17c657876SArnaldo Carvalho de Melo /* 2b84a2189SArnaldo Carvalho de Melo * Copyright (c) 2005-7 The University of Waikato, Hamilton, New Zealand. 3b84a2189SArnaldo Carvalho de Melo * Copyright (c) 2007 The University of Aberdeen, Scotland, UK 47c657876SArnaldo Carvalho de Melo * 57c657876SArnaldo Carvalho de Melo * An implementation of the DCCP protocol 67c657876SArnaldo Carvalho de Melo * 77c657876SArnaldo Carvalho de Melo * This code has been developed by the University of Waikato WAND 87c657876SArnaldo Carvalho de Melo * research group. For further information please see http://www.wand.net.nz/ 9e6bccd35SIan McDonald * or e-mail Ian McDonald - ian.mcdonald@jandi.co.nz 107c657876SArnaldo Carvalho de Melo * 117c657876SArnaldo Carvalho de Melo * This code also uses code from Lulea University, rereleased as GPL by its 127c657876SArnaldo Carvalho de Melo * authors: 137c657876SArnaldo Carvalho de Melo * Copyright (c) 2003 Nils-Erik Mattsson, Joacim Haggmark, Magnus Erixzon 147c657876SArnaldo Carvalho de Melo * 157c657876SArnaldo Carvalho de Melo * Changes to meet Linux coding standards, to make it meet latest ccid3 draft 167c657876SArnaldo Carvalho de Melo * and to make it work as a loadable module in the DCCP stack written by 177c657876SArnaldo Carvalho de Melo * Arnaldo Carvalho de Melo <acme@conectiva.com.br>. 187c657876SArnaldo Carvalho de Melo * 197c657876SArnaldo Carvalho de Melo * Copyright (c) 2005 Arnaldo Carvalho de Melo <acme@conectiva.com.br> 207c657876SArnaldo Carvalho de Melo * 217c657876SArnaldo Carvalho de Melo * This program is free software; you can redistribute it and/or modify 227c657876SArnaldo Carvalho de Melo * it under the terms of the GNU General Public License as published by 237c657876SArnaldo Carvalho de Melo * the Free Software Foundation; either version 2 of the License, or 247c657876SArnaldo Carvalho de Melo * (at your option) any later version. 257c657876SArnaldo Carvalho de Melo * 267c657876SArnaldo Carvalho de Melo * This program is distributed in the hope that it will be useful, 277c657876SArnaldo Carvalho de Melo * but WITHOUT ANY WARRANTY; without even the implied warranty of 287c657876SArnaldo Carvalho de Melo * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 297c657876SArnaldo Carvalho de Melo * GNU General Public License for more details. 307c657876SArnaldo Carvalho de Melo * 317c657876SArnaldo Carvalho de Melo * You should have received a copy of the GNU General Public License 327c657876SArnaldo Carvalho de Melo * along with this program; if not, write to the Free Software 337c657876SArnaldo Carvalho de Melo * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. 347c657876SArnaldo Carvalho de Melo */ 357c657876SArnaldo Carvalho de Melo #ifndef _DCCP_CCID3_H_ 367c657876SArnaldo Carvalho de Melo #define _DCCP_CCID3_H_ 377c657876SArnaldo Carvalho de Melo 388132da4dSGerrit Renker #include <linux/ktime.h> 397c657876SArnaldo Carvalho de Melo #include <linux/list.h> 40cfc3c525SArnaldo Carvalho de Melo #include <linux/types.h> 4165299d6cSArnaldo Carvalho de Melo #include <linux/tfrc.h> 42954c2db8SGerrit Renker #include "lib/tfrc.h" 4391f0ebf7SArnaldo Carvalho de Melo #include "../ccid.h" 44cfc3c525SArnaldo Carvalho de Melo 4548e03eeeSGerrit Renker /* Two seconds as per RFC 3448 4.2 */ 46cfc3c525SArnaldo Carvalho de Melo #define TFRC_INITIAL_TIMEOUT (2 * USEC_PER_SEC) 47cfc3c525SArnaldo Carvalho de Melo 48cfc3c525SArnaldo Carvalho de Melo /* In usecs - half the scheduling granularity as per RFC3448 4.6 */ 49cfc3c525SArnaldo Carvalho de Melo #define TFRC_OPSYS_HALF_TIME_GRAN (USEC_PER_SEC / (2 * HZ)) 50cfc3c525SArnaldo Carvalho de Melo 51a79ef76fSGerrit Renker /* Parameter t_mbi from [RFC 3448, 4.3]: backoff interval in seconds */ 52a79ef76fSGerrit Renker #define TFRC_T_MBI 64 53cfc3c525SArnaldo Carvalho de Melo 54cfc3c525SArnaldo Carvalho de Melo enum ccid3_options { 55cfc3c525SArnaldo Carvalho de Melo TFRC_OPT_LOSS_EVENT_RATE = 192, 56cfc3c525SArnaldo Carvalho de Melo TFRC_OPT_LOSS_INTERVALS = 193, 57cfc3c525SArnaldo Carvalho de Melo TFRC_OPT_RECEIVE_RATE = 194, 58cfc3c525SArnaldo Carvalho de Melo }; 597c657876SArnaldo Carvalho de Melo 607c657876SArnaldo Carvalho de Melo struct ccid3_options_received { 617c657876SArnaldo Carvalho de Melo u64 ccid3or_seqno:48, 627c657876SArnaldo Carvalho de Melo ccid3or_loss_intervals_idx:16; 637c657876SArnaldo Carvalho de Melo u16 ccid3or_loss_intervals_len; 647c657876SArnaldo Carvalho de Melo u32 ccid3or_loss_event_rate; 657c657876SArnaldo Carvalho de Melo u32 ccid3or_receive_rate; 667c657876SArnaldo Carvalho de Melo }; 677c657876SArnaldo Carvalho de Melo 683c695262SGerrit Renker /* TFRC sender states */ 693c695262SGerrit Renker enum ccid3_hc_tx_states { 703c695262SGerrit Renker TFRC_SSTATE_NO_SENT = 1, 713c695262SGerrit Renker TFRC_SSTATE_NO_FBACK, 723c695262SGerrit Renker TFRC_SSTATE_FBACK, 733c695262SGerrit Renker TFRC_SSTATE_TERM, 743c695262SGerrit Renker }; 753c695262SGerrit Renker 76aa1b1ff0SGerrit Renker /** 77aa1b1ff0SGerrit Renker * struct ccid3_hc_tx_sock - CCID3 sender half-connection socket 78388d5e99SGerrit Renker * @tx_x: Current sending rate in 64 * bytes per second 79388d5e99SGerrit Renker * @tx_x_recv: Receive rate in 64 * bytes per second 80388d5e99SGerrit Renker * @tx_x_calc: Calculated rate in bytes per second 81388d5e99SGerrit Renker * @tx_rtt: Estimate of current round trip time in usecs 82388d5e99SGerrit Renker * @tx_p: Current loss event rate (0-1) scaled by 1000000 83388d5e99SGerrit Renker * @tx_s: Packet size in bytes 84388d5e99SGerrit Renker * @tx_t_rto: Nofeedback Timer setting in usecs 85388d5e99SGerrit Renker * @tx_t_ipi: Interpacket (send) interval (RFC 3448, 4.6) in usecs 86388d5e99SGerrit Renker * @tx_state: Sender state, one of %ccid3_hc_tx_states 87388d5e99SGerrit Renker * @tx_last_win_count: Last window counter sent 88388d5e99SGerrit Renker * @tx_t_last_win_count: Timestamp of earliest packet 89cfc3c525SArnaldo Carvalho de Melo * with last_win_count value sent 90388d5e99SGerrit Renker * @tx_no_feedback_timer: Handle to no feedback timer 91388d5e99SGerrit Renker * @tx_t_ld: Time last doubled during slow start 92388d5e99SGerrit Renker * @tx_t_nom: Nominal send time of next packet 93388d5e99SGerrit Renker * @tx_delta: Send timer delta (RFC 3448, 4.6) in usecs 94388d5e99SGerrit Renker * @tx_hist: Packet history 95388d5e99SGerrit Renker * @tx_options_received: Parsed set of retrieved options 967c657876SArnaldo Carvalho de Melo */ 977c657876SArnaldo Carvalho de Melo struct ccid3_hc_tx_sock { 98388d5e99SGerrit Renker struct tfrc_tx_info tx_tfrc; 99388d5e99SGerrit Renker #define tx_x tx_tfrc.tfrctx_x 100388d5e99SGerrit Renker #define tx_x_recv tx_tfrc.tfrctx_x_recv 101388d5e99SGerrit Renker #define tx_x_calc tx_tfrc.tfrctx_x_calc 102388d5e99SGerrit Renker #define tx_rtt tx_tfrc.tfrctx_rtt 103388d5e99SGerrit Renker #define tx_p tx_tfrc.tfrctx_p 104388d5e99SGerrit Renker #define tx_t_rto tx_tfrc.tfrctx_rto 105388d5e99SGerrit Renker #define tx_t_ipi tx_tfrc.tfrctx_ipi 106388d5e99SGerrit Renker u16 tx_s; 107388d5e99SGerrit Renker enum ccid3_hc_tx_states tx_state:8; 108388d5e99SGerrit Renker u8 tx_last_win_count; 109388d5e99SGerrit Renker ktime_t tx_t_last_win_count; 110388d5e99SGerrit Renker struct timer_list tx_no_feedback_timer; 111388d5e99SGerrit Renker ktime_t tx_t_ld; 112388d5e99SGerrit Renker ktime_t tx_t_nom; 113388d5e99SGerrit Renker u32 tx_delta; 114388d5e99SGerrit Renker struct tfrc_tx_hist_entry *tx_hist; 115388d5e99SGerrit Renker struct ccid3_options_received tx_options_received; 1167c657876SArnaldo Carvalho de Melo }; 1177c657876SArnaldo Carvalho de Melo 1182e86908fSGerrit Renker static inline struct ccid3_hc_tx_sock *ccid3_hc_tx_sk(const struct sock *sk) 1192e86908fSGerrit Renker { 1202e86908fSGerrit Renker struct ccid3_hc_tx_sock *hctx = ccid_priv(dccp_sk(sk)->dccps_hc_tx_ccid); 1212e86908fSGerrit Renker BUG_ON(hctx == NULL); 1222e86908fSGerrit Renker return hctx; 1232e86908fSGerrit Renker } 1242e86908fSGerrit Renker 1253c695262SGerrit Renker /* TFRC receiver states */ 1263c695262SGerrit Renker enum ccid3_hc_rx_states { 1273c695262SGerrit Renker TFRC_RSTATE_NO_DATA = 1, 1283c695262SGerrit Renker TFRC_RSTATE_DATA, 1293c695262SGerrit Renker TFRC_RSTATE_TERM = 127, 1303c695262SGerrit Renker }; 1313c695262SGerrit Renker 132aa1b1ff0SGerrit Renker /** 133aa1b1ff0SGerrit Renker * struct ccid3_hc_rx_sock - CCID3 receiver half-connection socket 134388d5e99SGerrit Renker * @rx_x_recv: Receiver estimate of send rate (RFC 3448 4.3) 135388d5e99SGerrit Renker * @rx_rtt: Receiver estimate of rtt (non-standard) 136388d5e99SGerrit Renker * @rx_p: Current loss event rate (RFC 3448 5.4) 137388d5e99SGerrit Renker * @rx_last_counter: Tracks window counter (RFC 4342, 8.1) 138388d5e99SGerrit Renker * @rx_state: Receiver state, one of %ccid3_hc_rx_states 139388d5e99SGerrit Renker * @rx_bytes_recv: Total sum of DCCP payload bytes 140388d5e99SGerrit Renker * @rx_x_recv: Receiver estimate of send rate (RFC 3448, sec. 4.3) 141388d5e99SGerrit Renker * @rx_rtt: Receiver estimate of RTT 142388d5e99SGerrit Renker * @rx_tstamp_last_feedback: Time at which last feedback was sent 143388d5e99SGerrit Renker * @rx_tstamp_last_ack: Time at which last feedback was sent 144388d5e99SGerrit Renker * @rx_hist: Packet history (loss detection + RTT sampling) 145388d5e99SGerrit Renker * @rx_li_hist: Loss Interval database 146388d5e99SGerrit Renker * @rx_s: Received packet size in bytes 147388d5e99SGerrit Renker * @rx_pinv: Inverse of Loss Event Rate (RFC 4342, sec. 8.5) 14823ea8945SGerrit Renker */ 1497c657876SArnaldo Carvalho de Melo struct ccid3_hc_rx_sock { 150388d5e99SGerrit Renker u8 rx_last_counter:4; 151388d5e99SGerrit Renker enum ccid3_hc_rx_states rx_state:8; 152388d5e99SGerrit Renker u32 rx_bytes_recv; 153388d5e99SGerrit Renker u32 rx_x_recv; 154388d5e99SGerrit Renker u32 rx_rtt; 155388d5e99SGerrit Renker ktime_t rx_tstamp_last_feedback; 156388d5e99SGerrit Renker struct tfrc_rx_hist rx_hist; 157388d5e99SGerrit Renker struct tfrc_loss_hist rx_li_hist; 158388d5e99SGerrit Renker u16 rx_s; 159388d5e99SGerrit Renker #define rx_pinv rx_li_hist.i_mean 1607c657876SArnaldo Carvalho de Melo }; 1617c657876SArnaldo Carvalho de Melo 16259725dc2SArnaldo Carvalho de Melo static inline struct ccid3_hc_rx_sock *ccid3_hc_rx_sk(const struct sock *sk) 16359725dc2SArnaldo Carvalho de Melo { 1642e86908fSGerrit Renker struct ccid3_hc_rx_sock *hcrx = ccid_priv(dccp_sk(sk)->dccps_hc_rx_ccid); 1652e86908fSGerrit Renker BUG_ON(hcrx == NULL); 1662e86908fSGerrit Renker return hcrx; 16759725dc2SArnaldo Carvalho de Melo } 1687c657876SArnaldo Carvalho de Melo 1697c657876SArnaldo Carvalho de Melo #endif /* _DCCP_CCID3_H_ */ 170