tjh.dev
Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel
os
linux
1/*
2 * linux/include/linux/sunrpc/xprt.h
3 *
4 * Declarations for the RPC transport interface.
5 *
6 * Copyright (C) 1995, 1996 Olaf Kirch <okir@monad.swb.de>
7 */
8
9#ifndef _LINUX_SUNRPC_XPRT_H
10#define _LINUX_SUNRPC_XPRT_H
11
12#include <linux/uio.h>
13#include <linux/socket.h>
14#include <linux/in.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>
19
20extern unsigned int xprt_udp_slot_table_entries;
21extern unsigned int xprt_tcp_slot_table_entries;
22
23#define RPC_MIN_SLOT_TABLE (2U)
24#define RPC_DEF_SLOT_TABLE (16U)
25#define RPC_MAX_SLOT_TABLE (128U)
26
27/*
28 * Parameters for choosing a free port
29 */
30extern unsigned int xprt_min_resvport;
31extern unsigned int xprt_max_resvport;
32
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)
37
38/*
39 * This describes a timeout strategy
40 */
41struct rpc_timeout {
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;
47};
48
49enum rpc_display_format_t {
50 RPC_DISPLAY_ADDR = 0,
51 RPC_DISPLAY_PORT,
52 RPC_DISPLAY_PROTO,
53 RPC_DISPLAY_ALL,
54 RPC_DISPLAY_MAX,
55};
56
57struct rpc_task;
58struct rpc_xprt;
59struct seq_file;
60
61/*
62 * This describes a complete RPC request
63 */
64struct rpc_rqst {
65 /*
66 * This is the user-visible part
67 */
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 */
71
72 /*
73 * This is the private part
74 */
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. */
80 int rq_enc_pages_num;
81 struct page **rq_enc_pages; /* scratch pages for use by
82 gss privacy code */
83 void (*rq_release_snd_buf)(struct rpc_rqst *); /* release rq_enc_pages */
84 struct list_head rq_list;
85
86 __u32 * rq_buffer; /* XDR encode buffer */
87 size_t rq_bufsize,
88 rq_callsize,
89 rq_rcvsize;
90
91 struct xdr_buf rq_private_buf; /* The receive buffer
92 * used in the softirq.
93 */
94 unsigned long rq_majortimeo; /* major timeout alarm */
95 unsigned long rq_timeout; /* Current timeout value */
96 unsigned int rq_retries; /* # of retries */
97
98 /*
99 * Partial send handling
100 */
101 u32 rq_bytes_sent; /* Bytes we have sent */
102
103 unsigned long rq_xtime; /* when transmitted */
104 int rq_ntrans;
105};
106#define rq_svec rq_snd_buf.head
107#define rq_slen rq_snd_buf.len
108
109struct rpc_xprt_ops {
110 void (*set_buffer_size)(struct rpc_xprt *xprt, size_t sndsize, size_t rcvsize);
111 int (*reserve_xprt)(struct rpc_task *task);
112 void (*release_xprt)(struct rpc_xprt *xprt, struct rpc_task *task);
113 void (*rpcbind)(struct rpc_task *task);
114 void (*set_port)(struct rpc_xprt *xprt, unsigned short port);
115 void (*connect)(struct rpc_task *task);
116 void * (*buf_alloc)(struct rpc_task *task, size_t size);
117 void (*buf_free)(void *buffer);
118 int (*send_request)(struct rpc_task *task);
119 void (*set_retrans_timeout)(struct rpc_task *task);
120 void (*timer)(struct rpc_task *task);
121 void (*release_request)(struct rpc_task *task);
122 void (*close)(struct rpc_xprt *xprt);
123 void (*destroy)(struct rpc_xprt *xprt);
124 void (*print_stats)(struct rpc_xprt *xprt, struct seq_file *seq);
125};
126
127struct rpc_xprt {
128 struct kref kref; /* Reference count */
129 struct rpc_xprt_ops * ops; /* transport methods */
130
131 struct rpc_timeout timeout; /* timeout parms */
132 struct sockaddr_storage addr; /* server address */
133 size_t addrlen; /* size of server address */
134 int prot; /* IP protocol */
135
136 unsigned long cong; /* current congestion */
137 unsigned long cwnd; /* congestion window */
138
139 size_t max_payload; /* largest RPC payload size,
140 in bytes */
141 unsigned int tsh_size; /* size of transport specific
142 header */
143
144 struct rpc_wait_queue binding; /* requests waiting on rpcbind */
145 struct rpc_wait_queue sending; /* requests waiting to send */
146 struct rpc_wait_queue resend; /* requests waiting to resend */
147 struct rpc_wait_queue pending; /* requests in flight */
148 struct rpc_wait_queue backlog; /* waiting for slot */
149 struct list_head free; /* free slots */
150 struct rpc_rqst * slot; /* slot table storage */
151 unsigned int max_reqs; /* total slots */
152 unsigned long state; /* transport state */
153 unsigned char shutdown : 1, /* being shut down */
154 resvport : 1; /* use a reserved port */
155 unsigned int bind_index; /* bind function index */
156
157 /*
158 * Connection of transports
159 */
160 unsigned long connect_timeout,
161 bind_timeout,
162 reestablish_timeout;
163
164 /*
165 * Disconnection of idle transports
166 */
167 struct work_struct task_cleanup;
168 struct timer_list timer;
169 unsigned long last_used,
170 idle_timeout;
171
172 /*
173 * Send stuff
174 */
175 spinlock_t transport_lock; /* lock transport info */
176 spinlock_t reserve_lock; /* lock slot table */
177 u32 xid; /* Next XID value to use */
178 struct rpc_task * snd_task; /* Task blocked in send */
179 struct list_head recv;
180
181 struct {
182 unsigned long bind_count, /* total number of binds */
183 connect_count, /* total number of connects */
184 connect_start, /* connect start timestamp */
185 connect_time, /* jiffies waiting for connect */
186 sends, /* how many complete requests */
187 recvs, /* how many complete requests */
188 bad_xids; /* lookup_rqst didn't find XID */
189
190 unsigned long long req_u, /* average requests on the wire */
191 bklog_u; /* backlog queue utilization */
192 } stat;
193
194 char * address_strings[RPC_DISPLAY_MAX];
195};
196
197#ifdef __KERNEL__
198
199/*
200 * Transport operations used by ULPs
201 */
202void xprt_set_timeout(struct rpc_timeout *to, unsigned int retr, unsigned long incr);
203
204/*
205 * Generic internal transport functions
206 */
207struct rpc_xprt * xprt_create_transport(int proto, struct sockaddr *addr, size_t size, struct rpc_timeout *toparms);
208void xprt_connect(struct rpc_task *task);
209void xprt_reserve(struct rpc_task *task);
210int xprt_reserve_xprt(struct rpc_task *task);
211int xprt_reserve_xprt_cong(struct rpc_task *task);
212int xprt_prepare_transmit(struct rpc_task *task);
213void xprt_transmit(struct rpc_task *task);
214void xprt_end_transmit(struct rpc_task *task);
215int xprt_adjust_timeout(struct rpc_rqst *req);
216void xprt_release_xprt(struct rpc_xprt *xprt, struct rpc_task *task);
217void xprt_release_xprt_cong(struct rpc_xprt *xprt, struct rpc_task *task);
218void xprt_release(struct rpc_task *task);
219struct rpc_xprt * xprt_get(struct rpc_xprt *xprt);
220void xprt_put(struct rpc_xprt *xprt);
221
222static inline __be32 *xprt_skip_transport_header(struct rpc_xprt *xprt, __be32 *p)
223{
224 return p + xprt->tsh_size;
225}
226
227/*
228 * Transport switch helper functions
229 */
230void xprt_set_retrans_timeout_def(struct rpc_task *task);
231void xprt_set_retrans_timeout_rtt(struct rpc_task *task);
232void xprt_wake_pending_tasks(struct rpc_xprt *xprt, int status);
233void xprt_wait_for_buffer_space(struct rpc_task *task);
234void xprt_write_space(struct rpc_xprt *xprt);
235void xprt_update_rtt(struct rpc_task *task);
236void xprt_adjust_cwnd(struct rpc_task *task, int result);
237struct rpc_rqst * xprt_lookup_rqst(struct rpc_xprt *xprt, __be32 xid);
238void xprt_complete_rqst(struct rpc_task *task, int copied);
239void xprt_release_rqst_cong(struct rpc_task *task);
240void xprt_disconnect(struct rpc_xprt *xprt);
241
242/*
243 * Socket transport setup operations
244 */
245struct rpc_xprt * xs_setup_udp(struct sockaddr *addr, size_t addrlen, struct rpc_timeout *to);
246struct rpc_xprt * xs_setup_tcp(struct sockaddr *addr, size_t addrlen, struct rpc_timeout *to);
247int init_socket_xprt(void);
248void cleanup_socket_xprt(void);
249
250/*
251 * Reserved bit positions in xprt->state
252 */
253#define XPRT_LOCKED (0)
254#define XPRT_CONNECTED (1)
255#define XPRT_CONNECTING (2)
256#define XPRT_CLOSE_WAIT (3)
257#define XPRT_BOUND (4)
258#define XPRT_BINDING (5)
259
260static inline void xprt_set_connected(struct rpc_xprt *xprt)
261{
262 set_bit(XPRT_CONNECTED, &xprt->state);
263}
264
265static inline void xprt_clear_connected(struct rpc_xprt *xprt)
266{
267 clear_bit(XPRT_CONNECTED, &xprt->state);
268}
269
270static inline int xprt_connected(struct rpc_xprt *xprt)
271{
272 return test_bit(XPRT_CONNECTED, &xprt->state);
273}
274
275static inline int xprt_test_and_set_connected(struct rpc_xprt *xprt)
276{
277 return test_and_set_bit(XPRT_CONNECTED, &xprt->state);
278}
279
280static inline int xprt_test_and_clear_connected(struct rpc_xprt *xprt)
281{
282 return test_and_clear_bit(XPRT_CONNECTED, &xprt->state);
283}
284
285static inline void xprt_clear_connecting(struct rpc_xprt *xprt)
286{
287 smp_mb__before_clear_bit();
288 clear_bit(XPRT_CONNECTING, &xprt->state);
289 smp_mb__after_clear_bit();
290}
291
292static inline int xprt_connecting(struct rpc_xprt *xprt)
293{
294 return test_bit(XPRT_CONNECTING, &xprt->state);
295}
296
297static inline int xprt_test_and_set_connecting(struct rpc_xprt *xprt)
298{
299 return test_and_set_bit(XPRT_CONNECTING, &xprt->state);
300}
301
302static inline void xprt_set_bound(struct rpc_xprt *xprt)
303{
304 test_and_set_bit(XPRT_BOUND, &xprt->state);
305}
306
307static inline int xprt_bound(struct rpc_xprt *xprt)
308{
309 return test_bit(XPRT_BOUND, &xprt->state);
310}
311
312static inline void xprt_clear_bound(struct rpc_xprt *xprt)
313{
314 clear_bit(XPRT_BOUND, &xprt->state);
315}
316
317static inline void xprt_clear_binding(struct rpc_xprt *xprt)
318{
319 smp_mb__before_clear_bit();
320 clear_bit(XPRT_BINDING, &xprt->state);
321 smp_mb__after_clear_bit();
322}
323
324static inline int xprt_test_and_set_binding(struct rpc_xprt *xprt)
325{
326 return test_and_set_bit(XPRT_BINDING, &xprt->state);
327}
328
329#endif /* __KERNEL__*/
330
331#endif /* _LINUX_SUNRPC_XPRT_H */