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