blob: fc200c1ac225d36ec2ca5f82cb7812577507d262 [file] [log] [blame]
The Android Open Source Projectf6c38712009-03-03 19:28:47 -08001/*
2 * Copyright (C) 2008 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 */
The Android Open Source Project99409882009-03-18 22:20:24 -070016
The Android Open Source Projectf6c38712009-03-03 19:28:47 -080017/*
18 * Thread support.
19 */
20#include "Dalvik.h"
Bob Lee2fe146a2009-09-10 00:36:29 +020021#include "native/SystemThread.h"
The Android Open Source Projectf6c38712009-03-03 19:28:47 -080022
23#include "utils/threads.h" // need Android thread priorities
24
25#include <stdlib.h>
26#include <unistd.h>
27#include <sys/time.h>
28#include <sys/resource.h>
29#include <sys/mman.h>
30#include <errno.h>
Andy McFaddend62c0b52009-08-04 15:02:12 -070031#include <fcntl.h>
The Android Open Source Projectf6c38712009-03-03 19:28:47 -080032
San Mehat5a2056c2009-09-12 10:10:13 -070033#include <cutils/sched_policy.h>
34
The Android Open Source Projectf6c38712009-03-03 19:28:47 -080035#if defined(HAVE_PRCTL)
36#include <sys/prctl.h>
37#endif
38
Ben Chengfe1be872009-08-21 16:18:46 -070039#if defined(WITH_SELF_VERIFICATION)
40#include "interp/Jit.h" // need for self verification
41#endif
42
43
The Android Open Source Projectf6c38712009-03-03 19:28:47 -080044/* desktop Linux needs a little help with gettid() */
45#if defined(HAVE_GETTID) && !defined(HAVE_ANDROID_OS)
46#define __KERNEL__
47# include <linux/unistd.h>
48#ifdef _syscall0
49_syscall0(pid_t,gettid)
50#else
51pid_t gettid() { return syscall(__NR_gettid);}
52#endif
53#undef __KERNEL__
54#endif
55
San Mehat256fc152009-04-21 14:03:06 -070056// Change this to enable logging on cgroup errors
57#define ENABLE_CGROUP_ERR_LOGGING 0
58
The Android Open Source Projectf6c38712009-03-03 19:28:47 -080059// change this to LOGV/LOGD to debug thread activity
60#define LOG_THREAD LOGVV
61
62/*
63Notes on Threading
64
65All threads are native pthreads. All threads, except the JDWP debugger
66thread, are visible to code running in the VM and to the debugger. (We
67don't want the debugger to try to manipulate the thread that listens for
68instructions from the debugger.) Internal VM threads are in the "system"
69ThreadGroup, all others are in the "main" ThreadGroup, per convention.
70
71The GC only runs when all threads have been suspended. Threads are
72expected to suspend themselves, using a "safe point" mechanism. We check
73for a suspend request at certain points in the main interpreter loop,
74and on requests coming in from native code (e.g. all JNI functions).
75Certain debugger events may inspire threads to self-suspend.
76
77Native methods must use JNI calls to modify object references to avoid
78clashes with the GC. JNI doesn't provide a way for native code to access
79arrays of objects as such -- code must always get/set individual entries --
80so it should be possible to fully control access through JNI.
81
82Internal native VM threads, such as the finalizer thread, must explicitly
83check for suspension periodically. In most cases they will be sound
84asleep on a condition variable, and won't notice the suspension anyway.
85
86Threads may be suspended by the GC, debugger, or the SIGQUIT listener
87thread. The debugger may suspend or resume individual threads, while the
88GC always suspends all threads. Each thread has a "suspend count" that
89is incremented on suspend requests and decremented on resume requests.
90When the count is zero, the thread is runnable. This allows us to fulfill
91a debugger requirement: if the debugger suspends a thread, the thread is
92not allowed to run again until the debugger resumes it (or disconnects,
93in which case we must resume all debugger-suspended threads).
94
95Paused threads sleep on a condition variable, and are awoken en masse.
96Certain "slow" VM operations, such as starting up a new thread, will be
97done in a separate "VMWAIT" state, so that the rest of the VM doesn't
98freeze up waiting for the operation to finish. Threads must check for
99pending suspension when leaving VMWAIT.
100
101Because threads suspend themselves while interpreting code or when native
102code makes JNI calls, there is no risk of suspending while holding internal
103VM locks. All threads can enter a suspended (or native-code-only) state.
104Also, we don't have to worry about object references existing solely
105in hardware registers.
106
107We do, however, have to worry about objects that were allocated internally
108and aren't yet visible to anything else in the VM. If we allocate an
109object, and then go to sleep on a mutex after changing to a non-RUNNING
110state (e.g. while trying to allocate a second object), the first object
111could be garbage-collected out from under us while we sleep. To manage
112this, we automatically add all allocated objects to an internal object
113tracking list, and only remove them when we know we won't be suspended
114before the object appears in the GC root set.
115
116The debugger may choose to suspend or resume a single thread, which can
117lead to application-level deadlocks; this is expected behavior. The VM
118will only check for suspension of single threads when the debugger is
119active (the java.lang.Thread calls for this are deprecated and hence are
120not supported). Resumption of a single thread is handled by decrementing
121the thread's suspend count and sending a broadcast signal to the condition
122variable. (This will cause all threads to wake up and immediately go back
123to sleep, which isn't tremendously efficient, but neither is having the
124debugger attached.)
125
126The debugger is not allowed to resume threads suspended by the GC. This
127is trivially enforced by ignoring debugger requests while the GC is running
128(the JDWP thread is suspended during GC).
129
130The VM maintains a Thread struct for every pthread known to the VM. There
131is a java/lang/Thread object associated with every Thread. At present,
132there is no safe way to go from a Thread object to a Thread struct except by
133locking and scanning the list; this is necessary because the lifetimes of
134the two are not closely coupled. We may want to change this behavior,
135though at present the only performance impact is on the debugger (see
136threadObjToThread()). See also notes about dvmDetachCurrentThread().
137*/
138/*
139Alternate implementation (signal-based):
140
141Threads run without safe points -- zero overhead. The VM uses a signal
142(e.g. pthread_kill(SIGUSR1)) to notify threads of suspension or resumption.
143
144The trouble with using signals to suspend threads is that it means a thread
145can be in the middle of an operation when garbage collection starts.
146To prevent some sticky situations, we have to introduce critical sections
147to the VM code.
148
149Critical sections temporarily block suspension for a given thread.
150The thread must move to a non-blocked state (and self-suspend) after
151finishing its current task. If the thread blocks on a resource held
152by a suspended thread, we're hosed.
153
154One approach is to require that no blocking operations, notably
155acquisition of mutexes, can be performed within a critical section.
156This is too limiting. For example, if thread A gets suspended while
157holding the thread list lock, it will prevent the GC or debugger from
158being able to safely access the thread list. We need to wrap the critical
159section around the entire operation (enter critical, get lock, do stuff,
160release lock, exit critical).
161
162A better approach is to declare that certain resources can only be held
163within critical sections. A thread that enters a critical section and
164then gets blocked on the thread list lock knows that the thread it is
165waiting for is also in a critical section, and will release the lock
166before suspending itself. Eventually all threads will complete their
167operations and self-suspend. For this to work, the VM must:
168
169 (1) Determine the set of resources that may be accessed from the GC or
170 debugger threads. The mutexes guarding those go into the "critical
171 resource set" (CRS).
172 (2) Ensure that no resource in the CRS can be acquired outside of a
173 critical section. This can be verified with an assert().
174 (3) Ensure that only resources in the CRS can be held while in a critical
175 section. This is harder to enforce.
176
177If any of these conditions are not met, deadlock can ensue when grabbing
178resources in the GC or debugger (#1) or waiting for threads to suspend
179(#2,#3). (You won't actually deadlock in the GC, because if the semantics
180above are followed you don't need to lock anything in the GC. The risk is
181rather that the GC will access data structures in an intermediate state.)
182
183This approach requires more care and awareness in the VM than
184safe-pointing. Because the GC and debugger are fairly intrusive, there
185really aren't any internal VM resources that aren't shared. Thus, the
186enter/exit critical calls can be added to internal mutex wrappers, which
187makes it easy to get #1 and #2 right.
188
189An ordering should be established for all locks to avoid deadlocks.
190
191Monitor locks, which are also implemented with pthread calls, should not
192cause any problems here. Threads fighting over such locks will not be in
193critical sections and can be suspended freely.
194
195This can get tricky if we ever need exclusive access to VM and non-VM
196resources at the same time. It's not clear if this is a real concern.
197
198There are (at least) two ways to handle the incoming signals:
199
200 (a) Always accept signals. If we're in a critical section, the signal
201 handler just returns without doing anything (the "suspend level"
202 should have been incremented before the signal was sent). Otherwise,
203 if the "suspend level" is nonzero, we go to sleep.
204 (b) Block signals in critical sections. This ensures that we can't be
205 interrupted in a critical section, but requires pthread_sigmask()
206 calls on entry and exit.
207
208This is a choice between blocking the message and blocking the messenger.
209Because UNIX signals are unreliable (you can only know that you have been
210signaled, not whether you were signaled once or 10 times), the choice is
211not significant for correctness. The choice depends on the efficiency
212of pthread_sigmask() and the desire to actually block signals. Either way,
213it is best to ensure that there is only one indication of "blocked";
214having two (i.e. block signals and set a flag, then only send a signal
215if the flag isn't set) can lead to race conditions.
216
217The signal handler must take care to copy registers onto the stack (via
218setjmp), so that stack scans find all references. Because we have to scan
219native stacks, "exact" GC is not possible with this approach.
220
221Some other concerns with flinging signals around:
222 - Odd interactions with some debuggers (e.g. gdb on the Mac)
223 - Restrictions on some standard library calls during GC (e.g. don't
224 use printf on stdout to print GC debug messages)
225*/
226
227#define kMaxThreadId ((1<<15) - 1)
228#define kMainThreadId ((1<<1) | 1)
229
230
231static Thread* allocThread(int interpStackSize);
232static bool prepareThread(Thread* thread);
233static void setThreadSelf(Thread* thread);
234static void unlinkThread(Thread* thread);
235static void freeThread(Thread* thread);
236static void assignThreadId(Thread* thread);
237static bool createFakeEntryFrame(Thread* thread);
238static bool createFakeRunFrame(Thread* thread);
239static void* interpThreadStart(void* arg);
240static void* internalThreadStart(void* arg);
241static void threadExitUncaughtException(Thread* thread, Object* group);
242static void threadExitCheck(void* arg);
243static void waitForThreadSuspend(Thread* self, Thread* thread);
244static int getThreadPriorityFromSystem(void);
245
Bill Buzbee46cd5b62009-06-05 15:36:06 -0700246/*
247 * The JIT needs to know if any thread is suspended. We do this by
248 * maintaining a global sum of all threads' suspend counts. All suspendCount
249 * updates should go through this after aquiring threadSuspendCountLock.
250 */
251static inline void dvmAddToThreadSuspendCount(int *pSuspendCount, int delta)
252{
253 *pSuspendCount += delta;
254 gDvm.sumThreadSuspendCount += delta;
255}
The Android Open Source Projectf6c38712009-03-03 19:28:47 -0800256
257/*
258 * Initialize thread list and main thread's environment. We need to set
259 * up some basic stuff so that dvmThreadSelf() will work when we start
260 * loading classes (e.g. to check for exceptions).
261 */
262bool dvmThreadStartup(void)
263{
264 Thread* thread;
265
266 /* allocate a TLS slot */
267 if (pthread_key_create(&gDvm.pthreadKeySelf, threadExitCheck) != 0) {
268 LOGE("ERROR: pthread_key_create failed\n");
269 return false;
270 }
271
272 /* test our pthread lib */
273 if (pthread_getspecific(gDvm.pthreadKeySelf) != NULL)
274 LOGW("WARNING: newly-created pthread TLS slot is not NULL\n");
275
276 /* prep thread-related locks and conditions */
277 dvmInitMutex(&gDvm.threadListLock);
278 pthread_cond_init(&gDvm.threadStartCond, NULL);
279 //dvmInitMutex(&gDvm.vmExitLock);
280 pthread_cond_init(&gDvm.vmExitCond, NULL);
281 dvmInitMutex(&gDvm._threadSuspendLock);
282 dvmInitMutex(&gDvm.threadSuspendCountLock);
283 pthread_cond_init(&gDvm.threadSuspendCountCond, NULL);
284#ifdef WITH_DEADLOCK_PREDICTION
285 dvmInitMutex(&gDvm.deadlockHistoryLock);
286#endif
287
288 /*
289 * Dedicated monitor for Thread.sleep().
290 * TODO: change this to an Object* so we don't have to expose this
291 * call, and we interact better with JDWP monitor calls. Requires
292 * deferring the object creation to much later (e.g. final "main"
293 * thread prep) or until first use.
294 */
295 gDvm.threadSleepMon = dvmCreateMonitor(NULL);
296
297 gDvm.threadIdMap = dvmAllocBitVector(kMaxThreadId, false);
298
299 thread = allocThread(gDvm.stackSize);
300 if (thread == NULL)
301 return false;
302
303 /* switch mode for when we run initializers */
304 thread->status = THREAD_RUNNING;
305
306 /*
307 * We need to assign the threadId early so we can lock/notify
308 * object monitors. We'll set the "threadObj" field later.
309 */
310 prepareThread(thread);
311 gDvm.threadList = thread;
312
313#ifdef COUNT_PRECISE_METHODS
314 gDvm.preciseMethods = dvmPointerSetAlloc(200);
315#endif
316
317 return true;
318}
319
320/*
321 * We're a little farther up now, and can load some basic classes.
322 *
323 * We're far enough along that we can poke at java.lang.Thread and friends,
324 * but should not assume that static initializers have run (or cause them
325 * to do so). That means no object allocations yet.
326 */
327bool dvmThreadObjStartup(void)
328{
329 /*
330 * Cache the locations of these classes. It's likely that we're the
331 * first to reference them, so they're being loaded now.
332 */
333 gDvm.classJavaLangThread =
334 dvmFindSystemClassNoInit("Ljava/lang/Thread;");
335 gDvm.classJavaLangVMThread =
336 dvmFindSystemClassNoInit("Ljava/lang/VMThread;");
337 gDvm.classJavaLangThreadGroup =
338 dvmFindSystemClassNoInit("Ljava/lang/ThreadGroup;");
339 if (gDvm.classJavaLangThread == NULL ||
340 gDvm.classJavaLangThreadGroup == NULL ||
341 gDvm.classJavaLangThreadGroup == NULL)
342 {
343 LOGE("Could not find one or more essential thread classes\n");
344 return false;
345 }
346
347 /*
348 * Cache field offsets. This makes things a little faster, at the
349 * expense of hard-coding non-public field names into the VM.
350 */
351 gDvm.offJavaLangThread_vmThread =
352 dvmFindFieldOffset(gDvm.classJavaLangThread,
353 "vmThread", "Ljava/lang/VMThread;");
354 gDvm.offJavaLangThread_group =
355 dvmFindFieldOffset(gDvm.classJavaLangThread,
356 "group", "Ljava/lang/ThreadGroup;");
357 gDvm.offJavaLangThread_daemon =
358 dvmFindFieldOffset(gDvm.classJavaLangThread, "daemon", "Z");
359 gDvm.offJavaLangThread_name =
360 dvmFindFieldOffset(gDvm.classJavaLangThread,
361 "name", "Ljava/lang/String;");
362 gDvm.offJavaLangThread_priority =
363 dvmFindFieldOffset(gDvm.classJavaLangThread, "priority", "I");
364
365 if (gDvm.offJavaLangThread_vmThread < 0 ||
366 gDvm.offJavaLangThread_group < 0 ||
367 gDvm.offJavaLangThread_daemon < 0 ||
368 gDvm.offJavaLangThread_name < 0 ||
369 gDvm.offJavaLangThread_priority < 0)
370 {
371 LOGE("Unable to find all fields in java.lang.Thread\n");
372 return false;
373 }
374
375 gDvm.offJavaLangVMThread_thread =
376 dvmFindFieldOffset(gDvm.classJavaLangVMThread,
377 "thread", "Ljava/lang/Thread;");
378 gDvm.offJavaLangVMThread_vmData =
379 dvmFindFieldOffset(gDvm.classJavaLangVMThread, "vmData", "I");
380 if (gDvm.offJavaLangVMThread_thread < 0 ||
381 gDvm.offJavaLangVMThread_vmData < 0)
382 {
383 LOGE("Unable to find all fields in java.lang.VMThread\n");
384 return false;
385 }
386
387 /*
388 * Cache the vtable offset for "run()".
389 *
390 * We don't want to keep the Method* because then we won't find see
391 * methods defined in subclasses.
392 */
393 Method* meth;
394 meth = dvmFindVirtualMethodByDescriptor(gDvm.classJavaLangThread, "run", "()V");
395 if (meth == NULL) {
396 LOGE("Unable to find run() in java.lang.Thread\n");
397 return false;
398 }
399 gDvm.voffJavaLangThread_run = meth->methodIndex;
400
401 /*
402 * Cache vtable offsets for ThreadGroup methods.
403 */
404 meth = dvmFindVirtualMethodByDescriptor(gDvm.classJavaLangThreadGroup,
405 "removeThread", "(Ljava/lang/Thread;)V");
406 if (meth == NULL) {
407 LOGE("Unable to find removeThread(Thread) in java.lang.ThreadGroup\n");
408 return false;
409 }
410 gDvm.voffJavaLangThreadGroup_removeThread = meth->methodIndex;
411
412 return true;
413}
414
415/*
416 * All threads should be stopped by now. Clean up some thread globals.
417 */
418void dvmThreadShutdown(void)
419{
420 if (gDvm.threadList != NULL) {
Andy McFaddenf17638e2009-08-04 16:38:40 -0700421 /*
422 * If we walk through the thread list and try to free the
423 * lingering thread structures (which should only be for daemon
424 * threads), the daemon threads may crash if they execute before
425 * the process dies. Let them leak.
426 */
The Android Open Source Projectf6c38712009-03-03 19:28:47 -0800427 freeThread(gDvm.threadList);
428 gDvm.threadList = NULL;
429 }
430
431 dvmFreeBitVector(gDvm.threadIdMap);
432
433 dvmFreeMonitorList();
434
435 pthread_key_delete(gDvm.pthreadKeySelf);
436}
437
438
439/*
440 * Grab the suspend count global lock.
441 */
442static inline void lockThreadSuspendCount(void)
443{
444 /*
445 * Don't try to change to VMWAIT here. When we change back to RUNNING
446 * we have to check for a pending suspend, which results in grabbing
447 * this lock recursively. Doesn't work with "fast" pthread mutexes.
448 *
449 * This lock is always held for very brief periods, so as long as
450 * mutex ordering is respected we shouldn't stall.
451 */
452 int cc = pthread_mutex_lock(&gDvm.threadSuspendCountLock);
453 assert(cc == 0);
454}
455
456/*
457 * Release the suspend count global lock.
458 */
459static inline void unlockThreadSuspendCount(void)
460{
461 dvmUnlockMutex(&gDvm.threadSuspendCountLock);
462}
463
464/*
465 * Grab the thread list global lock.
466 *
467 * This is held while "suspend all" is trying to make everybody stop. If
468 * the shutdown is in progress, and somebody tries to grab the lock, they'll
469 * have to wait for the GC to finish. Therefore it's important that the
470 * thread not be in RUNNING mode.
471 *
472 * We don't have to check to see if we should be suspended once we have
473 * the lock. Nobody can suspend all threads without holding the thread list
474 * lock while they do it, so by definition there isn't a GC in progress.
Andy McFadden44860362009-08-06 17:56:14 -0700475 *
476 * TODO: consider checking for suspend after acquiring the lock, and
477 * backing off if set. As stated above, it can't happen during normal
478 * execution, but it *can* happen during shutdown when daemon threads
479 * are being suspended.
The Android Open Source Projectf6c38712009-03-03 19:28:47 -0800480 */
481void dvmLockThreadList(Thread* self)
482{
483 ThreadStatus oldStatus;
484
485 if (self == NULL) /* try to get it from TLS */
486 self = dvmThreadSelf();
487
488 if (self != NULL) {
489 oldStatus = self->status;
490 self->status = THREAD_VMWAIT;
491 } else {
Andy McFadden44860362009-08-06 17:56:14 -0700492 /* happens during VM shutdown */
The Android Open Source Projectf6c38712009-03-03 19:28:47 -0800493 //LOGW("NULL self in dvmLockThreadList\n");
494 oldStatus = -1; // shut up gcc
495 }
496
497 int cc = pthread_mutex_lock(&gDvm.threadListLock);
498 assert(cc == 0);
499
500 if (self != NULL)
501 self->status = oldStatus;
502}
503
504/*
505 * Release the thread list global lock.
506 */
507void dvmUnlockThreadList(void)
508{
509 int cc = pthread_mutex_unlock(&gDvm.threadListLock);
510 assert(cc == 0);
511}
512
The Android Open Source Project99409882009-03-18 22:20:24 -0700513/*
514 * Convert SuspendCause to a string.
515 */
516static const char* getSuspendCauseStr(SuspendCause why)
517{
518 switch (why) {
519 case SUSPEND_NOT: return "NOT?";
520 case SUSPEND_FOR_GC: return "gc";
521 case SUSPEND_FOR_DEBUG: return "debug";
522 case SUSPEND_FOR_DEBUG_EVENT: return "debug-event";
523 case SUSPEND_FOR_STACK_DUMP: return "stack-dump";
Ben Chenga8e64a72009-10-20 13:01:36 -0700524#if defined(WITH_JIT)
525 case SUSPEND_FOR_TBL_RESIZE: return "table-resize";
526 case SUSPEND_FOR_IC_PATCH: return "inline-cache-patch";
527#endif
The Android Open Source Project99409882009-03-18 22:20:24 -0700528 default: return "UNKNOWN";
529 }
530}
The Android Open Source Projectf6c38712009-03-03 19:28:47 -0800531
532/*
533 * Grab the "thread suspend" lock. This is required to prevent the
534 * GC and the debugger from simultaneously suspending all threads.
535 *
536 * If we fail to get the lock, somebody else is trying to suspend all
537 * threads -- including us. If we go to sleep on the lock we'll deadlock
538 * the VM. Loop until we get it or somebody puts us to sleep.
539 */
540static void lockThreadSuspend(const char* who, SuspendCause why)
541{
The Android Open Source Projectf6c38712009-03-03 19:28:47 -0800542 const int kSpinSleepTime = 3*1000*1000; /* 3s */
543 u8 startWhen = 0; // init req'd to placate gcc
544 int sleepIter = 0;
545 int cc;
Jeff Hao97319a82009-08-12 16:57:15 -0700546
The Android Open Source Projectf6c38712009-03-03 19:28:47 -0800547 do {
548 cc = pthread_mutex_trylock(&gDvm._threadSuspendLock);
549 if (cc != 0) {
550 if (!dvmCheckSuspendPending(NULL)) {
551 /*
Andy McFadden2aa43612009-06-17 16:29:30 -0700552 * Could be that a resume-all is in progress, and something
553 * grabbed the CPU when the wakeup was broadcast. The thread
554 * performing the resume hasn't had a chance to release the
Andy McFaddene8059be2009-06-04 14:34:14 -0700555 * thread suspend lock. (We release before the broadcast,
556 * so this should be a narrow window.)
Andy McFadden2aa43612009-06-17 16:29:30 -0700557 *
558 * Could be we hit the window as a suspend was started,
559 * and the lock has been grabbed but the suspend counts
560 * haven't been incremented yet.
The Android Open Source Project99409882009-03-18 22:20:24 -0700561 *
562 * Could be an unusual JNI thread-attach thing.
563 *
564 * Could be the debugger telling us to resume at roughly
The Android Open Source Projectf6c38712009-03-03 19:28:47 -0800565 * the same time we're posting an event.
Ben Chenga8e64a72009-10-20 13:01:36 -0700566 *
567 * Could be two app threads both want to patch predicted
568 * chaining cells around the same time.
The Android Open Source Projectf6c38712009-03-03 19:28:47 -0800569 */
The Android Open Source Project99409882009-03-18 22:20:24 -0700570 LOGI("threadid=%d ODD: want thread-suspend lock (%s:%s),"
571 " it's held, no suspend pending\n",
572 dvmThreadSelf()->threadId, who, getSuspendCauseStr(why));
573 } else {
574 /* we suspended; reset timeout */
575 sleepIter = 0;
The Android Open Source Projectf6c38712009-03-03 19:28:47 -0800576 }
577
578 /* give the lock-holder a chance to do some work */
579 if (sleepIter == 0)
580 startWhen = dvmGetRelativeTimeUsec();
581 if (!dvmIterativeSleep(sleepIter++, kSpinSleepTime, startWhen)) {
The Android Open Source Project99409882009-03-18 22:20:24 -0700582 LOGE("threadid=%d: couldn't get thread-suspend lock (%s:%s),"
The Android Open Source Projectf6c38712009-03-03 19:28:47 -0800583 " bailing\n",
The Android Open Source Project99409882009-03-18 22:20:24 -0700584 dvmThreadSelf()->threadId, who, getSuspendCauseStr(why));
Andy McFadden2aa43612009-06-17 16:29:30 -0700585 /* threads are not suspended, thread dump could crash */
The Android Open Source Projectf6c38712009-03-03 19:28:47 -0800586 dvmDumpAllThreads(false);
587 dvmAbort();
588 }
589 }
590 } while (cc != 0);
591 assert(cc == 0);
592}
593
594/*
595 * Release the "thread suspend" lock.
596 */
597static inline void unlockThreadSuspend(void)
598{
599 int cc = pthread_mutex_unlock(&gDvm._threadSuspendLock);
600 assert(cc == 0);
601}
602
603
604/*
605 * Kill any daemon threads that still exist. All of ours should be
606 * stopped, so these should be Thread objects or JNI-attached threads
607 * started by the application. Actively-running threads are likely
608 * to crash the process if they continue to execute while the VM
609 * shuts down, so we really need to kill or suspend them. (If we want
610 * the VM to restart within this process, we need to kill them, but that
611 * leaves open the possibility of orphaned resources.)
612 *
613 * Waiting for the thread to suspend may be unwise at this point, but
614 * if one of these is wedged in a critical section then we probably
615 * would've locked up on the last GC attempt.
616 *
617 * It's possible for this function to get called after a failed
618 * initialization, so be careful with assumptions about the environment.
Andy McFadden44860362009-08-06 17:56:14 -0700619 *
620 * This will be called from whatever thread calls DestroyJavaVM, usually
621 * but not necessarily the main thread. It's likely, but not guaranteed,
622 * that the current thread has already been cleaned up.
The Android Open Source Projectf6c38712009-03-03 19:28:47 -0800623 */
624void dvmSlayDaemons(void)
625{
Andy McFadden44860362009-08-06 17:56:14 -0700626 Thread* self = dvmThreadSelf(); // may be null
The Android Open Source Projectf6c38712009-03-03 19:28:47 -0800627 Thread* target;
Andy McFadden44860362009-08-06 17:56:14 -0700628 int threadId = 0;
629 bool doWait = false;
The Android Open Source Projectf6c38712009-03-03 19:28:47 -0800630
631 //dvmEnterCritical(self);
632 dvmLockThreadList(self);
633
Andy McFadden44860362009-08-06 17:56:14 -0700634 if (self != NULL)
635 threadId = self->threadId;
636
The Android Open Source Projectf6c38712009-03-03 19:28:47 -0800637 target = gDvm.threadList;
638 while (target != NULL) {
639 if (target == self) {
640 target = target->next;
641 continue;
642 }
643
644 if (!dvmGetFieldBoolean(target->threadObj,
645 gDvm.offJavaLangThread_daemon))
646 {
Andy McFadden44860362009-08-06 17:56:14 -0700647 /* should never happen; suspend it with the rest */
The Android Open Source Projectf6c38712009-03-03 19:28:47 -0800648 LOGW("threadid=%d: non-daemon id=%d still running at shutdown?!\n",
Andy McFadden44860362009-08-06 17:56:14 -0700649 threadId, target->threadId);
The Android Open Source Projectf6c38712009-03-03 19:28:47 -0800650 }
651
Andy McFadden44860362009-08-06 17:56:14 -0700652 char* threadName = dvmGetThreadName(target);
653 LOGD("threadid=%d: suspending daemon id=%d name='%s'\n",
654 threadId, target->threadId, threadName);
655 free(threadName);
The Android Open Source Projectf6c38712009-03-03 19:28:47 -0800656
Andy McFadden44860362009-08-06 17:56:14 -0700657 /* mark as suspended */
658 lockThreadSuspendCount();
659 dvmAddToThreadSuspendCount(&target->suspendCount, 1);
660 unlockThreadSuspendCount();
661 doWait = true;
662
663 target = target->next;
664 }
665
666 //dvmDumpAllThreads(false);
667
668 /*
669 * Unlock the thread list, relocking it later if necessary. It's
670 * possible a thread is in VMWAIT after calling dvmLockThreadList,
671 * and that function *doesn't* check for pending suspend after
672 * acquiring the lock. We want to let them finish their business
673 * and see the pending suspend before we continue here.
674 *
675 * There's no guarantee of mutex fairness, so this might not work.
676 * (The alternative is to have dvmLockThreadList check for suspend
677 * after acquiring the lock and back off, something we should consider.)
678 */
679 dvmUnlockThreadList();
680
681 if (doWait) {
682 usleep(200 * 1000);
683
684 dvmLockThreadList(self);
685
686 /*
687 * Sleep for a bit until the threads have suspended. We're trying
688 * to exit, so don't wait for too long.
689 */
690 int i;
691 for (i = 0; i < 10; i++) {
692 bool allSuspended = true;
693
694 target = gDvm.threadList;
695 while (target != NULL) {
696 if (target == self) {
697 target = target->next;
698 continue;
699 }
700
701 if (target->status == THREAD_RUNNING && !target->isSuspended) {
702 LOGD("threadid=%d not ready yet\n", target->threadId);
703 allSuspended = false;
704 break;
705 }
706
707 target = target->next;
708 }
709
710 if (allSuspended) {
711 LOGD("threadid=%d: all daemons have suspended\n", threadId);
712 break;
713 } else {
714 LOGD("threadid=%d: waiting for daemons to suspend\n", threadId);
715 }
716
717 usleep(200 * 1000);
718 }
719 dvmUnlockThreadList();
720 }
721
722#if 0 /* bad things happen if they come out of JNI or "spuriously" wake up */
723 /*
724 * Abandon the threads and recover their resources.
725 */
726 target = gDvm.threadList;
727 while (target != NULL) {
728 Thread* nextTarget = target->next;
The Android Open Source Projectf6c38712009-03-03 19:28:47 -0800729 unlinkThread(target);
The Android Open Source Projectf6c38712009-03-03 19:28:47 -0800730 freeThread(target);
731 target = nextTarget;
732 }
Andy McFadden44860362009-08-06 17:56:14 -0700733#endif
The Android Open Source Projectf6c38712009-03-03 19:28:47 -0800734
Andy McFadden44860362009-08-06 17:56:14 -0700735 //dvmDumpAllThreads(true);
The Android Open Source Projectf6c38712009-03-03 19:28:47 -0800736}
737
738
739/*
740 * Finish preparing the parts of the Thread struct required to support
741 * JNI registration.
742 */
743bool dvmPrepMainForJni(JNIEnv* pEnv)
744{
745 Thread* self;
746
747 /* main thread is always first in list at this point */
748 self = gDvm.threadList;
749 assert(self->threadId == kMainThreadId);
750
751 /* create a "fake" JNI frame at the top of the main thread interp stack */
752 if (!createFakeEntryFrame(self))
753 return false;
754
755 /* fill these in, since they weren't ready at dvmCreateJNIEnv time */
756 dvmSetJniEnvThreadId(pEnv, self);
757 dvmSetThreadJNIEnv(self, (JNIEnv*) pEnv);
758
759 return true;
760}
761
762
763/*
764 * Finish preparing the main thread, allocating some objects to represent
765 * it. As part of doing so, we finish initializing Thread and ThreadGroup.
Andy McFaddena1a7a342009-05-04 13:29:30 -0700766 * This will execute some interpreted code (e.g. class initializers).
The Android Open Source Projectf6c38712009-03-03 19:28:47 -0800767 */
768bool dvmPrepMainThread(void)
769{
770 Thread* thread;
771 Object* groupObj;
772 Object* threadObj;
773 Object* vmThreadObj;
774 StringObject* threadNameStr;
775 Method* init;
776 JValue unused;
777
778 LOGV("+++ finishing prep on main VM thread\n");
779
780 /* main thread is always first in list at this point */
781 thread = gDvm.threadList;
782 assert(thread->threadId == kMainThreadId);
783
784 /*
785 * Make sure the classes are initialized. We have to do this before
786 * we create an instance of them.
787 */
788 if (!dvmInitClass(gDvm.classJavaLangClass)) {
789 LOGE("'Class' class failed to initialize\n");
790 return false;
791 }
792 if (!dvmInitClass(gDvm.classJavaLangThreadGroup) ||
793 !dvmInitClass(gDvm.classJavaLangThread) ||
794 !dvmInitClass(gDvm.classJavaLangVMThread))
795 {
796 LOGE("thread classes failed to initialize\n");
797 return false;
798 }
799
800 groupObj = dvmGetMainThreadGroup();
801 if (groupObj == NULL)
802 return false;
803
804 /*
805 * Allocate and construct a Thread with the internal-creation
806 * constructor.
807 */
808 threadObj = dvmAllocObject(gDvm.classJavaLangThread, ALLOC_DEFAULT);
809 if (threadObj == NULL) {
810 LOGE("unable to allocate main thread object\n");
811 return false;
812 }
813 dvmReleaseTrackedAlloc(threadObj, NULL);
814
815 threadNameStr = dvmCreateStringFromCstr("main", ALLOC_DEFAULT);
816 if (threadNameStr == NULL)
817 return false;
818 dvmReleaseTrackedAlloc((Object*)threadNameStr, NULL);
819
820 init = dvmFindDirectMethodByDescriptor(gDvm.classJavaLangThread, "<init>",
821 "(Ljava/lang/ThreadGroup;Ljava/lang/String;IZ)V");
822 assert(init != NULL);
823 dvmCallMethod(thread, init, threadObj, &unused, groupObj, threadNameStr,
824 THREAD_NORM_PRIORITY, false);
825 if (dvmCheckException(thread)) {
826 LOGE("exception thrown while constructing main thread object\n");
827 return false;
828 }
829
830 /*
831 * Allocate and construct a VMThread.
832 */
833 vmThreadObj = dvmAllocObject(gDvm.classJavaLangVMThread, ALLOC_DEFAULT);
834 if (vmThreadObj == NULL) {
835 LOGE("unable to allocate main vmthread object\n");
836 return false;
837 }
838 dvmReleaseTrackedAlloc(vmThreadObj, NULL);
839
840 init = dvmFindDirectMethodByDescriptor(gDvm.classJavaLangVMThread, "<init>",
841 "(Ljava/lang/Thread;)V");
842 dvmCallMethod(thread, init, vmThreadObj, &unused, threadObj);
843 if (dvmCheckException(thread)) {
844 LOGE("exception thrown while constructing main vmthread object\n");
845 return false;
846 }
847
848 /* set the VMThread.vmData field to our Thread struct */
849 assert(gDvm.offJavaLangVMThread_vmData != 0);
850 dvmSetFieldInt(vmThreadObj, gDvm.offJavaLangVMThread_vmData, (u4)thread);
851
852 /*
853 * Stuff the VMThread back into the Thread. From this point on, other
Andy McFaddena1a7a342009-05-04 13:29:30 -0700854 * Threads will see that this Thread is running (at least, they would,
855 * if there were any).
The Android Open Source Projectf6c38712009-03-03 19:28:47 -0800856 */
857 dvmSetFieldObject(threadObj, gDvm.offJavaLangThread_vmThread,
858 vmThreadObj);
859
860 thread->threadObj = threadObj;
861
862 /*
Andy McFaddena1a7a342009-05-04 13:29:30 -0700863 * Set the context class loader. This invokes a ClassLoader method,
864 * which could conceivably call Thread.currentThread(), so we want the
865 * Thread to be fully configured before we do this.
866 */
867 Object* systemLoader = dvmGetSystemClassLoader();
868 if (systemLoader == NULL) {
869 LOGW("WARNING: system class loader is NULL (setting main ctxt)\n");
870 /* keep going */
871 }
872 int ctxtClassLoaderOffset = dvmFindFieldOffset(gDvm.classJavaLangThread,
873 "contextClassLoader", "Ljava/lang/ClassLoader;");
874 if (ctxtClassLoaderOffset < 0) {
875 LOGE("Unable to find contextClassLoader field in Thread\n");
876 return false;
877 }
878 dvmSetFieldObject(threadObj, ctxtClassLoaderOffset, systemLoader);
879
880 /*
The Android Open Source Projectf6c38712009-03-03 19:28:47 -0800881 * Finish our thread prep.
882 */
883
884 /* include self in non-daemon threads (mainly for AttachCurrentThread) */
885 gDvm.nonDaemonThreadCount++;
886
887 return true;
888}
889
890
891/*
892 * Alloc and initialize a Thread struct.
893 *
894 * "threadObj" is the java.lang.Thread object. It will be NULL for the
895 * main VM thread, but non-NULL for everything else.
896 *
897 * Does not create any objects, just stuff on the system (malloc) heap. (If
898 * this changes, we need to use ALLOC_NO_GC. And also verify that we're
899 * ready to load classes at the time this is called.)
900 */
901static Thread* allocThread(int interpStackSize)
902{
903 Thread* thread;
904 u1* stackBottom;
905
906 thread = (Thread*) calloc(1, sizeof(Thread));
907 if (thread == NULL)
908 return NULL;
909
Jeff Hao97319a82009-08-12 16:57:15 -0700910#if defined(WITH_SELF_VERIFICATION)
911 if (dvmSelfVerificationShadowSpaceAlloc(thread) == NULL)
912 return NULL;
913#endif
914
The Android Open Source Projectf6c38712009-03-03 19:28:47 -0800915 assert(interpStackSize >= kMinStackSize && interpStackSize <=kMaxStackSize);
916
917 thread->status = THREAD_INITIALIZING;
918 thread->suspendCount = 0;
919
920#ifdef WITH_ALLOC_LIMITS
921 thread->allocLimit = -1;
922#endif
923
924 /*
925 * Allocate and initialize the interpreted code stack. We essentially
926 * "lose" the alloc pointer, which points at the bottom of the stack,
927 * but we can get it back later because we know how big the stack is.
928 *
929 * The stack must be aligned on a 4-byte boundary.
930 */
931#ifdef MALLOC_INTERP_STACK
932 stackBottom = (u1*) malloc(interpStackSize);
933 if (stackBottom == NULL) {
Jeff Hao97319a82009-08-12 16:57:15 -0700934#if defined(WITH_SELF_VERIFICATION)
935 dvmSelfVerificationShadowSpaceFree(thread);
936#endif
The Android Open Source Projectf6c38712009-03-03 19:28:47 -0800937 free(thread);
938 return NULL;
939 }
940 memset(stackBottom, 0xc5, interpStackSize); // stop valgrind complaints
941#else
942 stackBottom = mmap(NULL, interpStackSize, PROT_READ | PROT_WRITE,
943 MAP_PRIVATE | MAP_ANON, -1, 0);
944 if (stackBottom == MAP_FAILED) {
Jeff Hao97319a82009-08-12 16:57:15 -0700945#if defined(WITH_SELF_VERIFICATION)
946 dvmSelfVerificationShadowSpaceFree(thread);
947#endif
The Android Open Source Projectf6c38712009-03-03 19:28:47 -0800948 free(thread);
949 return NULL;
950 }
951#endif
952
953 assert(((u4)stackBottom & 0x03) == 0); // looks like our malloc ensures this
954 thread->interpStackSize = interpStackSize;
955 thread->interpStackStart = stackBottom + interpStackSize;
956 thread->interpStackEnd = stackBottom + STACK_OVERFLOW_RESERVE;
957
958 /* give the thread code a chance to set things up */
959 dvmInitInterpStack(thread, interpStackSize);
960
961 return thread;
962}
963
964/*
965 * Get a meaningful thread ID. At present this only has meaning under Linux,
966 * where getpid() and gettid() sometimes agree and sometimes don't depending
967 * on your thread model (try "export LD_ASSUME_KERNEL=2.4.19").
968 */
969pid_t dvmGetSysThreadId(void)
970{
971#ifdef HAVE_GETTID
972 return gettid();
973#else
974 return getpid();
975#endif
976}
977
978/*
979 * Finish initialization of a Thread struct.
980 *
981 * This must be called while executing in the new thread, but before the
982 * thread is added to the thread list.
983 *
984 * *** NOTE: The threadListLock must be held by the caller (needed for
985 * assignThreadId()).
986 */
987static bool prepareThread(Thread* thread)
988{
989 assignThreadId(thread);
990 thread->handle = pthread_self();
991 thread->systemTid = dvmGetSysThreadId();
992
993 //LOGI("SYSTEM TID IS %d (pid is %d)\n", (int) thread->systemTid,
994 // (int) getpid());
995 setThreadSelf(thread);
996
997 LOGV("threadid=%d: interp stack at %p\n",
998 thread->threadId, thread->interpStackStart - thread->interpStackSize);
999
1000 /*
1001 * Initialize invokeReq.
1002 */
Carl Shapiro77f52eb2009-12-24 19:56:53 -08001003 dvmInitMutex(&thread->invokeReq.lock);
The Android Open Source Projectf6c38712009-03-03 19:28:47 -08001004 pthread_cond_init(&thread->invokeReq.cv, NULL);
1005
1006 /*
1007 * Initialize our reference tracking tables.
1008 *
The Android Open Source Projectf6c38712009-03-03 19:28:47 -08001009 * Most threads won't use jniMonitorRefTable, so we clear out the
1010 * structure but don't call the init function (which allocs storage).
1011 */
Andy McFaddend5ab7262009-08-25 07:19:34 -07001012#ifdef USE_INDIRECT_REF
1013 if (!dvmInitIndirectRefTable(&thread->jniLocalRefTable,
1014 kJniLocalRefMin, kJniLocalRefMax, kIndirectKindLocal))
1015 return false;
1016#else
1017 /*
1018 * The JNI local ref table *must* be fixed-size because we keep pointers
1019 * into the table in our stack frames.
1020 */
The Android Open Source Projectf6c38712009-03-03 19:28:47 -08001021 if (!dvmInitReferenceTable(&thread->jniLocalRefTable,
1022 kJniLocalRefMax, kJniLocalRefMax))
1023 return false;
Andy McFaddend5ab7262009-08-25 07:19:34 -07001024#endif
The Android Open Source Projectf6c38712009-03-03 19:28:47 -08001025 if (!dvmInitReferenceTable(&thread->internalLocalRefTable,
1026 kInternalRefDefault, kInternalRefMax))
1027 return false;
1028
1029 memset(&thread->jniMonitorRefTable, 0, sizeof(thread->jniMonitorRefTable));
1030
Carl Shapiro77f52eb2009-12-24 19:56:53 -08001031 pthread_cond_init(&thread->waitCond, NULL);
1032 dvmInitMutex(&thread->waitMutex);
1033
The Android Open Source Projectf6c38712009-03-03 19:28:47 -08001034 return true;
1035}
1036
1037/*
1038 * Remove a thread from the internal list.
1039 * Clear out the links to make it obvious that the thread is
1040 * no longer on the list. Caller must hold gDvm.threadListLock.
1041 */
1042static void unlinkThread(Thread* thread)
1043{
1044 LOG_THREAD("threadid=%d: removing from list\n", thread->threadId);
1045 if (thread == gDvm.threadList) {
1046 assert(thread->prev == NULL);
1047 gDvm.threadList = thread->next;
1048 } else {
1049 assert(thread->prev != NULL);
1050 thread->prev->next = thread->next;
1051 }
1052 if (thread->next != NULL)
1053 thread->next->prev = thread->prev;
1054 thread->prev = thread->next = NULL;
1055}
1056
1057/*
1058 * Free a Thread struct, and all the stuff allocated within.
1059 */
1060static void freeThread(Thread* thread)
1061{
1062 if (thread == NULL)
1063 return;
1064
1065 /* thread->threadId is zero at this point */
1066 LOGVV("threadid=%d: freeing\n", thread->threadId);
1067
1068 if (thread->interpStackStart != NULL) {
1069 u1* interpStackBottom;
1070
1071 interpStackBottom = thread->interpStackStart;
1072 interpStackBottom -= thread->interpStackSize;
1073#ifdef MALLOC_INTERP_STACK
1074 free(interpStackBottom);
1075#else
1076 if (munmap(interpStackBottom, thread->interpStackSize) != 0)
1077 LOGW("munmap(thread stack) failed\n");
1078#endif
1079 }
1080
Andy McFaddend5ab7262009-08-25 07:19:34 -07001081#ifdef USE_INDIRECT_REF
1082 dvmClearIndirectRefTable(&thread->jniLocalRefTable);
1083#else
The Android Open Source Projectf6c38712009-03-03 19:28:47 -08001084 dvmClearReferenceTable(&thread->jniLocalRefTable);
Andy McFaddend5ab7262009-08-25 07:19:34 -07001085#endif
The Android Open Source Projectf6c38712009-03-03 19:28:47 -08001086 dvmClearReferenceTable(&thread->internalLocalRefTable);
1087 if (&thread->jniMonitorRefTable.table != NULL)
1088 dvmClearReferenceTable(&thread->jniMonitorRefTable);
1089
Jeff Hao97319a82009-08-12 16:57:15 -07001090#if defined(WITH_SELF_VERIFICATION)
1091 dvmSelfVerificationShadowSpaceFree(thread);
1092#endif
The Android Open Source Projectf6c38712009-03-03 19:28:47 -08001093 free(thread);
1094}
1095
1096/*
1097 * Like pthread_self(), but on a Thread*.
1098 */
1099Thread* dvmThreadSelf(void)
1100{
1101 return (Thread*) pthread_getspecific(gDvm.pthreadKeySelf);
1102}
1103
1104/*
1105 * Explore our sense of self. Stuffs the thread pointer into TLS.
1106 */
1107static void setThreadSelf(Thread* thread)
1108{
1109 int cc;
1110
1111 cc = pthread_setspecific(gDvm.pthreadKeySelf, thread);
1112 if (cc != 0) {
1113 /*
1114 * Sometimes this fails under Bionic with EINVAL during shutdown.
1115 * This can happen if the timing is just right, e.g. a thread
1116 * fails to attach during shutdown, but the "fail" path calls
1117 * here to ensure we clean up after ourselves.
1118 */
1119 if (thread != NULL) {
1120 LOGE("pthread_setspecific(%p) failed, err=%d\n", thread, cc);
1121 dvmAbort(); /* the world is fundamentally hosed */
1122 }
1123 }
1124}
1125
1126/*
1127 * This is associated with the pthreadKeySelf key. It's called by the
1128 * pthread library when a thread is exiting and the "self" pointer in TLS
1129 * is non-NULL, meaning the VM hasn't had a chance to clean up. In normal
Andy McFadden909ce242009-12-10 16:38:30 -08001130 * operation this will not be called.
The Android Open Source Projectf6c38712009-03-03 19:28:47 -08001131 *
1132 * This is mainly of use to ensure that we don't leak resources if, for
1133 * example, a thread attaches itself to us with AttachCurrentThread and
1134 * then exits without notifying the VM.
Andy McFadden34e25bb2009-04-15 13:27:12 -07001135 *
1136 * We could do the detach here instead of aborting, but this will lead to
1137 * portability problems. Other implementations do not do this check and
1138 * will simply be unaware that the thread has exited, leading to resource
1139 * leaks (and, if this is a non-daemon thread, an infinite hang when the
1140 * VM tries to shut down).
Andy McFadden909ce242009-12-10 16:38:30 -08001141 *
1142 * Because some implementations may want to use the pthread destructor
1143 * to initiate the detach, and the ordering of destructors is not defined,
1144 * we want to iterate a couple of times to give those a chance to run.
The Android Open Source Projectf6c38712009-03-03 19:28:47 -08001145 */
1146static void threadExitCheck(void* arg)
1147{
Andy McFadden909ce242009-12-10 16:38:30 -08001148 const int kMaxCount = 2;
The Android Open Source Projectf6c38712009-03-03 19:28:47 -08001149
Andy McFadden909ce242009-12-10 16:38:30 -08001150 Thread* self = (Thread*) arg;
1151 assert(self != NULL);
The Android Open Source Projectf6c38712009-03-03 19:28:47 -08001152
Andy McFadden909ce242009-12-10 16:38:30 -08001153 LOGV("threadid=%d: threadExitCheck(%p) count=%d\n",
1154 self->threadId, arg, self->threadExitCheckCount);
1155
1156 if (self->status == THREAD_ZOMBIE) {
1157 LOGW("threadid=%d: Weird -- shouldn't be in threadExitCheck\n",
1158 self->threadId);
1159 return;
1160 }
1161
1162 if (self->threadExitCheckCount < kMaxCount) {
1163 /*
1164 * Spin a couple of times to let other destructors fire.
1165 */
1166 LOGD("threadid=%d: thread exiting, not yet detached (count=%d)\n",
1167 self->threadId, self->threadExitCheckCount);
1168 self->threadExitCheckCount++;
1169 int cc = pthread_setspecific(gDvm.pthreadKeySelf, self);
1170 if (cc != 0) {
1171 LOGE("threadid=%d: unable to re-add thread to TLS\n",
1172 self->threadId);
1173 dvmAbort();
1174 }
1175 } else {
1176 LOGE("threadid=%d: native thread exited without detaching\n",
1177 self->threadId);
The Android Open Source Projectf6c38712009-03-03 19:28:47 -08001178 dvmAbort();
1179 }
1180}
1181
1182
1183/*
1184 * Assign the threadId. This needs to be a small integer so that our
1185 * "thin" locks fit in a small number of bits.
1186 *
1187 * We reserve zero for use as an invalid ID.
1188 *
1189 * This must be called with threadListLock held (unless we're still
1190 * initializing the system).
1191 */
1192static void assignThreadId(Thread* thread)
1193{
1194 /* Find a small unique integer. threadIdMap is a vector of
1195 * kMaxThreadId bits; dvmAllocBit() returns the index of a
1196 * bit, meaning that it will always be < kMaxThreadId.
1197 *
1198 * The thin locking magic requires that the low bit is always
1199 * set, so we do it once, here.
1200 */
1201 int num = dvmAllocBit(gDvm.threadIdMap);
1202 if (num < 0) {
1203 LOGE("Ran out of thread IDs\n");
1204 dvmAbort(); // TODO: make this a non-fatal error result
1205 }
1206
1207 thread->threadId = ((num + 1) << 1) | 1;
1208
1209 assert(thread->threadId != 0);
1210 assert(thread->threadId != DVM_LOCK_INITIAL_THIN_VALUE);
1211}
1212
1213/*
1214 * Give back the thread ID.
1215 */
1216static void releaseThreadId(Thread* thread)
1217{
1218 assert(thread->threadId > 0);
1219 dvmClearBit(gDvm.threadIdMap, (thread->threadId >> 1) - 1);
1220 thread->threadId = 0;
1221}
1222
1223
1224/*
1225 * Add a stack frame that makes it look like the native code in the main
1226 * thread was originally invoked from interpreted code. This gives us a
1227 * place to hang JNI local references. The VM spec says (v2 5.2) that the
1228 * VM begins by executing "main" in a class, so in a way this brings us
1229 * closer to the spec.
1230 */
1231static bool createFakeEntryFrame(Thread* thread)
1232{
1233 assert(thread->threadId == kMainThreadId); // main thread only
1234
1235 /* find the method on first use */
1236 if (gDvm.methFakeNativeEntry == NULL) {
1237 ClassObject* nativeStart;
1238 Method* mainMeth;
1239
1240 nativeStart = dvmFindSystemClassNoInit(
1241 "Ldalvik/system/NativeStart;");
1242 if (nativeStart == NULL) {
1243 LOGE("Unable to find dalvik.system.NativeStart class\n");
1244 return false;
1245 }
1246
1247 /*
1248 * Because we are creating a frame that represents application code, we
1249 * want to stuff the application class loader into the method's class
1250 * loader field, even though we're using the system class loader to
1251 * load it. This makes life easier over in JNI FindClass (though it
1252 * could bite us in other ways).
1253 *
1254 * Unfortunately this is occurring too early in the initialization,
1255 * of necessity coming before JNI is initialized, and we're not quite
1256 * ready to set up the application class loader.
1257 *
1258 * So we save a pointer to the method in gDvm.methFakeNativeEntry
1259 * and check it in FindClass. The method is private so nobody else
1260 * can call it.
1261 */
1262 //nativeStart->classLoader = dvmGetSystemClassLoader();
1263
1264 mainMeth = dvmFindDirectMethodByDescriptor(nativeStart,
1265 "main", "([Ljava/lang/String;)V");
1266 if (mainMeth == NULL) {
1267 LOGE("Unable to find 'main' in dalvik.system.NativeStart\n");
1268 return false;
1269 }
1270
1271 gDvm.methFakeNativeEntry = mainMeth;
1272 }
1273
1274 return dvmPushJNIFrame(thread, gDvm.methFakeNativeEntry);
1275}
1276
1277
1278/*
1279 * Add a stack frame that makes it look like the native thread has been
1280 * executing interpreted code. This gives us a place to hang JNI local
1281 * references.
1282 */
1283static bool createFakeRunFrame(Thread* thread)
1284{
1285 ClassObject* nativeStart;
1286 Method* runMeth;
1287
1288 assert(thread->threadId != 1); // not for main thread
1289
1290 nativeStart =
1291 dvmFindSystemClassNoInit("Ldalvik/system/NativeStart;");
1292 if (nativeStart == NULL) {
1293 LOGE("Unable to find dalvik.system.NativeStart class\n");
1294 return false;
1295 }
1296
1297 runMeth = dvmFindVirtualMethodByDescriptor(nativeStart, "run", "()V");
1298 if (runMeth == NULL) {
1299 LOGE("Unable to find 'run' in dalvik.system.NativeStart\n");
1300 return false;
1301 }
1302
1303 return dvmPushJNIFrame(thread, runMeth);
1304}
1305
1306/*
1307 * Helper function to set the name of the current thread
1308 */
1309static void setThreadName(const char *threadName)
1310{
1311#if defined(HAVE_PRCTL)
1312 int hasAt = 0;
1313 int hasDot = 0;
1314 const char *s = threadName;
1315 while (*s) {
1316 if (*s == '.') hasDot = 1;
1317 else if (*s == '@') hasAt = 1;
1318 s++;
1319 }
1320 int len = s - threadName;
1321 if (len < 15 || hasAt || !hasDot) {
1322 s = threadName;
1323 } else {
1324 s = threadName + len - 15;
1325 }
1326 prctl(PR_SET_NAME, (unsigned long) s, 0, 0, 0);
1327#endif
1328}
1329
1330/*
1331 * Create a thread as a result of java.lang.Thread.start().
1332 *
1333 * We do have to worry about some concurrency problems, e.g. programs
1334 * that try to call Thread.start() on the same object from multiple threads.
1335 * (This will fail for all but one, but we have to make sure that it succeeds
1336 * for exactly one.)
1337 *
1338 * Some of the complexity here arises from our desire to mimic the
1339 * Thread vs. VMThread class decomposition we inherited. We've been given
1340 * a Thread, and now we need to create a VMThread and then populate both
1341 * objects. We also need to create one of our internal Thread objects.
1342 *
1343 * Pass in a stack size of 0 to get the default.
1344 */
1345bool dvmCreateInterpThread(Object* threadObj, int reqStackSize)
1346{
1347 pthread_attr_t threadAttr;
1348 pthread_t threadHandle;
1349 Thread* self;
1350 Thread* newThread = NULL;
1351 Object* vmThreadObj = NULL;
1352 int stackSize;
1353
1354 assert(threadObj != NULL);
1355
1356 if(gDvm.zygote) {
Bob Lee9dc72a32009-09-04 18:28:16 -07001357 // Allow the sampling profiler thread. We shut it down before forking.
1358 StringObject* nameStr = (StringObject*) dvmGetFieldObject(threadObj,
1359 gDvm.offJavaLangThread_name);
1360 char* threadName = dvmCreateCstrFromString(nameStr);
1361 bool profilerThread = strcmp(threadName, "SamplingProfiler") == 0;
1362 free(threadName);
1363 if (!profilerThread) {
1364 dvmThrowException("Ljava/lang/IllegalStateException;",
1365 "No new threads in -Xzygote mode");
The Android Open Source Projectf6c38712009-03-03 19:28:47 -08001366
Bob Lee9dc72a32009-09-04 18:28:16 -07001367 goto fail;
1368 }
The Android Open Source Projectf6c38712009-03-03 19:28:47 -08001369 }
1370
1371 self = dvmThreadSelf();
1372 if (reqStackSize == 0)
1373 stackSize = gDvm.stackSize;
1374 else if (reqStackSize < kMinStackSize)
1375 stackSize = kMinStackSize;
1376 else if (reqStackSize > kMaxStackSize)
1377 stackSize = kMaxStackSize;
1378 else
1379 stackSize = reqStackSize;
1380
1381 pthread_attr_init(&threadAttr);
1382 pthread_attr_setdetachstate(&threadAttr, PTHREAD_CREATE_DETACHED);
1383
1384 /*
1385 * To minimize the time spent in the critical section, we allocate the
1386 * vmThread object here.
1387 */
1388 vmThreadObj = dvmAllocObject(gDvm.classJavaLangVMThread, ALLOC_DEFAULT);
1389 if (vmThreadObj == NULL)
1390 goto fail;
1391
1392 newThread = allocThread(stackSize);
1393 if (newThread == NULL)
1394 goto fail;
1395 newThread->threadObj = threadObj;
1396
1397 assert(newThread->status == THREAD_INITIALIZING);
1398
1399 /*
1400 * We need to lock out other threads while we test and set the
1401 * "vmThread" field in java.lang.Thread, because we use that to determine
1402 * if this thread has been started before. We use the thread list lock
1403 * because it's handy and we're going to need to grab it again soon
1404 * anyway.
1405 */
1406 dvmLockThreadList(self);
1407
1408 if (dvmGetFieldObject(threadObj, gDvm.offJavaLangThread_vmThread) != NULL) {
1409 dvmUnlockThreadList();
1410 dvmThrowException("Ljava/lang/IllegalThreadStateException;",
1411 "thread has already been started");
1412 goto fail;
1413 }
1414
1415 /*
1416 * There are actually three data structures: Thread (object), VMThread
1417 * (object), and Thread (C struct). All of them point to at least one
1418 * other.
1419 *
1420 * As soon as "VMThread.vmData" is assigned, other threads can start
1421 * making calls into us (e.g. setPriority).
1422 */
1423 dvmSetFieldInt(vmThreadObj, gDvm.offJavaLangVMThread_vmData, (u4)newThread);
1424 dvmSetFieldObject(threadObj, gDvm.offJavaLangThread_vmThread, vmThreadObj);
1425
1426 /*
1427 * Thread creation might take a while, so release the lock.
1428 */
1429 dvmUnlockThreadList();
1430
Andy McFadden2aa43612009-06-17 16:29:30 -07001431 int cc, oldStatus;
1432 oldStatus = dvmChangeStatus(self, THREAD_VMWAIT);
1433 cc = pthread_create(&threadHandle, &threadAttr, interpThreadStart,
1434 newThread);
1435 oldStatus = dvmChangeStatus(self, oldStatus);
1436
1437 if (cc != 0) {
The Android Open Source Projectf6c38712009-03-03 19:28:47 -08001438 /*
1439 * Failure generally indicates that we have exceeded system
1440 * resource limits. VirtualMachineError is probably too severe,
1441 * so use OutOfMemoryError.
1442 */
1443 LOGE("Thread creation failed (err=%s)\n", strerror(errno));
1444
1445 dvmSetFieldObject(threadObj, gDvm.offJavaLangThread_vmThread, NULL);
1446
1447 dvmThrowException("Ljava/lang/OutOfMemoryError;",
1448 "thread creation failed");
1449 goto fail;
1450 }
1451
1452 /*
1453 * We need to wait for the thread to start. Otherwise, depending on
1454 * the whims of the OS scheduler, we could return and the code in our
1455 * thread could try to do operations on the new thread before it had
1456 * finished starting.
1457 *
1458 * The new thread will lock the thread list, change its state to
1459 * THREAD_STARTING, broadcast to gDvm.threadStartCond, and then sleep
1460 * on gDvm.threadStartCond (which uses the thread list lock). This
1461 * thread (the parent) will either see that the thread is already ready
1462 * after we grab the thread list lock, or will be awakened from the
1463 * condition variable on the broadcast.
1464 *
1465 * We don't want to stall the rest of the VM while the new thread
1466 * starts, which can happen if the GC wakes up at the wrong moment.
1467 * So, we change our own status to VMWAIT, and self-suspend if
1468 * necessary after we finish adding the new thread.
1469 *
1470 *
1471 * We have to deal with an odd race with the GC/debugger suspension
1472 * mechanism when creating a new thread. The information about whether
1473 * or not a thread should be suspended is contained entirely within
1474 * the Thread struct; this is usually cleaner to deal with than having
1475 * one or more globally-visible suspension flags. The trouble is that
1476 * we could create the thread while the VM is trying to suspend all
1477 * threads. The suspend-count won't be nonzero for the new thread,
1478 * so dvmChangeStatus(THREAD_RUNNING) won't cause a suspension.
1479 *
1480 * The easiest way to deal with this is to prevent the new thread from
1481 * running until the parent says it's okay. This results in the
Andy McFadden2aa43612009-06-17 16:29:30 -07001482 * following (correct) sequence of events for a "badly timed" GC
1483 * (where '-' is us, 'o' is the child, and '+' is some other thread):
The Android Open Source Projectf6c38712009-03-03 19:28:47 -08001484 *
1485 * - call pthread_create()
1486 * - lock thread list
1487 * - put self into THREAD_VMWAIT so GC doesn't wait for us
1488 * - sleep on condition var (mutex = thread list lock) until child starts
1489 * + GC triggered by another thread
1490 * + thread list locked; suspend counts updated; thread list unlocked
1491 * + loop waiting for all runnable threads to suspend
1492 * + success, start GC
1493 * o child thread wakes, signals condition var to wake parent
1494 * o child waits for parent ack on condition variable
1495 * - we wake up, locking thread list
1496 * - add child to thread list
1497 * - unlock thread list
1498 * - change our state back to THREAD_RUNNING; GC causes us to suspend
1499 * + GC finishes; all threads in thread list are resumed
1500 * - lock thread list
1501 * - set child to THREAD_VMWAIT, and signal it to start
1502 * - unlock thread list
1503 * o child resumes
1504 * o child changes state to THREAD_RUNNING
1505 *
1506 * The above shows the GC starting up during thread creation, but if
1507 * it starts anywhere after VMThread.create() is called it will
1508 * produce the same series of events.
1509 *
1510 * Once the child is in the thread list, it will be suspended and
1511 * resumed like any other thread. In the above scenario the resume-all
1512 * code will try to resume the new thread, which was never actually
1513 * suspended, and try to decrement the child's thread suspend count to -1.
1514 * We can catch this in the resume-all code.
1515 *
1516 * Bouncing back and forth between threads like this adds a small amount
1517 * of scheduler overhead to thread startup.
1518 *
1519 * One alternative to having the child wait for the parent would be
1520 * to have the child inherit the parents' suspension count. This
1521 * would work for a GC, since we can safely assume that the parent
1522 * thread didn't cause it, but we must only do so if the parent suspension
1523 * was caused by a suspend-all. If the parent was being asked to
1524 * suspend singly by the debugger, the child should not inherit the value.
1525 *
1526 * We could also have a global "new thread suspend count" that gets
1527 * picked up by new threads before changing state to THREAD_RUNNING.
1528 * This would be protected by the thread list lock and set by a
1529 * suspend-all.
1530 */
1531 dvmLockThreadList(self);
1532 assert(self->status == THREAD_RUNNING);
1533 self->status = THREAD_VMWAIT;
1534 while (newThread->status != THREAD_STARTING)
1535 pthread_cond_wait(&gDvm.threadStartCond, &gDvm.threadListLock);
1536
1537 LOG_THREAD("threadid=%d: adding to list\n", newThread->threadId);
1538 newThread->next = gDvm.threadList->next;
1539 if (newThread->next != NULL)
1540 newThread->next->prev = newThread;
1541 newThread->prev = gDvm.threadList;
1542 gDvm.threadList->next = newThread;
1543
1544 if (!dvmGetFieldBoolean(threadObj, gDvm.offJavaLangThread_daemon))
1545 gDvm.nonDaemonThreadCount++; // guarded by thread list lock
1546
1547 dvmUnlockThreadList();
1548
1549 /* change status back to RUNNING, self-suspending if necessary */
1550 dvmChangeStatus(self, THREAD_RUNNING);
1551
1552 /*
1553 * Tell the new thread to start.
1554 *
1555 * We must hold the thread list lock before messing with another thread.
1556 * In the general case we would also need to verify that newThread was
1557 * still in the thread list, but in our case the thread has not started
1558 * executing user code and therefore has not had a chance to exit.
1559 *
1560 * We move it to VMWAIT, and it then shifts itself to RUNNING, which
1561 * comes with a suspend-pending check.
1562 */
1563 dvmLockThreadList(self);
1564
1565 assert(newThread->status == THREAD_STARTING);
1566 newThread->status = THREAD_VMWAIT;
1567 pthread_cond_broadcast(&gDvm.threadStartCond);
1568
1569 dvmUnlockThreadList();
1570
1571 dvmReleaseTrackedAlloc(vmThreadObj, NULL);
1572 return true;
1573
1574fail:
1575 freeThread(newThread);
1576 dvmReleaseTrackedAlloc(vmThreadObj, NULL);
1577 return false;
1578}
1579
1580/*
1581 * pthread entry function for threads started from interpreted code.
1582 */
1583static void* interpThreadStart(void* arg)
1584{
1585 Thread* self = (Thread*) arg;
1586
1587 char *threadName = dvmGetThreadName(self);
1588 setThreadName(threadName);
1589 free(threadName);
1590
1591 /*
1592 * Finish initializing the Thread struct.
1593 */
1594 prepareThread(self);
1595
1596 LOG_THREAD("threadid=%d: created from interp\n", self->threadId);
1597
1598 /*
1599 * Change our status and wake our parent, who will add us to the
1600 * thread list and advance our state to VMWAIT.
1601 */
1602 dvmLockThreadList(self);
1603 self->status = THREAD_STARTING;
1604 pthread_cond_broadcast(&gDvm.threadStartCond);
1605
1606 /*
1607 * Wait until the parent says we can go. Assuming there wasn't a
1608 * suspend pending, this will happen immediately. When it completes,
1609 * we're full-fledged citizens of the VM.
1610 *
1611 * We have to use THREAD_VMWAIT here rather than THREAD_RUNNING
1612 * because the pthread_cond_wait below needs to reacquire a lock that
1613 * suspend-all is also interested in. If we get unlucky, the parent could
1614 * change us to THREAD_RUNNING, then a GC could start before we get
1615 * signaled, and suspend-all will grab the thread list lock and then
1616 * wait for us to suspend. We'll be in the tail end of pthread_cond_wait
1617 * trying to get the lock.
1618 */
1619 while (self->status != THREAD_VMWAIT)
1620 pthread_cond_wait(&gDvm.threadStartCond, &gDvm.threadListLock);
1621
1622 dvmUnlockThreadList();
1623
1624 /*
1625 * Add a JNI context.
1626 */
1627 self->jniEnv = dvmCreateJNIEnv(self);
1628
1629 /*
1630 * Change our state so the GC will wait for us from now on. If a GC is
1631 * in progress this call will suspend us.
1632 */
1633 dvmChangeStatus(self, THREAD_RUNNING);
1634
1635 /*
1636 * Notify the debugger & DDM. The debugger notification may cause
1637 * us to suspend ourselves (and others).
1638 */
1639 if (gDvm.debuggerConnected)
1640 dvmDbgPostThreadStart(self);
1641
1642 /*
1643 * Set the system thread priority according to the Thread object's
1644 * priority level. We don't usually need to do this, because both the
1645 * Thread object and system thread priorities inherit from parents. The
1646 * tricky case is when somebody creates a Thread object, calls
1647 * setPriority(), and then starts the thread. We could manage this with
1648 * a "needs priority update" flag to avoid the redundant call.
1649 */
Andy McFadden4879df92009-08-07 14:49:40 -07001650 int priority = dvmGetFieldInt(self->threadObj,
The Android Open Source Projectf6c38712009-03-03 19:28:47 -08001651 gDvm.offJavaLangThread_priority);
1652 dvmChangeThreadPriority(self, priority);
1653
1654 /*
1655 * Execute the "run" method.
1656 *
1657 * At this point our stack is empty, so somebody who comes looking for
1658 * stack traces right now won't have much to look at. This is normal.
1659 */
1660 Method* run = self->threadObj->clazz->vtable[gDvm.voffJavaLangThread_run];
1661 JValue unused;
1662
1663 LOGV("threadid=%d: calling run()\n", self->threadId);
1664 assert(strcmp(run->name, "run") == 0);
1665 dvmCallMethod(self, run, self->threadObj, &unused);
1666 LOGV("threadid=%d: exiting\n", self->threadId);
1667
1668 /*
1669 * Remove the thread from various lists, report its death, and free
1670 * its resources.
1671 */
1672 dvmDetachCurrentThread();
1673
1674 return NULL;
1675}
1676
1677/*
1678 * The current thread is exiting with an uncaught exception. The
1679 * Java programming language allows the application to provide a
1680 * thread-exit-uncaught-exception handler for the VM, for a specific
1681 * Thread, and for all threads in a ThreadGroup.
1682 *
1683 * Version 1.5 added the per-thread handler. We need to call
1684 * "uncaughtException" in the handler object, which is either the
1685 * ThreadGroup object or the Thread-specific handler.
1686 */
1687static void threadExitUncaughtException(Thread* self, Object* group)
1688{
1689 Object* exception;
1690 Object* handlerObj;
1691 ClassObject* throwable;
1692 Method* uncaughtHandler = NULL;
1693 InstField* threadHandler;
1694
1695 LOGW("threadid=%d: thread exiting with uncaught exception (group=%p)\n",
1696 self->threadId, group);
1697 assert(group != NULL);
1698
1699 /*
1700 * Get a pointer to the exception, then clear out the one in the
1701 * thread. We don't want to have it set when executing interpreted code.
1702 */
1703 exception = dvmGetException(self);
1704 dvmAddTrackedAlloc(exception, self);
1705 dvmClearException(self);
1706
1707 /*
1708 * Get the Thread's "uncaughtHandler" object. Use it if non-NULL;
1709 * else use "group" (which is an instance of UncaughtExceptionHandler).
1710 */
1711 threadHandler = dvmFindInstanceField(gDvm.classJavaLangThread,
1712 "uncaughtHandler", "Ljava/lang/Thread$UncaughtExceptionHandler;");
1713 if (threadHandler == NULL) {
1714 LOGW("WARNING: no 'uncaughtHandler' field in java/lang/Thread\n");
1715 goto bail;
1716 }
1717 handlerObj = dvmGetFieldObject(self->threadObj, threadHandler->byteOffset);
1718 if (handlerObj == NULL)
1719 handlerObj = group;
1720
1721 /*
1722 * Find the "uncaughtHandler" field in this object.
1723 */
1724 uncaughtHandler = dvmFindVirtualMethodHierByDescriptor(handlerObj->clazz,
1725 "uncaughtException", "(Ljava/lang/Thread;Ljava/lang/Throwable;)V");
1726
1727 if (uncaughtHandler != NULL) {
1728 //LOGI("+++ calling %s.uncaughtException\n",
1729 // handlerObj->clazz->descriptor);
1730 JValue unused;
1731 dvmCallMethod(self, uncaughtHandler, handlerObj, &unused,
1732 self->threadObj, exception);
1733 } else {
1734 /* restore it and dump a stack trace */
1735 LOGW("WARNING: no 'uncaughtException' method in class %s\n",
1736 handlerObj->clazz->descriptor);
1737 dvmSetException(self, exception);
1738 dvmLogExceptionStackTrace();
1739 }
1740
1741bail:
Bill Buzbee46cd5b62009-06-05 15:36:06 -07001742#if defined(WITH_JIT)
1743 /* Remove this thread's suspendCount from global suspendCount sum */
1744 lockThreadSuspendCount();
1745 dvmAddToThreadSuspendCount(&self->suspendCount, -self->suspendCount);
1746 unlockThreadSuspendCount();
1747#endif
The Android Open Source Projectf6c38712009-03-03 19:28:47 -08001748 dvmReleaseTrackedAlloc(exception, self);
1749}
1750
1751
1752/*
1753 * Create an internal VM thread, for things like JDWP and finalizers.
1754 *
1755 * The easiest way to do this is create a new thread and then use the
1756 * JNI AttachCurrentThread implementation.
1757 *
1758 * This does not return until after the new thread has begun executing.
1759 */
1760bool dvmCreateInternalThread(pthread_t* pHandle, const char* name,
1761 InternalThreadStart func, void* funcArg)
1762{
1763 InternalStartArgs* pArgs;
1764 Object* systemGroup;
1765 pthread_attr_t threadAttr;
1766 volatile Thread* newThread = NULL;
1767 volatile int createStatus = 0;
1768
1769 systemGroup = dvmGetSystemThreadGroup();
1770 if (systemGroup == NULL)
1771 return false;
1772
1773 pArgs = (InternalStartArgs*) malloc(sizeof(*pArgs));
1774 pArgs->func = func;
1775 pArgs->funcArg = funcArg;
1776 pArgs->name = strdup(name); // storage will be owned by new thread
1777 pArgs->group = systemGroup;
1778 pArgs->isDaemon = true;
1779 pArgs->pThread = &newThread;
1780 pArgs->pCreateStatus = &createStatus;
1781
1782 pthread_attr_init(&threadAttr);
1783 //pthread_attr_setdetachstate(&threadAttr, PTHREAD_CREATE_DETACHED);
1784
1785 if (pthread_create(pHandle, &threadAttr, internalThreadStart,
1786 pArgs) != 0)
1787 {
1788 LOGE("internal thread creation failed\n");
1789 free(pArgs->name);
1790 free(pArgs);
1791 return false;
1792 }
1793
1794 /*
1795 * Wait for the child to start. This gives us an opportunity to make
1796 * sure that the thread started correctly, and allows our caller to
1797 * assume that the thread has started running.
1798 *
1799 * Because we aren't holding a lock across the thread creation, it's
1800 * possible that the child will already have completed its
1801 * initialization. Because the child only adjusts "createStatus" while
1802 * holding the thread list lock, the initial condition on the "while"
1803 * loop will correctly avoid the wait if this occurs.
1804 *
1805 * It's also possible that we'll have to wait for the thread to finish
1806 * being created, and as part of allocating a Thread object it might
1807 * need to initiate a GC. We switch to VMWAIT while we pause.
1808 */
1809 Thread* self = dvmThreadSelf();
1810 int oldStatus = dvmChangeStatus(self, THREAD_VMWAIT);
1811 dvmLockThreadList(self);
1812 while (createStatus == 0)
1813 pthread_cond_wait(&gDvm.threadStartCond, &gDvm.threadListLock);
1814
1815 if (newThread == NULL) {
1816 LOGW("internal thread create failed (createStatus=%d)\n", createStatus);
1817 assert(createStatus < 0);
1818 /* don't free pArgs -- if pthread_create succeeded, child owns it */
1819 dvmUnlockThreadList();
1820 dvmChangeStatus(self, oldStatus);
1821 return false;
1822 }
1823
1824 /* thread could be in any state now (except early init states) */
1825 //assert(newThread->status == THREAD_RUNNING);
1826
1827 dvmUnlockThreadList();
1828 dvmChangeStatus(self, oldStatus);
1829
1830 return true;
1831}
1832
1833/*
1834 * pthread entry function for internally-created threads.
1835 *
1836 * We are expected to free "arg" and its contents. If we're a daemon
1837 * thread, and we get cancelled abruptly when the VM shuts down, the
1838 * storage won't be freed. If this becomes a concern we can make a copy
1839 * on the stack.
1840 */
1841static void* internalThreadStart(void* arg)
1842{
1843 InternalStartArgs* pArgs = (InternalStartArgs*) arg;
1844 JavaVMAttachArgs jniArgs;
1845
1846 jniArgs.version = JNI_VERSION_1_2;
1847 jniArgs.name = pArgs->name;
1848 jniArgs.group = pArgs->group;
1849
1850 setThreadName(pArgs->name);
1851
1852 /* use local jniArgs as stack top */
1853 if (dvmAttachCurrentThread(&jniArgs, pArgs->isDaemon)) {
1854 /*
1855 * Tell the parent of our success.
1856 *
1857 * threadListLock is the mutex for threadStartCond.
1858 */
1859 dvmLockThreadList(dvmThreadSelf());
1860 *pArgs->pCreateStatus = 1;
1861 *pArgs->pThread = dvmThreadSelf();
1862 pthread_cond_broadcast(&gDvm.threadStartCond);
1863 dvmUnlockThreadList();
1864
1865 LOG_THREAD("threadid=%d: internal '%s'\n",
1866 dvmThreadSelf()->threadId, pArgs->name);
1867
1868 /* execute */
1869 (*pArgs->func)(pArgs->funcArg);
1870
1871 /* detach ourselves */
1872 dvmDetachCurrentThread();
1873 } else {
1874 /*
1875 * Tell the parent of our failure. We don't have a Thread struct,
1876 * so we can't be suspended, so we don't need to enter a critical
1877 * section.
1878 */
1879 dvmLockThreadList(dvmThreadSelf());
1880 *pArgs->pCreateStatus = -1;
1881 assert(*pArgs->pThread == NULL);
1882 pthread_cond_broadcast(&gDvm.threadStartCond);
1883 dvmUnlockThreadList();
1884
1885 assert(*pArgs->pThread == NULL);
1886 }
1887
1888 free(pArgs->name);
1889 free(pArgs);
1890 return NULL;
1891}
1892
1893/*
1894 * Attach the current thread to the VM.
1895 *
1896 * Used for internally-created threads and JNI's AttachCurrentThread.
1897 */
1898bool dvmAttachCurrentThread(const JavaVMAttachArgs* pArgs, bool isDaemon)
1899{
1900 Thread* self = NULL;
1901 Object* threadObj = NULL;
1902 Object* vmThreadObj = NULL;
1903 StringObject* threadNameStr = NULL;
1904 Method* init;
1905 bool ok, ret;
1906
1907 /* establish a basic sense of self */
1908 self = allocThread(gDvm.stackSize);
1909 if (self == NULL)
1910 goto fail;
1911 setThreadSelf(self);
1912
1913 /*
1914 * Create Thread and VMThread objects. We have to use ALLOC_NO_GC
1915 * because this thread is not yet visible to the VM. We could also
1916 * just grab the GC lock earlier, but that leaves us executing
1917 * interpreted code with the lock held, which is not prudent.
1918 *
1919 * The alloc calls will block if a GC is in progress, so we don't need
1920 * to check for global suspension here.
1921 *
1922 * It's also possible for the allocation calls to *cause* a GC.
1923 */
1924 //BUG: deadlock if a GC happens here during HeapWorker creation
1925 threadObj = dvmAllocObject(gDvm.classJavaLangThread, ALLOC_NO_GC);
1926 if (threadObj == NULL)
1927 goto fail;
1928 vmThreadObj = dvmAllocObject(gDvm.classJavaLangVMThread, ALLOC_NO_GC);
1929 if (vmThreadObj == NULL)
1930 goto fail;
1931
1932 self->threadObj = threadObj;
1933 dvmSetFieldInt(vmThreadObj, gDvm.offJavaLangVMThread_vmData, (u4)self);
1934
1935 /*
1936 * Do some java.lang.Thread constructor prep before we lock stuff down.
1937 */
1938 if (pArgs->name != NULL) {
1939 threadNameStr = dvmCreateStringFromCstr(pArgs->name, ALLOC_NO_GC);
1940 if (threadNameStr == NULL) {
1941 assert(dvmCheckException(dvmThreadSelf()));
1942 goto fail;
1943 }
1944 }
1945
1946 init = dvmFindDirectMethodByDescriptor(gDvm.classJavaLangThread, "<init>",
1947 "(Ljava/lang/ThreadGroup;Ljava/lang/String;IZ)V");
1948 if (init == NULL) {
1949 assert(dvmCheckException(dvmThreadSelf()));
1950 goto fail;
1951 }
1952
1953 /*
1954 * Finish our thread prep. We need to do this before invoking any
1955 * interpreted code. prepareThread() requires that we hold the thread
1956 * list lock.
1957 */
1958 dvmLockThreadList(self);
1959 ok = prepareThread(self);
1960 dvmUnlockThreadList();
1961 if (!ok)
1962 goto fail;
1963
1964 self->jniEnv = dvmCreateJNIEnv(self);
1965 if (self->jniEnv == NULL)
1966 goto fail;
1967
1968 /*
1969 * Create a "fake" JNI frame at the top of the main thread interp stack.
1970 * It isn't really necessary for the internal threads, but it gives
1971 * the debugger something to show. It is essential for the JNI-attached
1972 * threads.
1973 */
1974 if (!createFakeRunFrame(self))
1975 goto fail;
1976
1977 /*
1978 * The native side of the thread is ready; add it to the list.
1979 */
1980 LOG_THREAD("threadid=%d: adding to list (attached)\n", self->threadId);
1981
1982 /* Start off in VMWAIT, because we may be about to block
1983 * on the heap lock, and we don't want any suspensions
1984 * to wait for us.
1985 */
1986 self->status = THREAD_VMWAIT;
1987
1988 /*
1989 * Add ourselves to the thread list. Once we finish here we are
1990 * visible to the debugger and the GC.
1991 */
1992 dvmLockThreadList(self);
1993
1994 self->next = gDvm.threadList->next;
1995 if (self->next != NULL)
1996 self->next->prev = self;
1997 self->prev = gDvm.threadList;
1998 gDvm.threadList->next = self;
1999 if (!isDaemon)
2000 gDvm.nonDaemonThreadCount++;
2001
2002 dvmUnlockThreadList();
2003
2004 /*
2005 * It's possible that a GC is currently running. Our thread
2006 * wasn't in the list when the GC started, so it's not properly
2007 * suspended in that case. Synchronize on the heap lock (held
2008 * when a GC is happening) to guarantee that any GCs from here
2009 * on will see this thread in the list.
2010 */
2011 dvmLockMutex(&gDvm.gcHeapLock);
2012 dvmUnlockMutex(&gDvm.gcHeapLock);
2013
2014 /*
2015 * Switch to the running state now that we're ready for
2016 * suspensions. This call may suspend.
2017 */
2018 dvmChangeStatus(self, THREAD_RUNNING);
2019
2020 /*
2021 * Now we're ready to run some interpreted code.
2022 *
2023 * We need to construct the Thread object and set the VMThread field.
2024 * Setting VMThread tells interpreted code that we're alive.
2025 *
2026 * Call the (group, name, priority, daemon) constructor on the Thread.
2027 * This sets the thread's name and adds it to the specified group, and
2028 * provides values for priority and daemon (which are normally inherited
2029 * from the current thread).
2030 */
2031 JValue unused;
2032 dvmCallMethod(self, init, threadObj, &unused, (Object*)pArgs->group,
2033 threadNameStr, getThreadPriorityFromSystem(), isDaemon);
2034 if (dvmCheckException(self)) {
2035 LOGE("exception thrown while constructing attached thread object\n");
2036 goto fail_unlink;
2037 }
2038 //if (isDaemon)
2039 // dvmSetFieldBoolean(threadObj, gDvm.offJavaLangThread_daemon, true);
2040
2041 /*
2042 * Set the VMThread field, which tells interpreted code that we're alive.
2043 *
2044 * The risk of a thread start collision here is very low; somebody
2045 * would have to be deliberately polling the ThreadGroup list and
2046 * trying to start threads against anything it sees, which would
2047 * generally cause problems for all thread creation. However, for
2048 * correctness we test "vmThread" before setting it.
2049 */
2050 if (dvmGetFieldObject(threadObj, gDvm.offJavaLangThread_vmThread) != NULL) {
2051 dvmThrowException("Ljava/lang/IllegalThreadStateException;",
2052 "thread has already been started");
2053 /* We don't want to free anything associated with the thread
2054 * because someone is obviously interested in it. Just let
2055 * it go and hope it will clean itself up when its finished.
2056 * This case should never happen anyway.
2057 *
2058 * Since we're letting it live, we need to finish setting it up.
2059 * We just have to let the caller know that the intended operation
2060 * has failed.
2061 *
2062 * [ This seems strange -- stepping on the vmThread object that's
2063 * already present seems like a bad idea. TODO: figure this out. ]
2064 */
2065 ret = false;
2066 } else
2067 ret = true;
2068 dvmSetFieldObject(threadObj, gDvm.offJavaLangThread_vmThread, vmThreadObj);
2069
2070 /* These are now reachable from the thread groups. */
2071 dvmClearAllocFlags(threadObj, ALLOC_NO_GC);
2072 dvmClearAllocFlags(vmThreadObj, ALLOC_NO_GC);
2073
2074 /*
2075 * The thread is ready to go; let the debugger see it.
2076 */
2077 self->threadObj = threadObj;
2078
2079 LOG_THREAD("threadid=%d: attached from native, name=%s\n",
2080 self->threadId, pArgs->name);
2081
2082 /* tell the debugger & DDM */
2083 if (gDvm.debuggerConnected)
2084 dvmDbgPostThreadStart(self);
2085
2086 return ret;
2087
2088fail_unlink:
2089 dvmLockThreadList(self);
2090 unlinkThread(self);
2091 if (!isDaemon)
2092 gDvm.nonDaemonThreadCount--;
2093 dvmUnlockThreadList();
2094 /* fall through to "fail" */
2095fail:
2096 dvmClearAllocFlags(threadObj, ALLOC_NO_GC);
2097 dvmClearAllocFlags(vmThreadObj, ALLOC_NO_GC);
2098 if (self != NULL) {
2099 if (self->jniEnv != NULL) {
2100 dvmDestroyJNIEnv(self->jniEnv);
2101 self->jniEnv = NULL;
2102 }
2103 freeThread(self);
2104 }
2105 setThreadSelf(NULL);
2106 return false;
2107}
2108
2109/*
2110 * Detach the thread from the various data structures, notify other threads
2111 * that are waiting to "join" it, and free up all heap-allocated storage.
2112 *
2113 * Used for all threads.
2114 *
2115 * When we get here the interpreted stack should be empty. The JNI 1.6 spec
2116 * requires us to enforce this for the DetachCurrentThread call, probably
2117 * because it also says that DetachCurrentThread causes all monitors
2118 * associated with the thread to be released. (Because the stack is empty,
2119 * we only have to worry about explicit JNI calls to MonitorEnter.)
2120 *
2121 * THOUGHT:
2122 * We might want to avoid freeing our internal Thread structure until the
2123 * associated Thread/VMThread objects get GCed. Our Thread is impossible to
2124 * get to once the thread shuts down, but there is a small possibility of
2125 * an operation starting in another thread before this thread halts, and
2126 * finishing much later (perhaps the thread got stalled by a weird OS bug).
2127 * We don't want something like Thread.isInterrupted() crawling through
2128 * freed storage. Can do with a Thread finalizer, or by creating a
2129 * dedicated ThreadObject class for java/lang/Thread and moving all of our
2130 * state into that.
2131 */
2132void dvmDetachCurrentThread(void)
2133{
2134 Thread* self = dvmThreadSelf();
2135 Object* vmThread;
2136 Object* group;
2137
2138 /*
2139 * Make sure we're not detaching a thread that's still running. (This
2140 * could happen with an explicit JNI detach call.)
2141 *
2142 * A thread created by interpreted code will finish with a depth of
2143 * zero, while a JNI-attached thread will have the synthetic "stack
2144 * starter" native method at the top.
2145 */
2146 int curDepth = dvmComputeExactFrameDepth(self->curFrame);
2147 if (curDepth != 0) {
2148 bool topIsNative = false;
2149
2150 if (curDepth == 1) {
2151 /* not expecting a lingering break frame; just look at curFrame */
2152 assert(!dvmIsBreakFrame(self->curFrame));
2153 StackSaveArea* ssa = SAVEAREA_FROM_FP(self->curFrame);
2154 if (dvmIsNativeMethod(ssa->method))
2155 topIsNative = true;
2156 }
2157
2158 if (!topIsNative) {
2159 LOGE("ERROR: detaching thread with interp frames (count=%d)\n",
2160 curDepth);
2161 dvmDumpThread(self, false);
2162 dvmAbort();
2163 }
2164 }
2165
2166 group = dvmGetFieldObject(self->threadObj, gDvm.offJavaLangThread_group);
2167 LOG_THREAD("threadid=%d: detach (group=%p)\n", self->threadId, group);
2168
2169 /*
2170 * Release any held monitors. Since there are no interpreted stack
2171 * frames, the only thing left are the monitors held by JNI MonitorEnter
2172 * calls.
2173 */
2174 dvmReleaseJniMonitors(self);
2175
2176 /*
2177 * Do some thread-exit uncaught exception processing if necessary.
2178 */
2179 if (dvmCheckException(self))
2180 threadExitUncaughtException(self, group);
2181
2182 /*
2183 * Remove the thread from the thread group.
2184 */
2185 if (group != NULL) {
2186 Method* removeThread =
2187 group->clazz->vtable[gDvm.voffJavaLangThreadGroup_removeThread];
2188 JValue unused;
2189 dvmCallMethod(self, removeThread, group, &unused, self->threadObj);
2190 }
2191
2192 /*
2193 * Clear the vmThread reference in the Thread object. Interpreted code
2194 * will now see that this Thread is not running. As this may be the
2195 * only reference to the VMThread object that the VM knows about, we
2196 * have to create an internal reference to it first.
2197 */
2198 vmThread = dvmGetFieldObject(self->threadObj,
2199 gDvm.offJavaLangThread_vmThread);
2200 dvmAddTrackedAlloc(vmThread, self);
2201 dvmSetFieldObject(self->threadObj, gDvm.offJavaLangThread_vmThread, NULL);
2202
2203 /* clear out our struct Thread pointer, since it's going away */
2204 dvmSetFieldObject(vmThread, gDvm.offJavaLangVMThread_vmData, NULL);
2205
2206 /*
2207 * Tell the debugger & DDM. This may cause the current thread or all
2208 * threads to suspend.
2209 *
2210 * The JDWP spec is somewhat vague about when this happens, other than
2211 * that it's issued by the dying thread, which may still appear in
2212 * an "all threads" listing.
2213 */
2214 if (gDvm.debuggerConnected)
2215 dvmDbgPostThreadDeath(self);
2216
2217 /*
2218 * Thread.join() is implemented as an Object.wait() on the VMThread
2219 * object. Signal anyone who is waiting.
2220 */
2221 dvmLockObject(self, vmThread);
2222 dvmObjectNotifyAll(self, vmThread);
2223 dvmUnlockObject(self, vmThread);
2224
2225 dvmReleaseTrackedAlloc(vmThread, self);
2226 vmThread = NULL;
2227
2228 /*
2229 * We're done manipulating objects, so it's okay if the GC runs in
2230 * parallel with us from here out. It's important to do this if
2231 * profiling is enabled, since we can wait indefinitely.
2232 */
2233 self->status = THREAD_VMWAIT;
2234
2235#ifdef WITH_PROFILER
2236 /*
2237 * If we're doing method trace profiling, we don't want threads to exit,
2238 * because if they do we'll end up reusing thread IDs. This complicates
2239 * analysis and makes it impossible to have reasonable output in the
2240 * "threads" section of the "key" file.
2241 *
2242 * We need to do this after Thread.join() completes, or other threads
2243 * could get wedged. Since self->threadObj is still valid, the Thread
2244 * object will not get GCed even though we're no longer in the ThreadGroup
2245 * list (which is important since the profiling thread needs to get
2246 * the thread's name).
2247 */
2248 MethodTraceState* traceState = &gDvm.methodTrace;
2249
2250 dvmLockMutex(&traceState->startStopLock);
2251 if (traceState->traceEnabled) {
2252 LOGI("threadid=%d: waiting for method trace to finish\n",
2253 self->threadId);
2254 while (traceState->traceEnabled) {
2255 int cc;
2256 cc = pthread_cond_wait(&traceState->threadExitCond,
2257 &traceState->startStopLock);
2258 assert(cc == 0);
2259 }
2260 }
2261 dvmUnlockMutex(&traceState->startStopLock);
2262#endif
2263
2264 dvmLockThreadList(self);
2265
2266 /*
2267 * Lose the JNI context.
2268 */
2269 dvmDestroyJNIEnv(self->jniEnv);
2270 self->jniEnv = NULL;
2271
2272 self->status = THREAD_ZOMBIE;
2273
2274 /*
2275 * Remove ourselves from the internal thread list.
2276 */
2277 unlinkThread(self);
2278
2279 /*
2280 * If we're the last one standing, signal anybody waiting in
2281 * DestroyJavaVM that it's okay to exit.
2282 */
2283 if (!dvmGetFieldBoolean(self->threadObj, gDvm.offJavaLangThread_daemon)) {
2284 gDvm.nonDaemonThreadCount--; // guarded by thread list lock
2285
2286 if (gDvm.nonDaemonThreadCount == 0) {
2287 int cc;
2288
2289 LOGV("threadid=%d: last non-daemon thread\n", self->threadId);
2290 //dvmDumpAllThreads(false);
2291 // cond var guarded by threadListLock, which we already hold
2292 cc = pthread_cond_signal(&gDvm.vmExitCond);
2293 assert(cc == 0);
2294 }
2295 }
2296
2297 LOGV("threadid=%d: bye!\n", self->threadId);
2298 releaseThreadId(self);
2299 dvmUnlockThreadList();
2300
2301 setThreadSelf(NULL);
Bob Lee9dc72a32009-09-04 18:28:16 -07002302
Bob Lee2fe146a2009-09-10 00:36:29 +02002303 dvmDetachSystemThread(self);
Bob Lee9dc72a32009-09-04 18:28:16 -07002304
The Android Open Source Projectf6c38712009-03-03 19:28:47 -08002305 freeThread(self);
2306}
2307
2308
2309/*
2310 * Suspend a single thread. Do not use to suspend yourself.
2311 *
2312 * This is used primarily for debugger/DDMS activity. Does not return
2313 * until the thread has suspended or is in a "safe" state (e.g. executing
2314 * native code outside the VM).
2315 *
2316 * The thread list lock should be held before calling here -- it's not
2317 * entirely safe to hang on to a Thread* from another thread otherwise.
2318 * (We'd need to grab it here anyway to avoid clashing with a suspend-all.)
2319 */
2320void dvmSuspendThread(Thread* thread)
2321{
2322 assert(thread != NULL);
2323 assert(thread != dvmThreadSelf());
2324 //assert(thread->handle != dvmJdwpGetDebugThread(gDvm.jdwpState));
2325
2326 lockThreadSuspendCount();
Bill Buzbee46cd5b62009-06-05 15:36:06 -07002327 dvmAddToThreadSuspendCount(&thread->suspendCount, 1);
The Android Open Source Projectf6c38712009-03-03 19:28:47 -08002328 thread->dbgSuspendCount++;
2329
2330 LOG_THREAD("threadid=%d: suspend++, now=%d\n",
2331 thread->threadId, thread->suspendCount);
2332 unlockThreadSuspendCount();
2333
2334 waitForThreadSuspend(dvmThreadSelf(), thread);
2335}
2336
2337/*
2338 * Reduce the suspend count of a thread. If it hits zero, tell it to
2339 * resume.
2340 *
2341 * Used primarily for debugger/DDMS activity. The thread in question
2342 * might have been suspended singly or as part of a suspend-all operation.
2343 *
2344 * The thread list lock should be held before calling here -- it's not
2345 * entirely safe to hang on to a Thread* from another thread otherwise.
2346 * (We'd need to grab it here anyway to avoid clashing with a suspend-all.)
2347 */
2348void dvmResumeThread(Thread* thread)
2349{
2350 assert(thread != NULL);
2351 assert(thread != dvmThreadSelf());
2352 //assert(thread->handle != dvmJdwpGetDebugThread(gDvm.jdwpState));
2353
2354 lockThreadSuspendCount();
2355 if (thread->suspendCount > 0) {
Bill Buzbee46cd5b62009-06-05 15:36:06 -07002356 dvmAddToThreadSuspendCount(&thread->suspendCount, -1);
The Android Open Source Projectf6c38712009-03-03 19:28:47 -08002357 thread->dbgSuspendCount--;
2358 } else {
2359 LOG_THREAD("threadid=%d: suspendCount already zero\n",
2360 thread->threadId);
2361 }
2362
2363 LOG_THREAD("threadid=%d: suspend--, now=%d\n",
2364 thread->threadId, thread->suspendCount);
2365
2366 if (thread->suspendCount == 0) {
2367 int cc = pthread_cond_broadcast(&gDvm.threadSuspendCountCond);
2368 assert(cc == 0);
2369 }
2370
2371 unlockThreadSuspendCount();
2372}
2373
2374/*
2375 * Suspend yourself, as a result of debugger activity.
2376 */
2377void dvmSuspendSelf(bool jdwpActivity)
2378{
2379 Thread* self = dvmThreadSelf();
2380
2381 /* debugger thread may not suspend itself due to debugger activity! */
2382 assert(gDvm.jdwpState != NULL);
2383 if (self->handle == dvmJdwpGetDebugThread(gDvm.jdwpState)) {
2384 assert(false);
2385 return;
2386 }
2387
2388 /*
2389 * Collisions with other suspends aren't really interesting. We want
2390 * to ensure that we're the only one fiddling with the suspend count
2391 * though.
2392 */
2393 lockThreadSuspendCount();
Bill Buzbee46cd5b62009-06-05 15:36:06 -07002394 dvmAddToThreadSuspendCount(&self->suspendCount, 1);
The Android Open Source Projectf6c38712009-03-03 19:28:47 -08002395 self->dbgSuspendCount++;
2396
2397 /*
2398 * Suspend ourselves.
2399 */
2400 assert(self->suspendCount > 0);
2401 self->isSuspended = true;
2402 LOG_THREAD("threadid=%d: self-suspending (dbg)\n", self->threadId);
2403
2404 /*
2405 * Tell JDWP that we've completed suspension. The JDWP thread can't
2406 * tell us to resume before we're fully asleep because we hold the
2407 * suspend count lock.
2408 *
2409 * If we got here via waitForDebugger(), don't do this part.
2410 */
2411 if (jdwpActivity) {
2412 //LOGI("threadid=%d: clearing wait-for-event (my handle=%08x)\n",
2413 // self->threadId, (int) self->handle);
2414 dvmJdwpClearWaitForEventThread(gDvm.jdwpState);
2415 }
2416
2417 while (self->suspendCount != 0) {
2418 int cc;
2419 cc = pthread_cond_wait(&gDvm.threadSuspendCountCond,
2420 &gDvm.threadSuspendCountLock);
2421 assert(cc == 0);
2422 if (self->suspendCount != 0) {
The Android Open Source Project99409882009-03-18 22:20:24 -07002423 /*
2424 * The condition was signaled but we're still suspended. This
2425 * can happen if the debugger lets go while a SIGQUIT thread
2426 * dump event is pending (assuming SignalCatcher was resumed for
2427 * just long enough to try to grab the thread-suspend lock).
2428 */
2429 LOGD("threadid=%d: still suspended after undo (sc=%d dc=%d s=%c)\n",
2430 self->threadId, self->suspendCount, self->dbgSuspendCount,
2431 self->isSuspended ? 'Y' : 'N');
The Android Open Source Projectf6c38712009-03-03 19:28:47 -08002432 }
2433 }
2434 assert(self->suspendCount == 0 && self->dbgSuspendCount == 0);
2435 self->isSuspended = false;
2436 LOG_THREAD("threadid=%d: self-reviving (dbg), status=%d\n",
2437 self->threadId, self->status);
2438
2439 unlockThreadSuspendCount();
2440}
2441
2442
2443#ifdef HAVE_GLIBC
2444# define NUM_FRAMES 20
2445# include <execinfo.h>
2446/*
2447 * glibc-only stack dump function. Requires link with "--export-dynamic".
2448 *
2449 * TODO: move this into libs/cutils and make it work for all platforms.
2450 */
2451static void printBackTrace(void)
2452{
2453 void* array[NUM_FRAMES];
2454 size_t size;
2455 char** strings;
2456 size_t i;
2457
2458 size = backtrace(array, NUM_FRAMES);
2459 strings = backtrace_symbols(array, size);
2460
2461 LOGW("Obtained %zd stack frames.\n", size);
2462
2463 for (i = 0; i < size; i++)
2464 LOGW("%s\n", strings[i]);
2465
2466 free(strings);
2467}
2468#else
2469static void printBackTrace(void) {}
2470#endif
2471
2472/*
2473 * Dump the state of the current thread and that of another thread that
2474 * we think is wedged.
2475 */
2476static void dumpWedgedThread(Thread* thread)
2477{
2478 char exePath[1024];
2479
2480 /*
2481 * The "executablepath" function in libutils is host-side only.
2482 */
2483 strcpy(exePath, "-");
2484#ifdef HAVE_GLIBC
2485 {
2486 char proc[100];
2487 sprintf(proc, "/proc/%d/exe", getpid());
2488 int len;
Jeff Hao97319a82009-08-12 16:57:15 -07002489
The Android Open Source Projectf6c38712009-03-03 19:28:47 -08002490 len = readlink(proc, exePath, sizeof(exePath)-1);
2491 exePath[len] = '\0';
2492 }
2493#endif
2494
2495 LOGW("dumping state: process %s %d\n", exePath, getpid());
2496 dvmDumpThread(dvmThreadSelf(), false);
2497 printBackTrace();
2498
2499 // dumping a running thread is risky, but could be useful
2500 dvmDumpThread(thread, true);
2501
2502
2503 // stop now and get a core dump
2504 //abort();
2505}
2506
2507
2508/*
2509 * Wait for another thread to see the pending suspension and stop running.
2510 * It can either suspend itself or go into a non-running state such as
2511 * VMWAIT or NATIVE in which it cannot interact with the GC.
2512 *
2513 * If we're running at a higher priority, sched_yield() may not do anything,
2514 * so we need to sleep for "long enough" to guarantee that the other
2515 * thread has a chance to finish what it's doing. Sleeping for too short
2516 * a period (e.g. less than the resolution of the sleep clock) might cause
2517 * the scheduler to return immediately, so we want to start with a
2518 * "reasonable" value and expand.
2519 *
2520 * This does not return until the other thread has stopped running.
2521 * Eventually we time out and the VM aborts.
2522 *
2523 * This does not try to detect the situation where two threads are
2524 * waiting for each other to suspend. In normal use this is part of a
2525 * suspend-all, which implies that the suspend-all lock is held, or as
2526 * part of a debugger action in which the JDWP thread is always the one
2527 * doing the suspending. (We may need to re-evaluate this now that
2528 * getThreadStackTrace is implemented as suspend-snapshot-resume.)
2529 *
2530 * TODO: track basic stats about time required to suspend VM.
2531 */
Bill Buzbee46cd5b62009-06-05 15:36:06 -07002532#define FIRST_SLEEP (250*1000) /* 0.25s */
2533#define MORE_SLEEP (750*1000) /* 0.75s */
The Android Open Source Projectf6c38712009-03-03 19:28:47 -08002534static void waitForThreadSuspend(Thread* self, Thread* thread)
2535{
2536 const int kMaxRetries = 10;
Bill Buzbee46cd5b62009-06-05 15:36:06 -07002537 int spinSleepTime = FIRST_SLEEP;
Andy McFadden2aa43612009-06-17 16:29:30 -07002538 bool complained = false;
Andy McFadden7ce9bd72009-08-07 11:41:35 -07002539 bool needPriorityReset = false;
2540 int savedThreadPrio = -500;
The Android Open Source Projectf6c38712009-03-03 19:28:47 -08002541
2542 int sleepIter = 0;
2543 int retryCount = 0;
2544 u8 startWhen = 0; // init req'd to placate gcc
Andy McFadden7ce9bd72009-08-07 11:41:35 -07002545 u8 firstStartWhen = 0;
The Android Open Source Projectf6c38712009-03-03 19:28:47 -08002546
2547 while (thread->status == THREAD_RUNNING && !thread->isSuspended) {
Andy McFadden7ce9bd72009-08-07 11:41:35 -07002548 if (sleepIter == 0) { // get current time on first iteration
The Android Open Source Projectf6c38712009-03-03 19:28:47 -08002549 startWhen = dvmGetRelativeTimeUsec();
Andy McFadden7ce9bd72009-08-07 11:41:35 -07002550 if (firstStartWhen == 0) // first iteration of first attempt
2551 firstStartWhen = startWhen;
2552
2553 /*
2554 * After waiting for a bit, check to see if the target thread is
2555 * running at a reduced priority. If so, bump it up temporarily
2556 * to give it more CPU time.
2557 *
2558 * getpriority() returns the "nice" value, so larger numbers
2559 * indicate lower priority.
2560 *
2561 * (Not currently changing the cgroup. Wasn't necessary in some
2562 * simple experiments.)
2563 */
2564 if (retryCount == 2) {
2565 assert(thread->systemTid != 0);
2566 errno = 0;
2567 int threadPrio = getpriority(PRIO_PROCESS, thread->systemTid);
2568 if (errno == 0 && threadPrio > 0) {
2569 const int kHigher = 0;
2570 if (setpriority(PRIO_PROCESS, thread->systemTid, kHigher) < 0)
2571 {
2572 LOGW("Couldn't raise priority on tid %d to %d\n",
2573 thread->systemTid, kHigher);
2574 } else {
2575 savedThreadPrio = threadPrio;
2576 needPriorityReset = true;
2577 LOGD("Temporarily raising priority on tid %d (%d -> %d)\n",
2578 thread->systemTid, threadPrio, kHigher);
2579 }
2580 }
2581 }
2582 }
The Android Open Source Projectf6c38712009-03-03 19:28:47 -08002583
Bill Buzbee46cd5b62009-06-05 15:36:06 -07002584#if defined (WITH_JIT)
2585 /*
2586 * If we're still waiting after the first timeout,
2587 * unchain all translations.
2588 */
2589 if (gDvmJit.pJitEntryTable && retryCount > 0) {
2590 LOGD("JIT unchain all attempt #%d",retryCount);
2591 dvmJitUnchainAll();
2592 }
2593#endif
2594
Andy McFadden7ce9bd72009-08-07 11:41:35 -07002595 /*
Andy McFadden1ede83b2009-12-02 17:03:41 -08002596 * Sleep briefly. The iterative sleep call returns false if we've
2597 * exceeded the total time limit for this round of sleeping.
Andy McFadden7ce9bd72009-08-07 11:41:35 -07002598 */
Bill Buzbee46cd5b62009-06-05 15:36:06 -07002599 if (!dvmIterativeSleep(sleepIter++, spinSleepTime, startWhen)) {
Andy McFadden1ede83b2009-12-02 17:03:41 -08002600 if (spinSleepTime != FIRST_SLEEP) {
2601 LOGW("threadid=%d: spin on suspend #%d threadid=%d (h=%d)\n",
2602 self->threadId, retryCount,
2603 thread->threadId, (int)thread->handle);
2604 dumpWedgedThread(thread);
2605 complained = true;
2606 }
The Android Open Source Projectf6c38712009-03-03 19:28:47 -08002607
2608 // keep going; could be slow due to valgrind
2609 sleepIter = 0;
Bill Buzbee46cd5b62009-06-05 15:36:06 -07002610 spinSleepTime = MORE_SLEEP;
The Android Open Source Projectf6c38712009-03-03 19:28:47 -08002611
2612 if (retryCount++ == kMaxRetries) {
2613 LOGE("threadid=%d: stuck on threadid=%d, giving up\n",
2614 self->threadId, thread->threadId);
2615 dvmDumpAllThreads(false);
2616 dvmAbort();
2617 }
2618 }
2619 }
Andy McFadden2aa43612009-06-17 16:29:30 -07002620
2621 if (complained) {
Andy McFadden7ce9bd72009-08-07 11:41:35 -07002622 LOGW("threadid=%d: spin on suspend resolved in %lld msec\n",
2623 self->threadId,
2624 (dvmGetRelativeTimeUsec() - firstStartWhen) / 1000);
Andy McFadden2aa43612009-06-17 16:29:30 -07002625 //dvmDumpThread(thread, false); /* suspended, so dump is safe */
2626 }
Andy McFadden7ce9bd72009-08-07 11:41:35 -07002627 if (needPriorityReset) {
2628 if (setpriority(PRIO_PROCESS, thread->systemTid, savedThreadPrio) < 0) {
2629 LOGW("NOTE: couldn't reset priority on thread %d to %d\n",
2630 thread->systemTid, savedThreadPrio);
2631 } else {
2632 LOGV("Restored priority on %d to %d\n",
2633 thread->systemTid, savedThreadPrio);
2634 }
2635 }
The Android Open Source Projectf6c38712009-03-03 19:28:47 -08002636}
2637
2638/*
2639 * Suspend all threads except the current one. This is used by the GC,
2640 * the debugger, and by any thread that hits a "suspend all threads"
2641 * debugger event (e.g. breakpoint or exception).
2642 *
2643 * If thread N hits a "suspend all threads" breakpoint, we don't want it
2644 * to suspend the JDWP thread. For the GC, we do, because the debugger can
2645 * create objects and even execute arbitrary code. The "why" argument
2646 * allows the caller to say why the suspension is taking place.
2647 *
2648 * This can be called when a global suspend has already happened, due to
2649 * various debugger gymnastics, so keeping an "everybody is suspended" flag
2650 * doesn't work.
2651 *
2652 * DO NOT grab any locks before calling here. We grab & release the thread
2653 * lock and suspend lock here (and we're not using recursive threads), and
2654 * we might have to self-suspend if somebody else beats us here.
2655 *
2656 * The current thread may not be attached to the VM. This can happen if
2657 * we happen to GC as the result of an allocation of a Thread object.
2658 */
2659void dvmSuspendAllThreads(SuspendCause why)
2660{
2661 Thread* self = dvmThreadSelf();
2662 Thread* thread;
2663
2664 assert(why != 0);
2665
2666 /*
2667 * Start by grabbing the thread suspend lock. If we can't get it, most
2668 * likely somebody else is in the process of performing a suspend or
2669 * resume, so lockThreadSuspend() will cause us to self-suspend.
2670 *
2671 * We keep the lock until all other threads are suspended.
2672 */
2673 lockThreadSuspend("susp-all", why);
2674
2675 LOG_THREAD("threadid=%d: SuspendAll starting\n", self->threadId);
2676
2677 /*
2678 * This is possible if the current thread was in VMWAIT mode when a
2679 * suspend-all happened, and then decided to do its own suspend-all.
2680 * This can happen when a couple of threads have simultaneous events
2681 * of interest to the debugger.
2682 */
2683 //assert(self->suspendCount == 0);
2684
2685 /*
2686 * Increment everybody's suspend count (except our own).
2687 */
2688 dvmLockThreadList(self);
2689
2690 lockThreadSuspendCount();
2691 for (thread = gDvm.threadList; thread != NULL; thread = thread->next) {
2692 if (thread == self)
2693 continue;
2694
2695 /* debugger events don't suspend JDWP thread */
2696 if ((why == SUSPEND_FOR_DEBUG || why == SUSPEND_FOR_DEBUG_EVENT) &&
2697 thread->handle == dvmJdwpGetDebugThread(gDvm.jdwpState))
2698 continue;
2699
Bill Buzbee46cd5b62009-06-05 15:36:06 -07002700 dvmAddToThreadSuspendCount(&thread->suspendCount, 1);
The Android Open Source Projectf6c38712009-03-03 19:28:47 -08002701 if (why == SUSPEND_FOR_DEBUG || why == SUSPEND_FOR_DEBUG_EVENT)
2702 thread->dbgSuspendCount++;
2703 }
2704 unlockThreadSuspendCount();
2705
2706 /*
2707 * Wait for everybody in THREAD_RUNNING state to stop. Other states
2708 * indicate the code is either running natively or sleeping quietly.
2709 * Any attempt to transition back to THREAD_RUNNING will cause a check
2710 * for suspension, so it should be impossible for anything to execute
2711 * interpreted code or modify objects (assuming native code plays nicely).
2712 *
2713 * It's also okay if the thread transitions to a non-RUNNING state.
2714 *
2715 * Note we released the threadSuspendCountLock before getting here,
2716 * so if another thread is fiddling with its suspend count (perhaps
2717 * self-suspending for the debugger) it won't block while we're waiting
2718 * in here.
2719 */
2720 for (thread = gDvm.threadList; thread != NULL; thread = thread->next) {
2721 if (thread == self)
2722 continue;
2723
2724 /* debugger events don't suspend JDWP thread */
2725 if ((why == SUSPEND_FOR_DEBUG || why == SUSPEND_FOR_DEBUG_EVENT) &&
2726 thread->handle == dvmJdwpGetDebugThread(gDvm.jdwpState))
2727 continue;
2728
2729 /* wait for the other thread to see the pending suspend */
2730 waitForThreadSuspend(self, thread);
2731
Jeff Hao97319a82009-08-12 16:57:15 -07002732 LOG_THREAD("threadid=%d: threadid=%d status=%d c=%d dc=%d isSusp=%d\n",
The Android Open Source Projectf6c38712009-03-03 19:28:47 -08002733 self->threadId,
2734 thread->threadId, thread->status, thread->suspendCount,
2735 thread->dbgSuspendCount, thread->isSuspended);
2736 }
2737
2738 dvmUnlockThreadList();
2739 unlockThreadSuspend();
2740
2741 LOG_THREAD("threadid=%d: SuspendAll complete\n", self->threadId);
2742}
2743
2744/*
2745 * Resume all threads that are currently suspended.
2746 *
2747 * The "why" must match with the previous suspend.
2748 */
2749void dvmResumeAllThreads(SuspendCause why)
2750{
2751 Thread* self = dvmThreadSelf();
2752 Thread* thread;
2753 int cc;
2754
2755 lockThreadSuspend("res-all", why); /* one suspend/resume at a time */
2756 LOG_THREAD("threadid=%d: ResumeAll starting\n", self->threadId);
2757
2758 /*
2759 * Decrement the suspend counts for all threads. No need for atomic
2760 * writes, since nobody should be moving until we decrement the count.
2761 * We do need to hold the thread list because of JNI attaches.
2762 */
2763 dvmLockThreadList(self);
2764 lockThreadSuspendCount();
2765 for (thread = gDvm.threadList; thread != NULL; thread = thread->next) {
2766 if (thread == self)
2767 continue;
2768
2769 /* debugger events don't suspend JDWP thread */
2770 if ((why == SUSPEND_FOR_DEBUG || why == SUSPEND_FOR_DEBUG_EVENT) &&
2771 thread->handle == dvmJdwpGetDebugThread(gDvm.jdwpState))
Andy McFadden2aa43612009-06-17 16:29:30 -07002772 {
The Android Open Source Projectf6c38712009-03-03 19:28:47 -08002773 continue;
Andy McFadden2aa43612009-06-17 16:29:30 -07002774 }
The Android Open Source Projectf6c38712009-03-03 19:28:47 -08002775
2776 if (thread->suspendCount > 0) {
Bill Buzbee46cd5b62009-06-05 15:36:06 -07002777 dvmAddToThreadSuspendCount(&thread->suspendCount, -1);
The Android Open Source Projectf6c38712009-03-03 19:28:47 -08002778 if (why == SUSPEND_FOR_DEBUG || why == SUSPEND_FOR_DEBUG_EVENT)
2779 thread->dbgSuspendCount--;
2780 } else {
2781 LOG_THREAD("threadid=%d: suspendCount already zero\n",
2782 thread->threadId);
2783 }
2784 }
2785 unlockThreadSuspendCount();
2786 dvmUnlockThreadList();
2787
2788 /*
Andy McFadden2aa43612009-06-17 16:29:30 -07002789 * In some ways it makes sense to continue to hold the thread-suspend
2790 * lock while we issue the wakeup broadcast. It allows us to complete
2791 * one operation before moving on to the next, which simplifies the
2792 * thread activity debug traces.
2793 *
2794 * This approach caused us some difficulty under Linux, because the
2795 * condition variable broadcast not only made the threads runnable,
2796 * but actually caused them to execute, and it was a while before
2797 * the thread performing the wakeup had an opportunity to release the
2798 * thread-suspend lock.
2799 *
2800 * This is a problem because, when a thread tries to acquire that
2801 * lock, it times out after 3 seconds. If at some point the thread
2802 * is told to suspend, the clock resets; but since the VM is still
2803 * theoretically mid-resume, there's no suspend pending. If, for
2804 * example, the GC was waking threads up while the SIGQUIT handler
2805 * was trying to acquire the lock, we would occasionally time out on
2806 * a busy system and SignalCatcher would abort.
2807 *
2808 * We now perform the unlock before the wakeup broadcast. The next
2809 * suspend can't actually start until the broadcast completes and
2810 * returns, because we're holding the thread-suspend-count lock, but the
2811 * suspending thread is now able to make progress and we avoid the abort.
2812 *
2813 * (Technically there is a narrow window between when we release
2814 * the thread-suspend lock and grab the thread-suspend-count lock.
2815 * This could cause us to send a broadcast to threads with nonzero
2816 * suspend counts, but this is expected and they'll all just fall
2817 * right back to sleep. It's probably safe to grab the suspend-count
2818 * lock before releasing thread-suspend, since we're still following
2819 * the correct order of acquisition, but it feels weird.)
2820 */
2821
2822 LOG_THREAD("threadid=%d: ResumeAll waking others\n", self->threadId);
2823 unlockThreadSuspend();
2824
2825 /*
The Android Open Source Projectf6c38712009-03-03 19:28:47 -08002826 * Broadcast a notification to all suspended threads, some or all of
2827 * which may choose to wake up. No need to wait for them.
2828 */
2829 lockThreadSuspendCount();
2830 cc = pthread_cond_broadcast(&gDvm.threadSuspendCountCond);
2831 assert(cc == 0);
2832 unlockThreadSuspendCount();
2833
The Android Open Source Projectf6c38712009-03-03 19:28:47 -08002834 LOG_THREAD("threadid=%d: ResumeAll complete\n", self->threadId);
2835}
2836
2837/*
2838 * Undo any debugger suspensions. This is called when the debugger
2839 * disconnects.
2840 */
2841void dvmUndoDebuggerSuspensions(void)
2842{
2843 Thread* self = dvmThreadSelf();
2844 Thread* thread;
2845 int cc;
2846
2847 lockThreadSuspend("undo", SUSPEND_FOR_DEBUG);
2848 LOG_THREAD("threadid=%d: UndoDebuggerSusp starting\n", self->threadId);
2849
2850 /*
2851 * Decrement the suspend counts for all threads. No need for atomic
2852 * writes, since nobody should be moving until we decrement the count.
2853 * We do need to hold the thread list because of JNI attaches.
2854 */
2855 dvmLockThreadList(self);
2856 lockThreadSuspendCount();
2857 for (thread = gDvm.threadList; thread != NULL; thread = thread->next) {
2858 if (thread == self)
2859 continue;
2860
2861 /* debugger events don't suspend JDWP thread */
2862 if (thread->handle == dvmJdwpGetDebugThread(gDvm.jdwpState)) {
2863 assert(thread->dbgSuspendCount == 0);
2864 continue;
2865 }
2866
2867 assert(thread->suspendCount >= thread->dbgSuspendCount);
Bill Buzbee46cd5b62009-06-05 15:36:06 -07002868 dvmAddToThreadSuspendCount(&thread->suspendCount,
2869 -thread->dbgSuspendCount);
The Android Open Source Projectf6c38712009-03-03 19:28:47 -08002870 thread->dbgSuspendCount = 0;
2871 }
2872 unlockThreadSuspendCount();
2873 dvmUnlockThreadList();
2874
2875 /*
2876 * Broadcast a notification to all suspended threads, some or all of
2877 * which may choose to wake up. No need to wait for them.
2878 */
2879 lockThreadSuspendCount();
2880 cc = pthread_cond_broadcast(&gDvm.threadSuspendCountCond);
2881 assert(cc == 0);
2882 unlockThreadSuspendCount();
2883
2884 unlockThreadSuspend();
2885
2886 LOG_THREAD("threadid=%d: UndoDebuggerSusp complete\n", self->threadId);
2887}
2888
2889/*
2890 * Determine if a thread is suspended.
2891 *
2892 * As with all operations on foreign threads, the caller should hold
2893 * the thread list lock before calling.
2894 */
2895bool dvmIsSuspended(Thread* thread)
2896{
2897 /*
2898 * The thread could be:
2899 * (1) Running happily. status is RUNNING, isSuspended is false,
2900 * suspendCount is zero. Return "false".
2901 * (2) Pending suspend. status is RUNNING, isSuspended is false,
2902 * suspendCount is nonzero. Return "false".
2903 * (3) Suspended. suspendCount is nonzero, and either (status is
2904 * RUNNING and isSuspended is true) OR (status is !RUNNING).
2905 * Return "true".
2906 * (4) Waking up. suspendCount is zero, status is RUNNING and
2907 * isSuspended is true. Return "false" (since it could change
2908 * out from under us, unless we hold suspendCountLock).
2909 */
2910
2911 return (thread->suspendCount != 0 &&
2912 ((thread->status == THREAD_RUNNING && thread->isSuspended) ||
2913 (thread->status != THREAD_RUNNING)));
2914}
2915
2916/*
2917 * Wait until another thread self-suspends. This is specifically for
2918 * synchronization between the JDWP thread and a thread that has decided
2919 * to suspend itself after sending an event to the debugger.
2920 *
2921 * Threads that encounter "suspend all" events work as well -- the thread
2922 * in question suspends everybody else and then itself.
2923 *
2924 * We can't hold a thread lock here or in the caller, because we could
2925 * get here just before the to-be-waited-for-thread issues a "suspend all".
2926 * There's an opportunity for badness if the thread we're waiting for exits
2927 * and gets cleaned up, but since the thread in question is processing a
2928 * debugger event, that's not really a possibility. (To avoid deadlock,
2929 * it's important that we not be in THREAD_RUNNING while we wait.)
2930 */
2931void dvmWaitForSuspend(Thread* thread)
2932{
2933 Thread* self = dvmThreadSelf();
2934
2935 LOG_THREAD("threadid=%d: waiting for threadid=%d to sleep\n",
2936 self->threadId, thread->threadId);
2937
2938 assert(thread->handle != dvmJdwpGetDebugThread(gDvm.jdwpState));
2939 assert(thread != self);
2940 assert(self->status != THREAD_RUNNING);
2941
2942 waitForThreadSuspend(self, thread);
2943
2944 LOG_THREAD("threadid=%d: threadid=%d is now asleep\n",
2945 self->threadId, thread->threadId);
2946}
2947
2948/*
2949 * Check to see if we need to suspend ourselves. If so, go to sleep on
2950 * a condition variable.
2951 *
2952 * Takes "self" as an argument as an optimization. Pass in NULL to have
2953 * it do the lookup.
2954 *
2955 * Returns "true" if we suspended ourselves.
2956 */
2957bool dvmCheckSuspendPending(Thread* self)
2958{
2959 bool didSuspend;
2960
2961 if (self == NULL)
2962 self = dvmThreadSelf();
2963
2964 /* fast path: if count is zero, bail immediately */
2965 if (self->suspendCount == 0)
2966 return false;
2967
2968 lockThreadSuspendCount(); /* grab gDvm.threadSuspendCountLock */
2969
2970 assert(self->suspendCount >= 0); /* XXX: valid? useful? */
2971
2972 didSuspend = (self->suspendCount != 0);
2973 self->isSuspended = true;
2974 LOG_THREAD("threadid=%d: self-suspending\n", self->threadId);
2975 while (self->suspendCount != 0) {
2976 /* wait for wakeup signal; releases lock */
2977 int cc;
2978 cc = pthread_cond_wait(&gDvm.threadSuspendCountCond,
2979 &gDvm.threadSuspendCountLock);
2980 assert(cc == 0);
2981 }
2982 assert(self->suspendCount == 0 && self->dbgSuspendCount == 0);
2983 self->isSuspended = false;
2984 LOG_THREAD("threadid=%d: self-reviving, status=%d\n",
2985 self->threadId, self->status);
2986
2987 unlockThreadSuspendCount();
2988
2989 return didSuspend;
2990}
2991
2992/*
2993 * Update our status.
2994 *
2995 * The "self" argument, which may be NULL, is accepted as an optimization.
2996 *
2997 * Returns the old status.
2998 */
2999ThreadStatus dvmChangeStatus(Thread* self, ThreadStatus newStatus)
3000{
3001 ThreadStatus oldStatus;
3002
3003 if (self == NULL)
3004 self = dvmThreadSelf();
3005
3006 LOGVV("threadid=%d: (status %d -> %d)\n",
3007 self->threadId, self->status, newStatus);
3008
3009 oldStatus = self->status;
3010
3011 if (newStatus == THREAD_RUNNING) {
3012 /*
3013 * Change our status to THREAD_RUNNING. The transition requires
3014 * that we check for pending suspension, because the VM considers
3015 * us to be "asleep" in all other states.
3016 *
3017 * We need to do the "suspend pending" check FIRST, because it grabs
3018 * a lock that could be held by something that wants us to suspend.
3019 * If we're in RUNNING it will wait for us, and we'll be waiting
3020 * for the lock it holds.
3021 */
3022 assert(self->status != THREAD_RUNNING);
3023
3024 dvmCheckSuspendPending(self);
3025 self->status = THREAD_RUNNING;
3026 } else {
3027 /*
3028 * Change from one state to another, neither of which is
3029 * THREAD_RUNNING. This is most common during system or thread
3030 * initialization.
3031 */
3032 self->status = newStatus;
3033 }
3034
3035 return oldStatus;
3036}
3037
3038/*
3039 * Get a statically defined thread group from a field in the ThreadGroup
3040 * Class object. Expected arguments are "mMain" and "mSystem".
3041 */
3042static Object* getStaticThreadGroup(const char* fieldName)
3043{
3044 StaticField* groupField;
3045 Object* groupObj;
3046
3047 groupField = dvmFindStaticField(gDvm.classJavaLangThreadGroup,
3048 fieldName, "Ljava/lang/ThreadGroup;");
3049 if (groupField == NULL) {
3050 LOGE("java.lang.ThreadGroup does not have an '%s' field\n", fieldName);
3051 dvmThrowException("Ljava/lang/IncompatibleClassChangeError;", NULL);
3052 return NULL;
3053 }
3054 groupObj = dvmGetStaticFieldObject(groupField);
3055 if (groupObj == NULL) {
3056 LOGE("java.lang.ThreadGroup.%s not initialized\n", fieldName);
3057 dvmThrowException("Ljava/lang/InternalError;", NULL);
3058 return NULL;
3059 }
3060
3061 return groupObj;
3062}
3063Object* dvmGetSystemThreadGroup(void)
3064{
3065 return getStaticThreadGroup("mSystem");
3066}
3067Object* dvmGetMainThreadGroup(void)
3068{
3069 return getStaticThreadGroup("mMain");
3070}
3071
3072/*
3073 * Given a VMThread object, return the associated Thread*.
3074 *
3075 * NOTE: if the thread detaches, the struct Thread will disappear, and
3076 * we will be touching invalid data. For safety, lock the thread list
3077 * before calling this.
3078 */
3079Thread* dvmGetThreadFromThreadObject(Object* vmThreadObj)
3080{
3081 int vmData;
3082
3083 vmData = dvmGetFieldInt(vmThreadObj, gDvm.offJavaLangVMThread_vmData);
Andy McFadden44860362009-08-06 17:56:14 -07003084
3085 if (false) {
3086 Thread* thread = gDvm.threadList;
3087 while (thread != NULL) {
3088 if ((Thread*)vmData == thread)
3089 break;
3090
3091 thread = thread->next;
3092 }
3093
3094 if (thread == NULL) {
3095 LOGW("WARNING: vmThreadObj=%p has thread=%p, not in thread list\n",
3096 vmThreadObj, (Thread*)vmData);
3097 vmData = 0;
3098 }
3099 }
3100
The Android Open Source Projectf6c38712009-03-03 19:28:47 -08003101 return (Thread*) vmData;
3102}
3103
3104
3105/*
3106 * Conversion map for "nice" values.
3107 *
3108 * We use Android thread priority constants to be consistent with the rest
3109 * of the system. In some cases adjacent entries may overlap.
3110 */
3111static const int kNiceValues[10] = {
3112 ANDROID_PRIORITY_LOWEST, /* 1 (MIN_PRIORITY) */
3113 ANDROID_PRIORITY_BACKGROUND + 6,
3114 ANDROID_PRIORITY_BACKGROUND + 3,
3115 ANDROID_PRIORITY_BACKGROUND,
3116 ANDROID_PRIORITY_NORMAL, /* 5 (NORM_PRIORITY) */
3117 ANDROID_PRIORITY_NORMAL - 2,
3118 ANDROID_PRIORITY_NORMAL - 4,
3119 ANDROID_PRIORITY_URGENT_DISPLAY + 3,
3120 ANDROID_PRIORITY_URGENT_DISPLAY + 2,
3121 ANDROID_PRIORITY_URGENT_DISPLAY /* 10 (MAX_PRIORITY) */
3122};
3123
3124/*
3125 * Change the priority of a system thread to match that of the Thread object.
3126 *
3127 * We map a priority value from 1-10 to Linux "nice" values, where lower
3128 * numbers indicate higher priority.
3129 */
3130void dvmChangeThreadPriority(Thread* thread, int newPriority)
3131{
3132 pid_t pid = thread->systemTid;
3133 int newNice;
3134
3135 if (newPriority < 1 || newPriority > 10) {
3136 LOGW("bad priority %d\n", newPriority);
3137 newPriority = 5;
3138 }
3139 newNice = kNiceValues[newPriority-1];
3140
Andy McFaddend62c0b52009-08-04 15:02:12 -07003141 if (newNice >= ANDROID_PRIORITY_BACKGROUND) {
San Mehat5a2056c2009-09-12 10:10:13 -07003142 set_sched_policy(dvmGetSysThreadId(), SP_BACKGROUND);
San Mehat3e371e22009-06-26 08:36:16 -07003143 } else if (getpriority(PRIO_PROCESS, pid) >= ANDROID_PRIORITY_BACKGROUND) {
San Mehat5a2056c2009-09-12 10:10:13 -07003144 set_sched_policy(dvmGetSysThreadId(), SP_FOREGROUND);
San Mehat256fc152009-04-21 14:03:06 -07003145 }
3146
The Android Open Source Projectf6c38712009-03-03 19:28:47 -08003147 if (setpriority(PRIO_PROCESS, pid, newNice) != 0) {
3148 char* str = dvmGetThreadName(thread);
3149 LOGI("setPriority(%d) '%s' to prio=%d(n=%d) failed: %s\n",
3150 pid, str, newPriority, newNice, strerror(errno));
3151 free(str);
3152 } else {
3153 LOGV("setPriority(%d) to prio=%d(n=%d)\n",
3154 pid, newPriority, newNice);
3155 }
3156}
3157
3158/*
3159 * Get the thread priority for the current thread by querying the system.
3160 * This is useful when attaching a thread through JNI.
3161 *
3162 * Returns a value from 1 to 10 (compatible with java.lang.Thread values).
3163 */
3164static int getThreadPriorityFromSystem(void)
3165{
3166 int i, sysprio, jprio;
3167
3168 errno = 0;
3169 sysprio = getpriority(PRIO_PROCESS, 0);
3170 if (sysprio == -1 && errno != 0) {
3171 LOGW("getpriority() failed: %s\n", strerror(errno));
3172 return THREAD_NORM_PRIORITY;
3173 }
3174
3175 jprio = THREAD_MIN_PRIORITY;
3176 for (i = 0; i < NELEM(kNiceValues); i++) {
3177 if (sysprio >= kNiceValues[i])
3178 break;
3179 jprio++;
3180 }
3181 if (jprio > THREAD_MAX_PRIORITY)
3182 jprio = THREAD_MAX_PRIORITY;
3183
3184 return jprio;
3185}
3186
3187
3188/*
3189 * Return true if the thread is on gDvm.threadList.
3190 * Caller should not hold gDvm.threadListLock.
3191 */
3192bool dvmIsOnThreadList(const Thread* thread)
3193{
3194 bool ret = false;
3195
3196 dvmLockThreadList(NULL);
3197 if (thread == gDvm.threadList) {
3198 ret = true;
3199 } else {
3200 ret = thread->prev != NULL || thread->next != NULL;
3201 }
3202 dvmUnlockThreadList();
3203
3204 return ret;
3205}
3206
3207/*
3208 * Dump a thread to the log file -- just calls dvmDumpThreadEx() with an
3209 * output target.
3210 */
3211void dvmDumpThread(Thread* thread, bool isRunning)
3212{
3213 DebugOutputTarget target;
3214
3215 dvmCreateLogOutputTarget(&target, ANDROID_LOG_INFO, LOG_TAG);
3216 dvmDumpThreadEx(&target, thread, isRunning);
3217}
3218
3219/*
Andy McFaddend62c0b52009-08-04 15:02:12 -07003220 * Try to get the scheduler group.
3221 *
3222 * The data from /proc/<pid>/cgroup looks like:
3223 * 2:cpu:/bg_non_interactive
3224 *
3225 * We return the part after the "/", which will be an empty string for
3226 * the default cgroup. If the string is longer than "bufLen", the string
3227 * will be truncated.
3228 */
3229static bool getSchedulerGroup(Thread* thread, char* buf, size_t bufLen)
3230{
3231#ifdef HAVE_ANDROID_OS
3232 char pathBuf[32];
3233 char readBuf[256];
3234 ssize_t count;
3235 int fd;
3236
3237 snprintf(pathBuf, sizeof(pathBuf), "/proc/%d/cgroup", thread->systemTid);
3238 if ((fd = open(pathBuf, O_RDONLY)) < 0) {
3239 LOGV("open(%s) failed: %s\n", pathBuf, strerror(errno));
3240 return false;
3241 }
3242
3243 count = read(fd, readBuf, sizeof(readBuf));
3244 if (count <= 0) {
3245 LOGV("read(%s) failed (%d): %s\n",
3246 pathBuf, (int) count, strerror(errno));
3247 close(fd);
3248 return false;
3249 }
3250 close(fd);
3251
3252 readBuf[--count] = '\0'; /* remove the '\n', now count==strlen */
3253
3254 char* cp = strchr(readBuf, '/');
3255 if (cp == NULL) {
3256 readBuf[sizeof(readBuf)-1] = '\0';
3257 LOGV("no '/' in '%s' (file=%s count=%d)\n",
3258 readBuf, pathBuf, (int) count);
3259 return false;
3260 }
3261
3262 memcpy(buf, cp+1, count); /* count-1 for cp+1, count+1 for NUL */
3263 return true;
3264#else
3265 return false;
3266#endif
3267}
3268
3269/*
The Android Open Source Projectf6c38712009-03-03 19:28:47 -08003270 * Print information about the specified thread.
3271 *
3272 * Works best when the thread in question is "self" or has been suspended.
3273 * When dumping a separate thread that's still running, set "isRunning" to
3274 * use a more cautious thread dump function.
3275 */
3276void dvmDumpThreadEx(const DebugOutputTarget* target, Thread* thread,
3277 bool isRunning)
3278{
3279 /* tied to ThreadStatus enum */
3280 static const char* kStatusNames[] = {
3281 "ZOMBIE", "RUNNABLE", "TIMED_WAIT", "MONITOR", "WAIT",
3282 "INITIALIZING", "STARTING", "NATIVE", "VMWAIT"
3283 };
3284 Object* threadObj;
3285 Object* groupObj;
3286 StringObject* nameStr;
3287 char* threadName = NULL;
3288 char* groupName = NULL;
Andy McFaddend62c0b52009-08-04 15:02:12 -07003289 char schedulerGroupBuf[32];
The Android Open Source Projectf6c38712009-03-03 19:28:47 -08003290 bool isDaemon;
3291 int priority; // java.lang.Thread priority
3292 int policy; // pthread policy
3293 struct sched_param sp; // pthread scheduling parameters
3294
3295 threadObj = thread->threadObj;
3296 if (threadObj == NULL) {
3297 LOGW("Can't dump thread %d: threadObj not set\n", thread->threadId);
3298 return;
3299 }
3300 nameStr = (StringObject*) dvmGetFieldObject(threadObj,
3301 gDvm.offJavaLangThread_name);
3302 threadName = dvmCreateCstrFromString(nameStr);
3303
3304 priority = dvmGetFieldInt(threadObj, gDvm.offJavaLangThread_priority);
3305 isDaemon = dvmGetFieldBoolean(threadObj, gDvm.offJavaLangThread_daemon);
3306
3307 if (pthread_getschedparam(pthread_self(), &policy, &sp) != 0) {
3308 LOGW("Warning: pthread_getschedparam failed\n");
3309 policy = -1;
3310 sp.sched_priority = -1;
3311 }
Andy McFaddend62c0b52009-08-04 15:02:12 -07003312 if (!getSchedulerGroup(thread, schedulerGroupBuf,sizeof(schedulerGroupBuf)))
3313 {
3314 strcpy(schedulerGroupBuf, "unknown");
3315 } else if (schedulerGroupBuf[0] == '\0') {
3316 strcpy(schedulerGroupBuf, "default");
3317 }
The Android Open Source Projectf6c38712009-03-03 19:28:47 -08003318
3319 /* a null value for group is not expected, but deal with it anyway */
3320 groupObj = (Object*) dvmGetFieldObject(threadObj,
3321 gDvm.offJavaLangThread_group);
3322 if (groupObj != NULL) {
3323 int offset = dvmFindFieldOffset(gDvm.classJavaLangThreadGroup,
3324 "name", "Ljava/lang/String;");
3325 if (offset < 0) {
3326 LOGW("Unable to find 'name' field in ThreadGroup\n");
3327 } else {
3328 nameStr = (StringObject*) dvmGetFieldObject(groupObj, offset);
3329 groupName = dvmCreateCstrFromString(nameStr);
3330 }
3331 }
3332 if (groupName == NULL)
3333 groupName = strdup("(BOGUS GROUP)");
3334
3335 assert(thread->status < NELEM(kStatusNames));
3336 dvmPrintDebugMessage(target,
3337 "\"%s\"%s prio=%d tid=%d %s\n",
3338 threadName, isDaemon ? " daemon" : "",
3339 priority, thread->threadId, kStatusNames[thread->status]);
3340 dvmPrintDebugMessage(target,
Andy McFadden2aa43612009-06-17 16:29:30 -07003341 " | group=\"%s\" sCount=%d dsCount=%d s=%c obj=%p self=%p\n",
The Android Open Source Projectf6c38712009-03-03 19:28:47 -08003342 groupName, thread->suspendCount, thread->dbgSuspendCount,
Andy McFadden2aa43612009-06-17 16:29:30 -07003343 thread->isSuspended ? 'Y' : 'N', thread->threadObj, thread);
The Android Open Source Projectf6c38712009-03-03 19:28:47 -08003344 dvmPrintDebugMessage(target,
Andy McFaddend62c0b52009-08-04 15:02:12 -07003345 " | sysTid=%d nice=%d sched=%d/%d cgrp=%s handle=%d\n",
The Android Open Source Projectf6c38712009-03-03 19:28:47 -08003346 thread->systemTid, getpriority(PRIO_PROCESS, thread->systemTid),
Andy McFaddend62c0b52009-08-04 15:02:12 -07003347 policy, sp.sched_priority, schedulerGroupBuf, (int)thread->handle);
The Android Open Source Projectf6c38712009-03-03 19:28:47 -08003348
3349#ifdef WITH_MONITOR_TRACKING
3350 if (!isRunning) {
3351 LockedObjectData* lod = thread->pLockedObjects;
3352 if (lod != NULL)
3353 dvmPrintDebugMessage(target, " | monitors held:\n");
3354 else
3355 dvmPrintDebugMessage(target, " | monitors held: <none>\n");
3356 while (lod != NULL) {
Elliott Hughesbeea0b72009-11-13 11:20:15 -08003357 Object* obj = lod->obj;
3358 if (obj->clazz == gDvm.classJavaLangClass) {
3359 ClassObject* clazz = (ClassObject*) obj;
3360 dvmPrintDebugMessage(target, " > %p[%d] (%s object for class %s)\n",
3361 obj, lod->recursionCount, obj->clazz->descriptor,
3362 clazz->descriptor);
3363 } else {
3364 dvmPrintDebugMessage(target, " > %p[%d] (%s)\n",
3365 obj, lod->recursionCount, obj->clazz->descriptor);
3366 }
The Android Open Source Projectf6c38712009-03-03 19:28:47 -08003367 lod = lod->next;
3368 }
3369 }
3370#endif
3371
3372 if (isRunning)
3373 dvmDumpRunningThreadStack(target, thread);
3374 else
3375 dvmDumpThreadStack(target, thread);
3376
3377 free(threadName);
3378 free(groupName);
3379
3380}
3381
3382/*
3383 * Get the name of a thread.
3384 *
3385 * For correctness, the caller should hold the thread list lock to ensure
3386 * that the thread doesn't go away mid-call.
3387 *
3388 * Returns a newly-allocated string, or NULL if the Thread doesn't have a name.
3389 */
3390char* dvmGetThreadName(Thread* thread)
3391{
3392 StringObject* nameObj;
3393
3394 if (thread->threadObj == NULL) {
3395 LOGW("threadObj is NULL, name not available\n");
3396 return strdup("-unknown-");
3397 }
3398
3399 nameObj = (StringObject*)
3400 dvmGetFieldObject(thread->threadObj, gDvm.offJavaLangThread_name);
3401 return dvmCreateCstrFromString(nameObj);
3402}
3403
3404/*
3405 * Dump all threads to the log file -- just calls dvmDumpAllThreadsEx() with
3406 * an output target.
3407 */
3408void dvmDumpAllThreads(bool grabLock)
3409{
3410 DebugOutputTarget target;
3411
3412 dvmCreateLogOutputTarget(&target, ANDROID_LOG_INFO, LOG_TAG);
3413 dvmDumpAllThreadsEx(&target, grabLock);
3414}
3415
3416/*
3417 * Print information about all known threads. Assumes they have been
3418 * suspended (or are in a non-interpreting state, e.g. WAIT or NATIVE).
3419 *
3420 * If "grabLock" is true, we grab the thread lock list. This is important
3421 * to do unless the caller already holds the lock.
3422 */
3423void dvmDumpAllThreadsEx(const DebugOutputTarget* target, bool grabLock)
3424{
3425 Thread* thread;
3426
3427 dvmPrintDebugMessage(target, "DALVIK THREADS:\n");
3428
3429 if (grabLock)
3430 dvmLockThreadList(dvmThreadSelf());
3431
3432 thread = gDvm.threadList;
3433 while (thread != NULL) {
3434 dvmDumpThreadEx(target, thread, false);
3435
3436 /* verify link */
3437 assert(thread->next == NULL || thread->next->prev == thread);
3438
3439 thread = thread->next;
3440 }
3441
3442 if (grabLock)
3443 dvmUnlockThreadList();
3444}
3445
3446#ifdef WITH_MONITOR_TRACKING
3447/*
3448 * Count up the #of locked objects in the current thread.
3449 */
3450static int getThreadObjectCount(const Thread* self)
3451{
3452 LockedObjectData* lod;
3453 int count = 0;
3454
3455 lod = self->pLockedObjects;
3456 while (lod != NULL) {
3457 count++;
3458 lod = lod->next;
3459 }
3460 return count;
3461}
3462
3463/*
3464 * Add the object to the thread's locked object list if it doesn't already
3465 * exist. The most recently added object is the most likely to be released
3466 * next, so we insert at the head of the list.
3467 *
3468 * If it already exists, we increase the recursive lock count.
3469 *
3470 * The object's lock may be thin or fat.
3471 */
3472void dvmAddToMonitorList(Thread* self, Object* obj, bool withTrace)
3473{
3474 LockedObjectData* newLod;
3475 LockedObjectData* lod;
3476 int* trace;
3477 int depth;
3478
3479 lod = self->pLockedObjects;
3480 while (lod != NULL) {
3481 if (lod->obj == obj) {
3482 lod->recursionCount++;
3483 LOGV("+++ +recursive lock %p -> %d\n", obj, lod->recursionCount);
3484 return;
3485 }
3486 lod = lod->next;
3487 }
3488
3489 newLod = (LockedObjectData*) calloc(1, sizeof(LockedObjectData));
3490 if (newLod == NULL) {
3491 LOGE("malloc failed on %d bytes\n", sizeof(LockedObjectData));
3492 return;
3493 }
3494 newLod->obj = obj;
3495 newLod->recursionCount = 0;
3496
3497 if (withTrace) {
3498 trace = dvmFillInStackTraceRaw(self, &depth);
3499 newLod->rawStackTrace = trace;
3500 newLod->stackDepth = depth;
3501 }
3502
3503 newLod->next = self->pLockedObjects;
3504 self->pLockedObjects = newLod;
3505
3506 LOGV("+++ threadid=%d: added %p, now %d\n",
3507 self->threadId, newLod, getThreadObjectCount(self));
3508}
3509
3510/*
3511 * Remove the object from the thread's locked object list. If the entry
3512 * has a nonzero recursion count, we just decrement the count instead.
3513 */
3514void dvmRemoveFromMonitorList(Thread* self, Object* obj)
3515{
3516 LockedObjectData* lod;
3517 LockedObjectData* prevLod;
3518
3519 lod = self->pLockedObjects;
3520 prevLod = NULL;
3521 while (lod != NULL) {
3522 if (lod->obj == obj) {
3523 if (lod->recursionCount > 0) {
3524 lod->recursionCount--;
3525 LOGV("+++ -recursive lock %p -> %d\n",
3526 obj, lod->recursionCount);
3527 return;
3528 } else {
3529 break;
3530 }
3531 }
3532 prevLod = lod;
3533 lod = lod->next;
3534 }
3535
3536 if (lod == NULL) {
3537 LOGW("BUG: object %p not found in thread's lock list\n", obj);
3538 return;
3539 }
3540 if (prevLod == NULL) {
3541 /* first item in list */
3542 assert(self->pLockedObjects == lod);
3543 self->pLockedObjects = lod->next;
3544 } else {
3545 /* middle/end of list */
3546 prevLod->next = lod->next;
3547 }
3548
3549 LOGV("+++ threadid=%d: removed %p, now %d\n",
3550 self->threadId, lod, getThreadObjectCount(self));
3551 free(lod->rawStackTrace);
3552 free(lod);
3553}
3554
3555/*
3556 * If the specified object is already in the thread's locked object list,
3557 * return the LockedObjectData struct. Otherwise return NULL.
3558 */
3559LockedObjectData* dvmFindInMonitorList(const Thread* self, const Object* obj)
3560{
3561 LockedObjectData* lod;
3562
3563 lod = self->pLockedObjects;
3564 while (lod != NULL) {
3565 if (lod->obj == obj)
3566 return lod;
3567 lod = lod->next;
3568 }
3569 return NULL;
3570}
3571#endif /*WITH_MONITOR_TRACKING*/
3572
3573
3574/*
3575 * GC helper functions
3576 */
3577
The Android Open Source Project99409882009-03-18 22:20:24 -07003578/*
3579 * Add the contents of the registers from the interpreted call stack.
3580 */
The Android Open Source Projectf6c38712009-03-03 19:28:47 -08003581static void gcScanInterpStackReferences(Thread *thread)
3582{
3583 const u4 *framePtr;
The Android Open Source Project99409882009-03-18 22:20:24 -07003584#if WITH_EXTRA_GC_CHECKS > 1
3585 bool first = true;
3586#endif
The Android Open Source Projectf6c38712009-03-03 19:28:47 -08003587
3588 framePtr = (const u4 *)thread->curFrame;
3589 while (framePtr != NULL) {
3590 const StackSaveArea *saveArea;
3591 const Method *method;
3592
3593 saveArea = SAVEAREA_FROM_FP(framePtr);
3594 method = saveArea->method;
The Android Open Source Project99409882009-03-18 22:20:24 -07003595 if (method != NULL && !dvmIsNativeMethod(method)) {
The Android Open Source Projectf6c38712009-03-03 19:28:47 -08003596#ifdef COUNT_PRECISE_METHODS
3597 /* the GC is running, so no lock required */
The Android Open Source Project99409882009-03-18 22:20:24 -07003598 if (dvmPointerSetAddEntry(gDvm.preciseMethods, method))
3599 LOGI("PGC: added %s.%s %p\n",
3600 method->clazz->descriptor, method->name, method);
The Android Open Source Projectf6c38712009-03-03 19:28:47 -08003601#endif
The Android Open Source Project99409882009-03-18 22:20:24 -07003602#if WITH_EXTRA_GC_CHECKS > 1
3603 /*
3604 * May also want to enable the memset() in the "invokeMethod"
3605 * goto target in the portable interpreter. That sets the stack
3606 * to a pattern that makes referring to uninitialized data
3607 * very obvious.
3608 */
3609
3610 if (first) {
3611 /*
3612 * First frame, isn't native, check the "alternate" saved PC
3613 * as a sanity check.
3614 *
3615 * It seems like we could check the second frame if the first
3616 * is native, since the PCs should be the same. It turns out
3617 * this doesn't always work. The problem is that we could
3618 * have calls in the sequence:
3619 * interp method #2
3620 * native method
3621 * interp method #1
3622 *
3623 * and then GC while in the native method after returning
3624 * from interp method #2. The currentPc on the stack is
3625 * for interp method #1, but thread->currentPc2 is still
3626 * set for the last thing interp method #2 did.
3627 *
3628 * This can also happen in normal execution:
3629 * - sget-object on not-yet-loaded class
3630 * - class init updates currentPc2
3631 * - static field init is handled by parsing annotations;
3632 * static String init requires creation of a String object,
3633 * which can cause a GC
3634 *
3635 * Essentially, any pattern that involves executing
3636 * interpreted code and then causes an allocation without
3637 * executing instructions in the original method will hit
3638 * this. These are rare enough that the test still has
3639 * some value.
3640 */
3641 if (saveArea->xtra.currentPc != thread->currentPc2) {
3642 LOGW("PGC: savedPC(%p) != current PC(%p), %s.%s ins=%p\n",
3643 saveArea->xtra.currentPc, thread->currentPc2,
3644 method->clazz->descriptor, method->name, method->insns);
3645 if (saveArea->xtra.currentPc != NULL)
3646 LOGE(" pc inst = 0x%04x\n", *saveArea->xtra.currentPc);
3647 if (thread->currentPc2 != NULL)
3648 LOGE(" pc2 inst = 0x%04x\n", *thread->currentPc2);
3649 dvmDumpThread(thread, false);
The Android Open Source Projectf6c38712009-03-03 19:28:47 -08003650 }
The Android Open Source Project99409882009-03-18 22:20:24 -07003651 } else {
3652 /*
3653 * It's unusual, but not impossible, for a non-first frame
3654 * to be at something other than a method invocation. For
3655 * example, if we do a new-instance on a nonexistent class,
3656 * we'll have a lot of class loader activity on the stack
3657 * above the frame with the "new" operation. Could also
3658 * happen while we initialize a Throwable when an instruction
3659 * fails.
3660 *
3661 * So there's not much we can do here to verify the PC,
3662 * except to verify that it's a GC point.
3663 */
3664 }
3665 assert(saveArea->xtra.currentPc != NULL);
3666#endif
3667
3668 const RegisterMap* pMap;
3669 const u1* regVector;
3670 int i;
3671
Andy McFaddencf8b55c2009-04-13 15:26:03 -07003672 Method* nonConstMethod = (Method*) method; // quiet gcc
3673 pMap = dvmGetExpandedRegisterMap(nonConstMethod);
The Android Open Source Project99409882009-03-18 22:20:24 -07003674 if (pMap != NULL) {
3675 /* found map, get registers for this address */
3676 int addr = saveArea->xtra.currentPc - method->insns;
Andy McFaddend45a8872009-03-24 20:41:52 -07003677 regVector = dvmRegisterMapGetLine(pMap, addr);
The Android Open Source Project99409882009-03-18 22:20:24 -07003678 if (regVector == NULL) {
3679 LOGW("PGC: map but no entry for %s.%s addr=0x%04x\n",
3680 method->clazz->descriptor, method->name, addr);
3681 } else {
3682 LOGV("PGC: found map for %s.%s 0x%04x (t=%d)\n",
3683 method->clazz->descriptor, method->name, addr,
3684 thread->threadId);
3685 }
3686 } else {
3687 /*
3688 * No map found. If precise GC is disabled this is
3689 * expected -- we don't create pointers to the map data even
3690 * if it's present -- but if it's enabled it means we're
3691 * unexpectedly falling back on a conservative scan, so it's
3692 * worth yelling a little.
The Android Open Source Project99409882009-03-18 22:20:24 -07003693 */
3694 if (gDvm.preciseGc) {
Andy McFaddena66a01a2009-08-18 15:11:35 -07003695 LOGVV("PGC: no map for %s.%s\n",
The Android Open Source Project99409882009-03-18 22:20:24 -07003696 method->clazz->descriptor, method->name);
3697 }
3698 regVector = NULL;
3699 }
3700
3701 if (regVector == NULL) {
3702 /* conservative scan */
3703 for (i = method->registersSize - 1; i >= 0; i--) {
3704 u4 rval = *framePtr++;
3705 if (rval != 0 && (rval & 0x3) == 0) {
3706 dvmMarkIfObject((Object *)rval);
3707 }
3708 }
3709 } else {
3710 /*
3711 * Precise scan. v0 is at the lowest address on the
3712 * interpreted stack, and is the first bit in the register
3713 * vector, so we can walk through the register map and
3714 * memory in the same direction.
3715 *
3716 * A '1' bit indicates a live reference.
3717 */
3718 u2 bits = 1 << 1;
3719 for (i = method->registersSize - 1; i >= 0; i--) {
3720 u4 rval = *framePtr++;
3721
3722 bits >>= 1;
3723 if (bits == 1) {
3724 /* set bit 9 so we can tell when we're empty */
3725 bits = *regVector++ | 0x0100;
3726 LOGVV("loaded bits: 0x%02x\n", bits & 0xff);
3727 }
3728
3729 if (rval != 0 && (bits & 0x01) != 0) {
3730 /*
3731 * Non-null, register marked as live reference. This
3732 * should always be a valid object.
3733 */
3734#if WITH_EXTRA_GC_CHECKS > 0
3735 if ((rval & 0x3) != 0 ||
3736 !dvmIsValidObject((Object*) rval))
3737 {
3738 /* this is very bad */
3739 LOGE("PGC: invalid ref in reg %d: 0x%08x\n",
3740 method->registersSize-1 - i, rval);
3741 } else
3742#endif
3743 {
3744 dvmMarkObjectNonNull((Object *)rval);
3745 }
3746 } else {
3747 /*
3748 * Null or non-reference, do nothing at all.
3749 */
3750#if WITH_EXTRA_GC_CHECKS > 1
3751 if (dvmIsValidObject((Object*) rval)) {
3752 /* this is normal, but we feel chatty */
3753 LOGD("PGC: ignoring valid ref in reg %d: 0x%08x\n",
3754 method->registersSize-1 - i, rval);
3755 }
3756#endif
3757 }
3758 }
3759 dvmReleaseRegisterMapLine(pMap, regVector);
The Android Open Source Projectf6c38712009-03-03 19:28:47 -08003760 }
3761 }
The Android Open Source Project99409882009-03-18 22:20:24 -07003762 /* else this is a break frame and there is nothing to mark, or
3763 * this is a native method and the registers are just the "ins",
3764 * copied from various registers in the caller's set.
The Android Open Source Projectf6c38712009-03-03 19:28:47 -08003765 */
3766
The Android Open Source Project99409882009-03-18 22:20:24 -07003767#if WITH_EXTRA_GC_CHECKS > 1
3768 first = false;
3769#endif
3770
The Android Open Source Projectf6c38712009-03-03 19:28:47 -08003771 /* Don't fall into an infinite loop if things get corrupted.
3772 */
3773 assert((uintptr_t)saveArea->prevFrame > (uintptr_t)framePtr ||
3774 saveArea->prevFrame == NULL);
3775 framePtr = saveArea->prevFrame;
3776 }
3777}
3778
3779static void gcScanReferenceTable(ReferenceTable *refTable)
3780{
3781 Object **op;
3782
3783 //TODO: these asserts are overkill; turn them off when things stablize.
3784 assert(refTable != NULL);
3785 assert(refTable->table != NULL);
3786 assert(refTable->nextEntry != NULL);
3787 assert((uintptr_t)refTable->nextEntry >= (uintptr_t)refTable->table);
3788 assert(refTable->nextEntry - refTable->table <= refTable->maxEntries);
3789
3790 op = refTable->table;
3791 while ((uintptr_t)op < (uintptr_t)refTable->nextEntry) {
3792 dvmMarkObjectNonNull(*(op++));
3793 }
3794}
3795
Andy McFaddend5ab7262009-08-25 07:19:34 -07003796static void gcScanIndirectRefTable(IndirectRefTable* pRefTable)
3797{
3798 Object** op = pRefTable->table;
3799 int numEntries = dvmIndirectRefTableEntries(pRefTable);
3800 int i;
3801
3802 for (i = 0; i < numEntries; i++) {
3803 Object* obj = *op;
3804 if (obj != NULL)
3805 dvmMarkObjectNonNull(obj);
3806 op++;
3807 }
3808}
3809
The Android Open Source Projectf6c38712009-03-03 19:28:47 -08003810/*
3811 * Scan a Thread and mark any objects it references.
3812 */
3813static void gcScanThread(Thread *thread)
3814{
3815 assert(thread != NULL);
3816
3817 /*
3818 * The target thread must be suspended or in a state where it can't do
3819 * any harm (e.g. in Object.wait()). The only exception is the current
3820 * thread, which will still be active and in the "running" state.
3821 *
3822 * (Newly-created threads shouldn't be able to shift themselves to
3823 * RUNNING without a suspend-pending check, so this shouldn't cause
3824 * a false-positive.)
3825 */
Andy McFaddend40223e2009-12-07 15:35:51 -08003826 if (thread->status == THREAD_RUNNING && !thread->isSuspended &&
3827 thread != dvmThreadSelf())
3828 {
3829 Thread* self = dvmThreadSelf();
3830 LOGW("threadid=%d: BUG: GC scanning a running thread (%d)\n",
3831 self->threadId, thread->threadId);
3832 dvmDumpThread(thread, true);
3833 LOGW("Found by:\n");
3834 dvmDumpThread(self, false);
3835
3836 /* continue anyway? */
3837 dvmAbort();
3838 }
The Android Open Source Projectf6c38712009-03-03 19:28:47 -08003839
3840 HPROF_SET_GC_SCAN_STATE(HPROF_ROOT_THREAD_OBJECT, thread->threadId);
3841
3842 dvmMarkObject(thread->threadObj); // could be NULL, when constructing
3843
3844 HPROF_SET_GC_SCAN_STATE(HPROF_ROOT_NATIVE_STACK, thread->threadId);
3845
3846 dvmMarkObject(thread->exception); // usually NULL
3847 gcScanReferenceTable(&thread->internalLocalRefTable);
3848
3849 HPROF_SET_GC_SCAN_STATE(HPROF_ROOT_JNI_LOCAL, thread->threadId);
3850
Andy McFaddend5ab7262009-08-25 07:19:34 -07003851#ifdef USE_INDIRECT_REF
3852 gcScanIndirectRefTable(&thread->jniLocalRefTable);
3853#else
The Android Open Source Projectf6c38712009-03-03 19:28:47 -08003854 gcScanReferenceTable(&thread->jniLocalRefTable);
Andy McFaddend5ab7262009-08-25 07:19:34 -07003855#endif
The Android Open Source Projectf6c38712009-03-03 19:28:47 -08003856
3857 if (thread->jniMonitorRefTable.table != NULL) {
3858 HPROF_SET_GC_SCAN_STATE(HPROF_ROOT_JNI_MONITOR, thread->threadId);
3859
3860 gcScanReferenceTable(&thread->jniMonitorRefTable);
3861 }
3862
3863 HPROF_SET_GC_SCAN_STATE(HPROF_ROOT_JAVA_FRAME, thread->threadId);
3864
3865 gcScanInterpStackReferences(thread);
3866
3867 HPROF_CLEAR_GC_SCAN_STATE();
3868}
3869
3870static void gcScanAllThreads()
3871{
3872 Thread *thread;
3873
3874 /* Lock the thread list so we can safely use the
3875 * next/prev pointers.
3876 */
3877 dvmLockThreadList(dvmThreadSelf());
3878
3879 for (thread = gDvm.threadList; thread != NULL;
3880 thread = thread->next)
3881 {
3882 /* We need to scan our own stack, so don't special-case
3883 * the current thread.
3884 */
3885 gcScanThread(thread);
3886 }
3887
3888 dvmUnlockThreadList();
3889}
3890
3891void dvmGcScanRootThreadGroups()
3892{
3893 /* We scan the VM's list of threads instead of going
3894 * through the actual ThreadGroups, but it should be
3895 * equivalent.
3896 *
Jeff Hao97319a82009-08-12 16:57:15 -07003897 * This assumes that the ThreadGroup class object is in
The Android Open Source Projectf6c38712009-03-03 19:28:47 -08003898 * the root set, which should always be true; it's
3899 * loaded by the built-in class loader, which is part
3900 * of the root set.
3901 */
3902 gcScanAllThreads();
3903}