upperiface.h

Go to the documentation of this file.

/*
 * Copyright (c) 2020 Bitdefender
 * SPDX-License-Identifier: Apache-2.0
 */

#ifndef _UPPERIFACE_H_
#define _UPPERIFACE_H_

#include "intro_types.h"

#if !defined(INT_COMPILER_MSVC)
#    define PRINTF_ATTRIBUTE __attribute__((format(printf, 3, 4)))
#else
#    define PRINTF_ATTRIBUTE
#endif // !defined(INT_COMPILER_MSVC)

//
// Core Functions exposed by the integrator.
//

typedef INTSTATUS
PRINTF_ATTRIBUTE
(*PFUNC_IntTracePrint)(
    _In_opt_ const CHAR *File,
    _In_opt_ DWORD Line,
    _In_z_ const CHAR *Format,
    ...
    );

typedef INTSTATUS
(*PFUNC_IntSpinLockInit)(
    _Outptr_ void **SpinLock,
    _In_z_ PCHAR Name
    );

typedef INTSTATUS
(*PFUNC_IntSpinLockUnInit)(
    _Inout_ _At_(*SpinLock, _Post_null_) void **SpinLock
    );

typedef INTSTATUS
(*PFUNC_IntSpinLockAcquire)(
    _In_ void *SpinLock
    );

typedef INTSTATUS
(*PFUNC_IntSpinLockRelease)(
    _In_ void *SpinLock
    );

typedef INTSTATUS
(*PFUNC_IntRwSpinLockInit)(
    _Outptr_ void **SpinLock,
    _In_z_ PCHAR Name
    );

typedef INTSTATUS
(*PFUNC_IntRwSpinLockUnInit)(
    _Inout_ _At_(*SpinLock, _Post_null_) void **SpinLock
    );

typedef INTSTATUS
(*PFUNC_IntRwSpinLockAcquireShared)(
    _In_ void *SpinLock
    );

typedef INTSTATUS
(*PFUNC_IntRwSpinLockAcquireExclusive)(
    _In_ void *SpinLock
    );

typedef INTSTATUS
(*PFUNC_IntRwSpinLockReleaseShared)(
    _In_ void *SpinLock
    );

typedef INTSTATUS
(*PFUNC_IntRwSpinLockReleaseExclusive)(
    _In_ void *SpinLock
    );

typedef INTSTATUS
(*PFUNC_IntQueryHeapSize)(
    _Out_ size_t *TotalHeapSize,
    _Out_ size_t *FreeHeapSize
    );

typedef void
(*PFUNC_IntBugCheck)(
    void
    );

typedef void
(*PFUNC_IntEnterDebugger)(
    void
    );

typedef INTSTATUS
(*PFUNC_HpAllocWithTagAndInfo)(
    _Outptr_result_bytebuffer_(Size) void **Address,
    _In_ size_t Size,
    _In_ DWORD Tag
    );

typedef INTSTATUS
(*PFUNC_HpFreeWithTagAndInfo)(
    _Inout_ _At_(*Address, _Post_null_) void **Address,
    _In_ DWORD Tag
    );

#pragma pack(push)
#pragma pack(8)

typedef struct _UPPER_IFACE
{
    DWORD                                   Version;
    DWORD                                   Size;
    QWORD                                   Reserved;

    PFUNC_IntTracePrint                     TracePrint;
    PFUNC_HpAllocWithTagAndInfo             MemAllocWithTagAndInfo;
    PFUNC_HpFreeWithTagAndInfo              MemFreeWithTagAndInfo;
    PFUNC_IntSpinLockInit                   SpinLockInit;
    PFUNC_IntSpinLockUnInit                 SpinLockUnInit;
    PFUNC_IntSpinLockAcquire                SpinLockAcquire;
    PFUNC_IntSpinLockRelease                SpinLockRelease;
    PFUNC_IntRwSpinLockInit                 RwSpinLockInit;
    PFUNC_IntRwSpinLockUnInit               RwSpinLockUnInit;
    PFUNC_IntRwSpinLockAcquireShared        RwSpinLockAcquireShared;
    PFUNC_IntRwSpinLockAcquireExclusive     RwSpinLockAcquireExclusive;
    PFUNC_IntRwSpinLockReleaseShared        RwSpinLockReleaseShared;
    PFUNC_IntRwSpinLockReleaseExclusive     RwSpinLockReleaseExclusive;
    PFUNC_IntQueryHeapSize                  QueryHeapSize;
    PFUNC_IntBugCheck                       BugCheck;
    PFUNC_IntEnterDebugger                  EnterDebugger;
} UPPER_IFACE, *PUPPER_IFACE;

#define UPPER_IFACE_VERSION_1           0x00010074
#define UPPER_IFACE_VERSION_1_SIZE      sizeof(UPPER_IFACE)

#define UPPER_IFACE_VERSION_LATEST      UPPER_IFACE_VERSION_1
#define UPPER_IFACE_VERSION_LATEST_SIZE UPPER_IFACE_VERSION_1_SIZE

#pragma pack(pop)

#endif // _UPPERIFACE_H_