/*

 * Copyright 1997-2007 Sun Microsystems, Inc.  All Rights Reserved.

 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

 *

 * This code is free software; you can redistribute it and/or modify it

 * 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 Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,

 * CA 95054 USA or visit www.sun.com if you need additional information or

 * have any questions.

 *

 */

# include "incls/_precompiled.incl"

# include "incls/_codeCache.cpp.incl"

// Helper class for printing in CodeCache

class CodeBlob_sizes {

 private:

  int count;

  int total_size;

  int header_size;

  int code_size;

  int stub_size;

  int relocation_size;

  int scopes_oop_size;

  int scopes_data_size;

  int scopes_pcs_size;

 public:

  CodeBlob_sizes() {

    count            = 0;

    total_size       = 0;

    header_size      = 0;

    code_size        = 0;

    stub_size        = 0;

    relocation_size  = 0;

    scopes_oop_size  = 0;

    scopes_data_size = 0;

    scopes_pcs_size  = 0;

  }

  int total()                                    { return total_size; }

  bool is_empty()                                { return count == 0; }

  void print(const char* title) {

    tty->print_cr(" #%d %s = %dK (hdr %d%%,  loc %d%%, code %d%%, stub %d%%, [oops %d%%, data %d%%, pcs %d%%])",

                  count,

                  title,

                  total() / K,

                  header_size             * 100 / total_size,

                  relocation_size         * 100 / total_size,

                  code_size               * 100 / total_size,

                  stub_size               * 100 / total_size,

                  scopes_oop_size         * 100 / total_size,

                  scopes_data_size        * 100 / total_size,

                  scopes_pcs_size         * 100 / total_size);

  }

  void add(CodeBlob* cb) {

    count++;

    total_size       += cb->size();

    header_size      += cb->header_size();

    relocation_size  += cb->relocation_size();

    scopes_oop_size  += cb->oops_size();

    if (cb->is_nmethod()) {

      nmethod *nm = (nmethod*)cb;

      code_size        += nm->code_size();

      stub_size        += nm->stub_size();

      scopes_data_size += nm->scopes_data_size();

      scopes_pcs_size  += nm->scopes_pcs_size();

    } else {

      code_size        += cb->instructions_size();

    }

  }

};

// CodeCache implementation

CodeHeap * CodeCache::_heap = new CodeHeap();

int CodeCache::_number_of_blobs = 0;

int CodeCache::_number_of_nmethods_with_dependencies = 0;

bool CodeCache::_needs_cache_clean = false;

CodeBlob* CodeCache::first() {

  assert_locked_or_safepoint(CodeCache_lock);

  return (CodeBlob*)_heap->first();

}

CodeBlob* CodeCache::next(CodeBlob* cb) {

  assert_locked_or_safepoint(CodeCache_lock);

  return (CodeBlob*)_heap->next(cb);

}

CodeBlob* CodeCache::alive(CodeBlob *cb) {

  assert_locked_or_safepoint(CodeCache_lock);

  while (cb != NULL && !cb->is_alive()) cb = next(cb);

  return cb;

}

nmethod* CodeCache::alive_nmethod(CodeBlob* cb) {

  assert_locked_or_safepoint(CodeCache_lock);

  while (cb != NULL && (!cb->is_alive() || !cb->is_nmethod())) cb = next(cb);

  return (nmethod*)cb;

}

CodeBlob* CodeCache::allocate(int size) {

  // Do not seize the CodeCache lock here--if the caller has not

  // already done so, we are going to lose bigtime, since the code

  // cache will contain a garbage CodeBlob until the caller can

  // run the constructor for the CodeBlob subclass he is busy

  // instantiating.

  guarantee(size >= 0, "allocation request must be reasonable");

  assert_locked_or_safepoint(CodeCache_lock);

  CodeBlob* cb = NULL;

  _number_of_blobs++;

  while (true) {

    cb = (CodeBlob*)_heap->allocate(size);

    if (cb != NULL) break;

    if (!_heap->expand_by(CodeCacheExpansionSize)) {

      // Expansion failed

      return NULL;

    }

    if (PrintCodeCacheExtension) {

      ResourceMark rm;

      tty->print_cr("code cache extended to [" INTPTR_FORMAT ", " INTPTR_FORMAT "] (%d bytes)",

                    (intptr_t)_heap->begin(), (intptr_t)_heap->end(),

                    (address)_heap->end() - (address)_heap->begin());

    }

  }

  verify_if_often();

  if (PrintCodeCache2) {        // Need to add a new flag

      ResourceMark rm;

      tty->print_cr("CodeCache allocation:  addr: " INTPTR_FORMAT ", size: 0x%x\n", cb, size);

  }

  return cb;

}

void CodeCache::free(CodeBlob* cb) {

  assert_locked_or_safepoint(CodeCache_lock);

  verify_if_often();

  if (PrintCodeCache2) {        // Need to add a new flag

      ResourceMark rm;

      tty->print_cr("CodeCache free:  addr: " INTPTR_FORMAT ", size: 0x%x\n", cb, cb->size());

  }

  if (cb->is_nmethod() && ((nmethod *)cb)->has_dependencies()) {

    _number_of_nmethods_with_dependencies--;

  }

  _number_of_blobs--;

  _heap->deallocate(cb);

  verify_if_often();

  assert(_number_of_blobs >= 0, "sanity check");

}

void CodeCache::commit(CodeBlob* cb) {

  // this is called by nmethod::nmethod, which must already own CodeCache_lock

  assert_locked_or_safepoint(CodeCache_lock);

  if (cb->is_nmethod() && ((nmethod *)cb)->has_dependencies()) {

    _number_of_nmethods_with_dependencies++;

  }

  // flush the hardware I-cache

  ICache::invalidate_range(cb->instructions_begin(), cb->instructions_size());

}

void CodeCache::flush() {

  assert_locked_or_safepoint(CodeCache_lock);

  Unimplemented();

}

// Iteration over CodeBlobs

#define FOR_ALL_BLOBS(var)       for (CodeBlob *var =       first() ; var != NULL; var =       next(var) )

#define FOR_ALL_ALIVE_BLOBS(var) for (CodeBlob *var = alive(first()); var != NULL; var = alive(next(var)))

#define FOR_ALL_ALIVE_NMETHODS(var) for (nmethod *var = alive_nmethod(first()); var != NULL; var = alive_nmethod(next(var)))

bool CodeCache::contains(void *p) {

  // It should be ok to call contains without holding a lock

  return _heap->contains(p);

}

// This method is safe to call without holding the CodeCache_lock, as long as a dead codeblob is not

// looked up (i.e., one that has been marked for deletion). It only dependes on the _segmap to contain

// valid indices, which it will always do, as long as the CodeBlob is not in the process of being recycled.

CodeBlob* CodeCache::find_blob(void* start) {

  CodeBlob* result = find_blob_unsafe(start);

  if (result == NULL) return NULL;

  // We could potientially look up non_entrant methods

  guarantee(!result->is_zombie() || result->is_locked_by_vm() || is_error_reported(), "unsafe access to zombie method");

  return result;

}

nmethod* CodeCache::find_nmethod(void* start) {

  CodeBlob *cb = find_blob(start);

  assert(cb == NULL || cb->is_nmethod(), "did not find an nmethod");

  return (nmethod*)cb;

}

void CodeCache::blobs_do(void f(CodeBlob* nm)) {

  assert_locked_or_safepoint(CodeCache_lock);

  FOR_ALL_BLOBS(p) {

    f(p);

  }

}

void CodeCache::nmethods_do(void f(nmethod* nm)) {

  assert_locked_or_safepoint(CodeCache_lock);

  FOR_ALL_BLOBS(nm) {

    if (nm->is_nmethod()) f((nmethod*)nm);

  }

}

int CodeCache::alignment_unit() {

  return (int)_heap->alignment_unit();

}

int CodeCache::alignment_offset() {

  return (int)_heap->alignment_offset();

}

// Mark code blobs for unloading if they contain otherwise

// unreachable oops.

void CodeCache::do_unloading(BoolObjectClosure* is_alive,

                             OopClosure* keep_alive,

                             bool unloading_occurred) {

  assert_locked_or_safepoint(CodeCache_lock);

  FOR_ALL_ALIVE_BLOBS(cb) {

    cb->do_unloading(is_alive, keep_alive, unloading_occurred);

  }

}

void CodeCache::oops_do(OopClosure* f) {

  assert_locked_or_safepoint(CodeCache_lock);

  FOR_ALL_ALIVE_BLOBS(cb) {

    cb->oops_do(f);

  }

}

void CodeCache::gc_prologue() {

}

void CodeCache::gc_epilogue() {

  assert_locked_or_safepoint(CodeCache_lock);

  FOR_ALL_ALIVE_BLOBS(cb) {

    if (cb->is_nmethod()) {

      nmethod *nm = (nmethod*)cb;

      assert(!nm->is_unloaded(), "Tautology");

      if (needs_cache_clean()) {

        nm->cleanup_inline_caches();

      }

      debug_only(nm->verify();)

    }

    cb->fix_oop_relocations();

  }

  set_needs_cache_clean(false);

}

address CodeCache::first_address() {

  assert_locked_or_safepoint(CodeCache_lock);

  return (address)_heap->begin();

}

address CodeCache::last_address() {

  assert_locked_or_safepoint(CodeCache_lock);

  return (address)_heap->end();

}

void icache_init();

void CodeCache::initialize() {

  assert(CodeCacheSegmentSize >= (uintx)CodeEntryAlignment, "CodeCacheSegmentSize must be large enough to align entry points");

#ifdef COMPILER2

  assert(CodeCacheSegmentSize >= (uintx)OptoLoopAlignment,  "CodeCacheSegmentSize must be large enough to align inner loops");

#endif

  assert(CodeCacheSegmentSize >= sizeof(jdouble),    "CodeCacheSegmentSize must be large enough to align constants");

  // This was originally just a check of the alignment, causing failure, instead, round

  // the code cache to the page size.  In particular, Solaris is moving to a larger

  // default page size.

  CodeCacheExpansionSize = round_to(CodeCacheExpansionSize, os::vm_page_size());

  InitialCodeCacheSize = round_to(InitialCodeCacheSize, os::vm_page_size());

  ReservedCodeCacheSize = round_to(ReservedCodeCacheSize, os::vm_page_size());

  if (!_heap->reserve(ReservedCodeCacheSize, InitialCodeCacheSize, CodeCacheSegmentSize)) {

    vm_exit_during_initialization("Could not reserve enough space for code cache");

  }

  MemoryService::add_code_heap_memory_pool(_heap);

  // Initialize ICache flush mechanism

  // This service is needed for os::register_code_area

  icache_init();

  // Give OS a chance to register generated code area.

  // This is used on Windows 64 bit platforms to register

  // Structured Exception Handlers for our generated code.

  os::register_code_area(_heap->low_boundary(), _heap->high_boundary());

}

void codeCache_init() {

  CodeCache::initialize();

}

//------------------------------------------------------------------------------------------------

int CodeCache::number_of_nmethods_with_dependencies() {

  return _number_of_nmethods_with_dependencies;

}

void CodeCache::clear_inline_caches() {

  assert_locked_or_safepoint(CodeCache_lock);

  FOR_ALL_ALIVE_NMETHODS(nm) {

    nm->clear_inline_caches();

  }

}

#ifndef PRODUCT

// used to keep track of how much time is spent in mark_for_deoptimization

static elapsedTimer dependentCheckTime;

static int dependentCheckCount = 0;

#endif // PRODUCT

int CodeCache::mark_for_deoptimization(DepChange& changes) {

  MutexLockerEx mu(CodeCache_lock, Mutex::_no_safepoint_check_flag);

#ifndef PRODUCT

  dependentCheckTime.start();

  dependentCheckCount++;

#endif // PRODUCT

  int number_of_marked_CodeBlobs = 0;

  // search the hierarchy looking for nmethods which are affected by the loading of this class

  // then search the interfaces this class implements looking for nmethods

  // which might be dependent of the fact that an interface only had one

  // implementor.

  { No_Safepoint_Verifier nsv;

    for (DepChange::ContextStream str(changes, nsv); str.next(); ) {

      klassOop d = str.klass();

      number_of_marked_CodeBlobs += instanceKlass::cast(d)->mark_dependent_nmethods(changes);

    }

  }

  if (VerifyDependencies) {

    // Turn off dependency tracing while actually testing deps.

    NOT_PRODUCT( FlagSetting fs(TraceDependencies, false) );

    FOR_ALL_ALIVE_NMETHODS(nm) {

      if (!nm->is_marked_for_deoptimization() &&

          nm->check_all_dependencies()) {

        ResourceMark rm;

        tty->print_cr("Should have been marked for deoptimization:");

        changes.print();

        nm->print();

        nm->print_dependencies();

      }

    }

  }

#ifndef PRODUCT

  dependentCheckTime.stop();

#endif // PRODUCT

  return number_of_marked_CodeBlobs;

}

#ifdef HOTSWAP

int CodeCache::mark_for_evol_deoptimization(instanceKlassHandle dependee) {

  MutexLockerEx mu(CodeCache_lock, Mutex::_no_safepoint_check_flag);

  int number_of_marked_CodeBlobs = 0;

  // Deoptimize all methods of the evolving class itself

  objArrayOop old_methods = dependee->methods();

  for (int i = 0; i < old_methods->length(); i++) {

    ResourceMark rm;

    methodOop old_method = (methodOop) old_methods->obj_at(i);

    nmethod *nm = old_method->code();

    if (nm != NULL) {

      nm->mark_for_deoptimization();

      number_of_marked_CodeBlobs++;

    }

  }

  FOR_ALL_ALIVE_NMETHODS(nm) {

    if (nm->is_marked_for_deoptimization()) {

      // ...Already marked in the previous pass; don't count it again.

    } else if (nm->is_evol_dependent_on(dependee())) {

      ResourceMark rm;

      nm->mark_for_deoptimization();

      number_of_marked_CodeBlobs++;

    } else  {

      // flush caches in case they refer to a redefined methodOop

      nm->clear_inline_caches();

    }

  }

  return number_of_marked_CodeBlobs;

}

#endif // HOTSWAP

// Deoptimize all methods

void CodeCache::mark_all_nmethods_for_deoptimization() {

  MutexLockerEx mu(CodeCache_lock, Mutex::_no_safepoint_check_flag);

  FOR_ALL_ALIVE_NMETHODS(nm) {

    nm->mark_for_deoptimization();

  }

}

int CodeCache::mark_for_deoptimization(methodOop dependee) {

  MutexLockerEx mu(CodeCache_lock, Mutex::_no_safepoint_check_flag);

  int number_of_marked_CodeBlobs = 0;

  FOR_ALL_ALIVE_NMETHODS(nm) {

    if (nm->is_dependent_on_method(dependee)) {

      ResourceMark rm;

      nm->mark_for_deoptimization();

      number_of_marked_CodeBlobs++;

    }

  }

  return number_of_marked_CodeBlobs;

}

void CodeCache::make_marked_nmethods_zombies() {

  assert(SafepointSynchronize::is_at_safepoint(), "must be at a safepoint");

  FOR_ALL_ALIVE_NMETHODS(nm) {

    if (nm->is_marked_for_deoptimization()) {

      // If the nmethod has already been made non-entrant and it can be converted

      // then zombie it now. Otherwise make it non-entrant and it will eventually

      // be zombied when it is no longer seen on the stack. Note that the nmethod

      // might be "entrant" and not on the stack and so could be zombied immediately

      // but we can't tell because we don't track it on stack until it becomes

      // non-entrant.

      if (nm->is_not_entrant() && nm->can_not_entrant_be_converted()) {

        nm->make_zombie();

      } else {

        nm->make_not_entrant();

      }

    }

  }

}

void CodeCache::make_marked_nmethods_not_entrant() {

  assert_locked_or_safepoint(CodeCache_lock);

  FOR_ALL_ALIVE_NMETHODS(nm) {

    if (nm->is_marked_for_deoptimization()) {

      nm->make_not_entrant();

    }

  }

}

void CodeCache::verify() {

  _heap->verify();

  FOR_ALL_ALIVE_BLOBS(p) {

    p->verify();

  }

}

//------------------------------------------------------------------------------------------------

// Non-product version

#ifndef PRODUCT

void CodeCache::verify_if_often() {

  if (VerifyCodeCacheOften) {

    _heap->verify();

  }

}

void CodeCache::print_internals() {

  int nmethodCount = 0;

  int runtimeStubCount = 0;

  int adapterCount = 0;

  int deoptimizationStubCount = 0;

  int uncommonTrapStubCount = 0;

  int bufferBlobCount = 0;

  int total = 0;

  int nmethodAlive = 0;

  int nmethodNotEntrant = 0;

  int nmethodZombie = 0;

  int nmethodUnloaded = 0;

  int nmethodJava = 0;

  int nmethodNative = 0;

  int maxCodeSize = 0;

  ResourceMark rm;

  CodeBlob *cb;