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 (650U)
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;
58 * This describes a complete RPC request
62 * This is the user-visible part
64 struct rpc_xprt * rq_xprt; /* RPC client */
65 struct xdr_buf rq_snd_buf; /* send buffer */
66 struct xdr_buf rq_rcv_buf; /* recv buffer */
69 * This is the private part
71 struct rpc_task * rq_task; /* RPC task data */
72 __u32 rq_xid; /* request XID */
73 int rq_cong; /* has incremented xprt->cong */
74 int rq_received; /* receive completed */
75 u32 rq_seqno; /* gss seq no. used on req. */
77 struct page **rq_enc_pages; /* scratch pages for use by
79 void (*rq_release_snd_buf)(struct rpc_rqst *); /* release rq_enc_pages */
80 struct list_head rq_list;
82 __u32 * rq_buffer; /* XDR encode buffer */
85 struct xdr_buf rq_private_buf; /* The receive buffer
86 * used in the softirq.
88 unsigned long rq_majortimeo; /* major timeout alarm */
89 unsigned long rq_timeout; /* Current timeout value */
90 unsigned int rq_retries; /* # of retries */
93 * Partial send handling
95 u32 rq_bytes_sent; /* Bytes we have sent */
97 unsigned long rq_xtime; /* when transmitted */
100 #define rq_svec rq_snd_buf.head
101 #define rq_slen rq_snd_buf.len
103 struct rpc_xprt_ops {
104 void (*set_buffer_size)(struct rpc_xprt *xprt, size_t sndsize, size_t rcvsize);
105 int (*reserve_xprt)(struct rpc_task *task);
106 void (*release_xprt)(struct rpc_xprt *xprt, struct rpc_task *task);
107 void (*set_port)(struct rpc_xprt *xprt, unsigned short port);
108 void (*connect)(struct rpc_task *task);
109 void * (*buf_alloc)(struct rpc_task *task, size_t size);
110 void (*buf_free)(struct rpc_task *task);
111 int (*send_request)(struct rpc_task *task);
112 void (*set_retrans_timeout)(struct rpc_task *task);
113 void (*timer)(struct rpc_task *task);
114 void (*release_request)(struct rpc_task *task);
115 void (*close)(struct rpc_xprt *xprt);
116 void (*destroy)(struct rpc_xprt *xprt);
117 void (*print_stats)(struct rpc_xprt *xprt, struct seq_file *seq);
121 struct rpc_xprt_ops * ops; /* transport methods */
122 struct socket * sock; /* BSD socket layer */
123 struct sock * inet; /* INET layer */
125 struct rpc_timeout timeout; /* timeout parms */
126 struct sockaddr_in addr; /* server address */
127 int prot; /* IP protocol */
129 unsigned long cong; /* current congestion */
130 unsigned long cwnd; /* congestion window */
132 size_t rcvsize, /* transport rcv buffer size */
133 sndsize; /* transport send buffer size */
135 size_t max_payload; /* largest RPC payload size,
137 unsigned int tsh_size; /* size of transport specific
140 struct rpc_wait_queue sending; /* requests waiting to send */
141 struct rpc_wait_queue resend; /* requests waiting to resend */
142 struct rpc_wait_queue pending; /* requests in flight */
143 struct rpc_wait_queue backlog; /* waiting for slot */
144 struct list_head free; /* free slots */
145 struct rpc_rqst * slot; /* slot table storage */
146 unsigned int max_reqs; /* total slots */
147 unsigned long state; /* transport state */
148 unsigned char shutdown : 1, /* being shut down */
149 resvport : 1; /* use a reserved port */
154 __u32 xid; /* Next XID value to use */
157 * State of TCP reply receive stuff
159 u32 tcp_recm, /* Fragment header */
160 tcp_xid, /* Current XID */
161 tcp_reclen, /* fragment length */
162 tcp_offset; /* fragment offset */
163 unsigned long tcp_copied, /* copied to request */
166 * Connection of transports
168 unsigned long connect_timeout,
171 struct work_struct connect_worker;
175 * Disconnection of idle transports
177 struct work_struct task_cleanup;
178 struct timer_list timer;
179 unsigned long last_used,
185 spinlock_t transport_lock; /* lock transport info */
186 spinlock_t reserve_lock; /* lock slot table */
187 struct rpc_task * snd_task; /* Task blocked in send */
189 struct list_head recv;
192 unsigned long bind_count, /* total number of binds */
193 connect_count, /* total number of connects */
194 connect_start, /* connect start timestamp */
195 connect_time, /* jiffies waiting for connect */
196 sends, /* how many complete requests */
197 recvs, /* how many complete requests */
198 bad_xids; /* lookup_rqst didn't find XID */
200 unsigned long long req_u, /* average requests on the wire */
201 bklog_u; /* backlog queue utilization */
204 void (*old_data_ready)(struct sock *, int);
205 void (*old_state_change)(struct sock *);
206 void (*old_write_space)(struct sock *);
209 #define XPRT_LAST_FRAG (1 << 0)
210 #define XPRT_COPY_RECM (1 << 1)
211 #define XPRT_COPY_XID (1 << 2)
212 #define XPRT_COPY_DATA (1 << 3)
217 * Transport operations used by ULPs
219 struct rpc_xprt * xprt_create_proto(int proto, struct sockaddr_in *addr, struct rpc_timeout *to);
220 void xprt_set_timeout(struct rpc_timeout *to, unsigned int retr, unsigned long incr);
223 * Generic internal transport functions
225 void xprt_connect(struct rpc_task *task);
226 void xprt_reserve(struct rpc_task *task);
227 int xprt_reserve_xprt(struct rpc_task *task);
228 int xprt_reserve_xprt_cong(struct rpc_task *task);
229 int xprt_prepare_transmit(struct rpc_task *task);
230 void xprt_transmit(struct rpc_task *task);
231 void xprt_abort_transmit(struct rpc_task *task);
232 int xprt_adjust_timeout(struct rpc_rqst *req);
233 void xprt_release_xprt(struct rpc_xprt *xprt, struct rpc_task *task);
234 void xprt_release_xprt_cong(struct rpc_xprt *xprt, struct rpc_task *task);
235 void xprt_release(struct rpc_task *task);
236 int xprt_destroy(struct rpc_xprt *xprt);
238 static inline u32 *xprt_skip_transport_header(struct rpc_xprt *xprt, u32 *p)
240 return p + xprt->tsh_size;
244 * Transport switch helper functions
246 void xprt_set_retrans_timeout_def(struct rpc_task *task);
247 void xprt_set_retrans_timeout_rtt(struct rpc_task *task);
248 void xprt_wake_pending_tasks(struct rpc_xprt *xprt, int status);
249 void xprt_wait_for_buffer_space(struct rpc_task *task);
250 void xprt_write_space(struct rpc_xprt *xprt);
251 void xprt_update_rtt(struct rpc_task *task);
252 void xprt_adjust_cwnd(struct rpc_task *task, int result);
253 struct rpc_rqst * xprt_lookup_rqst(struct rpc_xprt *xprt, u32 xid);
254 void xprt_complete_rqst(struct rpc_task *task, int copied);
255 void xprt_release_rqst_cong(struct rpc_task *task);
256 void xprt_disconnect(struct rpc_xprt *xprt);
259 * Socket transport setup operations
261 int xs_setup_udp(struct rpc_xprt *xprt, struct rpc_timeout *to);
262 int xs_setup_tcp(struct rpc_xprt *xprt, struct rpc_timeout *to);
265 * Reserved bit positions in xprt->state
267 #define XPRT_LOCKED (0)
268 #define XPRT_CONNECTED (1)
269 #define XPRT_CONNECTING (2)
270 #define XPRT_CLOSE_WAIT (3)
272 static inline void xprt_set_connected(struct rpc_xprt *xprt)
274 set_bit(XPRT_CONNECTED, &xprt->state);
277 static inline void xprt_clear_connected(struct rpc_xprt *xprt)
279 clear_bit(XPRT_CONNECTED, &xprt->state);
282 static inline int xprt_connected(struct rpc_xprt *xprt)
284 return test_bit(XPRT_CONNECTED, &xprt->state);
287 static inline int xprt_test_and_set_connected(struct rpc_xprt *xprt)
289 return test_and_set_bit(XPRT_CONNECTED, &xprt->state);
292 static inline int xprt_test_and_clear_connected(struct rpc_xprt *xprt)
294 return test_and_clear_bit(XPRT_CONNECTED, &xprt->state);
297 static inline void xprt_clear_connecting(struct rpc_xprt *xprt)
299 smp_mb__before_clear_bit();
300 clear_bit(XPRT_CONNECTING, &xprt->state);
301 smp_mb__after_clear_bit();
304 static inline int xprt_connecting(struct rpc_xprt *xprt)
306 return test_bit(XPRT_CONNECTING, &xprt->state);
309 static inline int xprt_test_and_set_connecting(struct rpc_xprt *xprt)
311 return test_and_set_bit(XPRT_CONNECTING, &xprt->state);
314 #endif /* __KERNEL__*/
316 #endif /* _LINUX_SUNRPC_XPRT_H */