xfr 0.7.1

Modern network bandwidth testing with TUI
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206

//! TCP_INFO extraction for Linux and macOS
//!
//! Provides access to kernel-level TCP statistics like RTT, congestion window,
//! and retransmit counts.

use crate::protocol::TcpInfoSnapshot;

#[cfg(target_os = "linux")]
mod linux {
    use super::*;
    use std::mem;
    use std::os::unix::io::AsRawFd;

    #[repr(C)]
    #[derive(Debug, Default, Clone, Copy)]
    pub struct TcpInfo {
        pub tcpi_state: u8,
        pub tcpi_ca_state: u8,
        pub tcpi_retransmits: u8,
        pub tcpi_probes: u8,
        pub tcpi_backoff: u8,
        pub tcpi_options: u8,
        pub tcpi_snd_wscale_rcv_wscale: u8,
        pub tcpi_delivery_rate_app_limited: u8,

        pub tcpi_rto: u32,
        pub tcpi_ato: u32,
        pub tcpi_snd_mss: u32,
        pub tcpi_rcv_mss: u32,

        pub tcpi_unacked: u32,
        pub tcpi_sacked: u32,
        pub tcpi_lost: u32,
        pub tcpi_retrans: u32,
        pub tcpi_fackets: u32,

        pub tcpi_last_data_sent: u32,
        pub tcpi_last_ack_sent: u32,
        pub tcpi_last_data_recv: u32,
        pub tcpi_last_ack_recv: u32,

        pub tcpi_pmtu: u32,
        pub tcpi_rcv_ssthresh: u32,
        pub tcpi_rtt: u32,
        pub tcpi_rttvar: u32,
        pub tcpi_snd_ssthresh: u32,
        pub tcpi_snd_cwnd: u32,
        pub tcpi_advmss: u32,
        pub tcpi_reordering: u32,

        pub tcpi_rcv_rtt: u32,
        pub tcpi_rcv_space: u32,

        pub tcpi_total_retrans: u32,
    }

    pub fn get_tcp_info<S: AsRawFd>(socket: &S) -> std::io::Result<TcpInfoSnapshot> {
        get_tcp_info_from_fd(socket.as_raw_fd())
    }

    /// Poll TCP_INFO using a raw file descriptor (for interval polling without owning the socket)
    pub fn get_tcp_info_from_fd(fd: i32) -> std::io::Result<TcpInfoSnapshot> {
        let mut info: TcpInfo = Default::default();
        let mut len = mem::size_of::<TcpInfo>() as libc::socklen_t;

        // SAFETY: fd must be a valid file descriptor for an open TCP socket.
        // info is zeroed TcpInfo struct with correct size, len is initialized
        // to the struct size. getsockopt will write at most len bytes.
        let ret = unsafe {
            libc::getsockopt(
                fd,
                libc::IPPROTO_TCP,
                libc::TCP_INFO,
                &mut info as *mut _ as *mut libc::c_void,
                &mut len,
            )
        };

        if ret == 0 {
            Ok(TcpInfoSnapshot {
                retransmits: info.tcpi_total_retrans as u64,
                rtt_us: info.tcpi_rtt,
                rtt_var_us: info.tcpi_rttvar,
                cwnd: info.tcpi_snd_cwnd,
            })
        } else {
            Err(std::io::Error::last_os_error())
        }
    }
}

#[cfg(target_os = "macos")]
mod macos {
    use super::*;
    use std::mem;
    use std::os::unix::io::AsRawFd;

    // macOS uses TCP_CONNECTION_INFO
    const TCP_CONNECTION_INFO: libc::c_int = 0x106;

    #[repr(C)]
    #[derive(Debug, Default, Clone, Copy)]
    pub struct TcpConnectionInfo {
        pub tcpi_state: u8,
        pub tcpi_snd_wscale: u8,
        pub tcpi_rcv_wscale: u8,
        pub __pad1: u8,
        pub tcpi_options: u32,
        pub tcpi_flags: u32,
        pub tcpi_rto: u32,
        pub tcpi_maxseg: u32,
        pub tcpi_snd_ssthresh: u32,
        pub tcpi_snd_cwnd: u32,
        pub tcpi_snd_wnd: u32,
        pub tcpi_snd_sbbytes: u32,
        pub tcpi_rcv_wnd: u32,
        pub tcpi_rttcur: u32,
        pub tcpi_srtt: u32,
        pub tcpi_rttvar: u32,
        pub tcpi_tfo_cookie_req: u32,
        pub tcpi_tfo_cookie_rcv: u32,
        pub tcpi_tfo_syn_loss: u32,
        pub tcpi_tfo_syn_data_sent: u32,
        pub tcpi_tfo_syn_data_acked: u32,
        pub tcpi_tfo_syn_data_rcv: u32,
        pub tcpi_tfo_cookie_wrong: u32,
        pub tcpi_tfo_no_cookie_rcv: u32,
        pub tcpi_tfo_heuristics_disable: u32,
        pub tcpi_tfo_send_blackhole: u32,
        pub tcpi_tfo_recv_blackhole: u32,
        pub tcpi_tfo_onebyte_proxy: u32,
        pub tcpi_txpackets: u64,
        pub tcpi_txbytes: u64,
        pub tcpi_txretransmitbytes: u64,
        pub tcpi_rxpackets: u64,
        pub tcpi_rxbytes: u64,
        pub tcpi_rxoutoforderbytes: u64,
        pub tcpi_txretransmitpackets: u64,
    }

    pub fn get_tcp_info<S: AsRawFd>(socket: &S) -> std::io::Result<TcpInfoSnapshot> {
        get_tcp_info_from_fd(socket.as_raw_fd())
    }

    /// Poll TCP_INFO using a raw file descriptor (for interval polling without owning the socket)
    pub fn get_tcp_info_from_fd(fd: i32) -> std::io::Result<TcpInfoSnapshot> {
        let mut info: TcpConnectionInfo = Default::default();
        let mut len = mem::size_of::<TcpConnectionInfo>() as libc::socklen_t;

        // SAFETY: fd must be a valid file descriptor for an open TCP socket.
        // info is zeroed TcpConnectionInfo struct with correct size, len is
        // initialized to the struct size. getsockopt will write at most len bytes.
        let ret = unsafe {
            libc::getsockopt(
                fd,
                libc::IPPROTO_TCP,
                TCP_CONNECTION_INFO,
                &mut info as *mut _ as *mut libc::c_void,
                &mut len,
            )
        };

        if ret == 0 {
            Ok(TcpInfoSnapshot {
                retransmits: info.tcpi_txretransmitpackets,
                rtt_us: info.tcpi_srtt,
                rtt_var_us: info.tcpi_rttvar,
                cwnd: info.tcpi_snd_cwnd,
            })
        } else {
            Err(std::io::Error::last_os_error())
        }
    }
}

#[cfg(not(any(target_os = "linux", target_os = "macos")))]
mod fallback {
    use super::*;

    pub fn get_tcp_info<S>(_socket: &S) -> std::io::Result<TcpInfoSnapshot> {
        Ok(TcpInfoSnapshot {
            retransmits: 0,
            rtt_us: 0,
            rtt_var_us: 0,
            cwnd: 0,
        })
    }

    pub fn get_tcp_info_from_fd(_fd: i32) -> std::io::Result<TcpInfoSnapshot> {
        Ok(TcpInfoSnapshot {
            retransmits: 0,
            rtt_us: 0,
            rtt_var_us: 0,
            cwnd: 0,
        })
    }
}

#[cfg(target_os = "linux")]
pub use linux::{get_tcp_info, get_tcp_info_from_fd};

#[cfg(target_os = "macos")]
pub use macos::{get_tcp_info, get_tcp_info_from_fd};

#[cfg(not(any(target_os = "linux", target_os = "macos")))]
pub use fallback::{get_tcp_info, get_tcp_info_from_fd};