]> bbs.cooldavid.org Git - net-next-2.6.git/blame - net/dccp/dccp.h
dccp: Minimise header option overhead in setting the MPS
[net-next-2.6.git] / net / dccp / dccp.h
CommitLineData
7c657876
ACM
1#ifndef _DCCP_H
2#define _DCCP_H
3/*
4 * net/dccp/dccp.h
5 *
6 * An implementation of the DCCP protocol
1bc09869 7 * Copyright (c) 2005 Arnaldo Carvalho de Melo <acme@conectiva.com.br>
e6bccd35 8 * Copyright (c) 2005-6 Ian McDonald <ian.mcdonald@jandi.co.nz>
7c657876
ACM
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>
9823b7b5 16#include <linux/ktime.h>
7c657876
ACM
17#include <net/snmp.h>
18#include <net/sock.h>
19#include <net/tcp.h>
ae31c339 20#include "ackvec.h"
7c657876 21
59348b19
GR
22/*
23 * DCCP - specific warning and debugging macros.
24 */
25#define DCCP_WARN(fmt, a...) LIMIT_NETDEBUG(KERN_WARNING "%s: " fmt, \
0dc47877 26 __func__, ##a)
59348b19 27#define DCCP_CRIT(fmt, a...) printk(KERN_CRIT fmt " at %s:%d/%s()\n", ##a, \
0dc47877 28 __FILE__, __LINE__, __func__)
59348b19
GR
29#define DCCP_BUG(a...) do { DCCP_CRIT("BUG: " a); dump_stack(); } while(0)
30#define DCCP_BUG_ON(cond) do { if (unlikely((cond) != 0)) \
31 DCCP_BUG("\"%s\" holds (exception!)", \
32 __stringify(cond)); \
3c695262
GR
33 } while (0)
34
84116716
GR
35#define DCCP_PRINTK(enable, fmt, args...) do { if (enable) \
36 printk(fmt, ##args); \
c9eaf173 37 } while(0)
84116716 38#define DCCP_PR_DEBUG(enable, fmt, a...) DCCP_PRINTK(enable, KERN_DEBUG \
0dc47877 39 "%s: " fmt, __func__, ##a)
84116716 40
725ba8ee 41#ifdef CONFIG_IP_DCCP_DEBUG
7c657876 42extern int dccp_debug;
84116716
GR
43#define dccp_pr_debug(format, a...) DCCP_PR_DEBUG(dccp_debug, format, ##a)
44#define dccp_pr_debug_cat(format, a...) DCCP_PRINTK(dccp_debug, format, ##a)
f3f3abb6 45#define dccp_debug(fmt, a...) dccp_pr_debug_cat(KERN_DEBUG fmt, ##a)
7c657876
ACM
46#else
47#define dccp_pr_debug(format, a...)
48#define dccp_pr_debug_cat(format, a...)
f3f3abb6 49#define dccp_debug(format, a...)
7c657876
ACM
50#endif
51
52extern struct inet_hashinfo dccp_hashinfo;
53
dd24c001 54extern struct percpu_counter dccp_orphan_count;
7c657876
ACM
55
56extern void dccp_time_wait(struct sock *sk, int state, int timeo);
57
60361be1
GR
58/*
59 * Set safe upper bounds for header and option length. Since Data Offset is 8
60 * bits (RFC 4340, sec. 5.1), the total header length can never be more than
61 * 4 * 255 = 1020 bytes. The largest possible header length is 28 bytes (X=1):
62 * - DCCP-Response with ACK Subheader and 4 bytes of Service code OR
63 * - DCCP-Reset with ACK Subheader and 4 bytes of Reset Code fields
64 * Hence a safe upper bound for the maximum option length is 1020-28 = 992
65 */
66#define MAX_DCCP_SPECIFIC_HEADER (255 * sizeof(int))
67#define DCCP_MAX_PACKET_HDR 28
68#define DCCP_MAX_OPT_LEN (MAX_DCCP_SPECIFIC_HEADER - DCCP_MAX_PACKET_HDR)
69#define MAX_DCCP_HEADER (MAX_DCCP_SPECIFIC_HEADER + MAX_HEADER)
7c657876
ACM
70
71#define DCCP_TIMEWAIT_LEN (60 * HZ) /* how long to wait to destroy TIME-WAIT
72 * state, about 60 seconds */
73
0e64e94e 74/* RFC 1122, 4.2.3.1 initial RTO value */
7c657876
ACM
75#define DCCP_TIMEOUT_INIT ((unsigned)(3 * HZ))
76
28be5440
GR
77/*
78 * The maximum back-off value for retransmissions. This is needed for
79 * - retransmitting client-Requests (sec. 8.1.1),
80 * - retransmitting Close/CloseReq when closing (sec. 8.3),
81 * - feature-negotiation retransmission (sec. 6.6.3),
82 * - Acks in client-PARTOPEN state (sec. 8.1.5).
83 */
84#define DCCP_RTO_MAX ((unsigned)(64 * HZ))
4712a792 85
954c2db8
GR
86/*
87 * RTT sampling: sanity bounds and fallback RTT value from RFC 4340, section 3.4
88 */
4712a792 89#define DCCP_SANE_RTT_MIN 100
954c2db8
GR
90#define DCCP_FALLBACK_RTT (USEC_PER_SEC / 5)
91#define DCCP_SANE_RTT_MAX (3 * USEC_PER_SEC)
4712a792 92
7c657876
ACM
93/* Maximal interval between probes for local resources. */
94#define DCCP_RESOURCE_PROBE_INTERVAL ((unsigned)(HZ / 2U))
95
2e2e9e92
GR
96/* sysctl variables for DCCP */
97extern int sysctl_dccp_request_retries;
98extern int sysctl_dccp_retries1;
99extern int sysctl_dccp_retries2;
b1308dc0 100extern int sysctl_dccp_tx_qlen;
a94f0f97 101extern int sysctl_dccp_sync_ratelimit;
2e2e9e92 102
6b811d43
GR
103/*
104 * 48-bit sequence number arithmetic (signed and unsigned)
105 */
106#define INT48_MIN 0x800000000000LL /* 2^47 */
107#define UINT48_MAX 0xFFFFFFFFFFFFLL /* 2^48 - 1 */
108#define COMPLEMENT48(x) (0x1000000000000LL - (x)) /* 2^48 - x */
109#define TO_SIGNED48(x) (((x) < INT48_MIN)? (x) : -COMPLEMENT48( (x)))
110#define TO_UNSIGNED48(x) (((x) >= 0)? (x) : COMPLEMENT48(-(x)))
111#define ADD48(a, b) (((a) + (b)) & UINT48_MAX)
112#define SUB48(a, b) ADD48((a), COMPLEMENT48(b))
113
114static inline void dccp_set_seqno(u64 *seqno, u64 value)
115{
116 *seqno = value & UINT48_MAX;
117}
118
119static inline void dccp_inc_seqno(u64 *seqno)
120{
121 *seqno = ADD48(*seqno, 1);
122}
123
0aec51c8
GR
124/* signed mod-2^48 distance: pos. if seqno1 < seqno2, neg. if seqno1 > seqno2 */
125static inline s64 dccp_delta_seqno(const u64 seqno1, const u64 seqno2)
6b811d43 126{
0aec51c8
GR
127 u64 delta = SUB48(seqno2, seqno1);
128
129 return TO_SIGNED48(delta);
6b811d43
GR
130}
131
7c657876 132/* is seq1 < seq2 ? */
a10cedd4 133static inline int before48(const u64 seq1, const u64 seq2)
7c657876 134{
d52de17b 135 return (s64)((seq2 << 16) - (seq1 << 16)) > 0;
7c657876
ACM
136}
137
138/* is seq1 > seq2 ? */
d52de17b 139#define after48(seq1, seq2) before48(seq2, seq1)
7c657876
ACM
140
141/* is seq2 <= seq1 <= seq3 ? */
a10cedd4 142static inline int between48(const u64 seq1, const u64 seq2, const u64 seq3)
7c657876
ACM
143{
144 return (seq3 << 16) - (seq2 << 16) >= (seq1 << 16) - (seq2 << 16);
145}
146
147static inline u64 max48(const u64 seq1, const u64 seq2)
148{
149 return after48(seq1, seq2) ? seq1 : seq2;
150}
151
2013c7e3
GR
152/**
153 * dccp_loss_free - Evaluates condition for data loss from RFC 4340, 7.7.1
154 * @s1: start sequence number
155 * @s2: end sequence number
156 * @ndp: NDP count on packet with sequence number @s2
157 * Returns true if the sequence range s1...s2 has no data loss.
158 */
159static inline bool dccp_loss_free(const u64 s1, const u64 s2, const u64 ndp)
160{
161 s64 delta = dccp_delta_seqno(s1, s2);
162
547b792c 163 WARN_ON(delta < 0);
2013c7e3
GR
164 return (u64)delta <= ndp + 1;
165}
166
7c657876
ACM
167enum {
168 DCCP_MIB_NUM = 0,
169 DCCP_MIB_ACTIVEOPENS, /* ActiveOpens */
170 DCCP_MIB_ESTABRESETS, /* EstabResets */
171 DCCP_MIB_CURRESTAB, /* CurrEstab */
c9eaf173 172 DCCP_MIB_OUTSEGS, /* OutSegs */
7c657876
ACM
173 DCCP_MIB_OUTRSTS,
174 DCCP_MIB_ABORTONTIMEOUT,
175 DCCP_MIB_TIMEOUTS,
176 DCCP_MIB_ABORTFAILED,
177 DCCP_MIB_PASSIVEOPENS,
178 DCCP_MIB_ATTEMPTFAILS,
179 DCCP_MIB_OUTDATAGRAMS,
180 DCCP_MIB_INERRS,
181 DCCP_MIB_OPTMANDATORYERROR,
182 DCCP_MIB_INVALIDOPT,
183 __DCCP_MIB_MAX
184};
185
186#define DCCP_MIB_MAX __DCCP_MIB_MAX
187struct dccp_mib {
188 unsigned long mibs[DCCP_MIB_MAX];
189} __SNMP_MIB_ALIGN__;
190
191DECLARE_SNMP_STAT(struct dccp_mib, dccp_statistics);
7690af3f
ACM
192#define DCCP_INC_STATS(field) SNMP_INC_STATS(dccp_statistics, field)
193#define DCCP_INC_STATS_BH(field) SNMP_INC_STATS_BH(dccp_statistics, field)
194#define DCCP_INC_STATS_USER(field) SNMP_INC_STATS_USER(dccp_statistics, field)
195#define DCCP_DEC_STATS(field) SNMP_DEC_STATS(dccp_statistics, field)
196#define DCCP_ADD_STATS_BH(field, val) \
197 SNMP_ADD_STATS_BH(dccp_statistics, field, val)
198#define DCCP_ADD_STATS_USER(field, val) \
199 SNMP_ADD_STATS_USER(dccp_statistics, field, val)
7c657876 200
6f4e5fff
GR
201/*
202 * Checksumming routines
203 */
e961811f 204static inline unsigned int dccp_csum_coverage(const struct sk_buff *skb)
6f4e5fff
GR
205{
206 const struct dccp_hdr* dh = dccp_hdr(skb);
207
208 if (dh->dccph_cscov == 0)
209 return skb->len;
210 return (dh->dccph_doff + dh->dccph_cscov - 1) * sizeof(u32);
211}
212
213static inline void dccp_csum_outgoing(struct sk_buff *skb)
214{
e961811f 215 unsigned int cov = dccp_csum_coverage(skb);
6f4e5fff
GR
216
217 if (cov >= skb->len)
218 dccp_hdr(skb)->dccph_cscov = 0;
219
220 skb->csum = skb_checksum(skb, 0, (cov > skb->len)? skb->len : cov, 0);
221}
222
223extern void dccp_v4_send_check(struct sock *sk, int len, struct sk_buff *skb);
224
59435444 225extern int dccp_retransmit_skb(struct sock *sk);
7c657876 226
7c657876 227extern void dccp_send_ack(struct sock *sk);
6edafaaf
GJ
228extern void dccp_reqsk_send_ack(struct sock *sk, struct sk_buff *skb,
229 struct request_sock *rsk);
8a73cd09 230
e92ae93a
ACM
231extern void dccp_send_sync(struct sock *sk, const u64 seq,
232 const enum dccp_pkt_type pkt_type);
7c657876 233
97e5848d 234extern void dccp_write_xmit(struct sock *sk, int block);
c530cfb1 235extern void dccp_write_space(struct sock *sk);
27258ee5 236
7c657876
ACM
237extern void dccp_init_xmit_timers(struct sock *sk);
238static inline void dccp_clear_xmit_timers(struct sock *sk)
239{
240 inet_csk_clear_xmit_timers(sk);
241}
242
243extern unsigned int dccp_sync_mss(struct sock *sk, u32 pmtu);
244
245extern const char *dccp_packet_name(const int type);
246extern const char *dccp_state_name(const int state);
247
c25a18ba
ACM
248extern void dccp_set_state(struct sock *sk, const int state);
249extern void dccp_done(struct sock *sk);
7c657876 250
ac75773c
GR
251extern int dccp_reqsk_init(struct request_sock *rq, struct dccp_sock const *dp,
252 struct sk_buff const *skb);
7c657876 253
7c657876
ACM
254extern int dccp_v4_conn_request(struct sock *sk, struct sk_buff *skb);
255
256extern struct sock *dccp_create_openreq_child(struct sock *sk,
257 const struct request_sock *req,
258 const struct sk_buff *skb);
259
260extern int dccp_v4_do_rcv(struct sock *sk, struct sk_buff *skb);
261
7c657876
ACM
262extern struct sock *dccp_v4_request_recv_sock(struct sock *sk,
263 struct sk_buff *skb,
264 struct request_sock *req,
265 struct dst_entry *dst);
266extern struct sock *dccp_check_req(struct sock *sk, struct sk_buff *skb,
267 struct request_sock *req,
268 struct request_sock **prev);
269
270extern int dccp_child_process(struct sock *parent, struct sock *child,
271 struct sk_buff *skb);
272extern int dccp_rcv_state_process(struct sock *sk, struct sk_buff *skb,
273 struct dccp_hdr *dh, unsigned len);
274extern int dccp_rcv_established(struct sock *sk, struct sk_buff *skb,
275 const struct dccp_hdr *dh, const unsigned len);
276
72478873 277extern int dccp_init_sock(struct sock *sk, const __u8 ctl_sock_initialized);
7d06b2e0 278extern void dccp_destroy_sock(struct sock *sk);
f21e68ca 279
7c657876
ACM
280extern void dccp_close(struct sock *sk, long timeout);
281extern struct sk_buff *dccp_make_response(struct sock *sk,
282 struct dst_entry *dst,
283 struct request_sock *req);
284
285extern int dccp_connect(struct sock *sk);
286extern int dccp_disconnect(struct sock *sk, int flags);
287extern int dccp_getsockopt(struct sock *sk, int level, int optname,
a1d3a355
ACM
288 char __user *optval, int __user *optlen);
289extern int dccp_setsockopt(struct sock *sk, int level, int optname,
290 char __user *optval, int optlen);
3fdadf7d
DM
291#ifdef CONFIG_COMPAT
292extern int compat_dccp_getsockopt(struct sock *sk,
293 int level, int optname,
294 char __user *optval, int __user *optlen);
295extern int compat_dccp_setsockopt(struct sock *sk,
296 int level, int optname,
297 char __user *optval, int optlen);
298#endif
7c657876 299extern int dccp_ioctl(struct sock *sk, int cmd, unsigned long arg);
7690af3f
ACM
300extern int dccp_sendmsg(struct kiocb *iocb, struct sock *sk,
301 struct msghdr *msg, size_t size);
7c657876
ACM
302extern int dccp_recvmsg(struct kiocb *iocb, struct sock *sk,
303 struct msghdr *msg, size_t len, int nonblock,
304 int flags, int *addr_len);
7c657876 305extern void dccp_shutdown(struct sock *sk, int how);
f21e68ca
ACM
306extern int inet_dccp_listen(struct socket *sock, int backlog);
307extern unsigned int dccp_poll(struct file *file, struct socket *sock,
308 poll_table *wait);
f21e68ca
ACM
309extern int dccp_v4_connect(struct sock *sk, struct sockaddr *uaddr,
310 int addr_len);
7c657876 311
7630f026 312extern struct sk_buff *dccp_ctl_make_reset(struct sock *sk,
e356d37a 313 struct sk_buff *skb);
017487d7 314extern int dccp_send_reset(struct sock *sk, enum dccp_reset_codes code);
7ad07e7c 315extern void dccp_send_close(struct sock *sk, const int active);
f21e68ca 316extern int dccp_invalid_packet(struct sk_buff *skb);
3393da82 317extern u32 dccp_sample_rtt(struct sock *sk, long delta);
f21e68ca
ACM
318
319static inline int dccp_bad_service_code(const struct sock *sk,
60fe62e7 320 const __be32 service)
f21e68ca
ACM
321{
322 const struct dccp_sock *dp = dccp_sk(sk);
323
324 if (dp->dccps_service == service)
325 return 0;
326 return !dccp_list_has_service(dp->dccps_service_list, service);
327}
7c657876 328
0430ee34
GR
329/**
330 * dccp_skb_cb - DCCP per-packet control information
331 * @dccpd_type: one of %dccp_pkt_type (or unknown)
332 * @dccpd_ccval: CCVal field (5.1), see e.g. RFC 4342, 8.1
333 * @dccpd_reset_code: one of %dccp_reset_codes
334 * @dccpd_reset_data: Data1..3 fields (depend on @dccpd_reset_code)
335 * @dccpd_opt_len: total length of all options (5.8) in the packet
336 * @dccpd_seq: sequence number
337 * @dccpd_ack_seq: acknowledgment number subheader field value
338 * This is used for transmission as well as for reception.
339 */
7c657876 340struct dccp_skb_cb {
028b0275
PM
341 union {
342 struct inet_skb_parm h4;
343#if defined(CONFIG_IPV6) || defined (CONFIG_IPV6_MODULE)
344 struct inet6_skb_parm h6;
345#endif
346 } header;
67e6b629
ACM
347 __u8 dccpd_type:4;
348 __u8 dccpd_ccval:4;
0430ee34
GR
349 __u8 dccpd_reset_code,
350 dccpd_reset_data[3];
67e6b629 351 __u16 dccpd_opt_len;
7c657876
ACM
352 __u64 dccpd_seq;
353 __u64 dccpd_ack_seq;
7c657876
ACM
354};
355
356#define DCCP_SKB_CB(__skb) ((struct dccp_skb_cb *)&((__skb)->cb[0]))
357
2180c41c 358/* RFC 4340, sec. 7.7 */
7c657876
ACM
359static inline int dccp_non_data_packet(const struct sk_buff *skb)
360{
361 const __u8 type = DCCP_SKB_CB(skb)->dccpd_type;
362
363 return type == DCCP_PKT_ACK ||
364 type == DCCP_PKT_CLOSE ||
365 type == DCCP_PKT_CLOSEREQ ||
366 type == DCCP_PKT_RESET ||
367 type == DCCP_PKT_SYNC ||
368 type == DCCP_PKT_SYNCACK;
369}
370
2180c41c
GR
371/* RFC 4340, sec. 7.7 */
372static inline int dccp_data_packet(const struct sk_buff *skb)
373{
374 const __u8 type = DCCP_SKB_CB(skb)->dccpd_type;
375
376 return type == DCCP_PKT_DATA ||
377 type == DCCP_PKT_DATAACK ||
378 type == DCCP_PKT_REQUEST ||
379 type == DCCP_PKT_RESPONSE;
380}
381
7c657876
ACM
382static inline int dccp_packet_without_ack(const struct sk_buff *skb)
383{
384 const __u8 type = DCCP_SKB_CB(skb)->dccpd_type;
385
386 return type == DCCP_PKT_DATA || type == DCCP_PKT_REQUEST;
387}
388
6b811d43 389#define DCCP_PKT_WITHOUT_ACK_SEQ (UINT48_MAX << 2)
7c657876
ACM
390
391static inline void dccp_hdr_set_seq(struct dccp_hdr *dh, const u64 gss)
392{
7690af3f
ACM
393 struct dccp_hdr_ext *dhx = (struct dccp_hdr_ext *)((void *)dh +
394 sizeof(*dh));
60fe62e7
AB
395 dh->dccph_seq2 = 0;
396 dh->dccph_seq = htons((gss >> 32) & 0xfffff);
7c657876
ACM
397 dhx->dccph_seq_low = htonl(gss & 0xffffffff);
398}
399
7690af3f
ACM
400static inline void dccp_hdr_set_ack(struct dccp_hdr_ack_bits *dhack,
401 const u64 gsr)
7c657876 402{
60fe62e7
AB
403 dhack->dccph_reserved1 = 0;
404 dhack->dccph_ack_nr_high = htons(gsr >> 32);
7c657876
ACM
405 dhack->dccph_ack_nr_low = htonl(gsr & 0xffffffff);
406}
407
408static inline void dccp_update_gsr(struct sock *sk, u64 seq)
409{
410 struct dccp_sock *dp = dccp_sk(sk);
7c657876 411
03ace394 412 dp->dccps_gsr = seq;
792b4878
GR
413 /* Sequence validity window depends on remote Sequence Window (7.5.1) */
414 dp->dccps_swl = SUB48(ADD48(dp->dccps_gsr, 1), dp->dccps_r_seq_win / 4);
415 dp->dccps_swh = ADD48(dp->dccps_gsr, (3 * dp->dccps_r_seq_win) / 4);
7c657876
ACM
416}
417
418static inline void dccp_update_gss(struct sock *sk, u64 seq)
419{
420 struct dccp_sock *dp = dccp_sk(sk);
7c657876 421
792b4878
GR
422 dp->dccps_gss = seq;
423 /* Ack validity window depends on local Sequence Window value (7.5.1) */
424 dp->dccps_awl = SUB48(ADD48(dp->dccps_gss, 1), dp->dccps_l_seq_win);
425 dp->dccps_awh = dp->dccps_gss;
7c657876 426}
c9eaf173 427
ae31c339
ACM
428static inline int dccp_ack_pending(const struct sock *sk)
429{
430 const struct dccp_sock *dp = dccp_sk(sk);
431 return dp->dccps_timestamp_echo != 0 ||
6fdd34d4 432 (dp->dccps_hc_rx_ackvec != NULL &&
ae31c339 433 dccp_ackvec_pending(dp->dccps_hc_rx_ackvec)) ||
ae31c339
ACM
434 inet_csk_ack_scheduled(sk);
435}
7c657876 436
9eca0a47 437extern int dccp_feat_finalise_settings(struct dccp_sock *dp);
0c116839 438extern int dccp_feat_server_ccid_dependencies(struct dccp_request_sock *dreq);
0971d17c
GR
439extern int dccp_feat_insert_opts(struct dccp_sock*, struct dccp_request_sock*,
440 struct sk_buff *skb);
422d9cdc 441extern int dccp_feat_activate_values(struct sock *sk, struct list_head *fn);
61e6473e
GR
442extern void dccp_feat_list_purge(struct list_head *fn_list);
443
2d0817d1 444extern int dccp_insert_options(struct sock *sk, struct sk_buff *skb);
af3b867e 445extern int dccp_insert_options_rsk(struct dccp_request_sock*, struct sk_buff*);
2d0817d1 446extern int dccp_insert_option_elapsed_time(struct sock *sk,
7c657876
ACM
447 struct sk_buff *skb,
448 u32 elapsed_time);
4c70f383
GR
449extern u32 dccp_timestamp(void);
450extern void dccp_timestamping_init(void);
2d0817d1 451extern int dccp_insert_option_timestamp(struct sock *sk,
d4b81ff7 452 struct sk_buff *skb);
2d0817d1 453extern int dccp_insert_option(struct sock *sk, struct sk_buff *skb,
7c657876
ACM
454 unsigned char option,
455 const void *value, unsigned char len);
456
e55d912f
ACM
457#ifdef CONFIG_SYSCTL
458extern int dccp_sysctl_init(void);
459extern void dccp_sysctl_exit(void);
460#else
461static inline int dccp_sysctl_init(void)
462{
463 return 0;
464}
465
466static inline void dccp_sysctl_exit(void)
467{
468}
469#endif
470
7c657876 471#endif /* _DCCP_H */