SAFE public projects git trees. - safe/jmp/linux-2.6/blob - net/dccp/ackvec.h

   1 #ifndef _ACKVEC_H
   2 #define _ACKVEC_H
   3 /*
   4  *  net/dccp/ackvec.h
   5  *
   6  *  An implementation of Ack Vectors for the DCCP protocol
   7  *  Copyright (c) 2007 University of Aberdeen, Scotland, UK
   8  *  Copyright (c) 2005 Arnaldo Carvalho de Melo <acme@mandriva.com>
   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
  11  *      published by the Free Software Foundation.
  12  */
  13
  14 #include <linux/dccp.h>
  15 #include <linux/compiler.h>
  16 #include <linux/list.h>
  17 #include <linux/types.h>
  18
  19 /*
  20  * Ack Vector buffer space is static, in multiples of %DCCP_SINGLE_OPT_MAXLEN,
  21  * the maximum size of a single Ack Vector. Setting %DCCPAV_NUM_ACKVECS to 1
  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)
  28
  29 /* Estimated minimum average Ack Vector length - used for updating MPS */
  30 #define DCCPAV_MIN_OPTLEN       16
  31
  32 /* Threshold for coping with large bursts of losses */
  33 #define DCCPAV_BURST_THRESH     (DCCPAV_MAX_ACKVEC_LEN / 8)
  34
  35 enum dccp_ackvec_states {
  36         DCCPAV_RECEIVED =       0x00,
  37         DCCPAV_ECN_MARKED =     0x40,
  38         DCCPAV_RESERVED =       0x80,
  39         DCCPAV_NOT_RECEIVED =   0xC0
  40 };
  41 #define DCCPAV_MAX_RUNLEN       0x3F
  42
  43 static inline u8 dccp_ackvec_runlen(const u8 *cell)
  44 {
  45         return *cell & DCCPAV_MAX_RUNLEN;
  46 }
  47
  48 static 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
  54  *
  55  * This implements a fixed-size circular buffer within an array and is largely
  56  * based on Appendix A of RFC 4340.
  57  *
  58  * @av_buf:        circular buffer storage area
  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)
  67  * @av_veclen:     length of the live portion of @av_buf
  68  */
  69 struct dccp_ackvec {
  70         u8                      av_buf[DCCPAV_MAX_ACKVEC_LEN];
  71         u16                     av_buf_head;
  72         u16                     av_buf_tail;
  73         u64                     av_buf_ackno:48;
  74         u64                     av_tail_ackno:48;
  75         bool                    av_buf_nonce[DCCPAV_NUM_ACKVECS];
  76         u8                      av_overflow:1;
  77         struct list_head        av_records;
  78         u16                     av_vec_len;
  79 };
  80
  81 /** struct dccp_ackvec_record - Records information about sent Ack Vectors
  82  *
  83  * These list entries define the additional information which the HC-Receiver
  84  * keeps about recently-sent Ack Vectors; again refer to RFC 4340, Appendix A.
  85  *
  86  * @avr_node:       the list node in @av_records
  87  * @avr_ack_seqno:  sequence number of the packet the Ack Vector was sent on
  88  * @avr_ack_ackno:  the Ack number that this record/Ack Vector refers to
  89  * @avr_ack_ptr:    pointer into @av_buf where this record starts
  90  * @avr_ack_runlen: run length of @avr_ack_ptr at the time of sending
  91  * @avr_ack_nonce:  the sum of @av_buf_nonce's at the time this record was sent
  92  *
  93  * The list as a whole is sorted in descending order by @avr_ack_seqno.
  94  */
  95 struct dccp_ackvec_record {
  96         struct list_head avr_node;
  97         u64              avr_ack_seqno:48;
  98         u64              avr_ack_ackno:48;
  99         u16              avr_ack_ptr;
 100         u8               avr_ack_runlen;
 101         u8               avr_ack_nonce:1;
 102 };
 103
 104 struct sock;
 105 struct sk_buff;
 106
 107 #ifdef CONFIG_IP_DCCP_ACKVEC
 108 extern int dccp_ackvec_init(void);
 109 extern void dccp_ackvec_exit(void);
 110
 111 extern struct dccp_ackvec *dccp_ackvec_alloc(const gfp_t priority);
 112 extern void dccp_ackvec_free(struct dccp_ackvec *av);
 113
 114 extern int dccp_ackvec_add(struct dccp_ackvec *av, const struct sock *sk,
 115                            const u64 ackno, const u8 state);
 116
 117 extern void dccp_ackvec_check_rcv_ackno(struct dccp_ackvec *av,
 118                                         struct sock *sk, const u64 ackno);
 119 extern int dccp_ackvec_parse(struct sock *sk, const struct sk_buff *skb,
 120                              u64 *ackno, const u8 opt,
 121                              const u8 *value, const u8 len);
 122
 123 extern void dccp_ackvec_input(struct dccp_ackvec *av, struct sk_buff *skb);
 124 extern int  dccp_ackvec_update_records(struct dccp_ackvec *av, u64 seq, u8 sum);
 125 extern void dccp_ackvec_clear_state(struct dccp_ackvec *av, const u64 ackno);
 126 extern u16  dccp_ackvec_buflen(const struct dccp_ackvec *av);
 127
 128 static inline bool dccp_ackvec_is_empty(const struct dccp_ackvec *av)
 129 {
 130         return av->av_overflow == 0 && av->av_buf_head == av->av_buf_tail;
 131 }
 132 #else /* CONFIG_IP_DCCP_ACKVEC */
 133 static inline int dccp_ackvec_init(void)
 134 {
 135         return 0;
 136 }
 137
 138 static inline void dccp_ackvec_exit(void)
 139 {
 140 }
 141
 142 static inline struct dccp_ackvec *dccp_ackvec_alloc(const gfp_t priority)
 143 {
 144         return NULL;
 145 }
 146
 147 static inline void dccp_ackvec_free(struct dccp_ackvec *av)
 148 {
 149 }
 150
 151 static inline void dccp_ackvec_input(struct dccp_ackvec *av, struct sk_buff *skb)
 152 {
 153
 154 }
 155
 156 static inline int dccp_ackvec_add(struct dccp_ackvec *av, const struct sock *sk,
 157                                   const u64 ackno, const u8 state)
 158 {
 159         return -1;
 160 }
 161
 162 static inline void dccp_ackvec_clear_state(struct dccp_ackvec *av,
 163                                             const u64 ackno)
 164 {
 165 }
 166
 167 static inline void dccp_ackvec_check_rcv_ackno(struct dccp_ackvec *av,
 168                                                struct sock *sk, const u64 ackno)
 169 {
 170 }
 171
 172 static inline int dccp_ackvec_parse(struct sock *sk, const struct sk_buff *skb,
 173                                     const u64 *ackno, const u8 opt,
 174                                     const u8 *value, const u8 len)
 175 {
 176         return -1;
 177 }
 178
 179 static inline int dccp_ackvec_update_records(struct dccp_ackvec *av, u64 seq, u8 nonce)
 180 {
 181         return -1;
 182 }
 183
 184 static inline u16 dccp_ackvec_buflen(const struct dccp_ackvec *av)
 185 {
 186         return 0;
 187 }
 188
 189 static inline bool dccp_ackvec_is_empty(const struct dccp_ackvec *av)
 190 {
 191         return true;
 192 }
 193 #endif /* CONFIG_IP_DCCP_ACKVEC */
 194 #endif /* _ACKVEC_H */