tools/llvm-bcanalyzer/llvm-bcanalyzer.cpp

   1 //===-- llvm-bcanalyzer.cpp - Byte Code Analyzer --------------------------===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file was developed by Reid Spencer and is distributed under the
   6 // University of Illinois Open Source 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 bytecode from stdin
  12 //  llvm-bcanalyzer [options] x.bc - Read LLVM bytecode from the x.bc file
  13 //
  14 //  Options:
  15 //      --help      - Output information about command line switches
  16 //      --nodetails - Don't print out detailed informaton about individual
  17 //                    blocks and functions
  18 //      --dump      - Dump low-level bytecode structure in readable format
  19 //
  20 // This tool provides analytical information about a bytecode file. It is
  21 // intended as an aid to developers of bytecode reading and writing software. It
  22 // produces on std::out a summary of the bytecode file that shows various
  23 // statistics about the contents of the file. By default this information is
  24 // detailed and contains information about individual bytecode blocks and the
  25 // functions in the module. To avoid this more detailed output, use the
  26 // -nodetails option to limit the output to just module level information.
  27 // The tool is also able to print a bytecode file in a straight forward text
  28 // format that shows the containment and relationships of the information in
  29 // the bytecode file (-dump option).
  30 //
  31 //===----------------------------------------------------------------------===//
  32
  33 #include "llvm/Analysis/Verifier.h"
  34 #include "llvm/Bytecode/Analyzer.h"
  35 #include "llvm/Support/CommandLine.h"
  36 #include "llvm/Support/Compressor.h"
  37 #include "llvm/Support/ManagedStatic.h"
  38 #include "llvm/System/Signals.h"
  39 #include <fstream>
  40 #include <iostream>
  41
  42 using namespace llvm;
  43
  44 static cl::opt<std::string>
  45   InputFilename(cl::Positional, cl::desc("<input bytecode>"), cl::init("-"));
  46
  47 static cl::opt<std::string>
  48   OutputFilename("-o", cl::init("-"), cl::desc("<output file>"));
  49
  50 static cl::opt<bool> NoDetails("nodetails", cl::desc("Skip detailed output"));
  51 static cl::opt<bool> Dump("dump", cl::desc("Dump low level bytecode trace"));
  52 static cl::opt<bool> Verify("verify", cl::desc("Progressively verify module"));
  53
  54 int main(int argc, char **argv) {
  55   llvm_shutdown_obj X;  // Call llvm_shutdown() on exit.
  56   try {
  57     cl::ParseCommandLineOptions(argc, argv,
  58       " llvm-bcanalyzer Analysis of ByteCode Dumper\n");
  59
  60     sys::PrintStackTraceOnErrorSignal();
  61
  62     std::ostream *Out = &std::cout;  // Default to printing to stdout...
  63     std::string ErrorMessage;
  64     BytecodeAnalysis bca;
  65
  66     /// Determine what to generate
  67     bca.detailedResults = !NoDetails;
  68     bca.progressiveVerify = Verify;
  69
  70     /// Analyze the bytecode file
  71     Module* M = AnalyzeBytecodeFile(InputFilename, bca,
  72                                     Compressor::decompressToNewBuffer,
  73                                     &ErrorMessage, (Dump?Out:0));
  74
  75     // All that bcanalyzer does is write the gathered statistics to the output
  76     PrintBytecodeAnalysis(bca,*Out);
  77
  78     if ( M && Verify ) {
  79       std::string verificationMsg;
  80       if (verifyModule(*M, ReturnStatusAction, &verificationMsg))
  81         std::cerr << "Final Verification Message: " << verificationMsg << "\n";
  82     }
  83
  84     if (Out != &std::cout) {
  85       ((std::ofstream*)Out)->close();
  86       delete Out;
  87     }
  88     return 0;
  89   } catch (const std::string& msg) {
  90     std::cerr << argv[0] << ": " << msg << "\n";
  91   } catch (...) {
  92     std::cerr << argv[0] << ": Unexpected unknown exception occurred.\n";
  93   }
  94   return 1;
  95 }