Chris Lattner | dbc2318 | 2003-10-15 21:49:57 +0000 | [diff] [blame] | 1 | //===-- gccas.cpp - The "optimizing assembler" used by the GCC frontend ---===// |
John Criswell | 7c0e022 | 2003-10-20 17:47:21 +0000 | [diff] [blame] | 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 | //===----------------------------------------------------------------------===// |
Chris Lattner | ecbde33 | 2001-10-31 04:28:11 +0000 | [diff] [blame] | 9 | // |
Misha Brukman | 57d708b | 2003-08-07 21:23:52 +0000 | [diff] [blame] | 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. |
Chris Lattner | ecbde33 | 2001-10-31 04:28:11 +0000 | [diff] [blame] | 13 | // |
Chris Lattner | 3dc67dd | 2002-01-22 03:30:46 +0000 | [diff] [blame] | 14 | //===----------------------------------------------------------------------===// |
Chris Lattner | ecbde33 | 2001-10-31 04:28:11 +0000 | [diff] [blame] | 15 | |
| 16 | #include "llvm/Module.h" |
Chris Lattner | 0f3bfff | 2002-01-31 00:46:22 +0000 | [diff] [blame] | 17 | #include "llvm/PassManager.h" |
Misha Brukman | 57d708b | 2003-08-07 21:23:52 +0000 | [diff] [blame] | 18 | #include "llvm/Analysis/LoadValueNumbering.h" |
| 19 | #include "llvm/Analysis/Verifier.h" |
Chris Lattner | ecbde33 | 2001-10-31 04:28:11 +0000 | [diff] [blame] | 20 | #include "llvm/Assembly/Parser.h" |
Misha Brukman | 57d708b | 2003-08-07 21:23:52 +0000 | [diff] [blame] | 21 | #include "llvm/Bytecode/WriteBytecodePass.h" |
| 22 | #include "llvm/Target/TargetData.h" |
Chris Lattner | d9d8c07 | 2002-07-23 22:04:43 +0000 | [diff] [blame] | 23 | #include "llvm/Transforms/IPO.h" |
Chris Lattner | 65f1b89 | 2002-05-07 20:03:27 +0000 | [diff] [blame] | 24 | #include "llvm/Transforms/Scalar.h" |
Reid Spencer | 551ccae | 2004-09-01 22:55:40 +0000 | [diff] [blame] | 25 | #include "llvm/Support/CommandLine.h" |
Chris Lattner | bed85ff | 2004-05-27 05:41:36 +0000 | [diff] [blame] | 26 | #include "llvm/System/Signals.h" |
Chris Lattner | ecbde33 | 2001-10-31 04:28:11 +0000 | [diff] [blame] | 27 | #include <memory> |
| 28 | #include <fstream> |
Chris Lattner | ecbde33 | 2001-10-31 04:28:11 +0000 | [diff] [blame] | 29 | |
Brian Gaeke | d0fde30 | 2003-11-11 22:41:34 +0000 | [diff] [blame] | 30 | using namespace llvm; |
| 31 | |
Chris Lattner | f2956fc | 2003-04-16 17:34:29 +0000 | [diff] [blame] | 32 | namespace { |
Chris Lattner | f2956fc | 2003-04-16 17:34:29 +0000 | [diff] [blame] | 33 | cl::opt<std::string> |
Chris Lattner | 8c7b055 | 2003-04-16 17:49:18 +0000 | [diff] [blame] | 34 | InputFilename(cl::Positional,cl::desc("<input llvm assembly>"),cl::init("-")); |
Chris Lattner | 5ff62e9 | 2002-07-22 02:10:13 +0000 | [diff] [blame] | 35 | |
Chris Lattner | f2956fc | 2003-04-16 17:34:29 +0000 | [diff] [blame] | 36 | cl::opt<std::string> |
| 37 | OutputFilename("o", cl::desc("Override output filename"), |
| 38 | cl::value_desc("filename")); |
Chris Lattner | 5ff62e9 | 2002-07-22 02:10:13 +0000 | [diff] [blame] | 39 | |
Chris Lattner | f2956fc | 2003-04-16 17:34:29 +0000 | [diff] [blame] | 40 | cl::opt<bool> |
| 41 | Verify("verify", cl::desc("Verify each pass result")); |
Chris Lattner | 0cea3ec | 2003-10-10 18:18:53 +0000 | [diff] [blame] | 42 | |
| 43 | cl::opt<bool> |
| 44 | DisableInline("disable-inlining", cl::desc("Do not run the inliner pass")); |
Chris Lattner | 74295c0 | 2003-12-30 03:24:27 +0000 | [diff] [blame] | 45 | |
| 46 | cl::opt<bool> |
| 47 | DisableOptimizations("disable-opt", |
| 48 | cl::desc("Do not run any optimization passes")); |
Chris Lattner | b11a463 | 2004-07-22 08:34:33 +0000 | [diff] [blame] | 49 | |
| 50 | cl::opt<bool> |
Chris Lattner | 40add59 | 2004-12-03 05:45:58 +0000 | [diff] [blame] | 51 | StripDebug("strip-debug", |
| 52 | cl::desc("Strip debugger symbol info from translation unit")); |
| 53 | |
Reid Spencer | cc0bd56 | 2004-11-08 17:37:04 +0000 | [diff] [blame] | 54 | cl::opt<bool> |
| 55 | NoCompress("disable-compression", cl::init(false), |
Jeff Cohen | 7109ce8 | 2005-01-01 22:10:32 +0000 | [diff] [blame] | 56 | cl::desc("Don't compress the generated bytecode")); |
Reid Spencer | 5512655 | 2004-12-22 02:58:43 +0000 | [diff] [blame] | 57 | |
| 58 | cl::opt<bool> TF("traditional-format", cl::Hidden, |
| 59 | cl::desc("Compatibility option: ignored")); |
Chris Lattner | f2956fc | 2003-04-16 17:34:29 +0000 | [diff] [blame] | 60 | } |
Chris Lattner | 5ff62e9 | 2002-07-22 02:10:13 +0000 | [diff] [blame] | 61 | |
Chris Lattner | 624c3e0 | 2002-06-25 15:57:43 +0000 | [diff] [blame] | 62 | |
| 63 | static inline void addPass(PassManager &PM, Pass *P) { |
Chris Lattner | 36f18ae | 2003-08-31 21:47:24 +0000 | [diff] [blame] | 64 | // Add the pass to the pass manager... |
| 65 | PM.add(P); |
Chris Lattner | 624c3e0 | 2002-06-25 15:57:43 +0000 | [diff] [blame] | 66 | |
Chris Lattner | 36f18ae | 2003-08-31 21:47:24 +0000 | [diff] [blame] | 67 | // If we are verifying all of the intermediate steps, add the verifier... |
| 68 | if (Verify) PM.add(createVerifierPass()); |
Chris Lattner | 624c3e0 | 2002-06-25 15:57:43 +0000 | [diff] [blame] | 69 | } |
| 70 | |
| 71 | |
| 72 | void AddConfiguredTransformationPasses(PassManager &PM) { |
Chris Lattner | e643a6c | 2003-06-22 20:11:45 +0000 | [diff] [blame] | 73 | PM.add(createVerifierPass()); // Verify that input is correct |
Chris Lattner | 40add59 | 2004-12-03 05:45:58 +0000 | [diff] [blame] | 74 | |
Chris Lattner | f7c7f5a | 2003-09-15 04:56:44 +0000 | [diff] [blame] | 75 | addPass(PM, createLowerSetJmpPass()); // Lower llvm.setjmp/.longjmp |
Chris Lattner | c539483 | 2002-08-30 22:55:32 +0000 | [diff] [blame] | 76 | addPass(PM, createFunctionResolvingPass()); // Resolve (...) functions |
Chris Lattner | 74295c0 | 2003-12-30 03:24:27 +0000 | [diff] [blame] | 77 | |
Chris Lattner | 40add59 | 2004-12-03 05:45:58 +0000 | [diff] [blame] | 78 | // If the -strip-debug command line option was specified, do it. |
| 79 | if (StripDebug) |
| 80 | addPass(PM, createStripSymbolsPass(true)); |
| 81 | |
Chris Lattner | 74295c0 | 2003-12-30 03:24:27 +0000 | [diff] [blame] | 82 | if (DisableOptimizations) return; |
| 83 | |
Chris Lattner | 14b170f | 2003-11-21 21:44:35 +0000 | [diff] [blame] | 84 | addPass(PM, createRaiseAllocationsPass()); // call %malloc -> malloc inst |
Chris Lattner | 05e4e8a | 2004-02-01 07:24:53 +0000 | [diff] [blame] | 85 | addPass(PM, createCFGSimplificationPass()); // Clean up disgusting code |
Alkis Evlogimenos | ab7ada3 | 2005-03-28 02:01:12 +0000 | [diff] [blame] | 86 | addPass(PM, createPromoteMemoryToRegisterPass());// Kill useless allocas |
Chris Lattner | 93a00e4 | 2004-10-07 04:12:02 +0000 | [diff] [blame] | 87 | addPass(PM, createGlobalOptimizerPass()); // Optimize out global vars |
| 88 | addPass(PM, createGlobalDCEPass()); // Remove unused fns and globs |
Chris Lattner | eaa35bb | 2003-10-23 18:25:57 +0000 | [diff] [blame] | 89 | addPass(PM, createIPConstantPropagationPass());// IP Constant Propagation |
| 90 | addPass(PM, createDeadArgEliminationPass()); // Dead argument elimination |
Chris Lattner | 05e4e8a | 2004-02-01 07:24:53 +0000 | [diff] [blame] | 91 | addPass(PM, createInstructionCombiningPass()); // Clean up after IPCP & DAE |
| 92 | addPass(PM, createCFGSimplificationPass()); // Clean up after IPCP & DAE |
Chris Lattner | eaa35bb | 2003-10-23 18:25:57 +0000 | [diff] [blame] | 93 | |
Chris Lattner | cf37c23 | 2003-08-31 21:45:55 +0000 | [diff] [blame] | 94 | addPass(PM, createPruneEHPass()); // Remove dead EH info |
Chris Lattner | 0cea3ec | 2003-10-10 18:18:53 +0000 | [diff] [blame] | 95 | |
| 96 | if (!DisableInline) |
| 97 | addPass(PM, createFunctionInliningPass()); // Inline small functions |
Chris Lattner | 2c7b430 | 2004-03-13 21:38:35 +0000 | [diff] [blame] | 98 | addPass(PM, createArgumentPromotionPass()); // Scalarize uninlined fn args |
Chris Lattner | cf37c23 | 2003-08-31 21:45:55 +0000 | [diff] [blame] | 99 | |
Chris Lattner | f07c833 | 2003-10-16 16:50:34 +0000 | [diff] [blame] | 100 | addPass(PM, createRaisePointerReferencesPass());// Recover type information |
Chris Lattner | e643a6c | 2003-06-22 20:11:45 +0000 | [diff] [blame] | 101 | addPass(PM, createTailDuplicationPass()); // Simplify cfg by copying code |
| 102 | addPass(PM, createCFGSimplificationPass()); // Merge & remove BBs |
Chris Lattner | 42ed21b | 2003-05-30 19:24:06 +0000 | [diff] [blame] | 103 | addPass(PM, createScalarReplAggregatesPass()); // Break up aggregate allocas |
Chris Lattner | cf37c23 | 2003-08-31 21:45:55 +0000 | [diff] [blame] | 104 | addPass(PM, createInstructionCombiningPass()); // Combine silly seq's |
| 105 | |
Chris Lattner | ca6cc6f | 2003-12-11 17:50:32 +0000 | [diff] [blame] | 106 | addPass(PM, createTailCallEliminationPass()); // Eliminate tail calls |
Chris Lattner | 4dd7d3e | 2002-09-06 18:41:33 +0000 | [diff] [blame] | 107 | addPass(PM, createCFGSimplificationPass()); // Merge & remove BBs |
Chris Lattner | c539483 | 2002-08-30 22:55:32 +0000 | [diff] [blame] | 108 | addPass(PM, createLICMPass()); // Hoist loop invariants |
Chris Lattner | 35641ec | 2005-03-07 03:19:50 +0000 | [diff] [blame] | 109 | addPass(PM, createReassociatePass()); // Reassociate expressions |
| 110 | addPass(PM, createInstructionCombiningPass()); // Clean up after LICM/reassoc |
Chris Lattner | 93d8202 | 2004-04-18 05:21:01 +0000 | [diff] [blame] | 111 | addPass(PM, createIndVarSimplifyPass()); // Canonicalize indvars |
| 112 | addPass(PM, createLoopUnrollPass()); // Unroll small loops |
| 113 | addPass(PM, createInstructionCombiningPass()); // Clean up after the unroller |
Chris Lattner | c539483 | 2002-08-30 22:55:32 +0000 | [diff] [blame] | 114 | addPass(PM, createLoadValueNumberingPass()); // GVN for load instructions |
| 115 | addPass(PM, createGCSEPass()); // Remove common subexprs |
| 116 | addPass(PM, createSCCPPass()); // Constant prop with SCCP |
Chris Lattner | 624c3e0 | 2002-06-25 15:57:43 +0000 | [diff] [blame] | 117 | |
| 118 | // Run instcombine after redundancy elimination to exploit opportunities |
| 119 | // opened up by them. |
| 120 | addPass(PM, createInstructionCombiningPass()); |
Chris Lattner | 40add59 | 2004-12-03 05:45:58 +0000 | [diff] [blame] | 121 | addPass(PM, createDeadStoreEliminationPass()); // Delete dead stores |
Chris Lattner | e643a6c | 2003-06-22 20:11:45 +0000 | [diff] [blame] | 122 | addPass(PM, createAggressiveDCEPass()); // SSA based 'Aggressive DCE' |
Chris Lattner | 4dd7d3e | 2002-09-06 18:41:33 +0000 | [diff] [blame] | 123 | addPass(PM, createCFGSimplificationPass()); // Merge & remove BBs |
Chris Lattner | cf37c23 | 2003-08-31 21:45:55 +0000 | [diff] [blame] | 124 | addPass(PM, createDeadTypeEliminationPass()); // Eliminate dead types |
| 125 | addPass(PM, createConstantMergePass()); // Merge dup global constants |
Chris Lattner | 624c3e0 | 2002-06-25 15:57:43 +0000 | [diff] [blame] | 126 | } |
| 127 | |
Chris Lattner | ecbde33 | 2001-10-31 04:28:11 +0000 | [diff] [blame] | 128 | |
| 129 | int main(int argc, char **argv) { |
Chris Lattner | ecbde33 | 2001-10-31 04:28:11 +0000 | [diff] [blame] | 130 | try { |
Reid Spencer | 1ef8bda | 2004-12-30 05:36:08 +0000 | [diff] [blame] | 131 | cl::ParseCommandLineOptions(argc, argv, |
| 132 | " llvm .s -> .o assembler for GCC\n"); |
| 133 | sys::PrintStackTraceOnErrorSignal(); |
Chris Lattner | ecbde33 | 2001-10-31 04:28:11 +0000 | [diff] [blame] | 134 | |
Reid Spencer | 1ef8bda | 2004-12-30 05:36:08 +0000 | [diff] [blame] | 135 | std::auto_ptr<Module> M; |
| 136 | try { |
| 137 | // Parse the file now... |
| 138 | M.reset(ParseAssemblyFile(InputFilename)); |
| 139 | } catch (const ParseException &E) { |
| 140 | std::cerr << argv[0] << ": " << E.getMessage() << "\n"; |
| 141 | return 1; |
Chris Lattner | ecbde33 | 2001-10-31 04:28:11 +0000 | [diff] [blame] | 142 | } |
Reid Spencer | 1ef8bda | 2004-12-30 05:36:08 +0000 | [diff] [blame] | 143 | |
| 144 | if (M.get() == 0) { |
| 145 | std::cerr << argv[0] << ": assembly didn't read correctly.\n"; |
| 146 | return 1; |
| 147 | } |
| 148 | |
| 149 | std::ostream *Out = 0; |
| 150 | if (OutputFilename == "") { // Didn't specify an output filename? |
| 151 | if (InputFilename == "-") { |
| 152 | OutputFilename = "-"; |
| 153 | } else { |
| 154 | std::string IFN = InputFilename; |
| 155 | int Len = IFN.length(); |
| 156 | if (IFN[Len-2] == '.' && IFN[Len-1] == 's') { // Source ends in .s? |
| 157 | OutputFilename = std::string(IFN.begin(), IFN.end()-2); |
| 158 | } else { |
| 159 | OutputFilename = IFN; // Append a .o to it |
| 160 | } |
| 161 | OutputFilename += ".o"; |
| 162 | } |
| 163 | } |
| 164 | |
| 165 | if (OutputFilename == "-") |
Jeff Cohen | 5fb6ed4 | 2005-01-22 17:36:17 +0000 | [diff] [blame] | 166 | // FIXME: cout is not binary! |
Reid Spencer | 1ef8bda | 2004-12-30 05:36:08 +0000 | [diff] [blame] | 167 | Out = &std::cout; |
| 168 | else { |
Jeff Cohen | 5fb6ed4 | 2005-01-22 17:36:17 +0000 | [diff] [blame] | 169 | std::ios::openmode io_mode = std::ios::out | std::ios::trunc | |
| 170 | std::ios::binary; |
| 171 | Out = new std::ofstream(OutputFilename.c_str(), io_mode); |
Reid Spencer | 1ef8bda | 2004-12-30 05:36:08 +0000 | [diff] [blame] | 172 | |
| 173 | // Make sure that the Out file gets unlinked from the disk if we get a |
| 174 | // signal |
| 175 | sys::RemoveFileOnSignal(sys::Path(OutputFilename)); |
| 176 | } |
| 177 | |
| 178 | |
| 179 | if (!Out->good()) { |
| 180 | std::cerr << argv[0] << ": error opening " << OutputFilename << "!\n"; |
| 181 | return 1; |
| 182 | } |
| 183 | |
| 184 | // In addition to just parsing the input from GCC, we also want to spiff it up |
| 185 | // a little bit. Do this now. |
| 186 | // |
| 187 | PassManager Passes; |
| 188 | |
| 189 | // Add an appropriate TargetData instance for this module... |
| 190 | Passes.add(new TargetData("gccas", M.get())); |
| 191 | |
| 192 | // Add all of the transformation passes to the pass manager to do the cleanup |
| 193 | // and optimization of the GCC output. |
| 194 | // |
| 195 | AddConfiguredTransformationPasses(Passes); |
| 196 | |
| 197 | // Make sure everything is still good. |
| 198 | Passes.add(createVerifierPass()); |
| 199 | |
| 200 | // Write bytecode to file... |
| 201 | Passes.add(new WriteBytecodePass(Out,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 | std::cerr << argv[0] << ": " << msg << "\n"; |
| 210 | } catch (...) { |
| 211 | std::cerr << argv[0] << ": Unexpected unknown exception occurred.\n"; |
Chris Lattner | ecbde33 | 2001-10-31 04:28:11 +0000 | [diff] [blame] | 212 | } |
Reid Spencer | 1ef8bda | 2004-12-30 05:36:08 +0000 | [diff] [blame] | 213 | return 1; |
Chris Lattner | ecbde33 | 2001-10-31 04:28:11 +0000 | [diff] [blame] | 214 | } |