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     }
 241   case bitc::TYPE_SYMTAB_BLOCK_ID:
 242     switch (CodeID) {
 243     default: return 0;
 244     case bitc::TST_CODE_ENTRY: return "ENTRY";
 245     }
 246   case bitc::VALUE_SYMTAB_BLOCK_ID:
 247     switch (CodeID) {
 248     default: return 0;
 249     case bitc::VST_CODE_ENTRY: return "ENTRY";
 250     case bitc::VST_CODE_BBENTRY: return "BBENTRY";
 251     }
 252   case bitc::METADATA_ATTACHMENT_ID:
 253     switch(CodeID) {
 254     default:return 0;
 255     case bitc::METADATA_ATTACHMENT:  return "METADATA_ATTACHMENT";
 256     }
 257   case bitc::METADATA_BLOCK_ID:
 258     switch(CodeID) {
 259     default:return 0;
 260     case bitc::METADATA_STRING:      return "MDSTRING";
 261     case bitc::METADATA_NODE:        return "MDNODE";
 262     case bitc::METADATA_FN_NODE:     return "FN_MDNODE";
 263     case bitc::METADATA_NAME:        return "METADATA_NAME";
 264     case bitc::METADATA_NAMED_NODE:  return "NAMEDMDNODE";
 265     case bitc::METADATA_KIND:        return "METADATA_KIND";
 266     case bitc::METADATA_ATTACHMENT:  return "METADATA_ATTACHMENT";
 267     }
 268   }
 269 }
 270
 271 struct PerRecordStats {
 272   unsigned NumInstances;
 273   unsigned NumAbbrev;
 274   uint64_t TotalBits;
 275
 276   PerRecordStats() : NumInstances(0), NumAbbrev(0), TotalBits(0) {}
 277 };
 278
 279 struct PerBlockIDStats {
 280   /// NumInstances - This the number of times this block ID has been seen.
 281   unsigned NumInstances;
 282
 283   /// NumBits - The total size in bits of all of these blocks.
 284   uint64_t NumBits;
 285
 286   /// NumSubBlocks - The total number of blocks these blocks contain.
 287   unsigned NumSubBlocks;
 288
 289   /// NumAbbrevs - The total number of abbreviations.
 290   unsigned NumAbbrevs;
 291
 292   /// NumRecords - The total number of records these blocks contain, and the
 293   /// number that are abbreviated.
 294   unsigned NumRecords, NumAbbreviatedRecords;
 295
 296   /// CodeFreq - Keep track of the number of times we see each code.
 297   std::vector<PerRecordStats> CodeFreq;
 298
 299   PerBlockIDStats()
 300     : NumInstances(0), NumBits(0),
 301       NumSubBlocks(0), NumAbbrevs(0), NumRecords(0), NumAbbreviatedRecords(0) {}
 302 };
 303
 304 static std::map<unsigned, PerBlockIDStats> BlockIDStats;
 305
 306
 307
 308 /// Error - All bitcode analysis errors go through this function, making this a
 309 /// good place to breakpoint if debugging.
 310 static bool Error(const std::string &Err) {
 311   errs() << Err << "\n";
 312   return true;
 313 }
 314
 315 /// ParseBlock - Read a block, updating statistics, etc.
 316 static bool ParseBlock(BitstreamCursor &Stream, unsigned IndentLevel) {
 317   std::string Indent(IndentLevel*2, ' ');
 318   uint64_t BlockBitStart = Stream.GetCurrentBitNo();
 319   unsigned BlockID = Stream.ReadSubBlockID();
 320
 321   // Get the statistics for this BlockID.
 322   PerBlockIDStats &BlockStats = BlockIDStats[BlockID];
 323
 324   BlockStats.NumInstances++;
 325
 326   // BLOCKINFO is a special part of the stream.
 327   if (BlockID == bitc::BLOCKINFO_BLOCK_ID) {
 328     if (Dump) errs() << Indent << "<BLOCKINFO_BLOCK/>\n";
 329     if (Stream.ReadBlockInfoBlock())
 330       return Error("Malformed BlockInfoBlock");
 331     uint64_t BlockBitEnd = Stream.GetCurrentBitNo();
 332     BlockStats.NumBits += BlockBitEnd-BlockBitStart;
 333     return false;
 334   }
 335
 336   unsigned NumWords = 0;
 337   if (Stream.EnterSubBlock(BlockID, &NumWords))
 338     return Error("Malformed block record");
 339
 340   const char *BlockName = 0;
 341   if (Dump) {
 342     errs() << Indent << "<";
 343     if ((BlockName = GetBlockName(BlockID, *Stream.getBitStreamReader())))
 344       errs() << BlockName;
 345     else
 346       errs() << "UnknownBlock" << BlockID;
 347
 348     if (NonSymbolic && BlockName)
 349       errs() << " BlockID=" << BlockID;
 350
 351     errs() << " NumWords=" << NumWords
 352            << " BlockCodeSize=" << Stream.GetAbbrevIDWidth() << ">\n";
 353   }
 354
 355   SmallVector<uint64_t, 64> Record;
 356
 357   // Read all the records for this block.
 358   while (1) {
 359     if (Stream.AtEndOfStream())
 360       return Error("Premature end of bitstream");
 361
 362     uint64_t RecordStartBit = Stream.GetCurrentBitNo();
 363
 364     // Read the code for this record.
 365     unsigned AbbrevID = Stream.ReadCode();
 366     switch (AbbrevID) {
 367     case bitc::END_BLOCK: {
 368       if (Stream.ReadBlockEnd())
 369         return Error("Error at end of block");
 370       uint64_t BlockBitEnd = Stream.GetCurrentBitNo();
 371       BlockStats.NumBits += BlockBitEnd-BlockBitStart;
 372       if (Dump) {
 373         errs() << Indent << "</";
 374         if (BlockName)
 375           errs() << BlockName << ">\n";
 376         else
 377           errs() << "UnknownBlock" << BlockID << ">\n";
 378       }
 379       return false;
 380     }
 381     case bitc::ENTER_SUBBLOCK: {
 382       uint64_t SubBlockBitStart = Stream.GetCurrentBitNo();
 383       if (ParseBlock(Stream, IndentLevel+1))
 384         return true;
 385       ++BlockStats.NumSubBlocks;
 386       uint64_t SubBlockBitEnd = Stream.GetCurrentBitNo();
 387
 388       // Don't include subblock sizes in the size of this block.
 389       BlockBitStart += SubBlockBitEnd-SubBlockBitStart;
 390       break;
 391     }
 392     case bitc::DEFINE_ABBREV:
 393       Stream.ReadAbbrevRecord();
 394       ++BlockStats.NumAbbrevs;
 395       break;
 396     default:
 397       Record.clear();
 398
 399       ++BlockStats.NumRecords;
 400       if (AbbrevID != bitc::UNABBREV_RECORD)
 401         ++BlockStats.NumAbbreviatedRecords;
 402
 403       const char *BlobStart = 0;
 404       unsigned BlobLen = 0;
 405       unsigned Code = Stream.ReadRecord(AbbrevID, Record, BlobStart, BlobLen);
 406
 407
 408
 409       // Increment the # occurrences of this code.
 410       if (BlockStats.CodeFreq.size() <= Code)
 411         BlockStats.CodeFreq.resize(Code+1);
 412       BlockStats.CodeFreq[Code].NumInstances++;
 413       BlockStats.CodeFreq[Code].TotalBits +=
 414         Stream.GetCurrentBitNo()-RecordStartBit;
 415       if (AbbrevID != bitc::UNABBREV_RECORD)
 416         BlockStats.CodeFreq[Code].NumAbbrev++;
 417
 418       if (Dump) {
 419         errs() << Indent << "  <";
 420         if (const char *CodeName =
 421               GetCodeName(Code, BlockID, *Stream.getBitStreamReader()))
 422           errs() << CodeName;
 423         else
 424           errs() << "UnknownCode" << Code;
 425         if (NonSymbolic &&
 426             GetCodeName(Code, BlockID, *Stream.getBitStreamReader()))
 427           errs() << " codeid=" << Code;
 428         if (AbbrevID != bitc::UNABBREV_RECORD)
 429           errs() << " abbrevid=" << AbbrevID;
 430
 431         for (unsigned i = 0, e = Record.size(); i != e; ++i)
 432           errs() << " op" << i << "=" << (int64_t)Record[i];
 433
 434         errs() << "/>";
 435
 436         if (BlobStart) {
 437           errs() << " blob data = ";
 438           bool BlobIsPrintable = true;
 439           for (unsigned i = 0; i != BlobLen; ++i)
 440             if (!isprint(BlobStart[i])) {
 441               BlobIsPrintable = false;
 442               break;
 443             }
 444
 445           if (BlobIsPrintable)
 446             errs() << "'" << std::string(BlobStart, BlobStart+BlobLen) <<"'";
 447           else
 448             errs() << "unprintable, " << BlobLen << " bytes.";
 449         }
 450
 451         errs() << "\n";
 452       }
 453
 454       break;
 455     }
 456   }
 457 }
 458
 459 static void PrintSize(double Bits) {
 460   fprintf(stderr, "%.2f/%.2fB/%lluW", Bits, Bits/8,(unsigned long long)Bits/32);
 461 }
 462 static void PrintSize(uint64_t Bits) {
 463   fprintf(stderr, "%llub/%.2fB/%lluW", (unsigned long long)Bits,
 464           (double)Bits/8, (unsigned long long)Bits/32);
 465 }
 466
 467
 468 /// AnalyzeBitcode - Analyze the bitcode file specified by InputFilename.
 469 static int AnalyzeBitcode() {
 470   // Read the input file.
 471   MemoryBuffer *MemBuf = MemoryBuffer::getFileOrSTDIN(InputFilename.c_str());
 472
 473   if (MemBuf == 0)
 474     return Error("Error reading '" + InputFilename + "'.");
 475
 476   if (MemBuf->getBufferSize() & 3)
 477     return Error("Bitcode stream should be a multiple of 4 bytes in length");
 478
 479   unsigned char *BufPtr = (unsigned char *)MemBuf->getBufferStart();
 480   unsigned char *EndBufPtr = BufPtr+MemBuf->getBufferSize();
 481
 482   // If we have a wrapper header, parse it and ignore the non-bc file contents.
 483   // The magic number is 0x0B17C0DE stored in little endian.
 484   if (isBitcodeWrapper(BufPtr, EndBufPtr))
 485     if (SkipBitcodeWrapperHeader(BufPtr, EndBufPtr))
 486       return Error("Invalid bitcode wrapper header");
 487
 488   BitstreamReader StreamFile(BufPtr, EndBufPtr);
 489   BitstreamCursor Stream(StreamFile);
 490   StreamFile.CollectBlockInfoNames();
 491
 492   // Read the stream signature.
 493   char Signature[6];
 494   Signature[0] = Stream.Read(8);
 495   Signature[1] = Stream.Read(8);
 496   Signature[2] = Stream.Read(4);
 497   Signature[3] = Stream.Read(4);
 498   Signature[4] = Stream.Read(4);
 499   Signature[5] = Stream.Read(4);
 500
 501   // Autodetect the file contents, if it is one we know.
 502   CurStreamType = UnknownBitstream;
 503   if (Signature[0] == 'B' && Signature[1] == 'C' &&
 504       Signature[2] == 0x0 && Signature[3] == 0xC &&
 505       Signature[4] == 0xE && Signature[5] == 0xD)
 506     CurStreamType = LLVMIRBitstream;
 507
 508   unsigned NumTopBlocks = 0;
 509
 510   // Parse the top-level structure.  We only allow blocks at the top-level.
 511   while (!Stream.AtEndOfStream()) {
 512     unsigned Code = Stream.ReadCode();
 513     if (Code != bitc::ENTER_SUBBLOCK)
 514       return Error("Invalid record at top-level");
 515
 516     if (ParseBlock(Stream, 0))
 517       return true;
 518     ++NumTopBlocks;
 519   }
 520
 521   if (Dump) errs() << "\n\n";
 522
 523   uint64_t BufferSizeBits = (EndBufPtr-BufPtr)*CHAR_BIT;
 524   // Print a summary of the read file.
 525   errs() << "Summary of " << InputFilename << ":\n";
 526   errs() << "         Total size: ";
 527   PrintSize(BufferSizeBits);
 528   errs() << "\n";
 529   errs() << "        Stream type: ";
 530   switch (CurStreamType) {
 531   default: assert(0 && "Unknown bitstream type");
 532   case UnknownBitstream: errs() << "unknown\n"; break;
 533   case LLVMIRBitstream:  errs() << "LLVM IR\n"; break;
 534   }
 535   errs() << "  # Toplevel Blocks: " << NumTopBlocks << "\n";
 536   errs() << "\n";
 537
 538   // Emit per-block stats.
 539   errs() << "Per-block Summary:\n";
 540   for (std::map<unsigned, PerBlockIDStats>::iterator I = BlockIDStats.begin(),
 541        E = BlockIDStats.end(); I != E; ++I) {
 542     errs() << "  Block ID #" << I->first;
 543     if (const char *BlockName = GetBlockName(I->first, StreamFile))
 544       errs() << " (" << BlockName << ")";
 545     errs() << ":\n";
 546
 547     const PerBlockIDStats &Stats = I->second;
 548     errs() << "      Num Instances: " << Stats.NumInstances << "\n";
 549     errs() << "         Total Size: ";
 550     PrintSize(Stats.NumBits);
 551     errs() << "\n";
 552     double pct = (Stats.NumBits * 100.0) / BufferSizeBits;
 553     errs() << "    Percent of file: " << format("%2.4f%%", pct) << "\n";
 554     if (Stats.NumInstances > 1) {
 555       errs() << "       Average Size: ";
 556       PrintSize(Stats.NumBits/(double)Stats.NumInstances);
 557       errs() << "\n";
 558       errs() << "  Tot/Avg SubBlocks: " << Stats.NumSubBlocks << "/"
 559              << Stats.NumSubBlocks/(double)Stats.NumInstances << "\n";
 560       errs() << "    Tot/Avg Abbrevs: " << Stats.NumAbbrevs << "/"
 561              << Stats.NumAbbrevs/(double)Stats.NumInstances << "\n";
 562       errs() << "    Tot/Avg Records: " << Stats.NumRecords << "/"
 563              << Stats.NumRecords/(double)Stats.NumInstances << "\n";
 564     } else {
 565       errs() << "      Num SubBlocks: " << Stats.NumSubBlocks << "\n";
 566       errs() << "        Num Abbrevs: " << Stats.NumAbbrevs << "\n";
 567       errs() << "        Num Records: " << Stats.NumRecords << "\n";
 568     }
 569     if (Stats.NumRecords) {
 570       double pct = (Stats.NumAbbreviatedRecords * 100.0) / Stats.NumRecords;
 571       errs() << "    Percent Abbrevs: " << format("%2.4f%%", pct) << "\n";
 572     }
 573     errs() << "\n";
 574
 575     // Print a histogram of the codes we see.
 576     if (!NoHistogram && !Stats.CodeFreq.empty()) {
 577       std::vector<std::pair<unsigned, unsigned> > FreqPairs;  // <freq,code>
 578       for (unsigned i = 0, e = Stats.CodeFreq.size(); i != e; ++i)
 579         if (unsigned Freq = Stats.CodeFreq[i].NumInstances)
 580           FreqPairs.push_back(std::make_pair(Freq, i));
 581       std::stable_sort(FreqPairs.begin(), FreqPairs.end());
 582       std::reverse(FreqPairs.begin(), FreqPairs.end());
 583
 584       errs() << "\tRecord Histogram:\n";
 585       fprintf(stderr, "\t\t  Count    # Bits   %% Abv  Record Kind\n");
 586       for (unsigned i = 0, e = FreqPairs.size(); i != e; ++i) {
 587         const PerRecordStats &RecStats = Stats.CodeFreq[FreqPairs[i].second];
 588
 589         fprintf(stderr, "\t\t%7d %9llu ", RecStats.NumInstances,
 590                 (unsigned long long)RecStats.TotalBits);
 591
 592         if (RecStats.NumAbbrev)
 593           fprintf(stderr, "%7.2f  ",
 594                   (double)RecStats.NumAbbrev/RecStats.NumInstances*100);
 595         else
 596           fprintf(stderr, "         ");
 597
 598         if (const char *CodeName =
 599               GetCodeName(FreqPairs[i].second, I->first, StreamFile))
 600           fprintf(stderr, "%s\n", CodeName);
 601         else
 602           fprintf(stderr, "UnknownCode%d\n", FreqPairs[i].second);
 603       }
 604       errs() << "\n";
 605
 606     }
 607   }
 608   return 0;
 609 }
 610
 611
 612 int main(int argc, char **argv) {
 613   // Print a stack trace if we signal out.
 614   sys::PrintStackTraceOnErrorSignal();
 615   PrettyStackTraceProgram X(argc, argv);
 616   llvm_shutdown_obj Y;  // Call llvm_shutdown() on exit.
 617   cl::ParseCommandLineOptions(argc, argv, "llvm-bcanalyzer file analyzer\n");
 618
 619   return AnalyzeBitcode();
 620 }