Mercurial > jdk8-mips64-public > hotspot / file revision
src/share/vm/classfile/classFileParser.hpp@ac27a9c85bea
src/share/vm/classfile/classFileParser.hpp
Thu, 24 May 2018 18:41:44 +0800
- author
- aoqi
- date
- Thu, 24 May 2018 18:41:44 +0800
- changeset 8856
- ac27a9c85bea
- parent 8761
- 4c3cae5323bb
- parent 7994
- 04ff2f6cd0eb
- child 9931
- fd44df5e3bc3
- permissions
- -rw-r--r--
Merge
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 */
25 #ifndef SHARE_VM_CLASSFILE_CLASSFILEPARSER_HPP
26 #define SHARE_VM_CLASSFILE_CLASSFILEPARSER_HPP
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"
36 class FieldAllocationCount;
37 class FieldLayoutInfo;
40 // Parser for for .class files
41 //
42 // The bytes describing the class file structure is read from a Stream object
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
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
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;
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 Annotations* _combined_annotations;
79 AnnotationArray* _annotations;
80 AnnotationArray* _type_annotations;
81 Array<AnnotationArray*>* _fields_annotations;
82 Array<AnnotationArray*>* _fields_type_annotations;
83 InstanceKlass* _klass; // InstanceKlass once created.
85 void set_class_synthetic_flag(bool x) { _synthetic_flag = x; }
86 void set_class_sourcefile_index(u2 x) { _sourcefile_index = x; }
87 void set_class_generic_signature_index(u2 x) { _generic_signature_index = x; }
88 void set_class_sde_buffer(char* x, int len) { _sde_buffer = x; _sde_length = len; }
90 void create_combined_annotations(TRAPS);
92 void init_parsed_class_attributes(ClassLoaderData* loader_data) {
93 _loader_data = loader_data;
94 _synthetic_flag = false;
95 _sourcefile_index = 0;
96 _generic_signature_index = 0;
97 _sde_buffer = NULL;
98 _sde_length = 0;
99 // initialize the other flags too:
100 _has_finalizer = _has_empty_finalizer = _has_vanilla_constructor = false;
101 _max_bootstrap_specifier_index = -1;
102 clear_class_metadata();
103 _klass = NULL;
104 }
105 void apply_parsed_class_attributes(instanceKlassHandle k); // update k
106 void apply_parsed_class_metadata(instanceKlassHandle k, int fields_count, TRAPS);
107 void clear_class_metadata() {
108 // metadata created before the instance klass is created. Must be
109 // deallocated if classfile parsing returns an error.
110 _cp = NULL;
111 _fields = NULL;
112 _methods = NULL;
113 _inner_classes = NULL;
114 _local_interfaces = NULL;
115 _transitive_interfaces = NULL;
116 _combined_annotations = NULL;
117 _annotations = _type_annotations = NULL;
118 _fields_annotations = _fields_type_annotations = NULL;
119 }
121 class AnnotationCollector {
122 public:
123 enum Location { _in_field, _in_method, _in_class };
124 enum ID {
125 _unknown = 0,
126 _method_CallerSensitive,
127 _method_ForceInline,
128 _method_DontInline,
129 _method_InjectedProfile,
130 _method_LambdaForm_Compiled,
131 _method_LambdaForm_Hidden,
132 _sun_misc_Contended,
133 _field_Stable,
134 _annotation_LIMIT
135 };
136 const Location _location;
137 int _annotations_present;
138 u2 _contended_group;
140 AnnotationCollector(Location location)
141 : _location(location), _annotations_present(0)
142 {
143 assert((int)_annotation_LIMIT <= (int)sizeof(_annotations_present) * BitsPerByte, "");
144 }
145 // If this annotation name has an ID, report it (or _none).
146 ID annotation_index(ClassLoaderData* loader_data, Symbol* name);
147 // Set the annotation name:
148 void set_annotation(ID id) {
149 assert((int)id >= 0 && (int)id < (int)_annotation_LIMIT, "oob");
150 _annotations_present |= nth_bit((int)id);
151 }
153 void remove_annotation(ID id) {
154 assert((int)id >= 0 && (int)id < (int)_annotation_LIMIT, "oob");
155 _annotations_present &= ~nth_bit((int)id);
156 }
158 // Report if the annotation is present.
159 bool has_any_annotations() const { return _annotations_present != 0; }
160 bool has_annotation(ID id) const { return (nth_bit((int)id) & _annotations_present) != 0; }
162 void set_contended_group(u2 group) { _contended_group = group; }
163 u2 contended_group() const { return _contended_group; }
165 bool is_contended() const { return has_annotation(_sun_misc_Contended); }
167 void set_stable(bool stable) { set_annotation(_field_Stable); }
168 bool is_stable() const { return has_annotation(_field_Stable); }
169 };
171 // This class also doubles as a holder for metadata cleanup.
172 class FieldAnnotationCollector: public AnnotationCollector {
173 ClassLoaderData* _loader_data;
174 AnnotationArray* _field_annotations;
175 AnnotationArray* _field_type_annotations;
176 public:
177 FieldAnnotationCollector(ClassLoaderData* loader_data) :
178 AnnotationCollector(_in_field),
179 _loader_data(loader_data),
180 _field_annotations(NULL),
181 _field_type_annotations(NULL) {}
182 void apply_to(FieldInfo* f);
183 ~FieldAnnotationCollector();
184 AnnotationArray* field_annotations() { return _field_annotations; }
185 AnnotationArray* field_type_annotations() { return _field_type_annotations; }
187 void set_field_annotations(AnnotationArray* a) { _field_annotations = a; }
188 void set_field_type_annotations(AnnotationArray* a) { _field_type_annotations = a; }
189 };
191 class MethodAnnotationCollector: public AnnotationCollector {
192 public:
193 MethodAnnotationCollector() : AnnotationCollector(_in_method) { }
194 void apply_to(methodHandle m);
195 };
196 class ClassAnnotationCollector: public AnnotationCollector {
197 public:
198 ClassAnnotationCollector() : AnnotationCollector(_in_class) { }
199 void apply_to(instanceKlassHandle k);
200 };
202 enum { fixed_buffer_size = 128 };
203 u_char linenumbertable_buffer[fixed_buffer_size];
205 ClassFileStream* _stream; // Actual input stream
207 enum { LegalClass, LegalField, LegalMethod }; // used to verify unqualified names
209 // Accessors
210 ClassFileStream* stream() { return _stream; }
211 void set_stream(ClassFileStream* st) { _stream = st; }
213 // Constant pool parsing
214 void parse_constant_pool_entries(int length, TRAPS);
216 constantPoolHandle parse_constant_pool(TRAPS);
218 // Interface parsing
219 Array<Klass*>* parse_interfaces(int length,
220 Handle protection_domain,
221 Symbol* class_name,
222 bool* has_default_methods,
223 TRAPS);
224 void record_defined_class_dependencies(instanceKlassHandle defined_klass, TRAPS);
226 instanceKlassHandle parse_super_class(int super_class_index, TRAPS);
227 // Field parsing
228 void parse_field_attributes(u2 attributes_count,
229 bool is_static, u2 signature_index,
230 u2* constantvalue_index_addr,
231 bool* is_synthetic_addr,
232 u2* generic_signature_index_addr,
233 FieldAnnotationCollector* parsed_annotations,
234 TRAPS);
235 Array<u2>* parse_fields(Symbol* class_name,
236 bool is_interface,
237 FieldAllocationCount *fac,
238 u2* java_fields_count_ptr, TRAPS);
240 void print_field_layout(Symbol* name,
241 Array<u2>* fields,
242 constantPoolHandle cp,
243 int instance_size,
244 int instance_fields_start,
245 int instance_fields_end,
246 int static_fields_end);
248 // Method parsing
249 methodHandle parse_method(bool is_interface,
250 AccessFlags* promoted_flags,
251 TRAPS);
252 Array<Method*>* parse_methods(bool is_interface,
253 AccessFlags* promoted_flags,
254 bool* has_final_method,
255 bool* declares_default_methods,
256 TRAPS);
257 intArray* sort_methods(Array<Method*>* methods);
259 u2* parse_exception_table(u4 code_length, u4 exception_table_length,
260 TRAPS);
261 void parse_linenumber_table(
262 u4 code_attribute_length, u4 code_length,
263 CompressedLineNumberWriteStream** write_stream, TRAPS);
264 u2* parse_localvariable_table(u4 code_length, u2 max_locals, u4 code_attribute_length,
265 u2* localvariable_table_length,
266 bool isLVTT, TRAPS);
267 u2* parse_checked_exceptions(u2* checked_exceptions_length, u4 method_attribute_length,
268 TRAPS);
269 void parse_type_array(u2 array_length, u4 code_length, u4* u1_index, u4* u2_index,
270 u1* u1_array, u2* u2_array, TRAPS);
271 u1* parse_stackmap_table(u4 code_attribute_length, TRAPS);
273 // Classfile attribute parsing
274 u2 parse_generic_signature_attribute(TRAPS);
275 void parse_classfile_sourcefile_attribute(TRAPS);
276 void parse_classfile_source_debug_extension_attribute(int length, TRAPS);
277 u2 parse_classfile_inner_classes_attribute(u1* inner_classes_attribute_start,
278 bool parsed_enclosingmethod_attribute,
279 u2 enclosing_method_class_index,
280 u2 enclosing_method_method_index,
281 TRAPS);
282 void parse_classfile_attributes(ClassAnnotationCollector* parsed_annotations,
283 TRAPS);
284 void parse_classfile_synthetic_attribute(TRAPS);
285 void parse_classfile_signature_attribute(TRAPS);
286 void parse_classfile_bootstrap_methods_attribute(u4 attribute_length, TRAPS);
288 // Annotations handling
289 AnnotationArray* assemble_annotations(u1* runtime_visible_annotations,
290 int runtime_visible_annotations_length,
291 u1* runtime_invisible_annotations,
292 int runtime_invisible_annotations_length, TRAPS);
293 int skip_annotation(u1* buffer, int limit, int index);
294 int skip_annotation_value(u1* buffer, int limit, int index);
295 void parse_annotations(u1* buffer, int limit,
296 /* Results (currently, only one result is supported): */
297 AnnotationCollector* result,
298 TRAPS);
300 // Final setup
301 unsigned int compute_oop_map_count(instanceKlassHandle super,
302 unsigned int nonstatic_oop_count,
303 int first_nonstatic_oop_offset);
304 void fill_oop_maps(instanceKlassHandle k,
305 unsigned int nonstatic_oop_map_count,
306 int* nonstatic_oop_offsets,
307 unsigned int* nonstatic_oop_counts);
308 void set_precomputed_flags(instanceKlassHandle k);
309 Array<Klass*>* compute_transitive_interfaces(instanceKlassHandle super,
310 Array<Klass*>* local_ifs, TRAPS);
312 // Format checker methods
313 void classfile_parse_error(const char* msg, TRAPS);
314 void classfile_parse_error(const char* msg, int index, TRAPS);
315 void classfile_parse_error(const char* msg, const char *name, TRAPS);
316 void classfile_parse_error(const char* msg, int index, const char *name, TRAPS);
317 void classfile_parse_error(const char* msg, const char* name, const char* signature, TRAPS);
318 inline void guarantee_property(bool b, const char* msg, TRAPS) {
319 if (!b) { classfile_parse_error(msg, CHECK); }
320 }
322 PRAGMA_DIAG_PUSH
323 PRAGMA_FORMAT_NONLITERAL_IGNORED
324 inline void assert_property(bool b, const char* msg, TRAPS) {
325 #ifdef ASSERT
326 if (!b) {
327 ResourceMark rm(THREAD);
328 fatal(err_msg(msg, _class_name->as_C_string()));
329 }
330 #endif
331 }
333 inline void assert_property(bool b, const char* msg, int index, TRAPS) {
334 #ifdef ASSERT
335 if (!b) {
336 ResourceMark rm(THREAD);
337 fatal(err_msg(msg, index, _class_name->as_C_string()));
338 }
339 #endif
340 }
341 PRAGMA_DIAG_POP
343 inline void check_property(bool property, const char* msg, int index, TRAPS) {
344 if (_need_verify) {
345 guarantee_property(property, msg, index, CHECK);
346 } else {
347 assert_property(property, msg, index, CHECK);
348 }
349 }
351 inline void check_property(bool property, const char* msg, TRAPS) {
352 if (_need_verify) {
353 guarantee_property(property, msg, CHECK);
354 } else {
355 assert_property(property, msg, CHECK);
356 }
357 }
359 inline void guarantee_property(bool b, const char* msg, int index, TRAPS) {
360 if (!b) { classfile_parse_error(msg, index, CHECK); }
361 }
362 inline void guarantee_property(bool b, const char* msg, const char *name, TRAPS) {
363 if (!b) { classfile_parse_error(msg, name, CHECK); }
364 }
365 inline void guarantee_property(bool b, const char* msg, int index, const char *name, TRAPS) {
366 if (!b) { classfile_parse_error(msg, index, name, CHECK); }
367 }
369 void throwIllegalSignature(
370 const char* type, Symbol* name, Symbol* sig, TRAPS);
372 bool is_supported_version(u2 major, u2 minor);
373 bool has_illegal_visibility(jint flags);
375 void verify_constantvalue(int constantvalue_index, int signature_index, TRAPS);
376 void verify_legal_utf8(const unsigned char* buffer, int length, TRAPS);
377 void verify_legal_class_name(Symbol* name, TRAPS);
378 void verify_legal_field_name(Symbol* name, TRAPS);
379 void verify_legal_method_name(Symbol* name, TRAPS);
380 void verify_legal_field_signature(Symbol* fieldname, Symbol* signature, TRAPS);
381 int verify_legal_method_signature(Symbol* methodname, Symbol* signature, TRAPS);
382 void verify_legal_class_modifiers(jint flags, TRAPS);
383 void verify_legal_field_modifiers(jint flags, bool is_interface, TRAPS);
384 void verify_legal_method_modifiers(jint flags, bool is_interface, Symbol* name, TRAPS);
385 bool verify_unqualified_name(char* name, unsigned int length, int type);
386 char* skip_over_field_name(char* name, bool slash_ok, unsigned int length);
387 char* skip_over_field_signature(char* signature, bool void_ok, unsigned int length, TRAPS);
389 bool is_anonymous() {
390 assert(EnableInvokeDynamic || _host_klass.is_null(), "");
391 return _host_klass.not_null();
392 }
393 bool has_cp_patch_at(int index) {
394 assert(EnableInvokeDynamic, "");
395 assert(index >= 0, "oob");
396 return (_cp_patches != NULL
397 && index < _cp_patches->length()
398 && _cp_patches->adr_at(index)->not_null());
399 }
400 Handle cp_patch_at(int index) {
401 assert(has_cp_patch_at(index), "oob");
402 return _cp_patches->at(index);
403 }
404 Handle clear_cp_patch_at(int index) {
405 Handle patch = cp_patch_at(index);
406 _cp_patches->at_put(index, Handle());
407 assert(!has_cp_patch_at(index), "");
408 return patch;
409 }
410 void patch_constant_pool(constantPoolHandle cp, int index, Handle patch, TRAPS);
412 // Wrapper for constantTag.is_klass_[or_]reference.
413 // In older versions of the VM, Klass*s cannot sneak into early phases of
414 // constant pool construction, but in later versions they can.
415 // %%% Let's phase out the old is_klass_reference.
416 bool valid_klass_reference_at(int index) {
417 return _cp->is_within_bounds(index) &&
418 (EnableInvokeDynamic
419 ? _cp->tag_at(index).is_klass_or_reference()
420 : _cp->tag_at(index).is_klass_reference());
421 }
423 // Checks that the cpool index is in range and is a utf8
424 bool valid_symbol_at(int cpool_index) {
425 return (_cp->is_within_bounds(cpool_index) &&
426 _cp->tag_at(cpool_index).is_utf8());
427 }
429 void copy_localvariable_table(ConstMethod* cm, int lvt_cnt,
430 u2* localvariable_table_length,
431 u2** localvariable_table_start,
432 int lvtt_cnt,
433 u2* localvariable_type_table_length,
434 u2** localvariable_type_table_start,
435 TRAPS);
437 void copy_method_annotations(ConstMethod* cm,
438 u1* runtime_visible_annotations,
439 int runtime_visible_annotations_length,
440 u1* runtime_invisible_annotations,
441 int runtime_invisible_annotations_length,
442 u1* runtime_visible_parameter_annotations,
443 int runtime_visible_parameter_annotations_length,
444 u1* runtime_invisible_parameter_annotations,
445 int runtime_invisible_parameter_annotations_length,
446 u1* runtime_visible_type_annotations,
447 int runtime_visible_type_annotations_length,
448 u1* runtime_invisible_type_annotations,
449 int runtime_invisible_type_annotations_length,
450 u1* annotation_default,
451 int annotation_default_length,
452 TRAPS);
454 // lays out fields in class and returns the total oopmap count
455 void layout_fields(Handle class_loader, FieldAllocationCount* fac,
456 ClassAnnotationCollector* parsed_annotations,
457 FieldLayoutInfo* info, TRAPS);
459 public:
460 // Constructor
461 ClassFileParser(ClassFileStream* st) { set_stream(st); }
462 ~ClassFileParser();
464 // Parse .class file and return new Klass*. The Klass* is not hooked up
465 // to the system dictionary or any other structures, so a .class file can
466 // be loaded several times if desired.
467 // The system dictionary hookup is done by the caller.
468 //
469 // "parsed_name" is updated by this method, and is the name found
470 // while parsing the stream.
471 instanceKlassHandle parseClassFile(Symbol* name,
472 ClassLoaderData* loader_data,
473 Handle protection_domain,
474 TempNewSymbol& parsed_name,
475 bool verify,
476 TRAPS) {
477 KlassHandle no_host_klass;
478 return parseClassFile(name, loader_data, protection_domain, no_host_klass, NULL, parsed_name, verify, THREAD);
479 }
480 instanceKlassHandle parseClassFile(Symbol* name,
481 ClassLoaderData* loader_data,
482 Handle protection_domain,
483 KlassHandle host_klass,
484 GrowableArray<Handle>* cp_patches,
485 TempNewSymbol& parsed_name,
486 bool verify,
487 TRAPS);
489 // Verifier checks
490 static void check_super_class_access(instanceKlassHandle this_klass, TRAPS);
491 static void check_super_interface_access(instanceKlassHandle this_klass, TRAPS);
492 static void check_final_method_override(instanceKlassHandle this_klass, TRAPS);
493 static void check_illegal_static_method(instanceKlassHandle this_klass, TRAPS);
494 };
496 #endif // SHARE_VM_CLASSFILE_CLASSFILEPARSER_HPP
