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
  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   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.
 117 static 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_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 IndentLevel) {
 322   std::string Indent(IndentLevel*2, ' ');
 323   uint64_t BlockBitStart = Stream.GetCurrentBitNo();
 324   unsigned BlockID = Stream.ReadSubBlockID();
 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     // Read the code for this record.
 370     unsigned AbbrevID = Stream.ReadCode();
 371     switch (AbbrevID) {
 372     case bitc::END_BLOCK: {
 373       if (Stream.ReadBlockEnd())
 374         return Error("Error at end of block");
 375       uint64_t BlockBitEnd = Stream.GetCurrentBitNo();
 376       BlockStats.NumBits += BlockBitEnd-BlockBitStart;
 377       if (Dump) {
 378         outs() << Indent << "</";
 379         if (BlockName)
 380           outs() << BlockName << ">\n";
 381         else
 382           outs() << "UnknownBlock" << BlockID << ">\n";
 383       }
 384       return false;
 385     }
 386     case bitc::ENTER_SUBBLOCK: {
 387       uint64_t SubBlockBitStart = Stream.GetCurrentBitNo();
 388       if (ParseBlock(Stream, IndentLevel+1))
 389         return true;
 390       ++BlockStats.NumSubBlocks;
 391       uint64_t SubBlockBitEnd = Stream.GetCurrentBitNo();
 392
 393       // Don't include subblock sizes in the size of this block.
 394       BlockBitStart += SubBlockBitEnd-SubBlockBitStart;
 395       break;
 396     }
 397     case bitc::DEFINE_ABBREV:
 398       Stream.ReadAbbrevRecord();
 399       ++BlockStats.NumAbbrevs;
 400       break;
 401     default:
 402       Record.clear();
 403
 404       ++BlockStats.NumRecords;
 405       if (AbbrevID != bitc::UNABBREV_RECORD)
 406         ++BlockStats.NumAbbreviatedRecords;
 407
 408       const char *BlobStart = 0;
 409       unsigned BlobLen = 0;
 410       unsigned Code = Stream.ReadRecord(AbbrevID, Record, BlobStart, BlobLen);
 411
 412
 413
 414       // Increment the # occurrences of this code.
 415       if (BlockStats.CodeFreq.size() <= Code)
 416         BlockStats.CodeFreq.resize(Code+1);
 417       BlockStats.CodeFreq[Code].NumInstances++;
 418       BlockStats.CodeFreq[Code].TotalBits +=
 419         Stream.GetCurrentBitNo()-RecordStartBit;
 420       if (AbbrevID != bitc::UNABBREV_RECORD)
 421         BlockStats.CodeFreq[Code].NumAbbrev++;
 422
 423       if (Dump) {
 424         outs() << Indent << "  <";
 425         if (const char *CodeName =
 426               GetCodeName(Code, BlockID, *Stream.getBitStreamReader()))
 427           outs() << CodeName;
 428         else
 429           outs() << "UnknownCode" << Code;
 430         if (NonSymbolic &&
 431             GetCodeName(Code, BlockID, *Stream.getBitStreamReader()))
 432           outs() << " codeid=" << Code;
 433         if (AbbrevID != bitc::UNABBREV_RECORD)
 434           outs() << " abbrevid=" << AbbrevID;
 435
 436         for (unsigned i = 0, e = Record.size(); i != e; ++i)
 437           outs() << " op" << i << "=" << (int64_t)Record[i];
 438
 439         outs() << "/>";
 440
 441         if (BlobStart) {
 442           outs() << " blob data = ";
 443           bool BlobIsPrintable = true;
 444           for (unsigned i = 0; i != BlobLen; ++i)
 445             if (!isprint(BlobStart[i])) {
 446               BlobIsPrintable = false;
 447               break;
 448             }
 449
 450           if (BlobIsPrintable)
 451             outs() << "'" << std::string(BlobStart, BlobStart+BlobLen) <<"'";
 452           else
 453             outs() << "unprintable, " << BlobLen << " bytes.";
 454         }
 455
 456         outs() << "\n";
 457       }
 458
 459       break;
 460     }
 461   }
 462 }
 463
 464 static void PrintSize(double Bits) {
 465   outs() << format("%.2f/%.2fB/%luW", Bits, Bits/8,(unsigned long)(Bits/32));
 466 }
 467 static void PrintSize(uint64_t Bits) {
 468   outs() << format("%lub/%.2fB/%luW", (unsigned long)Bits,
 469                    (double)Bits/8, (unsigned long)(Bits/32));
 470 }
 471
 472
 473 /// AnalyzeBitcode - Analyze the bitcode file specified by InputFilename.
 474 static int AnalyzeBitcode() {
 475   // Read the input file.
 476   OwningPtr<MemoryBuffer> MemBuf;
 477
 478   if (error_code ec =
 479         MemoryBuffer::getFileOrSTDIN(InputFilename.c_str(), MemBuf))
 480     return Error("Error reading '" + InputFilename + "': " + ec.message());
 481
 482   if (MemBuf->getBufferSize() & 3)
 483     return Error("Bitcode stream should be a multiple of 4 bytes in length");
 484
 485   const unsigned char *BufPtr = (const unsigned char *)MemBuf->getBufferStart();
 486   const unsigned char *EndBufPtr = BufPtr+MemBuf->getBufferSize();
 487
 488   // If we have a wrapper header, parse it and ignore the non-bc file contents.
 489   // The magic number is 0x0B17C0DE stored in little endian.
 490   if (isBitcodeWrapper(BufPtr, EndBufPtr))
 491     if (SkipBitcodeWrapperHeader(BufPtr, EndBufPtr, true))
 492       return Error("Invalid bitcode wrapper header");
 493
 494   BitstreamReader StreamFile(BufPtr, EndBufPtr);
 495   BitstreamCursor Stream(StreamFile);
 496   StreamFile.CollectBlockInfoNames();
 497
 498   // Read the stream signature.
 499   char Signature[6];
 500   Signature[0] = Stream.Read(8);
 501   Signature[1] = Stream.Read(8);
 502   Signature[2] = Stream.Read(4);
 503   Signature[3] = Stream.Read(4);
 504   Signature[4] = Stream.Read(4);
 505   Signature[5] = Stream.Read(4);
 506
 507   // Autodetect the file contents, if it is one we know.
 508   CurStreamType = UnknownBitstream;
 509   if (Signature[0] == 'B' && Signature[1] == 'C' &&
 510       Signature[2] == 0x0 && Signature[3] == 0xC &&
 511       Signature[4] == 0xE && Signature[5] == 0xD)
 512     CurStreamType = LLVMIRBitstream;
 513
 514   unsigned NumTopBlocks = 0;
 515
 516   // Parse the top-level structure.  We only allow blocks at the top-level.
 517   while (!Stream.AtEndOfStream()) {
 518     unsigned Code = Stream.ReadCode();
 519     if (Code != bitc::ENTER_SUBBLOCK)
 520       return Error("Invalid record at top-level");
 521
 522     if (ParseBlock(Stream, 0))
 523       return true;
 524     ++NumTopBlocks;
 525   }
 526
 527   if (Dump) outs() << "\n\n";
 528
 529   uint64_t BufferSizeBits = (EndBufPtr-BufPtr)*CHAR_BIT;
 530   // Print a summary of the read file.
 531   outs() << "Summary of " << InputFilename << ":\n";
 532   outs() << "         Total size: ";
 533   PrintSize(BufferSizeBits);
 534   outs() << "\n";
 535   outs() << "        Stream type: ";
 536   switch (CurStreamType) {
 537   case UnknownBitstream: outs() << "unknown\n"; break;
 538   case LLVMIRBitstream:  outs() << "LLVM IR\n"; break;
 539   }
 540   outs() << "  # Toplevel Blocks: " << NumTopBlocks << "\n";
 541   outs() << "\n";
 542
 543   // Emit per-block stats.
 544   outs() << "Per-block Summary:\n";
 545   for (std::map<unsigned, PerBlockIDStats>::iterator I = BlockIDStats.begin(),
 546        E = BlockIDStats.end(); I != E; ++I) {
 547     outs() << "  Block ID #" << I->first;
 548     if (const char *BlockName = GetBlockName(I->first, StreamFile))
 549       outs() << " (" << BlockName << ")";
 550     outs() << ":\n";
 551
 552     const PerBlockIDStats &Stats = I->second;
 553     outs() << "      Num Instances: " << Stats.NumInstances << "\n";
 554     outs() << "         Total Size: ";
 555     PrintSize(Stats.NumBits);
 556     outs() << "\n";
 557     double pct = (Stats.NumBits * 100.0) / BufferSizeBits;
 558     outs() << "    Percent of file: " << format("%2.4f%%", pct) << "\n";
 559     if (Stats.NumInstances > 1) {
 560       outs() << "       Average Size: ";
 561       PrintSize(Stats.NumBits/(double)Stats.NumInstances);
 562       outs() << "\n";
 563       outs() << "  Tot/Avg SubBlocks: " << Stats.NumSubBlocks << "/"
 564              << Stats.NumSubBlocks/(double)Stats.NumInstances << "\n";
 565       outs() << "    Tot/Avg Abbrevs: " << Stats.NumAbbrevs << "/"
 566              << Stats.NumAbbrevs/(double)Stats.NumInstances << "\n";
 567       outs() << "    Tot/Avg Records: " << Stats.NumRecords << "/"
 568              << Stats.NumRecords/(double)Stats.NumInstances << "\n";
 569     } else {
 570       outs() << "      Num SubBlocks: " << Stats.NumSubBlocks << "\n";
 571       outs() << "        Num Abbrevs: " << Stats.NumAbbrevs << "\n";
 572       outs() << "        Num Records: " << Stats.NumRecords << "\n";
 573     }
 574     if (Stats.NumRecords) {
 575       double pct = (Stats.NumAbbreviatedRecords * 100.0) / Stats.NumRecords;
 576       outs() << "    Percent Abbrevs: " << format("%2.4f%%", pct) << "\n";
 577     }
 578     outs() << "\n";
 579
 580     // Print a histogram of the codes we see.
 581     if (!NoHistogram && !Stats.CodeFreq.empty()) {
 582       std::vector<std::pair<unsigned, unsigned> > FreqPairs;  // <freq,code>
 583       for (unsigned i = 0, e = Stats.CodeFreq.size(); i != e; ++i)
 584         if (unsigned Freq = Stats.CodeFreq[i].NumInstances)
 585           FreqPairs.push_back(std::make_pair(Freq, i));
 586       std::stable_sort(FreqPairs.begin(), FreqPairs.end());
 587       std::reverse(FreqPairs.begin(), FreqPairs.end());
 588
 589       outs() << "\tRecord Histogram:\n";
 590       outs() << "\t\t  Count    # Bits   %% Abv  Record Kind\n";
 591       for (unsigned i = 0, e = FreqPairs.size(); i != e; ++i) {
 592         const PerRecordStats &RecStats = Stats.CodeFreq[FreqPairs[i].second];
 593
 594         outs() << format("\t\t%7d %9lu",
 595                          RecStats.NumInstances,
 596                          (unsigned long)RecStats.TotalBits);
 597
 598         if (RecStats.NumAbbrev)
 599           outs() <<
 600               format("%7.2f  ",
 601                      (double)RecStats.NumAbbrev/RecStats.NumInstances*100);
 602         else
 603           outs() << "         ";
 604
 605         if (const char *CodeName =
 606               GetCodeName(FreqPairs[i].second, I->first, StreamFile))
 607           outs() << CodeName << "\n";
 608         else
 609           outs() << "UnknownCode" << FreqPairs[i].second << "\n";
 610       }
 611       outs() << "\n";
 612
 613     }
 614   }
 615   return 0;
 616 }
 617
 618
 619 int 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 }