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