blob: c9548a63d09bbb6ce09097a0422ebd3b6091076d [file] [log] [blame]
Greg Kroah-Hartmanb2441312017-11-01 15:07:57 +01001/* SPDX-License-Identifier: GPL-2.0 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002/*
3 * linux/include/linux/sunrpc/sched.h
4 *
5 * Scheduling primitives for kernel Sun RPC.
6 *
7 * Copyright (C) 1996, Olaf Kirch <okir@monad.swb.de>
8 */
9
10#ifndef _LINUX_SUNRPC_SCHED_H_
11#define _LINUX_SUNRPC_SCHED_H_
12
13#include <linux/timer.h>
Chuck Leverff839972010-05-07 13:34:47 -040014#include <linux/ktime.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070015#include <linux/sunrpc/types.h>
16#include <linux/spinlock.h>
Ingo Molnar5dd43ce2017-06-20 12:19:09 +020017#include <linux/wait_bit.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070018#include <linux/workqueue.h>
19#include <linux/sunrpc/xdr.h>
20
21/*
22 * This is the actual RPC procedure call info.
23 */
24struct rpc_procinfo;
25struct rpc_message {
Christoph Hellwig499b4982017-05-12 15:36:49 +020026 const struct rpc_procinfo *rpc_proc; /* Procedure information */
Linus Torvalds1da177e2005-04-16 15:20:36 -070027 void * rpc_argp; /* Arguments */
28 void * rpc_resp; /* Result */
29 struct rpc_cred * rpc_cred; /* Credentials */
30};
31
Trond Myklebust963d8fe2006-01-03 09:55:04 +010032struct rpc_call_ops;
Linus Torvalds1da177e2005-04-16 15:20:36 -070033struct rpc_wait_queue;
34struct rpc_wait {
35 struct list_head list; /* wait queue links */
36 struct list_head links; /* Links to related tasks */
Trond Myklebust36df9aa2007-07-18 16:18:52 -040037 struct list_head timer_list; /* Timer list */
38 unsigned long expires;
Linus Torvalds1da177e2005-04-16 15:20:36 -070039};
40
41/*
42 * This is the RPC task struct
43 */
44struct rpc_task {
Trond Myklebust44c28872006-01-03 09:55:06 +010045 atomic_t tk_count; /* Reference count */
Trond Myklebust5edd1052015-02-25 14:49:16 -050046 int tk_status; /* result of last operation */
Linus Torvalds1da177e2005-04-16 15:20:36 -070047 struct list_head tk_task; /* global list of tasks */
Linus Torvalds1da177e2005-04-16 15:20:36 -070048
Linus Torvalds1da177e2005-04-16 15:20:36 -070049 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -070050 * callback to be executed after waking up
51 * action next procedure for async tasks
Linus Torvalds1da177e2005-04-16 15:20:36 -070052 */
Linus Torvalds1da177e2005-04-16 15:20:36 -070053 void (*tk_callback)(struct rpc_task *);
54 void (*tk_action)(struct rpc_task *);
Linus Torvalds1da177e2005-04-16 15:20:36 -070055
Linus Torvalds1da177e2005-04-16 15:20:36 -070056 unsigned long tk_timeout; /* timeout for rpc_sleep() */
Linus Torvalds1da177e2005-04-16 15:20:36 -070057 unsigned long tk_runstate; /* Task run status */
Trond Myklebust5edd1052015-02-25 14:49:16 -050058
Trond Myklebust96ef13b2008-02-22 15:46:41 -050059 struct rpc_wait_queue *tk_waitqueue; /* RPC wait queue we're on */
Linus Torvalds1da177e2005-04-16 15:20:36 -070060 union {
61 struct work_struct tk_work; /* Async task work queue */
62 struct rpc_wait tk_wait; /* RPC wait */
63 } u;
Chuck Leveref759a22006-03-20 13:44:17 -050064
Trond Myklebust5edd1052015-02-25 14:49:16 -050065 /*
66 * RPC call state
67 */
68 struct rpc_message tk_msg; /* RPC call info */
69 void * tk_calldata; /* Caller private data */
70 const struct rpc_call_ops *tk_ops; /* Caller callbacks */
71
72 struct rpc_clnt * tk_client; /* RPC client */
Trond Myklebustfb43d172016-01-30 16:39:26 -050073 struct rpc_xprt * tk_xprt; /* Transport */
74
Trond Myklebust5edd1052015-02-25 14:49:16 -050075 struct rpc_rqst * tk_rqstp; /* RPC request */
76
77 struct workqueue_struct *tk_workqueue; /* Normally rpciod, but could
78 * be any workqueue
79 */
Trond Myklebustd60dbb22010-05-13 12:51:49 -040080 ktime_t tk_start; /* RPC task init timestamp */
Chuck Leveref759a22006-03-20 13:44:17 -050081
Trond Myklebust3ff75762007-07-14 15:40:00 -040082 pid_t tk_owner; /* Process id for batching tasks */
Trond Myklebust9bb0b812010-05-13 12:51:50 -040083 unsigned short tk_flags; /* misc flags */
84 unsigned short tk_timeouts; /* maj timeouts */
Trond Myklebust3ff75762007-07-14 15:40:00 -040085
Jeff Layton13067292014-11-17 16:58:05 -050086#if IS_ENABLED(CONFIG_SUNRPC_DEBUG) || IS_ENABLED(CONFIG_TRACEPOINTS)
Linus Torvalds1da177e2005-04-16 15:20:36 -070087 unsigned short tk_pid; /* debugging aid */
88#endif
Trond Myklebust9bb0b812010-05-13 12:51:50 -040089 unsigned char tk_priority : 2,/* Task priority */
90 tk_garb_retry : 2,
Trond Myklebust0b760112011-05-31 15:15:34 -040091 tk_cred_retry : 2,
92 tk_rebind_retry : 2;
Linus Torvalds1da177e2005-04-16 15:20:36 -070093};
Linus Torvalds1da177e2005-04-16 15:20:36 -070094
Linus Torvalds1da177e2005-04-16 15:20:36 -070095typedef void (*rpc_action)(struct rpc_task *);
96
Trond Myklebust963d8fe2006-01-03 09:55:04 +010097struct rpc_call_ops {
Trond Myklebust4ce70ad2006-01-03 09:55:05 +010098 void (*rpc_call_prepare)(struct rpc_task *, void *);
Trond Myklebust963d8fe2006-01-03 09:55:04 +010099 void (*rpc_call_done)(struct rpc_task *, void *);
Weston Andros Adamson0a702192012-02-17 13:15:24 -0500100 void (*rpc_count_stats)(struct rpc_task *, void *);
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100101 void (*rpc_release)(void *);
102};
103
Trond Myklebust84115e12007-07-14 15:39:59 -0400104struct rpc_task_setup {
Trond Myklebuste8f5d772007-10-25 18:42:53 -0400105 struct rpc_task *task;
Trond Myklebust84115e12007-07-14 15:39:59 -0400106 struct rpc_clnt *rpc_client;
Trond Myklebust9d614982016-01-30 18:13:05 -0500107 struct rpc_xprt *rpc_xprt;
Trond Myklebust84115e12007-07-14 15:39:59 -0400108 const struct rpc_message *rpc_message;
109 const struct rpc_call_ops *callback_ops;
110 void *callback_data;
Trond Myklebust32bfb5c2008-02-19 20:04:21 -0500111 struct workqueue_struct *workqueue;
Trond Myklebust84115e12007-07-14 15:39:59 -0400112 unsigned short flags;
Trond Myklebust3ff75762007-07-14 15:40:00 -0400113 signed char priority;
Trond Myklebust84115e12007-07-14 15:39:59 -0400114};
Trond Myklebust963d8fe2006-01-03 09:55:04 +0100115
Linus Torvalds1da177e2005-04-16 15:20:36 -0700116/*
117 * RPC task flags
118 */
119#define RPC_TASK_ASYNC 0x0001 /* is an async task */
120#define RPC_TASK_SWAPPER 0x0002 /* is swapping in/out */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700121#define RPC_CALL_MAJORSEEN 0x0020 /* major timeout seen */
122#define RPC_TASK_ROOTCREDS 0x0040 /* force root creds */
123#define RPC_TASK_DYNAMIC 0x0080 /* task was kmalloc'ed */
124#define RPC_TASK_KILLED 0x0100 /* task was killed */
125#define RPC_TASK_SOFT 0x0200 /* Use soft timeouts */
Chuck Lever09a21c42009-12-03 15:58:56 -0500126#define RPC_TASK_SOFTCONN 0x0400 /* Fail if can't connect */
Bryan Schumaker468f8612011-04-18 15:57:32 -0400127#define RPC_TASK_SENT 0x0800 /* message was sent */
Trond Myklebust7494d002011-04-24 14:28:45 -0400128#define RPC_TASK_TIMEOUT 0x1000 /* fail with ETIMEDOUT on timeout */
Trond Myklebust786615b2013-08-05 16:04:47 -0400129#define RPC_TASK_NOCONNECT 0x2000 /* return ENOTCONN if not connected */
Trond Myklebust8a19a0b2013-09-24 12:00:27 -0400130#define RPC_TASK_NO_RETRANS_TIMEOUT 0x4000 /* wait forever for a reply */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700131
132#define RPC_IS_ASYNC(t) ((t)->tk_flags & RPC_TASK_ASYNC)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700133#define RPC_IS_SWAPPER(t) ((t)->tk_flags & RPC_TASK_SWAPPER)
134#define RPC_DO_ROOTOVERRIDE(t) ((t)->tk_flags & RPC_TASK_ROOTCREDS)
135#define RPC_ASSASSINATED(t) ((t)->tk_flags & RPC_TASK_KILLED)
Trond Myklebust7494d002011-04-24 14:28:45 -0400136#define RPC_IS_SOFT(t) ((t)->tk_flags & (RPC_TASK_SOFT|RPC_TASK_TIMEOUT))
Chuck Lever09a21c42009-12-03 15:58:56 -0500137#define RPC_IS_SOFTCONN(t) ((t)->tk_flags & RPC_TASK_SOFTCONN)
Bryan Schumaker468f8612011-04-18 15:57:32 -0400138#define RPC_WAS_SENT(t) ((t)->tk_flags & RPC_TASK_SENT)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700139
140#define RPC_TASK_RUNNING 0
141#define RPC_TASK_QUEUED 1
Trond Myklebustf5fb7b062008-02-25 21:40:50 -0800142#define RPC_TASK_ACTIVE 2
Trond Myklebust729749b2017-08-13 10:03:59 -0400143#define RPC_TASK_MSG_RECV 3
144#define RPC_TASK_MSG_RECV_WAIT 4
Linus Torvalds1da177e2005-04-16 15:20:36 -0700145
Ralf Baechle7b8f8502007-02-20 13:57:45 -0800146#define RPC_IS_RUNNING(t) test_bit(RPC_TASK_RUNNING, &(t)->tk_runstate)
147#define rpc_set_running(t) set_bit(RPC_TASK_RUNNING, &(t)->tk_runstate)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700148#define rpc_test_and_set_running(t) \
Ralf Baechle7b8f8502007-02-20 13:57:45 -0800149 test_and_set_bit(RPC_TASK_RUNNING, &(t)->tk_runstate)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700150#define rpc_clear_running(t) \
151 do { \
Peter Zijlstra4e857c52014-03-17 18:06:10 +0100152 smp_mb__before_atomic(); \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700153 clear_bit(RPC_TASK_RUNNING, &(t)->tk_runstate); \
Peter Zijlstra4e857c52014-03-17 18:06:10 +0100154 smp_mb__after_atomic(); \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700155 } while (0)
156
Ralf Baechle7b8f8502007-02-20 13:57:45 -0800157#define RPC_IS_QUEUED(t) test_bit(RPC_TASK_QUEUED, &(t)->tk_runstate)
158#define rpc_set_queued(t) set_bit(RPC_TASK_QUEUED, &(t)->tk_runstate)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700159#define rpc_clear_queued(t) \
160 do { \
Peter Zijlstra4e857c52014-03-17 18:06:10 +0100161 smp_mb__before_atomic(); \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700162 clear_bit(RPC_TASK_QUEUED, &(t)->tk_runstate); \
Peter Zijlstra4e857c52014-03-17 18:06:10 +0100163 smp_mb__after_atomic(); \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700164 } while (0)
165
Ralf Baechle7b8f8502007-02-20 13:57:45 -0800166#define RPC_IS_ACTIVATED(t) test_bit(RPC_TASK_ACTIVE, &(t)->tk_runstate)
Trond Myklebust44c28872006-01-03 09:55:06 +0100167
Linus Torvalds1da177e2005-04-16 15:20:36 -0700168/*
169 * Task priorities.
170 * Note: if you change these, you must also change
171 * the task initialization definitions below.
172 */
Trond Myklebust3ff75762007-07-14 15:40:00 -0400173#define RPC_PRIORITY_LOW (-1)
174#define RPC_PRIORITY_NORMAL (0)
175#define RPC_PRIORITY_HIGH (1)
Alexandros Batsakiscf3b01b2009-12-14 21:27:55 -0800176#define RPC_PRIORITY_PRIVILEGED (2)
177#define RPC_NR_PRIORITY (1 + RPC_PRIORITY_PRIVILEGED - RPC_PRIORITY_LOW)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700178
Trond Myklebust36df9aa2007-07-18 16:18:52 -0400179struct rpc_timer {
180 struct timer_list timer;
181 struct list_head list;
182 unsigned long expires;
183};
184
Linus Torvalds1da177e2005-04-16 15:20:36 -0700185/*
186 * RPC synchronization objects
187 */
188struct rpc_wait_queue {
189 spinlock_t lock;
190 struct list_head tasks[RPC_NR_PRIORITY]; /* task queue for each priority level */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700191 unsigned char maxpriority; /* maximum priority (0 if queue is not a priority queue) */
192 unsigned char priority; /* current priority */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700193 unsigned char nr; /* # tasks remaining for cookie */
Chuck Levere19b63d2006-03-20 13:44:15 -0500194 unsigned short qlen; /* total # tasks waiting in queue */
Trond Myklebust36df9aa2007-07-18 16:18:52 -0400195 struct rpc_timer timer_list;
Jeff Layton13067292014-11-17 16:58:05 -0500196#if IS_ENABLED(CONFIG_SUNRPC_DEBUG) || IS_ENABLED(CONFIG_TRACEPOINTS)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700197 const char * name;
198#endif
199};
200
201/*
202 * This is the # requests to send consecutively
203 * from a single cookie. The aim is to improve
204 * performance of NFS operations such as read/write.
205 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700206#define RPC_IS_PRIORITY(q) ((q)->maxpriority > 0)
207
208/*
209 * Function prototypes
210 */
Trond Myklebust84115e12007-07-14 15:39:59 -0400211struct rpc_task *rpc_new_task(const struct rpc_task_setup *);
Trond Myklebustc970aa82007-07-14 15:39:59 -0400212struct rpc_task *rpc_run_task(const struct rpc_task_setup *);
Trond Myklebust0f419792015-06-01 22:59:08 -0400213struct rpc_task *rpc_run_bc_task(struct rpc_rqst *req);
Trond Myklebuste6b3c4d2006-11-11 22:18:03 -0500214void rpc_put_task(struct rpc_task *);
Trond Myklebustbf294b42011-02-21 11:05:41 -0800215void rpc_put_task_async(struct rpc_task *);
Trond Myklebustabbcf282006-01-03 09:55:03 +0100216void rpc_exit_task(struct rpc_task *);
Trond Myklebustd9b6cd92010-07-31 14:29:08 -0400217void rpc_exit(struct rpc_task *, int);
Trond Myklebustbbd5a1f2006-10-18 16:01:05 -0400218void rpc_release_calldata(const struct rpc_call_ops *, void *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700219void rpc_killall_tasks(struct rpc_clnt *);
Trond Myklebust2efef832007-02-03 13:38:41 -0800220void rpc_execute(struct rpc_task *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700221void rpc_init_priority_wait_queue(struct rpc_wait_queue *, const char *);
222void rpc_init_wait_queue(struct rpc_wait_queue *, const char *);
Trond Myklebustf6a1cc82008-02-22 17:06:55 -0500223void rpc_destroy_wait_queue(struct rpc_wait_queue *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700224void rpc_sleep_on(struct rpc_wait_queue *, struct rpc_task *,
Trond Myklebust5d008372008-02-22 16:34:17 -0500225 rpc_action action);
Trond Myklebust3b27bad2011-07-17 18:11:34 -0400226void rpc_sleep_on_priority(struct rpc_wait_queue *,
227 struct rpc_task *,
228 rpc_action action,
229 int priority);
Trond Myklebust96ef13b2008-02-22 15:46:41 -0500230void rpc_wake_up_queued_task(struct rpc_wait_queue *,
231 struct rpc_task *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700232void rpc_wake_up(struct rpc_wait_queue *);
233struct rpc_task *rpc_wake_up_next(struct rpc_wait_queue *);
Trond Myklebustf1dc2372016-05-27 12:59:33 -0400234struct rpc_task *rpc_wake_up_first_on_wq(struct workqueue_struct *wq,
235 struct rpc_wait_queue *,
236 bool (*)(struct rpc_task *, void *),
237 void *);
Trond Myklebust961a8282012-01-17 22:57:37 -0500238struct rpc_task *rpc_wake_up_first(struct rpc_wait_queue *,
239 bool (*)(struct rpc_task *, void *),
240 void *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700241void rpc_wake_up_status(struct rpc_wait_queue *, int);
242void rpc_delay(struct rpc_task *, unsigned long);
Chuck Lever5fe6eaa2016-09-15 10:55:20 -0400243int rpc_malloc(struct rpc_task *);
Chuck Lever3435c742016-09-15 10:55:29 -0400244void rpc_free(struct rpc_task *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700245int rpciod_up(void);
246void rpciod_down(void);
NeilBrownc1221322014-07-07 15:16:04 +1000247int __rpc_wait_for_completion_task(struct rpc_task *task, wait_bit_action_f *);
Jeff Laytonf895b252014-11-17 16:58:04 -0500248#if IS_ENABLED(CONFIG_SUNRPC_DEBUG)
Stanislav Kinsbursky70abc492012-01-12 22:07:51 +0400249struct net;
250void rpc_show_tasks(struct net *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700251#endif
252int rpc_init_mempool(void);
253void rpc_destroy_mempool(void);
Trond Myklebust24c5d9d2006-03-20 13:44:08 -0500254extern struct workqueue_struct *rpciod_workqueue;
Trond Myklebust40a5f1b2016-05-27 10:39:50 -0400255extern struct workqueue_struct *xprtiod_workqueue;
Andy Adamsonaae20062009-04-01 09:22:40 -0400256void rpc_prepare_task(struct rpc_task *task);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700257
Trond Myklebust44c28872006-01-03 09:55:06 +0100258static inline int rpc_wait_for_completion_task(struct rpc_task *task)
259{
260 return __rpc_wait_for_completion_task(task, NULL);
261}
262
Jeff Layton13067292014-11-17 16:58:05 -0500263#if IS_ENABLED(CONFIG_SUNRPC_DEBUG) || IS_ENABLED(CONFIG_TRACEPOINTS)
Trond Myklebust82b0a4c2012-01-20 14:52:23 -0500264static inline const char * rpc_qname(const struct rpc_wait_queue *q)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700265{
266 return ((q && q->name) ? q->name : "unknown");
267}
Trond Myklebust2f09c242012-02-08 22:01:15 -0500268
269static inline void rpc_assign_waitqueue_name(struct rpc_wait_queue *q,
270 const char *name)
271{
272 q->name = name;
273}
274#else
275static inline void rpc_assign_waitqueue_name(struct rpc_wait_queue *q,
276 const char *name)
277{
278}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700279#endif
280
Jeff Layton3c87ef62015-06-03 16:14:25 -0400281#if IS_ENABLED(CONFIG_SUNRPC_SWAP)
282int rpc_clnt_swap_activate(struct rpc_clnt *clnt);
283void rpc_clnt_swap_deactivate(struct rpc_clnt *clnt);
284#else
285static inline int
286rpc_clnt_swap_activate(struct rpc_clnt *clnt)
287{
288 return -EINVAL;
289}
290
291static inline void
292rpc_clnt_swap_deactivate(struct rpc_clnt *clnt)
293{
294}
295#endif /* CONFIG_SUNRPC_SWAP */
296
Linus Torvalds1da177e2005-04-16 15:20:36 -0700297#endif /* _LINUX_SUNRPC_SCHED_H_ */