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/sunrpc/sched.h>
16#include <linux/sunrpc/xdr.h>
17
18extern unsigned int xprt_udp_slot_table_entries;
19extern unsigned int xprt_tcp_slot_table_entries;
20
21#define RPC_MIN_SLOT_TABLE (2U)
22#define RPC_DEF_SLOT_TABLE (16U)
23#define RPC_MAX_SLOT_TABLE (128U)
24
25/*
26 * RPC call and reply header size as number of 32bit words (verifier
27 * size computed separately)
28 */
29#define RPC_CALLHDRSIZE 6
30#define RPC_REPHDRSIZE 4
31
32/*
33 * Parameters for choosing a free port
34 */
35extern unsigned int xprt_min_resvport;
36extern unsigned int xprt_max_resvport;
37
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)
42
43/*
44 * This describes a timeout strategy
45 */
46struct rpc_timeout {
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;
52};
53
54struct rpc_task;
55struct rpc_xprt;
56
57/*
58 * This describes a complete RPC request
59 */
60struct rpc_rqst {
61 /*
62 * This is the user-visible part
63 */
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 */
67
68 /*
69 * This is the private part
70 */
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. */
76 int rq_enc_pages_num;
77 struct page **rq_enc_pages; /* scratch pages for use by
78 gss privacy code */
79 void (*rq_release_snd_buf)(struct rpc_rqst *); /* release rq_enc_pages */
80 struct list_head rq_list;
81
82 __u32 * rq_buffer; /* XDR encode buffer */
83 size_t rq_bufsize;
84
85 struct xdr_buf rq_private_buf; /* The receive buffer
86 * used in the softirq.
87 */
88 unsigned long rq_majortimeo; /* major timeout alarm */
89 unsigned long rq_timeout; /* Current timeout value */
90 unsigned int rq_retries; /* # of retries */
91
92 /*
93 * Partial send handling
94 */
95 u32 rq_bytes_sent; /* Bytes we have sent */
96
97 unsigned long rq_xtime; /* when transmitted */
98 int rq_ntrans;
99};
100#define rq_svec rq_snd_buf.head
101#define rq_slen rq_snd_buf.len
102
103struct 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};
118
119struct rpc_xprt {
120 struct rpc_xprt_ops * ops; /* transport methods */
121 struct socket * sock; /* BSD socket layer */
122 struct sock * inet; /* INET layer */
123
124 struct rpc_timeout timeout; /* timeout parms */
125 struct sockaddr_in addr; /* server address */
126 int prot; /* IP protocol */
127
128 unsigned long cong; /* current congestion */
129 unsigned long cwnd; /* congestion window */
130
131 size_t rcvsize, /* transport rcv buffer size */
132 sndsize; /* transport send buffer size */
133
134 size_t max_payload; /* largest RPC payload size,
135 in bytes */
136 unsigned int tsh_size; /* size of transport specific
137 header */
138
139 struct rpc_wait_queue sending; /* requests waiting to send */
140 struct rpc_wait_queue resend; /* requests waiting to resend */
141 struct rpc_wait_queue pending; /* requests in flight */
142 struct rpc_wait_queue backlog; /* waiting for slot */
143 struct list_head free; /* free slots */
144 struct rpc_rqst * slot; /* slot table storage */
145 unsigned int max_reqs; /* total slots */
146 unsigned long state; /* transport state */
147 unsigned char shutdown : 1, /* being shut down */
148 resvport : 1; /* use a reserved port */
149
150 /*
151 * XID
152 */
153 __u32 xid; /* Next XID value to use */
154
155 /*
156 * State of TCP reply receive stuff
157 */
158 u32 tcp_recm, /* Fragment header */
159 tcp_xid, /* Current XID */
160 tcp_reclen, /* fragment length */
161 tcp_offset; /* fragment offset */
162 unsigned long tcp_copied, /* copied to request */
163 tcp_flags;
164 /*
165 * Connection of transports
166 */
167 unsigned long connect_timeout,
168 bind_timeout,
169 reestablish_timeout;
170 struct work_struct connect_worker;
171 unsigned short port;
172
173 /*
174 * Disconnection of idle transports
175 */
176 struct work_struct task_cleanup;
177 struct timer_list timer;
178 unsigned long last_used,
179 idle_timeout;
180
181 /*
182 * Send stuff
183 */
184 spinlock_t transport_lock; /* lock transport info */
185 spinlock_t reserve_lock; /* lock slot table */
186 struct rpc_task * snd_task; /* Task blocked in send */
187
188 struct list_head recv;
189
190
191 void (*old_data_ready)(struct sock *, int);
192 void (*old_state_change)(struct sock *);
193 void (*old_write_space)(struct sock *);
194};
195
196#define XPRT_LAST_FRAG (1 << 0)
197#define XPRT_COPY_RECM (1 << 1)
198#define XPRT_COPY_XID (1 << 2)
199#define XPRT_COPY_DATA (1 << 3)
200
201#ifdef __KERNEL__
202
203/*
204 * Transport operations used by ULPs
205 */
206struct rpc_xprt * xprt_create_proto(int proto, struct sockaddr_in *addr, struct rpc_timeout *to);
207void xprt_set_timeout(struct rpc_timeout *to, unsigned int retr, unsigned long incr);
208
209/*
210 * Generic internal transport functions
211 */
212void xprt_connect(struct rpc_task *task);
213void xprt_reserve(struct rpc_task *task);
214int xprt_reserve_xprt(struct rpc_task *task);
215int xprt_reserve_xprt_cong(struct rpc_task *task);
216int xprt_prepare_transmit(struct rpc_task *task);
217void xprt_transmit(struct rpc_task *task);
218void xprt_abort_transmit(struct rpc_task *task);
219int xprt_adjust_timeout(struct rpc_rqst *req);
220void xprt_release_xprt(struct rpc_xprt *xprt, struct rpc_task *task);
221void xprt_release_xprt_cong(struct rpc_xprt *xprt, struct rpc_task *task);
222void xprt_release(struct rpc_task *task);
223int xprt_destroy(struct rpc_xprt *xprt);
224
225static inline u32 *xprt_skip_transport_header(struct rpc_xprt *xprt, u32 *p)
226{
227 return p + xprt->tsh_size;
228}
229
230/*
231 * Transport switch helper functions
232 */
233void xprt_set_retrans_timeout_def(struct rpc_task *task);
234void xprt_set_retrans_timeout_rtt(struct rpc_task *task);
235void xprt_wake_pending_tasks(struct rpc_xprt *xprt, int status);
236void xprt_wait_for_buffer_space(struct rpc_task *task);
237void xprt_write_space(struct rpc_xprt *xprt);
238void xprt_update_rtt(struct rpc_task *task);
239void xprt_adjust_cwnd(struct rpc_task *task, int result);
240struct rpc_rqst * xprt_lookup_rqst(struct rpc_xprt *xprt, u32 xid);
241void xprt_complete_rqst(struct rpc_task *task, int copied);
242void xprt_release_rqst_cong(struct rpc_task *task);
243void xprt_disconnect(struct rpc_xprt *xprt);
244
245/*
246 * Socket transport setup operations
247 */
248int xs_setup_udp(struct rpc_xprt *xprt, struct rpc_timeout *to);
249int xs_setup_tcp(struct rpc_xprt *xprt, struct rpc_timeout *to);
250
251/*
252 * Reserved bit positions in xprt->state
253 */
254#define XPRT_LOCKED (0)
255#define XPRT_CONNECTED (1)
256#define XPRT_CONNECTING (2)
257#define XPRT_CLOSE_WAIT (3)
258
259static inline void xprt_set_connected(struct rpc_xprt *xprt)
260{
261 set_bit(XPRT_CONNECTED, &xprt->state);
262}
263
264static inline void xprt_clear_connected(struct rpc_xprt *xprt)
265{
266 clear_bit(XPRT_CONNECTED, &xprt->state);
267}
268
269static inline int xprt_connected(struct rpc_xprt *xprt)
270{
271 return test_bit(XPRT_CONNECTED, &xprt->state);
272}
273
274static inline int xprt_test_and_set_connected(struct rpc_xprt *xprt)
275{
276 return test_and_set_bit(XPRT_CONNECTED, &xprt->state);
277}
278
279static inline int xprt_test_and_clear_connected(struct rpc_xprt *xprt)
280{
281 return test_and_clear_bit(XPRT_CONNECTED, &xprt->state);
282}
283
284static inline void xprt_clear_connecting(struct rpc_xprt *xprt)
285{
286 smp_mb__before_clear_bit();
287 clear_bit(XPRT_CONNECTING, &xprt->state);
288 smp_mb__after_clear_bit();
289}
290
291static inline int xprt_connecting(struct rpc_xprt *xprt)
292{
293 return test_bit(XPRT_CONNECTING, &xprt->state);
294}
295
296static inline int xprt_test_and_set_connecting(struct rpc_xprt *xprt)
297{
298 return test_and_set_bit(XPRT_CONNECTING, &xprt->state);
299}
300
301#endif /* __KERNEL__*/
302
303#endif /* _LINUX_SUNRPC_XPRT_H */