2 * linux/include/linux/sunrpc/xprt.h
4 * Declarations for the RPC transport interface.
6 * Copyright (C) 1995, 1996 Olaf Kirch <okir@monad.swb.de>
9 #ifndef _LINUX_SUNRPC_XPRT_H
10 #define _LINUX_SUNRPC_XPRT_H
12 #include <linux/uio.h>
13 #include <linux/socket.h>
15 #include <linux/sunrpc/sched.h>
16 #include <linux/sunrpc/xdr.h>
18 extern unsigned int xprt_udp_slot_table_entries;
19 extern unsigned int xprt_tcp_slot_table_entries;
21 #define RPC_MIN_SLOT_TABLE (2U)
22 #define RPC_DEF_SLOT_TABLE (16U)
23 #define RPC_MAX_SLOT_TABLE (128U)
26 * RPC call and reply header size as number of 32bit words (verifier
27 * size computed separately)
29 #define RPC_CALLHDRSIZE 6
30 #define RPC_REPHDRSIZE 4
33 * Parameters for choosing a free port
35 extern unsigned int xprt_min_resvport;
36 extern unsigned int xprt_max_resvport;
38 #define RPC_MIN_RESVPORT (1U)
39 #define RPC_MAX_RESVPORT (65535U)
40 #define RPC_DEF_MIN_RESVPORT (665U)
41 #define RPC_DEF_MAX_RESVPORT (1023U)
44 * This describes a timeout strategy
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;
54 enum rpc_display_format_t {
67 * This describes a complete RPC request
71 * This is the user-visible part
73 struct rpc_xprt * rq_xprt; /* RPC client */
74 struct xdr_buf rq_snd_buf; /* send buffer */
75 struct xdr_buf rq_rcv_buf; /* recv buffer */
78 * This is the private part
80 struct rpc_task * rq_task; /* RPC task data */
81 __u32 rq_xid; /* request XID */
82 int rq_cong; /* has incremented xprt->cong */
83 int rq_received; /* receive completed */
84 u32 rq_seqno; /* gss seq no. used on req. */
86 struct page **rq_enc_pages; /* scratch pages for use by
88 void (*rq_release_snd_buf)(struct rpc_rqst *); /* release rq_enc_pages */
89 struct list_head rq_list;
91 __u32 * rq_buffer; /* XDR encode buffer */
94 struct xdr_buf rq_private_buf; /* The receive buffer
95 * used in the softirq.
97 unsigned long rq_majortimeo; /* major timeout alarm */
98 unsigned long rq_timeout; /* Current timeout value */
99 unsigned int rq_retries; /* # of retries */
102 * Partial send handling
104 u32 rq_bytes_sent; /* Bytes we have sent */
106 unsigned long rq_xtime; /* when transmitted */
109 #define rq_svec rq_snd_buf.head
110 #define rq_slen rq_snd_buf.len
112 struct rpc_xprt_ops {
113 void (*set_buffer_size)(struct rpc_xprt *xprt, size_t sndsize, size_t rcvsize);
114 char * (*print_addr)(struct rpc_xprt *xprt, enum rpc_display_format_t format);
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)(struct rpc_task *task);
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);
132 struct rpc_xprt_ops * ops; /* transport methods */
133 struct socket * sock; /* BSD socket layer */
134 struct sock * inet; /* INET layer */
136 struct rpc_timeout timeout; /* timeout parms */
137 struct sockaddr_in addr; /* server address */
138 int prot; /* IP protocol */
140 unsigned long cong; /* current congestion */
141 unsigned long cwnd; /* congestion window */
143 size_t rcvsize, /* transport rcv buffer size */
144 sndsize; /* transport send buffer size */
146 size_t max_payload; /* largest RPC payload size,
148 unsigned int tsh_size; /* size of transport specific
151 struct rpc_wait_queue binding; /* requests waiting on rpcbind */
152 struct rpc_wait_queue sending; /* requests waiting to send */
153 struct rpc_wait_queue resend; /* requests waiting to resend */
154 struct rpc_wait_queue pending; /* requests in flight */
155 struct rpc_wait_queue backlog; /* waiting for slot */
156 struct list_head free; /* free slots */
157 struct rpc_rqst * slot; /* slot table storage */
158 unsigned int max_reqs; /* total slots */
159 unsigned long state; /* transport state */
160 unsigned char shutdown : 1, /* being shut down */
161 resvport : 1; /* use a reserved port */
166 __u32 xid; /* Next XID value to use */
169 * State of TCP reply receive stuff
171 u32 tcp_recm, /* Fragment header */
172 tcp_xid, /* Current XID */
173 tcp_reclen, /* fragment length */
174 tcp_offset; /* fragment offset */
175 unsigned long tcp_copied, /* copied to request */
178 * Connection of transports
180 unsigned long connect_timeout,
183 struct work_struct connect_worker;
187 * Disconnection of idle transports
189 struct work_struct task_cleanup;
190 struct timer_list timer;
191 unsigned long last_used,
197 spinlock_t transport_lock; /* lock transport info */
198 spinlock_t reserve_lock; /* lock slot table */
199 struct rpc_task * snd_task; /* Task blocked in send */
201 struct list_head recv;
204 unsigned long bind_count, /* total number of binds */
205 connect_count, /* total number of connects */
206 connect_start, /* connect start timestamp */
207 connect_time, /* jiffies waiting for connect */
208 sends, /* how many complete requests */
209 recvs, /* how many complete requests */
210 bad_xids; /* lookup_rqst didn't find XID */
212 unsigned long long req_u, /* average requests on the wire */
213 bklog_u; /* backlog queue utilization */
216 void (*old_data_ready)(struct sock *, int);
217 void (*old_state_change)(struct sock *);
218 void (*old_write_space)(struct sock *);
220 char * address_strings[RPC_DISPLAY_MAX];
223 #define XPRT_LAST_FRAG (1 << 0)
224 #define XPRT_COPY_RECM (1 << 1)
225 #define XPRT_COPY_XID (1 << 2)
226 #define XPRT_COPY_DATA (1 << 3)
231 * Transport operations used by ULPs
233 struct rpc_xprt * xprt_create_proto(int proto, struct sockaddr_in *addr, struct rpc_timeout *to);
234 void xprt_set_timeout(struct rpc_timeout *to, unsigned int retr, unsigned long incr);
237 * Generic internal transport functions
239 void xprt_connect(struct rpc_task *task);
240 void xprt_reserve(struct rpc_task *task);
241 int xprt_reserve_xprt(struct rpc_task *task);
242 int xprt_reserve_xprt_cong(struct rpc_task *task);
243 int xprt_prepare_transmit(struct rpc_task *task);
244 void xprt_transmit(struct rpc_task *task);
245 void xprt_end_transmit(struct rpc_task *task);
246 int xprt_adjust_timeout(struct rpc_rqst *req);
247 void xprt_release_xprt(struct rpc_xprt *xprt, struct rpc_task *task);
248 void xprt_release_xprt_cong(struct rpc_xprt *xprt, struct rpc_task *task);
249 void xprt_release(struct rpc_task *task);
250 int xprt_destroy(struct rpc_xprt *xprt);
252 static inline u32 *xprt_skip_transport_header(struct rpc_xprt *xprt, u32 *p)
254 return p + xprt->tsh_size;
258 * Transport switch helper functions
260 void xprt_set_retrans_timeout_def(struct rpc_task *task);
261 void xprt_set_retrans_timeout_rtt(struct rpc_task *task);
262 void xprt_wake_pending_tasks(struct rpc_xprt *xprt, int status);
263 void xprt_wait_for_buffer_space(struct rpc_task *task);
264 void xprt_write_space(struct rpc_xprt *xprt);
265 void xprt_update_rtt(struct rpc_task *task);
266 void xprt_adjust_cwnd(struct rpc_task *task, int result);
267 struct rpc_rqst * xprt_lookup_rqst(struct rpc_xprt *xprt, u32 xid);
268 void xprt_complete_rqst(struct rpc_task *task, int copied);
269 void xprt_release_rqst_cong(struct rpc_task *task);
270 void xprt_disconnect(struct rpc_xprt *xprt);
273 * Socket transport setup operations
275 int xs_setup_udp(struct rpc_xprt *xprt, struct rpc_timeout *to);
276 int xs_setup_tcp(struct rpc_xprt *xprt, struct rpc_timeout *to);
279 * Reserved bit positions in xprt->state
281 #define XPRT_LOCKED (0)
282 #define XPRT_CONNECTED (1)
283 #define XPRT_CONNECTING (2)
284 #define XPRT_CLOSE_WAIT (3)
285 #define XPRT_BOUND (4)
286 #define XPRT_BINDING (5)
288 static inline void xprt_set_connected(struct rpc_xprt *xprt)
290 set_bit(XPRT_CONNECTED, &xprt->state);
293 static inline void xprt_clear_connected(struct rpc_xprt *xprt)
295 clear_bit(XPRT_CONNECTED, &xprt->state);
298 static inline int xprt_connected(struct rpc_xprt *xprt)
300 return test_bit(XPRT_CONNECTED, &xprt->state);
303 static inline int xprt_test_and_set_connected(struct rpc_xprt *xprt)
305 return test_and_set_bit(XPRT_CONNECTED, &xprt->state);
308 static inline int xprt_test_and_clear_connected(struct rpc_xprt *xprt)
310 return test_and_clear_bit(XPRT_CONNECTED, &xprt->state);
313 static inline void xprt_clear_connecting(struct rpc_xprt *xprt)
315 smp_mb__before_clear_bit();
316 clear_bit(XPRT_CONNECTING, &xprt->state);
317 smp_mb__after_clear_bit();
320 static inline int xprt_connecting(struct rpc_xprt *xprt)
322 return test_bit(XPRT_CONNECTING, &xprt->state);
325 static inline int xprt_test_and_set_connecting(struct rpc_xprt *xprt)
327 return test_and_set_bit(XPRT_CONNECTING, &xprt->state);
330 static inline void xprt_set_bound(struct rpc_xprt *xprt)
332 test_and_set_bit(XPRT_BOUND, &xprt->state);
335 static inline int xprt_bound(struct rpc_xprt *xprt)
337 return test_bit(XPRT_BOUND, &xprt->state);
340 static inline void xprt_clear_bound(struct rpc_xprt *xprt)
342 clear_bit(XPRT_BOUND, &xprt->state);
345 static inline void xprt_clear_binding(struct rpc_xprt *xprt)
347 smp_mb__before_clear_bit();
348 clear_bit(XPRT_BINDING, &xprt->state);
349 smp_mb__after_clear_bit();
352 static inline int xprt_test_and_set_binding(struct rpc_xprt *xprt)
354 return test_and_set_bit(XPRT_BINDING, &xprt->state);
357 #endif /* __KERNEL__*/
359 #endif /* _LINUX_SUNRPC_XPRT_H */