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/Bitcode/BitstreamReader.h"
  31 #include "llvm/ADT/Optional.h"
  32 #include "llvm/Bitcode/LLVMBitCodes.h"
  33 #include "llvm/Bitcode/ReaderWriter.h"
  34 #include "llvm/IR/Verifier.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 <algorithm>
  43 #include <cctype>
  44 #include <map>
  45 #include <system_error>
  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 static cl::opt<std::string>
  66   BlockInfoFilename("block-info",
  67                     cl::desc("Use the BLOCK_INFO from the given file"));
  68
  69 static cl::opt<bool>
  70   ShowBinaryBlobs("show-binary-blobs",
  71                   cl::desc("Print binary blobs using hex escapes"));
  72
  73 namespace {
  74
  75 /// CurStreamTypeType - A type for CurStreamType
  76 enum CurStreamTypeType {
  77   UnknownBitstream,
  78   LLVMIRBitstream
  79 };
  80
  81 }
  82
  83 /// GetBlockName - Return a symbolic block name if known, otherwise return
  84 /// null.
  85 static const char *GetBlockName(unsigned BlockID,
  86                                 const BitstreamReader &StreamFile,
  87                                 CurStreamTypeType CurStreamType) {
  88   // Standard blocks for all bitcode files.
  89   if (BlockID < bitc::FIRST_APPLICATION_BLOCKID) {
  90     if (BlockID == bitc::BLOCKINFO_BLOCK_ID)
  91       return "BLOCKINFO_BLOCK";
  92     return nullptr;
  93   }
  94
  95   // Check to see if we have a blockinfo record for this block, with a name.
  96   if (const BitstreamReader::BlockInfo *Info =
  97         StreamFile.getBlockInfo(BlockID)) {
  98     if (!Info->Name.empty())
  99       return Info->Name.c_str();
 100   }
 101
 102
 103   if (CurStreamType != LLVMIRBitstream) return nullptr;
 104
 105   switch (BlockID) {
 106   default:                             return nullptr;
 107   case bitc::MODULE_BLOCK_ID:          return "MODULE_BLOCK";
 108   case bitc::PARAMATTR_BLOCK_ID:       return "PARAMATTR_BLOCK";
 109   case bitc::PARAMATTR_GROUP_BLOCK_ID: return "PARAMATTR_GROUP_BLOCK_ID";
 110   case bitc::TYPE_BLOCK_ID_NEW:        return "TYPE_BLOCK_ID";
 111   case bitc::CONSTANTS_BLOCK_ID:       return "CONSTANTS_BLOCK";
 112   case bitc::FUNCTION_BLOCK_ID:        return "FUNCTION_BLOCK";
 113   case bitc::VALUE_SYMTAB_BLOCK_ID:    return "VALUE_SYMTAB";
 114   case bitc::METADATA_BLOCK_ID:        return "METADATA_BLOCK";
 115   case bitc::METADATA_ATTACHMENT_ID:   return "METADATA_ATTACHMENT_BLOCK";
 116   case bitc::USELIST_BLOCK_ID:         return "USELIST_BLOCK_ID";
 117   }
 118 }
 119
 120 /// GetCodeName - Return a symbolic code name if known, otherwise return
 121 /// null.
 122 static const char *GetCodeName(unsigned CodeID, unsigned BlockID,
 123                                const BitstreamReader &StreamFile,
 124                                CurStreamTypeType CurStreamType) {
 125   // Standard blocks for all bitcode files.
 126   if (BlockID < bitc::FIRST_APPLICATION_BLOCKID) {
 127     if (BlockID == bitc::BLOCKINFO_BLOCK_ID) {
 128       switch (CodeID) {
 129       default: return nullptr;
 130       case bitc::BLOCKINFO_CODE_SETBID:        return "SETBID";
 131       case bitc::BLOCKINFO_CODE_BLOCKNAME:     return "BLOCKNAME";
 132       case bitc::BLOCKINFO_CODE_SETRECORDNAME: return "SETRECORDNAME";
 133       }
 134     }
 135     return nullptr;
 136   }
 137
 138   // Check to see if we have a blockinfo record for this record, with a name.
 139   if (const BitstreamReader::BlockInfo *Info =
 140         StreamFile.getBlockInfo(BlockID)) {
 141     for (unsigned i = 0, e = Info->RecordNames.size(); i != e; ++i)
 142       if (Info->RecordNames[i].first == CodeID)
 143         return Info->RecordNames[i].second.c_str();
 144   }
 145
 146
 147   if (CurStreamType != LLVMIRBitstream) return nullptr;
 148
 149 #define STRINGIFY_CODE(PREFIX, CODE)                                           \
 150   case bitc::PREFIX##_##CODE:                                                  \
 151     return #CODE;
 152   switch (BlockID) {
 153   default: return nullptr;
 154   case bitc::MODULE_BLOCK_ID:
 155     switch (CodeID) {
 156     default: return nullptr;
 157       STRINGIFY_CODE(MODULE_CODE, VERSION)
 158       STRINGIFY_CODE(MODULE_CODE, TRIPLE)
 159       STRINGIFY_CODE(MODULE_CODE, DATALAYOUT)
 160       STRINGIFY_CODE(MODULE_CODE, ASM)
 161       STRINGIFY_CODE(MODULE_CODE, SECTIONNAME)
 162       STRINGIFY_CODE(MODULE_CODE, DEPLIB) // FIXME: Remove in 4.0
 163       STRINGIFY_CODE(MODULE_CODE, GLOBALVAR)
 164       STRINGIFY_CODE(MODULE_CODE, FUNCTION)
 165       STRINGIFY_CODE(MODULE_CODE, ALIAS)
 166       STRINGIFY_CODE(MODULE_CODE, PURGEVALS)
 167       STRINGIFY_CODE(MODULE_CODE, GCNAME)
 168     }
 169   case bitc::PARAMATTR_BLOCK_ID:
 170     switch (CodeID) {
 171     default: return nullptr;
 172     // FIXME: Should these be different?
 173     case bitc::PARAMATTR_CODE_ENTRY_OLD: return "ENTRY";
 174     case bitc::PARAMATTR_CODE_ENTRY:     return "ENTRY";
 175     case bitc::PARAMATTR_GRP_CODE_ENTRY: return "ENTRY";
 176     }
 177   case bitc::TYPE_BLOCK_ID_NEW:
 178     switch (CodeID) {
 179     default: return nullptr;
 180       STRINGIFY_CODE(TYPE_CODE, NUMENTRY)
 181       STRINGIFY_CODE(TYPE_CODE, VOID)
 182       STRINGIFY_CODE(TYPE_CODE, FLOAT)
 183       STRINGIFY_CODE(TYPE_CODE, DOUBLE)
 184       STRINGIFY_CODE(TYPE_CODE, LABEL)
 185       STRINGIFY_CODE(TYPE_CODE, OPAQUE)
 186       STRINGIFY_CODE(TYPE_CODE, INTEGER)
 187       STRINGIFY_CODE(TYPE_CODE, POINTER)
 188       STRINGIFY_CODE(TYPE_CODE, ARRAY)
 189       STRINGIFY_CODE(TYPE_CODE, VECTOR)
 190       STRINGIFY_CODE(TYPE_CODE, X86_FP80)
 191       STRINGIFY_CODE(TYPE_CODE, FP128)
 192       STRINGIFY_CODE(TYPE_CODE, PPC_FP128)
 193       STRINGIFY_CODE(TYPE_CODE, METADATA)
 194       STRINGIFY_CODE(TYPE_CODE, STRUCT_ANON)
 195       STRINGIFY_CODE(TYPE_CODE, STRUCT_NAME)
 196       STRINGIFY_CODE(TYPE_CODE, STRUCT_NAMED)
 197       STRINGIFY_CODE(TYPE_CODE, FUNCTION)
 198     }
 199
 200   case bitc::CONSTANTS_BLOCK_ID:
 201     switch (CodeID) {
 202     default: return nullptr;
 203       STRINGIFY_CODE(CST_CODE, SETTYPE)
 204       STRINGIFY_CODE(CST_CODE, NULL)
 205       STRINGIFY_CODE(CST_CODE, UNDEF)
 206       STRINGIFY_CODE(CST_CODE, INTEGER)
 207       STRINGIFY_CODE(CST_CODE, WIDE_INTEGER)
 208       STRINGIFY_CODE(CST_CODE, FLOAT)
 209       STRINGIFY_CODE(CST_CODE, AGGREGATE)
 210       STRINGIFY_CODE(CST_CODE, STRING)
 211       STRINGIFY_CODE(CST_CODE, CSTRING)
 212       STRINGIFY_CODE(CST_CODE, CE_BINOP)
 213       STRINGIFY_CODE(CST_CODE, CE_CAST)
 214       STRINGIFY_CODE(CST_CODE, CE_GEP)
 215       STRINGIFY_CODE(CST_CODE, CE_INBOUNDS_GEP)
 216       STRINGIFY_CODE(CST_CODE, CE_SELECT)
 217       STRINGIFY_CODE(CST_CODE, CE_EXTRACTELT)
 218       STRINGIFY_CODE(CST_CODE, CE_INSERTELT)
 219       STRINGIFY_CODE(CST_CODE, CE_SHUFFLEVEC)
 220       STRINGIFY_CODE(CST_CODE, CE_CMP)
 221       STRINGIFY_CODE(CST_CODE, INLINEASM)
 222       STRINGIFY_CODE(CST_CODE, CE_SHUFVEC_EX)
 223     case bitc::CST_CODE_BLOCKADDRESS:    return "CST_CODE_BLOCKADDRESS";
 224       STRINGIFY_CODE(CST_CODE, DATA)
 225     }
 226   case bitc::FUNCTION_BLOCK_ID:
 227     switch (CodeID) {
 228     default: return nullptr;
 229       STRINGIFY_CODE(FUNC_CODE, DECLAREBLOCKS)
 230       STRINGIFY_CODE(FUNC_CODE, INST_BINOP)
 231       STRINGIFY_CODE(FUNC_CODE, INST_CAST)
 232       STRINGIFY_CODE(FUNC_CODE, INST_GEP_OLD)
 233       STRINGIFY_CODE(FUNC_CODE, INST_INBOUNDS_GEP_OLD)
 234       STRINGIFY_CODE(FUNC_CODE, INST_SELECT)
 235       STRINGIFY_CODE(FUNC_CODE, INST_EXTRACTELT)
 236       STRINGIFY_CODE(FUNC_CODE, INST_INSERTELT)
 237       STRINGIFY_CODE(FUNC_CODE, INST_SHUFFLEVEC)
 238       STRINGIFY_CODE(FUNC_CODE, INST_CMP)
 239       STRINGIFY_CODE(FUNC_CODE, INST_RET)
 240       STRINGIFY_CODE(FUNC_CODE, INST_BR)
 241       STRINGIFY_CODE(FUNC_CODE, INST_SWITCH)
 242       STRINGIFY_CODE(FUNC_CODE, INST_INVOKE)
 243       STRINGIFY_CODE(FUNC_CODE, INST_UNREACHABLE)
 244       STRINGIFY_CODE(FUNC_CODE, INST_PHI)
 245       STRINGIFY_CODE(FUNC_CODE, INST_ALLOCA)
 246       STRINGIFY_CODE(FUNC_CODE, INST_LOAD)
 247       STRINGIFY_CODE(FUNC_CODE, INST_VAARG)
 248       STRINGIFY_CODE(FUNC_CODE, INST_STORE)
 249       STRINGIFY_CODE(FUNC_CODE, INST_EXTRACTVAL)
 250       STRINGIFY_CODE(FUNC_CODE, INST_INSERTVAL)
 251       STRINGIFY_CODE(FUNC_CODE, INST_CMP2)
 252       STRINGIFY_CODE(FUNC_CODE, INST_VSELECT)
 253       STRINGIFY_CODE(FUNC_CODE, DEBUG_LOC_AGAIN)
 254       STRINGIFY_CODE(FUNC_CODE, INST_CALL)
 255       STRINGIFY_CODE(FUNC_CODE, DEBUG_LOC)
 256       STRINGIFY_CODE(FUNC_CODE, INST_GEP)
 257     }
 258   case bitc::VALUE_SYMTAB_BLOCK_ID:
 259     switch (CodeID) {
 260     default: return nullptr;
 261     STRINGIFY_CODE(VST_CODE, ENTRY)
 262     STRINGIFY_CODE(VST_CODE, BBENTRY)
 263     }
 264   case bitc::METADATA_ATTACHMENT_ID:
 265     switch(CodeID) {
 266     default:return nullptr;
 267       STRINGIFY_CODE(METADATA, ATTACHMENT)
 268     }
 269   case bitc::METADATA_BLOCK_ID:
 270     switch(CodeID) {
 271     default:return nullptr;
 272       STRINGIFY_CODE(METADATA, STRING)
 273       STRINGIFY_CODE(METADATA, NAME)
 274       STRINGIFY_CODE(METADATA, KIND)
 275       STRINGIFY_CODE(METADATA, NODE)
 276       STRINGIFY_CODE(METADATA, VALUE)
 277       STRINGIFY_CODE(METADATA, OLD_NODE)
 278       STRINGIFY_CODE(METADATA, OLD_FN_NODE)
 279       STRINGIFY_CODE(METADATA, NAMED_NODE)
 280       STRINGIFY_CODE(METADATA, DISTINCT_NODE)
 281       STRINGIFY_CODE(METADATA, LOCATION)
 282       STRINGIFY_CODE(METADATA, GENERIC_DEBUG)
 283       STRINGIFY_CODE(METADATA, SUBRANGE)
 284       STRINGIFY_CODE(METADATA, ENUMERATOR)
 285       STRINGIFY_CODE(METADATA, BASIC_TYPE)
 286       STRINGIFY_CODE(METADATA, FILE)
 287       STRINGIFY_CODE(METADATA, DERIVED_TYPE)
 288       STRINGIFY_CODE(METADATA, COMPOSITE_TYPE)
 289       STRINGIFY_CODE(METADATA, SUBROUTINE_TYPE)
 290       STRINGIFY_CODE(METADATA, COMPILE_UNIT)
 291       STRINGIFY_CODE(METADATA, SUBPROGRAM)
 292       STRINGIFY_CODE(METADATA, LEXICAL_BLOCK)
 293       STRINGIFY_CODE(METADATA, LEXICAL_BLOCK_FILE)
 294       STRINGIFY_CODE(METADATA, NAMESPACE)
 295       STRINGIFY_CODE(METADATA, TEMPLATE_TYPE)
 296       STRINGIFY_CODE(METADATA, TEMPLATE_VALUE)
 297       STRINGIFY_CODE(METADATA, GLOBAL_VAR)
 298       STRINGIFY_CODE(METADATA, LOCAL_VAR)
 299       STRINGIFY_CODE(METADATA, EXPRESSION)
 300       STRINGIFY_CODE(METADATA, OBJC_PROPERTY)
 301       STRINGIFY_CODE(METADATA, IMPORTED_ENTITY)
 302       STRINGIFY_CODE(METADATA, MODULE)
 303     }
 304   case bitc::USELIST_BLOCK_ID:
 305     switch(CodeID) {
 306     default:return nullptr;
 307     case bitc::USELIST_CODE_DEFAULT: return "USELIST_CODE_DEFAULT";
 308     case bitc::USELIST_CODE_BB:      return "USELIST_CODE_BB";
 309     }
 310   }
 311 #undef STRINGIFY_CODE
 312 }
 313
 314 struct PerRecordStats {
 315   unsigned NumInstances;
 316   unsigned NumAbbrev;
 317   uint64_t TotalBits;
 318
 319   PerRecordStats() : NumInstances(0), NumAbbrev(0), TotalBits(0) {}
 320 };
 321
 322 struct PerBlockIDStats {
 323   /// NumInstances - This the number of times this block ID has been seen.
 324   unsigned NumInstances;
 325
 326   /// NumBits - The total size in bits of all of these blocks.
 327   uint64_t NumBits;
 328
 329   /// NumSubBlocks - The total number of blocks these blocks contain.
 330   unsigned NumSubBlocks;
 331
 332   /// NumAbbrevs - The total number of abbreviations.
 333   unsigned NumAbbrevs;
 334
 335   /// NumRecords - The total number of records these blocks contain, and the
 336   /// number that are abbreviated.
 337   unsigned NumRecords, NumAbbreviatedRecords;
 338
 339   /// CodeFreq - Keep track of the number of times we see each code.
 340   std::vector<PerRecordStats> CodeFreq;
 341
 342   PerBlockIDStats()
 343     : NumInstances(0), NumBits(0),
 344       NumSubBlocks(0), NumAbbrevs(0), NumRecords(0), NumAbbreviatedRecords(0) {}
 345 };
 346
 347 static std::map<unsigned, PerBlockIDStats> BlockIDStats;
 348
 349
 350
 351 /// Error - All bitcode analysis errors go through this function, making this a
 352 /// good place to breakpoint if debugging.
 353 static bool Error(const Twine &Err) {
 354   errs() << Err << "\n";
 355   return true;
 356 }
 357
 358 /// ParseBlock - Read a block, updating statistics, etc.
 359 static bool ParseBlock(BitstreamCursor &Stream, unsigned BlockID,
 360                        unsigned IndentLevel, CurStreamTypeType CurStreamType) {
 361   std::string Indent(IndentLevel*2, ' ');
 362   uint64_t BlockBitStart = Stream.GetCurrentBitNo();
 363
 364   // Get the statistics for this BlockID.
 365   PerBlockIDStats &BlockStats = BlockIDStats[BlockID];
 366
 367   BlockStats.NumInstances++;
 368
 369   // BLOCKINFO is a special part of the stream.
 370   if (BlockID == bitc::BLOCKINFO_BLOCK_ID) {
 371     if (Dump) outs() << Indent << "<BLOCKINFO_BLOCK/>\n";
 372     if (Stream.ReadBlockInfoBlock())
 373       return Error("Malformed BlockInfoBlock");
 374     uint64_t BlockBitEnd = Stream.GetCurrentBitNo();
 375     BlockStats.NumBits += BlockBitEnd-BlockBitStart;
 376     return false;
 377   }
 378
 379   unsigned NumWords = 0;
 380   if (Stream.EnterSubBlock(BlockID, &NumWords))
 381     return Error("Malformed block record");
 382
 383   const char *BlockName = nullptr;
 384   if (Dump) {
 385     outs() << Indent << "<";
 386     if ((BlockName = GetBlockName(BlockID, *Stream.getBitStreamReader(),
 387                                   CurStreamType)))
 388       outs() << BlockName;
 389     else
 390       outs() << "UnknownBlock" << BlockID;
 391
 392     if (NonSymbolic && BlockName)
 393       outs() << " BlockID=" << BlockID;
 394
 395     outs() << " NumWords=" << NumWords
 396            << " BlockCodeSize=" << Stream.getAbbrevIDWidth() << ">\n";
 397   }
 398
 399   SmallVector<uint64_t, 64> Record;
 400
 401   // Read all the records for this block.
 402   while (1) {
 403     if (Stream.AtEndOfStream())
 404       return Error("Premature end of bitstream");
 405
 406     uint64_t RecordStartBit = Stream.GetCurrentBitNo();
 407
 408     BitstreamEntry Entry =
 409       Stream.advance(BitstreamCursor::AF_DontAutoprocessAbbrevs);
 410
 411     switch (Entry.Kind) {
 412     case BitstreamEntry::Error:
 413       return Error("malformed bitcode file");
 414     case BitstreamEntry::EndBlock: {
 415       uint64_t BlockBitEnd = Stream.GetCurrentBitNo();
 416       BlockStats.NumBits += BlockBitEnd-BlockBitStart;
 417       if (Dump) {
 418         outs() << Indent << "</";
 419         if (BlockName)
 420           outs() << BlockName << ">\n";
 421         else
 422           outs() << "UnknownBlock" << BlockID << ">\n";
 423       }
 424       return false;
 425     }
 426
 427     case BitstreamEntry::SubBlock: {
 428       uint64_t SubBlockBitStart = Stream.GetCurrentBitNo();
 429       if (ParseBlock(Stream, Entry.ID, IndentLevel+1, CurStreamType))
 430         return true;
 431       ++BlockStats.NumSubBlocks;
 432       uint64_t SubBlockBitEnd = Stream.GetCurrentBitNo();
 433
 434       // Don't include subblock sizes in the size of this block.
 435       BlockBitStart += SubBlockBitEnd-SubBlockBitStart;
 436       continue;
 437     }
 438     case BitstreamEntry::Record:
 439       // The interesting case.
 440       break;
 441     }
 442
 443     if (Entry.ID == bitc::DEFINE_ABBREV) {
 444       Stream.ReadAbbrevRecord();
 445       ++BlockStats.NumAbbrevs;
 446       continue;
 447     }
 448
 449     Record.clear();
 450
 451     ++BlockStats.NumRecords;
 452
 453     StringRef Blob;
 454     unsigned Code = Stream.readRecord(Entry.ID, Record, &Blob);
 455
 456     // Increment the # occurrences of this code.
 457     if (BlockStats.CodeFreq.size() <= Code)
 458       BlockStats.CodeFreq.resize(Code+1);
 459     BlockStats.CodeFreq[Code].NumInstances++;
 460     BlockStats.CodeFreq[Code].TotalBits +=
 461       Stream.GetCurrentBitNo()-RecordStartBit;
 462     if (Entry.ID != bitc::UNABBREV_RECORD) {
 463       BlockStats.CodeFreq[Code].NumAbbrev++;
 464       ++BlockStats.NumAbbreviatedRecords;
 465     }
 466
 467     if (Dump) {
 468       outs() << Indent << "  <";
 469       if (const char *CodeName =
 470             GetCodeName(Code, BlockID, *Stream.getBitStreamReader(),
 471                         CurStreamType))
 472         outs() << CodeName;
 473       else
 474         outs() << "UnknownCode" << Code;
 475       if (NonSymbolic &&
 476           GetCodeName(Code, BlockID, *Stream.getBitStreamReader(),
 477                       CurStreamType))
 478         outs() << " codeid=" << Code;
 479       if (Entry.ID != bitc::UNABBREV_RECORD)
 480         outs() << " abbrevid=" << Entry.ID;
 481
 482       for (unsigned i = 0, e = Record.size(); i != e; ++i)
 483         outs() << " op" << i << "=" << (int64_t)Record[i];
 484
 485       outs() << "/>";
 486
 487       if (Blob.data()) {
 488         outs() << " blob data = ";
 489         if (ShowBinaryBlobs) {
 490           outs() << "'";
 491           outs().write_escaped(Blob, /*hex=*/true) << "'";
 492         } else {
 493           bool BlobIsPrintable = true;
 494           for (unsigned i = 0, e = Blob.size(); i != e; ++i)
 495             if (!isprint(static_cast<unsigned char>(Blob[i]))) {
 496               BlobIsPrintable = false;
 497               break;
 498             }
 499
 500           if (BlobIsPrintable)
 501             outs() << "'" << Blob << "'";
 502           else
 503             outs() << "unprintable, " << Blob.size() << " bytes.";
 504         }
 505       }
 506
 507       outs() << "\n";
 508     }
 509   }
 510 }
 511
 512 static void PrintSize(double Bits) {
 513   outs() << format("%.2f/%.2fB/%luW", Bits, Bits/8,(unsigned long)(Bits/32));
 514 }
 515 static void PrintSize(uint64_t Bits) {
 516   outs() << format("%lub/%.2fB/%luW", (unsigned long)Bits,
 517                    (double)Bits/8, (unsigned long)(Bits/32));
 518 }
 519
 520 static bool openBitcodeFile(StringRef Path,
 521                             std::unique_ptr<MemoryBuffer> &MemBuf,
 522                             BitstreamReader &StreamFile,
 523                             BitstreamCursor &Stream,
 524                             CurStreamTypeType &CurStreamType) {
 525   // Read the input file.
 526   ErrorOr<std::unique_ptr<MemoryBuffer>> MemBufOrErr =
 527       MemoryBuffer::getFileOrSTDIN(Path);
 528   if (std::error_code EC = MemBufOrErr.getError())
 529     return Error(Twine("Error reading '") + Path + "': " + EC.message());
 530   MemBuf = std::move(MemBufOrErr.get());
 531
 532   if (MemBuf->getBufferSize() & 3)
 533     return Error("Bitcode stream should be a multiple of 4 bytes in length");
 534
 535   const unsigned char *BufPtr = (const unsigned char *)MemBuf->getBufferStart();
 536   const unsigned char *EndBufPtr = BufPtr + MemBuf->getBufferSize();
 537
 538   // If we have a wrapper header, parse it and ignore the non-bc file contents.
 539   // The magic number is 0x0B17C0DE stored in little endian.
 540   if (isBitcodeWrapper(BufPtr, EndBufPtr))
 541     if (SkipBitcodeWrapperHeader(BufPtr, EndBufPtr, true))
 542       return Error("Invalid bitcode wrapper header");
 543
 544   StreamFile = BitstreamReader(BufPtr, EndBufPtr);
 545   Stream = BitstreamCursor(StreamFile);
 546   StreamFile.CollectBlockInfoNames();
 547
 548   // Read the stream signature.
 549   char Signature[6];
 550   Signature[0] = Stream.Read(8);
 551   Signature[1] = Stream.Read(8);
 552   Signature[2] = Stream.Read(4);
 553   Signature[3] = Stream.Read(4);
 554   Signature[4] = Stream.Read(4);
 555   Signature[5] = Stream.Read(4);
 556
 557   // Autodetect the file contents, if it is one we know.
 558   CurStreamType = UnknownBitstream;
 559   if (Signature[0] == 'B' && Signature[1] == 'C' &&
 560       Signature[2] == 0x0 && Signature[3] == 0xC &&
 561       Signature[4] == 0xE && Signature[5] == 0xD)
 562     CurStreamType = LLVMIRBitstream;
 563
 564   return false;
 565 }
 566
 567 /// AnalyzeBitcode - Analyze the bitcode file specified by InputFilename.
 568 static int AnalyzeBitcode() {
 569   std::unique_ptr<MemoryBuffer> StreamBuffer;
 570   BitstreamReader StreamFile;
 571   BitstreamCursor Stream;
 572   CurStreamTypeType CurStreamType;
 573   if (openBitcodeFile(InputFilename, StreamBuffer, StreamFile, Stream,
 574                       CurStreamType))
 575     return true;
 576
 577   // Read block info from BlockInfoFilename, if specified.
 578   // The block info must be a top-level block.
 579   if (!BlockInfoFilename.empty()) {
 580     std::unique_ptr<MemoryBuffer> BlockInfoBuffer;
 581     BitstreamReader BlockInfoFile;
 582     BitstreamCursor BlockInfoCursor;
 583     CurStreamTypeType BlockInfoStreamType;
 584     if (openBitcodeFile(BlockInfoFilename, BlockInfoBuffer, BlockInfoFile,
 585                         BlockInfoCursor, BlockInfoStreamType))
 586       return true;
 587
 588     while (!BlockInfoCursor.AtEndOfStream()) {
 589       unsigned Code = BlockInfoCursor.ReadCode();
 590       if (Code != bitc::ENTER_SUBBLOCK)
 591         return Error("Invalid record at top-level in block info file");
 592
 593       unsigned BlockID = BlockInfoCursor.ReadSubBlockID();
 594       if (BlockID == bitc::BLOCKINFO_BLOCK_ID) {
 595         if (BlockInfoCursor.ReadBlockInfoBlock())
 596           return Error("Malformed BlockInfoBlock in block info file");
 597         break;
 598       }
 599
 600       BlockInfoCursor.SkipBlock();
 601     }
 602
 603     StreamFile.takeBlockInfo(std::move(BlockInfoFile));
 604   }
 605
 606   unsigned NumTopBlocks = 0;
 607
 608   // Parse the top-level structure.  We only allow blocks at the top-level.
 609   while (!Stream.AtEndOfStream()) {
 610     unsigned Code = Stream.ReadCode();
 611     if (Code != bitc::ENTER_SUBBLOCK)
 612       return Error("Invalid record at top-level");
 613
 614     unsigned BlockID = Stream.ReadSubBlockID();
 615
 616     if (ParseBlock(Stream, BlockID, 0, CurStreamType))
 617       return true;
 618     ++NumTopBlocks;
 619   }
 620
 621   if (Dump) outs() << "\n\n";
 622
 623   uint64_t BufferSizeBits = StreamFile.getBitcodeBytes().getExtent() * CHAR_BIT;
 624   // Print a summary of the read file.
 625   outs() << "Summary of " << InputFilename << ":\n";
 626   outs() << "         Total size: ";
 627   PrintSize(BufferSizeBits);
 628   outs() << "\n";
 629   outs() << "        Stream type: ";
 630   switch (CurStreamType) {
 631   case UnknownBitstream: outs() << "unknown\n"; break;
 632   case LLVMIRBitstream:  outs() << "LLVM IR\n"; break;
 633   }
 634   outs() << "  # Toplevel Blocks: " << NumTopBlocks << "\n";
 635   outs() << "\n";
 636
 637   // Emit per-block stats.
 638   outs() << "Per-block Summary:\n";
 639   for (std::map<unsigned, PerBlockIDStats>::iterator I = BlockIDStats.begin(),
 640        E = BlockIDStats.end(); I != E; ++I) {
 641     outs() << "  Block ID #" << I->first;
 642     if (const char *BlockName = GetBlockName(I->first, StreamFile,
 643                                              CurStreamType))
 644       outs() << " (" << BlockName << ")";
 645     outs() << ":\n";
 646
 647     const PerBlockIDStats &Stats = I->second;
 648     outs() << "      Num Instances: " << Stats.NumInstances << "\n";
 649     outs() << "         Total Size: ";
 650     PrintSize(Stats.NumBits);
 651     outs() << "\n";
 652     double pct = (Stats.NumBits * 100.0) / BufferSizeBits;
 653     outs() << "    Percent of file: " << format("%2.4f%%", pct) << "\n";
 654     if (Stats.NumInstances > 1) {
 655       outs() << "       Average Size: ";
 656       PrintSize(Stats.NumBits/(double)Stats.NumInstances);
 657       outs() << "\n";
 658       outs() << "  Tot/Avg SubBlocks: " << Stats.NumSubBlocks << "/"
 659              << Stats.NumSubBlocks/(double)Stats.NumInstances << "\n";
 660       outs() << "    Tot/Avg Abbrevs: " << Stats.NumAbbrevs << "/"
 661              << Stats.NumAbbrevs/(double)Stats.NumInstances << "\n";
 662       outs() << "    Tot/Avg Records: " << Stats.NumRecords << "/"
 663              << Stats.NumRecords/(double)Stats.NumInstances << "\n";
 664     } else {
 665       outs() << "      Num SubBlocks: " << Stats.NumSubBlocks << "\n";
 666       outs() << "        Num Abbrevs: " << Stats.NumAbbrevs << "\n";
 667       outs() << "        Num Records: " << Stats.NumRecords << "\n";
 668     }
 669     if (Stats.NumRecords) {
 670       double pct = (Stats.NumAbbreviatedRecords * 100.0) / Stats.NumRecords;
 671       outs() << "    Percent Abbrevs: " << format("%2.4f%%", pct) << "\n";
 672     }
 673     outs() << "\n";
 674
 675     // Print a histogram of the codes we see.
 676     if (!NoHistogram && !Stats.CodeFreq.empty()) {
 677       std::vector<std::pair<unsigned, unsigned> > FreqPairs;  // <freq,code>
 678       for (unsigned i = 0, e = Stats.CodeFreq.size(); i != e; ++i)
 679         if (unsigned Freq = Stats.CodeFreq[i].NumInstances)
 680           FreqPairs.push_back(std::make_pair(Freq, i));
 681       std::stable_sort(FreqPairs.begin(), FreqPairs.end());
 682       std::reverse(FreqPairs.begin(), FreqPairs.end());
 683
 684       outs() << "\tRecord Histogram:\n";
 685       outs() << "\t\t  Count    # Bits   %% Abv  Record Kind\n";
 686       for (unsigned i = 0, e = FreqPairs.size(); i != e; ++i) {
 687         const PerRecordStats &RecStats = Stats.CodeFreq[FreqPairs[i].second];
 688
 689         outs() << format("\t\t%7d %9lu",
 690                          RecStats.NumInstances,
 691                          (unsigned long)RecStats.TotalBits);
 692
 693         if (RecStats.NumAbbrev)
 694           outs() <<
 695               format("%7.2f  ",
 696                      (double)RecStats.NumAbbrev/RecStats.NumInstances*100);
 697         else
 698           outs() << "         ";
 699
 700         if (const char *CodeName =
 701               GetCodeName(FreqPairs[i].second, I->first, StreamFile,
 702                           CurStreamType))
 703           outs() << CodeName << "\n";
 704         else
 705           outs() << "UnknownCode" << FreqPairs[i].second << "\n";
 706       }
 707       outs() << "\n";
 708
 709     }
 710   }
 711   return 0;
 712 }
 713
 714
 715 int main(int argc, char **argv) {
 716   // Print a stack trace if we signal out.
 717   sys::PrintStackTraceOnErrorSignal();
 718   PrettyStackTraceProgram X(argc, argv);
 719   llvm_shutdown_obj Y;  // Call llvm_shutdown() on exit.
 720   cl::ParseCommandLineOptions(argc, argv, "llvm-bcanalyzer file analyzer\n");
 721
 722   return AnalyzeBitcode();
 723 }