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/ktime.h>
  17 #include <linux/sunrpc/sched.h>
  18 #include <linux/sunrpc/xdr.h>
  19 #include <linux/sunrpc/msg_prot.h>
  20
  21 #ifdef __KERNEL__
  22
  23 #define RPC_MIN_SLOT_TABLE      (2U)
  24 #define RPC_DEF_SLOT_TABLE      (16U)
  25 #define RPC_MAX_SLOT_TABLE      (128U)
  26
  27 /*
  28  * This describes a timeout strategy
  29  */
  30 struct rpc_timeout {
  31         unsigned long           to_initval,             /* initial timeout */
  32                                 to_maxval,              /* max timeout */
  33                                 to_increment;           /* if !exponential */
  34         unsigned int            to_retries;             /* max # of retries */
  35         unsigned char           to_exponential;
  36 };
  37
  38 enum rpc_display_format_t {
  39         RPC_DISPLAY_ADDR = 0,
  40         RPC_DISPLAY_PORT,
  41         RPC_DISPLAY_PROTO,
  42         RPC_DISPLAY_HEX_ADDR,
  43         RPC_DISPLAY_HEX_PORT,
  44         RPC_DISPLAY_NETID,
  45         RPC_DISPLAY_MAX,
  46 };
  47
  48 struct rpc_task;
  49 struct rpc_xprt;
  50 struct seq_file;
  51
  52 /*
  53  * This describes a complete RPC request
  54  */
  55 struct rpc_rqst {
  56         /*
  57          * This is the user-visible part
  58          */
  59         struct rpc_xprt *       rq_xprt;                /* RPC client */
  60         struct xdr_buf          rq_snd_buf;             /* send buffer */
  61         struct xdr_buf          rq_rcv_buf;             /* recv buffer */
  62
  63         /*
  64          * This is the private part
  65          */
  66         struct rpc_task *       rq_task;        /* RPC task data */
  67         __be32                  rq_xid;         /* request XID */
  68         int                     rq_cong;        /* has incremented xprt->cong */
  69         int                     rq_reply_bytes_recvd;   /* number of reply */
  70                                                         /* bytes received */
  71         u32                     rq_seqno;       /* gss seq no. used on req. */
  72         int                     rq_enc_pages_num;
  73         struct page             **rq_enc_pages; /* scratch pages for use by
  74                                                    gss privacy code */
  75         void (*rq_release_snd_buf)(struct rpc_rqst *); /* release rq_enc_pages */
  76         struct list_head        rq_list;
  77
  78         __u32 *                 rq_buffer;      /* XDR encode buffer */
  79         size_t                  rq_callsize,
  80                                 rq_rcvsize;
  81
  82         struct xdr_buf          rq_private_buf;         /* The receive buffer
  83                                                          * used in the softirq.
  84                                                          */
  85         unsigned long           rq_majortimeo;  /* major timeout alarm */
  86         unsigned long           rq_timeout;     /* Current timeout value */
  87         unsigned int            rq_retries;     /* # of retries */
  88         unsigned int            rq_connect_cookie;
  89                                                 /* A cookie used to track the
  90                                                    state of the transport
  91                                                    connection */
  92
  93         /*
  94          * Partial send handling
  95          */
  96         u32                     rq_bytes_sent;  /* Bytes we have sent */
  97
  98         ktime_t                 rq_xtime;       /* transmit time stamp */
  99         int                     rq_ntrans;
 100
 101 #if defined(CONFIG_NFS_V4_1)
 102         struct list_head        rq_bc_list;     /* Callback service list */
 103         unsigned long           rq_bc_pa_state; /* Backchannel prealloc state */
 104         struct list_head        rq_bc_pa_list;  /* Backchannel prealloc list */
 105 #endif /* CONFIG_NFS_V4_1 */
 106 };
 107 #define rq_svec                 rq_snd_buf.head
 108 #define rq_slen                 rq_snd_buf.len
 109
 110 struct rpc_xprt_ops {
 111         void            (*set_buffer_size)(struct rpc_xprt *xprt, size_t sndsize, size_t rcvsize);
 112         int             (*reserve_xprt)(struct rpc_task *task);
 113         void            (*release_xprt)(struct rpc_xprt *xprt, struct rpc_task *task);
 114         void            (*rpcbind)(struct rpc_task *task);
 115         void            (*set_port)(struct rpc_xprt *xprt, unsigned short port);
 116         void            (*connect)(struct rpc_task *task);
 117         void *          (*buf_alloc)(struct rpc_task *task, size_t size);
 118         void            (*buf_free)(void *buffer);
 119         int             (*send_request)(struct rpc_task *task);
 120         void            (*set_retrans_timeout)(struct rpc_task *task);
 121         void            (*timer)(struct rpc_task *task);
 122         void            (*release_request)(struct rpc_task *task);
 123         void            (*close)(struct rpc_xprt *xprt);
 124         void            (*destroy)(struct rpc_xprt *xprt);
 125         void            (*print_stats)(struct rpc_xprt *xprt, struct seq_file *seq);
 126 };
 127
 128 /*
 129  * RPC transport identifiers
 130  *
 131  * To preserve compatibility with the historical use of raw IP protocol
 132  * id's for transport selection, UDP and TCP identifiers are specified
 133  * with the previous values. No such restriction exists for new transports,
 134  * except that they may not collide with these values (17 and 6,
 135  * respectively).
 136  */
 137 #define XPRT_TRANSPORT_BC       (1 << 31)
 138 enum xprt_transports {
 139         XPRT_TRANSPORT_UDP      = IPPROTO_UDP,
 140         XPRT_TRANSPORT_TCP      = IPPROTO_TCP,
 141         XPRT_TRANSPORT_BC_TCP   = IPPROTO_TCP | XPRT_TRANSPORT_BC,
 142         XPRT_TRANSPORT_RDMA     = 256
 143 };
 144
 145 struct rpc_xprt {
 146         struct kref             kref;           /* Reference count */
 147         struct rpc_xprt_ops *   ops;            /* transport methods */
 148
 149         const struct rpc_timeout *timeout;      /* timeout parms */
 150         struct sockaddr_storage addr;           /* server address */
 151         size_t                  addrlen;        /* size of server address */
 152         int                     prot;           /* IP protocol */
 153
 154         unsigned long           cong;           /* current congestion */
 155         unsigned long           cwnd;           /* congestion window */
 156
 157         size_t                  max_payload;    /* largest RPC payload size,
 158                                                    in bytes */
 159         unsigned int            tsh_size;       /* size of transport specific
 160                                                    header */
 161
 162         struct rpc_wait_queue   binding;        /* requests waiting on rpcbind */
 163         struct rpc_wait_queue   sending;        /* requests waiting to send */
 164         struct rpc_wait_queue   resend;         /* requests waiting to resend */
 165         struct rpc_wait_queue   pending;        /* requests in flight */
 166         struct rpc_wait_queue   backlog;        /* waiting for slot */
 167         struct list_head        free;           /* free slots */
 168         struct rpc_rqst *       slot;           /* slot table storage */
 169         unsigned int            max_reqs;       /* total slots */
 170         unsigned long           state;          /* transport state */
 171         unsigned char           shutdown   : 1, /* being shut down */
 172                                 resvport   : 1; /* use a reserved port */
 173         unsigned int            bind_index;     /* bind function index */
 174
 175         /*
 176          * Connection of transports
 177          */
 178         unsigned long           bind_timeout,
 179                                 reestablish_timeout;
 180         unsigned int            connect_cookie; /* A cookie that gets bumped
 181                                                    every time the transport
 182                                                    is reconnected */
 183
 184         /*
 185          * Disconnection of idle transports
 186          */
 187         struct work_struct      task_cleanup;
 188         struct timer_list       timer;
 189         unsigned long           last_used,
 190                                 idle_timeout;
 191
 192         /*
 193          * Send stuff
 194          */
 195         spinlock_t              transport_lock; /* lock transport info */
 196         spinlock_t              reserve_lock;   /* lock slot table */
 197         u32                     xid;            /* Next XID value to use */
 198         struct rpc_task *       snd_task;       /* Task blocked in send */
 199         struct svc_xprt         *bc_xprt;       /* NFSv4.1 backchannel */
 200 #if defined(CONFIG_NFS_V4_1)
 201         struct svc_serv         *bc_serv;       /* The RPC service which will */
 202                                                 /* process the callback */
 203         unsigned int            bc_alloc_count; /* Total number of preallocs */
 204         spinlock_t              bc_pa_lock;     /* Protects the preallocated
 205                                                  * items */
 206         struct list_head        bc_pa_list;     /* List of preallocated
 207                                                  * backchannel rpc_rqst's */
 208 #endif /* CONFIG_NFS_V4_1 */
 209         struct list_head        recv;
 210
 211         struct {
 212                 unsigned long           bind_count,     /* total number of binds */
 213                                         connect_count,  /* total number of connects */
 214                                         connect_start,  /* connect start timestamp */
 215                                         connect_time,   /* jiffies waiting for connect */
 216                                         sends,          /* how many complete requests */
 217                                         recvs,          /* how many complete requests */
 218                                         bad_xids;       /* lookup_rqst didn't find XID */
 219
 220                 unsigned long long      req_u,          /* average requests on the wire */
 221                                         bklog_u;        /* backlog queue utilization */
 222         } stat;
 223
 224         const char              *address_strings[RPC_DISPLAY_MAX];
 225 };
 226
 227 #if defined(CONFIG_NFS_V4_1)
 228 /*
 229  * Backchannel flags
 230  */
 231 #define RPC_BC_PA_IN_USE        0x0001          /* Preallocated backchannel */
 232                                                 /* buffer in use */
 233 #endif /* CONFIG_NFS_V4_1 */
 234
 235 #if defined(CONFIG_NFS_V4_1)
 236 static inline int bc_prealloc(struct rpc_rqst *req)
 237 {
 238         return test_bit(RPC_BC_PA_IN_USE, &req->rq_bc_pa_state);
 239 }
 240 #else
 241 static inline int bc_prealloc(struct rpc_rqst *req)
 242 {
 243         return 0;
 244 }
 245 #endif /* CONFIG_NFS_V4_1 */
 246
 247 struct xprt_create {
 248         int                     ident;          /* XPRT_TRANSPORT identifier */
 249         struct sockaddr *       srcaddr;        /* optional local address */
 250         struct sockaddr *       dstaddr;        /* remote peer address */
 251         size_t                  addrlen;
 252         struct svc_xprt         *bc_xprt;       /* NFSv4.1 backchannel */
 253 };
 254
 255 struct xprt_class {
 256         struct list_head        list;
 257         int                     ident;          /* XPRT_TRANSPORT identifier */
 258         struct rpc_xprt *       (*setup)(struct xprt_create *);
 259         struct module           *owner;
 260         char                    name[32];
 261 };
 262
 263 /*
 264  * Generic internal transport functions
 265  */
 266 struct rpc_xprt         *xprt_create_transport(struct xprt_create *args);
 267 void                    xprt_connect(struct rpc_task *task);
 268 void                    xprt_reserve(struct rpc_task *task);
 269 int                     xprt_reserve_xprt(struct rpc_task *task);
 270 int                     xprt_reserve_xprt_cong(struct rpc_task *task);
 271 int                     xprt_prepare_transmit(struct rpc_task *task);
 272 void                    xprt_transmit(struct rpc_task *task);
 273 void                    xprt_end_transmit(struct rpc_task *task);
 274 int                     xprt_adjust_timeout(struct rpc_rqst *req);
 275 void                    xprt_release_xprt(struct rpc_xprt *xprt, struct rpc_task *task);
 276 void                    xprt_release_xprt_cong(struct rpc_xprt *xprt, struct rpc_task *task);
 277 void                    xprt_release(struct rpc_task *task);
 278 struct rpc_xprt *       xprt_get(struct rpc_xprt *xprt);
 279 void                    xprt_put(struct rpc_xprt *xprt);
 280
 281 static inline __be32 *xprt_skip_transport_header(struct rpc_xprt *xprt, __be32 *p)
 282 {
 283         return p + xprt->tsh_size;
 284 }
 285
 286 /*
 287  * Transport switch helper functions
 288  */
 289 int                     xprt_register_transport(struct xprt_class *type);
 290 int                     xprt_unregister_transport(struct xprt_class *type);
 291 int                     xprt_load_transport(const char *);
 292 void                    xprt_set_retrans_timeout_def(struct rpc_task *task);
 293 void                    xprt_set_retrans_timeout_rtt(struct rpc_task *task);
 294 void                    xprt_wake_pending_tasks(struct rpc_xprt *xprt, int status);
 295 void                    xprt_wait_for_buffer_space(struct rpc_task *task, rpc_action action);
 296 void                    xprt_write_space(struct rpc_xprt *xprt);
 297 void                    xprt_adjust_cwnd(struct rpc_task *task, int result);
 298 struct rpc_rqst *       xprt_lookup_rqst(struct rpc_xprt *xprt, __be32 xid);
 299 void                    xprt_complete_rqst(struct rpc_task *task, int copied);
 300 void                    xprt_release_rqst_cong(struct rpc_task *task);
 301 void                    xprt_disconnect_done(struct rpc_xprt *xprt);
 302 void                    xprt_force_disconnect(struct rpc_xprt *xprt);
 303 void                    xprt_conditional_disconnect(struct rpc_xprt *xprt, unsigned int cookie);
 304
 305 /*
 306  * Reserved bit positions in xprt->state
 307  */
 308 #define XPRT_LOCKED             (0)
 309 #define XPRT_CONNECTED          (1)
 310 #define XPRT_CONNECTING         (2)
 311 #define XPRT_CLOSE_WAIT         (3)
 312 #define XPRT_BOUND              (4)
 313 #define XPRT_BINDING            (5)
 314 #define XPRT_CLOSING            (6)
 315 #define XPRT_CONNECTION_ABORT   (7)
 316 #define XPRT_CONNECTION_CLOSE   (8)
 317
 318 static inline void xprt_set_connected(struct rpc_xprt *xprt)
 319 {
 320         set_bit(XPRT_CONNECTED, &xprt->state);
 321 }
 322
 323 static inline void xprt_clear_connected(struct rpc_xprt *xprt)
 324 {
 325         clear_bit(XPRT_CONNECTED, &xprt->state);
 326 }
 327
 328 static inline int xprt_connected(struct rpc_xprt *xprt)
 329 {
 330         return test_bit(XPRT_CONNECTED, &xprt->state);
 331 }
 332
 333 static inline int xprt_test_and_set_connected(struct rpc_xprt *xprt)
 334 {
 335         return test_and_set_bit(XPRT_CONNECTED, &xprt->state);
 336 }
 337
 338 static inline int xprt_test_and_clear_connected(struct rpc_xprt *xprt)
 339 {
 340         return test_and_clear_bit(XPRT_CONNECTED, &xprt->state);
 341 }
 342
 343 static inline void xprt_clear_connecting(struct rpc_xprt *xprt)
 344 {
 345         smp_mb__before_clear_bit();
 346         clear_bit(XPRT_CONNECTING, &xprt->state);
 347         smp_mb__after_clear_bit();
 348 }
 349
 350 static inline int xprt_connecting(struct rpc_xprt *xprt)
 351 {
 352         return test_bit(XPRT_CONNECTING, &xprt->state);
 353 }
 354
 355 static inline int xprt_test_and_set_connecting(struct rpc_xprt *xprt)
 356 {
 357         return test_and_set_bit(XPRT_CONNECTING, &xprt->state);
 358 }
 359
 360 static inline void xprt_set_bound(struct rpc_xprt *xprt)
 361 {
 362         test_and_set_bit(XPRT_BOUND, &xprt->state);
 363 }
 364
 365 static inline int xprt_bound(struct rpc_xprt *xprt)
 366 {
 367         return test_bit(XPRT_BOUND, &xprt->state);
 368 }
 369
 370 static inline void xprt_clear_bound(struct rpc_xprt *xprt)
 371 {
 372         clear_bit(XPRT_BOUND, &xprt->state);
 373 }
 374
 375 static inline void xprt_clear_binding(struct rpc_xprt *xprt)
 376 {
 377         smp_mb__before_clear_bit();
 378         clear_bit(XPRT_BINDING, &xprt->state);
 379         smp_mb__after_clear_bit();
 380 }
 381
 382 static inline int xprt_test_and_set_binding(struct rpc_xprt *xprt)
 383 {
 384         return test_and_set_bit(XPRT_BINDING, &xprt->state);
 385 }
 386
 387 #endif /* __KERNEL__*/
 388
 389 #endif /* _LINUX_SUNRPC_XPRT_H */