xref: /netbsd-src/sys/kern/kern_kthread.c (revision e39ef1d61eee3ccba837ee281f1e098c864487aa)
1 /*	$NetBSD: kern_kthread.c,v 1.38 2011/11/01 15:39:37 jym Exp $	*/
2 
3 /*-
4  * Copyright (c) 1998, 1999, 2007, 2009 The NetBSD Foundation, Inc.
5  * All rights reserved.
6  *
7  * This code is derived from software contributed to The NetBSD Foundation
8  * by Jason R. Thorpe of the Numerical Aerospace Simulation Facility,
9  * NASA Ames Research Center, and by Andrew Doran.
10  *
11  * Redistribution and use in source and binary forms, with or without
12  * modification, are permitted provided that the following conditions
13  * are met:
14  * 1. Redistributions of source code must retain the above copyright
15  *    notice, this list of conditions and the following disclaimer.
16  * 2. Redistributions in binary form must reproduce the above copyright
17  *    notice, this list of conditions and the following disclaimer in the
18  *    documentation and/or other materials provided with the distribution.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
21  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
22  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
23  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
24  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30  * POSSIBILITY OF SUCH DAMAGE.
31  */
32 
33 #include <sys/cdefs.h>
34 __KERNEL_RCSID(0, "$NetBSD: kern_kthread.c,v 1.38 2011/11/01 15:39:37 jym Exp $");
35 
36 #include <sys/param.h>
37 #include <sys/systm.h>
38 #include <sys/kernel.h>
39 #include <sys/kthread.h>
40 #include <sys/mutex.h>
41 #include <sys/sched.h>
42 #include <sys/kmem.h>
43 
44 #include <uvm/uvm_extern.h>
45 
46 static lwp_t *		kthread_jtarget;
47 static kmutex_t		kthread_lock;
48 static kcondvar_t	kthread_cv;
49 
50 void
51 kthread_sysinit(void)
52 {
53 
54 	mutex_init(&kthread_lock, MUTEX_DEFAULT, IPL_NONE);
55 	cv_init(&kthread_cv, "kthrwait");
56 	kthread_jtarget = NULL;
57 }
58 
59 /*
60  * kthread_create: create a kernel thread, that is, system-only LWP.
61  */
62 int
63 kthread_create(pri_t pri, int flag, struct cpu_info *ci,
64     void (*func)(void *), void *arg, lwp_t **lp, const char *fmt, ...)
65 {
66 	lwp_t *l;
67 	vaddr_t uaddr;
68 	int error, lc;
69 	va_list ap;
70 
71 	KASSERT((flag & KTHREAD_INTR) == 0 || (flag & KTHREAD_MPSAFE) != 0);
72 
73 	uaddr = uvm_uarea_system_alloc();
74 	if (uaddr == 0) {
75 		return ENOMEM;
76 	}
77 	if ((flag & KTHREAD_TS) != 0) {
78 		lc = SCHED_OTHER;
79 	} else {
80 		lc = SCHED_RR;
81 	}
82 
83 	error = lwp_create(&lwp0, &proc0, uaddr, LWP_DETACHED, NULL,
84 	    0, func, arg, &l, lc);
85 	if (error) {
86 		uvm_uarea_system_free(uaddr);
87 		return error;
88 	}
89 	if (fmt != NULL) {
90 		l->l_name = kmem_alloc(MAXCOMLEN, KM_SLEEP);
91 		if (l->l_name == NULL) {
92 			kthread_destroy(l);
93 			return ENOMEM;
94 		}
95 		va_start(ap, fmt);
96 		vsnprintf(l->l_name, MAXCOMLEN, fmt, ap);
97 		va_end(ap);
98 	}
99 
100 	/*
101 	 * Set parameters.
102 	 */
103 	if (pri == PRI_NONE) {
104 		if ((flag & KTHREAD_TS) != 0) {
105 			/* Maximum user priority level. */
106 			pri = MAXPRI_USER;
107 		} else {
108 			/* Minimum kernel priority level. */
109 			pri = PRI_KTHREAD;
110 		}
111 	}
112 	mutex_enter(proc0.p_lock);
113 	lwp_lock(l);
114 	l->l_priority = pri;
115 	if (ci != NULL) {
116 		if (ci != l->l_cpu) {
117 			lwp_unlock_to(l, ci->ci_schedstate.spc_mutex);
118 			lwp_lock(l);
119 		}
120 		l->l_pflag |= LP_BOUND;
121 		l->l_cpu = ci;
122 	}
123 
124 	if ((flag & KTHREAD_MUSTJOIN) != 0) {
125 		KASSERT(lp != NULL);
126 		l->l_pflag |= LP_MUSTJOIN;
127 	}
128 	if ((flag & KTHREAD_INTR) != 0) {
129 		l->l_pflag |= LP_INTR;
130 	}
131 	if ((flag & KTHREAD_MPSAFE) == 0) {
132 		l->l_pflag &= ~LP_MPSAFE;
133 	}
134 
135 	/*
136 	 * Set the new LWP running, unless the caller has requested
137 	 * otherwise.
138 	 */
139 	if ((flag & KTHREAD_IDLE) == 0) {
140 		l->l_stat = LSRUN;
141 		sched_enqueue(l, false);
142 		lwp_unlock(l);
143 	} else {
144 		if (ci != NULL)
145 			lwp_unlock_to(l, ci->ci_schedstate.spc_lwplock);
146 		else
147 			lwp_unlock(l);
148 	}
149 	mutex_exit(proc0.p_lock);
150 
151 	/* All done! */
152 	if (lp != NULL) {
153 		*lp = l;
154 	}
155 	return 0;
156 }
157 
158 /*
159  * Cause a kernel thread to exit.  Assumes the exiting thread is the
160  * current context.
161  */
162 void
163 kthread_exit(int ecode)
164 {
165 	const char *name;
166 	lwp_t *l = curlwp;
167 
168 	/* We can't do much with the exit code, so just report it. */
169 	if (ecode != 0) {
170 		if ((name = l->l_name) == NULL)
171 			name = "unnamed";
172 		printf("WARNING: kthread `%s' (%d) exits with status %d\n",
173 		    name, l->l_lid, ecode);
174 	}
175 
176 	/* Barrier for joining. */
177 	if (l->l_pflag & LP_MUSTJOIN) {
178 		mutex_enter(&kthread_lock);
179 		while (kthread_jtarget != l) {
180 			cv_wait(&kthread_cv, &kthread_lock);
181 		}
182 		kthread_jtarget = NULL;
183 		cv_broadcast(&kthread_cv);
184 		mutex_exit(&kthread_lock);
185 	}
186 
187 	/* And exit.. */
188 	lwp_exit(l);
189 	panic("kthread_exit");
190 }
191 
192 /*
193  * Destroy an inactive kthread.  The kthread must be in the LSIDL state.
194  */
195 void
196 kthread_destroy(lwp_t *l)
197 {
198 
199 	KASSERT((l->l_flag & LW_SYSTEM) != 0);
200 	KASSERT(l->l_stat == LSIDL);
201 
202 	lwp_exit(l);
203 }
204 
205 /*
206  * Wait for a kthread to exit, as pthread_join().
207  */
208 int
209 kthread_join(lwp_t *l)
210 {
211 
212 	KASSERT((l->l_flag & LW_SYSTEM) != 0);
213 
214 	/*
215 	 * - Wait if some other thread has occupied the target.
216 	 * - Specify our kthread as a target and notify it.
217 	 * - Wait for the target kthread to notify us.
218 	 */
219 	mutex_enter(&kthread_lock);
220 	while (kthread_jtarget) {
221 		cv_wait(&kthread_cv, &kthread_lock);
222 	}
223 	kthread_jtarget = l;
224 	cv_broadcast(&kthread_cv);
225 	while (kthread_jtarget == l) {
226 		cv_wait(&kthread_cv, &kthread_lock);
227 	}
228 	mutex_exit(&kthread_lock);
229 
230 	return 0;
231 }
232