blob: 190cc70f7e617578def5442988e070e93d2e168b [file] [log] [blame]
Elliott Hughes8d768a92011-09-14 16:35:25 -07001/*
2 * Copyright (C) 2011 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
Carl Shapiro0e5d75d2011-07-06 18:28:37 -070016
17#ifndef ART_SRC_THREAD_H_
18#define ART_SRC_THREAD_H_
19
Carl Shapirob5573532011-07-12 18:22:59 -070020#include <pthread.h>
Elliott Hughesa0957642011-09-02 14:27:33 -070021
Elliott Hughes02b48d12011-09-07 17:15:51 -070022#include <bitset>
Elliott Hughesa0957642011-09-02 14:27:33 -070023#include <iosfwd>
Ian Rogersb033c752011-07-20 12:22:35 -070024#include <list>
Elliott Hughes8daa0922011-09-11 13:46:25 -070025#include <string>
jeffhaoe343b762011-12-05 16:36:44 -080026#include <vector>
Carl Shapirob5573532011-07-12 18:22:59 -070027
Brian Carlstrom1f870082011-08-23 16:02:11 -070028#include "dex_file.h"
Brian Carlstrom578bbdc2011-07-21 14:07:47 -070029#include "globals.h"
Elliott Hughes69f5bc62011-08-24 09:26:14 -070030#include "jni_internal.h"
Brian Carlstrom578bbdc2011-07-21 14:07:47 -070031#include "logging.h"
32#include "macros.h"
Elliott Hughes8daa0922011-09-11 13:46:25 -070033#include "mutex.h"
Brian Carlstromb765be02011-08-17 23:54:10 -070034#include "mem_map.h"
Brian Carlstrom578bbdc2011-07-21 14:07:47 -070035#include "offsets.h"
Elliott Hughes9d5ccec2011-09-19 13:19:50 -070036#include "runtime_stats.h"
Elliott Hughes68e76522011-10-05 13:22:16 -070037#include "stack.h"
jeffhaoe343b762011-12-05 16:36:44 -080038#include "trace.h"
Ian Rogersbdb03912011-09-14 00:55:44 -070039#include "UniquePtr.h"
Ian Rogersb033c752011-07-20 12:22:35 -070040
Carl Shapiro0e5d75d2011-07-06 18:28:37 -070041namespace art {
42
Elliott Hughes69f5bc62011-08-24 09:26:14 -070043class Array;
Elliott Hughes37f7a402011-08-22 18:56:01 -070044class Class;
Brian Carlstrom1f870082011-08-23 16:02:11 -070045class ClassLinker;
Elliott Hughesedcc09c2011-08-21 18:47:05 -070046class ClassLoader;
Ian Rogersbdb03912011-09-14 00:55:44 -070047class Context;
Elliott Hughes475fc232011-10-25 15:00:35 -070048class DebugInvokeReq;
Brian Carlstroma40f9bc2011-07-26 21:26:07 -070049class Method;
Elliott Hughes8daa0922011-09-11 13:46:25 -070050class Monitor;
Carl Shapiro0e5d75d2011-07-06 18:28:37 -070051class Object;
Carl Shapirob5573532011-07-12 18:22:59 -070052class Runtime;
Logan Chien4455f862012-03-15 03:10:03 +080053class ShadowFrame;
Elliott Hughes68e76522011-10-05 13:22:16 -070054class StackIndirectReferenceTable;
Shih-wei Liao55df06b2011-08-26 14:39:27 -070055class StackTraceElement;
buzbee1da522d2011-09-04 11:22:20 -070056class StaticStorageBase;
Brian Carlstrom40381fb2011-10-19 14:13:40 -070057class Thread;
58class ThreadList;
59class Throwable;
buzbee1da522d2011-09-04 11:22:20 -070060
Shih-wei Liao55df06b2011-08-26 14:39:27 -070061template<class T> class ObjectArray;
Shih-wei Liao44175362011-08-28 16:59:17 -070062template<class T> class PrimitiveArray;
63typedef PrimitiveArray<int32_t> IntArray;
Carl Shapiro0e5d75d2011-07-06 18:28:37 -070064
Elliott Hughes85d15452011-09-16 17:33:01 -070065class PACKED Thread {
Carl Shapiro0e5d75d2011-07-06 18:28:37 -070066 public:
Elliott Hughes8daa0922011-09-11 13:46:25 -070067 /* thread priorities, from java.lang.Thread */
68 enum Priority {
69 kMinPriority = 1,
70 kNormPriority = 5,
71 kMaxPriority = 10,
72 };
Carl Shapirob5573532011-07-12 18:22:59 -070073 enum State {
Elliott Hughes499c5132011-11-17 14:55:11 -080074 // These correspond to JDWP states (but needn't share the same values).
75 kTerminated = 0, // TS_ZOMBIE
76 kRunnable = 1, // TS_RUNNING
Elliott Hughes3ce4b262012-02-24 11:24:02 -080077 kTimedWaiting = 2, // TS_WAIT in Object.wait() with a timeout
Elliott Hughes499c5132011-11-17 14:55:11 -080078 kBlocked = 3, // TS_MONITOR on a monitor
79 kWaiting = 4, // TS_WAIT in Object.wait()
Elliott Hughes93e74e82011-09-13 11:07:03 -070080 // Non-JDWP states.
81 kInitializing = 5, // allocated, not yet running --- TODO: unnecessary?
82 kStarting = 6, // native thread started, not yet ready to run managed code
83 kNative = 7, // off in a JNI native method
84 kVmWait = 8, // waiting on a VM resource
85 kSuspended = 9, // suspended, usually by GC or debugger
Carl Shapirob5573532011-07-12 18:22:59 -070086 };
87
Ian Rogers932746a2011-09-22 18:57:50 -070088 // Space to throw a StackOverflowError in.
Brian Carlstromaded5f72011-10-07 17:15:04 -070089 static const size_t kStackOverflowReservedBytes = 4 * KB;
buzbeec143c552011-08-20 17:38:58 -070090
Brian Carlstrom72db0d72011-11-10 17:58:56 -080091 static const size_t kDefaultStackSize = 96 * KB;
Carl Shapiro61e019d2011-07-14 16:53:09 -070092
Shih-wei Liao9b576b42011-08-29 01:45:07 -070093 class StackVisitor {
94 public:
Ian Rogers0cfe1fb2011-08-26 03:29:44 -070095 virtual ~StackVisitor() {}
Elliott Hughes530fa002012-03-12 11:44:49 -070096 // Return 'true' if we should continue to visit more frames, 'false' to stop.
97 virtual bool VisitFrame(const Frame& frame, uintptr_t pc) = 0;
Shih-wei Liao9b576b42011-08-29 01:45:07 -070098 };
99
Carl Shapiro61e019d2011-07-14 16:53:09 -0700100 // Creates a new thread.
Elliott Hughesd369bb72011-09-12 14:41:14 -0700101 static void Create(Object* peer, size_t stack_size);
Carl Shapiro61e019d2011-07-14 16:53:09 -0700102
103 // Creates a new thread from the calling thread.
Elliott Hughesdcc24742011-09-07 14:02:44 -0700104 static Thread* Attach(const Runtime* runtime, const char* name, bool as_daemon);
Carl Shapirob5573532011-07-12 18:22:59 -0700105
Brian Carlstromcaabb1b2011-10-11 18:09:13 -0700106 // Reset internal state of child thread after fork.
107 void InitAfterFork();
108
Carl Shapirob5573532011-07-12 18:22:59 -0700109 static Thread* Current() {
Carl Shapirod0e7e772011-07-15 14:31:01 -0700110 void* thread = pthread_getspecific(Thread::pthread_key_self_);
111 return reinterpret_cast<Thread*>(thread);
Carl Shapiro0e5d75d2011-07-06 18:28:37 -0700112 }
113
Elliott Hughes761928d2011-11-16 18:33:03 -0800114 static Thread* FromManagedThread(Object* thread_peer);
Elliott Hughes01158d72011-09-19 19:47:10 -0700115 static Thread* FromManagedThread(JNIEnv* env, jobject thread);
Elliott Hughes8e4aac52011-09-26 17:03:36 -0700116 static uint32_t LockOwnerFromThreadLock(Object* thread_lock);
Elliott Hughes8daa0922011-09-11 13:46:25 -0700117
Elliott Hughes899e7892012-01-24 14:57:32 -0800118 // When full == true, dumps the detailed thread state and the thread stack (used for SIGQUIT).
119 // When full == false, dumps a one-line summary of thread state (used for operator<<).
120 void Dump(std::ostream& os, bool full = true) const;
Elliott Hughesa0957642011-09-02 14:27:33 -0700121
Ian Rogers0cfe1fb2011-08-26 03:29:44 -0700122 State GetState() const {
123 return state_;
124 }
125
Elliott Hughes8d768a92011-09-14 16:35:25 -0700126 State SetState(State new_state);
Elliott Hughesa4060e52012-03-02 16:51:35 -0800127 void SetStateWithoutSuspendCheck(State new_state);
Elliott Hughes8d768a92011-09-14 16:35:25 -0700128
Elliott Hughes038a8062011-09-18 14:12:41 -0700129 bool IsDaemon();
Elliott Hughes761928d2011-11-16 18:33:03 -0800130 bool IsSuspended();
Elliott Hughes038a8062011-09-18 14:12:41 -0700131
Elliott Hughes8d768a92011-09-14 16:35:25 -0700132 void WaitUntilSuspended();
Ian Rogers0cfe1fb2011-08-26 03:29:44 -0700133
Elliott Hughes5f791332011-09-15 17:45:30 -0700134 bool HoldsLock(Object*);
135
Elliott Hughes8daa0922011-09-11 13:46:25 -0700136 /*
137 * Changes the priority of this thread to match that of the java.lang.Thread object.
138 *
139 * We map a priority value from 1-10 to Linux "nice" values, where lower
140 * numbers indicate higher priority.
141 */
142 void SetNativePriority(int newPriority);
143
144 /*
145 * Returns the thread priority for the current thread by querying the system.
146 * This is useful when attaching a thread through JNI.
147 *
148 * Returns a value from 1 to 10 (compatible with java.lang.Thread values).
149 */
150 static int GetNativePriority();
151
Ian Rogers0cfe1fb2011-08-26 03:29:44 -0700152 bool CanAccessDirectReferences() const {
Brian Carlstromcaabb1b2011-10-11 18:09:13 -0700153#ifdef MOVING_GARBAGE_COLLECTOR
Elliott Hughesa59d1792011-09-04 18:42:35 -0700154 // TODO: when we have a moving collector, we'll need: return state_ == kRunnable;
Brian Carlstromcaabb1b2011-10-11 18:09:13 -0700155#endif
Elliott Hughesa59d1792011-09-04 18:42:35 -0700156 return true;
Ian Rogers0cfe1fb2011-08-26 03:29:44 -0700157 }
158
Elliott Hughesdcc24742011-09-07 14:02:44 -0700159 uint32_t GetThinLockId() const {
160 return thin_lock_id_;
Carl Shapirob5573532011-07-12 18:22:59 -0700161 }
162
Elliott Hughesd92bec42011-09-02 17:04:36 -0700163 pid_t GetTid() const {
164 return tid_;
165 }
Elliott Hughese27955c2011-08-26 15:21:24 -0700166
Elliott Hughesffb465f2012-03-01 18:46:05 -0800167 // Returns the java.lang.Thread's name, or NULL if this Thread* doesn't have a peer.
Elliott Hughes899e7892012-01-24 14:57:32 -0800168 String* GetThreadName() const;
169
Elliott Hughesffb465f2012-03-01 18:46:05 -0800170 // Sets 'name' to the java.lang.Thread's name. This requires no transition to managed code,
171 // allocation, or locking.
172 void GetThreadName(std::string& name) const;
173
Elliott Hughes899e7892012-01-24 14:57:32 -0800174 // Sets the thread's name.
175 void SetThreadName(const char* name);
Elliott Hughesfc861622011-10-17 17:57:47 -0700176
Elliott Hughesd369bb72011-09-12 14:41:14 -0700177 Object* GetPeer() const {
Elliott Hughes8daa0922011-09-11 13:46:25 -0700178 return peer_;
179 }
180
Elliott Hughesa2155262011-11-16 16:26:58 -0800181 Object* GetThreadGroup() const;
182
Elliott Hughes9d5ccec2011-09-19 13:19:50 -0700183 RuntimeStats* GetStats() {
184 return &stats_;
185 }
186
Elliott Hughesd07986f2011-12-06 18:27:45 -0800187 int GetSuspendCount() const {
188 return suspend_count_;
189 }
Ian Rogers0cfe1fb2011-08-26 03:29:44 -0700190
Elliott Hughesd07986f2011-12-06 18:27:45 -0800191 // Returns the current Method* and native PC (not dex PC) for this thread.
192 Method* GetCurrentMethod(uintptr_t* pc = NULL, Method*** sp = NULL) const;
jeffhao33dc7712011-11-09 17:54:24 -0800193
Carl Shapiro0e5d75d2011-07-06 18:28:37 -0700194 bool IsExceptionPending() const {
Elliott Hughesb20a5542011-08-12 18:03:12 -0700195 return exception_ != NULL;
Carl Shapiro0e5d75d2011-07-06 18:28:37 -0700196 }
197
Elliott Hughese5b0dc82011-08-23 09:59:02 -0700198 Throwable* GetException() const {
Ian Rogers0cfe1fb2011-08-26 03:29:44 -0700199 DCHECK(CanAccessDirectReferences());
Carl Shapiro0e5d75d2011-07-06 18:28:37 -0700200 return exception_;
201 }
202
Ian Rogers0cfe1fb2011-08-26 03:29:44 -0700203 void SetException(Throwable* new_exception) {
204 DCHECK(CanAccessDirectReferences());
205 CHECK(new_exception != NULL);
206 // TODO: CHECK(exception_ == NULL);
207 exception_ = new_exception; // TODO
208 }
209
210 void ClearException() {
211 exception_ = NULL;
Elliott Hughesa0957642011-09-02 14:27:33 -0700212 }
213
Ian Rogersbdb03912011-09-14 00:55:44 -0700214 // Find catch block and perform long jump to appropriate exception handle
Ian Rogersff1ed472011-09-20 13:46:24 -0700215 void DeliverException();
Ian Rogersbdb03912011-09-14 00:55:44 -0700216
217 Context* GetLongJumpContext();
218
Shih-wei Liao1a18c8c2011-08-14 17:47:36 -0700219 Frame GetTopOfStack() const {
220 return top_of_managed_stack_;
221 }
222
223 // TODO: this is here for testing, remove when we have exception unit tests
224 // that use the real stack
Ian Rogersbdb03912011-09-14 00:55:44 -0700225 void SetTopOfStack(void* stack, uintptr_t pc) {
Ian Rogers0cfe1fb2011-08-26 03:29:44 -0700226 top_of_managed_stack_.SetSP(reinterpret_cast<Method**>(stack));
Ian Rogersbdb03912011-09-14 00:55:44 -0700227 top_of_managed_stack_pc_ = pc;
Carl Shapiro0e5d75d2011-07-06 18:28:37 -0700228 }
229
Ian Rogersbdb03912011-09-14 00:55:44 -0700230 void SetTopOfStackPC(uintptr_t pc) {
231 top_of_managed_stack_pc_ = pc;
232 }
233
Elliott Hughes5cb5ad22011-10-02 12:13:39 -0700234 // 'msg' may be NULL.
235 void ThrowNewException(const char* exception_class_descriptor, const char* msg);
236
237 void ThrowNewExceptionF(const char* exception_class_descriptor, const char* fmt, ...)
Elliott Hughes362f9bc2011-10-17 18:56:41 -0700238 __attribute__((format(printf, 3, 4)));
Elliott Hughesa5b897e2011-08-16 11:33:06 -0700239
Elliott Hughes4a2b4172011-09-20 17:08:25 -0700240 void ThrowNewExceptionV(const char* exception_class_descriptor, const char* fmt, va_list ap);
241
Elliott Hughes2ced6a52011-10-16 18:44:48 -0700242 // OutOfMemoryError is special, because we need to pre-allocate an instance.
243 void ThrowOutOfMemoryError(const char* msg);
Elliott Hughes418dfe72011-10-06 18:56:27 -0700244 void ThrowOutOfMemoryError(Class* c, size_t byte_count);
Elliott Hughes79082e32011-08-25 12:07:32 -0700245
Shih-wei Liao1a18c8c2011-08-14 17:47:36 -0700246 Frame FindExceptionHandler(void* throw_pc, void** handler_pc);
247
248 void* FindExceptionHandlerInMethod(const Method* method,
249 void* throw_pc,
250 const DexFile& dex_file,
251 ClassLinker* class_linker);
buzbeec143c552011-08-20 17:38:58 -0700252
Elliott Hughesbe759c62011-09-08 19:38:21 -0700253 static void Startup();
Elliott Hughes038a8062011-09-18 14:12:41 -0700254 static void FinishStartup();
Elliott Hughesc1674ed2011-08-25 18:09:09 -0700255 static void Shutdown();
Carl Shapirob5573532011-07-12 18:22:59 -0700256
Ian Rogersb033c752011-07-20 12:22:35 -0700257 // JNI methods
Elliott Hughes69f5bc62011-08-24 09:26:14 -0700258 JNIEnvExt* GetJniEnv() const {
Ian Rogersb033c752011-07-20 12:22:35 -0700259 return jni_env_;
260 }
261
TDYa12718fe89a2012-03-15 21:51:52 -0700262 // Number of references in SIRTs on this thread
Ian Rogers408f79a2011-08-23 18:22:33 -0700263 size_t NumSirtReferences();
Ian Rogersa8cd9f42011-08-19 16:43:41 -0700264
TDYa12718fe89a2012-03-15 21:51:52 -0700265 // Number of references allocated in ShadowFrames on this thread
266 size_t NumShadowFrameReferences();
267
268 // Number of references allocated in SIRTs & shadow frames on this thread
269 size_t NumStackReferences() {
270 return NumSirtReferences() + NumShadowFrameReferences();
271 };
272
Ian Rogers408f79a2011-08-23 18:22:33 -0700273 // Is the given obj in this thread's stack indirect reference table?
274 bool SirtContains(jobject obj);
275
TDYa12718fe89a2012-03-15 21:51:52 -0700276 // Is the given obj in this thread's ShadowFrame?
277 bool ShadowFrameContains(jobject obj);
278
279 // Is the given obj in this thread's Sirts & ShadowFrames?
280 bool StackReferencesContain(jobject obj);
281
Shih-wei Liao8dfc9d52011-09-28 18:06:15 -0700282 void SirtVisitRoots(Heap::RootVisitor* visitor, void* arg);
283
Logan Chien4455f862012-03-15 03:10:03 +0800284 void ShadowFrameVisitRoots(Heap::RootVisitor* visitor, void* arg);
285
Ian Rogers408f79a2011-08-23 18:22:33 -0700286 // Convert a jobject into a Object*
287 Object* DecodeJObject(jobject obj);
Ian Rogersb033c752011-07-20 12:22:35 -0700288
Elliott Hughes8daa0922011-09-11 13:46:25 -0700289 // Implements java.lang.Thread.interrupted.
290 bool Interrupted() {
Elliott Hughes85d15452011-09-16 17:33:01 -0700291 MutexLock mu(*wait_mutex_);
Elliott Hughes8daa0922011-09-11 13:46:25 -0700292 bool interrupted = interrupted_;
293 interrupted_ = false;
294 return interrupted;
295 }
296
297 // Implements java.lang.Thread.isInterrupted.
298 bool IsInterrupted() {
Elliott Hughes85d15452011-09-16 17:33:01 -0700299 MutexLock mu(*wait_mutex_);
Elliott Hughes8daa0922011-09-11 13:46:25 -0700300 return interrupted_;
301 }
302
Elliott Hughes5f791332011-09-15 17:45:30 -0700303 void Interrupt() {
Elliott Hughes85d15452011-09-16 17:33:01 -0700304 MutexLock mu(*wait_mutex_);
Elliott Hughes5f791332011-09-15 17:45:30 -0700305 if (interrupted_) {
306 return;
307 }
308 interrupted_ = true;
309 NotifyLocked();
310 }
311
312 void Notify() {
Elliott Hughes85d15452011-09-16 17:33:01 -0700313 MutexLock mu(*wait_mutex_);
Elliott Hughes5f791332011-09-15 17:45:30 -0700314 NotifyLocked();
315 }
316
Ian Rogers6de08602011-08-19 14:52:39 -0700317 // Linked list recording transitions from native to managed code
Ian Rogersb04f69f2011-10-17 00:40:54 -0700318 void PushNativeToManagedRecord(NativeToManagedRecord* record);
319 void PopNativeToManagedRecord(const NativeToManagedRecord& record);
Ian Rogers6de08602011-08-19 14:52:39 -0700320
Brian Carlstrombffb1552011-08-25 12:23:53 -0700321 const ClassLoader* GetClassLoaderOverride() {
Ian Rogers0cfe1fb2011-08-26 03:29:44 -0700322 // TODO: need to place the class_loader_override_ in a handle
323 // DCHECK(CanAccessDirectReferences());
buzbeec143c552011-08-20 17:38:58 -0700324 return class_loader_override_;
325 }
326
Brian Carlstrombffb1552011-08-25 12:23:53 -0700327 void SetClassLoaderOverride(const ClassLoader* class_loader_override) {
buzbeec143c552011-08-20 17:38:58 -0700328 class_loader_override_ = class_loader_override;
329 }
330
Ian Rogersaaa20802011-09-11 21:47:37 -0700331 // Create the internal representation of a stack trace, that is more time
332 // and space efficient to compute than the StackTraceElement[]
Elliott Hughes01158d72011-09-19 19:47:10 -0700333 jobject CreateInternalStackTrace(JNIEnv* env) const;
Ian Rogersaaa20802011-09-11 21:47:37 -0700334
Elliott Hughes01158d72011-09-19 19:47:10 -0700335 // Convert an internal stack trace representation (returned by CreateInternalStackTrace) to a
336 // StackTraceElement[]. If output_array is NULL, a new array is created, otherwise as many
337 // frames as will fit are written into the given array. If stack_depth is non-NULL, it's updated
338 // with the number of valid frames in the returned array.
339 static jobjectArray InternalStackTraceToStackTraceElementArray(JNIEnv* env, jobject internal,
340 jobjectArray output_array = NULL, int* stack_depth = NULL);
Shih-wei Liao55df06b2011-08-26 14:39:27 -0700341
Ian Rogersd6b1f612011-09-27 13:38:14 -0700342 void VisitRoots(Heap::RootVisitor* visitor, void* arg);
Elliott Hughes410c0c82011-09-01 17:58:25 -0700343
jeffhaod4983492012-03-13 19:34:37 -0700344#if VERIFY_OBJECT_ENABLED
345 void VerifyStack();
346#else
347 void VerifyStack() {}
348#endif
349
Elliott Hughesbe759c62011-09-08 19:38:21 -0700350 //
351 // Offsets of various members of native Thread class, used by compiled code.
352 //
353
354 static ThreadOffset SelfOffset() {
355 return ThreadOffset(OFFSETOF_MEMBER(Thread, self_));
356 }
357
358 static ThreadOffset ExceptionOffset() {
359 return ThreadOffset(OFFSETOF_MEMBER(Thread, exception_));
360 }
361
Elliott Hughes54e7df12011-09-16 11:47:04 -0700362 static ThreadOffset ThinLockIdOffset() {
Elliott Hughesbe759c62011-09-08 19:38:21 -0700363 return ThreadOffset(OFFSETOF_MEMBER(Thread, thin_lock_id_));
364 }
365
366 static ThreadOffset CardTableOffset() {
367 return ThreadOffset(OFFSETOF_MEMBER(Thread, card_table_));
368 }
369
370 static ThreadOffset SuspendCountOffset() {
371 return ThreadOffset(OFFSETOF_MEMBER(Thread, suspend_count_));
372 }
373
374 static ThreadOffset StateOffset() {
Elliott Hughes93e74e82011-09-13 11:07:03 -0700375 return ThreadOffset(OFFSETOF_VOLATILE_MEMBER(Thread, state_));
Elliott Hughesbe759c62011-09-08 19:38:21 -0700376 }
377
Ian Rogers932746a2011-09-22 18:57:50 -0700378 // Size of stack less any space reserved for stack overflow
379 size_t GetStackSize() {
Ian Rogers30fab402012-01-23 15:43:46 -0800380 return stack_size_ - (stack_end_ - stack_begin_);
Ian Rogers932746a2011-09-22 18:57:50 -0700381 }
382
383 // Set the stack end to that to be used during a stack overflow
384 void SetStackEndForStackOverflow() {
385 // During stack overflow we allow use of the full stack
Ian Rogers30fab402012-01-23 15:43:46 -0800386 if (stack_end_ == stack_begin_) {
Elliott Hughes3b6baaa2011-10-14 19:13:56 -0700387 DumpStack(std::cerr);
388 LOG(FATAL) << "Need to increase kStackOverflowReservedBytes (currently "
389 << kStackOverflowReservedBytes << ")";
390 }
391
Ian Rogers30fab402012-01-23 15:43:46 -0800392 stack_end_ = stack_begin_;
Ian Rogers932746a2011-09-22 18:57:50 -0700393 }
394
395 // Set the stack end to that to be used during regular execution
396 void ResetDefaultStackEnd() {
397 // Our stacks grow down, so we want stack_end_ to be near there, but reserving enough room
398 // to throw a StackOverflowError.
Ian Rogers30fab402012-01-23 15:43:46 -0800399 stack_end_ = stack_begin_ + kStackOverflowReservedBytes;
Ian Rogers932746a2011-09-22 18:57:50 -0700400 }
401
Elliott Hughes449b4bd2011-09-09 12:01:38 -0700402 static ThreadOffset StackEndOffset() {
403 return ThreadOffset(OFFSETOF_MEMBER(Thread, stack_end_));
Elliott Hughesbe759c62011-09-08 19:38:21 -0700404 }
405
406 static ThreadOffset JniEnvOffset() {
407 return ThreadOffset(OFFSETOF_MEMBER(Thread, jni_env_));
408 }
409
410 static ThreadOffset TopOfManagedStackOffset() {
411 return ThreadOffset(OFFSETOF_MEMBER(Thread, top_of_managed_stack_) +
412 OFFSETOF_MEMBER(Frame, sp_));
413 }
414
Ian Rogersbdb03912011-09-14 00:55:44 -0700415 static ThreadOffset TopOfManagedStackPcOffset() {
416 return ThreadOffset(OFFSETOF_MEMBER(Thread, top_of_managed_stack_pc_));
417 }
418
Logan Chien4455f862012-03-15 03:10:03 +0800419 void PushShadowFrame(ShadowFrame* frame);
420 ShadowFrame* PopShadowFrame();
421
Brian Carlstrom40381fb2011-10-19 14:13:40 -0700422 void PushSirt(StackIndirectReferenceTable* sirt);
423 StackIndirectReferenceTable* PopSirt();
424
Elliott Hughesbe759c62011-09-08 19:38:21 -0700425 static ThreadOffset TopSirtOffset() {
426 return ThreadOffset(OFFSETOF_MEMBER(Thread, top_sirt_));
427 }
428
Elliott Hughes530fa002012-03-12 11:44:49 -0700429 void WalkStack(StackVisitor* visitor, bool include_upcalls = false) const;
Shih-wei Liao9407c602011-09-16 10:36:43 -0700430
Elliott Hughes475fc232011-10-25 15:00:35 -0700431 DebugInvokeReq* GetInvokeReq() {
432 return debug_invoke_req_;
433 }
434
jeffhaoe343b762011-12-05 16:36:44 -0800435 bool IsTraceStackEmpty() const {
436 return trace_stack_->empty();
437 }
438
jeffhaoa9ef3fd2011-12-13 18:33:43 -0800439 TraceStackFrame GetTraceStackFrame(uint32_t depth) const {
440 return trace_stack_->at(trace_stack_->size() - depth - 1);
441 }
442
jeffhaoe343b762011-12-05 16:36:44 -0800443 void PushTraceStackFrame(const TraceStackFrame& frame) {
444 trace_stack_->push_back(frame);
445 }
446
447 TraceStackFrame PopTraceStackFrame() {
448 TraceStackFrame frame = trace_stack_->back();
449 trace_stack_->pop_back();
450 return frame;
451 }
452
Elliott Hughesa4060e52012-03-02 16:51:35 -0800453 void CheckSafeToLockOrUnlock(MutexRank rank, bool is_locking);
454 void CheckSafeToWait(MutexRank rank);
Elliott Hughesffb465f2012-03-01 18:46:05 -0800455
Carl Shapiro0e5d75d2011-07-06 18:28:37 -0700456 private:
Elliott Hughesdcc24742011-09-07 14:02:44 -0700457 Thread();
Elliott Hughesc1674ed2011-08-25 18:09:09 -0700458 ~Thread();
Elliott Hughes02b48d12011-09-07 17:15:51 -0700459 friend class ThreadList; // For ~Thread.
Carl Shapiro0e5d75d2011-07-06 18:28:37 -0700460
Elliott Hughes5fe594f2011-09-08 12:33:17 -0700461 void CreatePeer(const char* name, bool as_daemon);
462 friend class Runtime; // For CreatePeer.
463
Elliott Hughesd92bec42011-09-02 17:04:36 -0700464 void DumpState(std::ostream& os) const;
465 void DumpStack(std::ostream& os) const;
Elliott Hughesffb465f2012-03-01 18:46:05 -0800466 void DumpNativeStack(std::ostream& os) const;
Elliott Hughesd92bec42011-09-02 17:04:36 -0700467
Elliott Hughesaccd83d2011-10-17 14:25:58 -0700468 // Out-of-line conveniences for debugging in gdb.
Elliott Hughes498508c2011-10-17 14:58:22 -0700469 static Thread* CurrentFromGdb(); // Like Thread::Current.
Elliott Hughesaccd83d2011-10-17 14:25:58 -0700470 void DumpFromGdb() const; // Like Thread::Dump(std::cerr).
471
Elliott Hughes93e74e82011-09-13 11:07:03 -0700472 void Attach(const Runtime* runtime);
473 static void* CreateCallback(void* arg);
474
Elliott Hughesaccd83d2011-10-17 14:25:58 -0700475 void HandleUncaughtExceptions();
Brian Carlstrom4514d3c2011-10-21 17:01:31 -0700476 void RemoveFromThreadGroup();
Elliott Hughesaccd83d2011-10-17 14:25:58 -0700477
Ian Rogers5d76c432011-10-31 21:42:49 -0700478 void InitCardTable();
Ian Rogersb033c752011-07-20 12:22:35 -0700479 void InitCpu();
buzbee3ea4ec52011-08-22 17:37:19 -0700480 void InitFunctionPointers();
Brian Carlstromcaabb1b2011-10-11 18:09:13 -0700481 void InitTid();
Brian Carlstromcaabb1b2011-10-11 18:09:13 -0700482 void InitPthreadKeySelf();
Elliott Hughesbe759c62011-09-08 19:38:21 -0700483 void InitStackHwm();
484
Elliott Hughes5f791332011-09-15 17:45:30 -0700485 void NotifyLocked() {
486 if (wait_monitor_ != NULL) {
Elliott Hughes85d15452011-09-16 17:33:01 -0700487 wait_cond_->Signal();
Elliott Hughes5f791332011-09-15 17:45:30 -0700488 }
489 }
490
Elliott Hughesbe759c62011-09-08 19:38:21 -0700491 static void ThreadExitCallback(void* arg);
Ian Rogersb033c752011-07-20 12:22:35 -0700492
Elliott Hughesdcc24742011-09-07 14:02:44 -0700493 // Thin lock thread id. This is a small integer used by the thin lock implementation.
494 // This is not to be confused with the native thread's tid, nor is it the value returned
495 // by java.lang.Thread.getId --- this is a distinct value, used only for locking. One
496 // important difference between this id and the ids visible to managed code is that these
497 // ones get reused (to ensure that they fit in the number of bits available).
498 uint32_t thin_lock_id_;
Ian Rogersb033c752011-07-20 12:22:35 -0700499
Elliott Hughesd92bec42011-09-02 17:04:36 -0700500 // System thread id.
501 pid_t tid_;
502
Elliott Hughesdcc24742011-09-07 14:02:44 -0700503 // Our managed peer (an instance of java.lang.Thread).
Elliott Hughesd369bb72011-09-12 14:41:14 -0700504 Object* peer_;
Elliott Hughes8daa0922011-09-11 13:46:25 -0700505
Elliott Hughes8e4aac52011-09-26 17:03:36 -0700506 // The top_of_managed_stack_ and top_of_managed_stack_pc_ fields are accessed from
507 // compiled code, so we keep them early in the structure to (a) avoid having to keep
508 // fixing the assembler offsets and (b) improve the chances that these will still be aligned.
509
510 // Top of the managed stack, written out prior to the state transition from
Elliott Hughes68e76522011-10-05 13:22:16 -0700511 // kRunnable to kNative. Uses include giving the starting point for scanning
Elliott Hughes8e4aac52011-09-26 17:03:36 -0700512 // a managed stack when a thread is in native code.
513 Frame top_of_managed_stack_;
514 // PC corresponding to the call out of the top_of_managed_stack_ frame
515 uintptr_t top_of_managed_stack_pc_;
516
Elliott Hughes8daa0922011-09-11 13:46:25 -0700517 // Guards the 'interrupted_' and 'wait_monitor_' members.
Elliott Hughes85d15452011-09-16 17:33:01 -0700518 mutable Mutex* wait_mutex_;
519 ConditionVariable* wait_cond_;
Elliott Hughes8daa0922011-09-11 13:46:25 -0700520 // Pointer to the monitor lock we're currently waiting on (or NULL), guarded by wait_mutex_.
521 Monitor* wait_monitor_;
522 // Thread "interrupted" status; stays raised until queried or thrown, guarded by wait_mutex_.
Elliott Hughes8e4aac52011-09-26 17:03:36 -0700523 uint32_t interrupted_;
Elliott Hughes5f791332011-09-15 17:45:30 -0700524 // The next thread in the wait set this thread is part of.
525 Thread* wait_next_;
Elliott Hughes8e4aac52011-09-26 17:03:36 -0700526 // If we're blocked in MonitorEnter, this is the object we're trying to lock.
527 Object* monitor_enter_object_;
Elliott Hughes5f791332011-09-15 17:45:30 -0700528
529 friend class Monitor;
Elliott Hughesdcc24742011-09-07 14:02:44 -0700530
Elliott Hughes9d5ccec2011-09-19 13:19:50 -0700531 RuntimeStats stats_;
532
Ian Rogers5d76c432011-10-31 21:42:49 -0700533 // The biased card table, see CardTable for details
534 byte* card_table_;
buzbeec143c552011-08-20 17:38:58 -0700535
Elliott Hughes449b4bd2011-09-09 12:01:38 -0700536 // The end of this thread's stack. This is the lowest safely-addressable address on the stack.
537 // We leave extra space so there's room for the code that throws StackOverflowError.
538 byte* stack_end_;
Elliott Hughesbe759c62011-09-08 19:38:21 -0700539
Ian Rogers932746a2011-09-22 18:57:50 -0700540 // Size of the stack
541 size_t stack_size_;
542
543 // The "lowest addressable byte" of the stack
Ian Rogers30fab402012-01-23 15:43:46 -0800544 byte* stack_begin_;
Ian Rogers932746a2011-09-22 18:57:50 -0700545
Ian Rogers6de08602011-08-19 14:52:39 -0700546 // A linked list (of stack allocated records) recording transitions from
547 // native to managed code.
548 NativeToManagedRecord* native_to_managed_record_;
549
Ian Rogers408f79a2011-08-23 18:22:33 -0700550 // Top of linked list of stack indirect reference tables or NULL for none
551 StackIndirectReferenceTable* top_sirt_;
Ian Rogersb033c752011-07-20 12:22:35 -0700552
Logan Chien4455f862012-03-15 03:10:03 +0800553 // Top of linked list of shadow stack or NULL for none
554 // Some backend may require shadow frame to ease the GC work.
555 ShadowFrame* top_shadow_frame_;
556
Ian Rogersb033c752011-07-20 12:22:35 -0700557 // Every thread may have an associated JNI environment
Elliott Hughes69f5bc62011-08-24 09:26:14 -0700558 JNIEnvExt* jni_env_;
Ian Rogersb033c752011-07-20 12:22:35 -0700559
Elliott Hughes93e74e82011-09-13 11:07:03 -0700560 volatile State state_;
Carl Shapirob5573532011-07-12 18:22:59 -0700561
Carl Shapiro69759ea2011-07-21 18:13:35 -0700562 // Initialized to "this". On certain architectures (such as x86) reading
563 // off of Thread::Current is easy but getting the address of Thread::Current
564 // is hard. This field can be read off of Thread::Current to give the address.
565 Thread* self_;
566
567 Runtime* runtime_;
568
569 // The pending exception or NULL.
Elliott Hughese5b0dc82011-08-23 09:59:02 -0700570 Throwable* exception_;
Carl Shapiro0e5d75d2011-07-06 18:28:37 -0700571
Ian Rogers45a76cb2011-07-21 22:00:15 -0700572 // A non-zero value is used to tell the current thread to enter a safe point
573 // at the next poll.
574 int suspend_count_;
Elliott Hughes234ab152011-10-26 14:02:26 -0700575 // How much of 'suspend_count_' is by request of the debugger, used to set things right
576 // when the debugger detaches. Must be <= suspend_count_.
577 int debug_suspend_count_;
Ian Rogers45a76cb2011-07-21 22:00:15 -0700578
Elliott Hughesedcc09c2011-08-21 18:47:05 -0700579 // Needed to get the right ClassLoader in JNI_OnLoad, but also
580 // useful for testing.
Brian Carlstrombffb1552011-08-25 12:23:53 -0700581 const ClassLoader* class_loader_override_;
buzbeec143c552011-08-20 17:38:58 -0700582
Ian Rogersbdb03912011-09-14 00:55:44 -0700583 // Thread local, lazily allocated, long jump context. Used to deliver exceptions.
Elliott Hughes85d15452011-09-16 17:33:01 -0700584 Context* long_jump_context_;
Ian Rogersbdb03912011-09-14 00:55:44 -0700585
Elliott Hughes418dfe72011-10-06 18:56:27 -0700586 // A boolean telling us whether we're recursively throwing OOME.
Elliott Hughes726079d2011-10-07 18:43:44 -0700587 uint32_t throwing_OutOfMemoryError_;
588
589 Throwable* pre_allocated_OutOfMemoryError_;
Elliott Hughes418dfe72011-10-06 18:56:27 -0700590
Elliott Hughes475fc232011-10-25 15:00:35 -0700591 // JDWP invoke-during-breakpoint support.
592 DebugInvokeReq* debug_invoke_req_;
593
Carl Shapiro69759ea2011-07-21 18:13:35 -0700594 // TLS key used to retrieve the VM thread object.
Carl Shapirob5573532011-07-12 18:22:59 -0700595 static pthread_key_t pthread_key_self_;
596
jeffhaoe343b762011-12-05 16:36:44 -0800597 // Additional stack used by method tracer to store method and return pc values.
598 // Stored as a pointer since std::vector is not PACKED.
599 std::vector<TraceStackFrame>* trace_stack_;
600
Elliott Hughes899e7892012-01-24 14:57:32 -0800601 // A cached copy of the java.lang.Thread's name.
602 std::string* name_;
603
Elliott Hughesffb465f2012-03-01 18:46:05 -0800604 uint32_t held_mutexes_[kMaxMutexRank + 1];
605
Ian Rogersa32a6fd2012-02-06 20:18:44 -0800606 public:
607 // Runtime support function pointers
608 void (*pDebugMe)(Method*, uint32_t);
609 void* (*pMemcpy)(void*, const void*, size_t);
610 uint64_t (*pShlLong)(uint64_t, uint32_t);
611 uint64_t (*pShrLong)(uint64_t, uint32_t);
612 uint64_t (*pUshrLong)(uint64_t, uint32_t);
613 float (*pI2f)(int);
614 int (*pF2iz)(float);
615 float (*pD2f)(double);
616 double (*pF2d)(float);
617 double (*pI2d)(int);
618 int (*pD2iz)(double);
Ian Rogersc6f3bb82012-03-21 20:40:33 -0700619 float (*pL2f)(int64_t);
620 double (*pL2d)(int64_t);
621 int64_t (*pF2l)(float);
622 int64_t (*pD2l)(double);
Ian Rogersa32a6fd2012-02-06 20:18:44 -0800623 float (*pFadd)(float, float);
624 float (*pFsub)(float, float);
625 float (*pFdiv)(float, float);
626 float (*pFmul)(float, float);
627 float (*pFmodf)(float, float);
628 double (*pDadd)(double, double);
629 double (*pDsub)(double, double);
630 double (*pDdiv)(double, double);
631 double (*pDmul)(double, double);
632 double (*pFmod)(double, double);
633 int (*pIdivmod)(int, int);
634 int (*pIdiv)(int, int);
Ian Rogersc6f3bb82012-03-21 20:40:33 -0700635 int64_t (*pLadd)(int64_t, int64_t);
636 int64_t (*pLsub)(int64_t, int64_t);
637 int64_t (*pLand)(int64_t, int64_t);
638 int64_t (*pLor)(int64_t, int64_t);
639 int64_t (*pLxor)(int64_t, int64_t);
640 int64_t (*pLmul)(int64_t, int64_t);
641 int64_t (*pLdivmod)(int64_t, int64_t);
Ian Rogersa32a6fd2012-02-06 20:18:44 -0800642 void (*pCheckSuspendFromCode)(Thread*); // Stub that is called when the suspend count is non-zero
643 void (*pTestSuspendFromCode)(); // Stub that is periodically called to test the suspend count
644 void* (*pAllocObjectFromCode)(uint32_t, void*);
645 void* (*pAllocObjectFromCodeWithAccessCheck)(uint32_t, void*);
646 void* (*pAllocArrayFromCode)(uint32_t, void*, int32_t);
647 void* (*pAllocArrayFromCodeWithAccessCheck)(uint32_t, void*, int32_t);
648 void (*pCanPutArrayElementFromCode)(void*, void*);
649 void* (*pCheckAndAllocArrayFromCode)(uint32_t, void*, int32_t);
650 void* (*pCheckAndAllocArrayFromCodeWithAccessCheck)(uint32_t, void*, int32_t);
651 void (*pCheckCastFromCode)(void*, void*);
652 Object* (*pDecodeJObjectInThread)(Thread* thread, jobject obj);
653 void (*pDeliverException)(void*);
654 Method* (*pFindInterfaceMethodInCache)(Class*, uint32_t, const Method*, struct DvmDex*);
655 void* (*pFindNativeMethod)(Thread* thread);
656 int32_t (*pGet32Instance)(uint32_t, void*);
657 int64_t (*pGet64Instance)(uint32_t, void*);
658 void* (*pGetObjInstance)(uint32_t, void*);
659 int32_t (*pGet32Static)(uint32_t);
660 int64_t (*pGet64Static)(uint32_t);
661 void* (*pGetObjStatic)(uint32_t);
662 void (*pHandleFillArrayDataFromCode)(void*, void*);
663 void* (*pInitializeStaticStorage)(uint32_t, void*);
664 uint32_t (*pInstanceofNonTrivialFromCode)(const Class*, const Class*);
Ian Rogersc8b306f2012-02-17 21:34:44 -0800665 void (*pInvokeDirectTrampolineWithAccessCheck)(uint32_t, void*);
Ian Rogersa32a6fd2012-02-06 20:18:44 -0800666 void (*pInvokeInterfaceTrampoline)(uint32_t, void*);
667 void (*pInvokeInterfaceTrampolineWithAccessCheck)(uint32_t, void*);
Ian Rogersc8b306f2012-02-17 21:34:44 -0800668 void (*pInvokeStaticTrampolineWithAccessCheck)(uint32_t, void*);
Ian Rogersa32a6fd2012-02-06 20:18:44 -0800669 void (*pInvokeSuperTrampolineWithAccessCheck)(uint32_t, void*);
670 void (*pInvokeVirtualTrampolineWithAccessCheck)(uint32_t, void*);
671 void* (*pInitializeTypeFromCode)(uint32_t, void*);
672 void* (*pInitializeTypeAndVerifyAccessFromCode)(uint32_t, void*);
673 void (*pLockObjectFromCode)(void*);
Ian Rogersa32a6fd2012-02-06 20:18:44 -0800674 void* (*pResolveStringFromCode)(void*, uint32_t);
675 int (*pSet32Instance)(uint32_t, void*, int32_t); // field_idx, obj, src
676 int (*pSet64Instance)(uint32_t, void*, int64_t);
677 int (*pSetObjInstance)(uint32_t, void*, void*);
678 int (*pSet32Static)(uint32_t, int32_t);
679 int (*pSet64Static)(uint32_t, int64_t);
680 int (*pSetObjStatic)(uint32_t, void*);
681 void (*pThrowStackOverflowFromCode)(void*);
682 void (*pThrowNullPointerFromCode)();
683 void (*pThrowArrayBoundsFromCode)(int32_t, int32_t);
684 void (*pThrowDivZeroFromCode)();
685 void (*pThrowVerificationErrorFromCode)(int32_t, int32_t);
686 void (*pThrowNegArraySizeFromCode)(int32_t);
687 void (*pThrowNoSuchMethodFromCode)(int32_t);
688 void (*pThrowAbstractMethodErrorFromCode)(Method* method, Thread* thread, Method** sp);
689 void (*pUnlockObjectFromCode)(void*);
Ian Rogers19846512012-02-24 11:42:47 -0800690 const void* (*pUnresolvedDirectMethodTrampolineFromCode)(Method*, Method**, Thread*,
691 Runtime::TrampolineType);
Ian Rogersa32a6fd2012-02-06 20:18:44 -0800692 void (*pUpdateDebuggerFromCode)(void*, void*, int32_t, void*);
Bill Buzbee11f9d212012-03-03 20:03:18 -0800693 bool (*pCmplFloat)(float, float);
694 bool (*pCmpgFloat)(float, float);
695 bool (*pCmplDouble)(double, double);
696 bool (*pCmpgDouble)(double, double);
Ian Rogersa32a6fd2012-02-06 20:18:44 -0800697
698 private:
Carl Shapiro0e5d75d2011-07-06 18:28:37 -0700699 DISALLOW_COPY_AND_ASSIGN(Thread);
700};
Ian Rogersbdb03912011-09-14 00:55:44 -0700701
Elliott Hughes330304d2011-08-12 14:28:05 -0700702std::ostream& operator<<(std::ostream& os, const Thread& thread);
Ian Rogersb033c752011-07-20 12:22:35 -0700703std::ostream& operator<<(std::ostream& os, const Thread::State& state);
Carl Shapiro0e5d75d2011-07-06 18:28:37 -0700704
Elliott Hughesad7c2a32011-08-31 11:58:10 -0700705class ScopedThreadStateChange {
706 public:
707 ScopedThreadStateChange(Thread* thread, Thread::State new_state) : thread_(thread) {
708 old_thread_state_ = thread_->SetState(new_state);
709 }
710
711 ~ScopedThreadStateChange() {
712 thread_->SetState(old_thread_state_);
713 }
714
715 private:
716 Thread* thread_;
717 Thread::State old_thread_state_;
718 DISALLOW_COPY_AND_ASSIGN(ScopedThreadStateChange);
719};
720
Carl Shapiro0e5d75d2011-07-06 18:28:37 -0700721} // namespace art
722
723#endif // ART_SRC_THREAD_H_