blob: 9de105e6b56c0e6eff48c7d454743196a22b7b0c [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 Hughesfc1d9f52012-03-27 15:45:56 -070067 // Thread priorities. These must match the Thread.MIN_PRIORITY,
68 // Thread.NORM_PRIORITY, and Thread.MAX_PRIORITY constants.
Elliott Hughes8daa0922011-09-11 13:46:25 -070069 enum Priority {
70 kMinPriority = 1,
71 kNormPriority = 5,
72 kMaxPriority = 10,
73 };
Elliott Hughesfc1d9f52012-03-27 15:45:56 -070074
75 // Thread states. These must match Thread.STATE_MAP.
Carl Shapirob5573532011-07-12 18:22:59 -070076 enum State {
Elliott Hughes499c5132011-11-17 14:55:11 -080077 // These correspond to JDWP states (but needn't share the same values).
78 kTerminated = 0, // TS_ZOMBIE
79 kRunnable = 1, // TS_RUNNING
Elliott Hughes3ce4b262012-02-24 11:24:02 -080080 kTimedWaiting = 2, // TS_WAIT in Object.wait() with a timeout
Elliott Hughes499c5132011-11-17 14:55:11 -080081 kBlocked = 3, // TS_MONITOR on a monitor
82 kWaiting = 4, // TS_WAIT in Object.wait()
Elliott Hughes93e74e82011-09-13 11:07:03 -070083 // Non-JDWP states.
Elliott Hughesc0f09332012-03-26 13:27:06 -070084 kStarting = 5, // native thread started, not yet ready to run managed code
85 kNative = 6, // off in a JNI native method
86 kVmWait = 7, // waiting on an internal runtime resource
87 kSuspended = 8, // suspended, usually by GC or debugger
Carl Shapirob5573532011-07-12 18:22:59 -070088 };
89
Ian Rogers932746a2011-09-22 18:57:50 -070090 // Space to throw a StackOverflowError in.
Brian Carlstromaded5f72011-10-07 17:15:04 -070091 static const size_t kStackOverflowReservedBytes = 4 * KB;
buzbeec143c552011-08-20 17:38:58 -070092
Brian Carlstrom72db0d72011-11-10 17:58:56 -080093 static const size_t kDefaultStackSize = 96 * KB;
Carl Shapiro61e019d2011-07-14 16:53:09 -070094
Shih-wei Liao9b576b42011-08-29 01:45:07 -070095 class StackVisitor {
96 public:
Ian Rogers0cfe1fb2011-08-26 03:29:44 -070097 virtual ~StackVisitor() {}
Elliott Hughes530fa002012-03-12 11:44:49 -070098 // Return 'true' if we should continue to visit more frames, 'false' to stop.
99 virtual bool VisitFrame(const Frame& frame, uintptr_t pc) = 0;
Shih-wei Liao9b576b42011-08-29 01:45:07 -0700100 };
101
Elliott Hughes462c9442012-03-23 18:47:50 -0700102 // Creates a new native thread corresponding to the given managed peer.
103 // Used to implement Thread.start.
Elliott Hughesd369bb72011-09-12 14:41:14 -0700104 static void Create(Object* peer, size_t stack_size);
Carl Shapiro61e019d2011-07-14 16:53:09 -0700105
Elliott Hughes462c9442012-03-23 18:47:50 -0700106 // Attaches the calling native thread to the runtime, returning the new native peer.
107 // Used to implement JNI AttachCurrentThread and AttachCurrentThreadAsDaemon calls.
108 static Thread* Attach(const char* thread_name, bool as_daemon, Object* thread_group);
Carl Shapirob5573532011-07-12 18:22:59 -0700109
Brian Carlstromcaabb1b2011-10-11 18:09:13 -0700110 // Reset internal state of child thread after fork.
111 void InitAfterFork();
112
Carl Shapirob5573532011-07-12 18:22:59 -0700113 static Thread* Current() {
Carl Shapirod0e7e772011-07-15 14:31:01 -0700114 void* thread = pthread_getspecific(Thread::pthread_key_self_);
115 return reinterpret_cast<Thread*>(thread);
Carl Shapiro0e5d75d2011-07-06 18:28:37 -0700116 }
117
Elliott Hughes761928d2011-11-16 18:33:03 -0800118 static Thread* FromManagedThread(Object* thread_peer);
Elliott Hughes01158d72011-09-19 19:47:10 -0700119 static Thread* FromManagedThread(JNIEnv* env, jobject thread);
Elliott Hughes8e4aac52011-09-26 17:03:36 -0700120 static uint32_t LockOwnerFromThreadLock(Object* thread_lock);
Elliott Hughes8daa0922011-09-11 13:46:25 -0700121
Elliott Hughes899e7892012-01-24 14:57:32 -0800122 // When full == true, dumps the detailed thread state and the thread stack (used for SIGQUIT).
123 // When full == false, dumps a one-line summary of thread state (used for operator<<).
124 void Dump(std::ostream& os, bool full = true) const;
Elliott Hughesa0957642011-09-02 14:27:33 -0700125
Ian Rogers0cfe1fb2011-08-26 03:29:44 -0700126 State GetState() const {
127 return state_;
128 }
129
Elliott Hughes8d768a92011-09-14 16:35:25 -0700130 State SetState(State new_state);
Elliott Hughesa4060e52012-03-02 16:51:35 -0800131 void SetStateWithoutSuspendCheck(State new_state);
Elliott Hughes8d768a92011-09-14 16:35:25 -0700132
Elliott Hughes038a8062011-09-18 14:12:41 -0700133 bool IsDaemon();
Elliott Hughes761928d2011-11-16 18:33:03 -0800134 bool IsSuspended();
Elliott Hughes038a8062011-09-18 14:12:41 -0700135
Elliott Hughes8d768a92011-09-14 16:35:25 -0700136 void WaitUntilSuspended();
Ian Rogers0cfe1fb2011-08-26 03:29:44 -0700137
Elliott Hughes5f791332011-09-15 17:45:30 -0700138 bool HoldsLock(Object*);
139
Elliott Hughes8daa0922011-09-11 13:46:25 -0700140 /*
141 * Changes the priority of this thread to match that of the java.lang.Thread object.
142 *
143 * We map a priority value from 1-10 to Linux "nice" values, where lower
144 * numbers indicate higher priority.
145 */
146 void SetNativePriority(int newPriority);
147
148 /*
149 * Returns the thread priority for the current thread by querying the system.
150 * This is useful when attaching a thread through JNI.
151 *
152 * Returns a value from 1 to 10 (compatible with java.lang.Thread values).
153 */
154 static int GetNativePriority();
155
Elliott Hughes462c9442012-03-23 18:47:50 -0700156 // Returns the "main" ThreadGroup, used when attaching user threads.
157 static Object* GetMainThreadGroup();
158 // Returns the "system" ThreadGroup, used when attaching our internal threads.
159 static Object* GetSystemThreadGroup();
160
Ian Rogers0cfe1fb2011-08-26 03:29:44 -0700161 bool CanAccessDirectReferences() const {
Brian Carlstromcaabb1b2011-10-11 18:09:13 -0700162#ifdef MOVING_GARBAGE_COLLECTOR
Elliott Hughesa59d1792011-09-04 18:42:35 -0700163 // TODO: when we have a moving collector, we'll need: return state_ == kRunnable;
Brian Carlstromcaabb1b2011-10-11 18:09:13 -0700164#endif
Elliott Hughesa59d1792011-09-04 18:42:35 -0700165 return true;
Ian Rogers0cfe1fb2011-08-26 03:29:44 -0700166 }
167
Elliott Hughesdcc24742011-09-07 14:02:44 -0700168 uint32_t GetThinLockId() const {
169 return thin_lock_id_;
Carl Shapirob5573532011-07-12 18:22:59 -0700170 }
171
Elliott Hughesd92bec42011-09-02 17:04:36 -0700172 pid_t GetTid() const {
173 return tid_;
174 }
Elliott Hughese27955c2011-08-26 15:21:24 -0700175
Elliott Hughesffb465f2012-03-01 18:46:05 -0800176 // Returns the java.lang.Thread's name, or NULL if this Thread* doesn't have a peer.
Elliott Hughes899e7892012-01-24 14:57:32 -0800177 String* GetThreadName() const;
178
Elliott Hughesffb465f2012-03-01 18:46:05 -0800179 // Sets 'name' to the java.lang.Thread's name. This requires no transition to managed code,
180 // allocation, or locking.
181 void GetThreadName(std::string& name) const;
182
Elliott Hughes899e7892012-01-24 14:57:32 -0800183 // Sets the thread's name.
184 void SetThreadName(const char* name);
Elliott Hughesfc861622011-10-17 17:57:47 -0700185
Elliott Hughesd369bb72011-09-12 14:41:14 -0700186 Object* GetPeer() const {
Elliott Hughes8daa0922011-09-11 13:46:25 -0700187 return peer_;
188 }
189
Elliott Hughesa2155262011-11-16 16:26:58 -0800190 Object* GetThreadGroup() const;
191
Elliott Hughes9d5ccec2011-09-19 13:19:50 -0700192 RuntimeStats* GetStats() {
193 return &stats_;
194 }
195
Elliott Hughesd07986f2011-12-06 18:27:45 -0800196 int GetSuspendCount() const {
197 return suspend_count_;
198 }
Ian Rogers0cfe1fb2011-08-26 03:29:44 -0700199
Elliott Hughesd07986f2011-12-06 18:27:45 -0800200 // Returns the current Method* and native PC (not dex PC) for this thread.
201 Method* GetCurrentMethod(uintptr_t* pc = NULL, Method*** sp = NULL) const;
jeffhao33dc7712011-11-09 17:54:24 -0800202
Carl Shapiro0e5d75d2011-07-06 18:28:37 -0700203 bool IsExceptionPending() const {
Elliott Hughesb20a5542011-08-12 18:03:12 -0700204 return exception_ != NULL;
Carl Shapiro0e5d75d2011-07-06 18:28:37 -0700205 }
206
Elliott Hughese5b0dc82011-08-23 09:59:02 -0700207 Throwable* GetException() const {
Ian Rogers0cfe1fb2011-08-26 03:29:44 -0700208 DCHECK(CanAccessDirectReferences());
Carl Shapiro0e5d75d2011-07-06 18:28:37 -0700209 return exception_;
210 }
211
Ian Rogers0cfe1fb2011-08-26 03:29:44 -0700212 void SetException(Throwable* new_exception) {
213 DCHECK(CanAccessDirectReferences());
214 CHECK(new_exception != NULL);
215 // TODO: CHECK(exception_ == NULL);
216 exception_ = new_exception; // TODO
217 }
218
219 void ClearException() {
220 exception_ = NULL;
Elliott Hughesa0957642011-09-02 14:27:33 -0700221 }
222
Ian Rogersbdb03912011-09-14 00:55:44 -0700223 // Find catch block and perform long jump to appropriate exception handle
Ian Rogersff1ed472011-09-20 13:46:24 -0700224 void DeliverException();
Ian Rogersbdb03912011-09-14 00:55:44 -0700225
226 Context* GetLongJumpContext();
227
Shih-wei Liao1a18c8c2011-08-14 17:47:36 -0700228 Frame GetTopOfStack() const {
229 return top_of_managed_stack_;
230 }
231
232 // TODO: this is here for testing, remove when we have exception unit tests
233 // that use the real stack
Ian Rogersbdb03912011-09-14 00:55:44 -0700234 void SetTopOfStack(void* stack, uintptr_t pc) {
Ian Rogers0cfe1fb2011-08-26 03:29:44 -0700235 top_of_managed_stack_.SetSP(reinterpret_cast<Method**>(stack));
Ian Rogersbdb03912011-09-14 00:55:44 -0700236 top_of_managed_stack_pc_ = pc;
Carl Shapiro0e5d75d2011-07-06 18:28:37 -0700237 }
238
Ian Rogersbdb03912011-09-14 00:55:44 -0700239 void SetTopOfStackPC(uintptr_t pc) {
240 top_of_managed_stack_pc_ = pc;
241 }
242
Elliott Hughes5cb5ad22011-10-02 12:13:39 -0700243 // 'msg' may be NULL.
244 void ThrowNewException(const char* exception_class_descriptor, const char* msg);
245
246 void ThrowNewExceptionF(const char* exception_class_descriptor, const char* fmt, ...)
Elliott Hughes362f9bc2011-10-17 18:56:41 -0700247 __attribute__((format(printf, 3, 4)));
Elliott Hughesa5b897e2011-08-16 11:33:06 -0700248
Elliott Hughes4a2b4172011-09-20 17:08:25 -0700249 void ThrowNewExceptionV(const char* exception_class_descriptor, const char* fmt, va_list ap);
250
Elliott Hughes2ced6a52011-10-16 18:44:48 -0700251 // OutOfMemoryError is special, because we need to pre-allocate an instance.
252 void ThrowOutOfMemoryError(const char* msg);
Elliott Hughes418dfe72011-10-06 18:56:27 -0700253 void ThrowOutOfMemoryError(Class* c, size_t byte_count);
Elliott Hughes79082e32011-08-25 12:07:32 -0700254
Shih-wei Liao1a18c8c2011-08-14 17:47:36 -0700255 Frame FindExceptionHandler(void* throw_pc, void** handler_pc);
256
257 void* FindExceptionHandlerInMethod(const Method* method,
258 void* throw_pc,
259 const DexFile& dex_file,
260 ClassLinker* class_linker);
buzbeec143c552011-08-20 17:38:58 -0700261
Elliott Hughesbe759c62011-09-08 19:38:21 -0700262 static void Startup();
Elliott Hughes038a8062011-09-18 14:12:41 -0700263 static void FinishStartup();
Elliott Hughesc1674ed2011-08-25 18:09:09 -0700264 static void Shutdown();
Carl Shapirob5573532011-07-12 18:22:59 -0700265
Ian Rogersb033c752011-07-20 12:22:35 -0700266 // JNI methods
Elliott Hughes69f5bc62011-08-24 09:26:14 -0700267 JNIEnvExt* GetJniEnv() const {
Ian Rogersb033c752011-07-20 12:22:35 -0700268 return jni_env_;
269 }
270
TDYa12728f1a142012-03-15 21:51:52 -0700271 // Number of references in SIRTs on this thread
Ian Rogers408f79a2011-08-23 18:22:33 -0700272 size_t NumSirtReferences();
Ian Rogersa8cd9f42011-08-19 16:43:41 -0700273
TDYa12728f1a142012-03-15 21:51:52 -0700274 // Number of references allocated in ShadowFrames on this thread
275 size_t NumShadowFrameReferences();
276
277 // Number of references allocated in SIRTs & shadow frames on this thread
278 size_t NumStackReferences() {
279 return NumSirtReferences() + NumShadowFrameReferences();
280 };
281
Ian Rogers408f79a2011-08-23 18:22:33 -0700282 // Is the given obj in this thread's stack indirect reference table?
283 bool SirtContains(jobject obj);
284
TDYa12728f1a142012-03-15 21:51:52 -0700285 // Is the given obj in this thread's ShadowFrame?
286 bool ShadowFrameContains(jobject obj);
287
288 // Is the given obj in this thread's Sirts & ShadowFrames?
289 bool StackReferencesContain(jobject obj);
290
Shih-wei Liao8dfc9d52011-09-28 18:06:15 -0700291 void SirtVisitRoots(Heap::RootVisitor* visitor, void* arg);
292
Logan Chienf7ad17e2012-03-15 03:10:03 +0800293 void ShadowFrameVisitRoots(Heap::RootVisitor* visitor, void* arg);
294
Ian Rogers408f79a2011-08-23 18:22:33 -0700295 // Convert a jobject into a Object*
296 Object* DecodeJObject(jobject obj);
Ian Rogersb033c752011-07-20 12:22:35 -0700297
Elliott Hughes8daa0922011-09-11 13:46:25 -0700298 // Implements java.lang.Thread.interrupted.
299 bool Interrupted() {
Elliott Hughes85d15452011-09-16 17:33:01 -0700300 MutexLock mu(*wait_mutex_);
Elliott Hughes8daa0922011-09-11 13:46:25 -0700301 bool interrupted = interrupted_;
302 interrupted_ = false;
303 return interrupted;
304 }
305
306 // Implements java.lang.Thread.isInterrupted.
307 bool IsInterrupted() {
Elliott Hughes85d15452011-09-16 17:33:01 -0700308 MutexLock mu(*wait_mutex_);
Elliott Hughes8daa0922011-09-11 13:46:25 -0700309 return interrupted_;
310 }
311
Elliott Hughes5f791332011-09-15 17:45:30 -0700312 void Interrupt() {
Elliott Hughes85d15452011-09-16 17:33:01 -0700313 MutexLock mu(*wait_mutex_);
Elliott Hughes5f791332011-09-15 17:45:30 -0700314 if (interrupted_) {
315 return;
316 }
317 interrupted_ = true;
318 NotifyLocked();
319 }
320
321 void Notify() {
Elliott Hughes85d15452011-09-16 17:33:01 -0700322 MutexLock mu(*wait_mutex_);
Elliott Hughes5f791332011-09-15 17:45:30 -0700323 NotifyLocked();
324 }
325
Ian Rogers6de08602011-08-19 14:52:39 -0700326 // Linked list recording transitions from native to managed code
Ian Rogersb04f69f2011-10-17 00:40:54 -0700327 void PushNativeToManagedRecord(NativeToManagedRecord* record);
328 void PopNativeToManagedRecord(const NativeToManagedRecord& record);
Ian Rogers6de08602011-08-19 14:52:39 -0700329
Brian Carlstrombffb1552011-08-25 12:23:53 -0700330 const ClassLoader* GetClassLoaderOverride() {
Ian Rogers0cfe1fb2011-08-26 03:29:44 -0700331 // TODO: need to place the class_loader_override_ in a handle
332 // DCHECK(CanAccessDirectReferences());
buzbeec143c552011-08-20 17:38:58 -0700333 return class_loader_override_;
334 }
335
Brian Carlstrombffb1552011-08-25 12:23:53 -0700336 void SetClassLoaderOverride(const ClassLoader* class_loader_override) {
buzbeec143c552011-08-20 17:38:58 -0700337 class_loader_override_ = class_loader_override;
338 }
339
Ian Rogersaaa20802011-09-11 21:47:37 -0700340 // Create the internal representation of a stack trace, that is more time
341 // and space efficient to compute than the StackTraceElement[]
Elliott Hughes01158d72011-09-19 19:47:10 -0700342 jobject CreateInternalStackTrace(JNIEnv* env) const;
Ian Rogersaaa20802011-09-11 21:47:37 -0700343
Elliott Hughes01158d72011-09-19 19:47:10 -0700344 // Convert an internal stack trace representation (returned by CreateInternalStackTrace) to a
345 // StackTraceElement[]. If output_array is NULL, a new array is created, otherwise as many
346 // frames as will fit are written into the given array. If stack_depth is non-NULL, it's updated
347 // with the number of valid frames in the returned array.
348 static jobjectArray InternalStackTraceToStackTraceElementArray(JNIEnv* env, jobject internal,
349 jobjectArray output_array = NULL, int* stack_depth = NULL);
Shih-wei Liao55df06b2011-08-26 14:39:27 -0700350
Ian Rogersd6b1f612011-09-27 13:38:14 -0700351 void VisitRoots(Heap::RootVisitor* visitor, void* arg);
Elliott Hughes410c0c82011-09-01 17:58:25 -0700352
jeffhao25045522012-03-13 19:34:37 -0700353#if VERIFY_OBJECT_ENABLED
354 void VerifyStack();
355#else
356 void VerifyStack() {}
357#endif
358
Elliott Hughesbe759c62011-09-08 19:38:21 -0700359 //
360 // Offsets of various members of native Thread class, used by compiled code.
361 //
362
363 static ThreadOffset SelfOffset() {
364 return ThreadOffset(OFFSETOF_MEMBER(Thread, self_));
365 }
366
367 static ThreadOffset ExceptionOffset() {
368 return ThreadOffset(OFFSETOF_MEMBER(Thread, exception_));
369 }
370
Elliott Hughes54e7df12011-09-16 11:47:04 -0700371 static ThreadOffset ThinLockIdOffset() {
Elliott Hughesbe759c62011-09-08 19:38:21 -0700372 return ThreadOffset(OFFSETOF_MEMBER(Thread, thin_lock_id_));
373 }
374
375 static ThreadOffset CardTableOffset() {
376 return ThreadOffset(OFFSETOF_MEMBER(Thread, card_table_));
377 }
378
379 static ThreadOffset SuspendCountOffset() {
380 return ThreadOffset(OFFSETOF_MEMBER(Thread, suspend_count_));
381 }
382
383 static ThreadOffset StateOffset() {
Elliott Hughes93e74e82011-09-13 11:07:03 -0700384 return ThreadOffset(OFFSETOF_VOLATILE_MEMBER(Thread, state_));
Elliott Hughesbe759c62011-09-08 19:38:21 -0700385 }
386
Ian Rogers932746a2011-09-22 18:57:50 -0700387 // Size of stack less any space reserved for stack overflow
388 size_t GetStackSize() {
Ian Rogers30fab402012-01-23 15:43:46 -0800389 return stack_size_ - (stack_end_ - stack_begin_);
Ian Rogers932746a2011-09-22 18:57:50 -0700390 }
391
392 // Set the stack end to that to be used during a stack overflow
393 void SetStackEndForStackOverflow() {
394 // During stack overflow we allow use of the full stack
Ian Rogers30fab402012-01-23 15:43:46 -0800395 if (stack_end_ == stack_begin_) {
Elliott Hughes3b6baaa2011-10-14 19:13:56 -0700396 DumpStack(std::cerr);
397 LOG(FATAL) << "Need to increase kStackOverflowReservedBytes (currently "
398 << kStackOverflowReservedBytes << ")";
399 }
400
Ian Rogers30fab402012-01-23 15:43:46 -0800401 stack_end_ = stack_begin_;
Ian Rogers932746a2011-09-22 18:57:50 -0700402 }
403
404 // Set the stack end to that to be used during regular execution
405 void ResetDefaultStackEnd() {
406 // Our stacks grow down, so we want stack_end_ to be near there, but reserving enough room
407 // to throw a StackOverflowError.
Ian Rogers30fab402012-01-23 15:43:46 -0800408 stack_end_ = stack_begin_ + kStackOverflowReservedBytes;
Ian Rogers932746a2011-09-22 18:57:50 -0700409 }
410
Elliott Hughes449b4bd2011-09-09 12:01:38 -0700411 static ThreadOffset StackEndOffset() {
412 return ThreadOffset(OFFSETOF_MEMBER(Thread, stack_end_));
Elliott Hughesbe759c62011-09-08 19:38:21 -0700413 }
414
415 static ThreadOffset JniEnvOffset() {
416 return ThreadOffset(OFFSETOF_MEMBER(Thread, jni_env_));
417 }
418
419 static ThreadOffset TopOfManagedStackOffset() {
420 return ThreadOffset(OFFSETOF_MEMBER(Thread, top_of_managed_stack_) +
421 OFFSETOF_MEMBER(Frame, sp_));
422 }
423
Ian Rogersbdb03912011-09-14 00:55:44 -0700424 static ThreadOffset TopOfManagedStackPcOffset() {
425 return ThreadOffset(OFFSETOF_MEMBER(Thread, top_of_managed_stack_pc_));
426 }
427
Logan Chienf7ad17e2012-03-15 03:10:03 +0800428 void PushShadowFrame(ShadowFrame* frame);
429 ShadowFrame* PopShadowFrame();
430
Brian Carlstrom40381fb2011-10-19 14:13:40 -0700431 void PushSirt(StackIndirectReferenceTable* sirt);
432 StackIndirectReferenceTable* PopSirt();
433
Elliott Hughesbe759c62011-09-08 19:38:21 -0700434 static ThreadOffset TopSirtOffset() {
435 return ThreadOffset(OFFSETOF_MEMBER(Thread, top_sirt_));
436 }
437
Elliott Hughes530fa002012-03-12 11:44:49 -0700438 void WalkStack(StackVisitor* visitor, bool include_upcalls = false) const;
Shih-wei Liao9407c602011-09-16 10:36:43 -0700439
Elliott Hughes475fc232011-10-25 15:00:35 -0700440 DebugInvokeReq* GetInvokeReq() {
441 return debug_invoke_req_;
442 }
443
Elliott Hughesc0f09332012-03-26 13:27:06 -0700444 void SetDebuggerUpdatesEnabled(bool enabled);
445
jeffhaoe343b762011-12-05 16:36:44 -0800446 bool IsTraceStackEmpty() const {
447 return trace_stack_->empty();
448 }
449
jeffhaoa9ef3fd2011-12-13 18:33:43 -0800450 TraceStackFrame GetTraceStackFrame(uint32_t depth) const {
451 return trace_stack_->at(trace_stack_->size() - depth - 1);
452 }
453
jeffhaoe343b762011-12-05 16:36:44 -0800454 void PushTraceStackFrame(const TraceStackFrame& frame) {
455 trace_stack_->push_back(frame);
456 }
457
458 TraceStackFrame PopTraceStackFrame() {
459 TraceStackFrame frame = trace_stack_->back();
460 trace_stack_->pop_back();
461 return frame;
462 }
463
Elliott Hughesa4060e52012-03-02 16:51:35 -0800464 void CheckSafeToLockOrUnlock(MutexRank rank, bool is_locking);
465 void CheckSafeToWait(MutexRank rank);
Elliott Hughesffb465f2012-03-01 18:46:05 -0800466
Carl Shapiro0e5d75d2011-07-06 18:28:37 -0700467 private:
Elliott Hughesdcc24742011-09-07 14:02:44 -0700468 Thread();
Elliott Hughesc1674ed2011-08-25 18:09:09 -0700469 ~Thread();
Elliott Hughesc0f09332012-03-26 13:27:06 -0700470 void Destroy();
471 friend class ThreadList; // For ~Thread and Destroy.
Carl Shapiro0e5d75d2011-07-06 18:28:37 -0700472
Elliott Hughes462c9442012-03-23 18:47:50 -0700473 void CreatePeer(const char* name, bool as_daemon, Object* thread_group);
Elliott Hughes5fe594f2011-09-08 12:33:17 -0700474 friend class Runtime; // For CreatePeer.
475
Elliott Hughesd92bec42011-09-02 17:04:36 -0700476 void DumpState(std::ostream& os) const;
477 void DumpStack(std::ostream& os) const;
Elliott Hughesffb465f2012-03-01 18:46:05 -0800478 void DumpNativeStack(std::ostream& os) const;
Elliott Hughesd92bec42011-09-02 17:04:36 -0700479
Elliott Hughesaccd83d2011-10-17 14:25:58 -0700480 // Out-of-line conveniences for debugging in gdb.
Elliott Hughes498508c2011-10-17 14:58:22 -0700481 static Thread* CurrentFromGdb(); // Like Thread::Current.
Elliott Hughesaccd83d2011-10-17 14:25:58 -0700482 void DumpFromGdb() const; // Like Thread::Dump(std::cerr).
483
Elliott Hughes93e74e82011-09-13 11:07:03 -0700484 static void* CreateCallback(void* arg);
485
Elliott Hughesaccd83d2011-10-17 14:25:58 -0700486 void HandleUncaughtExceptions();
Brian Carlstrom4514d3c2011-10-21 17:01:31 -0700487 void RemoveFromThreadGroup();
Elliott Hughesaccd83d2011-10-17 14:25:58 -0700488
Elliott Hughes462c9442012-03-23 18:47:50 -0700489 void Init();
Ian Rogers5d76c432011-10-31 21:42:49 -0700490 void InitCardTable();
Ian Rogersb033c752011-07-20 12:22:35 -0700491 void InitCpu();
buzbee3ea4ec52011-08-22 17:37:19 -0700492 void InitFunctionPointers();
Brian Carlstromcaabb1b2011-10-11 18:09:13 -0700493 void InitTid();
Brian Carlstromcaabb1b2011-10-11 18:09:13 -0700494 void InitPthreadKeySelf();
Elliott Hughesbe759c62011-09-08 19:38:21 -0700495 void InitStackHwm();
496
Elliott Hughes5f791332011-09-15 17:45:30 -0700497 void NotifyLocked() {
498 if (wait_monitor_ != NULL) {
Elliott Hughes85d15452011-09-16 17:33:01 -0700499 wait_cond_->Signal();
Elliott Hughes5f791332011-09-15 17:45:30 -0700500 }
501 }
502
Elliott Hughesbe759c62011-09-08 19:38:21 -0700503 static void ThreadExitCallback(void* arg);
Ian Rogersb033c752011-07-20 12:22:35 -0700504
Elliott Hughesdcc24742011-09-07 14:02:44 -0700505 // Thin lock thread id. This is a small integer used by the thin lock implementation.
506 // This is not to be confused with the native thread's tid, nor is it the value returned
507 // by java.lang.Thread.getId --- this is a distinct value, used only for locking. One
508 // important difference between this id and the ids visible to managed code is that these
509 // ones get reused (to ensure that they fit in the number of bits available).
510 uint32_t thin_lock_id_;
Ian Rogersb033c752011-07-20 12:22:35 -0700511
Elliott Hughesd92bec42011-09-02 17:04:36 -0700512 // System thread id.
513 pid_t tid_;
514
Elliott Hughesdcc24742011-09-07 14:02:44 -0700515 // Our managed peer (an instance of java.lang.Thread).
Elliott Hughesd369bb72011-09-12 14:41:14 -0700516 Object* peer_;
Elliott Hughes8daa0922011-09-11 13:46:25 -0700517
Elliott Hughes8e4aac52011-09-26 17:03:36 -0700518 // The top_of_managed_stack_ and top_of_managed_stack_pc_ fields are accessed from
519 // compiled code, so we keep them early in the structure to (a) avoid having to keep
520 // fixing the assembler offsets and (b) improve the chances that these will still be aligned.
521
522 // Top of the managed stack, written out prior to the state transition from
Elliott Hughes68e76522011-10-05 13:22:16 -0700523 // kRunnable to kNative. Uses include giving the starting point for scanning
Elliott Hughes8e4aac52011-09-26 17:03:36 -0700524 // a managed stack when a thread is in native code.
525 Frame top_of_managed_stack_;
526 // PC corresponding to the call out of the top_of_managed_stack_ frame
527 uintptr_t top_of_managed_stack_pc_;
528
Elliott Hughes8daa0922011-09-11 13:46:25 -0700529 // Guards the 'interrupted_' and 'wait_monitor_' members.
Elliott Hughes85d15452011-09-16 17:33:01 -0700530 mutable Mutex* wait_mutex_;
531 ConditionVariable* wait_cond_;
Elliott Hughes8daa0922011-09-11 13:46:25 -0700532 // Pointer to the monitor lock we're currently waiting on (or NULL), guarded by wait_mutex_.
533 Monitor* wait_monitor_;
534 // Thread "interrupted" status; stays raised until queried or thrown, guarded by wait_mutex_.
Elliott Hughes8e4aac52011-09-26 17:03:36 -0700535 uint32_t interrupted_;
Elliott Hughes5f791332011-09-15 17:45:30 -0700536 // The next thread in the wait set this thread is part of.
537 Thread* wait_next_;
Elliott Hughes8e4aac52011-09-26 17:03:36 -0700538 // If we're blocked in MonitorEnter, this is the object we're trying to lock.
539 Object* monitor_enter_object_;
Elliott Hughes5f791332011-09-15 17:45:30 -0700540
541 friend class Monitor;
Elliott Hughesdcc24742011-09-07 14:02:44 -0700542
Elliott Hughes9d5ccec2011-09-19 13:19:50 -0700543 RuntimeStats stats_;
544
Ian Rogers5d76c432011-10-31 21:42:49 -0700545 // The biased card table, see CardTable for details
546 byte* card_table_;
buzbeec143c552011-08-20 17:38:58 -0700547
Elliott Hughes449b4bd2011-09-09 12:01:38 -0700548 // The end of this thread's stack. This is the lowest safely-addressable address on the stack.
549 // We leave extra space so there's room for the code that throws StackOverflowError.
550 byte* stack_end_;
Elliott Hughesbe759c62011-09-08 19:38:21 -0700551
Ian Rogers932746a2011-09-22 18:57:50 -0700552 // Size of the stack
553 size_t stack_size_;
554
555 // The "lowest addressable byte" of the stack
Ian Rogers30fab402012-01-23 15:43:46 -0800556 byte* stack_begin_;
Ian Rogers932746a2011-09-22 18:57:50 -0700557
Ian Rogers6de08602011-08-19 14:52:39 -0700558 // A linked list (of stack allocated records) recording transitions from
559 // native to managed code.
560 NativeToManagedRecord* native_to_managed_record_;
561
Ian Rogers408f79a2011-08-23 18:22:33 -0700562 // Top of linked list of stack indirect reference tables or NULL for none
563 StackIndirectReferenceTable* top_sirt_;
Ian Rogersb033c752011-07-20 12:22:35 -0700564
Logan Chienf7ad17e2012-03-15 03:10:03 +0800565 // Top of linked list of shadow stack or NULL for none
566 // Some backend may require shadow frame to ease the GC work.
567 ShadowFrame* top_shadow_frame_;
568
Ian Rogersb033c752011-07-20 12:22:35 -0700569 // Every thread may have an associated JNI environment
Elliott Hughes69f5bc62011-08-24 09:26:14 -0700570 JNIEnvExt* jni_env_;
Ian Rogersb033c752011-07-20 12:22:35 -0700571
Elliott Hughes93e74e82011-09-13 11:07:03 -0700572 volatile State state_;
Carl Shapirob5573532011-07-12 18:22:59 -0700573
Carl Shapiro69759ea2011-07-21 18:13:35 -0700574 // Initialized to "this". On certain architectures (such as x86) reading
575 // off of Thread::Current is easy but getting the address of Thread::Current
576 // is hard. This field can be read off of Thread::Current to give the address.
577 Thread* self_;
578
579 Runtime* runtime_;
580
581 // The pending exception or NULL.
Elliott Hughese5b0dc82011-08-23 09:59:02 -0700582 Throwable* exception_;
Carl Shapiro0e5d75d2011-07-06 18:28:37 -0700583
Ian Rogers45a76cb2011-07-21 22:00:15 -0700584 // A non-zero value is used to tell the current thread to enter a safe point
585 // at the next poll.
586 int suspend_count_;
Elliott Hughes234ab152011-10-26 14:02:26 -0700587 // How much of 'suspend_count_' is by request of the debugger, used to set things right
588 // when the debugger detaches. Must be <= suspend_count_.
589 int debug_suspend_count_;
Ian Rogers45a76cb2011-07-21 22:00:15 -0700590
Elliott Hughesedcc09c2011-08-21 18:47:05 -0700591 // Needed to get the right ClassLoader in JNI_OnLoad, but also
592 // useful for testing.
Brian Carlstrombffb1552011-08-25 12:23:53 -0700593 const ClassLoader* class_loader_override_;
buzbeec143c552011-08-20 17:38:58 -0700594
Ian Rogersbdb03912011-09-14 00:55:44 -0700595 // Thread local, lazily allocated, long jump context. Used to deliver exceptions.
Elliott Hughes85d15452011-09-16 17:33:01 -0700596 Context* long_jump_context_;
Ian Rogersbdb03912011-09-14 00:55:44 -0700597
Elliott Hughes418dfe72011-10-06 18:56:27 -0700598 // A boolean telling us whether we're recursively throwing OOME.
Elliott Hughes726079d2011-10-07 18:43:44 -0700599 uint32_t throwing_OutOfMemoryError_;
600
601 Throwable* pre_allocated_OutOfMemoryError_;
Elliott Hughes418dfe72011-10-06 18:56:27 -0700602
Elliott Hughes475fc232011-10-25 15:00:35 -0700603 // JDWP invoke-during-breakpoint support.
604 DebugInvokeReq* debug_invoke_req_;
605
Elliott Hughes81ff3182012-03-23 20:35:56 -0700606 // TLS key used to retrieve the Thread*.
Carl Shapirob5573532011-07-12 18:22:59 -0700607 static pthread_key_t pthread_key_self_;
608
jeffhaoe343b762011-12-05 16:36:44 -0800609 // Additional stack used by method tracer to store method and return pc values.
610 // Stored as a pointer since std::vector is not PACKED.
611 std::vector<TraceStackFrame>* trace_stack_;
612
Elliott Hughes899e7892012-01-24 14:57:32 -0800613 // A cached copy of the java.lang.Thread's name.
614 std::string* name_;
615
Elliott Hughesffb465f2012-03-01 18:46:05 -0800616 uint32_t held_mutexes_[kMaxMutexRank + 1];
617
Ian Rogersa32a6fd2012-02-06 20:18:44 -0800618 public:
619 // Runtime support function pointers
620 void (*pDebugMe)(Method*, uint32_t);
621 void* (*pMemcpy)(void*, const void*, size_t);
622 uint64_t (*pShlLong)(uint64_t, uint32_t);
623 uint64_t (*pShrLong)(uint64_t, uint32_t);
624 uint64_t (*pUshrLong)(uint64_t, uint32_t);
625 float (*pI2f)(int);
626 int (*pF2iz)(float);
627 float (*pD2f)(double);
628 double (*pF2d)(float);
629 double (*pI2d)(int);
630 int (*pD2iz)(double);
Ian Rogersc6f3bb82012-03-21 20:40:33 -0700631 float (*pL2f)(int64_t);
632 double (*pL2d)(int64_t);
633 int64_t (*pF2l)(float);
634 int64_t (*pD2l)(double);
Ian Rogersa32a6fd2012-02-06 20:18:44 -0800635 float (*pFadd)(float, float);
636 float (*pFsub)(float, float);
637 float (*pFdiv)(float, float);
638 float (*pFmul)(float, float);
639 float (*pFmodf)(float, float);
640 double (*pDadd)(double, double);
641 double (*pDsub)(double, double);
642 double (*pDdiv)(double, double);
643 double (*pDmul)(double, double);
644 double (*pFmod)(double, double);
645 int (*pIdivmod)(int, int);
646 int (*pIdiv)(int, int);
Ian Rogersc6f3bb82012-03-21 20:40:33 -0700647 int64_t (*pLadd)(int64_t, int64_t);
648 int64_t (*pLsub)(int64_t, int64_t);
649 int64_t (*pLand)(int64_t, int64_t);
650 int64_t (*pLor)(int64_t, int64_t);
651 int64_t (*pLxor)(int64_t, int64_t);
652 int64_t (*pLmul)(int64_t, int64_t);
653 int64_t (*pLdivmod)(int64_t, int64_t);
Ian Rogersa32a6fd2012-02-06 20:18:44 -0800654 void (*pCheckSuspendFromCode)(Thread*); // Stub that is called when the suspend count is non-zero
655 void (*pTestSuspendFromCode)(); // Stub that is periodically called to test the suspend count
656 void* (*pAllocObjectFromCode)(uint32_t, void*);
657 void* (*pAllocObjectFromCodeWithAccessCheck)(uint32_t, void*);
658 void* (*pAllocArrayFromCode)(uint32_t, void*, int32_t);
659 void* (*pAllocArrayFromCodeWithAccessCheck)(uint32_t, void*, int32_t);
660 void (*pCanPutArrayElementFromCode)(void*, void*);
661 void* (*pCheckAndAllocArrayFromCode)(uint32_t, void*, int32_t);
662 void* (*pCheckAndAllocArrayFromCodeWithAccessCheck)(uint32_t, void*, int32_t);
663 void (*pCheckCastFromCode)(void*, void*);
664 Object* (*pDecodeJObjectInThread)(Thread* thread, jobject obj);
665 void (*pDeliverException)(void*);
666 Method* (*pFindInterfaceMethodInCache)(Class*, uint32_t, const Method*, struct DvmDex*);
667 void* (*pFindNativeMethod)(Thread* thread);
668 int32_t (*pGet32Instance)(uint32_t, void*);
669 int64_t (*pGet64Instance)(uint32_t, void*);
670 void* (*pGetObjInstance)(uint32_t, void*);
671 int32_t (*pGet32Static)(uint32_t);
672 int64_t (*pGet64Static)(uint32_t);
673 void* (*pGetObjStatic)(uint32_t);
674 void (*pHandleFillArrayDataFromCode)(void*, void*);
675 void* (*pInitializeStaticStorage)(uint32_t, void*);
676 uint32_t (*pInstanceofNonTrivialFromCode)(const Class*, const Class*);
Ian Rogersc8b306f2012-02-17 21:34:44 -0800677 void (*pInvokeDirectTrampolineWithAccessCheck)(uint32_t, void*);
Ian Rogersa32a6fd2012-02-06 20:18:44 -0800678 void (*pInvokeInterfaceTrampoline)(uint32_t, void*);
679 void (*pInvokeInterfaceTrampolineWithAccessCheck)(uint32_t, void*);
Ian Rogersc8b306f2012-02-17 21:34:44 -0800680 void (*pInvokeStaticTrampolineWithAccessCheck)(uint32_t, void*);
Ian Rogersa32a6fd2012-02-06 20:18:44 -0800681 void (*pInvokeSuperTrampolineWithAccessCheck)(uint32_t, void*);
682 void (*pInvokeVirtualTrampolineWithAccessCheck)(uint32_t, void*);
683 void* (*pInitializeTypeFromCode)(uint32_t, void*);
684 void* (*pInitializeTypeAndVerifyAccessFromCode)(uint32_t, void*);
685 void (*pLockObjectFromCode)(void*);
Ian Rogersa32a6fd2012-02-06 20:18:44 -0800686 void* (*pResolveStringFromCode)(void*, uint32_t);
687 int (*pSet32Instance)(uint32_t, void*, int32_t); // field_idx, obj, src
688 int (*pSet64Instance)(uint32_t, void*, int64_t);
689 int (*pSetObjInstance)(uint32_t, void*, void*);
690 int (*pSet32Static)(uint32_t, int32_t);
691 int (*pSet64Static)(uint32_t, int64_t);
692 int (*pSetObjStatic)(uint32_t, void*);
693 void (*pThrowStackOverflowFromCode)(void*);
694 void (*pThrowNullPointerFromCode)();
695 void (*pThrowArrayBoundsFromCode)(int32_t, int32_t);
696 void (*pThrowDivZeroFromCode)();
697 void (*pThrowVerificationErrorFromCode)(int32_t, int32_t);
698 void (*pThrowNegArraySizeFromCode)(int32_t);
699 void (*pThrowNoSuchMethodFromCode)(int32_t);
700 void (*pThrowAbstractMethodErrorFromCode)(Method* method, Thread* thread, Method** sp);
701 void (*pUnlockObjectFromCode)(void*);
Ian Rogers19846512012-02-24 11:42:47 -0800702 const void* (*pUnresolvedDirectMethodTrampolineFromCode)(Method*, Method**, Thread*,
703 Runtime::TrampolineType);
Ian Rogersa32a6fd2012-02-06 20:18:44 -0800704 void (*pUpdateDebuggerFromCode)(void*, void*, int32_t, void*);
Bill Buzbee11f9d212012-03-03 20:03:18 -0800705 bool (*pCmplFloat)(float, float);
706 bool (*pCmpgFloat)(float, float);
707 bool (*pCmplDouble)(double, double);
708 bool (*pCmpgDouble)(double, double);
buzbeefc9e6fa2012-03-23 15:14:29 -0700709 int (*pIndexOf)(void*, uint32_t, uint32_t, uint32_t);
710 int (*pStringCompareTo)(void*, void*);
711 int (*pMemcmp16)(void*, void*, int32_t);
Ian Rogersa32a6fd2012-02-06 20:18:44 -0800712
713 private:
Carl Shapiro0e5d75d2011-07-06 18:28:37 -0700714 DISALLOW_COPY_AND_ASSIGN(Thread);
715};
Ian Rogersbdb03912011-09-14 00:55:44 -0700716
Elliott Hughes330304d2011-08-12 14:28:05 -0700717std::ostream& operator<<(std::ostream& os, const Thread& thread);
Ian Rogersb033c752011-07-20 12:22:35 -0700718std::ostream& operator<<(std::ostream& os, const Thread::State& state);
Carl Shapiro0e5d75d2011-07-06 18:28:37 -0700719
Elliott Hughesad7c2a32011-08-31 11:58:10 -0700720class ScopedThreadStateChange {
721 public:
722 ScopedThreadStateChange(Thread* thread, Thread::State new_state) : thread_(thread) {
723 old_thread_state_ = thread_->SetState(new_state);
724 }
725
726 ~ScopedThreadStateChange() {
727 thread_->SetState(old_thread_state_);
728 }
729
730 private:
731 Thread* thread_;
732 Thread::State old_thread_state_;
733 DISALLOW_COPY_AND_ASSIGN(ScopedThreadStateChange);
734};
735
Carl Shapiro0e5d75d2011-07-06 18:28:37 -0700736} // namespace art
737
738#endif // ART_SRC_THREAD_H_