xref: /freebsd/sys/compat/linuxkpi/common/include/linux/sched.h (revision 1ebd7aeecace66b0a21029aedaa4776064f5b6b5)
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  * $FreeBSD$
30  */
31 #ifndef	_LINUXKPI_LINUX_SCHED_H_
32 #define	_LINUXKPI_LINUX_SCHED_H_
33 
34 #include <sys/param.h>
35 #include <sys/systm.h>
36 #include <sys/proc.h>
37 #include <sys/sched.h>
38 #include <sys/sleepqueue.h>
39 #include <sys/time.h>
40 
41 #include <linux/bitmap.h>
42 #include <linux/compat.h>
43 #include <linux/completion.h>
44 #include <linux/hrtimer.h>
45 #include <linux/mm_types.h>
46 #include <linux/pid.h>
47 #include <linux/slab.h>
48 #include <linux/string.h>
49 #include <linux/spinlock.h>
50 #include <linux/time.h>
51 
52 #include <asm/atomic.h>
53 
54 #define	MAX_SCHEDULE_TIMEOUT	INT_MAX
55 
56 #define	TASK_RUNNING		0x0000
57 #define	TASK_INTERRUPTIBLE	0x0001
58 #define	TASK_UNINTERRUPTIBLE	0x0002
59 #define	TASK_NORMAL		(TASK_INTERRUPTIBLE | TASK_UNINTERRUPTIBLE)
60 #define	TASK_WAKING		0x0100
61 #define	TASK_PARKED		0x0200
62 
63 #define	TASK_COMM_LEN		(MAXCOMLEN + 1)
64 
65 struct seq_file;
66 
67 struct work_struct;
68 struct task_struct {
69 	struct thread *task_thread;
70 	struct mm_struct *mm;
71 	linux_task_fn_t *task_fn;
72 	void   *task_data;
73 	int	task_ret;
74 	atomic_t usage;
75 	atomic_t state;
76 	atomic_t kthread_flags;
77 	pid_t	pid;	/* BSD thread ID */
78 	const char    *comm;
79 	void   *bsd_ioctl_data;
80 	unsigned bsd_ioctl_len;
81 	struct completion parked;
82 	struct completion exited;
83 #define	TS_RCU_TYPE_MAX 2
84 	TAILQ_ENTRY(task_struct) rcu_entry[TS_RCU_TYPE_MAX];
85 	int rcu_recurse[TS_RCU_TYPE_MAX];
86 	int bsd_interrupt_value;
87 	struct work_struct *work;	/* current work struct, if set */
88 	struct task_struct *group_leader;
89 	unsigned rcu_section[TS_RCU_TYPE_MAX];
90 	unsigned int fpu_ctx_level;
91 };
92 
93 #define	current	({ \
94 	struct thread *__td = curthread; \
95 	linux_set_current(__td); \
96 	((struct task_struct *)__td->td_lkpi_task); \
97 })
98 
99 #define	task_pid_group_leader(task) (task)->task_thread->td_proc->p_pid
100 #define	task_pid(task)		((task)->pid)
101 #define	task_pid_nr(task)	((task)->pid)
102 #define	task_pid_vnr(task)	((task)->pid)
103 #define	get_pid(x)		(x)
104 #define	put_pid(x)		do { } while (0)
105 #define	current_euid()	(curthread->td_ucred->cr_uid)
106 #define	task_euid(task)	((task)->task_thread->td_ucred->cr_uid)
107 
108 #define	get_task_state(task)		atomic_read(&(task)->state)
109 #define	set_task_state(task, x)		atomic_set(&(task)->state, (x))
110 #define	__set_task_state(task, x)	((task)->state.counter = (x))
111 #define	set_current_state(x)		set_task_state(current, x)
112 #define	__set_current_state(x)		__set_task_state(current, x)
113 
114 static inline void
115 get_task_struct(struct task_struct *task)
116 {
117 	atomic_inc(&task->usage);
118 }
119 
120 static inline void
121 put_task_struct(struct task_struct *task)
122 {
123 	if (atomic_dec_and_test(&task->usage))
124 		linux_free_current(task);
125 }
126 
127 #define	cond_resched()	do { if (!cold) sched_relinquish(curthread); } while (0)
128 
129 #define	yield()		kern_yield(PRI_UNCHANGED)
130 #define	sched_yield()	sched_relinquish(curthread)
131 
132 #define	need_resched() (curthread->td_flags & TDF_NEEDRESCHED)
133 
134 static inline int
135 cond_resched_lock(spinlock_t *lock)
136 {
137 
138 	if (need_resched() == 0)
139 		return (0);
140 	spin_unlock(lock);
141 	cond_resched();
142 	spin_lock(lock);
143 	return (1);
144 }
145 
146 bool linux_signal_pending(struct task_struct *task);
147 bool linux_fatal_signal_pending(struct task_struct *task);
148 bool linux_signal_pending_state(long state, struct task_struct *task);
149 void linux_send_sig(int signo, struct task_struct *task);
150 
151 #define	signal_pending(task)		linux_signal_pending(task)
152 #define	fatal_signal_pending(task)	linux_fatal_signal_pending(task)
153 #define	signal_pending_state(state, task)		\
154 	linux_signal_pending_state(state, task)
155 #define	send_sig(signo, task, priv) do {		\
156 	CTASSERT((priv) == 0);				\
157 	linux_send_sig(signo, task);			\
158 } while (0)
159 
160 int linux_schedule_timeout(int timeout);
161 
162 static inline void
163 linux_schedule_save_interrupt_value(struct task_struct *task, int value)
164 {
165 	task->bsd_interrupt_value = value;
166 }
167 
168 bool linux_task_exiting(struct task_struct *task);
169 
170 #define	current_exiting() \
171 	linux_task_exiting(current)
172 
173 static inline int
174 linux_schedule_get_interrupt_value(struct task_struct *task)
175 {
176 	int value = task->bsd_interrupt_value;
177 	task->bsd_interrupt_value = 0;
178 	return (value);
179 }
180 
181 static inline void
182 schedule(void)
183 {
184 	(void)linux_schedule_timeout(MAX_SCHEDULE_TIMEOUT);
185 }
186 
187 #define	schedule_timeout(timeout)			\
188 	linux_schedule_timeout(timeout)
189 #define	schedule_timeout_killable(timeout)		\
190 	schedule_timeout_interruptible(timeout)
191 #define	schedule_timeout_interruptible(timeout) ({	\
192 	set_current_state(TASK_INTERRUPTIBLE);		\
193 	schedule_timeout(timeout);			\
194 })
195 #define	schedule_timeout_uninterruptible(timeout) ({	\
196 	set_current_state(TASK_UNINTERRUPTIBLE);	\
197 	schedule_timeout(timeout);			\
198 })
199 
200 #define	io_schedule()			schedule()
201 #define	io_schedule_timeout(timeout)	schedule_timeout(timeout)
202 
203 static inline uint64_t
204 local_clock(void)
205 {
206 	struct timespec ts;
207 
208 	nanotime(&ts);
209 	return ((uint64_t)ts.tv_sec * NSEC_PER_SEC + ts.tv_nsec);
210 }
211 
212 static inline const char *
213 get_task_comm(char *buf, struct task_struct *task)
214 {
215 
216 	buf[0] = 0; /* buffer is too small */
217 	return (task->comm);
218 }
219 
220 #endif	/* _LINUXKPI_LINUX_SCHED_H_ */
221