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