pthread_create.cpp revision 7086ad6919feb2415c6027163f5c63323bcca27c
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#include <unistd.h> 34 35#include "pthread_internal.h" 36 37#include "private/bionic_macros.h" 38#include "private/bionic_ssp.h" 39#include "private/bionic_tls.h" 40#include "private/libc_logging.h" 41#include "private/ErrnoRestorer.h" 42#include "private/ScopedPthreadMutexLocker.h" 43 44// Used by gdb to track thread creation. See libthread_db. 45#ifdef __i386__ 46extern "C" __attribute__((noinline)) __attribute__((fastcall)) void _thread_created_hook(pid_t) {} 47#else 48extern "C" __attribute__((noinline)) void _thread_created_hook(pid_t) {} 49#endif 50 51// x86 uses segment descriptors rather than a direct pointer to TLS. 52#if __i386__ 53#include <asm/ldt.h> 54extern "C" __LIBC_HIDDEN__ void __init_user_desc(struct user_desc*, int, void*); 55#endif 56 57static pthread_mutex_t g_pthread_stack_creation_lock = PTHREAD_MUTEX_INITIALIZER; 58 59static pthread_mutex_t g_debugger_notification_lock = PTHREAD_MUTEX_INITIALIZER; 60 61extern "C" int __isthreaded; 62 63// This code is used both by each new pthread and the code that initializes the main thread. 64void __init_tls(pthread_internal_t* thread) { 65 // Zero-initialize all the slots after TLS_SLOT_SELF and TLS_SLOT_THREAD_ID. 66 for (size_t i = TLS_SLOT_ERRNO; i < BIONIC_TLS_SLOTS; ++i) { 67 thread->tls[i] = NULL; 68 } 69 70 // Slot 0 must point to itself. The x86 Linux kernel reads the TLS from %fs:0. 71 thread->tls[TLS_SLOT_SELF] = thread->tls; 72 thread->tls[TLS_SLOT_THREAD_ID] = thread; 73 // GCC looks in the TLS for the stack guard on x86, so copy it there from our global. 74 thread->tls[TLS_SLOT_STACK_GUARD] = (void*) __stack_chk_guard; 75} 76 77void __init_alternate_signal_stack(pthread_internal_t* thread) { 78 // Create and set an alternate signal stack. 79 stack_t ss; 80 ss.ss_sp = mmap(NULL, SIGSTKSZ, PROT_READ|PROT_WRITE, MAP_PRIVATE|MAP_ANONYMOUS, 0, 0); 81 if (ss.ss_sp != MAP_FAILED) { 82 ss.ss_size = SIGSTKSZ; 83 ss.ss_flags = 0; 84 sigaltstack(&ss, NULL); 85 thread->alternate_signal_stack = ss.ss_sp; 86 } 87} 88 89int __init_thread(pthread_internal_t* thread, bool add_to_thread_list) { 90 int error = 0; 91 92 // Set the scheduling policy/priority of the thread. 93 if (thread->attr.sched_policy != SCHED_NORMAL) { 94 sched_param param; 95 param.sched_priority = thread->attr.sched_priority; 96 if (sched_setscheduler(thread->tid, thread->attr.sched_policy, ¶m) == -1) { 97#if __LP64__ 98 // For backwards compatibility reasons, we only report failures on 64-bit devices. 99 error = errno; 100#endif 101 __libc_format_log(ANDROID_LOG_WARN, "libc", 102 "pthread_create sched_setscheduler call failed: %s", strerror(errno)); 103 } 104 } 105 106 thread->cleanup_stack = NULL; 107 108 if (add_to_thread_list) { 109 _pthread_internal_add(thread); 110 } 111 112 return error; 113} 114 115static void* __create_thread_stack(pthread_internal_t* thread) { 116 ScopedPthreadMutexLocker lock(&g_pthread_stack_creation_lock); 117 118 // Create a new private anonymous map. 119 int prot = PROT_READ | PROT_WRITE; 120 int flags = MAP_PRIVATE | MAP_ANONYMOUS | MAP_NORESERVE; 121 void* stack = mmap(NULL, thread->attr.stack_size, prot, flags, -1, 0); 122 if (stack == MAP_FAILED) { 123 __libc_format_log(ANDROID_LOG_WARN, 124 "libc", 125 "pthread_create failed: couldn't allocate %zd-byte stack: %s", 126 thread->attr.stack_size, strerror(errno)); 127 return NULL; 128 } 129 130 // Set the guard region at the end of the stack to PROT_NONE. 131 if (mprotect(stack, thread->attr.guard_size, PROT_NONE) == -1) { 132 __libc_format_log(ANDROID_LOG_WARN, "libc", 133 "pthread_create failed: couldn't mprotect PROT_NONE %zd-byte stack guard region: %s", 134 thread->attr.guard_size, strerror(errno)); 135 munmap(stack, thread->attr.stack_size); 136 return NULL; 137 } 138 139 return stack; 140} 141 142static int __pthread_start(void* arg) { 143 pthread_internal_t* thread = reinterpret_cast<pthread_internal_t*>(arg); 144 145 // Wait for our creating thread to release us. This lets it have time to 146 // notify gdb about this thread before we start doing anything. 147 // This also provides the memory barrier needed to ensure that all memory 148 // accesses previously made by the creating thread are visible to us. 149 pthread_mutex_lock(&thread->startup_handshake_mutex); 150 pthread_mutex_destroy(&thread->startup_handshake_mutex); 151 152 __init_alternate_signal_stack(thread); 153 154 void* result = thread->start_routine(thread->start_routine_arg); 155 pthread_exit(result); 156 157 return 0; 158} 159 160// A dummy start routine for pthread_create failures where we've created a thread but aren't 161// going to run user code on it. We swap out the user's start routine for this and take advantage 162// of the regular thread teardown to free up resources. 163static void* __do_nothing(void*) { 164 return NULL; 165} 166 167int pthread_create(pthread_t* thread_out, pthread_attr_t const* attr, 168 void* (*start_routine)(void*), void* arg) { 169 ErrnoRestorer errno_restorer; 170 171 // Inform the rest of the C library that at least one thread was created. 172 __isthreaded = 1; 173 174 pthread_internal_t* thread = reinterpret_cast<pthread_internal_t*>(calloc(sizeof(*thread), 1)); 175 if (thread == NULL) { 176 __libc_format_log(ANDROID_LOG_WARN, "libc", "pthread_create failed: couldn't allocate thread"); 177 return EAGAIN; 178 } 179 180 if (attr == NULL) { 181 pthread_attr_init(&thread->attr); 182 } else { 183 thread->attr = *attr; 184 attr = NULL; // Prevent misuse below. 185 } 186 187 // Make sure the stack size and guard size are multiples of PAGE_SIZE. 188 thread->attr.stack_size = BIONIC_ALIGN(thread->attr.stack_size, PAGE_SIZE); 189 thread->attr.guard_size = BIONIC_ALIGN(thread->attr.guard_size, PAGE_SIZE); 190 191 if (thread->attr.stack_base == NULL) { 192 // The caller didn't provide a stack, so allocate one. 193 thread->attr.stack_base = __create_thread_stack(thread); 194 if (thread->attr.stack_base == NULL) { 195 free(thread); 196 return EAGAIN; 197 } 198 } else { 199 // The caller did provide a stack, so remember we're not supposed to free it. 200 thread->attr.flags |= PTHREAD_ATTR_FLAG_USER_ALLOCATED_STACK; 201 } 202 203 // Make room for the TLS area. 204 // The child stack is the same address, just growing in the opposite direction. 205 // At offsets >= 0, we have the TLS slots. 206 // At offsets < 0, we have the child stack. 207 thread->tls = reinterpret_cast<void**>(reinterpret_cast<uint8_t*>(thread->attr.stack_base) + 208 thread->attr.stack_size - BIONIC_TLS_SLOTS * sizeof(void*)); 209 void* child_stack = thread->tls; 210 __init_tls(thread); 211 212 // Create a mutex for the thread in TLS to wait on once it starts so we can keep 213 // it from doing anything until after we notify the debugger about it 214 // 215 // This also provides the memory barrier we need to ensure that all 216 // memory accesses previously performed by this thread are visible to 217 // the new thread. 218 pthread_mutex_init(&thread->startup_handshake_mutex, NULL); 219 pthread_mutex_lock(&thread->startup_handshake_mutex); 220 221 thread->start_routine = start_routine; 222 thread->start_routine_arg = arg; 223 224 thread->set_cached_pid(getpid()); 225 226 int flags = CLONE_VM | CLONE_FS | CLONE_FILES | CLONE_SIGHAND | CLONE_THREAD | CLONE_SYSVSEM | 227 CLONE_SETTLS | CLONE_PARENT_SETTID | CLONE_CHILD_CLEARTID; 228 void* tls = thread->tls; 229#if defined(__i386__) 230 // On x86 (but not x86-64), CLONE_SETTLS takes a pointer to a struct user_desc rather than 231 // a pointer to the TLS itself. 232 user_desc tls_descriptor; 233 __init_user_desc(&tls_descriptor, false, tls); 234 tls = &tls_descriptor; 235#endif 236 int rc = clone(__pthread_start, child_stack, flags, thread, &(thread->tid), tls, &(thread->tid)); 237 if (rc == -1) { 238 int clone_errno = errno; 239 // We don't have to unlock the mutex at all because clone(2) failed so there's no child waiting to 240 // be unblocked, but we're about to unmap the memory the mutex is stored in, so this serves as a 241 // reminder that you can't rewrite this function to use a ScopedPthreadMutexLocker. 242 pthread_mutex_unlock(&thread->startup_handshake_mutex); 243 if ((thread->attr.flags & PTHREAD_ATTR_FLAG_USER_ALLOCATED_STACK) == 0) { 244 munmap(thread->attr.stack_base, thread->attr.stack_size); 245 } 246 free(thread); 247 __libc_format_log(ANDROID_LOG_WARN, "libc", "pthread_create failed: clone failed: %s", strerror(errno)); 248 return clone_errno; 249 } 250 251 int init_errno = __init_thread(thread, true); 252 if (init_errno != 0) { 253 // Mark the thread detached and replace its start_routine with a no-op. 254 // Letting the thread run is the easiest way to clean up its resources. 255 thread->attr.flags |= PTHREAD_ATTR_FLAG_DETACHED; 256 thread->start_routine = __do_nothing; 257 pthread_mutex_unlock(&thread->startup_handshake_mutex); 258 return init_errno; 259 } 260 261 // Notify any debuggers about the new thread. 262 { 263 ScopedPthreadMutexLocker debugger_locker(&g_debugger_notification_lock); 264 _thread_created_hook(thread->tid); 265 } 266 267 // Publish the pthread_t and unlock the mutex to let the new thread start running. 268 *thread_out = reinterpret_cast<pthread_t>(thread); 269 pthread_mutex_unlock(&thread->startup_handshake_mutex); 270 271 return 0; 272} 273