17931287dSThomas Gleixner /* SPDX-License-Identifier: GPL-2.0-or-later */
27c657876SArnaldo Carvalho de Melo /*
3b84a2189SArnaldo Carvalho de Melo * Copyright (c) 2005-7 The University of Waikato, Hamilton, New Zealand.
4b84a2189SArnaldo Carvalho de Melo * Copyright (c) 2007 The University of Aberdeen, Scotland, UK
57c657876SArnaldo Carvalho de Melo *
67c657876SArnaldo Carvalho de Melo * An implementation of the DCCP protocol
77c657876SArnaldo Carvalho de Melo *
87c657876SArnaldo Carvalho de Melo * This code has been developed by the University of Waikato WAND
9266f3128SAlexander A. Klimov * research group. For further information please see https://www.wand.net.nz/
10e6bccd35SIan McDonald * or e-mail Ian McDonald - ian.mcdonald@jandi.co.nz
117c657876SArnaldo Carvalho de Melo *
127c657876SArnaldo Carvalho de Melo * This code also uses code from Lulea University, rereleased as GPL by its
137c657876SArnaldo Carvalho de Melo * authors:
147c657876SArnaldo Carvalho de Melo * Copyright (c) 2003 Nils-Erik Mattsson, Joacim Haggmark, Magnus Erixzon
157c657876SArnaldo Carvalho de Melo *
167c657876SArnaldo Carvalho de Melo * Changes to meet Linux coding standards, to make it meet latest ccid3 draft
177c657876SArnaldo Carvalho de Melo * and to make it work as a loadable module in the DCCP stack written by
187c657876SArnaldo Carvalho de Melo * Arnaldo Carvalho de Melo <acme@conectiva.com.br>.
197c657876SArnaldo Carvalho de Melo *
207c657876SArnaldo Carvalho de Melo * Copyright (c) 2005 Arnaldo Carvalho de Melo <acme@conectiva.com.br>
217c657876SArnaldo Carvalho de Melo */
227c657876SArnaldo Carvalho de Melo #ifndef _DCCP_CCID3_H_
237c657876SArnaldo Carvalho de Melo #define _DCCP_CCID3_H_
247c657876SArnaldo Carvalho de Melo
258132da4dSGerrit Renker #include <linux/ktime.h>
267c657876SArnaldo Carvalho de Melo #include <linux/list.h>
27cfc3c525SArnaldo Carvalho de Melo #include <linux/types.h>
2865299d6cSArnaldo Carvalho de Melo #include <linux/tfrc.h>
29954c2db8SGerrit Renker #include "lib/tfrc.h"
3091f0ebf7SArnaldo Carvalho de Melo #include "../ccid.h"
31cfc3c525SArnaldo Carvalho de Melo
3289858ad1SGerrit Renker /* Two seconds as per RFC 5348, 4.2 */
33cfc3c525SArnaldo Carvalho de Melo #define TFRC_INITIAL_TIMEOUT (2 * USEC_PER_SEC)
34cfc3c525SArnaldo Carvalho de Melo
35a79ef76fSGerrit Renker /* Parameter t_mbi from [RFC 3448, 4.3]: backoff interval in seconds */
36a79ef76fSGerrit Renker #define TFRC_T_MBI 64
37cfc3c525SArnaldo Carvalho de Melo
3820cbd3e1SGerrit Renker /*
3920cbd3e1SGerrit Renker * The t_delta parameter (RFC 5348, 8.3): delays of less than %USEC_PER_MSEC are
4020cbd3e1SGerrit Renker * rounded down to 0, since sk_reset_timer() here uses millisecond granularity.
4120cbd3e1SGerrit Renker * Hence we can use a constant t_delta = %USEC_PER_MSEC when HZ >= 500. A coarse
4220cbd3e1SGerrit Renker * resolution of HZ < 500 means that the error is below one timer tick (t_gran)
4320cbd3e1SGerrit Renker * when using the constant t_delta = t_gran / 2 = %USEC_PER_SEC / (2 * HZ).
4420cbd3e1SGerrit Renker */
4520cbd3e1SGerrit Renker #if (HZ >= 500)
4620cbd3e1SGerrit Renker # define TFRC_T_DELTA USEC_PER_MSEC
4720cbd3e1SGerrit Renker #else
4820cbd3e1SGerrit Renker # define TFRC_T_DELTA (USEC_PER_SEC / (2 * HZ))
4920cbd3e1SGerrit Renker #endif
5020cbd3e1SGerrit Renker
51cfc3c525SArnaldo Carvalho de Melo enum ccid3_options {
52cfc3c525SArnaldo Carvalho de Melo TFRC_OPT_LOSS_EVENT_RATE = 192,
53cfc3c525SArnaldo Carvalho de Melo TFRC_OPT_LOSS_INTERVALS = 193,
54cfc3c525SArnaldo Carvalho de Melo TFRC_OPT_RECEIVE_RATE = 194,
55cfc3c525SArnaldo Carvalho de Melo };
567c657876SArnaldo Carvalho de Melo
573c695262SGerrit Renker /* TFRC sender states */
583c695262SGerrit Renker enum ccid3_hc_tx_states {
593c695262SGerrit Renker TFRC_SSTATE_NO_SENT = 1,
603c695262SGerrit Renker TFRC_SSTATE_NO_FBACK,
613c695262SGerrit Renker TFRC_SSTATE_FBACK,
623c695262SGerrit Renker };
633c695262SGerrit Renker
64aa1b1ff0SGerrit Renker /**
65aa1b1ff0SGerrit Renker * struct ccid3_hc_tx_sock - CCID3 sender half-connection socket
66388d5e99SGerrit Renker * @tx_x: Current sending rate in 64 * bytes per second
67388d5e99SGerrit Renker * @tx_x_recv: Receive rate in 64 * bytes per second
68388d5e99SGerrit Renker * @tx_x_calc: Calculated rate in bytes per second
69388d5e99SGerrit Renker * @tx_rtt: Estimate of current round trip time in usecs
70388d5e99SGerrit Renker * @tx_p: Current loss event rate (0-1) scaled by 1000000
71388d5e99SGerrit Renker * @tx_s: Packet size in bytes
72388d5e99SGerrit Renker * @tx_t_rto: Nofeedback Timer setting in usecs
73388d5e99SGerrit Renker * @tx_t_ipi: Interpacket (send) interval (RFC 3448, 4.6) in usecs
74388d5e99SGerrit Renker * @tx_state: Sender state, one of %ccid3_hc_tx_states
75388d5e99SGerrit Renker * @tx_last_win_count: Last window counter sent
76388d5e99SGerrit Renker * @tx_t_last_win_count: Timestamp of earliest packet
77cfc3c525SArnaldo Carvalho de Melo * with last_win_count value sent
78388d5e99SGerrit Renker * @tx_no_feedback_timer: Handle to no feedback timer
79388d5e99SGerrit Renker * @tx_t_ld: Time last doubled during slow start
80388d5e99SGerrit Renker * @tx_t_nom: Nominal send time of next packet
81388d5e99SGerrit Renker * @tx_hist: Packet history
827c657876SArnaldo Carvalho de Melo */
837c657876SArnaldo Carvalho de Melo struct ccid3_hc_tx_sock {
8467b67e36SGerrit Renker u64 tx_x;
8567b67e36SGerrit Renker u64 tx_x_recv;
8667b67e36SGerrit Renker u32 tx_x_calc;
8767b67e36SGerrit Renker u32 tx_rtt;
8867b67e36SGerrit Renker u32 tx_p;
8967b67e36SGerrit Renker u32 tx_t_rto;
9067b67e36SGerrit Renker u32 tx_t_ipi;
91388d5e99SGerrit Renker u16 tx_s;
92388d5e99SGerrit Renker enum ccid3_hc_tx_states tx_state:8;
93388d5e99SGerrit Renker u8 tx_last_win_count;
94388d5e99SGerrit Renker ktime_t tx_t_last_win_count;
95388d5e99SGerrit Renker struct timer_list tx_no_feedback_timer;
96839a6094SKees Cook struct sock *sk;
97388d5e99SGerrit Renker ktime_t tx_t_ld;
98388d5e99SGerrit Renker ktime_t tx_t_nom;
99388d5e99SGerrit Renker struct tfrc_tx_hist_entry *tx_hist;
1007c657876SArnaldo Carvalho de Melo };
1017c657876SArnaldo Carvalho de Melo
ccid3_hc_tx_sk(const struct sock * sk)1022e86908fSGerrit Renker static inline struct ccid3_hc_tx_sock *ccid3_hc_tx_sk(const struct sock *sk)
1032e86908fSGerrit Renker {
1042e86908fSGerrit Renker struct ccid3_hc_tx_sock *hctx = ccid_priv(dccp_sk(sk)->dccps_hc_tx_ccid);
1052e86908fSGerrit Renker BUG_ON(hctx == NULL);
1062e86908fSGerrit Renker return hctx;
1072e86908fSGerrit Renker }
1082e86908fSGerrit Renker
1093c695262SGerrit Renker /* TFRC receiver states */
1103c695262SGerrit Renker enum ccid3_hc_rx_states {
1113c695262SGerrit Renker TFRC_RSTATE_NO_DATA = 1,
1123c695262SGerrit Renker TFRC_RSTATE_DATA,
1133c695262SGerrit Renker };
1143c695262SGerrit Renker
115aa1b1ff0SGerrit Renker /**
116aa1b1ff0SGerrit Renker * struct ccid3_hc_rx_sock - CCID3 receiver half-connection socket
117388d5e99SGerrit Renker * @rx_last_counter: Tracks window counter (RFC 4342, 8.1)
118388d5e99SGerrit Renker * @rx_state: Receiver state, one of %ccid3_hc_rx_states
119388d5e99SGerrit Renker * @rx_bytes_recv: Total sum of DCCP payload bytes
120388d5e99SGerrit Renker * @rx_x_recv: Receiver estimate of send rate (RFC 3448, sec. 4.3)
121388d5e99SGerrit Renker * @rx_rtt: Receiver estimate of RTT
122388d5e99SGerrit Renker * @rx_tstamp_last_feedback: Time at which last feedback was sent
123388d5e99SGerrit Renker * @rx_hist: Packet history (loss detection + RTT sampling)
124388d5e99SGerrit Renker * @rx_li_hist: Loss Interval database
125388d5e99SGerrit Renker * @rx_s: Received packet size in bytes
126388d5e99SGerrit Renker * @rx_pinv: Inverse of Loss Event Rate (RFC 4342, sec. 8.5)
12723ea8945SGerrit Renker */
1287c657876SArnaldo Carvalho de Melo struct ccid3_hc_rx_sock {
129388d5e99SGerrit Renker u8 rx_last_counter:4;
130388d5e99SGerrit Renker enum ccid3_hc_rx_states rx_state:8;
131388d5e99SGerrit Renker u32 rx_bytes_recv;
132388d5e99SGerrit Renker u32 rx_x_recv;
133388d5e99SGerrit Renker u32 rx_rtt;
134388d5e99SGerrit Renker ktime_t rx_tstamp_last_feedback;
135388d5e99SGerrit Renker struct tfrc_rx_hist rx_hist;
136388d5e99SGerrit Renker struct tfrc_loss_hist rx_li_hist;
137388d5e99SGerrit Renker u16 rx_s;
138388d5e99SGerrit Renker #define rx_pinv rx_li_hist.i_mean
1397c657876SArnaldo Carvalho de Melo };
1407c657876SArnaldo Carvalho de Melo
ccid3_hc_rx_sk(const struct sock * sk)14159725dc2SArnaldo Carvalho de Melo static inline struct ccid3_hc_rx_sock *ccid3_hc_rx_sk(const struct sock *sk)
14259725dc2SArnaldo Carvalho de Melo {
1432e86908fSGerrit Renker struct ccid3_hc_rx_sock *hcrx = ccid_priv(dccp_sk(sk)->dccps_hc_rx_ccid);
1442e86908fSGerrit Renker BUG_ON(hcrx == NULL);
1452e86908fSGerrit Renker return hcrx;
14659725dc2SArnaldo Carvalho de Melo }
1477c657876SArnaldo Carvalho de Melo
1487c657876SArnaldo Carvalho de Melo #endif /* _DCCP_CCID3_H_ */
149