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_tool_output_file *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   // Open the file.
 176   std::string error;
 177   unsigned OpenFlags = 0;
 178   if (Binary) OpenFlags |= raw_fd_ostream::F_Binary;
 179   tool_output_file *FDOut = new tool_output_file(OutputFilename.c_str(), error,
 180                                                  OpenFlags);
 181   if (!error.empty()) {
 182     errs() << error << '\n';
 183     delete FDOut;
 184     return 0;
 185   }
 186
 187   formatted_tool_output_file *Out =
 188     new formatted_tool_output_file(*FDOut,
 189                                    formatted_raw_ostream::DELETE_STREAM);
 190
 191   return Out;
 192 }
 193
 194 // main - Entry point for the llc compiler.
 195 //
 196 int main(int argc, char **argv) {
 197   sys::PrintStackTraceOnErrorSignal();
 198   PrettyStackTraceProgram X(argc, argv);
 199
 200   // Enable debug stream buffering.
 201   EnableDebugBuffering = true;
 202
 203   LLVMContext &Context = getGlobalContext();
 204   llvm_shutdown_obj Y;  // Call llvm_shutdown() on exit.
 205
 206   // Initialize targets first, so that --version shows registered targets.
 207   InitializeAllTargets();
 208   InitializeAllAsmPrinters();
 209   InitializeAllAsmParsers();
 210
 211   cl::ParseCommandLineOptions(argc, argv, "llvm system compiler\n");
 212
 213   // Load the module to be compiled...
 214   SMDiagnostic Err;
 215   std::auto_ptr<Module> M;
 216
 217   M.reset(ParseIRFile(InputFilename, Err, Context));
 218   if (M.get() == 0) {
 219     Err.Print(argv[0], errs());
 220     return 1;
 221   }
 222   Module &mod = *M.get();
 223
 224   // If we are supposed to override the target triple, do so now.
 225   if (!TargetTriple.empty())
 226     mod.setTargetTriple(TargetTriple);
 227
 228   Triple TheTriple(mod.getTargetTriple());
 229   if (TheTriple.getTriple().empty())
 230     TheTriple.setTriple(sys::getHostTriple());
 231
 232   // Allocate target machine.  First, check whether the user has explicitly
 233   // specified an architecture to compile for. If so we have to look it up by
 234   // name, because it might be a backend that has no mapping to a target triple.
 235   const Target *TheTarget = 0;
 236   if (!MArch.empty()) {
 237     for (TargetRegistry::iterator it = TargetRegistry::begin(),
 238            ie = TargetRegistry::end(); it != ie; ++it) {
 239       if (MArch == it->getName()) {
 240         TheTarget = &*it;
 241         break;
 242       }
 243     }
 244
 245     if (!TheTarget) {
 246       errs() << argv[0] << ": error: invalid target '" << MArch << "'.\n";
 247       return 1;
 248     }
 249
 250     // Adjust the triple to match (if known), otherwise stick with the
 251     // module/host triple.
 252     Triple::ArchType Type = Triple::getArchTypeForLLVMName(MArch);
 253     if (Type != Triple::UnknownArch)
 254       TheTriple.setArch(Type);
 255   } else {
 256     std::string Err;
 257     TheTarget = TargetRegistry::lookupTarget(TheTriple.getTriple(), Err);
 258     if (TheTarget == 0) {
 259       errs() << argv[0] << ": error auto-selecting target for module '"
 260              << Err << "'.  Please use the -march option to explicitly "
 261              << "pick a target.\n";
 262       return 1;
 263     }
 264   }
 265
 266   // Package up features to be passed to target/subtarget
 267   std::string FeaturesStr;
 268   if (MCPU.size() || MAttrs.size()) {
 269     SubtargetFeatures Features;
 270     Features.setCPU(MCPU);
 271     for (unsigned i = 0; i != MAttrs.size(); ++i)
 272       Features.AddFeature(MAttrs[i]);
 273     FeaturesStr = Features.getString();
 274   }
 275
 276   std::auto_ptr<TargetMachine>
 277     target(TheTarget->createTargetMachine(TheTriple.getTriple(), FeaturesStr));
 278   assert(target.get() && "Could not allocate target machine!");
 279   TargetMachine &Target = *target.get();
 280
 281   // Figure out where we are going to send the output...
 282   OwningPtr<formatted_tool_output_file> Out
 283     (GetOutputStream(TheTarget->getName(), TheTriple.getOS(), argv[0]));
 284   if (!Out) return 1;
 285
 286   CodeGenOpt::Level OLvl = CodeGenOpt::Default;
 287   switch (OptLevel) {
 288   default:
 289     errs() << argv[0] << ": invalid optimization level.\n";
 290     return 1;
 291   case ' ': break;
 292   case '0': OLvl = CodeGenOpt::None; break;
 293   case '1': OLvl = CodeGenOpt::Less; break;
 294   case '2': OLvl = CodeGenOpt::Default; break;
 295   case '3': OLvl = CodeGenOpt::Aggressive; break;
 296   }
 297
 298   // Request that addPassesToEmitFile run the Verifier after running
 299   // passes which modify the IR.
 300 #ifndef NDEBUG
 301   bool DisableVerify = false;
 302 #else
 303   bool DisableVerify = true;
 304 #endif
 305
 306   // Build up all of the passes that we want to do to the module.
 307   PassManager PM;
 308
 309   // Add the target data from the target machine, if it exists, or the module.
 310   if (const TargetData *TD = Target.getTargetData())
 311     PM.add(new TargetData(*TD));
 312   else
 313     PM.add(new TargetData(&mod));
 314
 315   if (!NoVerify)
 316     PM.add(createVerifierPass());
 317
 318   // Override default to generate verbose assembly.
 319   Target.setAsmVerbosityDefault(true);
 320
 321   if (RelaxAll) {
 322     if (FileType != TargetMachine::CGFT_ObjectFile)
 323       errs() << argv[0]
 324              << ": warning: ignoring -mc-relax-all because filetype != obj";
 325     else
 326       Target.setMCRelaxAll(true);
 327   }
 328
 329   // Ask the target to add backend passes as necessary.
 330   if (Target.addPassesToEmitFile(PM, *Out, FileType, OLvl,
 331                                  DisableVerify)) {
 332     errs() << argv[0] << ": target does not support generation of this"
 333            << " file type!\n";
 334     return 1;
 335   }
 336
 337   PM.run(mod);
 338
 339   // Declare success.
 340   Out->keep();
 341
 342   return 0;
 343 }