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