1 /*
  2  * Copyright (c) 1997, 2022, 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/instanceKlass.hpp"
 32 #include "oops/typeArrayOop.hpp"
 33 #include "utilities/accessFlags.hpp"
 34 
 35 class Annotations;
 36 template <typename T>
 37 class Array;
 38 class ClassFileStream;
 39 class ClassLoaderData;
 40 class ClassLoadInfo;
 41 class ClassInstanceInfo;
 42 class CompressedLineNumberWriteStream;
 43 class ConstMethod;
 44 class FieldInfo;
 45 template <typename T>
 46 class GrowableArray;
 47 class InstanceKlass;
 48 class RecordComponent;
 49 class Symbol;
 50 class FieldLayoutBuilder;
 51 
 52 // Utility to collect and compact oop maps during layout
 53 class OopMapBlocksBuilder : public ResourceObj {
 54  public:
 55   OopMapBlock* _nonstatic_oop_maps;
 56   unsigned int _nonstatic_oop_map_count;
 57   unsigned int _max_nonstatic_oop_maps;
 58 
 59   OopMapBlocksBuilder(unsigned int  max_blocks);
 60   OopMapBlock* last_oop_map() const;
 61   void initialize_inherited_blocks(OopMapBlock* blocks, unsigned int nof_blocks);
 62   void add(int offset, int count);
 63   void copy(OopMapBlock* dst);
 64   void compact();
 65   void print_on(outputStream* st) const;
 66   void print_value_on(outputStream* st) const;
 67 };
 68 
 69 // Values needed for oopmap and InstanceKlass creation
 70 class FieldLayoutInfo : public ResourceObj {
 71  public:
 72   OopMapBlocksBuilder* oop_map_blocks;
 73   int _instance_size;
 74   int _nonstatic_field_size;
 75   int _static_field_size;
 76   bool  _has_nonstatic_fields;
 77   bool  _is_naturally_atomic;
 78   bool _has_inline_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 FieldAllocationCount;
 91   class FieldAnnotationCollector;
 92 
 93  public:
 94   // The ClassFileParser has an associated "publicity" level
 95   // It is used to control which subsystems (if any)
 96   // will observe the parsing (logging, events, tracing).
 97   // Default level is "BROADCAST", which is equivalent to
 98   // a "public" parsing attempt.
 99   //
100   // "INTERNAL" level should be entirely private to the
101   // caller - this allows for internal reuse of ClassFileParser
102   //
103   enum Publicity {
104     INTERNAL,
105     BROADCAST
106   };
107 
108   enum { LegalClass, LegalField, LegalMethod }; // used to verify unqualified names
109 
110  private:
111   // Potentially unaligned pointer to various 16-bit entries in the class file
112   typedef void unsafe_u2;
113 
114   const ClassFileStream* _stream; // Actual input stream
115   Symbol* _class_name;
116   mutable ClassLoaderData* _loader_data;
117   const bool _is_hidden;
118   const bool _can_access_vm_annotations;
119   int _orig_cp_size;
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<u2>* _fields;
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<u2>* _preload_classes;
133   Array<RecordComponent*>* _record_components;
134   Array<InstanceKlass*>* _local_interfaces;
135   GrowableArray<u2>* _local_interface_indexes;
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   FieldAllocationCount* _fac;
147   FieldLayoutInfo* _field_info;
148   Array<InlineKlass*>* _inline_type_field_klasses;
149   const intArray* _method_ordering;
150   GrowableArray<Method*>* _all_mirandas;
151 
152   enum { fixed_buffer_size = 128 };
153   u_char _linenumbertable_buffer[fixed_buffer_size];
154 
155   // Size of Java vtable (in words)
156   int _vtable_size;
157   int _itable_size;
158 
159   int _num_miranda_methods;
160 
161   int _alignment;
162   int _first_field_offset;
163   int _exact_size_in_bytes;
164 
165   Handle _protection_domain;
166   AccessFlags _access_flags;
167 
168   // for tracing and notifications
169   Publicity _pub_level;
170 
171   // Used to keep track of whether a constant pool item 19 or 20 is found.  These
172   // correspond to CONSTANT_Module and CONSTANT_Package tags and are not allowed
173   // in regular class files.  For class file version >= 53, a CFE cannot be thrown
174   // immediately when these are seen because a NCDFE must be thrown if the class's
175   // access_flags have ACC_MODULE set.  But, the access_flags haven't been looked
176   // at yet.  So, the bad constant pool item is cached here.  A value of zero
177   // means that no constant pool item 19 or 20 was found.
178   short _bad_constant_seen;
179 
180   // class attributes parsed before the instance klass is created:
181   bool _synthetic_flag;
182   int _sde_length;
183   const char* _sde_buffer;
184   u2 _sourcefile_index;
185   u2 _generic_signature_index;
186 
187   u2 _major_version;
188   u2 _minor_version;
189   u2 _this_class_index;
190   u2 _super_class_index;
191   u2 _itfs_len;
192   u2 _java_fields_count;
193 
194   bool _need_verify;
195   bool _relax_verify;
196 
197   bool _has_nonstatic_concrete_methods;
198   bool _declares_nonstatic_concrete_methods;
199   bool _has_final_method;
200   bool _has_contended_fields;
201 
202   bool _has_inline_type_fields;
203   bool _has_nonstatic_fields;
204   bool _is_empty_inline_type;
205   bool _is_naturally_atomic;
206   bool _is_declared_atomic;
207   bool _carries_value_modifier;      // Has ACC_VALUE mddifier or one of its super types has
208   bool _carries_identity_modifier;   // Has ACC_IDENTITY modifier or one of its super types has
209 
210   // precomputed flags
211   bool _has_finalizer;
212   bool _has_empty_finalizer;
213   bool _has_vanilla_constructor;
214   int _max_bootstrap_specifier_index;  // detects BSS values
215 
216   void parse_stream(const ClassFileStream* const stream, TRAPS);
217 
218   void mangle_hidden_class_name(InstanceKlass* const ik);
219 
220   void post_process_parsed_stream(const ClassFileStream* const stream,
221                                   ConstantPool* cp,
222                                   TRAPS);
223 
224   void fill_instance_klass(InstanceKlass* ik, bool cf_changed_in_CFLH,
225                            const ClassInstanceInfo& cl_inst_info, TRAPS);
226 
227   void set_klass(InstanceKlass* instance);
228 
229   void set_class_bad_constant_seen(short bad_constant);
230   short class_bad_constant_seen() { return  _bad_constant_seen; }
231   void set_class_synthetic_flag(bool x)        { _synthetic_flag = x; }
232   void set_class_sourcefile_index(u2 x)        { _sourcefile_index = x; }
233   void set_class_generic_signature_index(u2 x) { _generic_signature_index = x; }
234   void set_class_sde_buffer(const char* x, int len)  { _sde_buffer = x; _sde_length = len; }
235 
236   void create_combined_annotations(TRAPS);
237   void apply_parsed_class_attributes(InstanceKlass* k);  // update k
238   void apply_parsed_class_metadata(InstanceKlass* k, int fields_count);
239   void clear_class_metadata();
240 
241   // Constant pool parsing
242   void parse_constant_pool_entries(const ClassFileStream* const stream,
243                                    ConstantPool* cp,
244                                    const int length,
245                                    TRAPS);
246 
247   void parse_constant_pool(const ClassFileStream* const cfs,
248                            ConstantPool* const cp,
249                            const int length,
250                            TRAPS);
251 
252   // Interface parsing
253   void parse_interfaces(const ClassFileStream* const stream,
254                         const int itfs_len,
255                         ConstantPool* const cp,
256                         bool* has_nonstatic_concrete_methods,
257                         bool* is_declared_atomic,
258                         TRAPS);
259 
260   const InstanceKlass* parse_super_class(ConstantPool* const cp,
261                                          const int super_class_index,
262                                          const bool need_verify,
263                                          TRAPS);
264 
265   // Field parsing
266   void parse_field_attributes(const ClassFileStream* const cfs,
267                               u2 attributes_count,
268                               bool is_static,
269                               u2 signature_index,
270                               u2* const constantvalue_index_addr,
271                               bool* const is_synthetic_addr,
272                               u2* const generic_signature_index_addr,
273                               FieldAnnotationCollector* parsed_annotations,
274                               TRAPS);
275 
276   void parse_fields(const ClassFileStream* const cfs,
277                     AccessFlags class_access_flags,
278                     FieldAllocationCount* const fac,
279                     ConstantPool* cp,
280                     const int cp_size,
281                     u2* const java_fields_count_ptr,
282                     TRAPS);
283 
284   // Method parsing
285   Method* parse_method(const ClassFileStream* const cfs,
286                        bool is_interface,
287                        bool is_value_class,
288                        bool is_abstract_class,
289                        const ConstantPool* cp,
290                        AccessFlags* const promoted_flags,
291                        TRAPS);
292 
293   void parse_methods(const ClassFileStream* const cfs,
294                      bool is_interface,
295                      bool is_value_class,
296                      bool is_abstract_class,
297                      AccessFlags* const promoted_flags,
298                      bool* const has_final_method,
299                      bool* const declares_nonstatic_concrete_methods,
300                      TRAPS);
301 
302   const unsafe_u2* parse_exception_table(const ClassFileStream* const stream,
303                                          u4 code_length,
304                                          u4 exception_table_length,
305                                          TRAPS);
306 
307   void parse_linenumber_table(u4 code_attribute_length,
308                               u4 code_length,
309                               CompressedLineNumberWriteStream**const write_stream,
310                               TRAPS);
311 
312   const unsafe_u2* parse_localvariable_table(const ClassFileStream* const cfs,
313                                              u4 code_length,
314                                              u2 max_locals,
315                                              u4 code_attribute_length,
316                                              u2* const localvariable_table_length,
317                                              bool isLVTT,
318                                              TRAPS);
319 
320   const unsafe_u2* parse_checked_exceptions(const ClassFileStream* const cfs,
321                                             u2* const checked_exceptions_length,
322                                             u4 method_attribute_length,
323                                             TRAPS);
324 
325   // Classfile attribute parsing
326   u2 parse_generic_signature_attribute(const ClassFileStream* const cfs, TRAPS);
327   void parse_classfile_sourcefile_attribute(const ClassFileStream* const cfs, TRAPS);
328   void parse_classfile_source_debug_extension_attribute(const ClassFileStream* const cfs,
329                                                         int length,
330                                                         TRAPS);
331 
332   // Check for circularity in InnerClasses attribute.
333   bool check_inner_classes_circularity(const ConstantPool* cp, int length, TRAPS);
334 
335   u2   parse_classfile_inner_classes_attribute(const ClassFileStream* const cfs,
336                                                const ConstantPool* cp,
337                                                const u1* const inner_classes_attribute_start,
338                                                bool parsed_enclosingmethod_attribute,
339                                                u2 enclosing_method_class_index,
340                                                u2 enclosing_method_method_index,
341                                                TRAPS);
342 
343   u2 parse_classfile_nest_members_attribute(const ClassFileStream* const cfs,
344                                             const u1* const nest_members_attribute_start,
345                                             TRAPS);
346 
347   u2 parse_classfile_permitted_subclasses_attribute(const ClassFileStream* const cfs,
348                                                     const u1* const permitted_subclasses_attribute_start,
349                                                     TRAPS);
350 
351   u2 parse_classfile_preload_attribute(const ClassFileStream* const cfs,
352                                                     const u1* const preload_attribute_start,
353                                                     TRAPS);
354 
355   u2 parse_classfile_record_attribute(const ClassFileStream* const cfs,
356                                       const ConstantPool* cp,
357                                       const u1* const record_attribute_start,
358                                       TRAPS);
359 
360   void parse_classfile_attributes(const ClassFileStream* const cfs,
361                                   ConstantPool* cp,
362                                   ClassAnnotationCollector* parsed_annotations,
363                                   TRAPS);
364 
365   void parse_classfile_synthetic_attribute();
366   void parse_classfile_signature_attribute(const ClassFileStream* const cfs, TRAPS);
367   void parse_classfile_bootstrap_methods_attribute(const ClassFileStream* const cfs,
368                                                    ConstantPool* cp,
369                                                    u4 attribute_length,
370                                                    TRAPS);
371 
372   // Annotations handling
373   AnnotationArray* assemble_annotations(const u1* const runtime_visible_annotations,
374                                         int runtime_visible_annotations_length,
375                                         const u1* const runtime_invisible_annotations,
376                                         int runtime_invisible_annotations_length,
377                                         TRAPS);
378 
379   void set_precomputed_flags(InstanceKlass* k);
380 
381   // Format checker methods
382   void classfile_parse_error(const char* msg, TRAPS) const;
383   void classfile_parse_error(const char* msg, int index, TRAPS) const;
384   void classfile_parse_error(const char* msg, const char *name, TRAPS) const;
385   void classfile_parse_error(const char* msg,
386                              int index,
387                              const char *name,
388                              TRAPS) const;
389   void classfile_parse_error(const char* msg,
390                              const char* name,
391                              const char* signature,
392                              TRAPS) const;
393 
394   void classfile_icce_error(const char* msg,
395                             const Klass* k,
396                             TRAPS) const;
397 
398   void classfile_ucve_error(const char* msg,
399                             const Symbol* class_name,
400                             u2 major,
401                             u2 minor,
402                             TRAPS) const;
403 
404   inline void guarantee_property(bool b, const char* msg, TRAPS) const {
405     if (!b) { classfile_parse_error(msg, THREAD); return; }
406   }
407 
408   void report_assert_property_failure(const char* msg, TRAPS) const PRODUCT_RETURN;
409   void report_assert_property_failure(const char* msg, int index, TRAPS) const PRODUCT_RETURN;
410 
411   inline void assert_property(bool b, const char* msg, TRAPS) const {
412 #ifdef ASSERT
413     if (!b) {
414       report_assert_property_failure(msg, THREAD);
415     }
416 #endif
417   }
418 
419   inline void assert_property(bool b, const char* msg, int index, TRAPS) const {
420 #ifdef ASSERT
421     if (!b) {
422       report_assert_property_failure(msg, index, THREAD);
423     }
424 #endif
425   }
426 
427   inline void check_property(bool property,
428                              const char* msg,
429                              int index,
430                              TRAPS) const {
431     if (_need_verify) {
432       guarantee_property(property, msg, index, CHECK);
433     } else {
434       assert_property(property, msg, index, CHECK);
435     }
436   }
437 
438   inline void check_property(bool property, const char* msg, TRAPS) const {
439     if (_need_verify) {
440       guarantee_property(property, msg, CHECK);
441     } else {
442       assert_property(property, msg, CHECK);
443     }
444   }
445 
446   inline void guarantee_property(bool b,
447                                  const char* msg,
448                                  int index,
449                                  TRAPS) const {
450     if (!b) { classfile_parse_error(msg, index, THREAD); return; }
451   }
452 
453   inline void guarantee_property(bool b,
454                                  const char* msg,
455                                  const char *name,
456                                  TRAPS) const {
457     if (!b) { classfile_parse_error(msg, name, THREAD); return; }
458   }
459 
460   inline void guarantee_property(bool b,
461                                  const char* msg,
462                                  int index,
463                                  const char *name,
464                                  TRAPS) const {
465     if (!b) { classfile_parse_error(msg, index, name, THREAD); return; }
466   }
467 
468   void throwIllegalSignature(const char* type,
469                              const Symbol* name,
470                              const Symbol* sig,
471                              TRAPS) const;
472 
473   void throwInlineTypeLimitation(THREAD_AND_LOCATION_DECL,
474                                  const char* msg,
475                                  const Symbol* name = NULL,
476                                  const Symbol* sig  = NULL) const;
477 
478   void verify_constantvalue(const ConstantPool* const cp,
479                             int constantvalue_index,
480                             int signature_index,
481                             TRAPS) const;
482 
483   void verify_legal_utf8(const unsigned char* buffer, int length, TRAPS) const;
484   void verify_legal_class_name(const Symbol* name, TRAPS) const;
485   void verify_legal_field_name(const Symbol* name, TRAPS) const;
486   void verify_legal_method_name(const Symbol* name, TRAPS) const;
487 
488   void verify_legal_field_signature(const Symbol* fieldname,
489                                     const Symbol* signature,
490                                     TRAPS) const;
491   int  verify_legal_method_signature(const Symbol* methodname,
492                                      const Symbol* signature,
493                                      TRAPS) const;
494   void verify_legal_name_with_signature(const Symbol* name,
495                                         const Symbol* signature,
496                                         TRAPS) const;
497 
498   void verify_class_version(u2 major, u2 minor, Symbol* class_name, TRAPS);
499 
500   void verify_legal_class_modifiers(jint flags, const char* name, bool is_Object, TRAPS) const;
501   void verify_legal_field_modifiers(jint flags,
502                                     AccessFlags class_access_flags,
503                                     TRAPS) const;
504   void verify_legal_method_modifiers(jint flags,
505                                      AccessFlags class_access_flags,
506                                      const Symbol* name,
507                                      TRAPS) const;
508 
509   void check_super_class_access(const InstanceKlass* this_klass,
510                                 TRAPS);
511 
512   void check_super_interface_access(const InstanceKlass* this_klass,
513                                     TRAPS);
514 
515   const char* skip_over_field_signature(const char* signature,
516                                         bool void_ok,
517                                         unsigned int length,
518                                         TRAPS) const;
519 
520   // Wrapper for constantTag.is_klass_[or_]reference.
521   // In older versions of the VM, Klass*s cannot sneak into early phases of
522   // constant pool construction, but in later versions they can.
523   // %%% Let's phase out the old is_klass_reference.
524   bool valid_klass_reference_at(int index) const {
525     return _cp->is_within_bounds(index) &&
526              _cp->tag_at(index).is_klass_or_reference();
527   }
528 
529   // Checks that the cpool index is in range and is a utf8
530   bool valid_symbol_at(int cpool_index) const {
531     return _cp->is_within_bounds(cpool_index) &&
532              _cp->tag_at(cpool_index).is_utf8();
533   }
534 
535   void copy_localvariable_table(const ConstMethod* cm,
536                                 int lvt_cnt,
537                                 u2* const localvariable_table_length,
538                                 const unsafe_u2** const localvariable_table_start,
539                                 int lvtt_cnt,
540                                 u2* const localvariable_type_table_length,
541                                 const unsafe_u2** const localvariable_type_table_start,
542                                 TRAPS);
543 
544   void copy_method_annotations(ConstMethod* cm,
545                                const u1* runtime_visible_annotations,
546                                int runtime_visible_annotations_length,
547                                const u1* runtime_invisible_annotations,
548                                int runtime_invisible_annotations_length,
549                                const u1* runtime_visible_parameter_annotations,
550                                int runtime_visible_parameter_annotations_length,
551                                const u1* runtime_invisible_parameter_annotations,
552                                int runtime_invisible_parameter_annotations_length,
553                                const u1* runtime_visible_type_annotations,
554                                int runtime_visible_type_annotations_length,
555                                const u1* runtime_invisible_type_annotations,
556                                int runtime_invisible_type_annotations_length,
557                                const u1* annotation_default,
558                                int annotation_default_length,
559                                TRAPS);
560 
561   void update_class_name(Symbol* new_name);
562 
563   // Check if the class file supports inline types
564   bool supports_inline_types() const;
565 
566  public:
567   ClassFileParser(ClassFileStream* stream,
568                   Symbol* name,
569                   ClassLoaderData* loader_data,
570                   const ClassLoadInfo* cl_info,
571                   Publicity pub_level,
572                   TRAPS);
573 
574   ~ClassFileParser();
575 
576   InstanceKlass* create_instance_klass(bool cf_changed_in_CFLH, const ClassInstanceInfo& cl_inst_info, TRAPS);
577 
578   const ClassFileStream* clone_stream() const;
579 
580   void set_klass_to_deallocate(InstanceKlass* klass);
581 
582   int static_field_size() const;
583   int total_oop_map_count() const;
584   jint layout_size() const;
585 
586   int vtable_size() const { return _vtable_size; }
587   int itable_size() const { return _itable_size; }
588 
589   u2 this_class_index() const { return _this_class_index; }
590 
591   bool is_hidden() const { return _is_hidden; }
592   bool is_interface() const { return _access_flags.is_interface(); }
593   bool is_inline_type() const { return _access_flags.is_value_class() && !_access_flags.is_interface() && !_access_flags.is_abstract(); }
594   bool is_value_class() const { return _access_flags.is_value_class(); }
595   bool is_abstract_class() const { return _access_flags.is_abstract(); }
596   bool is_identity_class() const { return _access_flags.is_identity_class(); }
597   bool is_value_capable_class() const;
598   bool has_inline_fields() const { return _has_inline_type_fields; }
599   bool carries_identity_modifier() const { return _carries_identity_modifier; }
600   void set_carries_identity_modifier() { _carries_identity_modifier = true; }
601   bool carries_value_modifier() const { return _carries_value_modifier; }
602   void set_carries_value_modifier() { _carries_value_modifier = true; }
603 
604   u2 java_fields_count() const { return _java_fields_count; }
605 
606   ClassLoaderData* loader_data() const { return _loader_data; }
607   const Symbol* class_name() const { return _class_name; }
608   const InstanceKlass* super_klass() const { return _super_klass; }
609 
610   ReferenceType super_reference_type() const;
611   bool is_instance_ref_klass() const;
612   bool is_java_lang_ref_Reference_subclass() const;
613 
614   AccessFlags access_flags() const { return _access_flags; }
615 
616   bool is_internal() const { return INTERNAL == _pub_level; }
617 
618   static bool verify_unqualified_name(const char* name, unsigned int length, int type);
619 
620 #ifdef ASSERT
621   static bool is_internal_format(Symbol* class_name);
622 #endif
623 
624 };
625 
626 #endif // SHARE_CLASSFILE_CLASSFILEPARSER_HPP