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/Support/CommandLine.h"
  34 #include "llvm/Support/ManagedStatic.h"
  35 #include "llvm/Support/MemoryBuffer.h"
  36 #include "llvm/System/Signals.h"
  37 #include <map>
  38 #include <fstream>
  39 #include <iostream>
  40 #include <algorithm>
  41 using namespace llvm;
  42
  43 static cl::opt<std::string>
  44   InputFilename(cl::Positional, cl::desc("<input bitcode>"), cl::init("-"));
  45
  46 static cl::opt<std::string>
  47   OutputFilename("-o", cl::init("-"), cl::desc("<output file>"));
  48
  49 static cl::opt<bool> Dump("dump", cl::desc("Dump low level bitcode trace"));
  50
  51 //===----------------------------------------------------------------------===//
  52 // Bitcode specific analysis.
  53 //===----------------------------------------------------------------------===//
  54
  55 static cl::opt<bool> NoHistogram("disable-histogram",
  56                                  cl::desc("Do not print per-code histogram"));
  57
  58 static cl::opt<bool>
  59 NonSymbolic("non-symbolic",
  60             cl::desc("Emit numberic info in dump even if"
  61                      " symbolic info is available"));
  62
  63 /// CurStreamType - If we can sniff the flavor of this stream, we can produce
  64 /// better dump info.
  65 static enum {
  66   UnknownBitstream,
  67   LLVMIRBitstream
  68 } CurStreamType;
  69
  70
  71 /// GetBlockName - Return a symbolic block name if known, otherwise return
  72 /// null.
  73 static const char *GetBlockName(unsigned BlockID) {
  74   // Standard blocks for all bitcode files.
  75   if (BlockID < bitc::FIRST_APPLICATION_BLOCKID) {
  76     if (BlockID == bitc::BLOCKINFO_BLOCK_ID)
  77       return "BLOCKINFO_BLOCK";
  78     return 0;
  79   }
  80
  81   if (CurStreamType != LLVMIRBitstream) return 0;
  82
  83   switch (BlockID) {
  84   default:                          return 0;
  85   case bitc::MODULE_BLOCK_ID:       return "MODULE_BLOCK";
  86   case bitc::PARAMATTR_BLOCK_ID:    return "PARAMATTR_BLOCK";
  87   case bitc::TYPE_BLOCK_ID:         return "TYPE_BLOCK";
  88   case bitc::CONSTANTS_BLOCK_ID:    return "CONSTANTS_BLOCK";
  89   case bitc::FUNCTION_BLOCK_ID:     return "FUNCTION_BLOCK";
  90   case bitc::TYPE_SYMTAB_BLOCK_ID:  return "TYPE_SYMTAB";
  91   case bitc::VALUE_SYMTAB_BLOCK_ID: return "VALUE_SYMTAB";
  92   }
  93 }
  94
  95 /// GetCodeName - Return a symbolic code name if known, otherwise return
  96 /// null.
  97 static const char *GetCodeName(unsigned CodeID, unsigned BlockID) {
  98   // Standard blocks for all bitcode files.
  99   if (BlockID < bitc::FIRST_APPLICATION_BLOCKID) {
 100     if (BlockID == bitc::BLOCKINFO_BLOCK_ID) {
 101       switch (CodeID) {
 102       default: return 0;
 103       case bitc::MODULE_CODE_VERSION:     return "VERSION";
 104       }
 105     }
 106     return 0;
 107   }
 108
 109   if (CurStreamType != LLVMIRBitstream) return 0;
 110
 111   switch (BlockID) {
 112   default: return 0;
 113   case bitc::MODULE_BLOCK_ID:
 114     switch (CodeID) {
 115     default: return 0;
 116     case bitc::MODULE_CODE_VERSION:     return "VERSION";
 117     case bitc::MODULE_CODE_TRIPLE:      return "TRIPLE";
 118     case bitc::MODULE_CODE_DATALAYOUT:  return "DATALAYOUT";
 119     case bitc::MODULE_CODE_ASM:         return "ASM";
 120     case bitc::MODULE_CODE_SECTIONNAME: return "SECTIONNAME";
 121     case bitc::MODULE_CODE_DEPLIB:      return "DEPLIB";
 122     case bitc::MODULE_CODE_GLOBALVAR:   return "GLOBALVAR";
 123     case bitc::MODULE_CODE_FUNCTION:    return "FUNCTION";
 124     case bitc::MODULE_CODE_ALIAS:       return "ALIAS";
 125     case bitc::MODULE_CODE_PURGEVALS:   return "PURGEVALS";
 126     }
 127   case bitc::PARAMATTR_BLOCK_ID:
 128     switch (CodeID) {
 129     default: return 0;
 130     case bitc::PARAMATTR_CODE_ENTRY: return "ENTRY";
 131     }
 132   case bitc::TYPE_BLOCK_ID:
 133     switch (CodeID) {
 134     default: return 0;
 135     case bitc::TYPE_CODE_NUMENTRY: return "NUMENTRY";
 136     case bitc::TYPE_CODE_VOID:     return "VOID";
 137     case bitc::TYPE_CODE_FLOAT:    return "FLOAT";
 138     case bitc::TYPE_CODE_DOUBLE:   return "DOUBLE";
 139     case bitc::TYPE_CODE_LABEL:    return "LABEL";
 140     case bitc::TYPE_CODE_OPAQUE:   return "OPAQUE";
 141     case bitc::TYPE_CODE_INTEGER:  return "INTEGER";
 142     case bitc::TYPE_CODE_POINTER:  return "POINTER";
 143     case bitc::TYPE_CODE_FUNCTION: return "FUNCTION";
 144     case bitc::TYPE_CODE_STRUCT:   return "STRUCT";
 145     case bitc::TYPE_CODE_ARRAY:    return "ARRAY";
 146     case bitc::TYPE_CODE_VECTOR:   return "VECTOR";
 147     }
 148
 149   case bitc::CONSTANTS_BLOCK_ID:
 150     switch (CodeID) {
 151     default: return 0;
 152     case bitc::CST_CODE_SETTYPE:       return "SETTYPE";
 153     case bitc::CST_CODE_NULL:          return "NULL";
 154     case bitc::CST_CODE_UNDEF:         return "UNDEF";
 155     case bitc::CST_CODE_INTEGER:       return "INTEGER";
 156     case bitc::CST_CODE_WIDE_INTEGER:  return "WIDE_INTEGER";
 157     case bitc::CST_CODE_FLOAT:         return "FLOAT";
 158     case bitc::CST_CODE_AGGREGATE:     return "AGGREGATE";
 159     case bitc::CST_CODE_STRING:        return "STRING";
 160     case bitc::CST_CODE_CSTRING:       return "CSTRING";
 161     case bitc::CST_CODE_CE_BINOP:      return "CE_BINOP";
 162     case bitc::CST_CODE_CE_CAST:       return "CE_CAST";
 163     case bitc::CST_CODE_CE_GEP:        return "CE_GEP";
 164     case bitc::CST_CODE_CE_SELECT:     return "CE_SELECT";
 165     case bitc::CST_CODE_CE_EXTRACTELT: return "CE_EXTRACTELT";
 166     case bitc::CST_CODE_CE_INSERTELT:  return "CE_INSERTELT";
 167     case bitc::CST_CODE_CE_SHUFFLEVEC: return "CE_SHUFFLEVEC";
 168     case bitc::CST_CODE_CE_CMP:        return "CE_CMP";
 169     case bitc::CST_CODE_INLINEASM:     return "INLINEASM";
 170     }
 171   case bitc::FUNCTION_BLOCK_ID:
 172     switch (CodeID) {
 173     default: return 0;
 174     case bitc::FUNC_CODE_DECLAREBLOCKS: return "DECLAREBLOCKS";
 175
 176     case bitc::FUNC_CODE_INST_BINOP:       return "INST_BINOP";
 177     case bitc::FUNC_CODE_INST_CAST:        return "INST_CAST";
 178     case bitc::FUNC_CODE_INST_GEP:         return "INST_GEP";
 179     case bitc::FUNC_CODE_INST_SELECT:      return "INST_SELECT";
 180     case bitc::FUNC_CODE_INST_EXTRACTELT:  return "INST_EXTRACTELT";
 181     case bitc::FUNC_CODE_INST_INSERTELT:   return "INST_INSERTELT";
 182     case bitc::FUNC_CODE_INST_SHUFFLEVEC:  return "INST_SHUFFLEVEC";
 183     case bitc::FUNC_CODE_INST_CMP:         return "INST_CMP";
 184
 185     case bitc::FUNC_CODE_INST_RET:         return "INST_RET";
 186     case bitc::FUNC_CODE_INST_BR:          return "INST_BR";
 187     case bitc::FUNC_CODE_INST_SWITCH:      return "INST_SWITCH";
 188     case bitc::FUNC_CODE_INST_INVOKE:      return "INST_INVOKE";
 189     case bitc::FUNC_CODE_INST_UNWIND:      return "INST_UNWIND";
 190     case bitc::FUNC_CODE_INST_UNREACHABLE: return "INST_UNREACHABLE";
 191
 192     case bitc::FUNC_CODE_INST_PHI:         return "INST_PHI";
 193     case bitc::FUNC_CODE_INST_MALLOC:      return "INST_MALLOC";
 194     case bitc::FUNC_CODE_INST_FREE:        return "INST_FREE";
 195     case bitc::FUNC_CODE_INST_ALLOCA:      return "INST_ALLOCA";
 196     case bitc::FUNC_CODE_INST_LOAD:        return "INST_LOAD";
 197     case bitc::FUNC_CODE_INST_STORE:       return "INST_STORE";
 198     case bitc::FUNC_CODE_INST_CALL:        return "INST_CALL";
 199     case bitc::FUNC_CODE_INST_VAARG:       return "INST_VAARG";
 200     case bitc::FUNC_CODE_INST_STORE2:      return "INST_STORE2";
 201     case bitc::FUNC_CODE_INST_GETRESULT:   return "INST_GETRESULT";
 202     }
 203   case bitc::TYPE_SYMTAB_BLOCK_ID:
 204     switch (CodeID) {
 205     default: return 0;
 206     case bitc::TST_CODE_ENTRY: return "ENTRY";
 207     }
 208   case bitc::VALUE_SYMTAB_BLOCK_ID:
 209     switch (CodeID) {
 210     default: return 0;
 211     case bitc::VST_CODE_ENTRY: return "ENTRY";
 212     case bitc::VST_CODE_BBENTRY: return "BBENTRY";
 213     }
 214   }
 215 }
 216
 217
 218 struct PerBlockIDStats {
 219   /// NumInstances - This the number of times this block ID has been seen.
 220   unsigned NumInstances;
 221
 222   /// NumBits - The total size in bits of all of these blocks.
 223   uint64_t NumBits;
 224
 225   /// NumSubBlocks - The total number of blocks these blocks contain.
 226   unsigned NumSubBlocks;
 227
 228   /// NumAbbrevs - The total number of abbreviations.
 229   unsigned NumAbbrevs;
 230
 231   /// NumRecords - The total number of records these blocks contain, and the
 232   /// number that are abbreviated.
 233   unsigned NumRecords, NumAbbreviatedRecords;
 234
 235   /// CodeFreq - Keep track of the number of times we see each code.
 236   std::vector<unsigned> CodeFreq;
 237
 238   PerBlockIDStats()
 239     : NumInstances(0), NumBits(0),
 240       NumSubBlocks(0), NumAbbrevs(0), NumRecords(0), NumAbbreviatedRecords(0) {}
 241 };
 242
 243 static std::map<unsigned, PerBlockIDStats> BlockIDStats;
 244
 245
 246
 247 /// Error - All bitcode analysis errors go through this function, making this a
 248 /// good place to breakpoint if debugging.
 249 static bool Error(const std::string &Err) {
 250   std::cerr << Err << "\n";
 251   return true;
 252 }
 253
 254 /// ParseBlock - Read a block, updating statistics, etc.
 255 static bool ParseBlock(BitstreamReader &Stream, unsigned IndentLevel) {
 256   std::string Indent(IndentLevel*2, ' ');
 257   uint64_t BlockBitStart = Stream.GetCurrentBitNo();
 258   unsigned BlockID = Stream.ReadSubBlockID();
 259
 260   // Get the statistics for this BlockID.
 261   PerBlockIDStats &BlockStats = BlockIDStats[BlockID];
 262
 263   BlockStats.NumInstances++;
 264
 265   // BLOCKINFO is a special part of the stream.
 266   if (BlockID == bitc::BLOCKINFO_BLOCK_ID) {
 267     if (Dump) std::cerr << Indent << "<BLOCKINFO_BLOCK/>\n";
 268     if (Stream.ReadBlockInfoBlock())
 269       return Error("Malformed BlockInfoBlock");
 270     uint64_t BlockBitEnd = Stream.GetCurrentBitNo();
 271     BlockStats.NumBits += BlockBitEnd-BlockBitStart;
 272     return false;
 273   }
 274
 275   unsigned NumWords = 0;
 276   if (Stream.EnterSubBlock(BlockID, &NumWords))
 277     return Error("Malformed block record");
 278
 279   const char *BlockName = 0;
 280   if (Dump) {
 281     std::cerr << Indent << "<";
 282     if ((BlockName = GetBlockName(BlockID)))
 283       std::cerr << BlockName;
 284     else
 285       std::cerr << "UnknownBlock" << BlockID;
 286
 287     if (NonSymbolic && BlockName)
 288       std::cerr << " BlockID=" << BlockID;
 289
 290     std::cerr << " NumWords=" << NumWords
 291               << " BlockCodeSize=" << Stream.GetAbbrevIDWidth() << ">\n";
 292   }
 293
 294   SmallVector<uint64_t, 64> Record;
 295
 296   // Read all the records for this block.
 297   while (1) {
 298     if (Stream.AtEndOfStream())
 299       return Error("Premature end of bitstream");
 300
 301     // Read the code for this record.
 302     unsigned AbbrevID = Stream.ReadCode();
 303     switch (AbbrevID) {
 304     case bitc::END_BLOCK: {
 305       if (Stream.ReadBlockEnd())
 306         return Error("Error at end of block");
 307       uint64_t BlockBitEnd = Stream.GetCurrentBitNo();
 308       BlockStats.NumBits += BlockBitEnd-BlockBitStart;
 309       if (Dump) {
 310         std::cerr << Indent << "</";
 311         if (BlockName)
 312           std::cerr << BlockName << ">\n";
 313         else
 314           std::cerr << "UnknownBlock" << BlockID << ">\n";
 315       }
 316       return false;
 317     }
 318     case bitc::ENTER_SUBBLOCK: {
 319       uint64_t SubBlockBitStart = Stream.GetCurrentBitNo();
 320       if (ParseBlock(Stream, IndentLevel+1))
 321         return true;
 322       ++BlockStats.NumSubBlocks;
 323       uint64_t SubBlockBitEnd = Stream.GetCurrentBitNo();
 324
 325       // Don't include subblock sizes in the size of this block.
 326       BlockBitStart += SubBlockBitEnd-SubBlockBitStart;
 327       break;
 328     }
 329     case bitc::DEFINE_ABBREV:
 330       Stream.ReadAbbrevRecord();
 331       ++BlockStats.NumAbbrevs;
 332       break;
 333     default:
 334       ++BlockStats.NumRecords;
 335       if (AbbrevID != bitc::UNABBREV_RECORD)
 336         ++BlockStats.NumAbbreviatedRecords;
 337
 338       Record.clear();
 339       unsigned Code = Stream.ReadRecord(AbbrevID, Record);
 340
 341       // Increment the # occurrences of this code.
 342       if (BlockStats.CodeFreq.size() <= Code)
 343         BlockStats.CodeFreq.resize(Code+1);
 344       BlockStats.CodeFreq[Code]++;
 345
 346       if (Dump) {
 347         std::cerr << Indent << "  <";
 348         if (const char *CodeName = GetCodeName(Code, BlockID))
 349           std::cerr << CodeName;
 350         else
 351           std::cerr << "UnknownCode" << Code;
 352         if (NonSymbolic && GetCodeName(Code, BlockID))
 353           std::cerr << " codeid=" << Code;
 354         if (AbbrevID != bitc::UNABBREV_RECORD)
 355           std::cerr << " abbrevid=" << AbbrevID;
 356
 357         for (unsigned i = 0, e = Record.size(); i != e; ++i)
 358           std::cerr << " op" << i << "=" << (int64_t)Record[i];
 359
 360         std::cerr << "/>\n";
 361       }
 362
 363       break;
 364     }
 365   }
 366 }
 367
 368 static void PrintSize(double Bits) {
 369   std::cerr << Bits << "b/" << Bits/8 << "B/" << Bits/32 << "W";
 370 }
 371
 372
 373 /// AnalyzeBitcode - Analyze the bitcode file specified by InputFilename.
 374 static int AnalyzeBitcode() {
 375   // Read the input file.
 376   MemoryBuffer *Buffer = MemoryBuffer::getFileOrSTDIN(InputFilename.c_str());
 377
 378   if (Buffer == 0)
 379     return Error("Error reading '" + InputFilename + "'.");
 380
 381   if (Buffer->getBufferSize() & 3)
 382     return Error("Bitcode stream should be a multiple of 4 bytes in length");
 383
 384   unsigned char *BufPtr = (unsigned char *)Buffer->getBufferStart();
 385   BitstreamReader Stream(BufPtr, BufPtr+Buffer->getBufferSize());
 386
 387
 388   // Read the stream signature.
 389   char Signature[6];
 390   Signature[0] = Stream.Read(8);
 391   Signature[1] = Stream.Read(8);
 392   Signature[2] = Stream.Read(4);
 393   Signature[3] = Stream.Read(4);
 394   Signature[4] = Stream.Read(4);
 395   Signature[5] = Stream.Read(4);
 396
 397   // Autodetect the file contents, if it is one we know.
 398   CurStreamType = UnknownBitstream;
 399   if (Signature[0] == 'B' && Signature[1] == 'C' &&
 400       Signature[2] == 0x0 && Signature[3] == 0xC &&
 401       Signature[4] == 0xE && Signature[5] == 0xD)
 402     CurStreamType = LLVMIRBitstream;
 403
 404   unsigned NumTopBlocks = 0;
 405
 406   // Parse the top-level structure.  We only allow blocks at the top-level.
 407   while (!Stream.AtEndOfStream()) {
 408     unsigned Code = Stream.ReadCode();
 409     if (Code != bitc::ENTER_SUBBLOCK)
 410       return Error("Invalid record at top-level");
 411
 412     if (ParseBlock(Stream, 0))
 413       return true;
 414     ++NumTopBlocks;
 415   }
 416
 417   if (Dump) std::cerr << "\n\n";
 418
 419   uint64_t BufferSizeBits = Buffer->getBufferSize()*8;
 420   // Print a summary of the read file.
 421   std::cerr << "Summary of " << InputFilename << ":\n";
 422   std::cerr << "         Total size: ";
 423   PrintSize(BufferSizeBits);
 424   std::cerr << "\n";
 425   std::cerr << "        Stream type: ";
 426   switch (CurStreamType) {
 427   default: assert(0 && "Unknown bitstream type");
 428   case UnknownBitstream: std::cerr << "unknown\n"; break;
 429   case LLVMIRBitstream:  std::cerr << "LLVM IR\n"; break;
 430   }
 431   std::cerr << "  # Toplevel Blocks: " << NumTopBlocks << "\n";
 432   std::cerr << "\n";
 433
 434   // Emit per-block stats.
 435   std::cerr << "Per-block Summary:\n";
 436   for (std::map<unsigned, PerBlockIDStats>::iterator I = BlockIDStats.begin(),
 437        E = BlockIDStats.end(); I != E; ++I) {
 438     std::cerr << "  Block ID #" << I->first;
 439     if (const char *BlockName = GetBlockName(I->first))
 440       std::cerr << " (" << BlockName << ")";
 441     std::cerr << ":\n";
 442
 443     const PerBlockIDStats &Stats = I->second;
 444     std::cerr << "      Num Instances: " << Stats.NumInstances << "\n";
 445     std::cerr << "         Total Size: ";
 446     PrintSize(Stats.NumBits);
 447     std::cerr << "\n";
 448     std::cerr << "          % of file: "
 449               << Stats.NumBits/(double)BufferSizeBits*100 << "\n";
 450     if (Stats.NumInstances > 1) {
 451       std::cerr << "       Average Size: ";
 452       PrintSize(Stats.NumBits/(double)Stats.NumInstances);
 453       std::cerr << "\n";
 454       std::cerr << "  Tot/Avg SubBlocks: " << Stats.NumSubBlocks << "/"
 455                 << Stats.NumSubBlocks/(double)Stats.NumInstances << "\n";
 456       std::cerr << "    Tot/Avg Abbrevs: " << Stats.NumAbbrevs << "/"
 457                 << Stats.NumAbbrevs/(double)Stats.NumInstances << "\n";
 458       std::cerr << "    Tot/Avg Records: " << Stats.NumRecords << "/"
 459                 << Stats.NumRecords/(double)Stats.NumInstances << "\n";
 460     } else {
 461       std::cerr << "      Num SubBlocks: " << Stats.NumSubBlocks << "\n";
 462       std::cerr << "        Num Abbrevs: " << Stats.NumAbbrevs << "\n";
 463       std::cerr << "        Num Records: " << Stats.NumRecords << "\n";
 464     }
 465     if (Stats.NumRecords)
 466       std::cerr << "      % Abbrev Recs: " << (Stats.NumAbbreviatedRecords/
 467                    (double)Stats.NumRecords)*100 << "\n";
 468     std::cerr << "\n";
 469
 470     // Print a histogram of the codes we see.
 471     if (!NoHistogram && !Stats.CodeFreq.empty()) {
 472       std::vector<std::pair<unsigned, unsigned> > FreqPairs;  // <freq,code>
 473       for (unsigned i = 0, e = Stats.CodeFreq.size(); i != e; ++i)
 474         if (unsigned Freq = Stats.CodeFreq[i])
 475           FreqPairs.push_back(std::make_pair(Freq, i));
 476       std::stable_sort(FreqPairs.begin(), FreqPairs.end());
 477       std::reverse(FreqPairs.begin(), FreqPairs.end());
 478
 479       std::cerr << "\tCode Histogram:\n";
 480       for (unsigned i = 0, e = FreqPairs.size(); i != e; ++i) {
 481         std::cerr << "\t\t" << FreqPairs[i].first << "\t";
 482         if (const char *CodeName = GetCodeName(FreqPairs[i].second, I->first))
 483           std::cerr << CodeName << "\n";
 484         else
 485           std::cerr << "UnknownCode" << FreqPairs[i].second << "\n";
 486       }
 487       std::cerr << "\n";
 488
 489     }
 490   }
 491   return 0;
 492 }
 493
 494
 495 int main(int argc, char **argv) {
 496   llvm_shutdown_obj X;  // Call llvm_shutdown() on exit.
 497   cl::ParseCommandLineOptions(argc, argv, "llvm-bcanalyzer file analyzer\n");
 498
 499   sys::PrintStackTraceOnErrorSignal();
 500
 501   return AnalyzeBitcode();
 502 }