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