use symbolic names for clone flags in pthread_create
[musl] / src / thread / pthread_create.c
1 #define _GNU_SOURCE
2 #include "pthread_impl.h"
3 #include "stdio_impl.h"
4 #include "libc.h"
5 #include <sys/mman.h>
6
7 static void dummy_0()
8 {
9 }
10 weak_alias(dummy_0, __acquire_ptc);
11 weak_alias(dummy_0, __release_ptc);
12 weak_alias(dummy_0, __pthread_tsd_run_dtors);
13
14 _Noreturn void pthread_exit(void *result)
15 {
16         pthread_t self = pthread_self();
17         sigset_t set;
18
19         self->result = result;
20
21         while (self->cancelbuf) {
22                 void (*f)(void *) = self->cancelbuf->__f;
23                 void *x = self->cancelbuf->__x;
24                 self->cancelbuf = self->cancelbuf->__next;
25                 f(x);
26         }
27
28         __pthread_tsd_run_dtors();
29
30         __lock(self->exitlock);
31
32         /* Mark this thread dead before decrementing count */
33         __lock(self->killlock);
34         self->dead = 1;
35
36         /* Block all signals before decrementing the live thread count.
37          * This is important to ensure that dynamically allocated TLS
38          * is not under-allocated/over-committed, and possibly for other
39          * reasons as well. */
40         __block_all_sigs(&set);
41
42         /* Wait to unlock the kill lock, which governs functions like
43          * pthread_kill which target a thread id, until signals have
44          * been blocked. This precludes observation of the thread id
45          * as a live thread (with application code running in it) after
46          * the thread was reported dead by ESRCH being returned. */
47         __unlock(self->killlock);
48
49         /* It's impossible to determine whether this is "the last thread"
50          * until performing the atomic decrement, since multiple threads
51          * could exit at the same time. For the last thread, revert the
52          * decrement and unblock signals to give the atexit handlers and
53          * stdio cleanup code a consistent state. */
54         if (a_fetch_add(&libc.threads_minus_1, -1)==0) {
55                 libc.threads_minus_1 = 0;
56                 __restore_sigs(&set);
57                 exit(0);
58         }
59
60         if (self->detached && self->map_base) {
61                 /* Detached threads must avoid the kernel clear_child_tid
62                  * feature, since the virtual address will have been
63                  * unmapped and possibly already reused by a new mapping
64                  * at the time the kernel would perform the write. In
65                  * the case of threads that started out detached, the
66                  * initial clone flags are correct, but if the thread was
67                  * detached later (== 2), we need to clear it here. */
68                 if (self->detached == 2) __syscall(SYS_set_tid_address, 0);
69
70                 /* The following call unmaps the thread's stack mapping
71                  * and then exits without touching the stack. */
72                 __unmapself(self->map_base, self->map_size);
73         }
74
75         for (;;) __syscall(SYS_exit, 0);
76 }
77
78 void __do_cleanup_push(struct __ptcb *cb)
79 {
80         struct pthread *self = pthread_self();
81         cb->__next = self->cancelbuf;
82         self->cancelbuf = cb;
83 }
84
85 void __do_cleanup_pop(struct __ptcb *cb)
86 {
87         __pthread_self()->cancelbuf = cb->__next;
88 }
89
90 static int start(void *p)
91 {
92         pthread_t self = p;
93         if (self->startlock[0]) {
94                 __wait(self->startlock, 0, 1, 1);
95                 if (self->startlock[0]) {
96                         self->detached = 2;
97                         pthread_exit(0);
98                 }
99                 __restore_sigs(self->sigmask);
100         }
101         if (self->unblock_cancel)
102                 __syscall(SYS_rt_sigprocmask, SIG_UNBLOCK,
103                         SIGPT_SET, 0, _NSIG/8);
104         pthread_exit(self->start(self->start_arg));
105         return 0;
106 }
107
108 #define ROUND(x) (((x)+PAGE_SIZE-1)&-PAGE_SIZE)
109
110 /* pthread_key_create.c overrides this */
111 static const size_t dummy = 0;
112 weak_alias(dummy, __pthread_tsd_size);
113
114 static FILE *const dummy_file = 0;
115 weak_alias(dummy_file, __stdin_used);
116 weak_alias(dummy_file, __stdout_used);
117 weak_alias(dummy_file, __stderr_used);
118
119 static void init_file_lock(FILE *f)
120 {
121         if (f && f->lock<0) f->lock = 0;
122 }
123
124 void *__copy_tls(unsigned char *);
125
126 int pthread_create(pthread_t *restrict res, const pthread_attr_t *restrict attrp, void *(*entry)(void *), void *restrict arg)
127 {
128         int ret;
129         size_t size, guard;
130         struct pthread *self = pthread_self(), *new;
131         unsigned char *map = 0, *stack = 0, *tsd = 0, *stack_limit;
132         unsigned flags = CLONE_VM | CLONE_FS | CLONE_FILES | CLONE_SIGHAND
133                 | CLONE_PARENT | CLONE_THREAD | CLONE_SYSVSEM | CLONE_SETTLS
134                 | CLONE_PARENT_SETTID | CLONE_CHILD_CLEARTID | CLONE_DETACHED;
135         int do_sched = 0;
136         pthread_attr_t attr = {0};
137
138         if (!self) return ENOSYS;
139         if (!libc.threaded) {
140                 for (FILE *f=libc.ofl_head; f; f=f->next)
141                         init_file_lock(f);
142                 init_file_lock(__stdin_used);
143                 init_file_lock(__stdout_used);
144                 init_file_lock(__stderr_used);
145                 libc.threaded = 1;
146         }
147         if (attrp) attr = *attrp;
148
149         __acquire_ptc();
150
151         if (attr._a_stackaddr) {
152                 size_t need = libc.tls_size + __pthread_tsd_size;
153                 size = attr._a_stacksize + DEFAULT_STACK_SIZE;
154                 stack = (void *)(attr._a_stackaddr & -16);
155                 stack_limit = (void *)(attr._a_stackaddr - size);
156                 /* Use application-provided stack for TLS only when
157                  * it does not take more than ~12% or 2k of the
158                  * application's stack space. */
159                 if (need < size/8 && need < 2048) {
160                         tsd = stack - __pthread_tsd_size;
161                         stack = tsd - libc.tls_size;
162                 } else {
163                         size = ROUND(need);
164                         guard = 0;
165                 }
166         } else {
167                 guard = ROUND(DEFAULT_GUARD_SIZE + attr._a_guardsize);
168                 size = guard + ROUND(DEFAULT_STACK_SIZE + attr._a_stacksize
169                         + libc.tls_size +  __pthread_tsd_size);
170         }
171
172         if (!tsd) {
173                 if (guard) {
174                         map = mmap(0, size, PROT_NONE, MAP_PRIVATE|MAP_ANON, -1, 0);
175                         if (map == MAP_FAILED) goto fail;
176                         if (mprotect(map+guard, size-guard, PROT_READ|PROT_WRITE)) {
177                                 munmap(map, size);
178                                 goto fail;
179                         }
180                 } else {
181                         map = mmap(0, size, PROT_READ|PROT_WRITE, MAP_PRIVATE|MAP_ANON, -1, 0);
182                         if (map == MAP_FAILED) goto fail;
183                 }
184                 tsd = map + size - __pthread_tsd_size;
185                 if (!stack) {
186                         stack = tsd - libc.tls_size;
187                         stack_limit = map + guard;
188                 }
189         }
190
191         new = __copy_tls(tsd - libc.tls_size);
192         new->map_base = map;
193         new->map_size = size;
194         new->stack = stack;
195         new->stack_size = stack - stack_limit;
196         new->pid = self->pid;
197         new->errno_ptr = &new->errno_val;
198         new->start = entry;
199         new->start_arg = arg;
200         new->self = new;
201         new->tsd = (void *)tsd;
202         if (attr._a_detach) {
203                 new->detached = 1;
204                 flags -= CLONE_CHILD_CLEARTID;
205         }
206         if (attr._a_sched) {
207                 do_sched = new->startlock[0] = 1;
208                 __block_app_sigs(new->sigmask);
209         }
210         new->unblock_cancel = self->cancel;
211         new->canary = self->canary;
212
213         a_inc(&libc.threads_minus_1);
214         ret = __clone(start, stack, flags, new, &new->tid, TP_ADJ(new), &new->tid);
215
216         __release_ptc();
217
218         if (do_sched) {
219                 __restore_sigs(new->sigmask);
220         }
221
222         if (ret < 0) {
223                 a_dec(&libc.threads_minus_1);
224                 if (map) munmap(map, size);
225                 return EAGAIN;
226         }
227
228         if (do_sched) {
229                 ret = __syscall(SYS_sched_setscheduler, new->tid,
230                         attr._a_policy, &attr._a_prio);
231                 a_store(new->startlock, ret<0 ? 2 : 0);
232                 __wake(new->startlock, 1, 1);
233                 if (ret < 0) return -ret;
234         }
235
236         *res = new;
237         return 0;
238 fail:
239         __release_ptc();
240         return EAGAIN;
241 }