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-c/lto.h"
  17 #include "llvm/ADT/OwningPtr.h"
  18 #include "llvm/ADT/StringSet.h"
  19 #include "llvm/Support/Errno.h"
  20 #include "llvm/Support/FileSystem.h"
  21 #include "llvm/Support/MemoryBuffer.h"
  22 #include "llvm/Support/Path.h"
  23 #include "llvm/Support/Program.h"
  24 #include "llvm/Support/ToolOutputFile.h"
  25 #include "llvm/Support/system_error.h"
  26 #include <cerrno>
  27 #include <cstdlib>
  28 #include <cstring>
  29 #include <fstream>
  30 #include <list>
  31 #include <plugin-api.h>
  32 #include <vector>
  33
  34 // Support Windows/MinGW crazyness.
  35 #ifdef _WIN32
  36 # include <io.h>
  37 # define lseek _lseek
  38 # define read _read
  39 #endif
  40
  41 using namespace llvm;
  42
  43 namespace {
  44   ld_plugin_status discard_message(int level, const char *format, ...) {
  45     // Die loudly. Recent versions of Gold pass ld_plugin_message as the first
  46     // callback in the transfer vector. This should never be called.
  47     abort();
  48   }
  49
  50   ld_plugin_add_symbols add_symbols = NULL;
  51   ld_plugin_get_symbols get_symbols = NULL;
  52   ld_plugin_add_input_file add_input_file = NULL;
  53   ld_plugin_add_input_library add_input_library = NULL;
  54   ld_plugin_set_extra_library_path set_extra_library_path = NULL;
  55   ld_plugin_get_view get_view = NULL;
  56   ld_plugin_message message = discard_message;
  57
  58   int api_version = 0;
  59   int gold_version = 0;
  60
  61   struct claimed_file {
  62     void *handle;
  63     std::vector<ld_plugin_symbol> syms;
  64   };
  65
  66   lto_codegen_model output_type = LTO_CODEGEN_PIC_MODEL_STATIC;
  67   std::string output_name = "";
  68   std::list<claimed_file> Modules;
  69   std::vector<std::string> Cleanup;
  70   lto_code_gen_t code_gen = NULL;
  71   StringSet<> CannotBeHidden;
  72 }
  73
  74 namespace options {
  75   enum generate_bc { BC_NO, BC_ALSO, BC_ONLY };
  76   static bool generate_api_file = false;
  77   static generate_bc generate_bc_file = BC_NO;
  78   static std::string bc_path;
  79   static std::string obj_path;
  80   static std::string extra_library_path;
  81   static std::string triple;
  82   static std::string mcpu;
  83   // Additional options to pass into the code generator.
  84   // Note: This array will contain all plugin options which are not claimed
  85   // as plugin exclusive to pass to the code generator.
  86   // For example, "generate-api-file" and "as"options are for the plugin
  87   // use only and will not be passed.
  88   static std::vector<std::string> extra;
  89
  90   static void process_plugin_option(const char* opt_)
  91   {
  92     if (opt_ == NULL)
  93       return;
  94     llvm::StringRef opt = opt_;
  95
  96     if (opt == "generate-api-file") {
  97       generate_api_file = true;
  98     } else if (opt.startswith("mcpu=")) {
  99       mcpu = opt.substr(strlen("mcpu="));
 100     } else if (opt.startswith("extra-library-path=")) {
 101       extra_library_path = opt.substr(strlen("extra_library_path="));
 102     } else if (opt.startswith("mtriple=")) {
 103       triple = opt.substr(strlen("mtriple="));
 104     } else if (opt.startswith("obj-path=")) {
 105       obj_path = opt.substr(strlen("obj-path="));
 106     } else if (opt == "emit-llvm") {
 107       generate_bc_file = BC_ONLY;
 108     } else if (opt == "also-emit-llvm") {
 109       generate_bc_file = BC_ALSO;
 110     } else if (opt.startswith("also-emit-llvm=")) {
 111       llvm::StringRef path = opt.substr(strlen("also-emit-llvm="));
 112       generate_bc_file = BC_ALSO;
 113       if (!bc_path.empty()) {
 114         (*message)(LDPL_WARNING, "Path to the output IL file specified twice. "
 115                    "Discarding %s", opt_);
 116       } else {
 117         bc_path = path;
 118       }
 119     } else {
 120       // Save this option to pass to the code generator.
 121       extra.push_back(opt);
 122     }
 123   }
 124 }
 125
 126 static ld_plugin_status claim_file_hook(const ld_plugin_input_file *file,
 127                                         int *claimed);
 128 static ld_plugin_status all_symbols_read_hook(void);
 129 static ld_plugin_status cleanup_hook(void);
 130
 131 extern "C" ld_plugin_status onload(ld_plugin_tv *tv);
 132 ld_plugin_status onload(ld_plugin_tv *tv) {
 133   // We're given a pointer to the first transfer vector. We read through them
 134   // until we find one where tv_tag == LDPT_NULL. The REGISTER_* tagged values
 135   // contain pointers to functions that we need to call to register our own
 136   // hooks. The others are addresses of functions we can use to call into gold
 137   // for services.
 138
 139   bool registeredClaimFile = false;
 140
 141   for (; tv->tv_tag != LDPT_NULL; ++tv) {
 142     switch (tv->tv_tag) {
 143       case LDPT_API_VERSION:
 144         api_version = tv->tv_u.tv_val;
 145         break;
 146       case LDPT_GOLD_VERSION:  // major * 100 + minor
 147         gold_version = tv->tv_u.tv_val;
 148         break;
 149       case LDPT_OUTPUT_NAME:
 150         output_name = tv->tv_u.tv_string;
 151         break;
 152       case LDPT_LINKER_OUTPUT:
 153         switch (tv->tv_u.tv_val) {
 154           case LDPO_REL:  // .o
 155           case LDPO_DYN:  // .so
 156           case LDPO_PIE:  // position independent executable
 157             output_type = LTO_CODEGEN_PIC_MODEL_DYNAMIC;
 158             break;
 159           case LDPO_EXEC:  // .exe
 160             output_type = LTO_CODEGEN_PIC_MODEL_STATIC;
 161             break;
 162           default:
 163             (*message)(LDPL_ERROR, "Unknown output file type %d",
 164                        tv->tv_u.tv_val);
 165             return LDPS_ERR;
 166         }
 167         // TODO: add an option to disable PIC.
 168         //output_type = LTO_CODEGEN_PIC_MODEL_DYNAMIC_NO_PIC;
 169         break;
 170       case LDPT_OPTION:
 171         options::process_plugin_option(tv->tv_u.tv_string);
 172         break;
 173       case LDPT_REGISTER_CLAIM_FILE_HOOK: {
 174         ld_plugin_register_claim_file callback;
 175         callback = tv->tv_u.tv_register_claim_file;
 176
 177         if ((*callback)(claim_file_hook) != LDPS_OK)
 178           return LDPS_ERR;
 179
 180         registeredClaimFile = true;
 181       } break;
 182       case LDPT_REGISTER_ALL_SYMBOLS_READ_HOOK: {
 183         ld_plugin_register_all_symbols_read callback;
 184         callback = tv->tv_u.tv_register_all_symbols_read;
 185
 186         if ((*callback)(all_symbols_read_hook) != LDPS_OK)
 187           return LDPS_ERR;
 188
 189         code_gen = lto_codegen_create();
 190       } break;
 191       case LDPT_REGISTER_CLEANUP_HOOK: {
 192         ld_plugin_register_cleanup callback;
 193         callback = tv->tv_u.tv_register_cleanup;
 194
 195         if ((*callback)(cleanup_hook) != LDPS_OK)
 196           return LDPS_ERR;
 197       } break;
 198       case LDPT_ADD_SYMBOLS:
 199         add_symbols = tv->tv_u.tv_add_symbols;
 200         break;
 201       case LDPT_GET_SYMBOLS_V2:
 202         get_symbols = tv->tv_u.tv_get_symbols;
 203         break;
 204       case LDPT_ADD_INPUT_FILE:
 205         add_input_file = tv->tv_u.tv_add_input_file;
 206         break;
 207       case LDPT_ADD_INPUT_LIBRARY:
 208         add_input_library = tv->tv_u.tv_add_input_file;
 209         break;
 210       case LDPT_SET_EXTRA_LIBRARY_PATH:
 211         set_extra_library_path = tv->tv_u.tv_set_extra_library_path;
 212         break;
 213       case LDPT_GET_VIEW:
 214         get_view = tv->tv_u.tv_get_view;
 215         break;
 216       case LDPT_MESSAGE:
 217         message = tv->tv_u.tv_message;
 218         break;
 219       default:
 220         break;
 221     }
 222   }
 223
 224   if (!registeredClaimFile) {
 225     (*message)(LDPL_ERROR, "register_claim_file not passed to LLVMgold.");
 226     return LDPS_ERR;
 227   }
 228   if (!add_symbols) {
 229     (*message)(LDPL_ERROR, "add_symbols not passed to LLVMgold.");
 230     return LDPS_ERR;
 231   }
 232
 233   return LDPS_OK;
 234 }
 235
 236 /// claim_file_hook - called by gold to see whether this file is one that
 237 /// our plugin can handle. We'll try to open it and register all the symbols
 238 /// with add_symbol if possible.
 239 static ld_plugin_status claim_file_hook(const ld_plugin_input_file *file,
 240                                         int *claimed) {
 241   lto_module_t M;
 242   const void *view;
 243   OwningPtr<MemoryBuffer> buffer;
 244   if (get_view) {
 245     if (get_view(file->handle, &view) != LDPS_OK) {
 246       (*message)(LDPL_ERROR, "Failed to get a view of %s", file->name);
 247       return LDPS_ERR;
 248     }
 249   } else {
 250     int64_t offset = 0;
 251     // Gold has found what might be IR part-way inside of a file, such as
 252     // an .a archive.
 253     if (file->offset) {
 254       offset = file->offset;
 255     }
 256     if (error_code ec = MemoryBuffer::getOpenFileSlice(
 257             file->fd, file->name, buffer, file->filesize, offset)) {
 258       (*message)(LDPL_ERROR, ec.message().c_str());
 259       return LDPS_ERR;
 260     }
 261     view = buffer->getBufferStart();
 262   }
 263
 264   if (!lto_module_is_object_file_in_memory(view, file->filesize))
 265     return LDPS_OK;
 266
 267   M = lto_module_create_from_memory(view, file->filesize);
 268   if (!M) {
 269     if (const char* msg = lto_get_error_message()) {
 270       (*message)(LDPL_ERROR,
 271                  "LLVM gold plugin has failed to create LTO module: %s",
 272                  msg);
 273       return LDPS_ERR;
 274     }
 275     return LDPS_OK;
 276   }
 277
 278   *claimed = 1;
 279   Modules.resize(Modules.size() + 1);
 280   claimed_file &cf = Modules.back();
 281
 282   if (!options::triple.empty())
 283     lto_module_set_target_triple(M, options::triple.c_str());
 284
 285   cf.handle = file->handle;
 286   unsigned sym_count = lto_module_get_num_symbols(M);
 287   cf.syms.reserve(sym_count);
 288
 289   for (unsigned i = 0; i != sym_count; ++i) {
 290     lto_symbol_attributes attrs = lto_module_get_symbol_attribute(M, i);
 291     if ((attrs & LTO_SYMBOL_SCOPE_MASK) == LTO_SYMBOL_SCOPE_INTERNAL)
 292       continue;
 293
 294     cf.syms.push_back(ld_plugin_symbol());
 295     ld_plugin_symbol &sym = cf.syms.back();
 296     sym.name = const_cast<char *>(lto_module_get_symbol_name(M, i));
 297     sym.name = strdup(sym.name);
 298     sym.version = NULL;
 299
 300     int scope = attrs & LTO_SYMBOL_SCOPE_MASK;
 301     bool CanBeHidden = scope == LTO_SYMBOL_SCOPE_DEFAULT_CAN_BE_HIDDEN;
 302     if (!CanBeHidden)
 303       CannotBeHidden.insert(sym.name);
 304     switch (scope) {
 305       case LTO_SYMBOL_SCOPE_HIDDEN:
 306         sym.visibility = LDPV_HIDDEN;
 307         break;
 308       case LTO_SYMBOL_SCOPE_PROTECTED:
 309         sym.visibility = LDPV_PROTECTED;
 310         break;
 311       case 0: // extern
 312       case LTO_SYMBOL_SCOPE_DEFAULT:
 313       case LTO_SYMBOL_SCOPE_DEFAULT_CAN_BE_HIDDEN:
 314         sym.visibility = LDPV_DEFAULT;
 315         break;
 316       default:
 317         (*message)(LDPL_ERROR, "Unknown scope attribute: %d", scope);
 318         return LDPS_ERR;
 319     }
 320
 321     int definition = attrs & LTO_SYMBOL_DEFINITION_MASK;
 322     sym.comdat_key = NULL;
 323     switch (definition) {
 324       case LTO_SYMBOL_DEFINITION_REGULAR:
 325         sym.def = LDPK_DEF;
 326         break;
 327       case LTO_SYMBOL_DEFINITION_UNDEFINED:
 328         sym.def = LDPK_UNDEF;
 329         break;
 330       case LTO_SYMBOL_DEFINITION_TENTATIVE:
 331         sym.def = LDPK_COMMON;
 332         break;
 333       case LTO_SYMBOL_DEFINITION_WEAK:
 334         sym.comdat_key = sym.name;
 335         sym.def = LDPK_WEAKDEF;
 336         break;
 337       case LTO_SYMBOL_DEFINITION_WEAKUNDEF:
 338         sym.def = LDPK_WEAKUNDEF;
 339         break;
 340       default:
 341         (*message)(LDPL_ERROR, "Unknown definition attribute: %d", definition);
 342         return LDPS_ERR;
 343     }
 344
 345     sym.size = 0;
 346
 347     sym.resolution = LDPR_UNKNOWN;
 348   }
 349
 350   cf.syms.reserve(cf.syms.size());
 351
 352   if (!cf.syms.empty()) {
 353     if ((*add_symbols)(cf.handle, cf.syms.size(), &cf.syms[0]) != LDPS_OK) {
 354       (*message)(LDPL_ERROR, "Unable to add symbols!");
 355       return LDPS_ERR;
 356     }
 357   }
 358
 359   if (code_gen) {
 360     if (lto_codegen_add_module(code_gen, M)) {
 361       (*message)(LDPL_ERROR, "Error linking module: %s",
 362                  lto_get_error_message());
 363       return LDPS_ERR;
 364     }
 365   }
 366
 367   lto_module_dispose(M);
 368
 369   return LDPS_OK;
 370 }
 371
 372 static bool mustPreserve(const claimed_file &F, int i) {
 373   if (F.syms[i].resolution == LDPR_PREVAILING_DEF)
 374     return true;
 375   if (F.syms[i].resolution == LDPR_PREVAILING_DEF_IRONLY_EXP)
 376     return CannotBeHidden.count(F.syms[i].name);
 377   return false;
 378 }
 379
 380 /// all_symbols_read_hook - gold informs us that all symbols have been read.
 381 /// At this point, we use get_symbols to see if any of our definitions have
 382 /// been overridden by a native object file. Then, perform optimization and
 383 /// codegen.
 384 static ld_plugin_status all_symbols_read_hook(void) {
 385   std::ofstream api_file;
 386   assert(code_gen);
 387
 388   if (options::generate_api_file) {
 389     api_file.open("apifile.txt", std::ofstream::out | std::ofstream::trunc);
 390     if (!api_file.is_open()) {
 391       (*message)(LDPL_FATAL, "Unable to open apifile.txt for writing.");
 392       abort();
 393     }
 394   }
 395
 396   for (std::list<claimed_file>::iterator I = Modules.begin(),
 397          E = Modules.end(); I != E; ++I) {
 398     if (I->syms.empty())
 399       continue;
 400     (*get_symbols)(I->handle, I->syms.size(), &I->syms[0]);
 401     for (unsigned i = 0, e = I->syms.size(); i != e; i++) {
 402       if (mustPreserve(*I, i)) {
 403         lto_codegen_add_must_preserve_symbol(code_gen, I->syms[i].name);
 404
 405         if (options::generate_api_file)
 406           api_file << I->syms[i].name << "\n";
 407       }
 408     }
 409   }
 410
 411   if (options::generate_api_file)
 412     api_file.close();
 413
 414   lto_codegen_set_pic_model(code_gen, output_type);
 415   lto_codegen_set_debug_model(code_gen, LTO_DEBUG_MODEL_DWARF);
 416   if (!options::mcpu.empty())
 417     lto_codegen_set_cpu(code_gen, options::mcpu.c_str());
 418
 419   // Pass through extra options to the code generator.
 420   if (!options::extra.empty()) {
 421     for (std::vector<std::string>::iterator it = options::extra.begin();
 422          it != options::extra.end(); ++it) {
 423       lto_codegen_debug_options(code_gen, (*it).c_str());
 424     }
 425   }
 426
 427   if (options::generate_bc_file != options::BC_NO) {
 428     std::string path;
 429     if (options::generate_bc_file == options::BC_ONLY)
 430       path = output_name;
 431     else if (!options::bc_path.empty())
 432       path = options::bc_path;
 433     else
 434       path = output_name + ".bc";
 435     bool err = lto_codegen_write_merged_modules(code_gen, path.c_str());
 436     if (err)
 437       (*message)(LDPL_FATAL, "Failed to write the output file.");
 438     if (options::generate_bc_file == options::BC_ONLY) {
 439       lto_codegen_dispose(code_gen);
 440       exit(0);
 441     }
 442   }
 443
 444   std::string ObjPath;
 445   {
 446     const char *Temp;
 447     if (lto_codegen_compile_to_file(code_gen, &Temp)) {
 448       (*message)(LDPL_ERROR, "Could not produce a combined object file\n");
 449     }
 450     ObjPath = Temp;
 451   }
 452
 453   lto_codegen_dispose(code_gen);
 454   for (std::list<claimed_file>::iterator I = Modules.begin(),
 455          E = Modules.end(); I != E; ++I) {
 456     for (unsigned i = 0; i != I->syms.size(); ++i) {
 457       ld_plugin_symbol &sym = I->syms[i];
 458       free(sym.name);
 459     }
 460   }
 461
 462   if ((*add_input_file)(ObjPath.c_str()) != LDPS_OK) {
 463     (*message)(LDPL_ERROR, "Unable to add .o file to the link.");
 464     (*message)(LDPL_ERROR, "File left behind in: %s", ObjPath.c_str());
 465     return LDPS_ERR;
 466   }
 467
 468   if (!options::extra_library_path.empty() &&
 469       set_extra_library_path(options::extra_library_path.c_str()) != LDPS_OK) {
 470     (*message)(LDPL_ERROR, "Unable to set the extra library path.");
 471     return LDPS_ERR;
 472   }
 473
 474   if (options::obj_path.empty())
 475     Cleanup.push_back(ObjPath);
 476
 477   return LDPS_OK;
 478 }
 479
 480 static ld_plugin_status cleanup_hook(void) {
 481   for (int i = 0, e = Cleanup.size(); i != e; ++i) {
 482     error_code EC = sys::fs::remove(Cleanup[i]);
 483     if (EC)
 484       (*message)(LDPL_ERROR, "Failed to delete '%s': %s", Cleanup[i].c_str(),
 485                  EC.message().c_str());
 486   }
 487
 488   return LDPS_OK;
 489 }