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"
  16 #include "plugin-api.h"
  17
  18 #include "llvm-c/lto.h"
  19
  20 #include "llvm/Support/ToolOutputFile.h"
  21 #include "llvm/Support/Errno.h"
  22 #include "llvm/Support/Path.h"
  23 #include "llvm/Support/Program.h"
  24
  25 #include <cerrno>
  26 #include <cstdlib>
  27 #include <cstring>
  28 #include <fstream>
  29 #include <list>
  30 #include <vector>
  31
  32 // Support Windows/MinGW crazyness.
  33 #ifdef _WIN32
  34 # include <io.h>
  35 # define lseek _lseek
  36 # define read _read
  37 #endif
  38
  39 using namespace llvm;
  40
  41 namespace {
  42   ld_plugin_status discard_message(int level, const char *format, ...) {
  43     // Die loudly. Recent versions of Gold pass ld_plugin_message as the first
  44     // callback in the transfer vector. This should never be called.
  45     abort();
  46   }
  47
  48   ld_plugin_add_symbols add_symbols = NULL;
  49   ld_plugin_get_symbols get_symbols = NULL;
  50   ld_plugin_add_input_file add_input_file = NULL;
  51   ld_plugin_add_input_library add_input_library = NULL;
  52   ld_plugin_set_extra_library_path set_extra_library_path = NULL;
  53   ld_plugin_message message = discard_message;
  54
  55   int api_version = 0;
  56   int gold_version = 0;
  57
  58   struct claimed_file {
  59     void *handle;
  60     std::vector<ld_plugin_symbol> syms;
  61   };
  62
  63   lto_codegen_model output_type = LTO_CODEGEN_PIC_MODEL_STATIC;
  64   std::string output_name = "";
  65   std::list<claimed_file> Modules;
  66   std::vector<sys::Path> Cleanup;
  67   lto_code_gen_t code_gen;
  68 }
  69
  70 namespace options {
  71   enum generate_bc { BC_NO, BC_ALSO, BC_ONLY };
  72   static bool generate_api_file = false;
  73   static generate_bc generate_bc_file = BC_NO;
  74   static std::string bc_path;
  75   static std::string obj_path;
  76   static std::string as_path;
  77   static std::vector<std::string> as_args;
  78   static std::vector<std::string> pass_through;
  79   static std::string extra_library_path;
  80   static std::string triple;
  81   static std::string mcpu;
  82   // Additional options to pass into the code generator.
  83   // Note: This array will contain all plugin options which are not claimed
  84   // as plugin exclusive to pass to the code generator.
  85   // For example, "generate-api-file" and "as"options are for the plugin
  86   // use only and will not be passed.
  87   static std::vector<std::string> extra;
  88
  89   static void process_plugin_option(const char* opt_)
  90   {
  91     if (opt_ == NULL)
  92       return;
  93     llvm::StringRef opt = opt_;
  94
  95     if (opt == "generate-api-file") {
  96       generate_api_file = true;
  97     } else if (opt.startswith("mcpu=")) {
  98       mcpu = opt.substr(strlen("mcpu="));
  99     } else if (opt.startswith("as=")) {
 100       if (!as_path.empty()) {
 101         (*message)(LDPL_WARNING, "Path to as specified twice. "
 102                    "Discarding %s", opt_);
 103       } else {
 104         as_path = opt.substr(strlen("as="));
 105       }
 106     } else if (opt.startswith("as-arg=")) {
 107       llvm::StringRef item = opt.substr(strlen("as-arg="));
 108       as_args.push_back(item.str());
 109     } else if (opt.startswith("extra-library-path=")) {
 110       extra_library_path = opt.substr(strlen("extra_library_path="));
 111     } else if (opt.startswith("pass-through=")) {
 112       llvm::StringRef item = opt.substr(strlen("pass-through="));
 113       pass_through.push_back(item.str());
 114     } else if (opt.startswith("mtriple=")) {
 115       triple = opt.substr(strlen("mtriple="));
 116     } else if (opt.startswith("obj-path=")) {
 117       obj_path = opt.substr(strlen("obj-path="));
 118     } else if (opt == "emit-llvm") {
 119       generate_bc_file = BC_ONLY;
 120     } else if (opt == "also-emit-llvm") {
 121       generate_bc_file = BC_ALSO;
 122     } else if (opt.startswith("also-emit-llvm=")) {
 123       llvm::StringRef path = opt.substr(strlen("also-emit-llvm="));
 124       generate_bc_file = BC_ALSO;
 125       if (!bc_path.empty()) {
 126         (*message)(LDPL_WARNING, "Path to the output IL file specified twice. "
 127                    "Discarding %s", opt_);
 128       } else {
 129         bc_path = path;
 130       }
 131     } else {
 132       // Save this option to pass to the code generator.
 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   // We're given a pointer to the first transfer vector. We read through them
 146   // until we find one where tv_tag == LDPT_NULL. The REGISTER_* tagged values
 147   // contain pointers to functions that we need to call to register our own
 148   // hooks. The others are addresses of functions we can use to call into gold
 149   // for services.
 150
 151   bool registeredClaimFile = false;
 152
 153   for (; tv->tv_tag != LDPT_NULL; ++tv) {
 154     switch (tv->tv_tag) {
 155       case LDPT_API_VERSION:
 156         api_version = tv->tv_u.tv_val;
 157         break;
 158       case LDPT_GOLD_VERSION:  // major * 100 + minor
 159         gold_version = tv->tv_u.tv_val;
 160         break;
 161       case LDPT_OUTPUT_NAME:
 162         output_name = tv->tv_u.tv_string;
 163         break;
 164       case LDPT_LINKER_OUTPUT:
 165         switch (tv->tv_u.tv_val) {
 166           case LDPO_REL:  // .o
 167           case LDPO_DYN:  // .so
 168             output_type = LTO_CODEGEN_PIC_MODEL_DYNAMIC;
 169             break;
 170           case LDPO_EXEC:  // .exe
 171             output_type = LTO_CODEGEN_PIC_MODEL_STATIC;
 172             break;
 173           default:
 174             (*message)(LDPL_ERROR, "Unknown output file type %d",
 175                        tv->tv_u.tv_val);
 176             return LDPS_ERR;
 177         }
 178         // TODO: add an option to disable PIC.
 179         //output_type = LTO_CODEGEN_PIC_MODEL_DYNAMIC_NO_PIC;
 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       } break;
 200       case LDPT_REGISTER_CLEANUP_HOOK: {
 201         ld_plugin_register_cleanup callback;
 202         callback = tv->tv_u.tv_register_cleanup;
 203
 204         if ((*callback)(cleanup_hook) != LDPS_OK)
 205           return LDPS_ERR;
 206       } break;
 207       case LDPT_ADD_SYMBOLS:
 208         add_symbols = tv->tv_u.tv_add_symbols;
 209         break;
 210       case LDPT_GET_SYMBOLS:
 211         get_symbols = tv->tv_u.tv_get_symbols;
 212         break;
 213       case LDPT_ADD_INPUT_FILE:
 214         add_input_file = tv->tv_u.tv_add_input_file;
 215         break;
 216       case LDPT_ADD_INPUT_LIBRARY:
 217         add_input_library = tv->tv_u.tv_add_input_file;
 218         break;
 219       case LDPT_SET_EXTRA_LIBRARY_PATH:
 220         set_extra_library_path = tv->tv_u.tv_set_extra_library_path;
 221         break;
 222       case LDPT_MESSAGE:
 223         message = tv->tv_u.tv_message;
 224         break;
 225       default:
 226         break;
 227     }
 228   }
 229
 230   if (!registeredClaimFile) {
 231     (*message)(LDPL_ERROR, "register_claim_file not passed to LLVMgold.");
 232     return LDPS_ERR;
 233   }
 234   if (!add_symbols) {
 235     (*message)(LDPL_ERROR, "add_symbols not passed to LLVMgold.");
 236     return LDPS_ERR;
 237   }
 238
 239   code_gen = lto_codegen_create();
 240
 241   return LDPS_OK;
 242 }
 243
 244 /// claim_file_hook - called by gold to see whether this file is one that
 245 /// our plugin can handle. We'll try to open it and register all the symbols
 246 /// with add_symbol if possible.
 247 static ld_plugin_status claim_file_hook(const ld_plugin_input_file *file,
 248                                         int *claimed) {
 249   lto_module_t M;
 250
 251   if (file->offset) {
 252     // Gold has found what might be IR part-way inside of a file, such as
 253     // an .a archive.
 254     if (lseek(file->fd, file->offset, SEEK_SET) == -1) {
 255       (*message)(LDPL_ERROR,
 256                  "Failed to seek to archive member of %s at offset %d: %s\n",
 257                  file->name,
 258                  file->offset, sys::StrError(errno).c_str());
 259       return LDPS_ERR;
 260     }
 261     void *buf = malloc(file->filesize);
 262     if (!buf) {
 263       (*message)(LDPL_ERROR,
 264                  "Failed to allocate buffer for archive member of size: %d\n",
 265                  file->filesize);
 266       return LDPS_ERR;
 267     }
 268     if (read(file->fd, buf, file->filesize) != file->filesize) {
 269       (*message)(LDPL_ERROR,
 270                  "Failed to read archive member of %s at offset %d: %s\n",
 271                  file->name,
 272                  file->offset,
 273                  sys::StrError(errno).c_str());
 274       free(buf);
 275       return LDPS_ERR;
 276     }
 277     if (!lto_module_is_object_file_in_memory(buf, file->filesize)) {
 278       free(buf);
 279       return LDPS_OK;
 280     }
 281     M = lto_module_create_from_memory(buf, file->filesize);
 282     if (!M) {
 283       (*message)(LDPL_ERROR, "Failed to create LLVM module: %s",
 284                  lto_get_error_message());
 285       return LDPS_ERR;
 286     }
 287     free(buf);
 288   } else {
 289     // FIXME: We should not need to pass -1 as the file size, but there
 290     // is a bug in BFD that causes it to pass 0 to us. Remove this once
 291     // that is fixed.
 292     off_t size = file->filesize ? file->filesize : -1;
 293
 294     // FIXME: We should not need to reset the position in the file, but there
 295     // is a bug in BFD. Remove this once that is fixed.
 296     off_t old_pos = lseek(file->fd, 0, SEEK_CUR);
 297
 298     lseek(file->fd, 0, SEEK_SET);
 299     M = lto_module_create_from_fd(file->fd, file->name, size);
 300
 301     lseek(file->fd, old_pos, SEEK_SET);
 302     if (!M)
 303       return LDPS_OK;
 304   }
 305
 306   *claimed = 1;
 307   Modules.resize(Modules.size() + 1);
 308   claimed_file &cf = Modules.back();
 309
 310   if (!options::triple.empty())
 311     lto_module_set_target_triple(M, options::triple.c_str());
 312
 313   cf.handle = file->handle;
 314   unsigned sym_count = lto_module_get_num_symbols(M);
 315   cf.syms.reserve(sym_count);
 316
 317   for (unsigned i = 0; i != sym_count; ++i) {
 318     lto_symbol_attributes attrs = lto_module_get_symbol_attribute(M, i);
 319     if ((attrs & LTO_SYMBOL_SCOPE_MASK) == LTO_SYMBOL_SCOPE_INTERNAL)
 320       continue;
 321
 322     cf.syms.push_back(ld_plugin_symbol());
 323     ld_plugin_symbol &sym = cf.syms.back();
 324     sym.name = const_cast<char *>(lto_module_get_symbol_name(M, i));
 325     sym.version = NULL;
 326
 327     int scope = attrs & LTO_SYMBOL_SCOPE_MASK;
 328     switch (scope) {
 329       case LTO_SYMBOL_SCOPE_HIDDEN:
 330         sym.visibility = LDPV_HIDDEN;
 331         break;
 332       case LTO_SYMBOL_SCOPE_PROTECTED:
 333         sym.visibility = LDPV_PROTECTED;
 334         break;
 335       case 0: // extern
 336       case LTO_SYMBOL_SCOPE_DEFAULT:
 337         sym.visibility = LDPV_DEFAULT;
 338         break;
 339       default:
 340         (*message)(LDPL_ERROR, "Unknown scope attribute: %d", scope);
 341         return LDPS_ERR;
 342     }
 343
 344     int definition = attrs & LTO_SYMBOL_DEFINITION_MASK;
 345     sym.comdat_key = NULL;
 346     switch (definition) {
 347       case LTO_SYMBOL_DEFINITION_REGULAR:
 348         sym.def = LDPK_DEF;
 349         break;
 350       case LTO_SYMBOL_DEFINITION_UNDEFINED:
 351         sym.def = LDPK_UNDEF;
 352         break;
 353       case LTO_SYMBOL_DEFINITION_TENTATIVE:
 354         sym.def = LDPK_COMMON;
 355         break;
 356       case LTO_SYMBOL_DEFINITION_WEAK:
 357         sym.comdat_key = sym.name;
 358         sym.def = LDPK_WEAKDEF;
 359         break;
 360       case LTO_SYMBOL_DEFINITION_WEAKUNDEF:
 361         sym.def = LDPK_WEAKUNDEF;
 362         break;
 363       default:
 364         (*message)(LDPL_ERROR, "Unknown definition attribute: %d", definition);
 365         return LDPS_ERR;
 366     }
 367
 368     sym.size = 0;
 369
 370     sym.resolution = LDPR_UNKNOWN;
 371   }
 372
 373   cf.syms.reserve(cf.syms.size());
 374
 375   if (!cf.syms.empty()) {
 376     if ((*add_symbols)(cf.handle, cf.syms.size(), &cf.syms[0]) != LDPS_OK) {
 377       (*message)(LDPL_ERROR, "Unable to add symbols!");
 378       return LDPS_ERR;
 379     }
 380   }
 381
 382   lto_codegen_add_module(code_gen, M);
 383   return LDPS_OK;
 384 }
 385
 386 /// all_symbols_read_hook - gold informs us that all symbols have been read.
 387 /// At this point, we use get_symbols to see if any of our definitions have
 388 /// been overridden by a native object file. Then, perform optimization and
 389 /// codegen.
 390 static ld_plugin_status all_symbols_read_hook(void) {
 391   std::ofstream api_file;
 392   if (options::generate_api_file) {
 393     api_file.open("apifile.txt", std::ofstream::out | std::ofstream::trunc);
 394     if (!api_file.is_open()) {
 395       (*message)(LDPL_FATAL, "Unable to open apifile.txt for writing.");
 396       abort();
 397     }
 398   }
 399
 400   // If we don't preserve any symbols, libLTO will assume that all symbols are
 401   // needed. Keep all symbols unless we're producing a final executable.
 402   bool anySymbolsPreserved = false;
 403   for (std::list<claimed_file>::iterator I = Modules.begin(),
 404          E = Modules.end(); I != E; ++I) {
 405     (*get_symbols)(I->handle, I->syms.size(), &I->syms[0]);
 406     for (unsigned i = 0, e = I->syms.size(); i != e; i++) {
 407       if (I->syms[i].resolution == LDPR_PREVAILING_DEF) {
 408         lto_codegen_add_must_preserve_symbol(code_gen, I->syms[i].name);
 409         anySymbolsPreserved = true;
 410
 411         if (options::generate_api_file)
 412           api_file << I->syms[i].name << "\n";
 413       }
 414     }
 415   }
 416
 417   if (options::generate_api_file)
 418     api_file.close();
 419
 420   if (!anySymbolsPreserved) {
 421     // All of the IL is unnecessary!
 422     lto_codegen_dispose(code_gen);
 423     return LDPS_OK;
 424   }
 425
 426   lto_codegen_set_pic_model(code_gen, output_type);
 427   lto_codegen_set_debug_model(code_gen, LTO_DEBUG_MODEL_DWARF);
 428   if (!options::as_path.empty()) {
 429     sys::Path p = sys::Program::FindProgramByName(options::as_path);
 430     lto_codegen_set_assembler_path(code_gen, p.c_str());
 431   }
 432   if (!options::as_args.empty()) {
 433     std::vector<const char *> as_args_p;
 434     for (std::vector<std::string>::iterator I = options::as_args.begin(),
 435            E = options::as_args.end(); I != E; ++I) {
 436       as_args_p.push_back(I->c_str());
 437     }
 438     lto_codegen_set_assembler_args(code_gen, &as_args_p[0], as_args_p.size());
 439   }
 440   if (!options::mcpu.empty())
 441     lto_codegen_set_cpu(code_gen, options::mcpu.c_str());
 442
 443   // Pass through extra options to the code generator.
 444   if (!options::extra.empty()) {
 445     for (std::vector<std::string>::iterator it = options::extra.begin();
 446          it != options::extra.end(); ++it) {
 447       lto_codegen_debug_options(code_gen, (*it).c_str());
 448     }
 449   }
 450
 451   if (options::generate_bc_file != options::BC_NO) {
 452     std::string path;
 453     if (options::generate_bc_file == options::BC_ONLY)
 454       path = output_name;
 455     else if (!options::bc_path.empty())
 456       path = options::bc_path;
 457     else
 458       path = output_name + ".bc";
 459     bool err = lto_codegen_write_merged_modules(code_gen, path.c_str());
 460     if (err)
 461       (*message)(LDPL_FATAL, "Failed to write the output file.");
 462     if (options::generate_bc_file == options::BC_ONLY)
 463       exit(0);
 464   }
 465   size_t bufsize = 0;
 466   const char *buffer = static_cast<const char *>(lto_codegen_compile(code_gen,
 467                                                                      &bufsize));
 468
 469   std::string ErrMsg;
 470
 471   const char *objPath;
 472   if (!options::obj_path.empty()) {
 473     objPath = options::obj_path.c_str();
 474   } else {
 475     sys::Path uniqueObjPath("/tmp/llvmgold.o");
 476     if (uniqueObjPath.createTemporaryFileOnDisk(true, &ErrMsg)) {
 477       (*message)(LDPL_ERROR, "%s", ErrMsg.c_str());
 478       return LDPS_ERR;
 479     }
 480     objPath = uniqueObjPath.c_str();
 481   }
 482   tool_output_file objFile(objPath, ErrMsg,
 483                              raw_fd_ostream::F_Binary);
 484     if (!ErrMsg.empty()) {
 485       (*message)(LDPL_ERROR, "%s", ErrMsg.c_str());
 486       return LDPS_ERR;
 487     }
 488
 489   objFile.os().write(buffer, bufsize);
 490   objFile.os().close();
 491   if (objFile.os().has_error()) {
 492     (*message)(LDPL_ERROR, "Error writing output file '%s'",
 493                objPath);
 494     objFile.os().clear_error();
 495     return LDPS_ERR;
 496   }
 497   objFile.keep();
 498
 499   lto_codegen_dispose(code_gen);
 500
 501   if ((*add_input_file)(objPath) != LDPS_OK) {
 502     (*message)(LDPL_ERROR, "Unable to add .o file to the link.");
 503     (*message)(LDPL_ERROR, "File left behind in: %s", objPath);
 504     return LDPS_ERR;
 505   }
 506
 507   if (!options::extra_library_path.empty() &&
 508       set_extra_library_path(options::extra_library_path.c_str()) != LDPS_OK) {
 509     (*message)(LDPL_ERROR, "Unable to set the extra library path.");
 510     return LDPS_ERR;
 511   }
 512
 513   for (std::vector<std::string>::iterator i = options::pass_through.begin(),
 514                                           e = options::pass_through.end();
 515        i != e; ++i) {
 516     std::string &item = *i;
 517     const char *item_p = item.c_str();
 518     if (llvm::StringRef(item).startswith("-l")) {
 519       if (add_input_library(item_p + 2) != LDPS_OK) {
 520         (*message)(LDPL_ERROR, "Unable to add library to the link.");
 521         return LDPS_ERR;
 522       }
 523     } else {
 524       if (add_input_file(item_p) != LDPS_OK) {
 525         (*message)(LDPL_ERROR, "Unable to add .o file to the link.");
 526         return LDPS_ERR;
 527       }
 528     }
 529   }
 530
 531   if (options::obj_path.empty())
 532     Cleanup.push_back(sys::Path(objPath));
 533
 534   return LDPS_OK;
 535 }
 536
 537 static ld_plugin_status cleanup_hook(void) {
 538   std::string ErrMsg;
 539
 540   for (int i = 0, e = Cleanup.size(); i != e; ++i)
 541     if (Cleanup[i].eraseFromDisk(false, &ErrMsg))
 542       (*message)(LDPL_ERROR, "Failed to delete '%s': %s", Cleanup[i].c_str(),
 543                  ErrMsg.c_str());
 544
 545   return LDPS_OK;
 546 }