Bitdefender Hypervisor Memory Introspection
hook_msr.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_MSR_H_
6 #define _HOOK_MSR_H_
7 
8 #include "introtypes.h"
9 
10 
22 typedef INTSTATUS
23 (*PFUNC_MsrReadWriteHookCallback)(
24  _In_ DWORD Msr,
25  _In_ DWORD Flags,
26  _Out_ INTRO_ACTION *Action,
27  _In_opt_ void *Context,
28  _In_opt_ QWORD OriginalValue,
29  _Inout_opt_ QWORD *NewValue
30  );
31 
32 
36 typedef struct _MSR_HOOK_STATE
37 {
38  LIST_HEAD MsrHooksList;
39  INT64 HooksCount;
40 } MSR_HOOK_STATE, *PMSR_HOOK_STATE;
41 
42 
46 typedef struct _HOOK_MSR
47 {
48  LIST_ENTRY Link;
49  DWORD Msr;
50  DWORD Flags;
51  BOOLEAN WasEnabled;
52  BOOLEAN Disabled;
53  PFUNC_MsrReadWriteHookCallback Callback;
54  void *Context;
55 } HOOK_MSR, *PHOOK_MSR;
56 
57 
58 //
59 // MSR hooks related API
60 //
61 INTSTATUS
62 IntHookMsrSetHook(
63  _In_ DWORD Msr,
64  _In_ DWORD Flags,
65  _In_ PFUNC_MsrReadWriteHookCallback Callback,
66  _In_opt_ void *Context,
67  _Out_opt_ void **Hook
68  );
69 
70 INTSTATUS
71 IntHookMsrRemoveHook(
72  _In_ HOOK_MSR *Hook
73  );
74 
75 INTSTATUS
76 IntHookMsrCommit(
77  void
78  );
79 
80 INTSTATUS
81 IntHookMsrInit(
82  void
83  );
84 
85 INTSTATUS
86 IntHookMsrUninit(
87  void
88  );
89 
90 #endif // _HOOK_MSR_H_
_In_opt_
#define _In_opt_
Definition: intro_sal.h:16
HOOK_MSR
struct _HOOK_MSR HOOK_MSR
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
_HOOK_MSR::Callback
PFUNC_MsrReadWriteHookCallback Callback
The callback.
Definition: hook_msr.h:53
IntHookMsrInit
INTSTATUS IntHookMsrInit(void)
Initialize the model specific registers hook state.
Definition: hook_msr.c:262
INTSTATUS
int INTSTATUS
The status data type.
Definition: introstatus.h:24
_HOOK_MSR::Link
LIST_ENTRY Link
List entry element.
Definition: hook_msr.h:48
_MSR_HOOK_STATE::HooksCount
INT64 HooksCount
Total number of MSR hooks.
Definition: hook_msr.h:39
_Inout_opt_
#define _Inout_opt_
Definition: intro_sal.h:31
_Out_opt_
#define _Out_opt_
Definition: intro_sal.h:30
_MSR_HOOK_STATE
Definition: hook_msr.h:36
QWORD
unsigned long long QWORD
Definition: intro_types.h:53
IntHookMsrRemoveHook
INTSTATUS IntHookMsrRemoveHook(HOOK_MSR *Hook)
Remove a model specific register hook.
Definition: hook_msr.c:138
_MSR_HOOK_STATE::MsrHooksList
LIST_HEAD MsrHooksList
The list of MSR hooks.
Definition: hook_msr.h:38
DWORD
uint32_t DWORD
Definition: intro_types.h:49
_HOOK_MSR::Msr
DWORD Msr
The hooked MSR.
Definition: hook_msr.h:49
_HOOK_MSR::WasEnabled
BOOLEAN WasEnabled
True if MSR exiting for this MSR was already enabled.
Definition: hook_msr.h:51
INTRO_ACTION
enum _INTRO_ACTION INTRO_ACTION
Event actions.
IntHookMsrSetHook
INTSTATUS IntHookMsrSetHook(DWORD Msr, DWORD Flags, PFUNC_MsrReadWriteHookCallback Callback, void *Context, void **Hook)
Set a model-specific register write hook.
Definition: hook_msr.c:11
PHOOK_MSR
struct _HOOK_MSR * PHOOK_MSR
IntHookMsrCommit
INTSTATUS IntHookMsrCommit(void)
Commit the model specific register hooks.
Definition: hook_msr.c:224
PFUNC_MsrReadWriteHookCallback
INTSTATUS(* PFUNC_MsrReadWriteHookCallback)(DWORD Msr, DWORD Flags, INTRO_ACTION *Action, void *Context, QWORD OriginalValue, QWORD *NewValue)
Model specific register access callback.
Definition: hook_msr.h:23
_HOOK_MSR::Disabled
BOOLEAN Disabled
True if this hook has been removed/disabled.
Definition: hook_msr.h:52
_HOOK_MSR
Definition: hook_msr.h:46
PMSR_HOOK_STATE
struct _MSR_HOOK_STATE * PMSR_HOOK_STATE
_HOOK_MSR::Flags
DWORD Flags
Access flags. See IG_MSR_HOOK_TYPE.
Definition: hook_msr.h:50
MSR_HOOK_STATE
struct _MSR_HOOK_STATE MSR_HOOK_STATE
IntHookMsrUninit
INTSTATUS IntHookMsrUninit(void)
Uninit the model specific register hooks state.
Definition: hook_msr.c:285
_HOOK_MSR::Context
void * Context
Optional context.
Definition: hook_msr.h:54
_LIST_ENTRY
Definition: introlists.h:16