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