Bitdefender Hypervisor Memory Introspection
hook_xcr.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2020 Bitdefender
3  * SPDX-License-Identifier: Apache-2.0
4  */
5 #ifndef _HOOK_XCR_H_
6 #define _HOOK_XCR_H_
7 
8 #include "introtypes.h"
9 
10 
18 typedef INTSTATUS
19 (*PFUNC_XcrWriteHookCallback)(
20  _In_opt_ void *Context,
21  _In_ DWORD Xcr,
22  _Out_ INTRO_ACTION *Action
23  );
24 
25 
29 typedef struct _XCR_HOOK_STATE
30 {
31  LIST_HEAD XcrHooksList;
32  INT64 HooksCount;
33 } XCR_HOOK_STATE, *PXCR_HOOK_STATE;
34 
35 
39 typedef struct _HOOK_XCR
40 {
41  LIST_ENTRY Link;
42  DWORD Flags;
43  DWORD Xcr;
44  BOOLEAN Disabled;
45  PFUNC_XcrWriteHookCallback Callback;
46  void *Context;
47 } HOOK_XCR, *PHOOK_XCR;
48 
49 
50 //
51 // XCR hooks related API
52 //
53 INTSTATUS
54 IntHookXcrSetHook(
55  _In_ DWORD Xcr,
56  _In_ DWORD Flags,
57  _In_ PFUNC_XcrWriteHookCallback Callback,
58  _In_opt_ void *Context,
59  _Out_opt_ HOOK_XCR **Hook
60  );
61 
62 INTSTATUS
63 IntHookXcrRemoveHook(
64  _In_ HOOK_XCR *Hook
65  );
66 
67 INTSTATUS
68 IntHookXcrCommit(
69  void
70  );
71 
72 INTSTATUS
73 IntHookXcrInit(
74  void
75  );
76 
77 INTSTATUS
78 IntHookXcrUninit(
79  void
80  );
81 
82 #endif // _HOOK_XCR_H_
IntHookXcrCommit
INTSTATUS IntHookXcrCommit(void)
Commit the extended control register hooks.
Definition: hook_xcr.c:169
_In_opt_
#define _In_opt_
Definition: intro_sal.h:16
BOOLEAN
_Bool BOOLEAN
Definition: intro_types.h:58
_Out_
#define _Out_
Definition: intro_sal.h:22
INT64
long long INT64
Definition: intro_types.h:45
_In_
#define _In_
Definition: intro_sal.h:21
XCR_HOOK_STATE
struct _XCR_HOOK_STATE XCR_HOOK_STATE
INTSTATUS
int INTSTATUS
The status data type.
Definition: introstatus.h:24
_XCR_HOOK_STATE
Definition: hook_xcr.h:29
IntHookXcrInit
INTSTATUS IntHookXcrInit(void)
Initialize the extended control registers hook state.
Definition: hook_xcr.c:207
IntHookXcrUninit
INTSTATUS IntHookXcrUninit(void)
Uninit the extended control register hooks state.
Definition: hook_xcr.c:230
_HOOK_XCR::Flags
DWORD Flags
Flags. Can be used by the caller.
Definition: hook_xcr.h:42
_HOOK_XCR::Disabled
BOOLEAN Disabled
If true, the hook has been removed/disabled.
Definition: hook_xcr.h:44
_Out_opt_
#define _Out_opt_
Definition: intro_sal.h:30
IntHookXcrRemoveHook
INTSTATUS IntHookXcrRemoveHook(HOOK_XCR *Hook)
Remove an extended control register hook.
Definition: hook_xcr.c:110
_HOOK_XCR::Context
void * Context
Optional context.
Definition: hook_xcr.h:46
_HOOK_XCR
Definition: hook_xcr.h:39
DWORD
uint32_t DWORD
Definition: intro_types.h:49
INTRO_ACTION
enum _INTRO_ACTION INTRO_ACTION
Event actions.
_HOOK_XCR::Callback
PFUNC_XcrWriteHookCallback Callback
Callback.
Definition: hook_xcr.h:45
PXCR_HOOK_STATE
struct _XCR_HOOK_STATE * PXCR_HOOK_STATE
IntHookXcrSetHook
INTSTATUS IntHookXcrSetHook(DWORD Xcr, DWORD Flags, PFUNC_XcrWriteHookCallback Callback, void *Context, HOOK_XCR **Hook)
Set an extended control register write hook.
Definition: hook_xcr.c:11
PHOOK_XCR
struct _HOOK_XCR * PHOOK_XCR
_XCR_HOOK_STATE::XcrHooksList
LIST_HEAD XcrHooksList
The list of XCR hooks.
Definition: hook_xcr.h:31
HOOK_XCR
struct _HOOK_XCR HOOK_XCR
_HOOK_XCR::Link
LIST_ENTRY Link
List entry element.
Definition: hook_xcr.h:41
_XCR_HOOK_STATE::HooksCount
INT64 HooksCount
Total number of XCR hooks.
Definition: hook_xcr.h:32
_HOOK_XCR::Xcr
DWORD Xcr
Intercepted XCR.
Definition: hook_xcr.h:43
PFUNC_XcrWriteHookCallback
INTSTATUS(* PFUNC_XcrWriteHookCallback)(void *Context, DWORD Xcr, INTRO_ACTION *Action)
Extended control register write callback.
Definition: hook_xcr.h:19
_LIST_ENTRY
Definition: introlists.h:16