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 "plugin-api.h"
  16
  17 #include "llvm-c/lto.h"
  18
  19 #include "llvm/Support/raw_ostream.h"
  20 #include "llvm/System/Path.h"
  21
  22 #include <cerrno>
  23 #include <cstdlib>
  24 #include <cstring>
  25 #include <list>
  26 #include <vector>
  27
  28 using namespace llvm;
  29
  30 namespace {
  31   ld_plugin_status discard_message(int level, const char *format, ...) {
  32     // Die loudly. Recent versions of Gold pass ld_plugin_message as the first
  33     // callback in the transfer vector. This should never be called.
  34     abort();
  35   }
  36
  37   ld_plugin_add_symbols add_symbols = NULL;
  38   ld_plugin_get_symbols get_symbols = NULL;
  39   ld_plugin_add_input_file add_input_file = NULL;
  40   ld_plugin_message message = discard_message;
  41
  42   int api_version = 0;
  43   int gold_version = 0;
  44
  45   struct claimed_file {
  46     lto_module_t M;
  47     void *handle;
  48     void *buf;
  49     std::vector<ld_plugin_symbol> syms;
  50   };
  51
  52   lto_codegen_model output_type = LTO_CODEGEN_PIC_MODEL_STATIC;
  53   std::list<claimed_file> Modules;
  54   std::vector<sys::Path> Cleanup;
  55 }
  56
  57 ld_plugin_status claim_file_hook(const ld_plugin_input_file *file,
  58                                  int *claimed);
  59 ld_plugin_status all_symbols_read_hook(void);
  60 ld_plugin_status cleanup_hook(void);
  61
  62 extern "C" ld_plugin_status onload(ld_plugin_tv *tv);
  63 ld_plugin_status onload(ld_plugin_tv *tv) {
  64   // We're given a pointer to the first transfer vector. We read through them
  65   // until we find one where tv_tag == LDPT_NULL. The REGISTER_* tagged values
  66   // contain pointers to functions that we need to call to register our own
  67   // hooks. The others are addresses of functions we can use to call into gold
  68   // for services.
  69
  70   bool registeredClaimFile = false;
  71   bool registeredAllSymbolsRead = false;
  72   bool registeredCleanup = false;
  73
  74   for (; tv->tv_tag != LDPT_NULL; ++tv) {
  75     switch (tv->tv_tag) {
  76       case LDPT_API_VERSION:
  77         api_version = tv->tv_u.tv_val;
  78         break;
  79       case LDPT_GOLD_VERSION:  // major * 100 + minor
  80         gold_version = tv->tv_u.tv_val;
  81         break;
  82       case LDPT_LINKER_OUTPUT:
  83         switch (tv->tv_u.tv_val) {
  84           case LDPO_REL:  // .o
  85           case LDPO_DYN:  // .so
  86             output_type = LTO_CODEGEN_PIC_MODEL_DYNAMIC;
  87             break;
  88           case LDPO_EXEC:  // .exe
  89             output_type = LTO_CODEGEN_PIC_MODEL_STATIC;
  90             break;
  91           default:
  92             (*message)(LDPL_ERROR, "Unknown output file type %d",
  93                        tv->tv_u.tv_val);
  94             return LDPS_ERR;
  95         }
  96         // TODO: add an option to disable PIC.
  97         //output_type = LTO_CODEGEN_PIC_MODEL_DYNAMIC_NO_PIC;
  98         break;
  99       case LDPT_OPTION:
 100         (*message)(LDPL_WARNING, "Ignoring flag %s", tv->tv_u.tv_string);
 101         break;
 102       case LDPT_REGISTER_CLAIM_FILE_HOOK: {
 103         ld_plugin_register_claim_file callback;
 104         callback = tv->tv_u.tv_register_claim_file;
 105
 106         if ((*callback)(claim_file_hook) != LDPS_OK)
 107           return LDPS_ERR;
 108
 109         registeredClaimFile = true;
 110       } break;
 111       case LDPT_REGISTER_ALL_SYMBOLS_READ_HOOK: {
 112         ld_plugin_register_all_symbols_read callback;
 113         callback = tv->tv_u.tv_register_all_symbols_read;
 114
 115         if ((*callback)(all_symbols_read_hook) != LDPS_OK)
 116           return LDPS_ERR;
 117
 118         registeredAllSymbolsRead = true;
 119       } break;
 120       case LDPT_REGISTER_CLEANUP_HOOK: {
 121         ld_plugin_register_cleanup callback;
 122         callback = tv->tv_u.tv_register_cleanup;
 123
 124         if ((*callback)(cleanup_hook) != LDPS_OK)
 125           return LDPS_ERR;
 126
 127         registeredCleanup = true;
 128       } break;
 129       case LDPT_ADD_SYMBOLS:
 130         add_symbols = tv->tv_u.tv_add_symbols;
 131         break;
 132       case LDPT_GET_SYMBOLS:
 133         get_symbols = tv->tv_u.tv_get_symbols;
 134         break;
 135       case LDPT_ADD_INPUT_FILE:
 136         add_input_file = tv->tv_u.tv_add_input_file;
 137         break;
 138       case LDPT_MESSAGE:
 139         message = tv->tv_u.tv_message;
 140         break;
 141       default:
 142         break;
 143     }
 144   }
 145
 146   if (!registeredClaimFile || !registeredAllSymbolsRead || !registeredCleanup ||
 147       !add_symbols || !get_symbols || !add_input_file) {
 148     (*message)(LDPL_ERROR, "Not all hooks registered for LLVMgold.");
 149     return LDPS_ERR;
 150   }
 151
 152   return LDPS_OK;
 153 }
 154
 155 /// claim_file_hook - called by gold to see whether this file is one that
 156 /// our plugin can handle. We'll try to open it and register all the symbols
 157 /// with add_symbol if possible.
 158 ld_plugin_status claim_file_hook(const ld_plugin_input_file *file,
 159                                  int *claimed) {
 160   void *buf = NULL;
 161   if (file->offset) {
 162     /* This is probably an archive member containing either an ELF object, or
 163      * LLVM IR. Find out which one it is */
 164     if (lseek(file->fd, file->offset, SEEK_SET) == -1) {
 165       (*message)(LDPL_ERROR,
 166                  "Failed to seek to archive member of %s at offset %d: %s\n",
 167                  file->name,
 168                  file->offset, strerror(errno));
 169       return LDPS_ERR;
 170     }
 171     buf = malloc(file->filesize);
 172     if (!buf) {
 173       (*message)(LDPL_ERROR,
 174                  "Failed to allocate buffer for archive member of size: %d\n",
 175                  file->filesize);
 176       return LDPS_ERR;
 177     }
 178     if (read(file->fd, buf, file->filesize) != file->filesize) {
 179       (*message)(LDPL_ERROR,
 180                  "Failed to read archive member of %s at offset %d: %s\n",
 181                  file->name,
 182                  file->offset,
 183                  strerror(errno));
 184       free(buf);
 185       return LDPS_ERR;
 186     }
 187     if (!lto_module_is_object_file_in_memory(buf, file->filesize)) {
 188       free(buf);
 189       return LDPS_OK;
 190     }
 191   } else if (!lto_module_is_object_file(file->name))
 192     return LDPS_OK;
 193
 194   *claimed = 1;
 195   Modules.resize(Modules.size() + 1);
 196   claimed_file &cf = Modules.back();
 197
 198   cf.M = buf ?  lto_module_create_from_memory(buf, file->filesize) :
 199                 lto_module_create(file->name);
 200   cf.buf = buf;
 201   if (!cf.M) {
 202     (*message)(LDPL_ERROR, "Failed to create LLVM module: %s",
 203                lto_get_error_message());
 204     return LDPS_ERR;
 205   }
 206   cf.handle = file->handle;
 207   unsigned sym_count = lto_module_get_num_symbols(cf.M);
 208   cf.syms.reserve(sym_count);
 209
 210   for (unsigned i = 0; i != sym_count; ++i) {
 211     lto_symbol_attributes attrs = lto_module_get_symbol_attribute(cf.M, i);
 212     if ((attrs & LTO_SYMBOL_SCOPE_MASK) == LTO_SYMBOL_SCOPE_INTERNAL)
 213       continue;
 214
 215     cf.syms.push_back(ld_plugin_symbol());
 216     ld_plugin_symbol &sym = cf.syms.back();
 217     sym.name = const_cast<char *>(lto_module_get_symbol_name(cf.M, i));
 218     sym.version = NULL;
 219
 220     int scope = attrs & LTO_SYMBOL_SCOPE_MASK;
 221     switch (scope) {
 222       case LTO_SYMBOL_SCOPE_HIDDEN:
 223         sym.visibility = LDPV_HIDDEN;
 224         break;
 225       case LTO_SYMBOL_SCOPE_PROTECTED:
 226         sym.visibility = LDPV_PROTECTED;
 227         break;
 228       case 0: // extern
 229       case LTO_SYMBOL_SCOPE_DEFAULT:
 230         sym.visibility = LDPV_DEFAULT;
 231         break;
 232       default:
 233         (*message)(LDPL_ERROR, "Unknown scope attribute: %d", scope);
 234         free(buf);
 235         return LDPS_ERR;
 236     }
 237
 238     int definition = attrs & LTO_SYMBOL_DEFINITION_MASK;
 239     switch (definition) {
 240       case LTO_SYMBOL_DEFINITION_REGULAR:
 241         sym.def = LDPK_DEF;
 242         break;
 243       case LTO_SYMBOL_DEFINITION_UNDEFINED:
 244         sym.def = LDPK_UNDEF;
 245         break;
 246       case LTO_SYMBOL_DEFINITION_TENTATIVE:
 247         sym.def = LDPK_COMMON;
 248         break;
 249       case LTO_SYMBOL_DEFINITION_WEAK:
 250         sym.def = LDPK_WEAKDEF;
 251         break;
 252       default:
 253         (*message)(LDPL_ERROR, "Unknown definition attribute: %d", definition);
 254         free(buf);
 255         return LDPS_ERR;
 256     }
 257
 258     // LLVM never emits COMDAT.
 259     sym.size = 0;
 260     sym.comdat_key = NULL;
 261
 262     sym.resolution = LDPR_UNKNOWN;
 263   }
 264
 265   cf.syms.reserve(cf.syms.size());
 266
 267   if (!cf.syms.empty()) {
 268     if ((*add_symbols)(cf.handle, cf.syms.size(), &cf.syms[0]) != LDPS_OK) {
 269       (*message)(LDPL_ERROR, "Unable to add symbols!");
 270       free(buf);
 271       return LDPS_ERR;
 272     }
 273   }
 274
 275   return LDPS_OK;
 276 }
 277
 278 /// all_symbols_read_hook - gold informs us that all symbols have been read.
 279 /// At this point, we use get_symbols to see if any of our definitions have
 280 /// been overridden by a native object file. Then, perform optimization and
 281 /// codegen.
 282 ld_plugin_status all_symbols_read_hook(void) {
 283   lto_code_gen_t cg = lto_codegen_create();
 284
 285   for (std::list<claimed_file>::iterator I = Modules.begin(),
 286        E = Modules.end(); I != E; ++I)
 287     lto_codegen_add_module(cg, I->M);
 288
 289   // If we don't preserve any symbols, libLTO will assume that all symbols are
 290   // needed. Keep all symbols unless we're producing a final executable.
 291   if (output_type == LTO_CODEGEN_PIC_MODEL_STATIC) {
 292     bool anySymbolsPreserved = false;
 293     for (std::list<claimed_file>::iterator I = Modules.begin(),
 294          E = Modules.end(); I != E; ++I) {
 295       (*get_symbols)(I->handle, I->syms.size(), &I->syms[0]);
 296       for (unsigned i = 0, e = I->syms.size(); i != e; i++) {
 297         (*message)(LDPL_WARNING, "def: %d visibility: %d resolution %d",
 298                    I->syms[i].def, I->syms[i].visibility, I->syms[i].resolution);
 299         if (I->syms[i].resolution == LDPR_PREVAILING_DEF) {
 300           lto_codegen_add_must_preserve_symbol(cg, I->syms[i].name);
 301           anySymbolsPreserved = true;
 302         }
 303       }
 304     }
 305
 306     if (!anySymbolsPreserved) {
 307       // This entire file is unnecessary!
 308       lto_codegen_dispose(cg);
 309       return LDPS_OK;
 310     }
 311   }
 312
 313   lto_codegen_set_pic_model(cg, output_type);
 314   lto_codegen_set_debug_model(cg, LTO_DEBUG_MODEL_DWARF);
 315
 316   size_t bufsize = 0;
 317   const char *buffer = static_cast<const char *>(lto_codegen_compile(cg,
 318                                                                      &bufsize));
 319
 320   std::string ErrMsg;
 321
 322   sys::Path uniqueObjPath("/tmp/llvmgold.o");
 323   if (uniqueObjPath.createTemporaryFileOnDisk(true, &ErrMsg)) {
 324     (*message)(LDPL_ERROR, "%s", ErrMsg.c_str());
 325     return LDPS_ERR;
 326   }
 327   raw_fd_ostream *objFile = new raw_fd_ostream(uniqueObjPath.c_str(), true,
 328                                                ErrMsg);
 329   if (!ErrMsg.empty()) {
 330     delete objFile;
 331     (*message)(LDPL_ERROR, "%s", ErrMsg.c_str());
 332     return LDPS_ERR;
 333   }
 334
 335   objFile->write(buffer, bufsize);
 336   objFile->close();
 337
 338   lto_codegen_dispose(cg);
 339   for (std::list<claimed_file>::iterator I = Modules.begin(),
 340        E = Modules.end(); I != E; ++I) {
 341     free(I->buf);
 342   }
 343
 344   if ((*add_input_file)(const_cast<char*>(uniqueObjPath.c_str())) != LDPS_OK) {
 345     (*message)(LDPL_ERROR, "Unable to add .o file to the link.");
 346     (*message)(LDPL_ERROR, "File left behind in: %s", uniqueObjPath.c_str());
 347     return LDPS_ERR;
 348   }
 349
 350   Cleanup.push_back(uniqueObjPath);
 351
 352   return LDPS_OK;
 353 }
 354
 355 ld_plugin_status cleanup_hook(void) {
 356   std::string ErrMsg;
 357
 358   for (int i = 0, e = Cleanup.size(); i != e; ++i)
 359     if (Cleanup[i].eraseFromDisk(false, &ErrMsg))
 360       (*message)(LDPL_ERROR, "Failed to delete '%s': %s", Cleanup[i].c_str(),
 361                  ErrMsg.c_str());
 362
 363   return LDPS_OK;
 364 }