blob: 01c6329520d954b00aec274c51f529ee534b8266 [file] [log] [blame]
Gabor Greif8ff70c22007-07-04 21:55:50 +00001//===-- llvm-bcanalyzer.cpp - Bitcode Analyzer --------------------------===//
Misha Brukman3da94ae2005-04-22 00:00:37 +00002//
Reid Spencerdac69c82004-06-07 17:53:43 +00003// The LLVM Compiler Infrastructure
4//
Chris Lattner21c62da2007-12-29 20:44:31 +00005// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
Misha Brukman3da94ae2005-04-22 00:00:37 +00007//
Reid Spencerdac69c82004-06-07 17:53:43 +00008//===----------------------------------------------------------------------===//
9//
Reid Spencer96684ef2004-06-08 05:56:58 +000010// This tool may be invoked in the following manner:
Gabor Greif8ff70c22007-07-04 21:55:50 +000011// llvm-bcanalyzer [options] - Read LLVM bitcode from stdin
12// llvm-bcanalyzer [options] x.bc - Read LLVM bitcode from the x.bc file
Reid Spencerdac69c82004-06-07 17:53:43 +000013//
Reid Spencer96684ef2004-06-08 05:56:58 +000014// Options:
Reid Spencer23d46e72004-06-10 18:38:44 +000015// --help - Output information about command line switches
Gabor Greif8ff70c22007-07-04 21:55:50 +000016// --dump - Dump low-level bitcode structure in readable format
Reid Spencer96684ef2004-06-08 05:56:58 +000017//
Gabor Greif8ff70c22007-07-04 21:55:50 +000018// This tool provides analytical information about a bitcode file. It is
19// intended as an aid to developers of bitcode reading and writing software. It
20// produces on std::out a summary of the bitcode file that shows various
Reid Spencer23d46e72004-06-10 18:38:44 +000021// statistics about the contents of the file. By default this information is
Gabor Greif8ff70c22007-07-04 21:55:50 +000022// detailed and contains information about individual bitcode blocks and the
Daniel Dunbar80ba3d22009-09-25 16:03:57 +000023// functions in the module.
Gabor Greif8ff70c22007-07-04 21:55:50 +000024// The tool is also able to print a bitcode file in a straight forward text
Misha Brukman3da94ae2005-04-22 00:00:37 +000025// format that shows the containment and relationships of the information in
Gabor Greif8ff70c22007-07-04 21:55:50 +000026// the bitcode file (-dump option).
Chris Lattner63db4852007-04-29 05:51:00 +000027//
Reid Spencerdac69c82004-06-07 17:53:43 +000028//===----------------------------------------------------------------------===//
29
Reid Spencer86a9a7a2004-06-29 23:34:27 +000030#include "llvm/Analysis/Verifier.h"
Chris Lattner45e0f892007-04-29 08:12:22 +000031#include "llvm/Bitcode/BitstreamReader.h"
Chris Lattner4238d472007-04-29 20:00:02 +000032#include "llvm/Bitcode/LLVMBitCodes.h"
Chris Lattnere2a466b2009-04-06 20:54:32 +000033#include "llvm/Bitcode/ReaderWriter.h"
Reid Spencer551ccae2004-09-01 22:55:40 +000034#include "llvm/Support/CommandLine.h"
Chris Lattnerc30598b2006-12-06 01:18:01 +000035#include "llvm/Support/ManagedStatic.h"
Chris Lattner45e0f892007-04-29 08:12:22 +000036#include "llvm/Support/MemoryBuffer.h"
Chris Lattnercc14d252009-03-06 05:34:10 +000037#include "llvm/Support/PrettyStackTrace.h"
Chris Lattner74382b72009-08-23 22:45:37 +000038#include "llvm/Support/raw_ostream.h"
Reid Spencerdac69c82004-06-07 17:53:43 +000039#include "llvm/System/Signals.h"
Duncan Sands15af79c2009-08-24 10:59:01 +000040#include <cstdio>
Chris Lattner44dadff2007-05-06 09:29:57 +000041#include <map>
Chris Lattnerb1e85b52007-05-05 01:46:49 +000042#include <algorithm>
Reid Spencerdac69c82004-06-07 17:53:43 +000043using namespace llvm;
44
45static cl::opt<std::string>
Gabor Greif8ff70c22007-07-04 21:55:50 +000046 InputFilename(cl::Positional, cl::desc("<input bitcode>"), cl::init("-"));
Reid Spencerdac69c82004-06-07 17:53:43 +000047
Reid Spencer75937452004-08-21 21:00:24 +000048static cl::opt<std::string>
49 OutputFilename("-o", cl::init("-"), cl::desc("<output file>"));
50
Gabor Greif8ff70c22007-07-04 21:55:50 +000051static cl::opt<bool> Dump("dump", cl::desc("Dump low level bitcode trace"));
Chris Lattner32de6332007-04-29 08:31:14 +000052
53//===----------------------------------------------------------------------===//
54// Bitcode specific analysis.
55//===----------------------------------------------------------------------===//
56
Chris Lattnerb1e85b52007-05-05 01:46:49 +000057static cl::opt<bool> NoHistogram("disable-histogram",
58 cl::desc("Do not print per-code histogram"));
Chris Lattner45e0f892007-04-29 08:12:22 +000059
Chris Lattnerb30c9252007-04-29 21:48:19 +000060static cl::opt<bool>
61NonSymbolic("non-symbolic",
62 cl::desc("Emit numberic info in dump even if"
63 " symbolic info is available"));
64
Daniel Dunbar80ba3d22009-09-25 16:03:57 +000065/// CurStreamType - If we can sniff the flavor of this stream, we can produce
Chris Lattner45e0f892007-04-29 08:12:22 +000066/// better dump info.
67static enum {
68 UnknownBitstream,
69 LLVMIRBitstream
70} CurStreamType;
71
Chris Lattner4238d472007-04-29 20:00:02 +000072
73/// GetBlockName - Return a symbolic block name if known, otherwise return
Chris Lattnerb30c9252007-04-29 21:48:19 +000074/// null.
Chris Lattnerf9a3ec82009-04-26 22:21:57 +000075static const char *GetBlockName(unsigned BlockID,
76 const BitstreamReader &StreamFile) {
Chris Lattner1772b122007-05-05 00:17:42 +000077 // Standard blocks for all bitcode files.
78 if (BlockID < bitc::FIRST_APPLICATION_BLOCKID) {
79 if (BlockID == bitc::BLOCKINFO_BLOCK_ID)
80 return "BLOCKINFO_BLOCK";
81 return 0;
82 }
Daniel Dunbar80ba3d22009-09-25 16:03:57 +000083
Chris Lattnerf9a3ec82009-04-26 22:21:57 +000084 // Check to see if we have a blockinfo record for this block, with a name.
85 if (const BitstreamReader::BlockInfo *Info =
86 StreamFile.getBlockInfo(BlockID)) {
87 if (!Info->Name.empty())
88 return Info->Name.c_str();
89 }
Daniel Dunbar80ba3d22009-09-25 16:03:57 +000090
91
Chris Lattnerb30c9252007-04-29 21:48:19 +000092 if (CurStreamType != LLVMIRBitstream) return 0;
Daniel Dunbar80ba3d22009-09-25 16:03:57 +000093
Chris Lattner4238d472007-04-29 20:00:02 +000094 switch (BlockID) {
Devang Patele8e02132009-09-18 19:26:43 +000095 default: return 0;
96 case bitc::MODULE_BLOCK_ID: return "MODULE_BLOCK";
97 case bitc::PARAMATTR_BLOCK_ID: return "PARAMATTR_BLOCK";
98 case bitc::TYPE_BLOCK_ID: return "TYPE_BLOCK";
99 case bitc::CONSTANTS_BLOCK_ID: return "CONSTANTS_BLOCK";
100 case bitc::FUNCTION_BLOCK_ID: return "FUNCTION_BLOCK";
101 case bitc::TYPE_SYMTAB_BLOCK_ID: return "TYPE_SYMTAB";
102 case bitc::VALUE_SYMTAB_BLOCK_ID: return "VALUE_SYMTAB";
103 case bitc::METADATA_BLOCK_ID: return "METADATA_BLOCK";
104 case bitc::METADATA_ATTACHMENT_ID: return "METADATA_ATTACHMENT_BLOCK";
Chris Lattner4238d472007-04-29 20:00:02 +0000105 }
106}
107
Chris Lattnerb30c9252007-04-29 21:48:19 +0000108/// GetCodeName - Return a symbolic code name if known, otherwise return
109/// null.
Chris Lattnerf9a3ec82009-04-26 22:21:57 +0000110static const char *GetCodeName(unsigned CodeID, unsigned BlockID,
111 const BitstreamReader &StreamFile) {
Chris Lattner1772b122007-05-05 00:17:42 +0000112 // Standard blocks for all bitcode files.
113 if (BlockID < bitc::FIRST_APPLICATION_BLOCKID) {
114 if (BlockID == bitc::BLOCKINFO_BLOCK_ID) {
115 switch (CodeID) {
116 default: return 0;
Chris Lattnerf9a3ec82009-04-26 22:21:57 +0000117 case bitc::BLOCKINFO_CODE_SETBID: return "SETBID";
118 case bitc::BLOCKINFO_CODE_BLOCKNAME: return "BLOCKNAME";
119 case bitc::BLOCKINFO_CODE_SETRECORDNAME: return "SETRECORDNAME";
Chris Lattner1772b122007-05-05 00:17:42 +0000120 }
121 }
122 return 0;
123 }
Daniel Dunbar80ba3d22009-09-25 16:03:57 +0000124
Chris Lattnerf9a3ec82009-04-26 22:21:57 +0000125 // Check to see if we have a blockinfo record for this record, with a name.
126 if (const BitstreamReader::BlockInfo *Info =
127 StreamFile.getBlockInfo(BlockID)) {
128 for (unsigned i = 0, e = Info->RecordNames.size(); i != e; ++i)
129 if (Info->RecordNames[i].first == CodeID)
130 return Info->RecordNames[i].second.c_str();
131 }
Daniel Dunbar80ba3d22009-09-25 16:03:57 +0000132
133
Chris Lattnerb30c9252007-04-29 21:48:19 +0000134 if (CurStreamType != LLVMIRBitstream) return 0;
Daniel Dunbar80ba3d22009-09-25 16:03:57 +0000135
Chris Lattnerb30c9252007-04-29 21:48:19 +0000136 switch (BlockID) {
137 default: return 0;
138 case bitc::MODULE_BLOCK_ID:
139 switch (CodeID) {
140 default: return 0;
141 case bitc::MODULE_CODE_VERSION: return "VERSION";
142 case bitc::MODULE_CODE_TRIPLE: return "TRIPLE";
143 case bitc::MODULE_CODE_DATALAYOUT: return "DATALAYOUT";
144 case bitc::MODULE_CODE_ASM: return "ASM";
145 case bitc::MODULE_CODE_SECTIONNAME: return "SECTIONNAME";
146 case bitc::MODULE_CODE_DEPLIB: return "DEPLIB";
147 case bitc::MODULE_CODE_GLOBALVAR: return "GLOBALVAR";
148 case bitc::MODULE_CODE_FUNCTION: return "FUNCTION";
149 case bitc::MODULE_CODE_ALIAS: return "ALIAS";
150 case bitc::MODULE_CODE_PURGEVALS: return "PURGEVALS";
Nick Lewycky82b80d92008-11-07 14:52:51 +0000151 case bitc::MODULE_CODE_GCNAME: return "GCNAME";
Chris Lattnerb30c9252007-04-29 21:48:19 +0000152 }
Chris Lattnercd5b7d72007-05-04 03:01:41 +0000153 case bitc::PARAMATTR_BLOCK_ID:
154 switch (CodeID) {
155 default: return 0;
156 case bitc::PARAMATTR_CODE_ENTRY: return "ENTRY";
157 }
Chris Lattnerb30c9252007-04-29 21:48:19 +0000158 case bitc::TYPE_BLOCK_ID:
159 switch (CodeID) {
160 default: return 0;
Nick Lewycky82b80d92008-11-07 14:52:51 +0000161 case bitc::TYPE_CODE_NUMENTRY: return "NUMENTRY";
162 case bitc::TYPE_CODE_VOID: return "VOID";
163 case bitc::TYPE_CODE_FLOAT: return "FLOAT";
164 case bitc::TYPE_CODE_DOUBLE: return "DOUBLE";
165 case bitc::TYPE_CODE_LABEL: return "LABEL";
166 case bitc::TYPE_CODE_OPAQUE: return "OPAQUE";
167 case bitc::TYPE_CODE_INTEGER: return "INTEGER";
168 case bitc::TYPE_CODE_POINTER: return "POINTER";
169 case bitc::TYPE_CODE_FUNCTION: return "FUNCTION";
170 case bitc::TYPE_CODE_STRUCT: return "STRUCT";
171 case bitc::TYPE_CODE_ARRAY: return "ARRAY";
172 case bitc::TYPE_CODE_VECTOR: return "VECTOR";
173 case bitc::TYPE_CODE_X86_FP80: return "X86_FP80";
174 case bitc::TYPE_CODE_FP128: return "FP128";
175 case bitc::TYPE_CODE_PPC_FP128: return "PPC_FP128";
Nick Lewycky079c0342009-06-01 04:41:03 +0000176 case bitc::TYPE_CODE_METADATA: return "METADATA";
Chris Lattnerb30c9252007-04-29 21:48:19 +0000177 }
Daniel Dunbar80ba3d22009-09-25 16:03:57 +0000178
Chris Lattnerb30c9252007-04-29 21:48:19 +0000179 case bitc::CONSTANTS_BLOCK_ID:
180 switch (CodeID) {
181 default: return 0;
Duncan Sands0cad4e32009-09-25 12:28:37 +0000182 case bitc::CST_CODE_SETTYPE: return "SETTYPE";
183 case bitc::CST_CODE_NULL: return "NULL";
184 case bitc::CST_CODE_UNDEF: return "UNDEF";
185 case bitc::CST_CODE_INTEGER: return "INTEGER";
186 case bitc::CST_CODE_WIDE_INTEGER: return "WIDE_INTEGER";
187 case bitc::CST_CODE_FLOAT: return "FLOAT";
188 case bitc::CST_CODE_AGGREGATE: return "AGGREGATE";
189 case bitc::CST_CODE_STRING: return "STRING";
190 case bitc::CST_CODE_CSTRING: return "CSTRING";
191 case bitc::CST_CODE_CE_BINOP: return "CE_BINOP";
192 case bitc::CST_CODE_CE_CAST: return "CE_CAST";
193 case bitc::CST_CODE_CE_GEP: return "CE_GEP";
194 case bitc::CST_CODE_CE_INBOUNDS_GEP: return "CE_INBOUNDS_GEP";
195 case bitc::CST_CODE_CE_SELECT: return "CE_SELECT";
196 case bitc::CST_CODE_CE_EXTRACTELT: return "CE_EXTRACTELT";
197 case bitc::CST_CODE_CE_INSERTELT: return "CE_INSERTELT";
198 case bitc::CST_CODE_CE_SHUFFLEVEC: return "CE_SHUFFLEVEC";
199 case bitc::CST_CODE_CE_CMP: return "CE_CMP";
200 case bitc::CST_CODE_INLINEASM: return "INLINEASM";
201 case bitc::CST_CODE_CE_SHUFVEC_EX: return "CE_SHUFVEC_EX";
Daniel Dunbar80ba3d22009-09-25 16:03:57 +0000202 }
Chris Lattnerb30c9252007-04-29 21:48:19 +0000203 case bitc::FUNCTION_BLOCK_ID:
204 switch (CodeID) {
205 default: return 0;
206 case bitc::FUNC_CODE_DECLAREBLOCKS: return "DECLAREBLOCKS";
Daniel Dunbar80ba3d22009-09-25 16:03:57 +0000207
Duncan Sands0cad4e32009-09-25 12:28:37 +0000208 case bitc::FUNC_CODE_INST_BINOP: return "INST_BINOP";
209 case bitc::FUNC_CODE_INST_CAST: return "INST_CAST";
210 case bitc::FUNC_CODE_INST_GEP: return "INST_GEP";
211 case bitc::FUNC_CODE_INST_INBOUNDS_GEP: return "INST_INBOUNDS_GEP";
212 case bitc::FUNC_CODE_INST_SELECT: return "INST_SELECT";
213 case bitc::FUNC_CODE_INST_EXTRACTELT: return "INST_EXTRACTELT";
214 case bitc::FUNC_CODE_INST_INSERTELT: return "INST_INSERTELT";
215 case bitc::FUNC_CODE_INST_SHUFFLEVEC: return "INST_SHUFFLEVEC";
216 case bitc::FUNC_CODE_INST_CMP: return "INST_CMP";
Daniel Dunbar80ba3d22009-09-25 16:03:57 +0000217
Duncan Sands0cad4e32009-09-25 12:28:37 +0000218 case bitc::FUNC_CODE_INST_RET: return "INST_RET";
219 case bitc::FUNC_CODE_INST_BR: return "INST_BR";
220 case bitc::FUNC_CODE_INST_SWITCH: return "INST_SWITCH";
221 case bitc::FUNC_CODE_INST_INVOKE: return "INST_INVOKE";
222 case bitc::FUNC_CODE_INST_UNWIND: return "INST_UNWIND";
223 case bitc::FUNC_CODE_INST_UNREACHABLE: return "INST_UNREACHABLE";
Daniel Dunbar80ba3d22009-09-25 16:03:57 +0000224
Duncan Sands0cad4e32009-09-25 12:28:37 +0000225 case bitc::FUNC_CODE_INST_PHI: return "INST_PHI";
226 case bitc::FUNC_CODE_INST_MALLOC: return "INST_MALLOC";
227 case bitc::FUNC_CODE_INST_FREE: return "INST_FREE";
228 case bitc::FUNC_CODE_INST_ALLOCA: return "INST_ALLOCA";
229 case bitc::FUNC_CODE_INST_LOAD: return "INST_LOAD";
230 case bitc::FUNC_CODE_INST_STORE: return "INST_STORE";
231 case bitc::FUNC_CODE_INST_CALL: return "INST_CALL";
232 case bitc::FUNC_CODE_INST_VAARG: return "INST_VAARG";
233 case bitc::FUNC_CODE_INST_STORE2: return "INST_STORE2";
234 case bitc::FUNC_CODE_INST_GETRESULT: return "INST_GETRESULT";
235 case bitc::FUNC_CODE_INST_EXTRACTVAL: return "INST_EXTRACTVAL";
236 case bitc::FUNC_CODE_INST_INSERTVAL: return "INST_INSERTVAL";
237 case bitc::FUNC_CODE_INST_CMP2: return "INST_CMP2";
238 case bitc::FUNC_CODE_INST_VSELECT: return "INST_VSELECT";
Chris Lattnerb30c9252007-04-29 21:48:19 +0000239 }
240 case bitc::TYPE_SYMTAB_BLOCK_ID:
241 switch (CodeID) {
242 default: return 0;
243 case bitc::TST_CODE_ENTRY: return "ENTRY";
244 }
245 case bitc::VALUE_SYMTAB_BLOCK_ID:
246 switch (CodeID) {
247 default: return 0;
248 case bitc::VST_CODE_ENTRY: return "ENTRY";
Chris Lattnercd5b7d72007-05-04 03:01:41 +0000249 case bitc::VST_CODE_BBENTRY: return "BBENTRY";
Chris Lattnerb30c9252007-04-29 21:48:19 +0000250 }
Devang Patele8e02132009-09-18 19:26:43 +0000251 case bitc::METADATA_ATTACHMENT_ID:
252 switch(CodeID) {
253 default:return 0;
254 case bitc::METADATA_ATTACHMENT: return "METADATA_ATTACHMENT";
255 }
Devang Patele54abc92009-07-22 17:43:22 +0000256 case bitc::METADATA_BLOCK_ID:
257 switch(CodeID) {
258 default:return 0;
259 case bitc::METADATA_STRING: return "MDSTRING";
Devang Patel104cf9e2009-07-23 01:07:34 +0000260 case bitc::METADATA_NODE: return "MDNODE";
Devang Patel124e6eb2009-07-30 23:03:19 +0000261 case bitc::METADATA_NAME: return "METADATA_NAME";
262 case bitc::METADATA_NAMED_NODE: return "NAMEDMDNODE";
Devang Patele8e02132009-09-18 19:26:43 +0000263 case bitc::METADATA_KIND: return "METADATA_KIND";
Devang Patele54abc92009-07-22 17:43:22 +0000264 }
Chris Lattnerb30c9252007-04-29 21:48:19 +0000265 }
266}
267
Chris Lattner24437472009-04-27 17:59:34 +0000268struct PerRecordStats {
269 unsigned NumInstances;
Chris Lattnerc167cac2009-04-27 18:15:27 +0000270 unsigned NumAbbrev;
271 uint64_t TotalBits;
Daniel Dunbar80ba3d22009-09-25 16:03:57 +0000272
Chris Lattnerc167cac2009-04-27 18:15:27 +0000273 PerRecordStats() : NumInstances(0), NumAbbrev(0), TotalBits(0) {}
Chris Lattner24437472009-04-27 17:59:34 +0000274};
Chris Lattner4238d472007-04-29 20:00:02 +0000275
276struct PerBlockIDStats {
277 /// NumInstances - This the number of times this block ID has been seen.
278 unsigned NumInstances;
Daniel Dunbar80ba3d22009-09-25 16:03:57 +0000279
Chris Lattner4238d472007-04-29 20:00:02 +0000280 /// NumBits - The total size in bits of all of these blocks.
281 uint64_t NumBits;
Daniel Dunbar80ba3d22009-09-25 16:03:57 +0000282
Chris Lattner4238d472007-04-29 20:00:02 +0000283 /// NumSubBlocks - The total number of blocks these blocks contain.
284 unsigned NumSubBlocks;
Daniel Dunbar80ba3d22009-09-25 16:03:57 +0000285
Chris Lattner4238d472007-04-29 20:00:02 +0000286 /// NumAbbrevs - The total number of abbreviations.
287 unsigned NumAbbrevs;
Daniel Dunbar80ba3d22009-09-25 16:03:57 +0000288
289 /// NumRecords - The total number of records these blocks contain, and the
Chris Lattner4238d472007-04-29 20:00:02 +0000290 /// number that are abbreviated.
291 unsigned NumRecords, NumAbbreviatedRecords;
Daniel Dunbar80ba3d22009-09-25 16:03:57 +0000292
Chris Lattnerb1e85b52007-05-05 01:46:49 +0000293 /// CodeFreq - Keep track of the number of times we see each code.
Chris Lattner24437472009-04-27 17:59:34 +0000294 std::vector<PerRecordStats> CodeFreq;
Daniel Dunbar80ba3d22009-09-25 16:03:57 +0000295
Chris Lattner4238d472007-04-29 20:00:02 +0000296 PerBlockIDStats()
297 : NumInstances(0), NumBits(0),
298 NumSubBlocks(0), NumAbbrevs(0), NumRecords(0), NumAbbreviatedRecords(0) {}
299};
300
301static std::map<unsigned, PerBlockIDStats> BlockIDStats;
302
303
304
Chris Lattner32de6332007-04-29 08:31:14 +0000305/// Error - All bitcode analysis errors go through this function, making this a
306/// good place to breakpoint if debugging.
307static bool Error(const std::string &Err) {
Dan Gohman65f57c22009-07-15 16:35:29 +0000308 errs() << Err << "\n";
Chris Lattner32de6332007-04-29 08:31:14 +0000309 return true;
310}
311
312/// ParseBlock - Read a block, updating statistics, etc.
Chris Lattner962dde32009-04-26 20:59:02 +0000313static bool ParseBlock(BitstreamCursor &Stream, unsigned IndentLevel) {
Chris Lattner1772b122007-05-05 00:17:42 +0000314 std::string Indent(IndentLevel*2, ' ');
Chris Lattner4238d472007-04-29 20:00:02 +0000315 uint64_t BlockBitStart = Stream.GetCurrentBitNo();
Chris Lattner32de6332007-04-29 08:31:14 +0000316 unsigned BlockID = Stream.ReadSubBlockID();
Chris Lattnerb30c9252007-04-29 21:48:19 +0000317
Chris Lattner4238d472007-04-29 20:00:02 +0000318 // Get the statistics for this BlockID.
319 PerBlockIDStats &BlockStats = BlockIDStats[BlockID];
Daniel Dunbar80ba3d22009-09-25 16:03:57 +0000320
Chris Lattner4238d472007-04-29 20:00:02 +0000321 BlockStats.NumInstances++;
Daniel Dunbar80ba3d22009-09-25 16:03:57 +0000322
Chris Lattner1772b122007-05-05 00:17:42 +0000323 // BLOCKINFO is a special part of the stream.
324 if (BlockID == bitc::BLOCKINFO_BLOCK_ID) {
Dan Gohman65f57c22009-07-15 16:35:29 +0000325 if (Dump) errs() << Indent << "<BLOCKINFO_BLOCK/>\n";
Chris Lattner1772b122007-05-05 00:17:42 +0000326 if (Stream.ReadBlockInfoBlock())
327 return Error("Malformed BlockInfoBlock");
328 uint64_t BlockBitEnd = Stream.GetCurrentBitNo();
329 BlockStats.NumBits += BlockBitEnd-BlockBitStart;
330 return false;
331 }
Daniel Dunbar80ba3d22009-09-25 16:03:57 +0000332
Chris Lattnerb30c9252007-04-29 21:48:19 +0000333 unsigned NumWords = 0;
Chris Lattner1772b122007-05-05 00:17:42 +0000334 if (Stream.EnterSubBlock(BlockID, &NumWords))
Chris Lattner32de6332007-04-29 08:31:14 +0000335 return Error("Malformed block record");
336
Chris Lattnerb30c9252007-04-29 21:48:19 +0000337 const char *BlockName = 0;
338 if (Dump) {
Dan Gohman65f57c22009-07-15 16:35:29 +0000339 errs() << Indent << "<";
Chris Lattnerf9a3ec82009-04-26 22:21:57 +0000340 if ((BlockName = GetBlockName(BlockID, *Stream.getBitStreamReader())))
Dan Gohman65f57c22009-07-15 16:35:29 +0000341 errs() << BlockName;
Chris Lattnerb30c9252007-04-29 21:48:19 +0000342 else
Dan Gohman65f57c22009-07-15 16:35:29 +0000343 errs() << "UnknownBlock" << BlockID;
Daniel Dunbar80ba3d22009-09-25 16:03:57 +0000344
Chris Lattnerb30c9252007-04-29 21:48:19 +0000345 if (NonSymbolic && BlockName)
Dan Gohman65f57c22009-07-15 16:35:29 +0000346 errs() << " BlockID=" << BlockID;
Daniel Dunbar80ba3d22009-09-25 16:03:57 +0000347
Dan Gohman65f57c22009-07-15 16:35:29 +0000348 errs() << " NumWords=" << NumWords
349 << " BlockCodeSize=" << Stream.GetAbbrevIDWidth() << ">\n";
Chris Lattnerb30c9252007-04-29 21:48:19 +0000350 }
Daniel Dunbar80ba3d22009-09-25 16:03:57 +0000351
Chris Lattner32de6332007-04-29 08:31:14 +0000352 SmallVector<uint64_t, 64> Record;
353
354 // Read all the records for this block.
355 while (1) {
356 if (Stream.AtEndOfStream())
357 return Error("Premature end of bitstream");
358
Chris Lattnerc167cac2009-04-27 18:15:27 +0000359 uint64_t RecordStartBit = Stream.GetCurrentBitNo();
Daniel Dunbar80ba3d22009-09-25 16:03:57 +0000360
Chris Lattner32de6332007-04-29 08:31:14 +0000361 // Read the code for this record.
362 unsigned AbbrevID = Stream.ReadCode();
363 switch (AbbrevID) {
Chris Lattner4238d472007-04-29 20:00:02 +0000364 case bitc::END_BLOCK: {
Chris Lattner32de6332007-04-29 08:31:14 +0000365 if (Stream.ReadBlockEnd())
366 return Error("Error at end of block");
Chris Lattner4238d472007-04-29 20:00:02 +0000367 uint64_t BlockBitEnd = Stream.GetCurrentBitNo();
368 BlockStats.NumBits += BlockBitEnd-BlockBitStart;
Chris Lattnerb30c9252007-04-29 21:48:19 +0000369 if (Dump) {
Dan Gohman65f57c22009-07-15 16:35:29 +0000370 errs() << Indent << "</";
Chris Lattnerb30c9252007-04-29 21:48:19 +0000371 if (BlockName)
Dan Gohman65f57c22009-07-15 16:35:29 +0000372 errs() << BlockName << ">\n";
Chris Lattnerb30c9252007-04-29 21:48:19 +0000373 else
Dan Gohman65f57c22009-07-15 16:35:29 +0000374 errs() << "UnknownBlock" << BlockID << ">\n";
Chris Lattnerb30c9252007-04-29 21:48:19 +0000375 }
Chris Lattner32de6332007-04-29 08:31:14 +0000376 return false;
Daniel Dunbar80ba3d22009-09-25 16:03:57 +0000377 }
Chris Lattner44b0f102007-05-05 01:29:31 +0000378 case bitc::ENTER_SUBBLOCK: {
379 uint64_t SubBlockBitStart = Stream.GetCurrentBitNo();
Chris Lattnerb30c9252007-04-29 21:48:19 +0000380 if (ParseBlock(Stream, IndentLevel+1))
Chris Lattner32de6332007-04-29 08:31:14 +0000381 return true;
Chris Lattner4238d472007-04-29 20:00:02 +0000382 ++BlockStats.NumSubBlocks;
Chris Lattner44b0f102007-05-05 01:29:31 +0000383 uint64_t SubBlockBitEnd = Stream.GetCurrentBitNo();
Daniel Dunbar80ba3d22009-09-25 16:03:57 +0000384
Chris Lattner44b0f102007-05-05 01:29:31 +0000385 // Don't include subblock sizes in the size of this block.
386 BlockBitStart += SubBlockBitEnd-SubBlockBitStart;
Chris Lattner32de6332007-04-29 08:31:14 +0000387 break;
Chris Lattner44b0f102007-05-05 01:29:31 +0000388 }
Chris Lattner32de6332007-04-29 08:31:14 +0000389 case bitc::DEFINE_ABBREV:
390 Stream.ReadAbbrevRecord();
Chris Lattner4238d472007-04-29 20:00:02 +0000391 ++BlockStats.NumAbbrevs;
Chris Lattner32de6332007-04-29 08:31:14 +0000392 break;
393 default:
394 Record.clear();
Chris Lattner3f75d312009-04-06 22:44:40 +0000395
396 ++BlockStats.NumRecords;
Chris Lattnerae7dd802009-04-07 02:56:46 +0000397 if (AbbrevID != bitc::UNABBREV_RECORD)
Chris Lattner3f75d312009-04-06 22:44:40 +0000398 ++BlockStats.NumAbbreviatedRecords;
Daniel Dunbar80ba3d22009-09-25 16:03:57 +0000399
Chris Lattner3f75d312009-04-06 22:44:40 +0000400 const char *BlobStart = 0;
401 unsigned BlobLen = 0;
Chris Lattnerae7dd802009-04-07 02:56:46 +0000402 unsigned Code = Stream.ReadRecord(AbbrevID, Record, BlobStart, BlobLen);
Chris Lattnerb1e85b52007-05-05 01:46:49 +0000403
Daniel Dunbar80ba3d22009-09-25 16:03:57 +0000404
405
Chris Lattnerb1e85b52007-05-05 01:46:49 +0000406 // Increment the # occurrences of this code.
407 if (BlockStats.CodeFreq.size() <= Code)
408 BlockStats.CodeFreq.resize(Code+1);
Chris Lattner24437472009-04-27 17:59:34 +0000409 BlockStats.CodeFreq[Code].NumInstances++;
Chris Lattnerc167cac2009-04-27 18:15:27 +0000410 BlockStats.CodeFreq[Code].TotalBits +=
411 Stream.GetCurrentBitNo()-RecordStartBit;
412 if (AbbrevID != bitc::UNABBREV_RECORD)
413 BlockStats.CodeFreq[Code].NumAbbrev++;
Daniel Dunbar80ba3d22009-09-25 16:03:57 +0000414
Chris Lattnerb30c9252007-04-29 21:48:19 +0000415 if (Dump) {
Dan Gohman65f57c22009-07-15 16:35:29 +0000416 errs() << Indent << " <";
Chris Lattnerf9a3ec82009-04-26 22:21:57 +0000417 if (const char *CodeName =
418 GetCodeName(Code, BlockID, *Stream.getBitStreamReader()))
Dan Gohman65f57c22009-07-15 16:35:29 +0000419 errs() << CodeName;
Chris Lattnerb30c9252007-04-29 21:48:19 +0000420 else
Dan Gohman65f57c22009-07-15 16:35:29 +0000421 errs() << "UnknownCode" << Code;
Chris Lattnerf9a3ec82009-04-26 22:21:57 +0000422 if (NonSymbolic &&
423 GetCodeName(Code, BlockID, *Stream.getBitStreamReader()))
Dan Gohman65f57c22009-07-15 16:35:29 +0000424 errs() << " codeid=" << Code;
Chris Lattnerb30c9252007-04-29 21:48:19 +0000425 if (AbbrevID != bitc::UNABBREV_RECORD)
Dan Gohman65f57c22009-07-15 16:35:29 +0000426 errs() << " abbrevid=" << AbbrevID;
Chris Lattnerb30c9252007-04-29 21:48:19 +0000427
428 for (unsigned i = 0, e = Record.size(); i != e; ++i)
Dan Gohman65f57c22009-07-15 16:35:29 +0000429 errs() << " op" << i << "=" << (int64_t)Record[i];
Daniel Dunbar80ba3d22009-09-25 16:03:57 +0000430
Dan Gohman65f57c22009-07-15 16:35:29 +0000431 errs() << "/>";
Daniel Dunbar80ba3d22009-09-25 16:03:57 +0000432
Chris Lattnerae7dd802009-04-07 02:56:46 +0000433 if (BlobStart) {
Dan Gohman65f57c22009-07-15 16:35:29 +0000434 errs() << " blob data = ";
Chris Lattnerae7dd802009-04-07 02:56:46 +0000435 bool BlobIsPrintable = true;
436 for (unsigned i = 0; i != BlobLen; ++i)
437 if (!isprint(BlobStart[i])) {
438 BlobIsPrintable = false;
439 break;
440 }
Daniel Dunbar80ba3d22009-09-25 16:03:57 +0000441
Chris Lattnerae7dd802009-04-07 02:56:46 +0000442 if (BlobIsPrintable)
Dan Gohman65f57c22009-07-15 16:35:29 +0000443 errs() << "'" << std::string(BlobStart, BlobStart+BlobLen) <<"'";
Chris Lattnerae7dd802009-04-07 02:56:46 +0000444 else
Dan Gohman65f57c22009-07-15 16:35:29 +0000445 errs() << "unprintable, " << BlobLen << " bytes.";
Chris Lattnerae7dd802009-04-07 02:56:46 +0000446 }
Daniel Dunbar80ba3d22009-09-25 16:03:57 +0000447
Dan Gohman65f57c22009-07-15 16:35:29 +0000448 errs() << "\n";
Chris Lattnerb30c9252007-04-29 21:48:19 +0000449 }
Daniel Dunbar80ba3d22009-09-25 16:03:57 +0000450
Chris Lattner32de6332007-04-29 08:31:14 +0000451 break;
452 }
453 }
454}
455
Chris Lattner4238d472007-04-29 20:00:02 +0000456static void PrintSize(double Bits) {
Chris Lattner24437472009-04-27 17:59:34 +0000457 fprintf(stderr, "%.2f/%.2fB/%lluW", Bits, Bits/8,(unsigned long long)Bits/32);
458}
459static void PrintSize(uint64_t Bits) {
460 fprintf(stderr, "%llub/%.2fB/%lluW", (unsigned long long)Bits,
461 (double)Bits/8, (unsigned long long)Bits/32);
Chris Lattner4238d472007-04-29 20:00:02 +0000462}
463
464
Chris Lattner45e0f892007-04-29 08:12:22 +0000465/// AnalyzeBitcode - Analyze the bitcode file specified by InputFilename.
466static int AnalyzeBitcode() {
467 // Read the input file.
Chris Lattnere2a466b2009-04-06 20:54:32 +0000468 MemoryBuffer *MemBuf = MemoryBuffer::getFileOrSTDIN(InputFilename.c_str());
Chris Lattner45e0f892007-04-29 08:12:22 +0000469
Chris Lattnere2a466b2009-04-06 20:54:32 +0000470 if (MemBuf == 0)
Chris Lattner32de6332007-04-29 08:31:14 +0000471 return Error("Error reading '" + InputFilename + "'.");
Daniel Dunbar80ba3d22009-09-25 16:03:57 +0000472
Chris Lattnere2a466b2009-04-06 20:54:32 +0000473 if (MemBuf->getBufferSize() & 3)
Chris Lattner32de6332007-04-29 08:31:14 +0000474 return Error("Bitcode stream should be a multiple of 4 bytes in length");
Daniel Dunbar80ba3d22009-09-25 16:03:57 +0000475
Chris Lattnere2a466b2009-04-06 20:54:32 +0000476 unsigned char *BufPtr = (unsigned char *)MemBuf->getBufferStart();
477 unsigned char *EndBufPtr = BufPtr+MemBuf->getBufferSize();
Daniel Dunbar80ba3d22009-09-25 16:03:57 +0000478
Chris Lattnere2a466b2009-04-06 20:54:32 +0000479 // If we have a wrapper header, parse it and ignore the non-bc file contents.
480 // The magic number is 0x0B17C0DE stored in little endian.
481 if (isBitcodeWrapper(BufPtr, EndBufPtr))
482 if (SkipBitcodeWrapperHeader(BufPtr, EndBufPtr))
483 return Error("Invalid bitcode wrapper header");
Daniel Dunbar80ba3d22009-09-25 16:03:57 +0000484
Chris Lattner962dde32009-04-26 20:59:02 +0000485 BitstreamReader StreamFile(BufPtr, EndBufPtr);
486 BitstreamCursor Stream(StreamFile);
Chris Lattner0370cc62009-04-27 20:04:08 +0000487 StreamFile.CollectBlockInfoNames();
Daniel Dunbar80ba3d22009-09-25 16:03:57 +0000488
Chris Lattner45e0f892007-04-29 08:12:22 +0000489 // Read the stream signature.
490 char Signature[6];
491 Signature[0] = Stream.Read(8);
492 Signature[1] = Stream.Read(8);
493 Signature[2] = Stream.Read(4);
494 Signature[3] = Stream.Read(4);
495 Signature[4] = Stream.Read(4);
496 Signature[5] = Stream.Read(4);
Daniel Dunbar80ba3d22009-09-25 16:03:57 +0000497
Chris Lattner32de6332007-04-29 08:31:14 +0000498 // Autodetect the file contents, if it is one we know.
Chris Lattner45e0f892007-04-29 08:12:22 +0000499 CurStreamType = UnknownBitstream;
500 if (Signature[0] == 'B' && Signature[1] == 'C' &&
501 Signature[2] == 0x0 && Signature[3] == 0xC &&
502 Signature[4] == 0xE && Signature[5] == 0xD)
503 CurStreamType = LLVMIRBitstream;
504
Chris Lattner4238d472007-04-29 20:00:02 +0000505 unsigned NumTopBlocks = 0;
Daniel Dunbar80ba3d22009-09-25 16:03:57 +0000506
Chris Lattner32de6332007-04-29 08:31:14 +0000507 // Parse the top-level structure. We only allow blocks at the top-level.
508 while (!Stream.AtEndOfStream()) {
509 unsigned Code = Stream.ReadCode();
510 if (Code != bitc::ENTER_SUBBLOCK)
511 return Error("Invalid record at top-level");
Daniel Dunbar80ba3d22009-09-25 16:03:57 +0000512
Chris Lattnerb30c9252007-04-29 21:48:19 +0000513 if (ParseBlock(Stream, 0))
Chris Lattner32de6332007-04-29 08:31:14 +0000514 return true;
Chris Lattner4238d472007-04-29 20:00:02 +0000515 ++NumTopBlocks;
Chris Lattner32de6332007-04-29 08:31:14 +0000516 }
Daniel Dunbar80ba3d22009-09-25 16:03:57 +0000517
Dan Gohman65f57c22009-07-15 16:35:29 +0000518 if (Dump) errs() << "\n\n";
Daniel Dunbar80ba3d22009-09-25 16:03:57 +0000519
Chris Lattnere2a466b2009-04-06 20:54:32 +0000520 uint64_t BufferSizeBits = (EndBufPtr-BufPtr)*CHAR_BIT;
Chris Lattner32de6332007-04-29 08:31:14 +0000521 // Print a summary of the read file.
Dan Gohman65f57c22009-07-15 16:35:29 +0000522 errs() << "Summary of " << InputFilename << ":\n";
523 errs() << " Total size: ";
Chris Lattner8f926682007-05-01 02:43:46 +0000524 PrintSize(BufferSizeBits);
Dan Gohman65f57c22009-07-15 16:35:29 +0000525 errs() << "\n";
526 errs() << " Stream type: ";
Chris Lattner45e0f892007-04-29 08:12:22 +0000527 switch (CurStreamType) {
528 default: assert(0 && "Unknown bitstream type");
Dan Gohman65f57c22009-07-15 16:35:29 +0000529 case UnknownBitstream: errs() << "unknown\n"; break;
530 case LLVMIRBitstream: errs() << "LLVM IR\n"; break;
Chris Lattner45e0f892007-04-29 08:12:22 +0000531 }
Dan Gohman65f57c22009-07-15 16:35:29 +0000532 errs() << " # Toplevel Blocks: " << NumTopBlocks << "\n";
533 errs() << "\n";
Chris Lattner4238d472007-04-29 20:00:02 +0000534
535 // Emit per-block stats.
Dan Gohman65f57c22009-07-15 16:35:29 +0000536 errs() << "Per-block Summary:\n";
Chris Lattner4238d472007-04-29 20:00:02 +0000537 for (std::map<unsigned, PerBlockIDStats>::iterator I = BlockIDStats.begin(),
538 E = BlockIDStats.end(); I != E; ++I) {
Dan Gohman65f57c22009-07-15 16:35:29 +0000539 errs() << " Block ID #" << I->first;
Chris Lattnerf9a3ec82009-04-26 22:21:57 +0000540 if (const char *BlockName = GetBlockName(I->first, StreamFile))
Dan Gohman65f57c22009-07-15 16:35:29 +0000541 errs() << " (" << BlockName << ")";
542 errs() << ":\n";
Daniel Dunbar80ba3d22009-09-25 16:03:57 +0000543
Chris Lattner4238d472007-04-29 20:00:02 +0000544 const PerBlockIDStats &Stats = I->second;
Dan Gohman65f57c22009-07-15 16:35:29 +0000545 errs() << " Num Instances: " << Stats.NumInstances << "\n";
546 errs() << " Total Size: ";
Chris Lattner4238d472007-04-29 20:00:02 +0000547 PrintSize(Stats.NumBits);
Dan Gohman65f57c22009-07-15 16:35:29 +0000548 errs() << "\n";
549 errs() << " % of file: "
550 << Stats.NumBits/(double)BufferSizeBits*100 << "\n";
Chris Lattnerb1e85b52007-05-05 01:46:49 +0000551 if (Stats.NumInstances > 1) {
Dan Gohman65f57c22009-07-15 16:35:29 +0000552 errs() << " Average Size: ";
Chris Lattnerb1e85b52007-05-05 01:46:49 +0000553 PrintSize(Stats.NumBits/(double)Stats.NumInstances);
Dan Gohman65f57c22009-07-15 16:35:29 +0000554 errs() << "\n";
555 errs() << " Tot/Avg SubBlocks: " << Stats.NumSubBlocks << "/"
556 << Stats.NumSubBlocks/(double)Stats.NumInstances << "\n";
557 errs() << " Tot/Avg Abbrevs: " << Stats.NumAbbrevs << "/"
558 << Stats.NumAbbrevs/(double)Stats.NumInstances << "\n";
559 errs() << " Tot/Avg Records: " << Stats.NumRecords << "/"
560 << Stats.NumRecords/(double)Stats.NumInstances << "\n";
Chris Lattnerb1e85b52007-05-05 01:46:49 +0000561 } else {
Dan Gohman65f57c22009-07-15 16:35:29 +0000562 errs() << " Num SubBlocks: " << Stats.NumSubBlocks << "\n";
563 errs() << " Num Abbrevs: " << Stats.NumAbbrevs << "\n";
564 errs() << " Num Records: " << Stats.NumRecords << "\n";
Chris Lattnerb1e85b52007-05-05 01:46:49 +0000565 }
Chris Lattner1772b122007-05-05 00:17:42 +0000566 if (Stats.NumRecords)
Dan Gohman65f57c22009-07-15 16:35:29 +0000567 errs() << " % Abbrev Recs: " << (Stats.NumAbbreviatedRecords/
568 (double)Stats.NumRecords)*100 << "\n";
569 errs() << "\n";
Daniel Dunbar80ba3d22009-09-25 16:03:57 +0000570
Chris Lattnerb1e85b52007-05-05 01:46:49 +0000571 // Print a histogram of the codes we see.
572 if (!NoHistogram && !Stats.CodeFreq.empty()) {
573 std::vector<std::pair<unsigned, unsigned> > FreqPairs; // <freq,code>
574 for (unsigned i = 0, e = Stats.CodeFreq.size(); i != e; ++i)
Chris Lattner24437472009-04-27 17:59:34 +0000575 if (unsigned Freq = Stats.CodeFreq[i].NumInstances)
Chris Lattnerb1e85b52007-05-05 01:46:49 +0000576 FreqPairs.push_back(std::make_pair(Freq, i));
577 std::stable_sort(FreqPairs.begin(), FreqPairs.end());
578 std::reverse(FreqPairs.begin(), FreqPairs.end());
Daniel Dunbar80ba3d22009-09-25 16:03:57 +0000579
Dan Gohman65f57c22009-07-15 16:35:29 +0000580 errs() << "\tRecord Histogram:\n";
Chris Lattnerc167cac2009-04-27 18:15:27 +0000581 fprintf(stderr, "\t\t Count # Bits %% Abv Record Kind\n");
Chris Lattnerb1e85b52007-05-05 01:46:49 +0000582 for (unsigned i = 0, e = FreqPairs.size(); i != e; ++i) {
Chris Lattnerc167cac2009-04-27 18:15:27 +0000583 const PerRecordStats &RecStats = Stats.CodeFreq[FreqPairs[i].second];
Daniel Dunbar80ba3d22009-09-25 16:03:57 +0000584
Chris Lattnerc167cac2009-04-27 18:15:27 +0000585 fprintf(stderr, "\t\t%7d %9llu ", RecStats.NumInstances,
Dan Gohmanfbccdef2009-05-01 16:33:33 +0000586 (unsigned long long)RecStats.TotalBits);
Daniel Dunbar80ba3d22009-09-25 16:03:57 +0000587
Chris Lattnerc167cac2009-04-27 18:15:27 +0000588 if (RecStats.NumAbbrev)
589 fprintf(stderr, "%7.2f ",
590 (double)RecStats.NumAbbrev/RecStats.NumInstances*100);
591 else
592 fprintf(stderr, " ");
Daniel Dunbar80ba3d22009-09-25 16:03:57 +0000593
594 if (const char *CodeName =
Chris Lattnerf9a3ec82009-04-26 22:21:57 +0000595 GetCodeName(FreqPairs[i].second, I->first, StreamFile))
Chris Lattner24437472009-04-27 17:59:34 +0000596 fprintf(stderr, "%s\n", CodeName);
Chris Lattnerb1e85b52007-05-05 01:46:49 +0000597 else
Chris Lattner24437472009-04-27 17:59:34 +0000598 fprintf(stderr, "UnknownCode%d\n", FreqPairs[i].second);
Chris Lattnerb1e85b52007-05-05 01:46:49 +0000599 }
Dan Gohman65f57c22009-07-15 16:35:29 +0000600 errs() << "\n";
Daniel Dunbar80ba3d22009-09-25 16:03:57 +0000601
Chris Lattnerb1e85b52007-05-05 01:46:49 +0000602 }
Chris Lattner4238d472007-04-29 20:00:02 +0000603 }
Chris Lattner45e0f892007-04-29 08:12:22 +0000604 return 0;
605}
Reid Spencerdac69c82004-06-07 17:53:43 +0000606
Chris Lattner32de6332007-04-29 08:31:14 +0000607
Chris Lattnerc30598b2006-12-06 01:18:01 +0000608int main(int argc, char **argv) {
Chris Lattnercc14d252009-03-06 05:34:10 +0000609 // Print a stack trace if we signal out.
Chris Lattner45e0f892007-04-29 08:12:22 +0000610 sys::PrintStackTraceOnErrorSignal();
Chris Lattnercc14d252009-03-06 05:34:10 +0000611 PrettyStackTraceProgram X(argc, argv);
612 llvm_shutdown_obj Y; // Call llvm_shutdown() on exit.
613 cl::ParseCommandLineOptions(argc, argv, "llvm-bcanalyzer file analyzer\n");
Daniel Dunbar80ba3d22009-09-25 16:03:57 +0000614
Chris Lattner44dadff2007-05-06 09:29:57 +0000615 return AnalyzeBitcode();
Reid Spencerdac69c82004-06-07 17:53:43 +0000616}