1 /*
2 * Copyright (c) 1997, 2023, 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 FieldAllocationCount;
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
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 FieldAllocationCount* _fac;
145 FieldLayoutInfo* _field_info;
146 GrowableArray<FieldInfo>* _temp_field_info;
147 const intArray* _method_ordering;
148 GrowableArray<Method*>* _all_mirandas;
149
150 enum { fixed_buffer_size = 128 };
151 u_char _linenumbertable_buffer[fixed_buffer_size];
152
153 // Size of Java vtable (in words)
154 int _vtable_size;
155 int _itable_size;
156
157 int _num_miranda_methods;
158
159 Handle _protection_domain;
160 AccessFlags _access_flags;
161
162 // for tracing and notifications
163 Publicity _pub_level;
164
165 // Used to keep track of whether a constant pool item 19 or 20 is found. These
166 // correspond to CONSTANT_Module and CONSTANT_Package tags and are not allowed
167 // in regular class files. For class file version >= 53, a CFE cannot be thrown
168 // immediately when these are seen because a NCDFE must be thrown if the class's
169 // access_flags have ACC_MODULE set. But, the access_flags haven't been looked
170 // at yet. So, the bad constant pool item is cached here. A value of zero
171 // means that no constant pool item 19 or 20 was found.
172 short _bad_constant_seen;
173
174 // class attributes parsed before the instance klass is created:
175 bool _synthetic_flag;
176 int _sde_length;
177 const char* _sde_buffer;
178 u2 _sourcefile_index;
179 u2 _generic_signature_index;
180
181 u2 _major_version;
182 u2 _minor_version;
183 u2 _this_class_index;
184 u2 _super_class_index;
185 u2 _itfs_len;
186 u2 _java_fields_count;
187
188 bool _need_verify;
189 bool _relax_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 bool _has_vanilla_constructor;
201 int _max_bootstrap_specifier_index; // detects BSS values
202
203 void parse_stream(const ClassFileStream* const stream, TRAPS);
204
205 void mangle_hidden_class_name(InstanceKlass* const ik);
206
207 void post_process_parsed_stream(const ClassFileStream* const stream,
208 ConstantPool* cp,
209 TRAPS);
210
211 void fill_instance_klass(InstanceKlass* ik, bool cf_changed_in_CFLH,
212 const ClassInstanceInfo& cl_inst_info, TRAPS);
213
214 void set_klass(InstanceKlass* instance);
215
216 void set_class_bad_constant_seen(short bad_constant);
217 short class_bad_constant_seen() { return _bad_constant_seen; }
218 void set_class_synthetic_flag(bool x) { _synthetic_flag = x; }
219 void set_class_sourcefile_index(u2 x) { _sourcefile_index = x; }
220 void set_class_generic_signature_index(u2 x) { _generic_signature_index = x; }
221 void set_class_sde_buffer(const char* x, int len) { _sde_buffer = x; _sde_length = len; }
222
223 void create_combined_annotations(TRAPS);
224 void apply_parsed_class_attributes(InstanceKlass* k); // update k
225 void apply_parsed_class_metadata(InstanceKlass* k, int fields_count);
226 void clear_class_metadata();
227
228 // Constant pool parsing
229 void parse_constant_pool_entries(const ClassFileStream* const stream,
230 ConstantPool* cp,
231 const int length,
232 TRAPS);
233
234 void parse_constant_pool(const ClassFileStream* const cfs,
235 ConstantPool* const cp,
236 const int length,
237 TRAPS);
238
239 // Interface parsing
240 void parse_interfaces(const ClassFileStream* const stream,
241 const int itfs_len,
242 ConstantPool* const cp,
243 bool* has_nonstatic_concrete_methods,
244 TRAPS);
245
246 const InstanceKlass* parse_super_class(ConstantPool* const cp,
247 const int super_class_index,
248 const bool need_verify,
249 TRAPS);
250
251 // Field parsing
252 void parse_field_attributes(const ClassFileStream* const cfs,
253 u2 attributes_count,
254 bool is_static,
255 u2 signature_index,
256 u2* const constantvalue_index_addr,
257 bool* const is_synthetic_addr,
258 u2* const generic_signature_index_addr,
259 FieldAnnotationCollector* parsed_annotations,
260 TRAPS);
261
262 void parse_fields(const ClassFileStream* const cfs,
263 bool is_interface,
264 FieldAllocationCount* const fac,
265 ConstantPool* cp,
266 const int cp_size,
267 u2* const java_fields_count_ptr,
268 TRAPS);
269
270 // Method parsing
271 Method* parse_method(const ClassFileStream* const cfs,
272 bool is_interface,
273 const ConstantPool* cp,
274 bool* const has_localvariable_table,
275 TRAPS);
276
277 void parse_methods(const ClassFileStream* const cfs,
278 bool is_interface,
279 bool* const has_localvariable_table,
280 bool* const has_final_method,
281 bool* const declares_nonstatic_concrete_methods,
282 TRAPS);
283
284 const unsafe_u2* parse_exception_table(const ClassFileStream* const stream,
285 u4 code_length,
286 u4 exception_table_length,
287 TRAPS);
288
289 void parse_linenumber_table(u4 code_attribute_length,
290 u4 code_length,
291 CompressedLineNumberWriteStream**const write_stream,
292 TRAPS);
293
294 const unsafe_u2* parse_localvariable_table(const ClassFileStream* const cfs,
295 u4 code_length,
296 u2 max_locals,
297 u4 code_attribute_length,
298 u2* const localvariable_table_length,
299 bool isLVTT,
300 TRAPS);
301
302 const unsafe_u2* parse_checked_exceptions(const ClassFileStream* const cfs,
303 u2* const checked_exceptions_length,
304 u4 method_attribute_length,
305 TRAPS);
306
307 // Classfile attribute parsing
308 u2 parse_generic_signature_attribute(const ClassFileStream* const cfs, TRAPS);
309 void parse_classfile_sourcefile_attribute(const ClassFileStream* const cfs, TRAPS);
310 void parse_classfile_source_debug_extension_attribute(const ClassFileStream* const cfs,
311 int length,
312 TRAPS);
313
314 // Check for circularity in InnerClasses attribute.
315 bool check_inner_classes_circularity(const ConstantPool* cp, int length, TRAPS);
316
317 u2 parse_classfile_inner_classes_attribute(const ClassFileStream* const cfs,
318 const ConstantPool* cp,
319 const u1* const inner_classes_attribute_start,
320 bool parsed_enclosingmethod_attribute,
321 u2 enclosing_method_class_index,
322 u2 enclosing_method_method_index,
323 TRAPS);
324
325 u2 parse_classfile_nest_members_attribute(const ClassFileStream* const cfs,
326 const u1* const nest_members_attribute_start,
327 TRAPS);
328
329 u2 parse_classfile_permitted_subclasses_attribute(const ClassFileStream* const cfs,
330 const u1* const permitted_subclasses_attribute_start,
331 TRAPS);
332
333 u4 parse_classfile_record_attribute(const ClassFileStream* const cfs,
334 const ConstantPool* cp,
335 const u1* const record_attribute_start,
336 TRAPS);
337
338 void parse_classfile_attributes(const ClassFileStream* const cfs,
339 ConstantPool* cp,
340 ClassAnnotationCollector* parsed_annotations,
341 TRAPS);
342
343 void parse_classfile_synthetic_attribute();
344 void parse_classfile_signature_attribute(const ClassFileStream* const cfs, TRAPS);
345 void parse_classfile_bootstrap_methods_attribute(const ClassFileStream* const cfs,
346 ConstantPool* cp,
347 u4 attribute_length,
348 TRAPS);
349
350 // Annotations handling
351 AnnotationArray* assemble_annotations(const u1* const runtime_visible_annotations,
352 int runtime_visible_annotations_length,
353 const u1* const runtime_invisible_annotations,
354 int runtime_invisible_annotations_length,
355 TRAPS);
356
357 void set_precomputed_flags(InstanceKlass* k);
358
359 // Format checker methods
360 void classfile_parse_error(const char* msg, TRAPS) const;
361 void classfile_parse_error(const char* msg, int index, TRAPS) const;
362 void classfile_parse_error(const char* msg, const char *name, TRAPS) const;
363 void classfile_parse_error(const char* msg,
364 int index,
365 const char *name,
366 TRAPS) const;
367 void classfile_parse_error(const char* msg,
368 const char* name,
369 const char* signature,
370 TRAPS) const;
371
372 void classfile_icce_error(const char* msg,
373 const Klass* k,
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 void report_assert_property_failure(const char* msg, TRAPS) const PRODUCT_RETURN;
387 void report_assert_property_failure(const char* msg, int index, TRAPS) const PRODUCT_RETURN;
388
389 inline void assert_property(bool b, const char* msg, TRAPS) const {
390 #ifdef ASSERT
391 if (!b) {
392 report_assert_property_failure(msg, THREAD);
393 }
394 #endif
395 }
396
397 inline void assert_property(bool b, const char* msg, int index, TRAPS) const {
398 #ifdef ASSERT
399 if (!b) {
400 report_assert_property_failure(msg, index, THREAD);
401 }
402 #endif
403 }
404
405 inline void check_property(bool property,
406 const char* msg,
407 int index,
408 TRAPS) const {
409 if (_need_verify) {
410 guarantee_property(property, msg, index, CHECK);
411 } else {
412 assert_property(property, msg, index, CHECK);
413 }
414 }
415
416 inline void check_property(bool property, const char* msg, TRAPS) const {
417 if (_need_verify) {
418 guarantee_property(property, msg, CHECK);
419 } else {
420 assert_property(property, msg, CHECK);
421 }
422 }
423
424 inline void guarantee_property(bool b,
425 const char* msg,
426 int index,
427 TRAPS) const {
428 if (!b) { classfile_parse_error(msg, index, THREAD); return; }
429 }
430
431 inline void guarantee_property(bool b,
432 const char* msg,
433 const char *name,
434 TRAPS) const {
435 if (!b) { classfile_parse_error(msg, name, THREAD); return; }
436 }
437
438 inline void guarantee_property(bool b,
439 const char* msg,
440 int index,
441 const char *name,
442 TRAPS) const {
443 if (!b) { classfile_parse_error(msg, index, name, THREAD); return; }
444 }
445
446 void throwIllegalSignature(const char* type,
447 const Symbol* name,
448 const Symbol* sig,
449 TRAPS) const;
450
451 void verify_constantvalue(const ConstantPool* const cp,
452 int constantvalue_index,
453 int signature_index,
454 TRAPS) const;
455
456 void verify_legal_utf8(const unsigned char* buffer, int length, TRAPS) const;
457 void verify_legal_class_name(const Symbol* name, TRAPS) const;
458 void verify_legal_field_name(const Symbol* name, TRAPS) const;
459 void verify_legal_method_name(const Symbol* name, TRAPS) const;
460
461 void verify_legal_field_signature(const Symbol* fieldname,
462 const Symbol* signature,
463 TRAPS) const;
464 int verify_legal_method_signature(const Symbol* methodname,
465 const Symbol* signature,
466 TRAPS) const;
467 void verify_legal_name_with_signature(const Symbol* name,
468 const Symbol* signature,
469 TRAPS) const;
470
471 void verify_class_version(u2 major, u2 minor, Symbol* class_name, TRAPS);
472
473 void verify_legal_class_modifiers(jint flags, TRAPS) const;
474 void verify_legal_field_modifiers(jint flags, bool is_interface, TRAPS) const;
475 void verify_legal_method_modifiers(jint flags,
476 bool is_interface,
477 const Symbol* name,
478 TRAPS) const;
479
480 void check_super_class_access(const InstanceKlass* this_klass,
481 TRAPS);
482
483 void check_super_interface_access(const InstanceKlass* this_klass,
484 TRAPS);
485
486 const char* skip_over_field_signature(const char* signature,
487 bool void_ok,
488 unsigned int length,
489 TRAPS) const;
490
491 // Wrapper for constantTag.is_klass_[or_]reference.
492 // In older versions of the VM, Klass*s cannot sneak into early phases of
493 // constant pool construction, but in later versions they can.
494 // %%% Let's phase out the old is_klass_reference.
495 bool valid_klass_reference_at(int index) const {
496 return _cp->is_within_bounds(index) &&
497 _cp->tag_at(index).is_klass_or_reference();
498 }
499
500 // Checks that the cpool index is in range and is a utf8
501 bool valid_symbol_at(int cpool_index) const {
502 return _cp->is_within_bounds(cpool_index) &&
503 _cp->tag_at(cpool_index).is_utf8();
504 }
505
506 void copy_localvariable_table(const ConstMethod* cm,
507 int lvt_cnt,
508 u2* const localvariable_table_length,
509 const unsafe_u2** const localvariable_table_start,
510 int lvtt_cnt,
511 u2* const localvariable_type_table_length,
512 const unsafe_u2** const localvariable_type_table_start,
513 TRAPS);
514
515 void copy_method_annotations(ConstMethod* cm,
516 const u1* runtime_visible_annotations,
517 int runtime_visible_annotations_length,
518 const u1* runtime_invisible_annotations,
519 int runtime_invisible_annotations_length,
520 const u1* runtime_visible_parameter_annotations,
521 int runtime_visible_parameter_annotations_length,
522 const u1* runtime_invisible_parameter_annotations,
523 int runtime_invisible_parameter_annotations_length,
524 const u1* runtime_visible_type_annotations,
525 int runtime_visible_type_annotations_length,
526 const u1* runtime_invisible_type_annotations,
527 int runtime_invisible_type_annotations_length,
528 const u1* annotation_default,
529 int annotation_default_length,
530 TRAPS);
531
532 void update_class_name(Symbol* new_name);
533
534 public:
535 ClassFileParser(ClassFileStream* stream,
536 Symbol* name,
537 ClassLoaderData* loader_data,
538 const ClassLoadInfo* cl_info,
539 Publicity pub_level,
540 TRAPS);
541
542 ~ClassFileParser();
543
544 InstanceKlass* create_instance_klass(bool cf_changed_in_CFLH, const ClassInstanceInfo& cl_inst_info, TRAPS);
545
546 const ClassFileStream* clone_stream() const;
547
548 void set_klass_to_deallocate(InstanceKlass* klass);
549
550 int static_field_size() const;
551 int total_oop_map_count() const;
552 jint layout_size() const;
553
554 int vtable_size() const { return _vtable_size; }
555 int itable_size() const { return _itable_size; }
556
557 u2 this_class_index() const { return _this_class_index; }
558
559 bool is_hidden() const { return _is_hidden; }
560 bool is_interface() const { return _access_flags.is_interface(); }
561
562 ClassLoaderData* loader_data() const { return _loader_data; }
563 const Symbol* class_name() const { return _class_name; }
564 const InstanceKlass* super_klass() const { return _super_klass; }
565
566 ReferenceType super_reference_type() const;
567 bool is_instance_ref_klass() const;
568 bool is_java_lang_ref_Reference_subclass() const;
569
570 AccessFlags access_flags() const { return _access_flags; }
571
572 bool is_internal() const { return INTERNAL == _pub_level; }
573
574 static bool verify_unqualified_name(const char* name, unsigned int length, int type);
575
576 #ifdef ASSERT
577 static bool is_internal_format(Symbol* class_name);
578 #endif
579
580 };
581
582 #endif // SHARE_CLASSFILE_CLASSFILEPARSER_HPP