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