|
1 .\" Man page generated from reStructuredText. |
|
2 . |
|
3 .TH "LLVM-PROFDATA" "1" "2016-07-10" "3.8" "LLVM" |
|
4 .SH NAME |
|
5 llvm-profdata \- Profile data tool |
|
6 . |
|
7 .nr rst2man-indent-level 0 |
|
8 . |
|
9 .de1 rstReportMargin |
|
10 \\$1 \\n[an-margin] |
|
11 level \\n[rst2man-indent-level] |
|
12 level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] |
|
13 - |
|
14 \\n[rst2man-indent0] |
|
15 \\n[rst2man-indent1] |
|
16 \\n[rst2man-indent2] |
|
17 .. |
|
18 .de1 INDENT |
|
19 .\" .rstReportMargin pre: |
|
20 . RS \\$1 |
|
21 . nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] |
|
22 . nr rst2man-indent-level +1 |
|
23 .\" .rstReportMargin post: |
|
24 .. |
|
25 .de UNINDENT |
|
26 . RE |
|
27 .\" indent \\n[an-margin] |
|
28 .\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] |
|
29 .nr rst2man-indent-level -1 |
|
30 .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] |
|
31 .in \\n[rst2man-indent\\n[rst2man-indent-level]]u |
|
32 .. |
|
33 .SH SYNOPSIS |
|
34 .sp |
|
35 \fBllvm\-profdata\fP \fIcommand\fP [\fIargs...\fP] |
|
36 .SH DESCRIPTION |
|
37 .sp |
|
38 The \fBllvm\-profdata\fP tool is a small utility for working with profile |
|
39 data files. |
|
40 .SH COMMANDS |
|
41 .INDENT 0.0 |
|
42 .IP \(bu 2 |
|
43 \fI\%merge\fP |
|
44 .IP \(bu 2 |
|
45 \fI\%show\fP |
|
46 .UNINDENT |
|
47 .SH MERGE |
|
48 .SS SYNOPSIS |
|
49 .sp |
|
50 \fBllvm\-profdata merge\fP [\fIoptions\fP] [\fIfilename...\fP] |
|
51 .SS DESCRIPTION |
|
52 .sp |
|
53 \fBllvm\-profdata merge\fP takes several profile data files |
|
54 generated by PGO instrumentation and merges them together into a single |
|
55 indexed profile data file. |
|
56 .sp |
|
57 By default profile data is merged without modification. This means that the |
|
58 relative importance of each input file is proportional to the number of samples |
|
59 or counts it contains. In general, the input from a longer training run will be |
|
60 interpreted as relatively more important than a shorter run. Depending on the |
|
61 nature of the training runs it may be useful to adjust the weight given to each |
|
62 input file by using the \fB\-weighted\-input\fP option. |
|
63 .SS OPTIONS |
|
64 .INDENT 0.0 |
|
65 .TP |
|
66 .B \-help |
|
67 Print a summary of command line options. |
|
68 .UNINDENT |
|
69 .INDENT 0.0 |
|
70 .TP |
|
71 .B \-output=output, \-o=output |
|
72 Specify the output file name. \fIOutput\fP cannot be \fB\-\fP as the resulting |
|
73 indexed profile data can\(aqt be written to standard output. |
|
74 .UNINDENT |
|
75 .INDENT 0.0 |
|
76 .TP |
|
77 .B \-weighted\-input=weight,filename |
|
78 Specify an input file name along with a weight. The profile counts of the input |
|
79 file will be scaled (multiplied) by the supplied \fBweight\fP, where where \fBweight\fP |
|
80 is a decimal integer >= 1. Input files specified without using this option are |
|
81 assigned a default weight of 1. Examples are shown below. |
|
82 .UNINDENT |
|
83 .INDENT 0.0 |
|
84 .TP |
|
85 .B \-instr (default) |
|
86 Specify that the input profile is an instrumentation\-based profile. |
|
87 .UNINDENT |
|
88 .INDENT 0.0 |
|
89 .TP |
|
90 .B \-sample |
|
91 Specify that the input profile is a sample\-based profile. |
|
92 .sp |
|
93 The format of the generated file can be generated in one of three ways: |
|
94 .INDENT 7.0 |
|
95 .TP |
|
96 .B \-binary (default) |
|
97 .UNINDENT |
|
98 .sp |
|
99 Emit the profile using a binary encoding. For instrumentation\-based profile |
|
100 the output format is the indexed binary format. |
|
101 .INDENT 7.0 |
|
102 .TP |
|
103 .B \-text |
|
104 .UNINDENT |
|
105 .sp |
|
106 Emit the profile in text mode. This option can also be used with both |
|
107 sample\-based and instrumentation\-based profile. When this option is used |
|
108 the profile will be dumped in the text format that is parsable by the profile |
|
109 reader. |
|
110 .INDENT 7.0 |
|
111 .TP |
|
112 .B \-gcc |
|
113 .UNINDENT |
|
114 .sp |
|
115 Emit the profile using GCC\(aqs gcov format (Not yet supported). |
|
116 .UNINDENT |
|
117 .SS EXAMPLES |
|
118 .SS Basic Usage |
|
119 .sp |
|
120 Merge three profiles: |
|
121 .INDENT 0.0 |
|
122 .INDENT 3.5 |
|
123 .sp |
|
124 .nf |
|
125 .ft C |
|
126 llvm\-profdata merge foo.profdata bar.profdata baz.profdata \-output merged.profdata |
|
127 .ft P |
|
128 .fi |
|
129 .UNINDENT |
|
130 .UNINDENT |
|
131 .SS Weighted Input |
|
132 .sp |
|
133 The input file \fIfoo.profdata\fP is especially important, multiply its counts by 10: |
|
134 .INDENT 0.0 |
|
135 .INDENT 3.5 |
|
136 .sp |
|
137 .nf |
|
138 .ft C |
|
139 llvm\-profdata merge \-weighted\-input=10,foo.profdata bar.profdata baz.profdata \-output merged.profdata |
|
140 .ft P |
|
141 .fi |
|
142 .UNINDENT |
|
143 .UNINDENT |
|
144 .sp |
|
145 Exactly equivalent to the previous invocation (explicit form; useful for programmatic invocation): |
|
146 .INDENT 0.0 |
|
147 .INDENT 3.5 |
|
148 .sp |
|
149 .nf |
|
150 .ft C |
|
151 llvm\-profdata merge \-weighted\-input=10,foo.profdata \-weighted\-input=1,bar.profdata \-weighted\-input=1,baz.profdata \-output merged.profdata |
|
152 .ft P |
|
153 .fi |
|
154 .UNINDENT |
|
155 .UNINDENT |
|
156 .SH SHOW |
|
157 .SS SYNOPSIS |
|
158 .sp |
|
159 \fBllvm\-profdata show\fP [\fIoptions\fP] [\fIfilename\fP] |
|
160 .SS DESCRIPTION |
|
161 .sp |
|
162 \fBllvm\-profdata show\fP takes a profile data file and displays the |
|
163 information about the profile counters for this file and |
|
164 for any of the specified function(s). |
|
165 .sp |
|
166 If \fIfilename\fP is omitted or is \fB\-\fP, then \fBllvm\-profdata show\fP reads its |
|
167 input from standard input. |
|
168 .SS OPTIONS |
|
169 .INDENT 0.0 |
|
170 .TP |
|
171 .B \-all\-functions |
|
172 Print details for every function. |
|
173 .UNINDENT |
|
174 .INDENT 0.0 |
|
175 .TP |
|
176 .B \-counts |
|
177 Print the counter values for the displayed functions. |
|
178 .UNINDENT |
|
179 .INDENT 0.0 |
|
180 .TP |
|
181 .B \-function=string |
|
182 Print details for a function if the function\(aqs name contains the given string. |
|
183 .UNINDENT |
|
184 .INDENT 0.0 |
|
185 .TP |
|
186 .B \-help |
|
187 Print a summary of command line options. |
|
188 .UNINDENT |
|
189 .INDENT 0.0 |
|
190 .TP |
|
191 .B \-output=output, \-o=output |
|
192 Specify the output file name. If \fIoutput\fP is \fB\-\fP or it isn\(aqt specified, |
|
193 then the output is sent to standard output. |
|
194 .UNINDENT |
|
195 .INDENT 0.0 |
|
196 .TP |
|
197 .B \-instr (default) |
|
198 Specify that the input profile is an instrumentation\-based profile. |
|
199 .UNINDENT |
|
200 .INDENT 0.0 |
|
201 .TP |
|
202 .B \-text |
|
203 Instruct the profile dumper to show profile counts in the text format of the |
|
204 instrumentation\-based profile data representation. By default, the profile |
|
205 information is dumped in a more human readable form (also in text) with |
|
206 annotations. |
|
207 .UNINDENT |
|
208 .INDENT 0.0 |
|
209 .TP |
|
210 .B \-sample |
|
211 Specify that the input profile is a sample\-based profile. |
|
212 .UNINDENT |
|
213 .SH EXIT STATUS |
|
214 .sp |
|
215 \fBllvm\-profdata\fP returns 1 if the command is omitted or is invalid, |
|
216 if it cannot read input files, or if there is a mismatch between their data. |
|
217 .SH AUTHOR |
|
218 Maintained by The LLVM Team (http://llvm.org/). |
|
219 .SH COPYRIGHT |
|
220 2003-2016, LLVM Project |
|
221 .\" Generated by docutils manpage writer. |
|
222 . |