Print this page
12743 man page spelling mistakes
*** 1,16 ****
'\" te
.\" Copyright 1999 Sun Microsystems, Inc. All Rights Reserved.
.\" 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.
.\" 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.
.\" 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]
! .TH TNF_KERNEL_PROBES 4 "Nov 8, 1999"
.SH NAME
tnf_kernel_probes \- TNF kernel probes
.SH DESCRIPTION
- .sp
- .LP
The set of probes (trace instrumentation points) available in the standard
kernel. The probes log trace data to a kernel trace buffer in Trace Normal
Form (TNF). Kernel probes are controlled by \fBprex\fR(1). A snapshot of the
kernel trace buffer can be made using \fBtnfxtract\fR(1) and examined using
\fBtnfdump\fR(1).
--- 1,14 ----
'\" te
.\" Copyright 1999 Sun Microsystems, Inc. All Rights Reserved.
.\" 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.
.\" 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.
.\" 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]
! .TH TNF_KERNEL_PROBES 4 "May 16, 2020"
.SH NAME
tnf_kernel_probes \- TNF kernel probes
.SH DESCRIPTION
The set of probes (trace instrumentation points) available in the standard
kernel. The probes log trace data to a kernel trace buffer in Trace Normal
Form (TNF). Kernel probes are controlled by \fBprex\fR(1). A snapshot of the
kernel trace buffer can be made using \fBtnfxtract\fR(1) and examined using
\fBtnfdump\fR(1).
*** 20,30 ****
\fIkeys\fR, or \fIcategories\fR. These are used to select and control probes
from \fBprex\fR(1). A probe that is enabled for tracing generates a \fBTNF\fR
record, called an \fIevent record\fR. An event record contains two common
members and may contain other probe-specific data members.
.SS "Common Members"
- .sp
.in +2
.nf
\fBtnf_probe_event\fR \fItag\fR
\fBtnf_time_delta\fR \fItime_delta\fR
.fi
--- 18,27 ----
*** 68,78 ****
time of the event.
.RE
.SS "Threads"
.SS "\fBthread_create\fR"
- .sp
.in +2
.nf
\fBtnf_kthread_id\fR \fItid\fR
\fBtnf_pid\fR \fIpid\fR
\fBtnf_symbol\fR \fIstart_pc\fR
--- 65,74 ----
*** 108,118 ****
.RS 12n
The kernel address of its start routine.
.RE
.SS "\fBthread_state\fR"
- .sp
.in +2
.nf
\fBtnf_kthread_id\fR \fItid\fR
\fBtnf_microstate\fR \fIstate\fR
.fi
--- 104,113 ----
*** 179,198 ****
microstates that are induced by system calls are not traced. This information
is implicit in the system call entry and exit events.
.RE
.SS "thread_exit"
- .sp
- .LP
Thread termination event for writing thread. This probe has no data members
other than the common members.
.SS "Scheduling"
- .sp
- .LP
\fB\fR
.SS "thread_queue"
- .sp
.in +2
.nf
\fBtnf_kthread_id\fR \fItid\fR
\fBtnf_cpuid\fR \fIcpuid\fR
\fBtnf_long\fR \fIpriority\fR
--- 174,188 ----
*** 231,241 ****
The current length of the cpu's dispatch queue.
.RE
.SS "Blocking"
.SS "\fBthread_block\fR"
- .sp
.in +2
.nf
\fBtnf_opaque\fR \fIreason\fR
\fBtnf_symbols\fR \fIstack\fR
.fi
--- 221,230 ----
*** 264,274 ****
stack at the time the thread blocks.
.RE
.SS "System Calls"
.SS "\fBsyscall_start\fR"
- .sp
.in +2
.nf
\fBtnf_sysnum\fR \fIsysnum\fR
.fi
.in -2
--- 253,262 ----
*** 285,295 ****
The system call number. The writing thread implicitly enters the \fIsystem\fR
microstate with this event.
.RE
.SS "\fBsyscall_end\fR"
- .sp
.in +2
.nf
\fBtnf_long\fR \fIrval1\fR
\fBtnf_long\fR \fIrval2\fR
\fBtnf_long\fR \fIerrno\fR
--- 273,282 ----
*** 320,330 ****
.sp
.LP
The writing thread implicitly enters the \fIuser\fR microstate with this event.
.SS "Page Faults"
.SS "\fBaddress_fault\fR"
- .sp
.in +2
.nf
\fBtnf_opaque\fR \fIaddress\fR
\fBtnf_fault_type\fR \fIfault_type\fR
\fBtnf_seg_access\fR \fIaccess\fR
--- 307,316 ----
*** 362,372 ****
Gives the desired access protection: read, write, execute or create. The values
for these two members are defined in <\fBvm/seg_enum.h\fR>.
.RE
.SS "\fBmajor_fault\fR"
- .sp
.in +2
.nf
\fBtnf_opaque\fR \fIvnode\fR
\fBtnf_offset\fR \fIoffset\fR
.fi
--- 348,357 ----
*** 377,387 ****
Major page fault event. The faulting page is mapped to the file given by the
\fIvnode\fR member, at the given \fIoffset\fR into the file. (The faulting
virtual address is in the most recent \fBaddress_fault\fR event for the writing
thread.)
.SS "\fBanon_private\fR"
- .sp
.in +2
.nf
\fBtnf_opaque\fR \fIaddress\fR
.fi
.in -2
--- 362,371 ----
*** 397,407 ****
.RS 11n
The virtual address at which the new page is mapped.
.RE
.SS "\fBanon_zero\fR"
- .sp
.in +2
.nf
\fBtnf_opaque\fR \fIaddress\fR
.fi
.in -2
--- 381,390 ----
*** 417,427 ****
.RS 11n
The virtual address at which the new page is mapped.
.RE
.SS "\fBpage_unmap\fR"
- .sp
.in +2
.nf
\fBtnf_opaque\fR \fIvnode\fR
\fBtnf_offset\fR \fIoffset\fR
.fi
--- 400,409 ----
*** 440,450 ****
Identifies the file and offset of the page being unmapped.
.RE
.SS "Pageins and Pageouts"
.SS "\fBpagein\fR"
- .sp
.in +2
.nf
\fBtnf_opaque\fR \fIvnode\fR
\fBtnf_offset\fR \fIoffset\fR
\fBtnf_size\fR \fIsize\fR
--- 422,431 ----
*** 458,468 ****
.ne 2
.na
\fB\fIvnode\fRand\fIoffset\fR\fR
.ad
.RS 18n
! Identifyies the file and offset to be paged in.
.RE
.sp
.ne 2
.na
--- 439,449 ----
.ne 2
.na
\fB\fIvnode\fRand\fIoffset\fR\fR
.ad
.RS 18n
! Identifies the file and offset to be paged in.
.RE
.sp
.ne 2
.na
*** 471,481 ****
.RS 18n
Specifies the number of bytes to be paged in.
.RE
.SS "\fBpageout\fR"
- .sp
.in +2
.nf
\fBtnf_opaque\fR \fIvnode\fR
\fBtnf_ulong\fR \fIpages_pageout\fR
\fBtnf_ulong\fR \fIpages_freed\fR
--- 452,461 ----
*** 522,532 ****
The number of pages reclaimed after being written out.
.RE
.SS "Page Daemon (Page Stealer)"
.SS "\fBpageout_scan_start\fR"
- .sp
.in +2
.nf
\fBtnf_ulong\fR \fIpages_free\fR
\fBtnf_ulong\fR \fIpages_needed\fR
.fi
--- 502,511 ----
*** 553,563 ****
.RS 16n
The number of pages desired free.
.RE
.SS "\fBpageout_scan_end\fR"
- .sp
.in +2
.nf
\fBtnf_ulong\fR \fIpages_free\fR
\fBtnf_ulong\fR \fIpages_scanned\fR
.fi
--- 532,541 ----
*** 586,596 ****
be freed when any queued pageout requests complete.)
.RE
.SS "Swapper"
.SS "\fBswapout_process\fR"
- .sp
.in +2
.nf
\fBtnf_pid\fR \fIpid\fR
\fBtnf_ulong\fR \fIpage_count\fR
.fi
--- 564,573 ----
*** 617,627 ****
.RS 14n
Reports the number of pages either freed or queued for pageout.
.RE
.SS "\fBswapout_lwp\fR"
- .sp
.in +2
.nf
\fBtnf_pid\fR \fIpid\fR
\fBtnf_lwpid\fR \fIlwpid\fR
\fBtnf_kthread_id\fR \fItid\fR
--- 594,603 ----
*** 668,678 ****
.RS 14n
The number of pages swapped out.
.RE
.SS "\fBswapin_lwp\fR"
- .sp
.in +2
.nf
\fBtnf_pid\fR \fIpid\fR
\fBtnf_lwpid\fR \fIlwpid\fR
\fBtnf_kthread_id\fR \fItid\fR
--- 644,653 ----
*** 720,730 ****
The number of pages swapped in.
.RE
.SS "Local I/O"
.SS "\fBstrategy\fR"
- .sp
.in +2
.nf
\fBtnf_device\fR \fIdevice\fR
\fBtnf_diskaddr\fR \fIblock\fR
\fBtnf_size\fR \fIsize\fR
--- 695,704 ----
*** 781,791 ****
.RS 10n
The \fBbuf\fR(9S) flags associated with the transfer.
.RE
.SS "\fBbiodone\fR"
- .sp
.in +2
.nf
\fBtnf_device\fR \fIdevice\fR
\fBtnf_diskaddr\fR \fIblock\fR
\fBtnf_opaque\fR \fIbuf\fR
--- 755,764 ----
*** 822,832 ****
.RS 10n
The kernel address of the \fBbuf\fR(9S) structure associated with the transfer.
.RE
.SS "\fBphysio_start\fR"
- .sp
.in +2
.nf
\fBtnf_device\fR \fIdevice\fR
\fBtnf_offset\fR \fIoffset\fR
\fBtnf_size\fR \fIsize\fR
--- 795,804 ----
*** 835,845 ****
.in -2
.sp
.LP
Raw I/O start event. This event marks entry into the \fBphysio\fR(9F)
! fufnction which performs unbuffered I/O.
.sp
.ne 2
.na
\fB\fIdevice\fR\fR
.ad
--- 807,817 ----
.in -2
.sp
.LP
Raw I/O start event. This event marks entry into the \fBphysio\fR(9F)
! function which performs unbuffered I/O.
.sp
.ne 2
.na
\fB\fIdevice\fR\fR
.ad
*** 873,892 ****
.RS 10n
The direction of the transfer: read or write (see \fBbuf\fR(9S)).
.RE
.SS "\fBphysio_end\fR"
- .sp
.in +2
.nf
\fBtnf_device\fR \fIdevice\fR
.fi
.in -2
.sp
.LP
! Raw I/O end event. This event marks exit from the \fBphysio\fR(9F) fufnction.
.sp
.ne 2
.na
\fB\fIdevice\fR\fR
.ad
--- 845,863 ----
.RS 10n
The direction of the transfer: read or write (see \fBbuf\fR(9S)).
.RE
.SS "\fBphysio_end\fR"
.in +2
.nf
\fBtnf_device\fR \fIdevice\fR
.fi
.in -2
.sp
.LP
! Raw I/O end event. This event marks exit from the \fBphysio\fR(9F) function.
.sp
.ne 2
.na
\fB\fIdevice\fR\fR
.ad
*** 893,904 ****
.RS 10n
The major and minor numbers of the device of the transfer.
.RE
.SH USAGE
- .sp
- .LP
Use the \fBprex\fR utility to control kernel probes. The standard \fBprex\fR
commands to list and manipulate probes are available to you, along with
commands to set up and manage kernel tracing.
.sp
.LP
--- 864,873 ----
*** 966,975 ****
.LP
A convenient way to follow these steps is to use two shell windows; run an
interactive \fBprex\fR session in one, and run your application and
\fBtnfxtract\fR in the other.
.SH SEE ALSO
- .sp
- .LP
\fBprex\fR(1), \fBtnfdump\fR(1), \fBtnfxtract\fR(1), \fBlibtnfctl\fR(3TNF),
\fBTNF_PROBE\fR(3TNF), \fBtracing\fR(3TNF), \fBstrategy\fR(9E),
\fBbiodone\fR(9F), \fBphysio\fR(9F), \fBbuf\fR(9S)
--- 935,942 ----