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
//! Get socket information and statistics. //! //! **[Crates.io](https://crates.io/crates/socketstat) │ [Repo](https://github.com/alecmocatta/socketstat)** //! //! Currently works on macOS only, PRs for other platforms welcome! //! //! # Example //! //! ``` //! #[cfg(unix)] //! use std::os::unix::io::AsRawFd; //! #[cfg(windows)] //! use std::os::windows::io::AsRawSocket; //! use socketstat::socketstat; //! //! let sock = std::net::TcpStream::connect("google.com:80").unwrap(); //! //! #[cfg(unix)] //! let fd = sock.as_raw_fd(); //! #[cfg(windows)] //! let fd = sock.as_raw_socket(); //! //! println!("{:#?}", socketstat(fd)); //! //! // prints: //! // Ok( //! // SocketStat { //! // unreceived: 0, //! // unsent: 0, //! // connection_info: tcp_connection_info { //! // tcpi_state: "ESTABLISHED", //! // tcpi_snd_wscale: 8, //! // tcpi_rcv_wscale: 6, //! // tcpi_options: 7, //! // tcpi_flags: 0, //! // tcpi_rto: 0, //! // tcpi_maxseg: 1368, //! // tcpi_snd_ssthresh: 1073725440, //! // tcpi_snd_cwnd: 4380, //! // tcpi_snd_wnd: 60192, //! // tcpi_snd_sbbytes: 0, //! // tcpi_rcv_wnd: 131328, //! // tcpi_rttcur: 79, //! // tcpi_srtt: 79, //! // tcpi_rttvar: 39, //! // tcpi_tfo: 0, //! // tcpi_txpackets: 0, //! // tcpi_txbytes: 0, //! // tcpi_txretransmitbytes: 0, //! // tcpi_rxpackets: 0, //! // tcpi_rxbytes: 0, //! // tcpi_rxoutoforderbytes: 0, //! // tcpi_txretransmitpackets: 0, //! // }, //! // socket_info: tcp_sockinfo { //! // tcpsi_ini: in_sockinfo { //! // insi_fport: 80, //! // insi_lport: 52621, //! // insi_gencnt: 100950561, //! // insi_flags: 8390720, //! // insi_flow: 0, //! // insi_vflag: "IPV4", //! // insi_ip_ttl: 64, //! // rfu_1: 0, //! // }, //! // tcpsi_state: "ESTABLISHED", //! // tcpsi_timer: [ //! // 0, //! // 0, //! // 7200079, //! // 0, //! // ], //! // tcpsi_mss: 1368, //! // tcpsi_flags: 1140851680, //! // rfu_1: 0, //! // tcpsi_tp: 9662996336038732135, //! // }, //! // }, //! // ) //! ``` //! //! # Note //! //! On macOS this calls: //! * `getsockopt(fd, IPPROTO_TCP, TCP_CONNECTION_INFO, ...)` //! * `proc_pidfdinfo(getpid(), fd, PROC_PIDFDSOCKETINFO, ...)` //! * `ioctl(fd, FIONREAD, ...)` //! * `getsockopt(fd, SOL_SOCKET, SO_NWRITE, ...)` //! //! Other sources to explore: //! * `sysctl([CTL_NET, PF_INET, IPPROTO_TCP, TCPCTL_PCBLIST], ...` //! * <https://stackoverflow.com/questions/31263289/on-linux-mac-windows-is-it-possible-to-access-the-tcp-timestamp-and-or-rtt-in-u> #![doc(html_root_url = "https://docs.rs/socketstat/0.1.0")] #![warn( missing_copy_implementations, missing_debug_implementations, missing_docs, trivial_casts, trivial_numeric_casts, unused_import_braces, unused_qualifications, unused_results, clippy::pedantic )] // from https://github.com/rust-unofficial/patterns/blob/master/anti_patterns/deny-warnings.md #![allow()] use std::fmt; #[cfg(unix)] type Fd = std::os::unix::io::RawFd; #[cfg(windows)] type Fd = std::os::windows::io::RawSocket; #[cfg(any(target_os = "macos", target_os = "ios"))] mod mac; #[cfg(any(target_os = "macos", target_os = "ios"))] use mac as sys; #[cfg(not(any(target_os = "macos", target_os = "ios")))] mod stub; #[cfg(not(any(target_os = "macos", target_os = "ios")))] use stub as sys; /// Information and stats that can be printed via the Debug implementation. #[derive(Clone)] pub struct SocketStat { sys: sys::SocketStat, } impl fmt::Debug for SocketStat { fn fmt(&self, fmt: &mut fmt::Formatter<'_>) -> fmt::Result { self.sys.fmt(fmt) } } /// An error occurred #[derive(Clone)] pub struct Error { sys: sys::Error, } impl fmt::Debug for Error { fn fmt(&self, fmt: &mut fmt::Formatter<'_>) -> fmt::Result { self.sys.fmt(fmt) } } /// Get socket information and statistics for a given File Descriptor or Socket. pub fn socketstat(fd: Fd) -> Result<SocketStat, Error> { sys::socketstat(fd) .map(|sys| SocketStat { sys }) .map_err(|sys| Error { sys }) } #[cfg(test)] mod tests { #[cfg(unix)] use std::os::unix::io::AsRawFd; #[cfg(windows)] use std::os::windows::io::AsRawSocket; use super::socketstat; #[test] fn succeeds() { let sock = std::net::TcpStream::connect("google.com:80").unwrap(); #[cfg(unix)] let fd = sock.as_raw_fd(); #[cfg(windows)] let fd = sock.as_raw_socket(); println!("{:#?}", socketstat(fd)); } }