blob: 9ebe00cf912e29598b5c4e0b03a3fe9f95baa2ca [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"
Ian Rogers57b86d42012-03-27 16:05:41 -070035#include "oat/runtime/oat_support_entrypoints.h"
Brian Carlstrom578bbdc2011-07-21 14:07:47 -070036#include "offsets.h"
Elliott Hughes9d5ccec2011-09-19 13:19:50 -070037#include "runtime_stats.h"
Elliott Hughes68e76522011-10-05 13:22:16 -070038#include "stack.h"
jeffhaoe343b762011-12-05 16:36:44 -080039#include "trace.h"
Ian Rogersbdb03912011-09-14 00:55:44 -070040#include "UniquePtr.h"
Ian Rogersb033c752011-07-20 12:22:35 -070041
Carl Shapiro0e5d75d2011-07-06 18:28:37 -070042namespace art {
43
Elliott Hughes69f5bc62011-08-24 09:26:14 -070044class Array;
Elliott Hughes37f7a402011-08-22 18:56:01 -070045class Class;
Brian Carlstrom1f870082011-08-23 16:02:11 -070046class ClassLinker;
Elliott Hughesedcc09c2011-08-21 18:47:05 -070047class ClassLoader;
Ian Rogersbdb03912011-09-14 00:55:44 -070048class Context;
Elliott Hughes475fc232011-10-25 15:00:35 -070049class DebugInvokeReq;
Brian Carlstroma40f9bc2011-07-26 21:26:07 -070050class Method;
Elliott Hughes8daa0922011-09-11 13:46:25 -070051class Monitor;
Carl Shapiro0e5d75d2011-07-06 18:28:37 -070052class Object;
Carl Shapirob5573532011-07-12 18:22:59 -070053class Runtime;
Logan Chienf7ad17e2012-03-15 03:10:03 +080054class ShadowFrame;
Elliott Hughes68e76522011-10-05 13:22:16 -070055class StackIndirectReferenceTable;
Shih-wei Liao55df06b2011-08-26 14:39:27 -070056class StackTraceElement;
buzbee1da522d2011-09-04 11:22:20 -070057class StaticStorageBase;
Brian Carlstrom40381fb2011-10-19 14:13:40 -070058class Thread;
59class ThreadList;
60class Throwable;
buzbee1da522d2011-09-04 11:22:20 -070061
Shih-wei Liao55df06b2011-08-26 14:39:27 -070062template<class T> class ObjectArray;
Shih-wei Liao44175362011-08-28 16:59:17 -070063template<class T> class PrimitiveArray;
64typedef PrimitiveArray<int32_t> IntArray;
Carl Shapiro0e5d75d2011-07-06 18:28:37 -070065
Elliott Hughes34e06962012-04-09 13:55:55 -070066// Thread priorities. These must match the Thread.MIN_PRIORITY,
67// Thread.NORM_PRIORITY, and Thread.MAX_PRIORITY constants.
68enum ThreadPriority {
69 kMinThreadPriority = 1,
70 kNormThreadPriority = 5,
71 kMaxThreadPriority = 10,
72};
73
74enum ThreadState {
75 kTerminated = 0, // Thread.TERMINATED JDWP TS_ZOMBIE
76 kRunnable = 1, // Thread.RUNNABLE JDWP TS_RUNNING
77 kTimedWaiting = 2, // Thread.TIMED_WAITING JDWP TS_WAIT - in Object.wait() with a timeout
78 kBlocked = 3, // Thread.BLOCKED JDWP TS_MONITOR - blocked on a monitor
79 kWaiting = 4, // Thread.WAITING JDWP TS_WAIT - in Object.wait()
80 kStarting = 5, // Thread.NEW - native thread started, not yet ready to run managed code
81 kNative = 6, // - running in a JNI native method
82 kVmWait = 7, // - waiting on an internal runtime resource
83 kSuspended = 8, // - suspended by GC or debugger
84};
85
Elliott Hughes85d15452011-09-16 17:33:01 -070086class PACKED Thread {
Carl Shapiro0e5d75d2011-07-06 18:28:37 -070087 public:
Ian Rogers932746a2011-09-22 18:57:50 -070088 // Space to throw a StackOverflowError in.
TDYa1274165a832012-04-03 17:47:16 -070089#if !defined(ART_USE_LLVM_COMPILER)
Brian Carlstromaded5f72011-10-07 17:15:04 -070090 static const size_t kStackOverflowReservedBytes = 4 * KB;
TDYa1274165a832012-04-03 17:47:16 -070091#else // LLVM_x86 requires more memory to throw stack overflow exception.
92 static const size_t kStackOverflowReservedBytes = 8 * KB;
93#endif
buzbeec143c552011-08-20 17:38:58 -070094
Brian Carlstrom6414a972012-04-14 14:20:04 -070095 static const size_t kDefaultStackSize = 16 * KB;
Carl Shapiro61e019d2011-07-14 16:53:09 -070096
Shih-wei Liao9b576b42011-08-29 01:45:07 -070097 class StackVisitor {
98 public:
Ian Rogers0cfe1fb2011-08-26 03:29:44 -070099 virtual ~StackVisitor() {}
Elliott Hughes530fa002012-03-12 11:44:49 -0700100 // Return 'true' if we should continue to visit more frames, 'false' to stop.
101 virtual bool VisitFrame(const Frame& frame, uintptr_t pc) = 0;
Shih-wei Liao9b576b42011-08-29 01:45:07 -0700102 };
103
Elliott Hughes462c9442012-03-23 18:47:50 -0700104 // Creates a new native thread corresponding to the given managed peer.
105 // Used to implement Thread.start.
Elliott Hughesd369bb72011-09-12 14:41:14 -0700106 static void Create(Object* peer, size_t stack_size);
Carl Shapiro61e019d2011-07-14 16:53:09 -0700107
Elliott Hughes462c9442012-03-23 18:47:50 -0700108 // Attaches the calling native thread to the runtime, returning the new native peer.
109 // Used to implement JNI AttachCurrentThread and AttachCurrentThreadAsDaemon calls.
110 static Thread* Attach(const char* thread_name, bool as_daemon, Object* thread_group);
Carl Shapirob5573532011-07-12 18:22:59 -0700111
Brian Carlstromcaabb1b2011-10-11 18:09:13 -0700112 // Reset internal state of child thread after fork.
113 void InitAfterFork();
114
Carl Shapirob5573532011-07-12 18:22:59 -0700115 static Thread* Current() {
Carl Shapirod0e7e772011-07-15 14:31:01 -0700116 void* thread = pthread_getspecific(Thread::pthread_key_self_);
117 return reinterpret_cast<Thread*>(thread);
Carl Shapiro0e5d75d2011-07-06 18:28:37 -0700118 }
119
Elliott Hughes761928d2011-11-16 18:33:03 -0800120 static Thread* FromManagedThread(Object* thread_peer);
Elliott Hughes01158d72011-09-19 19:47:10 -0700121 static Thread* FromManagedThread(JNIEnv* env, jobject thread);
Elliott Hughes8e4aac52011-09-26 17:03:36 -0700122 static uint32_t LockOwnerFromThreadLock(Object* thread_lock);
Elliott Hughes8daa0922011-09-11 13:46:25 -0700123
Elliott Hughes28fa76d2012-04-09 17:31:46 -0700124 // Translates 172 to pAllocArrayFromCode and so on.
125 static void DumpThreadOffset(std::ostream& os, uint32_t offset, size_t size_of_pointers);
126
Elliott Hughes899e7892012-01-24 14:57:32 -0800127 // When full == true, dumps the detailed thread state and the thread stack (used for SIGQUIT).
128 // When full == false, dumps a one-line summary of thread state (used for operator<<).
129 void Dump(std::ostream& os, bool full = true) const;
Elliott Hughesa0957642011-09-02 14:27:33 -0700130
Elliott Hughes34e06962012-04-09 13:55:55 -0700131 ThreadState GetState() const {
Ian Rogers0cfe1fb2011-08-26 03:29:44 -0700132 return state_;
133 }
134
Elliott Hughes34e06962012-04-09 13:55:55 -0700135 ThreadState SetState(ThreadState new_state);
136 void SetStateWithoutSuspendCheck(ThreadState new_state);
Elliott Hughes8d768a92011-09-14 16:35:25 -0700137
Elliott Hughes038a8062011-09-18 14:12:41 -0700138 bool IsDaemon();
Elliott Hughes761928d2011-11-16 18:33:03 -0800139 bool IsSuspended();
Elliott Hughes038a8062011-09-18 14:12:41 -0700140
Elliott Hughes8d768a92011-09-14 16:35:25 -0700141 void WaitUntilSuspended();
Ian Rogers0cfe1fb2011-08-26 03:29:44 -0700142
Elliott Hughes5f791332011-09-15 17:45:30 -0700143 bool HoldsLock(Object*);
144
Elliott Hughes8daa0922011-09-11 13:46:25 -0700145 /*
146 * Changes the priority of this thread to match that of the java.lang.Thread object.
147 *
148 * We map a priority value from 1-10 to Linux "nice" values, where lower
149 * numbers indicate higher priority.
150 */
151 void SetNativePriority(int newPriority);
152
153 /*
154 * Returns the thread priority for the current thread by querying the system.
155 * This is useful when attaching a thread through JNI.
156 *
157 * Returns a value from 1 to 10 (compatible with java.lang.Thread values).
158 */
159 static int GetNativePriority();
160
Elliott Hughes462c9442012-03-23 18:47:50 -0700161 // Returns the "main" ThreadGroup, used when attaching user threads.
162 static Object* GetMainThreadGroup();
163 // Returns the "system" ThreadGroup, used when attaching our internal threads.
164 static Object* GetSystemThreadGroup();
165
Ian Rogers0cfe1fb2011-08-26 03:29:44 -0700166 bool CanAccessDirectReferences() const {
Brian Carlstromcaabb1b2011-10-11 18:09:13 -0700167#ifdef MOVING_GARBAGE_COLLECTOR
Elliott Hughesa59d1792011-09-04 18:42:35 -0700168 // TODO: when we have a moving collector, we'll need: return state_ == kRunnable;
Brian Carlstromcaabb1b2011-10-11 18:09:13 -0700169#endif
Elliott Hughesa59d1792011-09-04 18:42:35 -0700170 return true;
Ian Rogers0cfe1fb2011-08-26 03:29:44 -0700171 }
172
Elliott Hughesdcc24742011-09-07 14:02:44 -0700173 uint32_t GetThinLockId() const {
174 return thin_lock_id_;
Carl Shapirob5573532011-07-12 18:22:59 -0700175 }
176
Elliott Hughesd92bec42011-09-02 17:04:36 -0700177 pid_t GetTid() const {
178 return tid_;
179 }
Elliott Hughese27955c2011-08-26 15:21:24 -0700180
Elliott Hughesffb465f2012-03-01 18:46:05 -0800181 // Returns the java.lang.Thread's name, or NULL if this Thread* doesn't have a peer.
Elliott Hughes899e7892012-01-24 14:57:32 -0800182 String* GetThreadName() const;
183
Elliott Hughesffb465f2012-03-01 18:46:05 -0800184 // Sets 'name' to the java.lang.Thread's name. This requires no transition to managed code,
185 // allocation, or locking.
186 void GetThreadName(std::string& name) const;
187
Elliott Hughes899e7892012-01-24 14:57:32 -0800188 // Sets the thread's name.
189 void SetThreadName(const char* name);
Elliott Hughesfc861622011-10-17 17:57:47 -0700190
Elliott Hughesd369bb72011-09-12 14:41:14 -0700191 Object* GetPeer() const {
Elliott Hughes8daa0922011-09-11 13:46:25 -0700192 return peer_;
193 }
194
Elliott Hughesa2155262011-11-16 16:26:58 -0800195 Object* GetThreadGroup() const;
196
Elliott Hughes9d5ccec2011-09-19 13:19:50 -0700197 RuntimeStats* GetStats() {
198 return &stats_;
199 }
200
Elliott Hughesd07986f2011-12-06 18:27:45 -0800201 int GetSuspendCount() const {
202 return suspend_count_;
203 }
Ian Rogers0cfe1fb2011-08-26 03:29:44 -0700204
Elliott Hughes7dc51662012-05-16 14:48:43 -0700205 bool IsStillStarting() const;
206
Elliott Hughesd07986f2011-12-06 18:27:45 -0800207 // Returns the current Method* and native PC (not dex PC) for this thread.
208 Method* GetCurrentMethod(uintptr_t* pc = NULL, Method*** sp = NULL) const;
jeffhao33dc7712011-11-09 17:54:24 -0800209
Carl Shapiro0e5d75d2011-07-06 18:28:37 -0700210 bool IsExceptionPending() const {
Elliott Hughesb20a5542011-08-12 18:03:12 -0700211 return exception_ != NULL;
Carl Shapiro0e5d75d2011-07-06 18:28:37 -0700212 }
213
Elliott Hughese5b0dc82011-08-23 09:59:02 -0700214 Throwable* GetException() const {
Ian Rogers0cfe1fb2011-08-26 03:29:44 -0700215 DCHECK(CanAccessDirectReferences());
Carl Shapiro0e5d75d2011-07-06 18:28:37 -0700216 return exception_;
217 }
218
Ian Rogers0cfe1fb2011-08-26 03:29:44 -0700219 void SetException(Throwable* new_exception) {
220 DCHECK(CanAccessDirectReferences());
221 CHECK(new_exception != NULL);
222 // TODO: CHECK(exception_ == NULL);
223 exception_ = new_exception; // TODO
224 }
225
226 void ClearException() {
227 exception_ = NULL;
Elliott Hughesa0957642011-09-02 14:27:33 -0700228 }
229
Ian Rogersbdb03912011-09-14 00:55:44 -0700230 // Find catch block and perform long jump to appropriate exception handle
Ian Rogersff1ed472011-09-20 13:46:24 -0700231 void DeliverException();
Ian Rogersbdb03912011-09-14 00:55:44 -0700232
233 Context* GetLongJumpContext();
234
Shih-wei Liao1a18c8c2011-08-14 17:47:36 -0700235 Frame GetTopOfStack() const {
236 return top_of_managed_stack_;
237 }
238
239 // TODO: this is here for testing, remove when we have exception unit tests
240 // that use the real stack
Ian Rogersbdb03912011-09-14 00:55:44 -0700241 void SetTopOfStack(void* stack, uintptr_t pc) {
Ian Rogers0cfe1fb2011-08-26 03:29:44 -0700242 top_of_managed_stack_.SetSP(reinterpret_cast<Method**>(stack));
Ian Rogersbdb03912011-09-14 00:55:44 -0700243 top_of_managed_stack_pc_ = pc;
Carl Shapiro0e5d75d2011-07-06 18:28:37 -0700244 }
245
Ian Rogersbdb03912011-09-14 00:55:44 -0700246 void SetTopOfStackPC(uintptr_t pc) {
247 top_of_managed_stack_pc_ = pc;
248 }
249
Elliott Hughesa4f94742012-05-29 16:28:38 -0700250 // If 'msg' is NULL, no detail message is set.
Elliott Hughes5cb5ad22011-10-02 12:13:39 -0700251 void ThrowNewException(const char* exception_class_descriptor, const char* msg);
252
Elliott Hughesa4f94742012-05-29 16:28:38 -0700253 // If 'msg' is NULL, no detail message is set. An exception must be pending, and will be
254 // used as the new exception's cause.
255 void ThrowNewWrappedException(const char* exception_class_descriptor, const char* msg);
256
Elliott Hughes5cb5ad22011-10-02 12:13:39 -0700257 void ThrowNewExceptionF(const char* exception_class_descriptor, const char* fmt, ...)
Elliott Hughes362f9bc2011-10-17 18:56:41 -0700258 __attribute__((format(printf, 3, 4)));
Elliott Hughesa5b897e2011-08-16 11:33:06 -0700259
Elliott Hughes4a2b4172011-09-20 17:08:25 -0700260 void ThrowNewExceptionV(const char* exception_class_descriptor, const char* fmt, va_list ap);
261
Elliott Hughes2ced6a52011-10-16 18:44:48 -0700262 // OutOfMemoryError is special, because we need to pre-allocate an instance.
Elliott Hughes8a8b9cb2012-04-13 18:29:22 -0700263 // Only the GC should call this.
Elliott Hughes2ced6a52011-10-16 18:44:48 -0700264 void ThrowOutOfMemoryError(const char* msg);
Elliott Hughes79082e32011-08-25 12:07:32 -0700265
Shih-wei Liao1a18c8c2011-08-14 17:47:36 -0700266 Frame FindExceptionHandler(void* throw_pc, void** handler_pc);
267
268 void* FindExceptionHandlerInMethod(const Method* method,
269 void* throw_pc,
270 const DexFile& dex_file,
271 ClassLinker* class_linker);
buzbeec143c552011-08-20 17:38:58 -0700272
Elliott Hughesbe759c62011-09-08 19:38:21 -0700273 static void Startup();
Elliott Hughes038a8062011-09-18 14:12:41 -0700274 static void FinishStartup();
Elliott Hughesc1674ed2011-08-25 18:09:09 -0700275 static void Shutdown();
Carl Shapirob5573532011-07-12 18:22:59 -0700276
Ian Rogersb033c752011-07-20 12:22:35 -0700277 // JNI methods
Elliott Hughes69f5bc62011-08-24 09:26:14 -0700278 JNIEnvExt* GetJniEnv() const {
Ian Rogersb033c752011-07-20 12:22:35 -0700279 return jni_env_;
280 }
281
TDYa12728f1a142012-03-15 21:51:52 -0700282 // Number of references in SIRTs on this thread
Ian Rogers408f79a2011-08-23 18:22:33 -0700283 size_t NumSirtReferences();
Ian Rogersa8cd9f42011-08-19 16:43:41 -0700284
TDYa12728f1a142012-03-15 21:51:52 -0700285 // Number of references allocated in ShadowFrames on this thread
286 size_t NumShadowFrameReferences();
287
288 // Number of references allocated in SIRTs & shadow frames on this thread
289 size_t NumStackReferences() {
290 return NumSirtReferences() + NumShadowFrameReferences();
291 };
292
Ian Rogers408f79a2011-08-23 18:22:33 -0700293 // Is the given obj in this thread's stack indirect reference table?
294 bool SirtContains(jobject obj);
295
TDYa12728f1a142012-03-15 21:51:52 -0700296 // Is the given obj in this thread's ShadowFrame?
297 bool ShadowFrameContains(jobject obj);
298
299 // Is the given obj in this thread's Sirts & ShadowFrames?
300 bool StackReferencesContain(jobject obj);
301
Shih-wei Liao8dfc9d52011-09-28 18:06:15 -0700302 void SirtVisitRoots(Heap::RootVisitor* visitor, void* arg);
303
Logan Chienf7ad17e2012-03-15 03:10:03 +0800304 void ShadowFrameVisitRoots(Heap::RootVisitor* visitor, void* arg);
305
Ian Rogers408f79a2011-08-23 18:22:33 -0700306 // Convert a jobject into a Object*
307 Object* DecodeJObject(jobject obj);
Ian Rogersb033c752011-07-20 12:22:35 -0700308
Elliott Hughes8daa0922011-09-11 13:46:25 -0700309 // Implements java.lang.Thread.interrupted.
310 bool Interrupted() {
Elliott Hughes85d15452011-09-16 17:33:01 -0700311 MutexLock mu(*wait_mutex_);
Elliott Hughes8daa0922011-09-11 13:46:25 -0700312 bool interrupted = interrupted_;
313 interrupted_ = false;
314 return interrupted;
315 }
316
317 // Implements java.lang.Thread.isInterrupted.
318 bool IsInterrupted() {
Elliott Hughes85d15452011-09-16 17:33:01 -0700319 MutexLock mu(*wait_mutex_);
Elliott Hughes8daa0922011-09-11 13:46:25 -0700320 return interrupted_;
321 }
322
Elliott Hughes5f791332011-09-15 17:45:30 -0700323 void Interrupt() {
Elliott Hughes85d15452011-09-16 17:33:01 -0700324 MutexLock mu(*wait_mutex_);
Elliott Hughes5f791332011-09-15 17:45:30 -0700325 if (interrupted_) {
326 return;
327 }
328 interrupted_ = true;
329 NotifyLocked();
330 }
331
332 void Notify() {
Elliott Hughes85d15452011-09-16 17:33:01 -0700333 MutexLock mu(*wait_mutex_);
Elliott Hughes5f791332011-09-15 17:45:30 -0700334 NotifyLocked();
335 }
336
Ian Rogers6de08602011-08-19 14:52:39 -0700337 // Linked list recording transitions from native to managed code
Ian Rogersb04f69f2011-10-17 00:40:54 -0700338 void PushNativeToManagedRecord(NativeToManagedRecord* record);
339 void PopNativeToManagedRecord(const NativeToManagedRecord& record);
Ian Rogers6de08602011-08-19 14:52:39 -0700340
Brian Carlstrombffb1552011-08-25 12:23:53 -0700341 const ClassLoader* GetClassLoaderOverride() {
Ian Rogers0cfe1fb2011-08-26 03:29:44 -0700342 // TODO: need to place the class_loader_override_ in a handle
343 // DCHECK(CanAccessDirectReferences());
buzbeec143c552011-08-20 17:38:58 -0700344 return class_loader_override_;
345 }
346
Brian Carlstrombffb1552011-08-25 12:23:53 -0700347 void SetClassLoaderOverride(const ClassLoader* class_loader_override) {
buzbeec143c552011-08-20 17:38:58 -0700348 class_loader_override_ = class_loader_override;
349 }
350
Ian Rogersaaa20802011-09-11 21:47:37 -0700351 // Create the internal representation of a stack trace, that is more time
352 // and space efficient to compute than the StackTraceElement[]
Elliott Hughes01158d72011-09-19 19:47:10 -0700353 jobject CreateInternalStackTrace(JNIEnv* env) const;
Ian Rogersaaa20802011-09-11 21:47:37 -0700354
Elliott Hughes01158d72011-09-19 19:47:10 -0700355 // Convert an internal stack trace representation (returned by CreateInternalStackTrace) to a
356 // StackTraceElement[]. If output_array is NULL, a new array is created, otherwise as many
357 // frames as will fit are written into the given array. If stack_depth is non-NULL, it's updated
358 // with the number of valid frames in the returned array.
359 static jobjectArray InternalStackTraceToStackTraceElementArray(JNIEnv* env, jobject internal,
360 jobjectArray output_array = NULL, int* stack_depth = NULL);
Shih-wei Liao55df06b2011-08-26 14:39:27 -0700361
Ian Rogersd6b1f612011-09-27 13:38:14 -0700362 void VisitRoots(Heap::RootVisitor* visitor, void* arg);
Elliott Hughes410c0c82011-09-01 17:58:25 -0700363
jeffhao25045522012-03-13 19:34:37 -0700364#if VERIFY_OBJECT_ENABLED
365 void VerifyStack();
366#else
367 void VerifyStack() {}
368#endif
369
Elliott Hughesbe759c62011-09-08 19:38:21 -0700370 //
371 // Offsets of various members of native Thread class, used by compiled code.
372 //
373
374 static ThreadOffset SelfOffset() {
375 return ThreadOffset(OFFSETOF_MEMBER(Thread, self_));
376 }
377
378 static ThreadOffset ExceptionOffset() {
379 return ThreadOffset(OFFSETOF_MEMBER(Thread, exception_));
380 }
381
Elliott Hughes54e7df12011-09-16 11:47:04 -0700382 static ThreadOffset ThinLockIdOffset() {
Elliott Hughesbe759c62011-09-08 19:38:21 -0700383 return ThreadOffset(OFFSETOF_MEMBER(Thread, thin_lock_id_));
384 }
385
386 static ThreadOffset CardTableOffset() {
387 return ThreadOffset(OFFSETOF_MEMBER(Thread, card_table_));
388 }
389
390 static ThreadOffset SuspendCountOffset() {
391 return ThreadOffset(OFFSETOF_MEMBER(Thread, suspend_count_));
392 }
393
394 static ThreadOffset StateOffset() {
Elliott Hughes93e74e82011-09-13 11:07:03 -0700395 return ThreadOffset(OFFSETOF_VOLATILE_MEMBER(Thread, state_));
Elliott Hughesbe759c62011-09-08 19:38:21 -0700396 }
397
Ian Rogers932746a2011-09-22 18:57:50 -0700398 // Size of stack less any space reserved for stack overflow
399 size_t GetStackSize() {
Ian Rogers30fab402012-01-23 15:43:46 -0800400 return stack_size_ - (stack_end_ - stack_begin_);
Ian Rogers932746a2011-09-22 18:57:50 -0700401 }
402
403 // Set the stack end to that to be used during a stack overflow
404 void SetStackEndForStackOverflow() {
405 // During stack overflow we allow use of the full stack
Ian Rogers30fab402012-01-23 15:43:46 -0800406 if (stack_end_ == stack_begin_) {
Elliott Hughes3b6baaa2011-10-14 19:13:56 -0700407 DumpStack(std::cerr);
408 LOG(FATAL) << "Need to increase kStackOverflowReservedBytes (currently "
409 << kStackOverflowReservedBytes << ")";
410 }
411
Ian Rogers30fab402012-01-23 15:43:46 -0800412 stack_end_ = stack_begin_;
Ian Rogers932746a2011-09-22 18:57:50 -0700413 }
414
415 // Set the stack end to that to be used during regular execution
416 void ResetDefaultStackEnd() {
417 // Our stacks grow down, so we want stack_end_ to be near there, but reserving enough room
418 // to throw a StackOverflowError.
Ian Rogers30fab402012-01-23 15:43:46 -0800419 stack_end_ = stack_begin_ + kStackOverflowReservedBytes;
Ian Rogers932746a2011-09-22 18:57:50 -0700420 }
421
Elliott Hughes449b4bd2011-09-09 12:01:38 -0700422 static ThreadOffset StackEndOffset() {
423 return ThreadOffset(OFFSETOF_MEMBER(Thread, stack_end_));
Elliott Hughesbe759c62011-09-08 19:38:21 -0700424 }
425
426 static ThreadOffset JniEnvOffset() {
427 return ThreadOffset(OFFSETOF_MEMBER(Thread, jni_env_));
428 }
429
430 static ThreadOffset TopOfManagedStackOffset() {
431 return ThreadOffset(OFFSETOF_MEMBER(Thread, top_of_managed_stack_) +
432 OFFSETOF_MEMBER(Frame, sp_));
433 }
434
Ian Rogersbdb03912011-09-14 00:55:44 -0700435 static ThreadOffset TopOfManagedStackPcOffset() {
436 return ThreadOffset(OFFSETOF_MEMBER(Thread, top_of_managed_stack_pc_));
437 }
438
Logan Chienf7ad17e2012-03-15 03:10:03 +0800439 void PushShadowFrame(ShadowFrame* frame);
440 ShadowFrame* PopShadowFrame();
441
TDYa127d668a062012-04-13 12:36:57 -0700442 static ThreadOffset TopShadowFrameOffset() {
443 return ThreadOffset(OFFSETOF_MEMBER(Thread, top_shadow_frame_));
444 }
445
Brian Carlstrom40381fb2011-10-19 14:13:40 -0700446 void PushSirt(StackIndirectReferenceTable* sirt);
447 StackIndirectReferenceTable* PopSirt();
448
Elliott Hughesbe759c62011-09-08 19:38:21 -0700449 static ThreadOffset TopSirtOffset() {
450 return ThreadOffset(OFFSETOF_MEMBER(Thread, top_sirt_));
451 }
452
Elliott Hughes530fa002012-03-12 11:44:49 -0700453 void WalkStack(StackVisitor* visitor, bool include_upcalls = false) const;
Shih-wei Liao9407c602011-09-16 10:36:43 -0700454
Elliott Hughes475fc232011-10-25 15:00:35 -0700455 DebugInvokeReq* GetInvokeReq() {
456 return debug_invoke_req_;
457 }
458
Elliott Hughesc0f09332012-03-26 13:27:06 -0700459 void SetDebuggerUpdatesEnabled(bool enabled);
460
jeffhaoe343b762011-12-05 16:36:44 -0800461 bool IsTraceStackEmpty() const {
462 return trace_stack_->empty();
463 }
464
jeffhaoa9ef3fd2011-12-13 18:33:43 -0800465 TraceStackFrame GetTraceStackFrame(uint32_t depth) const {
466 return trace_stack_->at(trace_stack_->size() - depth - 1);
467 }
468
jeffhaoe343b762011-12-05 16:36:44 -0800469 void PushTraceStackFrame(const TraceStackFrame& frame) {
470 trace_stack_->push_back(frame);
471 }
472
473 TraceStackFrame PopTraceStackFrame() {
474 TraceStackFrame frame = trace_stack_->back();
475 trace_stack_->pop_back();
476 return frame;
477 }
478
Elliott Hughesa4060e52012-03-02 16:51:35 -0800479 void CheckSafeToLockOrUnlock(MutexRank rank, bool is_locking);
480 void CheckSafeToWait(MutexRank rank);
Elliott Hughesffb465f2012-03-01 18:46:05 -0800481
Carl Shapiro0e5d75d2011-07-06 18:28:37 -0700482 private:
Elliott Hughesdcc24742011-09-07 14:02:44 -0700483 Thread();
Elliott Hughesc1674ed2011-08-25 18:09:09 -0700484 ~Thread();
Elliott Hughesc0f09332012-03-26 13:27:06 -0700485 void Destroy();
486 friend class ThreadList; // For ~Thread and Destroy.
Carl Shapiro0e5d75d2011-07-06 18:28:37 -0700487
Elliott Hughes462c9442012-03-23 18:47:50 -0700488 void CreatePeer(const char* name, bool as_daemon, Object* thread_group);
Elliott Hughes5fe594f2011-09-08 12:33:17 -0700489 friend class Runtime; // For CreatePeer.
490
Elliott Hughesd92bec42011-09-02 17:04:36 -0700491 void DumpState(std::ostream& os) const;
492 void DumpStack(std::ostream& os) const;
493
Elliott Hughesaccd83d2011-10-17 14:25:58 -0700494 // Out-of-line conveniences for debugging in gdb.
Elliott Hughes498508c2011-10-17 14:58:22 -0700495 static Thread* CurrentFromGdb(); // Like Thread::Current.
Elliott Hughesaccd83d2011-10-17 14:25:58 -0700496 void DumpFromGdb() const; // Like Thread::Dump(std::cerr).
497
Elliott Hughes93e74e82011-09-13 11:07:03 -0700498 static void* CreateCallback(void* arg);
499
Elliott Hughesaccd83d2011-10-17 14:25:58 -0700500 void HandleUncaughtExceptions();
Brian Carlstrom4514d3c2011-10-21 17:01:31 -0700501 void RemoveFromThreadGroup();
Elliott Hughesaccd83d2011-10-17 14:25:58 -0700502
Elliott Hughes462c9442012-03-23 18:47:50 -0700503 void Init();
Ian Rogers5d76c432011-10-31 21:42:49 -0700504 void InitCardTable();
Ian Rogersb033c752011-07-20 12:22:35 -0700505 void InitCpu();
buzbee3ea4ec52011-08-22 17:37:19 -0700506 void InitFunctionPointers();
Brian Carlstromcaabb1b2011-10-11 18:09:13 -0700507 void InitTid();
Brian Carlstromcaabb1b2011-10-11 18:09:13 -0700508 void InitPthreadKeySelf();
Elliott Hughesbe759c62011-09-08 19:38:21 -0700509 void InitStackHwm();
510
Elliott Hughes5f791332011-09-15 17:45:30 -0700511 void NotifyLocked() {
512 if (wait_monitor_ != NULL) {
Elliott Hughes85d15452011-09-16 17:33:01 -0700513 wait_cond_->Signal();
Elliott Hughes5f791332011-09-15 17:45:30 -0700514 }
515 }
516
Elliott Hughesbe759c62011-09-08 19:38:21 -0700517 static void ThreadExitCallback(void* arg);
Ian Rogersb033c752011-07-20 12:22:35 -0700518
Elliott Hughesdcc24742011-09-07 14:02:44 -0700519 // Thin lock thread id. This is a small integer used by the thin lock implementation.
520 // This is not to be confused with the native thread's tid, nor is it the value returned
521 // by java.lang.Thread.getId --- this is a distinct value, used only for locking. One
522 // important difference between this id and the ids visible to managed code is that these
523 // ones get reused (to ensure that they fit in the number of bits available).
524 uint32_t thin_lock_id_;
Ian Rogersb033c752011-07-20 12:22:35 -0700525
Elliott Hughesd92bec42011-09-02 17:04:36 -0700526 // System thread id.
527 pid_t tid_;
528
Elliott Hughesdcc24742011-09-07 14:02:44 -0700529 // Our managed peer (an instance of java.lang.Thread).
Elliott Hughesd369bb72011-09-12 14:41:14 -0700530 Object* peer_;
Elliott Hughes8daa0922011-09-11 13:46:25 -0700531
Elliott Hughes8e4aac52011-09-26 17:03:36 -0700532 // The top_of_managed_stack_ and top_of_managed_stack_pc_ fields are accessed from
533 // compiled code, so we keep them early in the structure to (a) avoid having to keep
534 // fixing the assembler offsets and (b) improve the chances that these will still be aligned.
535
536 // Top of the managed stack, written out prior to the state transition from
Elliott Hughes68e76522011-10-05 13:22:16 -0700537 // kRunnable to kNative. Uses include giving the starting point for scanning
Elliott Hughes8e4aac52011-09-26 17:03:36 -0700538 // a managed stack when a thread is in native code.
539 Frame top_of_managed_stack_;
540 // PC corresponding to the call out of the top_of_managed_stack_ frame
541 uintptr_t top_of_managed_stack_pc_;
542
Elliott Hughes8daa0922011-09-11 13:46:25 -0700543 // Guards the 'interrupted_' and 'wait_monitor_' members.
Elliott Hughes85d15452011-09-16 17:33:01 -0700544 mutable Mutex* wait_mutex_;
545 ConditionVariable* wait_cond_;
Elliott Hughes8daa0922011-09-11 13:46:25 -0700546 // Pointer to the monitor lock we're currently waiting on (or NULL), guarded by wait_mutex_.
547 Monitor* wait_monitor_;
548 // Thread "interrupted" status; stays raised until queried or thrown, guarded by wait_mutex_.
Elliott Hughes8e4aac52011-09-26 17:03:36 -0700549 uint32_t interrupted_;
Elliott Hughes5f791332011-09-15 17:45:30 -0700550 // The next thread in the wait set this thread is part of.
551 Thread* wait_next_;
Elliott Hughes8e4aac52011-09-26 17:03:36 -0700552 // If we're blocked in MonitorEnter, this is the object we're trying to lock.
553 Object* monitor_enter_object_;
Elliott Hughes5f791332011-09-15 17:45:30 -0700554
555 friend class Monitor;
Elliott Hughesdcc24742011-09-07 14:02:44 -0700556
Elliott Hughes9d5ccec2011-09-19 13:19:50 -0700557 RuntimeStats stats_;
558
Ian Rogers5d76c432011-10-31 21:42:49 -0700559 // The biased card table, see CardTable for details
560 byte* card_table_;
buzbeec143c552011-08-20 17:38:58 -0700561
Elliott Hughes449b4bd2011-09-09 12:01:38 -0700562 // The end of this thread's stack. This is the lowest safely-addressable address on the stack.
563 // We leave extra space so there's room for the code that throws StackOverflowError.
564 byte* stack_end_;
Elliott Hughesbe759c62011-09-08 19:38:21 -0700565
Ian Rogers932746a2011-09-22 18:57:50 -0700566 // Size of the stack
567 size_t stack_size_;
568
569 // The "lowest addressable byte" of the stack
Ian Rogers30fab402012-01-23 15:43:46 -0800570 byte* stack_begin_;
Ian Rogers932746a2011-09-22 18:57:50 -0700571
Ian Rogers6de08602011-08-19 14:52:39 -0700572 // A linked list (of stack allocated records) recording transitions from
573 // native to managed code.
574 NativeToManagedRecord* native_to_managed_record_;
575
Ian Rogers408f79a2011-08-23 18:22:33 -0700576 // Top of linked list of stack indirect reference tables or NULL for none
577 StackIndirectReferenceTable* top_sirt_;
Ian Rogersb033c752011-07-20 12:22:35 -0700578
Logan Chienf7ad17e2012-03-15 03:10:03 +0800579 // Top of linked list of shadow stack or NULL for none
580 // Some backend may require shadow frame to ease the GC work.
581 ShadowFrame* top_shadow_frame_;
582
Ian Rogersb033c752011-07-20 12:22:35 -0700583 // Every thread may have an associated JNI environment
Elliott Hughes69f5bc62011-08-24 09:26:14 -0700584 JNIEnvExt* jni_env_;
Ian Rogersb033c752011-07-20 12:22:35 -0700585
Elliott Hughes34e06962012-04-09 13:55:55 -0700586 volatile ThreadState state_;
Carl Shapirob5573532011-07-12 18:22:59 -0700587
Carl Shapiro69759ea2011-07-21 18:13:35 -0700588 // Initialized to "this". On certain architectures (such as x86) reading
589 // off of Thread::Current is easy but getting the address of Thread::Current
590 // is hard. This field can be read off of Thread::Current to give the address.
591 Thread* self_;
592
593 Runtime* runtime_;
594
595 // The pending exception or NULL.
Elliott Hughese5b0dc82011-08-23 09:59:02 -0700596 Throwable* exception_;
Carl Shapiro0e5d75d2011-07-06 18:28:37 -0700597
Ian Rogers45a76cb2011-07-21 22:00:15 -0700598 // A non-zero value is used to tell the current thread to enter a safe point
599 // at the next poll.
600 int suspend_count_;
Elliott Hughes234ab152011-10-26 14:02:26 -0700601 // How much of 'suspend_count_' is by request of the debugger, used to set things right
602 // when the debugger detaches. Must be <= suspend_count_.
603 int debug_suspend_count_;
Ian Rogers45a76cb2011-07-21 22:00:15 -0700604
Elliott Hughesedcc09c2011-08-21 18:47:05 -0700605 // Needed to get the right ClassLoader in JNI_OnLoad, but also
606 // useful for testing.
Brian Carlstrombffb1552011-08-25 12:23:53 -0700607 const ClassLoader* class_loader_override_;
buzbeec143c552011-08-20 17:38:58 -0700608
Ian Rogersbdb03912011-09-14 00:55:44 -0700609 // Thread local, lazily allocated, long jump context. Used to deliver exceptions.
Elliott Hughes85d15452011-09-16 17:33:01 -0700610 Context* long_jump_context_;
Ian Rogersbdb03912011-09-14 00:55:44 -0700611
Elliott Hughes418dfe72011-10-06 18:56:27 -0700612 // A boolean telling us whether we're recursively throwing OOME.
Elliott Hughes726079d2011-10-07 18:43:44 -0700613 uint32_t throwing_OutOfMemoryError_;
614
615 Throwable* pre_allocated_OutOfMemoryError_;
Elliott Hughes418dfe72011-10-06 18:56:27 -0700616
Elliott Hughes475fc232011-10-25 15:00:35 -0700617 // JDWP invoke-during-breakpoint support.
618 DebugInvokeReq* debug_invoke_req_;
619
Elliott Hughes81ff3182012-03-23 20:35:56 -0700620 // TLS key used to retrieve the Thread*.
Carl Shapirob5573532011-07-12 18:22:59 -0700621 static pthread_key_t pthread_key_self_;
622
jeffhaoe343b762011-12-05 16:36:44 -0800623 // Additional stack used by method tracer to store method and return pc values.
624 // Stored as a pointer since std::vector is not PACKED.
625 std::vector<TraceStackFrame>* trace_stack_;
626
Elliott Hughes899e7892012-01-24 14:57:32 -0800627 // A cached copy of the java.lang.Thread's name.
628 std::string* name_;
629
Elliott Hughesffb465f2012-03-01 18:46:05 -0800630 uint32_t held_mutexes_[kMaxMutexRank + 1];
631
Ian Rogersa32a6fd2012-02-06 20:18:44 -0800632 public:
633 // Runtime support function pointers
Ian Rogers57b86d42012-03-27 16:05:41 -0700634 EntryPoints entrypoints_;
Ian Rogersa32a6fd2012-02-06 20:18:44 -0800635
636 private:
Carl Shapiro0e5d75d2011-07-06 18:28:37 -0700637 DISALLOW_COPY_AND_ASSIGN(Thread);
638};
Ian Rogersbdb03912011-09-14 00:55:44 -0700639
Elliott Hughes330304d2011-08-12 14:28:05 -0700640std::ostream& operator<<(std::ostream& os, const Thread& thread);
Elliott Hughes34e06962012-04-09 13:55:55 -0700641std::ostream& operator<<(std::ostream& os, const ThreadState& state);
Carl Shapiro0e5d75d2011-07-06 18:28:37 -0700642
Elliott Hughesad7c2a32011-08-31 11:58:10 -0700643class ScopedThreadStateChange {
644 public:
Elliott Hughes34e06962012-04-09 13:55:55 -0700645 ScopedThreadStateChange(Thread* thread, ThreadState new_state) : thread_(thread) {
Elliott Hughesad7c2a32011-08-31 11:58:10 -0700646 old_thread_state_ = thread_->SetState(new_state);
647 }
648
649 ~ScopedThreadStateChange() {
650 thread_->SetState(old_thread_state_);
651 }
652
653 private:
654 Thread* thread_;
Elliott Hughes34e06962012-04-09 13:55:55 -0700655 ThreadState old_thread_state_;
Elliott Hughesad7c2a32011-08-31 11:58:10 -0700656 DISALLOW_COPY_AND_ASSIGN(ScopedThreadStateChange);
657};
658
Carl Shapiro0e5d75d2011-07-06 18:28:37 -0700659} // namespace art
660
661#endif // ART_SRC_THREAD_H_