1 .\" Copyright (c) 2015 Mark Johnston <markj@FreeBSD.org>
2 .\" All rights reserved.
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
7 .\" 1. Redistributions of source code must retain the above copyright
8 .\" notice, this list of conditions and the following disclaimer.
9 .\" 2. Redistributions in binary form must reproduce the above copyright
10 .\" notice, this list of conditions and the following disclaimer in the
11 .\" documentation and/or other materials provided with the distribution.
13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32 .Nd a DTrace provider for tracing events related to the UDP protocol
34 .Fn udp:::receive "pktinfo_t *" "csinfo_t *" "ipinfo_t *" "udpsinfo_t *" \
36 .Fn udp:::send "pktinfo_t *" "csinfo_t *" "ipinfo_t *" "udpsinfo_t *" \
41 provider allows users to trace events in the
43 protocol implementation.
46 probe fires whenever the kernel prepares to transmit a UDP packet, and the
48 probe fires whenever the kernel receives a UDP packet.
49 The arguments to these probes can be used to obtain detailed information about
50 the IP and UDP headers of the corresponding packet.
54 argument is currently unimplemented and is included for compatibility with other
55 implementations of this provider.
57 .Bl -tag -width "uintptr_t pkt_addr" -offset indent
58 .It Vt uintptr_t pkt_addr
64 argument is currently unimplemented and is included for compatibility with other
65 implementations of this provider.
67 .Bl -tag -width "uintptr_t cs_addr" -offset indent
68 .It Vt uintptr_t cs_addr
70 .It Vt uint64_t cs_cid
81 argument contains IP fields common to both IPv4 and IPv6 packets.
83 .Bl -tag -width "uint32_t ip_plength" -offset indent
85 IP version of the packet, 4 for IPv4 packets and 6 for IPv6 packets.
86 .It Vt uint32_t ip_plength
88 This does not include the size of the IP header or IPv6 option headers.
89 .It Vt string ip_saddr
91 .It Vt string ip_daddr
92 IP destination address.
97 argument contains the state of the UDP connection associated with the packet.
99 .Bl -tag -width "uintptr_t udps_addr" -offset indent
100 .It Vt uintptr_t udps_addr
103 containing the IP state for the associated socket.
104 .It Vt uint16_t udps_lport
106 .It Vt uint16_t udps_rport
108 .It Vt string udps_laddr
109 Local IPv4 or IPv6 address.
110 .It Vt string udps_raddr
111 Remote IPv4 or IPv6 address.
116 argument is the raw UDP header of the packet, with all fields in host order.
118 .Bl -tag -width "struct udphdr *udp_hdr" -offset indent
119 .It Vt uint16_t udp_sport
121 .It Vt uint16_t udp_dport
122 Destination UDP port.
123 .It Vt uint16_t udp_length
124 Length of the UDP header and payload, in bytes.
125 .It Vt uint16_t udp_checksum
126 A checksum of the UDP header and payload, or 0 if no checksum was calculated.
127 .It Vt struct udphdr *udp_hdr
128 A pointer to the raw UDP header.
131 .Bl -tag -width "/usr/lib/dtrace/udp.d" -compact
132 .It Pa /usr/lib/dtrace/udp.d
133 DTrace type and translator definitions for the
138 The following script counts transmitted packets by destination port.
139 .Bd -literal -offset indent
142 @num[args[4]->udp_dport] = count();
146 This script will print some details of each UDP packet as it is sent or received
148 .Bd -literal -offset indent
149 #pragma D option quiet
150 #pragma D option switchrate=10Hz
154 printf(" %10s %36s %-36s %6s\\n", "DELTA(us)", "SOURCE",
161 this->elapsed = (timestamp - last) / 1000;
162 self->dest = strjoin(strjoin(args[2]->ip_daddr, ":"),
163 lltostr(args[4]->udp_dport));
164 printf(" %10d %30s:%-5d -> %-36s %6d\\n", this->elapsed,
165 args[2]->ip_saddr, args[4]->udp_sport,
166 self->dest, args[4]->udp_length);
172 this->elapsed = (timestamp - last) / 1000;
173 self->dest = strjoin(strjoin(args[2]->ip_saddr, ":"),
174 lltostr(args[4]->udp_sport));
175 printf(" %10d %30s:%-5d <- %-36s %6d\\n", this->elapsed,
176 args[2]->ip_daddr, args[4]->udp_dport,
177 self->dest, args[4]->udp_length);
182 This provider is compatible with the
194 provider first appeared in
198 This manual page was written by
199 .An Mark Johnston Aq Mt markj@FreeBSD.org .