+//===- opt.cpp - The LLVM Modular Optimizer -------------------------------===//
+//
+// The LLVM Compiler Infrastructure
+//
+// This file was developed by the LLVM research group and is distributed under
+// the University of Illinois Open Source License. See LICENSE.TXT for details.
+//
//===----------------------------------------------------------------------===//
-// LLVM 'OPT' UTILITY
//
// Optimizations may be specified an arbitrary number of times on the command
-// line, they are run in the order specified.
+// line, They are run in the order specified.
//
//===----------------------------------------------------------------------===//
#include "llvm/Module.h"
+#include "llvm/PassManager.h"
#include "llvm/Bytecode/Reader.h"
-#include "llvm/Bytecode/Writer.h"
+#include "llvm/Bytecode/WriteBytecodePass.h"
#include "llvm/Assembly/PrintModulePass.h"
-#include "llvm/Transforms/ConstantMerge.h"
-#include "llvm/Transforms/CleanupGCCOutput.h"
-#include "llvm/Transforms/LevelChange.h"
-#include "llvm/Transforms/MethodInlining.h"
-#include "llvm/Transforms/SymbolStripping.h"
-#include "llvm/Transforms/ChangeAllocations.h"
-#include "llvm/Transforms/IPO/SimpleStructMutation.h"
-#include "llvm/Transforms/IPO/GlobalDCE.h"
-#include "llvm/Transforms/Scalar/DCE.h"
-#include "llvm/Transforms/Scalar/ConstantProp.h"
-#include "llvm/Transforms/Scalar/InductionVars.h"
-#include "llvm/Transforms/Scalar/IndVarSimplify.h"
-#include "llvm/Transforms/Scalar/InstructionCombining.h"
-#include "llvm/Transforms/Instrumentation/TraceValues.h"
-#include "Support/CommandLine.h"
+#include "llvm/Analysis/Verifier.h"
+#include "llvm/Analysis/LoopPass.h"
+#include "llvm/Target/TargetData.h"
+#include "llvm/Target/TargetMachine.h"
+#include "llvm/Support/PassNameParser.h"
+#include "llvm/System/Signals.h"
+#include "llvm/Support/ManagedStatic.h"
+#include "llvm/Support/PluginLoader.h"
+#include "llvm/Support/Streams.h"
+#include "llvm/Support/SystemUtils.h"
+#include "llvm/Support/Timer.h"
+#include "llvm/LinkAllPasses.h"
+#include "llvm/LinkAllVMCore.h"
+#include <iostream>
#include <fstream>
#include <memory>
+#include <algorithm>
+using namespace llvm;
+
+// The OptimizationList is automatically populated with registered Passes by the
+// PassNameParser.
+//
+static cl::list<const PassInfo*, bool, PassNameParser>
+PassList(cl::desc("Optimizations available:"));
+
+static cl::opt<bool> NoCompress("disable-compression", cl::init(true),
+ cl::desc("Don't compress the generated bytecode"));
+
+// Other command line options...
+//
+static cl::opt<std::string>
+InputFilename(cl::Positional, cl::desc("<input bytecode file>"),
+ cl::init("-"), cl::value_desc("filename"));
+
+static cl::opt<std::string>
+OutputFilename("o", cl::desc("Override output filename"),
+ cl::value_desc("filename"), cl::init("-"));
+
+static cl::opt<bool>
+Force("f", cl::desc("Overwrite output files"));
+
+static cl::opt<bool>
+PrintEachXForm("p", cl::desc("Print module after each transformation"));
+
+static cl::opt<bool>
+NoOutput("disable-output",
+ cl::desc("Do not write result bytecode file"), cl::Hidden);
+
+static cl::opt<bool>
+NoVerify("disable-verify", cl::desc("Do not verify result module"), cl::Hidden);
+
+static cl::opt<bool>
+VerifyEach("verify-each", cl::desc("Verify after each transform"));
+
+static cl::opt<bool>
+StripDebug("strip-debug",
+ cl::desc("Strip debugger symbol info from translation unit"));
+
+static cl::opt<bool>
+DisableInline("disable-inlining", cl::desc("Do not run the inliner pass"));
+
+static cl::opt<bool>
+DisableOptimizations("disable-opt",
+ cl::desc("Do not run any optimization passes"));
+
+static cl::opt<bool>
+StandardCompileOpts("std-compile-opts",
+ cl::desc("Include the standard compile time optimizations"));
+
+static cl::opt<bool>
+Quiet("q", cl::desc("Obsolete option"), cl::Hidden);
+static cl::alias
+QuietA("quiet", cl::desc("Alias for -q"), cl::aliasopt(Quiet));
+static cl::opt<bool>
+AnalyzeOnly("analyze", cl::desc("Only perform analysis, no optimization"));
-enum Opts {
- // Basic optimizations
- dce, constprop, inlining, constmerge, strip, mstrip,
+static Timer BytecodeLoadTimer("Bytecode Loader");
- // Miscellaneous Transformations
- trace, tracem, print, raiseallocs, cleangcc,
+// ---------- Define Printers for module and function passes ------------
+namespace {
- // More powerful optimizations
- indvars, instcombine, sccp, adce, raise,
+struct ModulePassPrinter : public ModulePass {
+ const PassInfo *PassToPrint;
+ ModulePassPrinter(const PassInfo *PI) : PassToPrint(PI) {}
- // Interprocedural optimizations...
- globaldce, swapstructs, sortstructs,
+ virtual bool runOnModule(Module &M) {
+ if (!Quiet) {
+ cout << "Printing analysis '" << PassToPrint->getPassName() << "':\n";
+ getAnalysisID<Pass>(PassToPrint).print(cout, &M);
+ }
+
+ // Get and print pass...
+ return false;
+ }
+
+ virtual const char *getPassName() const { return "'Pass' Printer"; }
+
+ virtual void getAnalysisUsage(AnalysisUsage &AU) const {
+ AU.addRequiredID(PassToPrint);
+ AU.setPreservesAll();
+ }
};
-struct {
- enum Opts OptID;
- Pass *ThePass;
-} OptTable[] = {
- { dce , new DeadCodeElimination() },
- { constprop , new ConstantPropogation() },
- { inlining , new MethodInlining() },
- { constmerge , new ConstantMerge() },
- { strip , new SymbolStripping() },
- { mstrip , new FullSymbolStripping() },
- { indvars , new InductionVariableSimplify() },
- { instcombine, new InstructionCombining() },
- { sccp , new SCCPPass() },
- { adce , new AgressiveDCE() },
- { raise , new RaisePointerReferences() },
- { trace , new InsertTraceCode(true, true) },
- { tracem , new InsertTraceCode(false, true) },
- { print , new PrintMethodPass("Current Method: \n",&cerr) },
- { raiseallocs, new RaiseAllocations() },
- { cleangcc , new CleanupGCCOutput() },
- { globaldce , new GlobalDCE() },
- { swapstructs, new SimpleStructMutation(SimpleStructMutation::SwapElements) },
- { sortstructs, new SimpleStructMutation(SimpleStructMutation::SortElements) },
+struct FunctionPassPrinter : public FunctionPass {
+ const PassInfo *PassToPrint;
+ FunctionPassPrinter(const PassInfo *PI) : PassToPrint(PI) {}
+
+ virtual bool runOnFunction(Function &F) {
+ if (!Quiet) {
+ cout << "Printing analysis '" << PassToPrint->getPassName()
+ << "' for function '" << F.getName() << "':\n";
+ }
+ // Get and print pass...
+ getAnalysisID<Pass>(PassToPrint).print(cout, F.getParent());
+ return false;
+ }
+
+ virtual const char *getPassName() const { return "FunctionPass Printer"; }
+
+ virtual void getAnalysisUsage(AnalysisUsage &AU) const {
+ AU.addRequiredID(PassToPrint);
+ AU.setPreservesAll();
+ }
};
-cl::String InputFilename ("", "Load <arg> file to optimize", cl::NoFlags, "-");
-cl::String OutputFilename("o", "Override output filename", cl::NoFlags, "");
-cl::Flag Force ("f", "Overwrite output files", cl::NoFlags, false);
-cl::Flag Quiet ("q", "Don't print modifying pass names", 0, false);
-cl::Alias QuietA ("quiet", "Alias for -q", cl::NoFlags, Quiet);
-cl::EnumList<enum Opts> OptimizationList(cl::NoFlags,
- clEnumVal(dce , "Dead Code Elimination"),
- clEnumVal(constprop , "Simple Constant Propogation"),
- clEnumValN(inlining , "inline", "Method Integration"),
- clEnumVal(constmerge , "Merge identical global constants"),
- clEnumVal(strip , "Strip Symbols"),
- clEnumVal(mstrip , "Strip Module Symbols"),
- clEnumVal(indvars , "Simplify Induction Variables"),
- clEnumVal(instcombine, "Simplify Induction Variables"),
- clEnumVal(sccp , "Sparse Conditional Constant Propogation"),
- clEnumVal(adce , "Agressive DCE"),
-
- clEnumVal(globaldce , "Remove unreachable globals"),
- clEnumVal(swapstructs, "Swap structure types around"),
- clEnumVal(sortstructs, "Sort structure elements"),
-
- clEnumVal(raiseallocs, "Raise allocations from calls to instructions"),
- clEnumVal(cleangcc , "Cleanup GCC Output"),
- clEnumVal(raise , "Raise to Higher Level"),
- clEnumVal(trace , "Insert BB & Method trace code"),
- clEnumVal(tracem , "Insert Method trace code only"),
- clEnumVal(print , "Print working method to stderr"),
-0);
-
-static void RunOptimization(Module *M, enum Opts Opt) {
- for (unsigned j = 0; j < sizeof(OptTable)/sizeof(OptTable[0]); ++j)
- if (Opt == OptTable[j].OptID) {
- if (OptTable[j].ThePass->run(M) && !Quiet)
- cerr << OptimizationList.getArgName(Opt)
- << " pass made modifications!\n";
- return;
+struct BasicBlockPassPrinter : public BasicBlockPass {
+ const PassInfo *PassToPrint;
+ BasicBlockPassPrinter(const PassInfo *PI) : PassToPrint(PI) {}
+
+ virtual bool runOnBasicBlock(BasicBlock &BB) {
+ if (!Quiet) {
+ cout << "Printing Analysis info for BasicBlock '" << BB.getName()
+ << "': Pass " << PassToPrint->getPassName() << ":\n";
}
-
- cerr << "Optimization tables inconsistent!!\n";
+
+ // Get and print pass...
+ getAnalysisID<Pass>(PassToPrint).print(cout, BB.getParent()->getParent());
+ return false;
+ }
+
+ virtual const char *getPassName() const { return "BasicBlockPass Printer"; }
+
+ virtual void getAnalysisUsage(AnalysisUsage &AU) const {
+ AU.addRequiredID(PassToPrint);
+ AU.setPreservesAll();
+ }
+};
+
+inline void addPass(PassManager &PM, Pass *P) {
+ // Add the pass to the pass manager...
+ PM.add(P);
+
+ // If we are verifying all of the intermediate steps, add the verifier...
+ if (VerifyEach) PM.add(createVerifierPass());
+}
+
+void AddStandardCompilePasses(PassManager &PM) {
+ PM.add(createVerifierPass()); // Verify that input is correct
+
+ addPass(PM, createLowerSetJmpPass()); // Lower llvm.setjmp/.longjmp
+
+ // If the -strip-debug command line option was specified, do it.
+ if (StripDebug)
+ addPass(PM, createStripSymbolsPass(true));
+
+ if (DisableOptimizations) return;
+
+ addPass(PM, createRaiseAllocationsPass()); // call %malloc -> malloc inst
+ addPass(PM, createCFGSimplificationPass()); // Clean up disgusting code
+ addPass(PM, createPromoteMemoryToRegisterPass());// Kill useless allocas
+ addPass(PM, createGlobalOptimizerPass()); // Optimize out global vars
+ addPass(PM, createGlobalDCEPass()); // Remove unused fns and globs
+ addPass(PM, createIPConstantPropagationPass());// IP Constant Propagation
+ addPass(PM, createDeadArgEliminationPass()); // Dead argument elimination
+ addPass(PM, createInstructionCombiningPass()); // Clean up after IPCP & DAE
+ addPass(PM, createCFGSimplificationPass()); // Clean up after IPCP & DAE
+
+ addPass(PM, createPruneEHPass()); // Remove dead EH info
+
+ if (!DisableInline)
+ addPass(PM, createFunctionInliningPass()); // Inline small functions
+ addPass(PM, createArgumentPromotionPass()); // Scalarize uninlined fn args
+
+ addPass(PM, createTailDuplicationPass()); // Simplify cfg by copying code
+ addPass(PM, createInstructionCombiningPass()); // Cleanup for scalarrepl.
+ addPass(PM, createCFGSimplificationPass()); // Merge & remove BBs
+ addPass(PM, createScalarReplAggregatesPass()); // Break up aggregate allocas
+ addPass(PM, createInstructionCombiningPass()); // Combine silly seq's
+ addPass(PM, createCondPropagationPass()); // Propagate conditionals
+
+ addPass(PM, createTailCallEliminationPass()); // Eliminate tail calls
+ addPass(PM, createCFGSimplificationPass()); // Merge & remove BBs
+ addPass(PM, createReassociatePass()); // Reassociate expressions
+ addPass(PM, createLoopRotatePass());
+ addPass(PM, createLICMPass()); // Hoist loop invariants
+ addPass(PM, createLoopUnswitchPass()); // Unswitch loops.
+ addPass(PM, createInstructionCombiningPass()); // Clean up after LICM/reassoc
+ addPass(PM, createIndVarSimplifyPass()); // Canonicalize indvars
+ addPass(PM, createLoopUnrollPass()); // Unroll small loops
+ addPass(PM, createInstructionCombiningPass()); // Clean up after the unroller
+ addPass(PM, createLoadValueNumberingPass()); // GVN for load instructions
+ addPass(PM, createGCSEPass()); // Remove common subexprs
+ addPass(PM, createSCCPPass()); // Constant prop with SCCP
+
+ // Run instcombine after redundancy elimination to exploit opportunities
+ // opened up by them.
+ addPass(PM, createInstructionCombiningPass());
+ addPass(PM, createCondPropagationPass()); // Propagate conditionals
+
+ addPass(PM, createDeadStoreEliminationPass()); // Delete dead stores
+ addPass(PM, createAggressiveDCEPass()); // SSA based 'Aggressive DCE'
+ addPass(PM, createCFGSimplificationPass()); // Merge & remove BBs
+ addPass(PM, createSimplifyLibCallsPass()); // Library Call Optimizations
+ addPass(PM, createDeadTypeEliminationPass()); // Eliminate dead types
+ addPass(PM, createConstantMergePass()); // Merge dup global constants
}
+} // anonymous namespace
+
+
+//===----------------------------------------------------------------------===//
+// main for opt
+//
int main(int argc, char **argv) {
- cl::ParseCommandLineOptions(argc, argv,
- " llvm .bc -> .bc modular optimizer\n");
- std::auto_ptr<Module> M(ParseBytecodeFile(InputFilename));
- if (M.get() == 0) {
- cerr << "bytecode didn't read correctly.\n";
- return 1;
- }
+ llvm_shutdown_obj X; // Call llvm_shutdown() on exit.
+ try {
+ cl::ParseCommandLineOptions(argc, argv,
+ " llvm .bc -> .bc modular optimizer and analysis printer \n");
+ sys::PrintStackTraceOnErrorSignal();
- PassManager Passes;
+ // Allocate a full target machine description only if necessary.
+ // FIXME: The choice of target should be controllable on the command line.
+ std::auto_ptr<TargetMachine> target;
- // Run all of the optimizations specified on the command line
- for (unsigned i = 0; i < OptimizationList.size(); ++i)
- RunOptimization(M.get(), OptimizationList[i]);
+ std::string ErrorMessage;
- std::ostream *Out = &std::cout; // Default to printing to stdout...
- if (OutputFilename != "") {
- if (!Force && std::ifstream(OutputFilename.c_str())) {
- // If force is not specified, make sure not to overwrite a file!
- cerr << "Error opening '" << OutputFilename << "': File exists!\n"
- << "Use -f command line argument to force output\n";
+ // Load the input module...
+ std::auto_ptr<Module> M(ParseBytecodeFile(InputFilename,
+ Compressor::decompressToNewBuffer, &ErrorMessage));
+ if (M.get() == 0) {
+ cerr << argv[0] << ": ";
+ if (ErrorMessage.size())
+ cerr << ErrorMessage << "\n";
+ else
+ cerr << "bytecode didn't read correctly.\n";
return 1;
}
- Out = new std::ofstream(OutputFilename.c_str());
- if (!Out->good()) {
- cerr << "Error opening " << OutputFilename << "!\n";
- return 1;
+ // Figure out what stream we are supposed to write to...
+ // FIXME: cout is not binary!
+ std::ostream *Out = &std::cout; // Default to printing to stdout...
+ if (OutputFilename != "-") {
+ if (!Force && std::ifstream(OutputFilename.c_str())) {
+ // If force is not specified, make sure not to overwrite a file!
+ cerr << argv[0] << ": error opening '" << OutputFilename
+ << "': file exists!\n"
+ << "Use -f command line argument to force output\n";
+ return 1;
+ }
+ std::ios::openmode io_mode = std::ios::out | std::ios::trunc |
+ std::ios::binary;
+ Out = new std::ofstream(OutputFilename.c_str(), io_mode);
+
+ if (!Out->good()) {
+ cerr << argv[0] << ": error opening " << OutputFilename << "!\n";
+ return 1;
+ }
+
+ // Make sure that the Output file gets unlinked from the disk if we get a
+ // SIGINT
+ sys::RemoveFileOnSignal(sys::Path(OutputFilename));
}
- }
- // Okay, we're done now... write out result...
- WriteBytecodeToFile(M.get(), *Out);
+ // If the output is set to be emitted to standard out, and standard out is a
+ // console, print out a warning message and refuse to do it. We don't
+ // impress anyone by spewing tons of binary goo to a terminal.
+ if (!Force && !NoOutput && CheckBytecodeOutputToConsole(Out,!Quiet)) {
+ NoOutput = true;
+ }
+
+ // Create a PassManager to hold and optimize the collection of passes we are
+ // about to build...
+ //
+ PassManager Passes;
+
+ // Add an appropriate TargetData instance for this module...
+ Passes.add(new TargetData(M.get()));
- if (Out != &cout) delete Out;
- return 0;
+ // If -std-compile-opts is given, add in all the standard compilation
+ // optimizations first. This will handle -strip-debug, -disable-inline,
+ // and -disable-opt as well.
+ if (StandardCompileOpts)
+ AddStandardCompilePasses(Passes);
+
+ // otherwise if the -strip-debug command line option was specified, add it.
+ else if (StripDebug)
+ addPass(Passes, createStripSymbolsPass(true));
+
+ // Create a new optimization pass for each one specified on the command line
+ for (unsigned i = 0; i < PassList.size(); ++i) {
+ const PassInfo *PassInf = PassList[i];
+ Pass *P = 0;
+ if (PassInf->getNormalCtor())
+ P = PassInf->getNormalCtor()();
+ else
+ cerr << argv[0] << ": cannot create pass: "
+ << PassInf->getPassName() << "\n";
+ if (P) {
+ addPass(Passes, P);
+
+ if (AnalyzeOnly) {
+ if (dynamic_cast<BasicBlockPass*>(P))
+ Passes.add(new BasicBlockPassPrinter(PassInf));
+ else if (dynamic_cast<FunctionPass*>(P))
+ Passes.add(new FunctionPassPrinter(PassInf));
+ else
+ Passes.add(new ModulePassPrinter(PassInf));
+ }
+ }
+
+ if (PrintEachXForm)
+ Passes.add(new PrintModulePass(&cerr));
+ }
+
+ // Check that the module is well formed on completion of optimization
+ if (!NoVerify && !VerifyEach)
+ Passes.add(createVerifierPass());
+
+ // Write bytecode out to disk or cout as the last step...
+ OStream L(*Out);
+ if (!NoOutput && !AnalyzeOnly)
+ Passes.add(new WriteBytecodePass(&L, false, !NoCompress));
+
+ // Now that we have all of the passes ready, run them.
+ Passes.run(*M.get());
+
+ return 0;
+
+ } catch (const std::string& msg) {
+ cerr << argv[0] << ": " << msg << "\n";
+ } catch (...) {
+ cerr << argv[0] << ": Unexpected unknown exception occurred.\n";
+ }
+ llvm_shutdown();
+ return 1;
}
projects / oota-llvm.git / blobdiff