[PECOFF][Writer] Implement the writer that can emit text section.

lld can now output a valid Windows executable with a text section that does nothing
but just returns immediately. It's not able to handle relocations, symbol tables,
data sections, etc, so it still can't do anything practical, though.

Reviewers: Bigcheese

CC: llvm-commits

Differential Revision: http://llvm-reviews.chandlerc.com/D892

llvm-svn: 183478

lld/include/lld/ReaderWriter/PECOFFTargetInfo.h

@@ -38,7 +38,7 @@ public:
     _subsystem = subsystem;
   }
 
-  llvm::COFF::WindowsSubsystem getSubsystem() {
+  llvm::COFF::WindowsSubsystem getSubsystem() const {
     return _subsystem;
   }
 

lld/include/lld/ReaderWriter/Writer.h

@@ -19,6 +19,7 @@ class ELFTargetInfo;
 class File;
 class InputFiles;
 class MachOTargetInfo;
+class PECOFFTargetInfo;
 class TargetInfo;
 
 /// \brief The Writer is an abstract class for writing object files, shared
@@ -44,7 +45,7 @@ protected:
 std::unique_ptr<Writer> createWriterELF(const ELFTargetInfo &);
 std::unique_ptr<Writer> createWriterMachO(const MachOTargetInfo &);
 std::unique_ptr<Writer> createWriterNative(const TargetInfo &);
-std::unique_ptr<Writer> createWriterPECOFF(const TargetInfo &);
+std::unique_ptr<Writer> createWriterPECOFF(const PECOFFTargetInfo &);
 std::unique_ptr<Writer> createWriterYAML(const TargetInfo &);
 } // end namespace lld
 

lld/lib/ReaderWriter/PECOFF/WriterPECOFF.cpp

@@ -6,28 +6,384 @@
 // License. See LICENSE.TXT for details.
 //
 //===----------------------------------------------------------------------===//
+///
+/// \file
+///
+/// PE/COFF file consists of DOS Header, PE Header, COFF Header and Section
+/// Tables followed by raw section data.
+///
+/// This writer is reponsible for writing Core Linker results to an Windows
+/// executable file. Currently it can only output ".text" section; other
+/// sections including the symbol table are silently ignored.
+///
+/// This writer currently supports 32 bit PE/COFF only.
+///
+//===----------------------------------------------------------------------===//
 
+#define DEBUG_TYPE "WriterPECOFF"
+
+#include <time.h>
+#include <vector>
+
+#include "lld/Core/DefinedAtom.h"
+#include "lld/Core/File.h"
+#include "lld/Core/InputFiles.h"
+#include "lld/ReaderWriter/PECOFFTargetInfo.h"
 #include "lld/ReaderWriter/Writer.h"
 
+#include "llvm/ADT/ArrayRef.h"
+#include "llvm/Object/COFF.h"
+#include "llvm/Support/COFF.h"
+#include "llvm/Support/Debug.h"
 #include "llvm/Support/ErrorHandling.h"
 #include "llvm/Support/ErrorOr.h"
+#include "llvm/Support/FileOutputBuffer.h"
 
 namespace lld {
 namespace pecoff {
 
+namespace {
+
+/// A Chunk is an abstrace contiguous range in an output file.
+class Chunk {
+public:
+  Chunk() : _size(0), _align(1) {}
+  virtual ~Chunk() {};
+  virtual void write(uint8_t *fileBuffer) = 0;
+
+  virtual uint64_t fileOffset() const { return _fileOffset; }
+  virtual uint64_t size() const { return _size; }
+  virtual uint64_t align() const { return _align; }
+
+  virtual void setFileOffset(uint64_t fileOffset) {
+    _fileOffset = fileOffset;
+  }
+
+protected:
+  uint64_t _size;
+  uint64_t _fileOffset;
+  uint64_t _align;
+};
+
+/// A DOSStubChunk represents the DOS compatible header at the beginning
+/// of PE/COFF files.
+class DOSStubChunk : public Chunk {
+public:
+  DOSStubChunk() : Chunk() {
+    // Make the DOS stub occupy the first 128 bytes of an exe. Technically
+    // this can be as small as 64 bytes, but GNU binutil's objdump cannot
+    // parse such irregular header.
+    _size = 128;
+
+    // A DOS stub is usually a small valid DOS program that prints out a message
+    // "This program requires Microsoft Windows" to help user who accidentally
+    // run a Windows executable on DOS. That's not a technical requirement, so
+    // we don't bother to emit such code, at least for now. We simply fill the
+    // DOS stub with null bytes.
+    std::memset(&_dosHeader, 0, sizeof(_dosHeader));
+
+    _dosHeader.Magic = 'M' | ('Z' << 8);
+    _dosHeader.AddressOfNewExeHeader = _size;
+  }
+
+  virtual void write(uint8_t *fileBuffer) {
+    std::memcpy(fileBuffer, &_dosHeader, sizeof(_dosHeader));
+  }
+
+private:
+  llvm::object::dos_header _dosHeader;
+};
+
+/// A PEHeaderChunk represents PE header.
+class PEHeaderChunk : public Chunk {
+public:
+  PEHeaderChunk(const PECOFFTargetInfo &targetInfo) : Chunk() {
+    // Set the size of the chunk and initialize the header with null bytes.
+    _size = sizeof(_peHeader);
+    std::memset(&_peHeader, 0, sizeof(_peHeader));
+
+    // Set PE/COFF header fields
+    _peHeader.Signature = 'P' | ('E' << 8);
+    _peHeader.COFFHeader.Machine = llvm::COFF::IMAGE_FILE_MACHINE_I386;
+
+    _peHeader.COFFHeader.NumberOfSections = 1;  // [FIXME]
+    _peHeader.COFFHeader.TimeDateStamp = time(NULL);
+
+    // The size of PE header including optional data directory is always 224.
+    _peHeader.COFFHeader.SizeOfOptionalHeader = 224;
+    _peHeader.COFFHeader.Characteristics = llvm::COFF::IMAGE_FILE_32BIT_MACHINE
+        | llvm::COFF::IMAGE_FILE_EXECUTABLE_IMAGE;
+
+    // 0x10b indicates a normal executable. For PE32+ it should be 0x20b.
+    _peHeader.Magic = 0x10b;
+
+    // The address of entry point relative to ImageBase. Windows executable
+    // usually starts at address 0x401000.
+    _peHeader.AddressOfEntryPoint = 0x1000;
+    _peHeader.BaseOfCode = 0x1000;
+
+    // [FIXME] The address of data section relative to ImageBase.
+    _peHeader.BaseOfData = 0x2000;
+
+    // The address of the executable when loaded into memory. The default for
+    // DLLs is 0x10000000. The default for executables is 0x400000.
+    _peHeader.ImageBase = 0x400000;
+
+    // Sections should be page-aligned when loaded into memory, which is 4KB on
+    // x86.
+    _peHeader.SectionAlignment = 4096;
+
+    // Sections in an executable file on disk should be sector-aligned (512 byte).
+    _peHeader.FileAlignment = 512;
+
+    // [FIXME] Windows 5.1 is Windows XP.
+    _peHeader.MajorOperatingSystemVersion = 5;
+    _peHeader.MinorOperatingSystemVersion = 1;
+    _peHeader.MajorSubsystemVersion = 5;
+    _peHeader.MinorSubsystemVersion = 1;
+
+    // [FIXME] The size of the image when loaded into memory
+    _peHeader.SizeOfImage = 0x2000;
+
+    // The combined size of the DOS, PE and section headers including garbage
+    // between the end of the header and the beginning of the first section.
+    // Must be multiple of FileAlignment.
+    _peHeader.SizeOfHeaders = 512;
+    _peHeader.Subsystem = targetInfo.getSubsystem();
+    _peHeader.DLLCharacteristics =
+        llvm::COFF::IMAGE_DLL_CHARACTERISTICS_DYNAMIC_BASE
+        | llvm::COFF::IMAGE_DLL_CHARACTERISTICS_NX_COMPAT
+        | llvm::COFF::IMAGE_DLL_CHARACTERISTICS_TERMINAL_SERVER_AWARE;
+
+    _peHeader.SizeOfStackReserve = 0x100000;
+    _peHeader.SizeOfStackCommit = 0x1000;
+    _peHeader.SizeOfHeapReserve = 0x100000;
+    _peHeader.SizeOfHeapCommit = 0x1000;
+
+    // The number of data directory entries. We always have 16 entries.
+    _peHeader.NumberOfRvaAndSize = 16;
+  }
+
+  virtual void write(uint8_t *fileBuffer) {
+    std::memcpy(fileBuffer, &_peHeader, sizeof(_peHeader));
+  }
+
+  virtual void setSizeOfCode(uint64_t size) {
+    _peHeader.SizeOfCode = size;
+  }
+
+private:
+  llvm::object::pe32_header _peHeader;
+};
+
+/// A DataDirectoryChunk represents data directory entries that follows the PE
+/// header in the output file. An entry consists of an 8 byte field that
+/// indicates a relative virtual address (the starting address of the entry data
+/// in memory) and 8 byte entry data size.
+class DataDirectoryChunk : public Chunk {
+public:
+  DataDirectoryChunk() : Chunk() {
+    // [FIXME] Currently all entries are filled with zero.
+    _size = sizeof(_dirs);
+    std::memset(&_dirs, 0, sizeof(_dirs));
+  }
+
+  virtual void write(uint8_t *fileBuffer) {
+    std::memcpy(fileBuffer, &_dirs, sizeof(_dirs));
+  }
+
+private:
+  llvm::object::data_directory _dirs[16];
+};
+
+/// A SectionChunk represents a section in the output file. It consists of a
+/// section header and atoms which to be output as the content of the section.
+class SectionChunk : public Chunk {
+public:
+  SectionChunk(llvm::object::coff_section sectionHeader)
+      : _sectionHeader(sectionHeader) {}
+
+  void appendAtom(const DefinedAtom *atom) {
+    _atoms.push_back(atom);
+    _size += atom->rawContent().size();
+  }
+
+  virtual void write(uint8_t *fileBuffer) {
+    uint64_t offset = 0;
+    for (const auto &atom : _atoms) {
+      ArrayRef<uint8_t> rawContent = atom->rawContent();
+      std::memcpy(fileBuffer + offset, rawContent.data(), rawContent.size());
+      offset += rawContent.size();
+    }
+  }
+
+  const llvm::object::coff_section &getSectionHeader() {
+    return _sectionHeader;
+  }
+
+protected:
+  llvm::object::coff_section _sectionHeader;
+
+private:
+  std::vector<const DefinedAtom *> _atoms;
+};
+
+/// A SectionHeaderTableChunk is a list of section headers. The number of
+/// section headers is in the PE header. A section header has metadata about the
+/// section and a file offset to its content. Each section header is 40 byte and
+/// contiguous in the output file.
+class SectionHeaderTableChunk : public Chunk {
+public:
+  SectionHeaderTableChunk() : Chunk() {}
+
+  void addSection(SectionChunk *chunk) {
+    _sections.push_back(chunk);
+  }
+
+  virtual uint64_t size() const {
+    return _sections.size() * sizeof(llvm::object::coff_section);
+  }
+
+  virtual void write(uint8_t *fileBuffer) {
+    uint64_t offset = 0;
+    for (const auto &chunk : _sections) {
+      const llvm::object::coff_section &header = chunk->getSectionHeader();
+      std::memcpy(fileBuffer + offset, &header, sizeof(header));
+      offset += sizeof(header);
+    }
+  }
+
+private:
+  std::vector<SectionChunk*> _sections;
+};
+
+// \brief A TextSectionChunk represents a .text section.
+class TextSectionChunk : public SectionChunk {
+private:
+  llvm::object::coff_section createSectionHeader() {
+    llvm::object::coff_section header;
+    std::memcpy(&header.Name, ".text\0\0\0\0", 8);
+    header.VirtualSize = 0;
+    header.VirtualAddress = 0x1000;
+    header.SizeOfRawData = 0;
+    header.PointerToRawData = 0;
+    header.PointerToRelocations = 0;
+    header.PointerToLinenumbers = 0;
+    header.NumberOfRelocations = 0;
+    header.NumberOfLinenumbers = 0;
+    header.Characteristics = llvm::COFF::IMAGE_SCN_CNT_CODE
+        | llvm::COFF::IMAGE_SCN_MEM_EXECUTE
+        | llvm::COFF::IMAGE_SCN_MEM_READ;
+    return header;
+  }
+
+public:
+  TextSectionChunk(const File &linkedFile)
+      : SectionChunk(createSectionHeader()) {
+    // The text section should be aligned to disk sector.
+    _align = 512;
+
+    // Extract executable atoms from the linked file and append them to this
+    // section.
+    for (const DefinedAtom* atom : linkedFile.defined()) {
+      assert(atom->sectionChoice() == DefinedAtom::sectionBasedOnContent);
+      DefinedAtom::ContentType type = atom->contentType();
+      if (type != DefinedAtom::typeCode)
+        continue;
+      appendAtom(atom);
+    }
+
+    // Now that we have a list of atoms that to be written in this section, and
+    // we know the size of the section.
+    _sectionHeader.VirtualSize = _size;
+    _sectionHeader.SizeOfRawData = _size;
+  }
+
+  virtual uint64_t size() const {
+    // Round up to the nearest alignment border, so that the text segment ends
+    // at a border.
+    return (_size + _align - 1) & -_align;
+  }
+
+  // Set the file offset of the beginning of this section.
+  virtual void setFileOffset(uint64_t fileOffset) {
+    SectionChunk::setFileOffset(fileOffset);
+    _sectionHeader.PointerToRawData = fileOffset;
+  }
+};
+
+};  // end anonymous namespace
+
 class ExecutableWriter : public Writer {
- public:
-  ExecutableWriter(const TargetInfo &) {}
+private:
+  // Compute and set the offset of each chunk in the output file.
+  void computeChunkSize() {
+    uint64_t offset = 0;
+    for (auto &chunk : _chunks) {
+      // Round up to the nearest alignment boundary.
+      offset = (offset + chunk->align() - 1) & -chunk->align();
+      chunk->setFileOffset(offset);
+      offset += chunk->size();
+    }
+  }
+
+  void addChunk(Chunk *chunk) {
+    _chunks.push_back(std::unique_ptr<Chunk>(chunk));
+  }
+
+public:
+  ExecutableWriter(const PECOFFTargetInfo &targetInfo)
+      : _PECOFFTargetInfo(targetInfo) {}
+
+  // Create all chunks that consist of the output file.
+  void build(const File &linkedFile) {
+    // Create file chunks and add them to the list.
+    Chunk *dosStub(new DOSStubChunk());
+    PEHeaderChunk *peHeader(new PEHeaderChunk(_PECOFFTargetInfo));
+    Chunk *dataDirectoryHeader(new DataDirectoryChunk());
+    SectionHeaderTableChunk *sectionTable(new SectionHeaderTableChunk());
+    addChunk(dosStub);
+    addChunk(peHeader);
+    addChunk(dataDirectoryHeader);
+    addChunk(sectionTable);
+
+    // Create text section.
+    // [FIXME] Handle data and bss sections.
+    SectionChunk *text = new TextSectionChunk(linkedFile);
+    sectionTable->addSection(text);
+    addChunk(text);
+
+    // Compute and assign file offset to each chunk.
+    computeChunkSize();
+
+    // Now that we know the size and file offset of sections. Set the file
+    // header accordingly.
+    peHeader->setSizeOfCode(text->size());
+  }
 
   virtual error_code writeFile(const File &linkedFile, StringRef path) {
-    // TODO: implement this
-    return error_code::success();
+    this->build(linkedFile);
+
+    uint64_t totalSize = _chunks.back()->fileOffset() + _chunks.back()->size();
+    OwningPtr<llvm::FileOutputBuffer> buffer;
+    error_code ec = llvm::FileOutputBuffer::create(
+        path, totalSize, buffer, llvm::FileOutputBuffer::F_executable);
+    if (ec)
+      return ec;
+
+    for (const auto &chunk : _chunks)
+      chunk->write(buffer->getBufferStart() + chunk->fileOffset());
+    return buffer->commit();
   }
+
+private:
+  std::vector<std::unique_ptr<Chunk>> _chunks;
+  const PECOFFTargetInfo &_PECOFFTargetInfo;
 };
 
 } // end namespace pecoff
 
-std::unique_ptr<Writer> createWriterPECOFF(const TargetInfo &info) {
+std::unique_ptr<Writer> createWriterPECOFF(const PECOFFTargetInfo &info) {
   return std::unique_ptr<Writer>(new pecoff::ExecutableWriter(info));
 }
 

lld/test/pecoff/basic.test

@@ -1,5 +1,43 @@
-# RUN: lld -flavor link -mllvm -debug-only=ReaderCOFF -- %p/Inputs/nop.obj \
-# RUN:   2>&1 | FileCheck %s
+# RUN: lld -flavor link -out %t1 -- %p/Inputs/nop.obj \
+# RUN:   && llvm-readobj -file-headers %t1 | FileCheck -check-prefix=FILE %s
 
-CHECK: Defined atoms:
-CHECK:   _start
+FILE: Format: COFF-i386
+FILE: Arch: i386
+FILE: AddressSize: 32bit
+FILE: ImageFileHeader {
+FILE:   Machine: IMAGE_FILE_MACHINE_I386 (0x14C)
+FILE:   SectionCount: 1
+FILE:   TimeDateStamp:
+FILE:   PointerToSymbolTable: 0x0
+FILE:   SymbolCount: 0
+FILE:   OptionalHeaderSize: 224
+FILE:   Characteristics [ (0x102)
+FILE:     IMAGE_FILE_32BIT_MACHINE (0x100)
+FILE:     IMAGE_FILE_EXECUTABLE_IMAGE (0x2)
+FILE:   ]
+FILE: }
+
+# RUN: lld -flavor link -out %t1 -- %p/Inputs/nop.obj \
+# RUN:   && llvm-readobj -sections %t1 | FileCheck -check-prefix=SECTIONS %s
+SECTIONS: Format: COFF-i386
+SECTIONS: Arch: i386
+SECTIONS: AddressSize: 32bit
+SECTIONS: Sections [
+SECTIONS:   Section {
+SECTIONS:     Number: 1
+SECTIONS:     Name: .text (2E 74 65 78 74 00 00 00)
+SECTIONS:     VirtualSize: 0x6
+SECTIONS:     VirtualAddress: 0x1000
+SECTIONS:     RawDataSize: 6
+SECTIONS:     PointerToRawData: 0x200
+SECTIONS:     PointerToRelocations: 0x0
+SECTIONS:     PointerToLineNumbers: 0x0
+SECTIONS:     RelocationCount: 0
+SECTIONS:     LineNumberCount: 0
+SECTIONS:     Characteristics [ (0x60000020)
+SECTIONS:       IMAGE_SCN_CNT_CODE (0x20)
+SECTIONS:       IMAGE_SCN_MEM_EXECUTE (0x20000000)
+SECTIONS:       IMAGE_SCN_MEM_READ (0x40000000)
+SECTIONS:     ]
+SECTIONS:   }
+SECTIONS: ]