]> git.proxmox.com Git - mirror_ubuntu-hirsute-kernel.git/blame - net/dccp/dccp.h
[DCCP]: Shift the retransmit timer for active-close into output.c
[mirror_ubuntu-hirsute-kernel.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, \
c9eaf173 26 __FUNCTION__, ##a)
59348b19
GR
27#define DCCP_CRIT(fmt, a...) printk(KERN_CRIT fmt " at %s:%d/%s()\n", ##a, \
28 __FILE__, __LINE__, __FUNCTION__)
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
GR
38#define DCCP_PR_DEBUG(enable, fmt, a...) DCCP_PRINTK(enable, KERN_DEBUG \
39 "%s: " fmt, __FUNCTION__, ##a)
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)
7c657876
ACM
45#else
46#define dccp_pr_debug(format, a...)
47#define dccp_pr_debug_cat(format, a...)
48#endif
49
50extern struct inet_hashinfo dccp_hashinfo;
51
52extern atomic_t dccp_orphan_count;
7c657876
ACM
53
54extern void dccp_time_wait(struct sock *sk, int state, int timeo);
55
60361be1
GR
56/*
57 * Set safe upper bounds for header and option length. Since Data Offset is 8
58 * bits (RFC 4340, sec. 5.1), the total header length can never be more than
59 * 4 * 255 = 1020 bytes. The largest possible header length is 28 bytes (X=1):
60 * - DCCP-Response with ACK Subheader and 4 bytes of Service code OR
61 * - DCCP-Reset with ACK Subheader and 4 bytes of Reset Code fields
62 * Hence a safe upper bound for the maximum option length is 1020-28 = 992
63 */
64#define MAX_DCCP_SPECIFIC_HEADER (255 * sizeof(int))
65#define DCCP_MAX_PACKET_HDR 28
66#define DCCP_MAX_OPT_LEN (MAX_DCCP_SPECIFIC_HEADER - DCCP_MAX_PACKET_HDR)
67#define MAX_DCCP_HEADER (MAX_DCCP_SPECIFIC_HEADER + MAX_HEADER)
7c657876
ACM
68
69#define DCCP_TIMEWAIT_LEN (60 * HZ) /* how long to wait to destroy TIME-WAIT
70 * state, about 60 seconds */
71
0e64e94e 72/* RFC 1122, 4.2.3.1 initial RTO value */
7c657876
ACM
73#define DCCP_TIMEOUT_INIT ((unsigned)(3 * HZ))
74
4712a792
GR
75#define DCCP_RTO_MAX ((unsigned)(120 * HZ)) /* FIXME: using TCP value */
76
954c2db8
GR
77/*
78 * RTT sampling: sanity bounds and fallback RTT value from RFC 4340, section 3.4
79 */
4712a792 80#define DCCP_SANE_RTT_MIN 100
954c2db8
GR
81#define DCCP_FALLBACK_RTT (USEC_PER_SEC / 5)
82#define DCCP_SANE_RTT_MAX (3 * USEC_PER_SEC)
4712a792 83
7c657876
ACM
84/* Maximal interval between probes for local resources. */
85#define DCCP_RESOURCE_PROBE_INTERVAL ((unsigned)(HZ / 2U))
86
2e2e9e92
GR
87/* sysctl variables for DCCP */
88extern int sysctl_dccp_request_retries;
89extern int sysctl_dccp_retries1;
90extern int sysctl_dccp_retries2;
afb0a34d
GR
91extern int sysctl_dccp_feat_sequence_window;
92extern int sysctl_dccp_feat_rx_ccid;
93extern int sysctl_dccp_feat_tx_ccid;
94extern int sysctl_dccp_feat_ack_ratio;
95extern int sysctl_dccp_feat_send_ack_vector;
96extern int sysctl_dccp_feat_send_ndp_count;
b1308dc0 97extern int sysctl_dccp_tx_qlen;
a94f0f97 98extern int sysctl_dccp_sync_ratelimit;
2e2e9e92 99
6b811d43
GR
100/*
101 * 48-bit sequence number arithmetic (signed and unsigned)
102 */
103#define INT48_MIN 0x800000000000LL /* 2^47 */
104#define UINT48_MAX 0xFFFFFFFFFFFFLL /* 2^48 - 1 */
105#define COMPLEMENT48(x) (0x1000000000000LL - (x)) /* 2^48 - x */
106#define TO_SIGNED48(x) (((x) < INT48_MIN)? (x) : -COMPLEMENT48( (x)))
107#define TO_UNSIGNED48(x) (((x) >= 0)? (x) : COMPLEMENT48(-(x)))
108#define ADD48(a, b) (((a) + (b)) & UINT48_MAX)
109#define SUB48(a, b) ADD48((a), COMPLEMENT48(b))
110
111static inline void dccp_set_seqno(u64 *seqno, u64 value)
112{
113 *seqno = value & UINT48_MAX;
114}
115
116static inline void dccp_inc_seqno(u64 *seqno)
117{
118 *seqno = ADD48(*seqno, 1);
119}
120
0aec51c8
GR
121/* signed mod-2^48 distance: pos. if seqno1 < seqno2, neg. if seqno1 > seqno2 */
122static inline s64 dccp_delta_seqno(const u64 seqno1, const u64 seqno2)
6b811d43 123{
0aec51c8
GR
124 u64 delta = SUB48(seqno2, seqno1);
125
126 return TO_SIGNED48(delta);
6b811d43
GR
127}
128
7c657876 129/* is seq1 < seq2 ? */
a10cedd4 130static inline int before48(const u64 seq1, const u64 seq2)
7c657876 131{
d52de17b 132 return (s64)((seq2 << 16) - (seq1 << 16)) > 0;
7c657876
ACM
133}
134
135/* is seq1 > seq2 ? */
d52de17b 136#define after48(seq1, seq2) before48(seq2, seq1)
7c657876
ACM
137
138/* is seq2 <= seq1 <= seq3 ? */
a10cedd4 139static inline int between48(const u64 seq1, const u64 seq2, const u64 seq3)
7c657876
ACM
140{
141 return (seq3 << 16) - (seq2 << 16) >= (seq1 << 16) - (seq2 << 16);
142}
143
144static inline u64 max48(const u64 seq1, const u64 seq2)
145{
146 return after48(seq1, seq2) ? seq1 : seq2;
147}
148
837d107c
IM
149/* is seq1 next seqno after seq2 */
150static inline int follows48(const u64 seq1, const u64 seq2)
151{
b16be51b 152 return dccp_delta_seqno(seq2, seq1) == 1;
837d107c
IM
153}
154
7c657876
ACM
155enum {
156 DCCP_MIB_NUM = 0,
157 DCCP_MIB_ACTIVEOPENS, /* ActiveOpens */
158 DCCP_MIB_ESTABRESETS, /* EstabResets */
159 DCCP_MIB_CURRESTAB, /* CurrEstab */
c9eaf173 160 DCCP_MIB_OUTSEGS, /* OutSegs */
7c657876
ACM
161 DCCP_MIB_OUTRSTS,
162 DCCP_MIB_ABORTONTIMEOUT,
163 DCCP_MIB_TIMEOUTS,
164 DCCP_MIB_ABORTFAILED,
165 DCCP_MIB_PASSIVEOPENS,
166 DCCP_MIB_ATTEMPTFAILS,
167 DCCP_MIB_OUTDATAGRAMS,
168 DCCP_MIB_INERRS,
169 DCCP_MIB_OPTMANDATORYERROR,
170 DCCP_MIB_INVALIDOPT,
171 __DCCP_MIB_MAX
172};
173
174#define DCCP_MIB_MAX __DCCP_MIB_MAX
175struct dccp_mib {
176 unsigned long mibs[DCCP_MIB_MAX];
177} __SNMP_MIB_ALIGN__;
178
179DECLARE_SNMP_STAT(struct dccp_mib, dccp_statistics);
7690af3f
ACM
180#define DCCP_INC_STATS(field) SNMP_INC_STATS(dccp_statistics, field)
181#define DCCP_INC_STATS_BH(field) SNMP_INC_STATS_BH(dccp_statistics, field)
182#define DCCP_INC_STATS_USER(field) SNMP_INC_STATS_USER(dccp_statistics, field)
183#define DCCP_DEC_STATS(field) SNMP_DEC_STATS(dccp_statistics, field)
184#define DCCP_ADD_STATS_BH(field, val) \
185 SNMP_ADD_STATS_BH(dccp_statistics, field, val)
186#define DCCP_ADD_STATS_USER(field, val) \
187 SNMP_ADD_STATS_USER(dccp_statistics, field, val)
7c657876 188
6f4e5fff
GR
189/*
190 * Checksumming routines
191 */
e961811f 192static inline unsigned int dccp_csum_coverage(const struct sk_buff *skb)
6f4e5fff
GR
193{
194 const struct dccp_hdr* dh = dccp_hdr(skb);
195
196 if (dh->dccph_cscov == 0)
197 return skb->len;
198 return (dh->dccph_doff + dh->dccph_cscov - 1) * sizeof(u32);
199}
200
201static inline void dccp_csum_outgoing(struct sk_buff *skb)
202{
e961811f 203 unsigned int cov = dccp_csum_coverage(skb);
6f4e5fff
GR
204
205 if (cov >= skb->len)
206 dccp_hdr(skb)->dccph_cscov = 0;
207
208 skb->csum = skb_checksum(skb, 0, (cov > skb->len)? skb->len : cov, 0);
209}
210
211extern void dccp_v4_send_check(struct sock *sk, int len, struct sk_buff *skb);
212
7c657876
ACM
213extern int dccp_retransmit_skb(struct sock *sk, struct sk_buff *skb);
214
7c657876 215extern void dccp_send_ack(struct sock *sk);
8a73cd09
GR
216extern void dccp_reqsk_send_ack(struct sk_buff *sk, struct request_sock *rsk);
217
e92ae93a
ACM
218extern void dccp_send_sync(struct sock *sk, const u64 seq,
219 const enum dccp_pkt_type pkt_type);
7c657876 220
97e5848d 221extern void dccp_write_xmit(struct sock *sk, int block);
c530cfb1 222extern void dccp_write_space(struct sock *sk);
27258ee5 223
7c657876
ACM
224extern void dccp_init_xmit_timers(struct sock *sk);
225static inline void dccp_clear_xmit_timers(struct sock *sk)
226{
227 inet_csk_clear_xmit_timers(sk);
228}
229
230extern unsigned int dccp_sync_mss(struct sock *sk, u32 pmtu);
231
232extern const char *dccp_packet_name(const int type);
233extern const char *dccp_state_name(const int state);
234
c25a18ba
ACM
235extern void dccp_set_state(struct sock *sk, const int state);
236extern void dccp_done(struct sock *sk);
7c657876 237
cf557926 238extern void dccp_reqsk_init(struct request_sock *req, struct sk_buff *skb);
7c657876 239
7c657876
ACM
240extern int dccp_v4_conn_request(struct sock *sk, struct sk_buff *skb);
241
242extern struct sock *dccp_create_openreq_child(struct sock *sk,
243 const struct request_sock *req,
244 const struct sk_buff *skb);
245
246extern int dccp_v4_do_rcv(struct sock *sk, struct sk_buff *skb);
247
7c657876
ACM
248extern struct sock *dccp_v4_request_recv_sock(struct sock *sk,
249 struct sk_buff *skb,
250 struct request_sock *req,
251 struct dst_entry *dst);
252extern struct sock *dccp_check_req(struct sock *sk, struct sk_buff *skb,
253 struct request_sock *req,
254 struct request_sock **prev);
255
256extern int dccp_child_process(struct sock *parent, struct sock *child,
257 struct sk_buff *skb);
258extern int dccp_rcv_state_process(struct sock *sk, struct sk_buff *skb,
259 struct dccp_hdr *dh, unsigned len);
260extern int dccp_rcv_established(struct sock *sk, struct sk_buff *skb,
261 const struct dccp_hdr *dh, const unsigned len);
262
72478873 263extern int dccp_init_sock(struct sock *sk, const __u8 ctl_sock_initialized);
3e0fadc5 264extern int dccp_destroy_sock(struct sock *sk);
f21e68ca 265
7c657876
ACM
266extern void dccp_close(struct sock *sk, long timeout);
267extern struct sk_buff *dccp_make_response(struct sock *sk,
268 struct dst_entry *dst,
269 struct request_sock *req);
270
271extern int dccp_connect(struct sock *sk);
272extern int dccp_disconnect(struct sock *sk, int flags);
c985ed70 273extern void dccp_hash(struct sock *sk);
f21e68ca 274extern void dccp_unhash(struct sock *sk);
7c657876 275extern int dccp_getsockopt(struct sock *sk, int level, int optname,
a1d3a355
ACM
276 char __user *optval, int __user *optlen);
277extern int dccp_setsockopt(struct sock *sk, int level, int optname,
278 char __user *optval, int optlen);
3fdadf7d
DM
279#ifdef CONFIG_COMPAT
280extern int compat_dccp_getsockopt(struct sock *sk,
281 int level, int optname,
282 char __user *optval, int __user *optlen);
283extern int compat_dccp_setsockopt(struct sock *sk,
284 int level, int optname,
285 char __user *optval, int optlen);
286#endif
7c657876 287extern int dccp_ioctl(struct sock *sk, int cmd, unsigned long arg);
7690af3f
ACM
288extern int dccp_sendmsg(struct kiocb *iocb, struct sock *sk,
289 struct msghdr *msg, size_t size);
7c657876
ACM
290extern int dccp_recvmsg(struct kiocb *iocb, struct sock *sk,
291 struct msghdr *msg, size_t len, int nonblock,
292 int flags, int *addr_len);
7c657876 293extern void dccp_shutdown(struct sock *sk, int how);
f21e68ca
ACM
294extern int inet_dccp_listen(struct socket *sock, int backlog);
295extern unsigned int dccp_poll(struct file *file, struct socket *sock,
296 poll_table *wait);
f21e68ca
ACM
297extern int dccp_v4_connect(struct sock *sk, struct sockaddr *uaddr,
298 int addr_len);
7c657876 299
e356d37a
GR
300extern struct sk_buff *dccp_ctl_make_reset(struct socket *ctl,
301 struct sk_buff *skb);
017487d7 302extern int dccp_send_reset(struct sock *sk, enum dccp_reset_codes code);
7ad07e7c 303extern void dccp_send_close(struct sock *sk, const int active);
f21e68ca 304extern int dccp_invalid_packet(struct sk_buff *skb);
3393da82 305extern u32 dccp_sample_rtt(struct sock *sk, long delta);
f21e68ca
ACM
306
307static inline int dccp_bad_service_code(const struct sock *sk,
60fe62e7 308 const __be32 service)
f21e68ca
ACM
309{
310 const struct dccp_sock *dp = dccp_sk(sk);
311
312 if (dp->dccps_service == service)
313 return 0;
314 return !dccp_list_has_service(dp->dccps_service_list, service);
315}
7c657876 316
0430ee34
GR
317/**
318 * dccp_skb_cb - DCCP per-packet control information
319 * @dccpd_type: one of %dccp_pkt_type (or unknown)
320 * @dccpd_ccval: CCVal field (5.1), see e.g. RFC 4342, 8.1
321 * @dccpd_reset_code: one of %dccp_reset_codes
322 * @dccpd_reset_data: Data1..3 fields (depend on @dccpd_reset_code)
323 * @dccpd_opt_len: total length of all options (5.8) in the packet
324 * @dccpd_seq: sequence number
325 * @dccpd_ack_seq: acknowledgment number subheader field value
326 * This is used for transmission as well as for reception.
327 */
7c657876 328struct dccp_skb_cb {
67e6b629
ACM
329 __u8 dccpd_type:4;
330 __u8 dccpd_ccval:4;
0430ee34
GR
331 __u8 dccpd_reset_code,
332 dccpd_reset_data[3];
67e6b629 333 __u16 dccpd_opt_len;
7c657876
ACM
334 __u64 dccpd_seq;
335 __u64 dccpd_ack_seq;
7c657876
ACM
336};
337
338#define DCCP_SKB_CB(__skb) ((struct dccp_skb_cb *)&((__skb)->cb[0]))
339
2180c41c 340/* RFC 4340, sec. 7.7 */
7c657876
ACM
341static inline int dccp_non_data_packet(const struct sk_buff *skb)
342{
343 const __u8 type = DCCP_SKB_CB(skb)->dccpd_type;
344
345 return type == DCCP_PKT_ACK ||
346 type == DCCP_PKT_CLOSE ||
347 type == DCCP_PKT_CLOSEREQ ||
348 type == DCCP_PKT_RESET ||
349 type == DCCP_PKT_SYNC ||
350 type == DCCP_PKT_SYNCACK;
351}
352
2180c41c
GR
353/* RFC 4340, sec. 7.7 */
354static inline int dccp_data_packet(const struct sk_buff *skb)
355{
356 const __u8 type = DCCP_SKB_CB(skb)->dccpd_type;
357
358 return type == DCCP_PKT_DATA ||
359 type == DCCP_PKT_DATAACK ||
360 type == DCCP_PKT_REQUEST ||
361 type == DCCP_PKT_RESPONSE;
362}
363
7c657876
ACM
364static inline int dccp_packet_without_ack(const struct sk_buff *skb)
365{
366 const __u8 type = DCCP_SKB_CB(skb)->dccpd_type;
367
368 return type == DCCP_PKT_DATA || type == DCCP_PKT_REQUEST;
369}
370
6b811d43 371#define DCCP_PKT_WITHOUT_ACK_SEQ (UINT48_MAX << 2)
7c657876
ACM
372
373static inline void dccp_hdr_set_seq(struct dccp_hdr *dh, const u64 gss)
374{
7690af3f
ACM
375 struct dccp_hdr_ext *dhx = (struct dccp_hdr_ext *)((void *)dh +
376 sizeof(*dh));
60fe62e7
AB
377 dh->dccph_seq2 = 0;
378 dh->dccph_seq = htons((gss >> 32) & 0xfffff);
7c657876
ACM
379 dhx->dccph_seq_low = htonl(gss & 0xffffffff);
380}
381
7690af3f
ACM
382static inline void dccp_hdr_set_ack(struct dccp_hdr_ack_bits *dhack,
383 const u64 gsr)
7c657876 384{
60fe62e7
AB
385 dhack->dccph_reserved1 = 0;
386 dhack->dccph_ack_nr_high = htons(gsr >> 32);
7c657876
ACM
387 dhack->dccph_ack_nr_low = htonl(gsr & 0xffffffff);
388}
389
390static inline void dccp_update_gsr(struct sock *sk, u64 seq)
391{
392 struct dccp_sock *dp = dccp_sk(sk);
a4bf3902 393 const struct dccp_minisock *dmsk = dccp_msk(sk);
7c657876 394
03ace394
ACM
395 dp->dccps_gsr = seq;
396 dccp_set_seqno(&dp->dccps_swl,
a4bf3902 397 dp->dccps_gsr + 1 - (dmsk->dccpms_sequence_window / 4));
7c657876 398 dccp_set_seqno(&dp->dccps_swh,
a4bf3902 399 dp->dccps_gsr + (3 * dmsk->dccpms_sequence_window) / 4);
7c657876
ACM
400}
401
402static inline void dccp_update_gss(struct sock *sk, u64 seq)
403{
404 struct dccp_sock *dp = dccp_sk(sk);
7c657876 405
03ace394
ACM
406 dp->dccps_awh = dp->dccps_gss = seq;
407 dccp_set_seqno(&dp->dccps_awl,
7690af3f 408 (dp->dccps_gss -
a4bf3902 409 dccp_msk(sk)->dccpms_sequence_window + 1));
7c657876 410}
c9eaf173 411
ae31c339
ACM
412static inline int dccp_ack_pending(const struct sock *sk)
413{
414 const struct dccp_sock *dp = dccp_sk(sk);
415 return dp->dccps_timestamp_echo != 0 ||
416#ifdef CONFIG_IP_DCCP_ACKVEC
a4bf3902 417 (dccp_msk(sk)->dccpms_send_ack_vector &&
ae31c339
ACM
418 dccp_ackvec_pending(dp->dccps_hc_rx_ackvec)) ||
419#endif
420 inet_csk_ack_scheduled(sk);
421}
7c657876 422
2d0817d1
ACM
423extern int dccp_insert_options(struct sock *sk, struct sk_buff *skb);
424extern int dccp_insert_option_elapsed_time(struct sock *sk,
7c657876
ACM
425 struct sk_buff *skb,
426 u32 elapsed_time);
4c70f383
GR
427extern u32 dccp_timestamp(void);
428extern void dccp_timestamping_init(void);
2d0817d1 429extern int dccp_insert_option_timestamp(struct sock *sk,
d4b81ff7 430 struct sk_buff *skb);
2d0817d1 431extern int dccp_insert_option(struct sock *sk, struct sk_buff *skb,
7c657876
ACM
432 unsigned char option,
433 const void *value, unsigned char len);
434
e55d912f
ACM
435#ifdef CONFIG_SYSCTL
436extern int dccp_sysctl_init(void);
437extern void dccp_sysctl_exit(void);
438#else
439static inline int dccp_sysctl_init(void)
440{
441 return 0;
442}
443
444static inline void dccp_sysctl_exit(void)
445{
446}
447#endif
448
7c657876 449#endif /* _DCCP_H */