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