]> git.proxmox.com Git - mirror_ubuntu-bionic-kernel.git/blame - net/dccp/dccp.h
[DCCP]: Add FIXME for send_delayed_ack
[mirror_ubuntu-bionic-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
77/* bounds for sampled RTT values from packet exchanges (in usec) */
78#define DCCP_SANE_RTT_MIN 100
79#define DCCP_SANE_RTT_MAX (4 * USEC_PER_SEC)
80
7c657876
ACM
81/* Maximal interval between probes for local resources. */
82#define DCCP_RESOURCE_PROBE_INTERVAL ((unsigned)(HZ / 2U))
83
2e2e9e92
GR
84/* sysctl variables for DCCP */
85extern int sysctl_dccp_request_retries;
86extern int sysctl_dccp_retries1;
87extern int sysctl_dccp_retries2;
afb0a34d
GR
88extern int sysctl_dccp_feat_sequence_window;
89extern int sysctl_dccp_feat_rx_ccid;
90extern int sysctl_dccp_feat_tx_ccid;
91extern int sysctl_dccp_feat_ack_ratio;
92extern int sysctl_dccp_feat_send_ack_vector;
93extern int sysctl_dccp_feat_send_ndp_count;
b1308dc0 94extern int sysctl_dccp_tx_qlen;
2e2e9e92 95
6b811d43
GR
96/*
97 * 48-bit sequence number arithmetic (signed and unsigned)
98 */
99#define INT48_MIN 0x800000000000LL /* 2^47 */
100#define UINT48_MAX 0xFFFFFFFFFFFFLL /* 2^48 - 1 */
101#define COMPLEMENT48(x) (0x1000000000000LL - (x)) /* 2^48 - x */
102#define TO_SIGNED48(x) (((x) < INT48_MIN)? (x) : -COMPLEMENT48( (x)))
103#define TO_UNSIGNED48(x) (((x) >= 0)? (x) : COMPLEMENT48(-(x)))
104#define ADD48(a, b) (((a) + (b)) & UINT48_MAX)
105#define SUB48(a, b) ADD48((a), COMPLEMENT48(b))
106
107static inline void dccp_set_seqno(u64 *seqno, u64 value)
108{
109 *seqno = value & UINT48_MAX;
110}
111
112static inline void dccp_inc_seqno(u64 *seqno)
113{
114 *seqno = ADD48(*seqno, 1);
115}
116
0aec51c8
GR
117/* signed mod-2^48 distance: pos. if seqno1 < seqno2, neg. if seqno1 > seqno2 */
118static inline s64 dccp_delta_seqno(const u64 seqno1, const u64 seqno2)
6b811d43 119{
0aec51c8
GR
120 u64 delta = SUB48(seqno2, seqno1);
121
122 return TO_SIGNED48(delta);
6b811d43
GR
123}
124
7c657876 125/* is seq1 < seq2 ? */
a10cedd4 126static inline int before48(const u64 seq1, const u64 seq2)
7c657876 127{
d52de17b 128 return (s64)((seq2 << 16) - (seq1 << 16)) > 0;
7c657876
ACM
129}
130
131/* is seq1 > seq2 ? */
d52de17b 132#define after48(seq1, seq2) before48(seq2, seq1)
7c657876
ACM
133
134/* is seq2 <= seq1 <= seq3 ? */
a10cedd4 135static inline int between48(const u64 seq1, const u64 seq2, const u64 seq3)
7c657876
ACM
136{
137 return (seq3 << 16) - (seq2 << 16) >= (seq1 << 16) - (seq2 << 16);
138}
139
140static inline u64 max48(const u64 seq1, const u64 seq2)
141{
142 return after48(seq1, seq2) ? seq1 : seq2;
143}
144
837d107c
IM
145/* is seq1 next seqno after seq2 */
146static inline int follows48(const u64 seq1, const u64 seq2)
147{
b16be51b 148 return dccp_delta_seqno(seq2, seq1) == 1;
837d107c
IM
149}
150
7c657876
ACM
151enum {
152 DCCP_MIB_NUM = 0,
153 DCCP_MIB_ACTIVEOPENS, /* ActiveOpens */
154 DCCP_MIB_ESTABRESETS, /* EstabResets */
155 DCCP_MIB_CURRESTAB, /* CurrEstab */
c9eaf173 156 DCCP_MIB_OUTSEGS, /* OutSegs */
7c657876
ACM
157 DCCP_MIB_OUTRSTS,
158 DCCP_MIB_ABORTONTIMEOUT,
159 DCCP_MIB_TIMEOUTS,
160 DCCP_MIB_ABORTFAILED,
161 DCCP_MIB_PASSIVEOPENS,
162 DCCP_MIB_ATTEMPTFAILS,
163 DCCP_MIB_OUTDATAGRAMS,
164 DCCP_MIB_INERRS,
165 DCCP_MIB_OPTMANDATORYERROR,
166 DCCP_MIB_INVALIDOPT,
167 __DCCP_MIB_MAX
168};
169
170#define DCCP_MIB_MAX __DCCP_MIB_MAX
171struct dccp_mib {
172 unsigned long mibs[DCCP_MIB_MAX];
173} __SNMP_MIB_ALIGN__;
174
175DECLARE_SNMP_STAT(struct dccp_mib, dccp_statistics);
7690af3f
ACM
176#define DCCP_INC_STATS(field) SNMP_INC_STATS(dccp_statistics, field)
177#define DCCP_INC_STATS_BH(field) SNMP_INC_STATS_BH(dccp_statistics, field)
178#define DCCP_INC_STATS_USER(field) SNMP_INC_STATS_USER(dccp_statistics, field)
179#define DCCP_DEC_STATS(field) SNMP_DEC_STATS(dccp_statistics, field)
180#define DCCP_ADD_STATS_BH(field, val) \
181 SNMP_ADD_STATS_BH(dccp_statistics, field, val)
182#define DCCP_ADD_STATS_USER(field, val) \
183 SNMP_ADD_STATS_USER(dccp_statistics, field, val)
7c657876 184
6f4e5fff
GR
185/*
186 * Checksumming routines
187 */
e961811f 188static inline unsigned int dccp_csum_coverage(const struct sk_buff *skb)
6f4e5fff
GR
189{
190 const struct dccp_hdr* dh = dccp_hdr(skb);
191
192 if (dh->dccph_cscov == 0)
193 return skb->len;
194 return (dh->dccph_doff + dh->dccph_cscov - 1) * sizeof(u32);
195}
196
197static inline void dccp_csum_outgoing(struct sk_buff *skb)
198{
e961811f 199 unsigned int cov = dccp_csum_coverage(skb);
6f4e5fff
GR
200
201 if (cov >= skb->len)
202 dccp_hdr(skb)->dccph_cscov = 0;
203
204 skb->csum = skb_checksum(skb, 0, (cov > skb->len)? skb->len : cov, 0);
205}
206
207extern void dccp_v4_send_check(struct sock *sk, int len, struct sk_buff *skb);
208
7c657876
ACM
209extern int dccp_retransmit_skb(struct sock *sk, struct sk_buff *skb);
210
7c657876 211extern void dccp_send_ack(struct sock *sk);
8a73cd09
GR
212extern void dccp_reqsk_send_ack(struct sk_buff *sk, struct request_sock *rsk);
213
e92ae93a
ACM
214extern void dccp_send_sync(struct sock *sk, const u64 seq,
215 const enum dccp_pkt_type pkt_type);
7c657876 216
97e5848d 217extern void dccp_write_xmit(struct sock *sk, int block);
c530cfb1 218extern void dccp_write_space(struct sock *sk);
27258ee5 219
7c657876
ACM
220extern void dccp_init_xmit_timers(struct sock *sk);
221static inline void dccp_clear_xmit_timers(struct sock *sk)
222{
223 inet_csk_clear_xmit_timers(sk);
224}
225
226extern unsigned int dccp_sync_mss(struct sock *sk, u32 pmtu);
227
228extern const char *dccp_packet_name(const int type);
229extern const char *dccp_state_name(const int state);
230
c25a18ba
ACM
231extern void dccp_set_state(struct sock *sk, const int state);
232extern void dccp_done(struct sock *sk);
7c657876 233
cf557926 234extern void dccp_reqsk_init(struct request_sock *req, struct sk_buff *skb);
7c657876 235
7c657876
ACM
236extern int dccp_v4_conn_request(struct sock *sk, struct sk_buff *skb);
237
238extern struct sock *dccp_create_openreq_child(struct sock *sk,
239 const struct request_sock *req,
240 const struct sk_buff *skb);
241
242extern int dccp_v4_do_rcv(struct sock *sk, struct sk_buff *skb);
243
7c657876
ACM
244extern struct sock *dccp_v4_request_recv_sock(struct sock *sk,
245 struct sk_buff *skb,
246 struct request_sock *req,
247 struct dst_entry *dst);
248extern struct sock *dccp_check_req(struct sock *sk, struct sk_buff *skb,
249 struct request_sock *req,
250 struct request_sock **prev);
251
252extern int dccp_child_process(struct sock *parent, struct sock *child,
253 struct sk_buff *skb);
254extern int dccp_rcv_state_process(struct sock *sk, struct sk_buff *skb,
255 struct dccp_hdr *dh, unsigned len);
256extern int dccp_rcv_established(struct sock *sk, struct sk_buff *skb,
257 const struct dccp_hdr *dh, const unsigned len);
258
72478873 259extern int dccp_init_sock(struct sock *sk, const __u8 ctl_sock_initialized);
3e0fadc5 260extern int dccp_destroy_sock(struct sock *sk);
f21e68ca 261
7c657876
ACM
262extern void dccp_close(struct sock *sk, long timeout);
263extern struct sk_buff *dccp_make_response(struct sock *sk,
264 struct dst_entry *dst,
265 struct request_sock *req);
266
267extern int dccp_connect(struct sock *sk);
268extern int dccp_disconnect(struct sock *sk, int flags);
c985ed70 269extern void dccp_hash(struct sock *sk);
f21e68ca 270extern void dccp_unhash(struct sock *sk);
7c657876 271extern int dccp_getsockopt(struct sock *sk, int level, int optname,
a1d3a355
ACM
272 char __user *optval, int __user *optlen);
273extern int dccp_setsockopt(struct sock *sk, int level, int optname,
274 char __user *optval, int optlen);
3fdadf7d
DM
275#ifdef CONFIG_COMPAT
276extern int compat_dccp_getsockopt(struct sock *sk,
277 int level, int optname,
278 char __user *optval, int __user *optlen);
279extern int compat_dccp_setsockopt(struct sock *sk,
280 int level, int optname,
281 char __user *optval, int optlen);
282#endif
7c657876 283extern int dccp_ioctl(struct sock *sk, int cmd, unsigned long arg);
7690af3f
ACM
284extern int dccp_sendmsg(struct kiocb *iocb, struct sock *sk,
285 struct msghdr *msg, size_t size);
7c657876
ACM
286extern int dccp_recvmsg(struct kiocb *iocb, struct sock *sk,
287 struct msghdr *msg, size_t len, int nonblock,
288 int flags, int *addr_len);
7c657876 289extern void dccp_shutdown(struct sock *sk, int how);
f21e68ca
ACM
290extern int inet_dccp_listen(struct socket *sock, int backlog);
291extern unsigned int dccp_poll(struct file *file, struct socket *sock,
292 poll_table *wait);
f21e68ca
ACM
293extern int dccp_v4_connect(struct sock *sk, struct sockaddr *uaddr,
294 int addr_len);
7c657876 295
017487d7 296extern int dccp_send_reset(struct sock *sk, enum dccp_reset_codes code);
7ad07e7c 297extern void dccp_send_close(struct sock *sk, const int active);
f21e68ca 298extern int dccp_invalid_packet(struct sk_buff *skb);
3393da82 299extern u32 dccp_sample_rtt(struct sock *sk, long delta);
f21e68ca
ACM
300
301static inline int dccp_bad_service_code(const struct sock *sk,
60fe62e7 302 const __be32 service)
f21e68ca
ACM
303{
304 const struct dccp_sock *dp = dccp_sk(sk);
305
306 if (dp->dccps_service == service)
307 return 0;
308 return !dccp_list_has_service(dp->dccps_service_list, service);
309}
7c657876
ACM
310
311struct dccp_skb_cb {
67e6b629
ACM
312 __u8 dccpd_type:4;
313 __u8 dccpd_ccval:4;
314 __u8 dccpd_reset_code;
315 __u16 dccpd_opt_len;
7c657876
ACM
316 __u64 dccpd_seq;
317 __u64 dccpd_ack_seq;
7c657876
ACM
318};
319
320#define DCCP_SKB_CB(__skb) ((struct dccp_skb_cb *)&((__skb)->cb[0]))
321
322static inline int dccp_non_data_packet(const struct sk_buff *skb)
323{
324 const __u8 type = DCCP_SKB_CB(skb)->dccpd_type;
325
326 return type == DCCP_PKT_ACK ||
327 type == DCCP_PKT_CLOSE ||
328 type == DCCP_PKT_CLOSEREQ ||
329 type == DCCP_PKT_RESET ||
330 type == DCCP_PKT_SYNC ||
331 type == DCCP_PKT_SYNCACK;
332}
333
334static inline int dccp_packet_without_ack(const struct sk_buff *skb)
335{
336 const __u8 type = DCCP_SKB_CB(skb)->dccpd_type;
337
338 return type == DCCP_PKT_DATA || type == DCCP_PKT_REQUEST;
339}
340
6b811d43 341#define DCCP_PKT_WITHOUT_ACK_SEQ (UINT48_MAX << 2)
7c657876
ACM
342
343static inline void dccp_hdr_set_seq(struct dccp_hdr *dh, const u64 gss)
344{
7690af3f
ACM
345 struct dccp_hdr_ext *dhx = (struct dccp_hdr_ext *)((void *)dh +
346 sizeof(*dh));
60fe62e7
AB
347 dh->dccph_seq2 = 0;
348 dh->dccph_seq = htons((gss >> 32) & 0xfffff);
7c657876
ACM
349 dhx->dccph_seq_low = htonl(gss & 0xffffffff);
350}
351
7690af3f
ACM
352static inline void dccp_hdr_set_ack(struct dccp_hdr_ack_bits *dhack,
353 const u64 gsr)
7c657876 354{
60fe62e7
AB
355 dhack->dccph_reserved1 = 0;
356 dhack->dccph_ack_nr_high = htons(gsr >> 32);
7c657876
ACM
357 dhack->dccph_ack_nr_low = htonl(gsr & 0xffffffff);
358}
359
360static inline void dccp_update_gsr(struct sock *sk, u64 seq)
361{
362 struct dccp_sock *dp = dccp_sk(sk);
a4bf3902 363 const struct dccp_minisock *dmsk = dccp_msk(sk);
7c657876 364
03ace394
ACM
365 dp->dccps_gsr = seq;
366 dccp_set_seqno(&dp->dccps_swl,
a4bf3902 367 dp->dccps_gsr + 1 - (dmsk->dccpms_sequence_window / 4));
7c657876 368 dccp_set_seqno(&dp->dccps_swh,
a4bf3902 369 dp->dccps_gsr + (3 * dmsk->dccpms_sequence_window) / 4);
7c657876
ACM
370}
371
372static inline void dccp_update_gss(struct sock *sk, u64 seq)
373{
374 struct dccp_sock *dp = dccp_sk(sk);
7c657876 375
03ace394
ACM
376 dp->dccps_awh = dp->dccps_gss = seq;
377 dccp_set_seqno(&dp->dccps_awl,
7690af3f 378 (dp->dccps_gss -
a4bf3902 379 dccp_msk(sk)->dccpms_sequence_window + 1));
7c657876 380}
c9eaf173 381
ae31c339
ACM
382static inline int dccp_ack_pending(const struct sock *sk)
383{
384 const struct dccp_sock *dp = dccp_sk(sk);
385 return dp->dccps_timestamp_echo != 0 ||
386#ifdef CONFIG_IP_DCCP_ACKVEC
a4bf3902 387 (dccp_msk(sk)->dccpms_send_ack_vector &&
ae31c339
ACM
388 dccp_ackvec_pending(dp->dccps_hc_rx_ackvec)) ||
389#endif
390 inet_csk_ack_scheduled(sk);
391}
7c657876 392
2d0817d1
ACM
393extern int dccp_insert_options(struct sock *sk, struct sk_buff *skb);
394extern int dccp_insert_option_elapsed_time(struct sock *sk,
7c657876
ACM
395 struct sk_buff *skb,
396 u32 elapsed_time);
4c70f383
GR
397extern u32 dccp_timestamp(void);
398extern void dccp_timestamping_init(void);
2d0817d1 399extern int dccp_insert_option_timestamp(struct sock *sk,
d4b81ff7 400 struct sk_buff *skb);
2d0817d1 401extern int dccp_insert_option(struct sock *sk, struct sk_buff *skb,
7c657876
ACM
402 unsigned char option,
403 const void *value, unsigned char len);
404
e55d912f
ACM
405#ifdef CONFIG_SYSCTL
406extern int dccp_sysctl_init(void);
407extern void dccp_sysctl_exit(void);
408#else
409static inline int dccp_sysctl_init(void)
410{
411 return 0;
412}
413
414static inline void dccp_sysctl_exit(void)
415{
416}
417#endif
418
7c657876 419#endif /* _DCCP_H */