blob: 6c29af26bea80b5e2e90e9b0a769490e623dc24b [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 Chienf7ad17e2012-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.
Elliott Hughesc0f09332012-03-26 13:27:06 -070081 kStarting = 5, // native thread started, not yet ready to run managed code
82 kNative = 6, // off in a JNI native method
83 kVmWait = 7, // waiting on an internal runtime resource
84 kSuspended = 8, // suspended, usually by GC or debugger
Carl Shapirob5573532011-07-12 18:22:59 -070085 };
86
Ian Rogers932746a2011-09-22 18:57:50 -070087 // Space to throw a StackOverflowError in.
Brian Carlstromaded5f72011-10-07 17:15:04 -070088 static const size_t kStackOverflowReservedBytes = 4 * KB;
buzbeec143c552011-08-20 17:38:58 -070089
Brian Carlstrom72db0d72011-11-10 17:58:56 -080090 static const size_t kDefaultStackSize = 96 * KB;
Carl Shapiro61e019d2011-07-14 16:53:09 -070091
Shih-wei Liao9b576b42011-08-29 01:45:07 -070092 class StackVisitor {
93 public:
Ian Rogers0cfe1fb2011-08-26 03:29:44 -070094 virtual ~StackVisitor() {}
Elliott Hughes530fa002012-03-12 11:44:49 -070095 // Return 'true' if we should continue to visit more frames, 'false' to stop.
96 virtual bool VisitFrame(const Frame& frame, uintptr_t pc) = 0;
Shih-wei Liao9b576b42011-08-29 01:45:07 -070097 };
98
Elliott Hughes462c9442012-03-23 18:47:50 -070099 // Creates a new native thread corresponding to the given managed peer.
100 // Used to implement Thread.start.
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
Elliott Hughes462c9442012-03-23 18:47:50 -0700103 // Attaches the calling native thread to the runtime, returning the new native peer.
104 // Used to implement JNI AttachCurrentThread and AttachCurrentThreadAsDaemon calls.
105 static Thread* Attach(const char* thread_name, bool as_daemon, Object* thread_group);
Carl Shapirob5573532011-07-12 18:22:59 -0700106
Brian Carlstromcaabb1b2011-10-11 18:09:13 -0700107 // Reset internal state of child thread after fork.
108 void InitAfterFork();
109
Carl Shapirob5573532011-07-12 18:22:59 -0700110 static Thread* Current() {
Carl Shapirod0e7e772011-07-15 14:31:01 -0700111 void* thread = pthread_getspecific(Thread::pthread_key_self_);
112 return reinterpret_cast<Thread*>(thread);
Carl Shapiro0e5d75d2011-07-06 18:28:37 -0700113 }
114
Elliott Hughes761928d2011-11-16 18:33:03 -0800115 static Thread* FromManagedThread(Object* thread_peer);
Elliott Hughes01158d72011-09-19 19:47:10 -0700116 static Thread* FromManagedThread(JNIEnv* env, jobject thread);
Elliott Hughes8e4aac52011-09-26 17:03:36 -0700117 static uint32_t LockOwnerFromThreadLock(Object* thread_lock);
Elliott Hughes8daa0922011-09-11 13:46:25 -0700118
Elliott Hughes899e7892012-01-24 14:57:32 -0800119 // When full == true, dumps the detailed thread state and the thread stack (used for SIGQUIT).
120 // When full == false, dumps a one-line summary of thread state (used for operator<<).
121 void Dump(std::ostream& os, bool full = true) const;
Elliott Hughesa0957642011-09-02 14:27:33 -0700122
Ian Rogers0cfe1fb2011-08-26 03:29:44 -0700123 State GetState() const {
124 return state_;
125 }
126
Elliott Hughes8d768a92011-09-14 16:35:25 -0700127 State SetState(State new_state);
Elliott Hughesa4060e52012-03-02 16:51:35 -0800128 void SetStateWithoutSuspendCheck(State new_state);
Elliott Hughes8d768a92011-09-14 16:35:25 -0700129
Elliott Hughes038a8062011-09-18 14:12:41 -0700130 bool IsDaemon();
Elliott Hughes761928d2011-11-16 18:33:03 -0800131 bool IsSuspended();
Elliott Hughes038a8062011-09-18 14:12:41 -0700132
Elliott Hughes8d768a92011-09-14 16:35:25 -0700133 void WaitUntilSuspended();
Ian Rogers0cfe1fb2011-08-26 03:29:44 -0700134
Elliott Hughes5f791332011-09-15 17:45:30 -0700135 bool HoldsLock(Object*);
136
Elliott Hughes8daa0922011-09-11 13:46:25 -0700137 /*
138 * Changes the priority of this thread to match that of the java.lang.Thread object.
139 *
140 * We map a priority value from 1-10 to Linux "nice" values, where lower
141 * numbers indicate higher priority.
142 */
143 void SetNativePriority(int newPriority);
144
145 /*
146 * Returns the thread priority for the current thread by querying the system.
147 * This is useful when attaching a thread through JNI.
148 *
149 * Returns a value from 1 to 10 (compatible with java.lang.Thread values).
150 */
151 static int GetNativePriority();
152
Elliott Hughes462c9442012-03-23 18:47:50 -0700153 // Returns the "main" ThreadGroup, used when attaching user threads.
154 static Object* GetMainThreadGroup();
155 // Returns the "system" ThreadGroup, used when attaching our internal threads.
156 static Object* GetSystemThreadGroup();
157
Ian Rogers0cfe1fb2011-08-26 03:29:44 -0700158 bool CanAccessDirectReferences() const {
Brian Carlstromcaabb1b2011-10-11 18:09:13 -0700159#ifdef MOVING_GARBAGE_COLLECTOR
Elliott Hughesa59d1792011-09-04 18:42:35 -0700160 // TODO: when we have a moving collector, we'll need: return state_ == kRunnable;
Brian Carlstromcaabb1b2011-10-11 18:09:13 -0700161#endif
Elliott Hughesa59d1792011-09-04 18:42:35 -0700162 return true;
Ian Rogers0cfe1fb2011-08-26 03:29:44 -0700163 }
164
Elliott Hughesdcc24742011-09-07 14:02:44 -0700165 uint32_t GetThinLockId() const {
166 return thin_lock_id_;
Carl Shapirob5573532011-07-12 18:22:59 -0700167 }
168
Elliott Hughesd92bec42011-09-02 17:04:36 -0700169 pid_t GetTid() const {
170 return tid_;
171 }
Elliott Hughese27955c2011-08-26 15:21:24 -0700172
Elliott Hughesffb465f2012-03-01 18:46:05 -0800173 // Returns the java.lang.Thread's name, or NULL if this Thread* doesn't have a peer.
Elliott Hughes899e7892012-01-24 14:57:32 -0800174 String* GetThreadName() const;
175
Elliott Hughesffb465f2012-03-01 18:46:05 -0800176 // Sets 'name' to the java.lang.Thread's name. This requires no transition to managed code,
177 // allocation, or locking.
178 void GetThreadName(std::string& name) const;
179
Elliott Hughes899e7892012-01-24 14:57:32 -0800180 // Sets the thread's name.
181 void SetThreadName(const char* name);
Elliott Hughesfc861622011-10-17 17:57:47 -0700182
Elliott Hughesd369bb72011-09-12 14:41:14 -0700183 Object* GetPeer() const {
Elliott Hughes8daa0922011-09-11 13:46:25 -0700184 return peer_;
185 }
186
Elliott Hughesa2155262011-11-16 16:26:58 -0800187 Object* GetThreadGroup() const;
188
Elliott Hughes9d5ccec2011-09-19 13:19:50 -0700189 RuntimeStats* GetStats() {
190 return &stats_;
191 }
192
Elliott Hughesd07986f2011-12-06 18:27:45 -0800193 int GetSuspendCount() const {
194 return suspend_count_;
195 }
Ian Rogers0cfe1fb2011-08-26 03:29:44 -0700196
Elliott Hughesd07986f2011-12-06 18:27:45 -0800197 // Returns the current Method* and native PC (not dex PC) for this thread.
198 Method* GetCurrentMethod(uintptr_t* pc = NULL, Method*** sp = NULL) const;
jeffhao33dc7712011-11-09 17:54:24 -0800199
Carl Shapiro0e5d75d2011-07-06 18:28:37 -0700200 bool IsExceptionPending() const {
Elliott Hughesb20a5542011-08-12 18:03:12 -0700201 return exception_ != NULL;
Carl Shapiro0e5d75d2011-07-06 18:28:37 -0700202 }
203
Elliott Hughese5b0dc82011-08-23 09:59:02 -0700204 Throwable* GetException() const {
Ian Rogers0cfe1fb2011-08-26 03:29:44 -0700205 DCHECK(CanAccessDirectReferences());
Carl Shapiro0e5d75d2011-07-06 18:28:37 -0700206 return exception_;
207 }
208
Ian Rogers0cfe1fb2011-08-26 03:29:44 -0700209 void SetException(Throwable* new_exception) {
210 DCHECK(CanAccessDirectReferences());
211 CHECK(new_exception != NULL);
212 // TODO: CHECK(exception_ == NULL);
213 exception_ = new_exception; // TODO
214 }
215
216 void ClearException() {
217 exception_ = NULL;
Elliott Hughesa0957642011-09-02 14:27:33 -0700218 }
219
Ian Rogersbdb03912011-09-14 00:55:44 -0700220 // Find catch block and perform long jump to appropriate exception handle
Ian Rogersff1ed472011-09-20 13:46:24 -0700221 void DeliverException();
Ian Rogersbdb03912011-09-14 00:55:44 -0700222
223 Context* GetLongJumpContext();
224
Shih-wei Liao1a18c8c2011-08-14 17:47:36 -0700225 Frame GetTopOfStack() const {
226 return top_of_managed_stack_;
227 }
228
229 // TODO: this is here for testing, remove when we have exception unit tests
230 // that use the real stack
Ian Rogersbdb03912011-09-14 00:55:44 -0700231 void SetTopOfStack(void* stack, uintptr_t pc) {
Ian Rogers0cfe1fb2011-08-26 03:29:44 -0700232 top_of_managed_stack_.SetSP(reinterpret_cast<Method**>(stack));
Ian Rogersbdb03912011-09-14 00:55:44 -0700233 top_of_managed_stack_pc_ = pc;
Carl Shapiro0e5d75d2011-07-06 18:28:37 -0700234 }
235
Ian Rogersbdb03912011-09-14 00:55:44 -0700236 void SetTopOfStackPC(uintptr_t pc) {
237 top_of_managed_stack_pc_ = pc;
238 }
239
Elliott Hughes5cb5ad22011-10-02 12:13:39 -0700240 // 'msg' may be NULL.
241 void ThrowNewException(const char* exception_class_descriptor, const char* msg);
242
243 void ThrowNewExceptionF(const char* exception_class_descriptor, const char* fmt, ...)
Elliott Hughes362f9bc2011-10-17 18:56:41 -0700244 __attribute__((format(printf, 3, 4)));
Elliott Hughesa5b897e2011-08-16 11:33:06 -0700245
Elliott Hughes4a2b4172011-09-20 17:08:25 -0700246 void ThrowNewExceptionV(const char* exception_class_descriptor, const char* fmt, va_list ap);
247
Elliott Hughes2ced6a52011-10-16 18:44:48 -0700248 // OutOfMemoryError is special, because we need to pre-allocate an instance.
249 void ThrowOutOfMemoryError(const char* msg);
Elliott Hughes418dfe72011-10-06 18:56:27 -0700250 void ThrowOutOfMemoryError(Class* c, size_t byte_count);
Elliott Hughes79082e32011-08-25 12:07:32 -0700251
Shih-wei Liao1a18c8c2011-08-14 17:47:36 -0700252 Frame FindExceptionHandler(void* throw_pc, void** handler_pc);
253
254 void* FindExceptionHandlerInMethod(const Method* method,
255 void* throw_pc,
256 const DexFile& dex_file,
257 ClassLinker* class_linker);
buzbeec143c552011-08-20 17:38:58 -0700258
Elliott Hughesbe759c62011-09-08 19:38:21 -0700259 static void Startup();
Elliott Hughes038a8062011-09-18 14:12:41 -0700260 static void FinishStartup();
Elliott Hughesc1674ed2011-08-25 18:09:09 -0700261 static void Shutdown();
Carl Shapirob5573532011-07-12 18:22:59 -0700262
Ian Rogersb033c752011-07-20 12:22:35 -0700263 // JNI methods
Elliott Hughes69f5bc62011-08-24 09:26:14 -0700264 JNIEnvExt* GetJniEnv() const {
Ian Rogersb033c752011-07-20 12:22:35 -0700265 return jni_env_;
266 }
267
TDYa12728f1a142012-03-15 21:51:52 -0700268 // Number of references in SIRTs on this thread
Ian Rogers408f79a2011-08-23 18:22:33 -0700269 size_t NumSirtReferences();
Ian Rogersa8cd9f42011-08-19 16:43:41 -0700270
TDYa12728f1a142012-03-15 21:51:52 -0700271 // Number of references allocated in ShadowFrames on this thread
272 size_t NumShadowFrameReferences();
273
274 // Number of references allocated in SIRTs & shadow frames on this thread
275 size_t NumStackReferences() {
276 return NumSirtReferences() + NumShadowFrameReferences();
277 };
278
Ian Rogers408f79a2011-08-23 18:22:33 -0700279 // Is the given obj in this thread's stack indirect reference table?
280 bool SirtContains(jobject obj);
281
TDYa12728f1a142012-03-15 21:51:52 -0700282 // Is the given obj in this thread's ShadowFrame?
283 bool ShadowFrameContains(jobject obj);
284
285 // Is the given obj in this thread's Sirts & ShadowFrames?
286 bool StackReferencesContain(jobject obj);
287
Shih-wei Liao8dfc9d52011-09-28 18:06:15 -0700288 void SirtVisitRoots(Heap::RootVisitor* visitor, void* arg);
289
Logan Chienf7ad17e2012-03-15 03:10:03 +0800290 void ShadowFrameVisitRoots(Heap::RootVisitor* visitor, void* arg);
291
Ian Rogers408f79a2011-08-23 18:22:33 -0700292 // Convert a jobject into a Object*
293 Object* DecodeJObject(jobject obj);
Ian Rogersb033c752011-07-20 12:22:35 -0700294
Elliott Hughes8daa0922011-09-11 13:46:25 -0700295 // Implements java.lang.Thread.interrupted.
296 bool Interrupted() {
Elliott Hughes85d15452011-09-16 17:33:01 -0700297 MutexLock mu(*wait_mutex_);
Elliott Hughes8daa0922011-09-11 13:46:25 -0700298 bool interrupted = interrupted_;
299 interrupted_ = false;
300 return interrupted;
301 }
302
303 // Implements java.lang.Thread.isInterrupted.
304 bool IsInterrupted() {
Elliott Hughes85d15452011-09-16 17:33:01 -0700305 MutexLock mu(*wait_mutex_);
Elliott Hughes8daa0922011-09-11 13:46:25 -0700306 return interrupted_;
307 }
308
Elliott Hughes5f791332011-09-15 17:45:30 -0700309 void Interrupt() {
Elliott Hughes85d15452011-09-16 17:33:01 -0700310 MutexLock mu(*wait_mutex_);
Elliott Hughes5f791332011-09-15 17:45:30 -0700311 if (interrupted_) {
312 return;
313 }
314 interrupted_ = true;
315 NotifyLocked();
316 }
317
318 void Notify() {
Elliott Hughes85d15452011-09-16 17:33:01 -0700319 MutexLock mu(*wait_mutex_);
Elliott Hughes5f791332011-09-15 17:45:30 -0700320 NotifyLocked();
321 }
322
Ian Rogers6de08602011-08-19 14:52:39 -0700323 // Linked list recording transitions from native to managed code
Ian Rogersb04f69f2011-10-17 00:40:54 -0700324 void PushNativeToManagedRecord(NativeToManagedRecord* record);
325 void PopNativeToManagedRecord(const NativeToManagedRecord& record);
Ian Rogers6de08602011-08-19 14:52:39 -0700326
Brian Carlstrombffb1552011-08-25 12:23:53 -0700327 const ClassLoader* GetClassLoaderOverride() {
Ian Rogers0cfe1fb2011-08-26 03:29:44 -0700328 // TODO: need to place the class_loader_override_ in a handle
329 // DCHECK(CanAccessDirectReferences());
buzbeec143c552011-08-20 17:38:58 -0700330 return class_loader_override_;
331 }
332
Brian Carlstrombffb1552011-08-25 12:23:53 -0700333 void SetClassLoaderOverride(const ClassLoader* class_loader_override) {
buzbeec143c552011-08-20 17:38:58 -0700334 class_loader_override_ = class_loader_override;
335 }
336
Ian Rogersaaa20802011-09-11 21:47:37 -0700337 // Create the internal representation of a stack trace, that is more time
338 // and space efficient to compute than the StackTraceElement[]
Elliott Hughes01158d72011-09-19 19:47:10 -0700339 jobject CreateInternalStackTrace(JNIEnv* env) const;
Ian Rogersaaa20802011-09-11 21:47:37 -0700340
Elliott Hughes01158d72011-09-19 19:47:10 -0700341 // Convert an internal stack trace representation (returned by CreateInternalStackTrace) to a
342 // StackTraceElement[]. If output_array is NULL, a new array is created, otherwise as many
343 // frames as will fit are written into the given array. If stack_depth is non-NULL, it's updated
344 // with the number of valid frames in the returned array.
345 static jobjectArray InternalStackTraceToStackTraceElementArray(JNIEnv* env, jobject internal,
346 jobjectArray output_array = NULL, int* stack_depth = NULL);
Shih-wei Liao55df06b2011-08-26 14:39:27 -0700347
Ian Rogersd6b1f612011-09-27 13:38:14 -0700348 void VisitRoots(Heap::RootVisitor* visitor, void* arg);
Elliott Hughes410c0c82011-09-01 17:58:25 -0700349
jeffhao25045522012-03-13 19:34:37 -0700350#if VERIFY_OBJECT_ENABLED
351 void VerifyStack();
352#else
353 void VerifyStack() {}
354#endif
355
Elliott Hughesbe759c62011-09-08 19:38:21 -0700356 //
357 // Offsets of various members of native Thread class, used by compiled code.
358 //
359
360 static ThreadOffset SelfOffset() {
361 return ThreadOffset(OFFSETOF_MEMBER(Thread, self_));
362 }
363
364 static ThreadOffset ExceptionOffset() {
365 return ThreadOffset(OFFSETOF_MEMBER(Thread, exception_));
366 }
367
Elliott Hughes54e7df12011-09-16 11:47:04 -0700368 static ThreadOffset ThinLockIdOffset() {
Elliott Hughesbe759c62011-09-08 19:38:21 -0700369 return ThreadOffset(OFFSETOF_MEMBER(Thread, thin_lock_id_));
370 }
371
372 static ThreadOffset CardTableOffset() {
373 return ThreadOffset(OFFSETOF_MEMBER(Thread, card_table_));
374 }
375
376 static ThreadOffset SuspendCountOffset() {
377 return ThreadOffset(OFFSETOF_MEMBER(Thread, suspend_count_));
378 }
379
380 static ThreadOffset StateOffset() {
Elliott Hughes93e74e82011-09-13 11:07:03 -0700381 return ThreadOffset(OFFSETOF_VOLATILE_MEMBER(Thread, state_));
Elliott Hughesbe759c62011-09-08 19:38:21 -0700382 }
383
Ian Rogers932746a2011-09-22 18:57:50 -0700384 // Size of stack less any space reserved for stack overflow
385 size_t GetStackSize() {
Ian Rogers30fab402012-01-23 15:43:46 -0800386 return stack_size_ - (stack_end_ - stack_begin_);
Ian Rogers932746a2011-09-22 18:57:50 -0700387 }
388
389 // Set the stack end to that to be used during a stack overflow
390 void SetStackEndForStackOverflow() {
391 // During stack overflow we allow use of the full stack
Ian Rogers30fab402012-01-23 15:43:46 -0800392 if (stack_end_ == stack_begin_) {
Elliott Hughes3b6baaa2011-10-14 19:13:56 -0700393 DumpStack(std::cerr);
394 LOG(FATAL) << "Need to increase kStackOverflowReservedBytes (currently "
395 << kStackOverflowReservedBytes << ")";
396 }
397
Ian Rogers30fab402012-01-23 15:43:46 -0800398 stack_end_ = stack_begin_;
Ian Rogers932746a2011-09-22 18:57:50 -0700399 }
400
401 // Set the stack end to that to be used during regular execution
402 void ResetDefaultStackEnd() {
403 // Our stacks grow down, so we want stack_end_ to be near there, but reserving enough room
404 // to throw a StackOverflowError.
Ian Rogers30fab402012-01-23 15:43:46 -0800405 stack_end_ = stack_begin_ + kStackOverflowReservedBytes;
Ian Rogers932746a2011-09-22 18:57:50 -0700406 }
407
Elliott Hughes449b4bd2011-09-09 12:01:38 -0700408 static ThreadOffset StackEndOffset() {
409 return ThreadOffset(OFFSETOF_MEMBER(Thread, stack_end_));
Elliott Hughesbe759c62011-09-08 19:38:21 -0700410 }
411
412 static ThreadOffset JniEnvOffset() {
413 return ThreadOffset(OFFSETOF_MEMBER(Thread, jni_env_));
414 }
415
416 static ThreadOffset TopOfManagedStackOffset() {
417 return ThreadOffset(OFFSETOF_MEMBER(Thread, top_of_managed_stack_) +
418 OFFSETOF_MEMBER(Frame, sp_));
419 }
420
Ian Rogersbdb03912011-09-14 00:55:44 -0700421 static ThreadOffset TopOfManagedStackPcOffset() {
422 return ThreadOffset(OFFSETOF_MEMBER(Thread, top_of_managed_stack_pc_));
423 }
424
Logan Chienf7ad17e2012-03-15 03:10:03 +0800425 void PushShadowFrame(ShadowFrame* frame);
426 ShadowFrame* PopShadowFrame();
427
Brian Carlstrom40381fb2011-10-19 14:13:40 -0700428 void PushSirt(StackIndirectReferenceTable* sirt);
429 StackIndirectReferenceTable* PopSirt();
430
Elliott Hughesbe759c62011-09-08 19:38:21 -0700431 static ThreadOffset TopSirtOffset() {
432 return ThreadOffset(OFFSETOF_MEMBER(Thread, top_sirt_));
433 }
434
Elliott Hughes530fa002012-03-12 11:44:49 -0700435 void WalkStack(StackVisitor* visitor, bool include_upcalls = false) const;
Shih-wei Liao9407c602011-09-16 10:36:43 -0700436
Elliott Hughes475fc232011-10-25 15:00:35 -0700437 DebugInvokeReq* GetInvokeReq() {
438 return debug_invoke_req_;
439 }
440
Elliott Hughesc0f09332012-03-26 13:27:06 -0700441 void SetDebuggerUpdatesEnabled(bool enabled);
442
jeffhaoe343b762011-12-05 16:36:44 -0800443 bool IsTraceStackEmpty() const {
444 return trace_stack_->empty();
445 }
446
jeffhaoa9ef3fd2011-12-13 18:33:43 -0800447 TraceStackFrame GetTraceStackFrame(uint32_t depth) const {
448 return trace_stack_->at(trace_stack_->size() - depth - 1);
449 }
450
jeffhaoe343b762011-12-05 16:36:44 -0800451 void PushTraceStackFrame(const TraceStackFrame& frame) {
452 trace_stack_->push_back(frame);
453 }
454
455 TraceStackFrame PopTraceStackFrame() {
456 TraceStackFrame frame = trace_stack_->back();
457 trace_stack_->pop_back();
458 return frame;
459 }
460
Elliott Hughesa4060e52012-03-02 16:51:35 -0800461 void CheckSafeToLockOrUnlock(MutexRank rank, bool is_locking);
462 void CheckSafeToWait(MutexRank rank);
Elliott Hughesffb465f2012-03-01 18:46:05 -0800463
Carl Shapiro0e5d75d2011-07-06 18:28:37 -0700464 private:
Elliott Hughesdcc24742011-09-07 14:02:44 -0700465 Thread();
Elliott Hughesc1674ed2011-08-25 18:09:09 -0700466 ~Thread();
Elliott Hughesc0f09332012-03-26 13:27:06 -0700467 void Destroy();
468 friend class ThreadList; // For ~Thread and Destroy.
Carl Shapiro0e5d75d2011-07-06 18:28:37 -0700469
Elliott Hughes462c9442012-03-23 18:47:50 -0700470 void CreatePeer(const char* name, bool as_daemon, Object* thread_group);
Elliott Hughes5fe594f2011-09-08 12:33:17 -0700471 friend class Runtime; // For CreatePeer.
472
Elliott Hughesd92bec42011-09-02 17:04:36 -0700473 void DumpState(std::ostream& os) const;
474 void DumpStack(std::ostream& os) const;
Elliott Hughesffb465f2012-03-01 18:46:05 -0800475 void DumpNativeStack(std::ostream& os) const;
Elliott Hughesd92bec42011-09-02 17:04:36 -0700476
Elliott Hughesaccd83d2011-10-17 14:25:58 -0700477 // Out-of-line conveniences for debugging in gdb.
Elliott Hughes498508c2011-10-17 14:58:22 -0700478 static Thread* CurrentFromGdb(); // Like Thread::Current.
Elliott Hughesaccd83d2011-10-17 14:25:58 -0700479 void DumpFromGdb() const; // Like Thread::Dump(std::cerr).
480
Elliott Hughes93e74e82011-09-13 11:07:03 -0700481 static void* CreateCallback(void* arg);
482
Elliott Hughesaccd83d2011-10-17 14:25:58 -0700483 void HandleUncaughtExceptions();
Brian Carlstrom4514d3c2011-10-21 17:01:31 -0700484 void RemoveFromThreadGroup();
Elliott Hughesaccd83d2011-10-17 14:25:58 -0700485
Elliott Hughes462c9442012-03-23 18:47:50 -0700486 void Init();
Ian Rogers5d76c432011-10-31 21:42:49 -0700487 void InitCardTable();
Ian Rogersb033c752011-07-20 12:22:35 -0700488 void InitCpu();
buzbee3ea4ec52011-08-22 17:37:19 -0700489 void InitFunctionPointers();
Brian Carlstromcaabb1b2011-10-11 18:09:13 -0700490 void InitTid();
Brian Carlstromcaabb1b2011-10-11 18:09:13 -0700491 void InitPthreadKeySelf();
Elliott Hughesbe759c62011-09-08 19:38:21 -0700492 void InitStackHwm();
493
Elliott Hughes5f791332011-09-15 17:45:30 -0700494 void NotifyLocked() {
495 if (wait_monitor_ != NULL) {
Elliott Hughes85d15452011-09-16 17:33:01 -0700496 wait_cond_->Signal();
Elliott Hughes5f791332011-09-15 17:45:30 -0700497 }
498 }
499
Elliott Hughesbe759c62011-09-08 19:38:21 -0700500 static void ThreadExitCallback(void* arg);
Ian Rogersb033c752011-07-20 12:22:35 -0700501
Elliott Hughesdcc24742011-09-07 14:02:44 -0700502 // Thin lock thread id. This is a small integer used by the thin lock implementation.
503 // This is not to be confused with the native thread's tid, nor is it the value returned
504 // by java.lang.Thread.getId --- this is a distinct value, used only for locking. One
505 // important difference between this id and the ids visible to managed code is that these
506 // ones get reused (to ensure that they fit in the number of bits available).
507 uint32_t thin_lock_id_;
Ian Rogersb033c752011-07-20 12:22:35 -0700508
Elliott Hughesd92bec42011-09-02 17:04:36 -0700509 // System thread id.
510 pid_t tid_;
511
Elliott Hughesdcc24742011-09-07 14:02:44 -0700512 // Our managed peer (an instance of java.lang.Thread).
Elliott Hughesd369bb72011-09-12 14:41:14 -0700513 Object* peer_;
Elliott Hughes8daa0922011-09-11 13:46:25 -0700514
Elliott Hughes8e4aac52011-09-26 17:03:36 -0700515 // The top_of_managed_stack_ and top_of_managed_stack_pc_ fields are accessed from
516 // compiled code, so we keep them early in the structure to (a) avoid having to keep
517 // fixing the assembler offsets and (b) improve the chances that these will still be aligned.
518
519 // Top of the managed stack, written out prior to the state transition from
Elliott Hughes68e76522011-10-05 13:22:16 -0700520 // kRunnable to kNative. Uses include giving the starting point for scanning
Elliott Hughes8e4aac52011-09-26 17:03:36 -0700521 // a managed stack when a thread is in native code.
522 Frame top_of_managed_stack_;
523 // PC corresponding to the call out of the top_of_managed_stack_ frame
524 uintptr_t top_of_managed_stack_pc_;
525
Elliott Hughes8daa0922011-09-11 13:46:25 -0700526 // Guards the 'interrupted_' and 'wait_monitor_' members.
Elliott Hughes85d15452011-09-16 17:33:01 -0700527 mutable Mutex* wait_mutex_;
528 ConditionVariable* wait_cond_;
Elliott Hughes8daa0922011-09-11 13:46:25 -0700529 // Pointer to the monitor lock we're currently waiting on (or NULL), guarded by wait_mutex_.
530 Monitor* wait_monitor_;
531 // Thread "interrupted" status; stays raised until queried or thrown, guarded by wait_mutex_.
Elliott Hughes8e4aac52011-09-26 17:03:36 -0700532 uint32_t interrupted_;
Elliott Hughes5f791332011-09-15 17:45:30 -0700533 // The next thread in the wait set this thread is part of.
534 Thread* wait_next_;
Elliott Hughes8e4aac52011-09-26 17:03:36 -0700535 // If we're blocked in MonitorEnter, this is the object we're trying to lock.
536 Object* monitor_enter_object_;
Elliott Hughes5f791332011-09-15 17:45:30 -0700537
538 friend class Monitor;
Elliott Hughesdcc24742011-09-07 14:02:44 -0700539
Elliott Hughes9d5ccec2011-09-19 13:19:50 -0700540 RuntimeStats stats_;
541
Ian Rogers5d76c432011-10-31 21:42:49 -0700542 // The biased card table, see CardTable for details
543 byte* card_table_;
buzbeec143c552011-08-20 17:38:58 -0700544
Elliott Hughes449b4bd2011-09-09 12:01:38 -0700545 // The end of this thread's stack. This is the lowest safely-addressable address on the stack.
546 // We leave extra space so there's room for the code that throws StackOverflowError.
547 byte* stack_end_;
Elliott Hughesbe759c62011-09-08 19:38:21 -0700548
Ian Rogers932746a2011-09-22 18:57:50 -0700549 // Size of the stack
550 size_t stack_size_;
551
552 // The "lowest addressable byte" of the stack
Ian Rogers30fab402012-01-23 15:43:46 -0800553 byte* stack_begin_;
Ian Rogers932746a2011-09-22 18:57:50 -0700554
Ian Rogers6de08602011-08-19 14:52:39 -0700555 // A linked list (of stack allocated records) recording transitions from
556 // native to managed code.
557 NativeToManagedRecord* native_to_managed_record_;
558
Ian Rogers408f79a2011-08-23 18:22:33 -0700559 // Top of linked list of stack indirect reference tables or NULL for none
560 StackIndirectReferenceTable* top_sirt_;
Ian Rogersb033c752011-07-20 12:22:35 -0700561
Logan Chienf7ad17e2012-03-15 03:10:03 +0800562 // Top of linked list of shadow stack or NULL for none
563 // Some backend may require shadow frame to ease the GC work.
564 ShadowFrame* top_shadow_frame_;
565
Ian Rogersb033c752011-07-20 12:22:35 -0700566 // Every thread may have an associated JNI environment
Elliott Hughes69f5bc62011-08-24 09:26:14 -0700567 JNIEnvExt* jni_env_;
Ian Rogersb033c752011-07-20 12:22:35 -0700568
Elliott Hughes93e74e82011-09-13 11:07:03 -0700569 volatile State state_;
Carl Shapirob5573532011-07-12 18:22:59 -0700570
Carl Shapiro69759ea2011-07-21 18:13:35 -0700571 // Initialized to "this". On certain architectures (such as x86) reading
572 // off of Thread::Current is easy but getting the address of Thread::Current
573 // is hard. This field can be read off of Thread::Current to give the address.
574 Thread* self_;
575
576 Runtime* runtime_;
577
578 // The pending exception or NULL.
Elliott Hughese5b0dc82011-08-23 09:59:02 -0700579 Throwable* exception_;
Carl Shapiro0e5d75d2011-07-06 18:28:37 -0700580
Ian Rogers45a76cb2011-07-21 22:00:15 -0700581 // A non-zero value is used to tell the current thread to enter a safe point
582 // at the next poll.
583 int suspend_count_;
Elliott Hughes234ab152011-10-26 14:02:26 -0700584 // How much of 'suspend_count_' is by request of the debugger, used to set things right
585 // when the debugger detaches. Must be <= suspend_count_.
586 int debug_suspend_count_;
Ian Rogers45a76cb2011-07-21 22:00:15 -0700587
Elliott Hughesedcc09c2011-08-21 18:47:05 -0700588 // Needed to get the right ClassLoader in JNI_OnLoad, but also
589 // useful for testing.
Brian Carlstrombffb1552011-08-25 12:23:53 -0700590 const ClassLoader* class_loader_override_;
buzbeec143c552011-08-20 17:38:58 -0700591
Ian Rogersbdb03912011-09-14 00:55:44 -0700592 // Thread local, lazily allocated, long jump context. Used to deliver exceptions.
Elliott Hughes85d15452011-09-16 17:33:01 -0700593 Context* long_jump_context_;
Ian Rogersbdb03912011-09-14 00:55:44 -0700594
Elliott Hughes418dfe72011-10-06 18:56:27 -0700595 // A boolean telling us whether we're recursively throwing OOME.
Elliott Hughes726079d2011-10-07 18:43:44 -0700596 uint32_t throwing_OutOfMemoryError_;
597
598 Throwable* pre_allocated_OutOfMemoryError_;
Elliott Hughes418dfe72011-10-06 18:56:27 -0700599
Elliott Hughes475fc232011-10-25 15:00:35 -0700600 // JDWP invoke-during-breakpoint support.
601 DebugInvokeReq* debug_invoke_req_;
602
Elliott Hughes81ff3182012-03-23 20:35:56 -0700603 // TLS key used to retrieve the Thread*.
Carl Shapirob5573532011-07-12 18:22:59 -0700604 static pthread_key_t pthread_key_self_;
605
jeffhaoe343b762011-12-05 16:36:44 -0800606 // Additional stack used by method tracer to store method and return pc values.
607 // Stored as a pointer since std::vector is not PACKED.
608 std::vector<TraceStackFrame>* trace_stack_;
609
Elliott Hughes899e7892012-01-24 14:57:32 -0800610 // A cached copy of the java.lang.Thread's name.
611 std::string* name_;
612
Elliott Hughesffb465f2012-03-01 18:46:05 -0800613 uint32_t held_mutexes_[kMaxMutexRank + 1];
614
Ian Rogersa32a6fd2012-02-06 20:18:44 -0800615 public:
616 // Runtime support function pointers
617 void (*pDebugMe)(Method*, uint32_t);
618 void* (*pMemcpy)(void*, const void*, size_t);
619 uint64_t (*pShlLong)(uint64_t, uint32_t);
620 uint64_t (*pShrLong)(uint64_t, uint32_t);
621 uint64_t (*pUshrLong)(uint64_t, uint32_t);
622 float (*pI2f)(int);
623 int (*pF2iz)(float);
624 float (*pD2f)(double);
625 double (*pF2d)(float);
626 double (*pI2d)(int);
627 int (*pD2iz)(double);
Ian Rogersc6f3bb82012-03-21 20:40:33 -0700628 float (*pL2f)(int64_t);
629 double (*pL2d)(int64_t);
630 int64_t (*pF2l)(float);
631 int64_t (*pD2l)(double);
Ian Rogersa32a6fd2012-02-06 20:18:44 -0800632 float (*pFadd)(float, float);
633 float (*pFsub)(float, float);
634 float (*pFdiv)(float, float);
635 float (*pFmul)(float, float);
636 float (*pFmodf)(float, float);
637 double (*pDadd)(double, double);
638 double (*pDsub)(double, double);
639 double (*pDdiv)(double, double);
640 double (*pDmul)(double, double);
641 double (*pFmod)(double, double);
642 int (*pIdivmod)(int, int);
643 int (*pIdiv)(int, int);
Ian Rogersc6f3bb82012-03-21 20:40:33 -0700644 int64_t (*pLadd)(int64_t, int64_t);
645 int64_t (*pLsub)(int64_t, int64_t);
646 int64_t (*pLand)(int64_t, int64_t);
647 int64_t (*pLor)(int64_t, int64_t);
648 int64_t (*pLxor)(int64_t, int64_t);
649 int64_t (*pLmul)(int64_t, int64_t);
650 int64_t (*pLdivmod)(int64_t, int64_t);
Ian Rogersa32a6fd2012-02-06 20:18:44 -0800651 void (*pCheckSuspendFromCode)(Thread*); // Stub that is called when the suspend count is non-zero
652 void (*pTestSuspendFromCode)(); // Stub that is periodically called to test the suspend count
653 void* (*pAllocObjectFromCode)(uint32_t, void*);
654 void* (*pAllocObjectFromCodeWithAccessCheck)(uint32_t, void*);
655 void* (*pAllocArrayFromCode)(uint32_t, void*, int32_t);
656 void* (*pAllocArrayFromCodeWithAccessCheck)(uint32_t, void*, int32_t);
657 void (*pCanPutArrayElementFromCode)(void*, void*);
658 void* (*pCheckAndAllocArrayFromCode)(uint32_t, void*, int32_t);
659 void* (*pCheckAndAllocArrayFromCodeWithAccessCheck)(uint32_t, void*, int32_t);
660 void (*pCheckCastFromCode)(void*, void*);
661 Object* (*pDecodeJObjectInThread)(Thread* thread, jobject obj);
662 void (*pDeliverException)(void*);
663 Method* (*pFindInterfaceMethodInCache)(Class*, uint32_t, const Method*, struct DvmDex*);
664 void* (*pFindNativeMethod)(Thread* thread);
665 int32_t (*pGet32Instance)(uint32_t, void*);
666 int64_t (*pGet64Instance)(uint32_t, void*);
667 void* (*pGetObjInstance)(uint32_t, void*);
668 int32_t (*pGet32Static)(uint32_t);
669 int64_t (*pGet64Static)(uint32_t);
670 void* (*pGetObjStatic)(uint32_t);
671 void (*pHandleFillArrayDataFromCode)(void*, void*);
672 void* (*pInitializeStaticStorage)(uint32_t, void*);
673 uint32_t (*pInstanceofNonTrivialFromCode)(const Class*, const Class*);
Ian Rogersc8b306f2012-02-17 21:34:44 -0800674 void (*pInvokeDirectTrampolineWithAccessCheck)(uint32_t, void*);
Ian Rogersa32a6fd2012-02-06 20:18:44 -0800675 void (*pInvokeInterfaceTrampoline)(uint32_t, void*);
676 void (*pInvokeInterfaceTrampolineWithAccessCheck)(uint32_t, void*);
Ian Rogersc8b306f2012-02-17 21:34:44 -0800677 void (*pInvokeStaticTrampolineWithAccessCheck)(uint32_t, void*);
Ian Rogersa32a6fd2012-02-06 20:18:44 -0800678 void (*pInvokeSuperTrampolineWithAccessCheck)(uint32_t, void*);
679 void (*pInvokeVirtualTrampolineWithAccessCheck)(uint32_t, void*);
680 void* (*pInitializeTypeFromCode)(uint32_t, void*);
681 void* (*pInitializeTypeAndVerifyAccessFromCode)(uint32_t, void*);
682 void (*pLockObjectFromCode)(void*);
Ian Rogersa32a6fd2012-02-06 20:18:44 -0800683 void* (*pResolveStringFromCode)(void*, uint32_t);
684 int (*pSet32Instance)(uint32_t, void*, int32_t); // field_idx, obj, src
685 int (*pSet64Instance)(uint32_t, void*, int64_t);
686 int (*pSetObjInstance)(uint32_t, void*, void*);
687 int (*pSet32Static)(uint32_t, int32_t);
688 int (*pSet64Static)(uint32_t, int64_t);
689 int (*pSetObjStatic)(uint32_t, void*);
690 void (*pThrowStackOverflowFromCode)(void*);
691 void (*pThrowNullPointerFromCode)();
692 void (*pThrowArrayBoundsFromCode)(int32_t, int32_t);
693 void (*pThrowDivZeroFromCode)();
694 void (*pThrowVerificationErrorFromCode)(int32_t, int32_t);
695 void (*pThrowNegArraySizeFromCode)(int32_t);
696 void (*pThrowNoSuchMethodFromCode)(int32_t);
697 void (*pThrowAbstractMethodErrorFromCode)(Method* method, Thread* thread, Method** sp);
698 void (*pUnlockObjectFromCode)(void*);
Ian Rogers19846512012-02-24 11:42:47 -0800699 const void* (*pUnresolvedDirectMethodTrampolineFromCode)(Method*, Method**, Thread*,
700 Runtime::TrampolineType);
Ian Rogersa32a6fd2012-02-06 20:18:44 -0800701 void (*pUpdateDebuggerFromCode)(void*, void*, int32_t, void*);
Bill Buzbee11f9d212012-03-03 20:03:18 -0800702 bool (*pCmplFloat)(float, float);
703 bool (*pCmpgFloat)(float, float);
704 bool (*pCmplDouble)(double, double);
705 bool (*pCmpgDouble)(double, double);
buzbeefc9e6fa2012-03-23 15:14:29 -0700706 int (*pIndexOf)(void*, uint32_t, uint32_t, uint32_t);
707 int (*pStringCompareTo)(void*, void*);
708 int (*pMemcmp16)(void*, void*, int32_t);
Ian Rogersa32a6fd2012-02-06 20:18:44 -0800709
710 private:
Carl Shapiro0e5d75d2011-07-06 18:28:37 -0700711 DISALLOW_COPY_AND_ASSIGN(Thread);
712};
Ian Rogersbdb03912011-09-14 00:55:44 -0700713
Elliott Hughes330304d2011-08-12 14:28:05 -0700714std::ostream& operator<<(std::ostream& os, const Thread& thread);
Ian Rogersb033c752011-07-20 12:22:35 -0700715std::ostream& operator<<(std::ostream& os, const Thread::State& state);
Carl Shapiro0e5d75d2011-07-06 18:28:37 -0700716
Elliott Hughesad7c2a32011-08-31 11:58:10 -0700717class ScopedThreadStateChange {
718 public:
719 ScopedThreadStateChange(Thread* thread, Thread::State new_state) : thread_(thread) {
720 old_thread_state_ = thread_->SetState(new_state);
721 }
722
723 ~ScopedThreadStateChange() {
724 thread_->SetState(old_thread_state_);
725 }
726
727 private:
728 Thread* thread_;
729 Thread::State old_thread_state_;
730 DISALLOW_COPY_AND_ASSIGN(ScopedThreadStateChange);
731};
732
Carl Shapiro0e5d75d2011-07-06 18:28:37 -0700733} // namespace art
734
735#endif // ART_SRC_THREAD_H_