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/nodemask.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 <linux/sched/mm.h> 53 54 #include <asm/atomic.h> 55 56 #define MAX_SCHEDULE_TIMEOUT LONG_MAX 57 58 #define TASK_RUNNING 0x0000 59 #define TASK_INTERRUPTIBLE 0x0001 60 #define TASK_UNINTERRUPTIBLE 0x0002 61 #define TASK_NORMAL (TASK_INTERRUPTIBLE | TASK_UNINTERRUPTIBLE) 62 #define TASK_WAKING 0x0100 63 #define TASK_PARKED 0x0200 64 65 #define TASK_COMM_LEN (MAXCOMLEN + 1) 66 67 struct seq_file; 68 69 struct work_struct; 70 struct task_struct { 71 struct thread *task_thread; 72 struct mm_struct *mm; 73 linux_task_fn_t *task_fn; 74 void *task_data; 75 int task_ret; 76 atomic_t usage; 77 atomic_t state; 78 atomic_t kthread_flags; 79 pid_t pid; /* BSD thread ID */ 80 pid_t tgid; 81 const char *comm; 82 void *bsd_ioctl_data; 83 unsigned bsd_ioctl_len; 84 struct completion parked; 85 struct completion exited; 86 #define TS_RCU_TYPE_MAX 2 87 TAILQ_ENTRY(task_struct) rcu_entry[TS_RCU_TYPE_MAX]; 88 int rcu_recurse[TS_RCU_TYPE_MAX]; 89 int bsd_interrupt_value; 90 struct work_struct *work; /* current work struct, if set */ 91 struct task_struct *group_leader; 92 unsigned rcu_section[TS_RCU_TYPE_MAX]; 93 unsigned int fpu_ctx_level; 94 }; 95 96 struct task_struct *__lkpi_current(void); 97 #define current (__lkpi_current()) 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_owepreempt || \ 133 td_ast_pending(curthread, TDA_SCHED)) 134 135 static inline int 136 cond_resched_lock(spinlock_t *lock) 137 { 138 139 if (need_resched() == 0) 140 return (0); 141 spin_unlock(lock); 142 cond_resched(); 143 spin_lock(lock); 144 return (1); 145 } 146 147 bool linux_signal_pending(struct task_struct *task); 148 bool linux_fatal_signal_pending(struct task_struct *task); 149 bool linux_signal_pending_state(long state, struct task_struct *task); 150 void linux_send_sig(int signo, struct task_struct *task); 151 152 #define signal_pending(task) linux_signal_pending(task) 153 #define fatal_signal_pending(task) linux_fatal_signal_pending(task) 154 #define signal_pending_state(state, task) \ 155 linux_signal_pending_state(state, task) 156 #define send_sig(signo, task, priv) do { \ 157 CTASSERT((priv) == 0); \ 158 linux_send_sig(signo, task); \ 159 } while (0) 160 161 long linux_schedule_timeout(long timeout); 162 163 static inline void 164 linux_schedule_save_interrupt_value(struct task_struct *task, int value) 165 { 166 task->bsd_interrupt_value = value; 167 } 168 169 bool linux_task_exiting(struct task_struct *task); 170 171 #define current_exiting() \ 172 linux_task_exiting(current) 173 174 static inline int 175 linux_schedule_get_interrupt_value(struct task_struct *task) 176 { 177 int value = task->bsd_interrupt_value; 178 task->bsd_interrupt_value = 0; 179 return (value); 180 } 181 182 static inline void 183 schedule(void) 184 { 185 (void)linux_schedule_timeout(MAX_SCHEDULE_TIMEOUT); 186 } 187 188 #define schedule_timeout(timeout) \ 189 linux_schedule_timeout(timeout) 190 #define schedule_timeout_killable(timeout) \ 191 schedule_timeout_interruptible(timeout) 192 #define schedule_timeout_interruptible(timeout) ({ \ 193 set_current_state(TASK_INTERRUPTIBLE); \ 194 schedule_timeout(timeout); \ 195 }) 196 #define schedule_timeout_uninterruptible(timeout) ({ \ 197 set_current_state(TASK_UNINTERRUPTIBLE); \ 198 schedule_timeout(timeout); \ 199 }) 200 201 #define io_schedule() schedule() 202 #define io_schedule_timeout(timeout) schedule_timeout(timeout) 203 204 static inline uint64_t 205 local_clock(void) 206 { 207 struct timespec ts; 208 209 nanotime(&ts); 210 return ((uint64_t)ts.tv_sec * NSEC_PER_SEC + ts.tv_nsec); 211 } 212 213 static inline const char * 214 get_task_comm(char *buf, struct task_struct *task) 215 { 216 217 buf[0] = 0; /* buffer is too small */ 218 return (task->comm); 219 } 220 221 static inline void 222 sched_set_fifo(struct task_struct *t) 223 { 224 struct rtprio rtp; 225 226 rtp.prio = (RTP_PRIO_MIN + RTP_PRIO_MAX) / 2; 227 rtp.type = RTP_PRIO_FIFO; 228 rtp_to_pri(&rtp, t->task_thread); 229 } 230 231 static inline void 232 sched_set_fifo_low(struct task_struct *t) 233 { 234 struct rtprio rtp; 235 236 rtp.prio = RTP_PRIO_MAX; /* lowest priority */ 237 rtp.type = RTP_PRIO_FIFO; 238 rtp_to_pri(&rtp, t->task_thread); 239 } 240 241 #endif /* _LINUXKPI_LINUX_SCHED_H_ */ 242