tools/llvm-bcanalyzer/llvm-bcanalyzer.cpp

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