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