annotate src/share/vm/runtime/osThread.hpp @ 0:a61af66fc99e jdk7-b24

Initial load
author duke
date Sat, 01 Dec 2007 00:00:00 +0000
parents
children c18cbe5936b8
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
a61af66fc99e Initial load
duke
parents:
diff changeset
1 /*
a61af66fc99e Initial load
duke
parents:
diff changeset
2 * Copyright 1997-2005 Sun Microsystems, Inc. All Rights Reserved.
a61af66fc99e Initial load
duke
parents:
diff changeset
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
a61af66fc99e Initial load
duke
parents:
diff changeset
4 *
a61af66fc99e Initial load
duke
parents:
diff changeset
5 * This code is free software; you can redistribute it and/or modify it
a61af66fc99e Initial load
duke
parents:
diff changeset
6 * under the terms of the GNU General Public License version 2 only, as
a61af66fc99e Initial load
duke
parents:
diff changeset
7 * published by the Free Software Foundation.
a61af66fc99e Initial load
duke
parents:
diff changeset
8 *
a61af66fc99e Initial load
duke
parents:
diff changeset
9 * This code is distributed in the hope that it will be useful, but WITHOUT
a61af66fc99e Initial load
duke
parents:
diff changeset
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
a61af66fc99e Initial load
duke
parents:
diff changeset
11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
a61af66fc99e Initial load
duke
parents:
diff changeset
12 * version 2 for more details (a copy is included in the LICENSE file that
a61af66fc99e Initial load
duke
parents:
diff changeset
13 * accompanied this code).
a61af66fc99e Initial load
duke
parents:
diff changeset
14 *
a61af66fc99e Initial load
duke
parents:
diff changeset
15 * You should have received a copy of the GNU General Public License version
a61af66fc99e Initial load
duke
parents:
diff changeset
16 * 2 along with this work; if not, write to the Free Software Foundation,
a61af66fc99e Initial load
duke
parents:
diff changeset
17 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
a61af66fc99e Initial load
duke
parents:
diff changeset
18 *
a61af66fc99e Initial load
duke
parents:
diff changeset
19 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
a61af66fc99e Initial load
duke
parents:
diff changeset
20 * CA 95054 USA or visit www.sun.com if you need additional information or
a61af66fc99e Initial load
duke
parents:
diff changeset
21 * have any questions.
a61af66fc99e Initial load
duke
parents:
diff changeset
22 *
a61af66fc99e Initial load
duke
parents:
diff changeset
23 */
a61af66fc99e Initial load
duke
parents:
diff changeset
24
a61af66fc99e Initial load
duke
parents:
diff changeset
25 // The OSThread class holds OS-specific thread information. It is equivalent
a61af66fc99e Initial load
duke
parents:
diff changeset
26 // to the sys_thread_t structure of the classic JVM implementation.
a61af66fc99e Initial load
duke
parents:
diff changeset
27
a61af66fc99e Initial load
duke
parents:
diff changeset
28 // The thread states represented by the ThreadState values are platform-specific
a61af66fc99e Initial load
duke
parents:
diff changeset
29 // and are likely to be only approximate, because most OSes don't give you access
a61af66fc99e Initial load
duke
parents:
diff changeset
30 // to precise thread state information.
a61af66fc99e Initial load
duke
parents:
diff changeset
31
a61af66fc99e Initial load
duke
parents:
diff changeset
32 // Note: the ThreadState is legacy code and is not correctly implemented.
a61af66fc99e Initial load
duke
parents:
diff changeset
33 // Uses of ThreadState need to be replaced by the state in the JavaThread.
a61af66fc99e Initial load
duke
parents:
diff changeset
34
a61af66fc99e Initial load
duke
parents:
diff changeset
35 enum ThreadState {
a61af66fc99e Initial load
duke
parents:
diff changeset
36 ALLOCATED, // Memory has been allocated but not initialized
a61af66fc99e Initial load
duke
parents:
diff changeset
37 INITIALIZED, // The thread has been initialized but yet started
a61af66fc99e Initial load
duke
parents:
diff changeset
38 RUNNABLE, // Has been started and is runnable, but not necessarily running
a61af66fc99e Initial load
duke
parents:
diff changeset
39 MONITOR_WAIT, // Waiting on a contended monitor lock
a61af66fc99e Initial load
duke
parents:
diff changeset
40 CONDVAR_WAIT, // Waiting on a condition variable
a61af66fc99e Initial load
duke
parents:
diff changeset
41 OBJECT_WAIT, // Waiting on an Object.wait() call
a61af66fc99e Initial load
duke
parents:
diff changeset
42 BREAKPOINTED, // Suspended at breakpoint
a61af66fc99e Initial load
duke
parents:
diff changeset
43 SLEEPING, // Thread.sleep()
a61af66fc99e Initial load
duke
parents:
diff changeset
44 ZOMBIE // All done, but not reclaimed yet
a61af66fc99e Initial load
duke
parents:
diff changeset
45 };
a61af66fc99e Initial load
duke
parents:
diff changeset
46
a61af66fc99e Initial load
duke
parents:
diff changeset
47 // I'd make OSThread a ValueObj embedded in Thread to avoid an indirection, but
a61af66fc99e Initial load
duke
parents:
diff changeset
48 // the assembler test in java.cpp expects that it can install the OSThread of
a61af66fc99e Initial load
duke
parents:
diff changeset
49 // the main thread into its own Thread at will.
a61af66fc99e Initial load
duke
parents:
diff changeset
50
a61af66fc99e Initial load
duke
parents:
diff changeset
51
a61af66fc99e Initial load
duke
parents:
diff changeset
52 class OSThread: public CHeapObj {
a61af66fc99e Initial load
duke
parents:
diff changeset
53 friend class VMStructs;
a61af66fc99e Initial load
duke
parents:
diff changeset
54 private:
a61af66fc99e Initial load
duke
parents:
diff changeset
55 //void* _start_proc; // Thread start routine
a61af66fc99e Initial load
duke
parents:
diff changeset
56 OSThreadStartFunc _start_proc; // Thread start routine
a61af66fc99e Initial load
duke
parents:
diff changeset
57 void* _start_parm; // Thread start routine parameter
a61af66fc99e Initial load
duke
parents:
diff changeset
58 volatile ThreadState _state; // Thread state *hint*
a61af66fc99e Initial load
duke
parents:
diff changeset
59 jint _interrupted; // Thread.isInterrupted state
a61af66fc99e Initial load
duke
parents:
diff changeset
60
a61af66fc99e Initial load
duke
parents:
diff changeset
61 // Note: _interrupted must be jint, so that Java intrinsics can access it.
a61af66fc99e Initial load
duke
parents:
diff changeset
62 // The value stored there must be either 0 or 1. It must be possible
a61af66fc99e Initial load
duke
parents:
diff changeset
63 // for Java to emulate Thread.currentThread().isInterrupted() by performing
a61af66fc99e Initial load
duke
parents:
diff changeset
64 // the double indirection Thread::current()->_osthread->_interrupted.
a61af66fc99e Initial load
duke
parents:
diff changeset
65
a61af66fc99e Initial load
duke
parents:
diff changeset
66 // Methods
a61af66fc99e Initial load
duke
parents:
diff changeset
67 public:
a61af66fc99e Initial load
duke
parents:
diff changeset
68 void set_state(ThreadState state) { _state = state; }
a61af66fc99e Initial load
duke
parents:
diff changeset
69 ThreadState get_state() { return _state; }
a61af66fc99e Initial load
duke
parents:
diff changeset
70
a61af66fc99e Initial load
duke
parents:
diff changeset
71 // Constructor
a61af66fc99e Initial load
duke
parents:
diff changeset
72 OSThread(OSThreadStartFunc start_proc, void* start_parm);
a61af66fc99e Initial load
duke
parents:
diff changeset
73
a61af66fc99e Initial load
duke
parents:
diff changeset
74 // Destructor
a61af66fc99e Initial load
duke
parents:
diff changeset
75 ~OSThread();
a61af66fc99e Initial load
duke
parents:
diff changeset
76
a61af66fc99e Initial load
duke
parents:
diff changeset
77 // Accessors
a61af66fc99e Initial load
duke
parents:
diff changeset
78 OSThreadStartFunc start_proc() const { return _start_proc; }
a61af66fc99e Initial load
duke
parents:
diff changeset
79 void set_start_proc(OSThreadStartFunc start_proc) { _start_proc = start_proc; }
a61af66fc99e Initial load
duke
parents:
diff changeset
80 void* start_parm() const { return _start_parm; }
a61af66fc99e Initial load
duke
parents:
diff changeset
81 void set_start_parm(void* start_parm) { _start_parm = start_parm; }
a61af66fc99e Initial load
duke
parents:
diff changeset
82
a61af66fc99e Initial load
duke
parents:
diff changeset
83 bool interrupted() const { return _interrupted != 0; }
a61af66fc99e Initial load
duke
parents:
diff changeset
84 void set_interrupted(bool z) { _interrupted = z ? 1 : 0; }
a61af66fc99e Initial load
duke
parents:
diff changeset
85
a61af66fc99e Initial load
duke
parents:
diff changeset
86 // Printing
a61af66fc99e Initial load
duke
parents:
diff changeset
87 void print_on(outputStream* st) const;
a61af66fc99e Initial load
duke
parents:
diff changeset
88 void print() const { print_on(tty); }
a61af66fc99e Initial load
duke
parents:
diff changeset
89
a61af66fc99e Initial load
duke
parents:
diff changeset
90 // For java intrinsics:
a61af66fc99e Initial load
duke
parents:
diff changeset
91 static ByteSize interrupted_offset() { return byte_offset_of(OSThread, _interrupted); }
a61af66fc99e Initial load
duke
parents:
diff changeset
92
a61af66fc99e Initial load
duke
parents:
diff changeset
93 // Platform dependent stuff
a61af66fc99e Initial load
duke
parents:
diff changeset
94 #include "incls/_osThread_pd.hpp.incl"
a61af66fc99e Initial load
duke
parents:
diff changeset
95 };
a61af66fc99e Initial load
duke
parents:
diff changeset
96
a61af66fc99e Initial load
duke
parents:
diff changeset
97
a61af66fc99e Initial load
duke
parents:
diff changeset
98 // Utility class for use with condition variables:
a61af66fc99e Initial load
duke
parents:
diff changeset
99 class OSThreadWaitState : public StackObj {
a61af66fc99e Initial load
duke
parents:
diff changeset
100 OSThread* _osthread;
a61af66fc99e Initial load
duke
parents:
diff changeset
101 ThreadState _old_state;
a61af66fc99e Initial load
duke
parents:
diff changeset
102 public:
a61af66fc99e Initial load
duke
parents:
diff changeset
103 OSThreadWaitState(OSThread* osthread, bool is_object_wait) {
a61af66fc99e Initial load
duke
parents:
diff changeset
104 _osthread = osthread;
a61af66fc99e Initial load
duke
parents:
diff changeset
105 _old_state = osthread->get_state();
a61af66fc99e Initial load
duke
parents:
diff changeset
106 if (is_object_wait) {
a61af66fc99e Initial load
duke
parents:
diff changeset
107 osthread->set_state(OBJECT_WAIT);
a61af66fc99e Initial load
duke
parents:
diff changeset
108 } else {
a61af66fc99e Initial load
duke
parents:
diff changeset
109 osthread->set_state(CONDVAR_WAIT);
a61af66fc99e Initial load
duke
parents:
diff changeset
110 }
a61af66fc99e Initial load
duke
parents:
diff changeset
111 }
a61af66fc99e Initial load
duke
parents:
diff changeset
112 ~OSThreadWaitState() {
a61af66fc99e Initial load
duke
parents:
diff changeset
113 _osthread->set_state(_old_state);
a61af66fc99e Initial load
duke
parents:
diff changeset
114 }
a61af66fc99e Initial load
duke
parents:
diff changeset
115 };
a61af66fc99e Initial load
duke
parents:
diff changeset
116
a61af66fc99e Initial load
duke
parents:
diff changeset
117
a61af66fc99e Initial load
duke
parents:
diff changeset
118 // Utility class for use with contended monitors:
a61af66fc99e Initial load
duke
parents:
diff changeset
119 class OSThreadContendState : public StackObj {
a61af66fc99e Initial load
duke
parents:
diff changeset
120 OSThread* _osthread;
a61af66fc99e Initial load
duke
parents:
diff changeset
121 ThreadState _old_state;
a61af66fc99e Initial load
duke
parents:
diff changeset
122 public:
a61af66fc99e Initial load
duke
parents:
diff changeset
123 OSThreadContendState(OSThread* osthread) {
a61af66fc99e Initial load
duke
parents:
diff changeset
124 _osthread = osthread;
a61af66fc99e Initial load
duke
parents:
diff changeset
125 _old_state = osthread->get_state();
a61af66fc99e Initial load
duke
parents:
diff changeset
126 osthread->set_state(MONITOR_WAIT);
a61af66fc99e Initial load
duke
parents:
diff changeset
127 }
a61af66fc99e Initial load
duke
parents:
diff changeset
128 ~OSThreadContendState() {
a61af66fc99e Initial load
duke
parents:
diff changeset
129 _osthread->set_state(_old_state);
a61af66fc99e Initial load
duke
parents:
diff changeset
130 }
a61af66fc99e Initial load
duke
parents:
diff changeset
131 };