duke@435: /* mikael@6198: * Copyright (c) 1997, 2013, 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_CODE_STUBS_HPP stefank@2314: #define SHARE_VM_CODE_STUBS_HPP stefank@2314: kvn@4107: #include "asm/codeBuffer.hpp" stefank@2314: #include "memory/allocation.hpp" stefank@2314: #ifdef TARGET_OS_FAMILY_linux stefank@2314: # include "os_linux.inline.hpp" stefank@2314: #endif stefank@2314: #ifdef TARGET_OS_FAMILY_solaris stefank@2314: # include "os_solaris.inline.hpp" stefank@2314: #endif stefank@2314: #ifdef TARGET_OS_FAMILY_windows stefank@2314: # include "os_windows.inline.hpp" stefank@2314: #endif goetz@6461: #ifdef TARGET_OS_FAMILY_aix goetz@6461: # include "os_aix.inline.hpp" goetz@6461: #endif never@3156: #ifdef TARGET_OS_FAMILY_bsd never@3156: # include "os_bsd.inline.hpp" never@3156: #endif stefank@2314: duke@435: // The classes in this file provide a simple framework for the duke@435: // management of little pieces of machine code - or stubs - duke@435: // created on the fly and frequently discarded. In this frame- duke@435: // work stubs are stored in a queue. duke@435: duke@435: duke@435: // Stub serves as abstract base class. A concrete stub duke@435: // implementation is a subclass of Stub, implementing duke@435: // all (non-virtual!) functions required sketched out duke@435: // in the Stub class. duke@435: // duke@435: // A concrete stub layout may look like this (both data duke@435: // and code sections could be empty as well): duke@435: // duke@435: // ________ duke@435: // stub -->| | <--+ duke@435: // | data | | duke@435: // |________| | duke@435: // code_begin -->| | | duke@435: // | | | duke@435: // | code | | size duke@435: // | | | duke@435: // |________| | duke@435: // code_end -->| | | duke@435: // | data | | duke@435: // |________| | duke@435: // <--+ duke@435: duke@435: duke@435: class Stub VALUE_OBJ_CLASS_SPEC { duke@435: public: duke@435: // Initialization/finalization kvn@4107: void initialize(int size, roland@4767: CodeStrings& strings) { ShouldNotCallThis(); } // called to initialize/specify the stub's size duke@435: void finalize() { ShouldNotCallThis(); } // called before the stub is deallocated duke@435: duke@435: // General info/converters duke@435: int size() const { ShouldNotCallThis(); return 0; } // must return the size provided by initialize duke@435: static int code_size_to_size(int code_size) { ShouldNotCallThis(); return 0; } // computes the size given the code size duke@435: duke@435: // Code info duke@435: address code_begin() const { ShouldNotCallThis(); return NULL; } // points to the first byte of the code duke@435: address code_end() const { ShouldNotCallThis(); return NULL; } // points to the first byte after the code duke@435: duke@435: // Debugging duke@435: void verify() { ShouldNotCallThis(); } // verifies the Stub duke@435: void print() { ShouldNotCallThis(); } // prints some information about the stub duke@435: }; duke@435: duke@435: duke@435: // A stub interface defines the interface between a stub queue duke@435: // and the stubs it queues. In order to avoid a vtable and duke@435: // (and thus the extra word) in each stub, a concrete stub duke@435: // interface object is created and associated with a stub duke@435: // buffer which in turn uses the stub interface to interact duke@435: // with its stubs. duke@435: // duke@435: // StubInterface serves as an abstract base class. A concrete duke@435: // stub interface implementation is a subclass of StubInterface, duke@435: // forwarding its virtual function calls to non-virtual calls duke@435: // of the concrete stub (see also macro below). There's exactly duke@435: // one stub interface instance required per stub queue. duke@435: zgu@3900: class StubInterface: public CHeapObj { duke@435: public: duke@435: // Initialization/finalization kvn@4107: virtual void initialize(Stub* self, int size, roland@4767: CodeStrings& strings) = 0; // called after creation (called twice if allocated via (request, commit)) duke@435: virtual void finalize(Stub* self) = 0; // called before deallocation duke@435: duke@435: // General info/converters duke@435: virtual int size(Stub* self) const = 0; // the total size of the stub in bytes (must be a multiple of CodeEntryAlignment) duke@435: virtual int code_size_to_size(int code_size) const = 0; // computes the total stub size in bytes given the code size in bytes duke@435: duke@435: // Code info duke@435: virtual address code_begin(Stub* self) const = 0; // points to the first code byte duke@435: virtual address code_end(Stub* self) const = 0; // points to the first byte after the code duke@435: duke@435: // Debugging duke@435: virtual void verify(Stub* self) = 0; // verifies the stub duke@435: virtual void print(Stub* self) = 0; // prints information about the stub duke@435: }; duke@435: duke@435: duke@435: // DEF_STUB_INTERFACE is used to create a concrete stub interface duke@435: // class, forwarding stub interface calls to the corresponding duke@435: // stub calls. duke@435: duke@435: #define DEF_STUB_INTERFACE(stub) \ duke@435: class stub##Interface: public StubInterface { \ duke@435: private: \ duke@435: static stub* cast(Stub* self) { return (stub*)self; } \ duke@435: \ duke@435: public: \ duke@435: /* Initialization/finalization */ \ kvn@4107: virtual void initialize(Stub* self, int size, \ roland@4767: CodeStrings& strings) { cast(self)->initialize(size, strings); } \ duke@435: virtual void finalize(Stub* self) { cast(self)->finalize(); } \ duke@435: \ duke@435: /* General info */ \ duke@435: virtual int size(Stub* self) const { return cast(self)->size(); } \ duke@435: virtual int code_size_to_size(int code_size) const { return stub::code_size_to_size(code_size); } \ duke@435: \ duke@435: /* Code info */ \ duke@435: virtual address code_begin(Stub* self) const { return cast(self)->code_begin(); } \ duke@435: virtual address code_end(Stub* self) const { return cast(self)->code_end(); } \ duke@435: \ duke@435: /* Debugging */ \ duke@435: virtual void verify(Stub* self) { cast(self)->verify(); } \ duke@435: virtual void print(Stub* self) { cast(self)->print(); } \ duke@435: }; duke@435: duke@435: duke@435: // A StubQueue maintains a queue of stubs. duke@435: // Note: All sizes (spaces) are given in bytes. duke@435: zgu@3900: class StubQueue: public CHeapObj { duke@435: friend class VMStructs; duke@435: private: duke@435: StubInterface* _stub_interface; // the interface prototype duke@435: address _stub_buffer; // where all stubs are stored duke@435: int _buffer_size; // the buffer size in bytes duke@435: int _buffer_limit; // the (byte) index of the actual buffer limit (_buffer_limit <= _buffer_size) duke@435: int _queue_begin; // the (byte) index of the first queue entry (word-aligned) duke@435: int _queue_end; // the (byte) index of the first entry after the queue (word-aligned) duke@435: int _number_of_stubs; // the number of buffered stubs duke@435: Mutex* const _mutex; // the lock used for a (request, commit) transaction duke@435: duke@435: void check_index(int i) const { assert(0 <= i && i < _buffer_limit && i % CodeEntryAlignment == 0, "illegal index"); } duke@435: bool is_contiguous() const { return _queue_begin <= _queue_end; } duke@435: int index_of(Stub* s) const { int i = (address)s - _stub_buffer; check_index(i); return i; } duke@435: Stub* stub_at(int i) const { check_index(i); return (Stub*)(_stub_buffer + i); } duke@435: Stub* current_stub() const { return stub_at(_queue_end); } duke@435: duke@435: // Stub functionality accessed via interface kvn@4107: void stub_initialize(Stub* s, int size, roland@4767: CodeStrings& strings) { assert(size % CodeEntryAlignment == 0, "size not aligned"); _stub_interface->initialize(s, size, strings); } duke@435: void stub_finalize(Stub* s) { _stub_interface->finalize(s); } duke@435: int stub_size(Stub* s) const { return _stub_interface->size(s); } duke@435: bool stub_contains(Stub* s, address pc) const { return _stub_interface->code_begin(s) <= pc && pc < _stub_interface->code_end(s); } duke@435: int stub_code_size_to_size(int code_size) const { return _stub_interface->code_size_to_size(code_size); } duke@435: void stub_verify(Stub* s) { _stub_interface->verify(s); } duke@435: void stub_print(Stub* s) { _stub_interface->print(s); } duke@435: duke@435: static void register_queue(StubQueue*); duke@435: duke@435: public: duke@435: StubQueue(StubInterface* stub_interface, int buffer_size, Mutex* lock, duke@435: const char* name); duke@435: ~StubQueue(); duke@435: duke@435: // General queue info duke@435: bool is_empty() const { return _queue_begin == _queue_end; } duke@435: int total_space() const { return _buffer_size - 1; } duke@435: int available_space() const { int d = _queue_begin - _queue_end - 1; return d < 0 ? d + _buffer_size : d; } duke@435: int used_space() const { return total_space() - available_space(); } duke@435: int number_of_stubs() const { return _number_of_stubs; } duke@435: bool contains(address pc) const { return _stub_buffer <= pc && pc < _stub_buffer + _buffer_limit; } duke@435: Stub* stub_containing(address pc) const; duke@435: address code_start() const { return _stub_buffer; } duke@435: address code_end() const { return _stub_buffer + _buffer_limit; } duke@435: duke@435: // Stub allocation (atomic transactions) duke@435: Stub* request_committed(int code_size); // request a stub that provides exactly code_size space for code duke@435: Stub* request(int requested_code_size); // request a stub with a (maximum) code space - locks the queue kvn@4107: void commit (int committed_code_size, roland@4767: CodeStrings& strings); // commit the previously requested stub - unlocks the queue duke@435: duke@435: // Stub deallocation duke@435: void remove_first(); // remove the first stub in the queue duke@435: void remove_first(int n); // remove the first n stubs in the queue duke@435: void remove_all(); // remove all stubs in the queue duke@435: duke@435: // Iteration duke@435: static void queues_do(void f(StubQueue* s)); // call f with each StubQueue duke@435: void stubs_do(void f(Stub* s)); // call f with all stubs duke@435: Stub* first() const { return number_of_stubs() > 0 ? stub_at(_queue_begin) : NULL; } duke@435: Stub* next(Stub* s) const { int i = index_of(s) + stub_size(s); duke@435: if (i == _buffer_limit) i = 0; duke@435: return (i == _queue_end) ? NULL : stub_at(i); duke@435: } duke@435: duke@435: address stub_code_begin(Stub* s) const { return _stub_interface->code_begin(s); } duke@435: address stub_code_end(Stub* s) const { return _stub_interface->code_end(s); } duke@435: duke@435: // Debugging/printing duke@435: void verify(); // verifies the stub queue duke@435: void print(); // prints information about the stub queue duke@435: }; stefank@2314: stefank@2314: #endif // SHARE_VM_CODE_STUBS_HPP