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
{
58 RPC_DISPLAY_UNIVERSAL_ADDR
,
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 __be32 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 */
96 struct xdr_buf rq_private_buf
; /* The receive buffer
97 * used in the softirq.
99 unsigned long rq_majortimeo
; /* major timeout alarm */
100 unsigned long rq_timeout
; /* Current timeout value */
101 unsigned int rq_retries
; /* # of retries */
104 * Partial send handling
106 u32 rq_bytes_sent
; /* Bytes we have sent */
108 unsigned long rq_xtime
; /* when transmitted */
111 #define rq_svec rq_snd_buf.head
112 #define rq_slen rq_snd_buf.len
114 struct rpc_xprt_ops
{
115 void (*set_buffer_size
)(struct rpc_xprt
*xprt
, size_t sndsize
, size_t rcvsize
);
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
)(void *buffer
);
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 */
136 struct rpc_timeout timeout
; /* timeout parms */
137 struct sockaddr_storage addr
; /* server address */
138 size_t addrlen
; /* size of server address */
139 int prot
; /* IP protocol */
141 unsigned long cong
; /* current congestion */
142 unsigned long cwnd
; /* congestion window */
144 size_t max_payload
; /* largest RPC payload size,
146 unsigned int tsh_size
; /* size of transport specific
149 struct rpc_wait_queue binding
; /* requests waiting on rpcbind */
150 struct rpc_wait_queue sending
; /* requests waiting to send */
151 struct rpc_wait_queue resend
; /* requests waiting to resend */
152 struct rpc_wait_queue pending
; /* requests in flight */
153 struct rpc_wait_queue backlog
; /* waiting for slot */
154 struct list_head free
; /* free slots */
155 struct rpc_rqst
* slot
; /* slot table storage */
156 unsigned int max_reqs
; /* total slots */
157 unsigned long state
; /* transport state */
158 unsigned char shutdown
: 1, /* being shut down */
159 resvport
: 1; /* use a reserved port */
160 unsigned int bind_index
; /* bind function index */
163 * Connection of transports
165 unsigned long connect_timeout
,
170 * Disconnection of idle transports
172 struct work_struct task_cleanup
;
173 struct timer_list timer
;
174 unsigned long last_used
,
180 spinlock_t transport_lock
; /* lock transport info */
181 spinlock_t reserve_lock
; /* lock slot table */
182 u32 xid
; /* Next XID value to use */
183 struct rpc_task
* snd_task
; /* Task blocked in send */
184 struct list_head recv
;
187 unsigned long bind_count
, /* total number of binds */
188 connect_count
, /* total number of connects */
189 connect_start
, /* connect start timestamp */
190 connect_time
, /* jiffies waiting for connect */
191 sends
, /* how many complete requests */
192 recvs
, /* how many complete requests */
193 bad_xids
; /* lookup_rqst didn't find XID */
195 unsigned long long req_u
, /* average requests on the wire */
196 bklog_u
; /* backlog queue utilization */
199 char * address_strings
[RPC_DISPLAY_MAX
];
202 struct rpc_xprtsock_create
{
203 int proto
; /* IPPROTO_UDP or IPPROTO_TCP */
204 struct sockaddr
* srcaddr
; /* optional local address */
205 struct sockaddr
* dstaddr
; /* remote peer address */
207 struct rpc_timeout
* timeout
; /* optional timeout parameters */
211 * Transport operations used by ULPs
213 void xprt_set_timeout(struct rpc_timeout
*to
, unsigned int retr
, unsigned long incr
);
216 * Generic internal transport functions
218 struct rpc_xprt
* xprt_create_transport(struct rpc_xprtsock_create
*args
);
219 void xprt_connect(struct rpc_task
*task
);
220 void xprt_reserve(struct rpc_task
*task
);
221 int xprt_reserve_xprt(struct rpc_task
*task
);
222 int xprt_reserve_xprt_cong(struct rpc_task
*task
);
223 int xprt_prepare_transmit(struct rpc_task
*task
);
224 void xprt_transmit(struct rpc_task
*task
);
225 void xprt_end_transmit(struct rpc_task
*task
);
226 int xprt_adjust_timeout(struct rpc_rqst
*req
);
227 void xprt_release_xprt(struct rpc_xprt
*xprt
, struct rpc_task
*task
);
228 void xprt_release_xprt_cong(struct rpc_xprt
*xprt
, struct rpc_task
*task
);
229 void xprt_release(struct rpc_task
*task
);
230 struct rpc_xprt
* xprt_get(struct rpc_xprt
*xprt
);
231 void xprt_put(struct rpc_xprt
*xprt
);
233 static inline __be32
*xprt_skip_transport_header(struct rpc_xprt
*xprt
, __be32
*p
)
235 return p
+ xprt
->tsh_size
;
239 * Transport switch helper functions
241 void xprt_set_retrans_timeout_def(struct rpc_task
*task
);
242 void xprt_set_retrans_timeout_rtt(struct rpc_task
*task
);
243 void xprt_wake_pending_tasks(struct rpc_xprt
*xprt
, int status
);
244 void xprt_wait_for_buffer_space(struct rpc_task
*task
);
245 void xprt_write_space(struct rpc_xprt
*xprt
);
246 void xprt_update_rtt(struct rpc_task
*task
);
247 void xprt_adjust_cwnd(struct rpc_task
*task
, int result
);
248 struct rpc_rqst
* xprt_lookup_rqst(struct rpc_xprt
*xprt
, __be32 xid
);
249 void xprt_complete_rqst(struct rpc_task
*task
, int copied
);
250 void xprt_release_rqst_cong(struct rpc_task
*task
);
251 void xprt_disconnect(struct rpc_xprt
*xprt
);
254 * Socket transport setup operations
256 struct rpc_xprt
* xs_setup_udp(struct rpc_xprtsock_create
*args
);
257 struct rpc_xprt
* xs_setup_tcp(struct rpc_xprtsock_create
*args
);
258 int init_socket_xprt(void);
259 void cleanup_socket_xprt(void);
262 * Reserved bit positions in xprt->state
264 #define XPRT_LOCKED (0)
265 #define XPRT_CONNECTED (1)
266 #define XPRT_CONNECTING (2)
267 #define XPRT_CLOSE_WAIT (3)
268 #define XPRT_BOUND (4)
269 #define XPRT_BINDING (5)
271 static inline void xprt_set_connected(struct rpc_xprt
*xprt
)
273 set_bit(XPRT_CONNECTED
, &xprt
->state
);
276 static inline void xprt_clear_connected(struct rpc_xprt
*xprt
)
278 clear_bit(XPRT_CONNECTED
, &xprt
->state
);
281 static inline int xprt_connected(struct rpc_xprt
*xprt
)
283 return test_bit(XPRT_CONNECTED
, &xprt
->state
);
286 static inline int xprt_test_and_set_connected(struct rpc_xprt
*xprt
)
288 return test_and_set_bit(XPRT_CONNECTED
, &xprt
->state
);
291 static inline int xprt_test_and_clear_connected(struct rpc_xprt
*xprt
)
293 return test_and_clear_bit(XPRT_CONNECTED
, &xprt
->state
);
296 static inline void xprt_clear_connecting(struct rpc_xprt
*xprt
)
298 smp_mb__before_clear_bit();
299 clear_bit(XPRT_CONNECTING
, &xprt
->state
);
300 smp_mb__after_clear_bit();
303 static inline int xprt_connecting(struct rpc_xprt
*xprt
)
305 return test_bit(XPRT_CONNECTING
, &xprt
->state
);
308 static inline int xprt_test_and_set_connecting(struct rpc_xprt
*xprt
)
310 return test_and_set_bit(XPRT_CONNECTING
, &xprt
->state
);
313 static inline void xprt_set_bound(struct rpc_xprt
*xprt
)
315 test_and_set_bit(XPRT_BOUND
, &xprt
->state
);
318 static inline int xprt_bound(struct rpc_xprt
*xprt
)
320 return test_bit(XPRT_BOUND
, &xprt
->state
);
323 static inline void xprt_clear_bound(struct rpc_xprt
*xprt
)
325 clear_bit(XPRT_BOUND
, &xprt
->state
);
328 static inline void xprt_clear_binding(struct rpc_xprt
*xprt
)
330 smp_mb__before_clear_bit();
331 clear_bit(XPRT_BINDING
, &xprt
->state
);
332 smp_mb__after_clear_bit();
335 static inline int xprt_test_and_set_binding(struct rpc_xprt
*xprt
)
337 return test_and_set_bit(XPRT_BINDING
, &xprt
->state
);
340 #endif /* __KERNEL__*/
342 #endif /* _LINUX_SUNRPC_XPRT_H */