xref: /freebsd/sys/compat/linuxkpi/common/include/linux/sched.h (revision 1d386b48a555f61cb7325543adbbb5c3f3407a66)
1 /*-
2  * Copyright (c) 2010 Isilon Systems, Inc.
3  * Copyright (c) 2010 iX Systems, Inc.
4  * Copyright (c) 2010 Panasas, Inc.
5  * Copyright (c) 2013-2018 Mellanox Technologies, Ltd.
6  * All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice unmodified, this list of conditions, and the following
13  *    disclaimer.
14  * 2. Redistributions in binary form must reproduce the above copyright
15  *    notice, this list of conditions and the following disclaimer in the
16  *    documentation and/or other materials provided with the distribution.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
19  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
20  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
21  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
22  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
23  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
27  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28  */
29 #ifndef	_LINUXKPI_LINUX_SCHED_H_
30 #define	_LINUXKPI_LINUX_SCHED_H_
31 
32 #include <sys/param.h>
33 #include <sys/systm.h>
34 #include <sys/proc.h>
35 #include <sys/rtprio.h>
36 #include <sys/sched.h>
37 #include <sys/sleepqueue.h>
38 #include <sys/time.h>
39 
40 #include <linux/bitmap.h>
41 #include <linux/compat.h>
42 #include <linux/completion.h>
43 #include <linux/hrtimer.h>
44 #include <linux/mm_types.h>
45 #include <linux/pid.h>
46 #include <linux/slab.h>
47 #include <linux/string.h>
48 #include <linux/spinlock.h>
49 #include <linux/time.h>
50 
51 #include <linux/sched/mm.h>
52 
53 #include <asm/atomic.h>
54 
55 #define	MAX_SCHEDULE_TIMEOUT	INT_MAX
56 
57 #define	TASK_RUNNING		0x0000
58 #define	TASK_INTERRUPTIBLE	0x0001
59 #define	TASK_UNINTERRUPTIBLE	0x0002
60 #define	TASK_NORMAL		(TASK_INTERRUPTIBLE | TASK_UNINTERRUPTIBLE)
61 #define	TASK_WAKING		0x0100
62 #define	TASK_PARKED		0x0200
63 
64 #define	TASK_COMM_LEN		(MAXCOMLEN + 1)
65 
66 struct seq_file;
67 
68 struct work_struct;
69 struct task_struct {
70 	struct thread *task_thread;
71 	struct mm_struct *mm;
72 	linux_task_fn_t *task_fn;
73 	void   *task_data;
74 	int	task_ret;
75 	atomic_t usage;
76 	atomic_t state;
77 	atomic_t kthread_flags;
78 	pid_t	pid;	/* BSD thread ID */
79 	const char    *comm;
80 	void   *bsd_ioctl_data;
81 	unsigned bsd_ioctl_len;
82 	struct completion parked;
83 	struct completion exited;
84 #define	TS_RCU_TYPE_MAX 2
85 	TAILQ_ENTRY(task_struct) rcu_entry[TS_RCU_TYPE_MAX];
86 	int rcu_recurse[TS_RCU_TYPE_MAX];
87 	int bsd_interrupt_value;
88 	struct work_struct *work;	/* current work struct, if set */
89 	struct task_struct *group_leader;
90 	unsigned rcu_section[TS_RCU_TYPE_MAX];
91 	unsigned int fpu_ctx_level;
92 };
93 
94 #define	current	({ \
95 	struct thread *__td = curthread; \
96 	linux_set_current(__td); \
97 	((struct task_struct *)__td->td_lkpi_task); \
98 })
99 
100 #define	task_pid_group_leader(task) (task)->task_thread->td_proc->p_pid
101 #define	task_pid(task)		((task)->pid)
102 #define	task_pid_nr(task)	((task)->pid)
103 #define	task_pid_vnr(task)	((task)->pid)
104 #define	get_pid(x)		(x)
105 #define	put_pid(x)		do { } while (0)
106 #define	current_euid()	(curthread->td_ucred->cr_uid)
107 #define	task_euid(task)	((task)->task_thread->td_ucred->cr_uid)
108 
109 #define	get_task_state(task)		atomic_read(&(task)->state)
110 #define	set_task_state(task, x)		atomic_set(&(task)->state, (x))
111 #define	__set_task_state(task, x)	((task)->state.counter = (x))
112 #define	set_current_state(x)		set_task_state(current, x)
113 #define	__set_current_state(x)		__set_task_state(current, x)
114 
115 static inline void
116 get_task_struct(struct task_struct *task)
117 {
118 	atomic_inc(&task->usage);
119 }
120 
121 static inline void
122 put_task_struct(struct task_struct *task)
123 {
124 	if (atomic_dec_and_test(&task->usage))
125 		linux_free_current(task);
126 }
127 
128 #define	cond_resched()	do { if (!cold) sched_relinquish(curthread); } while (0)
129 
130 #define	yield()		kern_yield(PRI_UNCHANGED)
131 #define	sched_yield()	sched_relinquish(curthread)
132 
133 #define	need_resched()	(curthread->td_owepreempt || \
134     td_ast_pending(curthread, TDA_SCHED))
135 
136 static inline int
137 cond_resched_lock(spinlock_t *lock)
138 {
139 
140 	if (need_resched() == 0)
141 		return (0);
142 	spin_unlock(lock);
143 	cond_resched();
144 	spin_lock(lock);
145 	return (1);
146 }
147 
148 bool linux_signal_pending(struct task_struct *task);
149 bool linux_fatal_signal_pending(struct task_struct *task);
150 bool linux_signal_pending_state(long state, struct task_struct *task);
151 void linux_send_sig(int signo, struct task_struct *task);
152 
153 #define	signal_pending(task)		linux_signal_pending(task)
154 #define	fatal_signal_pending(task)	linux_fatal_signal_pending(task)
155 #define	signal_pending_state(state, task)		\
156 	linux_signal_pending_state(state, task)
157 #define	send_sig(signo, task, priv) do {		\
158 	CTASSERT((priv) == 0);				\
159 	linux_send_sig(signo, task);			\
160 } while (0)
161 
162 int linux_schedule_timeout(int timeout);
163 
164 static inline void
165 linux_schedule_save_interrupt_value(struct task_struct *task, int value)
166 {
167 	task->bsd_interrupt_value = value;
168 }
169 
170 bool linux_task_exiting(struct task_struct *task);
171 
172 #define	current_exiting() \
173 	linux_task_exiting(current)
174 
175 static inline int
176 linux_schedule_get_interrupt_value(struct task_struct *task)
177 {
178 	int value = task->bsd_interrupt_value;
179 	task->bsd_interrupt_value = 0;
180 	return (value);
181 }
182 
183 static inline void
184 schedule(void)
185 {
186 	(void)linux_schedule_timeout(MAX_SCHEDULE_TIMEOUT);
187 }
188 
189 #define	schedule_timeout(timeout)			\
190 	linux_schedule_timeout(timeout)
191 #define	schedule_timeout_killable(timeout)		\
192 	schedule_timeout_interruptible(timeout)
193 #define	schedule_timeout_interruptible(timeout) ({	\
194 	set_current_state(TASK_INTERRUPTIBLE);		\
195 	schedule_timeout(timeout);			\
196 })
197 #define	schedule_timeout_uninterruptible(timeout) ({	\
198 	set_current_state(TASK_UNINTERRUPTIBLE);	\
199 	schedule_timeout(timeout);			\
200 })
201 
202 #define	io_schedule()			schedule()
203 #define	io_schedule_timeout(timeout)	schedule_timeout(timeout)
204 
205 static inline uint64_t
206 local_clock(void)
207 {
208 	struct timespec ts;
209 
210 	nanotime(&ts);
211 	return ((uint64_t)ts.tv_sec * NSEC_PER_SEC + ts.tv_nsec);
212 }
213 
214 static inline const char *
215 get_task_comm(char *buf, struct task_struct *task)
216 {
217 
218 	buf[0] = 0; /* buffer is too small */
219 	return (task->comm);
220 }
221 
222 static inline void
223 sched_set_fifo(struct task_struct *t)
224 {
225 	struct rtprio rtp;
226 
227 	rtp.prio = (RTP_PRIO_MIN + RTP_PRIO_MAX) / 2;
228 	rtp.type = RTP_PRIO_FIFO;
229 	rtp_to_pri(&rtp, t->task_thread);
230 }
231 
232 static inline void
233 sched_set_fifo_low(struct task_struct *t)
234 {
235 	struct rtprio rtp;
236 
237 	rtp.prio = RTP_PRIO_MAX;	/* lowest priority */
238 	rtp.type = RTP_PRIO_FIFO;
239 	rtp_to_pri(&rtp, t->task_thread);
240 }
241 
242 #endif	/* _LINUXKPI_LINUX_SCHED_H_ */
243