llvm-bcanalyzer.cpp revision 212793 
1//===-- llvm-bcanalyzer.cpp - Bitcode Analyzer --------------------------===//
2//
3//                     The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9//
10// This tool may be invoked in the following manner:
11//  llvm-bcanalyzer [options]      - Read LLVM bitcode from stdin
12//  llvm-bcanalyzer [options] x.bc - Read LLVM bitcode from the x.bc file
13//
14//  Options:
15//      --help      - Output information about command line switches
16//      --dump      - Dump low-level bitcode structure in readable format
17//
18// 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
21// statistics about the contents of the file. By default this information is
22// detailed and contains information about individual bitcode blocks and the
23// functions in the module.
24// The tool is also able to print a bitcode file in a straight forward text
25// format that shows the containment and relationships of the information in
26// the bitcode file (-dump option).
27//
28//===----------------------------------------------------------------------===//
29
30#include "llvm/Analysis/Verifier.h"
31#include "llvm/Bitcode/BitstreamReader.h"
32#include "llvm/Bitcode/LLVMBitCodes.h"
33#include "llvm/Bitcode/ReaderWriter.h"
34#include "llvm/Support/CommandLine.h"
35#include "llvm/Support/Format.h"
36#include "llvm/Support/ManagedStatic.h"
37#include "llvm/Support/MemoryBuffer.h"
38#include "llvm/Support/PrettyStackTrace.h"
39#include "llvm/Support/raw_ostream.h"
40#include "llvm/System/Signals.h"
41#include <cstdio>
42#include <map>
43#include <algorithm>
44using namespace llvm;
45
46static cl::opt<std::string>
47  InputFilename(cl::Positional, cl::desc("<input bitcode>"), cl::init("-"));
48
49static cl::opt<bool> Dump("dump", cl::desc("Dump low level bitcode trace"));
50
51//===----------------------------------------------------------------------===//
52// Bitcode specific analysis.
53//===----------------------------------------------------------------------===//
54
55static cl::opt<bool> NoHistogram("disable-histogram",
56                                 cl::desc("Do not print per-code histogram"));
57
58static cl::opt<bool>
59NonSymbolic("non-symbolic",
60            cl::desc("Emit numberic info in dump even if"
61                     " symbolic info is available"));
62
63/// CurStreamType - If we can sniff the flavor of this stream, we can produce
64/// better dump info.
65static enum {
66  UnknownBitstream,
67  LLVMIRBitstream
68} CurStreamType;
69
70
71/// GetBlockName - Return a symbolic block name if known, otherwise return
72/// null.
73static const char *GetBlockName(unsigned BlockID,
74                                const BitstreamReader &StreamFile) {
75  // Standard blocks for all bitcode files.
76  if (BlockID < bitc::FIRST_APPLICATION_BLOCKID) {
77    if (BlockID == bitc::BLOCKINFO_BLOCK_ID)
78      return "BLOCKINFO_BLOCK";
79    return 0;
80  }
81
82  // Check to see if we have a blockinfo record for this block, with a name.
83  if (const BitstreamReader::BlockInfo *Info =
84        StreamFile.getBlockInfo(BlockID)) {
85    if (!Info->Name.empty())
86      return Info->Name.c_str();
87  }
88
89
90  if (CurStreamType != LLVMIRBitstream) return 0;
91
92  switch (BlockID) {
93  default:                           return 0;
94  case bitc::MODULE_BLOCK_ID:        return "MODULE_BLOCK";
95  case bitc::PARAMATTR_BLOCK_ID:     return "PARAMATTR_BLOCK";
96  case bitc::TYPE_BLOCK_ID:          return "TYPE_BLOCK";
97  case bitc::CONSTANTS_BLOCK_ID:     return "CONSTANTS_BLOCK";
98  case bitc::FUNCTION_BLOCK_ID:      return "FUNCTION_BLOCK";
99  case bitc::TYPE_SYMTAB_BLOCK_ID:   return "TYPE_SYMTAB";
100  case bitc::VALUE_SYMTAB_BLOCK_ID:  return "VALUE_SYMTAB";
101  case bitc::METADATA_BLOCK_ID:      return "METADATA_BLOCK";
102  case bitc::METADATA_ATTACHMENT_ID: return "METADATA_ATTACHMENT_BLOCK";
103  }
104}
105
106/// GetCodeName - Return a symbolic code name if known, otherwise return
107/// null.
108static const char *GetCodeName(unsigned CodeID, unsigned BlockID,
109                               const BitstreamReader &StreamFile) {
110  // 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;
115      case bitc::BLOCKINFO_CODE_SETBID:        return "SETBID";
116      case bitc::BLOCKINFO_CODE_BLOCKNAME:     return "BLOCKNAME";
117      case bitc::BLOCKINFO_CODE_SETRECORDNAME: return "SETRECORDNAME";
118      }
119    }
120    return 0;
121  }
122
123  // 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
132  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";
149    case bitc::MODULE_CODE_GCNAME:      return "GCNAME";
150    }
151  case bitc::PARAMATTR_BLOCK_ID:
152    switch (CodeID) {
153    default: return 0;
154    case bitc::PARAMATTR_CODE_ENTRY: return "ENTRY";
155    }
156  case bitc::TYPE_BLOCK_ID:
157    switch (CodeID) {
158    default: return 0;
159    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";
174    case bitc::TYPE_CODE_METADATA:  return "METADATA";
175    }
176
177  case bitc::CONSTANTS_BLOCK_ID:
178    switch (CodeID) {
179    default: return 0;
180    case bitc::CST_CODE_SETTYPE:         return "SETTYPE";
181    case bitc::CST_CODE_NULL:            return "NULL";
182    case bitc::CST_CODE_UNDEF:           return "UNDEF";
183    case bitc::CST_CODE_INTEGER:         return "INTEGER";
184    case bitc::CST_CODE_WIDE_INTEGER:    return "WIDE_INTEGER";
185    case bitc::CST_CODE_FLOAT:           return "FLOAT";
186    case bitc::CST_CODE_AGGREGATE:       return "AGGREGATE";
187    case bitc::CST_CODE_STRING:          return "STRING";
188    case bitc::CST_CODE_CSTRING:         return "CSTRING";
189    case bitc::CST_CODE_CE_BINOP:        return "CE_BINOP";
190    case bitc::CST_CODE_CE_CAST:         return "CE_CAST";
191    case bitc::CST_CODE_CE_GEP:          return "CE_GEP";
192    case bitc::CST_CODE_CE_INBOUNDS_GEP: return "CE_INBOUNDS_GEP";
193    case bitc::CST_CODE_CE_SELECT:       return "CE_SELECT";
194    case bitc::CST_CODE_CE_EXTRACTELT:   return "CE_EXTRACTELT";
195    case bitc::CST_CODE_CE_INSERTELT:    return "CE_INSERTELT";
196    case bitc::CST_CODE_CE_SHUFFLEVEC:   return "CE_SHUFFLEVEC";
197    case bitc::CST_CODE_CE_CMP:          return "CE_CMP";
198    case bitc::CST_CODE_INLINEASM:       return "INLINEASM";
199    case bitc::CST_CODE_CE_SHUFVEC_EX:   return "CE_SHUFVEC_EX";
200    }
201  case bitc::FUNCTION_BLOCK_ID:
202    switch (CodeID) {
203    default: return 0;
204    case bitc::FUNC_CODE_DECLAREBLOCKS: return "DECLAREBLOCKS";
205
206    case bitc::FUNC_CODE_INST_BINOP:        return "INST_BINOP";
207    case bitc::FUNC_CODE_INST_CAST:         return "INST_CAST";
208    case bitc::FUNC_CODE_INST_GEP:          return "INST_GEP";
209    case bitc::FUNC_CODE_INST_INBOUNDS_GEP: return "INST_INBOUNDS_GEP";
210    case bitc::FUNC_CODE_INST_SELECT:       return "INST_SELECT";
211    case bitc::FUNC_CODE_INST_EXTRACTELT:   return "INST_EXTRACTELT";
212    case bitc::FUNC_CODE_INST_INSERTELT:    return "INST_INSERTELT";
213    case bitc::FUNC_CODE_INST_SHUFFLEVEC:   return "INST_SHUFFLEVEC";
214    case bitc::FUNC_CODE_INST_CMP:          return "INST_CMP";
215
216    case bitc::FUNC_CODE_INST_RET:          return "INST_RET";
217    case bitc::FUNC_CODE_INST_BR:           return "INST_BR";
218    case bitc::FUNC_CODE_INST_SWITCH:       return "INST_SWITCH";
219    case bitc::FUNC_CODE_INST_INVOKE:       return "INST_INVOKE";
220    case bitc::FUNC_CODE_INST_UNWIND:       return "INST_UNWIND";
221    case bitc::FUNC_CODE_INST_UNREACHABLE:  return "INST_UNREACHABLE";
222
223    case bitc::FUNC_CODE_INST_PHI:          return "INST_PHI";
224    case bitc::FUNC_CODE_INST_MALLOC:       return "INST_MALLOC";
225    case bitc::FUNC_CODE_INST_FREE:         return "INST_FREE";
226    case bitc::FUNC_CODE_INST_ALLOCA:       return "INST_ALLOCA";
227    case bitc::FUNC_CODE_INST_LOAD:         return "INST_LOAD";
228    case bitc::FUNC_CODE_INST_STORE:        return "INST_STORE";
229    case bitc::FUNC_CODE_INST_CALL:         return "INST_CALL";
230    case bitc::FUNC_CODE_INST_VAARG:        return "INST_VAARG";
231    case bitc::FUNC_CODE_INST_STORE2:       return "INST_STORE2";
232    case bitc::FUNC_CODE_INST_GETRESULT:    return "INST_GETRESULT";
233    case bitc::FUNC_CODE_INST_EXTRACTVAL:   return "INST_EXTRACTVAL";
234    case bitc::FUNC_CODE_INST_INSERTVAL:    return "INST_INSERTVAL";
235    case bitc::FUNC_CODE_INST_CMP2:         return "INST_CMP2";
236    case bitc::FUNC_CODE_INST_VSELECT:      return "INST_VSELECT";
237    case bitc::FUNC_CODE_DEBUG_LOC:         return "DEBUG_LOC";
238    case bitc::FUNC_CODE_DEBUG_LOC_AGAIN:   return "DEBUG_LOC_AGAIN";
239    case bitc::FUNC_CODE_INST_CALL2:        return "INST_CALL2";
240    case bitc::FUNC_CODE_DEBUG_LOC2:        return "DEBUG_LOC2";
241    }
242  case bitc::TYPE_SYMTAB_BLOCK_ID:
243    switch (CodeID) {
244    default: return 0;
245    case bitc::TST_CODE_ENTRY: return "ENTRY";
246    }
247  case bitc::VALUE_SYMTAB_BLOCK_ID:
248    switch (CodeID) {
249    default: return 0;
250    case bitc::VST_CODE_ENTRY: return "ENTRY";
251    case bitc::VST_CODE_BBENTRY: return "BBENTRY";
252    }
253  case bitc::METADATA_ATTACHMENT_ID:
254    switch(CodeID) {
255    default:return 0;
256    case bitc::METADATA_ATTACHMENT:  return "METADATA_ATTACHMENT";
257    }
258  case bitc::METADATA_BLOCK_ID:
259    switch(CodeID) {
260    default:return 0;
261    case bitc::METADATA_STRING:      return "METADATA_STRING";
262    case bitc::METADATA_NODE:        return "METADATA_NODE";
263    case bitc::METADATA_FN_NODE:     return "METADATA_FN_NODE";
264    case bitc::METADATA_NAME:        return "METADATA_NAME";
265    case bitc::METADATA_NAMED_NODE:  return "METADATA_NAMED_NODE";
266    case bitc::METADATA_KIND:        return "METADATA_KIND";
267    case bitc::METADATA_ATTACHMENT:  return "METADATA_ATTACHMENT";
268    case bitc::METADATA_NODE2:       return "METADATA_NODE2";
269    case bitc::METADATA_FN_NODE2:    return "METADATA_FN_NODE2";
270    case bitc::METADATA_NAMED_NODE2: return "METADATA_NAMED_NODE2";
271    case bitc::METADATA_ATTACHMENT2: return "METADATA_ATTACHMENT2";
272    }
273  }
274}
275
276struct PerRecordStats {
277  unsigned NumInstances;
278  unsigned NumAbbrev;
279  uint64_t TotalBits;
280
281  PerRecordStats() : NumInstances(0), NumAbbrev(0), TotalBits(0) {}
282};
283
284struct PerBlockIDStats {
285  /// NumInstances - This the number of times this block ID has been seen.
286  unsigned NumInstances;
287
288  /// NumBits - The total size in bits of all of these blocks.
289  uint64_t NumBits;
290
291  /// NumSubBlocks - The total number of blocks these blocks contain.
292  unsigned NumSubBlocks;
293
294  /// NumAbbrevs - The total number of abbreviations.
295  unsigned NumAbbrevs;
296
297  /// NumRecords - The total number of records these blocks contain, and the
298  /// number that are abbreviated.
299  unsigned NumRecords, NumAbbreviatedRecords;
300
301  /// CodeFreq - Keep track of the number of times we see each code.
302  std::vector<PerRecordStats> CodeFreq;
303
304  PerBlockIDStats()
305    : NumInstances(0), NumBits(0),
306      NumSubBlocks(0), NumAbbrevs(0), NumRecords(0), NumAbbreviatedRecords(0) {}
307};
308
309static std::map<unsigned, PerBlockIDStats> BlockIDStats;
310
311
312
313/// Error - All bitcode analysis errors go through this function, making this a
314/// good place to breakpoint if debugging.
315static bool Error(const std::string &Err) {
316  errs() << Err << "\n";
317  return true;
318}
319
320/// ParseBlock - Read a block, updating statistics, etc.
321static bool ParseBlock(BitstreamCursor &Stream, unsigned IndentLevel) {
322  std::string Indent(IndentLevel*2, ' ');
323  uint64_t BlockBitStart = Stream.GetCurrentBitNo();
324  unsigned BlockID = Stream.ReadSubBlockID();
325
326  // Get the statistics for this BlockID.
327  PerBlockIDStats &BlockStats = BlockIDStats[BlockID];
328
329  BlockStats.NumInstances++;
330
331  // BLOCKINFO is a special part of the stream.
332  if (BlockID == bitc::BLOCKINFO_BLOCK_ID) {
333    if (Dump) errs() << Indent << "<BLOCKINFO_BLOCK/>\n";
334    if (Stream.ReadBlockInfoBlock())
335      return Error("Malformed BlockInfoBlock");
336    uint64_t BlockBitEnd = Stream.GetCurrentBitNo();
337    BlockStats.NumBits += BlockBitEnd-BlockBitStart;
338    return false;
339  }
340
341  unsigned NumWords = 0;
342  if (Stream.EnterSubBlock(BlockID, &NumWords))
343    return Error("Malformed block record");
344
345  const char *BlockName = 0;
346  if (Dump) {
347    errs() << Indent << "<";
348    if ((BlockName = GetBlockName(BlockID, *Stream.getBitStreamReader())))
349      errs() << BlockName;
350    else
351      errs() << "UnknownBlock" << BlockID;
352
353    if (NonSymbolic && BlockName)
354      errs() << " BlockID=" << BlockID;
355
356    errs() << " NumWords=" << NumWords
357           << " BlockCodeSize=" << Stream.GetAbbrevIDWidth() << ">\n";
358  }
359
360  SmallVector<uint64_t, 64> Record;
361
362  // Read all the records for this block.
363  while (1) {
364    if (Stream.AtEndOfStream())
365      return Error("Premature end of bitstream");
366
367    uint64_t RecordStartBit = Stream.GetCurrentBitNo();
368
369    // Read the code for this record.
370    unsigned AbbrevID = Stream.ReadCode();
371    switch (AbbrevID) {
372    case bitc::END_BLOCK: {
373      if (Stream.ReadBlockEnd())
374        return Error("Error at end of block");
375      uint64_t BlockBitEnd = Stream.GetCurrentBitNo();
376      BlockStats.NumBits += BlockBitEnd-BlockBitStart;
377      if (Dump) {
378        errs() << Indent << "</";
379        if (BlockName)
380          errs() << BlockName << ">\n";
381        else
382          errs() << "UnknownBlock" << BlockID << ">\n";
383      }
384      return false;
385    }
386    case bitc::ENTER_SUBBLOCK: {
387      uint64_t SubBlockBitStart = Stream.GetCurrentBitNo();
388      if (ParseBlock(Stream, IndentLevel+1))
389        return true;
390      ++BlockStats.NumSubBlocks;
391      uint64_t SubBlockBitEnd = Stream.GetCurrentBitNo();
392
393      // Don't include subblock sizes in the size of this block.
394      BlockBitStart += SubBlockBitEnd-SubBlockBitStart;
395      break;
396    }
397    case bitc::DEFINE_ABBREV:
398      Stream.ReadAbbrevRecord();
399      ++BlockStats.NumAbbrevs;
400      break;
401    default:
402      Record.clear();
403
404      ++BlockStats.NumRecords;
405      if (AbbrevID != bitc::UNABBREV_RECORD)
406        ++BlockStats.NumAbbreviatedRecords;
407
408      const char *BlobStart = 0;
409      unsigned BlobLen = 0;
410      unsigned Code = Stream.ReadRecord(AbbrevID, Record, BlobStart, BlobLen);
411
412
413
414      // Increment the # occurrences of this code.
415      if (BlockStats.CodeFreq.size() <= Code)
416        BlockStats.CodeFreq.resize(Code+1);
417      BlockStats.CodeFreq[Code].NumInstances++;
418      BlockStats.CodeFreq[Code].TotalBits +=
419        Stream.GetCurrentBitNo()-RecordStartBit;
420      if (AbbrevID != bitc::UNABBREV_RECORD)
421        BlockStats.CodeFreq[Code].NumAbbrev++;
422
423      if (Dump) {
424        errs() << Indent << "  <";
425        if (const char *CodeName =
426              GetCodeName(Code, BlockID, *Stream.getBitStreamReader()))
427          errs() << CodeName;
428        else
429          errs() << "UnknownCode" << Code;
430        if (NonSymbolic &&
431            GetCodeName(Code, BlockID, *Stream.getBitStreamReader()))
432          errs() << " codeid=" << Code;
433        if (AbbrevID != bitc::UNABBREV_RECORD)
434          errs() << " abbrevid=" << AbbrevID;
435
436        for (unsigned i = 0, e = Record.size(); i != e; ++i)
437          errs() << " op" << i << "=" << (int64_t)Record[i];
438
439        errs() << "/>";
440
441        if (BlobStart) {
442          errs() << " blob data = ";
443          bool BlobIsPrintable = true;
444          for (unsigned i = 0; i != BlobLen; ++i)
445            if (!isprint(BlobStart[i])) {
446              BlobIsPrintable = false;
447              break;
448            }
449
450          if (BlobIsPrintable)
451            errs() << "'" << std::string(BlobStart, BlobStart+BlobLen) <<"'";
452          else
453            errs() << "unprintable, " << BlobLen << " bytes.";
454        }
455
456        errs() << "\n";
457      }
458
459      break;
460    }
461  }
462}
463
464static void PrintSize(double Bits) {
465  fprintf(stderr, "%.2f/%.2fB/%lluW", Bits, Bits/8,(unsigned long long)Bits/32);
466}
467static void PrintSize(uint64_t Bits) {
468  fprintf(stderr, "%llub/%.2fB/%lluW", (unsigned long long)Bits,
469          (double)Bits/8, (unsigned long long)Bits/32);
470}
471
472
473/// AnalyzeBitcode - Analyze the bitcode file specified by InputFilename.
474static int AnalyzeBitcode() {
475  // Read the input file.
476  MemoryBuffer *MemBuf = MemoryBuffer::getFileOrSTDIN(InputFilename.c_str());
477
478  if (MemBuf == 0)
479    return Error("Error reading '" + InputFilename + "'.");
480
481  if (MemBuf->getBufferSize() & 3)
482    return Error("Bitcode stream should be a multiple of 4 bytes in length");
483
484  unsigned char *BufPtr = (unsigned char *)MemBuf->getBufferStart();
485  unsigned char *EndBufPtr = BufPtr+MemBuf->getBufferSize();
486
487  // If we have a wrapper header, parse it and ignore the non-bc file contents.
488  // The magic number is 0x0B17C0DE stored in little endian.
489  if (isBitcodeWrapper(BufPtr, EndBufPtr))
490    if (SkipBitcodeWrapperHeader(BufPtr, EndBufPtr))
491      return Error("Invalid bitcode wrapper header");
492
493  BitstreamReader StreamFile(BufPtr, EndBufPtr);
494  BitstreamCursor Stream(StreamFile);
495  StreamFile.CollectBlockInfoNames();
496
497  // Read the stream signature.
498  char Signature[6];
499  Signature[0] = Stream.Read(8);
500  Signature[1] = Stream.Read(8);
501  Signature[2] = Stream.Read(4);
502  Signature[3] = Stream.Read(4);
503  Signature[4] = Stream.Read(4);
504  Signature[5] = Stream.Read(4);
505
506  // Autodetect the file contents, if it is one we know.
507  CurStreamType = UnknownBitstream;
508  if (Signature[0] == 'B' && Signature[1] == 'C' &&
509      Signature[2] == 0x0 && Signature[3] == 0xC &&
510      Signature[4] == 0xE && Signature[5] == 0xD)
511    CurStreamType = LLVMIRBitstream;
512
513  unsigned NumTopBlocks = 0;
514
515  // Parse the top-level structure.  We only allow blocks at the top-level.
516  while (!Stream.AtEndOfStream()) {
517    unsigned Code = Stream.ReadCode();
518    if (Code != bitc::ENTER_SUBBLOCK)
519      return Error("Invalid record at top-level");
520
521    if (ParseBlock(Stream, 0))
522      return true;
523    ++NumTopBlocks;
524  }
525
526  if (Dump) errs() << "\n\n";
527
528  uint64_t BufferSizeBits = (EndBufPtr-BufPtr)*CHAR_BIT;
529  // Print a summary of the read file.
530  errs() << "Summary of " << InputFilename << ":\n";
531  errs() << "         Total size: ";
532  PrintSize(BufferSizeBits);
533  errs() << "\n";
534  errs() << "        Stream type: ";
535  switch (CurStreamType) {
536  default: assert(0 && "Unknown bitstream type");
537  case UnknownBitstream: errs() << "unknown\n"; break;
538  case LLVMIRBitstream:  errs() << "LLVM IR\n"; break;
539  }
540  errs() << "  # Toplevel Blocks: " << NumTopBlocks << "\n";
541  errs() << "\n";
542
543  // Emit per-block stats.
544  errs() << "Per-block Summary:\n";
545  for (std::map<unsigned, PerBlockIDStats>::iterator I = BlockIDStats.begin(),
546       E = BlockIDStats.end(); I != E; ++I) {
547    errs() << "  Block ID #" << I->first;
548    if (const char *BlockName = GetBlockName(I->first, StreamFile))
549      errs() << " (" << BlockName << ")";
550    errs() << ":\n";
551
552    const PerBlockIDStats &Stats = I->second;
553    errs() << "      Num Instances: " << Stats.NumInstances << "\n";
554    errs() << "         Total Size: ";
555    PrintSize(Stats.NumBits);
556    errs() << "\n";
557    double pct = (Stats.NumBits * 100.0) / BufferSizeBits;
558    errs() << "    Percent of file: " << format("%2.4f%%", pct) << "\n";
559    if (Stats.NumInstances > 1) {
560      errs() << "       Average Size: ";
561      PrintSize(Stats.NumBits/(double)Stats.NumInstances);
562      errs() << "\n";
563      errs() << "  Tot/Avg SubBlocks: " << Stats.NumSubBlocks << "/"
564             << Stats.NumSubBlocks/(double)Stats.NumInstances << "\n";
565      errs() << "    Tot/Avg Abbrevs: " << Stats.NumAbbrevs << "/"
566             << Stats.NumAbbrevs/(double)Stats.NumInstances << "\n";
567      errs() << "    Tot/Avg Records: " << Stats.NumRecords << "/"
568             << Stats.NumRecords/(double)Stats.NumInstances << "\n";
569    } else {
570      errs() << "      Num SubBlocks: " << Stats.NumSubBlocks << "\n";
571      errs() << "        Num Abbrevs: " << Stats.NumAbbrevs << "\n";
572      errs() << "        Num Records: " << Stats.NumRecords << "\n";
573    }
574    if (Stats.NumRecords) {
575      double pct = (Stats.NumAbbreviatedRecords * 100.0) / Stats.NumRecords;
576      errs() << "    Percent Abbrevs: " << format("%2.4f%%", pct) << "\n";
577    }
578    errs() << "\n";
579
580    // Print a histogram of the codes we see.
581    if (!NoHistogram && !Stats.CodeFreq.empty()) {
582      std::vector<std::pair<unsigned, unsigned> > FreqPairs;  // <freq,code>
583      for (unsigned i = 0, e = Stats.CodeFreq.size(); i != e; ++i)
584        if (unsigned Freq = Stats.CodeFreq[i].NumInstances)
585          FreqPairs.push_back(std::make_pair(Freq, i));
586      std::stable_sort(FreqPairs.begin(), FreqPairs.end());
587      std::reverse(FreqPairs.begin(), FreqPairs.end());
588
589      errs() << "\tRecord Histogram:\n";
590      fprintf(stderr, "\t\t  Count    # Bits   %% Abv  Record Kind\n");
591      for (unsigned i = 0, e = FreqPairs.size(); i != e; ++i) {
592        const PerRecordStats &RecStats = Stats.CodeFreq[FreqPairs[i].second];
593
594        fprintf(stderr, "\t\t%7d %9llu ", RecStats.NumInstances,
595                (unsigned long long)RecStats.TotalBits);
596
597        if (RecStats.NumAbbrev)
598          fprintf(stderr, "%7.2f  ",
599                  (double)RecStats.NumAbbrev/RecStats.NumInstances*100);
600        else
601          fprintf(stderr, "         ");
602
603        if (const char *CodeName =
604              GetCodeName(FreqPairs[i].second, I->first, StreamFile))
605          fprintf(stderr, "%s\n", CodeName);
606        else
607          fprintf(stderr, "UnknownCode%d\n", FreqPairs[i].second);
608      }
609      errs() << "\n";
610
611    }
612  }
613  return 0;
614}
615
616
617int main(int argc, char **argv) {
618  // Print a stack trace if we signal out.
619  sys::PrintStackTraceOnErrorSignal();
620  PrettyStackTraceProgram X(argc, argv);
621  llvm_shutdown_obj Y;  // Call llvm_shutdown() on exit.
622  cl::ParseCommandLineOptions(argc, argv, "llvm-bcanalyzer file analyzer\n");
623
624  return AnalyzeBitcode();
625}
626