]>
git.proxmox.com Git - mirror_ubuntu-jammy-kernel.git/blob - include/linux/sunrpc/sched.h
2 * linux/include/linux/sunrpc/sched.h
4 * Scheduling primitives for kernel Sun RPC.
6 * Copyright (C) 1996, Olaf Kirch <okir@monad.swb.de>
9 #ifndef _LINUX_SUNRPC_SCHED_H_
10 #define _LINUX_SUNRPC_SCHED_H_
12 #include <linux/timer.h>
13 #include <linux/ktime.h>
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>
21 * This is the actual RPC procedure call info.
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 */
32 struct rpc_wait_queue
;
34 struct list_head list
; /* wait queue links */
35 struct list_head links
; /* Links to related tasks */
36 struct list_head timer_list
; /* Timer list */
37 unsigned long expires
;
41 * This is the RPC task struct
44 atomic_t tk_count
; /* Reference count */
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 */
52 struct rpc_message tk_msg
; /* RPC call info */
55 * callback to be executed after waking up
56 * action next procedure for async tasks
57 * tk_ops caller callbacks
59 void (*tk_callback
)(struct rpc_task
*);
60 void (*tk_action
)(struct rpc_task
*);
61 const struct rpc_call_ops
*tk_ops
;
64 unsigned long tk_timeout
; /* timeout for rpc_sleep() */
65 unsigned long tk_runstate
; /* Task run status */
66 struct workqueue_struct
*tk_workqueue
; /* Normally rpciod, but could
69 struct rpc_wait_queue
*tk_waitqueue
; /* RPC wait queue we're on */
71 struct work_struct tk_work
; /* Async task work queue */
72 struct rpc_wait tk_wait
; /* RPC wait */
75 ktime_t tk_start
; /* RPC task init timestamp */
77 pid_t tk_owner
; /* Process id for batching tasks */
78 int tk_status
; /* result of last operation */
79 unsigned short tk_flags
; /* misc flags */
80 unsigned short tk_timeouts
; /* maj timeouts */
82 #if defined(RPC_DEBUG) || defined(RPC_TRACEPOINTS)
83 unsigned short tk_pid
; /* debugging aid */
85 unsigned char tk_priority
: 2,/* Task priority */
91 typedef void (*rpc_action
)(struct rpc_task
*);
94 void (*rpc_call_prepare
)(struct rpc_task
*, void *);
95 void (*rpc_call_done
)(struct rpc_task
*, void *);
96 void (*rpc_count_stats
)(struct rpc_task
*, void *);
97 void (*rpc_release
)(void *);
100 struct rpc_task_setup
{
101 struct rpc_task
*task
;
102 struct rpc_clnt
*rpc_client
;
103 const struct rpc_message
*rpc_message
;
104 const struct rpc_call_ops
*callback_ops
;
106 struct workqueue_struct
*workqueue
;
107 unsigned short flags
;
108 signed char priority
;
114 #define RPC_TASK_ASYNC 0x0001 /* is an async task */
115 #define RPC_TASK_SWAPPER 0x0002 /* is swapping in/out */
116 #define RPC_CALL_MAJORSEEN 0x0020 /* major timeout seen */
117 #define RPC_TASK_ROOTCREDS 0x0040 /* force root creds */
118 #define RPC_TASK_DYNAMIC 0x0080 /* task was kmalloc'ed */
119 #define RPC_TASK_KILLED 0x0100 /* task was killed */
120 #define RPC_TASK_SOFT 0x0200 /* Use soft timeouts */
121 #define RPC_TASK_SOFTCONN 0x0400 /* Fail if can't connect */
122 #define RPC_TASK_SENT 0x0800 /* message was sent */
123 #define RPC_TASK_TIMEOUT 0x1000 /* fail with ETIMEDOUT on timeout */
124 #define RPC_TASK_NOCONNECT 0x2000 /* return ENOTCONN if not connected */
125 #define RPC_TASK_NO_RETRANS_TIMEOUT 0x4000 /* wait forever for a reply */
127 #define RPC_IS_ASYNC(t) ((t)->tk_flags & RPC_TASK_ASYNC)
128 #define RPC_IS_SWAPPER(t) ((t)->tk_flags & RPC_TASK_SWAPPER)
129 #define RPC_DO_ROOTOVERRIDE(t) ((t)->tk_flags & RPC_TASK_ROOTCREDS)
130 #define RPC_ASSASSINATED(t) ((t)->tk_flags & RPC_TASK_KILLED)
131 #define RPC_IS_SOFT(t) ((t)->tk_flags & (RPC_TASK_SOFT|RPC_TASK_TIMEOUT))
132 #define RPC_IS_SOFTCONN(t) ((t)->tk_flags & RPC_TASK_SOFTCONN)
133 #define RPC_WAS_SENT(t) ((t)->tk_flags & RPC_TASK_SENT)
135 #define RPC_TASK_RUNNING 0
136 #define RPC_TASK_QUEUED 1
137 #define RPC_TASK_ACTIVE 2
139 #define RPC_IS_RUNNING(t) test_bit(RPC_TASK_RUNNING, &(t)->tk_runstate)
140 #define rpc_set_running(t) set_bit(RPC_TASK_RUNNING, &(t)->tk_runstate)
141 #define rpc_test_and_set_running(t) \
142 test_and_set_bit(RPC_TASK_RUNNING, &(t)->tk_runstate)
143 #define rpc_clear_running(t) \
145 smp_mb__before_atomic(); \
146 clear_bit(RPC_TASK_RUNNING, &(t)->tk_runstate); \
147 smp_mb__after_atomic(); \
150 #define RPC_IS_QUEUED(t) test_bit(RPC_TASK_QUEUED, &(t)->tk_runstate)
151 #define rpc_set_queued(t) set_bit(RPC_TASK_QUEUED, &(t)->tk_runstate)
152 #define rpc_clear_queued(t) \
154 smp_mb__before_atomic(); \
155 clear_bit(RPC_TASK_QUEUED, &(t)->tk_runstate); \
156 smp_mb__after_atomic(); \
159 #define RPC_IS_ACTIVATED(t) test_bit(RPC_TASK_ACTIVE, &(t)->tk_runstate)
163 * Note: if you change these, you must also change
164 * the task initialization definitions below.
166 #define RPC_PRIORITY_LOW (-1)
167 #define RPC_PRIORITY_NORMAL (0)
168 #define RPC_PRIORITY_HIGH (1)
169 #define RPC_PRIORITY_PRIVILEGED (2)
170 #define RPC_NR_PRIORITY (1 + RPC_PRIORITY_PRIVILEGED - RPC_PRIORITY_LOW)
173 struct timer_list timer
;
174 struct list_head list
;
175 unsigned long expires
;
179 * RPC synchronization objects
181 struct rpc_wait_queue
{
183 struct list_head tasks
[RPC_NR_PRIORITY
]; /* task queue for each priority level */
184 pid_t owner
; /* process id of last task serviced */
185 unsigned char maxpriority
; /* maximum priority (0 if queue is not a priority queue) */
186 unsigned char priority
; /* current priority */
187 unsigned char nr
; /* # tasks remaining for cookie */
188 unsigned short qlen
; /* total # tasks waiting in queue */
189 struct rpc_timer timer_list
;
190 #if defined(RPC_DEBUG) || defined(RPC_TRACEPOINTS)
196 * This is the # requests to send consecutively
197 * from a single cookie. The aim is to improve
198 * performance of NFS operations such as read/write.
200 #define RPC_BATCH_COUNT 16
201 #define RPC_IS_PRIORITY(q) ((q)->maxpriority > 0)
204 * Function prototypes
206 struct rpc_task
*rpc_new_task(const struct rpc_task_setup
*);
207 struct rpc_task
*rpc_run_task(const struct rpc_task_setup
*);
208 struct rpc_task
*rpc_run_bc_task(struct rpc_rqst
*req
,
209 const struct rpc_call_ops
*ops
);
210 void rpc_put_task(struct rpc_task
*);
211 void rpc_put_task_async(struct rpc_task
*);
212 void rpc_exit_task(struct rpc_task
*);
213 void rpc_exit(struct rpc_task
*, int);
214 void rpc_release_calldata(const struct rpc_call_ops
*, void *);
215 void rpc_killall_tasks(struct rpc_clnt
*);
216 void rpc_execute(struct rpc_task
*);
217 void rpc_init_priority_wait_queue(struct rpc_wait_queue
*, const char *);
218 void rpc_init_wait_queue(struct rpc_wait_queue
*, const char *);
219 void rpc_destroy_wait_queue(struct rpc_wait_queue
*);
220 void rpc_sleep_on(struct rpc_wait_queue
*, struct rpc_task
*,
222 void rpc_sleep_on_priority(struct rpc_wait_queue
*,
226 void rpc_wake_up_queued_task(struct rpc_wait_queue
*,
228 void rpc_wake_up(struct rpc_wait_queue
*);
229 struct rpc_task
*rpc_wake_up_next(struct rpc_wait_queue
*);
230 struct rpc_task
*rpc_wake_up_first(struct rpc_wait_queue
*,
231 bool (*)(struct rpc_task
*, void *),
233 void rpc_wake_up_status(struct rpc_wait_queue
*, int);
234 void rpc_delay(struct rpc_task
*, unsigned long);
235 void * rpc_malloc(struct rpc_task
*, size_t);
236 void rpc_free(void *);
238 void rpciod_down(void);
239 int __rpc_wait_for_completion_task(struct rpc_task
*task
, int (*)(void *));
242 void rpc_show_tasks(struct net
*);
244 int rpc_init_mempool(void);
245 void rpc_destroy_mempool(void);
246 extern struct workqueue_struct
*rpciod_workqueue
;
247 void rpc_prepare_task(struct rpc_task
*task
);
249 static inline int rpc_wait_for_completion_task(struct rpc_task
*task
)
251 return __rpc_wait_for_completion_task(task
, NULL
);
254 #if defined(RPC_DEBUG) || defined (RPC_TRACEPOINTS)
255 static inline const char * rpc_qname(const struct rpc_wait_queue
*q
)
257 return ((q
&& q
->name
) ? q
->name
: "unknown");
260 static inline void rpc_assign_waitqueue_name(struct rpc_wait_queue
*q
,
266 static inline void rpc_assign_waitqueue_name(struct rpc_wait_queue
*q
,
272 #endif /* _LINUX_SUNRPC_SCHED_H_ */