xref: /dragonfly/sys/sys/kthread.h (revision e6d22e9b)
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 
27 #ifndef _SYS_KTHREAD_H_
28 #define _SYS_KTHREAD_H_
29 
30 #ifndef _SYS_CDEFS_H_
31 #include <sys/cdefs.h>
32 #endif
33 
34 #if !defined(_KERNEL) && !defined(_KERNEL_STRUCTURES)
35 #error "This file should not be included by userland programs."
36 #endif
37 
38 struct proc;
39 struct thread;
40 
41 /*
42  * A kernel process descriptor; used to start "internal" daemons
43  *
44  * Note: global_procpp may be NULL for no global save area
45  */
46 struct kproc_desc {
47 	char		*arg0;			/* arg 0 (for 'ps' listing) */
48 	void		(*func) (void);		/* "main" for kernel process */
49 	struct thread	**global_threadpp;	/* ptr to proc ptr save area */
50 };
51 
52 #ifdef _KERNEL
53 void	kproc_start (const void *);
54 
55 int	suspend_kproc (struct thread *, int);
56 int	resume_kproc (struct thread *);
57 void	kproc_suspend_loop (void);
58 void	shutdown_kproc (void *, int);
59 int	kthread_alloc (void (*)(void *), void *, struct thread **,
60 	    const char *, ...) __printflike(4, 5);
61 int	kthread_create (void (*)(void *), void *, struct thread **,
62 	    const char *, ...) __printflike(4, 5);
63 int	kthread_create_cpu (void (*)(void *), void *, struct thread **,
64 	    int, const char *, ...) __printflike(5, 6);
65 void	kthread_exit (void) __dead2;
66 #endif /* _KERNEL */
67 
68 #endif /* _SYS_KTHREAD_H_ */
69