8916 man pages should refer to our own Dynamic Tracing Guide
[unleashed.git] / usr / src / man / man7d / fbt.7d
blob3b62aa3392a17d026a471b1bd5fe9b63498e0331
1 '\" te
2 .\"  Copyright (c) 2003, Sun Microsystems, Inc.  All Rights Reserved
3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
5 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
6 .TH FBT 7D "Dec 10, 2017"
7 .SH NAME
8 fbt \- DTrace function boundary tracing provider
9 .SH DESCRIPTION
10 .LP
11 The \fBfbt\fR driver is a DTrace dynamic tracing provider that performs dynamic
12 instrumentation at function boundaries in the kernel.
13 .sp
14 .LP
15 The function is the fundamental unit of program text. In a well-designed
16 system, the function performs a discrete and well-defined operation on a
17 specified object or series of like objects. Most functions are implemented by
18 themselves calling functions on encapsulated objects, but some functions
19 \(emso-called "leaf functions" \(em are implemented without making further
20 function calls. The Function Boundary Tracing \fBfbt\fR provider contains a
21 mechanism for instrumenting the vast majority of functions in the kernel and
22 offering the instrumentation as a set of DTrace probes.
23 .sp
24 .LP
25 The \fBfbt\fR driver is not a public interface and you access the
26 instrumentation offered by this provider through DTrace. Refer to the
27 \fIDynamic Tracing Guide\fR for a description of the public documented
28 interfaces available for the DTrace facility and the probes offered by the
29 \fBfbt\fR provider.
30 .SH ATTRIBUTES
31 .LP
32 See \fBattributes\fR(5) for a description of the following attributes:
33 .sp
35 .sp
36 .TS
37 box;
38 c | c
39 l | l .
40 ATTRIBUTE TYPE  ATTRIBUTE VALUE
42 Interface Stability     Private
43 .TE
45 .SH SEE ALSO
46 .LP
47 \fBdtrace\fR(1M), \fBattributes\fR(5), \fBdtrace\fR(7D)
48 .sp
49 .LP
50 \fIDynamic Tracing Guide\fR:
51 .sp
52 .LP
53 https://illumos.org/books/dtrace/