1 /*
2  * Copyright (c) 2003 Daniel M. Eischen <deischen@freebsd.org>
3  * Copyright (c) 1995-1998 John Birrell <jb@cimlogic.com.au>
4  * All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  * 1. Redistributions of source code must retain the above copyright
10  *    notice, this list of conditions and the following disclaimer.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  *    notice, this list of conditions and the following disclaimer in the
13  *    documentation and/or other materials provided with the distribution.
14  * 3. All advertising materials mentioning features or use of this software
15  *    must display the following acknowledgement:
16  *	This product includes software developed by John Birrell.
17  * 4. Neither the name of the author nor the names of any co-contributors
18  *    may be used to endorse or promote products derived from this software
19  *    without specific prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY JOHN BIRRELL AND CONTRIBUTORS ``AS IS'' AND
22  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
25  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31  * SUCH DAMAGE.
32  */
33 
34 #include "namespace.h"
35 #include <sys/param.h>
36 #include <sys/signalvar.h>
37 #include <sys/ioctl.h>
38 #include <sys/sysctl.h>
39 #include <sys/time.h>
40 #include <sys/ttycom.h>
41 #include <sys/mman.h>
42 #include <stdio.h>
43 #include <fcntl.h>
44 #include <paths.h>
45 #include <pthread.h>
46 #include <signal.h>
47 #include <stdlib.h>
48 #include <string.h>
49 #include <unistd.h>
50 #include "un-namespace.h"
51 
52 #include "libc_private.h"
53 #include "thr_private.h"
54 
55 /* Default thread attributes: */
56 struct pthread_attr _pthread_attr_default = {
57 	.sched_policy = SCHED_OTHER,
58 	.sched_inherit = 0,
59 	.prio = THR_DEFAULT_PRIORITY,
60 	.suspend = THR_CREATE_RUNNING,
61 	.flags = PTHREAD_SCOPE_SYSTEM,
62 	.stackaddr_attr = NULL,
63 	.stacksize_attr = THR_STACK_DEFAULT,
64 	.guardsize_attr = 0
65 };
66 
67 /* Default mutex attributes: */
68 struct pthread_mutex_attr _pthread_mutexattr_default = {
69 	.m_type = PTHREAD_MUTEX_DEFAULT,
70 	.m_protocol = PTHREAD_PRIO_NONE,
71 	.m_ceiling = 0,
72 	.m_flags = 0
73 };
74 
75 /* Default condition variable attributes: */
76 struct pthread_cond_attr _pthread_condattr_default = {
77 	.c_pshared = PTHREAD_PROCESS_PRIVATE,
78 	.c_clockid = CLOCK_REALTIME
79 };
80 
81 /* thr_attr.c */
82 STATIC_LIB_REQUIRE(_pthread_attr_init);
83 /* thr_barrier.c */
84 STATIC_LIB_REQUIRE(_pthread_barrier_init);
85 /* thr_barrierattr.c */
86 STATIC_LIB_REQUIRE(_pthread_barrierattr_init);
87 /* thr_cancel.c */
88 STATIC_LIB_REQUIRE(_pthread_cancel);
89 /* thr_clean.c */
90 STATIC_LIB_REQUIRE(_pthread_cleanup_push);
91 /* thr_concurrency.c */
92 STATIC_LIB_REQUIRE(_pthread_getconcurrency);
93 STATIC_LIB_REQUIRE(_pthread_setconcurrency);
94 /* thr_cond.c */
95 STATIC_LIB_REQUIRE(_pthread_cond_init);
96 /* thr_condattr.c */
97 STATIC_LIB_REQUIRE(_pthread_condattr_init);
98 /* thr_create.c */
99 STATIC_LIB_REQUIRE(_pthread_create);
100 /* thr_detach.c */
101 STATIC_LIB_REQUIRE(_pthread_detach);
102 /* thr_equal.c */
103 STATIC_LIB_REQUIRE(_pthread_equal);
104 /* thr_exit.c */
105 STATIC_LIB_REQUIRE(_pthread_exit);
106 /* thr_fork.c */
107 STATIC_LIB_REQUIRE(_pthread_atfork);
108 STATIC_LIB_REQUIRE(_fork);
109 /* thr_affinity.c */
110 STATIC_LIB_REQUIRE(_pthread_getaffinity_np);
111 /* thr_getcpuclockid.c */
112 STATIC_LIB_REQUIRE(_pthread_getcpuclockid);
113 /* thr_getprio.c */
114 STATIC_LIB_REQUIRE(_pthread_getprio);
115 /* thr_getschedparam.c */
116 STATIC_LIB_REQUIRE(_pthread_getschedparam);
117 /* thr_getthreadid_np.c */
118 STATIC_LIB_REQUIRE(_pthread_getthreadid_np);
119 /* thr_info.c */
120 STATIC_LIB_REQUIRE(_pthread_get_name_np);
121 /* thr_info.c */
122 STATIC_LIB_REQUIRE(_pthread_set_name_np);
123 /* thr_init.c */
124 STATIC_LIB_REQUIRE(_pthread_init_early);
125 /* thr_join.c */
126 STATIC_LIB_REQUIRE(_pthread_join);
127 /* thr_kill.c */
128 STATIC_LIB_REQUIRE(_pthread_kill);
129 /* thr_main_np.c */
130 STATIC_LIB_REQUIRE(_pthread_main_np);
131 /* thr_multi_np.c */
132 STATIC_LIB_REQUIRE(_pthread_multi_np);
133 /* thr_mutex.c */
134 STATIC_LIB_REQUIRE(_pthread_mutex_init);
135 /* thr_mutex_prioceiling.c */
136 STATIC_LIB_REQUIRE(_pthread_mutexattr_getprioceiling);
137 /* thr_mutex_protocol.c */
138 STATIC_LIB_REQUIRE(_pthread_mutexattr_getprotocol);
139 /* thr_mutexattr.c */
140 STATIC_LIB_REQUIRE(_pthread_mutexattr_init);
141 /* thr_once.c */
142 STATIC_LIB_REQUIRE(_pthread_once);
143 /* thr_pspinlock.c */
144 STATIC_LIB_REQUIRE(_pthread_spin_init);
145 /* thr_resume_np.c */
146 STATIC_LIB_REQUIRE(_pthread_resume_np);
147 /* thr_rwlock.c */
148 STATIC_LIB_REQUIRE(_pthread_rwlock_init);
149 /* thr_rwlockattr.c */
150 STATIC_LIB_REQUIRE(_pthread_rwlockattr_init);
151 /* thr_self.c */
152 STATIC_LIB_REQUIRE(_pthread_self);
153 /* thr_sem.c */
154 STATIC_LIB_REQUIRE(_sem_init);
155 /* thr_affinity.c */
156 STATIC_LIB_REQUIRE(_pthread_setaffinity_np);
157 /* thr_setprio.c */
158 STATIC_LIB_REQUIRE(_pthread_setprio);
159 /* thr_setschedparam.c */
160 STATIC_LIB_REQUIRE(_pthread_setschedparam);
161 /* thr_sig.c */
162 STATIC_LIB_REQUIRE(_sigwait);
163 /* thr_single_np.c */
164 STATIC_LIB_REQUIRE(_pthread_single_np);
165 /* thr_spec.c */
166 STATIC_LIB_REQUIRE(_pthread_key_create);
167 /* thr_spinlock.c */
168 STATIC_LIB_REQUIRE(_spinlock);
169 /* thr_suspend_np.c */
170 STATIC_LIB_REQUIRE(_pthread_suspend_np);
171 /* thr_switch_np.c */
172 STATIC_LIB_REQUIRE(_pthread_switch_add_np);
173 /* thr_symbols.c */
174 STATIC_LIB_REQUIRE(_thread_state_running);
175 /* thr_syscalls.c */
176 STATIC_LIB_REQUIRE(__wait4);
177 /* thr_yield.c */
178 STATIC_LIB_REQUIRE(_pthread_yield);
179 
180 char		*_usrstack;
181 struct pthread	*_thr_initial;
182 static void	*_thr_main_redzone;
183 
184 pid_t		_thr_pid;
185 size_t		_thr_guard_default;
186 size_t		_thr_stack_default =	THR_STACK_DEFAULT;
187 size_t		_thr_stack_initial =	THR_STACK_INITIAL;
188 int		_thr_page_size;
189 
190 static void	init_private(void);
191 static void	_libpthread_uninit(void);
192 static void	init_main_thread(struct pthread *thread);
193 
194 void	_thread_init(void) __attribute__ ((constructor));
195 void
196 _thread_init(void)
197 {
198 	_libpthread_init(NULL);
199 	_libc_thr_init();
200 }
201 
202 void	_thread_uninit(void) __attribute__ ((destructor));
203 void
204 _thread_uninit(void)
205 {
206 	_libpthread_uninit();
207 }
208 
209 /*
210  * This function is used by libc to initialise libpthread
211  * early during dynamic linking.
212  */
213 void _pthread_init_early(void);
214 void
215 _pthread_init_early(void)
216 {
217 	_libpthread_init(NULL);
218 }
219 
220 /*
221  * Threaded process initialization.
222  *
223  * This is only called under two conditions:
224  *
225  *   1) Some thread routines have detected that the library hasn't yet
226  *      been initialized (_thr_initial == NULL && curthread == NULL), or
227  *
228  *   2) An explicit call to reinitialize after a fork (indicated
229  *      by curthread != NULL)
230  */
231 void
232 _libpthread_init(struct pthread *curthread)
233 {
234 	int fd, first = 0;
235 	sigset_t sigset, oldset;
236 
237 	/* Check if this function has already been called: */
238 	if ((_thr_initial != NULL) && (curthread == NULL))
239 		/* Only initialize the threaded application once. */
240 		return;
241 
242 	/*
243 	 * Check for the special case of this process running as
244 	 * or in place of init as pid = 1:
245 	 */
246 	if ((_thr_pid = getpid()) == 1) {
247 		/*
248 		 * Setup a new session for this process which is
249 		 * assumed to be running as root.
250 		 */
251 		if (setsid() == -1)
252 			PANIC("Can't set session ID");
253 		if (revoke(_PATH_CONSOLE) != 0)
254 			PANIC("Can't revoke console");
255 		if ((fd = __sys_open(_PATH_CONSOLE, O_RDWR)) < 0)
256 			PANIC("Can't open console");
257 		if (setlogin("root") == -1)
258 			PANIC("Can't set login to root");
259 		if (__sys_ioctl(fd, TIOCSCTTY, NULL) == -1)
260 			PANIC("Can't set controlling terminal");
261 	}
262 
263 	/* Initialize pthread private data. */
264 	init_private();
265 
266 	/* Set the initial thread. */
267 	if (curthread == NULL) {
268 		first = 1;
269 		/* Create and initialize the initial thread. */
270 		curthread = _thr_alloc(NULL);
271 		if (curthread == NULL)
272 			PANIC("Can't allocate initial thread");
273 		init_main_thread(curthread);
274 	}
275 	/*
276 	 * Add the thread to the thread list queue.
277 	 */
278 	THR_LIST_ADD(curthread);
279 	_thread_active_threads = 1;
280 
281 	/* Setup the thread specific data */
282 	tls_set_tcb(curthread->tcb);
283 
284 	if (first) {
285 		SIGFILLSET(sigset);
286 		__sys_sigprocmask(SIG_SETMASK, &sigset, &oldset);
287 		_thr_signal_init();
288 		_thr_initial = curthread;
289 		SIGDELSET(oldset, SIGCANCEL);
290 		__sys_sigprocmask(SIG_SETMASK, &oldset, NULL);
291 		if (td_eventismember(&_thread_event_mask, TD_CREATE))
292 			_thr_report_creation(curthread, curthread);
293 		_thr_rtld_init();
294 		_thr_malloc_init();
295 		_thr_sem_init();
296 	}
297 }
298 
299 static void
300 _libpthread_uninit(void)
301 {
302 	if (_thr_initial == NULL)
303 		return;
304 	if (_thr_main_redzone && _thr_main_redzone != MAP_FAILED) {
305 		munmap(_thr_main_redzone, _thr_guard_default);
306 		_thr_main_redzone = NULL;
307 	}
308 	_thr_stack_cleanup();
309 }
310 
311 /*
312  * This function and pthread_create() do a lot of the same things.
313  * It'd be nice to consolidate the common stuff in one place.
314  */
315 static void
316 init_main_thread(struct pthread *thread)
317 {
318 	/* Setup the thread attributes. */
319 	thread->tid = _thr_get_tid();
320 	thread->attr = _pthread_attr_default;
321 	/*
322 	 * Set up the thread stack.
323 	 *
324 	 * Create a red zone below the main stack.  All other stacks
325 	 * are constrained to a maximum size by the parameters
326 	 * passed to mmap(), but this stack is only limited by
327 	 * resource limits, so this stack needs an explicitly mapped
328 	 * red zone to protect the thread stack that is just beyond.
329 	 */
330 	_thr_main_redzone = mmap(_usrstack - _thr_stack_initial -
331 				 _thr_guard_default, _thr_guard_default,
332 				 0, MAP_ANON | MAP_TRYFIXED, -1, 0);
333 	if (_thr_main_redzone == MAP_FAILED) {
334 		PANIC("Cannot allocate red zone for initial thread");
335 	}
336 
337 	/*
338 	 * Mark the stack as an application supplied stack so that it
339 	 * isn't deallocated.
340 	 *
341 	 * XXX - I'm not sure it would hurt anything to deallocate
342 	 *       the main thread stack because deallocation doesn't
343 	 *       actually free() it; it just puts it in the free
344 	 *       stack queue for later reuse.
345 	 */
346 	thread->attr.stackaddr_attr = _usrstack - _thr_stack_initial;
347 	thread->attr.stacksize_attr = _thr_stack_initial;
348 	thread->attr.guardsize_attr = _thr_guard_default;
349 	thread->attr.flags |= THR_STACK_USER;
350 
351 	/*
352 	 * Write a magic value to the thread structure
353 	 * to help identify valid ones:
354 	 */
355 	thread->magic = THR_MAGIC;
356 
357 	thread->cancelflags = PTHREAD_CANCEL_ENABLE | PTHREAD_CANCEL_DEFERRED;
358 	thread->name = __malloc(16);
359 	snprintf(thread->name, 16, "initial thread");
360 
361 	/* Default the priority of the initial thread: */
362 	thread->base_priority = THR_DEFAULT_PRIORITY;
363 	thread->active_priority = THR_DEFAULT_PRIORITY;
364 	thread->inherited_priority = 0;
365 
366 	/* Initialize the mutex queue: */
367 	TAILQ_INIT(&thread->mutexq);
368 
369 	thread->state = PS_RUNNING;
370 	thread->uniqueid = 0;
371 
372 	/* Others cleared to zero by thr_alloc() */
373 }
374 
375 static void
376 init_private(void)
377 {
378 	static int init_once = 0;
379 	size_t len;
380 	int mib[2];
381 
382 	/*
383 	 * Avoid reinitializing some things if they don't need to be,
384 	 * e.g. after a fork().
385 	 *
386 	 * NOTE: _thr_atfork_*list must remain intact after a fork.
387 	 */
388 	if (init_once == 0) {
389 		/* Find the stack top */
390 		mib[0] = CTL_KERN;
391 		mib[1] = KERN_USRSTACK;
392 		len = sizeof (_usrstack);
393 		if (sysctl(mib, 2, &_usrstack, &len, NULL, 0) == -1)
394 			PANIC("Cannot get kern.usrstack from sysctl");
395 		_thr_page_size = getpagesize();
396 		_thr_guard_default = _thr_page_size;
397 		_pthread_attr_default.guardsize_attr = _thr_guard_default;
398 		TAILQ_INIT(&_thr_atfork_list);
399 		TAILQ_INIT(&_thr_atfork_kern_list);
400 		init_once = 1;
401 	}
402 
403 	_thr_umtx_init(&_mutex_static_lock);
404 	_thr_umtx_init(&_cond_static_lock);
405 	_thr_umtx_init(&_rwlock_static_lock);
406 	_thr_umtx_init(&_keytable_lock);
407 	_thr_umtx_init(&_thr_atfork_lock);
408 	_thr_umtx_init(&_thr_event_lock);
409 	_thr_spinlock_init();
410 	_thr_list_init();
411 }
412 
413 __strong_reference(_pthread_init_early, pthread_init_early);
414