/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* under the terms of the GNU General Public License version 2 only, as
* published by the Free Software Foundation.
*
* This code is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* version 2 for more details (a copy is included in the LICENSE file that
* accompanied this code).
*
* You should have received a copy of the GNU General Public License version
* 2 along with this work; if not, write to the Free Software Foundation,
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
*
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
* or visit www.oracle.com if you need additional information or have any
* questions.
*
*/
#ifndef SHARE_VM_OOPS_KLASS_HPP
#define SHARE_VM_OOPS_KLASS_HPP
#include "memory/genOopClosures.hpp"
#include "memory/iterator.hpp"
#include "memory/memRegion.hpp"
#include "memory/specialized_oop_closures.hpp"
#include "oops/klassOop.hpp"
#include "oops/klassPS.hpp"
#include "runtime/orderAccess.hpp"
#include "trace/traceMacros.hpp"
#include "utilities/accessFlags.hpp"
#ifndef SERIALGC
#include "gc_implementation/g1/g1OopClosures.hpp"
#include "gc_implementation/parNew/parOopClosures.hpp"
#endif
// A Klass is the part of the klassOop that provides:
// 1: language level class object (method dictionary etc.)
// 2: provide vm dispatch behavior for the object
// Both functions are combined into one C++ class. The toplevel class "Klass"
// implements purpose 1 whereas all subclasses provide extra virtual functions
// for purpose 2.
// that we don't want a C++ vtbl pointer in every object. Thus,
// normal oops don't have any virtual functions. Instead, they
// forward all "virtual" functions to their klass, which does have
// a vtbl and does the C++ dispatch depending on the object's
// actual type. (See oop.inline.hpp for some of the forwarding code.)
// ALL FUNCTIONS IMPLEMENTING THIS DISPATCH ARE PREFIXED WITH "oop_"!
// Klass layout:
// [header ] klassOop
// [klass pointer ] klassOop
// [C++ vtbl ptr ] (contained in Klass_vtbl)
// [layout_helper ]
// [super_check_offset ] for fast subtype checks
// [secondary_super_cache] for fast subtype checks
// [secondary_supers ] array of 2ndary supertypes
// [primary_supers 0]
// [primary_supers 1]
// [primary_supers 2]
// ...
// [primary_supers 7]
// [java_mirror ]
// [super ]
// [name ]
// [first subklass]
// [next_sibling ] link to chain additional subklasses
// [modifier_flags]
// [access_flags ]
// [verify_count ] - not in product
// [alloc_count ]
// [last_biased_lock_bulk_revocation_time] (64 bits)
// [prototype_header]
// [biased_lock_revocation_count]
// [trace_id]
// Forward declarations.
class klassVtable;
class KlassHandle;
class OrderAccess;
// Holder (or cage) for the C++ vtable of each kind of Klass.
// We want to tightly constrain the location of the C++ vtable in the overall layout.
class Klass_vtbl {
protected:
// The following virtual exists only to force creation of a C++ vtable,
// so that this class truly is the location of the vtable of all Klasses.
virtual void unused_initial_virtual() { }
public:
// The following virtual makes Klass_vtbl play a second role as a
// factory protocol for subclasses of Klass ("sub-Klasses").
// Here's how it works....
//
// This VM uses metaobjects as factories for their instances.
//
// In order to initialize the C++ vtable of a new instance, its
// metaobject is forced to use the C++ placed new operator to
// allocate the instance. In a typical C++-based system, each
// sub-class would have its own factory routine which
// directly uses the placed new operator on the desired class,
// and then calls the appropriate chain of C++ constructors.
//
// However, this system uses shared code to performs the first
// allocation and initialization steps for all sub-Klasses.
// (See base_create_klass() and base_create_array_klass().)
// This does not factor neatly into a hierarchy of C++ constructors.
// Each caller of these shared "base_create" routines knows
// exactly which sub-Klass it is creating, but the shared routine
// does not, even though it must perform the actual allocation.
//
// Therefore, the caller of the shared "base_create" must wrap
// the specific placed new call in a virtual function which
// performs the actual allocation and vtable set-up. That
// virtual function is here, Klass_vtbl::allocate_permanent.
//
// The arguments to Universe::allocate_permanent() are passed
// straight through the placed new operator, which in turn
// obtains them directly from this virtual call.
//
// This virtual is called on a temporary "example instance" of the
// sub-Klass being instantiated, a C++ auto variable. The "real"
// instance created by this virtual is on the VM heap, where it is
// equipped with a klassOopDesc header.
//
// It is merely an accident of implementation that we use "example
// instances", but that is why the virtual function which implements
// each sub-Klass factory happens to be defined by the same sub-Klass
// for which it creates instances.
//
// The vtbl_value() call (see below) is used to strip away the
// accidental Klass-ness from an "example instance" and present it as
// a factory. Think of each factory object as a mere container of the
// C++ vtable for the desired sub-Klass. Since C++ does not allow
// direct references to vtables, the factory must also be delegated
// the task of allocating the instance, but the essential point is
// that the factory knows how to initialize the C++ vtable with the
// right pointer value. All other common initializations are handled
// by the shared "base_create" subroutines.
//
// Every subclass on which vtbl_value is called must include this macro.
// Delay the installation of the klassKlass pointer until after the
// the vtable for a new klass has been installed (after the call to new()).
if (HAS_PENDING_EXCEPTION) return NULL; \
OrderAccess::storestore(); \
return result; \
}
protected:
};
friend class VMStructs;
protected:
// note: put frequently-used fields together at start of klass structure
// for better cache behavior (may not make much of a difference but sure won't hurt)
// The "layout helper" is a combined descriptor of object layout.
// For klasses which are neither instance nor array, the value is zero.
//
// For instances, layout helper is a positive number, the instance size.
// This size is already passed through align_object_size and scaled to bytes.
// The low order bit is set if instances of this class cannot be
// allocated using the fastpath.
//
// For arrays, layout helper is a negative number, containing four
// distinct bytes, as follows:
// MSB:[tag, hsz, ebt, log2(esz)]:LSB
// where:
// tag is 0x80 if the elements are oops, 0xC0 if non-oops
// hsz is array header size in bytes (i.e., offset of first element)
// ebt is the BasicType of the elements
// esz is the element size in bytes
// This packed word is arranged so as to be quickly unpacked by the
// various fast paths that use the various subfields.
//
// The esz bits can be used directly by a SLL instruction, without masking.
//
// Note that the array-kind tag looks like 0x00 for instance klasses,
// since their length in bytes is always less than 24Mb.
//
// Final note: This comes first, immediately after Klass_vtbl,
// because it is frequently queried.
// The fields _super_check_offset, _secondary_super_cache, _secondary_supers
// and _primary_supers all help make fast subtype checks. See big discussion
// in doc/server_compiler/checktype.txt
//
// Where to look to observe a supertype (it is &_secondary_super_cache for
// secondary supers, else is &_primary_supers[depth()].
public:
protected:
//
// The oop block. All oop fields must be declared here and only oop fields
// may be declared here. In addition, the first and last fields in this block
// are updated. Grouping the oop fields in a single block simplifies oop
// iteration.
//
// Cache of last observed secondary supertype
// Array of all secondary supertypes
// Ordered list of all primary supertypes
// Superclass
// First subclass (NULL if none); _subklass->next_sibling() is next one
// Sibling link (or NULL); links all subklasses of a klass
//
// End of the oop block.
//
#ifndef PRODUCT
#endif
// Biased locking implementation and statistics
// (the 64-bit chunk goes first, to avoid some fragmentation)
public:
// returns the enclosing klassOop
// see klassOop.hpp for layout.
return (klassOop) (((char*) this) - sizeof(klassOopDesc));
}
public:
// Allocation
// super
// initializes _super link, _primary_supers & _secondary_supers arrays
void initialize_supers_impl1(klassOop k);
void initialize_supers_impl2(klassOop k);
// klass-specific helper for initializing _secondary_supers
// java_super is the Java-level super type as specified by Class.getSuperClass.
void set_secondary_super_cache(klassOop k) { oop_store_without_check((oop*) &_secondary_super_cache, (oop) k); }
void set_secondary_supers(objArrayOop k) { oop_store_without_check((oop*) &_secondary_supers, (oop) k); }
// Return the element of the _super chain of the given depth.
// If there is no such element, return either NULL or this.
return super;
}
// Can this klass be a primary super? False for interfaces and arrays of
// interfaces. False also for arrays or classes with long super chains.
bool can_be_primary_super() const {
return super_check_offset() != secondary_offset;
}
virtual bool can_be_primary_super_slow() const;
// Returns number of primary supers; may be a number in the inclusive range [0, primary_super_limit].
if (!can_be_primary_super()) {
return primary_super_limit();
} else {
return d;
}
}
// java mirror
// modifier flags
// size helper
int layout_helper() const { return _layout_helper; }
// Note: for instances layout_helper() may include padding.
// Use instanceKlass::contains_field_offset to classify field offsets.
// sub/superklass links
instanceKlass* superklass() const;
Klass* next_sibling() const;
void append_to_sibling_list(); // add newly created receiver to superklass' subklass list
void remove_from_sibling_list(); // remove receiver from sibling list
protected: // internal accessors
void set_subklass(klassOop s);
void set_next_sibling(klassOop s);
public:
// Allocation profiling support
virtual juint alloc_size() const = 0;
virtual void set_alloc_size(juint n) = 0;
// Compiler support
static ByteSize super_offset() { return in_ByteSize(sizeof(klassOopDesc) + offset_of(Klass, _super)); }
static ByteSize super_check_offset_offset() { return in_ByteSize(sizeof(klassOopDesc) + offset_of(Klass, _super_check_offset)); }
static ByteSize primary_supers_offset() { return in_ByteSize(sizeof(klassOopDesc) + offset_of(Klass, _primary_supers)); }
static ByteSize secondary_super_cache_offset() { return in_ByteSize(sizeof(klassOopDesc) + offset_of(Klass, _secondary_super_cache)); }
static ByteSize secondary_supers_offset() { return in_ByteSize(sizeof(klassOopDesc) + offset_of(Klass, _secondary_supers)); }
static ByteSize java_mirror_offset() { return in_ByteSize(sizeof(klassOopDesc) + offset_of(Klass, _java_mirror)); }
static ByteSize modifier_flags_offset() { return in_ByteSize(sizeof(klassOopDesc) + offset_of(Klass, _modifier_flags)); }
static ByteSize layout_helper_offset() { return in_ByteSize(sizeof(klassOopDesc) + offset_of(Klass, _layout_helper)); }
static ByteSize access_flags_offset() { return in_ByteSize(sizeof(klassOopDesc) + offset_of(Klass, _access_flags)); }
// Unpacking layout_helper:
enum {
_lh_neutral_value = 0, // neutral non-array non-instance value
_lh_instance_slow_path_bit = 0x01,
_lh_array_tag_bits = 2,
};
return (int) lh & ~_lh_instance_slow_path_bit;
}
return (lh & _lh_instance_slow_path_bit) != 0;
}
}
}
// _lh_array_tag_type_value == (lh >> _lh_array_tag_shift);
}
// _lh_array_tag_obj_value == (lh >> _lh_array_tag_shift);
}
return hsize;
}
}
return l2esz;
}
return (tag << _lh_array_tag_shift)
| (hsize << _lh_header_size_shift)
| ((int)etype << _lh_element_type_shift)
}
return (size << LogHeapWordSize)
| (slow_path_flag ? _lh_instance_slow_path_bit : 0);
}
// Note that the following expression discards _lh_instance_slow_path_bit.
return lh >> LogHeapWordSize;
}
// Out-of-line version computes everything based on the etype:
// What is the maximum number of primary superclasses any klass can have?
#ifdef PRODUCT
#else
return FastSuperclassLimit;
}
#endif
// vtables
static int klass_size_in_bytes() { return offset_of(Klass, _alloc_count) + sizeof(juint); } // all "visible" fields
// subclass check
bool is_subclass_of(klassOop k) const;
// subtype check: true if is_subclass_of, or if k is interface and receiver implements it
if (sup == k) {
return true;
} else if (off != secondary_offset) {
return false;
} else {
return search_secondary_supers(k);
}
}
bool search_secondary_supers(klassOop k) const;
// Find LCA in class hierarchy
// Check whether reflection/jni/jvm code is allowed to instantiate this class;
// if not, throw either an Error or an Exception.
// Casting
return k->klass_part();
}
// array copying
// tells if the class should be initialized
virtual bool should_be_initialized() const { return false; }
// initializes the klass
virtual void initialize(TRAPS);
// lookup operation for MethodLookupCache
friend class MethodLookupCache;
public:
}
// array class with specific rank
// array class with this klass as element type
// These will return NULL instead of allocating on the heap:
// NB: these can block for a mutex, like other functions with TRAPS arg.
protected:
public:
virtual void remove_unshareable_info();
protected:
// computes the subtype relationship
virtual bool compute_is_subtype_of(klassOop k);
public:
// subclass accessor (here for convenience; undefined for non-klass objects)
public:
// ALL FUNCTIONS BELOW THIS POINT ARE DISPATCHED FROM AN OOP
// These functions describe behavior for the oop not the KLASS.
// actual oop size of obj in memory
// actual oop size of this klass in memory
virtual int klass_oop_size() const = 0;
// Returns the Java name for a class (Resource allocated)
// For arrays, this returns the name of the element with a leading '['.
// For classes, this returns the name with the package separators
// turned into '.'s.
const char* external_name() const;
// Returns the name for a class (Resource allocated) as the class
// would appear in a signature.
// For arrays, this returns the name of the element with a leading '['.
// For classes, this returns the name with a leading 'L' and a trailing ';'
// and the package separators as '/'.
virtual const char* signature_name() const;
// garbage collection support
// Parallel Scavenge and Parallel Old
public:
// type testing operations
virtual bool oop_is_instance_slow() const { return false; }
virtual bool oop_is_instanceMirror() const { return false; }
virtual bool oop_is_instanceRef() const { return false; }
virtual bool oop_is_array() const { return false; }
virtual bool oop_is_objArray_slow() const { return false; }
virtual bool oop_is_klass() const { return false; }
virtual bool oop_is_thread() const { return false; }
virtual bool oop_is_method() const { return false; }
virtual bool oop_is_constMethod() const { return false; }
virtual bool oop_is_methodData() const { return false; }
virtual bool oop_is_constantPool() const { return false; }
virtual bool oop_is_constantPoolCache() const { return false; }
virtual bool oop_is_typeArray_slow() const { return false; }
virtual bool oop_is_arrayKlass() const { return false; }
virtual bool oop_is_objArrayKlass() const { return false; }
virtual bool oop_is_typeArrayKlass() const { return false; }
virtual bool oop_is_compiledICHolder() const { return false; }
virtual bool oop_is_instanceKlass() const { return false; }
bool oop_is_javaArray_slow() const {
return oop_is_objArray_slow() || oop_is_typeArray_slow();
}
// Fast non-virtual versions, used by oop.inline.hpp and elsewhere:
#ifndef ASSERT
#else
private:
return xval;
}
public:
#endif
oop_is_instance_slow()); }
oop_is_javaArray_slow()); }
oop_is_objArray_slow()); }
oop_is_typeArray_slow()); }
// Unless overridden, oop is parsable if it has a klass pointer.
// Parsability of an object is object specific.
// Unless overridden, oop is safe for concurrent GC processing
// after its allocation is complete. The exception to
// this is the case where objects are changed after allocation.
// Class redefinition is one of the known exceptions. During
// class redefinition, an allocated class can changed in order
// order to create a merged class (the combiniation of the
// old class definition that has to be perserved and the new class
// definition which is being created.
// Access flags
// Biased locking support
// Note: the prototype header is always set up to be at least the
// prototype markOop. If biased locking is enabled it may further be
// biasable and have an epoch.
// NOTE: once instances of this klass are floating around in the
// system, this header must only be updated at a safepoint.
// NOTE 2: currently we only ever set the prototype header to the
// biasable prototype for instanceKlasses. There is no technical
// reason why it could not be done for arrayKlasses aside from
// wanting to reduce the initial scope of this optimization. There
// are potential problems in setting the bias pattern for
// JVM-internal oops.
static ByteSize prototype_header_offset() { return in_ByteSize(sizeof(klassOopDesc) + offset_of(Klass, _prototype_header)); }
// Atomically increments biased_lock_revocation_count and returns updated value
void set_last_biased_lock_bulk_revocation_time(jlong cur_time) { _last_biased_lock_bulk_revocation_time = cur_time; }
// garbage collection support
virtual void follow_weak_klass_links(
// Prefetch within oop iterators. This is a macro because we
// can't guarantee that the compiler will inline it. In 64-bit
// it generally doesn't. Signature is
//
// static void prefetch_beyond(oop* const start,
// oop* const end,
// const intx foffset,
// const Prefetch::style pstyle);
switch (pstyle_) { \
break; \
break; \
default: \
ShouldNotReachHere(); \
break; \
} \
} \
} \
}
// iterators
}
#ifndef SERIALGC
// In case we don't have a specialized backward scanner use forward
// iteration.
}
#endif // !SERIALGC
// Iterates "blk" over all the oops in "obj" (of type "this") within "mr".
// (I don't see why the _m should be required, but without it the Solaris
// C++ gives warning messages about overridings of the "oop_oop_iterate"
// defined above "hiding" this virtual function. (DLD, 6/20/00)) */
}
// Versions of the above iterators specialized to particular subtypes
// of OopClosure, to avoid closure virtual calls.
/* Default implementation reverts to general version. */ \
} \
\
/* Iterates "blk" over all the oops in "obj" (of type "this") within "mr". \
(I don't see why the _m should be required, but without it the Solaris \
C++ gives warning messages about overridings of the "oop_oop_iterate" \
defined above "hiding" this virtual function. (DLD, 6/20/00)) */ \
OopClosureType* blk, \
}
#ifndef SERIALGC
OopClosureType* blk) { \
/* Default implementation reverts to general version. */ \
}
#endif // !SERIALGC
virtual void with_array_klasses_do(void f(klassOop k));
// Return self, except for abstract classes with exactly 1
// implementor. Then return the 1 concrete implementation.
// klass name
friend class klassKlass;
public:
// jvm support
// JVMTI support
virtual jint jvmti_class_status() const;
// Printing
// Verification
virtual const char* internal_name() const = 0;
// tells whether obj is partially constructed (gc during class loading)
#ifndef PRODUCT
void verify_vtable_index(int index);
#endif
};
#endif // SHARE_VM_OOPS_KLASS_HPP