1 /*
2 * Copyright (C) 2010 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 #define _GNU_SOURCE 1
30 #include <sched.h>
31 #include <stdlib.h>
32 #include <stdarg.h>
33 #include <sys/syscall.h>
34
35 #include "pthread_internal.h"
36
37 #include "private/bionic_defs.h"
38 #include "platform/bionic/macros.h"
39
40 extern "C" pid_t __bionic_clone(uint32_t flags, void* child_stack, int* parent_tid, void* tls, int* child_tid, int (*fn)(void*), void* arg);
41 extern "C" __noreturn void __exit(int status);
42
43 // Called from the __bionic_clone assembler to call the thread function then exit.
44 __attribute__((no_sanitize("hwaddress")))
__start_thread(int (* fn)(void *),void * arg)45 extern "C" __LIBC_HIDDEN__ void __start_thread(int (*fn)(void*), void* arg) {
46 BIONIC_STOP_UNWIND;
47
48 pthread_internal_t* self = __get_thread();
49 if (self && self->tid == -1) {
50 self->tid = syscall(__NR_gettid);
51 }
52
53 int status = (*fn)(arg);
54 __exit(status);
55 }
56
57 __BIONIC_WEAK_FOR_NATIVE_BRIDGE
clone(int (* fn)(void *),void * child_stack,int flags,void * arg,...)58 int clone(int (*fn)(void*), void* child_stack, int flags, void* arg, ...) {
59 int* parent_tid = nullptr;
60 void* new_tls = nullptr;
61 int* child_tid = nullptr;
62
63 if (fn != nullptr && child_stack == nullptr) {
64 errno = EINVAL;
65 return -1;
66 }
67
68 // Extract any optional parameters required by the flags.
69 va_list args;
70 va_start(args, arg);
71 if ((flags & (CLONE_PARENT_SETTID|CLONE_SETTLS|CLONE_CHILD_SETTID|CLONE_CHILD_CLEARTID)) != 0) {
72 parent_tid = va_arg(args, int*);
73 }
74 if ((flags & (CLONE_SETTLS|CLONE_CHILD_SETTID|CLONE_CHILD_CLEARTID)) != 0) {
75 new_tls = va_arg(args, void*);
76 }
77 if ((flags & (CLONE_CHILD_SETTID|CLONE_CHILD_CLEARTID)) != 0) {
78 child_tid = va_arg(args, int*);
79 }
80 va_end(args);
81
82 // Align 'child_stack' to 16 bytes.
83 uintptr_t child_stack_addr = reinterpret_cast<uintptr_t>(child_stack);
84 child_stack_addr &= ~0xf;
85 child_stack = reinterpret_cast<void*>(child_stack_addr);
86
87 // Remember the parent pid and invalidate the cached value while we clone.
88 pthread_internal_t* self = __get_thread();
89 pid_t parent_pid = self->invalidate_cached_pid();
90
91 // Remmber the caller's tid so that it can be restored in the parent after clone.
92 pid_t caller_tid = self->tid;
93 // Invalidate the tid before the syscall. The value is lazily cached in gettid(),
94 // and it will be updated by fork() and pthread_create(). We don't do this if
95 // we are sharing address space with the child.
96 if (!(flags & (CLONE_VM|CLONE_VFORK))) {
97 self->tid = -1;
98 }
99
100 // Actually do the clone.
101 int clone_result;
102 if (fn != nullptr) {
103 clone_result = __bionic_clone(flags, child_stack, parent_tid, new_tls, child_tid, fn, arg);
104 } else {
105 #if defined(__x86_64__) // sys_clone's last two arguments are flipped on x86-64.
106 clone_result = syscall(__NR_clone, flags, child_stack, parent_tid, child_tid, new_tls);
107 #else
108 clone_result = syscall(__NR_clone, flags, child_stack, parent_tid, new_tls, child_tid);
109 #endif
110 }
111
112 if (clone_result != 0) {
113 // We're the parent, so put our known pid and tid back in place.
114 // We leave the child without a cached pid and tid, but:
115 // 1. pthread_create gives its children their own pthread_internal_t with the correct pid and tid.
116 // 2. fork uses CLONE_CHILD_SETTID to get the new pid/tid.
117 // 3. The tid is lazily fetched in gettid().
118 // If any other cases become important, we could use a double trampoline like __pthread_start.
119 self->set_cached_pid(parent_pid);
120 self->tid = caller_tid;
121 } else if (self->tid == -1) {
122 self->tid = syscall(__NR_gettid);
123 self->set_cached_pid(self->tid);
124 }
125
126 return clone_result;
127 }
128