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