blob: 503a937bdca91d3cb68c36f76d64649e5fd87ab2 [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 */
Linus Torvalds1da177e2005-04-16 15:20:36 -070036};
37
38/*
39 * This is the RPC task struct
40 */
41struct rpc_task {
42#ifdef RPC_DEBUG
43 unsigned long tk_magic; /* 0xf00baa */
44#endif
Trond Myklebust44c28872006-01-03 09:55:06 +010045 atomic_t tk_count; /* Reference count */
Linus Torvalds1da177e2005-04-16 15:20:36 -070046 struct list_head tk_task; /* global list of tasks */
47 struct rpc_clnt * tk_client; /* RPC client */
48 struct rpc_rqst * tk_rqstp; /* RPC request */
49 int tk_status; /* result of last operation */
50
51 /*
52 * RPC call state
53 */
54 struct rpc_message tk_msg; /* RPC call info */
Linus Torvalds1da177e2005-04-16 15:20:36 -070055 __u8 tk_garb_retry;
56 __u8 tk_cred_retry;
57
Linus Torvalds1da177e2005-04-16 15:20:36 -070058 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -070059 * callback to be executed after waking up
60 * action next procedure for async tasks
Trond Myklebust963d8fe2006-01-03 09:55:04 +010061 * tk_ops caller callbacks
Linus Torvalds1da177e2005-04-16 15:20:36 -070062 */
Linus Torvalds1da177e2005-04-16 15:20:36 -070063 void (*tk_callback)(struct rpc_task *);
64 void (*tk_action)(struct rpc_task *);
Trond Myklebust963d8fe2006-01-03 09:55:04 +010065 const struct rpc_call_ops *tk_ops;
Linus Torvalds1da177e2005-04-16 15:20:36 -070066 void * tk_calldata;
67
68 /*
69 * tk_timer is used for async processing by the RPC scheduling
70 * primitives. You should not access this directly unless
71 * you have a pathological interest in kernel oopses.
72 */
73 struct timer_list tk_timer; /* kernel timer */
74 unsigned long tk_timeout; /* timeout for rpc_sleep() */
75 unsigned short tk_flags; /* misc flags */
Linus Torvalds1da177e2005-04-16 15:20:36 -070076 unsigned long tk_runstate; /* Task run status */
77 struct workqueue_struct *tk_workqueue; /* Normally rpciod, but could
78 * be any workqueue
79 */
Trond Myklebust96ef13b2008-02-22 15:46:41 -050080 struct rpc_wait_queue *tk_waitqueue; /* RPC wait queue we're on */
Linus Torvalds1da177e2005-04-16 15:20:36 -070081 union {
82 struct work_struct tk_work; /* Async task work queue */
83 struct rpc_wait tk_wait; /* RPC wait */
Trond Myklebust8aca67f2006-11-13 16:23:44 -050084 struct rcu_head tk_rcu; /* for task deletion */
Linus Torvalds1da177e2005-04-16 15:20:36 -070085 } u;
Chuck Leveref759a22006-03-20 13:44:17 -050086
87 unsigned short tk_timeouts; /* maj timeouts */
88 size_t tk_bytes_sent; /* total bytes sent */
89 unsigned long tk_start; /* RPC task init timestamp */
90 long tk_rtt; /* round-trip time (jiffies) */
91
Trond Myklebust3ff75762007-07-14 15:40:00 -040092 pid_t tk_owner; /* Process id for batching tasks */
93 unsigned char tk_priority : 2;/* Task priority */
94
Linus Torvalds1da177e2005-04-16 15:20:36 -070095#ifdef RPC_DEBUG
96 unsigned short tk_pid; /* debugging aid */
97#endif
98};
Linus Torvalds1da177e2005-04-16 15:20:36 -070099#define tk_xprt tk_client->cl_xprt
100
101/* support walking a list of tasks on a wait queue */
102#define task_for_each(task, pos, head) \
103 list_for_each(pos, head) \
104 if ((task=list_entry(pos, struct rpc_task, u.tk_wait.list)),1)
105
106#define task_for_first(task, head) \
107 if (!list_empty(head) && \
108 ((task=list_entry((head)->next, struct rpc_task, u.tk_wait.list)),1))
109
Linus Torvalds1da177e2005-04-16 15:20:36 -0700110typedef void (*rpc_action)(struct rpc_task *);
111
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100112struct rpc_call_ops {
Trond Myklebust4ce70ad2006-01-03 09:55:05 +0100113 void (*rpc_call_prepare)(struct rpc_task *, void *);
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100114 void (*rpc_call_done)(struct rpc_task *, void *);
115 void (*rpc_release)(void *);
116};
117
Trond Myklebust84115e12007-07-14 15:39:59 -0400118struct rpc_task_setup {
Trond Myklebuste8f5d772007-10-25 18:42:53 -0400119 struct rpc_task *task;
Trond Myklebust84115e12007-07-14 15:39:59 -0400120 struct rpc_clnt *rpc_client;
121 const struct rpc_message *rpc_message;
122 const struct rpc_call_ops *callback_ops;
123 void *callback_data;
Trond Myklebust32bfb5c2008-02-19 20:04:21 -0500124 struct workqueue_struct *workqueue;
Trond Myklebust84115e12007-07-14 15:39:59 -0400125 unsigned short flags;
Trond Myklebust3ff75762007-07-14 15:40:00 -0400126 signed char priority;
Trond Myklebust84115e12007-07-14 15:39:59 -0400127};
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100128
Linus Torvalds1da177e2005-04-16 15:20:36 -0700129/*
130 * RPC task flags
131 */
132#define RPC_TASK_ASYNC 0x0001 /* is an async task */
133#define RPC_TASK_SWAPPER 0x0002 /* is swapping in/out */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700134#define RPC_CALL_MAJORSEEN 0x0020 /* major timeout seen */
135#define RPC_TASK_ROOTCREDS 0x0040 /* force root creds */
136#define RPC_TASK_DYNAMIC 0x0080 /* task was kmalloc'ed */
137#define RPC_TASK_KILLED 0x0100 /* task was killed */
138#define RPC_TASK_SOFT 0x0200 /* Use soft timeouts */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700139
140#define RPC_IS_ASYNC(t) ((t)->tk_flags & RPC_TASK_ASYNC)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700141#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)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700144#define RPC_DO_CALLBACK(t) ((t)->tk_callback != NULL)
145#define RPC_IS_SOFT(t) ((t)->tk_flags & RPC_TASK_SOFT)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700146
147#define RPC_TASK_RUNNING 0
148#define RPC_TASK_QUEUED 1
149#define RPC_TASK_WAKEUP 2
150#define RPC_TASK_HAS_TIMER 3
Trond Myklebust44c28872006-01-03 09:55:06 +0100151#define RPC_TASK_ACTIVE 4
Linus Torvalds1da177e2005-04-16 15:20:36 -0700152
Ralf Baechle7b8f8502007-02-20 13:57:45 -0800153#define RPC_IS_RUNNING(t) test_bit(RPC_TASK_RUNNING, &(t)->tk_runstate)
154#define rpc_set_running(t) set_bit(RPC_TASK_RUNNING, &(t)->tk_runstate)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700155#define rpc_test_and_set_running(t) \
Ralf Baechle7b8f8502007-02-20 13:57:45 -0800156 test_and_set_bit(RPC_TASK_RUNNING, &(t)->tk_runstate)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700157#define rpc_clear_running(t) \
158 do { \
159 smp_mb__before_clear_bit(); \
160 clear_bit(RPC_TASK_RUNNING, &(t)->tk_runstate); \
161 smp_mb__after_clear_bit(); \
162 } while (0)
163
Ralf Baechle7b8f8502007-02-20 13:57:45 -0800164#define RPC_IS_QUEUED(t) test_bit(RPC_TASK_QUEUED, &(t)->tk_runstate)
165#define rpc_set_queued(t) set_bit(RPC_TASK_QUEUED, &(t)->tk_runstate)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700166#define rpc_clear_queued(t) \
167 do { \
168 smp_mb__before_clear_bit(); \
169 clear_bit(RPC_TASK_QUEUED, &(t)->tk_runstate); \
170 smp_mb__after_clear_bit(); \
171 } while (0)
172
173#define rpc_start_wakeup(t) \
174 (test_and_set_bit(RPC_TASK_WAKEUP, &(t)->tk_runstate) == 0)
175#define rpc_finish_wakeup(t) \
176 do { \
177 smp_mb__before_clear_bit(); \
178 clear_bit(RPC_TASK_WAKEUP, &(t)->tk_runstate); \
179 smp_mb__after_clear_bit(); \
180 } while (0)
181
Ralf Baechle7b8f8502007-02-20 13:57:45 -0800182#define RPC_IS_ACTIVATED(t) test_bit(RPC_TASK_ACTIVE, &(t)->tk_runstate)
Trond Myklebust44c28872006-01-03 09:55:06 +0100183
Linus Torvalds1da177e2005-04-16 15:20:36 -0700184/*
185 * Task priorities.
186 * Note: if you change these, you must also change
187 * the task initialization definitions below.
188 */
Trond Myklebust3ff75762007-07-14 15:40:00 -0400189#define RPC_PRIORITY_LOW (-1)
190#define RPC_PRIORITY_NORMAL (0)
191#define RPC_PRIORITY_HIGH (1)
192#define RPC_NR_PRIORITY (1 + RPC_PRIORITY_HIGH - RPC_PRIORITY_LOW)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700193
194/*
195 * RPC synchronization objects
196 */
197struct rpc_wait_queue {
198 spinlock_t lock;
199 struct list_head tasks[RPC_NR_PRIORITY]; /* task queue for each priority level */
Trond Myklebust3ff75762007-07-14 15:40:00 -0400200 pid_t owner; /* process id of last task serviced */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700201 unsigned char maxpriority; /* maximum priority (0 if queue is not a priority queue) */
202 unsigned char priority; /* current priority */
203 unsigned char count; /* # task groups remaining serviced so far */
204 unsigned char nr; /* # tasks remaining for cookie */
Chuck Levere19b63d2006-03-20 13:44:15 -0500205 unsigned short qlen; /* total # tasks waiting in queue */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700206#ifdef RPC_DEBUG
207 const char * name;
208#endif
209};
210
211/*
212 * This is the # requests to send consecutively
213 * from a single cookie. The aim is to improve
214 * performance of NFS operations such as read/write.
215 */
216#define RPC_BATCH_COUNT 16
Linus Torvalds1da177e2005-04-16 15:20:36 -0700217#define RPC_IS_PRIORITY(q) ((q)->maxpriority > 0)
218
219/*
220 * Function prototypes
221 */
Trond Myklebust84115e12007-07-14 15:39:59 -0400222struct rpc_task *rpc_new_task(const struct rpc_task_setup *);
Trond Myklebustc970aa82007-07-14 15:39:59 -0400223struct rpc_task *rpc_run_task(const struct rpc_task_setup *);
Trond Myklebuste6b3c4d2006-11-11 22:18:03 -0500224void rpc_put_task(struct rpc_task *);
Trond Myklebustabbcf282006-01-03 09:55:03 +0100225void rpc_exit_task(struct rpc_task *);
Trond Myklebustbbd5a1f2006-10-18 16:01:05 -0400226void rpc_release_calldata(const struct rpc_call_ops *, void *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700227void rpc_killall_tasks(struct rpc_clnt *);
Trond Myklebust2efef832007-02-03 13:38:41 -0800228void rpc_execute(struct rpc_task *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700229void rpc_init_priority_wait_queue(struct rpc_wait_queue *, const char *);
230void rpc_init_wait_queue(struct rpc_wait_queue *, const char *);
231void rpc_sleep_on(struct rpc_wait_queue *, struct rpc_task *,
Trond Myklebust5d008372008-02-22 16:34:17 -0500232 rpc_action action);
Trond Myklebust96ef13b2008-02-22 15:46:41 -0500233void rpc_wake_up_queued_task(struct rpc_wait_queue *,
234 struct rpc_task *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700235void rpc_wake_up(struct rpc_wait_queue *);
236struct rpc_task *rpc_wake_up_next(struct rpc_wait_queue *);
237void rpc_wake_up_status(struct rpc_wait_queue *, int);
238void rpc_delay(struct rpc_task *, unsigned long);
239void * rpc_malloc(struct rpc_task *, size_t);
Chuck Leverc5a4dd82007-03-29 16:47:58 -0400240void rpc_free(void *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700241int rpciod_up(void);
242void rpciod_down(void);
Trond Myklebust44c28872006-01-03 09:55:06 +0100243int __rpc_wait_for_completion_task(struct rpc_task *task, int (*)(void *));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700244#ifdef RPC_DEBUG
245void rpc_show_tasks(void);
246#endif
247int rpc_init_mempool(void);
248void rpc_destroy_mempool(void);
Trond Myklebust24c5d9d2006-03-20 13:44:08 -0500249extern struct workqueue_struct *rpciod_workqueue;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700250
251static inline void rpc_exit(struct rpc_task *task, int status)
252{
253 task->tk_status = status;
Trond Myklebustabbcf282006-01-03 09:55:03 +0100254 task->tk_action = rpc_exit_task;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700255}
256
Trond Myklebust44c28872006-01-03 09:55:06 +0100257static inline int rpc_wait_for_completion_task(struct rpc_task *task)
258{
259 return __rpc_wait_for_completion_task(task, NULL);
260}
261
Linus Torvalds1da177e2005-04-16 15:20:36 -0700262#ifdef RPC_DEBUG
263static inline const char * rpc_qname(struct rpc_wait_queue *q)
264{
265 return ((q && q->name) ? q->name : "unknown");
266}
267#endif
268
269#endif /* _LINUX_SUNRPC_SCHED_H_ */