xref: /freebsd/cddl/lib/libdtrace/tcp.d (revision bd81e07d2761cf1c13063eb49a5c0cb4a6951318)
1 /*
2  * CDDL HEADER START
3  *
4  * The contents of this file are subject to the terms of the
5  * Common Development and Distribution License (the "License").
6  * You may not use this file except in compliance with the License.
7  *
8  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9  * or http://www.opensolaris.org/os/licensing.
10  * See the License for the specific language governing permissions
11  * and limitations under the License.
12  *
13  * When distributing Covered Code, include this CDDL HEADER in each
14  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15  * If applicable, add the following below this CDDL HEADER, with the
16  * fields enclosed by brackets "[]" replaced with your own identifying
17  * information: Portions Copyright [yyyy] [name of copyright owner]
18  *
19  * CDDL HEADER END
20  *
21  * $FreeBSD$
22  */
23 /*
24  * Copyright (c) 2010, Oracle and/or its affiliates. All rights reserved.
25  * Copyright (c) 2013 Mark Johnston <markj@freebsd.org>
26  */
27 
28 #pragma D depends_on library ip.d
29 #pragma D depends_on module kernel
30 #pragma D depends_on provider tcp
31 
32 /*
33  * Convert a TCP state value to a string.
34  */
35 #pragma D binding "1.6.3" TCPS_CLOSED
36 inline int TCPS_CLOSED =	0;
37 #pragma D binding "1.6.3" TCPS_LISTEN
38 inline int TCPS_LISTEN =	1;
39 #pragma D binding "1.6.3" TCPS_SYN_SENT
40 inline int TCPS_SYN_SENT =	2;
41 #pragma D binding "1.6.3" TCPS_SYN_RECEIVED
42 inline int TCPS_SYN_RECEIVED =	3;
43 #pragma D binding "1.6.3" TCPS_ESTABLISHED
44 inline int TCPS_ESTABLISHED =	4;
45 #pragma D binding "1.6.3" TCPS_CLOSE_WAIT
46 inline int TCPS_CLOSE_WAIT =	5;
47 #pragma D binding "1.6.3" TCPS_FIN_WAIT_1
48 inline int TCPS_FIN_WAIT_1 =	6;
49 #pragma D binding "1.6.3" TCPS_CLOSING
50 inline int TCPS_CLOSING =	7;
51 #pragma D binding "1.6.3" TCPS_LAST_ACK
52 inline int TCPS_LAST_ACK =	8;
53 #pragma D binding "1.6.3" TCPS_FIN_WAIT_2
54 inline int TCPS_FIN_WAIT_2 =	9;
55 #pragma D binding "1.6.3" TCPS_TIME_WAIT
56 inline int TCPS_TIME_WAIT =	10;
57 
58 /* TCP segment flags. */
59 #pragma D binding "1.6.3" TH_FIN
60 inline uint8_t TH_FIN =		0x01;
61 #pragma D binding "1.6.3" TH_SYN
62 inline uint8_t TH_SYN =		0x02;
63 #pragma D binding "1.6.3" TH_RST
64 inline uint8_t TH_RST =		0x04;
65 #pragma D binding "1.6.3" TH_PUSH
66 inline uint8_t TH_PUSH =	0x08;
67 #pragma D binding "1.6.3" TH_ACK
68 inline uint8_t TH_ACK =		0x10;
69 #pragma D binding "1.6.3" TH_URG
70 inline uint8_t TH_URG =		0x20;
71 #pragma D binding "1.6.3" TH_ECE
72 inline uint8_t TH_ECE =		0x40;
73 #pragma D binding "1.6.3" TH_CWR
74 inline uint8_t TH_CWR =		0x80;
75 
76 /* TCP connection state strings. */
77 #pragma D binding "1.6.3" tcp_state_string
78 inline string tcp_state_string[int32_t state] =
79 	state == TCPS_CLOSED ?		"state-closed" :
80 	state == TCPS_LISTEN ?		"state-listen" :
81 	state == TCPS_SYN_SENT ?	"state-syn-sent" :
82 	state == TCPS_SYN_RECEIVED ?	"state-syn-received" :
83 	state == TCPS_ESTABLISHED ?	"state-established" :
84 	state == TCPS_CLOSE_WAIT ?	"state-close-wait" :
85 	state == TCPS_FIN_WAIT_1 ?	"state-fin-wait-1" :
86 	state == TCPS_CLOSING ?		"state-closing" :
87 	state == TCPS_LAST_ACK ?	"state-last-ack" :
88 	state == TCPS_FIN_WAIT_2 ?	"state-fin-wait-2" :
89 	state == TCPS_TIME_WAIT ?	"state-time-wait" :
90 	"<unknown>";
91 
92 /*
93  * tcpsinfo contains stable TCP details from tcp_t.
94  */
95 typedef struct tcpsinfo {
96 	uintptr_t tcps_addr;
97 	int tcps_local;			/* is delivered locally, boolean */
98 	int tcps_active;		/* active open (from here), boolean */
99 	uint16_t tcps_lport;		/* local port */
100 	uint16_t tcps_rport;		/* remote port */
101 	string tcps_laddr;		/* local address, as a string */
102 	string tcps_raddr;		/* remote address, as a string */
103 	int32_t tcps_state;		/* TCP state */
104 	uint32_t tcps_iss;		/* Initial sequence # sent */
105 	uint32_t tcps_suna;		/* sequence # sent but unacked */
106 	uint32_t tcps_snxt;		/* next sequence # to send */
107 	uint32_t tcps_rack;		/* sequence # we have acked */
108 	uint32_t tcps_rnxt;		/* next sequence # expected */
109 	uint32_t tcps_swnd;		/* send window size */
110 	int32_t tcps_snd_ws;		/* send window scaling */
111 	uint32_t tcps_rwnd;		/* receive window size */
112 	int32_t tcps_rcv_ws;		/* receive window scaling */
113 	uint32_t tcps_cwnd;		/* congestion window */
114 	uint32_t tcps_cwnd_ssthresh;	/* threshold for congestion avoidance */
115 	uint32_t tcps_sack_fack;	/* SACK sequence # we have acked */
116 	uint32_t tcps_sack_snxt;	/* next SACK seq # for retransmission */
117 	uint32_t tcps_rto;		/* round-trip timeout, msec */
118 	uint32_t tcps_mss;		/* max segment size */
119 	int tcps_retransmit;		/* retransmit send event, boolean */
120 	int tcps_srtt;                  /* smoothed RTT in units of (TCP_RTT_SCALE*hz) */
121 } tcpsinfo_t;
122 
123 /*
124  * tcplsinfo provides the old tcp state for state changes.
125  */
126 typedef struct tcplsinfo {
127 	int32_t tcps_state;		/* previous TCP state */
128 } tcplsinfo_t;
129 
130 /*
131  * tcpinfo is the TCP header fields.
132  */
133 typedef struct tcpinfo {
134 	uint16_t tcp_sport;		/* source port */
135 	uint16_t tcp_dport;		/* destination port */
136 	uint32_t tcp_seq;		/* sequence number */
137 	uint32_t tcp_ack;		/* acknowledgment number */
138 	uint8_t tcp_offset;		/* data offset, in bytes */
139 	uint8_t tcp_flags;		/* flags */
140 	uint16_t tcp_window;		/* window size */
141 	uint16_t tcp_checksum;		/* checksum */
142 	uint16_t tcp_urgent;		/* urgent data pointer */
143 	struct tcphdr *tcp_hdr;		/* raw TCP header */
144 } tcpinfo_t;
145 
146 /*
147  * A clone of tcpinfo_t used to handle the fact that the TCP input path
148  * overwrites some fields of the TCP header with their host-order equivalents.
149  * Unfortunately, DTrace doesn't let us simply typedef a new name for struct
150  * tcpinfo and define a separate translator for it.
151  */
152 typedef struct tcpinfoh {
153 	uint16_t tcp_sport;		/* source port */
154 	uint16_t tcp_dport;		/* destination port */
155 	uint32_t tcp_seq;		/* sequence number */
156 	uint32_t tcp_ack;		/* acknowledgment number */
157 	uint8_t tcp_offset;		/* data offset, in bytes */
158 	uint8_t tcp_flags;		/* flags */
159 	uint16_t tcp_window;		/* window size */
160 	uint16_t tcp_checksum;		/* checksum */
161 	uint16_t tcp_urgent;		/* urgent data pointer */
162 	struct tcphdr *tcp_hdr;		/* raw TCP header */
163 } tcpinfoh_t;
164 
165 #pragma D binding "1.6.3" translator
166 translator csinfo_t < struct tcpcb *p > {
167 	cs_addr =	NULL;
168 	cs_cid =	(uint64_t)(p == NULL ? 0 : p->t_inpcb);
169 	cs_pid =	0;
170 	cs_zoneid =	0;
171 };
172 
173 #pragma D binding "1.6.3" translator
174 translator tcpsinfo_t < struct tcpcb *p > {
175 	tcps_addr =		(uintptr_t)p;
176 	tcps_local =		-1; /* XXX */
177 	tcps_active =		-1; /* XXX */
178 	tcps_lport =		p == NULL ? 0 : ntohs(p->t_inpcb->inp_inc.inc_ie.ie_lport);
179 	tcps_rport =		p == NULL ? 0 : ntohs(p->t_inpcb->inp_inc.inc_ie.ie_fport);
180 	tcps_laddr =		p == NULL ? 0 :
181 	    p->t_inpcb->inp_vflag == INP_IPV4 ?
182 	    inet_ntoa(&p->t_inpcb->inp_inc.inc_ie.ie_dependladdr.ie46_local.ia46_addr4.s_addr) :
183 	    inet_ntoa6(&p->t_inpcb->inp_inc.inc_ie.ie_dependladdr.ie6_local);
184 	tcps_raddr =		p == NULL ? 0 :
185 	    p->t_inpcb->inp_vflag == INP_IPV4 ?
186 	    inet_ntoa(&p->t_inpcb->inp_inc.inc_ie.ie_dependfaddr.ie46_foreign.ia46_addr4.s_addr) :
187 	    inet_ntoa6(&p->t_inpcb->inp_inc.inc_ie.ie_dependfaddr.ie6_foreign);
188 	tcps_state =		p == NULL ? -1 : p->t_state;
189 	tcps_iss =		p == NULL ? 0  : p->iss;
190 	tcps_suna =		p == NULL ? 0  : p->snd_una;
191 	tcps_snxt =		p == NULL ? 0  : p->snd_nxt;
192 	tcps_rack =		p == NULL ? 0  : p->last_ack_sent;
193 	tcps_rnxt =		p == NULL ? 0  : p->rcv_nxt;
194 	tcps_swnd =		p == NULL ? -1  : p->snd_wnd;
195 	tcps_snd_ws =		p == NULL ? -1  : p->snd_scale;
196 	tcps_rwnd =		p == NULL ? -1  : p->rcv_wnd;
197 	tcps_rcv_ws =		p == NULL ? -1  : p->rcv_scale;
198 	tcps_cwnd =		p == NULL ? -1  : p->snd_cwnd;
199 	tcps_cwnd_ssthresh =	p == NULL ? -1  : p->snd_ssthresh;
200 	tcps_sack_fack =	p == NULL ? 0  : p->snd_fack;
201 	tcps_sack_snxt =	p == NULL ? 0  : p->sack_newdata;
202 	tcps_rto =		p == NULL ? -1 : (p->t_rxtcur * 1000) / `hz;
203 	tcps_mss =		p == NULL ? -1  : p->t_maxseg;
204 	tcps_retransmit =	p == NULL ? -1 : p->t_rxtshift > 0 ? 1 : 0;
205 	tcps_srtt =             p == NULL ? -1  : p->t_srtt;   /* smoothed RTT in units of (TCP_RTT_SCALE*hz) */
206 };
207 
208 #pragma D binding "1.6.3" translator
209 translator tcpinfo_t < struct tcphdr *p > {
210 	tcp_sport =	p == NULL ? 0  : ntohs(p->th_sport);
211 	tcp_dport =	p == NULL ? 0  : ntohs(p->th_dport);
212 	tcp_seq =	p == NULL ? -1 : ntohl(p->th_seq);
213 	tcp_ack =	p == NULL ? -1 : ntohl(p->th_ack);
214 	tcp_offset =	p == NULL ? -1 : (p->th_off >> 2);
215 	tcp_flags =	p == NULL ? 0  : p->th_flags;
216 	tcp_window =	p == NULL ? 0  : ntohs(p->th_win);
217 	tcp_checksum =	p == NULL ? 0  : ntohs(p->th_sum);
218 	tcp_urgent =	p == NULL ? 0  : ntohs(p->th_urp);
219 	tcp_hdr =	(struct tcphdr *)p;
220 };
221 
222 /*
223  * This translator differs from the one for tcpinfo_t in that the sequence
224  * number, acknowledgement number, window size and urgent pointer are already
225  * in host order and thus don't need to be converted.
226  */
227 #pragma D binding "1.6.3" translator
228 translator tcpinfoh_t < struct tcphdr *p > {
229 	tcp_sport =	p == NULL ? 0  : ntohs(p->th_sport);
230 	tcp_dport =	p == NULL ? 0  : ntohs(p->th_dport);
231 	tcp_seq =	p == NULL ? -1 : p->th_seq;
232 	tcp_ack =	p == NULL ? -1 : p->th_ack;
233 	tcp_offset =	p == NULL ? -1 : (p->th_off >> 2);
234 	tcp_flags =	p == NULL ? 0  : p->th_flags;
235 	tcp_window =	p == NULL ? 0  : (p->th_win);
236 	tcp_checksum =	p == NULL ? 0  : ntohs(p->th_sum);
237 	tcp_urgent =	p == NULL ? 0  : p->th_urp;
238 	tcp_hdr =	(struct tcphdr *)p;
239 };
240 
241 #pragma D binding "1.6.3" translator
242 translator tcplsinfo_t < int s > {
243 	tcps_state =	s;
244 };
245