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 "Support/CommandLine.h"
  26 #include "Support/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
  47
  48 static inline void addPass(PassManager &PM, Pass *P) {
  49   // Add the pass to the pass manager...
  50   PM.add(P);
  51
  52   // If we are verifying all of the intermediate steps, add the verifier...
  53   if (Verify) PM.add(createVerifierPass());
  54 }
  55
  56
  57 void AddConfiguredTransformationPasses(PassManager &PM) {
  58   PM.add(createVerifierPass());                  // Verify that input is correct
  59   addPass(PM, createLowerSetJmpPass());          // Lower llvm.setjmp/.longjmp
  60   addPass(PM, createFunctionResolvingPass());    // Resolve (...) functions
  61   addPass(PM, createGlobalDCEPass());            // Remove unused globals
  62   addPass(PM, createRaiseAllocationsPass());     // call %malloc -> malloc inst
  63   addPass(PM, createPromoteMemoryToRegister());  // "Construct SSA form"
  64   addPass(PM, createIPConstantPropagationPass());// IP Constant Propagation
  65   addPass(PM, createDeadArgEliminationPass());   // Dead argument elimination
  66   addPass(PM, createInstructionCombiningPass()); // Cleanup after IPCP & DAE
  67   addPass(PM, createCFGSimplificationPass());    // Clean up disgusting code
  68
  69   addPass(PM, createPruneEHPass());              // Remove dead EH info
  70
  71   if (!DisableInline)
  72     addPass(PM, createFunctionInliningPass());   // Inline small functions
  73
  74   addPass(PM, createInstructionCombiningPass()); // Cleanup code for raise
  75
  76   // HACK HACK HACK.  This pass should be extended to support calls like 'call
  77   // (const expr cast (free))(Ty *).  Until it does so, we have to run it after
  78   // instruction combining.  This should be removed after PLDI!
  79   addPass(PM, createRaiseAllocationsPass());     // call %malloc -> malloc inst
  80
  81   addPass(PM, createRaisePointerReferencesPass());// Recover type information
  82   addPass(PM, createTailDuplicationPass());      // Simplify cfg by copying code
  83   addPass(PM, createCFGSimplificationPass());    // Merge & remove BBs
  84   addPass(PM, createScalarReplAggregatesPass()); // Break up aggregate allocas
  85   addPass(PM, createTailCallEliminationPass());  // Eliminate tail calls
  86   addPass(PM, createInstructionCombiningPass()); // Combine silly seq's
  87
  88   addPass(PM, createReassociatePass());          // Reassociate expressions
  89   addPass(PM, createInstructionCombiningPass()); // Combine silly seq's
  90   addPass(PM, createCFGSimplificationPass());    // Merge & remove BBs
  91   addPass(PM, createLICMPass());                 // Hoist loop invariants
  92   addPass(PM, createLoadValueNumberingPass());   // GVN for load instructions
  93   addPass(PM, createGCSEPass());                 // Remove common subexprs
  94   addPass(PM, createSCCPPass());                 // Constant prop with SCCP
  95
  96   // Run instcombine after redundancy elimination to exploit opportunities
  97   // opened up by them.
  98   addPass(PM, createInstructionCombiningPass());
  99   addPass(PM, createIndVarSimplifyPass());       // Canonicalize indvars
 100   addPass(PM, createAggressiveDCEPass());        // SSA based 'Aggressive DCE'
 101   addPass(PM, createCFGSimplificationPass());    // Merge & remove BBs
 102   addPass(PM, createDeadTypeEliminationPass());  // Eliminate dead types
 103   addPass(PM, createConstantMergePass());        // Merge dup global constants
 104 }
 105
 106
 107 int main(int argc, char **argv) {
 108   cl::ParseCommandLineOptions(argc, argv, " llvm .s -> .o assembler for GCC\n");
 109
 110   std::auto_ptr<Module> M;
 111   try {
 112     // Parse the file now...
 113     M.reset(ParseAssemblyFile(InputFilename));
 114   } catch (const ParseException &E) {
 115     std::cerr << argv[0] << ": " << E.getMessage() << "\n";
 116     return 1;
 117   }
 118
 119   if (M.get() == 0) {
 120     std::cerr << argv[0] << ": assembly didn't read correctly.\n";
 121     return 1;
 122   }
 123
 124   std::ostream *Out = 0;
 125   if (OutputFilename == "") {   // Didn't specify an output filename?
 126     if (InputFilename == "-") {
 127       OutputFilename = "-";
 128     } else {
 129       std::string IFN = InputFilename;
 130       int Len = IFN.length();
 131       if (IFN[Len-2] == '.' && IFN[Len-1] == 's') {   // Source ends in .s?
 132         OutputFilename = std::string(IFN.begin(), IFN.end()-2);
 133       } else {
 134         OutputFilename = IFN;   // Append a .o to it
 135       }
 136       OutputFilename += ".o";
 137     }
 138   }
 139
 140   if (OutputFilename == "-")
 141     Out = &std::cout;
 142   else {
 143     Out = new std::ofstream(OutputFilename.c_str(), std::ios::out);
 144
 145     // Make sure that the Out file gets unlinked from the disk if we get a
 146     // signal
 147     RemoveFileOnSignal(OutputFilename);
 148   }
 149
 150
 151   if (!Out->good()) {
 152     std::cerr << argv[0] << ": error opening " << OutputFilename << "!\n";
 153     return 1;
 154   }
 155
 156   // In addition to just parsing the input from GCC, we also want to spiff it up
 157   // a little bit.  Do this now.
 158   //
 159   PassManager Passes;
 160
 161   // Add an appropriate TargetData instance for this module...
 162   Passes.add(new TargetData("gccas", M.get()));
 163
 164   // Add all of the transformation passes to the pass manager to do the cleanup
 165   // and optimization of the GCC output.
 166   //
 167   AddConfiguredTransformationPasses(Passes);
 168
 169   // Write bytecode to file...
 170   Passes.add(new WriteBytecodePass(Out));
 171
 172   // Run our queue of passes all at once now, efficiently.
 173   Passes.run(*M.get());
 174
 175   if (Out != &std::cout) delete Out;
 176   return 0;
 177 }