xref: /dflybsd-src/lib/libthread_xu/thread/thr_init.c (revision febebf837b1267101987c1c8945f3e9e9e1df7c8)
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_set_name_np);
121 /* thr_init.c */
122 STATIC_LIB_REQUIRE(_pthread_init_early);
123 /* thr_join.c */
124 STATIC_LIB_REQUIRE(_pthread_join);
125 /* thr_kill.c */
126 STATIC_LIB_REQUIRE(_pthread_kill);
127 /* thr_main_np.c */
128 STATIC_LIB_REQUIRE(_pthread_main_np);
129 /* thr_multi_np.c */
130 STATIC_LIB_REQUIRE(_pthread_multi_np);
131 /* thr_mutex.c */
132 STATIC_LIB_REQUIRE(_pthread_mutex_init);
133 /* thr_mutex_prioceiling.c */
134 STATIC_LIB_REQUIRE(_pthread_mutexattr_getprioceiling);
135 /* thr_mutex_protocol.c */
136 STATIC_LIB_REQUIRE(_pthread_mutexattr_getprotocol);
137 /* thr_mutexattr.c */
138 STATIC_LIB_REQUIRE(_pthread_mutexattr_init);
139 /* thr_once.c */
140 STATIC_LIB_REQUIRE(_pthread_once);
141 /* thr_pspinlock.c */
142 STATIC_LIB_REQUIRE(_pthread_spin_init);
143 /* thr_resume_np.c */
144 STATIC_LIB_REQUIRE(_pthread_resume_np);
145 /* thr_rwlock.c */
146 STATIC_LIB_REQUIRE(_pthread_rwlock_init);
147 /* thr_rwlockattr.c */
148 STATIC_LIB_REQUIRE(_pthread_rwlockattr_init);
149 /* thr_self.c */
150 STATIC_LIB_REQUIRE(_pthread_self);
151 /* thr_sem.c */
152 STATIC_LIB_REQUIRE(_sem_init);
153 /* thr_affinity.c */
154 STATIC_LIB_REQUIRE(_pthread_setaffinity_np);
155 /* thr_setprio.c */
156 STATIC_LIB_REQUIRE(_pthread_setprio);
157 /* thr_setschedparam.c */
158 STATIC_LIB_REQUIRE(_pthread_setschedparam);
159 /* thr_sig.c */
160 STATIC_LIB_REQUIRE(_sigwait);
161 /* thr_single_np.c */
162 STATIC_LIB_REQUIRE(_pthread_single_np);
163 /* thr_spec.c */
164 STATIC_LIB_REQUIRE(_pthread_key_create);
165 /* thr_spinlock.c */
166 STATIC_LIB_REQUIRE(_spinlock);
167 /* thr_suspend_np.c */
168 STATIC_LIB_REQUIRE(_pthread_suspend_np);
169 /* thr_switch_np.c */
170 STATIC_LIB_REQUIRE(_pthread_switch_add_np);
171 /* thr_symbols.c */
172 STATIC_LIB_REQUIRE(_thread_state_running);
173 /* thr_syscalls.c */
174 STATIC_LIB_REQUIRE(__wait4);
175 /* thr_yield.c */
176 STATIC_LIB_REQUIRE(_pthread_yield);
177 
178 char		*_usrstack;
179 struct pthread	*_thr_initial;
180 static void	*_thr_main_redzone;
181 
182 pid_t		_thr_pid;
183 size_t		_thr_guard_default;
184 size_t		_thr_stack_default =	THR_STACK_DEFAULT;
185 size_t		_thr_stack_initial =	THR_STACK_INITIAL;
186 int		_thr_page_size;
187 
188 static void	init_private(void);
189 static void	_libpthread_uninit(void);
190 static void	init_main_thread(struct pthread *thread);
191 
192 void	_thread_init(void) __attribute__ ((constructor));
193 void
194 _thread_init(void)
195 {
196 	_libpthread_init(NULL);
197 }
198 
199 void	_thread_uninit(void) __attribute__ ((destructor));
200 void
201 _thread_uninit(void)
202 {
203 	_libpthread_uninit();
204 }
205 
206 /*
207  * This function is used by libc to initialise libpthread
208  * early during dynamic linking.
209  */
210 void _pthread_init_early(void);
211 void
212 _pthread_init_early(void)
213 {
214 	_libpthread_init(NULL);
215 }
216 
217 /*
218  * Threaded process initialization.
219  *
220  * This is only called under two conditions:
221  *
222  *   1) Some thread routines have detected that the library hasn't yet
223  *      been initialized (_thr_initial == NULL && curthread == NULL), or
224  *
225  *   2) An explicit call to reinitialize after a fork (indicated
226  *      by curthread != NULL)
227  */
228 void
229 _libpthread_init(struct pthread *curthread)
230 {
231 	int fd, first = 0;
232 	sigset_t sigset, oldset;
233 
234 	/* Check if this function has already been called: */
235 	if ((_thr_initial != NULL) && (curthread == NULL))
236 		/* Only initialize the threaded application once. */
237 		return;
238 
239 	/*
240 	 * Check for the special case of this process running as
241 	 * or in place of init as pid = 1:
242 	 */
243 	if ((_thr_pid = getpid()) == 1) {
244 		/*
245 		 * Setup a new session for this process which is
246 		 * assumed to be running as root.
247 		 */
248 		if (setsid() == -1)
249 			PANIC("Can't set session ID");
250 		if (revoke(_PATH_CONSOLE) != 0)
251 			PANIC("Can't revoke console");
252 		if ((fd = __sys_open(_PATH_CONSOLE, O_RDWR)) < 0)
253 			PANIC("Can't open console");
254 		if (setlogin("root") == -1)
255 			PANIC("Can't set login to root");
256 		if (__sys_ioctl(fd, TIOCSCTTY, NULL) == -1)
257 			PANIC("Can't set controlling terminal");
258 	}
259 
260 	/* Initialize pthread private data. */
261 	init_private();
262 
263 	/* Set the initial thread. */
264 	if (curthread == NULL) {
265 		first = 1;
266 		/* Create and initialize the initial thread. */
267 		curthread = _thr_alloc(NULL);
268 		if (curthread == NULL)
269 			PANIC("Can't allocate initial thread");
270 		init_main_thread(curthread);
271 	}
272 	/*
273 	 * Add the thread to the thread list queue.
274 	 */
275 	THR_LIST_ADD(curthread);
276 	_thread_active_threads = 1;
277 
278 	/* Setup the thread specific data */
279 	tls_set_tcb(curthread->tcb);
280 
281 	if (first) {
282 		SIGFILLSET(sigset);
283 		__sys_sigprocmask(SIG_SETMASK, &sigset, &oldset);
284 		_thr_signal_init();
285 		_thr_initial = curthread;
286 		SIGDELSET(oldset, SIGCANCEL);
287 		__sys_sigprocmask(SIG_SETMASK, &oldset, NULL);
288 		if (td_eventismember(&_thread_event_mask, TD_CREATE))
289 			_thr_report_creation(curthread, curthread);
290 		_thr_rtld_init();
291 		_thr_malloc_init();
292 		_thr_sem_init();
293 	}
294 }
295 
296 static void
297 _libpthread_uninit(void)
298 {
299 	if (_thr_initial == NULL)
300 		return;
301 	if (_thr_main_redzone && _thr_main_redzone != MAP_FAILED) {
302 		munmap(_thr_main_redzone, _thr_guard_default);
303 		_thr_main_redzone = NULL;
304 	}
305 	_thr_stack_cleanup();
306 }
307 
308 /*
309  * This function and pthread_create() do a lot of the same things.
310  * It'd be nice to consolidate the common stuff in one place.
311  */
312 static void
313 init_main_thread(struct pthread *thread)
314 {
315 	/* Setup the thread attributes. */
316 	thread->tid = _thr_get_tid();
317 	thread->attr = _pthread_attr_default;
318 	/*
319 	 * Set up the thread stack.
320 	 *
321 	 * Create a red zone below the main stack.  All other stacks
322 	 * are constrained to a maximum size by the parameters
323 	 * passed to mmap(), but this stack is only limited by
324 	 * resource limits, so this stack needs an explicitly mapped
325 	 * red zone to protect the thread stack that is just beyond.
326 	 */
327 	_thr_main_redzone = mmap(_usrstack - _thr_stack_initial -
328 				 _thr_guard_default, _thr_guard_default,
329 				 0, MAP_ANON | MAP_TRYFIXED, -1, 0);
330 	if (_thr_main_redzone == MAP_FAILED) {
331 		PANIC("Cannot allocate red zone for initial thread");
332 	}
333 
334 	/*
335 	 * Mark the stack as an application supplied stack so that it
336 	 * isn't deallocated.
337 	 *
338 	 * XXX - I'm not sure it would hurt anything to deallocate
339 	 *       the main thread stack because deallocation doesn't
340 	 *       actually free() it; it just puts it in the free
341 	 *       stack queue for later reuse.
342 	 */
343 	thread->attr.stackaddr_attr = _usrstack - _thr_stack_initial;
344 	thread->attr.stacksize_attr = _thr_stack_initial;
345 	thread->attr.guardsize_attr = _thr_guard_default;
346 	thread->attr.flags |= THR_STACK_USER;
347 
348 	/*
349 	 * Write a magic value to the thread structure
350 	 * to help identify valid ones:
351 	 */
352 	thread->magic = THR_MAGIC;
353 
354 	thread->cancelflags = PTHREAD_CANCEL_ENABLE | PTHREAD_CANCEL_DEFERRED;
355 	thread->name = __malloc(16);
356 	snprintf(thread->name, 16, "initial thread");
357 
358 	/* Default the priority of the initial thread: */
359 	thread->base_priority = THR_DEFAULT_PRIORITY;
360 	thread->active_priority = THR_DEFAULT_PRIORITY;
361 	thread->inherited_priority = 0;
362 
363 	/* Initialize the mutex queue: */
364 	TAILQ_INIT(&thread->mutexq);
365 
366 	thread->state = PS_RUNNING;
367 	thread->uniqueid = 0;
368 
369 	/* Others cleared to zero by thr_alloc() */
370 }
371 
372 static void
373 init_private(void)
374 {
375 	static int init_once = 0;
376 	size_t len;
377 	int mib[2];
378 
379 	/*
380 	 * Avoid reinitializing some things if they don't need to be,
381 	 * e.g. after a fork().
382 	 *
383 	 * NOTE: _thr_atfork_*list must remain intact after a fork.
384 	 */
385 	if (init_once == 0) {
386 		/* Find the stack top */
387 		mib[0] = CTL_KERN;
388 		mib[1] = KERN_USRSTACK;
389 		len = sizeof (_usrstack);
390 		if (sysctl(mib, 2, &_usrstack, &len, NULL, 0) == -1)
391 			PANIC("Cannot get kern.usrstack from sysctl");
392 		_thr_page_size = getpagesize();
393 		_thr_guard_default = _thr_page_size;
394 		_pthread_attr_default.guardsize_attr = _thr_guard_default;
395 		TAILQ_INIT(&_thr_atfork_list);
396 		TAILQ_INIT(&_thr_atfork_kern_list);
397 		init_once = 1;
398 	}
399 
400 	_thr_umtx_init(&_mutex_static_lock);
401 	_thr_umtx_init(&_cond_static_lock);
402 	_thr_umtx_init(&_rwlock_static_lock);
403 	_thr_umtx_init(&_keytable_lock);
404 	_thr_umtx_init(&_thr_atfork_lock);
405 	_thr_umtx_init(&_thr_event_lock);
406 	_thr_spinlock_init();
407 	_thr_list_init();
408 }
409 
410 __strong_reference(_pthread_init_early, pthread_init_early);
411