1 /*
   2  * Copyright (c) 1997, 2015, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.
   8  *
   9  * This code is distributed in the hope that it will be useful, but WITHOUT
  10  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  11  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  12  * version 2 for more details (a copy is included in the LICENSE file that
  13  * accompanied this code).
  14  *
  15  * You should have received a copy of the GNU General Public License version
  16  * 2 along with this work; if not, write to the Free Software Foundation,
  17  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  18  *
  19  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  20  * or visit www.oracle.com if you need additional information or have any
  21  * questions.
  22  *
  23  */
  24 
  25 #ifndef SHARE_VM_PRIMS_JVM_H
  26 #define SHARE_VM_PRIMS_JVM_H
  27 
  28 #include "prims/jni.h"
  29 #ifdef TARGET_OS_FAMILY_linux
  30 # include "jvm_linux.h"
  31 #endif
  32 #ifdef TARGET_OS_FAMILY_solaris
  33 # include "jvm_solaris.h"
  34 #endif
  35 #ifdef TARGET_OS_FAMILY_windows
  36 # include "jvm_windows.h"
  37 #endif
  38 #ifdef TARGET_OS_FAMILY_aix
  39 # include "jvm_aix.h"
  40 #endif
  41 #ifdef TARGET_OS_FAMILY_bsd
  42 # include "jvm_bsd.h"
  43 #endif
  44 
  45 #ifndef _JAVASOFT_JVM_H_
  46 #define _JAVASOFT_JVM_H_
  47 
  48 // HotSpot integration note:
  49 //
  50 // This file and jvm.h used with the JDK are identical,
  51 // except for the three includes removed below
  52 
  53 // #include <sys/stat.h>
  54 // #include "jni.h"
  55 // #include "jvm_md.h"
  56 
  57 
  58 #ifdef __cplusplus
  59 extern "C" {
  60 #endif
  61 
  62 /*
  63  * This file contains additional functions exported from the VM.
  64  * These functions are complementary to the standard JNI support.
  65  * There are three parts to this file:
  66  *
  67  * First, this file contains the VM-related functions needed by native
  68  * libraries in the standard Java API. For example, the java.lang.Object
  69  * class needs VM-level functions that wait for and notify monitors.
  70  *
  71  * Second, this file contains the functions and constant definitions
  72  * needed by the byte code verifier and class file format checker.
  73  * These functions allow the verifier and format checker to be written
  74  * in a VM-independent way.
  75  *
  76  * Third, this file contains various I/O and nerwork operations needed
  77  * by the standard Java I/O and network APIs.
  78  */
  79 
  80 /*
  81  * Bump the version number when either of the following happens:
  82  *
  83  * 1. There is a change in JVM_* functions.
  84  *
  85  * 2. There is a change in the contract between VM and Java classes.
  86  *    For example, if the VM relies on a new private field in Thread
  87  *    class.
  88  */
  89 
  90 #define JVM_INTERFACE_VERSION 5
  91 
  92 JNIEXPORT jobjectArray JNICALL
  93 JVM_GetMethodParameters(JNIEnv *env, jobject method);
  94 
  95 JNIEXPORT jint JNICALL
  96 JVM_GetInterfaceVersion(void);
  97 
  98 /*************************************************************************
  99  PART 1: Functions for Native Libraries
 100  ************************************************************************/
 101 /*
 102  * java.lang.Object
 103  */
 104 JNIEXPORT jint JNICALL
 105 JVM_IHashCode(JNIEnv *env, jobject obj);
 106 
 107 JNIEXPORT void JNICALL
 108 JVM_MonitorWait(JNIEnv *env, jobject obj, jlong ms);
 109 
 110 JNIEXPORT void JNICALL
 111 JVM_MonitorNotify(JNIEnv *env, jobject obj);
 112 
 113 JNIEXPORT void JNICALL
 114 JVM_MonitorNotifyAll(JNIEnv *env, jobject obj);
 115 
 116 JNIEXPORT jobject JNICALL
 117 JVM_Clone(JNIEnv *env, jobject obj);
 118 
 119 /*
 120  * java.lang.String
 121  */
 122 JNIEXPORT jstring JNICALL
 123 JVM_InternString(JNIEnv *env, jstring str);
 124 
 125 /*
 126  * java.lang.System
 127  */
 128 JNIEXPORT jlong JNICALL
 129 JVM_CurrentTimeMillis(JNIEnv *env, jclass ignored);
 130 
 131 JNIEXPORT jlong JNICALL
 132 JVM_NanoTime(JNIEnv *env, jclass ignored);
 133 
 134 JNIEXPORT jlong JNICALL
 135 JVM_GetNanoTimeAdjustment(JNIEnv *env, jclass ignored, jlong offset_secs);
 136 
 137 JNIEXPORT void JNICALL
 138 JVM_ArrayCopy(JNIEnv *env, jclass ignored, jobject src, jint src_pos,
 139               jobject dst, jint dst_pos, jint length);
 140 
 141 JNIEXPORT jobject JNICALL
 142 JVM_InitProperties(JNIEnv *env, jobject p);
 143 
 144 /*
 145  * java.lang.Runtime
 146  */
 147 
 148 JNIEXPORT void JNICALL
 149 JVM_Halt(jint code);
 150 
 151 JNIEXPORT void JNICALL
 152 JVM_GC(void);
 153 
 154 /* Returns the number of real-time milliseconds that have elapsed since the
 155  * least-recently-inspected heap object was last inspected by the garbage
 156  * collector.
 157  *
 158  * For simple stop-the-world collectors this value is just the time
 159  * since the most recent collection.  For generational collectors it is the
 160  * time since the oldest generation was most recently collected.  Other
 161  * collectors are free to return a pessimistic estimate of the elapsed time, or
 162  * simply the time since the last full collection was performed.
 163  *
 164  * Note that in the presence of reference objects, a given object that is no
 165  * longer strongly reachable may have to be inspected multiple times before it
 166  * can be reclaimed.
 167  */
 168 JNIEXPORT jlong JNICALL
 169 JVM_MaxObjectInspectionAge(void);
 170 
 171 JNIEXPORT jlong JNICALL
 172 JVM_TotalMemory(void);
 173 
 174 JNIEXPORT jlong JNICALL
 175 JVM_FreeMemory(void);
 176 
 177 JNIEXPORT jlong JNICALL
 178 JVM_MaxMemory(void);
 179 
 180 JNIEXPORT jint JNICALL
 181 JVM_ActiveProcessorCount(void);
 182 
 183 JNIEXPORT void * JNICALL
 184 JVM_LoadLibrary(const char *name);
 185 
 186 JNIEXPORT void JNICALL
 187 JVM_UnloadLibrary(void * handle);
 188 
 189 JNIEXPORT void * JNICALL
 190 JVM_FindLibraryEntry(void *handle, const char *name);
 191 
 192 JNIEXPORT jboolean JNICALL
 193 JVM_IsSupportedJNIVersion(jint version);
 194 
 195 JNIEXPORT jobjectArray JNICALL
 196 JVM_GetVmArguments(JNIEnv *env);
 197 
 198 /*
 199  * java.lang.Throwable
 200  */
 201 JNIEXPORT void JNICALL
 202 JVM_FillInStackTrace(JNIEnv *env, jobject throwable);
 203 
 204 JNIEXPORT jint JNICALL
 205 JVM_GetStackTraceDepth(JNIEnv *env, jobject throwable);
 206 
 207 JNIEXPORT jobject JNICALL
 208 JVM_GetStackTraceElement(JNIEnv *env, jobject throwable, jint index);
 209 
 210 /*
 211  * java.lang.StackWalker
 212  */
 213 enum {
 214   JVM_STACKWALK_FILL_CLASS_REFS_ONLY       = 0x2,
 215   JVM_STACKWALK_FILTER_FILL_IN_STACK_TRACE = 0x10,
 216   JVM_STACKWALK_SHOW_HIDDEN_FRAMES         = 0x20,
 217   JVM_STACKWALK_FILL_LIVE_STACK_FRAMES     = 0x100
 218 };
 219 
 220 JNIEXPORT jobject JNICALL
 221 JVM_CallStackWalk(JNIEnv *env, jobject stackStream, jlong mode,
 222                   jint skip_frames, jint frame_count, jint start_index,
 223                   jobjectArray classes,
 224                   jobjectArray frames);
 225 
 226 JNIEXPORT jint JNICALL
 227 JVM_MoreStackWalk(JNIEnv *env, jobject stackStream, jlong mode, jlong anchor,
 228                   jint frame_count, jint start_index,
 229                   jobjectArray classes,
 230                   jobjectArray frames);
 231 
 232 JNIEXPORT void JNICALL
 233 JVM_FillStackFrames(JNIEnv* env, jclass cls,
 234                     jint start_index,
 235                     jobjectArray frames,
 236                     jint from_index, jint toIndex);
 237 
 238 JNIEXPORT void JNICALL
 239 JVM_SetMethodInfo(JNIEnv* env, jobject frame);
 240 
 241 /*
 242  * java.lang.Thread
 243  */
 244 JNIEXPORT void JNICALL
 245 JVM_StartThread(JNIEnv *env, jobject thread);
 246 
 247 JNIEXPORT void JNICALL
 248 JVM_StopThread(JNIEnv *env, jobject thread, jobject exception);
 249 
 250 JNIEXPORT jboolean JNICALL
 251 JVM_IsThreadAlive(JNIEnv *env, jobject thread);
 252 
 253 JNIEXPORT void JNICALL
 254 JVM_SuspendThread(JNIEnv *env, jobject thread);
 255 
 256 JNIEXPORT void JNICALL
 257 JVM_ResumeThread(JNIEnv *env, jobject thread);
 258 
 259 JNIEXPORT void JNICALL
 260 JVM_SetThreadPriority(JNIEnv *env, jobject thread, jint prio);
 261 
 262 JNIEXPORT void JNICALL
 263 JVM_Yield(JNIEnv *env, jclass threadClass);
 264 
 265 JNIEXPORT void JNICALL
 266 JVM_Sleep(JNIEnv *env, jclass threadClass, jlong millis);
 267 
 268 JNIEXPORT jobject JNICALL
 269 JVM_CurrentThread(JNIEnv *env, jclass threadClass);
 270 
 271 JNIEXPORT jint JNICALL
 272 JVM_CountStackFrames(JNIEnv *env, jobject thread);
 273 
 274 JNIEXPORT void JNICALL
 275 JVM_Interrupt(JNIEnv *env, jobject thread);
 276 
 277 JNIEXPORT jboolean JNICALL
 278 JVM_IsInterrupted(JNIEnv *env, jobject thread, jboolean clearInterrupted);
 279 
 280 JNIEXPORT jboolean JNICALL
 281 JVM_HoldsLock(JNIEnv *env, jclass threadClass, jobject obj);
 282 
 283 JNIEXPORT void JNICALL
 284 JVM_DumpAllStacks(JNIEnv *env, jclass unused);
 285 
 286 JNIEXPORT jobjectArray JNICALL
 287 JVM_GetAllThreads(JNIEnv *env, jclass dummy);
 288 
 289 JNIEXPORT void JNICALL
 290 JVM_SetNativeThreadName(JNIEnv *env, jobject jthread, jstring name);
 291 
 292 /* getStackTrace() and getAllStackTraces() method */
 293 JNIEXPORT jobjectArray JNICALL
 294 JVM_DumpThreads(JNIEnv *env, jclass threadClass, jobjectArray threads);
 295 
 296 /*
 297  * java.lang.SecurityManager
 298  */
 299 JNIEXPORT jclass JNICALL
 300 JVM_CurrentLoadedClass(JNIEnv *env);
 301 
 302 JNIEXPORT jobject JNICALL
 303 JVM_CurrentClassLoader(JNIEnv *env);
 304 
 305 JNIEXPORT jobjectArray JNICALL
 306 JVM_GetClassContext(JNIEnv *env);
 307 
 308 JNIEXPORT jint JNICALL
 309 JVM_ClassDepth(JNIEnv *env, jstring name);
 310 
 311 JNIEXPORT jint JNICALL
 312 JVM_ClassLoaderDepth(JNIEnv *env);
 313 
 314 /*
 315  * java.lang.Package
 316  */
 317 JNIEXPORT jstring JNICALL
 318 JVM_GetSystemPackage(JNIEnv *env, jstring name);
 319 
 320 JNIEXPORT jobjectArray JNICALL
 321 JVM_GetSystemPackages(JNIEnv *env);
 322 
 323 /*
 324  * java.io.ObjectInputStream
 325  */
 326 JNIEXPORT jobject JNICALL
 327 JVM_LatestUserDefinedLoader(JNIEnv *env);
 328 
 329 /*
 330  * java.lang.reflect.Array
 331  */
 332 JNIEXPORT jint JNICALL
 333 JVM_GetArrayLength(JNIEnv *env, jobject arr);
 334 
 335 JNIEXPORT jobject JNICALL
 336 JVM_GetArrayElement(JNIEnv *env, jobject arr, jint index);
 337 
 338 JNIEXPORT jvalue JNICALL
 339 JVM_GetPrimitiveArrayElement(JNIEnv *env, jobject arr, jint index, jint wCode);
 340 
 341 JNIEXPORT void JNICALL
 342 JVM_SetArrayElement(JNIEnv *env, jobject arr, jint index, jobject val);
 343 
 344 JNIEXPORT void JNICALL
 345 JVM_SetPrimitiveArrayElement(JNIEnv *env, jobject arr, jint index, jvalue v,
 346                              unsigned char vCode);
 347 
 348 JNIEXPORT jobject JNICALL
 349 JVM_NewArray(JNIEnv *env, jclass eltClass, jint length);
 350 
 351 JNIEXPORT jobject JNICALL
 352 JVM_NewMultiArray(JNIEnv *env, jclass eltClass, jintArray dim);
 353 
 354 /*
 355  * java.lang.Class and java.lang.ClassLoader
 356  */
 357 
 358 #define JVM_CALLER_DEPTH -1
 359 
 360 /*
 361  * Returns the class in which the code invoking the native method
 362  * belongs.
 363  *
 364  * Note that in JDK 1.1, native methods did not create a frame.
 365  * In 1.2, they do. Therefore native methods like Class.forName
 366  * can no longer look at the current frame for the caller class.
 367  */
 368 JNIEXPORT jclass JNICALL
 369 JVM_GetCallerClass(JNIEnv *env, int n);
 370 
 371 /*
 372  * Find primitive classes
 373  * utf: class name
 374  */
 375 JNIEXPORT jclass JNICALL
 376 JVM_FindPrimitiveClass(JNIEnv *env, const char *utf);
 377 
 378 /*
 379  * Find a class from a boot class loader. Returns NULL if class not found.
 380  */
 381 JNIEXPORT jclass JNICALL
 382 JVM_FindClassFromBootLoader(JNIEnv *env, const char *name);
 383 
 384 /*
 385  * Find a class from a given class loader.  Throws ClassNotFoundException.
 386  *  name:   name of class
 387  *  init:   whether initialization is done
 388  *  loader: class loader to look up the class. This may not be the same as the caller's
 389  *          class loader.
 390  *  caller: initiating class. The initiating class may be null when a security
 391  *          manager is not installed.
 392  */
 393 JNIEXPORT jclass JNICALL
 394 JVM_FindClassFromCaller(JNIEnv *env, const char *name, jboolean init,
 395                         jobject loader, jclass caller);
 396 
 397 /*
 398  * Find a class from a given class.
 399  */
 400 JNIEXPORT jclass JNICALL
 401 JVM_FindClassFromClass(JNIEnv *env, const char *name, jboolean init,
 402                              jclass from);
 403 
 404 /* Find a loaded class cached by the VM */
 405 JNIEXPORT jclass JNICALL
 406 JVM_FindLoadedClass(JNIEnv *env, jobject loader, jstring name);
 407 
 408 /* Define a class */
 409 JNIEXPORT jclass JNICALL
 410 JVM_DefineClass(JNIEnv *env, const char *name, jobject loader, const jbyte *buf,
 411                 jsize len, jobject pd);
 412 
 413 /* Define a class with a source (added in JDK1.5) */
 414 JNIEXPORT jclass JNICALL
 415 JVM_DefineClassWithSource(JNIEnv *env, const char *name, jobject loader,
 416                           const jbyte *buf, jsize len, jobject pd,
 417                           const char *source);
 418 
 419 /*
 420  * Reflection support functions
 421  */
 422 
 423 JNIEXPORT jstring JNICALL
 424 JVM_GetClassName(JNIEnv *env, jclass cls);
 425 
 426 JNIEXPORT jobjectArray JNICALL
 427 JVM_GetClassInterfaces(JNIEnv *env, jclass cls);
 428 
 429 JNIEXPORT jboolean JNICALL
 430 JVM_IsInterface(JNIEnv *env, jclass cls);
 431 
 432 JNIEXPORT jobjectArray JNICALL
 433 JVM_GetClassSigners(JNIEnv *env, jclass cls);
 434 
 435 JNIEXPORT void JNICALL
 436 JVM_SetClassSigners(JNIEnv *env, jclass cls, jobjectArray signers);
 437 
 438 JNIEXPORT jobject JNICALL
 439 JVM_GetProtectionDomain(JNIEnv *env, jclass cls);
 440 
 441 JNIEXPORT jboolean JNICALL
 442 JVM_IsArrayClass(JNIEnv *env, jclass cls);
 443 
 444 JNIEXPORT jboolean JNICALL
 445 JVM_IsPrimitiveClass(JNIEnv *env, jclass cls);
 446 
 447 JNIEXPORT jint JNICALL
 448 JVM_GetClassModifiers(JNIEnv *env, jclass cls);
 449 
 450 JNIEXPORT jobjectArray JNICALL
 451 JVM_GetDeclaredClasses(JNIEnv *env, jclass ofClass);
 452 
 453 JNIEXPORT jclass JNICALL
 454 JVM_GetDeclaringClass(JNIEnv *env, jclass ofClass);
 455 
 456 JNIEXPORT jstring JNICALL
 457 JVM_GetSimpleBinaryName(JNIEnv *env, jclass ofClass);
 458 
 459 /* Generics support (JDK 1.5) */
 460 JNIEXPORT jstring JNICALL
 461 JVM_GetClassSignature(JNIEnv *env, jclass cls);
 462 
 463 /* Annotations support (JDK 1.5) */
 464 JNIEXPORT jbyteArray JNICALL
 465 JVM_GetClassAnnotations(JNIEnv *env, jclass cls);
 466 
 467 /* Annotations support (JDK 1.6) */
 468 
 469 /* Type use annotations support (JDK 1.8) */
 470 
 471 JNIEXPORT jbyteArray JNICALL
 472 JVM_GetClassTypeAnnotations(JNIEnv *env, jclass cls);
 473 
 474 // field is a handle to a java.lang.reflect.Field object
 475 JNIEXPORT jbyteArray JNICALL
 476 JVM_GetFieldTypeAnnotations(JNIEnv *env, jobject field);
 477 
 478 // method is a handle to a java.lang.reflect.Method object
 479 JNIEXPORT jbyteArray JNICALL
 480 JVM_GetMethodTypeAnnotations(JNIEnv *env, jobject method);
 481 
 482 /*
 483  * New (JDK 1.4) reflection implementation
 484  */
 485 
 486 JNIEXPORT jobjectArray JNICALL
 487 JVM_GetClassDeclaredMethods(JNIEnv *env, jclass ofClass, jboolean publicOnly);
 488 
 489 JNIEXPORT jobjectArray JNICALL
 490 JVM_GetClassDeclaredFields(JNIEnv *env, jclass ofClass, jboolean publicOnly);
 491 
 492 JNIEXPORT jobjectArray JNICALL
 493 JVM_GetClassDeclaredConstructors(JNIEnv *env, jclass ofClass, jboolean publicOnly);
 494 
 495 /* Differs from JVM_GetClassModifiers in treatment of inner classes.
 496    This returns the access flags for the class as specified in the
 497    class file rather than searching the InnerClasses attribute (if
 498    present) to find the source-level access flags. Only the values of
 499    the low 13 bits (i.e., a mask of 0x1FFF) are guaranteed to be
 500    valid. */
 501 JNIEXPORT jint JNICALL
 502 JVM_GetClassAccessFlags(JNIEnv *env, jclass cls);
 503 
 504 /*
 505  * Constant pool access; currently used to implement reflective access to annotations (JDK 1.5)
 506  */
 507 
 508 JNIEXPORT jobject JNICALL
 509 JVM_GetClassConstantPool(JNIEnv *env, jclass cls);
 510 
 511 JNIEXPORT jint JNICALL JVM_ConstantPoolGetSize
 512 (JNIEnv *env, jobject obj, jobject unused);
 513 
 514 JNIEXPORT jclass JNICALL JVM_ConstantPoolGetClassAt
 515 (JNIEnv *env, jobject obj, jobject unused, jint index);
 516 
 517 JNIEXPORT jclass JNICALL JVM_ConstantPoolGetClassAtIfLoaded
 518 (JNIEnv *env, jobject obj, jobject unused, jint index);
 519 
 520 JNIEXPORT jobject JNICALL JVM_ConstantPoolGetMethodAt
 521 (JNIEnv *env, jobject obj, jobject unused, jint index);
 522 
 523 JNIEXPORT jobject JNICALL JVM_ConstantPoolGetMethodAtIfLoaded
 524 (JNIEnv *env, jobject obj, jobject unused, jint index);
 525 
 526 JNIEXPORT jobject JNICALL JVM_ConstantPoolGetFieldAt
 527 (JNIEnv *env, jobject obj, jobject unused, jint index);
 528 
 529 JNIEXPORT jobject JNICALL JVM_ConstantPoolGetFieldAtIfLoaded
 530 (JNIEnv *env, jobject obj, jobject unused, jint index);
 531 
 532 JNIEXPORT jobjectArray JNICALL JVM_ConstantPoolGetMemberRefInfoAt
 533 (JNIEnv *env, jobject obj, jobject unused, jint index);
 534 
 535 JNIEXPORT jobjectArray JNICALL JVM_ConstantPoolGetNameAndTypeRefInfoAt
 536 (JNIEnv *env, jobject obj, jobject unused, jint index);
 537 
 538 JNIEXPORT jint JNICALL JVM_ConstantPoolGetNameAndTypeRefIndexAt
 539 (JNIEnv *env, jobject obj, jobject unused, jint index);
 540 
 541 JNIEXPORT jint JNICALL JVM_ConstantPoolGetClassRefIndexAt
 542 (JNIEnv *env, jobject obj, jobject unused, jint index);
 543 
 544 JNIEXPORT jint JNICALL JVM_ConstantPoolGetIntAt
 545 (JNIEnv *env, jobject obj, jobject unused, jint index);
 546 
 547 JNIEXPORT jlong JNICALL JVM_ConstantPoolGetLongAt
 548 (JNIEnv *env, jobject obj, jobject unused, jint index);
 549 
 550 JNIEXPORT jfloat JNICALL JVM_ConstantPoolGetFloatAt
 551 (JNIEnv *env, jobject obj, jobject unused, jint index);
 552 
 553 JNIEXPORT jdouble JNICALL JVM_ConstantPoolGetDoubleAt
 554 (JNIEnv *env, jobject obj, jobject unused, jint index);
 555 
 556 JNIEXPORT jstring JNICALL JVM_ConstantPoolGetStringAt
 557 (JNIEnv *env, jobject obj, jobject unused, jint index);
 558 
 559 JNIEXPORT jstring JNICALL JVM_ConstantPoolGetUTF8At
 560 (JNIEnv *env, jobject obj, jobject unused, jint index);
 561 
 562 JNIEXPORT jbyte JNICALL JVM_ConstantPoolGetTagAt
 563 (JNIEnv *env, jobject unused, jobject jcpool, jint index);
 564 
 565 /*
 566  * java.security.*
 567  */
 568 
 569 JNIEXPORT jobject JNICALL
 570 JVM_DoPrivileged(JNIEnv *env, jclass cls,
 571                  jobject action, jobject context, jboolean wrapException);
 572 
 573 JNIEXPORT jobject JNICALL
 574 JVM_GetInheritedAccessControlContext(JNIEnv *env, jclass cls);
 575 
 576 JNIEXPORT jobject JNICALL
 577 JVM_GetStackAccessControlContext(JNIEnv *env, jclass cls);
 578 
 579 /*
 580  * Signal support, used to implement the shutdown sequence.  Every VM must
 581  * support JVM_SIGINT and JVM_SIGTERM, raising the former for user interrupts
 582  * (^C) and the latter for external termination (kill, system shutdown, etc.).
 583  * Other platform-dependent signal values may also be supported.
 584  */
 585 
 586 JNIEXPORT void * JNICALL
 587 JVM_RegisterSignal(jint sig, void *handler);
 588 
 589 JNIEXPORT jboolean JNICALL
 590 JVM_RaiseSignal(jint sig);
 591 
 592 JNIEXPORT jint JNICALL
 593 JVM_FindSignal(const char *name);
 594 
 595 /*
 596  * Retrieve the assertion directives for the specified class.
 597  */
 598 JNIEXPORT jboolean JNICALL
 599 JVM_DesiredAssertionStatus(JNIEnv *env, jclass unused, jclass cls);
 600 
 601 /*
 602  * Retrieve the assertion directives from the VM.
 603  */
 604 JNIEXPORT jobject JNICALL
 605 JVM_AssertionStatusDirectives(JNIEnv *env, jclass unused);
 606 
 607 /*
 608  * java.util.concurrent.atomic.AtomicLong
 609  */
 610 JNIEXPORT jboolean JNICALL
 611 JVM_SupportsCX8(void);
 612 
 613 /*************************************************************************
 614  PART 2: Support for the Verifier and Class File Format Checker
 615  ************************************************************************/
 616 /*
 617  * Return the class name in UTF format. The result is valid
 618  * until JVM_ReleaseUTf is called.
 619  *
 620  * The caller must treat the string as a constant and not modify it
 621  * in any way.
 622  */
 623 JNIEXPORT const char * JNICALL
 624 JVM_GetClassNameUTF(JNIEnv *env, jclass cb);
 625 
 626 /*
 627  * Returns the constant pool types in the buffer provided by "types."
 628  */
 629 JNIEXPORT void JNICALL
 630 JVM_GetClassCPTypes(JNIEnv *env, jclass cb, unsigned char *types);
 631 
 632 /*
 633  * Returns the number of Constant Pool entries.
 634  */
 635 JNIEXPORT jint JNICALL
 636 JVM_GetClassCPEntriesCount(JNIEnv *env, jclass cb);
 637 
 638 /*
 639  * Returns the number of *declared* fields or methods.
 640  */
 641 JNIEXPORT jint JNICALL
 642 JVM_GetClassFieldsCount(JNIEnv *env, jclass cb);
 643 
 644 JNIEXPORT jint JNICALL
 645 JVM_GetClassMethodsCount(JNIEnv *env, jclass cb);
 646 
 647 /*
 648  * Returns the CP indexes of exceptions raised by a given method.
 649  * Places the result in the given buffer.
 650  *
 651  * The method is identified by method_index.
 652  */
 653 JNIEXPORT void JNICALL
 654 JVM_GetMethodIxExceptionIndexes(JNIEnv *env, jclass cb, jint method_index,
 655                                 unsigned short *exceptions);
 656 /*
 657  * Returns the number of exceptions raised by a given method.
 658  * The method is identified by method_index.
 659  */
 660 JNIEXPORT jint JNICALL
 661 JVM_GetMethodIxExceptionsCount(JNIEnv *env, jclass cb, jint method_index);
 662 
 663 /*
 664  * Returns the byte code sequence of a given method.
 665  * Places the result in the given buffer.
 666  *
 667  * The method is identified by method_index.
 668  */
 669 JNIEXPORT void JNICALL
 670 JVM_GetMethodIxByteCode(JNIEnv *env, jclass cb, jint method_index,
 671                         unsigned char *code);
 672 
 673 /*
 674  * Returns the length of the byte code sequence of a given method.
 675  * The method is identified by method_index.
 676  */
 677 JNIEXPORT jint JNICALL
 678 JVM_GetMethodIxByteCodeLength(JNIEnv *env, jclass cb, jint method_index);
 679 
 680 /*
 681  * A structure used to a capture exception table entry in a Java method.
 682  */
 683 typedef struct {
 684     jint start_pc;
 685     jint end_pc;
 686     jint handler_pc;
 687     jint catchType;
 688 } JVM_ExceptionTableEntryType;
 689 
 690 /*
 691  * Returns the exception table entry at entry_index of a given method.
 692  * Places the result in the given buffer.
 693  *
 694  * The method is identified by method_index.
 695  */
 696 JNIEXPORT void JNICALL
 697 JVM_GetMethodIxExceptionTableEntry(JNIEnv *env, jclass cb, jint method_index,
 698                                    jint entry_index,
 699                                    JVM_ExceptionTableEntryType *entry);
 700 
 701 /*
 702  * Returns the length of the exception table of a given method.
 703  * The method is identified by method_index.
 704  */
 705 JNIEXPORT jint JNICALL
 706 JVM_GetMethodIxExceptionTableLength(JNIEnv *env, jclass cb, int index);
 707 
 708 /*
 709  * Returns the modifiers of a given field.
 710  * The field is identified by field_index.
 711  */
 712 JNIEXPORT jint JNICALL
 713 JVM_GetFieldIxModifiers(JNIEnv *env, jclass cb, int index);
 714 
 715 /*
 716  * Returns the modifiers of a given method.
 717  * The method is identified by method_index.
 718  */
 719 JNIEXPORT jint JNICALL
 720 JVM_GetMethodIxModifiers(JNIEnv *env, jclass cb, int index);
 721 
 722 /*
 723  * Returns the number of local variables of a given method.
 724  * The method is identified by method_index.
 725  */
 726 JNIEXPORT jint JNICALL
 727 JVM_GetMethodIxLocalsCount(JNIEnv *env, jclass cb, int index);
 728 
 729 /*
 730  * Returns the number of arguments (including this pointer) of a given method.
 731  * The method is identified by method_index.
 732  */
 733 JNIEXPORT jint JNICALL
 734 JVM_GetMethodIxArgsSize(JNIEnv *env, jclass cb, int index);
 735 
 736 /*
 737  * Returns the maximum amount of stack (in words) used by a given method.
 738  * The method is identified by method_index.
 739  */
 740 JNIEXPORT jint JNICALL
 741 JVM_GetMethodIxMaxStack(JNIEnv *env, jclass cb, int index);
 742 
 743 /*
 744  * Is a given method a constructor.
 745  * The method is identified by method_index.
 746  */
 747 JNIEXPORT jboolean JNICALL
 748 JVM_IsConstructorIx(JNIEnv *env, jclass cb, int index);
 749 
 750 /*
 751  * Is the given method generated by the VM.
 752  * The method is identified by method_index.
 753  */
 754 JNIEXPORT jboolean JNICALL
 755 JVM_IsVMGeneratedMethodIx(JNIEnv *env, jclass cb, int index);
 756 
 757 /*
 758  * Returns the name of a given method in UTF format.
 759  * The result remains valid until JVM_ReleaseUTF is called.
 760  *
 761  * The caller must treat the string as a constant and not modify it
 762  * in any way.
 763  */
 764 JNIEXPORT const char * JNICALL
 765 JVM_GetMethodIxNameUTF(JNIEnv *env, jclass cb, jint index);
 766 
 767 /*
 768  * Returns the signature of a given method in UTF format.
 769  * The result remains valid until JVM_ReleaseUTF is called.
 770  *
 771  * The caller must treat the string as a constant and not modify it
 772  * in any way.
 773  */
 774 JNIEXPORT const char * JNICALL
 775 JVM_GetMethodIxSignatureUTF(JNIEnv *env, jclass cb, jint index);
 776 
 777 /*
 778  * Returns the name of the field refered to at a given constant pool
 779  * index.
 780  *
 781  * The result is in UTF format and remains valid until JVM_ReleaseUTF
 782  * is called.
 783  *
 784  * The caller must treat the string as a constant and not modify it
 785  * in any way.
 786  */
 787 JNIEXPORT const char * JNICALL
 788 JVM_GetCPFieldNameUTF(JNIEnv *env, jclass cb, jint index);
 789 
 790 /*
 791  * Returns the name of the method refered to at a given constant pool
 792  * index.
 793  *
 794  * The result is in UTF format and remains valid until JVM_ReleaseUTF
 795  * is called.
 796  *
 797  * The caller must treat the string as a constant and not modify it
 798  * in any way.
 799  */
 800 JNIEXPORT const char * JNICALL
 801 JVM_GetCPMethodNameUTF(JNIEnv *env, jclass cb, jint index);
 802 
 803 /*
 804  * Returns the signature of the method refered to at a given constant pool
 805  * index.
 806  *
 807  * The result is in UTF format and remains valid until JVM_ReleaseUTF
 808  * is called.
 809  *
 810  * The caller must treat the string as a constant and not modify it
 811  * in any way.
 812  */
 813 JNIEXPORT const char * JNICALL
 814 JVM_GetCPMethodSignatureUTF(JNIEnv *env, jclass cb, jint index);
 815 
 816 /*
 817  * Returns the signature of the field refered to at a given constant pool
 818  * index.
 819  *
 820  * The result is in UTF format and remains valid until JVM_ReleaseUTF
 821  * is called.
 822  *
 823  * The caller must treat the string as a constant and not modify it
 824  * in any way.
 825  */
 826 JNIEXPORT const char * JNICALL
 827 JVM_GetCPFieldSignatureUTF(JNIEnv *env, jclass cb, jint index);
 828 
 829 /*
 830  * Returns the class name refered to at a given constant pool index.
 831  *
 832  * The result is in UTF format and remains valid until JVM_ReleaseUTF
 833  * is called.
 834  *
 835  * The caller must treat the string as a constant and not modify it
 836  * in any way.
 837  */
 838 JNIEXPORT const char * JNICALL
 839 JVM_GetCPClassNameUTF(JNIEnv *env, jclass cb, jint index);
 840 
 841 /*
 842  * Returns the class name refered to at a given constant pool index.
 843  *
 844  * The constant pool entry must refer to a CONSTANT_Fieldref.
 845  *
 846  * The result is in UTF format and remains valid until JVM_ReleaseUTF
 847  * is called.
 848  *
 849  * The caller must treat the string as a constant and not modify it
 850  * in any way.
 851  */
 852 JNIEXPORT const char * JNICALL
 853 JVM_GetCPFieldClassNameUTF(JNIEnv *env, jclass cb, jint index);
 854 
 855 /*
 856  * Returns the class name refered to at a given constant pool index.
 857  *
 858  * The constant pool entry must refer to CONSTANT_Methodref or
 859  * CONSTANT_InterfaceMethodref.
 860  *
 861  * The result is in UTF format and remains valid until JVM_ReleaseUTF
 862  * is called.
 863  *
 864  * The caller must treat the string as a constant and not modify it
 865  * in any way.
 866  */
 867 JNIEXPORT const char * JNICALL
 868 JVM_GetCPMethodClassNameUTF(JNIEnv *env, jclass cb, jint index);
 869 
 870 /*
 871  * Returns the modifiers of a field in calledClass. The field is
 872  * referred to in class cb at constant pool entry index.
 873  *
 874  * The caller must treat the string as a constant and not modify it
 875  * in any way.
 876  *
 877  * Returns -1 if the field does not exist in calledClass.
 878  */
 879 JNIEXPORT jint JNICALL
 880 JVM_GetCPFieldModifiers(JNIEnv *env, jclass cb, int index, jclass calledClass);
 881 
 882 /*
 883  * Returns the modifiers of a method in calledClass. The method is
 884  * referred to in class cb at constant pool entry index.
 885  *
 886  * Returns -1 if the method does not exist in calledClass.
 887  */
 888 JNIEXPORT jint JNICALL
 889 JVM_GetCPMethodModifiers(JNIEnv *env, jclass cb, int index, jclass calledClass);
 890 
 891 /*
 892  * Releases the UTF string obtained from the VM.
 893  */
 894 JNIEXPORT void JNICALL
 895 JVM_ReleaseUTF(const char *utf);
 896 
 897 /*
 898  * Compare if two classes are in the same package.
 899  */
 900 JNIEXPORT jboolean JNICALL
 901 JVM_IsSameClassPackage(JNIEnv *env, jclass class1, jclass class2);
 902 
 903 /* Constants in class files */
 904 
 905 #define JVM_ACC_PUBLIC        0x0001  /* visible to everyone */
 906 #define JVM_ACC_PRIVATE       0x0002  /* visible only to the defining class */
 907 #define JVM_ACC_PROTECTED     0x0004  /* visible to subclasses */
 908 #define JVM_ACC_STATIC        0x0008  /* instance variable is static */
 909 #define JVM_ACC_FINAL         0x0010  /* no further subclassing, overriding */
 910 #define JVM_ACC_SYNCHRONIZED  0x0020  /* wrap method call in monitor lock */
 911 #define JVM_ACC_SUPER         0x0020  /* funky handling of invokespecial */
 912 #define JVM_ACC_VOLATILE      0x0040  /* can not cache in registers */
 913 #define JVM_ACC_BRIDGE        0x0040  /* bridge method generated by compiler */
 914 #define JVM_ACC_TRANSIENT     0x0080  /* not persistent */
 915 #define JVM_ACC_VARARGS       0x0080  /* method declared with variable number of args */
 916 #define JVM_ACC_NATIVE        0x0100  /* implemented in C */
 917 #define JVM_ACC_INTERFACE     0x0200  /* class is an interface */
 918 #define JVM_ACC_ABSTRACT      0x0400  /* no definition provided */
 919 #define JVM_ACC_STRICT        0x0800  /* strict floating point */
 920 #define JVM_ACC_SYNTHETIC     0x1000  /* compiler-generated class, method or field */
 921 #define JVM_ACC_ANNOTATION    0x2000  /* annotation type */
 922 #define JVM_ACC_ENUM          0x4000  /* field is declared as element of enum */
 923 
 924 #define JVM_ACC_PUBLIC_BIT        0
 925 #define JVM_ACC_PRIVATE_BIT       1
 926 #define JVM_ACC_PROTECTED_BIT     2
 927 #define JVM_ACC_STATIC_BIT        3
 928 #define JVM_ACC_FINAL_BIT         4
 929 #define JVM_ACC_SYNCHRONIZED_BIT  5
 930 #define JVM_ACC_SUPER_BIT         5
 931 #define JVM_ACC_VOLATILE_BIT      6
 932 #define JVM_ACC_BRIDGE_BIT        6
 933 #define JVM_ACC_TRANSIENT_BIT     7
 934 #define JVM_ACC_VARARGS_BIT       7
 935 #define JVM_ACC_NATIVE_BIT        8
 936 #define JVM_ACC_INTERFACE_BIT     9
 937 #define JVM_ACC_ABSTRACT_BIT      10
 938 #define JVM_ACC_STRICT_BIT        11
 939 #define JVM_ACC_SYNTHETIC_BIT     12
 940 #define JVM_ACC_ANNOTATION_BIT    13
 941 #define JVM_ACC_ENUM_BIT          14
 942 
 943 // NOTE: replicated in SA in vm/agent/sun/jvm/hotspot/utilities/ConstantTag.java
 944 enum {
 945     JVM_CONSTANT_Utf8 = 1,
 946     JVM_CONSTANT_Unicode,               /* unused */
 947     JVM_CONSTANT_Integer,
 948     JVM_CONSTANT_Float,
 949     JVM_CONSTANT_Long,
 950     JVM_CONSTANT_Double,
 951     JVM_CONSTANT_Class,
 952     JVM_CONSTANT_String,
 953     JVM_CONSTANT_Fieldref,
 954     JVM_CONSTANT_Methodref,
 955     JVM_CONSTANT_InterfaceMethodref,
 956     JVM_CONSTANT_NameAndType,
 957     JVM_CONSTANT_MethodHandle           = 15,  // JSR 292
 958     JVM_CONSTANT_MethodType             = 16,  // JSR 292
 959     //JVM_CONSTANT_(unused)             = 17,  // JSR 292 early drafts only
 960     JVM_CONSTANT_InvokeDynamic          = 18,  // JSR 292
 961     JVM_CONSTANT_ExternalMax            = 18   // Last tag found in classfiles
 962 };
 963 
 964 /* JVM_CONSTANT_MethodHandle subtypes */
 965 enum {
 966     JVM_REF_getField                = 1,
 967     JVM_REF_getStatic               = 2,
 968     JVM_REF_putField                = 3,
 969     JVM_REF_putStatic               = 4,
 970     JVM_REF_invokeVirtual           = 5,
 971     JVM_REF_invokeStatic            = 6,
 972     JVM_REF_invokeSpecial           = 7,
 973     JVM_REF_newInvokeSpecial        = 8,
 974     JVM_REF_invokeInterface         = 9
 975 };
 976 
 977 /* Used in the newarray instruction. */
 978 
 979 #define JVM_T_BOOLEAN 4
 980 #define JVM_T_CHAR    5
 981 #define JVM_T_FLOAT   6
 982 #define JVM_T_DOUBLE  7
 983 #define JVM_T_BYTE    8
 984 #define JVM_T_SHORT   9
 985 #define JVM_T_INT    10
 986 #define JVM_T_LONG   11
 987 
 988 /* JVM method signatures */
 989 
 990 #define JVM_SIGNATURE_ARRAY             '['
 991 #define JVM_SIGNATURE_BYTE              'B'
 992 #define JVM_SIGNATURE_CHAR              'C'
 993 #define JVM_SIGNATURE_CLASS             'L'
 994 #define JVM_SIGNATURE_ENDCLASS          ';'
 995 #define JVM_SIGNATURE_ENUM              'E'
 996 #define JVM_SIGNATURE_FLOAT             'F'
 997 #define JVM_SIGNATURE_DOUBLE            'D'
 998 #define JVM_SIGNATURE_FUNC              '('
 999 #define JVM_SIGNATURE_ENDFUNC           ')'
1000 #define JVM_SIGNATURE_INT               'I'
1001 #define JVM_SIGNATURE_LONG              'J'
1002 #define JVM_SIGNATURE_SHORT             'S'
1003 #define JVM_SIGNATURE_VOID              'V'
1004 #define JVM_SIGNATURE_BOOLEAN           'Z'
1005 
1006 /*
1007  * A function defined by the byte-code verifier and called by the VM.
1008  * This is not a function implemented in the VM.
1009  *
1010  * Returns JNI_FALSE if verification fails. A detailed error message
1011  * will be places in msg_buf, whose length is specified by buf_len.
1012  */
1013 typedef jboolean (*verifier_fn_t)(JNIEnv *env,
1014                                   jclass cb,
1015                                   char * msg_buf,
1016                                   jint buf_len);
1017 
1018 
1019 /*
1020  * Support for a VM-independent class format checker.
1021  */
1022 typedef struct {
1023     unsigned long code;    /* byte code */
1024     unsigned long excs;    /* exceptions */
1025     unsigned long etab;    /* catch table */
1026     unsigned long lnum;    /* line number */
1027     unsigned long lvar;    /* local vars */
1028 } method_size_info;
1029 
1030 typedef struct {
1031     unsigned int constants;    /* constant pool */
1032     unsigned int fields;
1033     unsigned int methods;
1034     unsigned int interfaces;
1035     unsigned int fields2;      /* number of static 2-word fields */
1036     unsigned int innerclasses; /* # of records in InnerClasses attr */
1037 
1038     method_size_info clinit;   /* memory used in clinit */
1039     method_size_info main;     /* used everywhere else */
1040 } class_size_info;
1041 
1042 /*
1043  * Functions defined in libjava.so to perform string conversions.
1044  *
1045  */
1046 
1047 typedef jstring (*to_java_string_fn_t)(JNIEnv *env, char *str);
1048 
1049 typedef char *(*to_c_string_fn_t)(JNIEnv *env, jstring s, jboolean *b);
1050 
1051 /* This is the function defined in libjava.so that performs class
1052  * format checks. This functions fills in size information about
1053  * the class file and returns:
1054  *
1055  *   0: good
1056  *  -1: out of memory
1057  *  -2: bad format
1058  *  -3: unsupported version
1059  *  -4: bad class name
1060  */
1061 
1062 typedef jint (*check_format_fn_t)(char *class_name,
1063                                   unsigned char *data,
1064                                   unsigned int data_size,
1065                                   class_size_info *class_size,
1066                                   char *message_buffer,
1067                                   jint buffer_length,
1068                                   jboolean measure_only,
1069                                   jboolean check_relaxed);
1070 
1071 #define JVM_RECOGNIZED_CLASS_MODIFIERS (JVM_ACC_PUBLIC | \
1072                                         JVM_ACC_FINAL | \
1073                                         JVM_ACC_SUPER | \
1074                                         JVM_ACC_INTERFACE | \
1075                                         JVM_ACC_ABSTRACT | \
1076                                         JVM_ACC_ANNOTATION | \
1077                                         JVM_ACC_ENUM | \
1078                                         JVM_ACC_SYNTHETIC)
1079 
1080 #define JVM_RECOGNIZED_FIELD_MODIFIERS (JVM_ACC_PUBLIC | \
1081                                         JVM_ACC_PRIVATE | \
1082                                         JVM_ACC_PROTECTED | \
1083                                         JVM_ACC_STATIC | \
1084                                         JVM_ACC_FINAL | \
1085                                         JVM_ACC_VOLATILE | \
1086                                         JVM_ACC_TRANSIENT | \
1087                                         JVM_ACC_ENUM | \
1088                                         JVM_ACC_SYNTHETIC)
1089 
1090 #define JVM_RECOGNIZED_METHOD_MODIFIERS (JVM_ACC_PUBLIC | \
1091                                          JVM_ACC_PRIVATE | \
1092                                          JVM_ACC_PROTECTED | \
1093                                          JVM_ACC_STATIC | \
1094                                          JVM_ACC_FINAL | \
1095                                          JVM_ACC_SYNCHRONIZED | \
1096                                          JVM_ACC_BRIDGE | \
1097                                          JVM_ACC_VARARGS | \
1098                                          JVM_ACC_NATIVE | \
1099                                          JVM_ACC_ABSTRACT | \
1100                                          JVM_ACC_STRICT | \
1101                                          JVM_ACC_SYNTHETIC)
1102 
1103 /*
1104  * This is the function defined in libjava.so to perform path
1105  * canonicalization. VM call this function before opening jar files
1106  * to load system classes.
1107  *
1108  */
1109 
1110 typedef int (*canonicalize_fn_t)(JNIEnv *env, char *orig, char *out, int len);
1111 
1112 /*************************************************************************
1113  PART 3: I/O and Network Support
1114  ************************************************************************/
1115 
1116 /*
1117  * Convert a pathname into native format.  This function does syntactic
1118  * cleanup, such as removing redundant separator characters.  It modifies
1119  * the given pathname string in place.
1120  */
1121 JNIEXPORT char * JNICALL
1122 JVM_NativePath(char *);
1123 
1124 /*
1125  * The standard printing functions supported by the Java VM. (Should they
1126  * be renamed to JVM_* in the future?
1127  */
1128 
1129 /* jio_snprintf() and jio_vsnprintf() behave like snprintf(3) and vsnprintf(3),
1130  *  respectively, with the following differences:
1131  * - The string written to str is always zero-terminated, also in case of
1132  *   truncation (count is too small to hold the result string), unless count
1133  *   is 0. In case of truncation count-1 characters are written and '\0'
1134  *   appendend.
1135  * - If count is too small to hold the whole string, -1 is returned across
1136  *   all platforms. */
1137 JNIEXPORT int
1138 jio_vsnprintf(char *str, size_t count, const char *fmt, va_list args);
1139 
1140 JNIEXPORT int
1141 jio_snprintf(char *str, size_t count, const char *fmt, ...);
1142 
1143 JNIEXPORT int
1144 jio_fprintf(FILE *, const char *fmt, ...);
1145 
1146 JNIEXPORT int
1147 jio_vfprintf(FILE *, const char *fmt, va_list args);
1148 
1149 
1150 JNIEXPORT void * JNICALL
1151 JVM_RawMonitorCreate(void);
1152 
1153 JNIEXPORT void JNICALL
1154 JVM_RawMonitorDestroy(void *mon);
1155 
1156 JNIEXPORT jint JNICALL
1157 JVM_RawMonitorEnter(void *mon);
1158 
1159 JNIEXPORT void JNICALL
1160 JVM_RawMonitorExit(void *mon);
1161 
1162 /*
1163  * java.lang.reflect.Method
1164  */
1165 JNIEXPORT jobject JNICALL
1166 JVM_InvokeMethod(JNIEnv *env, jobject method, jobject obj, jobjectArray args0);
1167 
1168 /*
1169  * java.lang.reflect.Constructor
1170  */
1171 JNIEXPORT jobject JNICALL
1172 JVM_NewInstanceFromConstructor(JNIEnv *env, jobject c, jobjectArray args0);
1173 
1174 /*
1175  * java.lang.management support
1176  */
1177 JNIEXPORT void* JNICALL
1178 JVM_GetManagement(jint version);
1179 
1180 /*
1181  * com.sun.tools.attach.VirtualMachine support
1182  *
1183  * Initialize the agent properties with the properties maintained in the VM.
1184  */
1185 JNIEXPORT jobject JNICALL
1186 JVM_InitAgentProperties(JNIEnv *env, jobject agent_props);
1187 
1188 JNIEXPORT jstring JNICALL
1189 JVM_GetTemporaryDirectory(JNIEnv *env);
1190 
1191 /* Generics reflection support.
1192  *
1193  * Returns information about the given class's EnclosingMethod
1194  * attribute, if present, or null if the class had no enclosing
1195  * method.
1196  *
1197  * If non-null, the returned array contains three elements. Element 0
1198  * is the java.lang.Class of which the enclosing method is a member,
1199  * and elements 1 and 2 are the java.lang.Strings for the enclosing
1200  * method's name and descriptor, respectively.
1201  */
1202 JNIEXPORT jobjectArray JNICALL
1203 JVM_GetEnclosingMethodInfo(JNIEnv* env, jclass ofClass);
1204 
1205 /* =========================================================================
1206  * The following defines a private JVM interface that the JDK can query
1207  * for the JVM version and capabilities.  sun.misc.Version defines
1208  * the methods for getting the VM version and its capabilities.
1209  *
1210  * When a new bit is added, the following should be updated to provide
1211  * access to the new capability:
1212  *    HS:   JVM_GetVersionInfo and Abstract_VM_Version class
1213  *    SDK:  Version class
1214  *
1215  * Similary, a private JDK interface JDK_GetVersionInfo0 is defined for
1216  * JVM to query for the JDK version and capabilities.
1217  *
1218  * When a new bit is added, the following should be updated to provide
1219  * access to the new capability:
1220  *    HS:   JDK_Version class
1221  *    SDK:  JDK_GetVersionInfo0
1222  *
1223  * ==========================================================================
1224  */
1225 typedef struct {
1226     unsigned int jvm_version; /* Encoded $VNUM as defined by JEP-223 */
1227     unsigned int patch_version : 8; /* JEP-223 patch version */
1228     unsigned int reserved3 : 8;
1229     unsigned int reserved1 : 16;
1230     unsigned int reserved2;
1231 
1232     /* The following bits represents JVM supports that JDK has dependency on.
1233      * JDK can use these bits to determine which JVM version
1234      * and support it has to maintain runtime compatibility.
1235      *
1236      * When a new bit is added in a minor or update release, make sure
1237      * the new bit is also added in the main/baseline.
1238      */
1239     unsigned int is_attachable : 1;
1240     unsigned int : 31;
1241     unsigned int : 32;
1242     unsigned int : 32;
1243 } jvm_version_info;
1244 
1245 #define JVM_VERSION_MAJOR(version) ((version & 0xFF000000) >> 24)
1246 #define JVM_VERSION_MINOR(version) ((version & 0x00FF0000) >> 16)
1247 #define JVM_VERSION_SECURITY(version) ((version & 0x0000FF00) >> 8)
1248 #define JVM_VERSION_BUILD(version) ((version & 0x000000FF))
1249 
1250 JNIEXPORT void JNICALL
1251 JVM_GetVersionInfo(JNIEnv* env, jvm_version_info* info, size_t info_size);
1252 
1253 typedef struct {
1254     unsigned int jdk_version; /* Encoded $VNUM as defined by JEP-223 */
1255     unsigned int patch_version : 8; /* JEP-223 patch version */
1256     unsigned int reserved3 : 8;
1257     unsigned int reserved1 : 16;
1258     unsigned int reserved2;
1259 
1260     /* The following bits represents new JDK supports that VM has dependency on.
1261      * VM implementation can use these bits to determine which JDK version
1262      * and support it has to maintain runtime compatibility.
1263      *
1264      * When a new bit is added in a minor or update release, make sure
1265      * the new bit is also added in the main/baseline.
1266      */
1267     unsigned int thread_park_blocker : 1;
1268     unsigned int post_vm_init_hook_enabled : 1;
1269     unsigned int pending_list_uses_discovered_field : 1;
1270     unsigned int : 29;
1271     unsigned int : 32;
1272     unsigned int : 32;
1273 } jdk_version_info;
1274 
1275 #define JDK_VERSION_MAJOR(version) ((version & 0xFF000000) >> 24)
1276 #define JDK_VERSION_MINOR(version) ((version & 0x00FF0000) >> 16)
1277 #define JDK_VERSION_SECURITY(version) ((version & 0x0000FF00) >> 8)
1278 #define JDK_VERSION_BUILD(version) ((version & 0x000000FF))
1279 
1280 /*
1281  * This is the function JDK_GetVersionInfo0 defined in libjava.so
1282  * that is dynamically looked up by JVM.
1283  */
1284 typedef void (*jdk_version_info_fn_t)(jdk_version_info* info, size_t info_size);
1285 
1286 /*
1287  * This structure is used by the launcher to get the default thread
1288  * stack size from the VM using JNI_GetDefaultJavaVMInitArgs() with a
1289  * version of 1.1.  As it is not supported otherwise, it has been removed
1290  * from jni.h
1291  */
1292 typedef struct JDK1_1InitArgs {
1293     jint version;
1294 
1295     char **properties;
1296     jint checkSource;
1297     jint nativeStackSize;
1298     jint javaStackSize;
1299     jint minHeapSize;
1300     jint maxHeapSize;
1301     jint verifyMode;
1302     char *classpath;
1303 
1304     jint (JNICALL *vfprintf)(FILE *fp, const char *format, va_list args);
1305     void (JNICALL *exit)(jint code);
1306     void (JNICALL *abort)(void);
1307 
1308     jint enableClassGC;
1309     jint enableVerboseGC;
1310     jint disableAsyncGC;
1311     jint verbose;
1312     jboolean debugging;
1313     jint debugPort;
1314 } JDK1_1InitArgs;
1315 
1316 #ifdef __cplusplus
1317 } /* extern "C" */
1318 #endif /* __cplusplus */
1319 
1320 #endif /* !_JAVASOFT_JVM_H_ */
1321 
1322 #endif // SHARE_VM_PRIMS_JVM_H