summaryrefslogtreecommitdiffstats
path: root/compat/gettcpinfo.c
blob: f7067e97d41cbda63dd9fe01ebae87910c0538cc (plain)
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
/*---------------------------------------------------------------
 * Copyright (c) 2021
 * Broadcom Corporation
 * All Rights Reserved.
 *---------------------------------------------------------------
 * Permission is hereby granted, free of charge, to any person
 * obtaining a copy of this software and associated
 * documentation files (the "Software"), to deal in the Software
 * without restriction, including without limitation the
 * rights to use, copy, modify, merge, publish, distribute,
 * sublicense, and/or sell copies of the Software, and to permit
 * persons to whom the Software is furnished to do
 * so, subject to the following conditions:
 *
 *
 * Redistributions of source code must retain the above
 * copyright notice, this list of conditions and
 * the following disclaimers.
 *
 *
 * Redistributions in binary form must reproduce the above
 * copyright notice, this list of conditions and the following
 * disclaimers in the documentation and/or other materials
 * provided with the distribution.
 *
 *
 * Neither the name of Broadcom Coporation,
 * nor the names of its contributors may be used to endorse
 * or promote products derived from this Software without
 * specific prior written permission.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
 * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 * NONINFRINGEMENT. IN NO EVENT SHALL THE CONTIBUTORS OR COPYRIGHT
 * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
 * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE
 * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 * ________________________________________________________________
 *
 * gettcpinfo.c
 * Suppport for tcp info in a portable way
 *
 * Hi Bob,
 *
 * I would suggest that the most interesting metrics from tcp_info would be:
 *
 * double ecn_mark_rate = (double)tcpi_delivered_ce / (double)tcpi_delivered
 * double retransmit_rate = (double)(tcpi_total_retrans - tcpi_dsack_dups) / (double)tcpi_data_segs_out
 * double smoothed_rtt = tcpi_rtt
 *
 * neal
 *
 * by Robert J. McMahon (rjmcmahon@rjmcmahon.com, bob.mcmahon@broadcom.com)
 * -------------------------------------------------------------------
 */
#include "headers.h"
#include "gettcpinfo.h"
#ifdef HAVE_THREAD_DEBUG
// needed for thread_debug
#include "Thread.h"
#endif

#if HAVE_TCP_STATS
inline void gettcpinfo (int sock, struct iperf_tcpstats *stats) {
    assert(stats);
#if HAVE_DECL_TCP_INFO
    struct tcp_info tcp_info_buf;
    socklen_t tcp_info_length = sizeof(struct tcp_info);
    if ((sock > 0) && !(getsockopt(sock, IPPROTO_TCP, TCP_INFO, &tcp_info_buf, &tcp_info_length) < 0)) {
#if HAVE_STRUCT_TCP_INFO_TCPI_SND_CWND
        stats->cwnd_packets = tcp_info_buf.tcpi_snd_cwnd;
#else
        stats->cwnd_packets = -1;
#endif
#if HAVE_STRUCT_TCP_INFO_TCPI_SND_CWND && HAVE_STRUCT_TCP_INFO_TCPI_SND_MSS
        stats->cwnd = tcp_info_buf.tcpi_snd_cwnd * tcp_info_buf.tcpi_snd_mss / 1024;
#else
        stats->cwnd = -1;
#endif
	stats->rtt = tcp_info_buf.tcpi_rtt;
	stats->rttvar = tcp_info_buf.tcpi_rttvar;
	stats->retry_tot = tcp_info_buf.tcpi_total_retrans;
#if HAVE_STRUCT_TCP_INFO_TCPI_SND_MSS
	stats->mss_negotiated = tcp_info_buf.tcpi_snd_mss;
#else
	stats->mss_negotiated = -1;
#endif
#if HAVE_TCP_INFLIGHT
	stats->packets_in_flight = (tcp_info_buf.tcpi_unacked - tcp_info_buf.tcpi_sacked - \
				    tcp_info_buf.tcpi_lost + tcp_info_buf.tcpi_retrans);
	stats->bytes_in_flight	= stats->packets_in_flight * tcp_info_buf.tcpi_snd_mss / 1024;
#endif
	stats->isValid  = true;
#elif HAVE_DECL_TCP_CONNECTION_INFO
    struct tcp_connection_info tcp_info_buf;
    socklen_t tcp_info_length = sizeof(struct tcp_connection_info);
    if ((sock > 0) && !(getsockopt(sock, IPPROTO_TCP, TCP_CONNECTION_INFO, &tcp_info_buf, &tcp_info_length) < 0)) {
#ifdef __APPLE__
	stats->cwnd = tcp_info_buf.tcpi_snd_cwnd / 1024;
        stats->cwnd_packets = -1;
#else
	stats->cwnd = tcp_info_buf.tcpi_snd_cwnd * tcp_info_buf.tcpi_maxseg / 1024;
        stats->cwnd_packets = tcp_info_buf.tcpi_snd_cwnd;
#endif
	stats->rtt = tcp_info_buf.tcpi_rttcur * 1000; // OS X units is ms
	stats->rttvar = tcp_info_buf.tcpi_rttvar;
	stats->retry_tot = tcp_info_buf.tcpi_txretransmitpackets;
	stats->mss_negotiated = tcp_info_buf.tcpi_maxseg;
	stats->isValid  = true;
#endif
    } else {
	stats->rtt = 1;
	stats->isValid = false;
    }
}
inline void tcpstats_copy (struct iperf_tcpstats *stats_dst, struct iperf_tcpstats *stats_src) {
    stats_dst->cwnd = stats_src->cwnd;
    stats_dst->cwnd_packets = stats_src->cwnd_packets;
    stats_dst->rtt = stats_src->rtt;
    stats_dst->rttvar = stats_src->rttvar;
    stats_dst->mss_negotiated = stats_src->mss_negotiated;
    stats_dst->retry_tot = stats_src->retry_tot;
    stats_dst->connecttime = stats_src->connecttime;
    stats_dst->isValid = stats_src->isValid;
#if HAVE_TCP_INFLIGHT
    stats_dst->packets_in_flight = stats_src->packets_in_flight;
    stats_dst->bytes_in_flight	= stats_src->bytes_in_flight;
#endif

}
#else
#if WIN32
inline void gettcpinfo (SOCKET sock, struct iperf_tcpstats *stats) {
#else
inline void gettcpinfo (int sock, struct iperf_tcpstats *stats) {
#endif
    stats->rtt = 1;
    stats->isValid  = false;
};
inline void tcpstats_copy (struct iperf_tcpstats *stats_dst, struct iperf_tcpstats *stats_src) {
    stats_dst->rtt = stats_src->rtt;
    stats_dst->isValid = stats_src->isValid;
}
#endif