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/Analysis/Verifier.h"
  17 #include "llvm/Assembly/PrintModulePass.h"
  18 #include "llvm/CodeGen/AsmPrinter.h"
  19 #include "llvm/CodeGen/MachineFunctionAnalysis.h"
  20 #include "llvm/CodeGen/MachineModuleInfo.h"
  21 #include "llvm/CodeGen/GCStrategy.h"
  22 #include "llvm/CodeGen/Passes.h"
  23 #include "llvm/Target/TargetLowering.h"
  24 #include "llvm/Target/TargetOptions.h"
  25 #include "llvm/MC/MCAsmInfo.h"
  26 #include "llvm/MC/MCStreamer.h"
  27 #include "llvm/Target/TargetAsmInfo.h"
  28 #include "llvm/Target/TargetData.h"
  29 #include "llvm/Target/TargetRegistry.h"
  30 #include "llvm/Transforms/Scalar.h"
  31 #include "llvm/ADT/OwningPtr.h"
  32 #include "llvm/Support/CommandLine.h"
  33 #include "llvm/Support/Debug.h"
  34 #include "llvm/Support/FormattedStream.h"
  35 #include "llvm/Support/StandardPasses.h"
  36 using namespace llvm;
  37
  38 namespace llvm {
  39   bool EnableFastISel;
  40 }
  41
  42 static cl::opt<bool> DisablePostRA("disable-post-ra", cl::Hidden,
  43     cl::desc("Disable Post Regalloc"));
  44 static cl::opt<bool> DisableBranchFold("disable-branch-fold", cl::Hidden,
  45     cl::desc("Disable branch folding"));
  46 static cl::opt<bool> DisableTailDuplicate("disable-tail-duplicate", cl::Hidden,
  47     cl::desc("Disable tail duplication"));
  48 static cl::opt<bool> DisableEarlyTailDup("disable-early-taildup", cl::Hidden,
  49     cl::desc("Disable pre-register allocation tail duplication"));
  50 static cl::opt<bool> DisableCodePlace("disable-code-place", cl::Hidden,
  51     cl::desc("Disable code placement"));
  52 static cl::opt<bool> DisableSSC("disable-ssc", cl::Hidden,
  53     cl::desc("Disable Stack Slot Coloring"));
  54 static cl::opt<bool> DisableMachineLICM("disable-machine-licm", cl::Hidden,
  55     cl::desc("Disable Machine LICM"));
  56 static cl::opt<bool> DisablePostRAMachineLICM("disable-postra-machine-licm",
  57     cl::Hidden,
  58     cl::desc("Disable Machine LICM"));
  59 static cl::opt<bool> DisableMachineSink("disable-machine-sink", cl::Hidden,
  60     cl::desc("Disable Machine Sinking"));
  61 static cl::opt<bool> DisableLSR("disable-lsr", cl::Hidden,
  62     cl::desc("Disable Loop Strength Reduction Pass"));
  63 static cl::opt<bool> DisableCGP("disable-cgp", cl::Hidden,
  64     cl::desc("Disable Codegen Prepare"));
  65 static cl::opt<bool> PrintLSR("print-lsr-output", cl::Hidden,
  66     cl::desc("Print LLVM IR produced by the loop-reduce pass"));
  67 static cl::opt<bool> PrintISelInput("print-isel-input", cl::Hidden,
  68     cl::desc("Print LLVM IR input to isel pass"));
  69 static cl::opt<bool> PrintGCInfo("print-gc", cl::Hidden,
  70     cl::desc("Dump garbage collector data"));
  71 static cl::opt<bool> ShowMCEncoding("show-mc-encoding", cl::Hidden,
  72     cl::desc("Show encoding in .s output"));
  73 static cl::opt<bool> ShowMCInst("show-mc-inst", cl::Hidden,
  74     cl::desc("Show instruction structure in .s output"));
  75 static cl::opt<bool> EnableMCLogging("enable-mc-api-logging", cl::Hidden,
  76     cl::desc("Enable MC API logging"));
  77 static cl::opt<bool> VerifyMachineCode("verify-machineinstrs", cl::Hidden,
  78     cl::desc("Verify generated machine code"),
  79     cl::init(getenv("LLVM_VERIFY_MACHINEINSTRS")!=NULL));
  80
  81 static cl::opt<cl::boolOrDefault>
  82 AsmVerbose("asm-verbose", cl::desc("Add comments to directives."),
  83            cl::init(cl::BOU_UNSET));
  84
  85 static bool getVerboseAsm() {
  86   switch (AsmVerbose) {
  87   default:
  88   case cl::BOU_UNSET: return TargetMachine::getAsmVerbosityDefault();
  89   case cl::BOU_TRUE:  return true;
  90   case cl::BOU_FALSE: return false;
  91   }
  92 }
  93
  94 // Enable or disable FastISel. Both options are needed, because
  95 // FastISel is enabled by default with -fast, and we wish to be
  96 // able to enable or disable fast-isel independently from -O0.
  97 static cl::opt<cl::boolOrDefault>
  98 EnableFastISelOption("fast-isel", cl::Hidden,
  99   cl::desc("Enable the \"fast\" instruction selector"));
 100
 101 LLVMTargetMachine::LLVMTargetMachine(const Target &T,
 102                                      const std::string &Triple)
 103   : TargetMachine(T), TargetTriple(Triple) {
 104   AsmInfo = T.createAsmInfo(TargetTriple);
 105 }
 106
 107 // Set the default code model for the JIT for a generic target.
 108 // FIXME: Is small right here? or .is64Bit() ? Large : Small?
 109 void LLVMTargetMachine::setCodeModelForJIT() {
 110   setCodeModel(CodeModel::Small);
 111 }
 112
 113 // Set the default code model for static compilation for a generic target.
 114 void LLVMTargetMachine::setCodeModelForStatic() {
 115   setCodeModel(CodeModel::Small);
 116 }
 117
 118 bool LLVMTargetMachine::addPassesToEmitFile(PassManagerBase &PM,
 119                                             formatted_raw_ostream &Out,
 120                                             CodeGenFileType FileType,
 121                                             CodeGenOpt::Level OptLevel,
 122                                             bool DisableVerify) {
 123   // Add common CodeGen passes.
 124   MCContext *Context = 0;
 125   if (addCommonCodeGenPasses(PM, OptLevel, DisableVerify, Context))
 126     return true;
 127   assert(Context != 0 && "Failed to get MCContext");
 128
 129   const MCAsmInfo &MAI = *getMCAsmInfo();
 130   OwningPtr<MCStreamer> AsmStreamer;
 131
 132   switch (FileType) {
 133   default: return true;
 134   case CGFT_AssemblyFile: {
 135     MCInstPrinter *InstPrinter =
 136       getTarget().createMCInstPrinter(MAI.getAssemblerDialect(), MAI);
 137
 138     // Create a code emitter if asked to show the encoding.
 139     MCCodeEmitter *MCE = 0;
 140     TargetAsmBackend *TAB = 0;
 141     if (ShowMCEncoding) {
 142       MCE = getTarget().createCodeEmitter(*this, *Context);
 143       TAB = getTarget().createAsmBackend(TargetTriple);
 144     }
 145
 146     MCStreamer *S = getTarget().createAsmStreamer(*Context, Out,
 147                                                   getVerboseAsm(),
 148                                                   hasMCUseLoc(),
 149                                                   InstPrinter,
 150                                                   MCE, TAB,
 151                                                   ShowMCInst);
 152     AsmStreamer.reset(S);
 153     break;
 154   }
 155   case CGFT_ObjectFile: {
 156     // Create the code emitter for the target if it exists.  If not, .o file
 157     // emission fails.
 158     MCCodeEmitter *MCE = getTarget().createCodeEmitter(*this, *Context);
 159     TargetAsmBackend *TAB = getTarget().createAsmBackend(TargetTriple);
 160     if (MCE == 0 || TAB == 0)
 161       return true;
 162
 163     AsmStreamer.reset(getTarget().createObjectStreamer(TargetTriple, *Context,
 164                                                        *TAB, Out, MCE,
 165                                                        hasMCRelaxAll(),
 166                                                        hasMCNoExecStack()));
 167     AsmStreamer.get()->InitSections();
 168     break;
 169   }
 170   case CGFT_Null:
 171     // The Null output is intended for use for performance analysis and testing,
 172     // not real users.
 173     AsmStreamer.reset(createNullStreamer(*Context));
 174     break;
 175   }
 176
 177   if (EnableMCLogging)
 178     AsmStreamer.reset(createLoggingStreamer(AsmStreamer.take(), errs()));
 179
 180   // Create the AsmPrinter, which takes ownership of AsmStreamer if successful.
 181   FunctionPass *Printer = getTarget().createAsmPrinter(*this, *AsmStreamer);
 182   if (Printer == 0)
 183     return true;
 184
 185   // If successful, createAsmPrinter took ownership of AsmStreamer.
 186   AsmStreamer.take();
 187
 188   PM.add(Printer);
 189
 190   // Make sure the code model is set.
 191   setCodeModelForStatic();
 192   PM.add(createGCInfoDeleter());
 193   return false;
 194 }
 195
 196 /// addPassesToEmitMachineCode - Add passes to the specified pass manager to
 197 /// get machine code emitted.  This uses a JITCodeEmitter object to handle
 198 /// actually outputting the machine code and resolving things like the address
 199 /// of functions.  This method should returns true if machine code emission is
 200 /// not supported.
 201 ///
 202 bool LLVMTargetMachine::addPassesToEmitMachineCode(PassManagerBase &PM,
 203                                                    JITCodeEmitter &JCE,
 204                                                    CodeGenOpt::Level OptLevel,
 205                                                    bool DisableVerify) {
 206   // Make sure the code model is set.
 207   setCodeModelForJIT();
 208
 209   // Add common CodeGen passes.
 210   MCContext *Ctx = 0;
 211   if (addCommonCodeGenPasses(PM, OptLevel, DisableVerify, Ctx))
 212     return true;
 213
 214   addCodeEmitter(PM, OptLevel, JCE);
 215   PM.add(createGCInfoDeleter());
 216
 217   return false; // success!
 218 }
 219
 220 /// addPassesToEmitMC - Add passes to the specified pass manager to get
 221 /// machine code emitted with the MCJIT. This method returns true if machine
 222 /// code is not supported. It fills the MCContext Ctx pointer which can be
 223 /// used to build custom MCStreamer.
 224 ///
 225 bool LLVMTargetMachine::addPassesToEmitMC(PassManagerBase &PM,
 226                                           MCContext *&Ctx,
 227                                           CodeGenOpt::Level OptLevel,
 228                                           bool DisableVerify) {
 229   // Add common CodeGen passes.
 230   if (addCommonCodeGenPasses(PM, OptLevel, DisableVerify, Ctx))
 231     return true;
 232   // Make sure the code model is set.
 233   setCodeModelForJIT();
 234
 235   return false; // success!
 236 }
 237
 238 static void printNoVerify(PassManagerBase &PM, const char *Banner) {
 239   if (PrintMachineCode)
 240     PM.add(createMachineFunctionPrinterPass(dbgs(), Banner));
 241 }
 242
 243 static void printAndVerify(PassManagerBase &PM,
 244                            const char *Banner) {
 245   if (PrintMachineCode)
 246     PM.add(createMachineFunctionPrinterPass(dbgs(), Banner));
 247
 248   if (VerifyMachineCode)
 249     PM.add(createMachineVerifierPass(Banner));
 250 }
 251
 252 /// addCommonCodeGenPasses - Add standard LLVM codegen passes used for both
 253 /// emitting to assembly files or machine code output.
 254 ///
 255 bool LLVMTargetMachine::addCommonCodeGenPasses(PassManagerBase &PM,
 256                                                CodeGenOpt::Level OptLevel,
 257                                                bool DisableVerify,
 258                                                MCContext *&OutContext) {
 259   // Standard LLVM-Level Passes.
 260
 261   // Basic AliasAnalysis support.
 262   createStandardAliasAnalysisPasses(&PM);
 263
 264   // Before running any passes, run the verifier to determine if the input
 265   // coming from the front-end and/or optimizer is valid.
 266   if (!DisableVerify)
 267     PM.add(createVerifierPass());
 268
 269   // Run loop strength reduction before anything else.
 270   if (OptLevel != CodeGenOpt::None && !DisableLSR) {
 271     PM.add(createLoopStrengthReducePass(getTargetLowering()));
 272     if (PrintLSR)
 273       PM.add(createPrintFunctionPass("\n\n*** Code after LSR ***\n", &dbgs()));
 274   }
 275
 276   PM.add(createGCLoweringPass());
 277
 278   // Make sure that no unreachable blocks are instruction selected.
 279   PM.add(createUnreachableBlockEliminationPass());
 280
 281   // Turn exception handling constructs into something the code generators can
 282   // handle.
 283   switch (getMCAsmInfo()->getExceptionHandlingType()) {
 284   case ExceptionHandling::SjLj:
 285     // SjLj piggy-backs on dwarf for this bit. The cleanups done apply to both
 286     // Dwarf EH prepare needs to be run after SjLj prepare. Otherwise,
 287     // catch info can get misplaced when a selector ends up more than one block
 288     // removed from the parent invoke(s). This could happen when a landing
 289     // pad is shared by multiple invokes and is also a target of a normal
 290     // edge from elsewhere.
 291     PM.add(createSjLjEHPass(getTargetLowering()));
 292     // FALLTHROUGH
 293   case ExceptionHandling::DwarfCFI:
 294   case ExceptionHandling::DwarfTable:
 295     PM.add(createDwarfEHPass(this));
 296     break;
 297   case ExceptionHandling::None:
 298     PM.add(createLowerInvokePass(getTargetLowering()));
 299
 300     // The lower invoke pass may create unreachable code. Remove it.
 301     PM.add(createUnreachableBlockEliminationPass());
 302     break;
 303   }
 304
 305   if (OptLevel != CodeGenOpt::None && !DisableCGP)
 306     PM.add(createCodeGenPreparePass(getTargetLowering()));
 307
 308   PM.add(createStackProtectorPass(getTargetLowering()));
 309
 310   addPreISel(PM, OptLevel);
 311
 312   if (PrintISelInput)
 313     PM.add(createPrintFunctionPass("\n\n"
 314                                    "*** Final LLVM Code input to ISel ***\n",
 315                                    &dbgs()));
 316
 317   // All passes which modify the LLVM IR are now complete; run the verifier
 318   // to ensure that the IR is valid.
 319   if (!DisableVerify)
 320     PM.add(createVerifierPass());
 321
 322   // Standard Lower-Level Passes.
 323
 324   // Install a MachineModuleInfo class, which is an immutable pass that holds
 325   // all the per-module stuff we're generating, including MCContext.
 326   TargetAsmInfo *TAI = new TargetAsmInfo(*this);
 327   MachineModuleInfo *MMI = new MachineModuleInfo(*getMCAsmInfo(), TAI);
 328   PM.add(MMI);
 329   OutContext = &MMI->getContext(); // Return the MCContext specifically by-ref.
 330
 331   // Set up a MachineFunction for the rest of CodeGen to work on.
 332   PM.add(new MachineFunctionAnalysis(*this, OptLevel));
 333
 334   // Enable FastISel with -fast, but allow that to be overridden.
 335   if (EnableFastISelOption == cl::BOU_TRUE ||
 336       (OptLevel == CodeGenOpt::None && EnableFastISelOption != cl::BOU_FALSE))
 337     EnableFastISel = true;
 338
 339   // Ask the target for an isel.
 340   if (addInstSelector(PM, OptLevel))
 341     return true;
 342
 343   // Print the instruction selected machine code...
 344   printAndVerify(PM, "After Instruction Selection");
 345
 346   // Expand pseudo-instructions emitted by ISel.
 347   PM.add(createExpandISelPseudosPass());
 348
 349   // Optimize PHIs before DCE: removing dead PHI cycles may make more
 350   // instructions dead.
 351   if (OptLevel != CodeGenOpt::None)
 352     PM.add(createOptimizePHIsPass());
 353
 354   // If the target requests it, assign local variables to stack slots relative
 355   // to one another and simplify frame index references where possible.
 356   PM.add(createLocalStackSlotAllocationPass());
 357
 358   if (OptLevel != CodeGenOpt::None) {
 359     // With optimization, dead code should already be eliminated. However
 360     // there is one known exception: lowered code for arguments that are only
 361     // used by tail calls, where the tail calls reuse the incoming stack
 362     // arguments directly (see t11 in test/CodeGen/X86/sibcall.ll).
 363     PM.add(createDeadMachineInstructionElimPass());
 364     printAndVerify(PM, "After codegen DCE pass");
 365
 366     if (!DisableMachineLICM)
 367       PM.add(createMachineLICMPass());
 368     PM.add(createMachineCSEPass());
 369     if (!DisableMachineSink)
 370       PM.add(createMachineSinkingPass());
 371     printAndVerify(PM, "After Machine LICM, CSE and Sinking passes");
 372
 373     PM.add(createPeepholeOptimizerPass());
 374     printAndVerify(PM, "After codegen peephole optimization pass");
 375   }
 376
 377   // Pre-ra tail duplication.
 378   if (OptLevel != CodeGenOpt::None && !DisableEarlyTailDup) {
 379     PM.add(createTailDuplicatePass(true));
 380     printAndVerify(PM, "After Pre-RegAlloc TailDuplicate");
 381   }
 382
 383   // Run pre-ra passes.
 384   if (addPreRegAlloc(PM, OptLevel))
 385     printAndVerify(PM, "After PreRegAlloc passes");
 386
 387   // Perform register allocation.
 388   PM.add(createRegisterAllocator(OptLevel));
 389   printAndVerify(PM, "After Register Allocation");
 390
 391   // Perform stack slot coloring and post-ra machine LICM.
 392   if (OptLevel != CodeGenOpt::None) {
 393     // FIXME: Re-enable coloring with register when it's capable of adding
 394     // kill markers.
 395     if (!DisableSSC)
 396       PM.add(createStackSlotColoringPass(false));
 397
 398     // Run post-ra machine LICM to hoist reloads / remats.
 399     if (!DisablePostRAMachineLICM)
 400       PM.add(createMachineLICMPass(false));
 401
 402     printAndVerify(PM, "After StackSlotColoring and postra Machine LICM");
 403   }
 404
 405   // Run post-ra passes.
 406   if (addPostRegAlloc(PM, OptLevel))
 407     printAndVerify(PM, "After PostRegAlloc passes");
 408
 409   PM.add(createLowerSubregsPass());
 410   printAndVerify(PM, "After LowerSubregs");
 411
 412   // Insert prolog/epilog code.  Eliminate abstract frame index references...
 413   PM.add(createPrologEpilogCodeInserter());
 414   printAndVerify(PM, "After PrologEpilogCodeInserter");
 415
 416   // Run pre-sched2 passes.
 417   if (addPreSched2(PM, OptLevel))
 418     printAndVerify(PM, "After PreSched2 passes");
 419
 420   // Second pass scheduler.
 421   if (OptLevel != CodeGenOpt::None && !DisablePostRA) {
 422     PM.add(createPostRAScheduler(OptLevel));
 423     printAndVerify(PM, "After PostRAScheduler");
 424   }
 425
 426   // Branch folding must be run after regalloc and prolog/epilog insertion.
 427   if (OptLevel != CodeGenOpt::None && !DisableBranchFold) {
 428     PM.add(createBranchFoldingPass(getEnableTailMergeDefault()));
 429     printNoVerify(PM, "After BranchFolding");
 430   }
 431
 432   // Tail duplication.
 433   if (OptLevel != CodeGenOpt::None && !DisableTailDuplicate) {
 434     PM.add(createTailDuplicatePass(false));
 435     printNoVerify(PM, "After TailDuplicate");
 436   }
 437
 438   PM.add(createGCMachineCodeAnalysisPass());
 439
 440   if (PrintGCInfo)
 441     PM.add(createGCInfoPrinter(dbgs()));
 442
 443   if (OptLevel != CodeGenOpt::None && !DisableCodePlace) {
 444     PM.add(createCodePlacementOptPass());
 445     printNoVerify(PM, "After CodePlacementOpt");
 446   }
 447
 448   if (addPreEmitPass(PM, OptLevel))
 449     printNoVerify(PM, "After PreEmit passes");
 450
 451   return false;
 452 }