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