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>
18 #include <linux/sunrpc/msg_prot.h>
22 extern unsigned int xprt_udp_slot_table_entries;
23 extern unsigned int xprt_tcp_slot_table_entries;
25 #define RPC_MIN_SLOT_TABLE (2U)
26 #define RPC_DEF_SLOT_TABLE (16U)
27 #define RPC_MAX_SLOT_TABLE (128U)
30 * Parameters for choosing a free port
32 extern unsigned int xprt_min_resvport;
33 extern unsigned int xprt_max_resvport;
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)
41 * This describes a timeout strategy
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;
51 enum rpc_display_format_t {
64 * This describes a complete RPC request
68 * This is the user-visible part
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 */
75 * This is the private part
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. */
83 struct page **rq_enc_pages; /* scratch pages for use by
85 void (*rq_release_snd_buf)(struct rpc_rqst *); /* release rq_enc_pages */
86 struct list_head rq_list;
88 __u32 * rq_buffer; /* XDR encode buffer */
91 struct xdr_buf rq_private_buf; /* The receive buffer
92 * used in the softirq.
94 unsigned long rq_majortimeo; /* major timeout alarm */
95 unsigned long rq_timeout; /* Current timeout value */
96 unsigned int rq_retries; /* # of retries */
99 * Partial send handling
101 u32 rq_bytes_sent; /* Bytes we have sent */
103 unsigned long rq_xtime; /* when transmitted */
106 #define rq_svec rq_snd_buf.head
107 #define rq_slen rq_snd_buf.len
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);
129 struct kref kref; /* Reference count */
130 struct rpc_xprt_ops * ops; /* transport methods */
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 */
137 unsigned long cong; /* current congestion */
138 unsigned long cwnd; /* congestion window */
140 size_t rcvsize, /* transport rcv buffer size */
141 sndsize; /* transport send buffer size */
143 size_t max_payload; /* largest RPC payload size,
145 unsigned int tsh_size; /* size of transport specific
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 */
161 * Connection of transports
163 unsigned long connect_timeout,
168 * Disconnection of idle transports
170 struct work_struct task_cleanup;
171 struct timer_list timer;
172 unsigned long last_used,
178 spinlock_t transport_lock; /* lock transport info */
179 spinlock_t reserve_lock; /* lock slot table */
180 u32 xid; /* Next XID value to use */
181 struct rpc_task * snd_task; /* Task blocked in send */
182 struct list_head recv;
185 unsigned long bind_count, /* total number of binds */
186 connect_count, /* total number of connects */
187 connect_start, /* connect start timestamp */
188 connect_time, /* jiffies waiting for connect */
189 sends, /* how many complete requests */
190 recvs, /* how many complete requests */
191 bad_xids; /* lookup_rqst didn't find XID */
193 unsigned long long req_u, /* average requests on the wire */
194 bklog_u; /* backlog queue utilization */
197 void (*old_data_ready)(struct sock *, int);
198 void (*old_state_change)(struct sock *);
199 void (*old_write_space)(struct sock *);
201 char * address_strings[RPC_DISPLAY_MAX];
207 * Transport operations used by ULPs
209 void xprt_set_timeout(struct rpc_timeout *to, unsigned int retr, unsigned long incr);
212 * Generic internal transport functions
214 struct rpc_xprt * xprt_create_transport(int proto, struct sockaddr *addr, size_t size, struct rpc_timeout *toparms);
215 void xprt_connect(struct rpc_task *task);
216 void xprt_reserve(struct rpc_task *task);
217 int xprt_reserve_xprt(struct rpc_task *task);
218 int xprt_reserve_xprt_cong(struct rpc_task *task);
219 int xprt_prepare_transmit(struct rpc_task *task);
220 void xprt_transmit(struct rpc_task *task);
221 void xprt_end_transmit(struct rpc_task *task);
222 int xprt_adjust_timeout(struct rpc_rqst *req);
223 void xprt_release_xprt(struct rpc_xprt *xprt, struct rpc_task *task);
224 void xprt_release_xprt_cong(struct rpc_xprt *xprt, struct rpc_task *task);
225 void xprt_release(struct rpc_task *task);
226 struct rpc_xprt * xprt_get(struct rpc_xprt *xprt);
227 void xprt_put(struct rpc_xprt *xprt);
229 static inline __be32 *xprt_skip_transport_header(struct rpc_xprt *xprt, __be32 *p)
231 return p + xprt->tsh_size;
235 * Transport switch helper functions
237 void xprt_set_retrans_timeout_def(struct rpc_task *task);
238 void xprt_set_retrans_timeout_rtt(struct rpc_task *task);
239 void xprt_wake_pending_tasks(struct rpc_xprt *xprt, int status);
240 void xprt_wait_for_buffer_space(struct rpc_task *task);
241 void xprt_write_space(struct rpc_xprt *xprt);
242 void xprt_update_rtt(struct rpc_task *task);
243 void xprt_adjust_cwnd(struct rpc_task *task, int result);
244 struct rpc_rqst * xprt_lookup_rqst(struct rpc_xprt *xprt, __be32 xid);
245 void xprt_complete_rqst(struct rpc_task *task, int copied);
246 void xprt_release_rqst_cong(struct rpc_task *task);
247 void xprt_disconnect(struct rpc_xprt *xprt);
250 * Socket transport setup operations
252 struct rpc_xprt * xs_setup_udp(struct sockaddr *addr, size_t addrlen, struct rpc_timeout *to);
253 struct rpc_xprt * xs_setup_tcp(struct sockaddr *addr, size_t addrlen, struct rpc_timeout *to);
256 * Reserved bit positions in xprt->state
258 #define XPRT_LOCKED (0)
259 #define XPRT_CONNECTED (1)
260 #define XPRT_CONNECTING (2)
261 #define XPRT_CLOSE_WAIT (3)
262 #define XPRT_BOUND (4)
263 #define XPRT_BINDING (5)
265 static inline void xprt_set_connected(struct rpc_xprt *xprt)
267 set_bit(XPRT_CONNECTED, &xprt->state);
270 static inline void xprt_clear_connected(struct rpc_xprt *xprt)
272 clear_bit(XPRT_CONNECTED, &xprt->state);
275 static inline int xprt_connected(struct rpc_xprt *xprt)
277 return test_bit(XPRT_CONNECTED, &xprt->state);
280 static inline int xprt_test_and_set_connected(struct rpc_xprt *xprt)
282 return test_and_set_bit(XPRT_CONNECTED, &xprt->state);
285 static inline int xprt_test_and_clear_connected(struct rpc_xprt *xprt)
287 return test_and_clear_bit(XPRT_CONNECTED, &xprt->state);
290 static inline void xprt_clear_connecting(struct rpc_xprt *xprt)
292 smp_mb__before_clear_bit();
293 clear_bit(XPRT_CONNECTING, &xprt->state);
294 smp_mb__after_clear_bit();
297 static inline int xprt_connecting(struct rpc_xprt *xprt)
299 return test_bit(XPRT_CONNECTING, &xprt->state);
302 static inline int xprt_test_and_set_connecting(struct rpc_xprt *xprt)
304 return test_and_set_bit(XPRT_CONNECTING, &xprt->state);
307 static inline void xprt_set_bound(struct rpc_xprt *xprt)
309 test_and_set_bit(XPRT_BOUND, &xprt->state);
312 static inline int xprt_bound(struct rpc_xprt *xprt)
314 return test_bit(XPRT_BOUND, &xprt->state);
317 static inline void xprt_clear_bound(struct rpc_xprt *xprt)
319 clear_bit(XPRT_BOUND, &xprt->state);
322 static inline void xprt_clear_binding(struct rpc_xprt *xprt)
324 smp_mb__before_clear_bit();
325 clear_bit(XPRT_BINDING, &xprt->state);
326 smp_mb__after_clear_bit();
329 static inline int xprt_test_and_set_binding(struct rpc_xprt *xprt)
331 return test_and_set_bit(XPRT_BINDING, &xprt->state);
334 #endif /* __KERNEL__*/
336 #endif /* _LINUX_SUNRPC_XPRT_H */