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