aboutsummaryrefslogtreecommitdiffstats
path: root/net/dccp/ackvec.h
diff options
context:
space:
mode:
authorDavid S. Miller <davem@davemloft.net>2008-09-08 20:28:59 -0400
committerDavid S. Miller <davem@davemloft.net>2008-09-08 20:28:59 -0400
commit0a68a20cc3eafa73bb54097c28b921147d7d3685 (patch)
tree8e5f315226b618cb8e050a0c7653c8ec134501e3 /net/dccp/ackvec.h
parent17dce5dfe38ae2fb359b61e855f5d8a3a8b7892b (diff)
parenta3cbdde8e9c38b66b4f13ac5d6ff1939ded0ff20 (diff)
Merge branch 'dccp' of git://eden-feed.erg.abdn.ac.uk/dccp_exp
Conflicts: net/dccp/input.c net/dccp/options.c
Diffstat (limited to 'net/dccp/ackvec.h')
-rw-r--r--net/dccp/ackvec.h204
1 files changed, 91 insertions, 113 deletions
diff --git a/net/dccp/ackvec.h b/net/dccp/ackvec.h
index bcb64fb4acef..6cdca79a99f7 100644
--- a/net/dccp/ackvec.h
+++ b/net/dccp/ackvec.h
@@ -3,156 +3,134 @@
3/* 3/*
4 * net/dccp/ackvec.h 4 * net/dccp/ackvec.h
5 * 5 *
6 * An implementation of the DCCP protocol 6 * An implementation of Ack Vectors for the DCCP protocol
7 * Copyright (c) 2007 University of Aberdeen, Scotland, UK
7 * Copyright (c) 2005 Arnaldo Carvalho de Melo <acme@mandriva.com> 8 * Copyright (c) 2005 Arnaldo Carvalho de Melo <acme@mandriva.com>
8 *
9 * This program is free software; you can redistribute it and/or modify it 9 * This program is free software; you can redistribute it and/or modify it
10 * under the terms of the GNU General Public License version 2 as 10 * under the terms of the GNU General Public License version 2 as
11 * published by the Free Software Foundation. 11 * published by the Free Software Foundation.
12 */ 12 */
13 13
14#include <linux/dccp.h>
14#include <linux/compiler.h> 15#include <linux/compiler.h>
15#include <linux/ktime.h>
16#include <linux/list.h> 16#include <linux/list.h>
17#include <linux/types.h> 17#include <linux/types.h>
18 18
19/* Read about the ECN nonce to see why it is 253 */ 19/*
20#define DCCP_MAX_ACKVEC_OPT_LEN 253 20 * Ack Vector buffer space is static, in multiples of %DCCP_SINGLE_OPT_MAXLEN,
21/* We can spread an ack vector across multiple options */ 21 * the maximum size of a single Ack Vector. Setting %DCCPAV_NUM_ACKVECS to 1
22#define DCCP_MAX_ACKVEC_LEN (DCCP_MAX_ACKVEC_OPT_LEN * 2) 22 * will be sufficient for most cases of low Ack Ratios, using a value of 2 gives
23 * more headroom if Ack Ratio is higher or when the sender acknowledges slowly.
24 * The maximum value is bounded by the u16 types for indices and functions.
25 */
26#define DCCPAV_NUM_ACKVECS 2
27#define DCCPAV_MAX_ACKVEC_LEN (DCCP_SINGLE_OPT_MAXLEN * DCCPAV_NUM_ACKVECS)
23 28
24#define DCCP_ACKVEC_STATE_RECEIVED 0 29/* Estimated minimum average Ack Vector length - used for updating MPS */
25#define DCCP_ACKVEC_STATE_ECN_MARKED (1 << 6) 30#define DCCPAV_MIN_OPTLEN 16
26#define DCCP_ACKVEC_STATE_NOT_RECEIVED (3 << 6)
27 31
28#define DCCP_ACKVEC_STATE_MASK 0xC0 /* 11000000 */ 32/* Threshold for coping with large bursts of losses */
29#define DCCP_ACKVEC_LEN_MASK 0x3F /* 00111111 */ 33#define DCCPAV_BURST_THRESH (DCCPAV_MAX_ACKVEC_LEN / 8)
30 34
31/** struct dccp_ackvec - ack vector 35enum dccp_ackvec_states {
32 * 36 DCCPAV_RECEIVED = 0x00,
33 * This data structure is the one defined in RFC 4340, Appendix A. 37 DCCPAV_ECN_MARKED = 0x40,
34 * 38 DCCPAV_RESERVED = 0x80,
35 * @av_buf_head - circular buffer head 39 DCCPAV_NOT_RECEIVED = 0xC0
36 * @av_buf_tail - circular buffer tail 40};
37 * @av_buf_ackno - ack # of the most recent packet acknowledgeable in the 41#define DCCPAV_MAX_RUNLEN 0x3F
38 * buffer (i.e. %av_buf_head) 42
39 * @av_buf_nonce - the one-bit sum of the ECN Nonces on all packets acked 43static inline u8 dccp_ackvec_runlen(const u8 *cell)
40 * by the buffer with State 0 44{
41 * 45 return *cell & DCCPAV_MAX_RUNLEN;
42 * Additionally, the HC-Receiver must keep some information about the 46}
43 * Ack Vectors it has recently sent. For each packet sent carrying an 47
44 * Ack Vector, it remembers four variables: 48static inline u8 dccp_ackvec_state(const u8 *cell)
49{
50 return *cell & ~DCCPAV_MAX_RUNLEN;
51}
52
53/** struct dccp_ackvec - Ack Vector main data structure
45 * 54 *
46 * @av_records - list of dccp_ackvec_record 55 * This implements a fixed-size circular buffer within an array and is largely
47 * @av_ack_nonce - the one-bit sum of the ECN Nonces for all State 0. 56 * based on Appendix A of RFC 4340.
48 * 57 *
49 * @av_time - the time in usecs 58 * @av_buf: circular buffer storage area
50 * @av_buf - circular buffer of acknowledgeable packets 59 * @av_buf_head: head index; begin of live portion in @av_buf
60 * @av_buf_tail: tail index; first index _after_ the live portion in @av_buf
61 * @av_buf_ackno: highest seqno of acknowledgeable packet recorded in @av_buf
62 * @av_tail_ackno: lowest seqno of acknowledgeable packet recorded in @av_buf
63 * @av_buf_nonce: ECN nonce sums, each covering subsequent segments of up to
64 * %DCCP_SINGLE_OPT_MAXLEN cells in the live portion of @av_buf
65 * @av_overflow: if 1 then buf_head == buf_tail indicates buffer wraparound
66 * @av_records: list of %dccp_ackvec_record (Ack Vectors sent previously)
51 */ 67 */
52struct dccp_ackvec { 68struct dccp_ackvec {
53 u64 av_buf_ackno; 69 u8 av_buf[DCCPAV_MAX_ACKVEC_LEN];
54 struct list_head av_records;
55 ktime_t av_time;
56 u16 av_buf_head; 70 u16 av_buf_head;
57 u16 av_vec_len; 71 u16 av_buf_tail;
58 u8 av_buf_nonce; 72 u64 av_buf_ackno:48;
59 u8 av_ack_nonce; 73 u64 av_tail_ackno:48;
60 u8 av_buf[DCCP_MAX_ACKVEC_LEN]; 74 bool av_buf_nonce[DCCPAV_NUM_ACKVECS];
75 u8 av_overflow:1;
76 struct list_head av_records;
61}; 77};
62 78
63/** struct dccp_ackvec_record - ack vector record 79/** struct dccp_ackvec_record - Records information about sent Ack Vectors
64 * 80 *
65 * ACK vector record as defined in Appendix A of spec. 81 * These list entries define the additional information which the HC-Receiver
82 * keeps about recently-sent Ack Vectors; again refer to RFC 4340, Appendix A.
66 * 83 *
67 * The list is sorted by avr_ack_seqno 84 * @avr_node: the list node in @av_records
85 * @avr_ack_seqno: sequence number of the packet the Ack Vector was sent on
86 * @avr_ack_ackno: the Ack number that this record/Ack Vector refers to
87 * @avr_ack_ptr: pointer into @av_buf where this record starts
88 * @avr_ack_runlen: run length of @avr_ack_ptr at the time of sending
89 * @avr_ack_nonce: the sum of @av_buf_nonce's at the time this record was sent
68 * 90 *
69 * @avr_node - node in av_records 91 * The list as a whole is sorted in descending order by @avr_ack_seqno.
70 * @avr_ack_seqno - sequence number of the packet this record was sent on
71 * @avr_ack_ackno - sequence number being acknowledged
72 * @avr_ack_ptr - pointer into av_buf where this record starts
73 * @avr_ack_nonce - av_ack_nonce at the time this record was sent
74 * @avr_sent_len - lenght of the record in av_buf
75 */ 92 */
76struct dccp_ackvec_record { 93struct dccp_ackvec_record {
77 struct list_head avr_node; 94 struct list_head avr_node;
78 u64 avr_ack_seqno; 95 u64 avr_ack_seqno:48;
79 u64 avr_ack_ackno; 96 u64 avr_ack_ackno:48;
80 u16 avr_ack_ptr; 97 u16 avr_ack_ptr;
81 u16 avr_sent_len; 98 u8 avr_ack_runlen;
82 u8 avr_ack_nonce; 99 u8 avr_ack_nonce:1;
83}; 100};
84 101
85struct sock; 102extern int dccp_ackvec_init(void);
86struct sk_buff;
87
88#ifdef CONFIG_IP_DCCP_ACKVEC
89extern int dccp_ackvec_init(void);
90extern void dccp_ackvec_exit(void); 103extern void dccp_ackvec_exit(void);
91 104
92extern struct dccp_ackvec *dccp_ackvec_alloc(const gfp_t priority); 105extern struct dccp_ackvec *dccp_ackvec_alloc(const gfp_t priority);
93extern void dccp_ackvec_free(struct dccp_ackvec *av); 106extern void dccp_ackvec_free(struct dccp_ackvec *av);
94 107
95extern int dccp_ackvec_add(struct dccp_ackvec *av, const struct sock *sk, 108extern void dccp_ackvec_input(struct dccp_ackvec *av, struct sk_buff *skb);
96 const u64 ackno, const u8 state); 109extern int dccp_ackvec_update_records(struct dccp_ackvec *av, u64 seq, u8 sum);
97 110extern void dccp_ackvec_clear_state(struct dccp_ackvec *av, const u64 ackno);
98extern void dccp_ackvec_check_rcv_ackno(struct dccp_ackvec *av, 111extern u16 dccp_ackvec_buflen(const struct dccp_ackvec *av);
99 struct sock *sk, const u64 ackno);
100extern int dccp_ackvec_parse(struct sock *sk, const struct sk_buff *skb,
101 u64 *ackno, const u8 opt,
102 const u8 *value, const u8 len);
103 112
104extern int dccp_insert_option_ackvec(struct sock *sk, struct sk_buff *skb); 113static inline bool dccp_ackvec_is_empty(const struct dccp_ackvec *av)
105
106static inline int dccp_ackvec_pending(const struct dccp_ackvec *av)
107{
108 return av->av_vec_len;
109}
110#else /* CONFIG_IP_DCCP_ACKVEC */
111static inline int dccp_ackvec_init(void)
112{ 114{
113 return 0; 115 return av->av_overflow == 0 && av->av_buf_head == av->av_buf_tail;
114} 116}
115 117
116static inline void dccp_ackvec_exit(void) 118/**
117{ 119 * struct dccp_ackvec_parsed - Record offsets of Ack Vectors in skb
118} 120 * @vec: start of vector (offset into skb)
119 121 * @len: length of @vec
120static inline struct dccp_ackvec *dccp_ackvec_alloc(const gfp_t priority) 122 * @nonce: whether @vec had an ECN nonce of 0 or 1
121{ 123 * @node: FIFO - arranged in descending order of ack_ackno
122 return NULL; 124 * This structure is used by CCIDs to access Ack Vectors in a received skb.
123} 125 */
124 126struct dccp_ackvec_parsed {
125static inline void dccp_ackvec_free(struct dccp_ackvec *av) 127 u8 *vec,
126{ 128 len,
127} 129 nonce:1;
128 130 struct list_head node;
129static inline int dccp_ackvec_add(struct dccp_ackvec *av, const struct sock *sk, 131};
130 const u64 ackno, const u8 state)
131{
132 return -1;
133}
134
135static inline void dccp_ackvec_check_rcv_ackno(struct dccp_ackvec *av,
136 struct sock *sk, const u64 ackno)
137{
138}
139
140static inline int dccp_ackvec_parse(struct sock *sk, const struct sk_buff *skb,
141 const u64 *ackno, const u8 opt,
142 const u8 *value, const u8 len)
143{
144 return -1;
145}
146
147static inline int dccp_insert_option_ackvec(const struct sock *sk,
148 const struct sk_buff *skb)
149{
150 return -1;
151}
152 132
153static inline int dccp_ackvec_pending(const struct dccp_ackvec *av) 133extern int dccp_ackvec_parsed_add(struct list_head *head,
154{ 134 u8 *vec, u8 len, u8 nonce);
155 return 0; 135extern void dccp_ackvec_parsed_cleanup(struct list_head *parsed_chunks);
156}
157#endif /* CONFIG_IP_DCCP_ACKVEC */
158#endif /* _ACKVEC_H */ 136#endif /* _ACKVEC_H */