xref: /freebsd/sys/sys/thr.h (revision b00ab754)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
3  *
4  * Copyright (c) 2003, Jeffrey Roberson <jeff@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 unmodified, this list of conditions, and the following
12  *    disclaimer.
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in the
15  *    documentation and/or other materials provided with the distribution.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
18  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27  *
28  * $FreeBSD$
29  *
30  */
31 
32 #ifndef _SYS_THR_H_
33 #define	_SYS_THR_H_
34 
35 #include <sys/cdefs.h>
36 #include <sys/_types.h>
37 #include <sys/sched.h>
38 
39 #ifndef _SIZE_T_DECLARED
40 typedef __size_t	size_t;
41 #define _SIZE_T_DECLARED
42 #endif
43 
44 /* Create the thread in the suspended state. */
45 #define	THR_SUSPENDED		0x0001
46 /* Create the system scope thread. */
47 #define	THR_SYSTEM_SCOPE	0x0002
48 
49 struct thr_param {
50     void	(*start_func)(void *);	/* thread entry function. */
51     void	*arg;			/* argument for entry function. */
52     char	*stack_base;		/* stack base address. */
53     size_t	stack_size;		/* stack size. */
54     char	*tls_base;		/* tls base address. */
55     size_t	tls_size;		/* tls size. */
56     long	*child_tid;		/* address to store new TID. */
57     long	*parent_tid;		/* parent accesses the new TID here. */
58     int		flags;			/* thread flags. */
59     struct rtprio	*rtp;		/* Real-time scheduling priority */
60     void	*spare[3];		/* TODO: cpu affinity mask etc. */
61 };
62 
63 /*
64  * See pthread_*
65  */
66 #ifndef _KERNEL
67 #include <sys/ucontext.h>
68 
69 #ifndef _PID_T_DECLARED
70 typedef __pid_t		pid_t;
71 #define _PID_T_DECLARED
72 #endif
73 
74 __BEGIN_DECLS
75 int thr_create(ucontext_t *ctx, long *id, int flags);
76 int thr_new(struct thr_param *param, int param_size);
77 int thr_self(long *id);
78 void thr_exit(long *state);
79 int thr_kill(long id, int sig);
80 int thr_kill2(pid_t pid, long id, int sig);
81 int thr_suspend(const struct timespec *timeout);
82 int thr_wake(long id);
83 int thr_set_name(long id, const char *name);
84 __END_DECLS
85 #endif /* !_KERNEL */
86 
87 #endif /* ! _SYS_THR_H_ */
88