/*

 * Copyright (c) 1997, 2014, Oracle and/or its affiliates. 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 Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA

 * or visit www.oracle.com if you need additional information or have any

 * questions.

 *

 */

#include "precompiled.hpp"

#include "memory/allocation.hpp"

#include "memory/allocation.inline.hpp"

#include "memory/genCollectedHeap.hpp"

#include "memory/metaspaceShared.hpp"

#include "memory/resourceArea.hpp"

#include "memory/universe.hpp"

#include "runtime/atomic.inline.hpp"

#include "runtime/os.hpp"

#include "runtime/task.hpp"

#include "runtime/threadCritical.hpp"

#include "services/memTracker.hpp"

#include "utilities/ostream.hpp"

void* StackObj::operator new(size_t size)     throw() { ShouldNotCallThis(); return 0; }

void  StackObj::operator delete(void* p)              { ShouldNotCallThis(); }

void* StackObj::operator new [](size_t size)  throw() { ShouldNotCallThis(); return 0; }

void  StackObj::operator delete [](void* p)           { ShouldNotCallThis(); }

void* _ValueObj::operator new(size_t size)    throw() { ShouldNotCallThis(); return 0; }

void  _ValueObj::operator delete(void* p)             { ShouldNotCallThis(); }

void* _ValueObj::operator new [](size_t size) throw() { ShouldNotCallThis(); return 0; }

void  _ValueObj::operator delete [](void* p)          { ShouldNotCallThis(); }

void* MetaspaceObj::operator new(size_t size, ClassLoaderData* loader_data,

                                 size_t word_size, bool read_only,

                                 MetaspaceObj::Type type, TRAPS) throw() {

  // Klass has it's own operator new

  return Metaspace::allocate(loader_data, word_size, read_only, type, THREAD);

}

bool MetaspaceObj::is_shared() const {

  return MetaspaceShared::is_in_shared_space(this);

}

bool MetaspaceObj::is_metaspace_object() const {

  return Metaspace::contains((void*)this);

}

void MetaspaceObj::print_address_on(outputStream* st) const {

  st->print(" {" INTPTR_FORMAT "}", p2i(this));

}

void* ResourceObj::operator new(size_t size, allocation_type type, MEMFLAGS flags) throw() {

  address res;

  switch (type) {

   case C_HEAP:

    res = (address)AllocateHeap(size, flags, CALLER_PC);

    DEBUG_ONLY(set_allocation_type(res, C_HEAP);)

    break;

   case RESOURCE_AREA:

    // new(size) sets allocation type RESOURCE_AREA.

    res = (address)operator new(size);

    break;

   default:

    ShouldNotReachHere();

  }

  return res;

}

void* ResourceObj::operator new [](size_t size, allocation_type type, MEMFLAGS flags) throw() {

  return (address) operator new(size, type, flags);

}

void* ResourceObj::operator new(size_t size, const std::nothrow_t&  nothrow_constant,

    allocation_type type, MEMFLAGS flags) throw() {

  //should only call this with std::nothrow, use other operator new() otherwise

  address res;

  switch (type) {

   case C_HEAP:

    res = (address)AllocateHeap(size, flags, CALLER_PC, AllocFailStrategy::RETURN_NULL);

    DEBUG_ONLY(if (res!= NULL) set_allocation_type(res, C_HEAP);)

    break;

   case RESOURCE_AREA:

    // new(size) sets allocation type RESOURCE_AREA.

    res = (address)operator new(size, std::nothrow);

    break;

   default:

    ShouldNotReachHere();

  }

  return res;

}

void* ResourceObj::operator new [](size_t size, const std::nothrow_t&  nothrow_constant,

    allocation_type type, MEMFLAGS flags) throw() {

  return (address)operator new(size, nothrow_constant, type, flags);

}

void ResourceObj::operator delete(void* p) {

  assert(((ResourceObj *)p)->allocated_on_C_heap(),

         "delete only allowed for C_HEAP objects");

  DEBUG_ONLY(((ResourceObj *)p)->_allocation_t[0] = (uintptr_t)badHeapOopVal;)

  FreeHeap(p);

}

void ResourceObj::operator delete [](void* p) {

  operator delete(p);

}

#ifdef ASSERT

void ResourceObj::set_allocation_type(address res, allocation_type type) {

    // Set allocation type in the resource object

    uintptr_t allocation = (uintptr_t)res;

    assert((allocation & allocation_mask) == 0, err_msg("address should be aligned to 4 bytes at least: " INTPTR_FORMAT, p2i(res)));

    assert(type <= allocation_mask, "incorrect allocation type");

    ResourceObj* resobj = (ResourceObj *)res;

    resobj->_allocation_t[0] = ~(allocation + type);

    if (type != STACK_OR_EMBEDDED) {

      // Called from operator new() and CollectionSetChooser(),

      // set verification value.

      resobj->_allocation_t[1] = (uintptr_t)&(resobj->_allocation_t[1]) + type;

    }

}

ResourceObj::allocation_type ResourceObj::get_allocation_type() const {

    assert(~(_allocation_t[0] | allocation_mask) == (uintptr_t)this, "lost resource object");

    return (allocation_type)((~_allocation_t[0]) & allocation_mask);

}

bool ResourceObj::is_type_set() const {

    allocation_type type = (allocation_type)(_allocation_t[1] & allocation_mask);

    return get_allocation_type()  == type &&

           (_allocation_t[1] - type) == (uintptr_t)(&_allocation_t[1]);

}

ResourceObj::ResourceObj() { // default constructor

    if (~(_allocation_t[0] | allocation_mask) != (uintptr_t)this) {

      // Operator new() is not called for allocations

      // on stack and for embedded objects.

      set_allocation_type((address)this, STACK_OR_EMBEDDED);

    } else if (allocated_on_stack()) { // STACK_OR_EMBEDDED

      // For some reason we got a value which resembles

      // an embedded or stack object (operator new() does not

      // set such type). Keep it since it is valid value

      // (even if it was garbage).

      // Ignore garbage in other fields.

    } else if (is_type_set()) {

      // Operator new() was called and type was set.

      assert(!allocated_on_stack(),

             err_msg("not embedded or stack, this(" PTR_FORMAT ") type %d a[0]=(" PTR_FORMAT ") a[1]=(" PTR_FORMAT ")",

                     p2i(this), get_allocation_type(), _allocation_t[0], _allocation_t[1]));

    } else {

      // Operator new() was not called.

      // Assume that it is embedded or stack object.

      set_allocation_type((address)this, STACK_OR_EMBEDDED);

    }

    _allocation_t[1] = 0; // Zap verification value

}

ResourceObj::ResourceObj(const ResourceObj& r) { // default copy constructor

    // Used in ClassFileParser::parse_constant_pool_entries() for ClassFileStream.

    // Note: garbage may resembles valid value.

    assert(~(_allocation_t[0] | allocation_mask) != (uintptr_t)this || !is_type_set(),

           err_msg("embedded or stack only, this(" PTR_FORMAT ") type %d a[0]=(" PTR_FORMAT ") a[1]=(" PTR_FORMAT ")",

                   p2i(this), get_allocation_type(), _allocation_t[0], _allocation_t[1]));

    set_allocation_type((address)this, STACK_OR_EMBEDDED);

    _allocation_t[1] = 0; // Zap verification value

}

ResourceObj& ResourceObj::operator=(const ResourceObj& r) { // default copy assignment

    // Used in InlineTree::ok_to_inline() for WarmCallInfo.

    assert(allocated_on_stack(),

           err_msg("copy only into local, this(" PTR_FORMAT ") type %d a[0]=(" PTR_FORMAT ") a[1]=(" PTR_FORMAT ")",

                   p2i(this), get_allocation_type(), _allocation_t[0], _allocation_t[1]));

    // Keep current _allocation_t value;

    return *this;

}

ResourceObj::~ResourceObj() {

    // allocated_on_C_heap() also checks that encoded (in _allocation) address == this.

    if (!allocated_on_C_heap()) { // ResourceObj::delete() will zap _allocation for C_heap.

      _allocation_t[0] = (uintptr_t)badHeapOopVal; // zap type

    }

}

#endif // ASSERT

void trace_heap_malloc(size_t size, const char* name, void* p) {

  // A lock is not needed here - tty uses a lock internally

  tty->print_cr("Heap malloc " INTPTR_FORMAT " " SIZE_FORMAT " %s", p2i(p), size, name == NULL ? "" : name);

}

void trace_heap_free(void* p) {

  // A lock is not needed here - tty uses a lock internally

  tty->print_cr("Heap free   " INTPTR_FORMAT, p2i(p));

}

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

// ChunkPool implementation

// MT-safe pool of chunks to reduce malloc/free thrashing

// NB: not using Mutex because pools are used before Threads are initialized

class ChunkPool: public CHeapObj<mtInternal> {

  Chunk*       _first;        // first cached Chunk; its first word points to next chunk

  size_t       _num_chunks;   // number of unused chunks in pool

  size_t       _num_used;     // number of chunks currently checked out

  const size_t _size;         // size of each chunk (must be uniform)

  // Our four static pools

  static ChunkPool* _large_pool;

  static ChunkPool* _medium_pool;

  static ChunkPool* _small_pool;

  static ChunkPool* _tiny_pool;

  // return first element or null

  void* get_first() {

    Chunk* c = _first;

    if (_first) {

      _first = _first->next();

      _num_chunks--;

    }

    return c;

  }

 public:

  // All chunks in a ChunkPool has the same size

   ChunkPool(size_t size) : _size(size) { _first = NULL; _num_chunks = _num_used = 0; }

  // Allocate a new chunk from the pool (might expand the pool)

  _NOINLINE_ void* allocate(size_t bytes, AllocFailType alloc_failmode) {

    assert(bytes == _size, "bad size");

    void* p = NULL;

    // No VM lock can be taken inside ThreadCritical lock, so os::malloc

    // should be done outside ThreadCritical lock due to NMT

    { ThreadCritical tc;

      _num_used++;

      p = get_first();

    }

    if (p == NULL) p = os::malloc(bytes, mtChunk, CURRENT_PC);

    if (p == NULL && alloc_failmode == AllocFailStrategy::EXIT_OOM) {

      vm_exit_out_of_memory(bytes, OOM_MALLOC_ERROR, "ChunkPool::allocate");

    }

    return p;

  }

  // Return a chunk to the pool

  void free(Chunk* chunk) {

    assert(chunk->length() + Chunk::aligned_overhead_size() == _size, "bad size");

    ThreadCritical tc;

    _num_used--;

    // Add chunk to list

    chunk->set_next(_first);

    _first = chunk;

    _num_chunks++;

  }

  // Prune the pool

  void free_all_but(size_t n) {

    Chunk* cur = NULL;

    Chunk* next;

    {

    // if we have more than n chunks, free all of them

    ThreadCritical tc;

    if (_num_chunks > n) {

      // free chunks at end of queue, for better locality

        cur = _first;

      for (size_t i = 0; i < (n - 1) && cur != NULL; i++) cur = cur->next();

      if (cur != NULL) {

          next = cur->next();

        cur->set_next(NULL);

        cur = next;

          _num_chunks = n;

        }

      }

    }

    // Free all remaining chunks, outside of ThreadCritical

    // to avoid deadlock with NMT

        while(cur != NULL) {

          next = cur->next();

      os::free(cur, mtChunk);

          cur = next;

        }

      }

  // Accessors to preallocated pool's

  static ChunkPool* large_pool()  { assert(_large_pool  != NULL, "must be initialized"); return _large_pool;  }

  static ChunkPool* medium_pool() { assert(_medium_pool != NULL, "must be initialized"); return _medium_pool; }

  static ChunkPool* small_pool()  { assert(_small_pool  != NULL, "must be initialized"); return _small_pool;  }

  static ChunkPool* tiny_pool()   { assert(_tiny_pool   != NULL, "must be initialized"); return _tiny_pool;   }

  static void initialize() {

    _large_pool  = new ChunkPool(Chunk::size        + Chunk::aligned_overhead_size());

    _medium_pool = new ChunkPool(Chunk::medium_size + Chunk::aligned_overhead_size());

    _small_pool  = new ChunkPool(Chunk::init_size   + Chunk::aligned_overhead_size());

    _tiny_pool   = new ChunkPool(Chunk::tiny_size   + Chunk::aligned_overhead_size());

  }

  static void clean() {

    enum { BlocksToKeep = 5 };

     _tiny_pool->free_all_but(BlocksToKeep);

     _small_pool->free_all_but(BlocksToKeep);

     _medium_pool->free_all_but(BlocksToKeep);

     _large_pool->free_all_but(BlocksToKeep);

  }

};

ChunkPool* ChunkPool::_large_pool  = NULL;

ChunkPool* ChunkPool::_medium_pool = NULL;

ChunkPool* ChunkPool::_small_pool  = NULL;

ChunkPool* ChunkPool::_tiny_pool   = NULL;

void chunkpool_init() {

  ChunkPool::initialize();

}

void

Chunk::clean_chunk_pool() {

  ChunkPool::clean();

}

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

// ChunkPoolCleaner implementation

//

class ChunkPoolCleaner : public PeriodicTask {

  enum { CleaningInterval = 5000 };      // cleaning interval in ms

 public:

   ChunkPoolCleaner() : PeriodicTask(CleaningInterval) {}

   void task() {

     ChunkPool::clean();

   }

};

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

// Chunk implementation

void* Chunk::operator new (size_t requested_size, AllocFailType alloc_failmode, size_t length) throw() {

  // requested_size is equal to sizeof(Chunk) but in order for the arena

  // allocations to come out aligned as expected the size must be aligned

  // to expected arena alignment.

  // expect requested_size but if sizeof(Chunk) doesn't match isn't proper size we must align it.

  assert(ARENA_ALIGN(requested_size) == aligned_overhead_size(), "Bad alignment");

  size_t bytes = ARENA_ALIGN(requested_size) + length;

  switch (length) {

   case Chunk::size:        return ChunkPool::large_pool()->allocate(bytes, alloc_failmode);

   case Chunk::medium_size: return ChunkPool::medium_pool()->allocate(bytes, alloc_failmode);

   case Chunk::init_size:   return ChunkPool::small_pool()->allocate(bytes, alloc_failmode);

   case Chunk::tiny_size:   return ChunkPool::tiny_pool()->allocate(bytes, alloc_failmode);

   default: {

     void* p = os::malloc(bytes, mtChunk, CALLER_PC);

     if (p == NULL && alloc_failmode == AllocFailStrategy::EXIT_OOM) {

       vm_exit_out_of_memory(bytes, OOM_MALLOC_ERROR, "Chunk::new");

     }

     return p;

   }

  }

}

void Chunk::operator delete(void* p) {

  Chunk* c = (Chunk*)p;

  switch (c->length()) {

   case Chunk::size:        ChunkPool::large_pool()->free(c); break;

   case Chunk::medium_size: ChunkPool::medium_pool()->free(c); break;

   case Chunk::init_size:   ChunkPool::small_pool()->free(c); break;

   case Chunk::tiny_size:   ChunkPool::tiny_pool()->free(c); break;

   default:                 os::free(c, mtChunk);

  }

}

Chunk::Chunk(size_t length) : _len(length) {

  _next = NULL;         // Chain on the linked list

}

void Chunk::chop() {

  Chunk *k = this;

  while( k ) {

    Chunk *tmp = k->next();

    // clear out this chunk (to detect allocation bugs)

    if (ZapResourceArea) memset(k->bottom(), badResourceValue, k->length());

    delete k;                   // Free chunk (was malloc'd)

    k = tmp;

  }

}

void Chunk::next_chop() {

  _next->chop();

  _next = NULL;

}

void Chunk::start_chunk_pool_cleaner_task() {

#ifdef ASSERT

  static bool task_created = false;

  assert(!task_created, "should not start chuck pool cleaner twice");

  task_created = true;

#endif

  ChunkPoolCleaner* cleaner = new ChunkPoolCleaner();

  cleaner->enroll();

}

//------------------------------Arena------------------------------------------

Arena::Arena(MEMFLAGS flag, size_t init_size) : _flags(flag), _size_in_bytes(0)  {

  size_t round_size = (sizeof (char *)) - 1;

  init_size = (init_size+round_size) & ~round_size;

  _first = _chunk = new (AllocFailStrategy::EXIT_OOM, init_size) Chunk(init_size);

  _hwm = _chunk->bottom();      // Save the cached hwm, max

  _max = _chunk->top();

  MemTracker::record_new_arena(flag);

  set_size_in_bytes(init_size);

}

Arena::Arena(MEMFLAGS flag) : _flags(flag), _size_in_bytes(0) {

  _first = _chunk = new (AllocFailStrategy::EXIT_OOM, Chunk::init_size) Chunk(Chunk::init_size);

  _hwm = _chunk->bottom();      // Save the cached hwm, max

  _max = _chunk->top();

  MemTracker::record_new_arena(flag);

  set_size_in_bytes(Chunk::init_size);

}

Arena *Arena::move_contents(Arena *copy) {

  copy->destruct_contents();

  copy->_chunk = _chunk;

  copy->_hwm   = _hwm;

  copy->_max   = _max;

  copy->_first = _first;

  // workaround rare racing condition, which could double count

  // the arena size by native memory tracking

  size_t size = size_in_bytes();

  set_size_in_bytes(0);

  copy->set_size_in_bytes(size);

  // Destroy original arena

  reset();

  return copy;            // Return Arena with contents

}

Arena::~Arena() {

  destruct_contents();

  MemTracker::record_arena_free(_flags);

}

void* Arena::operator new(size_t size) throw() {

  assert(false, "Use dynamic memory type binding");

  return NULL;

}

void* Arena::operator new (size_t size, const std::nothrow_t&  nothrow_constant) throw() {

  assert(false, "Use dynamic memory type binding");

  return NULL;

}

  // dynamic memory type binding

void* Arena::operator new(size_t size, MEMFLAGS flags) throw() {

#ifdef ASSERT

  void* p = (void*)AllocateHeap(size, flags, CALLER_PC);

  if (PrintMallocFree) trace_heap_malloc(size, "Arena-new", p);

  return p;

#else

  return (void *) AllocateHeap(size, flags, CALLER_PC);

#endif

}

void* Arena::operator new(size_t size, const std::nothrow_t& nothrow_constant, MEMFLAGS flags) throw() {

#ifdef ASSERT

  void* p = os::malloc(size, flags, CALLER_PC);

  if (PrintMallocFree) trace_heap_malloc(size, "Arena-new", p);

  return p;

#else

  return os::malloc(size, flags, CALLER_PC);

#endif

}

void Arena::operator delete(void* p) {

  FreeHeap(p);

}