include/linux/sunrpc/xprt.h

   1 /*
   2  *  linux/include/linux/sunrpc/xprt.h
   3  *
   4  *  Declarations for the RPC transport interface.
   5  *
   6  *  Copyright (C) 1995, 1996 Olaf Kirch <okir@monad.swb.de>
   7  */
   8
   9 #ifndef _LINUX_SUNRPC_XPRT_H
  10 #define _LINUX_SUNRPC_XPRT_H
  11
  12 #include <linux/uio.h>
  13 #include <linux/socket.h>
  14 #include <linux/in.h>
  15 #include <linux/kref.h>
  16 #include <linux/sunrpc/sched.h>
  17 #include <linux/sunrpc/xdr.h>
  18 #include <linux/sunrpc/msg_prot.h>
  19
  20 #ifdef __KERNEL__
  21
  22 extern unsigned int xprt_udp_slot_table_entries;
  23 extern unsigned int xprt_tcp_slot_table_entries;
  24
  25 #define RPC_MIN_SLOT_TABLE      (2U)
  26 #define RPC_DEF_SLOT_TABLE      (16U)
  27 #define RPC_MAX_SLOT_TABLE      (128U)
  28
  29 /*
  30  * Parameters for choosing a free port
  31  */
  32 extern unsigned int xprt_min_resvport;
  33 extern unsigned int xprt_max_resvport;
  34
  35 #define RPC_MIN_RESVPORT        (1U)
  36 #define RPC_MAX_RESVPORT        (65535U)
  37 #define RPC_DEF_MIN_RESVPORT    (665U)
  38 #define RPC_DEF_MAX_RESVPORT    (1023U)
  39
  40 /*
  41  * This describes a timeout strategy
  42  */
  43 struct rpc_timeout {
  44         unsigned long           to_initval,             /* initial timeout */
  45                                 to_maxval,              /* max timeout */
  46                                 to_increment;           /* if !exponential */
  47         unsigned int            to_retries;             /* max # of retries */
  48         unsigned char           to_exponential;
  49 };
  50
  51 enum rpc_display_format_t {
  52         RPC_DISPLAY_ADDR = 0,
  53         RPC_DISPLAY_PORT,
  54         RPC_DISPLAY_PROTO,
  55         RPC_DISPLAY_ALL,
  56         RPC_DISPLAY_MAX,
  57 };
  58
  59 struct rpc_task;
  60 struct rpc_xprt;
  61 struct seq_file;
  62
  63 /*
  64  * This describes a complete RPC request
  65  */
  66 struct rpc_rqst {
  67         /*
  68          * This is the user-visible part
  69          */
  70         struct rpc_xprt *       rq_xprt;                /* RPC client */
  71         struct xdr_buf          rq_snd_buf;             /* send buffer */
  72         struct xdr_buf          rq_rcv_buf;             /* recv buffer */
  73
  74         /*
  75          * This is the private part
  76          */
  77         struct rpc_task *       rq_task;        /* RPC task data */
  78         __be32                  rq_xid;         /* request XID */
  79         int                     rq_cong;        /* has incremented xprt->cong */
  80         int                     rq_received;    /* receive completed */
  81         u32                     rq_seqno;       /* gss seq no. used on req. */
  82         int                     rq_enc_pages_num;
  83         struct page             **rq_enc_pages; /* scratch pages for use by
  84                                                    gss privacy code */
  85         void (*rq_release_snd_buf)(struct rpc_rqst *); /* release rq_enc_pages */
  86         struct list_head        rq_list;
  87
  88         __u32 *                 rq_buffer;      /* XDR encode buffer */
  89         size_t                  rq_bufsize,
  90                                 rq_callsize,
  91                                 rq_rcvsize;
  92
  93         struct xdr_buf          rq_private_buf;         /* The receive buffer
  94                                                          * used in the softirq.
  95                                                          */
  96         unsigned long           rq_majortimeo;  /* major timeout alarm */
  97         unsigned long           rq_timeout;     /* Current timeout value */
  98         unsigned int            rq_retries;     /* # of retries */
  99
 100         /*
 101          * Partial send handling
 102          */
 103         u32                     rq_bytes_sent;  /* Bytes we have sent */
 104
 105         unsigned long           rq_xtime;       /* when transmitted */
 106         int                     rq_ntrans;
 107 };
 108 #define rq_svec                 rq_snd_buf.head
 109 #define rq_slen                 rq_snd_buf.len
 110
 111 struct rpc_xprt_ops {
 112         void            (*set_buffer_size)(struct rpc_xprt *xprt, size_t sndsize, size_t rcvsize);
 113         int             (*reserve_xprt)(struct rpc_task *task);
 114         void            (*release_xprt)(struct rpc_xprt *xprt, struct rpc_task *task);
 115         void            (*rpcbind)(struct rpc_task *task);
 116         void            (*set_port)(struct rpc_xprt *xprt, unsigned short port);
 117         void            (*connect)(struct rpc_task *task);
 118         void *          (*buf_alloc)(struct rpc_task *task, size_t size);
 119         void            (*buf_free)(void *buffer);
 120         int             (*send_request)(struct rpc_task *task);
 121         void            (*set_retrans_timeout)(struct rpc_task *task);
 122         void            (*timer)(struct rpc_task *task);
 123         void            (*release_request)(struct rpc_task *task);
 124         void            (*close)(struct rpc_xprt *xprt);
 125         void            (*destroy)(struct rpc_xprt *xprt);
 126         void            (*print_stats)(struct rpc_xprt *xprt, struct seq_file *seq);
 127 };
 128
 129 struct rpc_xprt {
 130         struct kref             kref;           /* Reference count */
 131         struct rpc_xprt_ops *   ops;            /* transport methods */
 132
 133         struct rpc_timeout      timeout;        /* timeout parms */
 134         struct sockaddr_storage addr;           /* server address */
 135         size_t                  addrlen;        /* size of server address */
 136         int                     prot;           /* IP protocol */
 137
 138         unsigned long           cong;           /* current congestion */
 139         unsigned long           cwnd;           /* congestion window */
 140
 141         size_t                  max_payload;    /* largest RPC payload size,
 142                                                    in bytes */
 143         unsigned int            tsh_size;       /* size of transport specific
 144                                                    header */
 145
 146         struct rpc_wait_queue   binding;        /* requests waiting on rpcbind */
 147         struct rpc_wait_queue   sending;        /* requests waiting to send */
 148         struct rpc_wait_queue   resend;         /* requests waiting to resend */
 149         struct rpc_wait_queue   pending;        /* requests in flight */
 150         struct rpc_wait_queue   backlog;        /* waiting for slot */
 151         struct list_head        free;           /* free slots */
 152         struct rpc_rqst *       slot;           /* slot table storage */
 153         unsigned int            max_reqs;       /* total slots */
 154         unsigned long           state;          /* transport state */
 155         unsigned char           shutdown   : 1, /* being shut down */
 156                                 resvport   : 1; /* use a reserved port */
 157         unsigned int            bind_index;     /* bind function index */
 158
 159         /*
 160          * Connection of transports
 161          */
 162         unsigned long           connect_timeout,
 163                                 bind_timeout,
 164                                 reestablish_timeout;
 165
 166         /*
 167          * Disconnection of idle transports
 168          */
 169         struct work_struct      task_cleanup;
 170         struct timer_list       timer;
 171         unsigned long           last_used,
 172                                 idle_timeout;
 173
 174         /*
 175          * Send stuff
 176          */
 177         spinlock_t              transport_lock; /* lock transport info */
 178         spinlock_t              reserve_lock;   /* lock slot table */
 179         u32                     xid;            /* Next XID value to use */
 180         struct rpc_task *       snd_task;       /* Task blocked in send */
 181         struct list_head        recv;
 182
 183         struct {
 184                 unsigned long           bind_count,     /* total number of binds */
 185                                         connect_count,  /* total number of connects */
 186                                         connect_start,  /* connect start timestamp */
 187                                         connect_time,   /* jiffies waiting for connect */
 188                                         sends,          /* how many complete requests */
 189                                         recvs,          /* how many complete requests */
 190                                         bad_xids;       /* lookup_rqst didn't find XID */
 191
 192                 unsigned long long      req_u,          /* average requests on the wire */
 193                                         bklog_u;        /* backlog queue utilization */
 194         } stat;
 195
 196         char *                  address_strings[RPC_DISPLAY_MAX];
 197 };
 198
 199 struct rpc_xprtsock_create {
 200         int                     proto;          /* IPPROTO_UDP or IPPROTO_TCP */
 201         struct sockaddr *       srcaddr;        /* optional local address */
 202         struct sockaddr *       dstaddr;        /* remote peer address */
 203         size_t                  addrlen;
 204         struct rpc_timeout *    timeout;        /* optional timeout parameters */
 205 };
 206
 207 /*
 208  * Transport operations used by ULPs
 209  */
 210 void                    xprt_set_timeout(struct rpc_timeout *to, unsigned int retr, unsigned long incr);
 211
 212 /*
 213  * Generic internal transport functions
 214  */
 215 struct rpc_xprt *       xprt_create_transport(struct rpc_xprtsock_create *args);
 216 void                    xprt_connect(struct rpc_task *task);
 217 void                    xprt_reserve(struct rpc_task *task);
 218 int                     xprt_reserve_xprt(struct rpc_task *task);
 219 int                     xprt_reserve_xprt_cong(struct rpc_task *task);
 220 int                     xprt_prepare_transmit(struct rpc_task *task);
 221 void                    xprt_transmit(struct rpc_task *task);
 222 void                    xprt_end_transmit(struct rpc_task *task);
 223 int                     xprt_adjust_timeout(struct rpc_rqst *req);
 224 void                    xprt_release_xprt(struct rpc_xprt *xprt, struct rpc_task *task);
 225 void                    xprt_release_xprt_cong(struct rpc_xprt *xprt, struct rpc_task *task);
 226 void                    xprt_release(struct rpc_task *task);
 227 struct rpc_xprt *       xprt_get(struct rpc_xprt *xprt);
 228 void                    xprt_put(struct rpc_xprt *xprt);
 229
 230 static inline __be32 *xprt_skip_transport_header(struct rpc_xprt *xprt, __be32 *p)
 231 {
 232         return p + xprt->tsh_size;
 233 }
 234
 235 /*
 236  * Transport switch helper functions
 237  */
 238 void                    xprt_set_retrans_timeout_def(struct rpc_task *task);
 239 void                    xprt_set_retrans_timeout_rtt(struct rpc_task *task);
 240 void                    xprt_wake_pending_tasks(struct rpc_xprt *xprt, int status);
 241 void                    xprt_wait_for_buffer_space(struct rpc_task *task);
 242 void                    xprt_write_space(struct rpc_xprt *xprt);
 243 void                    xprt_update_rtt(struct rpc_task *task);
 244 void                    xprt_adjust_cwnd(struct rpc_task *task, int result);
 245 struct rpc_rqst *       xprt_lookup_rqst(struct rpc_xprt *xprt, __be32 xid);
 246 void                    xprt_complete_rqst(struct rpc_task *task, int copied);
 247 void                    xprt_release_rqst_cong(struct rpc_task *task);
 248 void                    xprt_disconnect(struct rpc_xprt *xprt);
 249
 250 /*
 251  * Socket transport setup operations
 252  */
 253 struct rpc_xprt *       xs_setup_udp(struct rpc_xprtsock_create *args);
 254 struct rpc_xprt *       xs_setup_tcp(struct rpc_xprtsock_create *args);
 255 int                     init_socket_xprt(void);
 256 void                    cleanup_socket_xprt(void);
 257
 258 /*
 259  * Reserved bit positions in xprt->state
 260  */
 261 #define XPRT_LOCKED             (0)
 262 #define XPRT_CONNECTED          (1)
 263 #define XPRT_CONNECTING         (2)
 264 #define XPRT_CLOSE_WAIT         (3)
 265 #define XPRT_BOUND              (4)
 266 #define XPRT_BINDING            (5)
 267
 268 static inline void xprt_set_connected(struct rpc_xprt *xprt)
 269 {
 270         set_bit(XPRT_CONNECTED, &xprt->state);
 271 }
 272
 273 static inline void xprt_clear_connected(struct rpc_xprt *xprt)
 274 {
 275         clear_bit(XPRT_CONNECTED, &xprt->state);
 276 }
 277
 278 static inline int xprt_connected(struct rpc_xprt *xprt)
 279 {
 280         return test_bit(XPRT_CONNECTED, &xprt->state);
 281 }
 282
 283 static inline int xprt_test_and_set_connected(struct rpc_xprt *xprt)
 284 {
 285         return test_and_set_bit(XPRT_CONNECTED, &xprt->state);
 286 }
 287
 288 static inline int xprt_test_and_clear_connected(struct rpc_xprt *xprt)
 289 {
 290         return test_and_clear_bit(XPRT_CONNECTED, &xprt->state);
 291 }
 292
 293 static inline void xprt_clear_connecting(struct rpc_xprt *xprt)
 294 {
 295         smp_mb__before_clear_bit();
 296         clear_bit(XPRT_CONNECTING, &xprt->state);
 297         smp_mb__after_clear_bit();
 298 }
 299
 300 static inline int xprt_connecting(struct rpc_xprt *xprt)
 301 {
 302         return test_bit(XPRT_CONNECTING, &xprt->state);
 303 }
 304
 305 static inline int xprt_test_and_set_connecting(struct rpc_xprt *xprt)
 306 {
 307         return test_and_set_bit(XPRT_CONNECTING, &xprt->state);
 308 }
 309
 310 static inline void xprt_set_bound(struct rpc_xprt *xprt)
 311 {
 312         test_and_set_bit(XPRT_BOUND, &xprt->state);
 313 }
 314
 315 static inline int xprt_bound(struct rpc_xprt *xprt)
 316 {
 317         return test_bit(XPRT_BOUND, &xprt->state);
 318 }
 319
 320 static inline void xprt_clear_bound(struct rpc_xprt *xprt)
 321 {
 322         clear_bit(XPRT_BOUND, &xprt->state);
 323 }
 324
 325 static inline void xprt_clear_binding(struct rpc_xprt *xprt)
 326 {
 327         smp_mb__before_clear_bit();
 328         clear_bit(XPRT_BINDING, &xprt->state);
 329         smp_mb__after_clear_bit();
 330 }
 331
 332 static inline int xprt_test_and_set_binding(struct rpc_xprt *xprt)
 333 {
 334         return test_and_set_bit(XPRT_BINDING, &xprt->state);
 335 }
 336
 337 #endif /* __KERNEL__*/
 338
 339 #endif /* _LINUX_SUNRPC_XPRT_H */