1 /* 2 * Copyright (c) 1997, 2016, Oracle and/or its affiliates. All rights reserved. 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4 * 5 * This code is free software; you can redistribute it and/or modify it 6 * under the terms of the GNU General Public License version 2 only, as 7 * published by the Free Software Foundation. 8 * 9 * This code is distributed in the hope that it will be useful, but WITHOUT 10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 12 * version 2 for more details (a copy is included in the LICENSE file that 13 * accompanied this code). 14 * 15 * You should have received a copy of the GNU General Public License version 16 * 2 along with this work; if not, write to the Free Software Foundation, 17 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. 18 * 19 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA 20 * or visit www.oracle.com if you need additional information or have any 21 * questions. 22 * 23 */ 24 25 #ifndef SHARE_VM_RUNTIME_OSTHREAD_HPP 26 #define SHARE_VM_RUNTIME_OSTHREAD_HPP 27 28 #include "runtime/frame.hpp" 29 #include "runtime/handles.hpp" 30 #include "runtime/javaFrameAnchor.hpp" 31 #include "runtime/objectMonitor.hpp" 32 #include "utilities/macros.hpp" 33 34 // The OSThread class holds OS-specific thread information. It is equivalent 35 // to the sys_thread_t structure of the classic JVM implementation. 36 37 // The thread states represented by the ThreadState values are platform-specific 38 // and are likely to be only approximate, because most OSes don't give you access 39 // to precise thread state information. 40 41 // Note: the ThreadState is legacy code and is not correctly implemented. 42 // Uses of ThreadState need to be replaced by the state in the JavaThread. 43 44 enum ThreadState { 45 ALLOCATED, // Memory has been allocated but not initialized 46 INITIALIZED, // The thread has been initialized but yet started 47 RUNNABLE, // Has been started and is runnable, but not necessarily running 48 MONITOR_WAIT, // Waiting on a contended monitor lock 49 CONDVAR_WAIT, // Waiting on a condition variable 50 OBJECT_WAIT, // Waiting on an Object.wait() call 51 BREAKPOINTED, // Suspended at breakpoint 52 SLEEPING, // Thread.sleep() 53 ZOMBIE // All done, but not reclaimed yet 54 }; 55 56 class OSThread: public CHeapObj<mtThread> { 57 friend class VMStructs; 58 friend class JVMCIVMStructs; 59 private: 60 OSThreadStartFunc _start_proc; // Thread start routine 61 void* _start_parm; // Thread start routine parameter 62 volatile ThreadState _state; // Thread state *hint* 63 volatile jint _interrupted; // Thread.isInterrupted state 64 65 // Note: _interrupted must be jint, so that Java intrinsics can access it. 66 // The value stored there must be either 0 or 1. It must be possible 67 // for Java to emulate Thread.currentThread().isInterrupted() by performing 68 // the double indirection Thread::current()->_osthread->_interrupted. 69 70 // Methods 71 public: 72 void set_state(ThreadState state) { _state = state; } 73 ThreadState get_state() { return _state; } 74 75 OSThread(OSThreadStartFunc start_proc, void* start_parm); 76 ~OSThread(); 77 78 // Accessors 79 OSThreadStartFunc start_proc() const { return _start_proc; } 80 void set_start_proc(OSThreadStartFunc start_proc) { _start_proc = start_proc; } 81 void* start_parm() const { return _start_parm; } 82 void set_start_parm(void* start_parm) { _start_parm = start_parm; } 83 84 volatile bool interrupted() const { return _interrupted != 0; } 85 void set_interrupted(bool z) { _interrupted = z ? 1 : 0; } 86 87 // Printing 88 void print_on(outputStream* st) const; 89 void print() const { print_on(tty); } 90 91 // For java intrinsics: 92 static ByteSize interrupted_offset() { return byte_offset_of(OSThread, _interrupted); } 93 94 // Platform dependent stuff 95 #include OS_HEADER(osThread) 96 97 public: 98 static ByteSize thread_id_offset() { return byte_offset_of(OSThread, _thread_id); } 99 static size_t thread_id_size() { return sizeof(thread_id_t); } 100 101 thread_id_t thread_id() const { return _thread_id; } 102 103 void set_thread_id(thread_id_t id) { _thread_id = id; } 104 105 private: 106 // _thread_id is kernel thread id (similar to LWP id on Solaris). Each 107 // thread has a unique thread_id (BsdThreads or NPTL). It can be used 108 // to access /proc. 109 thread_id_t _thread_id; 110 }; 111 112 113 // Utility class for use with condition variables: 114 class OSThreadWaitState : public StackObj { 115 OSThread* _osthread; 116 ThreadState _old_state; 117 public: 118 OSThreadWaitState(OSThread* osthread, bool is_object_wait) { 119 _osthread = osthread; 120 _old_state = osthread->get_state(); 121 if (is_object_wait) { 122 osthread->set_state(OBJECT_WAIT); 123 } else { 124 osthread->set_state(CONDVAR_WAIT); 125 } 126 } 127 ~OSThreadWaitState() { 128 _osthread->set_state(_old_state); 129 } 130 }; 131 132 133 // Utility class for use with contended monitors: 134 class OSThreadContendState : public StackObj { 135 OSThread* _osthread; 136 ThreadState _old_state; 137 public: 138 OSThreadContendState(OSThread* osthread) { 139 _osthread = osthread; 140 _old_state = osthread->get_state(); 141 osthread->set_state(MONITOR_WAIT); 142 } 143 ~OSThreadContendState() { 144 _osthread->set_state(_old_state); 145 } 146 }; 147 148 #endif // SHARE_VM_RUNTIME_OSTHREAD_HPP