1 /*
   2  * Copyright (c) 1997, 2015, 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_VM_CLASSFILE_CLASSFILEPARSER_HPP
  26 #define SHARE_VM_CLASSFILE_CLASSFILEPARSER_HPP
  27 
  28 #include "classfile/classFileStream.hpp"
  29 #include "classfile/symbolTable.hpp"
  30 #include "oops/annotations.hpp"
  31 #include "oops/constantPool.hpp"
  32 #include "oops/typeArrayOop.hpp"
  33 #include "utilities/accessFlags.hpp"
  34 
  35 class CompressedLineNumberWriteStream;
  36 class FieldAllocationCount;
  37 class FieldInfo;
  38 class FieldLayoutInfo;
  39 
  40 
  41 // Parser for for .class files
  42 //
  43 // The bytes describing the class file structure is read from a Stream object
  44 
  45 class ClassFileParser VALUE_OBJ_CLASS_SPEC {
  46  private:
  47   bool _need_verify;
  48   bool _relax_verify;
  49   u2   _major_version;
  50   u2   _minor_version;
  51   Symbol* _class_name;
  52   ClassLoaderData* _loader_data;
  53   KlassHandle _host_klass;
  54   GrowableArray<Handle>* _cp_patches; // overrides for CP entries
  55 
  56   // precomputed flags
  57   bool _has_finalizer;
  58   bool _has_empty_finalizer;
  59   bool _has_vanilla_constructor;
  60   int _max_bootstrap_specifier_index;  // detects BSS values
  61 
  62   // class attributes parsed before the instance klass is created:
  63   bool       _synthetic_flag;
  64   int        _sde_length;
  65   char*      _sde_buffer;
  66   u2         _sourcefile_index;
  67   u2         _generic_signature_index;
  68 
  69   // Metadata created before the instance klass is created.  Must be deallocated
  70   // if not transferred to the InstanceKlass upon successful class loading
  71   // in which case these pointers have been set to NULL.
  72   instanceKlassHandle _super_klass;
  73   ConstantPool*    _cp;
  74   Array<u2>*       _fields;
  75   Array<Method*>*  _methods;
  76   Array<u2>*       _inner_classes;
  77   Array<Klass*>*   _local_interfaces;
  78   Array<Klass*>*   _transitive_interfaces;
  79   Annotations*     _combined_annotations;
  80   AnnotationArray* _annotations;
  81   AnnotationArray* _type_annotations;
  82   Array<AnnotationArray*>* _fields_annotations;
  83   Array<AnnotationArray*>* _fields_type_annotations;
  84   InstanceKlass*   _klass;  // InstanceKlass once created.
  85 
  86   void set_class_synthetic_flag(bool x)        { _synthetic_flag = x; }
  87   void set_class_sourcefile_index(u2 x)        { _sourcefile_index = x; }
  88   void set_class_generic_signature_index(u2 x) { _generic_signature_index = x; }
  89   void set_class_sde_buffer(char* x, int len)  { _sde_buffer = x; _sde_length = len; }
  90 
  91   void create_combined_annotations(TRAPS);
  92 
  93   void init_parsed_class_attributes(ClassLoaderData* loader_data) {
  94     _loader_data = loader_data;
  95     _synthetic_flag = false;
  96     _sourcefile_index = 0;
  97     _generic_signature_index = 0;
  98     _sde_buffer = NULL;
  99     _sde_length = 0;
 100     // initialize the other flags too:
 101     _has_finalizer = _has_empty_finalizer = _has_vanilla_constructor = false;
 102     _max_bootstrap_specifier_index = -1;
 103     clear_class_metadata();
 104     _klass = NULL;
 105   }
 106   void apply_parsed_class_attributes(instanceKlassHandle k);  // update k
 107   void apply_parsed_class_metadata(instanceKlassHandle k, int fields_count, TRAPS);
 108   void clear_class_metadata() {
 109     // metadata created before the instance klass is created.  Must be
 110     // deallocated if classfile parsing returns an error.
 111     _cp = NULL;
 112     _fields = NULL;
 113     _methods = NULL;
 114     _inner_classes = NULL;
 115     _local_interfaces = NULL;
 116     _transitive_interfaces = NULL;
 117     _combined_annotations = NULL;
 118     _annotations = _type_annotations = NULL;
 119     _fields_annotations = _fields_type_annotations = NULL;
 120   }
 121 
 122   class AnnotationCollector {
 123   public:
 124     enum Location { _in_field, _in_method, _in_class };
 125     enum ID {
 126       _unknown = 0,
 127       _method_CallerSensitive,
 128       _method_ForceInline,
 129       _method_DontInline,
 130       _method_InjectedProfile,
 131       _method_LambdaForm_Compiled,
 132       _method_LambdaForm_Hidden,
 133       _method_HotSpotIntrinsicCandidate,
 134       _method_Accessor_Method,
 135       _sun_misc_Contended,
 136       _field_Stable,
 137       _annotation_LIMIT
 138     };
 139     const Location _location;
 140           int      _annotations_present;
 141           u2       _contended_group;
 142           u2       _accessor_field_name;
 143 
 144     AnnotationCollector(Location location)
 145     : _location(location), _annotations_present(0)
 146     {
 147       assert((int)_annotation_LIMIT <= (int)sizeof(_annotations_present) * BitsPerByte, "");
 148     }
 149     // If this annotation name has an ID, report it (or _none).
 150     ID annotation_index(ClassLoaderData* loader_data, Symbol* name);
 151     // Set the annotation name:
 152     void set_annotation(ID id) {
 153       assert((int)id >= 0 && (int)id < (int)_annotation_LIMIT, "oob");
 154       _annotations_present |= nth_bit((int)id);
 155     }
 156 
 157     void remove_annotation(ID id) {
 158       assert((int)id >= 0 && (int)id < (int)_annotation_LIMIT, "oob");
 159       _annotations_present &= ~nth_bit((int)id);
 160     }
 161 
 162     // Report if the annotation is present.
 163     bool has_any_annotations() const { return _annotations_present != 0; }
 164     bool has_annotation(ID id) const { return (nth_bit((int)id) & _annotations_present) != 0; }
 165 
 166     void set_contended_group(u2 group) { _contended_group = group; }
 167     u2 contended_group() const { return _contended_group; }
 168 
 169     bool is_contended() const { return has_annotation(_sun_misc_Contended); }
 170 
 171     void set_stable(bool stable) { set_annotation(_field_Stable); }
 172     bool is_stable() const { return has_annotation(_field_Stable); }
 173     
 174     void set_accessor_field_name(u2 fname) { _accessor_field_name = fname; }
 175     u2 accessor_field_name() { return _accessor_field_name; }
 176     
 177     bool is_accessor() const { return has_annotation(_method_Accessor_Method); }
 178     
 179   };
 180 
 181   // This class also doubles as a holder for metadata cleanup.
 182   class FieldAnnotationCollector: public AnnotationCollector {
 183     ClassLoaderData* _loader_data;
 184     AnnotationArray* _field_annotations;
 185     AnnotationArray* _field_type_annotations;
 186   public:
 187     FieldAnnotationCollector(ClassLoaderData* loader_data) :
 188                                  AnnotationCollector(_in_field),
 189                                  _loader_data(loader_data),
 190                                  _field_annotations(NULL),
 191                                  _field_type_annotations(NULL) {}
 192     void apply_to(FieldInfo* f);
 193     ~FieldAnnotationCollector();
 194     AnnotationArray* field_annotations()      { return _field_annotations; }
 195     AnnotationArray* field_type_annotations() { return _field_type_annotations; }
 196 
 197     void set_field_annotations(AnnotationArray* a)      { _field_annotations = a; }
 198     void set_field_type_annotations(AnnotationArray* a) { _field_type_annotations = a; }
 199   };
 200 
 201   class MethodAnnotationCollector: public AnnotationCollector {
 202   public:
 203     MethodAnnotationCollector() : AnnotationCollector(_in_method) { }
 204     void apply_to(methodHandle m);
 205   };
 206   class ClassAnnotationCollector: public AnnotationCollector {
 207   public:
 208     ClassAnnotationCollector() : AnnotationCollector(_in_class) { }
 209     void apply_to(instanceKlassHandle k);
 210   };
 211 
 212   enum { fixed_buffer_size = 128 };
 213   u_char linenumbertable_buffer[fixed_buffer_size];
 214 
 215   ClassFileStream* _stream;              // Actual input stream
 216 
 217   enum { LegalClass, LegalField, LegalMethod }; // used to verify unqualified names
 218 
 219   // Accessors
 220   ClassFileStream* stream()                        { return _stream; }
 221   void set_stream(ClassFileStream* st)             { _stream = st; }
 222 
 223   // Constant pool parsing
 224   void parse_constant_pool_entries(int length, TRAPS);
 225 
 226   constantPoolHandle parse_constant_pool(TRAPS);
 227 
 228   // Interface parsing
 229   Array<Klass*>* parse_interfaces(int length,
 230                                   Handle protection_domain,
 231                                   Symbol* class_name,
 232                                   bool* has_default_methods,
 233                                   TRAPS);
 234   void record_defined_class_dependencies(instanceKlassHandle defined_klass, TRAPS);
 235 
 236   instanceKlassHandle parse_super_class(int super_class_index, TRAPS);
 237   // Field parsing
 238   void parse_field_attributes(u2 attributes_count,
 239                               bool is_static, u2 signature_index,
 240                               u2* constantvalue_index_addr,
 241                               bool* is_synthetic_addr,
 242                               u2* generic_signature_index_addr,
 243                               FieldAnnotationCollector* parsed_annotations,
 244                               TRAPS);
 245   Array<u2>* parse_fields(Symbol* class_name,
 246                           bool is_interface,
 247                           FieldAllocationCount *fac,
 248                           u2* java_fields_count_ptr, TRAPS);
 249 
 250   void print_field_layout(Symbol* name,
 251                           Array<u2>* fields,
 252                           const constantPoolHandle& cp,
 253                           int instance_size,
 254                           int instance_fields_start,
 255                           int instance_fields_end,
 256                           int static_fields_end);
 257 
 258   // Method parsing
 259   methodHandle parse_method(bool is_interface,
 260                             AccessFlags* promoted_flags,
 261                             TRAPS);
 262   Array<Method*>* parse_methods(bool is_interface,
 263                                 AccessFlags* promoted_flags,
 264                                 bool* has_final_method,
 265                                 bool* declares_default_methods,
 266                                 TRAPS);
 267   intArray* sort_methods(Array<Method*>* methods);
 268 
 269   u2* parse_exception_table(u4 code_length, u4 exception_table_length,
 270                             TRAPS);
 271   void parse_linenumber_table(
 272       u4 code_attribute_length, u4 code_length,
 273       CompressedLineNumberWriteStream** write_stream, TRAPS);
 274   u2* parse_localvariable_table(u4 code_length, u2 max_locals, u4 code_attribute_length,
 275                                 u2* localvariable_table_length,
 276                                 bool isLVTT, TRAPS);
 277   u2* parse_checked_exceptions(u2* checked_exceptions_length, u4 method_attribute_length,
 278                                TRAPS);
 279   void parse_type_array(u2 array_length, u4 code_length, u4* u1_index, u4* u2_index,
 280                         u1* u1_array, u2* u2_array, TRAPS);
 281   u1* parse_stackmap_table(u4 code_attribute_length, TRAPS);
 282 
 283   // Classfile attribute parsing
 284   u2 parse_generic_signature_attribute(TRAPS);
 285   void parse_classfile_sourcefile_attribute(TRAPS);
 286   void parse_classfile_source_debug_extension_attribute(int length, TRAPS);
 287   u2   parse_classfile_inner_classes_attribute(u1* inner_classes_attribute_start,
 288                                                bool parsed_enclosingmethod_attribute,
 289                                                u2 enclosing_method_class_index,
 290                                                u2 enclosing_method_method_index,
 291                                                TRAPS);
 292   void parse_classfile_attributes(ClassAnnotationCollector* parsed_annotations,
 293                                   TRAPS);
 294   void parse_classfile_synthetic_attribute(TRAPS);
 295   void parse_classfile_signature_attribute(TRAPS);
 296   void parse_classfile_bootstrap_methods_attribute(u4 attribute_length, TRAPS);
 297 
 298   // Annotations handling
 299   AnnotationArray* assemble_annotations(u1* runtime_visible_annotations,
 300                                         int runtime_visible_annotations_length,
 301                                         u1* runtime_invisible_annotations,
 302                                         int runtime_invisible_annotations_length, TRAPS);
 303   int skip_annotation(u1* buffer, int limit, int index);
 304   int skip_annotation_value(u1* buffer, int limit, int index);
 305   void parse_annotations(u1* buffer, int limit,
 306                          /* Results (currently, only one result is supported): */
 307                          AnnotationCollector* result);
 308 
 309   // Final setup
 310   unsigned int compute_oop_map_count(instanceKlassHandle super,
 311                                      unsigned int nonstatic_oop_count,
 312                                      int first_nonstatic_oop_offset);
 313   void fill_oop_maps(instanceKlassHandle k,
 314                      unsigned int nonstatic_oop_map_count,
 315                      int* nonstatic_oop_offsets,
 316                      unsigned int* nonstatic_oop_counts);
 317   void set_precomputed_flags(instanceKlassHandle k);
 318   Array<Klass*>* compute_transitive_interfaces(instanceKlassHandle super,
 319                                                Array<Klass*>* local_ifs, TRAPS);
 320 
 321   // Format checker methods
 322   void classfile_parse_error(const char* msg, TRAPS);
 323   void classfile_parse_error(const char* msg, int index, TRAPS);
 324   void classfile_parse_error(const char* msg, const char *name, TRAPS);
 325   void classfile_parse_error(const char* msg, int index, const char *name, TRAPS);
 326   inline void guarantee_property(bool b, const char* msg, TRAPS) {
 327     if (!b) { classfile_parse_error(msg, CHECK); }
 328   }
 329 
 330   void report_assert_property_failure(const char* msg, TRAPS) PRODUCT_RETURN;
 331   void report_assert_property_failure(const char* msg, int index, TRAPS) PRODUCT_RETURN;
 332 
 333   inline void assert_property(bool b, const char* msg, TRAPS) {
 334 #ifdef ASSERT
 335     if (!b) {
 336       report_assert_property_failure(msg, THREAD);
 337     }
 338 #endif
 339   }
 340 
 341   inline void assert_property(bool b, const char* msg, int index, TRAPS) {
 342 #ifdef ASSERT
 343     if (!b) {
 344       report_assert_property_failure(msg, index, THREAD);
 345     }
 346 #endif
 347   }
 348 
 349   inline void check_property(bool property, const char* msg, int index, TRAPS) {
 350     if (_need_verify) {
 351       guarantee_property(property, msg, index, CHECK);
 352     } else {
 353       assert_property(property, msg, index, CHECK);
 354     }
 355   }
 356 
 357   inline void check_property(bool property, const char* msg, TRAPS) {
 358     if (_need_verify) {
 359       guarantee_property(property, msg, CHECK);
 360     } else {
 361       assert_property(property, msg, CHECK);
 362     }
 363   }
 364 
 365   inline void guarantee_property(bool b, const char* msg, int index, TRAPS) {
 366     if (!b) { classfile_parse_error(msg, index, CHECK); }
 367   }
 368   inline void guarantee_property(bool b, const char* msg, const char *name, TRAPS) {
 369     if (!b) { classfile_parse_error(msg, name, CHECK); }
 370   }
 371   inline void guarantee_property(bool b, const char* msg, int index, const char *name, TRAPS) {
 372     if (!b) { classfile_parse_error(msg, index, name, CHECK); }
 373   }
 374 
 375   void throwIllegalSignature(
 376       const char* type, Symbol* name, Symbol* sig, TRAPS);
 377 
 378   bool is_supported_version(u2 major, u2 minor);
 379   bool has_illegal_visibility(jint flags);
 380 
 381   void verify_constantvalue(int constantvalue_index, int signature_index, TRAPS);
 382   void verify_legal_utf8(const unsigned char* buffer, int length, TRAPS);
 383   void verify_legal_class_name(Symbol* name, TRAPS);
 384   void verify_legal_field_name(Symbol* name, TRAPS);
 385   void verify_legal_method_name(Symbol* name, TRAPS);
 386   void verify_legal_field_signature(Symbol* fieldname, Symbol* signature, TRAPS);
 387   int  verify_legal_method_signature(Symbol* methodname, Symbol* signature, TRAPS);
 388   void verify_legal_class_modifiers(jint flags, TRAPS);
 389   void verify_legal_field_modifiers(jint flags, bool is_interface, TRAPS);
 390   void verify_legal_method_modifiers(jint flags, bool is_interface, Symbol* name, TRAPS);
 391   bool verify_unqualified_name(char* name, unsigned int length, int type);
 392   char* skip_over_field_name(char* name, bool slash_ok, unsigned int length);
 393   char* skip_over_field_signature(char* signature, bool void_ok, unsigned int length, TRAPS);
 394 
 395   bool is_anonymous() {
 396     return _host_klass.not_null();
 397   }
 398   bool has_cp_patch_at(int index) {
 399     assert(index >= 0, "oob");
 400     return (_cp_patches != NULL
 401             && index < _cp_patches->length()
 402             && _cp_patches->adr_at(index)->not_null());
 403   }
 404   Handle cp_patch_at(int index) {
 405     assert(has_cp_patch_at(index), "oob");
 406     return _cp_patches->at(index);
 407   }
 408   Handle clear_cp_patch_at(int index) {
 409     Handle patch = cp_patch_at(index);
 410     _cp_patches->at_put(index, Handle());
 411     assert(!has_cp_patch_at(index), "");
 412     return patch;
 413   }
 414   void patch_constant_pool(const constantPoolHandle& cp, int index, Handle patch, TRAPS);
 415 
 416   // Wrapper for constantTag.is_klass_[or_]reference.
 417   // In older versions of the VM, Klass*s cannot sneak into early phases of
 418   // constant pool construction, but in later versions they can.
 419   // %%% Let's phase out the old is_klass_reference.
 420   bool valid_klass_reference_at(int index) {
 421     return _cp->is_within_bounds(index) && _cp->tag_at(index).is_klass_or_reference();
 422   }
 423 
 424   // Checks that the cpool index is in range and is a utf8
 425   bool valid_symbol_at(int cpool_index) {
 426     return (_cp->is_within_bounds(cpool_index) &&
 427             _cp->tag_at(cpool_index).is_utf8());
 428   }
 429 
 430   void copy_localvariable_table(ConstMethod* cm, int lvt_cnt,
 431                                 u2* localvariable_table_length,
 432                                 u2** localvariable_table_start,
 433                                 int lvtt_cnt,
 434                                 u2* localvariable_type_table_length,
 435                                 u2** localvariable_type_table_start,
 436                                 TRAPS);
 437 
 438   void copy_method_annotations(ConstMethod* cm,
 439                                u1* runtime_visible_annotations,
 440                                int runtime_visible_annotations_length,
 441                                u1* runtime_invisible_annotations,
 442                                int runtime_invisible_annotations_length,
 443                                u1* runtime_visible_parameter_annotations,
 444                                int runtime_visible_parameter_annotations_length,
 445                                u1* runtime_invisible_parameter_annotations,
 446                                int runtime_invisible_parameter_annotations_length,
 447                                u1* runtime_visible_type_annotations,
 448                                int runtime_visible_type_annotations_length,
 449                                u1* runtime_invisible_type_annotations,
 450                                int runtime_invisible_type_annotations_length,
 451                                u1* annotation_default,
 452                                int annotation_default_length,
 453                                TRAPS);
 454 
 455   // lays out fields in class and returns the total oopmap count
 456   void layout_fields(Handle class_loader, FieldAllocationCount* fac,
 457                      ClassAnnotationCollector* parsed_annotations,
 458                      FieldLayoutInfo* info, TRAPS);
 459 
 460  public:
 461   // Constructor
 462   ClassFileParser(ClassFileStream* st) { set_stream(st); }
 463   ~ClassFileParser();
 464 
 465   // Parse .class file and return new Klass*. The Klass* is not hooked up
 466   // to the system dictionary or any other structures, so a .class file can
 467   // be loaded several times if desired.
 468   // The system dictionary hookup is done by the caller.
 469   //
 470   // "parsed_name" is updated by this method, and is the name found
 471   // while parsing the stream.
 472   instanceKlassHandle parseClassFile(Symbol* name,
 473                                      ClassLoaderData* loader_data,
 474                                      Handle protection_domain,
 475                                      TempNewSymbol& parsed_name,
 476                                      bool verify,
 477                                      TRAPS) {
 478     KlassHandle no_host_klass;
 479     return parseClassFile(name, loader_data, protection_domain, no_host_klass, NULL, parsed_name, verify, THREAD);
 480   }
 481   instanceKlassHandle parseClassFile(Symbol* name,
 482                                      ClassLoaderData* loader_data,
 483                                      Handle protection_domain,
 484                                      KlassHandle host_klass,
 485                                      GrowableArray<Handle>* cp_patches,
 486                                      TempNewSymbol& parsed_name,
 487                                      bool verify,
 488                                      TRAPS);
 489 
 490   // Verifier checks
 491   static void check_super_class_access(instanceKlassHandle this_klass, TRAPS);
 492   static void check_super_interface_access(instanceKlassHandle this_klass, TRAPS);
 493   static void check_final_method_override(instanceKlassHandle this_klass, TRAPS);
 494   static void check_illegal_static_method(instanceKlassHandle this_klass, TRAPS);
 495 };
 496 
 497 #endif // SHARE_VM_CLASSFILE_CLASSFILEPARSER_HPP
--- EOF ---