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