1 /* SPDX-License-Identifier: GPL-2.0 */ 2 /* 3 * linux/include/linux/sunrpc/sched.h 4 * 5 * Scheduling primitives for kernel Sun RPC. 6 * 7 * Copyright (C) 1996, Olaf Kirch <[email protected]> 8 */ 9 10 #ifndef _LINUX_SUNRPC_SCHED_H_ 11 #define _LINUX_SUNRPC_SCHED_H_ 12 13 #include <linux/timer.h> 14 #include <linux/ktime.h> 15 #include <linux/sunrpc/types.h> 16 #include <linux/spinlock.h> 17 #include <linux/wait_bit.h> 18 #include <linux/workqueue.h> 19 #include <linux/sunrpc/xdr.h> 20 21 /* 22 * This is the actual RPC procedure call info. 23 */ 24 struct rpc_procinfo; 25 struct rpc_message { 26 const struct rpc_procinfo *rpc_proc; /* Procedure information */ 27 void * rpc_argp; /* Arguments */ 28 void * rpc_resp; /* Result */ 29 const struct cred * rpc_cred; /* Credentials */ 30 }; 31 32 struct rpc_call_ops; 33 struct rpc_wait_queue; 34 struct rpc_wait { 35 struct list_head list; /* wait queue links */ 36 struct list_head links; /* Links to related tasks */ 37 struct list_head timer_list; /* Timer list */ 38 unsigned long expires; 39 }; 40 41 /* 42 * This is the RPC task struct 43 */ 44 struct rpc_task { 45 atomic_t tk_count; /* Reference count */ 46 int tk_status; /* result of last operation */ 47 struct list_head tk_task; /* global list of tasks */ 48 49 /* 50 * callback to be executed after waking up 51 * action next procedure for async tasks 52 */ 53 void (*tk_callback)(struct rpc_task *); 54 void (*tk_action)(struct rpc_task *); 55 56 unsigned long tk_timeout; /* timeout for rpc_sleep() */ 57 unsigned long tk_runstate; /* Task run status */ 58 59 struct rpc_wait_queue *tk_waitqueue; /* RPC wait queue we're on */ 60 union { 61 struct work_struct tk_work; /* Async task work queue */ 62 struct rpc_wait tk_wait; /* RPC wait */ 63 } u; 64 65 /* 66 * RPC call state 67 */ 68 struct rpc_message tk_msg; /* RPC call info */ 69 void * tk_calldata; /* Caller private data */ 70 const struct rpc_call_ops *tk_ops; /* Caller callbacks */ 71 72 struct rpc_clnt * tk_client; /* RPC client */ 73 struct rpc_xprt * tk_xprt; /* Transport */ 74 struct rpc_cred * tk_op_cred; /* cred being operated on */ 75 76 struct rpc_rqst * tk_rqstp; /* RPC request */ 77 78 struct workqueue_struct *tk_workqueue; /* Normally rpciod, but could 79 * be any workqueue 80 */ 81 ktime_t tk_start; /* RPC task init timestamp */ 82 83 pid_t tk_owner; /* Process id for batching tasks */ 84 unsigned short tk_flags; /* misc flags */ 85 unsigned short tk_timeouts; /* maj timeouts */ 86 87 #if IS_ENABLED(CONFIG_SUNRPC_DEBUG) || IS_ENABLED(CONFIG_TRACEPOINTS) 88 unsigned short tk_pid; /* debugging aid */ 89 #endif 90 unsigned char tk_priority : 2,/* Task priority */ 91 tk_garb_retry : 2, 92 tk_cred_retry : 2, 93 tk_rebind_retry : 2; 94 }; 95 96 typedef void (*rpc_action)(struct rpc_task *); 97 98 struct rpc_call_ops { 99 void (*rpc_call_prepare)(struct rpc_task *, void *); 100 void (*rpc_call_prepare_transmit)(struct rpc_task *, void *); 101 void (*rpc_call_done)(struct rpc_task *, void *); 102 void (*rpc_count_stats)(struct rpc_task *, void *); 103 void (*rpc_release)(void *); 104 }; 105 106 struct rpc_task_setup { 107 struct rpc_task *task; 108 struct rpc_clnt *rpc_client; 109 struct rpc_xprt *rpc_xprt; 110 struct rpc_cred *rpc_op_cred; /* credential being operated on */ 111 const struct rpc_message *rpc_message; 112 const struct rpc_call_ops *callback_ops; 113 void *callback_data; 114 struct workqueue_struct *workqueue; 115 unsigned short flags; 116 signed char priority; 117 }; 118 119 /* 120 * RPC task flags 121 */ 122 #define RPC_TASK_ASYNC 0x0001 /* is an async task */ 123 #define RPC_TASK_SWAPPER 0x0002 /* is swapping in/out */ 124 #define RPC_TASK_NULLCREDS 0x0010 /* Use AUTH_NULL credential */ 125 #define RPC_CALL_MAJORSEEN 0x0020 /* major timeout seen */ 126 #define RPC_TASK_ROOTCREDS 0x0040 /* force root creds */ 127 #define RPC_TASK_DYNAMIC 0x0080 /* task was kmalloc'ed */ 128 #define RPC_TASK_KILLED 0x0100 /* task was killed */ 129 #define RPC_TASK_SOFT 0x0200 /* Use soft timeouts */ 130 #define RPC_TASK_SOFTCONN 0x0400 /* Fail if can't connect */ 131 #define RPC_TASK_SENT 0x0800 /* message was sent */ 132 #define RPC_TASK_TIMEOUT 0x1000 /* fail with ETIMEDOUT on timeout */ 133 #define RPC_TASK_NOCONNECT 0x2000 /* return ENOTCONN if not connected */ 134 #define RPC_TASK_NO_RETRANS_TIMEOUT 0x4000 /* wait forever for a reply */ 135 136 #define RPC_IS_ASYNC(t) ((t)->tk_flags & RPC_TASK_ASYNC) 137 #define RPC_IS_SWAPPER(t) ((t)->tk_flags & RPC_TASK_SWAPPER) 138 #define RPC_ASSASSINATED(t) ((t)->tk_flags & RPC_TASK_KILLED) 139 #define RPC_IS_SOFT(t) ((t)->tk_flags & (RPC_TASK_SOFT|RPC_TASK_TIMEOUT)) 140 #define RPC_IS_SOFTCONN(t) ((t)->tk_flags & RPC_TASK_SOFTCONN) 141 #define RPC_WAS_SENT(t) ((t)->tk_flags & RPC_TASK_SENT) 142 143 #define RPC_TASK_RUNNING 0 144 #define RPC_TASK_QUEUED 1 145 #define RPC_TASK_ACTIVE 2 146 #define RPC_TASK_NEED_XMIT 3 147 #define RPC_TASK_NEED_RECV 4 148 #define RPC_TASK_MSG_PIN_WAIT 5 149 150 #define RPC_IS_RUNNING(t) test_bit(RPC_TASK_RUNNING, &(t)->tk_runstate) 151 #define rpc_set_running(t) set_bit(RPC_TASK_RUNNING, &(t)->tk_runstate) 152 #define rpc_test_and_set_running(t) \ 153 test_and_set_bit(RPC_TASK_RUNNING, &(t)->tk_runstate) 154 #define rpc_clear_running(t) \ 155 do { \ 156 smp_mb__before_atomic(); \ 157 clear_bit(RPC_TASK_RUNNING, &(t)->tk_runstate); \ 158 smp_mb__after_atomic(); \ 159 } while (0) 160 161 #define RPC_IS_QUEUED(t) test_bit(RPC_TASK_QUEUED, &(t)->tk_runstate) 162 #define rpc_set_queued(t) set_bit(RPC_TASK_QUEUED, &(t)->tk_runstate) 163 #define rpc_clear_queued(t) \ 164 do { \ 165 smp_mb__before_atomic(); \ 166 clear_bit(RPC_TASK_QUEUED, &(t)->tk_runstate); \ 167 smp_mb__after_atomic(); \ 168 } while (0) 169 170 #define RPC_IS_ACTIVATED(t) test_bit(RPC_TASK_ACTIVE, &(t)->tk_runstate) 171 172 /* 173 * Task priorities. 174 * Note: if you change these, you must also change 175 * the task initialization definitions below. 176 */ 177 #define RPC_PRIORITY_LOW (-1) 178 #define RPC_PRIORITY_NORMAL (0) 179 #define RPC_PRIORITY_HIGH (1) 180 #define RPC_PRIORITY_PRIVILEGED (2) 181 #define RPC_NR_PRIORITY (1 + RPC_PRIORITY_PRIVILEGED - RPC_PRIORITY_LOW) 182 183 struct rpc_timer { 184 struct timer_list timer; 185 struct list_head list; 186 unsigned long expires; 187 }; 188 189 /* 190 * RPC synchronization objects 191 */ 192 struct rpc_wait_queue { 193 spinlock_t lock; 194 struct list_head tasks[RPC_NR_PRIORITY]; /* task queue for each priority level */ 195 unsigned char maxpriority; /* maximum priority (0 if queue is not a priority queue) */ 196 unsigned char priority; /* current priority */ 197 unsigned char nr; /* # tasks remaining for cookie */ 198 unsigned short qlen; /* total # tasks waiting in queue */ 199 struct rpc_timer timer_list; 200 #if IS_ENABLED(CONFIG_SUNRPC_DEBUG) || IS_ENABLED(CONFIG_TRACEPOINTS) 201 const char * name; 202 #endif 203 }; 204 205 /* 206 * This is the # requests to send consecutively 207 * from a single cookie. The aim is to improve 208 * performance of NFS operations such as read/write. 209 */ 210 #define RPC_IS_PRIORITY(q) ((q)->maxpriority > 0) 211 212 /* 213 * Function prototypes 214 */ 215 struct rpc_task *rpc_new_task(const struct rpc_task_setup *); 216 struct rpc_task *rpc_run_task(const struct rpc_task_setup *); 217 struct rpc_task *rpc_run_bc_task(struct rpc_rqst *req); 218 void rpc_put_task(struct rpc_task *); 219 void rpc_put_task_async(struct rpc_task *); 220 void rpc_exit_task(struct rpc_task *); 221 void rpc_exit(struct rpc_task *, int); 222 void rpc_release_calldata(const struct rpc_call_ops *, void *); 223 void rpc_killall_tasks(struct rpc_clnt *); 224 void rpc_execute(struct rpc_task *); 225 void rpc_init_priority_wait_queue(struct rpc_wait_queue *, const char *); 226 void rpc_init_wait_queue(struct rpc_wait_queue *, const char *); 227 void rpc_destroy_wait_queue(struct rpc_wait_queue *); 228 void rpc_sleep_on(struct rpc_wait_queue *, struct rpc_task *, 229 rpc_action action); 230 void rpc_sleep_on_priority(struct rpc_wait_queue *, 231 struct rpc_task *, 232 rpc_action action, 233 int priority); 234 void rpc_wake_up_queued_task_on_wq(struct workqueue_struct *wq, 235 struct rpc_wait_queue *queue, 236 struct rpc_task *task); 237 void rpc_wake_up_queued_task(struct rpc_wait_queue *, 238 struct rpc_task *); 239 void rpc_wake_up_queued_task_set_status(struct rpc_wait_queue *, 240 struct rpc_task *, 241 int); 242 void rpc_wake_up(struct rpc_wait_queue *); 243 struct rpc_task *rpc_wake_up_next(struct rpc_wait_queue *); 244 struct rpc_task *rpc_wake_up_first_on_wq(struct workqueue_struct *wq, 245 struct rpc_wait_queue *, 246 bool (*)(struct rpc_task *, void *), 247 void *); 248 struct rpc_task *rpc_wake_up_first(struct rpc_wait_queue *, 249 bool (*)(struct rpc_task *, void *), 250 void *); 251 void rpc_wake_up_status(struct rpc_wait_queue *, int); 252 void rpc_delay(struct rpc_task *, unsigned long); 253 int rpc_malloc(struct rpc_task *); 254 void rpc_free(struct rpc_task *); 255 int rpciod_up(void); 256 void rpciod_down(void); 257 int __rpc_wait_for_completion_task(struct rpc_task *task, wait_bit_action_f *); 258 #if IS_ENABLED(CONFIG_SUNRPC_DEBUG) 259 struct net; 260 void rpc_show_tasks(struct net *); 261 #endif 262 int rpc_init_mempool(void); 263 void rpc_destroy_mempool(void); 264 extern struct workqueue_struct *rpciod_workqueue; 265 extern struct workqueue_struct *xprtiod_workqueue; 266 void rpc_prepare_task(struct rpc_task *task); 267 268 static inline int rpc_wait_for_completion_task(struct rpc_task *task) 269 { 270 return __rpc_wait_for_completion_task(task, NULL); 271 } 272 273 #if IS_ENABLED(CONFIG_SUNRPC_DEBUG) || IS_ENABLED(CONFIG_TRACEPOINTS) 274 static inline const char * rpc_qname(const struct rpc_wait_queue *q) 275 { 276 return ((q && q->name) ? q->name : "unknown"); 277 } 278 279 static inline void rpc_assign_waitqueue_name(struct rpc_wait_queue *q, 280 const char *name) 281 { 282 q->name = name; 283 } 284 #else 285 static inline void rpc_assign_waitqueue_name(struct rpc_wait_queue *q, 286 const char *name) 287 { 288 } 289 #endif 290 291 #if IS_ENABLED(CONFIG_SUNRPC_SWAP) 292 int rpc_clnt_swap_activate(struct rpc_clnt *clnt); 293 void rpc_clnt_swap_deactivate(struct rpc_clnt *clnt); 294 #else 295 static inline int 296 rpc_clnt_swap_activate(struct rpc_clnt *clnt) 297 { 298 return -EINVAL; 299 } 300 301 static inline void 302 rpc_clnt_swap_deactivate(struct rpc_clnt *clnt) 303 { 304 } 305 #endif /* CONFIG_SUNRPC_SWAP */ 306 307 static inline bool 308 rpc_task_need_resched(const struct rpc_task *task) 309 { 310 if (RPC_IS_QUEUED(task) || task->tk_callback) 311 return true; 312 return false; 313 } 314 315 #endif /* _LINUX_SUNRPC_SCHED_H_ */ 316