xref: /openbsd-src/sys/kern/kern_kthread.c (revision db3296cf5c1dd9058ceecc3a29fe4aaa0bd26000)
1 /*	$OpenBSD: kern_kthread.c,v 1.20 2003/05/27 21:03:49 henning Exp $	*/
2 /*	$NetBSD: kern_kthread.c,v 1.3 1998/12/22 21:21:36 kleink Exp $	*/
3 
4 /*-
5  * Copyright (c) 1998 The NetBSD Foundation, Inc.
6  * All rights reserved.
7  *
8  * This code is derived from software contributed to The NetBSD Foundation
9  * by Jason R. Thorpe of the Numerical Aerospace Simulation Facility,
10  * NASA Ames Research Center.
11  *
12  * Redistribution and use in source and binary forms, with or without
13  * modification, are permitted provided that the following conditions
14  * are met:
15  * 1. Redistributions of source code must retain the above copyright
16  *    notice, this list of conditions and the following disclaimer.
17  * 2. Redistributions in binary form must reproduce the above copyright
18  *    notice, this list of conditions and the following disclaimer in the
19  *    documentation and/or other materials provided with the distribution.
20  * 3. All advertising materials mentioning features or use of this software
21  *    must display the following acknowledgement:
22  *	This product includes software developed by the NetBSD
23  *	Foundation, Inc. and its contributors.
24  * 4. Neither the name of The NetBSD Foundation nor the names of its
25  *    contributors may be used to endorse or promote products derived
26  *    from this software without specific prior written permission.
27  *
28  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
29  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
30  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
31  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
32  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
33  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
34  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
35  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
36  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
37  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
38  * POSSIBILITY OF SUCH DAMAGE.
39  */
40 
41 #include <sys/param.h>
42 #include <sys/systm.h>
43 #include <sys/kernel.h>
44 #include <sys/kthread.h>
45 #include <sys/proc.h>
46 #include <sys/wait.h>
47 #include <sys/malloc.h>
48 #include <sys/queue.h>
49 
50 #include <machine/cpu.h>
51 
52 /*
53  * note that stdarg.h and the ansi style va_start macro is used for both
54  * ansi and traditional c compilers.
55  * XXX: this requires that stdarg.h define: va_alist and va_dcl
56  */
57 #include <machine/stdarg.h>
58 
59 /*
60  * Fork a kernel thread.  Any process can request this to be done.
61  * The VM space and limits, etc. will be shared with proc0.
62  */
63 int
64 kthread_create(void (*func)(void *), void *arg,
65     struct proc **newpp, const char *fmt, ...)
66 {
67 	struct proc *p2;
68 	register_t rv[2];
69 	int error;
70 	va_list ap;
71 
72 	/*
73 	 * First, create the new process.  Share the memory, file
74 	 * descriptors and don't leave the exit status around for the
75 	 * parent to wait for.
76 	 */
77 	error = fork1(&proc0, 0,
78 	    FORK_SHAREVM|FORK_NOZOMBIE|FORK_SIGHAND, NULL, 0, func, arg, rv);
79 	if (error)
80 		return (error);
81 
82 	p2 = pfind(rv[0]);
83 
84 	/*
85 	 * Mark it as a system process and not a candidate for
86 	 * swapping.
87 	 */
88 	p2->p_flag |= P_INMEM | P_SYSTEM;	/* XXX */
89 
90 	/* Name it as specified. */
91 	va_start(ap, fmt);
92 	vsnprintf(p2->p_comm, sizeof p2->p_comm, fmt, ap);
93 	va_end(ap);
94 
95 	/* All done! */
96 	if (newpp != NULL)
97 		*newpp = p2;
98 	return (0);
99 }
100 
101 /*
102  * Cause a kernel thread to exit.  Assumes the exiting thread is the
103  * current context.
104  */
105 void
106 kthread_exit(int ecode)
107 {
108 
109 	/*
110 	 * XXX What do we do with the exit code?  Should we even bother
111 	 * XXX with it?  The parent (proc0) isn't going to do much with
112 	 * XXX it.
113 	 */
114 	if (ecode != 0)
115 		printf("WARNING: thread `%s' (%d) exits with status %d\n",
116 		    curproc->p_comm, curproc->p_pid, ecode);
117 
118 	exit1(curproc, W_EXITCODE(ecode, 0));
119 
120 	/*
121 	 * XXX Fool the compiler.  Making exit1() __dead is a can
122 	 * XXX of worms right now.
123 	 */
124 	for (;;);
125 }
126 
127 struct kthread_q {
128 	SIMPLEQ_ENTRY(kthread_q) kq_q;
129 	void (*kq_func)(void *);
130 	void *kq_arg;
131 };
132 
133 SIMPLEQ_HEAD(, kthread_q) kthread_q = SIMPLEQ_HEAD_INITIALIZER(kthread_q);
134 
135 /*
136  * Defer the creation of a kernel thread.  Once the standard kernel threads
137  * and processes have been created, this queue will be run to callback to
138  * the caller to create threads for e.g. file systems and device drivers.
139  */
140 void
141 kthread_create_deferred(void (*func)(void *), void *arg)
142 {
143 	struct kthread_q *kq;
144 
145 	kq = malloc(sizeof *kq, M_TEMP, M_NOWAIT);
146 	if (kq == NULL)
147 		panic("unable to allocate kthread_q");
148 	bzero(kq, sizeof *kq);
149 
150 	kq->kq_func = func;
151 	kq->kq_arg = arg;
152 
153 	SIMPLEQ_INSERT_TAIL(&kthread_q, kq, kq_q);
154 }
155 
156 void
157 kthread_run_deferred_queue(void)
158 {
159 	struct kthread_q *kq;
160 
161 	while ((kq = SIMPLEQ_FIRST(&kthread_q)) != NULL) {
162 		SIMPLEQ_REMOVE_HEAD(&kthread_q, kq, kq_q);
163 		(*kq->kq_func)(kq->kq_arg);
164 		free(kq, M_TEMP);
165 	}
166 }
167