contrib/llvm/tools/lld/COFF/DLL.cpp

   1 //===- DLL.cpp ------------------------------------------------------------===//
   2 //
   3 //                             The LLVM Linker
   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 file defines various types of chunks for the DLL import or export
  11 // descriptor tables. They are inherently Windows-specific.
  12 // You need to read Microsoft PE/COFF spec to understand details
  13 // about the data structures.
  14 //
  15 // If you are not particularly interested in linking against Windows
  16 // DLL, you can skip this file, and you should still be able to
  17 // understand the rest of the linker.
  18 //
  19 //===----------------------------------------------------------------------===//
  20
  21 #include "Chunks.h"
  22 #include "DLL.h"
  23 #include "llvm/Object/COFF.h"
  24 #include "llvm/Support/Endian.h"
  25 #include "llvm/Support/Path.h"
  26
  27 using namespace llvm;
  28 using namespace llvm::object;
  29 using namespace llvm::support::endian;
  30 using namespace llvm::COFF;
  31
  32 namespace lld {
  33 namespace coff {
  34 namespace {
  35
  36 // Import table
  37
  38 static int ptrSize() { return Config->is64() ? 8 : 4; }
  39
  40 // A chunk for the import descriptor table.
  41 class HintNameChunk : public Chunk {
  42 public:
  43   HintNameChunk(StringRef N, uint16_t H) : Name(N), Hint(H) {}
  44
  45   size_t getSize() const override {
  46     // Starts with 2 byte Hint field, followed by a null-terminated string,
  47     // ends with 0 or 1 byte padding.
  48     return alignTo(Name.size() + 3, 2);
  49   }
  50
  51   void writeTo(uint8_t *Buf) const override {
  52     write16le(Buf + OutputSectionOff, Hint);
  53     memcpy(Buf + OutputSectionOff + 2, Name.data(), Name.size());
  54   }
  55
  56 private:
  57   StringRef Name;
  58   uint16_t Hint;
  59 };
  60
  61 // A chunk for the import descriptor table.
  62 class LookupChunk : public Chunk {
  63 public:
  64   explicit LookupChunk(Chunk *C) : HintName(C) {}
  65   size_t getSize() const override { return ptrSize(); }
  66
  67   void writeTo(uint8_t *Buf) const override {
  68     write32le(Buf + OutputSectionOff, HintName->getRVA());
  69   }
  70
  71   Chunk *HintName;
  72 };
  73
  74 // A chunk for the import descriptor table.
  75 // This chunk represent import-by-ordinal symbols.
  76 // See Microsoft PE/COFF spec 7.1. Import Header for details.
  77 class OrdinalOnlyChunk : public Chunk {
  78 public:
  79   explicit OrdinalOnlyChunk(uint16_t V) : Ordinal(V) {}
  80   size_t getSize() const override { return ptrSize(); }
  81
  82   void writeTo(uint8_t *Buf) const override {
  83     // An import-by-ordinal slot has MSB 1 to indicate that
  84     // this is import-by-ordinal (and not import-by-name).
  85     if (Config->is64()) {
  86       write64le(Buf + OutputSectionOff, (1ULL << 63) | Ordinal);
  87     } else {
  88       write32le(Buf + OutputSectionOff, (1ULL << 31) | Ordinal);
  89     }
  90   }
  91
  92   uint16_t Ordinal;
  93 };
  94
  95 // A chunk for the import descriptor table.
  96 class ImportDirectoryChunk : public Chunk {
  97 public:
  98   explicit ImportDirectoryChunk(Chunk *N) : DLLName(N) {}
  99   size_t getSize() const override { return sizeof(ImportDirectoryTableEntry); }
 100
 101   void writeTo(uint8_t *Buf) const override {
 102     auto *E = (coff_import_directory_table_entry *)(Buf + OutputSectionOff);
 103     E->ImportLookupTableRVA = LookupTab->getRVA();
 104     E->NameRVA = DLLName->getRVA();
 105     E->ImportAddressTableRVA = AddressTab->getRVA();
 106   }
 107
 108   Chunk *DLLName;
 109   Chunk *LookupTab;
 110   Chunk *AddressTab;
 111 };
 112
 113 // A chunk representing null terminator in the import table.
 114 // Contents of this chunk is always null bytes.
 115 class NullChunk : public Chunk {
 116 public:
 117   explicit NullChunk(size_t N) : Size(N) {}
 118   bool hasData() const override { return false; }
 119   size_t getSize() const override { return Size; }
 120   void setAlign(size_t N) { Align = N; }
 121
 122 private:
 123   size_t Size;
 124 };
 125
 126 static std::vector<std::vector<DefinedImportData *>>
 127 binImports(const std::vector<DefinedImportData *> &Imports) {
 128   // Group DLL-imported symbols by DLL name because that's how
 129   // symbols are layed out in the import descriptor table.
 130   auto Less = [](const std::string &A, const std::string &B) {
 131     return Config->DLLOrder[A] < Config->DLLOrder[B];
 132   };
 133   std::map<std::string, std::vector<DefinedImportData *>,
 134            bool(*)(const std::string &, const std::string &)> M(Less);
 135   for (DefinedImportData *Sym : Imports)
 136     M[Sym->getDLLName().lower()].push_back(Sym);
 137
 138   std::vector<std::vector<DefinedImportData *>> V;
 139   for (auto &KV : M) {
 140     // Sort symbols by name for each group.
 141     std::vector<DefinedImportData *> &Syms = KV.second;
 142     std::sort(Syms.begin(), Syms.end(),
 143               [](DefinedImportData *A, DefinedImportData *B) {
 144                 return A->getName() < B->getName();
 145               });
 146     V.push_back(std::move(Syms));
 147   }
 148   return V;
 149 }
 150
 151 // Export table
 152 // See Microsoft PE/COFF spec 4.3 for details.
 153
 154 // A chunk for the delay import descriptor table etnry.
 155 class DelayDirectoryChunk : public Chunk {
 156 public:
 157   explicit DelayDirectoryChunk(Chunk *N) : DLLName(N) {}
 158
 159   size_t getSize() const override {
 160     return sizeof(delay_import_directory_table_entry);
 161   }
 162
 163   void writeTo(uint8_t *Buf) const override {
 164     auto *E = (delay_import_directory_table_entry *)(Buf + OutputSectionOff);
 165     E->Attributes = 1;
 166     E->Name = DLLName->getRVA();
 167     E->ModuleHandle = ModuleHandle->getRVA();
 168     E->DelayImportAddressTable = AddressTab->getRVA();
 169     E->DelayImportNameTable = NameTab->getRVA();
 170   }
 171
 172   Chunk *DLLName;
 173   Chunk *ModuleHandle;
 174   Chunk *AddressTab;
 175   Chunk *NameTab;
 176 };
 177
 178 // Initial contents for delay-loaded functions.
 179 // This code calls __delayLoadHelper2 function to resolve a symbol
 180 // and then overwrites its jump table slot with the result
 181 // for subsequent function calls.
 182 static const uint8_t ThunkX64[] = {
 183     0x51,                               // push    rcx
 184     0x52,                               // push    rdx
 185     0x41, 0x50,                         // push    r8
 186     0x41, 0x51,                         // push    r9
 187     0x48, 0x83, 0xEC, 0x48,             // sub     rsp, 48h
 188     0x66, 0x0F, 0x7F, 0x04, 0x24,       // movdqa  xmmword ptr [rsp], xmm0
 189     0x66, 0x0F, 0x7F, 0x4C, 0x24, 0x10, // movdqa  xmmword ptr [rsp+10h], xmm1
 190     0x66, 0x0F, 0x7F, 0x54, 0x24, 0x20, // movdqa  xmmword ptr [rsp+20h], xmm2
 191     0x66, 0x0F, 0x7F, 0x5C, 0x24, 0x30, // movdqa  xmmword ptr [rsp+30h], xmm3
 192     0x48, 0x8D, 0x15, 0, 0, 0, 0,       // lea     rdx, [__imp_<FUNCNAME>]
 193     0x48, 0x8D, 0x0D, 0, 0, 0, 0,       // lea     rcx, [___DELAY_IMPORT_...]
 194     0xE8, 0, 0, 0, 0,                   // call    __delayLoadHelper2
 195     0x66, 0x0F, 0x6F, 0x04, 0x24,       // movdqa  xmm0, xmmword ptr [rsp]
 196     0x66, 0x0F, 0x6F, 0x4C, 0x24, 0x10, // movdqa  xmm1, xmmword ptr [rsp+10h]
 197     0x66, 0x0F, 0x6F, 0x54, 0x24, 0x20, // movdqa  xmm2, xmmword ptr [rsp+20h]
 198     0x66, 0x0F, 0x6F, 0x5C, 0x24, 0x30, // movdqa  xmm3, xmmword ptr [rsp+30h]
 199     0x48, 0x83, 0xC4, 0x48,             // add     rsp, 48h
 200     0x41, 0x59,                         // pop     r9
 201     0x41, 0x58,                         // pop     r8
 202     0x5A,                               // pop     rdx
 203     0x59,                               // pop     rcx
 204     0xFF, 0xE0,                         // jmp     rax
 205 };
 206
 207 static const uint8_t ThunkX86[] = {
 208     0x51,              // push  ecx
 209     0x52,              // push  edx
 210     0x68, 0, 0, 0, 0,  // push  offset ___imp__<FUNCNAME>
 211     0x68, 0, 0, 0, 0,  // push  offset ___DELAY_IMPORT_DESCRIPTOR_<DLLNAME>_dll
 212     0xE8, 0, 0, 0, 0,  // call  ___delayLoadHelper2@8
 213     0x5A,              // pop   edx
 214     0x59,              // pop   ecx
 215     0xFF, 0xE0,        // jmp   eax
 216 };
 217
 218 // A chunk for the delay import thunk.
 219 class ThunkChunkX64 : public Chunk {
 220 public:
 221   ThunkChunkX64(Defined *I, Chunk *D, Defined *H)
 222       : Imp(I), Desc(D), Helper(H) {}
 223
 224   size_t getSize() const override { return sizeof(ThunkX64); }
 225
 226   void writeTo(uint8_t *Buf) const override {
 227     memcpy(Buf + OutputSectionOff, ThunkX64, sizeof(ThunkX64));
 228     write32le(Buf + OutputSectionOff + 36, Imp->getRVA() - RVA - 40);
 229     write32le(Buf + OutputSectionOff + 43, Desc->getRVA() - RVA - 47);
 230     write32le(Buf + OutputSectionOff + 48, Helper->getRVA() - RVA - 52);
 231   }
 232
 233   Defined *Imp = nullptr;
 234   Chunk *Desc = nullptr;
 235   Defined *Helper = nullptr;
 236 };
 237
 238 class ThunkChunkX86 : public Chunk {
 239 public:
 240   ThunkChunkX86(Defined *I, Chunk *D, Defined *H)
 241       : Imp(I), Desc(D), Helper(H) {}
 242
 243   size_t getSize() const override { return sizeof(ThunkX86); }
 244
 245   void writeTo(uint8_t *Buf) const override {
 246     memcpy(Buf + OutputSectionOff, ThunkX86, sizeof(ThunkX86));
 247     write32le(Buf + OutputSectionOff + 3, Imp->getRVA() + Config->ImageBase);
 248     write32le(Buf + OutputSectionOff + 8, Desc->getRVA() + Config->ImageBase);
 249     write32le(Buf + OutputSectionOff + 13, Helper->getRVA() - RVA - 17);
 250   }
 251
 252   void getBaserels(std::vector<Baserel> *Res) override {
 253     Res->emplace_back(RVA + 3);
 254     Res->emplace_back(RVA + 8);
 255   }
 256
 257   Defined *Imp = nullptr;
 258   Chunk *Desc = nullptr;
 259   Defined *Helper = nullptr;
 260 };
 261
 262 // A chunk for the import descriptor table.
 263 class DelayAddressChunk : public Chunk {
 264 public:
 265   explicit DelayAddressChunk(Chunk *C) : Thunk(C) {}
 266   size_t getSize() const override { return ptrSize(); }
 267
 268   void writeTo(uint8_t *Buf) const override {
 269     if (Config->is64()) {
 270       write64le(Buf + OutputSectionOff, Thunk->getRVA() + Config->ImageBase);
 271     } else {
 272       write32le(Buf + OutputSectionOff, Thunk->getRVA() + Config->ImageBase);
 273     }
 274   }
 275
 276   void getBaserels(std::vector<Baserel> *Res) override {
 277     Res->emplace_back(RVA);
 278   }
 279
 280   Chunk *Thunk;
 281 };
 282
 283 // Export table
 284 // Read Microsoft PE/COFF spec 5.3 for details.
 285
 286 // A chunk for the export descriptor table.
 287 class ExportDirectoryChunk : public Chunk {
 288 public:
 289   ExportDirectoryChunk(int I, int J, Chunk *D, Chunk *A, Chunk *N, Chunk *O)
 290       : MaxOrdinal(I), NameTabSize(J), DLLName(D), AddressTab(A), NameTab(N),
 291         OrdinalTab(O) {}
 292
 293   size_t getSize() const override {
 294     return sizeof(export_directory_table_entry);
 295   }
 296
 297   void writeTo(uint8_t *Buf) const override {
 298     auto *E = (export_directory_table_entry *)(Buf + OutputSectionOff);
 299     E->NameRVA = DLLName->getRVA();
 300     E->OrdinalBase = 0;
 301     E->AddressTableEntries = MaxOrdinal + 1;
 302     E->NumberOfNamePointers = NameTabSize;
 303     E->ExportAddressTableRVA = AddressTab->getRVA();
 304     E->NamePointerRVA = NameTab->getRVA();
 305     E->OrdinalTableRVA = OrdinalTab->getRVA();
 306   }
 307
 308   uint16_t MaxOrdinal;
 309   uint16_t NameTabSize;
 310   Chunk *DLLName;
 311   Chunk *AddressTab;
 312   Chunk *NameTab;
 313   Chunk *OrdinalTab;
 314 };
 315
 316 class AddressTableChunk : public Chunk {
 317 public:
 318   explicit AddressTableChunk(size_t MaxOrdinal) : Size(MaxOrdinal + 1) {}
 319   size_t getSize() const override { return Size * 4; }
 320
 321   void writeTo(uint8_t *Buf) const override {
 322     for (Export &E : Config->Exports) {
 323       uint8_t *P = Buf + OutputSectionOff + E.Ordinal * 4;
 324       if (E.ForwardChunk) {
 325         write32le(P, E.ForwardChunk->getRVA());
 326       } else {
 327         write32le(P, cast<Defined>(E.Sym)->getRVA());
 328       }
 329     }
 330   }
 331
 332 private:
 333   size_t Size;
 334 };
 335
 336 class NamePointersChunk : public Chunk {
 337 public:
 338   explicit NamePointersChunk(std::vector<Chunk *> &V) : Chunks(V) {}
 339   size_t getSize() const override { return Chunks.size() * 4; }
 340
 341   void writeTo(uint8_t *Buf) const override {
 342     uint8_t *P = Buf + OutputSectionOff;
 343     for (Chunk *C : Chunks) {
 344       write32le(P, C->getRVA());
 345       P += 4;
 346     }
 347   }
 348
 349 private:
 350   std::vector<Chunk *> Chunks;
 351 };
 352
 353 class ExportOrdinalChunk : public Chunk {
 354 public:
 355   explicit ExportOrdinalChunk(size_t I) : Size(I) {}
 356   size_t getSize() const override { return Size * 2; }
 357
 358   void writeTo(uint8_t *Buf) const override {
 359     uint8_t *P = Buf + OutputSectionOff;
 360     for (Export &E : Config->Exports) {
 361       if (E.Noname)
 362         continue;
 363       write16le(P, E.Ordinal);
 364       P += 2;
 365     }
 366   }
 367
 368 private:
 369   size_t Size;
 370 };
 371
 372 } // anonymous namespace
 373
 374 uint64_t IdataContents::getDirSize() {
 375   return Dirs.size() * sizeof(ImportDirectoryTableEntry);
 376 }
 377
 378 uint64_t IdataContents::getIATSize() {
 379   return Addresses.size() * ptrSize();
 380 }
 381
 382 // Returns a list of .idata contents.
 383 // See Microsoft PE/COFF spec 5.4 for details.
 384 std::vector<Chunk *> IdataContents::getChunks() {
 385   create();
 386
 387   // The loader assumes a specific order of data.
 388   // Add each type in the correct order.
 389   std::vector<Chunk *> V;
 390   V.insert(V.end(), Dirs.begin(), Dirs.end());
 391   V.insert(V.end(), Lookups.begin(), Lookups.end());
 392   V.insert(V.end(), Addresses.begin(), Addresses.end());
 393   V.insert(V.end(), Hints.begin(), Hints.end());
 394   V.insert(V.end(), DLLNames.begin(), DLLNames.end());
 395   return V;
 396 }
 397
 398 void IdataContents::create() {
 399   std::vector<std::vector<DefinedImportData *>> V = binImports(Imports);
 400
 401   // Create .idata contents for each DLL.
 402   for (std::vector<DefinedImportData *> &Syms : V) {
 403     // Create lookup and address tables. If they have external names,
 404     // we need to create HintName chunks to store the names.
 405     // If they don't (if they are import-by-ordinals), we store only
 406     // ordinal values to the table.
 407     size_t Base = Lookups.size();
 408     for (DefinedImportData *S : Syms) {
 409       uint16_t Ord = S->getOrdinal();
 410       if (S->getExternalName().empty()) {
 411         Lookups.push_back(make<OrdinalOnlyChunk>(Ord));
 412         Addresses.push_back(make<OrdinalOnlyChunk>(Ord));
 413         continue;
 414       }
 415       auto *C = make<HintNameChunk>(S->getExternalName(), Ord);
 416       Lookups.push_back(make<LookupChunk>(C));
 417       Addresses.push_back(make<LookupChunk>(C));
 418       Hints.push_back(C);
 419     }
 420     // Terminate with null values.
 421     Lookups.push_back(make<NullChunk>(ptrSize()));
 422     Addresses.push_back(make<NullChunk>(ptrSize()));
 423
 424     for (int I = 0, E = Syms.size(); I < E; ++I)
 425       Syms[I]->setLocation(Addresses[Base + I]);
 426
 427     // Create the import table header.
 428     DLLNames.push_back(make<StringChunk>(Syms[0]->getDLLName()));
 429     auto *Dir = make<ImportDirectoryChunk>(DLLNames.back());
 430     Dir->LookupTab = Lookups[Base];
 431     Dir->AddressTab = Addresses[Base];
 432     Dirs.push_back(Dir);
 433   }
 434   // Add null terminator.
 435   Dirs.push_back(make<NullChunk>(sizeof(ImportDirectoryTableEntry)));
 436 }
 437
 438 std::vector<Chunk *> DelayLoadContents::getChunks() {
 439   std::vector<Chunk *> V;
 440   V.insert(V.end(), Dirs.begin(), Dirs.end());
 441   V.insert(V.end(), Names.begin(), Names.end());
 442   V.insert(V.end(), HintNames.begin(), HintNames.end());
 443   V.insert(V.end(), DLLNames.begin(), DLLNames.end());
 444   return V;
 445 }
 446
 447 std::vector<Chunk *> DelayLoadContents::getDataChunks() {
 448   std::vector<Chunk *> V;
 449   V.insert(V.end(), ModuleHandles.begin(), ModuleHandles.end());
 450   V.insert(V.end(), Addresses.begin(), Addresses.end());
 451   return V;
 452 }
 453
 454 uint64_t DelayLoadContents::getDirSize() {
 455   return Dirs.size() * sizeof(delay_import_directory_table_entry);
 456 }
 457
 458 void DelayLoadContents::create(Defined *H) {
 459   Helper = H;
 460   std::vector<std::vector<DefinedImportData *>> V = binImports(Imports);
 461
 462   // Create .didat contents for each DLL.
 463   for (std::vector<DefinedImportData *> &Syms : V) {
 464     // Create the delay import table header.
 465     DLLNames.push_back(make<StringChunk>(Syms[0]->getDLLName()));
 466     auto *Dir = make<DelayDirectoryChunk>(DLLNames.back());
 467
 468     size_t Base = Addresses.size();
 469     for (DefinedImportData *S : Syms) {
 470       Chunk *T = newThunkChunk(S, Dir);
 471       auto *A = make<DelayAddressChunk>(T);
 472       Addresses.push_back(A);
 473       Thunks.push_back(T);
 474       StringRef ExtName = S->getExternalName();
 475       if (ExtName.empty()) {
 476         Names.push_back(make<OrdinalOnlyChunk>(S->getOrdinal()));
 477       } else {
 478         auto *C = make<HintNameChunk>(ExtName, 0);
 479         Names.push_back(make<LookupChunk>(C));
 480         HintNames.push_back(C);
 481       }
 482     }
 483     // Terminate with null values.
 484     Addresses.push_back(make<NullChunk>(8));
 485     Names.push_back(make<NullChunk>(8));
 486
 487     for (int I = 0, E = Syms.size(); I < E; ++I)
 488       Syms[I]->setLocation(Addresses[Base + I]);
 489     auto *MH = make<NullChunk>(8);
 490     MH->setAlign(8);
 491     ModuleHandles.push_back(MH);
 492
 493     // Fill the delay import table header fields.
 494     Dir->ModuleHandle = MH;
 495     Dir->AddressTab = Addresses[Base];
 496     Dir->NameTab = Names[Base];
 497     Dirs.push_back(Dir);
 498   }
 499   // Add null terminator.
 500   Dirs.push_back(make<NullChunk>(sizeof(delay_import_directory_table_entry)));
 501 }
 502
 503 Chunk *DelayLoadContents::newThunkChunk(DefinedImportData *S, Chunk *Dir) {
 504   switch (Config->Machine) {
 505   case AMD64:
 506     return make<ThunkChunkX64>(S, Dir, Helper);
 507   case I386:
 508     return make<ThunkChunkX86>(S, Dir, Helper);
 509   default:
 510     llvm_unreachable("unsupported machine type");
 511   }
 512 }
 513
 514 EdataContents::EdataContents() {
 515   uint16_t MaxOrdinal = 0;
 516   for (Export &E : Config->Exports)
 517     MaxOrdinal = std::max(MaxOrdinal, E.Ordinal);
 518
 519   auto *DLLName = make<StringChunk>(sys::path::filename(Config->OutputFile));
 520   auto *AddressTab = make<AddressTableChunk>(MaxOrdinal);
 521   std::vector<Chunk *> Names;
 522   for (Export &E : Config->Exports)
 523     if (!E.Noname)
 524       Names.push_back(make<StringChunk>(E.ExportName));
 525
 526   std::vector<Chunk *> Forwards;
 527   for (Export &E : Config->Exports) {
 528     if (E.ForwardTo.empty())
 529       continue;
 530     E.ForwardChunk = make<StringChunk>(E.ForwardTo);
 531     Forwards.push_back(E.ForwardChunk);
 532   }
 533
 534   auto *NameTab = make<NamePointersChunk>(Names);
 535   auto *OrdinalTab = make<ExportOrdinalChunk>(Names.size());
 536   auto *Dir = make<ExportDirectoryChunk>(MaxOrdinal, Names.size(), DLLName,
 537                                          AddressTab, NameTab, OrdinalTab);
 538   Chunks.push_back(Dir);
 539   Chunks.push_back(DLLName);
 540   Chunks.push_back(AddressTab);
 541   Chunks.push_back(NameTab);
 542   Chunks.push_back(OrdinalTab);
 543   Chunks.insert(Chunks.end(), Names.begin(), Names.end());
 544   Chunks.insert(Chunks.end(), Forwards.begin(), Forwards.end());
 545 }
 546
 547 } // namespace coff
 548 } // namespace lld