xref: /netbsd-src/sys/compat/linux/common/linux_sched.h (revision a3740e150a4bea0d03e70539dc6fe36956b72c38)
1 /*	$NetBSD: linux_sched.h,v 1.11 2024/09/28 19:35:56 christos Exp $	*/
2 
3 /*-
4  * Copyright (c) 1999 The NetBSD Foundation, Inc.
5  * All rights reserved.
6  *
7  * This code is derived from software contributed to The NetBSD Foundation
8  * by Jason R. Thorpe of the Numerical Aerospace Simulation Facility,
9  * NASA Ames Research Center.
10  *
11  * Redistribution and use in source and binary forms, with or without
12  * modification, are permitted provided that the following conditions
13  * are met:
14  * 1. Redistributions of source code must retain the above copyright
15  *    notice, this list of conditions and the following disclaimer.
16  * 2. Redistributions in binary form must reproduce the above copyright
17  *    notice, this list of conditions and the following disclaimer in the
18  *    documentation and/or other materials provided with the distribution.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
21  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
22  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
23  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
24  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30  * POSSIBILITY OF SUCH DAMAGE.
31  */
32 
33 #ifndef _LINUX_SCHED_H
34 #define	_LINUX_SCHED_H
35 
36 /*
37  * Flags passed to the Linux __clone(2) system call.
38  */
39 #define	LINUX_CLONE_CSIGNAL	0x000000ff	/* signal to be sent at exit */
40 #define	LINUX_CLONE_VM		0x00000100	/* share address space */
41 #define	LINUX_CLONE_FS		0x00000200	/* share "file system" info */
42 #define	LINUX_CLONE_FILES	0x00000400	/* share file descriptors */
43 #define	LINUX_CLONE_SIGHAND	0x00000800	/* share signal actions */
44 #define	LINUX_CLONE_PID		0x00001000	/* share process ID */
45 #define	LINUX_CLONE_PTRACE	0x00002000	/* ptrace(2) continues on
46 						   child */
47 #define	LINUX_CLONE_VFORK	0x00004000	/* parent blocks until child
48 						   exits */
49 #define LINUX_CLONE_PARENT	0x00008000	/* want same parent as cloner */
50 #define LINUX_CLONE_THREAD	0x00010000	/* same thread group */
51 #define LINUX_CLONE_NEWNS	0x00020000	/* new namespace group */
52 #define LINUX_CLONE_SYSVSEM	0x00040000	/* share SysV SEM_UNDO */
53 #define LINUX_CLONE_SETTLS	0x00080000	/* create new TLS for child */
54 #define LINUX_CLONE_PARENT_SETTID \
55 				0x00100000	/* set TID in the parent */
56 #define LINUX_CLONE_CHILD_CLEARTID \
57 				0x00200000	/* clear TID in the child */
58 #define LINUX_CLONE_DETACHED	0x00400000	/* unused */
59 #define LINUX_CLONE_UNTRACED	0x00800000	/* set if parent cannot force CLONE_PTRACE */
60 #define LINUX_CLONE_CHILD_SETTID \
61 				0x01000000	/* set TID in the child */
62 #define LINUX_CLONE_STOPPED	0x02000000	/* start in stopped state */
63 
64 /*
65  * Flags that clone supports but are yet to be supported in NetBSD
66  */
67 
68 #define	LINUX_CLONE_PIDFD		0x00001000	/* since Linux 5.2 */
69 #define	LINUX_CLONE_NEWCGROUP		0x02000000	/* New cgroup NS */
70 #define	LINUX_CLONE_NEWUTS		0x04000000
71 #define	LINUX_CLONE_NEWIPC		0x08000000
72 #define	LINUX_CLONE_NEWUSER		0x10000000
73 #define	LINUX_CLONE_NEWPID		0x20000000
74 #define	LINUX_CLONE_NEWNET		0x40000000
75 #define	LINUX_CLONE_IO			0x80000000
76 
77 /* Flags for the clone3() syscall. */
78 #define	LINUX_CLONE_CLEAR_SIGHAND	0x100000000ULL
79 #define	LINUX_CLONE_INTO_CGROUP		0x200000000ULL
80 #define	LINUX_CLONE_NEWTIME		0x00000080
81 
82 #define	LINUX_CLONE_LEGACY_FLAGS	0xffffffffULL
83 
84 #define LINUX_CLONE_ALLOWED_FLAGS ( \
85     LINUX_CLONE_VM | LINUX_CLONE_FS | LINUX_CLONE_FILES | \
86     LINUX_CLONE_SIGHAND | LINUX_CLONE_THREAD | LINUX_CLONE_VFORK | \
87     LINUX_CLONE_PARENT_SETTID | LINUX_CLONE_CHILD_CLEARTID | \
88     LINUX_CLONE_CHILD_SETTID | LINUX_CLONE_SETTLS)
89 
90 #define LINUX_CLONE_UNIMPLEMENTED_FLAGS ( \
91     LINUX_CLONE_NEWNS | LINUX_CLONE_NEWUTS | LINUX_CLONE_NEWIPC | \
92     LINUX_CLONE_NEWUSER | LINUX_CLONE_NEWPID | LINUX_CLONE_NEWNET | \
93     LINUX_CLONE_PIDFD)
94 
95 #define	LINUX_CSIGNAL			0x000000ff
96 struct linux_sched_param {
97 	int	sched_priority;
98 };
99 
100 #define LINUX_SCHED_OTHER	0
101 #define LINUX_SCHED_FIFO	1
102 #define LINUX_SCHED_RR		2
103 
104 struct linux_timespec {
105 	linux_time_t	tv_sec;		/* seconds */
106 	long		tv_nsec;	/* nanoseconds */
107 };
108 
109 struct linux_itimerspec {
110 	struct linux_timespec it_interval;
111 	struct linux_timespec it_value;
112 };
113 
114 struct linux_user_clone3_args {
115 	uint64_t flags;        /* Flags bit mask */
116 	uint64_t pidfd;        /* Where to store PID file descriptor (int *) */
117 	uint64_t child_tid;    /* Where to store child TID, in child's memory
118 				  (pid_t *) */
119 	uint64_t parent_tid;   /* Where to store child TID, in parent's memory
120 				  (pid_t *) */
121 	uint64_t exit_signal;  /* Signal to deliver to parent on child
122 				  termination */
123 	uint64_t stack;        /* Pointer to lowest byte of stack */
124 	uint64_t stack_size;   /* Size of stack */
125 	uint64_t tls;          /* Location of new TLS */
126 	uint64_t set_tid;      /* Pointer to a pid_t array (since Linux 5.5) */
127 	uint64_t set_tid_size; /* Number of elements in set_tid (since Linux
128 				  5.5) */
129 	uint64_t cgroup;       /* File descriptor for target cgroup of child
130 				  (since Linux 5.7) */
131 };
132 
133 
134 #define LINUX_CLOCK_REALTIME		0
135 #define LINUX_CLOCK_MONOTONIC		1
136 #define LINUX_CLOCK_PROCESS_CPUTIME_ID	2
137 #define LINUX_CLOCK_THREAD_CPUTIME_ID	3
138 #define LINUX_CLOCK_MONOTONIC_RAW	4
139 #define	LINUX_CLOCK_REALTIME_COARSE	5
140 #define	LINUX_CLOCK_MONOTONIC_COARSE	6
141 #define	LINUX_CLOCK_BOOTTIME		7
142 #define	LINUX_CLOCK_BOOTTIME_ALARM	8
143 #define	LINUX_CLOCK_REALTIME_ALARM	9
144 
145 #define LINUX_TIMER_ABSTIME		0x01
146 
147 int	linux_to_native_clockid(clockid_t *, clockid_t);
148 
149 void	native_to_linux_timespec(struct linux_timespec *,
150 	    const struct timespec *);
151 void	linux_to_native_timespec(struct timespec *,
152 	    const struct linux_timespec *);
153 
154 void	native_to_linux_itimerspec(struct linux_itimerspec *,
155 	    const struct itimerspec *);
156 void	linux_to_native_itimerspec(struct itimerspec *,
157 	    const struct linux_itimerspec *);
158 
159 int	linux_to_native_timer_create_clockid(clockid_t *, clockid_t);
160 
161 int	linux_to_native_timerfd_settime_flags(int *, int);
162 
163 #endif /* _LINUX_SCHED_H */
164