blob: 6d5067b5145c1d840a74ea9d70839431d40caabb [file] [log] [blame]
The Android Open Source Projectcbb10112009-03-03 19:31:44 -08001/*
2 * Copyright (C) 2007 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 */
16
The Android Open Source Project7a4c8392009-03-05 14:34:35 -080017// #define LOG_NDEBUG 0
The Android Open Source Projectcbb10112009-03-03 19:31:44 -080018#define LOG_TAG "libutils.threads"
19
20#include <utils/threads.h>
21#include <utils/Log.h>
22
Dianne Hackborn235af972009-12-07 17:59:37 -080023#include <cutils/sched_policy.h>
Dianne Hackborn16d217e2010-09-03 17:07:07 -070024#include <cutils/properties.h>
Dianne Hackborn235af972009-12-07 17:59:37 -080025
The Android Open Source Projectcbb10112009-03-03 19:31:44 -080026#include <stdio.h>
27#include <stdlib.h>
28#include <memory.h>
29#include <errno.h>
30#include <assert.h>
31#include <unistd.h>
32
33#if defined(HAVE_PTHREADS)
34# include <pthread.h>
35# include <sched.h>
36# include <sys/resource.h>
37#elif defined(HAVE_WIN32_THREADS)
38# include <windows.h>
39# include <stdint.h>
40# include <process.h>
41# define HAVE_CREATETHREAD // Cygwin, vs. HAVE__BEGINTHREADEX for MinGW
42#endif
43
The Android Open Source Projectcbb10112009-03-03 19:31:44 -080044#if defined(HAVE_PRCTL)
45#include <sys/prctl.h>
46#endif
47
48/*
49 * ===========================================================================
50 * Thread wrappers
51 * ===========================================================================
52 */
53
54using namespace android;
55
56// ----------------------------------------------------------------------------
57#if defined(HAVE_PTHREADS)
The Android Open Source Projectcbb10112009-03-03 19:31:44 -080058// ----------------------------------------------------------------------------
59
60/*
Dianne Hackborn16d217e2010-09-03 17:07:07 -070061 * Create and run a new thread.
The Android Open Source Projectcbb10112009-03-03 19:31:44 -080062 *
63 * We create it "detached", so it cleans up after itself.
64 */
65
66typedef void* (*android_pthread_entry)(void*);
67
Dianne Hackborna78bab02010-09-09 15:50:18 -070068static pthread_once_t gDoSchedulingGroupOnce = PTHREAD_ONCE_INIT;
69static bool gDoSchedulingGroup = true;
70
71static void checkDoSchedulingGroup(void) {
72 char buf[PROPERTY_VALUE_MAX];
73 int len = property_get("debug.sys.noschedgroups", buf, "");
74 if (len > 0) {
75 int temp;
76 if (sscanf(buf, "%d", &temp) == 1) {
77 gDoSchedulingGroup = temp == 0;
78 }
79 }
80}
81
The Android Open Source Projectcbb10112009-03-03 19:31:44 -080082struct thread_data_t {
83 thread_func_t entryFunction;
84 void* userData;
85 int priority;
86 char * threadName;
87
88 // we use this trampoline when we need to set the priority with
89 // nice/setpriority.
90 static int trampoline(const thread_data_t* t) {
91 thread_func_t f = t->entryFunction;
92 void* u = t->userData;
93 int prio = t->priority;
94 char * name = t->threadName;
95 delete t;
96 setpriority(PRIO_PROCESS, 0, prio);
Dianne Hackborna78bab02010-09-09 15:50:18 -070097 pthread_once(&gDoSchedulingGroupOnce, checkDoSchedulingGroup);
98 if (gDoSchedulingGroup) {
99 if (prio >= ANDROID_PRIORITY_BACKGROUND) {
100 set_sched_policy(androidGetTid(), SP_BACKGROUND);
101 } else {
102 set_sched_policy(androidGetTid(), SP_FOREGROUND);
103 }
104 }
105
The Android Open Source Projectcbb10112009-03-03 19:31:44 -0800106 if (name) {
107#if defined(HAVE_PRCTL)
108 // Mac OS doesn't have this, and we build libutil for the host too
109 int hasAt = 0;
110 int hasDot = 0;
111 char *s = name;
112 while (*s) {
113 if (*s == '.') hasDot = 1;
114 else if (*s == '@') hasAt = 1;
115 s++;
116 }
117 int len = s - name;
118 if (len < 15 || hasAt || !hasDot) {
119 s = name;
120 } else {
121 s = name + len - 15;
122 }
123 prctl(PR_SET_NAME, (unsigned long) s, 0, 0, 0);
124#endif
125 free(name);
126 }
127 return f(u);
128 }
129};
130
131int androidCreateRawThreadEtc(android_thread_func_t entryFunction,
132 void *userData,
133 const char* threadName,
134 int32_t threadPriority,
135 size_t threadStackSize,
136 android_thread_id_t *threadId)
137{
138 pthread_attr_t attr;
139 pthread_attr_init(&attr);
140 pthread_attr_setdetachstate(&attr, PTHREAD_CREATE_DETACHED);
141
142#ifdef HAVE_ANDROID_OS /* valgrind is rejecting RT-priority create reqs */
143 if (threadPriority != PRIORITY_DEFAULT || threadName != NULL) {
144 // We could avoid the trampoline if there was a way to get to the
145 // android_thread_id_t (pid) from pthread_t
146 thread_data_t* t = new thread_data_t;
147 t->priority = threadPriority;
148 t->threadName = threadName ? strdup(threadName) : NULL;
149 t->entryFunction = entryFunction;
150 t->userData = userData;
151 entryFunction = (android_thread_func_t)&thread_data_t::trampoline;
152 userData = t;
153 }
154#endif
155
156 if (threadStackSize) {
157 pthread_attr_setstacksize(&attr, threadStackSize);
158 }
159
160 errno = 0;
161 pthread_t thread;
162 int result = pthread_create(&thread, &attr,
163 (android_pthread_entry)entryFunction, userData);
164 if (result != 0) {
165 LOGE("androidCreateRawThreadEtc failed (entry=%p, res=%d, errno=%d)\n"
166 "(android threadPriority=%d)",
167 entryFunction, result, errno, threadPriority);
168 return 0;
169 }
170
Glenn Kastena538e262011-06-02 08:59:28 -0700171 // Note that *threadID is directly available to the parent only, as it is
172 // assigned after the child starts. Use memory barrier / lock if the child
173 // or other threads also need access.
The Android Open Source Projectcbb10112009-03-03 19:31:44 -0800174 if (threadId != NULL) {
175 *threadId = (android_thread_id_t)thread; // XXX: this is not portable
176 }
177 return 1;
178}
179
180android_thread_id_t androidGetThreadId()
181{
182 return (android_thread_id_t)pthread_self();
183}
184
185// ----------------------------------------------------------------------------
186#elif defined(HAVE_WIN32_THREADS)
The Android Open Source Projectcbb10112009-03-03 19:31:44 -0800187// ----------------------------------------------------------------------------
188
189/*
190 * Trampoline to make us __stdcall-compliant.
191 *
192 * We're expected to delete "vDetails" when we're done.
193 */
194struct threadDetails {
195 int (*func)(void*);
196 void* arg;
197};
198static __stdcall unsigned int threadIntermediary(void* vDetails)
199{
200 struct threadDetails* pDetails = (struct threadDetails*) vDetails;
201 int result;
202
203 result = (*(pDetails->func))(pDetails->arg);
204
205 delete pDetails;
206
207 LOG(LOG_VERBOSE, "thread", "thread exiting\n");
208 return (unsigned int) result;
209}
210
211/*
212 * Create and run a new thread.
213 */
214static bool doCreateThread(android_thread_func_t fn, void* arg, android_thread_id_t *id)
215{
216 HANDLE hThread;
217 struct threadDetails* pDetails = new threadDetails; // must be on heap
218 unsigned int thrdaddr;
219
220 pDetails->func = fn;
221 pDetails->arg = arg;
222
223#if defined(HAVE__BEGINTHREADEX)
224 hThread = (HANDLE) _beginthreadex(NULL, 0, threadIntermediary, pDetails, 0,
225 &thrdaddr);
226 if (hThread == 0)
227#elif defined(HAVE_CREATETHREAD)
228 hThread = CreateThread(NULL, 0,
229 (LPTHREAD_START_ROUTINE) threadIntermediary,
230 (void*) pDetails, 0, (DWORD*) &thrdaddr);
231 if (hThread == NULL)
232#endif
233 {
234 LOG(LOG_WARN, "thread", "WARNING: thread create failed\n");
235 return false;
236 }
237
238#if defined(HAVE_CREATETHREAD)
239 /* close the management handle */
240 CloseHandle(hThread);
241#endif
242
243 if (id != NULL) {
244 *id = (android_thread_id_t)thrdaddr;
245 }
246
247 return true;
248}
249
250int androidCreateRawThreadEtc(android_thread_func_t fn,
251 void *userData,
252 const char* threadName,
253 int32_t threadPriority,
254 size_t threadStackSize,
255 android_thread_id_t *threadId)
256{
257 return doCreateThread( fn, userData, threadId);
258}
259
260android_thread_id_t androidGetThreadId()
261{
262 return (android_thread_id_t)GetCurrentThreadId();
263}
264
265// ----------------------------------------------------------------------------
266#else
267#error "Threads not supported"
268#endif
269
270// ----------------------------------------------------------------------------
271
The Android Open Source Projectcbb10112009-03-03 19:31:44 -0800272int androidCreateThread(android_thread_func_t fn, void* arg)
273{
274 return createThreadEtc(fn, arg);
275}
276
277int androidCreateThreadGetID(android_thread_func_t fn, void *arg, android_thread_id_t *id)
278{
279 return createThreadEtc(fn, arg, "android:unnamed_thread",
280 PRIORITY_DEFAULT, 0, id);
281}
282
283static android_create_thread_fn gCreateThreadFn = androidCreateRawThreadEtc;
284
285int androidCreateThreadEtc(android_thread_func_t entryFunction,
286 void *userData,
287 const char* threadName,
288 int32_t threadPriority,
289 size_t threadStackSize,
290 android_thread_id_t *threadId)
291{
292 return gCreateThreadFn(entryFunction, userData, threadName,
293 threadPriority, threadStackSize, threadId);
294}
295
296void androidSetCreateThreadFunc(android_create_thread_fn func)
297{
298 gCreateThreadFn = func;
299}
300
Dianne Hackborn235af972009-12-07 17:59:37 -0800301pid_t androidGetTid()
302{
303#ifdef HAVE_GETTID
304 return gettid();
305#else
306 return getpid();
307#endif
308}
309
310int androidSetThreadSchedulingGroup(pid_t tid, int grp)
311{
312 if (grp > ANDROID_TGROUP_MAX || grp < 0) {
313 return BAD_VALUE;
314 }
315
Dianne Hackbornaaa7ef82009-12-08 19:45:59 -0800316#if defined(HAVE_PTHREADS)
Dianne Hackborn16d217e2010-09-03 17:07:07 -0700317 pthread_once(&gDoSchedulingGroupOnce, checkDoSchedulingGroup);
318 if (gDoSchedulingGroup) {
Glenn Kasten5e0243f2011-06-22 17:42:23 -0700319 // set_sched_policy does not support tid == 0
320 if (tid == 0) {
321 tid = androidGetTid();
322 }
Dianne Hackborn16d217e2010-09-03 17:07:07 -0700323 if (set_sched_policy(tid, (grp == ANDROID_TGROUP_BG_NONINTERACT) ?
324 SP_BACKGROUND : SP_FOREGROUND)) {
325 return PERMISSION_DENIED;
326 }
Dianne Hackborn235af972009-12-07 17:59:37 -0800327 }
Dianne Hackbornaaa7ef82009-12-08 19:45:59 -0800328#endif
Dianne Hackborn235af972009-12-07 17:59:37 -0800329
330 return NO_ERROR;
331}
332
333int androidSetThreadPriority(pid_t tid, int pri)
334{
335 int rc = 0;
Dianne Hackbornaaa7ef82009-12-08 19:45:59 -0800336
337#if defined(HAVE_PTHREADS)
Dianne Hackborn235af972009-12-07 17:59:37 -0800338 int lasterr = 0;
339
Dianne Hackborn16d217e2010-09-03 17:07:07 -0700340 pthread_once(&gDoSchedulingGroupOnce, checkDoSchedulingGroup);
341 if (gDoSchedulingGroup) {
Glenn Kasten47f48572011-06-14 10:35:34 -0700342 // set_sched_policy does not support tid == 0
343 int policy_tid;
344 if (tid == 0) {
345 policy_tid = androidGetTid();
346 } else {
347 policy_tid = tid;
348 }
Dianne Hackborn16d217e2010-09-03 17:07:07 -0700349 if (pri >= ANDROID_PRIORITY_BACKGROUND) {
Glenn Kasten47f48572011-06-14 10:35:34 -0700350 rc = set_sched_policy(policy_tid, SP_BACKGROUND);
Dianne Hackborn16d217e2010-09-03 17:07:07 -0700351 } else if (getpriority(PRIO_PROCESS, tid) >= ANDROID_PRIORITY_BACKGROUND) {
Glenn Kasten47f48572011-06-14 10:35:34 -0700352 rc = set_sched_policy(policy_tid, SP_FOREGROUND);
Dianne Hackborn16d217e2010-09-03 17:07:07 -0700353 }
Dianne Hackborn235af972009-12-07 17:59:37 -0800354 }
355
356 if (rc) {
357 lasterr = errno;
358 }
359
360 if (setpriority(PRIO_PROCESS, tid, pri) < 0) {
361 rc = INVALID_OPERATION;
362 } else {
363 errno = lasterr;
364 }
Dianne Hackborn3432efa2009-12-08 16:38:01 -0800365#endif
Dianne Hackborn235af972009-12-07 17:59:37 -0800366
367 return rc;
368}
369
Glenn Kasten6fbe0a82011-06-22 16:20:37 -0700370int androidGetThreadSchedulingGroup(pid_t tid)
371{
372 int ret = ANDROID_TGROUP_DEFAULT;
373
374#if defined(HAVE_PTHREADS)
375 // convention is to not call get/set_sched_policy methods if disabled by property
376 pthread_once(&gDoSchedulingGroupOnce, checkDoSchedulingGroup);
377 if (gDoSchedulingGroup) {
378 SchedPolicy policy;
379 // get_sched_policy does not support tid == 0
380 if (tid == 0) {
381 tid = androidGetTid();
382 }
383 if (get_sched_policy(tid, &policy) < 0) {
384 ret = INVALID_OPERATION;
385 } else {
386 switch (policy) {
387 case SP_BACKGROUND:
388 ret = ANDROID_TGROUP_BG_NONINTERACT;
389 break;
390 case SP_FOREGROUND:
391 ret = ANDROID_TGROUP_FG_BOOST;
392 break;
393 default:
394 // should not happen, as enum SchedPolicy does not have any other values
395 ret = INVALID_OPERATION;
396 break;
397 }
398 }
399 }
400#endif
401
402 return ret;
403}
404
The Android Open Source Projectcbb10112009-03-03 19:31:44 -0800405namespace android {
406
407/*
408 * ===========================================================================
409 * Mutex class
410 * ===========================================================================
411 */
412
Mathias Agopian15554362009-07-12 23:11:20 -0700413#if defined(HAVE_PTHREADS)
414// implemented as inlines in threads.h
The Android Open Source Projectcbb10112009-03-03 19:31:44 -0800415#elif defined(HAVE_WIN32_THREADS)
The Android Open Source Projectcbb10112009-03-03 19:31:44 -0800416
417Mutex::Mutex()
418{
419 HANDLE hMutex;
420
421 assert(sizeof(hMutex) == sizeof(mState));
422
423 hMutex = CreateMutex(NULL, FALSE, NULL);
424 mState = (void*) hMutex;
425}
426
427Mutex::Mutex(const char* name)
428{
429 // XXX: name not used for now
430 HANDLE hMutex;
431
David 'Digit' Turner9bafd122009-08-01 00:20:17 +0200432 assert(sizeof(hMutex) == sizeof(mState));
433
434 hMutex = CreateMutex(NULL, FALSE, NULL);
435 mState = (void*) hMutex;
436}
437
438Mutex::Mutex(int type, const char* name)
439{
440 // XXX: type and name not used for now
441 HANDLE hMutex;
442
443 assert(sizeof(hMutex) == sizeof(mState));
444
The Android Open Source Projectcbb10112009-03-03 19:31:44 -0800445 hMutex = CreateMutex(NULL, FALSE, NULL);
446 mState = (void*) hMutex;
447}
448
449Mutex::~Mutex()
450{
451 CloseHandle((HANDLE) mState);
452}
453
454status_t Mutex::lock()
455{
456 DWORD dwWaitResult;
457 dwWaitResult = WaitForSingleObject((HANDLE) mState, INFINITE);
458 return dwWaitResult != WAIT_OBJECT_0 ? -1 : NO_ERROR;
459}
460
461void Mutex::unlock()
462{
463 if (!ReleaseMutex((HANDLE) mState))
464 LOG(LOG_WARN, "thread", "WARNING: bad result from unlocking mutex\n");
465}
466
467status_t Mutex::tryLock()
468{
469 DWORD dwWaitResult;
470
471 dwWaitResult = WaitForSingleObject((HANDLE) mState, 0);
472 if (dwWaitResult != WAIT_OBJECT_0 && dwWaitResult != WAIT_TIMEOUT)
473 LOG(LOG_WARN, "thread", "WARNING: bad result from try-locking mutex\n");
474 return (dwWaitResult == WAIT_OBJECT_0) ? 0 : -1;
475}
476
477#else
478#error "Somebody forgot to implement threads for this platform."
479#endif
480
481
482/*
483 * ===========================================================================
484 * Condition class
485 * ===========================================================================
486 */
487
Mathias Agopian15554362009-07-12 23:11:20 -0700488#if defined(HAVE_PTHREADS)
489// implemented as inlines in threads.h
The Android Open Source Projectcbb10112009-03-03 19:31:44 -0800490#elif defined(HAVE_WIN32_THREADS)
The Android Open Source Projectcbb10112009-03-03 19:31:44 -0800491
492/*
493 * Windows doesn't have a condition variable solution. It's possible
494 * to create one, but it's easy to get it wrong. For a discussion, and
495 * the origin of this implementation, see:
496 *
497 * http://www.cs.wustl.edu/~schmidt/win32-cv-1.html
498 *
499 * The implementation shown on the page does NOT follow POSIX semantics.
500 * As an optimization they require acquiring the external mutex before
501 * calling signal() and broadcast(), whereas POSIX only requires grabbing
502 * it before calling wait(). The implementation here has been un-optimized
503 * to have the correct behavior.
504 */
505typedef struct WinCondition {
506 // Number of waiting threads.
507 int waitersCount;
508
509 // Serialize access to waitersCount.
510 CRITICAL_SECTION waitersCountLock;
511
512 // Semaphore used to queue up threads waiting for the condition to
513 // become signaled.
514 HANDLE sema;
515
516 // An auto-reset event used by the broadcast/signal thread to wait
517 // for all the waiting thread(s) to wake up and be released from
518 // the semaphore.
519 HANDLE waitersDone;
520
521 // This mutex wouldn't be necessary if we required that the caller
522 // lock the external mutex before calling signal() and broadcast().
523 // I'm trying to mimic pthread semantics though.
524 HANDLE internalMutex;
525
526 // Keeps track of whether we were broadcasting or signaling. This
527 // allows us to optimize the code if we're just signaling.
528 bool wasBroadcast;
529
530 status_t wait(WinCondition* condState, HANDLE hMutex, nsecs_t* abstime)
531 {
532 // Increment the wait count, avoiding race conditions.
533 EnterCriticalSection(&condState->waitersCountLock);
534 condState->waitersCount++;
535 //printf("+++ wait: incr waitersCount to %d (tid=%ld)\n",
536 // condState->waitersCount, getThreadId());
537 LeaveCriticalSection(&condState->waitersCountLock);
538
539 DWORD timeout = INFINITE;
540 if (abstime) {
541 nsecs_t reltime = *abstime - systemTime();
542 if (reltime < 0)
543 reltime = 0;
544 timeout = reltime/1000000;
545 }
546
547 // Atomically release the external mutex and wait on the semaphore.
548 DWORD res =
549 SignalObjectAndWait(hMutex, condState->sema, timeout, FALSE);
550
551 //printf("+++ wait: awake (tid=%ld)\n", getThreadId());
552
553 // Reacquire lock to avoid race conditions.
554 EnterCriticalSection(&condState->waitersCountLock);
555
556 // No longer waiting.
557 condState->waitersCount--;
558
559 // Check to see if we're the last waiter after a broadcast.
560 bool lastWaiter = (condState->wasBroadcast && condState->waitersCount == 0);
561
562 //printf("+++ wait: lastWaiter=%d (wasBc=%d wc=%d)\n",
563 // lastWaiter, condState->wasBroadcast, condState->waitersCount);
564
565 LeaveCriticalSection(&condState->waitersCountLock);
566
567 // If we're the last waiter thread during this particular broadcast
568 // then signal broadcast() that we're all awake. It'll drop the
569 // internal mutex.
570 if (lastWaiter) {
571 // Atomically signal the "waitersDone" event and wait until we
572 // can acquire the internal mutex. We want to do this in one step
573 // because it ensures that everybody is in the mutex FIFO before
574 // any thread has a chance to run. Without it, another thread
575 // could wake up, do work, and hop back in ahead of us.
576 SignalObjectAndWait(condState->waitersDone, condState->internalMutex,
577 INFINITE, FALSE);
578 } else {
579 // Grab the internal mutex.
580 WaitForSingleObject(condState->internalMutex, INFINITE);
581 }
582
583 // Release the internal and grab the external.
584 ReleaseMutex(condState->internalMutex);
585 WaitForSingleObject(hMutex, INFINITE);
586
587 return res == WAIT_OBJECT_0 ? NO_ERROR : -1;
588 }
589} WinCondition;
590
591/*
592 * Constructor. Set up the WinCondition stuff.
593 */
594Condition::Condition()
595{
596 WinCondition* condState = new WinCondition;
597
598 condState->waitersCount = 0;
599 condState->wasBroadcast = false;
600 // semaphore: no security, initial value of 0
601 condState->sema = CreateSemaphore(NULL, 0, 0x7fffffff, NULL);
602 InitializeCriticalSection(&condState->waitersCountLock);
603 // auto-reset event, not signaled initially
604 condState->waitersDone = CreateEvent(NULL, FALSE, FALSE, NULL);
605 // used so we don't have to lock external mutex on signal/broadcast
606 condState->internalMutex = CreateMutex(NULL, FALSE, NULL);
607
608 mState = condState;
609}
610
611/*
612 * Destructor. Free Windows resources as well as our allocated storage.
613 */
614Condition::~Condition()
615{
616 WinCondition* condState = (WinCondition*) mState;
617 if (condState != NULL) {
618 CloseHandle(condState->sema);
619 CloseHandle(condState->waitersDone);
620 delete condState;
621 }
622}
623
624
625status_t Condition::wait(Mutex& mutex)
626{
627 WinCondition* condState = (WinCondition*) mState;
628 HANDLE hMutex = (HANDLE) mutex.mState;
629
630 return ((WinCondition*)mState)->wait(condState, hMutex, NULL);
631}
632
The Android Open Source Projectcbb10112009-03-03 19:31:44 -0800633status_t Condition::waitRelative(Mutex& mutex, nsecs_t reltime)
634{
David 'Digit' Turner9bafd122009-08-01 00:20:17 +0200635 WinCondition* condState = (WinCondition*) mState;
636 HANDLE hMutex = (HANDLE) mutex.mState;
637 nsecs_t absTime = systemTime()+reltime;
638
639 return ((WinCondition*)mState)->wait(condState, hMutex, &absTime);
The Android Open Source Projectcbb10112009-03-03 19:31:44 -0800640}
641
642/*
643 * Signal the condition variable, allowing one thread to continue.
644 */
645void Condition::signal()
646{
647 WinCondition* condState = (WinCondition*) mState;
648
649 // Lock the internal mutex. This ensures that we don't clash with
650 // broadcast().
651 WaitForSingleObject(condState->internalMutex, INFINITE);
652
653 EnterCriticalSection(&condState->waitersCountLock);
654 bool haveWaiters = (condState->waitersCount > 0);
655 LeaveCriticalSection(&condState->waitersCountLock);
656
657 // If no waiters, then this is a no-op. Otherwise, knock the semaphore
658 // down a notch.
659 if (haveWaiters)
660 ReleaseSemaphore(condState->sema, 1, 0);
661
662 // Release internal mutex.
663 ReleaseMutex(condState->internalMutex);
664}
665
666/*
667 * Signal the condition variable, allowing all threads to continue.
668 *
669 * First we have to wake up all threads waiting on the semaphore, then
670 * we wait until all of the threads have actually been woken before
671 * releasing the internal mutex. This ensures that all threads are woken.
672 */
673void Condition::broadcast()
674{
675 WinCondition* condState = (WinCondition*) mState;
676
677 // Lock the internal mutex. This keeps the guys we're waking up
678 // from getting too far.
679 WaitForSingleObject(condState->internalMutex, INFINITE);
680
681 EnterCriticalSection(&condState->waitersCountLock);
682 bool haveWaiters = false;
683
684 if (condState->waitersCount > 0) {
685 haveWaiters = true;
686 condState->wasBroadcast = true;
687 }
688
689 if (haveWaiters) {
690 // Wake up all the waiters.
691 ReleaseSemaphore(condState->sema, condState->waitersCount, 0);
692
693 LeaveCriticalSection(&condState->waitersCountLock);
694
695 // Wait for all awakened threads to acquire the counting semaphore.
696 // The last guy who was waiting sets this.
697 WaitForSingleObject(condState->waitersDone, INFINITE);
698
699 // Reset wasBroadcast. (No crit section needed because nobody
700 // else can wake up to poke at it.)
701 condState->wasBroadcast = 0;
702 } else {
703 // nothing to do
704 LeaveCriticalSection(&condState->waitersCountLock);
705 }
706
707 // Release internal mutex.
708 ReleaseMutex(condState->internalMutex);
709}
710
711#else
712#error "condition variables not supported on this platform"
713#endif
714
The Android Open Source Projectcbb10112009-03-03 19:31:44 -0800715// ----------------------------------------------------------------------------
716
The Android Open Source Projectcbb10112009-03-03 19:31:44 -0800717/*
718 * This is our thread object!
719 */
720
721Thread::Thread(bool canCallJava)
722 : mCanCallJava(canCallJava),
723 mThread(thread_id_t(-1)),
724 mLock("Thread::mLock"),
725 mStatus(NO_ERROR),
726 mExitPending(false), mRunning(false)
Glenn Kasten966a48f2011-02-01 11:32:29 -0800727#ifdef HAVE_ANDROID_OS
728 , mTid(-1)
729#endif
The Android Open Source Projectcbb10112009-03-03 19:31:44 -0800730{
731}
732
733Thread::~Thread()
734{
735}
736
737status_t Thread::readyToRun()
738{
739 return NO_ERROR;
740}
741
742status_t Thread::run(const char* name, int32_t priority, size_t stack)
743{
744 Mutex::Autolock _l(mLock);
745
746 if (mRunning) {
747 // thread already started
748 return INVALID_OPERATION;
749 }
750
751 // reset status and exitPending to their default value, so we can
752 // try again after an error happened (either below, or in readyToRun())
753 mStatus = NO_ERROR;
754 mExitPending = false;
755 mThread = thread_id_t(-1);
756
757 // hold a strong reference on ourself
758 mHoldSelf = this;
759
The Android Open Source Project7a4c8392009-03-05 14:34:35 -0800760 mRunning = true;
761
The Android Open Source Projectcbb10112009-03-03 19:31:44 -0800762 bool res;
763 if (mCanCallJava) {
764 res = createThreadEtc(_threadLoop,
765 this, name, priority, stack, &mThread);
766 } else {
767 res = androidCreateRawThreadEtc(_threadLoop,
768 this, name, priority, stack, &mThread);
769 }
770
771 if (res == false) {
772 mStatus = UNKNOWN_ERROR; // something happened!
773 mRunning = false;
774 mThread = thread_id_t(-1);
The Android Open Source Project7a4c8392009-03-05 14:34:35 -0800775 mHoldSelf.clear(); // "this" may have gone away after this.
776
777 return UNKNOWN_ERROR;
The Android Open Source Projectcbb10112009-03-03 19:31:44 -0800778 }
779
The Android Open Source Project7a4c8392009-03-05 14:34:35 -0800780 // Do not refer to mStatus here: The thread is already running (may, in fact
781 // already have exited with a valid mStatus result). The NO_ERROR indication
782 // here merely indicates successfully starting the thread and does not
783 // imply successful termination/execution.
784 return NO_ERROR;
Glenn Kasten966a48f2011-02-01 11:32:29 -0800785
786 // Exiting scope of mLock is a memory barrier and allows new thread to run
The Android Open Source Projectcbb10112009-03-03 19:31:44 -0800787}
788
789int Thread::_threadLoop(void* user)
790{
791 Thread* const self = static_cast<Thread*>(user);
Glenn Kasten966a48f2011-02-01 11:32:29 -0800792
The Android Open Source Projectcbb10112009-03-03 19:31:44 -0800793 sp<Thread> strong(self->mHoldSelf);
794 wp<Thread> weak(strong);
795 self->mHoldSelf.clear();
796
Kenny Rootdafff0b2011-02-16 10:13:53 -0800797#ifdef HAVE_ANDROID_OS
Mathias Agopian51ce3ad2009-09-09 02:38:13 -0700798 // this is very useful for debugging with gdb
799 self->mTid = gettid();
800#endif
801
The Android Open Source Project7a4c8392009-03-05 14:34:35 -0800802 bool first = true;
The Android Open Source Projectcbb10112009-03-03 19:31:44 -0800803
804 do {
The Android Open Source Project7a4c8392009-03-05 14:34:35 -0800805 bool result;
806 if (first) {
807 first = false;
808 self->mStatus = self->readyToRun();
809 result = (self->mStatus == NO_ERROR);
810
Glenn Kasten966a48f2011-02-01 11:32:29 -0800811 if (result && !self->exitPending()) {
The Android Open Source Project7a4c8392009-03-05 14:34:35 -0800812 // Binder threads (and maybe others) rely on threadLoop
813 // running at least once after a successful ::readyToRun()
814 // (unless, of course, the thread has already been asked to exit
815 // at that point).
816 // This is because threads are essentially used like this:
817 // (new ThreadSubclass())->run();
818 // The caller therefore does not retain a strong reference to
819 // the thread and the thread would simply disappear after the
820 // successful ::readyToRun() call instead of entering the
821 // threadLoop at least once.
822 result = self->threadLoop();
823 }
824 } else {
825 result = self->threadLoop();
826 }
827
Glenn Kasten966a48f2011-02-01 11:32:29 -0800828 // establish a scope for mLock
829 {
830 Mutex::Autolock _l(self->mLock);
The Android Open Source Projectcbb10112009-03-03 19:31:44 -0800831 if (result == false || self->mExitPending) {
832 self->mExitPending = true;
The Android Open Source Projectcbb10112009-03-03 19:31:44 -0800833 self->mRunning = false;
Eric Laurentfe2c4632011-01-04 11:58:04 -0800834 // clear thread ID so that requestExitAndWait() does not exit if
835 // called by a new thread using the same thread ID as this one.
836 self->mThread = thread_id_t(-1);
Glenn Kasten966a48f2011-02-01 11:32:29 -0800837 // note that interested observers blocked in requestExitAndWait are
838 // awoken by broadcast, but blocked on mLock until break exits scope
Mathias Agopian51ce3ad2009-09-09 02:38:13 -0700839 self->mThreadExitedCondition.broadcast();
The Android Open Source Projectcbb10112009-03-03 19:31:44 -0800840 break;
841 }
Glenn Kasten966a48f2011-02-01 11:32:29 -0800842 }
The Android Open Source Projectcbb10112009-03-03 19:31:44 -0800843
844 // Release our strong reference, to let a chance to the thread
845 // to die a peaceful death.
846 strong.clear();
Mathias Agopian51ce3ad2009-09-09 02:38:13 -0700847 // And immediately, re-acquire a strong reference for the next loop
The Android Open Source Projectcbb10112009-03-03 19:31:44 -0800848 strong = weak.promote();
849 } while(strong != 0);
850
851 return 0;
852}
853
854void Thread::requestExit()
855{
Glenn Kasten966a48f2011-02-01 11:32:29 -0800856 Mutex::Autolock _l(mLock);
The Android Open Source Projectcbb10112009-03-03 19:31:44 -0800857 mExitPending = true;
858}
859
860status_t Thread::requestExitAndWait()
861{
Glenn Kastena538e262011-06-02 08:59:28 -0700862 Mutex::Autolock _l(mLock);
The Android Open Source Project7a4c8392009-03-05 14:34:35 -0800863 if (mThread == getThreadId()) {
864 LOGW(
865 "Thread (this=%p): don't call waitForExit() from this "
866 "Thread object's thread. It's a guaranteed deadlock!",
867 this);
The Android Open Source Projectcbb10112009-03-03 19:31:44 -0800868
The Android Open Source Project7a4c8392009-03-05 14:34:35 -0800869 return WOULD_BLOCK;
The Android Open Source Projectcbb10112009-03-03 19:31:44 -0800870 }
The Android Open Source Project7a4c8392009-03-05 14:34:35 -0800871
Glenn Kastena538e262011-06-02 08:59:28 -0700872 mExitPending = true;
The Android Open Source Project7a4c8392009-03-05 14:34:35 -0800873
The Android Open Source Project7a4c8392009-03-05 14:34:35 -0800874 while (mRunning == true) {
875 mThreadExitedCondition.wait(mLock);
876 }
Glenn Kasten966a48f2011-02-01 11:32:29 -0800877 // This next line is probably not needed any more, but is being left for
878 // historical reference. Note that each interested party will clear flag.
The Android Open Source Project7a4c8392009-03-05 14:34:35 -0800879 mExitPending = false;
880
The Android Open Source Projectcbb10112009-03-03 19:31:44 -0800881 return mStatus;
882}
883
Glenn Kasten6839e8e2011-06-23 12:55:29 -0700884status_t Thread::join()
885{
886 Mutex::Autolock _l(mLock);
887 if (mThread == getThreadId()) {
888 LOGW(
889 "Thread (this=%p): don't call join() from this "
890 "Thread object's thread. It's a guaranteed deadlock!",
891 this);
892
893 return WOULD_BLOCK;
894 }
895
896 while (mRunning == true) {
897 mThreadExitedCondition.wait(mLock);
898 }
899
900 return mStatus;
901}
902
The Android Open Source Projectcbb10112009-03-03 19:31:44 -0800903bool Thread::exitPending() const
904{
Glenn Kasten966a48f2011-02-01 11:32:29 -0800905 Mutex::Autolock _l(mLock);
The Android Open Source Projectcbb10112009-03-03 19:31:44 -0800906 return mExitPending;
907}
908
909
910
911}; // namespace android