| 1 | /* $Id: PATMA.h 742 2007-02-07 10:17:01Z vboxsync $ */
|
|---|
| 2 | /** @file
|
|---|
| 3 | * PATM macros & definitions (identical to PATMA.mac!!)
|
|---|
| 4 | */
|
|---|
| 5 |
|
|---|
| 6 | /*
|
|---|
| 7 | * Copyright (C) 2006 InnoTek Systemberatung GmbH
|
|---|
| 8 | *
|
|---|
| 9 | * This file is part of VirtualBox Open Source Edition (OSE), as
|
|---|
| 10 | * available from http://www.virtualbox.org. This file is free software;
|
|---|
| 11 | * you can redistribute it and/or modify it under the terms of the GNU
|
|---|
| 12 | * General Public License as published by the Free Software Foundation,
|
|---|
| 13 | * in version 2 as it comes in the "COPYING" file of the VirtualBox OSE
|
|---|
| 14 | * distribution. VirtualBox OSE is distributed in the hope that it will
|
|---|
| 15 | * be useful, but WITHOUT ANY WARRANTY of any kind.
|
|---|
| 16 | *
|
|---|
| 17 | * If you received this file as part of a commercial VirtualBox
|
|---|
| 18 | * distribution, then only the terms of your commercial VirtualBox
|
|---|
| 19 | * license agreement apply instead of the previous paragraph.
|
|---|
| 20 | */
|
|---|
| 21 |
|
|---|
| 22 | #ifndef __PATMA_H__
|
|---|
| 23 | #define __PATMA_H__
|
|---|
| 24 |
|
|---|
| 25 |
|
|---|
| 26 | #define PATM_VMFLAGS 0xF1ABCD00
|
|---|
| 27 | #ifdef VBOX_WITH_STATISTICS
|
|---|
| 28 | #define PATM_ALLPATCHCALLS 0xF1ABCD01
|
|---|
| 29 | #define PATM_PERPATCHCALLS 0xF1ABCD02
|
|---|
| 30 | #endif
|
|---|
| 31 | #define PATM_JUMPDELTA 0xF1ABCD03
|
|---|
| 32 | #ifdef VBOX_WITH_STATISTICS
|
|---|
| 33 | #define PATM_IRETEFLAGS 0xF1ABCD04
|
|---|
| 34 | #define PATM_IRETCS 0xF1ABCD05
|
|---|
| 35 | #define PATM_IRETEIP 0xF1ABCD06
|
|---|
| 36 | #endif
|
|---|
| 37 | #define PATM_FIXUP 0xF1ABCD07
|
|---|
| 38 | #define PATM_PENDINGACTION 0xF1ABCD08
|
|---|
| 39 | #define PATM_CPUID_STD_PTR 0xF1ABCD09
|
|---|
| 40 | #define PATM_CPUID_EXT_PTR 0xF1ABCD0a
|
|---|
| 41 | #define PATM_CPUID_DEF_PTR 0xF1ABCD0b
|
|---|
| 42 | #define PATM_STACKBASE 0xF1ABCD0c /** Stack to store our private patch return addesses */
|
|---|
| 43 | #define PATM_STACKBASE_GUEST 0xF1ABCD0d /** Stack to store guest return addresses */
|
|---|
| 44 | #define PATM_STACKPTR 0xF1ABCD0e
|
|---|
| 45 | #define PATM_PATCHBASE 0xF1ABCD0f
|
|---|
| 46 | #define PATM_INTERRUPTFLAG 0xF1ABCD10
|
|---|
| 47 | #define PATM_INHIBITIRQADDR 0xF1ABCD11
|
|---|
| 48 | #define PATM_VM_FORCEDACTIONS 0xF1ABCD12
|
|---|
| 49 | #define PATM_TEMP_EAX 0xF1ABCD13 /** Location for original EAX register */
|
|---|
| 50 | #define PATM_TEMP_ECX 0xF1ABCD14 /** Location for original ECX register */
|
|---|
| 51 | #define PATM_TEMP_EDI 0xF1ABCD15 /** Location for original EDI register */
|
|---|
| 52 | #define PATM_TEMP_EFLAGS 0xF1ABCD16 /** Location for original eflags */
|
|---|
| 53 | #define PATM_TEMP_RESTORE_FLAGS 0xF1ABCD17 /** Which registers to restore */
|
|---|
| 54 | #define PATM_CALL_PATCH_TARGET_ADDR 0xF1ABCD18
|
|---|
| 55 | #define PATM_CALL_RETURN_ADDR 0xF1ABCD19
|
|---|
| 56 |
|
|---|
| 57 | /* Anything larger doesn't require a fixup */
|
|---|
| 58 | #define PATM_NO_FIXUP 0xF1ABCE00
|
|---|
| 59 | #define PATM_CPUID_STD_MAX 0xF1ABCE00
|
|---|
| 60 | #define PATM_CPUID_EXT_MAX 0xF1ABCE01
|
|---|
| 61 | #define PATM_RETURNADDR 0xF1ABCE02
|
|---|
| 62 | #define PATM_PATCHNEXTBLOCK 0xF1ABCE03
|
|---|
| 63 | #define PATM_CALLTARGET 0xF1ABCE04 /** relative call target */
|
|---|
| 64 | #define PATM_NEXTINSTRADDR 0xF1ABCE05 /** absolute guest address of the next instruction */
|
|---|
| 65 | #define PATM_CURINSTRADDR 0xF1ABCE06 /** absolute guest address of the current instruction */
|
|---|
| 66 | #define PATM_LOOKUP_AND_CALL_FUNCTION 0xF1ABCE07 /** Relative address of global PATM lookup and call function. */
|
|---|
| 67 | #define PATM_RETURN_FUNCTION 0xF1ABCE08 /** Relative address of global PATM return function. */
|
|---|
| 68 | #define PATM_LOOKUP_AND_JUMP_FUNCTION 0xF1ABCE09 /** Relative address of global PATM lookup and jump function. */
|
|---|
| 69 | #define PATM_IRET_FUNCTION 0xF1ABCE0A /** Relative address of global PATM iret function. */
|
|---|
| 70 |
|
|---|
| 71 | // everything except IOPL, NT, IF, VM, VIF, VIP and RF
|
|---|
| 72 | #define PATM_FLAGS_MASK (X86_EFL_CF|X86_EFL_PF|X86_EFL_AF|X86_EFL_ZF|X86_EFL_SF|X86_EFL_TF|X86_EFL_DF|X86_EFL_OF|X86_EFL_AC|X86_EFL_ID)
|
|---|
| 73 |
|
|---|
| 74 | // currently only IF & IOPL
|
|---|
| 75 | #define PATM_VIRTUAL_FLAGS_MASK (X86_EFL_IF|X86_EFL_IOPL)
|
|---|
| 76 |
|
|---|
| 77 | /* PATM stack size (identical in PATMA.mac!!) */
|
|---|
| 78 | #define PATM_STACK_SIZE (PAGE_SIZE)
|
|---|
| 79 | #define PATM_STACK_TOTAL_SIZE (2*PATM_STACK_SIZE)
|
|---|
| 80 | #define PATM_MAX_STACK (PATM_STACK_SIZE/sizeof(RTGCPTR))
|
|---|
| 81 |
|
|---|
| 82 | /* Patch Manager pending actions (in GCSTATE). */
|
|---|
| 83 | #define PATM_ACTION_LOOKUP_ADDRESS 1
|
|---|
| 84 | #define PATM_ACTION_DISPATCH_PENDING_IRQ 2
|
|---|
| 85 | #define PATM_ACTION_PENDING_IRQ_AFTER_IRET 3
|
|---|
| 86 | #define PATM_ACTION_LOG_IF1 4
|
|---|
| 87 | #define PATM_ACTION_LOG_CLI 5
|
|---|
| 88 | #define PATM_ACTION_LOG_STI 6
|
|---|
| 89 | #define PATM_ACTION_LOG_POPF_IF1 7
|
|---|
| 90 | #define PATM_ACTION_LOG_POPF_IF0 8
|
|---|
| 91 | #define PATM_ACTION_LOG_PUSHF 9
|
|---|
| 92 | #define PATM_ACTION_LOG_IRET 10
|
|---|
| 93 | #define PATM_ACTION_LOG_RET 11
|
|---|
| 94 | #define PATM_ACTION_LOG_CALL 12
|
|---|
| 95 |
|
|---|
| 96 | /* Magic dword found in ecx for patm pending actions. */
|
|---|
| 97 | #define PATM_ACTION_MAGIC 0xABCD4321
|
|---|
| 98 |
|
|---|
| 99 | /** PATM_TEMP_RESTORE_FLAGS */
|
|---|
| 100 | #define PATM_RESTORE_EAX BIT(0)
|
|---|
| 101 | #define PATM_RESTORE_ECX BIT(1)
|
|---|
| 102 | #define PATM_RESTORE_EDI BIT(2)
|
|---|
| 103 |
|
|---|
| 104 | typedef struct
|
|---|
| 105 | {
|
|---|
| 106 | uint8_t *pFunction;
|
|---|
| 107 | uint32_t offJump;
|
|---|
| 108 | uint32_t offRelJump; //used only by loop/loopz/loopnz
|
|---|
| 109 | uint32_t offSizeOverride; //size override byte position
|
|---|
| 110 | uint32_t size;
|
|---|
| 111 | uint32_t nrRelocs;
|
|---|
| 112 | uint32_t uReloc[1];
|
|---|
| 113 | } PATCHASMRECORD, *PPATCHASMRECORD;
|
|---|
| 114 |
|
|---|
| 115 | /* For indirect calls/jump (identical in PATMA.h & PATMA.mac!) */
|
|---|
| 116 | /** @note MUST BE A POWER OF TWO! */
|
|---|
| 117 | /** @note direct calls have only one lookup slot (PATCHDIRECTJUMPTABLE_SIZE) */
|
|---|
| 118 | /** @note Some statistics reveal that:
|
|---|
| 119 | * - call: Windows XP boot -> max 16, 127 replacements
|
|---|
| 120 | * - call: Knoppix 3.7 boot -> max 9
|
|---|
| 121 | * - ret: Knoppix 5.0.1 boot -> max 16, 80000 replacements (3+ million hits)
|
|---|
| 122 | */
|
|---|
| 123 | #define PATM_MAX_JUMPTABLE_ENTRIES 16
|
|---|
| 124 | typedef struct
|
|---|
| 125 | {
|
|---|
| 126 | uint16_t nrSlots;
|
|---|
| 127 | uint16_t ulInsertPos;
|
|---|
| 128 | uint32_t cAddresses;
|
|---|
| 129 | struct
|
|---|
| 130 | {
|
|---|
| 131 | RTGCPTR pInstrGC;
|
|---|
| 132 | RTGCUINTPTR pRelPatchGC; /* relative to patch base */
|
|---|
| 133 | } Slot[1];
|
|---|
| 134 | } PATCHJUMPTABLE, *PPATCHJUMPTABLE;
|
|---|
| 135 |
|
|---|
| 136 |
|
|---|
| 137 | #ifdef __cplusplus
|
|---|
| 138 | extern "C"
|
|---|
| 139 | {
|
|---|
| 140 | #endif
|
|---|
| 141 |
|
|---|
| 142 | extern PATCHASMRECORD PATMCliRecord;
|
|---|
| 143 | extern PATCHASMRECORD PATMStiRecord;
|
|---|
| 144 | extern PATCHASMRECORD PATMPopf32Record;
|
|---|
| 145 | extern PATCHASMRECORD PATMPopf16Record;
|
|---|
| 146 | extern PATCHASMRECORD PATMPopf16Record_NoExit;
|
|---|
| 147 | extern PATCHASMRECORD PATMPopf32Record_NoExit;
|
|---|
| 148 | extern PATCHASMRECORD PATMPushf32Record;
|
|---|
| 149 | extern PATCHASMRECORD PATMPushf16Record;
|
|---|
| 150 | extern PATCHASMRECORD PATMIretRecord;
|
|---|
| 151 | extern PATCHASMRECORD PATMCpuidRecord;
|
|---|
| 152 | extern PATCHASMRECORD PATMLoopRecord;
|
|---|
| 153 | extern PATCHASMRECORD PATMLoopZRecord;
|
|---|
| 154 | extern PATCHASMRECORD PATMLoopNZRecord;
|
|---|
| 155 | extern PATCHASMRECORD PATMJEcxRecord;
|
|---|
| 156 | extern PATCHASMRECORD PATMIntEntryRecord;
|
|---|
| 157 | extern PATCHASMRECORD PATMIntEntryRecordErrorCode;
|
|---|
| 158 | extern PATCHASMRECORD PATMTrapEntryRecord;
|
|---|
| 159 | extern PATCHASMRECORD PATMTrapEntryRecordErrorCode;
|
|---|
| 160 | extern PATCHASMRECORD PATMPushCSRecord;
|
|---|
| 161 |
|
|---|
| 162 | extern PATCHASMRECORD PATMCheckIFRecord;
|
|---|
| 163 | extern PATCHASMRECORD PATMJumpToGuest_IF1Record;
|
|---|
| 164 |
|
|---|
| 165 | extern PATCHASMRECORD PATMCallRecord;
|
|---|
| 166 | extern PATCHASMRECORD PATMCallIndirectRecord;
|
|---|
| 167 | extern PATCHASMRECORD PATMRetRecord;
|
|---|
| 168 | extern PATCHASMRECORD PATMJumpIndirectRecord;
|
|---|
| 169 |
|
|---|
| 170 | extern PATCHASMRECORD PATMLookupAndCallRecord;
|
|---|
| 171 | extern PATCHASMRECORD PATMRetFunctionRecord;
|
|---|
| 172 | extern PATCHASMRECORD PATMLookupAndJumpRecord;
|
|---|
| 173 | extern PATCHASMRECORD PATMIretFunctionRecord;
|
|---|
| 174 |
|
|---|
| 175 | extern PATCHASMRECORD PATMStatsRecord;
|
|---|
| 176 |
|
|---|
| 177 | extern PATCHASMRECORD PATMSetPIFRecord;
|
|---|
| 178 | extern PATCHASMRECORD PATMClearPIFRecord;
|
|---|
| 179 |
|
|---|
| 180 | extern PATCHASMRECORD PATMSetInhibitIRQRecord;
|
|---|
| 181 | extern PATCHASMRECORD PATMClearInhibitIRQFaultIF0Record;
|
|---|
| 182 | extern PATCHASMRECORD PATMClearInhibitIRQContIF0Record;
|
|---|
| 183 |
|
|---|
| 184 | extern uint32_t PATMInterruptFlag;
|
|---|
| 185 | #ifdef __cplusplus
|
|---|
| 186 | }
|
|---|
| 187 | #endif
|
|---|
| 188 |
|
|---|
| 189 | #endif //__PATMA_H__
|
|---|
