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    (650U)
  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 struct rpc_task;
  55 struct rpc_xprt;
  56
  57 /*
  58  * This describes a complete RPC request
  59  */
  60 struct rpc_rqst {
  61         /*
  62          * This is the user-visible part
  63          */
  64         struct rpc_xprt *       rq_xprt;                /* RPC client */
  65         struct xdr_buf          rq_snd_buf;             /* send buffer */
  66         struct xdr_buf          rq_rcv_buf;             /* recv buffer */
  67
  68         /*
  69          * This is the private part
  70          */
  71         struct rpc_task *       rq_task;        /* RPC task data */
  72         __u32                   rq_xid;         /* request XID */
  73         int                     rq_cong;        /* has incremented xprt->cong */
  74         int                     rq_received;    /* receive completed */
  75         u32                     rq_seqno;       /* gss seq no. used on req. */
  76
  77         struct list_head        rq_list;
  78
  79         struct xdr_buf          rq_private_buf;         /* The receive buffer
  80                                                          * used in the softirq.
  81                                                          */
  82         unsigned long           rq_majortimeo;  /* major timeout alarm */
  83         unsigned long           rq_timeout;     /* Current timeout value */
  84         unsigned int            rq_retries;     /* # of retries */
  85         /*
  86          * For authentication (e.g. auth_des)
  87          */
  88         u32                     rq_creddata[2];
  89
  90         /*
  91          * Partial send handling
  92          */
  93
  94         u32                     rq_bytes_sent;  /* Bytes we have sent */
  95
  96         unsigned long           rq_xtime;       /* when transmitted */
  97         int                     rq_ntrans;
  98 };
  99 #define rq_svec                 rq_snd_buf.head
 100 #define rq_slen                 rq_snd_buf.len
 101
 102 struct rpc_xprt_ops {
 103         void            (*set_buffer_size)(struct rpc_xprt *xprt);
 104         int             (*reserve_xprt)(struct rpc_task *task);
 105         void            (*release_xprt)(struct rpc_xprt *xprt, struct rpc_task *task);
 106         void            (*connect)(struct rpc_task *task);
 107         int             (*send_request)(struct rpc_task *task);
 108         void            (*set_retrans_timeout)(struct rpc_task *task);
 109         void            (*timer)(struct rpc_task *task);
 110         void            (*release_request)(struct rpc_task *task);
 111         void            (*close)(struct rpc_xprt *xprt);
 112         void            (*destroy)(struct rpc_xprt *xprt);
 113 };
 114
 115 struct rpc_xprt {
 116         struct rpc_xprt_ops *   ops;            /* transport methods */
 117         struct socket *         sock;           /* BSD socket layer */
 118         struct sock *           inet;           /* INET layer */
 119
 120         struct rpc_timeout      timeout;        /* timeout parms */
 121         struct sockaddr_in      addr;           /* server address */
 122         int                     prot;           /* IP protocol */
 123
 124         unsigned long           cong;           /* current congestion */
 125         unsigned long           cwnd;           /* congestion window */
 126
 127         unsigned int            rcvsize,        /* transport rcv buffer size */
 128                                 sndsize;        /* transport send buffer size */
 129
 130         size_t                  max_payload;    /* largest RPC payload size,
 131                                                    in bytes */
 132         unsigned int            tsh_size;       /* size of transport specific
 133                                                    header */
 134
 135         struct rpc_wait_queue   sending;        /* requests waiting to send */
 136         struct rpc_wait_queue   resend;         /* requests waiting to resend */
 137         struct rpc_wait_queue   pending;        /* requests in flight */
 138         struct rpc_wait_queue   backlog;        /* waiting for slot */
 139         struct list_head        free;           /* free slots */
 140         struct rpc_rqst *       slot;           /* slot table storage */
 141         unsigned int            max_reqs;       /* total slots */
 142         unsigned long           state;          /* transport state */
 143         unsigned char           shutdown   : 1, /* being shut down */
 144                                 resvport   : 1; /* use a reserved port */
 145
 146         /*
 147          * XID
 148          */
 149         __u32                   xid;            /* Next XID value to use */
 150
 151         /*
 152          * State of TCP reply receive stuff
 153          */
 154         u32                     tcp_recm,       /* Fragment header */
 155                                 tcp_xid,        /* Current XID */
 156                                 tcp_reclen,     /* fragment length */
 157                                 tcp_offset;     /* fragment offset */
 158         unsigned long           tcp_copied,     /* copied to request */
 159                                 tcp_flags;
 160         /*
 161          * Connection of transports
 162          */
 163         unsigned long           connect_timeout,
 164                                 bind_timeout,
 165                                 reestablish_timeout;
 166         struct work_struct      connect_worker;
 167         unsigned short          port;
 168
 169         /*
 170          * Disconnection of idle transports
 171          */
 172         struct work_struct      task_cleanup;
 173         struct timer_list       timer;
 174         unsigned long           last_used,
 175                                 idle_timeout;
 176
 177         /*
 178          * Send stuff
 179          */
 180         spinlock_t              transport_lock; /* lock transport info */
 181         spinlock_t              reserve_lock;   /* lock slot table */
 182         struct rpc_task *       snd_task;       /* Task blocked in send */
 183
 184         struct list_head        recv;
 185
 186
 187         void                    (*old_data_ready)(struct sock *, int);
 188         void                    (*old_state_change)(struct sock *);
 189         void                    (*old_write_space)(struct sock *);
 190 };
 191
 192 #define XPRT_LAST_FRAG          (1 << 0)
 193 #define XPRT_COPY_RECM          (1 << 1)
 194 #define XPRT_COPY_XID           (1 << 2)
 195 #define XPRT_COPY_DATA          (1 << 3)
 196
 197 #ifdef __KERNEL__
 198
 199 /*
 200  * Transport operations used by ULPs
 201  */
 202 struct rpc_xprt *       xprt_create_proto(int proto, struct sockaddr_in *addr, struct rpc_timeout *to);
 203 void                    xprt_set_timeout(struct rpc_timeout *to, unsigned int retr, unsigned long incr);
 204
 205 /*
 206  * Generic internal transport functions
 207  */
 208 void                    xprt_connect(struct rpc_task *task);
 209 void                    xprt_reserve(struct rpc_task *task);
 210 int                     xprt_reserve_xprt(struct rpc_task *task);
 211 int                     xprt_reserve_xprt_cong(struct rpc_task *task);
 212 int                     xprt_prepare_transmit(struct rpc_task *task);
 213 void                    xprt_transmit(struct rpc_task *task);
 214 int                     xprt_adjust_timeout(struct rpc_rqst *req);
 215 void                    xprt_release_xprt(struct rpc_xprt *xprt, struct rpc_task *task);
 216 void                    xprt_release_xprt_cong(struct rpc_xprt *xprt, struct rpc_task *task);
 217 void                    xprt_release(struct rpc_task *task);
 218 int                     xprt_destroy(struct rpc_xprt *xprt);
 219
 220 static inline u32 *xprt_skip_transport_header(struct rpc_xprt *xprt, u32 *p)
 221 {
 222         return p + xprt->tsh_size;
 223 }
 224
 225 /*
 226  * Transport switch helper functions
 227  */
 228 void                    xprt_set_retrans_timeout_def(struct rpc_task *task);
 229 void                    xprt_set_retrans_timeout_rtt(struct rpc_task *task);
 230 void                    xprt_wake_pending_tasks(struct rpc_xprt *xprt, int status);
 231 void                    xprt_wait_for_buffer_space(struct rpc_task *task);
 232 void                    xprt_write_space(struct rpc_xprt *xprt);
 233 void                    xprt_update_rtt(struct rpc_task *task);
 234 void                    xprt_adjust_cwnd(struct rpc_task *task, int result);
 235 struct rpc_rqst *       xprt_lookup_rqst(struct rpc_xprt *xprt, u32 xid);
 236 void                    xprt_complete_rqst(struct rpc_task *task, int copied);
 237 void                    xprt_release_rqst_cong(struct rpc_task *task);
 238 void                    xprt_disconnect(struct rpc_xprt *xprt);
 239
 240 /*
 241  * Socket transport setup operations
 242  */
 243 int                     xs_setup_udp(struct rpc_xprt *xprt, struct rpc_timeout *to);
 244 int                     xs_setup_tcp(struct rpc_xprt *xprt, struct rpc_timeout *to);
 245
 246 /*
 247  * Reserved bit positions in xprt->state
 248  */
 249 #define XPRT_LOCKED             (0)
 250 #define XPRT_CONNECTED          (1)
 251 #define XPRT_CONNECTING         (2)
 252
 253 static inline void xprt_set_connected(struct rpc_xprt *xprt)
 254 {
 255         set_bit(XPRT_CONNECTED, &xprt->state);
 256 }
 257
 258 static inline void xprt_clear_connected(struct rpc_xprt *xprt)
 259 {
 260         clear_bit(XPRT_CONNECTED, &xprt->state);
 261 }
 262
 263 static inline int xprt_connected(struct rpc_xprt *xprt)
 264 {
 265         return test_bit(XPRT_CONNECTED, &xprt->state);
 266 }
 267
 268 static inline int xprt_test_and_set_connected(struct rpc_xprt *xprt)
 269 {
 270         return test_and_set_bit(XPRT_CONNECTED, &xprt->state);
 271 }
 272
 273 static inline int xprt_test_and_clear_connected(struct rpc_xprt *xprt)
 274 {
 275         return test_and_clear_bit(XPRT_CONNECTED, &xprt->state);
 276 }
 277
 278 static inline void xprt_clear_connecting(struct rpc_xprt *xprt)
 279 {
 280         smp_mb__before_clear_bit();
 281         clear_bit(XPRT_CONNECTING, &xprt->state);
 282         smp_mb__after_clear_bit();
 283 }
 284
 285 static inline int xprt_connecting(struct rpc_xprt *xprt)
 286 {
 287         return test_bit(XPRT_CONNECTING, &xprt->state);
 288 }
 289
 290 static inline int xprt_test_and_set_connecting(struct rpc_xprt *xprt)
 291 {
 292         return test_and_set_bit(XPRT_CONNECTING, &xprt->state);
 293 }
 294
 295 #endif /* __KERNEL__*/
 296
 297 #endif /* _LINUX_SUNRPC_XPRT_H */