pdb-identity.h File Reference

Internal PDB identity formatting helpers. More...

Go to the source code of this file.

Typedefs
typedef BOOLEAN(*	PSYM_PDB_IDENTITY_FALLBACK_CALLBACK) (PVOID Context, CHAR *PdbFile, SIZE_T PdbFileSize, GUID *Guid, DWORD *Age)
typedef BOOLEAN(*	PSYM_PDB_IDENTITY_EXTRACTOR_CALLBACK) (const BYTE *PeImageBytes, SIZE_T PeImageSize, CHAR *PdbFile, SIZE_T PdbFileSize, GUID *Guid, DWORD *Age)

Functions
BOOLEAN	SymFormatPdbIdentity (const CHAR *PdbFile, const GUID *Guid, DWORD Age, CHAR *SymbolServerRelativePath, SIZE_T SymbolServerRelativePathSize, CHAR *GuidAndAgeDetails, SIZE_T GuidAndAgeDetailsSize)
	Helper function to format the PDB identity information into the specified output buffers.
BOOLEAN	SymFormatPdbIdentityFromPeImageOrFallback (const BYTE *PeImageBytes, SIZE_T PeImageSize, CHAR *SymbolServerRelativePath, SIZE_T SymbolServerRelativePathSize, CHAR *PdbFilePath, SIZE_T PdbFilePathSize, CHAR *GuidAndAgeDetails, SIZE_T GuidAndAgeDetailsSize, PSYM_PDB_IDENTITY_FALLBACK_CALLBACK FallbackCallback, PVOID FallbackContext)
	Extracts PDB identity information from a PE image using the specified extractor callback, with an optional fallback if extraction fails.
BOOLEAN	SymFormatPdbIdentityFromLoadedPeImageOrFallback (const BYTE *PeImageBytes, SIZE_T PeImageSize, CHAR *SymbolServerRelativePath, SIZE_T SymbolServerRelativePathSize, CHAR *PdbFilePath, SIZE_T PdbFilePathSize, CHAR *GuidAndAgeDetails, SIZE_T GuidAndAgeDetailsSize, PSYM_PDB_IDENTITY_FALLBACK_CALLBACK FallbackCallback, PVOID FallbackContext)
	Extracts PDB identity information from a PE image using the specified extractor callback that parses the image as if it is loaded in memory, with an optional fallback if extraction fails.

Detailed Description

Internal PDB identity formatting helpers.

Author

jtaw5649

Version

0.19

Date

2026-06-02

Copyright

This project is released under the GNU Public License v3.

Typedef Documentation

PSYM_PDB_IDENTITY_EXTRACTOR_CALLBACK

typedef BOOLEAN(* PSYM_PDB_IDENTITY_EXTRACTOR_CALLBACK) (const BYTE *PeImageBytes, SIZE_T PeImageSize, CHAR *PdbFile, SIZE_T PdbFileSize, GUID *Guid, DWORD *Age)

PSYM_PDB_IDENTITY_FALLBACK_CALLBACK

typedef BOOLEAN(* PSYM_PDB_IDENTITY_FALLBACK_CALLBACK) (PVOID Context, CHAR *PdbFile, SIZE_T PdbFileSize, GUID *Guid, DWORD *Age)

Function Documentation

SymFormatPdbIdentity()

BOOLEAN SymFormatPdbIdentity	(	const CHAR *	PdbFile,
		const GUID *	Guid,
		DWORD	Age,
		CHAR *	SymbolServerRelativePath,
		SIZE_T	SymbolServerRelativePathSize,
		CHAR *	GuidAndAgeDetails,
		SIZE_T	GuidAndAgeDetailsSize )

Helper function to format the PDB identity information into the specified output buffers.

The function formats the PDB file name, GUID, and age into a symbol server relative path and a combined GUID-and-age string according to the standard symbol server layout.

Parameters

PdbFile	The base name of the PDB file (e.g., "example.pdb")
Guid	The GUID associated with the PDB
Age	The age associated with the PDB
SymbolServerRelativePath	An optional output buffer to receive the formatted symbol server relative path. If not NULL, it must have enough space for the formatted string
SymbolServerRelativePathSize	The size of the SymbolServerRelativePath buffer in bytes
GuidAndAgeDetails	An optional output buffer to receive the formatted GUID and age details string. If not NULL, it must have enough space for the formatted string
GuidAndAgeDetailsSize	The size of the GuidAndAgeDetails buffer in bytes

Returns

BOOLEAN TRUE if the formatting succeeded and output buffers were filled as requested, FALSE if there was an error (e.g., invalid parameters or insufficient buffer sizes)

{
    const CHAR * FormatStrSymbolServerRelativePath = "%s/%08x%04x%04x%02x%02x%02x%02x%02x%02x%02x%02x%x/%s";
    const CHAR * FormatStrGuidAndAgeDetails        = "%08x%04x%04x%02x%02x%02x%02x%02x%02x%02x%02x%x";
 
    if (PdbFile == NULL || Guid == NULL || (SymbolServerRelativePath == NULL && GuidAndAgeDetails == NULL))
    {
        return FALSE;
    }
 
    if (SymbolServerRelativePath != NULL)
    {
        HRESULT Result = StringCchPrintfA(SymbolServerRelativePath,
                                          SymbolServerRelativePathSize,
                                          FormatStrSymbolServerRelativePath,
                                          PdbFile,
                                          Guid->Data1,
                                          Guid->Data2,
                                          Guid->Data3,
                                          Guid->Data4[0],
                                          Guid->Data4[1],
                                          Guid->Data4[2],
                                          Guid->Data4[3],
                                          Guid->Data4[4],
                                          Guid->Data4[5],
                                          Guid->Data4[6],
                                          Guid->Data4[7],
                                          Age,
                                          PdbFile);
 
        if (FAILED(Result))
        {
            return FALSE;
        }
    }
 
    if (GuidAndAgeDetails != NULL)
    {
        HRESULT Result = StringCchPrintfA(GuidAndAgeDetails,
                                          GuidAndAgeDetailsSize,
                                          FormatStrGuidAndAgeDetails,
                                          Guid->Data1,
                                          Guid->Data2,
                                          Guid->Data3,
                                          Guid->Data4[0],
                                          Guid->Data4[1],
                                          Guid->Data4[2],
                                          Guid->Data4[3],
                                          Guid->Data4[4],
                                          Guid->Data4[5],
                                          Guid->Data4[6],
                                          Guid->Data4[7],
                                          Age);
 
        if (FAILED(Result))
        {
            return FALSE;
        }
    }
 
    return TRUE;
}

SymFormatPdbIdentityFromLoadedPeImageOrFallback()

BOOLEAN SymFormatPdbIdentityFromLoadedPeImageOrFallback	(	const BYTE *	PeImageBytes,
		SIZE_T	PeImageSize,
		CHAR *	SymbolServerRelativePath,
		SIZE_T	SymbolServerRelativePathSize,
		CHAR *	PdbFilePath,
		SIZE_T	PdbFilePathSize,
		CHAR *	GuidAndAgeDetails,
		SIZE_T	GuidAndAgeDetailsSize,
		PSYM_PDB_IDENTITY_FALLBACK_CALLBACK	FallbackCallback,
		PVOID	FallbackContext )

Extracts PDB identity information from a PE image using the specified extractor callback that parses the image as if it is loaded in memory, with an optional fallback if extraction fails.

Parameters

PeImageBytes	A pointer to the bytes of the PE image in memory
PeImageSize	The size of the PE image in bytes
SymbolServerRelativePath	An optional output buffer to receive the formatted symbol server relative path. If not NULL, it must have enough space for the formatted string
SymbolServerRelativePathSize	The size of the SymbolServerRelativePath buffer in bytes
PdbFilePath	An optional output buffer to receive the extracted PDB file path. If not NULL, it must have enough space for the file path string
PdbFilePathSize	The size of the PdbFilePath buffer in bytes
GuidAndAgeDetails	An optional output buffer to receive the formatted GUID and age details string. If not NULL, it must have enough space for the formatted string
GuidAndAgeDetailsSize	The size of the GuidAndAgeDetails buffer in bytes
FallbackCallback	An optional callback function that is invoked if the extractor callback fails. It should attempt to provide the same information as the extractor and return TRUE on success or FALSE on failure
FallbackContext	An optional context pointer that is passed to the fallback callback when invoked

Returns

BOOLEAN TRUE if either extraction method succeeded and output buffers were filled as requested, FALSE if both methods failed or if there was an error with parameters or buffer sizes

{
    return SymFormatPdbIdentityFromExtractorOrFallback(PeImageBytes,
                                                       PeImageSize,
                                                       SymbolServerRelativePath,
                                                       SymbolServerRelativePathSize,
                                                       PdbFilePath,
                                                       PdbFilePathSize,
                                                       GuidAndAgeDetails,
                                                       GuidAndAgeDetailsSize,
                                                       SymExtractCodeViewRsdsInfoFromLoadedPeImage,
                                                       FallbackCallback,
                                                       FallbackContext);
}

SymFormatPdbIdentityFromPeImageOrFallback()

BOOLEAN SymFormatPdbIdentityFromPeImageOrFallback	(	const BYTE *	PeImageBytes,
		SIZE_T	PeImageSize,
		CHAR *	SymbolServerRelativePath,
		SIZE_T	SymbolServerRelativePathSize,
		CHAR *	PdbFilePath,
		SIZE_T	PdbFilePathSize,
		CHAR *	GuidAndAgeDetails,
		SIZE_T	GuidAndAgeDetailsSize,
		PSYM_PDB_IDENTITY_FALLBACK_CALLBACK	FallbackCallback,
		PVOID	FallbackContext )

Extracts PDB identity information from a PE image using the specified extractor callback, with an optional fallback if extraction fails.

Parameters

PeImageBytes	A pointer to the bytes of the PE image in memory
PeImageSize	The size of the PE image in bytes
SymbolServerRelativePath	An optional output buffer to receive the formatted symbol server relative path. If not NULL, it must have enough space for the formatted string
SymbolServerRelativePathSize	The size of the SymbolServerRelativePath buffer in bytes
PdbFilePath	An optional output buffer to receive the extracted PDB file path. If not NULL, it must have enough space for the file path string
PdbFilePathSize	The size of the PdbFilePath buffer in bytes
GuidAndAgeDetails	An optional output buffer to receive the formatted GUID and age details string. If not NULL, it must have enough space for the formatted string
GuidAndAgeDetailsSize	The size of the GuidAndAgeDetails buffer in bytes
FallbackCallback	An optional callback function that is invoked if the extractor callback fails. It should attempt to provide the same information as the extractor and return TRUE on success or FALSE on failure
FallbackContext	An optional context pointer that is passed to the fallback callback when invoked

Returns

BOOLEAN TRUE if either extraction method succeeded and output buffers were filled as requested, FALSE if both methods failed or if there was an error with parameters or buffer sizes

{
    return SymFormatPdbIdentityFromExtractorOrFallback(PeImageBytes,
                                                       PeImageSize,
                                                       SymbolServerRelativePath,
                                                       SymbolServerRelativePathSize,
                                                       PdbFilePath,
                                                       PdbFilePathSize,
                                                       GuidAndAgeDetails,
                                                       GuidAndAgeDetailsSize,
                                                       SymExtractCodeViewRsdsInfoFromPeImage,
                                                       FallbackCallback,
                                                       FallbackContext);
}