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, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2005, 2006,
5 2007, 2008, 2010 Free Software Foundation, Inc.
7 This file is part of GCC.
9 GCC is free software; you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
11 the Free Software Foundation; either version 3, or (at your option)
14 GCC is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License for more details.
19 You should have received a copy of the GNU General Public License
20 along with GCC; see the file COPYING3. If not see
21 <http://www.gnu.org/licenses/>.
23 Java and all Java-based marks are trademarks or registered trademarks
24 of Sun Microsystems, Inc. in the United States and other countries.
25 The Free Software Foundation is independent of Sun Microsystems, Inc. */
31 static int get_attribute (JCF
*, int, jv_attr_type
);
32 static int jcf_parse_preamble (JCF
*);
33 static int jcf_parse_constant_pool (JCF
*);
34 static void jcf_parse_class (JCF
*);
35 static int jcf_parse_fields (JCF
*);
36 static int jcf_parse_one_method (JCF
*, int);
37 static int jcf_parse_methods (JCF
*);
38 static int jcf_parse_final_attributes (JCF
*);
39 static int jcf_parse_bootstrap_methods (JCF
*, int );
40 #ifdef NEED_PEEK_ATTRIBUTE
41 static int peek_attribute (JCF
*, int, const char *, int);
43 #ifdef NEED_SKIP_ATTRIBUTE
44 static void skip_attribute (JCF
*, int);
47 /* Go through all available attribute (ATTRIBUTE_NUMER) and try to
48 identify PEEKED_NAME. Return 1 if PEEKED_NAME was found, 0
49 otherwise. JCF is restored to its initial position before
52 #ifdef NEED_PEEK_ATTRIBUTE /* Not everyone uses this function */
54 peek_attribute (JCF
*jcf
, int attribute_number
, const char *peeked_name
,
55 int peeked_name_length
)
58 long absolute_offset
= (long)JCF_TELL (jcf
);
61 for (i
= 0; !to_return
&& i
< attribute_number
; i
++)
63 uint16 attribute_name
= (JCF_FILL (jcf
, 6), JCF_readu2 (jcf
));
64 uint32 attribute_length
= JCF_readu4 (jcf
);
66 const unsigned char *name_data
;
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
)
73 name_length
= JPOOL_UTF_LENGTH (jcf
, attribute_name
);
74 name_data
= JPOOL_UTF_DATA (jcf
, attribute_name
);
76 if (name_length
== peeked_name_length
77 && ! memcmp (name_data
, peeked_name
, peeked_name_length
))
83 JCF_SKIP (jcf
, attribute_length
);
86 JCF_SEEK (jcf
, absolute_offset
);
91 #ifdef NEED_SKIP_ATTRIBUTE /* Not everyone uses this function */
93 skip_attribute (JCF
*jcf
, int number_of_attribute
)
95 while (number_of_attribute
--)
99 (void) JCF_readu2 (jcf
);
100 N
= JCF_readu4 (jcf
);
107 get_attribute (JCF
*jcf
, int index
,
108 jv_attr_type attr_type ATTRIBUTE_UNUSED
)
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
);
114 const unsigned char *name_data
;
115 JCF_FILL (jcf
, (long) attribute_length
);
116 if (attribute_name
<= 0 || attribute_name
>= JPOOL_SIZE(jcf
))
118 if (JPOOL_TAG (jcf
, attribute_name
) != CONSTANT_Utf8
)
120 name_length
= JPOOL_UTF_LENGTH (jcf
, attribute_name
);
121 name_data
= JPOOL_UTF_DATA (jcf
, attribute_name
);
123 #define MATCH_ATTRIBUTE(S) \
124 (name_length == sizeof (S)-1 && memcmp (name_data, S, sizeof (S)-1) == 0)
126 #ifdef IGNORE_ATTRIBUTE
127 if (IGNORE_ATTRIBUTE (jcf
, attribute_name
, attribute_length
))
129 JCF_SKIP (jcf
, attribute_length
);
133 #ifdef HANDLE_SOURCEFILE
134 if (MATCH_ATTRIBUTE ("SourceFile"))
136 uint16 sourcefile_index
= JCF_readu2 (jcf
);
137 HANDLE_SOURCEFILE(sourcefile_index
);
141 #ifdef HANDLE_CONSTANTVALUE
142 if (MATCH_ATTRIBUTE ("ConstantValue"))
144 uint16 constantvalue_index
= JCF_readu2 (jcf
);
145 if (constantvalue_index
<= 0 || constantvalue_index
>= JPOOL_SIZE(jcf
))
147 HANDLE_CONSTANTVALUE(constantvalue_index
);
151 #ifdef HANDLE_CODE_ATTRIBUTE
152 if (MATCH_ATTRIBUTE ("Code"))
155 uint16 max_stack ATTRIBUTE_UNUSED
= JCF_readu2 (jcf
);
156 uint16 max_locals ATTRIBUTE_UNUSED
= JCF_readu2 (jcf
);
157 uint32 code_length
= JCF_readu4 (jcf
);
158 uint16 exception_table_length
, attributes_count
;
159 if (code_length
+ 12 > attribute_length
)
161 HANDLE_CODE_ATTRIBUTE(max_stack
, max_locals
, code_length
);
162 JCF_SKIP (jcf
, code_length
);
163 exception_table_length
= JCF_readu2 (jcf
);
164 if (code_length
+ 8 * exception_table_length
+ 12 > attribute_length
)
166 #ifdef HANDLE_EXCEPTION_TABLE
167 HANDLE_EXCEPTION_TABLE (jcf
->read_ptr
, exception_table_length
);
169 JCF_SKIP (jcf
, 2 * 4 * exception_table_length
);
170 attributes_count
= JCF_readu2 (jcf
);
171 for (j
= 0; j
< attributes_count
; j
++)
173 int code
= get_attribute (jcf
, index
, JV_METHOD_ATTR
);
179 #endif /* HANDLE_CODE_ATTRIBUTE */
180 #ifdef HANDLE_EXCEPTIONS_ATTRIBUTE
181 if (MATCH_ATTRIBUTE ("Exceptions"))
183 uint16 count
= JCF_readu2 (jcf
);
184 HANDLE_EXCEPTIONS_ATTRIBUTE (count
);
188 #ifdef HANDLE_LINENUMBERTABLE_ATTRIBUTE
189 if (MATCH_ATTRIBUTE ("LineNumberTable"))
191 uint16 count
= JCF_readu2 (jcf
);
192 HANDLE_LINENUMBERTABLE_ATTRIBUTE (count
);
196 #ifdef HANDLE_LOCALVARIABLETABLE_ATTRIBUTE
197 if (MATCH_ATTRIBUTE ("LocalVariableTable"))
199 uint16 count
= JCF_readu2 (jcf
);
200 HANDLE_LOCALVARIABLETABLE_ATTRIBUTE (count
);
204 #ifdef HANDLE_LOCALVARIABLETYPETABLE_ATTRIBUTE
205 if (MATCH_ATTRIBUTE ("LocalVariableTypeTable"))
207 uint16 count
= JCF_readu2 (jcf
);
208 HANDLE_LOCALVARIABLETYPETABLE_ATTRIBUTE (count
);
212 #ifdef HANDLE_INNERCLASSES_ATTRIBUTE
213 if (MATCH_ATTRIBUTE ("InnerClasses"))
215 uint16 count
= JCF_readu2 (jcf
);
216 HANDLE_INNERCLASSES_ATTRIBUTE (count
);
220 #ifdef HANDLE_SYNTHETIC_ATTRIBUTE
221 if (MATCH_ATTRIBUTE ("Synthetic"))
223 HANDLE_SYNTHETIC_ATTRIBUTE ();
227 #ifdef HANDLE_GCJCOMPILED_ATTRIBUTE
228 if (MATCH_ATTRIBUTE ("gnu.gcj.gcj-compiled"))
230 HANDLE_GCJCOMPILED_ATTRIBUTE ();
234 #ifdef HANDLE_DEPRECATED_ATTRIBUTE
235 if (MATCH_ATTRIBUTE ("Deprecated"))
237 HANDLE_DEPRECATED_ATTRIBUTE ();
241 #ifdef HANDLE_SOURCEDEBUGEXTENSION_ATTRIBUTE
242 if (MATCH_ATTRIBUTE ("SourceDebugExtension")) /* JSR 45 */
244 HANDLE_SOURCEDEBUGEXTENSION_ATTRIBUTE (attribute_length
);
248 #ifdef HANDLE_ENCLOSINGMETHOD_ATTRIBUTE
249 if (MATCH_ATTRIBUTE ("EnclosingMethod"))
251 HANDLE_ENCLOSINGMETHOD_ATTRIBUTE ();
255 #ifdef HANDLE_SIGNATURE_ATTRIBUTE
256 if (MATCH_ATTRIBUTE ("Signature"))
258 HANDLE_SIGNATURE_ATTRIBUTE ();
262 #ifdef HANDLE_RUNTIMEVISIBLEANNOTATIONS_ATTRIBUTE
263 if (MATCH_ATTRIBUTE ("RuntimeVisibleAnnotations"))
265 HANDLE_RUNTIMEVISIBLEANNOTATIONS_ATTRIBUTE ();
269 #ifdef HANDLE_RUNTIMEINVISIBLEANNOTATIONS_ATTRIBUTE
270 if (MATCH_ATTRIBUTE ("RuntimeInvisibleAnnotations"))
272 HANDLE_RUNTIMEINVISIBLEANNOTATIONS_ATTRIBUTE ();
276 #ifdef HANDLE_RUNTIMEVISIBLEPARAMETERANNOTATIONS_ATTRIBUTE
277 if (MATCH_ATTRIBUTE ("RuntimeVisibleParameterAnnotations"))
279 HANDLE_RUNTIMEVISIBLEPARAMETERANNOTATIONS_ATTRIBUTE ();
283 #ifdef HANDLE_RUNTIMEINVISIBLEPARAMETERANNOTATIONS_ATTRIBUTE
284 if (MATCH_ATTRIBUTE ("RuntimeInvisibleParameterAnnotations"))
286 HANDLE_RUNTIMEINVISIBLEPARAMETERANNOTATIONS_ATTRIBUTE ();
290 #ifdef HANDLE_ANNOTATIONDEFAULT_ATTRIBUTE
291 if (MATCH_ATTRIBUTE ("AnnotationDefault"))
293 HANDLE_ANNOTATIONDEFAULT_ATTRIBUTE ();
297 if (MATCH_ATTRIBUTE ("BootstrapMethods"))
299 #ifdef HANDLE_BOOTSTRAP_METHODS_ATTRIBUTE
300 HANDLE_BOOTSTRAP_METHODS_ATTRIBUTE();
302 JCF_SKIP (jcf
, attribute_length
);
307 #ifdef PROCESS_OTHER_ATTRIBUTE
308 PROCESS_OTHER_ATTRIBUTE(jcf
, attribute_name
, attribute_length
);
310 JCF_SKIP (jcf
, attribute_length
);
313 if ((long) (start_pos
+ attribute_length
) != JCF_TELL(jcf
))
318 /* Read and handle the pre-amble. */
320 jcf_parse_preamble (JCF
* jcf
)
322 uint32 magic
= (JCF_FILL (jcf
, 8), JCF_readu4 (jcf
));
323 uint16 minor_version ATTRIBUTE_UNUSED
= JCF_readu2 (jcf
);
324 uint16 major_version ATTRIBUTE_UNUSED
= JCF_readu2 (jcf
);
326 HANDLE_MAGIC (magic
, minor_version
, major_version
);
328 if (magic
!= 0xcafebabe)
334 /* Read and handle the constant pool.
337 Return -2 if a bad cross-reference (index of other constant) was seen.
340 jcf_parse_constant_pool (JCF
* jcf
)
343 JPOOL_SIZE (jcf
) = (JCF_FILL (jcf
, 2), JCF_readu2 (jcf
));
344 jcf
->cpool
.tags
= (uint8
*) ggc_alloc_atomic (JPOOL_SIZE (jcf
));
345 jcf
->cpool
.data
= ggc_alloc_cpool_entry (sizeof (jword
) * JPOOL_SIZE (jcf
));
346 jcf
->cpool
.tags
[0] = 0;
347 #ifdef HANDLE_START_CONSTANT_POOL
348 HANDLE_START_CONSTANT_POOL (JPOOL_SIZE (jcf
));
350 for (i
= 1; i
< (int) JPOOL_SIZE (jcf
); i
++)
354 /* Make sure at least 9 bytes are available. This is enough
355 for all fixed-sized constant pool entries (so we don't need many
356 more JCF_FILL calls below), but is is small enough that
357 we are guaranteed to not hit EOF (in a valid .class file). */
359 constant_kind
= JCF_readu (jcf
);
360 jcf
->cpool
.tags
[i
] = constant_kind
;
361 switch (constant_kind
)
363 case CONSTANT_String
:
365 jcf
->cpool
.data
[i
].w
= JCF_readu2 (jcf
);
367 case CONSTANT_Fieldref
:
368 case CONSTANT_Methodref
:
369 case CONSTANT_InterfaceMethodref
:
370 case CONSTANT_NameAndType
:
371 jcf
->cpool
.data
[i
].w
= JCF_readu2 (jcf
);
372 jcf
->cpool
.data
[i
].w
|= JCF_readu2 (jcf
) << 16;
374 case CONSTANT_Integer
:
376 jcf
->cpool
.data
[i
].w
= JCF_readu4 (jcf
);
379 case CONSTANT_Double
:
380 jcf
->cpool
.data
[i
].w
= JCF_readu4 (jcf
);
381 i
++; /* These take up two spots in the constant pool */
382 jcf
->cpool
.tags
[i
] = 0;
383 jcf
->cpool
.data
[i
].w
= JCF_readu4 (jcf
);
386 n
= JCF_readu2 (jcf
);
388 #ifdef HANDLE_CONSTANT_Utf8
389 HANDLE_CONSTANT_Utf8(jcf
, i
, n
);
391 jcf
->cpool
.data
[i
].w
= JCF_TELL(jcf
) - 2;
395 case CONSTANT_MethodHandle
:
396 jcf
->cpool
.data
[i
].w
= JCF_readu (jcf
);
397 jcf
->cpool
.data
[i
].w
|= JCF_readu2 (jcf
) << 16;
399 case CONSTANT_MethodType
:
400 jcf
->cpool
.data
[i
].w
= JCF_readu2 (jcf
);
402 case CONSTANT_InvokeDynamic
:
403 jcf
->cpool
.data
[i
].w
= JCF_readu2 (jcf
);
404 jcf
->cpool
.data
[i
].w
|= JCF_readu2 (jcf
) << 16;
413 /* Read various class flags and numbers. */
416 jcf_parse_class (JCF
* jcf
)
419 uint16 interfaces_count
;
421 jcf
->access_flags
= JCF_readu2 (jcf
);
422 jcf
->this_class
= JCF_readu2 (jcf
);
423 jcf
->super_class
= JCF_readu2 (jcf
);
424 interfaces_count
= JCF_readu2 (jcf
);
426 #ifdef HANDLE_CLASS_INFO
427 HANDLE_CLASS_INFO(jcf
->access_flags
, jcf
->this_class
, jcf
->super_class
, interfaces_count
);
430 JCF_FILL (jcf
, 2 * interfaces_count
);
432 /* Read interfaces. */
433 for (i
= 0; i
< interfaces_count
; i
++)
435 uint16 index ATTRIBUTE_UNUSED
= JCF_readu2 (jcf
);
436 #ifdef HANDLE_CLASS_INTERFACE
437 HANDLE_CLASS_INTERFACE (index
);
444 jcf_parse_fields (JCF
* jcf
)
449 fields_count
= JCF_readu2 (jcf
);
451 #ifdef HANDLE_START_FIELDS
452 HANDLE_START_FIELDS (fields_count
);
454 for (i
= 0; i
< fields_count
; i
++)
456 uint16 access_flags
= (JCF_FILL (jcf
, 8), JCF_readu2 (jcf
));
457 uint16 name_index
= JCF_readu2 (jcf
);
458 uint16 signature_index
= JCF_readu2 (jcf
);
459 uint16 attribute_count
= JCF_readu2 (jcf
);
460 #ifdef HANDLE_START_FIELD
461 HANDLE_START_FIELD (access_flags
, name_index
, signature_index
,
464 for (j
= 0; j
< attribute_count
; j
++)
466 int code
= get_attribute (jcf
, i
, JV_FIELD_ATTR
);
470 #ifdef HANDLE_END_FIELD
474 #ifdef HANDLE_END_FIELDS
475 HANDLE_END_FIELDS ();
483 jcf_parse_one_method (JCF
* jcf
, int index
)
486 uint16 access_flags
= (JCF_FILL (jcf
, 8), JCF_readu2 (jcf
));
487 uint16 name_index
= JCF_readu2 (jcf
);
488 uint16 signature_index
= JCF_readu2 (jcf
);
489 uint16 attribute_count
= JCF_readu2 (jcf
);
491 HANDLE_METHOD(access_flags
, name_index
, signature_index
, attribute_count
);
493 for (i
= 0; i
< attribute_count
; i
++)
495 int code
= get_attribute (jcf
, index
, JV_METHOD_ATTR
);
499 #ifdef HANDLE_END_METHOD
500 HANDLE_END_METHOD ();
506 jcf_parse_methods (JCF
* jcf
)
509 uint16 methods_count
;
511 methods_count
= JCF_readu2 (jcf
);
512 #ifdef HANDLE_START_METHODS
513 HANDLE_START_METHODS (methods_count
);
515 for (i
= 0; i
< methods_count
; i
++)
517 int code
= jcf_parse_one_method (jcf
, i
);
521 #ifdef HANDLE_END_METHODS
522 HANDLE_END_METHODS ();
527 /* Read attributes. */
529 jcf_parse_final_attributes (JCF
*jcf
)
532 uint16 attributes_count
= (JCF_FILL (jcf
, 2), JCF_readu2 (jcf
));
533 #ifdef START_FINAL_ATTRIBUTES
534 START_FINAL_ATTRIBUTES (attributes_count
)
536 for (i
= 0; i
< attributes_count
; i
++)
538 int code
= get_attribute (jcf
, i
, JV_CLASS_ATTR
);
545 /* Read and handle the "BootstrapMethods" attribute.
550 jcf_parse_bootstrap_methods (JCF
* jcf
, int attribute_length ATTRIBUTE_UNUSED
)
553 uint16 num_methods
= JCF_readu2 (jcf
);
554 jcf
->bootstrap_methods
.count
= num_methods
;
555 jcf
->bootstrap_methods
.methods
556 = (bootstrap_method
*) ggc_alloc_atomic (num_methods
557 * sizeof (bootstrap_method
));
558 #ifdef HANDLE_START_BOOTSTRAP_METHODS
559 HANDLE_START_BOOTSTRAP_METHODS (jcf
, num_methods
);
562 for (i
= 0; i
< num_methods
; i
++)
565 bootstrap_method
*m
= &jcf
->bootstrap_methods
.methods
[i
];
566 m
->method_ref
= JCF_readu2 (jcf
);
567 m
->num_arguments
= JCF_readu2 (jcf
);
568 m
->bootstrap_arguments
569 = (unsigned *) ggc_alloc_atomic (m
->num_arguments
570 * sizeof (unsigned));
571 for (j
= 0; j
< m
->num_arguments
; j
++)
572 m
->bootstrap_arguments
[j
] = JCF_readu2 (jcf
);
575 #ifdef HANDLE_END_BOOTSTRAP_METHODS
576 HANDLE_END_BOOTSTRAP_METHODS (num_methods
);