llvm-bcanalyzer.cpp revision 224133 
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/raw_ostream.h"
41#include "llvm/Support/Signals.h"
42#include "llvm/Support/system_error.h"
43#include <cstdio>
44#include <map>
45#include <algorithm>
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::TYPE_BLOCK_ID_OLD:      return "TYPE_BLOCK_ID_OLD";
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::TYPE_SYMTAB_BLOCK_ID_OLD: return "TYPE_SYMTAB_OLD";
110  case bitc::VALUE_SYMTAB_BLOCK_ID:  return "VALUE_SYMTAB";
111  case bitc::METADATA_BLOCK_ID:      return "METADATA_BLOCK";
112  case bitc::METADATA_ATTACHMENT_ID: return "METADATA_ATTACHMENT_BLOCK";
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";
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: return "ENTRY";
165    }
166  case bitc::TYPE_BLOCK_ID_OLD:
167  case bitc::TYPE_BLOCK_ID_NEW:
168    switch (CodeID) {
169    default: return 0;
170    case bitc::TYPE_CODE_NUMENTRY:     return "NUMENTRY";
171    case bitc::TYPE_CODE_VOID:         return "VOID";
172    case bitc::TYPE_CODE_FLOAT:        return "FLOAT";
173    case bitc::TYPE_CODE_DOUBLE:       return "DOUBLE";
174    case bitc::TYPE_CODE_LABEL:        return "LABEL";
175    case bitc::TYPE_CODE_OPAQUE:       return "OPAQUE";
176    case bitc::TYPE_CODE_INTEGER:      return "INTEGER";
177    case bitc::TYPE_CODE_POINTER:      return "POINTER";
178    case bitc::TYPE_CODE_FUNCTION:     return "FUNCTION";
179    case bitc::TYPE_CODE_STRUCT_OLD:   return "STRUCT_OLD";
180    case bitc::TYPE_CODE_ARRAY:        return "ARRAY";
181    case bitc::TYPE_CODE_VECTOR:       return "VECTOR";
182    case bitc::TYPE_CODE_X86_FP80:     return "X86_FP80";
183    case bitc::TYPE_CODE_FP128:        return "FP128";
184    case bitc::TYPE_CODE_PPC_FP128:    return "PPC_FP128";
185    case bitc::TYPE_CODE_METADATA:     return "METADATA";
186    case bitc::TYPE_CODE_STRUCT_ANON:  return "STRUCT_ANON";
187    case bitc::TYPE_CODE_STRUCT_NAME:  return "STRUCT_NAME";
188    case bitc::TYPE_CODE_STRUCT_NAMED: return "STRUCT_NAMED";
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    }
215  case bitc::FUNCTION_BLOCK_ID:
216    switch (CodeID) {
217    default: return 0;
218    case bitc::FUNC_CODE_DECLAREBLOCKS: return "DECLAREBLOCKS";
219
220    case bitc::FUNC_CODE_INST_BINOP:        return "INST_BINOP";
221    case bitc::FUNC_CODE_INST_CAST:         return "INST_CAST";
222    case bitc::FUNC_CODE_INST_GEP:          return "INST_GEP";
223    case bitc::FUNC_CODE_INST_INBOUNDS_GEP: return "INST_INBOUNDS_GEP";
224    case bitc::FUNC_CODE_INST_SELECT:       return "INST_SELECT";
225    case bitc::FUNC_CODE_INST_EXTRACTELT:   return "INST_EXTRACTELT";
226    case bitc::FUNC_CODE_INST_INSERTELT:    return "INST_INSERTELT";
227    case bitc::FUNC_CODE_INST_SHUFFLEVEC:   return "INST_SHUFFLEVEC";
228    case bitc::FUNC_CODE_INST_CMP:          return "INST_CMP";
229
230    case bitc::FUNC_CODE_INST_RET:          return "INST_RET";
231    case bitc::FUNC_CODE_INST_BR:           return "INST_BR";
232    case bitc::FUNC_CODE_INST_SWITCH:       return "INST_SWITCH";
233    case bitc::FUNC_CODE_INST_INVOKE:       return "INST_INVOKE";
234    case bitc::FUNC_CODE_INST_UNWIND:       return "INST_UNWIND";
235    case bitc::FUNC_CODE_INST_UNREACHABLE:  return "INST_UNREACHABLE";
236
237    case bitc::FUNC_CODE_INST_PHI:          return "INST_PHI";
238    case bitc::FUNC_CODE_INST_ALLOCA:       return "INST_ALLOCA";
239    case bitc::FUNC_CODE_INST_LOAD:         return "INST_LOAD";
240    case bitc::FUNC_CODE_INST_VAARG:        return "INST_VAARG";
241    case bitc::FUNC_CODE_INST_STORE:        return "INST_STORE";
242    case bitc::FUNC_CODE_INST_EXTRACTVAL:   return "INST_EXTRACTVAL";
243    case bitc::FUNC_CODE_INST_INSERTVAL:    return "INST_INSERTVAL";
244    case bitc::FUNC_CODE_INST_CMP2:         return "INST_CMP2";
245    case bitc::FUNC_CODE_INST_VSELECT:      return "INST_VSELECT";
246    case bitc::FUNC_CODE_DEBUG_LOC_AGAIN:   return "DEBUG_LOC_AGAIN";
247    case bitc::FUNC_CODE_INST_CALL:         return "INST_CALL";
248    case bitc::FUNC_CODE_DEBUG_LOC:         return "DEBUG_LOC";
249    }
250  case bitc::TYPE_SYMTAB_BLOCK_ID_OLD:
251    switch (CodeID) {
252    default: return 0;
253    case bitc::TST_CODE_ENTRY: return "ENTRY";
254    }
255  case bitc::VALUE_SYMTAB_BLOCK_ID:
256    switch (CodeID) {
257    default: return 0;
258    case bitc::VST_CODE_ENTRY: return "ENTRY";
259    case bitc::VST_CODE_BBENTRY: return "BBENTRY";
260    }
261  case bitc::METADATA_ATTACHMENT_ID:
262    switch(CodeID) {
263    default:return 0;
264    case bitc::METADATA_ATTACHMENT: return "METADATA_ATTACHMENT";
265    }
266  case bitc::METADATA_BLOCK_ID:
267    switch(CodeID) {
268    default:return 0;
269    case bitc::METADATA_STRING:      return "METADATA_STRING";
270    case bitc::METADATA_NAME:        return "METADATA_NAME";
271    case bitc::METADATA_KIND:        return "METADATA_KIND";
272    case bitc::METADATA_NODE:        return "METADATA_NODE";
273    case bitc::METADATA_FN_NODE:     return "METADATA_FN_NODE";
274    case bitc::METADATA_NAMED_NODE:  return "METADATA_NAMED_NODE";
275    }
276  }
277}
278
279struct PerRecordStats {
280  unsigned NumInstances;
281  unsigned NumAbbrev;
282  uint64_t TotalBits;
283
284  PerRecordStats() : NumInstances(0), NumAbbrev(0), TotalBits(0) {}
285};
286
287struct PerBlockIDStats {
288  /// NumInstances - This the number of times this block ID has been seen.
289  unsigned NumInstances;
290
291  /// NumBits - The total size in bits of all of these blocks.
292  uint64_t NumBits;
293
294  /// NumSubBlocks - The total number of blocks these blocks contain.
295  unsigned NumSubBlocks;
296
297  /// NumAbbrevs - The total number of abbreviations.
298  unsigned NumAbbrevs;
299
300  /// NumRecords - The total number of records these blocks contain, and the
301  /// number that are abbreviated.
302  unsigned NumRecords, NumAbbreviatedRecords;
303
304  /// CodeFreq - Keep track of the number of times we see each code.
305  std::vector<PerRecordStats> CodeFreq;
306
307  PerBlockIDStats()
308    : NumInstances(0), NumBits(0),
309      NumSubBlocks(0), NumAbbrevs(0), NumRecords(0), NumAbbreviatedRecords(0) {}
310};
311
312static std::map<unsigned, PerBlockIDStats> BlockIDStats;
313
314
315
316/// Error - All bitcode analysis errors go through this function, making this a
317/// good place to breakpoint if debugging.
318static bool Error(const std::string &Err) {
319  errs() << Err << "\n";
320  return true;
321}
322
323/// ParseBlock - Read a block, updating statistics, etc.
324static bool ParseBlock(BitstreamCursor &Stream, unsigned IndentLevel) {
325  std::string Indent(IndentLevel*2, ' ');
326  uint64_t BlockBitStart = Stream.GetCurrentBitNo();
327  unsigned BlockID = Stream.ReadSubBlockID();
328
329  // Get the statistics for this BlockID.
330  PerBlockIDStats &BlockStats = BlockIDStats[BlockID];
331
332  BlockStats.NumInstances++;
333
334  // BLOCKINFO is a special part of the stream.
335  if (BlockID == bitc::BLOCKINFO_BLOCK_ID) {
336    if (Dump) errs() << Indent << "<BLOCKINFO_BLOCK/>\n";
337    if (Stream.ReadBlockInfoBlock())
338      return Error("Malformed BlockInfoBlock");
339    uint64_t BlockBitEnd = Stream.GetCurrentBitNo();
340    BlockStats.NumBits += BlockBitEnd-BlockBitStart;
341    return false;
342  }
343
344  unsigned NumWords = 0;
345  if (Stream.EnterSubBlock(BlockID, &NumWords))
346    return Error("Malformed block record");
347
348  const char *BlockName = 0;
349  if (Dump) {
350    errs() << Indent << "<";
351    if ((BlockName = GetBlockName(BlockID, *Stream.getBitStreamReader())))
352      errs() << BlockName;
353    else
354      errs() << "UnknownBlock" << BlockID;
355
356    if (NonSymbolic && BlockName)
357      errs() << " BlockID=" << BlockID;
358
359    errs() << " NumWords=" << NumWords
360           << " BlockCodeSize=" << Stream.GetAbbrevIDWidth() << ">\n";
361  }
362
363  SmallVector<uint64_t, 64> Record;
364
365  // Read all the records for this block.
366  while (1) {
367    if (Stream.AtEndOfStream())
368      return Error("Premature end of bitstream");
369
370    uint64_t RecordStartBit = Stream.GetCurrentBitNo();
371
372    // Read the code for this record.
373    unsigned AbbrevID = Stream.ReadCode();
374    switch (AbbrevID) {
375    case bitc::END_BLOCK: {
376      if (Stream.ReadBlockEnd())
377        return Error("Error at end of block");
378      uint64_t BlockBitEnd = Stream.GetCurrentBitNo();
379      BlockStats.NumBits += BlockBitEnd-BlockBitStart;
380      if (Dump) {
381        errs() << Indent << "</";
382        if (BlockName)
383          errs() << BlockName << ">\n";
384        else
385          errs() << "UnknownBlock" << BlockID << ">\n";
386      }
387      return false;
388    }
389    case bitc::ENTER_SUBBLOCK: {
390      uint64_t SubBlockBitStart = Stream.GetCurrentBitNo();
391      if (ParseBlock(Stream, IndentLevel+1))
392        return true;
393      ++BlockStats.NumSubBlocks;
394      uint64_t SubBlockBitEnd = Stream.GetCurrentBitNo();
395
396      // Don't include subblock sizes in the size of this block.
397      BlockBitStart += SubBlockBitEnd-SubBlockBitStart;
398      break;
399    }
400    case bitc::DEFINE_ABBREV:
401      Stream.ReadAbbrevRecord();
402      ++BlockStats.NumAbbrevs;
403      break;
404    default:
405      Record.clear();
406
407      ++BlockStats.NumRecords;
408      if (AbbrevID != bitc::UNABBREV_RECORD)
409        ++BlockStats.NumAbbreviatedRecords;
410
411      const char *BlobStart = 0;
412      unsigned BlobLen = 0;
413      unsigned Code = Stream.ReadRecord(AbbrevID, Record, BlobStart, BlobLen);
414
415
416
417      // Increment the # occurrences of this code.
418      if (BlockStats.CodeFreq.size() <= Code)
419        BlockStats.CodeFreq.resize(Code+1);
420      BlockStats.CodeFreq[Code].NumInstances++;
421      BlockStats.CodeFreq[Code].TotalBits +=
422        Stream.GetCurrentBitNo()-RecordStartBit;
423      if (AbbrevID != bitc::UNABBREV_RECORD)
424        BlockStats.CodeFreq[Code].NumAbbrev++;
425
426      if (Dump) {
427        errs() << Indent << "  <";
428        if (const char *CodeName =
429              GetCodeName(Code, BlockID, *Stream.getBitStreamReader()))
430          errs() << CodeName;
431        else
432          errs() << "UnknownCode" << Code;
433        if (NonSymbolic &&
434            GetCodeName(Code, BlockID, *Stream.getBitStreamReader()))
435          errs() << " codeid=" << Code;
436        if (AbbrevID != bitc::UNABBREV_RECORD)
437          errs() << " abbrevid=" << AbbrevID;
438
439        for (unsigned i = 0, e = Record.size(); i != e; ++i)
440          errs() << " op" << i << "=" << (int64_t)Record[i];
441
442        errs() << "/>";
443
444        if (BlobStart) {
445          errs() << " blob data = ";
446          bool BlobIsPrintable = true;
447          for (unsigned i = 0; i != BlobLen; ++i)
448            if (!isprint(BlobStart[i])) {
449              BlobIsPrintable = false;
450              break;
451            }
452
453          if (BlobIsPrintable)
454            errs() << "'" << std::string(BlobStart, BlobStart+BlobLen) <<"'";
455          else
456            errs() << "unprintable, " << BlobLen << " bytes.";
457        }
458
459        errs() << "\n";
460      }
461
462      break;
463    }
464  }
465}
466
467static void PrintSize(double Bits) {
468  fprintf(stderr, "%.2f/%.2fB/%luW", Bits, Bits/8,(unsigned long)(Bits/32));
469}
470static void PrintSize(uint64_t Bits) {
471  fprintf(stderr, "%lub/%.2fB/%luW", (unsigned long)Bits,
472          (double)Bits/8, (unsigned long)(Bits/32));
473}
474
475
476/// AnalyzeBitcode - Analyze the bitcode file specified by InputFilename.
477static int AnalyzeBitcode() {
478  // Read the input file.
479  OwningPtr<MemoryBuffer> MemBuf;
480
481  if (error_code ec =
482        MemoryBuffer::getFileOrSTDIN(InputFilename.c_str(), MemBuf))
483    return Error("Error reading '" + InputFilename + "': " + ec.message());
484
485  if (MemBuf->getBufferSize() & 3)
486    return Error("Bitcode stream should be a multiple of 4 bytes in length");
487
488  unsigned char *BufPtr = (unsigned char *)MemBuf->getBufferStart();
489  unsigned char *EndBufPtr = BufPtr+MemBuf->getBufferSize();
490
491  // If we have a wrapper header, parse it and ignore the non-bc file contents.
492  // The magic number is 0x0B17C0DE stored in little endian.
493  if (isBitcodeWrapper(BufPtr, EndBufPtr))
494    if (SkipBitcodeWrapperHeader(BufPtr, EndBufPtr))
495      return Error("Invalid bitcode wrapper header");
496
497  BitstreamReader StreamFile(BufPtr, EndBufPtr);
498  BitstreamCursor Stream(StreamFile);
499  StreamFile.CollectBlockInfoNames();
500
501  // Read the stream signature.
502  char Signature[6];
503  Signature[0] = Stream.Read(8);
504  Signature[1] = Stream.Read(8);
505  Signature[2] = Stream.Read(4);
506  Signature[3] = Stream.Read(4);
507  Signature[4] = Stream.Read(4);
508  Signature[5] = Stream.Read(4);
509
510  // Autodetect the file contents, if it is one we know.
511  CurStreamType = UnknownBitstream;
512  if (Signature[0] == 'B' && Signature[1] == 'C' &&
513      Signature[2] == 0x0 && Signature[3] == 0xC &&
514      Signature[4] == 0xE && Signature[5] == 0xD)
515    CurStreamType = LLVMIRBitstream;
516
517  unsigned NumTopBlocks = 0;
518
519  // Parse the top-level structure.  We only allow blocks at the top-level.
520  while (!Stream.AtEndOfStream()) {
521    unsigned Code = Stream.ReadCode();
522    if (Code != bitc::ENTER_SUBBLOCK)
523      return Error("Invalid record at top-level");
524
525    if (ParseBlock(Stream, 0))
526      return true;
527    ++NumTopBlocks;
528  }
529
530  if (Dump) errs() << "\n\n";
531
532  uint64_t BufferSizeBits = (EndBufPtr-BufPtr)*CHAR_BIT;
533  // Print a summary of the read file.
534  errs() << "Summary of " << InputFilename << ":\n";
535  errs() << "         Total size: ";
536  PrintSize(BufferSizeBits);
537  errs() << "\n";
538  errs() << "        Stream type: ";
539  switch (CurStreamType) {
540  default: assert(0 && "Unknown bitstream type");
541  case UnknownBitstream: errs() << "unknown\n"; break;
542  case LLVMIRBitstream:  errs() << "LLVM IR\n"; break;
543  }
544  errs() << "  # Toplevel Blocks: " << NumTopBlocks << "\n";
545  errs() << "\n";
546
547  // Emit per-block stats.
548  errs() << "Per-block Summary:\n";
549  for (std::map<unsigned, PerBlockIDStats>::iterator I = BlockIDStats.begin(),
550       E = BlockIDStats.end(); I != E; ++I) {
551    errs() << "  Block ID #" << I->first;
552    if (const char *BlockName = GetBlockName(I->first, StreamFile))
553      errs() << " (" << BlockName << ")";
554    errs() << ":\n";
555
556    const PerBlockIDStats &Stats = I->second;
557    errs() << "      Num Instances: " << Stats.NumInstances << "\n";
558    errs() << "         Total Size: ";
559    PrintSize(Stats.NumBits);
560    errs() << "\n";
561    double pct = (Stats.NumBits * 100.0) / BufferSizeBits;
562    errs() << "    Percent of file: " << format("%2.4f%%", pct) << "\n";
563    if (Stats.NumInstances > 1) {
564      errs() << "       Average Size: ";
565      PrintSize(Stats.NumBits/(double)Stats.NumInstances);
566      errs() << "\n";
567      errs() << "  Tot/Avg SubBlocks: " << Stats.NumSubBlocks << "/"
568             << Stats.NumSubBlocks/(double)Stats.NumInstances << "\n";
569      errs() << "    Tot/Avg Abbrevs: " << Stats.NumAbbrevs << "/"
570             << Stats.NumAbbrevs/(double)Stats.NumInstances << "\n";
571      errs() << "    Tot/Avg Records: " << Stats.NumRecords << "/"
572             << Stats.NumRecords/(double)Stats.NumInstances << "\n";
573    } else {
574      errs() << "      Num SubBlocks: " << Stats.NumSubBlocks << "\n";
575      errs() << "        Num Abbrevs: " << Stats.NumAbbrevs << "\n";
576      errs() << "        Num Records: " << Stats.NumRecords << "\n";
577    }
578    if (Stats.NumRecords) {
579      double pct = (Stats.NumAbbreviatedRecords * 100.0) / Stats.NumRecords;
580      errs() << "    Percent Abbrevs: " << format("%2.4f%%", pct) << "\n";
581    }
582    errs() << "\n";
583
584    // Print a histogram of the codes we see.
585    if (!NoHistogram && !Stats.CodeFreq.empty()) {
586      std::vector<std::pair<unsigned, unsigned> > FreqPairs;  // <freq,code>
587      for (unsigned i = 0, e = Stats.CodeFreq.size(); i != e; ++i)
588        if (unsigned Freq = Stats.CodeFreq[i].NumInstances)
589          FreqPairs.push_back(std::make_pair(Freq, i));
590      std::stable_sort(FreqPairs.begin(), FreqPairs.end());
591      std::reverse(FreqPairs.begin(), FreqPairs.end());
592
593      errs() << "\tRecord Histogram:\n";
594      fprintf(stderr, "\t\t  Count    # Bits   %% Abv  Record Kind\n");
595      for (unsigned i = 0, e = FreqPairs.size(); i != e; ++i) {
596        const PerRecordStats &RecStats = Stats.CodeFreq[FreqPairs[i].second];
597
598        fprintf(stderr, "\t\t%7d %9lu ", RecStats.NumInstances,
599                (unsigned long)RecStats.TotalBits);
600
601        if (RecStats.NumAbbrev)
602          fprintf(stderr, "%7.2f  ",
603                  (double)RecStats.NumAbbrev/RecStats.NumInstances*100);
604        else
605          fprintf(stderr, "         ");
606
607        if (const char *CodeName =
608              GetCodeName(FreqPairs[i].second, I->first, StreamFile))
609          fprintf(stderr, "%s\n", CodeName);
610        else
611          fprintf(stderr, "UnknownCode%d\n", FreqPairs[i].second);
612      }
613      errs() << "\n";
614
615    }
616  }
617  return 0;
618}
619
620
621int main(int argc, char **argv) {
622  // Print a stack trace if we signal out.
623  sys::PrintStackTraceOnErrorSignal();
624  PrettyStackTraceProgram X(argc, argv);
625  llvm_shutdown_obj Y;  // Call llvm_shutdown() on exit.
626  cl::ParseCommandLineOptions(argc, argv, "llvm-bcanalyzer file analyzer\n");
627
628  return AnalyzeBitcode();
629}
630