blob: 1c8e12deb46fb615cb78912d82a6906885c4d730 [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
Chris Lattner44dadff2007-05-06 09:29: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"
Reid Spencerdac69c82004-06-07 17:53:43 +000038#include "llvm/System/Signals.h"
Chris Lattner44dadff2007-05-06 09:29:57 +000039#include <map>
Reid Spencerdac69c82004-06-07 17:53:43 +000040#include <fstream>
41#include <iostream>
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
Chris Lattner45e0f892007-04-29 08:12:22 +000065/// CurStreamType - If we can sniff the flavor of this stream, we can produce
66/// 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 }
83
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 }
90
91
Chris Lattnerb30c9252007-04-29 21:48:19 +000092 if (CurStreamType != LLVMIRBitstream) return 0;
Chris Lattner4238d472007-04-29 20:00:02 +000093
94 switch (BlockID) {
Chris Lattnerb30c9252007-04-29 21:48:19 +000095 default: return 0;
Chris Lattner4238d472007-04-29 20:00:02 +000096 case bitc::MODULE_BLOCK_ID: return "MODULE_BLOCK";
Chris Lattnercd5b7d72007-05-04 03:01:41 +000097 case bitc::PARAMATTR_BLOCK_ID: return "PARAMATTR_BLOCK";
Chris Lattner4238d472007-04-29 20:00:02 +000098 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 }
104}
105
Chris Lattnerb30c9252007-04-29 21:48:19 +0000106/// GetCodeName - Return a symbolic code name if known, otherwise return
107/// null.
Chris Lattnerf9a3ec82009-04-26 22:21:57 +0000108static const char *GetCodeName(unsigned CodeID, unsigned BlockID,
109 const BitstreamReader &StreamFile) {
Chris Lattner1772b122007-05-05 00:17:42 +0000110 // Standard blocks for all bitcode files.
111 if (BlockID < bitc::FIRST_APPLICATION_BLOCKID) {
112 if (BlockID == bitc::BLOCKINFO_BLOCK_ID) {
113 switch (CodeID) {
114 default: return 0;
Chris Lattnerf9a3ec82009-04-26 22:21:57 +0000115 case bitc::BLOCKINFO_CODE_SETBID: return "SETBID";
116 case bitc::BLOCKINFO_CODE_BLOCKNAME: return "BLOCKNAME";
117 case bitc::BLOCKINFO_CODE_SETRECORDNAME: return "SETRECORDNAME";
Chris Lattner1772b122007-05-05 00:17:42 +0000118 }
119 }
120 return 0;
121 }
122
Chris Lattnerf9a3ec82009-04-26 22:21:57 +0000123 // Check to see if we have a blockinfo record for this record, with a name.
124 if (const BitstreamReader::BlockInfo *Info =
125 StreamFile.getBlockInfo(BlockID)) {
126 for (unsigned i = 0, e = Info->RecordNames.size(); i != e; ++i)
127 if (Info->RecordNames[i].first == CodeID)
128 return Info->RecordNames[i].second.c_str();
129 }
130
131
Chris Lattnerb30c9252007-04-29 21:48:19 +0000132 if (CurStreamType != LLVMIRBitstream) return 0;
133
134 switch (BlockID) {
135 default: return 0;
136 case bitc::MODULE_BLOCK_ID:
137 switch (CodeID) {
138 default: return 0;
139 case bitc::MODULE_CODE_VERSION: return "VERSION";
140 case bitc::MODULE_CODE_TRIPLE: return "TRIPLE";
141 case bitc::MODULE_CODE_DATALAYOUT: return "DATALAYOUT";
142 case bitc::MODULE_CODE_ASM: return "ASM";
143 case bitc::MODULE_CODE_SECTIONNAME: return "SECTIONNAME";
144 case bitc::MODULE_CODE_DEPLIB: return "DEPLIB";
145 case bitc::MODULE_CODE_GLOBALVAR: return "GLOBALVAR";
146 case bitc::MODULE_CODE_FUNCTION: return "FUNCTION";
147 case bitc::MODULE_CODE_ALIAS: return "ALIAS";
148 case bitc::MODULE_CODE_PURGEVALS: return "PURGEVALS";
Nick Lewycky82b80d92008-11-07 14:52:51 +0000149 case bitc::MODULE_CODE_GCNAME: return "GCNAME";
Chris Lattnerb30c9252007-04-29 21:48:19 +0000150 }
Chris Lattnercd5b7d72007-05-04 03:01:41 +0000151 case bitc::PARAMATTR_BLOCK_ID:
152 switch (CodeID) {
153 default: return 0;
154 case bitc::PARAMATTR_CODE_ENTRY: return "ENTRY";
155 }
Chris Lattnerb30c9252007-04-29 21:48:19 +0000156 case bitc::TYPE_BLOCK_ID:
157 switch (CodeID) {
158 default: return 0;
Nick Lewycky82b80d92008-11-07 14:52:51 +0000159 case bitc::TYPE_CODE_NUMENTRY: return "NUMENTRY";
160 case bitc::TYPE_CODE_VOID: return "VOID";
161 case bitc::TYPE_CODE_FLOAT: return "FLOAT";
162 case bitc::TYPE_CODE_DOUBLE: return "DOUBLE";
163 case bitc::TYPE_CODE_LABEL: return "LABEL";
164 case bitc::TYPE_CODE_OPAQUE: return "OPAQUE";
165 case bitc::TYPE_CODE_INTEGER: return "INTEGER";
166 case bitc::TYPE_CODE_POINTER: return "POINTER";
167 case bitc::TYPE_CODE_FUNCTION: return "FUNCTION";
168 case bitc::TYPE_CODE_STRUCT: return "STRUCT";
169 case bitc::TYPE_CODE_ARRAY: return "ARRAY";
170 case bitc::TYPE_CODE_VECTOR: return "VECTOR";
171 case bitc::TYPE_CODE_X86_FP80: return "X86_FP80";
172 case bitc::TYPE_CODE_FP128: return "FP128";
173 case bitc::TYPE_CODE_PPC_FP128: return "PPC_FP128";
Chris Lattnerb30c9252007-04-29 21:48:19 +0000174 }
175
176 case bitc::CONSTANTS_BLOCK_ID:
177 switch (CodeID) {
178 default: return 0;
179 case bitc::CST_CODE_SETTYPE: return "SETTYPE";
180 case bitc::CST_CODE_NULL: return "NULL";
181 case bitc::CST_CODE_UNDEF: return "UNDEF";
182 case bitc::CST_CODE_INTEGER: return "INTEGER";
183 case bitc::CST_CODE_WIDE_INTEGER: return "WIDE_INTEGER";
184 case bitc::CST_CODE_FLOAT: return "FLOAT";
185 case bitc::CST_CODE_AGGREGATE: return "AGGREGATE";
Chris Lattnercb3d91b2007-05-06 00:53:07 +0000186 case bitc::CST_CODE_STRING: return "STRING";
187 case bitc::CST_CODE_CSTRING: return "CSTRING";
Chris Lattnerb30c9252007-04-29 21:48:19 +0000188 case bitc::CST_CODE_CE_BINOP: return "CE_BINOP";
189 case bitc::CST_CODE_CE_CAST: return "CE_CAST";
190 case bitc::CST_CODE_CE_GEP: return "CE_GEP";
191 case bitc::CST_CODE_CE_SELECT: return "CE_SELECT";
192 case bitc::CST_CODE_CE_EXTRACTELT: return "CE_EXTRACTELT";
193 case bitc::CST_CODE_CE_INSERTELT: return "CE_INSERTELT";
194 case bitc::CST_CODE_CE_SHUFFLEVEC: return "CE_SHUFFLEVEC";
195 case bitc::CST_CODE_CE_CMP: return "CE_CMP";
Chris Lattnerc5ff2cc2007-05-06 01:50:11 +0000196 case bitc::CST_CODE_INLINEASM: return "INLINEASM";
Chris Lattnerb30c9252007-04-29 21:48:19 +0000197 }
198 case bitc::FUNCTION_BLOCK_ID:
199 switch (CodeID) {
200 default: return 0;
201 case bitc::FUNC_CODE_DECLAREBLOCKS: return "DECLAREBLOCKS";
202
203 case bitc::FUNC_CODE_INST_BINOP: return "INST_BINOP";
204 case bitc::FUNC_CODE_INST_CAST: return "INST_CAST";
205 case bitc::FUNC_CODE_INST_GEP: return "INST_GEP";
206 case bitc::FUNC_CODE_INST_SELECT: return "INST_SELECT";
207 case bitc::FUNC_CODE_INST_EXTRACTELT: return "INST_EXTRACTELT";
208 case bitc::FUNC_CODE_INST_INSERTELT: return "INST_INSERTELT";
209 case bitc::FUNC_CODE_INST_SHUFFLEVEC: return "INST_SHUFFLEVEC";
210 case bitc::FUNC_CODE_INST_CMP: return "INST_CMP";
211
212 case bitc::FUNC_CODE_INST_RET: return "INST_RET";
213 case bitc::FUNC_CODE_INST_BR: return "INST_BR";
214 case bitc::FUNC_CODE_INST_SWITCH: return "INST_SWITCH";
215 case bitc::FUNC_CODE_INST_INVOKE: return "INST_INVOKE";
216 case bitc::FUNC_CODE_INST_UNWIND: return "INST_UNWIND";
217 case bitc::FUNC_CODE_INST_UNREACHABLE: return "INST_UNREACHABLE";
218
Chris Lattner8f926682007-05-01 02:43:46 +0000219 case bitc::FUNC_CODE_INST_PHI: return "INST_PHI";
Chris Lattnerb30c9252007-04-29 21:48:19 +0000220 case bitc::FUNC_CODE_INST_MALLOC: return "INST_MALLOC";
221 case bitc::FUNC_CODE_INST_FREE: return "INST_FREE";
222 case bitc::FUNC_CODE_INST_ALLOCA: return "INST_ALLOCA";
223 case bitc::FUNC_CODE_INST_LOAD: return "INST_LOAD";
224 case bitc::FUNC_CODE_INST_STORE: return "INST_STORE";
225 case bitc::FUNC_CODE_INST_CALL: return "INST_CALL";
226 case bitc::FUNC_CODE_INST_VAARG: return "INST_VAARG";
Christopher Lambfe63fb92007-12-11 08:59:05 +0000227 case bitc::FUNC_CODE_INST_STORE2: return "INST_STORE2";
Nick Lewycky33a834a2008-03-01 21:47:06 +0000228 case bitc::FUNC_CODE_INST_GETRESULT: return "INST_GETRESULT";
Nick Lewycky82b80d92008-11-07 14:52:51 +0000229 case bitc::FUNC_CODE_INST_EXTRACTVAL: return "INST_EXTRACTVAL";
230 case bitc::FUNC_CODE_INST_INSERTVAL: return "INST_INSERTVAL";
231 case bitc::FUNC_CODE_INST_CMP2: return "INST_CMP2";
232 case bitc::FUNC_CODE_INST_VSELECT: return "INST_VSELECT";
Chris Lattnerb30c9252007-04-29 21:48:19 +0000233 }
234 case bitc::TYPE_SYMTAB_BLOCK_ID:
235 switch (CodeID) {
236 default: return 0;
237 case bitc::TST_CODE_ENTRY: return "ENTRY";
238 }
239 case bitc::VALUE_SYMTAB_BLOCK_ID:
240 switch (CodeID) {
241 default: return 0;
242 case bitc::VST_CODE_ENTRY: return "ENTRY";
Chris Lattnercd5b7d72007-05-04 03:01:41 +0000243 case bitc::VST_CODE_BBENTRY: return "BBENTRY";
Chris Lattnerb30c9252007-04-29 21:48:19 +0000244 }
245 }
246}
247
Chris Lattner24437472009-04-27 17:59:34 +0000248struct PerRecordStats {
249 unsigned NumInstances;
Chris Lattnerc167cac2009-04-27 18:15:27 +0000250 unsigned NumAbbrev;
251 uint64_t TotalBits;
252
253 PerRecordStats() : NumInstances(0), NumAbbrev(0), TotalBits(0) {}
Chris Lattner24437472009-04-27 17:59:34 +0000254};
Chris Lattner4238d472007-04-29 20:00:02 +0000255
256struct PerBlockIDStats {
257 /// NumInstances - This the number of times this block ID has been seen.
258 unsigned NumInstances;
259
260 /// NumBits - The total size in bits of all of these blocks.
261 uint64_t NumBits;
262
263 /// NumSubBlocks - The total number of blocks these blocks contain.
264 unsigned NumSubBlocks;
265
266 /// NumAbbrevs - The total number of abbreviations.
267 unsigned NumAbbrevs;
268
269 /// NumRecords - The total number of records these blocks contain, and the
270 /// number that are abbreviated.
271 unsigned NumRecords, NumAbbreviatedRecords;
272
Chris Lattnerb1e85b52007-05-05 01:46:49 +0000273 /// CodeFreq - Keep track of the number of times we see each code.
Chris Lattner24437472009-04-27 17:59:34 +0000274 std::vector<PerRecordStats> CodeFreq;
Chris Lattnerb1e85b52007-05-05 01:46:49 +0000275
Chris Lattner4238d472007-04-29 20:00:02 +0000276 PerBlockIDStats()
277 : NumInstances(0), NumBits(0),
278 NumSubBlocks(0), NumAbbrevs(0), NumRecords(0), NumAbbreviatedRecords(0) {}
279};
280
281static std::map<unsigned, PerBlockIDStats> BlockIDStats;
282
283
284
Chris Lattner32de6332007-04-29 08:31:14 +0000285/// Error - All bitcode analysis errors go through this function, making this a
286/// good place to breakpoint if debugging.
287static bool Error(const std::string &Err) {
288 std::cerr << Err << "\n";
289 return true;
290}
291
292/// ParseBlock - Read a block, updating statistics, etc.
Chris Lattner962dde32009-04-26 20:59:02 +0000293static bool ParseBlock(BitstreamCursor &Stream, unsigned IndentLevel) {
Chris Lattner1772b122007-05-05 00:17:42 +0000294 std::string Indent(IndentLevel*2, ' ');
Chris Lattner4238d472007-04-29 20:00:02 +0000295 uint64_t BlockBitStart = Stream.GetCurrentBitNo();
Chris Lattner32de6332007-04-29 08:31:14 +0000296 unsigned BlockID = Stream.ReadSubBlockID();
Chris Lattnerb30c9252007-04-29 21:48:19 +0000297
Chris Lattner4238d472007-04-29 20:00:02 +0000298 // Get the statistics for this BlockID.
299 PerBlockIDStats &BlockStats = BlockIDStats[BlockID];
300
301 BlockStats.NumInstances++;
Chris Lattner32de6332007-04-29 08:31:14 +0000302
Chris Lattner1772b122007-05-05 00:17:42 +0000303 // BLOCKINFO is a special part of the stream.
304 if (BlockID == bitc::BLOCKINFO_BLOCK_ID) {
305 if (Dump) std::cerr << Indent << "<BLOCKINFO_BLOCK/>\n";
306 if (Stream.ReadBlockInfoBlock())
307 return Error("Malformed BlockInfoBlock");
308 uint64_t BlockBitEnd = Stream.GetCurrentBitNo();
309 BlockStats.NumBits += BlockBitEnd-BlockBitStart;
310 return false;
311 }
312
Chris Lattnerb30c9252007-04-29 21:48:19 +0000313 unsigned NumWords = 0;
Chris Lattner1772b122007-05-05 00:17:42 +0000314 if (Stream.EnterSubBlock(BlockID, &NumWords))
Chris Lattner32de6332007-04-29 08:31:14 +0000315 return Error("Malformed block record");
316
Chris Lattnerb30c9252007-04-29 21:48:19 +0000317 const char *BlockName = 0;
318 if (Dump) {
319 std::cerr << Indent << "<";
Chris Lattnerf9a3ec82009-04-26 22:21:57 +0000320 if ((BlockName = GetBlockName(BlockID, *Stream.getBitStreamReader())))
Chris Lattnerb30c9252007-04-29 21:48:19 +0000321 std::cerr << BlockName;
322 else
323 std::cerr << "UnknownBlock" << BlockID;
324
325 if (NonSymbolic && BlockName)
326 std::cerr << " BlockID=" << BlockID;
327
328 std::cerr << " NumWords=" << NumWords
329 << " BlockCodeSize=" << Stream.GetAbbrevIDWidth() << ">\n";
330 }
331
Chris Lattner32de6332007-04-29 08:31:14 +0000332 SmallVector<uint64_t, 64> Record;
333
334 // Read all the records for this block.
335 while (1) {
336 if (Stream.AtEndOfStream())
337 return Error("Premature end of bitstream");
338
Chris Lattnerc167cac2009-04-27 18:15:27 +0000339 uint64_t RecordStartBit = Stream.GetCurrentBitNo();
340
Chris Lattner32de6332007-04-29 08:31:14 +0000341 // Read the code for this record.
342 unsigned AbbrevID = Stream.ReadCode();
343 switch (AbbrevID) {
Chris Lattner4238d472007-04-29 20:00:02 +0000344 case bitc::END_BLOCK: {
Chris Lattner32de6332007-04-29 08:31:14 +0000345 if (Stream.ReadBlockEnd())
346 return Error("Error at end of block");
Chris Lattner4238d472007-04-29 20:00:02 +0000347 uint64_t BlockBitEnd = Stream.GetCurrentBitNo();
348 BlockStats.NumBits += BlockBitEnd-BlockBitStart;
Chris Lattnerb30c9252007-04-29 21:48:19 +0000349 if (Dump) {
350 std::cerr << Indent << "</";
351 if (BlockName)
352 std::cerr << BlockName << ">\n";
353 else
354 std::cerr << "UnknownBlock" << BlockID << ">\n";
355 }
Chris Lattner32de6332007-04-29 08:31:14 +0000356 return false;
Chris Lattner4238d472007-04-29 20:00:02 +0000357 }
Chris Lattner44b0f102007-05-05 01:29:31 +0000358 case bitc::ENTER_SUBBLOCK: {
359 uint64_t SubBlockBitStart = Stream.GetCurrentBitNo();
Chris Lattnerb30c9252007-04-29 21:48:19 +0000360 if (ParseBlock(Stream, IndentLevel+1))
Chris Lattner32de6332007-04-29 08:31:14 +0000361 return true;
Chris Lattner4238d472007-04-29 20:00:02 +0000362 ++BlockStats.NumSubBlocks;
Chris Lattner44b0f102007-05-05 01:29:31 +0000363 uint64_t SubBlockBitEnd = Stream.GetCurrentBitNo();
364
365 // Don't include subblock sizes in the size of this block.
366 BlockBitStart += SubBlockBitEnd-SubBlockBitStart;
Chris Lattner32de6332007-04-29 08:31:14 +0000367 break;
Chris Lattner44b0f102007-05-05 01:29:31 +0000368 }
Chris Lattner32de6332007-04-29 08:31:14 +0000369 case bitc::DEFINE_ABBREV:
370 Stream.ReadAbbrevRecord();
Chris Lattner4238d472007-04-29 20:00:02 +0000371 ++BlockStats.NumAbbrevs;
Chris Lattner32de6332007-04-29 08:31:14 +0000372 break;
373 default:
374 Record.clear();
Chris Lattner3f75d312009-04-06 22:44:40 +0000375
376 ++BlockStats.NumRecords;
Chris Lattnerae7dd802009-04-07 02:56:46 +0000377 if (AbbrevID != bitc::UNABBREV_RECORD)
Chris Lattner3f75d312009-04-06 22:44:40 +0000378 ++BlockStats.NumAbbreviatedRecords;
Chris Lattner3f75d312009-04-06 22:44:40 +0000379
Chris Lattner3f75d312009-04-06 22:44:40 +0000380 const char *BlobStart = 0;
381 unsigned BlobLen = 0;
Chris Lattnerae7dd802009-04-07 02:56:46 +0000382 unsigned Code = Stream.ReadRecord(AbbrevID, Record, BlobStart, BlobLen);
Chris Lattnerb1e85b52007-05-05 01:46:49 +0000383
Chris Lattnerc167cac2009-04-27 18:15:27 +0000384
385
Chris Lattnerb1e85b52007-05-05 01:46:49 +0000386 // Increment the # occurrences of this code.
387 if (BlockStats.CodeFreq.size() <= Code)
388 BlockStats.CodeFreq.resize(Code+1);
Chris Lattner24437472009-04-27 17:59:34 +0000389 BlockStats.CodeFreq[Code].NumInstances++;
Chris Lattnerc167cac2009-04-27 18:15:27 +0000390 BlockStats.CodeFreq[Code].TotalBits +=
391 Stream.GetCurrentBitNo()-RecordStartBit;
392 if (AbbrevID != bitc::UNABBREV_RECORD)
393 BlockStats.CodeFreq[Code].NumAbbrev++;
394
Chris Lattnerb30c9252007-04-29 21:48:19 +0000395 if (Dump) {
396 std::cerr << Indent << " <";
Chris Lattnerf9a3ec82009-04-26 22:21:57 +0000397 if (const char *CodeName =
398 GetCodeName(Code, BlockID, *Stream.getBitStreamReader()))
Chris Lattnerb30c9252007-04-29 21:48:19 +0000399 std::cerr << CodeName;
400 else
401 std::cerr << "UnknownCode" << Code;
Chris Lattnerf9a3ec82009-04-26 22:21:57 +0000402 if (NonSymbolic &&
403 GetCodeName(Code, BlockID, *Stream.getBitStreamReader()))
Chris Lattnerb30c9252007-04-29 21:48:19 +0000404 std::cerr << " codeid=" << Code;
405 if (AbbrevID != bitc::UNABBREV_RECORD)
406 std::cerr << " abbrevid=" << AbbrevID;
407
408 for (unsigned i = 0, e = Record.size(); i != e; ++i)
409 std::cerr << " op" << i << "=" << (int64_t)Record[i];
410
Chris Lattnerae7dd802009-04-07 02:56:46 +0000411 std::cerr << "/>";
412
413 if (BlobStart) {
414 std::cerr << " blob data = ";
415 bool BlobIsPrintable = true;
416 for (unsigned i = 0; i != BlobLen; ++i)
417 if (!isprint(BlobStart[i])) {
418 BlobIsPrintable = false;
419 break;
420 }
421
422 if (BlobIsPrintable)
423 std::cerr << "'" << std::string(BlobStart, BlobStart+BlobLen) <<"'";
424 else
425 std::cerr << "unprintable, " << BlobLen << " bytes.";
426 }
427
428 std::cerr << "\n";
Chris Lattnerb30c9252007-04-29 21:48:19 +0000429 }
430
Chris Lattner32de6332007-04-29 08:31:14 +0000431 break;
432 }
433 }
434}
435
Chris Lattner4238d472007-04-29 20:00:02 +0000436static void PrintSize(double Bits) {
Chris Lattner24437472009-04-27 17:59:34 +0000437 fprintf(stderr, "%.2f/%.2fB/%lluW", Bits, Bits/8,(unsigned long long)Bits/32);
438}
439static void PrintSize(uint64_t Bits) {
440 fprintf(stderr, "%llub/%.2fB/%lluW", (unsigned long long)Bits,
441 (double)Bits/8, (unsigned long long)Bits/32);
Chris Lattner4238d472007-04-29 20:00:02 +0000442}
443
444
Chris Lattner45e0f892007-04-29 08:12:22 +0000445/// AnalyzeBitcode - Analyze the bitcode file specified by InputFilename.
446static int AnalyzeBitcode() {
447 // Read the input file.
Chris Lattnere2a466b2009-04-06 20:54:32 +0000448 MemoryBuffer *MemBuf = MemoryBuffer::getFileOrSTDIN(InputFilename.c_str());
Chris Lattner45e0f892007-04-29 08:12:22 +0000449
Chris Lattnere2a466b2009-04-06 20:54:32 +0000450 if (MemBuf == 0)
Chris Lattner32de6332007-04-29 08:31:14 +0000451 return Error("Error reading '" + InputFilename + "'.");
Chris Lattner45e0f892007-04-29 08:12:22 +0000452
Chris Lattnere2a466b2009-04-06 20:54:32 +0000453 if (MemBuf->getBufferSize() & 3)
Chris Lattner32de6332007-04-29 08:31:14 +0000454 return Error("Bitcode stream should be a multiple of 4 bytes in length");
Chris Lattner45e0f892007-04-29 08:12:22 +0000455
Chris Lattnere2a466b2009-04-06 20:54:32 +0000456 unsigned char *BufPtr = (unsigned char *)MemBuf->getBufferStart();
457 unsigned char *EndBufPtr = BufPtr+MemBuf->getBufferSize();
458
459 // If we have a wrapper header, parse it and ignore the non-bc file contents.
460 // The magic number is 0x0B17C0DE stored in little endian.
461 if (isBitcodeWrapper(BufPtr, EndBufPtr))
462 if (SkipBitcodeWrapperHeader(BufPtr, EndBufPtr))
463 return Error("Invalid bitcode wrapper header");
464
Chris Lattner962dde32009-04-26 20:59:02 +0000465 BitstreamReader StreamFile(BufPtr, EndBufPtr);
466 BitstreamCursor Stream(StreamFile);
Chris Lattner0370cc62009-04-27 20:04:08 +0000467 StreamFile.CollectBlockInfoNames();
Chris Lattner45e0f892007-04-29 08:12:22 +0000468
469 // Read the stream signature.
470 char Signature[6];
471 Signature[0] = Stream.Read(8);
472 Signature[1] = Stream.Read(8);
473 Signature[2] = Stream.Read(4);
474 Signature[3] = Stream.Read(4);
475 Signature[4] = Stream.Read(4);
476 Signature[5] = Stream.Read(4);
477
Chris Lattner32de6332007-04-29 08:31:14 +0000478 // Autodetect the file contents, if it is one we know.
Chris Lattner45e0f892007-04-29 08:12:22 +0000479 CurStreamType = UnknownBitstream;
480 if (Signature[0] == 'B' && Signature[1] == 'C' &&
481 Signature[2] == 0x0 && Signature[3] == 0xC &&
482 Signature[4] == 0xE && Signature[5] == 0xD)
483 CurStreamType = LLVMIRBitstream;
484
Chris Lattner4238d472007-04-29 20:00:02 +0000485 unsigned NumTopBlocks = 0;
486
Chris Lattner32de6332007-04-29 08:31:14 +0000487 // Parse the top-level structure. We only allow blocks at the top-level.
488 while (!Stream.AtEndOfStream()) {
489 unsigned Code = Stream.ReadCode();
490 if (Code != bitc::ENTER_SUBBLOCK)
491 return Error("Invalid record at top-level");
492
Chris Lattnerb30c9252007-04-29 21:48:19 +0000493 if (ParseBlock(Stream, 0))
Chris Lattner32de6332007-04-29 08:31:14 +0000494 return true;
Chris Lattner4238d472007-04-29 20:00:02 +0000495 ++NumTopBlocks;
Chris Lattner32de6332007-04-29 08:31:14 +0000496 }
497
Chris Lattnerb30c9252007-04-29 21:48:19 +0000498 if (Dump) std::cerr << "\n\n";
499
Chris Lattnere2a466b2009-04-06 20:54:32 +0000500 uint64_t BufferSizeBits = (EndBufPtr-BufPtr)*CHAR_BIT;
Chris Lattner32de6332007-04-29 08:31:14 +0000501 // Print a summary of the read file.
Chris Lattner45e0f892007-04-29 08:12:22 +0000502 std::cerr << "Summary of " << InputFilename << ":\n";
Chris Lattner4238d472007-04-29 20:00:02 +0000503 std::cerr << " Total size: ";
Chris Lattner8f926682007-05-01 02:43:46 +0000504 PrintSize(BufferSizeBits);
Chris Lattner4238d472007-04-29 20:00:02 +0000505 std::cerr << "\n";
506 std::cerr << " Stream type: ";
Chris Lattner45e0f892007-04-29 08:12:22 +0000507 switch (CurStreamType) {
508 default: assert(0 && "Unknown bitstream type");
509 case UnknownBitstream: std::cerr << "unknown\n"; break;
510 case LLVMIRBitstream: std::cerr << "LLVM IR\n"; break;
511 }
Chris Lattner4238d472007-04-29 20:00:02 +0000512 std::cerr << " # Toplevel Blocks: " << NumTopBlocks << "\n";
513 std::cerr << "\n";
514
515 // Emit per-block stats.
516 std::cerr << "Per-block Summary:\n";
517 for (std::map<unsigned, PerBlockIDStats>::iterator I = BlockIDStats.begin(),
518 E = BlockIDStats.end(); I != E; ++I) {
519 std::cerr << " Block ID #" << I->first;
Chris Lattnerf9a3ec82009-04-26 22:21:57 +0000520 if (const char *BlockName = GetBlockName(I->first, StreamFile))
Chris Lattner4238d472007-04-29 20:00:02 +0000521 std::cerr << " (" << BlockName << ")";
522 std::cerr << ":\n";
523
524 const PerBlockIDStats &Stats = I->second;
525 std::cerr << " Num Instances: " << Stats.NumInstances << "\n";
526 std::cerr << " Total Size: ";
527 PrintSize(Stats.NumBits);
528 std::cerr << "\n";
Chris Lattner8f926682007-05-01 02:43:46 +0000529 std::cerr << " % of file: "
530 << Stats.NumBits/(double)BufferSizeBits*100 << "\n";
Chris Lattnerb1e85b52007-05-05 01:46:49 +0000531 if (Stats.NumInstances > 1) {
532 std::cerr << " Average Size: ";
533 PrintSize(Stats.NumBits/(double)Stats.NumInstances);
534 std::cerr << "\n";
535 std::cerr << " Tot/Avg SubBlocks: " << Stats.NumSubBlocks << "/"
536 << Stats.NumSubBlocks/(double)Stats.NumInstances << "\n";
537 std::cerr << " Tot/Avg Abbrevs: " << Stats.NumAbbrevs << "/"
538 << Stats.NumAbbrevs/(double)Stats.NumInstances << "\n";
539 std::cerr << " Tot/Avg Records: " << Stats.NumRecords << "/"
540 << Stats.NumRecords/(double)Stats.NumInstances << "\n";
541 } else {
542 std::cerr << " Num SubBlocks: " << Stats.NumSubBlocks << "\n";
543 std::cerr << " Num Abbrevs: " << Stats.NumAbbrevs << "\n";
544 std::cerr << " Num Records: " << Stats.NumRecords << "\n";
545 }
Chris Lattner1772b122007-05-05 00:17:42 +0000546 if (Stats.NumRecords)
547 std::cerr << " % Abbrev Recs: " << (Stats.NumAbbreviatedRecords/
548 (double)Stats.NumRecords)*100 << "\n";
Chris Lattner4238d472007-04-29 20:00:02 +0000549 std::cerr << "\n";
Chris Lattnerb1e85b52007-05-05 01:46:49 +0000550
551 // Print a histogram of the codes we see.
552 if (!NoHistogram && !Stats.CodeFreq.empty()) {
553 std::vector<std::pair<unsigned, unsigned> > FreqPairs; // <freq,code>
554 for (unsigned i = 0, e = Stats.CodeFreq.size(); i != e; ++i)
Chris Lattner24437472009-04-27 17:59:34 +0000555 if (unsigned Freq = Stats.CodeFreq[i].NumInstances)
Chris Lattnerb1e85b52007-05-05 01:46:49 +0000556 FreqPairs.push_back(std::make_pair(Freq, i));
557 std::stable_sort(FreqPairs.begin(), FreqPairs.end());
558 std::reverse(FreqPairs.begin(), FreqPairs.end());
559
Chris Lattner24437472009-04-27 17:59:34 +0000560 std::cerr << "\tRecord Histogram:\n";
Chris Lattnerc167cac2009-04-27 18:15:27 +0000561 fprintf(stderr, "\t\t Count # Bits %% Abv Record Kind\n");
Chris Lattnerb1e85b52007-05-05 01:46:49 +0000562 for (unsigned i = 0, e = FreqPairs.size(); i != e; ++i) {
Chris Lattnerc167cac2009-04-27 18:15:27 +0000563 const PerRecordStats &RecStats = Stats.CodeFreq[FreqPairs[i].second];
564
565 fprintf(stderr, "\t\t%7d %9llu ", RecStats.NumInstances,
Dan Gohmanfbccdef2009-05-01 16:33:33 +0000566 (unsigned long long)RecStats.TotalBits);
Chris Lattnerc167cac2009-04-27 18:15:27 +0000567
568 if (RecStats.NumAbbrev)
569 fprintf(stderr, "%7.2f ",
570 (double)RecStats.NumAbbrev/RecStats.NumInstances*100);
571 else
572 fprintf(stderr, " ");
Chris Lattner24437472009-04-27 17:59:34 +0000573
Chris Lattnerf9a3ec82009-04-26 22:21:57 +0000574 if (const char *CodeName =
575 GetCodeName(FreqPairs[i].second, I->first, StreamFile))
Chris Lattner24437472009-04-27 17:59:34 +0000576 fprintf(stderr, "%s\n", CodeName);
Chris Lattnerb1e85b52007-05-05 01:46:49 +0000577 else
Chris Lattner24437472009-04-27 17:59:34 +0000578 fprintf(stderr, "UnknownCode%d\n", FreqPairs[i].second);
Chris Lattnerb1e85b52007-05-05 01:46:49 +0000579 }
580 std::cerr << "\n";
581
582 }
Chris Lattner4238d472007-04-29 20:00:02 +0000583 }
Chris Lattner45e0f892007-04-29 08:12:22 +0000584 return 0;
585}
Reid Spencerdac69c82004-06-07 17:53:43 +0000586
Chris Lattner32de6332007-04-29 08:31:14 +0000587
Chris Lattnerc30598b2006-12-06 01:18:01 +0000588int main(int argc, char **argv) {
Chris Lattnercc14d252009-03-06 05:34:10 +0000589 // Print a stack trace if we signal out.
Chris Lattner45e0f892007-04-29 08:12:22 +0000590 sys::PrintStackTraceOnErrorSignal();
Chris Lattnercc14d252009-03-06 05:34:10 +0000591 PrettyStackTraceProgram X(argc, argv);
592 llvm_shutdown_obj Y; // Call llvm_shutdown() on exit.
593 cl::ParseCommandLineOptions(argc, argv, "llvm-bcanalyzer file analyzer\n");
Chris Lattner45e0f892007-04-29 08:12:22 +0000594
Chris Lattner44dadff2007-05-06 09:29:57 +0000595 return AnalyzeBitcode();
Reid Spencerdac69c82004-06-07 17:53:43 +0000596}