Merge branch 'x86-urgent-for-linus' of git://git.kernel.org/pub/scm/linux/kernel...
[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>
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
1da177e4
LT
82#ifdef RPC_DEBUG
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
LT
90#define tk_xprt tk_client->cl_xprt
91
92/* support walking a list of tasks on a wait queue */
93#define task_for_each(task, pos, head) \
94 list_for_each(pos, head) \
95 if ((task=list_entry(pos, struct rpc_task, u.tk_wait.list)),1)
96
97#define task_for_first(task, head) \
98 if (!list_empty(head) && \
99 ((task=list_entry((head)->next, struct rpc_task, u.tk_wait.list)),1))
100
1da177e4
LT
101typedef void (*rpc_action)(struct rpc_task *);
102
963d8fe5 103struct rpc_call_ops {
4ce70ada 104 void (*rpc_call_prepare)(struct rpc_task *, void *);
963d8fe5 105 void (*rpc_call_done)(struct rpc_task *, void *);
0a702195 106 void (*rpc_count_stats)(struct rpc_task *, void *);
963d8fe5
TM
107 void (*rpc_release)(void *);
108};
109
84115e1c 110struct rpc_task_setup {
e8f5d77c 111 struct rpc_task *task;
84115e1c
TM
112 struct rpc_clnt *rpc_client;
113 const struct rpc_message *rpc_message;
114 const struct rpc_call_ops *callback_ops;
115 void *callback_data;
32bfb5c0 116 struct workqueue_struct *workqueue;
84115e1c 117 unsigned short flags;
3ff7576d 118 signed char priority;
84115e1c 119};
963d8fe5 120
1da177e4
LT
121/*
122 * RPC task flags
123 */
124#define RPC_TASK_ASYNC 0x0001 /* is an async task */
125#define RPC_TASK_SWAPPER 0x0002 /* is swapping in/out */
1da177e4
LT
126#define RPC_CALL_MAJORSEEN 0x0020 /* major timeout seen */
127#define RPC_TASK_ROOTCREDS 0x0040 /* force root creds */
128#define RPC_TASK_DYNAMIC 0x0080 /* task was kmalloc'ed */
129#define RPC_TASK_KILLED 0x0100 /* task was killed */
130#define RPC_TASK_SOFT 0x0200 /* Use soft timeouts */
09a21c41 131#define RPC_TASK_SOFTCONN 0x0400 /* Fail if can't connect */
468f8613 132#define RPC_TASK_SENT 0x0800 /* message was sent */
7494d00c 133#define RPC_TASK_TIMEOUT 0x1000 /* fail with ETIMEDOUT on timeout */
1da177e4
LT
134
135#define RPC_IS_ASYNC(t) ((t)->tk_flags & RPC_TASK_ASYNC)
1da177e4
LT
136#define RPC_IS_SWAPPER(t) ((t)->tk_flags & RPC_TASK_SWAPPER)
137#define RPC_DO_ROOTOVERRIDE(t) ((t)->tk_flags & RPC_TASK_ROOTCREDS)
138#define RPC_ASSASSINATED(t) ((t)->tk_flags & RPC_TASK_KILLED)
7494d00c 139#define RPC_IS_SOFT(t) ((t)->tk_flags & (RPC_TASK_SOFT|RPC_TASK_TIMEOUT))
09a21c41 140#define RPC_IS_SOFTCONN(t) ((t)->tk_flags & RPC_TASK_SOFTCONN)
468f8613 141#define RPC_WAS_SENT(t) ((t)->tk_flags & RPC_TASK_SENT)
1da177e4
LT
142
143#define RPC_TASK_RUNNING 0
144#define RPC_TASK_QUEUED 1
f5fb7b06 145#define RPC_TASK_ACTIVE 2
1da177e4 146
7b8f850b
RB
147#define RPC_IS_RUNNING(t) test_bit(RPC_TASK_RUNNING, &(t)->tk_runstate)
148#define rpc_set_running(t) set_bit(RPC_TASK_RUNNING, &(t)->tk_runstate)
1da177e4 149#define rpc_test_and_set_running(t) \
7b8f850b 150 test_and_set_bit(RPC_TASK_RUNNING, &(t)->tk_runstate)
1da177e4
LT
151#define rpc_clear_running(t) \
152 do { \
153 smp_mb__before_clear_bit(); \
154 clear_bit(RPC_TASK_RUNNING, &(t)->tk_runstate); \
155 smp_mb__after_clear_bit(); \
156 } while (0)
157
7b8f850b
RB
158#define RPC_IS_QUEUED(t) test_bit(RPC_TASK_QUEUED, &(t)->tk_runstate)
159#define rpc_set_queued(t) set_bit(RPC_TASK_QUEUED, &(t)->tk_runstate)
1da177e4
LT
160#define rpc_clear_queued(t) \
161 do { \
162 smp_mb__before_clear_bit(); \
163 clear_bit(RPC_TASK_QUEUED, &(t)->tk_runstate); \
164 smp_mb__after_clear_bit(); \
165 } while (0)
1da177e4 166
7b8f850b 167#define RPC_IS_ACTIVATED(t) test_bit(RPC_TASK_ACTIVE, &(t)->tk_runstate)
44c28873 168
1da177e4
LT
169/*
170 * Task priorities.
171 * Note: if you change these, you must also change
172 * the task initialization definitions below.
173 */
3ff7576d
TM
174#define RPC_PRIORITY_LOW (-1)
175#define RPC_PRIORITY_NORMAL (0)
176#define RPC_PRIORITY_HIGH (1)
cf3b01b5
AB
177#define RPC_PRIORITY_PRIVILEGED (2)
178#define RPC_NR_PRIORITY (1 + RPC_PRIORITY_PRIVILEGED - RPC_PRIORITY_LOW)
1da177e4 179
36df9aae
TM
180struct rpc_timer {
181 struct timer_list timer;
182 struct list_head list;
183 unsigned long expires;
184};
185
1da177e4
LT
186/*
187 * RPC synchronization objects
188 */
189struct rpc_wait_queue {
190 spinlock_t lock;
191 struct list_head tasks[RPC_NR_PRIORITY]; /* task queue for each priority level */
3ff7576d 192 pid_t owner; /* process id of last task serviced */
1da177e4
LT
193 unsigned char maxpriority; /* maximum priority (0 if queue is not a priority queue) */
194 unsigned char priority; /* current priority */
195 unsigned char count; /* # task groups remaining serviced so far */
196 unsigned char nr; /* # tasks remaining for cookie */
e19b63da 197 unsigned short qlen; /* total # tasks waiting in queue */
36df9aae 198 struct rpc_timer timer_list;
2f09c242 199#if defined(RPC_DEBUG) || defined(RPC_TRACEPOINTS)
1da177e4
LT
200 const char * name;
201#endif
202};
203
204/*
205 * This is the # requests to send consecutively
206 * from a single cookie. The aim is to improve
207 * performance of NFS operations such as read/write.
208 */
209#define RPC_BATCH_COUNT 16
1da177e4
LT
210#define RPC_IS_PRIORITY(q) ((q)->maxpriority > 0)
211
212/*
213 * Function prototypes
214 */
84115e1c 215struct rpc_task *rpc_new_task(const struct rpc_task_setup *);
c970aa85 216struct rpc_task *rpc_run_task(const struct rpc_task_setup *);
55ae1aab
RL
217struct rpc_task *rpc_run_bc_task(struct rpc_rqst *req,
218 const struct rpc_call_ops *ops);
e6b3c4db 219void rpc_put_task(struct rpc_task *);
bf294b41 220void rpc_put_task_async(struct rpc_task *);
abbcf28f 221void rpc_exit_task(struct rpc_task *);
d9b6cd94 222void rpc_exit(struct rpc_task *, int);
bbd5a1f9 223void rpc_release_calldata(const struct rpc_call_ops *, void *);
1da177e4 224void rpc_killall_tasks(struct rpc_clnt *);
2efef837 225void rpc_execute(struct rpc_task *);
1da177e4
LT
226void rpc_init_priority_wait_queue(struct rpc_wait_queue *, const char *);
227void rpc_init_wait_queue(struct rpc_wait_queue *, const char *);
f6a1cc89 228void rpc_destroy_wait_queue(struct rpc_wait_queue *);
1da177e4 229void rpc_sleep_on(struct rpc_wait_queue *, struct rpc_task *,
5d00837b 230 rpc_action action);
3b27bad7
TM
231void rpc_sleep_on_priority(struct rpc_wait_queue *,
232 struct rpc_task *,
233 rpc_action action,
234 int priority);
96ef13b2
TM
235void rpc_wake_up_queued_task(struct rpc_wait_queue *,
236 struct rpc_task *);
1da177e4
LT
237void rpc_wake_up(struct rpc_wait_queue *);
238struct rpc_task *rpc_wake_up_next(struct rpc_wait_queue *);
961a828d
TM
239struct rpc_task *rpc_wake_up_first(struct rpc_wait_queue *,
240 bool (*)(struct rpc_task *, void *),
241 void *);
1da177e4 242void rpc_wake_up_status(struct rpc_wait_queue *, int);
48f18612 243int rpc_queue_empty(struct rpc_wait_queue *);
1da177e4
LT
244void rpc_delay(struct rpc_task *, unsigned long);
245void * rpc_malloc(struct rpc_task *, size_t);
c5a4dd8b 246void rpc_free(void *);
1da177e4
LT
247int rpciod_up(void);
248void rpciod_down(void);
44c28873 249int __rpc_wait_for_completion_task(struct rpc_task *task, int (*)(void *));
1da177e4 250#ifdef RPC_DEBUG
70abc49b
SK
251struct net;
252void rpc_show_tasks(struct net *);
1da177e4
LT
253#endif
254int rpc_init_mempool(void);
255void rpc_destroy_mempool(void);
24c5d9d7 256extern struct workqueue_struct *rpciod_workqueue;
aae2006e 257void rpc_prepare_task(struct rpc_task *task);
1da177e4 258
44c28873
TM
259static inline int rpc_wait_for_completion_task(struct rpc_task *task)
260{
261 return __rpc_wait_for_completion_task(task, NULL);
262}
263
cf3b01b5
AB
264static inline void rpc_task_set_priority(struct rpc_task *task, unsigned char prio)
265{
266 task->tk_priority = prio - RPC_PRIORITY_LOW;
267}
268
269static inline int rpc_task_has_priority(struct rpc_task *task, unsigned char prio)
270{
271 return (task->tk_priority + RPC_PRIORITY_LOW == prio);
272}
273
2f09c242 274#if defined(RPC_DEBUG) || defined (RPC_TRACEPOINTS)
82b0a4c3 275static inline const char * rpc_qname(const struct rpc_wait_queue *q)
1da177e4
LT
276{
277 return ((q && q->name) ? q->name : "unknown");
278}
2f09c242
TM
279
280static inline void rpc_assign_waitqueue_name(struct rpc_wait_queue *q,
281 const char *name)
282{
283 q->name = name;
284}
285#else
286static inline void rpc_assign_waitqueue_name(struct rpc_wait_queue *q,
287 const char *name)
288{
289}
1da177e4
LT
290#endif
291
292#endif /* _LINUX_SUNRPC_SCHED_H_ */