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/ktime.h>
16 #include <linux/sunrpc/sched.h>
17 #include <linux/sunrpc/xdr.h>
18 #include <linux/sunrpc/msg_prot.h>
22 #define RPC_MIN_SLOT_TABLE (2U)
23 #define RPC_DEF_SLOT_TABLE (16U)
24 #define RPC_MAX_SLOT_TABLE (128U)
25 #define RPC_MAX_SLOT_TABLE_LIMIT (65536U)
28 * This describes a timeout strategy
31 unsigned long to_initval, /* initial timeout */
32 to_maxval, /* max timeout */
33 to_increment; /* if !exponential */
34 unsigned int to_retries; /* max # of retries */
35 unsigned char to_exponential;
38 enum rpc_display_format_t {
53 * This describes a complete RPC request
57 * This is the user-visible part
59 struct rpc_xprt * rq_xprt; /* RPC client */
60 struct xdr_buf rq_snd_buf; /* send buffer */
61 struct xdr_buf rq_rcv_buf; /* recv buffer */
64 * This is the private part
66 struct rpc_task * rq_task; /* RPC task data */
67 struct rpc_cred * rq_cred; /* Bound cred */
68 __be32 rq_xid; /* request XID */
69 int rq_cong; /* has incremented xprt->cong */
70 u32 rq_seqno; /* gss seq no. used on req. */
72 struct page **rq_enc_pages; /* scratch pages for use by
74 void (*rq_release_snd_buf)(struct rpc_rqst *); /* release rq_enc_pages */
75 struct list_head rq_list;
77 __u32 * rq_buffer; /* XDR encode buffer */
80 size_t rq_xmit_bytes_sent; /* total bytes sent */
81 size_t rq_reply_bytes_recvd; /* total reply bytes */
84 struct xdr_buf rq_private_buf; /* The receive buffer
85 * used in the softirq.
87 unsigned long rq_majortimeo; /* major timeout alarm */
88 unsigned long rq_timeout; /* Current timeout value */
89 ktime_t rq_rtt; /* round-trip time */
90 unsigned int rq_retries; /* # of retries */
91 unsigned int rq_connect_cookie;
92 /* A cookie used to track the
93 state of the transport
97 * Partial send handling
99 u32 rq_bytes_sent; /* Bytes we have sent */
101 ktime_t rq_xtime; /* transmit time stamp */
104 #if defined(CONFIG_SUNRPC_BACKCHANNEL)
105 struct list_head rq_bc_list; /* Callback service list */
106 unsigned long rq_bc_pa_state; /* Backchannel prealloc state */
107 struct list_head rq_bc_pa_list; /* Backchannel prealloc list */
108 #endif /* CONFIG_SUNRPC_BACKCHANEL */
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 int (*reserve_xprt)(struct rpc_xprt *xprt, struct rpc_task *task);
116 void (*release_xprt)(struct rpc_xprt *xprt, struct rpc_task *task);
117 void (*alloc_slot)(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 * RPC transport identifiers
135 * To preserve compatibility with the historical use of raw IP protocol
136 * id's for transport selection, UDP and TCP identifiers are specified
137 * with the previous values. No such restriction exists for new transports,
138 * except that they may not collide with these values (17 and 6,
141 #define XPRT_TRANSPORT_BC (1 << 31)
142 enum xprt_transports {
143 XPRT_TRANSPORT_UDP = IPPROTO_UDP,
144 XPRT_TRANSPORT_TCP = IPPROTO_TCP,
145 XPRT_TRANSPORT_BC_TCP = IPPROTO_TCP | XPRT_TRANSPORT_BC,
146 XPRT_TRANSPORT_RDMA = 256,
147 XPRT_TRANSPORT_LOCAL = 257,
151 atomic_t count; /* Reference count */
152 struct rpc_xprt_ops * ops; /* transport methods */
154 const struct rpc_timeout *timeout; /* timeout parms */
155 struct sockaddr_storage addr; /* server address */
156 size_t addrlen; /* size of server address */
157 int prot; /* IP protocol */
159 unsigned long cong; /* current congestion */
160 unsigned long cwnd; /* congestion window */
162 size_t max_payload; /* largest RPC payload size,
164 unsigned int tsh_size; /* size of transport specific
167 struct rpc_wait_queue binding; /* requests waiting on rpcbind */
168 struct rpc_wait_queue sending; /* requests waiting to send */
169 struct rpc_wait_queue pending; /* requests in flight */
170 struct rpc_wait_queue backlog; /* waiting for slot */
171 struct list_head free; /* free slots */
172 unsigned int max_reqs; /* max number of slots */
173 unsigned int min_reqs; /* min number of slots */
174 atomic_t num_reqs; /* total slots */
175 unsigned long state; /* transport state */
176 unsigned char shutdown : 1, /* being shut down */
177 resvport : 1; /* use a reserved port */
178 unsigned int bind_index; /* bind function index */
181 * Connection of transports
183 unsigned long bind_timeout,
185 unsigned int connect_cookie; /* A cookie that gets bumped
186 every time the transport
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 u32 xid; /* Next XID value to use */
203 struct rpc_task * snd_task; /* Task blocked in send */
204 struct svc_xprt *bc_xprt; /* NFSv4.1 backchannel */
205 #if defined(CONFIG_SUNRPC_BACKCHANNEL)
206 struct svc_serv *bc_serv; /* The RPC service which will */
207 /* process the callback */
208 unsigned int bc_alloc_count; /* Total number of preallocs */
209 spinlock_t bc_pa_lock; /* Protects the preallocated
211 struct list_head bc_pa_list; /* List of preallocated
212 * backchannel rpc_rqst's */
213 #endif /* CONFIG_SUNRPC_BACKCHANNEL */
214 struct list_head recv;
217 unsigned long bind_count, /* total number of binds */
218 connect_count, /* total number of connects */
219 connect_start, /* connect start timestamp */
220 connect_time, /* jiffies waiting for connect */
221 sends, /* how many complete requests */
222 recvs, /* how many complete requests */
223 bad_xids; /* lookup_rqst didn't find XID */
225 unsigned long long req_u, /* average requests on the wire */
226 bklog_u; /* backlog queue utilization */
229 struct net *xprt_net;
230 const char *address_strings[RPC_DISPLAY_MAX];
233 #if defined(CONFIG_SUNRPC_BACKCHANNEL)
237 #define RPC_BC_PA_IN_USE 0x0001 /* Preallocated backchannel */
239 #endif /* CONFIG_SUNRPC_BACKCHANNEL */
241 #if defined(CONFIG_SUNRPC_BACKCHANNEL)
242 static inline int bc_prealloc(struct rpc_rqst *req)
244 return test_bit(RPC_BC_PA_IN_USE, &req->rq_bc_pa_state);
247 static inline int bc_prealloc(struct rpc_rqst *req)
251 #endif /* CONFIG_SUNRPC_BACKCHANNEL */
254 int ident; /* XPRT_TRANSPORT identifier */
256 struct sockaddr * srcaddr; /* optional local address */
257 struct sockaddr * dstaddr; /* remote peer address */
259 struct svc_xprt *bc_xprt; /* NFSv4.1 backchannel */
263 struct list_head list;
264 int ident; /* XPRT_TRANSPORT identifier */
265 struct rpc_xprt * (*setup)(struct xprt_create *);
266 struct module *owner;
271 * Generic internal transport functions
273 struct rpc_xprt *xprt_create_transport(struct xprt_create *args);
274 void xprt_connect(struct rpc_task *task);
275 void xprt_reserve(struct rpc_task *task);
276 int xprt_reserve_xprt(struct rpc_xprt *xprt, struct rpc_task *task);
277 int xprt_reserve_xprt_cong(struct rpc_xprt *xprt, struct rpc_task *task);
278 void xprt_alloc_slot(struct rpc_xprt *xprt, struct rpc_task *task);
279 void xprt_lock_and_alloc_slot(struct rpc_xprt *xprt, struct rpc_task *task);
280 int xprt_prepare_transmit(struct rpc_task *task);
281 void xprt_transmit(struct rpc_task *task);
282 void xprt_end_transmit(struct rpc_task *task);
283 int xprt_adjust_timeout(struct rpc_rqst *req);
284 void xprt_release_xprt(struct rpc_xprt *xprt, struct rpc_task *task);
285 void xprt_release_xprt_cong(struct rpc_xprt *xprt, struct rpc_task *task);
286 void xprt_release(struct rpc_task *task);
287 struct rpc_xprt * xprt_get(struct rpc_xprt *xprt);
288 void xprt_put(struct rpc_xprt *xprt);
289 struct rpc_xprt * xprt_alloc(struct net *net, size_t size,
290 unsigned int num_prealloc,
291 unsigned int max_req);
292 void xprt_free(struct rpc_xprt *);
294 static inline __be32 *xprt_skip_transport_header(struct rpc_xprt *xprt, __be32 *p)
296 return p + xprt->tsh_size;
300 * Transport switch helper functions
302 int xprt_register_transport(struct xprt_class *type);
303 int xprt_unregister_transport(struct xprt_class *type);
304 int xprt_load_transport(const char *);
305 void xprt_set_retrans_timeout_def(struct rpc_task *task);
306 void xprt_set_retrans_timeout_rtt(struct rpc_task *task);
307 void xprt_wake_pending_tasks(struct rpc_xprt *xprt, int status);
308 void xprt_wait_for_buffer_space(struct rpc_task *task, rpc_action action);
309 void xprt_write_space(struct rpc_xprt *xprt);
310 void xprt_adjust_cwnd(struct rpc_task *task, int result);
311 struct rpc_rqst * xprt_lookup_rqst(struct rpc_xprt *xprt, __be32 xid);
312 void xprt_complete_rqst(struct rpc_task *task, int copied);
313 void xprt_release_rqst_cong(struct rpc_task *task);
314 void xprt_disconnect_done(struct rpc_xprt *xprt);
315 void xprt_force_disconnect(struct rpc_xprt *xprt);
316 void xprt_conditional_disconnect(struct rpc_xprt *xprt, unsigned int cookie);
319 * Reserved bit positions in xprt->state
321 #define XPRT_LOCKED (0)
322 #define XPRT_CONNECTED (1)
323 #define XPRT_CONNECTING (2)
324 #define XPRT_CLOSE_WAIT (3)
325 #define XPRT_BOUND (4)
326 #define XPRT_BINDING (5)
327 #define XPRT_CLOSING (6)
328 #define XPRT_CONNECTION_ABORT (7)
329 #define XPRT_CONNECTION_CLOSE (8)
331 static inline void xprt_set_connected(struct rpc_xprt *xprt)
333 set_bit(XPRT_CONNECTED, &xprt->state);
336 static inline void xprt_clear_connected(struct rpc_xprt *xprt)
338 clear_bit(XPRT_CONNECTED, &xprt->state);
341 static inline int xprt_connected(struct rpc_xprt *xprt)
343 return test_bit(XPRT_CONNECTED, &xprt->state);
346 static inline int xprt_test_and_set_connected(struct rpc_xprt *xprt)
348 return test_and_set_bit(XPRT_CONNECTED, &xprt->state);
351 static inline int xprt_test_and_clear_connected(struct rpc_xprt *xprt)
353 return test_and_clear_bit(XPRT_CONNECTED, &xprt->state);
356 static inline void xprt_clear_connecting(struct rpc_xprt *xprt)
358 smp_mb__before_clear_bit();
359 clear_bit(XPRT_CONNECTING, &xprt->state);
360 smp_mb__after_clear_bit();
363 static inline int xprt_connecting(struct rpc_xprt *xprt)
365 return test_bit(XPRT_CONNECTING, &xprt->state);
368 static inline int xprt_test_and_set_connecting(struct rpc_xprt *xprt)
370 return test_and_set_bit(XPRT_CONNECTING, &xprt->state);
373 static inline void xprt_set_bound(struct rpc_xprt *xprt)
375 test_and_set_bit(XPRT_BOUND, &xprt->state);
378 static inline int xprt_bound(struct rpc_xprt *xprt)
380 return test_bit(XPRT_BOUND, &xprt->state);
383 static inline void xprt_clear_bound(struct rpc_xprt *xprt)
385 clear_bit(XPRT_BOUND, &xprt->state);
388 static inline void xprt_clear_binding(struct rpc_xprt *xprt)
390 smp_mb__before_clear_bit();
391 clear_bit(XPRT_BINDING, &xprt->state);
392 smp_mb__after_clear_bit();
395 static inline int xprt_test_and_set_binding(struct rpc_xprt *xprt)
397 return test_and_set_bit(XPRT_BINDING, &xprt->state);
400 #endif /* __KERNEL__*/
402 #endif /* _LINUX_SUNRPC_XPRT_H */