lib/CodeGen/LLVMTargetMachine.cpp

   1 //===-- LLVMTargetMachine.cpp - Implement the LLVMTargetMachine class -----===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This file implements the LLVMTargetMachine class.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #include "llvm/Target/TargetMachine.h"
  15 #include "llvm/PassManager.h"
  16 #include "llvm/Pass.h"
  17 #include "llvm/Analysis/Verifier.h"
  18 #include "llvm/Assembly/PrintModulePass.h"
  19 #include "llvm/CodeGen/AsmPrinter.h"
  20 #include "llvm/CodeGen/Passes.h"
  21 #include "llvm/CodeGen/FileWriters.h"
  22 #include "llvm/CodeGen/GCStrategy.h"
  23 #include "llvm/CodeGen/MachineFunctionAnalysis.h"
  24 #include "llvm/Target/TargetOptions.h"
  25 #include "llvm/MC/MCAsmInfo.h"
  26 #include "llvm/Target/TargetRegistry.h"
  27 #include "llvm/Transforms/Scalar.h"
  28 #include "llvm/Support/CommandLine.h"
  29 #include "llvm/Support/Debug.h"
  30 #include "llvm/Support/FormattedStream.h"
  31 using namespace llvm;
  32
  33 namespace llvm {
  34   bool EnableFastISel;
  35 }
  36
  37 static cl::opt<bool> DisablePostRA("disable-post-ra", cl::Hidden,
  38     cl::desc("Disable Post Regalloc"));
  39 static cl::opt<bool> DisableBranchFold("disable-branch-fold", cl::Hidden,
  40     cl::desc("Disable branch folding"));
  41 static cl::opt<bool> DisableTailDuplicate("disable-tail-duplicate", cl::Hidden,
  42     cl::desc("Disable tail duplication"));
  43 static cl::opt<bool> DisableEarlyTailDup("disable-early-taildup", cl::Hidden,
  44     cl::desc("Disable pre-register allocation tail duplication"));
  45 static cl::opt<bool> DisableCodePlace("disable-code-place", cl::Hidden,
  46     cl::desc("Disable code placement"));
  47 static cl::opt<bool> DisableSSC("disable-ssc", cl::Hidden,
  48     cl::desc("Disable Stack Slot Coloring"));
  49 static cl::opt<bool> DisableMachineLICM("disable-machine-licm", cl::Hidden,
  50     cl::desc("Disable Machine LICM"));
  51 static cl::opt<bool> DisableMachineSink("disable-machine-sink", cl::Hidden,
  52     cl::desc("Disable Machine Sinking"));
  53 static cl::opt<bool> DisableLSR("disable-lsr", cl::Hidden,
  54     cl::desc("Disable Loop Strength Reduction Pass"));
  55 static cl::opt<bool> DisableCGP("disable-cgp", cl::Hidden,
  56     cl::desc("Disable Codegen Prepare"));
  57 static cl::opt<bool> PrintLSR("print-lsr-output", cl::Hidden,
  58     cl::desc("Print LLVM IR produced by the loop-reduce pass"));
  59 static cl::opt<bool> PrintISelInput("print-isel-input", cl::Hidden,
  60     cl::desc("Print LLVM IR input to isel pass"));
  61 static cl::opt<bool> PrintEmittedAsm("print-emitted-asm", cl::Hidden,
  62     cl::desc("Dump emitter generated instructions as assembly"));
  63 static cl::opt<bool> PrintGCInfo("print-gc", cl::Hidden,
  64     cl::desc("Dump garbage collector data"));
  65 static cl::opt<bool> VerifyMachineCode("verify-machineinstrs", cl::Hidden,
  66     cl::desc("Verify generated machine code"),
  67     cl::init(getenv("LLVM_VERIFY_MACHINEINSTRS")!=NULL));
  68
  69
  70 // Enable or disable FastISel. Both options are needed, because
  71 // FastISel is enabled by default with -fast, and we wish to be
  72 // able to enable or disable fast-isel independently from -O0.
  73 static cl::opt<cl::boolOrDefault>
  74 EnableFastISelOption("fast-isel", cl::Hidden,
  75   cl::desc("Enable the \"fast\" instruction selector"));
  76
  77 // Enable or disable an experimental optimization to split GEPs
  78 // and run a special GVN pass which does not examine loads, in
  79 // an effort to factor out redundancy implicit in complex GEPs.
  80 static cl::opt<bool> EnableSplitGEPGVN("split-gep-gvn", cl::Hidden,
  81     cl::desc("Split GEPs and run no-load GVN"));
  82
  83 LLVMTargetMachine::LLVMTargetMachine(const Target &T,
  84                                      const std::string &TargetTriple)
  85   : TargetMachine(T) {
  86   AsmInfo = T.createAsmInfo(TargetTriple);
  87 }
  88
  89 // Set the default code model for the JIT for a generic target.
  90 // FIXME: Is small right here? or .is64Bit() ? Large : Small?
  91 void
  92 LLVMTargetMachine::setCodeModelForJIT() {
  93   setCodeModel(CodeModel::Small);
  94 }
  95
  96 // Set the default code model for static compilation for a generic target.
  97 void
  98 LLVMTargetMachine::setCodeModelForStatic() {
  99   setCodeModel(CodeModel::Small);
 100 }
 101
 102 FileModel::Model
 103 LLVMTargetMachine::addPassesToEmitFile(PassManagerBase &PM,
 104                                        formatted_raw_ostream &Out,
 105                                        CodeGenFileType FileType,
 106                                        CodeGenOpt::Level OptLevel) {
 107   // Add common CodeGen passes.
 108   if (addCommonCodeGenPasses(PM, OptLevel))
 109     return FileModel::Error;
 110
 111   switch (FileType) {
 112   default:
 113     break;
 114   case TargetMachine::AssemblyFile:
 115     if (addAssemblyEmitter(PM, OptLevel, getAsmVerbosityDefault(), Out))
 116       return FileModel::Error;
 117     return FileModel::AsmFile;
 118   case TargetMachine::ObjectFile:
 119     if (!addObjectFileEmitter(PM, OptLevel, Out))
 120       return FileModel::MachOFile;
 121     else if (getELFWriterInfo())
 122       return FileModel::ElfFile;
 123   }
 124   return FileModel::Error;
 125 }
 126
 127 bool LLVMTargetMachine::addAssemblyEmitter(PassManagerBase &PM,
 128                                            CodeGenOpt::Level OptLevel,
 129                                            bool Verbose,
 130                                            formatted_raw_ostream &Out) {
 131   FunctionPass *Printer =
 132     getTarget().createAsmPrinter(Out, *this, getMCAsmInfo(), Verbose);
 133   if (!Printer)
 134     return true;
 135
 136   PM.add(Printer);
 137   return false;
 138 }
 139
 140 bool LLVMTargetMachine::addObjectFileEmitter(PassManagerBase &PM,
 141                                              CodeGenOpt::Level OptLevel,
 142                                              formatted_raw_ostream &Out) {
 143   MCCodeEmitter *Emitter = getTarget().createCodeEmitter(*this);
 144   if (!Emitter)
 145     return true;
 146
 147   PM.add(createMachOWriter(Out, *this, getMCAsmInfo(), Emitter));
 148   return false;
 149 }
 150
 151 /// addPassesToEmitFileFinish - If the passes to emit the specified file had to
 152 /// be split up (e.g., to add an object writer pass), this method can be used to
 153 /// finish up adding passes to emit the file, if necessary.
 154 bool LLVMTargetMachine::addPassesToEmitFileFinish(PassManagerBase &PM,
 155                                                   MachineCodeEmitter *MCE,
 156                                                   CodeGenOpt::Level OptLevel) {
 157   // Make sure the code model is set.
 158   setCodeModelForStatic();
 159
 160   if (MCE)
 161     addSimpleCodeEmitter(PM, OptLevel, *MCE);
 162   if (PrintEmittedAsm)
 163     addAssemblyEmitter(PM, OptLevel, true, ferrs());
 164
 165   PM.add(createGCInfoDeleter());
 166
 167   return false; // success!
 168 }
 169
 170 /// addPassesToEmitFileFinish - If the passes to emit the specified file had to
 171 /// be split up (e.g., to add an object writer pass), this method can be used to
 172 /// finish up adding passes to emit the file, if necessary.
 173 bool LLVMTargetMachine::addPassesToEmitFileFinish(PassManagerBase &PM,
 174                                                   JITCodeEmitter *JCE,
 175                                                   CodeGenOpt::Level OptLevel) {
 176   // Make sure the code model is set.
 177   setCodeModelForJIT();
 178
 179   if (JCE)
 180     addSimpleCodeEmitter(PM, OptLevel, *JCE);
 181   if (PrintEmittedAsm)
 182     addAssemblyEmitter(PM, OptLevel, true, ferrs());
 183
 184   PM.add(createGCInfoDeleter());
 185
 186   return false; // success!
 187 }
 188
 189 /// addPassesToEmitFileFinish - If the passes to emit the specified file had to
 190 /// be split up (e.g., to add an object writer pass), this method can be used to
 191 /// finish up adding passes to emit the file, if necessary.
 192 bool LLVMTargetMachine::addPassesToEmitFileFinish(PassManagerBase &PM,
 193                                                   ObjectCodeEmitter *OCE,
 194                                                   CodeGenOpt::Level OptLevel) {
 195   // Make sure the code model is set.
 196   setCodeModelForStatic();
 197
 198   if (OCE)
 199     addSimpleCodeEmitter(PM, OptLevel, *OCE);
 200   if (PrintEmittedAsm)
 201     addAssemblyEmitter(PM, OptLevel, true, ferrs());
 202
 203   PM.add(createGCInfoDeleter());
 204
 205   return false; // success!
 206 }
 207
 208 /// addPassesToEmitMachineCode - Add passes to the specified pass manager to
 209 /// get machine code emitted.  This uses a MachineCodeEmitter object to handle
 210 /// actually outputting the machine code and resolving things like the address
 211 /// of functions.  This method should returns true if machine code emission is
 212 /// not supported.
 213 ///
 214 bool LLVMTargetMachine::addPassesToEmitMachineCode(PassManagerBase &PM,
 215                                                    MachineCodeEmitter &MCE,
 216                                                    CodeGenOpt::Level OptLevel) {
 217   // Make sure the code model is set.
 218   setCodeModelForJIT();
 219
 220   // Add common CodeGen passes.
 221   if (addCommonCodeGenPasses(PM, OptLevel))
 222     return true;
 223
 224   addCodeEmitter(PM, OptLevel, MCE);
 225   if (PrintEmittedAsm)
 226     addAssemblyEmitter(PM, OptLevel, true, ferrs());
 227
 228   PM.add(createGCInfoDeleter());
 229
 230   return false; // success!
 231 }
 232
 233 /// addPassesToEmitMachineCode - Add passes to the specified pass manager to
 234 /// get machine code emitted.  This uses a MachineCodeEmitter object to handle
 235 /// actually outputting the machine code and resolving things like the address
 236 /// of functions.  This method should returns true if machine code emission is
 237 /// not supported.
 238 ///
 239 bool LLVMTargetMachine::addPassesToEmitMachineCode(PassManagerBase &PM,
 240                                                    JITCodeEmitter &JCE,
 241                                                    CodeGenOpt::Level OptLevel) {
 242   // Make sure the code model is set.
 243   setCodeModelForJIT();
 244
 245   // Add common CodeGen passes.
 246   if (addCommonCodeGenPasses(PM, OptLevel))
 247     return true;
 248
 249   addCodeEmitter(PM, OptLevel, JCE);
 250   if (PrintEmittedAsm)
 251     addAssemblyEmitter(PM, OptLevel, true, ferrs());
 252
 253   PM.add(createGCInfoDeleter());
 254
 255   return false; // success!
 256 }
 257
 258 static void printAndVerify(PassManagerBase &PM,
 259                            const char *Banner,
 260                            bool allowDoubleDefs = false) {
 261   if (PrintMachineCode)
 262     PM.add(createMachineFunctionPrinterPass(dbgs(), Banner));
 263
 264   if (VerifyMachineCode)
 265     PM.add(createMachineVerifierPass(allowDoubleDefs));
 266 }
 267
 268 /// addCommonCodeGenPasses - Add standard LLVM codegen passes used for both
 269 /// emitting to assembly files or machine code output.
 270 ///
 271 bool LLVMTargetMachine::addCommonCodeGenPasses(PassManagerBase &PM,
 272                                                CodeGenOpt::Level OptLevel) {
 273   // Standard LLVM-Level Passes.
 274
 275   // Optionally, tun split-GEPs and no-load GVN.
 276   if (EnableSplitGEPGVN) {
 277     PM.add(createGEPSplitterPass());
 278     PM.add(createGVNPass(/*NoPRE=*/false, /*NoLoads=*/true));
 279   }
 280
 281   // Run loop strength reduction before anything else.
 282   if (OptLevel != CodeGenOpt::None && !DisableLSR) {
 283     PM.add(createLoopStrengthReducePass(getTargetLowering()));
 284     if (PrintLSR)
 285       PM.add(createPrintFunctionPass("\n\n*** Code after LSR ***\n", &dbgs()));
 286 #ifndef NDEBUG
 287     PM.add(createVerifierPass());
 288 #endif
 289   }
 290
 291   // Turn exception handling constructs into something the code generators can
 292   // handle.
 293   switch (getMCAsmInfo()->getExceptionHandlingType())
 294   {
 295   case ExceptionHandling::SjLj:
 296     // SjLj piggy-backs on dwarf for this bit. The cleanups done apply to both
 297     // Dwarf EH prepare needs to be run after SjLj prepare. Otherwise,
 298     // catch info can get misplaced when a selector ends up more than one block
 299     // removed from the parent invoke(s). This could happen when a landing
 300     // pad is shared by multiple invokes and is also a target of a normal
 301     // edge from elsewhere.
 302     PM.add(createSjLjEHPass(getTargetLowering()));
 303     PM.add(createDwarfEHPass(getTargetLowering(), OptLevel==CodeGenOpt::None));
 304     break;
 305   case ExceptionHandling::Dwarf:
 306     PM.add(createDwarfEHPass(getTargetLowering(), OptLevel==CodeGenOpt::None));
 307     break;
 308   case ExceptionHandling::None:
 309     PM.add(createLowerInvokePass(getTargetLowering()));
 310     break;
 311   }
 312
 313   PM.add(createGCLoweringPass());
 314
 315   // Make sure that no unreachable blocks are instruction selected.
 316   PM.add(createUnreachableBlockEliminationPass());
 317
 318   if (OptLevel != CodeGenOpt::None && !DisableCGP)
 319     PM.add(createCodeGenPreparePass(getTargetLowering()));
 320
 321   PM.add(createStackProtectorPass(getTargetLowering()));
 322
 323   if (PrintISelInput)
 324     PM.add(createPrintFunctionPass("\n\n"
 325                                    "*** Final LLVM Code input to ISel ***\n",
 326                                    &dbgs()));
 327
 328   // Standard Lower-Level Passes.
 329
 330   // Set up a MachineFunction for the rest of CodeGen to work on.
 331   PM.add(new MachineFunctionAnalysis(*this, OptLevel));
 332
 333   // Enable FastISel with -fast, but allow that to be overridden.
 334   if (EnableFastISelOption == cl::BOU_TRUE ||
 335       (OptLevel == CodeGenOpt::None && EnableFastISelOption != cl::BOU_FALSE))
 336     EnableFastISel = true;
 337
 338   // Ask the target for an isel.
 339   if (addInstSelector(PM, OptLevel))
 340     return true;
 341
 342   // Print the instruction selected machine code...
 343   printAndVerify(PM, "After Instruction Selection",
 344                  /* allowDoubleDefs= */ true);
 345
 346   if (OptLevel != CodeGenOpt::None) {
 347     PM.add(createOptimizeExtsPass());
 348     if (!DisableMachineLICM)
 349       PM.add(createMachineLICMPass());
 350     if (!DisableMachineSink)
 351       PM.add(createMachineSinkingPass());
 352     printAndVerify(PM, "After MachineLICM and MachineSinking",
 353                    /* allowDoubleDefs= */ true);
 354   }
 355
 356   // Pre-ra tail duplication.
 357   if (OptLevel != CodeGenOpt::None && !DisableEarlyTailDup) {
 358     PM.add(createTailDuplicatePass(true));
 359     printAndVerify(PM, "After Pre-RegAlloc TailDuplicate",
 360                    /* allowDoubleDefs= */ true);
 361   }
 362
 363   // Run pre-ra passes.
 364   if (addPreRegAlloc(PM, OptLevel))
 365     printAndVerify(PM, "After PreRegAlloc passes",
 366                    /* allowDoubleDefs= */ true);
 367
 368   // Perform register allocation.
 369   PM.add(createRegisterAllocator());
 370   printAndVerify(PM, "After Register Allocation");
 371
 372   // Perform stack slot coloring.
 373   if (OptLevel != CodeGenOpt::None && !DisableSSC) {
 374     // FIXME: Re-enable coloring with register when it's capable of adding
 375     // kill markers.
 376     PM.add(createStackSlotColoringPass(false));
 377     printAndVerify(PM, "After StackSlotColoring");
 378   }
 379
 380   // Run post-ra passes.
 381   if (addPostRegAlloc(PM, OptLevel))
 382     printAndVerify(PM, "After PostRegAlloc passes");
 383
 384   PM.add(createLowerSubregsPass());
 385   printAndVerify(PM, "After LowerSubregs");
 386
 387   // Insert prolog/epilog code.  Eliminate abstract frame index references...
 388   PM.add(createPrologEpilogCodeInserter());
 389   printAndVerify(PM, "After PrologEpilogCodeInserter");
 390
 391   // Run pre-sched2 passes.
 392   if (addPreSched2(PM, OptLevel))
 393     printAndVerify(PM, "After PreSched2 passes");
 394
 395   // Second pass scheduler.
 396   if (OptLevel != CodeGenOpt::None && !DisablePostRA) {
 397     PM.add(createPostRAScheduler(OptLevel));
 398     printAndVerify(PM, "After PostRAScheduler");
 399   }
 400
 401   // Branch folding must be run after regalloc and prolog/epilog insertion.
 402   if (OptLevel != CodeGenOpt::None && !DisableBranchFold) {
 403     PM.add(createBranchFoldingPass(getEnableTailMergeDefault()));
 404     printAndVerify(PM, "After BranchFolding");
 405   }
 406
 407   // Tail duplication.
 408   if (OptLevel != CodeGenOpt::None && !DisableTailDuplicate) {
 409     PM.add(createTailDuplicatePass(false));
 410     printAndVerify(PM, "After TailDuplicate");
 411   }
 412
 413   PM.add(createGCMachineCodeAnalysisPass());
 414
 415   if (PrintGCInfo)
 416     PM.add(createGCInfoPrinter(dbgs()));
 417
 418   if (OptLevel != CodeGenOpt::None && !DisableCodePlace) {
 419     PM.add(createCodePlacementOptPass());
 420     printAndVerify(PM, "After CodePlacementOpt");
 421   }
 422
 423   if (addPreEmitPass(PM, OptLevel))
 424     printAndVerify(PM, "After PreEmit passes");
 425
 426   return false;
 427 }