sdbpapi.h File Reference

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	tagMEMMAPPED

Macros
#define	SdbAlloc(size)   SdbpAlloc(size)
#define	SdbReAlloc(mem, size, oldSize)   SdbpReAlloc(mem, size, oldSize)
#define	SdbFree(mem)   SdbpFree(mem)
#define	WINAPIV
#define	SHIM_ERR(fmt, ...)   do { if (g_ShimDebugLevel) ShimDbgPrint(SHIM_ERR, __FUNCTION__, fmt, ##__VA_ARGS__ ); } while (0)
#define	SHIM_WARN(fmt, ...)   do { if (g_ShimDebugLevel) ShimDbgPrint(SHIM_WARN, __FUNCTION__, fmt, ##__VA_ARGS__ ); } while (0)
#define	SHIM_INFO(fmt, ...)   do { if (g_ShimDebugLevel) ShimDbgPrint(SHIM_INFO, __FUNCTION__, fmt, ##__VA_ARGS__ ); } while (0)

Typedefs
typedef struct tagMEMMAPPED	MEMMAPPED
typedef struct tagMEMMAPPED *	PMEMMAPPED
typedef enum _SHIM_LOG_LEVEL	SHIM_LOG_LEVEL

Enumerations
enum	_SHIM_LOG_LEVEL { SHIM_ERR = 1 , SHIM_WARN = 2 , SHIM_INFO = 3 }

Functions
void	SdbpHeapInit (void)
void	SdbpHeapDeinit (void)
LPVOID	SdbpAlloc (SIZE_T size)
LPVOID	SdbpReAlloc (LPVOID mem, SIZE_T size, SIZE_T oldSize)
void	SdbpFree (LPVOID mem)
BOOL WINAPI	SdbpOpenMemMappedFile (LPCWSTR path, PMEMMAPPED mapping)
void WINAPI	SdbpCloseMemMappedFile (PMEMMAPPED mapping)
PDB WINAPI	SdbpCreate (LPCWSTR path, PATH_TYPE type, BOOL write)
void WINAPI	SdbpFlush (PDB pdb)
DWORD	SdbpStrlen (PCWSTR string)
DWORD	SdbpStrsize (PCWSTR string)
BOOL WINAPI	SdbpCheckTagType (TAG tag, WORD type)
BOOL WINAPI	SdbpCheckTagIDType (PDB pdb, TAGID tagid, WORD type)
BOOL WINAPIV	ShimDbgPrint (SHIM_LOG_LEVEL Level, PCSTR FunctionName, PCSTR Format,...)

Variables
ULONG	g_ShimDebugLevel

Macro Definition Documentation

SdbAlloc

#define SdbAlloc

(

size

)

SdbpAlloc(size)

Definition at line 35 of file sdbpapi.h.

SdbFree

#define SdbFree

(

mem

)

SdbpFree(mem)

Definition at line 37 of file sdbpapi.h.

SdbReAlloc

#define SdbReAlloc	(		mem,
			size,
			oldSize
	)		SdbpReAlloc(mem, size, oldSize)

Definition at line 36 of file sdbpapi.h.

SHIM_ERR

#define SHIM_ERR	(		fmt,
			...
	)		do { if (g_ShimDebugLevel) ShimDbgPrint(SHIM_ERR, __FUNCTION__, fmt, ##__VA_ARGS__ ); } while (0)

Definition at line 76 of file sdbpapi.h.

SHIM_INFO

#define SHIM_INFO	(		fmt,
			...
	)		do { if (g_ShimDebugLevel) ShimDbgPrint(SHIM_INFO, __FUNCTION__, fmt, ##__VA_ARGS__ ); } while (0)

Definition at line 78 of file sdbpapi.h.

SHIM_WARN

#define SHIM_WARN	(		fmt,
			...
	)		do { if (g_ShimDebugLevel) ShimDbgPrint(SHIM_WARN, __FUNCTION__, fmt, ##__VA_ARGS__ ); } while (0)

Definition at line 77 of file sdbpapi.h.

WINAPIV

#define WINAPIV

Definition at line 64 of file sdbpapi.h.

Typedef Documentation

MEMMAPPED

typedef struct tagMEMMAPPED MEMMAPPED

PMEMMAPPED

typedef struct tagMEMMAPPED * PMEMMAPPED

SHIM_LOG_LEVEL

typedef enum _SHIM_LOG_LEVEL SHIM_LOG_LEVEL

Enumeration Type Documentation

_SHIM_LOG_LEVEL

enum _SHIM_LOG_LEVEL

Enumerator
SHIM_ERR
SHIM_WARN
SHIM_INFO

Definition at line 67 of file sdbpapi.h.

                             {
    SHIM_ERR = 1,
    SHIM_WARN = 2,
    SHIM_INFO = 3,
} SHIM_LOG_LEVEL;

Function Documentation

SdbpAlloc()

LPVOID SdbpAlloc

(

SIZE_T

size

)

Definition at line 55 of file sdbapi.c.

{
    LPVOID mem = RtlAllocateHeap(SdbpHeap(), HEAP_ZERO_MEMORY, size);
#if SDBAPI_DEBUG_ALLOC
    SdbpInsertAllocation(mem, size, line, file);
#endif
    return mem;
}

SdbpCheckTagIDType()

BOOL WINAPI SdbpCheckTagIDType	(	PDB	pdb,
		TAGID	tagid,
		WORD	type
	)

Definition at line 261 of file sdbapi.c.

{
    TAG tag = SdbGetTagFromTagID(pdb, tagid);
    if (tag == TAG_NULL)
        return FALSE;
    return SdbpCheckTagType(tag, type);
}

Referenced by SdbEndWriteListTag(), SdbGetBinaryTagData(), SdbReadBinaryTag(), SdbReadDWORDTag(), SdbReadQWORDTag(), and SdbReadWORDTag().

SdbpCheckTagType()

BOOL WINAPI SdbpCheckTagType	(	TAG	tag,
		WORD	type
	)

Definition at line 254 of file sdbapi.c.

{
    if ((tag & TAG_TYPE_MASK) != type)
        return FALSE;
    return TRUE;
}

Referenced by SdbBeginWriteListTag(), SdbpCheckTagIDType(), SdbWriteBinaryTag(), SdbWriteBinaryTagFromFile(), SdbWriteDWORDTag(), SdbWriteNULLTag(), SdbWriteQWORDTag(), SdbWriteStringRefTag(), SdbWriteStringTag(), and SdbWriteWORDTag().

SdbpCloseMemMappedFile()

void WINAPI SdbpCloseMemMappedFile

(

PMEMMAPPED

mapping

)

Definition at line 244 of file sdbapi.c.

{
    /* Prevent a VAD warning */
    if (mapping->view)
        NtUnmapViewOfSection(NtCurrentProcess(), mapping->view);
    NtClose(mapping->section);
    NtClose(mapping->file);
    RtlZeroMemory(mapping, sizeof(*mapping));
}

Referenced by SdbGetFileAttributes(), and SdbWriteBinaryTagFromFile().

SdbpCreate()

PDB WINAPI SdbpCreate	(	LPCWSTR	path,
		PATH_TYPE	type,
		BOOL	write
	)

Definition at line 93 of file sdbapi.c.

{
    NTSTATUS Status;
    IO_STATUS_BLOCK io;
    OBJECT_ATTRIBUTES attr;
    UNICODE_STRING str;
    PDB pdb;
 
    if (type == DOS_PATH)
    {
        if (!RtlDosPathNameToNtPathName_U(path, &str, NULL, NULL))
            return NULL;
    }
    else
    {
        RtlInitUnicodeString(&str, path);
    }
 
    /* SdbAlloc zeroes the memory. */
    pdb = (PDB)SdbAlloc(sizeof(DB));
    if (!pdb)
    {
        SHIM_ERR("Failed to allocate memory for shim database\n");
        return NULL;
    }
 
    InitializeObjectAttributes(&attr, &str, OBJ_CASE_INSENSITIVE, NULL, NULL);
 
    Status = NtCreateFile(&pdb->file, (write ? FILE_GENERIC_WRITE : FILE_GENERIC_READ )| SYNCHRONIZE,
                          &attr, &io, NULL, FILE_ATTRIBUTE_NORMAL, FILE_SHARE_READ,
                          write ? FILE_SUPERSEDE : FILE_OPEN, FILE_NON_DIRECTORY_FILE | FILE_SYNCHRONOUS_IO_NONALERT, NULL, 0);
 
    pdb->for_write = write;
 
    if (type == DOS_PATH)
        RtlFreeUnicodeString(&str);
 
    if (!NT_SUCCESS(Status))
    {
        SdbCloseDatabase(pdb);
        SHIM_ERR("Failed to create shim database file: %lx\n", Status);
        return NULL;
    }
 
    return pdb;
}

Referenced by SdbCreateDatabase(), and SdbpOpenDatabase().

SdbpFlush()

void WINAPI SdbpFlush

(

PDB

pdb

)

Definition at line 140 of file sdbapi.c.

{
    IO_STATUS_BLOCK io;
    NTSTATUS Status;
 
    ASSERT(pdb->for_write);
    Status = NtWriteFile(pdb->file, NULL, NULL, NULL, &io,
        pdb->data, pdb->write_iter, NULL, NULL);
    if (!NT_SUCCESS(Status))
        SHIM_WARN("failed with 0x%lx\n", Status);
}

Referenced by SdbCloseDatabaseWrite().

SdbpFree()

void SdbpFree

(

LPVOID

mem

)

Definition at line 81 of file sdbapi.c.

{
#if SDBAPI_DEBUG_ALLOC
    SdbpRemoveAllocation(mem, line, file);
#endif
    RtlFreeHeap(SdbpHeap(), 0, mem);
}

SdbpHeapDeinit()

void SdbpHeapDeinit

(

void

)

Definition at line 42 of file sdbapi.c.

{
#if SDBAPI_DEBUG_ALLOC
    SdbpDebugHeapDeinit();
#endif
    RtlDestroyHeap(g_Heap);
}

Referenced by DllMain().

SdbpHeapInit()

void SdbpHeapInit

(

void

)

Definition at line 34 of file sdbapi.c.

{
    g_Heap = RtlCreateHeap(HEAP_GROWABLE, NULL, 0, 0x10000, NULL, NULL);
#if SDBAPI_DEBUG_ALLOC
    SdbpDebugHeapInit(g_Heap);
#endif
}

Referenced by DllMain().

SdbpOpenMemMappedFile()

BOOL WINAPI SdbpOpenMemMappedFile	(	LPCWSTR	path,
		PMEMMAPPED	mapping
	)

Definition at line 170 of file sdbapi.c.

{
    NTSTATUS Status;
    OBJECT_ATTRIBUTES ObjectAttributes;
    IO_STATUS_BLOCK IoStatusBlock;
    FILE_STANDARD_INFORMATION FileStandard;
    UNICODE_STRING FileName;
 
    RtlZeroMemory(mapping, sizeof(*mapping));
 
    RtlInitUnicodeString(&FileName, path);
 
    InitializeObjectAttributes(&ObjectAttributes, &FileName, OBJ_CASE_INSENSITIVE, NULL, NULL);
    Status = NtOpenFile(&mapping->file, GENERIC_READ | SYNCHRONIZE, &ObjectAttributes, &IoStatusBlock, FILE_SHARE_READ, FILE_SYNCHRONOUS_IO_NONALERT);
 
    if (Status == STATUS_OBJECT_NAME_INVALID || Status == STATUS_OBJECT_PATH_SYNTAX_BAD)
    {
        if (!RtlDosPathNameToNtPathName_U(path, &FileName, NULL, NULL))
        {
            SHIM_ERR("Failed to convert %S to Nt path: 0x%lx\n", path, Status);
            return FALSE;
        }
        InitializeObjectAttributes(&ObjectAttributes, &FileName, OBJ_CASE_INSENSITIVE, NULL, NULL);
        Status = NtOpenFile(&mapping->file, GENERIC_READ | SYNCHRONIZE, &ObjectAttributes, &IoStatusBlock, FILE_SHARE_READ, FILE_SYNCHRONOUS_IO_NONALERT);
        RtlFreeUnicodeString(&FileName);
    }
 
    if (!NT_SUCCESS(Status))
    {
        SHIM_ERR("Failed to open file %S: 0x%lx\n", path, Status);
        return FALSE;
    }
 
    Status = NtCreateSection(&mapping->section, STANDARD_RIGHTS_REQUIRED | SECTION_QUERY | SECTION_MAP_READ, 0, 0, PAGE_READONLY, SEC_COMMIT, mapping->file);
    if (!NT_SUCCESS(Status))
    {
        /* Special case */
        if (Status == STATUS_MAPPED_FILE_SIZE_ZERO)
        {
            NtClose(mapping->file);
            mapping->file = mapping->section = NULL;
            return TRUE;
        }
        SHIM_ERR("Failed to create mapping for file: 0x%lx\n", Status);
        goto err_out;
    }
 
    Status = NtQueryInformationFile(mapping->file, &IoStatusBlock, &FileStandard, sizeof(FileStandard), FileStandardInformation);
    if (!NT_SUCCESS(Status))
    {
        SHIM_ERR("Failed to read file info for file: 0x%lx\n", Status);
        goto err_out;
    }
 
    mapping->mapped_size = mapping->size = FileStandard.EndOfFile.LowPart;
    Status = NtMapViewOfSection(mapping->section, NtCurrentProcess(), (PVOID*)&mapping->view, 0, 0, 0, &mapping->mapped_size, ViewUnmap, 0, PAGE_READONLY);
    if (!NT_SUCCESS(Status))
    {
        SHIM_ERR("Failed to map view of file: 0x%lx\n", Status);
        goto err_out;
    }
 
    return TRUE;
 
err_out:
    if (!mapping->view)
    {
        if (mapping->section)
            NtClose(mapping->section);
        NtClose(mapping->file);
    }
    return FALSE;
}

Referenced by SdbGetFileAttributes(), and SdbWriteBinaryTagFromFile().

SdbpReAlloc()

LPVOID SdbpReAlloc	(	LPVOID	mem,
		SIZE_T	size,
		SIZE_T	oldSize
	)

Definition at line 68 of file sdbapi.c.

{
    LPVOID newmem = RtlReAllocateHeap(SdbpHeap(), HEAP_ZERO_MEMORY, mem, size);
#if SDBAPI_DEBUG_ALLOC
    SdbpUpdateAllocation(mem, newmem, size, line, file);
#endif
    return newmem;
}

SdbpStrlen()

DWORD SdbpStrlen

(

PCWSTR

string

)

Definition at line 152 of file sdbapi.c.

{
    return (DWORD)wcslen(string);
}

Referenced by HashAddString(), SdbGetAppPatchDir(), SdbpBuildSignMediaId(), SdbpCreate(), SdbpStrsize(), and Sdbwcscpy().

SdbpStrsize()

DWORD SdbpStrsize

(

PCWSTR

string

)

Definition at line 157 of file sdbapi.c.

{
    return (SdbpStrlen(string) + 1) * sizeof(WCHAR);
}

Referenced by SdbpStrDup().

ShimDbgPrint()

BOOL WINAPIV ShimDbgPrint	(	SHIM_LOG_LEVEL	Level,
		PCSTR	FunctionName,
		PCSTR	Format,
			...
	)

Outputs diagnostic info.

Parameters

[in]	Level	The level to log this message with, choose any of [SHIM_ERR, SHIM_WARN, SHIM_INFO].
[in]	FunctionName	The function this log should be attributed to.
[in]	Format	The format string.
	...	Variable arguments providing additional information.

Returns

Success: TRUE Failure: FALSE.

Definition at line 107 of file apphelp.c.

{
    char Buffer[512];
    va_list ArgList;
    char* Current = Buffer;
    const char* LevelStr;
    size_t Length = sizeof(Buffer);
 
    if (g_ShimDebugLevel == ~0)
        ApphelppInitDebugLevel();
 
    if (Level > g_ShimDebugLevel)
        return FALSE;
 
    switch (Level)
    {
    case SHIM_ERR:
        LevelStr = "Err ";
        Level = DPFLTR_MASK | (1 << DPFLTR_ERROR_LEVEL);
        break;
    case SHIM_WARN:
        LevelStr = "Warn";
        Level = DPFLTR_MASK | (1 << DPFLTR_WARNING_LEVEL);
        break;
    case SHIM_INFO:
        LevelStr = "Info";
        Level = DPFLTR_MASK | (1 << DPFLTR_INFO_LEVEL);
        break;
    default:
        LevelStr = "User";
        Level = DPFLTR_MASK | (1 << DPFLTR_INFO_LEVEL);
        break;
    }
    StringCchPrintfExA(Current, Length, &Current, &Length, STRSAFE_NULL_ON_FAILURE, "[%s][%-20s] ", LevelStr, FunctionName);
 
    va_start(ArgList, Format);
    StringCchVPrintfExA(Current, Length, &Current, &Length, STRSAFE_NULL_ON_FAILURE, Format, ArgList);
    va_end(ArgList);
 
#if defined(APPCOMPAT_USE_DBGPRINTEX) && APPCOMPAT_USE_DBGPRINTEX
    return NT_SUCCESS(DbgPrintEx(DPFLTR_APPCOMPAT_ID, Level, "%s", Buffer));
#else
    DbgPrint("%s", Buffer);
    return TRUE;
#endif
}

Variable Documentation

g_ShimDebugLevel

ULONG g_ShimDebugLevel

extern

Definition at line 36 of file apphelp.c.

Referenced by ApphelppInitDebugLevel(), ShimDbgPrint(), and update_loglevel().