Don't specify a function name in the example SDT(9) probe. As with the

module component, it is a bug that the SDT(9) KPI allows one to specify the
function component of an SDT probe. Currently, the module component is
filled in automatically if left unset; this is not yet true for the function
component, but will be addressed by some ongoing work.

MFC after:	3 days
This commit is contained in:
Mark Johnston 2015-03-09 04:00:46 +00:00
parent aa14e9b7c9
commit d85550b2c7
Notes: svn2git 2020-12-20 02:59:44 +00:00
svn path=/head/; revision=279802

View File

@ -24,7 +24,7 @@
.\"
.\" $FreeBSD$
.\"
.Dd September 18, 2014
.Dd March 8, 2015
.Dt SDT 9
.Os
.Sh NAME
@ -196,13 +196,13 @@ They are meant to be added to executable code and can be used to instrument the
code in which they are called.
.Sh EXAMPLES
The following probe definition will create a DTrace probe called
.Ql icmp::unreach:pkt-receive ,
.Ql icmp:::receive-unreachable ,
which would hypothetically be triggered when the kernel receives an ICMP packet
of type Destination Unreachable:
.Bd -literal -offset indent
SDT_PROVIDER_DECLARE(icmp);
SDT_PROBE_DEFINE1(icmp, , unreach, pkt__receive,
SDT_PROBE_DEFINE1(icmp, , , receive__unreachable,
"struct icmp *");
.Ed
@ -286,10 +286,10 @@ This manual page was written by
.Sh BUGS
The
.Nm
macros allow the module name of a probe to be specified as part of a probe
definition.
However, the DTrace framework uses the module name of probes to determine
which probes should be destroyed when a kernel module is unloaded, so the module
macros allow the module and function names of a probe to be specified as part of
a probe definition.
The DTrace framework uses the module name of probes to determine which probes
should be destroyed when a kernel module is unloaded, so the module
name of a probe should match the name of the module in which its defined.
.Nm
will set the module name properly if it is left unspecified in the probe