tools/gccas/gccas.cpp

   1 //===-- gccas.cpp - The "optimizing assembler" used by the GCC frontend ---===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file was developed by the LLVM research group and is distributed under
   6 // the University of Illinois Open Source License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This utility is designed to be used by the GCC frontend for creating bytecode
  11 // files from its intermediate LLVM assembly.  The requirements for this utility
  12 // are thus slightly different than that of the standard `as' util.
  13 //
  14 //===----------------------------------------------------------------------===//
  15
  16 #include "llvm/Module.h"
  17 #include "llvm/PassManager.h"
  18 #include "llvm/Analysis/LoadValueNumbering.h"
  19 #include "llvm/Analysis/Verifier.h"
  20 #include "llvm/Assembly/Parser.h"
  21 #include "llvm/Bytecode/WriteBytecodePass.h"
  22 #include "llvm/Target/TargetData.h"
  23 #include "llvm/Transforms/IPO.h"
  24 #include "llvm/Transforms/Scalar.h"
  25 #include "llvm/Support/CommandLine.h"
  26 #include "llvm/System/Signals.h"
  27 #include <memory>
  28 #include <fstream>
  29
  30 using namespace llvm;
  31
  32 namespace {
  33   cl::opt<std::string>
  34   InputFilename(cl::Positional,cl::desc("<input llvm assembly>"),cl::init("-"));
  35
  36   cl::opt<std::string>
  37   OutputFilename("o", cl::desc("Override output filename"),
  38                  cl::value_desc("filename"));
  39
  40   cl::opt<bool>
  41   Verify("verify", cl::desc("Verify each pass result"));
  42
  43   cl::opt<bool>
  44   DisableInline("disable-inlining", cl::desc("Do not run the inliner pass"));
  45
  46   cl::opt<bool>
  47   DisableOptimizations("disable-opt",
  48                        cl::desc("Do not run any optimization passes"));
  49
  50   cl::opt<bool>
  51   DisableDSE("disable-dse", cl::desc("Do not run dead store elimination"));
  52   cl::opt<bool>
  53   NoCompress("disable-compression", cl::init(false),
  54              cl::desc("Don't ompress the generated bytecode"));
  55 }
  56
  57
  58 static inline void addPass(PassManager &PM, Pass *P) {
  59   // Add the pass to the pass manager...
  60   PM.add(P);
  61
  62   // If we are verifying all of the intermediate steps, add the verifier...
  63   if (Verify) PM.add(createVerifierPass());
  64 }
  65
  66
  67 void AddConfiguredTransformationPasses(PassManager &PM) {
  68   PM.add(createVerifierPass());                  // Verify that input is correct
  69   addPass(PM, createLowerSetJmpPass());          // Lower llvm.setjmp/.longjmp
  70   addPass(PM, createFunctionResolvingPass());    // Resolve (...) functions
  71
  72   if (DisableOptimizations) return;
  73
  74   addPass(PM, createRaiseAllocationsPass());     // call %malloc -> malloc inst
  75   addPass(PM, createCFGSimplificationPass());    // Clean up disgusting code
  76   addPass(PM, createPromoteMemoryToRegister());  // Kill useless allocas
  77   addPass(PM, createGlobalOptimizerPass());      // Optimize out global vars
  78   addPass(PM, createGlobalDCEPass());            // Remove unused fns and globs
  79   addPass(PM, createIPConstantPropagationPass());// IP Constant Propagation
  80   addPass(PM, createDeadArgEliminationPass());   // Dead argument elimination
  81   addPass(PM, createInstructionCombiningPass()); // Clean up after IPCP & DAE
  82   addPass(PM, createCFGSimplificationPass());    // Clean up after IPCP & DAE
  83
  84   addPass(PM, createPruneEHPass());              // Remove dead EH info
  85
  86   if (!DisableInline)
  87     addPass(PM, createFunctionInliningPass());   // Inline small functions
  88   addPass(PM, createArgumentPromotionPass());    // Scalarize uninlined fn args
  89
  90   addPass(PM, createRaisePointerReferencesPass());// Recover type information
  91   addPass(PM, createTailDuplicationPass());      // Simplify cfg by copying code
  92   addPass(PM, createCFGSimplificationPass());    // Merge & remove BBs
  93   addPass(PM, createScalarReplAggregatesPass()); // Break up aggregate allocas
  94   addPass(PM, createInstructionCombiningPass()); // Combine silly seq's
  95
  96   addPass(PM, createReassociatePass());          // Reassociate expressions
  97   addPass(PM, createInstructionCombiningPass()); // Combine silly seq's
  98   addPass(PM, createTailCallEliminationPass());  // Eliminate tail calls
  99   addPass(PM, createCFGSimplificationPass());    // Merge & remove BBs
 100   addPass(PM, createLICMPass());                 // Hoist loop invariants
 101   addPass(PM, createInstructionCombiningPass()); // Clean up after the unroller
 102   addPass(PM, createIndVarSimplifyPass());       // Canonicalize indvars
 103   addPass(PM, createLoopUnrollPass());           // Unroll small loops
 104   addPass(PM, createInstructionCombiningPass()); // Clean up after the unroller
 105   addPass(PM, createLoadValueNumberingPass());   // GVN for load instructions
 106   addPass(PM, createGCSEPass());                 // Remove common subexprs
 107   addPass(PM, createSCCPPass());                 // Constant prop with SCCP
 108
 109   // Run instcombine after redundancy elimination to exploit opportunities
 110   // opened up by them.
 111   addPass(PM, createInstructionCombiningPass());
 112   if (!DisableDSE)
 113     addPass(PM, createDeadStoreEliminationPass()); // Delete dead stores
 114   addPass(PM, createAggressiveDCEPass());        // SSA based 'Aggressive DCE'
 115   addPass(PM, createCFGSimplificationPass());    // Merge & remove BBs
 116   addPass(PM, createDeadTypeEliminationPass());  // Eliminate dead types
 117   addPass(PM, createConstantMergePass());        // Merge dup global constants
 118 }
 119
 120
 121 int main(int argc, char **argv) {
 122   cl::ParseCommandLineOptions(argc, argv, " llvm .s -> .o assembler for GCC\n");
 123   sys::PrintStackTraceOnErrorSignal();
 124
 125   std::auto_ptr<Module> M;
 126   try {
 127     // Parse the file now...
 128     M.reset(ParseAssemblyFile(InputFilename));
 129   } catch (const ParseException &E) {
 130     std::cerr << argv[0] << ": " << E.getMessage() << "\n";
 131     return 1;
 132   }
 133
 134   if (M.get() == 0) {
 135     std::cerr << argv[0] << ": assembly didn't read correctly.\n";
 136     return 1;
 137   }
 138
 139   std::ostream *Out = 0;
 140   if (OutputFilename == "") {   // Didn't specify an output filename?
 141     if (InputFilename == "-") {
 142       OutputFilename = "-";
 143     } else {
 144       std::string IFN = InputFilename;
 145       int Len = IFN.length();
 146       if (IFN[Len-2] == '.' && IFN[Len-1] == 's') {   // Source ends in .s?
 147         OutputFilename = std::string(IFN.begin(), IFN.end()-2);
 148       } else {
 149         OutputFilename = IFN;   // Append a .o to it
 150       }
 151       OutputFilename += ".o";
 152     }
 153   }
 154
 155   if (OutputFilename == "-")
 156     Out = &std::cout;
 157   else {
 158     Out = new std::ofstream(OutputFilename.c_str(), std::ios::out);
 159
 160     // Make sure that the Out file gets unlinked from the disk if we get a
 161     // signal
 162     sys::RemoveFileOnSignal(sys::Path(OutputFilename));
 163   }
 164
 165
 166   if (!Out->good()) {
 167     std::cerr << argv[0] << ": error opening " << OutputFilename << "!\n";
 168     return 1;
 169   }
 170
 171   // In addition to just parsing the input from GCC, we also want to spiff it up
 172   // a little bit.  Do this now.
 173   //
 174   PassManager Passes;
 175
 176   // Add an appropriate TargetData instance for this module...
 177   Passes.add(new TargetData("gccas", M.get()));
 178
 179   // Add all of the transformation passes to the pass manager to do the cleanup
 180   // and optimization of the GCC output.
 181   //
 182   AddConfiguredTransformationPasses(Passes);
 183
 184   // Make sure everything is still good.
 185   Passes.add(createVerifierPass());
 186
 187   // Write bytecode to file...
 188   Passes.add(new WriteBytecodePass(Out,false,!NoCompress));
 189
 190   // Run our queue of passes all at once now, efficiently.
 191   Passes.run(*M.get());
 192
 193   if (Out != &std::cout) delete Out;
 194   return 0;
 195 }