blob: 8a0c1affe42acfc135821c2b86a84ae7ccdbe86d [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;
Elliott Hughes68e76522011-10-05 13:22:16 -070053class StackIndirectReferenceTable;
Shih-wei Liao55df06b2011-08-26 14:39:27 -070054class StackTraceElement;
buzbee1da522d2011-09-04 11:22:20 -070055class StaticStorageBase;
Brian Carlstrom40381fb2011-10-19 14:13:40 -070056class Thread;
57class ThreadList;
58class Throwable;
buzbee1da522d2011-09-04 11:22:20 -070059
Shih-wei Liao55df06b2011-08-26 14:39:27 -070060template<class T> class ObjectArray;
Shih-wei Liao44175362011-08-28 16:59:17 -070061template<class T> class PrimitiveArray;
62typedef PrimitiveArray<int32_t> IntArray;
Carl Shapiro0e5d75d2011-07-06 18:28:37 -070063
Elliott Hughes85d15452011-09-16 17:33:01 -070064class PACKED Thread {
Carl Shapiro0e5d75d2011-07-06 18:28:37 -070065 public:
Elliott Hughes8daa0922011-09-11 13:46:25 -070066 /* thread priorities, from java.lang.Thread */
67 enum Priority {
68 kMinPriority = 1,
69 kNormPriority = 5,
70 kMaxPriority = 10,
71 };
Carl Shapirob5573532011-07-12 18:22:59 -070072 enum State {
Elliott Hughes499c5132011-11-17 14:55:11 -080073 // These correspond to JDWP states (but needn't share the same values).
74 kTerminated = 0, // TS_ZOMBIE
75 kRunnable = 1, // TS_RUNNING
Elliott Hughes3ce4b262012-02-24 11:24:02 -080076 kTimedWaiting = 2, // TS_WAIT in Object.wait() with a timeout
Elliott Hughes499c5132011-11-17 14:55:11 -080077 kBlocked = 3, // TS_MONITOR on a monitor
78 kWaiting = 4, // TS_WAIT in Object.wait()
Elliott Hughes93e74e82011-09-13 11:07:03 -070079 // Non-JDWP states.
Elliott Hughesc0f09332012-03-26 13:27:06 -070080 kStarting = 5, // native thread started, not yet ready to run managed code
81 kNative = 6, // off in a JNI native method
82 kVmWait = 7, // waiting on an internal runtime resource
83 kSuspended = 8, // suspended, usually by GC or debugger
Carl Shapirob5573532011-07-12 18:22:59 -070084 };
85
Ian Rogers932746a2011-09-22 18:57:50 -070086 // Space to throw a StackOverflowError in.
Brian Carlstromaded5f72011-10-07 17:15:04 -070087 static const size_t kStackOverflowReservedBytes = 4 * KB;
buzbeec143c552011-08-20 17:38:58 -070088
Brian Carlstrom72db0d72011-11-10 17:58:56 -080089 static const size_t kDefaultStackSize = 96 * KB;
Carl Shapiro61e019d2011-07-14 16:53:09 -070090
Shih-wei Liao9b576b42011-08-29 01:45:07 -070091 class StackVisitor {
92 public:
Ian Rogers0cfe1fb2011-08-26 03:29:44 -070093 virtual ~StackVisitor() {}
Elliott Hughes530fa002012-03-12 11:44:49 -070094 // Return 'true' if we should continue to visit more frames, 'false' to stop.
95 virtual bool VisitFrame(const Frame& frame, uintptr_t pc) = 0;
Shih-wei Liao9b576b42011-08-29 01:45:07 -070096 };
97
Elliott Hughes462c9442012-03-23 18:47:50 -070098 // Creates a new native thread corresponding to the given managed peer.
99 // Used to implement Thread.start.
Elliott Hughesd369bb72011-09-12 14:41:14 -0700100 static void Create(Object* peer, size_t stack_size);
Carl Shapiro61e019d2011-07-14 16:53:09 -0700101
Elliott Hughes462c9442012-03-23 18:47:50 -0700102 // Attaches the calling native thread to the runtime, returning the new native peer.
103 // Used to implement JNI AttachCurrentThread and AttachCurrentThreadAsDaemon calls.
104 static Thread* Attach(const char* thread_name, bool as_daemon, Object* thread_group);
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
Elliott Hughes462c9442012-03-23 18:47:50 -0700152 // Returns the "main" ThreadGroup, used when attaching user threads.
153 static Object* GetMainThreadGroup();
154 // Returns the "system" ThreadGroup, used when attaching our internal threads.
155 static Object* GetSystemThreadGroup();
156
Ian Rogers0cfe1fb2011-08-26 03:29:44 -0700157 bool CanAccessDirectReferences() const {
Brian Carlstromcaabb1b2011-10-11 18:09:13 -0700158#ifdef MOVING_GARBAGE_COLLECTOR
Elliott Hughesa59d1792011-09-04 18:42:35 -0700159 // TODO: when we have a moving collector, we'll need: return state_ == kRunnable;
Brian Carlstromcaabb1b2011-10-11 18:09:13 -0700160#endif
Elliott Hughesa59d1792011-09-04 18:42:35 -0700161 return true;
Ian Rogers0cfe1fb2011-08-26 03:29:44 -0700162 }
163
Elliott Hughesdcc24742011-09-07 14:02:44 -0700164 uint32_t GetThinLockId() const {
165 return thin_lock_id_;
Carl Shapirob5573532011-07-12 18:22:59 -0700166 }
167
Elliott Hughesd92bec42011-09-02 17:04:36 -0700168 pid_t GetTid() const {
169 return tid_;
170 }
Elliott Hughese27955c2011-08-26 15:21:24 -0700171
Elliott Hughesffb465f2012-03-01 18:46:05 -0800172 // Returns the java.lang.Thread's name, or NULL if this Thread* doesn't have a peer.
Elliott Hughes899e7892012-01-24 14:57:32 -0800173 String* GetThreadName() const;
174
Elliott Hughesffb465f2012-03-01 18:46:05 -0800175 // Sets 'name' to the java.lang.Thread's name. This requires no transition to managed code,
176 // allocation, or locking.
177 void GetThreadName(std::string& name) const;
178
Elliott Hughes899e7892012-01-24 14:57:32 -0800179 // Sets the thread's name.
180 void SetThreadName(const char* name);
Elliott Hughesfc861622011-10-17 17:57:47 -0700181
Elliott Hughesd369bb72011-09-12 14:41:14 -0700182 Object* GetPeer() const {
Elliott Hughes8daa0922011-09-11 13:46:25 -0700183 return peer_;
184 }
185
Elliott Hughesa2155262011-11-16 16:26:58 -0800186 Object* GetThreadGroup() const;
187
Elliott Hughes9d5ccec2011-09-19 13:19:50 -0700188 RuntimeStats* GetStats() {
189 return &stats_;
190 }
191
Elliott Hughesd07986f2011-12-06 18:27:45 -0800192 int GetSuspendCount() const {
193 return suspend_count_;
194 }
Ian Rogers0cfe1fb2011-08-26 03:29:44 -0700195
Elliott Hughesd07986f2011-12-06 18:27:45 -0800196 // Returns the current Method* and native PC (not dex PC) for this thread.
197 Method* GetCurrentMethod(uintptr_t* pc = NULL, Method*** sp = NULL) const;
jeffhao33dc7712011-11-09 17:54:24 -0800198
Carl Shapiro0e5d75d2011-07-06 18:28:37 -0700199 bool IsExceptionPending() const {
Elliott Hughesb20a5542011-08-12 18:03:12 -0700200 return exception_ != NULL;
Carl Shapiro0e5d75d2011-07-06 18:28:37 -0700201 }
202
Elliott Hughese5b0dc82011-08-23 09:59:02 -0700203 Throwable* GetException() const {
Ian Rogers0cfe1fb2011-08-26 03:29:44 -0700204 DCHECK(CanAccessDirectReferences());
Carl Shapiro0e5d75d2011-07-06 18:28:37 -0700205 return exception_;
206 }
207
Ian Rogers0cfe1fb2011-08-26 03:29:44 -0700208 void SetException(Throwable* new_exception) {
209 DCHECK(CanAccessDirectReferences());
210 CHECK(new_exception != NULL);
211 // TODO: CHECK(exception_ == NULL);
212 exception_ = new_exception; // TODO
213 }
214
215 void ClearException() {
216 exception_ = NULL;
Elliott Hughesa0957642011-09-02 14:27:33 -0700217 }
218
Ian Rogersbdb03912011-09-14 00:55:44 -0700219 // Find catch block and perform long jump to appropriate exception handle
Ian Rogersff1ed472011-09-20 13:46:24 -0700220 void DeliverException();
Ian Rogersbdb03912011-09-14 00:55:44 -0700221
222 Context* GetLongJumpContext();
223
Shih-wei Liao1a18c8c2011-08-14 17:47:36 -0700224 Frame GetTopOfStack() const {
225 return top_of_managed_stack_;
226 }
227
228 // TODO: this is here for testing, remove when we have exception unit tests
229 // that use the real stack
Ian Rogersbdb03912011-09-14 00:55:44 -0700230 void SetTopOfStack(void* stack, uintptr_t pc) {
Ian Rogers0cfe1fb2011-08-26 03:29:44 -0700231 top_of_managed_stack_.SetSP(reinterpret_cast<Method**>(stack));
Ian Rogersbdb03912011-09-14 00:55:44 -0700232 top_of_managed_stack_pc_ = pc;
Carl Shapiro0e5d75d2011-07-06 18:28:37 -0700233 }
234
Ian Rogersbdb03912011-09-14 00:55:44 -0700235 void SetTopOfStackPC(uintptr_t pc) {
236 top_of_managed_stack_pc_ = pc;
237 }
238
Elliott Hughes5cb5ad22011-10-02 12:13:39 -0700239 // 'msg' may be NULL.
240 void ThrowNewException(const char* exception_class_descriptor, const char* msg);
241
242 void ThrowNewExceptionF(const char* exception_class_descriptor, const char* fmt, ...)
Elliott Hughes362f9bc2011-10-17 18:56:41 -0700243 __attribute__((format(printf, 3, 4)));
Elliott Hughesa5b897e2011-08-16 11:33:06 -0700244
Elliott Hughes4a2b4172011-09-20 17:08:25 -0700245 void ThrowNewExceptionV(const char* exception_class_descriptor, const char* fmt, va_list ap);
246
Elliott Hughes2ced6a52011-10-16 18:44:48 -0700247 // OutOfMemoryError is special, because we need to pre-allocate an instance.
248 void ThrowOutOfMemoryError(const char* msg);
Elliott Hughes418dfe72011-10-06 18:56:27 -0700249 void ThrowOutOfMemoryError(Class* c, size_t byte_count);
Elliott Hughes79082e32011-08-25 12:07:32 -0700250
Shih-wei Liao1a18c8c2011-08-14 17:47:36 -0700251 Frame FindExceptionHandler(void* throw_pc, void** handler_pc);
252
253 void* FindExceptionHandlerInMethod(const Method* method,
254 void* throw_pc,
255 const DexFile& dex_file,
256 ClassLinker* class_linker);
buzbeec143c552011-08-20 17:38:58 -0700257
Elliott Hughesbe759c62011-09-08 19:38:21 -0700258 static void Startup();
Elliott Hughes038a8062011-09-18 14:12:41 -0700259 static void FinishStartup();
Elliott Hughesc1674ed2011-08-25 18:09:09 -0700260 static void Shutdown();
Carl Shapirob5573532011-07-12 18:22:59 -0700261
Ian Rogersb033c752011-07-20 12:22:35 -0700262 // JNI methods
Elliott Hughes69f5bc62011-08-24 09:26:14 -0700263 JNIEnvExt* GetJniEnv() const {
Ian Rogersb033c752011-07-20 12:22:35 -0700264 return jni_env_;
265 }
266
Ian Rogers408f79a2011-08-23 18:22:33 -0700267 // Number of references allocated in SIRTs on this thread
268 size_t NumSirtReferences();
Ian Rogersa8cd9f42011-08-19 16:43:41 -0700269
Ian Rogers408f79a2011-08-23 18:22:33 -0700270 // Is the given obj in this thread's stack indirect reference table?
271 bool SirtContains(jobject obj);
272
Shih-wei Liao8dfc9d52011-09-28 18:06:15 -0700273 void SirtVisitRoots(Heap::RootVisitor* visitor, void* arg);
274
Ian Rogers408f79a2011-08-23 18:22:33 -0700275 // Convert a jobject into a Object*
276 Object* DecodeJObject(jobject obj);
Ian Rogersb033c752011-07-20 12:22:35 -0700277
Elliott Hughes8daa0922011-09-11 13:46:25 -0700278 // Implements java.lang.Thread.interrupted.
279 bool Interrupted() {
Elliott Hughes85d15452011-09-16 17:33:01 -0700280 MutexLock mu(*wait_mutex_);
Elliott Hughes8daa0922011-09-11 13:46:25 -0700281 bool interrupted = interrupted_;
282 interrupted_ = false;
283 return interrupted;
284 }
285
286 // Implements java.lang.Thread.isInterrupted.
287 bool IsInterrupted() {
Elliott Hughes85d15452011-09-16 17:33:01 -0700288 MutexLock mu(*wait_mutex_);
Elliott Hughes8daa0922011-09-11 13:46:25 -0700289 return interrupted_;
290 }
291
Elliott Hughes5f791332011-09-15 17:45:30 -0700292 void Interrupt() {
Elliott Hughes85d15452011-09-16 17:33:01 -0700293 MutexLock mu(*wait_mutex_);
Elliott Hughes5f791332011-09-15 17:45:30 -0700294 if (interrupted_) {
295 return;
296 }
297 interrupted_ = true;
298 NotifyLocked();
299 }
300
301 void Notify() {
Elliott Hughes85d15452011-09-16 17:33:01 -0700302 MutexLock mu(*wait_mutex_);
Elliott Hughes5f791332011-09-15 17:45:30 -0700303 NotifyLocked();
304 }
305
Ian Rogers6de08602011-08-19 14:52:39 -0700306 // Linked list recording transitions from native to managed code
Ian Rogersb04f69f2011-10-17 00:40:54 -0700307 void PushNativeToManagedRecord(NativeToManagedRecord* record);
308 void PopNativeToManagedRecord(const NativeToManagedRecord& record);
Ian Rogers6de08602011-08-19 14:52:39 -0700309
Brian Carlstrombffb1552011-08-25 12:23:53 -0700310 const ClassLoader* GetClassLoaderOverride() {
Ian Rogers0cfe1fb2011-08-26 03:29:44 -0700311 // TODO: need to place the class_loader_override_ in a handle
312 // DCHECK(CanAccessDirectReferences());
buzbeec143c552011-08-20 17:38:58 -0700313 return class_loader_override_;
314 }
315
Brian Carlstrombffb1552011-08-25 12:23:53 -0700316 void SetClassLoaderOverride(const ClassLoader* class_loader_override) {
buzbeec143c552011-08-20 17:38:58 -0700317 class_loader_override_ = class_loader_override;
318 }
319
Ian Rogersaaa20802011-09-11 21:47:37 -0700320 // Create the internal representation of a stack trace, that is more time
321 // and space efficient to compute than the StackTraceElement[]
Elliott Hughes01158d72011-09-19 19:47:10 -0700322 jobject CreateInternalStackTrace(JNIEnv* env) const;
Ian Rogersaaa20802011-09-11 21:47:37 -0700323
Elliott Hughes01158d72011-09-19 19:47:10 -0700324 // Convert an internal stack trace representation (returned by CreateInternalStackTrace) to a
325 // StackTraceElement[]. If output_array is NULL, a new array is created, otherwise as many
326 // frames as will fit are written into the given array. If stack_depth is non-NULL, it's updated
327 // with the number of valid frames in the returned array.
328 static jobjectArray InternalStackTraceToStackTraceElementArray(JNIEnv* env, jobject internal,
329 jobjectArray output_array = NULL, int* stack_depth = NULL);
Shih-wei Liao55df06b2011-08-26 14:39:27 -0700330
Ian Rogersd6b1f612011-09-27 13:38:14 -0700331 void VisitRoots(Heap::RootVisitor* visitor, void* arg);
Elliott Hughes410c0c82011-09-01 17:58:25 -0700332
jeffhao25045522012-03-13 19:34:37 -0700333#if VERIFY_OBJECT_ENABLED
334 void VerifyStack();
335#else
336 void VerifyStack() {}
337#endif
338
Elliott Hughesbe759c62011-09-08 19:38:21 -0700339 //
340 // Offsets of various members of native Thread class, used by compiled code.
341 //
342
343 static ThreadOffset SelfOffset() {
344 return ThreadOffset(OFFSETOF_MEMBER(Thread, self_));
345 }
346
347 static ThreadOffset ExceptionOffset() {
348 return ThreadOffset(OFFSETOF_MEMBER(Thread, exception_));
349 }
350
Elliott Hughes54e7df12011-09-16 11:47:04 -0700351 static ThreadOffset ThinLockIdOffset() {
Elliott Hughesbe759c62011-09-08 19:38:21 -0700352 return ThreadOffset(OFFSETOF_MEMBER(Thread, thin_lock_id_));
353 }
354
355 static ThreadOffset CardTableOffset() {
356 return ThreadOffset(OFFSETOF_MEMBER(Thread, card_table_));
357 }
358
359 static ThreadOffset SuspendCountOffset() {
360 return ThreadOffset(OFFSETOF_MEMBER(Thread, suspend_count_));
361 }
362
363 static ThreadOffset StateOffset() {
Elliott Hughes93e74e82011-09-13 11:07:03 -0700364 return ThreadOffset(OFFSETOF_VOLATILE_MEMBER(Thread, state_));
Elliott Hughesbe759c62011-09-08 19:38:21 -0700365 }
366
Ian Rogers932746a2011-09-22 18:57:50 -0700367 // Size of stack less any space reserved for stack overflow
368 size_t GetStackSize() {
Ian Rogers30fab402012-01-23 15:43:46 -0800369 return stack_size_ - (stack_end_ - stack_begin_);
Ian Rogers932746a2011-09-22 18:57:50 -0700370 }
371
372 // Set the stack end to that to be used during a stack overflow
373 void SetStackEndForStackOverflow() {
374 // During stack overflow we allow use of the full stack
Ian Rogers30fab402012-01-23 15:43:46 -0800375 if (stack_end_ == stack_begin_) {
Elliott Hughes3b6baaa2011-10-14 19:13:56 -0700376 DumpStack(std::cerr);
377 LOG(FATAL) << "Need to increase kStackOverflowReservedBytes (currently "
378 << kStackOverflowReservedBytes << ")";
379 }
380
Ian Rogers30fab402012-01-23 15:43:46 -0800381 stack_end_ = stack_begin_;
Ian Rogers932746a2011-09-22 18:57:50 -0700382 }
383
384 // Set the stack end to that to be used during regular execution
385 void ResetDefaultStackEnd() {
386 // Our stacks grow down, so we want stack_end_ to be near there, but reserving enough room
387 // to throw a StackOverflowError.
Ian Rogers30fab402012-01-23 15:43:46 -0800388 stack_end_ = stack_begin_ + kStackOverflowReservedBytes;
Ian Rogers932746a2011-09-22 18:57:50 -0700389 }
390
Elliott Hughes449b4bd2011-09-09 12:01:38 -0700391 static ThreadOffset StackEndOffset() {
392 return ThreadOffset(OFFSETOF_MEMBER(Thread, stack_end_));
Elliott Hughesbe759c62011-09-08 19:38:21 -0700393 }
394
395 static ThreadOffset JniEnvOffset() {
396 return ThreadOffset(OFFSETOF_MEMBER(Thread, jni_env_));
397 }
398
399 static ThreadOffset TopOfManagedStackOffset() {
400 return ThreadOffset(OFFSETOF_MEMBER(Thread, top_of_managed_stack_) +
401 OFFSETOF_MEMBER(Frame, sp_));
402 }
403
Ian Rogersbdb03912011-09-14 00:55:44 -0700404 static ThreadOffset TopOfManagedStackPcOffset() {
405 return ThreadOffset(OFFSETOF_MEMBER(Thread, top_of_managed_stack_pc_));
406 }
407
Brian Carlstrom40381fb2011-10-19 14:13:40 -0700408 void PushSirt(StackIndirectReferenceTable* sirt);
409 StackIndirectReferenceTable* PopSirt();
410
Elliott Hughesbe759c62011-09-08 19:38:21 -0700411 static ThreadOffset TopSirtOffset() {
412 return ThreadOffset(OFFSETOF_MEMBER(Thread, top_sirt_));
413 }
414
Elliott Hughes530fa002012-03-12 11:44:49 -0700415 void WalkStack(StackVisitor* visitor, bool include_upcalls = false) const;
Shih-wei Liao9407c602011-09-16 10:36:43 -0700416
Elliott Hughes475fc232011-10-25 15:00:35 -0700417 DebugInvokeReq* GetInvokeReq() {
418 return debug_invoke_req_;
419 }
420
Elliott Hughesc0f09332012-03-26 13:27:06 -0700421 void SetDebuggerUpdatesEnabled(bool enabled);
422
jeffhaoe343b762011-12-05 16:36:44 -0800423 bool IsTraceStackEmpty() const {
424 return trace_stack_->empty();
425 }
426
jeffhaoa9ef3fd2011-12-13 18:33:43 -0800427 TraceStackFrame GetTraceStackFrame(uint32_t depth) const {
428 return trace_stack_->at(trace_stack_->size() - depth - 1);
429 }
430
jeffhaoe343b762011-12-05 16:36:44 -0800431 void PushTraceStackFrame(const TraceStackFrame& frame) {
432 trace_stack_->push_back(frame);
433 }
434
435 TraceStackFrame PopTraceStackFrame() {
436 TraceStackFrame frame = trace_stack_->back();
437 trace_stack_->pop_back();
438 return frame;
439 }
440
Elliott Hughesa4060e52012-03-02 16:51:35 -0800441 void CheckSafeToLockOrUnlock(MutexRank rank, bool is_locking);
442 void CheckSafeToWait(MutexRank rank);
Elliott Hughesffb465f2012-03-01 18:46:05 -0800443
Carl Shapiro0e5d75d2011-07-06 18:28:37 -0700444 private:
Elliott Hughesdcc24742011-09-07 14:02:44 -0700445 Thread();
Elliott Hughesc1674ed2011-08-25 18:09:09 -0700446 ~Thread();
Elliott Hughesc0f09332012-03-26 13:27:06 -0700447 void Destroy();
448 friend class ThreadList; // For ~Thread and Destroy.
Carl Shapiro0e5d75d2011-07-06 18:28:37 -0700449
Elliott Hughes462c9442012-03-23 18:47:50 -0700450 void CreatePeer(const char* name, bool as_daemon, Object* thread_group);
Elliott Hughes5fe594f2011-09-08 12:33:17 -0700451 friend class Runtime; // For CreatePeer.
452
Elliott Hughesd92bec42011-09-02 17:04:36 -0700453 void DumpState(std::ostream& os) const;
454 void DumpStack(std::ostream& os) const;
Elliott Hughesffb465f2012-03-01 18:46:05 -0800455 void DumpNativeStack(std::ostream& os) const;
Elliott Hughesd92bec42011-09-02 17:04:36 -0700456
Elliott Hughesaccd83d2011-10-17 14:25:58 -0700457 // Out-of-line conveniences for debugging in gdb.
Elliott Hughes498508c2011-10-17 14:58:22 -0700458 static Thread* CurrentFromGdb(); // Like Thread::Current.
Elliott Hughesaccd83d2011-10-17 14:25:58 -0700459 void DumpFromGdb() const; // Like Thread::Dump(std::cerr).
460
Elliott Hughes93e74e82011-09-13 11:07:03 -0700461 static void* CreateCallback(void* arg);
462
Elliott Hughesaccd83d2011-10-17 14:25:58 -0700463 void HandleUncaughtExceptions();
Brian Carlstrom4514d3c2011-10-21 17:01:31 -0700464 void RemoveFromThreadGroup();
Elliott Hughesaccd83d2011-10-17 14:25:58 -0700465
Elliott Hughes462c9442012-03-23 18:47:50 -0700466 void Init();
Ian Rogers5d76c432011-10-31 21:42:49 -0700467 void InitCardTable();
Ian Rogersb033c752011-07-20 12:22:35 -0700468 void InitCpu();
buzbee3ea4ec52011-08-22 17:37:19 -0700469 void InitFunctionPointers();
Brian Carlstromcaabb1b2011-10-11 18:09:13 -0700470 void InitTid();
Brian Carlstromcaabb1b2011-10-11 18:09:13 -0700471 void InitPthreadKeySelf();
Elliott Hughesbe759c62011-09-08 19:38:21 -0700472 void InitStackHwm();
473
Elliott Hughes5f791332011-09-15 17:45:30 -0700474 void NotifyLocked() {
475 if (wait_monitor_ != NULL) {
Elliott Hughes85d15452011-09-16 17:33:01 -0700476 wait_cond_->Signal();
Elliott Hughes5f791332011-09-15 17:45:30 -0700477 }
478 }
479
Elliott Hughesbe759c62011-09-08 19:38:21 -0700480 static void ThreadExitCallback(void* arg);
Ian Rogersb033c752011-07-20 12:22:35 -0700481
Elliott Hughesdcc24742011-09-07 14:02:44 -0700482 // Thin lock thread id. This is a small integer used by the thin lock implementation.
483 // This is not to be confused with the native thread's tid, nor is it the value returned
484 // by java.lang.Thread.getId --- this is a distinct value, used only for locking. One
485 // important difference between this id and the ids visible to managed code is that these
486 // ones get reused (to ensure that they fit in the number of bits available).
487 uint32_t thin_lock_id_;
Ian Rogersb033c752011-07-20 12:22:35 -0700488
Elliott Hughesd92bec42011-09-02 17:04:36 -0700489 // System thread id.
490 pid_t tid_;
491
Elliott Hughesdcc24742011-09-07 14:02:44 -0700492 // Our managed peer (an instance of java.lang.Thread).
Elliott Hughesd369bb72011-09-12 14:41:14 -0700493 Object* peer_;
Elliott Hughes8daa0922011-09-11 13:46:25 -0700494
Elliott Hughes8e4aac52011-09-26 17:03:36 -0700495 // The top_of_managed_stack_ and top_of_managed_stack_pc_ fields are accessed from
496 // compiled code, so we keep them early in the structure to (a) avoid having to keep
497 // fixing the assembler offsets and (b) improve the chances that these will still be aligned.
498
499 // Top of the managed stack, written out prior to the state transition from
Elliott Hughes68e76522011-10-05 13:22:16 -0700500 // kRunnable to kNative. Uses include giving the starting point for scanning
Elliott Hughes8e4aac52011-09-26 17:03:36 -0700501 // a managed stack when a thread is in native code.
502 Frame top_of_managed_stack_;
503 // PC corresponding to the call out of the top_of_managed_stack_ frame
504 uintptr_t top_of_managed_stack_pc_;
505
Elliott Hughes8daa0922011-09-11 13:46:25 -0700506 // Guards the 'interrupted_' and 'wait_monitor_' members.
Elliott Hughes85d15452011-09-16 17:33:01 -0700507 mutable Mutex* wait_mutex_;
508 ConditionVariable* wait_cond_;
Elliott Hughes8daa0922011-09-11 13:46:25 -0700509 // Pointer to the monitor lock we're currently waiting on (or NULL), guarded by wait_mutex_.
510 Monitor* wait_monitor_;
511 // Thread "interrupted" status; stays raised until queried or thrown, guarded by wait_mutex_.
Elliott Hughes8e4aac52011-09-26 17:03:36 -0700512 uint32_t interrupted_;
Elliott Hughes5f791332011-09-15 17:45:30 -0700513 // The next thread in the wait set this thread is part of.
514 Thread* wait_next_;
Elliott Hughes8e4aac52011-09-26 17:03:36 -0700515 // If we're blocked in MonitorEnter, this is the object we're trying to lock.
516 Object* monitor_enter_object_;
Elliott Hughes5f791332011-09-15 17:45:30 -0700517
518 friend class Monitor;
Elliott Hughesdcc24742011-09-07 14:02:44 -0700519
Elliott Hughes9d5ccec2011-09-19 13:19:50 -0700520 RuntimeStats stats_;
521
Ian Rogers5d76c432011-10-31 21:42:49 -0700522 // The biased card table, see CardTable for details
523 byte* card_table_;
buzbeec143c552011-08-20 17:38:58 -0700524
Elliott Hughes449b4bd2011-09-09 12:01:38 -0700525 // The end of this thread's stack. This is the lowest safely-addressable address on the stack.
526 // We leave extra space so there's room for the code that throws StackOverflowError.
527 byte* stack_end_;
Elliott Hughesbe759c62011-09-08 19:38:21 -0700528
Ian Rogers932746a2011-09-22 18:57:50 -0700529 // Size of the stack
530 size_t stack_size_;
531
532 // The "lowest addressable byte" of the stack
Ian Rogers30fab402012-01-23 15:43:46 -0800533 byte* stack_begin_;
Ian Rogers932746a2011-09-22 18:57:50 -0700534
Ian Rogers6de08602011-08-19 14:52:39 -0700535 // A linked list (of stack allocated records) recording transitions from
536 // native to managed code.
537 NativeToManagedRecord* native_to_managed_record_;
538
Ian Rogers408f79a2011-08-23 18:22:33 -0700539 // Top of linked list of stack indirect reference tables or NULL for none
540 StackIndirectReferenceTable* top_sirt_;
Ian Rogersb033c752011-07-20 12:22:35 -0700541
542 // Every thread may have an associated JNI environment
Elliott Hughes69f5bc62011-08-24 09:26:14 -0700543 JNIEnvExt* jni_env_;
Ian Rogersb033c752011-07-20 12:22:35 -0700544
Elliott Hughes93e74e82011-09-13 11:07:03 -0700545 volatile State state_;
Carl Shapirob5573532011-07-12 18:22:59 -0700546
Carl Shapiro69759ea2011-07-21 18:13:35 -0700547 // Initialized to "this". On certain architectures (such as x86) reading
548 // off of Thread::Current is easy but getting the address of Thread::Current
549 // is hard. This field can be read off of Thread::Current to give the address.
550 Thread* self_;
551
552 Runtime* runtime_;
553
554 // The pending exception or NULL.
Elliott Hughese5b0dc82011-08-23 09:59:02 -0700555 Throwable* exception_;
Carl Shapiro0e5d75d2011-07-06 18:28:37 -0700556
Ian Rogers45a76cb2011-07-21 22:00:15 -0700557 // A non-zero value is used to tell the current thread to enter a safe point
558 // at the next poll.
559 int suspend_count_;
Elliott Hughes234ab152011-10-26 14:02:26 -0700560 // How much of 'suspend_count_' is by request of the debugger, used to set things right
561 // when the debugger detaches. Must be <= suspend_count_.
562 int debug_suspend_count_;
Ian Rogers45a76cb2011-07-21 22:00:15 -0700563
Elliott Hughesedcc09c2011-08-21 18:47:05 -0700564 // Needed to get the right ClassLoader in JNI_OnLoad, but also
565 // useful for testing.
Brian Carlstrombffb1552011-08-25 12:23:53 -0700566 const ClassLoader* class_loader_override_;
buzbeec143c552011-08-20 17:38:58 -0700567
Ian Rogersbdb03912011-09-14 00:55:44 -0700568 // Thread local, lazily allocated, long jump context. Used to deliver exceptions.
Elliott Hughes85d15452011-09-16 17:33:01 -0700569 Context* long_jump_context_;
Ian Rogersbdb03912011-09-14 00:55:44 -0700570
Elliott Hughes418dfe72011-10-06 18:56:27 -0700571 // A boolean telling us whether we're recursively throwing OOME.
Elliott Hughes726079d2011-10-07 18:43:44 -0700572 uint32_t throwing_OutOfMemoryError_;
573
574 Throwable* pre_allocated_OutOfMemoryError_;
Elliott Hughes418dfe72011-10-06 18:56:27 -0700575
Elliott Hughes475fc232011-10-25 15:00:35 -0700576 // JDWP invoke-during-breakpoint support.
577 DebugInvokeReq* debug_invoke_req_;
578
Elliott Hughes81ff3182012-03-23 20:35:56 -0700579 // TLS key used to retrieve the Thread*.
Carl Shapirob5573532011-07-12 18:22:59 -0700580 static pthread_key_t pthread_key_self_;
581
jeffhaoe343b762011-12-05 16:36:44 -0800582 // Additional stack used by method tracer to store method and return pc values.
583 // Stored as a pointer since std::vector is not PACKED.
584 std::vector<TraceStackFrame>* trace_stack_;
585
Elliott Hughes899e7892012-01-24 14:57:32 -0800586 // A cached copy of the java.lang.Thread's name.
587 std::string* name_;
588
Elliott Hughesffb465f2012-03-01 18:46:05 -0800589 uint32_t held_mutexes_[kMaxMutexRank + 1];
590
Ian Rogersa32a6fd2012-02-06 20:18:44 -0800591 public:
592 // Runtime support function pointers
593 void (*pDebugMe)(Method*, uint32_t);
594 void* (*pMemcpy)(void*, const void*, size_t);
595 uint64_t (*pShlLong)(uint64_t, uint32_t);
596 uint64_t (*pShrLong)(uint64_t, uint32_t);
597 uint64_t (*pUshrLong)(uint64_t, uint32_t);
598 float (*pI2f)(int);
599 int (*pF2iz)(float);
600 float (*pD2f)(double);
601 double (*pF2d)(float);
602 double (*pI2d)(int);
603 int (*pD2iz)(double);
Ian Rogersc6f3bb82012-03-21 20:40:33 -0700604 float (*pL2f)(int64_t);
605 double (*pL2d)(int64_t);
606 int64_t (*pF2l)(float);
607 int64_t (*pD2l)(double);
Ian Rogersa32a6fd2012-02-06 20:18:44 -0800608 float (*pFadd)(float, float);
609 float (*pFsub)(float, float);
610 float (*pFdiv)(float, float);
611 float (*pFmul)(float, float);
612 float (*pFmodf)(float, float);
613 double (*pDadd)(double, double);
614 double (*pDsub)(double, double);
615 double (*pDdiv)(double, double);
616 double (*pDmul)(double, double);
617 double (*pFmod)(double, double);
618 int (*pIdivmod)(int, int);
619 int (*pIdiv)(int, int);
Ian Rogersc6f3bb82012-03-21 20:40:33 -0700620 int64_t (*pLadd)(int64_t, int64_t);
621 int64_t (*pLsub)(int64_t, int64_t);
622 int64_t (*pLand)(int64_t, int64_t);
623 int64_t (*pLor)(int64_t, int64_t);
624 int64_t (*pLxor)(int64_t, int64_t);
625 int64_t (*pLmul)(int64_t, int64_t);
626 int64_t (*pLdivmod)(int64_t, int64_t);
Ian Rogersa32a6fd2012-02-06 20:18:44 -0800627 void (*pCheckSuspendFromCode)(Thread*); // Stub that is called when the suspend count is non-zero
628 void (*pTestSuspendFromCode)(); // Stub that is periodically called to test the suspend count
629 void* (*pAllocObjectFromCode)(uint32_t, void*);
630 void* (*pAllocObjectFromCodeWithAccessCheck)(uint32_t, void*);
631 void* (*pAllocArrayFromCode)(uint32_t, void*, int32_t);
632 void* (*pAllocArrayFromCodeWithAccessCheck)(uint32_t, void*, int32_t);
633 void (*pCanPutArrayElementFromCode)(void*, void*);
634 void* (*pCheckAndAllocArrayFromCode)(uint32_t, void*, int32_t);
635 void* (*pCheckAndAllocArrayFromCodeWithAccessCheck)(uint32_t, void*, int32_t);
636 void (*pCheckCastFromCode)(void*, void*);
637 Object* (*pDecodeJObjectInThread)(Thread* thread, jobject obj);
638 void (*pDeliverException)(void*);
639 Method* (*pFindInterfaceMethodInCache)(Class*, uint32_t, const Method*, struct DvmDex*);
640 void* (*pFindNativeMethod)(Thread* thread);
641 int32_t (*pGet32Instance)(uint32_t, void*);
642 int64_t (*pGet64Instance)(uint32_t, void*);
643 void* (*pGetObjInstance)(uint32_t, void*);
644 int32_t (*pGet32Static)(uint32_t);
645 int64_t (*pGet64Static)(uint32_t);
646 void* (*pGetObjStatic)(uint32_t);
647 void (*pHandleFillArrayDataFromCode)(void*, void*);
648 void* (*pInitializeStaticStorage)(uint32_t, void*);
649 uint32_t (*pInstanceofNonTrivialFromCode)(const Class*, const Class*);
Ian Rogersc8b306f2012-02-17 21:34:44 -0800650 void (*pInvokeDirectTrampolineWithAccessCheck)(uint32_t, void*);
Ian Rogersa32a6fd2012-02-06 20:18:44 -0800651 void (*pInvokeInterfaceTrampoline)(uint32_t, void*);
652 void (*pInvokeInterfaceTrampolineWithAccessCheck)(uint32_t, void*);
Ian Rogersc8b306f2012-02-17 21:34:44 -0800653 void (*pInvokeStaticTrampolineWithAccessCheck)(uint32_t, void*);
Ian Rogersa32a6fd2012-02-06 20:18:44 -0800654 void (*pInvokeSuperTrampolineWithAccessCheck)(uint32_t, void*);
655 void (*pInvokeVirtualTrampolineWithAccessCheck)(uint32_t, void*);
656 void* (*pInitializeTypeFromCode)(uint32_t, void*);
657 void* (*pInitializeTypeAndVerifyAccessFromCode)(uint32_t, void*);
658 void (*pLockObjectFromCode)(void*);
Ian Rogersa32a6fd2012-02-06 20:18:44 -0800659 void* (*pResolveStringFromCode)(void*, uint32_t);
660 int (*pSet32Instance)(uint32_t, void*, int32_t); // field_idx, obj, src
661 int (*pSet64Instance)(uint32_t, void*, int64_t);
662 int (*pSetObjInstance)(uint32_t, void*, void*);
663 int (*pSet32Static)(uint32_t, int32_t);
664 int (*pSet64Static)(uint32_t, int64_t);
665 int (*pSetObjStatic)(uint32_t, void*);
666 void (*pThrowStackOverflowFromCode)(void*);
667 void (*pThrowNullPointerFromCode)();
668 void (*pThrowArrayBoundsFromCode)(int32_t, int32_t);
669 void (*pThrowDivZeroFromCode)();
670 void (*pThrowVerificationErrorFromCode)(int32_t, int32_t);
671 void (*pThrowNegArraySizeFromCode)(int32_t);
672 void (*pThrowNoSuchMethodFromCode)(int32_t);
673 void (*pThrowAbstractMethodErrorFromCode)(Method* method, Thread* thread, Method** sp);
674 void (*pUnlockObjectFromCode)(void*);
Ian Rogers19846512012-02-24 11:42:47 -0800675 const void* (*pUnresolvedDirectMethodTrampolineFromCode)(Method*, Method**, Thread*,
676 Runtime::TrampolineType);
Ian Rogersa32a6fd2012-02-06 20:18:44 -0800677 void (*pUpdateDebuggerFromCode)(void*, void*, int32_t, void*);
Bill Buzbee11f9d212012-03-03 20:03:18 -0800678 bool (*pCmplFloat)(float, float);
679 bool (*pCmpgFloat)(float, float);
680 bool (*pCmplDouble)(double, double);
681 bool (*pCmpgDouble)(double, double);
buzbeefc9e6fa2012-03-23 15:14:29 -0700682 int (*pIndexOf)(void*, uint32_t, uint32_t, uint32_t);
683 int (*pStringCompareTo)(void*, void*);
684 int (*pMemcmp16)(void*, void*, int32_t);
Ian Rogersa32a6fd2012-02-06 20:18:44 -0800685
686 private:
Carl Shapiro0e5d75d2011-07-06 18:28:37 -0700687 DISALLOW_COPY_AND_ASSIGN(Thread);
688};
Ian Rogersbdb03912011-09-14 00:55:44 -0700689
Elliott Hughes330304d2011-08-12 14:28:05 -0700690std::ostream& operator<<(std::ostream& os, const Thread& thread);
Ian Rogersb033c752011-07-20 12:22:35 -0700691std::ostream& operator<<(std::ostream& os, const Thread::State& state);
Carl Shapiro0e5d75d2011-07-06 18:28:37 -0700692
Elliott Hughesad7c2a32011-08-31 11:58:10 -0700693class ScopedThreadStateChange {
694 public:
695 ScopedThreadStateChange(Thread* thread, Thread::State new_state) : thread_(thread) {
696 old_thread_state_ = thread_->SetState(new_state);
697 }
698
699 ~ScopedThreadStateChange() {
700 thread_->SetState(old_thread_state_);
701 }
702
703 private:
704 Thread* thread_;
705 Thread::State old_thread_state_;
706 DISALLOW_COPY_AND_ASSIGN(ScopedThreadStateChange);
707};
708
Carl Shapiro0e5d75d2011-07-06 18:28:37 -0700709} // namespace art
710
711#endif // ART_SRC_THREAD_H_