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 _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<FieldStatus>* _fields_status;
140 Array<Method*>* _methods;
141 Array<u2>* _inner_classes;
142 Array<u2>* _nest_members;
143 u2 _nest_host;
144 Array<u2>* _permitted_subclasses;
145 Array<u2>* _loadable_descriptors;
146 Array<RecordComponent*>* _record_components;
147 Array<InstanceKlass*>* _local_interfaces;
148 GrowableArray<u2>* _local_interface_indexes;
149 Array<InstanceKlass*>* _transitive_interfaces;
150 Annotations* _combined_annotations;
151 AnnotationArray* _class_annotations;
152 AnnotationArray* _class_type_annotations;
153 Array<AnnotationArray*>* _fields_annotations;
154 Array<AnnotationArray*>* _fields_type_annotations;
155 InstanceKlass* _klass; // InstanceKlass* once created.
156 InstanceKlass* _klass_to_deallocate; // an InstanceKlass* to be destroyed
157
158 ClassAnnotationCollector* _parsed_annotations;
159 FieldLayoutInfo* _layout_info;
160 Array<InlineLayoutInfo>* _inline_layout_info_array;
161 GrowableArray<FieldInfo>* _temp_field_info;
162 const intArray* _method_ordering;
163 GrowableArray<Method*>* _all_mirandas;
164
165 enum { fixed_buffer_size = 128 };
166 u_char _linenumbertable_buffer[fixed_buffer_size];
167
168 // Size of Java vtable (in words)
169 int _vtable_size;
170 int _itable_size;
171
172 int _num_miranda_methods;
173
174
175 Handle _protection_domain;
176 AccessFlags _access_flags;
177
178 // for tracing and notifications
179 Publicity _pub_level;
180
181 // Used to keep track of whether a constant pool item 19 or 20 is found. These
182 // correspond to CONSTANT_Module and CONSTANT_Package tags and are not allowed
183 // in regular class files. For class file version >= 53, a CFE cannot be thrown
184 // immediately when these are seen because a NCDFE must be thrown if the class's
185 // access_flags have ACC_MODULE set. But, the access_flags haven't been looked
186 // at yet. So, the bad constant pool item is cached here. A value of zero
187 // means that no constant pool item 19 or 20 was found.
188 short _bad_constant_seen;
189
190 // class attributes parsed before the instance klass is created:
191 bool _synthetic_flag;
192 int _sde_length;
193 const char* _sde_buffer;
194 u2 _sourcefile_index;
195 u2 _generic_signature_index;
196
197 u2 _major_version;
198 u2 _minor_version;
199 u2 _this_class_index;
200 u2 _super_class_index;
201 u2 _itfs_len;
202 u2 _java_fields_count;
203
204 bool _need_verify;
205
206 bool _has_nonstatic_concrete_methods;
207 bool _declares_nonstatic_concrete_methods;
208 bool _has_localvariable_table;
209 bool _has_final_method;
210 bool _has_contended_fields;
211
212 bool _has_inline_type_fields;
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 int _max_bootstrap_specifier_index; // detects BSS values
223
224 void parse_stream(const ClassFileStream* const stream, TRAPS);
225
226 void mangle_hidden_class_name(InstanceKlass* const ik);
227
228 void post_process_parsed_stream(const ClassFileStream* const stream,
229 ConstantPool* cp,
230 TRAPS);
231
232 void fill_instance_klass(InstanceKlass* ik, bool cf_changed_in_CFLH,
233 const ClassInstanceInfo& cl_inst_info, TRAPS);
234
235 void set_klass(InstanceKlass* instance);
236
237 void set_class_bad_constant_seen(short bad_constant);
238 short class_bad_constant_seen() { return _bad_constant_seen; }
239 void set_class_synthetic_flag(bool x) { _synthetic_flag = x; }
240 void set_class_sourcefile_index(u2 x) { _sourcefile_index = x; }
241 void set_class_generic_signature_index(u2 x) { _generic_signature_index = x; }
242 void set_class_sde_buffer(const char* x, int len) { _sde_buffer = x; _sde_length = len; }
243
244 void create_combined_annotations(TRAPS);
245 void apply_parsed_class_attributes(InstanceKlass* k); // update k
246 void apply_parsed_class_metadata(InstanceKlass* k, int fields_count);
247 void clear_class_metadata();
248
249 // Constant pool parsing
250 void parse_constant_pool_entries(const ClassFileStream* const stream,
251 ConstantPool* cp,
252 const int length,
253 TRAPS);
254
255 void parse_constant_pool(const ClassFileStream* const cfs,
256 ConstantPool* const cp,
257 const int length,
258 TRAPS);
259
260 // Interface parsing
261 void parse_interfaces(const ClassFileStream* const stream,
262 const int itfs_len,
263 ConstantPool* const cp,
264 bool* has_nonstatic_concrete_methods,
265 TRAPS);
266
267 const InstanceKlass* parse_super_class(ConstantPool* const cp,
268 const int super_class_index,
269 const bool need_verify,
270 TRAPS);
271
272 // Field parsing
273 void parse_field_attributes(const ClassFileStream* const cfs,
274 u2 attributes_count,
275 bool is_static,
276 u2 signature_index,
277 u2* const constantvalue_index_addr,
278 bool* const is_synthetic_addr,
279 u2* const generic_signature_index_addr,
280 FieldAnnotationCollector* parsed_annotations,
281 TRAPS);
282
283 void parse_fields(const ClassFileStream* const cfs,
284 AccessFlags class_access_flags,
285 ConstantPool* cp,
286 const int cp_size,
287 u2* const java_fields_count_ptr,
288 TRAPS);
289
290 // Method parsing
291 Method* parse_method(const ClassFileStream* const cfs,
292 bool is_interface,
293 bool is_value_class,
294 bool is_abstract_class,
295 const ConstantPool* cp,
296 bool* const has_localvariable_table,
297 TRAPS);
298
299 void parse_methods(const ClassFileStream* const cfs,
300 bool is_interface,
301 bool is_value_class,
302 bool is_abstract_class,
303 bool* const has_localvariable_table,
304 bool* const has_final_method,
305 bool* const declares_nonstatic_concrete_methods,
306 TRAPS);
307
308 const unsafe_u2* parse_exception_table(const ClassFileStream* const stream,
309 u4 code_length,
310 u4 exception_table_length,
311 TRAPS);
312
313 void parse_linenumber_table(u4 code_attribute_length,
314 u4 code_length,
315 CompressedLineNumberWriteStream**const write_stream,
316 TRAPS);
317
318 const unsafe_u2* parse_localvariable_table(const ClassFileStream* const cfs,
319 u4 code_length,
320 u2 max_locals,
321 u4 code_attribute_length,
322 u2* const localvariable_table_length,
323 bool isLVTT,
324 TRAPS);
325
326 const unsafe_u2* parse_checked_exceptions(const ClassFileStream* const cfs,
327 u2* const checked_exceptions_length,
328 u4 method_attribute_length,
329 TRAPS);
330
331 // Classfile attribute parsing
332 u2 parse_generic_signature_attribute(const ClassFileStream* const cfs, TRAPS);
333 void parse_classfile_sourcefile_attribute(const ClassFileStream* const cfs, TRAPS);
334 void parse_classfile_source_debug_extension_attribute(const ClassFileStream* const cfs,
335 int length,
336 TRAPS);
337
338 // Check for circularity in InnerClasses attribute.
339 bool check_inner_classes_circularity(const ConstantPool* cp, int length, TRAPS);
340
341 u2 parse_classfile_inner_classes_attribute(const ClassFileStream* const cfs,
342 const ConstantPool* cp,
343 const u1* const inner_classes_attribute_start,
344 bool parsed_enclosingmethod_attribute,
345 u2 enclosing_method_class_index,
346 u2 enclosing_method_method_index,
347 TRAPS);
348
349 u2 parse_classfile_nest_members_attribute(const ClassFileStream* const cfs,
350 const u1* const nest_members_attribute_start,
351 TRAPS);
352
353 u2 parse_classfile_permitted_subclasses_attribute(const ClassFileStream* const cfs,
354 const u1* const permitted_subclasses_attribute_start,
355 TRAPS);
356
357 u2 parse_classfile_loadable_descriptors_attribute(const ClassFileStream* const cfs,
358 const u1* const loadable_descriptors_attribute_start,
359 TRAPS);
360
361 u4 parse_classfile_record_attribute(const ClassFileStream* const cfs,
362 const ConstantPool* cp,
363 const u1* const record_attribute_start,
364 TRAPS);
365
366 void parse_classfile_attributes(const ClassFileStream* const cfs,
367 ConstantPool* cp,
368 ClassAnnotationCollector* parsed_annotations,
369 TRAPS);
370
371 void parse_classfile_synthetic_attribute();
372 void parse_classfile_signature_attribute(const ClassFileStream* const cfs, TRAPS);
373 void parse_classfile_bootstrap_methods_attribute(const ClassFileStream* const cfs,
374 ConstantPool* cp,
375 u4 attribute_length,
376 TRAPS);
377
378 // Annotations handling
379 AnnotationArray* allocate_annotations(const u1* const anno,
380 int anno_length,
381 TRAPS);
382
383 void set_precomputed_flags(InstanceKlass* k);
384
385 // Format checker methods
386 void classfile_parse_error(const char* msg, TRAPS) const;
387 void classfile_parse_error(const char* msg, int index, TRAPS) const;
388 void classfile_parse_error(const char* msg, const char *name, TRAPS) const;
389 void classfile_parse_error(const char* msg,
390 int index,
391 const char *name,
392 TRAPS) const;
393 void classfile_parse_error(const char* msg,
394 const char* name,
395 const char* signature,
396 TRAPS) const;
397
398 void classfile_icce_error(const char* msg,
399 const Klass* k,
400 TRAPS) const;
401
402 // Uses msg directly in the ICCE, with no additional content
403 void classfile_icce_error(const char* msg,
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 inline void guarantee_property(bool b,
417 const char* msg,
418 int index,
419 TRAPS) const {
420 if (!b) { classfile_parse_error(msg, index, THREAD); return; }
421 }
422
423 inline void guarantee_property(bool b,
424 const char* msg,
425 const char *name,
426 TRAPS) const {
427 if (!b) { classfile_parse_error(msg, name, THREAD); return; }
428 }
429
430 inline void guarantee_property(bool b,
431 const char* msg,
432 int index,
433 const char *name,
434 TRAPS) const {
435 if (!b) { classfile_parse_error(msg, index, name, THREAD); return; }
436 }
437
438 void throwIllegalSignature(const char* type,
439 const Symbol* name,
440 const Symbol* sig,
441 TRAPS) const;
442
443 void verify_constantvalue(const ConstantPool* const cp,
444 int constantvalue_index,
445 int signature_index,
446 TRAPS) const;
447
448 void verify_legal_utf8(const unsigned char* buffer, int length, TRAPS) const;
449 void verify_legal_class_name(const Symbol* name, TRAPS) const;
450 void verify_legal_field_name(const Symbol* name, TRAPS) const;
451 void verify_legal_method_name(const Symbol* name, TRAPS) const;
452
453 bool legal_field_signature(const Symbol* signature, TRAPS) const;
454
455 void verify_legal_field_signature(const Symbol* fieldname,
456 const Symbol* signature,
457 TRAPS) const;
458 int verify_legal_method_signature(const Symbol* methodname,
459 const Symbol* signature,
460 TRAPS) const;
461 void verify_legal_name_with_signature(const Symbol* name,
462 const Symbol* signature,
463 TRAPS) const;
464
465 void verify_class_version(u2 major, u2 minor, Symbol* class_name, TRAPS);
466
467 void verify_legal_class_modifiers(jint flags, const char* name, bool is_Object, TRAPS) const;
468 void verify_legal_field_modifiers(jint flags,
469 AccessFlags class_access_flags,
470 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 // Returns true if the Klass to be generated will need to be addressable
564 // with a narrow Klass ID.
565 bool klass_needs_narrow_id() const;
566
567 ClassLoaderData* loader_data() const { return _loader_data; }
568 const Symbol* class_name() const { return _class_name; }
569 const InstanceKlass* super_klass() const { return _super_klass; }
570
571 ReferenceType super_reference_type() const;
572 bool is_instance_ref_klass() const;
573 bool is_java_lang_ref_Reference_subclass() const;
574
575 AccessFlags access_flags() const { return _access_flags; }
576
577 bool is_internal() const { return INTERNAL == _pub_level; }
578
579 bool is_class_in_loadable_descriptors_attribute(Symbol *klass);
580
581 static bool verify_unqualified_name(const char* name, unsigned int length, int type);
582
583 #ifdef ASSERT
584 static bool is_internal_format(Symbol* class_name);
585 #endif
586
587 };
588
589 #endif // SHARE_CLASSFILE_CLASSFILEPARSER_HPP