]> CyberLeo.Net >> Repos - FreeBSD/stable/10.git/blob - cddl/contrib/dtracetoolkit/Man/man1m/dappprof.1m
Copy head (r256279) to stable/10 as part of the 10.0-RELEASE cycle.
[FreeBSD/stable/10.git] / cddl / contrib / dtracetoolkit / Man / man1m / dappprof.1m
1 .TH dappprof 1m  "$Date:: 2007-08-05 #$" "USER COMMANDS"
2 .SH NAME
3 dappprof \- profile user and lib function usage. Uses DTrace.
4 .SH SYNOPSIS
5 .B dappprof
6 [\-acehoTU] [\-u lib] { \-p PID | command }
7 .SH DESCRIPTION
8 dappprof prints details on user and library call times for processes
9 as a summary style aggragation. By default the user fuctions are
10 traced, options can be used to trace library activity. Output can
11 include function counts, elapsed times and on cpu times.
12
13 The elapsed times are interesting, to help identify functions
14 that take some time to complete (during which the process may
15 have slept). CPU time helps us identify syscalls that
16 are consuming CPU cycles to run.
17
18 Since this uses DTrace, only the root user or users with the
19 dtrace_kernel privilege can run this command.
20 .SH OS
21 Solaris
22 .SH STABILITY
23 stable - needs the pid provider.
24 .SH OPTIONS
25 .TP
26 \-a
27 print all data
28 .TP
29 \-c
30 print function counts
31 .TP
32 \-e
33 print elapsed times, ns
34 .TP
35 \-o
36 print CPU times, ns
37 .TP
38 \-T
39 print totals
40 .TP
41 \-p PID
42 examine this PID
43 .TP
44 \-u lib
45 trace this library instead
46 .TP
47 \-U
48 trace all library and user functions
49 .PP
50 .SH EXAMPLES
51 .TP
52 run and examine the "df \-h" command,
53
54 .B dappprof
55 df \-h
56 .PP
57 .TP
58 print elapsed times, on-cpu times and counts for "df \-h",
59 #
60 .B dappprof
61 -ceo df \-h
62 .TP
63 print elapsed times for PID 1871,
64
65 .B dappprof
66 \-p 1871
67 .PP
68 .TP
69 print all data for PID 1871,
70 #
71 .B dappprof
72 \-ap 1871
73 .PP
74 .SH FIELDS
75 .TP
76 CALL
77 Function call name
78 .TP
79 ELAPSED
80 Total elapsed time, nanoseconds
81 .TP
82 CPU
83 Total on-cpu time, nanoseconds
84 .TP
85 COUNT
86 Number of occurrences
87 .SH DOCUMENTATION
88 See the DTraceToolkit for further documentation under the 
89 Docs directory. The DTraceToolkit docs may include full worked
90 examples with verbose descriptions explaining the output.
91 .SH EXIT
92 dappprof will sample until Ctrl\-C is hit. 
93 .SH AUTHOR
94 Brendan Gregg
95 [Sydney, Australia]
96 .SH SEE ALSO
97 dapptrace(1M), dtrace(1M), apptrace(1)
98