xref: /freebsd/sys/compat/linuxkpi/common/include/linux/sched.h (revision e3514747256465c52c3b2aedc9795f52c0d3efe9)
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-2017 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	_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 
40 #include <linux/list.h>
41 #include <linux/compat.h>
42 #include <linux/completion.h>
43 #include <linux/pid.h>
44 #include <linux/slab.h>
45 #include <linux/mm_types.h>
46 #include <linux/string.h>
47 #include <linux/bitmap.h>
48 
49 #include <asm/atomic.h>
50 
51 #define	MAX_SCHEDULE_TIMEOUT	LONG_MAX
52 
53 #define	TASK_RUNNING		0
54 #define	TASK_INTERRUPTIBLE	1
55 #define	TASK_UNINTERRUPTIBLE	2
56 #define	TASK_DEAD		64
57 #define	TASK_WAKEKILL		128
58 #define	TASK_WAKING		256
59 
60 struct task_struct {
61 	struct thread *task_thread;
62 	struct mm_struct *mm;
63 	linux_task_fn_t *task_fn;
64 	void   *task_data;
65 	int	task_ret;
66 	atomic_t usage;
67 	int	state;
68 	atomic_t kthread_flags;
69 	pid_t	pid;	/* BSD thread ID */
70 	const char    *comm;
71 	void   *bsd_ioctl_data;
72 	unsigned bsd_ioctl_len;
73 	struct completion parked;
74 	struct completion exited;
75 	TAILQ_ENTRY(task_struct) rcu_entry;
76 	int rcu_recurse;
77 };
78 
79 #define	current	({ \
80 	struct thread *__td = curthread; \
81 	linux_set_current(__td); \
82 	((struct task_struct *)__td->td_lkpi_task); \
83 })
84 
85 #define	task_pid_group_leader(task) (task)->task_thread->td_proc->p_pid
86 #define	task_pid(task)		((task)->pid)
87 #define	task_pid_nr(task)	((task)->pid)
88 #define	get_pid(x)		(x)
89 #define	put_pid(x)		do { } while (0)
90 #define	current_euid()	(curthread->td_ucred->cr_uid)
91 
92 #define	set_current_state(x)						\
93 	atomic_store_rel_int((volatile int *)&current->state, (x))
94 #define	__set_current_state(x)	current->state = (x)
95 
96 static inline void
97 get_task_struct(struct task_struct *task)
98 {
99 	atomic_inc(&task->usage);
100 }
101 
102 static inline void
103 put_task_struct(struct task_struct *task)
104 {
105 	if (atomic_dec_and_test(&task->usage))
106 		linux_free_current(task);
107 }
108 
109 #define	schedule()							\
110 do {									\
111 	void *c;							\
112 									\
113 	if (cold || SCHEDULER_STOPPED())				\
114 		break;							\
115 	c = curthread;							\
116 	sleepq_lock(c);							\
117 	if (current->state == TASK_INTERRUPTIBLE ||			\
118 	    current->state == TASK_UNINTERRUPTIBLE) {			\
119 		sleepq_add(c, NULL, "task", SLEEPQ_SLEEP, 0);		\
120 		sleepq_wait(c, 0);					\
121 	} else {							\
122 		sleepq_release(c);					\
123 		sched_relinquish(curthread);				\
124 	}								\
125 } while (0)
126 
127 #define	wake_up_process(x)						\
128 do {									\
129 	int wakeup_swapper;						\
130 	void *c;							\
131 									\
132 	c = (x)->task_thread;						\
133 	sleepq_lock(c);							\
134 	(x)->state = TASK_RUNNING;					\
135 	wakeup_swapper = sleepq_signal(c, SLEEPQ_SLEEP, 0, 0);		\
136 	sleepq_release(c);						\
137 	if (wakeup_swapper)						\
138 		kick_proc0();						\
139 } while (0)
140 
141 #define	cond_resched()	if (!cold)	sched_relinquish(curthread)
142 
143 #define	sched_yield()	sched_relinquish(curthread)
144 
145 static inline long
146 schedule_timeout(signed long timeout)
147 {
148 	if (timeout < 0)
149 		return 0;
150 
151 	pause("lstim", timeout);
152 
153 	return 0;
154 }
155 
156 #define	need_resched() (curthread->td_flags & TDF_NEEDRESCHED)
157 
158 #endif	/* _LINUX_SCHED_H_ */
159