1 //===-- WindowsResource.cpp -------------------------------------*- C++ -*-===// 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 // This file implements the .res file class. 10 // 11 //===----------------------------------------------------------------------===// 12 13 #include "llvm/Object/WindowsResource.h" 14 #include "llvm/Object/COFF.h" 15 #include "llvm/Support/FileOutputBuffer.h" 16 #include "llvm/Support/FormatVariadic.h" 17 #include "llvm/Support/MathExtras.h" 18 #include "llvm/Support/ScopedPrinter.h" 19 #include <ctime> 20 #include <queue> 21 #include <system_error> 22 23 using namespace llvm; 24 using namespace object; 25 26 namespace llvm { 27 namespace object { 28 29 #define RETURN_IF_ERROR(X) \ 30 if (auto EC = X) \ 31 return EC; 32 33 const uint32_t MIN_HEADER_SIZE = 7 * sizeof(uint32_t) + 2 * sizeof(uint16_t); 34 35 // COFF files seem to be inconsistent with alignment between sections, just use 36 // 8-byte because it makes everyone happy. 37 const uint32_t SECTION_ALIGNMENT = sizeof(uint64_t); 38 39 uint32_t WindowsResourceParser::TreeNode::StringCount = 0; 40 uint32_t WindowsResourceParser::TreeNode::DataCount = 0; 41 42 WindowsResource::WindowsResource(MemoryBufferRef Source) 43 : Binary(Binary::ID_WinRes, Source) { 44 size_t LeadingSize = WIN_RES_MAGIC_SIZE + WIN_RES_NULL_ENTRY_SIZE; 45 BBS = BinaryByteStream(Data.getBuffer().drop_front(LeadingSize), 46 support::little); 47 } 48 49 // static 50 Expected<std::unique_ptr<WindowsResource>> 51 WindowsResource::createWindowsResource(MemoryBufferRef Source) { 52 if (Source.getBufferSize() < WIN_RES_MAGIC_SIZE + WIN_RES_NULL_ENTRY_SIZE) 53 return make_error<GenericBinaryError>( 54 Source.getBufferIdentifier() + ": too small to be a resource file", 55 object_error::invalid_file_type); 56 std::unique_ptr<WindowsResource> Ret(new WindowsResource(Source)); 57 return std::move(Ret); 58 } 59 60 Expected<ResourceEntryRef> WindowsResource::getHeadEntry() { 61 if (BBS.getLength() < sizeof(WinResHeaderPrefix) + sizeof(WinResHeaderSuffix)) 62 return make_error<EmptyResError>(getFileName() + " contains no entries", 63 object_error::unexpected_eof); 64 return ResourceEntryRef::create(BinaryStreamRef(BBS), this); 65 } 66 67 ResourceEntryRef::ResourceEntryRef(BinaryStreamRef Ref, 68 const WindowsResource *Owner) 69 : Reader(Ref), Owner(Owner) {} 70 71 Expected<ResourceEntryRef> 72 ResourceEntryRef::create(BinaryStreamRef BSR, const WindowsResource *Owner) { 73 auto Ref = ResourceEntryRef(BSR, Owner); 74 if (auto E = Ref.loadNext()) 75 return std::move(E); 76 return Ref; 77 } 78 79 Error ResourceEntryRef::moveNext(bool &End) { 80 // Reached end of all the entries. 81 if (Reader.bytesRemaining() == 0) { 82 End = true; 83 return Error::success(); 84 } 85 RETURN_IF_ERROR(loadNext()); 86 87 return Error::success(); 88 } 89 90 static Error readStringOrId(BinaryStreamReader &Reader, uint16_t &ID, 91 ArrayRef<UTF16> &Str, bool &IsString) { 92 uint16_t IDFlag; 93 RETURN_IF_ERROR(Reader.readInteger(IDFlag)); 94 IsString = IDFlag != 0xffff; 95 96 if (IsString) { 97 Reader.setOffset( 98 Reader.getOffset() - 99 sizeof(uint16_t)); // Re-read the bytes which we used to check the flag. 100 RETURN_IF_ERROR(Reader.readWideString(Str)); 101 } else 102 RETURN_IF_ERROR(Reader.readInteger(ID)); 103 104 return Error::success(); 105 } 106 107 Error ResourceEntryRef::loadNext() { 108 const WinResHeaderPrefix *Prefix; 109 RETURN_IF_ERROR(Reader.readObject(Prefix)); 110 111 if (Prefix->HeaderSize < MIN_HEADER_SIZE) 112 return make_error<GenericBinaryError>(Owner->getFileName() + 113 ": header size too small", 114 object_error::parse_failed); 115 116 RETURN_IF_ERROR(readStringOrId(Reader, TypeID, Type, IsStringType)); 117 118 RETURN_IF_ERROR(readStringOrId(Reader, NameID, Name, IsStringName)); 119 120 RETURN_IF_ERROR(Reader.padToAlignment(WIN_RES_HEADER_ALIGNMENT)); 121 122 RETURN_IF_ERROR(Reader.readObject(Suffix)); 123 124 RETURN_IF_ERROR(Reader.readArray(Data, Prefix->DataSize)); 125 126 RETURN_IF_ERROR(Reader.padToAlignment(WIN_RES_DATA_ALIGNMENT)); 127 128 return Error::success(); 129 } 130 131 WindowsResourceParser::WindowsResourceParser() : Root(false) {} 132 133 void printResourceTypeName(uint16_t TypeID, raw_ostream &OS) { 134 switch (TypeID) { 135 case 1: OS << "CURSOR (ID 1)"; break; 136 case 2: OS << "BITMAP (ID 2)"; break; 137 case 3: OS << "ICON (ID 3)"; break; 138 case 4: OS << "MENU (ID 4)"; break; 139 case 5: OS << "DIALOG (ID 5)"; break; 140 case 6: OS << "STRINGTABLE (ID 6)"; break; 141 case 7: OS << "FONTDIR (ID 7)"; break; 142 case 8: OS << "FONT (ID 8)"; break; 143 case 9: OS << "ACCELERATOR (ID 9)"; break; 144 case 10: OS << "RCDATA (ID 10)"; break; 145 case 11: OS << "MESSAGETABLE (ID 11)"; break; 146 case 12: OS << "GROUP_CURSOR (ID 12)"; break; 147 case 14: OS << "GROUP_ICON (ID 14)"; break; 148 case 16: OS << "VERSIONINFO (ID 16)"; break; 149 case 17: OS << "DLGINCLUDE (ID 17)"; break; 150 case 19: OS << "PLUGPLAY (ID 19)"; break; 151 case 20: OS << "VXD (ID 20)"; break; 152 case 21: OS << "ANICURSOR (ID 21)"; break; 153 case 22: OS << "ANIICON (ID 22)"; break; 154 case 23: OS << "HTML (ID 23)"; break; 155 case 24: OS << "MANIFEST (ID 24)"; break; 156 default: OS << "ID " << TypeID; break; 157 } 158 } 159 160 static bool convertUTF16LEToUTF8String(ArrayRef<UTF16> Src, std::string &Out) { 161 if (!sys::IsBigEndianHost) 162 return convertUTF16ToUTF8String(Src, Out); 163 164 std::vector<UTF16> EndianCorrectedSrc; 165 EndianCorrectedSrc.resize(Src.size() + 1); 166 llvm::copy(Src, EndianCorrectedSrc.begin() + 1); 167 EndianCorrectedSrc[0] = UNI_UTF16_BYTE_ORDER_MARK_SWAPPED; 168 return convertUTF16ToUTF8String(makeArrayRef(EndianCorrectedSrc), Out); 169 } 170 171 static Error makeDuplicateResourceError(const ResourceEntryRef &Entry, 172 StringRef File1, StringRef File2) { 173 std::string Ret; 174 raw_string_ostream OS(Ret); 175 176 OS << "duplicate resource:"; 177 178 OS << " type "; 179 if (Entry.checkTypeString()) { 180 std::string UTF8; 181 if (!convertUTF16LEToUTF8String(Entry.getTypeString(), UTF8)) 182 UTF8 = "(failed conversion from UTF16)"; 183 OS << '\"' << UTF8 << '\"'; 184 } else 185 printResourceTypeName(Entry.getTypeID(), OS); 186 187 OS << "/name "; 188 if (Entry.checkNameString()) { 189 std::string UTF8; 190 if (!convertUTF16LEToUTF8String(Entry.getNameString(), UTF8)) 191 UTF8 = "(failed conversion from UTF16)"; 192 OS << '\"' << UTF8 << '\"'; 193 } else { 194 OS << "ID " << Entry.getNameID(); 195 } 196 197 OS << "/language " << Entry.getLanguage() << ", in " << File1 << " and in " 198 << File2; 199 200 return make_error<GenericBinaryError>(OS.str(), object_error::parse_failed); 201 } 202 203 Error WindowsResourceParser::parse(WindowsResource *WR) { 204 auto EntryOrErr = WR->getHeadEntry(); 205 if (!EntryOrErr) { 206 auto E = EntryOrErr.takeError(); 207 if (E.isA<EmptyResError>()) { 208 // Check if the .res file contains no entries. In this case we don't have 209 // to throw an error but can rather just return without parsing anything. 210 // This applies for files which have a valid PE header magic and the 211 // mandatory empty null resource entry. Files which do not fit this 212 // criteria would have already been filtered out by 213 // WindowsResource::createWindowsResource(). 214 consumeError(std::move(E)); 215 return Error::success(); 216 } 217 return E; 218 } 219 220 ResourceEntryRef Entry = EntryOrErr.get(); 221 bool End = false; 222 while (!End) { 223 Data.push_back(Entry.getData()); 224 225 bool IsNewTypeString = false; 226 bool IsNewNameString = false; 227 228 TreeNode* Node; 229 bool IsNewNode = Root.addEntry(Entry, InputFilenames.size(), 230 IsNewTypeString, IsNewNameString, Node); 231 InputFilenames.push_back(WR->getFileName()); 232 if (!IsNewNode) 233 return makeDuplicateResourceError(Entry, InputFilenames[Node->Origin], 234 WR->getFileName()); 235 236 if (IsNewTypeString) 237 StringTable.push_back(Entry.getTypeString()); 238 239 if (IsNewNameString) 240 StringTable.push_back(Entry.getNameString()); 241 242 RETURN_IF_ERROR(Entry.moveNext(End)); 243 } 244 245 return Error::success(); 246 } 247 248 void WindowsResourceParser::printTree(raw_ostream &OS) const { 249 ScopedPrinter Writer(OS); 250 Root.print(Writer, "Resource Tree"); 251 } 252 253 bool WindowsResourceParser::TreeNode::addEntry(const ResourceEntryRef &Entry, 254 uint32_t Origin, 255 bool &IsNewTypeString, 256 bool &IsNewNameString, 257 TreeNode *&Result) { 258 TreeNode &TypeNode = addTypeNode(Entry, IsNewTypeString); 259 TreeNode &NameNode = TypeNode.addNameNode(Entry, IsNewNameString); 260 return NameNode.addLanguageNode(Entry, Origin, Result); 261 } 262 263 WindowsResourceParser::TreeNode::TreeNode(bool IsStringNode) { 264 if (IsStringNode) 265 StringIndex = StringCount++; 266 } 267 268 WindowsResourceParser::TreeNode::TreeNode(uint16_t MajorVersion, 269 uint16_t MinorVersion, 270 uint32_t Characteristics, 271 uint32_t Origin) 272 : IsDataNode(true), MajorVersion(MajorVersion), MinorVersion(MinorVersion), 273 Characteristics(Characteristics), Origin(Origin) { 274 DataIndex = DataCount++; 275 } 276 277 std::unique_ptr<WindowsResourceParser::TreeNode> 278 WindowsResourceParser::TreeNode::createStringNode() { 279 return std::unique_ptr<TreeNode>(new TreeNode(true)); 280 } 281 282 std::unique_ptr<WindowsResourceParser::TreeNode> 283 WindowsResourceParser::TreeNode::createIDNode() { 284 return std::unique_ptr<TreeNode>(new TreeNode(false)); 285 } 286 287 std::unique_ptr<WindowsResourceParser::TreeNode> 288 WindowsResourceParser::TreeNode::createDataNode(uint16_t MajorVersion, 289 uint16_t MinorVersion, 290 uint32_t Characteristics, 291 uint32_t Origin) { 292 return std::unique_ptr<TreeNode>( 293 new TreeNode(MajorVersion, MinorVersion, Characteristics, Origin)); 294 } 295 296 WindowsResourceParser::TreeNode & 297 WindowsResourceParser::TreeNode::addTypeNode(const ResourceEntryRef &Entry, 298 bool &IsNewTypeString) { 299 if (Entry.checkTypeString()) 300 return addNameChild(Entry.getTypeString(), IsNewTypeString); 301 else 302 return addIDChild(Entry.getTypeID()); 303 } 304 305 WindowsResourceParser::TreeNode & 306 WindowsResourceParser::TreeNode::addNameNode(const ResourceEntryRef &Entry, 307 bool &IsNewNameString) { 308 if (Entry.checkNameString()) 309 return addNameChild(Entry.getNameString(), IsNewNameString); 310 else 311 return addIDChild(Entry.getNameID()); 312 } 313 314 bool WindowsResourceParser::TreeNode::addLanguageNode( 315 const ResourceEntryRef &Entry, uint32_t Origin, TreeNode *&Result) { 316 return addDataChild(Entry.getLanguage(), Entry.getMajorVersion(), 317 Entry.getMinorVersion(), Entry.getCharacteristics(), 318 Origin, Result); 319 } 320 321 bool WindowsResourceParser::TreeNode::addDataChild( 322 uint32_t ID, uint16_t MajorVersion, uint16_t MinorVersion, 323 uint32_t Characteristics, uint32_t Origin, TreeNode *&Result) { 324 auto NewChild = 325 createDataNode(MajorVersion, MinorVersion, Characteristics, Origin); 326 auto ElementInserted = IDChildren.emplace(ID, std::move(NewChild)); 327 Result = ElementInserted.first->second.get(); 328 return ElementInserted.second; 329 } 330 331 WindowsResourceParser::TreeNode &WindowsResourceParser::TreeNode::addIDChild( 332 uint32_t ID) { 333 auto Child = IDChildren.find(ID); 334 if (Child == IDChildren.end()) { 335 auto NewChild = createIDNode(); 336 WindowsResourceParser::TreeNode &Node = *NewChild; 337 IDChildren.emplace(ID, std::move(NewChild)); 338 return Node; 339 } else 340 return *(Child->second); 341 } 342 343 WindowsResourceParser::TreeNode & 344 WindowsResourceParser::TreeNode::addNameChild(ArrayRef<UTF16> NameRef, 345 bool &IsNewString) { 346 std::string NameString; 347 convertUTF16LEToUTF8String(NameRef, NameString); 348 349 auto Child = StringChildren.find(NameString); 350 if (Child == StringChildren.end()) { 351 auto NewChild = createStringNode(); 352 IsNewString = true; 353 WindowsResourceParser::TreeNode &Node = *NewChild; 354 StringChildren.emplace(NameString, std::move(NewChild)); 355 return Node; 356 } else 357 return *(Child->second); 358 } 359 360 void WindowsResourceParser::TreeNode::print(ScopedPrinter &Writer, 361 StringRef Name) const { 362 ListScope NodeScope(Writer, Name); 363 for (auto const &Child : StringChildren) { 364 Child.second->print(Writer, Child.first); 365 } 366 for (auto const &Child : IDChildren) { 367 Child.second->print(Writer, to_string(Child.first)); 368 } 369 } 370 371 // This function returns the size of the entire resource tree, including 372 // directory tables, directory entries, and data entries. It does not include 373 // the directory strings or the relocations of the .rsrc section. 374 uint32_t WindowsResourceParser::TreeNode::getTreeSize() const { 375 uint32_t Size = (IDChildren.size() + StringChildren.size()) * 376 sizeof(coff_resource_dir_entry); 377 378 // Reached a node pointing to a data entry. 379 if (IsDataNode) { 380 Size += sizeof(coff_resource_data_entry); 381 return Size; 382 } 383 384 // If the node does not point to data, it must have a directory table pointing 385 // to other nodes. 386 Size += sizeof(coff_resource_dir_table); 387 388 for (auto const &Child : StringChildren) { 389 Size += Child.second->getTreeSize(); 390 } 391 for (auto const &Child : IDChildren) { 392 Size += Child.second->getTreeSize(); 393 } 394 return Size; 395 } 396 397 class WindowsResourceCOFFWriter { 398 public: 399 WindowsResourceCOFFWriter(COFF::MachineTypes MachineType, 400 const WindowsResourceParser &Parser, Error &E); 401 std::unique_ptr<MemoryBuffer> write(); 402 403 private: 404 void performFileLayout(); 405 void performSectionOneLayout(); 406 void performSectionTwoLayout(); 407 void writeCOFFHeader(); 408 void writeFirstSectionHeader(); 409 void writeSecondSectionHeader(); 410 void writeFirstSection(); 411 void writeSecondSection(); 412 void writeSymbolTable(); 413 void writeStringTable(); 414 void writeDirectoryTree(); 415 void writeDirectoryStringTable(); 416 void writeFirstSectionRelocations(); 417 std::unique_ptr<WritableMemoryBuffer> OutputBuffer; 418 char *BufferStart; 419 uint64_t CurrentOffset = 0; 420 COFF::MachineTypes MachineType; 421 const WindowsResourceParser::TreeNode &Resources; 422 const ArrayRef<std::vector<uint8_t>> Data; 423 uint64_t FileSize; 424 uint32_t SymbolTableOffset; 425 uint32_t SectionOneSize; 426 uint32_t SectionOneOffset; 427 uint32_t SectionOneRelocations; 428 uint32_t SectionTwoSize; 429 uint32_t SectionTwoOffset; 430 const ArrayRef<std::vector<UTF16>> StringTable; 431 std::vector<uint32_t> StringTableOffsets; 432 std::vector<uint32_t> DataOffsets; 433 std::vector<uint32_t> RelocationAddresses; 434 }; 435 436 WindowsResourceCOFFWriter::WindowsResourceCOFFWriter( 437 COFF::MachineTypes MachineType, const WindowsResourceParser &Parser, 438 Error &E) 439 : MachineType(MachineType), Resources(Parser.getTree()), 440 Data(Parser.getData()), StringTable(Parser.getStringTable()) { 441 performFileLayout(); 442 443 OutputBuffer = WritableMemoryBuffer::getNewMemBuffer(FileSize); 444 } 445 446 void WindowsResourceCOFFWriter::performFileLayout() { 447 // Add size of COFF header. 448 FileSize = COFF::Header16Size; 449 450 // one .rsrc section header for directory tree, another for resource data. 451 FileSize += 2 * COFF::SectionSize; 452 453 performSectionOneLayout(); 454 performSectionTwoLayout(); 455 456 // We have reached the address of the symbol table. 457 SymbolTableOffset = FileSize; 458 459 FileSize += COFF::Symbol16Size; // size of the @feat.00 symbol. 460 FileSize += 4 * COFF::Symbol16Size; // symbol + aux for each section. 461 FileSize += Data.size() * COFF::Symbol16Size; // 1 symbol per resource. 462 FileSize += 4; // four null bytes for the string table. 463 } 464 465 void WindowsResourceCOFFWriter::performSectionOneLayout() { 466 SectionOneOffset = FileSize; 467 468 SectionOneSize = Resources.getTreeSize(); 469 uint32_t CurrentStringOffset = SectionOneSize; 470 uint32_t TotalStringTableSize = 0; 471 for (auto const &String : StringTable) { 472 StringTableOffsets.push_back(CurrentStringOffset); 473 uint32_t StringSize = String.size() * sizeof(UTF16) + sizeof(uint16_t); 474 CurrentStringOffset += StringSize; 475 TotalStringTableSize += StringSize; 476 } 477 SectionOneSize += alignTo(TotalStringTableSize, sizeof(uint32_t)); 478 479 // account for the relocations of section one. 480 SectionOneRelocations = FileSize + SectionOneSize; 481 FileSize += SectionOneSize; 482 FileSize += 483 Data.size() * COFF::RelocationSize; // one relocation for each resource. 484 FileSize = alignTo(FileSize, SECTION_ALIGNMENT); 485 } 486 487 void WindowsResourceCOFFWriter::performSectionTwoLayout() { 488 // add size of .rsrc$2 section, which contains all resource data on 8-byte 489 // alignment. 490 SectionTwoOffset = FileSize; 491 SectionTwoSize = 0; 492 for (auto const &Entry : Data) { 493 DataOffsets.push_back(SectionTwoSize); 494 SectionTwoSize += alignTo(Entry.size(), sizeof(uint64_t)); 495 } 496 FileSize += SectionTwoSize; 497 FileSize = alignTo(FileSize, SECTION_ALIGNMENT); 498 } 499 500 static std::time_t getTime() { 501 std::time_t Now = time(nullptr); 502 if (Now < 0 || !isUInt<32>(Now)) 503 return UINT32_MAX; 504 return Now; 505 } 506 507 std::unique_ptr<MemoryBuffer> WindowsResourceCOFFWriter::write() { 508 BufferStart = OutputBuffer->getBufferStart(); 509 510 writeCOFFHeader(); 511 writeFirstSectionHeader(); 512 writeSecondSectionHeader(); 513 writeFirstSection(); 514 writeSecondSection(); 515 writeSymbolTable(); 516 writeStringTable(); 517 518 return std::move(OutputBuffer); 519 } 520 521 void WindowsResourceCOFFWriter::writeCOFFHeader() { 522 // Write the COFF header. 523 auto *Header = reinterpret_cast<coff_file_header *>(BufferStart); 524 Header->Machine = MachineType; 525 Header->NumberOfSections = 2; 526 Header->TimeDateStamp = getTime(); 527 Header->PointerToSymbolTable = SymbolTableOffset; 528 // One symbol for every resource plus 2 for each section and @feat.00 529 Header->NumberOfSymbols = Data.size() + 5; 530 Header->SizeOfOptionalHeader = 0; 531 Header->Characteristics = COFF::IMAGE_FILE_32BIT_MACHINE; 532 } 533 534 void WindowsResourceCOFFWriter::writeFirstSectionHeader() { 535 // Write the first section header. 536 CurrentOffset += sizeof(coff_file_header); 537 auto *SectionOneHeader = 538 reinterpret_cast<coff_section *>(BufferStart + CurrentOffset); 539 strncpy(SectionOneHeader->Name, ".rsrc$01", (size_t)COFF::NameSize); 540 SectionOneHeader->VirtualSize = 0; 541 SectionOneHeader->VirtualAddress = 0; 542 SectionOneHeader->SizeOfRawData = SectionOneSize; 543 SectionOneHeader->PointerToRawData = SectionOneOffset; 544 SectionOneHeader->PointerToRelocations = SectionOneRelocations; 545 SectionOneHeader->PointerToLinenumbers = 0; 546 SectionOneHeader->NumberOfRelocations = Data.size(); 547 SectionOneHeader->NumberOfLinenumbers = 0; 548 SectionOneHeader->Characteristics += COFF::IMAGE_SCN_CNT_INITIALIZED_DATA; 549 SectionOneHeader->Characteristics += COFF::IMAGE_SCN_MEM_READ; 550 } 551 552 void WindowsResourceCOFFWriter::writeSecondSectionHeader() { 553 // Write the second section header. 554 CurrentOffset += sizeof(coff_section); 555 auto *SectionTwoHeader = 556 reinterpret_cast<coff_section *>(BufferStart + CurrentOffset); 557 strncpy(SectionTwoHeader->Name, ".rsrc$02", (size_t)COFF::NameSize); 558 SectionTwoHeader->VirtualSize = 0; 559 SectionTwoHeader->VirtualAddress = 0; 560 SectionTwoHeader->SizeOfRawData = SectionTwoSize; 561 SectionTwoHeader->PointerToRawData = SectionTwoOffset; 562 SectionTwoHeader->PointerToRelocations = 0; 563 SectionTwoHeader->PointerToLinenumbers = 0; 564 SectionTwoHeader->NumberOfRelocations = 0; 565 SectionTwoHeader->NumberOfLinenumbers = 0; 566 SectionTwoHeader->Characteristics = COFF::IMAGE_SCN_CNT_INITIALIZED_DATA; 567 SectionTwoHeader->Characteristics += COFF::IMAGE_SCN_MEM_READ; 568 } 569 570 void WindowsResourceCOFFWriter::writeFirstSection() { 571 // Write section one. 572 CurrentOffset += sizeof(coff_section); 573 574 writeDirectoryTree(); 575 writeDirectoryStringTable(); 576 writeFirstSectionRelocations(); 577 578 CurrentOffset = alignTo(CurrentOffset, SECTION_ALIGNMENT); 579 } 580 581 void WindowsResourceCOFFWriter::writeSecondSection() { 582 // Now write the .rsrc$02 section. 583 for (auto const &RawDataEntry : Data) { 584 llvm::copy(RawDataEntry, BufferStart + CurrentOffset); 585 CurrentOffset += alignTo(RawDataEntry.size(), sizeof(uint64_t)); 586 } 587 588 CurrentOffset = alignTo(CurrentOffset, SECTION_ALIGNMENT); 589 } 590 591 void WindowsResourceCOFFWriter::writeSymbolTable() { 592 // Now write the symbol table. 593 // First, the feat symbol. 594 auto *Symbol = reinterpret_cast<coff_symbol16 *>(BufferStart + CurrentOffset); 595 strncpy(Symbol->Name.ShortName, "@feat.00", (size_t)COFF::NameSize); 596 Symbol->Value = 0x11; 597 Symbol->SectionNumber = 0xffff; 598 Symbol->Type = COFF::IMAGE_SYM_DTYPE_NULL; 599 Symbol->StorageClass = COFF::IMAGE_SYM_CLASS_STATIC; 600 Symbol->NumberOfAuxSymbols = 0; 601 CurrentOffset += sizeof(coff_symbol16); 602 603 // Now write the .rsrc1 symbol + aux. 604 Symbol = reinterpret_cast<coff_symbol16 *>(BufferStart + CurrentOffset); 605 strncpy(Symbol->Name.ShortName, ".rsrc$01", (size_t)COFF::NameSize); 606 Symbol->Value = 0; 607 Symbol->SectionNumber = 1; 608 Symbol->Type = COFF::IMAGE_SYM_DTYPE_NULL; 609 Symbol->StorageClass = COFF::IMAGE_SYM_CLASS_STATIC; 610 Symbol->NumberOfAuxSymbols = 1; 611 CurrentOffset += sizeof(coff_symbol16); 612 auto *Aux = reinterpret_cast<coff_aux_section_definition *>(BufferStart + 613 CurrentOffset); 614 Aux->Length = SectionOneSize; 615 Aux->NumberOfRelocations = Data.size(); 616 Aux->NumberOfLinenumbers = 0; 617 Aux->CheckSum = 0; 618 Aux->NumberLowPart = 0; 619 Aux->Selection = 0; 620 CurrentOffset += sizeof(coff_aux_section_definition); 621 622 // Now write the .rsrc2 symbol + aux. 623 Symbol = reinterpret_cast<coff_symbol16 *>(BufferStart + CurrentOffset); 624 strncpy(Symbol->Name.ShortName, ".rsrc$02", (size_t)COFF::NameSize); 625 Symbol->Value = 0; 626 Symbol->SectionNumber = 2; 627 Symbol->Type = COFF::IMAGE_SYM_DTYPE_NULL; 628 Symbol->StorageClass = COFF::IMAGE_SYM_CLASS_STATIC; 629 Symbol->NumberOfAuxSymbols = 1; 630 CurrentOffset += sizeof(coff_symbol16); 631 Aux = reinterpret_cast<coff_aux_section_definition *>(BufferStart + 632 CurrentOffset); 633 Aux->Length = SectionTwoSize; 634 Aux->NumberOfRelocations = 0; 635 Aux->NumberOfLinenumbers = 0; 636 Aux->CheckSum = 0; 637 Aux->NumberLowPart = 0; 638 Aux->Selection = 0; 639 CurrentOffset += sizeof(coff_aux_section_definition); 640 641 // Now write a symbol for each relocation. 642 for (unsigned i = 0; i < Data.size(); i++) { 643 auto RelocationName = formatv("$R{0:X-6}", i & 0xffffff).sstr<COFF::NameSize>(); 644 Symbol = reinterpret_cast<coff_symbol16 *>(BufferStart + CurrentOffset); 645 memcpy(Symbol->Name.ShortName, RelocationName.data(), (size_t) COFF::NameSize); 646 Symbol->Value = DataOffsets[i]; 647 Symbol->SectionNumber = 2; 648 Symbol->Type = COFF::IMAGE_SYM_DTYPE_NULL; 649 Symbol->StorageClass = COFF::IMAGE_SYM_CLASS_STATIC; 650 Symbol->NumberOfAuxSymbols = 0; 651 CurrentOffset += sizeof(coff_symbol16); 652 } 653 } 654 655 void WindowsResourceCOFFWriter::writeStringTable() { 656 // Just 4 null bytes for the string table. 657 auto COFFStringTable = reinterpret_cast<void *>(BufferStart + CurrentOffset); 658 memset(COFFStringTable, 0, 4); 659 } 660 661 void WindowsResourceCOFFWriter::writeDirectoryTree() { 662 // Traverse parsed resource tree breadth-first and write the corresponding 663 // COFF objects. 664 std::queue<const WindowsResourceParser::TreeNode *> Queue; 665 Queue.push(&Resources); 666 uint32_t NextLevelOffset = 667 sizeof(coff_resource_dir_table) + (Resources.getStringChildren().size() + 668 Resources.getIDChildren().size()) * 669 sizeof(coff_resource_dir_entry); 670 std::vector<const WindowsResourceParser::TreeNode *> DataEntriesTreeOrder; 671 uint32_t CurrentRelativeOffset = 0; 672 673 while (!Queue.empty()) { 674 auto CurrentNode = Queue.front(); 675 Queue.pop(); 676 auto *Table = reinterpret_cast<coff_resource_dir_table *>(BufferStart + 677 CurrentOffset); 678 Table->Characteristics = CurrentNode->getCharacteristics(); 679 Table->TimeDateStamp = 0; 680 Table->MajorVersion = CurrentNode->getMajorVersion(); 681 Table->MinorVersion = CurrentNode->getMinorVersion(); 682 auto &IDChildren = CurrentNode->getIDChildren(); 683 auto &StringChildren = CurrentNode->getStringChildren(); 684 Table->NumberOfNameEntries = StringChildren.size(); 685 Table->NumberOfIDEntries = IDChildren.size(); 686 CurrentOffset += sizeof(coff_resource_dir_table); 687 CurrentRelativeOffset += sizeof(coff_resource_dir_table); 688 689 // Write the directory entries immediately following each directory table. 690 for (auto const &Child : StringChildren) { 691 auto *Entry = reinterpret_cast<coff_resource_dir_entry *>(BufferStart + 692 CurrentOffset); 693 Entry->Identifier.setNameOffset( 694 StringTableOffsets[Child.second->getStringIndex()]); 695 if (Child.second->checkIsDataNode()) { 696 Entry->Offset.DataEntryOffset = NextLevelOffset; 697 NextLevelOffset += sizeof(coff_resource_data_entry); 698 DataEntriesTreeOrder.push_back(Child.second.get()); 699 } else { 700 Entry->Offset.SubdirOffset = NextLevelOffset + (1 << 31); 701 NextLevelOffset += sizeof(coff_resource_dir_table) + 702 (Child.second->getStringChildren().size() + 703 Child.second->getIDChildren().size()) * 704 sizeof(coff_resource_dir_entry); 705 Queue.push(Child.second.get()); 706 } 707 CurrentOffset += sizeof(coff_resource_dir_entry); 708 CurrentRelativeOffset += sizeof(coff_resource_dir_entry); 709 } 710 for (auto const &Child : IDChildren) { 711 auto *Entry = reinterpret_cast<coff_resource_dir_entry *>(BufferStart + 712 CurrentOffset); 713 Entry->Identifier.ID = Child.first; 714 if (Child.second->checkIsDataNode()) { 715 Entry->Offset.DataEntryOffset = NextLevelOffset; 716 NextLevelOffset += sizeof(coff_resource_data_entry); 717 DataEntriesTreeOrder.push_back(Child.second.get()); 718 } else { 719 Entry->Offset.SubdirOffset = NextLevelOffset + (1 << 31); 720 NextLevelOffset += sizeof(coff_resource_dir_table) + 721 (Child.second->getStringChildren().size() + 722 Child.second->getIDChildren().size()) * 723 sizeof(coff_resource_dir_entry); 724 Queue.push(Child.second.get()); 725 } 726 CurrentOffset += sizeof(coff_resource_dir_entry); 727 CurrentRelativeOffset += sizeof(coff_resource_dir_entry); 728 } 729 } 730 731 RelocationAddresses.resize(Data.size()); 732 // Now write all the resource data entries. 733 for (auto DataNodes : DataEntriesTreeOrder) { 734 auto *Entry = reinterpret_cast<coff_resource_data_entry *>(BufferStart + 735 CurrentOffset); 736 RelocationAddresses[DataNodes->getDataIndex()] = CurrentRelativeOffset; 737 Entry->DataRVA = 0; // Set to zero because it is a relocation. 738 Entry->DataSize = Data[DataNodes->getDataIndex()].size(); 739 Entry->Codepage = 0; 740 Entry->Reserved = 0; 741 CurrentOffset += sizeof(coff_resource_data_entry); 742 CurrentRelativeOffset += sizeof(coff_resource_data_entry); 743 } 744 } 745 746 void WindowsResourceCOFFWriter::writeDirectoryStringTable() { 747 // Now write the directory string table for .rsrc$01 748 uint32_t TotalStringTableSize = 0; 749 for (auto &String : StringTable) { 750 uint16_t Length = String.size(); 751 support::endian::write16le(BufferStart + CurrentOffset, Length); 752 CurrentOffset += sizeof(uint16_t); 753 auto *Start = reinterpret_cast<UTF16 *>(BufferStart + CurrentOffset); 754 llvm::copy(String, Start); 755 CurrentOffset += Length * sizeof(UTF16); 756 TotalStringTableSize += Length * sizeof(UTF16) + sizeof(uint16_t); 757 } 758 CurrentOffset += 759 alignTo(TotalStringTableSize, sizeof(uint32_t)) - TotalStringTableSize; 760 } 761 762 void WindowsResourceCOFFWriter::writeFirstSectionRelocations() { 763 764 // Now write the relocations for .rsrc$01 765 // Five symbols already in table before we start, @feat.00 and 2 for each 766 // .rsrc section. 767 uint32_t NextSymbolIndex = 5; 768 for (unsigned i = 0; i < Data.size(); i++) { 769 auto *Reloc = 770 reinterpret_cast<coff_relocation *>(BufferStart + CurrentOffset); 771 Reloc->VirtualAddress = RelocationAddresses[i]; 772 Reloc->SymbolTableIndex = NextSymbolIndex++; 773 switch (MachineType) { 774 case COFF::IMAGE_FILE_MACHINE_ARMNT: 775 Reloc->Type = COFF::IMAGE_REL_ARM_ADDR32NB; 776 break; 777 case COFF::IMAGE_FILE_MACHINE_AMD64: 778 Reloc->Type = COFF::IMAGE_REL_AMD64_ADDR32NB; 779 break; 780 case COFF::IMAGE_FILE_MACHINE_I386: 781 Reloc->Type = COFF::IMAGE_REL_I386_DIR32NB; 782 break; 783 case COFF::IMAGE_FILE_MACHINE_ARM64: 784 Reloc->Type = COFF::IMAGE_REL_ARM64_ADDR32NB; 785 break; 786 default: 787 llvm_unreachable("unknown machine type"); 788 } 789 CurrentOffset += sizeof(coff_relocation); 790 } 791 } 792 793 Expected<std::unique_ptr<MemoryBuffer>> 794 writeWindowsResourceCOFF(COFF::MachineTypes MachineType, 795 const WindowsResourceParser &Parser) { 796 Error E = Error::success(); 797 WindowsResourceCOFFWriter Writer(MachineType, Parser, E); 798 if (E) 799 return std::move(E); 800 return Writer.write(); 801 } 802 803 } // namespace object 804 } // namespace llvm 805