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