duke@435: /*
duke@435:  * Copyright 1997-2005 Sun Microsystems, Inc.  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:  *
duke@435:  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
duke@435:  * CA 95054 USA or visit www.sun.com if you need additional information or
duke@435:  * have any questions.
duke@435:  *
duke@435:  */
duke@435: 
duke@435: #include "incls/_precompiled.incl"
duke@435: #include "incls/_stubs.cpp.incl"
duke@435: 
duke@435: 
duke@435: // Implementation of StubQueue
duke@435: //
duke@435: // Standard wrap-around queue implementation; the queue dimensions
duke@435: // are specified by the _queue_begin & _queue_end indices. The queue
duke@435: // can be in two states (transparent to the outside):
duke@435: //
duke@435: // a) contiguous state: all queue entries in one block (or empty)
duke@435: //
duke@435: // Queue: |...|XXXXXXX|...............|
duke@435: //        ^0  ^begin  ^end            ^size = limit
duke@435: //            |_______|
duke@435: //            one block
duke@435: //
duke@435: // b) non-contiguous state: queue entries in two blocks
duke@435: //
duke@435: // Queue: |XXX|.......|XXXXXXX|.......|
duke@435: //        ^0  ^end    ^begin  ^limit  ^size
duke@435: //        |___|       |_______|
duke@435: //         1st block  2nd block
duke@435: //
duke@435: // In the non-contiguous state, the wrap-around point is
duke@435: // indicated via the _buffer_limit index since the last
duke@435: // queue entry may not fill up the queue completely in
duke@435: // which case we need to know where the 2nd block's end
duke@435: // is to do the proper wrap-around. When removing the
duke@435: // last entry of the 2nd block, _buffer_limit is reset
duke@435: // to _buffer_size.
duke@435: //
duke@435: // CAUTION: DO NOT MESS WITH THIS CODE IF YOU CANNOT PROVE
duke@435: // ITS CORRECTNESS! THIS CODE IS MORE SUBTLE THAN IT LOOKS!
duke@435: 
duke@435: 
duke@435: StubQueue::StubQueue(StubInterface* stub_interface, int buffer_size,
duke@435:                      Mutex* lock, const char* name) : _mutex(lock) {
duke@435:   intptr_t size = round_to(buffer_size, 2*BytesPerWord);
duke@435:   BufferBlob* blob = BufferBlob::create(name, size);
jcoomes@1845:   if( blob == NULL) {
jcoomes@1845:     vm_exit_out_of_memory(size, err_msg("CodeCache: no room for %s", name));
jcoomes@1845:   }
duke@435:   _stub_interface  = stub_interface;
duke@435:   _buffer_size     = blob->instructions_size();
duke@435:   _buffer_limit    = blob->instructions_size();
duke@435:   _stub_buffer     = blob->instructions_begin();
duke@435:   _queue_begin     = 0;
duke@435:   _queue_end       = 0;
duke@435:   _number_of_stubs = 0;
duke@435:   register_queue(this);
duke@435: }
duke@435: 
duke@435: 
duke@435: StubQueue::~StubQueue() {
duke@435:   // Note: Currently StubQueues are never destroyed so nothing needs to be done here.
duke@435:   //       If we want to implement the destructor, we need to release the BufferBlob
duke@435:   //       allocated in the constructor (i.e., we need to keep it around or look it
duke@435:   //       up via CodeCache::find_blob(...).
duke@435:   Unimplemented();
duke@435: }
duke@435: 
duke@435: 
duke@435: Stub* StubQueue::stub_containing(address pc) const {
duke@435:   if (contains(pc)) {
duke@435:     for (Stub* s = first(); s != NULL; s = next(s)) {
duke@435:       if (stub_contains(s, pc)) return s;
duke@435:     }
duke@435:   }
duke@435:   return NULL;
duke@435: }
duke@435: 
duke@435: 
duke@435: Stub* StubQueue::request_committed(int code_size) {
duke@435:   Stub* s = request(code_size);
duke@435:   if (s != NULL) commit(code_size);
duke@435:   return s;
duke@435: }
duke@435: 
duke@435: 
duke@435: Stub* StubQueue::request(int requested_code_size) {
duke@435:   assert(requested_code_size > 0, "requested_code_size must be > 0");
duke@435:   if (_mutex != NULL) _mutex->lock();
duke@435:   Stub* s = current_stub();
duke@435:   int requested_size = round_to(stub_code_size_to_size(requested_code_size), CodeEntryAlignment);
duke@435:   if (requested_size <= available_space()) {
duke@435:     if (is_contiguous()) {
duke@435:       // Queue: |...|XXXXXXX|.............|
duke@435:       //        ^0  ^begin  ^end          ^size = limit
duke@435:       assert(_buffer_limit == _buffer_size, "buffer must be fully usable");
duke@435:       if (_queue_end + requested_size <= _buffer_size) {
duke@435:         // code fits in at the end => nothing to do
duke@435:         stub_initialize(s, requested_size);
duke@435:         return s;
duke@435:       } else {
duke@435:         // stub doesn't fit in at the queue end
duke@435:         // => reduce buffer limit & wrap around
duke@435:         assert(!is_empty(), "just checkin'");
duke@435:         _buffer_limit = _queue_end;
duke@435:         _queue_end = 0;
duke@435:       }
duke@435:     }
duke@435:   }
duke@435:   if (requested_size <= available_space()) {
duke@435:     assert(!is_contiguous(), "just checkin'");
duke@435:     assert(_buffer_limit <= _buffer_size, "queue invariant broken");
duke@435:     // Queue: |XXX|.......|XXXXXXX|.......|
duke@435:     //        ^0  ^end    ^begin  ^limit  ^size
duke@435:     s = current_stub();
duke@435:     stub_initialize(s, requested_size);
duke@435:     return s;
duke@435:   }
duke@435:   // Not enough space left
duke@435:   if (_mutex != NULL) _mutex->unlock();
duke@435:   return NULL;
duke@435: }
duke@435: 
duke@435: 
duke@435: void StubQueue::commit(int committed_code_size) {
duke@435:   assert(committed_code_size > 0, "committed_code_size must be > 0");
duke@435:   int committed_size = round_to(stub_code_size_to_size(committed_code_size), CodeEntryAlignment);
duke@435:   Stub* s = current_stub();
duke@435:   assert(committed_size <= stub_size(s), "committed size must not exceed requested size");
duke@435:   stub_initialize(s, committed_size);
duke@435:   _queue_end += committed_size;
duke@435:   _number_of_stubs++;
duke@435:   if (_mutex != NULL) _mutex->unlock();
duke@435:   debug_only(stub_verify(s);)
duke@435: }
duke@435: 
duke@435: 
duke@435: void StubQueue::remove_first() {
duke@435:   if (number_of_stubs() == 0) return;
duke@435:   Stub* s = first();
duke@435:   debug_only(stub_verify(s);)
duke@435:   stub_finalize(s);
duke@435:   _queue_begin += stub_size(s);
duke@435:   assert(_queue_begin <= _buffer_limit, "sanity check");
duke@435:   if (_queue_begin == _queue_end) {
duke@435:     // buffer empty
duke@435:     // => reset queue indices
duke@435:     _queue_begin  = 0;
duke@435:     _queue_end    = 0;
duke@435:     _buffer_limit = _buffer_size;
duke@435:   } else if (_queue_begin == _buffer_limit) {
duke@435:     // buffer limit reached
duke@435:     // => reset buffer limit & wrap around
duke@435:     _buffer_limit = _buffer_size;
duke@435:     _queue_begin = 0;
duke@435:   }
duke@435:   _number_of_stubs--;
duke@435: }
duke@435: 
duke@435: 
duke@435: void StubQueue::remove_first(int n) {
duke@435:   int i = MIN2(n, number_of_stubs());
duke@435:   while (i-- > 0) remove_first();
duke@435: }
duke@435: 
duke@435: 
duke@435: void StubQueue::remove_all(){
duke@435:   debug_only(verify();)
duke@435:   remove_first(number_of_stubs());
duke@435:   assert(number_of_stubs() == 0, "sanity check");
duke@435: }
duke@435: 
duke@435: 
duke@435: enum { StubQueueLimit = 10 };  // there are only a few in the world
duke@435: static StubQueue* registered_stub_queues[StubQueueLimit];
duke@435: 
duke@435: void StubQueue::register_queue(StubQueue* sq) {
duke@435:   for (int i = 0; i < StubQueueLimit; i++) {
duke@435:     if (registered_stub_queues[i] == NULL) {
duke@435:       registered_stub_queues[i] = sq;
duke@435:       return;
duke@435:     }
duke@435:   }
duke@435:   ShouldNotReachHere();
duke@435: }
duke@435: 
duke@435: 
duke@435: void StubQueue::queues_do(void f(StubQueue* sq)) {
duke@435:   for (int i = 0; i < StubQueueLimit; i++) {
duke@435:     if (registered_stub_queues[i] != NULL) {
duke@435:       f(registered_stub_queues[i]);
duke@435:     }
duke@435:   }
duke@435: }
duke@435: 
duke@435: 
duke@435: void StubQueue::stubs_do(void f(Stub* s)) {
duke@435:   debug_only(verify();)
duke@435:   MutexLockerEx lock(_mutex);
duke@435:   for (Stub* s = first(); s != NULL; s = next(s)) f(s);
duke@435: }
duke@435: 
duke@435: 
duke@435: void StubQueue::verify() {
duke@435:   // verify only if initialized
duke@435:   if (_stub_buffer == NULL) return;
duke@435:   MutexLockerEx lock(_mutex);
duke@435:   // verify index boundaries
duke@435:   guarantee(0 <= _buffer_size, "buffer size must be positive");
duke@435:   guarantee(0 <= _buffer_limit && _buffer_limit <= _buffer_size , "_buffer_limit out of bounds");
duke@435:   guarantee(0 <= _queue_begin  && _queue_begin  <  _buffer_limit, "_queue_begin out of bounds");
duke@435:   guarantee(0 <= _queue_end    && _queue_end    <= _buffer_limit, "_queue_end   out of bounds");
duke@435:   // verify alignment
duke@435:   guarantee(_buffer_size  % CodeEntryAlignment == 0, "_buffer_size  not aligned");
duke@435:   guarantee(_buffer_limit % CodeEntryAlignment == 0, "_buffer_limit not aligned");
duke@435:   guarantee(_queue_begin  % CodeEntryAlignment == 0, "_queue_begin  not aligned");
duke@435:   guarantee(_queue_end    % CodeEntryAlignment == 0, "_queue_end    not aligned");
duke@435:   // verify buffer limit/size relationship
duke@435:   if (is_contiguous()) {
duke@435:     guarantee(_buffer_limit == _buffer_size, "_buffer_limit must equal _buffer_size");
duke@435:   }
duke@435:   // verify contents
duke@435:   int n = 0;
duke@435:   for (Stub* s = first(); s != NULL; s = next(s)) {
duke@435:     stub_verify(s);
duke@435:     n++;
duke@435:   }
duke@435:   guarantee(n == number_of_stubs(), "number of stubs inconsistent");
duke@435:   guarantee(_queue_begin != _queue_end || n == 0, "buffer indices must be the same");
duke@435: }
duke@435: 
duke@435: 
duke@435: void StubQueue::print() {
duke@435:   MutexLockerEx lock(_mutex);
duke@435:   for (Stub* s = first(); s != NULL; s = next(s)) {
duke@435:     stub_print(s);
duke@435:   }
duke@435: }