PATM.cpp@ 2919

Last change on this file since 2919 was 2919, checked in by vboxsync, 17 years ago
Stricter checks for patch jumps. Do not check for page boundary crossing when a patch jump will not be installed.
Property svn:eol-style set to `native` Property svn:keywords set to `Id`
File size: 236.7 KB

Line
1	/* $Id: PATM.cpp 2919 2007-05-29 14:43:31Z vboxsync $ */
2	/** @file
3	* PATM - Dynamic Guest OS Patching Manager
4	*
5	* NOTE: Never ever reuse patch memory!!
6	*/
7
8	/*
9	* Copyright (C) 2006 InnoTek Systemberatung GmbH
10	*
11	* This file is part of VirtualBox Open Source Edition (OSE), as
12	* available from http://www.virtualbox.org. This file is free software;
13	* you can redistribute it and/or modify it under the terms of the GNU
14	* General Public License as published by the Free Software Foundation,
15	* in version 2 as it comes in the "COPYING" file of the VirtualBox OSE
16	* distribution. VirtualBox OSE is distributed in the hope that it will
17	* be useful, but WITHOUT ANY WARRANTY of any kind.
18	*
19	* If you received this file as part of a commercial VirtualBox
20	* distribution, then only the terms of your commercial VirtualBox
21	* license agreement apply instead of the previous paragraph.
22	*/
23
24	/*******************************************************************************
25	* Header Files *
26	*******************************************************************************/
27	#define LOG_GROUP LOG_GROUP_PATM
28	#include <VBox/patm.h>
29	#include <VBox/stam.h>
30	#include <VBox/pgm.h>
31	#include <VBox/cpum.h>
32	#include <VBox/cpumdis.h>
33	#include <VBox/iom.h>
34	#include <VBox/sup.h>
35	#include <VBox/mm.h>
36	#include <VBox/ssm.h>
37	#include <VBox/pdm.h>
38	#include <VBox/trpm.h>
39	#include <VBox/cfgm.h>
40	#include <VBox/param.h>
41	#include <VBox/selm.h>
42	#include <iprt/avl.h>
43	#include "PATMInternal.h"
44	#include "PATMPatch.h"
45	#include <VBox/vm.h>
46	#include <VBox/csam.h>
47
48	#include <VBox/dbg.h>
49	#include <VBox/err.h>
50	#include <VBox/log.h>
51	#include <iprt/assert.h>
52	#include <iprt/asm.h>
53	#include <VBox/dis.h>
54	#include <VBox/disopcode.h>
55
56	#include <iprt/string.h>
57	#include "PATMA.h"
58
59	//#define PATM_REMOVE_PATCH_ON_TOO_MANY_TRAPS
60	//#define PATM_DISABLE_ALL
61
62	/*******************************************************************************
63	* Internal Functions *
64	*******************************************************************************/
65
66	static int patmDisableUnusablePatch(PVM pVM, RTGCPTR pInstrGC, RTGCPTR pConflictAddr, PPATCHINFO pPatch);
67	static int patmActivateInt3Patch(PVM pVM, PPATCHINFO pPatch);
68	static int patmDeactivateInt3Patch(PVM pVM, PPATCHINFO pPatch);
69
70	#ifdef DEBUG // keep gcc quiet
71	static bool patmIsCommonIDTHandlerPatch(PVM pVM, RTGCPTR pInstrGC);
72	#endif
73	#ifdef VBOX_WITH_STATISTICS
74	static const char *PATMPatchType(PVM pVM, PPATCHINFO pPatch);
75	static void patmResetStat(PVM pVM, void *pvSample);
76	static void patmPrintStat(PVM pVM, void pvSample, char pszBuf, size_t cchBuf);
77	#endif
78
79	#define patmPatchHCPtr2PatchGCPtr(pVM, pHC) (pVM->patm.s.pPatchMemGC + (pHC - pVM->patm.s.pPatchMemHC))
80	#define patmPatchGCPtr2PatchHCPtr(pVM, pGC) (pVM->patm.s.pPatchMemHC + (pGC - pVM->patm.s.pPatchMemGC))
81
82	static int patmReinit(PVM pVM);
83	static DECLCALLBACK(int) RelocatePatches(PAVLOGCPTRNODECORE pNode, void *pParam);
84	static DECLCALLBACK(int) patmVirtPageHandler(PVM pVM, RTGCPTR GCPtr, void pvPtr, void pvBuf, size_t cbBuf, PGMACCESSTYPE enmAccessType, void *pvUser);
85
86	#ifdef VBOX_WITH_DEBUGGER
87	static DECLCALLBACK(int) DisableAllPatches(PAVLOGCPTRNODECORE pNode, void *pVM);
88	static DECLCALLBACK(int) patmr3CmdOn(PCDBGCCMD pCmd, PDBGCCMDHLP pCmdHlp, PVM pVM, PCDBGCVAR paArgs, unsigned cArgs, PDBGCVAR pResult);
89	static DECLCALLBACK(int) patmr3CmdOff(PCDBGCCMD pCmd, PDBGCCMDHLP pCmdHlp, PVM pVM, PCDBGCVAR paArgs, unsigned cArgs, PDBGCVAR pResult);
90
91	/** Command descriptors. */
92	static const DBGCCMD g_aCmds[] =
93	{
94	/* pszCmd, cArgsMin, cArgsMax, paArgDesc, cArgDescs, pResultDesc, fFlags, pfnHandler pszSyntax, ....pszDescription */
95	{ "patmon", 0, 0, NULL, 0, NULL, 0, patmr3CmdOn, "", "Enable patching." },
96	{ "patmoff", 0, 0, NULL, 0, NULL, 0, patmr3CmdOff, "", "Disable patching." },
97	};
98	#endif
99
100	/**
101	* Initializes the PATM.
102	*
103	* @returns VBox status code.
104	* @param pVM The VM to operate on.
105	*/
106	PATMR3DECL(int) PATMR3Init(PVM pVM)
107	{
108	int rc;
109
110	Log(("PATMR3Init: Patch record size %d\n", sizeof(PATCHINFO)));
111
112	AssertReleaseMsg(PATMInterruptFlag == (VM_FF_INTERRUPT_APIC \| VM_FF_INTERRUPT_PIC \| VM_FF_TIMER \| VM_FF_REQUEST), ("Interrupt flags out of sync!!\n"));
113
114	/* Allocate patch memory and GC patch state memory. */
115	pVM->patm.s.cbPatchMem = PATCH_MEMORY_SIZE;
116	/* Add another page in case the generated code is much larger than expected. */
117	/** @todo bad safety precaution */
118	rc = MMR3HyperAllocOnceNoRel(pVM, PATCH_MEMORY_SIZE + PAGE_SIZE + PATM_STACK_TOTAL_SIZE + PAGE_SIZE + PATM_STAT_MEMSIZE, PAGE_SIZE, MM_TAG_PATM, (void **)&pVM->patm.s.pPatchMemHC);
119	if (VBOX_FAILURE(rc))
120	{
121	Log(("MMR3HyperAlloc failed with %Vrc\n", rc));
122	return rc;
123	}
124	pVM->patm.s.pPatchMemGC = MMHyperHC2GC(pVM, pVM->patm.s.pPatchMemHC);
125
126	/* PATM stack page for call instruction execution. (2 parts: one for our private stack and one to store the original return address */
127	pVM->patm.s.pGCStackHC = (RTGCPTR *)(pVM->patm.s.pPatchMemHC + PATCH_MEMORY_SIZE + PAGE_SIZE);
128	pVM->patm.s.pGCStackGC = MMHyperHC2GC(pVM, pVM->patm.s.pGCStackHC);
129
130	/*
131	* Hypervisor memory for GC status data (read/write)
132	*
133	* Note1: This is non-critical data; if trashed by the guest, then it will only cause problems for itself
134	* Note2: This doesn't really belong here, but we need access to it for relocation purposes
135	*
136	*/
137	Assert(sizeof(PATMGCSTATE) < PAGE_SIZE); /** @note hardcoded dependencies on this exist. */
138	pVM->patm.s.pGCStateHC = (PPATMGCSTATE)((uint8_t *)pVM->patm.s.pGCStackHC + PATM_STACK_TOTAL_SIZE);
139	pVM->patm.s.pGCStateGC = MMHyperHC2GC(pVM, pVM->patm.s.pGCStateHC);
140
141	/* Hypervisor memory for patch statistics */
142	pVM->patm.s.pStatsHC = (PSTAMRATIOU32)((uint8_t *)pVM->patm.s.pGCStateHC + PAGE_SIZE);
143	pVM->patm.s.pStatsGC = MMHyperHC2GC(pVM, pVM->patm.s.pStatsHC);
144
145	/* Memory for patch lookup trees. */
146	rc = MMHyperAlloc(pVM, sizeof(pVM->patm.s.PatchLookupTreeHC), 0, MM_TAG_PATM, (void *)&pVM->patm.s.PatchLookupTreeHC);
147	AssertRCReturn(rc, rc);
148	pVM->patm.s.PatchLookupTreeGC = MMHyperHC2GC(pVM, pVM->patm.s.PatchLookupTreeHC);
149
150	#ifdef __AMD64__ /* see patmReinit(). */
151	/* Check CFGM option. */
152	rc = CFGMR3QueryBool(CFGMR3GetRoot(pVM), "PATMEnabled", &pVM->fPATMEnabled);
153	if (VBOX_FAILURE(rc))
154	# ifdef PATM_DISABLE_ALL
155	pVM->fPATMEnabled = false;
156	# else
157	pVM->fPATMEnabled = true;
158	# endif
159	#endif
160
161	rc = patmReinit(pVM);
162	AssertRC(rc);
163	if (VBOX_FAILURE(rc))
164	return rc;
165
166	/*
167	* Register save and load state notificators.
168	*/
169	rc = SSMR3RegisterInternal(pVM, "PATM", 0, PATM_SSM_VERSION, sizeof(pVM->patm.s) + PATCH_MEMORY_SIZE + PAGE_SIZE + PATM_STACK_TOTAL_SIZE + PAGE_SIZE,
170	NULL, patmr3Save, NULL,
171	NULL, patmr3Load, NULL);
172	if (VBOX_FAILURE(rc))
173	{
174	AssertRC(rc);
175	return rc;
176	}
177
178	#ifdef VBOX_WITH_DEBUGGER
179	/*
180	* Debugger commands.
181	*/
182	static bool fRegisteredCmds = false;
183	if (!fRegisteredCmds)
184	{
185	int rc = DBGCRegisterCommands(&g_aCmds[0], ELEMENTS(g_aCmds));
186	if (VBOX_SUCCESS(rc))
187	fRegisteredCmds = true;
188	}
189	#endif
190
191	#ifdef VBOX_WITH_STATISTICS
192	STAM_REG(pVM, &pVM->patm.s.StatNrOpcodeRead, STAMTYPE_COUNTER, "/PATM/OpcodeBytesRead", STAMUNIT_OCCURENCES, "The number of opcode bytes read by the recompiler.");
193	STAM_REG(pVM, &pVM->patm.s.StatPATMMemoryUsed,STAMTYPE_COUNTER, "/PATM/MemoryUsed", STAMUNIT_OCCURENCES, "The amount of hypervisor heap used for patches.");
194	STAM_REG(pVM, &pVM->patm.s.StatDisabled, STAMTYPE_COUNTER, "/PATM/Patch/Disabled", STAMUNIT_OCCURENCES, "Number of times patches were disabled.");
195	STAM_REG(pVM, &pVM->patm.s.StatEnabled, STAMTYPE_COUNTER, "/PATM/Patch/Enabled", STAMUNIT_OCCURENCES, "Number of times patches were enabled.");
196	STAM_REG(pVM, &pVM->patm.s.StatDirty, STAMTYPE_COUNTER, "/PATM/Patch/Dirty", STAMUNIT_OCCURENCES, "Number of times patches were marked dirty.");
197	STAM_REG(pVM, &pVM->patm.s.StatUnusable, STAMTYPE_COUNTER, "/PATM/Patch/Unusable", STAMUNIT_OCCURENCES, "Number of unusable patches (conflicts).");
198	STAM_REG(pVM, &pVM->patm.s.StatInstalled, STAMTYPE_COUNTER, "/PATM/Patch/Installed", STAMUNIT_OCCURENCES, "Number of installed patches.");
199	STAM_REG(pVM, &pVM->patm.s.StatInt3Callable, STAMTYPE_COUNTER, "/PATM/Patch/Int3Callable", STAMUNIT_OCCURENCES, "Number of cli patches turned into int3 patches.");
200
201	STAM_REG(pVM, &pVM->patm.s.StatInt3BlockRun, STAMTYPE_COUNTER, "/PATM/Patch/Run/Int3", STAMUNIT_OCCURENCES, "Number of times an int3 block patch was executed.");
202	STAMR3RegisterF(pVM, &pVM->patm.s.pGCStateHC->uPatchCalls, STAMTYPE_U32, STAMVISIBILITY_ALWAYS, STAMUNIT_OCCURENCES, NULL, "/PATM/Patch/Run/Normal");
203
204	STAM_REG(pVM, &pVM->patm.s.StatInstalledFunctionPatches, STAMTYPE_COUNTER, "/PATM/Patch/Installed/Function", STAMUNIT_OCCURENCES, "Number of installed function duplication patches.");
205	STAM_REG(pVM, &pVM->patm.s.StatInstalledTrampoline, STAMTYPE_COUNTER, "/PATM/Patch/Installed/Trampoline", STAMUNIT_OCCURENCES, "Number of installed trampoline patches.");
206	STAM_REG(pVM, &pVM->patm.s.StatInstalledJump, STAMTYPE_COUNTER, "/PATM/Patch/Installed/Jump", STAMUNIT_OCCURENCES, "Number of installed jump patches.");
207
208	STAM_REG(pVM, &pVM->patm.s.StatOverwritten, STAMTYPE_COUNTER, "/PATM/Patch/Overwritten", STAMUNIT_OCCURENCES, "Number of overwritten patches.");
209	STAM_REG(pVM, &pVM->patm.s.StatFixedConflicts,STAMTYPE_COUNTER, "/PATM/Patch/ConflictFixed", STAMUNIT_OCCURENCES, "Number of fixed conflicts.");
210	STAM_REG(pVM, &pVM->patm.s.StatFlushed, STAMTYPE_COUNTER, "/PATM/Patch/Flushed", STAMUNIT_OCCURENCES, "Number of flushes of pages with patch jumps.");
211	STAM_REG(pVM, &pVM->patm.s.StatMonitored, STAMTYPE_COUNTER, "/PATM/Patch/Monitored", STAMUNIT_OCCURENCES, "Number of patches in monitored patch pages.");
212	STAM_REG(pVM, &pVM->patm.s.StatPageBoundaryCrossed, STAMTYPE_COUNTER, "/PATM/Patch/BoundaryCross", STAMUNIT_OCCURENCES, "Number of refused patches due to patch jump crossing page boundary.");
213
214	STAM_REG(pVM, &pVM->patm.s.StatHandleTrap, STAMTYPE_PROFILE, "/PATM/HandleTrap", STAMUNIT_TICKS_PER_CALL, "Profiling of PATMR3HandleTrap");
215	STAM_REG(pVM, &pVM->patm.s.StatPushTrap, STAMTYPE_COUNTER, "/PATM/HandleTrap/PushWP", STAMUNIT_OCCURENCES, "Number of traps due to monitored stack pages.");
216
217	STAM_REG(pVM, &pVM->patm.s.StatSwitchBack, STAMTYPE_COUNTER, "/PATM/SwitchBack", STAMUNIT_OCCURENCES, "Switch back to original guest code when IF=1 & executing PATM instructions");
218	STAM_REG(pVM, &pVM->patm.s.StatSwitchBackFail,STAMTYPE_COUNTER, "/PATM/SwitchBackFail", STAMUNIT_OCCURENCES, "Failed switch back to original guest code when IF=1 & executing PATM instructions");
219
220	STAM_REG(pVM, &pVM->patm.s.StatDuplicateREQFailed, STAMTYPE_COUNTER, "/PATM/Function/DupREQ/Failed", STAMUNIT_OCCURENCES, "Nr of failed PATMR3DuplicateFunctionRequest calls");
221	STAM_REG(pVM, &pVM->patm.s.StatDuplicateREQSuccess, STAMTYPE_COUNTER, "/PATM/Function/DupREQ/Success", STAMUNIT_OCCURENCES, "Nr of successful PATMR3DuplicateFunctionRequest calls");
222	STAM_REG(pVM, &pVM->patm.s.StatDuplicateUseExisting,STAMTYPE_COUNTER, "/PATM/Function/DupREQ/UseExist", STAMUNIT_OCCURENCES, "Nr of successful PATMR3DuplicateFunctionRequest calls when using an existing patch");
223
224	STAM_REG(pVM, &pVM->patm.s.StatFunctionLookupInsert, STAMTYPE_COUNTER, "/PATM/Function/Lookup/Insert", STAMUNIT_OCCURENCES, "Nr of successful function address insertions");
225	STAM_REG(pVM, &pVM->patm.s.StatFunctionLookupReplace, STAMTYPE_COUNTER, "/PATM/Function/Lookup/Replace", STAMUNIT_OCCURENCES, "Nr of successful function address replacements");
226	STAM_REG(pVM, &pVM->patm.s.StatU32FunctionMaxSlotsUsed, STAMTYPE_U32_RESET,"/PATM/Function/Lookup/MaxSlots", STAMUNIT_OCCURENCES, "Maximum nr of lookup slots used in all call patches");
227
228	STAM_REG(pVM, &pVM->patm.s.StatFunctionFound, STAMTYPE_COUNTER, "/PATM/Function/Found", STAMUNIT_OCCURENCES, "Nr of successful function patch lookups in GC");
229	STAM_REG(pVM, &pVM->patm.s.StatFunctionNotFound, STAMTYPE_COUNTER, "/PATM/Function/NotFound", STAMUNIT_OCCURENCES, "Nr of failed function patch lookups in GC");
230
231	STAM_REG(pVM, &pVM->patm.s.StatPatchWrite, STAMTYPE_PROFILE, "/PATM/Write/Handle", STAMUNIT_TICKS_PER_CALL, "Profiling of PATMR3PatchWrite");
232	STAM_REG(pVM, &pVM->patm.s.StatPatchWriteDetect, STAMTYPE_PROFILE, "/PATM/Write/Detect", STAMUNIT_TICKS_PER_CALL, "Profiling of PATMIsWriteToPatchPage");
233	STAM_REG(pVM, &pVM->patm.s.StatPatchWriteInterpreted, STAMTYPE_COUNTER, "/PATM/Write/Interpreted/Success", STAMUNIT_OCCURENCES, "Nr of interpreted patch writes.");
234	STAM_REG(pVM, &pVM->patm.s.StatPatchWriteInterpretedFailed, STAMTYPE_COUNTER, "/PATM/Write/Interpreted/Failed", STAMUNIT_OCCURENCES, "Nr of failed interpreted patch writes.");
235
236	STAM_REG(pVM, &pVM->patm.s.StatPatchRefreshSuccess, STAMTYPE_COUNTER, "/PATM/Refresh/Success", STAMUNIT_OCCURENCES, "Successful patch refreshes");
237	STAM_REG(pVM, &pVM->patm.s.StatPatchRefreshFailed, STAMTYPE_COUNTER, "/PATM/Refresh/Failure", STAMUNIT_OCCURENCES, "Failed patch refreshes");
238
239	STAM_REG(pVM, &pVM->patm.s.StatPatchPageInserted, STAMTYPE_COUNTER, "/PATM/Page/Inserted", STAMUNIT_OCCURENCES, "Nr of inserted guest pages that were patched");
240	STAM_REG(pVM, &pVM->patm.s.StatPatchPageRemoved, STAMTYPE_COUNTER, "/PATM/Page/Removed", STAMUNIT_OCCURENCES, "Nr of removed guest pages that were patched");
241
242	STAM_REG(pVM, &pVM->patm.s.StatInstrDirty, STAMTYPE_COUNTER, "/PATM/Instr/Dirty/Detected", STAMUNIT_OCCURENCES, "Number of times instructions were marked dirty.");
243	STAM_REG(pVM, &pVM->patm.s.StatInstrDirtyGood, STAMTYPE_COUNTER, "/PATM/Instr/Dirty/Corrected", STAMUNIT_OCCURENCES, "Number of times instructions were marked dirty and corrected later on.");
244	STAM_REG(pVM, &pVM->patm.s.StatInstrDirtyBad, STAMTYPE_COUNTER, "/PATM/Instr/Dirty/Failed", STAMUNIT_OCCURENCES, "Number of times instructions were marked dirty and we were not able to correct them.");
245
246	STAM_REG(pVM, &pVM->patm.s.StatSysEnter, STAMTYPE_COUNTER, "/PATM/Emul/SysEnter", STAMUNIT_OCCURENCES, "Number of times sysenter was emulated.");
247	STAM_REG(pVM, &pVM->patm.s.StatSysExit, STAMTYPE_COUNTER, "/PATM/Emul/SysExit" , STAMUNIT_OCCURENCES, "Number of times sysexit was emulated.");
248	STAM_REG(pVM, &pVM->patm.s.StatEmulIret, STAMTYPE_COUNTER, "/PATM/Emul/Iret/Success", STAMUNIT_OCCURENCES, "Number of times iret was emulated.");
249	STAM_REG(pVM, &pVM->patm.s.StatEmulIretFailed, STAMTYPE_COUNTER, "/PATM/Emul/Iret/Failed", STAMUNIT_OCCURENCES, "Number of times iret was emulated.");
250
251	STAM_REG(pVM, &pVM->patm.s.StatGenRet, STAMTYPE_COUNTER, "/PATM/Gen/Ret" , STAMUNIT_OCCURENCES, "Number of generated ret instructions.");
252	STAM_REG(pVM, &pVM->patm.s.StatGenRetReused, STAMTYPE_COUNTER, "/PATM/Gen/RetReused" , STAMUNIT_OCCURENCES, "Number of reused ret instructions.");
253	STAM_REG(pVM, &pVM->patm.s.StatGenCall, STAMTYPE_COUNTER, "/PATM/Gen/Call", STAMUNIT_OCCURENCES, "Number of generated call instructions.");
254	STAM_REG(pVM, &pVM->patm.s.StatGenJump, STAMTYPE_COUNTER, "/PATM/Gen/Jmp" , STAMUNIT_OCCURENCES, "Number of generated indirect jump instructions.");
255	STAM_REG(pVM, &pVM->patm.s.StatGenPopf, STAMTYPE_COUNTER, "/PATM/Gen/Popf" , STAMUNIT_OCCURENCES, "Number of generated popf instructions.");
256
257	STAM_REG(pVM, &pVM->patm.s.StatCheckPendingIRQ, STAMTYPE_COUNTER, "/PATM/GC/CheckIRQ" , STAMUNIT_OCCURENCES, "Number of traps that ask to check for pending irqs.");
258	#endif /* VBOX_WITH_STATISTICS */
259
260	Log(("PATMCallRecord.size %d\n", PATMCallRecord.size));
261	Log(("PATMCallIndirectRecord.size %d\n", PATMCallIndirectRecord.size));
262	Log(("PATMRetRecord.size %d\n", PATMRetRecord.size));
263	Log(("PATMJumpIndirectRecord.size %d\n", PATMJumpIndirectRecord.size));
264	Log(("PATMPopf32Record.size %d\n", PATMPopf32Record.size));
265	Log(("PATMIretRecord.size %d\n", PATMIretRecord.size));
266	Log(("PATMStiRecord.size %d\n", PATMStiRecord.size));
267	Log(("PATMCheckIFRecord.size %d\n", PATMCheckIFRecord.size));
268
269	return rc;
270	}
271
272	/**
273	* Finalizes HMA page attributes.
274	*
275	* @returns VBox status code.
276	* @param pVM The VM handle.
277	*/
278	PATMR3DECL(int) PATMR3InitFinalize(PVM pVM)
279	{
280	/* The GC state, stack and statistics must be read/write for the guest (supervisor only of course). */
281	int rc = PGMMapSetPage(pVM, pVM->patm.s.pGCStateGC, PAGE_SIZE, X86_PTE_P \| X86_PTE_A \| X86_PTE_D \| X86_PTE_RW);
282	if (VBOX_FAILURE(rc))
283	Log(("PATMR3InitFinalize: PGMMapSetPage failed with %Vrc!!\n", rc));
284
285	rc = PGMMapSetPage(pVM, pVM->patm.s.pGCStackGC, PATM_STACK_TOTAL_SIZE, X86_PTE_P \| X86_PTE_A \| X86_PTE_D \| X86_PTE_RW);
286	if (VBOX_FAILURE(rc))
287	Log(("PATMR3InitFinalize: PGMMapSetPage failed with %Vrc!!\n", rc));
288
289	rc = PGMMapSetPage(pVM, pVM->patm.s.pStatsGC, PATM_STAT_MEMSIZE, X86_PTE_P \| X86_PTE_A \| X86_PTE_D \| X86_PTE_RW);
290	if (VBOX_FAILURE(rc))
291	Log(("PATMR3InitFinalize: PGMMapSetPage failed with %Vrc!!\n", rc));
292
293	return rc;
294	}
295
296	/**
297	* (Re)initializes PATM
298	*
299	* @param pVM The VM.
300	*/
301	static int patmReinit(PVM pVM)
302	{
303	int rc;
304
305	/*
306	* Assert alignment and sizes.
307	*/
308	AssertRelease(!(RT_OFFSETOF(VM, patm.s) & 31));
309	AssertRelease(sizeof(pVM->patm.s) <= sizeof(pVM->patm.padding));
310
311	/*
312	* Setup any fixed pointers and offsets.
313	*/
314	pVM->patm.s.offVM = RT_OFFSETOF(VM, patm);
315
316	#ifndef __AMD64__ /* would be nice if this was changed everywhere. was driving me crazy on AMD64. */
317	#ifndef PATM_DISABLE_ALL
318	pVM->fPATMEnabled = true;
319	#endif
320	#endif
321
322	Assert(pVM->patm.s.pGCStateHC);
323	memset(pVM->patm.s.pGCStateHC, 0, PAGE_SIZE);
324	AssertReleaseMsg(pVM->patm.s.pGCStateGC, ("Impossible! MMHyperHC2GC(%p) failed!\n", pVM->patm.s.pGCStateGC));
325	Log(("Patch memory allocated at %p - %VGv\n", pVM->patm.s.pPatchMemHC, pVM->patm.s.pPatchMemGC));
326	pVM->patm.s.pGCStateHC->uVMFlags = X86_EFL_IF;
327
328	Assert(pVM->patm.s.pGCStackHC);
329	memset(pVM->patm.s.pGCStackHC, 0, PAGE_SIZE);
330	AssertReleaseMsg(pVM->patm.s.pGCStackGC, ("Impossible! MMHyperHC2GC(%p) failed!\n", pVM->patm.s.pGCStackGC));
331	pVM->patm.s.pGCStateHC->Psp = PATM_STACK_SIZE;
332	pVM->patm.s.pGCStateHC->fPIF = 1; /* PATM Interrupt Flag */
333
334	Assert(pVM->patm.s.pStatsHC);
335	memset(pVM->patm.s.pStatsHC, 0, PATM_STAT_MEMSIZE);
336	AssertReleaseMsg(pVM->patm.s.pStatsGC, ("Impossible! MMHyperHC2GC(%p) failed!\n", pVM->patm.s.pStatsGC));
337
338	Assert(pVM->patm.s.pPatchMemHC);
339	Assert(pVM->patm.s.pPatchMemGC = MMHyperHC2GC(pVM, pVM->patm.s.pPatchMemHC));
340	memset(pVM->patm.s.pPatchMemHC, 0, PATCH_MEMORY_SIZE);
341	AssertReleaseMsg(pVM->patm.s.pPatchMemGC, ("Impossible! MMHyperHC2GC(%p) failed!\n", pVM->patm.s.pPatchMemHC));
342
343	/* Needed for future patching of sldt/sgdt/sidt/str etc. */
344	rc = CPUMR3QueryGuestCtxGCPtr(pVM, &pVM->patm.s.pCPUMCtxGC);
345	AssertRCReturn(rc, rc);
346
347	Assert(pVM->patm.s.PatchLookupTreeHC);
348	Assert(pVM->patm.s.PatchLookupTreeGC == MMHyperHC2GC(pVM, pVM->patm.s.PatchLookupTreeHC));
349
350	/*
351	* (Re)Initialize PATM structure
352	*/
353	Assert(!pVM->patm.s.PatchLookupTreeHC->PatchTree);
354	Assert(!pVM->patm.s.PatchLookupTreeHC->PatchTreeByPatchAddr);
355	Assert(!pVM->patm.s.PatchLookupTreeHC->PatchTreeByPage);
356	pVM->patm.s.offPatchMem = 16; /* don't start with zero here */
357	pVM->patm.s.uCurrentPatchIdx = 1; /* Index zero is a dummy */
358	pVM->patm.s.pvFaultMonitor = 0;
359	pVM->patm.s.deltaReloc = 0;
360
361	/* Lowest and highest patched instruction */
362	pVM->patm.s.pPatchedInstrGCLowest = ~0;
363	pVM->patm.s.pPatchedInstrGCHighest = 0;
364
365	pVM->patm.s.PatchLookupTreeHC->PatchTree = 0;
366	pVM->patm.s.PatchLookupTreeHC->PatchTreeByPatchAddr = 0;
367	pVM->patm.s.PatchLookupTreeHC->PatchTreeByPage = 0;
368
369	pVM->patm.s.pfnSysEnterPatchGC = 0;
370	pVM->patm.s.pfnSysEnterGC = 0;
371
372	pVM->patm.s.fOutOfMemory = false;
373
374	pVM->patm.s.pfnHelperCallGC = 0;
375
376	/* Generate all global functions to be used by future patches. */
377	/* We generate a fake patch in order to use the existing code for relocation. */
378	rc = MMHyperAlloc(pVM, sizeof(PATMPATCHREC), 0, MM_TAG_PATM_PATCH, (void **)&pVM->patm.s.pGlobalPatchRec);
379	if (VBOX_FAILURE(rc))
380	{
381	Log(("Out of memory!!!!\n"));
382	return VERR_NO_MEMORY;
383	}
384	pVM->patm.s.pGlobalPatchRec->patch.flags = PATMFL_GLOBAL_FUNCTIONS;
385	pVM->patm.s.pGlobalPatchRec->patch.uState = PATCH_ENABLED;
386	pVM->patm.s.pGlobalPatchRec->patch.pPatchBlockOffset = pVM->patm.s.offPatchMem;
387
388	rc = patmPatchGenGlobalFunctions(pVM, &pVM->patm.s.pGlobalPatchRec->patch);
389	AssertRC(rc);
390
391	/* Update free pointer in patch memory. */
392	pVM->patm.s.offPatchMem += pVM->patm.s.pGlobalPatchRec->patch.uCurPatchOffset;
393	/* Round to next 8 byte boundary. */
394	pVM->patm.s.offPatchMem = RT_ALIGN_32(pVM->patm.s.offPatchMem, 8);
395	return rc;
396	}
397
398
399	/**
400	* Applies relocations to data and code managed by this
401	* component. This function will be called at init and
402	* whenever the VMM need to relocate it self inside the GC.
403	*
404	* The PATM will update the addresses used by the switcher.
405	*
406	* @param pVM The VM.
407	*/
408	PATMR3DECL(void) PATMR3Relocate(PVM pVM)
409	{
410	RTGCPTR GCPtrNew = MMHyperHC2GC(pVM, pVM->patm.s.pGCStateHC);
411	RTGCINTPTR delta = GCPtrNew - pVM->patm.s.pGCStateGC;
412
413	Log(("PATMR3Relocate from %VGv to %VGv - delta %08X\n", pVM->patm.s.pGCStateGC, GCPtrNew, delta));
414	if (delta)
415	{
416	PCPUMCTX pCtx;
417	int rc;
418
419	/* Update CPUMCTX guest context pointer. */
420	pVM->patm.s.pCPUMCtxGC += delta;
421
422	pVM->patm.s.deltaReloc = delta;
423
424	RTAvloGCPtrDoWithAll(&pVM->patm.s.PatchLookupTreeHC->PatchTree, true, RelocatePatches, (void *)pVM);
425
426	rc = CPUMQueryGuestCtxPtr(pVM, &pCtx);
427	AssertRC(rc);
428
429	/* If we are running patch code right now, then also adjust EIP. */
430	if (PATMIsPatchGCAddr(pVM, pCtx->eip))
431	pCtx->eip += delta;
432
433	pVM->patm.s.pGCStateGC = GCPtrNew;
434	pVM->patm.s.pPatchMemGC = MMHyperHC2GC(pVM, pVM->patm.s.pPatchMemHC);
435
436	pVM->patm.s.pGCStackGC = MMHyperHC2GC(pVM, pVM->patm.s.pGCStackHC);
437
438	pVM->patm.s.pStatsGC = MMHyperHC2GC(pVM, pVM->patm.s.pStatsHC);
439
440	pVM->patm.s.PatchLookupTreeGC = MMHyperHC2GC(pVM, pVM->patm.s.PatchLookupTreeHC);
441
442	if (pVM->patm.s.pfnSysEnterPatchGC)
443	pVM->patm.s.pfnSysEnterPatchGC += delta;
444
445	/* Deal with the global patch functions. */
446	pVM->patm.s.pfnHelperCallGC += delta;
447	pVM->patm.s.pfnHelperRetGC += delta;
448	pVM->patm.s.pfnHelperIretGC += delta;
449	pVM->patm.s.pfnHelperJumpGC += delta;
450
451	RelocatePatches(&pVM->patm.s.pGlobalPatchRec->Core, (void *)pVM);
452	}
453	}
454
455
456	/**
457	* Terminates the PATM.
458	*
459	* Termination means cleaning up and freeing all resources,
460	* the VM it self is at this point powered off or suspended.
461	*
462	* @returns VBox status code.
463	* @param pVM The VM to operate on.
464	*/
465	PATMR3DECL(int) PATMR3Term(PVM pVM)
466	{
467	/* Memory was all allocated from the two MM heaps and requires no freeing. */
468	return VINF_SUCCESS;
469	}
470
471
472	/**
473	* PATM reset callback.
474	*
475	* @returns VBox status code.
476	* @param pVM The VM which is reset.
477	*/
478	PATMR3DECL(int) PATMR3Reset(PVM pVM)
479	{
480	Log(("PATMR3Reset\n"));
481
482	/* Free all patches. */
483	while (true)
484	{
485	PPATMPATCHREC pPatchRec = (PPATMPATCHREC)RTAvloGCPtrRemoveBestFit(&pVM->patm.s.PatchLookupTreeHC->PatchTree, 0, true);
486	if (pPatchRec)
487	{
488	PATMRemovePatch(pVM, pPatchRec, true);
489	}
490	else
491	break;
492	}
493	Assert(!pVM->patm.s.PatchLookupTreeHC->PatchTreeByPage);
494	Assert(!pVM->patm.s.PatchLookupTreeHC->PatchTree);
495	pVM->patm.s.PatchLookupTreeHC->PatchTreeByPatchAddr = 0;
496	pVM->patm.s.PatchLookupTreeHC->PatchTreeByPage = 0;
497
498	int rc = patmReinit(pVM);
499	if (VBOX_SUCCESS(rc))
500	rc = PATMR3InitFinalize(pVM); /* paranoia */
501
502	return rc;
503	}
504
505	/**
506	* Read callback for disassembly function; supports reading bytes that cross a page boundary
507	*
508	* @returns VBox status code.
509	* @param pSrc GC source pointer
510	* @param pDest HC destination pointer
511	* @param size Number of bytes to read
512	* @param dwUserdata Callback specific user data (pCpu)
513	*
514	*/
515	int32_t patmReadBytes(RTHCUINTPTR pSrc, uint8_t *pDest, uint32_t size, RTHCUINTPTR dwUserdata)
516	{
517	DISCPUSTATE pCpu = (DISCPUSTATE )dwUserdata;
518	PATMDISASM pDisInfo = (PATMDISASM )pCpu->dwUserData[0];
519	int orgsize = size;
520
521	Assert(size);
522	if (size == 0)
523	return VERR_INVALID_PARAMETER;
524
525	/*
526	* Trap/interrupt handler typically call common code on entry. Which might already have patches inserted.
527	* As we currently don't support calling patch code from patch code, we'll let it read the original opcode bytes instead.
528	*/
529	/** @todo could change in the future! */
530	if (pDisInfo->fReadFlags & PATMREAD_ORGCODE)
531	{
532	for (int i=0;i<orgsize;i++)
533	{
534	int rc = PATMR3QueryOpcode(pDisInfo->pVM, (RTGCPTR)pSrc, pDest);
535	if (VBOX_SUCCESS(rc))
536	{
537	pSrc++;
538	pDest++;
539	size--;
540	}
541	else break;
542	}
543	if (size == 0)
544	return VINF_SUCCESS;
545	#ifdef VBOX_STRICT
546	if ( !(pDisInfo->pPatchInfo->flags & (PATMFL_DUPLICATE_FUNCTION\|PATMFL_IDTHANDLER))
547	&& !(pDisInfo->fReadFlags & PATMREAD_NOCHECK))
548	{
549	Assert(PATMR3IsInsidePatchJump(pDisInfo->pVM, pSrc, NULL) == false);
550	Assert(PATMR3IsInsidePatchJump(pDisInfo->pVM, pSrc+size-1, NULL) == false);
551	}
552	#endif
553	}
554
555
556	if (PAGE_ADDRESS(pDisInfo->pInstrGC) != PAGE_ADDRESS(pSrc + size - 1) && !PATMIsPatchGCAddr(pDisInfo->pVM, pSrc))
557	{
558	return PGMPhysReadGCPtr(pDisInfo->pVM, pDest, pSrc, size);
559	}
560	else
561	{
562	uint8_t *pInstrHC = pDisInfo->pInstrHC;
563
564	Assert(pInstrHC);
565
566	/* pInstrHC is the base address; adjust according to the GC pointer. */
567	pInstrHC = pInstrHC + (pSrc - pDisInfo->pInstrGC);
568
569	memcpy(pDest, (void *)pInstrHC, size);
570	}
571
572	return VINF_SUCCESS;
573	}
574
575	/**
576	* Callback function for RTAvloGCPtrDoWithAll
577	*
578	* Updates all fixups in the patches
579	*
580	* @returns VBox status code.
581	* @param pNode Current node
582	* @param pParam The VM to operate on.
583	*/
584	static DECLCALLBACK(int) RelocatePatches(PAVLOGCPTRNODECORE pNode, void *pParam)
585	{
586	PPATMPATCHREC pPatch = (PPATMPATCHREC)pNode;
587	PVM pVM = (PVM)pParam;
588	RTGCINTPTR delta;
589	#ifdef LOG_ENABLED
590	DISCPUSTATE cpu;
591	char szOutput[256];
592	uint32_t opsize;
593	bool disret;
594	#endif
595	int rc;
596
597	/* Nothing to do if the patch is not active. */
598	if (pPatch->patch.uState == PATCH_REFUSED)
599	return 0;
600
601	#ifdef LOG_ENABLED
602	if (pPatch->patch.flags & PATMFL_PATCHED_GUEST_CODE)
603	{
604	/** @note pPrivInstrHC is probably not valid anymore */
605	rc = PGMPhysGCPtr2HCPtr(pVM, pPatch->patch.pPrivInstrGC, (PRTHCPTR)&pPatch->patch.pPrivInstrHC);
606	if (rc == VINF_SUCCESS)
607	{
608	cpu.mode = (pPatch->patch.flags & PATMFL_CODE32) ? CPUMODE_32BIT : CPUMODE_16BIT;
609	disret = PATMR3DISInstr(pVM, &pPatch->patch, &cpu, pPatch->patch.pPrivInstrGC, pPatch->patch.pPrivInstrHC, &opsize, szOutput, PATMREAD_RAWCODE);
610	Log(("Org patch jump: %s", szOutput));
611	}
612	}
613	#endif
614
615	Log(("Nr of fixups %d\n", pPatch->patch.nrFixups));
616	delta = (RTGCINTPTR)pVM->patm.s.deltaReloc;
617
618	/*
619	* Apply fixups
620	*/
621	PRELOCREC pRec = 0;
622	AVLPVKEY key = 0;
623
624	while (true)
625	{
626	/* Get the record that's closest from above */
627	pRec = (PRELOCREC)RTAvlPVGetBestFit(&pPatch->patch.FixupTree, key, true);
628	if (pRec == 0)
629	break;
630
631	key = (AVLPVKEY)(pRec->pRelocPos + 1); /* search for the next record during the next round. */
632
633	switch (pRec->uType)
634	{
635	case FIXUP_ABSOLUTE:
636	Log(("Absolute fixup at %VGv %VHv -> %VHv at %VGv\n", pRec->pSource, (RTGCUINTPTR)pRec->pRelocPos, (RTGCINTPTR)pRec->pRelocPos + delta, pRec->pRelocPos));
637	if (!pRec->pSource \|\| PATMIsPatchGCAddr(pVM, pRec->pSource))
638	{
639	(RTGCUINTPTR )pRec->pRelocPos += delta;
640	}
641	else
642	{
643	uint8_t curInstr[15];
644	uint8_t oldInstr[15];
645	Assert(pRec->pSource && pPatch->patch.cbPrivInstr <= 15);
646
647	Assert(!(pPatch->patch.flags & PATMFL_GLOBAL_FUNCTIONS));
648
649	memcpy(oldInstr, pPatch->patch.aPrivInstr, pPatch->patch.cbPrivInstr);
650	(RTGCPTR )&oldInstr[pPatch->patch.cbPrivInstr - sizeof(RTGCPTR)] = pRec->pDest;
651
652	rc = PGMPhysReadGCPtr(pVM, curInstr, pPatch->patch.pPrivInstrGC, pPatch->patch.cbPrivInstr);
653	Assert(VBOX_SUCCESS(rc) \|\| rc == VERR_PAGE_NOT_PRESENT \|\| rc == VERR_PAGE_TABLE_NOT_PRESENT);
654
655	pRec->pDest = (RTGCPTR)((RTGCUINTPTR)pRec->pDest + delta);
656
657	if (rc == VERR_PAGE_NOT_PRESENT \|\| rc == VERR_PAGE_TABLE_NOT_PRESENT)
658	{
659	RTGCPTR pPage = pPatch->patch.pPrivInstrGC & PAGE_BASE_GC_MASK;
660
661	Log(("PATM: Patch page not present -> check later!\n"));
662	rc = PGMR3HandlerVirtualRegister(pVM, PGMVIRTHANDLERTYPE_ALL, pPage, pPage + (PAGE_SIZE - 1) /* inclusive! */, 0, patmVirtPageHandler, "PATMGCMonitorPage", 0, "PATMMonitorPatchJump");
663	Assert(VBOX_SUCCESS(rc) \|\| rc == VERR_PGM_HANDLER_VIRTUAL_CONFLICT);
664	}
665	else
666	if (memcmp(curInstr, oldInstr, pPatch->patch.cbPrivInstr))
667	{
668	Log(("PATM: Patch was overwritten -> disabling patch!!\n"));
669	/*
670	* Disable patch; this is not a good solution
671	*/
672	/* @todo hopefully it was completely overwritten (if the read was successful)!!!! */
673	pPatch->patch.uState = PATCH_DISABLED;
674	}
675	else
676	if (VBOX_SUCCESS(rc))
677	{
678	(RTGCPTR )&curInstr[pPatch->patch.cbPrivInstr - sizeof(RTGCPTR)] = pRec->pDest;
679	rc = PGMPhysWriteGCPtrDirty(pVM, pRec->pSource, curInstr, pPatch->patch.cbPrivInstr);
680	AssertRC(rc);
681	}
682	}
683	break;
684
685	case FIXUP_REL_JMPTOPATCH:
686	{
687	RTGCPTR pTarget = (RTGCPTR)((RTGCINTPTR)pRec->pDest + delta);
688
689	if ( pPatch->patch.uState == PATCH_ENABLED
690	&& (pPatch->patch.flags & PATMFL_PATCHED_GUEST_CODE))
691	{
692	uint8_t oldJump[SIZEOF_NEAR_COND_JUMP32];
693	uint8_t temp[SIZEOF_NEAR_COND_JUMP32];
694	RTGCPTR pJumpOffGC;
695	RTGCINTPTR displ = (RTGCINTPTR)pTarget - (RTGCINTPTR)pRec->pSource;
696	RTGCINTPTR displOld= (RTGCINTPTR)pRec->pDest - (RTGCINTPTR)pRec->pSource;
697
698	Log(("Relative fixup (g2p) %08X -> %08X at %08X (source=%08x, target=%08x)\n", (int32_t)pRec->pRelocPos, displ, pRec->pRelocPos, pRec->pSource, pRec->pDest));
699
700	Assert(pRec->pSource - pPatch->patch.cbPatchJump == pPatch->patch.pPrivInstrGC);
701	#ifdef PATM_RESOLVE_CONFLICTS_WITH_JUMP_PATCHES
702	if (pPatch->patch.cbPatchJump == SIZEOF_NEAR_COND_JUMP32)
703	{
704	Assert(pPatch->patch.flags & PATMFL_JUMP_CONFLICT);
705
706	pJumpOffGC = pPatch->patch.pPrivInstrGC + 2; //two byte opcode
707	oldJump[0] = pPatch->patch.aPrivInstr[0];
708	oldJump[1] = pPatch->patch.aPrivInstr[1];
709	(RTGCUINTPTR )&oldJump[2] = displOld;
710	}
711	else
712	#endif
713	if (pPatch->patch.cbPatchJump == SIZEOF_NEARJUMP32)
714	{
715	pJumpOffGC = pPatch->patch.pPrivInstrGC + 1; //one byte opcode
716	oldJump[0] = 0xE9;
717	(RTGCUINTPTR )&oldJump[1] = displOld;
718	}
719	else
720	{
721	AssertMsgFailed(("Invalid patch jump size %d\n", pPatch->patch.cbPatchJump));
722	continue; //this should never happen!!
723	}
724	Assert(pPatch->patch.cbPatchJump <= sizeof(temp));
725
726	/*
727	* Read old patch jump and compare it to the one we previously installed
728	*/
729	rc = PGMPhysReadGCPtr(pVM, temp, pPatch->patch.pPrivInstrGC, pPatch->patch.cbPatchJump);
730	Assert(VBOX_SUCCESS(rc) \|\| rc == VERR_PAGE_NOT_PRESENT \|\| rc == VERR_PAGE_TABLE_NOT_PRESENT);
731
732	if (rc == VERR_PAGE_NOT_PRESENT \|\| rc == VERR_PAGE_TABLE_NOT_PRESENT)
733	{
734	RTGCPTR pPage = pPatch->patch.pPrivInstrGC & PAGE_BASE_GC_MASK;
735
736	rc = PGMR3HandlerVirtualRegister(pVM, PGMVIRTHANDLERTYPE_ALL, pPage, pPage + (PAGE_SIZE - 1) /* inclusive! */, 0, patmVirtPageHandler, "PATMGCMonitorPage", 0, "PATMMonitorPatchJump");
737	Assert(VBOX_SUCCESS(rc) \|\| rc == VERR_PGM_HANDLER_VIRTUAL_CONFLICT);
738	}
739	else
740	if (memcmp(temp, oldJump, pPatch->patch.cbPatchJump))
741	{
742	Log(("PATM: Patch jump was overwritten -> disabling patch!!\n"));
743	/*
744	* Disable patch; this is not a good solution
745	*/
746	/* @todo hopefully it was completely overwritten (if the read was successful)!!!! */
747	pPatch->patch.uState = PATCH_DISABLED;
748	}
749	else
750	if (VBOX_SUCCESS(rc))
751	{
752	rc = PGMPhysWriteGCPtrDirty(pVM, pJumpOffGC, &displ, sizeof(displ));
753	AssertRC(rc);
754	}
755	else
756	{
757	AssertMsgFailed(("Unexpected error %d from MMR3PhysReadGCVirt\n", rc));
758	}
759	}
760	else
761	{
762	Log(("Skip the guest jump to patch code for this disabled patch %08X - %08X\n", pPatch->patch.pPrivInstrHC, pRec->pRelocPos));
763	}
764
765	pRec->pDest = pTarget;
766	break;
767	}
768
769	case FIXUP_REL_JMPTOGUEST:
770	{
771	RTGCPTR pSource = (RTGCPTR)((RTGCINTPTR)pRec->pSource + delta);
772	RTGCINTPTR displ = (RTGCINTPTR)pRec->pDest - (RTGCINTPTR)pSource;
773
774	Assert(!(pPatch->patch.flags & PATMFL_GLOBAL_FUNCTIONS));
775	Log(("Relative fixup (p2g) %08X -> %08X at %08X (source=%08x, target=%08x)\n", (int32_t)pRec->pRelocPos, displ, pRec->pRelocPos, pRec->pSource, pRec->pDest));
776	(RTGCUINTPTR )pRec->pRelocPos = displ;
777	pRec->pSource = pSource;
778	break;
779	}
780
781	default:
782	AssertMsg(0, ("Invalid fixup type!!\n"));
783	return VERR_INVALID_PARAMETER;
784	}
785	}
786
787	#ifdef LOG_ENABLED
788	if (pPatch->patch.flags & PATMFL_PATCHED_GUEST_CODE)
789	{
790	/** @note pPrivInstrHC is probably not valid anymore */
791	rc = PGMPhysGCPtr2HCPtr(pVM, pPatch->patch.pPrivInstrGC, (PRTHCPTR)&pPatch->patch.pPrivInstrHC);
792	if (rc == VINF_SUCCESS)
793	{
794	cpu.mode = (pPatch->patch.flags & PATMFL_CODE32) ? CPUMODE_32BIT : CPUMODE_16BIT;
795	disret = PATMR3DISInstr(pVM, &pPatch->patch, &cpu, pPatch->patch.pPrivInstrGC, pPatch->patch.pPrivInstrHC, &opsize, szOutput, PATMREAD_RAWCODE);
796	Log(("Rel patch jump: %s", szOutput));
797	}
798	}
799	#endif
800	return 0;
801	}
802
803	/**
804	* #PF Handler callback for virtual access handler ranges.
805	*
806	* Important to realize that a physical page in a range can have aliases, and
807	* for ALL and WRITE handlers these will also trigger.
808	*
809	* @returns VINF_SUCCESS if the handler have carried out the operation.
810	* @returns VINF_PGM_HANDLER_DO_DEFAULT if the caller should carry out the access operation.
811	* @param pVM VM Handle.
812	* @param GCPtr The virtual address the guest is writing to. (not correct if it's an alias!)
813	* @param pvPtr The HC mapping of that address.
814	* @param pvBuf What the guest is reading/writing.
815	* @param cbBuf How much it's reading/writing.
816	* @param enmAccessType The access type.
817	* @param pvUser User argument.
818	*/
819	static DECLCALLBACK(int) patmVirtPageHandler(PVM pVM, RTGCPTR GCPtr, void pvPtr, void pvBuf, size_t cbBuf, PGMACCESSTYPE enmAccessType, void *pvUser)
820	{
821	Assert(enmAccessType == PGMACCESSTYPE_WRITE);
822	/** @todo could be the wrong virtual address (alias) */
823	pVM->patm.s.pvFaultMonitor = GCPtr;
824	PATMR3HandleMonitoredPage(pVM);
825	return VINF_PGM_HANDLER_DO_DEFAULT;
826	}
827
828
829	#ifdef VBOX_WITH_DEBUGGER
830	/**
831	* Callback function for RTAvloGCPtrDoWithAll
832	*
833	* Enables the patch that's being enumerated
834	*
835	* @returns 0 (continue enumeration).
836	* @param pNode Current node
837	* @param pVM The VM to operate on.
838	*/
839	static DECLCALLBACK(int) EnableAllPatches(PAVLOGCPTRNODECORE pNode, void *pVM)
840	{
841	PPATMPATCHREC pPatch = (PPATMPATCHREC)pNode;
842
843	PATMR3EnablePatch((PVM)pVM, (RTGCPTR)pPatch->Core.Key);
844	return 0;
845	}
846	#endif /* VBOX_WITH_DEBUGGER */
847
848
849	#ifdef VBOX_WITH_DEBUGGER
850	/**
851	* Callback function for RTAvloGCPtrDoWithAll
852	*
853	* Disables the patch that's being enumerated
854	*
855	* @returns 0 (continue enumeration).
856	* @param pNode Current node
857	* @param pVM The VM to operate on.
858	*/
859	static DECLCALLBACK(int) DisableAllPatches(PAVLOGCPTRNODECORE pNode, void *pVM)
860	{
861	PPATMPATCHREC pPatch = (PPATMPATCHREC)pNode;
862
863	PATMR3DisablePatch((PVM)pVM, (RTGCPTR)pPatch->Core.Key);
864	return 0;
865	}
866	#endif
867
868	/**
869	* Returns the host context pointer and size of the patch memory block
870	*
871	* @returns VBox status code.
872	* @param pVM The VM to operate on.
873	* @param pcb Size of the patch memory block
874	*/
875	PATMR3DECL(void ) PATMR3QueryPatchMemHC(PVM pVM, uint32_t pcb)
876	{
877	if (pcb)
878	{
879	*pcb = pVM->patm.s.cbPatchMem;
880	}
881	return pVM->patm.s.pPatchMemHC;
882	}
883
884
885	/**
886	* Returns the guest context pointer and size of the patch memory block
887	*
888	* @returns VBox status code.
889	* @param pVM The VM to operate on.
890	* @param pcb Size of the patch memory block
891	*/
892	PATMR3DECL(RTGCPTR) PATMR3QueryPatchMemGC(PVM pVM, uint32_t *pcb)
893	{
894	if (pcb)
895	{
896	*pcb = pVM->patm.s.cbPatchMem;
897	}
898	return pVM->patm.s.pPatchMemGC;
899	}
900
901
902	/**
903	* Returns the host context pointer of the GC context structure
904	*
905	* @returns VBox status code.
906	* @param pVM The VM to operate on.
907	*/
908	PATMR3DECL(PPATMGCSTATE) PATMR3QueryGCStateHC(PVM pVM)
909	{
910	return pVM->patm.s.pGCStateHC;
911	}
912
913
914	/**
915	* Checks whether the HC address is part of our patch region
916	*
917	* @returns VBox status code.
918	* @param pVM The VM to operate on.
919	* @param pAddrGC Guest context address
920	*/
921	PATMR3DECL(bool) PATMR3IsPatchHCAddr(PVM pVM, HCPTRTYPE(uint8_t *) pAddrHC)
922	{
923	return (pAddrHC >= pVM->patm.s.pPatchMemHC && pAddrHC < pVM->patm.s.pPatchMemHC + pVM->patm.s.cbPatchMem) ? true : false;
924	}
925
926
927	/**
928	* Allows or disallow patching of privileged instructions executed by the guest OS
929	*
930	* @returns VBox status code.
931	* @param pVM The VM to operate on.
932	* @param fAllowPatching Allow/disallow patching
933	*/
934	PATMR3DECL(int) PATMR3AllowPatching(PVM pVM, uint32_t fAllowPatching)
935	{
936	pVM->fPATMEnabled = (fAllowPatching) ? true : false;
937	return VINF_SUCCESS;
938	}
939
940	/**
941	* Convert a GC patch block pointer to a HC patch pointer
942	*
943	* @returns HC pointer or NULL if it's not a GC patch pointer
944	* @param pVM The VM to operate on.
945	* @param pAddrGC GC pointer
946	*/
947	PATMR3DECL(HCPTRTYPE(void *)) PATMR3GCPtrToHCPtr(PVM pVM, RTGCPTR pAddrGC)
948	{
949	if (pVM->patm.s.pPatchMemGC <= pAddrGC && pVM->patm.s.pPatchMemGC + pVM->patm.s.cbPatchMem > pAddrGC)
950	{
951	return pVM->patm.s.pPatchMemHC + (pAddrGC - pVM->patm.s.pPatchMemGC);
952	}
953	return NULL;
954	}
955
956	/**
957	* Query PATM state (enabled/disabled)
958	*
959	* @returns 0 - disabled, 1 - enabled
960	* @param pVM The VM to operate on.
961	*/
962	PATMR3DECL(int) PATMR3IsEnabled(PVM pVM)
963	{
964	return pVM->fPATMEnabled;
965	}
966
967
968	/**
969	* Convert guest context address to host context pointer
970	*
971	* @returns VBox status code.
972	* @param pVM The VM to operate on.
973	* @param pPatch Patch block structure pointer
974	* @param pGCPtr Guest context pointer
975	*
976	* @returns Host context pointer or NULL in case of an error
977	*
978	*/
979	HCPTRTYPE(uint8_t ) PATMGCVirtToHCVirt(PVM pVM, PPATCHINFO pPatch, GCPTRTYPE(uint8_t )pGCPtr)
980	{
981	int rc;
982	HCPTRTYPE(uint8_t *)pHCPtr;
983	uint32_t offset;
984
985	if (PATMIsPatchGCAddr(pVM, pGCPtr))
986	{
987	return PATCHCODE_PTR_HC(pPatch) + (pGCPtr - PATCHCODE_PTR_GC(pPatch));
988	}
989
990	offset = pGCPtr & PAGE_OFFSET_MASK;
991	if (pPatch->cacheRec.pGuestLoc == (pGCPtr & PAGE_BASE_GC_MASK))
992	{
993	return pPatch->cacheRec.pPatchLocStartHC + offset;
994	}
995
996	rc = PGMPhysGCPtr2HCPtr(pVM, pGCPtr, (void **)&pHCPtr);
997	if (rc != VINF_SUCCESS)
998	{
999	AssertMsg(rc == VINF_SUCCESS \|\| rc == VERR_PAGE_NOT_PRESENT \|\| rc == VERR_PAGE_TABLE_NOT_PRESENT, ("MMR3PhysGCVirt2HCVirtEx failed for %08X\n", pGCPtr));
1000	return NULL;
1001	}
1002	////invalid? Assert(sizeof(HCPTRTYPE(uint8_t*)) == sizeof(uint32_t));
1003
1004	pPatch->cacheRec.pPatchLocStartHC = (HCPTRTYPE(uint8_t*))((RTHCUINTPTR)pHCPtr & PAGE_BASE_HC_MASK);
1005	pPatch->cacheRec.pGuestLoc = pGCPtr & PAGE_BASE_GC_MASK;
1006	return pHCPtr;
1007	}
1008
1009
1010	/* Calculates and fills in all branch targets
1011	*
1012	* @returns VBox status code.
1013	* @param pVM The VM to operate on.
1014	* @param pPatch Current patch block pointer
1015	*
1016	*/
1017	static int patmr3SetBranchTargets(PVM pVM, PPATCHINFO pPatch)
1018	{
1019	int32_t displ;
1020
1021	PJUMPREC pRec = 0;
1022	int nrJumpRecs = 0;
1023
1024	/*
1025	* Set all branch targets inside the patch block.
1026	* We remove all jump records as they are no longer needed afterwards.
1027	*/
1028	while (true)
1029	{
1030	GCPTRTYPE(uint8_t *)pInstrGC;
1031	GCPTRTYPE(uint8_t *)pBranchTargetGC = 0;
1032
1033	pRec = (PJUMPREC)RTAvlPVRemoveBestFit(&pPatch->JumpTree, 0, true);
1034	if (pRec == 0)
1035	break;
1036
1037	nrJumpRecs++;
1038
1039	/* HC in patch block to GC in patch block. */
1040	pInstrGC = patmPatchHCPtr2PatchGCPtr(pVM, pRec->pJumpHC);
1041
1042	if (pRec->opcode == OP_CALL)
1043	{
1044	/* Special case: call function replacement patch from this patch block.
1045	*/
1046	if (PATMQueryFunctionPatch(pVM, pRec->pTargetGC) == 0)
1047	{
1048	int rc;
1049
1050	if (PATMR3HasBeenPatched(pVM, pRec->pTargetGC) == false)
1051	rc = PATMR3InstallPatch(pVM, pRec->pTargetGC, PATMFL_CODE32 \| PATMFL_DUPLICATE_FUNCTION);
1052	else
1053	rc = VERR_PATCHING_REFUSED; /* exists as a normal patch; can't use it */
1054
1055	if (VBOX_FAILURE(rc))
1056	{
1057	uint8_t *pPatchHC;
1058	RTGCPTR pPatchGC;
1059	RTGCPTR pOrgInstrGC;
1060
1061	pOrgInstrGC = PATMR3PatchToGCPtr(pVM, pInstrGC, 0);
1062	Assert(pOrgInstrGC);
1063
1064	/* Failure for some reason -> mark exit point with int 3. */
1065	Log(("Failed to install function replacement patch (at %x) for reason %Vrc\n", pOrgInstrGC, rc));
1066
1067	pPatchGC = patmGuestGCPtrToPatchGCPtr(pVM, pPatch, pOrgInstrGC);
1068	Assert(pPatchGC);
1069
1070	pPatchHC = pVM->patm.s.pPatchMemHC + (pPatchGC - pVM->patm.s.pPatchMemGC);
1071
1072	/* Set a breakpoint at the very beginning of the recompiled instruction */
1073	*pPatchHC = 0xCC;
1074
1075	continue;
1076	}
1077	}
1078	pBranchTargetGC = PATMR3QueryPatchGCPtr(pVM, pRec->pTargetGC);
1079	}
1080	else
1081	{
1082	pBranchTargetGC = patmGuestGCPtrToPatchGCPtr(pVM, pPatch, pRec->pTargetGC);
1083	}
1084
1085	if (pBranchTargetGC == 0)
1086	{
1087	AssertMsgFailed(("patmr3SetBranchTargets: patmGuestGCPtrToPatchGCPtr failed for %08X\n", pRec->pTargetGC));
1088	return VERR_PATCHING_REFUSED;
1089	}
1090	/* Our jumps always have a dword displacement (to make things easier). */
1091	Assert(sizeof(uint32_t) == sizeof(RTGCPTR));
1092	displ = pBranchTargetGC - (pInstrGC + pRec->offDispl + sizeof(RTGCPTR));
1093	(RTGCPTR )(pRec->pJumpHC + pRec->offDispl) = displ;
1094	Log(("Set branch target %d to %08X : %08x - (%08x + %d + %d)\n", nrJumpRecs, displ, pBranchTargetGC, pInstrGC, pRec->offDispl, sizeof(RTGCPTR)));
1095	}
1096	Assert(nrJumpRecs == pPatch->nrJumpRecs);
1097	Assert(pPatch->JumpTree == 0);
1098	return VINF_SUCCESS;
1099	}
1100
1101	/* Add an illegal instruction record
1102	*
1103	* @param pVM The VM to operate on.
1104	* @param pPatch Patch structure ptr
1105	* @param pInstrGC Guest context pointer to privileged instruction
1106	*
1107	*/
1108	static void patmAddIllegalInstrRecord(PVM pVM, PPATCHINFO pPatch, RTGCPTR pInstrGC)
1109	{
1110	PAVLPVNODECORE pRec;
1111
1112	pRec = (PAVLPVNODECORE)MMR3HeapAllocZ(pVM, MM_TAG_PATM_PATCH, sizeof(*pRec));
1113	Assert(pRec);
1114	pRec->Key = (AVLPVKEY)pInstrGC;
1115
1116	bool ret = RTAvlPVInsert(&pPatch->pTempInfo->IllegalInstrTree, pRec);
1117	Assert(ret); NOREF(ret);
1118	pPatch->pTempInfo->nrIllegalInstr++;
1119	}
1120
1121	static bool patmIsIllegalInstr(PPATCHINFO pPatch, RTGCPTR pInstrGC)
1122	{
1123	PAVLPVNODECORE pRec;
1124
1125	pRec = RTAvlPVGet(&pPatch->pTempInfo->IllegalInstrTree, (AVLPVKEY)pInstrGC);
1126	if (pRec)
1127	return true;
1128	return false;
1129	}
1130
1131	/**
1132	* Add a patch to guest lookup record
1133	*
1134	* @param pVM The VM to operate on.
1135	* @param pPatch Patch structure ptr
1136	* @param pPatchInstrHC Guest context pointer to patch block
1137	* @param pInstrGC Guest context pointer to privileged instruction
1138	* @param enmType Lookup type
1139	* @param fDirty Dirty flag
1140	*
1141	*/
1142	/** @note Be extremely careful with this function. Make absolutely sure the guest address is correct! (to avoid executing instructions twice!) */
1143	void patmr3AddP2GLookupRecord(PVM pVM, PPATCHINFO pPatch, uint8_t *pPatchInstrHC, RTGCPTR pInstrGC, PATM_LOOKUP_TYPE enmType, bool fDirty)
1144	{
1145	bool ret;
1146	PRECPATCHTOGUEST pPatchToGuestRec;
1147	PRECGUESTTOPATCH pGuestToPatchRec;
1148	uint32_t PatchOffset = pPatchInstrHC - pVM->patm.s.pPatchMemHC; /* Offset in memory reserved for PATM. */
1149
1150	if (enmType == PATM_LOOKUP_PATCH2GUEST)
1151	{
1152	pPatchToGuestRec = (PRECPATCHTOGUEST)RTAvlU32Get(&pPatch->Patch2GuestAddrTree, PatchOffset);
1153	if (pPatchToGuestRec && pPatchToGuestRec->Core.Key == PatchOffset)
1154	return; /* already there */
1155
1156	Assert(!pPatchToGuestRec);
1157	}
1158	#ifdef VBOX_STRICT
1159	else
1160	{
1161	pPatchToGuestRec = (PRECPATCHTOGUEST)RTAvlU32Get(&pPatch->Patch2GuestAddrTree, PatchOffset);
1162	Assert(!pPatchToGuestRec);
1163	}
1164	#endif
1165
1166	pPatchToGuestRec = (PRECPATCHTOGUEST)MMR3HeapAllocZ(pVM, MM_TAG_PATM_PATCH, sizeof(RECPATCHTOGUEST) + sizeof(RECGUESTTOPATCH));
1167	Assert(pPatchToGuestRec);
1168	pPatchToGuestRec->Core.Key = PatchOffset;
1169	pPatchToGuestRec->pOrgInstrGC = pInstrGC;
1170	pPatchToGuestRec->enmType = enmType;
1171	pPatchToGuestRec->fDirty = fDirty;
1172
1173	ret = RTAvlU32Insert(&pPatch->Patch2GuestAddrTree, &pPatchToGuestRec->Core);
1174	Assert(ret);
1175
1176	/* GC to patch address */
1177	if (enmType == PATM_LOOKUP_BOTHDIR)
1178	{
1179	pGuestToPatchRec = (PRECGUESTTOPATCH)RTAvlGCPtrGet(&pPatch->Guest2PatchAddrTree, pInstrGC);
1180	if (!pGuestToPatchRec)
1181	{
1182	pGuestToPatchRec = (PRECGUESTTOPATCH)(pPatchToGuestRec+1);
1183	pGuestToPatchRec->Core.Key = pInstrGC;
1184	pGuestToPatchRec->PatchOffset = PatchOffset;
1185
1186	ret = RTAvlGCPtrInsert(&pPatch->Guest2PatchAddrTree, &pGuestToPatchRec->Core);
1187	Assert(ret);
1188	}
1189	}
1190
1191	pPatch->nrPatch2GuestRecs++;
1192	}
1193
1194
1195	/**
1196	* Removes a patch to guest lookup record
1197	*
1198	* @param pVM The VM to operate on.
1199	* @param pPatch Patch structure ptr
1200	* @param pPatchInstrGC Guest context pointer to patch block
1201	*/
1202	void patmr3RemoveP2GLookupRecord(PVM pVM, PPATCHINFO pPatch, RTGCPTR pPatchInstrGC)
1203	{
1204	PAVLU32NODECORE pNode;
1205	PAVLGCPTRNODECORE pNode2;
1206	PRECPATCHTOGUEST pPatchToGuestRec;
1207	uint32_t PatchOffset = pPatchInstrGC - pVM->patm.s.pPatchMemGC; /* Offset in memory reserved for PATM. */
1208
1209	pPatchToGuestRec = (PRECPATCHTOGUEST)RTAvlU32Get(&pPatch->Patch2GuestAddrTree, PatchOffset);
1210	Assert(pPatchToGuestRec);
1211	if (pPatchToGuestRec)
1212	{
1213	if (pPatchToGuestRec->enmType == PATM_LOOKUP_BOTHDIR)
1214	{
1215	PRECGUESTTOPATCH pGuestToPatchRec = (PRECGUESTTOPATCH)(pPatchToGuestRec+1);
1216
1217	Assert(pGuestToPatchRec->Core.Key);
1218	pNode2 = RTAvlGCPtrRemove(&pPatch->Guest2PatchAddrTree, pGuestToPatchRec->Core.Key);
1219	Assert(pNode2);
1220	}
1221	pNode = RTAvlU32Remove(&pPatch->Patch2GuestAddrTree, pPatchToGuestRec->Core.Key);
1222	Assert(pNode);
1223
1224	MMR3HeapFree(pPatchToGuestRec);
1225	pPatch->nrPatch2GuestRecs--;
1226	}
1227	}
1228
1229
1230	/**
1231	* RTAvlPVDestroy callback.
1232	*/
1233	static DECLCALLBACK(int) patmEmptyTreePVCallback(PAVLPVNODECORE pNode, void *)
1234	{
1235	MMR3HeapFree(pNode);
1236	return 0;
1237	}
1238
1239	/**
1240	* Empty the specified tree (PV tree, MMR3 heap)
1241	*
1242	* @param pVM The VM to operate on.
1243	* @param ppTree Tree to empty
1244	*/
1245	void patmEmptyTree(PVM pVM, PAVLPVNODECORE *ppTree)
1246	{
1247	RTAvlPVDestroy(ppTree, patmEmptyTreePVCallback, NULL);
1248	}
1249
1250
1251	/**
1252	* RTAvlU32Destroy callback.
1253	*/
1254	static DECLCALLBACK(int) patmEmptyTreeU32Callback(PAVLU32NODECORE pNode, void *)
1255	{
1256	MMR3HeapFree(pNode);
1257	return 0;
1258	}
1259
1260	/**
1261	* Empty the specified tree (U32 tree, MMR3 heap)
1262	*
1263	* @param pVM The VM to operate on.
1264	* @param ppTree Tree to empty
1265	*/
1266	void patmEmptyTreeU32(PVM pVM, PPAVLU32NODECORE ppTree)
1267	{
1268	RTAvlU32Destroy(ppTree, patmEmptyTreeU32Callback, NULL);
1269	}
1270
1271
1272	/**
1273	* Analyses the instructions following the cli for compliance with our heuristics for cli & pushf
1274	*
1275	* @returns VBox status code.
1276	* @param pVM The VM to operate on.
1277	* @param pCpu CPU disassembly state
1278	* @param pInstrGC Guest context pointer to privileged instruction
1279	* @param pCurInstrGC Guest context pointer to the current instruction
1280	* @param pUserData User pointer (callback specific)
1281	*
1282	*/
1283	static int patmAnalyseBlockCallback(PVM pVM, DISCPUSTATE pCpu, GCPTRTYPE(uint8_t ) pInstrGC, GCPTRTYPE(uint8_t ) pCurInstrGC, void pUserData)
1284	{
1285	PPATCHINFO pPatch = (PPATCHINFO)pUserData;
1286	bool fIllegalInstr = false;
1287
1288	//Preliminary heuristics:
1289	//- no call instructions without a fixed displacement between cli and sti/popf
1290	//- no jumps in the instructions following cli (4+ bytes; enough for the replacement jump (5 bytes))
1291	//- no nested pushf/cli
1292	//- sti/popf should be the (eventual) target of all branches
1293	//- no near or far returns; no int xx, no into
1294	//
1295	// Note: Later on we can impose less stricter guidelines if the need arises
1296
1297	/* Bail out if the patch gets too big. */
1298	if (pPatch->cbPatchBlockSize >= MAX_PATCH_SIZE)
1299	{
1300	Log(("Code block too big (%x) for patch at %VGv!!\n", pPatch->cbPatchBlockSize, pCurInstrGC));
1301	fIllegalInstr = true;
1302	patmAddIllegalInstrRecord(pVM, pPatch, pCurInstrGC);
1303	}
1304	else
1305	{
1306	/* No unconditinal jumps or calls without fixed displacements. */
1307	if ( (pCpu->pCurInstr->optype & OPTYPE_CONTROLFLOW)
1308	&& (pCpu->pCurInstr->opcode == OP_JMP \|\| pCpu->pCurInstr->opcode == OP_CALL)
1309	)
1310	{
1311	Assert(pCpu->param1.size <= 4 \|\| pCpu->param1.size == 8);
1312	if ( pCpu->param1.size == 8 /* far call/jmp */
1313	\|\| (pCpu->pCurInstr->opcode == OP_CALL && !(pPatch->flags & PATMFL_SUPPORT_CALLS))
1314	\|\| (OP_PARM_VTYPE(pCpu->pCurInstr->param1) != OP_PARM_J && !(pPatch->flags & PATMFL_SUPPORT_INDIRECT_CALLS))
1315	)
1316	{
1317	fIllegalInstr = true;
1318	patmAddIllegalInstrRecord(pVM, pPatch, pCurInstrGC);
1319	}
1320	}
1321
1322	/* An unconditional (short) jump right after a cli is a potential problem; we will overwrite whichever function comes afterwards */
1323	if (pPatch->opcode == OP_CLI && pCpu->pCurInstr->opcode == OP_JMP)
1324	{
1325	if (pCurInstrGC > pPatch->pPrivInstrGC && pCurInstrGC + pCpu->opsize < pPatch->pPrivInstrGC + SIZEOF_NEARJUMP32) /* hardcoded patch jump size; cbPatchJump is still zero */
1326	{
1327	Log(("Dangerous unconditional jump ends in our generated patch jump!! (%x vs %x)\n", pCurInstrGC, pPatch->pPrivInstrGC));
1328	/* We turn this one into a int 3 callable patch. */
1329	pPatch->flags \|= PATMFL_INT3_REPLACEMENT_BLOCK;
1330	}
1331	}
1332	else
1333	/* no nested pushfs just yet; nested cli is allowed for cli patches though. */
1334	if (pPatch->opcode == OP_PUSHF)
1335	{
1336	if (pCurInstrGC != pInstrGC && pCpu->pCurInstr->opcode == OP_PUSHF)
1337	{
1338	fIllegalInstr = true;
1339	patmAddIllegalInstrRecord(pVM, pPatch, pCurInstrGC);
1340	}
1341	}
1342
1343	// no far returns
1344	if (pCpu->pCurInstr->opcode == OP_RETF)
1345	{
1346	pPatch->pTempInfo->nrRetInstr++;
1347	fIllegalInstr = true;
1348	patmAddIllegalInstrRecord(pVM, pPatch, pCurInstrGC);
1349	}
1350	else
1351	// no int xx or into either
1352	if (pCpu->pCurInstr->opcode == OP_INT3 \|\| pCpu->pCurInstr->opcode == OP_INT \|\| pCpu->pCurInstr->opcode == OP_INTO)
1353	{
1354	fIllegalInstr = true;
1355	patmAddIllegalInstrRecord(pVM, pPatch, pCurInstrGC);
1356	}
1357	}
1358
1359	pPatch->cbPatchBlockSize += pCpu->opsize;
1360
1361	/* Illegal instruction -> end of analysis phase for this code block */
1362	if (fIllegalInstr \|\| patmIsIllegalInstr(pPatch, pCurInstrGC))
1363	return VINF_SUCCESS;
1364
1365	/* Check for exit points. */
1366	switch (pCpu->pCurInstr->opcode)
1367	{
1368	case OP_SYSEXIT:
1369	return VINF_SUCCESS; /* duplicate it; will fault or emulated in GC. */
1370
1371	case OP_SYSENTER:
1372	case OP_ILLUD2:
1373	//This appears to be some kind of kernel panic in Linux 2.4; no point to analyse more
1374	Log(("Illegal opcode (0xf 0xb) -> return here\n"));
1375	return VINF_SUCCESS;
1376
1377	case OP_STI:
1378	case OP_POPF:
1379	Assert(!(pPatch->flags & (PATMFL_DUPLICATE_FUNCTION)));
1380	/* If out exit point lies within the generated patch jump, then we have to refuse!! */
1381	if (pCurInstrGC > pPatch->pPrivInstrGC && pCurInstrGC < pPatch->pPrivInstrGC + SIZEOF_NEARJUMP32) /* hardcoded patch jump size; cbPatchJump is still zero */
1382	{
1383	Log(("Exit point within patch jump itself!! (%x vs %x)\n", pCurInstrGC, pPatch->pPrivInstrGC));
1384	return VERR_PATCHING_REFUSED;
1385	}
1386	if (pPatch->opcode == OP_PUSHF)
1387	{
1388	if (pCpu->pCurInstr->opcode == OP_POPF)
1389	{
1390	if (pPatch->cbPatchBlockSize >= SIZEOF_NEARJUMP32)
1391	return VINF_SUCCESS;
1392
1393	/* Or else we need to duplicate more instructions, because we can't jump back yet! */
1394	Log(("WARNING: End of block reached, but we need to duplicate some extra instruction to avoid a conflict with the patch jump\n"));
1395	pPatch->flags \|= PATMFL_CHECK_SIZE;
1396	}
1397	break; //sti doesn't mark the end of a pushf block; only popf does
1398	}
1399	//else no break
1400	case OP_RETN: /* exit point for function replacement */
1401	return VINF_SUCCESS;
1402
1403	case OP_IRET:
1404	return VINF_SUCCESS; /* exitpoint */
1405
1406	case OP_CPUID:
1407	case OP_CALL:
1408	case OP_JMP:
1409	break;
1410
1411	default:
1412	if (pCpu->pCurInstr->optype & (OPTYPE_PRIVILEGED_NOTRAP))
1413	{
1414	patmAddIllegalInstrRecord(pVM, pPatch, pCurInstrGC);
1415	return VINF_SUCCESS; /* exit point */
1416	}
1417	break;
1418	}
1419
1420	// If single instruction patch, we've copied enough instructions and the current instruction is not a relative jump
1421	if ((pPatch->flags & PATMFL_CHECK_SIZE) && pPatch->cbPatchBlockSize > SIZEOF_NEARJUMP32 && !(pCpu->pCurInstr->optype & OPTYPE_RELATIVE_CONTROLFLOW))
1422	{
1423	// The end marker for this kind of patch is any instruction at a location outside our patch jump
1424	Log(("End of block at %VGv size %d\n", pCurInstrGC, pCpu->opsize));
1425	return VINF_SUCCESS;
1426	}
1427
1428	return VWRN_CONTINUE_ANALYSIS;
1429	}
1430
1431	/**
1432	* Analyses the instructions inside a function for compliance
1433	*
1434	* @returns VBox status code.
1435	* @param pVM The VM to operate on.
1436	* @param pCpu CPU disassembly state
1437	* @param pInstrGC Guest context pointer to privileged instruction
1438	* @param pCurInstrGC Guest context pointer to the current instruction
1439	* @param pUserData User pointer (callback specific)
1440	*
1441	*/
1442	static int patmAnalyseFunctionCallback(PVM pVM, DISCPUSTATE pCpu, GCPTRTYPE(uint8_t ) pInstrGC, GCPTRTYPE(uint8_t ) pCurInstrGC, void pUserData)
1443	{
1444	PPATCHINFO pPatch = (PPATCHINFO)pUserData;
1445	bool fIllegalInstr = false;
1446
1447	//Preliminary heuristics:
1448	//- no call instructions
1449	//- ret ends a block
1450
1451	Assert(pPatch->flags & (PATMFL_DUPLICATE_FUNCTION));
1452
1453	// bail out if the patch gets too big
1454	if (pPatch->cbPatchBlockSize >= MAX_PATCH_SIZE)
1455	{
1456	Log(("Code block too big (%x) for function patch at %VGv!!\n", pPatch->cbPatchBlockSize, pCurInstrGC));
1457	fIllegalInstr = true;
1458	patmAddIllegalInstrRecord(pVM, pPatch, pCurInstrGC);
1459	}
1460	else
1461	{
1462	// no unconditinal jumps or calls without fixed displacements
1463	if ( (pCpu->pCurInstr->optype & OPTYPE_CONTROLFLOW)
1464	&& (pCpu->pCurInstr->opcode == OP_JMP \|\| pCpu->pCurInstr->opcode == OP_CALL)
1465	)
1466	{
1467	Assert(pCpu->param1.size <= 4 \|\| pCpu->param1.size == 8);
1468	if ( pCpu->param1.size == 8 /* far call/jmp */
1469	\|\| (pCpu->pCurInstr->opcode == OP_CALL && !(pPatch->flags & PATMFL_SUPPORT_CALLS))
1470	\|\| (OP_PARM_VTYPE(pCpu->pCurInstr->param1) != OP_PARM_J && !(pPatch->flags & PATMFL_SUPPORT_INDIRECT_CALLS))
1471	)
1472	{
1473	fIllegalInstr = true;
1474	patmAddIllegalInstrRecord(pVM, pPatch, pCurInstrGC);
1475	}
1476	}
1477	else /* no far returns */
1478	if (pCpu->pCurInstr->opcode == OP_RETF)
1479	{
1480	patmAddIllegalInstrRecord(pVM, pPatch, pCurInstrGC);
1481	fIllegalInstr = true;
1482	}
1483	else /* no int xx or into either */
1484	if (pCpu->pCurInstr->opcode == OP_INT3 \|\| pCpu->pCurInstr->opcode == OP_INT \|\| pCpu->pCurInstr->opcode == OP_INTO)
1485	{
1486	patmAddIllegalInstrRecord(pVM, pPatch, pCurInstrGC);
1487	fIllegalInstr = true;
1488	}
1489
1490	#if 0
1491	///@todo we can handle certain in/out and privileged instructions in the guest context
1492	if (pCpu->pCurInstr->optype & OPTYPE_PRIVILEGED && pCpu->pCurInstr->opcode != OP_STI)
1493	{
1494	Log(("Illegal instructions for function patch!!\n"));
1495	return VERR_PATCHING_REFUSED;
1496	}
1497	#endif
1498	}
1499
1500	pPatch->cbPatchBlockSize += pCpu->opsize;
1501
1502	/* Illegal instruction -> end of analysis phase for this code block */
1503	if (fIllegalInstr \|\| patmIsIllegalInstr(pPatch, pCurInstrGC))
1504	{
1505	return VINF_SUCCESS;
1506	}
1507
1508	// Check for exit points
1509	switch (pCpu->pCurInstr->opcode)
1510	{
1511	case OP_ILLUD2:
1512	//This appears to be some kind of kernel panic in Linux 2.4; no point to analyse more
1513	Log(("Illegal opcode (0xf 0xb) -> return here\n"));
1514	return VINF_SUCCESS;
1515
1516	case OP_IRET:
1517	case OP_SYSEXIT: /* will fault or emulated in GC */
1518	case OP_RETN:
1519	return VINF_SUCCESS;
1520
1521	case OP_POPF:
1522	case OP_STI:
1523	return VWRN_CONTINUE_ANALYSIS;
1524	default:
1525	if (pCpu->pCurInstr->optype & (OPTYPE_PRIVILEGED_NOTRAP))
1526	{
1527	patmAddIllegalInstrRecord(pVM, pPatch, pCurInstrGC);
1528	return VINF_SUCCESS; /* exit point */
1529	}
1530	return VWRN_CONTINUE_ANALYSIS;
1531	}
1532
1533	return VWRN_CONTINUE_ANALYSIS;
1534	}
1535
1536	/**
1537	* Recompiles the instructions in a code block
1538	*
1539	* @returns VBox status code.
1540	* @param pVM The VM to operate on.
1541	* @param pCpu CPU disassembly state
1542	* @param pInstrGC Guest context pointer to privileged instruction
1543	* @param pCurInstrGC Guest context pointer to the current instruction
1544	* @param pUserData User pointer (callback specific)
1545	*
1546	*/
1547	static int patmRecompileCallback(PVM pVM, DISCPUSTATE pCpu, GCPTRTYPE(uint8_t ) pInstrGC, GCPTRTYPE(uint8_t ) pCurInstrGC, void pUserData)
1548	{
1549	PPATCHINFO pPatch = (PPATCHINFO)pUserData;
1550	int rc = VINF_SUCCESS;
1551	bool fInhibitIRQInstr = false; /* did the instruction cause PATMFL_INHIBITIRQS to be set? */
1552
1553	LogFlow(("patmRecompileCallback %VGv %VGv\n", pInstrGC, pCurInstrGC));
1554
1555	if ( patmGuestGCPtrToPatchGCPtr(pVM, pPatch, pCurInstrGC) != 0
1556	&& !(pPatch->flags & PATMFL_RECOMPILE_NEXT)) /* do not do this when the next instruction must be executed! */
1557	{
1558	/*
1559	* Been there, done that; so insert a jump (we don't want to duplicate code)
1560	* no need to record this instruction as it's glue code that never crashes (it had better not!)
1561	*/
1562	Log(("patmRecompileCallback: jump to code we've recompiled before %VGv!\n", pCurInstrGC));
1563	return patmPatchGenRelJump(pVM, pPatch, pCurInstrGC, OP_JMP, !!(pCpu->prefix & PREFIX_OPSIZE));
1564	}
1565
1566	if (pPatch->flags & (PATMFL_DUPLICATE_FUNCTION))
1567	{
1568	rc = patmAnalyseFunctionCallback(pVM, pCpu, pInstrGC, pCurInstrGC, pUserData);
1569	}
1570	else
1571	rc = patmAnalyseBlockCallback(pVM, pCpu, pInstrGC, pCurInstrGC, pUserData);
1572
1573	if (VBOX_FAILURE(rc))
1574	return rc;
1575
1576	/** @note Never do a direct return unless a failure is encountered! */
1577
1578	/* Clear recompilation of next instruction flag; we are doing that right here. */
1579	if (pPatch->flags & PATMFL_RECOMPILE_NEXT)
1580	pPatch->flags &= ~PATMFL_RECOMPILE_NEXT;
1581
1582	/* Add lookup record for patch to guest address translation */
1583	patmr3AddP2GLookupRecord(pVM, pPatch, PATCHCODE_PTR_HC(pPatch) + pPatch->uCurPatchOffset, pCurInstrGC, PATM_LOOKUP_BOTHDIR);
1584
1585	/* Update lowest and highest instruction address for this patch */
1586	if (pCurInstrGC < pPatch->pInstrGCLowest)
1587	pPatch->pInstrGCLowest = pCurInstrGC;
1588	else
1589	if (pCurInstrGC > pPatch->pInstrGCHighest)
1590	pPatch->pInstrGCHighest = pCurInstrGC + pCpu->opsize;
1591
1592	/* Illegal instruction -> end of recompile phase for this code block. */
1593	if (patmIsIllegalInstr(pPatch, pCurInstrGC))
1594	{
1595	Log(("Illegal instruction at %VGv -> mark with int 3\n", pCurInstrGC));
1596	rc = patmPatchGenIllegalInstr(pVM, pPatch);
1597	goto end;
1598	}
1599
1600	/* For our first attempt, we'll handle only simple relative jumps (immediate offset coded in instruction).
1601	* Indirect calls are handled below.
1602	*/
1603	if ( (pCpu->pCurInstr->optype & OPTYPE_CONTROLFLOW)
1604	&& (pCpu->pCurInstr->opcode != OP_CALL \|\| (pPatch->flags & PATMFL_SUPPORT_CALLS))
1605	&& (OP_PARM_VTYPE(pCpu->pCurInstr->param1) == OP_PARM_J))
1606	{
1607	GCPTRTYPE(uint8_t *)pTargetGC = PATMResolveBranch(pCpu, pCurInstrGC);
1608	if (pTargetGC == 0)
1609	{
1610	Log(("We don't support far jumps here!! (%08X)\n", pCpu->param1.flags));
1611	return VERR_PATCHING_REFUSED;
1612	}
1613
1614	if (pCpu->pCurInstr->opcode == OP_CALL)
1615	{
1616	Assert(!PATMIsPatchGCAddr(pVM, pTargetGC));
1617	rc = patmPatchGenCall(pVM, pPatch, pCpu, pCurInstrGC, pTargetGC, false);
1618	if (VBOX_FAILURE(rc))
1619	goto end;
1620	}
1621	else
1622	rc = patmPatchGenRelJump(pVM, pPatch, pTargetGC, pCpu->pCurInstr->opcode, !!(pCpu->prefix & PREFIX_OPSIZE));
1623
1624	if (VBOX_SUCCESS(rc))
1625	rc = VWRN_CONTINUE_RECOMPILE;
1626
1627	goto end;
1628	}
1629
1630	switch (pCpu->pCurInstr->opcode)
1631	{
1632	case OP_CLI:
1633	{
1634	/* If a cli is found while duplicating instructions for another patch, then it's of vital importance to continue
1635	* until we've found the proper exit point(s).
1636	*/
1637	if ( pCurInstrGC != pInstrGC
1638	&& !(pPatch->flags & (PATMFL_DUPLICATE_FUNCTION))
1639	)
1640	{
1641	Log(("cli instruction found in other instruction patch block; force it to continue & find an exit point\n"));
1642	pPatch->flags &= ~(PATMFL_CHECK_SIZE \| PATMFL_SINGLE_INSTRUCTION);
1643	}
1644	/* Set by irq inhibition; no longer valid now. */
1645	pPatch->flags &= ~PATMFL_GENERATE_JUMPTOGUEST;
1646
1647	rc = patmPatchGenCli(pVM, pPatch);
1648	if (VBOX_SUCCESS(rc))
1649	rc = VWRN_CONTINUE_RECOMPILE;
1650	break;
1651	}
1652
1653	case OP_MOV:
1654	if (pCpu->pCurInstr->optype & OPTYPE_POTENTIALLY_DANGEROUS)
1655	{
1656	/* mov ss, src? */
1657	if ( (pCpu->param1.flags & USE_REG_SEG)
1658	&& (pCpu->param1.base.reg_seg == USE_REG_SS))
1659	{
1660	Log(("Force recompilation of next instruction for OP_MOV at %VGv\n", pCurInstrGC));
1661	pPatch->flags \|= PATMFL_RECOMPILE_NEXT;
1662	/** @todo this could cause a fault (ring 0 selector being loaded in ring 1) */
1663	}
1664	#if 0 /* necessary for Haiku */
1665	else
1666	if ( (pCpu->param2.flags & USE_REG_SEG)
1667	&& (pCpu->param2.base.reg_seg == USE_REG_SS)
1668	&& (pCpu->param1.flags & (USE_REG_GEN32\|USE_REG_GEN16))) /** @todo memory operand must in theory be handled too */
1669	{
1670	/* mov GPR, ss */
1671	rc = patmPatchGenMovFromSS(pVM, pPatch, pCpu, pCurInstrGC);
1672	if (VBOX_SUCCESS(rc))
1673	rc = VWRN_CONTINUE_RECOMPILE;
1674	break;
1675	}
1676	#endif
1677	}
1678	goto duplicate_instr;
1679
1680	case OP_POP:
1681	if (pCpu->pCurInstr->param1 == OP_PARM_REG_SS)
1682	{
1683	Assert(pCpu->pCurInstr->optype & OPTYPE_INHIBIT_IRQS);
1684
1685	Log(("Force recompilation of next instruction for OP_MOV at %VGv\n", pCurInstrGC));
1686	pPatch->flags \|= PATMFL_RECOMPILE_NEXT;
1687	}
1688	goto duplicate_instr;
1689
1690	case OP_STI:
1691	{
1692	RTGCPTR pNextInstrGC = 0; /* by default no inhibit irq */
1693
1694	/** In a sequence of instructions that inhibit irqs, only the first one actually inhibits irqs. */
1695	if (!(pPatch->flags & PATMFL_INHIBIT_IRQS))
1696	{
1697	pPatch->flags \|= PATMFL_INHIBIT_IRQS \| PATMFL_GENERATE_JUMPTOGUEST;
1698	fInhibitIRQInstr = true;
1699	pNextInstrGC = pCurInstrGC + pCpu->opsize;
1700	Log(("Inhibit irqs for instruction OP_STI at %VGv\n", pCurInstrGC));
1701	}
1702	rc = patmPatchGenSti(pVM, pPatch, pCurInstrGC, pNextInstrGC);
1703
1704	if (VBOX_SUCCESS(rc))
1705	{
1706	DISCPUSTATE cpu = *pCpu;
1707	unsigned opsize;
1708	int disret;
1709	GCPTRTYPE(uint8_t *) pNextInstrGC, pReturnInstrGC;
1710	HCPTRTYPE(uint8_t *) pNextInstrHC;
1711
1712	pPatch->flags \|= PATMFL_FOUND_PATCHEND;
1713
1714	pNextInstrGC = pCurInstrGC + pCpu->opsize;
1715	pNextInstrHC = PATMGCVirtToHCVirt(pVM, pPatch, pNextInstrGC);
1716	if (pNextInstrHC == NULL)
1717	{
1718	AssertFailed();
1719	return VERR_PATCHING_REFUSED;
1720	}
1721
1722	// Disassemble the next instruction
1723	disret = PATMR3DISInstr(pVM, pPatch, &cpu, pNextInstrGC, pNextInstrHC, &opsize, NULL);
1724	if (disret == false)
1725	{
1726	AssertMsgFailed(("STI: Disassembly failed (probably page not present) -> return to caller\n"));
1727	return VERR_PATCHING_REFUSED;
1728	}
1729	pReturnInstrGC = pNextInstrGC + opsize;
1730
1731	if ( (pPatch->flags & (PATMFL_DUPLICATE_FUNCTION))
1732	\|\| pReturnInstrGC <= pInstrGC
1733	\|\| pReturnInstrGC - pInstrGC >= SIZEOF_NEARJUMP32
1734	)
1735	{
1736	/* Not an exit point for function duplication patches */
1737	if ( (pPatch->flags & PATMFL_DUPLICATE_FUNCTION)
1738	&& VBOX_SUCCESS(rc))
1739	{
1740	pPatch->flags &= ~PATMFL_GENERATE_JUMPTOGUEST; /* Don't generate a jump back */
1741	rc = VWRN_CONTINUE_RECOMPILE;
1742	}
1743	else
1744	rc = VINF_SUCCESS; //exit point
1745	}
1746	else {
1747	Log(("PATM: sti occurred too soon; refusing patch!\n"));
1748	rc = VERR_PATCHING_REFUSED; //not allowed!!
1749	}
1750	}
1751	break;
1752	}
1753
1754	case OP_POPF:
1755	{
1756	bool fGenerateJmpBack = (pCurInstrGC + pCpu->opsize - pInstrGC >= SIZEOF_NEARJUMP32);
1757
1758	/* Not an exit point for IDT handler or function replacement patches */
1759	if (pPatch->flags & (PATMFL_IDTHANDLER\|PATMFL_DUPLICATE_FUNCTION))
1760	fGenerateJmpBack = false;
1761
1762	rc = patmPatchGenPopf(pVM, pPatch, pCurInstrGC + pCpu->opsize, !!(pCpu->prefix & PREFIX_OPSIZE), fGenerateJmpBack);
1763	if (VBOX_SUCCESS(rc))
1764	{
1765	if (fGenerateJmpBack == false)
1766	{
1767	/* Not an exit point for IDT handler or function replacement patches */
1768	rc = VWRN_CONTINUE_RECOMPILE;
1769	}
1770	else
1771	{
1772	pPatch->flags \|= PATMFL_FOUND_PATCHEND;
1773	rc = VINF_SUCCESS; /* exit point! */
1774	}
1775	}
1776	break;
1777	}
1778
1779	case OP_PUSHF:
1780	rc = patmPatchGenPushf(pVM, pPatch, !!(pCpu->prefix & PREFIX_OPSIZE));
1781	if (VBOX_SUCCESS(rc))
1782	rc = VWRN_CONTINUE_RECOMPILE;
1783	break;
1784
1785	case OP_PUSH:
1786	if (pCpu->pCurInstr->param1 == OP_PARM_REG_CS)
1787	{
1788	rc = patmPatchGenPushCS(pVM, pPatch);
1789	if (VBOX_SUCCESS(rc))
1790	rc = VWRN_CONTINUE_RECOMPILE;
1791	break;
1792	}
1793	goto duplicate_instr;
1794
1795	case OP_IRET:
1796	Log(("IRET at %VGv\n", pCurInstrGC));
1797	rc = patmPatchGenIret(pVM, pPatch, pCurInstrGC, !!(pCpu->prefix & PREFIX_OPSIZE));
1798	if (VBOX_SUCCESS(rc))
1799	{
1800	pPatch->flags \|= PATMFL_FOUND_PATCHEND;
1801	rc = VINF_SUCCESS; /* exit point by definition */
1802	}
1803	break;
1804
1805	case OP_ILLUD2:
1806	/* This appears to be some kind of kernel panic in Linux 2.4; no point to continue */
1807	rc = patmPatchGenIllegalInstr(pVM, pPatch);
1808	if (VBOX_SUCCESS(rc))
1809	rc = VINF_SUCCESS; /* exit point by definition */
1810	Log(("Illegal opcode (0xf 0xb)\n"));
1811	break;
1812
1813	case OP_CPUID:
1814	rc = patmPatchGenCpuid(pVM, pPatch, pCurInstrGC);
1815	if (VBOX_SUCCESS(rc))
1816	rc = VWRN_CONTINUE_RECOMPILE;
1817	break;
1818
1819	case OP_STR:
1820	case OP_SLDT:
1821	rc = patmPatchGenSldtStr(pVM, pPatch, pCpu, pCurInstrGC);
1822	if (VBOX_SUCCESS(rc))
1823	rc = VWRN_CONTINUE_RECOMPILE;
1824	break;
1825
1826	case OP_SGDT:
1827	case OP_SIDT:
1828	rc = patmPatchGenSxDT(pVM, pPatch, pCpu, pCurInstrGC);
1829	if (VBOX_SUCCESS(rc))
1830	rc = VWRN_CONTINUE_RECOMPILE;
1831	break;
1832
1833	case OP_RETN:
1834	/* retn is an exit point for function patches */
1835	rc = patmPatchGenRet(pVM, pPatch, pCpu, pCurInstrGC);
1836	if (VBOX_SUCCESS(rc))
1837	rc = VINF_SUCCESS; /* exit point by definition */
1838	break;
1839
1840	case OP_SYSEXIT:
1841	/* Duplicate it, so it can be emulated in GC (or fault). */
1842	rc = patmPatchGenDuplicate(pVM, pPatch, pCpu, pCurInstrGC);
1843	if (VBOX_SUCCESS(rc))
1844	rc = VINF_SUCCESS; /* exit point by definition */
1845	break;
1846
1847	case OP_CALL:
1848	Assert(pPatch->flags & PATMFL_SUPPORT_INDIRECT_CALLS);
1849	/* In interrupt gate handlers it's possible to encounter jumps or calls when IF has been enabled again.
1850	* In that case we'll jump to the original instruction and continue from there. Otherwise an int 3 is executed.
1851	*/
1852	Assert(pCpu->param1.size == 4 \|\| pCpu->param1.size == 8);
1853	if (pPatch->flags & PATMFL_SUPPORT_INDIRECT_CALLS && pCpu->param1.size == 4 /* no far calls! */)
1854	{
1855	rc = patmPatchGenCall(pVM, pPatch, pCpu, pCurInstrGC, (RTGCPTR)0xDEADBEEF, true);
1856	if (VBOX_SUCCESS(rc))
1857	{
1858	rc = VWRN_CONTINUE_RECOMPILE;
1859	}
1860	break;
1861	}
1862	goto gen_illegal_instr;
1863
1864	case OP_JMP:
1865	Assert(pPatch->flags & PATMFL_SUPPORT_INDIRECT_CALLS);
1866	/* In interrupt gate handlers it's possible to encounter jumps or calls when IF has been enabled again.
1867	* In that case we'll jump to the original instruction and continue from there. Otherwise an int 3 is executed.
1868	*/
1869	Assert(pCpu->param1.size == 4 \|\| pCpu->param1.size == 8);
1870	if (pPatch->flags & PATMFL_SUPPORT_INDIRECT_CALLS && pCpu->param1.size == 4 /* no far jumps! */)
1871	{
1872	rc = patmPatchGenJump(pVM, pPatch, pCpu, pCurInstrGC);
1873	if (VBOX_SUCCESS(rc))
1874	rc = VINF_SUCCESS; /* end of branch */
1875	break;
1876	}
1877	goto gen_illegal_instr;
1878
1879	case OP_INT3:
1880	case OP_INT:
1881	case OP_INTO:
1882	goto gen_illegal_instr;
1883
1884	case OP_MOV_DR:
1885	/** @note: currently we let DRx writes cause a trap d; our trap handler will decide to interpret it or not. */
1886	if (pCpu->pCurInstr->param2 == OP_PARM_Dd)
1887	{
1888	rc = patmPatchGenMovDebug(pVM, pPatch, pCpu);
1889	if (VBOX_SUCCESS(rc))
1890	rc = VWRN_CONTINUE_RECOMPILE;
1891	break;
1892	}
1893	goto duplicate_instr;
1894
1895	case OP_MOV_CR:
1896	/** @note: currently we let CRx writes cause a trap d; our trap handler will decide to interpret it or not. */
1897	if (pCpu->pCurInstr->param2 == OP_PARM_Cd)
1898	{
1899	rc = patmPatchGenMovControl(pVM, pPatch, pCpu);
1900	if (VBOX_SUCCESS(rc))
1901	rc = VWRN_CONTINUE_RECOMPILE;
1902	break;
1903	}
1904	goto duplicate_instr;
1905
1906	default:
1907	if (pCpu->pCurInstr->optype & (OPTYPE_CONTROLFLOW \| OPTYPE_PRIVILEGED_NOTRAP))
1908	{
1909	gen_illegal_instr:
1910	rc = patmPatchGenIllegalInstr(pVM, pPatch);
1911	if (VBOX_SUCCESS(rc))
1912	rc = VINF_SUCCESS; /* exit point by definition */
1913	}
1914	else
1915	{
1916	duplicate_instr:
1917	Log(("patmPatchGenDuplicate\n"));
1918	rc = patmPatchGenDuplicate(pVM, pPatch, pCpu, pCurInstrGC);
1919	if (VBOX_SUCCESS(rc))
1920	rc = VWRN_CONTINUE_RECOMPILE;
1921	}
1922	break;
1923	}
1924
1925	end:
1926
1927	if ( !fInhibitIRQInstr
1928	&& (pPatch->flags & PATMFL_INHIBIT_IRQS))
1929	{
1930	int rc2;
1931	RTGCPTR pNextInstrGC = pCurInstrGC + pCpu->opsize;
1932
1933	pPatch->flags &= ~PATMFL_INHIBIT_IRQS;
1934	Log(("Clear inhibit IRQ flag at %VGv\n", pCurInstrGC));
1935	if (pPatch->flags & PATMFL_GENERATE_JUMPTOGUEST)
1936	{
1937	Log(("patmRecompileCallback: generate jump back to guest (%VGv) after fused instruction\n", pNextInstrGC));
1938
1939	rc2 = patmPatchGenJumpToGuest(pVM, pPatch, pNextInstrGC, true /* clear inhibit irq flag */);
1940	pPatch->flags &= ~PATMFL_GENERATE_JUMPTOGUEST;
1941	rc = VINF_SUCCESS; /* end of the line */
1942	}
1943	else
1944	{
1945	rc2 = patmPatchGenClearInhibitIRQ(pVM, pPatch, pNextInstrGC);
1946	}
1947	if (VBOX_FAILURE(rc2))
1948	rc = rc2;
1949	}
1950
1951	if (VBOX_SUCCESS(rc))
1952	{
1953	// If single instruction patch, we've copied enough instructions and the current instruction is not a relative jump
1954	if ( (pPatch->flags & PATMFL_CHECK_SIZE)
1955	&& pCurInstrGC + pCpu->opsize - pInstrGC >= SIZEOF_NEARJUMP32
1956	&& !(pCpu->pCurInstr->optype & OPTYPE_RELATIVE_CONTROLFLOW)
1957	&& !(pPatch->flags & PATMFL_RECOMPILE_NEXT) /* do not do this when the next instruction must be executed! */
1958	)
1959	{
1960	RTGCPTR pNextInstrGC = pCurInstrGC + pCpu->opsize;
1961
1962	// The end marker for this kind of patch is any instruction at a location outside our patch jump
1963	Log(("patmRecompileCallback: end found for single instruction patch at %VGv opsize %d\n", pNextInstrGC, pCpu->opsize));
1964
1965	rc = patmPatchGenJumpToGuest(pVM, pPatch, pNextInstrGC);
1966	AssertRC(rc);
1967	}
1968	}
1969	return rc;
1970	}
1971
1972
1973	#ifdef LOG_ENABLED
1974
1975	/* Add a disasm jump record (temporary for prevent duplicate analysis)
1976	*
1977	* @param pVM The VM to operate on.
1978	* @param pPatch Patch structure ptr
1979	* @param pInstrGC Guest context pointer to privileged instruction
1980	*
1981	*/
1982	static void patmPatchAddDisasmJump(PVM pVM, PPATCHINFO pPatch, RTGCPTR pInstrGC)
1983	{
1984	PAVLPVNODECORE pRec;
1985
1986	pRec = (PAVLPVNODECORE)MMR3HeapAllocZ(pVM, MM_TAG_PATM_PATCH, sizeof(*pRec));
1987	Assert(pRec);
1988	pRec->Key = (AVLPVKEY)pInstrGC;
1989
1990	int ret = RTAvlPVInsert(&pPatch->pTempInfo->DisasmJumpTree, pRec);
1991	Assert(ret);
1992	}
1993
1994	/**
1995	* Checks if jump target has been analysed before.
1996	*
1997	* @returns VBox status code.
1998	* @param pPatch Patch struct
1999	* @param pInstrGC Jump target
2000	*
2001	*/
2002	static bool patmIsKnownDisasmJump(PPATCHINFO pPatch, RTGCPTR pInstrGC)
2003	{
2004	PAVLPVNODECORE pRec;
2005
2006	pRec = RTAvlPVGet(&pPatch->pTempInfo->DisasmJumpTree, (AVLPVKEY)pInstrGC);
2007	if (pRec)
2008	return true;
2009	return false;
2010	}
2011
2012	/**
2013	* For proper disassembly of the final patch block
2014	*
2015	* @returns VBox status code.
2016	* @param pVM The VM to operate on.
2017	* @param pCpu CPU disassembly state
2018	* @param pInstrGC Guest context pointer to privileged instruction
2019	* @param pCurInstrGC Guest context pointer to the current instruction
2020	* @param pUserData User pointer (callback specific)
2021	*
2022	*/
2023	int patmr3DisasmCallback(PVM pVM, DISCPUSTATE pCpu, GCPTRTYPE(uint8_t ) pInstrGC, GCPTRTYPE(uint8_t ) pCurInstrGC, void pUserData)
2024	{
2025	PPATCHINFO pPatch = (PPATCHINFO)pUserData;
2026
2027	if (pCpu->pCurInstr->opcode == OP_INT3)
2028	{
2029	/* Could be an int3 inserted in a call patch. Check to be sure */
2030	DISCPUSTATE cpu;
2031	uint8_t *pOrgJumpHC;
2032	RTGCPTR pOrgJumpGC;
2033	uint32_t dummy;
2034
2035	cpu.mode = (pPatch->flags & PATMFL_CODE32) ? CPUMODE_32BIT : CPUMODE_16BIT;
2036	pOrgJumpGC = patmPatchGCPtr2GuestGCPtr(pVM, pPatch, pCurInstrGC);
2037	pOrgJumpHC = PATMGCVirtToHCVirt(pVM, pPatch, pOrgJumpGC);
2038
2039	bool disret = PATMR3DISInstr(pVM, pPatch, &cpu, pOrgJumpGC, pOrgJumpHC, &dummy, NULL);
2040	if (!disret \|\| cpu.pCurInstr->opcode != OP_CALL \|\| cpu.param1.size != 4 /* only near calls */)
2041	return VINF_SUCCESS;
2042
2043	return VWRN_CONTINUE_ANALYSIS;
2044	}
2045
2046	if ( pCpu->pCurInstr->opcode == OP_ILLUD2
2047	&& PATMIsPatchGCAddr(pVM, pCurInstrGC))
2048	{
2049	/* the indirect call patch contains an 0xF/0xB illegal instr to call for assistance; check for this and continue */
2050	return VWRN_CONTINUE_ANALYSIS;
2051	}
2052
2053	if ( (pCpu->pCurInstr->opcode == OP_CALL && !(pPatch->flags & PATMFL_SUPPORT_CALLS))
2054	\|\| pCpu->pCurInstr->opcode == OP_INT
2055	\|\| pCpu->pCurInstr->opcode == OP_IRET
2056	\|\| pCpu->pCurInstr->opcode == OP_RETN
2057	\|\| pCpu->pCurInstr->opcode == OP_RETF
2058	)
2059	{
2060	return VINF_SUCCESS;
2061	}
2062
2063	if (pCpu->pCurInstr->opcode == OP_ILLUD2)
2064	return VINF_SUCCESS;
2065
2066	return VWRN_CONTINUE_ANALYSIS;
2067	}
2068
2069
2070	/**
2071	* Disassembles the code stream until the callback function detects a failure or decides everything is acceptable
2072	*
2073	* @returns VBox status code.
2074	* @param pVM The VM to operate on.
2075	* @param pInstrGC Guest context pointer to the initial privileged instruction
2076	* @param pCurInstrGC Guest context pointer to the current instruction
2077	* @param pfnPATMR3Disasm Callback for testing the disassembled instruction
2078	* @param pUserData User pointer (callback specific)
2079	*
2080	*/
2081	int patmr3DisasmCode(PVM pVM, GCPTRTYPE(uint8_t ) pInstrGC, GCPTRTYPE(uint8_t ) pCurInstrGC, PFN_PATMR3ANALYSE pfnPATMR3Disasm, void *pUserData)
2082	{
2083	DISCPUSTATE cpu;
2084	PPATCHINFO pPatch = (PPATCHINFO)pUserData;
2085	int rc = VWRN_CONTINUE_ANALYSIS;
2086	uint32_t opsize, delta;
2087	HCPTRTYPE(uint8_t *)pCurInstrHC = 0;
2088	bool disret;
2089	char szOutput[256];
2090
2091	Assert(pCurInstrHC != PATCHCODE_PTR_HC(pPatch) \|\| pPatch->pTempInfo->DisasmJumpTree == 0);
2092
2093	/* We need this to determine branch targets (and for disassembling). */
2094	delta = pVM->patm.s.pPatchMemGC - (uintptr_t)pVM->patm.s.pPatchMemHC;
2095
2096	while(rc == VWRN_CONTINUE_ANALYSIS)
2097	{
2098	cpu.mode = (pPatch->flags & PATMFL_CODE32) ? CPUMODE_32BIT : CPUMODE_16BIT;
2099
2100	pCurInstrHC = PATMGCVirtToHCVirt(pVM, pPatch, pCurInstrGC);
2101	if (pCurInstrHC == NULL)
2102	{
2103	rc = VERR_PATCHING_REFUSED;
2104	goto end;
2105	}
2106
2107	disret = PATMR3DISInstr(pVM, pPatch, &cpu, pCurInstrGC, pCurInstrHC, &opsize, szOutput, PATMREAD_RAWCODE);
2108	if (PATMIsPatchGCAddr(pVM, pCurInstrGC))
2109	{
2110	RTGCPTR pOrgInstrGC = patmPatchGCPtr2GuestGCPtr(pVM, pPatch, pCurInstrGC);
2111
2112	if (pOrgInstrGC != pPatch->pTempInfo->pLastDisasmInstrGC)
2113	Log(("DIS %VGv<-%s", pOrgInstrGC, szOutput));
2114	else
2115	Log(("DIS %s", szOutput));
2116
2117	pPatch->pTempInfo->pLastDisasmInstrGC = pOrgInstrGC;
2118	if (patmIsIllegalInstr(pPatch, pOrgInstrGC))
2119	{
2120	rc = VINF_SUCCESS;
2121	goto end;
2122	}
2123	}
2124	else
2125	Log(("DIS: %s", szOutput));
2126
2127	if (disret == false)
2128	{
2129	Log(("Disassembly failed (probably page not present) -> return to caller\n"));
2130	rc = VINF_SUCCESS;
2131	goto end;
2132	}
2133
2134	rc = pfnPATMR3Disasm(pVM, &cpu, pInstrGC, pCurInstrGC, pUserData);
2135	if (rc != VWRN_CONTINUE_ANALYSIS) {
2136	break; //done!
2137	}
2138
2139	/* For our first attempt, we'll handle only simple relative jumps and calls (immediate offset coded in instruction) */
2140	if ( (cpu.pCurInstr->optype & OPTYPE_CONTROLFLOW)
2141	&& (OP_PARM_VTYPE(cpu.pCurInstr->param1) == OP_PARM_J)
2142	&& cpu.pCurInstr->opcode != OP_CALL /* complete functions are replaced; don't bother here. */
2143	)
2144	{
2145	RTGCPTR pTargetGC = PATMResolveBranch(&cpu, pCurInstrGC);
2146	RTGCPTR pOrgTargetGC;
2147
2148	if (pTargetGC == 0)
2149	{
2150	Log(("We don't support far jumps here!! (%08X)\n", cpu.param1.flags));
2151	rc = VERR_PATCHING_REFUSED;
2152	break;
2153	}
2154
2155	if (!PATMIsPatchGCAddr(pVM, pTargetGC))
2156	{
2157	//jump back to guest code
2158	rc = VINF_SUCCESS;
2159	goto end;
2160	}
2161	pOrgTargetGC = PATMR3PatchToGCPtr(pVM, pTargetGC, 0);
2162
2163	if (patmIsCommonIDTHandlerPatch(pVM, pOrgTargetGC))
2164	{
2165	rc = VINF_SUCCESS;
2166	goto end;
2167	}
2168
2169	if (patmIsKnownDisasmJump(pPatch, pTargetGC) == false)
2170	{
2171	/* New jump, let's check it. */
2172	patmPatchAddDisasmJump(pVM, pPatch, pTargetGC);
2173
2174	if (cpu.pCurInstr->opcode == OP_CALL) pPatch->pTempInfo->nrCalls++;
2175	rc = patmr3DisasmCode(pVM, pInstrGC, pTargetGC, pfnPATMR3Disasm, pUserData);
2176	if (cpu.pCurInstr->opcode == OP_CALL) pPatch->pTempInfo->nrCalls--;
2177
2178	if (rc != VINF_SUCCESS) {
2179	break; //done!
2180	}
2181	}
2182	if (cpu.pCurInstr->opcode == OP_JMP)
2183	{
2184	/* Unconditional jump; return to caller. */
2185	rc = VINF_SUCCESS;
2186	goto end;
2187	}
2188
2189	rc = VWRN_CONTINUE_ANALYSIS;
2190	}
2191	pCurInstrGC += opsize;
2192	}
2193	end:
2194	return rc;
2195	}
2196
2197	/**
2198	* Disassembles the code stream until the callback function detects a failure or decides everything is acceptable
2199	*
2200	* @returns VBox status code.
2201	* @param pVM The VM to operate on.
2202	* @param pInstrGC Guest context pointer to the initial privileged instruction
2203	* @param pCurInstrGC Guest context pointer to the current instruction
2204	* @param pfnPATMR3Disasm Callback for testing the disassembled instruction
2205	* @param pUserData User pointer (callback specific)
2206	*
2207	*/
2208	int patmr3DisasmCodeStream(PVM pVM, GCPTRTYPE(uint8_t ) pInstrGC, GCPTRTYPE(uint8_t ) pCurInstrGC, PFN_PATMR3ANALYSE pfnPATMR3Disasm, void *pUserData)
2209	{
2210	PPATCHINFO pPatch = (PPATCHINFO)pUserData;
2211
2212	int rc = patmr3DisasmCode(pVM, pInstrGC, pCurInstrGC, pfnPATMR3Disasm, pUserData);
2213	/* Free all disasm jump records. */
2214	patmEmptyTree(pVM, &pPatch->pTempInfo->DisasmJumpTree);
2215	return rc;
2216	}
2217
2218	#endif /* LOG_ENABLED */
2219
2220	/**
2221	* Detects it the specified address falls within a 5 byte jump generated for an active patch.
2222	* If so, this patch is permanently disabled.
2223	*
2224	* @param pVM The VM to operate on.
2225	* @param pInstrGC Guest context pointer to instruction
2226	* @param pConflictGC Guest context pointer to check
2227	*
2228	* @note also checks for patch hints to make sure they can never be enabled if a conflict is present.
2229	*
2230	*/
2231	PATMR3DECL(int) PATMR3DetectConflict(PVM pVM, RTGCPTR pInstrGC, RTGCPTR pConflictGC)
2232	{
2233	PPATCHINFO pTargetPatch = PATMFindActivePatchByEntrypoint(pVM, pConflictGC, true /* include patch hints */);
2234	if (pTargetPatch)
2235	{
2236	return patmDisableUnusablePatch(pVM, pInstrGC, pConflictGC, pTargetPatch);
2237	}
2238	return VERR_PATCH_NO_CONFLICT;
2239	}
2240
2241	/**
2242	* Recompile the code stream until the callback function detects a failure or decides everything is acceptable
2243	*
2244	* @returns VBox status code.
2245	* @param pVM The VM to operate on.
2246	* @param pInstrGC Guest context pointer to privileged instruction
2247	* @param pCurInstrGC Guest context pointer to the current instruction
2248	* @param pfnPATMR3Recompile Callback for testing the disassembled instruction
2249	* @param pUserData User pointer (callback specific)
2250	*
2251	*/
2252	static int patmRecompileCodeStream(PVM pVM, GCPTRTYPE(uint8_t ) pInstrGC, GCPTRTYPE(uint8_t ) pCurInstrGC, PFN_PATMR3ANALYSE pfnPATMR3Recompile, void *pUserData)
2253	{
2254	DISCPUSTATE cpu;
2255	PPATCHINFO pPatch = (PPATCHINFO)pUserData;
2256	int rc = VWRN_CONTINUE_ANALYSIS;
2257	uint32_t opsize;
2258	HCPTRTYPE(uint8_t *)pCurInstrHC = 0;
2259	bool disret;
2260	#ifdef LOG_ENABLED
2261	char szOutput[256];
2262	#endif
2263
2264	while (rc == VWRN_CONTINUE_RECOMPILE)
2265	{
2266	cpu.mode = (pPatch->flags & PATMFL_CODE32) ? CPUMODE_32BIT : CPUMODE_16BIT;
2267
2268	////Log(("patmRecompileCodeStream %VGv %VGv\n", pInstrGC, pCurInstrGC));
2269
2270	pCurInstrHC = PATMGCVirtToHCVirt(pVM, pPatch, pCurInstrGC);
2271	if (pCurInstrHC == NULL)
2272	{
2273	rc = VERR_PATCHING_REFUSED; /* fatal in this case */
2274	goto end;
2275	}
2276	#ifdef LOG_ENABLED
2277	disret = PATMR3DISInstr(pVM, pPatch, &cpu, pCurInstrGC, pCurInstrHC, &opsize, szOutput);
2278	Log(("Recompile: %s", szOutput));
2279	#else
2280	disret = PATMR3DISInstr(pVM, pPatch, &cpu, pCurInstrGC, pCurInstrHC, &opsize, NULL);
2281	#endif
2282	if (disret == false)
2283	{
2284	Log(("Disassembly failed (probably page not present) -> return to caller\n"));
2285
2286	/* Add lookup record for patch to guest address translation */
2287	patmr3AddP2GLookupRecord(pVM, pPatch, PATCHCODE_PTR_HC(pPatch) + pPatch->uCurPatchOffset, pCurInstrGC, PATM_LOOKUP_BOTHDIR);
2288	patmPatchGenIllegalInstr(pVM, pPatch);
2289	rc = VINF_SUCCESS; /* Note: don't fail here; we might refuse an important patch!! */
2290	goto end;
2291	}
2292
2293	rc = pfnPATMR3Recompile(pVM, &cpu, pInstrGC, pCurInstrGC, pUserData);
2294	if (rc != VWRN_CONTINUE_RECOMPILE)
2295	{
2296	/* If irqs are inhibited because of the current instruction, then we must make sure the next one is executed! */
2297	if ( rc == VINF_SUCCESS
2298	&& (pPatch->flags & PATMFL_INHIBIT_IRQS))
2299	{
2300	DISCPUSTATE cpunext;
2301	uint32_t opsizenext;
2302	uint8_t *pNextInstrHC;
2303	RTGCPTR pNextInstrGC = pCurInstrGC + opsize;
2304
2305	Log(("patmRecompileCodeStream: irqs inhibited by instruction %VGv\n", pNextInstrGC));
2306
2307	/* Certain instructions (e.g. sti) force the next instruction to be executed before any interrupts can occur.
2308	* Recompile the next instruction as well
2309	*/
2310	pNextInstrHC = PATMGCVirtToHCVirt(pVM, pPatch, pNextInstrGC);
2311	if (pNextInstrHC == NULL)
2312	{
2313	rc = VERR_PATCHING_REFUSED; /* fatal in this case */
2314	goto end;
2315	}
2316	cpunext.mode = (pPatch->flags & PATMFL_CODE32) ? CPUMODE_32BIT : CPUMODE_16BIT;
2317	disret = PATMR3DISInstr(pVM, pPatch, &cpunext, pNextInstrGC, pNextInstrHC, &opsizenext, NULL);
2318	if (disret == false)
2319	{
2320	rc = VERR_PATCHING_REFUSED; /* fatal in this case */
2321	goto end;
2322	}
2323	switch(cpunext.pCurInstr->opcode)
2324	{
2325	case OP_IRET: /* inhibit cleared in generated code */
2326	case OP_SYSEXIT: /* faults; inhibit should be cleared in HC handling */
2327	case OP_HLT:
2328	break; /* recompile these */
2329
2330	default:
2331	if (cpunext.pCurInstr->optype & OPTYPE_CONTROLFLOW)
2332	{
2333	Log(("Unexpected control flow instruction after inhibit irq instruction\n"));
2334
2335	rc = patmPatchGenJumpToGuest(pVM, pPatch, pNextInstrGC, true /* clear inhibit irq flag */);
2336	AssertRC(rc);
2337	pPatch->flags &= ~PATMFL_INHIBIT_IRQS;
2338	goto end; /** @todo should be ok to ignore instruction fusing in this case */
2339	}
2340	break;
2341	}
2342
2343	/** @note after a cli we must continue to a proper exit point */
2344	if (cpunext.pCurInstr->opcode != OP_CLI)
2345	{
2346	rc = pfnPATMR3Recompile(pVM, &cpunext, pInstrGC, pNextInstrGC, pUserData);
2347	if (VBOX_SUCCESS(rc))
2348	{
2349	rc = VINF_SUCCESS;
2350	goto end;
2351	}
2352	break;
2353	}
2354	else
2355	rc = VWRN_CONTINUE_RECOMPILE;
2356	}
2357	else
2358	break; /* done! */
2359	}
2360
2361	/** @todo continue with the instructions following the jump and then recompile the jump target code */
2362
2363
2364	/* For our first attempt, we'll handle only simple relative jumps and calls (immediate offset coded in instruction). */
2365	if ( (cpu.pCurInstr->optype & OPTYPE_CONTROLFLOW)
2366	&& (OP_PARM_VTYPE(cpu.pCurInstr->param1) == OP_PARM_J)
2367	&& cpu.pCurInstr->opcode != OP_CALL /* complete functions are replaced; don't bother here. */
2368	)
2369	{
2370	GCPTRTYPE(uint8_t *)addr = PATMResolveBranch(&cpu, pCurInstrGC);
2371	if (addr == 0)
2372	{
2373	Log(("We don't support far jumps here!! (%08X)\n", cpu.param1.flags));
2374	rc = VERR_PATCHING_REFUSED;
2375	break;
2376	}
2377
2378	Log(("Jump encountered target %VGv\n", addr));
2379
2380	/* We don't check if the branch target lies in a valid page as we've already done that in the analysis phase. */
2381	if (!(cpu.pCurInstr->optype & OPTYPE_UNCOND_CONTROLFLOW))
2382	{
2383	Log(("patmRecompileCodeStream continue passed conditional jump\n"));
2384	/* First we need to finish this linear code stream until the next exit point. */
2385	rc = patmRecompileCodeStream(pVM, pInstrGC, pCurInstrGC+opsize, pfnPATMR3Recompile, pUserData);
2386	if (VBOX_FAILURE(rc))
2387	{
2388	Log(("patmRecompileCodeStream fatal error %d\n", rc));
2389	break; //fatal error
2390	}
2391	}
2392
2393	if (patmGuestGCPtrToPatchGCPtr(pVM, pPatch, addr) == 0)
2394	{
2395	/* New code; let's recompile it. */
2396	Log(("patmRecompileCodeStream continue with jump\n"));
2397
2398	/*
2399	* If we are jumping to an existing patch (or within 5 bytes of the entrypoint), then we must temporarily disable
2400	* this patch so we can continue our analysis
2401	*
2402	* We rely on CSAM to detect and resolve conflicts
2403	*/
2404	PPATCHINFO pTargetPatch = PATMFindActivePatchByEntrypoint(pVM, addr);
2405	if(pTargetPatch)
2406	{
2407	Log(("Found active patch at target %VGv (%VGv) -> temporarily disabling it!!\n", addr, pTargetPatch->pPrivInstrGC));
2408	PATMR3DisablePatch(pVM, pTargetPatch->pPrivInstrGC);
2409	}
2410
2411	if (cpu.pCurInstr->opcode == OP_CALL) pPatch->pTempInfo->nrCalls++;
2412	rc = patmRecompileCodeStream(pVM, pInstrGC, addr, pfnPATMR3Recompile, pUserData);
2413	if (cpu.pCurInstr->opcode == OP_CALL) pPatch->pTempInfo->nrCalls--;
2414
2415	if(pTargetPatch)
2416	{
2417	PATMR3EnablePatch(pVM, pTargetPatch->pPrivInstrGC);
2418	}
2419
2420	if (VBOX_FAILURE(rc))
2421	{
2422	Log(("patmRecompileCodeStream fatal error %d\n", rc));
2423	break; //done!
2424	}
2425	}
2426	/* Always return to caller here; we're done! */
2427	rc = VINF_SUCCESS;
2428	goto end;
2429	}
2430	else
2431	if (cpu.pCurInstr->optype & OPTYPE_UNCOND_CONTROLFLOW)
2432	{
2433	rc = VINF_SUCCESS;
2434	goto end;
2435	}
2436	pCurInstrGC += opsize;
2437	}
2438	end:
2439	Assert(!(pPatch->flags & PATMFL_RECOMPILE_NEXT));
2440	return rc;
2441	}
2442
2443
2444	/**
2445	* Generate the jump from guest to patch code
2446	*
2447	* @returns VBox status code.
2448	* @param pVM The VM to operate on.
2449	* @param pPatch Patch record
2450	*/
2451	static int patmGenJumpToPatch(PVM pVM, PPATCHINFO pPatch, bool fAddFixup = true)
2452	{
2453	uint8_t temp[8];
2454	uint8_t *pPB;
2455	int rc;
2456
2457	Assert(pPatch->cbPatchJump <= sizeof(temp));
2458	Assert(!(pPatch->flags & PATMFL_PATCHED_GUEST_CODE));
2459
2460	pPB = pPatch->pPrivInstrHC;
2461
2462	#ifdef PATM_RESOLVE_CONFLICTS_WITH_JUMP_PATCHES
2463	if (pPatch->flags & PATMFL_JUMP_CONFLICT)
2464	{
2465	Assert(pPatch->pPatchJumpDestGC);
2466
2467	if (pPatch->cbPatchJump == SIZEOF_NEARJUMP32)
2468	{
2469	// jmp [PatchCode]
2470	if (fAddFixup)
2471	{
2472	if (patmPatchAddReloc32(pVM, pPatch, &pPB[1], FIXUP_REL_JMPTOPATCH, pPatch->pPrivInstrGC + pPatch->cbPatchJump, pPatch->pPatchJumpDestGC) != VINF_SUCCESS)
2473	{
2474	Log(("Relocation failed for the jump in the guest code!!\n"));
2475	return VERR_PATCHING_REFUSED;
2476	}
2477	}
2478
2479	temp[0] = pPatch->aPrivInstr[0]; //jump opcode copied from original instruction
2480	(uint32_t )&temp[1] = (uint32_t)pPatch->pPatchJumpDestGC - ((uint32_t)pPatch->pPrivInstrGC + pPatch->cbPatchJump); //return address
2481	}
2482	else
2483	if (pPatch->cbPatchJump == SIZEOF_NEAR_COND_JUMP32)
2484	{
2485	// jmp [PatchCode]
2486	if (fAddFixup)
2487	{
2488	if (patmPatchAddReloc32(pVM, pPatch, &pPB[2], FIXUP_REL_JMPTOPATCH, pPatch->pPrivInstrGC + pPatch->cbPatchJump, pPatch->pPatchJumpDestGC) != VINF_SUCCESS)
2489	{
2490	Log(("Relocation failed for the jump in the guest code!!\n"));
2491	return VERR_PATCHING_REFUSED;
2492	}
2493	}
2494
2495	temp[0] = pPatch->aPrivInstr[0]; //jump opcode copied from original instruction
2496	temp[1] = pPatch->aPrivInstr[1]; //jump opcode copied from original instruction
2497	(uint32_t )&temp[2] = (uint32_t)pPatch->pPatchJumpDestGC - ((uint32_t)pPatch->pPrivInstrGC + pPatch->cbPatchJump); //return address
2498	}
2499	else
2500	{
2501	Assert(0);
2502	return VERR_PATCHING_REFUSED;
2503	}
2504	}
2505	else
2506	#endif
2507	{
2508	Assert(pPatch->cbPatchJump == SIZEOF_NEARJUMP32);
2509
2510	// jmp [PatchCode]
2511	if (fAddFixup)
2512	{
2513	if (patmPatchAddReloc32(pVM, pPatch, &pPB[1], FIXUP_REL_JMPTOPATCH, pPatch->pPrivInstrGC + SIZEOF_NEARJUMP32, PATCHCODE_PTR_GC(pPatch)) != VINF_SUCCESS)
2514	{
2515	Log(("Relocation failed for the jump in the guest code!!\n"));
2516	return VERR_PATCHING_REFUSED;
2517	}
2518	}
2519	temp[0] = 0xE9; //jmp
2520	(uint32_t )&temp[1] = (RTGCUINTPTR)PATCHCODE_PTR_GC(pPatch) - ((RTGCUINTPTR)pPatch->pPrivInstrGC + SIZEOF_NEARJUMP32); //return address
2521	}
2522	rc = PGMPhysWriteGCPtrDirty(pVM, pPatch->pPrivInstrGC, temp, pPatch->cbPatchJump);
2523	AssertRC(rc);
2524
2525	if (rc == VINF_SUCCESS)
2526	pPatch->flags \|= PATMFL_PATCHED_GUEST_CODE;
2527
2528	return rc;
2529	}
2530
2531	/**
2532	* Remove the jump from guest to patch code
2533	*
2534	* @returns VBox status code.
2535	* @param pVM The VM to operate on.
2536	* @param pPatch Patch record
2537	*/
2538	static int patmRemoveJumpToPatch(PVM pVM, PPATCHINFO pPatch)
2539	{
2540	#ifdef DEBUG
2541	DISCPUSTATE cpu;
2542	char szOutput[256];
2543	uint32_t opsize, i = 0;
2544	bool disret;
2545
2546	while(i < pPatch->cbPrivInstr)
2547	{
2548	cpu.mode = (pPatch->flags & PATMFL_CODE32) ? CPUMODE_32BIT : CPUMODE_16BIT;
2549	disret = PATMR3DISInstr(pVM, pPatch, &cpu, pPatch->pPrivInstrGC + i, &pPatch->pPrivInstrHC[i], &opsize, szOutput);
2550	if (disret == false)
2551	break;
2552
2553	Log(("Org patch jump: %s", szOutput));
2554	Assert(opsize);
2555	i += opsize;
2556	}
2557	#endif
2558
2559	/* Restore original code (privileged instruction + following instructions that were overwritten because of the 5/6 byte jmp). */
2560	int rc = PGMPhysWriteGCPtrDirty(pVM, pPatch->pPrivInstrGC, pPatch->aPrivInstr, pPatch->cbPatchJump);
2561	#ifdef DEBUG
2562	if (rc == VINF_SUCCESS)
2563	{
2564	DISCPUSTATE cpu;
2565	char szOutput[256];
2566	uint32_t opsize, i = 0;
2567	bool disret;
2568
2569	while(i < pPatch->cbPrivInstr)
2570	{
2571	cpu.mode = (pPatch->flags & PATMFL_CODE32) ? CPUMODE_32BIT : CPUMODE_16BIT;
2572	disret = PATMR3DISInstr(pVM, pPatch, &cpu, pPatch->pPrivInstrGC + i, &pPatch->pPrivInstrHC[i], &opsize, szOutput);
2573	if (disret == false)
2574	break;
2575
2576	Log(("Org instr: %s", szOutput));
2577	Assert(opsize);
2578	i += opsize;
2579	}
2580	}
2581	#endif
2582	pPatch->flags &= ~PATMFL_PATCHED_GUEST_CODE;
2583	return rc;
2584	}
2585
2586	/**
2587	* Generate the call from guest to patch code
2588	*
2589	* @returns VBox status code.
2590	* @param pVM The VM to operate on.
2591	* @param pPatch Patch record
2592	*/
2593	static int patmGenCallToPatch(PVM pVM, PPATCHINFO pPatch, RTGCPTR pTargetGC, bool fAddFixup = true)
2594	{
2595	uint8_t temp[8];
2596	uint8_t *pPB;
2597	int rc;
2598
2599	Assert(pPatch->cbPatchJump <= sizeof(temp));
2600
2601	pPB = pPatch->pPrivInstrHC;
2602
2603	Assert(pPatch->cbPatchJump == SIZEOF_NEARJUMP32);
2604
2605	// jmp [PatchCode]
2606	if (fAddFixup)
2607	{
2608	if (patmPatchAddReloc32(pVM, pPatch, &pPB[1], FIXUP_REL_JMPTOPATCH, pPatch->pPrivInstrGC + SIZEOF_NEARJUMP32, pTargetGC) != VINF_SUCCESS)
2609	{
2610	Log(("Relocation failed for the jump in the guest code!!\n"));
2611	return VERR_PATCHING_REFUSED;
2612	}
2613	}
2614
2615	Assert(pPatch->aPrivInstr[0] == 0xE8 \|\| pPatch->aPrivInstr[0] == 0xE9); /* call or jmp */
2616	temp[0] = pPatch->aPrivInstr[0];
2617	(uint32_t )&temp[1] = (uint32_t)pTargetGC - ((uint32_t)pPatch->pPrivInstrGC + SIZEOF_NEARJUMP32); //return address
2618
2619	rc = PGMPhysWriteGCPtrDirty(pVM, pPatch->pPrivInstrGC, temp, pPatch->cbPatchJump);
2620	AssertRC(rc);
2621
2622	return rc;
2623	}
2624
2625
2626	/**
2627	* Patch cli/sti pushf/popf instruction block at specified location
2628	*
2629	* @returns VBox status code.
2630	* @param pVM The VM to operate on.
2631	* @param pInstrGC Guest context point to privileged instruction
2632	* @param pInstrHC Host context point to privileged instruction
2633	* @param uOpcode Instruction opcode
2634	* @param uOpSize Size of starting instruction
2635	* @param pPatchRec Patch record
2636	*
2637	* @note returns failure if patching is not allowed or possible
2638	*
2639	*/
2640	PATMR3DECL(int) PATMR3PatchBlock(PVM pVM, RTGCPTR pInstrGC, HCPTRTYPE(uint8_t *) pInstrHC,
2641	uint32_t uOpcode, uint32_t uOpSize, PPATMPATCHREC pPatchRec)
2642	{
2643	PPATCHINFO pPatch = &pPatchRec->patch;
2644	int rc = VERR_PATCHING_REFUSED;
2645	DISCPUSTATE cpu;
2646	uint32_t orgOffsetPatchMem = ~0;
2647	RTGCPTR pInstrStart;
2648	#ifdef LOG_ENABLED
2649	uint32_t opsize;
2650	char szOutput[256];
2651	bool disret;
2652	#endif
2653
2654	/* Save original offset (in case of failures later on) */
2655	/** @todo use the hypervisor heap (that has quite a few consequences for save/restore though) */
2656	orgOffsetPatchMem = pVM->patm.s.offPatchMem;
2657
2658	Assert(!(pPatch->flags & (PATMFL_GUEST_SPECIFIC\|PATMFL_USER_MODE\|PATMFL_TRAPHANDLER)));
2659	switch (uOpcode)
2660	{
2661	case OP_MOV:
2662	break;
2663
2664	case OP_CLI:
2665	case OP_PUSHF:
2666	/* We can 'call' a cli or pushf patch. It will either return to the original guest code when IF is set again, or fault. */
2667	/** @note special precautions are taken when disabling and enabling such patches. */
2668	pPatch->flags \|= PATMFL_CALLABLE_AS_FUNCTION;
2669	break;
2670
2671	default:
2672	if (!(pPatch->flags & PATMFL_IDTHANDLER))
2673	{
2674	AssertMsg(0, ("PATMR3PatchBlock: Invalid opcode %x\n", uOpcode));
2675	return VERR_INVALID_PARAMETER;
2676	}
2677	}
2678
2679	if (!(pPatch->flags & (PATMFL_IDTHANDLER\|PATMFL_IDTHANDLER_WITHOUT_ENTRYPOINT\|PATMFL_SYSENTER\|PATMFL_INT3_REPLACEMENT_BLOCK)))
2680	pPatch->flags \|= PATMFL_MUST_INSTALL_PATCHJMP;
2681
2682	/* If we're going to insert a patch jump, then the jump itself is not allowed to cross a page boundary. */
2683	if ( (pPatch->flags & PATMFL_MUST_INSTALL_PATCHJMP)
2684	&& PAGE_ADDRESS(pInstrGC) != PAGE_ADDRESS(pInstrGC + SIZEOF_NEARJUMP32)
2685	)
2686	{
2687	STAM_COUNTER_INC(&pVM->patm.s.StatPageBoundaryCrossed);
2688	#ifdef DEBUG_sandervl
2689	//// AssertMsgFailed(("Patch jump would cross page boundary -> refuse!!\n"));
2690	#endif
2691	rc = VERR_PATCHING_REFUSED;
2692	goto failure;
2693	}
2694
2695	pPatch->nrPatch2GuestRecs = 0;
2696	pInstrStart = pInstrGC;
2697
2698	#ifdef PATM_ENABLE_CALL
2699	pPatch->flags \|= PATMFL_SUPPORT_CALLS \| PATMFL_SUPPORT_INDIRECT_CALLS;
2700	#endif
2701
2702	pPatch->pPatchBlockOffset = pVM->patm.s.offPatchMem;
2703	pPatch->uCurPatchOffset = 0;
2704
2705	cpu.mode = (pPatch->flags & PATMFL_CODE32) ? CPUMODE_32BIT : CPUMODE_16BIT;
2706
2707	if ((pPatch->flags & (PATMFL_IDTHANDLER\|PATMFL_IDTHANDLER_WITHOUT_ENTRYPOINT\|PATMFL_SYSENTER)) == PATMFL_IDTHANDLER)
2708	{
2709	Assert(pPatch->flags & PATMFL_INTHANDLER);
2710
2711	/* Install fake cli patch (to clear the virtual IF and check int xx parameters) */
2712	rc = patmPatchGenIntEntry(pVM, pPatch, pInstrGC);
2713	if (VBOX_FAILURE(rc))
2714	goto failure;
2715	}
2716
2717	/***************************************************************************************************************************/
2718	/** @note We can't insert any code before a sysenter handler; some linux guests have an invalid stack at this point!!!!! */
2719	/***************************************************************************************************************************/
2720	#ifdef VBOX_WITH_STATISTICS
2721	if (!(pPatch->flags & PATMFL_SYSENTER))
2722	{
2723	rc = patmPatchGenStats(pVM, pPatch, pInstrGC);
2724	if (VBOX_FAILURE(rc))
2725	goto failure;
2726	}
2727	#endif
2728
2729	rc = patmRecompileCodeStream(pVM, pInstrGC, pInstrGC, patmRecompileCallback, pPatch);
2730	if (rc != VINF_SUCCESS)
2731	{
2732	Log(("PATMR3PatchCli: patmRecompileCodeStream failed with %d\n", rc));
2733	goto failure;
2734	}
2735
2736	/* Calculated during analysis. */
2737	if (pPatch->cbPatchBlockSize < SIZEOF_NEARJUMP32)
2738	{
2739	/* Most likely cause: we encountered an illegal instruction very early on. */
2740	/** @todo could turn it into an int3 callable patch. */
2741	Log(("PATMR3PatchBlock: patch block too small -> refuse\n"));
2742	rc = VERR_PATCHING_REFUSED;
2743	goto failure;
2744	}
2745
2746	/* size of patch block */
2747	pPatch->cbPatchBlockSize = pPatch->uCurPatchOffset;
2748
2749
2750	/* Update free pointer in patch memory. */
2751	pVM->patm.s.offPatchMem += pPatch->cbPatchBlockSize;
2752	/* Round to next 8 byte boundary. */
2753	pVM->patm.s.offPatchMem = RT_ALIGN_32(pVM->patm.s.offPatchMem, 8);
2754
2755	/*
2756	* Insert into patch to guest lookup tree
2757	*/
2758	LogFlow(("Insert %VGv patch offset %VGv\n", pPatchRec->patch.pPrivInstrGC, pPatch->pPatchBlockOffset));
2759	pPatchRec->CoreOffset.Key = pPatch->pPatchBlockOffset;
2760	rc = RTAvloGCPtrInsert(&pVM->patm.s.PatchLookupTreeHC->PatchTreeByPatchAddr, &pPatchRec->CoreOffset);
2761	AssertMsg(rc, ("RTAvlULInsert failed for %x\n", pPatchRec->CoreOffset.Key));
2762	if (!rc)
2763	{
2764	rc = VERR_PATCHING_REFUSED;
2765	goto failure;
2766	}
2767
2768	/* Note that patmr3SetBranchTargets can install additional patches!! */
2769	rc = patmr3SetBranchTargets(pVM, pPatch);
2770	if (rc != VINF_SUCCESS)
2771	{
2772	Log(("PATMR3PatchCli: patmr3SetBranchTargets failed with %d\n", rc));
2773	goto failure;
2774	}
2775
2776	#ifdef LOG_ENABLED
2777	Log(("Patch code ----------------------------------------------------------\n"));
2778	patmr3DisasmCodeStream(pVM, PATCHCODE_PTR_GC(pPatch), PATCHCODE_PTR_GC(pPatch), patmr3DisasmCallback, pPatch);
2779	Log(("Patch code ends -----------------------------------------------------\n"));
2780	#endif
2781
2782	/* make a copy of the guest code bytes that will be overwritten */
2783	pPatch->cbPatchJump = SIZEOF_NEARJUMP32;
2784
2785	rc = PGMPhysReadGCPtr(pVM, pPatch->aPrivInstr, pPatch->pPrivInstrGC, pPatch->cbPatchJump);
2786	AssertRC(rc);
2787
2788	if (pPatch->flags & PATMFL_INT3_REPLACEMENT_BLOCK)
2789	{
2790	/uint8_t ASMInt3 = 0xCC; - unused /
2791
2792	Log(("PATMR3PatchBlock %VGv -> int 3 callable patch.\n", pPatch->pPrivInstrGC));
2793	/* Replace first opcode byte with 'int 3'. */
2794	rc = patmActivateInt3Patch(pVM, pPatch);
2795	if (VBOX_FAILURE(rc))
2796	goto failure;
2797
2798	Assert(!(pPatch->flags & PATMFL_MUST_INSTALL_PATCHJMP));
2799	pPatch->flags &= ~PATMFL_INSTR_HINT;
2800	STAM_COUNTER_INC(&pVM->patm.s.StatInt3Callable);
2801	}
2802
2803	if (pPatch->flags & PATMFL_MUST_INSTALL_PATCHJMP)
2804	{
2805	Assert(!(pPatch->flags & (PATMFL_IDTHANDLER\|PATMFL_IDTHANDLER_WITHOUT_ENTRYPOINT\|PATMFL_SYSENTER\|PATMFL_INT3_REPLACEMENT_BLOCK)));
2806	/* now insert a jump in the guest code */
2807	rc = patmGenJumpToPatch(pVM, pPatch, true);
2808	AssertRC(rc);
2809	if (VBOX_FAILURE(rc))
2810	goto failure;
2811
2812	}
2813
2814	#ifdef LOG_ENABLED
2815	cpu.mode = (pPatch->flags & PATMFL_CODE32) ? CPUMODE_32BIT : CPUMODE_16BIT;
2816	disret = PATMR3DISInstr(pVM, pPatch, &cpu, pPatch->pPrivInstrGC, pPatch->pPrivInstrHC, &opsize, szOutput, PATMREAD_RAWCODE);
2817	Log(("%s patch: %s", patmGetInstructionString(pPatch->opcode, pPatch->flags), szOutput));
2818	#endif
2819
2820	patmEmptyTree(pVM, &pPatch->pTempInfo->IllegalInstrTree);
2821	pPatch->pTempInfo->nrIllegalInstr = 0;
2822
2823	Log(("Successfully installed %s patch at %VGv\n", patmGetInstructionString(pPatch->opcode, pPatch->flags), pInstrGC));
2824
2825	pPatch->uState = PATCH_ENABLED;
2826	return VINF_SUCCESS;
2827
2828	failure:
2829	if (pPatchRec->CoreOffset.Key)
2830	RTAvloGCPtrRemove(&pVM->patm.s.PatchLookupTreeHC->PatchTreeByPatchAddr, pPatchRec->CoreOffset.Key);
2831
2832	patmEmptyTree(pVM, &pPatch->FixupTree);
2833	pPatch->nrFixups = 0;
2834
2835	patmEmptyTree(pVM, &pPatch->JumpTree);
2836	pPatch->nrJumpRecs = 0;
2837
2838	patmEmptyTree(pVM, &pPatch->pTempInfo->IllegalInstrTree);
2839	pPatch->pTempInfo->nrIllegalInstr = 0;
2840
2841	/* Turn this cli patch into a dummy. */
2842	pPatch->uState = PATCH_REFUSED;
2843	pPatch->pPatchBlockOffset = 0;
2844
2845	// Give back the patch memory we no longer need
2846	Assert(orgOffsetPatchMem != (uint32_t)~0);
2847	pVM->patm.s.offPatchMem = orgOffsetPatchMem;
2848
2849	return rc;
2850	}
2851
2852	/**
2853	* Patch IDT handler
2854	*
2855	* @returns VBox status code.
2856	* @param pVM The VM to operate on.
2857	* @param pInstrGC Guest context point to privileged instruction
2858	* @param pInstrHC Host context point to privileged instruction
2859	* @param uOpSize Size of starting instruction
2860	* @param pPatchRec Patch record
2861	*
2862	* @note returns failure if patching is not allowed or possible
2863	*
2864	*/
2865	static int patmIdtHandler(PVM pVM, RTGCPTR pInstrGC, HCPTRTYPE(uint8_t *) pInstrHC,
2866	uint32_t uOpSize, PPATMPATCHREC pPatchRec)
2867	{
2868	PPATCHINFO pPatch = &pPatchRec->patch;
2869	bool disret;
2870	DISCPUSTATE cpuPush, cpuJmp;
2871	uint32_t opsize;
2872	RTGCPTR pCurInstrGC = pInstrGC;
2873	uint8_t *pCurInstrHC = pInstrHC;
2874	uint32_t orgOffsetPatchMem = ~0;
2875
2876	/*
2877	* In Linux it's often the case that many interrupt handlers push a predefined value onto the stack
2878	* and then jump to a common entrypoint. In order not to waste a lot of memory, we will check for this
2879	* condition here and only patch the common entypoint once.
2880	*/
2881	cpuPush.mode = (pPatch->flags & PATMFL_CODE32) ? CPUMODE_32BIT : CPUMODE_16BIT;
2882	disret = PATMR3DISInstr(pVM, pPatch, &cpuPush, pCurInstrGC, pCurInstrHC, &opsize, NULL);
2883	Assert(disret);
2884	if (disret && cpuPush.pCurInstr->opcode == OP_PUSH)
2885	{
2886	RTGCPTR pJmpInstrGC;
2887	int rc;
2888
2889	pCurInstrGC += opsize;
2890	pCurInstrHC = PATMGCVirtToHCVirt(pVM, pPatch, pCurInstrGC);
2891
2892	cpuJmp.mode = (pPatch->flags & PATMFL_CODE32) ? CPUMODE_32BIT : CPUMODE_16BIT;
2893	disret = PATMR3DISInstr(pVM, pPatch, &cpuJmp, pCurInstrGC, pCurInstrHC, &opsize, NULL);
2894	if ( disret
2895	&& cpuJmp.pCurInstr->opcode == OP_JMP
2896	&& (pJmpInstrGC = PATMResolveBranch(&cpuJmp, pCurInstrGC))
2897	)
2898	{
2899	PPATMPATCHREC pJmpPatch = (PPATMPATCHREC)RTAvloGCPtrGet(&pVM->patm.s.PatchLookupTreeHC->PatchTree, pJmpInstrGC);
2900	if (pJmpPatch == 0)
2901	{
2902	/* Patch it first! */
2903	rc = PATMR3InstallPatch(pVM, pJmpInstrGC, pPatch->flags \| PATMFL_IDTHANDLER_WITHOUT_ENTRYPOINT);
2904	if (rc != VINF_SUCCESS)
2905	goto failure;
2906	pJmpPatch = (PPATMPATCHREC)RTAvloGCPtrGet(&pVM->patm.s.PatchLookupTreeHC->PatchTree, pJmpInstrGC);
2907	Assert(pJmpPatch);
2908	}
2909	if (pJmpPatch->patch.uState != PATCH_ENABLED)
2910	goto failure;
2911
2912	/* save original offset (in case of failures later on) */
2913	orgOffsetPatchMem = pVM->patm.s.offPatchMem;
2914
2915	pPatch->pPatchBlockOffset = pVM->patm.s.offPatchMem;
2916	pPatch->uCurPatchOffset = 0;
2917	pPatch->nrPatch2GuestRecs = 0;
2918
2919	#ifdef VBOX_WITH_STATISTICS
2920	rc = patmPatchGenStats(pVM, pPatch, pInstrGC);
2921	if (VBOX_FAILURE(rc))
2922	goto failure;
2923	#endif
2924
2925	/* Install fake cli patch (to clear the virtual IF) */
2926	rc = patmPatchGenIntEntry(pVM, pPatch, pInstrGC);
2927	if (VBOX_FAILURE(rc))
2928	goto failure;
2929
2930	/* Add lookup record for patch to guest address translation (for the push) */
2931	patmr3AddP2GLookupRecord(pVM, pPatch, PATCHCODE_PTR_HC(pPatch) + pPatch->uCurPatchOffset, pInstrGC, PATM_LOOKUP_BOTHDIR);
2932
2933	/* Duplicate push. */
2934	rc = patmPatchGenDuplicate(pVM, pPatch, &cpuPush, pInstrGC);
2935	if (VBOX_FAILURE(rc))
2936	goto failure;
2937
2938	/* Generate jump to common entrypoint. */
2939	rc = patmPatchGenPatchJump(pVM, pPatch, pCurInstrGC, PATCHCODE_PTR_GC(&pJmpPatch->patch));
2940	if (VBOX_FAILURE(rc))
2941	goto failure;
2942
2943	/* size of patch block */
2944	pPatch->cbPatchBlockSize = pPatch->uCurPatchOffset;
2945
2946	/* Update free pointer in patch memory. */
2947	pVM->patm.s.offPatchMem += pPatch->cbPatchBlockSize;
2948	/* Round to next 8 byte boundary */
2949	pVM->patm.s.offPatchMem = RT_ALIGN_32(pVM->patm.s.offPatchMem, 8);
2950
2951	/* There's no jump from guest to patch code. */
2952	pPatch->cbPatchJump = 0;
2953
2954
2955	#ifdef LOG_ENABLED
2956	Log(("Patch code ----------------------------------------------------------\n"));
2957	patmr3DisasmCodeStream(pVM, PATCHCODE_PTR_GC(pPatch), PATCHCODE_PTR_GC(pPatch), patmr3DisasmCallback, pPatch);
2958	Log(("Patch code ends -----------------------------------------------------\n"));
2959	#endif
2960	Log(("Successfully installed IDT handler patch at %VGv\n", pInstrGC));
2961
2962	/*
2963	* Insert into patch to guest lookup tree
2964	*/
2965	LogFlow(("Insert %VGv patch offset %VGv\n", pPatchRec->patch.pPrivInstrGC, pPatch->pPatchBlockOffset));
2966	pPatchRec->CoreOffset.Key = pPatch->pPatchBlockOffset;
2967	rc = RTAvloGCPtrInsert(&pVM->patm.s.PatchLookupTreeHC->PatchTreeByPatchAddr, &pPatchRec->CoreOffset);
2968	AssertMsg(rc, ("RTAvlULInsert failed for %x\n", pPatchRec->CoreOffset.Key));
2969
2970	pPatch->uState = PATCH_ENABLED;
2971
2972	return VINF_SUCCESS;
2973	}
2974	}
2975	failure:
2976	/* Give back the patch memory we no longer need */
2977	if (orgOffsetPatchMem != (uint32_t)~0)
2978	pVM->patm.s.offPatchMem = orgOffsetPatchMem;
2979
2980	return PATMR3PatchBlock(pVM, pInstrGC, pInstrHC, OP_CLI, uOpSize, pPatchRec);
2981	}
2982
2983	/**
2984	* Install a trampoline to call a guest trap handler directly
2985	*
2986	* @returns VBox status code.
2987	* @param pVM The VM to operate on.
2988	* @param pInstrGC Guest context point to privileged instruction
2989	* @param pPatchRec Patch record
2990	*
2991	*/
2992	static int patmInstallTrapTrampoline(PVM pVM, RTGCPTR pInstrGC, PPATMPATCHREC pPatchRec)
2993	{
2994	PPATCHINFO pPatch = &pPatchRec->patch;
2995	int rc = VERR_PATCHING_REFUSED;
2996	uint32_t orgOffsetPatchMem = ~0;
2997	#ifdef LOG_ENABLED
2998	bool disret;
2999	DISCPUSTATE cpu;
3000	uint32_t opsize;
3001	char szOutput[256];
3002	#endif
3003
3004	// save original offset (in case of failures later on)
3005	orgOffsetPatchMem = pVM->patm.s.offPatchMem;
3006
3007	pPatch->pPatchBlockOffset = pVM->patm.s.offPatchMem;
3008	pPatch->uCurPatchOffset = 0;
3009	pPatch->nrPatch2GuestRecs = 0;
3010
3011	#ifdef VBOX_WITH_STATISTICS
3012	rc = patmPatchGenStats(pVM, pPatch, pInstrGC);
3013	if (VBOX_FAILURE(rc))
3014	goto failure;
3015	#endif
3016
3017	rc = patmPatchGenTrapEntry(pVM, pPatch, pInstrGC);
3018	if (VBOX_FAILURE(rc))
3019	goto failure;
3020
3021	/* size of patch block */
3022	pPatch->cbPatchBlockSize = pPatch->uCurPatchOffset;
3023
3024	/* Update free pointer in patch memory. */
3025	pVM->patm.s.offPatchMem += pPatch->cbPatchBlockSize;
3026	/* Round to next 8 byte boundary */
3027	pVM->patm.s.offPatchMem = RT_ALIGN_32(pVM->patm.s.offPatchMem, 8);
3028
3029	/* There's no jump from guest to patch code. */
3030	pPatch->cbPatchJump = 0;
3031
3032	#ifdef LOG_ENABLED
3033	Log(("Patch code ----------------------------------------------------------\n"));
3034	patmr3DisasmCodeStream(pVM, PATCHCODE_PTR_GC(pPatch), PATCHCODE_PTR_GC(pPatch), patmr3DisasmCallback, pPatch);
3035	Log(("Patch code ends -----------------------------------------------------\n"));
3036	#endif
3037
3038	#ifdef LOG_ENABLED
3039	cpu.mode = (pPatch->flags & PATMFL_CODE32) ? CPUMODE_32BIT : CPUMODE_16BIT;
3040	disret = PATMR3DISInstr(pVM, pPatch, &cpu, pPatch->pPrivInstrGC, pPatch->pPrivInstrHC, &opsize, szOutput);
3041	Log(("TRAP handler patch: %s", szOutput));
3042	#endif
3043	Log(("Successfully installed Trap Trampoline patch at %VGv\n", pInstrGC));
3044
3045	/*
3046	* Insert into patch to guest lookup tree
3047	*/
3048	LogFlow(("Insert %VGv patch offset %VGv\n", pPatchRec->patch.pPrivInstrGC, pPatch->pPatchBlockOffset));
3049	pPatchRec->CoreOffset.Key = pPatch->pPatchBlockOffset;
3050	rc = RTAvloGCPtrInsert(&pVM->patm.s.PatchLookupTreeHC->PatchTreeByPatchAddr, &pPatchRec->CoreOffset);
3051	AssertMsg(rc, ("RTAvlULInsert failed for %x\n", pPatchRec->CoreOffset.Key));
3052
3053	pPatch->uState = PATCH_ENABLED;
3054	return VINF_SUCCESS;
3055
3056	failure:
3057	AssertMsgFailed(("Failed to install trap handler trampoline!!\n"));
3058
3059	/* Turn this cli patch into a dummy. */
3060	pPatch->uState = PATCH_REFUSED;
3061	pPatch->pPatchBlockOffset = 0;
3062
3063	/* Give back the patch memory we no longer need */
3064	Assert(orgOffsetPatchMem != (uint32_t)~0);
3065	pVM->patm.s.offPatchMem = orgOffsetPatchMem;
3066
3067	return rc;
3068	}
3069
3070
3071	#ifdef DEBUG
3072	/**
3073	* Check if the instruction is patched as a common idt handler
3074	*
3075	* @returns true or false
3076	* @param pVM The VM to operate on.
3077	* @param pInstrGC Guest context point to the instruction
3078	*
3079	*/
3080	static bool patmIsCommonIDTHandlerPatch(PVM pVM, RTGCPTR pInstrGC)
3081	{
3082	PPATMPATCHREC pRec;
3083
3084	pRec = (PPATMPATCHREC)RTAvloGCPtrGet(&pVM->patm.s.PatchLookupTreeHC->PatchTree, pInstrGC);
3085	if (pRec && pRec->patch.flags & PATMFL_IDTHANDLER_WITHOUT_ENTRYPOINT)
3086	return true;
3087	return false;
3088	}
3089	#endif //DEBUG
3090
3091
3092	/**
3093	* Duplicates a complete function
3094	*
3095	* @returns VBox status code.
3096	* @param pVM The VM to operate on.
3097	* @param pInstrGC Guest context point to privileged instruction
3098	* @param pPatchRec Patch record
3099	*
3100	*/
3101	static int patmDuplicateFunction(PVM pVM, RTGCPTR pInstrGC, PPATMPATCHREC pPatchRec)
3102	{
3103	PPATCHINFO pPatch = &pPatchRec->patch;
3104	int rc = VERR_PATCHING_REFUSED;
3105	DISCPUSTATE cpu;
3106	uint32_t orgOffsetPatchMem = ~0;
3107
3108	Log(("patmDuplicateFunction %VGv\n", pInstrGC));
3109	/* Save original offset (in case of failures later on). */
3110	orgOffsetPatchMem = pVM->patm.s.offPatchMem;
3111
3112	/* We will not go on indefinitely with call instruction handling. */
3113	if (pVM->patm.s.ulCallDepth > PATM_MAX_CALL_DEPTH)
3114	{
3115	Log(("patmDuplicateFunction: maximum callback depth reached!!\n"));
3116	return VERR_PATCHING_REFUSED;
3117	}
3118
3119	pVM->patm.s.ulCallDepth++;
3120
3121	#ifdef PATM_ENABLE_CALL
3122	pPatch->flags \|= PATMFL_SUPPORT_CALLS \| PATMFL_SUPPORT_INDIRECT_CALLS;
3123	#endif
3124
3125	Assert(pPatch->flags & (PATMFL_DUPLICATE_FUNCTION));
3126
3127	pPatch->nrPatch2GuestRecs = 0;
3128	pPatch->pPatchBlockOffset = pVM->patm.s.offPatchMem;
3129	pPatch->uCurPatchOffset = 0;
3130
3131	cpu.mode = (pPatch->flags & PATMFL_CODE32) ? CPUMODE_32BIT : CPUMODE_16BIT;
3132
3133	/** @note Set the PATM interrupt flag here; it was cleared before the patched call. (!!!) */
3134	rc = patmPatchGenSetPIF(pVM, pPatch, pInstrGC);
3135	if (VBOX_FAILURE(rc))
3136	goto failure;
3137
3138	#ifdef VBOX_WITH_STATISTICS
3139	rc = patmPatchGenStats(pVM, pPatch, pInstrGC);
3140	if (VBOX_FAILURE(rc))
3141	goto failure;
3142	#endif
3143	rc = patmRecompileCodeStream(pVM, pInstrGC, pInstrGC, patmRecompileCallback, pPatch);
3144	if (rc != VINF_SUCCESS)
3145	{
3146	Log(("PATMR3PatchCli: patmRecompileCodeStream failed with %d\n", rc));
3147	goto failure;
3148	}
3149
3150	//size of patch block
3151	pPatch->cbPatchBlockSize = pPatch->uCurPatchOffset;
3152
3153	//update free pointer in patch memory
3154	pVM->patm.s.offPatchMem += pPatch->cbPatchBlockSize;
3155	/* Round to next 8 byte boundary. */
3156	pVM->patm.s.offPatchMem = RT_ALIGN_32(pVM->patm.s.offPatchMem, 8);
3157
3158	pPatch->uState = PATCH_ENABLED;
3159
3160	/*
3161	* Insert into patch to guest lookup tree
3162	*/
3163	LogFlow(("Insert %VGv patch offset %VGv\n", pPatchRec->patch.pPrivInstrGC, pPatch->pPatchBlockOffset));
3164	pPatchRec->CoreOffset.Key = pPatch->pPatchBlockOffset;
3165	rc = RTAvloGCPtrInsert(&pVM->patm.s.PatchLookupTreeHC->PatchTreeByPatchAddr, &pPatchRec->CoreOffset);
3166	AssertMsg(rc, ("RTAvloGCPtrInsert failed for %x\n", pPatchRec->CoreOffset.Key));
3167	if (!rc)
3168	{
3169	rc = VERR_PATCHING_REFUSED;
3170	goto failure;
3171	}
3172
3173	/* Note that patmr3SetBranchTargets can install additional patches!! */
3174	rc = patmr3SetBranchTargets(pVM, pPatch);
3175	if (rc != VINF_SUCCESS)
3176	{
3177	Log(("PATMR3PatchCli: patmr3SetBranchTargets failed with %d\n", rc));
3178	goto failure;
3179	}
3180
3181	#ifdef LOG_ENABLED
3182	Log(("Patch code ----------------------------------------------------------\n"));
3183	patmr3DisasmCodeStream(pVM, PATCHCODE_PTR_GC(pPatch), PATCHCODE_PTR_GC(pPatch), patmr3DisasmCallback, pPatch);
3184	Log(("Patch code ends -----------------------------------------------------\n"));
3185	#endif
3186
3187	Log(("Successfully installed function duplication patch at %VGv\n", pInstrGC));
3188
3189	patmEmptyTree(pVM, &pPatch->pTempInfo->IllegalInstrTree);
3190	pPatch->pTempInfo->nrIllegalInstr = 0;
3191
3192	pVM->patm.s.ulCallDepth--;
3193	STAM_COUNTER_INC(&pVM->patm.s.StatInstalledFunctionPatches);
3194	return VINF_SUCCESS;
3195
3196	failure:
3197	if (pPatchRec->CoreOffset.Key)
3198	RTAvloGCPtrRemove(&pVM->patm.s.PatchLookupTreeHC->PatchTreeByPatchAddr, pPatchRec->CoreOffset.Key);
3199
3200	patmEmptyTree(pVM, &pPatch->FixupTree);
3201	pPatch->nrFixups = 0;
3202
3203	patmEmptyTree(pVM, &pPatch->JumpTree);
3204	pPatch->nrJumpRecs = 0;
3205
3206	patmEmptyTree(pVM, &pPatch->pTempInfo->IllegalInstrTree);
3207	pPatch->pTempInfo->nrIllegalInstr = 0;
3208
3209	/* Turn this cli patch into a dummy. */
3210	pPatch->uState = PATCH_REFUSED;
3211	pPatch->pPatchBlockOffset = 0;
3212
3213	// Give back the patch memory we no longer need
3214	Assert(orgOffsetPatchMem != (uint32_t)~0);
3215	pVM->patm.s.offPatchMem = orgOffsetPatchMem;
3216
3217	pVM->patm.s.ulCallDepth--;
3218	Log(("patmDupicateFunction %VGv failed!!\n", pInstrGC));
3219	return rc;
3220	}
3221
3222	/**
3223	* Creates trampoline code to jump inside an existing patch
3224	*
3225	* @returns VBox status code.
3226	* @param pVM The VM to operate on.
3227	* @param pInstrGC Guest context point to privileged instruction
3228	* @param pPatchRec Patch record
3229	*
3230	*/
3231	static int patmCreateTrampoline(PVM pVM, RTGCPTR pInstrGC, PPATMPATCHREC pPatchRec)
3232	{
3233	PPATCHINFO pPatch = &pPatchRec->patch;
3234	RTGCPTR pPage, pPatchTargetGC = 0;
3235	uint32_t orgOffsetPatchMem = ~0;
3236	int rc = VERR_PATCHING_REFUSED;
3237
3238	Log(("patmCreateTrampoline %VGv\n", pInstrGC));
3239	/* Save original offset (in case of failures later on). */
3240	orgOffsetPatchMem = pVM->patm.s.offPatchMem;
3241
3242	/* First we check if the duplicate function target lies in some existing function patch already. Will save some space. */
3243	/** @todo we already checked this before */
3244	pPage = pInstrGC & PAGE_BASE_GC_MASK;
3245
3246	PPATMPATCHPAGE pPatchPage = (PPATMPATCHPAGE)RTAvloGCPtrGet(&pVM->patm.s.PatchLookupTreeHC->PatchTreeByPage, (RTGCPTR)pPage);
3247	if (pPatchPage)
3248	{
3249	uint32_t i;
3250
3251	for (i=0;i<pPatchPage->cCount;i++)
3252	{
3253	if (pPatchPage->aPatch[i])
3254	{
3255	PPATCHINFO pPatch = pPatchPage->aPatch[i];
3256
3257	if ( (pPatch->flags & PATMFL_DUPLICATE_FUNCTION)
3258	&& pPatch->uState == PATCH_ENABLED)
3259	{
3260	pPatchTargetGC = patmGuestGCPtrToPatchGCPtr(pVM, pPatch, pInstrGC);
3261	if (pPatchTargetGC)
3262	{
3263	uint32_t offsetPatch = pPatchTargetGC - pVM->patm.s.pPatchMemGC;
3264	PRECPATCHTOGUEST pPatchToGuestRec = (PRECPATCHTOGUEST)RTAvlU32GetBestFit(&pPatch->Patch2GuestAddrTree, offsetPatch, false);
3265	Assert(pPatchToGuestRec);
3266
3267	pPatchToGuestRec->fJumpTarget = true;
3268	Assert(pPatchTargetGC != pPatch->pPrivInstrGC);
3269	Log(("patmCreateTrampoline: generating jump to code inside patch at %VGv\n", pPatch->pPrivInstrGC));
3270	pPatch->flags \|= PATMFL_EXTERNAL_JUMP_INSIDE;
3271	break;
3272	}
3273	}
3274	}
3275	}
3276	}
3277	AssertReturn(pPatchPage && pPatchTargetGC, VERR_PATCHING_REFUSED);
3278
3279	pPatch->nrPatch2GuestRecs = 0;
3280	pPatch->pPatchBlockOffset = pVM->patm.s.offPatchMem;
3281	pPatch->uCurPatchOffset = 0;
3282
3283	/** @note Set the PATM interrupt flag here; it was cleared before the patched call. (!!!) */
3284	rc = patmPatchGenSetPIF(pVM, pPatch, pInstrGC);
3285	if (VBOX_FAILURE(rc))
3286	goto failure;
3287
3288	#ifdef VBOX_WITH_STATISTICS
3289	rc = patmPatchGenStats(pVM, pPatch, pInstrGC);
3290	if (VBOX_FAILURE(rc))
3291	goto failure;
3292	#endif
3293
3294	rc = patmPatchGenPatchJump(pVM, pPatch, pInstrGC, pPatchTargetGC);
3295	if (VBOX_FAILURE(rc))
3296	goto failure;
3297
3298	/*
3299	* Insert into patch to guest lookup tree
3300	*/
3301	LogFlow(("Insert %VGv patch offset %VGv\n", pPatchRec->patch.pPrivInstrGC, pPatch->pPatchBlockOffset));
3302	pPatchRec->CoreOffset.Key = pPatch->pPatchBlockOffset;
3303	rc = RTAvloGCPtrInsert(&pVM->patm.s.PatchLookupTreeHC->PatchTreeByPatchAddr, &pPatchRec->CoreOffset);
3304	AssertMsg(rc, ("RTAvloGCPtrInsert failed for %x\n", pPatchRec->CoreOffset.Key));
3305	if (!rc)
3306	{
3307	rc = VERR_PATCHING_REFUSED;
3308	goto failure;
3309	}
3310
3311	/* size of patch block */
3312	pPatch->cbPatchBlockSize = pPatch->uCurPatchOffset;
3313
3314	/* Update free pointer in patch memory. */
3315	pVM->patm.s.offPatchMem += pPatch->cbPatchBlockSize;
3316	/* Round to next 8 byte boundary */
3317	pVM->patm.s.offPatchMem = RT_ALIGN_32(pVM->patm.s.offPatchMem, 8);
3318
3319	/* There's no jump from guest to patch code. */
3320	pPatch->cbPatchJump = 0;
3321
3322	/* Enable the patch. */
3323	pPatch->uState = PATCH_ENABLED;
3324	/* We allow this patch to be called as a function. */
3325	pPatch->flags \|= PATMFL_CALLABLE_AS_FUNCTION;
3326	STAM_COUNTER_INC(&pVM->patm.s.StatInstalledTrampoline);
3327	return VINF_SUCCESS;
3328
3329	failure:
3330	if (pPatchRec->CoreOffset.Key)
3331	RTAvloGCPtrRemove(&pVM->patm.s.PatchLookupTreeHC->PatchTreeByPatchAddr, pPatchRec->CoreOffset.Key);
3332
3333	patmEmptyTree(pVM, &pPatch->FixupTree);
3334	pPatch->nrFixups = 0;
3335
3336	patmEmptyTree(pVM, &pPatch->JumpTree);
3337	pPatch->nrJumpRecs = 0;
3338
3339	patmEmptyTree(pVM, &pPatch->pTempInfo->IllegalInstrTree);
3340	pPatch->pTempInfo->nrIllegalInstr = 0;
3341
3342	/* Turn this cli patch into a dummy. */
3343	pPatch->uState = PATCH_REFUSED;
3344	pPatch->pPatchBlockOffset = 0;
3345
3346	// Give back the patch memory we no longer need
3347	Assert(orgOffsetPatchMem != (uint32_t)~0);
3348	pVM->patm.s.offPatchMem = orgOffsetPatchMem;
3349
3350	return rc;
3351	}
3352
3353
3354	/**
3355	* Patch branch target function for call/jump at specified location.
3356	* (in responds to a VINF_PATM_DUPLICATE_FUNCTION GC exit reason)
3357	*
3358	* @returns VBox status code.
3359	* @param pVM The VM to operate on.
3360	* @param pCtx Guest context
3361	*
3362	*/
3363	PATMR3DECL(int) PATMR3DuplicateFunctionRequest(PVM pVM, PCPUMCTX pCtx)
3364	{
3365	RTGCPTR pBranchTarget, pPage;
3366	int rc;
3367	RTGCPTR pPatchTargetGC = 0;
3368
3369	pBranchTarget = pCtx->edx;
3370	pBranchTarget = SELMToFlat(pVM, pCtx->eflags, pCtx->cs, &pCtx->csHid, pBranchTarget);
3371
3372	/* First we check if the duplicate function target lies in some existing function patch already. Will save some space. */
3373	pPage = pBranchTarget & PAGE_BASE_GC_MASK;
3374
3375	PPATMPATCHPAGE pPatchPage = (PPATMPATCHPAGE)RTAvloGCPtrGet(&pVM->patm.s.PatchLookupTreeHC->PatchTreeByPage, (RTGCPTR)pPage);
3376	if (pPatchPage)
3377	{
3378	uint32_t i;
3379
3380	for (i=0;i<pPatchPage->cCount;i++)
3381	{
3382	if (pPatchPage->aPatch[i])
3383	{
3384	PPATCHINFO pPatch = pPatchPage->aPatch[i];
3385
3386	if ( (pPatch->flags & PATMFL_DUPLICATE_FUNCTION)
3387	&& pPatch->uState == PATCH_ENABLED)
3388	{
3389	pPatchTargetGC = patmGuestGCPtrToPatchGCPtr(pVM, pPatch, pBranchTarget);
3390	if (pPatchTargetGC)
3391	{
3392	STAM_COUNTER_INC(&pVM->patm.s.StatDuplicateUseExisting);
3393	break;
3394	}
3395	}
3396	}
3397	}
3398	}
3399
3400	if (pPatchTargetGC)
3401	{
3402	/* Create a trampoline that also sets PATM_INTERRUPTFLAG. */
3403	rc = PATMR3InstallPatch(pVM, pBranchTarget, PATMFL_CODE32 \| PATMFL_TRAMPOLINE);
3404	}
3405	else
3406	{
3407	rc = PATMR3InstallPatch(pVM, pBranchTarget, PATMFL_CODE32 \| PATMFL_DUPLICATE_FUNCTION);
3408	}
3409
3410	if (rc == VINF_SUCCESS)
3411	{
3412	pPatchTargetGC = PATMR3QueryPatchGCPtr(pVM, pBranchTarget);
3413	Assert(pPatchTargetGC);
3414	}
3415
3416	if (pPatchTargetGC)
3417	{
3418	pCtx->eax = pPatchTargetGC;
3419	pCtx->eax = pCtx->eax - (RTGCUINTPTR)pVM->patm.s.pPatchMemGC; /* make it relative */
3420	}
3421	else
3422	{
3423	/* We add a dummy entry into the lookup cache so we won't get bombarded with the same requests over and over again. */
3424	pCtx->eax = 0;
3425	STAM_COUNTER_INC(&pVM->patm.s.StatDuplicateREQFailed);
3426	}
3427	Assert(PATMIsPatchGCAddr(pVM, pCtx->edi));
3428	rc = PATMAddBranchToLookupCache(pVM, pCtx->edi, pBranchTarget, pCtx->eax);
3429	AssertRC(rc);
3430
3431	pCtx->eip += PATM_ILLEGAL_INSTR_SIZE;
3432	STAM_COUNTER_INC(&pVM->patm.s.StatDuplicateREQSuccess);
3433	return VINF_SUCCESS;
3434	}
3435
3436	/**
3437	* Replaces a function call by a call to an existing function duplicate (or jmp -> jmp)
3438	*
3439	* @returns VBox status code.
3440	* @param pVM The VM to operate on.
3441	* @param pCpu Disassembly CPU structure ptr
3442	* @param pInstrGC Guest context point to privileged instruction
3443	* @param pPatch Patch record
3444	*
3445	*/
3446	static int patmReplaceFunctionCall(PVM pVM, DISCPUSTATE *pCpu, RTGCPTR pInstrGC, PPATCHINFO pPatch)
3447	{
3448	int rc = VERR_PATCHING_REFUSED;
3449	DISCPUSTATE cpu;
3450	RTGCPTR pTargetGC;
3451	PPATMPATCHREC pPatchFunction;
3452	uint32_t opsize;
3453	bool disret;
3454	#ifdef LOG_ENABLED
3455	char szOutput[256];
3456	#endif
3457
3458	Assert(pPatch->flags & PATMFL_REPLACE_FUNCTION_CALL);
3459	Assert((pCpu->pCurInstr->opcode == OP_CALL \|\| pCpu->pCurInstr->opcode == OP_JMP) && pCpu->opsize == SIZEOF_NEARJUMP32);
3460
3461	if ((pCpu->pCurInstr->opcode != OP_CALL && pCpu->pCurInstr->opcode != OP_JMP) \|\| pCpu->opsize != SIZEOF_NEARJUMP32)
3462	{
3463	rc = VERR_PATCHING_REFUSED;
3464	goto failure;
3465	}
3466
3467	pTargetGC = PATMResolveBranch(pCpu, pInstrGC);
3468	if (pTargetGC == 0)
3469	{
3470	Log(("We don't support far jumps here!! (%08X)\n", pCpu->param1.flags));
3471	rc = VERR_PATCHING_REFUSED;
3472	goto failure;
3473	}
3474
3475	pPatchFunction = (PPATMPATCHREC)RTAvloGCPtrGet(&pVM->patm.s.PatchLookupTreeHC->PatchTree, pTargetGC);
3476	if (pPatchFunction == NULL)
3477	{
3478	for(;;)
3479	{
3480	/* It could be an indirect call (call -> jmp dest).
3481	* Note that it's dangerous to assume the jump will never change...
3482	*/
3483	uint8_t *pTmpInstrHC;
3484
3485	pTmpInstrHC = PATMGCVirtToHCVirt(pVM, pPatch, pTargetGC);
3486	Assert(pTmpInstrHC);
3487	if (pTmpInstrHC == 0)
3488	break;
3489
3490	cpu.mode = (pPatch->flags & PATMFL_CODE32) ? CPUMODE_32BIT : CPUMODE_16BIT;
3491	disret = PATMR3DISInstr(pVM, pPatch, &cpu, pTargetGC, pTmpInstrHC, &opsize, NULL);
3492	if (disret == false \|\| cpu.pCurInstr->opcode != OP_JMP)
3493	break;
3494
3495	pTargetGC = PATMResolveBranch(&cpu, pTargetGC);
3496	if (pTargetGC == 0)
3497	{
3498	break;
3499	}
3500
3501	pPatchFunction = (PPATMPATCHREC)RTAvloGCPtrGet(&pVM->patm.s.PatchLookupTreeHC->PatchTree, pTargetGC);
3502	break;
3503	}
3504	if (pPatchFunction == 0)
3505	{
3506	AssertMsgFailed(("Unable to find duplicate function %VGv\n", pTargetGC));
3507	rc = VERR_PATCHING_REFUSED;
3508	goto failure;
3509	}
3510	}
3511
3512	// make a copy of the guest code bytes that will be overwritten
3513	pPatch->cbPatchJump = SIZEOF_NEARJUMP32;
3514
3515	rc = PGMPhysReadGCPtr(pVM, pPatch->aPrivInstr, pPatch->pPrivInstrGC, pPatch->cbPatchJump);
3516	AssertRC(rc);
3517
3518	/* Now replace the original call in the guest code */
3519	rc = patmGenCallToPatch(pVM, pPatch, PATCHCODE_PTR_GC(&pPatchFunction->patch), true);
3520	AssertRC(rc);
3521	if (VBOX_FAILURE(rc))
3522	goto failure;
3523
3524	/* Lowest and highest address for write monitoring. */
3525	pPatch->pInstrGCLowest = pInstrGC;
3526	pPatch->pInstrGCHighest = pInstrGC + pCpu->opsize;
3527
3528	#ifdef LOG_ENABLED
3529	cpu.mode = (pPatch->flags & PATMFL_CODE32) ? CPUMODE_32BIT : CPUMODE_16BIT;
3530	disret = PATMR3DISInstr(pVM, pPatch, &cpu, pPatch->pPrivInstrGC, pPatch->pPrivInstrHC, &opsize, szOutput);
3531	Log(("Call patch: %s", szOutput));
3532	#endif
3533
3534	Log(("Successfully installed function replacement patch at %VGv\n", pInstrGC));
3535
3536	pPatch->uState = PATCH_ENABLED;
3537	return VINF_SUCCESS;
3538
3539	failure:
3540	/* Turn this patch into a dummy. */
3541	pPatch->uState = PATCH_REFUSED;
3542
3543	return rc;
3544	}
3545
3546	/**
3547	* Replace the address in an MMIO instruction with the cached version.
3548	*
3549	* @returns VBox status code.
3550	* @param pVM The VM to operate on.
3551	* @param pInstrGC Guest context point to privileged instruction
3552	* @param pCpu Disassembly CPU structure ptr
3553	* @param pPatch Patch record
3554	*
3555	* @note returns failure if patching is not allowed or possible
3556	*
3557	*/
3558	static int patmPatchMMIOInstr(PVM pVM, RTGCPTR pInstrGC, DISCPUSTATE *pCpu, PPATCHINFO pPatch)
3559	{
3560	uint8_t *pPB;
3561	int rc = VERR_PATCHING_REFUSED;
3562	#ifdef LOG_ENABLED
3563	DISCPUSTATE cpu;
3564	uint32_t opsize;
3565	bool disret;
3566	char szOutput[256];
3567	#endif
3568
3569	Assert(pVM->patm.s.mmio.pCachedData);
3570	if (!pVM->patm.s.mmio.pCachedData)
3571	goto failure;
3572
3573	if (pCpu->param2.flags != USE_DISPLACEMENT32)
3574	goto failure;
3575
3576	pPB = pPatch->pPrivInstrHC;
3577
3578	/* Add relocation record for cached data access. */
3579	if (patmPatchAddReloc32(pVM, pPatch, &pPB[pCpu->opsize - sizeof(RTGCPTR)], FIXUP_ABSOLUTE, pPatch->pPrivInstrGC, pVM->patm.s.mmio.pCachedData) != VINF_SUCCESS)
3580	{
3581	Log(("Relocation failed for cached mmio address!!\n"));
3582	return VERR_PATCHING_REFUSED;
3583	}
3584	#ifdef LOG_ENABLED
3585	cpu.mode = (pPatch->flags & PATMFL_CODE32) ? CPUMODE_32BIT : CPUMODE_16BIT;
3586	disret = PATMR3DISInstr(pVM, pPatch, &cpu, pPatch->pPrivInstrGC, pPatch->pPrivInstrHC, &opsize, szOutput);
3587	Log(("MMIO patch old instruction: %s", szOutput));
3588	#endif
3589
3590	/* Save original instruction. */
3591	rc = PGMPhysReadGCPtr(pVM, pPatch->aPrivInstr, pPatch->pPrivInstrGC, pPatch->cbPrivInstr);
3592	AssertRC(rc);
3593
3594	pPatch->cbPatchJump = pPatch->cbPrivInstr; /* bit of a misnomer in this case; size of replacement instruction. */
3595
3596	/* Replace address with that of the cached item. */
3597	rc = PGMPhysWriteGCPtrDirty(pVM, pInstrGC + pCpu->opsize - sizeof(RTGCPTR), &pVM->patm.s.mmio.pCachedData, sizeof(RTGCPTR));
3598	AssertRC(rc);
3599	if (VBOX_FAILURE(rc))
3600	{
3601	goto failure;
3602	}
3603
3604	#ifdef LOG_ENABLED
3605	cpu.mode = (pPatch->flags & PATMFL_CODE32) ? CPUMODE_32BIT : CPUMODE_16BIT;
3606	disret = PATMR3DISInstr(pVM, pPatch, &cpu, pPatch->pPrivInstrGC, pPatch->pPrivInstrHC, &opsize, szOutput);
3607	Log(("MMIO patch: %s", szOutput));
3608	#endif
3609	pVM->patm.s.mmio.pCachedData = 0;
3610	pVM->patm.s.mmio.GCPhys = 0;
3611	pPatch->uState = PATCH_ENABLED;
3612	return VINF_SUCCESS;
3613
3614	failure:
3615	/* Turn this patch into a dummy. */
3616	pPatch->uState = PATCH_REFUSED;
3617
3618	return rc;
3619	}
3620
3621
3622	/**
3623	* Replace the address in an MMIO instruction with the cached version. (instruction is part of an existing patch)
3624	*
3625	* @returns VBox status code.
3626	* @param pVM The VM to operate on.
3627	* @param pInstrGC Guest context point to privileged instruction
3628	* @param pPatch Patch record
3629	*
3630	* @note returns failure if patching is not allowed or possible
3631	*
3632	*/
3633	static int patmPatchPATMMMIOInstr(PVM pVM, RTGCPTR pInstrGC, PPATCHINFO pPatch)
3634	{
3635	DISCPUSTATE cpu;
3636	uint32_t opsize;
3637	bool disret;
3638	uint8_t *pInstrHC;
3639	#ifdef LOG_ENABLED
3640	char szOutput[256];
3641	#endif
3642
3643	AssertReturn(pVM->patm.s.mmio.pCachedData, VERR_INVALID_PARAMETER);
3644
3645	/* Convert GC to HC address. */
3646	pInstrHC = patmPatchGCPtr2PatchHCPtr(pVM, pInstrGC);
3647	AssertReturn(pInstrHC, VERR_PATCHING_REFUSED);
3648
3649	/* Disassemble mmio instruction. */
3650	cpu.mode = pPatch->uOpMode;
3651	disret = PATMR3DISInstr(pVM, pPatch, &cpu, pInstrGC, pInstrHC, &opsize, NULL);
3652	if (disret == false)
3653	{
3654	Log(("Disassembly failed (probably page not present) -> return to caller\n"));
3655	return VERR_PATCHING_REFUSED;
3656	}
3657
3658	AssertMsg(opsize <= MAX_INSTR_SIZE, ("privileged instruction too big %d!!\n", opsize));
3659	if (opsize > MAX_INSTR_SIZE)
3660	return VERR_PATCHING_REFUSED;
3661	if (cpu.param2.flags != USE_DISPLACEMENT32)
3662	return VERR_PATCHING_REFUSED;
3663
3664	/* Add relocation record for cached data access. */
3665	if (patmPatchAddReloc32(pVM, pPatch, &pInstrHC[cpu.opsize - sizeof(RTGCPTR)], FIXUP_ABSOLUTE) != VINF_SUCCESS)
3666	{
3667	Log(("Relocation failed for cached mmio address!!\n"));
3668	return VERR_PATCHING_REFUSED;
3669	}
3670	/* Replace address with that of the cached item. */
3671	(RTGCPTR )&pInstrHC[cpu.opsize - sizeof(RTGCPTR)] = pVM->patm.s.mmio.pCachedData;
3672
3673	/* Lowest and highest address for write monitoring. */
3674	pPatch->pInstrGCLowest = pInstrGC;
3675	pPatch->pInstrGCHighest = pInstrGC + cpu.opsize;
3676
3677	#ifdef LOG_ENABLED
3678	cpu.mode = (pPatch->flags & PATMFL_CODE32) ? CPUMODE_32BIT : CPUMODE_16BIT;
3679	disret = PATMR3DISInstr(pVM, pPatch, &cpu, pInstrGC, pInstrHC, &opsize, szOutput);
3680	Log(("MMIO patch: %s", szOutput));
3681	#endif
3682
3683	pVM->patm.s.mmio.pCachedData = 0;
3684	pVM->patm.s.mmio.GCPhys = 0;
3685	return VINF_SUCCESS;
3686	}
3687
3688	/**
3689	* Activates an int3 patch
3690	*
3691	* @returns VBox status code.
3692	* @param pVM The VM to operate on.
3693	* @param pPatch Patch record
3694	*/
3695	static int patmActivateInt3Patch(PVM pVM, PPATCHINFO pPatch)
3696	{
3697	uint8_t ASMInt3 = 0xCC;
3698	int rc;
3699
3700	Assert(pPatch->flags & (PATMFL_INT3_REPLACEMENT\|PATMFL_INT3_REPLACEMENT_BLOCK));
3701	Assert(pPatch->uState != PATCH_ENABLED);
3702
3703	/* Replace first opcode byte with 'int 3'. */
3704	rc = PGMPhysWriteGCPtrDirty(pVM, pPatch->pPrivInstrGC, &ASMInt3, sizeof(ASMInt3));
3705	AssertRC(rc);
3706
3707	pPatch->cbPatchJump = sizeof(ASMInt3);
3708
3709	return rc;
3710	}
3711
3712	/**
3713	* Deactivates an int3 patch
3714	*
3715	* @returns VBox status code.
3716	* @param pVM The VM to operate on.
3717	* @param pPatch Patch record
3718	*/
3719	static int patmDeactivateInt3Patch(PVM pVM, PPATCHINFO pPatch)
3720	{
3721	uint8_t ASMInt3 = 0xCC;
3722	int rc;
3723
3724	Assert(pPatch->flags & (PATMFL_INT3_REPLACEMENT\|PATMFL_INT3_REPLACEMENT_BLOCK));
3725	Assert(pPatch->uState == PATCH_ENABLED \|\| pPatch->uState == PATCH_DIRTY);
3726
3727	/* Restore first opcode byte. */
3728	rc = PGMPhysWriteGCPtrDirty(pVM, pPatch->pPrivInstrGC, pPatch->aPrivInstr, sizeof(ASMInt3));
3729	AssertRC(rc);
3730	return rc;
3731	}
3732
3733	/**
3734	* Replace an instruction with a breakpoint (0xCC), that is handled dynamically in the guest context.
3735	*
3736	* @returns VBox status code.
3737	* @param pVM The VM to operate on.
3738	* @param pInstrGC Guest context point to privileged instruction
3739	* @param pInstrHC Host context point to privileged instruction
3740	* @param pCpu Disassembly CPU structure ptr
3741	* @param pPatch Patch record
3742	*
3743	* @note returns failure if patching is not allowed or possible
3744	*
3745	*/
3746	PATMR3DECL(int) PATMR3PatchInstrInt3(PVM pVM, RTGCPTR pInstrGC, HCPTRTYPE(uint8_t ) pInstrHC, DISCPUSTATE pCpu, PPATCHINFO pPatch)
3747	{
3748	uint8_t ASMInt3 = 0xCC;
3749	int rc;
3750
3751	/** @note Do not use patch memory here! It might called during patch installation too. */
3752
3753	#ifdef LOG_ENABLED
3754	DISCPUSTATE cpu;
3755	char szOutput[256];
3756	uint32_t opsize;
3757
3758	cpu.mode = (pPatch->flags & PATMFL_CODE32) ? CPUMODE_32BIT : CPUMODE_16BIT;
3759	PATMR3DISInstr(pVM, pPatch, &cpu, pInstrGC, pInstrHC, &opsize, szOutput);
3760	Log(("PATMR3PatchInstrInt3: %s", szOutput));
3761	#endif
3762
3763	/* Save the original instruction. */
3764	rc = PGMPhysReadGCPtr(pVM, pPatch->aPrivInstr, pPatch->pPrivInstrGC, pPatch->cbPrivInstr);
3765	AssertRC(rc);
3766	pPatch->cbPatchJump = sizeof(ASMInt3); /* bit of a misnomer in this case; size of replacement instruction. */
3767
3768	pPatch->flags \|= PATMFL_INT3_REPLACEMENT;
3769
3770	/* Replace first opcode byte with 'int 3'. */
3771	rc = patmActivateInt3Patch(pVM, pPatch);
3772	if (VBOX_FAILURE(rc))
3773	goto failure;
3774
3775	/* Lowest and highest address for write monitoring. */
3776	pPatch->pInstrGCLowest = pInstrGC;
3777	pPatch->pInstrGCHighest = pInstrGC + pCpu->opsize;
3778
3779	pPatch->uState = PATCH_ENABLED;
3780	return VINF_SUCCESS;
3781
3782	failure:
3783	/* Turn this patch into a dummy. */
3784	return VERR_PATCHING_REFUSED;
3785	}
3786
3787	#ifdef PATM_RESOLVE_CONFLICTS_WITH_JUMP_PATCHES
3788	/**
3789	* Patch a jump instruction at specified location
3790	*
3791	* @returns VBox status code.
3792	* @param pVM The VM to operate on.
3793	* @param pInstrGC Guest context point to privileged instruction
3794	* @param pInstrHC Host context point to privileged instruction
3795	* @param pCpu Disassembly CPU structure ptr
3796	* @param pPatchRec Patch record
3797	*
3798	* @note returns failure if patching is not allowed or possible
3799	*
3800	*/
3801	int patmPatchJump(PVM pVM, RTGCPTR pInstrGC, HCPTRTYPE(uint8_t ) pInstrHC, DISCPUSTATE pCpu, PPATMPATCHREC pPatchRec)
3802	{
3803	PPATCHINFO pPatch = &pPatchRec->patch;
3804	int rc = VERR_PATCHING_REFUSED;
3805	#ifdef LOG_ENABLED
3806	bool disret;
3807	DISCPUSTATE cpu;
3808	uint32_t opsize;
3809	char szOutput[256];
3810	#endif
3811
3812	pPatch->pPatchBlockOffset = 0; /* doesn't use patch memory */
3813	pPatch->uCurPatchOffset = 0;
3814	pPatch->cbPatchBlockSize = 0;
3815	pPatch->flags \|= PATMFL_SINGLE_INSTRUCTION;
3816
3817	/*
3818	* Instruction replacements such as these should never be interrupted. I've added code to EM.cpp to
3819	* make sure this never happens. (unless a trap is triggered (intentionally or not))
3820	*/
3821	switch (pCpu->pCurInstr->opcode)
3822	{
3823	case OP_JO:
3824	case OP_JNO:
3825	case OP_JC:
3826	case OP_JNC:
3827	case OP_JE:
3828	case OP_JNE:
3829	case OP_JBE:
3830	case OP_JNBE:
3831	case OP_JS:
3832	case OP_JNS:
3833	case OP_JP:
3834	case OP_JNP:
3835	case OP_JL:
3836	case OP_JNL:
3837	case OP_JLE:
3838	case OP_JNLE:
3839	case OP_JMP:
3840	Assert(pPatch->flags & PATMFL_JUMP_CONFLICT);
3841	Assert(pCpu->param1.flags & USE_IMMEDIATE32_REL);
3842	if (!(pCpu->param1.flags & USE_IMMEDIATE32_REL))
3843	goto failure;
3844
3845	Assert(pCpu->opsize == SIZEOF_NEARJUMP32 \|\| pCpu->opsize == SIZEOF_NEAR_COND_JUMP32);
3846	if (pCpu->opsize != SIZEOF_NEARJUMP32 && pCpu->opsize != SIZEOF_NEAR_COND_JUMP32)
3847	goto failure;
3848
3849	if (PAGE_ADDRESS(pInstrGC) != PAGE_ADDRESS(pInstrGC + pCpu->opsize))
3850	{
3851	STAM_COUNTER_INC(&pVM->patm.s.StatPageBoundaryCrossed);
3852	AssertMsgFailed(("Patch jump would cross page boundary -> refuse!!\n"));
3853	rc = VERR_PATCHING_REFUSED;
3854	goto failure;
3855	}
3856
3857	break;
3858
3859	default:
3860	goto failure;
3861	}
3862
3863	// make a copy of the guest code bytes that will be overwritten
3864	Assert(pCpu->opsize <= sizeof(pPatch->aPrivInstr));
3865	Assert(pCpu->opsize >= SIZEOF_NEARJUMP32);
3866	pPatch->cbPatchJump = pCpu->opsize;
3867
3868	rc = PGMPhysReadGCPtr(pVM, pPatch->aPrivInstr, pPatch->pPrivInstrGC, pPatch->cbPatchJump);
3869	AssertRC(rc);
3870
3871	/* Now insert a jump in the guest code. */
3872	/*
3873	* A conflict jump patch needs to be treated differently; we'll just replace the relative jump address with one that
3874	* references the target instruction in the conflict patch.
3875	*/
3876	RTGCPTR pJmpDest = PATMR3GuestGCPtrToPatchGCPtr(pVM, pInstrGC + pCpu->opsize + (int32_t)pCpu->param1.parval);
3877
3878	AssertMsg(pJmpDest, ("PATMR3GuestGCPtrToPatchGCPtr failed for %VGv\n", pInstrGC + pCpu->opsize + (int32_t)pCpu->param1.parval));
3879	pPatch->pPatchJumpDestGC = pJmpDest;
3880
3881	rc = patmGenJumpToPatch(pVM, pPatch, true);
3882	AssertRC(rc);
3883	if (VBOX_FAILURE(rc))
3884	goto failure;
3885
3886	pPatch->flags \|= PATMFL_MUST_INSTALL_PATCHJMP;
3887
3888	#ifdef LOG_ENABLED
3889	cpu.mode = (pPatch->flags & PATMFL_CODE32) ? CPUMODE_32BIT : CPUMODE_16BIT;
3890	disret = PATMR3DISInstr(pVM, pPatch, &cpu, pPatch->pPrivInstrGC, pPatch->pPrivInstrHC, &opsize, szOutput);
3891	Log(("%s patch: %s", patmGetInstructionString(pPatch->opcode, pPatch->flags), szOutput));
3892	#endif
3893
3894	Log(("Successfully installed %s patch at %VGv\n", patmGetInstructionString(pPatch->opcode, pPatch->flags), pInstrGC));
3895
3896	STAM_COUNTER_INC(&pVM->patm.s.StatInstalledJump);
3897
3898	/* Lowest and highest address for write monitoring. */
3899	pPatch->pInstrGCLowest = pInstrGC;
3900	pPatch->pInstrGCHighest = pInstrGC + pPatch->cbPatchJump;
3901
3902	pPatch->uState = PATCH_ENABLED;
3903	return VINF_SUCCESS;
3904
3905	failure:
3906	/* Turn this cli patch into a dummy. */
3907	pPatch->uState = PATCH_REFUSED;
3908
3909	return rc;
3910	}
3911	#endif /* PATM_RESOLVE_CONFLICTS_WITH_JUMP_PATCHES */
3912
3913
3914	/**
3915	* Gives hint to PATM about supervisor guest instructions
3916	*
3917	* @returns VBox status code.
3918	* @param pVM The VM to operate on.
3919	* @param pInstr Guest context point to privileged instruction
3920	* @param flags Patch flags
3921	*/
3922	PATMR3DECL(int) PATMR3AddHint(PVM pVM, RTGCPTR pInstrGC, uint32_t flags)
3923	{
3924	Assert(pInstrGC);
3925	Assert(flags == PATMFL_CODE32);
3926
3927	Log(("PATMR3AddHint %VGv\n", pInstrGC));
3928	return PATMR3InstallPatch(pVM, pInstrGC, PATMFL_CODE32 \| PATMFL_INSTR_HINT);
3929	}
3930
3931	/**
3932	* Patch privileged instruction at specified location
3933	*
3934	* @returns VBox status code.
3935	* @param pVM The VM to operate on.
3936	* @param pInstr Guest context point to privileged instruction (0:32 flat address)
3937	* @param flags Patch flags
3938	*
3939	* @note returns failure if patching is not allowed or possible
3940	*/
3941	PATMR3DECL(int) PATMR3InstallPatch(PVM pVM, RTGCPTR pInstrGC, uint64_t flags)
3942	{
3943	DISCPUSTATE cpu;
3944	HCPTRTYPE(uint8_t *) pInstrHC;
3945	uint32_t opsize;
3946	PPATMPATCHREC pPatchRec;
3947	PCPUMCTX pCtx = 0;
3948	bool disret;
3949	int rc;
3950
3951	if (!pVM \|\| pInstrGC == 0 \|\| (flags & ~(PATMFL_CODE32\|PATMFL_IDTHANDLER\|PATMFL_INTHANDLER\|PATMFL_SYSENTER\|PATMFL_TRAPHANDLER\|PATMFL_DUPLICATE_FUNCTION\|PATMFL_REPLACE_FUNCTION_CALL\|PATMFL_GUEST_SPECIFIC\|PATMFL_INT3_REPLACEMENT\|PATMFL_TRAPHANDLER_WITH_ERRORCODE\|PATMFL_IDTHANDLER_WITHOUT_ENTRYPOINT\|PATMFL_MMIO_ACCESS\|PATMFL_TRAMPOLINE\|PATMFL_INSTR_HINT\|PATMFL_JUMP_CONFLICT)))
3952	{
3953	AssertFailed();
3954	return VERR_INVALID_PARAMETER;
3955	}
3956
3957	if (PATMIsEnabled(pVM) == false)
3958	return VERR_PATCHING_REFUSED;
3959
3960	/* Test for patch conflict only with patches that actually change guest code. */
3961	if (!(flags & (PATMFL_GUEST_SPECIFIC\|PATMFL_IDTHANDLER\|PATMFL_INTHANDLER\|PATMFL_TRAMPOLINE)))
3962	{
3963	PPATCHINFO pConflictPatch = PATMFindActivePatchByEntrypoint(pVM, pInstrGC);
3964	AssertReleaseMsg(pConflictPatch == 0, ("Unable to patch overwritten instruction at %VGv (%VGv)\n", pInstrGC, pConflictPatch->pPrivInstrGC));
3965	if (pConflictPatch != 0)
3966	return VERR_PATCHING_REFUSED;
3967	}
3968
3969	if (!(flags & PATMFL_CODE32))
3970	{
3971	/** @todo Only 32 bits code right now */
3972	AssertMsgFailed(("PATMR3InstallPatch: We don't support 16 bits code at this moment!!\n"));
3973	return VERR_NOT_IMPLEMENTED;
3974	}
3975
3976	/* We ran out of patch memory; don't bother anymore. */
3977	if (pVM->patm.s.fOutOfMemory == true)
3978	return VERR_PATCHING_REFUSED;
3979
3980	/* Make sure the code selector is wide open; otherwise refuse. */
3981	CPUMQueryGuestCtxPtr(pVM, &pCtx);
3982	if (CPUMGetGuestCPL(pVM, CPUMCTX2CORE(pCtx)) == 0)
3983	{
3984	RTGCPTR pInstrGCFlat = SELMToFlat(pVM, pCtx->eflags, pCtx->cs, &pCtx->csHid, pInstrGC);
3985	if (pInstrGCFlat != pInstrGC)
3986	{
3987	Log(("PATMR3InstallPatch: code selector not wide open: %04x:%VGv != %VGv eflags=%08x\n", pCtx->cs, pInstrGCFlat, pInstrGC, pCtx->eflags.u32));
3988	return VERR_PATCHING_REFUSED;
3989	}
3990	}
3991
3992	/** @note the OpenBSD specific check will break if we allow additional patches to be installed (int 3)) */
3993	if (!(flags & PATMFL_GUEST_SPECIFIC))
3994	{
3995	/* New code. Make sure CSAM has a go at it first. */
3996	CSAMR3CheckCode(pVM, pInstrGC);
3997	}
3998
3999	/** @note obsolete */
4000	if ( PATMIsPatchGCAddr(pVM, pInstrGC)
4001	&& (flags & PATMFL_MMIO_ACCESS))
4002	{
4003	RTGCUINTPTR offset;
4004	void *pvPatchCoreOffset;
4005
4006	/* Find the patch record. */
4007	offset = pInstrGC - pVM->patm.s.pPatchMemGC;
4008	pvPatchCoreOffset = RTAvloGCPtrGetBestFit(&pVM->patm.s.PatchLookupTreeHC->PatchTreeByPatchAddr, offset, false);
4009	if (pvPatchCoreOffset == NULL)
4010	{
4011	AssertMsgFailed(("PATMR3InstallPatch: patch not found at address %VGv!!\n", pInstrGC));
4012	return VERR_PATCH_NOT_FOUND; //fatal error
4013	}
4014	pPatchRec = PATM_PATCHREC_FROM_COREOFFSET(pvPatchCoreOffset);
4015
4016	return patmPatchPATMMMIOInstr(pVM, pInstrGC, &pPatchRec->patch);
4017	}
4018
4019	AssertReturn(!PATMIsPatchGCAddr(pVM, pInstrGC), VERR_PATCHING_REFUSED);
4020
4021	pPatchRec = (PPATMPATCHREC)RTAvloGCPtrGet(&pVM->patm.s.PatchLookupTreeHC->PatchTree, pInstrGC);
4022	if (pPatchRec)
4023	{
4024	Assert(!(flags & PATMFL_TRAMPOLINE));
4025
4026	/* Hints about existing patches are ignored. */
4027	if (flags & PATMFL_INSTR_HINT)
4028	return VERR_PATCHING_REFUSED;
4029
4030	if (pPatchRec->patch.uState == PATCH_DISABLE_PENDING)
4031	{
4032	Log(("PATMR3InstallPatch: disable operation is pending for patch at %VGv\n", pPatchRec->patch.pPrivInstrGC));
4033	PATMR3DisablePatch(pVM, pPatchRec->patch.pPrivInstrGC);
4034	Assert(pPatchRec->patch.uState == PATCH_DISABLED);
4035	}
4036
4037	if (pPatchRec->patch.uState == PATCH_DISABLED)
4038	{
4039	/* A patch, for which we previously received a hint, will be enabled and turned into a normal patch. */
4040	if (pPatchRec->patch.flags & PATMFL_INSTR_HINT)
4041	{
4042	Log(("Enabling HINTED patch %VGv\n", pInstrGC));
4043	pPatchRec->patch.flags &= ~PATMFL_INSTR_HINT;
4044	}
4045	else
4046	Log(("Enabling patch %VGv again\n", pInstrGC));
4047
4048	/** @todo we shouldn't disable and enable patches too often (it's relatively cheap, but pointless if it always happens) */
4049	rc = PATMR3EnablePatch(pVM, pInstrGC);
4050	if (VBOX_SUCCESS(rc))
4051	return VWRN_PATCH_ENABLED;
4052
4053	return rc;
4054	}
4055	if ( pPatchRec->patch.uState == PATCH_ENABLED
4056	\|\| pPatchRec->patch.uState == PATCH_DIRTY)
4057	{
4058	/*
4059	* The patch might have been overwritten.
4060	*/
4061	STAM_COUNTER_INC(&pVM->patm.s.StatOverwritten);
4062	if (pPatchRec->patch.uState != PATCH_REFUSED && pPatchRec->patch.uState != PATCH_UNUSABLE)
4063	{
4064	/* Patch must have been overwritten; remove it and pretend nothing happened. */
4065	Log(("Patch an existing patched instruction?!? (%VGv)\n", pInstrGC));
4066	if (pPatchRec->patch.flags & (PATMFL_DUPLICATE_FUNCTION\|PATMFL_IDTHANDLER\|PATMFL_MMIO_ACCESS\|PATMFL_INT3_REPLACEMENT\|PATMFL_INT3_REPLACEMENT_BLOCK))
4067	{
4068	if (flags & PATMFL_IDTHANDLER)
4069	pPatchRec->patch.flags \|= (flags & (PATMFL_IDTHANDLER\|PATMFL_TRAPHANDLER\|PATMFL_INTHANDLER)); /* update the type */
4070
4071	return VERR_PATM_ALREADY_PATCHED; /* already done once */
4072	}
4073	}
4074	PATMR3RemovePatch(pVM, pInstrGC);
4075	}
4076	else
4077	{
4078	AssertMsg(pPatchRec->patch.uState == PATCH_REFUSED \|\| pPatchRec->patch.uState == PATCH_UNUSABLE, ("Patch an existing patched instruction?!? (%VGv, state=%d)\n", pInstrGC, pPatchRec->patch.uState));
4079	/* already tried it once! */
4080	return VERR_PATCHING_REFUSED;
4081	}
4082	}
4083
4084	rc = MMHyperAlloc(pVM, sizeof(PATMPATCHREC), 0, MM_TAG_PATM_PATCH, (void **)&pPatchRec);
4085	if (VBOX_FAILURE(rc))
4086	{
4087	Log(("Out of memory!!!!\n"));
4088	return VERR_NO_MEMORY;
4089	}
4090	pPatchRec->Core.Key = pInstrGC;
4091	pPatchRec->patch.uState = PATCH_REFUSED; //default
4092	rc = RTAvloGCPtrInsert(&pVM->patm.s.PatchLookupTreeHC->PatchTree, &pPatchRec->Core);
4093	Assert(rc);
4094
4095	RTGCPHYS GCPhys;
4096	rc = PGMGstGetPage(pVM, pInstrGC, NULL, &GCPhys);
4097	if (rc != VINF_SUCCESS)
4098	{
4099	Log(("PGMGstGetPage failed with %Vrc\n", rc));
4100	return rc;
4101	}
4102	/* Disallow patching instructions inside ROM code; complete function duplication is allowed though. */
4103	if ( !(flags & (PATMFL_DUPLICATE_FUNCTION\|PATMFL_TRAMPOLINE))
4104	&& !PGMPhysIsGCPhysNormal(pVM, GCPhys))
4105	{
4106	Log(("Code at %RGv (phys %RGp) is in a ROM, MMIO or invalid page - refused\n", pInstrGC, GCPhys));
4107	return VERR_PATCHING_REFUSED;
4108	}
4109	GCPhys = GCPhys + (pInstrGC & PAGE_OFFSET_MASK);
4110	rc = PGMPhysGCPhys2HCPtr(pVM, GCPhys, MAX_INSTR_SIZE, (void **)&pInstrHC);
4111	AssertRCReturn(rc, rc);
4112
4113	pPatchRec->patch.pPrivInstrHC = pInstrHC;
4114	pPatchRec->patch.pPrivInstrGC = pInstrGC;
4115	pPatchRec->patch.flags = flags;
4116	pPatchRec->patch.uOpMode = (flags & PATMFL_CODE32) ? CPUMODE_32BIT : CPUMODE_16BIT;
4117
4118	pPatchRec->patch.pInstrGCLowest = pInstrGC;
4119	pPatchRec->patch.pInstrGCHighest = pInstrGC;
4120
4121	if (!(pPatchRec->patch.flags & (PATMFL_DUPLICATE_FUNCTION \| PATMFL_IDTHANDLER \| PATMFL_SYSENTER \| PATMFL_TRAMPOLINE)))
4122	{
4123	/*
4124	* Close proximity to an unusable patch is a possible hint that this patch would turn out to be dangerous too!
4125	*/
4126	PPATMPATCHREC pPatchNear = (PPATMPATCHREC)RTAvloGCPtrGetBestFit(&pVM->patm.s.PatchLookupTreeHC->PatchTree, (pInstrGC + SIZEOF_NEARJUMP32 - 1), false);
4127	if (pPatchNear)
4128	{
4129	if (pPatchNear->patch.uState == PATCH_UNUSABLE && pInstrGC < pPatchNear->patch.pPrivInstrGC && pInstrGC + SIZEOF_NEARJUMP32 > pPatchNear->patch.pPrivInstrGC)
4130	{
4131	Log(("Dangerous patch; would overwrite the ususable patch at %VGv\n", pPatchNear->patch.pPrivInstrGC));
4132
4133	pPatchRec->patch.uState = PATCH_UNUSABLE;
4134	/*
4135	* Leave the new patch active as it's marked unusable; to prevent us from checking it over and over again
4136	*/
4137	return VERR_PATCHING_REFUSED;
4138	}
4139	}
4140	}
4141
4142	pPatchRec->patch.pTempInfo = (PPATCHINFOTEMP)MMR3HeapAllocZ(pVM, MM_TAG_PATM_PATCH, sizeof(PATCHINFOTEMP));
4143	if (pPatchRec->patch.pTempInfo == 0)
4144	{
4145	Log(("Out of memory!!!!\n"));
4146	return VERR_NO_MEMORY;
4147	}
4148
4149	cpu.mode = pPatchRec->patch.uOpMode;
4150	disret = PATMR3DISInstr(pVM, &pPatchRec->patch, &cpu, pInstrGC, pInstrHC, &opsize, NULL);
4151	if (disret == false)
4152	{
4153	Log(("Disassembly failed (probably page not present) -> return to caller\n"));
4154	return VERR_PATCHING_REFUSED;
4155	}
4156
4157	AssertMsg(opsize <= MAX_INSTR_SIZE, ("privileged instruction too big %d!!\n", opsize));
4158	if (opsize > MAX_INSTR_SIZE)
4159	{
4160	return VERR_PATCHING_REFUSED;
4161	}
4162
4163	pPatchRec->patch.cbPrivInstr = opsize;
4164	pPatchRec->patch.opcode = cpu.pCurInstr->opcode;
4165
4166	/* Restricted hinting for now. */
4167	Assert(!(flags & PATMFL_INSTR_HINT) \|\| cpu.pCurInstr->opcode == OP_CLI);
4168
4169	/* Allocate statistics slot */
4170	if (pVM->patm.s.uCurrentPatchIdx < PATM_STAT_MAX_COUNTERS)
4171	{
4172	pPatchRec->patch.uPatchIdx = pVM->patm.s.uCurrentPatchIdx++;
4173	}
4174	else
4175	{
4176	Log(("WARNING: Patch index wrap around!!\n"));
4177	pPatchRec->patch.uPatchIdx = PATM_STAT_INDEX_DUMMY;
4178	}
4179
4180	if (pPatchRec->patch.flags & PATMFL_TRAPHANDLER)
4181	{
4182	rc = patmInstallTrapTrampoline(pVM, pInstrGC, pPatchRec);
4183	}
4184	else
4185	if (pPatchRec->patch.flags & (PATMFL_DUPLICATE_FUNCTION ))
4186	{
4187	rc = patmDuplicateFunction(pVM, pInstrGC, pPatchRec);
4188	}
4189	else
4190	if (pPatchRec->patch.flags & PATMFL_TRAMPOLINE)
4191	{
4192	rc = patmCreateTrampoline(pVM, pInstrGC, pPatchRec);
4193	}
4194	else
4195	if (pPatchRec->patch.flags & PATMFL_REPLACE_FUNCTION_CALL)
4196	{
4197	rc = patmReplaceFunctionCall(pVM, &cpu, pInstrGC, &pPatchRec->patch);
4198	}
4199	else
4200	if (pPatchRec->patch.flags & PATMFL_INT3_REPLACEMENT)
4201	{
4202	rc = PATMR3PatchInstrInt3(pVM, pInstrGC, pInstrHC, &cpu, &pPatchRec->patch);
4203	}
4204	else
4205	if (pPatchRec->patch.flags & PATMFL_MMIO_ACCESS)
4206	{
4207	rc = patmPatchMMIOInstr(pVM, pInstrGC, &cpu, &pPatchRec->patch);
4208	}
4209	else
4210	if (pPatchRec->patch.flags & (PATMFL_IDTHANDLER\|PATMFL_SYSENTER))
4211	{
4212	if (pPatchRec->patch.flags & PATMFL_SYSENTER)
4213	pPatchRec->patch.flags \|= PATMFL_IDTHANDLER; /* we treat a sysenter handler as an IDT handler */
4214
4215	rc = patmIdtHandler(pVM, pInstrGC, pInstrHC, opsize, pPatchRec);
4216	#ifdef VBOX_WITH_STATISTICS
4217	if ( rc == VINF_SUCCESS
4218	&& (pPatchRec->patch.flags & PATMFL_SYSENTER))
4219	{
4220	pVM->patm.s.uSysEnterPatchIdx = pPatchRec->patch.uPatchIdx;
4221	}
4222	#endif
4223	}
4224	else
4225	if (pPatchRec->patch.flags & PATMFL_GUEST_SPECIFIC)
4226	{
4227	switch (cpu.pCurInstr->opcode)
4228	{
4229	case OP_SYSENTER:
4230	case OP_PUSH:
4231	rc = PATMInstallGuestSpecificPatch(pVM, &cpu, pInstrGC, pInstrHC, pPatchRec);
4232	if (rc == VINF_SUCCESS)
4233	{
4234	if (rc == VINF_SUCCESS)
4235	Log(("PATMR3InstallPatch GUEST: %s %VGv code32=%d\n", patmGetInstructionString(pPatchRec->patch.opcode, pPatchRec->patch.flags), pInstrGC, (flags & PATMFL_CODE32) ? 1 : 0));
4236	return rc;
4237	}
4238	break;
4239
4240	default:
4241	rc = VERR_NOT_IMPLEMENTED;
4242	break;
4243	}
4244	}
4245	else
4246	{
4247	switch (cpu.pCurInstr->opcode)
4248	{
4249	case OP_SYSENTER:
4250	rc = PATMInstallGuestSpecificPatch(pVM, &cpu, pInstrGC, pInstrHC, pPatchRec);
4251	if (rc == VINF_SUCCESS)
4252	{
4253	Log(("PATMR3InstallPatch GUEST: %s %VGv code32=%d\n", patmGetInstructionString(pPatchRec->patch.opcode, pPatchRec->patch.flags), pInstrGC, (flags & PATMFL_CODE32) ? 1 : 0));
4254	return VINF_SUCCESS;
4255	}
4256	break;
4257
4258	#ifdef PATM_RESOLVE_CONFLICTS_WITH_JUMP_PATCHES
4259	case OP_JO:
4260	case OP_JNO:
4261	case OP_JC:
4262	case OP_JNC:
4263	case OP_JE:
4264	case OP_JNE:
4265	case OP_JBE:
4266	case OP_JNBE:
4267	case OP_JS:
4268	case OP_JNS:
4269	case OP_JP:
4270	case OP_JNP:
4271	case OP_JL:
4272	case OP_JNL:
4273	case OP_JLE:
4274	case OP_JNLE:
4275	case OP_JECXZ:
4276	case OP_LOOP:
4277	case OP_LOOPNE:
4278	case OP_LOOPE:
4279	case OP_JMP:
4280	if (pPatchRec->patch.flags & PATMFL_JUMP_CONFLICT)
4281	{
4282	rc = patmPatchJump(pVM, pInstrGC, pInstrHC, &cpu, pPatchRec);
4283	break;
4284	}
4285	return VERR_NOT_IMPLEMENTED;
4286	#endif
4287
4288	case OP_PUSHF:
4289	case OP_CLI:
4290	Log(("PATMR3InstallPatch %s %VGv code32=%d\n", patmGetInstructionString(pPatchRec->patch.opcode, pPatchRec->patch.flags), pInstrGC, (flags & PATMFL_CODE32) ? 1 : 0));
4291	rc = PATMR3PatchBlock(pVM, pInstrGC, pInstrHC, cpu.pCurInstr->opcode, opsize, pPatchRec);
4292	break;
4293
4294	case OP_STR:
4295	case OP_SGDT:
4296	case OP_SLDT:
4297	case OP_SIDT:
4298	case OP_CPUID:
4299	case OP_LSL:
4300	case OP_LAR:
4301	case OP_SMSW:
4302	case OP_VERW:
4303	case OP_VERR:
4304	case OP_IRET:
4305	rc = PATMR3PatchInstrInt3(pVM, pInstrGC, pInstrHC, &cpu, &pPatchRec->patch);
4306	break;
4307
4308	default:
4309	return VERR_NOT_IMPLEMENTED;
4310	}
4311	}
4312
4313	if (rc != VINF_SUCCESS)
4314	{
4315	if (pPatchRec && pPatchRec->patch.nrPatch2GuestRecs)
4316	{
4317	patmEmptyTreeU32(pVM, &pPatchRec->patch.Patch2GuestAddrTree);
4318	pPatchRec->patch.nrPatch2GuestRecs = 0;
4319	}
4320	pVM->patm.s.uCurrentPatchIdx--;
4321	}
4322	else
4323	{
4324	rc = patmInsertPatchPages(pVM, &pPatchRec->patch);
4325	AssertRCReturn(rc, rc);
4326
4327	/* Keep track upper and lower boundaries of patched instructions */
4328	if (pPatchRec->patch.pInstrGCLowest < pVM->patm.s.pPatchedInstrGCLowest)
4329	pVM->patm.s.pPatchedInstrGCLowest = pPatchRec->patch.pInstrGCLowest;
4330	if (pPatchRec->patch.pInstrGCHighest > pVM->patm.s.pPatchedInstrGCHighest)
4331	pVM->patm.s.pPatchedInstrGCHighest = pPatchRec->patch.pInstrGCHighest;
4332
4333	Log(("Patch lowest %VGv highest %VGv\n", pPatchRec->patch.pInstrGCLowest, pPatchRec->patch.pInstrGCHighest));
4334	Log(("Global lowest %VGv highest %VGv\n", pVM->patm.s.pPatchedInstrGCLowest, pVM->patm.s.pPatchedInstrGCHighest));
4335
4336	STAM_COUNTER_ADD(&pVM->patm.s.StatInstalled, 1);
4337	STAM_COUNTER_ADD(&pVM->patm.s.StatPATMMemoryUsed, pPatchRec->patch.cbPatchBlockSize);
4338
4339	rc = VINF_SUCCESS;
4340
4341	/* Patch hints are not enabled by default. Only when the are actually encountered. */
4342	if (pPatchRec->patch.flags & PATMFL_INSTR_HINT)
4343	{
4344	rc = PATMR3DisablePatch(pVM, pInstrGC);
4345	AssertRCReturn(rc, rc);
4346	}
4347
4348	#ifdef VBOX_WITH_STATISTICS
4349	/* Register statistics counter */
4350	if (PATM_STAT_INDEX_IS_VALID(pPatchRec->patch.uPatchIdx))
4351	{
4352	STAMR3RegisterCallback(pVM, &pPatchRec->patch, STAMVISIBILITY_NOT_GUI, STAMUNIT_GOOD_BAD, patmResetStat, patmPrintStat, "Patch statistics",
4353	"/PATM/Stats/Patch/0x%VGv", pPatchRec->patch.pPrivInstrGC);
4354	#ifndef DEBUG_sandervl
4355	/* Full breakdown for the GUI. */
4356	STAMR3RegisterF(pVM, &pVM->patm.s.pStatsHC[pPatchRec->patch.uPatchIdx], STAMTYPE_RATIO_U32, STAMVISIBILITY_ALWAYS, STAMUNIT_GOOD_BAD, PATMPatchType(pVM, &pPatchRec->patch),
4357	"/PATM/Stats/PatchBD/0x%VGv", pPatchRec->patch.pPrivInstrGC);
4358	STAMR3RegisterF(pVM, &pPatchRec->patch.cbPatchBlockSize,STAMTYPE_U32, STAMVISIBILITY_ALWAYS, STAMUNIT_BYTES, NULL, "/PATM/Stats/PatchBD/0x%VGv/cbPatchBlockSize", pPatchRec->patch.pPrivInstrGC);
4359	STAMR3RegisterF(pVM, &pPatchRec->patch.cbPatchJump, STAMTYPE_U32, STAMVISIBILITY_ALWAYS, STAMUNIT_BYTES, NULL, "/PATM/Stats/PatchBD/0x%VGv/cbPatchJump", pPatchRec->patch.pPrivInstrGC);
4360	STAMR3RegisterF(pVM, &pPatchRec->patch.cbPrivInstr, STAMTYPE_U32, STAMVISIBILITY_ALWAYS, STAMUNIT_BYTES, NULL, "/PATM/Stats/PatchBD/0x%VGv/cbPrivInstr", pPatchRec->patch.pPrivInstrGC);
4361	STAMR3RegisterF(pVM, &pPatchRec->patch.cCodeWrites, STAMTYPE_U32, STAMVISIBILITY_ALWAYS, STAMUNIT_OCCURENCES, NULL, "/PATM/Stats/PatchBD/0x%VGv/cCodeWrites", pPatchRec->patch.pPrivInstrGC);
4362	STAMR3RegisterF(pVM, &pPatchRec->patch.cInvalidWrites, STAMTYPE_U32, STAMVISIBILITY_ALWAYS, STAMUNIT_OCCURENCES, NULL, "/PATM/Stats/PatchBD/0x%VGv/cInvalidWrites", pPatchRec->patch.pPrivInstrGC);
4363	STAMR3RegisterF(pVM, &pPatchRec->patch.cTraps, STAMTYPE_U32, STAMVISIBILITY_ALWAYS, STAMUNIT_OCCURENCES, NULL, "/PATM/Stats/PatchBD/0x%VGv/cTraps", pPatchRec->patch.pPrivInstrGC);
4364	STAMR3RegisterF(pVM, &pPatchRec->patch.flags, STAMTYPE_X32, STAMVISIBILITY_ALWAYS, STAMUNIT_NONE, NULL, "/PATM/Stats/PatchBD/0x%VGv/flags", pPatchRec->patch.pPrivInstrGC);
4365	STAMR3RegisterF(pVM, &pPatchRec->patch.nrJumpRecs, STAMTYPE_U32, STAMVISIBILITY_ALWAYS, STAMUNIT_OCCURENCES, NULL, "/PATM/Stats/PatchBD/0x%VGv/nrJumpRecs", pPatchRec->patch.pPrivInstrGC);
4366	STAMR3RegisterF(pVM, &pPatchRec->patch.nrFixups, STAMTYPE_U32, STAMVISIBILITY_ALWAYS, STAMUNIT_OCCURENCES, NULL, "/PATM/Stats/PatchBD/0x%VGv/nrFixups", pPatchRec->patch.pPrivInstrGC);
4367	STAMR3RegisterF(pVM, &pPatchRec->patch.opcode, STAMTYPE_U32, STAMVISIBILITY_ALWAYS, STAMUNIT_OCCURENCES, NULL, "/PATM/Stats/PatchBD/0x%VGv/opcode", pPatchRec->patch.pPrivInstrGC);
4368	STAMR3RegisterF(pVM, &pPatchRec->patch.uOldState, STAMTYPE_U32, STAMVISIBILITY_ALWAYS, STAMUNIT_NONE, NULL, "/PATM/Stats/PatchBD/0x%VGv/uOldState", pPatchRec->patch.pPrivInstrGC);
4369	STAMR3RegisterF(pVM, &pPatchRec->patch.uOpMode, STAMTYPE_U32, STAMVISIBILITY_ALWAYS, STAMUNIT_NONE, NULL, "/PATM/Stats/PatchBD/0x%VGv/uOpMode", pPatchRec->patch.pPrivInstrGC);
4370	/// @todo change the state to be a callback so we can get a state mnemonic instead.
4371	STAMR3RegisterF(pVM, &pPatchRec->patch.uState, STAMTYPE_U32, STAMVISIBILITY_ALWAYS, STAMUNIT_NONE, NULL, "/PATM/Stats/PatchBD/0x%VGv/uState", pPatchRec->patch.pPrivInstrGC);
4372	#endif
4373	}
4374	#endif
4375	}
4376	return rc;
4377	}
4378
4379	/**
4380	* Query instruction size
4381	*
4382	* @returns VBox status code.
4383	* @param pVM The VM to operate on.
4384	* @param pPatch Patch record
4385	* @param pInstrGC Instruction address
4386	*/
4387	static uint32_t patmGetInstrSize(PVM pVM, PPATCHINFO pPatch, RTGCPTR pInstrGC)
4388	{
4389	uint8_t *pInstrHC;
4390
4391	int rc = PGMPhysGCPtr2HCPtr(pVM, pInstrGC, (RTHCPTR *)&pInstrHC);
4392	if (rc == VINF_SUCCESS)
4393	{
4394	DISCPUSTATE cpu;
4395	bool disret;
4396	uint32_t opsize;
4397
4398	cpu.mode = (pPatch->flags & PATMFL_CODE32) ? CPUMODE_32BIT : CPUMODE_16BIT;
4399	disret = PATMR3DISInstr(pVM, pPatch, &cpu, pInstrGC, pInstrHC, &opsize, NULL, PATMREAD_ORGCODE \| PATMREAD_NOCHECK);
4400	if (disret)
4401	return opsize;
4402	}
4403	return 0;
4404	}
4405
4406	/**
4407	* Add patch to page record
4408	*
4409	* @returns VBox status code.
4410	* @param pVM The VM to operate on.
4411	* @param pPage Page address
4412	* @param pPatch Patch record
4413	*/
4414	int patmAddPatchToPage(PVM pVM, RTGCUINTPTR pPage, PPATCHINFO pPatch)
4415	{
4416	PPATMPATCHPAGE pPatchPage;
4417	int rc;
4418
4419	Log(("patmAddPatchToPage: insert patch %VHv to page %VGv\n", pPatch, pPage));
4420
4421	pPatchPage = (PPATMPATCHPAGE)RTAvloGCPtrGet(&pVM->patm.s.PatchLookupTreeHC->PatchTreeByPage, pPage);
4422	if (pPatchPage)
4423	{
4424	Assert(pPatchPage->cCount <= pPatchPage->cMaxPatches);
4425	if (pPatchPage->cCount == pPatchPage->cMaxPatches)
4426	{
4427	uint32_t cMaxPatchesOld = pPatchPage->cMaxPatches;
4428	PPATCHINFO *paPatchOld = pPatchPage->aPatch;
4429
4430	pPatchPage->cMaxPatches += PATMPATCHPAGE_PREALLOC_INCREMENT;
4431	rc = MMHyperAlloc(pVM, sizeof(PPATCHINFO)pPatchPage->cMaxPatches, 0, MM_TAG_PATM_PATCH, (void *)&pPatchPage->aPatch);
4432	if (VBOX_FAILURE(rc))
4433	{
4434	Log(("Out of memory!!!!\n"));
4435	return VERR_NO_MEMORY;
4436	}
4437	memcpy(pPatchPage->aPatch, paPatchOld, cMaxPatchesOld*sizeof(PPATCHINFO));
4438	MMHyperFree(pVM, paPatchOld);
4439	}
4440	pPatchPage->aPatch[pPatchPage->cCount] = pPatch;
4441	pPatchPage->cCount++;
4442	}
4443	else
4444	{
4445	rc = MMHyperAlloc(pVM, sizeof(PATMPATCHPAGE), 0, MM_TAG_PATM_PATCH, (void **)&pPatchPage);
4446	if (VBOX_FAILURE(rc))
4447	{
4448	Log(("Out of memory!!!!\n"));
4449	return VERR_NO_MEMORY;
4450	}
4451	pPatchPage->Core.Key = pPage;
4452	pPatchPage->cCount = 1;
4453	pPatchPage->cMaxPatches = PATMPATCHPAGE_PREALLOC_INCREMENT;
4454
4455	rc = MMHyperAlloc(pVM, sizeof(PPATCHINFO)PATMPATCHPAGE_PREALLOC_INCREMENT, 0, MM_TAG_PATM_PATCH, (void *)&pPatchPage->aPatch);
4456	if (VBOX_FAILURE(rc))
4457	{
4458	Log(("Out of memory!!!!\n"));
4459	MMHyperFree(pVM, pPatchPage);
4460	return VERR_NO_MEMORY;
4461	}
4462	pPatchPage->aPatch[0] = pPatch;
4463
4464	rc = RTAvloGCPtrInsert(&pVM->patm.s.PatchLookupTreeHC->PatchTreeByPage, &pPatchPage->Core);
4465	Assert(rc);
4466	pVM->patm.s.cPageRecords++;
4467
4468	STAM_COUNTER_INC(&pVM->patm.s.StatPatchPageInserted);
4469	}
4470	CSAMR3MonitorPage(pVM, pPage, CSAM_TAG_PATM);
4471
4472	/* Get the closest guest instruction (from below) */
4473	PRECGUESTTOPATCH pGuestToPatchRec = (PRECGUESTTOPATCH)RTAvlGCPtrGetBestFit(&pPatch->Guest2PatchAddrTree, pPage, true);
4474	Assert(pGuestToPatchRec);
4475	if (pGuestToPatchRec)
4476	{
4477	if ( pPatchPage->pLowestAddrGC == 0
4478	\|\| pPatchPage->pLowestAddrGC > (RTGCPTR)pGuestToPatchRec->Core.Key)
4479	{
4480	RTGCUINTPTR offset;
4481
4482	pPatchPage->pLowestAddrGC = (RTGCPTR)pGuestToPatchRec->Core.Key;
4483
4484	offset = pPatchPage->pLowestAddrGC & PAGE_OFFSET_MASK;
4485	/* If we're too close to the page boundary, then make sure an instruction from the previous page doesn't cross the boundary itself. */
4486	if (offset && offset < MAX_INSTR_SIZE)
4487	{
4488	/* Get the closest guest instruction (from above) */
4489	pGuestToPatchRec = (PRECGUESTTOPATCH)RTAvlGCPtrGetBestFit(&pPatch->Guest2PatchAddrTree, pPage-1, false);
4490
4491	if (pGuestToPatchRec)
4492	{
4493	uint32_t size = patmGetInstrSize(pVM, pPatch, (RTGCPTR)pGuestToPatchRec->Core.Key);
4494	if ((RTGCUINTPTR)pGuestToPatchRec->Core.Key + size > pPage)
4495	pPatchPage->pLowestAddrGC = pPage;
4496	}
4497	}
4498	}
4499	}
4500
4501	/* Get the closest guest instruction (from above) */
4502	pGuestToPatchRec = (PRECGUESTTOPATCH)RTAvlGCPtrGetBestFit(&pPatch->Guest2PatchAddrTree, pPage+PAGE_SIZE-1, false);
4503	Assert(pGuestToPatchRec);
4504	if (pGuestToPatchRec)
4505	{
4506	if ( pPatchPage->pHighestAddrGC == 0
4507	\|\| pPatchPage->pHighestAddrGC < (RTGCPTR)pGuestToPatchRec->Core.Key)
4508	{
4509	pPatchPage->pHighestAddrGC = (RTGCPTR)pGuestToPatchRec->Core.Key;
4510	/* Increase by instruction size. */
4511	uint32_t size = patmGetInstrSize(pVM, pPatch, pPatchPage->pHighestAddrGC);
4512	//// Assert(size);
4513	pPatchPage->pHighestAddrGC += size;
4514	}
4515	}
4516
4517	return VINF_SUCCESS;
4518	}
4519
4520	/**
4521	* Remove patch from page record
4522	*
4523	* @returns VBox status code.
4524	* @param pVM The VM to operate on.
4525	* @param pPage Page address
4526	* @param pPatch Patch record
4527	*/
4528	int patmRemovePatchFromPage(PVM pVM, RTGCUINTPTR pPage, PPATCHINFO pPatch)
4529	{
4530	PPATMPATCHPAGE pPatchPage;
4531	int rc;
4532
4533	pPatchPage = (PPATMPATCHPAGE)RTAvloGCPtrGet(&pVM->patm.s.PatchLookupTreeHC->PatchTreeByPage, pPage);
4534	Assert(pPatchPage);
4535
4536	if (!pPatchPage)
4537	return VERR_INVALID_PARAMETER;
4538
4539	Assert(pPatchPage->cCount <= pPatchPage->cMaxPatches);
4540
4541	Log(("patmRemovePatchPage: remove patch %VHv from page %VGv\n", pPatch, pPage));
4542	if (pPatchPage->cCount > 1)
4543	{
4544	uint32_t i;
4545
4546	/* Used by multiple patches */
4547	for (i=0;i<pPatchPage->cCount;i++)
4548	{
4549	if (pPatchPage->aPatch[i] == pPatch)
4550	{
4551	pPatchPage->aPatch[i] = 0;
4552	break;
4553	}
4554	}
4555	/* close the gap between the remaining pointers. */
4556	if (i < pPatchPage->cCount - 1)
4557	{
4558	memcpy(&pPatchPage->aPatch[i], &pPatchPage->aPatch[i+1], sizeof(PPATCHINFO)*(pPatchPage->cCount - (i+1)));
4559	}
4560	AssertMsg(i < pPatchPage->cCount, ("Unable to find patch %VHv in page %VGv\n", pPatch, pPage));
4561
4562	pPatchPage->cCount--;
4563	}
4564	else
4565	{
4566	PPATMPATCHPAGE pPatchNode;
4567
4568	Log(("patmRemovePatchFromPage %VGv\n", pPage));
4569
4570	STAM_COUNTER_INC(&pVM->patm.s.StatPatchPageRemoved);
4571	pPatchNode = (PPATMPATCHPAGE)RTAvloGCPtrRemove(&pVM->patm.s.PatchLookupTreeHC->PatchTreeByPage, pPage);
4572	Assert(pPatchNode && pPatchNode == pPatchPage);
4573
4574	Assert(pPatchPage->aPatch);
4575	rc = MMHyperFree(pVM, pPatchPage->aPatch);
4576	AssertRC(rc);
4577	rc = MMHyperFree(pVM, pPatchPage);
4578	AssertRC(rc);
4579	pVM->patm.s.cPageRecords--;
4580	}
4581	return VINF_SUCCESS;
4582	}
4583
4584	/**
4585	* Insert page records for all guest pages that contain instructions that were recompiled for this patch
4586	*
4587	* @returns VBox status code.
4588	* @param pVM The VM to operate on.
4589	* @param pPatch Patch record
4590	*/
4591	int patmInsertPatchPages(PVM pVM, PPATCHINFO pPatch)
4592	{
4593	int rc;
4594	RTGCUINTPTR pPatchPageStart, pPatchPageEnd, pPage;
4595
4596	/* Insert the pages that contain patched instructions into a lookup tree for detecting self-modifying code. */
4597	pPatchPageStart = (RTGCUINTPTR)pPatch->pInstrGCLowest & PAGE_BASE_GC_MASK;
4598	pPatchPageEnd = (RTGCUINTPTR)pPatch->pInstrGCHighest & PAGE_BASE_GC_MASK;
4599
4600	/** @todo optimize better (large gaps between current and next used page) */
4601	for(pPage = pPatchPageStart; pPage <= pPatchPageEnd; pPage += PAGE_SIZE)
4602	{
4603	/* Get the closest guest instruction (from above) */
4604	PRECGUESTTOPATCH pGuestToPatchRec = (PRECGUESTTOPATCH)RTAvlGCPtrGetBestFit(&pPatch->Guest2PatchAddrTree, pPage, true);
4605	if ( pGuestToPatchRec
4606	&& PAGE_ADDRESS(pGuestToPatchRec->Core.Key) == PAGE_ADDRESS(pPage)
4607	)
4608	{
4609	/* Code in page really patched -> add record */
4610	rc = patmAddPatchToPage(pVM, pPage, pPatch);
4611	AssertRC(rc);
4612	}
4613	}
4614	pPatch->flags \|= PATMFL_CODE_MONITORED;
4615	return VINF_SUCCESS;
4616	}
4617
4618	/**
4619	* Remove page records for all guest pages that contain instructions that were recompiled for this patch
4620	*
4621	* @returns VBox status code.
4622	* @param pVM The VM to operate on.
4623	* @param pPatch Patch record
4624	*/
4625	int patmRemovePatchPages(PVM pVM, PPATCHINFO pPatch)
4626	{
4627	int rc;
4628	RTGCUINTPTR pPatchPageStart, pPatchPageEnd, pPage;
4629
4630	/* Insert the pages that contain patched instructions into a lookup tree for detecting self-modifying code. */
4631	pPatchPageStart = (RTGCUINTPTR)pPatch->pInstrGCLowest & PAGE_BASE_GC_MASK;
4632	pPatchPageEnd = (RTGCUINTPTR)pPatch->pInstrGCHighest & PAGE_BASE_GC_MASK;
4633
4634	for(pPage = pPatchPageStart; pPage <= pPatchPageEnd; pPage += PAGE_SIZE)
4635	{
4636	/* Get the closest guest instruction (from above) */
4637	PRECGUESTTOPATCH pGuestToPatchRec = (PRECGUESTTOPATCH)RTAvlGCPtrGetBestFit(&pPatch->Guest2PatchAddrTree, pPage, true);
4638	if ( pGuestToPatchRec
4639	&& PAGE_ADDRESS(pGuestToPatchRec->Core.Key) == PAGE_ADDRESS(pPage) /** @todo bird: PAGE_ADDRESS is for the current context really. check out these. */
4640	)
4641	{
4642	/* Code in page really patched -> remove record */
4643	rc = patmRemovePatchFromPage(pVM, pPage, pPatch);
4644	AssertRC(rc);
4645	}
4646	}
4647	pPatch->flags &= ~PATMFL_CODE_MONITORED;
4648	return VINF_SUCCESS;
4649	}
4650
4651	/**
4652	* Notifies PATM about a (potential) write to code that has been patched.
4653	*
4654	* @returns VBox status code.
4655	* @param pVM The VM to operate on.
4656	* @param GCPtr GC pointer to write address
4657	* @param cbWrite Nr of bytes to write
4658	*
4659	*/
4660	PATMR3DECL(int) PATMR3PatchWrite(PVM pVM, RTGCPTR GCPtr, uint32_t cbWrite)
4661	{
4662	RTGCUINTPTR pWritePageStart, pWritePageEnd, pPage;
4663
4664	Log(("PATMR3PatchWrite %VGv %x\n", GCPtr, cbWrite));
4665
4666	Assert(VM_IS_EMT(pVM));
4667
4668	/* Quick boundary check */
4669	if ( GCPtr < pVM->patm.s.pPatchedInstrGCLowest
4670	\|\| GCPtr > pVM->patm.s.pPatchedInstrGCHighest
4671	)
4672	return VINF_SUCCESS;
4673
4674	STAM_PROFILE_ADV_START(&pVM->patm.s.StatPatchWrite, a);
4675
4676	pWritePageStart = (RTGCUINTPTR)GCPtr & PAGE_BASE_GC_MASK;
4677	pWritePageEnd = ((RTGCUINTPTR)GCPtr + cbWrite - 1) & PAGE_BASE_GC_MASK;
4678
4679	for (pPage = pWritePageStart; pPage <= pWritePageEnd; pPage += PAGE_SIZE)
4680	{
4681	loop_start:
4682	PPATMPATCHPAGE pPatchPage = (PPATMPATCHPAGE)RTAvloGCPtrGet(&pVM->patm.s.PatchLookupTreeHC->PatchTreeByPage, (RTGCPTR)pPage);
4683	if (pPatchPage)
4684	{
4685	uint32_t i;
4686	bool fValidPatchWrite = false;
4687
4688	for (i=0;i<pPatchPage->cCount;i++)
4689	{
4690	if (pPatchPage->aPatch[i])
4691	{
4692	PPATCHINFO pPatch = pPatchPage->aPatch[i];
4693	RTGCPTR pPatchInstrGC;
4694	//unused: bool fForceBreak = false;
4695
4696	Assert(pPatchPage->aPatch[i]->flags & PATMFL_CODE_MONITORED);
4697	/** @todo inefficient and includes redundant checks for multiple pages. */
4698	for (uint32_t j=0; j<cbWrite; j++)
4699	{
4700	RTGCPTR pGuestPtrGC = (RTGCPTR)((RTGCUINTPTR)GCPtr + j);
4701
4702	if ( pPatch->cbPatchJump
4703	&& pGuestPtrGC >= pPatch->pPrivInstrGC
4704	&& pGuestPtrGC < pPatch->pPrivInstrGC + pPatch->cbPatchJump)
4705	{
4706	/* The guest is about to overwrite the 5 byte jump to patch code. Remove the patch. */
4707	Log(("PATMR3PatchWrite: overwriting jump to patch code -> remove patch.\n"));
4708	int rc = PATMR3RemovePatch(pVM, pPatch->pPrivInstrGC);
4709	AssertRC(rc);
4710
4711	/** @note jump back to the start as the pPatchPage has been deleted or changed */
4712	goto loop_start;
4713	}
4714
4715	pPatchInstrGC = patmGuestGCPtrToPatchGCPtr(pVM, pPatch, pGuestPtrGC);
4716	if (pPatchInstrGC)
4717	{
4718	uint32_t PatchOffset = pPatchInstrGC - pVM->patm.s.pPatchMemGC; /* Offset in memory reserved for PATM. */
4719
4720	fValidPatchWrite = true;
4721
4722	PRECPATCHTOGUEST pPatchToGuestRec = (PRECPATCHTOGUEST)RTAvlU32Get(&pPatch->Patch2GuestAddrTree, PatchOffset);
4723	Assert(pPatchToGuestRec);
4724	if (pPatchToGuestRec && !pPatchToGuestRec->fDirty)
4725	{
4726	Log(("PATMR3PatchWrite: Found patched instruction %VGv -> %VGv\n", pGuestPtrGC, pPatchInstrGC));
4727
4728	if (++pPatch->cCodeWrites > PATM_MAX_CODE_WRITES)
4729	{
4730	LogRel(("PATM: Disable block at %VGv - write %VGv-%VGv\n", pPatch->pPrivInstrGC, pGuestPtrGC, pGuestPtrGC+cbWrite));
4731
4732	PATMR3MarkDirtyPatch(pVM, pPatch);
4733
4734	/** @note jump back to the start as the pPatchPage has been deleted or changed */
4735	goto loop_start;
4736	}
4737	else
4738	{
4739	/* Replace the patch instruction with a breakpoint; when it's hit, then we'll attempt to recompile the instruction again. */
4740	uint8_t *pInstrHC = patmPatchGCPtr2PatchHCPtr(pVM, pPatchInstrGC);
4741
4742	pPatchToGuestRec->u8DirtyOpcode = *pInstrHC;
4743	pPatchToGuestRec->fDirty = true;
4744
4745	*pInstrHC = 0xCC;
4746
4747	STAM_COUNTER_INC(&pVM->patm.s.StatInstrDirty);
4748	}
4749	}
4750	/* else already marked dirty */
4751	}
4752	}
4753	}
4754	} /* for each patch */
4755
4756	if (fValidPatchWrite == false)
4757	{
4758	/* Write to a part of the page that either:
4759	* - doesn't contain any code (shared code/data); rather unlikely
4760	* - old code page that's no longer in active use.
4761	*/
4762	invalid_write_loop_start:
4763	pPatchPage = (PPATMPATCHPAGE)RTAvloGCPtrGet(&pVM->patm.s.PatchLookupTreeHC->PatchTreeByPage, (RTGCPTR)pPage);
4764
4765	if (pPatchPage)
4766	{
4767	for (i=0;i<pPatchPage->cCount;i++)
4768	{
4769	PPATCHINFO pPatch = pPatchPage->aPatch[i];
4770
4771	if (pPatch->cInvalidWrites > PATM_MAX_INVALID_WRITES)
4772	{
4773	/** @note possibly dangerous assumption that all future writes will be harmless. */
4774	if (pPatch->flags & PATMFL_IDTHANDLER)
4775	{
4776	LogRel(("PATM: Stop monitoring IDT handler pages at %VGv - invalid write %VGv-%VGv \n", pPatch->pPrivInstrGC, GCPtr, GCPtr+cbWrite));
4777
4778	Assert(pPatch->flags & PATMFL_CODE_MONITORED);
4779	int rc = patmRemovePatchPages(pVM, pPatch);
4780	AssertRC(rc);
4781	}
4782	else
4783	{
4784	LogRel(("PATM: Disable block at %VGv - invalid write %VGv-%VGv \n", pPatch->pPrivInstrGC, GCPtr, GCPtr+cbWrite));
4785	PATMR3MarkDirtyPatch(pVM, pPatch);
4786	}
4787	/** @note jump back to the start as the pPatchPage has been deleted or changed */
4788	goto invalid_write_loop_start;
4789	}
4790	} /* for */
4791	}
4792	}
4793	}
4794	}
4795	STAM_PROFILE_ADV_STOP(&pVM->patm.s.StatPatchWrite, a);
4796	return VINF_SUCCESS;
4797
4798	}
4799
4800	/**
4801	* Disable all patches in a flushed page
4802	*
4803	* @returns VBox status code
4804	* @param pVM The VM to operate on.
4805	* @param addr GC address of the page to flush
4806	*/
4807	/** @note Currently only called by CSAMR3FlushPage; optimization to avoid having to double check if the physical address has changed
4808	*/
4809	PATMR3DECL(int) PATMR3FlushPage(PVM pVM, RTGCPTR addr)
4810	{
4811	addr &= PAGE_BASE_GC_MASK;
4812
4813	PPATMPATCHPAGE pPatchPage = (PPATMPATCHPAGE)RTAvloGCPtrGet(&pVM->patm.s.PatchLookupTreeHC->PatchTreeByPage, addr);
4814	if (pPatchPage)
4815	{
4816	int i;
4817
4818	/* From top to bottom as the array is modified by PATMR3MarkDirtyPatch. */
4819	for (i=(int)pPatchPage->cCount-1;i>=0;i--)
4820	{
4821	if (pPatchPage->aPatch[i])
4822	{
4823	PPATCHINFO pPatch = pPatchPage->aPatch[i];
4824
4825	Log(("PATMR3FlushPage %VGv remove patch at %VGv\n", addr, pPatch->pPrivInstrGC));
4826	PATMR3MarkDirtyPatch(pVM, pPatch);
4827	}
4828	}
4829	STAM_COUNTER_INC(&pVM->patm.s.StatFlushed);
4830	}
4831	return VINF_SUCCESS;
4832	}
4833
4834	/**
4835	* Checks if the instructions at the specified address has been patched already.
4836	*
4837	* @returns boolean, patched or not
4838	* @param pVM The VM to operate on.
4839	* @param pInstrGC Guest context pointer to instruction
4840	*/
4841	PATMR3DECL(bool) PATMR3HasBeenPatched(PVM pVM, RTGCPTR pInstrGC)
4842	{
4843	PPATMPATCHREC pPatchRec;
4844	pPatchRec = (PPATMPATCHREC)RTAvloGCPtrGet(&pVM->patm.s.PatchLookupTreeHC->PatchTree, pInstrGC);
4845	if (pPatchRec && pPatchRec->patch.uState == PATCH_ENABLED)
4846	return true;
4847	return false;
4848	}
4849
4850	/**
4851	* Query the opcode of the original code that was overwritten by the 5 bytes patch jump
4852	*
4853	* @returns VBox status code.
4854	* @param pVM The VM to operate on.
4855	* @param pInstrGC GC address of instr
4856	* @param pByte opcode byte pointer (OUT)
4857	*
4858	*/
4859	PATMR3DECL(int) PATMR3QueryOpcode(PVM pVM, RTGCPTR pInstrGC, uint8_t *pByte)
4860	{
4861	PPATMPATCHREC pPatchRec;
4862
4863	/** @todo this will not work for aliased pages! (never has, but so far not a problem for us) */
4864
4865	/* Shortcut. */
4866	if ( !PATMIsEnabled(pVM)
4867	\|\| pInstrGC < pVM->patm.s.pPatchedInstrGCLowest
4868	\|\| pInstrGC > pVM->patm.s.pPatchedInstrGCHighest)
4869	{
4870	return VERR_PATCH_NOT_FOUND;
4871	}
4872
4873	pPatchRec = (PPATMPATCHREC)RTAvloGCPtrGetBestFit(&pVM->patm.s.PatchLookupTreeHC->PatchTree, pInstrGC, false);
4874	// if the patch is enabled and the pointer lies within 5 bytes of this priv instr ptr, then we've got a hit!
4875	if ( pPatchRec
4876	&& pPatchRec->patch.uState == PATCH_ENABLED
4877	&& pInstrGC >= pPatchRec->patch.pPrivInstrGC
4878	&& pInstrGC < pPatchRec->patch.pPrivInstrGC + pPatchRec->patch.cbPatchJump)
4879	{
4880	RTGCPTR offset = pInstrGC - pPatchRec->patch.pPrivInstrGC;
4881	*pByte = pPatchRec->patch.aPrivInstr[offset];
4882
4883	if (pPatchRec->patch.cbPatchJump == 1)
4884	{
4885	Log(("PATMR3QueryOpcode: returning opcode %2X for instruction at %VGv\n", *pByte, pInstrGC));
4886	}
4887	STAM_COUNTER_ADD(&pVM->patm.s.StatNrOpcodeRead, 1);
4888	return VINF_SUCCESS;
4889	}
4890	return VERR_PATCH_NOT_FOUND;
4891	}
4892
4893	/**
4894	* Disable patch for privileged instruction at specified location
4895	*
4896	* @returns VBox status code.
4897	* @param pVM The VM to operate on.
4898	* @param pInstr Guest context point to privileged instruction
4899	*
4900	* @note returns failure if patching is not allowed or possible
4901	*
4902	*/
4903	PATMR3DECL(int) PATMR3DisablePatch(PVM pVM, RTGCPTR pInstrGC)
4904	{
4905	PPATMPATCHREC pPatchRec;
4906	PPATCHINFO pPatch;
4907
4908	Log(("PATMR3DisablePatch: %VGv\n", pInstrGC));
4909	pPatchRec = (PPATMPATCHREC)RTAvloGCPtrGet(&pVM->patm.s.PatchLookupTreeHC->PatchTree, pInstrGC);
4910	if (pPatchRec)
4911	{
4912	int rc = VINF_SUCCESS;
4913
4914	pPatch = &pPatchRec->patch;
4915
4916	/* Already disabled? */
4917	if (pPatch->uState == PATCH_DISABLED)
4918	return VINF_SUCCESS;
4919
4920	/* Clear the IDT entries for the patch we're disabling. */
4921	/** @note very important as we clear IF in the patch itself */
4922	/** @todo this needs to be changed */
4923	if (pPatch->flags & PATMFL_IDTHANDLER)
4924	{
4925	uint32_t iGate;
4926
4927	iGate = TRPMR3QueryGateByHandler(pVM, PATCHCODE_PTR_GC(pPatch));
4928	if (iGate != (uint32_t)~0)
4929	{
4930	TRPMR3SetGuestTrapHandler(pVM, iGate, TRPM_INVALID_HANDLER);
4931	LogRel(("PATM: Disabling IDT %x patch handler %VGv\n", iGate, pInstrGC));
4932	}
4933	}
4934
4935	/* Mark the entry with a breakpoint in case somebody else calls it later on (cli patch used as a function, function, trampoline or idt patches) */
4936	if ( pPatch->pPatchBlockOffset
4937	&& pPatch->uState == PATCH_ENABLED)
4938	{
4939	Log(("Invalidate patch at %VGv (HC=%VGv)\n", PATCHCODE_PTR_GC(pPatch), PATCHCODE_PTR_HC(pPatch)));
4940	pPatch->bDirtyOpcode = *PATCHCODE_PTR_HC(pPatch);
4941	*PATCHCODE_PTR_HC(pPatch) = 0xCC;
4942	}
4943
4944	/* IDT or function patches haven't changed any guest code. */
4945	if (pPatch->flags & PATMFL_PATCHED_GUEST_CODE)
4946	{
4947	Assert(pPatch->flags & PATMFL_MUST_INSTALL_PATCHJMP);
4948	Assert(!(pPatch->flags & (PATMFL_DUPLICATE_FUNCTION\|PATMFL_IDTHANDLER\|PATMFL_TRAMPOLINE\|PATMFL_INT3_REPLACEMENT\|PATMFL_INT3_REPLACEMENT_BLOCK)));
4949
4950	if (pPatch->uState != PATCH_REFUSED)
4951	{
4952	AssertMsg(pPatch->pPrivInstrHC, ("Invalid HC pointer?!? (%VGv)\n", pInstrGC));
4953	Assert(pPatch->cbPatchJump);
4954
4955	/** pPrivInstrHC is probably not valid anymore */
4956	rc = PGMPhysGCPtr2HCPtr(pVM, pPatchRec->patch.pPrivInstrGC, (PRTHCPTR)&pPatchRec->patch.pPrivInstrHC);
4957	if (rc == VINF_SUCCESS)
4958	{
4959	uint8_t temp[16];
4960
4961	Assert(pPatch->cbPatchJump < sizeof(temp));
4962
4963	/* Let's first check if the guest code is still the same. */
4964	rc = PGMPhysReadGCPtr(pVM, temp, pPatch->pPrivInstrGC, pPatch->cbPatchJump);
4965	Assert(rc == VINF_SUCCESS \|\| rc == VERR_PAGE_TABLE_NOT_PRESENT \|\| rc == VERR_PAGE_NOT_PRESENT);
4966	if (rc == VINF_SUCCESS)
4967	{
4968	RTGCINTPTR displ = (RTGCUINTPTR)PATCHCODE_PTR_GC(pPatch) - ((RTGCUINTPTR)pPatch->pPrivInstrGC + SIZEOF_NEARJUMP32);
4969
4970	if ( temp[0] != 0xE9 /* jmp opcode */
4971	\|\| (RTGCINTPTR )(&temp[1]) != displ
4972	)
4973	{
4974	Log(("PATMR3DisablePatch: Can't disable a patch who's guest code has changed!!\n"));
4975	STAM_COUNTER_INC(&pVM->patm.s.StatOverwritten);
4976	/* Remove it completely */
4977	pPatch->uState = PATCH_DISABLED; /* don't call PATMR3DisablePatch again */
4978	rc = PATMR3RemovePatch(pVM, pInstrGC);
4979	AssertRC(rc);
4980	return VWRN_PATCH_REMOVED;
4981	}
4982	}
4983	patmRemoveJumpToPatch(pVM, pPatch);
4984
4985	}
4986	else
4987	{
4988	Log(("PATMR3DisablePatch: unable to disable patch -> mark PATCH_DISABLE_PENDING\n"));
4989	pPatch->uState = PATCH_DISABLE_PENDING;
4990	}
4991	}
4992	else
4993	{
4994	AssertMsgFailed(("Patch was refused!\n"));
4995	return VERR_PATCH_ALREADY_DISABLED;
4996	}
4997	}
4998	else
4999	if (pPatch->flags & (PATMFL_INT3_REPLACEMENT\|PATMFL_INT3_REPLACEMENT_BLOCK))
5000	{
5001	uint8_t temp[16];
5002
5003	Assert(pPatch->cbPatchJump < sizeof(temp));
5004
5005	/* Let's first check if the guest code is still the same. */
5006	rc = PGMPhysReadGCPtr(pVM, temp, pPatch->pPrivInstrGC, pPatch->cbPatchJump);
5007	Assert(rc == VINF_SUCCESS \|\| rc == VERR_PAGE_TABLE_NOT_PRESENT \|\| rc == VERR_PAGE_NOT_PRESENT);
5008	if (rc == VINF_SUCCESS)
5009	{
5010	if (temp[0] != 0xCC)
5011	{
5012	Log(("PATMR3DisablePatch: Can't disable a patch who's guest code has changed!!\n"));
5013	STAM_COUNTER_INC(&pVM->patm.s.StatOverwritten);
5014	/* Remove it completely */
5015	pPatch->uState = PATCH_DISABLED; /* don't call PATMR3DisablePatch again */
5016	rc = PATMR3RemovePatch(pVM, pInstrGC);
5017	AssertRC(rc);
5018	return VWRN_PATCH_REMOVED;
5019	}
5020	patmDeactivateInt3Patch(pVM, pPatch);
5021	}
5022	}
5023
5024	if (rc == VINF_SUCCESS)
5025	{
5026	/* Save old state and mark this one as disabled (so it can be enabled later on). */
5027	if (pPatch->uState == PATCH_DISABLE_PENDING)
5028	{
5029	/* Just to be safe, let's make sure this one can never be reused; the patch might be marked dirty already (int3 at start) */
5030	pPatch->uState = PATCH_UNUSABLE;
5031	}
5032	else
5033	if (pPatch->uState != PATCH_DIRTY)
5034	{
5035	pPatch->uOldState = pPatch->uState;
5036	pPatch->uState = PATCH_DISABLED;
5037	}
5038	STAM_COUNTER_ADD(&pVM->patm.s.StatDisabled, 1);
5039	}
5040
5041	Log(("PATMR3DisablePatch: disabled patch at %VGv\n", pInstrGC));
5042	return VINF_SUCCESS;
5043	}
5044	Log(("Patch not found!\n"));
5045	return VERR_PATCH_NOT_FOUND;
5046	}
5047
5048	/**
5049	* Permanently disable patch for privileged instruction at specified location
5050	*
5051	* @returns VBox status code.
5052	* @param pVM The VM to operate on.
5053	* @param pInstr Guest context instruction pointer
5054	* @param pConflictAddr Guest context pointer which conflicts with specified patch
5055	* @param pConflictPatch Conflicting patch
5056	*
5057	*/
5058	static int patmDisableUnusablePatch(PVM pVM, RTGCPTR pInstrGC, RTGCPTR pConflictAddr, PPATCHINFO pConflictPatch)
5059	{
5060	#ifdef PATM_RESOLVE_CONFLICTS_WITH_JUMP_PATCHES
5061	PATCHINFO patch = {0};
5062	DISCPUSTATE cpu;
5063	HCPTRTYPE(uint8_t *) pInstrHC;
5064	uint32_t opsize;
5065	bool disret;
5066	int rc;
5067
5068	pInstrHC = PATMGCVirtToHCVirt(pVM, &patch, pInstrGC);
5069	cpu.mode = (pConflictPatch->flags & PATMFL_CODE32) ? CPUMODE_32BIT : CPUMODE_16BIT;
5070	disret = PATMR3DISInstr(pVM, &patch, &cpu, pInstrGC, pInstrHC, &opsize, NULL);
5071	/*
5072	* If it's a 5 byte relative jump, then we can work around the problem by replacing the 32 bits relative offset
5073	* with one that jumps right into the conflict patch.
5074	* Otherwise we must disable the conflicting patch to avoid serious problems.
5075	*/
5076	if ( disret == true
5077	&& (pConflictPatch->flags & PATMFL_CODE32)
5078	&& (cpu.pCurInstr->opcode == OP_JMP \|\| (cpu.pCurInstr->optype & OPTYPE_COND_CONTROLFLOW))
5079	&& (cpu.param1.flags & USE_IMMEDIATE32_REL))
5080	{
5081	/* Hint patches must be enabled first. */
5082	if (pConflictPatch->flags & PATMFL_INSTR_HINT)
5083	{
5084	Log(("Enabling HINTED patch %VGv\n", pConflictPatch->pPrivInstrGC));
5085	pConflictPatch->flags &= ~PATMFL_INSTR_HINT;
5086	rc = PATMR3EnablePatch(pVM, pConflictPatch->pPrivInstrGC);
5087	Assert(rc == VINF_SUCCESS \|\| rc == VERR_PATCH_NOT_FOUND);
5088	/* Enabling might fail if the patched code has changed in the meantime. */
5089	if (rc != VINF_SUCCESS)
5090	return rc;
5091	}
5092
5093	rc = PATMR3InstallPatch(pVM, pInstrGC, PATMFL_CODE32 \| PATMFL_JUMP_CONFLICT);
5094	if (VBOX_SUCCESS(rc))
5095	{
5096	Log(("PATM -> CONFLICT: Installed JMP patch for patch conflict at %VGv\n", pInstrGC));
5097	STAM_COUNTER_INC(&pVM->patm.s.StatFixedConflicts);
5098	return VINF_SUCCESS;
5099	}
5100	}
5101	#endif
5102
5103	if (pConflictPatch->opcode == OP_CLI)
5104	{
5105	/* Turn it into an int3 patch; our GC trap handler will call the generated code manually. */
5106	Log(("PATM -> CONFLICT: Found active patch at instruction %VGv with target %VGv -> turn into int 3 patch!!\n", pInstrGC, pConflictPatch->pPrivInstrGC));
5107	int rc = PATMR3DisablePatch(pVM, pConflictPatch->pPrivInstrGC);
5108	if (rc == VWRN_PATCH_REMOVED)
5109	return VINF_SUCCESS;
5110	if (VBOX_SUCCESS(rc))
5111	{
5112	pConflictPatch->flags &= ~(PATMFL_MUST_INSTALL_PATCHJMP\|PATMFL_INSTR_HINT);
5113	pConflictPatch->flags \|= PATMFL_INT3_REPLACEMENT_BLOCK;
5114	rc = PATMR3EnablePatch(pVM, pConflictPatch->pPrivInstrGC);
5115	if (rc == VERR_PATCH_NOT_FOUND)
5116	return VINF_SUCCESS; /* removed already */
5117
5118	AssertRC(rc);
5119	if (VBOX_SUCCESS(rc))
5120	{
5121	STAM_COUNTER_INC(&pVM->patm.s.StatInt3Callable);
5122	return VINF_SUCCESS;
5123	}
5124	}
5125	/* else turned into unusable patch (see below) */
5126	}
5127	else
5128	{
5129	Log(("PATM -> CONFLICT: Found active patch at instruction %VGv with target %VGv -> DISABLING it!!\n", pInstrGC, pConflictPatch->pPrivInstrGC));
5130	int rc = PATMR3DisablePatch(pVM, pConflictPatch->pPrivInstrGC);
5131	if (rc == VWRN_PATCH_REMOVED)
5132	return VINF_SUCCESS;
5133	}
5134
5135	/* No need to monitor the code anymore. */
5136	if (pConflictPatch->flags & PATMFL_CODE_MONITORED)
5137	{
5138	int rc = patmRemovePatchPages(pVM, pConflictPatch);
5139	AssertRC(rc);
5140	}
5141	pConflictPatch->uState = PATCH_UNUSABLE;
5142	STAM_COUNTER_INC(&pVM->patm.s.StatUnusable);
5143	return VERR_PATCH_DISABLED;
5144	}
5145
5146	/**
5147	* Enable patch for privileged instruction at specified location
5148	*
5149	* @returns VBox status code.
5150	* @param pVM The VM to operate on.
5151	* @param pInstr Guest context point to privileged instruction
5152	*
5153	* @note returns failure if patching is not allowed or possible
5154	*
5155	*/
5156	PATMR3DECL(int) PATMR3EnablePatch(PVM pVM, RTGCPTR pInstrGC)
5157	{
5158	PPATMPATCHREC pPatchRec;
5159	PPATCHINFO pPatch;
5160
5161	Log(("PATMR3EnablePatch %VGv\n", pInstrGC));
5162	pPatchRec = (PPATMPATCHREC)RTAvloGCPtrGet(&pVM->patm.s.PatchLookupTreeHC->PatchTree, pInstrGC);
5163	if (pPatchRec)
5164	{
5165	int rc = VINF_SUCCESS;
5166
5167	pPatch = &pPatchRec->patch;
5168
5169	if (pPatch->uState == PATCH_DISABLED)
5170	{
5171	if (pPatch->flags & PATMFL_MUST_INSTALL_PATCHJMP)
5172	{
5173	Assert(!(pPatch->flags & PATMFL_PATCHED_GUEST_CODE));
5174	/** @todo -> pPrivInstrHC is probably not valid anymore */
5175	rc = PGMPhysGCPtr2HCPtr(pVM, pPatchRec->patch.pPrivInstrGC, (PRTHCPTR)&pPatchRec->patch.pPrivInstrHC);
5176	if (rc == VINF_SUCCESS)
5177	{
5178	#ifdef DEBUG
5179	DISCPUSTATE cpu;
5180	char szOutput[256];
5181	uint32_t opsize, i = 0;
5182	#endif
5183	uint8_t temp[16];
5184
5185	Assert(pPatch->cbPatchJump < sizeof(temp));
5186
5187	// let's first check if the guest code is still the same
5188	int rc = PGMPhysReadGCPtr(pVM, temp, pPatch->pPrivInstrGC, pPatch->cbPatchJump);
5189	AssertRC(rc);
5190
5191	if (memcmp(temp, pPatch->aPrivInstr, pPatch->cbPatchJump))
5192	{
5193	Log(("PATMR3EnablePatch: Can't enable a patch who's guest code has changed!!\n"));
5194	STAM_COUNTER_INC(&pVM->patm.s.StatOverwritten);
5195	/* Remove it completely */
5196	PATMR3RemovePatch(pVM, pInstrGC);
5197	return VERR_PATCH_NOT_FOUND;
5198	}
5199
5200	rc = patmGenJumpToPatch(pVM, pPatch, false);
5201	AssertRC(rc);
5202	if (VBOX_FAILURE(rc))
5203	return rc;
5204
5205	#ifdef DEBUG
5206	bool disret;
5207	i = 0;
5208	while(i < pPatch->cbPatchJump)
5209	{
5210	cpu.mode = (pPatch->flags & PATMFL_CODE32) ? CPUMODE_32BIT : CPUMODE_16BIT;
5211	disret = PATMR3DISInstr(pVM, pPatch, &cpu, pPatch->pPrivInstrGC + i, &pPatch->pPrivInstrHC[i], &opsize, szOutput);
5212	Log(("Renewed patch instr: %s", szOutput));
5213	i += opsize;
5214	}
5215	#endif
5216	}
5217	}
5218	else
5219	if (pPatch->flags & (PATMFL_INT3_REPLACEMENT\|PATMFL_INT3_REPLACEMENT_BLOCK))
5220	{
5221	uint8_t temp[16];
5222
5223	Assert(pPatch->cbPatchJump < sizeof(temp));
5224
5225	/* Let's first check if the guest code is still the same. */
5226	int rc = PGMPhysReadGCPtr(pVM, temp, pPatch->pPrivInstrGC, pPatch->cbPatchJump);
5227	AssertRC(rc);
5228
5229	if (memcmp(temp, pPatch->aPrivInstr, pPatch->cbPatchJump))
5230	{
5231	Log(("PATMR3EnablePatch: Can't enable a patch who's guest code has changed!!\n"));
5232	STAM_COUNTER_INC(&pVM->patm.s.StatOverwritten);
5233	PATMR3RemovePatch(pVM, pInstrGC);
5234	return VERR_PATCH_NOT_FOUND;
5235	}
5236
5237	rc = patmActivateInt3Patch(pVM, pPatch);
5238	if (VBOX_FAILURE(rc))
5239	return rc;
5240	}
5241
5242	pPatch->uState = pPatch->uOldState; //restore state
5243
5244	/* Restore the entry breakpoint with the original opcode (see PATMR3DisablePatch). */
5245	if (pPatch->pPatchBlockOffset)
5246	{
5247	*PATCHCODE_PTR_HC(pPatch) = pPatch->bDirtyOpcode;
5248	}
5249
5250	STAM_COUNTER_ADD(&pVM->patm.s.StatEnabled, 1);
5251	}
5252	else
5253	Log(("PATMR3EnablePatch: Unable to enable patch %VGv with state %d\n", pInstrGC, pPatch->uState));
5254
5255	return rc;
5256	}
5257	return VERR_PATCH_NOT_FOUND;
5258	}
5259
5260	/**
5261	* Remove patch for privileged instruction at specified location
5262	*
5263	* @returns VBox status code.
5264	* @param pVM The VM to operate on.
5265	* @param pPatchRec Patch record
5266	* @param fForceRemove Remove all patches
5267	*/
5268	int PATMRemovePatch(PVM pVM, PPATMPATCHREC pPatchRec, bool fForceRemove)
5269	{
5270	PPATCHINFO pPatch;
5271
5272	pPatch = &pPatchRec->patch;
5273
5274	/* Strictly forbidden to remove such patches. There can be dependencies!! */
5275	AssertReturn(fForceRemove \|\| !(pPatch->flags & (PATMFL_DUPLICATE_FUNCTION)), VERR_ACCESS_DENIED);
5276
5277	/** @note NEVER EVER REUSE PATCH MEMORY */
5278	/** @note PATMR3DisablePatch put a breakpoint (0xCC) at the entry of this patch */
5279
5280	if (pPatchRec->patch.pPatchBlockOffset)
5281	{
5282	PAVLOGCPTRNODECORE pNode;
5283
5284	pNode = RTAvloGCPtrRemove(&pVM->patm.s.PatchLookupTreeHC->PatchTreeByPatchAddr, pPatchRec->patch.pPatchBlockOffset);
5285	Assert(pNode);
5286	}
5287
5288	if (pPatchRec->patch.flags & PATMFL_CODE_MONITORED)
5289	{
5290	int rc = patmRemovePatchPages(pVM, &pPatchRec->patch);
5291	AssertRC(rc);
5292	}
5293
5294	#ifdef VBOX_WITH_STATISTICS
5295	if (PATM_STAT_INDEX_IS_VALID(pPatchRec->patch.uPatchIdx))
5296	{
5297	STAMR3Deregister(pVM, &pPatchRec->patch);
5298	#ifndef DEBUG_sandervl
5299	STAMR3Deregister(pVM, &pVM->patm.s.pStatsHC[pPatchRec->patch.uPatchIdx]);
5300	STAMR3Deregister(pVM, &pPatchRec->patch.cbPatchBlockSize);
5301	STAMR3Deregister(pVM, &pPatchRec->patch.cbPatchJump);
5302	STAMR3Deregister(pVM, &pPatchRec->patch.cbPrivInstr);
5303	STAMR3Deregister(pVM, &pPatchRec->patch.cCodeWrites);
5304	STAMR3Deregister(pVM, &pPatchRec->patch.cInvalidWrites);
5305	STAMR3Deregister(pVM, &pPatchRec->patch.cTraps);
5306	STAMR3Deregister(pVM, &pPatchRec->patch.flags);
5307	STAMR3Deregister(pVM, &pPatchRec->patch.nrJumpRecs);
5308	STAMR3Deregister(pVM, &pPatchRec->patch.nrFixups);
5309	STAMR3Deregister(pVM, &pPatchRec->patch.opcode);
5310	STAMR3Deregister(pVM, &pPatchRec->patch.uState);
5311	STAMR3Deregister(pVM, &pPatchRec->patch.uOldState);
5312	STAMR3Deregister(pVM, &pPatchRec->patch.uOpMode);
5313	#endif
5314	}
5315	#endif
5316
5317	/** @note no need to free Guest2PatchAddrTree as those records share memory with Patch2GuestAddrTree records. */
5318	patmEmptyTreeU32(pVM, &pPatch->Patch2GuestAddrTree);
5319	pPatch->nrPatch2GuestRecs = 0;
5320	Assert(pPatch->Patch2GuestAddrTree == 0);
5321
5322	patmEmptyTree(pVM, &pPatch->FixupTree);
5323	pPatch->nrFixups = 0;
5324	Assert(pPatch->FixupTree == 0);
5325
5326	if (pPatchRec->patch.pTempInfo)
5327	MMR3HeapFree(pPatchRec->patch.pTempInfo);
5328
5329	/** @note might fail, because it has already been removed (e.g. during reset). */
5330	RTAvloGCPtrRemove(&pVM->patm.s.PatchLookupTreeHC->PatchTree, pPatchRec->Core.Key);
5331
5332	/* Free the patch record */
5333	MMHyperFree(pVM, pPatchRec);
5334	return VINF_SUCCESS;
5335	}
5336
5337	/**
5338	* Attempt to refresh the patch by recompiling its entire code block
5339	*
5340	* @returns VBox status code.
5341	* @param pVM The VM to operate on.
5342	* @param pPatchRec Patch record
5343	*/
5344	int patmR3RefreshPatch(PVM pVM, PPATMPATCHREC pPatchRec)
5345	{
5346	PPATCHINFO pPatch;
5347	int rc;
5348	RTGCPTR pInstrGC = pPatchRec->patch.pPrivInstrGC;
5349
5350	Log(("patmR3RefreshPatch: attempt to refresh patch at %VGv\n", pInstrGC));
5351
5352	pPatch = &pPatchRec->patch;
5353	AssertReturn(pPatch->flags & (PATMFL_DUPLICATE_FUNCTION\|PATMFL_IDTHANDLER\|PATMFL_TRAPHANDLER), VERR_PATCHING_REFUSED);
5354	AssertReturn(!(pPatch->flags & PATMFL_EXTERNAL_JUMP_INSIDE), VERR_PATCHING_REFUSED);
5355
5356	/** Note: quite ugly to enable/disable/remove/insert old and new patches, but there's no easy way around it. */
5357
5358	rc = PATMR3DisablePatch(pVM, pInstrGC);
5359	AssertRC(rc);
5360
5361	/** Kick it out of the lookup tree to make sure PATMR3InstallPatch doesn't fail (hack alert) */
5362	RTAvloGCPtrRemove(&pVM->patm.s.PatchLookupTreeHC->PatchTree, pPatchRec->Core.Key);
5363	#ifdef VBOX_WITH_STATISTICS
5364	if (PATM_STAT_INDEX_IS_VALID(pPatchRec->patch.uPatchIdx))
5365	{
5366	STAMR3Deregister(pVM, &pPatchRec->patch);
5367	#ifndef DEBUG_sandervl
5368	STAMR3Deregister(pVM, &pVM->patm.s.pStatsHC[pPatchRec->patch.uPatchIdx]);
5369	STAMR3Deregister(pVM, &pPatchRec->patch.cbPatchBlockSize);
5370	STAMR3Deregister(pVM, &pPatchRec->patch.cbPatchJump);
5371	STAMR3Deregister(pVM, &pPatchRec->patch.cbPrivInstr);
5372	STAMR3Deregister(pVM, &pPatchRec->patch.cCodeWrites);
5373	STAMR3Deregister(pVM, &pPatchRec->patch.cInvalidWrites);
5374	STAMR3Deregister(pVM, &pPatchRec->patch.cTraps);
5375	STAMR3Deregister(pVM, &pPatchRec->patch.flags);
5376	STAMR3Deregister(pVM, &pPatchRec->patch.nrJumpRecs);
5377	STAMR3Deregister(pVM, &pPatchRec->patch.nrFixups);
5378	STAMR3Deregister(pVM, &pPatchRec->patch.opcode);
5379	STAMR3Deregister(pVM, &pPatchRec->patch.uState);
5380	STAMR3Deregister(pVM, &pPatchRec->patch.uOldState);
5381	STAMR3Deregister(pVM, &pPatchRec->patch.uOpMode);
5382	#endif
5383	}
5384	#endif
5385
5386	/** Note: We don't attempt to reuse patch memory here as it's quite common that the new code block requires more memory. */
5387
5388	/* Attempt to install a new patch. */
5389	rc = PATMR3InstallPatch(pVM, pInstrGC, pPatch->flags & (PATMFL_CODE32\|PATMFL_IDTHANDLER\|PATMFL_INTHANDLER\|PATMFL_TRAPHANDLER\|PATMFL_DUPLICATE_FUNCTION\|PATMFL_TRAPHANDLER_WITH_ERRORCODE\|PATMFL_IDTHANDLER_WITHOUT_ENTRYPOINT));
5390	if (VBOX_SUCCESS(rc))
5391	{
5392	RTGCPTR pPatchTargetGC;
5393	PPATMPATCHREC pNewPatchRec;
5394
5395	/* Determine target address in new patch */
5396	pPatchTargetGC = PATMR3QueryPatchGCPtr(pVM, pInstrGC);
5397	Assert(pPatchTargetGC);
5398	if (!pPatchTargetGC)
5399	{
5400	rc = VERR_PATCHING_REFUSED;
5401	goto failure;
5402	}
5403
5404	/* Reset offset into patch memory to put the next code blocks right at the beginning. */
5405	pPatch->uCurPatchOffset = 0;
5406
5407	/* insert jump to new patch in old patch block */
5408	rc = patmPatchGenPatchJump(pVM, pPatch, pInstrGC, pPatchTargetGC, false /* no lookup record */);
5409	if (VBOX_FAILURE(rc))
5410	goto failure;
5411
5412	pNewPatchRec = (PPATMPATCHREC)RTAvloGCPtrGet(&pVM->patm.s.PatchLookupTreeHC->PatchTree, pInstrGC);
5413	Assert(pNewPatchRec); /* can't fail */
5414
5415	/* Remove old patch (only do that when everything is finished) */
5416	int rc2 = PATMRemovePatch(pVM, pPatchRec, true /* force removal */);
5417	AssertRC(rc2);
5418
5419	/* Put the new patch back into the tree, because removing the old one kicked this one out. (hack alert) */
5420	RTAvloGCPtrInsert(&pVM->patm.s.PatchLookupTreeHC->PatchTree, &pNewPatchRec->Core);
5421
5422	LogRel(("PATM: patmR3RefreshPatch: succeeded to refresh patch at %VGv \n", pInstrGC));
5423	STAM_COUNTER_INC(&pVM->patm.s.StatPatchRefreshSuccess);
5424	}
5425
5426	failure:
5427	if (VBOX_FAILURE(rc))
5428	{
5429	LogRel(("PATM: patmR3RefreshPatch: failed to refresh patch at %VGv. Reactiving old one. \n", pInstrGC));
5430
5431	/* Remove the new inactive patch */
5432	rc = PATMR3RemovePatch(pVM, pInstrGC);
5433	AssertRC(rc);
5434
5435	/* Put the old patch back into the tree (or else it won't be saved) (hack alert) */
5436	RTAvloGCPtrInsert(&pVM->patm.s.PatchLookupTreeHC->PatchTree, &pPatchRec->Core);
5437
5438	/* Enable again in case the dirty instruction is near the end and there are safe code paths. */
5439	int rc2 = PATMR3EnablePatch(pVM, pInstrGC);
5440	AssertRC(rc2);
5441
5442	STAM_COUNTER_INC(&pVM->patm.s.StatPatchRefreshFailed);
5443	}
5444	return rc;
5445	}
5446
5447	/**
5448	* Find patch for privileged instruction at specified location
5449	*
5450	* @returns Patch structure pointer if found; else NULL
5451	* @param pVM The VM to operate on.
5452	* @param pInstr Guest context point to instruction that might lie within 5 bytes of an existing patch jump
5453	* @param fIncludeHints Include hinted patches or not
5454	*
5455	*/
5456	PPATCHINFO PATMFindActivePatchByEntrypoint(PVM pVM, RTGCPTR pInstrGC, bool fIncludeHints)
5457	{
5458	PPATMPATCHREC pPatchRec = (PPATMPATCHREC)RTAvloGCPtrGetBestFit(&pVM->patm.s.PatchLookupTreeHC->PatchTree, pInstrGC, false);
5459	/* if the patch is enabled, the pointer is not indentical to the privileged patch ptr and it lies within 5 bytes of this priv instr ptr, then we've got a hit! */
5460	if (pPatchRec)
5461	{
5462	if ( pPatchRec->patch.uState == PATCH_ENABLED
5463	&& (pPatchRec->patch.flags & PATMFL_PATCHED_GUEST_CODE)
5464	&& pInstrGC > pPatchRec->patch.pPrivInstrGC
5465	&& pInstrGC < pPatchRec->patch.pPrivInstrGC + pPatchRec->patch.cbPatchJump)
5466	{
5467	Log(("Found active patch at %VGv (org %VGv)\n", pInstrGC, pPatchRec->patch.pPrivInstrGC));
5468	return &pPatchRec->patch;
5469	}
5470	else
5471	if ( fIncludeHints
5472	&& pPatchRec->patch.uState == PATCH_DISABLED
5473	&& (pPatchRec->patch.flags & PATMFL_INSTR_HINT)
5474	&& pInstrGC > pPatchRec->patch.pPrivInstrGC
5475	&& pInstrGC < pPatchRec->patch.pPrivInstrGC + pPatchRec->patch.cbPatchJump)
5476	{
5477	Log(("Found HINT patch at %VGv (org %VGv)\n", pInstrGC, pPatchRec->patch.pPrivInstrGC));
5478	return &pPatchRec->patch;
5479	}
5480	}
5481	return NULL;
5482	}
5483
5484	/**
5485	* Checks whether the GC address is inside a generated patch jump
5486	*
5487	* @returns true -> yes, false -> no
5488	* @param pVM The VM to operate on.
5489	* @param pAddr Guest context address
5490	* @param pPatchAddr Guest context patch address (if true)
5491	*/
5492	PATMR3DECL(bool) PATMR3IsInsidePatchJump(PVM pVM, RTGCPTR pAddr, PRTGCPTR pPatchAddr)
5493	{
5494	RTGCPTR addr;
5495	PPATCHINFO pPatch;
5496
5497	if (PATMIsEnabled(pVM) == false)
5498	return false;
5499
5500	if (pPatchAddr == NULL)
5501	pPatchAddr = &addr;
5502
5503	*pPatchAddr = 0;
5504
5505	pPatch = PATMFindActivePatchByEntrypoint(pVM, pAddr);
5506	if (pPatch)
5507	{
5508	*pPatchAddr = pPatch->pPrivInstrGC;
5509	}
5510	return *pPatchAddr == 0 ? false : true;
5511	}
5512
5513	/**
5514	* Remove patch for privileged instruction at specified location
5515	*
5516	* @returns VBox status code.
5517	* @param pVM The VM to operate on.
5518	* @param pInstr Guest context point to privileged instruction
5519	*
5520	* @note returns failure if patching is not allowed or possible
5521	*
5522	*/
5523	PATMR3DECL(int) PATMR3RemovePatch(PVM pVM, RTGCPTR pInstrGC)
5524	{
5525	PPATMPATCHREC pPatchRec;
5526
5527	pPatchRec = (PPATMPATCHREC)RTAvloGCPtrGet(&pVM->patm.s.PatchLookupTreeHC->PatchTree, pInstrGC);
5528	if (pPatchRec)
5529	{
5530	int rc = PATMR3DisablePatch(pVM, pInstrGC);
5531	if (rc == VWRN_PATCH_REMOVED)
5532	return VINF_SUCCESS;
5533	return PATMRemovePatch(pVM, pPatchRec, false);
5534	}
5535	AssertFailed();
5536	return VERR_PATCH_NOT_FOUND;
5537	}
5538
5539	/**
5540	* Mark patch as dirty
5541	*
5542	* @returns VBox status code.
5543	* @param pVM The VM to operate on.
5544	* @param pPatch Patch record
5545	*
5546	* @note returns failure if patching is not allowed or possible
5547	*
5548	*/
5549	PATMR3DECL(int) PATMR3MarkDirtyPatch(PVM pVM, PPATCHINFO pPatch)
5550	{
5551	if (pPatch->pPatchBlockOffset)
5552	{
5553	Log(("Invalidate patch at %VGv (HC=%VGv)\n", PATCHCODE_PTR_GC(pPatch), PATCHCODE_PTR_HC(pPatch)));
5554	pPatch->bDirtyOpcode = *PATCHCODE_PTR_HC(pPatch);
5555	*PATCHCODE_PTR_HC(pPatch) = 0xCC;
5556	}
5557
5558	STAM_COUNTER_INC(&pVM->patm.s.StatDirty);
5559	/* Put back the replaced instruction. */
5560	int rc = PATMR3DisablePatch(pVM, pPatch->pPrivInstrGC);
5561	if (rc == VWRN_PATCH_REMOVED)
5562	return VINF_SUCCESS;
5563
5564	/** @note we don't restore patch pages for patches that are not enabled! */
5565	/** @note be careful when changing this behaviour!! */
5566
5567	/* The patch pages are no longer marked for self-modifying code detection */
5568	if (pPatch->flags & PATMFL_CODE_MONITORED)
5569	{
5570	int rc = patmRemovePatchPages(pVM, pPatch);
5571	AssertRCReturn(rc, rc);
5572	}
5573	pPatch->uState = PATCH_DIRTY;
5574
5575	/* Paranoia; make sure this patch is not somewhere in the callchain, so prevent ret instructions from succeeding. */
5576	CTXSUFF(pVM->patm.s.pGCState)->Psp = PATM_STACK_SIZE;
5577
5578	return VINF_SUCCESS;
5579	}
5580
5581	/**
5582	* Query the corresponding GC instruction pointer from a pointer inside the patch block itself
5583	*
5584	* @returns VBox status code.
5585	* @param pVM The VM to operate on.
5586	* @param pPatch Patch block structure pointer
5587	* @param pPatchGC GC address in patch block
5588	*/
5589	RTGCPTR patmPatchGCPtr2GuestGCPtr(PVM pVM, PPATCHINFO pPatch, GCPTRTYPE(uint8_t *) pPatchGC)
5590	{
5591	Assert(pPatch->Patch2GuestAddrTree);
5592	/* Get the closest record from below. */
5593	PRECPATCHTOGUEST pPatchToGuestRec = (PRECPATCHTOGUEST)RTAvlU32GetBestFit(&pPatch->Patch2GuestAddrTree, pPatchGC - pVM->patm.s.pPatchMemGC, false);
5594	if (pPatchToGuestRec)
5595	return pPatchToGuestRec->pOrgInstrGC;
5596
5597	return 0;
5598	}
5599
5600	/* Converts Guest code GC ptr to Patch code GC ptr (if found)
5601	*
5602	* @returns corresponding GC pointer in patch block
5603	* @param pVM The VM to operate on.
5604	* @param pPatch Current patch block pointer
5605	* @param pInstrGC Guest context pointer to privileged instruction
5606	*
5607	*/
5608	RTGCPTR patmGuestGCPtrToPatchGCPtr(PVM pVM, PPATCHINFO pPatch, GCPTRTYPE(uint8_t*) pInstrGC)
5609	{
5610	if (pPatch->Guest2PatchAddrTree)
5611	{
5612	PRECGUESTTOPATCH pGuestToPatchRec = (PRECGUESTTOPATCH)RTAvlGCPtrGet(&pPatch->Guest2PatchAddrTree, pInstrGC);
5613	if (pGuestToPatchRec)
5614	return pVM->patm.s.pPatchMemGC + pGuestToPatchRec->PatchOffset;
5615	}
5616
5617	return 0;
5618	}
5619
5620	/* Converts Guest code GC ptr to Patch code GC ptr (if found)
5621	*
5622	* @returns corresponding GC pointer in patch block
5623	* @param pVM The VM to operate on.
5624	* @param pInstrGC Guest context pointer to privileged instruction
5625	*
5626	*/
5627	PATMR3DECL(RTGCPTR) PATMR3GuestGCPtrToPatchGCPtr(PVM pVM, GCPTRTYPE(uint8_t*)pInstrGC)
5628	{
5629	PPATMPATCHREC pPatchRec = (PPATMPATCHREC)RTAvloGCPtrGetBestFit(&pVM->patm.s.PatchLookupTreeHC->PatchTree, pInstrGC, false);
5630	if (pPatchRec && pPatchRec->patch.uState == PATCH_ENABLED && pInstrGC >= pPatchRec->patch.pPrivInstrGC)
5631	{
5632	return patmGuestGCPtrToPatchGCPtr(pVM, &pPatchRec->patch, pInstrGC);
5633	}
5634	return 0;
5635	}
5636
5637	/**
5638	* Query the corresponding GC instruction pointer from a pointer inside the patch block itself
5639	*
5640	* @returns original GC instruction pointer or 0 if not found
5641	* @param pVM The VM to operate on.
5642	* @param pPatchGC GC address in patch block
5643	* @param pEnmState State of the translated address (out)
5644	*
5645	*/
5646	PATMR3DECL(RTGCPTR) PATMR3PatchToGCPtr(PVM pVM, RTGCPTR pPatchGC, PATMTRANSSTATE *pEnmState)
5647	{
5648	PPATMPATCHREC pPatchRec;
5649	void *pvPatchCoreOffset;
5650	RTGCPTR pPrivInstrGC;
5651
5652	Assert(PATMIsPatchGCAddr(pVM, pPatchGC));
5653	pvPatchCoreOffset = RTAvloGCPtrGetBestFit(&pVM->patm.s.PatchLookupTreeHC->PatchTreeByPatchAddr, pPatchGC - pVM->patm.s.pPatchMemGC, false);
5654	if (pvPatchCoreOffset == 0)
5655	{
5656	Log(("PATMR3PatchToGCPtr failed for %VGv offset %x\n", pPatchGC, pPatchGC - pVM->patm.s.pPatchMemGC));
5657	return 0;
5658	}
5659	pPatchRec = PATM_PATCHREC_FROM_COREOFFSET(pvPatchCoreOffset);
5660	pPrivInstrGC = patmPatchGCPtr2GuestGCPtr(pVM, &pPatchRec->patch, pPatchGC);
5661	if (pEnmState)
5662	{
5663	AssertMsg(pPrivInstrGC && ( pPatchRec->patch.uState == PATCH_ENABLED
5664	\|\| pPatchRec->patch.uState == PATCH_DIRTY
5665	\|\| pPatchRec->patch.uState == PATCH_DISABLE_PENDING
5666	\|\| pPatchRec->patch.uState == PATCH_UNUSABLE),
5667	("pPrivInstrGC=%VGv uState=%d\n", pPrivInstrGC, pPatchRec->patch.uState));
5668
5669	if ( !pPrivInstrGC
5670	\|\| pPatchRec->patch.uState == PATCH_UNUSABLE
5671	\|\| pPatchRec->patch.uState == PATCH_REFUSED)
5672	{
5673	pPrivInstrGC = 0;
5674	*pEnmState = PATMTRANS_FAILED;
5675	}
5676	else
5677	if (pVM->patm.s.pGCStateHC->GCPtrInhibitInterrupts == pPrivInstrGC)
5678	{
5679	*pEnmState = PATMTRANS_INHIBITIRQ;
5680	}
5681	else
5682	if ( pPatchRec->patch.uState == PATCH_ENABLED
5683	&& !(pPatchRec->patch.flags & (PATMFL_DUPLICATE_FUNCTION\|PATMFL_IDTHANDLER\|PATMFL_TRAMPOLINE))
5684	&& pPrivInstrGC > pPatchRec->patch.pPrivInstrGC
5685	&& pPrivInstrGC < pPatchRec->patch.pPrivInstrGC + pPatchRec->patch.cbPatchJump)
5686	{
5687	*pEnmState = PATMTRANS_OVERWRITTEN;
5688	}
5689	else
5690	if (PATMFindActivePatchByEntrypoint(pVM, pPrivInstrGC))
5691	{
5692	*pEnmState = PATMTRANS_OVERWRITTEN;
5693	}
5694	else
5695	if (pPrivInstrGC == pPatchRec->patch.pPrivInstrGC)
5696	{
5697	*pEnmState = PATMTRANS_PATCHSTART;
5698	}
5699	else
5700	*pEnmState = PATMTRANS_SAFE;
5701	}
5702	return pPrivInstrGC;
5703	}
5704
5705	/**
5706	* Returns the GC pointer of the patch for the specified GC address
5707	*
5708	* @returns VBox status code.
5709	* @param pVM The VM to operate on.
5710	* @param pAddrGC Guest context address
5711	*/
5712	PATMR3DECL(RTGCPTR) PATMR3QueryPatchGCPtr(PVM pVM, RTGCPTR pAddrGC)
5713	{
5714	PPATMPATCHREC pPatchRec;
5715
5716	// Find the patch record
5717	pPatchRec = (PPATMPATCHREC)RTAvloGCPtrGet(&pVM->patm.s.PatchLookupTreeHC->PatchTree, pAddrGC);
5718	/** @todo we should only use patches that are enabled! always did this, but it's incorrect! */
5719	if (pPatchRec && (pPatchRec->patch.uState == PATCH_ENABLED \|\| pPatchRec->patch.uState == PATCH_DIRTY))
5720	return PATCHCODE_PTR_GC(&pPatchRec->patch);
5721
5722	return 0;
5723	}
5724
5725	/**
5726	* Attempt to recover dirty instructions
5727	*
5728	* @returns VBox status code.
5729	* @param pVM The VM to operate on.
5730	* @param pCtx CPU context
5731	* @param pPatch Patch record
5732	* @param pPatchToGuestRec Patch to guest address record
5733	* @param pEip GC pointer of trapping instruction
5734	*/
5735	static int patmR3HandleDirtyInstr(PVM pVM, PCPUMCTX pCtx, PPATMPATCHREC pPatch, PRECPATCHTOGUEST pPatchToGuestRec, RTGCPTR pEip)
5736	{
5737	DISCPUSTATE CpuOld, CpuNew;
5738	uint8_t pPatchInstrHC, pCurPatchInstrHC;
5739	int rc;
5740	RTGCPTR pCurInstrGC, pCurPatchInstrGC;
5741	uint32_t cbDirty;
5742	PRECPATCHTOGUEST pRec;
5743
5744	Log(("patmR3HandleDirtyInstr: dirty instruction at %VGv (%VGv)\n", pEip, pPatchToGuestRec->pOrgInstrGC));
5745
5746	pRec = pPatchToGuestRec;
5747	pCurInstrGC = pPatchToGuestRec->pOrgInstrGC;
5748	pCurPatchInstrGC = pEip;
5749	cbDirty = 0;
5750	pPatchInstrHC = patmPatchGCPtr2PatchHCPtr(pVM, pCurPatchInstrGC);
5751
5752	/* Find all adjacent dirty instructions */
5753	while (true)
5754	{
5755	if (pRec->fJumpTarget)
5756	{
5757	LogRel(("PATM: patmR3HandleDirtyInstr: dirty instruction at %VGv (%VGv) ignored, because instruction in function was reused as target of jump\n", pEip, pPatchToGuestRec->pOrgInstrGC));
5758	pRec->fDirty = false;
5759	return VERR_PATCHING_REFUSED;
5760	}
5761
5762	/* Restore original instruction opcode byte so we can check if the write was indeed safe. */
5763	pCurPatchInstrHC = patmPatchGCPtr2PatchHCPtr(pVM, pCurPatchInstrGC);
5764	*pCurPatchInstrHC = pRec->u8DirtyOpcode;
5765
5766	/* Only harmless instructions are acceptable. */
5767	rc = CPUMR3DisasmInstrCPU(pVM, pCtx, pCurPatchInstrGC, &CpuOld, 0);
5768	if ( VBOX_FAILURE(rc)
5769	\|\| !(CpuOld.pCurInstr->optype & OPTYPE_HARMLESS))
5770	break;
5771
5772	#ifdef DEBUG
5773	char szBuf[256];
5774	szBuf[0] = '\0';
5775	DBGFR3DisasInstr(pVM, pCtx->cs, pCurPatchInstrGC, szBuf, sizeof(szBuf));
5776	Log(("DIRTY: %s\n", szBuf));
5777	#endif
5778	/** Remove old lookup record. */
5779	patmr3RemoveP2GLookupRecord(pVM, &pPatch->patch, pCurPatchInstrGC);
5780
5781	pCurPatchInstrGC += CpuOld.opsize;
5782	cbDirty += CpuOld.opsize;
5783
5784	/* Mark as clean; if we fail we'll let it always fault. */
5785	pRec->fDirty = false;
5786
5787	/* Let's see if there's another dirty instruction right after. */
5788	pRec = (PRECPATCHTOGUEST)RTAvlU32GetBestFit(&pPatch->patch.Patch2GuestAddrTree, pCurPatchInstrGC - pVM->patm.s.pPatchMemGC, true);
5789	if (!pRec \|\| !pRec->fDirty)
5790	break; /* no more dirty instructions */
5791	}
5792
5793	if ( VBOX_SUCCESS(rc)
5794	&& (CpuOld.pCurInstr->optype & OPTYPE_HARMLESS)
5795	)
5796	{
5797	uint32_t cbLeft;
5798
5799	pCurPatchInstrHC = pPatchInstrHC;
5800	pCurPatchInstrGC = pEip;
5801	cbLeft = cbDirty;
5802
5803	while (cbLeft && VBOX_SUCCESS(rc))
5804	{
5805	bool fValidInstr;
5806
5807	rc = CPUMR3DisasmInstrCPU(pVM, pCtx, pCurInstrGC, &CpuNew, 0);
5808
5809	fValidInstr = !!(CpuNew.pCurInstr->optype & OPTYPE_HARMLESS);
5810	if ( !fValidInstr
5811	&& (CpuNew.pCurInstr->optype & OPTYPE_RELATIVE_CONTROLFLOW)
5812	)
5813	{
5814	RTGCPTR pTargetGC = PATMResolveBranch(&CpuNew, pCurInstrGC);
5815
5816	if ( pTargetGC >= pPatchToGuestRec->pOrgInstrGC
5817	&& pTargetGC <= pPatchToGuestRec->pOrgInstrGC + cbDirty
5818	)
5819	{
5820	/* A relative jump to an instruction inside or to the end of the dirty block is acceptable. */
5821	fValidInstr = true;
5822	}
5823	}
5824
5825	/* If the instruction is completely harmless (which implies a 1:1 patch copy). */
5826	if ( rc == VINF_SUCCESS
5827	&& CpuNew.opsize <= cbLeft /* must still fit */
5828	&& fValidInstr
5829	)
5830	{
5831	#ifdef DEBUG
5832	char szBuf[256];
5833	szBuf[0] = '\0';
5834	DBGFR3DisasInstr(pVM, pCtx->cs, pCurInstrGC, szBuf, sizeof(szBuf));
5835	Log(("NEW: %s\n", szBuf));
5836	#endif
5837
5838	/* Copy the new instruction. */
5839	rc = PGMPhysReadGCPtr(pVM, pCurPatchInstrHC, pCurInstrGC, CpuNew.opsize);
5840	AssertRC(rc);
5841
5842	/* Add a new lookup record for the duplicated instruction. */
5843	patmr3AddP2GLookupRecord(pVM, &pPatch->patch, pCurPatchInstrHC, pCurInstrGC, PATM_LOOKUP_BOTHDIR);
5844	}
5845	else
5846	{
5847	#ifdef DEBUG
5848	char szBuf[256];
5849	szBuf[0] = '\0';
5850	DBGFR3DisasInstr(pVM, pCtx->cs, pCurInstrGC, szBuf, sizeof(szBuf));
5851	Log(("NEW: %s (FAILED)\n", szBuf));
5852	#endif
5853	/* Restore the old lookup record for the duplicated instruction. */
5854	patmr3AddP2GLookupRecord(pVM, &pPatch->patch, pCurPatchInstrHC, pCurInstrGC, PATM_LOOKUP_BOTHDIR);
5855
5856	/** @todo in theory we need to restore the lookup records for the remaining dirty instructions too! */
5857	rc = VERR_PATCHING_REFUSED;
5858	break;
5859	}
5860	pCurInstrGC += CpuNew.opsize;
5861	pCurPatchInstrHC += CpuNew.opsize;
5862	pCurPatchInstrGC += CpuNew.opsize;
5863	cbLeft -= CpuNew.opsize;
5864	}
5865	}
5866	else
5867	rc = VERR_PATCHING_REFUSED;
5868
5869	if (VBOX_SUCCESS(rc))
5870	{
5871	STAM_COUNTER_INC(&pVM->patm.s.StatInstrDirtyGood);
5872	}
5873	else
5874	{
5875	STAM_COUNTER_INC(&pVM->patm.s.StatInstrDirtyBad);
5876	/* Mark the whole instruction stream with breakpoints. */
5877	memset(pPatchInstrHC, 0xCC, cbDirty);
5878
5879	if ( pVM->patm.s.fOutOfMemory == false
5880	&& (pPatch->patch.flags & (PATMFL_DUPLICATE_FUNCTION\|PATMFL_IDTHANDLER\|PATMFL_TRAPHANDLER)))
5881	{
5882	rc = patmR3RefreshPatch(pVM, pPatch);
5883	if (VBOX_FAILURE(rc))
5884	{
5885	LogRel(("PATM: Failed to refresh dirty patch at %VGv. Disabling it.\n", pPatch->patch.pPrivInstrGC));
5886	}
5887	/* Even if we succeed, we must go back to the original instruction as the patched one could be invalid. */
5888	rc = VERR_PATCHING_REFUSED;
5889	}
5890	}
5891	return rc;
5892	}
5893
5894	/**
5895	* Handle trap inside patch code
5896	*
5897	* @returns VBox status code.
5898	* @param pVM The VM to operate on.
5899	* @param pCtx CPU context
5900	* @param pEip GC pointer of trapping instruction
5901	* @param ppNewEip GC pointer to new instruction
5902	*/
5903	PATMR3DECL(int) PATMR3HandleTrap(PVM pVM, PCPUMCTX pCtx, RTGCPTR pEip, RTGCPTR *ppNewEip)
5904	{
5905	PPATMPATCHREC pPatch = 0;
5906	void *pvPatchCoreOffset;
5907	RTGCUINTPTR offset;
5908	RTGCPTR pNewEip;
5909	int rc ;
5910	PRECPATCHTOGUEST pPatchToGuestRec = 0;
5911
5912	pNewEip = 0;
5913	*ppNewEip = 0;
5914
5915	STAM_PROFILE_ADV_START(&pVM->patm.s.StatHandleTrap, a);
5916
5917	/* Find the patch record. */
5918	/** @note there might not be a patch to guest translation record (global function) */
5919	offset = pEip - pVM->patm.s.pPatchMemGC;
5920	pvPatchCoreOffset = RTAvloGCPtrGetBestFit(&pVM->patm.s.PatchLookupTreeHC->PatchTreeByPatchAddr, offset, false);
5921	if (pvPatchCoreOffset)
5922	{
5923	pPatch = PATM_PATCHREC_FROM_COREOFFSET(pvPatchCoreOffset);
5924
5925	if (pPatch->patch.uState == PATCH_DIRTY)
5926	{
5927	Log(("PATMR3HandleTrap: trap in dirty patch at %VGv\n", pEip));
5928	if (pPatch->patch.flags & (PATMFL_DUPLICATE_FUNCTION\|PATMFL_CALLABLE_AS_FUNCTION))
5929	{
5930	/* Function duplication patches set fPIF to 1 on entry */
5931	pVM->patm.s.pGCStateHC->fPIF = 1;
5932	}
5933	}
5934	else
5935	if (pPatch->patch.uState == PATCH_DISABLED)
5936	{
5937	Log(("PATMR3HandleTrap: trap in disabled patch at %VGv\n", pEip));
5938	if (pPatch->patch.flags & (PATMFL_DUPLICATE_FUNCTION\|PATMFL_CALLABLE_AS_FUNCTION))
5939	{
5940	/* Function duplication patches set fPIF to 1 on entry */
5941	pVM->patm.s.pGCStateHC->fPIF = 1;
5942	}
5943	}
5944	else
5945	if (pPatch->patch.uState == PATCH_DISABLE_PENDING)
5946	{
5947	RTGCPTR pPrivInstrGC = pPatch->patch.pPrivInstrGC;
5948
5949	Log(("PATMR3HandleTrap: disable operation is pending for patch at %VGv\n", pPatch->patch.pPrivInstrGC));
5950	rc = PATMR3DisablePatch(pVM, pPatch->patch.pPrivInstrGC);
5951	AssertReleaseMsg(rc != VWRN_PATCH_REMOVED, ("PATMR3DisablePatch removed patch at %VGv\n", pPrivInstrGC));
5952	AssertMsg(pPatch->patch.uState == PATCH_DISABLED \|\| pPatch->patch.uState == PATCH_UNUSABLE, ("Unexpected failure to disable patch state=%d rc=%Vrc\n", pPatch->patch.uState, rc));
5953	}
5954
5955	pPatchToGuestRec = (PRECPATCHTOGUEST)RTAvlU32GetBestFit(&pPatch->patch.Patch2GuestAddrTree, offset, false);
5956	AssertReleaseMsg(pPatchToGuestRec, ("PATMR3HandleTrap: Unable to find corresponding guest address for %VGv (offset %x)\n", pEip, offset));
5957
5958	pNewEip = pPatchToGuestRec->pOrgInstrGC;
5959	pPatch->patch.cTraps++;
5960	PATM_STAT_FAULT_INC(&pPatch->patch);
5961	}
5962	else
5963	AssertReleaseMsg(pVM->patm.s.pGCStateHC->fPIF == 0, ("PATMR3HandleTrap: Unable to find translation record for %VGv (PIF=0)\n", pEip));
5964
5965	/* Check if we were interrupted in PATM generated instruction code. */
5966	if (pVM->patm.s.pGCStateHC->fPIF == 0)
5967	{
5968	DISCPUSTATE Cpu;
5969	rc = CPUMR3DisasmInstrCPU(pVM, pCtx, pEip, &Cpu, "PIF Trap: ");
5970	AssertRC(rc);
5971
5972	if ( rc == VINF_SUCCESS
5973	&& ( Cpu.pCurInstr->opcode == OP_PUSHF
5974	\|\| Cpu.pCurInstr->opcode == OP_PUSH
5975	\|\| Cpu.pCurInstr->opcode == OP_CALL)
5976	)
5977	{
5978	STAM_COUNTER_INC(&pVM->patm.s.StatPushTrap);
5979	/* Typical pushf (most patches)/push (call patch) trap because of a monitored page. */
5980	rc = PGMShwModifyPage(pVM, pCtx->esp, 1, X86_PTE_RW, ~(uint64_t)X86_PTE_RW);
5981	AssertMsgRC(rc, ("PGMShwModifyPage -> rc=%Vrc\n", rc));
5982	if (rc == VINF_SUCCESS)
5983	{
5984	uint64_t fFlags;
5985
5986	/* The guest page must be present. */
5987	rc = PGMGstGetPage(pVM, pCtx->esp, &fFlags, NULL);
5988	if (rc == VINF_SUCCESS && (fFlags & X86_PTE_P))
5989	{
5990	STAM_PROFILE_ADV_STOP(&pVM->patm.s.StatHandleTrap, a);
5991	return VINF_PATCH_CONTINUE;
5992	}
5993	}
5994	}
5995
5996	char szBuf[256];
5997	szBuf[0] = '\0';
5998	DBGFR3DisasInstr(pVM, pCtx->cs, pEip, szBuf, sizeof(szBuf));
5999
6000	/* Very bad. We crashed in emitted code. Probably stack? */
6001	if (pPatch)
6002	{
6003	AssertReleaseMsg(pVM->patm.s.pGCStateHC->fPIF == 1,
6004	("Crash in patch code %VGv (%VGv) esp=%RX32\nPatch state=%x flags=%x fDirty=%d\n%s\n", pEip, pNewEip, CPUMGetGuestESP(pVM), pPatch->patch.uState, pPatch->patch.flags, pPatchToGuestRec->fDirty, szBuf));
6005	}
6006	else
6007	AssertReleaseMsg(pVM->patm.s.pGCStateHC->fPIF == 1,
6008	("Crash in patch code %VGv (%VGv) esp=%RX32\n%s\n", pEip, pNewEip, CPUMGetGuestESP(pVM), szBuf));
6009	EMR3FatalError(pVM, VERR_INTERNAL_ERROR);
6010	}
6011
6012	/* From here on, we must have a valid patch to guest translation. */
6013	if (pvPatchCoreOffset == 0)
6014	{
6015	STAM_PROFILE_ADV_STOP(&pVM->patm.s.StatHandleTrap, a);
6016	AssertMsgFailed(("PATMR3HandleTrap: patch not found at address %VGv!!\n", pEip));
6017	return VERR_PATCH_NOT_FOUND; //fatal error
6018	}
6019
6020	/* Take care of dirty/changed instructions. */
6021	if (pPatchToGuestRec->fDirty)
6022	{
6023	Assert(pPatchToGuestRec->Core.Key == offset);
6024	Assert(pVM->patm.s.pGCStateHC->fPIF == 1);
6025
6026	rc = patmR3HandleDirtyInstr(pVM, pCtx, pPatch, pPatchToGuestRec, pEip);
6027	if (VBOX_SUCCESS(rc))
6028	{
6029	/* Retry the current instruction. */
6030	pNewEip = pEip;
6031	rc = VINF_PATCH_CONTINUE; /* Continue at current patch instruction. */
6032	}
6033	else
6034	{
6035	/* Reset the PATM stack. */
6036	CTXSUFF(pVM->patm.s.pGCState)->Psp = PATM_STACK_SIZE;
6037
6038	rc = VINF_SUCCESS; /* Continue at original instruction. */
6039	}
6040
6041	*ppNewEip = pNewEip;
6042	STAM_PROFILE_ADV_STOP(&pVM->patm.s.StatHandleTrap, a);
6043	return rc;
6044	}
6045
6046	#ifdef VBOX_STRICT
6047	if (pPatch->patch.flags & PATMFL_DUPLICATE_FUNCTION)
6048	{
6049	DISCPUSTATE cpu;
6050	bool disret;
6051	uint32_t opsize;
6052
6053	cpu.mode = (pPatch->patch.flags & PATMFL_CODE32) ? CPUMODE_32BIT : CPUMODE_16BIT;
6054	disret = PATMR3DISInstr(pVM, &pPatch->patch, &cpu, pNewEip, PATMGCVirtToHCVirt(pVM, &pPatch->patch, pNewEip), &opsize, NULL, PATMREAD_RAWCODE);
6055	if (disret && cpu.pCurInstr->opcode == OP_RETN)
6056	{
6057	RTGCPTR retaddr;
6058	PCPUMCTX pCtx;
6059	int rc;
6060
6061	rc = CPUMQueryGuestCtxPtr(pVM, &pCtx);
6062	AssertRC(rc);
6063
6064	rc = PGMPhysReadGCPtr(pVM, &retaddr, pCtx->esp, sizeof(retaddr));
6065	AssertRC(rc);
6066
6067	Log(("Return failed at %VGv (%VGv)\n", pEip, pNewEip));
6068	Log(("Expected return address %VGv found address %VGv Psp=%x\n", pVM->patm.s.pGCStackHC[(pVM->patm.s.pGCStateHC->Psp+PATM_STACK_SIZE)/sizeof(RTGCPTR)], retaddr, pVM->patm.s.pGCStateHC->Psp));
6069	}
6070	}
6071	#endif
6072
6073	/* Return original address, correct by subtracting the CS base address. */
6074	*ppNewEip = pNewEip - SELMToFlat(pVM, pCtx->eflags, pCtx->cs, &pCtx->csHid, 0);
6075
6076	/* Reset the PATM stack. */
6077	CTXSUFF(pVM->patm.s.pGCState)->Psp = PATM_STACK_SIZE;
6078
6079	if (pVM->patm.s.pGCStateHC->GCPtrInhibitInterrupts == pNewEip)
6080	{
6081	/* Must be a faulting instruction after sti; currently only sysexit, hlt or iret */
6082	Log(("PATMR3HandleTrap %VGv -> inhibit irqs set!\n", pEip));
6083	#ifdef VBOX_STRICT
6084	DISCPUSTATE cpu;
6085	bool disret;
6086	uint32_t opsize;
6087
6088	cpu.mode = (pPatch->patch.flags & PATMFL_CODE32) ? CPUMODE_32BIT : CPUMODE_16BIT;
6089	disret = PATMR3DISInstr(pVM, &pPatch->patch, &cpu, pNewEip, PATMGCVirtToHCVirt(pVM, &pPatch->patch, pNewEip), &opsize, NULL, PATMREAD_ORGCODE);
6090
6091	if (disret && (cpu.pCurInstr->opcode == OP_SYSEXIT \|\| cpu.pCurInstr->opcode == OP_HLT \|\| cpu.pCurInstr->opcode == OP_INT3))
6092	{
6093	cpu.mode = (pPatch->patch.flags & PATMFL_CODE32) ? CPUMODE_32BIT : CPUMODE_16BIT;
6094	disret = PATMR3DISInstr(pVM, &pPatch->patch, &cpu, pNewEip, PATMGCVirtToHCVirt(pVM, &pPatch->patch, pNewEip), &opsize, NULL, PATMREAD_RAWCODE);
6095
6096	Assert(cpu.pCurInstr->opcode == OP_SYSEXIT \|\| cpu.pCurInstr->opcode == OP_HLT \|\| cpu.pCurInstr->opcode == OP_IRET);
6097	}
6098	#endif
6099	EMSetInhibitInterruptsPC(pVM, pNewEip);
6100	pVM->patm.s.pGCStateHC->GCPtrInhibitInterrupts = 0;
6101	}
6102
6103	Log2(("pPatchBlockGC %VGv - pEip %VGv corresponding GC address %VGv\n", PATCHCODE_PTR_GC(&pPatch->patch), pEip, pNewEip));
6104
6105	if (pNewEip >= pPatch->patch.pPrivInstrGC && pNewEip < pPatch->patch.pPrivInstrGC + pPatch->patch.cbPatchJump)
6106	{
6107	/* We can't jump back to code that we've overwritten with a 5 byte jump! */
6108	Log(("Disabling patch at location %VGv due to trap too close to the privileged instruction \n", pPatch->patch.pPrivInstrGC));
6109	PATMR3DisablePatch(pVM, pPatch->patch.pPrivInstrGC);
6110	STAM_PROFILE_ADV_STOP(&pVM->patm.s.StatHandleTrap, a);
6111	return VERR_PATCH_DISABLED;
6112	}
6113
6114	#ifdef PATM_REMOVE_PATCH_ON_TOO_MANY_TRAPS
6115	/** @todo compare to nr of successful runs. add some aging algorithm and determine the best time to disable the patch */
6116	if (pPatch->patch.cTraps > MAX_PATCH_TRAPS)
6117	{
6118	Log(("Disabling patch at location %VGv due to too many traps inside patch code\n", pPatch->patch.pPrivInstrGC));
6119	//we are only wasting time, back out the patch
6120	PATMR3DisablePatch(pVM, pPatch->patch.pPrivInstrGC);
6121	pTrapRec->pNextPatchInstr = 0;
6122	STAM_PROFILE_ADV_STOP(&pVM->patm.s.StatHandleTrap, a);
6123	return VERR_PATCH_DISABLED;
6124	}
6125	#endif
6126
6127	STAM_PROFILE_ADV_STOP(&pVM->patm.s.StatHandleTrap, a);
6128	return VINF_SUCCESS;
6129	}
6130
6131
6132	/**
6133	* Handle page-fault in monitored page
6134	*
6135	* @returns VBox status code.
6136	* @param pVM The VM to operate on.
6137	*/
6138	PATMR3DECL(int) PATMR3HandleMonitoredPage(PVM pVM)
6139	{
6140	RTGCPTR addr = pVM->patm.s.pvFaultMonitor;
6141
6142	addr &= PAGE_BASE_GC_MASK;
6143
6144	int rc = PGMHandlerVirtualDeregister(pVM, addr);
6145	AssertRC(rc); NOREF(rc);
6146
6147	PPATMPATCHREC pPatchRec = (PPATMPATCHREC)RTAvloGCPtrGetBestFit(&pVM->patm.s.PatchLookupTreeHC->PatchTree, addr, false);
6148	if (pPatchRec && pPatchRec->patch.uState == PATCH_ENABLED && PAGE_ADDRESS(pPatchRec->patch.pPrivInstrGC) == PAGE_ADDRESS(addr))
6149	{
6150	STAM_COUNTER_INC(&pVM->patm.s.StatMonitored);
6151	Log(("Renewing patch at %VGv\n", pPatchRec->patch.pPrivInstrGC));
6152	rc = PATMR3DisablePatch(pVM, pPatchRec->patch.pPrivInstrGC);
6153	if (rc == VWRN_PATCH_REMOVED)
6154	return VINF_SUCCESS;
6155
6156	PATMR3EnablePatch(pVM, pPatchRec->patch.pPrivInstrGC);
6157
6158	if (addr == pPatchRec->patch.pPrivInstrGC)
6159	addr++;
6160	}
6161
6162	for(;;)
6163	{
6164	pPatchRec = (PPATMPATCHREC)RTAvloGCPtrGetBestFit(&pVM->patm.s.PatchLookupTreeHC->PatchTree, addr, true);
6165
6166	if (!pPatchRec \|\| PAGE_ADDRESS(pPatchRec->patch.pPrivInstrGC) != PAGE_ADDRESS(addr))
6167	break;
6168
6169	if (pPatchRec && pPatchRec->patch.uState == PATCH_ENABLED)
6170	{
6171	STAM_COUNTER_INC(&pVM->patm.s.StatMonitored);
6172	Log(("Renewing patch at %VGv\n", pPatchRec->patch.pPrivInstrGC));
6173	PATMR3DisablePatch(pVM, pPatchRec->patch.pPrivInstrGC);
6174	PATMR3EnablePatch(pVM, pPatchRec->patch.pPrivInstrGC);
6175	}
6176	addr = pPatchRec->patch.pPrivInstrGC + 1;
6177	}
6178
6179	pVM->patm.s.pvFaultMonitor = 0;
6180	return VINF_SUCCESS;
6181	}
6182
6183
6184	#ifdef VBOX_WITH_STATISTICS
6185
6186	static const char *PATMPatchType(PVM pVM, PPATCHINFO pPatch)
6187	{
6188	if (pPatch->flags & PATMFL_SYSENTER)
6189	{
6190	return "SYSENT";
6191	}
6192	else
6193	if (pPatch->flags & (PATMFL_TRAPHANDLER\|PATMFL_INTHANDLER))
6194	{
6195	static char szTrap[16];
6196	uint32_t iGate;
6197
6198	iGate = TRPMR3QueryGateByHandler(pVM, PATCHCODE_PTR_GC(pPatch));
6199	if (iGate < 256)
6200	RTStrPrintf(szTrap, sizeof(szTrap), (pPatch->flags & PATMFL_INTHANDLER) ? "INT-%2X" : "TRAP-%2X", iGate);
6201	else
6202	RTStrPrintf(szTrap, sizeof(szTrap), (pPatch->flags & PATMFL_INTHANDLER) ? "INT-??" : "TRAP-??");
6203	return szTrap;
6204	}
6205	else
6206	if (pPatch->flags & (PATMFL_DUPLICATE_FUNCTION))
6207	return "DUPFUNC";
6208	else
6209	if (pPatch->flags & PATMFL_REPLACE_FUNCTION_CALL)
6210	return "FUNCCALL";
6211	else
6212	if (pPatch->flags & PATMFL_TRAMPOLINE)
6213	return "TRAMP";
6214	else
6215	return patmGetInstructionString(pPatch->opcode, pPatch->flags);
6216	}
6217
6218	static const char *PATMPatchState(PVM pVM, PPATCHINFO pPatch)
6219	{
6220	switch(pPatch->uState)
6221	{
6222	case PATCH_ENABLED:
6223	return "ENA";
6224	case PATCH_DISABLED:
6225	return "DIS";
6226	case PATCH_DIRTY:
6227	return "DIR";
6228	case PATCH_UNUSABLE:
6229	return "UNU";
6230	case PATCH_REFUSED:
6231	return "REF";
6232	case PATCH_DISABLE_PENDING:
6233	return "DIP";
6234	default:
6235	AssertFailed();
6236	return " ";
6237	}
6238	}
6239
6240	/**
6241	* Resets the sample.
6242	* @param pVM The VM handle.
6243	* @param pvSample The sample registered using STAMR3RegisterCallback.
6244	*/
6245	static void patmResetStat(PVM pVM, void *pvSample)
6246	{
6247	PPATCHINFO pPatch = (PPATCHINFO)pvSample;
6248	Assert(pPatch);
6249
6250	pVM->patm.s.pStatsHC[pPatch->uPatchIdx].u32A = 0;
6251	pVM->patm.s.pStatsHC[pPatch->uPatchIdx].u32B = 0;
6252	}
6253
6254	/**
6255	* Prints the sample into the buffer.
6256	*
6257	* @param pVM The VM handle.
6258	* @param pvSample The sample registered using STAMR3RegisterCallback.
6259	* @param pszBuf The buffer to print into.
6260	* @param cchBuf The size of the buffer.
6261	*/
6262	static void patmPrintStat(PVM pVM, void pvSample, char pszBuf, size_t cchBuf)
6263	{
6264	PPATCHINFO pPatch = (PPATCHINFO)pvSample;
6265	Assert(pPatch);
6266
6267	Assert(pPatch->uState != PATCH_REFUSED);
6268	Assert(!(pPatch->flags & (PATMFL_REPLACE_FUNCTION_CALL\|PATMFL_MMIO_ACCESS)));
6269
6270	RTStrPrintf(pszBuf, cchBuf, "size %04x ->%3s %8s - %08d - %08d",
6271	pPatch->cbPatchBlockSize, PATMPatchState(pVM, pPatch), PATMPatchType(pVM, pPatch),
6272	pVM->patm.s.pStatsHC[pPatch->uPatchIdx].u32A, pVM->patm.s.pStatsHC[pPatch->uPatchIdx].u32B);
6273	}
6274
6275	/**
6276	* Returns the GC address of the corresponding patch statistics counter
6277	*
6278	* @returns Stat address
6279	* @param pVM The VM to operate on.
6280	* @param pPatch Patch structure
6281	*/
6282	RTGCPTR patmPatchQueryStatAddress(PVM pVM, PPATCHINFO pPatch)
6283	{
6284	Assert(pPatch->uPatchIdx != PATM_STAT_INDEX_NONE);
6285	return pVM->patm.s.pStatsGC + sizeof(STAMRATIOU32) * pPatch->uPatchIdx + RT_OFFSETOF(STAMRATIOU32, u32A);
6286	}
6287
6288	#endif /* VBOX_WITH_STATISTICS */
6289
6290	#ifdef VBOX_WITH_DEBUGGER
6291	/**
6292	* The '.patmoff' command.
6293	*
6294	* @returns VBox status.
6295	* @param pCmd Pointer to the command descriptor (as registered).
6296	* @param pCmdHlp Pointer to command helper functions.
6297	* @param pVM Pointer to the current VM (if any).
6298	* @param paArgs Pointer to (readonly) array of arguments.
6299	* @param cArgs Number of arguments in the array.
6300	*/
6301	static DECLCALLBACK(int) patmr3CmdOff(PCDBGCCMD pCmd, PDBGCCMDHLP pCmdHlp, PVM pVM, PCDBGCVAR paArgs, unsigned cArgs, PDBGCVAR pResult)
6302	{
6303	/*
6304	* Validate input.
6305	*/
6306	if (!pVM)
6307	return pCmdHlp->pfnPrintf(pCmdHlp, NULL, "error: The command requires VM to be selected.\n");
6308
6309	RTAvloGCPtrDoWithAll(&pVM->patm.s.PatchLookupTreeHC->PatchTree, true, DisableAllPatches, pVM);
6310	PATMR3AllowPatching(pVM, false);
6311	return pCmdHlp->pfnPrintf(pCmdHlp, NULL, "Patching disabled\n");
6312	}
6313
6314	/**
6315	* The '.patmon' command.
6316	*
6317	* @returns VBox status.
6318	* @param pCmd Pointer to the command descriptor (as registered).
6319	* @param pCmdHlp Pointer to command helper functions.
6320	* @param pVM Pointer to the current VM (if any).
6321	* @param paArgs Pointer to (readonly) array of arguments.
6322	* @param cArgs Number of arguments in the array.
6323	*/
6324	static DECLCALLBACK(int) patmr3CmdOn(PCDBGCCMD pCmd, PDBGCCMDHLP pCmdHlp, PVM pVM, PCDBGCVAR paArgs, unsigned cArgs, PDBGCVAR pResult)
6325	{
6326	/*
6327	* Validate input.
6328	*/
6329	if (!pVM)
6330	return pCmdHlp->pfnPrintf(pCmdHlp, NULL, "error: The command requires VM to be selected.\n");
6331
6332	PATMR3AllowPatching(pVM, true);
6333	RTAvloGCPtrDoWithAll(&pVM->patm.s.PatchLookupTreeHC->PatchTree, true, EnableAllPatches, pVM);
6334	return pCmdHlp->pfnPrintf(pCmdHlp, NULL, "Patching enabled\n");
6335	}
6336	#endif

Note: See TracBrowser for help on using the repository browser.

source: vbox/trunk/src/VBox/VMM/PATM/PATM.cpp@ 2919

Download in other formats: