1 //===- LTO.cpp ------------------------------------------------------------===// 2 // 3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. 4 // See https://llvm.org/LICENSE.txt for license information. 5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception 6 // 7 //===----------------------------------------------------------------------===// 8 9 #include "LTO.h" 10 #include "Config.h" 11 #include "Driver.h" 12 #include "InputFiles.h" 13 #include "Symbols.h" 14 #include "Target.h" 15 16 #include "lld/Common/Args.h" 17 #include "lld/Common/CommonLinkerContext.h" 18 #include "lld/Common/Strings.h" 19 #include "lld/Common/TargetOptionsCommandFlags.h" 20 #include "llvm/LTO/Config.h" 21 #include "llvm/LTO/LTO.h" 22 #include "llvm/Support/Caching.h" 23 #include "llvm/Support/FileSystem.h" 24 #include "llvm/Support/Path.h" 25 #include "llvm/Support/raw_ostream.h" 26 #include "llvm/Transforms/ObjCARC.h" 27 28 using namespace lld; 29 using namespace lld::macho; 30 using namespace llvm; 31 using namespace llvm::MachO; 32 using namespace llvm::sys; 33 34 static lto::Config createConfig() { 35 lto::Config c; 36 c.Options = initTargetOptionsFromCodeGenFlags(); 37 c.CodeModel = getCodeModelFromCMModel(); 38 c.CPU = getCPUStr(); 39 c.MAttrs = getMAttrs(); 40 c.DiagHandler = diagnosticHandler; 41 c.UseNewPM = config->ltoNewPassManager; 42 c.PreCodeGenPassesHook = [](legacy::PassManager &pm) { 43 pm.add(createObjCARCContractPass()); 44 }; 45 c.TimeTraceEnabled = config->timeTraceEnabled; 46 c.TimeTraceGranularity = config->timeTraceGranularity; 47 c.OptLevel = config->ltoo; 48 c.CGOptLevel = args::getCGOptLevel(config->ltoo); 49 if (config->saveTemps) 50 checkError(c.addSaveTemps(config->outputFile.str() + ".", 51 /*UseInputModulePath=*/true)); 52 return c; 53 } 54 55 BitcodeCompiler::BitcodeCompiler() { 56 lto::ThinBackend backend = lto::createInProcessThinBackend( 57 heavyweight_hardware_concurrency(config->thinLTOJobs)); 58 ltoObj = std::make_unique<lto::LTO>(createConfig(), backend); 59 } 60 61 void BitcodeCompiler::add(BitcodeFile &f) { 62 ArrayRef<lto::InputFile::Symbol> objSyms = f.obj->symbols(); 63 std::vector<lto::SymbolResolution> resols; 64 resols.reserve(objSyms.size()); 65 66 // Provide a resolution to the LTO API for each symbol. 67 bool exportDynamic = 68 config->outputType != MH_EXECUTE || config->exportDynamic; 69 auto symIt = f.symbols.begin(); 70 for (const lto::InputFile::Symbol &objSym : objSyms) { 71 resols.emplace_back(); 72 lto::SymbolResolution &r = resols.back(); 73 Symbol *sym = *symIt++; 74 75 // Ideally we shouldn't check for SF_Undefined but currently IRObjectFile 76 // reports two symbols for module ASM defined. Without this check, lld 77 // flags an undefined in IR with a definition in ASM as prevailing. 78 // Once IRObjectFile is fixed to report only one symbol this hack can 79 // be removed. 80 r.Prevailing = !objSym.isUndefined() && sym->getFile() == &f; 81 82 if (const auto *defined = dyn_cast<Defined>(sym)) 83 r.ExportDynamic = 84 defined->isExternal() && !defined->privateExtern && exportDynamic; 85 else if (const auto *common = dyn_cast<CommonSymbol>(sym)) 86 r.ExportDynamic = !common->privateExtern && exportDynamic; 87 88 r.VisibleToRegularObj = 89 sym->isUsedInRegularObj || (r.Prevailing && r.ExportDynamic); 90 91 // Un-define the symbol so that we don't get duplicate symbol errors when we 92 // load the ObjFile emitted by LTO compilation. 93 if (r.Prevailing) 94 replaceSymbol<Undefined>(sym, sym->getName(), sym->getFile(), 95 RefState::Strong); 96 97 // TODO: set the other resolution configs properly 98 } 99 checkError(ltoObj->add(std::move(f.obj), resols)); 100 } 101 102 // Merge all the bitcode files we have seen, codegen the result 103 // and return the resulting ObjectFile(s). 104 std::vector<ObjFile *> BitcodeCompiler::compile() { 105 unsigned maxTasks = ltoObj->getMaxTasks(); 106 buf.resize(maxTasks); 107 files.resize(maxTasks); 108 109 // The -cache_path_lto option specifies the path to a directory in which 110 // to cache native object files for ThinLTO incremental builds. If a path was 111 // specified, configure LTO to use it as the cache directory. 112 FileCache cache; 113 if (!config->thinLTOCacheDir.empty()) 114 cache = 115 check(localCache("ThinLTO", "Thin", config->thinLTOCacheDir, 116 [&](size_t task, std::unique_ptr<MemoryBuffer> mb) { 117 files[task] = std::move(mb); 118 })); 119 120 checkError(ltoObj->run( 121 [&](size_t task) { 122 return std::make_unique<CachedFileStream>( 123 std::make_unique<raw_svector_ostream>(buf[task])); 124 }, 125 cache)); 126 127 if (!config->thinLTOCacheDir.empty()) 128 pruneCache(config->thinLTOCacheDir, config->thinLTOCachePolicy); 129 130 if (config->saveTemps) { 131 if (!buf[0].empty()) 132 saveBuffer(buf[0], config->outputFile + ".lto.o"); 133 for (unsigned i = 1; i != maxTasks; ++i) 134 saveBuffer(buf[i], config->outputFile + Twine(i) + ".lto.o"); 135 } 136 137 if (!config->ltoObjPath.empty()) 138 fs::create_directories(config->ltoObjPath); 139 140 std::vector<ObjFile *> ret; 141 for (unsigned i = 0; i != maxTasks; ++i) { 142 if (buf[i].empty()) 143 continue; 144 SmallString<261> filePath("/tmp/lto.tmp"); 145 uint32_t modTime = 0; 146 if (!config->ltoObjPath.empty()) { 147 filePath = config->ltoObjPath; 148 path::append(filePath, Twine(i) + "." + 149 getArchitectureName(config->arch()) + 150 ".lto.o"); 151 saveBuffer(buf[i], filePath); 152 modTime = getModTime(filePath); 153 } 154 ret.push_back(make<ObjFile>( 155 MemoryBufferRef(buf[i], saver().save(filePath.str())), modTime, "")); 156 } 157 for (std::unique_ptr<MemoryBuffer> &file : files) 158 if (file) 159 ret.push_back(make<ObjFile>(*file, 0, "")); 160 return ret; 161 } 162