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