2004-07-02 03:22:53 +00:00
|
|
|
//===-- llvm-bcanalyzer.cpp - Byte Code Analyzer --------------------------===//
|
2005-04-22 00:00:37 +00:00
|
|
|
//
|
2004-06-07 17:53:43 +00:00
|
|
|
// The LLVM Compiler Infrastructure
|
|
|
|
//
|
2005-04-22 00:00:37 +00:00
|
|
|
// This file was developed by Reid Spencer and is distributed under the
|
2004-06-08 05:56:58 +00:00
|
|
|
// University of Illinois Open Source License. See LICENSE.TXT for details.
|
2005-04-22 00:00:37 +00:00
|
|
|
//
|
2004-06-07 17:53:43 +00:00
|
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
//
|
2004-06-08 05:56:58 +00:00
|
|
|
// This tool may be invoked in the following manner:
|
2004-07-02 03:22:53 +00:00
|
|
|
// llvm-bcanalyzer [options] - Read LLVM bytecode from stdin
|
|
|
|
// llvm-bcanalyzer [options] x.bc - Read LLVM bytecode from the x.bc file
|
2004-06-08 05:56:58 +00:00
|
|
|
//
|
2004-06-07 17:53:43 +00:00
|
|
|
// Options:
|
2004-06-10 18:38:44 +00:00
|
|
|
// --help - Output information about command line switches
|
2005-04-22 00:00:37 +00:00
|
|
|
// --nodetails - Don't print out detailed informaton about individual
|
2004-06-10 18:38:44 +00:00
|
|
|
// blocks and functions
|
|
|
|
// --dump - Dump low-level bytecode structure in readable format
|
2004-06-07 17:53:43 +00:00
|
|
|
//
|
2004-06-08 05:56:58 +00:00
|
|
|
// This tool provides analytical information about a bytecode file. It is
|
|
|
|
// intended as an aid to developers of bytecode reading and writing software. It
|
2005-04-22 00:00:37 +00:00
|
|
|
// produces on std::out a summary of the bytecode file that shows various
|
2004-06-10 18:38:44 +00:00
|
|
|
// statistics about the contents of the file. By default this information is
|
|
|
|
// detailed and contains information about individual bytecode blocks and the
|
2005-04-22 00:00:37 +00:00
|
|
|
// functions in the module. To avoid this more detailed output, use the
|
2004-06-10 18:38:44 +00:00
|
|
|
// -nodetails option to limit the output to just module level information.
|
2005-04-22 00:00:37 +00:00
|
|
|
// The tool is also able to print a bytecode file in a straight forward text
|
|
|
|
// format that shows the containment and relationships of the information in
|
|
|
|
// the bytecode file (-dump option).
|
2007-04-29 05:51:00 +00:00
|
|
|
//
|
2004-06-07 17:53:43 +00:00
|
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
|
2004-06-29 23:34:27 +00:00
|
|
|
#include "llvm/Analysis/Verifier.h"
|
2007-04-29 08:12:22 +00:00
|
|
|
#include "llvm/Bitcode/BitstreamReader.h"
|
2007-04-29 20:00:02 +00:00
|
|
|
#include "llvm/Bitcode/LLVMBitCodes.h"
|
2004-06-07 17:53:43 +00:00
|
|
|
#include "llvm/Bytecode/Analyzer.h"
|
2004-09-01 22:55:40 +00:00
|
|
|
#include "llvm/Support/CommandLine.h"
|
2007-02-07 21:41:02 +00:00
|
|
|
#include "llvm/Support/Compressor.h"
|
2006-12-06 01:18:01 +00:00
|
|
|
#include "llvm/Support/ManagedStatic.h"
|
2007-04-29 08:12:22 +00:00
|
|
|
#include "llvm/Support/MemoryBuffer.h"
|
2004-06-07 17:53:43 +00:00
|
|
|
#include "llvm/System/Signals.h"
|
|
|
|
#include <fstream>
|
|
|
|
#include <iostream>
|
|
|
|
using namespace llvm;
|
|
|
|
|
|
|
|
static cl::opt<std::string>
|
|
|
|
InputFilename(cl::Positional, cl::desc("<input bytecode>"), cl::init("-"));
|
|
|
|
|
2004-08-21 21:00:24 +00:00
|
|
|
static cl::opt<std::string>
|
|
|
|
OutputFilename("-o", cl::init("-"), cl::desc("<output file>"));
|
|
|
|
|
2007-04-29 05:51:00 +00:00
|
|
|
static cl::opt<bool> NoDetails("nodetails", cl::desc("Skip detailed output"));
|
|
|
|
static cl::opt<bool> Dump("dump", cl::desc("Dump low level bytecode trace"));
|
|
|
|
static cl::opt<bool> Verify("verify", cl::desc("Progressively verify module"));
|
2007-04-29 08:31:14 +00:00
|
|
|
|
|
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
// Bitcode specific analysis.
|
|
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
|
2007-04-29 08:12:22 +00:00
|
|
|
static cl::opt<bool> Bitcode("bitcode", cl::desc("Read a bitcode file"));
|
|
|
|
|
|
|
|
/// CurStreamType - If we can sniff the flavor of this stream, we can produce
|
|
|
|
/// better dump info.
|
|
|
|
static enum {
|
|
|
|
UnknownBitstream,
|
|
|
|
LLVMIRBitstream
|
|
|
|
} CurStreamType;
|
|
|
|
|
2007-04-29 20:00:02 +00:00
|
|
|
|
|
|
|
/// GetBlockName - Return a symbolic block name if known, otherwise return
|
|
|
|
/// empty.
|
|
|
|
static const char *GetBlockName(unsigned BlockID) {
|
|
|
|
if (CurStreamType != LLVMIRBitstream) return "";
|
|
|
|
|
|
|
|
switch (BlockID) {
|
|
|
|
default: return "<unknown LLVM IR block ID>";
|
|
|
|
case bitc::MODULE_BLOCK_ID: return "MODULE_BLOCK";
|
|
|
|
case bitc::TYPE_BLOCK_ID: return "TYPE_BLOCK";
|
|
|
|
case bitc::CONSTANTS_BLOCK_ID: return "CONSTANTS_BLOCK";
|
|
|
|
case bitc::FUNCTION_BLOCK_ID: return "FUNCTION_BLOCK";
|
|
|
|
case bitc::TYPE_SYMTAB_BLOCK_ID: return "TYPE_SYMTAB";
|
|
|
|
case bitc::VALUE_SYMTAB_BLOCK_ID: return "VALUE_SYMTAB";
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
struct PerBlockIDStats {
|
|
|
|
/// NumInstances - This the number of times this block ID has been seen.
|
|
|
|
unsigned NumInstances;
|
|
|
|
|
|
|
|
/// NumBits - The total size in bits of all of these blocks.
|
|
|
|
uint64_t NumBits;
|
|
|
|
|
|
|
|
/// NumSubBlocks - The total number of blocks these blocks contain.
|
|
|
|
unsigned NumSubBlocks;
|
|
|
|
|
|
|
|
/// NumAbbrevs - The total number of abbreviations.
|
|
|
|
unsigned NumAbbrevs;
|
|
|
|
|
|
|
|
/// NumRecords - The total number of records these blocks contain, and the
|
|
|
|
/// number that are abbreviated.
|
|
|
|
unsigned NumRecords, NumAbbreviatedRecords;
|
|
|
|
|
|
|
|
PerBlockIDStats()
|
|
|
|
: NumInstances(0), NumBits(0),
|
|
|
|
NumSubBlocks(0), NumAbbrevs(0), NumRecords(0), NumAbbreviatedRecords(0) {}
|
|
|
|
};
|
|
|
|
|
|
|
|
static std::map<unsigned, PerBlockIDStats> BlockIDStats;
|
|
|
|
|
|
|
|
|
|
|
|
|
2007-04-29 08:31:14 +00:00
|
|
|
/// Error - All bitcode analysis errors go through this function, making this a
|
|
|
|
/// good place to breakpoint if debugging.
|
|
|
|
static bool Error(const std::string &Err) {
|
|
|
|
std::cerr << Err << "\n";
|
|
|
|
return true;
|
|
|
|
}
|
|
|
|
|
|
|
|
/// ParseBlock - Read a block, updating statistics, etc.
|
|
|
|
static bool ParseBlock(BitstreamReader &Stream) {
|
2007-04-29 20:00:02 +00:00
|
|
|
uint64_t BlockBitStart = Stream.GetCurrentBitNo();
|
|
|
|
|
2007-04-29 08:31:14 +00:00
|
|
|
unsigned BlockID = Stream.ReadSubBlockID();
|
|
|
|
|
2007-04-29 20:00:02 +00:00
|
|
|
// Get the statistics for this BlockID.
|
|
|
|
PerBlockIDStats &BlockStats = BlockIDStats[BlockID];
|
|
|
|
|
|
|
|
BlockStats.NumInstances++;
|
2007-04-29 08:31:14 +00:00
|
|
|
|
|
|
|
if (Stream.EnterSubBlock())
|
|
|
|
return Error("Malformed block record");
|
|
|
|
|
|
|
|
SmallVector<uint64_t, 64> Record;
|
|
|
|
|
|
|
|
// Read all the records for this block.
|
|
|
|
while (1) {
|
|
|
|
if (Stream.AtEndOfStream())
|
|
|
|
return Error("Premature end of bitstream");
|
|
|
|
|
|
|
|
// Read the code for this record.
|
|
|
|
unsigned AbbrevID = Stream.ReadCode();
|
|
|
|
switch (AbbrevID) {
|
2007-04-29 20:00:02 +00:00
|
|
|
case bitc::END_BLOCK: {
|
2007-04-29 08:31:14 +00:00
|
|
|
if (Stream.ReadBlockEnd())
|
|
|
|
return Error("Error at end of block");
|
2007-04-29 20:00:02 +00:00
|
|
|
uint64_t BlockBitEnd = Stream.GetCurrentBitNo();
|
|
|
|
BlockStats.NumBits += BlockBitEnd-BlockBitStart;
|
2007-04-29 08:31:14 +00:00
|
|
|
return false;
|
2007-04-29 20:00:02 +00:00
|
|
|
}
|
2007-04-29 08:31:14 +00:00
|
|
|
case bitc::ENTER_SUBBLOCK:
|
|
|
|
if (ParseBlock(Stream))
|
|
|
|
return true;
|
2007-04-29 20:00:02 +00:00
|
|
|
++BlockStats.NumSubBlocks;
|
2007-04-29 08:31:14 +00:00
|
|
|
break;
|
|
|
|
case bitc::DEFINE_ABBREV:
|
|
|
|
Stream.ReadAbbrevRecord();
|
2007-04-29 20:00:02 +00:00
|
|
|
++BlockStats.NumAbbrevs;
|
2007-04-29 08:31:14 +00:00
|
|
|
break;
|
|
|
|
default:
|
2007-04-29 20:00:02 +00:00
|
|
|
++BlockStats.NumRecords;
|
|
|
|
if (AbbrevID != bitc::UNABBREV_RECORD)
|
|
|
|
++BlockStats.NumAbbreviatedRecords;
|
|
|
|
|
2007-04-29 08:31:14 +00:00
|
|
|
Record.clear();
|
|
|
|
unsigned Code = Stream.ReadRecord(AbbrevID, Record);
|
|
|
|
// TODO: Compute per-blockid/code stats.
|
|
|
|
Code = Code;
|
|
|
|
break;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2007-04-29 20:00:02 +00:00
|
|
|
static void PrintSize(double Bits) {
|
|
|
|
std::cerr << Bits << "b/" << Bits/8 << "B/" << Bits/32 << "W";
|
|
|
|
}
|
|
|
|
|
|
|
|
|
2007-04-29 08:12:22 +00:00
|
|
|
/// AnalyzeBitcode - Analyze the bitcode file specified by InputFilename.
|
|
|
|
static int AnalyzeBitcode() {
|
|
|
|
// Read the input file.
|
|
|
|
MemoryBuffer *Buffer;
|
|
|
|
if (InputFilename == "-")
|
|
|
|
Buffer = MemoryBuffer::getSTDIN();
|
|
|
|
else
|
|
|
|
Buffer = MemoryBuffer::getFile(&InputFilename[0], InputFilename.size());
|
|
|
|
|
2007-04-29 08:31:14 +00:00
|
|
|
if (Buffer == 0)
|
|
|
|
return Error("Error reading '" + InputFilename + "'.");
|
2007-04-29 08:12:22 +00:00
|
|
|
|
2007-04-29 08:31:14 +00:00
|
|
|
if (Buffer->getBufferSize() & 3)
|
|
|
|
return Error("Bitcode stream should be a multiple of 4 bytes in length");
|
2007-04-29 08:12:22 +00:00
|
|
|
|
|
|
|
unsigned char *BufPtr = (unsigned char *)Buffer->getBufferStart();
|
|
|
|
BitstreamReader Stream(BufPtr, BufPtr+Buffer->getBufferSize());
|
|
|
|
|
|
|
|
|
|
|
|
// Read the stream signature.
|
|
|
|
char Signature[6];
|
|
|
|
Signature[0] = Stream.Read(8);
|
|
|
|
Signature[1] = Stream.Read(8);
|
|
|
|
Signature[2] = Stream.Read(4);
|
|
|
|
Signature[3] = Stream.Read(4);
|
|
|
|
Signature[4] = Stream.Read(4);
|
|
|
|
Signature[5] = Stream.Read(4);
|
|
|
|
|
2007-04-29 08:31:14 +00:00
|
|
|
// Autodetect the file contents, if it is one we know.
|
2007-04-29 08:12:22 +00:00
|
|
|
CurStreamType = UnknownBitstream;
|
|
|
|
if (Signature[0] == 'B' && Signature[1] == 'C' &&
|
|
|
|
Signature[2] == 0x0 && Signature[3] == 0xC &&
|
|
|
|
Signature[4] == 0xE && Signature[5] == 0xD)
|
|
|
|
CurStreamType = LLVMIRBitstream;
|
|
|
|
|
2007-04-29 20:00:02 +00:00
|
|
|
unsigned NumTopBlocks = 0;
|
|
|
|
|
2007-04-29 08:31:14 +00:00
|
|
|
// Parse the top-level structure. We only allow blocks at the top-level.
|
|
|
|
while (!Stream.AtEndOfStream()) {
|
|
|
|
unsigned Code = Stream.ReadCode();
|
|
|
|
if (Code != bitc::ENTER_SUBBLOCK)
|
|
|
|
return Error("Invalid record at top-level");
|
|
|
|
|
|
|
|
if (ParseBlock(Stream))
|
|
|
|
return true;
|
2007-04-29 20:00:02 +00:00
|
|
|
++NumTopBlocks;
|
2007-04-29 08:31:14 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
// Print a summary of the read file.
|
2007-04-29 08:12:22 +00:00
|
|
|
std::cerr << "Summary of " << InputFilename << ":\n";
|
2007-04-29 20:00:02 +00:00
|
|
|
std::cerr << " Total size: ";
|
|
|
|
PrintSize(Buffer->getBufferSize()*8);
|
|
|
|
std::cerr << "\n";
|
|
|
|
std::cerr << " Stream type: ";
|
2007-04-29 08:12:22 +00:00
|
|
|
switch (CurStreamType) {
|
|
|
|
default: assert(0 && "Unknown bitstream type");
|
|
|
|
case UnknownBitstream: std::cerr << "unknown\n"; break;
|
|
|
|
case LLVMIRBitstream: std::cerr << "LLVM IR\n"; break;
|
|
|
|
}
|
2007-04-29 20:00:02 +00:00
|
|
|
std::cerr << " # Toplevel Blocks: " << NumTopBlocks << "\n";
|
|
|
|
std::cerr << "\n";
|
|
|
|
|
|
|
|
// Emit per-block stats.
|
|
|
|
std::cerr << "Per-block Summary:\n";
|
|
|
|
for (std::map<unsigned, PerBlockIDStats>::iterator I = BlockIDStats.begin(),
|
|
|
|
E = BlockIDStats.end(); I != E; ++I) {
|
|
|
|
std::cerr << " Block ID #" << I->first;
|
|
|
|
const char *BlockName = GetBlockName(I->first);
|
|
|
|
if (BlockName[0])
|
|
|
|
std::cerr << " (" << BlockName << ")";
|
|
|
|
std::cerr << ":\n";
|
|
|
|
|
|
|
|
const PerBlockIDStats &Stats = I->second;
|
|
|
|
std::cerr << " Num Instances: " << Stats.NumInstances << "\n";
|
|
|
|
std::cerr << " Total Size: ";
|
|
|
|
PrintSize(Stats.NumBits);
|
|
|
|
std::cerr << "\n";
|
|
|
|
std::cerr << " Average Size: ";
|
|
|
|
PrintSize(Stats.NumBits/(double)Stats.NumInstances);
|
|
|
|
std::cerr << "\n";
|
|
|
|
std::cerr << " Tot/Avg SubBlocks: " << Stats.NumSubBlocks << "/"
|
|
|
|
<< Stats.NumSubBlocks/(double)Stats.NumInstances << "\n";
|
|
|
|
std::cerr << " Tot/Avg Abbrevs: " << Stats.NumAbbrevs << "/"
|
|
|
|
<< Stats.NumAbbrevs/(double)Stats.NumInstances << "\n";
|
|
|
|
std::cerr << " Tot/Avg Records: " << Stats.NumRecords << "/"
|
|
|
|
<< Stats.NumRecords/(double)Stats.NumInstances << "\n";
|
|
|
|
std::cerr << " % Abbrev Recs: " << (Stats.NumAbbreviatedRecords/
|
|
|
|
(double)Stats.NumRecords)*100 << "\n";
|
|
|
|
std::cerr << "\n";
|
|
|
|
}
|
2007-04-29 08:12:22 +00:00
|
|
|
return 0;
|
|
|
|
}
|
2004-06-07 17:53:43 +00:00
|
|
|
|
2007-04-29 08:31:14 +00:00
|
|
|
|
|
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
// Bytecode specific analysis.
|
|
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
|
2006-12-06 01:18:01 +00:00
|
|
|
int main(int argc, char **argv) {
|
|
|
|
llvm_shutdown_obj X; // Call llvm_shutdown() on exit.
|
2007-04-29 08:12:22 +00:00
|
|
|
cl::ParseCommandLineOptions(argc, argv, " llvm-bcanalyzer file analyzer\n");
|
|
|
|
|
|
|
|
sys::PrintStackTraceOnErrorSignal();
|
|
|
|
|
|
|
|
if (Bitcode)
|
|
|
|
return AnalyzeBitcode();
|
|
|
|
|
2004-12-30 05:36:08 +00:00
|
|
|
try {
|
2007-04-29 05:51:00 +00:00
|
|
|
std::ostream *Out = &std::cout; // Default to printing to stdout...
|
2004-12-30 05:36:08 +00:00
|
|
|
std::string ErrorMessage;
|
|
|
|
BytecodeAnalysis bca;
|
|
|
|
|
|
|
|
/// Determine what to generate
|
|
|
|
bca.detailedResults = !NoDetails;
|
|
|
|
bca.progressiveVerify = Verify;
|
|
|
|
|
|
|
|
/// Analyze the bytecode file
|
2007-02-07 21:41:02 +00:00
|
|
|
Module* M = AnalyzeBytecodeFile(InputFilename, bca,
|
|
|
|
Compressor::decompressToNewBuffer,
|
|
|
|
&ErrorMessage, (Dump?Out:0));
|
2004-12-30 05:36:08 +00:00
|
|
|
|
|
|
|
// All that bcanalyzer does is write the gathered statistics to the output
|
|
|
|
PrintBytecodeAnalysis(bca,*Out);
|
|
|
|
|
2007-04-29 08:12:22 +00:00
|
|
|
if (M && Verify) {
|
2004-12-30 05:36:08 +00:00
|
|
|
std::string verificationMsg;
|
2006-07-06 18:02:27 +00:00
|
|
|
if (verifyModule(*M, ReturnStatusAction, &verificationMsg))
|
2004-12-30 05:36:08 +00:00
|
|
|
std::cerr << "Final Verification Message: " << verificationMsg << "\n";
|
2004-06-29 23:34:27 +00:00
|
|
|
}
|
|
|
|
|
2004-12-30 05:36:08 +00:00
|
|
|
if (Out != &std::cout) {
|
|
|
|
((std::ofstream*)Out)->close();
|
|
|
|
delete Out;
|
|
|
|
}
|
|
|
|
return 0;
|
|
|
|
} catch (const std::string& msg) {
|
|
|
|
std::cerr << argv[0] << ": " << msg << "\n";
|
|
|
|
} catch (...) {
|
|
|
|
std::cerr << argv[0] << ": Unexpected unknown exception occurred.\n";
|
2004-06-07 17:53:43 +00:00
|
|
|
}
|
2004-12-30 05:36:08 +00:00
|
|
|
return 1;
|
2004-06-07 17:53:43 +00:00
|
|
|
}
|