net/dccp/ccids/ccid3.h

   1 /*
   2  *  net/dccp/ccids/ccid3.h
   3  *
   4  *  Copyright (c) 2005 The University of Waikato, Hamilton, New Zealand.
   5  *
   6  *  An implementation of the DCCP protocol
   7  *
   8  *  This code has been developed by the University of Waikato WAND
   9  *  research group. For further information please see http://www.wand.net.nz/
  10  *  or e-mail Ian McDonald - iam4@cs.waikato.ac.nz
  11  *
  12  *  This code also uses code from Lulea University, rereleased as GPL by its
  13  *  authors:
  14  *  Copyright (c) 2003 Nils-Erik Mattsson, Joacim Haggmark, Magnus Erixzon
  15  *
  16  *  Changes to meet Linux coding standards, to make it meet latest ccid3 draft
  17  *  and to make it work as a loadable module in the DCCP stack written by
  18  *  Arnaldo Carvalho de Melo <acme@conectiva.com.br>.
  19  *
  20  *  Copyright (c) 2005 Arnaldo Carvalho de Melo <acme@conectiva.com.br>
  21  *
  22  *  This program is free software; you can redistribute it and/or modify
  23  *  it under the terms of the GNU General Public License as published by
  24  *  the Free Software Foundation; either version 2 of the License, or
  25  *  (at your option) any later version.
  26  *
  27  *  This program is distributed in the hope that it will be useful,
  28  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  29  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  30  *  GNU General Public License for more details.
  31  *
  32  *  You should have received a copy of the GNU General Public License
  33  *  along with this program; if not, write to the Free Software
  34  *  Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  35  */
  36 #ifndef _DCCP_CCID3_H_
  37 #define _DCCP_CCID3_H_
  38
  39 #include <linux/config.h>
  40 #include <linux/list.h>
  41 #include <linux/time.h>
  42 #include <linux/types.h>
  43
  44 #define TFRC_MIN_PACKET_SIZE       16
  45 #define TFRC_STD_PACKET_SIZE      256
  46 #define TFRC_MAX_PACKET_SIZE    65535
  47
  48 /* Two seconds as per CCID3 spec */
  49 #define TFRC_INITIAL_TIMEOUT       (2 * USEC_PER_SEC)
  50
  51 /* In usecs - half the scheduling granularity as per RFC3448 4.6 */
  52 #define TFRC_OPSYS_HALF_TIME_GRAN  (USEC_PER_SEC / (2 * HZ))
  53
  54 #define TFRC_WIN_COUNT_PER_RTT      4
  55 #define TFRC_WIN_COUNT_LIMIT       16
  56
  57 /* In seconds */
  58 #define TFRC_MAX_BACK_OFF_TIME     64
  59
  60 #define TFRC_SMALLEST_P            40
  61
  62 #define TFRC_RECV_IVAL_F_LENGTH     8
  63
  64 /* Number of later packets received before one is considered lost */
  65 #define TFRC_RECV_NUM_LATE_LOSS 3
  66
  67 enum ccid3_options {
  68         TFRC_OPT_LOSS_EVENT_RATE = 192,
  69         TFRC_OPT_LOSS_INTERVALS  = 193,
  70         TFRC_OPT_RECEIVE_RATE    = 194,
  71 };
  72
  73 struct ccid3_options_received {
  74         u64 ccid3or_seqno:48,
  75             ccid3or_loss_intervals_idx:16;
  76         u16 ccid3or_loss_intervals_len;
  77         u32 ccid3or_loss_event_rate;
  78         u32 ccid3or_receive_rate;
  79 };
  80
  81 /** struct ccid3_hc_tx_sock - CCID3 sender half connection sock
  82  *
  83   * @ccid3hctx_state - Sender state
  84   * @ccid3hctx_x - Current sending rate
  85   * @ccid3hctx_x_recv - Receive rate
  86   * @ccid3hctx_x_calc - Calculated send (?) rate
  87   * @ccid3hctx_s - Packet size
  88   * @ccid3hctx_rtt - Estimate of current round trip time in usecs
  89   * @@ccid3hctx_p - Current loss event rate (0-1) scaled by 1000000
  90   * @ccid3hctx_last_win_count - Last window counter sent
  91   * @ccid3hctx_t_last_win_count - Timestamp of earliest packet
  92   *                               with last_win_count value sent
  93   * @ccid3hctx_no_feedback_timer - Handle to no feedback timer
  94   * @ccid3hctx_idle - FIXME
  95   * @ccid3hctx_t_ld - Time last doubled during slow start
  96   * @ccid3hctx_t_nom - Nominal send time of next packet
  97   * @ccid3hctx_t_ipi - Interpacket (send) interval
  98   * @ccid3hctx_delta - Send timer delta
  99   * @ccid3hctx_hist - Packet history
 100   */
 101 struct ccid3_hc_tx_sock {
 102         u32                             ccid3hctx_x;
 103         u32                             ccid3hctx_x_recv;
 104         u32                             ccid3hctx_x_calc;
 105         u16                             ccid3hctx_s;
 106         u32                             ccid3hctx_rtt;
 107         u32                             ccid3hctx_p;
 108         u8                              ccid3hctx_state;
 109         u8                              ccid3hctx_last_win_count;
 110         u8                              ccid3hctx_idle;
 111         struct timeval                  ccid3hctx_t_last_win_count;
 112         struct timer_list               ccid3hctx_no_feedback_timer;
 113         struct timeval                  ccid3hctx_t_ld;
 114         struct timeval                  ccid3hctx_t_nom;
 115         u32                             ccid3hctx_t_rto;
 116         u32                             ccid3hctx_t_ipi;
 117         u32                             ccid3hctx_delta;
 118         struct list_head                ccid3hctx_hist;
 119         struct ccid3_options_received   ccid3hctx_options_received;
 120 };
 121
 122 struct ccid3_loss_interval_hist_entry {
 123         struct list_head        ccid3lih_node;
 124         u64                     ccid3lih_seqno:48,
 125                                 ccid3lih_win_count:4;
 126         u32                     ccid3lih_interval;
 127 };
 128
 129 struct ccid3_hc_rx_sock {
 130         u64                     ccid3hcrx_seqno_last_counter:48,
 131                                 ccid3hcrx_state:8,
 132                                 ccid3hcrx_last_counter:4;
 133         unsigned long           ccid3hcrx_rtt;
 134         u32                     ccid3hcrx_p;
 135         u32                     ccid3hcrx_bytes_recv;
 136         struct timeval          ccid3hcrx_tstamp_last_feedback;
 137         struct timeval          ccid3hcrx_tstamp_last_ack;
 138         struct list_head        ccid3hcrx_hist;
 139         struct list_head        ccid3hcrx_loss_interval_hist;
 140         u16                     ccid3hcrx_s;
 141         u32                     ccid3hcrx_pinv;
 142         u32                     ccid3hcrx_elapsed_time;
 143         u32                     ccid3hcrx_x_recv;
 144 };
 145
 146 #define ccid3_hc_tx_field(s,field) (s->dccps_hc_tx_ccid_private == NULL ? 0 : \
 147     ((struct ccid3_hc_tx_sock *)s->dccps_hc_tx_ccid_private)->ccid3hctx_##field)
 148
 149 #define ccid3_hc_rx_field(s,field) (s->dccps_hc_rx_ccid_private == NULL ? 0 : \
 150     ((struct ccid3_hc_rx_sock *)s->dccps_hc_rx_ccid_private)->ccid3hcrx_##field)
 151
 152 #endif /* _DCCP_CCID3_H_ */