Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 1 | /* |
Chuck Lever | 55aa4f5 | 2005-08-11 16:25:47 -0400 | [diff] [blame] | 2 | * linux/include/linux/sunrpc/xprt.h |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 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 | /* |
| 19 | * The transport code maintains an estimate on the maximum number of out- |
| 20 | * standing RPC requests, using a smoothed version of the congestion |
| 21 | * avoidance implemented in 44BSD. This is basically the Van Jacobson |
| 22 | * congestion algorithm: If a retransmit occurs, the congestion window is |
| 23 | * halved; otherwise, it is incremented by 1/cwnd when |
| 24 | * |
| 25 | * - a reply is received and |
| 26 | * - a full number of requests are outstanding and |
| 27 | * - the congestion window hasn't been updated recently. |
| 28 | * |
| 29 | * Upper procedures may check whether a request would block waiting for |
| 30 | * a free RPC slot by using the RPC_CONGESTED() macro. |
| 31 | */ |
| 32 | extern unsigned int xprt_udp_slot_table_entries; |
| 33 | extern unsigned int xprt_tcp_slot_table_entries; |
| 34 | |
| 35 | #define RPC_MIN_SLOT_TABLE (2U) |
| 36 | #define RPC_DEF_SLOT_TABLE (16U) |
| 37 | #define RPC_MAX_SLOT_TABLE (128U) |
| 38 | |
| 39 | #define RPC_CWNDSHIFT (8U) |
| 40 | #define RPC_CWNDSCALE (1U << RPC_CWNDSHIFT) |
| 41 | #define RPC_INITCWND RPC_CWNDSCALE |
| 42 | #define RPC_MAXCWND(xprt) ((xprt)->max_reqs << RPC_CWNDSHIFT) |
| 43 | #define RPCXPRT_CONGESTED(xprt) ((xprt)->cong >= (xprt)->cwnd) |
| 44 | |
| 45 | /* Default timeout values */ |
| 46 | #define RPC_MAX_UDP_TIMEOUT (60*HZ) |
| 47 | #define RPC_MAX_TCP_TIMEOUT (600*HZ) |
| 48 | |
| 49 | /* |
| 50 | * Wait duration for an RPC TCP connection to be established. Solaris |
| 51 | * NFS over TCP uses 60 seconds, for example, which is in line with how |
| 52 | * long a server takes to reboot. |
| 53 | */ |
| 54 | #define RPC_CONNECT_TIMEOUT (60*HZ) |
| 55 | |
| 56 | /* |
| 57 | * Delay an arbitrary number of seconds before attempting to reconnect |
| 58 | * after an error. |
| 59 | */ |
| 60 | #define RPC_REESTABLISH_TIMEOUT (15*HZ) |
| 61 | |
Chuck Lever | a246b01 | 2005-08-11 16:25:23 -0400 | [diff] [blame] | 62 | /* |
| 63 | * RPC transport idle timeout. |
| 64 | */ |
| 65 | #define RPC_IDLE_DISCONNECT_TIMEOUT (5*60*HZ) |
| 66 | |
| 67 | /* |
| 68 | * RPC call and reply header size as number of 32bit words (verifier |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 69 | * size computed separately) |
| 70 | */ |
| 71 | #define RPC_CALLHDRSIZE 6 |
| 72 | #define RPC_REPHDRSIZE 4 |
| 73 | |
| 74 | /* |
| 75 | * This describes a timeout strategy |
| 76 | */ |
| 77 | struct rpc_timeout { |
| 78 | unsigned long to_initval, /* initial timeout */ |
| 79 | to_maxval, /* max timeout */ |
| 80 | to_increment; /* if !exponential */ |
| 81 | unsigned int to_retries; /* max # of retries */ |
| 82 | unsigned char to_exponential; |
| 83 | }; |
| 84 | |
| 85 | /* |
| 86 | * This describes a complete RPC request |
| 87 | */ |
| 88 | struct rpc_rqst { |
| 89 | /* |
| 90 | * This is the user-visible part |
| 91 | */ |
| 92 | struct rpc_xprt * rq_xprt; /* RPC client */ |
| 93 | struct xdr_buf rq_snd_buf; /* send buffer */ |
| 94 | struct xdr_buf rq_rcv_buf; /* recv buffer */ |
| 95 | |
| 96 | /* |
| 97 | * This is the private part |
| 98 | */ |
| 99 | struct rpc_task * rq_task; /* RPC task data */ |
| 100 | __u32 rq_xid; /* request XID */ |
| 101 | int rq_cong; /* has incremented xprt->cong */ |
| 102 | int rq_received; /* receive completed */ |
| 103 | u32 rq_seqno; /* gss seq no. used on req. */ |
| 104 | |
| 105 | struct list_head rq_list; |
| 106 | |
| 107 | struct xdr_buf rq_private_buf; /* The receive buffer |
| 108 | * used in the softirq. |
| 109 | */ |
| 110 | unsigned long rq_majortimeo; /* major timeout alarm */ |
| 111 | unsigned long rq_timeout; /* Current timeout value */ |
| 112 | unsigned int rq_retries; /* # of retries */ |
| 113 | /* |
| 114 | * For authentication (e.g. auth_des) |
| 115 | */ |
| 116 | u32 rq_creddata[2]; |
| 117 | |
| 118 | /* |
| 119 | * Partial send handling |
| 120 | */ |
| 121 | |
| 122 | u32 rq_bytes_sent; /* Bytes we have sent */ |
| 123 | |
| 124 | unsigned long rq_xtime; /* when transmitted */ |
| 125 | int rq_ntrans; |
| 126 | }; |
| 127 | #define rq_svec rq_snd_buf.head |
| 128 | #define rq_slen rq_snd_buf.len |
| 129 | |
Chuck Lever | a246b01 | 2005-08-11 16:25:23 -0400 | [diff] [blame] | 130 | struct rpc_task; |
| 131 | struct rpc_xprt; |
| 132 | |
| 133 | struct rpc_xprt_ops { |
| 134 | void (*set_buffer_size)(struct rpc_xprt *xprt); |
Chuck Lever | 12a8046 | 2005-08-25 16:25:51 -0700 | [diff] [blame] | 135 | int (*reserve_xprt)(struct rpc_task *task); |
Chuck Lever | 49e9a89 | 2005-08-25 16:25:51 -0700 | [diff] [blame] | 136 | void (*release_xprt)(struct rpc_xprt *xprt, struct rpc_task *task); |
Chuck Lever | a246b01 | 2005-08-11 16:25:23 -0400 | [diff] [blame] | 137 | void (*connect)(struct rpc_task *task); |
| 138 | int (*send_request)(struct rpc_task *task); |
Chuck Lever | fe3aca2 | 2005-08-25 16:25:50 -0700 | [diff] [blame] | 139 | void (*set_retrans_timeout)(struct rpc_task *task); |
Chuck Lever | 46c0ee8 | 2005-08-25 16:25:52 -0700 | [diff] [blame^] | 140 | void (*timer)(struct rpc_task *task); |
Chuck Lever | a246b01 | 2005-08-11 16:25:23 -0400 | [diff] [blame] | 141 | void (*close)(struct rpc_xprt *xprt); |
| 142 | void (*destroy)(struct rpc_xprt *xprt); |
| 143 | }; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 144 | |
| 145 | struct rpc_xprt { |
Chuck Lever | a246b01 | 2005-08-11 16:25:23 -0400 | [diff] [blame] | 146 | struct rpc_xprt_ops * ops; /* transport methods */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 147 | struct socket * sock; /* BSD socket layer */ |
| 148 | struct sock * inet; /* INET layer */ |
| 149 | |
| 150 | struct rpc_timeout timeout; /* timeout parms */ |
| 151 | struct sockaddr_in addr; /* server address */ |
| 152 | int prot; /* IP protocol */ |
| 153 | |
| 154 | unsigned long cong; /* current congestion */ |
| 155 | unsigned long cwnd; /* congestion window */ |
| 156 | |
Chuck Lever | 55aa4f5 | 2005-08-11 16:25:47 -0400 | [diff] [blame] | 157 | unsigned int rcvsize, /* transport rcv buffer size */ |
| 158 | sndsize; /* transport send buffer size */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 159 | |
| 160 | size_t max_payload; /* largest RPC payload size, |
| 161 | in bytes */ |
Chuck Lever | 808012f | 2005-08-25 16:25:49 -0700 | [diff] [blame] | 162 | unsigned int tsh_size; /* size of transport specific |
| 163 | header */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 164 | |
| 165 | struct rpc_wait_queue sending; /* requests waiting to send */ |
| 166 | struct rpc_wait_queue resend; /* requests waiting to resend */ |
| 167 | struct rpc_wait_queue pending; /* requests in flight */ |
| 168 | struct rpc_wait_queue backlog; /* waiting for slot */ |
| 169 | struct list_head free; /* free slots */ |
| 170 | struct rpc_rqst * slot; /* slot table storage */ |
| 171 | unsigned int max_reqs; /* total slots */ |
Chuck Lever | 2226feb | 2005-08-11 16:25:38 -0400 | [diff] [blame] | 172 | unsigned long state; /* transport state */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 173 | unsigned char shutdown : 1, /* being shut down */ |
| 174 | nocong : 1, /* no congestion control */ |
Chuck Lever | 43118c2 | 2005-08-25 16:25:49 -0700 | [diff] [blame] | 175 | resvport : 1; /* use a reserved port */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 176 | |
| 177 | /* |
| 178 | * XID |
| 179 | */ |
| 180 | __u32 xid; /* Next XID value to use */ |
| 181 | |
| 182 | /* |
| 183 | * State of TCP reply receive stuff |
| 184 | */ |
| 185 | u32 tcp_recm, /* Fragment header */ |
| 186 | tcp_xid, /* Current XID */ |
| 187 | tcp_reclen, /* fragment length */ |
| 188 | tcp_offset; /* fragment offset */ |
| 189 | unsigned long tcp_copied, /* copied to request */ |
| 190 | tcp_flags; |
| 191 | /* |
Chuck Lever | 55aa4f5 | 2005-08-11 16:25:47 -0400 | [diff] [blame] | 192 | * Connection of transports |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 193 | */ |
Chuck Lever | 55aa4f5 | 2005-08-11 16:25:47 -0400 | [diff] [blame] | 194 | struct work_struct connect_worker; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 195 | unsigned short port; |
| 196 | /* |
Chuck Lever | 55aa4f5 | 2005-08-11 16:25:47 -0400 | [diff] [blame] | 197 | * Disconnection of idle transports |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 198 | */ |
| 199 | struct work_struct task_cleanup; |
| 200 | struct timer_list timer; |
| 201 | unsigned long last_used; |
| 202 | |
| 203 | /* |
| 204 | * Send stuff |
| 205 | */ |
Chuck Lever | 4a0f8c0 | 2005-08-11 16:25:32 -0400 | [diff] [blame] | 206 | spinlock_t transport_lock; /* lock transport info */ |
Chuck Lever | 5dc0772 | 2005-08-11 16:25:35 -0400 | [diff] [blame] | 207 | spinlock_t reserve_lock; /* lock slot table */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 208 | struct rpc_task * snd_task; /* Task blocked in send */ |
| 209 | |
| 210 | struct list_head recv; |
| 211 | |
| 212 | |
| 213 | void (*old_data_ready)(struct sock *, int); |
| 214 | void (*old_state_change)(struct sock *); |
| 215 | void (*old_write_space)(struct sock *); |
| 216 | |
| 217 | wait_queue_head_t cong_wait; |
| 218 | }; |
| 219 | |
Chuck Lever | a246b01 | 2005-08-11 16:25:23 -0400 | [diff] [blame] | 220 | #define XPRT_LAST_FRAG (1 << 0) |
| 221 | #define XPRT_COPY_RECM (1 << 1) |
| 222 | #define XPRT_COPY_XID (1 << 2) |
| 223 | #define XPRT_COPY_DATA (1 << 3) |
| 224 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 225 | #ifdef __KERNEL__ |
| 226 | |
Chuck Lever | 55aa4f5 | 2005-08-11 16:25:47 -0400 | [diff] [blame] | 227 | /* |
| 228 | * Transport operations used by ULPs |
| 229 | */ |
| 230 | struct rpc_xprt * xprt_create_proto(int proto, struct sockaddr_in *addr, struct rpc_timeout *to); |
| 231 | void xprt_set_timeout(struct rpc_timeout *to, unsigned int retr, unsigned long incr); |
| 232 | |
| 233 | /* |
| 234 | * Generic internal transport functions |
| 235 | */ |
| 236 | void xprt_connect(struct rpc_task *task); |
| 237 | void xprt_reserve(struct rpc_task *task); |
Chuck Lever | 12a8046 | 2005-08-25 16:25:51 -0700 | [diff] [blame] | 238 | int xprt_reserve_xprt(struct rpc_task *task); |
| 239 | int xprt_reserve_xprt_cong(struct rpc_task *task); |
Chuck Lever | 55aa4f5 | 2005-08-11 16:25:47 -0400 | [diff] [blame] | 240 | int xprt_prepare_transmit(struct rpc_task *task); |
| 241 | void xprt_transmit(struct rpc_task *task); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 242 | int xprt_adjust_timeout(struct rpc_rqst *req); |
Chuck Lever | 49e9a89 | 2005-08-25 16:25:51 -0700 | [diff] [blame] | 243 | void xprt_release_xprt(struct rpc_xprt *xprt, struct rpc_task *task); |
| 244 | void xprt_release_xprt_cong(struct rpc_xprt *xprt, struct rpc_task *task); |
Chuck Lever | 55aa4f5 | 2005-08-11 16:25:47 -0400 | [diff] [blame] | 245 | void xprt_release(struct rpc_task *task); |
| 246 | int xprt_destroy(struct rpc_xprt *xprt); |
| 247 | |
Chuck Lever | 808012f | 2005-08-25 16:25:49 -0700 | [diff] [blame] | 248 | static inline u32 *xprt_skip_transport_header(struct rpc_xprt *xprt, u32 *p) |
| 249 | { |
| 250 | return p + xprt->tsh_size; |
| 251 | } |
| 252 | |
Chuck Lever | 55aa4f5 | 2005-08-11 16:25:47 -0400 | [diff] [blame] | 253 | /* |
| 254 | * Transport switch helper functions |
| 255 | */ |
Chuck Lever | fe3aca2 | 2005-08-25 16:25:50 -0700 | [diff] [blame] | 256 | void xprt_set_retrans_timeout_def(struct rpc_task *task); |
| 257 | void xprt_set_retrans_timeout_rtt(struct rpc_task *task); |
Chuck Lever | 55aa4f5 | 2005-08-11 16:25:47 -0400 | [diff] [blame] | 258 | void xprt_wake_pending_tasks(struct rpc_xprt *xprt, int status); |
Chuck Lever | c7b2cae | 2005-08-11 16:25:50 -0400 | [diff] [blame] | 259 | void xprt_wait_for_buffer_space(struct rpc_task *task); |
| 260 | void xprt_write_space(struct rpc_xprt *xprt); |
Chuck Lever | 46c0ee8 | 2005-08-25 16:25:52 -0700 | [diff] [blame^] | 261 | void xprt_adjust_cwnd(struct rpc_task *task, int result); |
Chuck Lever | 55aa4f5 | 2005-08-11 16:25:47 -0400 | [diff] [blame] | 262 | struct rpc_rqst * xprt_lookup_rqst(struct rpc_xprt *xprt, u32 xid); |
| 263 | void xprt_complete_rqst(struct rpc_xprt *xprt, struct rpc_rqst *req, int copied); |
| 264 | void xprt_disconnect(struct rpc_xprt *xprt); |
| 265 | |
| 266 | /* |
| 267 | * Socket transport setup operations |
| 268 | */ |
| 269 | int xs_setup_udp(struct rpc_xprt *xprt, struct rpc_timeout *to); |
| 270 | int xs_setup_tcp(struct rpc_xprt *xprt, struct rpc_timeout *to); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 271 | |
Chuck Lever | 2226feb | 2005-08-11 16:25:38 -0400 | [diff] [blame] | 272 | /* |
| 273 | * Reserved bit positions in xprt->state |
| 274 | */ |
| 275 | #define XPRT_LOCKED (0) |
| 276 | #define XPRT_CONNECTED (1) |
| 277 | #define XPRT_CONNECTING (2) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 278 | |
Chuck Lever | 2226feb | 2005-08-11 16:25:38 -0400 | [diff] [blame] | 279 | static inline void xprt_set_connected(struct rpc_xprt *xprt) |
| 280 | { |
| 281 | set_bit(XPRT_CONNECTED, &xprt->state); |
| 282 | } |
| 283 | |
| 284 | static inline void xprt_clear_connected(struct rpc_xprt *xprt) |
| 285 | { |
| 286 | clear_bit(XPRT_CONNECTED, &xprt->state); |
| 287 | } |
| 288 | |
| 289 | static inline int xprt_connected(struct rpc_xprt *xprt) |
| 290 | { |
| 291 | return test_bit(XPRT_CONNECTED, &xprt->state); |
| 292 | } |
| 293 | |
| 294 | static inline int xprt_test_and_set_connected(struct rpc_xprt *xprt) |
| 295 | { |
| 296 | return test_and_set_bit(XPRT_CONNECTED, &xprt->state); |
| 297 | } |
| 298 | |
| 299 | static inline int xprt_test_and_clear_connected(struct rpc_xprt *xprt) |
| 300 | { |
| 301 | return test_and_clear_bit(XPRT_CONNECTED, &xprt->state); |
| 302 | } |
| 303 | |
| 304 | static inline void xprt_clear_connecting(struct rpc_xprt *xprt) |
| 305 | { |
| 306 | smp_mb__before_clear_bit(); |
| 307 | clear_bit(XPRT_CONNECTING, &xprt->state); |
| 308 | smp_mb__after_clear_bit(); |
| 309 | } |
| 310 | |
| 311 | static inline int xprt_connecting(struct rpc_xprt *xprt) |
| 312 | { |
| 313 | return test_bit(XPRT_CONNECTING, &xprt->state); |
| 314 | } |
| 315 | |
| 316 | static inline int xprt_test_and_set_connecting(struct rpc_xprt *xprt) |
| 317 | { |
| 318 | return test_and_set_bit(XPRT_CONNECTING, &xprt->state); |
| 319 | } |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 320 | |
| 321 | #endif /* __KERNEL__*/ |
| 322 | |
| 323 | #endif /* _LINUX_SUNRPC_XPRT_H */ |