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>
20 extern unsigned int xprt_udp_slot_table_entries
;
21 extern unsigned int xprt_tcp_slot_table_entries
;
23 #define RPC_MIN_SLOT_TABLE (2U)
24 #define RPC_DEF_SLOT_TABLE (16U)
25 #define RPC_MAX_SLOT_TABLE (128U)
28 * Parameters for choosing a free port
30 extern unsigned int xprt_min_resvport
;
31 extern unsigned int xprt_max_resvport
;
33 #define RPC_MIN_RESVPORT (1U)
34 #define RPC_MAX_RESVPORT (65535U)
35 #define RPC_DEF_MIN_RESVPORT (665U)
36 #define RPC_DEF_MAX_RESVPORT (1023U)
39 * This describes a timeout strategy
42 unsigned long to_initval
, /* initial timeout */
43 to_maxval
, /* max timeout */
44 to_increment
; /* if !exponential */
45 unsigned int to_retries
; /* max # of retries */
46 unsigned char to_exponential
;
49 enum rpc_display_format_t
{
62 * This describes a complete RPC request
66 * This is the user-visible part
68 struct rpc_xprt
* rq_xprt
; /* RPC client */
69 struct xdr_buf rq_snd_buf
; /* send buffer */
70 struct xdr_buf rq_rcv_buf
; /* recv buffer */
73 * This is the private part
75 struct rpc_task
* rq_task
; /* RPC task data */
76 __be32 rq_xid
; /* request XID */
77 int rq_cong
; /* has incremented xprt->cong */
78 int rq_received
; /* receive completed */
79 u32 rq_seqno
; /* gss seq no. used on req. */
81 struct page
**rq_enc_pages
; /* scratch pages for use by
83 void (*rq_release_snd_buf
)(struct rpc_rqst
*); /* release rq_enc_pages */
84 struct list_head rq_list
;
86 __u32
* rq_buffer
; /* XDR encode buffer */
89 struct xdr_buf rq_private_buf
; /* The receive buffer
90 * used in the softirq.
92 unsigned long rq_majortimeo
; /* major timeout alarm */
93 unsigned long rq_timeout
; /* Current timeout value */
94 unsigned int rq_retries
; /* # of retries */
97 * Partial send handling
99 u32 rq_bytes_sent
; /* Bytes we have sent */
101 unsigned long rq_xtime
; /* when transmitted */
104 #define rq_svec rq_snd_buf.head
105 #define rq_slen rq_snd_buf.len
107 struct rpc_xprt_ops
{
108 void (*set_buffer_size
)(struct rpc_xprt
*xprt
, size_t sndsize
, size_t rcvsize
);
109 char * (*print_addr
)(struct rpc_xprt
*xprt
, enum rpc_display_format_t format
);
110 int (*reserve_xprt
)(struct rpc_task
*task
);
111 void (*release_xprt
)(struct rpc_xprt
*xprt
, struct rpc_task
*task
);
112 void (*rpcbind
)(struct rpc_task
*task
);
113 void (*set_port
)(struct rpc_xprt
*xprt
, unsigned short port
);
114 void (*connect
)(struct rpc_task
*task
);
115 void * (*buf_alloc
)(struct rpc_task
*task
, size_t size
);
116 void (*buf_free
)(struct rpc_task
*task
);
117 int (*send_request
)(struct rpc_task
*task
);
118 void (*set_retrans_timeout
)(struct rpc_task
*task
);
119 void (*timer
)(struct rpc_task
*task
);
120 void (*release_request
)(struct rpc_task
*task
);
121 void (*close
)(struct rpc_xprt
*xprt
);
122 void (*destroy
)(struct rpc_xprt
*xprt
);
123 void (*print_stats
)(struct rpc_xprt
*xprt
, struct seq_file
*seq
);
127 struct kref kref
; /* Reference count */
128 struct rpc_xprt_ops
* ops
; /* transport methods */
129 struct socket
* sock
; /* BSD socket layer */
130 struct sock
* inet
; /* INET layer */
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 */
163 __u32 xid
; /* Next XID value to use */
166 * State of TCP reply receive stuff
168 __be32 tcp_recm
, /* Fragment header */
169 tcp_xid
; /* Current XID */
170 u32 tcp_reclen
, /* fragment length */
171 tcp_offset
; /* fragment offset */
172 unsigned long tcp_copied
, /* copied to request */
175 * Connection of transports
177 unsigned long connect_timeout
,
180 struct delayed_work connect_worker
;
184 * Disconnection of idle transports
186 struct work_struct task_cleanup
;
187 struct timer_list timer
;
188 unsigned long last_used
,
194 spinlock_t transport_lock
; /* lock transport info */
195 spinlock_t reserve_lock
; /* lock slot table */
196 struct rpc_task
* snd_task
; /* Task blocked in send */
198 struct list_head recv
;
201 unsigned long bind_count
, /* total number of binds */
202 connect_count
, /* total number of connects */
203 connect_start
, /* connect start timestamp */
204 connect_time
, /* jiffies waiting for connect */
205 sends
, /* how many complete requests */
206 recvs
, /* how many complete requests */
207 bad_xids
; /* lookup_rqst didn't find XID */
209 unsigned long long req_u
, /* average requests on the wire */
210 bklog_u
; /* backlog queue utilization */
213 void (*old_data_ready
)(struct sock
*, int);
214 void (*old_state_change
)(struct sock
*);
215 void (*old_write_space
)(struct sock
*);
217 char * address_strings
[RPC_DISPLAY_MAX
];
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)
228 * Transport operations used by ULPs
230 void xprt_set_timeout(struct rpc_timeout
*to
, unsigned int retr
, unsigned long incr
);
233 * Generic internal transport functions
235 struct rpc_xprt
* xprt_create_transport(int proto
, struct sockaddr
*addr
, size_t size
, struct rpc_timeout
*toparms
);
236 void xprt_connect(struct rpc_task
*task
);
237 void xprt_reserve(struct rpc_task
*task
);
238 int xprt_reserve_xprt(struct rpc_task
*task
);
239 int xprt_reserve_xprt_cong(struct rpc_task
*task
);
240 int xprt_prepare_transmit(struct rpc_task
*task
);
241 void xprt_transmit(struct rpc_task
*task
);
242 void xprt_end_transmit(struct rpc_task
*task
);
243 int xprt_adjust_timeout(struct rpc_rqst
*req
);
244 void xprt_release_xprt(struct rpc_xprt
*xprt
, struct rpc_task
*task
);
245 void xprt_release_xprt_cong(struct rpc_xprt
*xprt
, struct rpc_task
*task
);
246 void xprt_release(struct rpc_task
*task
);
247 struct rpc_xprt
* xprt_get(struct rpc_xprt
*xprt
);
248 void xprt_put(struct rpc_xprt
*xprt
);
250 static inline __be32
*xprt_skip_transport_header(struct rpc_xprt
*xprt
, __be32
*p
)
252 return p
+ xprt
->tsh_size
;
256 * Transport switch helper functions
258 void xprt_set_retrans_timeout_def(struct rpc_task
*task
);
259 void xprt_set_retrans_timeout_rtt(struct rpc_task
*task
);
260 void xprt_wake_pending_tasks(struct rpc_xprt
*xprt
, int status
);
261 void xprt_wait_for_buffer_space(struct rpc_task
*task
);
262 void xprt_write_space(struct rpc_xprt
*xprt
);
263 void xprt_update_rtt(struct rpc_task
*task
);
264 void xprt_adjust_cwnd(struct rpc_task
*task
, int result
);
265 struct rpc_rqst
* xprt_lookup_rqst(struct rpc_xprt
*xprt
, __be32 xid
);
266 void xprt_complete_rqst(struct rpc_task
*task
, int copied
);
267 void xprt_release_rqst_cong(struct rpc_task
*task
);
268 void xprt_disconnect(struct rpc_xprt
*xprt
);
271 * Socket transport setup operations
273 int xs_setup_udp(struct rpc_xprt
*xprt
, struct rpc_timeout
*to
);
274 int xs_setup_tcp(struct rpc_xprt
*xprt
, struct rpc_timeout
*to
);
277 * Reserved bit positions in xprt->state
279 #define XPRT_LOCKED (0)
280 #define XPRT_CONNECTED (1)
281 #define XPRT_CONNECTING (2)
282 #define XPRT_CLOSE_WAIT (3)
283 #define XPRT_BOUND (4)
284 #define XPRT_BINDING (5)
286 static inline void xprt_set_connected(struct rpc_xprt
*xprt
)
288 set_bit(XPRT_CONNECTED
, &xprt
->state
);
291 static inline void xprt_clear_connected(struct rpc_xprt
*xprt
)
293 clear_bit(XPRT_CONNECTED
, &xprt
->state
);
296 static inline int xprt_connected(struct rpc_xprt
*xprt
)
298 return test_bit(XPRT_CONNECTED
, &xprt
->state
);
301 static inline int xprt_test_and_set_connected(struct rpc_xprt
*xprt
)
303 return test_and_set_bit(XPRT_CONNECTED
, &xprt
->state
);
306 static inline int xprt_test_and_clear_connected(struct rpc_xprt
*xprt
)
308 return test_and_clear_bit(XPRT_CONNECTED
, &xprt
->state
);
311 static inline void xprt_clear_connecting(struct rpc_xprt
*xprt
)
313 smp_mb__before_clear_bit();
314 clear_bit(XPRT_CONNECTING
, &xprt
->state
);
315 smp_mb__after_clear_bit();
318 static inline int xprt_connecting(struct rpc_xprt
*xprt
)
320 return test_bit(XPRT_CONNECTING
, &xprt
->state
);
323 static inline int xprt_test_and_set_connecting(struct rpc_xprt
*xprt
)
325 return test_and_set_bit(XPRT_CONNECTING
, &xprt
->state
);
328 static inline void xprt_set_bound(struct rpc_xprt
*xprt
)
330 test_and_set_bit(XPRT_BOUND
, &xprt
->state
);
333 static inline int xprt_bound(struct rpc_xprt
*xprt
)
335 return test_bit(XPRT_BOUND
, &xprt
->state
);
338 static inline void xprt_clear_bound(struct rpc_xprt
*xprt
)
340 clear_bit(XPRT_BOUND
, &xprt
->state
);
343 static inline void xprt_clear_binding(struct rpc_xprt
*xprt
)
345 smp_mb__before_clear_bit();
346 clear_bit(XPRT_BINDING
, &xprt
->state
);
347 smp_mb__after_clear_bit();
350 static inline int xprt_test_and_set_binding(struct rpc_xprt
*xprt
)
352 return test_and_set_bit(XPRT_BINDING
, &xprt
->state
);
355 #endif /* __KERNEL__*/
357 #endif /* _LINUX_SUNRPC_XPRT_H */