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