make pthread_attr_init honor defaults set by pthread_setattr_default_np
[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 #include <string.h>
7 #include <stddef.h>
8
9 void *__mmap(void *, size_t, int, int, int, off_t);
10 int __munmap(void *, size_t);
11 int __mprotect(void *, size_t, int);
12
13 static void dummy_0()
14 {
15 }
16 weak_alias(dummy_0, __acquire_ptc);
17 weak_alias(dummy_0, __release_ptc);
18 weak_alias(dummy_0, __pthread_tsd_run_dtors);
19 weak_alias(dummy_0, __do_orphaned_stdio_locks);
20 weak_alias(dummy_0, __dl_thread_cleanup);
21
22 static void *dummy_1(void *p)
23 {
24         return 0;
25 }
26 weak_alias(dummy_1, __start_sched);
27
28 _Noreturn void __pthread_exit(void *result)
29 {
30         pthread_t self = __pthread_self();
31         sigset_t set;
32
33         self->canceldisable = 1;
34         self->cancelasync = 0;
35         self->result = result;
36
37         while (self->cancelbuf) {
38                 void (*f)(void *) = self->cancelbuf->__f;
39                 void *x = self->cancelbuf->__x;
40                 self->cancelbuf = self->cancelbuf->__next;
41                 f(x);
42         }
43
44         __pthread_tsd_run_dtors();
45
46         /* Access to target the exiting thread with syscalls that use
47          * its kernel tid is controlled by killlock. For detached threads,
48          * any use past this point would have undefined behavior, but for
49          * joinable threads it's a valid usage that must be handled. */
50         LOCK(self->killlock);
51
52         /* Block all signals before decrementing the live thread count.
53          * This is important to ensure that dynamically allocated TLS
54          * is not under-allocated/over-committed, and possibly for other
55          * reasons as well. */
56         __block_all_sigs(&set);
57
58         /* It's impossible to determine whether this is "the last thread"
59          * until performing the atomic decrement, since multiple threads
60          * could exit at the same time. For the last thread, revert the
61          * decrement, restore the tid, and unblock signals to give the
62          * atexit handlers and stdio cleanup code a consistent state. */
63         if (a_fetch_add(&libc.threads_minus_1, -1)==0) {
64                 libc.threads_minus_1 = 0;
65                 UNLOCK(self->killlock);
66                 __restore_sigs(&set);
67                 exit(0);
68         }
69
70         /* Process robust list in userspace to handle non-pshared mutexes
71          * and the detached thread case where the robust list head will
72          * be invalid when the kernel would process it. */
73         __vm_lock();
74         volatile void *volatile *rp;
75         while ((rp=self->robust_list.head) && rp != &self->robust_list.head) {
76                 pthread_mutex_t *m = (void *)((char *)rp
77                         - offsetof(pthread_mutex_t, _m_next));
78                 int waiters = m->_m_waiters;
79                 int priv = (m->_m_type & 128) ^ 128;
80                 self->robust_list.pending = rp;
81                 self->robust_list.head = *rp;
82                 int cont = a_swap(&m->_m_lock, 0x40000000);
83                 self->robust_list.pending = 0;
84                 if (cont < 0 || waiters)
85                         __wake(&m->_m_lock, 1, priv);
86         }
87         __vm_unlock();
88
89         __do_orphaned_stdio_locks();
90         __dl_thread_cleanup();
91
92         /* This atomic potentially competes with a concurrent pthread_detach
93          * call; the loser is responsible for freeing thread resources. */
94         int state = a_cas(&self->detach_state, DT_JOINABLE, DT_EXITING);
95
96         if (state>=DT_DETACHED && self->map_base) {
97                 /* Detached threads must avoid the kernel clear_child_tid
98                  * feature, since the virtual address will have been
99                  * unmapped and possibly already reused by a new mapping
100                  * at the time the kernel would perform the write. In
101                  * the case of threads that started out detached, the
102                  * initial clone flags are correct, but if the thread was
103                  * detached later, we need to clear it here. */
104                 if (state == DT_DYNAMIC) __syscall(SYS_set_tid_address, 0);
105
106                 /* Robust list will no longer be valid, and was already
107                  * processed above, so unregister it with the kernel. */
108                 if (self->robust_list.off)
109                         __syscall(SYS_set_robust_list, 0, 3*sizeof(long));
110
111                 /* Since __unmapself bypasses the normal munmap code path,
112                  * explicitly wait for vmlock holders first. */
113                 __vm_wait();
114
115                 /* The following call unmaps the thread's stack mapping
116                  * and then exits without touching the stack. */
117                 __unmapself(self->map_base, self->map_size);
118         }
119
120         /* After the kernel thread exits, its tid may be reused. Clear it
121          * to prevent inadvertent use and inform functions that would use
122          * it that it's no longer available. */
123         self->tid = 0;
124         UNLOCK(self->killlock);
125
126         for (;;) __syscall(SYS_exit, 0);
127 }
128
129 void __do_cleanup_push(struct __ptcb *cb)
130 {
131         struct pthread *self = __pthread_self();
132         cb->__next = self->cancelbuf;
133         self->cancelbuf = cb;
134 }
135
136 void __do_cleanup_pop(struct __ptcb *cb)
137 {
138         __pthread_self()->cancelbuf = cb->__next;
139 }
140
141 static int start(void *p)
142 {
143         pthread_t self = p;
144         if (self->unblock_cancel)
145                 __syscall(SYS_rt_sigprocmask, SIG_UNBLOCK,
146                         SIGPT_SET, 0, _NSIG/8);
147         __pthread_exit(self->start(self->start_arg));
148         return 0;
149 }
150
151 static int start_c11(void *p)
152 {
153         pthread_t self = p;
154         int (*start)(void*) = (int(*)(void*)) self->start;
155         __pthread_exit((void *)(uintptr_t)start(self->start_arg));
156         return 0;
157 }
158
159 #define ROUND(x) (((x)+PAGE_SIZE-1)&-PAGE_SIZE)
160
161 /* pthread_key_create.c overrides this */
162 static volatile size_t dummy = 0;
163 weak_alias(dummy, __pthread_tsd_size);
164 static void *dummy_tsd[1] = { 0 };
165 weak_alias(dummy_tsd, __pthread_tsd_main);
166
167 volatile int __block_new_threads = 0;
168 extern size_t __default_stacksize;
169 extern size_t __default_guardsize;
170
171 static FILE *volatile dummy_file = 0;
172 weak_alias(dummy_file, __stdin_used);
173 weak_alias(dummy_file, __stdout_used);
174 weak_alias(dummy_file, __stderr_used);
175
176 static void init_file_lock(FILE *f)
177 {
178         if (f && f->lock<0) f->lock = 0;
179 }
180
181 void *__copy_tls(unsigned char *);
182
183 int __pthread_create(pthread_t *restrict res, const pthread_attr_t *restrict attrp, void *(*entry)(void *), void *restrict arg)
184 {
185         int ret, c11 = (attrp == __ATTRP_C11_THREAD);
186         size_t size, guard;
187         struct pthread *self, *new;
188         unsigned char *map = 0, *stack = 0, *tsd = 0, *stack_limit;
189         unsigned flags = CLONE_VM | CLONE_FS | CLONE_FILES | CLONE_SIGHAND
190                 | CLONE_THREAD | CLONE_SYSVSEM | CLONE_SETTLS
191                 | CLONE_PARENT_SETTID | CLONE_CHILD_CLEARTID | CLONE_DETACHED;
192         int do_sched = 0;
193         pthread_attr_t attr = { 0 };
194         struct start_sched_args ssa;
195
196         if (!libc.can_do_threads) return ENOSYS;
197         self = __pthread_self();
198         if (!libc.threaded) {
199                 for (FILE *f=*__ofl_lock(); f; f=f->next)
200                         init_file_lock(f);
201                 __ofl_unlock();
202                 init_file_lock(__stdin_used);
203                 init_file_lock(__stdout_used);
204                 init_file_lock(__stderr_used);
205                 __syscall(SYS_rt_sigprocmask, SIG_UNBLOCK, SIGPT_SET, 0, _NSIG/8);
206                 self->tsd = (void **)__pthread_tsd_main;
207                 libc.threaded = 1;
208         }
209         if (attrp && !c11) attr = *attrp;
210
211         __acquire_ptc();
212         if (!attrp || c11) {
213                 attr._a_stacksize = __default_stacksize;
214                 attr._a_guardsize = __default_guardsize;
215         }
216
217         if (__block_new_threads) __wait(&__block_new_threads, 0, 1, 1);
218
219         if (attr._a_stackaddr) {
220                 size_t need = libc.tls_size + __pthread_tsd_size;
221                 size = attr._a_stacksize;
222                 stack = (void *)(attr._a_stackaddr & -16);
223                 stack_limit = (void *)(attr._a_stackaddr - size);
224                 /* Use application-provided stack for TLS only when
225                  * it does not take more than ~12% or 2k of the
226                  * application's stack space. */
227                 if (need < size/8 && need < 2048) {
228                         tsd = stack - __pthread_tsd_size;
229                         stack = tsd - libc.tls_size;
230                         memset(stack, 0, need);
231                 } else {
232                         size = ROUND(need);
233                 }
234                 guard = 0;
235         } else {
236                 guard = ROUND(attr._a_guardsize);
237                 size = guard + ROUND(attr._a_stacksize
238                         + libc.tls_size +  __pthread_tsd_size);
239         }
240
241         if (!tsd) {
242                 if (guard) {
243                         map = __mmap(0, size, PROT_NONE, MAP_PRIVATE|MAP_ANON, -1, 0);
244                         if (map == MAP_FAILED) goto fail;
245                         if (__mprotect(map+guard, size-guard, PROT_READ|PROT_WRITE)
246                             && errno != ENOSYS) {
247                                 __munmap(map, size);
248                                 goto fail;
249                         }
250                 } else {
251                         map = __mmap(0, size, PROT_READ|PROT_WRITE, MAP_PRIVATE|MAP_ANON, -1, 0);
252                         if (map == MAP_FAILED) goto fail;
253                 }
254                 tsd = map + size - __pthread_tsd_size;
255                 if (!stack) {
256                         stack = tsd - libc.tls_size;
257                         stack_limit = map + guard;
258                 }
259         }
260
261         new = __copy_tls(tsd - libc.tls_size);
262         new->map_base = map;
263         new->map_size = size;
264         new->stack = stack;
265         new->stack_size = stack - stack_limit;
266         new->guard_size = guard;
267         new->start = entry;
268         new->start_arg = arg;
269         new->self = new;
270         new->tsd = (void *)tsd;
271         new->locale = &libc.global_locale;
272         if (attr._a_detach) {
273                 new->detach_state = DT_DETACHED;
274                 flags -= CLONE_CHILD_CLEARTID;
275         } else {
276                 new->detach_state = DT_JOINABLE;
277         }
278         if (attr._a_sched) {
279                 do_sched = 1;
280                 ssa.futex = -1;
281                 ssa.start_fn = new->start;
282                 ssa.start_arg = new->start_arg;
283                 ssa.attr = &attr;
284                 new->start = __start_sched;
285                 new->start_arg = &ssa;
286                 __block_app_sigs(&ssa.mask);
287         }
288         new->robust_list.head = &new->robust_list.head;
289         new->unblock_cancel = self->cancel;
290         new->CANARY = self->CANARY;
291
292         a_inc(&libc.threads_minus_1);
293         ret = __clone((c11 ? start_c11 : start), stack, flags, new, &new->tid, TP_ADJ(new), &new->detach_state);
294
295         __release_ptc();
296
297         if (do_sched) {
298                 __restore_sigs(&ssa.mask);
299         }
300
301         if (ret < 0) {
302                 a_dec(&libc.threads_minus_1);
303                 if (map) __munmap(map, size);
304                 return EAGAIN;
305         }
306
307         if (do_sched) {
308                 __futexwait(&ssa.futex, -1, 1);
309                 if (ret) return ret;
310         }
311
312         *res = new;
313         return 0;
314 fail:
315         __release_ptc();
316         return EAGAIN;
317 }
318
319 weak_alias(__pthread_exit, pthread_exit);
320 weak_alias(__pthread_create, pthread_create);