SUNRPC: Cleanup of rpc_task initialisation
[linux-2.6-block.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>
13#include <linux/sunrpc/types.h>
8aca67f0 14#include <linux/rcupdate.h>
1da177e4
LT
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 */
1da177e4
LT
36 struct rpc_wait_queue * rpc_waitq; /* RPC wait queue we're on */
37};
38
39/*
40 * This is the RPC task struct
41 */
42struct rpc_task {
43#ifdef RPC_DEBUG
44 unsigned long tk_magic; /* 0xf00baa */
45#endif
44c28873 46 atomic_t tk_count; /* Reference count */
1da177e4
LT
47 struct list_head tk_task; /* global list of tasks */
48 struct rpc_clnt * tk_client; /* RPC client */
49 struct rpc_rqst * tk_rqstp; /* RPC request */
50 int tk_status; /* result of last operation */
51
52 /*
53 * RPC call state
54 */
55 struct rpc_message tk_msg; /* RPC call info */
1da177e4
LT
56 __u8 tk_garb_retry;
57 __u8 tk_cred_retry;
58
59 unsigned long tk_cookie; /* Cookie for batching tasks */
60
61 /*
62 * timeout_fn to be executed by timer bottom half
63 * callback to be executed after waking up
64 * action next procedure for async tasks
963d8fe5 65 * tk_ops caller callbacks
1da177e4
LT
66 */
67 void (*tk_timeout_fn)(struct rpc_task *);
68 void (*tk_callback)(struct rpc_task *);
69 void (*tk_action)(struct rpc_task *);
963d8fe5 70 const struct rpc_call_ops *tk_ops;
1da177e4
LT
71 void * tk_calldata;
72
73 /*
74 * tk_timer is used for async processing by the RPC scheduling
75 * primitives. You should not access this directly unless
76 * you have a pathological interest in kernel oopses.
77 */
78 struct timer_list tk_timer; /* kernel timer */
79 unsigned long tk_timeout; /* timeout for rpc_sleep() */
80 unsigned short tk_flags; /* misc flags */
1da177e4
LT
81 unsigned char tk_priority : 2;/* Task priority */
82 unsigned long tk_runstate; /* Task run status */
83 struct workqueue_struct *tk_workqueue; /* Normally rpciod, but could
84 * be any workqueue
85 */
86 union {
87 struct work_struct tk_work; /* Async task work queue */
88 struct rpc_wait tk_wait; /* RPC wait */
8aca67f0 89 struct rcu_head tk_rcu; /* for task deletion */
1da177e4 90 } u;
ef759a2e
CL
91
92 unsigned short tk_timeouts; /* maj timeouts */
93 size_t tk_bytes_sent; /* total bytes sent */
94 unsigned long tk_start; /* RPC task init timestamp */
95 long tk_rtt; /* round-trip time (jiffies) */
96
1da177e4
LT
97#ifdef RPC_DEBUG
98 unsigned short tk_pid; /* debugging aid */
99#endif
100};
1da177e4
LT
101#define tk_xprt tk_client->cl_xprt
102
103/* support walking a list of tasks on a wait queue */
104#define task_for_each(task, pos, head) \
105 list_for_each(pos, head) \
106 if ((task=list_entry(pos, struct rpc_task, u.tk_wait.list)),1)
107
108#define task_for_first(task, head) \
109 if (!list_empty(head) && \
110 ((task=list_entry((head)->next, struct rpc_task, u.tk_wait.list)),1))
111
1da177e4
LT
112typedef void (*rpc_action)(struct rpc_task *);
113
963d8fe5 114struct rpc_call_ops {
4ce70ada 115 void (*rpc_call_prepare)(struct rpc_task *, void *);
963d8fe5
TM
116 void (*rpc_call_done)(struct rpc_task *, void *);
117 void (*rpc_release)(void *);
118};
119
84115e1c
TM
120struct rpc_task_setup {
121 struct rpc_clnt *rpc_client;
122 const struct rpc_message *rpc_message;
123 const struct rpc_call_ops *callback_ops;
124 void *callback_data;
125 unsigned short flags;
126};
963d8fe5 127
1da177e4
LT
128/*
129 * RPC task flags
130 */
131#define RPC_TASK_ASYNC 0x0001 /* is an async task */
132#define RPC_TASK_SWAPPER 0x0002 /* is swapping in/out */
1da177e4
LT
133#define RPC_CALL_MAJORSEEN 0x0020 /* major timeout seen */
134#define RPC_TASK_ROOTCREDS 0x0040 /* force root creds */
135#define RPC_TASK_DYNAMIC 0x0080 /* task was kmalloc'ed */
136#define RPC_TASK_KILLED 0x0100 /* task was killed */
137#define RPC_TASK_SOFT 0x0200 /* Use soft timeouts */
138#define RPC_TASK_NOINTR 0x0400 /* uninterruptible task */
139
140#define RPC_IS_ASYNC(t) ((t)->tk_flags & RPC_TASK_ASYNC)
1da177e4
LT
141#define RPC_IS_SWAPPER(t) ((t)->tk_flags & RPC_TASK_SWAPPER)
142#define RPC_DO_ROOTOVERRIDE(t) ((t)->tk_flags & RPC_TASK_ROOTCREDS)
143#define RPC_ASSASSINATED(t) ((t)->tk_flags & RPC_TASK_KILLED)
1da177e4
LT
144#define RPC_DO_CALLBACK(t) ((t)->tk_callback != NULL)
145#define RPC_IS_SOFT(t) ((t)->tk_flags & RPC_TASK_SOFT)
146#define RPC_TASK_UNINTERRUPTIBLE(t) ((t)->tk_flags & RPC_TASK_NOINTR)
147
148#define RPC_TASK_RUNNING 0
149#define RPC_TASK_QUEUED 1
150#define RPC_TASK_WAKEUP 2
151#define RPC_TASK_HAS_TIMER 3
44c28873 152#define RPC_TASK_ACTIVE 4
1da177e4 153
7b8f850b
RB
154#define RPC_IS_RUNNING(t) test_bit(RPC_TASK_RUNNING, &(t)->tk_runstate)
155#define rpc_set_running(t) set_bit(RPC_TASK_RUNNING, &(t)->tk_runstate)
1da177e4 156#define rpc_test_and_set_running(t) \
7b8f850b 157 test_and_set_bit(RPC_TASK_RUNNING, &(t)->tk_runstate)
1da177e4
LT
158#define rpc_clear_running(t) \
159 do { \
160 smp_mb__before_clear_bit(); \
161 clear_bit(RPC_TASK_RUNNING, &(t)->tk_runstate); \
162 smp_mb__after_clear_bit(); \
163 } while (0)
164
7b8f850b
RB
165#define RPC_IS_QUEUED(t) test_bit(RPC_TASK_QUEUED, &(t)->tk_runstate)
166#define rpc_set_queued(t) set_bit(RPC_TASK_QUEUED, &(t)->tk_runstate)
1da177e4
LT
167#define rpc_clear_queued(t) \
168 do { \
169 smp_mb__before_clear_bit(); \
170 clear_bit(RPC_TASK_QUEUED, &(t)->tk_runstate); \
171 smp_mb__after_clear_bit(); \
172 } while (0)
173
174#define rpc_start_wakeup(t) \
175 (test_and_set_bit(RPC_TASK_WAKEUP, &(t)->tk_runstate) == 0)
176#define rpc_finish_wakeup(t) \
177 do { \
178 smp_mb__before_clear_bit(); \
179 clear_bit(RPC_TASK_WAKEUP, &(t)->tk_runstate); \
180 smp_mb__after_clear_bit(); \
181 } while (0)
182
7b8f850b 183#define RPC_IS_ACTIVATED(t) test_bit(RPC_TASK_ACTIVE, &(t)->tk_runstate)
44c28873 184
1da177e4
LT
185/*
186 * Task priorities.
187 * Note: if you change these, you must also change
188 * the task initialization definitions below.
189 */
190#define RPC_PRIORITY_LOW 0
191#define RPC_PRIORITY_NORMAL 1
192#define RPC_PRIORITY_HIGH 2
193#define RPC_NR_PRIORITY (RPC_PRIORITY_HIGH+1)
194
195/*
196 * RPC synchronization objects
197 */
198struct rpc_wait_queue {
199 spinlock_t lock;
200 struct list_head tasks[RPC_NR_PRIORITY]; /* task queue for each priority level */
201 unsigned long cookie; /* cookie of last task serviced */
202 unsigned char maxpriority; /* maximum priority (0 if queue is not a priority queue) */
203 unsigned char priority; /* current priority */
204 unsigned char count; /* # task groups remaining serviced so far */
205 unsigned char nr; /* # tasks remaining for cookie */
e19b63da 206 unsigned short qlen; /* total # tasks waiting in queue */
1da177e4
LT
207#ifdef RPC_DEBUG
208 const char * name;
209#endif
210};
211
212/*
213 * This is the # requests to send consecutively
214 * from a single cookie. The aim is to improve
215 * performance of NFS operations such as read/write.
216 */
217#define RPC_BATCH_COUNT 16
218
219#ifndef RPC_DEBUG
220# define RPC_WAITQ_INIT(var,qname) { \
6cfd76a2 221 .lock = __SPIN_LOCK_UNLOCKED(var.lock), \
1da177e4
LT
222 .tasks = { \
223 [0] = LIST_HEAD_INIT(var.tasks[0]), \
224 [1] = LIST_HEAD_INIT(var.tasks[1]), \
225 [2] = LIST_HEAD_INIT(var.tasks[2]), \
226 }, \
227 }
228#else
229# define RPC_WAITQ_INIT(var,qname) { \
6cfd76a2 230 .lock = __SPIN_LOCK_UNLOCKED(var.lock), \
1da177e4
LT
231 .tasks = { \
232 [0] = LIST_HEAD_INIT(var.tasks[0]), \
233 [1] = LIST_HEAD_INIT(var.tasks[1]), \
234 [2] = LIST_HEAD_INIT(var.tasks[2]), \
235 }, \
236 .name = qname, \
237 }
238#endif
239# define RPC_WAITQ(var,qname) struct rpc_wait_queue var = RPC_WAITQ_INIT(var,qname)
240
241#define RPC_IS_PRIORITY(q) ((q)->maxpriority > 0)
242
243/*
244 * Function prototypes
245 */
84115e1c 246struct rpc_task *rpc_new_task(const struct rpc_task_setup *);
44c28873
TM
247struct rpc_task *rpc_run_task(struct rpc_clnt *clnt, int flags,
248 const struct rpc_call_ops *ops, void *data);
84115e1c 249void rpc_init_task(struct rpc_task *task, const struct rpc_task_setup *);
e6b3c4db 250void rpc_put_task(struct rpc_task *);
abbcf28f 251void rpc_exit_task(struct rpc_task *);
bbd5a1f9 252void rpc_release_calldata(const struct rpc_call_ops *, void *);
1da177e4 253void rpc_killall_tasks(struct rpc_clnt *);
2efef837 254void rpc_execute(struct rpc_task *);
1da177e4
LT
255void rpc_init_priority_wait_queue(struct rpc_wait_queue *, const char *);
256void rpc_init_wait_queue(struct rpc_wait_queue *, const char *);
257void rpc_sleep_on(struct rpc_wait_queue *, struct rpc_task *,
258 rpc_action action, rpc_action timer);
259void rpc_wake_up_task(struct rpc_task *);
260void rpc_wake_up(struct rpc_wait_queue *);
261struct rpc_task *rpc_wake_up_next(struct rpc_wait_queue *);
262void rpc_wake_up_status(struct rpc_wait_queue *, int);
263void rpc_delay(struct rpc_task *, unsigned long);
264void * rpc_malloc(struct rpc_task *, size_t);
c5a4dd8b 265void rpc_free(void *);
1da177e4
LT
266int rpciod_up(void);
267void rpciod_down(void);
44c28873 268int __rpc_wait_for_completion_task(struct rpc_task *task, int (*)(void *));
1da177e4
LT
269#ifdef RPC_DEBUG
270void rpc_show_tasks(void);
271#endif
272int rpc_init_mempool(void);
273void rpc_destroy_mempool(void);
24c5d9d7 274extern struct workqueue_struct *rpciod_workqueue;
1da177e4
LT
275
276static inline void rpc_exit(struct rpc_task *task, int status)
277{
278 task->tk_status = status;
abbcf28f 279 task->tk_action = rpc_exit_task;
1da177e4
LT
280}
281
44c28873
TM
282static inline int rpc_wait_for_completion_task(struct rpc_task *task)
283{
284 return __rpc_wait_for_completion_task(task, NULL);
285}
286
1da177e4
LT
287#ifdef RPC_DEBUG
288static inline const char * rpc_qname(struct rpc_wait_queue *q)
289{
290 return ((q && q->name) ? q->name : "unknown");
291}
292#endif
293
294#endif /* _LINUX_SUNRPC_SCHED_H_ */