Add section header stream to PDB.

[ruiu]

Summary

This patch demonstrates how to use addStream function.

[ruiu]

• updated for the new patch.

[ruiu]

• Update for the latest patch.

COFF/Driver.cpp

 //===- Driver.cpp ---------------------------------------------------------===//
 //
 //                             The LLVM Linker
 //
 // This file is distributed under the University of Illinois Open Source
 // License. See LICENSE.TXT for details.
 //
 //===----------------------------------------------------------------------===//
 
 #include "Driver.h"
 #include "Config.h"
 #include "Error.h"
 #include "InputFiles.h"
-#include "PDB.h"
 #include "SymbolTable.h"
 #include "Symbols.h"
 #include "Writer.h"
 #include "lld/Driver/Driver.h"
 #include "llvm/ADT/Optional.h"
 #include "llvm/ADT/StringSwitch.h"
 #include "llvm/LibDriver/LibDriver.h"
 #include "llvm/Option/Arg.h"
if (Args.hasArg(OPT_debug)) {
     Config->Debug = true;
     Config->DebugTypes =
         Args.hasArg(OPT_debugtype)
             ? parseDebugType(Args.getLastArg(OPT_debugtype)->getValue())
             : getDefaultDebugType(Args);
   }
 
   // Create a dummy PDB file to satisfy build sytem rules.
-  if (auto *Arg = Args.getLastArg(OPT_pdb)) {
+  if (auto *Arg = Args.getLastArg(OPT_pdb))
     Config->PDBPath = Arg->getValue();
-    createPDB(Config->PDBPath);
-  }
 
   // Handle /noentry
   if (Args.hasArg(OPT_noentry)) {
     if (!Args.hasArg(OPT_dll))
       fatal("/noentry must be specified with /dll");
     Config->NoEntry = true;
   }
 

COFF/PDB.h

 //===- PDB.h ----------------------------------------------------*- C++ -*-===//
 //
 //                             The LLVM Linker
 //
 // This file is distributed under the University of Illinois Open Source
 // License. See LICENSE.TXT for details.
 //
 //===----------------------------------------------------------------------===//
 
 #ifndef LLD_COFF_PDB_H
 #define LLD_COFF_PDB_H
 
+#include "llvm/ADT/ArrayRef.h"
 #include "llvm/ADT/StringRef.h"
 
 namespace lld {
 namespace coff {
-void createPDB(llvm::StringRef Path);
+void createPDB(llvm::StringRef Path, llvm::ArrayRef<uint8_t> SectionTable);
 }
 }
 
 #endif

COFF/PDB.cpp

 
 using namespace lld;
 using namespace llvm;
 using namespace llvm::support;
 using namespace llvm::support::endian;
 
 static ExitOnError ExitOnErr;
 
-void coff::createPDB(StringRef Path) {
+void coff::createPDB(StringRef Path, ArrayRef<uint8_t> SectionTable) {
   BumpPtrAllocator Alloc;
   pdb::PDBFileBuilder Builder(Alloc);
   ExitOnErr(Builder.initialize(4096)); // 4096 is blocksize
 
   // Create streams in MSF for predefined streams, namely
   // PDB, TPI, DBI and IPI.
   for (int I = 0; I < (int)pdb::kSpecialStreamCount; ++I)
     ExitOnErr(Builder.getMsfBuilder().addStream(0));
void coff::createPDB(StringRef Path, ArrayRef<uint8_t> SectionTable) {
   // Add an empty TPI stream.
   auto &TpiBuilder = Builder.getTpiBuilder();
   TpiBuilder.setVersionHeader(pdb::PdbTpiV80);
 
   // Add an empty IPI stream.
   auto &IpiBuilder = Builder.getIpiBuilder();
   IpiBuilder.setVersionHeader(pdb::PdbTpiV80);
 
+  uint32_t SectionHeaderStreamIdx = ExitOnErr(Builder.addStream(SectionTable));
+  DbiBuilder.setDebugStreamIndex(pdb::DbgHeaderType::SectionHdr,
+                                 SectionHeaderStreamIdx);
+
   // Write to a file.
   ExitOnErr(Builder.commit(Path));
 }

COFF/Writer.cpp

 //===- Writer.cpp ---------------------------------------------------------===//
 //
 //                             The LLVM Linker
 //
 // This file is distributed under the University of Illinois Open Source
 // License. See LICENSE.TXT for details.
 //
 //===----------------------------------------------------------------------===//
 
 #include "Config.h"
 #include "DLL.h"
 #include "Error.h"
 #include "InputFiles.h"
+#include "PDB.h"
 #include "SymbolTable.h"
 #include "Symbols.h"
 #include "Writer.h"
 #include "lld/Core/Parallel.h"
 #include "llvm/ADT/DenseMap.h"
 #include "llvm/ADT/STLExtras.h"
 #include "llvm/ADT/StringSwitch.h"
 #include "llvm/Support/Debug.h"
private:
   IdataContents Idata;
   DelayLoadContents DelayIdata;
   EdataContents Edata;
   std::unique_ptr<SEHTableChunk> SEHTable;
 
   std::unique_ptr<Chunk> DebugDirectory;
   std::vector<std::unique_ptr<Chunk>> DebugRecords;
   CVDebugRecordChunk *BuildId = nullptr;
+  ArrayRef<uint8_t> SectionTable;
 
   uint64_t FileSize;
   uint32_t PointerToSymbolTable = 0;
   uint64_t SizeOfImage;
   uint64_t SizeOfHeaders;
 
   std::vector<std::unique_ptr<Chunk>> Chunks;
 };
if (Config->is64()) {
     writeHeader<pe32plus_header>();
   } else {
     writeHeader<pe32_header>();
   }
   fixSafeSEHSymbols();
   writeSections();
   sortExceptionTable();
   writeBuildId();
+
+  if (!Config->PDBPath.empty())
+    createPDB(Config->PDBPath, SectionTable);
+
   if (auto EC = Buffer->commit())
     fatal(EC, "failed to write the output file");
 }
 
 static StringRef getOutputSection(StringRef Name) {
   StringRef S = Name.split('$').first;
   auto It = Config->Merge.find(S);
   if (It == Config->Merge.end())
if (!DelayIdata.empty()) {
     Dir[DELAY_IMPORT_DESCRIPTOR].Size = DelayIdata.getDirSize();
   }
 
   // Write section table
   for (OutputSection *Sec : OutputSections) {
     Sec->writeHeaderTo(Buf);
     Buf += sizeof(coff_section);
   }
+  SectionTable = ArrayRef<uint8_t>(
+      Buf - OutputSections.size() * sizeof(coff_section), Buf);
 
   if (OutputSymtab.empty())
     return;
 
   COFF->PointerToSymbolTable = PointerToSymbolTable;
   uint32_t NumberOfSymbols = OutputSymtab.size();
   COFF->NumberOfSymbols = NumberOfSymbols;
   auto *SymbolTable = reinterpret_cast<coff_symbol16 *>(

test/COFF/pdb.test

 # RUN: yaml2obj %s > %t.obj
 # RUN: lld-link /debug /pdb:%t.pdb /dll /out:%t.dll /entry:DllMain %t.obj
 # RUN: llvm-pdbdump pdb2yaml -stream-metadata -stream-directory -pdb-stream \
 # RUN:   -dbi-stream -ipi-stream %t.pdb | FileCheck %s
 
+# RUN: llvm-pdbdump raw -section-headers %t.pdb | FileCheck -check-prefix RAW %s
+
 # CHECK:      MSF:
 # CHECK-NEXT:   SuperBlock:
 # CHECK-NEXT:     BlockSize:       4096
 # CHECK-NEXT:     FreeBlockMap:
-# CHECK-NEXT:     NumBlocks:       9
-# CHECK-NEXT:     NumDirectoryBytes: 40
+# CHECK-NEXT:     NumBlocks:       10
+# CHECK-NEXT:     NumDirectoryBytes: 48
 # CHECK-NEXT:     Unknown1:        0
 # CHECK-NEXT:     BlockMapAddr:    3
 # CHECK-NEXT:     NumDirectoryBlocks: 1
-# CHECK-NEXT:     DirectoryBlocks: [ 8 ]
-# CHECK-NEXT:     NumStreams:      5
-# CHECK-NEXT:     FileSize:        36864
-# CHECK-NEXT:   StreamSizes:     [ 0, 48, 56, 68, 56 ]
+# CHECK-NEXT:     DirectoryBlocks: [ 9 ]
+# CHECK-NEXT:     NumStreams:      6
+# CHECK-NEXT:     FileSize:        40960
+# CHECK-NEXT:   StreamSizes:     [ 0, 48, 56, 90, 56, 80 ]
 # CHECK-NEXT:   StreamMap:
-# CHECK-NEXT:     - Stream:          [ ]
-# CHECK-NEXT:     - Stream:          [ 4 ]
-# CHECK-NEXT:     - Stream:          [ 6 ]
+# CHECK-NEXT:     - Stream:          [  ]
 # CHECK-NEXT:     - Stream:          [ 5 ]
 # CHECK-NEXT:     - Stream:          [ 7 ]
+# CHECK-NEXT:     - Stream:          [ 6 ]
+# CHECK-NEXT:     - Stream:          [ 8 ]
+# CHECK-NEXT:     - Stream:          [ 4 ]
 # CHECK-NEXT:   PdbStream:
 # CHECK-NEXT:     Age:             1
 # CHECK-NEXT:     Guid:            '{00000000-0000-0000-0000-000000000000}'
 # CHECK-NEXT:     Signature:       0
 # CHECK-NEXT:     Version:         VC70
 # CHECK-NEXT:     NamedStreams:
 # CHECK-NEXT:   DbiStream:
 # CHECK-NEXT:     VerHeader:       V110
 # CHECK-NEXT:     Age:             1
 # CHECK-NEXT:     BuildNumber:     0
 # CHECK-NEXT:     PdbDllVersion:   0
 # CHECK-NEXT:     PdbDllRbld:      0
 # CHECK-NEXT:     Flags:           0
 # CHECK-NEXT:     MachineType:     x86
 # CHECK-NEXT:   IpiStream:
 # CHECK-NEXT:     Version:         VC80
 # CHECK-NEXT:     Records:
 
+# RAW:      Section Headers [
+# RAW-NEXT:   {
+# RAW-NEXT:     Name: .text
+# RAW-NEXT:     Virtual Size: 3
+# RAW-NEXT:     Virtual Address: 4096
+# RAW-NEXT:     Size of Raw Data: 512
+# RAW-NEXT:     File Pointer to Raw Data: 512
+# RAW-NEXT:     File Pointer to Relocations: 0
+# RAW-NEXT:     File Pointer to Linenumbers: 0
+# RAW-NEXT:     Number of Relocations: 0
+# RAW-NEXT:     Number of Linenumbers: 0
+# RAW-NEXT:     Characteristics [ (0x60000020)
+# RAW-NEXT:       IMAGE_SCN_CNT_CODE (0x20)
+# RAW-NEXT:       IMAGE_SCN_MEM_EXECUTE (0x20000000)
+# RAW-NEXT:       IMAGE_SCN_MEM_READ (0x40000000)
+# RAW-NEXT:     ]
+# RAW-NEXT:   }
+# RAW-NEXT:   {
+# RAW-NEXT:     Name: .rdata
+# RAW-NEXT:     Virtual Size: 107
+# RAW-NEXT:     Virtual Address: 8192
+# RAW-NEXT:     Size of Raw Data: 512
+# RAW-NEXT:     File Pointer to Raw Data: 1024
+# RAW-NEXT:     File Pointer to Relocations: 0
+# RAW-NEXT:     File Pointer to Linenumbers: 0
+# RAW-NEXT:     Number of Relocations: 0
+# RAW-NEXT:     Number of Linenumbers: 0
+# RAW-NEXT:     Characteristics [ (0x40000040)
+# RAW-NEXT:       IMAGE_SCN_CNT_INITIALIZED_DATA (0x40)
+# RAW-NEXT:       IMAGE_SCN_MEM_READ (0x40000000)
+# RAW-NEXT:     ]
+# RAW-NEXT:   }
+# RAW-NEXT: ]
+
 --- !COFF
 header:
   Machine:         IMAGE_FILE_MACHINE_I386
   Characteristics: [  ]
 sections:
   - Name:            .text
     Characteristics: [ IMAGE_SCN_CNT_CODE, IMAGE_SCN_MEM_EXECUTE, IMAGE_SCN_MEM_READ ]
     Alignment:       4