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