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   StripDebug("strip-debug",
  52              cl::desc("Strip debugger symbol info from translation unit"));
  53
  54   cl::opt<bool>
  55   NoCompress("disable-compression", cl::init(false),
  56              cl::desc("Don't compress the generated bytecode"));
  57
  58   cl::opt<bool> TF("traditional-format", cl::Hidden,
  59     cl::desc("Compatibility option: ignored"));
  60 }
  61
  62
  63 static inline void addPass(PassManager &PM, Pass *P) {
  64   // Add the pass to the pass manager...
  65   PM.add(P);
  66
  67   // If we are verifying all of the intermediate steps, add the verifier...
  68   if (Verify) PM.add(createVerifierPass());
  69 }
  70
  71
  72 void AddConfiguredTransformationPasses(PassManager &PM) {
  73   PM.add(createVerifierPass());                  // Verify that input is correct
  74
  75   addPass(PM, createLowerSetJmpPass());          // Lower llvm.setjmp/.longjmp
  76   addPass(PM, createFunctionResolvingPass());    // Resolve (...) functions
  77
  78   // If the -strip-debug command line option was specified, do it.
  79   if (StripDebug)
  80     addPass(PM, createStripSymbolsPass(true));
  81
  82   if (DisableOptimizations) return;
  83
  84   addPass(PM, createRaiseAllocationsPass());     // call %malloc -> malloc inst
  85   addPass(PM, createCFGSimplificationPass());    // Clean up disgusting code
  86   addPass(PM, createPromoteMemoryToRegisterPass());// Kill useless allocas
  87   addPass(PM, createGlobalOptimizerPass());      // Optimize out global vars
  88   addPass(PM, createGlobalDCEPass());            // Remove unused fns and globs
  89   addPass(PM, createIPConstantPropagationPass());// IP Constant Propagation
  90   addPass(PM, createDeadArgEliminationPass());   // Dead argument elimination
  91   addPass(PM, createInstructionCombiningPass()); // Clean up after IPCP & DAE
  92   addPass(PM, createCFGSimplificationPass());    // Clean up after IPCP & DAE
  93
  94   addPass(PM, createPruneEHPass());              // Remove dead EH info
  95
  96   if (!DisableInline)
  97     addPass(PM, createFunctionInliningPass());   // Inline small functions
  98   addPass(PM, createSimplifyLibCallsPass());     // Library Call Optimizations
  99   addPass(PM, createArgumentPromotionPass());    // Scalarize uninlined fn args
 100
 101   addPass(PM, createRaisePointerReferencesPass());// Recover type information
 102   addPass(PM, createTailDuplicationPass());      // Simplify cfg by copying code
 103   addPass(PM, createCFGSimplificationPass());    // Merge & remove BBs
 104   addPass(PM, createScalarReplAggregatesPass()); // Break up aggregate allocas
 105   addPass(PM, createInstructionCombiningPass()); // Combine silly seq's
 106
 107   addPass(PM, createTailCallEliminationPass());  // Eliminate tail calls
 108   addPass(PM, createCFGSimplificationPass());    // Merge & remove BBs
 109   addPass(PM, createLICMPass());                 // Hoist loop invariants
 110   addPass(PM, createReassociatePass());          // Reassociate expressions
 111   addPass(PM, createInstructionCombiningPass()); // Clean up after LICM/reassoc
 112   addPass(PM, createIndVarSimplifyPass());       // Canonicalize indvars
 113   addPass(PM, createLoopUnrollPass());           // Unroll small loops
 114   addPass(PM, createInstructionCombiningPass()); // Clean up after the unroller
 115   addPass(PM, createLoadValueNumberingPass());   // GVN for load instructions
 116   addPass(PM, createGCSEPass());                 // Remove common subexprs
 117   addPass(PM, createSCCPPass());                 // Constant prop with SCCP
 118
 119   // Run instcombine after redundancy elimination to exploit opportunities
 120   // opened up by them.
 121   addPass(PM, createInstructionCombiningPass());
 122   addPass(PM, createDeadStoreEliminationPass()); // Delete dead stores
 123   addPass(PM, createAggressiveDCEPass());        // SSA based 'Aggressive DCE'
 124   addPass(PM, createCFGSimplificationPass());    // Merge & remove BBs
 125   addPass(PM, createDeadTypeEliminationPass());  // Eliminate dead types
 126   addPass(PM, createConstantMergePass());        // Merge dup global constants
 127 }
 128
 129
 130 int main(int argc, char **argv) {
 131   try {
 132     cl::ParseCommandLineOptions(argc, argv,
 133                                 " llvm .s -> .o assembler for GCC\n");
 134     sys::PrintStackTraceOnErrorSignal();
 135
 136     std::auto_ptr<Module> M;
 137     try {
 138       // Parse the file now...
 139       M.reset(ParseAssemblyFile(InputFilename));
 140     } catch (const ParseException &E) {
 141       std::cerr << argv[0] << ": " << E.getMessage() << "\n";
 142       return 1;
 143     }
 144
 145     if (M.get() == 0) {
 146       std::cerr << argv[0] << ": assembly didn't read correctly.\n";
 147       return 1;
 148     }
 149
 150     std::ostream *Out = 0;
 151     if (OutputFilename == "") {   // Didn't specify an output filename?
 152       if (InputFilename == "-") {
 153         OutputFilename = "-";
 154       } else {
 155         std::string IFN = InputFilename;
 156         int Len = IFN.length();
 157         if (IFN[Len-2] == '.' && IFN[Len-1] == 's') {   // Source ends in .s?
 158           OutputFilename = std::string(IFN.begin(), IFN.end()-2);
 159         } else {
 160           OutputFilename = IFN;   // Append a .o to it
 161         }
 162         OutputFilename += ".o";
 163       }
 164     }
 165
 166     if (OutputFilename == "-")
 167       // FIXME: cout is not binary!
 168       Out = &std::cout;
 169     else {
 170       std::ios::openmode io_mode = std::ios::out | std::ios::trunc |
 171                                    std::ios::binary;
 172       Out = new std::ofstream(OutputFilename.c_str(), io_mode);
 173
 174       // Make sure that the Out file gets unlinked from the disk if we get a
 175       // signal
 176       sys::RemoveFileOnSignal(sys::Path(OutputFilename));
 177     }
 178
 179
 180     if (!Out->good()) {
 181       std::cerr << argv[0] << ": error opening " << OutputFilename << "!\n";
 182       return 1;
 183     }
 184
 185     // In addition to just parsing the input from GCC, we also want to spiff it up
 186     // a little bit.  Do this now.
 187     //
 188     PassManager Passes;
 189
 190     // Add an appropriate TargetData instance for this module...
 191     Passes.add(new TargetData("gccas", M.get()));
 192
 193     // Add all of the transformation passes to the pass manager to do the cleanup
 194     // and optimization of the GCC output.
 195     //
 196     AddConfiguredTransformationPasses(Passes);
 197
 198     // Make sure everything is still good.
 199     Passes.add(createVerifierPass());
 200
 201     // Write bytecode to file...
 202     Passes.add(new WriteBytecodePass(Out,false,!NoCompress));
 203
 204     // Run our queue of passes all at once now, efficiently.
 205     Passes.run(*M.get());
 206
 207     if (Out != &std::cout) delete Out;
 208     return 0;
 209   } catch (const std::string& msg) {
 210     std::cerr << argv[0] << ": " << msg << "\n";
 211   } catch (...) {
 212     std::cerr << argv[0] << ": Unexpected unknown exception occurred.\n";
 213   }
 214   return 1;
 215 }