|
1 /* |
|
2 * Copyright (c) 1997, 2014, Oracle and/or its affiliates. All rights reserved. |
|
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
|
4 * |
|
5 * This code is free software; you can redistribute it and/or modify it |
|
6 * under the terms of the GNU General Public License version 2 only, as |
|
7 * published by the Free Software Foundation. |
|
8 * |
|
9 * This code is distributed in the hope that it will be useful, but WITHOUT |
|
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
|
11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
|
12 * version 2 for more details (a copy is included in the LICENSE file that |
|
13 * accompanied this code). |
|
14 * |
|
15 * You should have received a copy of the GNU General Public License version |
|
16 * 2 along with this work; if not, write to the Free Software Foundation, |
|
17 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
|
18 * |
|
19 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
|
20 * or visit www.oracle.com if you need additional information or have any |
|
21 * questions. |
|
22 * |
|
23 */ |
|
24 |
|
25 #ifndef SHARE_VM_CLASSFILE_CLASSFILEPARSER_HPP |
|
26 #define SHARE_VM_CLASSFILE_CLASSFILEPARSER_HPP |
|
27 |
|
28 #include "classfile/classFileStream.hpp" |
|
29 #include "memory/resourceArea.hpp" |
|
30 #include "oops/oop.inline.hpp" |
|
31 #include "oops/typeArrayOop.hpp" |
|
32 #include "runtime/handles.inline.hpp" |
|
33 #include "utilities/accessFlags.hpp" |
|
34 #include "classfile/symbolTable.hpp" |
|
35 |
|
36 class FieldAllocationCount; |
|
37 class FieldLayoutInfo; |
|
38 |
|
39 |
|
40 // Parser for for .class files |
|
41 // |
|
42 // The bytes describing the class file structure is read from a Stream object |
|
43 |
|
44 class ClassFileParser VALUE_OBJ_CLASS_SPEC { |
|
45 private: |
|
46 bool _need_verify; |
|
47 bool _relax_verify; |
|
48 u2 _major_version; |
|
49 u2 _minor_version; |
|
50 Symbol* _class_name; |
|
51 ClassLoaderData* _loader_data; |
|
52 KlassHandle _host_klass; |
|
53 GrowableArray<Handle>* _cp_patches; // overrides for CP entries |
|
54 |
|
55 // precomputed flags |
|
56 bool _has_finalizer; |
|
57 bool _has_empty_finalizer; |
|
58 bool _has_vanilla_constructor; |
|
59 int _max_bootstrap_specifier_index; // detects BSS values |
|
60 |
|
61 // class attributes parsed before the instance klass is created: |
|
62 bool _synthetic_flag; |
|
63 int _sde_length; |
|
64 char* _sde_buffer; |
|
65 u2 _sourcefile_index; |
|
66 u2 _generic_signature_index; |
|
67 |
|
68 // Metadata created before the instance klass is created. Must be deallocated |
|
69 // if not transferred to the InstanceKlass upon successful class loading |
|
70 // in which case these pointers have been set to NULL. |
|
71 instanceKlassHandle _super_klass; |
|
72 ConstantPool* _cp; |
|
73 Array<u2>* _fields; |
|
74 Array<Method*>* _methods; |
|
75 Array<u2>* _inner_classes; |
|
76 Array<Klass*>* _local_interfaces; |
|
77 Array<Klass*>* _transitive_interfaces; |
|
78 AnnotationArray* _annotations; |
|
79 AnnotationArray* _type_annotations; |
|
80 Array<AnnotationArray*>* _fields_annotations; |
|
81 Array<AnnotationArray*>* _fields_type_annotations; |
|
82 InstanceKlass* _klass; // InstanceKlass once created. |
|
83 |
|
84 void set_class_synthetic_flag(bool x) { _synthetic_flag = x; } |
|
85 void set_class_sourcefile_index(u2 x) { _sourcefile_index = x; } |
|
86 void set_class_generic_signature_index(u2 x) { _generic_signature_index = x; } |
|
87 void set_class_sde_buffer(char* x, int len) { _sde_buffer = x; _sde_length = len; } |
|
88 |
|
89 void init_parsed_class_attributes(ClassLoaderData* loader_data) { |
|
90 _loader_data = loader_data; |
|
91 _synthetic_flag = false; |
|
92 _sourcefile_index = 0; |
|
93 _generic_signature_index = 0; |
|
94 _sde_buffer = NULL; |
|
95 _sde_length = 0; |
|
96 // initialize the other flags too: |
|
97 _has_finalizer = _has_empty_finalizer = _has_vanilla_constructor = false; |
|
98 _max_bootstrap_specifier_index = -1; |
|
99 clear_class_metadata(); |
|
100 _klass = NULL; |
|
101 } |
|
102 void apply_parsed_class_attributes(instanceKlassHandle k); // update k |
|
103 void apply_parsed_class_metadata(instanceKlassHandle k, int fields_count, TRAPS); |
|
104 void clear_class_metadata() { |
|
105 // metadata created before the instance klass is created. Must be |
|
106 // deallocated if classfile parsing returns an error. |
|
107 _cp = NULL; |
|
108 _fields = NULL; |
|
109 _methods = NULL; |
|
110 _inner_classes = NULL; |
|
111 _local_interfaces = NULL; |
|
112 _transitive_interfaces = NULL; |
|
113 _annotations = _type_annotations = NULL; |
|
114 _fields_annotations = _fields_type_annotations = NULL; |
|
115 } |
|
116 |
|
117 class AnnotationCollector { |
|
118 public: |
|
119 enum Location { _in_field, _in_method, _in_class }; |
|
120 enum ID { |
|
121 _unknown = 0, |
|
122 _method_CallerSensitive, |
|
123 _method_ForceInline, |
|
124 _method_DontInline, |
|
125 _method_LambdaForm_Compiled, |
|
126 _method_LambdaForm_Hidden, |
|
127 _sun_misc_Contended, |
|
128 _field_Stable, |
|
129 _annotation_LIMIT |
|
130 }; |
|
131 const Location _location; |
|
132 int _annotations_present; |
|
133 u2 _contended_group; |
|
134 |
|
135 AnnotationCollector(Location location) |
|
136 : _location(location), _annotations_present(0) |
|
137 { |
|
138 assert((int)_annotation_LIMIT <= (int)sizeof(_annotations_present) * BitsPerByte, ""); |
|
139 } |
|
140 // If this annotation name has an ID, report it (or _none). |
|
141 ID annotation_index(ClassLoaderData* loader_data, Symbol* name); |
|
142 // Set the annotation name: |
|
143 void set_annotation(ID id) { |
|
144 assert((int)id >= 0 && (int)id < (int)_annotation_LIMIT, "oob"); |
|
145 _annotations_present |= nth_bit((int)id); |
|
146 } |
|
147 |
|
148 void remove_annotation(ID id) { |
|
149 assert((int)id >= 0 && (int)id < (int)_annotation_LIMIT, "oob"); |
|
150 _annotations_present &= ~nth_bit((int)id); |
|
151 } |
|
152 |
|
153 // Report if the annotation is present. |
|
154 bool has_any_annotations() const { return _annotations_present != 0; } |
|
155 bool has_annotation(ID id) const { return (nth_bit((int)id) & _annotations_present) != 0; } |
|
156 |
|
157 void set_contended_group(u2 group) { _contended_group = group; } |
|
158 u2 contended_group() const { return _contended_group; } |
|
159 |
|
160 bool is_contended() const { return has_annotation(_sun_misc_Contended); } |
|
161 |
|
162 void set_stable(bool stable) { set_annotation(_field_Stable); } |
|
163 bool is_stable() const { return has_annotation(_field_Stable); } |
|
164 }; |
|
165 |
|
166 // This class also doubles as a holder for metadata cleanup. |
|
167 class FieldAnnotationCollector: public AnnotationCollector { |
|
168 ClassLoaderData* _loader_data; |
|
169 AnnotationArray* _field_annotations; |
|
170 AnnotationArray* _field_type_annotations; |
|
171 public: |
|
172 FieldAnnotationCollector(ClassLoaderData* loader_data) : |
|
173 AnnotationCollector(_in_field), |
|
174 _loader_data(loader_data), |
|
175 _field_annotations(NULL), |
|
176 _field_type_annotations(NULL) {} |
|
177 void apply_to(FieldInfo* f); |
|
178 ~FieldAnnotationCollector(); |
|
179 AnnotationArray* field_annotations() { return _field_annotations; } |
|
180 AnnotationArray* field_type_annotations() { return _field_type_annotations; } |
|
181 |
|
182 void set_field_annotations(AnnotationArray* a) { _field_annotations = a; } |
|
183 void set_field_type_annotations(AnnotationArray* a) { _field_type_annotations = a; } |
|
184 }; |
|
185 |
|
186 class MethodAnnotationCollector: public AnnotationCollector { |
|
187 public: |
|
188 MethodAnnotationCollector() : AnnotationCollector(_in_method) { } |
|
189 void apply_to(methodHandle m); |
|
190 }; |
|
191 class ClassAnnotationCollector: public AnnotationCollector { |
|
192 public: |
|
193 ClassAnnotationCollector() : AnnotationCollector(_in_class) { } |
|
194 void apply_to(instanceKlassHandle k); |
|
195 }; |
|
196 |
|
197 enum { fixed_buffer_size = 128 }; |
|
198 u_char linenumbertable_buffer[fixed_buffer_size]; |
|
199 |
|
200 ClassFileStream* _stream; // Actual input stream |
|
201 |
|
202 enum { LegalClass, LegalField, LegalMethod }; // used to verify unqualified names |
|
203 |
|
204 // Accessors |
|
205 ClassFileStream* stream() { return _stream; } |
|
206 void set_stream(ClassFileStream* st) { _stream = st; } |
|
207 |
|
208 // Constant pool parsing |
|
209 void parse_constant_pool_entries(int length, TRAPS); |
|
210 |
|
211 constantPoolHandle parse_constant_pool(TRAPS); |
|
212 |
|
213 // Interface parsing |
|
214 Array<Klass*>* parse_interfaces(int length, |
|
215 Handle protection_domain, |
|
216 Symbol* class_name, |
|
217 bool* has_default_methods, |
|
218 TRAPS); |
|
219 void record_defined_class_dependencies(instanceKlassHandle defined_klass, TRAPS); |
|
220 |
|
221 instanceKlassHandle parse_super_class(int super_class_index, TRAPS); |
|
222 // Field parsing |
|
223 void parse_field_attributes(u2 attributes_count, |
|
224 bool is_static, u2 signature_index, |
|
225 u2* constantvalue_index_addr, |
|
226 bool* is_synthetic_addr, |
|
227 u2* generic_signature_index_addr, |
|
228 FieldAnnotationCollector* parsed_annotations, |
|
229 TRAPS); |
|
230 Array<u2>* parse_fields(Symbol* class_name, |
|
231 bool is_interface, |
|
232 FieldAllocationCount *fac, |
|
233 u2* java_fields_count_ptr, TRAPS); |
|
234 |
|
235 void print_field_layout(Symbol* name, |
|
236 Array<u2>* fields, |
|
237 constantPoolHandle cp, |
|
238 int instance_size, |
|
239 int instance_fields_start, |
|
240 int instance_fields_end, |
|
241 int static_fields_end); |
|
242 |
|
243 // Method parsing |
|
244 methodHandle parse_method(bool is_interface, |
|
245 AccessFlags* promoted_flags, |
|
246 TRAPS); |
|
247 Array<Method*>* parse_methods(bool is_interface, |
|
248 AccessFlags* promoted_flags, |
|
249 bool* has_final_method, |
|
250 bool* has_default_method, |
|
251 TRAPS); |
|
252 intArray* sort_methods(Array<Method*>* methods); |
|
253 |
|
254 u2* parse_exception_table(u4 code_length, u4 exception_table_length, |
|
255 TRAPS); |
|
256 void parse_linenumber_table( |
|
257 u4 code_attribute_length, u4 code_length, |
|
258 CompressedLineNumberWriteStream** write_stream, TRAPS); |
|
259 u2* parse_localvariable_table(u4 code_length, u2 max_locals, u4 code_attribute_length, |
|
260 u2* localvariable_table_length, |
|
261 bool isLVTT, TRAPS); |
|
262 u2* parse_checked_exceptions(u2* checked_exceptions_length, u4 method_attribute_length, |
|
263 TRAPS); |
|
264 void parse_type_array(u2 array_length, u4 code_length, u4* u1_index, u4* u2_index, |
|
265 u1* u1_array, u2* u2_array, TRAPS); |
|
266 u1* parse_stackmap_table(u4 code_attribute_length, TRAPS); |
|
267 |
|
268 // Classfile attribute parsing |
|
269 u2 parse_generic_signature_attribute(TRAPS); |
|
270 void parse_classfile_sourcefile_attribute(TRAPS); |
|
271 void parse_classfile_source_debug_extension_attribute(int length, TRAPS); |
|
272 u2 parse_classfile_inner_classes_attribute(u1* inner_classes_attribute_start, |
|
273 bool parsed_enclosingmethod_attribute, |
|
274 u2 enclosing_method_class_index, |
|
275 u2 enclosing_method_method_index, |
|
276 TRAPS); |
|
277 void parse_classfile_attributes(ClassAnnotationCollector* parsed_annotations, |
|
278 TRAPS); |
|
279 void parse_classfile_synthetic_attribute(TRAPS); |
|
280 void parse_classfile_signature_attribute(TRAPS); |
|
281 void parse_classfile_bootstrap_methods_attribute(u4 attribute_length, TRAPS); |
|
282 |
|
283 // Annotations handling |
|
284 AnnotationArray* assemble_annotations(u1* runtime_visible_annotations, |
|
285 int runtime_visible_annotations_length, |
|
286 u1* runtime_invisible_annotations, |
|
287 int runtime_invisible_annotations_length, TRAPS); |
|
288 int skip_annotation(u1* buffer, int limit, int index); |
|
289 int skip_annotation_value(u1* buffer, int limit, int index); |
|
290 void parse_annotations(u1* buffer, int limit, |
|
291 /* Results (currently, only one result is supported): */ |
|
292 AnnotationCollector* result, |
|
293 TRAPS); |
|
294 |
|
295 // Final setup |
|
296 unsigned int compute_oop_map_count(instanceKlassHandle super, |
|
297 unsigned int nonstatic_oop_count, |
|
298 int first_nonstatic_oop_offset); |
|
299 void fill_oop_maps(instanceKlassHandle k, |
|
300 unsigned int nonstatic_oop_map_count, |
|
301 int* nonstatic_oop_offsets, |
|
302 unsigned int* nonstatic_oop_counts); |
|
303 void set_precomputed_flags(instanceKlassHandle k); |
|
304 Array<Klass*>* compute_transitive_interfaces(instanceKlassHandle super, |
|
305 Array<Klass*>* local_ifs, TRAPS); |
|
306 |
|
307 // Format checker methods |
|
308 void classfile_parse_error(const char* msg, TRAPS); |
|
309 void classfile_parse_error(const char* msg, int index, TRAPS); |
|
310 void classfile_parse_error(const char* msg, const char *name, TRAPS); |
|
311 void classfile_parse_error(const char* msg, int index, const char *name, TRAPS); |
|
312 inline void guarantee_property(bool b, const char* msg, TRAPS) { |
|
313 if (!b) { classfile_parse_error(msg, CHECK); } |
|
314 } |
|
315 |
|
316 PRAGMA_DIAG_PUSH |
|
317 PRAGMA_FORMAT_NONLITERAL_IGNORED |
|
318 inline void assert_property(bool b, const char* msg, TRAPS) { |
|
319 #ifdef ASSERT |
|
320 if (!b) { |
|
321 ResourceMark rm(THREAD); |
|
322 fatal(err_msg(msg, _class_name->as_C_string())); |
|
323 } |
|
324 #endif |
|
325 } |
|
326 |
|
327 inline void assert_property(bool b, const char* msg, int index, TRAPS) { |
|
328 #ifdef ASSERT |
|
329 if (!b) { |
|
330 ResourceMark rm(THREAD); |
|
331 fatal(err_msg(msg, index, _class_name->as_C_string())); |
|
332 } |
|
333 #endif |
|
334 } |
|
335 PRAGMA_DIAG_POP |
|
336 |
|
337 inline void check_property(bool property, const char* msg, int index, TRAPS) { |
|
338 if (_need_verify) { |
|
339 guarantee_property(property, msg, index, CHECK); |
|
340 } else { |
|
341 assert_property(property, msg, index, CHECK); |
|
342 } |
|
343 } |
|
344 |
|
345 inline void check_property(bool property, const char* msg, TRAPS) { |
|
346 if (_need_verify) { |
|
347 guarantee_property(property, msg, CHECK); |
|
348 } else { |
|
349 assert_property(property, msg, CHECK); |
|
350 } |
|
351 } |
|
352 |
|
353 inline void guarantee_property(bool b, const char* msg, int index, TRAPS) { |
|
354 if (!b) { classfile_parse_error(msg, index, CHECK); } |
|
355 } |
|
356 inline void guarantee_property(bool b, const char* msg, const char *name, TRAPS) { |
|
357 if (!b) { classfile_parse_error(msg, name, CHECK); } |
|
358 } |
|
359 inline void guarantee_property(bool b, const char* msg, int index, const char *name, TRAPS) { |
|
360 if (!b) { classfile_parse_error(msg, index, name, CHECK); } |
|
361 } |
|
362 |
|
363 void throwIllegalSignature( |
|
364 const char* type, Symbol* name, Symbol* sig, TRAPS); |
|
365 |
|
366 bool is_supported_version(u2 major, u2 minor); |
|
367 bool has_illegal_visibility(jint flags); |
|
368 |
|
369 void verify_constantvalue(int constantvalue_index, int signature_index, TRAPS); |
|
370 void verify_legal_utf8(const unsigned char* buffer, int length, TRAPS); |
|
371 void verify_legal_class_name(Symbol* name, TRAPS); |
|
372 void verify_legal_field_name(Symbol* name, TRAPS); |
|
373 void verify_legal_method_name(Symbol* name, TRAPS); |
|
374 void verify_legal_field_signature(Symbol* fieldname, Symbol* signature, TRAPS); |
|
375 int verify_legal_method_signature(Symbol* methodname, Symbol* signature, TRAPS); |
|
376 void verify_legal_class_modifiers(jint flags, TRAPS); |
|
377 void verify_legal_field_modifiers(jint flags, bool is_interface, TRAPS); |
|
378 void verify_legal_method_modifiers(jint flags, bool is_interface, Symbol* name, TRAPS); |
|
379 bool verify_unqualified_name(char* name, unsigned int length, int type); |
|
380 char* skip_over_field_name(char* name, bool slash_ok, unsigned int length); |
|
381 char* skip_over_field_signature(char* signature, bool void_ok, unsigned int length, TRAPS); |
|
382 |
|
383 bool is_anonymous() { |
|
384 assert(EnableInvokeDynamic || _host_klass.is_null(), ""); |
|
385 return _host_klass.not_null(); |
|
386 } |
|
387 bool has_cp_patch_at(int index) { |
|
388 assert(EnableInvokeDynamic, ""); |
|
389 assert(index >= 0, "oob"); |
|
390 return (_cp_patches != NULL |
|
391 && index < _cp_patches->length() |
|
392 && _cp_patches->adr_at(index)->not_null()); |
|
393 } |
|
394 Handle cp_patch_at(int index) { |
|
395 assert(has_cp_patch_at(index), "oob"); |
|
396 return _cp_patches->at(index); |
|
397 } |
|
398 Handle clear_cp_patch_at(int index) { |
|
399 Handle patch = cp_patch_at(index); |
|
400 _cp_patches->at_put(index, Handle()); |
|
401 assert(!has_cp_patch_at(index), ""); |
|
402 return patch; |
|
403 } |
|
404 void patch_constant_pool(constantPoolHandle cp, int index, Handle patch, TRAPS); |
|
405 |
|
406 // Wrapper for constantTag.is_klass_[or_]reference. |
|
407 // In older versions of the VM, Klass*s cannot sneak into early phases of |
|
408 // constant pool construction, but in later versions they can. |
|
409 // %%% Let's phase out the old is_klass_reference. |
|
410 bool valid_klass_reference_at(int index) { |
|
411 return _cp->is_within_bounds(index) && |
|
412 (EnableInvokeDynamic |
|
413 ? _cp->tag_at(index).is_klass_or_reference() |
|
414 : _cp->tag_at(index).is_klass_reference()); |
|
415 } |
|
416 |
|
417 // Checks that the cpool index is in range and is a utf8 |
|
418 bool valid_symbol_at(int cpool_index) { |
|
419 return (_cp->is_within_bounds(cpool_index) && |
|
420 _cp->tag_at(cpool_index).is_utf8()); |
|
421 } |
|
422 |
|
423 void copy_localvariable_table(ConstMethod* cm, int lvt_cnt, |
|
424 u2* localvariable_table_length, |
|
425 u2** localvariable_table_start, |
|
426 int lvtt_cnt, |
|
427 u2* localvariable_type_table_length, |
|
428 u2** localvariable_type_table_start, |
|
429 TRAPS); |
|
430 |
|
431 void copy_method_annotations(ConstMethod* cm, |
|
432 u1* runtime_visible_annotations, |
|
433 int runtime_visible_annotations_length, |
|
434 u1* runtime_invisible_annotations, |
|
435 int runtime_invisible_annotations_length, |
|
436 u1* runtime_visible_parameter_annotations, |
|
437 int runtime_visible_parameter_annotations_length, |
|
438 u1* runtime_invisible_parameter_annotations, |
|
439 int runtime_invisible_parameter_annotations_length, |
|
440 u1* runtime_visible_type_annotations, |
|
441 int runtime_visible_type_annotations_length, |
|
442 u1* runtime_invisible_type_annotations, |
|
443 int runtime_invisible_type_annotations_length, |
|
444 u1* annotation_default, |
|
445 int annotation_default_length, |
|
446 TRAPS); |
|
447 |
|
448 // lays out fields in class and returns the total oopmap count |
|
449 void layout_fields(Handle class_loader, FieldAllocationCount* fac, |
|
450 ClassAnnotationCollector* parsed_annotations, |
|
451 FieldLayoutInfo* info, TRAPS); |
|
452 |
|
453 public: |
|
454 // Constructor |
|
455 ClassFileParser(ClassFileStream* st) { set_stream(st); } |
|
456 ~ClassFileParser(); |
|
457 |
|
458 // Parse .class file and return new Klass*. The Klass* is not hooked up |
|
459 // to the system dictionary or any other structures, so a .class file can |
|
460 // be loaded several times if desired. |
|
461 // The system dictionary hookup is done by the caller. |
|
462 // |
|
463 // "parsed_name" is updated by this method, and is the name found |
|
464 // while parsing the stream. |
|
465 instanceKlassHandle parseClassFile(Symbol* name, |
|
466 ClassLoaderData* loader_data, |
|
467 Handle protection_domain, |
|
468 TempNewSymbol& parsed_name, |
|
469 bool verify, |
|
470 TRAPS) { |
|
471 KlassHandle no_host_klass; |
|
472 return parseClassFile(name, loader_data, protection_domain, no_host_klass, NULL, parsed_name, verify, THREAD); |
|
473 } |
|
474 instanceKlassHandle parseClassFile(Symbol* name, |
|
475 ClassLoaderData* loader_data, |
|
476 Handle protection_domain, |
|
477 KlassHandle host_klass, |
|
478 GrowableArray<Handle>* cp_patches, |
|
479 TempNewSymbol& parsed_name, |
|
480 bool verify, |
|
481 TRAPS); |
|
482 |
|
483 // Verifier checks |
|
484 static void check_super_class_access(instanceKlassHandle this_klass, TRAPS); |
|
485 static void check_super_interface_access(instanceKlassHandle this_klass, TRAPS); |
|
486 static void check_final_method_override(instanceKlassHandle this_klass, TRAPS); |
|
487 static void check_illegal_static_method(instanceKlassHandle this_klass, TRAPS); |
|
488 }; |
|
489 |
|
490 #endif // SHARE_VM_CLASSFILE_CLASSFILEPARSER_HPP |