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