src/share/vm/classfile/classFileParser.hpp

Sat, 01 Sep 2012 13:25:18 -0400

author
coleenp
date
Sat, 01 Sep 2012 13:25:18 -0400
changeset 4037
da91efe96a93
parent 3969
1d7922586cf6
child 4142
d8ce2825b193
child 4163
19eb999cb72c
permissions
-rw-r--r--

6964458: Reimplement class meta-data storage to use native memory
Summary: Remove PermGen, allocate meta-data in metaspace linked to class loaders, rewrite GC walking, rewrite and rename metadata to be C++ classes
Reviewed-by: jmasa, stefank, never, coleenp, kvn, brutisso, mgerdin, dholmes, jrose, twisti, roland
Contributed-by: jmasa <jon.masamitsu@oracle.com>, stefank <stefan.karlsson@oracle.com>, mgerdin <mikael.gerdin@oracle.com>, never <tom.rodriguez@oracle.com>

     1 /*
     2  * Copyright (c) 1997, 2012, 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  */
    25 #ifndef SHARE_VM_CLASSFILE_CLASSFILEPARSER_HPP
    26 #define SHARE_VM_CLASSFILE_CLASSFILEPARSER_HPP
    28 #include "classfile/classFileStream.hpp"
    29 #include "memory/resourceArea.hpp"
    30 #include "oops/oop.inline.hpp"
    31 #include "oops/typeArrayOop.hpp"
    32 #include "runtime/handles.inline.hpp"
    33 #include "utilities/accessFlags.hpp"
    34 #include "classfile/symbolTable.hpp"
    36 class FieldAllocationCount;
    39 // Parser for for .class files
    40 //
    41 // The bytes describing the class file structure is read from a Stream object
    43 class ClassFileParser VALUE_OBJ_CLASS_SPEC {
    44  private:
    45   bool _need_verify;
    46   bool _relax_verify;
    47   u2   _major_version;
    48   u2   _minor_version;
    49   Symbol* _class_name;
    50   KlassHandle _host_klass;
    51   GrowableArray<Handle>* _cp_patches; // overrides for CP entries
    53   // precomputed flags
    54   bool _has_finalizer;
    55   bool _has_empty_finalizer;
    56   bool _has_vanilla_constructor;
    57   int _max_bootstrap_specifier_index;  // detects BSS values
    59   // class attributes parsed before the instance klass is created:
    60   bool       _synthetic_flag;
    61   Symbol*    _sourcefile;
    62   Symbol*    _generic_signature;
    63   char*      _sde_buffer;
    64   int        _sde_length;
    65   Array<u2>* _inner_classes;
    66   AnnotationArray* _annotations;
    68   void set_class_synthetic_flag(bool x)           { _synthetic_flag = x; }
    69   void set_class_sourcefile(Symbol* x)            { _sourcefile = x; }
    70   void set_class_generic_signature(Symbol* x)     { _generic_signature = x; }
    71   void set_class_sde_buffer(char* x, int len)     { _sde_buffer = x; _sde_length = len; }
    72   void set_class_inner_classes(Array<u2>* x)      { _inner_classes = x; }
    73   void set_class_annotations(AnnotationArray* x)  { _annotations = x; }
    74   void init_parsed_class_attributes() {
    75     _synthetic_flag = false;
    76     _sourcefile = NULL;
    77     _generic_signature = NULL;
    78     _sde_buffer = NULL;
    79     _sde_length = 0;
    80     // initialize the other flags too:
    81     _has_finalizer = _has_empty_finalizer = _has_vanilla_constructor = false;
    82     _max_bootstrap_specifier_index = -1;
    83   }
    84   void apply_parsed_class_attributes(instanceKlassHandle k);  // update k
    86   class AnnotationCollector {
    87   public:
    88     enum Location { _in_field, _in_method, _in_class };
    89     enum ID {
    90       _unknown = 0,
    91       _method_ForceInline,
    92       _method_DontInline,
    93       _method_LambdaForm_Compiled,
    94       _method_LambdaForm_Hidden,
    95       _annotation_LIMIT
    96     };
    97     const Location _location;
    98     int _annotations_present;
    99     AnnotationCollector(Location location)
   100     : _location(location), _annotations_present(0)
   101     {
   102       assert((int)_annotation_LIMIT <= (int)sizeof(_annotations_present) * BitsPerByte, "");
   103     }
   104     // If this annotation name has an ID, report it (or _none).
   105     ID annotation_index(Symbol* name);
   106     // Set the annotation name:
   107     void set_annotation(ID id) {
   108       assert((int)id >= 0 && (int)id < (int)_annotation_LIMIT, "oob");
   109       _annotations_present |= nth_bit((int)id);
   110     }
   111     // Report if the annotation is present.
   112     bool has_any_annotations() { return _annotations_present != 0; }
   113     bool has_annotation(ID id) { return (nth_bit((int)id) & _annotations_present) != 0; }
   114   };
   115   class FieldAnnotationCollector: public AnnotationCollector {
   116   public:
   117     FieldAnnotationCollector() : AnnotationCollector(_in_field) { }
   118     void apply_to(FieldInfo* f);
   119   };
   120   class MethodAnnotationCollector: public AnnotationCollector {
   121   public:
   122     MethodAnnotationCollector() : AnnotationCollector(_in_method) { }
   123     void apply_to(methodHandle m);
   124   };
   125   class ClassAnnotationCollector: public AnnotationCollector {
   126   public:
   127     ClassAnnotationCollector() : AnnotationCollector(_in_class) { }
   128     void apply_to(instanceKlassHandle k);
   129   };
   131   enum { fixed_buffer_size = 128 };
   132   u_char linenumbertable_buffer[fixed_buffer_size];
   134   ClassFileStream* _stream;              // Actual input stream
   136   enum { LegalClass, LegalField, LegalMethod }; // used to verify unqualified names
   138   // Accessors
   139   ClassFileStream* stream()                        { return _stream; }
   140   void set_stream(ClassFileStream* st)             { _stream = st; }
   142   // Constant pool parsing
   143   void parse_constant_pool_entries(ClassLoaderData* loader_data,
   144                                    constantPoolHandle cp, int length, TRAPS);
   146   constantPoolHandle parse_constant_pool(ClassLoaderData* loader_data, TRAPS);
   148   // Interface parsing
   149   Array<Klass*>* parse_interfaces(constantPoolHandle cp,
   150                                   int length,
   151                                     ClassLoaderData* loader_data,
   152                                   Handle protection_domain,
   153                                   Symbol* class_name,
   154                                   TRAPS);
   155   void record_defined_class_dependencies(instanceKlassHandle defined_klass, TRAPS);
   157   // Field parsing
   158   void parse_field_attributes(ClassLoaderData* loader_data,
   159                               constantPoolHandle cp, u2 attributes_count,
   160                               bool is_static, u2 signature_index,
   161                               u2* constantvalue_index_addr,
   162                               bool* is_synthetic_addr,
   163                               u2* generic_signature_index_addr,
   164                               AnnotationArray** field_annotations,
   165                               FieldAnnotationCollector* parsed_annotations,
   166                               TRAPS);
   167   Array<u2>* parse_fields(ClassLoaderData* loader_data,
   168                           Symbol* class_name,
   169                                constantPoolHandle cp, bool is_interface,
   170                                FieldAllocationCount *fac,
   171                           Array<AnnotationArray*>** fields_annotations,
   172                                u2* java_fields_count_ptr, TRAPS);
   174   // Method parsing
   175   methodHandle parse_method(ClassLoaderData* loader_data,
   176                             constantPoolHandle cp,
   177                             bool is_interface,
   178                             AccessFlags* promoted_flags,
   179                             AnnotationArray** method_annotations,
   180                             AnnotationArray** method_parameter_annotations,
   181                             AnnotationArray** method_default_annotations,
   182                             TRAPS);
   183   Array<Method*>* parse_methods(ClassLoaderData* loader_data,
   184                                   constantPoolHandle cp,
   185                                   bool is_interface,
   186                                 AccessFlags* promoted_flags,
   187                                 bool* has_final_method,
   188                                   Array<AnnotationArray*>** methods_annotations,
   189                                   Array<AnnotationArray*>** methods_parameter_annotations,
   190                                   Array<AnnotationArray*>** methods_default_annotations,
   191                                 TRAPS);
   192   Array<int>* sort_methods(ClassLoaderData* loader_data,
   193                            Array<Method*>* methods,
   194                            Array<AnnotationArray*>* methods_annotations,
   195                            Array<AnnotationArray*>* methods_parameter_annotations,
   196                            Array<AnnotationArray*>* methods_default_annotations,
   197                                 TRAPS);
   198   u2* parse_exception_table(ClassLoaderData* loader_data,
   199                             u4 code_length, u4 exception_table_length,
   200                             constantPoolHandle cp, TRAPS);
   201   void parse_linenumber_table(
   202       u4 code_attribute_length, u4 code_length,
   203       CompressedLineNumberWriteStream** write_stream, TRAPS);
   204   u2* parse_localvariable_table(u4 code_length, u2 max_locals, u4 code_attribute_length,
   205                                 constantPoolHandle cp, u2* localvariable_table_length,
   206                                 bool isLVTT, TRAPS);
   207   u2* parse_checked_exceptions(u2* checked_exceptions_length, u4 method_attribute_length,
   208                                constantPoolHandle cp, TRAPS);
   209   void parse_type_array(u2 array_length, u4 code_length, u4* u1_index, u4* u2_index,
   210                         u1* u1_array, u2* u2_array, constantPoolHandle cp, TRAPS);
   211   Array<u1>* parse_stackmap_table(ClassLoaderData* loader_data, u4 code_attribute_length, TRAPS);
   213   // Classfile attribute parsing
   214   void parse_classfile_sourcefile_attribute(constantPoolHandle cp, TRAPS);
   215   void parse_classfile_source_debug_extension_attribute(constantPoolHandle cp,
   216                                                         int length, TRAPS);
   217   u2   parse_classfile_inner_classes_attribute(ClassLoaderData* loader_data,
   218                                                u1* inner_classes_attribute_start,
   219                                                bool parsed_enclosingmethod_attribute,
   220                                                u2 enclosing_method_class_index,
   221                                                u2 enclosing_method_method_index,
   222                                                constantPoolHandle cp,
   223                                                TRAPS);
   224   void parse_classfile_attributes(ClassLoaderData* loader_data,
   225                                   constantPoolHandle cp,
   226                                   ClassAnnotationCollector* parsed_annotations,
   227                                   TRAPS);
   228   void parse_classfile_synthetic_attribute(constantPoolHandle cp, TRAPS);
   229   void parse_classfile_signature_attribute(constantPoolHandle cp, TRAPS);
   230   void parse_classfile_bootstrap_methods_attribute(ClassLoaderData* loader_data, constantPoolHandle cp, u4 attribute_length, TRAPS);
   232   // Annotations handling
   233   AnnotationArray* assemble_annotations(ClassLoaderData* loader_data,
   234                                         u1* runtime_visible_annotations,
   235                                        int runtime_visible_annotations_length,
   236                                        u1* runtime_invisible_annotations,
   237                                        int runtime_invisible_annotations_length, TRAPS);
   238   int skip_annotation(u1* buffer, int limit, int index);
   239   int skip_annotation_value(u1* buffer, int limit, int index);
   240   void parse_annotations(u1* buffer, int limit, constantPoolHandle cp,
   241                          /* Results (currently, only one result is supported): */
   242                          AnnotationCollector* result,
   243                          TRAPS);
   245   // Final setup
   246   unsigned int compute_oop_map_count(instanceKlassHandle super,
   247                                      unsigned int nonstatic_oop_count,
   248                                      int first_nonstatic_oop_offset);
   249   void fill_oop_maps(instanceKlassHandle k,
   250                      unsigned int nonstatic_oop_map_count,
   251                      int* nonstatic_oop_offsets,
   252                      unsigned int* nonstatic_oop_counts);
   253   void set_precomputed_flags(instanceKlassHandle k);
   254   Array<Klass*>* compute_transitive_interfaces(ClassLoaderData* loader_data,
   255                                                  instanceKlassHandle super,
   256                                                  Array<Klass*>* local_ifs, TRAPS);
   258   // Format checker methods
   259   void classfile_parse_error(const char* msg, TRAPS);
   260   void classfile_parse_error(const char* msg, int index, TRAPS);
   261   void classfile_parse_error(const char* msg, const char *name, TRAPS);
   262   void classfile_parse_error(const char* msg, int index, const char *name, TRAPS);
   263   inline void guarantee_property(bool b, const char* msg, TRAPS) {
   264     if (!b) { classfile_parse_error(msg, CHECK); }
   265   }
   267   inline void assert_property(bool b, const char* msg, TRAPS) {
   268 #ifdef ASSERT
   269     if (!b) { fatal(msg); }
   270 #endif
   271   }
   273   inline void check_property(bool property, const char* msg, int index, TRAPS) {
   274     if (_need_verify) {
   275       guarantee_property(property, msg, index, CHECK);
   276     } else {
   277       assert_property(property, msg, CHECK);
   278     }
   279   }
   281   inline void check_property(bool property, const char* msg, TRAPS) {
   282     if (_need_verify) {
   283       guarantee_property(property, msg, CHECK);
   284     } else {
   285       assert_property(property, msg, CHECK);
   286     }
   287   }
   289   inline void guarantee_property(bool b, const char* msg, int index, TRAPS) {
   290     if (!b) { classfile_parse_error(msg, index, CHECK); }
   291   }
   292   inline void guarantee_property(bool b, const char* msg, const char *name, TRAPS) {
   293     if (!b) { classfile_parse_error(msg, name, CHECK); }
   294   }
   295   inline void guarantee_property(bool b, const char* msg, int index, const char *name, TRAPS) {
   296     if (!b) { classfile_parse_error(msg, index, name, CHECK); }
   297   }
   299   void throwIllegalSignature(
   300       const char* type, Symbol* name, Symbol* sig, TRAPS);
   302   bool is_supported_version(u2 major, u2 minor);
   303   bool has_illegal_visibility(jint flags);
   305   void verify_constantvalue(int constantvalue_index, int signature_index, constantPoolHandle cp, TRAPS);
   306   void verify_legal_utf8(const unsigned char* buffer, int length, TRAPS);
   307   void verify_legal_class_name(Symbol* name, TRAPS);
   308   void verify_legal_field_name(Symbol* name, TRAPS);
   309   void verify_legal_method_name(Symbol* name, TRAPS);
   310   void verify_legal_field_signature(Symbol* fieldname, Symbol* signature, TRAPS);
   311   int  verify_legal_method_signature(Symbol* methodname, Symbol* signature, TRAPS);
   312   void verify_legal_class_modifiers(jint flags, TRAPS);
   313   void verify_legal_field_modifiers(jint flags, bool is_interface, TRAPS);
   314   void verify_legal_method_modifiers(jint flags, bool is_interface, Symbol* name, TRAPS);
   315   bool verify_unqualified_name(char* name, unsigned int length, int type);
   316   char* skip_over_field_name(char* name, bool slash_ok, unsigned int length);
   317   char* skip_over_field_signature(char* signature, bool void_ok, unsigned int length, TRAPS);
   319   bool is_anonymous() {
   320     assert(EnableInvokeDynamic || _host_klass.is_null(), "");
   321     return _host_klass.not_null();
   322   }
   323   bool has_cp_patch_at(int index) {
   324     assert(EnableInvokeDynamic, "");
   325     assert(index >= 0, "oob");
   326     return (_cp_patches != NULL
   327             && index < _cp_patches->length()
   328             && _cp_patches->adr_at(index)->not_null());
   329   }
   330   Handle cp_patch_at(int index) {
   331     assert(has_cp_patch_at(index), "oob");
   332     return _cp_patches->at(index);
   333   }
   334   Handle clear_cp_patch_at(int index) {
   335     Handle patch = cp_patch_at(index);
   336     _cp_patches->at_put(index, Handle());
   337     assert(!has_cp_patch_at(index), "");
   338     return patch;
   339   }
   340   void patch_constant_pool(constantPoolHandle cp, int index, Handle patch, TRAPS);
   342   // Wrapper for constantTag.is_klass_[or_]reference.
   343   // In older versions of the VM, Klass*s cannot sneak into early phases of
   344   // constant pool construction, but in later versions they can.
   345   // %%% Let's phase out the old is_klass_reference.
   346   bool is_klass_reference(constantPoolHandle cp, int index) {
   347     return ((LinkWellKnownClasses || EnableInvokeDynamic)
   348             ? cp->tag_at(index).is_klass_or_reference()
   349             : cp->tag_at(index).is_klass_reference());
   350   }
   352  public:
   353   // Constructor
   354   ClassFileParser(ClassFileStream* st) { set_stream(st); }
   356   // Parse .class file and return new Klass*. The Klass* is not hooked up
   357   // to the system dictionary or any other structures, so a .class file can
   358   // be loaded several times if desired.
   359   // The system dictionary hookup is done by the caller.
   360   //
   361   // "parsed_name" is updated by this method, and is the name found
   362   // while parsing the stream.
   363   instanceKlassHandle parseClassFile(Symbol* name,
   364                                      Handle class_loader,
   365                                      Handle protection_domain,
   366                                      TempNewSymbol& parsed_name,
   367                                      bool verify,
   368                                      TRAPS) {
   369     KlassHandle no_host_klass;
   370     return parseClassFile(name, class_loader, protection_domain, no_host_klass, NULL, parsed_name, verify, THREAD);
   371   }
   372   instanceKlassHandle parseClassFile(Symbol* name,
   373                                      Handle class_loader,
   374                                      Handle protection_domain,
   375                                      KlassHandle host_klass,
   376                                      GrowableArray<Handle>* cp_patches,
   377                                      TempNewSymbol& parsed_name,
   378                                      bool verify,
   379                                      TRAPS);
   381   // Verifier checks
   382   static void check_super_class_access(instanceKlassHandle this_klass, TRAPS);
   383   static void check_super_interface_access(instanceKlassHandle this_klass, TRAPS);
   384   static void check_final_method_override(instanceKlassHandle this_klass, TRAPS);
   385   static void check_illegal_static_method(instanceKlassHandle this_klass, TRAPS);
   386 };
   388 #endif // SHARE_VM_CLASSFILE_CLASSFILEPARSER_HPP

mercurial