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>

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

mercurial