1 /*
2 * Copyright (c) 1997, 2018, 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_OOPS_KLASS_HPP
26 #define SHARE_VM_OOPS_KLASS_HPP
27
28 #include "gc/shared/specialized_oop_closures.hpp"
29 #include "memory/iterator.hpp"
30 #include "memory/memRegion.hpp"
31 #include "oops/metadata.hpp"
32 #include "oops/oop.hpp"
33 #include "oops/oopHandle.hpp"
34 #include "trace/traceMacros.hpp"
35 #include "utilities/accessFlags.hpp"
36 #include "utilities/macros.hpp"
37
38 //
39 // A Klass provides:
40 // 1: language level class object (method dictionary etc.)
41 // 2: provide vm dispatch behavior for the object
42 // Both functions are combined into one C++ class.
43
44 // One reason for the oop/klass dichotomy in the implementation is
45 // that we don't want a C++ vtbl pointer in every object. Thus,
46 // normal oops don't have any virtual functions. Instead, they
47 // forward all "virtual" functions to their klass, which does have
48 // a vtbl and does the C++ dispatch depending on the object's
49 // actual type. (See oop.inline.hpp for some of the forwarding code.)
50 // ALL FUNCTIONS IMPLEMENTING THIS DISPATCH ARE PREFIXED WITH "oop_"!
51
52 // Forward declarations.
53 template <class T> class Array;
54 template <class T> class GrowableArray;
55 class ClassLoaderData;
56 class fieldDescriptor;
57 class KlassSizeStats;
58 class klassVtable;
59 class ModuleEntry;
60 class PackageEntry;
61 class ParCompactionManager;
62 class PSPromotionManager;
63 class vtableEntry;
64
65 class Klass : public Metadata {
66 friend class VMStructs;
67 friend class JVMCIVMStructs;
68 protected:
69 // If you add a new field that points to any metaspace object, you
70 // must add this field to Klass::metaspace_pointers_do().
71
72 // note: put frequently-used fields together at start of klass structure
73 // for better cache behavior (may not make much of a difference but sure won't hurt)
74 enum { _primary_super_limit = 8 };
75
76 // The "layout helper" is a combined descriptor of object layout.
77 // For klasses which are neither instance nor array, the value is zero.
78 //
79 // For instances, layout helper is a positive number, the instance size.
80 // This size is already passed through align_object_size and scaled to bytes.
81 // The low order bit is set if instances of this class cannot be
82 // allocated using the fastpath.
83 //
84 // For arrays, layout helper is a negative number, containing four
85 // distinct bytes, as follows:
86 // MSB:[tag, hsz, ebt, log2(esz)]:LSB
87 // where:
88 // tag is 0x80 if the elements are oops, 0xC0 if non-oops
89 // hsz is array header size in bytes (i.e., offset of first element)
90 // ebt is the BasicType of the elements
91 // esz is the element size in bytes
92 // This packed word is arranged so as to be quickly unpacked by the
93 // various fast paths that use the various subfields.
94 //
95 // The esz bits can be used directly by a SLL instruction, without masking.
96 //
97 // Note that the array-kind tag looks like 0x00 for instance klasses,
98 // since their length in bytes is always less than 24Mb.
99 //
100 // Final note: This comes first, immediately after C++ vtable,
101 // because it is frequently queried.
102 jint _layout_helper;
103
104 // The fields _super_check_offset, _secondary_super_cache, _secondary_supers
105 // and _primary_supers all help make fast subtype checks. See big discussion
106 // in doc/server_compiler/checktype.txt
107 //
108 // Where to look to observe a supertype (it is &_secondary_super_cache for
109 // secondary supers, else is &_primary_supers[depth()].
110 juint _super_check_offset;
111
112 // Class name. Instance classes: java/lang/String, etc. Array classes: [I,
113 // [Ljava/lang/String;, etc. Set to zero for all other kinds of classes.
114 Symbol* _name;
115
116 // Cache of last observed secondary supertype
117 Klass* _secondary_super_cache;
118 // Array of all secondary supertypes
119 Array<Klass*>* _secondary_supers;
120 // Ordered list of all primary supertypes
121 Klass* _primary_supers[_primary_super_limit];
122 // java/lang/Class instance mirroring this class
123 OopHandle _java_mirror;
124 // Superclass
125 Klass* _super;
126 // First subclass (NULL if none); _subklass->next_sibling() is next one
127 Klass* _subklass;
128 // Sibling link (or NULL); links all subklasses of a klass
129 Klass* _next_sibling;
130
131 // All klasses loaded by a class loader are chained through these links
132 Klass* _next_link;
133
134 // The VM's representation of the ClassLoader used to load this class.
135 // Provide access the corresponding instance java.lang.ClassLoader.
136 ClassLoaderData* _class_loader_data;
137
138 jint _modifier_flags; // Processed access flags, for use by Class.getModifiers.
139 AccessFlags _access_flags; // Access flags. The class/interface distinction is stored here.
140
141 TRACE_DEFINE_TRACE_ID_FIELD;
142
143 // Biased locking implementation and statistics
144 // (the 64-bit chunk goes first, to avoid some fragmentation)
145 jlong _last_biased_lock_bulk_revocation_time;
146 markOop _prototype_header; // Used when biased locking is both enabled and disabled for this type
147 jint _biased_lock_revocation_count;
148
149 // vtable length
150 int _vtable_len;
151
152 private:
153 // This is an index into FileMapHeader::_classpath_entry_table[], to
154 // associate this class with the JAR file where it's loaded from during
155 // dump time. If a class is not loaded from the shared archive, this field is
156 // -1.
157 jshort _shared_class_path_index;
158
159 friend class SharedClassUtil;
160 protected:
161
162 // Constructor
163 Klass();
164
165 void* operator new(size_t size, ClassLoaderData* loader_data, size_t word_size, TRAPS) throw();
166
167 public:
168 enum DefaultsLookupMode { find_defaults, skip_defaults };
169 enum OverpassLookupMode { find_overpass, skip_overpass };
170 enum StaticLookupMode { find_static, skip_static };
171 enum PrivateLookupMode { find_private, skip_private };
172
173 bool is_klass() const volatile { return true; }
174
175 // super
176 Klass* super() const { return _super; }
177 void set_super(Klass* k) { _super = k; }
178
179 // initializes _super link, _primary_supers & _secondary_supers arrays
180 void initialize_supers(Klass* k, TRAPS);
181 void initialize_supers_impl1(Klass* k);
182 void initialize_supers_impl2(Klass* k);
183
184 // klass-specific helper for initializing _secondary_supers
185 virtual GrowableArray<Klass*>* compute_secondary_supers(int num_extra_slots);
186
187 // java_super is the Java-level super type as specified by Class.getSuperClass.
188 virtual Klass* java_super() const { return NULL; }
189
190 juint super_check_offset() const { return _super_check_offset; }
191 void set_super_check_offset(juint o) { _super_check_offset = o; }
192
193 Klass* secondary_super_cache() const { return _secondary_super_cache; }
194 void set_secondary_super_cache(Klass* k) { _secondary_super_cache = k; }
195
196 Array<Klass*>* secondary_supers() const { return _secondary_supers; }
197 void set_secondary_supers(Array<Klass*>* k) { _secondary_supers = k; }
198
199 // Return the element of the _super chain of the given depth.
200 // If there is no such element, return either NULL or this.
201 Klass* primary_super_of_depth(juint i) const {
202 assert(i < primary_super_limit(), "oob");
203 Klass* super = _primary_supers[i];
204 assert(super == NULL || super->super_depth() == i, "correct display");
205 return super;
206 }
207
208 // Can this klass be a primary super? False for interfaces and arrays of
209 // interfaces. False also for arrays or classes with long super chains.
210 bool can_be_primary_super() const {
211 const juint secondary_offset = in_bytes(secondary_super_cache_offset());
212 return super_check_offset() != secondary_offset;
213 }
214 virtual bool can_be_primary_super_slow() const;
215
216 // Returns number of primary supers; may be a number in the inclusive range [0, primary_super_limit].
217 juint super_depth() const {
218 if (!can_be_primary_super()) {
219 return primary_super_limit();
220 } else {
221 juint d = (super_check_offset() - in_bytes(primary_supers_offset())) / sizeof(Klass*);
222 assert(d < primary_super_limit(), "oob");
223 assert(_primary_supers[d] == this, "proper init");
224 return d;
225 }
226 }
227
228 // java mirror
229 oop java_mirror() const;
230 void set_java_mirror(Handle m);
231
232 // Temporary mirror switch used by RedefineClasses
233 // Both mirrors are on the ClassLoaderData::_handles list already so no
234 // barriers are needed.
235 void set_java_mirror_handle(OopHandle mirror) { _java_mirror = mirror; }
236 OopHandle java_mirror_handle() const { return _java_mirror; }
237
238 // modifier flags
239 jint modifier_flags() const { return _modifier_flags; }
240 void set_modifier_flags(jint flags) { _modifier_flags = flags; }
241
242 // size helper
243 int layout_helper() const { return _layout_helper; }
244 void set_layout_helper(int lh) { _layout_helper = lh; }
245
246 // Note: for instances layout_helper() may include padding.
247 // Use InstanceKlass::contains_field_offset to classify field offsets.
248
249 // sub/superklass links
250 Klass* subklass() const { return _subklass; }
251 Klass* next_sibling() const { return _next_sibling; }
252 InstanceKlass* superklass() const;
253 void append_to_sibling_list(); // add newly created receiver to superklass' subklass list
254
255 void set_next_link(Klass* k) { _next_link = k; }
256 Klass* next_link() const { return _next_link; } // The next klass defined by the class loader.
257
258 // class loader data
259 ClassLoaderData* class_loader_data() const { return _class_loader_data; }
260 void set_class_loader_data(ClassLoaderData* loader_data) { _class_loader_data = loader_data; }
261
262 int shared_classpath_index() const {
263 return _shared_class_path_index;
264 };
265
266 void set_shared_classpath_index(int index) {
267 _shared_class_path_index = index;
268 };
269
270 // Obtain the module or package for this class
271 virtual ModuleEntry* module() const = 0;
272 virtual PackageEntry* package() const = 0;
273
274 protected: // internal accessors
275 void set_subklass(Klass* s);
276 void set_next_sibling(Klass* s);
277
278 public:
279
280 // Compiler support
281 static ByteSize super_offset() { return in_ByteSize(offset_of(Klass, _super)); }
282 static ByteSize super_check_offset_offset() { return in_ByteSize(offset_of(Klass, _super_check_offset)); }
283 static ByteSize primary_supers_offset() { return in_ByteSize(offset_of(Klass, _primary_supers)); }
284 static ByteSize secondary_super_cache_offset() { return in_ByteSize(offset_of(Klass, _secondary_super_cache)); }
285 static ByteSize secondary_supers_offset() { return in_ByteSize(offset_of(Klass, _secondary_supers)); }
286 static ByteSize java_mirror_offset() { return in_ByteSize(offset_of(Klass, _java_mirror)); }
287 static ByteSize modifier_flags_offset() { return in_ByteSize(offset_of(Klass, _modifier_flags)); }
288 static ByteSize layout_helper_offset() { return in_ByteSize(offset_of(Klass, _layout_helper)); }
289 static ByteSize access_flags_offset() { return in_ByteSize(offset_of(Klass, _access_flags)); }
290
291 // Unpacking layout_helper:
292 enum {
293 _lh_neutral_value = 0, // neutral non-array non-instance value
294 _lh_instance_slow_path_bit = 0x01,
295 _lh_log2_element_size_shift = BitsPerByte*0,
296 _lh_log2_element_size_mask = BitsPerLong-1,
297 _lh_element_type_shift = BitsPerByte*1,
298 _lh_element_type_mask = right_n_bits(BitsPerByte), // shifted mask
299 _lh_header_size_shift = BitsPerByte*2,
300 _lh_header_size_mask = right_n_bits(BitsPerByte), // shifted mask
301 _lh_array_tag_bits = 2,
302 _lh_array_tag_shift = BitsPerInt - _lh_array_tag_bits,
303 _lh_array_tag_obj_value = ~0x01 // 0x80000000 >> 30
304 };
305
306 static const unsigned int _lh_array_tag_type_value = 0Xffffffff; // ~0x00, // 0xC0000000 >> 30
307
308 static int layout_helper_size_in_bytes(jint lh) {
309 assert(lh > (jint)_lh_neutral_value, "must be instance");
310 return (int) lh & ~_lh_instance_slow_path_bit;
311 }
312 static bool layout_helper_needs_slow_path(jint lh) {
313 assert(lh > (jint)_lh_neutral_value, "must be instance");
314 return (lh & _lh_instance_slow_path_bit) != 0;
315 }
316 static bool layout_helper_is_instance(jint lh) {
317 return (jint)lh > (jint)_lh_neutral_value;
318 }
319 static bool layout_helper_is_array(jint lh) {
320 return (jint)lh < (jint)_lh_neutral_value;
321 }
322 static bool layout_helper_is_typeArray(jint lh) {
323 // _lh_array_tag_type_value == (lh >> _lh_array_tag_shift);
324 return (juint)lh >= (juint)(_lh_array_tag_type_value << _lh_array_tag_shift);
325 }
326 static bool layout_helper_is_objArray(jint lh) {
327 // _lh_array_tag_obj_value == (lh >> _lh_array_tag_shift);
328 return (jint)lh < (jint)(_lh_array_tag_type_value << _lh_array_tag_shift);
329 }
330 static int layout_helper_header_size(jint lh) {
331 assert(lh < (jint)_lh_neutral_value, "must be array");
332 int hsize = (lh >> _lh_header_size_shift) & _lh_header_size_mask;
333 assert(hsize > 0 && hsize < (int)sizeof(oopDesc)*3, "sanity");
334 return hsize;
335 }
336 static BasicType layout_helper_element_type(jint lh) {
337 assert(lh < (jint)_lh_neutral_value, "must be array");
338 int btvalue = (lh >> _lh_element_type_shift) & _lh_element_type_mask;
339 assert(btvalue >= T_BOOLEAN && btvalue <= T_OBJECT, "sanity");
340 return (BasicType) btvalue;
341 }
342
343 // Want a pattern to quickly diff against layout header in register
344 // find something less clever!
345 static int layout_helper_boolean_diffbit() {
346 jint zlh = array_layout_helper(T_BOOLEAN);
347 jint blh = array_layout_helper(T_BYTE);
348 assert(zlh != blh, "array layout helpers must differ");
349 int diffbit = 1;
350 while ((diffbit & (zlh ^ blh)) == 0 && (diffbit & zlh) == 0) {
351 diffbit <<= 1;
352 assert(diffbit != 0, "make sure T_BOOLEAN has a different bit than T_BYTE");
353 }
354 return diffbit;
355 }
356
357 static int layout_helper_log2_element_size(jint lh) {
358 assert(lh < (jint)_lh_neutral_value, "must be array");
359 int l2esz = (lh >> _lh_log2_element_size_shift) & _lh_log2_element_size_mask;
360 assert(l2esz <= LogBytesPerLong,
361 "sanity. l2esz: 0x%x for lh: 0x%x", (uint)l2esz, (uint)lh);
362 return l2esz;
363 }
364 static jint array_layout_helper(jint tag, int hsize, BasicType etype, int log2_esize) {
365 return (tag << _lh_array_tag_shift)
366 | (hsize << _lh_header_size_shift)
367 | ((int)etype << _lh_element_type_shift)
368 | (log2_esize << _lh_log2_element_size_shift);
369 }
370 static jint instance_layout_helper(jint size, bool slow_path_flag) {
371 return (size << LogBytesPerWord)
372 | (slow_path_flag ? _lh_instance_slow_path_bit : 0);
373 }
374 static int layout_helper_to_size_helper(jint lh) {
375 assert(lh > (jint)_lh_neutral_value, "must be instance");
376 // Note that the following expression discards _lh_instance_slow_path_bit.
377 return lh >> LogBytesPerWord;
378 }
379 // Out-of-line version computes everything based on the etype:
380 static jint array_layout_helper(BasicType etype);
381
382 // What is the maximum number of primary superclasses any klass can have?
383 #ifdef PRODUCT
384 static juint primary_super_limit() { return _primary_super_limit; }
385 #else
386 static juint primary_super_limit() {
387 assert(FastSuperclassLimit <= _primary_super_limit, "parameter oob");
388 return FastSuperclassLimit;
389 }
390 #endif
391
392 // vtables
393 klassVtable vtable() const;
394 int vtable_length() const { return _vtable_len; }
395
396 // subclass check
397 bool is_subclass_of(const Klass* k) const;
398 // subtype check: true if is_subclass_of, or if k is interface and receiver implements it
399 bool is_subtype_of(Klass* k) const {
400 juint off = k->super_check_offset();
401 Klass* sup = *(Klass**)( (address)this + off );
402 const juint secondary_offset = in_bytes(secondary_super_cache_offset());
403 if (sup == k) {
404 return true;
405 } else if (off != secondary_offset) {
406 return false;
407 } else {
408 return search_secondary_supers(k);
409 }
410 }
411
412 // Is an oop/narrowOop null or subtype of this Klass?
413 template <typename T>
414 bool is_instanceof_or_null(T element);
415
416 bool search_secondary_supers(Klass* k) const;
417
418 // Find LCA in class hierarchy
419 Klass *LCA( Klass *k );
420
421 // Check whether reflection/jni/jvm code is allowed to instantiate this class;
422 // if not, throw either an Error or an Exception.
423 virtual void check_valid_for_instantiation(bool throwError, TRAPS);
424
425 // array copying
426 virtual void copy_array(arrayOop s, int src_pos, arrayOop d, int dst_pos, int length, TRAPS);
427
428 // tells if the class should be initialized
429 virtual bool should_be_initialized() const { return false; }
430 // initializes the klass
431 virtual void initialize(TRAPS);
432 // lookup operation for MethodLookupCache
433 friend class MethodLookupCache;
434 virtual Klass* find_field(Symbol* name, Symbol* signature, fieldDescriptor* fd) const;
435 virtual Method* uncached_lookup_method(const Symbol* name, const Symbol* signature, OverpassLookupMode overpass_mode) const;
436 public:
437 Method* lookup_method(const Symbol* name, const Symbol* signature) const {
438 return uncached_lookup_method(name, signature, find_overpass);
439 }
440
441 // array class with specific rank
442 Klass* array_klass(int rank, TRAPS) { return array_klass_impl(false, rank, THREAD); }
443
444 // array class with this klass as element type
445 Klass* array_klass(TRAPS) { return array_klass_impl(false, THREAD); }
446
447 // These will return NULL instead of allocating on the heap:
448 // NB: these can block for a mutex, like other functions with TRAPS arg.
449 Klass* array_klass_or_null(int rank);
450 Klass* array_klass_or_null();
451
452 virtual oop protection_domain() const = 0;
453
454 oop class_loader() const;
455
456 virtual oop klass_holder() const { return class_loader(); }
457
458 protected:
459 virtual Klass* array_klass_impl(bool or_null, int rank, TRAPS);
460 virtual Klass* array_klass_impl(bool or_null, TRAPS);
461
462 void set_vtable_length(int len) { _vtable_len= len; }
463
464 vtableEntry* start_of_vtable() const;
465 public:
466 Method* method_at_vtable(int index);
467
468 static ByteSize vtable_start_offset();
469 static ByteSize vtable_length_offset() {
470 return byte_offset_of(Klass, _vtable_len);
471 }
472
473 // CDS support - remove and restore oops from metadata. Oops are not shared.
474 virtual void remove_unshareable_info();
475 virtual void remove_java_mirror();
476 virtual void restore_unshareable_info(ClassLoaderData* loader_data, Handle protection_domain, TRAPS);
477
478 protected:
479 // computes the subtype relationship
480 virtual bool compute_is_subtype_of(Klass* k);
481 public:
482 // subclass accessor (here for convenience; undefined for non-klass objects)
483 virtual bool is_leaf_class() const { fatal("not a class"); return false; }
484 public:
485 // ALL FUNCTIONS BELOW THIS POINT ARE DISPATCHED FROM AN OOP
486 // These functions describe behavior for the oop not the KLASS.
487
488 // actual oop size of obj in memory
489 virtual int oop_size(oop obj) const = 0;
490
491 // Size of klass in word size.
492 virtual int size() const = 0;
493 #if INCLUDE_SERVICES
494 virtual void collect_statistics(KlassSizeStats *sz) const;
495 #endif
496
497 // Returns the Java name for a class (Resource allocated)
498 // For arrays, this returns the name of the element with a leading '['.
499 // For classes, this returns the name with the package separators
500 // turned into '.'s.
501 const char* external_name() const;
502 // Returns the name for a class (Resource allocated) as the class
503 // would appear in a signature.
504 // For arrays, this returns the name of the element with a leading '['.
505 // For classes, this returns the name with a leading 'L' and a trailing ';'
506 // and the package separators as '/'.
507 virtual const char* signature_name() const;
508
509 // type testing operations
510 #ifdef ASSERT
511 protected:
512 virtual bool is_instance_klass_slow() const { return false; }
513 virtual bool is_array_klass_slow() const { return false; }
514 virtual bool is_objArray_klass_slow() const { return false; }
515 virtual bool is_typeArray_klass_slow() const { return false; }
516 #endif // ASSERT
517 public:
518
519 // Fast non-virtual versions
520 #ifndef ASSERT
521 #define assert_same_query(xval, xcheck) xval
522 #else
523 private:
524 static bool assert_same_query(bool xval, bool xslow) {
525 assert(xval == xslow, "slow and fast queries agree");
526 return xval;
527 }
528 public:
529 #endif
530 inline bool is_instance_klass() const { return assert_same_query(
531 layout_helper_is_instance(layout_helper()),
532 is_instance_klass_slow()); }
533 inline bool is_array_klass() const { return assert_same_query(
534 layout_helper_is_array(layout_helper()),
535 is_array_klass_slow()); }
536 inline bool is_objArray_klass() const { return assert_same_query(
537 layout_helper_is_objArray(layout_helper()),
538 is_objArray_klass_slow()); }
539 inline bool is_typeArray_klass() const { return assert_same_query(
540 layout_helper_is_typeArray(layout_helper()),
541 is_typeArray_klass_slow()); }
542 #undef assert_same_query
543
544 // Access flags
545 AccessFlags access_flags() const { return _access_flags; }
546 void set_access_flags(AccessFlags flags) { _access_flags = flags; }
547
548 bool is_public() const { return _access_flags.is_public(); }
549 bool is_final() const { return _access_flags.is_final(); }
550 bool is_interface() const { return _access_flags.is_interface(); }
551 bool is_abstract() const { return _access_flags.is_abstract(); }
552 bool is_super() const { return _access_flags.is_super(); }
553 bool is_synthetic() const { return _access_flags.is_synthetic(); }
554 void set_is_synthetic() { _access_flags.set_is_synthetic(); }
555 bool has_finalizer() const { return _access_flags.has_finalizer(); }
556 bool has_final_method() const { return _access_flags.has_final_method(); }
557 void set_has_finalizer() { _access_flags.set_has_finalizer(); }
558 void set_has_final_method() { _access_flags.set_has_final_method(); }
559 bool has_vanilla_constructor() const { return _access_flags.has_vanilla_constructor(); }
560 void set_has_vanilla_constructor() { _access_flags.set_has_vanilla_constructor(); }
561 bool has_miranda_methods () const { return access_flags().has_miranda_methods(); }
562 void set_has_miranda_methods() { _access_flags.set_has_miranda_methods(); }
563 bool is_shared() const { return access_flags().is_shared_class(); } // shadows MetaspaceObj::is_shared)()
564 void set_is_shared() { _access_flags.set_is_shared_class(); }
565
566 bool is_cloneable() const;
567 void set_is_cloneable();
568
569 // Biased locking support
570 // Note: the prototype header is always set up to be at least the
571 // prototype markOop. If biased locking is enabled it may further be
572 // biasable and have an epoch.
573 markOop prototype_header() const { return _prototype_header; }
574 // NOTE: once instances of this klass are floating around in the
575 // system, this header must only be updated at a safepoint.
576 // NOTE 2: currently we only ever set the prototype header to the
577 // biasable prototype for instanceKlasses. There is no technical
578 // reason why it could not be done for arrayKlasses aside from
579 // wanting to reduce the initial scope of this optimization. There
580 // are potential problems in setting the bias pattern for
581 // JVM-internal oops.
582 inline void set_prototype_header(markOop header);
583 static ByteSize prototype_header_offset() { return in_ByteSize(offset_of(Klass, _prototype_header)); }
584
585 int biased_lock_revocation_count() const { return (int) _biased_lock_revocation_count; }
586 // Atomically increments biased_lock_revocation_count and returns updated value
587 int atomic_incr_biased_lock_revocation_count();
588 void set_biased_lock_revocation_count(int val) { _biased_lock_revocation_count = (jint) val; }
589 jlong last_biased_lock_bulk_revocation_time() { return _last_biased_lock_bulk_revocation_time; }
590 void set_last_biased_lock_bulk_revocation_time(jlong cur_time) { _last_biased_lock_bulk_revocation_time = cur_time; }
591
592 TRACE_DEFINE_TRACE_ID_METHODS;
593
594 virtual void metaspace_pointers_do(MetaspaceClosure* iter);
595 virtual MetaspaceObj::Type type() const { return ClassType; }
596
597 // Iff the class loader (or mirror for anonymous classes) is alive the
598 // Klass is considered alive.
599 // The is_alive closure passed in depends on the Garbage Collector used.
600 bool is_loader_alive(BoolObjectClosure* is_alive);
601
602 static void clean_weak_klass_links(BoolObjectClosure* is_alive, bool clean_alive_klasses = true);
603 static void clean_subklass_tree(BoolObjectClosure* is_alive) {
604 clean_weak_klass_links(is_alive, false /* clean_alive_klasses */);
605 }
606
607 // GC specific object visitors
608 //
609 #if INCLUDE_ALL_GCS
610 // Parallel Scavenge
611 virtual void oop_ps_push_contents( oop obj, PSPromotionManager* pm) = 0;
612 // Parallel Compact
613 virtual void oop_pc_follow_contents(oop obj, ParCompactionManager* cm) = 0;
614 virtual void oop_pc_update_pointers(oop obj, ParCompactionManager* cm) = 0;
615 #endif
616
617 // Iterators specialized to particular subtypes
618 // of ExtendedOopClosure, to avoid closure virtual calls.
619 #define Klass_OOP_OOP_ITERATE_DECL(OopClosureType, nv_suffix) \
620 virtual void oop_oop_iterate##nv_suffix(oop obj, OopClosureType* closure) = 0; \
621 /* Iterates "closure" over all the oops in "obj" (of type "this") within "mr". */ \
622 virtual void oop_oop_iterate_bounded##nv_suffix(oop obj, OopClosureType* closure, MemRegion mr) = 0;
623
624 ALL_OOP_OOP_ITERATE_CLOSURES_1(Klass_OOP_OOP_ITERATE_DECL)
625 ALL_OOP_OOP_ITERATE_CLOSURES_2(Klass_OOP_OOP_ITERATE_DECL)
626
627 #if INCLUDE_ALL_GCS
628 #define Klass_OOP_OOP_ITERATE_DECL_BACKWARDS(OopClosureType, nv_suffix) \
629 virtual void oop_oop_iterate_backwards##nv_suffix(oop obj, OopClosureType* closure) = 0;
630
631 ALL_OOP_OOP_ITERATE_CLOSURES_1(Klass_OOP_OOP_ITERATE_DECL_BACKWARDS)
632 ALL_OOP_OOP_ITERATE_CLOSURES_2(Klass_OOP_OOP_ITERATE_DECL_BACKWARDS)
633 #endif // INCLUDE_ALL_GCS
634
635 virtual void array_klasses_do(void f(Klass* k)) {}
636
637 // Return self, except for abstract classes with exactly 1
638 // implementor. Then return the 1 concrete implementation.
639 Klass *up_cast_abstract();
640
641 // klass name
642 Symbol* name() const { return _name; }
643 void set_name(Symbol* n);
644
645 public:
646 // jvm support
647 virtual jint compute_modifier_flags(TRAPS) const;
648
649 // JVMTI support
650 virtual jint jvmti_class_status() const;
651
652 static void ensure_klass_alive(oop o);
653
654 // Printing
655 virtual void print_on(outputStream* st) const;
656
657 virtual void oop_print_value_on(oop obj, outputStream* st);
658 virtual void oop_print_on (oop obj, outputStream* st);
659
660 virtual const char* internal_name() const = 0;
661
662 // Verification
663 virtual void verify_on(outputStream* st);
664 void verify() { verify_on(tty); }
665
666 #ifndef PRODUCT
667 bool verify_vtable_index(int index);
668 bool verify_itable_index(int index);
669 #endif
670
671 virtual void oop_verify_on(oop obj, outputStream* st);
672
673 static bool is_null(narrowKlass obj);
674 static bool is_null(Klass* obj);
675
676 // klass encoding for klass pointer in objects.
677 static narrowKlass encode_klass_not_null(Klass* v);
678 static narrowKlass encode_klass(Klass* v);
679
680 static Klass* decode_klass_not_null(narrowKlass v);
681 static Klass* decode_klass(narrowKlass v);
682 };
683
684 // Helper to convert the oop iterate macro suffixes into bool values that can be used by template functions.
685 #define nvs_nv_to_bool true
686 #define nvs_v_to_bool false
687 #define nvs_to_bool(nv_suffix) nvs##nv_suffix##_to_bool
688
689 // Oop iteration macros for declarations.
690 // Used to generate declarations in the *Klass header files.
691
692 #define OOP_OOP_ITERATE_DECL(OopClosureType, nv_suffix) \
693 void oop_oop_iterate##nv_suffix(oop obj, OopClosureType* closure); \
694 void oop_oop_iterate_bounded##nv_suffix(oop obj, OopClosureType* closure, MemRegion mr);
695
696 #if INCLUDE_ALL_GCS
697 #define OOP_OOP_ITERATE_DECL_BACKWARDS(OopClosureType, nv_suffix) \
698 void oop_oop_iterate_backwards##nv_suffix(oop obj, OopClosureType* closure);
699 #endif // INCLUDE_ALL_GCS
700
701
702 // Oop iteration macros for definitions.
703 // Used to generate definitions in the *Klass.inline.hpp files.
704
705 #define OOP_OOP_ITERATE_DEFN(KlassType, OopClosureType, nv_suffix) \
706 void KlassType::oop_oop_iterate##nv_suffix(oop obj, OopClosureType* closure) { \
707 oop_oop_iterate<nvs_to_bool(nv_suffix)>(obj, closure); \
708 }
709
710 #if INCLUDE_ALL_GCS
711 #define OOP_OOP_ITERATE_DEFN_BACKWARDS(KlassType, OopClosureType, nv_suffix) \
712 void KlassType::oop_oop_iterate_backwards##nv_suffix(oop obj, OopClosureType* closure) { \
713 oop_oop_iterate_reverse<nvs_to_bool(nv_suffix)>(obj, closure); \
714 }
715 #else
716 #define OOP_OOP_ITERATE_DEFN_BACKWARDS(KlassType, OopClosureType, nv_suffix)
717 #endif
718
719 #define OOP_OOP_ITERATE_DEFN_BOUNDED(KlassType, OopClosureType, nv_suffix) \
720 void KlassType::oop_oop_iterate_bounded##nv_suffix(oop obj, OopClosureType* closure, MemRegion mr) { \
721 oop_oop_iterate_bounded<nvs_to_bool(nv_suffix)>(obj, closure, mr); \
722 }
723
724 #endif // SHARE_VM_OOPS_KLASS_HPP