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