1 /*
   2  * Copyright (c) 1997, 2013, 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_bsd
  39 # include "jvm_bsd.h"
  40 #endif
  41 
  42 #ifndef _JAVASOFT_JVM_H_
  43 #define _JAVASOFT_JVM_H_
  44 
  45 // HotSpot integration note:
  46 //
  47 // This file and jvm.h used with the JDK are identical,
  48 // except for the three includes removed below
  49 
  50 // #include <sys/stat.h>
  51 // #include "jni.h"
  52 // #include "jvm_md.h"
  53 
  54 
  55 #ifdef __cplusplus
  56 extern "C" {
  57 #endif
  58 
  59 /*
  60  * This file contains additional functions exported from the VM.
  61  * These functions are complementary to the standard JNI support.
  62  * There are three parts to this file:
  63  *
  64  * First, this file contains the VM-related functions needed by native
  65  * libraries in the standard Java API. For example, the java.lang.Object
  66  * class needs VM-level functions that wait for and notify monitors.
  67  *
  68  * Second, this file contains the functions and constant definitions
  69  * needed by the byte code verifier and class file format checker.
  70  * These functions allow the verifier and format checker to be written
  71  * in a VM-independent way.
  72  *
  73  * Third, this file contains various I/O and nerwork operations needed
  74  * by the standard Java I/O and network APIs.
  75  */
  76 
  77 /*
  78  * Bump the version number when either of the following happens:
  79  *
  80  * 1. There is a change in JVM_* functions.
  81  *
  82  * 2. There is a change in the contract between VM and Java classes.
  83  *    For example, if the VM relies on a new private field in Thread
  84  *    class.
  85  */
  86 
  87 #define JVM_INTERFACE_VERSION 4
  88 
  89 JNIEXPORT jobjectArray JNICALL
  90 JVM_GetMethodParameters(JNIEnv *env, jobject method);
  91 
  92 JNIEXPORT jint JNICALL
  93 JVM_GetInterfaceVersion(void);
  94 
  95 /*************************************************************************
  96  PART 1: Functions for Native Libraries
  97  ************************************************************************/
  98 /*
  99  * java.lang.Object
 100  */
 101 JNIEXPORT jint JNICALL
 102 JVM_IHashCode(JNIEnv *env, jobject obj);
 103 
 104 JNIEXPORT void JNICALL
 105 JVM_MonitorWait(JNIEnv *env, jobject obj, jlong ms);
 106 
 107 JNIEXPORT void JNICALL
 108 JVM_MonitorNotify(JNIEnv *env, jobject obj);
 109 
 110 JNIEXPORT void JNICALL
 111 JVM_MonitorNotifyAll(JNIEnv *env, jobject obj);
 112 
 113 JNIEXPORT jobject JNICALL
 114 JVM_Clone(JNIEnv *env, jobject obj);
 115 
 116 /*
 117  * java.lang.String
 118  */
 119 JNIEXPORT jstring JNICALL
 120 JVM_InternString(JNIEnv *env, jstring str);
 121 
 122 /*
 123  * java.lang.System
 124  */
 125 JNIEXPORT jlong JNICALL
 126 JVM_CurrentTimeMillis(JNIEnv *env, jclass ignored);
 127 
 128 JNIEXPORT jlong JNICALL
 129 JVM_NanoTime(JNIEnv *env, jclass ignored);
 130 
 131 JNIEXPORT void JNICALL
 132 JVM_ArrayCopy(JNIEnv *env, jclass ignored, jobject src, jint src_pos,
 133               jobject dst, jint dst_pos, jint length);
 134 
 135 JNIEXPORT jobject JNICALL
 136 JVM_InitProperties(JNIEnv *env, jobject p);
 137 
 138 /*
 139  * java.io.File
 140  */
 141 JNIEXPORT void JNICALL
 142 JVM_OnExit(void (*func)(void));
 143 
 144 /*
 145  * java.lang.Runtime
 146  */
 147 JNIEXPORT void JNICALL
 148 JVM_Exit(jint code);
 149 
 150 JNIEXPORT void JNICALL
 151 JVM_Halt(jint code);
 152 
 153 JNIEXPORT void JNICALL
 154 JVM_GC(void);
 155 
 156 /* Returns the number of real-time milliseconds that have elapsed since the
 157  * least-recently-inspected heap object was last inspected by the garbage
 158  * collector.
 159  *
 160  * For simple stop-the-world collectors this value is just the time
 161  * since the most recent collection.  For generational collectors it is the
 162  * time since the oldest generation was most recently collected.  Other
 163  * collectors are free to return a pessimistic estimate of the elapsed time, or
 164  * simply the time since the last full collection was performed.
 165  *
 166  * Note that in the presence of reference objects, a given object that is no
 167  * longer strongly reachable may have to be inspected multiple times before it
 168  * can be reclaimed.
 169  */
 170 JNIEXPORT jlong JNICALL
 171 JVM_MaxObjectInspectionAge(void);
 172 
 173 JNIEXPORT void JNICALL
 174 JVM_TraceInstructions(jboolean on);
 175 
 176 JNIEXPORT void JNICALL
 177 JVM_TraceMethodCalls(jboolean on);
 178 
 179 JNIEXPORT jlong JNICALL
 180 JVM_TotalMemory(void);
 181 
 182 JNIEXPORT jlong JNICALL
 183 JVM_FreeMemory(void);
 184 
 185 JNIEXPORT jlong JNICALL
 186 JVM_MaxMemory(void);
 187 
 188 JNIEXPORT jint JNICALL
 189 JVM_ActiveProcessorCount(void);
 190 
 191 JNIEXPORT void * JNICALL
 192 JVM_LoadLibrary(const char *name);
 193 
 194 JNIEXPORT void JNICALL
 195 JVM_UnloadLibrary(void * handle);
 196 
 197 JNIEXPORT void * JNICALL
 198 JVM_FindLibraryEntry(void *handle, const char *name);
 199 
 200 JNIEXPORT jboolean JNICALL
 201 JVM_IsSupportedJNIVersion(jint version);
 202 
 203 /*
 204  * java.lang.Float and java.lang.Double
 205  */
 206 JNIEXPORT jboolean JNICALL
 207 JVM_IsNaN(jdouble d);
 208 
 209 /*
 210  * java.lang.Throwable
 211  */
 212 JNIEXPORT void JNICALL
 213 JVM_FillInStackTrace(JNIEnv *env, jobject throwable);
 214 
 215 JNIEXPORT jint JNICALL
 216 JVM_GetStackTraceDepth(JNIEnv *env, jobject throwable);
 217 
 218 JNIEXPORT jobject JNICALL
 219 JVM_GetStackTraceElement(JNIEnv *env, jobject throwable, jint index);
 220 
 221 /*
 222  * java.lang.Compiler
 223  */
 224 JNIEXPORT void JNICALL
 225 JVM_InitializeCompiler (JNIEnv *env, jclass compCls);
 226 
 227 JNIEXPORT jboolean JNICALL
 228 JVM_IsSilentCompiler(JNIEnv *env, jclass compCls);
 229 
 230 JNIEXPORT jboolean JNICALL
 231 JVM_CompileClass(JNIEnv *env, jclass compCls, jclass cls);
 232 
 233 JNIEXPORT jboolean JNICALL
 234 JVM_CompileClasses(JNIEnv *env, jclass cls, jstring jname);
 235 
 236 JNIEXPORT jobject JNICALL
 237 JVM_CompilerCommand(JNIEnv *env, jclass compCls, jobject arg);
 238 
 239 JNIEXPORT void JNICALL
 240 JVM_EnableCompiler(JNIEnv *env, jclass compCls);
 241 
 242 JNIEXPORT void JNICALL
 243 JVM_DisableCompiler(JNIEnv *env, jclass compCls);
 244 
 245 /*
 246  * java.lang.Thread
 247  */
 248 JNIEXPORT void JNICALL
 249 JVM_StartThread(JNIEnv *env, jobject thread);
 250 
 251 JNIEXPORT void JNICALL
 252 JVM_StopThread(JNIEnv *env, jobject thread, jobject exception);
 253 
 254 JNIEXPORT jboolean JNICALL
 255 JVM_IsThreadAlive(JNIEnv *env, jobject thread);
 256 
 257 JNIEXPORT void JNICALL
 258 JVM_SuspendThread(JNIEnv *env, jobject thread);
 259 
 260 JNIEXPORT void JNICALL
 261 JVM_ResumeThread(JNIEnv *env, jobject thread);
 262 
 263 JNIEXPORT void JNICALL
 264 JVM_SetThreadPriority(JNIEnv *env, jobject thread, jint prio);
 265 
 266 JNIEXPORT void JNICALL
 267 JVM_Yield(JNIEnv *env, jclass threadClass);
 268 
 269 JNIEXPORT void JNICALL
 270 JVM_Sleep(JNIEnv *env, jclass threadClass, jlong millis);
 271 
 272 JNIEXPORT jobject JNICALL
 273 JVM_CurrentThread(JNIEnv *env, jclass threadClass);
 274 
 275 JNIEXPORT jint JNICALL
 276 JVM_CountStackFrames(JNIEnv *env, jobject thread);
 277 
 278 JNIEXPORT void JNICALL
 279 JVM_Interrupt(JNIEnv *env, jobject thread);
 280 
 281 JNIEXPORT jboolean JNICALL
 282 JVM_IsInterrupted(JNIEnv *env, jobject thread, jboolean clearInterrupted);
 283 
 284 JNIEXPORT jboolean JNICALL
 285 JVM_HoldsLock(JNIEnv *env, jclass threadClass, jobject obj);
 286 
 287 JNIEXPORT void JNICALL
 288 JVM_DumpAllStacks(JNIEnv *env, jclass unused);
 289 
 290 JNIEXPORT jobjectArray JNICALL
 291 JVM_GetAllThreads(JNIEnv *env, jclass dummy);
 292 
 293 JNIEXPORT void JNICALL
 294 JVM_SetNativeThreadName(JNIEnv *env, jobject jthread, jstring name);
 295 
 296 /* getStackTrace() and getAllStackTraces() method */
 297 JNIEXPORT jobjectArray JNICALL
 298 JVM_DumpThreads(JNIEnv *env, jclass threadClass, jobjectArray threads);
 299 
 300 /*
 301  * java.lang.SecurityManager
 302  */
 303 JNIEXPORT jclass JNICALL
 304 JVM_CurrentLoadedClass(JNIEnv *env);
 305 
 306 JNIEXPORT jobject JNICALL
 307 JVM_CurrentClassLoader(JNIEnv *env);
 308 
 309 JNIEXPORT jobjectArray JNICALL
 310 JVM_GetClassContext(JNIEnv *env);
 311 
 312 JNIEXPORT jint JNICALL
 313 JVM_ClassDepth(JNIEnv *env, jstring name);
 314 
 315 JNIEXPORT jint JNICALL
 316 JVM_ClassLoaderDepth(JNIEnv *env);
 317 
 318 /*
 319  * java.lang.Package
 320  */
 321 JNIEXPORT jstring JNICALL
 322 JVM_GetSystemPackage(JNIEnv *env, jstring name);
 323 
 324 JNIEXPORT jobjectArray JNICALL
 325 JVM_GetSystemPackages(JNIEnv *env);
 326 
 327 /*
 328  * java.io.ObjectInputStream
 329  */
 330 JNIEXPORT jobject JNICALL
 331 JVM_AllocateNewObject(JNIEnv *env, jobject obj, jclass currClass,
 332                       jclass initClass);
 333 
 334 JNIEXPORT jobject JNICALL
 335 JVM_AllocateNewArray(JNIEnv *env, jobject obj, jclass currClass,
 336                      jint length);
 337 
 338 JNIEXPORT jobject JNICALL
 339 JVM_LatestUserDefinedLoader(JNIEnv *env);
 340 
 341 /*
 342  * This function has been deprecated and should not be considered
 343  * part of the specified JVM interface.
 344  */
 345 JNIEXPORT jclass JNICALL
 346 JVM_LoadClass0(JNIEnv *env, jobject obj, jclass currClass,
 347                jstring currClassName);
 348 
 349 /*
 350  * java.lang.reflect.Array
 351  */
 352 JNIEXPORT jint JNICALL
 353 JVM_GetArrayLength(JNIEnv *env, jobject arr);
 354 
 355 JNIEXPORT jobject JNICALL
 356 JVM_GetArrayElement(JNIEnv *env, jobject arr, jint index);
 357 
 358 JNIEXPORT jvalue JNICALL
 359 JVM_GetPrimitiveArrayElement(JNIEnv *env, jobject arr, jint index, jint wCode);
 360 
 361 JNIEXPORT void JNICALL
 362 JVM_SetArrayElement(JNIEnv *env, jobject arr, jint index, jobject val);
 363 
 364 JNIEXPORT void JNICALL
 365 JVM_SetPrimitiveArrayElement(JNIEnv *env, jobject arr, jint index, jvalue v,
 366                              unsigned char vCode);
 367 
 368 JNIEXPORT jobject JNICALL
 369 JVM_NewArray(JNIEnv *env, jclass eltClass, jint length);
 370 
 371 JNIEXPORT jobject JNICALL
 372 JVM_NewMultiArray(JNIEnv *env, jclass eltClass, jintArray dim);
 373 
 374 /*
 375  * java.lang.Class and java.lang.ClassLoader
 376  */
 377 /*
 378  * Returns the class in which the code invoking the native method
 379  * belongs.
 380  *
 381  * Note that in JDK 1.1, native methods did not create a frame.
 382  * In 1.2, they do. Therefore native methods like Class.forName
 383  * can no longer look at the current frame for the caller class.
 384  */
 385 JNIEXPORT jclass JNICALL
 386 JVM_GetCallerClass(JNIEnv *env, int n);
 387 
 388 /*
 389  * Find primitive classes
 390  * utf: class name
 391  */
 392 JNIEXPORT jclass JNICALL
 393 JVM_FindPrimitiveClass(JNIEnv *env, const char *utf);
 394 
 395 /*
 396  * Link the class
 397  */
 398 JNIEXPORT void JNICALL
 399 JVM_ResolveClass(JNIEnv *env, jclass cls);
 400 
 401 /*
 402  * Find a class from a given class loader. Throw ClassNotFoundException
 403  * or NoClassDefFoundError depending on the value of the last
 404  * argument.
 405  */
 406 JNIEXPORT jclass JNICALL
 407 JVM_FindClassFromClassLoader(JNIEnv *env, const char *name, jboolean init,
 408                              jobject loader, jboolean throwError);
 409 
 410 /*
 411  * Find a class from a boot class loader. Returns NULL if class not found.
 412  */
 413 JNIEXPORT jclass JNICALL
 414 JVM_FindClassFromBootLoader(JNIEnv *env, const char *name);
 415 
 416 /*
 417  * Find a class from a given class.
 418  */
 419 JNIEXPORT jclass JNICALL
 420 JVM_FindClassFromClass(JNIEnv *env, const char *name, jboolean init,
 421                              jclass from);
 422 
 423 /* Find a loaded class cached by the VM */
 424 JNIEXPORT jclass JNICALL
 425 JVM_FindLoadedClass(JNIEnv *env, jobject loader, jstring name);
 426 
 427 /* Define a class */
 428 JNIEXPORT jclass JNICALL
 429 JVM_DefineClass(JNIEnv *env, const char *name, jobject loader, const jbyte *buf,
 430                 jsize len, jobject pd);
 431 
 432 /* Define a class with a source (added in JDK1.5) */
 433 JNIEXPORT jclass JNICALL
 434 JVM_DefineClassWithSource(JNIEnv *env, const char *name, jobject loader,
 435                           const jbyte *buf, jsize len, jobject pd,
 436                           const char *source);
 437 
 438 /* Define a class with a source with conditional verification (added HSX 14)
 439  * -Xverify:all will verify anyway, -Xverify:none will not verify,
 440  * -Xverify:remote (default) will obey this conditional
 441  * i.e. true = should_verify_class
 442  */
 443 JNIEXPORT jclass JNICALL
 444 JVM_DefineClassWithSourceCond(JNIEnv *env, const char *name,
 445                               jobject loader, const jbyte *buf,
 446                               jsize len, jobject pd, const char *source,
 447                               jboolean verify);
 448 
 449 /*
 450  * Reflection support functions
 451  */
 452 
 453 JNIEXPORT jstring JNICALL
 454 JVM_GetClassName(JNIEnv *env, jclass cls);
 455 
 456 JNIEXPORT jobjectArray JNICALL
 457 JVM_GetClassInterfaces(JNIEnv *env, jclass cls);
 458 
 459 JNIEXPORT jobject JNICALL
 460 JVM_GetClassLoader(JNIEnv *env, jclass cls);
 461 
 462 JNIEXPORT jboolean JNICALL
 463 JVM_IsInterface(JNIEnv *env, jclass cls);
 464 
 465 JNIEXPORT jobjectArray JNICALL
 466 JVM_GetClassSigners(JNIEnv *env, jclass cls);
 467 
 468 JNIEXPORT void JNICALL
 469 JVM_SetClassSigners(JNIEnv *env, jclass cls, jobjectArray signers);
 470 
 471 JNIEXPORT jobject JNICALL
 472 JVM_GetProtectionDomain(JNIEnv *env, jclass cls);
 473 
 474 JNIEXPORT void JNICALL
 475 JVM_SetProtectionDomain(JNIEnv *env, jclass cls, jobject protection_domain);
 476 
 477 JNIEXPORT jboolean JNICALL
 478 JVM_IsArrayClass(JNIEnv *env, jclass cls);
 479 
 480 JNIEXPORT jboolean JNICALL
 481 JVM_IsPrimitiveClass(JNIEnv *env, jclass cls);
 482 
 483 JNIEXPORT jclass JNICALL
 484 JVM_GetComponentType(JNIEnv *env, jclass cls);
 485 
 486 JNIEXPORT jint JNICALL
 487 JVM_GetClassModifiers(JNIEnv *env, jclass cls);
 488 
 489 JNIEXPORT jobjectArray JNICALL
 490 JVM_GetDeclaredClasses(JNIEnv *env, jclass ofClass);
 491 
 492 JNIEXPORT jclass JNICALL
 493 JVM_GetDeclaringClass(JNIEnv *env, jclass ofClass);
 494 
 495 /* Generics support (JDK 1.5) */
 496 JNIEXPORT jstring JNICALL
 497 JVM_GetClassSignature(JNIEnv *env, jclass cls);
 498 
 499 /* Annotations support (JDK 1.5) */
 500 JNIEXPORT jbyteArray JNICALL
 501 JVM_GetClassAnnotations(JNIEnv *env, jclass cls);
 502 
 503 /* Annotations support (JDK 1.6) */
 504 
 505 // field is a handle to a java.lang.reflect.Field object
 506 JNIEXPORT jbyteArray JNICALL
 507 JVM_GetFieldAnnotations(JNIEnv *env, jobject field);
 508 
 509 // method is a handle to a java.lang.reflect.Method object
 510 JNIEXPORT jbyteArray JNICALL
 511 JVM_GetMethodAnnotations(JNIEnv *env, jobject method);
 512 
 513 // method is a handle to a java.lang.reflect.Method object
 514 JNIEXPORT jbyteArray JNICALL
 515 JVM_GetMethodDefaultAnnotationValue(JNIEnv *env, jobject method);
 516 
 517 // method is a handle to a java.lang.reflect.Method object
 518 JNIEXPORT jbyteArray JNICALL
 519 JVM_GetMethodParameterAnnotations(JNIEnv *env, jobject method);
 520 
 521 /* Type use annotations support (JDK 1.8) */
 522 
 523 JNIEXPORT jbyteArray JNICALL
 524 JVM_GetClassTypeAnnotations(JNIEnv *env, jclass cls);
 525 
 526 // field is a handle to a java.lang.reflect.Field object
 527 JNIEXPORT jbyteArray JNICALL
 528 JVM_GetFieldTypeAnnotations(JNIEnv *env, jobject field);
 529 
 530 // method is a handle to a java.lang.reflect.Method object
 531 JNIEXPORT jbyteArray JNICALL
 532 JVM_GetMethodTypeAnnotations(JNIEnv *env, jobject method);
 533 
 534 /*
 535  * New (JDK 1.4) reflection implementation
 536  */
 537 
 538 JNIEXPORT jobjectArray JNICALL
 539 JVM_GetClassDeclaredMethods(JNIEnv *env, jclass ofClass, jboolean publicOnly);
 540 
 541 JNIEXPORT jobjectArray JNICALL
 542 JVM_GetClassDeclaredFields(JNIEnv *env, jclass ofClass, jboolean publicOnly);
 543 
 544 JNIEXPORT jobjectArray JNICALL
 545 JVM_GetClassDeclaredConstructors(JNIEnv *env, jclass ofClass, jboolean publicOnly);
 546 
 547 /* Differs from JVM_GetClassModifiers in treatment of inner classes.
 548    This returns the access flags for the class as specified in the
 549    class file rather than searching the InnerClasses attribute (if
 550    present) to find the source-level access flags. Only the values of
 551    the low 13 bits (i.e., a mask of 0x1FFF) are guaranteed to be
 552    valid. */
 553 JNIEXPORT jint JNICALL
 554 JVM_GetClassAccessFlags(JNIEnv *env, jclass cls);
 555 
 556 /*
 557  * Constant pool access; currently used to implement reflective access to annotations (JDK 1.5)
 558  */
 559 
 560 JNIEXPORT jobject JNICALL
 561 JVM_GetClassConstantPool(JNIEnv *env, jclass cls);
 562 
 563 JNIEXPORT jint JNICALL JVM_ConstantPoolGetSize
 564 (JNIEnv *env, jobject obj, jobject unused);
 565 
 566 JNIEXPORT jclass JNICALL JVM_ConstantPoolGetClassAt
 567 (JNIEnv *env, jobject obj, jobject unused, jint index);
 568 
 569 JNIEXPORT jclass JNICALL JVM_ConstantPoolGetClassAtIfLoaded
 570 (JNIEnv *env, jobject obj, jobject unused, jint index);
 571 
 572 JNIEXPORT jobject JNICALL JVM_ConstantPoolGetMethodAt
 573 (JNIEnv *env, jobject obj, jobject unused, jint index);
 574 
 575 JNIEXPORT jobject JNICALL JVM_ConstantPoolGetMethodAtIfLoaded
 576 (JNIEnv *env, jobject obj, jobject unused, jint index);
 577 
 578 JNIEXPORT jobject JNICALL JVM_ConstantPoolGetFieldAt
 579 (JNIEnv *env, jobject obj, jobject unused, jint index);
 580 
 581 JNIEXPORT jobject JNICALL JVM_ConstantPoolGetFieldAtIfLoaded
 582 (JNIEnv *env, jobject obj, jobject unused, jint index);
 583 
 584 JNIEXPORT jobjectArray JNICALL JVM_ConstantPoolGetMemberRefInfoAt
 585 (JNIEnv *env, jobject obj, jobject unused, jint index);
 586 
 587 JNIEXPORT jint JNICALL JVM_ConstantPoolGetIntAt
 588 (JNIEnv *env, jobject obj, jobject unused, jint index);
 589 
 590 JNIEXPORT jlong JNICALL JVM_ConstantPoolGetLongAt
 591 (JNIEnv *env, jobject obj, jobject unused, jint index);
 592 
 593 JNIEXPORT jfloat JNICALL JVM_ConstantPoolGetFloatAt
 594 (JNIEnv *env, jobject obj, jobject unused, jint index);
 595 
 596 JNIEXPORT jdouble JNICALL JVM_ConstantPoolGetDoubleAt
 597 (JNIEnv *env, jobject obj, jobject unused, jint index);
 598 
 599 JNIEXPORT jstring JNICALL JVM_ConstantPoolGetStringAt
 600 (JNIEnv *env, jobject obj, jobject unused, jint index);
 601 
 602 JNIEXPORT jstring JNICALL JVM_ConstantPoolGetUTF8At
 603 (JNIEnv *env, jobject obj, jobject unused, jint index);
 604 
 605 /*
 606  * java.security.*
 607  */
 608 
 609 JNIEXPORT jobject JNICALL
 610 JVM_DoPrivileged(JNIEnv *env, jclass cls,
 611                  jobject action, jobject context, jboolean wrapException);
 612 
 613 JNIEXPORT jobject JNICALL
 614 JVM_GetInheritedAccessControlContext(JNIEnv *env, jclass cls);
 615 
 616 JNIEXPORT jobject JNICALL
 617 JVM_GetStackAccessControlContext(JNIEnv *env, jclass cls);
 618 
 619 /*
 620  * Signal support, used to implement the shutdown sequence.  Every VM must
 621  * support JVM_SIGINT and JVM_SIGTERM, raising the former for user interrupts
 622  * (^C) and the latter for external termination (kill, system shutdown, etc.).
 623  * Other platform-dependent signal values may also be supported.
 624  */
 625 
 626 JNIEXPORT void * JNICALL
 627 JVM_RegisterSignal(jint sig, void *handler);
 628 
 629 JNIEXPORT jboolean JNICALL
 630 JVM_RaiseSignal(jint sig);
 631 
 632 JNIEXPORT jint JNICALL
 633 JVM_FindSignal(const char *name);
 634 
 635 /*
 636  * Retrieve the assertion directives for the specified class.
 637  */
 638 JNIEXPORT jboolean JNICALL
 639 JVM_DesiredAssertionStatus(JNIEnv *env, jclass unused, jclass cls);
 640 
 641 /*
 642  * Retrieve the assertion directives from the VM.
 643  */
 644 JNIEXPORT jobject JNICALL
 645 JVM_AssertionStatusDirectives(JNIEnv *env, jclass unused);
 646 
 647 /*
 648  * java.util.concurrent.atomic.AtomicLong
 649  */
 650 JNIEXPORT jboolean JNICALL
 651 JVM_SupportsCX8(void);
 652 
 653 JNIEXPORT jboolean JNICALL
 654 JVM_CX8Field(JNIEnv *env, jobject obj, jfieldID fldID, jlong oldVal, jlong newVal);
 655 
 656 /*
 657  * com.sun.dtrace.jsdt support
 658  */
 659 
 660 #define JVM_TRACING_DTRACE_VERSION 1
 661 
 662 /*
 663  * Structure to pass one probe description to JVM.
 664  *
 665  * The VM will overwrite the definition of the referenced method with
 666  * code that will fire the probe.
 667  */
 668 typedef struct {
 669     jmethodID method;
 670     jstring   function;
 671     jstring   name;
 672     void*     reserved[4];     // for future use
 673 } JVM_DTraceProbe;
 674 
 675 /**
 676  * Encapsulates the stability ratings for a DTrace provider field
 677  */
 678 typedef struct {
 679     jint nameStability;
 680     jint dataStability;
 681     jint dependencyClass;
 682 } JVM_DTraceInterfaceAttributes;
 683 
 684 /*
 685  * Structure to pass one provider description to JVM
 686  */
 687 typedef struct {
 688     jstring                       name;
 689     JVM_DTraceProbe*              probes;
 690     jint                          probe_count;
 691     JVM_DTraceInterfaceAttributes providerAttributes;
 692     JVM_DTraceInterfaceAttributes moduleAttributes;
 693     JVM_DTraceInterfaceAttributes functionAttributes;
 694     JVM_DTraceInterfaceAttributes nameAttributes;
 695     JVM_DTraceInterfaceAttributes argsAttributes;
 696     void*                         reserved[4]; // for future use
 697 } JVM_DTraceProvider;
 698 
 699 /*
 700  * Get the version number the JVM was built with
 701  */
 702 JNIEXPORT jint JNICALL
 703 JVM_DTraceGetVersion(JNIEnv* env);
 704 
 705 /*
 706  * Register new probe with given signature, return global handle
 707  *
 708  * The version passed in is the version that the library code was
 709  * built with.
 710  */
 711 JNIEXPORT jlong JNICALL
 712 JVM_DTraceActivate(JNIEnv* env, jint version, jstring module_name,
 713   jint providers_count, JVM_DTraceProvider* providers);
 714 
 715 /*
 716  * Check JSDT probe
 717  */
 718 JNIEXPORT jboolean JNICALL
 719 JVM_DTraceIsProbeEnabled(JNIEnv* env, jmethodID method);
 720 
 721 /*
 722  * Destroy custom DOF
 723  */
 724 JNIEXPORT void JNICALL
 725 JVM_DTraceDispose(JNIEnv* env, jlong handle);
 726 
 727 /*
 728  * Check to see if DTrace is supported by OS
 729  */
 730 JNIEXPORT jboolean JNICALL
 731 JVM_DTraceIsSupported(JNIEnv* env);
 732 
 733 /*************************************************************************
 734  PART 2: Support for the Verifier and Class File Format Checker
 735  ************************************************************************/
 736 /*
 737  * Return the class name in UTF format. The result is valid
 738  * until JVM_ReleaseUTf is called.
 739  *
 740  * The caller must treat the string as a constant and not modify it
 741  * in any way.
 742  */
 743 JNIEXPORT const char * JNICALL
 744 JVM_GetClassNameUTF(JNIEnv *env, jclass cb);
 745 
 746 /*
 747  * Returns the constant pool types in the buffer provided by "types."
 748  */
 749 JNIEXPORT void JNICALL
 750 JVM_GetClassCPTypes(JNIEnv *env, jclass cb, unsigned char *types);
 751 
 752 /*
 753  * Returns the number of Constant Pool entries.
 754  */
 755 JNIEXPORT jint JNICALL
 756 JVM_GetClassCPEntriesCount(JNIEnv *env, jclass cb);
 757 
 758 /*
 759  * Returns the number of *declared* fields or methods.
 760  */
 761 JNIEXPORT jint JNICALL
 762 JVM_GetClassFieldsCount(JNIEnv *env, jclass cb);
 763 
 764 JNIEXPORT jint JNICALL
 765 JVM_GetClassMethodsCount(JNIEnv *env, jclass cb);
 766 
 767 /*
 768  * Returns the CP indexes of exceptions raised by a given method.
 769  * Places the result in the given buffer.
 770  *
 771  * The method is identified by method_index.
 772  */
 773 JNIEXPORT void JNICALL
 774 JVM_GetMethodIxExceptionIndexes(JNIEnv *env, jclass cb, jint method_index,
 775                                 unsigned short *exceptions);
 776 /*
 777  * Returns the number of exceptions raised by a given method.
 778  * The method is identified by method_index.
 779  */
 780 JNIEXPORT jint JNICALL
 781 JVM_GetMethodIxExceptionsCount(JNIEnv *env, jclass cb, jint method_index);
 782 
 783 /*
 784  * Returns the byte code sequence of a given method.
 785  * Places the result in the given buffer.
 786  *
 787  * The method is identified by method_index.
 788  */
 789 JNIEXPORT void JNICALL
 790 JVM_GetMethodIxByteCode(JNIEnv *env, jclass cb, jint method_index,
 791                         unsigned char *code);
 792 
 793 /*
 794  * Returns the length of the byte code sequence of a given method.
 795  * The method is identified by method_index.
 796  */
 797 JNIEXPORT jint JNICALL
 798 JVM_GetMethodIxByteCodeLength(JNIEnv *env, jclass cb, jint method_index);
 799 
 800 /*
 801  * A structure used to a capture exception table entry in a Java method.
 802  */
 803 typedef struct {
 804     jint start_pc;
 805     jint end_pc;
 806     jint handler_pc;
 807     jint catchType;
 808 } JVM_ExceptionTableEntryType;
 809 
 810 /*
 811  * Returns the exception table entry at entry_index of a given method.
 812  * Places the result in the given buffer.
 813  *
 814  * The method is identified by method_index.
 815  */
 816 JNIEXPORT void JNICALL
 817 JVM_GetMethodIxExceptionTableEntry(JNIEnv *env, jclass cb, jint method_index,
 818                                    jint entry_index,
 819                                    JVM_ExceptionTableEntryType *entry);
 820 
 821 /*
 822  * Returns the length of the exception table of a given method.
 823  * The method is identified by method_index.
 824  */
 825 JNIEXPORT jint JNICALL
 826 JVM_GetMethodIxExceptionTableLength(JNIEnv *env, jclass cb, int index);
 827 
 828 /*
 829  * Returns the modifiers of a given field.
 830  * The field is identified by field_index.
 831  */
 832 JNIEXPORT jint JNICALL
 833 JVM_GetFieldIxModifiers(JNIEnv *env, jclass cb, int index);
 834 
 835 /*
 836  * Returns the modifiers of a given method.
 837  * The method is identified by method_index.
 838  */
 839 JNIEXPORT jint JNICALL
 840 JVM_GetMethodIxModifiers(JNIEnv *env, jclass cb, int index);
 841 
 842 /*
 843  * Returns the number of local variables of a given method.
 844  * The method is identified by method_index.
 845  */
 846 JNIEXPORT jint JNICALL
 847 JVM_GetMethodIxLocalsCount(JNIEnv *env, jclass cb, int index);
 848 
 849 /*
 850  * Returns the number of arguments (including this pointer) of a given method.
 851  * The method is identified by method_index.
 852  */
 853 JNIEXPORT jint JNICALL
 854 JVM_GetMethodIxArgsSize(JNIEnv *env, jclass cb, int index);
 855 
 856 /*
 857  * Returns the maximum amount of stack (in words) used by a given method.
 858  * The method is identified by method_index.
 859  */
 860 JNIEXPORT jint JNICALL
 861 JVM_GetMethodIxMaxStack(JNIEnv *env, jclass cb, int index);
 862 
 863 /*
 864  * Is a given method a constructor.
 865  * The method is identified by method_index.
 866  */
 867 JNIEXPORT jboolean JNICALL
 868 JVM_IsConstructorIx(JNIEnv *env, jclass cb, int index);
 869 
 870 /*
 871  * Is the given method generated by the VM.
 872  * The method is identified by method_index.
 873  */
 874 JNIEXPORT jboolean JNICALL
 875 JVM_IsVMGeneratedMethodIx(JNIEnv *env, jclass cb, int index);
 876 
 877 /*
 878  * Returns the name of a given method in UTF format.
 879  * The result remains valid until JVM_ReleaseUTF is called.
 880  *
 881  * The caller must treat the string as a constant and not modify it
 882  * in any way.
 883  */
 884 JNIEXPORT const char * JNICALL
 885 JVM_GetMethodIxNameUTF(JNIEnv *env, jclass cb, jint index);
 886 
 887 /*
 888  * Returns the signature of a given method in UTF format.
 889  * The result remains valid until JVM_ReleaseUTF is called.
 890  *
 891  * The caller must treat the string as a constant and not modify it
 892  * in any way.
 893  */
 894 JNIEXPORT const char * JNICALL
 895 JVM_GetMethodIxSignatureUTF(JNIEnv *env, jclass cb, jint index);
 896 
 897 /*
 898  * Returns the name of the field refered to at a given constant pool
 899  * index.
 900  *
 901  * The result is in UTF format and remains valid until JVM_ReleaseUTF
 902  * is called.
 903  *
 904  * The caller must treat the string as a constant and not modify it
 905  * in any way.
 906  */
 907 JNIEXPORT const char * JNICALL
 908 JVM_GetCPFieldNameUTF(JNIEnv *env, jclass cb, jint index);
 909 
 910 /*
 911  * Returns the name of the method refered to at a given constant pool
 912  * index.
 913  *
 914  * The result is in UTF format and remains valid until JVM_ReleaseUTF
 915  * is called.
 916  *
 917  * The caller must treat the string as a constant and not modify it
 918  * in any way.
 919  */
 920 JNIEXPORT const char * JNICALL
 921 JVM_GetCPMethodNameUTF(JNIEnv *env, jclass cb, jint index);
 922 
 923 /*
 924  * Returns the signature of the method refered to at a given constant pool
 925  * index.
 926  *
 927  * The result is in UTF format and remains valid until JVM_ReleaseUTF
 928  * is called.
 929  *
 930  * The caller must treat the string as a constant and not modify it
 931  * in any way.
 932  */
 933 JNIEXPORT const char * JNICALL
 934 JVM_GetCPMethodSignatureUTF(JNIEnv *env, jclass cb, jint index);
 935 
 936 /*
 937  * Returns the signature of the field refered to at a given constant pool
 938  * index.
 939  *
 940  * The result is in UTF format and remains valid until JVM_ReleaseUTF
 941  * is called.
 942  *
 943  * The caller must treat the string as a constant and not modify it
 944  * in any way.
 945  */
 946 JNIEXPORT const char * JNICALL
 947 JVM_GetCPFieldSignatureUTF(JNIEnv *env, jclass cb, jint index);
 948 
 949 /*
 950  * Returns the class name refered to at a given constant pool index.
 951  *
 952  * The result is in UTF format and remains valid until JVM_ReleaseUTF
 953  * is called.
 954  *
 955  * The caller must treat the string as a constant and not modify it
 956  * in any way.
 957  */
 958 JNIEXPORT const char * JNICALL
 959 JVM_GetCPClassNameUTF(JNIEnv *env, jclass cb, jint index);
 960 
 961 /*
 962  * Returns the class name refered to at a given constant pool index.
 963  *
 964  * The constant pool entry must refer to a CONSTANT_Fieldref.
 965  *
 966  * The result is in UTF format and remains valid until JVM_ReleaseUTF
 967  * is called.
 968  *
 969  * The caller must treat the string as a constant and not modify it
 970  * in any way.
 971  */
 972 JNIEXPORT const char * JNICALL
 973 JVM_GetCPFieldClassNameUTF(JNIEnv *env, jclass cb, jint index);
 974 
 975 /*
 976  * Returns the class name refered to at a given constant pool index.
 977  *
 978  * The constant pool entry must refer to CONSTANT_Methodref or
 979  * CONSTANT_InterfaceMethodref.
 980  *
 981  * The result is in UTF format and remains valid until JVM_ReleaseUTF
 982  * is called.
 983  *
 984  * The caller must treat the string as a constant and not modify it
 985  * in any way.
 986  */
 987 JNIEXPORT const char * JNICALL
 988 JVM_GetCPMethodClassNameUTF(JNIEnv *env, jclass cb, jint index);
 989 
 990 /*
 991  * Returns the modifiers of a field in calledClass. The field is
 992  * referred to in class cb at constant pool entry index.
 993  *
 994  * The caller must treat the string as a constant and not modify it
 995  * in any way.
 996  *
 997  * Returns -1 if the field does not exist in calledClass.
 998  */
 999 JNIEXPORT jint JNICALL
1000 JVM_GetCPFieldModifiers(JNIEnv *env, jclass cb, int index, jclass calledClass);
1001 
1002 /*
1003  * Returns the modifiers of a method in calledClass. The method is
1004  * referred to in class cb at constant pool entry index.
1005  *
1006  * Returns -1 if the method does not exist in calledClass.
1007  */
1008 JNIEXPORT jint JNICALL
1009 JVM_GetCPMethodModifiers(JNIEnv *env, jclass cb, int index, jclass calledClass);
1010 
1011 /*
1012  * Releases the UTF string obtained from the VM.
1013  */
1014 JNIEXPORT void JNICALL
1015 JVM_ReleaseUTF(const char *utf);
1016 
1017 /*
1018  * Compare if two classes are in the same package.
1019  */
1020 JNIEXPORT jboolean JNICALL
1021 JVM_IsSameClassPackage(JNIEnv *env, jclass class1, jclass class2);
1022 
1023 /* Constants in class files */
1024 
1025 #define JVM_ACC_PUBLIC        0x0001  /* visible to everyone */
1026 #define JVM_ACC_PRIVATE       0x0002  /* visible only to the defining class */
1027 #define JVM_ACC_PROTECTED     0x0004  /* visible to subclasses */
1028 #define JVM_ACC_STATIC        0x0008  /* instance variable is static */
1029 #define JVM_ACC_FINAL         0x0010  /* no further subclassing, overriding */
1030 #define JVM_ACC_SYNCHRONIZED  0x0020  /* wrap method call in monitor lock */
1031 #define JVM_ACC_SUPER         0x0020  /* funky handling of invokespecial */
1032 #define JVM_ACC_VOLATILE      0x0040  /* can not cache in registers */
1033 #define JVM_ACC_BRIDGE        0x0040  /* bridge method generated by compiler */
1034 #define JVM_ACC_TRANSIENT     0x0080  /* not persistent */
1035 #define JVM_ACC_VARARGS       0x0080  /* method declared with variable number of args */
1036 #define JVM_ACC_NATIVE        0x0100  /* implemented in C */
1037 #define JVM_ACC_INTERFACE     0x0200  /* class is an interface */
1038 #define JVM_ACC_ABSTRACT      0x0400  /* no definition provided */
1039 #define JVM_ACC_STRICT        0x0800  /* strict floating point */
1040 #define JVM_ACC_SYNTHETIC     0x1000  /* compiler-generated class, method or field */
1041 #define JVM_ACC_ANNOTATION    0x2000  /* annotation type */
1042 #define JVM_ACC_ENUM          0x4000  /* field is declared as element of enum */
1043 
1044 #define JVM_ACC_PUBLIC_BIT        0
1045 #define JVM_ACC_PRIVATE_BIT       1
1046 #define JVM_ACC_PROTECTED_BIT     2
1047 #define JVM_ACC_STATIC_BIT        3
1048 #define JVM_ACC_FINAL_BIT         4
1049 #define JVM_ACC_SYNCHRONIZED_BIT  5
1050 #define JVM_ACC_SUPER_BIT         5
1051 #define JVM_ACC_VOLATILE_BIT      6
1052 #define JVM_ACC_BRIDGE_BIT        6
1053 #define JVM_ACC_TRANSIENT_BIT     7
1054 #define JVM_ACC_VARARGS_BIT       7
1055 #define JVM_ACC_NATIVE_BIT        8
1056 #define JVM_ACC_INTERFACE_BIT     9
1057 #define JVM_ACC_ABSTRACT_BIT      10
1058 #define JVM_ACC_STRICT_BIT        11
1059 #define JVM_ACC_SYNTHETIC_BIT     12
1060 #define JVM_ACC_ANNOTATION_BIT    13
1061 #define JVM_ACC_ENUM_BIT          14
1062 
1063 // NOTE: replicated in SA in vm/agent/sun/jvm/hotspot/utilities/ConstantTag.java
1064 enum {
1065     JVM_CONSTANT_Utf8 = 1,
1066     JVM_CONSTANT_Unicode,               /* unused */
1067     JVM_CONSTANT_Integer,
1068     JVM_CONSTANT_Float,
1069     JVM_CONSTANT_Long,
1070     JVM_CONSTANT_Double,
1071     JVM_CONSTANT_Class,
1072     JVM_CONSTANT_String,
1073     JVM_CONSTANT_Fieldref,
1074     JVM_CONSTANT_Methodref,
1075     JVM_CONSTANT_InterfaceMethodref,
1076     JVM_CONSTANT_NameAndType,
1077     JVM_CONSTANT_MethodHandle           = 15,  // JSR 292
1078     JVM_CONSTANT_MethodType             = 16,  // JSR 292
1079     //JVM_CONSTANT_(unused)             = 17,  // JSR 292 early drafts only
1080     JVM_CONSTANT_InvokeDynamic          = 18,  // JSR 292
1081     JVM_CONSTANT_ExternalMax            = 18   // Last tag found in classfiles
1082 };
1083 
1084 /* JVM_CONSTANT_MethodHandle subtypes */
1085 enum {
1086     JVM_REF_getField                = 1,
1087     JVM_REF_getStatic               = 2,
1088     JVM_REF_putField                = 3,
1089     JVM_REF_putStatic               = 4,
1090     JVM_REF_invokeVirtual           = 5,
1091     JVM_REF_invokeStatic            = 6,
1092     JVM_REF_invokeSpecial           = 7,
1093     JVM_REF_newInvokeSpecial        = 8,
1094     JVM_REF_invokeInterface         = 9
1095 };
1096 
1097 /* Used in the newarray instruction. */
1098 
1099 #define JVM_T_BOOLEAN 4
1100 #define JVM_T_CHAR    5
1101 #define JVM_T_FLOAT   6
1102 #define JVM_T_DOUBLE  7
1103 #define JVM_T_BYTE    8
1104 #define JVM_T_SHORT   9
1105 #define JVM_T_INT    10
1106 #define JVM_T_LONG   11
1107 
1108 /* JVM method signatures */
1109 
1110 #define JVM_SIGNATURE_ARRAY             '['
1111 #define JVM_SIGNATURE_BYTE              'B'
1112 #define JVM_SIGNATURE_CHAR              'C'
1113 #define JVM_SIGNATURE_CLASS             'L'
1114 #define JVM_SIGNATURE_ENDCLASS          ';'
1115 #define JVM_SIGNATURE_ENUM              'E'
1116 #define JVM_SIGNATURE_FLOAT             'F'
1117 #define JVM_SIGNATURE_DOUBLE            'D'
1118 #define JVM_SIGNATURE_FUNC              '('
1119 #define JVM_SIGNATURE_ENDFUNC           ')'
1120 #define JVM_SIGNATURE_INT               'I'
1121 #define JVM_SIGNATURE_LONG              'J'
1122 #define JVM_SIGNATURE_SHORT             'S'
1123 #define JVM_SIGNATURE_VOID              'V'
1124 #define JVM_SIGNATURE_BOOLEAN           'Z'
1125 
1126 /*
1127  * A function defined by the byte-code verifier and called by the VM.
1128  * This is not a function implemented in the VM.
1129  *
1130  * Returns JNI_FALSE if verification fails. A detailed error message
1131  * will be places in msg_buf, whose length is specified by buf_len.
1132  */
1133 typedef jboolean (*verifier_fn_t)(JNIEnv *env,
1134                                   jclass cb,
1135                                   char * msg_buf,
1136                                   jint buf_len);
1137 
1138 
1139 /*
1140  * Support for a VM-independent class format checker.
1141  */
1142 typedef struct {
1143     unsigned long code;    /* byte code */
1144     unsigned long excs;    /* exceptions */
1145     unsigned long etab;    /* catch table */
1146     unsigned long lnum;    /* line number */
1147     unsigned long lvar;    /* local vars */
1148 } method_size_info;
1149 
1150 typedef struct {
1151     unsigned int constants;    /* constant pool */
1152     unsigned int fields;
1153     unsigned int methods;
1154     unsigned int interfaces;
1155     unsigned int fields2;      /* number of static 2-word fields */
1156     unsigned int innerclasses; /* # of records in InnerClasses attr */
1157 
1158     method_size_info clinit;   /* memory used in clinit */
1159     method_size_info main;     /* used everywhere else */
1160 } class_size_info;
1161 
1162 /*
1163  * Functions defined in libjava.so to perform string conversions.
1164  *
1165  */
1166 
1167 typedef jstring (*to_java_string_fn_t)(JNIEnv *env, char *str);
1168 
1169 typedef char *(*to_c_string_fn_t)(JNIEnv *env, jstring s, jboolean *b);
1170 
1171 /* This is the function defined in libjava.so that performs class
1172  * format checks. This functions fills in size information about
1173  * the class file and returns:
1174  *
1175  *   0: good
1176  *  -1: out of memory
1177  *  -2: bad format
1178  *  -3: unsupported version
1179  *  -4: bad class name
1180  */
1181 
1182 typedef jint (*check_format_fn_t)(char *class_name,
1183                                   unsigned char *data,
1184                                   unsigned int data_size,
1185                                   class_size_info *class_size,
1186                                   char *message_buffer,
1187                                   jint buffer_length,
1188                                   jboolean measure_only,
1189                                   jboolean check_relaxed);
1190 
1191 #define JVM_RECOGNIZED_CLASS_MODIFIERS (JVM_ACC_PUBLIC | \
1192                                         JVM_ACC_FINAL | \
1193                                         JVM_ACC_SUPER | \
1194                                         JVM_ACC_INTERFACE | \
1195                                         JVM_ACC_ABSTRACT | \
1196                                         JVM_ACC_ANNOTATION | \
1197                                         JVM_ACC_ENUM | \
1198                                         JVM_ACC_SYNTHETIC)
1199 
1200 #define JVM_RECOGNIZED_FIELD_MODIFIERS (JVM_ACC_PUBLIC | \
1201                                         JVM_ACC_PRIVATE | \
1202                                         JVM_ACC_PROTECTED | \
1203                                         JVM_ACC_STATIC | \
1204                                         JVM_ACC_FINAL | \
1205                                         JVM_ACC_VOLATILE | \
1206                                         JVM_ACC_TRANSIENT | \
1207                                         JVM_ACC_ENUM | \
1208                                         JVM_ACC_SYNTHETIC)
1209 
1210 #define JVM_RECOGNIZED_METHOD_MODIFIERS (JVM_ACC_PUBLIC | \
1211                                          JVM_ACC_PRIVATE | \
1212                                          JVM_ACC_PROTECTED | \
1213                                          JVM_ACC_STATIC | \
1214                                          JVM_ACC_FINAL | \
1215                                          JVM_ACC_SYNCHRONIZED | \
1216                                          JVM_ACC_BRIDGE | \
1217                                          JVM_ACC_VARARGS | \
1218                                          JVM_ACC_NATIVE | \
1219                                          JVM_ACC_ABSTRACT | \
1220                                          JVM_ACC_STRICT | \
1221                                          JVM_ACC_SYNTHETIC)
1222 
1223 /*
1224  * This is the function defined in libjava.so to perform path
1225  * canonicalization. VM call this function before opening jar files
1226  * to load system classes.
1227  *
1228  */
1229 
1230 typedef int (*canonicalize_fn_t)(JNIEnv *env, char *orig, char *out, int len);
1231 
1232 /*************************************************************************
1233  PART 3: I/O and Network Support
1234  ************************************************************************/
1235 
1236 /* Note that the JVM IO functions are expected to return JVM_IO_ERR
1237  * when there is any kind of error. The caller can then use the
1238  * platform specific support (e.g., errno) to get the detailed
1239  * error info.  The JVM_GetLastErrorString procedure may also be used
1240  * to obtain a descriptive error string.
1241  */
1242 #define JVM_IO_ERR  (-1)
1243 
1244 /* For interruptible IO. Returning JVM_IO_INTR indicates that an IO
1245  * operation has been disrupted by Thread.interrupt. There are a
1246  * number of technical difficulties related to interruptible IO that
1247  * need to be solved. For example, most existing programs do not handle
1248  * InterruptedIOExceptions specially, they simply treat those as any
1249  * IOExceptions, which typically indicate fatal errors.
1250  *
1251  * There are also two modes of operation for interruptible IO. In the
1252  * resumption mode, an interrupted IO operation is guaranteed not to
1253  * have any side-effects, and can be restarted. In the termination mode,
1254  * an interrupted IO operation corrupts the underlying IO stream, so
1255  * that the only reasonable operation on an interrupted stream is to
1256  * close that stream. The resumption mode seems to be impossible to
1257  * implement on Win32 and Solaris. Implementing the termination mode is
1258  * easier, but it's not clear that's the right semantics.
1259  *
1260  * Interruptible IO is not supported on Win32.It can be enabled/disabled
1261  * using a compile-time flag on Solaris. Third-party JVM ports do not
1262  * need to implement interruptible IO.
1263  */
1264 #define JVM_IO_INTR (-2)
1265 
1266 /* Write a string into the given buffer, in the platform's local encoding,
1267  * that describes the most recent system-level error to occur in this thread.
1268  * Return the length of the string or zero if no error occurred.
1269  */
1270 JNIEXPORT jint JNICALL
1271 JVM_GetLastErrorString(char *buf, int len);
1272 
1273 /*
1274  * Convert a pathname into native format.  This function does syntactic
1275  * cleanup, such as removing redundant separator characters.  It modifies
1276  * the given pathname string in place.
1277  */
1278 JNIEXPORT char * JNICALL
1279 JVM_NativePath(char *);
1280 
1281 /*
1282  * JVM I/O error codes
1283  */
1284 #define JVM_EEXIST       -100
1285 
1286 /*
1287  * Open a file descriptor. This function returns a negative error code
1288  * on error, and a non-negative integer that is the file descriptor on
1289  * success.
1290  */
1291 JNIEXPORT jint JNICALL
1292 JVM_Open(const char *fname, jint flags, jint mode);
1293 
1294 /*
1295  * Close a file descriptor. This function returns -1 on error, and 0
1296  * on success.
1297  *
1298  * fd        the file descriptor to close.
1299  */
1300 JNIEXPORT jint JNICALL
1301 JVM_Close(jint fd);
1302 
1303 /*
1304  * Read data from a file decriptor into a char array.
1305  *
1306  * fd        the file descriptor to read from.
1307  * buf       the buffer where to put the read data.
1308  * nbytes    the number of bytes to read.
1309  *
1310  * This function returns -1 on error, and 0 on success.
1311  */
1312 JNIEXPORT jint JNICALL
1313 JVM_Read(jint fd, char *buf, jint nbytes);
1314 
1315 /*
1316  * Write data from a char array to a file decriptor.
1317  *
1318  * fd        the file descriptor to read from.
1319  * buf       the buffer from which to fetch the data.
1320  * nbytes    the number of bytes to write.
1321  *
1322  * This function returns -1 on error, and 0 on success.
1323  */
1324 JNIEXPORT jint JNICALL
1325 JVM_Write(jint fd, char *buf, jint nbytes);
1326 
1327 /*
1328  * Returns the number of bytes available for reading from a given file
1329  * descriptor
1330  */
1331 JNIEXPORT jint JNICALL
1332 JVM_Available(jint fd, jlong *pbytes);
1333 
1334 /*
1335  * Move the file descriptor pointer from whence by offset.
1336  *
1337  * fd        the file descriptor to move.
1338  * offset    the number of bytes to move it by.
1339  * whence    the start from where to move it.
1340  *
1341  * This function returns the resulting pointer location.
1342  */
1343 JNIEXPORT jlong JNICALL
1344 JVM_Lseek(jint fd, jlong offset, jint whence);
1345 
1346 /*
1347  * Set the length of the file associated with the given descriptor to the given
1348  * length.  If the new length is longer than the current length then the file
1349  * is extended; the contents of the extended portion are not defined.  The
1350  * value of the file pointer is undefined after this procedure returns.
1351  */
1352 JNIEXPORT jint JNICALL
1353 JVM_SetLength(jint fd, jlong length);
1354 
1355 /*
1356  * Synchronize the file descriptor's in memory state with that of the
1357  * physical device.  Return of -1 is an error, 0 is OK.
1358  */
1359 JNIEXPORT jint JNICALL
1360 JVM_Sync(jint fd);
1361 
1362 /*
1363  * Networking library support
1364  */
1365 
1366 JNIEXPORT jint JNICALL
1367 JVM_InitializeSocketLibrary(void);
1368 
1369 struct sockaddr;
1370 
1371 JNIEXPORT jint JNICALL
1372 JVM_Socket(jint domain, jint type, jint protocol);
1373 
1374 JNIEXPORT jint JNICALL
1375 JVM_SocketClose(jint fd);
1376 
1377 JNIEXPORT jint JNICALL
1378 JVM_SocketShutdown(jint fd, jint howto);
1379 
1380 JNIEXPORT jint JNICALL
1381 JVM_Recv(jint fd, char *buf, jint nBytes, jint flags);
1382 
1383 JNIEXPORT jint JNICALL
1384 JVM_Send(jint fd, char *buf, jint nBytes, jint flags);
1385 
1386 JNIEXPORT jint JNICALL
1387 JVM_Timeout(int fd, long timeout);
1388 
1389 JNIEXPORT jint JNICALL
1390 JVM_Listen(jint fd, jint count);
1391 
1392 JNIEXPORT jint JNICALL
1393 JVM_Connect(jint fd, struct sockaddr *him, jint len);
1394 
1395 JNIEXPORT jint JNICALL
1396 JVM_Bind(jint fd, struct sockaddr *him, jint len);
1397 
1398 JNIEXPORT jint JNICALL
1399 JVM_Accept(jint fd, struct sockaddr *him, jint *len);
1400 
1401 JNIEXPORT jint JNICALL
1402 JVM_RecvFrom(jint fd, char *buf, int nBytes,
1403                   int flags, struct sockaddr *from, int *fromlen);
1404 
1405 JNIEXPORT jint JNICALL
1406 JVM_SendTo(jint fd, char *buf, int len,
1407                 int flags, struct sockaddr *to, int tolen);
1408 
1409 JNIEXPORT jint JNICALL
1410 JVM_SocketAvailable(jint fd, jint *result);
1411 
1412 
1413 JNIEXPORT jint JNICALL
1414 JVM_GetSockName(jint fd, struct sockaddr *him, int *len);
1415 
1416 JNIEXPORT jint JNICALL
1417 JVM_GetSockOpt(jint fd, int level, int optname, char *optval, int *optlen);
1418 
1419 JNIEXPORT jint JNICALL
1420 JVM_SetSockOpt(jint fd, int level, int optname, const char *optval, int optlen);
1421 
1422 JNIEXPORT int JNICALL
1423 JVM_GetHostName(char* name, int namelen);
1424 
1425 /*
1426  * The standard printing functions supported by the Java VM. (Should they
1427  * be renamed to JVM_* in the future?
1428  */
1429 
1430 /*
1431  * BE CAREFUL! The following functions do not implement the
1432  * full feature set of standard C printf formats.
1433  */
1434 JNIEXPORT int
1435 jio_vsnprintf(char *str, size_t count, const char *fmt, va_list args);
1436 
1437 JNIEXPORT int
1438 jio_snprintf(char *str, size_t count, const char *fmt, ...);
1439 
1440 JNIEXPORT int
1441 jio_fprintf(FILE *, const char *fmt, ...);
1442 
1443 JNIEXPORT int
1444 jio_vfprintf(FILE *, const char *fmt, va_list args);
1445 
1446 
1447 JNIEXPORT void * JNICALL
1448 JVM_RawMonitorCreate(void);
1449 
1450 JNIEXPORT void JNICALL
1451 JVM_RawMonitorDestroy(void *mon);
1452 
1453 JNIEXPORT jint JNICALL
1454 JVM_RawMonitorEnter(void *mon);
1455 
1456 JNIEXPORT void JNICALL
1457 JVM_RawMonitorExit(void *mon);
1458 
1459 /*
1460  * java.lang.reflect.Method
1461  */
1462 JNIEXPORT jobject JNICALL
1463 JVM_InvokeMethod(JNIEnv *env, jobject method, jobject obj, jobjectArray args0);
1464 
1465 /*
1466  * java.lang.reflect.Constructor
1467  */
1468 JNIEXPORT jobject JNICALL
1469 JVM_NewInstanceFromConstructor(JNIEnv *env, jobject c, jobjectArray args0);
1470 
1471 /*
1472  * java.lang.management support
1473  */
1474 JNIEXPORT void* JNICALL
1475 JVM_GetManagement(jint version);
1476 
1477 /*
1478  * com.sun.tools.attach.VirtualMachine support
1479  *
1480  * Initialize the agent properties with the properties maintained in the VM.
1481  */
1482 JNIEXPORT jobject JNICALL
1483 JVM_InitAgentProperties(JNIEnv *env, jobject agent_props);
1484 
1485 /* Generics reflection support.
1486  *
1487  * Returns information about the given class's EnclosingMethod
1488  * attribute, if present, or null if the class had no enclosing
1489  * method.
1490  *
1491  * If non-null, the returned array contains three elements. Element 0
1492  * is the java.lang.Class of which the enclosing method is a member,
1493  * and elements 1 and 2 are the java.lang.Strings for the enclosing
1494  * method's name and descriptor, respectively.
1495  */
1496 JNIEXPORT jobjectArray JNICALL
1497 JVM_GetEnclosingMethodInfo(JNIEnv* env, jclass ofClass);
1498 
1499 /*
1500  * Java thread state support
1501  */
1502 enum {
1503     JAVA_THREAD_STATE_NEW           = 0,
1504     JAVA_THREAD_STATE_RUNNABLE      = 1,
1505     JAVA_THREAD_STATE_BLOCKED       = 2,
1506     JAVA_THREAD_STATE_WAITING       = 3,
1507     JAVA_THREAD_STATE_TIMED_WAITING = 4,
1508     JAVA_THREAD_STATE_TERMINATED    = 5,
1509     JAVA_THREAD_STATE_COUNT         = 6
1510 };
1511 
1512 /*
1513  * Returns an array of the threadStatus values representing the
1514  * given Java thread state.  Returns NULL if the VM version is
1515  * incompatible with the JDK or doesn't support the given
1516  * Java thread state.
1517  */
1518 JNIEXPORT jintArray JNICALL
1519 JVM_GetThreadStateValues(JNIEnv* env, jint javaThreadState);
1520 
1521 /*
1522  * Returns an array of the substate names representing the
1523  * given Java thread state.  Returns NULL if the VM version is
1524  * incompatible with the JDK or the VM doesn't support
1525  * the given Java thread state.
1526  * values must be the jintArray returned from JVM_GetThreadStateValues
1527  * and javaThreadState.
1528  */
1529 JNIEXPORT jobjectArray JNICALL
1530 JVM_GetThreadStateNames(JNIEnv* env, jint javaThreadState, jintArray values);
1531 
1532 /* =========================================================================
1533  * The following defines a private JVM interface that the JDK can query
1534  * for the JVM version and capabilities.  sun.misc.Version defines
1535  * the methods for getting the VM version and its capabilities.
1536  *
1537  * When a new bit is added, the following should be updated to provide
1538  * access to the new capability:
1539  *    HS:   JVM_GetVersionInfo and Abstract_VM_Version class
1540  *    SDK:  Version class
1541  *
1542  * Similary, a private JDK interface JDK_GetVersionInfo0 is defined for
1543  * JVM to query for the JDK version and capabilities.
1544  *
1545  * When a new bit is added, the following should be updated to provide
1546  * access to the new capability:
1547  *    HS:   JDK_Version class
1548  *    SDK:  JDK_GetVersionInfo0
1549  *
1550  * ==========================================================================
1551  */
1552 typedef struct {
1553     /* HotSpot Express VM version string:
1554      * <major>.<minor>-bxx[-<identifier>][-<debug_flavor>]
1555      */
1556     unsigned int jvm_version; /* Consists of major.minor.0.build */
1557     unsigned int update_version : 8;         /* 0 in HotSpot Express VM */
1558     unsigned int special_update_version : 8; /* 0 in HotSpot Express VM */
1559     unsigned int reserved1 : 16;
1560     unsigned int reserved2;
1561 
1562     /* The following bits represents JVM supports that JDK has dependency on.
1563      * JDK can use these bits to determine which JVM version
1564      * and support it has to maintain runtime compatibility.
1565      *
1566      * When a new bit is added in a minor or update release, make sure
1567      * the new bit is also added in the main/baseline.
1568      */
1569     unsigned int is_attachable : 1;
1570     unsigned int : 31;
1571     unsigned int : 32;
1572     unsigned int : 32;
1573 } jvm_version_info;
1574 
1575 #define JVM_VERSION_MAJOR(version) ((version & 0xFF000000) >> 24)
1576 #define JVM_VERSION_MINOR(version) ((version & 0x00FF0000) >> 16)
1577 // Micro version is 0 in HotSpot Express VM (set in jvm.cpp).
1578 #define JVM_VERSION_MICRO(version) ((version & 0x0000FF00) >> 8)
1579 /* Build number is available in all HotSpot Express VM builds.
1580  * It is defined in make/hotspot_version file.
1581  */
1582 #define JVM_VERSION_BUILD(version) ((version & 0x000000FF))
1583 
1584 JNIEXPORT void JNICALL
1585 JVM_GetVersionInfo(JNIEnv* env, jvm_version_info* info, size_t info_size);
1586 
1587 typedef struct {
1588     // Naming convention of RE build version string: n.n.n[_uu[c]][-<identifier>]-bxx
1589     unsigned int jdk_version;   /* Consists of major, minor, micro (n.n.n) */
1590                                 /* and build number (xx) */
1591     unsigned int update_version : 8;         /* Update release version (uu) */
1592     unsigned int special_update_version : 8; /* Special update release version (c)*/
1593     unsigned int reserved1 : 16;
1594     unsigned int reserved2;
1595 
1596     /* The following bits represents new JDK supports that VM has dependency on.
1597      * VM implementation can use these bits to determine which JDK version
1598      * and support it has to maintain runtime compatibility.
1599      *
1600      * When a new bit is added in a minor or update release, make sure
1601      * the new bit is also added in the main/baseline.
1602      */
1603     unsigned int thread_park_blocker : 1;
1604     unsigned int post_vm_init_hook_enabled : 1;
1605     unsigned int pending_list_uses_discovered_field : 1;
1606     unsigned int : 29;
1607     unsigned int : 32;
1608     unsigned int : 32;
1609 } jdk_version_info;
1610 
1611 #define JDK_VERSION_MAJOR(version) ((version & 0xFF000000) >> 24)
1612 #define JDK_VERSION_MINOR(version) ((version & 0x00FF0000) >> 16)
1613 #define JDK_VERSION_MICRO(version) ((version & 0x0000FF00) >> 8)
1614 
1615 /* Build number is available only for RE build (i.e. JDK_BUILD_NUMBER is set to bNN)
1616  * It will be zero for internal builds.
1617  */
1618 #define JDK_VERSION_BUILD(version) ((version & 0x000000FF))
1619 
1620 /*
1621  * This is the function JDK_GetVersionInfo0 defined in libjava.so
1622  * that is dynamically looked up by JVM.
1623  */
1624 typedef void (*jdk_version_info_fn_t)(jdk_version_info* info, size_t info_size);
1625 
1626 /*
1627  * This structure is used by the launcher to get the default thread
1628  * stack size from the VM using JNI_GetDefaultJavaVMInitArgs() with a
1629  * version of 1.1.  As it is not supported otherwise, it has been removed
1630  * from jni.h
1631  */
1632 typedef struct JDK1_1InitArgs {
1633     jint version;
1634 
1635     char **properties;
1636     jint checkSource;
1637     jint nativeStackSize;
1638     jint javaStackSize;
1639     jint minHeapSize;
1640     jint maxHeapSize;
1641     jint verifyMode;
1642     char *classpath;
1643 
1644     jint (JNICALL *vfprintf)(FILE *fp, const char *format, va_list args);
1645     void (JNICALL *exit)(jint code);
1646     void (JNICALL *abort)(void);
1647 
1648     jint enableClassGC;
1649     jint enableVerboseGC;
1650     jint disableAsyncGC;
1651     jint verbose;
1652     jboolean debugging;
1653     jint debugPort;
1654 } JDK1_1InitArgs;
1655 
1656 #ifdef __cplusplus
1657 } /* extern "C" */
1658 #endif /* __cplusplus */
1659 
1660 #endif /* !_JAVASOFT_JVM_H_ */
1661 
1662 #endif // SHARE_VM_PRIMS_JVM_H