xref: /freebsd/sys/sys/kthread.h (revision fe6060f10f634930ff71b7c50291ddc610da2475)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
3  *
4  * Copyright (c) 1999 Peter Wemm <peter@FreeBSD.org>
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26  * SUCH DAMAGE.
27  *
28  * $FreeBSD$
29  */
30 
31 #ifndef _SYS_KTHREAD_H_
32 #define	_SYS_KTHREAD_H_
33 
34 #include <sys/cdefs.h>
35 
36 /*
37  * A kernel process descriptor; used to start "internal" daemons.
38  *
39  * Note: global_procpp may be NULL for no global save area.
40  */
41 struct kproc_desc {
42 	const char	*arg0;			/* arg 0 (for 'ps' listing) */
43 	void		(*func)(void);		/* "main" for kernel process */
44 	struct proc	**global_procpp;	/* ptr to proc ptr save area */
45 };
46 
47  /* A kernel thread descriptor; used to start "internal" daemons. */
48 struct kthread_desc {
49 	const char	*arg0;			/* arg 0 (for 'ps' listing) */
50 	void		(*func)(void);		/* "main" for kernel thread */
51 	struct thread	**global_threadpp;	/* ptr to thread ptr save area */
52 };
53 
54 int     kproc_create(void (*)(void *), void *, struct proc **,
55 	    int flags, int pages, const char *, ...) __printflike(6, 7);
56 void    kproc_exit(int) __dead2;
57 int	kproc_resume(struct proc *);
58 void	kproc_shutdown(void *, int);
59 void	kproc_start(const void *);
60 int	kproc_suspend(struct proc *, int);
61 void	kproc_suspend_check(struct proc *);
62 
63 /* create a thread inthe given process. create the process if needed */
64 int     kproc_kthread_add(void (*)(void *), void *,
65 	    struct proc **,
66 	    struct thread **,
67 	    int flags, int pages,
68 	    const char *procname, const char *, ...) __printflike(8, 9);
69 
70 int     kthread_add(void (*)(void *), void *,
71 	    struct proc *, struct thread **,
72 	    int flags, int pages, const char *, ...) __printflike(7, 8);
73 void    kthread_exit(void) __dead2;
74 int	kthread_resume(struct thread *);
75 void	kthread_shutdown(void *, int);
76 void	kthread_start(const void *);
77 int	kthread_suspend(struct thread *, int);
78 void	kthread_suspend_check(void);
79 
80 #endif /* !_SYS_KTHREAD_H_ */
81