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/Signals.h"
  41 #include "llvm/Support/raw_ostream.h"
  42 #include "llvm/Support/system_error.h"
  43 #include <algorithm>
  44 #include <map>
  45 using namespace llvm;
  46
  47 static cl::opt<std::string>
  48   InputFilename(cl::Positional, cl::desc("<input bitcode>"), cl::init("-"));
  49
  50 static cl::opt<bool> Dump("dump", cl::desc("Dump low level bitcode trace"));
  51
  52 //===----------------------------------------------------------------------===//
  53 // Bitcode specific analysis.
  54 //===----------------------------------------------------------------------===//
  55
  56 static cl::opt<bool> NoHistogram("disable-histogram",
  57                                  cl::desc("Do not print per-code histogram"));
  58
  59 static cl::opt<bool>
  60 NonSymbolic("non-symbolic",
  61             cl::desc("Emit numeric info in dump even if"
  62                      " symbolic info is available"));
  63
  64 namespace {
  65
  66 /// CurStreamTypeType - A type for CurStreamType
  67 enum CurStreamTypeType {
  68   UnknownBitstream,
  69   LLVMIRBitstream
  70 };
  71
  72 }
  73
  74 /// CurStreamType - If we can sniff the flavor of this stream, we can produce
  75 /// better dump info.
  76 static CurStreamTypeType CurStreamType;
  77
  78
  79 /// GetBlockName - Return a symbolic block name if known, otherwise return
  80 /// null.
  81 static const char *GetBlockName(unsigned BlockID,
  82                                 const BitstreamReader &StreamFile) {
  83   // Standard blocks for all bitcode files.
  84   if (BlockID < bitc::FIRST_APPLICATION_BLOCKID) {
  85     if (BlockID == bitc::BLOCKINFO_BLOCK_ID)
  86       return "BLOCKINFO_BLOCK";
  87     return 0;
  88   }
  89
  90   // Check to see if we have a blockinfo record for this block, with a name.
  91   if (const BitstreamReader::BlockInfo *Info =
  92         StreamFile.getBlockInfo(BlockID)) {
  93     if (!Info->Name.empty())
  94       return Info->Name.c_str();
  95   }
  96
  97
  98   if (CurStreamType != LLVMIRBitstream) return 0;
  99
 100   switch (BlockID) {
 101   default:                           return 0;
 102   case bitc::MODULE_BLOCK_ID:        return "MODULE_BLOCK";
 103   case bitc::PARAMATTR_BLOCK_ID:     return "PARAMATTR_BLOCK";
 104   case bitc::TYPE_BLOCK_ID_NEW:      return "TYPE_BLOCK_ID";
 105   case bitc::CONSTANTS_BLOCK_ID:     return "CONSTANTS_BLOCK";
 106   case bitc::FUNCTION_BLOCK_ID:      return "FUNCTION_BLOCK";
 107   case bitc::VALUE_SYMTAB_BLOCK_ID:  return "VALUE_SYMTAB";
 108   case bitc::METADATA_BLOCK_ID:      return "METADATA_BLOCK";
 109   case bitc::METADATA_ATTACHMENT_ID: return "METADATA_ATTACHMENT_BLOCK";
 110   case bitc::USELIST_BLOCK_ID:       return "USELIST_BLOCK_ID";
 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"; // FIXME: Remove in 4.0
 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     case bitc::CST_CODE_BLOCKADDRESS:    return "CST_CODE_BLOCKADDRESS";
 211     case bitc::CST_CODE_DATA:            return "DATA";
 212     }
 213   case bitc::FUNCTION_BLOCK_ID:
 214     switch (CodeID) {
 215     default: return 0;
 216     case bitc::FUNC_CODE_DECLAREBLOCKS: return "DECLAREBLOCKS";
 217
 218     case bitc::FUNC_CODE_INST_BINOP:        return "INST_BINOP";
 219     case bitc::FUNC_CODE_INST_CAST:         return "INST_CAST";
 220     case bitc::FUNC_CODE_INST_GEP:          return "INST_GEP";
 221     case bitc::FUNC_CODE_INST_INBOUNDS_GEP: return "INST_INBOUNDS_GEP";
 222     case bitc::FUNC_CODE_INST_SELECT:       return "INST_SELECT";
 223     case bitc::FUNC_CODE_INST_EXTRACTELT:   return "INST_EXTRACTELT";
 224     case bitc::FUNC_CODE_INST_INSERTELT:    return "INST_INSERTELT";
 225     case bitc::FUNC_CODE_INST_SHUFFLEVEC:   return "INST_SHUFFLEVEC";
 226     case bitc::FUNC_CODE_INST_CMP:          return "INST_CMP";
 227
 228     case bitc::FUNC_CODE_INST_RET:          return "INST_RET";
 229     case bitc::FUNC_CODE_INST_BR:           return "INST_BR";
 230     case bitc::FUNC_CODE_INST_SWITCH:       return "INST_SWITCH";
 231     case bitc::FUNC_CODE_INST_INVOKE:       return "INST_INVOKE";
 232     case bitc::FUNC_CODE_INST_UNREACHABLE:  return "INST_UNREACHABLE";
 233
 234     case bitc::FUNC_CODE_INST_PHI:          return "INST_PHI";
 235     case bitc::FUNC_CODE_INST_ALLOCA:       return "INST_ALLOCA";
 236     case bitc::FUNC_CODE_INST_LOAD:         return "INST_LOAD";
 237     case bitc::FUNC_CODE_INST_VAARG:        return "INST_VAARG";
 238     case bitc::FUNC_CODE_INST_STORE:        return "INST_STORE";
 239     case bitc::FUNC_CODE_INST_EXTRACTVAL:   return "INST_EXTRACTVAL";
 240     case bitc::FUNC_CODE_INST_INSERTVAL:    return "INST_INSERTVAL";
 241     case bitc::FUNC_CODE_INST_CMP2:         return "INST_CMP2";
 242     case bitc::FUNC_CODE_INST_VSELECT:      return "INST_VSELECT";
 243     case bitc::FUNC_CODE_DEBUG_LOC_AGAIN:   return "DEBUG_LOC_AGAIN";
 244     case bitc::FUNC_CODE_INST_CALL:         return "INST_CALL";
 245     case bitc::FUNC_CODE_DEBUG_LOC:         return "DEBUG_LOC";
 246     }
 247   case bitc::VALUE_SYMTAB_BLOCK_ID:
 248     switch (CodeID) {
 249     default: return 0;
 250     case bitc::VST_CODE_ENTRY: return "ENTRY";
 251     case bitc::VST_CODE_BBENTRY: return "BBENTRY";
 252     }
 253   case bitc::METADATA_ATTACHMENT_ID:
 254     switch(CodeID) {
 255     default:return 0;
 256     case bitc::METADATA_ATTACHMENT: return "METADATA_ATTACHMENT";
 257     }
 258   case bitc::METADATA_BLOCK_ID:
 259     switch(CodeID) {
 260     default:return 0;
 261     case bitc::METADATA_STRING:      return "METADATA_STRING";
 262     case bitc::METADATA_NAME:        return "METADATA_NAME";
 263     case bitc::METADATA_KIND:        return "METADATA_KIND";
 264     case bitc::METADATA_NODE:        return "METADATA_NODE";
 265     case bitc::METADATA_FN_NODE:     return "METADATA_FN_NODE";
 266     case bitc::METADATA_NAMED_NODE:  return "METADATA_NAMED_NODE";
 267     }
 268   case bitc::USELIST_BLOCK_ID:
 269     switch(CodeID) {
 270     default:return 0;
 271     case bitc::USELIST_CODE_ENTRY:   return "USELIST_CODE_ENTRY";
 272     }
 273   }
 274 }
 275
 276 struct PerRecordStats {
 277   unsigned NumInstances;
 278   unsigned NumAbbrev;
 279   uint64_t TotalBits;
 280
 281   PerRecordStats() : NumInstances(0), NumAbbrev(0), TotalBits(0) {}
 282 };
 283
 284 struct PerBlockIDStats {
 285   /// NumInstances - This the number of times this block ID has been seen.
 286   unsigned NumInstances;
 287
 288   /// NumBits - The total size in bits of all of these blocks.
 289   uint64_t NumBits;
 290
 291   /// NumSubBlocks - The total number of blocks these blocks contain.
 292   unsigned NumSubBlocks;
 293
 294   /// NumAbbrevs - The total number of abbreviations.
 295   unsigned NumAbbrevs;
 296
 297   /// NumRecords - The total number of records these blocks contain, and the
 298   /// number that are abbreviated.
 299   unsigned NumRecords, NumAbbreviatedRecords;
 300
 301   /// CodeFreq - Keep track of the number of times we see each code.
 302   std::vector<PerRecordStats> CodeFreq;
 303
 304   PerBlockIDStats()
 305     : NumInstances(0), NumBits(0),
 306       NumSubBlocks(0), NumAbbrevs(0), NumRecords(0), NumAbbreviatedRecords(0) {}
 307 };
 308
 309 static std::map<unsigned, PerBlockIDStats> BlockIDStats;
 310
 311
 312
 313 /// Error - All bitcode analysis errors go through this function, making this a
 314 /// good place to breakpoint if debugging.
 315 static bool Error(const std::string &Err) {
 316   errs() << Err << "\n";
 317   return true;
 318 }
 319
 320 /// ParseBlock - Read a block, updating statistics, etc.
 321 static bool ParseBlock(BitstreamCursor &Stream, unsigned BlockID,
 322                        unsigned IndentLevel) {
 323   std::string Indent(IndentLevel*2, ' ');
 324   uint64_t BlockBitStart = Stream.GetCurrentBitNo();
 325
 326   // Get the statistics for this BlockID.
 327   PerBlockIDStats &BlockStats = BlockIDStats[BlockID];
 328
 329   BlockStats.NumInstances++;
 330
 331   // BLOCKINFO is a special part of the stream.
 332   if (BlockID == bitc::BLOCKINFO_BLOCK_ID) {
 333     if (Dump) outs() << Indent << "<BLOCKINFO_BLOCK/>\n";
 334     if (Stream.ReadBlockInfoBlock())
 335       return Error("Malformed BlockInfoBlock");
 336     uint64_t BlockBitEnd = Stream.GetCurrentBitNo();
 337     BlockStats.NumBits += BlockBitEnd-BlockBitStart;
 338     return false;
 339   }
 340
 341   unsigned NumWords = 0;
 342   if (Stream.EnterSubBlock(BlockID, &NumWords))
 343     return Error("Malformed block record");
 344
 345   const char *BlockName = 0;
 346   if (Dump) {
 347     outs() << Indent << "<";
 348     if ((BlockName = GetBlockName(BlockID, *Stream.getBitStreamReader())))
 349       outs() << BlockName;
 350     else
 351       outs() << "UnknownBlock" << BlockID;
 352
 353     if (NonSymbolic && BlockName)
 354       outs() << " BlockID=" << BlockID;
 355
 356     outs() << " NumWords=" << NumWords
 357            << " BlockCodeSize=" << Stream.getAbbrevIDWidth() << ">\n";
 358   }
 359
 360   SmallVector<uint64_t, 64> Record;
 361
 362   // Read all the records for this block.
 363   while (1) {
 364     if (Stream.AtEndOfStream())
 365       return Error("Premature end of bitstream");
 366
 367     uint64_t RecordStartBit = Stream.GetCurrentBitNo();
 368
 369     BitstreamEntry Entry =
 370       Stream.advance(BitstreamCursor::AF_DontAutoprocessAbbrevs);
 371
 372     switch (Entry.Kind) {
 373     case BitstreamEntry::Error:
 374       return Error("malformed bitcode file");
 375     case BitstreamEntry::EndBlock: {
 376       uint64_t BlockBitEnd = Stream.GetCurrentBitNo();
 377       BlockStats.NumBits += BlockBitEnd-BlockBitStart;
 378       if (Dump) {
 379         outs() << Indent << "</";
 380         if (BlockName)
 381           outs() << BlockName << ">\n";
 382         else
 383           outs() << "UnknownBlock" << BlockID << ">\n";
 384       }
 385       return false;
 386     }
 387
 388     case BitstreamEntry::SubBlock: {
 389       uint64_t SubBlockBitStart = Stream.GetCurrentBitNo();
 390       if (ParseBlock(Stream, Entry.ID, 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       continue;
 398     }
 399     case BitstreamEntry::Record:
 400       // The interesting case.
 401       break;
 402     }
 403
 404     if (Entry.ID == bitc::DEFINE_ABBREV) {
 405       Stream.ReadAbbrevRecord();
 406       ++BlockStats.NumAbbrevs;
 407       continue;
 408     }
 409
 410     Record.clear();
 411
 412     ++BlockStats.NumRecords;
 413
 414     StringRef Blob;
 415     unsigned Code = Stream.readRecord(Entry.ID, Record, &Blob);
 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 (Entry.ID != bitc::UNABBREV_RECORD) {
 424       BlockStats.CodeFreq[Code].NumAbbrev++;
 425       ++BlockStats.NumAbbreviatedRecords;
 426     }
 427
 428     if (Dump) {
 429       outs() << Indent << "  <";
 430       if (const char *CodeName =
 431             GetCodeName(Code, BlockID, *Stream.getBitStreamReader()))
 432         outs() << CodeName;
 433       else
 434         outs() << "UnknownCode" << Code;
 435       if (NonSymbolic &&
 436           GetCodeName(Code, BlockID, *Stream.getBitStreamReader()))
 437         outs() << " codeid=" << Code;
 438       if (Entry.ID != bitc::UNABBREV_RECORD)
 439         outs() << " abbrevid=" << Entry.ID;
 440
 441       for (unsigned i = 0, e = Record.size(); i != e; ++i)
 442         outs() << " op" << i << "=" << (int64_t)Record[i];
 443
 444       outs() << "/>";
 445
 446       if (Blob.data()) {
 447         outs() << " blob data = ";
 448         bool BlobIsPrintable = true;
 449         for (unsigned i = 0, e = Blob.size(); i != e; ++i)
 450           if (!isprint(Blob[i])) {
 451             BlobIsPrintable = false;
 452             break;
 453           }
 454
 455         if (BlobIsPrintable)
 456           outs() << "'" << Blob << "'";
 457         else
 458           outs() << "unprintable, " << Blob.size() << " bytes.";
 459       }
 460
 461       outs() << "\n";
 462     }
 463   }
 464 }
 465
 466 static void PrintSize(double Bits) {
 467   outs() << format("%.2f/%.2fB/%luW", Bits, Bits/8,(unsigned long)(Bits/32));
 468 }
 469 static void PrintSize(uint64_t Bits) {
 470   outs() << format("%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.
 476 static 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   const unsigned char *BufPtr = (const unsigned char *)MemBuf->getBufferStart();
 488   const 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, true))
 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     unsigned BlockID = Stream.ReadSubBlockID();
 525
 526     if (ParseBlock(Stream, BlockID, 0))
 527       return true;
 528     ++NumTopBlocks;
 529   }
 530
 531   if (Dump) outs() << "\n\n";
 532
 533   uint64_t BufferSizeBits = (EndBufPtr-BufPtr)*CHAR_BIT;
 534   // Print a summary of the read file.
 535   outs() << "Summary of " << InputFilename << ":\n";
 536   outs() << "         Total size: ";
 537   PrintSize(BufferSizeBits);
 538   outs() << "\n";
 539   outs() << "        Stream type: ";
 540   switch (CurStreamType) {
 541   case UnknownBitstream: outs() << "unknown\n"; break;
 542   case LLVMIRBitstream:  outs() << "LLVM IR\n"; break;
 543   }
 544   outs() << "  # Toplevel Blocks: " << NumTopBlocks << "\n";
 545   outs() << "\n";
 546
 547   // Emit per-block stats.
 548   outs() << "Per-block Summary:\n";
 549   for (std::map<unsigned, PerBlockIDStats>::iterator I = BlockIDStats.begin(),
 550        E = BlockIDStats.end(); I != E; ++I) {
 551     outs() << "  Block ID #" << I->first;
 552     if (const char *BlockName = GetBlockName(I->first, StreamFile))
 553       outs() << " (" << BlockName << ")";
 554     outs() << ":\n";
 555
 556     const PerBlockIDStats &Stats = I->second;
 557     outs() << "      Num Instances: " << Stats.NumInstances << "\n";
 558     outs() << "         Total Size: ";
 559     PrintSize(Stats.NumBits);
 560     outs() << "\n";
 561     double pct = (Stats.NumBits * 100.0) / BufferSizeBits;
 562     outs() << "    Percent of file: " << format("%2.4f%%", pct) << "\n";
 563     if (Stats.NumInstances > 1) {
 564       outs() << "       Average Size: ";
 565       PrintSize(Stats.NumBits/(double)Stats.NumInstances);
 566       outs() << "\n";
 567       outs() << "  Tot/Avg SubBlocks: " << Stats.NumSubBlocks << "/"
 568              << Stats.NumSubBlocks/(double)Stats.NumInstances << "\n";
 569       outs() << "    Tot/Avg Abbrevs: " << Stats.NumAbbrevs << "/"
 570              << Stats.NumAbbrevs/(double)Stats.NumInstances << "\n";
 571       outs() << "    Tot/Avg Records: " << Stats.NumRecords << "/"
 572              << Stats.NumRecords/(double)Stats.NumInstances << "\n";
 573     } else {
 574       outs() << "      Num SubBlocks: " << Stats.NumSubBlocks << "\n";
 575       outs() << "        Num Abbrevs: " << Stats.NumAbbrevs << "\n";
 576       outs() << "        Num Records: " << Stats.NumRecords << "\n";
 577     }
 578     if (Stats.NumRecords) {
 579       double pct = (Stats.NumAbbreviatedRecords * 100.0) / Stats.NumRecords;
 580       outs() << "    Percent Abbrevs: " << format("%2.4f%%", pct) << "\n";
 581     }
 582     outs() << "\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       outs() << "\tRecord Histogram:\n";
 594       outs() << "\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         outs() << format("\t\t%7d %9lu",
 599                          RecStats.NumInstances,
 600                          (unsigned long)RecStats.TotalBits);
 601
 602         if (RecStats.NumAbbrev)
 603           outs() <<
 604               format("%7.2f  ",
 605                      (double)RecStats.NumAbbrev/RecStats.NumInstances*100);
 606         else
 607           outs() << "         ";
 608
 609         if (const char *CodeName =
 610               GetCodeName(FreqPairs[i].second, I->first, StreamFile))
 611           outs() << CodeName << "\n";
 612         else
 613           outs() << "UnknownCode" << FreqPairs[i].second << "\n";
 614       }
 615       outs() << "\n";
 616
 617     }
 618   }
 619   return 0;
 620 }
 621
 622
 623 int main(int argc, char **argv) {
 624   // Print a stack trace if we signal out.
 625   sys::PrintStackTraceOnErrorSignal();
 626   PrettyStackTraceProgram X(argc, argv);
 627   llvm_shutdown_obj Y;  // Call llvm_shutdown() on exit.
 628   cl::ParseCommandLineOptions(argc, argv, "llvm-bcanalyzer file analyzer\n");
 629
 630   return AnalyzeBitcode();
 631 }