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