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/typeArrayOop.hpp" 32 #include "oops/constantPool.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_LambdaForm_Compiled, 131 _method_LambdaForm_Hidden, 132 _sun_misc_Contended, 133 _field_Stable, 134 _annotation_LIMIT 135 }; 136 const Location _location; 137 int _annotations_present; 138 u2 _contended_group; 139 140 AnnotationCollector(Location location) 141 : _location(location), _annotations_present(0) 142 { 143 assert((int)_annotation_LIMIT <= (int)sizeof(_annotations_present) * BitsPerByte, ""); 144 } 145 // If this annotation name has an ID, report it (or _none). 146 ID annotation_index(ClassLoaderData* loader_data, Symbol* name); 147 // Set the annotation name: 148 void set_annotation(ID id) { 149 assert((int)id >= 0 && (int)id < (int)_annotation_LIMIT, "oob"); 150 _annotations_present |= nth_bit((int)id); 151 } 152 153 void remove_annotation(ID id) { 154 assert((int)id >= 0 && (int)id < (int)_annotation_LIMIT, "oob"); 155 _annotations_present &= ~nth_bit((int)id); 156 } 157 158 // Report if the annotation is present. 159 bool has_any_annotations() const { return _annotations_present != 0; } 160 bool has_annotation(ID id) const { return (nth_bit((int)id) & _annotations_present) != 0; } 161 162 void set_contended_group(u2 group) { _contended_group = group; } 163 u2 contended_group() const { return _contended_group; } 164 165 bool is_contended() const { return has_annotation(_sun_misc_Contended); } 166 167 void set_stable(bool stable) { set_annotation(_field_Stable); } 168 bool is_stable() const { return has_annotation(_field_Stable); } 169 }; 170 171 // This class also doubles as a holder for metadata cleanup. 172 class FieldAnnotationCollector: public AnnotationCollector { 173 ClassLoaderData* _loader_data; 174 AnnotationArray* _field_annotations; 175 AnnotationArray* _field_type_annotations; 176 public: 177 FieldAnnotationCollector(ClassLoaderData* loader_data) : 178 AnnotationCollector(_in_field), 179 _loader_data(loader_data), 180 _field_annotations(NULL), 181 _field_type_annotations(NULL) {} 182 void apply_to(FieldInfo* f); 183 ~FieldAnnotationCollector(); 184 AnnotationArray* field_annotations() { return _field_annotations; } 185 AnnotationArray* field_type_annotations() { return _field_type_annotations; } 186 187 void set_field_annotations(AnnotationArray* a) { _field_annotations = a; } 188 void set_field_type_annotations(AnnotationArray* a) { _field_type_annotations = a; } 189 }; 190 191 class MethodAnnotationCollector: public AnnotationCollector { 192 public: 193 MethodAnnotationCollector() : AnnotationCollector(_in_method) { } 194 void apply_to(methodHandle m); 195 }; 196 class ClassAnnotationCollector: public AnnotationCollector { 197 public: 198 ClassAnnotationCollector() : AnnotationCollector(_in_class) { } 199 void apply_to(instanceKlassHandle k); 200 }; 201 202 enum { fixed_buffer_size = 128 }; 203 u_char linenumbertable_buffer[fixed_buffer_size]; 204 205 ClassFileStream* _stream; // Actual input stream 206 207 enum { LegalClass, LegalField, LegalMethod }; // used to verify unqualified names 208 209 // Accessors 210 ClassFileStream* stream() { return _stream; } 211 void set_stream(ClassFileStream* st) { _stream = st; } 212 213 // Constant pool parsing 214 void parse_constant_pool_entries(int length, TRAPS); 215 216 constantPoolHandle parse_constant_pool(TRAPS); 217 218 // Interface parsing 219 Array<Klass*>* parse_interfaces(int length, 220 Handle protection_domain, 221 Symbol* class_name, 222 bool* has_default_methods, 223 TRAPS); 224 void record_defined_class_dependencies(instanceKlassHandle defined_klass, TRAPS); 225 226 instanceKlassHandle parse_super_class(int super_class_index, TRAPS); 227 // Field parsing 228 void parse_field_attributes(u2 attributes_count, 229 bool is_static, u2 signature_index, 230 u2* constantvalue_index_addr, 231 bool* is_synthetic_addr, 232 u2* generic_signature_index_addr, 233 FieldAnnotationCollector* parsed_annotations, 234 TRAPS); 235 Array<u2>* parse_fields(Symbol* class_name, 236 bool is_interface, 237 FieldAllocationCount *fac, 238 u2* java_fields_count_ptr, TRAPS); 239 240 void print_field_layout(Symbol* name, 241 Array<u2>* fields, 242 constantPoolHandle cp, 243 int instance_size, 244 int instance_fields_start, 245 int instance_fields_end, 246 int static_fields_end); 247 248 // Method parsing 249 methodHandle parse_method(bool is_interface, 250 AccessFlags* promoted_flags, 251 TRAPS); 252 Array<Method*>* parse_methods(bool is_interface, 253 AccessFlags* promoted_flags, 254 bool* has_final_method, 255 bool* declares_default_methods, 256 TRAPS); 257 intArray* sort_methods(Array<Method*>* methods); 258 259 u2* parse_exception_table(u4 code_length, u4 exception_table_length, 260 TRAPS); 261 void parse_linenumber_table( 262 u4 code_attribute_length, u4 code_length, 263 CompressedLineNumberWriteStream** write_stream, TRAPS); 264 u2* parse_localvariable_table(u4 code_length, u2 max_locals, u4 code_attribute_length, 265 u2* localvariable_table_length, 266 bool isLVTT, TRAPS); 267 u2* parse_checked_exceptions(u2* checked_exceptions_length, u4 method_attribute_length, 268 TRAPS); 269 void parse_type_array(u2 array_length, u4 code_length, u4* u1_index, u4* u2_index, 270 u1* u1_array, u2* u2_array, TRAPS); 271 u1* parse_stackmap_table(u4 code_attribute_length, TRAPS); 272 273 // Classfile attribute parsing 274 u2 parse_generic_signature_attribute(TRAPS); 275 void parse_classfile_sourcefile_attribute(TRAPS); 276 void parse_classfile_source_debug_extension_attribute(int length, TRAPS); 277 u2 parse_classfile_inner_classes_attribute(u1* inner_classes_attribute_start, 278 bool parsed_enclosingmethod_attribute, 279 u2 enclosing_method_class_index, 280 u2 enclosing_method_method_index, 281 TRAPS); 282 void parse_classfile_attributes(ClassAnnotationCollector* parsed_annotations, 283 TRAPS); 284 void parse_classfile_synthetic_attribute(TRAPS); 285 void parse_classfile_signature_attribute(TRAPS); 286 void parse_classfile_bootstrap_methods_attribute(u4 attribute_length, TRAPS); 287 288 // Annotations handling 289 AnnotationArray* assemble_annotations(u1* runtime_visible_annotations, 290 int runtime_visible_annotations_length, 291 u1* runtime_invisible_annotations, 292 int runtime_invisible_annotations_length, TRAPS); 293 int skip_annotation(u1* buffer, int limit, int index); 294 int skip_annotation_value(u1* buffer, int limit, int index); 295 void parse_annotations(u1* buffer, int limit, 296 /* Results (currently, only one result is supported): */ 297 AnnotationCollector* result, 298 TRAPS); 299 300 // Final setup 301 unsigned int compute_oop_map_count(instanceKlassHandle super, 302 unsigned int nonstatic_oop_count, 303 int first_nonstatic_oop_offset); 304 void fill_oop_maps(instanceKlassHandle k, 305 unsigned int nonstatic_oop_map_count, 306 int* nonstatic_oop_offsets, 307 unsigned int* nonstatic_oop_counts); 308 void set_precomputed_flags(instanceKlassHandle k); 309 Array<Klass*>* compute_transitive_interfaces(instanceKlassHandle super, 310 Array<Klass*>* local_ifs, TRAPS); 311 312 // Format checker methods 313 void classfile_parse_error(const char* msg, TRAPS); 314 void classfile_parse_error(const char* msg, int index, TRAPS); 315 void classfile_parse_error(const char* msg, const char *name, TRAPS); 316 void classfile_parse_error(const char* msg, int index, const char *name, TRAPS); 317 inline void guarantee_property(bool b, const char* msg, TRAPS) { 318 if (!b) { classfile_parse_error(msg, CHECK); } 319 } 320 321 void report_assert_property_failure(const char* msg, TRAPS); 322 void report_assert_property_failure(const char* msg, int index, TRAPS); 323 324 inline void assert_property(bool b, const char* msg, TRAPS) { 325 #ifdef ASSERT 326 if (!b) { 327 report_assert_property_failure(msg, THREAD); 328 } 329 #endif 330 } 331 332 inline void assert_property(bool b, const char* msg, int index, TRAPS) { 333 #ifdef ASSERT 334 if (!b) { 335 report_assert_property_failure(msg, index, THREAD); 336 } 337 #endif 338 } 339 340 inline void check_property(bool property, const char* msg, int index, TRAPS) { 341 if (_need_verify) { 342 guarantee_property(property, msg, index, CHECK); 343 } else { 344 assert_property(property, msg, index, CHECK); 345 } 346 } 347 348 inline void check_property(bool property, const char* msg, TRAPS) { 349 if (_need_verify) { 350 guarantee_property(property, msg, CHECK); 351 } else { 352 assert_property(property, msg, CHECK); 353 } 354 } 355 356 inline void guarantee_property(bool b, const char* msg, int index, TRAPS) { 357 if (!b) { classfile_parse_error(msg, index, CHECK); } 358 } 359 inline void guarantee_property(bool b, const char* msg, const char *name, TRAPS) { 360 if (!b) { classfile_parse_error(msg, name, CHECK); } 361 } 362 inline void guarantee_property(bool b, const char* msg, int index, const char *name, TRAPS) { 363 if (!b) { classfile_parse_error(msg, index, name, CHECK); } 364 } 365 366 void throwIllegalSignature( 367 const char* type, Symbol* name, Symbol* sig, TRAPS); 368 369 bool is_supported_version(u2 major, u2 minor); 370 bool has_illegal_visibility(jint flags); 371 372 void verify_constantvalue(int constantvalue_index, int signature_index, TRAPS); 373 void verify_legal_utf8(const unsigned char* buffer, int length, TRAPS); 374 void verify_legal_class_name(Symbol* name, TRAPS); 375 void verify_legal_field_name(Symbol* name, TRAPS); 376 void verify_legal_method_name(Symbol* name, TRAPS); 377 void verify_legal_field_signature(Symbol* fieldname, Symbol* signature, TRAPS); 378 int verify_legal_method_signature(Symbol* methodname, Symbol* signature, TRAPS); 379 void verify_legal_class_modifiers(jint flags, TRAPS); 380 void verify_legal_field_modifiers(jint flags, bool is_interface, TRAPS); 381 void verify_legal_method_modifiers(jint flags, bool is_interface, Symbol* name, TRAPS); 382 bool verify_unqualified_name(char* name, unsigned int length, int type); 383 char* skip_over_field_name(char* name, bool slash_ok, unsigned int length); 384 char* skip_over_field_signature(char* signature, bool void_ok, unsigned int length, TRAPS); 385 386 bool is_anonymous() { 387 return _host_klass.not_null(); 388 } 389 bool has_cp_patch_at(int index) { 390 assert(index >= 0, "oob"); 391 return (_cp_patches != NULL 392 && index < _cp_patches->length() 393 && _cp_patches->adr_at(index)->not_null()); 394 } 395 Handle cp_patch_at(int index) { 396 assert(has_cp_patch_at(index), "oob"); 397 return _cp_patches->at(index); 398 } 399 Handle clear_cp_patch_at(int index) { 400 Handle patch = cp_patch_at(index); 401 _cp_patches->at_put(index, Handle()); 402 assert(!has_cp_patch_at(index), ""); 403 return patch; 404 } 405 void patch_constant_pool(constantPoolHandle cp, int index, Handle patch, TRAPS); 406 407 // Wrapper for constantTag.is_klass_[or_]reference. 408 // In older versions of the VM, Klass*s cannot sneak into early phases of 409 // constant pool construction, but in later versions they can. 410 // %%% Let's phase out the old is_klass_reference. 411 bool valid_klass_reference_at(int index) { 412 return _cp->is_within_bounds(index) && _cp->tag_at(index).is_klass_or_reference(); 413 } 414 415 // Checks that the cpool index is in range and is a utf8 416 bool valid_symbol_at(int cpool_index) { 417 return (_cp->is_within_bounds(cpool_index) && 418 _cp->tag_at(cpool_index).is_utf8()); 419 } 420 421 void copy_localvariable_table(ConstMethod* cm, int lvt_cnt, 422 u2* localvariable_table_length, 423 u2** localvariable_table_start, 424 int lvtt_cnt, 425 u2* localvariable_type_table_length, 426 u2** localvariable_type_table_start, 427 TRAPS); 428 429 void copy_method_annotations(ConstMethod* cm, 430 u1* runtime_visible_annotations, 431 int runtime_visible_annotations_length, 432 u1* runtime_invisible_annotations, 433 int runtime_invisible_annotations_length, 434 u1* runtime_visible_parameter_annotations, 435 int runtime_visible_parameter_annotations_length, 436 u1* runtime_invisible_parameter_annotations, 437 int runtime_invisible_parameter_annotations_length, 438 u1* runtime_visible_type_annotations, 439 int runtime_visible_type_annotations_length, 440 u1* runtime_invisible_type_annotations, 441 int runtime_invisible_type_annotations_length, 442 u1* annotation_default, 443 int annotation_default_length, 444 TRAPS); 445 446 // lays out fields in class and returns the total oopmap count 447 void layout_fields(Handle class_loader, FieldAllocationCount* fac, 448 ClassAnnotationCollector* parsed_annotations, 449 FieldLayoutInfo* info, TRAPS); 450 451 public: 452 // Constructor 453 ClassFileParser(ClassFileStream* st) { set_stream(st); } 454 ~ClassFileParser(); 455 456 // Parse .class file and return new Klass*. The Klass* is not hooked up 457 // to the system dictionary or any other structures, so a .class file can 458 // be loaded several times if desired. 459 // The system dictionary hookup is done by the caller. 460 // 461 // "parsed_name" is updated by this method, and is the name found 462 // while parsing the stream. 463 instanceKlassHandle parseClassFile(Symbol* name, 464 ClassLoaderData* loader_data, 465 Handle protection_domain, 466 TempNewSymbol& parsed_name, 467 bool verify, 468 TRAPS) { 469 KlassHandle no_host_klass; 470 return parseClassFile(name, loader_data, protection_domain, no_host_klass, NULL, parsed_name, verify, THREAD); 471 } 472 instanceKlassHandle parseClassFile(Symbol* name, 473 ClassLoaderData* loader_data, 474 Handle protection_domain, 475 KlassHandle host_klass, 476 GrowableArray<Handle>* cp_patches, 477 TempNewSymbol& parsed_name, 478 bool verify, 479 TRAPS); 480 481 // Verifier checks 482 static void check_super_class_access(instanceKlassHandle this_klass, TRAPS); 483 static void check_super_interface_access(instanceKlassHandle this_klass, TRAPS); 484 static void check_final_method_override(instanceKlassHandle this_klass, TRAPS); 485 static void check_illegal_static_method(instanceKlassHandle this_klass, TRAPS); 486 }; 487 488 #endif // SHARE_VM_CLASSFILE_CLASSFILEPARSER_HPP