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
   5    Copyright (C) 1996, 1997, 1998, 1999, 2000  Free Software Foundation, Inc.
   6
   7 This program is free software; you can redistribute it and/or modify
   8 it under the terms of the GNU General Public License as published by
   9 the Free Software Foundation; either version 2, or (at your option)
  10 any later version.
  11
  12 This program is distributed in the hope that it will be useful,
  13 but WITHOUT ANY WARRANTY; without even the implied warranty of
  14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15 GNU General Public License for more details.
  16
  17 You should have received a copy of the GNU General Public License
  18 along with GNU CC; see the file COPYING.  If not, write to
  19 the Free Software Foundation, 59 Temple Place - Suite 330,
  20 Boston, MA 02111-1307, USA.
  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 PARAMS ((JCF *));
  30 static int jcf_parse_preamble PARAMS ((JCF *));
  31 static int jcf_parse_constant_pool PARAMS ((JCF *));
  32 static void jcf_parse_class PARAMS ((JCF *));
  33 static int jcf_parse_fields PARAMS ((JCF *));
  34 static int jcf_parse_one_method PARAMS ((JCF *));
  35 static int jcf_parse_methods PARAMS ((JCF *));
  36 static int jcf_parse_final_attributes PARAMS ((JCF *));
  37 #ifdef NEED_PEEK_ATTRIBUTE
  38 static int peek_attribute PARAMS ((JCF *, int, const char *, int));
  39 #endif
  40 #ifdef NEED_SKIP_ATTRIBUTE
  41 static void skip_attribute PARAMS ((JCF *, int));
  42 #endif
  43
  44 /* Go through all available attribute (ATTRIBUTE_NUMER) and try to
  45    identify PEEKED_NAME.  Return 1 if PEEKED_NAME was found, 0
  46    otherwise. JCF is restored to its initial position before
  47    returning.  */
  48
  49 #ifdef NEED_PEEK_ATTRIBUTE      /* Not everyone uses this function */
  50 static int
  51 peek_attribute (jcf, attribute_number, peeked_name, peeked_name_length)
  52       JCF *jcf;
  53       int attribute_number;
  54       const char *peeked_name;
  55       int peeked_name_length;
  56 {
  57   int to_return = 0;
  58   long absolute_offset = (long)JCF_TELL (jcf);
  59   int i;
  60
  61   for (i = 0; !to_return && i < attribute_number; i++)
  62     {
  63       uint16 attribute_name = (JCF_FILL (jcf, 6), JCF_readu2 (jcf));
  64       uint32 attribute_length = JCF_readu4 (jcf);
  65       int name_length;
  66       const unsigned char *name_data;
  67
  68       JCF_FILL (jcf, (long) attribute_length);
  69       if (attribute_name <= 0 || attribute_name >= JPOOL_SIZE(jcf)
  70           || JPOOL_TAG (jcf, attribute_name) != CONSTANT_Utf8)
  71         continue;
  72
  73       name_length = JPOOL_UTF_LENGTH (jcf, attribute_name);
  74       name_data = JPOOL_UTF_DATA (jcf, attribute_name);
  75
  76       if (name_length == peeked_name_length
  77           && ! memcmp (name_data, peeked_name, peeked_name_length))
  78         {
  79           to_return = 1;
  80           break;
  81         }
  82
  83       JCF_SKIP (jcf, attribute_length);
  84     }
  85
  86   JCF_SEEK (jcf, absolute_offset);
  87   return to_return;
  88 }
  89 #endif
  90
  91 #ifdef NEED_SKIP_ATTRIBUTE      /* Not everyone uses this function */
  92 static void
  93 skip_attribute (jcf, number_of_attribute)
  94      JCF *jcf;
  95      int number_of_attribute;
  96 {
  97   while (number_of_attribute--)
  98     {
  99       JCF_FILL (jcf, 6);
 100       (void) JCF_readu2 (jcf);
 101       JCF_SKIP (jcf, JCF_readu4 (jcf));
 102     }
 103 }
 104 #endif
 105
 106 static int
 107 DEFUN(get_attribute, (jcf),
 108       JCF *jcf)
 109 {
 110   uint16 attribute_name = (JCF_FILL (jcf, 6), JCF_readu2 (jcf));
 111   uint32 attribute_length = JCF_readu4 (jcf);
 112   uint32 start_pos = JCF_TELL(jcf);
 113   int name_length;
 114   const unsigned char *name_data;
 115   JCF_FILL (jcf, (long) attribute_length);
 116   if (attribute_name <= 0 || attribute_name >= JPOOL_SIZE(jcf))
 117     return -2;
 118   if (JPOOL_TAG (jcf, attribute_name) != CONSTANT_Utf8)
 119     return -2;
 120   name_length = JPOOL_UTF_LENGTH (jcf, attribute_name);
 121   name_data = JPOOL_UTF_DATA (jcf, attribute_name);
 122
 123 #ifdef IGNORE_ATTRIBUTE
 124    if (IGNORE_ATTRIBUTE (jcf, attribute_name, attribute_length))
 125      {
 126        JCF_SKIP (jcf, attribute_length);
 127      }
 128    else
 129 #endif
 130 #ifdef HANDLE_SOURCEFILE
 131   if (name_length == 10 && memcmp (name_data, "SourceFile", 10) == 0)
 132     {
 133       uint16 sourcefile_index = JCF_readu2 (jcf);
 134       HANDLE_SOURCEFILE(sourcefile_index);
 135     }
 136   else
 137 #endif
 138 #ifdef HANDLE_CONSTANTVALUE
 139   if (name_length == 13 && memcmp (name_data, "ConstantValue", 13) == 0)
 140     {
 141       uint16 constantvalue_index = JCF_readu2 (jcf);
 142       if (constantvalue_index <= 0 || constantvalue_index >= JPOOL_SIZE(jcf))
 143         return -2;
 144       HANDLE_CONSTANTVALUE(constantvalue_index);
 145     }
 146   else
 147 #endif
 148 #ifdef HANDLE_CODE_ATTRIBUTE
 149   if (name_length == 4 && memcmp (name_data, "Code", 4) == 0)
 150     {
 151       uint16 j;
 152       uint16 max_stack ATTRIBUTE_UNUSED = JCF_readu2 (jcf);
 153       uint16 max_locals ATTRIBUTE_UNUSED = JCF_readu2 (jcf);
 154       uint32 code_length = JCF_readu4 (jcf);
 155       uint16 exception_table_length, attributes_count;
 156       if (code_length + 12 > attribute_length)
 157         return -1;
 158       HANDLE_CODE_ATTRIBUTE(max_stack, max_locals, code_length);
 159       JCF_SKIP (jcf, code_length);
 160       exception_table_length = JCF_readu2 (jcf);
 161       if (code_length + 8 * exception_table_length + 12 > attribute_length)
 162         return -1;
 163 #ifdef HANDLE_EXCEPTION_TABLE
 164       HANDLE_EXCEPTION_TABLE (jcf->read_ptr, exception_table_length);
 165 #endif
 166       JCF_SKIP (jcf, 2 * 4 * exception_table_length);
 167       attributes_count = JCF_readu2 (jcf);
 168       for (j = 0; j < attributes_count; j++)
 169         {
 170           int code = get_attribute (jcf);
 171           if (code != 0)
 172             return code;
 173         }
 174     }
 175   else
 176 #endif /* HANDLE_CODE_ATTRIBUTE */
 177 #ifdef HANDLE_EXCEPTIONS_ATTRIBUTE
 178   if (name_length == 10 && memcmp (name_data, "Exceptions", 10) == 0)
 179     {
 180       uint16 count = JCF_readu2 (jcf);
 181       HANDLE_EXCEPTIONS_ATTRIBUTE (count);
 182     }
 183   else
 184 #endif
 185 #ifdef HANDLE_LINENUMBERTABLE_ATTRIBUTE
 186   if (name_length == 15 && memcmp (name_data, "LineNumberTable", 15) == 0)
 187     {
 188       uint16 count = JCF_readu2 (jcf);
 189       HANDLE_LINENUMBERTABLE_ATTRIBUTE (count);
 190     }
 191   else
 192 #endif
 193 #ifdef HANDLE_LOCALVARIABLETABLE_ATTRIBUTE
 194   if (name_length == 18 && memcmp (name_data, "LocalVariableTable", 18) == 0)
 195     {
 196       uint16 count = JCF_readu2 (jcf);
 197       HANDLE_LOCALVARIABLETABLE_ATTRIBUTE (count);
 198     }
 199   else
 200 #endif
 201 #ifdef HANDLE_INNERCLASSES_ATTRIBUTE
 202   if (name_length == 12 && memcmp (name_data, "InnerClasses", 12) == 0)
 203     {
 204       uint16 count = JCF_readu2 (jcf);
 205       HANDLE_INNERCLASSES_ATTRIBUTE (count);
 206     }
 207   else
 208 #endif
 209 #ifdef HANDLE_SYNTHETIC_ATTRIBUTE
 210   if (name_length == 9 && memcmp (name_data, "Synthetic", 9) == 0)
 211     {
 212       HANDLE_SYNTHETIC_ATTRIBUTE ();
 213     }
 214   else
 215 #endif
 216     {
 217 #ifdef PROCESS_OTHER_ATTRIBUTE
 218       PROCESS_OTHER_ATTRIBUTE(jcf, attribute_name, attribute_length);
 219 #else
 220       JCF_SKIP (jcf, attribute_length);
 221 #endif
 222     }
 223   if ((long) (start_pos + attribute_length) != JCF_TELL(jcf))
 224     return -1;
 225   return 0;
 226 }
 227
 228 /* Read and handle the pre-amble. */
 229 static int
 230 DEFUN(jcf_parse_preamble, (jcf),
 231       JCF* jcf)
 232 {
 233   uint32 magic = (JCF_FILL (jcf, 8), JCF_readu4 (jcf));
 234   uint16 minor_version ATTRIBUTE_UNUSED = JCF_readu2 (jcf);
 235   uint16 major_version ATTRIBUTE_UNUSED = JCF_readu2 (jcf);
 236 #ifdef HANDLE_MAGIC
 237   HANDLE_MAGIC (magic, minor_version, major_version);
 238 #endif
 239   if (magic != 0xcafebabe)
 240     return -1;
 241   else
 242     return 0;
 243 }
 244
 245 /* Read and handle the constant pool.
 246
 247    Return 0 if OK.
 248    Return -2 if a bad cross-reference (index of other constant) was seen.
 249 */
 250 static int
 251 DEFUN(jcf_parse_constant_pool, (jcf),
 252       JCF* jcf)
 253 {
 254   int i, n;
 255   JPOOL_SIZE (jcf) = (JCF_FILL (jcf, 2), JCF_readu2 (jcf));
 256   jcf->cpool.tags = ALLOC (JPOOL_SIZE (jcf));
 257   jcf->cpool.data = ALLOC (sizeof (jword) * JPOOL_SIZE (jcf));
 258   jcf->cpool.tags[0] = 0;
 259 #ifdef HANDLE_START_CONSTANT_POOL
 260   HANDLE_START_CONSTANT_POOL (JPOOL_SIZE (jcf));
 261 #endif
 262   for (i = 1; i < (int) JPOOL_SIZE (jcf); i++)
 263     {
 264       int constant_kind;
 265
 266       /* Make sure at least 9 bytes are available.  This is enough
 267          for all fixed-sized constant pool entries (so we don't need many
 268          more JCF_FILL calls below), but is is small enough that
 269          we are guaranteed to not hit EOF (in a valid .class file). */
 270       JCF_FILL (jcf, 9);
 271       constant_kind = JCF_readu (jcf);
 272       jcf->cpool.tags[i] = constant_kind;
 273       switch (constant_kind)
 274         {
 275         case CONSTANT_String:
 276         case CONSTANT_Class:
 277           jcf->cpool.data[i] = JCF_readu2 (jcf);
 278           break;
 279         case CONSTANT_Fieldref:
 280         case CONSTANT_Methodref:
 281         case CONSTANT_InterfaceMethodref:
 282         case CONSTANT_NameAndType:
 283           jcf->cpool.data[i] = JCF_readu2 (jcf);
 284           jcf->cpool.data[i] |= JCF_readu2 (jcf) << 16;
 285           break;
 286         case CONSTANT_Integer:
 287         case CONSTANT_Float:
 288           jcf->cpool.data[i] = JCF_readu4 (jcf);
 289           break;
 290         case CONSTANT_Long:
 291         case CONSTANT_Double:
 292           jcf->cpool.data[i] = JCF_readu4 (jcf);
 293           i++; /* These take up two spots in the constant pool */
 294           jcf->cpool.tags[i] = 0;
 295           jcf->cpool.data[i] = JCF_readu4 (jcf);
 296           break;
 297         case CONSTANT_Utf8:
 298           n = JCF_readu2 (jcf);
 299           JCF_FILL (jcf, n);
 300 #ifdef HANDLE_CONSTANT_Utf8
 301           HANDLE_CONSTANT_Utf8(jcf, i, n);
 302 #else
 303           jcf->cpool.data[i] = JCF_TELL(jcf) - 2;
 304           JCF_SKIP (jcf, n);
 305 #endif
 306           break;
 307         default:
 308           return i;
 309         }
 310     }
 311   return 0;
 312 }
 313
 314 /* Read various class flags and numbers. */
 315
 316 static void
 317 DEFUN(jcf_parse_class, (jcf),
 318       JCF* jcf)
 319 {
 320   int i;
 321   uint16 interfaces_count;
 322   JCF_FILL (jcf, 8);
 323   jcf->access_flags = JCF_readu2 (jcf);
 324   jcf->this_class = JCF_readu2 (jcf);
 325   jcf->super_class = JCF_readu2 (jcf);
 326   interfaces_count = JCF_readu2 (jcf);
 327
 328 #ifdef HANDLE_CLASS_INFO
 329   HANDLE_CLASS_INFO(jcf->access_flags, jcf->this_class, jcf->super_class, interfaces_count);
 330 #endif
 331
 332   JCF_FILL (jcf, 2 * interfaces_count);
 333
 334   /* Read interfaces. */
 335   for (i = 0; i < interfaces_count; i++)
 336     {
 337       uint16 index ATTRIBUTE_UNUSED = JCF_readu2 (jcf);
 338 #ifdef HANDLE_CLASS_INTERFACE
 339       HANDLE_CLASS_INTERFACE (index);
 340 #endif
 341     }
 342 }
 343
 344 /* Read fields. */
 345 static int
 346 DEFUN(jcf_parse_fields, (jcf),
 347       JCF* jcf)
 348 {
 349   int i, j;
 350   uint16 fields_count;
 351   JCF_FILL (jcf, 2);
 352   fields_count = JCF_readu2 (jcf);
 353
 354 #ifdef HANDLE_START_FIELDS
 355   HANDLE_START_FIELDS (fields_count);
 356 #endif
 357   for (i = 0; i < fields_count; i++)
 358     {
 359       uint16 access_flags = (JCF_FILL (jcf, 8), JCF_readu2 (jcf));
 360       uint16 name_index = JCF_readu2 (jcf);
 361       uint16 signature_index = JCF_readu2 (jcf);
 362       uint16 attribute_count = JCF_readu2 (jcf);
 363 #ifdef HANDLE_START_FIELD
 364       HANDLE_START_FIELD (access_flags, name_index, signature_index,
 365                     attribute_count);
 366 #endif
 367       for (j = 0; j < attribute_count; j++)
 368         {
 369           int code = get_attribute (jcf);
 370           if (code != 0)
 371             return code;
 372         }
 373 #ifdef HANDLE_END_FIELD
 374       HANDLE_END_FIELD ();
 375 #endif
 376     }
 377 #ifdef HANDLE_END_FIELDS
 378   HANDLE_END_FIELDS ();
 379 #endif
 380   return 0;
 381 }
 382
 383 /* Read methods. */
 384
 385 static int
 386 DEFUN(jcf_parse_one_method, (jcf),
 387       JCF* jcf)
 388 {
 389   int i;
 390   uint16 access_flags = (JCF_FILL (jcf, 8), JCF_readu2 (jcf));
 391   uint16 name_index = JCF_readu2 (jcf);
 392   uint16 signature_index = JCF_readu2 (jcf);
 393   uint16 attribute_count = JCF_readu2 (jcf);
 394 #ifdef HANDLE_METHOD
 395   HANDLE_METHOD(access_flags, name_index, signature_index, attribute_count);
 396 #endif
 397   for (i = 0; i < attribute_count; i++)
 398     {
 399       int code = get_attribute (jcf);
 400       if (code != 0)
 401         return code;
 402     }
 403 #ifdef HANDLE_END_METHOD
 404   HANDLE_END_METHOD ();
 405 #endif
 406   return 0;
 407 }
 408
 409 static int
 410 DEFUN(jcf_parse_methods, (jcf),
 411       JCF* jcf)
 412 {
 413   int i;
 414   uint16 methods_count;
 415   JCF_FILL (jcf, 2);
 416   methods_count = JCF_readu2 (jcf);
 417 #ifdef HANDLE_START_METHODS
 418   HANDLE_START_METHODS (methods_count);
 419 #endif
 420   for (i = 0; i < methods_count; i++)
 421     {
 422       int code = jcf_parse_one_method (jcf);
 423       if (code != 0)
 424         return code;
 425     }
 426 #ifdef HANDLE_END_METHODS
 427   HANDLE_END_METHODS ();
 428 #endif
 429   return 0;
 430 }
 431
 432 /* Read attributes. */
 433 static int
 434 DEFUN(jcf_parse_final_attributes, (jcf),
 435       JCF *jcf)
 436 {
 437   int i;
 438   uint16 attributes_count = (JCF_FILL (jcf, 2), JCF_readu2 (jcf));
 439 #ifdef START_FINAL_ATTRIBUTES
 440   START_FINAL_ATTRIBUTES (attributes_count)
 441 #endif
 442   for (i = 0; i < attributes_count; i++)
 443     {
 444       int code = get_attribute (jcf);
 445       if (code != 0)
 446         return code;
 447     }
 448   return 0;
 449 }
 450