LLVM 20.0.0git
Public Types | Public Member Functions | Friends | List of all members
llvm::pdb::DbiModuleDescriptorBuilder Class Reference

#include "llvm/DebugInfo/PDB/Native/DbiModuleDescriptorBuilder.h"

Public Types

using MergeSymbolsCallback = Error(*)(void *Ctx, void *Symbols, BinaryStreamWriter &Writer)
 

Public Member Functions

 DbiModuleDescriptorBuilder (StringRef ModuleName, uint32_t ModIndex, msf::MSFBuilder &Msf)
 
 ~DbiModuleDescriptorBuilder ()
 
 DbiModuleDescriptorBuilder (const DbiModuleDescriptorBuilder &)=delete
 
DbiModuleDescriptorBuilder & operator= (const DbiModuleDescriptorBuilder &)=delete
 
void setPdbFilePathNI (uint32_t NI)
 
void setObjFileName (StringRef Name)
 
void setMergeSymbolsCallback (void *Ctx, MergeSymbolsCallback Callback)
 
void setStringTableFixups (std::vector< StringTableFixup > &&Fixups)
 
void setFirstSectionContrib (const SectionContrib &SC)
 
void addSymbol (codeview::CVSymbol Symbol)
 
void addSymbolsInBulk (ArrayRef< uint8_t > BulkSymbols)
 
void addUnmergedSymbols (void *SymSrc, uint32_t SymLength)
 
void addDebugSubsection (std::shared_ptr< codeview::DebugSubsection > Subsection)
 
void addDebugSubsection (const codeview::DebugSubsectionRecord &SubsectionContents)
 
uint16_t getStreamIndex () const
 
StringRef getModuleName () const
 
StringRef getObjFileName () const
 
unsigned getModuleIndex () const
 
ArrayRef< std::string > source_files () const
 
uint32_t calculateSerializedLength () const
 
uint32_t getNextSymbolOffset () const
 Return the offset within the module symbol stream of the next symbol record passed to addSymbol.
 
void finalize ()
 
Error finalizeMsfLayout ()
 
Error commit (BinaryStreamWriter &ModiWriter)
 Commit the DBI descriptor to the DBI stream.
 
Error commitSymbolStream (const msf::MSFLayout &MsfLayout, WritableBinaryStreamRef MsfBuffer)
 Commit the accumulated symbols to the module symbol stream.
 

Friends

class DbiStreamBuilder
 

Detailed Description

Definition at line 63 of file DbiModuleDescriptorBuilder.h.

Member Typedef Documentation

◆ MergeSymbolsCallback

using llvm::pdb::DbiModuleDescriptorBuilder::MergeSymbolsCallback = Error (*)(void *Ctx, void *Symbols, BinaryStreamWriter &Writer)

Definition at line 79 of file DbiModuleDescriptorBuilder.h.

Constructor & Destructor Documentation

◆ DbiModuleDescriptorBuilder() [1/2]

DbiModuleDescriptorBuilder::DbiModuleDescriptorBuilder ( StringRef  ModuleName,
uint32_t  ModIndex,
msf::MSFBuilder &  Msf 
)

Definition at line 43 of file DbiModuleDescriptorBuilder.cpp.

References llvm::pdb::ModuleInfoHeader::Mod, and string.

◆ ~DbiModuleDescriptorBuilder()

DbiModuleDescriptorBuilder::~DbiModuleDescriptorBuilder ( )
default

◆ DbiModuleDescriptorBuilder() [2/2]

llvm::pdb::DbiModuleDescriptorBuilder::DbiModuleDescriptorBuilder ( const DbiModuleDescriptorBuilder &  )
delete

Member Function Documentation

◆ addDebugSubsection() [1/2]

void DbiModuleDescriptorBuilder::addDebugSubsection ( const codeview::DebugSubsectionRecord &  SubsectionContents)

Definition at line 219 of file DbiModuleDescriptorBuilder.cpp.

◆ addDebugSubsection() [2/2]

void llvm::pdb::DbiModuleDescriptorBuilder::addDebugSubsection ( std::shared_ptr< codeview::DebugSubsection >  Subsection)

◆ addSymbol()

void DbiModuleDescriptorBuilder::addSymbol ( codeview::CVSymbol  Symbol)

Definition at line 70 of file DbiModuleDescriptorBuilder.cpp.

References addSymbolsInBulk().

◆ addSymbolsInBulk()

void DbiModuleDescriptorBuilder::addSymbolsInBulk ( ArrayRef< uint8_t >  BulkSymbols)

Definition at line 75 of file DbiModuleDescriptorBuilder.cpp.

References llvm::codeview::alignOf(), assert(), llvm::ArrayRef< T >::empty(), and llvm::ArrayRef< T >::size().

Referenced by addSymbol().

◆ addUnmergedSymbols()

void DbiModuleDescriptorBuilder::addUnmergedSymbols ( void *  SymSrc,
uint32_t  SymLength 
)

Definition at line 89 of file DbiModuleDescriptorBuilder.cpp.

References llvm::codeview::alignOf(), and assert().

◆ calculateSerializedLength()

uint32_t DbiModuleDescriptorBuilder::calculateSerializedLength ( ) const

Definition at line 113 of file DbiModuleDescriptorBuilder.cpp.

References llvm::alignTo().

◆ commit()

Error DbiModuleDescriptorBuilder::commit ( BinaryStreamWriter &  ModiWriter)

Commit the DBI descriptor to the DBI stream.

Definition at line 150 of file DbiModuleDescriptorBuilder.cpp.

References llvm::codeview::EC, llvm::BinaryStreamWriter::padToAlignment(), llvm::Error::success(), llvm::BinaryStreamWriter::writeCString(), and llvm::BinaryStreamWriter::writeObject().

◆ commitSymbolStream()

Error DbiModuleDescriptorBuilder::commitSymbolStream ( const msf::MSFLayout &  MsfLayout,
WritableBinaryStreamRef  MsfBuffer 
)

Commit the accumulated symbols to the module symbol stream.

Safe to call in parallel on different DbiModuleDescriptorBuilder objects. Only modifies the pre-allocated stream in question.

Definition at line 164 of file DbiModuleDescriptorBuilder.cpp.

References llvm::codeview::alignOf(), assert(), llvm::BinaryStreamWriter::bytesRemaining(), llvm::msf::WritableMappedBlockStream::createIndexedStream(), llvm::COFF::DEBUG_SECTION_MAGIC, E, llvm::codeview::EC, llvm::pdb::Fixup, llvm::msf::MSFBuilder::getAllocator(), llvm::BinaryStreamWriter::getOffset(), llvm::pdb::kInvalidStreamIndex, llvm::pdb::ModuleInfoHeader::ModDiStream, llvm::Ref, llvm::BinaryStreamWriter::setOffset(), llvm::pdb::stream_too_long, llvm::Error::success(), Sym, llvm::BinaryStreamWriter::writeBytes(), and llvm::BinaryStreamWriter::writeInteger().

◆ finalize()

void DbiModuleDescriptorBuilder::finalize ( )

Definition at line 120 of file DbiModuleDescriptorBuilder.cpp.

References llvm::pdb::ModuleInfoHeader::C11Bytes, llvm::pdb::ModuleInfoHeader::C13Bytes, llvm::pdb::ModuleInfoHeader::FileNameOffs, llvm::pdb::ModuleInfoHeader::Flags, getNextSymbolOffset(), llvm::pdb::kInvalidStreamIndex, llvm::pdb::ModuleInfoHeader::Mod, llvm::pdb::ModuleInfoHeader::ModDiStream, llvm::pdb::ModuleInfoHeader::NumFiles, llvm::pdb::ModuleInfoHeader::PdbFilePathNI, llvm::pdb::SourceFiles, llvm::pdb::ModuleInfoHeader::SrcFileNameNI, and llvm::pdb::ModuleInfoHeader::SymBytes.

◆ finalizeMsfLayout()

Error DbiModuleDescriptorBuilder::finalizeMsfLayout ( )

Definition at line 137 of file DbiModuleDescriptorBuilder.cpp.

References llvm::msf::MSFBuilder::addStream(), calculateDiSymbolStreamSize(), llvm::pdb::kInvalidStreamIndex, llvm::pdb::ModuleInfoHeader::ModDiStream, and llvm::Error::success().

◆ getModuleIndex()

unsigned llvm::pdb::DbiModuleDescriptorBuilder::getModuleIndex ( ) const
inline

Definition at line 109 of file DbiModuleDescriptorBuilder.h.

References llvm::pdb::ModuleInfoHeader::Mod.

◆ getModuleName()

StringRef llvm::pdb::DbiModuleDescriptorBuilder::getModuleName ( ) const
inline

Definition at line 106 of file DbiModuleDescriptorBuilder.h.

◆ getNextSymbolOffset()

uint32_t llvm::pdb::DbiModuleDescriptorBuilder::getNextSymbolOffset ( ) const
inline

Return the offset within the module symbol stream of the next symbol record passed to addSymbol.

Add four to account for the signature.

Definition at line 117 of file DbiModuleDescriptorBuilder.h.

Referenced by finalize().

◆ getObjFileName()

StringRef llvm::pdb::DbiModuleDescriptorBuilder::getObjFileName ( ) const
inline

Definition at line 107 of file DbiModuleDescriptorBuilder.h.

◆ getStreamIndex()

uint16_t DbiModuleDescriptorBuilder::getStreamIndex ( ) const

Definition at line 53 of file DbiModuleDescriptorBuilder.cpp.

References llvm::pdb::ModuleInfoHeader::ModDiStream.

◆ operator=()

DbiModuleDescriptorBuilder & llvm::pdb::DbiModuleDescriptorBuilder::operator= ( const DbiModuleDescriptorBuilder &  )
delete

◆ setFirstSectionContrib()

void DbiModuleDescriptorBuilder::setFirstSectionContrib ( const SectionContrib &  SC)

Definition at line 65 of file DbiModuleDescriptorBuilder.cpp.

References llvm::pdb::ModuleInfoHeader::SC.

◆ setMergeSymbolsCallback()

void llvm::pdb::DbiModuleDescriptorBuilder::setMergeSymbolsCallback ( void *  Ctx,
MergeSymbolsCallback  Callback 
)
inline

Definition at line 82 of file DbiModuleDescriptorBuilder.h.

◆ setObjFileName()

void DbiModuleDescriptorBuilder::setObjFileName ( StringRef  Name)

Definition at line 57 of file DbiModuleDescriptorBuilder.cpp.

References Name.

◆ setPdbFilePathNI()

void DbiModuleDescriptorBuilder::setPdbFilePathNI ( uint32_t  NI)

Definition at line 61 of file DbiModuleDescriptorBuilder.cpp.

◆ setStringTableFixups()

void llvm::pdb::DbiModuleDescriptorBuilder::setStringTableFixups ( std::vector< StringTableFixup > &&  Fixups)
inline

Definition at line 87 of file DbiModuleDescriptorBuilder.h.

◆ source_files()

ArrayRef< std::string > llvm::pdb::DbiModuleDescriptorBuilder::source_files ( ) const
inline

Definition at line 111 of file DbiModuleDescriptorBuilder.h.

Friends And Related Function Documentation

◆ DbiStreamBuilder

friend class DbiStreamBuilder
friend

Definition at line 64 of file DbiModuleDescriptorBuilder.h.

The documentation for this class was generated from the following files:
Generated on Sun Dec 22 2024 11:30:08 for LLVM by doxygen 1.9.6