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  * $DragonFly: src/lib/libthread_xu/thread/thr_init.c,v 1.8 2006/04/06 13:03:09 davidxu Exp $
34  */
35 
36 #include "namespace.h"
37 #include <sys/param.h>
38 #include <sys/signalvar.h>
39 
40 #include <sys/ioctl.h>
41 #include <sys/sysctl.h>
42 #include <sys/time.h>
43 #include <sys/ttycom.h>
44 #include <sys/mman.h>
45 
46 #include <fcntl.h>
47 #include <paths.h>
48 #include <pthread.h>
49 #include <signal.h>
50 #include <stdlib.h>
51 #include <string.h>
52 #include <unistd.h>
53 #include "un-namespace.h"
54 
55 #include "libc_private.h"
56 #include "thr_private.h"
57 
58 /* thr_attr.c */
59 STATIC_LIB_REQUIRE(_pthread_attr_init);
60 /* thr_barrier.c */
61 STATIC_LIB_REQUIRE(_pthread_barrier_init);
62 /* thr_barrierattr.c */
63 STATIC_LIB_REQUIRE(_pthread_barrierattr_init);
64 /* thr_cancel.c */
65 STATIC_LIB_REQUIRE(_pthread_cancel);
66 /* thr_clean.c */
67 STATIC_LIB_REQUIRE(_pthread_cleanup_push);
68 /* thr_concurrency.c */
69 STATIC_LIB_REQUIRE(_pthread_get_concurrency);
70 /* thr_cond.c */
71 STATIC_LIB_REQUIRE(_pthread_cond_init);
72 /* thr_condattr.c */
73 STATIC_LIB_REQUIRE(_pthread_condattr_init);
74 /* thr_create.c */
75 STATIC_LIB_REQUIRE(_pthread_create);
76 /* thr_detach.c */
77 STATIC_LIB_REQUIRE(_pthread_detach);
78 /* thr_equal.c */
79 STATIC_LIB_REQUIRE(_pthread_equal);
80 /* thr_exit.c */
81 STATIC_LIB_REQUIRE(_pthread_exit);
82 /* thr_fork.c */
83 STATIC_LIB_REQUIRE(_pthread_atfork);
84 STATIC_LIB_REQUIRE(_fork);
85 /* thr_getprio.c */
86 STATIC_LIB_REQUIRE(_pthread_getprio);
87 /* thr_getschedparam.c */
88 STATIC_LIB_REQUIRE(_pthread_getschedparam);
89 /* thr_info.c */
90 STATIC_LIB_REQUIRE(_pthread_set_name_np);
91 /* thr_join.c */
92 STATIC_LIB_REQUIRE(_pthread_join);
93 /* thr_kill.c */
94 STATIC_LIB_REQUIRE(_pthread_kill);
95 /* thr_main_np.c */
96 STATIC_LIB_REQUIRE(_pthread_main_np);
97 /* thr_multi_np.c */
98 STATIC_LIB_REQUIRE(_pthread_multi_np);
99 /* thr_mutex.c */
100 STATIC_LIB_REQUIRE(_pthread_mutex_init);
101 /* thr_mutex_prioceiling.c */
102 STATIC_LIB_REQUIRE(_pthread_mutexattr_getprioceiling);
103 /* thr_mutex_protocol.c */
104 STATIC_LIB_REQUIRE(_pthread_mutexattr_getprotocol);
105 /* thr_mutexattr.c */
106 STATIC_LIB_REQUIRE(_pthread_mutexattr_init);
107 /* thr_once.c */
108 STATIC_LIB_REQUIRE(_pthread_once);
109 /* thr_pspinlock.c */
110 STATIC_LIB_REQUIRE(_pthread_spin_init);
111 /* thr_resume_np.c */
112 STATIC_LIB_REQUIRE(_pthread_resume_np);
113 /* thr_rwlock.c */
114 STATIC_LIB_REQUIRE(_pthread_rwlock_init);
115 /* thr_rwlockattr.c */
116 STATIC_LIB_REQUIRE(_pthread_rwlockattr_init);
117 /* thr_self.c */
118 STATIC_LIB_REQUIRE(_pthread_self);
119 /* thr_sem.c */
120 STATIC_LIB_REQUIRE(_sem_init);
121 /* thr_setprio.c */
122 STATIC_LIB_REQUIRE(_pthread_setprio);
123 /* thr_setschedparam.c */
124 STATIC_LIB_REQUIRE(_pthread_setschedparam);
125 /* thr_sig.c */
126 STATIC_LIB_REQUIRE(_sigwait);
127 /* thr_single_np.c */
128 STATIC_LIB_REQUIRE(_pthread_single_np);
129 /* thr_spec.c */
130 STATIC_LIB_REQUIRE(_pthread_key_create);
131 /* thr_spinlock.c */
132 STATIC_LIB_REQUIRE(_spinlock);
133 /* thr_suspend_np.c */
134 STATIC_LIB_REQUIRE(_pthread_suspend_np);
135 /* thr_switch_np.c */
136 STATIC_LIB_REQUIRE(_pthread_switch_add_np);
137 /* thr_symbols.c */
138 STATIC_LIB_REQUIRE(_thread_state_running);
139 /* thr_syscalls.c */
140 STATIC_LIB_REQUIRE(__wait4);
141 /* thr_yield.c */
142 STATIC_LIB_REQUIRE(_pthread_yield);
143 
144 char		*_usrstack;
145 struct pthread	*_thr_initial;
146 int		_thread_scope_system;
147 
148 pid_t		_thr_pid;
149 size_t		_thr_guard_default;
150 size_t		_thr_stack_default =	THR_STACK_DEFAULT;
151 size_t		_thr_stack_initial =	THR_STACK_INITIAL;
152 int		_thr_page_size;
153 
154 static void	init_private(void);
155 static void	init_main_thread(struct pthread *thread);
156 static int	init_once = 0;
157 
158 void	_thread_init(void) __attribute__ ((constructor));
159 void
160 _thread_init(void)
161 {
162 	_libpthread_init(NULL);
163 }
164 
165 /*
166  * Threaded process initialization.
167  *
168  * This is only called under two conditions:
169  *
170  *   1) Some thread routines have detected that the library hasn't yet
171  *      been initialized (_thr_initial == NULL && curthread == NULL), or
172  *
173  *   2) An explicit call to reinitialize after a fork (indicated
174  *      by curthread != NULL)
175  */
176 void
177 _libpthread_init(struct pthread *curthread)
178 {
179 	int fd, first = 0;
180 	sigset_t sigset, oldset;
181 
182 	/* Check if this function has already been called: */
183 	if ((_thr_initial != NULL) && (curthread == NULL))
184 		/* Only initialize the threaded application once. */
185 		return;
186 
187 	/*
188 	 * Check for the special case of this process running as
189 	 * or in place of init as pid = 1:
190 	 */
191 	if ((_thr_pid = getpid()) == 1) {
192 		/*
193 		 * Setup a new session for this process which is
194 		 * assumed to be running as root.
195 		 */
196 		if (setsid() == -1)
197 			PANIC("Can't set session ID");
198 		if (revoke(_PATH_CONSOLE) != 0)
199 			PANIC("Can't revoke console");
200 		if ((fd = __sys_open(_PATH_CONSOLE, O_RDWR)) < 0)
201 			PANIC("Can't open console");
202 		if (setlogin("root") == -1)
203 			PANIC("Can't set login to root");
204 		if (__sys_ioctl(fd, TIOCSCTTY, (char *) NULL) == -1)
205 			PANIC("Can't set controlling terminal");
206 	}
207 
208 	/* Initialize pthread private data. */
209 	init_private();
210 
211 	/* Set the initial thread. */
212 	if (curthread == NULL) {
213 		first = 1;
214 		/* Create and initialize the initial thread. */
215 		curthread = _thr_alloc(NULL);
216 		if (curthread == NULL)
217 			PANIC("Can't allocate initial thread");
218 		init_main_thread(curthread);
219 	}
220 	/*
221 	 * Add the thread to the thread list queue.
222 	 */
223 	THR_LIST_ADD(curthread);
224 	_thread_active_threads = 1;
225 
226 	/* Setup the thread specific data */
227 	tls_set_tcb(curthread->tcb);
228 
229 	if (first) {
230 		SIGFILLSET(sigset);
231 		__sys_sigprocmask(SIG_SETMASK, &sigset, &oldset);
232 		_thr_signal_init();
233 		_thr_initial = curthread;
234 		SIGDELSET(oldset, SIGCANCEL);
235 		__sys_sigprocmask(SIG_SETMASK, &oldset, NULL);
236 		if (td_eventismember(&_thread_event_mask, TD_CREATE))
237 			_thr_report_creation(curthread, curthread);
238 	}
239 }
240 
241 /*
242  * This function and pthread_create() do a lot of the same things.
243  * It'd be nice to consolidate the common stuff in one place.
244  */
245 static void
246 init_main_thread(struct pthread *thread)
247 {
248 	/* Setup the thread attributes. */
249 	thread->tid = _thr_get_tid();
250 	thread->attr = _pthread_attr_default;
251 	/*
252 	 * Set up the thread stack.
253 	 *
254 	 * Create a red zone below the main stack.  All other stacks
255 	 * are constrained to a maximum size by the parameters
256 	 * passed to mmap(), but this stack is only limited by
257 	 * resource limits, so this stack needs an explicitly mapped
258 	 * red zone to protect the thread stack that is just beyond.
259 	 */
260 	if (mmap(_usrstack - _thr_stack_initial -
261 	    _thr_guard_default, _thr_guard_default, 0, MAP_ANON,
262 	    -1, 0) == MAP_FAILED)
263 		PANIC("Cannot allocate red zone for initial thread");
264 
265 	/*
266 	 * Mark the stack as an application supplied stack so that it
267 	 * isn't deallocated.
268 	 *
269 	 * XXX - I'm not sure it would hurt anything to deallocate
270 	 *       the main thread stack because deallocation doesn't
271 	 *       actually free() it; it just puts it in the free
272 	 *       stack queue for later reuse.
273 	 */
274 	thread->attr.stackaddr_attr = _usrstack - _thr_stack_initial;
275 	thread->attr.stacksize_attr = _thr_stack_initial;
276 	thread->attr.guardsize_attr = _thr_guard_default;
277 	thread->attr.flags |= THR_STACK_USER;
278 
279 	/*
280 	 * Write a magic value to the thread structure
281 	 * to help identify valid ones:
282 	 */
283 	thread->magic = THR_MAGIC;
284 
285 	thread->cancelflags = PTHREAD_CANCEL_ENABLE | PTHREAD_CANCEL_DEFERRED;
286 	thread->name = strdup("initial thread");
287 
288 	/* Default the priority of the initial thread: */
289 	thread->base_priority = THR_DEFAULT_PRIORITY;
290 	thread->active_priority = THR_DEFAULT_PRIORITY;
291 	thread->inherited_priority = 0;
292 
293 	/* Initialize the mutex queue: */
294 	TAILQ_INIT(&thread->mutexq);
295 
296 	thread->state = PS_RUNNING;
297 	thread->uniqueid = 0;
298 
299 	/* Others cleared to zero by thr_alloc() */
300 }
301 
302 static void
303 init_private(void)
304 {
305 	size_t len;
306 	int mib[2];
307 
308 	_thr_umtx_init(&_mutex_static_lock);
309 	_thr_umtx_init(&_cond_static_lock);
310 	_thr_umtx_init(&_rwlock_static_lock);
311 	_thr_umtx_init(&_keytable_lock);
312 	_thr_umtx_init(&_thr_atfork_lock);
313 	_thr_umtx_init(&_thr_event_lock);
314 	_thr_spinlock_init();
315 	_thr_list_init();
316 
317 	/*
318 	 * Avoid reinitializing some things if they don't need to be,
319 	 * e.g. after a fork().
320 	 */
321 	if (init_once == 0) {
322 		/* Find the stack top */
323 		mib[0] = CTL_KERN;
324 		mib[1] = KERN_USRSTACK;
325 		len = sizeof (_usrstack);
326 		if (sysctl(mib, 2, &_usrstack, &len, NULL, 0) == -1)
327 			PANIC("Cannot get kern.usrstack from sysctl");
328 		_thr_page_size = getpagesize();
329 		_thr_guard_default = _thr_page_size;
330 		_pthread_attr_default.guardsize_attr = _thr_guard_default;
331 
332 		TAILQ_INIT(&_thr_atfork_list);
333 #ifdef SYSTEM_SCOPE_ONLY
334 		_thread_scope_system = 1;
335 #else
336 		if (getenv("LIBPTHREAD_SYSTEM_SCOPE") != NULL)
337 			_thread_scope_system = 1;
338 		else if (getenv("LIBPTHREAD_PROCESS_SCOPE") != NULL)
339 			_thread_scope_system = -1;
340 #endif
341 	}
342 	init_once = 1;
343 }
344