1 /*
   2  * Copyright (c) 2012, 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_INLINE_HPP
  26 #define SHARE_RUNTIME_THREAD_INLINE_HPP
  27 
  28 #include "runtime/atomic.hpp"
  29 #include "runtime/globals.hpp"
  30 #include "runtime/orderAccess.hpp"
  31 #include "runtime/os.inline.hpp"
  32 #include "runtime/safepoint.hpp"
  33 #include "runtime/thread.hpp"
  34 
  35 inline void Thread::set_suspend_flag(SuspendFlags f) {
  36   uint32_t flags;
  37   do {
  38     flags = _suspend_flags;
  39   }
  40   while (Atomic::cmpxchg(&_suspend_flags, flags, (flags | f)) != flags);
  41 }
  42 inline void Thread::clear_suspend_flag(SuspendFlags f) {
  43   uint32_t flags;
  44   do {
  45     flags = _suspend_flags;
  46   }
  47   while (Atomic::cmpxchg(&_suspend_flags, flags, (flags & ~f)) != flags);
  48 }
  49 
  50 inline void Thread::set_has_async_exception() {
  51   set_suspend_flag(_has_async_exception);
  52 }
  53 inline void Thread::clear_has_async_exception() {
  54   clear_suspend_flag(_has_async_exception);
  55 }
  56 inline void Thread::set_critical_native_unlock() {
  57   set_suspend_flag(_critical_native_unlock);
  58 }
  59 inline void Thread::clear_critical_native_unlock() {
  60   clear_suspend_flag(_critical_native_unlock);
  61 }
  62 inline void Thread::set_trace_flag() {
  63   set_suspend_flag(_trace_flag);
  64 }
  65 inline void Thread::clear_trace_flag() {
  66   clear_suspend_flag(_trace_flag);
  67 }
  68 inline void Thread::set_ea_obj_deopt_flag() {
  69   set_suspend_flag(_ea_obj_deopt);
  70 }
  71 inline void Thread::clear_ea_obj_deopt_flag() {
  72   clear_suspend_flag(_ea_obj_deopt);
  73 }
  74 
  75 inline jlong Thread::cooked_allocated_bytes() {
  76   jlong allocated_bytes = Atomic::load_acquire(&_allocated_bytes);
  77   if (UseTLAB) {
  78     size_t used_bytes = tlab().used_bytes();
  79     if (used_bytes <= ThreadLocalAllocBuffer::max_size_in_bytes()) {
  80       // Comparing used_bytes with the maximum allowed size will ensure
  81       // that we don't add the used bytes from a semi-initialized TLAB
  82       // ending up with incorrect values. There is still a race between
  83       // incrementing _allocated_bytes and clearing the TLAB, that might
  84       // cause double counting in rare cases.
  85       return allocated_bytes + used_bytes;
  86     }
  87   }
  88   return allocated_bytes;
  89 }
  90 
  91 inline ThreadsList* Thread::cmpxchg_threads_hazard_ptr(ThreadsList* exchange_value, ThreadsList* compare_value) {
  92   return (ThreadsList*)Atomic::cmpxchg(&_threads_hazard_ptr, compare_value, exchange_value);
  93 }
  94 
  95 inline ThreadsList* Thread::get_threads_hazard_ptr() {
  96   return (ThreadsList*)Atomic::load_acquire(&_threads_hazard_ptr);
  97 }
  98 
  99 inline void Thread::set_threads_hazard_ptr(ThreadsList* new_list) {
 100   Atomic::release_store_fence(&_threads_hazard_ptr, new_list);
 101 }
 102 
 103 inline void JavaThread::set_ext_suspended() {
 104   set_suspend_flag (_ext_suspended);
 105 }
 106 inline void JavaThread::clear_ext_suspended() {
 107   clear_suspend_flag(_ext_suspended);
 108 }
 109 
 110 inline void JavaThread::set_external_suspend() {
 111   set_suspend_flag(_external_suspend);
 112 }
 113 inline void JavaThread::clear_external_suspend() {
 114   clear_suspend_flag(_external_suspend);
 115 }
 116 
 117 inline void JavaThread::set_pending_async_exception(oop e) {
 118   _pending_async_exception = e;
 119   _special_runtime_exit_condition = _async_exception;
 120   set_has_async_exception();
 121 }
 122 
 123 inline JavaThreadState JavaThread::thread_state() const    {
 124 #if defined(PPC64) || defined (AARCH64)
 125   // Use membars when accessing volatile _thread_state. See
 126   // Threads::create_vm() for size checks.
 127   return (JavaThreadState) Atomic::load_acquire((volatile jint*)&_thread_state);
 128 #else
 129   return _thread_state;
 130 #endif
 131 }
 132 
 133 inline void JavaThread::set_thread_state(JavaThreadState s) {
 134   assert(current_or_null() == NULL || current_or_null() == this,
 135          "state change should only be called by the current thread");
 136 #if defined(PPC64) || defined (AARCH64)
 137   // Use membars when accessing volatile _thread_state. See
 138   // Threads::create_vm() for size checks.
 139   Atomic::release_store((volatile jint*)&_thread_state, (jint)s);
 140 #else
 141   _thread_state = s;
 142 #endif
 143 }
 144 
 145 inline void JavaThread::set_thread_state_fence(JavaThreadState s) {
 146   set_thread_state(s);
 147   OrderAccess::fence();
 148 }
 149 
 150 ThreadSafepointState* JavaThread::safepoint_state() const  {
 151   return _safepoint_state;
 152 }
 153 
 154 void JavaThread::set_safepoint_state(ThreadSafepointState *state) {
 155   _safepoint_state = state;
 156 }
 157 
 158 bool JavaThread::is_at_poll_safepoint() {
 159   return _safepoint_state->is_at_poll_safepoint();
 160 }
 161 
 162 void JavaThread::enter_critical() {
 163   assert(Thread::current() == this ||
 164          (Thread::current()->is_VM_thread() &&
 165          SafepointSynchronize::is_synchronizing()),
 166          "this must be current thread or synchronizing");
 167   _jni_active_critical++;
 168 }
 169 
 170 inline void JavaThread::set_done_attaching_via_jni() {
 171   _jni_attach_state = _attached_via_jni;
 172   OrderAccess::fence();
 173 }
 174 
 175 inline bool JavaThread::stack_guard_zone_unused() {
 176   return _stack_guard_state == stack_guard_unused;
 177 }
 178 
 179 inline bool JavaThread::stack_yellow_reserved_zone_disabled() {
 180   return _stack_guard_state == stack_guard_yellow_reserved_disabled;
 181 }
 182 
 183 inline bool JavaThread::stack_reserved_zone_disabled() {
 184   return _stack_guard_state == stack_guard_reserved_disabled;
 185 }
 186 
 187 inline size_t JavaThread::stack_available(address cur_sp) {
 188   // This code assumes java stacks grow down
 189   address low_addr; // Limit on the address for deepest stack depth
 190   if (_stack_guard_state == stack_guard_unused) {
 191     low_addr = stack_end();
 192   } else {
 193     low_addr = stack_reserved_zone_base();
 194   }
 195   return cur_sp > low_addr ? cur_sp - low_addr : 0;
 196 }
 197 
 198 inline bool JavaThread::stack_guards_enabled() {
 199 #ifdef ASSERT
 200   if (os::uses_stack_guard_pages() &&
 201       !(DisablePrimordialThreadGuardPages && os::is_primordial_thread())) {
 202     assert(_stack_guard_state != stack_guard_unused, "guard pages must be in use");
 203   }
 204 #endif
 205   return _stack_guard_state == stack_guard_enabled;
 206 }
 207 
 208 // The release make sure this store is done after storing the handshake
 209 // operation or global state
 210 inline void JavaThread::set_polling_page_release(void* poll_value) {
 211   Atomic::release_store(polling_page_addr(), poll_value);
 212 }
 213 
 214 // Caller is responsible for using a memory barrier if needed.
 215 inline void JavaThread::set_polling_page(void* poll_value) {
 216   *polling_page_addr() = poll_value;
 217 }
 218 
 219 // The aqcquire make sure reading of polling page is done before
 220 // the reading the handshake operation or the global state
 221 inline volatile void* JavaThread::get_polling_page() {
 222   return Atomic::load_acquire(polling_page_addr());
 223 }
 224 
 225 inline bool JavaThread::is_exiting() const {
 226   // Use load-acquire so that setting of _terminated by
 227   // JavaThread::exit() is seen more quickly.
 228   TerminatedTypes l_terminated = (TerminatedTypes)
 229       Atomic::load_acquire((volatile jint *) &_terminated);
 230   return l_terminated == _thread_exiting || check_is_terminated(l_terminated);
 231 }
 232 
 233 inline bool JavaThread::is_terminated() const {
 234   // Use load-acquire so that setting of _terminated by
 235   // JavaThread::exit() is seen more quickly.
 236   TerminatedTypes l_terminated = (TerminatedTypes)
 237       Atomic::load_acquire((volatile jint *) &_terminated);
 238   return check_is_terminated(l_terminated);
 239 }
 240 
 241 inline void JavaThread::set_terminated(TerminatedTypes t) {
 242   // use release-store so the setting of _terminated is seen more quickly
 243   Atomic::release_store((volatile jint *) &_terminated, (jint) t);
 244 }
 245 
 246 // special for Threads::remove() which is static:
 247 inline void JavaThread::set_terminated_value() {
 248   // use release-store so the setting of _terminated is seen more quickly
 249   Atomic::release_store((volatile jint *) &_terminated, (jint) _thread_terminated);
 250 }
 251 
 252 // Allow tracking of class initialization monitor use
 253 inline void JavaThread::set_class_to_be_initialized(InstanceKlass* k) {
 254   assert((k == NULL && _class_to_be_initialized != NULL) ||
 255          (k != NULL && _class_to_be_initialized == NULL), "incorrect usage");
 256   assert(this == Thread::current(), "Only the current thread can set this field");
 257   _class_to_be_initialized = k;
 258 }
 259 
 260 inline InstanceKlass* JavaThread::class_to_be_initialized() const {
 261   return _class_to_be_initialized;
 262 }
 263 
 264 #endif // SHARE_RUNTIME_THREAD_INLINE_HPP