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 #include "llvm/LLVMContext.h"
  17 #include "llvm/Module.h"
  18 #include "llvm/PassManager.h"
  19 #include "llvm/Pass.h"
  20 #include "llvm/ADT/Triple.h"
  21 #include "llvm/Analysis/Verifier.h"
  22 #include "llvm/Support/IRReader.h"
  23 #include "llvm/CodeGen/LinkAllAsmWriterComponents.h"
  24 #include "llvm/CodeGen/LinkAllCodegenComponents.h"
  25 #include "llvm/Config/config.h"
  26 #include "llvm/Support/CommandLine.h"
  27 #include "llvm/Support/Debug.h"
  28 #include "llvm/Support/FormattedStream.h"
  29 #include "llvm/Support/ManagedStatic.h"
  30 #include "llvm/Support/PluginLoader.h"
  31 #include "llvm/Support/PrettyStackTrace.h"
  32 #include "llvm/System/Host.h"
  33 #include "llvm/System/Signals.h"
  34 #include "llvm/Target/SubtargetFeature.h"
  35 #include "llvm/Target/TargetData.h"
  36 #include "llvm/Target/TargetMachine.h"
  37 #include "llvm/Target/TargetRegistry.h"
  38 #include "llvm/Target/TargetSelect.h"
  39 #include <memory>
  40 using namespace llvm;
  41
  42 // General options for llc.  Other pass-specific options are specified
  43 // within the corresponding llc passes, and target-specific options
  44 // and back-end code generation options are specified with the target machine.
  45 //
  46 static cl::opt<std::string>
  47 InputFilename(cl::Positional, cl::desc("<input bitcode>"), cl::init("-"));
  48
  49 static cl::opt<std::string>
  50 OutputFilename("o", cl::desc("Output filename"), cl::value_desc("filename"));
  51
  52 // Determine optimization level.
  53 static cl::opt<char>
  54 OptLevel("O",
  55          cl::desc("Optimization level. [-O0, -O1, -O2, or -O3] "
  56                   "(default = '-O2')"),
  57          cl::Prefix,
  58          cl::ZeroOrMore,
  59          cl::init(' '));
  60
  61 static cl::opt<std::string>
  62 TargetTriple("mtriple", cl::desc("Override target triple for module"));
  63
  64 static cl::opt<std::string>
  65 MArch("march", cl::desc("Architecture to generate code for (see --version)"));
  66
  67 static cl::opt<std::string>
  68 MCPU("mcpu",
  69   cl::desc("Target a specific cpu type (-mcpu=help for details)"),
  70   cl::value_desc("cpu-name"),
  71   cl::init(""));
  72
  73 static cl::list<std::string>
  74 MAttrs("mattr",
  75   cl::CommaSeparated,
  76   cl::desc("Target specific attributes (-mattr=help for details)"),
  77   cl::value_desc("a1,+a2,-a3,..."));
  78
  79 static cl::opt<bool>
  80 RelaxAll("mc-relax-all",
  81   cl::desc("When used with filetype=obj, "
  82            "relax all fixups in the emitted object file"));
  83
  84 cl::opt<TargetMachine::CodeGenFileType>
  85 FileType("filetype", cl::init(TargetMachine::CGFT_AssemblyFile),
  86   cl::desc("Choose a file type (not all types are supported by all targets):"),
  87   cl::values(
  88        clEnumValN(TargetMachine::CGFT_AssemblyFile, "asm",
  89                   "Emit an assembly ('.s') file"),
  90        clEnumValN(TargetMachine::CGFT_ObjectFile, "obj",
  91                   "Emit a native object ('.o') file [experimental]"),
  92        clEnumValN(TargetMachine::CGFT_Null, "null",
  93                   "Emit nothing, for performance testing"),
  94        clEnumValEnd));
  95
  96 cl::opt<bool> NoVerify("disable-verify", cl::Hidden,
  97                        cl::desc("Do not verify input module"));
  98
  99
 100 static cl::opt<bool>
 101 DisableRedZone("disable-red-zone",
 102   cl::desc("Do not emit code that uses the red zone."),
 103   cl::init(false));
 104
 105 static cl::opt<bool>
 106 NoImplicitFloats("no-implicit-float",
 107   cl::desc("Don't generate implicit floating point instructions (x86-only)"),
 108   cl::init(false));
 109
 110 // GetFileNameRoot - Helper function to get the basename of a filename.
 111 static inline std::string
 112 GetFileNameRoot(const std::string &InputFilename) {
 113   std::string IFN = InputFilename;
 114   std::string outputFilename;
 115   int Len = IFN.length();
 116   if ((Len > 2) &&
 117       IFN[Len-3] == '.' &&
 118       ((IFN[Len-2] == 'b' && IFN[Len-1] == 'c') ||
 119        (IFN[Len-2] == 'l' && IFN[Len-1] == 'l'))) {
 120     outputFilename = std::string(IFN.begin(), IFN.end()-3); // s/.bc/.s/
 121   } else {
 122     outputFilename = IFN;
 123   }
 124   return outputFilename;
 125 }
 126
 127 static formatted_raw_ostream *GetOutputStream(const char *TargetName,
 128                                               Triple::OSType OS,
 129                                               const char *ProgName) {
 130   // If we don't yet have an output filename, make one.
 131   if (OutputFilename.empty()) {
 132     if (InputFilename == "-")
 133       OutputFilename = "-";
 134     else {
 135       OutputFilename = GetFileNameRoot(InputFilename);
 136
 137       switch (FileType) {
 138       default: assert(0 && "Unknown file type");
 139       case TargetMachine::CGFT_AssemblyFile:
 140         if (TargetName[0] == 'c') {
 141           if (TargetName[1] == 0)
 142             OutputFilename += ".cbe.c";
 143           else if (TargetName[1] == 'p' && TargetName[2] == 'p')
 144             OutputFilename += ".cpp";
 145           else
 146             OutputFilename += ".s";
 147         } else
 148           OutputFilename += ".s";
 149         break;
 150       case TargetMachine::CGFT_ObjectFile:
 151         if (OS == Triple::Win32)
 152           OutputFilename += ".obj";
 153         else
 154           OutputFilename += ".o";
 155         break;
 156       case TargetMachine::CGFT_Null:
 157         OutputFilename += ".null";
 158         break;
 159       }
 160     }
 161   }
 162
 163   // Decide if we need "binary" output.
 164   bool Binary = false;
 165   switch (FileType) {
 166   default: assert(0 && "Unknown file type");
 167   case TargetMachine::CGFT_AssemblyFile:
 168     break;
 169   case TargetMachine::CGFT_ObjectFile:
 170   case TargetMachine::CGFT_Null:
 171     Binary = true;
 172     break;
 173   }
 174
 175   // Make sure that the Out file gets unlinked from the disk if we get a
 176   // SIGINT
 177   if (OutputFilename != "-")
 178     sys::RemoveFileOnSignal(sys::Path(OutputFilename));
 179
 180   // Open the file.
 181   std::string error;
 182   unsigned OpenFlags = 0;
 183   if (Binary) OpenFlags |= raw_fd_ostream::F_Binary;
 184   raw_fd_ostream *FDOut = new raw_fd_ostream(OutputFilename.c_str(), error,
 185                                              OpenFlags);
 186   if (!error.empty()) {
 187     errs() << error << '\n';
 188     delete FDOut;
 189     return 0;
 190   }
 191
 192   formatted_raw_ostream *Out =
 193     new formatted_raw_ostream(*FDOut, formatted_raw_ostream::DELETE_STREAM);
 194
 195   return Out;
 196 }
 197
 198 // main - Entry point for the llc compiler.
 199 //
 200 int main(int argc, char **argv) {
 201   sys::PrintStackTraceOnErrorSignal();
 202   PrettyStackTraceProgram X(argc, argv);
 203
 204   // Enable debug stream buffering.
 205   EnableDebugBuffering = true;
 206
 207   LLVMContext &Context = getGlobalContext();
 208   llvm_shutdown_obj Y;  // Call llvm_shutdown() on exit.
 209
 210   // Initialize targets first, so that --version shows registered targets.
 211   InitializeAllTargets();
 212   InitializeAllAsmPrinters();
 213   InitializeAllAsmParsers();
 214
 215   cl::ParseCommandLineOptions(argc, argv, "llvm system compiler\n");
 216
 217   // Load the module to be compiled...
 218   SMDiagnostic Err;
 219   std::auto_ptr<Module> M;
 220
 221   M.reset(ParseIRFile(InputFilename, Err, Context));
 222   if (M.get() == 0) {
 223     Err.Print(argv[0], errs());
 224     return 1;
 225   }
 226   Module &mod = *M.get();
 227
 228   // If we are supposed to override the target triple, do so now.
 229   if (!TargetTriple.empty())
 230     mod.setTargetTriple(TargetTriple);
 231
 232   Triple TheTriple(mod.getTargetTriple());
 233   if (TheTriple.getTriple().empty())
 234     TheTriple.setTriple(sys::getHostTriple());
 235
 236   // Allocate target machine.  First, check whether the user has explicitly
 237   // specified an architecture to compile for. If so we have to look it up by
 238   // name, because it might be a backend that has no mapping to a target triple.
 239   const Target *TheTarget = 0;
 240   if (!MArch.empty()) {
 241     for (TargetRegistry::iterator it = TargetRegistry::begin(),
 242            ie = TargetRegistry::end(); it != ie; ++it) {
 243       if (MArch == it->getName()) {
 244         TheTarget = &*it;
 245         break;
 246       }
 247     }
 248
 249     if (!TheTarget) {
 250       errs() << argv[0] << ": error: invalid target '" << MArch << "'.\n";
 251       return 1;
 252     }
 253
 254     // Adjust the triple to match (if known), otherwise stick with the
 255     // module/host triple.
 256     Triple::ArchType Type = Triple::getArchTypeForLLVMName(MArch);
 257     if (Type != Triple::UnknownArch)
 258       TheTriple.setArch(Type);
 259   } else {
 260     std::string Err;
 261     TheTarget = TargetRegistry::lookupTarget(TheTriple.getTriple(), Err);
 262     if (TheTarget == 0) {
 263       errs() << argv[0] << ": error auto-selecting target for module '"
 264              << Err << "'.  Please use the -march option to explicitly "
 265              << "pick a target.\n";
 266       return 1;
 267     }
 268   }
 269
 270   // Package up features to be passed to target/subtarget
 271   std::string FeaturesStr;
 272   if (MCPU.size() || MAttrs.size()) {
 273     SubtargetFeatures Features;
 274     Features.setCPU(MCPU);
 275     for (unsigned i = 0; i != MAttrs.size(); ++i)
 276       Features.AddFeature(MAttrs[i]);
 277     FeaturesStr = Features.getString();
 278   }
 279
 280   std::auto_ptr<TargetMachine>
 281     target(TheTarget->createTargetMachine(TheTriple.getTriple(), FeaturesStr));
 282   assert(target.get() && "Could not allocate target machine!");
 283   TargetMachine &Target = *target.get();
 284
 285   // Figure out where we are going to send the output...
 286   formatted_raw_ostream *Out = GetOutputStream(TheTarget->getName(),
 287                                                TheTriple.getOS(), argv[0]);
 288   if (Out == 0) return 1;
 289
 290   CodeGenOpt::Level OLvl = CodeGenOpt::Default;
 291   switch (OptLevel) {
 292   default:
 293     errs() << argv[0] << ": invalid optimization level.\n";
 294     return 1;
 295   case ' ': break;
 296   case '0': OLvl = CodeGenOpt::None; break;
 297   case '1': OLvl = CodeGenOpt::Less; break;
 298   case '2': OLvl = CodeGenOpt::Default; break;
 299   case '3': OLvl = CodeGenOpt::Aggressive; break;
 300   }
 301
 302   // Request that addPassesToEmitFile run the Verifier after running
 303   // passes which modify the IR.
 304 #ifndef NDEBUG
 305   bool DisableVerify = false;
 306 #else
 307   bool DisableVerify = true;
 308 #endif
 309
 310   // Build up all of the passes that we want to do to the module.
 311   PassManager PM;
 312
 313   // Add the target data from the target machine, if it exists, or the module.
 314   if (const TargetData *TD = Target.getTargetData())
 315     PM.add(new TargetData(*TD));
 316   else
 317     PM.add(new TargetData(&mod));
 318
 319   if (!NoVerify)
 320     PM.add(createVerifierPass());
 321
 322   // Override default to generate verbose assembly.
 323   Target.setAsmVerbosityDefault(true);
 324
 325   if (RelaxAll) {
 326     if (FileType != TargetMachine::CGFT_ObjectFile)
 327       errs() << argv[0]
 328              << ": warning: ignoring -mc-relax-all because filetype != obj";
 329     else
 330       Target.setMCRelaxAll(true);
 331   }
 332
 333   // Ask the target to add backend passes as necessary.
 334   if (Target.addPassesToEmitFile(PM, *Out, FileType, OLvl,
 335                                  DisableVerify)) {
 336     errs() << argv[0] << ": target does not support generation of this"
 337            << " file type!\n";
 338     delete Out;
 339     // And the Out file is empty and useless, so remove it now.
 340     sys::Path(OutputFilename).eraseFromDisk();
 341     return 1;
 342   }
 343
 344   PM.run(mod);
 345
 346   // Delete the ostream.
 347   delete Out;
 348
 349   return 0;
 350 }