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