PATM.cpp@ 2705

Last change on this file since 2705 was 2049, checked in by vboxsync, 18 years ago
Disabled ss mov patch again.
Property svn:eol-style set to `native` Property svn:keywords set to `Id`
File size: 236.3 KB

Line
1	/* $Id: PATM.cpp 2049 2007-04-12 14:43:48Z 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 (PAGE_ADDRESS(pInstrGC) != PAGE_ADDRESS(pInstrGC + SIZEOF_NEARJUMP32))
2680	{
2681	STAM_COUNTER_INC(&pVM->patm.s.StatPageBoundaryCrossed);
2682	#ifdef DEBUG_sandervl
2683	//// AssertMsgFailed(("Patch jump would cross page boundary -> refuse!!\n"));
2684	#endif
2685	rc = VERR_PATCHING_REFUSED;
2686	goto failure;
2687	}
2688
2689	pPatch->nrPatch2GuestRecs = 0;
2690	pInstrStart = pInstrGC;
2691
2692	#ifdef PATM_ENABLE_CALL
2693	pPatch->flags \|= PATMFL_SUPPORT_CALLS \| PATMFL_SUPPORT_INDIRECT_CALLS;
2694	#endif
2695
2696	pPatch->pPatchBlockOffset = pVM->patm.s.offPatchMem;
2697	pPatch->uCurPatchOffset = 0;
2698
2699	cpu.mode = (pPatch->flags & PATMFL_CODE32) ? CPUMODE_32BIT : CPUMODE_16BIT;
2700
2701	if ((pPatch->flags & (PATMFL_IDTHANDLER\|PATMFL_IDTHANDLER_WITHOUT_ENTRYPOINT\|PATMFL_SYSENTER)) == PATMFL_IDTHANDLER)
2702	{
2703	Assert(pPatch->flags & PATMFL_INTHANDLER);
2704
2705	/* Install fake cli patch (to clear the virtual IF and check int xx parameters) */
2706	rc = patmPatchGenIntEntry(pVM, pPatch, pInstrGC);
2707	if (VBOX_FAILURE(rc))
2708	goto failure;
2709	}
2710
2711	/***************************************************************************************************************************/
2712	/** @note We can't insert any code before a sysenter handler; some linux guests have an invalid stack at this point!!!!! */
2713	/***************************************************************************************************************************/
2714	#ifdef VBOX_WITH_STATISTICS
2715	if (!(pPatch->flags & PATMFL_SYSENTER))
2716	{
2717	rc = patmPatchGenStats(pVM, pPatch, pInstrGC);
2718	if (VBOX_FAILURE(rc))
2719	goto failure;
2720	}
2721	#endif
2722
2723	rc = patmRecompileCodeStream(pVM, pInstrGC, pInstrGC, patmRecompileCallback, pPatch);
2724	if (rc != VINF_SUCCESS)
2725	{
2726	Log(("PATMR3PatchCli: patmRecompileCodeStream failed with %d\n", rc));
2727	goto failure;
2728	}
2729
2730	/* Calculated during analysis. */
2731	if (pPatch->cbPatchBlockSize < SIZEOF_NEARJUMP32)
2732	{
2733	/* Most likely cause: we encountered an illegal instruction very early on. */
2734	/** @todo could turn it into an int3 callable patch. */
2735	Log(("PATMR3PatchBlock: patch block too small -> refuse\n"));
2736	rc = VERR_PATCHING_REFUSED;
2737	goto failure;
2738	}
2739
2740	/* size of patch block */
2741	pPatch->cbPatchBlockSize = pPatch->uCurPatchOffset;
2742
2743
2744	/* Update free pointer in patch memory. */
2745	pVM->patm.s.offPatchMem += pPatch->cbPatchBlockSize;
2746	/* Round to next 8 byte boundary. */
2747	pVM->patm.s.offPatchMem = RT_ALIGN_32(pVM->patm.s.offPatchMem, 8);
2748
2749	/*
2750	* Insert into patch to guest lookup tree
2751	*/
2752	LogFlow(("Insert %VGv patch offset %VGv\n", pPatchRec->patch.pPrivInstrGC, pPatch->pPatchBlockOffset));
2753	pPatchRec->CoreOffset.Key = pPatch->pPatchBlockOffset;
2754	rc = RTAvloGCPtrInsert(&pVM->patm.s.PatchLookupTreeHC->PatchTreeByPatchAddr, &pPatchRec->CoreOffset);
2755	AssertMsg(rc, ("RTAvlULInsert failed for %x\n", pPatchRec->CoreOffset.Key));
2756	if (!rc)
2757	{
2758	rc = VERR_PATCHING_REFUSED;
2759	goto failure;
2760	}
2761
2762	/* Note that patmr3SetBranchTargets can install additional patches!! */
2763	rc = patmr3SetBranchTargets(pVM, pPatch);
2764	if (rc != VINF_SUCCESS)
2765	{
2766	Log(("PATMR3PatchCli: patmr3SetBranchTargets failed with %d\n", rc));
2767	goto failure;
2768	}
2769
2770	#ifdef LOG_ENABLED
2771	Log(("Patch code ----------------------------------------------------------\n"));
2772	patmr3DisasmCodeStream(pVM, PATCHCODE_PTR_GC(pPatch), PATCHCODE_PTR_GC(pPatch), patmr3DisasmCallback, pPatch);
2773	Log(("Patch code ends -----------------------------------------------------\n"));
2774	#endif
2775
2776	/* make a copy of the guest code bytes that will be overwritten */
2777	pPatch->cbPatchJump = SIZEOF_NEARJUMP32;
2778
2779	rc = PGMPhysReadGCPtr(pVM, pPatch->aPrivInstr, pPatch->pPrivInstrGC, pPatch->cbPatchJump);
2780	AssertRC(rc);
2781
2782	if (pPatch->flags & PATMFL_INT3_REPLACEMENT_BLOCK)
2783	{
2784	/uint8_t ASMInt3 = 0xCC; - unused /
2785
2786	Log(("PATMR3PatchBlock %VGv -> int 3 callable patch.\n", pPatch->pPrivInstrGC));
2787	/* Replace first opcode byte with 'int 3'. */
2788	rc = patmActivateInt3Patch(pVM, pPatch);
2789	if (VBOX_FAILURE(rc))
2790	goto failure;
2791
2792	Assert(!(pPatch->flags & PATMFL_MUST_INSTALL_PATCHJMP));
2793	pPatch->flags &= ~PATMFL_INSTR_HINT;
2794	STAM_COUNTER_INC(&pVM->patm.s.StatInt3Callable);
2795	}
2796	else
2797	if (!(pPatch->flags & PATMFL_IDTHANDLER))
2798	{
2799	pPatch->flags \|= PATMFL_MUST_INSTALL_PATCHJMP;
2800
2801	/* now insert a jump in the guest code */
2802	rc = patmGenJumpToPatch(pVM, pPatch, true);
2803	AssertRC(rc);
2804	if (VBOX_FAILURE(rc))
2805	goto failure;
2806
2807	}
2808
2809	#ifdef LOG_ENABLED
2810	cpu.mode = (pPatch->flags & PATMFL_CODE32) ? CPUMODE_32BIT : CPUMODE_16BIT;
2811	disret = PATMR3DISInstr(pVM, pPatch, &cpu, pPatch->pPrivInstrGC, pPatch->pPrivInstrHC, &opsize, szOutput, PATMREAD_RAWCODE);
2812	Log(("%s patch: %s", patmGetInstructionString(pPatch->opcode, pPatch->flags), szOutput));
2813	#endif
2814
2815	patmEmptyTree(pVM, &pPatch->pTempInfo->IllegalInstrTree);
2816	pPatch->pTempInfo->nrIllegalInstr = 0;
2817
2818	Log(("Successfully installed %s patch at %VGv\n", patmGetInstructionString(pPatch->opcode, pPatch->flags), pInstrGC));
2819
2820	pPatch->uState = PATCH_ENABLED;
2821	return VINF_SUCCESS;
2822
2823	failure:
2824	if (pPatchRec->CoreOffset.Key)
2825	RTAvloGCPtrRemove(&pVM->patm.s.PatchLookupTreeHC->PatchTreeByPatchAddr, pPatchRec->CoreOffset.Key);
2826
2827	patmEmptyTree(pVM, &pPatch->FixupTree);
2828	pPatch->nrFixups = 0;
2829
2830	patmEmptyTree(pVM, &pPatch->JumpTree);
2831	pPatch->nrJumpRecs = 0;
2832
2833	patmEmptyTree(pVM, &pPatch->pTempInfo->IllegalInstrTree);
2834	pPatch->pTempInfo->nrIllegalInstr = 0;
2835
2836	/* Turn this cli patch into a dummy. */
2837	pPatch->uState = PATCH_REFUSED;
2838	pPatch->pPatchBlockOffset = 0;
2839
2840	// Give back the patch memory we no longer need
2841	Assert(orgOffsetPatchMem != (uint32_t)~0);
2842	pVM->patm.s.offPatchMem = orgOffsetPatchMem;
2843
2844	return rc;
2845	}
2846
2847	/**
2848	* Patch IDT handler
2849	*
2850	* @returns VBox status code.
2851	* @param pVM The VM to operate on.
2852	* @param pInstrGC Guest context point to privileged instruction
2853	* @param pInstrHC Host context point to privileged instruction
2854	* @param uOpSize Size of starting instruction
2855	* @param pPatchRec Patch record
2856	*
2857	* @note returns failure if patching is not allowed or possible
2858	*
2859	*/
2860	static int patmIdtHandler(PVM pVM, RTGCPTR pInstrGC, HCPTRTYPE(uint8_t *) pInstrHC,
2861	uint32_t uOpSize, PPATMPATCHREC pPatchRec)
2862	{
2863	PPATCHINFO pPatch = &pPatchRec->patch;
2864	bool disret;
2865	DISCPUSTATE cpuPush, cpuJmp;
2866	uint32_t opsize;
2867	RTGCPTR pCurInstrGC = pInstrGC;
2868	uint8_t *pCurInstrHC = pInstrHC;
2869	uint32_t orgOffsetPatchMem = ~0;
2870
2871	/*
2872	* In Linux it's often the case that many interrupt handlers push a predefined value onto the stack
2873	* and then jump to a common entrypoint. In order not to waste a lot of memory, we will check for this
2874	* condition here and only patch the common entypoint once.
2875	*/
2876	cpuPush.mode = (pPatch->flags & PATMFL_CODE32) ? CPUMODE_32BIT : CPUMODE_16BIT;
2877	disret = PATMR3DISInstr(pVM, pPatch, &cpuPush, pCurInstrGC, pCurInstrHC, &opsize, NULL);
2878	Assert(disret);
2879	if (disret && cpuPush.pCurInstr->opcode == OP_PUSH)
2880	{
2881	RTGCPTR pJmpInstrGC;
2882	int rc;
2883
2884	pCurInstrGC += opsize;
2885	pCurInstrHC = PATMGCVirtToHCVirt(pVM, pPatch, pCurInstrGC);
2886
2887	cpuJmp.mode = (pPatch->flags & PATMFL_CODE32) ? CPUMODE_32BIT : CPUMODE_16BIT;
2888	disret = PATMR3DISInstr(pVM, pPatch, &cpuJmp, pCurInstrGC, pCurInstrHC, &opsize, NULL);
2889	if ( disret
2890	&& cpuJmp.pCurInstr->opcode == OP_JMP
2891	&& (pJmpInstrGC = PATMResolveBranch(&cpuJmp, pCurInstrGC))
2892	)
2893	{
2894	PPATMPATCHREC pJmpPatch = (PPATMPATCHREC)RTAvloGCPtrGet(&pVM->patm.s.PatchLookupTreeHC->PatchTree, pJmpInstrGC);
2895	if (pJmpPatch == 0)
2896	{
2897	/* Patch it first! */
2898	rc = PATMR3InstallPatch(pVM, pJmpInstrGC, pPatch->flags \| PATMFL_IDTHANDLER_WITHOUT_ENTRYPOINT);
2899	if (rc != VINF_SUCCESS)
2900	goto failure;
2901	pJmpPatch = (PPATMPATCHREC)RTAvloGCPtrGet(&pVM->patm.s.PatchLookupTreeHC->PatchTree, pJmpInstrGC);
2902	Assert(pJmpPatch);
2903	}
2904	if (pJmpPatch->patch.uState != PATCH_ENABLED)
2905	goto failure;
2906
2907	/* save original offset (in case of failures later on) */
2908	orgOffsetPatchMem = pVM->patm.s.offPatchMem;
2909
2910	pPatch->pPatchBlockOffset = pVM->patm.s.offPatchMem;
2911	pPatch->uCurPatchOffset = 0;
2912	pPatch->nrPatch2GuestRecs = 0;
2913
2914	#ifdef VBOX_WITH_STATISTICS
2915	rc = patmPatchGenStats(pVM, pPatch, pInstrGC);
2916	if (VBOX_FAILURE(rc))
2917	goto failure;
2918	#endif
2919
2920	/* Install fake cli patch (to clear the virtual IF) */
2921	rc = patmPatchGenIntEntry(pVM, pPatch, pInstrGC);
2922	if (VBOX_FAILURE(rc))
2923	goto failure;
2924
2925	/* Add lookup record for patch to guest address translation (for the push) */
2926	patmr3AddP2GLookupRecord(pVM, pPatch, PATCHCODE_PTR_HC(pPatch) + pPatch->uCurPatchOffset, pInstrGC, PATM_LOOKUP_BOTHDIR);
2927
2928	/* Duplicate push. */
2929	rc = patmPatchGenDuplicate(pVM, pPatch, &cpuPush, pInstrGC);
2930	if (VBOX_FAILURE(rc))
2931	goto failure;
2932
2933	/* Generate jump to common entrypoint. */
2934	rc = patmPatchGenPatchJump(pVM, pPatch, pCurInstrGC, PATCHCODE_PTR_GC(&pJmpPatch->patch));
2935	if (VBOX_FAILURE(rc))
2936	goto failure;
2937
2938	/* size of patch block */
2939	pPatch->cbPatchBlockSize = pPatch->uCurPatchOffset;
2940
2941	/* Update free pointer in patch memory. */
2942	pVM->patm.s.offPatchMem += pPatch->cbPatchBlockSize;
2943	/* Round to next 8 byte boundary */
2944	pVM->patm.s.offPatchMem = RT_ALIGN_32(pVM->patm.s.offPatchMem, 8);
2945
2946	/* There's no jump from guest to patch code. */
2947	pPatch->cbPatchJump = 0;
2948
2949
2950	#ifdef LOG_ENABLED
2951	Log(("Patch code ----------------------------------------------------------\n"));
2952	patmr3DisasmCodeStream(pVM, PATCHCODE_PTR_GC(pPatch), PATCHCODE_PTR_GC(pPatch), patmr3DisasmCallback, pPatch);
2953	Log(("Patch code ends -----------------------------------------------------\n"));
2954	#endif
2955	Log(("Successfully installed IDT handler patch at %VGv\n", pInstrGC));
2956
2957	/*
2958	* Insert into patch to guest lookup tree
2959	*/
2960	LogFlow(("Insert %VGv patch offset %VGv\n", pPatchRec->patch.pPrivInstrGC, pPatch->pPatchBlockOffset));
2961	pPatchRec->CoreOffset.Key = pPatch->pPatchBlockOffset;
2962	rc = RTAvloGCPtrInsert(&pVM->patm.s.PatchLookupTreeHC->PatchTreeByPatchAddr, &pPatchRec->CoreOffset);
2963	AssertMsg(rc, ("RTAvlULInsert failed for %x\n", pPatchRec->CoreOffset.Key));
2964
2965	pPatch->uState = PATCH_ENABLED;
2966
2967	return VINF_SUCCESS;
2968	}
2969	}
2970	failure:
2971	/* Give back the patch memory we no longer need */
2972	if (orgOffsetPatchMem != (uint32_t)~0)
2973	pVM->patm.s.offPatchMem = orgOffsetPatchMem;
2974
2975	return PATMR3PatchBlock(pVM, pInstrGC, pInstrHC, OP_CLI, uOpSize, pPatchRec);
2976	}
2977
2978	/**
2979	* Install a trampoline to call a guest trap handler directly
2980	*
2981	* @returns VBox status code.
2982	* @param pVM The VM to operate on.
2983	* @param pInstrGC Guest context point to privileged instruction
2984	* @param pPatchRec Patch record
2985	*
2986	*/
2987	static int patmInstallTrapTrampoline(PVM pVM, RTGCPTR pInstrGC, PPATMPATCHREC pPatchRec)
2988	{
2989	PPATCHINFO pPatch = &pPatchRec->patch;
2990	int rc = VERR_PATCHING_REFUSED;
2991	uint32_t orgOffsetPatchMem = ~0;
2992	#ifdef LOG_ENABLED
2993	bool disret;
2994	DISCPUSTATE cpu;
2995	uint32_t opsize;
2996	char szOutput[256];
2997	#endif
2998
2999	// save original offset (in case of failures later on)
3000	orgOffsetPatchMem = pVM->patm.s.offPatchMem;
3001
3002	pPatch->pPatchBlockOffset = pVM->patm.s.offPatchMem;
3003	pPatch->uCurPatchOffset = 0;
3004	pPatch->nrPatch2GuestRecs = 0;
3005
3006	#ifdef VBOX_WITH_STATISTICS
3007	rc = patmPatchGenStats(pVM, pPatch, pInstrGC);
3008	if (VBOX_FAILURE(rc))
3009	goto failure;
3010	#endif
3011
3012	rc = patmPatchGenTrapEntry(pVM, pPatch, pInstrGC);
3013	if (VBOX_FAILURE(rc))
3014	goto failure;
3015
3016	/* size of patch block */
3017	pPatch->cbPatchBlockSize = pPatch->uCurPatchOffset;
3018
3019	/* Update free pointer in patch memory. */
3020	pVM->patm.s.offPatchMem += pPatch->cbPatchBlockSize;
3021	/* Round to next 8 byte boundary */
3022	pVM->patm.s.offPatchMem = RT_ALIGN_32(pVM->patm.s.offPatchMem, 8);
3023
3024	/* There's no jump from guest to patch code. */
3025	pPatch->cbPatchJump = 0;
3026
3027	#ifdef LOG_ENABLED
3028	Log(("Patch code ----------------------------------------------------------\n"));
3029	patmr3DisasmCodeStream(pVM, PATCHCODE_PTR_GC(pPatch), PATCHCODE_PTR_GC(pPatch), patmr3DisasmCallback, pPatch);
3030	Log(("Patch code ends -----------------------------------------------------\n"));
3031	#endif
3032
3033	#ifdef LOG_ENABLED
3034	cpu.mode = (pPatch->flags & PATMFL_CODE32) ? CPUMODE_32BIT : CPUMODE_16BIT;
3035	disret = PATMR3DISInstr(pVM, pPatch, &cpu, pPatch->pPrivInstrGC, pPatch->pPrivInstrHC, &opsize, szOutput);
3036	Log(("TRAP handler patch: %s", szOutput));
3037	#endif
3038	Log(("Successfully installed Trap Trampoline patch at %VGv\n", pInstrGC));
3039
3040	/*
3041	* Insert into patch to guest lookup tree
3042	*/
3043	LogFlow(("Insert %VGv patch offset %VGv\n", pPatchRec->patch.pPrivInstrGC, pPatch->pPatchBlockOffset));
3044	pPatchRec->CoreOffset.Key = pPatch->pPatchBlockOffset;
3045	rc = RTAvloGCPtrInsert(&pVM->patm.s.PatchLookupTreeHC->PatchTreeByPatchAddr, &pPatchRec->CoreOffset);
3046	AssertMsg(rc, ("RTAvlULInsert failed for %x\n", pPatchRec->CoreOffset.Key));
3047
3048	pPatch->uState = PATCH_ENABLED;
3049	return VINF_SUCCESS;
3050
3051	failure:
3052	AssertMsgFailed(("Failed to install trap handler trampoline!!\n"));
3053
3054	/* Turn this cli patch into a dummy. */
3055	pPatch->uState = PATCH_REFUSED;
3056	pPatch->pPatchBlockOffset = 0;
3057
3058	/* Give back the patch memory we no longer need */
3059	Assert(orgOffsetPatchMem != (uint32_t)~0);
3060	pVM->patm.s.offPatchMem = orgOffsetPatchMem;
3061
3062	return rc;
3063	}
3064
3065
3066	#ifdef DEBUG
3067	/**
3068	* Check if the instruction is patched as a common idt handler
3069	*
3070	* @returns true or false
3071	* @param pVM The VM to operate on.
3072	* @param pInstrGC Guest context point to the instruction
3073	*
3074	*/
3075	static bool patmIsCommonIDTHandlerPatch(PVM pVM, RTGCPTR pInstrGC)
3076	{
3077	PPATMPATCHREC pRec;
3078
3079	pRec = (PPATMPATCHREC)RTAvloGCPtrGet(&pVM->patm.s.PatchLookupTreeHC->PatchTree, pInstrGC);
3080	if (pRec && pRec->patch.flags & PATMFL_IDTHANDLER_WITHOUT_ENTRYPOINT)
3081	return true;
3082	return false;
3083	}
3084	#endif //DEBUG
3085
3086
3087	/**
3088	* Duplicates a complete function
3089	*
3090	* @returns VBox status code.
3091	* @param pVM The VM to operate on.
3092	* @param pInstrGC Guest context point to privileged instruction
3093	* @param pPatchRec Patch record
3094	*
3095	*/
3096	static int patmDuplicateFunction(PVM pVM, RTGCPTR pInstrGC, PPATMPATCHREC pPatchRec)
3097	{
3098	PPATCHINFO pPatch = &pPatchRec->patch;
3099	int rc = VERR_PATCHING_REFUSED;
3100	DISCPUSTATE cpu;
3101	uint32_t orgOffsetPatchMem = ~0;
3102
3103	Log(("patmDuplicateFunction %VGv\n", pInstrGC));
3104	/* Save original offset (in case of failures later on). */
3105	orgOffsetPatchMem = pVM->patm.s.offPatchMem;
3106
3107	/* We will not go on indefinitely with call instruction handling. */
3108	if (pVM->patm.s.ulCallDepth > PATM_MAX_CALL_DEPTH)
3109	{
3110	Log(("patmDuplicateFunction: maximum callback depth reached!!\n"));
3111	return VERR_PATCHING_REFUSED;
3112	}
3113
3114	pVM->patm.s.ulCallDepth++;
3115
3116	#ifdef PATM_ENABLE_CALL
3117	pPatch->flags \|= PATMFL_SUPPORT_CALLS \| PATMFL_SUPPORT_INDIRECT_CALLS;
3118	#endif
3119
3120	Assert(pPatch->flags & (PATMFL_DUPLICATE_FUNCTION));
3121
3122	pPatch->nrPatch2GuestRecs = 0;
3123	pPatch->pPatchBlockOffset = pVM->patm.s.offPatchMem;
3124	pPatch->uCurPatchOffset = 0;
3125
3126	cpu.mode = (pPatch->flags & PATMFL_CODE32) ? CPUMODE_32BIT : CPUMODE_16BIT;
3127
3128	/** @note Set the PATM interrupt flag here; it was cleared before the patched call. (!!!) */
3129	rc = patmPatchGenSetPIF(pVM, pPatch, pInstrGC);
3130	if (VBOX_FAILURE(rc))
3131	goto failure;
3132
3133	#ifdef VBOX_WITH_STATISTICS
3134	rc = patmPatchGenStats(pVM, pPatch, pInstrGC);
3135	if (VBOX_FAILURE(rc))
3136	goto failure;
3137	#endif
3138	rc = patmRecompileCodeStream(pVM, pInstrGC, pInstrGC, patmRecompileCallback, pPatch);
3139	if (rc != VINF_SUCCESS)
3140	{
3141	Log(("PATMR3PatchCli: patmRecompileCodeStream failed with %d\n", rc));
3142	goto failure;
3143	}
3144
3145	//size of patch block
3146	pPatch->cbPatchBlockSize = pPatch->uCurPatchOffset;
3147
3148	//update free pointer in patch memory
3149	pVM->patm.s.offPatchMem += pPatch->cbPatchBlockSize;
3150	/* Round to next 8 byte boundary. */
3151	pVM->patm.s.offPatchMem = RT_ALIGN_32(pVM->patm.s.offPatchMem, 8);
3152
3153	pPatch->uState = PATCH_ENABLED;
3154
3155	/*
3156	* Insert into patch to guest lookup tree
3157	*/
3158	LogFlow(("Insert %VGv patch offset %VGv\n", pPatchRec->patch.pPrivInstrGC, pPatch->pPatchBlockOffset));
3159	pPatchRec->CoreOffset.Key = pPatch->pPatchBlockOffset;
3160	rc = RTAvloGCPtrInsert(&pVM->patm.s.PatchLookupTreeHC->PatchTreeByPatchAddr, &pPatchRec->CoreOffset);
3161	AssertMsg(rc, ("RTAvloGCPtrInsert failed for %x\n", pPatchRec->CoreOffset.Key));
3162	if (!rc)
3163	{
3164	rc = VERR_PATCHING_REFUSED;
3165	goto failure;
3166	}
3167
3168	/* Note that patmr3SetBranchTargets can install additional patches!! */
3169	rc = patmr3SetBranchTargets(pVM, pPatch);
3170	if (rc != VINF_SUCCESS)
3171	{
3172	Log(("PATMR3PatchCli: patmr3SetBranchTargets failed with %d\n", rc));
3173	goto failure;
3174	}
3175
3176	#ifdef LOG_ENABLED
3177	Log(("Patch code ----------------------------------------------------------\n"));
3178	patmr3DisasmCodeStream(pVM, PATCHCODE_PTR_GC(pPatch), PATCHCODE_PTR_GC(pPatch), patmr3DisasmCallback, pPatch);
3179	Log(("Patch code ends -----------------------------------------------------\n"));
3180	#endif
3181
3182	Log(("Successfully installed function duplication patch at %VGv\n", pInstrGC));
3183
3184	patmEmptyTree(pVM, &pPatch->pTempInfo->IllegalInstrTree);
3185	pPatch->pTempInfo->nrIllegalInstr = 0;
3186
3187	pVM->patm.s.ulCallDepth--;
3188	STAM_COUNTER_INC(&pVM->patm.s.StatInstalledFunctionPatches);
3189	return VINF_SUCCESS;
3190
3191	failure:
3192	if (pPatchRec->CoreOffset.Key)
3193	RTAvloGCPtrRemove(&pVM->patm.s.PatchLookupTreeHC->PatchTreeByPatchAddr, pPatchRec->CoreOffset.Key);
3194
3195	patmEmptyTree(pVM, &pPatch->FixupTree);
3196	pPatch->nrFixups = 0;
3197
3198	patmEmptyTree(pVM, &pPatch->JumpTree);
3199	pPatch->nrJumpRecs = 0;
3200
3201	patmEmptyTree(pVM, &pPatch->pTempInfo->IllegalInstrTree);
3202	pPatch->pTempInfo->nrIllegalInstr = 0;
3203
3204	/* Turn this cli patch into a dummy. */
3205	pPatch->uState = PATCH_REFUSED;
3206	pPatch->pPatchBlockOffset = 0;
3207
3208	// Give back the patch memory we no longer need
3209	Assert(orgOffsetPatchMem != (uint32_t)~0);
3210	pVM->patm.s.offPatchMem = orgOffsetPatchMem;
3211
3212	pVM->patm.s.ulCallDepth--;
3213	Log(("patmDupicateFunction %VGv failed!!\n", pInstrGC));
3214	return rc;
3215	}
3216
3217	/**
3218	* Creates trampoline code to jump inside an existing patch
3219	*
3220	* @returns VBox status code.
3221	* @param pVM The VM to operate on.
3222	* @param pInstrGC Guest context point to privileged instruction
3223	* @param pPatchRec Patch record
3224	*
3225	*/
3226	static int patmCreateTrampoline(PVM pVM, RTGCPTR pInstrGC, PPATMPATCHREC pPatchRec)
3227	{
3228	PPATCHINFO pPatch = &pPatchRec->patch;
3229	RTGCPTR pPage, pPatchTargetGC = 0;
3230	uint32_t orgOffsetPatchMem = ~0;
3231	int rc = VERR_PATCHING_REFUSED;
3232
3233	Log(("patmCreateTrampoline %VGv\n", pInstrGC));
3234	/* Save original offset (in case of failures later on). */
3235	orgOffsetPatchMem = pVM->patm.s.offPatchMem;
3236
3237	/* First we check if the duplicate function target lies in some existing function patch already. Will save some space. */
3238	/** @todo we already checked this before */
3239	pPage = pInstrGC & PAGE_BASE_GC_MASK;
3240
3241	PPATMPATCHPAGE pPatchPage = (PPATMPATCHPAGE)RTAvloGCPtrGet(&pVM->patm.s.PatchLookupTreeHC->PatchTreeByPage, (RTGCPTR)pPage);
3242	if (pPatchPage)
3243	{
3244	uint32_t i;
3245
3246	for (i=0;i<pPatchPage->cCount;i++)
3247	{
3248	if (pPatchPage->aPatch[i])
3249	{
3250	PPATCHINFO pPatch = pPatchPage->aPatch[i];
3251
3252	if ( (pPatch->flags & PATMFL_DUPLICATE_FUNCTION)
3253	&& pPatch->uState == PATCH_ENABLED)
3254	{
3255	pPatchTargetGC = patmGuestGCPtrToPatchGCPtr(pVM, pPatch, pInstrGC);
3256	if (pPatchTargetGC)
3257	{
3258	uint32_t offsetPatch = pPatchTargetGC - pVM->patm.s.pPatchMemGC;
3259	PRECPATCHTOGUEST pPatchToGuestRec = (PRECPATCHTOGUEST)RTAvlU32GetBestFit(&pPatch->Patch2GuestAddrTree, offsetPatch, false);
3260	Assert(pPatchToGuestRec);
3261
3262	pPatchToGuestRec->fJumpTarget = true;
3263	Assert(pPatchTargetGC != pPatch->pPrivInstrGC);
3264	Log(("patmCreateTrampoline: generating jump to code inside patch at %VGv\n", pPatch->pPrivInstrGC));
3265	pPatch->flags \|= PATMFL_EXTERNAL_JUMP_INSIDE;
3266	break;
3267	}
3268	}
3269	}
3270	}
3271	}
3272	AssertReturn(pPatchPage && pPatchTargetGC, VERR_PATCHING_REFUSED);
3273
3274	pPatch->nrPatch2GuestRecs = 0;
3275	pPatch->pPatchBlockOffset = pVM->patm.s.offPatchMem;
3276	pPatch->uCurPatchOffset = 0;
3277
3278	/** @note Set the PATM interrupt flag here; it was cleared before the patched call. (!!!) */
3279	rc = patmPatchGenSetPIF(pVM, pPatch, pInstrGC);
3280	if (VBOX_FAILURE(rc))
3281	goto failure;
3282
3283	#ifdef VBOX_WITH_STATISTICS
3284	rc = patmPatchGenStats(pVM, pPatch, pInstrGC);
3285	if (VBOX_FAILURE(rc))
3286	goto failure;
3287	#endif
3288
3289	rc = patmPatchGenPatchJump(pVM, pPatch, pInstrGC, pPatchTargetGC);
3290	if (VBOX_FAILURE(rc))
3291	goto failure;
3292
3293	/*
3294	* Insert into patch to guest lookup tree
3295	*/
3296	LogFlow(("Insert %VGv patch offset %VGv\n", pPatchRec->patch.pPrivInstrGC, pPatch->pPatchBlockOffset));
3297	pPatchRec->CoreOffset.Key = pPatch->pPatchBlockOffset;
3298	rc = RTAvloGCPtrInsert(&pVM->patm.s.PatchLookupTreeHC->PatchTreeByPatchAddr, &pPatchRec->CoreOffset);
3299	AssertMsg(rc, ("RTAvloGCPtrInsert failed for %x\n", pPatchRec->CoreOffset.Key));
3300	if (!rc)
3301	{
3302	rc = VERR_PATCHING_REFUSED;
3303	goto failure;
3304	}
3305
3306	/* size of patch block */
3307	pPatch->cbPatchBlockSize = pPatch->uCurPatchOffset;
3308
3309	/* Update free pointer in patch memory. */
3310	pVM->patm.s.offPatchMem += pPatch->cbPatchBlockSize;
3311	/* Round to next 8 byte boundary */
3312	pVM->patm.s.offPatchMem = RT_ALIGN_32(pVM->patm.s.offPatchMem, 8);
3313
3314	/* There's no jump from guest to patch code. */
3315	pPatch->cbPatchJump = 0;
3316
3317	/* Enable the patch. */
3318	pPatch->uState = PATCH_ENABLED;
3319	/* We allow this patch to be called as a function. */
3320	pPatch->flags \|= PATMFL_CALLABLE_AS_FUNCTION;
3321	STAM_COUNTER_INC(&pVM->patm.s.StatInstalledTrampoline);
3322	return VINF_SUCCESS;
3323
3324	failure:
3325	if (pPatchRec->CoreOffset.Key)
3326	RTAvloGCPtrRemove(&pVM->patm.s.PatchLookupTreeHC->PatchTreeByPatchAddr, pPatchRec->CoreOffset.Key);
3327
3328	patmEmptyTree(pVM, &pPatch->FixupTree);
3329	pPatch->nrFixups = 0;
3330
3331	patmEmptyTree(pVM, &pPatch->JumpTree);
3332	pPatch->nrJumpRecs = 0;
3333
3334	patmEmptyTree(pVM, &pPatch->pTempInfo->IllegalInstrTree);
3335	pPatch->pTempInfo->nrIllegalInstr = 0;
3336
3337	/* Turn this cli patch into a dummy. */
3338	pPatch->uState = PATCH_REFUSED;
3339	pPatch->pPatchBlockOffset = 0;
3340
3341	// Give back the patch memory we no longer need
3342	Assert(orgOffsetPatchMem != (uint32_t)~0);
3343	pVM->patm.s.offPatchMem = orgOffsetPatchMem;
3344
3345	return rc;
3346	}
3347
3348
3349	/**
3350	* Patch branch target function for call/jump at specified location.
3351	* (in responds to a VINF_PATM_DUPLICATE_FUNCTION GC exit reason)
3352	*
3353	* @returns VBox status code.
3354	* @param pVM The VM to operate on.
3355	* @param pCtx Guest context
3356	*
3357	*/
3358	PATMR3DECL(int) PATMR3DuplicateFunctionRequest(PVM pVM, PCPUMCTX pCtx)
3359	{
3360	RTGCPTR pBranchTarget, pPage;
3361	int rc;
3362	RTGCPTR pPatchTargetGC = 0;
3363
3364	pBranchTarget = pCtx->edx;
3365	pBranchTarget = SELMToFlat(pVM, pCtx->eflags, pCtx->cs, &pCtx->csHid, pBranchTarget);
3366
3367	/* First we check if the duplicate function target lies in some existing function patch already. Will save some space. */
3368	pPage = pBranchTarget & PAGE_BASE_GC_MASK;
3369
3370	PPATMPATCHPAGE pPatchPage = (PPATMPATCHPAGE)RTAvloGCPtrGet(&pVM->patm.s.PatchLookupTreeHC->PatchTreeByPage, (RTGCPTR)pPage);
3371	if (pPatchPage)
3372	{
3373	uint32_t i;
3374
3375	for (i=0;i<pPatchPage->cCount;i++)
3376	{
3377	if (pPatchPage->aPatch[i])
3378	{
3379	PPATCHINFO pPatch = pPatchPage->aPatch[i];
3380
3381	if ( (pPatch->flags & PATMFL_DUPLICATE_FUNCTION)
3382	&& pPatch->uState == PATCH_ENABLED)
3383	{
3384	pPatchTargetGC = patmGuestGCPtrToPatchGCPtr(pVM, pPatch, pBranchTarget);
3385	if (pPatchTargetGC)
3386	{
3387	STAM_COUNTER_INC(&pVM->patm.s.StatDuplicateUseExisting);
3388	break;
3389	}
3390	}
3391	}
3392	}
3393	}
3394
3395	if (pPatchTargetGC)
3396	{
3397	/* Create a trampoline that also sets PATM_INTERRUPTFLAG. */
3398	rc = PATMR3InstallPatch(pVM, pBranchTarget, PATMFL_CODE32 \| PATMFL_TRAMPOLINE);
3399	}
3400	else
3401	{
3402	rc = PATMR3InstallPatch(pVM, pBranchTarget, PATMFL_CODE32 \| PATMFL_DUPLICATE_FUNCTION);
3403	}
3404
3405	if (rc == VINF_SUCCESS)
3406	{
3407	pPatchTargetGC = PATMR3QueryPatchGCPtr(pVM, pBranchTarget);
3408	Assert(pPatchTargetGC);
3409	}
3410
3411	if (pPatchTargetGC)
3412	{
3413	pCtx->eax = pPatchTargetGC;
3414	pCtx->eax = pCtx->eax - (RTGCUINTPTR)pVM->patm.s.pPatchMemGC; /* make it relative */
3415	}
3416	else
3417	{
3418	/* We add a dummy entry into the lookup cache so we won't get bombarded with the same requests over and over again. */
3419	pCtx->eax = 0;
3420	STAM_COUNTER_INC(&pVM->patm.s.StatDuplicateREQFailed);
3421	}
3422	Assert(PATMIsPatchGCAddr(pVM, pCtx->edi));
3423	rc = PATMAddBranchToLookupCache(pVM, pCtx->edi, pBranchTarget, pCtx->eax);
3424	AssertRC(rc);
3425
3426	pCtx->eip += PATM_ILLEGAL_INSTR_SIZE;
3427	STAM_COUNTER_INC(&pVM->patm.s.StatDuplicateREQSuccess);
3428	return VINF_SUCCESS;
3429	}
3430
3431	/**
3432	* Replaces a function call by a call to an existing function duplicate (or jmp -> jmp)
3433	*
3434	* @returns VBox status code.
3435	* @param pVM The VM to operate on.
3436	* @param pCpu Disassembly CPU structure ptr
3437	* @param pInstrGC Guest context point to privileged instruction
3438	* @param pPatch Patch record
3439	*
3440	*/
3441	static int patmReplaceFunctionCall(PVM pVM, DISCPUSTATE *pCpu, RTGCPTR pInstrGC, PPATCHINFO pPatch)
3442	{
3443	int rc = VERR_PATCHING_REFUSED;
3444	DISCPUSTATE cpu;
3445	RTGCPTR pTargetGC;
3446	PPATMPATCHREC pPatchFunction;
3447	uint32_t opsize;
3448	bool disret;
3449	#ifdef LOG_ENABLED
3450	char szOutput[256];
3451	#endif
3452
3453	Assert(pPatch->flags & PATMFL_REPLACE_FUNCTION_CALL);
3454	Assert((pCpu->pCurInstr->opcode == OP_CALL \|\| pCpu->pCurInstr->opcode == OP_JMP) && pCpu->opsize == SIZEOF_NEARJUMP32);
3455
3456	if ((pCpu->pCurInstr->opcode != OP_CALL && pCpu->pCurInstr->opcode != OP_JMP) \|\| pCpu->opsize != SIZEOF_NEARJUMP32)
3457	{
3458	rc = VERR_PATCHING_REFUSED;
3459	goto failure;
3460	}
3461
3462	pTargetGC = PATMResolveBranch(pCpu, pInstrGC);
3463	if (pTargetGC == 0)
3464	{
3465	Log(("We don't support far jumps here!! (%08X)\n", pCpu->param1.flags));
3466	rc = VERR_PATCHING_REFUSED;
3467	goto failure;
3468	}
3469
3470	pPatchFunction = (PPATMPATCHREC)RTAvloGCPtrGet(&pVM->patm.s.PatchLookupTreeHC->PatchTree, pTargetGC);
3471	if (pPatchFunction == NULL)
3472	{
3473	for(;;)
3474	{
3475	/* It could be an indirect call (call -> jmp dest).
3476	* Note that it's dangerous to assume the jump will never change...
3477	*/
3478	uint8_t *pTmpInstrHC;
3479
3480	pTmpInstrHC = PATMGCVirtToHCVirt(pVM, pPatch, pTargetGC);
3481	Assert(pTmpInstrHC);
3482	if (pTmpInstrHC == 0)
3483	break;
3484
3485	cpu.mode = (pPatch->flags & PATMFL_CODE32) ? CPUMODE_32BIT : CPUMODE_16BIT;
3486	disret = PATMR3DISInstr(pVM, pPatch, &cpu, pTargetGC, pTmpInstrHC, &opsize, NULL);
3487	if (disret == false \|\| cpu.pCurInstr->opcode != OP_JMP)
3488	break;
3489
3490	pTargetGC = PATMResolveBranch(&cpu, pTargetGC);
3491	if (pTargetGC == 0)
3492	{
3493	break;
3494	}
3495
3496	pPatchFunction = (PPATMPATCHREC)RTAvloGCPtrGet(&pVM->patm.s.PatchLookupTreeHC->PatchTree, pTargetGC);
3497	break;
3498	}
3499	if (pPatchFunction == 0)
3500	{
3501	AssertMsgFailed(("Unable to find duplicate function %VGv\n", pTargetGC));
3502	rc = VERR_PATCHING_REFUSED;
3503	goto failure;
3504	}
3505	}
3506
3507	// make a copy of the guest code bytes that will be overwritten
3508	pPatch->cbPatchJump = SIZEOF_NEARJUMP32;
3509
3510	rc = PGMPhysReadGCPtr(pVM, pPatch->aPrivInstr, pPatch->pPrivInstrGC, pPatch->cbPatchJump);
3511	AssertRC(rc);
3512
3513	/* Now replace the original call in the guest code */
3514	rc = patmGenCallToPatch(pVM, pPatch, PATCHCODE_PTR_GC(&pPatchFunction->patch), true);
3515	AssertRC(rc);
3516	if (VBOX_FAILURE(rc))
3517	goto failure;
3518
3519	/* Lowest and highest address for write monitoring. */
3520	pPatch->pInstrGCLowest = pInstrGC;
3521	pPatch->pInstrGCHighest = pInstrGC + pCpu->opsize;
3522
3523	#ifdef LOG_ENABLED
3524	cpu.mode = (pPatch->flags & PATMFL_CODE32) ? CPUMODE_32BIT : CPUMODE_16BIT;
3525	disret = PATMR3DISInstr(pVM, pPatch, &cpu, pPatch->pPrivInstrGC, pPatch->pPrivInstrHC, &opsize, szOutput);
3526	Log(("Call patch: %s", szOutput));
3527	#endif
3528
3529	Log(("Successfully installed function replacement patch at %VGv\n", pInstrGC));
3530
3531	pPatch->uState = PATCH_ENABLED;
3532	return VINF_SUCCESS;
3533
3534	failure:
3535	/* Turn this patch into a dummy. */
3536	pPatch->uState = PATCH_REFUSED;
3537
3538	return rc;
3539	}
3540
3541	/**
3542	* Replace the address in an MMIO instruction with the cached version.
3543	*
3544	* @returns VBox status code.
3545	* @param pVM The VM to operate on.
3546	* @param pInstrGC Guest context point to privileged instruction
3547	* @param pCpu Disassembly CPU structure ptr
3548	* @param pPatch Patch record
3549	*
3550	* @note returns failure if patching is not allowed or possible
3551	*
3552	*/
3553	static int patmPatchMMIOInstr(PVM pVM, RTGCPTR pInstrGC, DISCPUSTATE *pCpu, PPATCHINFO pPatch)
3554	{
3555	uint8_t *pPB;
3556	int rc = VERR_PATCHING_REFUSED;
3557	#ifdef LOG_ENABLED
3558	DISCPUSTATE cpu;
3559	uint32_t opsize;
3560	bool disret;
3561	char szOutput[256];
3562	#endif
3563
3564	Assert(pVM->patm.s.mmio.pCachedData);
3565	if (!pVM->patm.s.mmio.pCachedData)
3566	goto failure;
3567
3568	if (pCpu->param2.flags != USE_DISPLACEMENT32)
3569	goto failure;
3570
3571	pPB = pPatch->pPrivInstrHC;
3572
3573	/* Add relocation record for cached data access. */
3574	if (patmPatchAddReloc32(pVM, pPatch, &pPB[pCpu->opsize - sizeof(RTGCPTR)], FIXUP_ABSOLUTE, pPatch->pPrivInstrGC, pVM->patm.s.mmio.pCachedData) != VINF_SUCCESS)
3575	{
3576	Log(("Relocation failed for cached mmio address!!\n"));
3577	return VERR_PATCHING_REFUSED;
3578	}
3579	#ifdef LOG_ENABLED
3580	cpu.mode = (pPatch->flags & PATMFL_CODE32) ? CPUMODE_32BIT : CPUMODE_16BIT;
3581	disret = PATMR3DISInstr(pVM, pPatch, &cpu, pPatch->pPrivInstrGC, pPatch->pPrivInstrHC, &opsize, szOutput);
3582	Log(("MMIO patch old instruction: %s", szOutput));
3583	#endif
3584
3585	/* Save original instruction. */
3586	rc = PGMPhysReadGCPtr(pVM, pPatch->aPrivInstr, pPatch->pPrivInstrGC, pPatch->cbPrivInstr);
3587	AssertRC(rc);
3588
3589	pPatch->cbPatchJump = pPatch->cbPrivInstr; /* bit of a misnomer in this case; size of replacement instruction. */
3590
3591	/* Replace address with that of the cached item. */
3592	rc = PGMPhysWriteGCPtrDirty(pVM, pInstrGC + pCpu->opsize - sizeof(RTGCPTR), &pVM->patm.s.mmio.pCachedData, sizeof(RTGCPTR));
3593	AssertRC(rc);
3594	if (VBOX_FAILURE(rc))
3595	{
3596	goto failure;
3597	}
3598
3599	#ifdef LOG_ENABLED
3600	cpu.mode = (pPatch->flags & PATMFL_CODE32) ? CPUMODE_32BIT : CPUMODE_16BIT;
3601	disret = PATMR3DISInstr(pVM, pPatch, &cpu, pPatch->pPrivInstrGC, pPatch->pPrivInstrHC, &opsize, szOutput);
3602	Log(("MMIO patch: %s", szOutput));
3603	#endif
3604	pVM->patm.s.mmio.pCachedData = 0;
3605	pVM->patm.s.mmio.GCPhys = 0;
3606	pPatch->uState = PATCH_ENABLED;
3607	return VINF_SUCCESS;
3608
3609	failure:
3610	/* Turn this patch into a dummy. */
3611	pPatch->uState = PATCH_REFUSED;
3612
3613	return rc;
3614	}
3615
3616
3617	/**
3618	* Replace the address in an MMIO instruction with the cached version. (instruction is part of an existing patch)
3619	*
3620	* @returns VBox status code.
3621	* @param pVM The VM to operate on.
3622	* @param pInstrGC Guest context point to privileged instruction
3623	* @param pPatch Patch record
3624	*
3625	* @note returns failure if patching is not allowed or possible
3626	*
3627	*/
3628	static int patmPatchPATMMMIOInstr(PVM pVM, RTGCPTR pInstrGC, PPATCHINFO pPatch)
3629	{
3630	DISCPUSTATE cpu;
3631	uint32_t opsize;
3632	bool disret;
3633	uint8_t *pInstrHC;
3634	#ifdef LOG_ENABLED
3635	char szOutput[256];
3636	#endif
3637
3638	AssertReturn(pVM->patm.s.mmio.pCachedData, VERR_INVALID_PARAMETER);
3639
3640	/* Convert GC to HC address. */
3641	pInstrHC = patmPatchGCPtr2PatchHCPtr(pVM, pInstrGC);
3642	AssertReturn(pInstrHC, VERR_PATCHING_REFUSED);
3643
3644	/* Disassemble mmio instruction. */
3645	cpu.mode = pPatch->uOpMode;
3646	disret = PATMR3DISInstr(pVM, pPatch, &cpu, pInstrGC, pInstrHC, &opsize, NULL);
3647	if (disret == false)
3648	{
3649	Log(("Disassembly failed (probably page not present) -> return to caller\n"));
3650	return VERR_PATCHING_REFUSED;
3651	}
3652
3653	AssertMsg(opsize <= MAX_INSTR_SIZE, ("privileged instruction too big %d!!\n", opsize));
3654	if (opsize > MAX_INSTR_SIZE)
3655	return VERR_PATCHING_REFUSED;
3656	if (cpu.param2.flags != USE_DISPLACEMENT32)
3657	return VERR_PATCHING_REFUSED;
3658
3659	/* Add relocation record for cached data access. */
3660	if (patmPatchAddReloc32(pVM, pPatch, &pInstrHC[cpu.opsize - sizeof(RTGCPTR)], FIXUP_ABSOLUTE) != VINF_SUCCESS)
3661	{
3662	Log(("Relocation failed for cached mmio address!!\n"));
3663	return VERR_PATCHING_REFUSED;
3664	}
3665	/* Replace address with that of the cached item. */
3666	(RTGCPTR )&pInstrHC[cpu.opsize - sizeof(RTGCPTR)] = pVM->patm.s.mmio.pCachedData;
3667
3668	/* Lowest and highest address for write monitoring. */
3669	pPatch->pInstrGCLowest = pInstrGC;
3670	pPatch->pInstrGCHighest = pInstrGC + cpu.opsize;
3671
3672	#ifdef LOG_ENABLED
3673	cpu.mode = (pPatch->flags & PATMFL_CODE32) ? CPUMODE_32BIT : CPUMODE_16BIT;
3674	disret = PATMR3DISInstr(pVM, pPatch, &cpu, pInstrGC, pInstrHC, &opsize, szOutput);
3675	Log(("MMIO patch: %s", szOutput));
3676	#endif
3677
3678	pVM->patm.s.mmio.pCachedData = 0;
3679	pVM->patm.s.mmio.GCPhys = 0;
3680	return VINF_SUCCESS;
3681	}
3682
3683	/**
3684	* Activates an int3 patch
3685	*
3686	* @returns VBox status code.
3687	* @param pVM The VM to operate on.
3688	* @param pPatch Patch record
3689	*/
3690	static int patmActivateInt3Patch(PVM pVM, PPATCHINFO pPatch)
3691	{
3692	uint8_t ASMInt3 = 0xCC;
3693	int rc;
3694
3695	Assert(pPatch->flags & (PATMFL_INT3_REPLACEMENT\|PATMFL_INT3_REPLACEMENT_BLOCK));
3696	Assert(pPatch->uState != PATCH_ENABLED);
3697
3698	/* Replace first opcode byte with 'int 3'. */
3699	rc = PGMPhysWriteGCPtrDirty(pVM, pPatch->pPrivInstrGC, &ASMInt3, sizeof(ASMInt3));
3700	AssertRC(rc);
3701
3702	pPatch->cbPatchJump = sizeof(ASMInt3);
3703
3704	return rc;
3705	}
3706
3707	/**
3708	* Deactivates an int3 patch
3709	*
3710	* @returns VBox status code.
3711	* @param pVM The VM to operate on.
3712	* @param pPatch Patch record
3713	*/
3714	static int patmDeactivateInt3Patch(PVM pVM, PPATCHINFO pPatch)
3715	{
3716	uint8_t ASMInt3 = 0xCC;
3717	int rc;
3718
3719	Assert(pPatch->flags & (PATMFL_INT3_REPLACEMENT\|PATMFL_INT3_REPLACEMENT_BLOCK));
3720	Assert(pPatch->uState == PATCH_ENABLED \|\| pPatch->uState == PATCH_DIRTY);
3721
3722	/* Restore first opcode byte. */
3723	rc = PGMPhysWriteGCPtrDirty(pVM, pPatch->pPrivInstrGC, pPatch->aPrivInstr, sizeof(ASMInt3));
3724	AssertRC(rc);
3725	return rc;
3726	}
3727
3728	/**
3729	* Replace an instruction with a breakpoint (0xCC), that is handled dynamically in the guest context.
3730	*
3731	* @returns VBox status code.
3732	* @param pVM The VM to operate on.
3733	* @param pInstrGC Guest context point to privileged instruction
3734	* @param pInstrHC Host context point to privileged instruction
3735	* @param pCpu Disassembly CPU structure ptr
3736	* @param pPatch Patch record
3737	*
3738	* @note returns failure if patching is not allowed or possible
3739	*
3740	*/
3741	PATMR3DECL(int) PATMR3PatchInstrInt3(PVM pVM, RTGCPTR pInstrGC, HCPTRTYPE(uint8_t ) pInstrHC, DISCPUSTATE pCpu, PPATCHINFO pPatch)
3742	{
3743	uint8_t ASMInt3 = 0xCC;
3744	int rc;
3745
3746	/** @note Do not use patch memory here! It might called during patch installation too. */
3747
3748	#ifdef LOG_ENABLED
3749	DISCPUSTATE cpu;
3750	char szOutput[256];
3751	uint32_t opsize;
3752
3753	cpu.mode = (pPatch->flags & PATMFL_CODE32) ? CPUMODE_32BIT : CPUMODE_16BIT;
3754	PATMR3DISInstr(pVM, pPatch, &cpu, pInstrGC, pInstrHC, &opsize, szOutput);
3755	Log(("PATMR3PatchInstrInt3: %s", szOutput));
3756	#endif
3757
3758	/* Save the original instruction. */
3759	rc = PGMPhysReadGCPtr(pVM, pPatch->aPrivInstr, pPatch->pPrivInstrGC, pPatch->cbPrivInstr);
3760	AssertRC(rc);
3761	pPatch->cbPatchJump = sizeof(ASMInt3); /* bit of a misnomer in this case; size of replacement instruction. */
3762
3763	pPatch->flags \|= PATMFL_INT3_REPLACEMENT;
3764
3765	/* Replace first opcode byte with 'int 3'. */
3766	rc = patmActivateInt3Patch(pVM, pPatch);
3767	if (VBOX_FAILURE(rc))
3768	goto failure;
3769
3770	/* Lowest and highest address for write monitoring. */
3771	pPatch->pInstrGCLowest = pInstrGC;
3772	pPatch->pInstrGCHighest = pInstrGC + pCpu->opsize;
3773
3774	pPatch->uState = PATCH_ENABLED;
3775	return VINF_SUCCESS;
3776
3777	failure:
3778	/* Turn this patch into a dummy. */
3779	return VERR_PATCHING_REFUSED;
3780	}
3781
3782	#ifdef PATM_RESOLVE_CONFLICTS_WITH_JUMP_PATCHES
3783	/**
3784	* Patch a jump instruction at specified location
3785	*
3786	* @returns VBox status code.
3787	* @param pVM The VM to operate on.
3788	* @param pInstrGC Guest context point to privileged instruction
3789	* @param pInstrHC Host context point to privileged instruction
3790	* @param pCpu Disassembly CPU structure ptr
3791	* @param pPatchRec Patch record
3792	*
3793	* @note returns failure if patching is not allowed or possible
3794	*
3795	*/
3796	int patmPatchJump(PVM pVM, RTGCPTR pInstrGC, HCPTRTYPE(uint8_t ) pInstrHC, DISCPUSTATE pCpu, PPATMPATCHREC pPatchRec)
3797	{
3798	PPATCHINFO pPatch = &pPatchRec->patch;
3799	int rc = VERR_PATCHING_REFUSED;
3800	#ifdef LOG_ENABLED
3801	bool disret;
3802	DISCPUSTATE cpu;
3803	uint32_t opsize;
3804	char szOutput[256];
3805	#endif
3806
3807	pPatch->pPatchBlockOffset = 0; /* doesn't use patch memory */
3808	pPatch->uCurPatchOffset = 0;
3809	pPatch->cbPatchBlockSize = 0;
3810	pPatch->flags \|= PATMFL_SINGLE_INSTRUCTION;
3811
3812	/*
3813	* Instruction replacements such as these should never be interrupted. I've added code to EM.cpp to
3814	* make sure this never happens. (unless a trap is triggered (intentionally or not))
3815	*/
3816	switch (pCpu->pCurInstr->opcode)
3817	{
3818	case OP_JO:
3819	case OP_JNO:
3820	case OP_JC:
3821	case OP_JNC:
3822	case OP_JE:
3823	case OP_JNE:
3824	case OP_JBE:
3825	case OP_JNBE:
3826	case OP_JS:
3827	case OP_JNS:
3828	case OP_JP:
3829	case OP_JNP:
3830	case OP_JL:
3831	case OP_JNL:
3832	case OP_JLE:
3833	case OP_JNLE:
3834	case OP_JMP:
3835	Assert(pPatch->flags & PATMFL_JUMP_CONFLICT);
3836	Assert(pCpu->param1.flags & USE_IMMEDIATE32_REL);
3837	if (!(pCpu->param1.flags & USE_IMMEDIATE32_REL))
3838	goto failure;
3839
3840	Assert(pCpu->opsize == SIZEOF_NEARJUMP32 \|\| pCpu->opsize == SIZEOF_NEAR_COND_JUMP32);
3841	if (pCpu->opsize != SIZEOF_NEARJUMP32 && pCpu->opsize != SIZEOF_NEAR_COND_JUMP32)
3842	goto failure;
3843
3844	if (PAGE_ADDRESS(pInstrGC) != PAGE_ADDRESS(pInstrGC + pCpu->opsize))
3845	{
3846	STAM_COUNTER_INC(&pVM->patm.s.StatPageBoundaryCrossed);
3847	AssertMsgFailed(("Patch jump would cross page boundary -> refuse!!\n"));
3848	rc = VERR_PATCHING_REFUSED;
3849	goto failure;
3850	}
3851
3852	break;
3853
3854	default:
3855	goto failure;
3856	}
3857
3858	// make a copy of the guest code bytes that will be overwritten
3859	Assert(pCpu->opsize <= sizeof(pPatch->aPrivInstr));
3860	Assert(pCpu->opsize >= SIZEOF_NEARJUMP32);
3861	pPatch->cbPatchJump = pCpu->opsize;
3862
3863	rc = PGMPhysReadGCPtr(pVM, pPatch->aPrivInstr, pPatch->pPrivInstrGC, pPatch->cbPatchJump);
3864	AssertRC(rc);
3865
3866	/* Now insert a jump in the guest code. */
3867	/*
3868	* A conflict jump patch needs to be treated differently; we'll just replace the relative jump address with one that
3869	* references the target instruction in the conflict patch.
3870	*/
3871	RTGCPTR pJmpDest = PATMR3GuestGCPtrToPatchGCPtr(pVM, pInstrGC + pCpu->opsize + (int32_t)pCpu->param1.parval);
3872
3873	AssertMsg(pJmpDest, ("PATMR3GuestGCPtrToPatchGCPtr failed for %VGv\n", pInstrGC + pCpu->opsize + (int32_t)pCpu->param1.parval));
3874	pPatch->pPatchJumpDestGC = pJmpDest;
3875
3876	rc = patmGenJumpToPatch(pVM, pPatch, true);
3877	AssertRC(rc);
3878	if (VBOX_FAILURE(rc))
3879	goto failure;
3880
3881	pPatch->flags \|= PATMFL_MUST_INSTALL_PATCHJMP;
3882
3883	#ifdef LOG_ENABLED
3884	cpu.mode = (pPatch->flags & PATMFL_CODE32) ? CPUMODE_32BIT : CPUMODE_16BIT;
3885	disret = PATMR3DISInstr(pVM, pPatch, &cpu, pPatch->pPrivInstrGC, pPatch->pPrivInstrHC, &opsize, szOutput);
3886	Log(("%s patch: %s", patmGetInstructionString(pPatch->opcode, pPatch->flags), szOutput));
3887	#endif
3888
3889	Log(("Successfully installed %s patch at %VGv\n", patmGetInstructionString(pPatch->opcode, pPatch->flags), pInstrGC));
3890
3891	STAM_COUNTER_INC(&pVM->patm.s.StatInstalledJump);
3892
3893	/* Lowest and highest address for write monitoring. */
3894	pPatch->pInstrGCLowest = pInstrGC;
3895	pPatch->pInstrGCHighest = pInstrGC + pPatch->cbPatchJump;
3896
3897	pPatch->uState = PATCH_ENABLED;
3898	return VINF_SUCCESS;
3899
3900	failure:
3901	/* Turn this cli patch into a dummy. */
3902	pPatch->uState = PATCH_REFUSED;
3903
3904	return rc;
3905	}
3906	#endif /* PATM_RESOLVE_CONFLICTS_WITH_JUMP_PATCHES */
3907
3908
3909	/**
3910	* Gives hint to PATM about supervisor guest instructions
3911	*
3912	* @returns VBox status code.
3913	* @param pVM The VM to operate on.
3914	* @param pInstr Guest context point to privileged instruction
3915	* @param flags Patch flags
3916	*/
3917	PATMR3DECL(int) PATMR3AddHint(PVM pVM, RTGCPTR pInstrGC, uint32_t flags)
3918	{
3919	Assert(pInstrGC);
3920	Assert(flags == PATMFL_CODE32);
3921
3922	Log(("PATMR3AddHint %VGv\n", pInstrGC));
3923	return PATMR3InstallPatch(pVM, pInstrGC, PATMFL_CODE32 \| PATMFL_INSTR_HINT);
3924	}
3925
3926	/**
3927	* Patch privileged instruction at specified location
3928	*
3929	* @returns VBox status code.
3930	* @param pVM The VM to operate on.
3931	* @param pInstr Guest context point to privileged instruction (0:32 flat address)
3932	* @param flags Patch flags
3933	*
3934	* @note returns failure if patching is not allowed or possible
3935	*/
3936	PATMR3DECL(int) PATMR3InstallPatch(PVM pVM, RTGCPTR pInstrGC, uint64_t flags)
3937	{
3938	DISCPUSTATE cpu;
3939	HCPTRTYPE(uint8_t *) pInstrHC;
3940	uint32_t opsize;
3941	PPATMPATCHREC pPatchRec;
3942	PCPUMCTX pCtx = 0;
3943	bool disret;
3944	int rc;
3945
3946	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)))
3947	{
3948	AssertFailed();
3949	return VERR_INVALID_PARAMETER;
3950	}
3951
3952	if (PATMIsEnabled(pVM) == false)
3953	return VERR_PATCHING_REFUSED;
3954
3955	/* Test for patch conflict only with patches that actually change guest code. */
3956	if (!(flags & (PATMFL_GUEST_SPECIFIC\|PATMFL_IDTHANDLER\|PATMFL_INTHANDLER\|PATMFL_TRAMPOLINE)))
3957	{
3958	PPATCHINFO pConflictPatch = PATMFindActivePatchByEntrypoint(pVM, pInstrGC);
3959	AssertReleaseMsg(pConflictPatch == 0, ("Unable to patch overwritten instruction at %VGv (%VGv)\n", pInstrGC, pConflictPatch->pPrivInstrGC));
3960	if (pConflictPatch != 0)
3961	return VERR_PATCHING_REFUSED;
3962	}
3963
3964	if (!(flags & PATMFL_CODE32))
3965	{
3966	/** @todo Only 32 bits code right now */
3967	AssertMsgFailed(("PATMR3InstallPatch: We don't support 16 bits code at this moment!!\n"));
3968	return VERR_NOT_IMPLEMENTED;
3969	}
3970
3971	/* We ran out of patch memory; don't bother anymore. */
3972	if (pVM->patm.s.fOutOfMemory == true)
3973	return VERR_PATCHING_REFUSED;
3974
3975	/* Make sure the code selector is wide open; otherwise refuse. */
3976	CPUMQueryGuestCtxPtr(pVM, &pCtx);
3977	if (CPUMGetGuestCPL(pVM, CPUMCTX2CORE(pCtx)) == 0)
3978	{
3979	RTGCPTR pInstrGCFlat = SELMToFlat(pVM, pCtx->eflags, pCtx->cs, &pCtx->csHid, pInstrGC);
3980	if (pInstrGCFlat != pInstrGC)
3981	{
3982	Log(("PATMR3InstallPatch: code selector not wide open: %04x:%VGv != %VGv eflags=%08x\n", pCtx->cs, pInstrGCFlat, pInstrGC, pCtx->eflags.u32));
3983	return VERR_PATCHING_REFUSED;
3984	}
3985	}
3986
3987	/** @note the OpenBSD specific check will break if we allow additional patches to be installed (int 3)) */
3988	if (!(flags & PATMFL_GUEST_SPECIFIC))
3989	{
3990	/* New code. Make sure CSAM has a go at it first. */
3991	CSAMR3CheckCode(pVM, pInstrGC);
3992	}
3993
3994	/** @note obsolete */
3995	if ( PATMIsPatchGCAddr(pVM, pInstrGC)
3996	&& (flags & PATMFL_MMIO_ACCESS))
3997	{
3998	RTGCUINTPTR offset;
3999	void *pvPatchCoreOffset;
4000
4001	/* Find the patch record. */
4002	offset = pInstrGC - pVM->patm.s.pPatchMemGC;
4003	pvPatchCoreOffset = RTAvloGCPtrGetBestFit(&pVM->patm.s.PatchLookupTreeHC->PatchTreeByPatchAddr, offset, false);
4004	if (pvPatchCoreOffset == NULL)
4005	{
4006	AssertMsgFailed(("PATMR3InstallPatch: patch not found at address %VGv!!\n", pInstrGC));
4007	return VERR_PATCH_NOT_FOUND; //fatal error
4008	}
4009	pPatchRec = PATM_PATCHREC_FROM_COREOFFSET(pvPatchCoreOffset);
4010
4011	return patmPatchPATMMMIOInstr(pVM, pInstrGC, &pPatchRec->patch);
4012	}
4013
4014	AssertReturn(!PATMIsPatchGCAddr(pVM, pInstrGC), VERR_PATCHING_REFUSED);
4015
4016	pPatchRec = (PPATMPATCHREC)RTAvloGCPtrGet(&pVM->patm.s.PatchLookupTreeHC->PatchTree, pInstrGC);
4017	if (pPatchRec)
4018	{
4019	Assert(!(flags & PATMFL_TRAMPOLINE));
4020
4021	/* Hints about existing patches are ignored. */
4022	if (flags & PATMFL_INSTR_HINT)
4023	return VERR_PATCHING_REFUSED;
4024
4025	if (pPatchRec->patch.uState == PATCH_DISABLE_PENDING)
4026	{
4027	Log(("PATMR3InstallPatch: disable operation is pending for patch at %VGv\n", pPatchRec->patch.pPrivInstrGC));
4028	PATMR3DisablePatch(pVM, pPatchRec->patch.pPrivInstrGC);
4029	Assert(pPatchRec->patch.uState == PATCH_DISABLED);
4030	}
4031
4032	if (pPatchRec->patch.uState == PATCH_DISABLED)
4033	{
4034	/* A patch, for which we previously received a hint, will be enabled and turned into a normal patch. */
4035	if (pPatchRec->patch.flags & PATMFL_INSTR_HINT)
4036	{
4037	Log(("Enabling HINTED patch %VGv\n", pInstrGC));
4038	pPatchRec->patch.flags &= ~PATMFL_INSTR_HINT;
4039	}
4040	else
4041	Log(("Enabling patch %VGv again\n", pInstrGC));
4042
4043	/** @todo we shouldn't disable and enable patches too often (it's relatively cheap, but pointless if it always happens) */
4044	rc = PATMR3EnablePatch(pVM, pInstrGC);
4045	if (VBOX_SUCCESS(rc))
4046	return VWRN_PATCH_ENABLED;
4047
4048	return rc;
4049	}
4050	if ( pPatchRec->patch.uState == PATCH_ENABLED
4051	\|\| pPatchRec->patch.uState == PATCH_DIRTY)
4052	{
4053	/*
4054	* The patch might have been overwritten.
4055	*/
4056	STAM_COUNTER_INC(&pVM->patm.s.StatOverwritten);
4057	if (pPatchRec->patch.uState != PATCH_REFUSED && pPatchRec->patch.uState != PATCH_UNUSABLE)
4058	{
4059	/* Patch must have been overwritten; remove it and pretend nothing happened. */
4060	Log(("Patch an existing patched instruction?!? (%VGv)\n", pInstrGC));
4061	if (pPatchRec->patch.flags & (PATMFL_DUPLICATE_FUNCTION\|PATMFL_IDTHANDLER\|PATMFL_MMIO_ACCESS\|PATMFL_INT3_REPLACEMENT\|PATMFL_INT3_REPLACEMENT_BLOCK))
4062	{
4063	if (flags & PATMFL_IDTHANDLER)
4064	pPatchRec->patch.flags \|= (flags & (PATMFL_IDTHANDLER\|PATMFL_TRAPHANDLER\|PATMFL_INTHANDLER)); /* update the type */
4065
4066	return VERR_PATM_ALREADY_PATCHED; /* already done once */
4067	}
4068	}
4069	PATMR3RemovePatch(pVM, pInstrGC);
4070	}
4071	else
4072	{
4073	AssertMsg(pPatchRec->patch.uState == PATCH_REFUSED \|\| pPatchRec->patch.uState == PATCH_UNUSABLE, ("Patch an existing patched instruction?!? (%VGv, state=%d)\n", pInstrGC, pPatchRec->patch.uState));
4074	/* already tried it once! */
4075	return VERR_PATCHING_REFUSED;
4076	}
4077	}
4078
4079	rc = MMHyperAlloc(pVM, sizeof(PATMPATCHREC), 0, MM_TAG_PATM_PATCH, (void **)&pPatchRec);
4080	if (VBOX_FAILURE(rc))
4081	{
4082	Log(("Out of memory!!!!\n"));
4083	return VERR_NO_MEMORY;
4084	}
4085	pPatchRec->Core.Key = pInstrGC;
4086	pPatchRec->patch.uState = PATCH_REFUSED; //default
4087	rc = RTAvloGCPtrInsert(&pVM->patm.s.PatchLookupTreeHC->PatchTree, &pPatchRec->Core);
4088	Assert(rc);
4089
4090	RTGCPHYS GCPhys;
4091	rc = PGMGstGetPage(pVM, pInstrGC, NULL, &GCPhys);
4092	if (rc != VINF_SUCCESS)
4093	{
4094	Log(("PGMGstGetPage failed with %Vrc\n", rc));
4095	return rc;
4096	}
4097	/* Disallow patching instructions inside ROM code; complete function duplication is allowed though. */
4098	if ( !(flags & (PATMFL_DUPLICATE_FUNCTION\|PATMFL_TRAMPOLINE))
4099	&& !PGMPhysIsGCPhysNormal(pVM, GCPhys))
4100	{
4101	Log(("Code at %RGv (phys %RGp) is in a ROM, MMIO or invalid page - refused\n", pInstrGC, GCPhys));
4102	return VERR_PATCHING_REFUSED;
4103	}
4104	GCPhys = GCPhys + (pInstrGC & PAGE_OFFSET_MASK);
4105	rc = PGMPhysGCPhys2HCPtr(pVM, GCPhys, MAX_INSTR_SIZE, (void **)&pInstrHC);
4106	AssertRCReturn(rc, rc);
4107
4108	pPatchRec->patch.pPrivInstrHC = pInstrHC;
4109	pPatchRec->patch.pPrivInstrGC = pInstrGC;
4110	pPatchRec->patch.flags = flags;
4111	pPatchRec->patch.uOpMode = (flags & PATMFL_CODE32) ? CPUMODE_32BIT : CPUMODE_16BIT;
4112
4113	pPatchRec->patch.pInstrGCLowest = pInstrGC;
4114	pPatchRec->patch.pInstrGCHighest = pInstrGC;
4115
4116	if (!(pPatchRec->patch.flags & (PATMFL_DUPLICATE_FUNCTION \| PATMFL_IDTHANDLER \| PATMFL_SYSENTER \| PATMFL_TRAMPOLINE)))
4117	{
4118	/*
4119	* Close proximity to an unusable patch is a possible hint that this patch would turn out to be dangerous too!
4120	*/
4121	PPATMPATCHREC pPatchNear = (PPATMPATCHREC)RTAvloGCPtrGetBestFit(&pVM->patm.s.PatchLookupTreeHC->PatchTree, (pInstrGC + SIZEOF_NEARJUMP32 - 1), false);
4122	if (pPatchNear)
4123	{
4124	if (pPatchNear->patch.uState == PATCH_UNUSABLE && pInstrGC < pPatchNear->patch.pPrivInstrGC && pInstrGC + SIZEOF_NEARJUMP32 > pPatchNear->patch.pPrivInstrGC)
4125	{
4126	Log(("Dangerous patch; would overwrite the ususable patch at %VGv\n", pPatchNear->patch.pPrivInstrGC));
4127
4128	pPatchRec->patch.uState = PATCH_UNUSABLE;
4129	/*
4130	* Leave the new patch active as it's marked unusable; to prevent us from checking it over and over again
4131	*/
4132	return VERR_PATCHING_REFUSED;
4133	}
4134	}
4135	}
4136
4137	pPatchRec->patch.pTempInfo = (PPATCHINFOTEMP)MMR3HeapAllocZ(pVM, MM_TAG_PATM_PATCH, sizeof(PATCHINFOTEMP));
4138	if (pPatchRec->patch.pTempInfo == 0)
4139	{
4140	Log(("Out of memory!!!!\n"));
4141	return VERR_NO_MEMORY;
4142	}
4143
4144	cpu.mode = pPatchRec->patch.uOpMode;
4145	disret = PATMR3DISInstr(pVM, &pPatchRec->patch, &cpu, pInstrGC, pInstrHC, &opsize, NULL);
4146	if (disret == false)
4147	{
4148	Log(("Disassembly failed (probably page not present) -> return to caller\n"));
4149	return VERR_PATCHING_REFUSED;
4150	}
4151
4152	AssertMsg(opsize <= MAX_INSTR_SIZE, ("privileged instruction too big %d!!\n", opsize));
4153	if (opsize > MAX_INSTR_SIZE)
4154	{
4155	return VERR_PATCHING_REFUSED;
4156	}
4157
4158	pPatchRec->patch.cbPrivInstr = opsize;
4159	pPatchRec->patch.opcode = cpu.pCurInstr->opcode;
4160
4161	/* Restricted hinting for now. */
4162	Assert(!(flags & PATMFL_INSTR_HINT) \|\| cpu.pCurInstr->opcode == OP_CLI);
4163
4164	/* Allocate statistics slot */
4165	if (pVM->patm.s.uCurrentPatchIdx < PATM_STAT_MAX_COUNTERS)
4166	{
4167	pPatchRec->patch.uPatchIdx = pVM->patm.s.uCurrentPatchIdx++;
4168	}
4169	else
4170	{
4171	Log(("WARNING: Patch index wrap around!!\n"));
4172	pPatchRec->patch.uPatchIdx = PATM_STAT_INDEX_DUMMY;
4173	}
4174
4175	if (pPatchRec->patch.flags & PATMFL_TRAPHANDLER)
4176	{
4177	rc = patmInstallTrapTrampoline(pVM, pInstrGC, pPatchRec);
4178	}
4179	else
4180	if (pPatchRec->patch.flags & (PATMFL_DUPLICATE_FUNCTION ))
4181	{
4182	rc = patmDuplicateFunction(pVM, pInstrGC, pPatchRec);
4183	}
4184	else
4185	if (pPatchRec->patch.flags & PATMFL_TRAMPOLINE)
4186	{
4187	rc = patmCreateTrampoline(pVM, pInstrGC, pPatchRec);
4188	}
4189	else
4190	if (pPatchRec->patch.flags & PATMFL_REPLACE_FUNCTION_CALL)
4191	{
4192	rc = patmReplaceFunctionCall(pVM, &cpu, pInstrGC, &pPatchRec->patch);
4193	}
4194	else
4195	if (pPatchRec->patch.flags & PATMFL_INT3_REPLACEMENT)
4196	{
4197	rc = PATMR3PatchInstrInt3(pVM, pInstrGC, pInstrHC, &cpu, &pPatchRec->patch);
4198	}
4199	else
4200	if (pPatchRec->patch.flags & PATMFL_MMIO_ACCESS)
4201	{
4202	rc = patmPatchMMIOInstr(pVM, pInstrGC, &cpu, &pPatchRec->patch);
4203	}
4204	else
4205	if (pPatchRec->patch.flags & (PATMFL_IDTHANDLER\|PATMFL_SYSENTER))
4206	{
4207	if (pPatchRec->patch.flags & PATMFL_SYSENTER)
4208	pPatchRec->patch.flags \|= PATMFL_IDTHANDLER; /* we treat a sysenter handler as an IDT handler */
4209
4210	rc = patmIdtHandler(pVM, pInstrGC, pInstrHC, opsize, pPatchRec);
4211	#ifdef VBOX_WITH_STATISTICS
4212	if ( rc == VINF_SUCCESS
4213	&& (pPatchRec->patch.flags & PATMFL_SYSENTER))
4214	{
4215	pVM->patm.s.uSysEnterPatchIdx = pPatchRec->patch.uPatchIdx;
4216	}
4217	#endif
4218	}
4219	else
4220	if (pPatchRec->patch.flags & PATMFL_GUEST_SPECIFIC)
4221	{
4222	switch (cpu.pCurInstr->opcode)
4223	{
4224	case OP_SYSENTER:
4225	case OP_PUSH:
4226	rc = PATMInstallGuestSpecificPatch(pVM, &cpu, pInstrGC, pInstrHC, pPatchRec);
4227	if (rc == VINF_SUCCESS)
4228	{
4229	if (rc == VINF_SUCCESS)
4230	Log(("PATMR3InstallPatch GUEST: %s %VGv code32=%d\n", patmGetInstructionString(pPatchRec->patch.opcode, pPatchRec->patch.flags), pInstrGC, (flags & PATMFL_CODE32) ? 1 : 0));
4231	return rc;
4232	}
4233	break;
4234
4235	default:
4236	rc = VERR_NOT_IMPLEMENTED;
4237	break;
4238	}
4239	}
4240	else
4241	{
4242	switch (cpu.pCurInstr->opcode)
4243	{
4244	case OP_SYSENTER:
4245	rc = PATMInstallGuestSpecificPatch(pVM, &cpu, pInstrGC, pInstrHC, pPatchRec);
4246	if (rc == VINF_SUCCESS)
4247	{
4248	Log(("PATMR3InstallPatch GUEST: %s %VGv code32=%d\n", patmGetInstructionString(pPatchRec->patch.opcode, pPatchRec->patch.flags), pInstrGC, (flags & PATMFL_CODE32) ? 1 : 0));
4249	return VINF_SUCCESS;
4250	}
4251	break;
4252
4253	#ifdef PATM_RESOLVE_CONFLICTS_WITH_JUMP_PATCHES
4254	case OP_JO:
4255	case OP_JNO:
4256	case OP_JC:
4257	case OP_JNC:
4258	case OP_JE:
4259	case OP_JNE:
4260	case OP_JBE:
4261	case OP_JNBE:
4262	case OP_JS:
4263	case OP_JNS:
4264	case OP_JP:
4265	case OP_JNP:
4266	case OP_JL:
4267	case OP_JNL:
4268	case OP_JLE:
4269	case OP_JNLE:
4270	case OP_JECXZ:
4271	case OP_LOOP:
4272	case OP_LOOPNE:
4273	case OP_LOOPE:
4274	case OP_JMP:
4275	if (pPatchRec->patch.flags & PATMFL_JUMP_CONFLICT)
4276	{
4277	rc = patmPatchJump(pVM, pInstrGC, pInstrHC, &cpu, pPatchRec);
4278	break;
4279	}
4280	return VERR_NOT_IMPLEMENTED;
4281	#endif
4282
4283	case OP_PUSHF:
4284	case OP_CLI:
4285	Log(("PATMR3InstallPatch %s %VGv code32=%d\n", patmGetInstructionString(pPatchRec->patch.opcode, pPatchRec->patch.flags), pInstrGC, (flags & PATMFL_CODE32) ? 1 : 0));
4286	rc = PATMR3PatchBlock(pVM, pInstrGC, pInstrHC, cpu.pCurInstr->opcode, opsize, pPatchRec);
4287	break;
4288
4289	case OP_STR:
4290	case OP_SGDT:
4291	case OP_SLDT:
4292	case OP_SIDT:
4293	case OP_CPUID:
4294	case OP_LSL:
4295	case OP_LAR:
4296	case OP_SMSW:
4297	case OP_VERW:
4298	case OP_VERR:
4299	case OP_IRET:
4300	rc = PATMR3PatchInstrInt3(pVM, pInstrGC, pInstrHC, &cpu, &pPatchRec->patch);
4301	break;
4302
4303	default:
4304	return VERR_NOT_IMPLEMENTED;
4305	}
4306	}
4307
4308	if (rc != VINF_SUCCESS)
4309	{
4310	if (pPatchRec && pPatchRec->patch.nrPatch2GuestRecs)
4311	{
4312	patmEmptyTreeU32(pVM, &pPatchRec->patch.Patch2GuestAddrTree);
4313	pPatchRec->patch.nrPatch2GuestRecs = 0;
4314	}
4315	pVM->patm.s.uCurrentPatchIdx--;
4316	}
4317	else
4318	{
4319	rc = patmInsertPatchPages(pVM, &pPatchRec->patch);
4320	AssertRCReturn(rc, rc);
4321
4322	/* Keep track upper and lower boundaries of patched instructions */
4323	if (pPatchRec->patch.pInstrGCLowest < pVM->patm.s.pPatchedInstrGCLowest)
4324	pVM->patm.s.pPatchedInstrGCLowest = pPatchRec->patch.pInstrGCLowest;
4325	if (pPatchRec->patch.pInstrGCHighest > pVM->patm.s.pPatchedInstrGCHighest)
4326	pVM->patm.s.pPatchedInstrGCHighest = pPatchRec->patch.pInstrGCHighest;
4327
4328	Log(("Patch lowest %VGv highest %VGv\n", pPatchRec->patch.pInstrGCLowest, pPatchRec->patch.pInstrGCHighest));
4329	Log(("Global lowest %VGv highest %VGv\n", pVM->patm.s.pPatchedInstrGCLowest, pVM->patm.s.pPatchedInstrGCHighest));
4330
4331	STAM_COUNTER_ADD(&pVM->patm.s.StatInstalled, 1);
4332	STAM_COUNTER_ADD(&pVM->patm.s.StatPATMMemoryUsed, pPatchRec->patch.cbPatchBlockSize);
4333
4334	rc = VINF_SUCCESS;
4335
4336	/* Patch hints are not enabled by default. Only when the are actually encountered. */
4337	if (pPatchRec->patch.flags & PATMFL_INSTR_HINT)
4338	{
4339	rc = PATMR3DisablePatch(pVM, pInstrGC);
4340	AssertRCReturn(rc, rc);
4341	}
4342
4343	#ifdef VBOX_WITH_STATISTICS
4344	/* Register statistics counter */
4345	if (PATM_STAT_INDEX_IS_VALID(pPatchRec->patch.uPatchIdx))
4346	{
4347	STAMR3RegisterCallback(pVM, &pPatchRec->patch, STAMVISIBILITY_NOT_GUI, STAMUNIT_GOOD_BAD, patmResetStat, patmPrintStat, "Patch statistics",
4348	"/PATM/Stats/Patch/0x%VGv", pPatchRec->patch.pPrivInstrGC);
4349	#ifndef DEBUG_sandervl
4350	/* Full breakdown for the GUI. */
4351	STAMR3RegisterF(pVM, &pVM->patm.s.pStatsHC[pPatchRec->patch.uPatchIdx], STAMTYPE_RATIO_U32, STAMVISIBILITY_ALWAYS, STAMUNIT_GOOD_BAD, PATMPatchType(pVM, &pPatchRec->patch),
4352	"/PATM/Stats/PatchBD/0x%VGv", pPatchRec->patch.pPrivInstrGC);
4353	STAMR3RegisterF(pVM, &pPatchRec->patch.cbPatchBlockSize,STAMTYPE_U32, STAMVISIBILITY_ALWAYS, STAMUNIT_BYTES, NULL, "/PATM/Stats/PatchBD/0x%VGv/cbPatchBlockSize", pPatchRec->patch.pPrivInstrGC);
4354	STAMR3RegisterF(pVM, &pPatchRec->patch.cbPatchJump, STAMTYPE_U32, STAMVISIBILITY_ALWAYS, STAMUNIT_BYTES, NULL, "/PATM/Stats/PatchBD/0x%VGv/cbPatchJump", pPatchRec->patch.pPrivInstrGC);
4355	STAMR3RegisterF(pVM, &pPatchRec->patch.cbPrivInstr, STAMTYPE_U32, STAMVISIBILITY_ALWAYS, STAMUNIT_BYTES, NULL, "/PATM/Stats/PatchBD/0x%VGv/cbPrivInstr", pPatchRec->patch.pPrivInstrGC);
4356	STAMR3RegisterF(pVM, &pPatchRec->patch.cCodeWrites, STAMTYPE_U32, STAMVISIBILITY_ALWAYS, STAMUNIT_OCCURENCES, NULL, "/PATM/Stats/PatchBD/0x%VGv/cCodeWrites", pPatchRec->patch.pPrivInstrGC);
4357	STAMR3RegisterF(pVM, &pPatchRec->patch.cInvalidWrites, STAMTYPE_U32, STAMVISIBILITY_ALWAYS, STAMUNIT_OCCURENCES, NULL, "/PATM/Stats/PatchBD/0x%VGv/cInvalidWrites", pPatchRec->patch.pPrivInstrGC);
4358	STAMR3RegisterF(pVM, &pPatchRec->patch.cTraps, STAMTYPE_U32, STAMVISIBILITY_ALWAYS, STAMUNIT_OCCURENCES, NULL, "/PATM/Stats/PatchBD/0x%VGv/cTraps", pPatchRec->patch.pPrivInstrGC);
4359	STAMR3RegisterF(pVM, &pPatchRec->patch.flags, STAMTYPE_X32, STAMVISIBILITY_ALWAYS, STAMUNIT_NONE, NULL, "/PATM/Stats/PatchBD/0x%VGv/flags", pPatchRec->patch.pPrivInstrGC);
4360	STAMR3RegisterF(pVM, &pPatchRec->patch.nrJumpRecs, STAMTYPE_U32, STAMVISIBILITY_ALWAYS, STAMUNIT_OCCURENCES, NULL, "/PATM/Stats/PatchBD/0x%VGv/nrJumpRecs", pPatchRec->patch.pPrivInstrGC);
4361	STAMR3RegisterF(pVM, &pPatchRec->patch.nrFixups, STAMTYPE_U32, STAMVISIBILITY_ALWAYS, STAMUNIT_OCCURENCES, NULL, "/PATM/Stats/PatchBD/0x%VGv/nrFixups", pPatchRec->patch.pPrivInstrGC);
4362	STAMR3RegisterF(pVM, &pPatchRec->patch.opcode, STAMTYPE_U32, STAMVISIBILITY_ALWAYS, STAMUNIT_OCCURENCES, NULL, "/PATM/Stats/PatchBD/0x%VGv/opcode", pPatchRec->patch.pPrivInstrGC);
4363	STAMR3RegisterF(pVM, &pPatchRec->patch.uOldState, STAMTYPE_U32, STAMVISIBILITY_ALWAYS, STAMUNIT_NONE, NULL, "/PATM/Stats/PatchBD/0x%VGv/uOldState", pPatchRec->patch.pPrivInstrGC);
4364	STAMR3RegisterF(pVM, &pPatchRec->patch.uOpMode, STAMTYPE_U32, STAMVISIBILITY_ALWAYS, STAMUNIT_NONE, NULL, "/PATM/Stats/PatchBD/0x%VGv/uOpMode", pPatchRec->patch.pPrivInstrGC);
4365	/// @todo change the state to be a callback so we can get a state mnemonic instead.
4366	STAMR3RegisterF(pVM, &pPatchRec->patch.uState, STAMTYPE_U32, STAMVISIBILITY_ALWAYS, STAMUNIT_NONE, NULL, "/PATM/Stats/PatchBD/0x%VGv/uState", pPatchRec->patch.pPrivInstrGC);
4367	#endif
4368	}
4369	#endif
4370	}
4371	return rc;
4372	}
4373
4374	/**
4375	* Query instruction size
4376	*
4377	* @returns VBox status code.
4378	* @param pVM The VM to operate on.
4379	* @param pPatch Patch record
4380	* @param pInstrGC Instruction address
4381	*/
4382	static uint32_t patmGetInstrSize(PVM pVM, PPATCHINFO pPatch, RTGCPTR pInstrGC)
4383	{
4384	uint8_t *pInstrHC;
4385
4386	int rc = PGMPhysGCPtr2HCPtr(pVM, pInstrGC, (RTHCPTR *)&pInstrHC);
4387	if (rc == VINF_SUCCESS)
4388	{
4389	DISCPUSTATE cpu;
4390	bool disret;
4391	uint32_t opsize;
4392
4393	cpu.mode = (pPatch->flags & PATMFL_CODE32) ? CPUMODE_32BIT : CPUMODE_16BIT;
4394	disret = PATMR3DISInstr(pVM, pPatch, &cpu, pInstrGC, pInstrHC, &opsize, NULL, PATMREAD_ORGCODE \| PATMREAD_NOCHECK);
4395	if (disret)
4396	return opsize;
4397	}
4398	return 0;
4399	}
4400
4401	/**
4402	* Add patch to page record
4403	*
4404	* @returns VBox status code.
4405	* @param pVM The VM to operate on.
4406	* @param pPage Page address
4407	* @param pPatch Patch record
4408	*/
4409	int patmAddPatchToPage(PVM pVM, RTGCUINTPTR pPage, PPATCHINFO pPatch)
4410	{
4411	PPATMPATCHPAGE pPatchPage;
4412	int rc;
4413
4414	Log(("patmAddPatchToPage: insert patch %VHv to page %VGv\n", pPatch, pPage));
4415
4416	pPatchPage = (PPATMPATCHPAGE)RTAvloGCPtrGet(&pVM->patm.s.PatchLookupTreeHC->PatchTreeByPage, pPage);
4417	if (pPatchPage)
4418	{
4419	Assert(pPatchPage->cCount <= pPatchPage->cMaxPatches);
4420	if (pPatchPage->cCount == pPatchPage->cMaxPatches)
4421	{
4422	uint32_t cMaxPatchesOld = pPatchPage->cMaxPatches;
4423	PPATCHINFO *paPatchOld = pPatchPage->aPatch;
4424
4425	pPatchPage->cMaxPatches += PATMPATCHPAGE_PREALLOC_INCREMENT;
4426	rc = MMHyperAlloc(pVM, sizeof(PPATCHINFO)pPatchPage->cMaxPatches, 0, MM_TAG_PATM_PATCH, (void *)&pPatchPage->aPatch);
4427	if (VBOX_FAILURE(rc))
4428	{
4429	Log(("Out of memory!!!!\n"));
4430	return VERR_NO_MEMORY;
4431	}
4432	memcpy(pPatchPage->aPatch, paPatchOld, cMaxPatchesOld*sizeof(PPATCHINFO));
4433	MMHyperFree(pVM, paPatchOld);
4434	}
4435	pPatchPage->aPatch[pPatchPage->cCount] = pPatch;
4436	pPatchPage->cCount++;
4437	}
4438	else
4439	{
4440	rc = MMHyperAlloc(pVM, sizeof(PATMPATCHPAGE), 0, MM_TAG_PATM_PATCH, (void **)&pPatchPage);
4441	if (VBOX_FAILURE(rc))
4442	{
4443	Log(("Out of memory!!!!\n"));
4444	return VERR_NO_MEMORY;
4445	}
4446	pPatchPage->Core.Key = pPage;
4447	pPatchPage->cCount = 1;
4448	pPatchPage->cMaxPatches = PATMPATCHPAGE_PREALLOC_INCREMENT;
4449
4450	rc = MMHyperAlloc(pVM, sizeof(PPATCHINFO)PATMPATCHPAGE_PREALLOC_INCREMENT, 0, MM_TAG_PATM_PATCH, (void *)&pPatchPage->aPatch);
4451	if (VBOX_FAILURE(rc))
4452	{
4453	Log(("Out of memory!!!!\n"));
4454	MMHyperFree(pVM, pPatchPage);
4455	return VERR_NO_MEMORY;
4456	}
4457	pPatchPage->aPatch[0] = pPatch;
4458
4459	rc = RTAvloGCPtrInsert(&pVM->patm.s.PatchLookupTreeHC->PatchTreeByPage, &pPatchPage->Core);
4460	Assert(rc);
4461	pVM->patm.s.cPageRecords++;
4462
4463	STAM_COUNTER_INC(&pVM->patm.s.StatPatchPageInserted);
4464	}
4465	CSAMR3MonitorPage(pVM, pPage, CSAM_TAG_PATM);
4466
4467	/* Get the closest guest instruction (from below) */
4468	PRECGUESTTOPATCH pGuestToPatchRec = (PRECGUESTTOPATCH)RTAvlGCPtrGetBestFit(&pPatch->Guest2PatchAddrTree, pPage, true);
4469	Assert(pGuestToPatchRec);
4470	if (pGuestToPatchRec)
4471	{
4472	if ( pPatchPage->pLowestAddrGC == 0
4473	\|\| pPatchPage->pLowestAddrGC > (RTGCPTR)pGuestToPatchRec->Core.Key)
4474	{
4475	RTGCUINTPTR offset;
4476
4477	pPatchPage->pLowestAddrGC = (RTGCPTR)pGuestToPatchRec->Core.Key;
4478
4479	offset = pPatchPage->pLowestAddrGC & PAGE_OFFSET_MASK;
4480	/* If we're too close to the page boundary, then make sure an instruction from the previous page doesn't cross the boundary itself. */
4481	if (offset && offset < MAX_INSTR_SIZE)
4482	{
4483	/* Get the closest guest instruction (from above) */
4484	pGuestToPatchRec = (PRECGUESTTOPATCH)RTAvlGCPtrGetBestFit(&pPatch->Guest2PatchAddrTree, pPage-1, false);
4485
4486	if (pGuestToPatchRec)
4487	{
4488	uint32_t size = patmGetInstrSize(pVM, pPatch, (RTGCPTR)pGuestToPatchRec->Core.Key);
4489	if ((RTGCUINTPTR)pGuestToPatchRec->Core.Key + size > pPage)
4490	pPatchPage->pLowestAddrGC = pPage;
4491	}
4492	}
4493	}
4494	}
4495
4496	/* Get the closest guest instruction (from above) */
4497	pGuestToPatchRec = (PRECGUESTTOPATCH)RTAvlGCPtrGetBestFit(&pPatch->Guest2PatchAddrTree, pPage+PAGE_SIZE-1, false);
4498	Assert(pGuestToPatchRec);
4499	if (pGuestToPatchRec)
4500	{
4501	if ( pPatchPage->pHighestAddrGC == 0
4502	\|\| pPatchPage->pHighestAddrGC < (RTGCPTR)pGuestToPatchRec->Core.Key)
4503	{
4504	pPatchPage->pHighestAddrGC = (RTGCPTR)pGuestToPatchRec->Core.Key;
4505	/* Increase by instruction size. */
4506	uint32_t size = patmGetInstrSize(pVM, pPatch, pPatchPage->pHighestAddrGC);
4507	//// Assert(size);
4508	pPatchPage->pHighestAddrGC += size;
4509	}
4510	}
4511
4512	return VINF_SUCCESS;
4513	}
4514
4515	/**
4516	* Remove patch from page record
4517	*
4518	* @returns VBox status code.
4519	* @param pVM The VM to operate on.
4520	* @param pPage Page address
4521	* @param pPatch Patch record
4522	*/
4523	int patmRemovePatchFromPage(PVM pVM, RTGCUINTPTR pPage, PPATCHINFO pPatch)
4524	{
4525	PPATMPATCHPAGE pPatchPage;
4526	int rc;
4527
4528	pPatchPage = (PPATMPATCHPAGE)RTAvloGCPtrGet(&pVM->patm.s.PatchLookupTreeHC->PatchTreeByPage, pPage);
4529	Assert(pPatchPage);
4530
4531	if (!pPatchPage)
4532	return VERR_INVALID_PARAMETER;
4533
4534	Assert(pPatchPage->cCount <= pPatchPage->cMaxPatches);
4535
4536	Log(("patmRemovePatchPage: remove patch %VHv from page %VGv\n", pPatch, pPage));
4537	if (pPatchPage->cCount > 1)
4538	{
4539	uint32_t i;
4540
4541	/* Used by multiple patches */
4542	for (i=0;i<pPatchPage->cCount;i++)
4543	{
4544	if (pPatchPage->aPatch[i] == pPatch)
4545	{
4546	pPatchPage->aPatch[i] = 0;
4547	break;
4548	}
4549	}
4550	/* close the gap between the remaining pointers. */
4551	if (i < pPatchPage->cCount - 1)
4552	{
4553	memcpy(&pPatchPage->aPatch[i], &pPatchPage->aPatch[i+1], sizeof(PPATCHINFO)*(pPatchPage->cCount - (i+1)));
4554	}
4555	AssertMsg(i < pPatchPage->cCount, ("Unable to find patch %VHv in page %VGv\n", pPatch, pPage));
4556
4557	pPatchPage->cCount--;
4558	}
4559	else
4560	{
4561	PPATMPATCHPAGE pPatchNode;
4562
4563	Log(("patmRemovePatchFromPage %VGv\n", pPage));
4564
4565	STAM_COUNTER_INC(&pVM->patm.s.StatPatchPageRemoved);
4566	pPatchNode = (PPATMPATCHPAGE)RTAvloGCPtrRemove(&pVM->patm.s.PatchLookupTreeHC->PatchTreeByPage, pPage);
4567	Assert(pPatchNode && pPatchNode == pPatchPage);
4568
4569	Assert(pPatchPage->aPatch);
4570	rc = MMHyperFree(pVM, pPatchPage->aPatch);
4571	AssertRC(rc);
4572	rc = MMHyperFree(pVM, pPatchPage);
4573	AssertRC(rc);
4574	pVM->patm.s.cPageRecords--;
4575	}
4576	return VINF_SUCCESS;
4577	}
4578
4579	/**
4580	* Insert page records for all guest pages that contain instructions that were recompiled for this patch
4581	*
4582	* @returns VBox status code.
4583	* @param pVM The VM to operate on.
4584	* @param pPatch Patch record
4585	*/
4586	int patmInsertPatchPages(PVM pVM, PPATCHINFO pPatch)
4587	{
4588	int rc;
4589	RTGCUINTPTR pPatchPageStart, pPatchPageEnd, pPage;
4590
4591	/* Insert the pages that contain patched instructions into a lookup tree for detecting self-modifying code. */
4592	pPatchPageStart = (RTGCUINTPTR)pPatch->pInstrGCLowest & PAGE_BASE_GC_MASK;
4593	pPatchPageEnd = (RTGCUINTPTR)pPatch->pInstrGCHighest & PAGE_BASE_GC_MASK;
4594
4595	/** @todo optimize better (large gaps between current and next used page) */
4596	for(pPage = pPatchPageStart; pPage <= pPatchPageEnd; pPage += PAGE_SIZE)
4597	{
4598	/* Get the closest guest instruction (from above) */
4599	PRECGUESTTOPATCH pGuestToPatchRec = (PRECGUESTTOPATCH)RTAvlGCPtrGetBestFit(&pPatch->Guest2PatchAddrTree, pPage, true);
4600	if ( pGuestToPatchRec
4601	&& PAGE_ADDRESS(pGuestToPatchRec->Core.Key) == PAGE_ADDRESS(pPage)
4602	)
4603	{
4604	/* Code in page really patched -> add record */
4605	rc = patmAddPatchToPage(pVM, pPage, pPatch);
4606	AssertRC(rc);
4607	}
4608	}
4609	pPatch->flags \|= PATMFL_CODE_MONITORED;
4610	return VINF_SUCCESS;
4611	}
4612
4613	/**
4614	* Remove page records for all guest pages that contain instructions that were recompiled for this patch
4615	*
4616	* @returns VBox status code.
4617	* @param pVM The VM to operate on.
4618	* @param pPatch Patch record
4619	*/
4620	int patmRemovePatchPages(PVM pVM, PPATCHINFO pPatch)
4621	{
4622	int rc;
4623	RTGCUINTPTR pPatchPageStart, pPatchPageEnd, pPage;
4624
4625	/* Insert the pages that contain patched instructions into a lookup tree for detecting self-modifying code. */
4626	pPatchPageStart = (RTGCUINTPTR)pPatch->pInstrGCLowest & PAGE_BASE_GC_MASK;
4627	pPatchPageEnd = (RTGCUINTPTR)pPatch->pInstrGCHighest & PAGE_BASE_GC_MASK;
4628
4629	for(pPage = pPatchPageStart; pPage <= pPatchPageEnd; pPage += PAGE_SIZE)
4630	{
4631	/* Get the closest guest instruction (from above) */
4632	PRECGUESTTOPATCH pGuestToPatchRec = (PRECGUESTTOPATCH)RTAvlGCPtrGetBestFit(&pPatch->Guest2PatchAddrTree, pPage, true);
4633	if ( pGuestToPatchRec
4634	&& PAGE_ADDRESS(pGuestToPatchRec->Core.Key) == PAGE_ADDRESS(pPage) /** @todo bird: PAGE_ADDRESS is for the current context really. check out these. */
4635	)
4636	{
4637	/* Code in page really patched -> remove record */
4638	rc = patmRemovePatchFromPage(pVM, pPage, pPatch);
4639	AssertRC(rc);
4640	}
4641	}
4642	pPatch->flags &= ~PATMFL_CODE_MONITORED;
4643	return VINF_SUCCESS;
4644	}
4645
4646	/**
4647	* Notifies PATM about a (potential) write to code that has been patched.
4648	*
4649	* @returns VBox status code.
4650	* @param pVM The VM to operate on.
4651	* @param GCPtr GC pointer to write address
4652	* @param cbWrite Nr of bytes to write
4653	*
4654	*/
4655	PATMR3DECL(int) PATMR3PatchWrite(PVM pVM, RTGCPTR GCPtr, uint32_t cbWrite)
4656	{
4657	RTGCUINTPTR pWritePageStart, pWritePageEnd, pPage;
4658
4659	Log(("PATMR3PatchWrite %VGv %x\n", GCPtr, cbWrite));
4660
4661	Assert(VM_IS_EMT(pVM));
4662
4663	/* Quick boundary check */
4664	if ( GCPtr < pVM->patm.s.pPatchedInstrGCLowest
4665	\|\| GCPtr > pVM->patm.s.pPatchedInstrGCHighest
4666	)
4667	return VINF_SUCCESS;
4668
4669	STAM_PROFILE_ADV_START(&pVM->patm.s.StatPatchWrite, a);
4670
4671	pWritePageStart = (RTGCUINTPTR)GCPtr & PAGE_BASE_GC_MASK;
4672	pWritePageEnd = ((RTGCUINTPTR)GCPtr + cbWrite - 1) & PAGE_BASE_GC_MASK;
4673
4674	for (pPage = pWritePageStart; pPage <= pWritePageEnd; pPage += PAGE_SIZE)
4675	{
4676	loop_start:
4677	PPATMPATCHPAGE pPatchPage = (PPATMPATCHPAGE)RTAvloGCPtrGet(&pVM->patm.s.PatchLookupTreeHC->PatchTreeByPage, (RTGCPTR)pPage);
4678	if (pPatchPage)
4679	{
4680	uint32_t i;
4681	bool fValidPatchWrite = false;
4682
4683	for (i=0;i<pPatchPage->cCount;i++)
4684	{
4685	if (pPatchPage->aPatch[i])
4686	{
4687	PPATCHINFO pPatch = pPatchPage->aPatch[i];
4688	RTGCPTR pPatchInstrGC;
4689	//unused: bool fForceBreak = false;
4690
4691	Assert(pPatchPage->aPatch[i]->flags & PATMFL_CODE_MONITORED);
4692	/** @todo inefficient and includes redundant checks for multiple pages. */
4693	for (uint32_t j=0; j<cbWrite; j++)
4694	{
4695	RTGCPTR pGuestPtrGC = (RTGCPTR)((RTGCUINTPTR)GCPtr + j);
4696
4697	if ( pPatch->cbPatchJump
4698	&& pGuestPtrGC >= pPatch->pPrivInstrGC
4699	&& pGuestPtrGC < pPatch->pPrivInstrGC + pPatch->cbPatchJump)
4700	{
4701	/* The guest is about to overwrite the 5 byte jump to patch code. Remove the patch. */
4702	Log(("PATMR3PatchWrite: overwriting jump to patch code -> remove patch.\n"));
4703	int rc = PATMR3RemovePatch(pVM, pPatch->pPrivInstrGC);
4704	AssertRC(rc);
4705
4706	/** @note jump back to the start as the pPatchPage has been deleted or changed */
4707	goto loop_start;
4708	}
4709
4710	pPatchInstrGC = patmGuestGCPtrToPatchGCPtr(pVM, pPatch, pGuestPtrGC);
4711	if (pPatchInstrGC)
4712	{
4713	uint32_t PatchOffset = pPatchInstrGC - pVM->patm.s.pPatchMemGC; /* Offset in memory reserved for PATM. */
4714
4715	fValidPatchWrite = true;
4716
4717	PRECPATCHTOGUEST pPatchToGuestRec = (PRECPATCHTOGUEST)RTAvlU32Get(&pPatch->Patch2GuestAddrTree, PatchOffset);
4718	Assert(pPatchToGuestRec);
4719	if (pPatchToGuestRec && !pPatchToGuestRec->fDirty)
4720	{
4721	Log(("PATMR3PatchWrite: Found patched instruction %VGv -> %VGv\n", pGuestPtrGC, pPatchInstrGC));
4722
4723	if (++pPatch->cCodeWrites > PATM_MAX_CODE_WRITES)
4724	{
4725	LogRel(("PATM: Disable block at %VGv - write %VGv-%VGv\n", pPatch->pPrivInstrGC, pGuestPtrGC, pGuestPtrGC+cbWrite));
4726
4727	PATMR3MarkDirtyPatch(pVM, pPatch);
4728
4729	/** @note jump back to the start as the pPatchPage has been deleted or changed */
4730	goto loop_start;
4731	}
4732	else
4733	{
4734	/* Replace the patch instruction with a breakpoint; when it's hit, then we'll attempt to recompile the instruction again. */
4735	uint8_t *pInstrHC = patmPatchGCPtr2PatchHCPtr(pVM, pPatchInstrGC);
4736
4737	pPatchToGuestRec->u8DirtyOpcode = *pInstrHC;
4738	pPatchToGuestRec->fDirty = true;
4739
4740	*pInstrHC = 0xCC;
4741
4742	STAM_COUNTER_INC(&pVM->patm.s.StatInstrDirty);
4743	}
4744	}
4745	/* else already marked dirty */
4746	}
4747	}
4748	}
4749	} /* for each patch */
4750
4751	if (fValidPatchWrite == false)
4752	{
4753	/* Write to a part of the page that either:
4754	* - doesn't contain any code (shared code/data); rather unlikely
4755	* - old code page that's no longer in active use.
4756	*/
4757	invalid_write_loop_start:
4758	pPatchPage = (PPATMPATCHPAGE)RTAvloGCPtrGet(&pVM->patm.s.PatchLookupTreeHC->PatchTreeByPage, (RTGCPTR)pPage);
4759
4760	if (pPatchPage)
4761	{
4762	for (i=0;i<pPatchPage->cCount;i++)
4763	{
4764	PPATCHINFO pPatch = pPatchPage->aPatch[i];
4765
4766	if (pPatch->cInvalidWrites > PATM_MAX_INVALID_WRITES)
4767	{
4768	/** @note possibly dangerous assumption that all future writes will be harmless. */
4769	if (pPatch->flags & PATMFL_IDTHANDLER)
4770	{
4771	LogRel(("PATM: Stop monitoring IDT handler pages at %VGv - invalid write %VGv-%VGv \n", pPatch->pPrivInstrGC, GCPtr, GCPtr+cbWrite));
4772
4773	Assert(pPatch->flags & PATMFL_CODE_MONITORED);
4774	int rc = patmRemovePatchPages(pVM, pPatch);
4775	AssertRC(rc);
4776	}
4777	else
4778	{
4779	LogRel(("PATM: Disable block at %VGv - invalid write %VGv-%VGv \n", pPatch->pPrivInstrGC, GCPtr, GCPtr+cbWrite));
4780	PATMR3MarkDirtyPatch(pVM, pPatch);
4781	}
4782	/** @note jump back to the start as the pPatchPage has been deleted or changed */
4783	goto invalid_write_loop_start;
4784	}
4785	} /* for */
4786	}
4787	}
4788	}
4789	}
4790	STAM_PROFILE_ADV_STOP(&pVM->patm.s.StatPatchWrite, a);
4791	return VINF_SUCCESS;
4792
4793	}
4794
4795	/**
4796	* Disable all patches in a flushed page
4797	*
4798	* @returns VBox status code
4799	* @param pVM The VM to operate on.
4800	* @param addr GC address of the page to flush
4801	*/
4802	/** @note Currently only called by CSAMR3FlushPage; optimization to avoid having to double check if the physical address has changed
4803	*/
4804	PATMR3DECL(int) PATMR3FlushPage(PVM pVM, RTGCPTR addr)
4805	{
4806	addr &= PAGE_BASE_GC_MASK;
4807
4808	PPATMPATCHPAGE pPatchPage = (PPATMPATCHPAGE)RTAvloGCPtrGet(&pVM->patm.s.PatchLookupTreeHC->PatchTreeByPage, addr);
4809	if (pPatchPage)
4810	{
4811	int i;
4812
4813	/* From top to bottom as the array is modified by PATMR3MarkDirtyPatch. */
4814	for (i=(int)pPatchPage->cCount-1;i>=0;i--)
4815	{
4816	if (pPatchPage->aPatch[i])
4817	{
4818	PPATCHINFO pPatch = pPatchPage->aPatch[i];
4819
4820	Log(("PATMR3FlushPage %VGv remove patch at %VGv\n", addr, pPatch->pPrivInstrGC));
4821	PATMR3MarkDirtyPatch(pVM, pPatch);
4822	}
4823	}
4824	STAM_COUNTER_INC(&pVM->patm.s.StatFlushed);
4825	}
4826	return VINF_SUCCESS;
4827	}
4828
4829	/**
4830	* Checks if the instructions at the specified address has been patched already.
4831	*
4832	* @returns boolean, patched or not
4833	* @param pVM The VM to operate on.
4834	* @param pInstrGC Guest context pointer to instruction
4835	*/
4836	PATMR3DECL(bool) PATMR3HasBeenPatched(PVM pVM, RTGCPTR pInstrGC)
4837	{
4838	PPATMPATCHREC pPatchRec;
4839	pPatchRec = (PPATMPATCHREC)RTAvloGCPtrGet(&pVM->patm.s.PatchLookupTreeHC->PatchTree, pInstrGC);
4840	if (pPatchRec && pPatchRec->patch.uState == PATCH_ENABLED)
4841	return true;
4842	return false;
4843	}
4844
4845	/**
4846	* Query the opcode of the original code that was overwritten by the 5 bytes patch jump
4847	*
4848	* @returns VBox status code.
4849	* @param pVM The VM to operate on.
4850	* @param pInstrGC GC address of instr
4851	* @param pByte opcode byte pointer (OUT)
4852	*
4853	*/
4854	PATMR3DECL(int) PATMR3QueryOpcode(PVM pVM, RTGCPTR pInstrGC, uint8_t *pByte)
4855	{
4856	PPATMPATCHREC pPatchRec;
4857
4858	/** @todo this will not work for aliased pages! (never has, but so far not a problem for us) */
4859
4860	/* Shortcut. */
4861	if ( !PATMIsEnabled(pVM)
4862	\|\| pInstrGC < pVM->patm.s.pPatchedInstrGCLowest
4863	\|\| pInstrGC > pVM->patm.s.pPatchedInstrGCHighest)
4864	{
4865	return VERR_PATCH_NOT_FOUND;
4866	}
4867
4868	pPatchRec = (PPATMPATCHREC)RTAvloGCPtrGetBestFit(&pVM->patm.s.PatchLookupTreeHC->PatchTree, pInstrGC, false);
4869	// if the patch is enabled and the pointer lies within 5 bytes of this priv instr ptr, then we've got a hit!
4870	if ( pPatchRec
4871	&& pPatchRec->patch.uState == PATCH_ENABLED
4872	&& pInstrGC >= pPatchRec->patch.pPrivInstrGC
4873	&& pInstrGC < pPatchRec->patch.pPrivInstrGC + pPatchRec->patch.cbPatchJump)
4874	{
4875	RTGCPTR offset = pInstrGC - pPatchRec->patch.pPrivInstrGC;
4876	*pByte = pPatchRec->patch.aPrivInstr[offset];
4877
4878	if (pPatchRec->patch.cbPatchJump == 1)
4879	{
4880	Log(("PATMR3QueryOpcode: returning opcode %2X for instruction at %VGv\n", *pByte, pInstrGC));
4881	}
4882	STAM_COUNTER_ADD(&pVM->patm.s.StatNrOpcodeRead, 1);
4883	return VINF_SUCCESS;
4884	}
4885	return VERR_PATCH_NOT_FOUND;
4886	}
4887
4888	/**
4889	* Disable patch for privileged instruction at specified location
4890	*
4891	* @returns VBox status code.
4892	* @param pVM The VM to operate on.
4893	* @param pInstr Guest context point to privileged instruction
4894	*
4895	* @note returns failure if patching is not allowed or possible
4896	*
4897	*/
4898	PATMR3DECL(int) PATMR3DisablePatch(PVM pVM, RTGCPTR pInstrGC)
4899	{
4900	PPATMPATCHREC pPatchRec;
4901	PPATCHINFO pPatch;
4902
4903	Log(("PATMR3DisablePatch: %VGv\n", pInstrGC));
4904	pPatchRec = (PPATMPATCHREC)RTAvloGCPtrGet(&pVM->patm.s.PatchLookupTreeHC->PatchTree, pInstrGC);
4905	if (pPatchRec)
4906	{
4907	int rc = VINF_SUCCESS;
4908
4909	pPatch = &pPatchRec->patch;
4910
4911	/* Already disabled? */
4912	if (pPatch->uState == PATCH_DISABLED)
4913	return VINF_SUCCESS;
4914
4915	/* Clear the IDT entries for the patch we're disabling. */
4916	/** @note very important as we clear IF in the patch itself */
4917	/** @todo this needs to be changed */
4918	if (pPatch->flags & PATMFL_IDTHANDLER)
4919	{
4920	uint32_t iGate;
4921
4922	iGate = TRPMR3QueryGateByHandler(pVM, PATCHCODE_PTR_GC(pPatch));
4923	if (iGate != (uint32_t)~0)
4924	{
4925	TRPMR3SetGuestTrapHandler(pVM, iGate, TRPM_INVALID_HANDLER);
4926	LogRel(("PATM: Disabling IDT %x patch handler %VGv\n", iGate, pInstrGC));
4927	}
4928	}
4929
4930	/* 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) */
4931	if ( pPatch->pPatchBlockOffset
4932	&& pPatch->uState == PATCH_ENABLED)
4933	{
4934	Log(("Invalidate patch at %VGv (HC=%VGv)\n", PATCHCODE_PTR_GC(pPatch), PATCHCODE_PTR_HC(pPatch)));
4935	pPatch->bDirtyOpcode = *PATCHCODE_PTR_HC(pPatch);
4936	*PATCHCODE_PTR_HC(pPatch) = 0xCC;
4937	}
4938
4939	/* IDT or function patches haven't changed any guest code. */
4940	if (pPatch->flags & PATMFL_PATCHED_GUEST_CODE)
4941	{
4942	Assert(pPatch->flags & PATMFL_MUST_INSTALL_PATCHJMP);
4943	Assert(!(pPatch->flags & (PATMFL_DUPLICATE_FUNCTION\|PATMFL_IDTHANDLER\|PATMFL_TRAMPOLINE\|PATMFL_INT3_REPLACEMENT\|PATMFL_INT3_REPLACEMENT_BLOCK)));
4944
4945	if (pPatch->uState != PATCH_REFUSED)
4946	{
4947	AssertMsg(pPatch->pPrivInstrHC, ("Invalid HC pointer?!? (%VGv)\n", pInstrGC));
4948	Assert(pPatch->cbPatchJump);
4949
4950	/** pPrivInstrHC is probably not valid anymore */
4951	rc = PGMPhysGCPtr2HCPtr(pVM, pPatchRec->patch.pPrivInstrGC, (PRTHCPTR)&pPatchRec->patch.pPrivInstrHC);
4952	if (rc == VINF_SUCCESS)
4953	{
4954	uint8_t temp[16];
4955
4956	Assert(pPatch->cbPatchJump < sizeof(temp));
4957
4958	/* Let's first check if the guest code is still the same. */
4959	rc = PGMPhysReadGCPtr(pVM, temp, pPatch->pPrivInstrGC, pPatch->cbPatchJump);
4960	Assert(rc == VINF_SUCCESS \|\| rc == VERR_PAGE_TABLE_NOT_PRESENT \|\| rc == VERR_PAGE_NOT_PRESENT);
4961	if (rc == VINF_SUCCESS)
4962	{
4963	RTGCINTPTR displ = (RTGCUINTPTR)PATCHCODE_PTR_GC(pPatch) - ((RTGCUINTPTR)pPatch->pPrivInstrGC + SIZEOF_NEARJUMP32);
4964
4965	if ( temp[0] != 0xE9 /* jmp opcode */
4966	\|\| (RTGCINTPTR )(&temp[1]) != displ
4967	)
4968	{
4969	Log(("PATMR3DisablePatch: Can't disable a patch who's guest code has changed!!\n"));
4970	STAM_COUNTER_INC(&pVM->patm.s.StatOverwritten);
4971	/* Remove it completely */
4972	pPatch->uState = PATCH_DISABLED; /* don't call PATMR3DisablePatch again */
4973	rc = PATMR3RemovePatch(pVM, pInstrGC);
4974	AssertRC(rc);
4975	return VWRN_PATCH_REMOVED;
4976	}
4977	}
4978	patmRemoveJumpToPatch(pVM, pPatch);
4979
4980	}
4981	else
4982	{
4983	Log(("PATMR3DisablePatch: unable to disable patch -> mark PATCH_DISABLE_PENDING\n"));
4984	pPatch->uState = PATCH_DISABLE_PENDING;
4985	}
4986	}
4987	else
4988	{
4989	AssertMsgFailed(("Patch was refused!\n"));
4990	return VERR_PATCH_ALREADY_DISABLED;
4991	}
4992	}
4993	else
4994	if (pPatch->flags & (PATMFL_INT3_REPLACEMENT\|PATMFL_INT3_REPLACEMENT_BLOCK))
4995	{
4996	uint8_t temp[16];
4997
4998	Assert(pPatch->cbPatchJump < sizeof(temp));
4999
5000	/* Let's first check if the guest code is still the same. */
5001	rc = PGMPhysReadGCPtr(pVM, temp, pPatch->pPrivInstrGC, pPatch->cbPatchJump);
5002	Assert(rc == VINF_SUCCESS \|\| rc == VERR_PAGE_TABLE_NOT_PRESENT \|\| rc == VERR_PAGE_NOT_PRESENT);
5003	if (rc == VINF_SUCCESS)
5004	{
5005	if (temp[0] != 0xCC)
5006	{
5007	Log(("PATMR3DisablePatch: Can't disable a patch who's guest code has changed!!\n"));
5008	STAM_COUNTER_INC(&pVM->patm.s.StatOverwritten);
5009	/* Remove it completely */
5010	pPatch->uState = PATCH_DISABLED; /* don't call PATMR3DisablePatch again */
5011	rc = PATMR3RemovePatch(pVM, pInstrGC);
5012	AssertRC(rc);
5013	return VWRN_PATCH_REMOVED;
5014	}
5015	patmDeactivateInt3Patch(pVM, pPatch);
5016	}
5017	}
5018
5019	if (rc == VINF_SUCCESS)
5020	{
5021	/* Save old state and mark this one as disabled (so it can be enabled later on). */
5022	if (pPatch->uState == PATCH_DISABLE_PENDING)
5023	{
5024	/* Just to be safe, let's make sure this one can never be reused; the patch might be marked dirty already (int3 at start) */
5025	pPatch->uState = PATCH_UNUSABLE;
5026	}
5027	else
5028	if (pPatch->uState != PATCH_DIRTY)
5029	{
5030	pPatch->uOldState = pPatch->uState;
5031	pPatch->uState = PATCH_DISABLED;
5032	}
5033	STAM_COUNTER_ADD(&pVM->patm.s.StatDisabled, 1);
5034	}
5035
5036	Log(("PATMR3DisablePatch: disabled patch at %VGv\n", pInstrGC));
5037	return VINF_SUCCESS;
5038	}
5039	Log(("Patch not found!\n"));
5040	return VERR_PATCH_NOT_FOUND;
5041	}
5042
5043	/**
5044	* Permanently disable patch for privileged instruction at specified location
5045	*
5046	* @returns VBox status code.
5047	* @param pVM The VM to operate on.
5048	* @param pInstr Guest context instruction pointer
5049	* @param pConflictAddr Guest context pointer which conflicts with specified patch
5050	* @param pConflictPatch Conflicting patch
5051	*
5052	*/
5053	static int patmDisableUnusablePatch(PVM pVM, RTGCPTR pInstrGC, RTGCPTR pConflictAddr, PPATCHINFO pConflictPatch)
5054	{
5055	#ifdef PATM_RESOLVE_CONFLICTS_WITH_JUMP_PATCHES
5056	PATCHINFO patch = {0};
5057	DISCPUSTATE cpu;
5058	HCPTRTYPE(uint8_t *) pInstrHC;
5059	uint32_t opsize;
5060	bool disret;
5061	int rc;
5062
5063	pInstrHC = PATMGCVirtToHCVirt(pVM, &patch, pInstrGC);
5064	cpu.mode = (pConflictPatch->flags & PATMFL_CODE32) ? CPUMODE_32BIT : CPUMODE_16BIT;
5065	disret = PATMR3DISInstr(pVM, &patch, &cpu, pInstrGC, pInstrHC, &opsize, NULL);
5066	/*
5067	* If it's a 5 byte relative jump, then we can work around the problem by replacing the 32 bits relative offset
5068	* with one that jumps right into the conflict patch.
5069	* Otherwise we must disable the conflicting patch to avoid serious problems.
5070	*/
5071	if ( disret == true
5072	&& (pConflictPatch->flags & PATMFL_CODE32)
5073	&& (cpu.pCurInstr->opcode == OP_JMP \|\| (cpu.pCurInstr->optype & OPTYPE_COND_CONTROLFLOW))
5074	&& (cpu.param1.flags & USE_IMMEDIATE32_REL))
5075	{
5076	/* Hint patches must be enabled first. */
5077	if (pConflictPatch->flags & PATMFL_INSTR_HINT)
5078	{
5079	Log(("Enabling HINTED patch %VGv\n", pConflictPatch->pPrivInstrGC));
5080	pConflictPatch->flags &= ~PATMFL_INSTR_HINT;
5081	rc = PATMR3EnablePatch(pVM, pConflictPatch->pPrivInstrGC);
5082	Assert(rc == VINF_SUCCESS \|\| rc == VERR_PATCH_NOT_FOUND);
5083	/* Enabling might fail if the patched code has changed in the meantime. */
5084	if (rc != VINF_SUCCESS)
5085	return rc;
5086	}
5087
5088	rc = PATMR3InstallPatch(pVM, pInstrGC, PATMFL_CODE32 \| PATMFL_JUMP_CONFLICT);
5089	if (VBOX_SUCCESS(rc))
5090	{
5091	Log(("PATM -> CONFLICT: Installed JMP patch for patch conflict at %VGv\n", pInstrGC));
5092	STAM_COUNTER_INC(&pVM->patm.s.StatFixedConflicts);
5093	return VINF_SUCCESS;
5094	}
5095	}
5096	#endif
5097
5098	if (pConflictPatch->opcode == OP_CLI)
5099	{
5100	/* Turn it into an int3 patch; our GC trap handler will call the generated code manually. */
5101	Log(("PATM -> CONFLICT: Found active patch at instruction %VGv with target %VGv -> turn into int 3 patch!!\n", pInstrGC, pConflictPatch->pPrivInstrGC));
5102	int rc = PATMR3DisablePatch(pVM, pConflictPatch->pPrivInstrGC);
5103	if (rc == VWRN_PATCH_REMOVED)
5104	return VINF_SUCCESS;
5105	if (VBOX_SUCCESS(rc))
5106	{
5107	pConflictPatch->flags &= ~(PATMFL_MUST_INSTALL_PATCHJMP\|PATMFL_INSTR_HINT);
5108	pConflictPatch->flags \|= PATMFL_INT3_REPLACEMENT_BLOCK;
5109	rc = PATMR3EnablePatch(pVM, pConflictPatch->pPrivInstrGC);
5110	if (rc == VERR_PATCH_NOT_FOUND)
5111	return VINF_SUCCESS; /* removed already */
5112
5113	AssertRC(rc);
5114	if (VBOX_SUCCESS(rc))
5115	{
5116	STAM_COUNTER_INC(&pVM->patm.s.StatInt3Callable);
5117	return VINF_SUCCESS;
5118	}
5119	}
5120	/* else turned into unusable patch (see below) */
5121	}
5122	else
5123	{
5124	Log(("PATM -> CONFLICT: Found active patch at instruction %VGv with target %VGv -> DISABLING it!!\n", pInstrGC, pConflictPatch->pPrivInstrGC));
5125	int rc = PATMR3DisablePatch(pVM, pConflictPatch->pPrivInstrGC);
5126	if (rc == VWRN_PATCH_REMOVED)
5127	return VINF_SUCCESS;
5128	}
5129
5130	/* No need to monitor the code anymore. */
5131	if (pConflictPatch->flags & PATMFL_CODE_MONITORED)
5132	{
5133	int rc = patmRemovePatchPages(pVM, pConflictPatch);
5134	AssertRC(rc);
5135	}
5136	pConflictPatch->uState = PATCH_UNUSABLE;
5137	STAM_COUNTER_INC(&pVM->patm.s.StatUnusable);
5138	return VERR_PATCH_DISABLED;
5139	}
5140
5141	/**
5142	* Enable patch for privileged instruction at specified location
5143	*
5144	* @returns VBox status code.
5145	* @param pVM The VM to operate on.
5146	* @param pInstr Guest context point to privileged instruction
5147	*
5148	* @note returns failure if patching is not allowed or possible
5149	*
5150	*/
5151	PATMR3DECL(int) PATMR3EnablePatch(PVM pVM, RTGCPTR pInstrGC)
5152	{
5153	PPATMPATCHREC pPatchRec;
5154	PPATCHINFO pPatch;
5155
5156	Log(("PATMR3EnablePatch %VGv\n", pInstrGC));
5157	pPatchRec = (PPATMPATCHREC)RTAvloGCPtrGet(&pVM->patm.s.PatchLookupTreeHC->PatchTree, pInstrGC);
5158	if (pPatchRec)
5159	{
5160	int rc = VINF_SUCCESS;
5161
5162	pPatch = &pPatchRec->patch;
5163
5164	if (pPatch->uState == PATCH_DISABLED)
5165	{
5166	if (pPatch->flags & PATMFL_MUST_INSTALL_PATCHJMP)
5167	{
5168	Assert(!(pPatch->flags & PATMFL_PATCHED_GUEST_CODE));
5169	/** @todo -> pPrivInstrHC is probably not valid anymore */
5170	rc = PGMPhysGCPtr2HCPtr(pVM, pPatchRec->patch.pPrivInstrGC, (PRTHCPTR)&pPatchRec->patch.pPrivInstrHC);
5171	if (rc == VINF_SUCCESS)
5172	{
5173	#ifdef DEBUG
5174	DISCPUSTATE cpu;
5175	char szOutput[256];
5176	uint32_t opsize, i = 0;
5177	#endif
5178	uint8_t temp[16];
5179
5180	Assert(pPatch->cbPatchJump < sizeof(temp));
5181
5182	// let's first check if the guest code is still the same
5183	int rc = PGMPhysReadGCPtr(pVM, temp, pPatch->pPrivInstrGC, pPatch->cbPatchJump);
5184	AssertRC(rc);
5185
5186	if (memcmp(temp, pPatch->aPrivInstr, pPatch->cbPatchJump))
5187	{
5188	Log(("PATMR3EnablePatch: Can't enable a patch who's guest code has changed!!\n"));
5189	STAM_COUNTER_INC(&pVM->patm.s.StatOverwritten);
5190	/* Remove it completely */
5191	PATMR3RemovePatch(pVM, pInstrGC);
5192	return VERR_PATCH_NOT_FOUND;
5193	}
5194
5195	rc = patmGenJumpToPatch(pVM, pPatch, false);
5196	AssertRC(rc);
5197	if (VBOX_FAILURE(rc))
5198	return rc;
5199
5200	#ifdef DEBUG
5201	bool disret;
5202	i = 0;
5203	while(i < pPatch->cbPatchJump)
5204	{
5205	cpu.mode = (pPatch->flags & PATMFL_CODE32) ? CPUMODE_32BIT : CPUMODE_16BIT;
5206	disret = PATMR3DISInstr(pVM, pPatch, &cpu, pPatch->pPrivInstrGC + i, &pPatch->pPrivInstrHC[i], &opsize, szOutput);
5207	Log(("Renewed patch instr: %s", szOutput));
5208	i += opsize;
5209	}
5210	#endif
5211	}
5212	}
5213	else
5214	if (pPatch->flags & (PATMFL_INT3_REPLACEMENT\|PATMFL_INT3_REPLACEMENT_BLOCK))
5215	{
5216	uint8_t temp[16];
5217
5218	Assert(pPatch->cbPatchJump < sizeof(temp));
5219
5220	/* Let's first check if the guest code is still the same. */
5221	int rc = PGMPhysReadGCPtr(pVM, temp, pPatch->pPrivInstrGC, pPatch->cbPatchJump);
5222	AssertRC(rc);
5223
5224	if (memcmp(temp, pPatch->aPrivInstr, pPatch->cbPatchJump))
5225	{
5226	Log(("PATMR3EnablePatch: Can't enable a patch who's guest code has changed!!\n"));
5227	STAM_COUNTER_INC(&pVM->patm.s.StatOverwritten);
5228	PATMR3RemovePatch(pVM, pInstrGC);
5229	return VERR_PATCH_NOT_FOUND;
5230	}
5231
5232	rc = patmActivateInt3Patch(pVM, pPatch);
5233	if (VBOX_FAILURE(rc))
5234	return rc;
5235	}
5236
5237	pPatch->uState = pPatch->uOldState; //restore state
5238
5239	/* Restore the entry breakpoint with the original opcode (see PATMR3DisablePatch). */
5240	if (pPatch->pPatchBlockOffset)
5241	{
5242	*PATCHCODE_PTR_HC(pPatch) = pPatch->bDirtyOpcode;
5243	}
5244
5245	STAM_COUNTER_ADD(&pVM->patm.s.StatEnabled, 1);
5246	}
5247	else
5248	Log(("PATMR3EnablePatch: Unable to enable patch %VGv with state %d\n", pInstrGC, pPatch->uState));
5249
5250	return rc;
5251	}
5252	return VERR_PATCH_NOT_FOUND;
5253	}
5254
5255	/**
5256	* Remove patch for privileged instruction at specified location
5257	*
5258	* @returns VBox status code.
5259	* @param pVM The VM to operate on.
5260	* @param pPatchRec Patch record
5261	* @param fForceRemove Remove all patches
5262	*/
5263	int PATMRemovePatch(PVM pVM, PPATMPATCHREC pPatchRec, bool fForceRemove)
5264	{
5265	PPATCHINFO pPatch;
5266
5267	pPatch = &pPatchRec->patch;
5268
5269	/* Strictly forbidden to remove such patches. There can be dependencies!! */
5270	AssertReturn(fForceRemove \|\| !(pPatch->flags & (PATMFL_DUPLICATE_FUNCTION)), VERR_ACCESS_DENIED);
5271
5272	/** @note NEVER EVER REUSE PATCH MEMORY */
5273	/** @note PATMR3DisablePatch put a breakpoint (0xCC) at the entry of this patch */
5274
5275	if (pPatchRec->patch.pPatchBlockOffset)
5276	{
5277	PAVLOGCPTRNODECORE pNode;
5278
5279	pNode = RTAvloGCPtrRemove(&pVM->patm.s.PatchLookupTreeHC->PatchTreeByPatchAddr, pPatchRec->patch.pPatchBlockOffset);
5280	Assert(pNode);
5281	}
5282
5283	if (pPatchRec->patch.flags & PATMFL_CODE_MONITORED)
5284	{
5285	int rc = patmRemovePatchPages(pVM, &pPatchRec->patch);
5286	AssertRC(rc);
5287	}
5288
5289	#ifdef VBOX_WITH_STATISTICS
5290	if (PATM_STAT_INDEX_IS_VALID(pPatchRec->patch.uPatchIdx))
5291	{
5292	STAMR3Deregister(pVM, &pPatchRec->patch);
5293	#ifndef DEBUG_sandervl
5294	STAMR3Deregister(pVM, &pVM->patm.s.pStatsHC[pPatchRec->patch.uPatchIdx]);
5295	STAMR3Deregister(pVM, &pPatchRec->patch.cbPatchBlockSize);
5296	STAMR3Deregister(pVM, &pPatchRec->patch.cbPatchJump);
5297	STAMR3Deregister(pVM, &pPatchRec->patch.cbPrivInstr);
5298	STAMR3Deregister(pVM, &pPatchRec->patch.cCodeWrites);
5299	STAMR3Deregister(pVM, &pPatchRec->patch.cInvalidWrites);
5300	STAMR3Deregister(pVM, &pPatchRec->patch.cTraps);
5301	STAMR3Deregister(pVM, &pPatchRec->patch.flags);
5302	STAMR3Deregister(pVM, &pPatchRec->patch.nrJumpRecs);
5303	STAMR3Deregister(pVM, &pPatchRec->patch.nrFixups);
5304	STAMR3Deregister(pVM, &pPatchRec->patch.opcode);
5305	STAMR3Deregister(pVM, &pPatchRec->patch.uState);
5306	STAMR3Deregister(pVM, &pPatchRec->patch.uOldState);
5307	STAMR3Deregister(pVM, &pPatchRec->patch.uOpMode);
5308	#endif
5309	}
5310	#endif
5311
5312	/** @note no need to free Guest2PatchAddrTree as those records share memory with Patch2GuestAddrTree records. */
5313	patmEmptyTreeU32(pVM, &pPatch->Patch2GuestAddrTree);
5314	pPatch->nrPatch2GuestRecs = 0;
5315	Assert(pPatch->Patch2GuestAddrTree == 0);
5316
5317	patmEmptyTree(pVM, &pPatch->FixupTree);
5318	pPatch->nrFixups = 0;
5319	Assert(pPatch->FixupTree == 0);
5320
5321	if (pPatchRec->patch.pTempInfo)
5322	MMR3HeapFree(pPatchRec->patch.pTempInfo);
5323
5324	/** @note might fail, because it has already been removed (e.g. during reset). */
5325	RTAvloGCPtrRemove(&pVM->patm.s.PatchLookupTreeHC->PatchTree, pPatchRec->Core.Key);
5326
5327	/* Free the patch record */
5328	MMHyperFree(pVM, pPatchRec);
5329	return VINF_SUCCESS;
5330	}
5331
5332	/**
5333	* Attempt to refresh the patch by recompiling its entire code block
5334	*
5335	* @returns VBox status code.
5336	* @param pVM The VM to operate on.
5337	* @param pPatchRec Patch record
5338	*/
5339	int patmR3RefreshPatch(PVM pVM, PPATMPATCHREC pPatchRec)
5340	{
5341	PPATCHINFO pPatch;
5342	int rc;
5343	RTGCPTR pInstrGC = pPatchRec->patch.pPrivInstrGC;
5344
5345	Log(("patmR3RefreshPatch: attempt to refresh patch at %VGv\n", pInstrGC));
5346
5347	pPatch = &pPatchRec->patch;
5348	AssertReturn(pPatch->flags & (PATMFL_DUPLICATE_FUNCTION\|PATMFL_IDTHANDLER\|PATMFL_TRAPHANDLER), VERR_PATCHING_REFUSED);
5349	AssertReturn(!(pPatch->flags & PATMFL_EXTERNAL_JUMP_INSIDE), VERR_PATCHING_REFUSED);
5350
5351	/** Note: quite ugly to enable/disable/remove/insert old and new patches, but there's no easy way around it. */
5352
5353	rc = PATMR3DisablePatch(pVM, pInstrGC);
5354	AssertRC(rc);
5355
5356	/** Kick it out of the lookup tree to make sure PATMR3InstallPatch doesn't fail (hack alert) */
5357	RTAvloGCPtrRemove(&pVM->patm.s.PatchLookupTreeHC->PatchTree, pPatchRec->Core.Key);
5358	#ifdef VBOX_WITH_STATISTICS
5359	if (PATM_STAT_INDEX_IS_VALID(pPatchRec->patch.uPatchIdx))
5360	{
5361	STAMR3Deregister(pVM, &pPatchRec->patch);
5362	#ifndef DEBUG_sandervl
5363	STAMR3Deregister(pVM, &pVM->patm.s.pStatsHC[pPatchRec->patch.uPatchIdx]);
5364	STAMR3Deregister(pVM, &pPatchRec->patch.cbPatchBlockSize);
5365	STAMR3Deregister(pVM, &pPatchRec->patch.cbPatchJump);
5366	STAMR3Deregister(pVM, &pPatchRec->patch.cbPrivInstr);
5367	STAMR3Deregister(pVM, &pPatchRec->patch.cCodeWrites);
5368	STAMR3Deregister(pVM, &pPatchRec->patch.cInvalidWrites);
5369	STAMR3Deregister(pVM, &pPatchRec->patch.cTraps);
5370	STAMR3Deregister(pVM, &pPatchRec->patch.flags);
5371	STAMR3Deregister(pVM, &pPatchRec->patch.nrJumpRecs);
5372	STAMR3Deregister(pVM, &pPatchRec->patch.nrFixups);
5373	STAMR3Deregister(pVM, &pPatchRec->patch.opcode);
5374	STAMR3Deregister(pVM, &pPatchRec->patch.uState);
5375	STAMR3Deregister(pVM, &pPatchRec->patch.uOldState);
5376	STAMR3Deregister(pVM, &pPatchRec->patch.uOpMode);
5377	#endif
5378	}
5379	#endif
5380
5381	/** Note: We don't attempt to reuse patch memory here as it's quite common that the new code block requires more memory. */
5382
5383	/* Attempt to install a new patch. */
5384	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));
5385	if (VBOX_SUCCESS(rc))
5386	{
5387	RTGCPTR pPatchTargetGC;
5388	PPATMPATCHREC pNewPatchRec;
5389
5390	/* Determine target address in new patch */
5391	pPatchTargetGC = PATMR3QueryPatchGCPtr(pVM, pInstrGC);
5392	Assert(pPatchTargetGC);
5393	if (!pPatchTargetGC)
5394	{
5395	rc = VERR_PATCHING_REFUSED;
5396	goto failure;
5397	}
5398
5399	/* Reset offset into patch memory to put the next code blocks right at the beginning. */
5400	pPatch->uCurPatchOffset = 0;
5401
5402	/* insert jump to new patch in old patch block */
5403	rc = patmPatchGenPatchJump(pVM, pPatch, pInstrGC, pPatchTargetGC, false /* no lookup record */);
5404	if (VBOX_FAILURE(rc))
5405	goto failure;
5406
5407	pNewPatchRec = (PPATMPATCHREC)RTAvloGCPtrGet(&pVM->patm.s.PatchLookupTreeHC->PatchTree, pInstrGC);
5408	Assert(pNewPatchRec); /* can't fail */
5409
5410	/* Remove old patch (only do that when everything is finished) */
5411	int rc2 = PATMRemovePatch(pVM, pPatchRec, true /* force removal */);
5412	AssertRC(rc2);
5413
5414	/* Put the new patch back into the tree, because removing the old one kicked this one out. (hack alert) */
5415	RTAvloGCPtrInsert(&pVM->patm.s.PatchLookupTreeHC->PatchTree, &pNewPatchRec->Core);
5416
5417	LogRel(("PATM: patmR3RefreshPatch: succeeded to refresh patch at %VGv \n", pInstrGC));
5418	STAM_COUNTER_INC(&pVM->patm.s.StatPatchRefreshSuccess);
5419	}
5420
5421	failure:
5422	if (VBOX_FAILURE(rc))
5423	{
5424	LogRel(("PATM: patmR3RefreshPatch: failed to refresh patch at %VGv. Reactiving old one. \n", pInstrGC));
5425
5426	/* Remove the new inactive patch */
5427	rc = PATMR3RemovePatch(pVM, pInstrGC);
5428	AssertRC(rc);
5429
5430	/* Put the old patch back into the tree (or else it won't be saved) (hack alert) */
5431	RTAvloGCPtrInsert(&pVM->patm.s.PatchLookupTreeHC->PatchTree, &pPatchRec->Core);
5432
5433	/* Enable again in case the dirty instruction is near the end and there are safe code paths. */
5434	int rc2 = PATMR3EnablePatch(pVM, pInstrGC);
5435	AssertRC(rc2);
5436
5437	STAM_COUNTER_INC(&pVM->patm.s.StatPatchRefreshFailed);
5438	}
5439	return rc;
5440	}
5441
5442	/**
5443	* Find patch for privileged instruction at specified location
5444	*
5445	* @returns Patch structure pointer if found; else NULL
5446	* @param pVM The VM to operate on.
5447	* @param pInstr Guest context point to instruction that might lie within 5 bytes of an existing patch jump
5448	* @param fIncludeHints Include hinted patches or not
5449	*
5450	*/
5451	PPATCHINFO PATMFindActivePatchByEntrypoint(PVM pVM, RTGCPTR pInstrGC, bool fIncludeHints)
5452	{
5453	PPATMPATCHREC pPatchRec = (PPATMPATCHREC)RTAvloGCPtrGetBestFit(&pVM->patm.s.PatchLookupTreeHC->PatchTree, pInstrGC, false);
5454	/* 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! */
5455	if (pPatchRec)
5456	{
5457	if ( pPatchRec->patch.uState == PATCH_ENABLED
5458	&& (pPatchRec->patch.flags & PATMFL_PATCHED_GUEST_CODE)
5459	&& pInstrGC > pPatchRec->patch.pPrivInstrGC
5460	&& pInstrGC < pPatchRec->patch.pPrivInstrGC + pPatchRec->patch.cbPatchJump)
5461	{
5462	Log(("Found active patch at %VGv (org %VGv)\n", pInstrGC, pPatchRec->patch.pPrivInstrGC));
5463	return &pPatchRec->patch;
5464	}
5465	else
5466	if ( fIncludeHints
5467	&& pPatchRec->patch.uState == PATCH_DISABLED
5468	&& (pPatchRec->patch.flags & PATMFL_INSTR_HINT)
5469	&& pInstrGC > pPatchRec->patch.pPrivInstrGC
5470	&& pInstrGC < pPatchRec->patch.pPrivInstrGC + pPatchRec->patch.cbPatchJump)
5471	{
5472	Log(("Found HINT patch at %VGv (org %VGv)\n", pInstrGC, pPatchRec->patch.pPrivInstrGC));
5473	return &pPatchRec->patch;
5474	}
5475	}
5476	return NULL;
5477	}
5478
5479	/**
5480	* Checks whether the GC address is inside a generated patch jump
5481	*
5482	* @returns true -> yes, false -> no
5483	* @param pVM The VM to operate on.
5484	* @param pAddr Guest context address
5485	* @param pPatchAddr Guest context patch address (if true)
5486	*/
5487	PATMR3DECL(bool) PATMR3IsInsidePatchJump(PVM pVM, RTGCPTR pAddr, PRTGCPTR pPatchAddr)
5488	{
5489	RTGCPTR addr;
5490	PPATCHINFO pPatch;
5491
5492	if (PATMIsEnabled(pVM) == false)
5493	return false;
5494
5495	if (pPatchAddr == NULL)
5496	pPatchAddr = &addr;
5497
5498	*pPatchAddr = 0;
5499
5500	pPatch = PATMFindActivePatchByEntrypoint(pVM, pAddr);
5501	if (pPatch)
5502	{
5503	*pPatchAddr = pPatch->pPrivInstrGC;
5504	}
5505	return *pPatchAddr == 0 ? false : true;
5506	}
5507
5508	/**
5509	* Remove patch for privileged instruction at specified location
5510	*
5511	* @returns VBox status code.
5512	* @param pVM The VM to operate on.
5513	* @param pInstr Guest context point to privileged instruction
5514	*
5515	* @note returns failure if patching is not allowed or possible
5516	*
5517	*/
5518	PATMR3DECL(int) PATMR3RemovePatch(PVM pVM, RTGCPTR pInstrGC)
5519	{
5520	PPATMPATCHREC pPatchRec;
5521
5522	pPatchRec = (PPATMPATCHREC)RTAvloGCPtrGet(&pVM->patm.s.PatchLookupTreeHC->PatchTree, pInstrGC);
5523	if (pPatchRec)
5524	{
5525	int rc = PATMR3DisablePatch(pVM, pInstrGC);
5526	if (rc == VWRN_PATCH_REMOVED)
5527	return VINF_SUCCESS;
5528	return PATMRemovePatch(pVM, pPatchRec, false);
5529	}
5530	AssertFailed();
5531	return VERR_PATCH_NOT_FOUND;
5532	}
5533
5534	/**
5535	* Mark patch as dirty
5536	*
5537	* @returns VBox status code.
5538	* @param pVM The VM to operate on.
5539	* @param pPatch Patch record
5540	*
5541	* @note returns failure if patching is not allowed or possible
5542	*
5543	*/
5544	PATMR3DECL(int) PATMR3MarkDirtyPatch(PVM pVM, PPATCHINFO pPatch)
5545	{
5546	if (pPatch->pPatchBlockOffset)
5547	{
5548	Log(("Invalidate patch at %VGv (HC=%VGv)\n", PATCHCODE_PTR_GC(pPatch), PATCHCODE_PTR_HC(pPatch)));
5549	pPatch->bDirtyOpcode = *PATCHCODE_PTR_HC(pPatch);
5550	*PATCHCODE_PTR_HC(pPatch) = 0xCC;
5551	}
5552
5553	STAM_COUNTER_INC(&pVM->patm.s.StatDirty);
5554	/* Put back the replaced instruction. */
5555	int rc = PATMR3DisablePatch(pVM, pPatch->pPrivInstrGC);
5556	if (rc == VWRN_PATCH_REMOVED)
5557	return VINF_SUCCESS;
5558
5559	/** @note we don't restore patch pages for patches that are not enabled! */
5560	/** @note be careful when changing this behaviour!! */
5561
5562	/* The patch pages are no longer marked for self-modifying code detection */
5563	if (pPatch->flags & PATMFL_CODE_MONITORED)
5564	{
5565	int rc = patmRemovePatchPages(pVM, pPatch);
5566	AssertRCReturn(rc, rc);
5567	}
5568	pPatch->uState = PATCH_DIRTY;
5569
5570	/* Paranoia; make sure this patch is not somewhere in the callchain, so prevent ret instructions from succeeding. */
5571	CTXSUFF(pVM->patm.s.pGCState)->Psp = PATM_STACK_SIZE;
5572
5573	return VINF_SUCCESS;
5574	}
5575
5576	/**
5577	* Query the corresponding GC instruction pointer from a pointer inside the patch block itself
5578	*
5579	* @returns VBox status code.
5580	* @param pVM The VM to operate on.
5581	* @param pPatch Patch block structure pointer
5582	* @param pPatchGC GC address in patch block
5583	*/
5584	RTGCPTR patmPatchGCPtr2GuestGCPtr(PVM pVM, PPATCHINFO pPatch, GCPTRTYPE(uint8_t *) pPatchGC)
5585	{
5586	Assert(pPatch->Patch2GuestAddrTree);
5587	/* Get the closest record from below. */
5588	PRECPATCHTOGUEST pPatchToGuestRec = (PRECPATCHTOGUEST)RTAvlU32GetBestFit(&pPatch->Patch2GuestAddrTree, pPatchGC - pVM->patm.s.pPatchMemGC, false);
5589	if (pPatchToGuestRec)
5590	return pPatchToGuestRec->pOrgInstrGC;
5591
5592	return 0;
5593	}
5594
5595	/* Converts Guest code GC ptr to Patch code GC ptr (if found)
5596	*
5597	* @returns corresponding GC pointer in patch block
5598	* @param pVM The VM to operate on.
5599	* @param pPatch Current patch block pointer
5600	* @param pInstrGC Guest context pointer to privileged instruction
5601	*
5602	*/
5603	RTGCPTR patmGuestGCPtrToPatchGCPtr(PVM pVM, PPATCHINFO pPatch, GCPTRTYPE(uint8_t*) pInstrGC)
5604	{
5605	if (pPatch->Guest2PatchAddrTree)
5606	{
5607	PRECGUESTTOPATCH pGuestToPatchRec = (PRECGUESTTOPATCH)RTAvlGCPtrGet(&pPatch->Guest2PatchAddrTree, pInstrGC);
5608	if (pGuestToPatchRec)
5609	return pVM->patm.s.pPatchMemGC + pGuestToPatchRec->PatchOffset;
5610	}
5611
5612	return 0;
5613	}
5614
5615	/* Converts Guest code GC ptr to Patch code GC ptr (if found)
5616	*
5617	* @returns corresponding GC pointer in patch block
5618	* @param pVM The VM to operate on.
5619	* @param pInstrGC Guest context pointer to privileged instruction
5620	*
5621	*/
5622	PATMR3DECL(RTGCPTR) PATMR3GuestGCPtrToPatchGCPtr(PVM pVM, GCPTRTYPE(uint8_t*)pInstrGC)
5623	{
5624	PPATMPATCHREC pPatchRec = (PPATMPATCHREC)RTAvloGCPtrGetBestFit(&pVM->patm.s.PatchLookupTreeHC->PatchTree, pInstrGC, false);
5625	if (pPatchRec && pPatchRec->patch.uState == PATCH_ENABLED && pInstrGC >= pPatchRec->patch.pPrivInstrGC)
5626	{
5627	return patmGuestGCPtrToPatchGCPtr(pVM, &pPatchRec->patch, pInstrGC);
5628	}
5629	return 0;
5630	}
5631
5632	/**
5633	* Query the corresponding GC instruction pointer from a pointer inside the patch block itself
5634	*
5635	* @returns original GC instruction pointer or 0 if not found
5636	* @param pVM The VM to operate on.
5637	* @param pPatchGC GC address in patch block
5638	* @param pEnmState State of the translated address (out)
5639	*
5640	*/
5641	PATMR3DECL(RTGCPTR) PATMR3PatchToGCPtr(PVM pVM, RTGCPTR pPatchGC, PATMTRANSSTATE *pEnmState)
5642	{
5643	PPATMPATCHREC pPatchRec;
5644	void *pvPatchCoreOffset;
5645	RTGCPTR pPrivInstrGC;
5646
5647	Assert(PATMIsPatchGCAddr(pVM, pPatchGC));
5648	pvPatchCoreOffset = RTAvloGCPtrGetBestFit(&pVM->patm.s.PatchLookupTreeHC->PatchTreeByPatchAddr, pPatchGC - pVM->patm.s.pPatchMemGC, false);
5649	if (pvPatchCoreOffset == 0)
5650	{
5651	Log(("PATMR3PatchToGCPtr failed for %VGv offset %x\n", pPatchGC, pPatchGC - pVM->patm.s.pPatchMemGC));
5652	return 0;
5653	}
5654	pPatchRec = PATM_PATCHREC_FROM_COREOFFSET(pvPatchCoreOffset);
5655	pPrivInstrGC = patmPatchGCPtr2GuestGCPtr(pVM, &pPatchRec->patch, pPatchGC);
5656	if (pEnmState)
5657	{
5658	AssertMsg(pPrivInstrGC && ( pPatchRec->patch.uState == PATCH_ENABLED
5659	\|\| pPatchRec->patch.uState == PATCH_DIRTY
5660	\|\| pPatchRec->patch.uState == PATCH_DISABLE_PENDING
5661	\|\| pPatchRec->patch.uState == PATCH_UNUSABLE),
5662	("pPrivInstrGC=%VGv uState=%d\n", pPrivInstrGC, pPatchRec->patch.uState));
5663
5664	if ( !pPrivInstrGC
5665	\|\| pPatchRec->patch.uState == PATCH_UNUSABLE
5666	\|\| pPatchRec->patch.uState == PATCH_REFUSED)
5667	{
5668	pPrivInstrGC = 0;
5669	*pEnmState = PATMTRANS_FAILED;
5670	}
5671	else
5672	if (pVM->patm.s.pGCStateHC->GCPtrInhibitInterrupts == pPrivInstrGC)
5673	{
5674	*pEnmState = PATMTRANS_INHIBITIRQ;
5675	}
5676	else
5677	if ( pPatchRec->patch.uState == PATCH_ENABLED
5678	&& !(pPatchRec->patch.flags & (PATMFL_DUPLICATE_FUNCTION\|PATMFL_IDTHANDLER\|PATMFL_TRAMPOLINE))
5679	&& pPrivInstrGC > pPatchRec->patch.pPrivInstrGC
5680	&& pPrivInstrGC < pPatchRec->patch.pPrivInstrGC + pPatchRec->patch.cbPatchJump)
5681	{
5682	*pEnmState = PATMTRANS_OVERWRITTEN;
5683	}
5684	else
5685	if (PATMFindActivePatchByEntrypoint(pVM, pPrivInstrGC))
5686	{
5687	*pEnmState = PATMTRANS_OVERWRITTEN;
5688	}
5689	else
5690	if (pPrivInstrGC == pPatchRec->patch.pPrivInstrGC)
5691	{
5692	*pEnmState = PATMTRANS_PATCHSTART;
5693	}
5694	else
5695	*pEnmState = PATMTRANS_SAFE;
5696	}
5697	return pPrivInstrGC;
5698	}
5699
5700	/**
5701	* Returns the GC pointer of the patch for the specified GC address
5702	*
5703	* @returns VBox status code.
5704	* @param pVM The VM to operate on.
5705	* @param pAddrGC Guest context address
5706	*/
5707	PATMR3DECL(RTGCPTR) PATMR3QueryPatchGCPtr(PVM pVM, RTGCPTR pAddrGC)
5708	{
5709	PPATMPATCHREC pPatchRec;
5710
5711	// Find the patch record
5712	pPatchRec = (PPATMPATCHREC)RTAvloGCPtrGet(&pVM->patm.s.PatchLookupTreeHC->PatchTree, pAddrGC);
5713	/** @todo we should only use patches that are enabled! always did this, but it's incorrect! */
5714	if (pPatchRec && (pPatchRec->patch.uState == PATCH_ENABLED \|\| pPatchRec->patch.uState == PATCH_DIRTY))
5715	return PATCHCODE_PTR_GC(&pPatchRec->patch);
5716
5717	return 0;
5718	}
5719
5720	/**
5721	* Attempt to recover dirty instructions
5722	*
5723	* @returns VBox status code.
5724	* @param pVM The VM to operate on.
5725	* @param pCtx CPU context
5726	* @param pPatch Patch record
5727	* @param pPatchToGuestRec Patch to guest address record
5728	* @param pEip GC pointer of trapping instruction
5729	*/
5730	static int patmR3HandleDirtyInstr(PVM pVM, PCPUMCTX pCtx, PPATMPATCHREC pPatch, PRECPATCHTOGUEST pPatchToGuestRec, RTGCPTR pEip)
5731	{
5732	DISCPUSTATE CpuOld, CpuNew;
5733	uint8_t pPatchInstrHC, pCurPatchInstrHC;
5734	int rc;
5735	RTGCPTR pCurInstrGC, pCurPatchInstrGC;
5736	uint32_t cbDirty;
5737	PRECPATCHTOGUEST pRec;
5738
5739	Log(("patmR3HandleDirtyInstr: dirty instruction at %VGv (%VGv)\n", pEip, pPatchToGuestRec->pOrgInstrGC));
5740
5741	pRec = pPatchToGuestRec;
5742	pCurInstrGC = pPatchToGuestRec->pOrgInstrGC;
5743	pCurPatchInstrGC = pEip;
5744	cbDirty = 0;
5745	pPatchInstrHC = patmPatchGCPtr2PatchHCPtr(pVM, pCurPatchInstrGC);
5746
5747	/* Find all adjacent dirty instructions */
5748	while (true)
5749	{
5750	if (pRec->fJumpTarget)
5751	{
5752	LogRel(("PATM: patmR3HandleDirtyInstr: dirty instruction at %VGv (%VGv) ignored, because instruction in function was reused as target of jump\n", pEip, pPatchToGuestRec->pOrgInstrGC));
5753	pRec->fDirty = false;
5754	return VERR_PATCHING_REFUSED;
5755	}
5756
5757	/* Restore original instruction opcode byte so we can check if the write was indeed safe. */
5758	pCurPatchInstrHC = patmPatchGCPtr2PatchHCPtr(pVM, pCurPatchInstrGC);
5759	*pCurPatchInstrHC = pRec->u8DirtyOpcode;
5760
5761	/* Only harmless instructions are acceptable. */
5762	rc = CPUMR3DisasmInstrCPU(pVM, pCtx, pCurPatchInstrGC, &CpuOld, 0);
5763	if ( VBOX_FAILURE(rc)
5764	\|\| !(CpuOld.pCurInstr->optype & OPTYPE_HARMLESS))
5765	break;
5766
5767	#ifdef DEBUG
5768	char szBuf[256];
5769	szBuf[0] = '\0';
5770	DBGFR3DisasInstr(pVM, pCtx->cs, pCurPatchInstrGC, szBuf, sizeof(szBuf));
5771	Log(("DIRTY: %s\n", szBuf));
5772	#endif
5773	/** Remove old lookup record. */
5774	patmr3RemoveP2GLookupRecord(pVM, &pPatch->patch, pCurPatchInstrGC);
5775
5776	pCurPatchInstrGC += CpuOld.opsize;
5777	cbDirty += CpuOld.opsize;
5778
5779	/* Mark as clean; if we fail we'll let it always fault. */
5780	pRec->fDirty = false;
5781
5782	/* Let's see if there's another dirty instruction right after. */
5783	pRec = (PRECPATCHTOGUEST)RTAvlU32GetBestFit(&pPatch->patch.Patch2GuestAddrTree, pCurPatchInstrGC - pVM->patm.s.pPatchMemGC, true);
5784	if (!pRec \|\| !pRec->fDirty)
5785	break; /* no more dirty instructions */
5786	}
5787
5788	if ( VBOX_SUCCESS(rc)
5789	&& (CpuOld.pCurInstr->optype & OPTYPE_HARMLESS)
5790	)
5791	{
5792	uint32_t cbLeft;
5793
5794	pCurPatchInstrHC = pPatchInstrHC;
5795	pCurPatchInstrGC = pEip;
5796	cbLeft = cbDirty;
5797
5798	while (cbLeft && VBOX_SUCCESS(rc))
5799	{
5800	bool fValidInstr;
5801
5802	rc = CPUMR3DisasmInstrCPU(pVM, pCtx, pCurInstrGC, &CpuNew, 0);
5803
5804	fValidInstr = !!(CpuNew.pCurInstr->optype & OPTYPE_HARMLESS);
5805	if ( !fValidInstr
5806	&& (CpuNew.pCurInstr->optype & OPTYPE_RELATIVE_CONTROLFLOW)
5807	)
5808	{
5809	RTGCPTR pTargetGC = PATMResolveBranch(&CpuNew, pCurInstrGC);
5810
5811	if ( pTargetGC >= pPatchToGuestRec->pOrgInstrGC
5812	&& pTargetGC <= pPatchToGuestRec->pOrgInstrGC + cbDirty
5813	)
5814	{
5815	/* A relative jump to an instruction inside or to the end of the dirty block is acceptable. */
5816	fValidInstr = true;
5817	}
5818	}
5819
5820	/* If the instruction is completely harmless (which implies a 1:1 patch copy). */
5821	if ( rc == VINF_SUCCESS
5822	&& CpuNew.opsize <= cbLeft /* must still fit */
5823	&& fValidInstr
5824	)
5825	{
5826	#ifdef DEBUG
5827	char szBuf[256];
5828	szBuf[0] = '\0';
5829	DBGFR3DisasInstr(pVM, pCtx->cs, pCurInstrGC, szBuf, sizeof(szBuf));
5830	Log(("NEW: %s\n", szBuf));
5831	#endif
5832
5833	/* Copy the new instruction. */
5834	rc = PGMPhysReadGCPtr(pVM, pCurPatchInstrHC, pCurInstrGC, CpuNew.opsize);
5835	AssertRC(rc);
5836
5837	/* Add a new lookup record for the duplicated instruction. */
5838	patmr3AddP2GLookupRecord(pVM, &pPatch->patch, pCurPatchInstrHC, pCurInstrGC, PATM_LOOKUP_BOTHDIR);
5839	}
5840	else
5841	{
5842	#ifdef DEBUG
5843	char szBuf[256];
5844	szBuf[0] = '\0';
5845	DBGFR3DisasInstr(pVM, pCtx->cs, pCurInstrGC, szBuf, sizeof(szBuf));
5846	Log(("NEW: %s (FAILED)\n", szBuf));
5847	#endif
5848	/* Restore the old lookup record for the duplicated instruction. */
5849	patmr3AddP2GLookupRecord(pVM, &pPatch->patch, pCurPatchInstrHC, pCurInstrGC, PATM_LOOKUP_BOTHDIR);
5850
5851	/** @todo in theory we need to restore the lookup records for the remaining dirty instructions too! */
5852	rc = VERR_PATCHING_REFUSED;
5853	break;
5854	}
5855	pCurInstrGC += CpuNew.opsize;
5856	pCurPatchInstrHC += CpuNew.opsize;
5857	pCurPatchInstrGC += CpuNew.opsize;
5858	cbLeft -= CpuNew.opsize;
5859	}
5860	}
5861	else
5862	rc = VERR_PATCHING_REFUSED;
5863
5864	if (VBOX_SUCCESS(rc))
5865	{
5866	STAM_COUNTER_INC(&pVM->patm.s.StatInstrDirtyGood);
5867	}
5868	else
5869	{
5870	STAM_COUNTER_INC(&pVM->patm.s.StatInstrDirtyBad);
5871	/* Mark the whole instruction stream with breakpoints. */
5872	memset(pPatchInstrHC, 0xCC, cbDirty);
5873
5874	if ( pVM->patm.s.fOutOfMemory == false
5875	&& (pPatch->patch.flags & (PATMFL_DUPLICATE_FUNCTION\|PATMFL_IDTHANDLER\|PATMFL_TRAPHANDLER)))
5876	{
5877	rc = patmR3RefreshPatch(pVM, pPatch);
5878	if (VBOX_FAILURE(rc))
5879	{
5880	LogRel(("PATM: Failed to refresh dirty patch at %VGv. Disabling it.\n", pPatch->patch.pPrivInstrGC));
5881	}
5882	/* Even if we succeed, we must go back to the original instruction as the patched one could be invalid. */
5883	rc = VERR_PATCHING_REFUSED;
5884	}
5885	}
5886	return rc;
5887	}
5888
5889	/**
5890	* Handle trap inside patch code
5891	*
5892	* @returns VBox status code.
5893	* @param pVM The VM to operate on.
5894	* @param pCtx CPU context
5895	* @param pEip GC pointer of trapping instruction
5896	* @param ppNewEip GC pointer to new instruction
5897	*/
5898	PATMR3DECL(int) PATMR3HandleTrap(PVM pVM, PCPUMCTX pCtx, RTGCPTR pEip, RTGCPTR *ppNewEip)
5899	{
5900	PPATMPATCHREC pPatch = 0;
5901	void *pvPatchCoreOffset;
5902	RTGCUINTPTR offset;
5903	RTGCPTR pNewEip;
5904	int rc ;
5905	PRECPATCHTOGUEST pPatchToGuestRec = 0;
5906
5907	pNewEip = 0;
5908	*ppNewEip = 0;
5909
5910	STAM_PROFILE_ADV_START(&pVM->patm.s.StatHandleTrap, a);
5911
5912	/* Find the patch record. */
5913	/** @note there might not be a patch to guest translation record (global function) */
5914	offset = pEip - pVM->patm.s.pPatchMemGC;
5915	pvPatchCoreOffset = RTAvloGCPtrGetBestFit(&pVM->patm.s.PatchLookupTreeHC->PatchTreeByPatchAddr, offset, false);
5916	if (pvPatchCoreOffset)
5917	{
5918	pPatch = PATM_PATCHREC_FROM_COREOFFSET(pvPatchCoreOffset);
5919
5920	if (pPatch->patch.uState == PATCH_DIRTY)
5921	{
5922	Log(("PATMR3HandleTrap: trap in dirty patch at %VGv\n", pEip));
5923	if (pPatch->patch.flags & (PATMFL_DUPLICATE_FUNCTION\|PATMFL_CALLABLE_AS_FUNCTION))
5924	{
5925	/* Function duplication patches set fPIF to 1 on entry */
5926	pVM->patm.s.pGCStateHC->fPIF = 1;
5927	}
5928	}
5929	else
5930	if (pPatch->patch.uState == PATCH_DISABLED)
5931	{
5932	Log(("PATMR3HandleTrap: trap in disabled patch at %VGv\n", pEip));
5933	if (pPatch->patch.flags & (PATMFL_DUPLICATE_FUNCTION\|PATMFL_CALLABLE_AS_FUNCTION))
5934	{
5935	/* Function duplication patches set fPIF to 1 on entry */
5936	pVM->patm.s.pGCStateHC->fPIF = 1;
5937	}
5938	}
5939	else
5940	if (pPatch->patch.uState == PATCH_DISABLE_PENDING)
5941	{
5942	RTGCPTR pPrivInstrGC = pPatch->patch.pPrivInstrGC;
5943
5944	Log(("PATMR3HandleTrap: disable operation is pending for patch at %VGv\n", pPatch->patch.pPrivInstrGC));
5945	rc = PATMR3DisablePatch(pVM, pPatch->patch.pPrivInstrGC);
5946	AssertReleaseMsg(rc != VWRN_PATCH_REMOVED, ("PATMR3DisablePatch removed patch at %VGv\n", pPrivInstrGC));
5947	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));
5948	}
5949
5950	pPatchToGuestRec = (PRECPATCHTOGUEST)RTAvlU32GetBestFit(&pPatch->patch.Patch2GuestAddrTree, offset, false);
5951	AssertReleaseMsg(pPatchToGuestRec, ("PATMR3HandleTrap: Unable to find corresponding guest address for %VGv (offset %x)\n", pEip, offset));
5952
5953	pNewEip = pPatchToGuestRec->pOrgInstrGC;
5954	pPatch->patch.cTraps++;
5955	PATM_STAT_FAULT_INC(&pPatch->patch);
5956	}
5957	else
5958	AssertReleaseMsg(pVM->patm.s.pGCStateHC->fPIF == 0, ("PATMR3HandleTrap: Unable to find translation record for %VGv (PIF=0)\n", pEip));
5959
5960	/* Check if we were interrupted in PATM generated instruction code. */
5961	if (pVM->patm.s.pGCStateHC->fPIF == 0)
5962	{
5963	DISCPUSTATE Cpu;
5964	rc = CPUMR3DisasmInstrCPU(pVM, pCtx, pEip, &Cpu, "PIF Trap: ");
5965	AssertRC(rc);
5966
5967	if ( rc == VINF_SUCCESS
5968	&& ( Cpu.pCurInstr->opcode == OP_PUSHF
5969	\|\| Cpu.pCurInstr->opcode == OP_PUSH
5970	\|\| Cpu.pCurInstr->opcode == OP_CALL)
5971	)
5972	{
5973	STAM_COUNTER_INC(&pVM->patm.s.StatPushTrap);
5974	/* Typical pushf (most patches)/push (call patch) trap because of a monitored page. */
5975	rc = PGMShwModifyPage(pVM, pCtx->esp, 1, X86_PTE_RW, ~(uint64_t)X86_PTE_RW);
5976	AssertMsgRC(rc, ("PGMShwModifyPage -> rc=%Vrc\n", rc));
5977	if (rc == VINF_SUCCESS)
5978	{
5979	uint64_t fFlags;
5980
5981	/* The guest page must be present. */
5982	rc = PGMGstGetPage(pVM, pCtx->esp, &fFlags, NULL);
5983	if (rc == VINF_SUCCESS && (fFlags & X86_PTE_P))
5984	{
5985	STAM_PROFILE_ADV_STOP(&pVM->patm.s.StatHandleTrap, a);
5986	return VINF_PATCH_CONTINUE;
5987	}
5988	}
5989	}
5990
5991	char szBuf[256];
5992	szBuf[0] = '\0';
5993	DBGFR3DisasInstr(pVM, pCtx->cs, pEip, szBuf, sizeof(szBuf));
5994
5995	/* Very bad. We crashed in emitted code. Probably stack? */
5996	if (pPatch)
5997	{
5998	AssertReleaseMsg(pVM->patm.s.pGCStateHC->fPIF == 1,
5999	("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));
6000	}
6001	else
6002	AssertReleaseMsg(pVM->patm.s.pGCStateHC->fPIF == 1,
6003	("Crash in patch code %VGv (%VGv) esp=%RX32\n%s\n", pEip, pNewEip, CPUMGetGuestESP(pVM), szBuf));
6004	EMR3FatalError(pVM, VERR_INTERNAL_ERROR);
6005	}
6006
6007	/* From here on, we must have a valid patch to guest translation. */
6008	if (pvPatchCoreOffset == 0)
6009	{
6010	STAM_PROFILE_ADV_STOP(&pVM->patm.s.StatHandleTrap, a);
6011	AssertMsgFailed(("PATMR3HandleTrap: patch not found at address %VGv!!\n", pEip));
6012	return VERR_PATCH_NOT_FOUND; //fatal error
6013	}
6014
6015	/* Take care of dirty/changed instructions. */
6016	if (pPatchToGuestRec->fDirty)
6017	{
6018	Assert(pPatchToGuestRec->Core.Key == offset);
6019	Assert(pVM->patm.s.pGCStateHC->fPIF == 1);
6020
6021	rc = patmR3HandleDirtyInstr(pVM, pCtx, pPatch, pPatchToGuestRec, pEip);
6022	if (VBOX_SUCCESS(rc))
6023	{
6024	/* Retry the current instruction. */
6025	pNewEip = pEip;
6026	rc = VINF_PATCH_CONTINUE; /* Continue at current patch instruction. */
6027	}
6028	else
6029	{
6030	/* Reset the PATM stack. */
6031	CTXSUFF(pVM->patm.s.pGCState)->Psp = PATM_STACK_SIZE;
6032
6033	rc = VINF_SUCCESS; /* Continue at original instruction. */
6034	}
6035
6036	*ppNewEip = pNewEip;
6037	STAM_PROFILE_ADV_STOP(&pVM->patm.s.StatHandleTrap, a);
6038	return rc;
6039	}
6040
6041	#ifdef VBOX_STRICT
6042	if (pPatch->patch.flags & PATMFL_DUPLICATE_FUNCTION)
6043	{
6044	DISCPUSTATE cpu;
6045	bool disret;
6046	uint32_t opsize;
6047
6048	cpu.mode = (pPatch->patch.flags & PATMFL_CODE32) ? CPUMODE_32BIT : CPUMODE_16BIT;
6049	disret = PATMR3DISInstr(pVM, &pPatch->patch, &cpu, pNewEip, PATMGCVirtToHCVirt(pVM, &pPatch->patch, pNewEip), &opsize, NULL, PATMREAD_RAWCODE);
6050	if (disret && cpu.pCurInstr->opcode == OP_RETN)
6051	{
6052	RTGCPTR retaddr;
6053	PCPUMCTX pCtx;
6054	int rc;
6055
6056	rc = CPUMQueryGuestCtxPtr(pVM, &pCtx);
6057	AssertRC(rc);
6058
6059	rc = PGMPhysReadGCPtr(pVM, &retaddr, pCtx->esp, sizeof(retaddr));
6060	AssertRC(rc);
6061
6062	Log(("Return failed at %VGv (%VGv)\n", pEip, pNewEip));
6063	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));
6064	}
6065	}
6066	#endif
6067
6068	/* Return original address, correct by subtracting the CS base address. */
6069	*ppNewEip = pNewEip - SELMToFlat(pVM, pCtx->eflags, pCtx->cs, &pCtx->csHid, 0);
6070
6071	/* Reset the PATM stack. */
6072	CTXSUFF(pVM->patm.s.pGCState)->Psp = PATM_STACK_SIZE;
6073
6074	if (pVM->patm.s.pGCStateHC->GCPtrInhibitInterrupts == pNewEip)
6075	{
6076	/* Must be a faulting instruction after sti; currently only sysexit, hlt or iret */
6077	Log(("PATMR3HandleTrap %VGv -> inhibit irqs set!\n", pEip));
6078	#ifdef VBOX_STRICT
6079	DISCPUSTATE cpu;
6080	bool disret;
6081	uint32_t opsize;
6082
6083	cpu.mode = (pPatch->patch.flags & PATMFL_CODE32) ? CPUMODE_32BIT : CPUMODE_16BIT;
6084	disret = PATMR3DISInstr(pVM, &pPatch->patch, &cpu, pNewEip, PATMGCVirtToHCVirt(pVM, &pPatch->patch, pNewEip), &opsize, NULL, PATMREAD_ORGCODE);
6085
6086	if (disret && (cpu.pCurInstr->opcode == OP_SYSEXIT \|\| cpu.pCurInstr->opcode == OP_HLT \|\| cpu.pCurInstr->opcode == OP_INT3))
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_RAWCODE);
6090
6091	Assert(cpu.pCurInstr->opcode == OP_SYSEXIT \|\| cpu.pCurInstr->opcode == OP_HLT \|\| cpu.pCurInstr->opcode == OP_IRET);
6092	}
6093	#endif
6094	EMSetInhibitInterruptsPC(pVM, pNewEip);
6095	pVM->patm.s.pGCStateHC->GCPtrInhibitInterrupts = 0;
6096	}
6097
6098	Log2(("pPatchBlockGC %VGv - pEip %VGv corresponding GC address %VGv\n", PATCHCODE_PTR_GC(&pPatch->patch), pEip, pNewEip));
6099
6100	if (pNewEip >= pPatch->patch.pPrivInstrGC && pNewEip < pPatch->patch.pPrivInstrGC + pPatch->patch.cbPatchJump)
6101	{
6102	/* We can't jump back to code that we've overwritten with a 5 byte jump! */
6103	Log(("Disabling patch at location %VGv due to trap too close to the privileged instruction \n", pPatch->patch.pPrivInstrGC));
6104	PATMR3DisablePatch(pVM, pPatch->patch.pPrivInstrGC);
6105	STAM_PROFILE_ADV_STOP(&pVM->patm.s.StatHandleTrap, a);
6106	return VERR_PATCH_DISABLED;
6107	}
6108
6109	#ifdef PATM_REMOVE_PATCH_ON_TOO_MANY_TRAPS
6110	/** @todo compare to nr of successful runs. add some aging algorithm and determine the best time to disable the patch */
6111	if (pPatch->patch.cTraps > MAX_PATCH_TRAPS)
6112	{
6113	Log(("Disabling patch at location %VGv due to too many traps inside patch code\n", pPatch->patch.pPrivInstrGC));
6114	//we are only wasting time, back out the patch
6115	PATMR3DisablePatch(pVM, pPatch->patch.pPrivInstrGC);
6116	pTrapRec->pNextPatchInstr = 0;
6117	STAM_PROFILE_ADV_STOP(&pVM->patm.s.StatHandleTrap, a);
6118	return VERR_PATCH_DISABLED;
6119	}
6120	#endif
6121
6122	STAM_PROFILE_ADV_STOP(&pVM->patm.s.StatHandleTrap, a);
6123	return VINF_SUCCESS;
6124	}
6125
6126
6127	/**
6128	* Handle page-fault in monitored page
6129	*
6130	* @returns VBox status code.
6131	* @param pVM The VM to operate on.
6132	*/
6133	PATMR3DECL(int) PATMR3HandleMonitoredPage(PVM pVM)
6134	{
6135	RTGCPTR addr = pVM->patm.s.pvFaultMonitor;
6136
6137	addr &= PAGE_BASE_GC_MASK;
6138
6139	int rc = PGMHandlerVirtualDeregister(pVM, addr);
6140	AssertRC(rc); NOREF(rc);
6141
6142	PPATMPATCHREC pPatchRec = (PPATMPATCHREC)RTAvloGCPtrGetBestFit(&pVM->patm.s.PatchLookupTreeHC->PatchTree, addr, false);
6143	if (pPatchRec && pPatchRec->patch.uState == PATCH_ENABLED && PAGE_ADDRESS(pPatchRec->patch.pPrivInstrGC) == PAGE_ADDRESS(addr))
6144	{
6145	STAM_COUNTER_INC(&pVM->patm.s.StatMonitored);
6146	Log(("Renewing patch at %VGv\n", pPatchRec->patch.pPrivInstrGC));
6147	rc = PATMR3DisablePatch(pVM, pPatchRec->patch.pPrivInstrGC);
6148	if (rc == VWRN_PATCH_REMOVED)
6149	return VINF_SUCCESS;
6150
6151	PATMR3EnablePatch(pVM, pPatchRec->patch.pPrivInstrGC);
6152
6153	if (addr == pPatchRec->patch.pPrivInstrGC)
6154	addr++;
6155	}
6156
6157	for(;;)
6158	{
6159	pPatchRec = (PPATMPATCHREC)RTAvloGCPtrGetBestFit(&pVM->patm.s.PatchLookupTreeHC->PatchTree, addr, true);
6160
6161	if (!pPatchRec \|\| PAGE_ADDRESS(pPatchRec->patch.pPrivInstrGC) != PAGE_ADDRESS(addr))
6162	break;
6163
6164	if (pPatchRec && pPatchRec->patch.uState == PATCH_ENABLED)
6165	{
6166	STAM_COUNTER_INC(&pVM->patm.s.StatMonitored);
6167	Log(("Renewing patch at %VGv\n", pPatchRec->patch.pPrivInstrGC));
6168	PATMR3DisablePatch(pVM, pPatchRec->patch.pPrivInstrGC);
6169	PATMR3EnablePatch(pVM, pPatchRec->patch.pPrivInstrGC);
6170	}
6171	addr = pPatchRec->patch.pPrivInstrGC + 1;
6172	}
6173
6174	pVM->patm.s.pvFaultMonitor = 0;
6175	return VINF_SUCCESS;
6176	}
6177
6178
6179	#ifdef VBOX_WITH_STATISTICS
6180
6181	static const char *PATMPatchType(PVM pVM, PPATCHINFO pPatch)
6182	{
6183	if (pPatch->flags & PATMFL_SYSENTER)
6184	{
6185	return "SYSENT";
6186	}
6187	else
6188	if (pPatch->flags & (PATMFL_TRAPHANDLER\|PATMFL_INTHANDLER))
6189	{
6190	static char szTrap[16];
6191	uint32_t iGate;
6192
6193	iGate = TRPMR3QueryGateByHandler(pVM, PATCHCODE_PTR_GC(pPatch));
6194	if (iGate < 256)
6195	RTStrPrintf(szTrap, sizeof(szTrap), (pPatch->flags & PATMFL_INTHANDLER) ? "INT-%2X" : "TRAP-%2X", iGate);
6196	else
6197	RTStrPrintf(szTrap, sizeof(szTrap), (pPatch->flags & PATMFL_INTHANDLER) ? "INT-??" : "TRAP-??");
6198	return szTrap;
6199	}
6200	else
6201	if (pPatch->flags & (PATMFL_DUPLICATE_FUNCTION))
6202	return "DUPFUNC";
6203	else
6204	if (pPatch->flags & PATMFL_REPLACE_FUNCTION_CALL)
6205	return "FUNCCALL";
6206	else
6207	if (pPatch->flags & PATMFL_TRAMPOLINE)
6208	return "TRAMP";
6209	else
6210	return patmGetInstructionString(pPatch->opcode, pPatch->flags);
6211	}
6212
6213	static const char *PATMPatchState(PVM pVM, PPATCHINFO pPatch)
6214	{
6215	switch(pPatch->uState)
6216	{
6217	case PATCH_ENABLED:
6218	return "ENA";
6219	case PATCH_DISABLED:
6220	return "DIS";
6221	case PATCH_DIRTY:
6222	return "DIR";
6223	case PATCH_UNUSABLE:
6224	return "UNU";
6225	case PATCH_REFUSED:
6226	return "REF";
6227	case PATCH_DISABLE_PENDING:
6228	return "DIP";
6229	default:
6230	AssertFailed();
6231	return " ";
6232	}
6233	}
6234
6235	/**
6236	* Resets the sample.
6237	* @param pVM The VM handle.
6238	* @param pvSample The sample registered using STAMR3RegisterCallback.
6239	*/
6240	static void patmResetStat(PVM pVM, void *pvSample)
6241	{
6242	PPATCHINFO pPatch = (PPATCHINFO)pvSample;
6243	Assert(pPatch);
6244
6245	pVM->patm.s.pStatsHC[pPatch->uPatchIdx].u32A = 0;
6246	pVM->patm.s.pStatsHC[pPatch->uPatchIdx].u32B = 0;
6247	}
6248
6249	/**
6250	* Prints the sample into the buffer.
6251	*
6252	* @param pVM The VM handle.
6253	* @param pvSample The sample registered using STAMR3RegisterCallback.
6254	* @param pszBuf The buffer to print into.
6255	* @param cchBuf The size of the buffer.
6256	*/
6257	static void patmPrintStat(PVM pVM, void pvSample, char pszBuf, size_t cchBuf)
6258	{
6259	PPATCHINFO pPatch = (PPATCHINFO)pvSample;
6260	Assert(pPatch);
6261
6262	Assert(pPatch->uState != PATCH_REFUSED);
6263	Assert(!(pPatch->flags & (PATMFL_REPLACE_FUNCTION_CALL\|PATMFL_MMIO_ACCESS)));
6264
6265	RTStrPrintf(pszBuf, cchBuf, "size %04x ->%3s %8s - %08d - %08d",
6266	pPatch->cbPatchBlockSize, PATMPatchState(pVM, pPatch), PATMPatchType(pVM, pPatch),
6267	pVM->patm.s.pStatsHC[pPatch->uPatchIdx].u32A, pVM->patm.s.pStatsHC[pPatch->uPatchIdx].u32B);
6268	}
6269
6270	/**
6271	* Returns the GC address of the corresponding patch statistics counter
6272	*
6273	* @returns Stat address
6274	* @param pVM The VM to operate on.
6275	* @param pPatch Patch structure
6276	*/
6277	RTGCPTR patmPatchQueryStatAddress(PVM pVM, PPATCHINFO pPatch)
6278	{
6279	Assert(pPatch->uPatchIdx != PATM_STAT_INDEX_NONE);
6280	return pVM->patm.s.pStatsGC + sizeof(STAMRATIOU32) * pPatch->uPatchIdx + RT_OFFSETOF(STAMRATIOU32, u32A);
6281	}
6282
6283	#endif /* VBOX_WITH_STATISTICS */
6284
6285	#ifdef VBOX_WITH_DEBUGGER
6286	/**
6287	* The '.patmoff' command.
6288	*
6289	* @returns VBox status.
6290	* @param pCmd Pointer to the command descriptor (as registered).
6291	* @param pCmdHlp Pointer to command helper functions.
6292	* @param pVM Pointer to the current VM (if any).
6293	* @param paArgs Pointer to (readonly) array of arguments.
6294	* @param cArgs Number of arguments in the array.
6295	*/
6296	static DECLCALLBACK(int) patmr3CmdOff(PCDBGCCMD pCmd, PDBGCCMDHLP pCmdHlp, PVM pVM, PCDBGCVAR paArgs, unsigned cArgs, PDBGCVAR pResult)
6297	{
6298	/*
6299	* Validate input.
6300	*/
6301	if (!pVM)
6302	return pCmdHlp->pfnPrintf(pCmdHlp, NULL, "error: The command requires VM to be selected.\n");
6303
6304	RTAvloGCPtrDoWithAll(&pVM->patm.s.PatchLookupTreeHC->PatchTree, true, DisableAllPatches, pVM);
6305	PATMR3AllowPatching(pVM, false);
6306	return pCmdHlp->pfnPrintf(pCmdHlp, NULL, "Patching disabled\n");
6307	}
6308
6309	/**
6310	* The '.patmon' command.
6311	*
6312	* @returns VBox status.
6313	* @param pCmd Pointer to the command descriptor (as registered).
6314	* @param pCmdHlp Pointer to command helper functions.
6315	* @param pVM Pointer to the current VM (if any).
6316	* @param paArgs Pointer to (readonly) array of arguments.
6317	* @param cArgs Number of arguments in the array.
6318	*/
6319	static DECLCALLBACK(int) patmr3CmdOn(PCDBGCCMD pCmd, PDBGCCMDHLP pCmdHlp, PVM pVM, PCDBGCVAR paArgs, unsigned cArgs, PDBGCVAR pResult)
6320	{
6321	/*
6322	* Validate input.
6323	*/
6324	if (!pVM)
6325	return pCmdHlp->pfnPrintf(pCmdHlp, NULL, "error: The command requires VM to be selected.\n");
6326
6327	PATMR3AllowPatching(pVM, true);
6328	RTAvloGCPtrDoWithAll(&pVM->patm.s.PatchLookupTreeHC->PatchTree, true, EnableAllPatches, pVM);
6329	return pCmdHlp->pfnPrintf(pCmdHlp, NULL, "Patching enabled\n");
6330	}
6331	#endif

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

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

Download in other formats: