1 .TH BOOTGRAPH 8 1 .TH BOOTGRAPH 8
2 .SH NAME 2 .SH NAME
3 bootgraph \- Kernel boot timing analysis 3 bootgraph \- Kernel boot timing analysis
4 .SH SYNOPSIS 4 .SH SYNOPSIS
5 .ft B 5 .ft B
6 .B bootgraph 6 .B bootgraph
7 .RB [ OPTIONS ] 7 .RB [ OPTIONS ]
8 .RB [ COMMAND ] 8 .RB [ COMMAND ]
9 .SH DESCRIPTION 9 .SH DESCRIPTION
10 \fBbootgraph \fP reads the dmesg log from kern 10 \fBbootgraph \fP reads the dmesg log from kernel boot and
11 creates an html representation of the initcall !! 11 creates an html representation of the initcall timeline up to the start
12 every module init call found, through both ker !! 12 of the init process.
13 timeline is split into two phases: kernel mode <<
14 represents a single process run on a single cp <<
15 Once user mode begins, the init process is cal <<
16 start working in parallel. <<
17 .PP 13 .PP
18 If no specific command is given, the tool read 14 If no specific command is given, the tool reads the current dmesg log and
19 outputs a new timeline. !! 15 outputs bootgraph.html.
20 .PP 16 .PP
21 The tool can also augment the timeline with ft 17 The tool can also augment the timeline with ftrace data on custom target
22 functions as well as full trace callgraphs. 18 functions as well as full trace callgraphs.
23 .PP <<
24 Generates output files in subdirectory: boot-y <<
25 html timeline : <hostname>_boot.html <<
26 raw dmesg file : <hostname>_boot_dmesg <<
27 raw ftrace file : <hostname>_boot_ftrac <<
28 .SH OPTIONS 19 .SH OPTIONS
29 .TP 20 .TP
30 \fB-h\fR 21 \fB-h\fR
31 Print this help text 22 Print this help text
32 .TP 23 .TP
33 \fB-v\fR 24 \fB-v\fR
34 Print the current tool version 25 Print the current tool version
35 .TP 26 .TP
36 \fB-addlogs\fR 27 \fB-addlogs\fR
37 Add the dmesg log to the html output. It will 28 Add the dmesg log to the html output. It will be viewable by
38 clicking a button in the timeline. 29 clicking a button in the timeline.
39 .TP 30 .TP
40 \fB-result \fIfile\fR !! 31 \fB-o \fIfile\fR
41 Export a results table to a text file for pars !! 32 Override the HTML output filename (default: bootgraph.html)
>> 33 .SS "Ftrace Debug"
42 .TP 34 .TP
43 \fB-o \fIname\fR !! 35 \fB-f\fR
44 Overrides the output subdirectory name when ru !! 36 Use ftrace to add function detail (default: disabled)
45 Use {date}, {time}, {hostname} for current val <<
46 .sp <<
47 e.g. boot-{hostname}-{date}-{time} <<
48 .SS "advanced" <<
49 .TP 37 .TP
50 \fB-f or -callgraph\fR !! 38 \fB-callgraph\fR
51 Use ftrace to create initcall callgraphs (defa !! 39 Use ftrace to create initcall callgraphs (default: disabled). If -filter
52 is not used there will be one callgraph per in 40 is not used there will be one callgraph per initcall. This can produce
53 very large outputs, i.e. 10MB - 100MB. 41 very large outputs, i.e. 10MB - 100MB.
54 .TP 42 .TP
55 \fB-fstat\fR <<
56 Use ftrace to add function detail (default: di <<
57 .TP <<
58 \fB-maxdepth \fIlevel\fR 43 \fB-maxdepth \fIlevel\fR
59 limit the callgraph trace depth to \fIlevel\fR 44 limit the callgraph trace depth to \fIlevel\fR (default: 2). This is
60 the best way to limit the output size when usi 45 the best way to limit the output size when using -callgraph.
61 .TP 46 .TP
62 \fB-mincg \fIt\fR 47 \fB-mincg \fIt\fR
63 Discard all callgraphs shorter than \fIt\fR mi 48 Discard all callgraphs shorter than \fIt\fR milliseconds (default: 0=all).
64 This reduces the html file size as there can b 49 This reduces the html file size as there can be many tiny callgraphs
65 which are barely visible in the timeline. 50 which are barely visible in the timeline.
66 The value is a float: e.g. 0.001 represents 1 51 The value is a float: e.g. 0.001 represents 1 us.
67 .TP 52 .TP
68 \fB-cgfilter \fI"func1,func2,..."\fR <<
69 Reduce callgraph output in the timeline by lim <<
70 argument can be a single function name or a co <<
71 (default: none) <<
72 .TP <<
73 \fB-cgskip \fIfile\fR <<
74 Reduce callgraph output in the timeline by ski <<
75 functions in the trace, e.g. printk or console <<
76 in this file will show up as empty leaves in t <<
77 times displayed. <<
78 (default: none) <<
79 .TP <<
80 \fB-timeprec \fIn\fR 53 \fB-timeprec \fIn\fR
81 Number of significant digits in timestamps (0: 54 Number of significant digits in timestamps (0:S, 3:ms, [6:us])
82 .TP 55 .TP
83 \fB-expandcg\fR 56 \fB-expandcg\fR
84 pre-expand the callgraph data in the html outp 57 pre-expand the callgraph data in the html output (default: disabled)
85 .TP 58 .TP
86 \fB-func \fI"func1,func2,..."\fR !! 59 \fB-filter \fI"func1,func2,..."\fR
87 Instead of tracing each initcall, trace a cust 60 Instead of tracing each initcall, trace a custom list of functions (default: do_one_initcall)
>> 61
>> 62 .SH COMMANDS
88 .TP 63 .TP
89 \fB-reboot\fR 64 \fB-reboot\fR
90 Reboot the machine and generate a new timeline 65 Reboot the machine and generate a new timeline automatically. Works in 4 steps.
91 1. updates grub with the required kernel par 66 1. updates grub with the required kernel parameters
92 2. installs a cron job which re-runs the too 67 2. installs a cron job which re-runs the tool after reboot
93 3. reboots the system 68 3. reboots the system
94 4. after startup, extracts the data and gene 69 4. after startup, extracts the data and generates the timeline
95 .TP 70 .TP
96 \fB-manual\fR 71 \fB-manual\fR
97 Show the requirements to generate a new timeli 72 Show the requirements to generate a new timeline manually. Requires 3 steps.
98 1. append the string to the kernel command l 73 1. append the string to the kernel command line via your native boot manager.
99 2. reboot the system 74 2. reboot the system
100 3. after startup, re-run the tool with the s 75 3. after startup, re-run the tool with the same arguments and no command
101 <<
102 .SH COMMANDS <<
103 .SS "rebuild" <<
104 .TP 76 .TP
105 \fB-dmesg \fIfile\fR 77 \fB-dmesg \fIfile\fR
106 Create HTML output from an existing dmesg file 78 Create HTML output from an existing dmesg file.
107 .TP 79 .TP
108 \fB-ftrace \fIfile\fR 80 \fB-ftrace \fIfile\fR
109 Create HTML output from an existing ftrace fil 81 Create HTML output from an existing ftrace file (used with -dmesg).
110 .SS "other" <<
111 .TP 82 .TP
112 \fB-flistall\fR 83 \fB-flistall\fR
113 Print all ftrace functions capable of being ca 84 Print all ftrace functions capable of being captured. These are all the
114 possible values you can add to trace via the - !! 85 possible values you can add to trace via the -filter argument.
115 .TP <<
116 \fB-sysinfo\fR <<
117 Print out system info extracted from BIOS. Rea <<
118 86
119 .SH EXAMPLES 87 .SH EXAMPLES
120 Create a timeline using the current dmesg log. 88 Create a timeline using the current dmesg log.
121 .IP 89 .IP
122 \f(CW$ bootgraph\fR 90 \f(CW$ bootgraph\fR
123 .PP 91 .PP
124 Create a timeline using the current dmesg and 92 Create a timeline using the current dmesg and ftrace log.
125 .IP 93 .IP
126 \f(CW$ bootgraph -callgraph\fR 94 \f(CW$ bootgraph -callgraph\fR
127 .PP 95 .PP
128 Create a timeline using the current dmesg, add !! 96 Create a timeline using the current dmesg, add the log to the html and change the name.
129 .IP 97 .IP
130 \f(CW$ bootgraph -addlogs -o "myboot-{date}-{t !! 98 \f(CW$ bootgraph -addlogs -o myboot.html\fR
131 .PP 99 .PP
132 Capture a new boot timeline by automatically r 100 Capture a new boot timeline by automatically rebooting the machine.
133 .IP 101 .IP
134 \f(CW$ sudo bootgraph -reboot -addlogs -o "lat !! 102 \f(CW$ sudo bootgraph -reboot -addlogs -o latestboot.html\fR
135 .PP 103 .PP
136 Capture a new boot timeline with function trac 104 Capture a new boot timeline with function trace data.
137 .IP 105 .IP
138 \f(CW$ sudo bootgraph -reboot -f\fR 106 \f(CW$ sudo bootgraph -reboot -f\fR
139 .PP 107 .PP
140 Capture a new boot timeline with trace & callg 108 Capture a new boot timeline with trace & callgraph data. Skip callgraphs smaller than 5ms.
141 .IP 109 .IP
142 \f(CW$ sudo bootgraph -reboot -callgraph -minc 110 \f(CW$ sudo bootgraph -reboot -callgraph -mincg 5\fR
143 .PP 111 .PP
144 Capture a new boot timeline with callgraph dat 112 Capture a new boot timeline with callgraph data over custom functions.
145 .IP 113 .IP
146 \f(CW$ sudo bootgraph -reboot -callgraph -func !! 114 \f(CW$ sudo bootgraph -reboot -callgraph -filter "acpi_ps_parse_aml,msleep"\fR
147 .PP 115 .PP
148 Capture a brand new boot timeline with manual 116 Capture a brand new boot timeline with manual reboot.
149 .IP 117 .IP
150 \f(CW$ sudo bootgraph -callgraph -manual\fR 118 \f(CW$ sudo bootgraph -callgraph -manual\fR
151 .IP 119 .IP
152 \f(CW$ vi /etc/default/grub # add the CMD 120 \f(CW$ vi /etc/default/grub # add the CMDLINE string to your kernel params\fR
153 .IP 121 .IP
154 \f(CW$ sudo reboot # reboot the 122 \f(CW$ sudo reboot # reboot the machine\fR
155 .IP 123 .IP
156 \f(CW$ sudo bootgraph -callgraph # re-run the 124 \f(CW$ sudo bootgraph -callgraph # re-run the tool after restart\fR
157 .PP 125 .PP
158 .SS "rebuild timeline from logs" <<
159 .PP <<
160 Rebuild the html from a previous run's logs, u <<
161 .IP <<
162 \f(CW$ bootgraph -dmesg dmesg.txt -ftrace ftra <<
163 .PP <<
164 Rebuild the html with different options. <<
165 .IP <<
166 \f(CW$ bootgraph -dmesg dmesg.txt -ftrace ftra <<
167 126
168 .SH "SEE ALSO" 127 .SH "SEE ALSO"
169 dmesg(1), update-grub(8), crontab(1), reboot(8 128 dmesg(1), update-grub(8), crontab(1), reboot(8)
170 .PP 129 .PP
171 .SH AUTHOR 130 .SH AUTHOR
172 .nf 131 .nf
173 Written by Todd Brandt <todd.e.brandt@linux.int 132 Written by Todd Brandt <todd.e.brandt@linux.intel.com>
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.