2990bfb12587ef3645bf2ecd440892d96e4f8f2c
[linux-2.6.git] / net / dccp / dccp.h
1 #ifndef _DCCP_H
2 #define _DCCP_H
3 /*
4  *  net/dccp/dccp.h
5  *
6  *  An implementation of the DCCP protocol
7  *  Copyright (c) 2005 Arnaldo Carvalho de Melo <acme@conectiva.com.br>
8  *  Copyright (c) 2005-6 Ian McDonald <ian.mcdonald@jandi.co.nz>
9  *
10  *      This program is free software; you can redistribute it and/or modify it
11  *      under the terms of the GNU General Public License version 2 as
12  *      published by the Free Software Foundation.
13  */
14
15 #include <linux/dccp.h>
16 #include <net/snmp.h>
17 #include <net/sock.h>
18 #include <net/tcp.h>
19 #include "ackvec.h"
20
21 #ifdef CONFIG_IP_DCCP_DEBUG
22 extern int dccp_debug;
23
24 #define dccp_pr_debug(format, a...) \
25         do { if (dccp_debug) \
26                 printk(KERN_DEBUG "%s: " format, __FUNCTION__ , ##a); \
27         } while (0)
28 #define dccp_pr_debug_cat(format, a...) do { if (dccp_debug) \
29                                              printk(format, ##a); } while (0)
30 #else
31 #define dccp_pr_debug(format, a...)
32 #define dccp_pr_debug_cat(format, a...)
33 #endif
34
35 extern struct inet_hashinfo dccp_hashinfo;
36
37 extern atomic_t dccp_orphan_count;
38
39 extern void dccp_time_wait(struct sock *sk, int state, int timeo);
40
41 /*
42  *  Set safe upper bounds for header and option length. Since Data Offset is 8
43  *  bits (RFC 4340, sec. 5.1), the total header length can never be more than
44  *  4 * 255 = 1020 bytes. The largest possible header length is 28 bytes (X=1):
45  *    - DCCP-Response with ACK Subheader and 4 bytes of Service code      OR
46  *    - DCCP-Reset    with ACK Subheader and 4 bytes of Reset Code fields
47  *  Hence a safe upper bound for the maximum option length is 1020-28 = 992
48  */
49 #define MAX_DCCP_SPECIFIC_HEADER (255 * sizeof(int))
50 #define DCCP_MAX_PACKET_HDR 28
51 #define DCCP_MAX_OPT_LEN (MAX_DCCP_SPECIFIC_HEADER - DCCP_MAX_PACKET_HDR)
52 #define MAX_DCCP_HEADER (MAX_DCCP_SPECIFIC_HEADER + MAX_HEADER)
53
54 #define DCCP_TIMEWAIT_LEN (60 * HZ) /* how long to wait to destroy TIME-WAIT
55                                      * state, about 60 seconds */
56
57 /* RFC 1122, 4.2.3.1 initial RTO value */
58 #define DCCP_TIMEOUT_INIT ((unsigned)(3 * HZ))
59
60 /* Maximal interval between probes for local resources.  */
61 #define DCCP_RESOURCE_PROBE_INTERVAL ((unsigned)(HZ / 2U))
62
63 #define DCCP_RTO_MAX ((unsigned)(120 * HZ)) /* FIXME: using TCP value */
64
65 #define DCCP_XMIT_TIMEO 30000 /* Time/msecs for blocking transmit per packet */
66
67 /* is seq1 < seq2 ? */
68 static inline int before48(const u64 seq1, const u64 seq2)
69 {
70         return (s64)((seq1 << 16) - (seq2 << 16)) < 0;
71 }
72
73 /* is seq1 > seq2 ? */
74 static inline int after48(const u64 seq1, const u64 seq2)
75 {
76         return (s64)((seq2 << 16) - (seq1 << 16)) < 0;
77 }
78
79 /* is seq2 <= seq1 <= seq3 ? */
80 static inline int between48(const u64 seq1, const u64 seq2, const u64 seq3)
81 {
82         return (seq3 << 16) - (seq2 << 16) >= (seq1 << 16) - (seq2 << 16);
83 }
84
85 static inline u64 max48(const u64 seq1, const u64 seq2)
86 {
87         return after48(seq1, seq2) ? seq1 : seq2;
88 }
89
90 /* is seq1 next seqno after seq2 */
91 static inline int follows48(const u64 seq1, const u64 seq2)
92 {
93         int diff = (seq1 & 0xFFFF) - (seq2 & 0xFFFF);
94
95         return diff==1;
96 }
97
98 enum {
99         DCCP_MIB_NUM = 0,
100         DCCP_MIB_ACTIVEOPENS,                   /* ActiveOpens */
101         DCCP_MIB_ESTABRESETS,                   /* EstabResets */
102         DCCP_MIB_CURRESTAB,                     /* CurrEstab */
103         DCCP_MIB_OUTSEGS,                       /* OutSegs */ 
104         DCCP_MIB_OUTRSTS,
105         DCCP_MIB_ABORTONTIMEOUT,
106         DCCP_MIB_TIMEOUTS,
107         DCCP_MIB_ABORTFAILED,
108         DCCP_MIB_PASSIVEOPENS,
109         DCCP_MIB_ATTEMPTFAILS,
110         DCCP_MIB_OUTDATAGRAMS,
111         DCCP_MIB_INERRS,
112         DCCP_MIB_OPTMANDATORYERROR,
113         DCCP_MIB_INVALIDOPT,
114         __DCCP_MIB_MAX
115 };
116
117 #define DCCP_MIB_MAX    __DCCP_MIB_MAX
118 struct dccp_mib {
119         unsigned long   mibs[DCCP_MIB_MAX];
120 } __SNMP_MIB_ALIGN__;
121
122 DECLARE_SNMP_STAT(struct dccp_mib, dccp_statistics);
123 #define DCCP_INC_STATS(field)       SNMP_INC_STATS(dccp_statistics, field)
124 #define DCCP_INC_STATS_BH(field)    SNMP_INC_STATS_BH(dccp_statistics, field)
125 #define DCCP_INC_STATS_USER(field)  SNMP_INC_STATS_USER(dccp_statistics, field)
126 #define DCCP_DEC_STATS(field)       SNMP_DEC_STATS(dccp_statistics, field)
127 #define DCCP_ADD_STATS_BH(field, val) \
128                         SNMP_ADD_STATS_BH(dccp_statistics, field, val)
129 #define DCCP_ADD_STATS_USER(field, val) \
130                         SNMP_ADD_STATS_USER(dccp_statistics, field, val)
131
132 extern int  dccp_retransmit_skb(struct sock *sk, struct sk_buff *skb);
133
134 extern void dccp_send_ack(struct sock *sk);
135 extern void dccp_send_delayed_ack(struct sock *sk);
136 extern void dccp_reqsk_send_ack(struct sk_buff *sk, struct request_sock *rsk);
137
138 extern void dccp_send_sync(struct sock *sk, const u64 seq,
139                            const enum dccp_pkt_type pkt_type);
140
141 extern void dccp_write_xmit(struct sock *sk, int block);
142 extern void dccp_write_space(struct sock *sk);
143
144 extern void dccp_init_xmit_timers(struct sock *sk);
145 static inline void dccp_clear_xmit_timers(struct sock *sk)
146 {
147         inet_csk_clear_xmit_timers(sk);
148 }
149
150 extern unsigned int dccp_sync_mss(struct sock *sk, u32 pmtu);
151
152 extern const char *dccp_packet_name(const int type);
153 extern const char *dccp_state_name(const int state);
154
155 extern void dccp_set_state(struct sock *sk, const int state);
156 extern void dccp_done(struct sock *sk);
157
158 extern void dccp_reqsk_init(struct request_sock *req, struct sk_buff *skb);
159
160 extern int dccp_v4_conn_request(struct sock *sk, struct sk_buff *skb);
161
162 extern struct sock *dccp_create_openreq_child(struct sock *sk,
163                                               const struct request_sock *req,
164                                               const struct sk_buff *skb);
165
166 extern int dccp_v4_do_rcv(struct sock *sk, struct sk_buff *skb);
167
168 extern struct sock *dccp_v4_request_recv_sock(struct sock *sk,
169                                               struct sk_buff *skb,
170                                               struct request_sock *req,
171                                               struct dst_entry *dst);
172 extern struct sock *dccp_check_req(struct sock *sk, struct sk_buff *skb,
173                                    struct request_sock *req,
174                                    struct request_sock **prev);
175
176 extern int dccp_child_process(struct sock *parent, struct sock *child,
177                               struct sk_buff *skb);
178 extern int dccp_rcv_state_process(struct sock *sk, struct sk_buff *skb,
179                                   struct dccp_hdr *dh, unsigned len);
180 extern int dccp_rcv_established(struct sock *sk, struct sk_buff *skb,
181                                 const struct dccp_hdr *dh, const unsigned len);
182
183 extern int dccp_init_sock(struct sock *sk, const __u8 ctl_sock_initialized);
184 extern int dccp_destroy_sock(struct sock *sk);
185
186 extern void             dccp_close(struct sock *sk, long timeout);
187 extern struct sk_buff   *dccp_make_response(struct sock *sk,
188                                             struct dst_entry *dst,
189                                             struct request_sock *req);
190
191 extern int         dccp_connect(struct sock *sk);
192 extern int         dccp_disconnect(struct sock *sk, int flags);
193 extern void        dccp_hash(struct sock *sk);
194 extern void        dccp_unhash(struct sock *sk);
195 extern int         dccp_getsockopt(struct sock *sk, int level, int optname,
196                                    char __user *optval, int __user *optlen);
197 extern int         dccp_setsockopt(struct sock *sk, int level, int optname,
198                                    char __user *optval, int optlen);
199 #ifdef CONFIG_COMPAT
200 extern int         compat_dccp_getsockopt(struct sock *sk,
201                                 int level, int optname,
202                                 char __user *optval, int __user *optlen);
203 extern int         compat_dccp_setsockopt(struct sock *sk,
204                                 int level, int optname,
205                                 char __user *optval, int optlen);
206 #endif
207 extern int         dccp_ioctl(struct sock *sk, int cmd, unsigned long arg);
208 extern int         dccp_sendmsg(struct kiocb *iocb, struct sock *sk,
209                                 struct msghdr *msg, size_t size);
210 extern int         dccp_recvmsg(struct kiocb *iocb, struct sock *sk,
211                                 struct msghdr *msg, size_t len, int nonblock,
212                                 int flags, int *addr_len);
213 extern void        dccp_shutdown(struct sock *sk, int how);
214 extern int         inet_dccp_listen(struct socket *sock, int backlog);
215 extern unsigned int dccp_poll(struct file *file, struct socket *sock,
216                              poll_table *wait);
217 extern void        dccp_v4_send_check(struct sock *sk, int len,
218                                       struct sk_buff *skb);
219 extern int         dccp_v4_connect(struct sock *sk, struct sockaddr *uaddr,
220                                    int addr_len);
221
222 extern int         dccp_v4_checksum(const struct sk_buff *skb,
223                                     const __be32 saddr, const __be32 daddr);
224
225 extern int         dccp_send_reset(struct sock *sk, enum dccp_reset_codes code);
226 extern void        dccp_send_close(struct sock *sk, const int active);
227 extern int         dccp_invalid_packet(struct sk_buff *skb);
228
229 static inline int dccp_bad_service_code(const struct sock *sk,
230                                         const __be32 service)
231 {
232         const struct dccp_sock *dp = dccp_sk(sk);
233
234         if (dp->dccps_service == service)
235                 return 0;
236         return !dccp_list_has_service(dp->dccps_service_list, service);
237 }
238
239 struct dccp_skb_cb {
240         __u8  dccpd_type:4;
241         __u8  dccpd_ccval:4;
242         __u8  dccpd_reset_code;
243         __u16 dccpd_opt_len;
244         __u64 dccpd_seq;
245         __u64 dccpd_ack_seq;
246 };
247
248 #define DCCP_SKB_CB(__skb) ((struct dccp_skb_cb *)&((__skb)->cb[0]))
249
250 static inline int dccp_non_data_packet(const struct sk_buff *skb)
251 {
252         const __u8 type = DCCP_SKB_CB(skb)->dccpd_type;
253
254         return type == DCCP_PKT_ACK      ||
255                type == DCCP_PKT_CLOSE    ||
256                type == DCCP_PKT_CLOSEREQ ||
257                type == DCCP_PKT_RESET    ||
258                type == DCCP_PKT_SYNC     ||
259                type == DCCP_PKT_SYNCACK;
260 }
261
262 static inline int dccp_packet_without_ack(const struct sk_buff *skb)
263 {
264         const __u8 type = DCCP_SKB_CB(skb)->dccpd_type;
265
266         return type == DCCP_PKT_DATA || type == DCCP_PKT_REQUEST;
267 }
268
269 #define DCCP_MAX_SEQNO ((((u64)1) << 48) - 1)
270 #define DCCP_PKT_WITHOUT_ACK_SEQ (DCCP_MAX_SEQNO << 2)
271
272 static inline void dccp_set_seqno(u64 *seqno, u64 value)
273 {
274         if (value > DCCP_MAX_SEQNO)
275                 value -= DCCP_MAX_SEQNO + 1;
276         *seqno = value;
277 }
278
279 static inline u64 dccp_delta_seqno(u64 seqno1, u64 seqno2)
280 {
281         return ((seqno2 << 16) - (seqno1 << 16)) >> 16;
282 }
283
284 static inline void dccp_inc_seqno(u64 *seqno)
285 {
286         if (++*seqno > DCCP_MAX_SEQNO)
287                 *seqno = 0;
288 }
289
290 static inline void dccp_hdr_set_seq(struct dccp_hdr *dh, const u64 gss)
291 {
292         struct dccp_hdr_ext *dhx = (struct dccp_hdr_ext *)((void *)dh +
293                                                            sizeof(*dh));
294         dh->dccph_seq2 = 0;
295         dh->dccph_seq = htons((gss >> 32) & 0xfffff);
296         dhx->dccph_seq_low = htonl(gss & 0xffffffff);
297 }
298
299 static inline void dccp_hdr_set_ack(struct dccp_hdr_ack_bits *dhack,
300                                     const u64 gsr)
301 {
302         dhack->dccph_reserved1 = 0;
303         dhack->dccph_ack_nr_high = htons(gsr >> 32);
304         dhack->dccph_ack_nr_low  = htonl(gsr & 0xffffffff);
305 }
306
307 static inline void dccp_update_gsr(struct sock *sk, u64 seq)
308 {
309         struct dccp_sock *dp = dccp_sk(sk);
310         const struct dccp_minisock *dmsk = dccp_msk(sk);
311
312         dp->dccps_gsr = seq;
313         dccp_set_seqno(&dp->dccps_swl,
314                        dp->dccps_gsr + 1 - (dmsk->dccpms_sequence_window / 4));
315         dccp_set_seqno(&dp->dccps_swh,
316                        dp->dccps_gsr + (3 * dmsk->dccpms_sequence_window) / 4);
317 }
318
319 static inline void dccp_update_gss(struct sock *sk, u64 seq)
320 {
321         struct dccp_sock *dp = dccp_sk(sk);
322
323         dp->dccps_awh = dp->dccps_gss = seq;
324         dccp_set_seqno(&dp->dccps_awl,
325                        (dp->dccps_gss -
326                         dccp_msk(sk)->dccpms_sequence_window + 1));
327 }
328                                 
329 static inline int dccp_ack_pending(const struct sock *sk)
330 {
331         const struct dccp_sock *dp = dccp_sk(sk);
332         return dp->dccps_timestamp_echo != 0 ||
333 #ifdef CONFIG_IP_DCCP_ACKVEC
334                (dccp_msk(sk)->dccpms_send_ack_vector &&
335                 dccp_ackvec_pending(dp->dccps_hc_rx_ackvec)) ||
336 #endif
337                inet_csk_ack_scheduled(sk);
338 }
339
340 extern int dccp_insert_options(struct sock *sk, struct sk_buff *skb);
341 extern int dccp_insert_option_elapsed_time(struct sock *sk,
342                                             struct sk_buff *skb,
343                                             u32 elapsed_time);
344 extern int dccp_insert_option_timestamp(struct sock *sk,
345                                          struct sk_buff *skb);
346 extern int dccp_insert_option(struct sock *sk, struct sk_buff *skb,
347                                unsigned char option,
348                                const void *value, unsigned char len);
349
350 extern void dccp_timestamp(const struct sock *sk, struct timeval *tv);
351
352 static inline suseconds_t timeval_usecs(const struct timeval *tv)
353 {
354         return tv->tv_sec * USEC_PER_SEC + tv->tv_usec;
355 }
356
357 static inline suseconds_t timeval_delta(const struct timeval *large,
358                                         const struct timeval *small)
359 {
360         time_t      secs  = large->tv_sec  - small->tv_sec;
361         suseconds_t usecs = large->tv_usec - small->tv_usec;
362
363         if (usecs < 0) {
364                 secs--;
365                 usecs += USEC_PER_SEC;
366         }
367         return secs * USEC_PER_SEC + usecs;
368 }
369
370 static inline void timeval_add_usecs(struct timeval *tv,
371                                      const suseconds_t usecs)
372 {
373         tv->tv_usec += usecs;
374         while (tv->tv_usec >= USEC_PER_SEC) {
375                 tv->tv_sec++;
376                 tv->tv_usec -= USEC_PER_SEC;
377         }
378 }
379
380 static inline void timeval_sub_usecs(struct timeval *tv,
381                                      const suseconds_t usecs)
382 {
383         tv->tv_usec -= usecs;
384         while (tv->tv_usec < 0) {
385                 tv->tv_sec--;
386                 tv->tv_usec += USEC_PER_SEC;
387         }
388 }
389
390 #ifdef CONFIG_SYSCTL
391 extern int dccp_sysctl_init(void);
392 extern void dccp_sysctl_exit(void);
393 #else
394 static inline int dccp_sysctl_init(void)
395 {
396         return 0;
397 }
398
399 static inline void dccp_sysctl_exit(void)
400 {
401 }
402 #endif
403
404 #endif /* _DCCP_H */