X-Git-Url: http://plrg.eecs.uci.edu/git/?a=blobdiff_plain;f=tools%2Fgold%2Fgold-plugin.cpp;h=a42ce4f3e8d98187e08d3788b646ae05d5f32865;hb=c170f5f31cd697818bf470b57b72c11a1da78010;hp=e9d81870e6dc5fee05f64fe5443fd4ccff732d75;hpb=98c507ed5c2883bc8ef487d952e851da37f8b32f;p=oota-llvm.git diff --git a/tools/gold/gold-plugin.cpp b/tools/gold/gold-plugin.cpp index e9d81870e6d..a42ce4f3e8d 100644 --- a/tools/gold/gold-plugin.cpp +++ b/tools/gold/gold-plugin.cpp @@ -12,19 +12,30 @@ // //===----------------------------------------------------------------------===// +#include "llvm/Config/config.h" #include "plugin-api.h" #include "llvm-c/lto.h" -#include "llvm/Support/raw_ostream.h" -#include "llvm/System/Path.h" +#include "llvm/Support/ToolOutputFile.h" +#include "llvm/Support/Errno.h" +#include "llvm/Support/Path.h" +#include "llvm/Support/Program.h" #include #include #include +#include #include #include +// Support Windows/MinGW crazyness. +#ifdef _WIN32 +# include +# define lseek _lseek +# define read _read +#endif + using namespace llvm; namespace { @@ -37,26 +48,82 @@ namespace { ld_plugin_add_symbols add_symbols = NULL; ld_plugin_get_symbols get_symbols = NULL; ld_plugin_add_input_file add_input_file = NULL; + ld_plugin_add_input_library add_input_library = NULL; + ld_plugin_set_extra_library_path set_extra_library_path = NULL; + ld_plugin_get_view get_view = NULL; ld_plugin_message message = discard_message; int api_version = 0; int gold_version = 0; struct claimed_file { - lto_module_t M; void *handle; std::vector syms; }; lto_codegen_model output_type = LTO_CODEGEN_PIC_MODEL_STATIC; + std::string output_name = ""; std::list Modules; std::vector Cleanup; + lto_code_gen_t code_gen = NULL; +} + +namespace options { + enum generate_bc { BC_NO, BC_ALSO, BC_ONLY }; + static bool generate_api_file = false; + static generate_bc generate_bc_file = BC_NO; + static std::string bc_path; + static std::string obj_path; + static std::string extra_library_path; + static std::string triple; + static std::string mcpu; + // Additional options to pass into the code generator. + // Note: This array will contain all plugin options which are not claimed + // as plugin exclusive to pass to the code generator. + // For example, "generate-api-file" and "as"options are for the plugin + // use only and will not be passed. + static std::vector extra; + + static void process_plugin_option(const char* opt_) + { + if (opt_ == NULL) + return; + llvm::StringRef opt = opt_; + + if (opt == "generate-api-file") { + generate_api_file = true; + } else if (opt.startswith("mcpu=")) { + mcpu = opt.substr(strlen("mcpu=")); + } else if (opt.startswith("extra-library-path=")) { + extra_library_path = opt.substr(strlen("extra_library_path=")); + } else if (opt.startswith("mtriple=")) { + triple = opt.substr(strlen("mtriple=")); + } else if (opt.startswith("obj-path=")) { + obj_path = opt.substr(strlen("obj-path=")); + } else if (opt == "emit-llvm") { + generate_bc_file = BC_ONLY; + } else if (opt == "also-emit-llvm") { + generate_bc_file = BC_ALSO; + } else if (opt.startswith("also-emit-llvm=")) { + llvm::StringRef path = opt.substr(strlen("also-emit-llvm=")); + generate_bc_file = BC_ALSO; + if (!bc_path.empty()) { + (*message)(LDPL_WARNING, "Path to the output IL file specified twice. " + "Discarding %s", opt_); + } else { + bc_path = path; + } + } else { + // Save this option to pass to the code generator. + extra.push_back(opt); + } + } } -ld_plugin_status claim_file_hook(const ld_plugin_input_file *file, - int *claimed); -ld_plugin_status all_symbols_read_hook(void); -ld_plugin_status cleanup_hook(void); +static ld_plugin_status claim_file_hook(const ld_plugin_input_file *file, + int *claimed); +static ld_plugin_status all_symbols_read_hook(void); +static ld_plugin_status cleanup_hook(void); extern "C" ld_plugin_status onload(ld_plugin_tv *tv); ld_plugin_status onload(ld_plugin_tv *tv) { @@ -67,8 +134,6 @@ ld_plugin_status onload(ld_plugin_tv *tv) { // for services. bool registeredClaimFile = false; - bool registeredAllSymbolsRead = false; - bool registeredCleanup = false; for (; tv->tv_tag != LDPT_NULL; ++tv) { switch (tv->tv_tag) { @@ -78,6 +143,9 @@ ld_plugin_status onload(ld_plugin_tv *tv) { case LDPT_GOLD_VERSION: // major * 100 + minor gold_version = tv->tv_u.tv_val; break; + case LDPT_OUTPUT_NAME: + output_name = tv->tv_u.tv_string; + break; case LDPT_LINKER_OUTPUT: switch (tv->tv_u.tv_val) { case LDPO_REL: // .o @@ -96,7 +164,7 @@ ld_plugin_status onload(ld_plugin_tv *tv) { //output_type = LTO_CODEGEN_PIC_MODEL_DYNAMIC_NO_PIC; break; case LDPT_OPTION: - (*message)(LDPL_WARNING, "Ignoring flag %s", tv->tv_u.tv_string); + options::process_plugin_option(tv->tv_u.tv_string); break; case LDPT_REGISTER_CLAIM_FILE_HOOK: { ld_plugin_register_claim_file callback; @@ -114,7 +182,7 @@ ld_plugin_status onload(ld_plugin_tv *tv) { if ((*callback)(all_symbols_read_hook) != LDPS_OK) return LDPS_ERR; - registeredAllSymbolsRead = true; + code_gen = lto_codegen_create(); } break; case LDPT_REGISTER_CLEANUP_HOOK: { ld_plugin_register_cleanup callback; @@ -122,8 +190,6 @@ ld_plugin_status onload(ld_plugin_tv *tv) { if ((*callback)(cleanup_hook) != LDPS_OK) return LDPS_ERR; - - registeredCleanup = true; } break; case LDPT_ADD_SYMBOLS: add_symbols = tv->tv_u.tv_add_symbols; @@ -134,6 +200,15 @@ ld_plugin_status onload(ld_plugin_tv *tv) { case LDPT_ADD_INPUT_FILE: add_input_file = tv->tv_u.tv_add_input_file; break; + case LDPT_ADD_INPUT_LIBRARY: + add_input_library = tv->tv_u.tv_add_input_file; + break; + case LDPT_SET_EXTRA_LIBRARY_PATH: + set_extra_library_path = tv->tv_u.tv_set_extra_library_path; + break; + case LDPT_GET_VIEW: + get_view = tv->tv_u.tv_get_view; + break; case LDPT_MESSAGE: message = tv->tv_u.tv_message; break; @@ -143,13 +218,13 @@ ld_plugin_status onload(ld_plugin_tv *tv) { } if (!registeredClaimFile) { - (*message)(LDPL_ERROR, "register_claim_file not passed to LLVMgold."); - return LDPS_ERR; - } + (*message)(LDPL_ERROR, "register_claim_file not passed to LLVMgold."); + return LDPS_ERR; + } if (!add_symbols) { - (*message)(LDPL_ERROR, "add_symbols not passed to LLVMgold."); - return LDPS_ERR; - } + (*message)(LDPL_ERROR, "add_symbols not passed to LLVMgold."); + return LDPS_ERR; + } return LDPS_OK; } @@ -157,66 +232,53 @@ ld_plugin_status onload(ld_plugin_tv *tv) { /// claim_file_hook - called by gold to see whether this file is one that /// our plugin can handle. We'll try to open it and register all the symbols /// with add_symbol if possible. -ld_plugin_status claim_file_hook(const ld_plugin_input_file *file, - int *claimed) { - void *buf = NULL; - if (file->offset) { - // Gold has found what might be IR part-way inside of a file, such as - // an .a archive. - if (lseek(file->fd, file->offset, SEEK_SET) == -1) { - (*message)(LDPL_ERROR, - "Failed to seek to archive member of %s at offset %d: %s\n", - file->name, - file->offset, strerror(errno)); - return LDPS_ERR; - } - buf = malloc(file->filesize); - if (!buf) { - (*message)(LDPL_ERROR, - "Failed to allocate buffer for archive member of size: %d\n", - file->filesize); +static ld_plugin_status claim_file_hook(const ld_plugin_input_file *file, + int *claimed) { + lto_module_t M; + + if (get_view) { + const void *view; + if (get_view(file->handle, &view) != LDPS_OK) { + (*message)(LDPL_ERROR, "Failed to get a view of %s", file->name); return LDPS_ERR; } - if (read(file->fd, buf, file->filesize) != file->filesize) { - (*message)(LDPL_ERROR, - "Failed to read archive member of %s at offset %d: %s\n", - file->name, - file->offset, - strerror(errno)); - free(buf); + M = lto_module_create_from_memory(view, file->filesize); + } else if (file->offset) { + // Gold has found what might be IR part-way inside of a file, such as + // an .a archive. + M = lto_module_create_from_fd_at_offset(file->fd, file->name, -1, + file->filesize, file->offset); + } else { + M = lto_module_create_from_fd(file->fd, file->name, file->filesize); + } + if (!M) { + if (const char* msg = lto_get_error_message()) { + (*message)(LDPL_ERROR, "Failed to create LTO module: %s", msg); return LDPS_ERR; } - if (!lto_module_is_object_file_in_memory(buf, file->filesize)) { - free(buf); - return LDPS_OK; - } - } else if (!lto_module_is_object_file(file->name)) return LDPS_OK; + } *claimed = 1; Modules.resize(Modules.size() + 1); claimed_file &cf = Modules.back(); - cf.M = buf ? lto_module_create_from_memory(buf, file->filesize) : - lto_module_create(file->name); - free(buf); - if (!cf.M) { - (*message)(LDPL_ERROR, "Failed to create LLVM module: %s", - lto_get_error_message()); - return LDPS_ERR; - } + if (!options::triple.empty()) + lto_module_set_target_triple(M, options::triple.c_str()); + cf.handle = file->handle; - unsigned sym_count = lto_module_get_num_symbols(cf.M); + unsigned sym_count = lto_module_get_num_symbols(M); cf.syms.reserve(sym_count); for (unsigned i = 0; i != sym_count; ++i) { - lto_symbol_attributes attrs = lto_module_get_symbol_attribute(cf.M, i); + lto_symbol_attributes attrs = lto_module_get_symbol_attribute(M, i); if ((attrs & LTO_SYMBOL_SCOPE_MASK) == LTO_SYMBOL_SCOPE_INTERNAL) continue; cf.syms.push_back(ld_plugin_symbol()); ld_plugin_symbol &sym = cf.syms.back(); - sym.name = const_cast(lto_module_get_symbol_name(cf.M, i)); + sym.name = const_cast(lto_module_get_symbol_name(M, i)); + sym.name = strdup(sym.name); sym.version = NULL; int scope = attrs & LTO_SYMBOL_SCOPE_MASK; @@ -237,6 +299,7 @@ ld_plugin_status claim_file_hook(const ld_plugin_input_file *file, } int definition = attrs & LTO_SYMBOL_DEFINITION_MASK; + sym.comdat_key = NULL; switch (definition) { case LTO_SYMBOL_DEFINITION_REGULAR: sym.def = LDPK_DEF; @@ -248,16 +311,18 @@ ld_plugin_status claim_file_hook(const ld_plugin_input_file *file, sym.def = LDPK_COMMON; break; case LTO_SYMBOL_DEFINITION_WEAK: + sym.comdat_key = sym.name; sym.def = LDPK_WEAKDEF; break; + case LTO_SYMBOL_DEFINITION_WEAKUNDEF: + sym.def = LDPK_WEAKUNDEF; + break; default: (*message)(LDPL_ERROR, "Unknown definition attribute: %d", definition); return LDPS_ERR; } - // LLVM never emits COMDAT. sym.size = 0; - sym.comdat_key = NULL; sym.resolution = LDPR_UNKNOWN; } @@ -271,6 +336,11 @@ ld_plugin_status claim_file_hook(const ld_plugin_input_file *file, } } + if (code_gen) + lto_codegen_add_module(code_gen, M); + + lto_module_dispose(M); + return LDPS_OK; } @@ -278,76 +348,106 @@ ld_plugin_status claim_file_hook(const ld_plugin_input_file *file, /// At this point, we use get_symbols to see if any of our definitions have /// been overridden by a native object file. Then, perform optimization and /// codegen. -ld_plugin_status all_symbols_read_hook(void) { - lto_code_gen_t cg = lto_codegen_create(); - - for (std::list::iterator I = Modules.begin(), - E = Modules.end(); I != E; ++I) - lto_codegen_add_module(cg, I->M); +static ld_plugin_status all_symbols_read_hook(void) { + std::ofstream api_file; + assert(code_gen); + + if (options::generate_api_file) { + api_file.open("apifile.txt", std::ofstream::out | std::ofstream::trunc); + if (!api_file.is_open()) { + (*message)(LDPL_FATAL, "Unable to open apifile.txt for writing."); + abort(); + } + } // If we don't preserve any symbols, libLTO will assume that all symbols are // needed. Keep all symbols unless we're producing a final executable. - if (output_type == LTO_CODEGEN_PIC_MODEL_STATIC) { - bool anySymbolsPreserved = false; - for (std::list::iterator I = Modules.begin(), + bool anySymbolsPreserved = false; + for (std::list::iterator I = Modules.begin(), E = Modules.end(); I != E; ++I) { - (*get_symbols)(I->handle, I->syms.size(), &I->syms[0]); - for (unsigned i = 0, e = I->syms.size(); i != e; i++) { - if (I->syms[i].resolution == LDPR_PREVAILING_DEF || - (I->syms[i].def == LDPK_COMMON && - I->syms[i].resolution == LDPR_RESOLVED_IR)) { - lto_codegen_add_must_preserve_symbol(cg, I->syms[i].name); - anySymbolsPreserved = true; - } + if (I->syms.empty()) + continue; + (*get_symbols)(I->handle, I->syms.size(), &I->syms[0]); + for (unsigned i = 0, e = I->syms.size(); i != e; i++) { + if (I->syms[i].resolution == LDPR_PREVAILING_DEF) { + lto_codegen_add_must_preserve_symbol(code_gen, I->syms[i].name); + anySymbolsPreserved = true; + + if (options::generate_api_file) + api_file << I->syms[i].name << "\n"; } } - - if (!anySymbolsPreserved) { - // This entire file is unnecessary! - lto_codegen_dispose(cg); - return LDPS_OK; - } } - lto_codegen_set_pic_model(cg, output_type); - lto_codegen_set_debug_model(cg, LTO_DEBUG_MODEL_DWARF); + if (options::generate_api_file) + api_file.close(); + + if (!anySymbolsPreserved) { + // All of the IL is unnecessary! + lto_codegen_dispose(code_gen); + return LDPS_OK; + } - size_t bufsize = 0; - const char *buffer = static_cast(lto_codegen_compile(cg, - &bufsize)); + lto_codegen_set_pic_model(code_gen, output_type); + lto_codegen_set_debug_model(code_gen, LTO_DEBUG_MODEL_DWARF); + if (!options::mcpu.empty()) + lto_codegen_set_cpu(code_gen, options::mcpu.c_str()); - std::string ErrMsg; + // Pass through extra options to the code generator. + if (!options::extra.empty()) { + for (std::vector::iterator it = options::extra.begin(); + it != options::extra.end(); ++it) { + lto_codegen_debug_options(code_gen, (*it).c_str()); + } + } - sys::Path uniqueObjPath("/tmp/llvmgold.o"); - if (uniqueObjPath.createTemporaryFileOnDisk(true, &ErrMsg)) { - (*message)(LDPL_ERROR, "%s", ErrMsg.c_str()); - return LDPS_ERR; + if (options::generate_bc_file != options::BC_NO) { + std::string path; + if (options::generate_bc_file == options::BC_ONLY) + path = output_name; + else if (!options::bc_path.empty()) + path = options::bc_path; + else + path = output_name + ".bc"; + bool err = lto_codegen_write_merged_modules(code_gen, path.c_str()); + if (err) + (*message)(LDPL_FATAL, "Failed to write the output file."); + if (options::generate_bc_file == options::BC_ONLY) + exit(0); } - raw_fd_ostream *objFile = new raw_fd_ostream(uniqueObjPath.c_str(), true, - ErrMsg); - if (!ErrMsg.empty()) { - delete objFile; - (*message)(LDPL_ERROR, "%s", ErrMsg.c_str()); - return LDPS_ERR; + const char *objPath; + if (lto_codegen_compile_to_file(code_gen, &objPath)) { + (*message)(LDPL_ERROR, "Could not produce a combined object file\n"); } - objFile->write(buffer, bufsize); - objFile->close(); - - lto_codegen_dispose(cg); + lto_codegen_dispose(code_gen); + for (std::list::iterator I = Modules.begin(), + E = Modules.end(); I != E; ++I) { + for (unsigned i = 0; i != I->syms.size(); ++i) { + ld_plugin_symbol &sym = I->syms[i]; + free(sym.name); + } + } - if ((*add_input_file)(const_cast(uniqueObjPath.c_str())) != LDPS_OK) { + if ((*add_input_file)(objPath) != LDPS_OK) { (*message)(LDPL_ERROR, "Unable to add .o file to the link."); - (*message)(LDPL_ERROR, "File left behind in: %s", uniqueObjPath.c_str()); + (*message)(LDPL_ERROR, "File left behind in: %s", objPath); + return LDPS_ERR; + } + + if (!options::extra_library_path.empty() && + set_extra_library_path(options::extra_library_path.c_str()) != LDPS_OK) { + (*message)(LDPL_ERROR, "Unable to set the extra library path."); return LDPS_ERR; } - Cleanup.push_back(uniqueObjPath); + if (options::obj_path.empty()) + Cleanup.push_back(sys::Path(objPath)); return LDPS_OK; } -ld_plugin_status cleanup_hook(void) { +static ld_plugin_status cleanup_hook(void) { std::string ErrMsg; for (int i = 0, e = Cleanup.size(); i != e; ++i)