8322 nl: misleading-indentation
[unleashed/tickless.git] / usr / src / man / man4 / tnf_kernel_probes.4
blob7d5c3c1ee034f08f87b468f0351f2fe14488c486
1 '\" te
2 .\"  Copyright 1999 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 TNF_KERNEL_PROBES 4 "Nov 8, 1999"
7 .SH NAME
8 tnf_kernel_probes \- TNF kernel probes
9 .SH DESCRIPTION
10 .sp
11 .LP
12 The set of probes (trace instrumentation points) available in the standard
13 kernel.  The probes log trace data to a kernel trace buffer in Trace Normal
14 Form  (TNF).  Kernel probes are controlled by \fBprex\fR(1). A snapshot of the
15 kernel trace buffer can be made using \fBtnfxtract\fR(1) and examined using
16 \fBtnfdump\fR(1).
17 .sp
18 .LP
19 Each probe has a \fIname\fR and is associated with a set of symbolic
20 \fIkeys\fR, or \fIcategories\fR. These are used to select and control probes
21 from \fBprex\fR(1). A probe that is enabled for tracing generates a  \fBTNF\fR
22 record, called an \fIevent record\fR. An event record contains two common
23 members and may contain other probe-specific data members.
24 .SS "Common Members"
25 .sp
26 .in +2
27 .nf
28 \fBtnf_probe_event\fR    \fItag\fR
29 \fBtnf_time_delta\fR     \fItime_delta\fR
30 .fi
31 .in -2
33 .sp
34 .ne 2
35 .na
36 \fB\fItag\fR\fR
37 .ad
38 .RS 14n
39 Encodes  \fBTNF\fR references to two other records:
40 .sp
41 .ne 2
42 .na
43 \fB\fItag\fR\fR
44 .ad
45 .RS 12n
46 Describes the layout of the event record.
47 .RE
49 .sp
50 .ne 2
51 .na
52 \fB\fIschedule\fR\fR
53 .ad
54 .RS 12n
55 Identifies the writing thread and also contains a 64-bit base time in
56 nanoseconds.
57 .RE
59 .RE
61 .sp
62 .ne 2
63 .na
64 \fB\fItime_delta\fR\fR
65 .ad
66 .RS 14n
67 A 32-bit time offset from the base time; the sum of the two times is the actual
68 time of the event.
69 .RE
71 .SS "Threads"
72 .SS "\fBthread_create\fR"
73 .sp
74 .in +2
75 .nf
76 \fBtnf_kthread_id\fR    \fItid\fR
77 \fBtnf_pid\fR           \fIpid\fR
78 \fBtnf_symbol\fR        \fIstart_pc\fR
79 .fi
80 .in -2
82 .sp
83 .LP
84 Thread creation event.
85 .sp
86 .ne 2
87 .na
88 \fB\fItid\fR\fR
89 .ad
90 .RS 12n
91 The thread identifier for the new thread.
92 .RE
94 .sp
95 .ne 2
96 .na
97 \fB\fIpid\fR\fR
98 .ad
99 .RS 12n
100 The process identifier for the new thread.
104 .ne 2
106 \fB\fIstart_pc\fR\fR
108 .RS 12n
109 The kernel address of its start routine.
112 .SS "\fBthread_state\fR"
114 .in +2
116 \fBtnf_kthread_id\fR    \fItid\fR
117 \fBtnf_microstate\fR    \fIstate\fR
119 .in -2
123 Thread microstate transition events.
125 .ne 2
127 \fB\fItid\fR\fR
129 .RS 9n
130 Optional; if it is absent, the event is for the writing thread, otherwise the
131 event is for the specified thread.
135 .ne 2
137 \fB\fIstate\fR\fR
139 .RS 9n
140 Indicates the thread state:
141 .RS +4
143 .ie t \(bu
144 .el o
145 Running in user mode.
147 .RS +4
149 .ie t \(bu
150 .el o
151 Running in system mode.
153 .RS +4
155 .ie t \(bu
156 .el o
157 Asleep waiting for a user-mode lock.
159 .RS +4
161 .ie t \(bu
162 .el o
163 Asleep on a kernel object.
165 .RS +4
167 .ie t \(bu
168 .el o
169 Runnable (waiting for a cpu).
171 .RS +4
173 .ie t \(bu
174 .el o
175 Stopped.
177 The values of this member are defined in <\fBsys/msacct.h\fR>. Note that to
178 reduce trace output, transitions between the \fIsystem\fR and \fIuser\fR
179 microstates that are induced by system calls are not traced.  This  information
180 is implicit in the system call entry and exit events.
183 .SS "thread_exit"
186 Thread termination event for writing thread.  This probe has no data members
187 other than the common members.
188 .SS "Scheduling"
191 \fB\fR
192 .SS "thread_queue"
194 .in +2
196 \fBtnf_kthread_id\fR    \fItid\fR
197 \fBtnf_cpuid\fR         \fIcpuid\fR
198 \fBtnf_long\fR          \fIpriority\fR
199 \fBtnf_ulong\fR         \fIqueue_length\fR
201 .in -2
205 Thread scheduling events.  These are triggered when a runnable thread is placed
206 on a dispatch queue.
208 .ne 2
210 \fB\fIcpuid\fR\fR
212 .RS 16n
213 Specifies the cpu to which the queue is attached.
217 .ne 2
219 \fB\fIpriority\fR\fR
221 .RS 16n
222 The (global) dispatch priority of the thread.
226 .ne 2
228 \fB\fIqueue_length\fR\fR
230 .RS 16n
231 The current length of the cpu's dispatch queue.
234 .SS "Blocking"
235 .SS "\fBthread_block\fR"
237 .in +2
239 \fBtnf_opaque\fR     \fIreason\fR
240 \fBtnf_symbols\fR    \fIstack\fR
242 .in -2
246 Thread blockage event.  This probe captures a partial stack backtrace when the
247 current thread blocks.
249 .ne 2
251 \fB\fIreason\fR\fR
253 .RS 11n
254 The address of the object on which the thread is blocking.
258 .ne 2
260 \fB\fIsymbols\fR\fR
262 .RS 11n
263 References a \fBTNF\fR array of kernel addresses representing the PCs on the
264 stack at the time the thread blocks.
267 .SS "System Calls"
268 .SS "\fBsyscall_start\fR"
270 .in +2
272 \fBtnf_sysnum\fR    \fIsysnum\fR
274 .in -2
278 System call entry event.
280 .ne 2
282 \fB\fIsysnum\fR\fR
284 .RS 10n
285 The system call number.  The writing thread implicitly enters the \fIsystem\fR
286 microstate with this event.
289 .SS "\fBsyscall_end\fR"
291 .in +2
293 \fBtnf_long\fR    \fIrval1\fR
294 \fBtnf_long\fR    \fIrval2\fR
295 \fBtnf_long\fR    \fIerrno\fR
297 .in -2
301 System call exit event.
303 .ne 2
305 \fB\fIrval1\fR and \fIrval2\fR\fR
307 .RS 19n
308 The two return values of the system call
312 .ne 2
314 \fB\fIerrno\fR\fR
316 .RS 19n
317 The error return.
322 The writing thread implicitly enters the \fIuser\fR microstate with this event.
323 .SS "Page Faults"
324 .SS "\fBaddress_fault\fR"
326 .in +2
328 \fBtnf_opaque\fR      \fIaddress\fR
329 \fBtnf_fault_type\fR  \fIfault_type\fR
330 \fBtnf_seg_access\fR  \fIaccess\fR
332 .in -2
336 Address-space fault event.
338 .ne 2
340 \fB\fIaddress\fR\fR
342 .RS 14n
343 Gives the faulting virtual address.
347 .ne 2
349 \fB\fIfault_type\fR\fR
351 .RS 14n
352 Gives the fault type: invalid page, protection fault, software requested
353 locking or unlocking.
357 .ne 2
359 \fB\fIaccess\fR\fR
361 .RS 14n
362 Gives the desired access protection: read, write, execute or create. The values
363 for these two members are defined in <\fBvm/seg_enum.h\fR>.
366 .SS "\fBmajor_fault\fR"
368 .in +2
370 \fBtnf_opaque\fR    \fIvnode\fR
371 \fBtnf_offset\fR    \fIoffset\fR
373 .in -2
377 Major page fault event.  The faulting page is mapped to the file given by the
378 \fIvnode\fR member, at the given \fIoffset\fR into the file.  (The faulting
379 virtual address is in the most recent \fBaddress_fault\fR event for the writing
380 thread.)
381 .SS "\fBanon_private\fR"
383 .in +2
385 \fBtnf_opaque\fR    \fIaddress\fR
387 .in -2
391 Copy-on-write page fault event.
393 .ne 2
395 \fB\fIaddress\fR\fR
397 .RS 11n
398 The virtual address at which the new page is mapped.
401 .SS "\fBanon_zero\fR"
403 .in +2
405 \fBtnf_opaque\fR    \fIaddress\fR
407 .in -2
411 Zero-fill page fault event.
413 .ne 2
415 \fB\fIaddress\fR\fR
417 .RS 11n
418 The virtual address at which the new page is mapped.
421 .SS "\fBpage_unmap\fR"
423 .in +2
425 \fBtnf_opaque\fR    \fIvnode\fR
426 \fBtnf_offset\fR    \fIoffset\fR
428 .in -2
432 Page unmapping event.  This probe marks the unmapping of a file system page
433 from the system.
435 .ne 2
437 \fB\fIvnode\fR and \fIoffset\fR\fR
439 .RS 20n
440 Identifies the file and offset of the page being unmapped.
443 .SS "Pageins and Pageouts"
444 .SS "\fBpagein\fR"
446 .in +2
448 \fBtnf_opaque\fR    \fIvnode\fR
449 \fBtnf_offset\fR    \fIoffset\fR
450 \fBtnf_size\fR      \fIsize\fR
452 .in -2
456 Pagein start event.  This event signals the initiation of pagein I/O.
458 .ne 2
460 \fB\fIvnode\fRand\fIoffset\fR\fR
462 .RS 18n
463 Identifyies the file and offset to be paged in.
467 .ne 2
469 \fB\fIsize\fR\fR
471 .RS 18n
472 Specifies the number of bytes to be paged in.
475 .SS "\fBpageout\fR"
477 .in +2
479 \fBtnf_opaque\fR    \fIvnode\fR
480 \fBtnf_ulong\fR     \fIpages_pageout\fR
481 \fBtnf_ulong\fR     \fIpages_freed\fR
482 \fBtnf_ulong\fR     \fIpages_reclaimed\fR
484 .in -2
488 Pageout completion event.  This event signals the completion of pageout I/O.
490 .ne 2
492 \fB\fIvnode\fR\fR
494 .RS 19n
495 Identifies the file of the pageout request.
499 .ne 2
501 \fB\fIpages_pageout\fR\fR
503 .RS 19n
504 The number of pages written out.
508 .ne 2
510 \fB\fIpages_freed\fR\fR
512 .RS 19n
513 The number of pages freed after being written out.
517 .ne 2
519 \fB\fIpages_reclaimed\fR\fR
521 .RS 19n
522 The number of pages reclaimed after being written out.
525 .SS "Page Daemon (Page Stealer)"
526 .SS "\fBpageout_scan_start\fR"
528 .in +2
530 \fBtnf_ulong\fR    \fIpages_free\fR
531 \fBtnf_ulong\fR    \fIpages_needed\fR
533 .in -2
537 Page daemon scan start event.  This event signals the beginning of one
538 iteration of the page daemon.
540 .ne 2
542 \fB\fIpages_free\fR\fR
544 .RS 16n
545 The number of free pages in the system.
549 .ne 2
551 \fB\fIpages_needed\fR\fR
553 .RS 16n
554 The number of pages desired free.
557 .SS "\fBpageout_scan_end\fR"
559 .in +2
561 \fBtnf_ulong\fR    \fIpages_free\fR
562 \fBtnf_ulong\fR    \fIpages_scanned\fR
564 .in -2
568 Page daemon scan end event.  This event signals the end of one iteration of the
569 page daemon.
571 .ne 2
573 \fB\fIpages_free\fR\fR
575 .RS 17n
576 The number of free pages in the system.
580 .ne 2
582 \fB\fIpages_scanned\fR\fR
584 .RS 17n
585 The number of pages examined by the page daemon.  (Potentially more pages will
586 be freed when any queued pageout requests complete.)
589 .SS "Swapper"
590 .SS "\fBswapout_process\fR"
592 .in +2
594 \fBtnf_pid\fR      \fIpid\fR
595 \fBtnf_ulong\fR    \fIpage_count\fR
597 .in -2
601 Address space swapout event.  This event marks the swapping out of a process
602 address space.
604 .ne 2
606 \fB\fIpid\fR\fR
608 .RS 14n
609 Identifies the process.
613 .ne 2
615 \fB\fIpage_count\fR\fR
617 .RS 14n
618 Reports the number of pages either freed or queued for pageout.
621 .SS "\fBswapout_lwp\fR"
623 .in +2
625 \fBtnf_pid\fR         \fIpid\fR
626 \fBtnf_lwpid\fR       \fIlwpid\fR
627 \fBtnf_kthread_id\fR  \fItid\fR
628 \fBtnf_ulong\fR       \fIpage_count\fR
630 .in -2
634 Light-weight process swapout event.  This event marks the swapping out of an
635 \fBLWP\fR and its stack.
637 .ne 2
639 \fB\fIpid\fR\fR
641 .RS 14n
642 The  \fBLWP's\fR process identifier
646 .ne 2
648 \fB\fIlwpid\fR\fR
650 .RS 14n
651 The \fBLWP\fR identifier
655 .ne 2
657 \fB\fItid\fR \fImember\fR\fR
659 .RS 14n
660 The \fBLWP's\fR kernel thread identifier.
664 .ne 2
666 \fB\fIpage_count\fR\fR
668 .RS 14n
669 The number of pages swapped out.
672 .SS "\fBswapin_lwp\fR"
674 .in +2
676 \fBtnf_pid\fR         \fIpid\fR
677 \fBtnf_lwpid\fR       \fIlwpid\fR
678 \fBtnf_kthread_id\fR  \fItid\fR
679 \fBtnf_ulong\fR       \fIpage_count\fR
681 .in -2
685 Light-weight process swapin event.  This event marks the swapping in of an
686 \fBLWP\fR and its stack.
688 .ne 2
690 \fB\fIpid\fR\fR
692 .RS 14n
693 The \fBLWP's\fR process identifier.
697 .ne 2
699 \fB\fIlwpid\fR\fR
701 .RS 14n
702 The \fBLWP\fR identifier.
706 .ne 2
708 \fB\fItid\fR\fR
710 .RS 14n
711 The \fBLWP's\fR kernel thread identifier.
715 .ne 2
717 \fB\fIpage_count\fR\fR
719 .RS 14n
720 The number of pages swapped in.
723 .SS "Local I/O"
724 .SS "\fBstrategy\fR"
726 .in +2
728 \fBtnf_device\fR      \fIdevice\fR
729 \fBtnf_diskaddr\fR    \fIblock\fR
730 \fBtnf_size\fR        \fIsize\fR
731 \fBtnf_opaque\fR      \fIbuf\fR
732 \fBtnf_bioflags\fR   \fI flags\fR
734 .in -2
738 Block I/O strategy event.  This event marks a call to the \fBstrategy\fR(9E)
739 function of a block device driver.
741 .ne 2
743 \fB\fIdevice\fR\fR
745 .RS 10n
746 Contains the major and minor numbers of the device.
750 .ne 2
752 \fB\fIblock\fR\fR
754 .RS 10n
755 The logical block number to be accessed on the device.
759 .ne 2
761 \fB\fIsize\fR\fR
763 .RS 10n
764 The size of the I/O request.
768 .ne 2
770 \fB\fIbuf\fR\fR
772 .RS 10n
773 The kernel address of the \fBbuf\fR(9S) structure associated with the transfer.
777 .ne 2
779 \fB\fIflags\fR\fR
781 .RS 10n
782 The \fBbuf\fR(9S) flags associated with the transfer.
785 .SS "\fBbiodone\fR"
787 .in +2
789 \fBtnf_device\fR     \fIdevice\fR
790 \fBtnf_diskaddr\fR   \fIblock\fR
791 \fBtnf_opaque\fR     \fIbuf\fR
793 .in -2
797 Buffered I/O completion event.  This event marks calls to the \fBbiodone\fR(9F)
798 function.
800 .ne 2
802 \fB\fIdevice\fR\fR
804 .RS 10n
805 Contains the major and minor numbers of the device.
809 .ne 2
811 \fB\fIblock\fR\fR
813 .RS 10n
814 The logical block number accessed on the device.
818 .ne 2
820 \fB\fIbuf\fR\fR
822 .RS 10n
823 The kernel address of the \fBbuf\fR(9S) structure associated with the transfer.
826 .SS "\fBphysio_start\fR"
828 .in +2
830 \fBtnf_device\fR     \fIdevice\fR
831 \fBtnf_offset\fR     \fIoffset\fR
832 \fBtnf_size\fR       \fIsize\fR
833 \fBtnf_bioflags\fR   \fIrw\fR
835 .in -2
839 Raw I/O start event.  This event marks entry into the \fBphysio\fR(9F)
840 fufnction which performs unbuffered I/O.
842 .ne 2
844 \fB\fIdevice\fR\fR
846 .RS 10n
847 Contains the major and minor numbers of the device of the transfer.
851 .ne 2
853 \fB\fIoffset\fR\fR
855 .RS 10n
856 The logical offset on the device for the transfer.
860 .ne 2
862 \fB\fIsize\fR\fR
864 .RS 10n
865 The number of bytes to be transferred.
869 .ne 2
871 \fB\fIrw\fR\fR
873 .RS 10n
874 The direction of the transfer: read or write (see \fBbuf\fR(9S)).
877 .SS "\fBphysio_end\fR"
879 .in +2
881 \fBtnf_device\fR    \fIdevice\fR
883 .in -2
887 Raw I/O end event.  This event marks exit from the \fBphysio\fR(9F) fufnction.
889 .ne 2
891 \fB\fIdevice\fR\fR
893 .RS 10n
894 The major and minor numbers of the device of the transfer.
897 .SH USAGE
900 Use the \fBprex\fR utility to control kernel probes. The standard \fBprex\fR
901 commands to list and manipulate probes are available to you, along with
902 commands to set up and manage kernel tracing.
905 Kernel probes write trace records into a kernel trace buffer. You must copy the
906 buffer into a TNF file for post-processing; use the \fBtnfxtract\fR utility for
907 this.
910 You use the \fBtnfdump\fR utility to examine a kernel trace file. This is
911 exactly the same as examining a user-level trace file.
914 The steps you typically follow to take a kernel trace are:
915 .RS +4
918 Become superuser (\fBsu\fR).
920 .RS +4
923 Allocate a kernel trace buffer of the desired size (\fBprex\fR).
925 .RS +4
928 Select the probes you want to trace and enable (\fBprex\fR).
930 .RS +4
933 Turn kernel tracing on (\fBprex\fR).
935 .RS +4
938 Run your application.
940 .RS +4
943 Turn kernel tracing off (\fBprex\fR).
945 .RS +4
948 Extract the kernel trace buffer (\fBtnfxtract\fR).
950 .RS +4
953 Disable all probes (\fBprex\fR).
955 .RS +4
958 Deallocate the kernel trace buffer (\fBprex\fR).
960 .RS +4
963 Examine the trace file (\fBtnfdump\fR).
967 A convenient way to follow these steps is to use two shell windows; run an
968 interactive \fBprex\fR session in one, and run your application and
969 \fBtnfxtract\fR in the other.
970 .SH SEE ALSO
973 \fBprex\fR(1), \fBtnfdump\fR(1), \fBtnfxtract\fR(1), \fBlibtnfctl\fR(3TNF),
974 \fBTNF_PROBE\fR(3TNF), \fBtracing\fR(3TNF), \fBstrategy\fR(9E),
975 \fBbiodone\fR(9F), \fBphysio\fR(9F), \fBbuf\fR(9S)