SAFE public projects git trees. - safe/jmp/linux-2.6/blob - include/linux/sunrpc/sched.h

   1 /*
   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>
  14 #include <linux/rcupdate.h>
  15 #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  */
  23 struct rpc_procinfo;
  24 struct 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
  31 struct rpc_call_ops;
  32 struct rpc_wait_queue;
  33 struct rpc_wait {
  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;
  38 };
  39
  40 /*
  41  * This is the RPC task struct
  42  */
  43 struct rpc_task {
  44 #ifdef RPC_DEBUG
  45         unsigned long           tk_magic;       /* 0xf00baa */
  46 #endif
  47         atomic_t                tk_count;       /* Reference count */
  48         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 */
  57         __u8                    tk_garb_retry;
  58         __u8                    tk_cred_retry;
  59
  60         /*
  61          * callback     to be executed after waking up
  62          * action       next procedure for async tasks
  63          * tk_ops       caller callbacks
  64          */
  65         void                    (*tk_callback)(struct rpc_task *);
  66         void                    (*tk_action)(struct rpc_task *);
  67         const struct rpc_call_ops *tk_ops;
  68         void *                  tk_calldata;
  69
  70         unsigned long           tk_timeout;     /* timeout for rpc_sleep() */
  71         unsigned short          tk_flags;       /* misc flags */
  72         unsigned long           tk_runstate;    /* Task run status */
  73         struct workqueue_struct *tk_workqueue;  /* Normally rpciod, but could
  74                                                  * be any workqueue
  75                                                  */
  76         struct rpc_wait_queue   *tk_waitqueue;  /* RPC wait queue we're on */
  77         union {
  78                 struct work_struct      tk_work;        /* Async task work queue */
  79                 struct rpc_wait         tk_wait;        /* RPC wait */
  80                 struct rcu_head         tk_rcu;         /* for task deletion */
  81         } u;
  82
  83         unsigned short          tk_timeouts;    /* maj timeouts */
  84         size_t                  tk_bytes_sent;  /* total bytes sent */
  85         unsigned long           tk_start;       /* RPC task init timestamp */
  86         long                    tk_rtt;         /* round-trip time (jiffies) */
  87
  88         pid_t                   tk_owner;       /* Process id for batching tasks */
  89         unsigned char           tk_priority : 2;/* Task priority */
  90
  91 #ifdef RPC_DEBUG
  92         unsigned short          tk_pid;         /* debugging aid */
  93 #endif
  94 };
  95 #define tk_xprt                 tk_client->cl_xprt
  96
  97 /* support walking a list of tasks on a wait queue */
  98 #define task_for_each(task, pos, head) \
  99         list_for_each(pos, head) \
 100                 if ((task=list_entry(pos, struct rpc_task, u.tk_wait.list)),1)
 101
 102 #define task_for_first(task, head) \
 103         if (!list_empty(head) &&  \
 104             ((task=list_entry((head)->next, struct rpc_task, u.tk_wait.list)),1))
 105
 106 typedef void                    (*rpc_action)(struct rpc_task *);
 107
 108 struct rpc_call_ops {
 109         void (*rpc_call_prepare)(struct rpc_task *, void *);
 110         void (*rpc_call_done)(struct rpc_task *, void *);
 111         void (*rpc_release)(void *);
 112 };
 113
 114 struct rpc_task_setup {
 115         struct rpc_task *task;
 116         struct rpc_clnt *rpc_client;
 117         const struct rpc_message *rpc_message;
 118         const struct rpc_call_ops *callback_ops;
 119         void *callback_data;
 120         struct workqueue_struct *workqueue;
 121         unsigned short flags;
 122         signed char priority;
 123 };
 124
 125 /*
 126  * RPC task flags
 127  */
 128 #define RPC_TASK_ASYNC          0x0001          /* is an async task */
 129 #define RPC_TASK_SWAPPER        0x0002          /* is swapping in/out */
 130 #define RPC_CALL_MAJORSEEN      0x0020          /* major timeout seen */
 131 #define RPC_TASK_ROOTCREDS      0x0040          /* force root creds */
 132 #define RPC_TASK_DYNAMIC        0x0080          /* task was kmalloc'ed */
 133 #define RPC_TASK_KILLED         0x0100          /* task was killed */
 134 #define RPC_TASK_SOFT           0x0200          /* Use soft timeouts */
 135
 136 #define RPC_IS_ASYNC(t)         ((t)->tk_flags & RPC_TASK_ASYNC)
 137 #define RPC_IS_SWAPPER(t)       ((t)->tk_flags & RPC_TASK_SWAPPER)
 138 #define RPC_DO_ROOTOVERRIDE(t)  ((t)->tk_flags & RPC_TASK_ROOTCREDS)
 139 #define RPC_ASSASSINATED(t)     ((t)->tk_flags & RPC_TASK_KILLED)
 140 #define RPC_DO_CALLBACK(t)      ((t)->tk_callback != NULL)
 141 #define RPC_IS_SOFT(t)          ((t)->tk_flags & RPC_TASK_SOFT)
 142
 143 #define RPC_TASK_RUNNING        0
 144 #define RPC_TASK_QUEUED         1
 145 #define RPC_TASK_WAKEUP         2
 146 #define RPC_TASK_ACTIVE         3
 147
 148 #define RPC_IS_RUNNING(t)       test_bit(RPC_TASK_RUNNING, &(t)->tk_runstate)
 149 #define rpc_set_running(t)      set_bit(RPC_TASK_RUNNING, &(t)->tk_runstate)
 150 #define rpc_test_and_set_running(t) \
 151                                 test_and_set_bit(RPC_TASK_RUNNING, &(t)->tk_runstate)
 152 #define rpc_clear_running(t)    \
 153         do { \
 154                 smp_mb__before_clear_bit(); \
 155                 clear_bit(RPC_TASK_RUNNING, &(t)->tk_runstate); \
 156                 smp_mb__after_clear_bit(); \
 157         } while (0)
 158
 159 #define RPC_IS_QUEUED(t)        test_bit(RPC_TASK_QUEUED, &(t)->tk_runstate)
 160 #define rpc_set_queued(t)       set_bit(RPC_TASK_QUEUED, &(t)->tk_runstate)
 161 #define rpc_clear_queued(t)     \
 162         do { \
 163                 smp_mb__before_clear_bit(); \
 164                 clear_bit(RPC_TASK_QUEUED, &(t)->tk_runstate); \
 165                 smp_mb__after_clear_bit(); \
 166         } while (0)
 167
 168 #define rpc_start_wakeup(t) \
 169         (test_and_set_bit(RPC_TASK_WAKEUP, &(t)->tk_runstate) == 0)
 170 #define rpc_finish_wakeup(t) \
 171         do { \
 172                 smp_mb__before_clear_bit(); \
 173                 clear_bit(RPC_TASK_WAKEUP, &(t)->tk_runstate); \
 174                 smp_mb__after_clear_bit(); \
 175         } while (0)
 176
 177 #define RPC_IS_ACTIVATED(t)     test_bit(RPC_TASK_ACTIVE, &(t)->tk_runstate)
 178
 179 /*
 180  * Task priorities.
 181  * Note: if you change these, you must also change
 182  * the task initialization definitions below.
 183  */
 184 #define RPC_PRIORITY_LOW        (-1)
 185 #define RPC_PRIORITY_NORMAL     (0)
 186 #define RPC_PRIORITY_HIGH       (1)
 187 #define RPC_NR_PRIORITY         (1 + RPC_PRIORITY_HIGH - RPC_PRIORITY_LOW)
 188
 189 struct rpc_timer {
 190         struct timer_list timer;
 191         struct list_head list;
 192         unsigned long expires;
 193 };
 194
 195 /*
 196  * RPC synchronization objects
 197  */
 198 struct rpc_wait_queue {
 199         spinlock_t              lock;
 200         struct list_head        tasks[RPC_NR_PRIORITY]; /* task queue for each priority level */
 201         pid_t                   owner;                  /* process id of last task serviced */
 202         unsigned char           maxpriority;            /* maximum priority (0 if queue is not a priority queue) */
 203         unsigned char           priority;               /* current priority */
 204         unsigned char           count;                  /* # task groups remaining serviced so far */
 205         unsigned char           nr;                     /* # tasks remaining for cookie */
 206         unsigned short          qlen;                   /* total # tasks waiting in queue */
 207         struct rpc_timer        timer_list;
 208 #ifdef RPC_DEBUG
 209         const char *            name;
 210 #endif
 211 };
 212
 213 /*
 214  * This is the # requests to send consecutively
 215  * from a single cookie.  The aim is to improve
 216  * performance of NFS operations such as read/write.
 217  */
 218 #define RPC_BATCH_COUNT                 16
 219 #define RPC_IS_PRIORITY(q)              ((q)->maxpriority > 0)
 220
 221 /*
 222  * Function prototypes
 223  */
 224 struct rpc_task *rpc_new_task(const struct rpc_task_setup *);
 225 struct rpc_task *rpc_run_task(const struct rpc_task_setup *);
 226 void            rpc_put_task(struct rpc_task *);
 227 void            rpc_exit_task(struct rpc_task *);
 228 void            rpc_release_calldata(const struct rpc_call_ops *, void *);
 229 void            rpc_killall_tasks(struct rpc_clnt *);
 230 void            rpc_execute(struct rpc_task *);
 231 void            rpc_init_priority_wait_queue(struct rpc_wait_queue *, const char *);
 232 void            rpc_init_wait_queue(struct rpc_wait_queue *, const char *);
 233 void            rpc_destroy_wait_queue(struct rpc_wait_queue *);
 234 void            rpc_sleep_on(struct rpc_wait_queue *, struct rpc_task *,
 235                                         rpc_action action);
 236 void            rpc_wake_up_queued_task(struct rpc_wait_queue *,
 237                                         struct rpc_task *);
 238 void            rpc_wake_up(struct rpc_wait_queue *);
 239 struct rpc_task *rpc_wake_up_next(struct rpc_wait_queue *);
 240 void            rpc_wake_up_status(struct rpc_wait_queue *, int);
 241 void            rpc_delay(struct rpc_task *, unsigned long);
 242 void *          rpc_malloc(struct rpc_task *, size_t);
 243 void            rpc_free(void *);
 244 int             rpciod_up(void);
 245 void            rpciod_down(void);
 246 int             __rpc_wait_for_completion_task(struct rpc_task *task, int (*)(void *));
 247 #ifdef RPC_DEBUG
 248 void            rpc_show_tasks(void);
 249 #endif
 250 int             rpc_init_mempool(void);
 251 void            rpc_destroy_mempool(void);
 252 extern struct workqueue_struct *rpciod_workqueue;
 253
 254 static inline void rpc_exit(struct rpc_task *task, int status)
 255 {
 256         task->tk_status = status;
 257         task->tk_action = rpc_exit_task;
 258 }
 259
 260 static inline int rpc_wait_for_completion_task(struct rpc_task *task)
 261 {
 262         return __rpc_wait_for_completion_task(task, NULL);
 263 }
 264
 265 #ifdef RPC_DEBUG
 266 static inline const char * rpc_qname(struct rpc_wait_queue *q)
 267 {
 268         return ((q && q->name) ? q->name : "unknown");
 269 }
 270 #endif
 271
 272 #endif /* _LINUX_SUNRPC_SCHED_H_ */