pthread_exit: don't __vm_wait under thread list lock
[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 "lock.h"
6 #include <sys/mman.h>
7 #include <string.h>
8 #include <stddef.h>
9
10 static void dummy_0()
11 {
12 }
13 weak_alias(dummy_0, __acquire_ptc);
14 weak_alias(dummy_0, __release_ptc);
15 weak_alias(dummy_0, __pthread_tsd_run_dtors);
16 weak_alias(dummy_0, __do_orphaned_stdio_locks);
17 weak_alias(dummy_0, __dl_thread_cleanup);
18 weak_alias(dummy_0, __membarrier_init);
19
20 static int tl_lock_count;
21 static int tl_lock_waiters;
22
23 void __tl_lock(void)
24 {
25         int tid = __pthread_self()->tid;
26         int val = __thread_list_lock;
27         if (val == tid) {
28                 tl_lock_count++;
29                 return;
30         }
31         while ((val = a_cas(&__thread_list_lock, 0, tid)))
32                 __wait(&__thread_list_lock, &tl_lock_waiters, val, 0);
33 }
34
35 void __tl_unlock(void)
36 {
37         if (tl_lock_count) {
38                 tl_lock_count--;
39                 return;
40         }
41         a_store(&__thread_list_lock, 0);
42         if (tl_lock_waiters) __wake(&__thread_list_lock, 1, 0);
43 }
44
45 void __tl_sync(pthread_t td)
46 {
47         a_barrier();
48         int val = __thread_list_lock;
49         if (!val) return;
50         __wait(&__thread_list_lock, &tl_lock_waiters, val, 0);
51         if (tl_lock_waiters) __wake(&__thread_list_lock, 1, 0);
52 }
53
54 _Noreturn void __pthread_exit(void *result)
55 {
56         pthread_t self = __pthread_self();
57         sigset_t set;
58
59         self->canceldisable = 1;
60         self->cancelasync = 0;
61         self->result = result;
62
63         while (self->cancelbuf) {
64                 void (*f)(void *) = self->cancelbuf->__f;
65                 void *x = self->cancelbuf->__x;
66                 self->cancelbuf = self->cancelbuf->__next;
67                 f(x);
68         }
69
70         __pthread_tsd_run_dtors();
71
72         __block_app_sigs(&set);
73
74         /* This atomic potentially competes with a concurrent pthread_detach
75          * call; the loser is responsible for freeing thread resources. */
76         int state = a_cas(&self->detach_state, DT_JOINABLE, DT_EXITING);
77
78         if (state==DT_DETACHED && self->map_base) {
79                 /* Since __unmapself bypasses the normal munmap code path,
80                  * explicitly wait for vmlock holders first. This must be
81                  * done before any locks are taken, to avoid lock ordering
82                  * issues that could lead to deadlock. */
83                 __vm_wait();
84         }
85
86         /* Access to target the exiting thread with syscalls that use
87          * its kernel tid is controlled by killlock. For detached threads,
88          * any use past this point would have undefined behavior, but for
89          * joinable threads it's a valid usage that must be handled.
90          * Signals must be blocked since pthread_kill must be AS-safe. */
91         LOCK(self->killlock);
92
93         /* The thread list lock must be AS-safe, and thus depends on
94          * application signals being blocked above. */
95         __tl_lock();
96
97         /* If this is the only thread in the list, don't proceed with
98          * termination of the thread, but restore the previous lock and
99          * signal state to prepare for exit to call atexit handlers. */
100         if (self->next == self) {
101                 __tl_unlock();
102                 UNLOCK(self->killlock);
103                 self->detach_state = state;
104                 __restore_sigs(&set);
105                 exit(0);
106         }
107
108         /* At this point we are committed to thread termination. */
109
110         /* Process robust list in userspace to handle non-pshared mutexes
111          * and the detached thread case where the robust list head will
112          * be invalid when the kernel would process it. */
113         __vm_lock();
114         volatile void *volatile *rp;
115         while ((rp=self->robust_list.head) && rp != &self->robust_list.head) {
116                 pthread_mutex_t *m = (void *)((char *)rp
117                         - offsetof(pthread_mutex_t, _m_next));
118                 int waiters = m->_m_waiters;
119                 int priv = (m->_m_type & 128) ^ 128;
120                 self->robust_list.pending = rp;
121                 self->robust_list.head = *rp;
122                 int cont = a_swap(&m->_m_lock, 0x40000000);
123                 self->robust_list.pending = 0;
124                 if (cont < 0 || waiters)
125                         __wake(&m->_m_lock, 1, priv);
126         }
127         __vm_unlock();
128
129         __do_orphaned_stdio_locks();
130         __dl_thread_cleanup();
131
132         /* Last, unlink thread from the list. This change will not be visible
133          * until the lock is released, which only happens after SYS_exit
134          * has been called, via the exit futex address pointing at the lock.
135          * This needs to happen after any possible calls to LOCK() that might
136          * skip locking if process appears single-threaded. */
137         if (!--libc.threads_minus_1) libc.need_locks = -1;
138         self->next->prev = self->prev;
139         self->prev->next = self->next;
140         self->prev = self->next = self;
141
142         if (state==DT_DETACHED && self->map_base) {
143                 /* Detached threads must block even implementation-internal
144                  * signals, since they will not have a stack in their last
145                  * moments of existence. */
146                 __block_all_sigs(&set);
147
148                 /* Robust list will no longer be valid, and was already
149                  * processed above, so unregister it with the kernel. */
150                 if (self->robust_list.off)
151                         __syscall(SYS_set_robust_list, 0, 3*sizeof(long));
152
153                 /* The following call unmaps the thread's stack mapping
154                  * and then exits without touching the stack. */
155                 __unmapself(self->map_base, self->map_size);
156         }
157
158         /* Wake any joiner. */
159         __wake(&self->detach_state, 1, 1);
160
161         /* After the kernel thread exits, its tid may be reused. Clear it
162          * to prevent inadvertent use and inform functions that would use
163          * it that it's no longer available. */
164         self->tid = 0;
165         UNLOCK(self->killlock);
166
167         for (;;) __syscall(SYS_exit, 0);
168 }
169
170 void __do_cleanup_push(struct __ptcb *cb)
171 {
172         struct pthread *self = __pthread_self();
173         cb->__next = self->cancelbuf;
174         self->cancelbuf = cb;
175 }
176
177 void __do_cleanup_pop(struct __ptcb *cb)
178 {
179         __pthread_self()->cancelbuf = cb->__next;
180 }
181
182 struct start_args {
183         void *(*start_func)(void *);
184         void *start_arg;
185         volatile int control;
186         unsigned long sig_mask[_NSIG/8/sizeof(long)];
187 };
188
189 static int start(void *p)
190 {
191         struct start_args *args = p;
192         int state = args->control;
193         if (state) {
194                 if (a_cas(&args->control, 1, 2)==1)
195                         __wait(&args->control, 0, 2, 1);
196                 if (args->control) {
197                         __syscall(SYS_set_tid_address, &args->control);
198                         for (;;) __syscall(SYS_exit, 0);
199                 }
200         }
201         __syscall(SYS_rt_sigprocmask, SIG_SETMASK, &args->sig_mask, 0, _NSIG/8);
202         __pthread_exit(args->start_func(args->start_arg));
203         return 0;
204 }
205
206 static int start_c11(void *p)
207 {
208         struct start_args *args = p;
209         int (*start)(void*) = (int(*)(void*)) args->start_func;
210         __pthread_exit((void *)(uintptr_t)start(args->start_arg));
211         return 0;
212 }
213
214 #define ROUND(x) (((x)+PAGE_SIZE-1)&-PAGE_SIZE)
215
216 /* pthread_key_create.c overrides this */
217 static volatile size_t dummy = 0;
218 weak_alias(dummy, __pthread_tsd_size);
219 static void *dummy_tsd[1] = { 0 };
220 weak_alias(dummy_tsd, __pthread_tsd_main);
221
222 static FILE *volatile dummy_file = 0;
223 weak_alias(dummy_file, __stdin_used);
224 weak_alias(dummy_file, __stdout_used);
225 weak_alias(dummy_file, __stderr_used);
226
227 static void init_file_lock(FILE *f)
228 {
229         if (f && f->lock<0) f->lock = 0;
230 }
231
232 int __pthread_create(pthread_t *restrict res, const pthread_attr_t *restrict attrp, void *(*entry)(void *), void *restrict arg)
233 {
234         int ret, c11 = (attrp == __ATTRP_C11_THREAD);
235         size_t size, guard;
236         struct pthread *self, *new;
237         unsigned char *map = 0, *stack = 0, *tsd = 0, *stack_limit;
238         unsigned flags = CLONE_VM | CLONE_FS | CLONE_FILES | CLONE_SIGHAND
239                 | CLONE_THREAD | CLONE_SYSVSEM | CLONE_SETTLS
240                 | CLONE_PARENT_SETTID | CLONE_CHILD_CLEARTID | CLONE_DETACHED;
241         pthread_attr_t attr = { 0 };
242         sigset_t set;
243
244         if (!libc.can_do_threads) return ENOSYS;
245         self = __pthread_self();
246         if (!libc.threaded) {
247                 for (FILE *f=*__ofl_lock(); f; f=f->next)
248                         init_file_lock(f);
249                 __ofl_unlock();
250                 init_file_lock(__stdin_used);
251                 init_file_lock(__stdout_used);
252                 init_file_lock(__stderr_used);
253                 __syscall(SYS_rt_sigprocmask, SIG_UNBLOCK, SIGPT_SET, 0, _NSIG/8);
254                 self->tsd = (void **)__pthread_tsd_main;
255                 __membarrier_init();
256                 libc.threaded = 1;
257         }
258         if (attrp && !c11) attr = *attrp;
259
260         __acquire_ptc();
261         if (!attrp || c11) {
262                 attr._a_stacksize = __default_stacksize;
263                 attr._a_guardsize = __default_guardsize;
264         }
265
266         if (attr._a_stackaddr) {
267                 size_t need = libc.tls_size + __pthread_tsd_size;
268                 size = attr._a_stacksize;
269                 stack = (void *)(attr._a_stackaddr & -16);
270                 stack_limit = (void *)(attr._a_stackaddr - size);
271                 /* Use application-provided stack for TLS only when
272                  * it does not take more than ~12% or 2k of the
273                  * application's stack space. */
274                 if (need < size/8 && need < 2048) {
275                         tsd = stack - __pthread_tsd_size;
276                         stack = tsd - libc.tls_size;
277                         memset(stack, 0, need);
278                 } else {
279                         size = ROUND(need);
280                 }
281                 guard = 0;
282         } else {
283                 guard = ROUND(attr._a_guardsize);
284                 size = guard + ROUND(attr._a_stacksize
285                         + libc.tls_size +  __pthread_tsd_size);
286         }
287
288         if (!tsd) {
289                 if (guard) {
290                         map = __mmap(0, size, PROT_NONE, MAP_PRIVATE|MAP_ANON, -1, 0);
291                         if (map == MAP_FAILED) goto fail;
292                         if (__mprotect(map+guard, size-guard, PROT_READ|PROT_WRITE)
293                             && errno != ENOSYS) {
294                                 __munmap(map, size);
295                                 goto fail;
296                         }
297                 } else {
298                         map = __mmap(0, size, PROT_READ|PROT_WRITE, MAP_PRIVATE|MAP_ANON, -1, 0);
299                         if (map == MAP_FAILED) goto fail;
300                 }
301                 tsd = map + size - __pthread_tsd_size;
302                 if (!stack) {
303                         stack = tsd - libc.tls_size;
304                         stack_limit = map + guard;
305                 }
306         }
307
308         new = __copy_tls(tsd - libc.tls_size);
309         new->map_base = map;
310         new->map_size = size;
311         new->stack = stack;
312         new->stack_size = stack - stack_limit;
313         new->guard_size = guard;
314         new->self = new;
315         new->tsd = (void *)tsd;
316         new->locale = &libc.global_locale;
317         if (attr._a_detach) {
318                 new->detach_state = DT_DETACHED;
319         } else {
320                 new->detach_state = DT_JOINABLE;
321         }
322         new->robust_list.head = &new->robust_list.head;
323         new->canary = self->canary;
324         new->sysinfo = self->sysinfo;
325
326         /* Setup argument structure for the new thread on its stack.
327          * It's safe to access from the caller only until the thread
328          * list is unlocked. */
329         stack -= (uintptr_t)stack % sizeof(uintptr_t);
330         stack -= sizeof(struct start_args);
331         struct start_args *args = (void *)stack;
332         args->start_func = entry;
333         args->start_arg = arg;
334         args->control = attr._a_sched ? 1 : 0;
335
336         /* Application signals (but not the synccall signal) must be
337          * blocked before the thread list lock can be taken, to ensure
338          * that the lock is AS-safe. */
339         __block_app_sigs(&set);
340
341         /* Ensure SIGCANCEL is unblocked in new thread. This requires
342          * working with a copy of the set so we can restore the
343          * original mask in the calling thread. */
344         memcpy(&args->sig_mask, &set, sizeof args->sig_mask);
345         args->sig_mask[(SIGCANCEL-1)/8/sizeof(long)] &=
346                 ~(1UL<<((SIGCANCEL-1)%(8*sizeof(long))));
347
348         __tl_lock();
349         if (!libc.threads_minus_1++) libc.need_locks = 1;
350         ret = __clone((c11 ? start_c11 : start), stack, flags, args, &new->tid, TP_ADJ(new), &__thread_list_lock);
351
352         /* All clone failures translate to EAGAIN. If explicit scheduling
353          * was requested, attempt it before unlocking the thread list so
354          * that the failed thread is never exposed and so that we can
355          * clean up all transient resource usage before returning. */
356         if (ret < 0) {
357                 ret = -EAGAIN;
358         } else if (attr._a_sched) {
359                 ret = __syscall(SYS_sched_setscheduler,
360                         new->tid, attr._a_policy, &attr._a_prio);
361                 if (a_swap(&args->control, ret ? 3 : 0)==2)
362                         __wake(&args->control, 1, 1);
363                 if (ret)
364                         __wait(&args->control, 0, 3, 0);
365         }
366
367         if (ret >= 0) {
368                 new->next = self->next;
369                 new->prev = self;
370                 new->next->prev = new;
371                 new->prev->next = new;
372         } else {
373                 if (!--libc.threads_minus_1) libc.need_locks = 0;
374         }
375         __tl_unlock();
376         __restore_sigs(&set);
377         __release_ptc();
378
379         if (ret < 0) {
380                 if (map) __munmap(map, size);
381                 return -ret;
382         }
383
384         *res = new;
385         return 0;
386 fail:
387         __release_ptc();
388         return EAGAIN;
389 }
390
391 weak_alias(__pthread_exit, pthread_exit);
392 weak_alias(__pthread_create, pthread_create);