]> bbs.cooldavid.org Git - net-next-2.6.git/blame - include/linux/sunrpc/sched.h
SUNRPC: Move the task->tk_bytes_sent and tk_rtt to struct rpc_rqst
[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 {
44#ifdef RPC_DEBUG
45 unsigned long tk_magic; /* 0xf00baa */
46#endif
44c28873 47 atomic_t tk_count; /* Reference count */
1da177e4
LT
48 struct list_head tk_task; /* global list of tasks */
49 struct rpc_clnt * tk_client; /* RPC client */
50 struct rpc_rqst * tk_rqstp; /* RPC request */
51 int tk_status; /* result of last operation */
52
53 /*
54 * RPC call state
55 */
56 struct rpc_message tk_msg; /* RPC call info */
1da177e4
LT
57 __u8 tk_garb_retry;
58 __u8 tk_cred_retry;
59
1da177e4 60 /*
1da177e4
LT
61 * callback to be executed after waking up
62 * action next procedure for async tasks
963d8fe5 63 * tk_ops caller callbacks
1da177e4 64 */
1da177e4
LT
65 void (*tk_callback)(struct rpc_task *);
66 void (*tk_action)(struct rpc_task *);
963d8fe5 67 const struct rpc_call_ops *tk_ops;
1da177e4
LT
68 void * tk_calldata;
69
1da177e4
LT
70 unsigned long tk_timeout; /* timeout for rpc_sleep() */
71 unsigned short tk_flags; /* misc flags */
1da177e4
LT
72 unsigned long tk_runstate; /* Task run status */
73 struct workqueue_struct *tk_workqueue; /* Normally rpciod, but could
74 * be any workqueue
75 */
96ef13b2 76 struct rpc_wait_queue *tk_waitqueue; /* RPC wait queue we're on */
1da177e4
LT
77 union {
78 struct work_struct tk_work; /* Async task work queue */
79 struct rpc_wait tk_wait; /* RPC wait */
80 } u;
ef759a2e
CL
81
82 unsigned short tk_timeouts; /* maj timeouts */
d60dbb20 83 ktime_t tk_start; /* RPC task init timestamp */
ef759a2e 84
3ff7576d
TM
85 pid_t tk_owner; /* Process id for batching tasks */
86 unsigned char tk_priority : 2;/* Task priority */
87
1da177e4
LT
88#ifdef RPC_DEBUG
89 unsigned short tk_pid; /* debugging aid */
90#endif
91};
1da177e4
LT
92#define tk_xprt tk_client->cl_xprt
93
94/* support walking a list of tasks on a wait queue */
95#define task_for_each(task, pos, head) \
96 list_for_each(pos, head) \
97 if ((task=list_entry(pos, struct rpc_task, u.tk_wait.list)),1)
98
99#define task_for_first(task, head) \
100 if (!list_empty(head) && \
101 ((task=list_entry((head)->next, struct rpc_task, u.tk_wait.list)),1))
102
1da177e4
LT
103typedef void (*rpc_action)(struct rpc_task *);
104
963d8fe5 105struct rpc_call_ops {
4ce70ada 106 void (*rpc_call_prepare)(struct rpc_task *, void *);
963d8fe5
TM
107 void (*rpc_call_done)(struct rpc_task *, void *);
108 void (*rpc_release)(void *);
109};
110
84115e1c 111struct rpc_task_setup {
e8f5d77c 112 struct rpc_task *task;
84115e1c
TM
113 struct rpc_clnt *rpc_client;
114 const struct rpc_message *rpc_message;
115 const struct rpc_call_ops *callback_ops;
116 void *callback_data;
32bfb5c0 117 struct workqueue_struct *workqueue;
84115e1c 118 unsigned short flags;
3ff7576d 119 signed char priority;
84115e1c 120};
963d8fe5 121
1da177e4
LT
122/*
123 * RPC task flags
124 */
125#define RPC_TASK_ASYNC 0x0001 /* is an async task */
126#define RPC_TASK_SWAPPER 0x0002 /* is swapping in/out */
1da177e4
LT
127#define RPC_CALL_MAJORSEEN 0x0020 /* major timeout seen */
128#define RPC_TASK_ROOTCREDS 0x0040 /* force root creds */
129#define RPC_TASK_DYNAMIC 0x0080 /* task was kmalloc'ed */
130#define RPC_TASK_KILLED 0x0100 /* task was killed */
131#define RPC_TASK_SOFT 0x0200 /* Use soft timeouts */
09a21c41 132#define RPC_TASK_SOFTCONN 0x0400 /* Fail if can't connect */
1da177e4
LT
133
134#define RPC_IS_ASYNC(t) ((t)->tk_flags & RPC_TASK_ASYNC)
1da177e4
LT
135#define RPC_IS_SWAPPER(t) ((t)->tk_flags & RPC_TASK_SWAPPER)
136#define RPC_DO_ROOTOVERRIDE(t) ((t)->tk_flags & RPC_TASK_ROOTCREDS)
137#define RPC_ASSASSINATED(t) ((t)->tk_flags & RPC_TASK_KILLED)
1da177e4 138#define RPC_IS_SOFT(t) ((t)->tk_flags & RPC_TASK_SOFT)
09a21c41 139#define RPC_IS_SOFTCONN(t) ((t)->tk_flags & RPC_TASK_SOFTCONN)
1da177e4
LT
140
141#define RPC_TASK_RUNNING 0
142#define RPC_TASK_QUEUED 1
f5fb7b06 143#define RPC_TASK_ACTIVE 2
1da177e4 144
7b8f850b
RB
145#define RPC_IS_RUNNING(t) test_bit(RPC_TASK_RUNNING, &(t)->tk_runstate)
146#define rpc_set_running(t) set_bit(RPC_TASK_RUNNING, &(t)->tk_runstate)
1da177e4 147#define rpc_test_and_set_running(t) \
7b8f850b 148 test_and_set_bit(RPC_TASK_RUNNING, &(t)->tk_runstate)
1da177e4
LT
149#define rpc_clear_running(t) \
150 do { \
151 smp_mb__before_clear_bit(); \
152 clear_bit(RPC_TASK_RUNNING, &(t)->tk_runstate); \
153 smp_mb__after_clear_bit(); \
154 } while (0)
155
7b8f850b
RB
156#define RPC_IS_QUEUED(t) test_bit(RPC_TASK_QUEUED, &(t)->tk_runstate)
157#define rpc_set_queued(t) set_bit(RPC_TASK_QUEUED, &(t)->tk_runstate)
1da177e4
LT
158#define rpc_clear_queued(t) \
159 do { \
160 smp_mb__before_clear_bit(); \
161 clear_bit(RPC_TASK_QUEUED, &(t)->tk_runstate); \
162 smp_mb__after_clear_bit(); \
163 } while (0)
1da177e4 164
7b8f850b 165#define RPC_IS_ACTIVATED(t) test_bit(RPC_TASK_ACTIVE, &(t)->tk_runstate)
44c28873 166
1da177e4
LT
167/*
168 * Task priorities.
169 * Note: if you change these, you must also change
170 * the task initialization definitions below.
171 */
3ff7576d
TM
172#define RPC_PRIORITY_LOW (-1)
173#define RPC_PRIORITY_NORMAL (0)
174#define RPC_PRIORITY_HIGH (1)
cf3b01b5
AB
175#define RPC_PRIORITY_PRIVILEGED (2)
176#define RPC_NR_PRIORITY (1 + RPC_PRIORITY_PRIVILEGED - RPC_PRIORITY_LOW)
1da177e4 177
36df9aae
TM
178struct rpc_timer {
179 struct timer_list timer;
180 struct list_head list;
181 unsigned long expires;
182};
183
1da177e4
LT
184/*
185 * RPC synchronization objects
186 */
187struct rpc_wait_queue {
188 spinlock_t lock;
189 struct list_head tasks[RPC_NR_PRIORITY]; /* task queue for each priority level */
3ff7576d 190 pid_t owner; /* process id of last task serviced */
1da177e4
LT
191 unsigned char maxpriority; /* maximum priority (0 if queue is not a priority queue) */
192 unsigned char priority; /* current priority */
193 unsigned char count; /* # task groups remaining serviced so far */
194 unsigned char nr; /* # tasks remaining for cookie */
e19b63da 195 unsigned short qlen; /* total # tasks waiting in queue */
36df9aae 196 struct rpc_timer timer_list;
1da177e4
LT
197#ifdef RPC_DEBUG
198 const char * name;
199#endif
200};
201
202/*
203 * This is the # requests to send consecutively
204 * from a single cookie. The aim is to improve
205 * performance of NFS operations such as read/write.
206 */
207#define RPC_BATCH_COUNT 16
1da177e4
LT
208#define RPC_IS_PRIORITY(q) ((q)->maxpriority > 0)
209
210/*
211 * Function prototypes
212 */
84115e1c 213struct rpc_task *rpc_new_task(const struct rpc_task_setup *);
c970aa85 214struct rpc_task *rpc_run_task(const struct rpc_task_setup *);
55ae1aab
RL
215struct rpc_task *rpc_run_bc_task(struct rpc_rqst *req,
216 const struct rpc_call_ops *ops);
e6b3c4db 217void rpc_put_task(struct rpc_task *);
abbcf28f 218void rpc_exit_task(struct rpc_task *);
bbd5a1f9 219void rpc_release_calldata(const struct rpc_call_ops *, void *);
1da177e4 220void rpc_killall_tasks(struct rpc_clnt *);
2efef837 221void rpc_execute(struct rpc_task *);
1da177e4
LT
222void rpc_init_priority_wait_queue(struct rpc_wait_queue *, const char *);
223void rpc_init_wait_queue(struct rpc_wait_queue *, const char *);
f6a1cc89 224void rpc_destroy_wait_queue(struct rpc_wait_queue *);
1da177e4 225void rpc_sleep_on(struct rpc_wait_queue *, struct rpc_task *,
5d00837b 226 rpc_action action);
96ef13b2
TM
227void rpc_wake_up_queued_task(struct rpc_wait_queue *,
228 struct rpc_task *);
1da177e4
LT
229void rpc_wake_up(struct rpc_wait_queue *);
230struct rpc_task *rpc_wake_up_next(struct rpc_wait_queue *);
231void rpc_wake_up_status(struct rpc_wait_queue *, int);
48f18612 232int rpc_queue_empty(struct rpc_wait_queue *);
1da177e4
LT
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);
44c28873 238int __rpc_wait_for_completion_task(struct rpc_task *task, int (*)(void *));
1da177e4
LT
239#ifdef RPC_DEBUG
240void rpc_show_tasks(void);
241#endif
242int rpc_init_mempool(void);
243void rpc_destroy_mempool(void);
24c5d9d7 244extern struct workqueue_struct *rpciod_workqueue;
aae2006e 245void rpc_prepare_task(struct rpc_task *task);
1da177e4
LT
246
247static inline void rpc_exit(struct rpc_task *task, int status)
248{
249 task->tk_status = status;
abbcf28f 250 task->tk_action = rpc_exit_task;
1da177e4
LT
251}
252
44c28873
TM
253static inline int rpc_wait_for_completion_task(struct rpc_task *task)
254{
255 return __rpc_wait_for_completion_task(task, NULL);
256}
257
cf3b01b5
AB
258static inline void rpc_task_set_priority(struct rpc_task *task, unsigned char prio)
259{
260 task->tk_priority = prio - RPC_PRIORITY_LOW;
261}
262
263static inline int rpc_task_has_priority(struct rpc_task *task, unsigned char prio)
264{
265 return (task->tk_priority + RPC_PRIORITY_LOW == prio);
266}
267
1da177e4
LT
268#ifdef RPC_DEBUG
269static inline const char * rpc_qname(struct rpc_wait_queue *q)
270{
271 return ((q && q->name) ? q->name : "unknown");
272}
273#endif
274
275#endif /* _LINUX_SUNRPC_SCHED_H_ */