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