Page MenuHomeFreeBSD

Manual pages for various DTrace providers.
ClosedPublic

Authored by markj on Mar 28 2015, 9:18 PM.
Tags
None
Referenced Files
Unknown Object (File)
Tue, Nov 5, 5:57 PM
Unknown Object (File)
Tue, Nov 5, 5:57 PM
Unknown Object (File)
Tue, Nov 5, 5:55 PM
Unknown Object (File)
Tue, Nov 5, 5:55 PM
Unknown Object (File)
Sun, Nov 3, 1:03 PM
Unknown Object (File)
Sat, Nov 2, 1:36 AM
Unknown Object (File)
Sep 27 2024, 5:05 PM
Unknown Object (File)
Sep 25 2024, 7:42 PM

Details

Summary

This is a first attempt at documenting some of the more "standard" DTrace providers in FreeBSD. We don't currently have any documentation for static probes, so I had to come up with some conventions. They're obviously not set in stone yet, so please feel free to suggest sweeping changes in addition to the usual wording/consistency/completeness issues.

The main reference for Solaris DTrace providers are pages on the Oracle wiki, e.g. https://wikis.oracle.com/display/DTrace/ip+Provider

I followed a roughly similar format: each provider gets its own man page, the probes are described in the DESCRIPTION section, argument types are described in ARGUMENTS, and some examples are under EXAMPLES. Probe names are rendered using the .Fn macro; this isn't really ideal, but I don't see any good alternatives. In general, I try to describe the conditions under which a given probe will fire, as well as the arguments it receives. Rendered pages are here: https://people.freebsd.org/~markj/dtrace/man/

As mentioned, this covers only a subset of the SDT providers that we have. Most of the rest are less complete and mainly intended for developer debugging, so they're not very amenable to documentation.

Diff Detail

Repository
rS FreeBSD src repository - subversion
Lint
Lint Skipped
Unit
Tests Skipped

Event Timeline

markj retitled this revision from to Manual pages for various DTrace providers..
markj edited the test plan for this revision. (Show Details)
rpaulo added a reviewer: rpaulo.
rpaulo added a subscriber: rpaulo.

Good job :)

share/man/man4/dtrace-proc.4
226 ↗(On Diff #4488)

Hmm, maybe we should fix this. :-)

share/man/man4/dtrace-tcp.4
355 ↗(On Diff #4488)

I think this isn't true anymore on Darwin since lots of TCP probes are missing on Darwin.

This revision is now accepted and ready to land.Mar 28 2015, 10:29 PM

Looks nice! The comment are mostly recurring small issues.

share/man/man4/dtrace-io.4
37 ↗(On Diff #4488)

This should probably be:

The
.Nm io
provider...

96 ↗(On Diff #4488)

FreeBSD -> .Fx

102 ↗(On Diff #4488)

.Nm io, same as above

111 ↗(On Diff #4488)

FreeBSD -> .Fx

share/man/man4/dtrace-ip.4
39 ↗(On Diff #4488)

.Nm ip

52 ↗(On Diff #4488)

Xref the dtrace-{tcp, udp} manpages perhaps?

214 ↗(On Diff #4488)

.Nm ip

257 ↗(On Diff #4488)

.Nm ip

267 ↗(On Diff #4488)

.Nm ip and .Fx

share/man/man4/dtrace-proc.4
43 ↗(On Diff #4488)

.Nm proc

123 ↗(On Diff #4488)

.Nm proc and .Fx

199 ↗(On Diff #4488)

.Nm proc

220 ↗(On Diff #4488)

.Nm proc and .Fx

227 ↗(On Diff #4488)

.Nm proc

228 ↗(On Diff #4488)

.Fx

241 ↗(On Diff #4488)

.Nm proc and .Fx

share/man/man4/dtrace-sched.4
48 ↗(On Diff #4488)

.Nm sched

149 ↗(On Diff #4488)

.Nm sched

196 ↗(On Diff #4488)

.Fx

202 ↗(On Diff #4488)

.Fx

210 ↗(On Diff #4488)

.Nm sched and .Fx

share/man/man4/dtrace-tcp.4
53 ↗(On Diff #4488)

.Nm tcp

56 ↗(On Diff #4488)

Xref dtrace-{ip, udp}.4?

59 ↗(On Diff #4488)

.Nm tcp

66 ↗(On Diff #4488)

Typo, exposes

115 ↗(On Diff #4488)

.Xr dtrace-udp 4 and .Nm tcp

117 ↗(On Diff #4488)

.Xr dtrace-ip 4

165 ↗(On Diff #4488)

.Nm tcp

277 ↗(On Diff #4488)

.Nm tcp

363 ↗(On Diff #4488)

.Nm tcp and .Fx

share/man/man4/dtrace-udp.4
39 ↗(On Diff #4488)

.Nm udp

131 ↗(On Diff #4488)

.Nm udp

186 ↗(On Diff #4488)

.Nm udp and .Fx

markj edited edge metadata.
  • Address review comments from brueffer.
This revision now requires review to proceed.Mar 30 2015, 6:52 PM
In D2170#10, @brueffer wrote:

Looks nice! The comment are mostly recurring small issues.

Thanks! I think I addressed all the comments with the last upload.

share/man/man4/dtrace-proc.4
226 ↗(On Diff #4488)

I'd like to, but I don't think we can without breaking compatibility, D2169 notwithstanding. :)

There are a number of other compatibility-breaking changes that I'd like to make, mostly for PR 195222: https://bugs.freebsd.org/bugzilla/show_bug.cgi?id=195222

share/man/man4/dtrace-tcp.4
355 ↗(On Diff #4488)

Hm, ok. I'll check on my macbook and revise.

bcr added a reviewer: bcr.
bcr added a subscriber: bcr.

I think this is too important to have these man pages to not to stall it longer from the docs point of view.

This revision is now accepted and ready to land.Apr 18 2015, 7:29 PM
markj updated this revision to Diff 4909.

Closed by commit rS281705 (authored by @markj).