$FreeBSD$
Man page generated from reStructuredText.
. llvm-bcanalyzer - LLVM bitcode analyzer . .nr rst2man-indent-level 0 . \\$1 \\n[an-margin] level \\n[rst2man-indent-level] level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] - \\n[rst2man-indent0] \\n[rst2man-indent1] \\n[rst2man-indent2] .. .rstReportMargin pre:
. RS \\$1 . nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] . nr rst2man-indent-level +1 .rstReportMargin post:
.. . RE indent \\n[an-margin]
old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1 new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.. llvm-bcanalyzer [options] [filename] The llvm-bcanalyzer command is a small utility for analyzing bitcode files. The tool reads a bitcode file (such as generated with the llvm-as tool) and produces a statistical report on the contents of the bitcode file. The tool can also dump a low level but human readable version of the bitcode file. This tool is probably not of much interest or utility except for those working directly with the bitcode file format. Most LLVM users can just ignore this tool. If filename is omitted or is -, then llvm-bcanalyzer reads its input from standard input. This is useful for combining the tool into a pipeline. Output is written to the standard output. NDENT 0.0

-nodetails Causes llvm-bcanalyzer to abbreviate its output by writing out only a module level summary. The details for individual functions are not displayed. NINDENT NDENT 0.0

-dump Causes llvm-bcanalyzer to dump the bitcode in a human readable format. This format is significantly different from LLVM assembly and provides details about the encoding of the bitcode file. NINDENT NDENT 0.0

-verify Causes llvm-bcanalyzer to verify the module produced by reading the bitcode. This ensures that the statistics generated are based on a consistent module. NINDENT NDENT 0.0

-help Print a summary of command line options. NINDENT

If llvm-bcanalyzer succeeds, it will exit with 0. Otherwise, if an error occurs, it will exit with a non-zero value, usually 1. The following items are always printed by llvm-bcanalyzer. They comprize the summary output. Bitcode Analysis Of Module NDENT 0.0 NDENT 3.5 This just provides the name of the module for which bitcode analysis is being generated. NINDENT NINDENT Bitcode Version Number NDENT 0.0 NDENT 3.5 The bitcode version (not LLVM version) of the file read by the analyzer. NINDENT NINDENT File Size NDENT 0.0 NDENT 3.5 The size, in bytes, of the entire bitcode file. NINDENT NINDENT Module Bytes NDENT 0.0 NDENT 3.5 The size, in bytes, of the module block. Percentage is relative to File Size. NINDENT NINDENT Function Bytes NDENT 0.0 NDENT 3.5 The size, in bytes, of all the function blocks. Percentage is relative to File Size. NINDENT NINDENT Global Types Bytes NDENT 0.0 NDENT 3.5 The size, in bytes, of the Global Types Pool. Percentage is relative to File Size. This is the size of the definitions of all types in the bitcode file. NINDENT NINDENT Constant Pool Bytes NDENT 0.0 NDENT 3.5 The size, in bytes, of the Constant Pool Blocks Percentage is relative to File Size. NINDENT NINDENT Module Globals Bytes NDENT 0.0 NDENT 3.5 Ths size, in bytes, of the Global Variable Definitions and their initializers. Percentage is relative to File Size. NINDENT NINDENT Instruction List Bytes NDENT 0.0 NDENT 3.5 The size, in bytes, of all the instruction lists in all the functions. Percentage is relative to File Size. Note that this value is also included in the Function Bytes. NINDENT NINDENT Compaction Table Bytes NDENT 0.0 NDENT 3.5 The size, in bytes, of all the compaction tables in all the functions. Percentage is relative to File Size. Note that this value is also included in the Function Bytes. NINDENT NINDENT Symbol Table Bytes NDENT 0.0 NDENT 3.5 The size, in bytes, of all the symbol tables in all the functions. Percentage is relative to File Size. Note that this value is also included in the Function Bytes. NINDENT NINDENT Dependent Libraries Bytes NDENT 0.0 NDENT 3.5 The size, in bytes, of the list of dependent libraries in the module. Percentage is relative to File Size. Note that this value is also included in the Module Global Bytes. NINDENT NINDENT Number Of Bitcode Blocks NDENT 0.0 NDENT 3.5 The total number of blocks of any kind in the bitcode file. NINDENT NINDENT Number Of Functions NDENT 0.0 NDENT 3.5 The total number of function definitions in the bitcode file. NINDENT NINDENT Number Of Types NDENT 0.0 NDENT 3.5 The total number of types defined in the Global Types Pool. NINDENT NINDENT Number Of Constants NDENT 0.0 NDENT 3.5 The total number of constants (of any type) defined in the Constant Pool. NINDENT NINDENT Number Of Basic Blocks NDENT 0.0 NDENT 3.5 The total number of basic blocks defined in all functions in the bitcode file. NINDENT NINDENT Number Of Instructions NDENT 0.0 NDENT 3.5 The total number of instructions defined in all functions in the bitcode file. NINDENT NINDENT Number Of Long Instructions NDENT 0.0 NDENT 3.5 The total number of long instructions defined in all functions in the bitcode file. Long instructions are those taking greater than 4 bytes. Typically long instructions are GetElementPtr with several indices, PHI nodes, and calls to functions with large numbers of arguments. NINDENT NINDENT Number Of Operands NDENT 0.0 NDENT 3.5 The total number of operands used in all instructions in the bitcode file. NINDENT NINDENT Number Of Compaction Tables NDENT 0.0 NDENT 3.5 The total number of compaction tables in all functions in the bitcode file. NINDENT NINDENT Number Of Symbol Tables NDENT 0.0 NDENT 3.5 The total number of symbol tables in all functions in the bitcode file. NINDENT NINDENT Number Of Dependent Libs NDENT 0.0 NDENT 3.5 The total number of dependent libraries found in the bitcode file. NINDENT NINDENT Total Instruction Size NDENT 0.0 NDENT 3.5 The total size of the instructions in all functions in the bitcode file. NINDENT NINDENT Average Instruction Size NDENT 0.0 NDENT 3.5 The average number of bytes per instruction across all functions in the bitcode file. This value is computed by dividing Total Instruction Size by Number Of Instructions. NINDENT NINDENT Maximum Type Slot Number NDENT 0.0 NDENT 3.5 The maximum value used for a type\(aqs slot number. Larger slot number values take more bytes to encode. NINDENT NINDENT Maximum Value Slot Number NDENT 0.0 NDENT 3.5 The maximum value used for a value\(aqs slot number. Larger slot number values take more bytes to encode. NINDENT NINDENT Bytes Per Value NDENT 0.0 NDENT 3.5 The average size of a Value definition (of any type). This is computed by dividing File Size by the total number of values of any type. NINDENT NINDENT Bytes Per Global NDENT 0.0 NDENT 3.5 The average size of a global definition (constants and global variables). NINDENT NINDENT Bytes Per Function NDENT 0.0 NDENT 3.5 The average number of bytes per function definition. This is computed by dividing Function Bytes by Number Of Functions. NINDENT NINDENT # of VBR 32-bit Integers NDENT 0.0 NDENT 3.5 The total number of 32-bit integers encoded using the Variable Bit Rate encoding scheme. NINDENT NINDENT # of VBR 64-bit Integers NDENT 0.0 NDENT 3.5 The total number of 64-bit integers encoded using the Variable Bit Rate encoding scheme. NINDENT NINDENT # of VBR Compressed Bytes NDENT 0.0 NDENT 3.5 The total number of bytes consumed by the 32-bit and 64-bit integers that use the Variable Bit Rate encoding scheme. NINDENT NINDENT # of VBR Expanded Bytes NDENT 0.0 NDENT 3.5 The total number of bytes that would have been consumed by the 32-bit and 64-bit integers had they not been compressed with the Variable Bit Rage encoding scheme. NINDENT NINDENT Bytes Saved With VBR NDENT 0.0 NDENT 3.5 The total number of bytes saved by using the Variable Bit Rate encoding scheme. The percentage is relative to # of VBR Expanded Bytes. NINDENT NINDENT The following definitions occur only if the -nodetails option was not given. The detailed output provides additional information on a per-function basis. Type NDENT 0.0 NDENT 3.5 The type signature of the function. NINDENT NINDENT Byte Size NDENT 0.0 NDENT 3.5 The total number of bytes in the function\(aqs block. NINDENT NINDENT Basic Blocks NDENT 0.0 NDENT 3.5 The number of basic blocks defined by the function. NINDENT NINDENT Instructions NDENT 0.0 NDENT 3.5 The number of instructions defined by the function. NINDENT NINDENT Long Instructions NDENT 0.0 NDENT 3.5 The number of instructions using the long instruction format in the function. NINDENT NINDENT Operands NDENT 0.0 NDENT 3.5 The number of operands used by all instructions in the function. NINDENT NINDENT Instruction Size NDENT 0.0 NDENT 3.5 The number of bytes consumed by instructions in the function. NINDENT NINDENT Average Instruction Size NDENT 0.0 NDENT 3.5 The average number of bytes consumed by the instructions in the function. This value is computed by dividing Instruction Size by Instructions. NINDENT NINDENT Bytes Per Instruction NDENT 0.0 NDENT 3.5 The average number of bytes used by the function per instruction. This value is computed by dividing Byte Size by Instructions. Note that this is not the same as Average Instruction Size. It computes a number relative to the total function size not just the size of the instruction list. NINDENT NINDENT Number of VBR 32-bit Integers NDENT 0.0 NDENT 3.5 The total number of 32-bit integers found in this function (for any use). NINDENT NINDENT Number of VBR 64-bit Integers NDENT 0.0 NDENT 3.5 The total number of 64-bit integers found in this function (for any use). NINDENT NINDENT Number of VBR Compressed Bytes NDENT 0.0 NDENT 3.5 The total number of bytes in this function consumed by the 32-bit and 64-bit integers that use the Variable Bit Rate encoding scheme. NINDENT NINDENT Number of VBR Expanded Bytes NDENT 0.0 NDENT 3.5 The total number of bytes in this function that would have been consumed by the 32-bit and 64-bit integers had they not been compressed with the Variable Bit Rate encoding scheme. NINDENT NINDENT Bytes Saved With VBR NDENT 0.0 NDENT 3.5 The total number of bytes saved in this function by using the Variable Bit Rate encoding scheme. The percentage is relative to # of VBR Expanded Bytes. NINDENT NINDENT llvm-dis(1), /BitCodeFormat Maintained by the LLVM Team (https://llvm.org/). 2003-2020, LLVM Project Generated by docutils manpage writer.
.