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