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