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