1 /*
2 * Copyright (c) 1997, 2025, 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 int _payload_alignment;
78 int _payload_offset;
79 int _payload_size_in_bytes;
80 int _non_atomic_size_in_bytes;
81 int _non_atomic_alignment;
82 int _atomic_layout_size_in_bytes;
83 int _nullable_layout_size_in_bytes;
84 int _null_marker_offset;
85 int _null_reset_value_offset;
86 bool _has_nonstatic_fields;
87 bool _is_naturally_atomic;
88 bool _must_be_atomic;
89 bool _has_inline_fields;
90 bool _is_empty_inline_klass;
91 };
92
93 // Parser for for .class files
94 //
95 // The bytes describing the class file structure is read from a Stream object
96
97 class ClassFileParser {
98 friend class FieldLayoutBuilder;
99 friend class FieldLayout;
100
101 class ClassAnnotationCollector;
102 class FieldAnnotationCollector;
103
104 public:
105 // The ClassFileParser has an associated "publicity" level
106 // It is used to control which subsystems (if any)
107 // will observe the parsing (logging, events, tracing).
108 // Default level is "BROADCAST", which is equivalent to
109 // a "public" parsing attempt.
110 //
111 // "INTERNAL" level should be entirely private to the
112 // caller - this allows for internal reuse of ClassFileParser
113 //
114 enum Publicity {
115 INTERNAL,
116 BROADCAST
117 };
118
119 enum { LegalClass, LegalField, LegalMethod }; // used to verify unqualified names
120
121 private:
122 // Potentially unaligned pointer to various 16-bit entries in the class file
123 typedef void unsafe_u2;
124
125 const ClassFileStream* _stream; // Actual input stream
126 Symbol* _class_name;
127 mutable ClassLoaderData* _loader_data;
128 const bool _is_hidden;
129 const bool _can_access_vm_annotations;
130 int _orig_cp_size;
131 unsigned int _static_oop_count;
132
133 // Metadata created before the instance klass is created. Must be deallocated
134 // if not transferred to the InstanceKlass upon successful class loading
135 // in which case these pointers have been set to null.
136 const InstanceKlass* _super_klass;
137 ConstantPool* _cp;
138 Array<u1>* _fieldinfo_stream;
139 Array<u1>* _fieldinfo_search_table;
140 Array<FieldStatus>* _fields_status;
141 Array<Method*>* _methods;
142 Array<u2>* _inner_classes;
143 Array<u2>* _nest_members;
144 u2 _nest_host;
145 Array<u2>* _permitted_subclasses;
146 Array<u2>* _loadable_descriptors;
147 Array<RecordComponent*>* _record_components;
148 Array<InstanceKlass*>* _local_interfaces;
149 GrowableArray<u2>* _local_interface_indexes;
150 Array<InstanceKlass*>* _transitive_interfaces;
151 Annotations* _combined_annotations;
152 AnnotationArray* _class_annotations;
153 AnnotationArray* _class_type_annotations;
154 Array<AnnotationArray*>* _fields_annotations;
155 Array<AnnotationArray*>* _fields_type_annotations;
156 InstanceKlass* _klass; // InstanceKlass* once created.
157 InstanceKlass* _klass_to_deallocate; // an InstanceKlass* to be destroyed
158
159 ClassAnnotationCollector* _parsed_annotations;
160 FieldLayoutInfo* _layout_info;
161 Array<InlineLayoutInfo>* _inline_layout_info_array;
162 GrowableArray<FieldInfo>* _temp_field_info;
163 const intArray* _method_ordering;
164 GrowableArray<Method*>* _all_mirandas;
165
166 enum { fixed_buffer_size = 128 };
167 u_char _linenumbertable_buffer[fixed_buffer_size];
168
169 // Size of Java vtable (in words)
170 int _vtable_size;
171 int _itable_size;
172
173 int _num_miranda_methods;
174
175
176 Handle _protection_domain;
177 AccessFlags _access_flags;
178
179 // for tracing and notifications
180 Publicity _pub_level;
181
182 // Used to keep track of whether a constant pool item 19 or 20 is found. These
183 // correspond to CONSTANT_Module and CONSTANT_Package tags and are not allowed
184 // in regular class files. For class file version >= 53, a CFE cannot be thrown
185 // immediately when these are seen because a NCDFE must be thrown if the class's
186 // access_flags have ACC_MODULE set. But, the access_flags haven't been looked
187 // at yet. So, the bad constant pool item is cached here. A value of zero
188 // means that no constant pool item 19 or 20 was found.
189 short _bad_constant_seen;
190
191 // class attributes parsed before the instance klass is created:
192 bool _synthetic_flag;
193 int _sde_length;
194 const char* _sde_buffer;
195 u2 _sourcefile_index;
196 u2 _generic_signature_index;
197
198 u2 _major_version;
199 u2 _minor_version;
200 u2 _this_class_index;
201 u2 _super_class_index;
202 u2 _itfs_len;
203 u2 _java_fields_count;
204
205 bool _need_verify;
206
207 bool _has_nonstatic_concrete_methods;
208 bool _declares_nonstatic_concrete_methods;
209 bool _has_localvariable_table;
210 bool _has_final_method;
211 bool _has_contended_fields;
212 bool _has_aot_runtime_setup_method;
213 bool _has_strict_static_fields;
214
215 bool _has_inline_type_fields;
216 bool _is_naturally_atomic;
217 bool _must_be_atomic;
218 bool _has_loosely_consistent_annotation;
219
220 // precomputed flags
221 bool _has_finalizer;
222 bool _has_empty_finalizer;
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 void check_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 ConstantPool* cp,
287 const int cp_size,
288 u2* const java_fields_count_ptr,
289 TRAPS);
290
291 // Method parsing
292 Method* parse_method(const ClassFileStream* const cfs,
293 bool is_interface,
294 bool is_value_class,
295 bool is_abstract_class,
296 const ConstantPool* cp,
297 bool* const has_localvariable_table,
298 TRAPS);
299
300 void parse_methods(const ClassFileStream* const cfs,
301 bool is_interface,
302 bool is_value_class,
303 bool is_abstract_class,
304 bool* const has_localvariable_table,
305 bool* const has_final_method,
306 bool* const declares_nonstatic_concrete_methods,
307 TRAPS);
308
309 const unsafe_u2* parse_exception_table(const ClassFileStream* const stream,
310 u4 code_length,
311 u4 exception_table_length,
312 TRAPS);
313
314 void parse_linenumber_table(u4 code_attribute_length,
315 u4 code_length,
316 CompressedLineNumberWriteStream**const write_stream,
317 TRAPS);
318
319 const unsafe_u2* parse_localvariable_table(const ClassFileStream* const cfs,
320 u4 code_length,
321 u2 max_locals,
322 u4 code_attribute_length,
323 u2* const localvariable_table_length,
324 bool isLVTT,
325 TRAPS);
326
327 const unsafe_u2* parse_checked_exceptions(const ClassFileStream* const cfs,
328 u2* const checked_exceptions_length,
329 u4 method_attribute_length,
330 TRAPS);
331
332 // Classfile attribute parsing
333 u2 parse_generic_signature_attribute(const ClassFileStream* const cfs, TRAPS);
334 void parse_classfile_sourcefile_attribute(const ClassFileStream* const cfs, TRAPS);
335 void parse_classfile_source_debug_extension_attribute(const ClassFileStream* const cfs,
336 int length,
337 TRAPS);
338
339 // Check for circularity in InnerClasses attribute.
340 bool check_inner_classes_circularity(const ConstantPool* cp, int length, TRAPS);
341
342 u2 parse_classfile_inner_classes_attribute(const ClassFileStream* const cfs,
343 const ConstantPool* cp,
344 const u1* const inner_classes_attribute_start,
345 bool parsed_enclosingmethod_attribute,
346 u2 enclosing_method_class_index,
347 u2 enclosing_method_method_index,
348 TRAPS);
349
350 u2 parse_classfile_nest_members_attribute(const ClassFileStream* const cfs,
351 const u1* const nest_members_attribute_start,
352 TRAPS);
353
354 u2 parse_classfile_permitted_subclasses_attribute(const ClassFileStream* const cfs,
355 const u1* const permitted_subclasses_attribute_start,
356 TRAPS);
357
358 u2 parse_classfile_loadable_descriptors_attribute(const ClassFileStream* const cfs,
359 const u1* const loadable_descriptors_attribute_start,
360 TRAPS);
361
362 u4 parse_classfile_record_attribute(const ClassFileStream* const cfs,
363 const ConstantPool* cp,
364 const u1* const record_attribute_start,
365 TRAPS);
366
367 void parse_classfile_attributes(const ClassFileStream* const cfs,
368 ConstantPool* cp,
369 ClassAnnotationCollector* parsed_annotations,
370 TRAPS);
371
372 void parse_classfile_synthetic_attribute();
373 void parse_classfile_signature_attribute(const ClassFileStream* const cfs, TRAPS);
374 void parse_classfile_bootstrap_methods_attribute(const ClassFileStream* const cfs,
375 ConstantPool* cp,
376 u4 attribute_length,
377 TRAPS);
378
379 // Annotations handling
380 AnnotationArray* allocate_annotations(const u1* const anno,
381 int anno_length,
382 TRAPS);
383
384 void set_precomputed_flags(InstanceKlass* k);
385
386 // Format checker methods
387 void classfile_parse_error(const char* msg, TRAPS) const;
388 void classfile_parse_error(const char* msg, int index, TRAPS) const;
389 void classfile_parse_error(const char* msg, const char *name, TRAPS) const;
390 void classfile_parse_error(const char* msg,
391 int index,
392 const char *name,
393 TRAPS) const;
394 void classfile_parse_error(const char* msg,
395 const char* name,
396 const char* signature,
397 TRAPS) const;
398
399 void classfile_icce_error(const char* msg,
400 const Klass* k,
401 TRAPS) const;
402
403 // Uses msg directly in the ICCE, with no additional content
404 void classfile_icce_error(const char* msg,
405 TRAPS) const;
406
407 void classfile_ucve_error(const char* msg,
408 const Symbol* class_name,
409 u2 major,
410 u2 minor,
411 TRAPS) const;
412
413 inline void guarantee_property(bool b, const char* msg, TRAPS) const {
414 if (!b) { classfile_parse_error(msg, THREAD); return; }
415 }
416
417 inline void guarantee_property(bool b,
418 const char* msg,
419 int index,
420 TRAPS) const {
421 if (!b) { classfile_parse_error(msg, index, THREAD); return; }
422 }
423
424 inline void guarantee_property(bool b,
425 const char* msg,
426 const char *name,
427 TRAPS) const {
428 if (!b) { classfile_parse_error(msg, name, THREAD); return; }
429 }
430
431 inline void guarantee_property(bool b,
432 const char* msg,
433 int index,
434 const char *name,
435 TRAPS) const {
436 if (!b) { classfile_parse_error(msg, index, name, THREAD); return; }
437 }
438
439 void throwIllegalSignature(const char* type,
440 const Symbol* name,
441 const Symbol* sig,
442 TRAPS) const;
443
444 void verify_constantvalue(const ConstantPool* const cp,
445 int constantvalue_index,
446 int signature_index,
447 TRAPS) const;
448
449 void verify_legal_utf8(const unsigned char* buffer, int length, TRAPS) const;
450 void verify_legal_class_name(const Symbol* name, TRAPS) const;
451 void verify_legal_field_name(const Symbol* name, TRAPS) const;
452 void verify_legal_method_name(const Symbol* name, TRAPS) const;
453
454 bool legal_field_signature(const Symbol* signature, TRAPS) const;
455
456 void verify_legal_field_signature(const Symbol* fieldname,
457 const Symbol* signature,
458 TRAPS) const;
459 int verify_legal_method_signature(const Symbol* methodname,
460 const Symbol* signature,
461 TRAPS) const;
462 void verify_legal_name_with_signature(const Symbol* name,
463 const Symbol* signature,
464 TRAPS) const;
465
466 void verify_class_version(u2 major, u2 minor, Symbol* class_name, TRAPS);
467
468 void verify_legal_class_modifiers(jint flags, Symbol* inner_name,
469 bool is_anonymous_inner_class, TRAPS) const;
470 void verify_legal_field_modifiers(jint flags, AccessFlags class_access_flags, TRAPS) const;
471 void verify_legal_method_modifiers(jint flags,
472 AccessFlags class_access_flags,
473 const Symbol* name,
474 TRAPS) const;
475
476 void check_super_class_access(const InstanceKlass* this_klass,
477 TRAPS);
478
479 void check_super_interface_access(const InstanceKlass* this_klass,
480 TRAPS);
481
482 const char* skip_over_field_signature(const char* signature,
483 bool void_ok,
484 unsigned int length,
485 TRAPS) const;
486
487 // Wrapper for constantTag.is_klass_[or_]reference.
488 // In older versions of the VM, Klass*s cannot sneak into early phases of
489 // constant pool construction, but in later versions they can.
490 // %%% Let's phase out the old is_klass_reference.
491 bool valid_klass_reference_at(int index) const {
492 return _cp->is_within_bounds(index) &&
493 _cp->tag_at(index).is_klass_or_reference();
494 }
495
496 // Checks that the cpool index is in range and is a utf8
497 bool valid_symbol_at(int cpool_index) const {
498 return _cp->is_within_bounds(cpool_index) &&
499 _cp->tag_at(cpool_index).is_utf8();
500 }
501
502 void copy_localvariable_table(const ConstMethod* cm,
503 int lvt_cnt,
504 u2* const localvariable_table_length,
505 const unsafe_u2** const localvariable_table_start,
506 int lvtt_cnt,
507 u2* const localvariable_type_table_length,
508 const unsafe_u2** const localvariable_type_table_start,
509 TRAPS);
510
511 void copy_method_annotations(ConstMethod* cm,
512 const u1* runtime_visible_annotations,
513 int runtime_visible_annotations_length,
514 const u1* runtime_visible_parameter_annotations,
515 int runtime_visible_parameter_annotations_length,
516 const u1* runtime_visible_type_annotations,
517 int runtime_visible_type_annotations_length,
518 const u1* annotation_default,
519 int annotation_default_length,
520 TRAPS);
521
522 void update_class_name(Symbol* new_name);
523
524 // Check if the class file supports inline types
525 bool supports_inline_types() const;
526
527 public:
528 ClassFileParser(ClassFileStream* stream,
529 Symbol* name,
530 ClassLoaderData* loader_data,
531 const ClassLoadInfo* cl_info,
532 Publicity pub_level,
533 TRAPS);
534
535 ~ClassFileParser();
536
537 InstanceKlass* create_instance_klass(bool cf_changed_in_CFLH, const ClassInstanceInfo& cl_inst_info, TRAPS);
538
539 const ClassFileStream* clone_stream() const;
540
541 void set_klass_to_deallocate(InstanceKlass* klass);
542
543 int static_field_size() const;
544 int total_oop_map_count() const;
545 jint layout_size() const;
546
547 int vtable_size() const { return _vtable_size; }
548 int itable_size() const { return _itable_size; }
549
550 u2 this_class_index() const { return _this_class_index; }
551
552 bool is_hidden() const { return _is_hidden; }
553 bool is_interface() const { return _access_flags.is_interface(); }
554 // Being an inline type means being a concrete value class
555 bool is_inline_type() const { return !_access_flags.is_identity_class() && !_access_flags.is_interface() && !_access_flags.is_abstract(); }
556 bool is_abstract_class() const { return _access_flags.is_abstract(); }
557 bool is_identity_class() const { return _access_flags.is_identity_class(); }
558 bool has_inline_fields() const { return _has_inline_type_fields; }
559
560 u2 java_fields_count() const { return _java_fields_count; }
561 bool is_abstract() const { return _access_flags.is_abstract(); }
562
563 ClassLoaderData* loader_data() const { return _loader_data; }
564 const Symbol* class_name() const { return _class_name; }
565 const InstanceKlass* super_klass() const { return _super_klass; }
566
567 ReferenceType super_reference_type() const;
568 bool is_instance_ref_klass() const;
569 bool is_java_lang_ref_Reference_subclass() const;
570
571 AccessFlags access_flags() const { return _access_flags; }
572
573 bool is_internal() const { return INTERNAL == _pub_level; }
574
575 bool is_class_in_loadable_descriptors_attribute(Symbol *klass);
576
577 static bool verify_unqualified_name(const char* name, unsigned int length, int type);
578
579 #ifdef ASSERT
580 static bool is_internal_format(Symbol* class_name);
581 #endif
582
583 };
584
585 #endif // SHARE_CLASSFILE_CLASSFILEPARSER_HPP