blob: 7751d3a0549705eed214a7e272a74c30cdd439fd [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
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>
Trond Myklebust8aca67f2006-11-13 16:23:44 -050014#include <linux/rcupdate.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070015#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
Trond Myklebust963d8fe2006-01-03 09:55:04 +010031struct rpc_call_ops;
Linus Torvalds1da177e2005-04-16 15:20:36 -070032struct rpc_wait_queue;
33struct rpc_wait {
34 struct list_head list; /* wait queue links */
35 struct list_head links; /* Links to related tasks */
Trond Myklebust36df9aa2007-07-18 16:18:52 -040036 struct list_head timer_list; /* Timer list */
37 unsigned long expires;
Linus Torvalds1da177e2005-04-16 15:20:36 -070038};
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
Trond Myklebust44c28872006-01-03 09:55:06 +010047 atomic_t tk_count; /* Reference count */
Linus Torvalds1da177e2005-04-16 15:20:36 -070048 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 */
Linus Torvalds1da177e2005-04-16 15:20:36 -070057 __u8 tk_garb_retry;
58 __u8 tk_cred_retry;
59
Linus Torvalds1da177e2005-04-16 15:20:36 -070060 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -070061 * callback to be executed after waking up
62 * action next procedure for async tasks
Trond Myklebust963d8fe2006-01-03 09:55:04 +010063 * tk_ops caller callbacks
Linus Torvalds1da177e2005-04-16 15:20:36 -070064 */
Linus Torvalds1da177e2005-04-16 15:20:36 -070065 void (*tk_callback)(struct rpc_task *);
66 void (*tk_action)(struct rpc_task *);
Trond Myklebust963d8fe2006-01-03 09:55:04 +010067 const struct rpc_call_ops *tk_ops;
Linus Torvalds1da177e2005-04-16 15:20:36 -070068 void * tk_calldata;
69
70 /*
71 * tk_timer is used for async processing by the RPC scheduling
72 * primitives. You should not access this directly unless
73 * you have a pathological interest in kernel oopses.
74 */
75 struct timer_list tk_timer; /* kernel timer */
76 unsigned long tk_timeout; /* timeout for rpc_sleep() */
77 unsigned short tk_flags; /* misc flags */
Linus Torvalds1da177e2005-04-16 15:20:36 -070078 unsigned long tk_runstate; /* Task run status */
79 struct workqueue_struct *tk_workqueue; /* Normally rpciod, but could
80 * be any workqueue
81 */
Trond Myklebust96ef13b2008-02-22 15:46:41 -050082 struct rpc_wait_queue *tk_waitqueue; /* RPC wait queue we're on */
Linus Torvalds1da177e2005-04-16 15:20:36 -070083 union {
84 struct work_struct tk_work; /* Async task work queue */
85 struct rpc_wait tk_wait; /* RPC wait */
Trond Myklebust8aca67f2006-11-13 16:23:44 -050086 struct rcu_head tk_rcu; /* for task deletion */
Linus Torvalds1da177e2005-04-16 15:20:36 -070087 } u;
Chuck Leveref759a22006-03-20 13:44:17 -050088
89 unsigned short tk_timeouts; /* maj timeouts */
90 size_t tk_bytes_sent; /* total bytes sent */
91 unsigned long tk_start; /* RPC task init timestamp */
92 long tk_rtt; /* round-trip time (jiffies) */
93
Trond Myklebust3ff75762007-07-14 15:40:00 -040094 pid_t tk_owner; /* Process id for batching tasks */
95 unsigned char tk_priority : 2;/* Task priority */
96
Linus Torvalds1da177e2005-04-16 15:20:36 -070097#ifdef RPC_DEBUG
98 unsigned short tk_pid; /* debugging aid */
99#endif
100};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700101#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
Linus Torvalds1da177e2005-04-16 15:20:36 -0700112typedef void (*rpc_action)(struct rpc_task *);
113
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100114struct rpc_call_ops {
Trond Myklebust4ce70ad2006-01-03 09:55:05 +0100115 void (*rpc_call_prepare)(struct rpc_task *, void *);
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100116 void (*rpc_call_done)(struct rpc_task *, void *);
117 void (*rpc_release)(void *);
118};
119
Trond Myklebust84115e12007-07-14 15:39:59 -0400120struct rpc_task_setup {
Trond Myklebuste8f5d772007-10-25 18:42:53 -0400121 struct rpc_task *task;
Trond Myklebust84115e12007-07-14 15:39:59 -0400122 struct rpc_clnt *rpc_client;
123 const struct rpc_message *rpc_message;
124 const struct rpc_call_ops *callback_ops;
125 void *callback_data;
Trond Myklebust32bfb5c2008-02-19 20:04:21 -0500126 struct workqueue_struct *workqueue;
Trond Myklebust84115e12007-07-14 15:39:59 -0400127 unsigned short flags;
Trond Myklebust3ff75762007-07-14 15:40:00 -0400128 signed char priority;
Trond Myklebust84115e12007-07-14 15:39:59 -0400129};
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100130
Linus Torvalds1da177e2005-04-16 15:20:36 -0700131/*
132 * RPC task flags
133 */
134#define RPC_TASK_ASYNC 0x0001 /* is an async task */
135#define RPC_TASK_SWAPPER 0x0002 /* is swapping in/out */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700136#define RPC_CALL_MAJORSEEN 0x0020 /* major timeout seen */
137#define RPC_TASK_ROOTCREDS 0x0040 /* force root creds */
138#define RPC_TASK_DYNAMIC 0x0080 /* task was kmalloc'ed */
139#define RPC_TASK_KILLED 0x0100 /* task was killed */
140#define RPC_TASK_SOFT 0x0200 /* Use soft timeouts */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700141
142#define RPC_IS_ASYNC(t) ((t)->tk_flags & RPC_TASK_ASYNC)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700143#define RPC_IS_SWAPPER(t) ((t)->tk_flags & RPC_TASK_SWAPPER)
144#define RPC_DO_ROOTOVERRIDE(t) ((t)->tk_flags & RPC_TASK_ROOTCREDS)
145#define RPC_ASSASSINATED(t) ((t)->tk_flags & RPC_TASK_KILLED)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700146#define RPC_DO_CALLBACK(t) ((t)->tk_callback != NULL)
147#define RPC_IS_SOFT(t) ((t)->tk_flags & RPC_TASK_SOFT)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700148
149#define RPC_TASK_RUNNING 0
150#define RPC_TASK_QUEUED 1
151#define RPC_TASK_WAKEUP 2
152#define RPC_TASK_HAS_TIMER 3
Trond Myklebust44c28872006-01-03 09:55:06 +0100153#define RPC_TASK_ACTIVE 4
Linus Torvalds1da177e2005-04-16 15:20:36 -0700154
Ralf Baechle7b8f8502007-02-20 13:57:45 -0800155#define RPC_IS_RUNNING(t) test_bit(RPC_TASK_RUNNING, &(t)->tk_runstate)
156#define rpc_set_running(t) set_bit(RPC_TASK_RUNNING, &(t)->tk_runstate)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700157#define rpc_test_and_set_running(t) \
Ralf Baechle7b8f8502007-02-20 13:57:45 -0800158 test_and_set_bit(RPC_TASK_RUNNING, &(t)->tk_runstate)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700159#define rpc_clear_running(t) \
160 do { \
161 smp_mb__before_clear_bit(); \
162 clear_bit(RPC_TASK_RUNNING, &(t)->tk_runstate); \
163 smp_mb__after_clear_bit(); \
164 } while (0)
165
Ralf Baechle7b8f8502007-02-20 13:57:45 -0800166#define RPC_IS_QUEUED(t) test_bit(RPC_TASK_QUEUED, &(t)->tk_runstate)
167#define rpc_set_queued(t) set_bit(RPC_TASK_QUEUED, &(t)->tk_runstate)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700168#define rpc_clear_queued(t) \
169 do { \
170 smp_mb__before_clear_bit(); \
171 clear_bit(RPC_TASK_QUEUED, &(t)->tk_runstate); \
172 smp_mb__after_clear_bit(); \
173 } while (0)
174
175#define rpc_start_wakeup(t) \
176 (test_and_set_bit(RPC_TASK_WAKEUP, &(t)->tk_runstate) == 0)
177#define rpc_finish_wakeup(t) \
178 do { \
179 smp_mb__before_clear_bit(); \
180 clear_bit(RPC_TASK_WAKEUP, &(t)->tk_runstate); \
181 smp_mb__after_clear_bit(); \
182 } while (0)
183
Ralf Baechle7b8f8502007-02-20 13:57:45 -0800184#define RPC_IS_ACTIVATED(t) test_bit(RPC_TASK_ACTIVE, &(t)->tk_runstate)
Trond Myklebust44c28872006-01-03 09:55:06 +0100185
Linus Torvalds1da177e2005-04-16 15:20:36 -0700186/*
187 * Task priorities.
188 * Note: if you change these, you must also change
189 * the task initialization definitions below.
190 */
Trond Myklebust3ff75762007-07-14 15:40:00 -0400191#define RPC_PRIORITY_LOW (-1)
192#define RPC_PRIORITY_NORMAL (0)
193#define RPC_PRIORITY_HIGH (1)
194#define RPC_NR_PRIORITY (1 + RPC_PRIORITY_HIGH - RPC_PRIORITY_LOW)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700195
Trond Myklebust36df9aa2007-07-18 16:18:52 -0400196struct rpc_timer {
197 struct timer_list timer;
198 struct list_head list;
199 unsigned long expires;
200};
201
Linus Torvalds1da177e2005-04-16 15:20:36 -0700202/*
203 * RPC synchronization objects
204 */
205struct rpc_wait_queue {
206 spinlock_t lock;
207 struct list_head tasks[RPC_NR_PRIORITY]; /* task queue for each priority level */
Trond Myklebust3ff75762007-07-14 15:40:00 -0400208 pid_t owner; /* process id of last task serviced */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700209 unsigned char maxpriority; /* maximum priority (0 if queue is not a priority queue) */
210 unsigned char priority; /* current priority */
211 unsigned char count; /* # task groups remaining serviced so far */
212 unsigned char nr; /* # tasks remaining for cookie */
Chuck Levere19b63d2006-03-20 13:44:15 -0500213 unsigned short qlen; /* total # tasks waiting in queue */
Trond Myklebust36df9aa2007-07-18 16:18:52 -0400214 struct rpc_timer timer_list;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700215#ifdef RPC_DEBUG
216 const char * name;
217#endif
218};
219
220/*
221 * This is the # requests to send consecutively
222 * from a single cookie. The aim is to improve
223 * performance of NFS operations such as read/write.
224 */
225#define RPC_BATCH_COUNT 16
Linus Torvalds1da177e2005-04-16 15:20:36 -0700226#define RPC_IS_PRIORITY(q) ((q)->maxpriority > 0)
227
228/*
229 * Function prototypes
230 */
Trond Myklebust84115e12007-07-14 15:39:59 -0400231struct rpc_task *rpc_new_task(const struct rpc_task_setup *);
Trond Myklebustc970aa82007-07-14 15:39:59 -0400232struct rpc_task *rpc_run_task(const struct rpc_task_setup *);
Trond Myklebuste6b3c4d2006-11-11 22:18:03 -0500233void rpc_put_task(struct rpc_task *);
Trond Myklebustabbcf282006-01-03 09:55:03 +0100234void rpc_exit_task(struct rpc_task *);
Trond Myklebustbbd5a1f2006-10-18 16:01:05 -0400235void rpc_release_calldata(const struct rpc_call_ops *, void *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700236void rpc_killall_tasks(struct rpc_clnt *);
Trond Myklebust2efef832007-02-03 13:38:41 -0800237void rpc_execute(struct rpc_task *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700238void rpc_init_priority_wait_queue(struct rpc_wait_queue *, const char *);
239void rpc_init_wait_queue(struct rpc_wait_queue *, const char *);
Trond Myklebustf6a1cc82008-02-22 17:06:55 -0500240void rpc_destroy_wait_queue(struct rpc_wait_queue *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700241void rpc_sleep_on(struct rpc_wait_queue *, struct rpc_task *,
Trond Myklebust5d008372008-02-22 16:34:17 -0500242 rpc_action action);
Trond Myklebust96ef13b2008-02-22 15:46:41 -0500243void rpc_wake_up_queued_task(struct rpc_wait_queue *,
244 struct rpc_task *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700245void rpc_wake_up(struct rpc_wait_queue *);
246struct rpc_task *rpc_wake_up_next(struct rpc_wait_queue *);
247void rpc_wake_up_status(struct rpc_wait_queue *, int);
248void rpc_delay(struct rpc_task *, unsigned long);
249void * rpc_malloc(struct rpc_task *, size_t);
Chuck Leverc5a4dd82007-03-29 16:47:58 -0400250void rpc_free(void *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700251int rpciod_up(void);
252void rpciod_down(void);
Trond Myklebust44c28872006-01-03 09:55:06 +0100253int __rpc_wait_for_completion_task(struct rpc_task *task, int (*)(void *));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700254#ifdef RPC_DEBUG
255void rpc_show_tasks(void);
256#endif
257int rpc_init_mempool(void);
258void rpc_destroy_mempool(void);
Trond Myklebust24c5d9d2006-03-20 13:44:08 -0500259extern struct workqueue_struct *rpciod_workqueue;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700260
261static inline void rpc_exit(struct rpc_task *task, int status)
262{
263 task->tk_status = status;
Trond Myklebustabbcf282006-01-03 09:55:03 +0100264 task->tk_action = rpc_exit_task;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700265}
266
Trond Myklebust44c28872006-01-03 09:55:06 +0100267static inline int rpc_wait_for_completion_task(struct rpc_task *task)
268{
269 return __rpc_wait_for_completion_task(task, NULL);
270}
271
Linus Torvalds1da177e2005-04-16 15:20:36 -0700272#ifdef RPC_DEBUG
273static inline const char * rpc_qname(struct rpc_wait_queue *q)
274{
275 return ((q && q->name) ? q->name : "unknown");
276}
277#endif
278
279#endif /* _LINUX_SUNRPC_SCHED_H_ */