]> bbs.cooldavid.org Git - net-next-2.6.git/blame - include/linux/sunrpc/sched.h
SUNRPC: Remove the 'tk_magic' debugging field
[net-next-2.6.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 */
48 int tk_status; /* result of last operation */
49
50 /*
51 * RPC call state
52 */
53 struct rpc_message tk_msg; /* RPC call info */
1da177e4
LT
54 __u8 tk_garb_retry;
55 __u8 tk_cred_retry;
56
1da177e4 57 /*
1da177e4
LT
58 * callback to be executed after waking up
59 * action next procedure for async tasks
963d8fe5 60 * tk_ops caller callbacks
1da177e4 61 */
1da177e4
LT
62 void (*tk_callback)(struct rpc_task *);
63 void (*tk_action)(struct rpc_task *);
963d8fe5 64 const struct rpc_call_ops *tk_ops;
1da177e4
LT
65 void * tk_calldata;
66
1da177e4
LT
67 unsigned long tk_timeout; /* timeout for rpc_sleep() */
68 unsigned short tk_flags; /* misc flags */
1da177e4
LT
69 unsigned long tk_runstate; /* Task run status */
70 struct workqueue_struct *tk_workqueue; /* Normally rpciod, but could
71 * be any workqueue
72 */
96ef13b2 73 struct rpc_wait_queue *tk_waitqueue; /* RPC wait queue we're on */
1da177e4
LT
74 union {
75 struct work_struct tk_work; /* Async task work queue */
76 struct rpc_wait tk_wait; /* RPC wait */
77 } u;
ef759a2e
CL
78
79 unsigned short tk_timeouts; /* maj timeouts */
d60dbb20 80 ktime_t tk_start; /* RPC task init timestamp */
ef759a2e 81
3ff7576d
TM
82 pid_t tk_owner; /* Process id for batching tasks */
83 unsigned char tk_priority : 2;/* Task priority */
84
1da177e4
LT
85#ifdef RPC_DEBUG
86 unsigned short tk_pid; /* debugging aid */
87#endif
88};
1da177e4
LT
89#define tk_xprt tk_client->cl_xprt
90
91/* support walking a list of tasks on a wait queue */
92#define task_for_each(task, pos, head) \
93 list_for_each(pos, head) \
94 if ((task=list_entry(pos, struct rpc_task, u.tk_wait.list)),1)
95
96#define task_for_first(task, head) \
97 if (!list_empty(head) && \
98 ((task=list_entry((head)->next, struct rpc_task, u.tk_wait.list)),1))
99
1da177e4
LT
100typedef void (*rpc_action)(struct rpc_task *);
101
963d8fe5 102struct rpc_call_ops {
4ce70ada 103 void (*rpc_call_prepare)(struct rpc_task *, void *);
963d8fe5
TM
104 void (*rpc_call_done)(struct rpc_task *, void *);
105 void (*rpc_release)(void *);
106};
107
84115e1c 108struct rpc_task_setup {
e8f5d77c 109 struct rpc_task *task;
84115e1c
TM
110 struct rpc_clnt *rpc_client;
111 const struct rpc_message *rpc_message;
112 const struct rpc_call_ops *callback_ops;
113 void *callback_data;
32bfb5c0 114 struct workqueue_struct *workqueue;
84115e1c 115 unsigned short flags;
3ff7576d 116 signed char priority;
84115e1c 117};
963d8fe5 118
1da177e4
LT
119/*
120 * RPC task flags
121 */
122#define RPC_TASK_ASYNC 0x0001 /* is an async task */
123#define RPC_TASK_SWAPPER 0x0002 /* is swapping in/out */
1da177e4
LT
124#define RPC_CALL_MAJORSEEN 0x0020 /* major timeout seen */
125#define RPC_TASK_ROOTCREDS 0x0040 /* force root creds */
126#define RPC_TASK_DYNAMIC 0x0080 /* task was kmalloc'ed */
127#define RPC_TASK_KILLED 0x0100 /* task was killed */
128#define RPC_TASK_SOFT 0x0200 /* Use soft timeouts */
09a21c41 129#define RPC_TASK_SOFTCONN 0x0400 /* Fail if can't connect */
1da177e4
LT
130
131#define RPC_IS_ASYNC(t) ((t)->tk_flags & RPC_TASK_ASYNC)
1da177e4
LT
132#define RPC_IS_SWAPPER(t) ((t)->tk_flags & RPC_TASK_SWAPPER)
133#define RPC_DO_ROOTOVERRIDE(t) ((t)->tk_flags & RPC_TASK_ROOTCREDS)
134#define RPC_ASSASSINATED(t) ((t)->tk_flags & RPC_TASK_KILLED)
1da177e4 135#define RPC_IS_SOFT(t) ((t)->tk_flags & RPC_TASK_SOFT)
09a21c41 136#define RPC_IS_SOFTCONN(t) ((t)->tk_flags & RPC_TASK_SOFTCONN)
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 { \
148 smp_mb__before_clear_bit(); \
149 clear_bit(RPC_TASK_RUNNING, &(t)->tk_runstate); \
150 smp_mb__after_clear_bit(); \
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 { \
157 smp_mb__before_clear_bit(); \
158 clear_bit(RPC_TASK_QUEUED, &(t)->tk_runstate); \
159 smp_mb__after_clear_bit(); \
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 */
190 unsigned char count; /* # task groups remaining serviced so far */
191 unsigned char nr; /* # tasks remaining for cookie */
e19b63da 192 unsigned short qlen; /* total # tasks waiting in queue */
36df9aae 193 struct rpc_timer timer_list;
1da177e4
LT
194#ifdef RPC_DEBUG
195 const char * name;
196#endif
197};
198
199/*
200 * This is the # requests to send consecutively
201 * from a single cookie. The aim is to improve
202 * performance of NFS operations such as read/write.
203 */
204#define RPC_BATCH_COUNT 16
1da177e4
LT
205#define RPC_IS_PRIORITY(q) ((q)->maxpriority > 0)
206
207/*
208 * Function prototypes
209 */
84115e1c 210struct rpc_task *rpc_new_task(const struct rpc_task_setup *);
c970aa85 211struct rpc_task *rpc_run_task(const struct rpc_task_setup *);
55ae1aab
RL
212struct rpc_task *rpc_run_bc_task(struct rpc_rqst *req,
213 const struct rpc_call_ops *ops);
e6b3c4db 214void rpc_put_task(struct rpc_task *);
abbcf28f 215void rpc_exit_task(struct rpc_task *);
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);
96ef13b2
TM
224void rpc_wake_up_queued_task(struct rpc_wait_queue *,
225 struct rpc_task *);
1da177e4
LT
226void rpc_wake_up(struct rpc_wait_queue *);
227struct rpc_task *rpc_wake_up_next(struct rpc_wait_queue *);
228void rpc_wake_up_status(struct rpc_wait_queue *, int);
48f18612 229int rpc_queue_empty(struct rpc_wait_queue *);
1da177e4
LT
230void rpc_delay(struct rpc_task *, unsigned long);
231void * rpc_malloc(struct rpc_task *, size_t);
c5a4dd8b 232void rpc_free(void *);
1da177e4
LT
233int rpciod_up(void);
234void rpciod_down(void);
44c28873 235int __rpc_wait_for_completion_task(struct rpc_task *task, int (*)(void *));
1da177e4
LT
236#ifdef RPC_DEBUG
237void rpc_show_tasks(void);
238#endif
239int rpc_init_mempool(void);
240void rpc_destroy_mempool(void);
24c5d9d7 241extern struct workqueue_struct *rpciod_workqueue;
aae2006e 242void rpc_prepare_task(struct rpc_task *task);
1da177e4
LT
243
244static inline void rpc_exit(struct rpc_task *task, int status)
245{
246 task->tk_status = status;
abbcf28f 247 task->tk_action = rpc_exit_task;
1da177e4
LT
248}
249
44c28873
TM
250static inline int rpc_wait_for_completion_task(struct rpc_task *task)
251{
252 return __rpc_wait_for_completion_task(task, NULL);
253}
254
cf3b01b5
AB
255static inline void rpc_task_set_priority(struct rpc_task *task, unsigned char prio)
256{
257 task->tk_priority = prio - RPC_PRIORITY_LOW;
258}
259
260static inline int rpc_task_has_priority(struct rpc_task *task, unsigned char prio)
261{
262 return (task->tk_priority + RPC_PRIORITY_LOW == prio);
263}
264
1da177e4
LT
265#ifdef RPC_DEBUG
266static inline const char * rpc_qname(struct rpc_wait_queue *q)
267{
268 return ((q && q->name) ? q->name : "unknown");
269}
270#endif
271
272#endif /* _LINUX_SUNRPC_SCHED_H_ */