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/Support/Streams.h"
  27 #include "llvm/Support/ManagedStatic.h"
  28 #include "llvm/System/Signals.h"
  29 #include <iostream>
  30 #include <memory>
  31 #include <fstream>
  32 using namespace llvm;
  33
  34 namespace {
  35   cl::opt<std::string>
  36   InputFilename(cl::Positional,cl::desc("<input llvm assembly>"),cl::init("-"));
  37
  38   cl::opt<std::string>
  39   OutputFilename("o", cl::desc("Override output filename"),
  40                  cl::value_desc("filename"));
  41
  42   cl::opt<bool>
  43   Verify("verify", cl::desc("Verify each pass result"));
  44
  45   cl::opt<bool>
  46   DisableInline("disable-inlining", cl::desc("Do not run the inliner pass"));
  47
  48   cl::opt<bool>
  49   DisableOptimizations("disable-opt",
  50                        cl::desc("Do not run any optimization passes"));
  51
  52   cl::opt<bool>
  53   StripDebug("strip-debug",
  54              cl::desc("Strip debugger symbol info from translation unit"));
  55
  56   cl::opt<bool>
  57   NoCompress("disable-compression", cl::init(false),
  58              cl::desc("Don't compress the generated bytecode"));
  59
  60   cl::opt<bool> TF("traditional-format", cl::Hidden,
  61     cl::desc("Compatibility option: ignored"));
  62 }
  63
  64
  65 static inline void addPass(PassManager &PM, Pass *P) {
  66   // Add the pass to the pass manager...
  67   PM.add(P);
  68
  69   // If we are verifying all of the intermediate steps, add the verifier...
  70   if (Verify) PM.add(createVerifierPass());
  71 }
  72
  73
  74 void AddConfiguredTransformationPasses(PassManager &PM) {
  75   PM.add(createVerifierPass());                  // Verify that input is correct
  76
  77   addPass(PM, createLowerSetJmpPass());          // Lower llvm.setjmp/.longjmp
  78   addPass(PM, createFunctionResolvingPass());    // Resolve (...) functions
  79
  80   // If the -strip-debug command line option was specified, do it.
  81   if (StripDebug)
  82     addPass(PM, createStripSymbolsPass(true));
  83
  84   if (DisableOptimizations) return;
  85
  86   addPass(PM, createRaiseAllocationsPass());     // call %malloc -> malloc inst
  87   addPass(PM, createCFGSimplificationPass());    // Clean up disgusting code
  88   addPass(PM, createPromoteMemoryToRegisterPass());// Kill useless allocas
  89   addPass(PM, createGlobalOptimizerPass());      // Optimize out global vars
  90   addPass(PM, createGlobalDCEPass());            // Remove unused fns and globs
  91   addPass(PM, createIPConstantPropagationPass());// IP Constant Propagation
  92   addPass(PM, createDeadArgEliminationPass());   // Dead argument elimination
  93   addPass(PM, createInstructionCombiningPass()); // Clean up after IPCP & DAE
  94   addPass(PM, createCFGSimplificationPass());    // Clean up after IPCP & DAE
  95
  96   addPass(PM, createPruneEHPass());              // Remove dead EH info
  97
  98   if (!DisableInline)
  99     addPass(PM, createFunctionInliningPass());   // Inline small functions
 100   addPass(PM, createSimplifyLibCallsPass());     // Library Call Optimizations
 101   addPass(PM, createArgumentPromotionPass());    // Scalarize uninlined fn args
 102
 103   addPass(PM, createRaisePointerReferencesPass());// Recover type information
 104   addPass(PM, createTailDuplicationPass());      // Simplify cfg by copying code
 105   addPass(PM, createCFGSimplificationPass());    // Merge & remove BBs
 106   addPass(PM, createScalarReplAggregatesPass()); // Break up aggregate allocas
 107   addPass(PM, createInstructionCombiningPass()); // Combine silly seq's
 108   addPass(PM, createCondPropagationPass());      // Propagate conditionals
 109
 110   addPass(PM, createTailCallEliminationPass());  // Eliminate tail calls
 111   addPass(PM, createCFGSimplificationPass());    // Merge & remove BBs
 112   addPass(PM, createReassociatePass());          // Reassociate expressions
 113   addPass(PM, createLICMPass());                 // Hoist loop invariants
 114   addPass(PM, createLoopUnswitchPass());         // Unswitch loops.
 115   addPass(PM, createInstructionCombiningPass()); // Clean up after LICM/reassoc
 116   addPass(PM, createIndVarSimplifyPass());       // Canonicalize indvars
 117   addPass(PM, createLoopUnrollPass());           // Unroll small loops
 118   addPass(PM, createInstructionCombiningPass()); // Clean up after the unroller
 119   addPass(PM, createLoadValueNumberingPass());   // GVN for load instructions
 120   addPass(PM, createGCSEPass());                 // Remove common subexprs
 121   addPass(PM, createSCCPPass());                 // Constant prop with SCCP
 122
 123   // Run instcombine after redundancy elimination to exploit opportunities
 124   // opened up by them.
 125   addPass(PM, createInstructionCombiningPass());
 126   addPass(PM, createCondPropagationPass());      // Propagate conditionals
 127
 128   addPass(PM, createDeadStoreEliminationPass()); // Delete dead stores
 129   addPass(PM, createAggressiveDCEPass());        // SSA based 'Aggressive DCE'
 130   addPass(PM, createCFGSimplificationPass());    // Merge & remove BBs
 131   addPass(PM, createDeadTypeEliminationPass());  // Eliminate dead types
 132   addPass(PM, createConstantMergePass());        // Merge dup global constants
 133 }
 134
 135
 136 int main(int argc, char **argv) {
 137   llvm_shutdown_obj X;  // Call llvm_shutdown() on exit.
 138   try {
 139     cl::ParseCommandLineOptions(argc, argv,
 140                                 " llvm .s -> .o assembler for GCC\n");
 141     sys::PrintStackTraceOnErrorSignal();
 142
 143     ParseError Err;
 144     std::auto_ptr<Module> M(ParseAssemblyFile(InputFilename,&Err));
 145     if (M.get() == 0) {
 146       cerr << argv[0] << ": " << Err.getMessage() << "\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       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
 186     // it up a little bit.  Do this now.
 187     PassManager Passes;
 188
 189     // Add an appropriate TargetData instance for this module...
 190     Passes.add(new TargetData(M.get()));
 191
 192     // Add all of the transformation passes to the pass manager to do the
 193     // cleanup and optimization of the GCC output.
 194     AddConfiguredTransformationPasses(Passes);
 195
 196     // Make sure everything is still good.
 197     Passes.add(createVerifierPass());
 198
 199     // Write bytecode to file...
 200     OStream L(*Out);
 201     Passes.add(new WriteBytecodePass(&L,false,!NoCompress));
 202
 203     // Run our queue of passes all at once now, efficiently.
 204     Passes.run(*M.get());
 205
 206     if (Out != &std::cout) delete Out;
 207     return 0;
 208   } catch (const std::string& msg) {
 209     cerr << argv[0] << ": " << msg << "\n";
 210   } catch (...) {
 211     cerr << argv[0] << ": Unexpected unknown exception occurred.\n";
 212   }
 213   return 1;
 214 }