d7dc7e5f49
This completes the implementation of a circular buffer for Ack Vectors, by
extending the current (linear array-based) implementation. The changes are:
(a) An `overflow' flag to deal with the case of overflow. As before, dynamic
growth of the buffer will not be supported; but code will be added to deal
robustly with overflowing Ack Vector buffers.
(b) A `tail_seqno' field. When naively implementing the algorithm of Appendix A
in RFC 4340, problems arise whenever subsequent Ack Vector records overlap,
which can bring the entire run length calculation completely out of synch.
(This is documented on http://www.erg.abdn.ac.uk/users/gerrit/dccp/notes/\
ack_vectors/tracking_tail_ackno/ .)
(c) The buffer lengthi is now computed dynamically (i.e. current fill level),
as the span between head to tail.
As a result, dccp_ackvec_pending() is now simpler - the #ifdef is no longer
necessary since buf_empty is always true when IP_DCCP_ACKVEC is not configured.
Note on overflow handling:
-------------------------
The Ack Vector code previously simply started to drop packets when the
Ack Vector buffer overflowed. This means that the userspace application
will not be able to receive, only because of an Ack Vector storage problem.
Furthermore, overflow may be transient, so that applications may later
recover from the overflow. Recovering from dropped packets is more difficult
(e.g. video key frames).
Hence the patch uses a different policy: when the buffer overflows, the oldest
entries are subsequently overwritten. This has a higher chance of recovery.
Details are on http://www.erg.abdn.ac.uk/users/gerrit/dccp/notes/ack_vectors/
Signed-off-by: Gerrit Renker <gerrit@erg.abdn.ac.uk>
180 lines
5.4 KiB
C
180 lines
5.4 KiB
C
#ifndef _ACKVEC_H
|
|
#define _ACKVEC_H
|
|
/*
|
|
* net/dccp/ackvec.h
|
|
*
|
|
* An implementation of Ack Vectors for the DCCP protocol
|
|
* Copyright (c) 2007 University of Aberdeen, Scotland, UK
|
|
* Copyright (c) 2005 Arnaldo Carvalho de Melo <acme@mandriva.com>
|
|
* This program is free software; you can redistribute it and/or modify it
|
|
* under the terms of the GNU General Public License version 2 as
|
|
* published by the Free Software Foundation.
|
|
*/
|
|
|
|
#include <linux/dccp.h>
|
|
#include <linux/compiler.h>
|
|
#include <linux/list.h>
|
|
#include <linux/types.h>
|
|
|
|
/*
|
|
* Ack Vector buffer space is static, in multiples of %DCCP_SINGLE_OPT_MAXLEN,
|
|
* the maximum size of a single Ack Vector. Setting %DCCPAV_NUM_ACKVECS to 1
|
|
* will be sufficient for most cases of low Ack Ratios, using a value of 2 gives
|
|
* more headroom if Ack Ratio is higher or when the sender acknowledges slowly.
|
|
* The maximum value is bounded by the u16 types for indices and functions.
|
|
*/
|
|
#define DCCPAV_NUM_ACKVECS 2
|
|
#define DCCPAV_MAX_ACKVEC_LEN (DCCP_SINGLE_OPT_MAXLEN * DCCPAV_NUM_ACKVECS)
|
|
|
|
/* Estimated minimum average Ack Vector length - used for updating MPS */
|
|
#define DCCPAV_MIN_OPTLEN 16
|
|
|
|
enum dccp_ackvec_states {
|
|
DCCPAV_RECEIVED = 0x00,
|
|
DCCPAV_ECN_MARKED = 0x40,
|
|
DCCPAV_RESERVED = 0x80,
|
|
DCCPAV_NOT_RECEIVED = 0xC0
|
|
};
|
|
#define DCCPAV_MAX_RUNLEN 0x3F
|
|
|
|
static inline u8 dccp_ackvec_runlen(const u8 *cell)
|
|
{
|
|
return *cell & DCCPAV_MAX_RUNLEN;
|
|
}
|
|
|
|
static inline u8 dccp_ackvec_state(const u8 *cell)
|
|
{
|
|
return *cell & ~DCCPAV_MAX_RUNLEN;
|
|
}
|
|
|
|
/** struct dccp_ackvec - Ack Vector main data structure
|
|
*
|
|
* This implements a fixed-size circular buffer within an array and is largely
|
|
* based on Appendix A of RFC 4340.
|
|
*
|
|
* @av_buf: circular buffer storage area
|
|
* @av_buf_head: head index; begin of live portion in @av_buf
|
|
* @av_buf_tail: tail index; first index _after_ the live portion in @av_buf
|
|
* @av_buf_ackno: highest seqno of acknowledgeable packet recorded in @av_buf
|
|
* @av_tail_ackno: lowest seqno of acknowledgeable packet recorded in @av_buf
|
|
* @av_buf_nonce: ECN nonce sums, each covering subsequent segments of up to
|
|
* %DCCP_SINGLE_OPT_MAXLEN cells in the live portion of @av_buf
|
|
* @av_overflow: if 1 then buf_head == buf_tail indicates buffer wraparound
|
|
* @av_records: list of %dccp_ackvec_record (Ack Vectors sent previously)
|
|
* @av_veclen: length of the live portion of @av_buf
|
|
*/
|
|
struct dccp_ackvec {
|
|
u8 av_buf[DCCPAV_MAX_ACKVEC_LEN];
|
|
u16 av_buf_head;
|
|
u16 av_buf_tail;
|
|
u64 av_buf_ackno:48;
|
|
u64 av_tail_ackno:48;
|
|
bool av_buf_nonce[DCCPAV_NUM_ACKVECS];
|
|
u8 av_overflow:1;
|
|
struct list_head av_records;
|
|
u16 av_vec_len;
|
|
};
|
|
|
|
/** struct dccp_ackvec_record - Records information about sent Ack Vectors
|
|
*
|
|
* These list entries define the additional information which the HC-Receiver
|
|
* keeps about recently-sent Ack Vectors; again refer to RFC 4340, Appendix A.
|
|
*
|
|
* @avr_node: the list node in @av_records
|
|
* @avr_ack_seqno: sequence number of the packet the Ack Vector was sent on
|
|
* @avr_ack_ackno: the Ack number that this record/Ack Vector refers to
|
|
* @avr_ack_ptr: pointer into @av_buf where this record starts
|
|
* @avr_ack_runlen: run length of @avr_ack_ptr at the time of sending
|
|
* @avr_ack_nonce: the sum of @av_buf_nonce's at the time this record was sent
|
|
*
|
|
* The list as a whole is sorted in descending order by @avr_ack_seqno.
|
|
*/
|
|
struct dccp_ackvec_record {
|
|
struct list_head avr_node;
|
|
u64 avr_ack_seqno:48;
|
|
u64 avr_ack_ackno:48;
|
|
u16 avr_ack_ptr;
|
|
u8 avr_ack_runlen;
|
|
u8 avr_ack_nonce:1;
|
|
};
|
|
|
|
struct sock;
|
|
struct sk_buff;
|
|
|
|
#ifdef CONFIG_IP_DCCP_ACKVEC
|
|
extern int dccp_ackvec_init(void);
|
|
extern void dccp_ackvec_exit(void);
|
|
|
|
extern struct dccp_ackvec *dccp_ackvec_alloc(const gfp_t priority);
|
|
extern void dccp_ackvec_free(struct dccp_ackvec *av);
|
|
|
|
extern int dccp_ackvec_add(struct dccp_ackvec *av, const struct sock *sk,
|
|
const u64 ackno, const u8 state);
|
|
|
|
extern void dccp_ackvec_check_rcv_ackno(struct dccp_ackvec *av,
|
|
struct sock *sk, const u64 ackno);
|
|
extern int dccp_ackvec_parse(struct sock *sk, const struct sk_buff *skb,
|
|
u64 *ackno, const u8 opt,
|
|
const u8 *value, const u8 len);
|
|
|
|
extern int dccp_ackvec_update_records(struct dccp_ackvec *av, u64 seq, u8 sum);
|
|
extern u16 dccp_ackvec_buflen(const struct dccp_ackvec *av);
|
|
|
|
static inline bool dccp_ackvec_is_empty(const struct dccp_ackvec *av)
|
|
{
|
|
return av->av_overflow == 0 && av->av_buf_head == av->av_buf_tail;
|
|
}
|
|
#else /* CONFIG_IP_DCCP_ACKVEC */
|
|
static inline int dccp_ackvec_init(void)
|
|
{
|
|
return 0;
|
|
}
|
|
|
|
static inline void dccp_ackvec_exit(void)
|
|
{
|
|
}
|
|
|
|
static inline struct dccp_ackvec *dccp_ackvec_alloc(const gfp_t priority)
|
|
{
|
|
return NULL;
|
|
}
|
|
|
|
static inline void dccp_ackvec_free(struct dccp_ackvec *av)
|
|
{
|
|
}
|
|
|
|
static inline int dccp_ackvec_add(struct dccp_ackvec *av, const struct sock *sk,
|
|
const u64 ackno, const u8 state)
|
|
{
|
|
return -1;
|
|
}
|
|
|
|
static inline void dccp_ackvec_check_rcv_ackno(struct dccp_ackvec *av,
|
|
struct sock *sk, const u64 ackno)
|
|
{
|
|
}
|
|
|
|
static inline int dccp_ackvec_parse(struct sock *sk, const struct sk_buff *skb,
|
|
const u64 *ackno, const u8 opt,
|
|
const u8 *value, const u8 len)
|
|
{
|
|
return -1;
|
|
}
|
|
|
|
static inline int dccp_ackvec_update_records(struct dccp_ackvec *av, u64 seq, u8 nonce)
|
|
{
|
|
return -1;
|
|
}
|
|
|
|
static inline u16 dccp_ackvec_buflen(const struct dccp_ackvec *av)
|
|
{
|
|
return 0;
|
|
}
|
|
|
|
static inline bool dccp_ackvec_is_empty(const struct dccp_ackvec *av)
|
|
{
|
|
return true;
|
|
}
|
|
#endif /* CONFIG_IP_DCCP_ACKVEC */
|
|
#endif /* _ACKVEC_H */
|