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/kref.h>
16 #include <linux/sunrpc/sched.h>
17 #include <linux/sunrpc/xdr.h>
19 extern unsigned int xprt_udp_slot_table_entries;
20 extern unsigned int xprt_tcp_slot_table_entries;
22 #define RPC_MIN_SLOT_TABLE (2U)
23 #define RPC_DEF_SLOT_TABLE (16U)
24 #define RPC_MAX_SLOT_TABLE (128U)
27 * RPC call and reply header size as number of 32bit words (verifier
28 * size computed separately)
30 #define RPC_CALLHDRSIZE 6
31 #define RPC_REPHDRSIZE 4
34 * Parameters for choosing a free port
36 extern unsigned int xprt_min_resvport;
37 extern unsigned int xprt_max_resvport;
39 #define RPC_MIN_RESVPORT (1U)
40 #define RPC_MAX_RESVPORT (65535U)
41 #define RPC_DEF_MIN_RESVPORT (665U)
42 #define RPC_DEF_MAX_RESVPORT (1023U)
45 * This describes a timeout strategy
48 unsigned long to_initval, /* initial timeout */
49 to_maxval, /* max timeout */
50 to_increment; /* if !exponential */
51 unsigned int to_retries; /* max # of retries */
52 unsigned char to_exponential;
55 enum rpc_display_format_t {
68 * This describes a complete RPC request
72 * This is the user-visible part
74 struct rpc_xprt * rq_xprt; /* RPC client */
75 struct xdr_buf rq_snd_buf; /* send buffer */
76 struct xdr_buf rq_rcv_buf; /* recv buffer */
79 * This is the private part
81 struct rpc_task * rq_task; /* RPC task data */
82 __u32 rq_xid; /* request XID */
83 int rq_cong; /* has incremented xprt->cong */
84 int rq_received; /* receive completed */
85 u32 rq_seqno; /* gss seq no. used on req. */
87 struct page **rq_enc_pages; /* scratch pages for use by
89 void (*rq_release_snd_buf)(struct rpc_rqst *); /* release rq_enc_pages */
90 struct list_head rq_list;
92 __u32 * rq_buffer; /* XDR encode buffer */
95 struct xdr_buf rq_private_buf; /* The receive buffer
96 * used in the softirq.
98 unsigned long rq_majortimeo; /* major timeout alarm */
99 unsigned long rq_timeout; /* Current timeout value */
100 unsigned int rq_retries; /* # of retries */
103 * Partial send handling
105 u32 rq_bytes_sent; /* Bytes we have sent */
107 unsigned long rq_xtime; /* when transmitted */
110 #define rq_svec rq_snd_buf.head
111 #define rq_slen rq_snd_buf.len
113 struct rpc_xprt_ops {
114 void (*set_buffer_size)(struct rpc_xprt *xprt, size_t sndsize, size_t rcvsize);
115 char * (*print_addr)(struct rpc_xprt *xprt, enum rpc_display_format_t format);
116 int (*reserve_xprt)(struct rpc_task *task);
117 void (*release_xprt)(struct rpc_xprt *xprt, struct rpc_task *task);
118 void (*rpcbind)(struct rpc_task *task);
119 void (*set_port)(struct rpc_xprt *xprt, unsigned short port);
120 void (*connect)(struct rpc_task *task);
121 void * (*buf_alloc)(struct rpc_task *task, size_t size);
122 void (*buf_free)(struct rpc_task *task);
123 int (*send_request)(struct rpc_task *task);
124 void (*set_retrans_timeout)(struct rpc_task *task);
125 void (*timer)(struct rpc_task *task);
126 void (*release_request)(struct rpc_task *task);
127 void (*close)(struct rpc_xprt *xprt);
128 void (*destroy)(struct rpc_xprt *xprt);
129 void (*print_stats)(struct rpc_xprt *xprt, struct seq_file *seq);
133 struct kref kref; /* Reference count */
134 struct rpc_xprt_ops * ops; /* transport methods */
135 struct socket * sock; /* BSD socket layer */
136 struct sock * inet; /* INET layer */
138 struct rpc_timeout timeout; /* timeout parms */
139 struct sockaddr_storage addr; /* server address */
140 size_t addrlen; /* size of server address */
141 int prot; /* IP protocol */
143 unsigned long cong; /* current congestion */
144 unsigned long cwnd; /* congestion window */
146 size_t rcvsize, /* transport rcv buffer size */
147 sndsize; /* transport send buffer size */
149 size_t max_payload; /* largest RPC payload size,
151 unsigned int tsh_size; /* size of transport specific
154 struct rpc_wait_queue binding; /* requests waiting on rpcbind */
155 struct rpc_wait_queue sending; /* requests waiting to send */
156 struct rpc_wait_queue resend; /* requests waiting to resend */
157 struct rpc_wait_queue pending; /* requests in flight */
158 struct rpc_wait_queue backlog; /* waiting for slot */
159 struct list_head free; /* free slots */
160 struct rpc_rqst * slot; /* slot table storage */
161 unsigned int max_reqs; /* total slots */
162 unsigned long state; /* transport state */
163 unsigned char shutdown : 1, /* being shut down */
164 resvport : 1; /* use a reserved port */
169 __u32 xid; /* Next XID value to use */
172 * State of TCP reply receive stuff
174 u32 tcp_recm, /* Fragment header */
175 tcp_xid, /* Current XID */
176 tcp_reclen, /* fragment length */
177 tcp_offset; /* fragment offset */
178 unsigned long tcp_copied, /* copied to request */
181 * Connection of transports
183 unsigned long connect_timeout,
186 struct work_struct connect_worker;
190 * Disconnection of idle transports
192 struct work_struct task_cleanup;
193 struct timer_list timer;
194 unsigned long last_used,
200 spinlock_t transport_lock; /* lock transport info */
201 spinlock_t reserve_lock; /* lock slot table */
202 struct rpc_task * snd_task; /* Task blocked in send */
204 struct list_head recv;
207 unsigned long bind_count, /* total number of binds */
208 connect_count, /* total number of connects */
209 connect_start, /* connect start timestamp */
210 connect_time, /* jiffies waiting for connect */
211 sends, /* how many complete requests */
212 recvs, /* how many complete requests */
213 bad_xids; /* lookup_rqst didn't find XID */
215 unsigned long long req_u, /* average requests on the wire */
216 bklog_u; /* backlog queue utilization */
219 void (*old_data_ready)(struct sock *, int);
220 void (*old_state_change)(struct sock *);
221 void (*old_write_space)(struct sock *);
223 char * address_strings[RPC_DISPLAY_MAX];
226 #define XPRT_LAST_FRAG (1 << 0)
227 #define XPRT_COPY_RECM (1 << 1)
228 #define XPRT_COPY_XID (1 << 2)
229 #define XPRT_COPY_DATA (1 << 3)
234 * Transport operations used by ULPs
236 void xprt_set_timeout(struct rpc_timeout *to, unsigned int retr, unsigned long incr);
239 * Generic internal transport functions
241 struct rpc_xprt * xprt_create_transport(int proto, struct sockaddr *addr, size_t size, struct rpc_timeout *toparms);
242 void xprt_connect(struct rpc_task *task);
243 void xprt_reserve(struct rpc_task *task);
244 int xprt_reserve_xprt(struct rpc_task *task);
245 int xprt_reserve_xprt_cong(struct rpc_task *task);
246 int xprt_prepare_transmit(struct rpc_task *task);
247 void xprt_transmit(struct rpc_task *task);
248 void xprt_end_transmit(struct rpc_task *task);
249 int xprt_adjust_timeout(struct rpc_rqst *req);
250 void xprt_release_xprt(struct rpc_xprt *xprt, struct rpc_task *task);
251 void xprt_release_xprt_cong(struct rpc_xprt *xprt, struct rpc_task *task);
252 void xprt_release(struct rpc_task *task);
253 struct rpc_xprt * xprt_get(struct rpc_xprt *xprt);
254 void xprt_put(struct rpc_xprt *xprt);
256 static inline u32 *xprt_skip_transport_header(struct rpc_xprt *xprt, u32 *p)
258 return p + xprt->tsh_size;
262 * Transport switch helper functions
264 void xprt_set_retrans_timeout_def(struct rpc_task *task);
265 void xprt_set_retrans_timeout_rtt(struct rpc_task *task);
266 void xprt_wake_pending_tasks(struct rpc_xprt *xprt, int status);
267 void xprt_wait_for_buffer_space(struct rpc_task *task);
268 void xprt_write_space(struct rpc_xprt *xprt);
269 void xprt_update_rtt(struct rpc_task *task);
270 void xprt_adjust_cwnd(struct rpc_task *task, int result);
271 struct rpc_rqst * xprt_lookup_rqst(struct rpc_xprt *xprt, u32 xid);
272 void xprt_complete_rqst(struct rpc_task *task, int copied);
273 void xprt_release_rqst_cong(struct rpc_task *task);
274 void xprt_disconnect(struct rpc_xprt *xprt);
277 * Socket transport setup operations
279 int xs_setup_udp(struct rpc_xprt *xprt, struct rpc_timeout *to);
280 int xs_setup_tcp(struct rpc_xprt *xprt, struct rpc_timeout *to);
283 * Reserved bit positions in xprt->state
285 #define XPRT_LOCKED (0)
286 #define XPRT_CONNECTED (1)
287 #define XPRT_CONNECTING (2)
288 #define XPRT_CLOSE_WAIT (3)
289 #define XPRT_BOUND (4)
290 #define XPRT_BINDING (5)
292 static inline void xprt_set_connected(struct rpc_xprt *xprt)
294 set_bit(XPRT_CONNECTED, &xprt->state);
297 static inline void xprt_clear_connected(struct rpc_xprt *xprt)
299 clear_bit(XPRT_CONNECTED, &xprt->state);
302 static inline int xprt_connected(struct rpc_xprt *xprt)
304 return test_bit(XPRT_CONNECTED, &xprt->state);
307 static inline int xprt_test_and_set_connected(struct rpc_xprt *xprt)
309 return test_and_set_bit(XPRT_CONNECTED, &xprt->state);
312 static inline int xprt_test_and_clear_connected(struct rpc_xprt *xprt)
314 return test_and_clear_bit(XPRT_CONNECTED, &xprt->state);
317 static inline void xprt_clear_connecting(struct rpc_xprt *xprt)
319 smp_mb__before_clear_bit();
320 clear_bit(XPRT_CONNECTING, &xprt->state);
321 smp_mb__after_clear_bit();
324 static inline int xprt_connecting(struct rpc_xprt *xprt)
326 return test_bit(XPRT_CONNECTING, &xprt->state);
329 static inline int xprt_test_and_set_connecting(struct rpc_xprt *xprt)
331 return test_and_set_bit(XPRT_CONNECTING, &xprt->state);
334 static inline void xprt_set_bound(struct rpc_xprt *xprt)
336 test_and_set_bit(XPRT_BOUND, &xprt->state);
339 static inline int xprt_bound(struct rpc_xprt *xprt)
341 return test_bit(XPRT_BOUND, &xprt->state);
344 static inline void xprt_clear_bound(struct rpc_xprt *xprt)
346 clear_bit(XPRT_BOUND, &xprt->state);
349 static inline void xprt_clear_binding(struct rpc_xprt *xprt)
351 smp_mb__before_clear_bit();
352 clear_bit(XPRT_BINDING, &xprt->state);
353 smp_mb__after_clear_bit();
356 static inline int xprt_test_and_set_binding(struct rpc_xprt *xprt)
358 return test_and_set_bit(XPRT_BINDING, &xprt->state);
361 #endif /* __KERNEL__*/
363 #endif /* _LINUX_SUNRPC_XPRT_H */