1 /*
   2  * Copyright (c) 1997, 2011, 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 "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 
  35 class TempNewSymbol;
  36 class FieldAllocationCount;
  37 
  38 
  39 // Parser for for .class files
  40 //
  41 // The bytes describing the class file structure is read from a Stream object
  42 
  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
  52 
  53   bool _has_finalizer;
  54   bool _has_empty_finalizer;
  55   bool _has_vanilla_constructor;
  56 
  57   int _max_bootstrap_specifier_index;
  58 
  59   enum { fixed_buffer_size = 128 };
  60   u_char linenumbertable_buffer[fixed_buffer_size];
  61 
  62   ClassFileStream* _stream;              // Actual input stream
  63 
  64   enum { LegalClass, LegalField, LegalMethod }; // used to verify unqualified names
  65 
  66   // Accessors
  67   ClassFileStream* stream()                        { return _stream; }
  68   void set_stream(ClassFileStream* st)             { _stream = st; }
  69 
  70   // Constant pool parsing
  71   void parse_constant_pool_entries(constantPoolHandle cp, int length, TRAPS);
  72 
  73   constantPoolHandle parse_constant_pool(TRAPS);
  74 
  75   // Interface parsing
  76   objArrayHandle parse_interfaces(constantPoolHandle cp,
  77                                   int length,
  78                                   Handle class_loader,
  79                                   Handle protection_domain,
  80                                   Symbol* class_name,
  81                                   TRAPS);
  82 
  83   // Field parsing
  84   void parse_field_attributes(constantPoolHandle cp, u2 attributes_count,
  85                               bool is_static, u2 signature_index,
  86                               u2* constantvalue_index_addr,
  87                               bool* is_synthetic_addr,
  88                               u2* generic_signature_index_addr,
  89                               typeArrayHandle* field_annotations, TRAPS);
  90   typeArrayHandle parse_fields(Symbol* class_name,
  91                                constantPoolHandle cp, bool is_interface,
  92                                FieldAllocationCount *fac,
  93                                objArrayHandle* fields_annotations,
  94                                u2* java_fields_count_ptr, TRAPS);
  95 
  96   // Method parsing
  97   methodHandle parse_method(constantPoolHandle cp, bool is_interface,
  98                             AccessFlags* promoted_flags,
  99                             typeArrayHandle* method_annotations,
 100                             typeArrayHandle* method_parameter_annotations,
 101                             typeArrayHandle* method_default_annotations,
 102                             TRAPS);
 103   objArrayHandle parse_methods (constantPoolHandle cp, bool is_interface,
 104                                 AccessFlags* promoted_flags,
 105                                 bool* has_final_method,
 106                                 objArrayOop* methods_annotations_oop,
 107                                 objArrayOop* methods_parameter_annotations_oop,
 108                                 objArrayOop* methods_default_annotations_oop,
 109                                 TRAPS);
 110   typeArrayHandle sort_methods (objArrayHandle methods,
 111                                 objArrayHandle methods_annotations,
 112                                 objArrayHandle methods_parameter_annotations,
 113                                 objArrayHandle methods_default_annotations,
 114                                 TRAPS);
 115   typeArrayHandle parse_exception_table(u4 code_length, u4 exception_table_length,
 116                                         constantPoolHandle cp, TRAPS);
 117   void parse_linenumber_table(
 118       u4 code_attribute_length, u4 code_length,
 119       CompressedLineNumberWriteStream** write_stream, TRAPS);
 120   u2* parse_localvariable_table(u4 code_length, u2 max_locals, u4 code_attribute_length,
 121                                 constantPoolHandle cp, u2* localvariable_table_length,
 122                                 bool isLVTT, TRAPS);
 123   u2* parse_checked_exceptions(u2* checked_exceptions_length, u4 method_attribute_length,
 124                                constantPoolHandle cp, TRAPS);
 125   void parse_type_array(u2 array_length, u4 code_length, u4* u1_index, u4* u2_index,
 126                         u1* u1_array, u2* u2_array, constantPoolHandle cp, TRAPS);
 127   typeArrayOop parse_stackmap_table(u4 code_attribute_length, TRAPS);
 128 
 129   // Classfile attribute parsing
 130   void parse_classfile_sourcefile_attribute(constantPoolHandle cp, instanceKlassHandle k, TRAPS);
 131   void parse_classfile_source_debug_extension_attribute(constantPoolHandle cp,
 132                                                 instanceKlassHandle k, int length, TRAPS);
 133   u2   parse_classfile_inner_classes_attribute(u1* inner_classes_attribute_start,
 134                                                bool parsed_enclosingmethod_attribute,
 135                                                u2 enclosing_method_class_index,
 136                                                u2 enclosing_method_method_index,
 137                                                constantPoolHandle cp,
 138                                                instanceKlassHandle k, TRAPS);
 139   void parse_classfile_attributes(constantPoolHandle cp, instanceKlassHandle k, TRAPS);
 140   void parse_classfile_synthetic_attribute(constantPoolHandle cp, instanceKlassHandle k, TRAPS);
 141   void parse_classfile_signature_attribute(constantPoolHandle cp, instanceKlassHandle k, TRAPS);
 142   void parse_classfile_bootstrap_methods_attribute(constantPoolHandle cp, instanceKlassHandle k, u4 attribute_length, TRAPS);
 143 
 144   // Annotations handling
 145   typeArrayHandle assemble_annotations(u1* runtime_visible_annotations,
 146                                        int runtime_visible_annotations_length,
 147                                        u1* runtime_invisible_annotations,
 148                                        int runtime_invisible_annotations_length, TRAPS);
 149 
 150   // Final setup
 151   unsigned int compute_oop_map_count(instanceKlassHandle super,
 152                                      unsigned int nonstatic_oop_count,
 153                                      int first_nonstatic_oop_offset);
 154   void fill_oop_maps(instanceKlassHandle k,
 155                      unsigned int nonstatic_oop_map_count,
 156                      int* nonstatic_oop_offsets,
 157                      unsigned int* nonstatic_oop_counts);
 158   void set_precomputed_flags(instanceKlassHandle k);
 159   objArrayHandle compute_transitive_interfaces(instanceKlassHandle super,
 160                                                objArrayHandle local_ifs, TRAPS);
 161 
 162   // Format checker methods
 163   void classfile_parse_error(const char* msg, TRAPS);
 164   void classfile_parse_error(const char* msg, int index, TRAPS);
 165   void classfile_parse_error(const char* msg, const char *name, TRAPS);
 166   void classfile_parse_error(const char* msg, int index, const char *name, TRAPS);
 167   inline void guarantee_property(bool b, const char* msg, TRAPS) {
 168     if (!b) { classfile_parse_error(msg, CHECK); }
 169   }
 170 
 171   inline void assert_property(bool b, const char* msg, TRAPS) {
 172 #ifdef ASSERT
 173     if (!b) { fatal(msg); }
 174 #endif
 175   }
 176 
 177   inline void check_property(bool property, const char* msg, int index, TRAPS) {
 178     if (_need_verify) {
 179       guarantee_property(property, msg, index, CHECK);
 180     } else {
 181       assert_property(property, msg, CHECK);
 182     }
 183   }
 184 
 185   inline void check_property(bool property, const char* msg, TRAPS) {
 186     if (_need_verify) {
 187       guarantee_property(property, msg, CHECK);
 188     } else {
 189       assert_property(property, msg, CHECK);
 190     }
 191   }
 192 
 193   inline void guarantee_property(bool b, const char* msg, int index, TRAPS) {
 194     if (!b) { classfile_parse_error(msg, index, CHECK); }
 195   }
 196   inline void guarantee_property(bool b, const char* msg, const char *name, TRAPS) {
 197     if (!b) { classfile_parse_error(msg, name, CHECK); }
 198   }
 199   inline void guarantee_property(bool b, const char* msg, int index, const char *name, TRAPS) {
 200     if (!b) { classfile_parse_error(msg, index, name, CHECK); }
 201   }
 202 
 203   void throwIllegalSignature(
 204       const char* type, Symbol* name, Symbol* sig, TRAPS);
 205 
 206   bool is_supported_version(u2 major, u2 minor);
 207   bool has_illegal_visibility(jint flags);
 208 
 209   void verify_constantvalue(int constantvalue_index, int signature_index, constantPoolHandle cp, TRAPS);
 210   void verify_legal_utf8(const unsigned char* buffer, int length, TRAPS);
 211   void verify_legal_class_name(Symbol* name, TRAPS);
 212   void verify_legal_field_name(Symbol* name, TRAPS);
 213   void verify_legal_method_name(Symbol* name, TRAPS);
 214   void verify_legal_field_signature(Symbol* fieldname, Symbol* signature, TRAPS);
 215   int  verify_legal_method_signature(Symbol* methodname, Symbol* signature, TRAPS);
 216   void verify_legal_class_modifiers(jint flags, TRAPS);
 217   void verify_legal_field_modifiers(jint flags, bool is_interface, TRAPS);
 218   void verify_legal_method_modifiers(jint flags, bool is_interface, Symbol* name, TRAPS);
 219   bool verify_unqualified_name(char* name, unsigned int length, int type);
 220   char* skip_over_field_name(char* name, bool slash_ok, unsigned int length);
 221   char* skip_over_field_signature(char* signature, bool void_ok, unsigned int length, TRAPS);
 222 
 223   bool is_anonymous() {
 224     assert(EnableInvokeDynamic || _host_klass.is_null(), "");
 225     return _host_klass.not_null();
 226   }
 227   bool has_cp_patch_at(int index) {
 228     assert(EnableInvokeDynamic, "");
 229     assert(index >= 0, "oob");
 230     return (_cp_patches != NULL
 231             && index < _cp_patches->length()
 232             && _cp_patches->adr_at(index)->not_null());
 233   }
 234   Handle cp_patch_at(int index) {
 235     assert(has_cp_patch_at(index), "oob");
 236     return _cp_patches->at(index);
 237   }
 238   Handle clear_cp_patch_at(int index) {
 239     Handle patch = cp_patch_at(index);
 240     _cp_patches->at_put(index, Handle());
 241     assert(!has_cp_patch_at(index), "");
 242     return patch;
 243   }
 244   void patch_constant_pool(constantPoolHandle cp, int index, Handle patch, TRAPS);
 245 
 246   // Wrapper for constantTag.is_klass_[or_]reference.
 247   // In older versions of the VM, klassOops cannot sneak into early phases of
 248   // constant pool construction, but in later versions they can.
 249   // %%% Let's phase out the old is_klass_reference.
 250   bool is_klass_reference(constantPoolHandle cp, int index) {
 251     return ((LinkWellKnownClasses || EnableInvokeDynamic)
 252             ? cp->tag_at(index).is_klass_or_reference()
 253             : cp->tag_at(index).is_klass_reference());
 254   }
 255 
 256  public:
 257   // Constructor
 258   ClassFileParser(ClassFileStream* st) { set_stream(st); }
 259 
 260   // Parse .class file and return new klassOop. The klassOop is not hooked up
 261   // to the system dictionary or any other structures, so a .class file can
 262   // be loaded several times if desired.
 263   // The system dictionary hookup is done by the caller.
 264   //
 265   // "parsed_name" is updated by this method, and is the name found
 266   // while parsing the stream.
 267   instanceKlassHandle parseClassFile(Symbol* name,
 268                                      Handle class_loader,
 269                                      Handle protection_domain,
 270                                      TempNewSymbol& parsed_name,
 271                                      bool verify,
 272                                      TRAPS) {
 273     KlassHandle no_host_klass;
 274     return parseClassFile(name, class_loader, protection_domain, no_host_klass, NULL, parsed_name, verify, THREAD);
 275   }
 276   instanceKlassHandle parseClassFile(Symbol* name,
 277                                      Handle class_loader,
 278                                      Handle protection_domain,
 279                                      KlassHandle host_klass,
 280                                      GrowableArray<Handle>* cp_patches,
 281                                      TempNewSymbol& parsed_name,
 282                                      bool verify,
 283                                      TRAPS);
 284 
 285   // Verifier checks
 286   static void check_super_class_access(instanceKlassHandle this_klass, TRAPS);
 287   static void check_super_interface_access(instanceKlassHandle this_klass, TRAPS);
 288   static void check_final_method_override(instanceKlassHandle this_klass, TRAPS);
 289   static void check_illegal_static_method(instanceKlassHandle this_klass, TRAPS);
 290 };
 291 
 292 #endif // SHARE_VM_CLASSFILE_CLASSFILEPARSER_HPP