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 static bool shouldSkip(uint32_t Symflags) {
 265   if (!(Symflags & object::BasicSymbolRef::SF_Global))
 266     return true;
 267   if (Symflags & object::BasicSymbolRef::SF_FormatSpecific)
 268     return true;
 269   return false;
 270 }
 271
 272 /// Called by gold to see whether this file is one that our plugin can handle.
 273 /// We'll try to open it and register all the symbols with add_symbol if
 274 /// possible.
 275 static ld_plugin_status claim_file_hook(const ld_plugin_input_file *file,
 276                                         int *claimed) {
 277   LLVMContext Context;
 278   MemoryBufferRef BufferRef;
 279   std::unique_ptr<MemoryBuffer> Buffer;
 280   if (get_view) {
 281     const void *view;
 282     if (get_view(file->handle, &view) != LDPS_OK) {
 283       message(LDPL_ERROR, "Failed to get a view of %s", file->name);
 284       return LDPS_ERR;
 285     }
 286     BufferRef = MemoryBufferRef(StringRef((const char *)view, file->filesize), "");
 287   } else {
 288     int64_t offset = 0;
 289     // Gold has found what might be IR part-way inside of a file, such as
 290     // an .a archive.
 291     if (file->offset) {
 292       offset = file->offset;
 293     }
 294     ErrorOr<std::unique_ptr<MemoryBuffer>> BufferOrErr =
 295         MemoryBuffer::getOpenFileSlice(file->fd, file->name, file->filesize,
 296                                        offset);
 297     if (std::error_code EC = BufferOrErr.getError()) {
 298       message(LDPL_ERROR, EC.message().c_str());
 299       return LDPS_ERR;
 300     }
 301     Buffer = std::move(BufferOrErr.get());
 302     BufferRef = Buffer->getMemBufferRef();
 303   }
 304
 305   ErrorOr<std::unique_ptr<object::IRObjectFile>> ObjOrErr =
 306       object::IRObjectFile::create(BufferRef, Context);
 307   std::error_code EC = ObjOrErr.getError();
 308   if (EC == BitcodeError::InvalidBitcodeSignature ||
 309       EC == object::object_error::invalid_file_type ||
 310       EC == object::object_error::bitcode_section_not_found)
 311     return LDPS_OK;
 312
 313   *claimed = 1;
 314
 315   if (EC) {
 316     message(LDPL_ERROR, "LLVM gold plugin has failed to create LTO module: %s",
 317             EC.message().c_str());
 318     return LDPS_ERR;
 319   }
 320   std::unique_ptr<object::IRObjectFile> Obj = std::move(*ObjOrErr);
 321
 322   Modules.resize(Modules.size() + 1);
 323   claimed_file &cf = Modules.back();
 324
 325   cf.handle = file->handle;
 326
 327   for (auto &Sym : Obj->symbols()) {
 328     uint32_t Symflags = Sym.getFlags();
 329     if (shouldSkip(Symflags))
 330       continue;
 331
 332     cf.syms.push_back(ld_plugin_symbol());
 333     ld_plugin_symbol &sym = cf.syms.back();
 334     sym.version = nullptr;
 335
 336     SmallString<64> Name;
 337     {
 338       raw_svector_ostream OS(Name);
 339       Sym.printName(OS);
 340     }
 341     sym.name = strdup(Name.c_str());
 342
 343     const GlobalValue *GV = Obj->getSymbolGV(Sym.getRawDataRefImpl());
 344
 345     sym.visibility = LDPV_DEFAULT;
 346     if (GV) {
 347       switch (GV->getVisibility()) {
 348       case GlobalValue::DefaultVisibility:
 349         sym.visibility = LDPV_DEFAULT;
 350         break;
 351       case GlobalValue::HiddenVisibility:
 352         sym.visibility = LDPV_HIDDEN;
 353         break;
 354       case GlobalValue::ProtectedVisibility:
 355         sym.visibility = LDPV_PROTECTED;
 356         break;
 357       }
 358     }
 359
 360     if (Symflags & object::BasicSymbolRef::SF_Undefined) {
 361       sym.def = LDPK_UNDEF;
 362       if (GV && GV->hasExternalWeakLinkage())
 363         sym.def = LDPK_WEAKUNDEF;
 364     } else {
 365       sym.def = LDPK_DEF;
 366       if (GV) {
 367         assert(!GV->hasExternalWeakLinkage() &&
 368                !GV->hasAvailableExternallyLinkage() && "Not a declaration!");
 369         if (GV->hasCommonLinkage())
 370           sym.def = LDPK_COMMON;
 371         else if (GV->isWeakForLinker())
 372           sym.def = LDPK_WEAKDEF;
 373       }
 374     }
 375
 376     sym.size = 0;
 377     sym.comdat_key = nullptr;
 378     if (GV) {
 379       const GlobalObject *Base = getBaseObject(*GV);
 380       if (!Base)
 381         message(LDPL_FATAL, "Unable to determine comdat of alias!");
 382       const Comdat *C = Base->getComdat();
 383       if (C)
 384         sym.comdat_key = strdup(C->getName().str().c_str());
 385       else if (Base->hasWeakLinkage() || Base->hasLinkOnceLinkage())
 386         sym.comdat_key = strdup(sym.name);
 387     }
 388
 389     sym.resolution = LDPR_UNKNOWN;
 390   }
 391
 392   if (!cf.syms.empty()) {
 393     if (add_symbols(cf.handle, cf.syms.size(), &cf.syms[0]) != LDPS_OK) {
 394       message(LDPL_ERROR, "Unable to add symbols!");
 395       return LDPS_ERR;
 396     }
 397   }
 398
 399   return LDPS_OK;
 400 }
 401
 402 static void keepGlobalValue(GlobalValue &GV,
 403                             std::vector<GlobalAlias *> &KeptAliases) {
 404   assert(!GV.hasLocalLinkage());
 405
 406   if (auto *GA = dyn_cast<GlobalAlias>(&GV))
 407     KeptAliases.push_back(GA);
 408
 409   switch (GV.getLinkage()) {
 410   default:
 411     break;
 412   case GlobalValue::LinkOnceAnyLinkage:
 413     GV.setLinkage(GlobalValue::WeakAnyLinkage);
 414     break;
 415   case GlobalValue::LinkOnceODRLinkage:
 416     GV.setLinkage(GlobalValue::WeakODRLinkage);
 417     break;
 418   }
 419
 420   assert(!GV.isDiscardableIfUnused());
 421 }
 422
 423 static void internalize(GlobalValue &GV) {
 424   if (GV.isDeclarationForLinker())
 425     return; // We get here if there is a matching asm definition.
 426   if (!GV.hasLocalLinkage())
 427     GV.setLinkage(GlobalValue::InternalLinkage);
 428 }
 429
 430 static void drop(GlobalValue &GV) {
 431   if (auto *F = dyn_cast<Function>(&GV)) {
 432     F->deleteBody();
 433     F->setComdat(nullptr); // Should deleteBody do this?
 434     return;
 435   }
 436
 437   if (auto *Var = dyn_cast<GlobalVariable>(&GV)) {
 438     Var->setInitializer(nullptr);
 439     Var->setLinkage(
 440         GlobalValue::ExternalLinkage); // Should setInitializer do this?
 441     Var->setComdat(nullptr); // and this?
 442     return;
 443   }
 444
 445   auto &Alias = cast<GlobalAlias>(GV);
 446   Module &M = *Alias.getParent();
 447   PointerType &Ty = *cast<PointerType>(Alias.getType());
 448   GlobalValue::LinkageTypes L = Alias.getLinkage();
 449   auto *Var =
 450       new GlobalVariable(M, Ty.getElementType(), /*isConstant*/ false, L,
 451                          /*Initializer*/ nullptr);
 452   Var->takeName(&Alias);
 453   Alias.replaceAllUsesWith(Var);
 454   Alias.eraseFromParent();
 455 }
 456
 457 static const char *getResolutionName(ld_plugin_symbol_resolution R) {
 458   switch (R) {
 459   case LDPR_UNKNOWN:
 460     return "UNKNOWN";
 461   case LDPR_UNDEF:
 462     return "UNDEF";
 463   case LDPR_PREVAILING_DEF:
 464     return "PREVAILING_DEF";
 465   case LDPR_PREVAILING_DEF_IRONLY:
 466     return "PREVAILING_DEF_IRONLY";
 467   case LDPR_PREEMPTED_REG:
 468     return "PREEMPTED_REG";
 469   case LDPR_PREEMPTED_IR:
 470     return "PREEMPTED_IR";
 471   case LDPR_RESOLVED_IR:
 472     return "RESOLVED_IR";
 473   case LDPR_RESOLVED_EXEC:
 474     return "RESOLVED_EXEC";
 475   case LDPR_RESOLVED_DYN:
 476     return "RESOLVED_DYN";
 477   case LDPR_PREVAILING_DEF_IRONLY_EXP:
 478     return "PREVAILING_DEF_IRONLY_EXP";
 479   }
 480   llvm_unreachable("Unknown resolution");
 481 }
 482
 483 namespace {
 484 class LocalValueMaterializer : public ValueMaterializer {
 485   DenseSet<GlobalValue *> &Dropped;
 486   DenseMap<GlobalObject *, GlobalObject *> LocalVersions;
 487
 488 public:
 489   LocalValueMaterializer(DenseSet<GlobalValue *> &Dropped) : Dropped(Dropped) {}
 490   Value *materializeValueFor(Value *V) override;
 491 };
 492 }
 493
 494 Value *LocalValueMaterializer::materializeValueFor(Value *V) {
 495   auto *GO = dyn_cast<GlobalObject>(V);
 496   if (!GO)
 497     return nullptr;
 498
 499   auto I = LocalVersions.find(GO);
 500   if (I != LocalVersions.end())
 501     return I->second;
 502
 503   if (!Dropped.count(GO))
 504     return nullptr;
 505
 506   Module &M = *GO->getParent();
 507   GlobalValue::LinkageTypes L = GO->getLinkage();
 508   GlobalObject *Declaration;
 509   if (auto *F = dyn_cast<Function>(GO)) {
 510     Declaration = Function::Create(F->getFunctionType(), L, "", &M);
 511   } else {
 512     auto *Var = cast<GlobalVariable>(GO);
 513     Declaration = new GlobalVariable(M, Var->getType()->getElementType(),
 514                                      Var->isConstant(), L,
 515                                      /*Initializer*/ nullptr);
 516   }
 517   Declaration->takeName(GO);
 518   Declaration->copyAttributesFrom(GO);
 519
 520   GO->setLinkage(GlobalValue::InternalLinkage);
 521   GO->setName(Declaration->getName());
 522   Dropped.erase(GO);
 523   GO->replaceAllUsesWith(Declaration);
 524
 525   LocalVersions[Declaration] = GO;
 526
 527   return GO;
 528 }
 529
 530 static Constant *mapConstantToLocalCopy(Constant *C, ValueToValueMapTy &VM,
 531                                         LocalValueMaterializer *Materializer) {
 532   return MapValue(C, VM, RF_IgnoreMissingEntries, nullptr, Materializer);
 533 }
 534
 535 static std::unique_ptr<Module>
 536 getModuleForFile(LLVMContext &Context, claimed_file &F, raw_fd_ostream *ApiFile,
 537                  StringSet<> &Internalize, StringSet<> &Maybe) {
 538   ld_plugin_input_file File;
 539   if (get_input_file(F.handle, &File) != LDPS_OK)
 540     message(LDPL_FATAL, "Failed to get file information");
 541
 542   if (get_symbols(F.handle, F.syms.size(), &F.syms[0]) != LDPS_OK)
 543     message(LDPL_FATAL, "Failed to get symbol information");
 544
 545   const void *View;
 546   if (get_view(F.handle, &View) != LDPS_OK)
 547     message(LDPL_FATAL, "Failed to get a view of file");
 548
 549   MemoryBufferRef BufferRef(StringRef((const char *)View, File.filesize), "");
 550   ErrorOr<std::unique_ptr<object::IRObjectFile>> ObjOrErr =
 551       object::IRObjectFile::create(BufferRef, Context);
 552
 553   if (std::error_code EC = ObjOrErr.getError())
 554     message(LDPL_FATAL, "Could not read bitcode from file : %s",
 555             EC.message().c_str());
 556
 557   if (release_input_file(F.handle) != LDPS_OK)
 558     message(LDPL_FATAL, "Failed to release file information");
 559
 560   object::IRObjectFile &Obj = **ObjOrErr;
 561
 562   Module &M = Obj.getModule();
 563
 564   SmallPtrSet<GlobalValue *, 8> Used;
 565   collectUsedGlobalVariables(M, Used, /*CompilerUsed*/ false);
 566
 567   DenseSet<GlobalValue *> Drop;
 568   std::vector<GlobalAlias *> KeptAliases;
 569
 570   unsigned SymNum = 0;
 571   for (auto &ObjSym : Obj.symbols()) {
 572     if (shouldSkip(ObjSym.getFlags()))
 573       continue;
 574     ld_plugin_symbol &Sym = F.syms[SymNum];
 575     ++SymNum;
 576
 577     ld_plugin_symbol_resolution Resolution =
 578         (ld_plugin_symbol_resolution)Sym.resolution;
 579
 580     if (options::generate_api_file)
 581       *ApiFile << Sym.name << ' ' << getResolutionName(Resolution) << '\n';
 582
 583     GlobalValue *GV = Obj.getSymbolGV(ObjSym.getRawDataRefImpl());
 584     if (!GV)
 585       continue; // Asm symbol.
 586
 587     if (Resolution != LDPR_PREVAILING_DEF_IRONLY && GV->hasCommonLinkage()) {
 588       // Common linkage is special. There is no single symbol that wins the
 589       // resolution. Instead we have to collect the maximum alignment and size.
 590       // The IR linker does that for us if we just pass it every common GV.
 591       // We still have to keep track of LDPR_PREVAILING_DEF_IRONLY so we
 592       // internalize once the IR linker has done its job.
 593       continue;
 594     }
 595
 596     switch (Resolution) {
 597     case LDPR_UNKNOWN:
 598       llvm_unreachable("Unexpected resolution");
 599
 600     case LDPR_RESOLVED_IR:
 601     case LDPR_RESOLVED_EXEC:
 602     case LDPR_RESOLVED_DYN:
 603     case LDPR_UNDEF:
 604       assert(GV->isDeclarationForLinker());
 605       break;
 606
 607     case LDPR_PREVAILING_DEF_IRONLY: {
 608       keepGlobalValue(*GV, KeptAliases);
 609       if (!Used.count(GV)) {
 610         // Since we use the regular lib/Linker, we cannot just internalize GV
 611         // now or it will not be copied to the merged module. Instead we force
 612         // it to be copied and then internalize it.
 613         Internalize.insert(GV->getName());
 614       }
 615       break;
 616     }
 617
 618     case LDPR_PREVAILING_DEF:
 619       keepGlobalValue(*GV, KeptAliases);
 620       break;
 621
 622     case LDPR_PREEMPTED_IR:
 623       // Gold might have selected a linkonce_odr and preempted a weak_odr.
 624       // In that case we have to make sure we don't end up internalizing it.
 625       if (!GV->isDiscardableIfUnused())
 626         Maybe.erase(GV->getName());
 627
 628       // fall-through
 629     case LDPR_PREEMPTED_REG:
 630       Drop.insert(GV);
 631       break;
 632
 633     case LDPR_PREVAILING_DEF_IRONLY_EXP: {
 634       // We can only check for address uses after we merge the modules. The
 635       // reason is that this GV might have a copy in another module
 636       // and in that module the address might be significant, but that
 637       // copy will be LDPR_PREEMPTED_IR.
 638       if (GV->hasLinkOnceODRLinkage())
 639         Maybe.insert(GV->getName());
 640       keepGlobalValue(*GV, KeptAliases);
 641       break;
 642     }
 643     }
 644
 645     free(Sym.name);
 646     free(Sym.comdat_key);
 647     Sym.name = nullptr;
 648     Sym.comdat_key = nullptr;
 649   }
 650
 651   ValueToValueMapTy VM;
 652   LocalValueMaterializer Materializer(Drop);
 653   for (GlobalAlias *GA : KeptAliases) {
 654     // Gold told us to keep GA. It is possible that a GV usied in the aliasee
 655     // expression is being dropped. If that is the case, that GV must be copied.
 656     Constant *Aliasee = GA->getAliasee();
 657     Constant *Replacement = mapConstantToLocalCopy(Aliasee, VM, &Materializer);
 658     GA->setAliasee(Replacement);
 659   }
 660
 661   for (auto *GV : Drop)
 662     drop(*GV);
 663
 664   return Obj.takeModule();
 665 }
 666
 667 static void runLTOPasses(Module &M, TargetMachine &TM) {
 668   PassManager passes;
 669   PassManagerBuilder PMB;
 670   PMB.LibraryInfo = new TargetLibraryInfo(Triple(TM.getTargetTriple()));
 671   PMB.Inliner = createFunctionInliningPass();
 672   PMB.VerifyInput = true;
 673   PMB.VerifyOutput = true;
 674   PMB.LoopVectorize = true;
 675   PMB.SLPVectorize = true;
 676   PMB.populateLTOPassManager(passes, &TM);
 677   passes.run(M);
 678 }
 679
 680 static void saveBCFile(StringRef Path, Module &M) {
 681   std::error_code EC;
 682   raw_fd_ostream OS(Path, EC, sys::fs::OpenFlags::F_None);
 683   if (EC)
 684     message(LDPL_FATAL, "Failed to write the output file.");
 685   WriteBitcodeToFile(&M, OS);
 686 }
 687
 688 static void codegen(Module &M) {
 689   const std::string &TripleStr = M.getTargetTriple();
 690   Triple TheTriple(TripleStr);
 691
 692   std::string ErrMsg;
 693   const Target *TheTarget = TargetRegistry::lookupTarget(TripleStr, ErrMsg);
 694   if (!TheTarget)
 695     message(LDPL_FATAL, "Target not found: %s", ErrMsg.c_str());
 696
 697   if (unsigned NumOpts = options::extra.size())
 698     cl::ParseCommandLineOptions(NumOpts, &options::extra[0]);
 699
 700   SubtargetFeatures Features;
 701   Features.getDefaultSubtargetFeatures(TheTriple);
 702   for (const std::string &A : MAttrs)
 703     Features.AddFeature(A);
 704
 705   TargetOptions Options = InitTargetOptionsFromCodeGenFlags();
 706   std::unique_ptr<TargetMachine> TM(TheTarget->createTargetMachine(
 707       TripleStr, options::mcpu, Features.getString(), Options, RelocationModel,
 708       CodeModel::Default, CodeGenOpt::Aggressive));
 709
 710   runLTOPasses(M, *TM);
 711
 712   if (options::TheOutputType == options::OT_SAVE_TEMPS)
 713     saveBCFile(output_name + ".opt.bc", M);
 714
 715   PassManager CodeGenPasses;
 716   CodeGenPasses.add(new DataLayoutPass());
 717
 718   SmallString<128> Filename;
 719   int FD;
 720   if (options::obj_path.empty()) {
 721     std::error_code EC =
 722         sys::fs::createTemporaryFile("lto-llvm", "o", FD, Filename);
 723     if (EC)
 724       message(LDPL_FATAL, "Could not create temporary file: %s",
 725               EC.message().c_str());
 726   } else {
 727     Filename = options::obj_path;
 728     std::error_code EC =
 729         sys::fs::openFileForWrite(Filename.c_str(), FD, sys::fs::F_None);
 730     if (EC)
 731       message(LDPL_FATAL, "Could not open file: %s", EC.message().c_str());
 732   }
 733
 734   {
 735     raw_fd_ostream OS(FD, true);
 736     formatted_raw_ostream FOS(OS);
 737
 738     if (TM->addPassesToEmitFile(CodeGenPasses, FOS,
 739                                 TargetMachine::CGFT_ObjectFile))
 740       message(LDPL_FATAL, "Failed to setup codegen");
 741     CodeGenPasses.run(M);
 742   }
 743
 744   if (add_input_file(Filename.c_str()) != LDPS_OK)
 745     message(LDPL_FATAL,
 746             "Unable to add .o file to the link. File left behind in: %s",
 747             Filename.c_str());
 748
 749   if (options::obj_path.empty())
 750     Cleanup.push_back(Filename.c_str());
 751 }
 752
 753 /// gold informs us that all symbols have been read. At this point, we use
 754 /// get_symbols to see if any of our definitions have been overridden by a
 755 /// native object file. Then, perform optimization and codegen.
 756 static ld_plugin_status allSymbolsReadHook(raw_fd_ostream *ApiFile) {
 757   if (Modules.empty())
 758     return LDPS_OK;
 759
 760   LLVMContext Context;
 761   std::unique_ptr<Module> Combined(new Module("ld-temp.o", Context));
 762   Linker L(Combined.get());
 763
 764   std::string DefaultTriple = sys::getDefaultTargetTriple();
 765
 766   StringSet<> Internalize;
 767   StringSet<> Maybe;
 768   for (claimed_file &F : Modules) {
 769     std::unique_ptr<Module> M =
 770         getModuleForFile(Context, F, ApiFile, Internalize, Maybe);
 771     if (!options::triple.empty())
 772       M->setTargetTriple(options::triple.c_str());
 773     else if (M->getTargetTriple().empty()) {
 774       M->setTargetTriple(DefaultTriple);
 775     }
 776
 777     if (L.linkInModule(M.get()))
 778       message(LDPL_FATAL, "Failed to link module");
 779   }
 780
 781   for (const auto &Name : Internalize) {
 782     GlobalValue *GV = Combined->getNamedValue(Name.first());
 783     if (GV)
 784       internalize(*GV);
 785   }
 786
 787   for (const auto &Name : Maybe) {
 788     GlobalValue *GV = Combined->getNamedValue(Name.first());
 789     if (!GV)
 790       continue;
 791     GV->setLinkage(GlobalValue::LinkOnceODRLinkage);
 792     if (canBeOmittedFromSymbolTable(GV))
 793       internalize(*GV);
 794   }
 795
 796   if (options::TheOutputType == options::OT_DISABLE)
 797     return LDPS_OK;
 798
 799   if (options::TheOutputType != options::OT_NORMAL) {
 800     std::string path;
 801     if (options::TheOutputType == options::OT_BC_ONLY)
 802       path = output_name;
 803     else
 804       path = output_name + ".bc";
 805     saveBCFile(path, *L.getModule());
 806     if (options::TheOutputType == options::OT_BC_ONLY)
 807       return LDPS_OK;
 808   }
 809
 810   codegen(*L.getModule());
 811
 812   if (!options::extra_library_path.empty() &&
 813       set_extra_library_path(options::extra_library_path.c_str()) != LDPS_OK)
 814     message(LDPL_FATAL, "Unable to set the extra library path.");
 815
 816   return LDPS_OK;
 817 }
 818
 819 static ld_plugin_status all_symbols_read_hook(void) {
 820   ld_plugin_status Ret;
 821   if (!options::generate_api_file) {
 822     Ret = allSymbolsReadHook(nullptr);
 823   } else {
 824     std::error_code EC;
 825     raw_fd_ostream ApiFile("apifile.txt", EC, sys::fs::F_None);
 826     if (EC)
 827       message(LDPL_FATAL, "Unable to open apifile.txt for writing: %s",
 828               EC.message().c_str());
 829     Ret = allSymbolsReadHook(&ApiFile);
 830   }
 831
 832   llvm_shutdown();
 833
 834   if (options::TheOutputType == options::OT_BC_ONLY ||
 835       options::TheOutputType == options::OT_DISABLE)
 836     exit(0);
 837
 838   return Ret;
 839 }
 840
 841 static ld_plugin_status cleanup_hook(void) {
 842   for (std::string &Name : Cleanup) {
 843     std::error_code EC = sys::fs::remove(Name);
 844     if (EC)
 845       message(LDPL_ERROR, "Failed to delete '%s': %s", Name.c_str(),
 846               EC.message().c_str());
 847   }
 848
 849   return LDPS_OK;
 850 }