Home | History | Annotate | Download | only in llvm-bcanalyzer
      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 #include <cstdio>
     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_DEPLIB:      return "DEPLIB";
    154     case bitc::MODULE_CODE_GLOBALVAR:   return "GLOBALVAR";
    155     case bitc::MODULE_CODE_FUNCTION:    return "FUNCTION";
    156     case bitc::MODULE_CODE_ALIAS:       return "ALIAS";
    157     case bitc::MODULE_CODE_PURGEVALS:   return "PURGEVALS";
    158     case bitc::MODULE_CODE_GCNAME:      return "GCNAME";
    159     }
    160   case bitc::PARAMATTR_BLOCK_ID:
    161     switch (CodeID) {
    162     default: return 0;
    163     case bitc::PARAMATTR_CODE_ENTRY: return "ENTRY";
    164     }
    165   case bitc::TYPE_BLOCK_ID_NEW:
    166     switch (CodeID) {
    167     default: return 0;
    168     case bitc::TYPE_CODE_NUMENTRY:     return "NUMENTRY";
    169     case bitc::TYPE_CODE_VOID:         return "VOID";
    170     case bitc::TYPE_CODE_FLOAT:        return "FLOAT";
    171     case bitc::TYPE_CODE_DOUBLE:       return "DOUBLE";
    172     case bitc::TYPE_CODE_LABEL:        return "LABEL";
    173     case bitc::TYPE_CODE_OPAQUE:       return "OPAQUE";
    174     case bitc::TYPE_CODE_INTEGER:      return "INTEGER";
    175     case bitc::TYPE_CODE_POINTER:      return "POINTER";
    176     case bitc::TYPE_CODE_ARRAY:        return "ARRAY";
    177     case bitc::TYPE_CODE_VECTOR:       return "VECTOR";
    178     case bitc::TYPE_CODE_X86_FP80:     return "X86_FP80";
    179     case bitc::TYPE_CODE_FP128:        return "FP128";
    180     case bitc::TYPE_CODE_PPC_FP128:    return "PPC_FP128";
    181     case bitc::TYPE_CODE_METADATA:     return "METADATA";
    182     case bitc::TYPE_CODE_STRUCT_ANON:  return "STRUCT_ANON";
    183     case bitc::TYPE_CODE_STRUCT_NAME:  return "STRUCT_NAME";
    184     case bitc::TYPE_CODE_STRUCT_NAMED: return "STRUCT_NAMED";
    185     case bitc::TYPE_CODE_FUNCTION:     return "FUNCTION";
    186     }
    187 
    188   case bitc::CONSTANTS_BLOCK_ID:
    189     switch (CodeID) {
    190     default: return 0;
    191     case bitc::CST_CODE_SETTYPE:         return "SETTYPE";
    192     case bitc::CST_CODE_NULL:            return "NULL";
    193     case bitc::CST_CODE_UNDEF:           return "UNDEF";
    194     case bitc::CST_CODE_INTEGER:         return "INTEGER";
    195     case bitc::CST_CODE_WIDE_INTEGER:    return "WIDE_INTEGER";
    196     case bitc::CST_CODE_FLOAT:           return "FLOAT";
    197     case bitc::CST_CODE_AGGREGATE:       return "AGGREGATE";
    198     case bitc::CST_CODE_STRING:          return "STRING";
    199     case bitc::CST_CODE_CSTRING:         return "CSTRING";
    200     case bitc::CST_CODE_CE_BINOP:        return "CE_BINOP";
    201     case bitc::CST_CODE_CE_CAST:         return "CE_CAST";
    202     case bitc::CST_CODE_CE_GEP:          return "CE_GEP";
    203     case bitc::CST_CODE_CE_INBOUNDS_GEP: return "CE_INBOUNDS_GEP";
    204     case bitc::CST_CODE_CE_SELECT:       return "CE_SELECT";
    205     case bitc::CST_CODE_CE_EXTRACTELT:   return "CE_EXTRACTELT";
    206     case bitc::CST_CODE_CE_INSERTELT:    return "CE_INSERTELT";
    207     case bitc::CST_CODE_CE_SHUFFLEVEC:   return "CE_SHUFFLEVEC";
    208     case bitc::CST_CODE_CE_CMP:          return "CE_CMP";
    209     case bitc::CST_CODE_INLINEASM:       return "INLINEASM";
    210     case bitc::CST_CODE_CE_SHUFVEC_EX:   return "CE_SHUFVEC_EX";
    211     case bitc::CST_CODE_BLOCKADDRESS:    return "CST_CODE_BLOCKADDRESS";
    212     case bitc::CST_CODE_DATA:            return "DATA";
    213     }
    214   case bitc::FUNCTION_BLOCK_ID:
    215     switch (CodeID) {
    216     default: return 0;
    217     case bitc::FUNC_CODE_DECLAREBLOCKS: return "DECLAREBLOCKS";
    218 
    219     case bitc::FUNC_CODE_INST_BINOP:        return "INST_BINOP";
    220     case bitc::FUNC_CODE_INST_CAST:         return "INST_CAST";
    221     case bitc::FUNC_CODE_INST_GEP:          return "INST_GEP";
    222     case bitc::FUNC_CODE_INST_INBOUNDS_GEP: return "INST_INBOUNDS_GEP";
    223     case bitc::FUNC_CODE_INST_SELECT:       return "INST_SELECT";
    224     case bitc::FUNC_CODE_INST_EXTRACTELT:   return "INST_EXTRACTELT";
    225     case bitc::FUNC_CODE_INST_INSERTELT:    return "INST_INSERTELT";
    226     case bitc::FUNC_CODE_INST_SHUFFLEVEC:   return "INST_SHUFFLEVEC";
    227     case bitc::FUNC_CODE_INST_CMP:          return "INST_CMP";
    228 
    229     case bitc::FUNC_CODE_INST_RET:          return "INST_RET";
    230     case bitc::FUNC_CODE_INST_BR:           return "INST_BR";
    231     case bitc::FUNC_CODE_INST_SWITCH:       return "INST_SWITCH";
    232     case bitc::FUNC_CODE_INST_INVOKE:       return "INST_INVOKE";
    233     case bitc::FUNC_CODE_INST_UNREACHABLE:  return "INST_UNREACHABLE";
    234 
    235     case bitc::FUNC_CODE_INST_PHI:          return "INST_PHI";
    236     case bitc::FUNC_CODE_INST_ALLOCA:       return "INST_ALLOCA";
    237     case bitc::FUNC_CODE_INST_LOAD:         return "INST_LOAD";
    238     case bitc::FUNC_CODE_INST_VAARG:        return "INST_VAARG";
    239     case bitc::FUNC_CODE_INST_STORE:        return "INST_STORE";
    240     case bitc::FUNC_CODE_INST_EXTRACTVAL:   return "INST_EXTRACTVAL";
    241     case bitc::FUNC_CODE_INST_INSERTVAL:    return "INST_INSERTVAL";
    242     case bitc::FUNC_CODE_INST_CMP2:         return "INST_CMP2";
    243     case bitc::FUNC_CODE_INST_VSELECT:      return "INST_VSELECT";
    244     case bitc::FUNC_CODE_DEBUG_LOC_AGAIN:   return "DEBUG_LOC_AGAIN";
    245     case bitc::FUNC_CODE_INST_CALL:         return "INST_CALL";
    246     case bitc::FUNC_CODE_DEBUG_LOC:         return "DEBUG_LOC";
    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_NAME:        return "METADATA_NAME";
    264     case bitc::METADATA_KIND:        return "METADATA_KIND";
    265     case bitc::METADATA_NODE:        return "METADATA_NODE";
    266     case bitc::METADATA_FN_NODE:     return "METADATA_FN_NODE";
    267     case bitc::METADATA_NAMED_NODE:  return "METADATA_NAMED_NODE";
    268     }
    269   case bitc::USELIST_BLOCK_ID:
    270     switch(CodeID) {
    271     default:return 0;
    272     case bitc::USELIST_CODE_ENTRY:   return "USELIST_CODE_ENTRY";
    273     }
    274   }
    275 }
    276 
    277 struct PerRecordStats {
    278   unsigned NumInstances;
    279   unsigned NumAbbrev;
    280   uint64_t TotalBits;
    281 
    282   PerRecordStats() : NumInstances(0), NumAbbrev(0), TotalBits(0) {}
    283 };
    284 
    285 struct PerBlockIDStats {
    286   /// NumInstances - This the number of times this block ID has been seen.
    287   unsigned NumInstances;
    288 
    289   /// NumBits - The total size in bits of all of these blocks.
    290   uint64_t NumBits;
    291 
    292   /// NumSubBlocks - The total number of blocks these blocks contain.
    293   unsigned NumSubBlocks;
    294 
    295   /// NumAbbrevs - The total number of abbreviations.
    296   unsigned NumAbbrevs;
    297 
    298   /// NumRecords - The total number of records these blocks contain, and the
    299   /// number that are abbreviated.
    300   unsigned NumRecords, NumAbbreviatedRecords;
    301 
    302   /// CodeFreq - Keep track of the number of times we see each code.
    303   std::vector<PerRecordStats> CodeFreq;
    304 
    305   PerBlockIDStats()
    306     : NumInstances(0), NumBits(0),
    307       NumSubBlocks(0), NumAbbrevs(0), NumRecords(0), NumAbbreviatedRecords(0) {}
    308 };
    309 
    310 static std::map<unsigned, PerBlockIDStats> BlockIDStats;
    311 
    312 
    313 
    314 /// Error - All bitcode analysis errors go through this function, making this a
    315 /// good place to breakpoint if debugging.
    316 static bool Error(const std::string &Err) {
    317   errs() << Err << "\n";
    318   return true;
    319 }
    320 
    321 /// ParseBlock - Read a block, updating statistics, etc.
    322 static bool ParseBlock(BitstreamCursor &Stream, unsigned IndentLevel) {
    323   std::string Indent(IndentLevel*2, ' ');
    324   uint64_t BlockBitStart = Stream.GetCurrentBitNo();
    325   unsigned BlockID = Stream.ReadSubBlockID();
    326 
    327   // Get the statistics for this BlockID.
    328   PerBlockIDStats &BlockStats = BlockIDStats[BlockID];
    329 
    330   BlockStats.NumInstances++;
    331 
    332   // BLOCKINFO is a special part of the stream.
    333   if (BlockID == bitc::BLOCKINFO_BLOCK_ID) {
    334     if (Dump) outs() << Indent << "<BLOCKINFO_BLOCK/>\n";
    335     if (Stream.ReadBlockInfoBlock())
    336       return Error("Malformed BlockInfoBlock");
    337     uint64_t BlockBitEnd = Stream.GetCurrentBitNo();
    338     BlockStats.NumBits += BlockBitEnd-BlockBitStart;
    339     return false;
    340   }
    341 
    342   unsigned NumWords = 0;
    343   if (Stream.EnterSubBlock(BlockID, &NumWords))
    344     return Error("Malformed block record");
    345 
    346   const char *BlockName = 0;
    347   if (Dump) {
    348     outs() << Indent << "<";
    349     if ((BlockName = GetBlockName(BlockID, *Stream.getBitStreamReader())))
    350       outs() << BlockName;
    351     else
    352       outs() << "UnknownBlock" << BlockID;
    353 
    354     if (NonSymbolic && BlockName)
    355       outs() << " BlockID=" << BlockID;
    356 
    357     outs() << " NumWords=" << NumWords
    358            << " BlockCodeSize=" << Stream.GetAbbrevIDWidth() << ">\n";
    359   }
    360 
    361   SmallVector<uint64_t, 64> Record;
    362 
    363   // Read all the records for this block.
    364   while (1) {
    365     if (Stream.AtEndOfStream())
    366       return Error("Premature end of bitstream");
    367 
    368     uint64_t RecordStartBit = Stream.GetCurrentBitNo();
    369 
    370     // Read the code for this record.
    371     unsigned AbbrevID = Stream.ReadCode();
    372     switch (AbbrevID) {
    373     case bitc::END_BLOCK: {
    374       if (Stream.ReadBlockEnd())
    375         return Error("Error at end of block");
    376       uint64_t BlockBitEnd = Stream.GetCurrentBitNo();
    377       BlockStats.NumBits += BlockBitEnd-BlockBitStart;
    378       if (Dump) {
    379         outs() << Indent << "</";
    380         if (BlockName)
    381           outs() << BlockName << ">\n";
    382         else
    383           outs() << "UnknownBlock" << BlockID << ">\n";
    384       }
    385       return false;
    386     }
    387     case bitc::ENTER_SUBBLOCK: {
    388       uint64_t SubBlockBitStart = Stream.GetCurrentBitNo();
    389       if (ParseBlock(Stream, IndentLevel+1))
    390         return true;
    391       ++BlockStats.NumSubBlocks;
    392       uint64_t SubBlockBitEnd = Stream.GetCurrentBitNo();
    393 
    394       // Don't include subblock sizes in the size of this block.
    395       BlockBitStart += SubBlockBitEnd-SubBlockBitStart;
    396       break;
    397     }
    398     case bitc::DEFINE_ABBREV:
    399       Stream.ReadAbbrevRecord();
    400       ++BlockStats.NumAbbrevs;
    401       break;
    402     default:
    403       Record.clear();
    404 
    405       ++BlockStats.NumRecords;
    406       if (AbbrevID != bitc::UNABBREV_RECORD)
    407         ++BlockStats.NumAbbreviatedRecords;
    408 
    409       const char *BlobStart = 0;
    410       unsigned BlobLen = 0;
    411       unsigned Code = Stream.ReadRecord(AbbrevID, Record, BlobStart, BlobLen);
    412 
    413 
    414 
    415       // Increment the # occurrences of this code.
    416       if (BlockStats.CodeFreq.size() <= Code)
    417         BlockStats.CodeFreq.resize(Code+1);
    418       BlockStats.CodeFreq[Code].NumInstances++;
    419       BlockStats.CodeFreq[Code].TotalBits +=
    420         Stream.GetCurrentBitNo()-RecordStartBit;
    421       if (AbbrevID != bitc::UNABBREV_RECORD)
    422         BlockStats.CodeFreq[Code].NumAbbrev++;
    423 
    424       if (Dump) {
    425         outs() << Indent << "  <";
    426         if (const char *CodeName =
    427               GetCodeName(Code, BlockID, *Stream.getBitStreamReader()))
    428           outs() << CodeName;
    429         else
    430           outs() << "UnknownCode" << Code;
    431         if (NonSymbolic &&
    432             GetCodeName(Code, BlockID, *Stream.getBitStreamReader()))
    433           outs() << " codeid=" << Code;
    434         if (AbbrevID != bitc::UNABBREV_RECORD)
    435           outs() << " abbrevid=" << AbbrevID;
    436 
    437         for (unsigned i = 0, e = Record.size(); i != e; ++i)
    438           outs() << " op" << i << "=" << (int64_t)Record[i];
    439 
    440         outs() << "/>";
    441 
    442         if (BlobStart) {
    443           outs() << " blob data = ";
    444           bool BlobIsPrintable = true;
    445           for (unsigned i = 0; i != BlobLen; ++i)
    446             if (!isprint(BlobStart[i])) {
    447               BlobIsPrintable = false;
    448               break;
    449             }
    450 
    451           if (BlobIsPrintable)
    452             outs() << "'" << std::string(BlobStart, BlobStart+BlobLen) <<"'";
    453           else
    454             outs() << "unprintable, " << BlobLen << " bytes.";
    455         }
    456 
    457         outs() << "\n";
    458       }
    459 
    460       break;
    461     }
    462   }
    463 }
    464 
    465 static void PrintSize(double Bits) {
    466   fprintf(stderr, "%.2f/%.2fB/%luW", Bits, Bits/8,(unsigned long)(Bits/32));
    467 }
    468 static void PrintSize(uint64_t Bits) {
    469   fprintf(stderr, "%lub/%.2fB/%luW", (unsigned long)Bits,
    470           (double)Bits/8, (unsigned long)(Bits/32));
    471 }
    472 
    473 
    474 /// AnalyzeBitcode - Analyze the bitcode file specified by InputFilename.
    475 static int AnalyzeBitcode() {
    476   // Read the input file.
    477   OwningPtr<MemoryBuffer> MemBuf;
    478 
    479   if (error_code ec =
    480         MemoryBuffer::getFileOrSTDIN(InputFilename.c_str(), MemBuf))
    481     return Error("Error reading '" + InputFilename + "': " + ec.message());
    482 
    483   if (MemBuf->getBufferSize() & 3)
    484     return Error("Bitcode stream should be a multiple of 4 bytes in length");
    485 
    486   const unsigned char *BufPtr = (unsigned char *)MemBuf->getBufferStart();
    487   const unsigned char *EndBufPtr = BufPtr+MemBuf->getBufferSize();
    488 
    489   // If we have a wrapper header, parse it and ignore the non-bc file contents.
    490   // The magic number is 0x0B17C0DE stored in little endian.
    491   if (isBitcodeWrapper(BufPtr, EndBufPtr))
    492     if (SkipBitcodeWrapperHeader(BufPtr, EndBufPtr, true))
    493       return Error("Invalid bitcode wrapper header");
    494 
    495   BitstreamReader StreamFile(BufPtr, EndBufPtr);
    496   BitstreamCursor Stream(StreamFile);
    497   StreamFile.CollectBlockInfoNames();
    498 
    499   // Read the stream signature.
    500   char Signature[6];
    501   Signature[0] = Stream.Read(8);
    502   Signature[1] = Stream.Read(8);
    503   Signature[2] = Stream.Read(4);
    504   Signature[3] = Stream.Read(4);
    505   Signature[4] = Stream.Read(4);
    506   Signature[5] = Stream.Read(4);
    507 
    508   // Autodetect the file contents, if it is one we know.
    509   CurStreamType = UnknownBitstream;
    510   if (Signature[0] == 'B' && Signature[1] == 'C' &&
    511       Signature[2] == 0x0 && Signature[3] == 0xC &&
    512       Signature[4] == 0xE && Signature[5] == 0xD)
    513     CurStreamType = LLVMIRBitstream;
    514 
    515   unsigned NumTopBlocks = 0;
    516 
    517   // Parse the top-level structure.  We only allow blocks at the top-level.
    518   while (!Stream.AtEndOfStream()) {
    519     unsigned Code = Stream.ReadCode();
    520     if (Code != bitc::ENTER_SUBBLOCK)
    521       return Error("Invalid record at top-level");
    522 
    523     if (ParseBlock(Stream, 0))
    524       return true;
    525     ++NumTopBlocks;
    526   }
    527 
    528   if (Dump) outs() << "\n\n";
    529 
    530   uint64_t BufferSizeBits = (EndBufPtr-BufPtr)*CHAR_BIT;
    531   // Print a summary of the read file.
    532   outs() << "Summary of " << InputFilename << ":\n";
    533   outs() << "         Total size: ";
    534   PrintSize(BufferSizeBits);
    535   outs() << "\n";
    536   outs() << "        Stream type: ";
    537   switch (CurStreamType) {
    538   case UnknownBitstream: outs() << "unknown\n"; break;
    539   case LLVMIRBitstream:  outs() << "LLVM IR\n"; break;
    540   }
    541   outs() << "  # Toplevel Blocks: " << NumTopBlocks << "\n";
    542   outs() << "\n";
    543 
    544   // Emit per-block stats.
    545   outs() << "Per-block Summary:\n";
    546   for (std::map<unsigned, PerBlockIDStats>::iterator I = BlockIDStats.begin(),
    547        E = BlockIDStats.end(); I != E; ++I) {
    548     outs() << "  Block ID #" << I->first;
    549     if (const char *BlockName = GetBlockName(I->first, StreamFile))
    550       outs() << " (" << BlockName << ")";
    551     outs() << ":\n";
    552 
    553     const PerBlockIDStats &Stats = I->second;
    554     outs() << "      Num Instances: " << Stats.NumInstances << "\n";
    555     outs() << "         Total Size: ";
    556     PrintSize(Stats.NumBits);
    557     outs() << "\n";
    558     double pct = (Stats.NumBits * 100.0) / BufferSizeBits;
    559     errs() << "    Percent of file: " << format("%2.4f%%", pct) << "\n";
    560     if (Stats.NumInstances > 1) {
    561       outs() << "       Average Size: ";
    562       PrintSize(Stats.NumBits/(double)Stats.NumInstances);
    563       outs() << "\n";
    564       outs() << "  Tot/Avg SubBlocks: " << Stats.NumSubBlocks << "/"
    565              << Stats.NumSubBlocks/(double)Stats.NumInstances << "\n";
    566       outs() << "    Tot/Avg Abbrevs: " << Stats.NumAbbrevs << "/"
    567              << Stats.NumAbbrevs/(double)Stats.NumInstances << "\n";
    568       outs() << "    Tot/Avg Records: " << Stats.NumRecords << "/"
    569              << Stats.NumRecords/(double)Stats.NumInstances << "\n";
    570     } else {
    571       outs() << "      Num SubBlocks: " << Stats.NumSubBlocks << "\n";
    572       outs() << "        Num Abbrevs: " << Stats.NumAbbrevs << "\n";
    573       outs() << "        Num Records: " << Stats.NumRecords << "\n";
    574     }
    575     if (Stats.NumRecords) {
    576       double pct = (Stats.NumAbbreviatedRecords * 100.0) / Stats.NumRecords;
    577       outs() << "    Percent Abbrevs: " << format("%2.4f%%", pct) << "\n";
    578     }
    579     outs() << "\n";
    580 
    581     // Print a histogram of the codes we see.
    582     if (!NoHistogram && !Stats.CodeFreq.empty()) {
    583       std::vector<std::pair<unsigned, unsigned> > FreqPairs;  // <freq,code>
    584       for (unsigned i = 0, e = Stats.CodeFreq.size(); i != e; ++i)
    585         if (unsigned Freq = Stats.CodeFreq[i].NumInstances)
    586           FreqPairs.push_back(std::make_pair(Freq, i));
    587       std::stable_sort(FreqPairs.begin(), FreqPairs.end());
    588       std::reverse(FreqPairs.begin(), FreqPairs.end());
    589 
    590       outs() << "\tRecord Histogram:\n";
    591       fprintf(stderr, "\t\t  Count    # Bits   %% Abv  Record Kind\n");
    592       for (unsigned i = 0, e = FreqPairs.size(); i != e; ++i) {
    593         const PerRecordStats &RecStats = Stats.CodeFreq[FreqPairs[i].second];
    594 
    595         fprintf(stderr, "\t\t%7d %9lu ", RecStats.NumInstances,
    596                 (unsigned long)RecStats.TotalBits);
    597 
    598         if (RecStats.NumAbbrev)
    599           fprintf(stderr, "%7.2f  ",
    600                   (double)RecStats.NumAbbrev/RecStats.NumInstances*100);
    601         else
    602           fprintf(stderr, "         ");
    603 
    604         if (const char *CodeName =
    605               GetCodeName(FreqPairs[i].second, I->first, StreamFile))
    606           fprintf(stderr, "%s\n", CodeName);
    607         else
    608           fprintf(stderr, "UnknownCode%d\n", FreqPairs[i].second);
    609       }
    610       outs() << "\n";
    611 
    612     }
    613   }
    614   return 0;
    615 }
    616 
    617 
    618 int main(int argc, char **argv) {
    619   // Print a stack trace if we signal out.
    620   sys::PrintStackTraceOnErrorSignal();
    621   PrettyStackTraceProgram X(argc, argv);
    622   llvm_shutdown_obj Y;  // Call llvm_shutdown() on exit.
    623   cl::ParseCommandLineOptions(argc, argv, "llvm-bcanalyzer file analyzer\n");
    624 
    625   return AnalyzeBitcode();
    626 }
    627