1 /*
2 * Copyright (c) 1997, 2024, 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 _first_field_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 _default_value_offset;
86 int _null_reset_value_offset;
87 bool _has_nonstatic_fields;
88 bool _is_naturally_atomic;
89 bool _must_be_atomic;
90 bool _has_inline_fields;
91 bool _is_empty_inline_klass;
92 };
93
94 // Parser for for .class files
95 //
96 // The bytes describing the class file structure is read from a Stream object
97
98 class ClassFileParser {
99 friend class FieldLayoutBuilder;
100 friend class FieldLayout;
101
102 class ClassAnnotationCollector;
103 class FieldAnnotationCollector;
104
105 public:
106 // The ClassFileParser has an associated "publicity" level
107 // It is used to control which subsystems (if any)
108 // will observe the parsing (logging, events, tracing).
109 // Default level is "BROADCAST", which is equivalent to
110 // a "public" parsing attempt.
111 //
112 // "INTERNAL" level should be entirely private to the
113 // caller - this allows for internal reuse of ClassFileParser
114 //
115 enum Publicity {
116 INTERNAL,
117 BROADCAST
118 };
119
120 enum { LegalClass, LegalField, LegalMethod }; // used to verify unqualified names
121
122 private:
123 // Potentially unaligned pointer to various 16-bit entries in the class file
124 typedef void unsafe_u2;
125
126 const ClassFileStream* _stream; // Actual input stream
127 Symbol* _class_name;
128 mutable ClassLoaderData* _loader_data;
129 const bool _is_hidden;
130 const bool _can_access_vm_annotations;
131 int _orig_cp_size;
132 unsigned int _static_oop_count;
133
134 // Metadata created before the instance klass is created. Must be deallocated
135 // if not transferred to the InstanceKlass upon successful class loading
136 // in which case these pointers have been set to null.
137 const InstanceKlass* _super_klass;
138 ConstantPool* _cp;
139 Array<u1>* _fieldinfo_stream;
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 bool _relax_verify;
207
208 bool _has_nonstatic_concrete_methods;
209 bool _declares_nonstatic_concrete_methods;
210 bool _has_localvariable_table;
211 bool _has_final_method;
212 bool _has_contended_fields;
213
214 bool _has_inline_type_fields;
215 bool _has_null_marker_offsets;
216 bool _is_naturally_atomic;
217 bool _must_be_atomic;
218 bool _is_implicitly_constructible;
219 bool _has_loosely_consistent_annotation;
220 bool _has_implicitly_constructible_annotation;
221
222 // precomputed flags
223 bool _has_finalizer;
224 bool _has_empty_finalizer;
225 int _max_bootstrap_specifier_index; // detects BSS values
226
227 void parse_stream(const ClassFileStream* const stream, TRAPS);
228
229 void mangle_hidden_class_name(InstanceKlass* const ik);
230
231 void post_process_parsed_stream(const ClassFileStream* const stream,
232 ConstantPool* cp,
233 TRAPS);
234
235 void fill_instance_klass(InstanceKlass* ik, bool cf_changed_in_CFLH,
236 const ClassInstanceInfo& cl_inst_info, TRAPS);
237
238 void set_klass(InstanceKlass* instance);
239
240 void set_class_bad_constant_seen(short bad_constant);
241 short class_bad_constant_seen() { return _bad_constant_seen; }
242 void set_class_synthetic_flag(bool x) { _synthetic_flag = x; }
243 void set_class_sourcefile_index(u2 x) { _sourcefile_index = x; }
244 void set_class_generic_signature_index(u2 x) { _generic_signature_index = x; }
245 void set_class_sde_buffer(const char* x, int len) { _sde_buffer = x; _sde_length = len; }
246
247 void create_combined_annotations(TRAPS);
248 void apply_parsed_class_attributes(InstanceKlass* k); // update k
249 void apply_parsed_class_metadata(InstanceKlass* k, int fields_count);
250 void clear_class_metadata();
251
252 // Constant pool parsing
253 void parse_constant_pool_entries(const ClassFileStream* const stream,
254 ConstantPool* cp,
255 const int length,
256 TRAPS);
257
258 void parse_constant_pool(const ClassFileStream* const cfs,
259 ConstantPool* const cp,
260 const int length,
261 TRAPS);
262
263 // Interface parsing
264 void parse_interfaces(const ClassFileStream* const stream,
265 const int itfs_len,
266 ConstantPool* const cp,
267 bool* has_nonstatic_concrete_methods,
268 TRAPS);
269
270 const InstanceKlass* parse_super_class(ConstantPool* const cp,
271 const int super_class_index,
272 const bool need_verify,
273 TRAPS);
274
275 // Field parsing
276 void parse_field_attributes(const ClassFileStream* const cfs,
277 u2 attributes_count,
278 bool is_static,
279 u2 signature_index,
280 u2* const constantvalue_index_addr,
281 bool* const is_synthetic_addr,
282 u2* const generic_signature_index_addr,
283 FieldAnnotationCollector* parsed_annotations,
284 TRAPS);
285
286 void parse_fields(const ClassFileStream* const cfs,
287 AccessFlags class_access_flags,
288 ConstantPool* cp,
289 const int cp_size,
290 u2* const java_fields_count_ptr,
291 TRAPS);
292
293 // Method parsing
294 Method* parse_method(const ClassFileStream* const cfs,
295 bool is_interface,
296 bool is_value_class,
297 bool is_abstract_class,
298 const ConstantPool* cp,
299 bool* const has_localvariable_table,
300 TRAPS);
301
302 void parse_methods(const ClassFileStream* const cfs,
303 bool is_interface,
304 bool is_value_class,
305 bool is_abstract_class,
306 bool* const has_localvariable_table,
307 bool* const has_final_method,
308 bool* const declares_nonstatic_concrete_methods,
309 TRAPS);
310
311 const unsafe_u2* parse_exception_table(const ClassFileStream* const stream,
312 u4 code_length,
313 u4 exception_table_length,
314 TRAPS);
315
316 void parse_linenumber_table(u4 code_attribute_length,
317 u4 code_length,
318 CompressedLineNumberWriteStream**const write_stream,
319 TRAPS);
320
321 const unsafe_u2* parse_localvariable_table(const ClassFileStream* const cfs,
322 u4 code_length,
323 u2 max_locals,
324 u4 code_attribute_length,
325 u2* const localvariable_table_length,
326 bool isLVTT,
327 TRAPS);
328
329 const unsafe_u2* parse_checked_exceptions(const ClassFileStream* const cfs,
330 u2* const checked_exceptions_length,
331 u4 method_attribute_length,
332 TRAPS);
333
334 // Classfile attribute parsing
335 u2 parse_generic_signature_attribute(const ClassFileStream* const cfs, TRAPS);
336 void parse_classfile_sourcefile_attribute(const ClassFileStream* const cfs, TRAPS);
337 void parse_classfile_source_debug_extension_attribute(const ClassFileStream* const cfs,
338 int length,
339 TRAPS);
340
341 // Check for circularity in InnerClasses attribute.
342 bool check_inner_classes_circularity(const ConstantPool* cp, int length, TRAPS);
343
344 u2 parse_classfile_inner_classes_attribute(const ClassFileStream* const cfs,
345 const ConstantPool* cp,
346 const u1* const inner_classes_attribute_start,
347 bool parsed_enclosingmethod_attribute,
348 u2 enclosing_method_class_index,
349 u2 enclosing_method_method_index,
350 TRAPS);
351
352 u2 parse_classfile_nest_members_attribute(const ClassFileStream* const cfs,
353 const u1* const nest_members_attribute_start,
354 TRAPS);
355
356 u2 parse_classfile_permitted_subclasses_attribute(const ClassFileStream* const cfs,
357 const u1* const permitted_subclasses_attribute_start,
358 TRAPS);
359
360 u2 parse_classfile_loadable_descriptors_attribute(const ClassFileStream* const cfs,
361 const u1* const loadable_descriptors_attribute_start,
362 TRAPS);
363
364 u4 parse_classfile_record_attribute(const ClassFileStream* const cfs,
365 const ConstantPool* cp,
366 const u1* const record_attribute_start,
367 TRAPS);
368
369 void parse_classfile_attributes(const ClassFileStream* const cfs,
370 ConstantPool* cp,
371 ClassAnnotationCollector* parsed_annotations,
372 TRAPS);
373
374 void parse_classfile_synthetic_attribute();
375 void parse_classfile_signature_attribute(const ClassFileStream* const cfs, TRAPS);
376 void parse_classfile_bootstrap_methods_attribute(const ClassFileStream* const cfs,
377 ConstantPool* cp,
378 u4 attribute_length,
379 TRAPS);
380
381 // Annotations handling
382 AnnotationArray* allocate_annotations(const u1* const anno,
383 int anno_length,
384 TRAPS);
385
386 void set_precomputed_flags(InstanceKlass* k);
387
388 // Format checker methods
389 void classfile_parse_error(const char* msg, TRAPS) const;
390 void classfile_parse_error(const char* msg, int index, TRAPS) const;
391 void classfile_parse_error(const char* msg, const char *name, TRAPS) const;
392 void classfile_parse_error(const char* msg,
393 int index,
394 const char *name,
395 TRAPS) const;
396 void classfile_parse_error(const char* msg,
397 const char* name,
398 const char* signature,
399 TRAPS) const;
400
401 void classfile_icce_error(const char* msg,
402 const Klass* k,
403 TRAPS) const;
404
405 void classfile_ucve_error(const char* msg,
406 const Symbol* class_name,
407 u2 major,
408 u2 minor,
409 TRAPS) const;
410
411 inline void guarantee_property(bool b, const char* msg, TRAPS) const {
412 if (!b) { classfile_parse_error(msg, THREAD); return; }
413 }
414
415 void report_assert_property_failure(const char* msg, TRAPS) const PRODUCT_RETURN;
416 void report_assert_property_failure(const char* msg, int index, TRAPS) const PRODUCT_RETURN;
417
418 inline void assert_property(bool b, const char* msg, TRAPS) const {
419 #ifdef ASSERT
420 if (!b) {
421 report_assert_property_failure(msg, THREAD);
422 }
423 #endif
424 }
425
426 inline void assert_property(bool b, const char* msg, int index, TRAPS) const {
427 #ifdef ASSERT
428 if (!b) {
429 report_assert_property_failure(msg, index, THREAD);
430 }
431 #endif
432 }
433
434 inline void check_property(bool property,
435 const char* msg,
436 int index,
437 TRAPS) const {
438 if (_need_verify) {
439 guarantee_property(property, msg, index, CHECK);
440 } else {
441 assert_property(property, msg, index, CHECK);
442 }
443 }
444
445 inline void check_property(bool property, const char* msg, TRAPS) const {
446 if (_need_verify) {
447 guarantee_property(property, msg, CHECK);
448 } else {
449 assert_property(property, msg, CHECK);
450 }
451 }
452
453 inline void guarantee_property(bool b,
454 const char* msg,
455 int index,
456 TRAPS) const {
457 if (!b) { classfile_parse_error(msg, index, THREAD); return; }
458 }
459
460 inline void guarantee_property(bool b,
461 const char* msg,
462 const char *name,
463 TRAPS) const {
464 if (!b) { classfile_parse_error(msg, name, THREAD); return; }
465 }
466
467 inline void guarantee_property(bool b,
468 const char* msg,
469 int index,
470 const char *name,
471 TRAPS) const {
472 if (!b) { classfile_parse_error(msg, index, name, THREAD); return; }
473 }
474
475 void throwIllegalSignature(const char* type,
476 const Symbol* name,
477 const Symbol* sig,
478 TRAPS) const;
479
480 void verify_constantvalue(const ConstantPool* const cp,
481 int constantvalue_index,
482 int signature_index,
483 TRAPS) const;
484
485 void verify_legal_utf8(const unsigned char* buffer, int length, TRAPS) const;
486 void verify_legal_class_name(const Symbol* name, TRAPS) const;
487 void verify_legal_field_name(const Symbol* name, TRAPS) const;
488 void verify_legal_method_name(const Symbol* name, TRAPS) const;
489
490 bool legal_field_signature(const Symbol* signature, TRAPS) const;
491
492 void verify_legal_field_signature(const Symbol* fieldname,
493 const Symbol* signature,
494 TRAPS) const;
495 int verify_legal_method_signature(const Symbol* methodname,
496 const Symbol* signature,
497 TRAPS) const;
498 void verify_legal_name_with_signature(const Symbol* name,
499 const Symbol* signature,
500 TRAPS) const;
501
502 void verify_class_version(u2 major, u2 minor, Symbol* class_name, TRAPS);
503
504 void verify_legal_class_modifiers(jint flags, const char* name, bool is_Object, TRAPS) const;
505 void verify_legal_field_modifiers(jint flags,
506 AccessFlags class_access_flags,
507 TRAPS) const;
508 void verify_legal_method_modifiers(jint flags,
509 AccessFlags class_access_flags,
510 const Symbol* name,
511 TRAPS) const;
512
513 void check_super_class_access(const InstanceKlass* this_klass,
514 TRAPS);
515
516 void check_super_interface_access(const InstanceKlass* this_klass,
517 TRAPS);
518
519 const char* skip_over_field_signature(const char* signature,
520 bool void_ok,
521 unsigned int length,
522 TRAPS) const;
523
524 // Wrapper for constantTag.is_klass_[or_]reference.
525 // In older versions of the VM, Klass*s cannot sneak into early phases of
526 // constant pool construction, but in later versions they can.
527 // %%% Let's phase out the old is_klass_reference.
528 bool valid_klass_reference_at(int index) const {
529 return _cp->is_within_bounds(index) &&
530 _cp->tag_at(index).is_klass_or_reference();
531 }
532
533 // Checks that the cpool index is in range and is a utf8
534 bool valid_symbol_at(int cpool_index) const {
535 return _cp->is_within_bounds(cpool_index) &&
536 _cp->tag_at(cpool_index).is_utf8();
537 }
538
539 void copy_localvariable_table(const ConstMethod* cm,
540 int lvt_cnt,
541 u2* const localvariable_table_length,
542 const unsafe_u2** const localvariable_table_start,
543 int lvtt_cnt,
544 u2* const localvariable_type_table_length,
545 const unsafe_u2** const localvariable_type_table_start,
546 TRAPS);
547
548 void copy_method_annotations(ConstMethod* cm,
549 const u1* runtime_visible_annotations,
550 int runtime_visible_annotations_length,
551 const u1* runtime_visible_parameter_annotations,
552 int runtime_visible_parameter_annotations_length,
553 const u1* runtime_visible_type_annotations,
554 int runtime_visible_type_annotations_length,
555 const u1* annotation_default,
556 int annotation_default_length,
557 TRAPS);
558
559 void update_class_name(Symbol* new_name);
560
561 // Check if the class file supports inline types
562 bool supports_inline_types() const;
563
564 public:
565 ClassFileParser(ClassFileStream* stream,
566 Symbol* name,
567 ClassLoaderData* loader_data,
568 const ClassLoadInfo* cl_info,
569 Publicity pub_level,
570 TRAPS);
571
572 ~ClassFileParser();
573
574 InstanceKlass* create_instance_klass(bool cf_changed_in_CFLH, const ClassInstanceInfo& cl_inst_info, TRAPS);
575
576 const ClassFileStream* clone_stream() const;
577
578 void set_klass_to_deallocate(InstanceKlass* klass);
579
580 int static_field_size() const;
581 int total_oop_map_count() const;
582 jint layout_size() const;
583
584 int vtable_size() const { return _vtable_size; }
585 int itable_size() const { return _itable_size; }
586
587 u2 this_class_index() const { return _this_class_index; }
588
589 bool is_hidden() const { return _is_hidden; }
590 bool is_interface() const { return _access_flags.is_interface(); }
591 // Being an inline type means being a concrete value class
592 bool is_inline_type() const { return !_access_flags.is_identity_class() && !_access_flags.is_interface() && !_access_flags.is_abstract(); }
593 bool is_abstract_class() const { return _access_flags.is_abstract(); }
594 bool is_identity_class() const { return _access_flags.is_identity_class(); }
595 bool has_inline_fields() const { return _has_inline_type_fields; }
596
597 u2 java_fields_count() const { return _java_fields_count; }
598 bool is_abstract() const { return _access_flags.is_abstract(); }
599
600 ClassLoaderData* loader_data() const { return _loader_data; }
601 const Symbol* class_name() const { return _class_name; }
602 const InstanceKlass* super_klass() const { return _super_klass; }
603
604 ReferenceType super_reference_type() const;
605 bool is_instance_ref_klass() const;
606 bool is_java_lang_ref_Reference_subclass() const;
607
608 AccessFlags access_flags() const { return _access_flags; }
609
610 bool is_internal() const { return INTERNAL == _pub_level; }
611
612 bool is_class_in_loadable_descriptors_attribute(Symbol *klass);
613
614 static bool verify_unqualified_name(const char* name, unsigned int length, int type);
615
616 #ifdef ASSERT
617 static bool is_internal_format(Symbol* class_name);
618 #endif
619
620 };
621
622 #endif // SHARE_CLASSFILE_CLASSFILEPARSER_HPP