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