/*

 * Copyright (c) 1997, 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.  Oracle designates this

 * particular file as subject to the "Classpath" exception as provided

 * by Oracle in the LICENSE file that accompanied this code.

 *

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

 */

#ifndef _JAVASOFT_JVM_H_

#define _JAVASOFT_JVM_H_

#include <sys/stat.h>

#include "jni.h"

#include "jvm_md.h"

#ifdef __cplusplus

extern "C" {

#endif

/*

 * This file contains additional functions exported from the VM.

 * These functions are complementary to the standard JNI support.

 * There are three parts to this file:

 *

 * First, this file contains the VM-related functions needed by native

 * libraries in the standard Java API. For example, the java.lang.Object

 * class needs VM-level functions that wait for and notify monitors.

 *

 * Second, this file contains the functions and constant definitions

 * needed by the byte code verifier and class file format checker.

 * These functions allow the verifier and format checker to be written

 * in a VM-independent way.

 *

 * Third, this file contains various I/O and network operations needed

 * by the standard Java I/O and network APIs.

 */

/*

 * Bump the version number when either of the following happens:

 *

 * 1. There is a change in JVM_* functions.

 *

 * 2. There is a change in the contract between VM and Java classes.

 *    For example, if the VM relies on a new private field in Thread

 *    class.

 */

#define JVM_INTERFACE_VERSION 6

JNIEXPORT jint JNICALL

JVM_GetInterfaceVersion(void);

/*************************************************************************

 PART 1: Functions for Native Libraries

 ************************************************************************/

/*

 * java.lang.Object

 */

JNIEXPORT jint JNICALL

JVM_IHashCode(JNIEnv *env, jobject obj);

JNIEXPORT void JNICALL

JVM_MonitorWait(JNIEnv *env, jobject obj, jlong ms);

JNIEXPORT void JNICALL

JVM_MonitorNotify(JNIEnv *env, jobject obj);

JNIEXPORT void JNICALL

JVM_MonitorNotifyAll(JNIEnv *env, jobject obj);

JNIEXPORT jobject JNICALL

JVM_Clone(JNIEnv *env, jobject obj);

/*

 * java.lang.String

 */

JNIEXPORT jstring JNICALL

JVM_InternString(JNIEnv *env, jstring str);

/*

 * java.lang.System

 */

JNIEXPORT jlong JNICALL

JVM_CurrentTimeMillis(JNIEnv *env, jclass ignored);

JNIEXPORT jlong JNICALL

JVM_NanoTime(JNIEnv *env, jclass ignored);

JNIEXPORT jlong JNICALL

JVM_GetNanoTimeAdjustment(JNIEnv *env, jclass ignored, jlong offset_secs);

JNIEXPORT void JNICALL

JVM_ArrayCopy(JNIEnv *env, jclass ignored, jobject src, jint src_pos,

              jobject dst, jint dst_pos, jint length);

/*

 * Return an array of all properties as alternating name and value pairs.

 */

JNIEXPORT jobjectArray JNICALL

JVM_GetProperties(JNIEnv *env);

/*

 * java.lang.Runtime

 */

JNIEXPORT void JNICALL

JVM_BeforeHalt();

JNIEXPORT void JNICALL

JVM_Halt(jint code);

JNIEXPORT void JNICALL

JVM_GC(void);

/* Returns the number of real-time milliseconds that have elapsed since the

 * least-recently-inspected heap object was last inspected by the garbage

 * collector.

 *

 * For simple stop-the-world collectors this value is just the time

 * since the most recent collection.  For generational collectors it is the

 * time since the oldest generation was most recently collected.  Other

 * collectors are free to return a pessimistic estimate of the elapsed time, or

 * simply the time since the last full collection was performed.

 *

 * Note that in the presence of reference objects, a given object that is no

 * longer strongly reachable may have to be inspected multiple times before it

 * can be reclaimed.

 */

JNIEXPORT jlong JNICALL

JVM_MaxObjectInspectionAge(void);

JNIEXPORT jlong JNICALL

JVM_TotalMemory(void);

JNIEXPORT jlong JNICALL

JVM_FreeMemory(void);

JNIEXPORT jlong JNICALL

JVM_MaxMemory(void);

JNIEXPORT jint JNICALL

JVM_ActiveProcessorCount(void);

JNIEXPORT void * JNICALL

JVM_LoadLibrary(const char *name);

JNIEXPORT void JNICALL

JVM_UnloadLibrary(void * handle);

JNIEXPORT void * JNICALL

JVM_FindLibraryEntry(void *handle, const char *name);

JNIEXPORT jboolean JNICALL

JVM_IsSupportedJNIVersion(jint version);

JNIEXPORT jobjectArray JNICALL

JVM_GetVmArguments(JNIEnv *env);

JNIEXPORT void JNICALL

JVM_InitializeFromArchive(JNIEnv* env, jclass cls);

/*

 * java.lang.Throwable

 */

JNIEXPORT void JNICALL

JVM_FillInStackTrace(JNIEnv *env, jobject throwable);

/*

 * java.lang.StackTraceElement

 */

JNIEXPORT void JNICALL

JVM_InitStackTraceElementArray(JNIEnv *env, jobjectArray elements, jobject throwable);

JNIEXPORT void JNICALL

JVM_InitStackTraceElement(JNIEnv* env, jobject element, jobject stackFrameInfo);

/*

 * java.lang.StackWalker

 */

enum {

  JVM_STACKWALK_FILL_CLASS_REFS_ONLY       = 0x2,

  JVM_STACKWALK_GET_CALLER_CLASS           = 0x04,

  JVM_STACKWALK_SHOW_HIDDEN_FRAMES         = 0x20,

  JVM_STACKWALK_FILL_LIVE_STACK_FRAMES     = 0x100

};

JNIEXPORT jobject JNICALL

JVM_CallStackWalk(JNIEnv *env, jobject stackStream, jlong mode,

                  jint skip_frames, jint frame_count, jint start_index,

                  jobjectArray frames);

JNIEXPORT jint JNICALL

JVM_MoreStackWalk(JNIEnv *env, jobject stackStream, jlong mode, jlong anchor,

                  jint frame_count, jint start_index,

                  jobjectArray frames);

/*

 * java.lang.Thread

 */

JNIEXPORT void JNICALL

JVM_StartThread(JNIEnv *env, jobject thread);

JNIEXPORT void JNICALL

JVM_StopThread(JNIEnv *env, jobject thread, jobject exception);

JNIEXPORT jboolean JNICALL

JVM_IsThreadAlive(JNIEnv *env, jobject thread);

JNIEXPORT void JNICALL

JVM_SuspendThread(JNIEnv *env, jobject thread);

JNIEXPORT void JNICALL

JVM_ResumeThread(JNIEnv *env, jobject thread);

JNIEXPORT void JNICALL

JVM_SetThreadPriority(JNIEnv *env, jobject thread, jint prio);

JNIEXPORT void JNICALL

JVM_Yield(JNIEnv *env, jclass threadClass);

JNIEXPORT void JNICALL

JVM_Sleep(JNIEnv *env, jclass threadClass, jlong millis);

JNIEXPORT jobject JNICALL

JVM_CurrentThread(JNIEnv *env, jclass threadClass);

JNIEXPORT jint JNICALL

JVM_CountStackFrames(JNIEnv *env, jobject thread);

JNIEXPORT void JNICALL

JVM_Interrupt(JNIEnv *env, jobject thread);

JNIEXPORT jboolean JNICALL

JVM_IsInterrupted(JNIEnv *env, jobject thread, jboolean clearInterrupted);

JNIEXPORT jboolean JNICALL

JVM_HoldsLock(JNIEnv *env, jclass threadClass, jobject obj);

JNIEXPORT void JNICALL

JVM_DumpAllStacks(JNIEnv *env, jclass unused);

JNIEXPORT jobjectArray JNICALL

JVM_GetAllThreads(JNIEnv *env, jclass dummy);

JNIEXPORT void JNICALL

JVM_SetNativeThreadName(JNIEnv *env, jobject jthread, jstring name);

/* getStackTrace() and getAllStackTraces() method */

JNIEXPORT jobjectArray JNICALL

JVM_DumpThreads(JNIEnv *env, jclass threadClass, jobjectArray threads);

/*

 * java.lang.SecurityManager

 */

JNIEXPORT jobjectArray JNICALL

JVM_GetClassContext(JNIEnv *env);

/*

 * java.lang.Package

 */

JNIEXPORT jstring JNICALL

JVM_GetSystemPackage(JNIEnv *env, jstring name);

JNIEXPORT jobjectArray JNICALL

JVM_GetSystemPackages(JNIEnv *env);

/*

 * java.lang.ref.Reference

 */

JNIEXPORT jobject JNICALL

JVM_GetAndClearReferencePendingList(JNIEnv *env);

JNIEXPORT jboolean JNICALL

JVM_HasReferencePendingList(JNIEnv *env);

JNIEXPORT void JNICALL

JVM_WaitForReferencePendingList(JNIEnv *env);

/*

 * java.io.ObjectInputStream

 */

JNIEXPORT jobject JNICALL

JVM_LatestUserDefinedLoader(JNIEnv *env);

/*

 * java.lang.reflect.Array

 */

JNIEXPORT jint JNICALL

JVM_GetArrayLength(JNIEnv *env, jobject arr);

JNIEXPORT jobject JNICALL

JVM_GetArrayElement(JNIEnv *env, jobject arr, jint index);

JNIEXPORT jvalue JNICALL

JVM_GetPrimitiveArrayElement(JNIEnv *env, jobject arr, jint index, jint wCode);

JNIEXPORT void JNICALL

JVM_SetArrayElement(JNIEnv *env, jobject arr, jint index, jobject val);

JNIEXPORT void JNICALL

JVM_SetPrimitiveArrayElement(JNIEnv *env, jobject arr, jint index, jvalue v,

                             unsigned char vCode);

JNIEXPORT jobject JNICALL

JVM_NewArray(JNIEnv *env, jclass eltClass, jint length);

JNIEXPORT jobject JNICALL

JVM_NewMultiArray(JNIEnv *env, jclass eltClass, jintArray dim);

/*

 * Returns the immediate caller class of the native method invoking

 * JVM_GetCallerClass.  The Method.invoke and other frames due to

 * reflection machinery are skipped.

 *

 * The caller is expected to be marked with

 * jdk.internal.reflect.CallerSensitive. The JVM will throw an

 * error if it is not marked properly.

 */

JNIEXPORT jclass JNICALL

JVM_GetCallerClass(JNIEnv *env);

/*

 * Find primitive classes

 * utf: class name

 */

JNIEXPORT jclass JNICALL

JVM_FindPrimitiveClass(JNIEnv *env, const char *utf);

/*

 * Find a class from a boot class loader. Returns NULL if class not found.

 */

JNIEXPORT jclass JNICALL

JVM_FindClassFromBootLoader(JNIEnv *env, const char *name);

/*

 * Find a class from a given class loader.  Throws ClassNotFoundException.

 *  name:   name of class

 *  init:   whether initialization is done

 *  loader: class loader to look up the class. This may not be the same as the caller's

 *          class loader.

 *  caller: initiating class. The initiating class may be null when a security

 *          manager is not installed.

 */

JNIEXPORT jclass JNICALL

JVM_FindClassFromCaller(JNIEnv *env, const char *name, jboolean init,

                        jobject loader, jclass caller);

/*

 * Find a class from a given class.

 */

JNIEXPORT jclass JNICALL

JVM_FindClassFromClass(JNIEnv *env, const char *name, jboolean init,

                             jclass from);

/* Find a loaded class cached by the VM */

JNIEXPORT jclass JNICALL

JVM_FindLoadedClass(JNIEnv *env, jobject loader, jstring name);

/* Define a class */

JNIEXPORT jclass JNICALL

JVM_DefineClass(JNIEnv *env, const char *name, jobject loader, const jbyte *buf,

                jsize len, jobject pd);

/* Define a class with a source (added in JDK1.5) */

JNIEXPORT jclass JNICALL

JVM_DefineClassWithSource(JNIEnv *env, const char *name, jobject loader,

                          const jbyte *buf, jsize len, jobject pd,

                          const char *source);

/*

 * Module support funcions

 */

/*

 * Define a module with the specified packages and bind the module to the

 * given class loader.

 *  module:       module to define

 *  is_open:      specifies if module is open (currently ignored)

 *  version:      the module version

 *  location:     the module location

 *  packages:     list of packages in the module

 *  num_packages: number of packages in the module

 */

JNIEXPORT void JNICALL

JVM_DefineModule(JNIEnv *env, jobject module, jboolean is_open, jstring version,

                 jstring location, const char* const* packages, jsize num_packages);

/*

 * Set the boot loader's unnamed module.

 *  module: boot loader's unnamed module

 */

JNIEXPORT void JNICALL

JVM_SetBootLoaderUnnamedModule(JNIEnv *env, jobject module);

/*

 * Do a qualified export of a package.

 *  from_module: module containing the package to export

 *  package:     name of the package to export

 *  to_module:   module to export the package to

 */

JNIEXPORT void JNICALL

JVM_AddModuleExports(JNIEnv *env, jobject from_module, const char* package, jobject to_module);

/*

 * Do an export of a package to all unnamed modules.

 *  from_module: module containing the package to export

 *  package:     name of the package to export to all unnamed modules

 */

JNIEXPORT void JNICALL

JVM_AddModuleExportsToAllUnnamed(JNIEnv *env, jobject from_module, const char* package);

/*

 * Do an unqualified export of a package.

 *  from_module: module containing the package to export

 *  package:     name of the package to export

 */

JNIEXPORT void JNICALL

JVM_AddModuleExportsToAll(JNIEnv *env, jobject from_module, const char* package);

/*

 * Add a module to the list of modules that a given module can read.

 *  from_module:   module requesting read access

 *  source_module: module that from_module wants to read

 */

JNIEXPORT void JNICALL

JVM_AddReadsModule(JNIEnv *env, jobject from_module, jobject source_module);

/*

 * Reflection support functions

 */

JNIEXPORT jstring JNICALL

JVM_InitClassName(JNIEnv *env, jclass cls);

JNIEXPORT jobjectArray JNICALL

JVM_GetClassInterfaces(JNIEnv *env, jclass cls);

JNIEXPORT jboolean JNICALL

JVM_IsInterface(JNIEnv *env, jclass cls);

JNIEXPORT jobjectArray JNICALL

JVM_GetClassSigners(JNIEnv *env, jclass cls);

JNIEXPORT void JNICALL

JVM_SetClassSigners(JNIEnv *env, jclass cls, jobjectArray signers);

JNIEXPORT jobject JNICALL

JVM_GetProtectionDomain(JNIEnv *env, jclass cls);

JNIEXPORT jboolean JNICALL

JVM_IsArrayClass(JNIEnv *env, jclass cls);

JNIEXPORT jboolean JNICALL

JVM_IsPrimitiveClass(JNIEnv *env, jclass cls);

JNIEXPORT jint JNICALL

JVM_GetClassModifiers(JNIEnv *env, jclass cls);

JNIEXPORT jobjectArray JNICALL

JVM_GetDeclaredClasses(JNIEnv *env, jclass ofClass);

JNIEXPORT jclass JNICALL

JVM_GetDeclaringClass(JNIEnv *env, jclass ofClass);

JNIEXPORT jstring JNICALL

JVM_GetSimpleBinaryName(JNIEnv *env, jclass ofClass);

/* Generics support (JDK 1.5) */

JNIEXPORT jstring JNICALL

JVM_GetClassSignature(JNIEnv *env, jclass cls);

/* Annotations support (JDK 1.5) */

JNIEXPORT jbyteArray JNICALL

JVM_GetClassAnnotations(JNIEnv *env, jclass cls);

/* Type use annotations support (JDK 1.8) */

JNIEXPORT jbyteArray JNICALL

JVM_GetClassTypeAnnotations(JNIEnv *env, jclass cls);

JNIEXPORT jbyteArray JNICALL

JVM_GetFieldTypeAnnotations(JNIEnv *env, jobject field);

JNIEXPORT jbyteArray JNICALL

JVM_GetMethodTypeAnnotations(JNIEnv *env, jobject method);

/*

 * New (JDK 1.4) reflection implementation

 */

JNIEXPORT jobjectArray JNICALL

JVM_GetClassDeclaredMethods(JNIEnv *env, jclass ofClass, jboolean publicOnly);