tools/llc/llc.cpp

   1 //===-- llc.cpp - Implement the LLVM Native Code Generator ----------------===//
   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 is the llc code generator driver. It provides a convenient
  11 // command-line interface for generating native assembly-language code
  12 // or C code, given LLVM bitcode.
  13 //
  14 //===----------------------------------------------------------------------===//
  15
  16
  17 #include "llvm/ADT/Triple.h"
  18 #include "llvm/CodeGen/CommandFlags.h"
  19 #include "llvm/CodeGen/LinkAllAsmWriterComponents.h"
  20 #include "llvm/CodeGen/LinkAllCodegenComponents.h"
  21 #include "llvm/IR/DataLayout.h"
  22 #include "llvm/IR/IRPrintingPasses.h"
  23 #include "llvm/IR/LLVMContext.h"
  24 #include "llvm/IR/Module.h"
  25 #include "llvm/IRReader/IRReader.h"
  26 #include "llvm/MC/SubtargetFeature.h"
  27 #include "llvm/Pass.h"
  28 #include "llvm/PassManager.h"
  29 #include "llvm/Support/CommandLine.h"
  30 #include "llvm/Support/Debug.h"
  31 #include "llvm/Support/FileSystem.h"
  32 #include "llvm/Support/FormattedStream.h"
  33 #include "llvm/Support/Host.h"
  34 #include "llvm/Support/ManagedStatic.h"
  35 #include "llvm/Support/PluginLoader.h"
  36 #include "llvm/Support/PrettyStackTrace.h"
  37 #include "llvm/Support/Signals.h"
  38 #include "llvm/Support/SourceMgr.h"
  39 #include "llvm/Support/TargetRegistry.h"
  40 #include "llvm/Support/TargetSelect.h"
  41 #include "llvm/Support/ToolOutputFile.h"
  42 #include "llvm/Target/TargetLibraryInfo.h"
  43 #include "llvm/Target/TargetMachine.h"
  44 #include "llvm/Target/TargetSubtargetInfo.h"
  45 #include <memory>
  46 using namespace llvm;
  47
  48 // General options for llc.  Other pass-specific options are specified
  49 // within the corresponding llc passes, and target-specific options
  50 // and back-end code generation options are specified with the target machine.
  51 //
  52 static cl::opt<std::string>
  53 InputFilename(cl::Positional, cl::desc("<input bitcode>"), cl::init("-"));
  54
  55 static cl::opt<std::string>
  56 OutputFilename("o", cl::desc("Output filename"), cl::value_desc("filename"));
  57
  58 static cl::opt<unsigned>
  59 TimeCompilations("time-compilations", cl::Hidden, cl::init(1u),
  60                  cl::value_desc("N"),
  61                  cl::desc("Repeat compilation N times for timing"));
  62
  63 static cl::opt<bool>
  64 NoIntegratedAssembler("no-integrated-as", cl::Hidden,
  65                       cl::desc("Disable integrated assembler"));
  66
  67 // Determine optimization level.
  68 static cl::opt<char>
  69 OptLevel("O",
  70          cl::desc("Optimization level. [-O0, -O1, -O2, or -O3] "
  71                   "(default = '-O2')"),
  72          cl::Prefix,
  73          cl::ZeroOrMore,
  74          cl::init(' '));
  75
  76 static cl::opt<std::string>
  77 TargetTriple("mtriple", cl::desc("Override target triple for module"));
  78
  79 static cl::opt<bool> NoVerify("disable-verify", cl::Hidden,
  80                               cl::desc("Do not verify input module"));
  81
  82 static cl::opt<bool> DisableSimplifyLibCalls("disable-simplify-libcalls",
  83                                              cl::desc("Disable simplify-libcalls"));
  84
  85 static cl::opt<bool> ShowMCEncoding("show-mc-encoding", cl::Hidden,
  86                                     cl::desc("Show encoding in .s output"));
  87
  88 static cl::opt<bool> EnableDwarfDirectory(
  89     "enable-dwarf-directory", cl::Hidden,
  90     cl::desc("Use .file directives with an explicit directory."));
  91
  92 static cl::opt<bool> AsmVerbose("asm-verbose",
  93                                 cl::desc("Add comments to directives."),
  94                                 cl::init(true));
  95
  96 static int compileModule(char **, LLVMContext &);
  97
  98 // GetFileNameRoot - Helper function to get the basename of a filename.
  99 static inline std::string
 100 GetFileNameRoot(const std::string &InputFilename) {
 101   std::string IFN = InputFilename;
 102   std::string outputFilename;
 103   int Len = IFN.length();
 104   if ((Len > 2) &&
 105       IFN[Len-3] == '.' &&
 106       ((IFN[Len-2] == 'b' && IFN[Len-1] == 'c') ||
 107        (IFN[Len-2] == 'l' && IFN[Len-1] == 'l'))) {
 108     outputFilename = std::string(IFN.begin(), IFN.end()-3); // s/.bc/.s/
 109   } else {
 110     outputFilename = IFN;
 111   }
 112   return outputFilename;
 113 }
 114
 115 static tool_output_file *GetOutputStream(const char *TargetName,
 116                                          Triple::OSType OS,
 117                                          const char *ProgName) {
 118   // If we don't yet have an output filename, make one.
 119   if (OutputFilename.empty()) {
 120     if (InputFilename == "-")
 121       OutputFilename = "-";
 122     else {
 123       OutputFilename = GetFileNameRoot(InputFilename);
 124
 125       switch (FileType) {
 126       case TargetMachine::CGFT_AssemblyFile:
 127         if (TargetName[0] == 'c') {
 128           if (TargetName[1] == 0)
 129             OutputFilename += ".cbe.c";
 130           else if (TargetName[1] == 'p' && TargetName[2] == 'p')
 131             OutputFilename += ".cpp";
 132           else
 133             OutputFilename += ".s";
 134         } else
 135           OutputFilename += ".s";
 136         break;
 137       case TargetMachine::CGFT_ObjectFile:
 138         if (OS == Triple::Win32)
 139           OutputFilename += ".obj";
 140         else
 141           OutputFilename += ".o";
 142         break;
 143       case TargetMachine::CGFT_Null:
 144         OutputFilename += ".null";
 145         break;
 146       }
 147     }
 148   }
 149
 150   // Decide if we need "binary" output.
 151   bool Binary = false;
 152   switch (FileType) {
 153   case TargetMachine::CGFT_AssemblyFile:
 154     break;
 155   case TargetMachine::CGFT_ObjectFile:
 156   case TargetMachine::CGFT_Null:
 157     Binary = true;
 158     break;
 159   }
 160
 161   // Open the file.
 162   std::error_code EC;
 163   sys::fs::OpenFlags OpenFlags = sys::fs::F_None;
 164   if (!Binary)
 165     OpenFlags |= sys::fs::F_Text;
 166   tool_output_file *FDOut = new tool_output_file(OutputFilename, EC, OpenFlags);
 167   if (EC) {
 168     errs() << EC.message() << '\n';
 169     delete FDOut;
 170     return nullptr;
 171   }
 172
 173   return FDOut;
 174 }
 175
 176 // main - Entry point for the llc compiler.
 177 //
 178 int main(int argc, char **argv) {
 179   sys::PrintStackTraceOnErrorSignal();
 180   PrettyStackTraceProgram X(argc, argv);
 181
 182   // Enable debug stream buffering.
 183   EnableDebugBuffering = true;
 184
 185   LLVMContext &Context = getGlobalContext();
 186   llvm_shutdown_obj Y;  // Call llvm_shutdown() on exit.
 187
 188   // Initialize targets first, so that --version shows registered targets.
 189   InitializeAllTargets();
 190   InitializeAllTargetMCs();
 191   InitializeAllAsmPrinters();
 192   InitializeAllAsmParsers();
 193
 194   // Initialize codegen and IR passes used by llc so that the -print-after,
 195   // -print-before, and -stop-after options work.
 196   PassRegistry *Registry = PassRegistry::getPassRegistry();
 197   initializeCore(*Registry);
 198   initializeCodeGen(*Registry);
 199   initializeLoopStrengthReducePass(*Registry);
 200   initializeLowerIntrinsicsPass(*Registry);
 201   initializeUnreachableBlockElimPass(*Registry);
 202
 203   // Register the target printer for --version.
 204   cl::AddExtraVersionPrinter(TargetRegistry::printRegisteredTargetsForVersion);
 205
 206   cl::ParseCommandLineOptions(argc, argv, "llvm system compiler\n");
 207
 208   // Compile the module TimeCompilations times to give better compile time
 209   // metrics.
 210   for (unsigned I = TimeCompilations; I; --I)
 211     if (int RetVal = compileModule(argv, Context))
 212       return RetVal;
 213   return 0;
 214 }
 215
 216 static int compileModule(char **argv, LLVMContext &Context) {
 217   // Load the module to be compiled...
 218   SMDiagnostic Err;
 219   std::unique_ptr<Module> M;
 220   Module *mod = nullptr;
 221   Triple TheTriple;
 222
 223   bool SkipModule = MCPU == "help" ||
 224                     (!MAttrs.empty() && MAttrs.front() == "help");
 225
 226   // If user asked for the 'native' CPU, autodetect here. If autodection fails,
 227   // this will set the CPU to an empty string which tells the target to
 228   // pick a basic default.
 229   if (MCPU == "native")
 230     MCPU = sys::getHostCPUName();
 231
 232   // If user just wants to list available options, skip module loading
 233   if (!SkipModule) {
 234     M.reset(ParseIRFile(InputFilename, Err, Context));
 235     mod = M.get();
 236     if (mod == nullptr) {
 237       Err.print(argv[0], errs());
 238       return 1;
 239     }
 240
 241     // If we are supposed to override the target triple, do so now.
 242     if (!TargetTriple.empty())
 243       mod->setTargetTriple(Triple::normalize(TargetTriple));
 244     TheTriple = Triple(mod->getTargetTriple());
 245   } else {
 246     TheTriple = Triple(Triple::normalize(TargetTriple));
 247   }
 248
 249   if (TheTriple.getTriple().empty())
 250     TheTriple.setTriple(sys::getDefaultTargetTriple());
 251
 252   // Get the target specific parser.
 253   std::string Error;
 254   const Target *TheTarget = TargetRegistry::lookupTarget(MArch, TheTriple,
 255                                                          Error);
 256   if (!TheTarget) {
 257     errs() << argv[0] << ": " << Error;
 258     return 1;
 259   }
 260
 261   // Package up features to be passed to target/subtarget
 262   std::string FeaturesStr;
 263   if (MAttrs.size()) {
 264     SubtargetFeatures Features;
 265     for (unsigned i = 0; i != MAttrs.size(); ++i)
 266       Features.AddFeature(MAttrs[i]);
 267     FeaturesStr = Features.getString();
 268   }
 269
 270   CodeGenOpt::Level OLvl = CodeGenOpt::Default;
 271   switch (OptLevel) {
 272   default:
 273     errs() << argv[0] << ": invalid optimization level.\n";
 274     return 1;
 275   case ' ': break;
 276   case '0': OLvl = CodeGenOpt::None; break;
 277   case '1': OLvl = CodeGenOpt::Less; break;
 278   case '2': OLvl = CodeGenOpt::Default; break;
 279   case '3': OLvl = CodeGenOpt::Aggressive; break;
 280   }
 281
 282   TargetOptions Options = InitTargetOptionsFromCodeGenFlags();
 283   Options.DisableIntegratedAS = NoIntegratedAssembler;
 284   Options.MCOptions.ShowMCEncoding = ShowMCEncoding;
 285   Options.MCOptions.MCUseDwarfDirectory = EnableDwarfDirectory;
 286   Options.MCOptions.AsmVerbose = AsmVerbose;
 287
 288   std::unique_ptr<TargetMachine> target(
 289       TheTarget->createTargetMachine(TheTriple.getTriple(), MCPU, FeaturesStr,
 290                                      Options, RelocModel, CMModel, OLvl));
 291   assert(target.get() && "Could not allocate target machine!");
 292
 293   // If we don't have a module then just exit now. We do this down
 294   // here since the CPU/Feature help is underneath the target machine
 295   // creation.
 296   if (SkipModule)
 297     return 0;
 298
 299   assert(mod && "Should have exited if we didn't have a module!");
 300   TargetMachine &Target = *target.get();
 301
 302   if (GenerateSoftFloatCalls)
 303     FloatABIForCalls = FloatABI::Soft;
 304
 305   // Figure out where we are going to send the output.
 306   std::unique_ptr<tool_output_file> Out(
 307       GetOutputStream(TheTarget->getName(), TheTriple.getOS(), argv[0]));
 308   if (!Out) return 1;
 309
 310   // Build up all of the passes that we want to do to the module.
 311   PassManager PM;
 312
 313   // Add an appropriate TargetLibraryInfo pass for the module's triple.
 314   TargetLibraryInfo *TLI = new TargetLibraryInfo(TheTriple);
 315   if (DisableSimplifyLibCalls)
 316     TLI->disableAllFunctions();
 317   PM.add(TLI);
 318
 319   // Add the target data from the target machine, if it exists, or the module.
 320   if (const DataLayout *DL = Target.getSubtargetImpl()->getDataLayout())
 321     mod->setDataLayout(DL);
 322   PM.add(new DataLayoutPass(mod));
 323
 324   if (RelaxAll.getNumOccurrences() > 0 &&
 325       FileType != TargetMachine::CGFT_ObjectFile)
 326     errs() << argv[0]
 327              << ": warning: ignoring -mc-relax-all because filetype != obj";
 328
 329   {
 330     formatted_raw_ostream FOS(Out->os());
 331
 332     AnalysisID StartAfterID = nullptr;
 333     AnalysisID StopAfterID = nullptr;
 334     const PassRegistry *PR = PassRegistry::getPassRegistry();
 335     if (!StartAfter.empty()) {
 336       const PassInfo *PI = PR->getPassInfo(StartAfter);
 337       if (!PI) {
 338         errs() << argv[0] << ": start-after pass is not registered.\n";
 339         return 1;
 340       }
 341       StartAfterID = PI->getTypeInfo();
 342     }
 343     if (!StopAfter.empty()) {
 344       const PassInfo *PI = PR->getPassInfo(StopAfter);
 345       if (!PI) {
 346         errs() << argv[0] << ": stop-after pass is not registered.\n";
 347         return 1;
 348       }
 349       StopAfterID = PI->getTypeInfo();
 350     }
 351
 352     // Ask the target to add backend passes as necessary.
 353     if (Target.addPassesToEmitFile(PM, FOS, FileType, NoVerify,
 354                                    StartAfterID, StopAfterID)) {
 355       errs() << argv[0] << ": target does not support generation of this"
 356              << " file type!\n";
 357       return 1;
 358     }
 359
 360     // Before executing passes, print the final values of the LLVM options.
 361     cl::PrintOptionValues();
 362
 363     PM.run(*mod);
 364   }
 365
 366   // Declare success.
 367   Out->keep();
 368
 369   return 0;
 370 }