tools/gold/gold-plugin.cpp

   1 //===-- gold-plugin.cpp - Plugin to gold for Link Time Optimization  ------===//
   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 a gold plugin for LLVM. It provides an LLVM implementation of the
  11 // interface described in http://gcc.gnu.org/wiki/whopr/driver .
  12 //
  13 //===----------------------------------------------------------------------===//
  14
  15 #include "llvm/Config/config.h" // plugin-api.h requires HAVE_STDINT_H
  16 #include "llvm/ADT/DenseSet.h"
  17 #include "llvm/ADT/StringSet.h"
  18 #include "llvm/Bitcode/ReaderWriter.h"
  19 #include "llvm/CodeGen/Analysis.h"
  20 #include "llvm/CodeGen/CommandFlags.h"
  21 #include "llvm/IR/Constants.h"
  22 #include "llvm/IR/LLVMContext.h"
  23 #include "llvm/IR/Module.h"
  24 #include "llvm/IR/Verifier.h"
  25 #include "llvm/Linker/Linker.h"
  26 #include "llvm/MC/SubtargetFeature.h"
  27 #include "llvm/Object/IRObjectFile.h"
  28 #include "llvm/PassManager.h"
  29 #include "llvm/Support/FormattedStream.h"
  30 #include "llvm/Support/Host.h"
  31 #include "llvm/Support/ManagedStatic.h"
  32 #include "llvm/Support/MemoryBuffer.h"
  33 #include "llvm/Support/TargetRegistry.h"
  34 #include "llvm/Support/TargetSelect.h"
  35 #include "llvm/Target/TargetLibraryInfo.h"
  36 #include "llvm/Transforms/IPO.h"
  37 #include "llvm/Transforms/IPO/PassManagerBuilder.h"
  38 #include "llvm/Transforms/Utils/GlobalStatus.h"
  39 #include "llvm/Transforms/Utils/ModuleUtils.h"
  40 #include "llvm/Transforms/Utils/ValueMapper.h"
  41 #include <list>
  42 #include <plugin-api.h>
  43 #include <system_error>
  44 #include <vector>
  45
  46 #ifndef LDPO_PIE
  47 // FIXME: remove this declaration when we stop maintaining Ubuntu Quantal and
  48 // Precise and Debian Wheezy (binutils 2.23 is required)
  49 # define LDPO_PIE 3
  50 #endif
  51
  52 using namespace llvm;
  53
  54 namespace {
  55 struct claimed_file {
  56   void *handle;
  57   std::vector<ld_plugin_symbol> syms;
  58 };
  59 }
  60
  61 static ld_plugin_status discard_message(int level, const char *format, ...) {
  62   // Die loudly. Recent versions of Gold pass ld_plugin_message as the first
  63   // callback in the transfer vector. This should never be called.
  64   abort();
  65 }
  66
  67 static ld_plugin_get_input_file get_input_file = nullptr;
  68 static ld_plugin_release_input_file release_input_file = nullptr;
  69 static ld_plugin_add_symbols add_symbols = nullptr;
  70 static ld_plugin_get_symbols get_symbols = nullptr;
  71 static ld_plugin_add_input_file add_input_file = nullptr;
  72 static ld_plugin_set_extra_library_path set_extra_library_path = nullptr;
  73 static ld_plugin_get_view get_view = nullptr;
  74 static ld_plugin_message message = discard_message;
  75 static Reloc::Model RelocationModel = Reloc::Default;
  76 static std::string output_name = "";
  77 static std::list<claimed_file> Modules;
  78 static std::vector<std::string> Cleanup;
  79 static llvm::TargetOptions TargetOpts;
  80
  81 namespace options {
  82   enum OutputType {
  83     OT_NORMAL,
  84     OT_DISABLE,
  85     OT_BC_ONLY,
  86     OT_SAVE_TEMPS
  87   };
  88   static bool generate_api_file = false;
  89   static OutputType TheOutputType = OT_NORMAL;
  90   static std::string obj_path;
  91   static std::string extra_library_path;
  92   static std::string triple;
  93   static std::string mcpu;
  94   // Additional options to pass into the code generator.
  95   // Note: This array will contain all plugin options which are not claimed
  96   // as plugin exclusive to pass to the code generator.
  97   // For example, "generate-api-file" and "as"options are for the plugin
  98   // use only and will not be passed.
  99   static std::vector<const char *> extra;
 100
 101   static void process_plugin_option(const char* opt_)
 102   {
 103     if (opt_ == nullptr)
 104       return;
 105     llvm::StringRef opt = opt_;
 106
 107     if (opt == "generate-api-file") {
 108       generate_api_file = true;
 109     } else if (opt.startswith("mcpu=")) {
 110       mcpu = opt.substr(strlen("mcpu="));
 111     } else if (opt.startswith("extra-library-path=")) {
 112       extra_library_path = opt.substr(strlen("extra_library_path="));
 113     } else if (opt.startswith("mtriple=")) {
 114       triple = opt.substr(strlen("mtriple="));
 115     } else if (opt.startswith("obj-path=")) {
 116       obj_path = opt.substr(strlen("obj-path="));
 117     } else if (opt == "emit-llvm") {
 118       TheOutputType = OT_BC_ONLY;
 119     } else if (opt == "save-temps") {
 120       TheOutputType = OT_SAVE_TEMPS;
 121     } else if (opt == "disable-output") {
 122       TheOutputType = OT_DISABLE;
 123     } else {
 124       // Save this option to pass to the code generator.
 125       // ParseCommandLineOptions() expects argv[0] to be program name. Lazily
 126       // add that.
 127       if (extra.empty())
 128         extra.push_back("LLVMgold");
 129
 130       extra.push_back(opt_);
 131     }
 132   }
 133 }
 134
 135 static ld_plugin_status claim_file_hook(const ld_plugin_input_file *file,
 136                                         int *claimed);
 137 static ld_plugin_status all_symbols_read_hook(void);
 138 static ld_plugin_status cleanup_hook(void);
 139
 140 extern "C" ld_plugin_status onload(ld_plugin_tv *tv);
 141 ld_plugin_status onload(ld_plugin_tv *tv) {
 142   InitializeAllTargetInfos();
 143   InitializeAllTargets();
 144   InitializeAllTargetMCs();
 145   InitializeAllAsmParsers();
 146   InitializeAllAsmPrinters();
 147
 148   // We're given a pointer to the first transfer vector. We read through them
 149   // until we find one where tv_tag == LDPT_NULL. The REGISTER_* tagged values
 150   // contain pointers to functions that we need to call to register our own
 151   // hooks. The others are addresses of functions we can use to call into gold
 152   // for services.
 153
 154   bool registeredClaimFile = false;
 155   bool RegisteredAllSymbolsRead = false;
 156
 157   for (; tv->tv_tag != LDPT_NULL; ++tv) {
 158     switch (tv->tv_tag) {
 159       case LDPT_OUTPUT_NAME:
 160         output_name = tv->tv_u.tv_string;
 161         break;
 162       case LDPT_LINKER_OUTPUT:
 163         switch (tv->tv_u.tv_val) {
 164           case LDPO_REL:  // .o
 165           case LDPO_DYN:  // .so
 166           case LDPO_PIE:  // position independent executable
 167             RelocationModel = Reloc::PIC_;
 168             break;
 169           case LDPO_EXEC:  // .exe
 170             RelocationModel = Reloc::Static;
 171             break;
 172           default:
 173             message(LDPL_ERROR, "Unknown output file type %d", tv->tv_u.tv_val);
 174             return LDPS_ERR;
 175         }
 176         break;
 177       case LDPT_OPTION:
 178         options::process_plugin_option(tv->tv_u.tv_string);
 179         break;
 180       case LDPT_REGISTER_CLAIM_FILE_HOOK: {
 181         ld_plugin_register_claim_file callback;
 182         callback = tv->tv_u.tv_register_claim_file;
 183
 184         if (callback(claim_file_hook) != LDPS_OK)
 185           return LDPS_ERR;
 186
 187         registeredClaimFile = true;
 188       } break;
 189       case LDPT_REGISTER_ALL_SYMBOLS_READ_HOOK: {
 190         ld_plugin_register_all_symbols_read callback;
 191         callback = tv->tv_u.tv_register_all_symbols_read;
 192
 193         if (callback(all_symbols_read_hook) != LDPS_OK)
 194           return LDPS_ERR;
 195
 196         RegisteredAllSymbolsRead = true;
 197       } break;
 198       case LDPT_REGISTER_CLEANUP_HOOK: {
 199         ld_plugin_register_cleanup callback;
 200         callback = tv->tv_u.tv_register_cleanup;
 201
 202         if (callback(cleanup_hook) != LDPS_OK)
 203           return LDPS_ERR;
 204       } break;
 205       case LDPT_GET_INPUT_FILE:
 206         get_input_file = tv->tv_u.tv_get_input_file;
 207         break;
 208       case LDPT_RELEASE_INPUT_FILE:
 209         release_input_file = tv->tv_u.tv_release_input_file;
 210         break;
 211       case LDPT_ADD_SYMBOLS:
 212         add_symbols = tv->tv_u.tv_add_symbols;
 213         break;
 214       case LDPT_GET_SYMBOLS_V2:
 215         get_symbols = tv->tv_u.tv_get_symbols;
 216         break;
 217       case LDPT_ADD_INPUT_FILE:
 218         add_input_file = tv->tv_u.tv_add_input_file;
 219         break;
 220       case LDPT_SET_EXTRA_LIBRARY_PATH:
 221         set_extra_library_path = tv->tv_u.tv_set_extra_library_path;
 222         break;
 223       case LDPT_GET_VIEW:
 224         get_view = tv->tv_u.tv_get_view;
 225         break;
 226       case LDPT_MESSAGE:
 227         message = tv->tv_u.tv_message;
 228         break;
 229       default:
 230         break;
 231     }
 232   }
 233
 234   if (!registeredClaimFile) {
 235     message(LDPL_ERROR, "register_claim_file not passed to LLVMgold.");
 236     return LDPS_ERR;
 237   }
 238   if (!add_symbols) {
 239     message(LDPL_ERROR, "add_symbols not passed to LLVMgold.");
 240     return LDPS_ERR;
 241   }
 242
 243   if (!RegisteredAllSymbolsRead)
 244     return LDPS_OK;
 245
 246   if (!get_input_file) {
 247     message(LDPL_ERROR, "get_input_file not passed to LLVMgold.");
 248     return LDPS_ERR;
 249   }
 250   if (!release_input_file) {
 251     message(LDPL_ERROR, "relesase_input_file not passed to LLVMgold.");
 252     return LDPS_ERR;
 253   }
 254
 255   return LDPS_OK;
 256 }
 257
 258 static const GlobalObject *getBaseObject(const GlobalValue &GV) {
 259   if (auto *GA = dyn_cast<GlobalAlias>(&GV))
 260     return GA->getBaseObject();
 261   return cast<GlobalObject>(&GV);
 262 }
 263
 264 /// Called by gold to see whether this file is one that our plugin can handle.
 265 /// We'll try to open it and register all the symbols with add_symbol if
 266 /// possible.
 267 static ld_plugin_status claim_file_hook(const ld_plugin_input_file *file,
 268                                         int *claimed) {
 269   LLVMContext Context;
 270   MemoryBufferRef BufferRef;
 271   std::unique_ptr<MemoryBuffer> Buffer;
 272   if (get_view) {
 273     const void *view;
 274     if (get_view(file->handle, &view) != LDPS_OK) {
 275       message(LDPL_ERROR, "Failed to get a view of %s", file->name);
 276       return LDPS_ERR;
 277     }
 278     BufferRef = MemoryBufferRef(StringRef((const char *)view, file->filesize), "");
 279   } else {
 280     int64_t offset = 0;
 281     // Gold has found what might be IR part-way inside of a file, such as
 282     // an .a archive.
 283     if (file->offset) {
 284       offset = file->offset;
 285     }
 286     ErrorOr<std::unique_ptr<MemoryBuffer>> BufferOrErr =
 287         MemoryBuffer::getOpenFileSlice(file->fd, file->name, file->filesize,
 288                                        offset);
 289     if (std::error_code EC = BufferOrErr.getError()) {
 290       message(LDPL_ERROR, EC.message().c_str());
 291       return LDPS_ERR;
 292     }
 293     Buffer = std::move(BufferOrErr.get());
 294     BufferRef = Buffer->getMemBufferRef();
 295   }
 296
 297   ErrorOr<std::unique_ptr<object::IRObjectFile>> ObjOrErr =
 298       object::IRObjectFile::createIRObjectFile(BufferRef, Context);
 299   std::error_code EC = ObjOrErr.getError();
 300   if (EC == BitcodeError::InvalidBitcodeSignature ||
 301       EC == object::object_error::invalid_file_type ||
 302       EC == object::object_error::bitcode_section_not_found)
 303     return LDPS_OK;
 304
 305   *claimed = 1;
 306
 307   if (EC) {
 308     message(LDPL_ERROR, "LLVM gold plugin has failed to create LTO module: %s",
 309             EC.message().c_str());
 310     return LDPS_ERR;
 311   }
 312   std::unique_ptr<object::IRObjectFile> Obj = std::move(*ObjOrErr);
 313
 314   Modules.resize(Modules.size() + 1);
 315   claimed_file &cf = Modules.back();
 316
 317   cf.handle = file->handle;
 318
 319   for (auto &Sym : Obj->symbols()) {
 320     uint32_t Symflags = Sym.getFlags();
 321     if (!(Symflags & object::BasicSymbolRef::SF_Global))
 322       continue;
 323
 324     if (Symflags & object::BasicSymbolRef::SF_FormatSpecific)
 325       continue;
 326
 327     cf.syms.push_back(ld_plugin_symbol());
 328     ld_plugin_symbol &sym = cf.syms.back();
 329     sym.version = nullptr;
 330
 331     SmallString<64> Name;
 332     {
 333       raw_svector_ostream OS(Name);
 334       Sym.printName(OS);
 335     }
 336     sym.name = strdup(Name.c_str());
 337
 338     const GlobalValue *GV = Obj->getSymbolGV(Sym.getRawDataRefImpl());
 339
 340     sym.visibility = LDPV_DEFAULT;
 341     if (GV) {
 342       switch (GV->getVisibility()) {
 343       case GlobalValue::DefaultVisibility:
 344         sym.visibility = LDPV_DEFAULT;
 345         break;
 346       case GlobalValue::HiddenVisibility:
 347         sym.visibility = LDPV_HIDDEN;
 348         break;
 349       case GlobalValue::ProtectedVisibility:
 350         sym.visibility = LDPV_PROTECTED;
 351         break;
 352       }
 353     }
 354
 355     if (Symflags & object::BasicSymbolRef::SF_Undefined) {
 356       sym.def = LDPK_UNDEF;
 357       if (GV && GV->hasExternalWeakLinkage())
 358         sym.def = LDPK_WEAKUNDEF;
 359     } else {
 360       sym.def = LDPK_DEF;
 361       if (GV) {
 362         assert(!GV->hasExternalWeakLinkage() &&
 363                !GV->hasAvailableExternallyLinkage() && "Not a declaration!");
 364         if (GV->hasCommonLinkage())
 365           sym.def = LDPK_COMMON;
 366         else if (GV->isWeakForLinker())
 367           sym.def = LDPK_WEAKDEF;
 368       }
 369     }
 370
 371     sym.size = 0;
 372     sym.comdat_key = nullptr;
 373     if (GV) {
 374       const GlobalObject *Base = getBaseObject(*GV);
 375       if (!Base)
 376         message(LDPL_FATAL, "Unable to determine comdat of alias!");
 377       const Comdat *C = Base->getComdat();
 378       if (C)
 379         sym.comdat_key = strdup(C->getName().str().c_str());
 380       else if (Base->hasWeakLinkage() || Base->hasLinkOnceLinkage())
 381         sym.comdat_key = strdup(sym.name);
 382     }
 383
 384     sym.resolution = LDPR_UNKNOWN;
 385   }
 386
 387   if (!cf.syms.empty()) {
 388     if (add_symbols(cf.handle, cf.syms.size(), &cf.syms[0]) != LDPS_OK) {
 389       message(LDPL_ERROR, "Unable to add symbols!");
 390       return LDPS_ERR;
 391     }
 392   }
 393
 394   return LDPS_OK;
 395 }
 396
 397 static void keepGlobalValue(GlobalValue &GV,
 398                             std::vector<GlobalAlias *> &KeptAliases) {
 399   assert(!GV.hasLocalLinkage());
 400
 401   if (auto *GA = dyn_cast<GlobalAlias>(&GV))
 402     KeptAliases.push_back(GA);
 403
 404   switch (GV.getLinkage()) {
 405   default:
 406     break;
 407   case GlobalValue::LinkOnceAnyLinkage:
 408     GV.setLinkage(GlobalValue::WeakAnyLinkage);
 409     break;
 410   case GlobalValue::LinkOnceODRLinkage:
 411     GV.setLinkage(GlobalValue::WeakODRLinkage);
 412     break;
 413   }
 414
 415   assert(!GV.isDiscardableIfUnused());
 416 }
 417
 418 static void internalize(GlobalValue &GV) {
 419   if (GV.isDeclarationForLinker())
 420     return; // We get here if there is a matching asm definition.
 421   if (!GV.hasLocalLinkage())
 422     GV.setLinkage(GlobalValue::InternalLinkage);
 423 }
 424
 425 static void drop(GlobalValue &GV) {
 426   if (auto *F = dyn_cast<Function>(&GV)) {
 427     F->deleteBody();
 428     F->setComdat(nullptr); // Should deleteBody do this?
 429     return;
 430   }
 431
 432   if (auto *Var = dyn_cast<GlobalVariable>(&GV)) {
 433     Var->setInitializer(nullptr);
 434     Var->setLinkage(
 435         GlobalValue::ExternalLinkage); // Should setInitializer do this?
 436     Var->setComdat(nullptr); // and this?
 437     return;
 438   }
 439
 440   auto &Alias = cast<GlobalAlias>(GV);
 441   Module &M = *Alias.getParent();
 442   PointerType &Ty = *cast<PointerType>(Alias.getType());
 443   GlobalValue::LinkageTypes L = Alias.getLinkage();
 444   auto *Var =
 445       new GlobalVariable(M, Ty.getElementType(), /*isConstant*/ false, L,
 446                          /*Initializer*/ nullptr);
 447   Var->takeName(&Alias);
 448   Alias.replaceAllUsesWith(Var);
 449   Alias.eraseFromParent();
 450 }
 451
 452 static const char *getResolutionName(ld_plugin_symbol_resolution R) {
 453   switch (R) {
 454   case LDPR_UNKNOWN:
 455     return "UNKNOWN";
 456   case LDPR_UNDEF:
 457     return "UNDEF";
 458   case LDPR_PREVAILING_DEF:
 459     return "PREVAILING_DEF";
 460   case LDPR_PREVAILING_DEF_IRONLY:
 461     return "PREVAILING_DEF_IRONLY";
 462   case LDPR_PREEMPTED_REG:
 463     return "PREEMPTED_REG";
 464   case LDPR_PREEMPTED_IR:
 465     return "PREEMPTED_IR";
 466   case LDPR_RESOLVED_IR:
 467     return "RESOLVED_IR";
 468   case LDPR_RESOLVED_EXEC:
 469     return "RESOLVED_EXEC";
 470   case LDPR_RESOLVED_DYN:
 471     return "RESOLVED_DYN";
 472   case LDPR_PREVAILING_DEF_IRONLY_EXP:
 473     return "PREVAILING_DEF_IRONLY_EXP";
 474   }
 475   llvm_unreachable("Unknown resolution");
 476 }
 477
 478 static GlobalObject *makeInternalReplacement(GlobalObject *GO) {
 479   Module *M = GO->getParent();
 480   GlobalObject *Ret;
 481   if (auto *F = dyn_cast<Function>(GO)) {
 482     if (F->materialize())
 483       message(LDPL_FATAL, "LLVM gold plugin has failed to read a function");
 484
 485     auto *NewF = Function::Create(F->getFunctionType(), F->getLinkage(),
 486                                   F->getName(), M);
 487
 488     ValueToValueMapTy VM;
 489     Function::arg_iterator NewI = NewF->arg_begin();
 490     for (auto &Arg : F->args()) {
 491       NewI->setName(Arg.getName());
 492       VM[&Arg] = NewI;
 493       ++NewI;
 494     }
 495
 496     NewF->getBasicBlockList().splice(NewF->end(), F->getBasicBlockList());
 497     for (auto &BB : *NewF) {
 498       for (auto &Inst : BB)
 499         RemapInstruction(&Inst, VM, RF_IgnoreMissingEntries);
 500     }
 501
 502     Ret = NewF;
 503     F->deleteBody();
 504   } else {
 505     auto *Var = cast<GlobalVariable>(GO);
 506     Ret = new GlobalVariable(
 507         *M, Var->getType()->getElementType(), Var->isConstant(),
 508         Var->getLinkage(), Var->getInitializer(), Var->getName(),
 509         nullptr, Var->getThreadLocalMode(), Var->getType()->getAddressSpace(),
 510         Var->isExternallyInitialized());
 511     Var->setInitializer(nullptr);
 512   }
 513   Ret->copyAttributesFrom(GO);
 514   Ret->setLinkage(GlobalValue::InternalLinkage);
 515   Ret->setComdat(GO->getComdat());
 516
 517   return Ret;
 518 }
 519
 520 namespace {
 521 class LocalValueMaterializer : public ValueMaterializer {
 522   DenseSet<GlobalValue *> &Dropped;
 523
 524 public:
 525   LocalValueMaterializer(DenseSet<GlobalValue *> &Dropped) : Dropped(Dropped) {}
 526   Value *materializeValueFor(Value *V) override;
 527 };
 528 }
 529
 530 Value *LocalValueMaterializer::materializeValueFor(Value *V) {
 531   auto *GV = dyn_cast<GlobalValue>(V);
 532   if (!GV)
 533     return nullptr;
 534   if (!Dropped.count(GV))
 535     return nullptr;
 536   assert(!isa<GlobalAlias>(GV) && "Found alias point to weak alias.");
 537   return makeInternalReplacement(cast<GlobalObject>(GV));
 538 }
 539
 540 static Constant *mapConstantToLocalCopy(Constant *C, ValueToValueMapTy &VM,
 541                                         LocalValueMaterializer *Materializer) {
 542   return MapValue(C, VM, RF_IgnoreMissingEntries, nullptr, Materializer);
 543 }
 544
 545 static std::unique_ptr<Module>
 546 getModuleForFile(LLVMContext &Context, claimed_file &F, raw_fd_ostream *ApiFile,
 547                  StringSet<> &Internalize, StringSet<> &Maybe) {
 548   ld_plugin_input_file File;
 549   if (get_input_file(F.handle, &File) != LDPS_OK)
 550     message(LDPL_FATAL, "Failed to get file information");
 551
 552   if (get_symbols(F.handle, F.syms.size(), &F.syms[0]) != LDPS_OK)
 553     message(LDPL_FATAL, "Failed to get symbol information");
 554
 555   const void *View;
 556   if (get_view(F.handle, &View) != LDPS_OK)
 557     message(LDPL_FATAL, "Failed to get a view of file");
 558
 559   llvm::ErrorOr<MemoryBufferRef> MBOrErr =
 560       object::IRObjectFile::findBitcodeInMemBuffer(
 561           MemoryBufferRef(StringRef((const char *)View, File.filesize), ""));
 562   if (std::error_code EC = MBOrErr.getError())
 563     message(LDPL_FATAL, "Could not read bitcode from file : %s",
 564             EC.message().c_str());
 565
 566   std::unique_ptr<MemoryBuffer> Buffer =
 567       MemoryBuffer::getMemBuffer(MBOrErr->getBuffer(), "", false);
 568
 569   if (release_input_file(F.handle) != LDPS_OK)
 570     message(LDPL_FATAL, "Failed to release file information");
 571
 572   ErrorOr<Module *> MOrErr = getLazyBitcodeModule(std::move(Buffer), Context);
 573
 574   if (std::error_code EC = MOrErr.getError())
 575     message(LDPL_FATAL, "Could not read bitcode from file : %s",
 576             EC.message().c_str());
 577
 578   std::unique_ptr<Module> M(MOrErr.get());
 579
 580   SmallPtrSet<GlobalValue *, 8> Used;
 581   collectUsedGlobalVariables(*M, Used, /*CompilerUsed*/ false);
 582
 583   DenseSet<GlobalValue *> Drop;
 584   std::vector<GlobalAlias *> KeptAliases;
 585   for (ld_plugin_symbol &Sym : F.syms) {
 586     ld_plugin_symbol_resolution Resolution =
 587         (ld_plugin_symbol_resolution)Sym.resolution;
 588
 589     if (options::generate_api_file)
 590       *ApiFile << Sym.name << ' ' << getResolutionName(Resolution) << '\n';
 591
 592     GlobalValue *GV = M->getNamedValue(Sym.name);
 593     if (!GV)
 594       continue; // Asm symbol.
 595
 596     if (Resolution != LDPR_PREVAILING_DEF_IRONLY && GV->hasCommonLinkage()) {
 597       // Common linkage is special. There is no single symbol that wins the
 598       // resolution. Instead we have to collect the maximum alignment and size.
 599       // The IR linker does that for us if we just pass it every common GV.
 600       // We still have to keep track of LDPR_PREVAILING_DEF_IRONLY so we
 601       // internalize once the IR linker has done its job.
 602       continue;
 603     }
 604
 605     switch (Resolution) {
 606     case LDPR_UNKNOWN:
 607       llvm_unreachable("Unexpected resolution");
 608
 609     case LDPR_RESOLVED_IR:
 610     case LDPR_RESOLVED_EXEC:
 611     case LDPR_RESOLVED_DYN:
 612     case LDPR_UNDEF:
 613       assert(GV->isDeclarationForLinker());
 614       break;
 615
 616     case LDPR_PREVAILING_DEF_IRONLY: {
 617       keepGlobalValue(*GV, KeptAliases);
 618       if (!Used.count(GV)) {
 619         // Since we use the regular lib/Linker, we cannot just internalize GV
 620         // now or it will not be copied to the merged module. Instead we force
 621         // it to be copied and then internalize it.
 622         Internalize.insert(Sym.name);
 623       }
 624       break;
 625     }
 626
 627     case LDPR_PREVAILING_DEF:
 628       keepGlobalValue(*GV, KeptAliases);
 629       break;
 630
 631     case LDPR_PREEMPTED_IR:
 632       // Gold might have selected a linkonce_odr and preempted a weak_odr.
 633       // In that case we have to make sure we don't end up internalizing it.
 634       if (!GV->isDiscardableIfUnused())
 635         Maybe.erase(Sym.name);
 636
 637       // fall-through
 638     case LDPR_PREEMPTED_REG:
 639       Drop.insert(GV);
 640       break;
 641
 642     case LDPR_PREVAILING_DEF_IRONLY_EXP: {
 643       // We can only check for address uses after we merge the modules. The
 644       // reason is that this GV might have a copy in another module
 645       // and in that module the address might be significant, but that
 646       // copy will be LDPR_PREEMPTED_IR.
 647       if (GV->hasLinkOnceODRLinkage())
 648         Maybe.insert(Sym.name);
 649       keepGlobalValue(*GV, KeptAliases);
 650       break;
 651     }
 652     }
 653
 654     free(Sym.name);
 655     free(Sym.comdat_key);
 656     Sym.name = nullptr;
 657     Sym.comdat_key = nullptr;
 658   }
 659
 660   ValueToValueMapTy VM;
 661   LocalValueMaterializer Materializer(Drop);
 662   for (GlobalAlias *GA : KeptAliases) {
 663     // Gold told us to keep GA. It is possible that a GV usied in the aliasee
 664     // expression is being dropped. If that is the case, that GV must be copied.
 665     Constant *Aliasee = GA->getAliasee();
 666     Constant *Replacement = mapConstantToLocalCopy(Aliasee, VM, &Materializer);
 667     if (Aliasee != Replacement)
 668       GA->setAliasee(Replacement);
 669   }
 670
 671   for (auto *GV : Drop)
 672     drop(*GV);
 673
 674   return M;
 675 }
 676
 677 static void runLTOPasses(Module &M, TargetMachine &TM) {
 678   PassManager passes;
 679   PassManagerBuilder PMB;
 680   PMB.LibraryInfo = new TargetLibraryInfo(Triple(TM.getTargetTriple()));
 681   PMB.Inliner = createFunctionInliningPass();
 682   PMB.VerifyInput = true;
 683   PMB.VerifyOutput = true;
 684   PMB.LoopVectorize = true;
 685   PMB.SLPVectorize = true;
 686   PMB.populateLTOPassManager(passes, &TM);
 687   passes.run(M);
 688 }
 689
 690 static void saveBCFile(StringRef Path, Module &M) {
 691   std::error_code EC;
 692   raw_fd_ostream OS(Path, EC, sys::fs::OpenFlags::F_None);
 693   if (EC)
 694     message(LDPL_FATAL, "Failed to write the output file.");
 695   WriteBitcodeToFile(&M, OS);
 696 }
 697
 698 static void codegen(Module &M) {
 699   const std::string &TripleStr = M.getTargetTriple();
 700   Triple TheTriple(TripleStr);
 701
 702   std::string ErrMsg;
 703   const Target *TheTarget = TargetRegistry::lookupTarget(TripleStr, ErrMsg);
 704   if (!TheTarget)
 705     message(LDPL_FATAL, "Target not found: %s", ErrMsg.c_str());
 706
 707   if (unsigned NumOpts = options::extra.size())
 708     cl::ParseCommandLineOptions(NumOpts, &options::extra[0]);
 709
 710   SubtargetFeatures Features;
 711   Features.getDefaultSubtargetFeatures(TheTriple);
 712   for (const std::string &A : MAttrs)
 713     Features.AddFeature(A);
 714
 715   TargetOptions Options = InitTargetOptionsFromCodeGenFlags();
 716   std::unique_ptr<TargetMachine> TM(TheTarget->createTargetMachine(
 717       TripleStr, options::mcpu, Features.getString(), Options, RelocationModel,
 718       CodeModel::Default, CodeGenOpt::Aggressive));
 719
 720   runLTOPasses(M, *TM);
 721
 722   if (options::TheOutputType == options::OT_SAVE_TEMPS)
 723     saveBCFile(output_name + ".opt.bc", M);
 724
 725   PassManager CodeGenPasses;
 726   CodeGenPasses.add(new DataLayoutPass());
 727
 728   SmallString<128> Filename;
 729   int FD;
 730   if (options::obj_path.empty()) {
 731     std::error_code EC =
 732         sys::fs::createTemporaryFile("lto-llvm", "o", FD, Filename);
 733     if (EC)
 734       message(LDPL_FATAL, "Could not create temporary file: %s",
 735               EC.message().c_str());
 736   } else {
 737     Filename = options::obj_path;
 738     std::error_code EC =
 739         sys::fs::openFileForWrite(Filename.c_str(), FD, sys::fs::F_None);
 740     if (EC)
 741       message(LDPL_FATAL, "Could not open file: %s", EC.message().c_str());
 742   }
 743
 744   {
 745     raw_fd_ostream OS(FD, true);
 746     formatted_raw_ostream FOS(OS);
 747
 748     if (TM->addPassesToEmitFile(CodeGenPasses, FOS,
 749                                 TargetMachine::CGFT_ObjectFile))
 750       message(LDPL_FATAL, "Failed to setup codegen");
 751     CodeGenPasses.run(M);
 752   }
 753
 754   if (add_input_file(Filename.c_str()) != LDPS_OK)
 755     message(LDPL_FATAL,
 756             "Unable to add .o file to the link. File left behind in: %s",
 757             Filename.c_str());
 758
 759   if (options::obj_path.empty())
 760     Cleanup.push_back(Filename.c_str());
 761 }
 762
 763 /// gold informs us that all symbols have been read. At this point, we use
 764 /// get_symbols to see if any of our definitions have been overridden by a
 765 /// native object file. Then, perform optimization and codegen.
 766 static ld_plugin_status allSymbolsReadHook(raw_fd_ostream *ApiFile) {
 767   if (Modules.empty())
 768     return LDPS_OK;
 769
 770   LLVMContext Context;
 771   std::unique_ptr<Module> Combined(new Module("ld-temp.o", Context));
 772   Linker L(Combined.get());
 773
 774   std::string DefaultTriple = sys::getDefaultTargetTriple();
 775
 776   StringSet<> Internalize;
 777   StringSet<> Maybe;
 778   for (claimed_file &F : Modules) {
 779     std::unique_ptr<Module> M =
 780         getModuleForFile(Context, F, ApiFile, Internalize, Maybe);
 781     if (!options::triple.empty())
 782       M->setTargetTriple(options::triple.c_str());
 783     else if (M->getTargetTriple().empty()) {
 784       M->setTargetTriple(DefaultTriple);
 785     }
 786
 787     if (L.linkInModule(M.get()))
 788       message(LDPL_FATAL, "Failed to link module");
 789   }
 790
 791   for (const auto &Name : Internalize) {
 792     GlobalValue *GV = Combined->getNamedValue(Name.first());
 793     if (GV)
 794       internalize(*GV);
 795   }
 796
 797   for (const auto &Name : Maybe) {
 798     GlobalValue *GV = Combined->getNamedValue(Name.first());
 799     if (!GV)
 800       continue;
 801     GV->setLinkage(GlobalValue::LinkOnceODRLinkage);
 802     if (canBeOmittedFromSymbolTable(GV))
 803       internalize(*GV);
 804   }
 805
 806   if (options::TheOutputType == options::OT_DISABLE)
 807     return LDPS_OK;
 808
 809   if (options::TheOutputType != options::OT_NORMAL) {
 810     std::string path;
 811     if (options::TheOutputType == options::OT_BC_ONLY)
 812       path = output_name;
 813     else
 814       path = output_name + ".bc";
 815     saveBCFile(path, *L.getModule());
 816     if (options::TheOutputType == options::OT_BC_ONLY)
 817       return LDPS_OK;
 818   }
 819
 820   codegen(*L.getModule());
 821
 822   if (!options::extra_library_path.empty() &&
 823       set_extra_library_path(options::extra_library_path.c_str()) != LDPS_OK)
 824     message(LDPL_FATAL, "Unable to set the extra library path.");
 825
 826   return LDPS_OK;
 827 }
 828
 829 static ld_plugin_status all_symbols_read_hook(void) {
 830   ld_plugin_status Ret;
 831   if (!options::generate_api_file) {
 832     Ret = allSymbolsReadHook(nullptr);
 833   } else {
 834     std::error_code EC;
 835     raw_fd_ostream ApiFile("apifile.txt", EC, sys::fs::F_None);
 836     if (EC)
 837       message(LDPL_FATAL, "Unable to open apifile.txt for writing: %s",
 838               EC.message().c_str());
 839     Ret = allSymbolsReadHook(&ApiFile);
 840   }
 841
 842   llvm_shutdown();
 843
 844   if (options::TheOutputType == options::OT_BC_ONLY ||
 845       options::TheOutputType == options::OT_DISABLE)
 846     exit(0);
 847
 848   return Ret;
 849 }
 850
 851 static ld_plugin_status cleanup_hook(void) {
 852   for (std::string &Name : Cleanup) {
 853     std::error_code EC = sys::fs::remove(Name);
 854     if (EC)
 855       message(LDPL_ERROR, "Failed to delete '%s': %s", Name.c_str(),
 856               EC.message().c_str());
 857   }
 858
 859   return LDPS_OK;
 860 }