SUNRPC: remove extraneous header inclusions
[linux-2.6.git] / include / linux / sunrpc / xprt.h
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
18 extern unsigned int xprt_udp_slot_table_entries;
19 extern 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  */
35 extern unsigned int xprt_min_resvport;
36 extern unsigned int xprt_max_resvport;
37
38 #define RPC_MIN_RESVPORT        (1U)
39 #define RPC_MAX_RESVPORT        (65535U)
40 #define RPC_DEF_MIN_RESVPORT    (665U)
41 #define RPC_DEF_MAX_RESVPORT    (1023U)
42
43 /*
44  * This describes a timeout strategy
45  */
46 struct 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
54 struct rpc_task;
55 struct rpc_xprt;
56 struct seq_file;
57
58 /*
59  * This describes a complete RPC request
60  */
61 struct rpc_rqst {
62         /*
63          * This is the user-visible part
64          */
65         struct rpc_xprt *       rq_xprt;                /* RPC client */
66         struct xdr_buf          rq_snd_buf;             /* send buffer */
67         struct xdr_buf          rq_rcv_buf;             /* recv buffer */
68
69         /*
70          * This is the private part
71          */
72         struct rpc_task *       rq_task;        /* RPC task data */
73         __u32                   rq_xid;         /* request XID */
74         int                     rq_cong;        /* has incremented xprt->cong */
75         int                     rq_received;    /* receive completed */
76         u32                     rq_seqno;       /* gss seq no. used on req. */
77         int                     rq_enc_pages_num;
78         struct page             **rq_enc_pages; /* scratch pages for use by
79                                                    gss privacy code */
80         void (*rq_release_snd_buf)(struct rpc_rqst *); /* release rq_enc_pages */
81         struct list_head        rq_list;
82
83         __u32 *                 rq_buffer;      /* XDR encode buffer */
84         size_t                  rq_bufsize;
85
86         struct xdr_buf          rq_private_buf;         /* The receive buffer
87                                                          * used in the softirq.
88                                                          */
89         unsigned long           rq_majortimeo;  /* major timeout alarm */
90         unsigned long           rq_timeout;     /* Current timeout value */
91         unsigned int            rq_retries;     /* # of retries */
92         
93         /*
94          * Partial send handling
95          */
96         u32                     rq_bytes_sent;  /* Bytes we have sent */
97
98         unsigned long           rq_xtime;       /* when transmitted */
99         int                     rq_ntrans;
100 };
101 #define rq_svec                 rq_snd_buf.head
102 #define rq_slen                 rq_snd_buf.len
103
104 struct rpc_xprt_ops {
105         void            (*set_buffer_size)(struct rpc_xprt *xprt, size_t sndsize, size_t rcvsize);
106         int             (*reserve_xprt)(struct rpc_task *task);
107         void            (*release_xprt)(struct rpc_xprt *xprt, struct rpc_task *task);
108         void            (*rpcbind)(struct rpc_task *task);
109         void            (*set_port)(struct rpc_xprt *xprt, unsigned short port);
110         void            (*connect)(struct rpc_task *task);
111         void *          (*buf_alloc)(struct rpc_task *task, size_t size);
112         void            (*buf_free)(struct rpc_task *task);
113         int             (*send_request)(struct rpc_task *task);
114         void            (*set_retrans_timeout)(struct rpc_task *task);
115         void            (*timer)(struct rpc_task *task);
116         void            (*release_request)(struct rpc_task *task);
117         void            (*close)(struct rpc_xprt *xprt);
118         void            (*destroy)(struct rpc_xprt *xprt);
119         void            (*print_stats)(struct rpc_xprt *xprt, struct seq_file *seq);
120 };
121
122 struct rpc_xprt {
123         struct rpc_xprt_ops *   ops;            /* transport methods */
124         struct socket *         sock;           /* BSD socket layer */
125         struct sock *           inet;           /* INET layer */
126
127         struct rpc_timeout      timeout;        /* timeout parms */
128         struct sockaddr_in      addr;           /* server address */
129         int                     prot;           /* IP protocol */
130
131         unsigned long           cong;           /* current congestion */
132         unsigned long           cwnd;           /* congestion window */
133
134         size_t                  rcvsize,        /* transport rcv buffer size */
135                                 sndsize;        /* transport send buffer size */
136
137         size_t                  max_payload;    /* largest RPC payload size,
138                                                    in bytes */
139         unsigned int            tsh_size;       /* size of transport specific
140                                                    header */
141
142         struct rpc_wait_queue   binding;        /* requests waiting on rpcbind */
143         struct rpc_wait_queue   sending;        /* requests waiting to send */
144         struct rpc_wait_queue   resend;         /* requests waiting to resend */
145         struct rpc_wait_queue   pending;        /* requests in flight */
146         struct rpc_wait_queue   backlog;        /* waiting for slot */
147         struct list_head        free;           /* free slots */
148         struct rpc_rqst *       slot;           /* slot table storage */
149         unsigned int            max_reqs;       /* total slots */
150         unsigned long           state;          /* transport state */
151         unsigned char           shutdown   : 1, /* being shut down */
152                                 resvport   : 1; /* use a reserved port */
153
154         /*
155          * XID
156          */
157         __u32                   xid;            /* Next XID value to use */
158
159         /*
160          * State of TCP reply receive stuff
161          */
162         u32                     tcp_recm,       /* Fragment header */
163                                 tcp_xid,        /* Current XID */
164                                 tcp_reclen,     /* fragment length */
165                                 tcp_offset;     /* fragment offset */
166         unsigned long           tcp_copied,     /* copied to request */
167                                 tcp_flags;
168         /*
169          * Connection of transports
170          */
171         unsigned long           connect_timeout,
172                                 bind_timeout,
173                                 reestablish_timeout;
174         struct work_struct      connect_worker;
175         unsigned short          port;
176
177         /*
178          * Disconnection of idle transports
179          */
180         struct work_struct      task_cleanup;
181         struct timer_list       timer;
182         unsigned long           last_used,
183                                 idle_timeout;
184
185         /*
186          * Send stuff
187          */
188         spinlock_t              transport_lock; /* lock transport info */
189         spinlock_t              reserve_lock;   /* lock slot table */
190         struct rpc_task *       snd_task;       /* Task blocked in send */
191
192         struct list_head        recv;
193
194         struct {
195                 unsigned long           bind_count,     /* total number of binds */
196                                         connect_count,  /* total number of connects */
197                                         connect_start,  /* connect start timestamp */
198                                         connect_time,   /* jiffies waiting for connect */
199                                         sends,          /* how many complete requests */
200                                         recvs,          /* how many complete requests */
201                                         bad_xids;       /* lookup_rqst didn't find XID */
202
203                 unsigned long long      req_u,          /* average requests on the wire */
204                                         bklog_u;        /* backlog queue utilization */
205         } stat;
206
207         void                    (*old_data_ready)(struct sock *, int);
208         void                    (*old_state_change)(struct sock *);
209         void                    (*old_write_space)(struct sock *);
210 };
211
212 #define XPRT_LAST_FRAG          (1 << 0)
213 #define XPRT_COPY_RECM          (1 << 1)
214 #define XPRT_COPY_XID           (1 << 2)
215 #define XPRT_COPY_DATA          (1 << 3)
216
217 #ifdef __KERNEL__
218
219 /*
220  * Transport operations used by ULPs
221  */
222 struct rpc_xprt *       xprt_create_proto(int proto, struct sockaddr_in *addr, struct rpc_timeout *to);
223 void                    xprt_set_timeout(struct rpc_timeout *to, unsigned int retr, unsigned long incr);
224
225 /*
226  * Generic internal transport functions
227  */
228 void                    xprt_connect(struct rpc_task *task);
229 void                    xprt_reserve(struct rpc_task *task);
230 int                     xprt_reserve_xprt(struct rpc_task *task);
231 int                     xprt_reserve_xprt_cong(struct rpc_task *task);
232 int                     xprt_prepare_transmit(struct rpc_task *task);
233 void                    xprt_transmit(struct rpc_task *task);
234 void                    xprt_end_transmit(struct rpc_task *task);
235 int                     xprt_adjust_timeout(struct rpc_rqst *req);
236 void                    xprt_release_xprt(struct rpc_xprt *xprt, struct rpc_task *task);
237 void                    xprt_release_xprt_cong(struct rpc_xprt *xprt, struct rpc_task *task);
238 void                    xprt_release(struct rpc_task *task);
239 int                     xprt_destroy(struct rpc_xprt *xprt);
240
241 static inline u32 *xprt_skip_transport_header(struct rpc_xprt *xprt, u32 *p)
242 {
243         return p + xprt->tsh_size;
244 }
245
246 /*
247  * Transport switch helper functions
248  */
249 void                    xprt_set_retrans_timeout_def(struct rpc_task *task);
250 void                    xprt_set_retrans_timeout_rtt(struct rpc_task *task);
251 void                    xprt_wake_pending_tasks(struct rpc_xprt *xprt, int status);
252 void                    xprt_wait_for_buffer_space(struct rpc_task *task);
253 void                    xprt_write_space(struct rpc_xprt *xprt);
254 void                    xprt_update_rtt(struct rpc_task *task);
255 void                    xprt_adjust_cwnd(struct rpc_task *task, int result);
256 struct rpc_rqst *       xprt_lookup_rqst(struct rpc_xprt *xprt, u32 xid);
257 void                    xprt_complete_rqst(struct rpc_task *task, int copied);
258 void                    xprt_release_rqst_cong(struct rpc_task *task);
259 void                    xprt_disconnect(struct rpc_xprt *xprt);
260
261 /*
262  * Socket transport setup operations
263  */
264 int                     xs_setup_udp(struct rpc_xprt *xprt, struct rpc_timeout *to);
265 int                     xs_setup_tcp(struct rpc_xprt *xprt, struct rpc_timeout *to);
266
267 /*
268  * Reserved bit positions in xprt->state
269  */
270 #define XPRT_LOCKED             (0)
271 #define XPRT_CONNECTED          (1)
272 #define XPRT_CONNECTING         (2)
273 #define XPRT_CLOSE_WAIT         (3)
274 #define XPRT_BOUND              (4)
275 #define XPRT_BINDING            (5)
276
277 static inline void xprt_set_connected(struct rpc_xprt *xprt)
278 {
279         set_bit(XPRT_CONNECTED, &xprt->state);
280 }
281
282 static inline void xprt_clear_connected(struct rpc_xprt *xprt)
283 {
284         clear_bit(XPRT_CONNECTED, &xprt->state);
285 }
286
287 static inline int xprt_connected(struct rpc_xprt *xprt)
288 {
289         return test_bit(XPRT_CONNECTED, &xprt->state);
290 }
291
292 static inline int xprt_test_and_set_connected(struct rpc_xprt *xprt)
293 {
294         return test_and_set_bit(XPRT_CONNECTED, &xprt->state);
295 }
296
297 static inline int xprt_test_and_clear_connected(struct rpc_xprt *xprt)
298 {
299         return test_and_clear_bit(XPRT_CONNECTED, &xprt->state);
300 }
301
302 static inline void xprt_clear_connecting(struct rpc_xprt *xprt)
303 {
304         smp_mb__before_clear_bit();
305         clear_bit(XPRT_CONNECTING, &xprt->state);
306         smp_mb__after_clear_bit();
307 }
308
309 static inline int xprt_connecting(struct rpc_xprt *xprt)
310 {
311         return test_bit(XPRT_CONNECTING, &xprt->state);
312 }
313
314 static inline int xprt_test_and_set_connecting(struct rpc_xprt *xprt)
315 {
316         return test_and_set_bit(XPRT_CONNECTING, &xprt->state);
317 }
318
319 static inline void xprt_set_bound(struct rpc_xprt *xprt)
320 {
321         test_and_set_bit(XPRT_BOUND, &xprt->state);
322 }
323
324 static inline int xprt_bound(struct rpc_xprt *xprt)
325 {
326         return test_bit(XPRT_BOUND, &xprt->state);
327 }
328
329 static inline void xprt_clear_bound(struct rpc_xprt *xprt)
330 {
331         clear_bit(XPRT_BOUND, &xprt->state);
332 }
333
334 static inline void xprt_clear_binding(struct rpc_xprt *xprt)
335 {
336         smp_mb__before_clear_bit();
337         clear_bit(XPRT_BINDING, &xprt->state);
338         smp_mb__after_clear_bit();
339 }
340
341 static inline int xprt_test_and_set_binding(struct rpc_xprt *xprt)
342 {
343         return test_and_set_bit(XPRT_BINDING, &xprt->state);
344 }
345
346 #endif /* __KERNEL__*/
347
348 #endif /* _LINUX_SUNRPC_XPRT_H */