PATM.cpp@ 2043

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

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

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

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

Download in other formats: