blob: 32e000cccb8b1d66a95a1a026fd588326d1aa40a [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
Elliott Hughescf2b2d42012-03-27 17:11:42 -070075 // Thread states.
Carl Shapirob5573532011-07-12 18:22:59 -070076 enum State {
Elliott Hughescf2b2d42012-03-27 17:11:42 -070077 kTerminated = 0, // Thread.TERMINATED JDWP TS_ZOMBIE
78 kRunnable = 1, // Thread.RUNNABLE JDWP TS_RUNNING
79 kTimedWaiting = 2, // Thread.TIMED_WAITING JDWP TS_WAIT - in Object.wait() with a timeout
80 kBlocked = 3, // Thread.BLOCKED JDWP TS_MONITOR - blocked on a monitor
81 kWaiting = 4, // Thread.WAITING JDWP TS_WAIT - in Object.wait()
82 kStarting = 5, // Thread.NEW - native thread started, not yet ready to run managed code
83 kNative = 6, // - running in a JNI native method
84 kVmWait = 7, // - waiting on an internal runtime resource
85 kSuspended = 8, // - suspended by GC or debugger
Carl Shapirob5573532011-07-12 18:22:59 -070086 };
87
Ian Rogers932746a2011-09-22 18:57:50 -070088 // Space to throw a StackOverflowError in.
Brian Carlstromaded5f72011-10-07 17:15:04 -070089 static const size_t kStackOverflowReservedBytes = 4 * KB;
buzbeec143c552011-08-20 17:38:58 -070090
Brian Carlstrom72db0d72011-11-10 17:58:56 -080091 static const size_t kDefaultStackSize = 96 * KB;
Carl Shapiro61e019d2011-07-14 16:53:09 -070092
Shih-wei Liao9b576b42011-08-29 01:45:07 -070093 class StackVisitor {
94 public:
Ian Rogers0cfe1fb2011-08-26 03:29:44 -070095 virtual ~StackVisitor() {}
Elliott Hughes530fa002012-03-12 11:44:49 -070096 // Return 'true' if we should continue to visit more frames, 'false' to stop.
97 virtual bool VisitFrame(const Frame& frame, uintptr_t pc) = 0;
Shih-wei Liao9b576b42011-08-29 01:45:07 -070098 };
99
Elliott Hughes462c9442012-03-23 18:47:50 -0700100 // Creates a new native thread corresponding to the given managed peer.
101 // Used to implement Thread.start.
Elliott Hughesd369bb72011-09-12 14:41:14 -0700102 static void Create(Object* peer, size_t stack_size);
Carl Shapiro61e019d2011-07-14 16:53:09 -0700103
Elliott Hughes462c9442012-03-23 18:47:50 -0700104 // Attaches the calling native thread to the runtime, returning the new native peer.
105 // Used to implement JNI AttachCurrentThread and AttachCurrentThreadAsDaemon calls.
106 static Thread* Attach(const char* thread_name, bool as_daemon, Object* thread_group);
Carl Shapirob5573532011-07-12 18:22:59 -0700107
Brian Carlstromcaabb1b2011-10-11 18:09:13 -0700108 // Reset internal state of child thread after fork.
109 void InitAfterFork();
110
Carl Shapirob5573532011-07-12 18:22:59 -0700111 static Thread* Current() {
Carl Shapirod0e7e772011-07-15 14:31:01 -0700112 void* thread = pthread_getspecific(Thread::pthread_key_self_);
113 return reinterpret_cast<Thread*>(thread);
Carl Shapiro0e5d75d2011-07-06 18:28:37 -0700114 }
115
Elliott Hughes761928d2011-11-16 18:33:03 -0800116 static Thread* FromManagedThread(Object* thread_peer);
Elliott Hughes01158d72011-09-19 19:47:10 -0700117 static Thread* FromManagedThread(JNIEnv* env, jobject thread);
Elliott Hughes8e4aac52011-09-26 17:03:36 -0700118 static uint32_t LockOwnerFromThreadLock(Object* thread_lock);
Elliott Hughes8daa0922011-09-11 13:46:25 -0700119
Elliott Hughes899e7892012-01-24 14:57:32 -0800120 // When full == true, dumps the detailed thread state and the thread stack (used for SIGQUIT).
121 // When full == false, dumps a one-line summary of thread state (used for operator<<).
122 void Dump(std::ostream& os, bool full = true) const;
Elliott Hughesa0957642011-09-02 14:27:33 -0700123
Ian Rogers0cfe1fb2011-08-26 03:29:44 -0700124 State GetState() const {
125 return state_;
126 }
127
Elliott Hughes8d768a92011-09-14 16:35:25 -0700128 State SetState(State new_state);
Elliott Hughesa4060e52012-03-02 16:51:35 -0800129 void SetStateWithoutSuspendCheck(State new_state);
Elliott Hughes8d768a92011-09-14 16:35:25 -0700130
Elliott Hughes038a8062011-09-18 14:12:41 -0700131 bool IsDaemon();
Elliott Hughes761928d2011-11-16 18:33:03 -0800132 bool IsSuspended();
Elliott Hughes038a8062011-09-18 14:12:41 -0700133
Elliott Hughes8d768a92011-09-14 16:35:25 -0700134 void WaitUntilSuspended();
Ian Rogers0cfe1fb2011-08-26 03:29:44 -0700135
Elliott Hughes5f791332011-09-15 17:45:30 -0700136 bool HoldsLock(Object*);
137
Elliott Hughes8daa0922011-09-11 13:46:25 -0700138 /*
139 * Changes the priority of this thread to match that of the java.lang.Thread object.
140 *
141 * We map a priority value from 1-10 to Linux "nice" values, where lower
142 * numbers indicate higher priority.
143 */
144 void SetNativePriority(int newPriority);
145
146 /*
147 * Returns the thread priority for the current thread by querying the system.
148 * This is useful when attaching a thread through JNI.
149 *
150 * Returns a value from 1 to 10 (compatible with java.lang.Thread values).
151 */
152 static int GetNativePriority();
153
Elliott Hughes462c9442012-03-23 18:47:50 -0700154 // Returns the "main" ThreadGroup, used when attaching user threads.
155 static Object* GetMainThreadGroup();
156 // Returns the "system" ThreadGroup, used when attaching our internal threads.
157 static Object* GetSystemThreadGroup();
158
Ian Rogers0cfe1fb2011-08-26 03:29:44 -0700159 bool CanAccessDirectReferences() const {
Brian Carlstromcaabb1b2011-10-11 18:09:13 -0700160#ifdef MOVING_GARBAGE_COLLECTOR
Elliott Hughesa59d1792011-09-04 18:42:35 -0700161 // TODO: when we have a moving collector, we'll need: return state_ == kRunnable;
Brian Carlstromcaabb1b2011-10-11 18:09:13 -0700162#endif
Elliott Hughesa59d1792011-09-04 18:42:35 -0700163 return true;
Ian Rogers0cfe1fb2011-08-26 03:29:44 -0700164 }
165
Elliott Hughesdcc24742011-09-07 14:02:44 -0700166 uint32_t GetThinLockId() const {
167 return thin_lock_id_;
Carl Shapirob5573532011-07-12 18:22:59 -0700168 }
169
Elliott Hughesd92bec42011-09-02 17:04:36 -0700170 pid_t GetTid() const {
171 return tid_;
172 }
Elliott Hughese27955c2011-08-26 15:21:24 -0700173
Elliott Hughesffb465f2012-03-01 18:46:05 -0800174 // Returns the java.lang.Thread's name, or NULL if this Thread* doesn't have a peer.
Elliott Hughes899e7892012-01-24 14:57:32 -0800175 String* GetThreadName() const;
176
Elliott Hughesffb465f2012-03-01 18:46:05 -0800177 // Sets 'name' to the java.lang.Thread's name. This requires no transition to managed code,
178 // allocation, or locking.
179 void GetThreadName(std::string& name) const;
180
Elliott Hughes899e7892012-01-24 14:57:32 -0800181 // Sets the thread's name.
182 void SetThreadName(const char* name);
Elliott Hughesfc861622011-10-17 17:57:47 -0700183
Elliott Hughesd369bb72011-09-12 14:41:14 -0700184 Object* GetPeer() const {
Elliott Hughes8daa0922011-09-11 13:46:25 -0700185 return peer_;
186 }
187
Elliott Hughesa2155262011-11-16 16:26:58 -0800188 Object* GetThreadGroup() const;
189
Elliott Hughes9d5ccec2011-09-19 13:19:50 -0700190 RuntimeStats* GetStats() {
191 return &stats_;
192 }
193
Elliott Hughesd07986f2011-12-06 18:27:45 -0800194 int GetSuspendCount() const {
195 return suspend_count_;
196 }
Ian Rogers0cfe1fb2011-08-26 03:29:44 -0700197
Elliott Hughesd07986f2011-12-06 18:27:45 -0800198 // Returns the current Method* and native PC (not dex PC) for this thread.
199 Method* GetCurrentMethod(uintptr_t* pc = NULL, Method*** sp = NULL) const;
jeffhao33dc7712011-11-09 17:54:24 -0800200
Carl Shapiro0e5d75d2011-07-06 18:28:37 -0700201 bool IsExceptionPending() const {
Elliott Hughesb20a5542011-08-12 18:03:12 -0700202 return exception_ != NULL;
Carl Shapiro0e5d75d2011-07-06 18:28:37 -0700203 }
204
Elliott Hughese5b0dc82011-08-23 09:59:02 -0700205 Throwable* GetException() const {
Ian Rogers0cfe1fb2011-08-26 03:29:44 -0700206 DCHECK(CanAccessDirectReferences());
Carl Shapiro0e5d75d2011-07-06 18:28:37 -0700207 return exception_;
208 }
209
Ian Rogers0cfe1fb2011-08-26 03:29:44 -0700210 void SetException(Throwable* new_exception) {
211 DCHECK(CanAccessDirectReferences());
212 CHECK(new_exception != NULL);
213 // TODO: CHECK(exception_ == NULL);
214 exception_ = new_exception; // TODO
215 }
216
217 void ClearException() {
218 exception_ = NULL;
Elliott Hughesa0957642011-09-02 14:27:33 -0700219 }
220
Ian Rogersbdb03912011-09-14 00:55:44 -0700221 // Find catch block and perform long jump to appropriate exception handle
Ian Rogersff1ed472011-09-20 13:46:24 -0700222 void DeliverException();
Ian Rogersbdb03912011-09-14 00:55:44 -0700223
224 Context* GetLongJumpContext();
225
Shih-wei Liao1a18c8c2011-08-14 17:47:36 -0700226 Frame GetTopOfStack() const {
227 return top_of_managed_stack_;
228 }
229
230 // TODO: this is here for testing, remove when we have exception unit tests
231 // that use the real stack
Ian Rogersbdb03912011-09-14 00:55:44 -0700232 void SetTopOfStack(void* stack, uintptr_t pc) {
Ian Rogers0cfe1fb2011-08-26 03:29:44 -0700233 top_of_managed_stack_.SetSP(reinterpret_cast<Method**>(stack));
Ian Rogersbdb03912011-09-14 00:55:44 -0700234 top_of_managed_stack_pc_ = pc;
Carl Shapiro0e5d75d2011-07-06 18:28:37 -0700235 }
236
Ian Rogersbdb03912011-09-14 00:55:44 -0700237 void SetTopOfStackPC(uintptr_t pc) {
238 top_of_managed_stack_pc_ = pc;
239 }
240
Elliott Hughes5cb5ad22011-10-02 12:13:39 -0700241 // 'msg' may be NULL.
242 void ThrowNewException(const char* exception_class_descriptor, const char* msg);
243
244 void ThrowNewExceptionF(const char* exception_class_descriptor, const char* fmt, ...)
Elliott Hughes362f9bc2011-10-17 18:56:41 -0700245 __attribute__((format(printf, 3, 4)));
Elliott Hughesa5b897e2011-08-16 11:33:06 -0700246
Elliott Hughes4a2b4172011-09-20 17:08:25 -0700247 void ThrowNewExceptionV(const char* exception_class_descriptor, const char* fmt, va_list ap);
248
Elliott Hughes2ced6a52011-10-16 18:44:48 -0700249 // OutOfMemoryError is special, because we need to pre-allocate an instance.
250 void ThrowOutOfMemoryError(const char* msg);
Elliott Hughes418dfe72011-10-06 18:56:27 -0700251 void ThrowOutOfMemoryError(Class* c, size_t byte_count);
Elliott Hughes79082e32011-08-25 12:07:32 -0700252
Shih-wei Liao1a18c8c2011-08-14 17:47:36 -0700253 Frame FindExceptionHandler(void* throw_pc, void** handler_pc);
254
255 void* FindExceptionHandlerInMethod(const Method* method,
256 void* throw_pc,
257 const DexFile& dex_file,
258 ClassLinker* class_linker);
buzbeec143c552011-08-20 17:38:58 -0700259
Elliott Hughesbe759c62011-09-08 19:38:21 -0700260 static void Startup();
Elliott Hughes038a8062011-09-18 14:12:41 -0700261 static void FinishStartup();
Elliott Hughesc1674ed2011-08-25 18:09:09 -0700262 static void Shutdown();
Carl Shapirob5573532011-07-12 18:22:59 -0700263
Ian Rogersb033c752011-07-20 12:22:35 -0700264 // JNI methods
Elliott Hughes69f5bc62011-08-24 09:26:14 -0700265 JNIEnvExt* GetJniEnv() const {
Ian Rogersb033c752011-07-20 12:22:35 -0700266 return jni_env_;
267 }
268
TDYa12728f1a142012-03-15 21:51:52 -0700269 // Number of references in SIRTs on this thread
Ian Rogers408f79a2011-08-23 18:22:33 -0700270 size_t NumSirtReferences();
Ian Rogersa8cd9f42011-08-19 16:43:41 -0700271
TDYa12728f1a142012-03-15 21:51:52 -0700272 // Number of references allocated in ShadowFrames on this thread
273 size_t NumShadowFrameReferences();
274
275 // Number of references allocated in SIRTs & shadow frames on this thread
276 size_t NumStackReferences() {
277 return NumSirtReferences() + NumShadowFrameReferences();
278 };
279
Ian Rogers408f79a2011-08-23 18:22:33 -0700280 // Is the given obj in this thread's stack indirect reference table?
281 bool SirtContains(jobject obj);
282
TDYa12728f1a142012-03-15 21:51:52 -0700283 // Is the given obj in this thread's ShadowFrame?
284 bool ShadowFrameContains(jobject obj);
285
286 // Is the given obj in this thread's Sirts & ShadowFrames?
287 bool StackReferencesContain(jobject obj);
288
Shih-wei Liao8dfc9d52011-09-28 18:06:15 -0700289 void SirtVisitRoots(Heap::RootVisitor* visitor, void* arg);
290
Logan Chienf7ad17e2012-03-15 03:10:03 +0800291 void ShadowFrameVisitRoots(Heap::RootVisitor* visitor, void* arg);
292
Ian Rogers408f79a2011-08-23 18:22:33 -0700293 // Convert a jobject into a Object*
294 Object* DecodeJObject(jobject obj);
Ian Rogersb033c752011-07-20 12:22:35 -0700295
Elliott Hughes8daa0922011-09-11 13:46:25 -0700296 // Implements java.lang.Thread.interrupted.
297 bool Interrupted() {
Elliott Hughes85d15452011-09-16 17:33:01 -0700298 MutexLock mu(*wait_mutex_);
Elliott Hughes8daa0922011-09-11 13:46:25 -0700299 bool interrupted = interrupted_;
300 interrupted_ = false;
301 return interrupted;
302 }
303
304 // Implements java.lang.Thread.isInterrupted.
305 bool IsInterrupted() {
Elliott Hughes85d15452011-09-16 17:33:01 -0700306 MutexLock mu(*wait_mutex_);
Elliott Hughes8daa0922011-09-11 13:46:25 -0700307 return interrupted_;
308 }
309
Elliott Hughes5f791332011-09-15 17:45:30 -0700310 void Interrupt() {
Elliott Hughes85d15452011-09-16 17:33:01 -0700311 MutexLock mu(*wait_mutex_);
Elliott Hughes5f791332011-09-15 17:45:30 -0700312 if (interrupted_) {
313 return;
314 }
315 interrupted_ = true;
316 NotifyLocked();
317 }
318
319 void Notify() {
Elliott Hughes85d15452011-09-16 17:33:01 -0700320 MutexLock mu(*wait_mutex_);
Elliott Hughes5f791332011-09-15 17:45:30 -0700321 NotifyLocked();
322 }
323
Ian Rogers6de08602011-08-19 14:52:39 -0700324 // Linked list recording transitions from native to managed code
Ian Rogersb04f69f2011-10-17 00:40:54 -0700325 void PushNativeToManagedRecord(NativeToManagedRecord* record);
326 void PopNativeToManagedRecord(const NativeToManagedRecord& record);
Ian Rogers6de08602011-08-19 14:52:39 -0700327
Brian Carlstrombffb1552011-08-25 12:23:53 -0700328 const ClassLoader* GetClassLoaderOverride() {
Ian Rogers0cfe1fb2011-08-26 03:29:44 -0700329 // TODO: need to place the class_loader_override_ in a handle
330 // DCHECK(CanAccessDirectReferences());
buzbeec143c552011-08-20 17:38:58 -0700331 return class_loader_override_;
332 }
333
Brian Carlstrombffb1552011-08-25 12:23:53 -0700334 void SetClassLoaderOverride(const ClassLoader* class_loader_override) {
buzbeec143c552011-08-20 17:38:58 -0700335 class_loader_override_ = class_loader_override;
336 }
337
Ian Rogersaaa20802011-09-11 21:47:37 -0700338 // Create the internal representation of a stack trace, that is more time
339 // and space efficient to compute than the StackTraceElement[]
Elliott Hughes01158d72011-09-19 19:47:10 -0700340 jobject CreateInternalStackTrace(JNIEnv* env) const;
Ian Rogersaaa20802011-09-11 21:47:37 -0700341
Elliott Hughes01158d72011-09-19 19:47:10 -0700342 // Convert an internal stack trace representation (returned by CreateInternalStackTrace) to a
343 // StackTraceElement[]. If output_array is NULL, a new array is created, otherwise as many
344 // frames as will fit are written into the given array. If stack_depth is non-NULL, it's updated
345 // with the number of valid frames in the returned array.
346 static jobjectArray InternalStackTraceToStackTraceElementArray(JNIEnv* env, jobject internal,
347 jobjectArray output_array = NULL, int* stack_depth = NULL);
Shih-wei Liao55df06b2011-08-26 14:39:27 -0700348
Ian Rogersd6b1f612011-09-27 13:38:14 -0700349 void VisitRoots(Heap::RootVisitor* visitor, void* arg);
Elliott Hughes410c0c82011-09-01 17:58:25 -0700350
jeffhao25045522012-03-13 19:34:37 -0700351#if VERIFY_OBJECT_ENABLED
352 void VerifyStack();
353#else
354 void VerifyStack() {}
355#endif
356
Elliott Hughesbe759c62011-09-08 19:38:21 -0700357 //
358 // Offsets of various members of native Thread class, used by compiled code.
359 //
360
361 static ThreadOffset SelfOffset() {
362 return ThreadOffset(OFFSETOF_MEMBER(Thread, self_));
363 }
364
365 static ThreadOffset ExceptionOffset() {
366 return ThreadOffset(OFFSETOF_MEMBER(Thread, exception_));
367 }
368
Elliott Hughes54e7df12011-09-16 11:47:04 -0700369 static ThreadOffset ThinLockIdOffset() {
Elliott Hughesbe759c62011-09-08 19:38:21 -0700370 return ThreadOffset(OFFSETOF_MEMBER(Thread, thin_lock_id_));
371 }
372
373 static ThreadOffset CardTableOffset() {
374 return ThreadOffset(OFFSETOF_MEMBER(Thread, card_table_));
375 }
376
377 static ThreadOffset SuspendCountOffset() {
378 return ThreadOffset(OFFSETOF_MEMBER(Thread, suspend_count_));
379 }
380
381 static ThreadOffset StateOffset() {
Elliott Hughes93e74e82011-09-13 11:07:03 -0700382 return ThreadOffset(OFFSETOF_VOLATILE_MEMBER(Thread, state_));
Elliott Hughesbe759c62011-09-08 19:38:21 -0700383 }
384
Ian Rogers932746a2011-09-22 18:57:50 -0700385 // Size of stack less any space reserved for stack overflow
386 size_t GetStackSize() {
Ian Rogers30fab402012-01-23 15:43:46 -0800387 return stack_size_ - (stack_end_ - stack_begin_);
Ian Rogers932746a2011-09-22 18:57:50 -0700388 }
389
390 // Set the stack end to that to be used during a stack overflow
391 void SetStackEndForStackOverflow() {
392 // During stack overflow we allow use of the full stack
Ian Rogers30fab402012-01-23 15:43:46 -0800393 if (stack_end_ == stack_begin_) {
Elliott Hughes3b6baaa2011-10-14 19:13:56 -0700394 DumpStack(std::cerr);
395 LOG(FATAL) << "Need to increase kStackOverflowReservedBytes (currently "
396 << kStackOverflowReservedBytes << ")";
397 }
398
Ian Rogers30fab402012-01-23 15:43:46 -0800399 stack_end_ = stack_begin_;
Ian Rogers932746a2011-09-22 18:57:50 -0700400 }
401
402 // Set the stack end to that to be used during regular execution
403 void ResetDefaultStackEnd() {
404 // Our stacks grow down, so we want stack_end_ to be near there, but reserving enough room
405 // to throw a StackOverflowError.
Ian Rogers30fab402012-01-23 15:43:46 -0800406 stack_end_ = stack_begin_ + kStackOverflowReservedBytes;
Ian Rogers932746a2011-09-22 18:57:50 -0700407 }
408
Elliott Hughes449b4bd2011-09-09 12:01:38 -0700409 static ThreadOffset StackEndOffset() {
410 return ThreadOffset(OFFSETOF_MEMBER(Thread, stack_end_));
Elliott Hughesbe759c62011-09-08 19:38:21 -0700411 }
412
413 static ThreadOffset JniEnvOffset() {
414 return ThreadOffset(OFFSETOF_MEMBER(Thread, jni_env_));
415 }
416
417 static ThreadOffset TopOfManagedStackOffset() {
418 return ThreadOffset(OFFSETOF_MEMBER(Thread, top_of_managed_stack_) +
419 OFFSETOF_MEMBER(Frame, sp_));
420 }
421
Ian Rogersbdb03912011-09-14 00:55:44 -0700422 static ThreadOffset TopOfManagedStackPcOffset() {
423 return ThreadOffset(OFFSETOF_MEMBER(Thread, top_of_managed_stack_pc_));
424 }
425
Logan Chienf7ad17e2012-03-15 03:10:03 +0800426 void PushShadowFrame(ShadowFrame* frame);
427 ShadowFrame* PopShadowFrame();
428
Brian Carlstrom40381fb2011-10-19 14:13:40 -0700429 void PushSirt(StackIndirectReferenceTable* sirt);
430 StackIndirectReferenceTable* PopSirt();
431
Elliott Hughesbe759c62011-09-08 19:38:21 -0700432 static ThreadOffset TopSirtOffset() {
433 return ThreadOffset(OFFSETOF_MEMBER(Thread, top_sirt_));
434 }
435
Elliott Hughes530fa002012-03-12 11:44:49 -0700436 void WalkStack(StackVisitor* visitor, bool include_upcalls = false) const;
Shih-wei Liao9407c602011-09-16 10:36:43 -0700437
Elliott Hughes475fc232011-10-25 15:00:35 -0700438 DebugInvokeReq* GetInvokeReq() {
439 return debug_invoke_req_;
440 }
441
Elliott Hughesc0f09332012-03-26 13:27:06 -0700442 void SetDebuggerUpdatesEnabled(bool enabled);
443
jeffhaoe343b762011-12-05 16:36:44 -0800444 bool IsTraceStackEmpty() const {
445 return trace_stack_->empty();
446 }
447
jeffhaoa9ef3fd2011-12-13 18:33:43 -0800448 TraceStackFrame GetTraceStackFrame(uint32_t depth) const {
449 return trace_stack_->at(trace_stack_->size() - depth - 1);
450 }
451
jeffhaoe343b762011-12-05 16:36:44 -0800452 void PushTraceStackFrame(const TraceStackFrame& frame) {
453 trace_stack_->push_back(frame);
454 }
455
456 TraceStackFrame PopTraceStackFrame() {
457 TraceStackFrame frame = trace_stack_->back();
458 trace_stack_->pop_back();
459 return frame;
460 }
461
Elliott Hughesa4060e52012-03-02 16:51:35 -0800462 void CheckSafeToLockOrUnlock(MutexRank rank, bool is_locking);
463 void CheckSafeToWait(MutexRank rank);
Elliott Hughesffb465f2012-03-01 18:46:05 -0800464
Carl Shapiro0e5d75d2011-07-06 18:28:37 -0700465 private:
Elliott Hughesdcc24742011-09-07 14:02:44 -0700466 Thread();
Elliott Hughesc1674ed2011-08-25 18:09:09 -0700467 ~Thread();
Elliott Hughesc0f09332012-03-26 13:27:06 -0700468 void Destroy();
469 friend class ThreadList; // For ~Thread and Destroy.
Carl Shapiro0e5d75d2011-07-06 18:28:37 -0700470
Elliott Hughes462c9442012-03-23 18:47:50 -0700471 void CreatePeer(const char* name, bool as_daemon, Object* thread_group);
Elliott Hughes5fe594f2011-09-08 12:33:17 -0700472 friend class Runtime; // For CreatePeer.
473
Elliott Hughesd92bec42011-09-02 17:04:36 -0700474 void DumpState(std::ostream& os) const;
475 void DumpStack(std::ostream& os) const;
Elliott Hughesffb465f2012-03-01 18:46:05 -0800476 void DumpNativeStack(std::ostream& os) const;
Elliott Hughesd92bec42011-09-02 17:04:36 -0700477
Elliott Hughesaccd83d2011-10-17 14:25:58 -0700478 // Out-of-line conveniences for debugging in gdb.
Elliott Hughes498508c2011-10-17 14:58:22 -0700479 static Thread* CurrentFromGdb(); // Like Thread::Current.
Elliott Hughesaccd83d2011-10-17 14:25:58 -0700480 void DumpFromGdb() const; // Like Thread::Dump(std::cerr).
481
Elliott Hughes93e74e82011-09-13 11:07:03 -0700482 static void* CreateCallback(void* arg);
483
Elliott Hughesaccd83d2011-10-17 14:25:58 -0700484 void HandleUncaughtExceptions();
Brian Carlstrom4514d3c2011-10-21 17:01:31 -0700485 void RemoveFromThreadGroup();
Elliott Hughesaccd83d2011-10-17 14:25:58 -0700486
Elliott Hughes462c9442012-03-23 18:47:50 -0700487 void Init();
Ian Rogers5d76c432011-10-31 21:42:49 -0700488 void InitCardTable();
Ian Rogersb033c752011-07-20 12:22:35 -0700489 void InitCpu();
buzbee3ea4ec52011-08-22 17:37:19 -0700490 void InitFunctionPointers();
Brian Carlstromcaabb1b2011-10-11 18:09:13 -0700491 void InitTid();
Brian Carlstromcaabb1b2011-10-11 18:09:13 -0700492 void InitPthreadKeySelf();
Elliott Hughesbe759c62011-09-08 19:38:21 -0700493 void InitStackHwm();
494
Elliott Hughes5f791332011-09-15 17:45:30 -0700495 void NotifyLocked() {
496 if (wait_monitor_ != NULL) {
Elliott Hughes85d15452011-09-16 17:33:01 -0700497 wait_cond_->Signal();
Elliott Hughes5f791332011-09-15 17:45:30 -0700498 }
499 }
500
Elliott Hughesbe759c62011-09-08 19:38:21 -0700501 static void ThreadExitCallback(void* arg);
Ian Rogersb033c752011-07-20 12:22:35 -0700502
Elliott Hughesdcc24742011-09-07 14:02:44 -0700503 // Thin lock thread id. This is a small integer used by the thin lock implementation.
504 // This is not to be confused with the native thread's tid, nor is it the value returned
505 // by java.lang.Thread.getId --- this is a distinct value, used only for locking. One
506 // important difference between this id and the ids visible to managed code is that these
507 // ones get reused (to ensure that they fit in the number of bits available).
508 uint32_t thin_lock_id_;
Ian Rogersb033c752011-07-20 12:22:35 -0700509
Elliott Hughesd92bec42011-09-02 17:04:36 -0700510 // System thread id.
511 pid_t tid_;
512
Elliott Hughesdcc24742011-09-07 14:02:44 -0700513 // Our managed peer (an instance of java.lang.Thread).
Elliott Hughesd369bb72011-09-12 14:41:14 -0700514 Object* peer_;
Elliott Hughes8daa0922011-09-11 13:46:25 -0700515
Elliott Hughes8e4aac52011-09-26 17:03:36 -0700516 // The top_of_managed_stack_ and top_of_managed_stack_pc_ fields are accessed from
517 // compiled code, so we keep them early in the structure to (a) avoid having to keep
518 // fixing the assembler offsets and (b) improve the chances that these will still be aligned.
519
520 // Top of the managed stack, written out prior to the state transition from
Elliott Hughes68e76522011-10-05 13:22:16 -0700521 // kRunnable to kNative. Uses include giving the starting point for scanning
Elliott Hughes8e4aac52011-09-26 17:03:36 -0700522 // a managed stack when a thread is in native code.
523 Frame top_of_managed_stack_;
524 // PC corresponding to the call out of the top_of_managed_stack_ frame
525 uintptr_t top_of_managed_stack_pc_;
526
Elliott Hughes8daa0922011-09-11 13:46:25 -0700527 // Guards the 'interrupted_' and 'wait_monitor_' members.
Elliott Hughes85d15452011-09-16 17:33:01 -0700528 mutable Mutex* wait_mutex_;
529 ConditionVariable* wait_cond_;
Elliott Hughes8daa0922011-09-11 13:46:25 -0700530 // Pointer to the monitor lock we're currently waiting on (or NULL), guarded by wait_mutex_.
531 Monitor* wait_monitor_;
532 // Thread "interrupted" status; stays raised until queried or thrown, guarded by wait_mutex_.
Elliott Hughes8e4aac52011-09-26 17:03:36 -0700533 uint32_t interrupted_;
Elliott Hughes5f791332011-09-15 17:45:30 -0700534 // The next thread in the wait set this thread is part of.
535 Thread* wait_next_;
Elliott Hughes8e4aac52011-09-26 17:03:36 -0700536 // If we're blocked in MonitorEnter, this is the object we're trying to lock.
537 Object* monitor_enter_object_;
Elliott Hughes5f791332011-09-15 17:45:30 -0700538
539 friend class Monitor;
Elliott Hughesdcc24742011-09-07 14:02:44 -0700540
Elliott Hughes9d5ccec2011-09-19 13:19:50 -0700541 RuntimeStats stats_;
542
Ian Rogers5d76c432011-10-31 21:42:49 -0700543 // The biased card table, see CardTable for details
544 byte* card_table_;
buzbeec143c552011-08-20 17:38:58 -0700545
Elliott Hughes449b4bd2011-09-09 12:01:38 -0700546 // The end of this thread's stack. This is the lowest safely-addressable address on the stack.
547 // We leave extra space so there's room for the code that throws StackOverflowError.
548 byte* stack_end_;
Elliott Hughesbe759c62011-09-08 19:38:21 -0700549
Ian Rogers932746a2011-09-22 18:57:50 -0700550 // Size of the stack
551 size_t stack_size_;
552
553 // The "lowest addressable byte" of the stack
Ian Rogers30fab402012-01-23 15:43:46 -0800554 byte* stack_begin_;
Ian Rogers932746a2011-09-22 18:57:50 -0700555
Ian Rogers6de08602011-08-19 14:52:39 -0700556 // A linked list (of stack allocated records) recording transitions from
557 // native to managed code.
558 NativeToManagedRecord* native_to_managed_record_;
559
Ian Rogers408f79a2011-08-23 18:22:33 -0700560 // Top of linked list of stack indirect reference tables or NULL for none
561 StackIndirectReferenceTable* top_sirt_;
Ian Rogersb033c752011-07-20 12:22:35 -0700562
Logan Chienf7ad17e2012-03-15 03:10:03 +0800563 // Top of linked list of shadow stack or NULL for none
564 // Some backend may require shadow frame to ease the GC work.
565 ShadowFrame* top_shadow_frame_;
566
Ian Rogersb033c752011-07-20 12:22:35 -0700567 // Every thread may have an associated JNI environment
Elliott Hughes69f5bc62011-08-24 09:26:14 -0700568 JNIEnvExt* jni_env_;
Ian Rogersb033c752011-07-20 12:22:35 -0700569
Elliott Hughes93e74e82011-09-13 11:07:03 -0700570 volatile State state_;
Carl Shapirob5573532011-07-12 18:22:59 -0700571
Carl Shapiro69759ea2011-07-21 18:13:35 -0700572 // Initialized to "this". On certain architectures (such as x86) reading
573 // off of Thread::Current is easy but getting the address of Thread::Current
574 // is hard. This field can be read off of Thread::Current to give the address.
575 Thread* self_;
576
577 Runtime* runtime_;
578
579 // The pending exception or NULL.
Elliott Hughese5b0dc82011-08-23 09:59:02 -0700580 Throwable* exception_;
Carl Shapiro0e5d75d2011-07-06 18:28:37 -0700581
Ian Rogers45a76cb2011-07-21 22:00:15 -0700582 // A non-zero value is used to tell the current thread to enter a safe point
583 // at the next poll.
584 int suspend_count_;
Elliott Hughes234ab152011-10-26 14:02:26 -0700585 // How much of 'suspend_count_' is by request of the debugger, used to set things right
586 // when the debugger detaches. Must be <= suspend_count_.
587 int debug_suspend_count_;
Ian Rogers45a76cb2011-07-21 22:00:15 -0700588
Elliott Hughesedcc09c2011-08-21 18:47:05 -0700589 // Needed to get the right ClassLoader in JNI_OnLoad, but also
590 // useful for testing.
Brian Carlstrombffb1552011-08-25 12:23:53 -0700591 const ClassLoader* class_loader_override_;
buzbeec143c552011-08-20 17:38:58 -0700592
Ian Rogersbdb03912011-09-14 00:55:44 -0700593 // Thread local, lazily allocated, long jump context. Used to deliver exceptions.
Elliott Hughes85d15452011-09-16 17:33:01 -0700594 Context* long_jump_context_;
Ian Rogersbdb03912011-09-14 00:55:44 -0700595
Elliott Hughes418dfe72011-10-06 18:56:27 -0700596 // A boolean telling us whether we're recursively throwing OOME.
Elliott Hughes726079d2011-10-07 18:43:44 -0700597 uint32_t throwing_OutOfMemoryError_;
598
599 Throwable* pre_allocated_OutOfMemoryError_;
Elliott Hughes418dfe72011-10-06 18:56:27 -0700600
Elliott Hughes475fc232011-10-25 15:00:35 -0700601 // JDWP invoke-during-breakpoint support.
602 DebugInvokeReq* debug_invoke_req_;
603
Elliott Hughes81ff3182012-03-23 20:35:56 -0700604 // TLS key used to retrieve the Thread*.
Carl Shapirob5573532011-07-12 18:22:59 -0700605 static pthread_key_t pthread_key_self_;
606
jeffhaoe343b762011-12-05 16:36:44 -0800607 // Additional stack used by method tracer to store method and return pc values.
608 // Stored as a pointer since std::vector is not PACKED.
609 std::vector<TraceStackFrame>* trace_stack_;
610
Elliott Hughes899e7892012-01-24 14:57:32 -0800611 // A cached copy of the java.lang.Thread's name.
612 std::string* name_;
613
Elliott Hughesffb465f2012-03-01 18:46:05 -0800614 uint32_t held_mutexes_[kMaxMutexRank + 1];
615
Ian Rogersa32a6fd2012-02-06 20:18:44 -0800616 public:
617 // Runtime support function pointers
618 void (*pDebugMe)(Method*, uint32_t);
619 void* (*pMemcpy)(void*, const void*, size_t);
620 uint64_t (*pShlLong)(uint64_t, uint32_t);
621 uint64_t (*pShrLong)(uint64_t, uint32_t);
622 uint64_t (*pUshrLong)(uint64_t, uint32_t);
623 float (*pI2f)(int);
624 int (*pF2iz)(float);
625 float (*pD2f)(double);
626 double (*pF2d)(float);
627 double (*pI2d)(int);
628 int (*pD2iz)(double);
Ian Rogersc6f3bb82012-03-21 20:40:33 -0700629 float (*pL2f)(int64_t);
630 double (*pL2d)(int64_t);
631 int64_t (*pF2l)(float);
632 int64_t (*pD2l)(double);
Ian Rogersa32a6fd2012-02-06 20:18:44 -0800633 float (*pFadd)(float, float);
634 float (*pFsub)(float, float);
635 float (*pFdiv)(float, float);
636 float (*pFmul)(float, float);
637 float (*pFmodf)(float, float);
638 double (*pDadd)(double, double);
639 double (*pDsub)(double, double);
640 double (*pDdiv)(double, double);
641 double (*pDmul)(double, double);
642 double (*pFmod)(double, double);
643 int (*pIdivmod)(int, int);
644 int (*pIdiv)(int, int);
Ian Rogersc6f3bb82012-03-21 20:40:33 -0700645 int64_t (*pLadd)(int64_t, int64_t);
646 int64_t (*pLsub)(int64_t, int64_t);
647 int64_t (*pLand)(int64_t, int64_t);
648 int64_t (*pLor)(int64_t, int64_t);
649 int64_t (*pLxor)(int64_t, int64_t);
650 int64_t (*pLmul)(int64_t, int64_t);
651 int64_t (*pLdivmod)(int64_t, int64_t);
Ian Rogersa32a6fd2012-02-06 20:18:44 -0800652 void (*pCheckSuspendFromCode)(Thread*); // Stub that is called when the suspend count is non-zero
653 void (*pTestSuspendFromCode)(); // Stub that is periodically called to test the suspend count
654 void* (*pAllocObjectFromCode)(uint32_t, void*);
655 void* (*pAllocObjectFromCodeWithAccessCheck)(uint32_t, void*);
656 void* (*pAllocArrayFromCode)(uint32_t, void*, int32_t);
657 void* (*pAllocArrayFromCodeWithAccessCheck)(uint32_t, void*, int32_t);
658 void (*pCanPutArrayElementFromCode)(void*, void*);
659 void* (*pCheckAndAllocArrayFromCode)(uint32_t, void*, int32_t);
660 void* (*pCheckAndAllocArrayFromCodeWithAccessCheck)(uint32_t, void*, int32_t);
661 void (*pCheckCastFromCode)(void*, void*);
662 Object* (*pDecodeJObjectInThread)(Thread* thread, jobject obj);
663 void (*pDeliverException)(void*);
664 Method* (*pFindInterfaceMethodInCache)(Class*, uint32_t, const Method*, struct DvmDex*);
665 void* (*pFindNativeMethod)(Thread* thread);
666 int32_t (*pGet32Instance)(uint32_t, void*);
667 int64_t (*pGet64Instance)(uint32_t, void*);
668 void* (*pGetObjInstance)(uint32_t, void*);
669 int32_t (*pGet32Static)(uint32_t);
670 int64_t (*pGet64Static)(uint32_t);
671 void* (*pGetObjStatic)(uint32_t);
672 void (*pHandleFillArrayDataFromCode)(void*, void*);
673 void* (*pInitializeStaticStorage)(uint32_t, void*);
674 uint32_t (*pInstanceofNonTrivialFromCode)(const Class*, const Class*);
Ian Rogersc8b306f2012-02-17 21:34:44 -0800675 void (*pInvokeDirectTrampolineWithAccessCheck)(uint32_t, void*);
Ian Rogersa32a6fd2012-02-06 20:18:44 -0800676 void (*pInvokeInterfaceTrampoline)(uint32_t, void*);
677 void (*pInvokeInterfaceTrampolineWithAccessCheck)(uint32_t, void*);
Ian Rogersc8b306f2012-02-17 21:34:44 -0800678 void (*pInvokeStaticTrampolineWithAccessCheck)(uint32_t, void*);
Ian Rogersa32a6fd2012-02-06 20:18:44 -0800679 void (*pInvokeSuperTrampolineWithAccessCheck)(uint32_t, void*);
680 void (*pInvokeVirtualTrampolineWithAccessCheck)(uint32_t, void*);
681 void* (*pInitializeTypeFromCode)(uint32_t, void*);
682 void* (*pInitializeTypeAndVerifyAccessFromCode)(uint32_t, void*);
683 void (*pLockObjectFromCode)(void*);
Ian Rogersa32a6fd2012-02-06 20:18:44 -0800684 void* (*pResolveStringFromCode)(void*, uint32_t);
685 int (*pSet32Instance)(uint32_t, void*, int32_t); // field_idx, obj, src
686 int (*pSet64Instance)(uint32_t, void*, int64_t);
687 int (*pSetObjInstance)(uint32_t, void*, void*);
688 int (*pSet32Static)(uint32_t, int32_t);
689 int (*pSet64Static)(uint32_t, int64_t);
690 int (*pSetObjStatic)(uint32_t, void*);
691 void (*pThrowStackOverflowFromCode)(void*);
692 void (*pThrowNullPointerFromCode)();
693 void (*pThrowArrayBoundsFromCode)(int32_t, int32_t);
694 void (*pThrowDivZeroFromCode)();
695 void (*pThrowVerificationErrorFromCode)(int32_t, int32_t);
696 void (*pThrowNegArraySizeFromCode)(int32_t);
697 void (*pThrowNoSuchMethodFromCode)(int32_t);
698 void (*pThrowAbstractMethodErrorFromCode)(Method* method, Thread* thread, Method** sp);
699 void (*pUnlockObjectFromCode)(void*);
Ian Rogers19846512012-02-24 11:42:47 -0800700 const void* (*pUnresolvedDirectMethodTrampolineFromCode)(Method*, Method**, Thread*,
701 Runtime::TrampolineType);
Ian Rogersa32a6fd2012-02-06 20:18:44 -0800702 void (*pUpdateDebuggerFromCode)(void*, void*, int32_t, void*);
Bill Buzbee11f9d212012-03-03 20:03:18 -0800703 bool (*pCmplFloat)(float, float);
704 bool (*pCmpgFloat)(float, float);
705 bool (*pCmplDouble)(double, double);
706 bool (*pCmpgDouble)(double, double);
buzbeefc9e6fa2012-03-23 15:14:29 -0700707 int (*pIndexOf)(void*, uint32_t, uint32_t, uint32_t);
708 int (*pStringCompareTo)(void*, void*);
709 int (*pMemcmp16)(void*, void*, int32_t);
Ian Rogersa32a6fd2012-02-06 20:18:44 -0800710
711 private:
Carl Shapiro0e5d75d2011-07-06 18:28:37 -0700712 DISALLOW_COPY_AND_ASSIGN(Thread);
713};
Ian Rogersbdb03912011-09-14 00:55:44 -0700714
Elliott Hughes330304d2011-08-12 14:28:05 -0700715std::ostream& operator<<(std::ostream& os, const Thread& thread);
Ian Rogersb033c752011-07-20 12:22:35 -0700716std::ostream& operator<<(std::ostream& os, const Thread::State& state);
Carl Shapiro0e5d75d2011-07-06 18:28:37 -0700717
Elliott Hughesad7c2a32011-08-31 11:58:10 -0700718class ScopedThreadStateChange {
719 public:
720 ScopedThreadStateChange(Thread* thread, Thread::State new_state) : thread_(thread) {
721 old_thread_state_ = thread_->SetState(new_state);
722 }
723
724 ~ScopedThreadStateChange() {
725 thread_->SetState(old_thread_state_);
726 }
727
728 private:
729 Thread* thread_;
730 Thread::State old_thread_state_;
731 DISALLOW_COPY_AND_ASSIGN(ScopedThreadStateChange);
732};
733
Carl Shapiro0e5d75d2011-07-06 18:28:37 -0700734} // namespace art
735
736#endif // ART_SRC_THREAD_H_