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