pthread_create.cpp revision aa754dca90487356cabf07ade0e8d88c2630b784
1/* 2 * Copyright (C) 2008 The Android Open Source Project 3 * All rights reserved. 4 * 5 * Redistribution and use in source and binary forms, with or without 6 * modification, are permitted provided that the following conditions 7 * are met: 8 * * Redistributions of source code must retain the above copyright 9 * notice, this list of conditions and the following disclaimer. 10 * * Redistributions in binary form must reproduce the above copyright 11 * notice, this list of conditions and the following disclaimer in 12 * the documentation and/or other materials provided with the 13 * distribution. 14 * 15 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 16 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 17 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS 18 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE 19 * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, 20 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 21 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS 22 * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED 23 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 24 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT 25 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 26 * SUCH DAMAGE. 27 */ 28 29#include <pthread.h> 30 31#include <errno.h> 32#include <sys/mman.h> 33 34#include "pthread_internal.h" 35 36#include "private/bionic_ssp.h" 37#include "private/bionic_tls.h" 38#include "private/libc_logging.h" 39#include "private/thread_private.h" 40#include "private/ErrnoRestorer.h" 41#include "private/ScopedPthreadMutexLocker.h" 42 43extern "C" int __pthread_clone(void* (*fn)(void*), void* child_stack, int flags, void* arg); 44 45#ifdef __i386__ 46#define ATTRIBUTES __attribute__((noinline)) __attribute__((fastcall)) 47#else 48#define ATTRIBUTES __attribute__((noinline)) 49#endif 50 51extern "C" void ATTRIBUTES _thread_created_hook(pid_t thread_id); 52 53static const int kPthreadInitFailed = 1; 54 55static pthread_mutex_t gPthreadStackCreationLock = PTHREAD_MUTEX_INITIALIZER; 56 57static pthread_mutex_t gDebuggerNotificationLock = PTHREAD_MUTEX_INITIALIZER; 58 59void __init_tls(pthread_internal_t* thread) { 60 // Zero-initialize all the slots. 61 for (size_t i = 0; i < BIONIC_TLS_SLOTS; ++i) { 62 thread->tls[i] = NULL; 63 } 64 65 // Create and set an alternate signal stack. 66 stack_t ss; 67 ss.ss_sp = mmap(NULL, SIGSTKSZ, PROT_READ|PROT_WRITE, MAP_PRIVATE|MAP_ANONYMOUS, 0, 0); 68 if (ss.ss_sp != MAP_FAILED) { 69 ss.ss_size = SIGSTKSZ; 70 ss.ss_flags = 0; 71 sigaltstack(&ss, NULL); 72 } 73 74 // Slot 0 must point to itself. The x86 Linux kernel reads the TLS from %fs:0. 75 thread->tls[TLS_SLOT_SELF] = thread->tls; 76 thread->tls[TLS_SLOT_THREAD_ID] = thread; 77 // GCC looks in the TLS for the stack guard on x86, so copy it there from our global. 78 thread->tls[TLS_SLOT_STACK_GUARD] = (void*) __stack_chk_guard; 79 80 __set_tls(thread->tls); 81} 82 83// This trampoline is called from the assembly _pthread_clone function. 84// Our 'tls' and __pthread_clone's 'child_stack' are one and the same, just growing in 85// opposite directions. 86extern "C" void __thread_entry(void* (*func)(void*), void* arg, void** tls) { 87 // Wait for our creating thread to release us. This lets it have time to 88 // notify gdb about this thread before we start doing anything. 89 // This also provides the memory barrier needed to ensure that all memory 90 // accesses previously made by the creating thread are visible to us. 91 pthread_mutex_t* start_mutex = (pthread_mutex_t*) &tls[TLS_SLOT_SELF]; 92 pthread_mutex_lock(start_mutex); 93 pthread_mutex_destroy(start_mutex); 94 95 pthread_internal_t* thread = (pthread_internal_t*) tls[TLS_SLOT_THREAD_ID]; 96 thread->tls = tls; 97 __init_tls(thread); 98 99 if ((thread->internal_flags & kPthreadInitFailed) != 0) { 100 pthread_exit(NULL); 101 } 102 103 void* result = func(arg); 104 pthread_exit(result); 105} 106 107__LIBC_ABI_PRIVATE__ 108int _init_thread(pthread_internal_t* thread, bool add_to_thread_list) { 109 int error = 0; 110 111 // Set the scheduling policy/priority of the thread. 112 if (thread->attr.sched_policy != SCHED_NORMAL) { 113 struct sched_param param; 114 param.sched_priority = thread->attr.sched_priority; 115 if (sched_setscheduler(thread->tid, thread->attr.sched_policy, ¶m) == -1) { 116 // For backwards compatibility reasons, we just warn about failures here. 117 // error = errno; 118 __libc_format_log(ANDROID_LOG_WARN, "libc", 119 "pthread_create sched_setscheduler call failed: %s", strerror(errno)); 120 } 121 } 122 123 pthread_cond_init(&thread->join_cond, NULL); 124 thread->cleanup_stack = NULL; 125 126 if (add_to_thread_list) { 127 _pthread_internal_add(thread); 128 } 129 130 return error; 131} 132 133static void* __create_thread_stack(pthread_internal_t* thread) { 134 ScopedPthreadMutexLocker lock(&gPthreadStackCreationLock); 135 136 // Create a new private anonymous map. 137 int prot = PROT_READ | PROT_WRITE; 138 int flags = MAP_PRIVATE | MAP_ANONYMOUS | MAP_NORESERVE; 139 void* stack = mmap(NULL, thread->attr.stack_size, prot, flags, -1, 0); 140 if (stack == MAP_FAILED) { 141 __libc_format_log(ANDROID_LOG_WARN, 142 "libc", 143 "pthread_create failed: couldn't allocate %zd-byte stack: %s", 144 thread->attr.stack_size, strerror(errno)); 145 return NULL; 146 } 147 148 // Set the guard region at the end of the stack to PROT_NONE. 149 if (mprotect(stack, thread->attr.guard_size, PROT_NONE) == -1) { 150 __libc_format_log(ANDROID_LOG_WARN, "libc", 151 "pthread_create failed: couldn't mprotect PROT_NONE %zd-byte stack guard region: %s", 152 thread->attr.guard_size, strerror(errno)); 153 munmap(stack, thread->attr.stack_size); 154 return NULL; 155 } 156 157 return stack; 158} 159 160int pthread_create(pthread_t* thread_out, pthread_attr_t const* attr, 161 void* (*start_routine)(void*), void* arg) { 162 ErrnoRestorer errno_restorer; 163 164 // Inform the rest of the C library that at least one thread 165 // was created. This will enforce certain functions to acquire/release 166 // locks (e.g. atexit()) to protect shared global structures. 167 // This works because pthread_create() is not called by the C library 168 // initialization routine that sets up the main thread's data structures. 169 __isthreaded = 1; 170 171 pthread_internal_t* thread = reinterpret_cast<pthread_internal_t*>(calloc(sizeof(*thread), 1)); 172 if (thread == NULL) { 173 __libc_format_log(ANDROID_LOG_WARN, "libc", "pthread_create failed: couldn't allocate thread"); 174 return EAGAIN; 175 } 176 thread->allocated_on_heap = true; 177 178 if (attr == NULL) { 179 pthread_attr_init(&thread->attr); 180 } else { 181 thread->attr = *attr; 182 attr = NULL; // Prevent misuse below. 183 } 184 185 // Make sure the stack size and guard size are multiples of PAGE_SIZE. 186 thread->attr.stack_size = (thread->attr.stack_size + (PAGE_SIZE-1)) & ~(PAGE_SIZE-1); 187 thread->attr.guard_size = (thread->attr.guard_size + (PAGE_SIZE-1)) & ~(PAGE_SIZE-1); 188 189 if (thread->attr.stack_base == NULL) { 190 // The caller didn't provide a stack, so allocate one. 191 thread->attr.stack_base = __create_thread_stack(thread); 192 if (thread->attr.stack_base == NULL) { 193 free(thread); 194 return EAGAIN; 195 } 196 } else { 197 // The caller did provide a stack, so remember we're not supposed to free it. 198 thread->attr.flags |= PTHREAD_ATTR_FLAG_USER_STACK; 199 } 200 201 // Make room for the TLS area. 202 // The child stack is the same address, just growing in the opposite direction. 203 // At offsets >= 0, we have the TLS slots. 204 // At offsets < 0, we have the child stack. 205 void** tls = (void**)((uint8_t*)(thread->attr.stack_base) + thread->attr.stack_size - BIONIC_TLS_SLOTS * sizeof(void*)); 206 void* child_stack = tls; 207 208 // Create a mutex for the thread in TLS_SLOT_SELF to wait on once it starts so we can keep 209 // it from doing anything until after we notify the debugger about it 210 // 211 // This also provides the memory barrier we need to ensure that all 212 // memory accesses previously performed by this thread are visible to 213 // the new thread. 214 pthread_mutex_t* start_mutex = (pthread_mutex_t*) &tls[TLS_SLOT_SELF]; 215 pthread_mutex_init(start_mutex, NULL); 216 ScopedPthreadMutexLocker start_locker(start_mutex); 217 218 tls[TLS_SLOT_THREAD_ID] = thread; 219 220 int flags = CLONE_FILES | CLONE_FS | CLONE_VM | CLONE_SIGHAND | CLONE_THREAD | CLONE_SYSVSEM; 221 222 int tid = __pthread_clone(start_routine, child_stack, flags, arg); 223 if (tid < 0) { 224 int clone_errno = errno; 225 if ((thread->attr.flags & PTHREAD_ATTR_FLAG_USER_STACK) == 0) { 226 munmap(thread->attr.stack_base, thread->attr.stack_size); 227 } 228 free(thread); 229 __libc_format_log(ANDROID_LOG_WARN, "libc", "pthread_create failed: clone failed: %s", strerror(errno)); 230 return clone_errno; 231 } 232 233 thread->tid = tid; 234 235 int init_errno = _init_thread(thread, true); 236 if (init_errno != 0) { 237 // Mark the thread detached and let its __thread_entry run to 238 // completion. (It'll just exit immediately, cleaning up its resources.) 239 thread->internal_flags |= kPthreadInitFailed; 240 thread->attr.flags |= PTHREAD_ATTR_FLAG_DETACHED; 241 return init_errno; 242 } 243 244 // Notify any debuggers about the new thread. 245 { 246 ScopedPthreadMutexLocker debugger_locker(&gDebuggerNotificationLock); 247 _thread_created_hook(thread->tid); 248 } 249 250 // Publish the pthread_t and let the thread run. 251 *thread_out = (pthread_t) thread; 252 253 return 0; 254} 255