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(), 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   switch (FileType) {
 146   case TargetMachine::AssemblyFile:
 147     if (MArch->Name[0] == 'c') {
 148       if (MArch->Name[1] == 0)
 149         OutputFilename += ".cbe.c";
 150       else if (MArch->Name[1] == 'p' && MArch->Name[2] == 'p')
 151         OutputFilename += ".cpp";
 152       else
 153         OutputFilename += ".s";
 154     } else
 155       OutputFilename += ".s";
 156     break;
 157   case TargetMachine::ObjectFile:
 158     OutputFilename += ".o";
 159     break;
 160   case TargetMachine::DynamicLibrary:
 161     OutputFilename += LTDL_SHLIB_EXT;
 162     break;
 163   }
 164
 165   if (!Force && std::ifstream(OutputFilename.c_str())) {
 166     // If force is not specified, make sure not to overwrite a file!
 167     std::cerr << ProgName << ": error opening '" << OutputFilename
 168                           << "': file exists!\n"
 169                           << "Use -f command line argument to force output\n";
 170     return 0;
 171   }
 172
 173   // Make sure that the Out file gets unlinked from the disk if we get a
 174   // SIGINT
 175   sys::RemoveFileOnSignal(sys::Path(OutputFilename));
 176
 177   std::string error;
 178   raw_ostream *Out = new raw_fd_ostream(OutputFilename.c_str(), error);
 179   if (!error.empty()) {
 180     std::cerr << error << '\n';
 181     delete Out;
 182     return 0;
 183   }
 184
 185   return Out;
 186 }
 187
 188 // main - Entry point for the llc compiler.
 189 //
 190 int main(int argc, char **argv) {
 191   llvm_shutdown_obj X;  // Call llvm_shutdown() on exit.
 192   cl::ParseCommandLineOptions(argc, argv, "llvm system compiler\n");
 193   sys::PrintStackTraceOnErrorSignal();
 194
 195   // Load the module to be compiled...
 196   std::string ErrorMessage;
 197   std::auto_ptr<Module> M;
 198
 199   std::auto_ptr<MemoryBuffer> Buffer(
 200                    MemoryBuffer::getFileOrSTDIN(InputFilename, &ErrorMessage));
 201   if (Buffer.get())
 202     M.reset(ParseBitcodeFile(Buffer.get(), &ErrorMessage));
 203   if (M.get() == 0) {
 204     std::cerr << argv[0] << ": bitcode didn't read correctly.\n";
 205     std::cerr << "Reason: " << ErrorMessage << "\n";
 206     return 1;
 207   }
 208   Module &mod = *M.get();
 209
 210   // If we are supposed to override the target triple, do so now.
 211   if (!TargetTriple.empty())
 212     mod.setTargetTriple(TargetTriple);
 213
 214   // Allocate target machine.  First, check whether the user has
 215   // explicitly specified an architecture to compile for.
 216   if (MArch == 0) {
 217     std::string Err;
 218     MArch = TargetMachineRegistry::getClosestStaticTargetForModule(mod, Err);
 219     if (MArch == 0) {
 220       std::cerr << argv[0] << ": error auto-selecting target for module '"
 221                 << Err << "'.  Please use the -march option to explicitly "
 222                 << "pick a target.\n";
 223       return 1;
 224     }
 225   }
 226
 227   // Package up features to be passed to target/subtarget
 228   std::string FeaturesStr;
 229   if (MCPU.size() || MAttrs.size()) {
 230     SubtargetFeatures Features;
 231     Features.setCPU(MCPU);
 232     for (unsigned i = 0; i != MAttrs.size(); ++i)
 233       Features.AddFeature(MAttrs[i]);
 234     FeaturesStr = Features.getString();
 235   }
 236
 237   std::auto_ptr<TargetMachine> target(MArch->CtorFn(mod, FeaturesStr));
 238   assert(target.get() && "Could not allocate target machine!");
 239   TargetMachine &Target = *target.get();
 240
 241   // Figure out where we are going to send the output...
 242   raw_ostream *Out = GetOutputStream(argv[0]);
 243   if (Out == 0) return 1;
 244
 245   // If this target requires addPassesToEmitWholeFile, do it now.  This is
 246   // used by strange things like the C backend.
 247   if (Target.WantsWholeFile()) {
 248     PassManager PM;
 249     PM.add(new TargetData(*Target.getTargetData()));
 250     if (!NoVerify)
 251       PM.add(createVerifierPass());
 252
 253     // Ask the target to add backend passes as necessary.
 254     if (Target.addPassesToEmitWholeFile(PM, *Out, FileType, Fast)) {
 255       std::cerr << argv[0] << ": target does not support generation of this"
 256                 << " file type!\n";
 257       if (Out != &outs()) delete Out;
 258       // And the Out file is empty and useless, so remove it now.
 259       sys::Path(OutputFilename).eraseFromDisk();
 260       return 1;
 261     }
 262     PM.run(mod);
 263   } else {
 264     // Build up all of the passes that we want to do to the module.
 265     ExistingModuleProvider Provider(M.release());
 266     FunctionPassManager Passes(&Provider);
 267     Passes.add(new TargetData(*Target.getTargetData()));
 268
 269 #ifndef NDEBUG
 270     if (!NoVerify)
 271       Passes.add(createVerifierPass());
 272 #endif
 273
 274     // Ask the target to add backend passes as necessary.
 275     MachineCodeEmitter *MCE = 0;
 276
 277     switch (Target.addPassesToEmitFile(Passes, *Out, FileType, Fast)) {
 278     default:
 279       assert(0 && "Invalid file model!");
 280       return 1;
 281     case FileModel::Error:
 282       std::cerr << argv[0] << ": target does not support generation of this"
 283                 << " file type!\n";
 284       if (Out != &outs()) delete Out;
 285       // And the Out file is empty and useless, so remove it now.
 286       sys::Path(OutputFilename).eraseFromDisk();
 287       return 1;
 288     case FileModel::AsmFile:
 289       break;
 290     case FileModel::MachOFile:
 291       MCE = AddMachOWriter(Passes, *Out, Target);
 292       break;
 293     case FileModel::ElfFile:
 294       MCE = AddELFWriter(Passes, *Out, Target);
 295       break;
 296     }
 297
 298     if (Target.addPassesToEmitFileFinish(Passes, MCE, Fast)) {
 299       std::cerr << argv[0] << ": target does not support generation of this"
 300                 << " file type!\n";
 301       if (Out != &outs()) delete Out;
 302       // And the Out file is empty and useless, so remove it now.
 303       sys::Path(OutputFilename).eraseFromDisk();
 304       return 1;
 305     }
 306
 307     Passes.doInitialization();
 308
 309     // Run our queue of passes all at once now, efficiently.
 310     // TODO: this could lazily stream functions out of the module.
 311     for (Module::iterator I = mod.begin(), E = mod.end(); I != E; ++I)
 312       if (!I->isDeclaration())
 313         Passes.run(*I);
 314
 315     Passes.doFinalization();
 316   }
 317
 318   // Delete the ostream if it's not a stdout stream
 319   if (Out != &outs()) delete Out;
 320
 321   return 0;
 322 }