xref: /freebsd/sys/sys/kthread.h (revision 2be1a816b9ff69588e55be0a84cbe2a31efc0f2f)
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$
27  */
28 
29 #ifndef _SYS_KTHREAD_H_
30 #define	_SYS_KTHREAD_H_
31 
32 #include <sys/cdefs.h>
33 
34 /*-
35  * A kernel process descriptor; used to start "internal" daemons.
36  *
37  * Note: global_procpp may be NULL for no global save area.
38  */
39 struct kproc_desc {
40 	char		*arg0;			/* arg 0 (for 'ps' listing) */
41 	void		(*func)(void);	/* "main" for kernel process */
42 	struct proc	**global_procpp;	/* ptr to proc ptr save area */
43 };
44 
45  /* A kernel thread descriptor; used to start "internal" daemons. */
46 struct kthread_desc {
47 	char		*arg0;			/* arg 0 (for 'ps' listing) */
48 	void		(*func)(void);		/* "main" for kernel thread */
49 	struct thread	**global_threadpp;	/* ptr to thread ptr save area */
50 };
51 
52 int     kproc_create(void (*)(void *), void *, struct proc **,
53 	    int flags, int pages, const char *, ...) __printflike(6, 7);
54 void    kproc_exit(int) __dead2;
55 int	kproc_resume(struct proc *);
56 void	kproc_shutdown(void *, int);
57 void	kproc_start(const void *);
58 int	kproc_suspend(struct proc *, int);
59 void	kproc_suspend_check(struct proc *);
60 
61 /* create a thread inthe given process. create the process if needed */
62 int     kproc_kthread_add(void (*)(void *), void *,
63 	    struct proc **,
64 	    struct thread **,
65 	    int flags, int pages,
66 	    char * procname, const char *, ...) __printflike(8, 9);
67 
68 int     kthread_add(void (*)(void *), void *,
69 	    struct proc *, struct thread **,
70 	    int flags, int pages, const char *, ...) __printflike(7, 8);
71 void    kthread_exit(void) __dead2;
72 int	kthread_resume(struct thread *);
73 void	kthread_shutdown(void *, int);
74 void	kthread_start(const void *);
75 int	kthread_suspend(struct thread *, int);
76 void	kthread_suspend_check(struct thread *);
77 
78 
79 #endif /* !_SYS_KTHREAD_H_ */
80