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/Target/SubtargetFeature.h"
  21 #include "llvm/Target/TargetData.h"
  22 #include "llvm/Target/TargetMachine.h"
  23 #include "llvm/Target/TargetMachineRegistry.h"
  24 #include "llvm/Transforms/Scalar.h"
  25 #include "llvm/Module.h"
  26 #include "llvm/ModuleProvider.h"
  27 #include "llvm/PassManager.h"
  28 #include "llvm/Pass.h"
  29 #include "llvm/Support/CommandLine.h"
  30 #include "llvm/Support/ManagedStatic.h"
  31 #include "llvm/Support/MemoryBuffer.h"
  32 #include "llvm/Support/PluginLoader.h"
  33 #include "llvm/Support/FileUtilities.h"
  34 #include "llvm/Support/raw_ostream.h"
  35 #include "llvm/Analysis/Verifier.h"
  36 #include "llvm/System/Signals.h"
  37 #include "llvm/Config/config.h"
  38 #include "llvm/LinkAllVMCore.h"
  39 #include <fstream>
  40 #include <iostream>
  41 #include <memory>
  42 using namespace llvm;
  43
  44 // General options for llc.  Other pass-specific options are specified
  45 // within the corresponding llc passes, and target-specific options
  46 // and back-end code generation options are specified with the target machine.
  47 //
  48 static cl::opt<std::string>
  49 InputFilename(cl::Positional, cl::desc("<input bitcode>"), cl::init("-"));
  50
  51 static cl::opt<std::string>
  52 OutputFilename("o", cl::desc("Output filename"), cl::value_desc("filename"));
  53
  54 static cl::opt<bool> Force("f", cl::desc("Overwrite output files"));
  55
  56 static cl::opt<bool> Fast("fast",
  57       cl::desc("Generate code quickly, potentially sacrificing code quality"));
  58
  59 static cl::opt<std::string>
  60 TargetTriple("mtriple", cl::desc("Override target triple for module"));
  61
  62 static cl::opt<const TargetMachineRegistry::entry*, false,
  63                TargetMachineRegistry::Parser>
  64 MArch("march", cl::desc("Architecture to generate code for:"));
  65
  66 static cl::opt<std::string>
  67 MCPU("mcpu",
  68   cl::desc("Target a specific cpu type (-mcpu=help for details)"),
  69   cl::value_desc("cpu-name"),
  70   cl::init(""));
  71
  72 static cl::list<std::string>
  73 MAttrs("mattr",
  74   cl::CommaSeparated,
  75   cl::desc("Target specific attributes (-mattr=help for details)"),
  76   cl::value_desc("a1,+a2,-a3,..."));
  77
  78 cl::opt<TargetMachine::CodeGenFileType>
  79 FileType("filetype", cl::init(TargetMachine::AssemblyFile),
  80   cl::desc("Choose a file type (not all types are supported by all targets):"),
  81   cl::values(
  82        clEnumValN(TargetMachine::AssemblyFile, "asm",
  83                   "Emit an assembly ('.s') file"),
  84        clEnumValN(TargetMachine::ObjectFile, "obj",
  85                   "Emit a native object ('.o') file [experimental]"),
  86        clEnumValN(TargetMachine::DynamicLibrary, "dynlib",
  87                   "Emit a native dynamic library ('.so') file"
  88                   " [experimental]"),
  89        clEnumValEnd));
  90
  91 cl::opt<bool> NoVerify("disable-verify", cl::Hidden,
  92                        cl::desc("Do not verify input module"));
  93
  94
  95 // GetFileNameRoot - Helper function to get the basename of a filename.
  96 static inline std::string
  97 GetFileNameRoot(const std::string &InputFilename) {
  98   std::string IFN = InputFilename;
  99   std::string outputFilename;
 100   int Len = IFN.length();
 101   if ((Len > 2) &&
 102       IFN[Len-3] == '.' && IFN[Len-2] == 'b' && IFN[Len-1] == 'c') {
 103     outputFilename = std::string(IFN.begin(), IFN.end()-3); // s/.bc/.s/
 104   } else {
 105     outputFilename = IFN;
 106   }
 107   return outputFilename;
 108 }
 109
 110 static raw_ostream *GetOutputStream(const char *ProgName) {
 111   if (OutputFilename != "") {
 112     if (OutputFilename == "-")
 113       return &outs();
 114
 115     // Specified an output filename?
 116     if (!Force && std::ifstream(OutputFilename.c_str())) {
 117       // If force is not specified, make sure not to overwrite a file!
 118       std::cerr << ProgName << ": error opening '" << OutputFilename
 119                 << "': file exists!\n"
 120                 << "Use -f command line argument to force output\n";
 121       return 0;
 122     }
 123     // Make sure that the Out file gets unlinked from the disk if we get a
 124     // SIGINT
 125     sys::RemoveFileOnSignal(sys::Path(OutputFilename));
 126
 127     std::string error;
 128     raw_ostream *Out = new raw_fd_ostream(OutputFilename.c_str(), true, error);
 129     if (!error.empty()) {
 130       std::cerr << error << '\n';
 131       delete Out;
 132       return 0;
 133     }
 134
 135     return Out;
 136   }
 137
 138   if (InputFilename == "-") {
 139     OutputFilename = "-";
 140     return &outs();
 141   }
 142
 143   OutputFilename = GetFileNameRoot(InputFilename);
 144
 145   bool Binary = false;
 146   switch (FileType) {
 147   case TargetMachine::AssemblyFile:
 148     if (MArch->Name[0] == 'c') {
 149       if (MArch->Name[1] == 0)
 150         OutputFilename += ".cbe.c";
 151       else if (MArch->Name[1] == 'p' && MArch->Name[2] == 'p')
 152         OutputFilename += ".cpp";
 153       else
 154         OutputFilename += ".s";
 155     } else
 156       OutputFilename += ".s";
 157     break;
 158   case TargetMachine::ObjectFile:
 159     OutputFilename += ".o";
 160     Binary = true;
 161     break;
 162   case TargetMachine::DynamicLibrary:
 163     OutputFilename += LTDL_SHLIB_EXT;
 164     Binary = true;
 165     break;
 166   }
 167
 168   if (!Force && std::ifstream(OutputFilename.c_str())) {
 169     // If force is not specified, make sure not to overwrite a file!
 170     std::cerr << ProgName << ": error opening '" << OutputFilename
 171                           << "': file exists!\n"
 172                           << "Use -f command line argument to force output\n";
 173     return 0;
 174   }
 175
 176   // Make sure that the Out file gets unlinked from the disk if we get a
 177   // SIGINT
 178   sys::RemoveFileOnSignal(sys::Path(OutputFilename));
 179
 180   std::string error;
 181   raw_ostream *Out = new raw_fd_ostream(OutputFilename.c_str(), Binary, error);
 182   if (!error.empty()) {
 183     std::cerr << error << '\n';
 184     delete Out;
 185     return 0;
 186   }
 187
 188   return Out;
 189 }
 190
 191 // main - Entry point for the llc compiler.
 192 //
 193 int main(int argc, char **argv) {
 194   llvm_shutdown_obj X;  // Call llvm_shutdown() on exit.
 195   cl::ParseCommandLineOptions(argc, argv, "llvm system compiler\n");
 196   sys::PrintStackTraceOnErrorSignal();
 197
 198   // Load the module to be compiled...
 199   std::string ErrorMessage;
 200   std::auto_ptr<Module> M;
 201
 202   std::auto_ptr<MemoryBuffer> Buffer(
 203                    MemoryBuffer::getFileOrSTDIN(InputFilename, &ErrorMessage));
 204   if (Buffer.get())
 205     M.reset(ParseBitcodeFile(Buffer.get(), &ErrorMessage));
 206   if (M.get() == 0) {
 207     std::cerr << argv[0] << ": bitcode didn't read correctly.\n";
 208     std::cerr << "Reason: " << ErrorMessage << "\n";
 209     return 1;
 210   }
 211   Module &mod = *M.get();
 212
 213   // If we are supposed to override the target triple, do so now.
 214   if (!TargetTriple.empty())
 215     mod.setTargetTriple(TargetTriple);
 216
 217   // Allocate target machine.  First, check whether the user has
 218   // explicitly specified an architecture to compile for.
 219   if (MArch == 0) {
 220     std::string Err;
 221     MArch = TargetMachineRegistry::getClosestStaticTargetForModule(mod, Err);
 222     if (MArch == 0) {
 223       std::cerr << argv[0] << ": error auto-selecting target for module '"
 224                 << Err << "'.  Please use the -march option to explicitly "
 225                 << "pick a target.\n";
 226       return 1;
 227     }
 228   }
 229
 230   // Package up features to be passed to target/subtarget
 231   std::string FeaturesStr;
 232   if (MCPU.size() || MAttrs.size()) {
 233     SubtargetFeatures Features;
 234     Features.setCPU(MCPU);
 235     for (unsigned i = 0; i != MAttrs.size(); ++i)
 236       Features.AddFeature(MAttrs[i]);
 237     FeaturesStr = Features.getString();
 238   }
 239
 240   std::auto_ptr<TargetMachine> target(MArch->CtorFn(mod, FeaturesStr));
 241   assert(target.get() && "Could not allocate target machine!");
 242   TargetMachine &Target = *target.get();
 243
 244   // Figure out where we are going to send the output...
 245   raw_ostream *Out = GetOutputStream(argv[0]);
 246   if (Out == 0) return 1;
 247
 248   // If this target requires addPassesToEmitWholeFile, do it now.  This is
 249   // used by strange things like the C backend.
 250   if (Target.WantsWholeFile()) {
 251     PassManager PM;
 252     PM.add(new TargetData(*Target.getTargetData()));
 253     if (!NoVerify)
 254       PM.add(createVerifierPass());
 255
 256     // Ask the target to add backend passes as necessary.
 257     if (Target.addPassesToEmitWholeFile(PM, *Out, FileType, Fast)) {
 258       std::cerr << argv[0] << ": target does not support generation of this"
 259                 << " file type!\n";
 260       if (Out != &outs()) delete Out;
 261       // And the Out file is empty and useless, so remove it now.
 262       sys::Path(OutputFilename).eraseFromDisk();
 263       return 1;
 264     }
 265     PM.run(mod);
 266   } else {
 267     // Build up all of the passes that we want to do to the module.
 268     ExistingModuleProvider Provider(M.release());
 269     FunctionPassManager Passes(&Provider);
 270     Passes.add(new TargetData(*Target.getTargetData()));
 271
 272 #ifndef NDEBUG
 273     if (!NoVerify)
 274       Passes.add(createVerifierPass());
 275 #endif
 276
 277     // Ask the target to add backend passes as necessary.
 278     MachineCodeEmitter *MCE = 0;
 279
 280     switch (Target.addPassesToEmitFile(Passes, *Out, FileType, Fast)) {
 281     default:
 282       assert(0 && "Invalid file model!");
 283       return 1;
 284     case FileModel::Error:
 285       std::cerr << argv[0] << ": target does not support generation of this"
 286                 << " file type!\n";
 287       if (Out != &outs()) delete Out;
 288       // And the Out file is empty and useless, so remove it now.
 289       sys::Path(OutputFilename).eraseFromDisk();
 290       return 1;
 291     case FileModel::AsmFile:
 292       break;
 293     case FileModel::MachOFile:
 294       MCE = AddMachOWriter(Passes, *Out, Target);
 295       break;
 296     case FileModel::ElfFile:
 297       MCE = AddELFWriter(Passes, *Out, Target);
 298       break;
 299     }
 300
 301     if (Target.addPassesToEmitFileFinish(Passes, MCE, Fast)) {
 302       std::cerr << argv[0] << ": target does not support generation of this"
 303                 << " file type!\n";
 304       if (Out != &outs()) delete Out;
 305       // And the Out file is empty and useless, so remove it now.
 306       sys::Path(OutputFilename).eraseFromDisk();
 307       return 1;
 308     }
 309
 310     Passes.doInitialization();
 311
 312     // Run our queue of passes all at once now, efficiently.
 313     // TODO: this could lazily stream functions out of the module.
 314     for (Module::iterator I = mod.begin(), E = mod.end(); I != E; ++I)
 315       if (!I->isDeclaration())
 316         Passes.run(*I);
 317
 318     Passes.doFinalization();
 319   }
 320
 321   // Delete the ostream if it's not a stdout stream
 322   if (Out != &outs()) delete Out;
 323
 324   return 0;
 325 }