2 .\" Man page generated from reStructuredText.
4 .TH "LLVM-BCANALYZER" "1" "2014-01-01" "3.4" "LLVM"
6 llvm-bcanalyzer \- LLVM bitcode analyzer
8 .nr rst2man-indent-level 0
12 level \\n[rst2man-indent-level]
13 level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
20 .\" .rstReportMargin pre:
22 . nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
23 . nr rst2man-indent-level +1
24 .\" .rstReportMargin post:
28 .\" indent \\n[an-margin]
29 .\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
30 .nr rst2man-indent-level -1
31 .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
32 .in \\n[rst2man-indent\\n[rst2man-indent-level]]u
36 \fBllvm\-bcanalyzer\fP [\fIoptions\fP] [\fIfilename\fP]
39 The \fBllvm\-bcanalyzer\fP command is a small utility for analyzing bitcode
40 files. The tool reads a bitcode file (such as generated with the
41 \fBllvm\-as\fP tool) and produces a statistical report on the contents of
42 the bitcode file. The tool can also dump a low level but human readable
43 version of the bitcode file. This tool is probably not of much interest or
44 utility except for those working directly with the bitcode file format. Most
45 LLVM users can just ignore this tool.
47 If \fIfilename\fP is omitted or is \fB\-\fP, then \fBllvm\-bcanalyzer\fP reads its
48 input from standard input. This is useful for combining the tool into a
49 pipeline. Output is written to the standard output.
54 Causes \fBllvm\-bcanalyzer\fP to abbreviate its output by writing out only
55 a module level summary. The details for individual functions are not
61 Causes \fBllvm\-bcanalyzer\fP to dump the bitcode in a human readable
62 format. This format is significantly different from LLVM assembly and
63 provides details about the encoding of the bitcode file.
68 Causes \fBllvm\-bcanalyzer\fP to verify the module produced by reading the
69 bitcode. This ensures that the statistics generated are based on a consistent
75 Print a summary of command line options.
79 If \fBllvm\-bcanalyzer\fP succeeds, it will exit with 0. Otherwise, if an
80 error occurs, it will exit with a non\-zero value, usually 1.
81 .SH SUMMARY OUTPUT DEFINITIONS
83 The following items are always printed by llvm\-bcanalyzer. They comprize the
86 \fBBitcode Analysis Of Module\fP
89 This just provides the name of the module for which bitcode analysis is being
94 \fBBitcode Version Number\fP
97 The bitcode version (not LLVM version) of the file read by the analyzer.
104 The size, in bytes, of the entire bitcode file.
111 The size, in bytes, of the module block. Percentage is relative to File Size.
118 The size, in bytes, of all the function blocks. Percentage is relative to File
123 \fBGlobal Types Bytes\fP
126 The size, in bytes, of the Global Types Pool. Percentage is relative to File
127 Size. This is the size of the definitions of all types in the bitcode file.
131 \fBConstant Pool Bytes\fP
134 The size, in bytes, of the Constant Pool Blocks Percentage is relative to File
139 \fBModule Globals Bytes\fP
142 Ths size, in bytes, of the Global Variable Definitions and their initializers.
143 Percentage is relative to File Size.
147 \fBInstruction List Bytes\fP
150 The size, in bytes, of all the instruction lists in all the functions.
151 Percentage is relative to File Size. Note that this value is also included in
156 \fBCompaction Table Bytes\fP
159 The size, in bytes, of all the compaction tables in all the functions.
160 Percentage is relative to File Size. Note that this value is also included in
165 \fBSymbol Table Bytes\fP
168 The size, in bytes, of all the symbol tables in all the functions. Percentage is
169 relative to File Size. Note that this value is also included in the Function
174 \fBDependent Libraries Bytes\fP
177 The size, in bytes, of the list of dependent libraries in the module. Percentage
178 is relative to File Size. Note that this value is also included in the Module
183 \fBNumber Of Bitcode Blocks\fP
186 The total number of blocks of any kind in the bitcode file.
190 \fBNumber Of Functions\fP
193 The total number of function definitions in the bitcode file.
197 \fBNumber Of Types\fP
200 The total number of types defined in the Global Types Pool.
204 \fBNumber Of Constants\fP
207 The total number of constants (of any type) defined in the Constant Pool.
211 \fBNumber Of Basic Blocks\fP
214 The total number of basic blocks defined in all functions in the bitcode file.
218 \fBNumber Of Instructions\fP
221 The total number of instructions defined in all functions in the bitcode file.
225 \fBNumber Of Long Instructions\fP
228 The total number of long instructions defined in all functions in the bitcode
229 file. Long instructions are those taking greater than 4 bytes. Typically long
230 instructions are GetElementPtr with several indices, PHI nodes, and calls to
231 functions with large numbers of arguments.
235 \fBNumber Of Operands\fP
238 The total number of operands used in all instructions in the bitcode file.
242 \fBNumber Of Compaction Tables\fP
245 The total number of compaction tables in all functions in the bitcode file.
249 \fBNumber Of Symbol Tables\fP
252 The total number of symbol tables in all functions in the bitcode file.
256 \fBNumber Of Dependent Libs\fP
259 The total number of dependent libraries found in the bitcode file.
263 \fBTotal Instruction Size\fP
266 The total size of the instructions in all functions in the bitcode file.
270 \fBAverage Instruction Size\fP
273 The average number of bytes per instruction across all functions in the bitcode
274 file. This value is computed by dividing Total Instruction Size by Number Of
279 \fBMaximum Type Slot Number\fP
282 The maximum value used for a type\(aqs slot number. Larger slot number values take
283 more bytes to encode.
287 \fBMaximum Value Slot Number\fP
290 The maximum value used for a value\(aqs slot number. Larger slot number values take
291 more bytes to encode.
295 \fBBytes Per Value\fP
298 The average size of a Value definition (of any type). This is computed by
299 dividing File Size by the total number of values of any type.
303 \fBBytes Per Global\fP
306 The average size of a global definition (constants and global variables).
310 \fBBytes Per Function\fP
313 The average number of bytes per function definition. This is computed by
314 dividing Function Bytes by Number Of Functions.
318 \fB# of VBR 32\-bit Integers\fP
321 The total number of 32\-bit integers encoded using the Variable Bit Rate
326 \fB# of VBR 64\-bit Integers\fP
329 The total number of 64\-bit integers encoded using the Variable Bit Rate encoding
334 \fB# of VBR Compressed Bytes\fP
337 The total number of bytes consumed by the 32\-bit and 64\-bit integers that use
338 the Variable Bit Rate encoding scheme.
342 \fB# of VBR Expanded Bytes\fP
345 The total number of bytes that would have been consumed by the 32\-bit and 64\-bit
346 integers had they not been compressed with the Variable Bit Rage encoding
351 \fBBytes Saved With VBR\fP
354 The total number of bytes saved by using the Variable Bit Rate encoding scheme.
355 The percentage is relative to # of VBR Expanded Bytes.
358 .SH DETAILED OUTPUT DEFINITIONS
360 The following definitions occur only if the \-nodetails option was not given.
361 The detailed output provides additional information on a per\-function basis.
366 The type signature of the function.
373 The total number of bytes in the function\(aqs block.
380 The number of basic blocks defined by the function.
387 The number of instructions defined by the function.
391 \fBLong Instructions\fP
394 The number of instructions using the long instruction format in the function.
401 The number of operands used by all instructions in the function.
405 \fBInstruction Size\fP
408 The number of bytes consumed by instructions in the function.
412 \fBAverage Instruction Size\fP
415 The average number of bytes consumed by the instructions in the function.
416 This value is computed by dividing Instruction Size by Instructions.
420 \fBBytes Per Instruction\fP
423 The average number of bytes used by the function per instruction. This value
424 is computed by dividing Byte Size by Instructions. Note that this is not the
425 same as Average Instruction Size. It computes a number relative to the total
426 function size not just the size of the instruction list.
430 \fBNumber of VBR 32\-bit Integers\fP
433 The total number of 32\-bit integers found in this function (for any use).
437 \fBNumber of VBR 64\-bit Integers\fP
440 The total number of 64\-bit integers found in this function (for any use).
444 \fBNumber of VBR Compressed Bytes\fP
447 The total number of bytes in this function consumed by the 32\-bit and 64\-bit
448 integers that use the Variable Bit Rate encoding scheme.
452 \fBNumber of VBR Expanded Bytes\fP
455 The total number of bytes in this function that would have been consumed by
456 the 32\-bit and 64\-bit integers had they not been compressed with the Variable
457 Bit Rate encoding scheme.
461 \fBBytes Saved With VBR\fP
464 The total number of bytes saved in this function by using the Variable Bit
465 Rate encoding scheme. The percentage is relative to # of VBR Expanded Bytes.
470 \fB/CommandGuide/llvm\-dis\fP, \fB/BitCodeFormat\fP
472 Maintained by The LLVM Team (http://llvm.org/).
474 2003-2013, LLVM Project
475 .\" Generated by docutils manpage writer.