xref: /freebsd/lib/libthr/thread/thr_create.c (revision 035e325c81b75ea3b5c878c55cc133672b6ac06d)
1 /*
2  * Copyright (c) 1995-1998 John Birrell <jb@cimlogic.com.au>
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  * 3. All advertising materials mentioning features or use of this software
14  *    must display the following acknowledgement:
15  *	This product includes software developed by John Birrell.
16  * 4. Neither the name of the author nor the names of any co-contributors
17  *    may be used to endorse or promote products derived from this software
18  *    without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY JOHN BIRRELL AND CONTRIBUTORS ``AS IS'' AND
21  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
24  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30  * SUCH DAMAGE.
31  *
32  * $FreeBSD$
33  */
34 #include <errno.h>
35 #include <stdlib.h>
36 #include <string.h>
37 #include <fcntl.h>
38 #include <unistd.h>
39 #include <stddef.h>
40 #include <sys/time.h>
41 #include <machine/reg.h>
42 #include <pthread.h>
43 #include "thr_private.h"
44 #include "libc_private.h"
45 
46 static u_int64_t next_uniqueid = 1;
47 
48 #define OFF(f)	offsetof(struct pthread, f)
49 int _thread_next_offset			= OFF(tle.tqe_next);
50 int _thread_uniqueid_offset		= OFF(uniqueid);
51 int _thread_state_offset		= OFF(state);
52 int _thread_name_offset			= OFF(name);
53 int _thread_ctx_offset			= OFF(ctx);
54 #undef OFF
55 
56 int _thread_PS_RUNNING_value		= PS_RUNNING;
57 int _thread_PS_DEAD_value		= PS_DEAD;
58 
59 __weak_reference(_pthread_create, pthread_create);
60 
61 int
62 _pthread_create(pthread_t * thread, const pthread_attr_t * attr,
63 	       void *(*start_routine) (void *), void *arg)
64 {
65 	int		f_gc = 0;
66 	int             ret = 0;
67 	pthread_t       gc_thread;
68 	pthread_t       new_thread;
69 	pthread_attr_t	pattr;
70 	int		flags;
71 	void           *stack;
72 
73 	/*
74 	 * Locking functions in libc are required when there are
75 	 * threads other than the initial thread.
76 	 */
77 	__isthreaded = 1;
78 
79 	/* Allocate memory for the thread structure: */
80 	if ((new_thread = (pthread_t) malloc(sizeof(struct pthread))) == NULL)
81 		return (EAGAIN);
82 
83 	/* Check if default thread attributes are required: */
84 	if (attr == NULL || *attr == NULL)
85 		pattr = &pthread_attr_default;
86 	else
87 		pattr = *attr;
88 
89 	/* Check if a stack was specified in the thread attributes: */
90 	if ((stack = pattr->stackaddr_attr) == NULL) {
91 		stack = _thread_stack_alloc(pattr->stacksize_attr,
92 		    pattr->guardsize_attr);
93 		if (stack == NULL) {
94 			free(new_thread);
95 			return (EAGAIN);
96 		}
97 	}
98 
99 	/* Initialise the thread structure: */
100 	memset(new_thread, 0, sizeof(struct pthread));
101 	new_thread->stack = stack;
102 	new_thread->start_routine = start_routine;
103 	new_thread->arg = arg;
104 
105 	new_thread->cancelflags = PTHREAD_CANCEL_ENABLE |
106 	    PTHREAD_CANCEL_DEFERRED;
107 
108 	/*
109 	 * Write a magic value to the thread structure
110 	 * to help identify valid ones:
111 	 */
112 	new_thread->magic = PTHREAD_MAGIC;
113 
114 	/* Initialise the machine context: */
115 	getcontext(&new_thread->ctx);
116 	new_thread->ctx.uc_stack.ss_sp = new_thread->stack;
117 	new_thread->ctx.uc_stack.ss_size = pattr->stacksize_attr;
118 	makecontext(&new_thread->ctx, _thread_start, 0);
119 	new_thread->arch_id = _set_curthread(&new_thread->ctx, new_thread, &ret);
120 	if (ret != 0) {
121 		if (pattr->stackaddr_attr == NULL) {
122 			STACK_LOCK;
123 			_thread_stack_free(new_thread->stack,
124 			    pattr->stacksize_attr, pattr->guardsize_attr);
125 			STACK_UNLOCK;
126 		}
127 		free(new_thread);
128 		return (ret);
129 	}
130 
131 	/* Copy the thread attributes: */
132 	memcpy(&new_thread->attr, pattr, sizeof(struct pthread_attr));
133 
134 	/*
135 	 * Check if this thread is to inherit the scheduling
136 	 * attributes from its parent:
137 	 */
138 	if (new_thread->attr.flags & PTHREAD_INHERIT_SCHED) {
139 		/* Copy the scheduling attributes: */
140 		new_thread->base_priority = curthread->base_priority &
141 		    ~PTHREAD_SIGNAL_PRIORITY;
142 		new_thread->attr.prio = curthread->base_priority &
143 		    ~PTHREAD_SIGNAL_PRIORITY;
144 		new_thread->attr.sched_policy = curthread->attr.sched_policy;
145 	} else {
146 		/*
147 		 * Use just the thread priority, leaving the
148 		 * other scheduling attributes as their
149 		 * default values:
150 		 */
151 		new_thread->base_priority = new_thread->attr.prio;
152 	}
153 	new_thread->active_priority = new_thread->base_priority;
154 	new_thread->inherited_priority = 0;
155 
156 	/* Initialize joiner to NULL (no joiner): */
157 	new_thread->joiner = NULL;
158 
159 	/* Initialize the mutex queue: */
160 	TAILQ_INIT(&new_thread->mutexq);
161 
162 	/* Initialise hooks in the thread structure: */
163 	new_thread->specific = NULL;
164 	new_thread->cleanup = NULL;
165 	new_thread->flags = 0;
166 
167 	/*
168 	 * Initialise the unique id which GDB uses to
169 	 * track threads.
170 	 */
171 	new_thread->uniqueid = next_uniqueid++;
172 
173 	THREAD_LIST_LOCK;
174 
175 	/*
176 	 * Check if the garbage collector thread
177 	 * needs to be started.
178 	 */
179 	f_gc = (TAILQ_FIRST(&_thread_list) == _thread_initial);
180 
181 	/* Add the thread to the linked list of all threads: */
182 	TAILQ_INSERT_HEAD(&_thread_list, new_thread, tle);
183 
184 	/*
185 	 * Create the thread.
186 	 *
187 	 */
188 	if (pattr->suspend == PTHREAD_FLAGS_SUSPENDED)
189 		flags = THR_SUSPENDED;
190 	else
191 		flags = 0;
192 
193 	ret = thr_create(&new_thread->ctx, &new_thread->thr_id, flags);
194 
195 	if (ret != 0) {
196 		_thread_printf(STDERR_FILENO, "thr_create() == %d\n", ret);
197 		PANIC("thr_create");
198 	}
199 
200 	THREAD_LIST_UNLOCK;
201 
202 	/* Return a pointer to the thread structure: */
203 	(*thread) = new_thread;
204 
205 	/*
206 	 * Start a garbage collector thread
207 	 * if necessary.
208 	 */
209 	if (f_gc && pthread_create(&gc_thread,NULL, _thread_gc,NULL) != 0)
210 		PANIC("Can't create gc thread");
211 
212 	return (0);
213 }
214 
215 void
216 _thread_start(void)
217 {
218 
219 	/* Run the current thread's start routine with argument: */
220 	pthread_exit(curthread->start_routine(curthread->arg));
221 
222 	/* This point should never be reached. */
223 	PANIC("Thread has resumed after exit");
224 }
225