1 #ifdef USE_PRAGMA_IDENT_HDR
2 #pragma ident "@(#)instanceKlass.hpp 1.201 08/11/24 12:22:50 JVM"
3 #endif
4 /*
5 * Copyright 1997-2007 Sun Microsystems, Inc. All Rights Reserved.
6 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
7 *
8 * This code is free software; you can redistribute it and/or modify it
9 * under the terms of the GNU General Public License version 2 only, as
10 * published by the Free Software Foundation.
11 *
12 * This code is distributed in the hope that it will be useful, but WITHOUT
13 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
14 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
15 * version 2 for more details (a copy is included in the LICENSE file that
16 * accompanied this code).
17 *
18 * You should have received a copy of the GNU General Public License version
19 * 2 along with this work; if not, write to the Free Software Foundation,
20 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
21 *
22 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
23 * CA 95054 USA or visit www.sun.com if you need additional information or
24 * have any questions.
25 *
26 */
27
28 // An instanceKlass is the VM level representation of a Java class.
29 // It contains all information needed for at class at execution runtime.
30
31 // instanceKlass layout:
32 // [header ] klassOop
33 // [klass pointer ] klassOop
34 // [C++ vtbl pointer ] Klass
35 // [subtype cache ] Klass
36 // [instance size ] Klass
37 // [java mirror ] Klass
38 // [super ] Klass
39 // [access_flags ] Klass
40 // [name ] Klass
41 // [first subklass ] Klass
42 // [next sibling ] Klass
43 // [array klasses ]
44 // [methods ]
45 // [local interfaces ]
46 // [transitive interfaces ]
47 // [number of implementors ]
48 // [implementors ] klassOop[2]
49 // [fields ]
50 // [constants ]
51 // [class loader ]
52 // [protection domain ]
53 // [signers ]
54 // [source file name ]
55 // [inner classes ]
56 // [static field size ]
57 // [nonstatic field size ]
58 // [static oop fields size ]
59 // [nonstatic oop maps size ]
60 // [has finalize method ]
61 // [deoptimization mark bit ]
62 // [initialization state ]
63 // [initializing thread ]
64 // [Java vtable length ]
65 // [oop map cache (stack maps) ]
66 // [EMBEDDED Java vtable ] size in words = vtable_len
67 // [EMBEDDED static oop fields ] size in words = static_oop_fields_size
68 // [ static non-oop fields ] size in words = static_field_size - static_oop_fields_size
69 // [EMBEDDED nonstatic oop-map blocks] size in words = nonstatic_oop_map_size
70 //
71 // The embedded nonstatic oop-map blocks are short pairs (offset, length) indicating
72 // where oops are located in instances of this klass.
73
74
75 // forward declaration for class -- see below for definition
76 class SuperTypeClosure;
77 class OopMapBlock;
78 class JNIid;
79 class jniIdMapBase;
80 class BreakpointInfo;
81 class fieldDescriptor;
82 class DepChange;
83 class nmethodBucket;
84 class PreviousVersionNode;
85 class JvmtiCachedClassFieldMap;
86
87 // This is used in iterators below.
88 class FieldClosure: public StackObj {
89 public:
90 virtual void do_field(fieldDescriptor* fd) = 0;
91 };
92
93 #ifndef PRODUCT
94 // Print fields.
95 // If "obj" argument to constructor is NULL, prints static fields, otherwise prints non-static fields.
96 class FieldPrinter: public FieldClosure {
97 oop _obj;
98 outputStream* _st;
99 public:
100 FieldPrinter(outputStream* st, oop obj = NULL) : _obj(obj), _st(st) {}
101 void do_field(fieldDescriptor* fd);
102 };
103 #endif // !PRODUCT
104
105 class instanceKlass: public Klass {
106 friend class VMStructs;
107 public:
108 // See "The Java Virtual Machine Specification" section 2.16.2-5 for a detailed description
109 // of the class loading & initialization procedure, and the use of the states.
110 enum ClassState {
111 unparsable_by_gc = 0, // object is not yet parsable by gc. Value of _init_state at object allocation.
112 allocated, // allocated (but not yet linked)
113 loaded, // loaded and inserted in class hierarchy (but not linked yet)
114 linked, // successfully linked/verified (but not initialized yet)
115 being_initialized, // currently running class initializer
116 fully_initialized, // initialized (successfull final state)
117 initialization_error // error happened during initialization
118 };
119
120 public:
121 oop* oop_block_beg() const { return adr_array_klasses(); }
122 oop* oop_block_end() const { return adr_methods_default_annotations() + 1; }
123
124 enum {
125 implementors_limit = 2 // how many implems can we track?
126 };
127
128 protected:
129 //
130 // The oop block. See comment in klass.hpp before making changes.
131 //
132
133 // Array classes holding elements of this class.
134 klassOop _array_klasses;
135 // Method array.
136 objArrayOop _methods;
137 // Int array containing the original order of method in the class file (for
138 // JVMTI).
139 typeArrayOop _method_ordering;
140 // Interface (klassOops) this class declares locally to implement.
141 objArrayOop _local_interfaces;
142 // Interface (klassOops) this class implements transitively.
143 objArrayOop _transitive_interfaces;
144 // Instance and static variable information, 5-tuples of shorts [access, name
145 // index, sig index, initval index, offset].
146 typeArrayOop _fields;
147 // Constant pool for this class.
148 constantPoolOop _constants;
149 // Class loader used to load this class, NULL if VM loader used.
150 oop _class_loader;
151 // Protection domain.
152 oop _protection_domain;
153 // Class signers.
154 objArrayOop _signers;
155 // Name of source file containing this klass, NULL if not specified.
156 symbolOop _source_file_name;
157 // the source debug extension for this klass, NULL if not specified.
158 symbolOop _source_debug_extension;
159 // inner_classes attribute.
160 typeArrayOop _inner_classes;
161 // Implementors of this interface (not valid if it overflows)
162 klassOop _implementors[implementors_limit];
163 // Generic signature, or null if none.
164 symbolOop _generic_signature;
165 // Annotations for this class, or null if none.
166 typeArrayOop _class_annotations;
167 // Annotation objects (byte arrays) for fields, or null if no annotations.
168 // Indices correspond to entries (not indices) in fields array.
169 objArrayOop _fields_annotations;
170 // Annotation objects (byte arrays) for methods, or null if no annotations.
171 // Index is the idnum, which is initially the same as the methods array index.
172 objArrayOop _methods_annotations;
173 // Annotation objects (byte arrays) for methods' parameters, or null if no
174 // such annotations.
175 // Index is the idnum, which is initially the same as the methods array index.
176 objArrayOop _methods_parameter_annotations;
177 // Annotation objects (byte arrays) for methods' default values, or null if no
178 // such annotations.
179 // Index is the idnum, which is initially the same as the methods array index.
180 objArrayOop _methods_default_annotations;
181
182 //
183 // End of the oop block.
184 //
185
186 int _nonstatic_field_size; // number of non-static fields in this klass (including inherited fields)
187 int _static_field_size; // number of static fields (oop and non-oop) in this klass
188 int _static_oop_field_size;// number of static oop fields in this klass
189 int _nonstatic_oop_map_size;// number of nonstatic oop-map blocks allocated at end of this klass
190 bool _is_marked_dependent; // used for marking during flushing and deoptimization
191 bool _rewritten; // methods rewritten.
192 u2 _minor_version; // minor version number of class file
193 u2 _major_version; // major version number of class file
194 ClassState _init_state; // state of class
195 Thread* _init_thread; // Pointer to current thread doing initialization (to handle recusive initialization)
196 int _vtable_len; // length of Java vtable (in words)
197 int _itable_len; // length of Java itable (in words)
198 ReferenceType _reference_type; // reference type
199 OopMapCache* volatile _oop_map_cache; // OopMapCache for all methods in the klass (allocated lazily)
200 JNIid* _jni_ids; // First JNI identifier for static fields in this class
201 jmethodID* _methods_jmethod_ids; // jmethodIDs corresponding to method_idnum, or NULL if none
202 int* _methods_cached_itable_indices; // itable_index cache for JNI invoke corresponding to methods idnum, or NULL
203 nmethodBucket* _dependencies; // list of dependent nmethods
204 nmethod* _osr_nmethods_head; // Head of list of on-stack replacement nmethods for this class
205 BreakpointInfo* _breakpoints; // bpt lists, managed by methodOop
206 int _nof_implementors; // No of implementors of this interface (zero if not an interface)
207 // Array of interesting part(s) of the previous version(s) of this
208 // instanceKlass. See PreviousVersionWalker below.
209 GrowableArray<PreviousVersionNode *>* _previous_versions;
210 u2 _enclosing_method_class_index; // Constant pool index for class of enclosing method, or 0 if none
211 u2 _enclosing_method_method_index; // Constant pool index for name and type of enclosing method, or 0 if none
212 // JVMTI fields can be moved to their own structure - see 6315920
213 unsigned char * _cached_class_file_bytes; // JVMTI: cached class file, before retransformable agent modified it in CFLH
214 jint _cached_class_file_len; // JVMTI: length of above
215 JvmtiCachedClassFieldMap* _jvmti_cached_class_field_map; // JVMTI: used during heap iteration
216 volatile u2 _idnum_allocated_count; // JNI/JVMTI: increments with the addition of methods, old ids don't change
217
218 // embedded Java vtable follows here
219 // embedded Java itables follows here
220 // embedded static fields follows here
221 // embedded nonstatic oop-map blocks follows here
222
223 friend class instanceKlassKlass;
224 friend class SystemDictionary;
225
226 public:
227 // field sizes
228 int nonstatic_field_size() const { return _nonstatic_field_size; }
229 void set_nonstatic_field_size(int size) { _nonstatic_field_size = size; }
230
231 int static_field_size() const { return _static_field_size; }
232 void set_static_field_size(int size) { _static_field_size = size; }
233
234 int static_oop_field_size() const { return _static_oop_field_size; }
235 void set_static_oop_field_size(int size) { _static_oop_field_size = size; }
236
237 // Java vtable
238 int vtable_length() const { return _vtable_len; }
239 void set_vtable_length(int len) { _vtable_len = len; }
240
241 // Java itable
242 int itable_length() const { return _itable_len; }
243 void set_itable_length(int len) { _itable_len = len; }
244
245 // array klasses
246 klassOop array_klasses() const { return _array_klasses; }
247 void set_array_klasses(klassOop k) { oop_store_without_check((oop*) &_array_klasses, (oop) k); }
248
249 // methods
250 objArrayOop methods() const { return _methods; }
251 void set_methods(objArrayOop a) { oop_store_without_check((oop*) &_methods, (oop) a); }
252 methodOop method_with_idnum(int idnum);
253
254 // method ordering
255 typeArrayOop method_ordering() const { return _method_ordering; }
256 void set_method_ordering(typeArrayOop m) { oop_store_without_check((oop*) &_method_ordering, (oop) m); }
257
258 // interfaces
259 objArrayOop local_interfaces() const { return _local_interfaces; }
260 void set_local_interfaces(objArrayOop a) { oop_store_without_check((oop*) &_local_interfaces, (oop) a); }
261 objArrayOop transitive_interfaces() const { return _transitive_interfaces; }
262 void set_transitive_interfaces(objArrayOop a) { oop_store_without_check((oop*) &_transitive_interfaces, (oop) a); }
263
264 // fields
265 // Field info extracted from the class file and stored
266 // as an array of 7 shorts
267 enum FieldOffset {
268 access_flags_offset = 0,
269 name_index_offset = 1,
270 signature_index_offset = 2,
271 initval_index_offset = 3,
272 low_offset = 4,
273 high_offset = 5,
274 generic_signature_offset = 6,
275 next_offset = 7
276 };
277
278 typeArrayOop fields() const { return _fields; }
279 int offset_from_fields( int index ) const {
280 return build_int_from_shorts( fields()->ushort_at(index + low_offset),
281 fields()->ushort_at(index + high_offset) );
282 }
283
284 void set_fields(typeArrayOop f) { oop_store_without_check((oop*) &_fields, (oop) f); }
285
286 // inner classes
287 typeArrayOop inner_classes() const { return _inner_classes; }
288 void set_inner_classes(typeArrayOop f) { oop_store_without_check((oop*) &_inner_classes, (oop) f); }
289
290 enum InnerClassAttributeOffset {
291 // From http://mirror.eng/products/jdk/1.1/docs/guide/innerclasses/spec/innerclasses.doc10.html#18814
292 inner_class_inner_class_info_offset = 0,
293 inner_class_outer_class_info_offset = 1,
294 inner_class_inner_name_offset = 2,
295 inner_class_access_flags_offset = 3,
296 inner_class_next_offset = 4
297 };
298
299 // package
300 bool is_same_class_package(klassOop class2);
301 bool is_same_class_package(oop classloader2, symbolOop classname2);
302 static bool is_same_class_package(oop class_loader1, symbolOop class_name1, oop class_loader2, symbolOop class_name2);
303
304 // initialization state
305 bool is_loaded() const { return _init_state >= loaded; }
306 bool is_linked() const { return _init_state >= linked; }
307 bool is_initialized() const { return _init_state == fully_initialized; }
308 bool is_not_initialized() const { return _init_state < being_initialized; }
309 bool is_being_initialized() const { return _init_state == being_initialized; }
310 bool is_in_error_state() const { return _init_state == initialization_error; }
311 bool is_reentrant_initialization(Thread *thread) { return thread == _init_thread; }
312 int get_init_state() { return _init_state; } // Useful for debugging
313 bool is_rewritten() const { return _rewritten; }
314
315 // marking
316 bool is_marked_dependent() const { return _is_marked_dependent; }
317 void set_is_marked_dependent(bool value) { _is_marked_dependent = value; }
318
319 // initialization (virtuals from Klass)
320 bool should_be_initialized() const; // means that initialize should be called
321 void initialize(TRAPS);
322 void link_class(TRAPS);
323 bool link_class_or_fail(TRAPS); // returns false on failure
324 void unlink_class();
325 void rewrite_class(TRAPS);
326 methodOop class_initializer();
327
328 // set the class to initialized if no static initializer is present
329 void eager_initialize(Thread *thread);
330
331 // reference type
332 ReferenceType reference_type() const { return _reference_type; }
333 void set_reference_type(ReferenceType t) { _reference_type = t; }
334
335 // find local field, returns true if found
336 bool find_local_field(symbolOop name, symbolOop sig, fieldDescriptor* fd) const;
337 // find field in direct superinterfaces, returns the interface in which the field is defined
338 klassOop find_interface_field(symbolOop name, symbolOop sig, fieldDescriptor* fd) const;
339 // find field according to JVM spec 5.4.3.2, returns the klass in which the field is defined
340 klassOop find_field(symbolOop name, symbolOop sig, fieldDescriptor* fd) const;
341 // find instance or static fields according to JVM spec 5.4.3.2, returns the klass in which the field is defined
342 klassOop find_field(symbolOop name, symbolOop sig, bool is_static, fieldDescriptor* fd) const;
343
344 // find a non-static or static field given its offset within the class.
345 bool contains_field_offset(int offset) {
346 return ((offset/wordSize) >= instanceOopDesc::header_size() &&
347 (offset/wordSize)-instanceOopDesc::header_size() < nonstatic_field_size());
348 }
349
350 bool find_local_field_from_offset(int offset, bool is_static, fieldDescriptor* fd) const;
351 bool find_field_from_offset(int offset, bool is_static, fieldDescriptor* fd) const;
352
353 // find a local method (returns NULL if not found)
354 methodOop find_method(symbolOop name, symbolOop signature) const;
355 static methodOop find_method(objArrayOop methods, symbolOop name, symbolOop signature);
356
357 // lookup operation (returns NULL if not found)
358 methodOop uncached_lookup_method(symbolOop name, symbolOop signature) const;
359
360 // lookup a method in all the interfaces that this class implements
361 // (returns NULL if not found)
362 methodOop lookup_method_in_all_interfaces(symbolOop name, symbolOop signature) const;
363
364 // constant pool
365 constantPoolOop constants() const { return _constants; }
366 void set_constants(constantPoolOop c) { oop_store_without_check((oop*) &_constants, (oop) c); }
367
368 // class loader
369 oop class_loader() const { return _class_loader; }
370 void set_class_loader(oop l) { oop_store((oop*) &_class_loader, l); }
371
372 // protection domain
373 oop protection_domain() { return _protection_domain; }
374 void set_protection_domain(oop pd) { oop_store((oop*) &_protection_domain, pd); }
375
376 // signers
377 objArrayOop signers() const { return _signers; }
378 void set_signers(objArrayOop s) { oop_store((oop*) &_signers, oop(s)); }
379
380 // source file name
381 symbolOop source_file_name() const { return _source_file_name; }
382 void set_source_file_name(symbolOop n) { oop_store_without_check((oop*) &_source_file_name, (oop) n); }
383
384 // minor and major version numbers of class file
385 u2 minor_version() const { return _minor_version; }
386 void set_minor_version(u2 minor_version) { _minor_version = minor_version; }
387 u2 major_version() const { return _major_version; }
388 void set_major_version(u2 major_version) { _major_version = major_version; }
389
390 // source debug extension
391 symbolOop source_debug_extension() const { return _source_debug_extension; }
392 void set_source_debug_extension(symbolOop n){ oop_store_without_check((oop*) &_source_debug_extension, (oop) n); }
393
394 // nonstatic oop-map blocks
395 int nonstatic_oop_map_size() const { return _nonstatic_oop_map_size; }
396 void set_nonstatic_oop_map_size(int size) { _nonstatic_oop_map_size = size; }
397
398 // RedefineClasses() support for previous versions:
399 void add_previous_version(instanceKlassHandle ikh, BitMap *emcp_methods,
400 int emcp_method_count);
401 bool has_previous_version() const;
402 void init_previous_versions() {
403 _previous_versions = NULL;
404 }
405 GrowableArray<PreviousVersionNode *>* previous_versions() const {
406 return _previous_versions;
407 }
408
409 // JVMTI: Support for caching a class file before it is modified by an agent that can do retransformation
410 void set_cached_class_file(unsigned char *class_file_bytes,
411 jint class_file_len) { _cached_class_file_len = class_file_len;
412 _cached_class_file_bytes = class_file_bytes; }
413 jint get_cached_class_file_len() { return _cached_class_file_len; }
414 unsigned char * get_cached_class_file_bytes() { return _cached_class_file_bytes; }
415
416 // JVMTI: Support for caching of field indices, types, and offsets
417 void set_jvmti_cached_class_field_map(JvmtiCachedClassFieldMap* descriptor) {
418 _jvmti_cached_class_field_map = descriptor;
419 }
420 JvmtiCachedClassFieldMap* jvmti_cached_class_field_map() const {
421 return _jvmti_cached_class_field_map;
422 }
423
424 // for adding methods, constMethodOopDesc::UNSET_IDNUM means no more ids available
425 inline u2 next_method_idnum();
426 void set_initial_method_idnum(u2 value) { _idnum_allocated_count = value; }
427
428 // generics support
429 symbolOop generic_signature() const { return _generic_signature; }
430 void set_generic_signature(symbolOop sig) { oop_store_without_check((oop*)&_generic_signature, (oop)sig); }
431 u2 enclosing_method_class_index() const { return _enclosing_method_class_index; }
432 u2 enclosing_method_method_index() const { return _enclosing_method_method_index; }
433 void set_enclosing_method_indices(u2 class_index,
434 u2 method_index) { _enclosing_method_class_index = class_index;
435 _enclosing_method_method_index = method_index; }
436
437 // jmethodID support
438 static jmethodID jmethod_id_for_impl(instanceKlassHandle ik_h, methodHandle method_h);
439 jmethodID jmethod_id_or_null(methodOop method);
440
441 // cached itable index support
442 void set_cached_itable_index(size_t idnum, int index);
443 int cached_itable_index(size_t idnum);
444
445 // annotations support
446 typeArrayOop class_annotations() const { return _class_annotations; }
447 objArrayOop fields_annotations() const { return _fields_annotations; }
448 objArrayOop methods_annotations() const { return _methods_annotations; }
449 objArrayOop methods_parameter_annotations() const { return _methods_parameter_annotations; }
450 objArrayOop methods_default_annotations() const { return _methods_default_annotations; }
451 void set_class_annotations(typeArrayOop md) { oop_store_without_check((oop*)&_class_annotations, (oop)md); }
452 void set_fields_annotations(objArrayOop md) { set_annotations(md, &_fields_annotations); }
453 void set_methods_annotations(objArrayOop md) { set_annotations(md, &_methods_annotations); }
454 void set_methods_parameter_annotations(objArrayOop md) { set_annotations(md, &_methods_parameter_annotations); }
455 void set_methods_default_annotations(objArrayOop md) { set_annotations(md, &_methods_default_annotations); }
456 typeArrayOop get_method_annotations_of(int idnum)
457 { return get_method_annotations_from(idnum, _methods_annotations); }
458 typeArrayOop get_method_parameter_annotations_of(int idnum)
459 { return get_method_annotations_from(idnum, _methods_parameter_annotations); }
460 typeArrayOop get_method_default_annotations_of(int idnum)
461 { return get_method_annotations_from(idnum, _methods_default_annotations); }
462 void set_method_annotations_of(int idnum, typeArrayOop anno)
463 { set_methods_annotations_of(idnum, anno, &_methods_annotations); }
464 void set_method_parameter_annotations_of(int idnum, typeArrayOop anno)
465 { set_methods_annotations_of(idnum, anno, &_methods_annotations); }
466 void set_method_default_annotations_of(int idnum, typeArrayOop anno)
467 { set_methods_annotations_of(idnum, anno, &_methods_annotations); }
468
469 // allocation
470 DEFINE_ALLOCATE_PERMANENT(instanceKlass);
471 instanceOop allocate_instance(TRAPS);
472 instanceOop allocate_permanent_instance(TRAPS);
473
474 // additional member function to return a handle
475 instanceHandle allocate_instance_handle(TRAPS) { return instanceHandle(THREAD, allocate_instance(THREAD)); }
476
477 objArrayOop allocate_objArray(int n, int length, TRAPS);
478 // Helper function
479 static instanceOop register_finalizer(instanceOop i, TRAPS);
480
481 // Check whether reflection/jni/jvm code is allowed to instantiate this class;
482 // if not, throw either an Error or an Exception.
483 virtual void check_valid_for_instantiation(bool throwError, TRAPS);
484
485 // initialization
486 void call_class_initializer(TRAPS);
487 void set_initialization_state_and_notify(ClassState state, TRAPS);
488
489 // OopMapCache support
490 OopMapCache* oop_map_cache() { return _oop_map_cache; }
491 void set_oop_map_cache(OopMapCache *cache) { _oop_map_cache = cache; }
492 void mask_for(methodHandle method, int bci, InterpreterOopMap* entry);
493
494 // JNI identifier support (for static fields - for jni performance)
495 JNIid* jni_ids() { return _jni_ids; }
496 void set_jni_ids(JNIid* ids) { _jni_ids = ids; }
497 JNIid* jni_id_for(int offset);
498
499 // maintenance of deoptimization dependencies
500 int mark_dependent_nmethods(DepChange& changes);
501 void add_dependent_nmethod(nmethod* nm);
502 void remove_dependent_nmethod(nmethod* nm);
503
504 // On-stack replacement support
505 nmethod* osr_nmethods_head() const { return _osr_nmethods_head; };
506 void set_osr_nmethods_head(nmethod* h) { _osr_nmethods_head = h; };
507 void add_osr_nmethod(nmethod* n);
508 void remove_osr_nmethod(nmethod* n);
509 nmethod* lookup_osr_nmethod(const methodOop m, int bci) const;
510
511 // Breakpoint support (see methods on methodOop for details)
512 BreakpointInfo* breakpoints() const { return _breakpoints; };
513 void set_breakpoints(BreakpointInfo* bps) { _breakpoints = bps; };
514
515 // support for stub routines
516 static int init_state_offset_in_bytes() { return offset_of(instanceKlass, _init_state); }
517 static int init_thread_offset_in_bytes() { return offset_of(instanceKlass, _init_thread); }
518
519 // subclass/subinterface checks
520 bool implements_interface(klassOop k) const;
521
522 // Access to implementors of an interface. We only store the count
523 // of implementors, and in case, there are only a few
524 // implementors, we store them in a short list.
525 // This accessor returns NULL if we walk off the end of the list.
526 klassOop implementor(int i) const {
527 return (i < implementors_limit)? _implementors[i]: (klassOop) NULL;
528 }
529 int nof_implementors() const { return _nof_implementors; }
530 void add_implementor(klassOop k); // k is a new class that implements this interface
531 void init_implementor(); // initialize
532
533 // link this class into the implementors list of every interface it implements
534 void process_interfaces(Thread *thread);
535
536 // virtual operations from Klass
537 bool is_leaf_class() const { return _subklass == NULL; }
538 objArrayOop compute_secondary_supers(int num_extra_slots, TRAPS);
539 bool compute_is_subtype_of(klassOop k);
540 bool can_be_primary_super_slow() const;
541 klassOop java_super() const { return super(); }
542 int oop_size(oop obj) const { return size_helper(); }
543 int klass_oop_size() const { return object_size(); }
544 bool oop_is_instance_slow() const { return true; }
545
546 // Iterators
547 void do_local_static_fields(FieldClosure* cl);
548 void do_nonstatic_fields(FieldClosure* cl); // including inherited fields
549 void do_local_static_fields(void f(fieldDescriptor*, TRAPS), TRAPS);
550
551 void methods_do(void f(methodOop method));
552 void array_klasses_do(void f(klassOop k));
553 void with_array_klasses_do(void f(klassOop k));
554 bool super_types_do(SuperTypeClosure* blk);
555
556 // Casting from klassOop
557 static instanceKlass* cast(klassOop k) {
558 Klass* kp = k->klass_part();
559 assert(kp->null_vtbl() || kp->oop_is_instance_slow(), "cast to instanceKlass");
560 return (instanceKlass*) kp;
561 }
562
563 // Sizing (in words)
564 static int header_size() { return align_object_offset(oopDesc::header_size() + sizeof(instanceKlass)/HeapWordSize); }
565 int object_size() const { return object_size(align_object_offset(vtable_length()) + align_object_offset(itable_length()) + static_field_size() + nonstatic_oop_map_size()); }
566 static int vtable_start_offset() { return header_size(); }
567 static int vtable_length_offset() { return oopDesc::header_size() + offset_of(instanceKlass, _vtable_len) / HeapWordSize; }
568 static int object_size(int extra) { return align_object_size(header_size() + extra); }
569
570 intptr_t* start_of_vtable() const { return ((intptr_t*)as_klassOop()) + vtable_start_offset(); }
571 intptr_t* start_of_itable() const { return start_of_vtable() + align_object_offset(vtable_length()); }
572 int itable_offset_in_words() const { return start_of_itable() - (intptr_t*)as_klassOop(); }
573
574 oop* start_of_static_fields() const { return (oop*)(start_of_itable() + align_object_offset(itable_length())); }
575 intptr_t* end_of_itable() const { return start_of_itable() + itable_length(); }
576 oop* end_of_static_fields() const { return start_of_static_fields() + static_field_size(); }
577 int offset_of_static_fields() const { return (intptr_t)start_of_static_fields() - (intptr_t)as_klassOop(); }
578
579 OopMapBlock* start_of_nonstatic_oop_maps() const { return (OopMapBlock*) (start_of_static_fields() + static_field_size()); }
580
581 // Allocation profiling support
582 juint alloc_size() const { return _alloc_count * size_helper(); }
583 void set_alloc_size(juint n) {}
584
585 // Use this to return the size of an instance in heap words:
586 int size_helper() const {
587 return layout_helper_to_size_helper(layout_helper());
588 }
589
590 // This bit is initialized in classFileParser.cpp.
591 // It is false under any of the following conditions:
592 // - the class is abstract (including any interface)
593 // - the class has a finalizer (if !RegisterFinalizersAtInit)
594 // - the class size is larger than FastAllocateSizeLimit
595 // - the class is java/lang/Class, which cannot be allocated directly
596 bool can_be_fastpath_allocated() const {
597 return !layout_helper_needs_slow_path(layout_helper());
598 }
599
600 // Java vtable/itable
601 klassVtable* vtable() const; // return new klassVtable wrapper
602 inline methodOop method_at_vtable(int index);
603 klassItable* itable() const; // return new klassItable wrapper
604 methodOop method_at_itable(klassOop holder, int index, TRAPS);
605
606 // Garbage collection
607 void oop_follow_contents(oop obj);
608 void follow_static_fields();
609 void adjust_static_fields();
610 int oop_adjust_pointers(oop obj);
611 bool object_is_parsable() const { return _init_state != unparsable_by_gc; }
612 // Value of _init_state must be zero (unparsable_by_gc) when klass field is set.
613
614 void follow_weak_klass_links(
615 BoolObjectClosure* is_alive, OopClosure* keep_alive);
616 void release_C_heap_structures();
617
618 // Parallel Scavenge and Parallel Old
619 PARALLEL_GC_DECLS
620
621 #ifndef SERIALGC
622 // Parallel Scavenge
623 void copy_static_fields(PSPromotionManager* pm);
624 void push_static_fields(PSPromotionManager* pm);
625
626 // Parallel Old
627 void follow_static_fields(ParCompactionManager* cm);
628 void copy_static_fields(ParCompactionManager* cm);
629 void update_static_fields();
630 void update_static_fields(HeapWord* beg_addr, HeapWord* end_addr);
631 #endif // SERIALGC
632
633 // Naming
634 char* signature_name() const;
635
636 // Iterators
637 int oop_oop_iterate(oop obj, OopClosure* blk) {
638 return oop_oop_iterate_v(obj, blk);
639 }
640
641 int oop_oop_iterate_m(oop obj, OopClosure* blk, MemRegion mr) {
642 return oop_oop_iterate_v_m(obj, blk, mr);
643 }
644
645 #define InstanceKlass_OOP_OOP_ITERATE_DECL(OopClosureType, nv_suffix) \
646 int oop_oop_iterate##nv_suffix(oop obj, OopClosureType* blk); \
647 int oop_oop_iterate##nv_suffix##_m(oop obj, OopClosureType* blk, \
648 MemRegion mr);
649
650 ALL_OOP_OOP_ITERATE_CLOSURES_1(InstanceKlass_OOP_OOP_ITERATE_DECL)
651 ALL_OOP_OOP_ITERATE_CLOSURES_3(InstanceKlass_OOP_OOP_ITERATE_DECL)
652
653 void iterate_static_fields(OopClosure* closure);
654 void iterate_static_fields(OopClosure* closure, MemRegion mr);
655
656 private:
657 // initialization state
658 #ifdef ASSERT
659 void set_init_state(ClassState state);
660 #else
661 void set_init_state(ClassState state) { _init_state = state; }
662 #endif
663 void set_rewritten() { _rewritten = true; }
664 void set_init_thread(Thread *thread) { _init_thread = thread; }
665
666 u2 idnum_allocated_count() const { return _idnum_allocated_count; }
667 jmethodID* methods_jmethod_ids_acquire() const
668 { return (jmethodID*)OrderAccess::load_ptr_acquire(&_methods_jmethod_ids); }
669 void release_set_methods_jmethod_ids(jmethodID* jmeths)
670 { OrderAccess::release_store_ptr(&_methods_jmethod_ids, jmeths); }
671
672 int* methods_cached_itable_indices_acquire() const
673 { return (int*)OrderAccess::load_ptr_acquire(&_methods_cached_itable_indices); }
674 void release_set_methods_cached_itable_indices(int* indices)
675 { OrderAccess::release_store_ptr(&_methods_cached_itable_indices, indices); }
676
677 inline typeArrayOop get_method_annotations_from(int idnum, objArrayOop annos);
678 void set_annotations(objArrayOop md, objArrayOop* md_p) { oop_store_without_check((oop*)md_p, (oop)md); }
679 void set_methods_annotations_of(int idnum, typeArrayOop anno, objArrayOop* md_p);
680
681 // Offsets for memory management
682 oop* adr_array_klasses() const { return (oop*)&this->_array_klasses;}
683 oop* adr_methods() const { return (oop*)&this->_methods;}
684 oop* adr_method_ordering() const { return (oop*)&this->_method_ordering;}
685 oop* adr_local_interfaces() const { return (oop*)&this->_local_interfaces;}
686 oop* adr_transitive_interfaces() const { return (oop*)&this->_transitive_interfaces;}
687 oop* adr_fields() const { return (oop*)&this->_fields;}
688 oop* adr_constants() const { return (oop*)&this->_constants;}
689 oop* adr_class_loader() const { return (oop*)&this->_class_loader;}
690 oop* adr_protection_domain() const { return (oop*)&this->_protection_domain;}
691 oop* adr_signers() const { return (oop*)&this->_signers;}
692 oop* adr_source_file_name() const { return (oop*)&this->_source_file_name;}
693 oop* adr_source_debug_extension() const { return (oop*)&this->_source_debug_extension;}
694 oop* adr_inner_classes() const { return (oop*)&this->_inner_classes;}
695 oop* adr_implementors() const { return (oop*)&this->_implementors[0];}
696 oop* adr_generic_signature() const { return (oop*)&this->_generic_signature;}
697 oop* adr_methods_jmethod_ids() const { return (oop*)&this->_methods_jmethod_ids;}
698 oop* adr_methods_cached_itable_indices() const { return (oop*)&this->_methods_cached_itable_indices;}
699 oop* adr_class_annotations() const { return (oop*)&this->_class_annotations;}
700 oop* adr_fields_annotations() const { return (oop*)&this->_fields_annotations;}
701 oop* adr_methods_annotations() const { return (oop*)&this->_methods_annotations;}
702 oop* adr_methods_parameter_annotations() const { return (oop*)&this->_methods_parameter_annotations;}
703 oop* adr_methods_default_annotations() const { return (oop*)&this->_methods_default_annotations;}
704
705 // Static methods that are used to implement member methods where an exposed this pointer
706 // is needed due to possible GCs
707 static bool link_class_impl (instanceKlassHandle this_oop, bool throw_verifyerror, TRAPS);
708 static bool verify_code (instanceKlassHandle this_oop, bool throw_verifyerror, TRAPS);
709 static void initialize_impl (instanceKlassHandle this_oop, TRAPS);
710 static void eager_initialize_impl (instanceKlassHandle this_oop);
711 static void set_initialization_state_and_notify_impl (instanceKlassHandle this_oop, ClassState state, TRAPS);
712 static void call_class_initializer_impl (instanceKlassHandle this_oop, TRAPS);
713 static klassOop array_klass_impl (instanceKlassHandle this_oop, bool or_null, int n, TRAPS);
714 static void do_local_static_fields_impl (instanceKlassHandle this_oop, void f(fieldDescriptor* fd, TRAPS), TRAPS);
715 /* jni_id_for_impl for jfieldID only */
716 static JNIid* jni_id_for_impl (instanceKlassHandle this_oop, int offset);
717
718 // Returns the array class for the n'th dimension
719 klassOop array_klass_impl(bool or_null, int n, TRAPS);
720
721 // Returns the array class with this class as element type
722 klassOop array_klass_impl(bool or_null, TRAPS);
723
724 public:
725 // sharing support
726 virtual void remove_unshareable_info();
727 void field_names_and_sigs_iterate(OopClosure* closure);
728
729 // jvm support
730 jint compute_modifier_flags(TRAPS) const;
731
732 public:
733 // JVMTI support
734 jint jvmti_class_status() const;
735
736 #ifndef PRODUCT
737 public:
738 // Printing
739 void oop_print_on (oop obj, outputStream* st);
740 void oop_print_value_on(oop obj, outputStream* st);
741
742 void print_dependent_nmethods(bool verbose = false);
743 bool is_dependent_nmethod(nmethod* nm);
744 #endif
745
746 public:
747 // Verification
748 const char* internal_name() const;
749 void oop_verify_on(oop obj, outputStream* st);
750
751 #ifndef PRODUCT
752 static void verify_class_klass_nonstatic_oop_maps(klassOop k) PRODUCT_RETURN;
753 #endif
754 };
755
756 inline methodOop instanceKlass::method_at_vtable(int index) {
757 #ifndef PRODUCT
758 assert(index >= 0, "valid vtable index");
759 if (DebugVtables) {
760 verify_vtable_index(index);
761 }
762 #endif
763 vtableEntry* ve = (vtableEntry*)start_of_vtable();
764 return ve[index].method();
765 }
766
767 inline typeArrayOop instanceKlass::get_method_annotations_from(int idnum, objArrayOop annos) {
768 if (annos == NULL || annos->length() <= idnum) {
769 return NULL;
770 }
771 return typeArrayOop(annos->obj_at(idnum));
772 }
773
774 // for adding methods
775 // UNSET_IDNUM return means no more ids available
776 inline u2 instanceKlass::next_method_idnum() {
777 if (_idnum_allocated_count == constMethodOopDesc::MAX_IDNUM) {
778 return constMethodOopDesc::UNSET_IDNUM; // no more ids available
779 } else {
780 return _idnum_allocated_count++;
781 }
782 }
783
784
785 // ValueObjs embedded in klass. Describes where oops are located in instances of this klass.
786
787 class OopMapBlock VALUE_OBJ_CLASS_SPEC {
788 private:
789 jushort _offset; // Offset of first oop in oop-map block
790 jushort _length; // Length of oop-map block
791 public:
792 // Accessors
793 jushort offset() const { return _offset; }
794 void set_offset(jushort offset) { _offset = offset; }
795
796 jushort length() const { return _length; }
797 void set_length(jushort length) { _length = length; }
798 };
799
800 /* JNIid class for jfieldIDs only */
801 class JNIid: public CHeapObj {
802 friend class VMStructs;
803 private:
804 klassOop _holder;
805 JNIid* _next;
806 int _offset;
807 #ifdef ASSERT
808 bool _is_static_field_id;
809 #endif
810
811 public:
812 // Accessors
813 klassOop holder() const { return _holder; }
814 int offset() const { return _offset; }
815 JNIid* next() { return _next; }
816 // Constructor
817 JNIid(klassOop holder, int offset, JNIid* next);
818 // Identifier lookup
819 JNIid* find(int offset);
820
821 // Garbage collection support
822 oop* holder_addr() { return (oop*)&_holder; }
823 void oops_do(OopClosure* f);
824 static void deallocate(JNIid* id);
825 // Debugging
826 #ifdef ASSERT
827 bool is_static_field_id() const { return _is_static_field_id; }
828 void set_is_static_field_id() { _is_static_field_id = true; }
829 #endif
830 void verify(klassOop holder);
831 };
832
833
834 // If breakpoints are more numerous than just JVMTI breakpoints,
835 // consider compressing this data structure.
836 // It is currently a simple linked list defined in methodOop.hpp.
837
838 class BreakpointInfo;
839
840
841 // A collection point for interesting information about the previous
842 // version(s) of an instanceKlass. This class uses weak references to
843 // the information so that the information may be collected as needed
844 // by the system. If the information is shared, then a regular
845 // reference must be used because a weak reference would be seen as
846 // collectible. A GrowableArray of PreviousVersionNodes is attached
847 // to the instanceKlass as needed. See PreviousVersionWalker below.
848 class PreviousVersionNode : public CHeapObj {
849 private:
850 // A shared ConstantPool is never collected so we'll always have
851 // a reference to it so we can update items in the cache. We'll
852 // have a weak reference to a non-shared ConstantPool until all
853 // of the methods (EMCP or obsolete) have been collected; the
854 // non-shared ConstantPool becomes collectible at that point.
855 jobject _prev_constant_pool; // regular or weak reference
856 bool _prev_cp_is_weak; // true if not a shared ConstantPool
857
858 // If the previous version of the instanceKlass doesn't have any
859 // EMCP methods, then _prev_EMCP_methods will be NULL. If all the
860 // EMCP methods have been collected, then _prev_EMCP_methods can
861 // have a length of zero.
862 GrowableArray<jweak>* _prev_EMCP_methods;
863
864 public:
865 PreviousVersionNode(jobject prev_constant_pool, bool prev_cp_is_weak,
866 GrowableArray<jweak>* prev_EMCP_methods);
867 ~PreviousVersionNode();
868 jobject prev_constant_pool() const {
869 return _prev_constant_pool;
870 }
871 GrowableArray<jweak>* prev_EMCP_methods() const {
872 return _prev_EMCP_methods;
873 }
874 };
875
876
877 // A Handle-ized version of PreviousVersionNode.
878 class PreviousVersionInfo : public ResourceObj {
879 private:
880 constantPoolHandle _prev_constant_pool_handle;
881 // If the previous version of the instanceKlass doesn't have any
882 // EMCP methods, then _prev_EMCP_methods will be NULL. Since the
883 // methods cannot be collected while we hold a handle,
884 // _prev_EMCP_methods should never have a length of zero.
885 GrowableArray<methodHandle>* _prev_EMCP_method_handles;
886
887 public:
888 PreviousVersionInfo(PreviousVersionNode *pv_node);
889 ~PreviousVersionInfo();
890 constantPoolHandle prev_constant_pool_handle() const {
891 return _prev_constant_pool_handle;
892 }
893 GrowableArray<methodHandle>* prev_EMCP_method_handles() const {
894 return _prev_EMCP_method_handles;
895 }
896 };
897
898
899 // Helper object for walking previous versions. This helper cleans up
900 // the Handles that it allocates when the helper object is destroyed.
901 // The PreviousVersionInfo object returned by next_previous_version()
902 // is only valid until a subsequent call to next_previous_version() or
903 // the helper object is destroyed.
904 class PreviousVersionWalker : public StackObj {
905 private:
906 GrowableArray<PreviousVersionNode *>* _previous_versions;
907 int _current_index;
908 // Fields for cleaning up when we are done walking the previous versions:
909 // A HandleMark for the PreviousVersionInfo handles:
910 HandleMark _hm;
911
912 // It would be nice to have a ResourceMark field in this helper also,
913 // but the ResourceMark code says to be careful to delete handles held
914 // in GrowableArrays _before_ deleting the GrowableArray. Since we
915 // can't guarantee the order in which the fields are destroyed, we
916 // have to let the creator of the PreviousVersionWalker object do
917 // the right thing. Also, adding a ResourceMark here causes an
918 // include loop.
919
920 // A pointer to the current info object so we can handle the deletes.
921 PreviousVersionInfo * _current_p;
922
923 public:
924 PreviousVersionWalker(instanceKlass *ik);
925 ~PreviousVersionWalker();
926
927 // Return the interesting information for the next previous version
928 // of the klass. Returns NULL if there are no more previous versions.
929 PreviousVersionInfo* next_previous_version();
930 };