1 /*
   2  * Copyright (c) 1997, 2025, 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.  Oracle designates this
   8  * particular file as subject to the "Classpath" exception as provided
   9  * by Oracle in the LICENSE file that accompanied this code.
  10  *
  11  * This code is distributed in the hope that it will be useful, but WITHOUT
  12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14  * version 2 for more details (a copy is included in the LICENSE file that
  15  * accompanied this code).
  16  *
  17  * You should have received a copy of the GNU General Public License version
  18  * 2 along with this work; if not, write to the Free Software Foundation,
  19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any
  23  * questions.
  24  */
  25 
  26 #ifndef _JAVASOFT_JVM_H_
  27 #define _JAVASOFT_JVM_H_
  28 
  29 #include <sys/stat.h>
  30 
  31 #include "jni.h"
  32 #include "jvm_constants.h"
  33 #include "jvm_io.h"
  34 #include "jvm_md.h"
  35 
  36 #ifdef __cplusplus
  37 extern "C" {
  38 #endif
  39 
  40 /*
  41  * This file contains additional functions exported from the VM.
  42  * These functions are complementary to the standard JNI support.
  43  * There are three parts to this file:
  44  *
  45  * First, this file contains the VM-related functions needed by native
  46  * libraries in the standard Java API. For example, the java.lang.Object
  47  * class needs VM-level functions that wait for and notify monitors.
  48  *
  49  * Second, (included from jvm_constants.h) constant definitions
  50  * needed by the byte code verifier and class file format checker.
  51  * These definitions allow the verifier and format checker to be written
  52  * in a VM-independent way.
  53  *
  54  * Third, this file contains various I/O and network operations needed
  55  * by the standard Java I/O and network APIs. A part of these APIs,
  56  * namely the jio_xxxprintf functions, are included from jvm_io.h.
  57  */
  58 
  59 
  60 /*************************************************************************
  61  PART 1: Functions for Native Libraries
  62  ************************************************************************/
  63 /*
  64  * java.lang.Object
  65  */
  66 JNIEXPORT jint JNICALL
  67 JVM_IHashCode(JNIEnv *env, jobject obj);
  68 
  69 JNIEXPORT void JNICALL
  70 JVM_MonitorWait(JNIEnv *env, jobject obj, jlong ms);
  71 
  72 JNIEXPORT void JNICALL
  73 JVM_MonitorNotify(JNIEnv *env, jobject obj);
  74 
  75 JNIEXPORT void JNICALL
  76 JVM_MonitorNotifyAll(JNIEnv *env, jobject obj);
  77 
  78 JNIEXPORT jobject JNICALL
  79 JVM_Clone(JNIEnv *env, jobject obj);
  80 
  81 /*
  82  * java.lang.String
  83  */
  84 JNIEXPORT jstring JNICALL
  85 JVM_InternString(JNIEnv *env, jstring str);
  86 
  87 /*
  88  * java.lang.System
  89  */
  90 JNIEXPORT jboolean JNICALL
  91 JVM_AOTIsTraining(JNIEnv *env);
  92 
  93 JNIEXPORT void JNICALL
  94 JVM_AOTEndTraining(JNIEnv *env);
  95 
  96 JNIEXPORT jlong JNICALL
  97 JVM_CurrentTimeMillis(JNIEnv *env, jclass ignored);
  98 
  99 JNIEXPORT jlong JNICALL
 100 JVM_NanoTime(JNIEnv *env, jclass ignored);
 101 
 102 JNIEXPORT jlong JNICALL
 103 JVM_GetNanoTimeAdjustment(JNIEnv *env, jclass ignored, jlong offset_secs);
 104 
 105 JNIEXPORT void JNICALL
 106 JVM_ArrayCopy(JNIEnv *env, jclass ignored, jobject src, jint src_pos,
 107               jobject dst, jint dst_pos, jint length);
 108 
 109 /*
 110  * Return an array of all properties as alternating name and value pairs.
 111  */
 112 JNIEXPORT jobjectArray JNICALL
 113 JVM_GetProperties(JNIEnv *env);
 114 
 115 /*
 116  * java.lang.Runtime
 117  */
 118 JNIEXPORT void JNICALL
 119 JVM_BeforeHalt();
 120 
 121 JNIEXPORT void JNICALL
 122 JVM_Halt(jint code);
 123 
 124 JNIEXPORT void JNICALL
 125 JVM_GC(void);
 126 
 127 /* Returns the number of real-time milliseconds that have elapsed since the
 128  * least-recently-inspected heap object was last inspected by the garbage
 129  * collector.
 130  *
 131  * For simple stop-the-world collectors this value is just the time
 132  * since the most recent collection.  For generational collectors it is the
 133  * time since the oldest generation was most recently collected.  Other
 134  * collectors are free to return a pessimistic estimate of the elapsed time, or
 135  * simply the time since the last full collection was performed.
 136  *
 137  * Note that in the presence of reference objects, a given object that is no
 138  * longer strongly reachable may have to be inspected multiple times before it
 139  * can be reclaimed.
 140  */
 141 JNIEXPORT jlong JNICALL
 142 JVM_MaxObjectInspectionAge(void);
 143 
 144 JNIEXPORT jlong JNICALL
 145 JVM_TotalMemory(void);
 146 
 147 JNIEXPORT jlong JNICALL
 148 JVM_FreeMemory(void);
 149 
 150 JNIEXPORT jlong JNICALL
 151 JVM_MaxMemory(void);
 152 
 153 JNIEXPORT jint JNICALL
 154 JVM_ActiveProcessorCount(void);
 155 
 156 JNIEXPORT jboolean JNICALL
 157 JVM_IsUseContainerSupport(void);
 158 
 159 JNIEXPORT jboolean JNICALL
 160 JVM_IsContainerized(void);
 161 
 162 JNIEXPORT void * JNICALL
 163 JVM_LoadZipLibrary();
 164 
 165 JNIEXPORT void * JNICALL
 166 JVM_LoadLibrary(const char *name, jboolean throwException);
 167 
 168 JNIEXPORT void JNICALL
 169 JVM_UnloadLibrary(void * handle);
 170 
 171 JNIEXPORT void * JNICALL
 172 JVM_FindLibraryEntry(void *handle, const char *name);
 173 
 174 JNIEXPORT jboolean JNICALL
 175 JVM_IsSupportedJNIVersion(jint version);
 176 
 177 JNIEXPORT jobjectArray JNICALL
 178 JVM_GetVmArguments(JNIEnv *env);
 179 
 180 JNIEXPORT jboolean JNICALL
 181 JVM_IsPreviewEnabled(void);
 182 
 183 JNIEXPORT jboolean JNICALL
 184 JVM_IsContinuationsSupported(void);
 185 
 186 JNIEXPORT jboolean JNICALL
 187 JVM_IsForeignLinkerSupported(void);
 188 
 189 JNIEXPORT jboolean JNICALL
 190 JVM_IsStaticallyLinked(void);
 191 
 192 JNIEXPORT void JNICALL
 193 JVM_InitializeFromArchive(JNIEnv* env, jclass cls);
 194 
 195 JNIEXPORT void JNICALL
 196 JVM_RegisterLambdaProxyClassForArchiving(JNIEnv* env, jclass caller,
 197                                          jstring interfaceMethodName,
 198                                          jobject factoryType,
 199                                          jobject interfaceMethodType,
 200                                          jobject implementationMember,
 201                                          jobject dynamicMethodType,
 202                                          jclass lambdaProxyClass);
 203 
 204 JNIEXPORT jclass JNICALL
 205 JVM_LookupLambdaProxyClassFromArchive(JNIEnv* env, jclass caller,
 206                                       jstring interfaceMethodName,
 207                                       jobject factoryType,
 208                                       jobject interfaceMethodType,
 209                                       jobject implementationMember,
 210                                       jobject dynamicMethodType);
 211 
 212 JNIEXPORT jint JNICALL
 213 JVM_GetCDSConfigStatus();
 214 
 215 JNIEXPORT jlong JNICALL
 216 JVM_GetRandomSeedForDumping();
 217 
 218 JNIEXPORT void JNICALL
 219 JVM_LogLambdaFormInvoker(JNIEnv* env, jstring line);
 220 
 221 JNIEXPORT void JNICALL
 222 JVM_LogDynamicProxy(JNIEnv *env, jobject loader, jstring proxy_name, jobjectArray interfaces, jint accessFlags);
 223 
 224 JNIEXPORT void JNICALL
 225 JVM_DumpClassListToFile(JNIEnv* env, jstring fileName);
 226 
 227 JNIEXPORT void JNICALL
 228 JVM_DumpDynamicArchive(JNIEnv* env, jstring archiveName);
 229 
 230 /*
 231  * java.lang.Throwable
 232  */
 233 JNIEXPORT void JNICALL
 234 JVM_FillInStackTrace(JNIEnv *env, jobject throwable);
 235 
 236 /*
 237  * java.lang.StackTraceElement
 238  */
 239 JNIEXPORT void JNICALL
 240 JVM_InitStackTraceElementArray(JNIEnv *env, jobjectArray elements, jobject backtrace, jint depth);
 241 
 242 JNIEXPORT void JNICALL
 243 JVM_InitStackTraceElement(JNIEnv* env, jobject element, jobject stackFrameInfo);
 244 
 245 /*
 246  * java.lang.NullPointerException
 247  */
 248 
 249 JNIEXPORT jstring JNICALL
 250 JVM_GetExtendedNPEMessage(JNIEnv *env, jthrowable throwable);
 251 
 252 /*
 253  * java.lang.StackWalker
 254  */
 255 enum {
 256   JVM_STACKWALK_CLASS_INFO_ONLY            = 0x2,
 257   JVM_STACKWALK_SHOW_HIDDEN_FRAMES         = 0x20,
 258   JVM_STACKWALK_FILL_LIVE_STACK_FRAMES     = 0x100
 259 };
 260 
 261 JNIEXPORT void JNICALL
 262 JVM_ExpandStackFrameInfo(JNIEnv *env, jobject obj);
 263 
 264 JNIEXPORT jobject JNICALL
 265 JVM_CallStackWalk(JNIEnv *env, jobject stackStream, jint mode,
 266                   jint skip_frames, jobject contScope, jobject cont,
 267                   jint buffer_size, jint start_index, jobjectArray frames);
 268 
 269 JNIEXPORT jint JNICALL
 270 JVM_MoreStackWalk(JNIEnv *env, jobject stackStream, jint mode, jlong anchor,
 271                   jint last_batch_count, jint buffer_size, jint start_index,
 272                   jobjectArray frames);
 273 
 274 JNIEXPORT void JNICALL
 275 JVM_SetStackWalkContinuation(JNIEnv *env, jobject stackStream, jlong anchor, jobjectArray frames, jobject cont);
 276 
 277 /*
 278  * java.lang.Thread
 279  */
 280 JNIEXPORT void JNICALL
 281 JVM_StartThread(JNIEnv *env, jobject thread);
 282 
 283 JNIEXPORT void JNICALL
 284 JVM_SetThreadPriority(JNIEnv *env, jobject thread, jint prio);
 285 
 286 JNIEXPORT void JNICALL
 287 JVM_Yield(JNIEnv *env, jclass threadClass);
 288 
 289 JNIEXPORT void JNICALL
 290 JVM_SleepNanos(JNIEnv *env, jclass threadClass, jlong nanos);
 291 
 292 JNIEXPORT jobject JNICALL
 293 JVM_CurrentCarrierThread(JNIEnv *env, jclass threadClass);
 294 
 295 JNIEXPORT jobject JNICALL
 296 JVM_CurrentThread(JNIEnv *env, jclass threadClass);
 297 
 298 JNIEXPORT void JNICALL
 299 JVM_SetCurrentThread(JNIEnv *env, jobject thisThread, jobject theThread);
 300 
 301 JNIEXPORT void JNICALL
 302 JVM_Interrupt(JNIEnv *env, jobject thread);
 303 
 304 JNIEXPORT jboolean JNICALL
 305 JVM_HoldsLock(JNIEnv *env, jclass threadClass, jobject obj);
 306 
 307 JNIEXPORT jobject JNICALL
 308 JVM_GetStackTrace(JNIEnv *env, jobject thread);
 309 
 310 JNIEXPORT jobjectArray JNICALL
 311 JVM_GetAllThreads(JNIEnv *env, jclass dummy);
 312 
 313 JNIEXPORT void JNICALL
 314 JVM_SetNativeThreadName(JNIEnv *env, jobject jthread, jstring name);
 315 
 316 /* getStackTrace() and getAllStackTraces() method */
 317 JNIEXPORT jobjectArray JNICALL
 318 JVM_DumpThreads(JNIEnv *env, jclass threadClass, jobjectArray threads);
 319 
 320 JNIEXPORT jobject JNICALL
 321 JVM_ScopedValueCache(JNIEnv *env, jclass threadClass);
 322 
 323 JNIEXPORT void JNICALL
 324 JVM_SetScopedValueCache(JNIEnv *env, jclass threadClass, jobject theCache);
 325 
 326 JNIEXPORT jobject JNICALL
 327 JVM_FindScopedValueBindings(JNIEnv *env, jclass threadClass);
 328 
 329 JNIEXPORT jlong JNICALL
 330 JVM_GetNextThreadIdOffset(JNIEnv *env, jclass threadClass);
 331 
 332 /*
 333  * jdk.internal.vm.Continuation
 334  */
 335 JNIEXPORT void JNICALL
 336 JVM_RegisterContinuationMethods(JNIEnv *env, jclass cls);
 337 
 338 /*
 339  * java.lang.Package
 340  */
 341 JNIEXPORT jstring JNICALL
 342 JVM_GetSystemPackage(JNIEnv *env, jstring name);
 343 
 344 JNIEXPORT jobjectArray JNICALL
 345 JVM_GetSystemPackages(JNIEnv *env);
 346 
 347 /*
 348  * java.lang.ref.Reference
 349  */
 350 JNIEXPORT jobject JNICALL
 351 JVM_GetAndClearReferencePendingList(JNIEnv *env);
 352 
 353 JNIEXPORT jboolean JNICALL
 354 JVM_HasReferencePendingList(JNIEnv *env);
 355 
 356 JNIEXPORT void JNICALL
 357 JVM_WaitForReferencePendingList(JNIEnv *env);
 358 
 359 JNIEXPORT jboolean JNICALL
 360 JVM_ReferenceRefersTo(JNIEnv *env, jobject ref, jobject o);
 361 
 362 JNIEXPORT void JNICALL
 363 JVM_ReferenceClear(JNIEnv *env, jobject ref);
 364 
 365 /*
 366  * java.lang.ref.PhantomReference
 367  */
 368 JNIEXPORT jboolean JNICALL
 369 JVM_PhantomReferenceRefersTo(JNIEnv *env, jobject ref, jobject o);
 370 
 371 /*
 372  * java.io.ObjectInputStream
 373  */
 374 JNIEXPORT jobject JNICALL
 375 JVM_LatestUserDefinedLoader(JNIEnv *env);
 376 
 377 /*
 378  * java.lang.reflect.Array
 379  */
 380 JNIEXPORT jint JNICALL
 381 JVM_GetArrayLength(JNIEnv *env, jobject arr);
 382 
 383 JNIEXPORT jobject JNICALL
 384 JVM_GetArrayElement(JNIEnv *env, jobject arr, jint index);
 385 
 386 JNIEXPORT jvalue JNICALL
 387 JVM_GetPrimitiveArrayElement(JNIEnv *env, jobject arr, jint index, jint wCode);
 388 
 389 JNIEXPORT void JNICALL
 390 JVM_SetArrayElement(JNIEnv *env, jobject arr, jint index, jobject val);
 391 
 392 JNIEXPORT void JNICALL
 393 JVM_SetPrimitiveArrayElement(JNIEnv *env, jobject arr, jint index, jvalue v,
 394                              unsigned char vCode);
 395 
 396 JNIEXPORT jobject JNICALL
 397 JVM_NewArray(JNIEnv *env, jclass eltClass, jint length);
 398 
 399 JNIEXPORT jobject JNICALL
 400 JVM_NewMultiArray(JNIEnv *env, jclass eltClass, jintArray dim);
 401 
 402 
 403 /*
 404  * Returns the immediate caller class of the native method invoking
 405  * JVM_GetCallerClass.  The Method.invoke and other frames due to
 406  * reflection machinery are skipped.
 407  *
 408  * The caller is expected to be marked with
 409  * jdk.internal.reflect.CallerSensitive. The JVM will throw an
 410  * error if it is not marked properly.
 411  */
 412 JNIEXPORT jclass JNICALL
 413 JVM_GetCallerClass(JNIEnv *env);
 414 
 415 
 416 /*
 417  * Find primitive classes
 418  * utf: class name
 419  */
 420 JNIEXPORT jclass JNICALL
 421 JVM_FindPrimitiveClass(JNIEnv *env, const char *utf);
 422 
 423 
 424 /*
 425  * Find a class from a boot class loader. Returns null if class not found.
 426  */
 427 JNIEXPORT jclass JNICALL
 428 JVM_FindClassFromBootLoader(JNIEnv *env, const char *name);
 429 
 430 /*
 431  * Find a class from a given class loader.  Throws ClassNotFoundException.
 432  *  name:   name of class
 433  *  init:   whether initialization is done
 434  *  loader: class loader to look up the class. This may not be the same as the caller's
 435  *          class loader.
 436  *  caller: initiating class. The initiating class may be null when a security
 437  *          manager is not installed.
 438  */
 439 JNIEXPORT jclass JNICALL
 440 JVM_FindClassFromCaller(JNIEnv *env, const char *name, jboolean init,
 441                         jobject loader, jclass caller);
 442 
 443 /*
 444  * Find a class from a given class.
 445  */
 446 JNIEXPORT jclass JNICALL
 447 JVM_FindClassFromClass(JNIEnv *env, const char *name, jboolean init,
 448                              jclass from);
 449 
 450 /* Find a loaded class cached by the VM */
 451 JNIEXPORT jclass JNICALL
 452 JVM_FindLoadedClass(JNIEnv *env, jobject loader, jstring name);
 453 
 454 /* Define a class */
 455 JNIEXPORT jclass JNICALL
 456 JVM_DefineClass(JNIEnv *env, const char *name, jobject loader, const jbyte *buf,
 457                 jsize len, jobject pd);
 458 
 459 /* Define a class with a source (added in JDK1.5) */
 460 JNIEXPORT jclass JNICALL
 461 JVM_DefineClassWithSource(JNIEnv *env, const char *name, jobject loader,
 462                           const jbyte *buf, jsize len, jobject pd,
 463                           const char *source);
 464 
 465 /*
 466  * Define a class with the specified lookup class.
 467  *  lookup:  Lookup class
 468  *  name:    the name of the class
 469  *  buf:     class bytes
 470  *  len:     length of class bytes
 471  *  pd:      protection domain
 472  *  init:    initialize the class
 473  *  flags:   properties of the class
 474  *  classData: private static pre-initialized field; may be null
 475  */
 476 JNIEXPORT jclass JNICALL
 477 JVM_LookupDefineClass(JNIEnv *env, jclass lookup, const char *name, const jbyte *buf,
 478                       jsize len, jobject pd, jboolean init, int flags, jobject classData);
 479 
 480 /*
 481  * Module support functions
 482  */
 483 
 484 /*
 485  * Define a module with the specified packages and bind the module to the
 486  * given class loader.
 487  *  module:       module to define
 488  *  is_open:      specifies if module is open (currently ignored)
 489  *  version:      the module version
 490  *  location:     the module location
 491  *  packages:     array of packages in the module
 492  */
 493 JNIEXPORT void JNICALL
 494 JVM_DefineModule(JNIEnv *env, jobject module, jboolean is_open, jstring version,
 495                  jstring location, jobjectArray packages);
 496 
 497 /*
 498  * Set the boot loader's unnamed module.
 499  *  module: boot loader's unnamed module
 500  */
 501 JNIEXPORT void JNICALL
 502 JVM_SetBootLoaderUnnamedModule(JNIEnv *env, jobject module);
 503 
 504 /*
 505  * Do a qualified export of a package.
 506  *  from_module: module containing the package to export
 507  *  package:     name of the package to export
 508  *  to_module:   module to export the package to
 509  */
 510 JNIEXPORT void JNICALL
 511 JVM_AddModuleExports(JNIEnv *env, jobject from_module, jstring package, jobject to_module);
 512 
 513 /*
 514  * Do an export of a package to all unnamed modules.
 515  *  from_module: module containing the package to export
 516  *  package:     name of the package to export to all unnamed modules
 517  */
 518 JNIEXPORT void JNICALL
 519 JVM_AddModuleExportsToAllUnnamed(JNIEnv *env, jobject from_module, jstring package);
 520 
 521 /*
 522  * Do an unqualified export of a package.
 523  *  from_module: module containing the package to export
 524  *  package:     name of the package to export
 525  */
 526 JNIEXPORT void JNICALL
 527 JVM_AddModuleExportsToAll(JNIEnv *env, jobject from_module, jstring package);
 528 
 529 /*
 530  * Add a module to the list of modules that a given module can read.
 531  *  from_module:   module requesting read access
 532  *  source_module: module that from_module wants to read
 533  */
 534 JNIEXPORT void JNICALL
 535 JVM_AddReadsModule(JNIEnv *env, jobject from_module, jobject source_module);
 536 
 537 /*
 538  * Define all modules that have been stored in the CDS archived heap.
 539  *  platform_loader: the built-in platform class loader
 540  *  system_loader:   the built-in system class loader
 541  */
 542 JNIEXPORT void JNICALL
 543 JVM_DefineArchivedModules(JNIEnv *env, jobject platform_loader, jobject system_loader);
 544 
 545 /*
 546  * Reflection support functions
 547  */
 548 
 549 JNIEXPORT jstring JNICALL
 550 JVM_InitClassName(JNIEnv *env, jclass cls);
 551 
 552 JNIEXPORT jobjectArray JNICALL
 553 JVM_GetClassInterfaces(JNIEnv *env, jclass cls);
 554 
 555 JNIEXPORT jboolean JNICALL
 556 JVM_IsInterface(JNIEnv *env, jclass cls);
 557 
 558 JNIEXPORT jobject JNICALL
 559 JVM_GetProtectionDomain(JNIEnv *env, jclass cls);
 560 
 561 JNIEXPORT jboolean JNICALL
 562 JVM_IsArrayClass(JNIEnv *env, jclass cls);
 563 
 564 JNIEXPORT jboolean JNICALL
 565 JVM_IsPrimitiveClass(JNIEnv *env, jclass cls);
 566 
 567 JNIEXPORT jboolean JNICALL
 568 JVM_IsHiddenClass(JNIEnv *env, jclass cls);
 569 
 570 JNIEXPORT jint JNICALL
 571 JVM_GetClassModifiers(JNIEnv *env, jclass cls);
 572 
 573 JNIEXPORT jobjectArray JNICALL
 574 JVM_GetDeclaredClasses(JNIEnv *env, jclass ofClass);
 575 
 576 JNIEXPORT jclass JNICALL
 577 JVM_GetDeclaringClass(JNIEnv *env, jclass ofClass);
 578 
 579 JNIEXPORT jstring JNICALL
 580 JVM_GetSimpleBinaryName(JNIEnv *env, jclass ofClass);
 581 
 582 /* Generics support (JDK 1.5) */
 583 JNIEXPORT jstring JNICALL
 584 JVM_GetClassSignature(JNIEnv *env, jclass cls);
 585 
 586 /* Annotations support (JDK 1.5) */
 587 JNIEXPORT jbyteArray JNICALL
 588 JVM_GetClassAnnotations(JNIEnv *env, jclass cls);
 589 
 590 /* Type use annotations support (JDK 1.8) */
 591 
 592 JNIEXPORT jbyteArray JNICALL
 593 JVM_GetClassTypeAnnotations(JNIEnv *env, jclass cls);
 594 
 595 JNIEXPORT jbyteArray JNICALL
 596 JVM_GetFieldTypeAnnotations(JNIEnv *env, jobject field);
 597 
 598 JNIEXPORT jbyteArray JNICALL
 599 JVM_GetMethodTypeAnnotations(JNIEnv *env, jobject method);
 600 
 601 /*
 602  * New (JDK 1.4) reflection implementation
 603  */
 604 
 605 JNIEXPORT jobjectArray JNICALL
 606 JVM_GetClassDeclaredMethods(JNIEnv *env, jclass ofClass, jboolean publicOnly);
 607 
 608 JNIEXPORT jobjectArray JNICALL
 609 JVM_GetClassDeclaredFields(JNIEnv *env, jclass ofClass, jboolean publicOnly);
 610 
 611 JNIEXPORT jobjectArray JNICALL
 612 JVM_GetClassDeclaredConstructors(JNIEnv *env, jclass ofClass, jboolean publicOnly);
 613 
 614 
 615 /* Differs from JVM_GetClassModifiers in treatment of inner classes.
 616    This returns the access flags for the class as specified in the
 617    class file rather than searching the InnerClasses attribute (if
 618    present) to find the source-level access flags. Only the values of
 619    the low 13 bits (i.e., a mask of 0x1FFF) are guaranteed to be
 620    valid. */
 621 JNIEXPORT jint JNICALL
 622 JVM_GetClassAccessFlags(JNIEnv *env, jclass cls);
 623 
 624 /* Nestmates - since JDK 11 */
 625 
 626 JNIEXPORT jboolean JNICALL
 627 JVM_AreNestMates(JNIEnv *env, jclass current, jclass member);
 628 
 629 JNIEXPORT jclass JNICALL
 630 JVM_GetNestHost(JNIEnv *env, jclass current);
 631 
 632 JNIEXPORT jobjectArray JNICALL
 633 JVM_GetNestMembers(JNIEnv *env, jclass current);
 634 
 635 /* Records - since JDK 16 */
 636 
 637 JNIEXPORT jboolean JNICALL
 638 JVM_IsRecord(JNIEnv *env, jclass cls);
 639 
 640 JNIEXPORT jobjectArray JNICALL
 641 JVM_GetRecordComponents(JNIEnv *env, jclass ofClass);
 642 
 643 /* Sealed classes - since JDK 17 */
 644 
 645 JNIEXPORT jobjectArray JNICALL
 646 JVM_GetPermittedSubclasses(JNIEnv *env, jclass current);
 647 
 648 /* The following two reflection routines are still needed due to startup time issues */
 649 /*
 650  * java.lang.reflect.Method
 651  */
 652 JNIEXPORT jobject JNICALL
 653 JVM_InvokeMethod(JNIEnv *env, jobject method, jobject obj, jobjectArray args0);
 654 
 655 /*
 656  * java.lang.reflect.Constructor
 657  */
 658 JNIEXPORT jobject JNICALL
 659 JVM_NewInstanceFromConstructor(JNIEnv *env, jobject c, jobjectArray args0);
 660 
 661 /*
 662  * Constant pool access; currently used to implement reflective access to annotations (JDK 1.5)
 663  */
 664 
 665 JNIEXPORT jobject JNICALL
 666 JVM_GetClassConstantPool(JNIEnv *env, jclass cls);
 667 
 668 JNIEXPORT jint JNICALL JVM_ConstantPoolGetSize
 669 (JNIEnv *env, jobject unused, jobject jcpool);
 670 
 671 JNIEXPORT jclass JNICALL JVM_ConstantPoolGetClassAt
 672 (JNIEnv *env, jobject unused, jobject jcpool, jint index);
 673 
 674 JNIEXPORT jclass JNICALL JVM_ConstantPoolGetClassAtIfLoaded
 675 (JNIEnv *env, jobject unused, jobject jcpool, jint index);
 676 
 677 JNIEXPORT jint JNICALL JVM_ConstantPoolGetClassRefIndexAt
 678 (JNIEnv *env, jobject obj, jobject unused, jint index);
 679 
 680 JNIEXPORT jobject JNICALL JVM_ConstantPoolGetMethodAt
 681 (JNIEnv *env, jobject unused, jobject jcpool, jint index);
 682 
 683 JNIEXPORT jobject JNICALL JVM_ConstantPoolGetMethodAtIfLoaded
 684 (JNIEnv *env, jobject unused, jobject jcpool, jint index);
 685 
 686 JNIEXPORT jobject JNICALL JVM_ConstantPoolGetFieldAt
 687 (JNIEnv *env, jobject unused, jobject jcpool, jint index);
 688 
 689 JNIEXPORT jobject JNICALL JVM_ConstantPoolGetFieldAtIfLoaded
 690 (JNIEnv *env, jobject unused, jobject jcpool, jint index);
 691 
 692 JNIEXPORT jobjectArray JNICALL JVM_ConstantPoolGetMemberRefInfoAt
 693 (JNIEnv *env, jobject unused, jobject jcpool, jint index);
 694 
 695 JNIEXPORT jint JNICALL JVM_ConstantPoolGetNameAndTypeRefIndexAt
 696 (JNIEnv *env, jobject obj, jobject unused, jint index);
 697 
 698 JNIEXPORT jobjectArray JNICALL JVM_ConstantPoolGetNameAndTypeRefInfoAt
 699 (JNIEnv *env, jobject obj, jobject unused, jint index);
 700 
 701 JNIEXPORT jint JNICALL JVM_ConstantPoolGetIntAt
 702 (JNIEnv *env, jobject unused, jobject jcpool, jint index);
 703 
 704 JNIEXPORT jlong JNICALL JVM_ConstantPoolGetLongAt
 705 (JNIEnv *env, jobject unused, jobject jcpool, jint index);
 706 
 707 JNIEXPORT jfloat JNICALL JVM_ConstantPoolGetFloatAt
 708 (JNIEnv *env, jobject unused, jobject jcpool, jint index);
 709 
 710 JNIEXPORT jdouble JNICALL JVM_ConstantPoolGetDoubleAt
 711 (JNIEnv *env, jobject unused, jobject jcpool, jint index);
 712 
 713 JNIEXPORT jstring JNICALL JVM_ConstantPoolGetStringAt
 714 (JNIEnv *env, jobject unused, jobject jcpool, jint index);
 715 
 716 JNIEXPORT jstring JNICALL JVM_ConstantPoolGetUTF8At
 717 (JNIEnv *env, jobject unused, jobject jcpool, jint index);
 718 
 719 JNIEXPORT jbyte JNICALL JVM_ConstantPoolGetTagAt
 720 (JNIEnv *env, jobject unused, jobject jcpool, jint index);
 721 
 722 /*
 723  * Parameter reflection
 724  */
 725 
 726 JNIEXPORT jobjectArray JNICALL
 727 JVM_GetMethodParameters(JNIEnv *env, jobject method);
 728 
 729 /*
 730  * Ensure that code doing a stackwalk and using javaVFrame::locals() to
 731  * get the value will see a materialized value and not a scalar-replaced
 732  * null value.
 733  */
 734 #define JVM_EnsureMaterializedForStackWalk(env, value) \
 735     do {} while(0) // Nothing to do.  The fact that the value escaped
 736                    // through a native method is enough.
 737 JNIEXPORT void JNICALL
 738 JVM_EnsureMaterializedForStackWalk_func(JNIEnv* env, jobject vthread, jobject value);
 739 
 740 /*
 741  * Signal support, used to implement the shutdown sequence.  Every VM must
 742  * support JVM_SIGINT and JVM_SIGTERM, raising the former for user interrupts
 743  * (^C) and the latter for external termination (kill, system shutdown, etc.).
 744  * Other platform-dependent signal values may also be supported.
 745  */
 746 
 747 JNIEXPORT void * JNICALL
 748 JVM_RegisterSignal(jint sig, void *handler);
 749 
 750 JNIEXPORT jboolean JNICALL
 751 JVM_RaiseSignal(jint sig);
 752 
 753 JNIEXPORT jint JNICALL
 754 JVM_FindSignal(const char *name);
 755 
 756 /*
 757  * Retrieve the assertion directives for the specified class.
 758  */
 759 JNIEXPORT jboolean JNICALL
 760 JVM_DesiredAssertionStatus(JNIEnv *env, jclass unused, jclass cls);
 761 
 762 /*
 763  * Retrieve the assertion directives from the VM.
 764  */
 765 JNIEXPORT jobject JNICALL
 766 JVM_AssertionStatusDirectives(JNIEnv *env, jclass unused);
 767 
 768 /*
 769  * java.lang.ref.Finalizer
 770  */
 771 JNIEXPORT void JNICALL
 772 JVM_ReportFinalizationComplete(JNIEnv *env, jobject finalizee);
 773 
 774 JNIEXPORT jboolean JNICALL
 775 JVM_IsFinalizationEnabled(JNIEnv *env);
 776 
 777 /*************************************************************************
 778  PART 2: Support for the Verifier and Class File Format Checker
 779  ************************************************************************/
 780 /*
 781  * Return the class name in UTF format. The result is valid
 782  * until JVM_ReleaseUTf 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_GetClassNameUTF(JNIEnv *env, jclass cb);
 789 
 790 /*
 791  * Returns the constant pool types in the buffer provided by "types."
 792  */
 793 JNIEXPORT void JNICALL
 794 JVM_GetClassCPTypes(JNIEnv *env, jclass cb, unsigned char *types);
 795 
 796 /*
 797  * Returns the number of Constant Pool entries.
 798  */
 799 JNIEXPORT jint JNICALL
 800 JVM_GetClassCPEntriesCount(JNIEnv *env, jclass cb);
 801 
 802 /*
 803  * Returns the number of *declared* fields or methods.
 804  */
 805 JNIEXPORT jint JNICALL
 806 JVM_GetClassFieldsCount(JNIEnv *env, jclass cb);
 807 
 808 JNIEXPORT jint JNICALL
 809 JVM_GetClassMethodsCount(JNIEnv *env, jclass cb);
 810 
 811 /*
 812  * Returns the CP indexes of exceptions raised by a given method.
 813  * Places the result in the given buffer.
 814  *
 815  * The method is identified by method_index.
 816  */
 817 JNIEXPORT void JNICALL
 818 JVM_GetMethodIxExceptionIndexes(JNIEnv *env, jclass cb, jint method_index,
 819                                 unsigned short *exceptions);
 820 /*
 821  * Returns the number of exceptions raised by a given method.
 822  * The method is identified by method_index.
 823  */
 824 JNIEXPORT jint JNICALL
 825 JVM_GetMethodIxExceptionsCount(JNIEnv *env, jclass cb, jint method_index);
 826 
 827 /*
 828  * Returns the byte code sequence of a given method.
 829  * Places the result in the given buffer.
 830  *
 831  * The method is identified by method_index.
 832  */
 833 JNIEXPORT void JNICALL
 834 JVM_GetMethodIxByteCode(JNIEnv *env, jclass cb, jint method_index,
 835                         unsigned char *code);
 836 
 837 /*
 838  * Returns the length of the byte code sequence of a given method.
 839  * The method is identified by method_index.
 840  */
 841 JNIEXPORT jint JNICALL
 842 JVM_GetMethodIxByteCodeLength(JNIEnv *env, jclass cb, jint method_index);
 843 
 844 /*
 845  * A structure used to a capture exception table entry in a Java method.
 846  */
 847 typedef struct {
 848     jint start_pc;
 849     jint end_pc;
 850     jint handler_pc;
 851     jint catchType;
 852 } JVM_ExceptionTableEntryType;
 853 
 854 /*
 855  * Returns the exception table entry at entry_index of a given method.
 856  * Places the result in the given buffer.
 857  *
 858  * The method is identified by method_index.
 859  */
 860 JNIEXPORT void JNICALL
 861 JVM_GetMethodIxExceptionTableEntry(JNIEnv *env, jclass cb, jint method_index,
 862                                    jint entry_index,
 863                                    JVM_ExceptionTableEntryType *entry);
 864 
 865 /*
 866  * Returns the length of the exception table of a given method.
 867  * The method is identified by method_index.
 868  */
 869 JNIEXPORT jint JNICALL
 870 JVM_GetMethodIxExceptionTableLength(JNIEnv *env, jclass cb, int index);
 871 
 872 /*
 873  * Returns the modifiers of a given field.
 874  * The field is identified by field_index.
 875  */
 876 JNIEXPORT jint JNICALL
 877 JVM_GetFieldIxModifiers(JNIEnv *env, jclass cb, int index);
 878 
 879 /*
 880  * Returns the modifiers of a given method.
 881  * The method is identified by method_index.
 882  */
 883 JNIEXPORT jint JNICALL
 884 JVM_GetMethodIxModifiers(JNIEnv *env, jclass cb, int index);
 885 
 886 /*
 887  * Returns the number of local variables of a given method.
 888  * The method is identified by method_index.
 889  */
 890 JNIEXPORT jint JNICALL
 891 JVM_GetMethodIxLocalsCount(JNIEnv *env, jclass cb, int index);
 892 
 893 /*
 894  * Returns the number of arguments (including this pointer) of a given method.
 895  * The method is identified by method_index.
 896  */
 897 JNIEXPORT jint JNICALL
 898 JVM_GetMethodIxArgsSize(JNIEnv *env, jclass cb, int index);
 899 
 900 /*
 901  * Returns the maximum amount of stack (in words) used by a given method.
 902  * The method is identified by method_index.
 903  */
 904 JNIEXPORT jint JNICALL
 905 JVM_GetMethodIxMaxStack(JNIEnv *env, jclass cb, int index);
 906 
 907 /*
 908  * Is a given method a constructor.
 909  * The method is identified by method_index.
 910  */
 911 JNIEXPORT jboolean JNICALL
 912 JVM_IsConstructorIx(JNIEnv *env, jclass cb, int index);
 913 
 914 /*
 915  * Is the given method generated by the VM.
 916  * The method is identified by method_index.
 917  */
 918 JNIEXPORT jboolean JNICALL
 919 JVM_IsVMGeneratedMethodIx(JNIEnv *env, jclass cb, int index);
 920 
 921 /*
 922  * Returns the name of a given method in UTF format.
 923  * The result remains valid until JVM_ReleaseUTF is called.
 924  *
 925  * The caller must treat the string as a constant and not modify it
 926  * in any way.
 927  */
 928 JNIEXPORT const char * JNICALL
 929 JVM_GetMethodIxNameUTF(JNIEnv *env, jclass cb, jint index);
 930 
 931 /*
 932  * Returns the signature of a given method in UTF format.
 933  * The result remains valid until JVM_ReleaseUTF is called.
 934  *
 935  * The caller must treat the string as a constant and not modify it
 936  * in any way.
 937  */
 938 JNIEXPORT const char * JNICALL
 939 JVM_GetMethodIxSignatureUTF(JNIEnv *env, jclass cb, jint index);
 940 
 941 /*
 942  * Returns the name of the field referred to at a given constant pool
 943  * index.
 944  *
 945  * The result is in UTF format and remains valid until JVM_ReleaseUTF
 946  * is called.
 947  *
 948  * The caller must treat the string as a constant and not modify it
 949  * in any way.
 950  */
 951 JNIEXPORT const char * JNICALL
 952 JVM_GetCPFieldNameUTF(JNIEnv *env, jclass cb, jint index);
 953 
 954 /*
 955  * Returns the name of the method referred to at a given constant pool
 956  * index.
 957  *
 958  * The result is in UTF format and remains valid until JVM_ReleaseUTF
 959  * is called.
 960  *
 961  * The caller must treat the string as a constant and not modify it
 962  * in any way.
 963  */
 964 JNIEXPORT const char * JNICALL
 965 JVM_GetCPMethodNameUTF(JNIEnv *env, jclass cb, jint index);
 966 
 967 /*
 968  * Returns the signature of the method referred to at a given constant pool
 969  * index.
 970  *
 971  * The result is in UTF format and remains valid until JVM_ReleaseUTF
 972  * is called.
 973  *
 974  * The caller must treat the string as a constant and not modify it
 975  * in any way.
 976  */
 977 JNIEXPORT const char * JNICALL
 978 JVM_GetCPMethodSignatureUTF(JNIEnv *env, jclass cb, jint index);
 979 
 980 /*
 981  * Returns the signature of the field referred to at a given constant pool
 982  * index.
 983  *
 984  * The result is in UTF format and remains valid until JVM_ReleaseUTF
 985  * is called.
 986  *
 987  * The caller must treat the string as a constant and not modify it
 988  * in any way.
 989  */
 990 JNIEXPORT const char * JNICALL
 991 JVM_GetCPFieldSignatureUTF(JNIEnv *env, jclass cb, jint index);
 992 
 993 /*
 994  * Returns the class name referred to at a given constant pool index.
 995  *
 996  * The result is in UTF format and remains valid until JVM_ReleaseUTF
 997  * is called.
 998  *
 999  * The caller must treat the string as a constant and not modify it
1000  * in any way.
1001  */
1002 JNIEXPORT const char * JNICALL
1003 JVM_GetCPClassNameUTF(JNIEnv *env, jclass cb, jint index);
1004 
1005 /*
1006  * Returns the class name referred to at a given constant pool index.
1007  *
1008  * The constant pool entry must refer to a CONSTANT_Fieldref.
1009  *
1010  * The result is in UTF format and remains valid until JVM_ReleaseUTF
1011  * is called.
1012  *
1013  * The caller must treat the string as a constant and not modify it
1014  * in any way.
1015  */
1016 JNIEXPORT const char * JNICALL
1017 JVM_GetCPFieldClassNameUTF(JNIEnv *env, jclass cb, jint index);
1018 
1019 /*
1020  * Returns the class name referred to at a given constant pool index.
1021  *
1022  * The constant pool entry must refer to CONSTANT_Methodref or
1023  * CONSTANT_InterfaceMethodref.
1024  *
1025  * The result is in UTF format and remains valid until JVM_ReleaseUTF
1026  * is called.
1027  *
1028  * The caller must treat the string as a constant and not modify it
1029  * in any way.
1030  */
1031 JNIEXPORT const char * JNICALL
1032 JVM_GetCPMethodClassNameUTF(JNIEnv *env, jclass cb, jint index);
1033 
1034 /*
1035  * Returns the modifiers of a field in calledClass. The field is
1036  * referred to in class cb at constant pool entry index.
1037  *
1038  * The caller must treat the string as a constant and not modify it
1039  * in any way.
1040  *
1041  * Returns -1 if the field does not exist in calledClass.
1042  */
1043 JNIEXPORT jint JNICALL
1044 JVM_GetCPFieldModifiers(JNIEnv *env, jclass cb, int index, jclass calledClass);
1045 
1046 /*
1047  * Returns the modifiers of a method in calledClass. The method is
1048  * referred to in class cb at constant pool entry index.
1049  *
1050  * Returns -1 if the method does not exist in calledClass.
1051  */
1052 JNIEXPORT jint JNICALL
1053 JVM_GetCPMethodModifiers(JNIEnv *env, jclass cb, int index, jclass calledClass);
1054 
1055 /*
1056  * Releases the UTF string obtained from the VM.
1057  */
1058 JNIEXPORT void JNICALL
1059 JVM_ReleaseUTF(const char *utf);
1060 
1061 /*
1062  * Compare if two classes are in the same package.
1063  */
1064 JNIEXPORT jboolean JNICALL
1065 JVM_IsSameClassPackage(JNIEnv *env, jclass class1, jclass class2);
1066 
1067 
1068 /*************************************************************************
1069  PART 3: I/O and Network Support
1070  ************************************************************************/
1071 
1072 /*
1073  * Convert a pathname into native format.  This function does syntactic
1074  * cleanup, such as removing redundant separator characters.  It modifies
1075  * the given pathname string in place.
1076  */
1077 JNIEXPORT char * JNICALL
1078 JVM_NativePath(char *);
1079 
1080 JNIEXPORT void * JNICALL
1081 JVM_RawMonitorCreate(void);
1082 
1083 JNIEXPORT void JNICALL
1084 JVM_RawMonitorDestroy(void *mon);
1085 
1086 JNIEXPORT jint JNICALL
1087 JVM_RawMonitorEnter(void *mon);
1088 
1089 JNIEXPORT void JNICALL
1090 JVM_RawMonitorExit(void *mon);
1091 
1092 /*
1093  * java.lang.management support
1094  */
1095 JNIEXPORT void* JNICALL
1096 JVM_GetManagement(jint version);
1097 
1098 /*
1099  * com.sun.tools.attach.VirtualMachine support
1100  *
1101  * Initialize the agent properties with the properties maintained in the VM.
1102  */
1103 JNIEXPORT jobject JNICALL
1104 JVM_InitAgentProperties(JNIEnv *env, jobject agent_props);
1105 
1106 JNIEXPORT jstring JNICALL
1107 JVM_GetTemporaryDirectory(JNIEnv *env);
1108 
1109 /* Generics reflection support.
1110  *
1111  * Returns information about the given class's EnclosingMethod
1112  * attribute, if present, or null if the class had no enclosing
1113  * method.
1114  *
1115  * If non-null, the returned array contains three elements. Element 0
1116  * is the java.lang.Class of which the enclosing method is a member,
1117  * and elements 1 and 2 are the java.lang.Strings for the enclosing
1118  * method's name and descriptor, respectively.
1119  */
1120 JNIEXPORT jobjectArray JNICALL
1121 JVM_GetEnclosingMethodInfo(JNIEnv* env, jclass ofClass);
1122 
1123 /*
1124  * Virtual thread support.
1125  */
1126 JNIEXPORT void JNICALL
1127 JVM_VirtualThreadStart(JNIEnv* env, jobject vthread);
1128 
1129 JNIEXPORT void JNICALL
1130 JVM_VirtualThreadEnd(JNIEnv* env, jobject vthread);
1131 
1132 JNIEXPORT void JNICALL
1133 JVM_VirtualThreadMount(JNIEnv* env, jobject vthread, jboolean hide);
1134 
1135 JNIEXPORT void JNICALL
1136 JVM_VirtualThreadUnmount(JNIEnv* env, jobject vthread, jboolean hide);
1137 
1138 JNIEXPORT void JNICALL
1139 JVM_VirtualThreadDisableSuspend(JNIEnv* env, jclass clazz, jboolean enter);
1140 
1141 JNIEXPORT void JNICALL
1142 JVM_VirtualThreadPinnedEvent(JNIEnv* env, jclass clazz, jstring op);
1143 
1144 JNIEXPORT jobject JNICALL
1145 JVM_TakeVirtualThreadListToUnblock(JNIEnv* env, jclass ignored);
1146 
1147 /*
1148  * Core reflection support.
1149  */
1150 JNIEXPORT jint JNICALL
1151 JVM_GetClassFileVersion(JNIEnv *env, jclass current);
1152 
1153 /*
1154  * Return JNI_TRUE if warnings are printed when agents are dynamically loaded.
1155  */
1156 JNIEXPORT jboolean JNICALL
1157 JVM_PrintWarningAtDynamicAgentLoad(void);
1158 
1159 /*
1160  * This structure is used by the launcher to get the default thread
1161  * stack size from the VM using JNI_GetDefaultJavaVMInitArgs() with a
1162  * version of 1.1.  As it is not supported otherwise, it has been removed
1163  * from jni.h
1164  */
1165 typedef struct JDK1_1InitArgs {
1166     jint version;
1167 
1168     char **properties;
1169     jint checkSource;
1170     jint nativeStackSize;
1171     jint javaStackSize;
1172     jint minHeapSize;
1173     jint maxHeapSize;
1174     jint verifyMode;
1175     char *classpath;
1176 
1177     jint (JNICALL *vfprintf)(FILE *fp, const char *format, va_list args);
1178     void (JNICALL *exit)(jint code);
1179     void (JNICALL *abort)(void);
1180 
1181     jint enableClassGC;
1182     jint enableVerboseGC;
1183     jint disableAsyncGC;
1184     jint verbose;
1185     jboolean debugging;
1186     jint debugPort;
1187 } JDK1_1InitArgs;
1188 
1189 
1190 #ifdef __cplusplus
1191 } /* extern "C" */
1192 
1193 #endif /* __cplusplus */
1194 
1195 #endif /* !_JAVASOFT_JVM_H_ */