1 /*
   2  * Copyright (c) 1997, 2017, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.
   8  *
   9  * This code is distributed in the hope that it will be useful, but WITHOUT
  10  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  11  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  12  * version 2 for more details (a copy is included in the LICENSE file that
  13  * accompanied this code).
  14  *
  15  * You should have received a copy of the GNU General Public License version
  16  * 2 along with this work; if not, write to the Free Software Foundation,
  17  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  18  *
  19  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  20  * or visit www.oracle.com if you need additional information or have any
  21  * questions.
  22  *
  23  */
  24 
  25 #ifndef SHARE_VM_RUNTIME_THREAD_HPP
  26 #define SHARE_VM_RUNTIME_THREAD_HPP
  27 
  28 #include "gc/shared/threadLocalAllocBuffer.hpp"
  29 #include "memory/allocation.hpp"
  30 #include "oops/oop.hpp"
  31 #include "prims/jni.h"
  32 #include "prims/jvmtiExport.hpp"
  33 #include "runtime/frame.hpp"
  34 #include "runtime/javaFrameAnchor.hpp"
  35 #include "runtime/jniHandles.hpp"
  36 #include "runtime/mutexLocker.hpp"
  37 #include "runtime/os.hpp"
  38 #include "runtime/osThread.hpp"
  39 #include "runtime/park.hpp"
  40 #include "runtime/safepoint.hpp"
  41 #include "runtime/stubRoutines.hpp"
  42 #include "runtime/threadLocalStorage.hpp"
  43 #include "runtime/thread_ext.hpp"
  44 #include "runtime/unhandledOops.hpp"
  45 #include "trace/traceBackend.hpp"
  46 #include "trace/traceMacros.hpp"
  47 #include "utilities/align.hpp"
  48 #include "utilities/exceptions.hpp"
  49 #include "utilities/macros.hpp"
  50 #if INCLUDE_ALL_GCS
  51 #include "gc/g1/dirtyCardQueue.hpp"
  52 #include "gc/g1/satbMarkQueue.hpp"
  53 #endif // INCLUDE_ALL_GCS
  54 #ifdef ZERO
  55 # include "stack_zero.hpp"
  56 #endif
  57 
  58 class ThreadSafepointState;
  59 class ThreadProfiler;
  60 
  61 class JvmtiThreadState;
  62 class JvmtiGetLoadedClassesClosure;
  63 class ThreadStatistics;
  64 class ConcurrentLocksDump;
  65 class ParkEvent;
  66 class Parker;
  67 
  68 class ciEnv;
  69 class CompileThread;
  70 class CompileLog;
  71 class CompileTask;
  72 class CompileQueue;
  73 class CompilerCounters;
  74 class vframeArray;
  75 
  76 class DeoptResourceMark;
  77 class jvmtiDeferredLocalVariableSet;
  78 
  79 class GCTaskQueue;
  80 class ThreadClosure;
  81 class IdealGraphPrinter;
  82 
  83 class Metadata;
  84 template <class T, MEMFLAGS F> class ChunkedList;
  85 typedef ChunkedList<Metadata*, mtInternal> MetadataOnStackBuffer;
  86 
  87 DEBUG_ONLY(class ResourceMark;)
  88 
  89 class WorkerThread;
  90 
  91 // Class hierarchy
  92 // - Thread
  93 //   - NamedThread
  94 //     - VMThread
  95 //     - ConcurrentGCThread
  96 //     - WorkerThread
  97 //       - GangWorker
  98 //       - GCTaskThread
  99 //   - JavaThread
 100 //     - various subclasses eg CompilerThread, ServiceThread
 101 //   - WatcherThread
 102 
 103 class Thread: public ThreadShadow {
 104   friend class VMStructs;
 105   friend class JVMCIVMStructs;
 106  private:
 107 
 108 #ifndef USE_LIBRARY_BASED_TLS_ONLY
 109   // Current thread is maintained as a thread-local variable
 110   static THREAD_LOCAL_DECL Thread* _thr_current;
 111 #endif
 112 
 113   // Exception handling
 114   // (Note: _pending_exception and friends are in ThreadShadow)
 115   //oop       _pending_exception;                // pending exception for current thread
 116   // const char* _exception_file;                   // file information for exception (debugging only)
 117   // int         _exception_line;                   // line information for exception (debugging only)
 118  protected:
 119   // Support for forcing alignment of thread objects for biased locking
 120   void*       _real_malloc_address;
 121  public:
 122   void* operator new(size_t size) throw() { return allocate(size, true); }
 123   void* operator new(size_t size, const std::nothrow_t& nothrow_constant) throw() {
 124     return allocate(size, false); }
 125   void  operator delete(void* p);
 126 
 127  protected:
 128   static void* allocate(size_t size, bool throw_excpt, MEMFLAGS flags = mtThread);
 129  private:
 130 
 131   // ***************************************************************
 132   // Suspend and resume support
 133   // ***************************************************************
 134   //
 135   // VM suspend/resume no longer exists - it was once used for various
 136   // things including safepoints but was deprecated and finally removed
 137   // in Java 7. Because VM suspension was considered "internal" Java-level
 138   // suspension was considered "external", and this legacy naming scheme
 139   // remains.
 140   //
 141   // External suspend/resume requests come from JVM_SuspendThread,
 142   // JVM_ResumeThread, JVMTI SuspendThread, and finally JVMTI
 143   // ResumeThread. External
 144   // suspend requests cause _external_suspend to be set and external
 145   // resume requests cause _external_suspend to be cleared.
 146   // External suspend requests do not nest on top of other external
 147   // suspend requests. The higher level APIs reject suspend requests
 148   // for already suspended threads.
 149   //
 150   // The external_suspend
 151   // flag is checked by has_special_runtime_exit_condition() and java thread
 152   // will self-suspend when handle_special_runtime_exit_condition() is
 153   // called. Most uses of the _thread_blocked state in JavaThreads are
 154   // considered the same as being externally suspended; if the blocking
 155   // condition lifts, the JavaThread will self-suspend. Other places
 156   // where VM checks for external_suspend include:
 157   //   + mutex granting (do not enter monitors when thread is suspended)
 158   //   + state transitions from _thread_in_native
 159   //
 160   // In general, java_suspend() does not wait for an external suspend
 161   // request to complete. When it returns, the only guarantee is that
 162   // the _external_suspend field is true.
 163   //
 164   // wait_for_ext_suspend_completion() is used to wait for an external
 165   // suspend request to complete. External suspend requests are usually
 166   // followed by some other interface call that requires the thread to
 167   // be quiescent, e.g., GetCallTrace(). By moving the "wait time" into
 168   // the interface that requires quiescence, we give the JavaThread a
 169   // chance to self-suspend before we need it to be quiescent. This
 170   // improves overall suspend/query performance.
 171   //
 172   // _suspend_flags controls the behavior of java_ suspend/resume.
 173   // It must be set under the protection of SR_lock. Read from the flag is
 174   // OK without SR_lock as long as the value is only used as a hint.
 175   // (e.g., check _external_suspend first without lock and then recheck
 176   // inside SR_lock and finish the suspension)
 177   //
 178   // _suspend_flags is also overloaded for other "special conditions" so
 179   // that a single check indicates whether any special action is needed
 180   // eg. for async exceptions.
 181   // -------------------------------------------------------------------
 182   // Notes:
 183   // 1. The suspend/resume logic no longer uses ThreadState in OSThread
 184   // but we still update its value to keep other part of the system (mainly
 185   // JVMTI) happy. ThreadState is legacy code (see notes in
 186   // osThread.hpp).
 187   //
 188   // 2. It would be more natural if set_external_suspend() is private and
 189   // part of java_suspend(), but that probably would affect the suspend/query
 190   // performance. Need more investigation on this.
 191 
 192   // suspend/resume lock: used for self-suspend
 193   Monitor* _SR_lock;
 194 
 195  protected:
 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 
 200     _external_suspend       = 0x20000000U, // thread is asked to self suspend
 201     _ext_suspended          = 0x40000000U, // thread has self-suspended
 202     _deopt_suspend          = 0x10000000U, // thread needs to self suspend for deopt
 203 
 204     _has_async_exception    = 0x00000001U, // there is a pending async exception
 205     _critical_native_unlock = 0x00000002U  // Must call back to unlock JNI critical lock
 206   };
 207 
 208   // various suspension related flags - atomically updated
 209   // overloaded for async exception checking in check_special_condition_for_native_trans.
 210   volatile uint32_t _suspend_flags;
 211 
 212  private:
 213   int _num_nested_signal;
 214 
 215   DEBUG_ONLY(bool _suspendible_thread;)
 216 
 217  public:
 218   void enter_signal_handler() { _num_nested_signal++; }
 219   void leave_signal_handler() { _num_nested_signal--; }
 220   bool is_inside_signal_handler() const { return _num_nested_signal > 0; }
 221 
 222 #ifdef ASSERT
 223   void set_suspendible_thread() {
 224     _suspendible_thread = true;
 225   }
 226 
 227   void clear_suspendible_thread() {
 228     _suspendible_thread = false;
 229   }
 230 
 231   bool is_suspendible_thread() { return _suspendible_thread; }
 232 #endif
 233 
 234  private:
 235   // Active_handles points to a block of handles
 236   JNIHandleBlock* _active_handles;
 237 
 238   // One-element thread local free list
 239   JNIHandleBlock* _free_handle_block;
 240 
 241   // Point to the last handle mark
 242   HandleMark* _last_handle_mark;
 243 
 244   // The parity of the last strong_roots iteration in which this thread was
 245   // claimed as a task.
 246   jint _oops_do_parity;
 247 
 248  public:
 249   void set_last_handle_mark(HandleMark* mark)   { _last_handle_mark = mark; }
 250   HandleMark* last_handle_mark() const          { return _last_handle_mark; }
 251  private:
 252 
 253   // debug support for checking if code does allow safepoints or not
 254   // GC points in the VM can happen because of allocation, invoking a VM operation, or blocking on
 255   // mutex, or blocking on an object synchronizer (Java locking).
 256   // If !allow_safepoint(), then an assertion failure will happen in any of the above cases
 257   // If !allow_allocation(), then an assertion failure will happen during allocation
 258   // (Hence, !allow_safepoint() => !allow_allocation()).
 259   //
 260   // The two classes NoSafepointVerifier and No_Allocation_Verifier are used to set these counters.
 261   //
 262   NOT_PRODUCT(int _allow_safepoint_count;)      // If 0, thread allow a safepoint to happen
 263   debug_only(int _allow_allocation_count;)     // If 0, the thread is allowed to allocate oops.
 264 
 265   // Used by SkipGCALot class.
 266   NOT_PRODUCT(bool _skip_gcalot;)               // Should we elide gc-a-lot?
 267 
 268   friend class NoAllocVerifier;
 269   friend class NoSafepointVerifier;
 270   friend class PauseNoSafepointVerifier;
 271   friend class GCLocker;
 272 
 273   ThreadLocalAllocBuffer _tlab;                 // Thread-local eden
 274   jlong _allocated_bytes;                       // Cumulative number of bytes allocated on
 275                                                 // the Java heap
 276 
 277   mutable TRACE_DATA _trace_data;               // Thread-local data for tracing
 278 
 279   ThreadExt _ext;
 280 
 281   int   _vm_operation_started_count;            // VM_Operation support
 282   int   _vm_operation_completed_count;          // VM_Operation support
 283 
 284   ObjectMonitor* _current_pending_monitor;      // ObjectMonitor this thread
 285                                                 // is waiting to lock
 286   bool _current_pending_monitor_is_from_java;   // locking is from Java code
 287 
 288   // ObjectMonitor on which this thread called Object.wait()
 289   ObjectMonitor* _current_waiting_monitor;
 290 
 291   // Private thread-local objectmonitor list - a simple cache organized as a SLL.
 292  public:
 293   ObjectMonitor* omFreeList;
 294   int omFreeCount;                              // length of omFreeList
 295   int omFreeProvision;                          // reload chunk size
 296   ObjectMonitor* omInUseList;                   // SLL to track monitors in circulation
 297   int omInUseCount;                             // length of omInUseList
 298 
 299 #ifdef ASSERT
 300  private:
 301   bool _visited_for_critical_count;
 302 
 303  public:
 304   void set_visited_for_critical_count(bool z) { _visited_for_critical_count = z; }
 305   bool was_visited_for_critical_count() const   { return _visited_for_critical_count; }
 306 #endif
 307 
 308  public:
 309   enum {
 310     is_definitely_current_thread = true
 311   };
 312 
 313   // Constructor
 314   Thread();
 315   virtual ~Thread();
 316 
 317   // Manage Thread::current()
 318   void initialize_thread_current();
 319   void clear_thread_current(); // TLS cleanup needed before threads terminate
 320 
 321   public:
 322   // thread entry point
 323   virtual void run();
 324 
 325   // Testers
 326   virtual bool is_VM_thread()       const            { return false; }
 327   virtual bool is_Java_thread()     const            { return false; }
 328   virtual bool is_Compiler_thread() const            { return false; }
 329   virtual bool is_Code_cache_sweeper_thread() const  { return false; }
 330   virtual bool is_hidden_from_external_view() const  { return false; }
 331   virtual bool is_jvmti_agent_thread() const         { return false; }
 332   // True iff the thread can perform GC operations at a safepoint.
 333   // Generally will be true only of VM thread and parallel GC WorkGang
 334   // threads.
 335   virtual bool is_GC_task_thread() const             { return false; }
 336   virtual bool is_Watcher_thread() const             { return false; }
 337   virtual bool is_ConcurrentGC_thread() const        { return false; }
 338   virtual bool is_Named_thread() const               { return false; }
 339   virtual bool is_Worker_thread() const              { return false; }
 340 
 341   // Can this thread make Java upcalls
 342   virtual bool can_call_java() const                 { return false; }
 343 
 344   // Casts
 345   virtual WorkerThread* as_Worker_thread() const     { return NULL; }
 346 
 347   virtual char* name() const { return (char*)"Unknown thread"; }
 348 
 349   // Returns the current thread (ASSERTS if NULL)
 350   static inline Thread* current();
 351   // Returns the current thread, or NULL if not attached
 352   static inline Thread* current_or_null();
 353   // Returns the current thread, or NULL if not attached, and is
 354   // safe for use from signal-handlers
 355   static inline Thread* current_or_null_safe();
 356 
 357   // Common thread operations
 358   static void set_priority(Thread* thread, ThreadPriority priority);
 359   static ThreadPriority get_priority(const Thread* const thread);
 360   static void start(Thread* thread);
 361   static void interrupt(Thread* thr);
 362   static bool is_interrupted(Thread* thr, bool clear_interrupted);
 363 
 364   void set_native_thread_name(const char *name) {
 365     assert(Thread::current() == this, "set_native_thread_name can only be called on the current thread");
 366     os::set_native_thread_name(name);
 367   }
 368 
 369   ObjectMonitor** omInUseList_addr()             { return (ObjectMonitor **)&omInUseList; }
 370   Monitor* SR_lock() const                       { return _SR_lock; }
 371 
 372   bool has_async_exception() const { return (_suspend_flags & _has_async_exception) != 0; }
 373 
 374   inline void set_suspend_flag(SuspendFlags f);
 375   inline void clear_suspend_flag(SuspendFlags f);
 376 
 377   inline void set_has_async_exception();
 378   inline void clear_has_async_exception();
 379 
 380   bool do_critical_native_unlock() const { return (_suspend_flags & _critical_native_unlock) != 0; }
 381 
 382   inline void set_critical_native_unlock();
 383   inline void clear_critical_native_unlock();
 384 
 385   // Support for Unhandled Oop detection
 386   // Add the field for both, fastdebug and debug, builds to keep
 387   // Thread's fields layout the same.
 388   // Note: CHECK_UNHANDLED_OOPS is defined only for fastdebug build.
 389 #ifdef CHECK_UNHANDLED_OOPS
 390  private:
 391   UnhandledOops* _unhandled_oops;
 392 #elif defined(ASSERT)
 393  private:
 394   void* _unhandled_oops;
 395 #endif
 396 #ifdef CHECK_UNHANDLED_OOPS
 397  public:
 398   UnhandledOops* unhandled_oops() { return _unhandled_oops; }
 399   // Mark oop safe for gc.  It may be stack allocated but won't move.
 400   void allow_unhandled_oop(oop *op) {
 401     if (CheckUnhandledOops) unhandled_oops()->allow_unhandled_oop(op);
 402   }
 403   // Clear oops at safepoint so crashes point to unhandled oop violator
 404   void clear_unhandled_oops() {
 405     if (CheckUnhandledOops) unhandled_oops()->clear_unhandled_oops();
 406   }
 407 #endif // CHECK_UNHANDLED_OOPS
 408 
 409  public:
 410 #ifndef PRODUCT
 411   bool skip_gcalot()           { return _skip_gcalot; }
 412   void set_skip_gcalot(bool v) { _skip_gcalot = v;    }
 413 #endif
 414 
 415   // Installs a pending exception to be inserted later
 416   static void send_async_exception(oop thread_oop, oop java_throwable);
 417 
 418   // Resource area
 419   ResourceArea* resource_area() const            { return _resource_area; }
 420   void set_resource_area(ResourceArea* area)     { _resource_area = area; }
 421 
 422   OSThread* osthread() const                     { return _osthread;   }
 423   void set_osthread(OSThread* thread)            { _osthread = thread; }
 424 
 425   // JNI handle support
 426   JNIHandleBlock* active_handles() const         { return _active_handles; }
 427   void set_active_handles(JNIHandleBlock* block) { _active_handles = block; }
 428   JNIHandleBlock* free_handle_block() const      { return _free_handle_block; }
 429   void set_free_handle_block(JNIHandleBlock* block) { _free_handle_block = block; }
 430 
 431   // Internal handle support
 432   HandleArea* handle_area() const                { return _handle_area; }
 433   void set_handle_area(HandleArea* area)         { _handle_area = area; }
 434 
 435   GrowableArray<Metadata*>* metadata_handles() const          { return _metadata_handles; }
 436   void set_metadata_handles(GrowableArray<Metadata*>* handles){ _metadata_handles = handles; }
 437 
 438   // Thread-Local Allocation Buffer (TLAB) support
 439   ThreadLocalAllocBuffer& tlab()                 { return _tlab; }
 440   void initialize_tlab() {
 441     if (UseTLAB) {
 442       tlab().initialize();
 443     }
 444   }
 445 
 446   jlong allocated_bytes()               { return _allocated_bytes; }
 447   void set_allocated_bytes(jlong value) { _allocated_bytes = value; }
 448   void incr_allocated_bytes(jlong size) { _allocated_bytes += size; }
 449   inline jlong cooked_allocated_bytes();
 450 
 451   TRACE_DEFINE_THREAD_TRACE_DATA_OFFSET;
 452   TRACE_DATA* trace_data() const        { return &_trace_data; }
 453 
 454   const ThreadExt& ext() const          { return _ext; }
 455   ThreadExt& ext()                      { return _ext; }
 456 
 457   // VM operation support
 458   int vm_operation_ticket()                      { return ++_vm_operation_started_count; }
 459   int vm_operation_completed_count()             { return _vm_operation_completed_count; }
 460   void increment_vm_operation_completed_count()  { _vm_operation_completed_count++; }
 461 
 462   // For tracking the heavyweight monitor the thread is pending on.
 463   ObjectMonitor* current_pending_monitor() {
 464     return _current_pending_monitor;
 465   }
 466   void set_current_pending_monitor(ObjectMonitor* monitor) {
 467     _current_pending_monitor = monitor;
 468   }
 469   void set_current_pending_monitor_is_from_java(bool from_java) {
 470     _current_pending_monitor_is_from_java = from_java;
 471   }
 472   bool current_pending_monitor_is_from_java() {
 473     return _current_pending_monitor_is_from_java;
 474   }
 475 
 476   // For tracking the ObjectMonitor on which this thread called Object.wait()
 477   ObjectMonitor* current_waiting_monitor() {
 478     return _current_waiting_monitor;
 479   }
 480   void set_current_waiting_monitor(ObjectMonitor* monitor) {
 481     _current_waiting_monitor = monitor;
 482   }
 483 
 484   // GC support
 485   // Apply "f->do_oop" to all root oops in "this".
 486   //   Used by JavaThread::oops_do.
 487   // Apply "cf->do_code_blob" (if !NULL) to all code blobs active in frames
 488   virtual void oops_do(OopClosure* f, CodeBlobClosure* cf);
 489 
 490   // Handles the parallel case for the method below.
 491  private:
 492   bool claim_oops_do_par_case(int collection_parity);
 493  public:
 494   // Requires that "collection_parity" is that of the current roots
 495   // iteration.  If "is_par" is false, sets the parity of "this" to
 496   // "collection_parity", and returns "true".  If "is_par" is true,
 497   // uses an atomic instruction to set the current threads parity to
 498   // "collection_parity", if it is not already.  Returns "true" iff the
 499   // calling thread does the update, this indicates that the calling thread
 500   // has claimed the thread's stack as a root groop in the current
 501   // collection.
 502   bool claim_oops_do(bool is_par, int collection_parity) {
 503     if (!is_par) {
 504       _oops_do_parity = collection_parity;
 505       return true;
 506     } else {
 507       return claim_oops_do_par_case(collection_parity);
 508     }
 509   }
 510 
 511   // jvmtiRedefineClasses support
 512   void metadata_handles_do(void f(Metadata*));
 513 
 514   // Used by fast lock support
 515   virtual bool is_lock_owned(address adr) const;
 516 
 517   // Check if address is in the stack of the thread (not just for locks).
 518   // Warning: the method can only be used on the running thread
 519   bool is_in_stack(address adr) const;
 520   // Check if address is in the usable part of the stack (excludes protected
 521   // guard pages)
 522   bool is_in_usable_stack(address adr) const;
 523 
 524   // Sets this thread as starting thread. Returns failure if thread
 525   // creation fails due to lack of memory, too many threads etc.
 526   bool set_as_starting_thread();
 527 
 528 protected:
 529   // OS data associated with the thread
 530   OSThread* _osthread;  // Platform-specific thread information
 531 
 532   // Thread local resource area for temporary allocation within the VM
 533   ResourceArea* _resource_area;
 534 
 535   DEBUG_ONLY(ResourceMark* _current_resource_mark;)
 536 
 537   // Thread local handle area for allocation of handles within the VM
 538   HandleArea* _handle_area;
 539   GrowableArray<Metadata*>* _metadata_handles;
 540 
 541   // Support for stack overflow handling, get_thread, etc.
 542   address          _stack_base;
 543   size_t           _stack_size;
 544   uintptr_t        _self_raw_id;      // used by get_thread (mutable)
 545   int              _lgrp_id;
 546 
 547  public:
 548   // Stack overflow support
 549   address stack_base() const           { assert(_stack_base != NULL,"Sanity check"); return _stack_base; }
 550   void    set_stack_base(address base) { _stack_base = base; }
 551   size_t  stack_size() const           { return _stack_size; }
 552   void    set_stack_size(size_t size)  { _stack_size = size; }
 553   address stack_end()  const           { return stack_base() - stack_size(); }
 554   void    record_stack_base_and_size();
 555 
 556   bool    on_local_stack(address adr) const {
 557     // QQQ this has knowledge of direction, ought to be a stack method
 558     return (_stack_base >= adr && adr >= stack_end());
 559   }
 560 
 561   uintptr_t self_raw_id()                    { return _self_raw_id; }
 562   void      set_self_raw_id(uintptr_t value) { _self_raw_id = value; }
 563 
 564   int     lgrp_id() const        { return _lgrp_id; }
 565   void    set_lgrp_id(int value) { _lgrp_id = value; }
 566 
 567   // Printing
 568   virtual void print_on(outputStream* st) const;
 569   void print() const { print_on(tty); }
 570   virtual void print_on_error(outputStream* st, char* buf, int buflen) const;
 571 
 572   // Debug-only code
 573 #ifdef ASSERT
 574  private:
 575   // Deadlock detection support for Mutex locks. List of locks own by thread.
 576   Monitor* _owned_locks;
 577   // Mutex::set_owner_implementation is the only place where _owned_locks is modified,
 578   // thus the friendship
 579   friend class Mutex;
 580   friend class Monitor;
 581 
 582  public:
 583   void print_owned_locks_on(outputStream* st) const;
 584   void print_owned_locks() const                 { print_owned_locks_on(tty);    }
 585   Monitor* owned_locks() const                   { return _owned_locks;          }
 586   bool owns_locks() const                        { return owned_locks() != NULL; }
 587   bool owns_locks_but_compiled_lock() const;
 588   int oops_do_parity() const                     { return _oops_do_parity; }
 589 
 590   // Deadlock detection
 591   bool allow_allocation()                        { return _allow_allocation_count == 0; }
 592   ResourceMark* current_resource_mark()          { return _current_resource_mark; }
 593   void set_current_resource_mark(ResourceMark* rm) { _current_resource_mark = rm; }
 594 #endif
 595 
 596   void check_for_valid_safepoint_state(bool potential_vm_operation) PRODUCT_RETURN;
 597 
 598  private:
 599   volatile int _jvmti_env_iteration_count;
 600 
 601  public:
 602   void entering_jvmti_env_iteration()            { ++_jvmti_env_iteration_count; }
 603   void leaving_jvmti_env_iteration()             { --_jvmti_env_iteration_count; }
 604   bool is_inside_jvmti_env_iteration()           { return _jvmti_env_iteration_count > 0; }
 605 
 606   // Code generation
 607   static ByteSize exception_file_offset()        { return byte_offset_of(Thread, _exception_file); }
 608   static ByteSize exception_line_offset()        { return byte_offset_of(Thread, _exception_line); }
 609   static ByteSize active_handles_offset()        { return byte_offset_of(Thread, _active_handles); }
 610 
 611   static ByteSize stack_base_offset()            { return byte_offset_of(Thread, _stack_base); }
 612   static ByteSize stack_size_offset()            { return byte_offset_of(Thread, _stack_size); }
 613 
 614 #define TLAB_FIELD_OFFSET(name) \
 615   static ByteSize tlab_##name##_offset()         { return byte_offset_of(Thread, _tlab) + ThreadLocalAllocBuffer::name##_offset(); }
 616 
 617   TLAB_FIELD_OFFSET(start)
 618   TLAB_FIELD_OFFSET(end)
 619   TLAB_FIELD_OFFSET(top)
 620   TLAB_FIELD_OFFSET(pf_top)
 621   TLAB_FIELD_OFFSET(size)                   // desired_size
 622   TLAB_FIELD_OFFSET(refill_waste_limit)
 623   TLAB_FIELD_OFFSET(number_of_refills)
 624   TLAB_FIELD_OFFSET(fast_refill_waste)
 625   TLAB_FIELD_OFFSET(slow_allocations)
 626 
 627 #undef TLAB_FIELD_OFFSET
 628 
 629   static ByteSize allocated_bytes_offset()       { return byte_offset_of(Thread, _allocated_bytes); }
 630 
 631  public:
 632   volatile intptr_t _Stalled;
 633   volatile int _TypeTag;
 634   ParkEvent * _ParkEvent;                     // for synchronized()
 635   ParkEvent * _SleepEvent;                    // for Thread.sleep
 636   ParkEvent * _MutexEvent;                    // for native internal Mutex/Monitor
 637   ParkEvent * _MuxEvent;                      // for low-level muxAcquire-muxRelease
 638   int NativeSyncRecursion;                    // diagnostic
 639 
 640   volatile int _OnTrap;                       // Resume-at IP delta
 641   jint _hashStateW;                           // Marsaglia Shift-XOR thread-local RNG
 642   jint _hashStateX;                           // thread-specific hashCode generator state
 643   jint _hashStateY;
 644   jint _hashStateZ;
 645   void * _schedctl;
 646 
 647 
 648   volatile jint rng[4];                      // RNG for spin loop
 649 
 650   // Low-level leaf-lock primitives used to implement synchronization
 651   // and native monitor-mutex infrastructure.
 652   // Not for general synchronization use.
 653   static void SpinAcquire(volatile int * Lock, const char * Name);
 654   static void SpinRelease(volatile int * Lock);
 655   static void muxAcquire(volatile intptr_t * Lock, const char * Name);
 656   static void muxAcquireW(volatile intptr_t * Lock, ParkEvent * ev);
 657   static void muxRelease(volatile intptr_t * Lock);
 658 };
 659 
 660 // Inline implementation of Thread::current()
 661 inline Thread* Thread::current() {
 662   Thread* current = current_or_null();
 663   assert(current != NULL, "Thread::current() called on detached thread");
 664   return current;
 665 }
 666 
 667 inline Thread* Thread::current_or_null() {
 668 #ifndef USE_LIBRARY_BASED_TLS_ONLY
 669   return _thr_current;
 670 #else
 671   return ThreadLocalStorage::thread();
 672 #endif
 673 }
 674 
 675 inline Thread* Thread::current_or_null_safe() {
 676   return ThreadLocalStorage::thread();
 677 }
 678 
 679 // Name support for threads.  non-JavaThread subclasses with multiple
 680 // uniquely named instances should derive from this.
 681 class NamedThread: public Thread {
 682   friend class VMStructs;
 683   enum {
 684     max_name_len = 64
 685   };
 686  private:
 687   char* _name;
 688   // log JavaThread being processed by oops_do
 689   JavaThread* _processed_thread;
 690   uint _gc_id; // The current GC id when a thread takes part in GC
 691 
 692  public:
 693   NamedThread();
 694   ~NamedThread();
 695   // May only be called once per thread.
 696   void set_name(const char* format, ...)  ATTRIBUTE_PRINTF(2, 3);
 697   void initialize_named_thread();
 698   virtual bool is_Named_thread() const { return true; }
 699   virtual char* name() const { return _name == NULL ? (char*)"Unknown Thread" : _name; }
 700   JavaThread *processed_thread() { return _processed_thread; }
 701   void set_processed_thread(JavaThread *thread) { _processed_thread = thread; }
 702   virtual void print_on(outputStream* st) const;
 703 
 704   void set_gc_id(uint gc_id) { _gc_id = gc_id; }
 705   uint gc_id() { return _gc_id; }
 706 };
 707 
 708 // Worker threads are named and have an id of an assigned work.
 709 class WorkerThread: public NamedThread {
 710  private:
 711   uint _id;
 712  public:
 713   WorkerThread() : _id(0)               { }
 714   virtual bool is_Worker_thread() const { return true; }
 715 
 716   virtual WorkerThread* as_Worker_thread() const {
 717     assert(is_Worker_thread(), "Dubious cast to WorkerThread*?");
 718     return (WorkerThread*) this;
 719   }
 720 
 721   void set_id(uint work_id)             { _id = work_id; }
 722   uint id() const                       { return _id; }
 723 };
 724 
 725 // A single WatcherThread is used for simulating timer interrupts.
 726 class WatcherThread: public Thread {
 727   friend class VMStructs;
 728  public:
 729   virtual void run();
 730 
 731  private:
 732   static WatcherThread* _watcher_thread;
 733 
 734   static bool _startable;
 735   // volatile due to at least one lock-free read
 736   volatile static bool _should_terminate;
 737 
 738   os::WatcherThreadCrashProtection* _crash_protection;
 739  public:
 740   enum SomeConstants {
 741     delay_interval = 10                          // interrupt delay in milliseconds
 742   };
 743 
 744   // Constructor
 745   WatcherThread();
 746 
 747   // No destruction allowed
 748   ~WatcherThread() {
 749     guarantee(false, "WatcherThread deletion must fix the race with VM termination");
 750   }
 751 
 752   // Tester
 753   bool is_Watcher_thread() const                 { return true; }
 754 
 755   // Printing
 756   char* name() const { return (char*)"VM Periodic Task Thread"; }
 757   void print_on(outputStream* st) const;
 758   void unpark();
 759 
 760   // Returns the single instance of WatcherThread
 761   static WatcherThread* watcher_thread()         { return _watcher_thread; }
 762 
 763   // Create and start the single instance of WatcherThread, or stop it on shutdown
 764   static void start();
 765   static void stop();
 766   // Only allow start once the VM is sufficiently initialized
 767   // Otherwise the first task to enroll will trigger the start
 768   static void make_startable();
 769 
 770   void set_crash_protection(os::WatcherThreadCrashProtection* crash_protection) {
 771     assert(Thread::current()->is_Watcher_thread(), "Can only be set by WatcherThread");
 772     _crash_protection = crash_protection;
 773   }
 774 
 775   bool has_crash_protection() const { return _crash_protection != NULL; }
 776   os::WatcherThreadCrashProtection* crash_protection() const { return _crash_protection; }
 777 
 778  private:
 779   int sleep() const;
 780 };
 781 
 782 
 783 class CompilerThread;
 784 
 785 typedef void (*ThreadFunction)(JavaThread*, TRAPS);
 786 
 787 class JavaThread: public Thread {
 788   friend class VMStructs;
 789   friend class JVMCIVMStructs;
 790   friend class WhiteBox;
 791  private:
 792   JavaThread*    _next;                          // The next thread in the Threads list
 793   oop            _threadObj;                     // The Java level thread object
 794 
 795 #ifdef ASSERT
 796  private:
 797   int _java_call_counter;
 798 
 799  public:
 800   int  java_call_counter()                       { return _java_call_counter; }
 801   void inc_java_call_counter()                   { _java_call_counter++; }
 802   void dec_java_call_counter() {
 803     assert(_java_call_counter > 0, "Invalid nesting of JavaCallWrapper");
 804     _java_call_counter--;
 805   }
 806  private:  // restore original namespace restriction
 807 #endif  // ifdef ASSERT
 808 
 809 #ifndef PRODUCT
 810  public:
 811   enum {
 812     jump_ring_buffer_size = 16
 813   };
 814  private:  // restore original namespace restriction
 815 #endif
 816 
 817   JavaFrameAnchor _anchor;                       // Encapsulation of current java frame and it state
 818 
 819   ThreadFunction _entry_point;
 820 
 821   JNIEnv        _jni_environment;
 822 
 823   // Deopt support
 824   DeoptResourceMark*  _deopt_mark;               // Holds special ResourceMark for deoptimization
 825 
 826   intptr_t*      _must_deopt_id;                 // id of frame that needs to be deopted once we
 827                                                  // transition out of native
 828   CompiledMethod*       _deopt_nmethod;         // CompiledMethod that is currently being deoptimized
 829   vframeArray*  _vframe_array_head;              // Holds the heap of the active vframeArrays
 830   vframeArray*  _vframe_array_last;              // Holds last vFrameArray we popped
 831   // Because deoptimization is lazy we must save jvmti requests to set locals
 832   // in compiled frames until we deoptimize and we have an interpreter frame.
 833   // This holds the pointer to array (yeah like there might be more than one) of
 834   // description of compiled vframes that have locals that need to be updated.
 835   GrowableArray<jvmtiDeferredLocalVariableSet*>* _deferred_locals_updates;
 836 
 837   // Handshake value for fixing 6243940. We need a place for the i2c
 838   // adapter to store the callee Method*. This value is NEVER live
 839   // across a gc point so it does NOT have to be gc'd
 840   // The handshake is open ended since we can't be certain that it will
 841   // be NULLed. This is because we rarely ever see the race and end up
 842   // in handle_wrong_method which is the backend of the handshake. See
 843   // code in i2c adapters and handle_wrong_method.
 844 
 845   Method*       _callee_target;
 846 
 847   // Used to pass back results to the interpreter or generated code running Java code.
 848   oop           _vm_result;    // oop result is GC-preserved
 849   Metadata*     _vm_result_2;  // non-oop result
 850 
 851   // See ReduceInitialCardMarks: this holds the precise space interval of
 852   // the most recent slow path allocation for which compiled code has
 853   // elided card-marks for performance along the fast-path.
 854   MemRegion     _deferred_card_mark;
 855 
 856   MonitorChunk* _monitor_chunks;                 // Contains the off stack monitors
 857                                                  // allocated during deoptimization
 858                                                  // and by JNI_MonitorEnter/Exit
 859 
 860   // Async. requests support
 861   enum AsyncRequests {
 862     _no_async_condition = 0,
 863     _async_exception,
 864     _async_unsafe_access_error
 865   };
 866   AsyncRequests _special_runtime_exit_condition; // Enum indicating pending async. request
 867   oop           _pending_async_exception;
 868 
 869   // Safepoint support
 870  public:                                         // Expose _thread_state for SafeFetchInt()
 871   volatile JavaThreadState _thread_state;
 872  private:
 873   ThreadSafepointState *_safepoint_state;        // Holds information about a thread during a safepoint
 874   address               _saved_exception_pc;     // Saved pc of instruction where last implicit exception happened
 875 
 876   // JavaThread termination support
 877   enum TerminatedTypes {
 878     _not_terminated = 0xDEAD - 2,
 879     _thread_exiting,                             // JavaThread::exit() has been called for this thread
 880     _thread_terminated,                          // JavaThread is removed from thread list
 881     _vm_exited                                   // JavaThread is still executing native code, but VM is terminated
 882                                                  // only VM_Exit can set _vm_exited
 883   };
 884 
 885   // In general a JavaThread's _terminated field transitions as follows:
 886   //
 887   //   _not_terminated => _thread_exiting => _thread_terminated
 888   //
 889   // _vm_exited is a special value to cover the case of a JavaThread
 890   // executing native code after the VM itself is terminated.
 891   volatile TerminatedTypes _terminated;
 892   // suspend/resume support
 893   volatile bool         _suspend_equivalent;     // Suspend equivalent condition
 894   jint                  _in_deopt_handler;       // count of deoptimization
 895                                                  // handlers thread is in
 896   volatile bool         _doing_unsafe_access;    // Thread may fault due to unsafe access
 897   bool                  _do_not_unlock_if_synchronized;  // Do not unlock the receiver of a synchronized method (since it was
 898                                                          // never locked) when throwing an exception. Used by interpreter only.
 899 
 900   // JNI attach states:
 901   enum JNIAttachStates {
 902     _not_attaching_via_jni = 1,  // thread is not attaching via JNI
 903     _attaching_via_jni,          // thread is attaching via JNI
 904     _attached_via_jni            // thread has attached via JNI
 905   };
 906 
 907   // A regular JavaThread's _jni_attach_state is _not_attaching_via_jni.
 908   // A native thread that is attaching via JNI starts with a value
 909   // of _attaching_via_jni and transitions to _attached_via_jni.
 910   volatile JNIAttachStates _jni_attach_state;
 911 
 912  public:
 913   // State of the stack guard pages for this thread.
 914   enum StackGuardState {
 915     stack_guard_unused,         // not needed
 916     stack_guard_reserved_disabled,
 917     stack_guard_yellow_reserved_disabled,// disabled (temporarily) after stack overflow
 918     stack_guard_enabled         // enabled
 919   };
 920 
 921  private:
 922 
 923 #if INCLUDE_JVMCI
 924   // The _pending_* fields below are used to communicate extra information
 925   // from an uncommon trap in JVMCI compiled code to the uncommon trap handler.
 926 
 927   // Communicates the DeoptReason and DeoptAction of the uncommon trap
 928   int       _pending_deoptimization;
 929 
 930   // Specifies whether the uncommon trap is to bci 0 of a synchronized method
 931   // before the monitor has been acquired.
 932   bool      _pending_monitorenter;
 933 
 934   // Specifies if the DeoptReason for the last uncommon trap was Reason_transfer_to_interpreter
 935   bool      _pending_transfer_to_interpreter;
 936 
 937   // Guard for re-entrant call to JVMCIRuntime::adjust_comp_level
 938   bool      _adjusting_comp_level;
 939 
 940   // An object that JVMCI compiled code can use to further describe and
 941   // uniquely identify the  speculative optimization guarded by the uncommon trap
 942   oop       _pending_failed_speculation;
 943 
 944   // These fields are mutually exclusive in terms of live ranges.
 945   union {
 946     // Communicates the pc at which the most recent implicit exception occurred
 947     // from the signal handler to a deoptimization stub.
 948     address   _implicit_exception_pc;
 949 
 950     // Communicates an alternative call target to an i2c stub from a JavaCall .
 951     address   _alternate_call_target;
 952   } _jvmci;
 953 
 954   // Support for high precision, thread sensitive counters in JVMCI compiled code.
 955   jlong*    _jvmci_counters;
 956 
 957  public:
 958   static jlong* _jvmci_old_thread_counters;
 959   static void collect_counters(typeArrayOop array);
 960  private:
 961 #endif // INCLUDE_JVMCI
 962 
 963   StackGuardState  _stack_guard_state;
 964 
 965   // Precompute the limit of the stack as used in stack overflow checks.
 966   // We load it from here to simplify the stack overflow check in assembly.
 967   address          _stack_overflow_limit;
 968   address          _reserved_stack_activation;
 969 
 970   // Compiler exception handling (NOTE: The _exception_oop is *NOT* the same as _pending_exception. It is
 971   // used to temp. parsing values into and out of the runtime system during exception handling for compiled
 972   // code)
 973   volatile oop     _exception_oop;               // Exception thrown in compiled code
 974   volatile address _exception_pc;                // PC where exception happened
 975   volatile address _exception_handler_pc;        // PC for handler of exception
 976   volatile int     _is_method_handle_return;     // true (== 1) if the current exception PC is a MethodHandle call site.
 977 
 978  private:
 979   // support for JNI critical regions
 980   jint    _jni_active_critical;                  // count of entries into JNI critical region
 981 
 982   // Checked JNI: function name requires exception check
 983   char* _pending_jni_exception_check_fn;
 984 
 985   // For deadlock detection.
 986   int _depth_first_number;
 987 
 988   // JVMTI PopFrame support
 989   // This is set to popframe_pending to signal that top Java frame should be popped immediately
 990   int _popframe_condition;
 991 
 992   // If reallocation of scalar replaced objects fails, we throw OOM
 993   // and during exception propagation, pop the top
 994   // _frames_to_pop_failed_realloc frames, the ones that reference
 995   // failed reallocations.
 996   int _frames_to_pop_failed_realloc;
 997 
 998 #ifndef PRODUCT
 999   int _jmp_ring_index;
1000   struct {
1001     // We use intptr_t instead of address so debugger doesn't try and display strings
1002     intptr_t _target;
1003     intptr_t _instruction;
1004     const char*  _file;
1005     int _line;
1006   }   _jmp_ring[jump_ring_buffer_size];
1007 #endif // PRODUCT
1008 
1009 #if INCLUDE_ALL_GCS
1010   // Support for G1 barriers
1011 
1012   SATBMarkQueue _satb_mark_queue;        // Thread-local log for SATB barrier.
1013   // Set of all such queues.
1014   static SATBMarkQueueSet _satb_mark_queue_set;
1015 
1016   DirtyCardQueue _dirty_card_queue;      // Thread-local log for dirty cards.
1017   // Set of all such queues.
1018   static DirtyCardQueueSet _dirty_card_queue_set;
1019 
1020   void flush_barrier_queues();
1021 #endif // INCLUDE_ALL_GCS
1022 
1023   friend class VMThread;
1024   friend class ThreadWaitTransition;
1025   friend class VM_Exit;
1026 
1027   void initialize();                             // Initialized the instance variables
1028 
1029  public:
1030   // Constructor
1031   JavaThread(bool is_attaching_via_jni = false); // for main thread and JNI attached threads
1032   JavaThread(ThreadFunction entry_point, size_t stack_size = 0);
1033   ~JavaThread();
1034 
1035 #ifdef ASSERT
1036   // verify this JavaThread hasn't be published in the Threads::list yet
1037   void verify_not_published();
1038 #endif
1039 
1040   //JNI functiontable getter/setter for JVMTI jni function table interception API.
1041   void set_jni_functions(struct JNINativeInterface_* functionTable) {
1042     _jni_environment.functions = functionTable;
1043   }
1044   struct JNINativeInterface_* get_jni_functions() {
1045     return (struct JNINativeInterface_ *)_jni_environment.functions;
1046   }
1047 
1048   // This function is called at thread creation to allow
1049   // platform specific thread variables to be initialized.
1050   void cache_global_variables();
1051 
1052   // Executes Shutdown.shutdown()
1053   void invoke_shutdown_hooks();
1054 
1055   // Cleanup on thread exit
1056   enum ExitType {
1057     normal_exit,
1058     jni_detach
1059   };
1060   void exit(bool destroy_vm, ExitType exit_type = normal_exit);
1061 
1062   void cleanup_failed_attach_current_thread();
1063 
1064   // Testers
1065   virtual bool is_Java_thread() const            { return true;  }
1066   virtual bool can_call_java() const             { return true; }
1067 
1068   // Thread chain operations
1069   JavaThread* next() const                       { return _next; }
1070   void set_next(JavaThread* p)                   { _next = p; }
1071 
1072   // Thread oop. threadObj() can be NULL for initial JavaThread
1073   // (or for threads attached via JNI)
1074   oop threadObj() const                          { return _threadObj; }
1075   void set_threadObj(oop p)                      { _threadObj = p; }
1076 
1077   ThreadPriority java_priority() const;          // Read from threadObj()
1078 
1079   // Prepare thread and add to priority queue.  If a priority is
1080   // not specified, use the priority of the thread object. Threads_lock
1081   // must be held while this function is called.
1082   void prepare(jobject jni_thread, ThreadPriority prio=NoPriority);
1083   void prepare_ext();
1084 
1085   void set_saved_exception_pc(address pc)        { _saved_exception_pc = pc; }
1086   address saved_exception_pc()                   { return _saved_exception_pc; }
1087 
1088 
1089   ThreadFunction entry_point() const             { return _entry_point; }
1090 
1091   // Allocates a new Java level thread object for this thread. thread_name may be NULL.
1092   void allocate_threadObj(Handle thread_group, const char* thread_name, bool daemon, TRAPS);
1093 
1094   // Last frame anchor routines
1095 
1096   JavaFrameAnchor* frame_anchor(void)            { return &_anchor; }
1097 
1098   // last_Java_sp
1099   bool has_last_Java_frame() const               { return _anchor.has_last_Java_frame(); }
1100   intptr_t* last_Java_sp() const                 { return _anchor.last_Java_sp(); }
1101 
1102   // last_Java_pc
1103 
1104   address last_Java_pc(void)                     { return _anchor.last_Java_pc(); }
1105 
1106   // Safepoint support
1107 #if !(defined(PPC64) || defined(AARCH64))
1108   JavaThreadState thread_state() const           { return _thread_state; }
1109   void set_thread_state(JavaThreadState s)       { _thread_state = s;    }
1110 #else
1111   // Use membars when accessing volatile _thread_state. See
1112   // Threads::create_vm() for size checks.
1113   inline JavaThreadState thread_state() const;
1114   inline void set_thread_state(JavaThreadState s);
1115 #endif
1116   ThreadSafepointState *safepoint_state() const  { return _safepoint_state; }
1117   void set_safepoint_state(ThreadSafepointState *state) { _safepoint_state = state; }
1118   bool is_at_poll_safepoint()                    { return _safepoint_state->is_at_poll_safepoint(); }
1119 
1120   // thread has called JavaThread::exit() or is terminated
1121   bool is_exiting()                              { return _terminated == _thread_exiting || is_terminated(); }
1122   // thread is terminated (no longer on the threads list); we compare
1123   // against the two non-terminated values so that a freed JavaThread
1124   // will also be considered terminated.
1125   bool is_terminated()                           { return _terminated != _not_terminated && _terminated != _thread_exiting; }
1126   void set_terminated(TerminatedTypes t)         { _terminated = t; }
1127   // special for Threads::remove() which is static:
1128   void set_terminated_value()                    { _terminated = _thread_terminated; }
1129   void block_if_vm_exited();
1130 
1131   bool doing_unsafe_access()                     { return _doing_unsafe_access; }
1132   void set_doing_unsafe_access(bool val)         { _doing_unsafe_access = val; }
1133 
1134   bool do_not_unlock_if_synchronized()             { return _do_not_unlock_if_synchronized; }
1135   void set_do_not_unlock_if_synchronized(bool val) { _do_not_unlock_if_synchronized = val; }
1136 
1137   // Suspend/resume support for JavaThread
1138  private:
1139   inline void set_ext_suspended();
1140   inline void clear_ext_suspended();
1141 
1142  public:
1143   void java_suspend();
1144   void java_resume();
1145   int  java_suspend_self();
1146 
1147   void check_and_wait_while_suspended() {
1148     assert(JavaThread::current() == this, "sanity check");
1149 
1150     bool do_self_suspend;
1151     do {
1152       // were we externally suspended while we were waiting?
1153       do_self_suspend = handle_special_suspend_equivalent_condition();
1154       if (do_self_suspend) {
1155         // don't surprise the thread that suspended us by returning
1156         java_suspend_self();
1157         set_suspend_equivalent();
1158       }
1159     } while (do_self_suspend);
1160   }
1161   static void check_safepoint_and_suspend_for_native_trans(JavaThread *thread);
1162   // Check for async exception in addition to safepoint and suspend request.
1163   static void check_special_condition_for_native_trans(JavaThread *thread);
1164 
1165   // Same as check_special_condition_for_native_trans but finishes the
1166   // transition into thread_in_Java mode so that it can potentially
1167   // block.
1168   static void check_special_condition_for_native_trans_and_transition(JavaThread *thread);
1169 
1170   bool is_ext_suspend_completed(bool called_by_wait, int delay, uint32_t *bits);
1171   bool is_ext_suspend_completed_with_lock(uint32_t *bits) {
1172     MutexLockerEx ml(SR_lock(), Mutex::_no_safepoint_check_flag);
1173     // Warning: is_ext_suspend_completed() may temporarily drop the
1174     // SR_lock to allow the thread to reach a stable thread state if
1175     // it is currently in a transient thread state.
1176     return is_ext_suspend_completed(false /* !called_by_wait */,
1177                                     SuspendRetryDelay, bits);
1178   }
1179 
1180   // We cannot allow wait_for_ext_suspend_completion() to run forever or
1181   // we could hang. SuspendRetryCount and SuspendRetryDelay are normally
1182   // passed as the count and delay parameters. Experiments with specific
1183   // calls to wait_for_ext_suspend_completion() can be done by passing
1184   // other values in the code. Experiments with all calls can be done
1185   // via the appropriate -XX options.
1186   bool wait_for_ext_suspend_completion(int count, int delay, uint32_t *bits);
1187 
1188   inline void set_external_suspend();
1189   inline void clear_external_suspend();
1190 
1191   inline void set_deopt_suspend();
1192   inline void clear_deopt_suspend();
1193   bool is_deopt_suspend()         { return (_suspend_flags & _deopt_suspend) != 0; }
1194 
1195   bool is_external_suspend() const {
1196     return (_suspend_flags & _external_suspend) != 0;
1197   }
1198   // Whenever a thread transitions from native to vm/java it must suspend
1199   // if external|deopt suspend is present.
1200   bool is_suspend_after_native() const {
1201     return (_suspend_flags & (_external_suspend | _deopt_suspend)) != 0;
1202   }
1203 
1204   // external suspend request is completed
1205   bool is_ext_suspended() const {
1206     return (_suspend_flags & _ext_suspended) != 0;
1207   }
1208 
1209   bool is_external_suspend_with_lock() const {
1210     MutexLockerEx ml(SR_lock(), Mutex::_no_safepoint_check_flag);
1211     return is_external_suspend();
1212   }
1213 
1214   // Special method to handle a pending external suspend request
1215   // when a suspend equivalent condition lifts.
1216   bool handle_special_suspend_equivalent_condition() {
1217     assert(is_suspend_equivalent(),
1218            "should only be called in a suspend equivalence condition");
1219     MutexLockerEx ml(SR_lock(), Mutex::_no_safepoint_check_flag);
1220     bool ret = is_external_suspend();
1221     if (!ret) {
1222       // not about to self-suspend so clear suspend equivalence
1223       clear_suspend_equivalent();
1224     }
1225     // implied else:
1226     // We have a pending external suspend request so we leave the
1227     // suspend_equivalent flag set until java_suspend_self() sets
1228     // the ext_suspended flag and clears the suspend_equivalent
1229     // flag. This insures that wait_for_ext_suspend_completion()
1230     // will return consistent values.
1231     return ret;
1232   }
1233 
1234   // utility methods to see if we are doing some kind of suspension
1235   bool is_being_ext_suspended() const            {
1236     MutexLockerEx ml(SR_lock(), Mutex::_no_safepoint_check_flag);
1237     return is_ext_suspended() || is_external_suspend();
1238   }
1239 
1240   bool is_suspend_equivalent() const             { return _suspend_equivalent; }
1241 
1242   void set_suspend_equivalent()                  { _suspend_equivalent = true; }
1243   void clear_suspend_equivalent()                { _suspend_equivalent = false; }
1244 
1245   // Thread.stop support
1246   void send_thread_stop(oop throwable);
1247   AsyncRequests clear_special_runtime_exit_condition() {
1248     AsyncRequests x = _special_runtime_exit_condition;
1249     _special_runtime_exit_condition = _no_async_condition;
1250     return x;
1251   }
1252 
1253   // Are any async conditions present?
1254   bool has_async_condition() { return (_special_runtime_exit_condition != _no_async_condition); }
1255 
1256   void check_and_handle_async_exceptions(bool check_unsafe_error = true);
1257 
1258   // these next two are also used for self-suspension and async exception support
1259   void handle_special_runtime_exit_condition(bool check_asyncs = true);
1260 
1261   // Return true if JavaThread has an asynchronous condition or
1262   // if external suspension is requested.
1263   bool has_special_runtime_exit_condition() {
1264     // We call is_external_suspend() last since external suspend should
1265     // be less common. Because we don't use is_external_suspend_with_lock
1266     // it is possible that we won't see an asynchronous external suspend
1267     // request that has just gotten started, i.e., SR_lock grabbed but
1268     // _external_suspend field change either not made yet or not visible
1269     // yet. However, this is okay because the request is asynchronous and
1270     // we will see the new flag value the next time through. It's also
1271     // possible that the external suspend request is dropped after
1272     // we have checked is_external_suspend(), we will recheck its value
1273     // under SR_lock in java_suspend_self().
1274     return (_special_runtime_exit_condition != _no_async_condition) ||
1275             is_external_suspend() || is_deopt_suspend();
1276   }
1277 
1278   void set_pending_unsafe_access_error()          { _special_runtime_exit_condition = _async_unsafe_access_error; }
1279 
1280   inline void set_pending_async_exception(oop e);
1281 
1282   // Fast-locking support
1283   bool is_lock_owned(address adr) const;
1284 
1285   // Accessors for vframe array top
1286   // The linked list of vframe arrays are sorted on sp. This means when we
1287   // unpack the head must contain the vframe array to unpack.
1288   void set_vframe_array_head(vframeArray* value) { _vframe_array_head = value; }
1289   vframeArray* vframe_array_head() const         { return _vframe_array_head;  }
1290 
1291   // Side structure for deferring update of java frame locals until deopt occurs
1292   GrowableArray<jvmtiDeferredLocalVariableSet*>* deferred_locals() const { return _deferred_locals_updates; }
1293   void set_deferred_locals(GrowableArray<jvmtiDeferredLocalVariableSet *>* vf) { _deferred_locals_updates = vf; }
1294 
1295   // These only really exist to make debugging deopt problems simpler
1296 
1297   void set_vframe_array_last(vframeArray* value) { _vframe_array_last = value; }
1298   vframeArray* vframe_array_last() const         { return _vframe_array_last;  }
1299 
1300   // The special resourceMark used during deoptimization
1301 
1302   void set_deopt_mark(DeoptResourceMark* value)  { _deopt_mark = value; }
1303   DeoptResourceMark* deopt_mark(void)            { return _deopt_mark; }
1304 
1305   intptr_t* must_deopt_id()                      { return _must_deopt_id; }
1306   void     set_must_deopt_id(intptr_t* id)       { _must_deopt_id = id; }
1307   void     clear_must_deopt_id()                 { _must_deopt_id = NULL; }
1308 
1309   void set_deopt_compiled_method(CompiledMethod* nm)  { _deopt_nmethod = nm; }
1310   CompiledMethod* deopt_compiled_method()        { return _deopt_nmethod; }
1311 
1312   Method*    callee_target() const               { return _callee_target; }
1313   void set_callee_target  (Method* x)          { _callee_target   = x; }
1314 
1315   // Oop results of vm runtime calls
1316   oop  vm_result() const                         { return _vm_result; }
1317   void set_vm_result  (oop x)                    { _vm_result   = x; }
1318 
1319   Metadata*    vm_result_2() const               { return _vm_result_2; }
1320   void set_vm_result_2  (Metadata* x)          { _vm_result_2   = x; }
1321 
1322   MemRegion deferred_card_mark() const           { return _deferred_card_mark; }
1323   void set_deferred_card_mark(MemRegion mr)      { _deferred_card_mark = mr;   }
1324 
1325 #if INCLUDE_JVMCI
1326   int  pending_deoptimization() const             { return _pending_deoptimization; }
1327   oop  pending_failed_speculation() const         { return _pending_failed_speculation; }
1328   bool adjusting_comp_level() const               { return _adjusting_comp_level; }
1329   void set_adjusting_comp_level(bool b)           { _adjusting_comp_level = b; }
1330   bool has_pending_monitorenter() const           { return _pending_monitorenter; }
1331   void set_pending_monitorenter(bool b)           { _pending_monitorenter = b; }
1332   void set_pending_deoptimization(int reason)     { _pending_deoptimization = reason; }
1333   void set_pending_failed_speculation(oop failed_speculation) { _pending_failed_speculation = failed_speculation; }
1334   void set_pending_transfer_to_interpreter(bool b) { _pending_transfer_to_interpreter = b; }
1335   void set_jvmci_alternate_call_target(address a) { assert(_jvmci._alternate_call_target == NULL, "must be"); _jvmci._alternate_call_target = a; }
1336   void set_jvmci_implicit_exception_pc(address a) { assert(_jvmci._implicit_exception_pc == NULL, "must be"); _jvmci._implicit_exception_pc = a; }
1337 #endif // INCLUDE_JVMCI
1338 
1339   // Exception handling for compiled methods
1340   oop      exception_oop() const                 { return _exception_oop; }
1341   address  exception_pc() const                  { return _exception_pc; }
1342   address  exception_handler_pc() const          { return _exception_handler_pc; }
1343   bool     is_method_handle_return() const       { return _is_method_handle_return == 1; }
1344 
1345   void set_exception_oop(oop o)                  { (void)const_cast<oop&>(_exception_oop = o); }
1346   void set_exception_pc(address a)               { _exception_pc = a; }
1347   void set_exception_handler_pc(address a)       { _exception_handler_pc = a; }
1348   void set_is_method_handle_return(bool value)   { _is_method_handle_return = value ? 1 : 0; }
1349 
1350   void clear_exception_oop_and_pc() {
1351     set_exception_oop(NULL);
1352     set_exception_pc(NULL);
1353   }
1354 
1355   // Stack overflow support
1356   //
1357   //  (small addresses)
1358   //
1359   //  --  <-- stack_end()                   ---
1360   //  |                                      |
1361   //  |  red pages                           |
1362   //  |                                      |
1363   //  --  <-- stack_red_zone_base()          |
1364   //  |                                      |
1365   //  |                                     guard
1366   //  |  yellow pages                       zone
1367   //  |                                      |
1368   //  |                                      |
1369   //  --  <-- stack_yellow_zone_base()       |
1370   //  |                                      |
1371   //  |                                      |
1372   //  |  reserved pages                      |
1373   //  |                                      |
1374   //  --  <-- stack_reserved_zone_base()    ---      ---
1375   //                                                 /|\  shadow     <--  stack_overflow_limit() (somewhere in here)
1376   //                                                  |   zone
1377   //                                                 \|/  size
1378   //  some untouched memory                          ---
1379   //
1380   //
1381   //  --
1382   //  |
1383   //  |  shadow zone
1384   //  |
1385   //  --
1386   //  x    frame n
1387   //  --
1388   //  x    frame n-1
1389   //  x
1390   //  --
1391   //  ...
1392   //
1393   //  --
1394   //  x    frame 0
1395   //  --  <-- stack_base()
1396   //
1397   //  (large addresses)
1398   //
1399 
1400  private:
1401   // These values are derived from flags StackRedPages, StackYellowPages,
1402   // StackReservedPages and StackShadowPages. The zone size is determined
1403   // ergonomically if page_size > 4K.
1404   static size_t _stack_red_zone_size;
1405   static size_t _stack_yellow_zone_size;
1406   static size_t _stack_reserved_zone_size;
1407   static size_t _stack_shadow_zone_size;
1408  public:
1409   inline size_t stack_available(address cur_sp);
1410 
1411   static size_t stack_red_zone_size() {
1412     assert(_stack_red_zone_size > 0, "Don't call this before the field is initialized.");
1413     return _stack_red_zone_size;
1414   }
1415   static void set_stack_red_zone_size(size_t s) {
1416     assert(is_aligned(s, os::vm_page_size()),
1417            "We can not protect if the red zone size is not page aligned.");
1418     assert(_stack_red_zone_size == 0, "This should be called only once.");
1419     _stack_red_zone_size = s;
1420   }
1421   address stack_red_zone_base() {
1422     return (address)(stack_end() + stack_red_zone_size());
1423   }
1424   bool in_stack_red_zone(address a) {
1425     return a <= stack_red_zone_base() && a >= stack_end();
1426   }
1427 
1428   static size_t stack_yellow_zone_size() {
1429     assert(_stack_yellow_zone_size > 0, "Don't call this before the field is initialized.");
1430     return _stack_yellow_zone_size;
1431   }
1432   static void set_stack_yellow_zone_size(size_t s) {
1433     assert(is_aligned(s, os::vm_page_size()),
1434            "We can not protect if the yellow zone size is not page aligned.");
1435     assert(_stack_yellow_zone_size == 0, "This should be called only once.");
1436     _stack_yellow_zone_size = s;
1437   }
1438 
1439   static size_t stack_reserved_zone_size() {
1440     // _stack_reserved_zone_size may be 0. This indicates the feature is off.
1441     return _stack_reserved_zone_size;
1442   }
1443   static void set_stack_reserved_zone_size(size_t s) {
1444     assert(is_aligned(s, os::vm_page_size()),
1445            "We can not protect if the reserved zone size is not page aligned.");
1446     assert(_stack_reserved_zone_size == 0, "This should be called only once.");
1447     _stack_reserved_zone_size = s;
1448   }
1449   address stack_reserved_zone_base() {
1450     return (address)(stack_end() +
1451                      (stack_red_zone_size() + stack_yellow_zone_size() + stack_reserved_zone_size()));
1452   }
1453   bool in_stack_reserved_zone(address a) {
1454     return (a <= stack_reserved_zone_base()) &&
1455            (a >= (address)((intptr_t)stack_reserved_zone_base() - stack_reserved_zone_size()));
1456   }
1457 
1458   static size_t stack_yellow_reserved_zone_size() {
1459     return _stack_yellow_zone_size + _stack_reserved_zone_size;
1460   }
1461   bool in_stack_yellow_reserved_zone(address a) {
1462     return (a <= stack_reserved_zone_base()) && (a >= stack_red_zone_base());
1463   }
1464 
1465   // Size of red + yellow + reserved zones.
1466   static size_t stack_guard_zone_size() {
1467     return stack_red_zone_size() + stack_yellow_reserved_zone_size();
1468   }
1469 
1470   static size_t stack_shadow_zone_size() {
1471     assert(_stack_shadow_zone_size > 0, "Don't call this before the field is initialized.");
1472     return _stack_shadow_zone_size;
1473   }
1474   static void set_stack_shadow_zone_size(size_t s) {
1475     // The shadow area is not allocated or protected, so
1476     // it needs not be page aligned.
1477     // But the stack bang currently assumes that it is a
1478     // multiple of page size. This guarantees that the bang
1479     // loop touches all pages in the shadow zone.
1480     // This can be guaranteed differently, as well.  E.g., if
1481     // the page size is a multiple of 4K, banging in 4K steps
1482     // suffices to touch all pages. (Some pages are banged
1483     // several times, though.)
1484     assert(is_aligned(s, os::vm_page_size()),
1485            "Stack bang assumes multiple of page size.");
1486     assert(_stack_shadow_zone_size == 0, "This should be called only once.");
1487     _stack_shadow_zone_size = s;
1488   }
1489 
1490   void create_stack_guard_pages();
1491   void remove_stack_guard_pages();
1492 
1493   void enable_stack_reserved_zone();
1494   void disable_stack_reserved_zone();
1495   void enable_stack_yellow_reserved_zone();
1496   void disable_stack_yellow_reserved_zone();
1497   void enable_stack_red_zone();
1498   void disable_stack_red_zone();
1499 
1500   inline bool stack_guard_zone_unused();
1501   inline bool stack_yellow_reserved_zone_disabled();
1502   inline bool stack_reserved_zone_disabled();
1503   inline bool stack_guards_enabled();
1504 
1505   address reserved_stack_activation() const { return _reserved_stack_activation; }
1506   void set_reserved_stack_activation(address addr) {
1507     assert(_reserved_stack_activation == stack_base()
1508             || _reserved_stack_activation == NULL
1509             || addr == stack_base(), "Must not be set twice");
1510     _reserved_stack_activation = addr;
1511   }
1512 
1513   // Attempt to reguard the stack after a stack overflow may have occurred.
1514   // Returns true if (a) guard pages are not needed on this thread, (b) the
1515   // pages are already guarded, or (c) the pages were successfully reguarded.
1516   // Returns false if there is not enough stack space to reguard the pages, in
1517   // which case the caller should unwind a frame and try again.  The argument
1518   // should be the caller's (approximate) sp.
1519   bool reguard_stack(address cur_sp);
1520   // Similar to above but see if current stackpoint is out of the guard area
1521   // and reguard if possible.
1522   bool reguard_stack(void);
1523 
1524   address stack_overflow_limit() { return _stack_overflow_limit; }
1525   void set_stack_overflow_limit() {
1526     _stack_overflow_limit =
1527       stack_end() + MAX2(JavaThread::stack_guard_zone_size(), JavaThread::stack_shadow_zone_size());
1528   }
1529 
1530   // Misc. accessors/mutators
1531   void set_do_not_unlock(void)                   { _do_not_unlock_if_synchronized = true; }
1532   void clr_do_not_unlock(void)                   { _do_not_unlock_if_synchronized = false; }
1533   bool do_not_unlock(void)                       { return _do_not_unlock_if_synchronized; }
1534 
1535 #ifndef PRODUCT
1536   void record_jump(address target, address instr, const char* file, int line);
1537 #endif // PRODUCT
1538 
1539   // For assembly stub generation
1540   static ByteSize threadObj_offset()             { return byte_offset_of(JavaThread, _threadObj); }
1541 #ifndef PRODUCT
1542   static ByteSize jmp_ring_index_offset()        { return byte_offset_of(JavaThread, _jmp_ring_index); }
1543   static ByteSize jmp_ring_offset()              { return byte_offset_of(JavaThread, _jmp_ring); }
1544 #endif // PRODUCT
1545   static ByteSize jni_environment_offset()       { return byte_offset_of(JavaThread, _jni_environment); }
1546   static ByteSize pending_jni_exception_check_fn_offset() {
1547     return byte_offset_of(JavaThread, _pending_jni_exception_check_fn);
1548   }
1549   static ByteSize last_Java_sp_offset() {
1550     return byte_offset_of(JavaThread, _anchor) + JavaFrameAnchor::last_Java_sp_offset();
1551   }
1552   static ByteSize last_Java_pc_offset() {
1553     return byte_offset_of(JavaThread, _anchor) + JavaFrameAnchor::last_Java_pc_offset();
1554   }
1555   static ByteSize frame_anchor_offset() {
1556     return byte_offset_of(JavaThread, _anchor);
1557   }
1558   static ByteSize callee_target_offset()         { return byte_offset_of(JavaThread, _callee_target); }
1559   static ByteSize vm_result_offset()             { return byte_offset_of(JavaThread, _vm_result); }
1560   static ByteSize vm_result_2_offset()           { return byte_offset_of(JavaThread, _vm_result_2); }
1561   static ByteSize thread_state_offset()          { return byte_offset_of(JavaThread, _thread_state); }
1562   static ByteSize saved_exception_pc_offset()    { return byte_offset_of(JavaThread, _saved_exception_pc); }
1563   static ByteSize osthread_offset()              { return byte_offset_of(JavaThread, _osthread); }
1564 #if INCLUDE_JVMCI
1565   static ByteSize pending_deoptimization_offset() { return byte_offset_of(JavaThread, _pending_deoptimization); }
1566   static ByteSize pending_monitorenter_offset()  { return byte_offset_of(JavaThread, _pending_monitorenter); }
1567   static ByteSize pending_failed_speculation_offset() { return byte_offset_of(JavaThread, _pending_failed_speculation); }
1568   static ByteSize jvmci_alternate_call_target_offset() { return byte_offset_of(JavaThread, _jvmci._alternate_call_target); }
1569   static ByteSize jvmci_implicit_exception_pc_offset() { return byte_offset_of(JavaThread, _jvmci._implicit_exception_pc); }
1570   static ByteSize jvmci_counters_offset()        { return byte_offset_of(JavaThread, _jvmci_counters); }
1571 #endif // INCLUDE_JVMCI
1572   static ByteSize exception_oop_offset()         { return byte_offset_of(JavaThread, _exception_oop); }
1573   static ByteSize exception_pc_offset()          { return byte_offset_of(JavaThread, _exception_pc); }
1574   static ByteSize exception_handler_pc_offset()  { return byte_offset_of(JavaThread, _exception_handler_pc); }
1575   static ByteSize stack_overflow_limit_offset()  { return byte_offset_of(JavaThread, _stack_overflow_limit); }
1576   static ByteSize is_method_handle_return_offset() { return byte_offset_of(JavaThread, _is_method_handle_return); }
1577   static ByteSize stack_guard_state_offset()     { return byte_offset_of(JavaThread, _stack_guard_state); }
1578   static ByteSize reserved_stack_activation_offset() { return byte_offset_of(JavaThread, _reserved_stack_activation); }
1579   static ByteSize suspend_flags_offset()         { return byte_offset_of(JavaThread, _suspend_flags); }
1580 
1581   static ByteSize do_not_unlock_if_synchronized_offset() { return byte_offset_of(JavaThread, _do_not_unlock_if_synchronized); }
1582   static ByteSize should_post_on_exceptions_flag_offset() {
1583     return byte_offset_of(JavaThread, _should_post_on_exceptions_flag);
1584   }
1585 
1586 #if INCLUDE_ALL_GCS
1587   static ByteSize satb_mark_queue_offset()       { return byte_offset_of(JavaThread, _satb_mark_queue); }
1588   static ByteSize dirty_card_queue_offset()      { return byte_offset_of(JavaThread, _dirty_card_queue); }
1589 #endif // INCLUDE_ALL_GCS
1590 
1591   // Returns the jni environment for this thread
1592   JNIEnv* jni_environment()                      { return &_jni_environment; }
1593 
1594   static JavaThread* thread_from_jni_environment(JNIEnv* env) {
1595     JavaThread *thread_from_jni_env = (JavaThread*)((intptr_t)env - in_bytes(jni_environment_offset()));
1596     // Only return NULL if thread is off the thread list; starting to
1597     // exit should not return NULL.
1598     if (thread_from_jni_env->is_terminated()) {
1599       thread_from_jni_env->block_if_vm_exited();
1600       return NULL;
1601     } else {
1602       return thread_from_jni_env;
1603     }
1604   }
1605 
1606   // JNI critical regions. These can nest.
1607   bool in_critical()    { return _jni_active_critical > 0; }
1608   bool in_last_critical()  { return _jni_active_critical == 1; }
1609   void enter_critical() {
1610     assert(Thread::current() == this ||
1611            (Thread::current()->is_VM_thread() &&
1612            SafepointSynchronize::is_synchronizing()),
1613            "this must be current thread or synchronizing");
1614     _jni_active_critical++;
1615   }
1616   void exit_critical() {
1617     assert(Thread::current() == this, "this must be current thread");
1618     _jni_active_critical--;
1619     assert(_jni_active_critical >= 0, "JNI critical nesting problem?");
1620   }
1621 
1622   // Checked JNI: is the programmer required to check for exceptions, if so specify
1623   // which function name. Returning to a Java frame should implicitly clear the
1624   // pending check, this is done for Native->Java transitions (i.e. user JNI code).
1625   // VM->Java transistions are not cleared, it is expected that JNI code enclosed
1626   // within ThreadToNativeFromVM makes proper exception checks (i.e. VM internal).
1627   bool is_pending_jni_exception_check() const { return _pending_jni_exception_check_fn != NULL; }
1628   void clear_pending_jni_exception_check() { _pending_jni_exception_check_fn = NULL; }
1629   const char* get_pending_jni_exception_check() const { return _pending_jni_exception_check_fn; }
1630   void set_pending_jni_exception_check(const char* fn_name) { _pending_jni_exception_check_fn = (char*) fn_name; }
1631 
1632   // For deadlock detection
1633   int depth_first_number() { return _depth_first_number; }
1634   void set_depth_first_number(int dfn) { _depth_first_number = dfn; }
1635 
1636  private:
1637   void set_monitor_chunks(MonitorChunk* monitor_chunks) { _monitor_chunks = monitor_chunks; }
1638 
1639  public:
1640   MonitorChunk* monitor_chunks() const           { return _monitor_chunks; }
1641   void add_monitor_chunk(MonitorChunk* chunk);
1642   void remove_monitor_chunk(MonitorChunk* chunk);
1643   bool in_deopt_handler() const                  { return _in_deopt_handler > 0; }
1644   void inc_in_deopt_handler()                    { _in_deopt_handler++; }
1645   void dec_in_deopt_handler() {
1646     assert(_in_deopt_handler > 0, "mismatched deopt nesting");
1647     if (_in_deopt_handler > 0) { // robustness
1648       _in_deopt_handler--;
1649     }
1650   }
1651 
1652  private:
1653   void set_entry_point(ThreadFunction entry_point) { _entry_point = entry_point; }
1654 
1655  public:
1656 
1657   // Frame iteration; calls the function f for all frames on the stack
1658   void frames_do(void f(frame*, const RegisterMap*));
1659 
1660   // Memory operations
1661   void oops_do(OopClosure* f, CodeBlobClosure* cf);
1662 
1663   // Sweeper operations
1664   virtual void nmethods_do(CodeBlobClosure* cf);
1665 
1666   // RedefineClasses Support
1667   void metadata_do(void f(Metadata*));
1668 
1669   // Misc. operations
1670   char* name() const { return (char*)get_thread_name(); }
1671   void print_on(outputStream* st) const;
1672   void print_value();
1673   void print_thread_state_on(outputStream*) const      PRODUCT_RETURN;
1674   void print_thread_state() const                      PRODUCT_RETURN;
1675   void print_on_error(outputStream* st, char* buf, int buflen) const;
1676   void print_name_on_error(outputStream* st, char* buf, int buflen) const;
1677   void verify();
1678   const char* get_thread_name() const;
1679  private:
1680   // factor out low-level mechanics for use in both normal and error cases
1681   const char* get_thread_name_string(char* buf = NULL, int buflen = 0) const;
1682  public:
1683   const char* get_threadgroup_name() const;
1684   const char* get_parent_name() const;
1685 
1686   // Accessing frames
1687   frame last_frame() {
1688     _anchor.make_walkable(this);
1689     return pd_last_frame();
1690   }
1691   javaVFrame* last_java_vframe(RegisterMap* reg_map);
1692 
1693   // Returns method at 'depth' java or native frames down the stack
1694   // Used for security checks
1695   Klass* security_get_caller_class(int depth);
1696 
1697   // Print stack trace in external format
1698   void print_stack_on(outputStream* st);
1699   void print_stack() { print_stack_on(tty); }
1700 
1701   // Print stack traces in various internal formats
1702   void trace_stack()                             PRODUCT_RETURN;
1703   void trace_stack_from(vframe* start_vf)        PRODUCT_RETURN;
1704   void trace_frames()                            PRODUCT_RETURN;
1705   void trace_oops()                              PRODUCT_RETURN;
1706 
1707   // Print an annotated view of the stack frames
1708   void print_frame_layout(int depth = 0, bool validate_only = false) NOT_DEBUG_RETURN;
1709   void validate_frame_layout() {
1710     print_frame_layout(0, true);
1711   }
1712 
1713   // Returns the number of stack frames on the stack
1714   int depth() const;
1715 
1716   // Function for testing deoptimization
1717   void deoptimize();
1718   void make_zombies();
1719 
1720   void deoptimized_wrt_marked_nmethods();
1721 
1722   // Profiling operation (see fprofile.cpp)
1723  public:
1724   bool profile_last_Java_frame(frame* fr);
1725 
1726  private:
1727   ThreadProfiler* _thread_profiler;
1728  private:
1729   friend class FlatProfiler;                    // uses both [gs]et_thread_profiler.
1730   friend class FlatProfilerTask;                // uses get_thread_profiler.
1731   friend class ThreadProfilerMark;              // uses get_thread_profiler.
1732   ThreadProfiler* get_thread_profiler()         { return _thread_profiler; }
1733   ThreadProfiler* set_thread_profiler(ThreadProfiler* tp) {
1734     ThreadProfiler* result = _thread_profiler;
1735     _thread_profiler = tp;
1736     return result;
1737   }
1738 
1739  public:
1740   // Returns the running thread as a JavaThread
1741   static inline JavaThread* current();
1742 
1743   // Returns the active Java thread.  Do not use this if you know you are calling
1744   // from a JavaThread, as it's slower than JavaThread::current.  If called from
1745   // the VMThread, it also returns the JavaThread that instigated the VMThread's
1746   // operation.  You may not want that either.
1747   static JavaThread* active();
1748 
1749   inline CompilerThread* as_CompilerThread();
1750 
1751  public:
1752   virtual void run();
1753   void thread_main_inner();
1754 
1755  private:
1756   // PRIVILEGED STACK
1757   PrivilegedElement*  _privileged_stack_top;
1758   GrowableArray<oop>* _array_for_gc;
1759  public:
1760 
1761   // Returns the privileged_stack information.
1762   PrivilegedElement* privileged_stack_top() const       { return _privileged_stack_top; }
1763   void set_privileged_stack_top(PrivilegedElement *e)   { _privileged_stack_top = e; }
1764   void register_array_for_gc(GrowableArray<oop>* array) { _array_for_gc = array; }
1765 
1766  public:
1767   // Thread local information maintained by JVMTI.
1768   void set_jvmti_thread_state(JvmtiThreadState *value)                           { _jvmti_thread_state = value; }
1769   // A JvmtiThreadState is lazily allocated. This jvmti_thread_state()
1770   // getter is used to get this JavaThread's JvmtiThreadState if it has
1771   // one which means NULL can be returned. JvmtiThreadState::state_for()
1772   // is used to get the specified JavaThread's JvmtiThreadState if it has
1773   // one or it allocates a new JvmtiThreadState for the JavaThread and
1774   // returns it. JvmtiThreadState::state_for() will return NULL only if
1775   // the specified JavaThread is exiting.
1776   JvmtiThreadState *jvmti_thread_state() const                                   { return _jvmti_thread_state; }
1777   static ByteSize jvmti_thread_state_offset()                                    { return byte_offset_of(JavaThread, _jvmti_thread_state); }
1778   void set_jvmti_get_loaded_classes_closure(JvmtiGetLoadedClassesClosure* value) { _jvmti_get_loaded_classes_closure = value; }
1779   JvmtiGetLoadedClassesClosure* get_jvmti_get_loaded_classes_closure() const     { return _jvmti_get_loaded_classes_closure; }
1780 
1781   // JVMTI PopFrame support
1782   // Setting and clearing popframe_condition
1783   // All of these enumerated values are bits. popframe_pending
1784   // indicates that a PopFrame() has been requested and not yet been
1785   // completed. popframe_processing indicates that that PopFrame() is in
1786   // the process of being completed. popframe_force_deopt_reexecution_bit
1787   // indicates that special handling is required when returning to a
1788   // deoptimized caller.
1789   enum PopCondition {
1790     popframe_inactive                      = 0x00,
1791     popframe_pending_bit                   = 0x01,
1792     popframe_processing_bit                = 0x02,
1793     popframe_force_deopt_reexecution_bit   = 0x04
1794   };
1795   PopCondition popframe_condition()                   { return (PopCondition) _popframe_condition; }
1796   void set_popframe_condition(PopCondition c)         { _popframe_condition = c; }
1797   void set_popframe_condition_bit(PopCondition c)     { _popframe_condition |= c; }
1798   void clear_popframe_condition()                     { _popframe_condition = popframe_inactive; }
1799   static ByteSize popframe_condition_offset()         { return byte_offset_of(JavaThread, _popframe_condition); }
1800   bool has_pending_popframe()                         { return (popframe_condition() & popframe_pending_bit) != 0; }
1801   bool popframe_forcing_deopt_reexecution()           { return (popframe_condition() & popframe_force_deopt_reexecution_bit) != 0; }
1802   void clear_popframe_forcing_deopt_reexecution()     { _popframe_condition &= ~popframe_force_deopt_reexecution_bit; }
1803 #ifdef CC_INTERP
1804   bool pop_frame_pending(void)                        { return ((_popframe_condition & popframe_pending_bit) != 0); }
1805   void clr_pop_frame_pending(void)                    { _popframe_condition = popframe_inactive; }
1806   bool pop_frame_in_process(void)                     { return ((_popframe_condition & popframe_processing_bit) != 0); }
1807   void set_pop_frame_in_process(void)                 { _popframe_condition |= popframe_processing_bit; }
1808   void clr_pop_frame_in_process(void)                 { _popframe_condition &= ~popframe_processing_bit; }
1809 #endif
1810 
1811   int frames_to_pop_failed_realloc() const            { return _frames_to_pop_failed_realloc; }
1812   void set_frames_to_pop_failed_realloc(int nb)       { _frames_to_pop_failed_realloc = nb; }
1813   void dec_frames_to_pop_failed_realloc()             { _frames_to_pop_failed_realloc--; }
1814 
1815  private:
1816   // Saved incoming arguments to popped frame.
1817   // Used only when popped interpreted frame returns to deoptimized frame.
1818   void*    _popframe_preserved_args;
1819   int      _popframe_preserved_args_size;
1820 
1821  public:
1822   void  popframe_preserve_args(ByteSize size_in_bytes, void* start);
1823   void* popframe_preserved_args();
1824   ByteSize popframe_preserved_args_size();
1825   WordSize popframe_preserved_args_size_in_words();
1826   void  popframe_free_preserved_args();
1827 
1828 
1829  private:
1830   JvmtiThreadState *_jvmti_thread_state;
1831   JvmtiGetLoadedClassesClosure* _jvmti_get_loaded_classes_closure;
1832 
1833   // Used by the interpreter in fullspeed mode for frame pop, method
1834   // entry, method exit and single stepping support. This field is
1835   // only set to non-zero by the VM_EnterInterpOnlyMode VM operation.
1836   // It can be set to zero asynchronously (i.e., without a VM operation
1837   // or a lock) so we have to be very careful.
1838   int               _interp_only_mode;
1839 
1840  public:
1841   // used by the interpreter for fullspeed debugging support (see above)
1842   static ByteSize interp_only_mode_offset() { return byte_offset_of(JavaThread, _interp_only_mode); }
1843   bool is_interp_only_mode()                { return (_interp_only_mode != 0); }
1844   int get_interp_only_mode()                { return _interp_only_mode; }
1845   void increment_interp_only_mode()         { ++_interp_only_mode; }
1846   void decrement_interp_only_mode()         { --_interp_only_mode; }
1847 
1848   // support for cached flag that indicates whether exceptions need to be posted for this thread
1849   // if this is false, we can avoid deoptimizing when events are thrown
1850   // this gets set to reflect whether jvmtiExport::post_exception_throw would actually do anything
1851  private:
1852   int    _should_post_on_exceptions_flag;
1853 
1854  public:
1855   int   should_post_on_exceptions_flag()  { return _should_post_on_exceptions_flag; }
1856   void  set_should_post_on_exceptions_flag(int val)  { _should_post_on_exceptions_flag = val; }
1857 
1858  private:
1859   ThreadStatistics *_thread_stat;
1860 
1861  public:
1862   ThreadStatistics* get_thread_stat() const    { return _thread_stat; }
1863 
1864   // Return a blocker object for which this thread is blocked parking.
1865   oop current_park_blocker();
1866 
1867  private:
1868   static size_t _stack_size_at_create;
1869 
1870  public:
1871   static inline size_t stack_size_at_create(void) {
1872     return _stack_size_at_create;
1873   }
1874   static inline void set_stack_size_at_create(size_t value) {
1875     _stack_size_at_create = value;
1876   }
1877 
1878 #if INCLUDE_ALL_GCS
1879   // SATB marking queue support
1880   SATBMarkQueue& satb_mark_queue() { return _satb_mark_queue; }
1881   static SATBMarkQueueSet& satb_mark_queue_set() {
1882     return _satb_mark_queue_set;
1883   }
1884 
1885   // Dirty card queue support
1886   DirtyCardQueue& dirty_card_queue() { return _dirty_card_queue; }
1887   static DirtyCardQueueSet& dirty_card_queue_set() {
1888     return _dirty_card_queue_set;
1889   }
1890 #endif // INCLUDE_ALL_GCS
1891 
1892   // This method initializes the SATB and dirty card queues before a
1893   // JavaThread is added to the Java thread list. Right now, we don't
1894   // have to do anything to the dirty card queue (it should have been
1895   // activated when the thread was created), but we have to activate
1896   // the SATB queue if the thread is created while a marking cycle is
1897   // in progress. The activation / de-activation of the SATB queues at
1898   // the beginning / end of a marking cycle is done during safepoints
1899   // so we have to make sure this method is called outside one to be
1900   // able to safely read the active field of the SATB queue set. Right
1901   // now, it is called just before the thread is added to the Java
1902   // thread list in the Threads::add() method. That method is holding
1903   // the Threads_lock which ensures we are outside a safepoint. We
1904   // cannot do the obvious and set the active field of the SATB queue
1905   // when the thread is created given that, in some cases, safepoints
1906   // might happen between the JavaThread constructor being called and the
1907   // thread being added to the Java thread list (an example of this is
1908   // when the structure for the DestroyJavaVM thread is created).
1909 #if INCLUDE_ALL_GCS
1910   void initialize_queues();
1911 #else  // INCLUDE_ALL_GCS
1912   void initialize_queues() { }
1913 #endif // INCLUDE_ALL_GCS
1914 
1915   // Machine dependent stuff
1916 #include OS_CPU_HEADER(thread)
1917 
1918  public:
1919   void set_blocked_on_compilation(bool value) {
1920     _blocked_on_compilation = value;
1921   }
1922 
1923   bool blocked_on_compilation() {
1924     return _blocked_on_compilation;
1925   }
1926  protected:
1927   bool         _blocked_on_compilation;
1928 
1929 
1930   // JSR166 per-thread parker
1931  private:
1932   Parker*    _parker;
1933  public:
1934   Parker*     parker() { return _parker; }
1935 
1936   // Biased locking support
1937  private:
1938   GrowableArray<MonitorInfo*>* _cached_monitor_info;
1939  public:
1940   GrowableArray<MonitorInfo*>* cached_monitor_info() { return _cached_monitor_info; }
1941   void set_cached_monitor_info(GrowableArray<MonitorInfo*>* info) { _cached_monitor_info = info; }
1942 
1943   // clearing/querying jni attach status
1944   bool is_attaching_via_jni() const { return _jni_attach_state == _attaching_via_jni; }
1945   bool has_attached_via_jni() const { return is_attaching_via_jni() || _jni_attach_state == _attached_via_jni; }
1946   inline void set_done_attaching_via_jni();
1947 };
1948 
1949 // Inline implementation of JavaThread::current
1950 inline JavaThread* JavaThread::current() {
1951   Thread* thread = Thread::current();
1952   assert(thread->is_Java_thread(), "just checking");
1953   return (JavaThread*)thread;
1954 }
1955 
1956 inline CompilerThread* JavaThread::as_CompilerThread() {
1957   assert(is_Compiler_thread(), "just checking");
1958   return (CompilerThread*)this;
1959 }
1960 
1961 // Dedicated thread to sweep the code cache
1962 class CodeCacheSweeperThread : public JavaThread {
1963   CompiledMethod*       _scanned_compiled_method; // nmethod being scanned by the sweeper
1964  public:
1965   CodeCacheSweeperThread();
1966   // Track the nmethod currently being scanned by the sweeper
1967   void set_scanned_compiled_method(CompiledMethod* cm) {
1968     assert(_scanned_compiled_method == NULL || cm == NULL, "should reset to NULL before writing a new value");
1969     _scanned_compiled_method = cm;
1970   }
1971 
1972   // Hide sweeper thread from external view.
1973   bool is_hidden_from_external_view() const { return true; }
1974 
1975   bool is_Code_cache_sweeper_thread() const { return true; }
1976 
1977   // Prevent GC from unloading _scanned_compiled_method
1978   void oops_do(OopClosure* f, CodeBlobClosure* cf);
1979   void nmethods_do(CodeBlobClosure* cf);
1980 };
1981 
1982 // A thread used for Compilation.
1983 class CompilerThread : public JavaThread {
1984   friend class VMStructs;
1985  private:
1986   CompilerCounters* _counters;
1987 
1988   ciEnv*            _env;
1989   CompileLog*       _log;
1990   CompileTask*      _task;
1991   CompileQueue*     _queue;
1992   BufferBlob*       _buffer_blob;
1993 
1994   AbstractCompiler* _compiler;
1995 
1996  public:
1997 
1998   static CompilerThread* current();
1999 
2000   CompilerThread(CompileQueue* queue, CompilerCounters* counters);
2001 
2002   bool is_Compiler_thread() const                { return true; }
2003 
2004   virtual bool can_call_java() const;
2005 
2006   // Hide native compiler threads from external view.
2007   bool is_hidden_from_external_view() const      { return !can_call_java(); }
2008 
2009   void set_compiler(AbstractCompiler* c)         { _compiler = c; }
2010   AbstractCompiler* compiler() const             { return _compiler; }
2011 
2012   CompileQueue* queue()        const             { return _queue; }
2013   CompilerCounters* counters() const             { return _counters; }
2014 
2015   // Get/set the thread's compilation environment.
2016   ciEnv*        env()                            { return _env; }
2017   void          set_env(ciEnv* env)              { _env = env; }
2018 
2019   BufferBlob*   get_buffer_blob() const          { return _buffer_blob; }
2020   void          set_buffer_blob(BufferBlob* b)   { _buffer_blob = b; }
2021 
2022   // Get/set the thread's logging information
2023   CompileLog*   log()                            { return _log; }
2024   void          init_log(CompileLog* log) {
2025     // Set once, for good.
2026     assert(_log == NULL, "set only once");
2027     _log = log;
2028   }
2029 
2030 #ifndef PRODUCT
2031  private:
2032   IdealGraphPrinter *_ideal_graph_printer;
2033  public:
2034   IdealGraphPrinter *ideal_graph_printer()           { return _ideal_graph_printer; }
2035   void set_ideal_graph_printer(IdealGraphPrinter *n) { _ideal_graph_printer = n; }
2036 #endif
2037 
2038   // Get/set the thread's current task
2039   CompileTask* task()                      { return _task; }
2040   void         set_task(CompileTask* task) { _task = task; }
2041 };
2042 
2043 inline CompilerThread* CompilerThread::current() {
2044   return JavaThread::current()->as_CompilerThread();
2045 }
2046 
2047 // The active thread queue. It also keeps track of the current used
2048 // thread priorities.
2049 class Threads: AllStatic {
2050   friend class VMStructs;
2051  private:
2052   static JavaThread* _thread_list;
2053   static int         _number_of_threads;
2054   static int         _number_of_non_daemon_threads;
2055   static int         _return_code;
2056   static int         _thread_claim_parity;
2057 #ifdef ASSERT
2058   static bool        _vm_complete;
2059 #endif
2060 
2061   static void initialize_java_lang_classes(JavaThread* main_thread, TRAPS);
2062   static void initialize_jsr292_core_classes(TRAPS);
2063  public:
2064   // Thread management
2065   // force_daemon is a concession to JNI, where we may need to add a
2066   // thread to the thread list before allocating its thread object
2067   static void add(JavaThread* p, bool force_daemon = false);
2068   static void remove(JavaThread* p);
2069   static bool includes(JavaThread* p);
2070   static JavaThread* first()                     { return _thread_list; }
2071   static void threads_do(ThreadClosure* tc);
2072   static void parallel_java_threads_do(ThreadClosure* tc);
2073 
2074   // Initializes the vm and creates the vm thread
2075   static jint create_vm(JavaVMInitArgs* args, bool* canTryAgain);
2076   static void convert_vm_init_libraries_to_agents();
2077   static void create_vm_init_libraries();
2078   static void create_vm_init_agents();
2079   static void shutdown_vm_agents();
2080   static bool destroy_vm();
2081   // Supported VM versions via JNI
2082   // Includes JNI_VERSION_1_1
2083   static jboolean is_supported_jni_version_including_1_1(jint version);
2084   // Does not include JNI_VERSION_1_1
2085   static jboolean is_supported_jni_version(jint version);
2086 
2087   // The "thread claim parity" provides a way for threads to be claimed
2088   // by parallel worker tasks.
2089   //
2090   // Each thread contains a a "parity" field. A task will claim the
2091   // thread only if its parity field is the same as the global parity,
2092   // which is updated by calling change_thread_claim_parity().
2093   //
2094   // For this to work change_thread_claim_parity() needs to be called
2095   // exactly once in sequential code before starting parallel tasks
2096   // that should claim threads.
2097   //
2098   // New threads get their parity set to 0 and change_thread_claim_parity()
2099   // never set the global parity to 0.
2100   static int thread_claim_parity() { return _thread_claim_parity; }
2101   static void change_thread_claim_parity();
2102   static void assert_all_threads_claimed() NOT_DEBUG_RETURN;
2103 
2104   // Apply "f->do_oop" to all root oops in all threads.
2105   // This version may only be called by sequential code.
2106   static void oops_do(OopClosure* f, CodeBlobClosure* cf);
2107   // This version may be called by sequential or parallel code.
2108   static void possibly_parallel_oops_do(bool is_par, OopClosure* f, CodeBlobClosure* cf);
2109   // This creates a list of GCTasks, one per thread.
2110   static void create_thread_roots_tasks(GCTaskQueue* q);
2111   // This creates a list of GCTasks, one per thread, for marking objects.
2112   static void create_thread_roots_marking_tasks(GCTaskQueue* q);
2113 
2114   // Apply "f->do_oop" to roots in all threads that
2115   // are part of compiled frames
2116   static void compiled_frame_oops_do(OopClosure* f, CodeBlobClosure* cf);
2117 
2118   static void convert_hcode_pointers();
2119   static void restore_hcode_pointers();
2120 
2121   // Sweeper
2122   static void nmethods_do(CodeBlobClosure* cf);
2123 
2124   // RedefineClasses support
2125   static void metadata_do(void f(Metadata*));
2126   static void metadata_handles_do(void f(Metadata*));
2127 
2128 #ifdef ASSERT
2129   static bool is_vm_complete() { return _vm_complete; }
2130 #endif
2131 
2132   // Verification
2133   static void verify();
2134   static void print_on(outputStream* st, bool print_stacks, bool internal_format, bool print_concurrent_locks);
2135   static void print(bool print_stacks, bool internal_format) {
2136     // this function is only used by debug.cpp
2137     print_on(tty, print_stacks, internal_format, false /* no concurrent lock printed */);
2138   }
2139   static void print_on_error(outputStream* st, Thread* current, char* buf, int buflen);
2140   static void print_on_error(Thread* this_thread, outputStream* st, Thread* current, char* buf,
2141                              int buflen, bool* found_current);
2142   static void print_threads_compiling(outputStream* st, char* buf, int buflen);
2143 
2144   // Get Java threads that are waiting to enter a monitor. If doLock
2145   // is true, then Threads_lock is grabbed as needed. Otherwise, the
2146   // VM needs to be at a safepoint.
2147   static GrowableArray<JavaThread*>* get_pending_threads(int count,
2148                                                          address monitor, bool doLock);
2149 
2150   // Get owning Java thread from the monitor's owner field. If doLock
2151   // is true, then Threads_lock is grabbed as needed. Otherwise, the
2152   // VM needs to be at a safepoint.
2153   static JavaThread *owning_thread_from_monitor_owner(address owner,
2154                                                       bool doLock);
2155 
2156   // Number of threads on the active threads list
2157   static int number_of_threads()                 { return _number_of_threads; }
2158   // Number of non-daemon threads on the active threads list
2159   static int number_of_non_daemon_threads()      { return _number_of_non_daemon_threads; }
2160 
2161   // Deoptimizes all frames tied to marked nmethods
2162   static void deoptimized_wrt_marked_nmethods();
2163 
2164   static JavaThread* find_java_thread_from_java_tid(jlong java_tid);
2165 
2166 };
2167 
2168 
2169 // Thread iterator
2170 class ThreadClosure: public StackObj {
2171  public:
2172   virtual void do_thread(Thread* thread) = 0;
2173 };
2174 
2175 class SignalHandlerMark: public StackObj {
2176  private:
2177   Thread* _thread;
2178  public:
2179   SignalHandlerMark(Thread* t) {
2180     _thread = t;
2181     if (_thread) _thread->enter_signal_handler();
2182   }
2183   ~SignalHandlerMark() {
2184     if (_thread) _thread->leave_signal_handler();
2185     _thread = NULL;
2186   }
2187 };
2188 
2189 
2190 #endif // SHARE_VM_RUNTIME_THREAD_HPP