/*

 * 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 <new>

#include "classfile/classLoaderData.hpp"

#include "classfile/stringTable.hpp"

#include "code/codeCache.hpp"

#include "jvmtifiles/jvmtiEnv.hpp"

#include "memory/metadataFactory.hpp"

#include "memory/universe.hpp"

#include "oops/oop.inline.hpp"

#include "prims/wbtestmethods/parserTests.hpp"

#include "prims/whitebox.hpp"

#include "runtime/arguments.hpp"

#include "runtime/compilationPolicy.hpp"

#include "runtime/deoptimization.hpp"

#include "runtime/interfaceSupport.hpp"

#include "runtime/os.hpp"

#include "runtime/sweeper.hpp"

#include "runtime/javaCalls.hpp"

#include "runtime/thread.hpp"

#include "runtime/vm_version.hpp"

#include "utilities/array.hpp"

#include "utilities/debug.hpp"

#include "utilities/exceptions.hpp"

#include "utilities/macros.hpp"

#if INCLUDE_ALL_GCS

#include "gc_implementation/parallelScavenge/parallelScavengeHeap.inline.hpp"

#include "gc_implementation/g1/concurrentMark.hpp"

#include "gc_implementation/g1/concurrentMarkThread.hpp"

#include "gc_implementation/g1/g1CollectedHeap.inline.hpp"

#include "gc_implementation/g1/heapRegionRemSet.hpp"

#endif // INCLUDE_ALL_GCS

#if INCLUDE_NMT

#include "services/mallocSiteTable.hpp"

#include "services/memTracker.hpp"

#include "utilities/nativeCallStack.hpp"

#endif // INCLUDE_NMT

PRAGMA_FORMAT_MUTE_WARNINGS_FOR_GCC

#define SIZE_T_MAX_VALUE ((size_t) -1)

bool WhiteBox::_used = false;

volatile bool WhiteBox::compilation_locked = false;

class VM_WhiteBoxOperation : public VM_Operation {

 public:

  VM_WhiteBoxOperation()                         { }

  VMOp_Type type()                  const        { return VMOp_WhiteBoxOperation; }

  bool allow_nested_vm_operations() const        { return true; }

};

WB_ENTRY(jlong, WB_GetObjectAddress(JNIEnv* env, jobject o, jobject obj))

  return (jlong)(void*)JNIHandles::resolve(obj);

WB_END

WB_ENTRY(jint, WB_GetHeapOopSize(JNIEnv* env, jobject o))

  return heapOopSize;

WB_END

WB_ENTRY(jint, WB_GetVMPageSize(JNIEnv* env, jobject o))

  return os::vm_page_size();

WB_END

class WBIsKlassAliveClosure : public KlassClosure {

    Symbol* _name;

    bool _found;

public:

    WBIsKlassAliveClosure(Symbol* name) : _name(name), _found(false) {}

    void do_klass(Klass* k) {

      if (_found) return;

      Symbol* ksym = k->name();

      if (ksym->fast_compare(_name) == 0) {

        _found = true;

      }

    }

    bool found() const {

        return _found;

    }

};

WB_ENTRY(jboolean, WB_IsClassAlive(JNIEnv* env, jobject target, jstring name))

  Handle h_name = JNIHandles::resolve(name);

  if (h_name.is_null()) return false;

  Symbol* sym = java_lang_String::as_symbol(h_name, CHECK_false);

  TempNewSymbol tsym(sym); // Make sure to decrement reference count on sym on return

  WBIsKlassAliveClosure closure(sym);

  ClassLoaderDataGraph::classes_do(&closure);

  return closure.found();

WB_END

WB_ENTRY(void, WB_AddToBootstrapClassLoaderSearch(JNIEnv* env, jobject o, jstring segment)) {

#if INCLUDE_JVMTI

  ResourceMark rm;

  const char* seg = java_lang_String::as_utf8_string(JNIHandles::resolve_non_null(segment));

  JvmtiEnv* jvmti_env = JvmtiEnv::create_a_jvmti(JVMTI_VERSION);

  jvmtiError err = jvmti_env->AddToBootstrapClassLoaderSearch(seg);

  assert(err == JVMTI_ERROR_NONE, "must not fail");

#endif

}

WB_END

WB_ENTRY(void, WB_AddToSystemClassLoaderSearch(JNIEnv* env, jobject o, jstring segment)) {

#if INCLUDE_JVMTI

  ResourceMark rm;

  const char* seg = java_lang_String::as_utf8_string(JNIHandles::resolve_non_null(segment));

  JvmtiEnv* jvmti_env = JvmtiEnv::create_a_jvmti(JVMTI_VERSION);

  jvmtiError err = jvmti_env->AddToSystemClassLoaderSearch(seg);

  assert(err == JVMTI_ERROR_NONE, "must not fail");

#endif

}

WB_END

WB_ENTRY(jlong, WB_GetCompressedOopsMaxHeapSize(JNIEnv* env, jobject o)) {

  return (jlong)Arguments::max_heap_for_compressed_oops();

}

WB_END

WB_ENTRY(void, WB_PrintHeapSizes(JNIEnv* env, jobject o)) {

  CollectorPolicy * p = Universe::heap()->collector_policy();

  gclog_or_tty->print_cr("Minimum heap "SIZE_FORMAT" Initial heap "

    SIZE_FORMAT" Maximum heap "SIZE_FORMAT" Space alignment "SIZE_FORMAT" Heap alignment "SIZE_FORMAT,

    p->min_heap_byte_size(), p->initial_heap_byte_size(), p->max_heap_byte_size(),

    p->space_alignment(), p->heap_alignment());

}

WB_END

#ifndef PRODUCT

// Forward declaration

void TestReservedSpace_test();

void TestReserveMemorySpecial_test();

void TestVirtualSpace_test();

void TestMetaspaceAux_test();

#endif

WB_ENTRY(void, WB_RunMemoryUnitTests(JNIEnv* env, jobject o))

#ifndef PRODUCT

  TestReservedSpace_test();

  TestReserveMemorySpecial_test();

  TestVirtualSpace_test();

  TestMetaspaceAux_test();

#endif

WB_END

WB_ENTRY(void, WB_ReadFromNoaccessArea(JNIEnv* env, jobject o))

  size_t granularity = os::vm_allocation_granularity();

  VirtualSpace vs;

  vs.initialize(rhs, 50 * granularity);

  if (!( UseCompressedOops && rhs.base() != NULL &&

         Universe::narrow_oop_base() != NULL &&

         Universe::narrow_oop_use_implicit_null_checks() )) {

    tty->print_cr("WB_ReadFromNoaccessArea method is useless:\n "

                  "\tUseCompressedOops is %d\n"

                  "\trhs.base() is "PTR_FORMAT"\n"

                  "\tUniverse::narrow_oop_base() is "PTR_FORMAT"\n"

                  "\tUniverse::narrow_oop_use_implicit_null_checks() is %d",

                  UseCompressedOops,

                  rhs.base(),

                  Universe::narrow_oop_base(),

                  Universe::narrow_oop_use_implicit_null_checks());

    return;

  }

  tty->print_cr("Reading from no access area... ");

  tty->print_cr("*(vs.low_boundary() - rhs.noaccess_prefix() / 2 ) = %c",

                *(vs.low_boundary() - rhs.noaccess_prefix() / 2 ));

WB_END

static jint wb_stress_virtual_space_resize(size_t reserved_space_size,

                                           size_t magnitude, size_t iterations) {

  size_t granularity = os::vm_allocation_granularity();

  VirtualSpace vs;

  if (!vs.initialize(rhs, 0)) {

    tty->print_cr("Failed to initialize VirtualSpace. Can't proceed.");

    return 3;

  }

  long seed = os::random();

  tty->print_cr("Random seed is %ld", seed);

  os::init_random(seed);

  for (size_t i = 0; i < iterations; i++) {

    // Whether we will shrink or grow

    bool shrink = os::random() % 2L == 0;

    // Get random delta to resize virtual space

    size_t delta = (size_t)os::random() % magnitude;

    // If we are about to shrink virtual space below zero, then expand instead

    if (shrink && vs.committed_size() < delta) {

      shrink = false;

    }

    // Resizing by delta

    if (shrink) {

      vs.shrink_by(delta);

    } else {

      // If expanding fails expand_by will silently return false

      vs.expand_by(delta, true);

    }

  }

  return 0;

}

WB_ENTRY(jint, WB_StressVirtualSpaceResize(JNIEnv* env, jobject o,

        jlong reserved_space_size, jlong magnitude, jlong iterations))

  tty->print_cr("reservedSpaceSize="JLONG_FORMAT", magnitude="JLONG_FORMAT", "

                "iterations="JLONG_FORMAT"\n", reserved_space_size, magnitude,

                iterations);

  if (reserved_space_size < 0 || magnitude < 0 || iterations < 0) {

    tty->print_cr("One of variables printed above is negative. Can't proceed.\n");

    return 1;

  }

  // sizeof(size_t) depends on whether OS is 32bit or 64bit. sizeof(jlong) is

  // always 8 byte. That's why we should avoid overflow in case of 32bit platform.

  if (sizeof(size_t) < sizeof(jlong)) {

    jlong size_t_max_value = (jlong) SIZE_T_MAX_VALUE;

    if (reserved_space_size > size_t_max_value || magnitude > size_t_max_value

        || iterations > size_t_max_value) {

      tty->print_cr("One of variables printed above overflows size_t. Can't proceed.\n");

      return 2;

    }

  }

  return wb_stress_virtual_space_resize((size_t) reserved_space_size,

                                        (size_t) magnitude, (size_t) iterations);

WB_END

WB_ENTRY(jboolean, WB_isObjectInOldGen(JNIEnv* env, jobject o, jobject obj))

  oop p = JNIHandles::resolve(obj);

#if INCLUDE_ALL_GCS

  if (UseG1GC) {

    G1CollectedHeap* g1 = G1CollectedHeap::heap();

    const HeapRegion* hr = g1->heap_region_containing(p);

    if (hr == NULL) {

      return false;

    }

    return !(hr->is_young());

  } else if (UseParallelGC) {

    ParallelScavengeHeap* psh = ParallelScavengeHeap::heap();

    return !psh->is_in_young(p);

  }

#endif // INCLUDE_ALL_GCS

  GenCollectedHeap* gch = GenCollectedHeap::heap();

  return !gch->is_in_young(p);

WB_END

WB_ENTRY(jlong, WB_GetObjectSize(JNIEnv* env, jobject o, jobject obj))

  oop p = JNIHandles::resolve(obj);

  return p->size() * HeapWordSize;

WB_END

#if INCLUDE_ALL_GCS

WB_ENTRY(jboolean, WB_G1IsHumongous(JNIEnv* env, jobject o, jobject obj))

  G1CollectedHeap* g1 = G1CollectedHeap::heap();

  oop result = JNIHandles::resolve(obj);

  const HeapRegion* hr = g1->heap_region_containing(result);

  return hr->is_humongous();

WB_END

WB_ENTRY(jlong, WB_G1NumFreeRegions(JNIEnv* env, jobject o))

  G1CollectedHeap* g1 = G1CollectedHeap::heap();

  size_t nr = g1->num_free_regions();

  return (jlong)nr;

WB_END

WB_ENTRY(jboolean, WB_G1InConcurrentMark(JNIEnv* env, jobject o))

  G1CollectedHeap* g1 = G1CollectedHeap::heap();

  return g1->concurrent_mark()->cmThread()->during_cycle();

WB_END

WB_ENTRY(jboolean, WB_G1StartMarkCycle(JNIEnv* env, jobject o))

  G1CollectedHeap* g1h = G1CollectedHeap::heap();

  if (!g1h->concurrent_mark()->cmThread()->during_cycle()) {

    g1h->collect(GCCause::_wb_conc_mark);

    return true;

  }

  return false;

WB_END

WB_ENTRY(jint, WB_G1RegionSize(JNIEnv* env, jobject o))

  return (jint)HeapRegion::GrainBytes;

WB_END

#endif // INCLUDE_ALL_GCS

#if INCLUDE_NMT

// Alloc memory using the test memory type so that we can use that to see if

// NMT picks it up correctly

WB_ENTRY(jlong, WB_NMTMalloc(JNIEnv* env, jobject o, jlong size))

  jlong addr = 0;

  addr = (jlong)(uintptr_t)os::malloc(size, mtTest);

  return addr;

WB_END

// Alloc memory with pseudo call stack. The test can create psudo malloc

// allocation site to stress the malloc tracking.

WB_ENTRY(jlong, WB_NMTMallocWithPseudoStack(JNIEnv* env, jobject o, jlong size, jint pseudo_stack))

  address pc = (address)(size_t)pseudo_stack;

  NativeCallStack stack(&pc, 1);

  return (jlong)(uintptr_t)os::malloc(size, mtTest, stack);

WB_END

// Free the memory allocated by NMTAllocTest

WB_ENTRY(void, WB_NMTFree(JNIEnv* env, jobject o, jlong mem))

  os::free((void*)(uintptr_t)mem);

WB_END

WB_ENTRY(jlong, WB_NMTReserveMemory(JNIEnv* env, jobject o, jlong size))

  jlong addr = 0;

  addr = (jlong)(uintptr_t)os::reserve_memory(size);

  MemTracker::record_virtual_memory_type((address)addr, mtTest);

  return addr;

WB_END

WB_ENTRY(void, WB_NMTCommitMemory(JNIEnv* env, jobject o, jlong addr, jlong size))

  os::commit_memory((char *)(uintptr_t)addr, size, !ExecMem);

  MemTracker::record_virtual_memory_type((address)(uintptr_t)addr, mtTest);

WB_END

WB_ENTRY(void, WB_NMTUncommitMemory(JNIEnv* env, jobject o, jlong addr, jlong size))

  os::uncommit_memory((char *)(uintptr_t)addr, size);

WB_END

WB_ENTRY(void, WB_NMTReleaseMemory(JNIEnv* env, jobject o, jlong addr, jlong size))

  os::release_memory((char *)(uintptr_t)addr, size);

WB_END

WB_ENTRY(jboolean, WB_NMTIsDetailSupported(JNIEnv* env))

  return MemTracker::tracking_level() == NMT_detail;

WB_END

WB_ENTRY(jboolean, WB_NMTChangeTrackingLevel(JNIEnv* env))

  // Test that we can downgrade NMT levels but not upgrade them.

  if (MemTracker::tracking_level() == NMT_off) {

    MemTracker::transition_to(NMT_off);

    return MemTracker::tracking_level() == NMT_off;

  } else {

    assert(MemTracker::tracking_level() == NMT_detail, "Should start out as detail tracking");

    MemTracker::transition_to(NMT_summary);

    assert(MemTracker::tracking_level() == NMT_summary, "Should be summary now");

    // Can't go to detail once NMT is set to summary.

    MemTracker::transition_to(NMT_detail);

    assert(MemTracker::tracking_level() == NMT_summary, "Should still be summary now");

    // Shutdown sets tracking level to minimal.

    MemTracker::shutdown();

    assert(MemTracker::tracking_level() == NMT_minimal, "Should be minimal now");

    // Once the tracking level is minimal, we cannot increase to summary.

    // The code ignores this request instead of asserting because if the malloc site

    // table overflows in another thread, it tries to change the code to summary.

    MemTracker::transition_to(NMT_summary);

    assert(MemTracker::tracking_level() == NMT_minimal, "Should still be minimal now");

    // Really can never go up to detail, verify that the code would never do this.

    MemTracker::transition_to(NMT_detail);

    assert(MemTracker::tracking_level() == NMT_minimal, "Should still be minimal now");

    return MemTracker::tracking_level() == NMT_minimal;

  }

WB_END

WB_ENTRY(jint, WB_NMTGetHashSize(JNIEnv* env, jobject o))

  int hash_size = MallocSiteTable::hash_buckets();

  assert(hash_size > 0, "NMT hash_size should be > 0");

  return (jint)hash_size;

WB_END

#endif // INCLUDE_NMT

static jmethodID reflected_method_to_jmid(JavaThread* thread, JNIEnv* env, jobject method) {

  assert(method != NULL, "method should not be null");

  ThreadToNativeFromVM ttn(thread);

  return env->FromReflectedMethod(method);

}

// Deoptimizes all compiled frames and makes nmethods not entrant if it's requested

class VM_WhiteBoxDeoptimizeFrames : public VM_WhiteBoxOperation {

 private:

  int _result;

  const bool _make_not_entrant;

 public:

  VM_WhiteBoxDeoptimizeFrames(bool make_not_entrant) :

        _result(0), _make_not_entrant(make_not_entrant) { }

  int  result() const { return _result; }

  void doit() {

    for (JavaThread* t = Threads::first(); t != NULL; t = t->next()) {

      if (t->has_last_Java_frame()) {

        for (StackFrameStream fst(t, UseBiasedLocking); !fst.is_done(); fst.next()) {

          frame* f = fst.current();

          if (f->can_be_deoptimized() && !f->is_deoptimized_frame()) {

            RegisterMap* reg_map = fst.register_map();

            Deoptimization::deoptimize(t, *f, reg_map);

            if (_make_not_entrant) {

                nmethod* nm = CodeCache::find_nmethod(f->pc());

                assert(nm != NULL, "sanity check");

                nm->make_not_entrant();

            }

            ++_result;

          }

        }

      }

    }

  }

};

WB_ENTRY(jint, WB_DeoptimizeFrames(JNIEnv* env, jobject o, jboolean make_not_entrant))

  VM_WhiteBoxDeoptimizeFrames op(make_not_entrant == JNI_TRUE);

  VMThread::execute(&op);

  return op.result();

WB_END

WB_ENTRY(void, WB_DeoptimizeAll(JNIEnv* env, jobject o))

  MutexLockerEx mu(Compile_lock);

  CodeCache::mark_all_nmethods_for_deoptimization();

  VM_Deoptimize op;

  VMThread::execute(&op);

WB_END

WB_ENTRY(jint, WB_DeoptimizeMethod(JNIEnv* env, jobject o, jobject method, jboolean is_osr))

  jmethodID jmid = reflected_method_to_jmid(thread, env, method);

  int result = 0;

  CHECK_JNI_EXCEPTION_(env, result);

  MutexLockerEx mu(Compile_lock);

  methodHandle mh(THREAD, Method::checked_resolve_jmethod_id(jmid));

  if (is_osr) {

    result += mh->mark_osr_nmethods();

  } else if (mh->code() != NULL) {

    mh->code()->mark_for_deoptimization();

    ++result;

  }

  result += CodeCache::mark_for_deoptimization(mh());

  if (result > 0) {

    VM_Deoptimize op;

    VMThread::execute(&op);

  }

  return result;

WB_END

WB_ENTRY(jboolean, WB_IsMethodCompiled(JNIEnv* env, jobject o, jobject method, jboolean is_osr))

  jmethodID jmid = reflected_method_to_jmid(thread, env, method);

  CHECK_JNI_EXCEPTION_(env, JNI_FALSE);

  MutexLockerEx mu(Compile_lock);

  methodHandle mh(THREAD, Method::checked_resolve_jmethod_id(jmid));

  nmethod* code = is_osr ? mh->lookup_osr_nmethod_for(InvocationEntryBci, CompLevel_none, false) : mh->code();

  if (code == NULL) {

    return JNI_FALSE;

  }

  return (code->is_alive() && !code->is_marked_for_deoptimization());

WB_END

WB_ENTRY(jboolean, WB_IsMethodCompilable(JNIEnv* env, jobject o, jobject method, jint comp_level, jboolean is_osr))

  jmethodID jmid = reflected_method_to_jmid(thread, env, method);