fff53838fcb058e328116d4026469b3bef56ae55
[dragonfly.git] / sys / kern / kern_kthread.c
1 /*
2  * Copyright (c) 1999 Peter Wemm <peter@FreeBSD.org>
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  *
14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24  * SUCH DAMAGE.
25  *
26  * $FreeBSD: src/sys/kern/kern_kthread.c,v 1.5.2.3 2001/12/25 01:51:14 dillon Exp $
27  * $DragonFly: src/sys/kern/kern_kthread.c,v 1.13 2006/12/18 20:41:01 dillon Exp $
28  */
29
30 #include <sys/param.h>
31 #include <sys/systm.h>
32 #include <sys/proc.h>
33 #include <sys/kthread.h>
34 #include <sys/ptrace.h>
35 #include <sys/resourcevar.h>
36 #include <sys/signalvar.h>
37 #include <sys/unistd.h>
38 #include <sys/wait.h>
39
40 #include <machine/stdarg.h>
41
42 /*
43  * Create a kernel process/thread/whatever.  It shares it's address space
44  * with proc0 - ie: kernel only.  5.x compatible.
45  *
46  * NOTE!  By default kthreads are created with the MP lock held.  A
47  * thread which does not require the MP lock should release it by calling
48  * rel_mplock() at the start of the new thread.
49  */
50 int
51 kthread_create(void (*func)(void *), void *arg,
52     struct thread **tdp, const char *fmt, ...)
53 {
54     thread_t td;
55     __va_list ap;
56
57     td = lwkt_alloc_thread(NULL, LWKT_THREAD_STACK, -1, TDF_VERBOSE);
58     if (tdp)
59         *tdp = td;
60     cpu_set_thread_handler(td, kthread_exit, func, arg);
61 #ifdef SMP
62     KKASSERT(td->td_mpcount == 1);
63 #endif
64
65     /*
66      * Set up arg0 for 'ps' etc
67      */
68     __va_start(ap, fmt);
69     kvsnprintf(td->td_comm, sizeof(td->td_comm), fmt, ap);
70     __va_end(ap);
71
72     td->td_ucred = crhold(proc0.p_ucred);
73
74     /*
75      * Schedule the thread to run
76      */
77     lwkt_schedule(td);
78     return 0;
79 }
80
81 /*
82  * Same as kthread_create() but you can specify a custom stack size.
83  */
84 int
85 kthread_create_stk(void (*func)(void *), void *arg,
86     struct thread **tdp, int stksize, const char *fmt, ...)
87 {
88     thread_t td;
89     __va_list ap;
90
91     td = lwkt_alloc_thread(NULL, stksize, -1, TDF_VERBOSE);
92     if (tdp)
93         *tdp = td;
94     cpu_set_thread_handler(td, kthread_exit, func, arg);
95 #ifdef SMP
96     KKASSERT(td->td_mpcount == 1);
97 #endif
98     __va_start(ap, fmt);
99     kvsnprintf(td->td_comm, sizeof(td->td_comm), fmt, ap);
100     __va_end(ap);
101
102     lwkt_schedule(td);
103     return 0;
104 }
105
106 /*
107  * Destroy an LWKT thread.   Warning!  This function is not called when
108  * a process exits, cpu_proc_exit() directly calls cpu_thread_exit() and
109  * uses a different reaping mechanism.
110  *
111  * XXX duplicates lwkt_exit()
112  */
113 void
114 kthread_exit(void)
115 {
116     lwkt_exit();
117 }
118
119
120 /*
121  * Start a kernel process.  This is called after a fork() call in
122  * mi_startup() in the file kern/init_main.c.
123  *
124  * This function is used to start "internal" daemons and intended
125  * to be called from SYSINIT().
126  */
127 void
128 kproc_start(const void *udata)
129 {
130         const struct kproc_desc *kp = udata;
131         int error;
132
133         error = kthread_create((void (*)(void *))kp->func, NULL,
134                     kp->global_threadpp, kp->arg0);
135         lwkt_setpri(*kp->global_threadpp, TDPRI_KERN_DAEMON);
136         if (error)
137                 panic("kproc_start: %s: error %d", kp->arg0, error);
138 }
139
140 /*
141  * Advise a kernel process to suspend (or resume) in its main loop.
142  * Participation is voluntary.
143  */
144 int
145 suspend_kproc(struct thread *td, int timo)
146 {
147         if (td->td_proc == NULL) {
148                 td->td_flags |= TDF_STOPREQ;    /* request thread pause */
149                 wakeup(td);
150                 while (td->td_flags & TDF_STOPREQ) {
151                         int error = tsleep(td, 0, "suspkp", timo);
152                         if (error == EWOULDBLOCK)
153                                 break;
154                 }
155                 td->td_flags &= ~TDF_STOPREQ;
156                 return(0);
157         } else {
158                 return(EINVAL); /* not a kernel thread */
159         }
160 }
161
162 void
163 kproc_suspend_loop(void)
164 {
165         struct thread *td = curthread;
166
167         if (td->td_flags & TDF_STOPREQ) {
168                 td->td_flags &= ~TDF_STOPREQ;
169                 while ((td->td_flags & TDF_WAKEREQ) == 0) {
170                         wakeup(td);
171                         tsleep(td, 0, "kpsusp", 0);
172                 }
173                 td->td_flags &= ~TDF_WAKEREQ;
174                 wakeup(td);
175         }
176 }
177