1 /*
   2  * Copyright (c) 1997, 2024, Oracle and/or its affiliates. All rights reserved.
   3  * Copyright (c) 2021, Azul Systems, Inc. All rights reserved.
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * This code is free software; you can redistribute it and/or modify it
   7  * under the terms of the GNU General Public License version 2 only, as
   8  * published by the Free Software Foundation.
   9  *
  10  * This code is distributed in the hope that it will be useful, but WITHOUT
  11  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  12  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  13  * version 2 for more details (a copy is included in the LICENSE file that
  14  * accompanied this code).
  15  *
  16  * You should have received a copy of the GNU General Public License version
  17  * 2 along with this work; if not, write to the Free Software Foundation,
  18  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  19  *
  20  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  21  * or visit www.oracle.com if you need additional information or have any
  22  * questions.
  23  *
  24  */
  25 
  26 #ifndef SHARE_RUNTIME_JAVATHREAD_HPP
  27 #define SHARE_RUNTIME_JAVATHREAD_HPP
  28 
  29 #include "jni.h"
  30 #include "memory/allocation.hpp"
  31 #include "oops/oop.hpp"
  32 #include "oops/oopHandle.hpp"
  33 #include "runtime/frame.hpp"
  34 #include "runtime/globals.hpp"
  35 #include "runtime/handshake.hpp"
  36 #include "runtime/javaFrameAnchor.hpp"
  37 #include "runtime/lockStack.hpp"
  38 #include "runtime/park.hpp"
  39 #include "runtime/safepointMechanism.hpp"
  40 #include "runtime/stackWatermarkSet.hpp"
  41 #include "runtime/stackOverflow.hpp"
  42 #include "runtime/thread.hpp"
  43 #include "runtime/threadHeapSampler.hpp"
  44 #include "runtime/threadStatisticalInfo.hpp"
  45 #include "utilities/exceptions.hpp"
  46 #include "utilities/globalDefinitions.hpp"
  47 #include "utilities/macros.hpp"
  48 #if INCLUDE_JFR
  49 #include "jfr/support/jfrThreadExtension.hpp"
  50 #endif
  51 
  52 class AsyncExceptionHandshake;
  53 class ContinuationEntry;
  54 class DeoptResourceMark;
  55 class InternalOOMEMark;
  56 class JNIHandleBlock;
  57 class JVMCIRuntime;
  58 
  59 class JvmtiDeferredUpdates;
  60 class JvmtiSampledObjectAllocEventCollector;
  61 class JvmtiThreadState;
  62 
  63 class Metadata;
  64 class OopHandleList;
  65 class OopStorage;
  66 class OSThread;
  67 
  68 class ThreadsList;
  69 class ThreadSafepointState;
  70 class ThreadStatistics;
  71 
  72 class vframeArray;
  73 class vframe;
  74 class javaVFrame;
  75 
  76 class JavaThread;
  77 typedef void (*ThreadFunction)(JavaThread*, TRAPS);
  78 
  79 class JavaThread: public Thread {
  80   friend class VMStructs;
  81   friend class JVMCIVMStructs;
  82   friend class WhiteBox;
  83   friend class ThreadsSMRSupport; // to access _threadObj for exiting_threads_oops_do
  84   friend class HandshakeState;
  85   friend class Continuation;
  86   friend class Threads;
  87   friend class ServiceThread; // for deferred OopHandle release access
  88  private:
  89   bool           _on_thread_list;                // Is set when this JavaThread is added to the Threads list
  90 
  91   // All references to Java objects managed via OopHandles. These
  92   // have to be released by the ServiceThread after the JavaThread has
  93   // terminated - see add_oop_handles_for_release().
  94   OopHandle      _threadObj;                     // The Java level thread object
  95   OopHandle      _vthread; // the value returned by Thread.currentThread(): the virtual thread, if mounted, otherwise _threadObj
  96   OopHandle      _jvmti_vthread;
  97   OopHandle      _scopedValueCache;
  98 
  99   static OopStorage* _thread_oop_storage;
 100 
 101 #ifdef ASSERT
 102  private:
 103   int _java_call_counter;
 104 
 105  public:
 106   int  java_call_counter()                       { return _java_call_counter; }
 107   void inc_java_call_counter()                   { _java_call_counter++; }
 108   void dec_java_call_counter() {
 109     assert(_java_call_counter > 0, "Invalid nesting of JavaCallWrapper");
 110     _java_call_counter--;
 111   }
 112  private:  // restore original namespace restriction
 113 #endif  // ifdef ASSERT
 114 
 115   JavaFrameAnchor _anchor;                       // Encapsulation of current java frame and it state
 116 
 117   ThreadFunction _entry_point;
 118 
 119   JNIEnv        _jni_environment;
 120 
 121   // Deopt support
 122   DeoptResourceMark*  _deopt_mark;               // Holds special ResourceMark for deoptimization
 123 
 124   nmethod*      _deopt_nmethod;                  // nmethod that is currently being deoptimized
 125   vframeArray*  _vframe_array_head;              // Holds the heap of the active vframeArrays
 126   vframeArray*  _vframe_array_last;              // Holds last vFrameArray we popped
 127   // Holds updates by JVMTI agents for compiled frames that cannot be performed immediately. They
 128   // will be carried out as soon as possible which, in most cases, is just before deoptimization of
 129   // the frame, when control returns to it.
 130   JvmtiDeferredUpdates* _jvmti_deferred_updates;
 131 
 132   // Handshake value for fixing 6243940. We need a place for the i2c
 133   // adapter to store the callee Method*. This value is NEVER live
 134   // across a gc point so it does NOT have to be gc'd
 135   // The handshake is open ended since we can't be certain that it will
 136   // be nulled. This is because we rarely ever see the race and end up
 137   // in handle_wrong_method which is the backend of the handshake. See
 138   // code in i2c adapters and handle_wrong_method.
 139 
 140   Method*       _callee_target;
 141 
 142   // Used to pass back results to the interpreter or generated code running Java code.
 143   oop           _vm_result;    // oop result is GC-preserved
 144   Metadata*     _vm_result_2;  // non-oop result
 145 
 146   // See ReduceInitialCardMarks: this holds the precise space interval of
 147   // the most recent slow path allocation for which compiled code has
 148   // elided card-marks for performance along the fast-path.
 149   MemRegion     _deferred_card_mark;
 150 
 151   ObjectMonitor* volatile _current_pending_monitor;     // ObjectMonitor this thread is waiting to lock
 152   bool           _current_pending_monitor_is_from_java; // locking is from Java code
 153   ObjectMonitor* volatile _current_waiting_monitor;     // ObjectMonitor on which this thread called Object.wait()
 154 
 155   // Active_handles points to a block of handles
 156   JNIHandleBlock* _active_handles;
 157 
 158   // One-element thread local free list
 159   JNIHandleBlock* _free_handle_block;
 160 
 161  public:
 162   // For tracking the heavyweight monitor the thread is pending on.
 163   ObjectMonitor* current_pending_monitor() {
 164     // Use Atomic::load() to prevent data race between concurrent modification and
 165     // concurrent readers, e.g. ThreadService::get_current_contended_monitor().
 166     // Especially, reloading pointer from thread after null check must be prevented.
 167     return Atomic::load(&_current_pending_monitor);
 168   }
 169   void set_current_pending_monitor(ObjectMonitor* monitor) {
 170     Atomic::store(&_current_pending_monitor, monitor);
 171   }
 172   void set_current_pending_monitor_is_from_java(bool from_java) {
 173     _current_pending_monitor_is_from_java = from_java;
 174   }
 175   bool current_pending_monitor_is_from_java() {
 176     return _current_pending_monitor_is_from_java;
 177   }
 178   ObjectMonitor* current_waiting_monitor() {
 179     // See the comment in current_pending_monitor() above.
 180     return Atomic::load(&_current_waiting_monitor);
 181   }
 182   void set_current_waiting_monitor(ObjectMonitor* monitor) {
 183     Atomic::store(&_current_waiting_monitor, monitor);
 184   }
 185 
 186   // JNI handle support
 187   JNIHandleBlock* active_handles() const         { return _active_handles; }
 188   void set_active_handles(JNIHandleBlock* block) { _active_handles = block; }
 189   JNIHandleBlock* free_handle_block() const      { return _free_handle_block; }
 190   void set_free_handle_block(JNIHandleBlock* block) { _free_handle_block = block; }
 191 
 192   void push_jni_handle_block();
 193   void pop_jni_handle_block();
 194 
 195  private:
 196   enum SuspendFlags {
 197     // NOTE: avoid using the sign-bit as cc generates different test code
 198     //       when the sign-bit is used, and sometimes incorrectly - see CR 6398077
 199     _trace_flag             = 0x00000004U, // call tracing backend
 200     _obj_deopt              = 0x00000008U  // suspend for object reallocation and relocking for JVMTI agent
 201   };
 202 
 203   // various suspension related flags - atomically updated
 204   volatile uint32_t _suspend_flags;
 205 
 206   inline void set_suspend_flag(SuspendFlags f);
 207   inline void clear_suspend_flag(SuspendFlags f);
 208 
 209  public:
 210   inline void set_trace_flag();
 211   inline void clear_trace_flag();
 212   inline void set_obj_deopt_flag();
 213   inline void clear_obj_deopt_flag();
 214   bool is_trace_suspend()      { return (_suspend_flags & _trace_flag) != 0; }
 215   bool is_obj_deopt_suspend()  { return (_suspend_flags & _obj_deopt) != 0; }
 216 
 217   // Asynchronous exception support
 218  private:
 219   friend class InstallAsyncExceptionHandshake;
 220   friend class AsyncExceptionHandshake;
 221   friend class HandshakeState;
 222 
 223   void handle_async_exception(oop java_throwable);
 224  public:
 225   void install_async_exception(AsyncExceptionHandshake* aec = nullptr);
 226   bool has_async_exception_condition();
 227   inline void set_pending_unsafe_access_error();
 228   static void send_async_exception(JavaThread* jt, oop java_throwable);
 229 
 230   class NoAsyncExceptionDeliveryMark : public StackObj {
 231     friend JavaThread;
 232     JavaThread *_target;
 233     inline NoAsyncExceptionDeliveryMark(JavaThread *t);
 234     inline ~NoAsyncExceptionDeliveryMark();
 235   };
 236 
 237   // Safepoint support
 238  public:                                                        // Expose _thread_state for SafeFetchInt()
 239   volatile JavaThreadState _thread_state;
 240  private:
 241   SafepointMechanism::ThreadData _poll_data;
 242   ThreadSafepointState*          _safepoint_state;              // Holds information about a thread during a safepoint
 243   address                        _saved_exception_pc;           // Saved pc of instruction where last implicit exception happened
 244   NOT_PRODUCT(bool               _requires_cross_modify_fence;) // State used by VerifyCrossModifyFence
 245 #ifdef ASSERT
 246   // Debug support for checking if code allows safepoints or not.
 247   // Safepoints in the VM can happen because of allocation, invoking a VM operation, or blocking on
 248   // mutex, or blocking on an object synchronizer (Java locking).
 249   // If _no_safepoint_count is non-zero, then an assertion failure will happen in any of
 250   // the above cases. The class NoSafepointVerifier is used to set this counter.
 251   int _no_safepoint_count;                             // If 0, thread allow a safepoint to happen
 252 
 253  public:
 254   void inc_no_safepoint_count() { _no_safepoint_count++; }
 255   void dec_no_safepoint_count() { _no_safepoint_count--; }
 256   bool is_in_no_safepoint_scope() { return _no_safepoint_count > 0; }
 257 #endif // ASSERT
 258  public:
 259   // These functions check conditions before possibly going to a safepoint.
 260   // including NoSafepointVerifier.
 261   void check_for_valid_safepoint_state() NOT_DEBUG_RETURN;
 262   void check_possible_safepoint()        NOT_DEBUG_RETURN;
 263 
 264 #ifdef ASSERT
 265  private:
 266   volatile uint64_t _visited_for_critical_count;
 267 
 268  public:
 269   void set_visited_for_critical_count(uint64_t safepoint_id) {
 270     assert(_visited_for_critical_count == 0, "Must be reset before set");
 271     assert((safepoint_id & 0x1) == 1, "Must be odd");
 272     _visited_for_critical_count = safepoint_id;
 273   }
 274   void reset_visited_for_critical_count(uint64_t safepoint_id) {
 275     assert(_visited_for_critical_count == safepoint_id, "Was not visited");
 276     _visited_for_critical_count = 0;
 277   }
 278   bool was_visited_for_critical_count(uint64_t safepoint_id) const {
 279     return _visited_for_critical_count == safepoint_id;
 280   }
 281 #endif // ASSERT
 282 
 283   // JavaThread termination support
 284  public:
 285   enum TerminatedTypes {
 286     _not_terminated = 0xDEAD - 3,
 287     _thread_exiting,                             // JavaThread::exit() has been called for this thread
 288     _thread_gc_barrier_detached,                 // thread's GC barrier has been detached
 289     _thread_terminated,                          // JavaThread is removed from thread list
 290     _vm_exited                                   // JavaThread is still executing native code, but VM is terminated
 291                                                  // only VM_Exit can set _vm_exited
 292   };
 293 
 294  private:
 295   // In general a JavaThread's _terminated field transitions as follows:
 296   //
 297   //   _not_terminated => _thread_exiting => _thread_gc_barrier_detached => _thread_terminated
 298   //
 299   // _vm_exited is a special value to cover the case of a JavaThread
 300   // executing native code after the VM itself is terminated.
 301   //
 302   // A JavaThread that fails to JNI attach has these _terminated field transitions:
 303   //   _not_terminated => _thread_terminated
 304   //
 305   volatile TerminatedTypes _terminated;
 306 
 307   jint                  _in_deopt_handler;       // count of deoptimization
 308                                                  // handlers thread is in
 309   volatile bool         _doing_unsafe_access;    // Thread may fault due to unsafe access
 310   bool                  _do_not_unlock_if_synchronized;  // Do not unlock the receiver of a synchronized method (since it was
 311                                                          // never locked) when throwing an exception. Used by interpreter only.
 312 #if INCLUDE_JVMTI
 313   volatile bool         _carrier_thread_suspended;       // Carrier thread is externally suspended
 314   bool                  _is_in_VTMS_transition;          // thread is in virtual thread mount state transition
 315   bool                  _is_in_tmp_VTMS_transition;      // thread is in temporary virtual thread mount state transition
 316   bool                  _is_disable_suspend;             // JVMTI suspend is temporarily disabled; used on current thread only
 317   bool                  _VTMS_transition_mark;           // used for sync between VTMS transitions and disablers
 318 #ifdef ASSERT
 319   bool                  _is_VTMS_transition_disabler;    // thread currently disabled VTMS transitions
 320 #endif
 321 #endif
 322 
 323   // JNI attach states:
 324   enum JNIAttachStates {
 325     _not_attaching_via_jni = 1,  // thread is not attaching via JNI
 326     _attaching_via_jni,          // thread is attaching via JNI
 327     _attached_via_jni            // thread has attached via JNI
 328   };
 329 
 330   // A regular JavaThread's _jni_attach_state is _not_attaching_via_jni.
 331   // A native thread that is attaching via JNI starts with a value
 332   // of _attaching_via_jni and transitions to _attached_via_jni.
 333   volatile JNIAttachStates _jni_attach_state;
 334 
 335   // In scope of an InternalOOMEMark?
 336   bool _is_in_internal_oome_mark;
 337 
 338 #if INCLUDE_JVMCI
 339   // The _pending_* fields below are used to communicate extra information
 340   // from an uncommon trap in JVMCI compiled code to the uncommon trap handler.
 341 
 342   // Communicates the DeoptReason and DeoptAction of the uncommon trap
 343   int       _pending_deoptimization;
 344 
 345   // Specifies whether the uncommon trap is to bci 0 of a synchronized method
 346   // before the monitor has been acquired.
 347   bool      _pending_monitorenter;
 348 
 349   // Specifies if the DeoptReason for the last uncommon trap was Reason_transfer_to_interpreter
 350   bool      _pending_transfer_to_interpreter;
 351 
 352   // An id of a speculation that JVMCI compiled code can use to further describe and
 353   // uniquely identify the speculative optimization guarded by an uncommon trap.
 354   // See JVMCINMethodData::SPECULATION_LENGTH_BITS for further details.
 355   jlong     _pending_failed_speculation;
 356 
 357   // These fields are mutually exclusive in terms of live ranges.
 358   union {
 359     // Communicates the pc at which the most recent implicit exception occurred
 360     // from the signal handler to a deoptimization stub.
 361     address   _implicit_exception_pc;
 362 
 363     // Communicates an alternative call target to an i2c stub from a JavaCall .
 364     address   _alternate_call_target;
 365   } _jvmci;
 366 
 367   // The JVMCIRuntime in a JVMCI shared library
 368   JVMCIRuntime* _libjvmci_runtime;
 369 
 370   // Support for high precision, thread sensitive counters in JVMCI compiled code.
 371   jlong*    _jvmci_counters;
 372 
 373   // Fast thread locals for use by JVMCI
 374   jlong      _jvmci_reserved0;
 375   jlong      _jvmci_reserved1;
 376   oop        _jvmci_reserved_oop0;
 377 
 378   // This field is used to keep an nmethod visible to the GC so that it and its contained oops can
 379   // be kept alive
 380   nmethod*  _live_nmethod;
 381 
 382  public:
 383   static jlong* _jvmci_old_thread_counters;
 384   static void collect_counters(jlong* array, int length);
 385 
 386   bool resize_counters(int current_size, int new_size);
 387 
 388   static bool resize_all_jvmci_counters(int new_size);
 389 
 390   void set_jvmci_reserved_oop0(oop value) {
 391     _jvmci_reserved_oop0 = value;
 392   }
 393 
 394   oop get_jvmci_reserved_oop0() {
 395     return _jvmci_reserved_oop0;
 396   }
 397 
 398   void set_jvmci_reserved0(jlong value) {
 399     _jvmci_reserved0 = value;
 400   }
 401 
 402   jlong get_jvmci_reserved0() {
 403     return _jvmci_reserved0;
 404   }
 405 
 406   void set_jvmci_reserved1(jlong value) {
 407     _jvmci_reserved1 = value;
 408   }
 409 
 410   jlong get_jvmci_reserved1() {
 411     return _jvmci_reserved1;
 412   }
 413 
 414   void set_live_nmethod(nmethod* nm) {
 415     assert(_live_nmethod == nullptr, "only one");
 416     _live_nmethod = nm;
 417   }
 418 
 419   void clear_live_nmethod() {
 420     _live_nmethod = nullptr;
 421   }
 422 
 423  private:
 424 #endif // INCLUDE_JVMCI
 425 
 426   StackOverflow    _stack_overflow_state;
 427 
 428   void pretouch_stack();
 429 
 430   // Compiler exception handling (NOTE: The _exception_oop is *NOT* the same as _pending_exception. It is
 431   // used to temp. parsing values into and out of the runtime system during exception handling for compiled
 432   // code)
 433   volatile oop     _exception_oop;               // Exception thrown in compiled code
 434   volatile address _exception_pc;                // PC where exception happened
 435   volatile address _exception_handler_pc;        // PC for handler of exception
 436   volatile int     _is_method_handle_return;     // true (== 1) if the current exception PC is a MethodHandle call site.
 437 
 438  private:
 439   // support for JNI critical regions
 440   jint    _jni_active_critical;                  // count of entries into JNI critical region
 441 
 442   // Checked JNI: function name requires exception check
 443   char* _pending_jni_exception_check_fn;
 444 
 445   // For deadlock detection.
 446   int _depth_first_number;
 447 
 448   // JVMTI PopFrame support
 449   // This is set to popframe_pending to signal that top Java frame should be popped immediately
 450   int _popframe_condition;
 451 
 452   // If reallocation of scalar replaced objects fails, we throw OOM
 453   // and during exception propagation, pop the top
 454   // _frames_to_pop_failed_realloc frames, the ones that reference
 455   // failed reallocations.
 456   int _frames_to_pop_failed_realloc;
 457 
 458   ContinuationEntry* _cont_entry;
 459   intptr_t* _cont_fastpath; // the sp of the oldest known interpreted/call_stub frame inside the
 460                             // continuation that we know about
 461   int _cont_fastpath_thread_state; // whether global thread state allows continuation fastpath (JVMTI)
 462 
 463   // It's signed for error detection.
 464   intx _held_monitor_count;  // used by continuations for fast lock detection
 465   intx _jni_monitor_count;
 466 
 467   bool _can_call_java;
 468 
 469 private:
 470 
 471   friend class VMThread;
 472   friend class ThreadWaitTransition;
 473   friend class VM_Exit;
 474 
 475   // Stack watermark barriers.
 476   StackWatermarks _stack_watermarks;
 477 
 478  public:
 479   inline StackWatermarks* stack_watermarks() { return &_stack_watermarks; }
 480 
 481  public:
 482   // Constructor
 483   JavaThread(MEMFLAGS flags = mtThread);   // delegating constructor
 484   JavaThread(ThreadFunction entry_point, size_t stack_size = 0, MEMFLAGS flags = mtThread);
 485   ~JavaThread();
 486 
 487   // Factory method to create a new JavaThread whose attach state is "is attaching"
 488   static JavaThread* create_attaching_thread();
 489 
 490 #ifdef ASSERT
 491   // verify this JavaThread hasn't be published in the Threads::list yet
 492   void verify_not_published();
 493 #endif // ASSERT
 494 
 495   StackOverflow* stack_overflow_state() { return &_stack_overflow_state; }
 496 
 497   //JNI functiontable getter/setter for JVMTI jni function table interception API.
 498   void set_jni_functions(struct JNINativeInterface_* functionTable) {
 499     _jni_environment.functions = functionTable;
 500   }
 501   struct JNINativeInterface_* get_jni_functions() {
 502     return (struct JNINativeInterface_ *)_jni_environment.functions;
 503   }
 504 
 505   // This function is called at thread creation to allow
 506   // platform specific thread variables to be initialized.
 507   void cache_global_variables();
 508 
 509   // Executes Shutdown.shutdown()
 510   void invoke_shutdown_hooks();
 511 
 512   // Cleanup on thread exit
 513   enum ExitType {
 514     normal_exit,
 515     jni_detach
 516   };
 517   void exit(bool destroy_vm, ExitType exit_type = normal_exit);
 518 
 519   void cleanup_failed_attach_current_thread(bool is_daemon);
 520 
 521   class NoJavaCodeMark : public StackObj {
 522     friend JavaThread;
 523     JavaThread* _target;
 524     bool _orig;
 525    public:
 526     NoJavaCodeMark(JavaThread* t) : _target(t), _orig(t->_can_call_java) {
 527       _target->_can_call_java = false;
 528     }
 529     ~NoJavaCodeMark() {
 530       _target->_can_call_java = _orig;
 531     }
 532   };
 533 
 534   // Testers
 535   virtual bool is_Java_thread() const            { return true;  }
 536   virtual bool can_call_java() const             { return _can_call_java; }
 537 
 538   virtual bool is_active_Java_thread() const;
 539 
 540   // Thread oop. threadObj() can be null for initial JavaThread
 541   // (or for threads attached via JNI)
 542   oop threadObj() const;
 543   void set_threadOopHandles(oop p);
 544   oop vthread() const;
 545   void set_vthread(oop p);
 546   oop scopedValueCache() const;
 547   void set_scopedValueCache(oop p);
 548   void clear_scopedValueBindings();
 549   oop jvmti_vthread() const;
 550   void set_jvmti_vthread(oop p);
 551   oop vthread_or_thread() const;
 552 
 553   // Prepare thread and add to priority queue.  If a priority is
 554   // not specified, use the priority of the thread object. Threads_lock
 555   // must be held while this function is called.
 556   void prepare(jobject jni_thread, ThreadPriority prio=NoPriority);
 557 
 558   void set_saved_exception_pc(address pc)        { _saved_exception_pc = pc; }
 559   address saved_exception_pc()                   { return _saved_exception_pc; }
 560 
 561   ThreadFunction entry_point() const             { return _entry_point; }
 562 
 563   // Allocates a new Java level thread object for this thread. thread_name may be null.
 564   void allocate_threadObj(Handle thread_group, const char* thread_name, bool daemon, TRAPS);
 565 
 566   // Last frame anchor routines
 567 
 568   JavaFrameAnchor* frame_anchor(void)            { return &_anchor; }
 569 
 570   // last_Java_sp
 571   bool has_last_Java_frame() const               { return _anchor.has_last_Java_frame(); }
 572   intptr_t* last_Java_sp() const                 { return _anchor.last_Java_sp(); }
 573 
 574   // last_Java_pc
 575 
 576   address last_Java_pc(void)                     { return _anchor.last_Java_pc(); }
 577 
 578   // Safepoint support
 579   inline JavaThreadState thread_state() const;
 580   inline void set_thread_state(JavaThreadState s);
 581   inline void set_thread_state_fence(JavaThreadState s);  // fence after setting thread state
 582   inline ThreadSafepointState* safepoint_state() const;
 583   inline void set_safepoint_state(ThreadSafepointState* state);
 584   inline bool is_at_poll_safepoint();
 585 
 586   // JavaThread termination and lifecycle support:
 587   void smr_delete();
 588   bool on_thread_list() const { return _on_thread_list; }
 589   void set_on_thread_list() { _on_thread_list = true; }
 590 
 591   // thread has called JavaThread::exit(), thread's GC barrier is detached
 592   // or thread is terminated
 593   bool is_exiting() const;
 594   // thread's GC barrier is NOT detached and thread is NOT terminated
 595   bool is_oop_safe() const;
 596   // thread is terminated (no longer on the threads list); the thread must
 597   // be protected by a ThreadsListHandle to avoid potential crashes.
 598   bool check_is_terminated(TerminatedTypes l_terminated) const {
 599     return l_terminated == _thread_terminated || l_terminated == _vm_exited;
 600   }
 601   bool is_terminated() const;
 602   void set_terminated(TerminatedTypes t);
 603 
 604   void block_if_vm_exited();
 605 
 606   bool doing_unsafe_access()                     { return _doing_unsafe_access; }
 607   void set_doing_unsafe_access(bool val)         { _doing_unsafe_access = val; }
 608 
 609   bool do_not_unlock_if_synchronized()             { return _do_not_unlock_if_synchronized; }
 610   void set_do_not_unlock_if_synchronized(bool val) { _do_not_unlock_if_synchronized = val; }
 611 
 612   SafepointMechanism::ThreadData* poll_data() { return &_poll_data; }
 613 
 614   void set_requires_cross_modify_fence(bool val) PRODUCT_RETURN NOT_PRODUCT({ _requires_cross_modify_fence = val; })
 615 
 616   // Continuation support
 617   ContinuationEntry* last_continuation() const { return _cont_entry; }
 618   void set_cont_fastpath(intptr_t* x)          { _cont_fastpath = x; }
 619   void push_cont_fastpath(intptr_t* sp)        { if (sp > _cont_fastpath) _cont_fastpath = sp; }
 620   void set_cont_fastpath_thread_state(bool x)  { _cont_fastpath_thread_state = (int)x; }
 621   intptr_t* raw_cont_fastpath() const          { return _cont_fastpath; }
 622   bool cont_fastpath() const                   { return _cont_fastpath == nullptr && _cont_fastpath_thread_state != 0; }
 623   bool cont_fastpath_thread_state() const      { return _cont_fastpath_thread_state != 0; }
 624 
 625   void inc_held_monitor_count(intx i = 1, bool jni = false);
 626   void dec_held_monitor_count(intx i = 1, bool jni = false);
 627 
 628   intx held_monitor_count() { return _held_monitor_count; }
 629   intx jni_monitor_count()  { return _jni_monitor_count;  }
 630   void clear_jni_monitor_count() { _jni_monitor_count = 0;   }
 631 
 632   inline bool is_vthread_mounted() const;
 633   inline const ContinuationEntry* vthread_continuation() const;
 634 
 635  private:
 636   DEBUG_ONLY(void verify_frame_info();)
 637 
 638   // Support for thread handshake operations
 639   HandshakeState _handshake;
 640  public:
 641   HandshakeState* handshake_state() { return &_handshake; }
 642 
 643   // A JavaThread can always safely operate on it self and other threads
 644   // can do it safely if they are the active handshaker.
 645   bool is_handshake_safe_for(Thread* th) const {
 646     return _handshake.active_handshaker() == th || this == th;
 647   }
 648 
 649   // Suspend/resume support for JavaThread
 650   // higher-level suspension/resume logic called by the public APIs
 651   bool java_suspend();
 652   bool java_resume();
 653   bool is_suspended()     { return _handshake.is_suspended(); }
 654 
 655   // Check for async exception in addition to safepoint.
 656   static void check_special_condition_for_native_trans(JavaThread *thread);
 657 
 658   // Synchronize with another thread that is deoptimizing objects of the
 659   // current thread, i.e. reverts optimizations based on escape analysis.
 660   void wait_for_object_deoptimization();
 661 
 662 #if INCLUDE_JVMTI
 663   inline void set_carrier_thread_suspended();
 664   inline void clear_carrier_thread_suspended();
 665 
 666   bool is_carrier_thread_suspended() const {
 667     return _carrier_thread_suspended;
 668   }
 669 
 670   bool is_in_VTMS_transition() const             { return _is_in_VTMS_transition; }
 671   bool is_in_tmp_VTMS_transition() const         { return _is_in_tmp_VTMS_transition; }
 672   bool is_in_any_VTMS_transition() const         { return _is_in_VTMS_transition || _is_in_tmp_VTMS_transition; }
 673 
 674   void set_is_in_VTMS_transition(bool val);
 675   void toggle_is_in_tmp_VTMS_transition()        { _is_in_tmp_VTMS_transition = !_is_in_tmp_VTMS_transition; };
 676 
 677   bool is_disable_suspend() const                { return _is_disable_suspend; }
 678   void toggle_is_disable_suspend()               { _is_disable_suspend = !_is_disable_suspend; };
 679 
 680   bool VTMS_transition_mark() const              { return Atomic::load(&_VTMS_transition_mark); }
 681   void set_VTMS_transition_mark(bool val)        { Atomic::store(&_VTMS_transition_mark, val); }
 682 
 683 #ifdef ASSERT
 684   bool is_VTMS_transition_disabler() const       { return _is_VTMS_transition_disabler; }
 685   void set_is_VTMS_transition_disabler(bool val);
 686 #endif
 687 #endif
 688 
 689   // Support for object deoptimization and JFR suspension
 690   void handle_special_runtime_exit_condition();
 691   bool has_special_runtime_exit_condition() {
 692     return (_suspend_flags & (_obj_deopt JFR_ONLY(| _trace_flag))) != 0;
 693   }
 694 
 695   // Stack-locking support (not for LM_LIGHTWEIGHT)
 696   bool is_lock_owned(address adr) const;
 697 
 698   // Accessors for vframe array top
 699   // The linked list of vframe arrays are sorted on sp. This means when we
 700   // unpack the head must contain the vframe array to unpack.
 701   void set_vframe_array_head(vframeArray* value) { _vframe_array_head = value; }
 702   vframeArray* vframe_array_head() const         { return _vframe_array_head;  }
 703 
 704   // Side structure for deferring update of java frame locals until deopt occurs
 705   JvmtiDeferredUpdates* deferred_updates() const      { return _jvmti_deferred_updates; }
 706   void set_deferred_updates(JvmtiDeferredUpdates* du) { _jvmti_deferred_updates = du; }
 707 
 708   // These only really exist to make debugging deopt problems simpler
 709 
 710   void set_vframe_array_last(vframeArray* value) { _vframe_array_last = value; }
 711   vframeArray* vframe_array_last() const         { return _vframe_array_last;  }
 712 
 713   // The special resourceMark used during deoptimization
 714 
 715   void set_deopt_mark(DeoptResourceMark* value)  { _deopt_mark = value; }
 716   DeoptResourceMark* deopt_mark(void)            { return _deopt_mark; }
 717 
 718   void set_deopt_compiled_method(nmethod* nm)    { _deopt_nmethod = nm; }
 719   nmethod* deopt_compiled_method()               { return _deopt_nmethod; }
 720 
 721   Method*    callee_target() const               { return _callee_target; }
 722   void set_callee_target  (Method* x)            { _callee_target   = x; }
 723 
 724   // Oop results of vm runtime calls
 725   oop  vm_result() const                         { return _vm_result; }
 726   void set_vm_result  (oop x)                    { _vm_result   = x; }
 727 
 728   void set_vm_result_2  (Metadata* x)            { _vm_result_2   = x; }
 729 
 730   MemRegion deferred_card_mark() const           { return _deferred_card_mark; }
 731   void set_deferred_card_mark(MemRegion mr)      { _deferred_card_mark = mr;   }
 732 
 733   // Is thread in scope of an InternalOOMEMark?
 734   bool is_in_internal_oome_mark() const          { return _is_in_internal_oome_mark; }
 735   void set_is_in_internal_oome_mark(bool b)      { _is_in_internal_oome_mark = b;    }
 736 
 737 #if INCLUDE_JVMCI
 738   jlong pending_failed_speculation() const        { return _pending_failed_speculation; }
 739   void set_pending_monitorenter(bool b)           { _pending_monitorenter = b; }
 740   void set_pending_deoptimization(int reason)     { _pending_deoptimization = reason; }
 741   void set_pending_failed_speculation(jlong failed_speculation) { _pending_failed_speculation = failed_speculation; }
 742   void set_pending_transfer_to_interpreter(bool b) { _pending_transfer_to_interpreter = b; }
 743   void set_jvmci_alternate_call_target(address a) { assert(_jvmci._alternate_call_target == nullptr, "must be"); _jvmci._alternate_call_target = a; }
 744   void set_jvmci_implicit_exception_pc(address a) { assert(_jvmci._implicit_exception_pc == nullptr, "must be"); _jvmci._implicit_exception_pc = a; }
 745 
 746   JVMCIRuntime* libjvmci_runtime() const          { return _libjvmci_runtime; }
 747   void set_libjvmci_runtime(JVMCIRuntime* rt) {
 748     assert((_libjvmci_runtime == nullptr && rt != nullptr) || (_libjvmci_runtime != nullptr && rt == nullptr), "must be");
 749     _libjvmci_runtime = rt;
 750   }
 751 #endif // INCLUDE_JVMCI
 752 
 753   // Exception handling for compiled methods
 754   oop      exception_oop() const;
 755   address  exception_pc() const                  { return _exception_pc; }
 756 
 757   void set_exception_oop(oop o);
 758   void set_exception_pc(address a)               { _exception_pc = a; }
 759   void set_exception_handler_pc(address a)       { _exception_handler_pc = a; }
 760   void set_is_method_handle_return(bool value)   { _is_method_handle_return = value ? 1 : 0; }
 761 
 762   void clear_exception_oop_and_pc() {
 763     set_exception_oop(nullptr);
 764     set_exception_pc(nullptr);
 765   }
 766 
 767   // Check if address is in the usable part of the stack (excludes protected
 768   // guard pages). Can be applied to any thread and is an approximation for
 769   // using is_in_live_stack when the query has to happen from another thread.
 770   bool is_in_usable_stack(address adr) const {
 771     return is_in_stack_range_incl(adr, _stack_overflow_state.stack_reserved_zone_base());
 772   }
 773 
 774   // Misc. accessors/mutators
 775   static ByteSize scopedValueCache_offset()       { return byte_offset_of(JavaThread, _scopedValueCache); }
 776 
 777   // For assembly stub generation
 778   static ByteSize threadObj_offset()             { return byte_offset_of(JavaThread, _threadObj); }
 779   static ByteSize vthread_offset()               { return byte_offset_of(JavaThread, _vthread); }
 780   static ByteSize jni_environment_offset()       { return byte_offset_of(JavaThread, _jni_environment); }
 781   static ByteSize pending_jni_exception_check_fn_offset() {
 782     return byte_offset_of(JavaThread, _pending_jni_exception_check_fn);
 783   }
 784   static ByteSize last_Java_sp_offset() {
 785     return byte_offset_of(JavaThread, _anchor) + JavaFrameAnchor::last_Java_sp_offset();
 786   }
 787   static ByteSize last_Java_pc_offset() {
 788     return byte_offset_of(JavaThread, _anchor) + JavaFrameAnchor::last_Java_pc_offset();
 789   }
 790   static ByteSize frame_anchor_offset() {
 791     return byte_offset_of(JavaThread, _anchor);
 792   }
 793   static ByteSize callee_target_offset()         { return byte_offset_of(JavaThread, _callee_target); }
 794   static ByteSize vm_result_offset()             { return byte_offset_of(JavaThread, _vm_result); }
 795   static ByteSize vm_result_2_offset()           { return byte_offset_of(JavaThread, _vm_result_2); }
 796   static ByteSize thread_state_offset()          { return byte_offset_of(JavaThread, _thread_state); }
 797   static ByteSize polling_word_offset()          { return byte_offset_of(JavaThread, _poll_data) + byte_offset_of(SafepointMechanism::ThreadData, _polling_word);}
 798   static ByteSize polling_page_offset()          { return byte_offset_of(JavaThread, _poll_data) + byte_offset_of(SafepointMechanism::ThreadData, _polling_page);}
 799   static ByteSize saved_exception_pc_offset()    { return byte_offset_of(JavaThread, _saved_exception_pc); }
 800   static ByteSize osthread_offset()              { return byte_offset_of(JavaThread, _osthread); }
 801 #if INCLUDE_JVMCI
 802   static ByteSize pending_deoptimization_offset() { return byte_offset_of(JavaThread, _pending_deoptimization); }
 803   static ByteSize pending_monitorenter_offset()  { return byte_offset_of(JavaThread, _pending_monitorenter); }
 804   static ByteSize jvmci_alternate_call_target_offset() { return byte_offset_of(JavaThread, _jvmci._alternate_call_target); }
 805   static ByteSize jvmci_implicit_exception_pc_offset() { return byte_offset_of(JavaThread, _jvmci._implicit_exception_pc); }
 806   static ByteSize jvmci_counters_offset()        { return byte_offset_of(JavaThread, _jvmci_counters); }
 807 #endif // INCLUDE_JVMCI
 808   static ByteSize exception_oop_offset()         { return byte_offset_of(JavaThread, _exception_oop); }
 809   static ByteSize exception_pc_offset()          { return byte_offset_of(JavaThread, _exception_pc); }
 810   static ByteSize exception_handler_pc_offset()  { return byte_offset_of(JavaThread, _exception_handler_pc); }
 811   static ByteSize is_method_handle_return_offset() { return byte_offset_of(JavaThread, _is_method_handle_return); }
 812 
 813   static ByteSize active_handles_offset()        { return byte_offset_of(JavaThread, _active_handles); }
 814 
 815   // StackOverflow offsets
 816   static ByteSize stack_overflow_limit_offset()  {
 817     return byte_offset_of(JavaThread, _stack_overflow_state._stack_overflow_limit);
 818   }
 819   static ByteSize stack_guard_state_offset()     {
 820     return byte_offset_of(JavaThread, _stack_overflow_state._stack_guard_state);
 821   }
 822   static ByteSize reserved_stack_activation_offset() {
 823     return byte_offset_of(JavaThread, _stack_overflow_state._reserved_stack_activation);
 824   }
 825   static ByteSize shadow_zone_safe_limit()  {
 826     return byte_offset_of(JavaThread, _stack_overflow_state._shadow_zone_safe_limit);
 827   }
 828   static ByteSize shadow_zone_growth_watermark()  {
 829     return byte_offset_of(JavaThread, _stack_overflow_state._shadow_zone_growth_watermark);
 830   }
 831 
 832   static ByteSize suspend_flags_offset()         { return byte_offset_of(JavaThread, _suspend_flags); }
 833 
 834   static ByteSize do_not_unlock_if_synchronized_offset() { return byte_offset_of(JavaThread, _do_not_unlock_if_synchronized); }
 835   static ByteSize should_post_on_exceptions_flag_offset() {
 836     return byte_offset_of(JavaThread, _should_post_on_exceptions_flag);
 837   }
 838   static ByteSize doing_unsafe_access_offset() { return byte_offset_of(JavaThread, _doing_unsafe_access); }
 839   NOT_PRODUCT(static ByteSize requires_cross_modify_fence_offset()  { return byte_offset_of(JavaThread, _requires_cross_modify_fence); })
 840 
 841   static ByteSize cont_entry_offset()         { return byte_offset_of(JavaThread, _cont_entry); }
 842   static ByteSize cont_fastpath_offset()      { return byte_offset_of(JavaThread, _cont_fastpath); }
 843   static ByteSize held_monitor_count_offset() { return byte_offset_of(JavaThread, _held_monitor_count); }
 844   static ByteSize jni_monitor_count_offset()  { return byte_offset_of(JavaThread, _jni_monitor_count); }
 845 
 846 #if INCLUDE_JVMTI
 847   static ByteSize is_in_VTMS_transition_offset()     { return byte_offset_of(JavaThread, _is_in_VTMS_transition); }
 848   static ByteSize is_in_tmp_VTMS_transition_offset() { return byte_offset_of(JavaThread, _is_in_tmp_VTMS_transition); }
 849   static ByteSize is_disable_suspend_offset()        { return byte_offset_of(JavaThread, _is_disable_suspend); }
 850 #endif
 851 
 852   // Returns the jni environment for this thread
 853   JNIEnv* jni_environment()                      { return &_jni_environment; }
 854 
 855   // Returns the current thread as indicated by the given JNIEnv.
 856   // We don't assert it is Thread::current here as that is done at the
 857   // external JNI entry points where the JNIEnv is passed into the VM.
 858   static JavaThread* thread_from_jni_environment(JNIEnv* env) {
 859     JavaThread* current = reinterpret_cast<JavaThread*>(((intptr_t)env - in_bytes(jni_environment_offset())));
 860     // We can't normally get here in a thread that has completed its
 861     // execution and so "is_terminated", except when the call is from
 862     // AsyncGetCallTrace, which can be triggered by a signal at any point in
 863     // a thread's lifecycle. A thread is also considered terminated if the VM
 864     // has exited, so we have to check this and block in case this is a daemon
 865     // thread returning to the VM (the JNI DirectBuffer entry points rely on
 866     // this).
 867     if (current->is_terminated()) {
 868       current->block_if_vm_exited();
 869     }
 870     return current;
 871   }
 872 
 873   // JNI critical regions. These can nest.
 874   bool in_critical()    { return _jni_active_critical > 0; }
 875   bool in_last_critical()  { return _jni_active_critical == 1; }
 876   inline void enter_critical();
 877   void exit_critical() {
 878     assert(Thread::current() == this, "this must be current thread");
 879     _jni_active_critical--;
 880     assert(_jni_active_critical >= 0, "JNI critical nesting problem?");
 881   }
 882 
 883   // Checked JNI: is the programmer required to check for exceptions, if so specify
 884   // which function name. Returning to a Java frame should implicitly clear the
 885   // pending check, this is done for Native->Java transitions (i.e. user JNI code).
 886   // VM->Java transitions are not cleared, it is expected that JNI code enclosed
 887   // within ThreadToNativeFromVM makes proper exception checks (i.e. VM internal).
 888   bool is_pending_jni_exception_check() const { return _pending_jni_exception_check_fn != nullptr; }
 889   void clear_pending_jni_exception_check() { _pending_jni_exception_check_fn = nullptr; }
 890   const char* get_pending_jni_exception_check() const { return _pending_jni_exception_check_fn; }
 891   void set_pending_jni_exception_check(const char* fn_name) { _pending_jni_exception_check_fn = (char*) fn_name; }
 892 
 893   // For deadlock detection
 894   int depth_first_number() { return _depth_first_number; }
 895   void set_depth_first_number(int dfn) { _depth_first_number = dfn; }
 896 
 897  public:
 898   bool in_deopt_handler() const                  { return _in_deopt_handler > 0; }
 899   void inc_in_deopt_handler()                    { _in_deopt_handler++; }
 900   void dec_in_deopt_handler() {
 901     assert(_in_deopt_handler > 0, "mismatched deopt nesting");
 902     if (_in_deopt_handler > 0) { // robustness
 903       _in_deopt_handler--;
 904     }
 905   }
 906 
 907  private:
 908   void set_entry_point(ThreadFunction entry_point) { _entry_point = entry_point; }
 909 
 910   // factor out low-level mechanics for use in both normal and error cases
 911   const char* get_thread_name_string(char* buf = nullptr, int buflen = 0) const;
 912 
 913  public:
 914 
 915   // Frame iteration; calls the function f for all frames on the stack
 916   void frames_do(void f(frame*, const RegisterMap*));
 917 
 918   // Memory operations
 919   void oops_do_frames(OopClosure* f, NMethodClosure* cf);
 920   void oops_do_no_frames(OopClosure* f, NMethodClosure* cf);
 921 
 922   // GC operations
 923   virtual void nmethods_do(NMethodClosure* cf);
 924 
 925   // RedefineClasses Support
 926   void metadata_do(MetadataClosure* f);
 927 
 928   // Debug method asserting thread states are correct during a handshake operation.
 929   DEBUG_ONLY(void verify_states_for_handshake();)
 930 
 931   // Misc. operations
 932   const char* name() const;
 933   const char* name_raw() const;
 934   const char* type_name() const { return "JavaThread"; }
 935   static const char* name_for(oop thread_obj);
 936 
 937   void print_on(outputStream* st, bool print_extended_info) const;
 938   void print_on(outputStream* st) const { print_on(st, false); }
 939   void print() const;
 940   void print_thread_state_on(outputStream*) const;
 941   void print_on_error(outputStream* st, char* buf, int buflen) const;
 942   void print_name_on_error(outputStream* st, char* buf, int buflen) const;
 943   void verify();
 944 
 945   // Accessing frames
 946   frame last_frame() {
 947     _anchor.make_walkable();
 948     return pd_last_frame();
 949   }
 950   javaVFrame* last_java_vframe(RegisterMap* reg_map) { return last_java_vframe(last_frame(), reg_map); }
 951 
 952   frame carrier_last_frame(RegisterMap* reg_map);
 953   javaVFrame* carrier_last_java_vframe(RegisterMap* reg_map) { return last_java_vframe(carrier_last_frame(reg_map), reg_map); }
 954 
 955   frame vthread_last_frame();
 956   javaVFrame* vthread_last_java_vframe(RegisterMap* reg_map) { return last_java_vframe(vthread_last_frame(), reg_map); }
 957 
 958   frame platform_thread_last_frame(RegisterMap* reg_map);
 959   javaVFrame*  platform_thread_last_java_vframe(RegisterMap* reg_map) {
 960     return last_java_vframe(platform_thread_last_frame(reg_map), reg_map);
 961   }
 962 
 963   javaVFrame* last_java_vframe(const frame f, RegisterMap* reg_map);
 964 
 965   // Returns method at 'depth' java or native frames down the stack
 966   // Used for security checks
 967   Klass* security_get_caller_class(int depth);
 968 
 969   // Print stack trace in external format
 970   // These variants print carrier/platform thread information only.
 971   void print_stack_on(outputStream* st);
 972   void print_stack() { print_stack_on(tty); }
 973   // This prints the currently mounted virtual thread.
 974   void print_vthread_stack_on(outputStream* st);
 975   // This prints the active stack: either carrier/platform or virtual.
 976   void print_active_stack_on(outputStream* st);
 977   // Print current stack trace for checked JNI warnings and JNI fatal errors.
 978   // This is the external format from above, but selecting the platform
 979   // or vthread as applicable.
 980   void print_jni_stack();
 981 
 982   void print_native_stack_on(outputStream* st);
 983 
 984   // Print stack traces in various internal formats
 985   void trace_stack()                             PRODUCT_RETURN;
 986   void trace_stack_from(vframe* start_vf)        PRODUCT_RETURN;
 987   void trace_frames()                            PRODUCT_RETURN;
 988 
 989   // Print an annotated view of the stack frames
 990   void print_frame_layout(int depth = 0, bool validate_only = false) NOT_DEBUG_RETURN;
 991   void validate_frame_layout() {
 992     print_frame_layout(0, true);
 993   }
 994 
 995   // Function for testing deoptimization
 996   void deoptimize();
 997   void make_zombies();
 998 
 999   void deoptimize_marked_methods();
1000 
1001  public:
1002   // Returns the running thread as a JavaThread
1003   static JavaThread* current() {
1004     return JavaThread::cast(Thread::current());
1005   }
1006 
1007   // Returns the current thread as a JavaThread, or nullptr if not attached
1008   static inline JavaThread* current_or_null();
1009 
1010   // Casts
1011   static JavaThread* cast(Thread* t) {
1012     assert(t->is_Java_thread(), "incorrect cast to JavaThread");
1013     return static_cast<JavaThread*>(t);
1014   }
1015 
1016   static const JavaThread* cast(const Thread* t) {
1017     assert(t->is_Java_thread(), "incorrect cast to const JavaThread");
1018     return static_cast<const JavaThread*>(t);
1019   }
1020 
1021   // Returns the active Java thread.  Do not use this if you know you are calling
1022   // from a JavaThread, as it's slower than JavaThread::current.  If called from
1023   // the VMThread, it also returns the JavaThread that instigated the VMThread's
1024   // operation.  You may not want that either.
1025   static JavaThread* active();
1026 
1027  protected:
1028   virtual void pre_run();
1029   virtual void run();
1030   void thread_main_inner();
1031   virtual void post_run();
1032 
1033  public:
1034   // Thread local information maintained by JVMTI.
1035   void set_jvmti_thread_state(JvmtiThreadState *value)                           { _jvmti_thread_state = value; }
1036   // A JvmtiThreadState is lazily allocated. This jvmti_thread_state()
1037   // getter is used to get this JavaThread's JvmtiThreadState if it has
1038   // one which means null can be returned. JvmtiThreadState::state_for()
1039   // is used to get the specified JavaThread's JvmtiThreadState if it has
1040   // one or it allocates a new JvmtiThreadState for the JavaThread and
1041   // returns it. JvmtiThreadState::state_for() will return null only if
1042   // the specified JavaThread is exiting.
1043   JvmtiThreadState *jvmti_thread_state() const                                   { return _jvmti_thread_state; }
1044   static ByteSize jvmti_thread_state_offset()                                    { return byte_offset_of(JavaThread, _jvmti_thread_state); }
1045 
1046 #if INCLUDE_JVMTI
1047   // Rebind JVMTI thread state from carrier to virtual or from virtual to carrier.
1048   JvmtiThreadState *rebind_to_jvmti_thread_state_of(oop thread_oop);
1049 #endif
1050 
1051   // JVMTI PopFrame support
1052   // Setting and clearing popframe_condition
1053   // All of these enumerated values are bits. popframe_pending
1054   // indicates that a PopFrame() has been requested and not yet been
1055   // completed. popframe_processing indicates that that PopFrame() is in
1056   // the process of being completed. popframe_force_deopt_reexecution_bit
1057   // indicates that special handling is required when returning to a
1058   // deoptimized caller.
1059   enum PopCondition {
1060     popframe_inactive                      = 0x00,
1061     popframe_pending_bit                   = 0x01,
1062     popframe_processing_bit                = 0x02,
1063     popframe_force_deopt_reexecution_bit   = 0x04
1064   };
1065   PopCondition popframe_condition()                   { return (PopCondition) _popframe_condition; }
1066   void set_popframe_condition(PopCondition c)         { _popframe_condition = c; }
1067   void set_popframe_condition_bit(PopCondition c)     { _popframe_condition |= c; }
1068   void clear_popframe_condition()                     { _popframe_condition = popframe_inactive; }
1069   static ByteSize popframe_condition_offset()         { return byte_offset_of(JavaThread, _popframe_condition); }
1070   bool has_pending_popframe()                         { return (popframe_condition() & popframe_pending_bit) != 0; }
1071   bool popframe_forcing_deopt_reexecution()           { return (popframe_condition() & popframe_force_deopt_reexecution_bit) != 0; }
1072 
1073   bool pop_frame_in_process(void)                     { return ((_popframe_condition & popframe_processing_bit) != 0); }
1074   void set_pop_frame_in_process(void)                 { _popframe_condition |= popframe_processing_bit; }
1075   void clr_pop_frame_in_process(void)                 { _popframe_condition &= ~popframe_processing_bit; }
1076 
1077   int frames_to_pop_failed_realloc() const            { return _frames_to_pop_failed_realloc; }
1078   void set_frames_to_pop_failed_realloc(int nb)       { _frames_to_pop_failed_realloc = nb; }
1079   void dec_frames_to_pop_failed_realloc()             { _frames_to_pop_failed_realloc--; }
1080 
1081  private:
1082   // Saved incoming arguments to popped frame.
1083   // Used only when popped interpreted frame returns to deoptimized frame.
1084   void*    _popframe_preserved_args;
1085   int      _popframe_preserved_args_size;
1086 
1087  public:
1088   void  popframe_preserve_args(ByteSize size_in_bytes, void* start);
1089   void* popframe_preserved_args();
1090   ByteSize popframe_preserved_args_size();
1091   WordSize popframe_preserved_args_size_in_words();
1092   void  popframe_free_preserved_args();
1093 
1094 
1095  private:
1096   JvmtiThreadState *_jvmti_thread_state;
1097 
1098   // Used by the interpreter in fullspeed mode for frame pop, method
1099   // entry, method exit and single stepping support. This field is
1100   // only set to non-zero at a safepoint or using a direct handshake
1101   // (see EnterInterpOnlyModeClosure).
1102   // It can be set to zero asynchronously to this threads execution (i.e., without
1103   // safepoint/handshake or a lock) so we have to be very careful.
1104   // Accesses by other threads are synchronized using JvmtiThreadState_lock though.
1105   int               _interp_only_mode;
1106 
1107  public:
1108   // used by the interpreter for fullspeed debugging support (see above)
1109   static ByteSize interp_only_mode_offset() { return byte_offset_of(JavaThread, _interp_only_mode); }
1110   bool is_interp_only_mode()                { return (_interp_only_mode != 0); }
1111   int get_interp_only_mode()                { return _interp_only_mode; }
1112   int set_interp_only_mode(int val)         { return _interp_only_mode = val; }
1113   void increment_interp_only_mode()         { ++_interp_only_mode; }
1114   void decrement_interp_only_mode()         { --_interp_only_mode; }
1115 
1116   // support for cached flag that indicates whether exceptions need to be posted for this thread
1117   // if this is false, we can avoid deoptimizing when events are thrown
1118   // this gets set to reflect whether jvmtiExport::post_exception_throw would actually do anything
1119  private:
1120   int    _should_post_on_exceptions_flag;
1121 
1122  public:
1123   void  set_should_post_on_exceptions_flag(int val)  { _should_post_on_exceptions_flag = val; }
1124 
1125  private:
1126   ThreadStatistics *_thread_stat;
1127 
1128  public:
1129   ThreadStatistics* get_thread_stat() const    { return _thread_stat; }
1130 
1131   // Return a blocker object for which this thread is blocked parking.
1132   oop current_park_blocker();
1133 
1134  private:
1135   static size_t _stack_size_at_create;
1136 
1137  public:
1138   static inline size_t stack_size_at_create(void) {
1139     return _stack_size_at_create;
1140   }
1141   static inline void set_stack_size_at_create(size_t value) {
1142     _stack_size_at_create = value;
1143   }
1144 
1145   // Machine dependent stuff
1146 #include OS_CPU_HEADER(javaThread)
1147 
1148   // JSR166 per-thread parker
1149  private:
1150   Parker _parker;
1151  public:
1152   Parker* parker() { return &_parker; }
1153 
1154  public:
1155   // clearing/querying jni attach status
1156   bool is_attaching_via_jni() const { return _jni_attach_state == _attaching_via_jni; }
1157   bool has_attached_via_jni() const { return is_attaching_via_jni() || _jni_attach_state == _attached_via_jni; }
1158   inline void set_done_attaching_via_jni();
1159 
1160   // Stack dump assistance:
1161   // Track the class we want to initialize but for which we have to wait
1162   // on its init_lock() because it is already being initialized.
1163   void set_class_to_be_initialized(InstanceKlass* k);
1164   InstanceKlass* class_to_be_initialized() const;
1165 
1166   // The most recent active <clinit> invocation is tracked by this variable.
1167   // The setter returns the previous value, so it can be restored later if needed.
1168   InstanceKlass* set_class_being_initialized(InstanceKlass* k);
1169   InstanceKlass* class_being_initialized() const;
1170 
1171 private:
1172   InstanceKlass* _class_to_be_initialized;
1173   InstanceKlass* _class_being_initialized;
1174 
1175   // java.lang.Thread.sleep support
1176   ParkEvent * _SleepEvent;
1177 public:
1178   bool sleep(jlong millis);
1179   bool sleep_nanos(jlong nanos);
1180 
1181   // java.lang.Thread interruption support
1182   void interrupt();
1183   bool is_interrupted(bool clear_interrupted);
1184 
1185   // This is only for use by JVMTI RawMonitorWait. It emulates the actions of
1186   // the Java code in Object::wait which are not present in RawMonitorWait.
1187   bool get_and_clear_interrupted();
1188 
1189 private:
1190   LockStack _lock_stack;
1191 
1192 public:
1193   LockStack& lock_stack() { return _lock_stack; }
1194 
1195   static ByteSize lock_stack_offset()      { return byte_offset_of(JavaThread, _lock_stack); }
1196   // Those offsets are used in code generators to access the LockStack that is embedded in this
1197   // JavaThread structure. Those accesses are relative to the current thread, which
1198   // is typically in a dedicated register.
1199   static ByteSize lock_stack_top_offset()  { return lock_stack_offset() + LockStack::top_offset(); }
1200   static ByteSize lock_stack_base_offset() { return lock_stack_offset() + LockStack::base_offset(); }
1201 
1202   static OopStorage* thread_oop_storage();
1203 
1204   static void verify_cross_modify_fence_failure(JavaThread *thread) PRODUCT_RETURN;
1205 
1206   // Helper function to create the java.lang.Thread object for a
1207   // VM-internal thread. The thread will have the given name and be
1208   // part of the System ThreadGroup.
1209   static Handle create_system_thread_object(const char* name, TRAPS);
1210 
1211   // Helper function to start a VM-internal daemon thread.
1212   // E.g. ServiceThread, NotificationThread, CompilerThread etc.
1213   static void start_internal_daemon(JavaThread* current, JavaThread* target,
1214                                     Handle thread_oop, ThreadPriority prio);
1215 
1216   // Helper function to do vm_exit_on_initialization for osthread
1217   // resource allocation failure.
1218   static void vm_exit_on_osthread_failure(JavaThread* thread);
1219 
1220   // Deferred OopHandle release support
1221  private:
1222   // List of OopHandles to be released - guarded by the Service_lock.
1223   static OopHandleList* _oop_handle_list;
1224   // Add our OopHandles to the list for the service thread to release.
1225   void add_oop_handles_for_release();
1226   // Called by the ServiceThread to release the OopHandles.
1227   static void release_oop_handles();
1228   // Called by the ServiceThread to poll if there are any OopHandles to release.
1229   // Called when holding the Service_lock.
1230   static bool has_oop_handles_to_release() {
1231     return _oop_handle_list != nullptr;
1232   }
1233 };
1234 
1235 inline JavaThread* JavaThread::current_or_null() {
1236   Thread* current = Thread::current_or_null();
1237   return current != nullptr ? JavaThread::cast(current) : nullptr;
1238 }
1239 
1240 class UnlockFlagSaver {
1241   private:
1242     JavaThread* _thread;
1243     bool _do_not_unlock;
1244   public:
1245     UnlockFlagSaver(JavaThread* t) {
1246       _thread = t;
1247       _do_not_unlock = t->do_not_unlock_if_synchronized();
1248       t->set_do_not_unlock_if_synchronized(false);
1249     }
1250     ~UnlockFlagSaver() {
1251       _thread->set_do_not_unlock_if_synchronized(_do_not_unlock);
1252     }
1253 };
1254 
1255 class JNIHandleMark : public StackObj {
1256   JavaThread* _thread;
1257  public:
1258   JNIHandleMark(JavaThread* thread) : _thread(thread) {
1259     thread->push_jni_handle_block();
1260   }
1261   ~JNIHandleMark() { _thread->pop_jni_handle_block(); }
1262 };
1263 
1264 #endif // SHARE_RUNTIME_JAVATHREAD_HPP