duke@435: /* stefank@2534: * Copyright (c) 1998, 2011, Oracle and/or its affiliates. All rights reserved. duke@435: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. duke@435: * duke@435: * This code is free software; you can redistribute it and/or modify it duke@435: * under the terms of the GNU General Public License version 2 only, as duke@435: * published by the Free Software Foundation. duke@435: * duke@435: * This code is distributed in the hope that it will be useful, but WITHOUT duke@435: * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or duke@435: * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License duke@435: * version 2 for more details (a copy is included in the LICENSE file that duke@435: * accompanied this code). duke@435: * duke@435: * You should have received a copy of the GNU General Public License version duke@435: * 2 along with this work; if not, write to the Free Software Foundation, duke@435: * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. duke@435: * trims@1907: * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA trims@1907: * or visit www.oracle.com if you need additional information or have any trims@1907: * questions. duke@435: * duke@435: */ duke@435: stefank@2314: #ifndef SHARE_VM_OOPS_CPCACHEOOP_HPP stefank@2314: #define SHARE_VM_OOPS_CPCACHEOOP_HPP stefank@2314: stefank@2314: #include "interpreter/bytecodes.hpp" stefank@2314: #include "memory/allocation.hpp" stefank@2314: #include "oops/arrayOop.hpp" stefank@2314: #include "utilities/array.hpp" stefank@2314: duke@435: // A ConstantPoolCacheEntry describes an individual entry of the constant duke@435: // pool cache. There's 2 principal kinds of entries: field entries for in- duke@435: // stance & static field access, and method entries for invokes. Some of duke@435: // the entry layout is shared and looks as follows: duke@435: // duke@435: // bit number |31 0| duke@435: // bit length |-8--|-8--|---16----| duke@435: // -------------------------------- duke@435: // _indices [ b2 | b1 | index ] duke@435: // _f1 [ entry specific ] duke@435: // _f2 [ entry specific ] duke@435: // _flags [t|f|vf|v|m|h|unused|field_index] (for field entries) duke@435: // bit length |4|1|1 |1|1|0|---7--|----16-----] duke@435: // _flags [t|f|vf|v|m|h|unused|eidx|psze] (for method entries) duke@435: // bit length |4|1|1 |1|1|1|---7--|-8--|-8--] duke@435: duke@435: // -------------------------------- duke@435: // duke@435: // with: duke@435: // index = original constant pool index duke@435: // b1 = bytecode 1 duke@435: // b2 = bytecode 2 duke@435: // psze = parameters size (method entries only) duke@435: // eidx = interpreter entry index (method entries only) duke@435: // field_index = index into field information in holder instanceKlass duke@435: // The index max is 0xffff (max number of fields in constant pool) duke@435: // and is multiplied by (instanceKlass::next_offset) when accessing. duke@435: // t = TosState (see below) duke@435: // f = field is marked final (see below) duke@435: // vf = virtual, final (method entries only : is_vfinal()) duke@435: // v = field is volatile (see below) duke@435: // m = invokeinterface used for method in class Object (see below) duke@435: // h = RedefineClasses/Hotswap bit (see below) duke@435: // duke@435: // The flags after TosState have the following interpretation: duke@435: // bit 27: f flag true if field is marked final duke@435: // bit 26: vf flag true if virtual final method duke@435: // bit 25: v flag true if field is volatile (only for fields) duke@435: // bit 24: m flag true if invokeinterface used for method in class Object duke@435: // bit 23: 0 for fields, 1 for methods duke@435: // duke@435: // The flags 31, 30, 29, 28 together build a 4 bit number 0 to 8 with the duke@435: // following mapping to the TosState states: duke@435: // duke@435: // btos: 0 duke@435: // ctos: 1 duke@435: // stos: 2 duke@435: // itos: 3 duke@435: // ltos: 4 duke@435: // ftos: 5 duke@435: // dtos: 6 duke@435: // atos: 7 duke@435: // vtos: 8 duke@435: // duke@435: // Entry specific: field entries: duke@435: // _indices = get (b1 section) and put (b2 section) bytecodes, original constant pool index duke@435: // _f1 = field holder duke@435: // _f2 = field offset in words duke@435: // _flags = field type information, original field index in field holder duke@435: // (field_index section) duke@435: // duke@435: // Entry specific: method entries: duke@435: // _indices = invoke code for f1 (b1 section), invoke code for f2 (b2 section), duke@435: // original constant pool index duke@435: // _f1 = method for all but virtual calls, unused by virtual calls duke@435: // (note: for interface calls, which are essentially virtual, duke@435: // contains klassOop for the corresponding interface. jrose@1161: // for invokedynamic, f1 contains the CallSite object for the invocation duke@435: // _f2 = method/vtable index for virtual calls only, unused by all other duke@435: // calls. The vf flag indicates this is a method pointer not an duke@435: // index. duke@435: // _flags = field type info (f section), duke@435: // virtual final entry (vf), duke@435: // interpreter entry index (eidx section), duke@435: // parameter size (psze section) duke@435: // duke@435: // Note: invokevirtual & invokespecial bytecodes can share the same constant duke@435: // pool entry and thus the same constant pool cache entry. All invoke duke@435: // bytecodes but invokevirtual use only _f1 and the corresponding b1 duke@435: // bytecode, while invokevirtual uses only _f2 and the corresponding duke@435: // b2 bytecode. The value of _flags is shared for both types of entries. duke@435: // duke@435: // The fields are volatile so that they are stored in the order written in the duke@435: // source code. The _indices field with the bytecode must be written last. duke@435: duke@435: class ConstantPoolCacheEntry VALUE_OBJ_CLASS_SPEC { duke@435: friend class VMStructs; jrose@1161: friend class constantPoolCacheKlass; jrose@1957: friend class constantPoolOopDesc; //resolve_constant_at_impl => set_f1 jrose@1161: duke@435: private: duke@435: volatile intx _indices; // constant pool index & rewrite bytecodes duke@435: volatile oop _f1; // entry specific oop field duke@435: volatile intx _f2; // entry specific int/oop field duke@435: volatile intx _flags; // flags duke@435: duke@435: duke@435: #ifdef ASSERT duke@435: bool same_methodOop(oop cur_f1, oop f1); duke@435: #endif duke@435: duke@435: void set_bytecode_1(Bytecodes::Code code); duke@435: void set_bytecode_2(Bytecodes::Code code); duke@435: void set_f1(oop f1) { duke@435: oop existing_f1 = _f1; // read once duke@435: assert(existing_f1 == NULL || existing_f1 == f1, "illegal field change"); duke@435: oop_store(&_f1, f1); duke@435: } twisti@2258: void set_f1_if_null_atomic(oop f1); duke@435: void set_f2(intx f2) { assert(_f2 == 0 || _f2 == f2, "illegal field change"); _f2 = f2; } duke@435: int as_flags(TosState state, bool is_final, bool is_vfinal, bool is_volatile, duke@435: bool is_method_interface, bool is_method); duke@435: void set_flags(intx flags) { _flags = flags; } duke@435: duke@435: public: duke@435: // specific bit values in flag field duke@435: // Note: the interpreter knows this layout! duke@435: enum FlagBitValues { duke@435: hotSwapBit = 23, duke@435: methodInterface = 24, duke@435: volatileField = 25, duke@435: vfinalMethod = 26, duke@435: finalField = 27 duke@435: }; duke@435: duke@435: enum { field_index_mask = 0xFFFF }; duke@435: duke@435: // start of type bits in flags duke@435: // Note: the interpreter knows this layout! duke@435: enum FlagValues { duke@435: tosBits = 28 duke@435: }; duke@435: duke@435: // Initialization jrose@1494: void initialize_entry(int original_index); // initialize primary entry jrose@1494: void initialize_secondary_entry(int main_index); // initialize secondary entry duke@435: duke@435: void set_field( // sets entry to resolved field state duke@435: Bytecodes::Code get_code, // the bytecode used for reading the field duke@435: Bytecodes::Code put_code, // the bytecode used for writing the field duke@435: KlassHandle field_holder, // the object/klass holding the field duke@435: int orig_field_index, // the original field index in the field holder duke@435: int field_offset, // the field offset in words in the field holder duke@435: TosState field_type, // the (machine) field type duke@435: bool is_final, // the field is final duke@435: bool is_volatile // the field is volatile duke@435: ); duke@435: duke@435: void set_method( // sets entry to resolved method entry duke@435: Bytecodes::Code invoke_code, // the bytecode used for invoking the method duke@435: methodHandle method, // the method/prototype if any (NULL, otherwise) duke@435: int vtable_index // the vtable index if any, else negative duke@435: ); duke@435: duke@435: void set_interface_call( duke@435: methodHandle method, // Resolved method duke@435: int index // Method index into interface duke@435: ); duke@435: jrose@1161: void set_dynamic_call( jrose@1161: Handle call_site, // Resolved java.dyn.CallSite (f1) jrose@1862: methodHandle signature_invoker // determines signature information jrose@1161: ); jrose@1161: jrose@2015: // For JVM_CONSTANT_InvokeDynamic cache entries: jrose@2015: void initialize_bootstrap_method_index_in_cache(int bsm_cache_index); jrose@2015: int bootstrap_method_index_in_cache(); jrose@2015: duke@435: void set_parameter_size(int value) { duke@435: assert(parameter_size() == 0 || parameter_size() == value, duke@435: "size must not change"); duke@435: // Setting the parameter size by itself is only safe if the duke@435: // current value of _flags is 0, otherwise another thread may have duke@435: // updated it and we don't want to overwrite that value. Don't duke@435: // bother trying to update it once it's nonzero but always make duke@435: // sure that the final parameter size agrees with what was passed. duke@435: if (_flags == 0) { duke@435: Atomic::cmpxchg_ptr((value & 0xFF), &_flags, 0); duke@435: } duke@435: guarantee(parameter_size() == value, "size must not change"); duke@435: } duke@435: duke@435: // Which bytecode number (1 or 2) in the index field is valid for this bytecode? duke@435: // Returns -1 if neither is valid. duke@435: static int bytecode_number(Bytecodes::Code code) { duke@435: switch (code) { duke@435: case Bytecodes::_getstatic : // fall through duke@435: case Bytecodes::_getfield : // fall through duke@435: case Bytecodes::_invokespecial : // fall through duke@435: case Bytecodes::_invokestatic : // fall through jrose@2017: case Bytecodes::_invokedynamic : // fall through duke@435: case Bytecodes::_invokeinterface : return 1; duke@435: case Bytecodes::_putstatic : // fall through duke@435: case Bytecodes::_putfield : // fall through duke@435: case Bytecodes::_invokevirtual : return 2; duke@435: default : break; duke@435: } duke@435: return -1; duke@435: } duke@435: duke@435: // Has this bytecode been resolved? Only valid for invokes and get/put field/static. duke@435: bool is_resolved(Bytecodes::Code code) const { duke@435: switch (bytecode_number(code)) { duke@435: case 1: return (bytecode_1() == code); duke@435: case 2: return (bytecode_2() == code); duke@435: } duke@435: return false; // default: not resolved duke@435: } duke@435: duke@435: // Accessors jrose@1161: bool is_secondary_entry() const { return (_indices & 0xFFFF) == 0; } jrose@1161: int constant_pool_index() const { assert((_indices & 0xFFFF) != 0, "must be main entry"); jrose@1161: return (_indices & 0xFFFF); } jrose@1161: int main_entry_index() const { assert((_indices & 0xFFFF) == 0, "must be secondary entry"); jrose@1161: return ((uintx)_indices >> 16); } duke@435: Bytecodes::Code bytecode_1() const { return Bytecodes::cast((_indices >> 16) & 0xFF); } duke@435: Bytecodes::Code bytecode_2() const { return Bytecodes::cast((_indices >> 24) & 0xFF); } duke@435: volatile oop f1() const { return _f1; } jrose@2015: bool is_f1_null() const { return (oop)_f1 == NULL; } // classifies a CPC entry as unbound duke@435: intx f2() const { return _f2; } duke@435: int field_index() const; duke@435: int parameter_size() const { return _flags & 0xFF; } duke@435: bool is_vfinal() const { return ((_flags & (1 << vfinalMethod)) == (1 << vfinalMethod)); } duke@435: bool is_volatile() const { return ((_flags & (1 << volatileField)) == (1 << volatileField)); } duke@435: bool is_methodInterface() const { return ((_flags & (1 << methodInterface)) == (1 << methodInterface)); } duke@435: bool is_byte() const { return (((uintx) _flags >> tosBits) == btos); } duke@435: bool is_char() const { return (((uintx) _flags >> tosBits) == ctos); } duke@435: bool is_short() const { return (((uintx) _flags >> tosBits) == stos); } duke@435: bool is_int() const { return (((uintx) _flags >> tosBits) == itos); } duke@435: bool is_long() const { return (((uintx) _flags >> tosBits) == ltos); } duke@435: bool is_float() const { return (((uintx) _flags >> tosBits) == ftos); } duke@435: bool is_double() const { return (((uintx) _flags >> tosBits) == dtos); } duke@435: bool is_object() const { return (((uintx) _flags >> tosBits) == atos); } duke@435: TosState flag_state() const { assert( ( (_flags >> tosBits) & 0x0F ) < number_of_states, "Invalid state in as_flags"); duke@435: return (TosState)((_flags >> tosBits) & 0x0F); } duke@435: duke@435: // Code generation support duke@435: static WordSize size() { return in_WordSize(sizeof(ConstantPoolCacheEntry) / HeapWordSize); } jrose@1494: static ByteSize size_in_bytes() { return in_ByteSize(sizeof(ConstantPoolCacheEntry)); } duke@435: static ByteSize indices_offset() { return byte_offset_of(ConstantPoolCacheEntry, _indices); } duke@435: static ByteSize f1_offset() { return byte_offset_of(ConstantPoolCacheEntry, _f1); } duke@435: static ByteSize f2_offset() { return byte_offset_of(ConstantPoolCacheEntry, _f2); } duke@435: static ByteSize flags_offset() { return byte_offset_of(ConstantPoolCacheEntry, _flags); } duke@435: duke@435: // GC Support duke@435: void oops_do(void f(oop*)); duke@435: void oop_iterate(OopClosure* blk); duke@435: void oop_iterate_m(OopClosure* blk, MemRegion mr); duke@435: void follow_contents(); duke@435: void adjust_pointers(); duke@435: duke@435: #ifndef SERIALGC duke@435: // Parallel Old duke@435: void follow_contents(ParCompactionManager* cm); duke@435: #endif // SERIALGC duke@435: duke@435: void update_pointers(); duke@435: duke@435: // RedefineClasses() API support: duke@435: // If this constantPoolCacheEntry refers to old_method then update it duke@435: // to refer to new_method. duke@435: // trace_name_printed is set to true if the current call has duke@435: // printed the klass name so that other routines in the adjust_* duke@435: // group don't print the klass name. duke@435: bool adjust_method_entry(methodOop old_method, methodOop new_method, duke@435: bool * trace_name_printed); duke@435: bool is_interesting_method_entry(klassOop k); duke@435: bool is_field_entry() const { return (_flags & (1 << hotSwapBit)) == 0; } duke@435: bool is_method_entry() const { return (_flags & (1 << hotSwapBit)) != 0; } duke@435: duke@435: // Debugging & Printing duke@435: void print (outputStream* st, int index) const; duke@435: void verify(outputStream* st) const; duke@435: duke@435: static void verify_tosBits() { duke@435: assert(tosBits == 28, "interpreter now assumes tosBits is 28"); duke@435: } duke@435: }; duke@435: duke@435: duke@435: // A constant pool cache is a runtime data structure set aside to a constant pool. The cache duke@435: // holds interpreter runtime information for all field access and invoke bytecodes. The cache duke@435: // is created and initialized before a class is actively used (i.e., initialized), the indivi- duke@435: // dual cache entries are filled at resolution (i.e., "link") time (see also: rewriter.*). duke@435: coleenp@548: class constantPoolCacheOopDesc: public oopDesc { duke@435: friend class VMStructs; duke@435: private: coleenp@548: int _length; duke@435: constantPoolOop _constant_pool; // the corresponding constant pool duke@435: duke@435: // Sizing coleenp@548: debug_only(friend class ClassVerifier;) jrose@2268: public: coleenp@548: int length() const { return _length; } jrose@2268: private: coleenp@548: void set_length(int length) { _length = length; } coleenp@548: duke@435: static int header_size() { return sizeof(constantPoolCacheOopDesc) / HeapWordSize; } duke@435: static int object_size(int length) { return align_object_size(header_size() + length * in_words(ConstantPoolCacheEntry::size())); } duke@435: int object_size() { return object_size(length()); } duke@435: duke@435: // Helpers duke@435: constantPoolOop* constant_pool_addr() { return &_constant_pool; } duke@435: ConstantPoolCacheEntry* base() const { return (ConstantPoolCacheEntry*)((address)this + in_bytes(base_offset())); } duke@435: duke@435: friend class constantPoolCacheKlass; jrose@1494: friend class ConstantPoolCacheEntry; duke@435: duke@435: public: duke@435: // Initialization duke@435: void initialize(intArray& inverse_index_map); duke@435: jrose@1161: // Secondary indexes. jrose@1161: // They must look completely different from normal indexes. jrose@1161: // The main reason is that byte swapping is sometimes done on normal indexes. jrose@1494: // Also, some of the CP accessors do different things for secondary indexes. jrose@1494: // Finally, it is helpful for debugging to tell the two apart. jrose@1161: static bool is_secondary_index(int i) { return (i < 0); } jrose@1161: static int decode_secondary_index(int i) { assert(is_secondary_index(i), ""); return ~i; } jrose@1161: static int encode_secondary_index(int i) { assert(!is_secondary_index(i), ""); return ~i; } jrose@1161: duke@435: // Accessors duke@435: void set_constant_pool(constantPoolOop pool) { oop_store_without_check((oop*)&_constant_pool, (oop)pool); } duke@435: constantPoolOop constant_pool() const { return _constant_pool; } jrose@1494: // Fetches the entry at the given index. jrose@1494: // The entry may be either primary or secondary. jrose@1494: // In either case the index must not be encoded or byte-swapped in any way. jrose@1494: ConstantPoolCacheEntry* entry_at(int i) const { jrose@1494: assert(0 <= i && i < length(), "index out of bounds"); jrose@1494: return base() + i; jrose@1494: } jrose@1494: // Fetches the secondary entry referred to by index. jrose@1494: // The index may be a secondary index, and must not be byte-swapped. jrose@1494: ConstantPoolCacheEntry* secondary_entry_at(int i) const { jrose@1494: int raw_index = i; jrose@1494: if (is_secondary_index(i)) { // correct these on the fly jrose@1494: raw_index = decode_secondary_index(i); jrose@1494: } jrose@1494: assert(entry_at(raw_index)->is_secondary_entry(), "not a secondary entry"); jrose@1494: return entry_at(raw_index); jrose@1494: } jrose@1494: // Given a primary or secondary index, fetch the corresponding primary entry. jrose@1494: // Indirect through the secondary entry, if the index is encoded as a secondary index. jrose@1494: // The index must not be byte-swapped. jrose@1161: ConstantPoolCacheEntry* main_entry_at(int i) const { jrose@1494: int primary_index = i; jrose@1161: if (is_secondary_index(i)) { jrose@1161: // run through an extra level of indirection: jrose@1494: int raw_index = decode_secondary_index(i); jrose@1494: primary_index = entry_at(raw_index)->main_entry_index(); jrose@1161: } jrose@1494: assert(!entry_at(primary_index)->is_secondary_entry(), "only one level of indirection"); jrose@1494: return entry_at(primary_index); jrose@1161: } duke@435: duke@435: // Code generation duke@435: static ByteSize base_offset() { return in_ByteSize(sizeof(constantPoolCacheOopDesc)); } jrose@1494: static ByteSize entry_offset(int raw_index) { jrose@1494: int index = raw_index; jrose@1494: if (is_secondary_index(raw_index)) jrose@1494: index = decode_secondary_index(raw_index); jrose@1494: return (base_offset() + ConstantPoolCacheEntry::size_in_bytes() * index); jrose@1494: } duke@435: duke@435: // RedefineClasses() API support: duke@435: // If any entry of this constantPoolCache points to any of duke@435: // old_methods, replace it with the corresponding new_method. duke@435: // trace_name_printed is set to true if the current call has duke@435: // printed the klass name so that other routines in the adjust_* duke@435: // group don't print the klass name. duke@435: void adjust_method_entries(methodOop* old_methods, methodOop* new_methods, duke@435: int methods_length, bool * trace_name_printed); duke@435: }; stefank@2314: stefank@2314: #endif // SHARE_VM_OOPS_CPCACHEOOP_HPP