^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 1) /* SPDX-License-Identifier: GPL-2.0-or-later */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 2) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 3) * Copyright (c) 2005-7 The University of Waikato, Hamilton, New Zealand.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 4) * Copyright (c) 2007 The University of Aberdeen, Scotland, UK
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 5) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 6) * An implementation of the DCCP protocol
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 7) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 8) * This code has been developed by the University of Waikato WAND
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 9) * research group. For further information please see https://www.wand.net.nz/
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 10) * or e-mail Ian McDonald - ian.mcdonald@jandi.co.nz
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 11) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 12) * This code also uses code from Lulea University, rereleased as GPL by its
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 13) * authors:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 14) * Copyright (c) 2003 Nils-Erik Mattsson, Joacim Haggmark, Magnus Erixzon
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 15) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 16) * Changes to meet Linux coding standards, to make it meet latest ccid3 draft
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 17) * and to make it work as a loadable module in the DCCP stack written by
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 18) * Arnaldo Carvalho de Melo <acme@conectiva.com.br>.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 19) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 20) * Copyright (c) 2005 Arnaldo Carvalho de Melo <acme@conectiva.com.br>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 21) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 22) #ifndef _DCCP_CCID3_H_
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 23) #define _DCCP_CCID3_H_
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 24)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 25) #include <linux/ktime.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 26) #include <linux/list.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 27) #include <linux/types.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 28) #include <linux/tfrc.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 29) #include "lib/tfrc.h"
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 30) #include "../ccid.h"
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 31)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 32) /* Two seconds as per RFC 5348, 4.2 */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 33) #define TFRC_INITIAL_TIMEOUT (2 * USEC_PER_SEC)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 34)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 35) /* Parameter t_mbi from [RFC 3448, 4.3]: backoff interval in seconds */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 36) #define TFRC_T_MBI 64
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 37)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 38) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 39) * The t_delta parameter (RFC 5348, 8.3): delays of less than %USEC_PER_MSEC are
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 40) * rounded down to 0, since sk_reset_timer() here uses millisecond granularity.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 41) * Hence we can use a constant t_delta = %USEC_PER_MSEC when HZ >= 500. A coarse
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 42) * resolution of HZ < 500 means that the error is below one timer tick (t_gran)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 43) * when using the constant t_delta = t_gran / 2 = %USEC_PER_SEC / (2 * HZ).
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 44) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 45) #if (HZ >= 500)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 46) # define TFRC_T_DELTA USEC_PER_MSEC
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 47) #else
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 48) # define TFRC_T_DELTA (USEC_PER_SEC / (2 * HZ))
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 49) #endif
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 50)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 51) enum ccid3_options {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 52) TFRC_OPT_LOSS_EVENT_RATE = 192,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 53) TFRC_OPT_LOSS_INTERVALS = 193,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 54) TFRC_OPT_RECEIVE_RATE = 194,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 55) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 56)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 57) /* TFRC sender states */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 58) enum ccid3_hc_tx_states {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 59) TFRC_SSTATE_NO_SENT = 1,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 60) TFRC_SSTATE_NO_FBACK,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 61) TFRC_SSTATE_FBACK,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 62) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 63)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 64) /**
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 65) * struct ccid3_hc_tx_sock - CCID3 sender half-connection socket
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 66) * @tx_x: Current sending rate in 64 * bytes per second
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 67) * @tx_x_recv: Receive rate in 64 * bytes per second
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 68) * @tx_x_calc: Calculated rate in bytes per second
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 69) * @tx_rtt: Estimate of current round trip time in usecs
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 70) * @tx_p: Current loss event rate (0-1) scaled by 1000000
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 71) * @tx_s: Packet size in bytes
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 72) * @tx_t_rto: Nofeedback Timer setting in usecs
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 73) * @tx_t_ipi: Interpacket (send) interval (RFC 3448, 4.6) in usecs
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 74) * @tx_state: Sender state, one of %ccid3_hc_tx_states
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 75) * @tx_last_win_count: Last window counter sent
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 76) * @tx_t_last_win_count: Timestamp of earliest packet
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 77) * with last_win_count value sent
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 78) * @tx_no_feedback_timer: Handle to no feedback timer
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 79) * @tx_t_ld: Time last doubled during slow start
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 80) * @tx_t_nom: Nominal send time of next packet
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 81) * @tx_hist: Packet history
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 82) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 83) struct ccid3_hc_tx_sock {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 84) u64 tx_x;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 85) u64 tx_x_recv;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 86) u32 tx_x_calc;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 87) u32 tx_rtt;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 88) u32 tx_p;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 89) u32 tx_t_rto;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 90) u32 tx_t_ipi;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 91) u16 tx_s;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 92) enum ccid3_hc_tx_states tx_state:8;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 93) u8 tx_last_win_count;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 94) ktime_t tx_t_last_win_count;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 95) struct timer_list tx_no_feedback_timer;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 96) struct sock *sk;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 97) ktime_t tx_t_ld;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 98) ktime_t tx_t_nom;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 99) struct tfrc_tx_hist_entry *tx_hist;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 100) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 101)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 102) static inline struct ccid3_hc_tx_sock *ccid3_hc_tx_sk(const struct sock *sk)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 103) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 104) struct ccid3_hc_tx_sock *hctx = ccid_priv(dccp_sk(sk)->dccps_hc_tx_ccid);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 105) BUG_ON(hctx == NULL);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 106) return hctx;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 107) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 108)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 109) /* TFRC receiver states */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 110) enum ccid3_hc_rx_states {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 111) TFRC_RSTATE_NO_DATA = 1,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 112) TFRC_RSTATE_DATA,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 113) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 114)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 115) /**
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 116) * struct ccid3_hc_rx_sock - CCID3 receiver half-connection socket
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 117) * @rx_last_counter: Tracks window counter (RFC 4342, 8.1)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 118) * @rx_state: Receiver state, one of %ccid3_hc_rx_states
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 119) * @rx_bytes_recv: Total sum of DCCP payload bytes
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 120) * @rx_x_recv: Receiver estimate of send rate (RFC 3448, sec. 4.3)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 121) * @rx_rtt: Receiver estimate of RTT
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 122) * @rx_tstamp_last_feedback: Time at which last feedback was sent
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 123) * @rx_hist: Packet history (loss detection + RTT sampling)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 124) * @rx_li_hist: Loss Interval database
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 125) * @rx_s: Received packet size in bytes
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 126) * @rx_pinv: Inverse of Loss Event Rate (RFC 4342, sec. 8.5)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 127) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 128) struct ccid3_hc_rx_sock {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 129) u8 rx_last_counter:4;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 130) enum ccid3_hc_rx_states rx_state:8;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 131) u32 rx_bytes_recv;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 132) u32 rx_x_recv;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 133) u32 rx_rtt;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 134) ktime_t rx_tstamp_last_feedback;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 135) struct tfrc_rx_hist rx_hist;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 136) struct tfrc_loss_hist rx_li_hist;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 137) u16 rx_s;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 138) #define rx_pinv rx_li_hist.i_mean
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 139) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 140)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 141) static inline struct ccid3_hc_rx_sock *ccid3_hc_rx_sk(const struct sock *sk)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 142) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 143) struct ccid3_hc_rx_sock *hcrx = ccid_priv(dccp_sk(sk)->dccps_hc_rx_ccid);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 144) BUG_ON(hcrx == NULL);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 145) return hcrx;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 146) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 147)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 148) #endif /* _DCCP_CCID3_H_ */