/*

 * Copyright (c) 2018, 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 "classfile/javaClasses.inline.hpp"

#include "classfile/stringTable.hpp"

#include "classfile/symbolTable.hpp"

#include "classfile/vmSymbols.hpp"

#include "logging/log.hpp"

#include "logging/logMessage.hpp"

#include "logging/logStream.hpp"

#include "memory/filemap.hpp"

#include "memory/heapShared.inline.hpp"

#include "memory/iterator.inline.hpp"

#include "memory/metadataFactory.hpp"

#include "memory/metaspaceClosure.hpp"

#include "memory/resourceArea.hpp"

#include "oops/compressedOops.inline.hpp"

#include "oops/fieldStreams.hpp"

#include "oops/oop.inline.hpp"

#include "runtime/fieldDescriptor.inline.hpp"

#include "runtime/safepointVerifiers.hpp"

#include "utilities/bitMap.inline.hpp"

#if INCLUDE_G1GC

#include "gc/g1/g1CollectedHeap.hpp"

#endif

#if INCLUDE_CDS_JAVA_HEAP

bool HeapShared::_closed_archive_heap_region_mapped = false;

bool HeapShared::_open_archive_heap_region_mapped = false;

bool HeapShared::_archive_heap_region_fixed = false;

address   HeapShared::_narrow_oop_base;

int       HeapShared::_narrow_oop_shift;

//

// If you add new entries to the following tables, you should know what you're doing!

//

// Entry fields for shareable subgraphs archived in the closed archive heap

// region. Warning: Objects in the subgraphs should not have reference fields

// assigned at runtime.

static ArchivableStaticFieldInfo closed_archive_subgraph_entry_fields[] = {

  {"java/lang/Integer$IntegerCache",           "archivedCache"},

  {"java/lang/Long$LongCache",                 "archivedCache"},

  {"java/lang/Byte$ByteCache",                 "archivedCache"},

  {"java/lang/Short$ShortCache",               "archivedCache"},

  {"java/lang/Character$CharacterCache",       "archivedCache"},

};

// Entry fields for subgraphs archived in the open archive heap region.

static ArchivableStaticFieldInfo open_archive_subgraph_entry_fields[] = {

  {"jdk/internal/module/ArchivedModuleGraph",  "archivedSystemModules"},

  {"jdk/internal/module/ArchivedModuleGraph",  "archivedModuleFinder"},

  {"jdk/internal/module/ArchivedModuleGraph",  "archivedMainModule"},

  {"jdk/internal/module/ArchivedModuleGraph",  "archivedConfiguration"},

  {"java/util/ImmutableCollections$ListN",     "EMPTY_LIST"},

  {"java/util/ImmutableCollections$MapN",      "EMPTY_MAP"},

  {"java/util/ImmutableCollections$SetN",      "EMPTY_SET"},

  {"java/lang/module/Configuration",           "EMPTY_CONFIGURATION"},

};

const static int num_closed_archive_subgraph_entry_fields =

  sizeof(closed_archive_subgraph_entry_fields) / sizeof(ArchivableStaticFieldInfo);

const static int num_open_archive_subgraph_entry_fields =

  sizeof(open_archive_subgraph_entry_fields) / sizeof(ArchivableStaticFieldInfo);

////////////////////////////////////////////////////////////////

//

// Java heap object archiving support

//

////////////////////////////////////////////////////////////////

void HeapShared::fixup_mapped_heap_regions() {

  FileMapInfo *mapinfo = FileMapInfo::current_info();

  mapinfo->fixup_mapped_heap_regions();

  set_archive_heap_region_fixed();

}

unsigned HeapShared::oop_hash(oop const& p) {

  assert(!p->mark()->has_bias_pattern(),

         "this object should never have been locked");  // so identity_hash won't safepoin

  unsigned hash = (unsigned)p->identity_hash();

  return hash;

}

HeapShared::ArchivedObjectCache* HeapShared::_archived_object_cache = NULL;

oop HeapShared::find_archived_heap_object(oop obj) {

  assert(DumpSharedSpaces, "dump-time only");

  ArchivedObjectCache* cache = archived_object_cache();

  oop* p = cache->get(obj);

  if (p != NULL) {

    return *p;

  } else {

    return NULL;

  }

}

oop HeapShared::archive_heap_object(oop obj, Thread* THREAD) {

  assert(DumpSharedSpaces, "dump-time only");

  oop ao = find_archived_heap_object(obj);

  if (ao != NULL) {

    // already archived

    return ao;

  }

  int len = obj->size();

  if (G1CollectedHeap::heap()->is_archive_alloc_too_large(len)) {

    log_debug(cds, heap)("Cannot archive, object (" PTR_FORMAT ") is too large: " SIZE_FORMAT,

                         p2i(obj), (size_t)obj->size());

    return NULL;

  }

  // Pre-compute object identity hash at CDS dump time.

  obj->identity_hash();

  oop archived_oop = (oop)G1CollectedHeap::heap()->archive_mem_allocate(len);

  if (archived_oop != NULL) {

    Copy::aligned_disjoint_words((HeapWord*)obj, (HeapWord*)archived_oop, len);

    MetaspaceShared::relocate_klass_ptr(archived_oop);

    ArchivedObjectCache* cache = archived_object_cache();

    cache->put(obj, archived_oop);

    log_debug(cds, heap)("Archived heap object " PTR_FORMAT " ==> " PTR_FORMAT,

                         p2i(obj), p2i(archived_oop));

  } else {

    log_error(cds, heap)(

      "Cannot allocate space for object " PTR_FORMAT " in archived heap region",

      p2i(obj));

    vm_exit(1);

  }

  return archived_oop;

}

oop HeapShared::materialize_archived_object(narrowOop v) {

  assert(archive_heap_region_fixed(),

         "must be called after archive heap regions are fixed");

  if (!CompressedOops::is_null(v)) {

    oop obj = HeapShared::decode_from_archive(v);

    return G1CollectedHeap::heap()->materialize_archived_object(obj);

  }

  return NULL;

}

void HeapShared::archive_klass_objects(Thread* THREAD) {

  GrowableArray<Klass*>* klasses = MetaspaceShared::collected_klasses();

  assert(klasses != NULL, "sanity");

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

    Klass* k = klasses->at(i);

    // archive mirror object

    java_lang_Class::archive_mirror(k, CHECK);

    // archive the resolved_referenes array

    if (k->is_instance_klass()) {

      InstanceKlass* ik = InstanceKlass::cast(k);

      ik->constants()->archive_resolved_references(THREAD);

    }

  }

}

void HeapShared::archive_java_heap_objects(GrowableArray<MemRegion> *closed,

                                           GrowableArray<MemRegion> *open) {

  if (!is_heap_object_archiving_allowed()) {

    if (log_is_enabled(Info, cds)) {

      log_info(cds)(

        "Archived java heap is not supported as UseG1GC, "

        "UseCompressedOops and UseCompressedClassPointers are required."

        "Current settings: UseG1GC=%s, UseCompressedOops=%s, UseCompressedClassPointers=%s.",

        BOOL_TO_STR(UseG1GC), BOOL_TO_STR(UseCompressedOops),

        BOOL_TO_STR(UseCompressedClassPointers));

    }

    return;

  }

  {

    NoSafepointVerifier nsv;

    // Cache for recording where the archived objects are copied to

    create_archived_object_cache();

    tty->print_cr("Dumping objects to closed archive heap region ...");

    NOT_PRODUCT(StringTable::verify());

    copy_closed_archive_heap_objects(closed);

    tty->print_cr("Dumping objects to open archive heap region ...");

    copy_open_archive_heap_objects(open);

    destroy_archived_object_cache();

  }

  G1HeapVerifier::verify_archive_regions();

}

void HeapShared::copy_closed_archive_heap_objects(

                                    GrowableArray<MemRegion> * closed_archive) {

  assert(is_heap_object_archiving_allowed(), "Cannot archive java heap objects");

  Thread* THREAD = Thread::current();

  G1CollectedHeap::heap()->begin_archive_alloc_range();

  // Archive interned string objects

  StringTable::write_to_archive();

  archive_object_subgraphs(closed_archive_subgraph_entry_fields,

                           num_closed_archive_subgraph_entry_fields,

                           true /* is_closed_archive */, THREAD);

  G1CollectedHeap::heap()->end_archive_alloc_range(closed_archive,

                                                   os::vm_allocation_granularity());

}

void HeapShared::copy_open_archive_heap_objects(

                                    GrowableArray<MemRegion> * open_archive) {

  assert(is_heap_object_archiving_allowed(), "Cannot archive java heap objects");

  Thread* THREAD = Thread::current();

  G1CollectedHeap::heap()->begin_archive_alloc_range(true /* open */);

  java_lang_Class::archive_basic_type_mirrors(THREAD);

  archive_klass_objects(THREAD);

  archive_object_subgraphs(open_archive_subgraph_entry_fields,

                           num_open_archive_subgraph_entry_fields,

                           false /* is_closed_archive */,

                           THREAD);

  G1CollectedHeap::heap()->end_archive_alloc_range(open_archive,

                                                   os::vm_allocation_granularity());

}

void HeapShared::init_narrow_oop_decoding(address base, int shift) {

  _narrow_oop_base = base;

  _narrow_oop_shift = shift;

}

//

// Subgraph archiving support

//

HeapShared::DumpTimeKlassSubGraphInfoTable* HeapShared::_dump_time_subgraph_info_table = NULL;

HeapShared::RunTimeKlassSubGraphInfoTable   HeapShared::_run_time_subgraph_info_table;

// Get the subgraph_info for Klass k. A new subgraph_info is created if

// there is no existing one for k. The subgraph_info records the relocated

// Klass* of the original k.

KlassSubGraphInfo* HeapShared::get_subgraph_info(Klass* k) {

  assert(DumpSharedSpaces, "dump time only");

  Klass* relocated_k = MetaspaceShared::get_relocated_klass(k);

  KlassSubGraphInfo* info = _dump_time_subgraph_info_table->get(relocated_k);

  if (info == NULL) {

    _dump_time_subgraph_info_table->put(relocated_k, KlassSubGraphInfo(relocated_k));

    info = _dump_time_subgraph_info_table->get(relocated_k);

    ++ _dump_time_subgraph_info_table->_count;

  }

  return info;

}

// Add an entry field to the current KlassSubGraphInfo.

void KlassSubGraphInfo::add_subgraph_entry_field(

      int static_field_offset, oop v, bool is_closed_archive) {

  assert(DumpSharedSpaces, "dump time only");

  if (_subgraph_entry_fields == NULL) {

    _subgraph_entry_fields =

      new(ResourceObj::C_HEAP, mtClass) GrowableArray<juint>(10, true);

  }

  _subgraph_entry_fields->append((juint)static_field_offset);

  _subgraph_entry_fields->append(CompressedOops::encode(v));

  _subgraph_entry_fields->append(is_closed_archive ? 1 : 0);

}

// Add the Klass* for an object in the current KlassSubGraphInfo's subgraphs.

// Only objects of boot classes can be included in sub-graph.

void KlassSubGraphInfo::add_subgraph_object_klass(Klass* orig_k, Klass *relocated_k) {

  assert(DumpSharedSpaces, "dump time only");

  assert(relocated_k == MetaspaceShared::get_relocated_klass(orig_k),

         "must be the relocated Klass in the shared space");

  if (_subgraph_object_klasses == NULL) {

    _subgraph_object_klasses =

      new(ResourceObj::C_HEAP, mtClass) GrowableArray<Klass*>(50, true);

  }

  assert(relocated_k->is_shared(), "must be a shared class");

  if (_k == relocated_k) {

    // Don't add the Klass containing the sub-graph to it's own klass

    // initialization list.

    return;

  }

  if (relocated_k->is_instance_klass()) {

    assert(InstanceKlass::cast(relocated_k)->is_shared_boot_class(),

          "must be boot class");

    // SystemDictionary::xxx_klass() are not updated, need to check

    // the original Klass*

    if (orig_k == SystemDictionary::String_klass() ||

        orig_k == SystemDictionary::Object_klass()) {

      // Initialized early during VM initialization. No need to be added

      // to the sub-graph object class list.

      return;

    }

  } else if (relocated_k->is_objArray_klass()) {

    Klass* abk = ObjArrayKlass::cast(relocated_k)->bottom_klass();

    if (abk->is_instance_klass()) {

      assert(InstanceKlass::cast(abk)->is_shared_boot_class(),

            "must be boot class");

    }

    if (relocated_k == Universe::objectArrayKlassObj()) {

      // Initialized early during Universe::genesis. No need to be added

      // to the list.

      return;

    }

  } else {

    assert(relocated_k->is_typeArray_klass(), "must be");

    // Primitive type arrays are created early during Universe::genesis.

    return;

  }

  if (log_is_enabled(Debug, cds, heap)) {

    if (!_subgraph_object_klasses->contains(relocated_k)) {

      ResourceMark rm;

      log_debug(cds, heap)("Adding klass %s", orig_k->external_name());

    }

  }

  _subgraph_object_klasses->append_if_missing(relocated_k);

}

// Initialize an archived subgraph_info_record from the given KlassSubGraphInfo.

void ArchivedKlassSubGraphInfoRecord::init(KlassSubGraphInfo* info) {

  _k = info->klass();

  _entry_field_records = NULL;

  _subgraph_object_klasses = NULL;

  // populate the entry fields

  GrowableArray<juint>* entry_fields = info->subgraph_entry_fields();

  if (entry_fields != NULL) {

    int num_entry_fields = entry_fields->length();

    assert(num_entry_fields % 3 == 0, "sanity");

    _entry_field_records =

      MetaspaceShared::new_ro_array<juint>(num_entry_fields);

    for (int i = 0 ; i < num_entry_fields; i++) {

      _entry_field_records->at_put(i, entry_fields->at(i));

    }

  }

  // the Klasses of the objects in the sub-graphs

  GrowableArray<Klass*>* subgraph_object_klasses = info->subgraph_object_klasses();

  if (subgraph_object_klasses != NULL) {

    int num_subgraphs_klasses = subgraph_object_klasses->length();

    _subgraph_object_klasses =

      MetaspaceShared::new_ro_array<Klass*>(num_subgraphs_klasses);

    for (int i = 0; i < num_subgraphs_klasses; i++) {

      Klass* subgraph_k = subgraph_object_klasses->at(i);

      if (log_is_enabled(Info, cds, heap)) {

        ResourceMark rm;

        log_info(cds, heap)(

          "Archived object klass %s (%2d) => %s",

          _k->external_name(), i, subgraph_k->external_name());

      }

      _subgraph_object_klasses->at_put(i, subgraph_k);

    }

  }

}

struct CopyKlassSubGraphInfoToArchive : StackObj {

  CompactHashtableWriter* _writer;

  CopyKlassSubGraphInfoToArchive(CompactHashtableWriter* writer) : _writer(writer) {}

  bool do_entry(Klass* klass, KlassSubGraphInfo& info) {

    if (info.subgraph_object_klasses() != NULL || info.subgraph_entry_fields() != NULL) {

      ArchivedKlassSubGraphInfoRecord* record =

        (ArchivedKlassSubGraphInfoRecord*)MetaspaceShared::read_only_space_alloc(sizeof(ArchivedKlassSubGraphInfoRecord));

      record->init(&info);

      unsigned int hash = primitive_hash<Klass*>(klass);

      u4 delta = MetaspaceShared::object_delta_u4(record);

      _writer->add(hash, delta);

    }

    return true; // keep on iterating

  }

};

// Build the records of archived subgraph infos, which include:

// - Entry points to all subgraphs from the containing class mirror. The entry

//   points are static fields in the mirror. For each entry point, the field

//   offset, value and is_closed_archive flag are recorded in the sub-graph

//   info. The value is stored back to the corresponding field at runtime.

// - A list of klasses that need to be loaded/initialized before archived

//   java object sub-graph can be accessed at runtime.

void HeapShared::write_subgraph_info_table() {

  // Allocate the contents of the hashtable(s) inside the RO region of the CDS archive.

  DumpTimeKlassSubGraphInfoTable* d_table = _dump_time_subgraph_info_table;

  CompactHashtableStats stats;

  _run_time_subgraph_info_table.reset();

  int num_buckets = CompactHashtableWriter::default_num_buckets(d_table->_count);

  CompactHashtableWriter writer(num_buckets, &stats);

  CopyKlassSubGraphInfoToArchive copy(&writer);

  d_table->iterate(&copy);

  writer.dump(&_run_time_subgraph_info_table, "subgraphs");

}

void HeapShared::serialize_subgraph_info_table_header(SerializeClosure* soc) {

  _run_time_subgraph_info_table.serialize_header(soc);

}

void HeapShared::initialize_from_archived_subgraph(Klass* k) {

  if (!open_archive_heap_region_mapped()) {

    return; // nothing to do

  }

  assert(!DumpSharedSpaces, "Should not be called with DumpSharedSpaces");

  unsigned int hash = primitive_hash<Klass*>(k);

  const ArchivedKlassSubGraphInfoRecord* record = _run_time_subgraph_info_table.lookup(k, hash, 0);

  // Initialize from archived data. Currently this is done only

  // during VM initialization time. No lock is needed.

  if (record != NULL) {

    Thread* THREAD = Thread::current();

    int i;

    // Load/link/initialize the klasses of the objects in the subgraph.

    // NULL class loader is used.

    Array<Klass*>* klasses = record->subgraph_object_klasses();

    if (klasses != NULL) {

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

        Klass* obj_k = klasses->at(i);

        Klass* resolved_k = SystemDictionary::resolve_or_null(

                                              (obj_k)->name(), THREAD);

        if (resolved_k != obj_k) {

          assert(!SystemDictionary::is_well_known_klass(resolved_k),

                 "shared well-known classes must not be replaced by JVMTI ClassFileLoadHook");

          ResourceMark rm(THREAD);

          log_info(cds, heap)("Failed to load subgraph because %s was not loaded from archive",

                              resolved_k->external_name());

          return;

        }

        if ((obj_k)->is_instance_klass()) {

          InstanceKlass* ik = InstanceKlass::cast(obj_k);

          ik->initialize(THREAD);

        } else if ((obj_k)->is_objArray_klass()) {

          ObjArrayKlass* oak = ObjArrayKlass::cast(obj_k);

          oak->initialize(THREAD);

        }

      }

    }

    if (HAS_PENDING_EXCEPTION) {

      CLEAR_PENDING_EXCEPTION;

      // None of the field value will be set if there was an exception.

      // The java code will not see any of the archived objects in the

      // subgraphs referenced from k in this case.

      return;

    }

    // Load the subgraph entry fields from the record and store them back to

    // the corresponding fields within the mirror.

    oop m = k->java_mirror();

    Array<juint>* entry_field_records = record->entry_field_records();

    if (entry_field_records != NULL) {

      int efr_len = entry_field_records->length();

      assert(efr_len % 3 == 0, "sanity");

      for (i = 0; i < efr_len;) {

        int field_offset = entry_field_records->at(i);

        narrowOop nv = entry_field_records->at(i+1);

        int is_closed_archive = entry_field_records->at(i+2);

        oop v;

        if (is_closed_archive == 0) {

          // It's an archived object in the open archive heap regions, not shared.

          // The object refereced by the field becomes 'known' by GC from this

          // point. All objects in the subgraph reachable from the object are

          // also 'known' by GC.

          v = materialize_archived_object(nv);

        } else {

          // Shared object in the closed archive heap regions. Decode directly.