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