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