mirror of
https://github.com/CyberSecurityUP/Offensive-Windows-Drivers-Development
synced 2026-06-06 15:34:28 +00:00
Joas A Santos
767 lines
23 KiB
Plaintext
767 lines
23 KiB
Plaintext
// ff9375f2a9679d242a245d9492a2af50 Generated file. Do not edit.
|
|
// File created by WPP compiler version 10.0.26100
|
|
// from template km-default.tpl
|
|
|
|
#pragma once
|
|
|
|
// template km-header.tpl
|
|
|
|
#ifdef WPP_THIS_FILE
|
|
// included twice
|
|
# define WPP_ALREADY_INCLUDED
|
|
# undef WPP_THIS_FILE
|
|
#endif // #ifdef WPP_THIS_FILE
|
|
|
|
#define WPP_THIS_FILE Driver_c
|
|
|
|
#ifndef WPP_ALREADY_INCLUDED
|
|
|
|
#define WPP_KERNEL_MODE
|
|
|
|
#include <evntrace.h>
|
|
#include <stddef.h>
|
|
#include <stdarg.h>
|
|
#include <wmistr.h>
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
typedef
|
|
LONG
|
|
(*PFN_WPPQUERYTRACEINFORMATION) (
|
|
IN TRACE_INFORMATION_CLASS TraceInformationClass,
|
|
OUT PVOID TraceInformation,
|
|
IN ULONG TraceInformationLength,
|
|
OUT PULONG RequiredLength OPTIONAL,
|
|
IN PVOID Buffer OPTIONAL
|
|
);
|
|
|
|
typedef
|
|
LONG
|
|
(*PFN_WPPTRACEMESSAGE)(
|
|
IN ULONG64 LoggerHandle,
|
|
IN ULONG MessageFlags,
|
|
IN LPCGUID MessageGuid,
|
|
IN USHORT MessageNumber,
|
|
IN ...
|
|
);
|
|
|
|
typedef enum _WPP_TRACE_API_SUITE {
|
|
WppTraceDisabledSuite,
|
|
WppTraceWin2K,
|
|
WppTraceWinXP,
|
|
WppTraceTraceLH,
|
|
WppTraceServer08,
|
|
WppTraceMaxSuite
|
|
} WPP_TRACE_API_SUITE;
|
|
|
|
_IRQL_requires_same_
|
|
typedef
|
|
VOID
|
|
(NTAPI *PETW_CLASSIC_CALLBACK)(
|
|
_In_ LPCGUID Guid,
|
|
_In_ UCHAR ControlCode,
|
|
_In_ PVOID EnableContext,
|
|
_In_opt_ PVOID CallbackContext
|
|
);
|
|
|
|
_IRQL_requires_same_
|
|
typedef
|
|
NTSTATUS
|
|
NTKERNELAPI
|
|
(FN_ETWREGISTERCLASSICPROVIDER)(
|
|
_In_ LPCGUID ProviderGuid,
|
|
_In_ ULONG Type,
|
|
_In_ PETW_CLASSIC_CALLBACK EnableCallback,
|
|
_In_opt_ PVOID CallbackContext,
|
|
_Out_ PREGHANDLE RegHandle
|
|
);
|
|
|
|
typedef FN_ETWREGISTERCLASSICPROVIDER *PFN_ETWREGISTERCLASSICPROVIDER;
|
|
|
|
typedef
|
|
BOOLEAN
|
|
NTKERNELAPI
|
|
(FN_WPPGETVERSION)(
|
|
_Out_opt_ PULONG MajorVersion,
|
|
_Out_opt_ PULONG MinorVersion,
|
|
_Out_opt_ PULONG BuildNumber,
|
|
_Out_opt_ PUNICODE_STRING CSDVersion
|
|
);
|
|
|
|
typedef FN_WPPGETVERSION *PFN_WPPGETVERSION;
|
|
|
|
typedef
|
|
NTSTATUS
|
|
NTKERNELAPI
|
|
(FN_ETWUNREGISTER)(
|
|
_In_ REGHANDLE RegHandle
|
|
);
|
|
|
|
typedef FN_ETWUNREGISTER *PFN_ETWUNREGISTER;
|
|
|
|
#pragma prefast(suppress:__WARNING_ENCODE_GLOBAL_FUNCTION_POINTER, "this pointer can not be encoded");
|
|
__declspec(selectany) PFN_WPPQUERYTRACEINFORMATION pfnWppQueryTraceInformation = NULL;
|
|
|
|
#pragma prefast(suppress:__WARNING_ENCODE_GLOBAL_FUNCTION_POINTER, "this pointer can not be encoded");
|
|
__declspec(selectany) PFN_WPPTRACEMESSAGE pfnWppTraceMessage = NULL;
|
|
|
|
#pragma prefast(suppress:__WARNING_ENCODE_GLOBAL_FUNCTION_POINTER, "this pointer can not be encoded");
|
|
__declspec(selectany) PFN_ETWUNREGISTER pfnEtwUnregister = NULL;
|
|
|
|
#pragma prefast(suppress:__WARNING_ENCODE_GLOBAL_FUNCTION_POINTER, "this pointer can not be encoded");
|
|
__declspec(selectany) PFN_ETWREGISTERCLASSICPROVIDER pfnEtwRegisterClassicProvider = NULL;
|
|
|
|
#pragma prefast(suppress:__WARNING_ENCODE_GLOBAL_FUNCTION_POINTER, "this pointer can not be encoded");
|
|
__declspec(selectany) PFN_WPPGETVERSION pfnWppGetVersion = NULL;
|
|
|
|
|
|
__declspec(selectany) WPP_TRACE_API_SUITE WPPTraceSuite = WppTraceDisabledSuite;
|
|
|
|
#if !defined(_NTRTL_)
|
|
#if !defined(_NTHAL_)
|
|
// fake RTL_TIME_ZONE_INFORMATION //
|
|
typedef int RTL_TIME_ZONE_INFORMATION;
|
|
#endif
|
|
#define _WMIKM_
|
|
#endif
|
|
|
|
#ifndef WPP_TRACE
|
|
#define WPP_TRACE pfnWppTraceMessage
|
|
#endif
|
|
|
|
#if ENABLE_WPP_RECORDER
|
|
|
|
#define _ENABLE_WPP_RECORDER TRUE
|
|
|
|
#ifndef WPP_RECORDER
|
|
#define WPP_RECORDER WppAutoLogTrace
|
|
#endif
|
|
|
|
//
|
|
// This setting is only applicable when IFR is enabled.
|
|
// Setting this to 1 will allow a WPP trace session to
|
|
// capture trace messages as usual i.e it will require the
|
|
// user to provide WPP trace ENABLED and LOGGER macro. If
|
|
// this is set to 0 by default the IFR trace filter also
|
|
// affects which trace messages land in the WPP trace session.
|
|
//
|
|
#if !defined(ENABLE_WPP_TRACE_FILTERING_WITH_WPP_RECORDER)
|
|
#define ENABLE_WPP_TRACE_FILTERING_WITH_WPP_RECORDER 0
|
|
#endif
|
|
|
|
#if !defined(WPP_RECORDER_LEVEL_FLAGS_ARGS)
|
|
#define WPP_RECORDER_LEVEL_FLAGS_ARGS(lvl, flags) WPP_CONTROL(WPP_BIT_ ## flags).AutoLogContext, lvl, WPP_BIT_ ## flags
|
|
#define WPP_RECORDER_LEVEL_FLAGS_FILTER(lvl,flags) (lvl < TRACE_LEVEL_VERBOSE || WPP_CONTROL(WPP_BIT_ ## flags).AutoLogVerboseEnabled)
|
|
#endif
|
|
|
|
|
|
#if !defined(WPP_RECORDER_LEVEL_ARGS)
|
|
#define WPP_RECORDER_LEVEL_ARGS(lvl) WPP_CONTROL(WPP_BIT_ ## lvl).AutoLogContext, 0, WPP_BIT_ ## lvl
|
|
#define WPP_RECORDER_LEVEL_FILTER(lvl) (WPP_CONTROL(WPP_BIT_ ## lvl).AutoLogVerboseEnabled)
|
|
#endif
|
|
|
|
NTSTATUS
|
|
WppAutoLogTrace(
|
|
IN PVOID AutoLogContext,
|
|
IN UCHAR MessageLevel,
|
|
IN ULONG MessageFlags,
|
|
IN LPGUID MessageGuid,
|
|
IN USHORT MessageNumber,
|
|
IN ...
|
|
);
|
|
|
|
#else
|
|
#define _ENABLE_WPP_RECORDER FALSE
|
|
#endif
|
|
|
|
VOID
|
|
WppLoadTracingSupport(
|
|
VOID
|
|
);
|
|
|
|
NTSTATUS
|
|
WppTraceCallback(
|
|
_In_ UCHAR MinorFunction,
|
|
_In_opt_ PVOID DataPath,
|
|
_In_ ULONG BufferLength,
|
|
_Inout_updates_bytes_(BufferLength) PVOID Buffer,
|
|
_Inout_ PVOID Context,
|
|
_Out_ PULONG Size
|
|
);
|
|
|
|
#if !defined(WPP_TRACE_CONTROL_NULL_GUID)
|
|
DEFINE_GUID(WPP_TRACE_CONTROL_NULL_GUID, 0x00000000L, 0x0000, 0x0000, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00);
|
|
#endif
|
|
|
|
#define WPP_TRACE_CONTROL(Function,Buffer,BufferSize,ReturnSize) WppTraceCallback(Function,NULL,BufferSize,Buffer,&WPP_CB[0],&ReturnSize);
|
|
|
|
__inline ULONG64 WppQueryLogger(_In_opt_ PCWSTR LoggerName)
|
|
{
|
|
if (WppTraceWinXP != WPPTraceSuite) {
|
|
return (ULONG64)0;
|
|
}
|
|
|
|
ULONG ReturnLength;
|
|
LONG Status;
|
|
ULONG64 TraceHandle;
|
|
UNICODE_STRING Buffer;
|
|
|
|
RtlInitUnicodeString(&Buffer, LoggerName ? LoggerName : L"stdout");
|
|
|
|
Status = pfnWppQueryTraceInformation(TraceHandleByNameClass,
|
|
(PVOID)&TraceHandle,
|
|
sizeof(TraceHandle),
|
|
&ReturnLength,
|
|
(PVOID)&Buffer
|
|
);
|
|
if (Status != STATUS_SUCCESS) {
|
|
return (ULONG64)0;
|
|
}
|
|
|
|
return TraceHandle;
|
|
}
|
|
|
|
typedef LONG (*WMIENTRY_NEW)(
|
|
_In_ UCHAR MinorFunction,
|
|
_In_opt_ PVOID DataPath,
|
|
_In_ ULONG BufferLength,
|
|
_Inout_updates_bytes_(BufferLength) PVOID Buffer,
|
|
_In_ PVOID Context,
|
|
_Out_ PULONG Size
|
|
);
|
|
|
|
typedef struct _WPP_TRACE_CONTROL_BLOCK
|
|
{
|
|
WMIENTRY_NEW Callback;
|
|
LPCGUID ControlGuid;
|
|
struct _WPP_TRACE_CONTROL_BLOCK *Next;
|
|
__int64 Logger;
|
|
PUNICODE_STRING RegistryPath;
|
|
UCHAR FlagsLen;
|
|
UCHAR Level;
|
|
USHORT Reserved;
|
|
ULONG Flags[1];
|
|
ULONG ReservedFlags;
|
|
REGHANDLE RegHandle;
|
|
#if ENABLE_WPP_RECORDER
|
|
PVOID AutoLogContext;
|
|
USHORT AutoLogVerboseEnabled;
|
|
USHORT AutoLogAttachToMiniDump;
|
|
#endif
|
|
} WPP_TRACE_CONTROL_BLOCK, *PWPP_TRACE_CONTROL_BLOCK;
|
|
|
|
VOID WppCleanupKm(_When_(_ENABLE_WPP_RECORDER, _In_) _When_(!_ENABLE_WPP_RECORDER, _In_opt_) PDRIVER_OBJECT DriverObject);
|
|
|
|
#define WPP_CLEANUP(DriverObject) WppCleanupKm((PDRIVER_OBJECT)DriverObject)
|
|
|
|
#define WPP_IsValidSid RtlValidSid
|
|
#define WPP_GetLengthSid RtlLengthSid
|
|
|
|
//
|
|
// Callback routine to be defined by the driver, which will be called from WPP callback
|
|
// WPP will pass current valued of : GUID, Logger, Enable, Flags, and Level
|
|
//
|
|
// To activate driver must define WPP_PRIVATE_ENABLE_CALLBACK in their code, sample below
|
|
// #define WPP_PRIVATE_ENABLE_CALLBACK MyPrivateCallback;
|
|
//
|
|
typedef
|
|
VOID
|
|
(*PFN_WPP_PRIVATE_ENABLE_CALLBACK)(
|
|
_In_ LPCGUID Guid,
|
|
_In_ __int64 Logger,
|
|
_In_ BOOLEAN Enable,
|
|
_In_ ULONG Flags,
|
|
_In_ UCHAR Level);
|
|
|
|
#ifdef __cplusplus
|
|
} // extern "C"
|
|
#endif
|
|
|
|
#endif // #ifndef WPP_ALREADY_INCLUDED
|
|
|
|
// template control.tpl
|
|
|
|
//
|
|
// Defines a set of macro that expand control model specified
|
|
// with WPP_CONTROL_GUIDS (example shown below)
|
|
// into an enum of trace levels and required structures that
|
|
// contain the mask of levels, logger handle and some information
|
|
// required for registration.
|
|
//
|
|
|
|
#ifndef WPP_ALREADY_INCLUDED
|
|
|
|
#define WPP_EVAL(x) x
|
|
#define WPP_STR(x) #x
|
|
#define WPP_STRINGIZE(x) WPP_STR(x)
|
|
#define WPP_GLUE(a, b) a ## b
|
|
#define WPP_GLUE3(a, b, c) a ## b ## c
|
|
#define WPP_GLUE4(a, b, c, d) a ## b ## c ## d
|
|
#define WPP_XGLUE(a, b) WPP_GLUE(a, b)
|
|
#define WPP_XGLUE3(a, b, c) WPP_GLUE3(a, b, c)
|
|
#define WPP_XGLUE4(a, b, c, d) WPP_GLUE4(a, b, c, d)
|
|
|
|
///////////////////////////////////////////////////////////////////////////////////
|
|
//
|
|
// #define WPP_CONTROL_GUIDS \
|
|
// WPP_DEFINE_CONTROL_GUID(Regular,(81b20fea,73a8,4b62,95bc,354477c97a6f), \
|
|
// WPP_DEFINE_BIT(Error) \
|
|
// WPP_DEFINE_BIT(Unusual) \
|
|
// WPP_DEFINE_BIT(Noise) \
|
|
// ) \
|
|
// WPP_DEFINE_CONTROL_GUID(HiFreq,(91b20fea,73a8,4b62,95bc,354477c97a6f), \
|
|
// WPP_DEFINE_BIT(Entry) \
|
|
// WPP_DEFINE_BIT(Exit) \
|
|
// WPP_DEFINE_BIT(ApiCalls) \
|
|
// WPP_DEFINE_BIT(RandomJunk) \
|
|
// WPP_DEFINE_BIT(LovePoem) \
|
|
// )
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
#ifndef WPP_NO_CONTROL_GUIDS
|
|
|
|
#ifdef WPP_DEFAULT_CONTROL_GUID
|
|
# ifdef WPP_CONTROL_GUIDS
|
|
# error WPP_DEFAULT_CONTROL_GUID cannot be used together with WPP_CONTROL_GUIDS.
|
|
# else // WPP_CONTROL_GUIDS
|
|
# define WPP_CONTROL_GUIDS \
|
|
WPP_DEFINE_CONTROL_GUID(Default,(WPP_DEFAULT_CONTROL_GUID), \
|
|
WPP_DEFINE_BIT(Error) \
|
|
WPP_DEFINE_BIT(Unusual) \
|
|
WPP_DEFINE_BIT(Noise) \
|
|
)
|
|
# endif // WPP_CONTROL_GUIDS
|
|
#endif // WPP_DEFAULT_CONTROL_GUID
|
|
|
|
#ifndef WPP_CONTROL_GUIDS
|
|
# pragma message(__FILE__ " : error : Please define control model via WPP_CONTROL_GUIDS or WPP_DEFAULT_CONTROL_GUID macros")
|
|
# pragma message(__FILE__ " : error : don't forget to call WPP_INIT_TRACING and WPP_CLEANUP in your main, DriverEntry or DllInit")
|
|
# pragma message(__FILE__ " : error : see tracewpp.doc for further information")
|
|
# error WPP_CONTROL_GUIDS not defined.
|
|
#endif // WPP_CONTROL_GUIDS
|
|
// a set of macro to convert a guid in a form x(81b20fea,73a8,4b62,95bc,354477c97a6f)
|
|
// into either a a struct or text string
|
|
|
|
#define _WPPW(x) WPP_GLUE(L, x)
|
|
|
|
#define WPP_GUID_NORM(l,w1,w2,w3,ll) l ## w1 ## w2 ## w3 ## ll
|
|
#define WPP_GUID_TEXT(l,w1,w2,w3,ll) #l "-" #w1 "-" #w2 "-" #w3 "-" #ll
|
|
#define WPP_GUID_WTEXT(l,w1,w2,w3,ll) _WPPW(#l) L"-" _WPPW(#w1) L"-" _WPPW(#w2) L"-" _WPPW(#w3) L"-" _WPPW(#ll)
|
|
#define WPP_EXTRACT_BYTE(val,n) (((ULONGLONG)(0x ## val) >> (8 * n)) & 0xFF)
|
|
#define WPP_GUID_STRUCT(l,w1,w2,w3,ll) {0x ## l, 0x ## w1, 0x ## w2,\
|
|
{WPP_EXTRACT_BYTE(w3, 1), WPP_EXTRACT_BYTE(w3, 0),\
|
|
WPP_EXTRACT_BYTE(ll, 5), WPP_EXTRACT_BYTE(ll, 4),\
|
|
WPP_EXTRACT_BYTE(ll, 3), WPP_EXTRACT_BYTE(ll, 2),\
|
|
WPP_EXTRACT_BYTE(ll, 1), WPP_EXTRACT_BYTE(ll, 0)} }
|
|
|
|
#ifndef WPP_FORCEINLINE
|
|
#define WPP_FORCEINLINE __forceinline
|
|
#endif
|
|
|
|
// define an enum of control block names
|
|
//////
|
|
#define WPP_DEFINE_CONTROL_GUID(Name,Guid,Bits) WPP_XGLUE(WPP_CTL_, WPP_EVAL(Name)),
|
|
enum WPP_CTL_NAMES { WPP_CONTROL_GUIDS WPP_LAST_CTL};
|
|
#undef WPP_DEFINE_CONTROL_GUID
|
|
|
|
// define control guids
|
|
//////
|
|
#define WPP_DEFINE_CONTROL_GUID(Name,Guid,Bits) \
|
|
extern __declspec(selectany) const GUID WPP_XGLUE4(WPP_, ThisDir, _CTLGUID_, WPP_EVAL(Name)) = WPP_GUID_STRUCT Guid;
|
|
WPP_CONTROL_GUIDS
|
|
#undef WPP_DEFINE_CONTROL_GUID
|
|
|
|
// define enums of individual bits
|
|
/////
|
|
#define WPP_DEFINE_CONTROL_GUID(Name,Guid,Bits) \
|
|
WPP_XGLUE(WPP_BLOCK_START_, WPP_EVAL(Name)) = WPP_XGLUE(WPP_CTL_, WPP_EVAL(Name)) * 0x10000, Bits WPP_XGLUE(WPP_BLOCK_END_, WPP_EVAL(Name)),
|
|
# define WPP_DEFINE_BIT(Name) WPP_BIT_ ## Name,
|
|
enum WPP_DEFINE_BIT_NAMES { WPP_CONTROL_GUIDS };
|
|
# undef WPP_DEFINE_BIT
|
|
#undef WPP_DEFINE_CONTROL_GUID
|
|
|
|
#define WPP_MASK(CTL) (1 << ( ((CTL)-1) & 31 ))
|
|
#define WPP_FLAG_NO(CTL) ( (0xFFFF & ((CTL)-1) ) / 32)
|
|
#define WPP_CTRL_NO(CTL) ((CTL) >> 16)
|
|
|
|
// calculate how many DWORDs we need to get the required number of bits
|
|
// upper estimate. Sometimes will be off by one
|
|
#define WPP_DEFINE_CONTROL_GUID(Name,Guid,Bits) | WPP_XGLUE(WPP_BLOCK_END_, WPP_EVAL(Name))
|
|
enum _WPP_FLAG_LEN_ENUM { WPP_FLAG_LEN = 1 | ((0 WPP_CONTROL_GUIDS) & 0xFFFF) / 32 };
|
|
#undef WPP_DEFINE_CONTROL_GUID
|
|
|
|
//
|
|
// Check that maximum number of flags does not exceed 32
|
|
//
|
|
#ifndef C_ASSERT
|
|
#define C_ASSERT(e) typedef char __C_ASSERT__[(e)?1:-1]
|
|
#endif
|
|
|
|
#define MAX_NUMBER_OF_ETW_FLAGS 34 // 32 flags plus 2 separators
|
|
#define WPP_DEFINE_CONTROL_GUID(Name,Guid,Bits) && ((WPP_XGLUE(WPP_BLOCK_END_, WPP_EVAL(Name) & 0xFFFF)) < MAX_NUMBER_OF_ETW_FLAGS)
|
|
enum _WPP_FLAG_LEN_ENUM_MAX { WPP_MAX_FLAG_LEN_CHECK = (1 WPP_CONTROL_GUIDS) };
|
|
#undef WPP_DEFINE_CONTROL_GUID
|
|
|
|
#ifndef WPP_CB
|
|
#define WPP_CB WPP_GLOBAL_Control
|
|
#endif
|
|
#ifndef WPP_CB_TYPE
|
|
#define WPP_CB_TYPE WPP_PROJECT_CONTROL_BLOCK
|
|
#endif
|
|
|
|
#ifndef WPP_CHECK_INIT
|
|
#define WPP_CHECK_INIT (WPP_CB != (WPP_CB_TYPE*)&WPP_CB) &&
|
|
#endif
|
|
|
|
typedef union {
|
|
WPP_TRACE_CONTROL_BLOCK Control;
|
|
UCHAR ReserveSpace[ sizeof(WPP_TRACE_CONTROL_BLOCK) + sizeof(ULONG) * (WPP_FLAG_LEN - 1) ];
|
|
} WPP_CB_TYPE ;
|
|
|
|
|
|
extern __declspec(selectany) WPP_CB_TYPE *WPP_CB = (WPP_CB_TYPE*)&WPP_CB;
|
|
|
|
#if ENABLE_WPP_RECORDER
|
|
#ifndef WPP_RECORDER_CHECK_INIT
|
|
#define WPP_RECORDER_CHECK_INIT (WPP_RECORDER_INITIALIZED != (WPP_CB_TYPE*)&WPP_RECORDER_INITIALIZED) &&
|
|
#endif
|
|
// Global varaible used to track if WPP_RECORDER was initialized.
|
|
// It will be initialized on calling WPP_INIT_TRACING macro.
|
|
extern __declspec(selectany) WPP_CB_TYPE *WPP_RECORDER_INITIALIZED = (WPP_CB_TYPE*)&WPP_RECORDER_INITIALIZED;
|
|
#endif
|
|
|
|
#define WPP_CONTROL(CTL) (WPP_CB[WPP_CTRL_NO(CTL)].Control)
|
|
|
|
// Define the default WPP_LEVEL_LOGGER/WPP_LEVEL_ENABLED macros for the
|
|
// predefined DoTraceMessage(LEVEL) function.
|
|
#ifdef WPP_USE_TRACE_LEVELS
|
|
|
|
#ifndef WPP_LEVEL_LOGGER
|
|
#define WPP_LEVEL_LOGGER(lvl) (WPP_CONTROL(WPP_BIT_ ## DUMMY).Logger),
|
|
#endif
|
|
#ifndef WPP_LEVEL_ENABLED
|
|
#define WPP_LEVEL_ENABLED(lvl) (WPP_CONTROL(WPP_BIT_ ## DUMMY).Level >= lvl)
|
|
#endif
|
|
|
|
#else // WPP_USE_TRACE_LEVELS
|
|
|
|
// For historical reasons, the use of LEVEL means flags by default.
|
|
// This was a bad choice but very difficult to undo.
|
|
#ifndef WPP_LEVEL_LOGGER
|
|
# define WPP_LEVEL_LOGGER(CTL) (WPP_CONTROL(WPP_BIT_ ## CTL).Logger),
|
|
#endif
|
|
#ifndef WPP_LEVEL_ENABLED
|
|
# define WPP_LEVEL_ENABLED(CTL) (WPP_CONTROL(WPP_BIT_ ## CTL).Flags[WPP_FLAG_NO(WPP_BIT_ ## CTL)] & WPP_MASK(WPP_BIT_ ## CTL))
|
|
#endif
|
|
|
|
#endif // WPP_USE_TRACE_LEVELS
|
|
|
|
// Define default WPP_FLAG_LOGGER/WPP_FLAG_ENABLED macros for convenience in
|
|
// defining a function that takes a FLAG parameter e.g. DoTrace(FLAG).
|
|
#ifndef WPP_FLAG_LOGGER
|
|
# define WPP_FLAG_LOGGER(CTL) (WPP_CONTROL(WPP_BIT_ ## CTL).Logger),
|
|
#endif
|
|
#ifndef WPP_FLAG_ENABLED
|
|
# define WPP_FLAG_ENABLED(CTL) (WPP_CONTROL(WPP_BIT_ ## CTL).Flags[WPP_FLAG_NO(WPP_BIT_ ## CTL)] & WPP_MASK(WPP_BIT_ ## CTL))
|
|
#endif
|
|
|
|
#ifndef WPP_ENABLED
|
|
# define WPP_ENABLED() 1
|
|
#endif
|
|
#ifndef WPP_LOGGER
|
|
# define WPP_LOGGER() (WPP_CB[0].Control.Logger),
|
|
#endif
|
|
|
|
#endif // WPP_NO_CONTROL_GUIDS
|
|
|
|
#ifndef WPP_GET_LOGGER
|
|
# define WPP_GET_LOGGER Logger
|
|
#endif
|
|
|
|
#ifndef WPP_LOGGER_ARG
|
|
# define WPP_LOGGER_ARG TRACEHANDLE Logger,
|
|
#endif
|
|
|
|
#ifdef __cplusplus
|
|
} // extern "C"
|
|
#endif
|
|
|
|
#endif // WPP_ALREADY_INCLUDED
|
|
|
|
// template tracemacro.tpl
|
|
|
|
// This template expects:
|
|
// WPP_THIS_FILE defined (see header.tpl)
|
|
// WPP_LOGGER_ARG defined
|
|
// WPP_GET_LOGGER defined
|
|
// WPP_ENABLED() defined
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
#ifdef WPP_ALREADY_INCLUDED
|
|
|
|
#undef WPP_LOCAL_TraceGuids
|
|
#undef WPP_INVOKE_WPP_DEBUG
|
|
|
|
#else // WPP_ALREADY_INCLUDED
|
|
|
|
#ifndef NO_CHECK_FOR_NULL_STRING
|
|
#ifndef WPP_CHECK_FOR_NULL_STRING
|
|
#define WPP_CHECK_FOR_NULL_STRING
|
|
#endif
|
|
#endif // NO_CHECK_FOR_NULL_STRING
|
|
|
|
#define WPP_FLATTEN(...) __VA_ARGS__
|
|
#define WPP_GLUE5(a, b, c, d, e) a ## b ## c ## d ## e
|
|
#define WPP_XGLUE5(a, b, c, d, e) WPP_GLUE5(a, b, c, d, e)
|
|
#define WPP_(Id) WPP_XGLUE5(WPP_, Id, _, WPP_THIS_FILE, __LINE__)
|
|
|
|
#ifndef WPP_INLINE
|
|
#define WPP_INLINE DECLSPEC_NOINLINE __inline
|
|
#endif
|
|
|
|
#ifndef WPP_FORCEINLINE
|
|
#define WPP_FORCEINLINE __forceinline
|
|
#endif
|
|
|
|
#endif // WPP_ALREADY_INCLUDED
|
|
|
|
#ifdef WPP_NO_ANNOTATIONS
|
|
|
|
#define WPP_ANNOTATE(x)
|
|
|
|
#else // WPP_NO_ANNOTATIONS
|
|
|
|
#ifdef WPP_EMIT_FUNC_NAME
|
|
#define WPP_FUNC_NAME L" FUNC=" _WPPW(__FUNCTION__)
|
|
#else // WPP_EMIT_FUNC_NAME
|
|
#define WPP_FUNC_NAME
|
|
#endif // WPP_EMIT_FUNC_NAME
|
|
|
|
# define WPP_ANNOTATE(x) WPP_ANNOTATE_ ## x,
|
|
|
|
#endif // WPP_NO_ANNOTATIONS
|
|
|
|
#ifndef WPP_ALREADY_INCLUDED
|
|
|
|
#ifndef WPP_TRACE_OPTIONS
|
|
enum { WPP_TRACE_OPTIONS =
|
|
TRACE_MESSAGE_SEQUENCE |
|
|
TRACE_MESSAGE_GUID |
|
|
TRACE_MESSAGE_SYSTEMINFO |
|
|
TRACE_MESSAGE_TIMESTAMP };
|
|
#endif // WPP_TRACE_OPTIONS
|
|
|
|
#ifndef WPP_LOGPAIR_SEPARATOR
|
|
# define WPP_LOGPAIR_SEPARATOR ,
|
|
#endif
|
|
#ifndef WPP_LOGPAIR_SIZET
|
|
# define WPP_LOGPAIR_SIZET SIZE_T
|
|
#endif
|
|
#ifndef WPP_LOGPAIR
|
|
# define WPP_LOGPAIR(_Size, _Addr) (_Addr),((WPP_LOGPAIR_SIZET)(_Size))WPP_LOGPAIR_SEPARATOR
|
|
#endif
|
|
|
|
#define WPP_LOGTYPEVAL(_Type, _Value) WPP_LOGPAIR(sizeof(_Type), &(_Value))
|
|
#define WPP_LOGTYPEPTR(_Value) WPP_LOGPAIR(sizeof(*(_Value)), (_Value))
|
|
|
|
// Marshalling macros.
|
|
|
|
#ifndef WPP_LOGASTR
|
|
# ifdef WPP_CHECK_FOR_NULL_STRING
|
|
# define WPP_LOGASTR(_value) WPP_LOGPAIR( \
|
|
(_value) ? strlen(_value) + 1 : 5, \
|
|
(_value) ? (_value) : "NULL" )
|
|
# else // WPP_CHECK_FOR_NULL_STRING
|
|
# define WPP_LOGASTR(_value) WPP_LOGPAIR( \
|
|
strlen(_value) + 1, \
|
|
_value )
|
|
# endif // WPP_CHECK_FOR_NULL_STRING
|
|
#endif // WPP_LOGASTR
|
|
|
|
#ifndef WPP_LOGWSTR
|
|
# ifdef WPP_CHECK_FOR_NULL_STRING
|
|
# define WPP_LOGWSTR(_value) WPP_LOGPAIR( \
|
|
((_value) ? wcslen(_value) + 1 : 5) * sizeof(WCHAR), \
|
|
(_value) ? (_value) : L"NULL" )
|
|
# else // WPP_CHECK_FOR_NULL_STRING
|
|
# define WPP_LOGWSTR(_value) WPP_LOGPAIR( \
|
|
(wcslen(_value) + 1) * sizeof(WCHAR), \
|
|
_value )
|
|
# endif // WPP_CHECK_FOR_NULL_STRING
|
|
#endif // WPP_LOGWSTR
|
|
|
|
#ifndef WPP_LOGPGUID
|
|
# define WPP_LOGPGUID(_value) WPP_LOGPAIR( sizeof(GUID), (_value) )
|
|
#endif // WPP_LOGPGUID
|
|
|
|
#ifndef WPP_LOGPSID
|
|
# ifdef WPP_CHECK_FOR_NULL_STRING
|
|
# define WPP_LOGPSID(_value) WPP_LOGPAIR( \
|
|
(_value) && WPP_IsValidSid(_value) ? WPP_GetLengthSid(_value) : 5, \
|
|
(_value) && WPP_IsValidSid(_value) ? (_value) : (void const*)"NULL")
|
|
# else // WPP_CHECK_FOR_NULL_STRING
|
|
# define WPP_LOGPSID(_value) WPP_LOGPAIR( \
|
|
WPP_GetLengthSid(_value), \
|
|
(_value) )
|
|
#endif // WPP_CHECK_FOR_NULL_STRING
|
|
#endif // WPP_LOGPSID
|
|
|
|
#ifndef WPP_LOGCSTR
|
|
# define WPP_LOGCSTR(_x) \
|
|
WPP_LOGPAIR( sizeof(USHORT), &(_x).Length ) \
|
|
WPP_LOGPAIR( (USHORT)(_x).Length, (USHORT)(_x).Length ? (_x).Buffer : "" )
|
|
#endif // WPP_LOGCSTR
|
|
|
|
#ifndef WPP_LOGUSTR
|
|
# define WPP_LOGUSTR(_x) \
|
|
WPP_LOGPAIR( sizeof(USHORT), &(_x).Length ) \
|
|
WPP_LOGPAIR( (USHORT)(_x).Length, (USHORT)(_x).Length ? (_x).Buffer : L"" )
|
|
#endif // WPP_LOGUSTR
|
|
|
|
#ifndef WPP_LOGPUSTR
|
|
#ifdef WPP_CHECK_FOR_NULL_STRING
|
|
# define WPP_LOGPUSTR(_x) \
|
|
WPP_LOGPAIR( \
|
|
sizeof(USHORT), \
|
|
(_x) ? &(_x)->Length : (void const*)L"\x08" ) \
|
|
WPP_LOGPAIR( \
|
|
(_x) ? (USHORT)(_x)->Length : 0x08, \
|
|
(_x) && (USHORT)(_x)->Length ? (_x)->Buffer : L"NULL" )
|
|
#else // WPP_CHECK_FOR_NULL_STRING
|
|
# define WPP_LOGPUSTR(_x) WPP_LOGUSTR(*(_x))
|
|
#endif // WPP_CHECK_FOR_NULL_STRING
|
|
#endif // WPP_LOGPUSTR
|
|
|
|
#ifndef WPP_LOGPCSTR
|
|
#ifdef WPP_CHECK_FOR_NULL_STRING
|
|
# define WPP_LOGPCSTR(_x) \
|
|
WPP_LOGPAIR( \
|
|
sizeof(USHORT), \
|
|
(_x) ? &(_x)->Length : (void const*)L"\x04" ) \
|
|
WPP_LOGPAIR( \
|
|
(_x) ? (USHORT)(_x)->Length : 0x04, \
|
|
(_x) && (USHORT)(_x)->Length ? (_x)->Buffer : "NULL" )
|
|
#else // WPP_CHECK_FOR_NULL_STRING
|
|
# define WPP_LOGPCSTR(_x) WPP_LOGCSTR(*(_x))
|
|
#endif // WPP_CHECK_FOR_NULL_STRING
|
|
#endif // WPP_LOGPCSTR
|
|
|
|
#ifdef __cplusplus
|
|
|
|
#ifndef WPP_POINTER_TO_USHORT
|
|
struct WppPointerToUshort
|
|
{
|
|
USHORT m_val;
|
|
WPP_FORCEINLINE explicit WppPointerToUshort(USHORT val) : m_val(val) {}
|
|
WPP_FORCEINLINE USHORT const* get() const { return &m_val; }
|
|
};
|
|
#define WPP_POINTER_TO_USHORT(val) (WppPointerToUshort((val)).get())
|
|
#endif // WPP_POINTER_TO_USHORT
|
|
|
|
#ifndef WPP_LOGCPPSTR
|
|
#define WPP_LOGCPPSTR(_value) \
|
|
WPP_LOGPAIR( \
|
|
sizeof(USHORT), \
|
|
WPP_POINTER_TO_USHORT((USHORT)((_value).size()*sizeof(*(_value).c_str()))) ) \
|
|
WPP_LOGPAIR( \
|
|
(USHORT)((_value).size()*sizeof(*(_value).c_str())), \
|
|
(_value).c_str() )
|
|
#endif // WPP_LOGCPPSTR
|
|
|
|
#ifndef WPP_LOGCPPVEC
|
|
#define WPP_LOGCPPVEC(_value) \
|
|
WPP_LOGPAIR( \
|
|
sizeof(USHORT), \
|
|
WPP_POINTER_TO_USHORT((USHORT)((_value).size()*sizeof(*(_value).data()))) ) \
|
|
WPP_LOGPAIR( \
|
|
(USHORT)((_value).size()*sizeof(*(_value).data())), \
|
|
(_value).data() + ((_value).data() == NULL) )
|
|
#endif // WPP_LOGCPPVEC
|
|
|
|
#endif // __cplusplus
|
|
|
|
#ifndef WPP_BINARY_def
|
|
# define WPP_BINARY_def
|
|
typedef struct tagWPP_BINARY
|
|
{
|
|
_Field_size_bytes_(Length) void const* Buffer;
|
|
USHORT Length;
|
|
} WPP_BINARY;
|
|
#endif // WPP_BINARY_def
|
|
|
|
#ifndef WPP_BINARY_func
|
|
# define WPP_BINARY_func
|
|
WPP_FORCEINLINE WPP_BINARY
|
|
WppBinary(_In_reads_bytes_(Length) void const* Buffer, USHORT Length)
|
|
{
|
|
WPP_BINARY data;
|
|
data.Buffer = Buffer;
|
|
data.Length = Length;
|
|
return data;
|
|
}
|
|
#endif // WPP_BINARY_func
|
|
|
|
#endif // WPP_ALREADY_INCLUDED
|
|
|
|
#ifndef WPP_ENABLE_FLAG_BIT
|
|
#define WPP_ENABLE_FLAG_BIT(flag) (WPP_CB[((flag) >> 16)].Control).Flags[( (0xFFFF & ((flag)-1) ) / 32)] & (1 << ( ((flag)-1) & 31 ))
|
|
#endif
|
|
|
|
// WPP_LOG_ALWAYS:
|
|
// Called for each event: WPP_LOG_ALWAYS(EX, MSG, arg1, arg2, arg3...) Other()
|
|
// If defined, the definition needs to include a trailing comma or semicolon.
|
|
// In addition, you will need to define a WPP_EX_[args](args...) macro to
|
|
// extract any needed information from the other arguments (e.g. LEVEL).
|
|
#ifndef WPP_LOG_ALWAYS
|
|
#define WPP_LOG_ALWAYS(...)
|
|
#endif
|
|
|
|
// WPP_DEBUG:
|
|
// Called for each enabled event: WPP_DEBUG((MSG, arg1, arg2, arg3...)), Other()
|
|
// Potential definition: printf MsgArgs
|
|
// Definition should not include any trailing comma or semicolon.
|
|
#ifdef WPP_DEBUG
|
|
#define WPP_INVOKE_WPP_DEBUG(MsgArgs) WPP_DEBUG(MsgArgs)
|
|
#else // WPP_DEBUG
|
|
#define WPP_INVOKE_WPP_DEBUG(MsgArgs) (void)0
|
|
#endif // WPP_DEBUG
|
|
|
|
// Functions
|
|
#undef DoDebugTrace
|
|
#ifdef __INTELLISENSE__
|
|
#define DoDebugTrace(TRACELEVEL, MSG, ...) ((void)(MSG, ## __VA_ARGS__))
|
|
#else
|
|
#define DoDebugTrace WPP_(CALL)
|
|
#endif
|
|
#undef DoTraceMessage
|
|
#ifdef __INTELLISENSE__
|
|
#define DoTraceMessage(LEVEL, MSG, ...) ((void)(MSG, ## __VA_ARGS__))
|
|
#else
|
|
#define DoTraceMessage WPP_(CALL)
|
|
#endif
|
|
#undef Trace
|
|
#ifdef __INTELLISENSE__
|
|
#define Trace(LEVEL, MSG, ...) ((void)(MSG, ## __VA_ARGS__))
|
|
#else
|
|
#define Trace WPP_(CALL)
|
|
#endif
|
|
#undef TraceEvents
|
|
#ifdef __INTELLISENSE__
|
|
#define TraceEvents(LEVEL, FLAGS, MSG, ...) ((void)(MSG, ## __VA_ARGS__))
|
|
#else
|
|
#define TraceEvents WPP_(CALL)
|
|
#endif
|
|
|
|
#ifdef __cplusplus
|
|
} // extern "C"
|
|
#endif
|
|
|