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