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