LXR linux/include/linux/sunrpc/sched.h

   1/* SPDX-License-Identifier: GPL-2.0 */
   2/*
   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>
  14#include <linux/ktime.h>
  15#include <linux/sunrpc/types.h>
  16#include <linux/spinlock.h>
  17#include <linux/wait_bit.h>
  18#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 {
  26        const struct rpc_procinfo *rpc_proc;    /* Procedure information */
  27        void *                  rpc_argp;       /* Arguments */
  28        void *                  rpc_resp;       /* Result */
  29        const struct cred *     rpc_cred;       /* Credentials */
  30};
  31
  32struct rpc_call_ops;
  33struct rpc_wait_queue;
  34struct rpc_wait {
  35        struct list_head        list;           /* wait queue links */
  36        struct list_head        links;          /* Links to related tasks */
  37        struct list_head        timer_list;     /* Timer list */
  38};
  39
  40/*
  41 * This is the RPC task struct
  42 */
  43struct rpc_task {
  44        atomic_t                tk_count;       /* Reference count */
  45        int                     tk_status;      /* result of last operation */
  46        struct list_head        tk_task;        /* global list of tasks */
  47
  48        /*
  49         * callback     to be executed after waking up
  50         * action       next procedure for async tasks
  51         */
  52        void                    (*tk_callback)(struct rpc_task *);
  53        void                    (*tk_action)(struct rpc_task *);
  54
  55        unsigned long           tk_timeout;     /* timeout for rpc_sleep() */
  56        unsigned long           tk_runstate;    /* Task run status */
  57
  58        struct rpc_wait_queue   *tk_waitqueue;  /* RPC wait queue we're on */
  59        union {
  60                struct work_struct      tk_work;        /* Async task work queue */
  61                struct rpc_wait         tk_wait;        /* RPC wait */
  62        } u;
  63
  64        int                     tk_rpc_status;  /* Result of last RPC operation */
  65
  66        /*
  67         * RPC call state
  68         */
  69        struct rpc_message      tk_msg;         /* RPC call info */
  70        void *                  tk_calldata;    /* Caller private data */
  71        const struct rpc_call_ops *tk_ops;      /* Caller callbacks */
  72
  73        struct rpc_clnt *       tk_client;      /* RPC client */
  74        struct rpc_xprt *       tk_xprt;        /* Transport */
  75        struct rpc_cred *       tk_op_cred;     /* cred being operated on */
  76
  77        struct rpc_rqst *       tk_rqstp;       /* RPC request */
  78
  79        struct workqueue_struct *tk_workqueue;  /* Normally rpciod, but could
  80                                                 * be any workqueue
  81                                                 */
  82        ktime_t                 tk_start;       /* RPC task init timestamp */
  83
  84        pid_t                   tk_owner;       /* Process id for batching tasks */
  85        unsigned short          tk_flags;       /* misc flags */
  86        unsigned short          tk_timeouts;    /* maj timeouts */
  87
  88#if IS_ENABLED(CONFIG_SUNRPC_DEBUG) || IS_ENABLED(CONFIG_TRACEPOINTS)
  89        unsigned short          tk_pid;         /* debugging aid */
  90#endif
  91        unsigned char           tk_priority : 2,/* Task priority */
  92                                tk_garb_retry : 2,
  93                                tk_cred_retry : 2,
  94                                tk_rebind_retry : 2;
  95};
  96
  97typedef void                    (*rpc_action)(struct rpc_task *);
  98
  99struct rpc_call_ops {
 100        void (*rpc_call_prepare)(struct rpc_task *, void *);
 101        void (*rpc_call_done)(struct rpc_task *, void *);
 102        void (*rpc_count_stats)(struct rpc_task *, void *);
 103        void (*rpc_release)(void *);
 104};
 105
 106struct rpc_task_setup {
 107        struct rpc_task *task;
 108        struct rpc_clnt *rpc_client;
 109        struct rpc_xprt *rpc_xprt;
 110        struct rpc_cred *rpc_op_cred;   /* credential being operated on */
 111        const struct rpc_message *rpc_message;
 112        const struct rpc_call_ops *callback_ops;
 113        void *callback_data;
 114        struct workqueue_struct *workqueue;
 115        unsigned short flags;
 116        signed char priority;
 117};
 118
 119/*
 120 * RPC task flags
 121 */
 122#define RPC_TASK_ASYNC          0x0001          /* is an async task */
 123#define RPC_TASK_SWAPPER        0x0002          /* is swapping in/out */
 124#define RPC_TASK_MOVEABLE       0x0004          /* nfs4.1+ rpc tasks */
 125#define RPC_TASK_NULLCREDS      0x0010          /* Use AUTH_NULL credential */
 126#define RPC_CALL_MAJORSEEN      0x0020          /* major timeout seen */
 127#define RPC_TASK_ROOTCREDS      0x0040          /* force root creds */
 128#define RPC_TASK_DYNAMIC        0x0080          /* task was kmalloc'ed */
 129#define RPC_TASK_NO_ROUND_ROBIN 0x0100          /* send requests on "main" xprt */
 130#define RPC_TASK_SOFT           0x0200          /* Use soft timeouts */
 131#define RPC_TASK_SOFTCONN       0x0400          /* Fail if can't connect */
 132#define RPC_TASK_SENT           0x0800          /* message was sent */
 133#define RPC_TASK_TIMEOUT        0x1000          /* fail with ETIMEDOUT on timeout */
 134#define RPC_TASK_NOCONNECT      0x2000          /* return ENOTCONN if not connected */
 135#define RPC_TASK_NO_RETRANS_TIMEOUT     0x4000          /* wait forever for a reply */
 136#define RPC_TASK_CRED_NOREF     0x8000          /* No refcount on the credential */
 137
 138#define RPC_IS_ASYNC(t)         ((t)->tk_flags & RPC_TASK_ASYNC)
 139#define RPC_IS_SWAPPER(t)       ((t)->tk_flags & RPC_TASK_SWAPPER)
 140#define RPC_IS_SOFT(t)          ((t)->tk_flags & (RPC_TASK_SOFT|RPC_TASK_TIMEOUT))
 141#define RPC_IS_SOFTCONN(t)      ((t)->tk_flags & RPC_TASK_SOFTCONN)
 142#define RPC_WAS_SENT(t)         ((t)->tk_flags & RPC_TASK_SENT)
 143#define RPC_IS_MOVEABLE(t)      ((t)->tk_flags & RPC_TASK_MOVEABLE)
 144
 145#define RPC_TASK_RUNNING        0
 146#define RPC_TASK_QUEUED         1
 147#define RPC_TASK_ACTIVE         2
 148#define RPC_TASK_NEED_XMIT      3
 149#define RPC_TASK_NEED_RECV      4
 150#define RPC_TASK_MSG_PIN_WAIT   5
 151#define RPC_TASK_SIGNALLED      6
 152
 153#define rpc_test_and_set_running(t) \
 154                                test_and_set_bit(RPC_TASK_RUNNING, &(t)->tk_runstate)
 155#define rpc_clear_running(t)    clear_bit(RPC_TASK_RUNNING, &(t)->tk_runstate)
 156
 157#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)
 159#define rpc_clear_queued(t)     clear_bit(RPC_TASK_QUEUED, &(t)->tk_runstate)
 160
 161#define RPC_IS_ACTIVATED(t)     test_bit(RPC_TASK_ACTIVE, &(t)->tk_runstate)
 162
 163#define RPC_SIGNALLED(t)        test_bit(RPC_TASK_SIGNALLED, &(t)->tk_runstate)
 164
 165/*
 166 * Task priorities.
 167 * Note: if you change these, you must also change
 168 * the task initialization definitions below.
 169 */
 170#define RPC_PRIORITY_LOW        (-1)
 171#define RPC_PRIORITY_NORMAL     (0)
 172#define RPC_PRIORITY_HIGH       (1)
 173#define RPC_PRIORITY_PRIVILEGED (2)
 174#define RPC_NR_PRIORITY         (1 + RPC_PRIORITY_PRIVILEGED - RPC_PRIORITY_LOW)
 175
 176struct rpc_timer {
 177        struct list_head list;
 178        unsigned long expires;
 179        struct delayed_work dwork;
 180};
 181
 182/*
 183 * RPC synchronization objects
 184 */
 185struct rpc_wait_queue {
 186        spinlock_t              lock;
 187        struct list_head        tasks[RPC_NR_PRIORITY]; /* task queue for each priority level */
 188        unsigned char           maxpriority;            /* maximum priority (0 if queue is not a priority queue) */
 189        unsigned char           priority;               /* current priority */
 190        unsigned char           nr;                     /* # tasks remaining for cookie */
 191        unsigned short          qlen;                   /* total # tasks waiting in queue */
 192        struct rpc_timer        timer_list;
 193#if IS_ENABLED(CONFIG_SUNRPC_DEBUG) || IS_ENABLED(CONFIG_TRACEPOINTS)
 194        const char *            name;
 195#endif
 196};
 197
 198/*
 199 * This is the # requests to send consecutively
 200 * from a single cookie.  The aim is to improve
 201 * performance of NFS operations such as read/write.
 202 */
 203#define RPC_IS_PRIORITY(q)              ((q)->maxpriority > 0)
 204
 205/*
 206 * Function prototypes
 207 */
 208struct rpc_task *rpc_new_task(const struct rpc_task_setup *);
 209struct rpc_task *rpc_run_task(const struct rpc_task_setup *);
 210struct rpc_task *rpc_run_bc_task(struct rpc_rqst *req);
 211void            rpc_put_task(struct rpc_task *);
 212void            rpc_put_task_async(struct rpc_task *);
 213void            rpc_signal_task(struct rpc_task *);
 214void            rpc_exit_task(struct rpc_task *);
 215void            rpc_exit(struct rpc_task *, int);
 216void            rpc_release_calldata(const struct rpc_call_ops *, void *);
 217void            rpc_killall_tasks(struct rpc_clnt *);
 218void            rpc_execute(struct rpc_task *);
 219void            rpc_init_priority_wait_queue(struct rpc_wait_queue *, const char *);
 220void            rpc_init_wait_queue(struct rpc_wait_queue *, const char *);
 221void            rpc_destroy_wait_queue(struct rpc_wait_queue *);
 222unsigned long   rpc_task_timeout(const struct rpc_task *task);
 223void            rpc_sleep_on_timeout(struct rpc_wait_queue *queue,
 224                                        struct rpc_task *task,
 225                                        rpc_action action,
 226                                        unsigned long timeout);
 227void            rpc_sleep_on(struct rpc_wait_queue *, struct rpc_task *,
 228                                        rpc_action action);
 229void            rpc_sleep_on_priority_timeout(struct rpc_wait_queue *queue,
 230                                        struct rpc_task *task,
 231                                        unsigned long timeout,
 232                                        int priority);
 233void            rpc_sleep_on_priority(struct rpc_wait_queue *,
 234                                        struct rpc_task *,
 235                                        int priority);
 236void            rpc_wake_up_queued_task(struct rpc_wait_queue *,
 237                                        struct rpc_task *);
 238void            rpc_wake_up_queued_task_set_status(struct rpc_wait_queue *,
 239                                                   struct rpc_task *,
 240                                                   int);
 241void            rpc_wake_up(struct rpc_wait_queue *);
 242struct rpc_task *rpc_wake_up_next(struct rpc_wait_queue *);
 243struct rpc_task *rpc_wake_up_first_on_wq(struct workqueue_struct *wq,
 244                                        struct rpc_wait_queue *,
 245                                        bool (*)(struct rpc_task *, void *),
 246                                        void *);
 247struct rpc_task *rpc_wake_up_first(struct rpc_wait_queue *,
 248                                        bool (*)(struct rpc_task *, void *),
 249                                        void *);
 250void            rpc_wake_up_status(struct rpc_wait_queue *, int);
 251void            rpc_delay(struct rpc_task *, unsigned long);
 252int             rpc_malloc(struct rpc_task *);
 253void            rpc_free(struct rpc_task *);
 254int             rpciod_up(void);
 255void            rpciod_down(void);
 256int             __rpc_wait_for_completion_task(struct rpc_task *task, wait_bit_action_f *);
 257#if IS_ENABLED(CONFIG_SUNRPC_DEBUG)
 258struct net;
 259void            rpc_show_tasks(struct net *);
 260#endif
 261int             rpc_init_mempool(void);
 262void            rpc_destroy_mempool(void);
 263extern struct workqueue_struct *rpciod_workqueue;
 264extern struct workqueue_struct *xprtiod_workqueue;
 265void            rpc_prepare_task(struct rpc_task *task);
 266
 267static inline int rpc_wait_for_completion_task(struct rpc_task *task)
 268{
 269        return __rpc_wait_for_completion_task(task, NULL);
 270}
 271
 272#if IS_ENABLED(CONFIG_SUNRPC_DEBUG) || IS_ENABLED(CONFIG_TRACEPOINTS)
 273static inline const char * rpc_qname(const struct rpc_wait_queue *q)
 274{
 275        return ((q && q->name) ? q->name : "unknown");
 276}
 277
 278static inline void rpc_assign_waitqueue_name(struct rpc_wait_queue *q,
 279                const char *name)
 280{
 281        q->name = name;
 282}
 283#else
 284static inline void rpc_assign_waitqueue_name(struct rpc_wait_queue *q,
 285                const char *name)
 286{
 287}
 288#endif
 289
 290#if IS_ENABLED(CONFIG_SUNRPC_SWAP)
 291int rpc_clnt_swap_activate(struct rpc_clnt *clnt);
 292void rpc_clnt_swap_deactivate(struct rpc_clnt *clnt);
 293#else
 294static inline int
 295rpc_clnt_swap_activate(struct rpc_clnt *clnt)
 296{
 297        return -EINVAL;
 298}
 299
 300static inline void
 301rpc_clnt_swap_deactivate(struct rpc_clnt *clnt)
 302{
 303}
 304#endif /* CONFIG_SUNRPC_SWAP */
 305
 306#endif /* _LINUX_SUNRPC_SCHED_H_ */
 307