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