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