xref: /freebsd/share/man/man4/dtrace_mib.4 (revision ef19cae25337e7449f338914650bbfab0fbea99f)
1*ef19cae2SMateusz Piotrowski.\"
2*ef19cae2SMateusz Piotrowski.\" Copyright (c) 2025-2026  Mateusz Piotrowski <0mp@FreeBSD.org>
3*ef19cae2SMateusz Piotrowski.\"
4*ef19cae2SMateusz Piotrowski.\" SPDX-License-Identifier: BSD-2-Clause
5*ef19cae2SMateusz Piotrowski.\"
6*ef19cae2SMateusz Piotrowski.Dd May 7, 2026
7*ef19cae2SMateusz Piotrowski.Dt DTRACE_MIB 4
8*ef19cae2SMateusz Piotrowski.Os
9*ef19cae2SMateusz Piotrowski.Sh NAME
10*ef19cae2SMateusz Piotrowski.Nm dtrace_mib
11*ef19cae2SMateusz Piotrowski.Nd a DTrace provider for Management Information Base
12*ef19cae2SMateusz Piotrowski.Sh SYNOPSIS
13*ef19cae2SMateusz Piotrowski.Cm mib: Ns Ar module Ns Cm \&:count: Ns Ar counter
14*ef19cae2SMateusz Piotrowski.Pp
15*ef19cae2SMateusz PiotrowskiIn
16*ef19cae2SMateusz Piotrowski.Xr config 5 :
17*ef19cae2SMateusz Piotrowski.Cd "options KDTRACE_MIB_SDT"
18*ef19cae2SMateusz Piotrowski.Sh DESCRIPTION
19*ef19cae2SMateusz PiotrowskiThe
20*ef19cae2SMateusz Piotrowski.Nm mib
21*ef19cae2SMateusz Piotrowskiprovider allows tracing of Management Information Base stats counters.
22*ef19cae2SMateusz Piotrowski.Pp
23*ef19cae2SMateusz PiotrowskiThe list of instrumented
24*ef19cae2SMateusz Piotrowski.Ar module Ns s
25*ef19cae2SMateusz Piotrowskiincludes:
26*ef19cae2SMateusz Piotrowski.Bl -tag -offset indent -width ipcomp -compact
27*ef19cae2SMateusz Piotrowski.It Cm ah
28*ef19cae2SMateusz PiotrowskiIP Authentication Header (RFC 2402),
29*ef19cae2SMateusz Piotrowski.Xr ipsec 4
30*ef19cae2SMateusz Piotrowski.It Cm esp
31*ef19cae2SMateusz PiotrowskiIP Encapsulating Security Payload (RFC 1827, RFC 2406),
32*ef19cae2SMateusz Piotrowski.Xr ipsec 4
33*ef19cae2SMateusz Piotrowski.It Cm icmp
34*ef19cae2SMateusz Piotrowski.Xr icmp 4
35*ef19cae2SMateusz Piotrowski.It Cm icmp6
36*ef19cae2SMateusz Piotrowski.Xr icmp6 4
37*ef19cae2SMateusz Piotrowski.It Cm ip
38*ef19cae2SMateusz Piotrowski.Xr ip 4
39*ef19cae2SMateusz Piotrowski.It Cm ip6
40*ef19cae2SMateusz Piotrowski.Xr ip6 4
41*ef19cae2SMateusz Piotrowski.It Cm ipcomp
42*ef19cae2SMateusz PiotrowskiIP Payload Compression Protocol,
43*ef19cae2SMateusz Piotrowski.Xr ipsec 4
44*ef19cae2SMateusz Piotrowski.It Cm ipsec
45*ef19cae2SMateusz Piotrowski.Xr ipsec 4
46*ef19cae2SMateusz Piotrowski.It Cm tcp
47*ef19cae2SMateusz Piotrowski.Xr tcp 4
48*ef19cae2SMateusz Piotrowski.It Cm udp
49*ef19cae2SMateusz Piotrowski.Xr udp 4
50*ef19cae2SMateusz Piotrowski.El
51*ef19cae2SMateusz Piotrowski.Pp
52*ef19cae2SMateusz PiotrowskiThe
53*ef19cae2SMateusz Piotrowski.Cm mib: Ns Ar module Ns Cm \&:count: Ns Ar counter
54*ef19cae2SMateusz Piotrowskiprobes fire when the
55*ef19cae2SMateusz Piotrowski.Ar counter
56*ef19cae2SMateusz Piotrowskiin
57*ef19cae2SMateusz Piotrowski.Ar module Ns s
58*ef19cae2SMateusz Piotrowskiincreases.
59*ef19cae2SMateusz Piotrowski.Pp
60*ef19cae2SMateusz PiotrowskiThe first probe argument,
61*ef19cae2SMateusz Piotrowski.Vt uint64_t Va args[0] ,
62*ef19cae2SMateusz Piotrowskiis the increment that the
63*ef19cae2SMateusz Piotrowski.Ar counter
64*ef19cae2SMateusz Piotrowskiwill increase by.
65*ef19cae2SMateusz Piotrowski.Pp
66*ef19cae2SMateusz PiotrowskiNote that some probes like
67*ef19cae2SMateusz Piotrowski.Cm mib:esp:count:esps_hist
68*ef19cae2SMateusz Piotrowskior
69*ef19cae2SMateusz Piotrowski.Cm mib:icmp6:count:icp6s_outhist
70*ef19cae2SMateusz Piotrowskiprovide additional probe-specific arguments.
71*ef19cae2SMateusz Piotrowski.Sh EXAMPLES
72*ef19cae2SMateusz Piotrowski.Ss Example 1 : Tracing IP Stats Counters
73*ef19cae2SMateusz PiotrowskiWhen debugging network issues one common clue is an unexpectedly
74*ef19cae2SMateusz Piotrowskiincrementing error counter.
75*ef19cae2SMateusz PiotrowskiThis is helpful, in that it gives us an
76*ef19cae2SMateusz Piotrowskiidea of what might be going wrong, but often these counters may be
77*ef19cae2SMateusz Piotrowskiincremented in different functions.
78*ef19cae2SMateusz Piotrowski.Pp
79*ef19cae2SMateusz PiotrowskiTrace all
80*ef19cae2SMateusz Piotrowski.Nm mib
81*ef19cae2SMateusz Piotrowskiprobes in the
82*ef19cae2SMateusz Piotrowski.Xr ip 4
83*ef19cae2SMateusz Piotrowskimodule and print the current count and a stack trace:
84*ef19cae2SMateusz Piotrowski.Pp
85*ef19cae2SMateusz Piotrowski.Bd -literal -offset 2n
86*ef19cae2SMateusz Piotrowski# dtrace -n 'mib:ip:count: { printf("%d", arg0); stack(); }'
87*ef19cae2SMateusz Piotrowskidtrace: description 'mib:ip:count: ' matched 29 probes
88*ef19cae2SMateusz PiotrowskiCPU     ID                    FUNCTION:NAME
89*ef19cae2SMateusz Piotrowski  7  98784               count:ips_localout 1
90*ef19cae2SMateusz Piotrowski              kernel`ip_output+0x17a2
91*ef19cae2SMateusz Piotrowski              kernel`udp_send+0xaca
92*ef19cae2SMateusz Piotrowski              kernel`sosend_dgram+0x315
93*ef19cae2SMateusz Piotrowski              kernel`sousrsend+0x79
94*ef19cae2SMateusz Piotrowski              kernel`kern_sendit+0x1be
95*ef19cae2SMateusz Piotrowski              kernel`sendit+0x1ab
96*ef19cae2SMateusz Piotrowski              kernel`sys_sendmsg+0x5b
97*ef19cae2SMateusz Piotrowski              kernel`amd64_syscall+0x169
98*ef19cae2SMateusz Piotrowski              kernel`0xffffffff81094b8b
99*ef19cae2SMateusz Piotrowski.Ed
100*ef19cae2SMateusz Piotrowski.Sh SEE ALSO
101*ef19cae2SMateusz Piotrowski.Xr dtrace 1 ,
102*ef19cae2SMateusz Piotrowski.Xr dtrace_ip 4 ,
103*ef19cae2SMateusz Piotrowski.Xr dtrace_tcp 4 ,
104*ef19cae2SMateusz Piotrowski.Xr dtrace_udp 4 ,
105*ef19cae2SMateusz Piotrowski.Xr tracing 7 ,
106*ef19cae2SMateusz Piotrowski.Xr sysctl 8
107*ef19cae2SMateusz Piotrowski.Sh STANDARDS
108*ef19cae2SMateusz PiotrowskiThe probe descriptions in
109*ef19cae2SMateusz Piotrowskithe
110*ef19cae2SMateusz Piotrowski.Fx
111*ef19cae2SMateusz Piotrowski.Nm mib
112*ef19cae2SMateusz Piotrowskiprovider are not compatible with those in the Solaris/illumos mib provider.
113*ef19cae2SMateusz Piotrowski.Sh AUTHORS
114*ef19cae2SMateusz Piotrowski.An -nosplit
115*ef19cae2SMateusz PiotrowskiThe
116*ef19cae2SMateusz Piotrowski.Nm mib
117*ef19cae2SMateusz Piotrowskiprovider was added to
118*ef19cae2SMateusz Piotrowski.Fx
119*ef19cae2SMateusz Piotrowskiby
120*ef19cae2SMateusz Piotrowski.An Kristof Provost Aq Mt kp@FreeBSD.org .
121*ef19cae2SMateusz Piotrowski.Pp
122*ef19cae2SMateusz PiotrowskiThis manual page was written by
123*ef19cae2SMateusz Piotrowski.An Mateusz Piotrowski Aq Mt 0mp@FreeBSD.org .
124