/*
 * Copyright (c) 2019, SAP SE. All rights reserved.
 * Copyright (c) 2019, 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/metaspace/chunkAllocSequence.hpp"
#include "memory/metaspace/chunkLevel.hpp"
#include "utilities/globalDefinitions.hpp"

namespace metaspace {

// A chunk allocation sequence which can be encoded with a simple const array.
class ConstantChunkAllocSequence : public ChunkAllocSequence {

  // integer array specifying chunk level allocation progression.
  // Last chunk is to be an endlessly repeated allocation.
  const chklvl_t* const _entries;
  const int _num_entries;

public:

  ConstantChunkAllocSequence(const chklvl_t* array, int num_entries)
    : _entries(array)
    , _num_entries(num_entries)
  {
    assert(_num_entries > 0, "must not be empty.");
  }

  chklvl_t get_next_chunk_level(int num_allocated) const {
    if (num_allocated >= _num_entries) {
      // Caller shall repeat last allocation
      return _entries[_num_entries - 1];
    }
    return _entries[num_allocated];
  }

};

// hard-coded chunk allocation sequences for various space types

static const chklvl_t g_sequ_standard_non_class[] = {
    chklvl::CHUNK_LEVEL_4K,
    chklvl::CHUNK_LEVEL_4K,
    chklvl::CHUNK_LEVEL_4K,
    chklvl::CHUNK_LEVEL_4K,
    chklvl::CHUNK_LEVEL_16K
    // .. repeat last
};

static const chklvl_t g_sequ_standard_class[] = {
    chklvl::CHUNK_LEVEL_2K,
    chklvl::CHUNK_LEVEL_2K,
    chklvl::CHUNK_LEVEL_2K,
    chklvl::CHUNK_LEVEL_2K,
    chklvl::CHUNK_LEVEL_16K
    // .. repeat last
};

static const chklvl_t g_sequ_anon_non_class[] = {
    chklvl::CHUNK_LEVEL_1K,
    // .. repeat last
};

static const chklvl_t g_sequ_anon_class[] = {
    chklvl::CHUNK_LEVEL_1K,
    // .. repeat last
};

static const chklvl_t g_sequ_refl_non_class[] = {
    chklvl::CHUNK_LEVEL_2K,
    chklvl::CHUNK_LEVEL_1K
    // .. repeat last
};

static const chklvl_t g_sequ_refl_class[] = {
    chklvl::CHUNK_LEVEL_1K,
    // .. repeat last
};

#define DEFINE_CLASS_FOR_ARRAY(what) \
  static ConstantChunkAllocSequence g_chunk_alloc_sequence_##what (g_sequ_##what, sizeof(g_sequ_##what)/sizeof(chklvl_t));

DEFINE_CLASS_FOR_ARRAY(standard_non_class)
DEFINE_CLASS_FOR_ARRAY(standard_class)
DEFINE_CLASS_FOR_ARRAY(anon_non_class)
DEFINE_CLASS_FOR_ARRAY(anon_class)
DEFINE_CLASS_FOR_ARRAY(refl_non_class)
DEFINE_CLASS_FOR_ARRAY(refl_class)


class BootLoaderChunkAllocSequence : public ChunkAllocSequence {

  // For now, this mirrors what the old code did
  // (see SpaceManager::get_initial_chunk_size() and SpaceManager::calc_chunk_size).

  // Not sure how much sense this still makes, especially with CDS - by default we
  // now load JDK classes from CDS and therefore most of the boot loader
  // chunks remain unoccupied.

  // Also, InitialBootClassLoaderMetaspaceSize was/is confusing since it only applies
  // to the non-class chunk.

  const bool _is_class;

  static chklvl_t calc_initial_chunk_level(bool is_class) {

    size_t word_size = 0;
    if (is_class) {
      // In the old version first class space chunk for boot loader was always medium class chunk size * 6.
      word_size = (32 * K * 6) / BytesPerWord;

    } else {
      //assert(InitialBootClassLoaderMetaspaceSize < chklvl::MAX_CHUNK_BYTE_SIZE,
      //       "InitialBootClassLoaderMetaspaceSize too large");
      word_size = MIN2(InitialBootClassLoaderMetaspaceSize,
                       chklvl::MAX_CHUNK_BYTE_SIZE) / BytesPerWord;
    }
    return chklvl::level_fitting_word_size(word_size);
  }

public:

  BootLoaderChunkAllocSequence(bool is_class)
    : _is_class(is_class)
  {}

  chklvl_t get_next_chunk_level(int num_allocated) const {
    if (num_allocated == 0) {
      return calc_initial_chunk_level(_is_class);
    }
    // bit arbitrary, but this is what the old code did. Can tweak later if needed.
    return chklvl::CHUNK_LEVEL_64K;
  }

};

static BootLoaderChunkAllocSequence g_chunk_alloc_sequence_boot_non_class(false);
static BootLoaderChunkAllocSequence g_chunk_alloc_sequence_boot_class(true);


const ChunkAllocSequence* ChunkAllocSequence::alloc_sequence_by_space_type(MetaspaceType space_type, bool is_class) {

  if (is_class) {
    switch(space_type) {
    case StandardMetaspaceType:          return &g_chunk_alloc_sequence_standard_class;
    case ReflectionMetaspaceType:        return &g_chunk_alloc_sequence_refl_class;
    case UnsafeAnonymousMetaspaceType:   return &g_chunk_alloc_sequence_anon_class;
    case BootMetaspaceType:              return &g_chunk_alloc_sequence_boot_non_class;
    default: ShouldNotReachHere();
    }
  } else {
    switch(space_type) {
    case StandardMetaspaceType:          return &g_chunk_alloc_sequence_standard_non_class;
    case ReflectionMetaspaceType:        return &g_chunk_alloc_sequence_refl_non_class;
    case UnsafeAnonymousMetaspaceType:   return &g_chunk_alloc_sequence_anon_non_class;
    case BootMetaspaceType:              return &g_chunk_alloc_sequence_boot_non_class;
    default: ShouldNotReachHere();
    }
  }

  return NULL;

}



} // namespace metaspace