1 /*
2 * Copyright (c) 1997, 2023, 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_CLASSFILE_CLASSFILEPARSER_HPP
26 #define SHARE_CLASSFILE_CLASSFILEPARSER_HPP
27
28 #include "memory/referenceType.hpp"
29 #include "oops/annotations.hpp"
30 #include "oops/constantPool.hpp"
31 #include "oops/fieldInfo.hpp"
32 #include "oops/instanceKlass.hpp"
33 #include "oops/typeArrayOop.hpp"
34 #include "utilities/accessFlags.hpp"
35
36 class Annotations;
37 template <typename T>
38 class Array;
39 class ClassFileStream;
40 class ClassLoaderData;
41 class ClassLoadInfo;
42 class ClassInstanceInfo;
43 class CompressedLineNumberWriteStream;
44 class ConstMethod;
45 class FieldInfo;
46 template <typename T>
47 class GrowableArray;
48 class InstanceKlass;
49 class RecordComponent;
50 class Symbol;
51 class FieldLayoutBuilder;
52
53 // Utility to collect and compact oop maps during layout
54 class OopMapBlocksBuilder : public ResourceObj {
55 public:
56 OopMapBlock* _nonstatic_oop_maps;
57 unsigned int _nonstatic_oop_map_count;
58 unsigned int _max_nonstatic_oop_maps;
59
60 OopMapBlocksBuilder(unsigned int max_blocks);
61 OopMapBlock* last_oop_map() const;
62 void initialize_inherited_blocks(OopMapBlock* blocks, unsigned int nof_blocks);
63 void add(int offset, int count);
64 void copy(OopMapBlock* dst);
65 void compact();
66 void print_on(outputStream* st) const;
67 void print_value_on(outputStream* st) const;
68 };
69
70 // Values needed for oopmap and InstanceKlass creation
71 class FieldLayoutInfo : public ResourceObj {
72 public:
73 OopMapBlocksBuilder* oop_map_blocks;
74 int _instance_size;
75 int _nonstatic_field_size;
76 int _static_field_size;
77 bool _has_nonstatic_fields;
78 bool _is_naturally_atomic;
79 bool _has_inline_fields;
80 bool _has_null_marker_offsets;
81 };
82
83 // Parser for for .class files
84 //
85 // The bytes describing the class file structure is read from a Stream object
86
87 class ClassFileParser {
88 friend class FieldLayoutBuilder;
89 friend class FieldLayout;
90
91 class ClassAnnotationCollector;
92 class FieldAllocationCount;
93 class FieldAnnotationCollector;
94
95 public:
96 // The ClassFileParser has an associated "publicity" level
97 // It is used to control which subsystems (if any)
98 // will observe the parsing (logging, events, tracing).
99 // Default level is "BROADCAST", which is equivalent to
100 // a "public" parsing attempt.
101 //
102 // "INTERNAL" level should be entirely private to the
103 // caller - this allows for internal reuse of ClassFileParser
104 //
105 enum Publicity {
106 INTERNAL,
107 BROADCAST
108 };
109
110 enum { LegalClass, LegalField, LegalMethod }; // used to verify unqualified names
111
112 private:
113 // Potentially unaligned pointer to various 16-bit entries in the class file
114 typedef void unsafe_u2;
115
116 const ClassFileStream* _stream; // Actual input stream
117 Symbol* _class_name;
118 mutable ClassLoaderData* _loader_data;
119 const bool _is_hidden;
120 const bool _can_access_vm_annotations;
121 int _orig_cp_size;
122
123 // Metadata created before the instance klass is created. Must be deallocated
124 // if not transferred to the InstanceKlass upon successful class loading
125 // in which case these pointers have been set to null.
126 const InstanceKlass* _super_klass;
127 ConstantPool* _cp;
128 Array<u1>* _fieldinfo_stream;
129 Array<FieldStatus>* _fields_status;
130 Array<Method*>* _methods;
131 Array<u2>* _inner_classes;
132 Array<u2>* _nest_members;
133 u2 _nest_host;
134 Array<u2>* _permitted_subclasses;
135 Array<u2>* _loadable_descriptors;
136 Array<RecordComponent*>* _record_components;
137 Array<InstanceKlass*>* _local_interfaces;
138 GrowableArray<u2>* _local_interface_indexes;
139 Array<InstanceKlass*>* _transitive_interfaces;
140 Annotations* _combined_annotations;
141 AnnotationArray* _class_annotations;
142 AnnotationArray* _class_type_annotations;
143 Array<AnnotationArray*>* _fields_annotations;
144 Array<AnnotationArray*>* _fields_type_annotations;
145 InstanceKlass* _klass; // InstanceKlass* once created.
146 InstanceKlass* _klass_to_deallocate; // an InstanceKlass* to be destroyed
147
148 ClassAnnotationCollector* _parsed_annotations;
149 FieldAllocationCount* _fac;
150 FieldLayoutInfo* _field_info;
151 Array<InlineKlass*>* _inline_type_field_klasses;
152 Array<int>* _null_marker_offsets;
153 GrowableArray<FieldInfo>* _temp_field_info;
154 const intArray* _method_ordering;
155 GrowableArray<Method*>* _all_mirandas;
156
157 enum { fixed_buffer_size = 128 };
158 u_char _linenumbertable_buffer[fixed_buffer_size];
159
160 // Size of Java vtable (in words)
161 int _vtable_size;
162 int _itable_size;
163
164 int _num_miranda_methods;
165
166 int _alignment;
167 int _first_field_offset;
168 int _payload_size_in_bytes;
169 int _internal_null_marker_offset;
170
171 Handle _protection_domain;
172 AccessFlags _access_flags;
173
174 // for tracing and notifications
175 Publicity _pub_level;
176
177 // Used to keep track of whether a constant pool item 19 or 20 is found. These
178 // correspond to CONSTANT_Module and CONSTANT_Package tags and are not allowed
179 // in regular class files. For class file version >= 53, a CFE cannot be thrown
180 // immediately when these are seen because a NCDFE must be thrown if the class's
181 // access_flags have ACC_MODULE set. But, the access_flags haven't been looked
182 // at yet. So, the bad constant pool item is cached here. A value of zero
183 // means that no constant pool item 19 or 20 was found.
184 short _bad_constant_seen;
185
186 // class attributes parsed before the instance klass is created:
187 bool _synthetic_flag;
188 int _sde_length;
189 const char* _sde_buffer;
190 u2 _sourcefile_index;
191 u2 _generic_signature_index;
192
193 u2 _major_version;
194 u2 _minor_version;
195 u2 _this_class_index;
196 u2 _super_class_index;
197 u2 _itfs_len;
198 u2 _java_fields_count;
199
200 bool _need_verify;
201 bool _relax_verify;
202
203 bool _has_nonstatic_concrete_methods;
204 bool _declares_nonstatic_concrete_methods;
205 bool _has_localvariable_table;
206 bool _has_final_method;
207 bool _has_contended_fields;
208
209 bool _has_inline_type_fields;
210 bool _has_null_marker_offsets;
211 bool _has_nonstatic_fields;
212 bool _is_empty_inline_type;
213 bool _is_naturally_atomic;
214 bool _must_be_atomic;
215 bool _is_implicitly_constructible;
216 bool _has_loosely_consistent_annotation;
217 bool _has_implicitly_constructible_annotation;
218
219 // precomputed flags
220 bool _has_finalizer;
221 bool _has_empty_finalizer;
222 bool _has_vanilla_constructor;
223 int _max_bootstrap_specifier_index; // detects BSS values
224
225 void parse_stream(const ClassFileStream* const stream, TRAPS);
226
227 void mangle_hidden_class_name(InstanceKlass* const ik);
228
229 void post_process_parsed_stream(const ClassFileStream* const stream,
230 ConstantPool* cp,
231 TRAPS);
232
233 void fill_instance_klass(InstanceKlass* ik, bool cf_changed_in_CFLH,
234 const ClassInstanceInfo& cl_inst_info, TRAPS);
235
236 void set_klass(InstanceKlass* instance);
237
238 void set_class_bad_constant_seen(short bad_constant);
239 short class_bad_constant_seen() { return _bad_constant_seen; }
240 void set_class_synthetic_flag(bool x) { _synthetic_flag = x; }
241 void set_class_sourcefile_index(u2 x) { _sourcefile_index = x; }
242 void set_class_generic_signature_index(u2 x) { _generic_signature_index = x; }
243 void set_class_sde_buffer(const char* x, int len) { _sde_buffer = x; _sde_length = len; }
244
245 void create_combined_annotations(TRAPS);
246 void apply_parsed_class_attributes(InstanceKlass* k); // update k
247 void apply_parsed_class_metadata(InstanceKlass* k, int fields_count);
248 void clear_class_metadata();
249
250 // Constant pool parsing
251 void parse_constant_pool_entries(const ClassFileStream* const stream,
252 ConstantPool* cp,
253 const int length,
254 TRAPS);
255
256 void parse_constant_pool(const ClassFileStream* const cfs,
257 ConstantPool* const cp,
258 const int length,
259 TRAPS);
260
261 // Interface parsing
262 void parse_interfaces(const ClassFileStream* const stream,
263 const int itfs_len,
264 ConstantPool* const cp,
265 bool* has_nonstatic_concrete_methods,
266 TRAPS);
267
268 const InstanceKlass* parse_super_class(ConstantPool* const cp,
269 const int super_class_index,
270 const bool need_verify,
271 TRAPS);
272
273 // Field parsing
274 void parse_field_attributes(const ClassFileStream* const cfs,
275 u2 attributes_count,
276 bool is_static,
277 u2 signature_index,
278 u2* const constantvalue_index_addr,
279 bool* const is_synthetic_addr,
280 u2* const generic_signature_index_addr,
281 FieldAnnotationCollector* parsed_annotations,
282 TRAPS);
283
284 void parse_fields(const ClassFileStream* const cfs,
285 AccessFlags class_access_flags,
286 FieldAllocationCount* const fac,
287 ConstantPool* cp,
288 const int cp_size,
289 u2* const java_fields_count_ptr,
290 TRAPS);
291
292 // Method parsing
293 Method* parse_method(const ClassFileStream* const cfs,
294 bool is_interface,
295 bool is_value_class,
296 bool is_abstract_class,
297 const ConstantPool* cp,
298 bool* const has_localvariable_table,
299 TRAPS);
300
301 void parse_methods(const ClassFileStream* const cfs,
302 bool is_interface,
303 bool is_value_class,
304 bool is_abstract_class,
305 bool* const has_localvariable_table,
306 bool* const has_final_method,
307 bool* const declares_nonstatic_concrete_methods,
308 TRAPS);
309
310 const unsafe_u2* parse_exception_table(const ClassFileStream* const stream,
311 u4 code_length,
312 u4 exception_table_length,
313 TRAPS);
314
315 void parse_linenumber_table(u4 code_attribute_length,
316 u4 code_length,
317 CompressedLineNumberWriteStream**const write_stream,
318 TRAPS);
319
320 const unsafe_u2* parse_localvariable_table(const ClassFileStream* const cfs,
321 u4 code_length,
322 u2 max_locals,
323 u4 code_attribute_length,
324 u2* const localvariable_table_length,
325 bool isLVTT,
326 TRAPS);
327
328 const unsafe_u2* parse_checked_exceptions(const ClassFileStream* const cfs,
329 u2* const checked_exceptions_length,
330 u4 method_attribute_length,
331 TRAPS);
332
333 // Classfile attribute parsing
334 u2 parse_generic_signature_attribute(const ClassFileStream* const cfs, TRAPS);
335 void parse_classfile_sourcefile_attribute(const ClassFileStream* const cfs, TRAPS);
336 void parse_classfile_source_debug_extension_attribute(const ClassFileStream* const cfs,
337 int length,
338 TRAPS);
339
340 // Check for circularity in InnerClasses attribute.
341 bool check_inner_classes_circularity(const ConstantPool* cp, int length, TRAPS);
342
343 u2 parse_classfile_inner_classes_attribute(const ClassFileStream* const cfs,
344 const ConstantPool* cp,
345 const u1* const inner_classes_attribute_start,
346 bool parsed_enclosingmethod_attribute,
347 u2 enclosing_method_class_index,
348 u2 enclosing_method_method_index,
349 TRAPS);
350
351 u2 parse_classfile_nest_members_attribute(const ClassFileStream* const cfs,
352 const u1* const nest_members_attribute_start,
353 TRAPS);
354
355 u2 parse_classfile_permitted_subclasses_attribute(const ClassFileStream* const cfs,
356 const u1* const permitted_subclasses_attribute_start,
357 TRAPS);
358
359 u2 parse_classfile_loadable_descriptors_attribute(const ClassFileStream* const cfs,
360 const u1* const loadable_descriptors_attribute_start,
361 TRAPS);
362
363 u4 parse_classfile_record_attribute(const ClassFileStream* const cfs,
364 const ConstantPool* cp,
365 const u1* const record_attribute_start,
366 TRAPS);
367
368 void parse_classfile_attributes(const ClassFileStream* const cfs,
369 ConstantPool* cp,
370 ClassAnnotationCollector* parsed_annotations,
371 TRAPS);
372
373 void parse_classfile_synthetic_attribute();
374 void parse_classfile_signature_attribute(const ClassFileStream* const cfs, TRAPS);
375 void parse_classfile_bootstrap_methods_attribute(const ClassFileStream* const cfs,
376 ConstantPool* cp,
377 u4 attribute_length,
378 TRAPS);
379
380 // Annotations handling
381 AnnotationArray* assemble_annotations(const u1* const runtime_visible_annotations,
382 int runtime_visible_annotations_length,
383 const u1* const runtime_invisible_annotations,
384 int runtime_invisible_annotations_length,
385 TRAPS);
386
387 void set_precomputed_flags(InstanceKlass* k);
388
389 // Format checker methods
390 void classfile_parse_error(const char* msg, TRAPS) const;
391 void classfile_parse_error(const char* msg, int index, TRAPS) const;
392 void classfile_parse_error(const char* msg, const char *name, TRAPS) const;
393 void classfile_parse_error(const char* msg,
394 int index,
395 const char *name,
396 TRAPS) const;
397 void classfile_parse_error(const char* msg,
398 const char* name,
399 const char* signature,
400 TRAPS) const;
401
402 void classfile_icce_error(const char* msg,
403 const Klass* k,
404 TRAPS) const;
405
406 void classfile_ucve_error(const char* msg,
407 const Symbol* class_name,
408 u2 major,
409 u2 minor,
410 TRAPS) const;
411
412 inline void guarantee_property(bool b, const char* msg, TRAPS) const {
413 if (!b) { classfile_parse_error(msg, THREAD); return; }
414 }
415
416 void report_assert_property_failure(const char* msg, TRAPS) const PRODUCT_RETURN;
417 void report_assert_property_failure(const char* msg, int index, TRAPS) const PRODUCT_RETURN;
418
419 inline void assert_property(bool b, const char* msg, TRAPS) const {
420 #ifdef ASSERT
421 if (!b) {
422 report_assert_property_failure(msg, THREAD);
423 }
424 #endif
425 }
426
427 inline void assert_property(bool b, const char* msg, int index, TRAPS) const {
428 #ifdef ASSERT
429 if (!b) {
430 report_assert_property_failure(msg, index, THREAD);
431 }
432 #endif
433 }
434
435 inline void check_property(bool property,
436 const char* msg,
437 int index,
438 TRAPS) const {
439 if (_need_verify) {
440 guarantee_property(property, msg, index, CHECK);
441 } else {
442 assert_property(property, msg, index, CHECK);
443 }
444 }
445
446 inline void check_property(bool property, const char* msg, TRAPS) const {
447 if (_need_verify) {
448 guarantee_property(property, msg, CHECK);
449 } else {
450 assert_property(property, msg, CHECK);
451 }
452 }
453
454 inline void guarantee_property(bool b,
455 const char* msg,
456 int index,
457 TRAPS) const {
458 if (!b) { classfile_parse_error(msg, index, THREAD); return; }
459 }
460
461 inline void guarantee_property(bool b,
462 const char* msg,
463 const char *name,
464 TRAPS) const {
465 if (!b) { classfile_parse_error(msg, name, THREAD); return; }
466 }
467
468 inline void guarantee_property(bool b,
469 const char* msg,
470 int index,
471 const char *name,
472 TRAPS) const {
473 if (!b) { classfile_parse_error(msg, index, name, THREAD); return; }
474 }
475
476 void throwIllegalSignature(const char* type,
477 const Symbol* name,
478 const Symbol* sig,
479 TRAPS) const;
480
481 void verify_constantvalue(const ConstantPool* const cp,
482 int constantvalue_index,
483 int signature_index,
484 TRAPS) const;
485
486 void verify_legal_utf8(const unsigned char* buffer, int length, TRAPS) const;
487 void verify_legal_class_name(const Symbol* name, TRAPS) const;
488 void verify_legal_field_name(const Symbol* name, TRAPS) const;
489 void verify_legal_method_name(const Symbol* name, TRAPS) const;
490
491 bool legal_field_signature(const Symbol* signature, TRAPS) const;
492
493 void verify_legal_field_signature(const Symbol* fieldname,
494 const Symbol* signature,
495 TRAPS) const;
496 int verify_legal_method_signature(const Symbol* methodname,
497 const Symbol* signature,
498 TRAPS) const;
499 void verify_legal_name_with_signature(const Symbol* name,
500 const Symbol* signature,
501 TRAPS) const;
502
503 void verify_class_version(u2 major, u2 minor, Symbol* class_name, TRAPS);
504
505 void verify_legal_class_modifiers(jint flags, const char* name, bool is_Object, TRAPS) const;
506 void verify_legal_field_modifiers(jint flags,
507 AccessFlags class_access_flags,
508 TRAPS) const;
509 void verify_legal_method_modifiers(jint flags,
510 AccessFlags class_access_flags,
511 const Symbol* name,
512 TRAPS) const;
513
514 void check_super_class_access(const InstanceKlass* this_klass,
515 TRAPS);
516
517 void check_super_interface_access(const InstanceKlass* this_klass,
518 TRAPS);
519
520 const char* skip_over_field_signature(const char* signature,
521 bool void_ok,
522 unsigned int length,
523 TRAPS) const;
524
525 // Wrapper for constantTag.is_klass_[or_]reference.
526 // In older versions of the VM, Klass*s cannot sneak into early phases of
527 // constant pool construction, but in later versions they can.
528 // %%% Let's phase out the old is_klass_reference.
529 bool valid_klass_reference_at(int index) const {
530 return _cp->is_within_bounds(index) &&
531 _cp->tag_at(index).is_klass_or_reference();
532 }
533
534 // Checks that the cpool index is in range and is a utf8
535 bool valid_symbol_at(int cpool_index) const {
536 return _cp->is_within_bounds(cpool_index) &&
537 _cp->tag_at(cpool_index).is_utf8();
538 }
539
540 void copy_localvariable_table(const ConstMethod* cm,
541 int lvt_cnt,
542 u2* const localvariable_table_length,
543 const unsafe_u2** const localvariable_table_start,
544 int lvtt_cnt,
545 u2* const localvariable_type_table_length,
546 const unsafe_u2** const localvariable_type_table_start,
547 TRAPS);
548
549 void copy_method_annotations(ConstMethod* cm,
550 const u1* runtime_visible_annotations,
551 int runtime_visible_annotations_length,
552 const u1* runtime_invisible_annotations,
553 int runtime_invisible_annotations_length,
554 const u1* runtime_visible_parameter_annotations,
555 int runtime_visible_parameter_annotations_length,
556 const u1* runtime_invisible_parameter_annotations,
557 int runtime_invisible_parameter_annotations_length,
558 const u1* runtime_visible_type_annotations,
559 int runtime_visible_type_annotations_length,
560 const u1* runtime_invisible_type_annotations,
561 int runtime_invisible_type_annotations_length,
562 const u1* annotation_default,
563 int annotation_default_length,
564 TRAPS);
565
566 void update_class_name(Symbol* new_name);
567
568 // Check if the class file supports inline types
569 bool supports_inline_types() const;
570
571 public:
572 ClassFileParser(ClassFileStream* stream,
573 Symbol* name,
574 ClassLoaderData* loader_data,
575 const ClassLoadInfo* cl_info,
576 Publicity pub_level,
577 TRAPS);
578
579 ~ClassFileParser();
580
581 InstanceKlass* create_instance_klass(bool cf_changed_in_CFLH, const ClassInstanceInfo& cl_inst_info, TRAPS);
582
583 const ClassFileStream* clone_stream() const;
584
585 void set_klass_to_deallocate(InstanceKlass* klass);
586
587 int static_field_size() const;
588 int total_oop_map_count() const;
589 jint layout_size() const;
590
591 int vtable_size() const { return _vtable_size; }
592 int itable_size() const { return _itable_size; }
593
594 u2 this_class_index() const { return _this_class_index; }
595
596 bool is_hidden() const { return _is_hidden; }
597 bool is_interface() const { return _access_flags.is_interface(); }
598 // Being an inline type means being a concrete value class
599 bool is_inline_type() const { return !_access_flags.is_identity_class() && !_access_flags.is_interface() && !_access_flags.is_abstract(); }
600 bool is_abstract_class() const { return _access_flags.is_abstract(); }
601 bool is_identity_class() const { return _access_flags.is_identity_class(); }
602 bool has_inline_fields() const { return _has_inline_type_fields; }
603
604 u2 java_fields_count() const { return _java_fields_count; }
605
606 ClassLoaderData* loader_data() const { return _loader_data; }
607 const Symbol* class_name() const { return _class_name; }
608 const InstanceKlass* super_klass() const { return _super_klass; }
609
610 ReferenceType super_reference_type() const;
611 bool is_instance_ref_klass() const;
612 bool is_java_lang_ref_Reference_subclass() const;
613
614 AccessFlags access_flags() const { return _access_flags; }
615
616 bool is_internal() const { return INTERNAL == _pub_level; }
617
618 bool is_class_in_loadable_descriptors_attribute(Symbol *klass);
619
620 static bool verify_unqualified_name(const char* name, unsigned int length, int type);
621
622 #ifdef ASSERT
623 static bool is_internal_format(Symbol* class_name);
624 #endif
625
626 };
627
628 #endif // SHARE_CLASSFILE_CLASSFILEPARSER_HPP