gcc/java/jcf-reader.c

   1 /* This file read a Java(TM) .class file.
   2    It is not stand-alone:  It depends on tons of macros, and the
   3    intent is you #include this file after you've defined the macros.
   4    Copyright (C) 1996-2016 Free Software Foundation, Inc.
   5
   6 This file is part of GCC.
   7
   8 GCC is free software; you can redistribute it and/or modify
   9 it under the terms of the GNU General Public License as published by
  10 the Free Software Foundation; either version 3, or (at your option)
  11 any later version.
  12
  13 GCC is distributed in the hope that it will be useful,
  14 but WITHOUT ANY WARRANTY; without even the implied warranty of
  15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16 GNU General Public License for more details.
  17
  18 You should have received a copy of the GNU General Public License
  19 along with GCC; see the file COPYING3.  If not see
  20 <http://www.gnu.org/licenses/>.
  21
  22 Java and all Java-based marks are trademarks or registered trademarks
  23 of Sun Microsystems, Inc. in the United States and other countries.
  24 The Free Software Foundation is independent of Sun Microsystems, Inc.  */
  25
  26 #include "jcf.h"
  27 #include "zipfile.h"
  28
  29 static int get_attribute (JCF *, int, jv_attr_type);
  30 static int jcf_parse_preamble (JCF *);
  31 static int jcf_parse_constant_pool (JCF *);
  32 static void jcf_parse_class (JCF *);
  33 static int jcf_parse_fields (JCF *);
  34 static int jcf_parse_one_method (JCF *, int);
  35 static int jcf_parse_methods (JCF *);
  36 static int jcf_parse_final_attributes (JCF *);
  37 static int jcf_parse_bootstrap_methods (JCF *, int) ATTRIBUTE_UNUSED;
  38 #ifdef NEED_PEEK_ATTRIBUTE
  39 static int peek_attribute (JCF *, int, const char *, int);
  40 #endif
  41 #ifdef NEED_SKIP_ATTRIBUTE
  42 static void skip_attribute (JCF *, int);
  43 #endif
  44
  45 /* Go through all available attribute (ATTRIBUTE_NUMER) and try to
  46    identify PEEKED_NAME.  Return 1 if PEEKED_NAME was found, 0
  47    otherwise. JCF is restored to its initial position before
  48    returning.  */
  49
  50 #ifdef NEED_PEEK_ATTRIBUTE      /* Not everyone uses this function */
  51 static int
  52 peek_attribute (JCF *jcf, int attribute_number, const char *peeked_name,
  53                 int peeked_name_length)
  54 {
  55   int to_return = 0;
  56   long absolute_offset = (long)JCF_TELL (jcf);
  57   int i;
  58
  59   for (i = 0; !to_return && i < attribute_number; i++)
  60     {
  61       uint16 attribute_name = (JCF_FILL (jcf, 6), JCF_readu2 (jcf));
  62       uint32 attribute_length = JCF_readu4 (jcf);
  63       int name_length;
  64       const unsigned char *name_data;
  65
  66       JCF_FILL (jcf, (long) attribute_length);
  67       if (attribute_name <= 0 || attribute_name >= JPOOL_SIZE(jcf)
  68           || JPOOL_TAG (jcf, attribute_name) != CONSTANT_Utf8)
  69         continue;
  70
  71       name_length = JPOOL_UTF_LENGTH (jcf, attribute_name);
  72       name_data = JPOOL_UTF_DATA (jcf, attribute_name);
  73
  74       if (name_length == peeked_name_length
  75           && ! memcmp (name_data, peeked_name, peeked_name_length))
  76         {
  77           to_return = 1;
  78           break;
  79         }
  80
  81       JCF_SKIP (jcf, attribute_length);
  82     }
  83
  84   JCF_SEEK (jcf, absolute_offset);
  85   return to_return;
  86 }
  87 #endif
  88
  89 #ifdef NEED_SKIP_ATTRIBUTE      /* Not everyone uses this function */
  90 static void
  91 skip_attribute (JCF *jcf, int number_of_attribute)
  92 {
  93   while (number_of_attribute--)
  94     {
  95       JCF_u4 N;
  96       JCF_FILL (jcf, 6);
  97       (void) JCF_readu2 (jcf);
  98       N = JCF_readu4 (jcf);
  99       JCF_SKIP (jcf, N);
 100     }
 101 }
 102 #endif
 103
 104 static int
 105 get_attribute (JCF *jcf, int index,
 106                jv_attr_type attr_type ATTRIBUTE_UNUSED)
 107 {
 108   uint16 attribute_name = (JCF_FILL (jcf, 6), JCF_readu2 (jcf));
 109   uint32 attribute_length = JCF_readu4 (jcf);
 110   uint32 start_pos = JCF_TELL(jcf);
 111   int name_length;
 112   const unsigned char *name_data;
 113   JCF_FILL (jcf, (long) attribute_length);
 114   if (attribute_name <= 0 || attribute_name >= JPOOL_SIZE(jcf))
 115     return -2;
 116   if (JPOOL_TAG (jcf, attribute_name) != CONSTANT_Utf8)
 117     return -2;
 118   name_length = JPOOL_UTF_LENGTH (jcf, attribute_name);
 119   name_data = JPOOL_UTF_DATA (jcf, attribute_name);
 120
 121 #define MATCH_ATTRIBUTE(S) \
 122   (name_length == sizeof (S)-1 && memcmp (name_data, S, sizeof (S)-1) == 0)
 123
 124 #ifdef IGNORE_ATTRIBUTE
 125    if (IGNORE_ATTRIBUTE (jcf, attribute_name, attribute_length))
 126      {
 127        JCF_SKIP (jcf, attribute_length);
 128      }
 129    else
 130 #endif
 131 #ifdef HANDLE_SOURCEFILE
 132   if (MATCH_ATTRIBUTE ("SourceFile"))
 133     {
 134       uint16 sourcefile_index = JCF_readu2 (jcf);
 135       HANDLE_SOURCEFILE(sourcefile_index);
 136     }
 137   else
 138 #endif
 139 #ifdef HANDLE_CONSTANTVALUE
 140   if (MATCH_ATTRIBUTE ("ConstantValue"))
 141     {
 142       uint16 constantvalue_index = JCF_readu2 (jcf);
 143       if (constantvalue_index <= 0 || constantvalue_index >= JPOOL_SIZE(jcf))
 144         return -2;
 145       HANDLE_CONSTANTVALUE(constantvalue_index);
 146     }
 147   else
 148 #endif
 149 #ifdef HANDLE_CODE_ATTRIBUTE
 150   if (MATCH_ATTRIBUTE ("Code"))
 151     {
 152       uint16 j;
 153       uint16 max_stack ATTRIBUTE_UNUSED = JCF_readu2 (jcf);
 154       uint16 max_locals ATTRIBUTE_UNUSED = JCF_readu2 (jcf);
 155       uint32 code_length = JCF_readu4 (jcf);
 156       uint16 exception_table_length, attributes_count;
 157       if (code_length + 12 > attribute_length)
 158         return -1;
 159       HANDLE_CODE_ATTRIBUTE(max_stack, max_locals, code_length);
 160       JCF_SKIP (jcf, code_length);
 161       exception_table_length = JCF_readu2 (jcf);
 162       if (code_length + 8 * exception_table_length + 12 > attribute_length)
 163         return -1;
 164 #ifdef HANDLE_EXCEPTION_TABLE
 165       HANDLE_EXCEPTION_TABLE (jcf->read_ptr, exception_table_length);
 166 #endif
 167       JCF_SKIP (jcf, 2 * 4 * exception_table_length);
 168       attributes_count = JCF_readu2 (jcf);
 169       for (j = 0; j < attributes_count; j++)
 170         {
 171           int code = get_attribute (jcf, index, JV_METHOD_ATTR);
 172           if (code != 0)
 173             return code;
 174         }
 175     }
 176   else
 177 #endif /* HANDLE_CODE_ATTRIBUTE */
 178 #ifdef HANDLE_EXCEPTIONS_ATTRIBUTE
 179   if (MATCH_ATTRIBUTE ("Exceptions"))
 180     {
 181       uint16 count = JCF_readu2 (jcf);
 182       HANDLE_EXCEPTIONS_ATTRIBUTE (count);
 183     }
 184   else
 185 #endif
 186 #ifdef HANDLE_LINENUMBERTABLE_ATTRIBUTE
 187   if (MATCH_ATTRIBUTE ("LineNumberTable"))
 188     {
 189       uint16 count = JCF_readu2 (jcf);
 190       HANDLE_LINENUMBERTABLE_ATTRIBUTE (count);
 191     }
 192   else
 193 #endif
 194 #ifdef HANDLE_LOCALVARIABLETABLE_ATTRIBUTE
 195   if (MATCH_ATTRIBUTE ("LocalVariableTable"))
 196     {
 197       uint16 count = JCF_readu2 (jcf);
 198       HANDLE_LOCALVARIABLETABLE_ATTRIBUTE (count);
 199     }
 200   else
 201 #endif
 202 #ifdef HANDLE_LOCALVARIABLETYPETABLE_ATTRIBUTE
 203   if (MATCH_ATTRIBUTE ("LocalVariableTypeTable"))
 204     {
 205       uint16 count = JCF_readu2 (jcf);
 206       HANDLE_LOCALVARIABLETYPETABLE_ATTRIBUTE (count);
 207     }
 208   else
 209 #endif
 210 #ifdef HANDLE_INNERCLASSES_ATTRIBUTE
 211   if (MATCH_ATTRIBUTE ("InnerClasses"))
 212     {
 213       uint16 count = JCF_readu2 (jcf);
 214       HANDLE_INNERCLASSES_ATTRIBUTE (count);
 215     }
 216   else
 217 #endif
 218 #ifdef HANDLE_SYNTHETIC_ATTRIBUTE
 219   if (MATCH_ATTRIBUTE ("Synthetic"))
 220     {
 221       HANDLE_SYNTHETIC_ATTRIBUTE ();
 222     }
 223   else
 224 #endif
 225 #ifdef HANDLE_GCJCOMPILED_ATTRIBUTE
 226   if (MATCH_ATTRIBUTE ("gnu.gcj.gcj-compiled"))
 227     {
 228       HANDLE_GCJCOMPILED_ATTRIBUTE ();
 229     }
 230   else
 231 #endif
 232 #ifdef HANDLE_DEPRECATED_ATTRIBUTE
 233   if (MATCH_ATTRIBUTE ("Deprecated"))
 234     {
 235       HANDLE_DEPRECATED_ATTRIBUTE ();
 236     }
 237   else
 238 #endif
 239 #ifdef HANDLE_SOURCEDEBUGEXTENSION_ATTRIBUTE
 240   if (MATCH_ATTRIBUTE ("SourceDebugExtension")) /* JSR 45 */
 241     {
 242       HANDLE_SOURCEDEBUGEXTENSION_ATTRIBUTE (attribute_length);
 243     }
 244   else
 245 #endif
 246 #ifdef HANDLE_ENCLOSINGMETHOD_ATTRIBUTE
 247   if (MATCH_ATTRIBUTE ("EnclosingMethod"))
 248     {
 249       HANDLE_ENCLOSINGMETHOD_ATTRIBUTE ();
 250     }
 251   else
 252 #endif
 253 #ifdef HANDLE_SIGNATURE_ATTRIBUTE
 254   if (MATCH_ATTRIBUTE ("Signature"))
 255     {
 256       HANDLE_SIGNATURE_ATTRIBUTE ();
 257     }
 258   else
 259 #endif
 260 #ifdef HANDLE_RUNTIMEVISIBLEANNOTATIONS_ATTRIBUTE
 261   if (MATCH_ATTRIBUTE ("RuntimeVisibleAnnotations"))
 262     {
 263       HANDLE_RUNTIMEVISIBLEANNOTATIONS_ATTRIBUTE ();
 264     }
 265   else
 266 #endif
 267 #ifdef HANDLE_RUNTIMEINVISIBLEANNOTATIONS_ATTRIBUTE
 268   if (MATCH_ATTRIBUTE ("RuntimeInvisibleAnnotations"))
 269     {
 270       HANDLE_RUNTIMEINVISIBLEANNOTATIONS_ATTRIBUTE ();
 271     }
 272   else
 273 #endif
 274 #ifdef HANDLE_RUNTIMEVISIBLEPARAMETERANNOTATIONS_ATTRIBUTE
 275   if (MATCH_ATTRIBUTE ("RuntimeVisibleParameterAnnotations"))
 276     {
 277       HANDLE_RUNTIMEVISIBLEPARAMETERANNOTATIONS_ATTRIBUTE ();
 278     }
 279   else
 280 #endif
 281 #ifdef HANDLE_RUNTIMEINVISIBLEPARAMETERANNOTATIONS_ATTRIBUTE
 282   if (MATCH_ATTRIBUTE ("RuntimeInvisibleParameterAnnotations"))
 283     {
 284       HANDLE_RUNTIMEINVISIBLEPARAMETERANNOTATIONS_ATTRIBUTE ();
 285     }
 286   else
 287 #endif
 288 #ifdef HANDLE_ANNOTATIONDEFAULT_ATTRIBUTE
 289   if (MATCH_ATTRIBUTE ("AnnotationDefault"))
 290     {
 291       HANDLE_ANNOTATIONDEFAULT_ATTRIBUTE ();
 292     }
 293   else
 294 #endif
 295   if (MATCH_ATTRIBUTE ("BootstrapMethods"))
 296     {
 297 #ifdef HANDLE_BOOTSTRAP_METHODS_ATTRIBUTE
 298       HANDLE_BOOTSTRAP_METHODS_ATTRIBUTE();
 299 #else
 300       JCF_SKIP (jcf, attribute_length);
 301 #endif
 302     }
 303    else
 304     {
 305 #ifdef PROCESS_OTHER_ATTRIBUTE
 306       PROCESS_OTHER_ATTRIBUTE(jcf, attribute_name, attribute_length);
 307 #else
 308       JCF_SKIP (jcf, attribute_length);
 309 #endif
 310     }
 311   if ((long) (start_pos + attribute_length) != JCF_TELL(jcf))
 312     return -1;
 313   return 0;
 314 }
 315
 316 /* Read and handle the pre-amble. */
 317 static int
 318 jcf_parse_preamble (JCF* jcf)
 319 {
 320   uint32 magic = (JCF_FILL (jcf, 8), JCF_readu4 (jcf));
 321   uint16 minor_version ATTRIBUTE_UNUSED = JCF_readu2 (jcf);
 322   uint16 major_version ATTRIBUTE_UNUSED = JCF_readu2 (jcf);
 323 #ifdef HANDLE_MAGIC
 324   HANDLE_MAGIC (magic, minor_version, major_version);
 325 #endif
 326   if (magic != 0xcafebabe)
 327     return -1;
 328   else
 329     return 0;
 330 }
 331
 332 /* Read and handle the constant pool.
 333
 334    Return 0 if OK.
 335    Return -2 if a bad cross-reference (index of other constant) was seen.
 336 */
 337 static int
 338 jcf_parse_constant_pool (JCF* jcf)
 339 {
 340   int i, n;
 341   JPOOL_SIZE (jcf) = (JCF_FILL (jcf, 2), JCF_readu2 (jcf));
 342   jcf->cpool.tags = (uint8 *) ggc_alloc_atomic (JPOOL_SIZE (jcf));
 343   jcf->cpool.data = (cpool_entry *) ggc_internal_cleared_alloc
 344     (sizeof (jword) * JPOOL_SIZE (jcf));
 345   jcf->cpool.tags[0] = 0;
 346 #ifdef HANDLE_START_CONSTANT_POOL
 347   HANDLE_START_CONSTANT_POOL (JPOOL_SIZE (jcf));
 348 #endif
 349   for (i = 1; i < (int) JPOOL_SIZE (jcf); i++)
 350     {
 351       int constant_kind;
 352
 353       /* Make sure at least 9 bytes are available.  This is enough
 354          for all fixed-sized constant pool entries (so we don't need many
 355          more JCF_FILL calls below), but is small enough that
 356          we are guaranteed to not hit EOF (in a valid .class file). */
 357       JCF_FILL (jcf, 9);
 358       constant_kind = JCF_readu (jcf);
 359       jcf->cpool.tags[i] = constant_kind;
 360       switch (constant_kind)
 361         {
 362         case CONSTANT_String:
 363         case CONSTANT_Class:
 364           jcf->cpool.data[i].w = JCF_readu2 (jcf);
 365           break;
 366         case CONSTANT_Fieldref:
 367         case CONSTANT_Methodref:
 368         case CONSTANT_InterfaceMethodref:
 369         case CONSTANT_NameAndType:
 370           jcf->cpool.data[i].w = JCF_readu2 (jcf);
 371           jcf->cpool.data[i].w |= JCF_readu2 (jcf) << 16;
 372           break;
 373         case CONSTANT_Integer:
 374         case CONSTANT_Float:
 375           jcf->cpool.data[i].w = JCF_readu4 (jcf);
 376           break;
 377         case CONSTANT_Long:
 378         case CONSTANT_Double:
 379           jcf->cpool.data[i].w = JCF_readu4 (jcf);
 380           i++; /* These take up two spots in the constant pool */
 381           jcf->cpool.tags[i] = 0;
 382           jcf->cpool.data[i].w = JCF_readu4 (jcf);
 383           break;
 384         case CONSTANT_Utf8:
 385           n = JCF_readu2 (jcf);
 386           JCF_FILL (jcf, n);
 387 #ifdef HANDLE_CONSTANT_Utf8
 388           HANDLE_CONSTANT_Utf8(jcf, i, n);
 389 #else
 390           jcf->cpool.data[i].w = JCF_TELL(jcf) - 2;
 391           JCF_SKIP (jcf, n);
 392 #endif
 393           break;
 394         case CONSTANT_MethodHandle:
 395           jcf->cpool.data[i].w = JCF_readu (jcf);
 396           jcf->cpool.data[i].w |= JCF_readu2 (jcf) << 16;
 397           break;
 398         case CONSTANT_MethodType:
 399           jcf->cpool.data[i].w = JCF_readu2 (jcf);
 400           break;
 401         case CONSTANT_InvokeDynamic:
 402           jcf->cpool.data[i].w = JCF_readu2 (jcf);
 403           jcf->cpool.data[i].w |= JCF_readu2 (jcf) << 16;
 404           break;
 405         default:
 406           return i;
 407         }
 408     }
 409   return 0;
 410 }
 411
 412 /* Read various class flags and numbers. */
 413
 414 static void
 415 jcf_parse_class (JCF* jcf)
 416 {
 417   int i;
 418   uint16 interfaces_count;
 419   JCF_FILL (jcf, 8);
 420   jcf->access_flags = JCF_readu2 (jcf);
 421   jcf->this_class = JCF_readu2 (jcf);
 422   jcf->super_class = JCF_readu2 (jcf);
 423   interfaces_count = JCF_readu2 (jcf);
 424
 425 #ifdef HANDLE_CLASS_INFO
 426   HANDLE_CLASS_INFO(jcf->access_flags, jcf->this_class, jcf->super_class, interfaces_count);
 427 #endif
 428
 429   JCF_FILL (jcf, 2 * interfaces_count);
 430
 431   /* Read interfaces. */
 432   for (i = 0; i < interfaces_count; i++)
 433     {
 434       uint16 index ATTRIBUTE_UNUSED = JCF_readu2 (jcf);
 435 #ifdef HANDLE_CLASS_INTERFACE
 436       HANDLE_CLASS_INTERFACE (index);
 437 #endif
 438     }
 439 }
 440
 441 /* Read fields. */
 442 static int
 443 jcf_parse_fields (JCF* jcf)
 444 {
 445   int i, j;
 446   uint16 fields_count;
 447   JCF_FILL (jcf, 2);
 448   fields_count = JCF_readu2 (jcf);
 449
 450 #ifdef HANDLE_START_FIELDS
 451   HANDLE_START_FIELDS (fields_count);
 452 #endif
 453   for (i = 0; i < fields_count; i++)
 454     {
 455       uint16 access_flags = (JCF_FILL (jcf, 8), JCF_readu2 (jcf));
 456       uint16 name_index = JCF_readu2 (jcf);
 457       uint16 signature_index = JCF_readu2 (jcf);
 458       uint16 attribute_count = JCF_readu2 (jcf);
 459 #ifdef HANDLE_START_FIELD
 460       HANDLE_START_FIELD (access_flags, name_index, signature_index,
 461                           attribute_count);
 462 #endif
 463       for (j = 0; j < attribute_count; j++)
 464         {
 465           int code = get_attribute (jcf, i, JV_FIELD_ATTR);
 466           if (code != 0)
 467             return code;
 468         }
 469 #ifdef HANDLE_END_FIELD
 470       HANDLE_END_FIELD ();
 471 #endif
 472     }
 473 #ifdef HANDLE_END_FIELDS
 474   HANDLE_END_FIELDS ();
 475 #endif
 476   return 0;
 477 }
 478
 479 /* Read methods. */
 480
 481 static int
 482 jcf_parse_one_method (JCF* jcf, int index)
 483 {
 484   int i;
 485   uint16 access_flags = (JCF_FILL (jcf, 8), JCF_readu2 (jcf));
 486   uint16 name_index = JCF_readu2 (jcf);
 487   uint16 signature_index = JCF_readu2 (jcf);
 488   uint16 attribute_count = JCF_readu2 (jcf);
 489 #ifdef HANDLE_METHOD
 490   HANDLE_METHOD(access_flags, name_index, signature_index, attribute_count);
 491 #endif
 492   for (i = 0; i < attribute_count; i++)
 493     {
 494       int code = get_attribute (jcf, index, JV_METHOD_ATTR);
 495       if (code != 0)
 496         return code;
 497     }
 498 #ifdef HANDLE_END_METHOD
 499   HANDLE_END_METHOD ();
 500 #endif
 501   return 0;
 502 }
 503
 504 static int
 505 jcf_parse_methods (JCF* jcf)
 506 {
 507   int i;
 508   uint16 methods_count;
 509   JCF_FILL (jcf, 2);
 510   methods_count = JCF_readu2 (jcf);
 511 #ifdef HANDLE_START_METHODS
 512   HANDLE_START_METHODS (methods_count);
 513 #endif
 514   for (i = 0; i < methods_count; i++)
 515     {
 516       int code = jcf_parse_one_method (jcf, i);
 517       if (code != 0)
 518         return code;
 519     }
 520 #ifdef HANDLE_END_METHODS
 521   HANDLE_END_METHODS ();
 522 #endif
 523   return 0;
 524 }
 525
 526 /* Read attributes. */
 527 static int
 528 jcf_parse_final_attributes (JCF *jcf)
 529 {
 530   int i;
 531   uint16 attributes_count = (JCF_FILL (jcf, 2), JCF_readu2 (jcf));
 532 #ifdef START_FINAL_ATTRIBUTES
 533   START_FINAL_ATTRIBUTES (attributes_count)
 534 #endif
 535   for (i = 0; i < attributes_count; i++)
 536     {
 537       int code = get_attribute (jcf, i, JV_CLASS_ATTR);
 538       if (code != 0)
 539         return code;
 540     }
 541   return 0;
 542 }
 543
 544 /* Read and handle the "BootstrapMethods" attribute.
 545
 546    Return 0 if OK.
 547 */
 548 static int
 549 jcf_parse_bootstrap_methods (JCF* jcf, int attribute_length ATTRIBUTE_UNUSED)
 550 {
 551   int i;
 552   uint16 num_methods = JCF_readu2 (jcf);
 553   jcf->bootstrap_methods.count = num_methods;
 554   jcf->bootstrap_methods.methods = ggc_vec_alloc<bootstrap_method> (num_methods);
 555 #ifdef HANDLE_START_BOOTSTRAP_METHODS
 556   HANDLE_START_BOOTSTRAP_METHODS (jcf, num_methods);
 557 #endif
 558
 559   for (i = 0; i < num_methods; i++)
 560     {
 561       unsigned j;
 562       bootstrap_method *m = &jcf->bootstrap_methods.methods[i];
 563       m->method_ref = JCF_readu2 (jcf);
 564       m->num_arguments = JCF_readu2 (jcf);
 565       m->bootstrap_arguments = ggc_vec_alloc<unsigned> (m->num_arguments);
 566       for (j = 0; j < m->num_arguments; j++)
 567         m->bootstrap_arguments[j] = JCF_readu2 (jcf);
 568     }
 569
 570 #ifdef HANDLE_END_BOOTSTRAP_METHODS
 571   HANDLE_END_BOOTSTRAP_METHODS (num_methods);
 572 #endif
 573
 574   return 0;
 575 }