duke@435: /* stefank@2314: * Copyright (c) 1998, 2010, 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_COMPILER_OOPMAP_HPP stefank@2314: #define SHARE_VM_COMPILER_OOPMAP_HPP stefank@2314: stefank@2314: #include "code/compressedStream.hpp" stefank@2314: #include "code/vmreg.hpp" stefank@2314: #include "memory/allocation.hpp" stefank@2314: #include "utilities/growableArray.hpp" stefank@2314: duke@435: // Interface for generating the frame map for compiled code. A frame map duke@435: // describes for a specific pc whether each register and frame stack slot is: duke@435: // Oop - A GC root for current frame duke@435: // Value - Live non-oop, non-float value: int, either half of double duke@435: // Dead - Dead; can be Zapped for debugging duke@435: // CalleeXX - Callee saved; also describes which caller register is saved duke@435: // DerivedXX - A derived oop; original oop is described. duke@435: // duke@435: // OopMapValue describes a single OopMap entry duke@435: duke@435: class frame; duke@435: class RegisterMap; duke@435: class DerivedPointerEntry; duke@435: duke@435: class OopMapValue: public StackObj { duke@435: friend class VMStructs; duke@435: private: duke@435: short _value; duke@435: int value() const { return _value; } duke@435: void set_value(int value) { _value = value; } duke@435: short _content_reg; duke@435: duke@435: public: duke@435: // Constants kvn@679: enum { type_bits = 5, duke@435: register_bits = BitsPerShort - type_bits }; duke@435: duke@435: enum { type_shift = 0, duke@435: register_shift = type_bits }; duke@435: duke@435: enum { type_mask = right_n_bits(type_bits), duke@435: type_mask_in_place = type_mask << type_shift, duke@435: register_mask = right_n_bits(register_bits), duke@435: register_mask_in_place = register_mask << register_shift }; duke@435: duke@435: enum oop_types { // must fit in type_bits duke@435: unused_value =0, // powers of 2, for masking OopMapStream duke@435: oop_value = 1, duke@435: value_value = 2, coleenp@548: narrowoop_value = 4, duke@435: callee_saved_value = 8, kvn@679: derived_oop_value= 16 }; duke@435: duke@435: // Constructors duke@435: OopMapValue () { set_value(0); set_content_reg(VMRegImpl::Bad()); } duke@435: OopMapValue (VMReg reg, oop_types t) { set_reg_type(reg,t); } duke@435: OopMapValue (VMReg reg, oop_types t, VMReg reg2) { set_reg_type(reg,t); set_content_reg(reg2); } duke@435: OopMapValue (CompressedReadStream* stream) { read_from(stream); } duke@435: duke@435: // Archiving duke@435: void write_on(CompressedWriteStream* stream) { duke@435: stream->write_int(value()); duke@435: if(is_callee_saved() || is_derived_oop()) { duke@435: stream->write_int(content_reg()->value()); duke@435: } duke@435: } duke@435: duke@435: void read_from(CompressedReadStream* stream) { duke@435: set_value(stream->read_int()); duke@435: if(is_callee_saved() || is_derived_oop()) { duke@435: set_content_reg(VMRegImpl::as_VMReg(stream->read_int(), true)); duke@435: } duke@435: } duke@435: duke@435: // Querying duke@435: bool is_oop() { return mask_bits(value(), type_mask_in_place) == oop_value; } duke@435: bool is_value() { return mask_bits(value(), type_mask_in_place) == value_value; } coleenp@548: bool is_narrowoop() { return mask_bits(value(), type_mask_in_place) == narrowoop_value; } duke@435: bool is_callee_saved() { return mask_bits(value(), type_mask_in_place) == callee_saved_value; } duke@435: bool is_derived_oop() { return mask_bits(value(), type_mask_in_place) == derived_oop_value; } duke@435: duke@435: void set_oop() { set_value((value() & register_mask_in_place) | oop_value); } duke@435: void set_value() { set_value((value() & register_mask_in_place) | value_value); } coleenp@548: void set_narrowoop() { set_value((value() & register_mask_in_place) | narrowoop_value); } duke@435: void set_callee_saved() { set_value((value() & register_mask_in_place) | callee_saved_value); } duke@435: void set_derived_oop() { set_value((value() & register_mask_in_place) | derived_oop_value); } duke@435: duke@435: VMReg reg() const { return VMRegImpl::as_VMReg(mask_bits(value(), register_mask_in_place) >> register_shift); } duke@435: oop_types type() const { return (oop_types)mask_bits(value(), type_mask_in_place); } duke@435: duke@435: static bool legal_vm_reg_name(VMReg p) { duke@435: return (p->value() == (p->value() & register_mask)); duke@435: } duke@435: duke@435: void set_reg_type(VMReg p, oop_types t) { duke@435: set_value((p->value() << register_shift) | t); duke@435: assert(reg() == p, "sanity check" ); duke@435: assert(type() == t, "sanity check" ); duke@435: } duke@435: duke@435: duke@435: VMReg content_reg() const { return VMRegImpl::as_VMReg(_content_reg, true); } duke@435: void set_content_reg(VMReg r) { _content_reg = r->value(); } duke@435: duke@435: // Physical location queries duke@435: bool is_register_loc() { return reg()->is_reg(); } duke@435: bool is_stack_loc() { return reg()->is_stack(); } duke@435: duke@435: // Returns offset from sp. duke@435: int stack_offset() { duke@435: assert(is_stack_loc(), "must be stack location"); duke@435: return reg()->reg2stack(); duke@435: } duke@435: jrose@535: void print_on(outputStream* st) const; kvn@460: void print() const { print_on(tty); } duke@435: }; duke@435: duke@435: duke@435: class OopMap: public ResourceObj { duke@435: friend class OopMapStream; duke@435: friend class VMStructs; duke@435: private: duke@435: int _pc_offset; duke@435: int _omv_count; duke@435: int _omv_data_size; duke@435: unsigned char* _omv_data; duke@435: CompressedWriteStream* _write_stream; duke@435: duke@435: debug_only( OopMapValue::oop_types* _locs_used; int _locs_length;) duke@435: duke@435: // Accessors duke@435: unsigned char* omv_data() const { return _omv_data; } duke@435: void set_omv_data(unsigned char* value) { _omv_data = value; } duke@435: int omv_data_size() const { return _omv_data_size; } duke@435: void set_omv_data_size(int value) { _omv_data_size = value; } duke@435: int omv_count() const { return _omv_count; } duke@435: void set_omv_count(int value) { _omv_count = value; } duke@435: void increment_count() { _omv_count++; } duke@435: CompressedWriteStream* write_stream() const { return _write_stream; } duke@435: void set_write_stream(CompressedWriteStream* value) { _write_stream = value; } duke@435: duke@435: private: duke@435: enum DeepCopyToken { _deep_copy_token }; duke@435: OopMap(DeepCopyToken, OopMap* source); // used only by deep_copy duke@435: duke@435: public: duke@435: OopMap(int frame_size, int arg_count); duke@435: duke@435: // pc-offset handling duke@435: int offset() const { return _pc_offset; } duke@435: void set_offset(int o) { _pc_offset = o; } duke@435: duke@435: // Check to avoid double insertion duke@435: debug_only(OopMapValue::oop_types locs_used( int indx ) { return _locs_used[indx]; }) duke@435: duke@435: // Construction duke@435: // frame_size units are stack-slots (4 bytes) NOT intptr_t; we can name odd duke@435: // slots to hold 4-byte values like ints and floats in the LP64 build. duke@435: void set_oop ( VMReg local); duke@435: void set_value( VMReg local); coleenp@548: void set_narrowoop(VMReg local); duke@435: void set_dead ( VMReg local); duke@435: void set_callee_saved( VMReg local, VMReg caller_machine_register ); duke@435: void set_derived_oop ( VMReg local, VMReg derived_from_local_register ); duke@435: void set_xxx(VMReg reg, OopMapValue::oop_types x, VMReg optional); duke@435: duke@435: int heap_size() const; duke@435: void copy_to(address addr); duke@435: OopMap* deep_copy(); duke@435: duke@435: bool has_derived_pointer() const PRODUCT_RETURN0; duke@435: duke@435: bool legal_vm_reg_name(VMReg local) { duke@435: return OopMapValue::legal_vm_reg_name(local); duke@435: } duke@435: duke@435: // Printing jrose@535: void print_on(outputStream* st) const; duke@435: void print() const { print_on(tty); } duke@435: }; duke@435: duke@435: duke@435: class OopMapSet : public ResourceObj { duke@435: friend class VMStructs; duke@435: private: duke@435: int _om_count; duke@435: int _om_size; duke@435: OopMap** _om_data; duke@435: duke@435: int om_count() const { return _om_count; } duke@435: void set_om_count(int value) { _om_count = value; } duke@435: void increment_count() { _om_count++; } duke@435: int om_size() const { return _om_size; } duke@435: void set_om_size(int value) { _om_size = value; } duke@435: OopMap** om_data() const { return _om_data; } duke@435: void set_om_data(OopMap** value) { _om_data = value; } duke@435: void grow_om_data(); duke@435: void set(int index,OopMap* value) { assert((index == 0) || ((index > 0) && (index < om_size())),"bad index"); _om_data[index] = value; } duke@435: duke@435: public: duke@435: OopMapSet(); duke@435: duke@435: // returns the number of OopMaps in this OopMapSet duke@435: int size() const { return _om_count; } duke@435: // returns the OopMap at a given index duke@435: OopMap* at(int index) const { assert((index >= 0) && (index <= om_count()),"bad index"); return _om_data[index]; } duke@435: duke@435: // Collect OopMaps. duke@435: void add_gc_map(int pc, OopMap* map); duke@435: duke@435: // Returns the only oop map. Used for reconstructing duke@435: // Adapter frames during deoptimization duke@435: OopMap* singular_oop_map(); duke@435: duke@435: // returns OopMap in that is anchored to the pc duke@435: OopMap* find_map_at_offset(int pc_offset) const; duke@435: duke@435: int heap_size() const; duke@435: void copy_to(address addr); duke@435: kvn@1293: // Methods oops_do() and all_do() filter out NULL oops and kvn@1293: // oop == Universe::narrow_oop_base() before passing oops kvn@1293: // to closures. kvn@1293: duke@435: // Iterates through frame for a compiled method duke@435: static void oops_do (const frame* fr, duke@435: const RegisterMap* reg_map, OopClosure* f); duke@435: static void update_register_map(const frame* fr, RegisterMap *reg_map); duke@435: duke@435: // Iterates through frame for a compiled method for dead ones and values, too duke@435: static void all_do(const frame* fr, const RegisterMap* reg_map, duke@435: OopClosure* oop_fn, duke@435: void derived_oop_fn(oop* base, oop* derived), coleenp@548: OopClosure* value_fn); duke@435: duke@435: // Printing jrose@535: void print_on(outputStream* st) const; duke@435: void print() const { print_on(tty); } duke@435: }; duke@435: duke@435: duke@435: class OopMapStream : public StackObj { duke@435: private: duke@435: CompressedReadStream* _stream; duke@435: int _mask; duke@435: int _size; duke@435: int _position; duke@435: bool _valid_omv; duke@435: OopMapValue _omv; duke@435: void find_next(); duke@435: duke@435: public: duke@435: OopMapStream(OopMap* oop_map); duke@435: OopMapStream(OopMap* oop_map, int oop_types_mask); duke@435: bool is_done() { if(!_valid_omv) { find_next(); } return !_valid_omv; } duke@435: void next() { find_next(); } duke@435: OopMapValue current() { return _omv; } duke@435: }; duke@435: duke@435: duke@435: // Derived pointer support. This table keeps track of all derived points on a duke@435: // stack. It is cleared before each scavenge/GC. During the traversal of all duke@435: // oops, it is filled in with references to all locations that contains a duke@435: // derived oop (assumed to be very few). When the GC is complete, the derived duke@435: // pointers are updated based on their base pointers new value and an offset. duke@435: #ifdef COMPILER2 duke@435: class DerivedPointerTable : public AllStatic { duke@435: friend class VMStructs; duke@435: private: duke@435: static GrowableArray* _list; duke@435: static bool _active; // do not record pointers for verify pass etc. duke@435: public: duke@435: static void clear(); // Called before scavenge/GC duke@435: static void add(oop *derived, oop *base); // Called during scavenge/GC duke@435: static void update_pointers(); // Called after scavenge/GC duke@435: static bool is_empty() { return _list == NULL || _list->is_empty(); } duke@435: static bool is_active() { return _active; } duke@435: static void set_active(bool value) { _active = value; } duke@435: }; duke@435: duke@435: // A utility class to temporarily "deactivate" the DerivedPointerTable. duke@435: // (Note: clients are responsible for any MT-safety issues) duke@435: class DerivedPointerTableDeactivate: public StackObj { duke@435: private: duke@435: bool _active; duke@435: public: duke@435: DerivedPointerTableDeactivate() { duke@435: _active = DerivedPointerTable::is_active(); duke@435: if (_active) { duke@435: DerivedPointerTable::set_active(false); duke@435: } duke@435: } duke@435: duke@435: ~DerivedPointerTableDeactivate() { duke@435: assert(!DerivedPointerTable::is_active(), duke@435: "Inconsistency: not MT-safe"); duke@435: if (_active) { duke@435: DerivedPointerTable::set_active(true); duke@435: } duke@435: } duke@435: }; duke@435: #endif // COMPILER2 stefank@2314: stefank@2314: #endif // SHARE_VM_COMPILER_OOPMAP_HPP