//===- DLL.cpp ------------------------------------------------------------===// // // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. // See https://llvm.org/LICENSE.txt for license information. // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception // //===----------------------------------------------------------------------===// // // This file defines various types of chunks for the DLL import or export // descriptor tables. They are inherently Windows-specific. // You need to read Microsoft PE/COFF spec to understand details // about the data structures. // // If you are not particularly interested in linking against Windows // DLL, you can skip this file, and you should still be able to // understand the rest of the linker. // //===----------------------------------------------------------------------===// #include "DLL.h" #include "Chunks.h" #include "llvm/Object/COFF.h" #include "llvm/Support/Endian.h" #include "llvm/Support/Path.h" using namespace llvm; using namespace llvm::object; using namespace llvm::support::endian; using namespace llvm::COFF; namespace lld { namespace coff { namespace { // Import table // A chunk for the import descriptor table. class HintNameChunk : public NonSectionChunk { public: HintNameChunk(StringRef n, uint16_t h) : name(n), hint(h) {} size_t getSize() const override { // Starts with 2 byte Hint field, followed by a null-terminated string, // ends with 0 or 1 byte padding. return alignTo(name.size() + 3, 2); } void writeTo(uint8_t *buf) const override { memset(buf, 0, getSize()); write16le(buf, hint); memcpy(buf + 2, name.data(), name.size()); } private: StringRef name; uint16_t hint; }; // A chunk for the import descriptor table. class LookupChunk : public NonSectionChunk { public: explicit LookupChunk(Chunk *c) : hintName(c) { setAlignment(config->wordsize); } size_t getSize() const override { return config->wordsize; } void writeTo(uint8_t *buf) const override { if (config->is64()) write64le(buf, hintName->getRVA()); else write32le(buf, hintName->getRVA()); } Chunk *hintName; }; // A chunk for the import descriptor table. // This chunk represent import-by-ordinal symbols. // See Microsoft PE/COFF spec 7.1. Import Header for details. class OrdinalOnlyChunk : public NonSectionChunk { public: explicit OrdinalOnlyChunk(uint16_t v) : ordinal(v) { setAlignment(config->wordsize); } size_t getSize() const override { return config->wordsize; } void writeTo(uint8_t *buf) const override { // An import-by-ordinal slot has MSB 1 to indicate that // this is import-by-ordinal (and not import-by-name). if (config->is64()) { write64le(buf, (1ULL << 63) | ordinal); } else { write32le(buf, (1ULL << 31) | ordinal); } } uint16_t ordinal; }; // A chunk for the import descriptor table. class ImportDirectoryChunk : public NonSectionChunk { public: explicit ImportDirectoryChunk(Chunk *n) : dllName(n) {} size_t getSize() const override { return sizeof(ImportDirectoryTableEntry); } void writeTo(uint8_t *buf) const override { memset(buf, 0, getSize()); auto *e = (coff_import_directory_table_entry *)(buf); e->ImportLookupTableRVA = lookupTab->getRVA(); e->NameRVA = dllName->getRVA(); e->ImportAddressTableRVA = addressTab->getRVA(); } Chunk *dllName; Chunk *lookupTab; Chunk *addressTab; }; // A chunk representing null terminator in the import table. // Contents of this chunk is always null bytes. class NullChunk : public NonSectionChunk { public: explicit NullChunk(size_t n) : size(n) { hasData = false; } size_t getSize() const override { return size; } void writeTo(uint8_t *buf) const override { memset(buf, 0, size); } private: size_t size; }; static std::vector> binImports(const std::vector &imports) { // Group DLL-imported symbols by DLL name because that's how // symbols are layed out in the import descriptor table. auto less = [](const std::string &a, const std::string &b) { return config->dllOrder[a] < config->dllOrder[b]; }; std::map, bool(*)(const std::string &, const std::string &)> m(less); for (DefinedImportData *sym : imports) m[sym->getDLLName().lower()].push_back(sym); std::vector> v; for (auto &kv : m) { // Sort symbols by name for each group. std::vector &syms = kv.second; std::sort(syms.begin(), syms.end(), [](DefinedImportData *a, DefinedImportData *b) { return a->getName() < b->getName(); }); v.push_back(std::move(syms)); } return v; } // Export table // See Microsoft PE/COFF spec 4.3 for details. // A chunk for the delay import descriptor table etnry. class DelayDirectoryChunk : public NonSectionChunk { public: explicit DelayDirectoryChunk(Chunk *n) : dllName(n) {} size_t getSize() const override { return sizeof(delay_import_directory_table_entry); } void writeTo(uint8_t *buf) const override { memset(buf, 0, getSize()); auto *e = (delay_import_directory_table_entry *)(buf); e->Attributes = 1; e->Name = dllName->getRVA(); e->ModuleHandle = moduleHandle->getRVA(); e->DelayImportAddressTable = addressTab->getRVA(); e->DelayImportNameTable = nameTab->getRVA(); } Chunk *dllName; Chunk *moduleHandle; Chunk *addressTab; Chunk *nameTab; }; // Initial contents for delay-loaded functions. // This code calls __delayLoadHelper2 function to resolve a symbol // and then overwrites its jump table slot with the result // for subsequent function calls. static const uint8_t thunkX64[] = { 0x48, 0x8D, 0x05, 0, 0, 0, 0, // lea rax, [__imp_] 0xE9, 0, 0, 0, 0, // jmp __tailMerge_ }; static const uint8_t tailMergeX64[] = { 0x51, // push rcx 0x52, // push rdx 0x41, 0x50, // push r8 0x41, 0x51, // push r9 0x48, 0x83, 0xEC, 0x48, // sub rsp, 48h 0x66, 0x0F, 0x7F, 0x04, 0x24, // movdqa xmmword ptr [rsp], xmm0 0x66, 0x0F, 0x7F, 0x4C, 0x24, 0x10, // movdqa xmmword ptr [rsp+10h], xmm1 0x66, 0x0F, 0x7F, 0x54, 0x24, 0x20, // movdqa xmmword ptr [rsp+20h], xmm2 0x66, 0x0F, 0x7F, 0x5C, 0x24, 0x30, // movdqa xmmword ptr [rsp+30h], xmm3 0x48, 0x8B, 0xD0, // mov rdx, rax 0x48, 0x8D, 0x0D, 0, 0, 0, 0, // lea rcx, [___DELAY_IMPORT_...] 0xE8, 0, 0, 0, 0, // call __delayLoadHelper2 0x66, 0x0F, 0x6F, 0x04, 0x24, // movdqa xmm0, xmmword ptr [rsp] 0x66, 0x0F, 0x6F, 0x4C, 0x24, 0x10, // movdqa xmm1, xmmword ptr [rsp+10h] 0x66, 0x0F, 0x6F, 0x54, 0x24, 0x20, // movdqa xmm2, xmmword ptr [rsp+20h] 0x66, 0x0F, 0x6F, 0x5C, 0x24, 0x30, // movdqa xmm3, xmmword ptr [rsp+30h] 0x48, 0x83, 0xC4, 0x48, // add rsp, 48h 0x41, 0x59, // pop r9 0x41, 0x58, // pop r8 0x5A, // pop rdx 0x59, // pop rcx 0xFF, 0xE0, // jmp rax }; static const uint8_t thunkX86[] = { 0xB8, 0, 0, 0, 0, // mov eax, offset ___imp__ 0xE9, 0, 0, 0, 0, // jmp __tailMerge_ }; static const uint8_t tailMergeX86[] = { 0x51, // push ecx 0x52, // push edx 0x50, // push eax 0x68, 0, 0, 0, 0, // push offset ___DELAY_IMPORT_DESCRIPTOR__dll 0xE8, 0, 0, 0, 0, // call ___delayLoadHelper2@8 0x5A, // pop edx 0x59, // pop ecx 0xFF, 0xE0, // jmp eax }; static const uint8_t thunkARM[] = { 0x40, 0xf2, 0x00, 0x0c, // mov.w ip, #0 __imp_ 0xc0, 0xf2, 0x00, 0x0c, // mov.t ip, #0 __imp_ 0x00, 0xf0, 0x00, 0xb8, // b.w __tailMerge_ }; static const uint8_t tailMergeARM[] = { 0x2d, 0xe9, 0x0f, 0x48, // push.w {r0, r1, r2, r3, r11, lr} 0x0d, 0xf2, 0x10, 0x0b, // addw r11, sp, #16 0x2d, 0xed, 0x10, 0x0b, // vpush {d0, d1, d2, d3, d4, d5, d6, d7} 0x61, 0x46, // mov r1, ip 0x40, 0xf2, 0x00, 0x00, // mov.w r0, #0 DELAY_IMPORT_DESCRIPTOR 0xc0, 0xf2, 0x00, 0x00, // mov.t r0, #0 DELAY_IMPORT_DESCRIPTOR 0x00, 0xf0, 0x00, 0xd0, // bl #0 __delayLoadHelper2 0x84, 0x46, // mov ip, r0 0xbd, 0xec, 0x10, 0x0b, // vpop {d0, d1, d2, d3, d4, d5, d6, d7} 0xbd, 0xe8, 0x0f, 0x48, // pop.w {r0, r1, r2, r3, r11, lr} 0x60, 0x47, // bx ip }; static const uint8_t thunkARM64[] = { 0x11, 0x00, 0x00, 0x90, // adrp x17, #0 __imp_ 0x31, 0x02, 0x00, 0x91, // add x17, x17, #0 :lo12:__imp_ 0x00, 0x00, 0x00, 0x14, // b __tailMerge_ }; static const uint8_t tailMergeARM64[] = { 0xfd, 0x7b, 0xb3, 0xa9, // stp x29, x30, [sp, #-208]! 0xfd, 0x03, 0x00, 0x91, // mov x29, sp 0xe0, 0x07, 0x01, 0xa9, // stp x0, x1, [sp, #16] 0xe2, 0x0f, 0x02, 0xa9, // stp x2, x3, [sp, #32] 0xe4, 0x17, 0x03, 0xa9, // stp x4, x5, [sp, #48] 0xe6, 0x1f, 0x04, 0xa9, // stp x6, x7, [sp, #64] 0xe0, 0x87, 0x02, 0xad, // stp q0, q1, [sp, #80] 0xe2, 0x8f, 0x03, 0xad, // stp q2, q3, [sp, #112] 0xe4, 0x97, 0x04, 0xad, // stp q4, q5, [sp, #144] 0xe6, 0x9f, 0x05, 0xad, // stp q6, q7, [sp, #176] 0xe1, 0x03, 0x11, 0xaa, // mov x1, x17 0x00, 0x00, 0x00, 0x90, // adrp x0, #0 DELAY_IMPORT_DESCRIPTOR 0x00, 0x00, 0x00, 0x91, // add x0, x0, #0 :lo12:DELAY_IMPORT_DESCRIPTOR 0x00, 0x00, 0x00, 0x94, // bl #0 __delayLoadHelper2 0xf0, 0x03, 0x00, 0xaa, // mov x16, x0 0xe6, 0x9f, 0x45, 0xad, // ldp q6, q7, [sp, #176] 0xe4, 0x97, 0x44, 0xad, // ldp q4, q5, [sp, #144] 0xe2, 0x8f, 0x43, 0xad, // ldp q2, q3, [sp, #112] 0xe0, 0x87, 0x42, 0xad, // ldp q0, q1, [sp, #80] 0xe6, 0x1f, 0x44, 0xa9, // ldp x6, x7, [sp, #64] 0xe4, 0x17, 0x43, 0xa9, // ldp x4, x5, [sp, #48] 0xe2, 0x0f, 0x42, 0xa9, // ldp x2, x3, [sp, #32] 0xe0, 0x07, 0x41, 0xa9, // ldp x0, x1, [sp, #16] 0xfd, 0x7b, 0xcd, 0xa8, // ldp x29, x30, [sp], #208 0x00, 0x02, 0x1f, 0xd6, // br x16 }; // A chunk for the delay import thunk. class ThunkChunkX64 : public NonSectionChunk { public: ThunkChunkX64(Defined *i, Chunk *tm) : imp(i), tailMerge(tm) {} size_t getSize() const override { return sizeof(thunkX64); } void writeTo(uint8_t *buf) const override { memcpy(buf, thunkX64, sizeof(thunkX64)); write32le(buf + 3, imp->getRVA() - rva - 7); write32le(buf + 8, tailMerge->getRVA() - rva - 12); } Defined *imp = nullptr; Chunk *tailMerge = nullptr; }; class TailMergeChunkX64 : public NonSectionChunk { public: TailMergeChunkX64(Chunk *d, Defined *h) : desc(d), helper(h) {} size_t getSize() const override { return sizeof(tailMergeX64); } void writeTo(uint8_t *buf) const override { memcpy(buf, tailMergeX64, sizeof(tailMergeX64)); write32le(buf + 39, desc->getRVA() - rva - 43); write32le(buf + 44, helper->getRVA() - rva - 48); } Chunk *desc = nullptr; Defined *helper = nullptr; }; class ThunkChunkX86 : public NonSectionChunk { public: ThunkChunkX86(Defined *i, Chunk *tm) : imp(i), tailMerge(tm) {} size_t getSize() const override { return sizeof(thunkX86); } void writeTo(uint8_t *buf) const override { memcpy(buf, thunkX86, sizeof(thunkX86)); write32le(buf + 1, imp->getRVA() + config->imageBase); write32le(buf + 6, tailMerge->getRVA() - rva - 10); } void getBaserels(std::vector *res) override { res->emplace_back(rva + 1); } Defined *imp = nullptr; Chunk *tailMerge = nullptr; }; class TailMergeChunkX86 : public NonSectionChunk { public: TailMergeChunkX86(Chunk *d, Defined *h) : desc(d), helper(h) {} size_t getSize() const override { return sizeof(tailMergeX86); } void writeTo(uint8_t *buf) const override { memcpy(buf, tailMergeX86, sizeof(tailMergeX86)); write32le(buf + 4, desc->getRVA() + config->imageBase); write32le(buf + 9, helper->getRVA() - rva - 13); } void getBaserels(std::vector *res) override { res->emplace_back(rva + 4); } Chunk *desc = nullptr; Defined *helper = nullptr; }; class ThunkChunkARM : public NonSectionChunk { public: ThunkChunkARM(Defined *i, Chunk *tm) : imp(i), tailMerge(tm) {} size_t getSize() const override { return sizeof(thunkARM); } void writeTo(uint8_t *buf) const override { memcpy(buf, thunkARM, sizeof(thunkARM)); applyMOV32T(buf + 0, imp->getRVA() + config->imageBase); applyBranch24T(buf + 8, tailMerge->getRVA() - rva - 12); } void getBaserels(std::vector *res) override { res->emplace_back(rva + 0, IMAGE_REL_BASED_ARM_MOV32T); } Defined *imp = nullptr; Chunk *tailMerge = nullptr; }; class TailMergeChunkARM : public NonSectionChunk { public: TailMergeChunkARM(Chunk *d, Defined *h) : desc(d), helper(h) {} size_t getSize() const override { return sizeof(tailMergeARM); } void writeTo(uint8_t *buf) const override { memcpy(buf, tailMergeARM, sizeof(tailMergeARM)); applyMOV32T(buf + 14, desc->getRVA() + config->imageBase); applyBranch24T(buf + 22, helper->getRVA() - rva - 26); } void getBaserels(std::vector *res) override { res->emplace_back(rva + 14, IMAGE_REL_BASED_ARM_MOV32T); } Chunk *desc = nullptr; Defined *helper = nullptr; }; class ThunkChunkARM64 : public NonSectionChunk { public: ThunkChunkARM64(Defined *i, Chunk *tm) : imp(i), tailMerge(tm) {} size_t getSize() const override { return sizeof(thunkARM64); } void writeTo(uint8_t *buf) const override { memcpy(buf, thunkARM64, sizeof(thunkARM64)); applyArm64Addr(buf + 0, imp->getRVA(), rva + 0, 12); applyArm64Imm(buf + 4, imp->getRVA() & 0xfff, 0); applyArm64Branch26(buf + 8, tailMerge->getRVA() - rva - 8); } Defined *imp = nullptr; Chunk *tailMerge = nullptr; }; class TailMergeChunkARM64 : public NonSectionChunk { public: TailMergeChunkARM64(Chunk *d, Defined *h) : desc(d), helper(h) {} size_t getSize() const override { return sizeof(tailMergeARM64); } void writeTo(uint8_t *buf) const override { memcpy(buf, tailMergeARM64, sizeof(tailMergeARM64)); applyArm64Addr(buf + 44, desc->getRVA(), rva + 44, 12); applyArm64Imm(buf + 48, desc->getRVA() & 0xfff, 0); applyArm64Branch26(buf + 52, helper->getRVA() - rva - 52); } Chunk *desc = nullptr; Defined *helper = nullptr; }; // A chunk for the import descriptor table. class DelayAddressChunk : public NonSectionChunk { public: explicit DelayAddressChunk(Chunk *c) : thunk(c) { setAlignment(config->wordsize); } size_t getSize() const override { return config->wordsize; } void writeTo(uint8_t *buf) const override { if (config->is64()) { write64le(buf, thunk->getRVA() + config->imageBase); } else { uint32_t bit = 0; // Pointer to thumb code must have the LSB set, so adjust it. if (config->machine == ARMNT) bit = 1; write32le(buf, (thunk->getRVA() + config->imageBase) | bit); } } void getBaserels(std::vector *res) override { res->emplace_back(rva); } Chunk *thunk; }; // Export table // Read Microsoft PE/COFF spec 5.3 for details. // A chunk for the export descriptor table. class ExportDirectoryChunk : public NonSectionChunk { public: ExportDirectoryChunk(int i, int j, Chunk *d, Chunk *a, Chunk *n, Chunk *o) : maxOrdinal(i), nameTabSize(j), dllName(d), addressTab(a), nameTab(n), ordinalTab(o) {} size_t getSize() const override { return sizeof(export_directory_table_entry); } void writeTo(uint8_t *buf) const override { memset(buf, 0, getSize()); auto *e = (export_directory_table_entry *)(buf); e->NameRVA = dllName->getRVA(); e->OrdinalBase = 0; e->AddressTableEntries = maxOrdinal + 1; e->NumberOfNamePointers = nameTabSize; e->ExportAddressTableRVA = addressTab->getRVA(); e->NamePointerRVA = nameTab->getRVA(); e->OrdinalTableRVA = ordinalTab->getRVA(); } uint16_t maxOrdinal; uint16_t nameTabSize; Chunk *dllName; Chunk *addressTab; Chunk *nameTab; Chunk *ordinalTab; }; class AddressTableChunk : public NonSectionChunk { public: explicit AddressTableChunk(size_t maxOrdinal) : size(maxOrdinal + 1) {} size_t getSize() const override { return size * 4; } void writeTo(uint8_t *buf) const override { memset(buf, 0, getSize()); for (const Export &e : config->exports) { uint8_t *p = buf + e.ordinal * 4; uint32_t bit = 0; // Pointer to thumb code must have the LSB set, so adjust it. if (config->machine == ARMNT && !e.data) bit = 1; if (e.forwardChunk) { write32le(p, e.forwardChunk->getRVA() | bit); } else { write32le(p, cast(e.sym)->getRVA() | bit); } } } private: size_t size; }; class NamePointersChunk : public NonSectionChunk { public: explicit NamePointersChunk(std::vector &v) : chunks(v) {} size_t getSize() const override { return chunks.size() * 4; } void writeTo(uint8_t *buf) const override { for (Chunk *c : chunks) { write32le(buf, c->getRVA()); buf += 4; } } private: std::vector chunks; }; class ExportOrdinalChunk : public NonSectionChunk { public: explicit ExportOrdinalChunk(size_t i) : size(i) {} size_t getSize() const override { return size * 2; } void writeTo(uint8_t *buf) const override { for (Export &e : config->exports) { if (e.noname) continue; write16le(buf, e.ordinal); buf += 2; } } private: size_t size; }; } // anonymous namespace void IdataContents::create() { std::vector> v = binImports(imports); // Create .idata contents for each DLL. for (std::vector &syms : v) { // Create lookup and address tables. If they have external names, // we need to create hintName chunks to store the names. // If they don't (if they are import-by-ordinals), we store only // ordinal values to the table. size_t base = lookups.size(); for (DefinedImportData *s : syms) { uint16_t ord = s->getOrdinal(); if (s->getExternalName().empty()) { lookups.push_back(make(ord)); addresses.push_back(make(ord)); continue; } auto *c = make(s->getExternalName(), ord); lookups.push_back(make(c)); addresses.push_back(make(c)); hints.push_back(c); } // Terminate with null values. lookups.push_back(make(config->wordsize)); addresses.push_back(make(config->wordsize)); for (int i = 0, e = syms.size(); i < e; ++i) syms[i]->setLocation(addresses[base + i]); // Create the import table header. dllNames.push_back(make(syms[0]->getDLLName())); auto *dir = make(dllNames.back()); dir->lookupTab = lookups[base]; dir->addressTab = addresses[base]; dirs.push_back(dir); } // Add null terminator. dirs.push_back(make(sizeof(ImportDirectoryTableEntry))); } std::vector DelayLoadContents::getChunks() { std::vector v; v.insert(v.end(), dirs.begin(), dirs.end()); v.insert(v.end(), names.begin(), names.end()); v.insert(v.end(), hintNames.begin(), hintNames.end()); v.insert(v.end(), dllNames.begin(), dllNames.end()); return v; } std::vector DelayLoadContents::getDataChunks() { std::vector v; v.insert(v.end(), moduleHandles.begin(), moduleHandles.end()); v.insert(v.end(), addresses.begin(), addresses.end()); return v; } uint64_t DelayLoadContents::getDirSize() { return dirs.size() * sizeof(delay_import_directory_table_entry); } void DelayLoadContents::create(Defined *h) { helper = h; std::vector> v = binImports(imports); // Create .didat contents for each DLL. for (std::vector &syms : v) { // Create the delay import table header. dllNames.push_back(make(syms[0]->getDLLName())); auto *dir = make(dllNames.back()); size_t base = addresses.size(); Chunk *tm = newTailMergeChunk(dir); for (DefinedImportData *s : syms) { Chunk *t = newThunkChunk(s, tm); auto *a = make(t); addresses.push_back(a); thunks.push_back(t); StringRef extName = s->getExternalName(); if (extName.empty()) { names.push_back(make(s->getOrdinal())); } else { auto *c = make(extName, 0); names.push_back(make(c)); hintNames.push_back(c); } } thunks.push_back(tm); // Terminate with null values. addresses.push_back(make(8)); names.push_back(make(8)); for (int i = 0, e = syms.size(); i < e; ++i) syms[i]->setLocation(addresses[base + i]); auto *mh = make(8); mh->setAlignment(8); moduleHandles.push_back(mh); // Fill the delay import table header fields. dir->moduleHandle = mh; dir->addressTab = addresses[base]; dir->nameTab = names[base]; dirs.push_back(dir); } // Add null terminator. dirs.push_back(make(sizeof(delay_import_directory_table_entry))); } Chunk *DelayLoadContents::newTailMergeChunk(Chunk *dir) { switch (config->machine) { case AMD64: return make(dir, helper); case I386: return make(dir, helper); case ARMNT: return make(dir, helper); case ARM64: return make(dir, helper); default: llvm_unreachable("unsupported machine type"); } } Chunk *DelayLoadContents::newThunkChunk(DefinedImportData *s, Chunk *tailMerge) { switch (config->machine) { case AMD64: return make(s, tailMerge); case I386: return make(s, tailMerge); case ARMNT: return make(s, tailMerge); case ARM64: return make(s, tailMerge); default: llvm_unreachable("unsupported machine type"); } } EdataContents::EdataContents() { uint16_t maxOrdinal = 0; for (Export &e : config->exports) maxOrdinal = std::max(maxOrdinal, e.ordinal); auto *dllName = make(sys::path::filename(config->outputFile)); auto *addressTab = make(maxOrdinal); std::vector names; for (Export &e : config->exports) if (!e.noname) names.push_back(make(e.exportName)); std::vector forwards; for (Export &e : config->exports) { if (e.forwardTo.empty()) continue; e.forwardChunk = make(e.forwardTo); forwards.push_back(e.forwardChunk); } auto *nameTab = make(names); auto *ordinalTab = make(names.size()); auto *dir = make(maxOrdinal, names.size(), dllName, addressTab, nameTab, ordinalTab); chunks.push_back(dir); chunks.push_back(dllName); chunks.push_back(addressTab); chunks.push_back(nameTab); chunks.push_back(ordinalTab); chunks.insert(chunks.end(), names.begin(), names.end()); chunks.insert(chunks.end(), forwards.begin(), forwards.end()); } } // namespace coff } // namespace lld