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/Bitcode/ReaderWriter.h"
  17 #include "llvm/CodeGen/FileWriters.h"
  18 #include "llvm/CodeGen/LinkAllCodegenComponents.h"
  19 #include "llvm/CodeGen/LinkAllAsmWriterComponents.h"
  20 #include "llvm/CodeGen/ObjectCodeEmitter.h"
  21 #include "llvm/Target/SubtargetFeature.h"
  22 #include "llvm/Target/TargetData.h"
  23 #include "llvm/Target/TargetMachine.h"
  24 #include "llvm/Target/TargetRegistry.h"
  25 #include "llvm/Transforms/Scalar.h"
  26 #include "llvm/LLVMContext.h"
  27 #include "llvm/Module.h"
  28 #include "llvm/ModuleProvider.h"
  29 #include "llvm/PassManager.h"
  30 #include "llvm/Pass.h"
  31 #include "llvm/Support/CommandLine.h"
  32 #include "llvm/Support/FileUtilities.h"
  33 #include "llvm/Support/FormattedStream.h"
  34 #include "llvm/Support/ManagedStatic.h"
  35 #include "llvm/Support/MemoryBuffer.h"
  36 #include "llvm/Support/PluginLoader.h"
  37 #include "llvm/Support/PrettyStackTrace.h"
  38 #include "llvm/Analysis/Verifier.h"
  39 #include "llvm/System/Signals.h"
  40 #include "llvm/Config/config.h"
  41 #include "llvm/LinkAllVMCore.h"
  42 #include "llvm/Target/TargetSelect.h"
  43 #include <memory>
  44 using namespace llvm;
  45
  46 // General options for llc.  Other pass-specific options are specified
  47 // within the corresponding llc passes, and target-specific options
  48 // and back-end code generation options are specified with the target machine.
  49 //
  50 static cl::opt<std::string>
  51 InputFilename(cl::Positional, cl::desc("<input bitcode>"), cl::init("-"));
  52
  53 static cl::opt<std::string>
  54 OutputFilename("o", cl::desc("Output filename"), cl::value_desc("filename"));
  55
  56 static cl::opt<bool> Force("f", cl::desc("Overwrite output files"));
  57
  58 // Determine optimization level.
  59 static cl::opt<char>
  60 OptLevel("O",
  61          cl::desc("Optimization level. [-O0, -O1, -O2, or -O3] "
  62                   "(default = '-O2')"),
  63          cl::Prefix,
  64          cl::ZeroOrMore,
  65          cl::init(' '));
  66
  67 static cl::opt<std::string>
  68 TargetTriple("mtriple", cl::desc("Override target triple for module"));
  69
  70 static cl::opt<std::string>
  71 MArch("march", cl::desc("Architecture to generate code for (see --version)"));
  72
  73 static cl::opt<std::string>
  74 MCPU("mcpu",
  75   cl::desc("Target a specific cpu type (-mcpu=help for details)"),
  76   cl::value_desc("cpu-name"),
  77   cl::init(""));
  78
  79 static cl::list<std::string>
  80 MAttrs("mattr",
  81   cl::CommaSeparated,
  82   cl::desc("Target specific attributes (-mattr=help for details)"),
  83   cl::value_desc("a1,+a2,-a3,..."));
  84
  85 cl::opt<TargetMachine::CodeGenFileType>
  86 FileType("filetype", cl::init(TargetMachine::AssemblyFile),
  87   cl::desc("Choose a file type (not all types are supported by all targets):"),
  88   cl::values(
  89        clEnumValN(TargetMachine::AssemblyFile, "asm",
  90                   "Emit an assembly ('.s') file"),
  91        clEnumValN(TargetMachine::ObjectFile, "obj",
  92                   "Emit a native object ('.o') file [experimental]"),
  93        clEnumValN(TargetMachine::DynamicLibrary, "dynlib",
  94                   "Emit a native dynamic library ('.so') file"
  95                   " [experimental]"),
  96        clEnumValEnd));
  97
  98 cl::opt<bool> NoVerify("disable-verify", cl::Hidden,
  99                        cl::desc("Do not verify input module"));
 100
 101
 102 static cl::opt<bool>
 103 DisableRedZone("disable-red-zone",
 104   cl::desc("Do not emit code that uses the red zone."),
 105   cl::init(false));
 106
 107 static cl::opt<bool>
 108 NoImplicitFloats("no-implicit-float",
 109   cl::desc("Don't generate implicit floating point instructions (x86-only)"),
 110   cl::init(false));
 111
 112 // GetFileNameRoot - Helper function to get the basename of a filename.
 113 static inline std::string
 114 GetFileNameRoot(const std::string &InputFilename) {
 115   std::string IFN = InputFilename;
 116   std::string outputFilename;
 117   int Len = IFN.length();
 118   if ((Len > 2) &&
 119       IFN[Len-3] == '.' && IFN[Len-2] == 'b' && IFN[Len-1] == 'c') {
 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                                               const char *ProgName) {
 129   if (OutputFilename != "") {
 130     if (OutputFilename == "-")
 131       return &fouts();
 132
 133     // Make sure that the Out file gets unlinked from the disk if we get a
 134     // SIGINT
 135     sys::RemoveFileOnSignal(sys::Path(OutputFilename));
 136
 137     std::string error;
 138     raw_fd_ostream *FDOut = new raw_fd_ostream(OutputFilename.c_str(),
 139                                                /*Binary=*/true, Force, error);
 140     if (!error.empty()) {
 141       errs() << error << '\n';
 142       if (!Force)
 143         errs() << "Use -f command line argument to force output\n";
 144       delete FDOut;
 145       return 0;
 146     }
 147     formatted_raw_ostream *Out =
 148       new formatted_raw_ostream(*FDOut, formatted_raw_ostream::DELETE_STREAM);
 149
 150     return Out;
 151   }
 152
 153   if (InputFilename == "-") {
 154     OutputFilename = "-";
 155     return &fouts();
 156   }
 157
 158   OutputFilename = GetFileNameRoot(InputFilename);
 159
 160   bool Binary = false;
 161   switch (FileType) {
 162   case TargetMachine::AssemblyFile:
 163     if (TargetName[0] == 'c') {
 164       if (TargetName[1] == 0)
 165         OutputFilename += ".cbe.c";
 166       else if (TargetName[1] == 'p' && TargetName[2] == 'p')
 167         OutputFilename += ".cpp";
 168       else
 169         OutputFilename += ".s";
 170     } else
 171       OutputFilename += ".s";
 172     break;
 173   case TargetMachine::ObjectFile:
 174     OutputFilename += ".o";
 175     Binary = true;
 176     break;
 177   case TargetMachine::DynamicLibrary:
 178     OutputFilename += LTDL_SHLIB_EXT;
 179     Binary = true;
 180     break;
 181   }
 182
 183   // Make sure that the Out file gets unlinked from the disk if we get a
 184   // SIGINT
 185   sys::RemoveFileOnSignal(sys::Path(OutputFilename));
 186
 187   std::string error;
 188   raw_fd_ostream *FDOut = new raw_fd_ostream(OutputFilename.c_str(),
 189                                              Binary, Force, error);
 190   if (!error.empty()) {
 191     errs() << error << '\n';
 192     if (!Force)
 193       errs() << "Use -f command line argument to force output\n";
 194     delete FDOut;
 195     return 0;
 196   }
 197
 198   formatted_raw_ostream *Out =
 199     new formatted_raw_ostream(*FDOut, formatted_raw_ostream::DELETE_STREAM);
 200
 201   return Out;
 202 }
 203
 204 // main - Entry point for the llc compiler.
 205 //
 206 int main(int argc, char **argv) {
 207   sys::PrintStackTraceOnErrorSignal();
 208   PrettyStackTraceProgram X(argc, argv);
 209   LLVMContext &Context = getGlobalContext();
 210   llvm_shutdown_obj Y;  // Call llvm_shutdown() on exit.
 211
 212   // Initialize targets first.
 213   InitializeAllTargets();
 214   InitializeAllAsmPrinters();
 215
 216   cl::ParseCommandLineOptions(argc, argv, "llvm system compiler\n");
 217
 218   // Load the module to be compiled...
 219   std::string ErrorMessage;
 220   std::auto_ptr<Module> M;
 221
 222   std::auto_ptr<MemoryBuffer> Buffer(
 223                    MemoryBuffer::getFileOrSTDIN(InputFilename, &ErrorMessage));
 224   if (Buffer.get())
 225     M.reset(ParseBitcodeFile(Buffer.get(), Context, &ErrorMessage));
 226   if (M.get() == 0) {
 227     errs() << argv[0] << ": bitcode didn't read correctly.\n";
 228     errs() << "Reason: " << ErrorMessage << "\n";
 229     return 1;
 230   }
 231   Module &mod = *M.get();
 232
 233   // If we are supposed to override the target triple, do so now.
 234   if (!TargetTriple.empty())
 235     mod.setTargetTriple(TargetTriple);
 236
 237   // Allocate target machine.  First, check whether the user has
 238   // explicitly specified an architecture to compile for.
 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   } else {
 254     std::string Err;
 255     TheTarget = TargetRegistry::lookupTarget(mod.getTargetTriple(),
 256                                              /*FallbackToHost=*/true,
 257                                              /*RequireJIT=*/false,
 258                                              Err);
 259     if (TheTarget == 0) {
 260       errs() << argv[0] << ": error auto-selecting target for module '"
 261              << Err << "'.  Please use the -march option to explicitly "
 262              << "pick a target.\n";
 263       return 1;
 264     }
 265   }
 266
 267   // Package up features to be passed to target/subtarget
 268   std::string FeaturesStr;
 269   if (MCPU.size() || MAttrs.size()) {
 270     SubtargetFeatures Features;
 271     Features.setCPU(MCPU);
 272     for (unsigned i = 0; i != MAttrs.size(); ++i)
 273       Features.AddFeature(MAttrs[i]);
 274     FeaturesStr = Features.getString();
 275   }
 276
 277   std::auto_ptr<TargetMachine>
 278     target(TheTarget->createTargetMachine(mod, FeaturesStr));
 279   assert(target.get() && "Could not allocate target machine!");
 280   TargetMachine &Target = *target.get();
 281
 282   // Figure out where we are going to send the output...
 283   formatted_raw_ostream *Out = GetOutputStream(TheTarget->getName(), argv[0]);
 284   if (Out == 0) 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':
 294   case '2': OLvl = CodeGenOpt::Default; break;
 295   case '3': OLvl = CodeGenOpt::Aggressive; break;
 296   }
 297
 298   // If this target requires addPassesToEmitWholeFile, do it now.  This is
 299   // used by strange things like the C backend.
 300   if (Target.WantsWholeFile()) {
 301     PassManager PM;
 302     PM.add(new TargetData(*Target.getTargetData()));
 303     if (!NoVerify)
 304       PM.add(createVerifierPass());
 305
 306     // Ask the target to add backend passes as necessary.
 307     if (Target.addPassesToEmitWholeFile(PM, *Out, FileType, OLvl)) {
 308       errs() << argv[0] << ": target does not support generation of this"
 309              << " file type!\n";
 310       if (Out != &fouts()) delete Out;
 311       // And the Out file is empty and useless, so remove it now.
 312       sys::Path(OutputFilename).eraseFromDisk();
 313       return 1;
 314     }
 315     PM.run(mod);
 316   } else {
 317     // Build up all of the passes that we want to do to the module.
 318     ExistingModuleProvider Provider(M.release());
 319     FunctionPassManager Passes(&Provider);
 320     Passes.add(new TargetData(*Target.getTargetData()));
 321
 322 #ifndef NDEBUG
 323     if (!NoVerify)
 324       Passes.add(createVerifierPass());
 325 #endif
 326
 327     // Ask the target to add backend passes as necessary.
 328     ObjectCodeEmitter *OCE = 0;
 329
 330     // Override default to generate verbose assembly.
 331     Target.setAsmVerbosityDefault(true);
 332
 333     switch (Target.addPassesToEmitFile(Passes, *Out, FileType, OLvl)) {
 334     default:
 335       assert(0 && "Invalid file model!");
 336       return 1;
 337     case FileModel::Error:
 338       errs() << argv[0] << ": target does not support generation of this"
 339              << " file type!\n";
 340       if (Out != &fouts()) delete Out;
 341       // And the Out file is empty and useless, so remove it now.
 342       sys::Path(OutputFilename).eraseFromDisk();
 343       return 1;
 344     case FileModel::AsmFile:
 345       break;
 346     case FileModel::MachOFile:
 347       OCE = AddMachOWriter(Passes, *Out, Target);
 348       break;
 349     case FileModel::ElfFile:
 350       OCE = AddELFWriter(Passes, *Out, Target);
 351       break;
 352     }
 353
 354     if (Target.addPassesToEmitFileFinish(Passes, OCE, OLvl)) {
 355       errs() << argv[0] << ": target does not support generation of this"
 356              << " file type!\n";
 357       if (Out != &fouts()) delete Out;
 358       // And the Out file is empty and useless, so remove it now.
 359       sys::Path(OutputFilename).eraseFromDisk();
 360       return 1;
 361     }
 362
 363     Passes.doInitialization();
 364
 365     // Run our queue of passes all at once now, efficiently.
 366     // TODO: this could lazily stream functions out of the module.
 367     for (Module::iterator I = mod.begin(), E = mod.end(); I != E; ++I)
 368       if (!I->isDeclaration()) {
 369         if (DisableRedZone)
 370           I->addFnAttr(Attribute::NoRedZone);
 371         if (NoImplicitFloats)
 372           I->addFnAttr(Attribute::NoImplicitFloat);
 373         Passes.run(*I);
 374       }
 375
 376     Passes.doFinalization();
 377   }
 378
 379   Out->flush();
 380
 381   // Delete the ostream if it's not a stdout stream
 382   if (Out != &fouts()) delete Out;
 383
 384   return 0;
 385 }