VirtioCore.cpp@ 98661

Last change on this file since 98661 was 98661, checked in by vboxsync, 21 months ago
Devices/DevVirtioSCSI: Possible fix for bugref:9440#c164, the queue head can get out of sync if two threads complete I/O requests concurrently
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 116.6 KB

Line
1	/* $Id: VirtioCore.cpp 98661 2023-02-20 16:31:14Z vboxsync $ */
2
3	/** @file
4	* VirtioCore - Virtio Core (PCI, feature & config mgt, queue mgt & proxy, notification mgt)
5	*/
6
7	/*
8	* Copyright (C) 2009-2023 Oracle and/or its affiliates.
9	*
10	* This file is part of VirtualBox base platform packages, as
11	* available from https://www.virtualbox.org.
12	*
13	* This program is free software; you can redistribute it and/or
14	* modify it under the terms of the GNU General Public License
15	* as published by the Free Software Foundation, in version 3 of the
16	* License.
17	*
18	* This program is distributed in the hope that it will be useful, but
19	* WITHOUT ANY WARRANTY; without even the implied warranty of
20	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
21	* General Public License for more details.
22	*
23	* You should have received a copy of the GNU General Public License
24	* along with this program; if not, see <https://www.gnu.org/licenses>.
25	*
26	* SPDX-License-Identifier: GPL-3.0-only
27	*/
28
29
30	/*********************************************************************************************************************************
31	* Header Files *
32	*********************************************************************************************************************************/
33	#define LOG_GROUP LOG_GROUP_DEV_VIRTIO
34
35	#include <iprt/assert.h>
36	#include <iprt/uuid.h>
37	#include <iprt/mem.h>
38	#include <iprt/sg.h>
39	#include <iprt/assert.h>
40	#include <iprt/string.h>
41	#include <iprt/param.h>
42	#include <iprt/types.h>
43	#include <VBox/log.h>
44	#include <VBox/msi.h>
45	#include <iprt/types.h>
46	#include <VBox/AssertGuest.h>
47	#include <VBox/vmm/pdmdev.h>
48	#include "VirtioCore.h"
49
50
51	/*********************************************************************************************************************************
52	* Defined Constants And Macros *
53	*********************************************************************************************************************************/
54
55	#define INSTANCE(a_pVirtio) ((a_pVirtio)->szInstance)
56	#define VIRTQNAME(a_pVirtio, a_uVirtq) ((a_pVirtio)->aVirtqueues[(a_uVirtq)].szName)
57
58	#define IS_VIRTQ_EMPTY(pDevIns, pVirtio, pVirtq) \
59	(virtioCoreVirtqAvailCnt(pDevIns, pVirtio, pVirtq) == 0)
60
61	#define IS_DRIVER_OK(a_pVirtio) ((a_pVirtio)->fDeviceStatus & VIRTIO_STATUS_DRIVER_OK)
62	#define WAS_DRIVER_OK(a_pVirtio) ((a_pVirtio)->fPrevDeviceStatus & VIRTIO_STATUS_DRIVER_OK)
63
64	/**
65	* These defines are used to track guest virtio-net driver writing driver features accepted flags
66	* in two 32-bit operations (in arbitrary order), and one bit dedicated to ensured 'features complete'
67	* is handled once.
68	*/
69	#define DRIVER_FEATURES_0_WRITTEN 1 /*< fDriverFeatures[0] written by guest virtio-net /
70	#define DRIVER_FEATURES_1_WRITTEN 2 /*< fDriverFeatures[1] written by guest virtio-net /
71	#define DRIVER_FEATURES_0_AND_1_WRITTEN 3 /*< Both 32-bit parts of fDriverFeatures[] written /
72	#define DRIVER_FEATURES_COMPLETE_HANDLED 4 /*< Features negotiation complete handler called /
73
74	/**
75	* This macro returns true if the @a a_offAccess and access length (@a
76	* a_cbAccess) are within the range of the mapped capability struct described by
77	* @a a_LocCapData.
78	*
79	* @param[in] a_offAccess Input: The offset into the MMIO bar of the access.
80	* @param[in] a_cbAccess Input: The access size.
81	* @param[out] a_offsetIntoCap Output: uint32_t variable to return the intra-capability offset into.
82	* @param[in] a_LocCapData Input: The capability location info.
83	*/
84	#define MATCHES_VIRTIO_CAP_STRUCT(a_offAccess, a_cbAccess, a_offsetIntoCap, a_LocCapData) \
85	( ((a_offsetIntoCap) = (uint32_t)((a_offAccess) - (a_LocCapData).offMmio)) < (uint32_t)(a_LocCapData).cbMmio \
86	&& (a_offsetIntoCap) + (uint32_t)(a_cbAccess) <= (uint32_t)(a_LocCapData).cbMmio )
87
88
89	/*********************************************************************************************************************************
90	* Structures and Typedefs *
91	*********************************************************************************************************************************/
92
93	/** @name virtq related flags
94	* @{ */
95	#define VIRTQ_DESC_F_NEXT 1 /*< Indicates this descriptor chains to next /
96	#define VIRTQ_DESC_F_WRITE 2 /*< Marks buffer as write-only (default ro) /
97	#define VIRTQ_DESC_F_INDIRECT 4 /*< Buffer is list of buffer descriptors /
98
99	#define VIRTQ_USED_F_NO_NOTIFY 1 /*< Dev to Drv: Don't notify when buf added /
100	#define VIRTQ_AVAIL_F_NO_INTERRUPT 1 /*< Drv to Dev: Don't notify when buf eaten /
101	/** @} */
102
103	/**
104	* virtq-related structs
105	* (struct names follow VirtIO 1.0 spec, field names use VBox styled naming, w/respective spec'd name in comments)
106	*/
107	typedef struct virtq_desc
108	{
109	uint64_t GCPhysBuf; /*< addr GC Phys. address of buffer /
110	uint32_t cb; /*< len Buffer length /
111	uint16_t fFlags; /*< flags Buffer specific flags /
112	uint16_t uDescIdxNext; /*< next Idx set if VIRTIO_DESC_F_NEXT /
113	} VIRTQ_DESC_T, *PVIRTQ_DESC_T;
114
115	typedef struct virtq_avail
116	{
117	uint16_t fFlags; /*< flags avail ring guest-to-host flags /
118	uint16_t uIdx; /*< idx Index of next free ring slot /
119	RT_FLEXIBLE_ARRAY_EXTENSION
120	uint16_t auRing[RT_FLEXIBLE_ARRAY]; /*< ring Ring: avail drv to dev bufs /
121	//uint16_t uUsedEventIdx; /*< used_event (if VIRTQ_USED_F_EVENT_IDX) /
122	} VIRTQ_AVAIL_T, *PVIRTQ_AVAIL_T;
123
124	typedef struct virtq_used_elem
125	{
126	uint32_t uDescIdx; /*< idx Start of used desc chain /
127	uint32_t cbElem; /*< len Total len of used desc chain /
128	} VIRTQ_USED_ELEM_T;
129
130	typedef struct virt_used
131	{
132	uint16_t fFlags; /*< flags used ring host-to-guest flags /
133	uint16_t uIdx; /*< idx Index of next ring slot /
134	RT_FLEXIBLE_ARRAY_EXTENSION
135	VIRTQ_USED_ELEM_T aRing[RT_FLEXIBLE_ARRAY]; /*< ring Ring: used dev to drv bufs /
136	//uint16_t uAvailEventIdx; /*< avail_event if (VIRTQ_USED_F_EVENT_IDX) /
137	} VIRTQ_USED_T, *PVIRTQ_USED_T;
138
139	const char *virtioCoreGetStateChangeText(VIRTIOVMSTATECHANGED enmState)
140	{
141	switch (enmState)
142	{
143	case kvirtIoVmStateChangedReset: return "VM RESET";
144	case kvirtIoVmStateChangedSuspend: return "VM SUSPEND";
145	case kvirtIoVmStateChangedPowerOff: return "VM POWER OFF";
146	case kvirtIoVmStateChangedResume: return "VM RESUME";
147	default: return "<BAD ENUM>";
148	}
149	}
150
151	/* Internal Functions */
152
153	static void virtioCoreNotifyGuestDriver(PPDMDEVINS pDevIns, PVIRTIOCORE pVirtio, uint16_t uVirtq);
154	static int virtioNudgeGuest(PPDMDEVINS pDevIns, PVIRTIOCORE pVirtio, uint8_t uCause, uint16_t uVec);
155
156	#ifdef IN_RING3
157	# ifdef LOG_ENABLED
158	DECLINLINE(uint16_t) virtioCoreR3CountPendingBufs(uint16_t uRingIdx, uint16_t uShadowIdx, uint16_t uQueueSize)
159	{
160	if (uShadowIdx == uRingIdx)
161	return 0;
162	else
163	if (uShadowIdx > uRingIdx)
164	return uShadowIdx - uRingIdx;
165	return uQueueSize - (uRingIdx - uShadowIdx);
166	}
167	# endif
168	#endif
169	/** @name Internal queue operations
170	* @{ */
171
172	/**
173	* Accessor for virtq descriptor
174	*/
175	#ifdef IN_RING3
176	DECLINLINE(void) virtioReadDesc(PPDMDEVINS pDevIns, PVIRTIOCORE pVirtio, PVIRTQUEUE pVirtq,
177	uint32_t idxDesc, PVIRTQ_DESC_T pDesc)
178	{
179	/*
180	* Shut up assertion for legacy virtio-net driver in FreeBSD up to 12.3 (see virtioCoreR3VirtqUsedBufPut()
181	* for more information).
182	*/
183	AssertMsg( IS_DRIVER_OK(pVirtio)
184	\|\| ( pVirtio->fLegacyDriver
185	&& pVirtq->GCPhysVirtqDesc),
186	("Called with guest driver not ready\n"));
187	uint16_t const cVirtqItems = RT_MAX(pVirtq->uQueueSize, 1); /* Make sure to avoid div-by-zero. */
188
189	virtioCoreGCPhysRead(pVirtio, pDevIns,
190	pVirtq->GCPhysVirtqDesc + sizeof(VIRTQ_DESC_T) * (idxDesc % cVirtqItems),
191	pDesc, sizeof(VIRTQ_DESC_T));
192	}
193	#endif
194
195	/**
196	* Accessors for virtq avail ring
197	*/
198	#ifdef IN_RING3
199	DECLINLINE(uint16_t) virtioReadAvailDescIdx(PPDMDEVINS pDevIns, PVIRTIOCORE pVirtio, PVIRTQUEUE pVirtq, uint32_t availIdx)
200	{
201	uint16_t uDescIdx;
202
203	AssertMsg(pVirtio->fLegacyDriver \|\| IS_DRIVER_OK(pVirtio), ("Called with guest driver not ready\n"));
204	uint16_t const cVirtqItems = RT_MAX(pVirtq->uQueueSize, 1); /* Make sure to avoid div-by-zero. */
205	virtioCoreGCPhysRead(pVirtio, pDevIns,
206	pVirtq->GCPhysVirtqAvail + RT_UOFFSETOF_DYN(VIRTQ_AVAIL_T, auRing[availIdx % cVirtqItems]),
207	&uDescIdx, sizeof(uDescIdx));
208	return uDescIdx;
209	}
210
211	DECLINLINE(uint16_t) virtioReadAvailUsedEvent(PPDMDEVINS pDevIns, PVIRTIOCORE pVirtio, PVIRTQUEUE pVirtq)
212	{
213	uint16_t uUsedEventIdx;
214	/* VirtIO 1.0 uUsedEventIdx (used_event) immediately follows ring */
215	AssertMsg(pVirtio->fLegacyDriver \|\| IS_DRIVER_OK(pVirtio), ("Called with guest driver not ready\n"));
216	virtioCoreGCPhysRead(pVirtio, pDevIns,
217	pVirtq->GCPhysVirtqAvail + RT_UOFFSETOF_DYN(VIRTQ_AVAIL_T, auRing[pVirtq->uQueueSize]),
218	&uUsedEventIdx, sizeof(uUsedEventIdx));
219	return uUsedEventIdx;
220	}
221	#endif
222
223	DECLINLINE(uint16_t) virtioReadAvailRingIdx(PPDMDEVINS pDevIns, PVIRTIOCORE pVirtio, PVIRTQUEUE pVirtq)
224	{
225	uint16_t uIdx = 0;
226	AssertMsg(pVirtio->fLegacyDriver \|\| IS_DRIVER_OK(pVirtio), ("Called with guest driver not ready\n"));
227	virtioCoreGCPhysRead(pVirtio, pDevIns,
228	pVirtq->GCPhysVirtqAvail + RT_UOFFSETOF(VIRTQ_AVAIL_T, uIdx),
229	&uIdx, sizeof(uIdx));
230	return uIdx;
231	}
232
233	DECLINLINE(uint16_t) virtioReadAvailRingFlags(PPDMDEVINS pDevIns, PVIRTIOCORE pVirtio, PVIRTQUEUE pVirtq)
234	{
235	uint16_t fFlags = 0;
236	AssertMsg(pVirtio->fLegacyDriver \|\| IS_DRIVER_OK(pVirtio), ("Called with guest driver not ready\n"));
237	virtioCoreGCPhysRead(pVirtio, pDevIns,
238	pVirtq->GCPhysVirtqAvail + RT_UOFFSETOF(VIRTQ_AVAIL_T, fFlags),
239	&fFlags, sizeof(fFlags));
240	return fFlags;
241	}
242
243	/** @} */
244
245	/** @name Accessors for virtq used ring
246	* @{
247	*/
248
249	#ifdef IN_RING3
250	DECLINLINE(void) virtioWriteUsedElem(PPDMDEVINS pDevIns, PVIRTIOCORE pVirtio, PVIRTQUEUE pVirtq,
251	uint32_t usedIdx, uint32_t uDescIdx, uint32_t uLen)
252	{
253	VIRTQ_USED_ELEM_T elem = { uDescIdx, uLen };
254	AssertMsg(pVirtio->fLegacyDriver \|\| IS_DRIVER_OK(pVirtio), ("Called with guest driver not ready\n"));
255	uint16_t const cVirtqItems = RT_MAX(pVirtq->uQueueSize, 1); /* Make sure to avoid div-by-zero. */
256	virtioCoreGCPhysWrite(pVirtio, pDevIns,
257	pVirtq->GCPhysVirtqUsed
258	+ RT_UOFFSETOF_DYN(VIRTQ_USED_T, aRing[usedIdx % cVirtqItems]),
259	&elem, sizeof(elem));
260	}
261
262	DECLINLINE(void) virtioWriteUsedRingFlags(PPDMDEVINS pDevIns, PVIRTIOCORE pVirtio, PVIRTQUEUE pVirtq, uint16_t fFlags)
263	{
264	AssertMsg(pVirtio->fLegacyDriver \|\| IS_DRIVER_OK(pVirtio), ("Called with guest driver not ready\n"));
265	RT_UNTRUSTED_VALIDATED_FENCE(); /* VirtIO 1.0, Section 3.2.1.4.1 */
266	virtioCoreGCPhysWrite(pVirtio, pDevIns,
267	pVirtq->GCPhysVirtqUsed + RT_UOFFSETOF(VIRTQ_USED_T, fFlags),
268	&fFlags, sizeof(fFlags));
269	}
270	#endif
271
272	DECLINLINE(void) virtioWriteUsedRingIdx(PPDMDEVINS pDevIns, PVIRTIOCORE pVirtio, PVIRTQUEUE pVirtq, uint16_t uIdx)
273	{
274	AssertMsg(pVirtio->fLegacyDriver \|\| IS_DRIVER_OK(pVirtio), ("Called with guest driver not ready\n"));
275	RT_UNTRUSTED_VALIDATED_FENCE(); /* VirtIO 1.0, Section 3.2.1.4.1 */
276	virtioCoreGCPhysWrite(pVirtio, pDevIns,
277	pVirtq->GCPhysVirtqUsed + RT_UOFFSETOF(VIRTQ_USED_T, uIdx),
278	&uIdx, sizeof(uIdx));
279	}
280
281	#ifdef IN_RING3
282	DECLINLINE(uint16_t) virtioReadUsedRingIdx(PPDMDEVINS pDevIns, PVIRTIOCORE pVirtio, PVIRTQUEUE pVirtq)
283	{
284	uint16_t uIdx = 0;
285	AssertMsg(pVirtio->fLegacyDriver \|\| IS_DRIVER_OK(pVirtio), ("Called with guest driver not ready\n"));
286	virtioCoreGCPhysRead(pVirtio, pDevIns,
287	pVirtq->GCPhysVirtqUsed + RT_UOFFSETOF(VIRTQ_USED_T, uIdx),
288	&uIdx, sizeof(uIdx));
289	return uIdx;
290	}
291
292	DECLINLINE(uint16_t) virtioReadUsedRingFlags(PPDMDEVINS pDevIns, PVIRTIOCORE pVirtio, PVIRTQUEUE pVirtq)
293	{
294	uint16_t fFlags = 0;
295	AssertMsg(pVirtio->fLegacyDriver \|\| IS_DRIVER_OK(pVirtio), ("Called with guest driver not ready\n"));
296	virtioCoreGCPhysRead(pVirtio, pDevIns,
297	pVirtq->GCPhysVirtqUsed + RT_UOFFSETOF(VIRTQ_USED_T, fFlags),
298	&fFlags, sizeof(fFlags));
299	return fFlags;
300	}
301
302	DECLINLINE(void) virtioWriteUsedAvailEvent(PPDMDEVINS pDevIns, PVIRTIOCORE pVirtio, PVIRTQUEUE pVirtq, uint32_t uAvailEventIdx)
303	{
304	/** VirtIO 1.0 uAvailEventIdx (avail_event) immediately follows ring */
305	AssertMsg(pVirtio->fLegacyDriver \|\| IS_DRIVER_OK(pVirtio), ("Called with guest driver not ready\n"));
306	virtioCoreGCPhysWrite(pVirtio, pDevIns,
307	pVirtq->GCPhysVirtqUsed
308	+ RT_UOFFSETOF_DYN(VIRTQ_USED_T, aRing[pVirtq->uQueueSize]),
309	&uAvailEventIdx, sizeof(uAvailEventIdx));
310	}
311	#endif
312	/** @} */
313
314
315	DECLINLINE(uint16_t) virtioCoreVirtqAvailCnt(PPDMDEVINS pDevIns, PVIRTIOCORE pVirtio, PVIRTQUEUE pVirtq)
316	{
317	uint16_t uIdxActual = virtioReadAvailRingIdx(pDevIns, pVirtio, pVirtq);
318	uint16_t uIdxShadow = pVirtq->uAvailIdxShadow;
319	uint16_t uIdxDelta;
320
321	if (uIdxActual < uIdxShadow)
322	uIdxDelta = (uIdxActual + pVirtq->uQueueSize) - uIdxShadow;
323	else
324	uIdxDelta = uIdxActual - uIdxShadow;
325
326	return uIdxDelta;
327	}
328	/**
329	* Get count of new (e.g. pending) elements in available ring.
330	*
331	* @param pDevIns The device instance.
332	* @param pVirtio Pointer to the shared virtio state.
333	* @param uVirtq Virtq number
334	*
335	* @returns how many entries have been added to ring as a delta of the consumer's
336	* avail index and the queue's guest-side current avail index.
337	*/
338	uint16_t virtioCoreVirtqAvailBufCount(PPDMDEVINS pDevIns, PVIRTIOCORE pVirtio, uint16_t uVirtq)
339	{
340	AssertMsgReturn(uVirtq < RT_ELEMENTS(pVirtio->aVirtqueues), ("uVirtq out of range"), 0);
341	PVIRTQUEUE pVirtq = &pVirtio->aVirtqueues[uVirtq];
342
343	if (!IS_DRIVER_OK(pVirtio))
344	{
345	LogRelFunc(("Driver not ready\n"));
346	return 0;
347	}
348	if (!pVirtio->fLegacyDriver && !pVirtq->uEnable)
349	{
350	LogRelFunc(("virtq: %s not enabled\n", VIRTQNAME(pVirtio, uVirtq)));
351	return 0;
352	}
353	return virtioCoreVirtqAvailCnt(pDevIns, pVirtio, pVirtq);
354	}
355
356	#ifdef IN_RING3
357
358	void virtioCoreR3FeatureDump(VIRTIOCORE pVirtio, PCDBGFINFOHLP pHlp, const VIRTIO_FEATURES_LIST s_aFeatures, int cFeatures, int fBanner)
359	{
360	#define MAXLINE 80
361	/* Display as a single buf to prevent interceding log messages */
362	uint16_t cbBuf = cFeatures * 132;
363	char pszBuf = (char )RTMemAllocZ(cbBuf);
364	Assert(pszBuf);
365	char *cp = pszBuf;
366	for (int i = 0; i < cFeatures; ++i)
367	{
368	bool isOffered = RT_BOOL(pVirtio->uDeviceFeatures & s_aFeatures[i].fFeatureBit);
369	bool isNegotiated = RT_BOOL(pVirtio->uDriverFeatures & s_aFeatures[i].fFeatureBit);
370	cp += RTStrPrintf(cp, cbBuf - (cp - pszBuf), " %s %s %s",
371	isOffered ? "+" : "-", isNegotiated ? "x" : " ", s_aFeatures[i].pcszDesc);
372	}
373	if (pHlp) {
374	if (fBanner)
375	pHlp->pfnPrintf(pHlp, "VirtIO Features Configuration\n\n"
376	" Offered Accepted Feature Description\n"
377	" ------- -------- ------- -----------\n");
378	pHlp->pfnPrintf(pHlp, "%s\n", pszBuf);
379	}
380	#ifdef LOG_ENABLED
381	else
382	{
383	if (fBanner)
384	Log(("VirtIO Features Configuration\n\n"
385	" Offered Accepted Feature Description\n"
386	" ------- -------- ------- -----------\n"));
387	Log(("%s\n", pszBuf));
388	}
389	#endif
390	RTMemFree(pszBuf);
391	}
392
393	/** API Function: See header file*/
394	void virtioCorePrintDeviceFeatures(VIRTIOCORE *pVirtio, PCDBGFINFOHLP pHlp,
395	const VIRTIO_FEATURES_LIST *s_aDevSpecificFeatures, int cFeatures) {
396	virtioCoreR3FeatureDump(pVirtio, pHlp, s_aCoreFeatures, RT_ELEMENTS(s_aCoreFeatures), 1 /fBanner /);
397	virtioCoreR3FeatureDump(pVirtio, pHlp, s_aDevSpecificFeatures, cFeatures, 0 /fBanner /);
398	}
399
400	#endif
401
402	#ifdef LOG_ENABLED
403
404	/** API Function: See header file */
405	void virtioCoreHexDump(uint8_t pv, uint32_t cb, uint32_t uBase, const char pszTitle)
406	{
407	#define ADJCURSOR(cb) pszOut += cb; cbRemain -= cb;
408	size_t cbPrint = 0, cbRemain = ((cb / 16) + 1) * 80;
409	char pszBuf = (char )RTMemAllocZ(cbRemain), *pszOut = pszBuf;
410	AssertMsgReturnVoid(pszBuf, ("Out of Memory"));
411	if (pszTitle)
412	{
413	cbPrint = RTStrPrintf(pszOut, cbRemain, "%s [%d bytes]:\n", pszTitle, cb);
414	ADJCURSOR(cbPrint);
415	}
416	for (uint32_t row = 0; row < RT_MAX(1, (cb / 16) + 1) && row * 16 < cb; row++)
417	{
418	cbPrint = RTStrPrintf(pszOut, cbRemain, "%04x: ", row * 16 + uBase); /* line address */
419	ADJCURSOR(cbPrint);
420	for (uint8_t col = 0; col < 16; col++)
421	{
422	uint32_t idx = row * 16 + col;
423	if (idx >= cb)
424	cbPrint = RTStrPrintf(pszOut, cbRemain, "-- %s", (col + 1) % 8 ? "" : " ");
425	else
426	cbPrint = RTStrPrintf(pszOut, cbRemain, "%02x %s", pv[idx], (col + 1) % 8 ? "" : " ");
427	ADJCURSOR(cbPrint);
428	}
429	for (uint32_t idx = row * 16; idx < row * 16 + 16; idx++)
430	{
431	cbPrint = RTStrPrintf(pszOut, cbRemain, "%c", (idx >= cb) ? ' ' : (pv[idx] >= 0x20 && pv[idx] <= 0x7e ? pv[idx] : '.'));
432	ADJCURSOR(cbPrint);
433	}
434	*pszOut++ = '\n';
435	--cbRemain;
436	}
437	Log(("%s\n", pszBuf));
438	RTMemFree(pszBuf);
439	RT_NOREF2(uBase, pv);
440	#undef ADJCURSOR
441	}
442
443	/* API FUnction: See header file */
444	void virtioCoreGCPhysHexDump(PPDMDEVINS pDevIns, RTGCPHYS GCPhys, uint16_t cb, uint32_t uBase, const char *pszTitle)
445	{
446	PVIRTIOCORE pVirtio = PDMDEVINS_2_DATA(pDevIns, PVIRTIOCORE);
447	#define ADJCURSOR(cb) pszOut += cb; cbRemain -= cb;
448	size_t cbPrint = 0, cbRemain = ((cb / 16) + 1) * 80;
449	char pszBuf = (char )RTMemAllocZ(cbRemain), *pszOut = pszBuf;
450	AssertMsgReturnVoid(pszBuf, ("Out of Memory"));
451	if (pszTitle)
452	{
453	cbPrint = RTStrPrintf(pszOut, cbRemain, "%s [%d bytes]:\n", pszTitle, cb);
454	ADJCURSOR(cbPrint);
455	}
456	for (uint16_t row = 0; row < (uint16_t)RT_MAX(1, (cb / 16) + 1) && row * 16 < cb; row++)
457	{
458	uint8_t c;
459	cbPrint = RTStrPrintf(pszOut, cbRemain, "%04x: ", row * 16 + uBase); /* line address */
460	ADJCURSOR(cbPrint);
461	for (uint8_t col = 0; col < 16; col++)
462	{
463	uint32_t idx = row * 16 + col;
464	virtioCoreGCPhysRead(pVirtio, pDevIns, GCPhys + idx, &c, 1);
465	if (idx >= cb)
466	cbPrint = RTStrPrintf(pszOut, cbRemain, "-- %s", (col + 1) % 8 ? "" : " ");
467	else
468	cbPrint = RTStrPrintf(pszOut, cbRemain, "%02x %s", c, (col + 1) % 8 ? "" : " ");
469	ADJCURSOR(cbPrint);
470	}
471	for (uint16_t idx = row * 16; idx < row * 16 + 16; idx++)
472	{
473	virtioCoreGCPhysRead(pVirtio, pDevIns, GCPhys + idx, &c, 1);
474	cbPrint = RTStrPrintf(pszOut, cbRemain, "%c", (idx >= cb) ? ' ' : (c >= 0x20 && c <= 0x7e ? c : '.'));
475	ADJCURSOR(cbPrint);
476	}
477	*pszOut++ = '\n';
478	--cbRemain;
479	}
480	Log(("%s\n", pszBuf));
481	RTMemFree(pszBuf);
482	RT_NOREF(uBase);
483	#undef ADJCURSOR
484	}
485
486
487	/** API function: See header file */
488	void virtioCoreLogMappedIoValue(const char pszFunc, const char pszMember, uint32_t uMemberSize,
489	const void *pv, uint32_t cb, uint32_t uOffset, int fWrite,
490	int fHasIndex, uint32_t idx)
491	{
492	if (LogIs6Enabled())
493	{
494	char szIdx[16];
495	if (fHasIndex)
496	RTStrPrintf(szIdx, sizeof(szIdx), "[%d]", idx);
497	else
498	szIdx[0] = '\0';
499
500	if (cb == 1 \|\| cb == 2 \|\| cb == 4 \|\| cb == 8)
501	{
502	char szDepiction[64];
503	size_t cchDepiction;
504	if (uOffset != 0 \|\| cb != uMemberSize) /* display bounds if partial member access */
505	cchDepiction = RTStrPrintf(szDepiction, sizeof(szDepiction), "%s%s[%d:%d]",
506	pszMember, szIdx, uOffset, uOffset + cb - 1);
507	else
508	cchDepiction = RTStrPrintf(szDepiction, sizeof(szDepiction), "%s%s", pszMember, szIdx);
509
510	/* padding */
511	if (cchDepiction < 30)
512	szDepiction[cchDepiction++] = ' ';
513	while (cchDepiction < 30)
514	szDepiction[cchDepiction++] = '.';
515	szDepiction[cchDepiction] = '\0';
516
517	RTUINT64U uValue;
518	uValue.u = 0;
519	memcpy(uValue.au8, pv, cb);
520	Log6(("%-23s: Guest %s %s %#0*RX64\n",
521	pszFunc, fWrite ? "wrote" : "read ", szDepiction, 2 + cb * 2, uValue.u));
522	}
523	else /* odd number or oversized access, ... log inline hex-dump style */
524	{
525	Log6(("%-23s: Guest %s %s%s[%d:%d]: %.*Rhxs\n",
526	pszFunc, fWrite ? "wrote" : "read ", pszMember,
527	szIdx, uOffset, uOffset + cb, cb, pv));
528	}
529	}
530	RT_NOREF2(fWrite, pszFunc);
531	}
532
533	/**
534	* Log MMIO-mapped Virtio fDeviceStatus register bitmask, naming the bits
535	*/
536	DECLINLINE(void) virtioCoreFormatDeviceStatus(uint8_t bStatus, char *pszBuf, size_t uSize)
537	{
538	# define ADJCURSOR(len) { cp += len; uSize -= len; sep = (char *)" \| "; }
539	memset(pszBuf, 0, uSize);
540	char cp = pszBuf, sep = (char *)"";
541	size_t len;
542	if (bStatus == 0)
543	RTStrPrintf(cp, uSize, "RESET");
544	else
545	{
546	if (bStatus & VIRTIO_STATUS_ACKNOWLEDGE)
547	{
548	len = RTStrPrintf(cp, uSize, "ACKNOWLEDGE");
549	ADJCURSOR(len);
550	}
551	if (bStatus & VIRTIO_STATUS_DRIVER)
552	{
553	len = RTStrPrintf(cp, uSize, "%sDRIVER", sep);
554	ADJCURSOR(len);
555	}
556	if (bStatus & VIRTIO_STATUS_FEATURES_OK)
557	{
558	len = RTStrPrintf(cp, uSize, "%sFEATURES_OK", sep);
559	ADJCURSOR(len);
560	}
561	if (bStatus & VIRTIO_STATUS_DRIVER_OK)
562	{
563	len = RTStrPrintf(cp, uSize, "%sDRIVER_OK", sep);
564	ADJCURSOR(len);
565	}
566	if (bStatus & VIRTIO_STATUS_FAILED)
567	{
568	len = RTStrPrintf(cp, uSize, "%sFAILED", sep);
569	ADJCURSOR(len);
570	}
571	if (bStatus & VIRTIO_STATUS_DEVICE_NEEDS_RESET)
572	RTStrPrintf(cp, uSize, "%sNEEDS_RESET", sep);
573	}
574	# undef ADJCURSOR
575	}
576
577	#endif /* LOG_ENABLED */
578
579	/** API function: See header file */
580	int virtioCoreIsLegacyMode(PVIRTIOCORE pVirtio)
581	{
582	return pVirtio->fLegacyDriver;
583	}
584
585	#ifdef IN_RING3
586
587	int virtioCoreR3VirtqAttach(PVIRTIOCORE pVirtio, uint16_t uVirtq, const char *pcszName)
588	{
589	LogFunc(("Attaching %s to VirtIO core\n", pcszName));
590	PVIRTQUEUE pVirtq = &pVirtio->aVirtqueues[uVirtq];
591	pVirtq->uVirtq = uVirtq;
592	pVirtq->fUsedRingEvent = false;
593	pVirtq->fAttached = true;
594	RTStrCopy(pVirtq->szName, sizeof(pVirtq->szName), pcszName);
595	return VINF_SUCCESS;
596	}
597
598	int virtioCoreR3VirtqDetach(PVIRTIOCORE pVirtio, uint16_t uVirtqNbr)
599	{
600	PVIRTQUEUE pVirtq = &pVirtio->aVirtqueues[uVirtqNbr];
601	pVirtq->uVirtq = 0;
602	pVirtq->uAvailIdxShadow = 0;
603	pVirtq->uUsedIdxShadow = 0;
604	pVirtq->fUsedRingEvent = false;
605	pVirtq->fAttached = false;
606	memset(pVirtq->szName, 0, sizeof(pVirtq->szName));
607	return VINF_SUCCESS;
608	}
609
610	bool virtioCoreR3VirtqIsAttached(PVIRTIOCORE pVirtio, uint16_t uVirtqNbr)
611	{
612	return pVirtio->aVirtqueues[uVirtqNbr].fAttached;
613	}
614
615	bool virtioCoreR3VirtqIsEnabled(PVIRTIOCORE pVirtio, uint16_t uVirtqNbr)
616	{
617	PVIRTQUEUE pVirtq = &pVirtio->aVirtqueues[uVirtqNbr];
618	return (bool)pVirtq->uEnable && pVirtq->GCPhysVirtqDesc;
619	}
620
621	/** API Fuunction: See header file */
622	void virtioCoreR3VirtqInfo(PPDMDEVINS pDevIns, PCDBGFINFOHLP pHlp, const char *pszArgs, int uVirtq)
623	{
624	RT_NOREF(pszArgs);
625	PVIRTIOCORE pVirtio = PDMDEVINS_2_DATA(pDevIns, PVIRTIOCORE);
626	PVIRTQUEUE pVirtq = &pVirtio->aVirtqueues[uVirtq];
627
628	/** @todo add ability to dump physical contents described by any descriptor (using existing VirtIO core API function) */
629	// bool fDump = pszArgs && (pszArgs == 'd' \|\| pszArgs == 'D'); /* "dump" (avail phys descriptor)"
630
631	uint16_t uAvailIdx = virtioReadAvailRingIdx(pDevIns, pVirtio, pVirtq);
632	uint16_t uAvailIdxShadow = pVirtq->uAvailIdxShadow;
633
634	uint16_t uUsedIdx = virtioReadUsedRingIdx(pDevIns, pVirtio, pVirtq);
635	uint16_t uUsedIdxShadow = pVirtq->uUsedIdxShadow;
636
637	#ifdef VIRTIO_VBUF_ON_STACK
638	VIRTQBUF_T VirtqBuf;
639	PVIRTQBUF pVirtqBuf = &VirtqBuf;
640	#else /* !VIRTIO_VBUF_ON_STACK */
641	PVIRTQBUF pVirtqBuf = NULL;
642	#endif /* !VIRTIO_VBUF_ON_STACK */
643
644	bool fEmpty = IS_VIRTQ_EMPTY(pDevIns, pVirtio, pVirtq);
645
646	LogFunc(("%s, empty = %s\n", pVirtq->szName, fEmpty ? "true" : "false"));
647
648	int cSendSegs = 0, cReturnSegs = 0;
649	if (!fEmpty)
650	{
651	#ifdef VIRTIO_VBUF_ON_STACK
652	virtioCoreR3VirtqAvailBufPeek(pDevIns, pVirtio, uVirtq, pVirtqBuf);
653	#else /* !VIRTIO_VBUF_ON_STACK */
654	virtioCoreR3VirtqAvailBufPeek(pDevIns, pVirtio, uVirtq, &pVirtqBuf);
655	#endif /* !VIRTIO_VBUF_ON_STACK */
656	cSendSegs = pVirtqBuf->pSgPhysSend ? pVirtqBuf->pSgPhysSend->cSegs : 0;
657	cReturnSegs = pVirtqBuf->pSgPhysReturn ? pVirtqBuf->pSgPhysReturn->cSegs : 0;
658	}
659
660	bool fAvailNoInterrupt = virtioReadAvailRingFlags(pDevIns, pVirtio, pVirtq) & VIRTQ_AVAIL_F_NO_INTERRUPT;
661	bool fUsedNoNotify = virtioReadUsedRingFlags(pDevIns, pVirtio, pVirtq) & VIRTQ_USED_F_NO_NOTIFY;
662
663	pHlp->pfnPrintf(pHlp, " queue enabled: ........... %s\n", pVirtq->uEnable ? "true" : "false");
664	pHlp->pfnPrintf(pHlp, " size: .................... %d\n", pVirtq->uQueueSize);
665	pHlp->pfnPrintf(pHlp, " notify offset: ........... %d\n", pVirtq->uNotifyOffset);
666	if (pVirtio->fMsiSupport)
667	pHlp->pfnPrintf(pHlp, " MSIX vector: ....... %4.4x\n", pVirtq->uMsixVector);
668	pHlp->pfnPrintf(pHlp, "\n");
669	pHlp->pfnPrintf(pHlp, " avail ring (%d entries):\n", uAvailIdx - uAvailIdxShadow);
670	pHlp->pfnPrintf(pHlp, " index: ................ %d\n", uAvailIdx);
671	pHlp->pfnPrintf(pHlp, " shadow: ............... %d\n", uAvailIdxShadow);
672	pHlp->pfnPrintf(pHlp, " flags: ................ %s\n", fAvailNoInterrupt ? "NO_INTERRUPT" : "");
673	pHlp->pfnPrintf(pHlp, "\n");
674	pHlp->pfnPrintf(pHlp, " used ring (%d entries):\n", uUsedIdx - uUsedIdxShadow);
675	pHlp->pfnPrintf(pHlp, " index: ................ %d\n", uUsedIdx);
676	pHlp->pfnPrintf(pHlp, " shadow: ............... %d\n", uUsedIdxShadow);
677	pHlp->pfnPrintf(pHlp, " flags: ................ %s\n", fUsedNoNotify ? "NO_NOTIFY" : "");
678	pHlp->pfnPrintf(pHlp, "\n");
679	if (!fEmpty)
680	{
681	pHlp->pfnPrintf(pHlp, " desc chain:\n");
682	pHlp->pfnPrintf(pHlp, " head idx: ............. %d\n", uUsedIdx);
683	pHlp->pfnPrintf(pHlp, " segs: ................. %d\n", cSendSegs + cReturnSegs);
684	pHlp->pfnPrintf(pHlp, " refCnt ................ %d\n", pVirtqBuf->cRefs);
685	pHlp->pfnPrintf(pHlp, "\n");
686	pHlp->pfnPrintf(pHlp, " host-to-guest (%d bytes):\n", pVirtqBuf->cbPhysSend);
687	pHlp->pfnPrintf(pHlp, " segs: .............. %d\n", cSendSegs);
688	if (cSendSegs)
689	{
690	pHlp->pfnPrintf(pHlp, " index: ............. %d\n", pVirtqBuf->pSgPhysSend->idxSeg);
691	pHlp->pfnPrintf(pHlp, " unsent ............. %d\n", pVirtqBuf->pSgPhysSend->cbSegLeft);
692	}
693	pHlp->pfnPrintf(pHlp, "\n");
694	pHlp->pfnPrintf(pHlp, " guest-to-host (%d bytes)\n", pVirtqBuf->cbPhysReturn);
695	pHlp->pfnPrintf(pHlp, " segs: .............. %d\n", cReturnSegs);
696	if (cReturnSegs)
697	{
698	pHlp->pfnPrintf(pHlp, " index: ............. %d\n", pVirtqBuf->pSgPhysReturn->idxSeg);
699	pHlp->pfnPrintf(pHlp, " unsent ............. %d\n", pVirtqBuf->pSgPhysReturn->cbSegLeft);
700	}
701	} else
702	pHlp->pfnPrintf(pHlp, " No desc chains available\n");
703	pHlp->pfnPrintf(pHlp, "\n");
704	}
705
706	#ifdef VIRTIO_VBUF_ON_STACK
707	/** API Function: See header file */
708	PVIRTQBUF virtioCoreR3VirtqBufAlloc(void)
709	{
710	PVIRTQBUF pVirtqBuf = (PVIRTQBUF)RTMemAllocZ(sizeof(VIRTQBUF_T));
711	AssertReturn(pVirtqBuf, NULL);
712	pVirtqBuf->u32Magic = VIRTQBUF_MAGIC;
713	pVirtqBuf->cRefs = 1;
714	return pVirtqBuf;
715	}
716	#endif /* VIRTIO_VBUF_ON_STACK */
717
718	/** API Function: See header file */
719	uint32_t virtioCoreR3VirtqBufRetain(PVIRTQBUF pVirtqBuf)
720	{
721	AssertReturn(pVirtqBuf, UINT32_MAX);
722	AssertReturn(pVirtqBuf->u32Magic == VIRTQBUF_MAGIC, UINT32_MAX);
723	uint32_t cRefs = ASMAtomicIncU32(&pVirtqBuf->cRefs);
724	Assert(cRefs > 1);
725	Assert(cRefs < 16);
726	return cRefs;
727	}
728
729	/** API Function: See header file */
730	uint32_t virtioCoreR3VirtqBufRelease(PVIRTIOCORE pVirtio, PVIRTQBUF pVirtqBuf)
731	{
732	if (!pVirtqBuf)
733	return 0;
734	AssertReturn(pVirtqBuf, 0);
735	AssertReturn(pVirtqBuf->u32Magic == VIRTQBUF_MAGIC, 0);
736	uint32_t cRefs = ASMAtomicDecU32(&pVirtqBuf->cRefs);
737	Assert(cRefs < 16);
738	if (cRefs == 0)
739	{
740	pVirtqBuf->u32Magic = ~VIRTQBUF_MAGIC;
741	RTMemFree(pVirtqBuf);
742	#ifdef VBOX_WITH_STATISTICS
743	STAM_REL_COUNTER_INC(&pVirtio->StatDescChainsFreed);
744	#endif
745	}
746	RT_NOREF(pVirtio);
747	return cRefs;
748	}
749
750	/** API Function: See header file */
751	void virtioCoreNotifyConfigChanged(PVIRTIOCORE pVirtio)
752	{
753	virtioNudgeGuest(pVirtio->pDevInsR3, pVirtio, VIRTIO_ISR_DEVICE_CONFIG, pVirtio->uMsixConfig);
754	}
755
756
757	/** API Function: See header file */
758	void virtioCoreVirtqEnableNotify(PVIRTIOCORE pVirtio, uint16_t uVirtq, bool fEnable)
759	{
760	Assert(uVirtq < RT_ELEMENTS(pVirtio->aVirtqueues));
761	PVIRTQUEUE pVirtq = &pVirtio->aVirtqueues[uVirtq];
762
763	if (IS_DRIVER_OK(pVirtio))
764	{
765	uint16_t fFlags = virtioReadUsedRingFlags(pVirtio->pDevInsR3, pVirtio, pVirtq);
766
767	if (fEnable)
768	fFlags &= ~VIRTQ_USED_F_NO_NOTIFY;
769	else
770	fFlags \|= VIRTQ_USED_F_NO_NOTIFY;
771
772	virtioWriteUsedRingFlags(pVirtio->pDevInsR3, pVirtio, pVirtq, fFlags);
773	}
774	}
775
776	/** API function: See Header file */
777	void virtioCoreResetAll(PVIRTIOCORE pVirtio)
778	{
779	LogFunc(("\n"));
780	pVirtio->fDeviceStatus \|= VIRTIO_STATUS_DEVICE_NEEDS_RESET;
781	if (IS_DRIVER_OK(pVirtio))
782	{
783	if (!pVirtio->fLegacyDriver)
784	pVirtio->fGenUpdatePending = true;
785	virtioNudgeGuest(pVirtio->pDevInsR3, pVirtio, VIRTIO_ISR_DEVICE_CONFIG, pVirtio->uMsixConfig);
786	}
787	}
788
789	/** API function: See Header file */
790	#ifdef VIRTIO_VBUF_ON_STACK
791	int virtioCoreR3VirtqAvailBufPeek(PPDMDEVINS pDevIns, PVIRTIOCORE pVirtio, uint16_t uVirtq, PVIRTQBUF pVirtqBuf)
792	{
793	return virtioCoreR3VirtqAvailBufGet(pDevIns, pVirtio, uVirtq, pVirtqBuf, false);
794	}
795	#else /* !VIRTIO_VBUF_ON_STACK */
796	int virtioCoreR3VirtqAvailBufPeek(PPDMDEVINS pDevIns, PVIRTIOCORE pVirtio, uint16_t uVirtq,
797	PPVIRTQBUF ppVirtqBuf)
798	{
799	return virtioCoreR3VirtqAvailBufGet(pDevIns, pVirtio, uVirtq, ppVirtqBuf, false);
800	}
801	#endif /* !VIRTIO_VBUF_ON_STACK */
802
803	/** API function: See Header file */
804	int virtioCoreR3VirtqAvailBufNext(PVIRTIOCORE pVirtio, uint16_t uVirtq)
805	{
806	Assert(uVirtq < RT_ELEMENTS(pVirtio->aVirtqueues));
807	PVIRTQUEUE pVirtq = &pVirtio->aVirtqueues[uVirtq];
808
809	if (!pVirtio->fLegacyDriver)
810	AssertMsgReturn((pVirtio->fDeviceStatus & VIRTIO_STATUS_DRIVER_OK) && pVirtq->uEnable,
811	("Guest driver not in ready state.\n"), VERR_INVALID_STATE);
812
813	if (IS_VIRTQ_EMPTY(pVirtio->pDevInsR3, pVirtio, pVirtq))
814	return VERR_NOT_AVAILABLE;
815
816	Log6Func(("%s avail shadow idx: %u\n", pVirtq->szName, pVirtq->uAvailIdxShadow));
817	pVirtq->uAvailIdxShadow++;
818
819	return VINF_SUCCESS;
820	}
821
822	/** API Function: See header file */
823	#ifdef VIRTIO_VBUF_ON_STACK
824	int virtioCoreR3VirtqAvailBufGet(PPDMDEVINS pDevIns, PVIRTIOCORE pVirtio, uint16_t uVirtq,
825	uint16_t uHeadIdx, PVIRTQBUF pVirtqBuf)
826	#else /* !VIRTIO_VBUF_ON_STACK */
827	int virtioCoreR3VirtqAvailBufGet(PPDMDEVINS pDevIns, PVIRTIOCORE pVirtio, uint16_t uVirtq,
828	uint16_t uHeadIdx, PPVIRTQBUF ppVirtqBuf)
829	#endif /* !VIRTIO_VBUF_ON_STACK */
830	{
831	#ifndef VIRTIO_VBUF_ON_STACK
832	AssertReturn(ppVirtqBuf, VERR_INVALID_POINTER);
833	*ppVirtqBuf = NULL;
834	#endif /* !VIRTIO_VBUF_ON_STACK */
835
836	AssertMsgReturn(uVirtq < RT_ELEMENTS(pVirtio->aVirtqueues),
837	("uVirtq out of range"), VERR_INVALID_PARAMETER);
838
839	PVIRTQUEUE pVirtq = &pVirtio->aVirtqueues[uVirtq];
840
841	if (!pVirtio->fLegacyDriver)
842	AssertMsgReturn((pVirtio->fDeviceStatus & VIRTIO_STATUS_DRIVER_OK) && pVirtq->uEnable,
843	("Guest driver not in ready state.\n"), VERR_INVALID_STATE);
844
845	uint16_t uDescIdx = uHeadIdx;
846
847	Log6Func(("%s DESC CHAIN: (head idx = %u)\n", pVirtio->aVirtqueues[uVirtq].szName, uHeadIdx));
848
849	/*
850	* Allocate and initialize the descriptor chain structure.
851	*/
852	#ifndef VIRTIO_VBUF_ON_STACK
853	PVIRTQBUF pVirtqBuf = (PVIRTQBUF)RTMemAllocZ(sizeof(VIRTQBUF_T));
854	AssertReturn(pVirtqBuf, VERR_NO_MEMORY);
855	#endif /* !VIRTIO_VBUF_ON_STACK */
856	pVirtqBuf->u32Magic = VIRTQBUF_MAGIC;
857	pVirtqBuf->cRefs = 1;
858	pVirtqBuf->uHeadIdx = uHeadIdx;
859	pVirtqBuf->uVirtq = uVirtq;
860	#ifndef VIRTIO_VBUF_ON_STACK
861	*ppVirtqBuf = pVirtqBuf;
862	#endif /* !VIRTIO_VBUF_ON_STACK */
863
864	/*
865	* Gather segments.
866	*/
867	VIRTQ_DESC_T desc;
868
869	uint32_t cbIn = 0;
870	uint32_t cbOut = 0;
871	uint32_t cSegsIn = 0;
872	uint32_t cSegsOut = 0;
873
874	PVIRTIOSGSEG paSegsIn = pVirtqBuf->aSegsIn;
875	PVIRTIOSGSEG paSegsOut = pVirtqBuf->aSegsOut;
876
877	do
878	{
879	PVIRTIOSGSEG pSeg;
880	/*
881	* Malicious guests may go beyond paSegsIn or paSegsOut boundaries by linking
882	* several descriptors into a loop. Since there is no legitimate way to get a sequences of
883	* linked descriptors exceeding the total number of descriptors in the ring (see @bugref{8620}),
884	* the following aborts I/O if breach and employs a simple log throttling algorithm to notify.
885	*/
886	if (cSegsIn + cSegsOut >= pVirtq->uQueueSize)
887	{
888	static volatile uint32_t s_cMessages = 0;
889	static volatile uint32_t s_cThreshold = 1;
890	if (ASMAtomicIncU32(&s_cMessages) == ASMAtomicReadU32(&s_cThreshold))
891	{
892	LogRelMax(64, ("Too many linked descriptors; check if the guest arranges descriptors in a loop.\n"));
893	if (ASMAtomicReadU32(&s_cMessages) != 1)
894	LogRelMax(64, ("(the above error has occured %u times so far)\n", ASMAtomicReadU32(&s_cMessages)));
895	ASMAtomicWriteU32(&s_cThreshold, ASMAtomicReadU32(&s_cThreshold) * 10);
896	}
897	break;
898	}
899	RT_UNTRUSTED_VALIDATED_FENCE();
900
901	virtioReadDesc(pDevIns, pVirtio, pVirtq, uDescIdx, &desc);
902
903	if (desc.fFlags & VIRTQ_DESC_F_WRITE)
904	{
905	Log6Func(("%s IN idx=%-4u seg=%-3u addr=%RGp cb=%u\n", pVirtq->szName, uDescIdx, cSegsIn, desc.GCPhysBuf, desc.cb));
906	cbIn += desc.cb;
907	pSeg = &paSegsIn[cSegsIn++];
908	}
909	else
910	{
911	Log6Func(("%s OUT desc_idx=%-4u seg=%-3u addr=%RGp cb=%u\n", pVirtq->szName, uDescIdx, cSegsOut, desc.GCPhysBuf, desc.cb));
912	cbOut += desc.cb;
913	pSeg = &paSegsOut[cSegsOut++];
914	#ifdef DEEP_DEBUG
915	if (LogIs11Enabled())
916	{
917	virtioCoreGCPhysHexDump(pDevIns, desc.GCPhysBuf, desc.cb, 0, NULL);
918	Log(("\n"));
919	}
920	#endif
921	}
922	pSeg->GCPhys = desc.GCPhysBuf;
923	pSeg->cbSeg = desc.cb;
924	uDescIdx = desc.uDescIdxNext;
925	} while (desc.fFlags & VIRTQ_DESC_F_NEXT);
926
927	/*
928	* Add segments to the descriptor chain structure.
929	*/
930	if (cSegsIn)
931	{
932	virtioCoreGCPhysChainInit(&pVirtqBuf->SgBufIn, paSegsIn, cSegsIn);
933	pVirtqBuf->pSgPhysReturn = &pVirtqBuf->SgBufIn;
934	pVirtqBuf->cbPhysReturn = cbIn;
935	#ifdef VBOX_WITH_STATISTICS
936	STAM_REL_COUNTER_ADD(&pVirtio->StatDescChainsSegsIn, cSegsIn);
937	#endif
938	}
939
940	if (cSegsOut)
941	{
942	virtioCoreGCPhysChainInit(&pVirtqBuf->SgBufOut, paSegsOut, cSegsOut);
943	pVirtqBuf->pSgPhysSend = &pVirtqBuf->SgBufOut;
944	pVirtqBuf->cbPhysSend = cbOut;
945	#ifdef VBOX_WITH_STATISTICS
946	STAM_REL_COUNTER_ADD(&pVirtio->StatDescChainsSegsOut, cSegsOut);
947	#endif
948	}
949
950	#ifdef VBOX_WITH_STATISTICS
951	STAM_REL_COUNTER_INC(&pVirtio->StatDescChainsAllocated);
952	#endif
953	Log6Func(("%s -- segs OUT: %u (%u bytes) IN: %u (%u bytes) --\n",
954	pVirtq->szName, cSegsOut, cbOut, cSegsIn, cbIn));
955
956	return VINF_SUCCESS;
957	}
958
959	/** API function: See Header file */
960	#ifdef VIRTIO_VBUF_ON_STACK
961	int virtioCoreR3VirtqAvailBufGet(PPDMDEVINS pDevIns, PVIRTIOCORE pVirtio, uint16_t uVirtq,
962	PVIRTQBUF pVirtqBuf, bool fRemove)
963	#else /* !VIRTIO_VBUF_ON_STACK */
964	int virtioCoreR3VirtqAvailBufGet(PPDMDEVINS pDevIns, PVIRTIOCORE pVirtio, uint16_t uVirtq,
965	PPVIRTQBUF ppVirtqBuf, bool fRemove)
966	#endif /* !VIRTIO_VBUF_ON_STACK */
967	{
968	Assert(uVirtq < RT_ELEMENTS(pVirtio->aVirtqueues));
969	PVIRTQUEUE pVirtq = &pVirtio->aVirtqueues[uVirtq];
970
971	if (IS_VIRTQ_EMPTY(pDevIns, pVirtio, pVirtq))
972	return VERR_NOT_AVAILABLE;
973
974	uint16_t uHeadIdx = virtioReadAvailDescIdx(pDevIns, pVirtio, pVirtq, pVirtq->uAvailIdxShadow);
975
976	if (pVirtio->uDriverFeatures & VIRTIO_F_EVENT_IDX)
977	virtioWriteUsedAvailEvent(pDevIns,pVirtio, pVirtq, pVirtq->uAvailIdxShadow + 1);
978
979	if (fRemove)
980	pVirtq->uAvailIdxShadow++;
981
982	#ifdef VIRTIO_VBUF_ON_STACK
983	int rc = virtioCoreR3VirtqAvailBufGet(pDevIns, pVirtio, uVirtq, uHeadIdx, pVirtqBuf);
984	#else /* !VIRTIO_VBUF_ON_STACK */
985	int rc = virtioCoreR3VirtqAvailBufGet(pDevIns, pVirtio, uVirtq, uHeadIdx, ppVirtqBuf);
986	#endif /* !VIRTIO_VBUF_ON_STACK */
987	return rc;
988	}
989
990	/** API function: See Header file */
991	int virtioCoreR3VirtqUsedBufPut(PPDMDEVINS pDevIns, PVIRTIOCORE pVirtio, uint16_t uVirtq, PRTSGBUF pSgVirtReturn,
992	PVIRTQBUF pVirtqBuf, bool fFence)
993	{
994	Assert(uVirtq < RT_ELEMENTS(pVirtio->aVirtqueues));
995	PVIRTQUEUE pVirtq = &pVirtio->aVirtqueues[uVirtq];
996
997	PVIRTIOSGBUF pSgPhysReturn = pVirtqBuf->pSgPhysReturn;
998
999	Assert(pVirtqBuf->u32Magic == VIRTQBUF_MAGIC);
1000	Assert(pVirtqBuf->cRefs > 0);
1001
1002	/*
1003	* Workaround for a bug in FreeBSD's virtio-net driver up until 12.3 which supports only the legacy style devive.
1004	* When the device is re-initialized from the driver it violates the spec and posts commands to the control queue
1005	* before setting the DRIVER_OK flag, breaking the following check and rendering the device non-functional.
1006	* The queues are properly set up at this stage however so no real harm is done and we can safely continue here,
1007	* for the legacy device only of course after making sure the queue is properly set up.
1008	*/
1009	AssertMsgReturn( IS_DRIVER_OK(pVirtio)
1010	\|\| ( pVirtio->fLegacyDriver
1011	&& pVirtq->GCPhysVirtqDesc),
1012	("Guest driver not in ready state.\n"), VERR_INVALID_STATE);
1013
1014	Log6Func((" Copying device data to %s, [desc:%u -> used ring:%u]\n",
1015	VIRTQNAME(pVirtio, uVirtq), pVirtqBuf->uHeadIdx, pVirtq->uUsedIdxShadow));
1016
1017	/* Copy s/g buf (virtual memory) to guest phys mem (VirtIO "IN" direction). */
1018
1019	size_t cbCopy = 0, cbTotal = 0, cbRemain = 0;
1020
1021	if (pSgVirtReturn)
1022	{
1023	size_t cbTarget = virtioCoreGCPhysChainCalcBufSize(pSgPhysReturn);
1024	cbRemain = cbTotal = RTSgBufCalcTotalLength(pSgVirtReturn);
1025	AssertMsgReturn(cbTarget >= cbRemain, ("No space to write data to phys memory"), VERR_BUFFER_OVERFLOW);
1026	virtioCoreGCPhysChainReset(pSgPhysReturn);
1027	while (cbRemain)
1028	{
1029	cbCopy = RT_MIN(pSgVirtReturn->cbSegLeft, pSgPhysReturn->cbSegLeft);
1030	Assert(cbCopy > 0);
1031	virtioCoreGCPhysWrite(pVirtio, pDevIns, (RTGCPHYS)pSgPhysReturn->GCPhysCur, pSgVirtReturn->pvSegCur, cbCopy);
1032	RTSgBufAdvance(pSgVirtReturn, cbCopy);
1033	virtioCoreGCPhysChainAdvance(pSgPhysReturn, cbCopy);
1034	cbRemain -= cbCopy;
1035	}
1036
1037	if (fFence)
1038	RT_UNTRUSTED_NONVOLATILE_COPY_FENCE(); /* needed? */
1039
1040	Assert(!(cbCopy >> 32));
1041	}
1042
1043	/* Flag if write-ahead crosses threshold where guest driver indicated it wants event notification */
1044	if (pVirtio->uDriverFeatures & VIRTIO_F_EVENT_IDX)
1045	if (pVirtq->uUsedIdxShadow == virtioReadAvailUsedEvent(pDevIns, pVirtio, pVirtq))
1046	pVirtq->fUsedRingEvent = true;
1047
1048	/*
1049	* Place used buffer's descriptor in used ring but don't update used ring's slot index.
1050	* That will be done with a subsequent client call to virtioCoreVirtqUsedRingSync()
1051	*
1052	* @todo r=aeichner: The increment of the shadow index is not atomic but this code can be called
1053	* concurrently!!
1054	*/
1055	virtioWriteUsedElem(pDevIns, pVirtio, pVirtq, pVirtq->uUsedIdxShadow++, pVirtqBuf->uHeadIdx, (uint32_t)cbTotal);
1056
1057	#ifdef LOG_ENABLED
1058	if (LogIs6Enabled() && pSgVirtReturn)
1059	{
1060
1061	LogFunc((" ... %d segs, %zu bytes, copied to %u byte buf@offset=%u. Residual: %zu bytes\n",
1062	pSgVirtReturn->cSegs, cbTotal - cbRemain, pVirtqBuf->cbPhysReturn,
1063	((virtioCoreGCPhysChainCalcBufSize(pVirtqBuf->pSgPhysReturn) -
1064	virtioCoreGCPhysChainCalcLengthLeft(pVirtqBuf->pSgPhysReturn)) - (cbTotal - cbRemain)),
1065	virtioCoreGCPhysChainCalcLengthLeft(pVirtqBuf->pSgPhysReturn) ));
1066
1067	uint16_t uPending = virtioCoreR3CountPendingBufs(
1068	virtioReadUsedRingIdx(pDevIns, pVirtio, pVirtq),
1069	pVirtq->uUsedIdxShadow, pVirtq->uQueueSize);
1070
1071	LogFunc((" %u used buf%s not synced in %s\n", uPending, uPending == 1 ? "" : "s ",
1072	VIRTQNAME(pVirtio, uVirtq)));
1073	}
1074	#endif
1075	return VINF_SUCCESS;
1076	}
1077
1078	/** API function: See Header file */
1079	int virtioCoreR3VirtqUsedBufPut(PPDMDEVINS pDevIns, PVIRTIOCORE pVirtio, uint16_t uVirtq,
1080	size_t cb, void const *pv, PVIRTQBUF pVirtqBuf, size_t cbEnqueue, bool fFence)
1081	{
1082	Assert(uVirtq < RT_ELEMENTS(pVirtio->aVirtqueues));
1083	Assert(pv);
1084
1085	PVIRTQUEUE pVirtq = &pVirtio->aVirtqueues[uVirtq];
1086	PVIRTIOSGBUF pSgPhysReturn = pVirtqBuf->pSgPhysReturn;
1087
1088	Assert(pVirtqBuf->u32Magic == VIRTQBUF_MAGIC);
1089	Assert(pVirtqBuf->cRefs > 0);
1090
1091	AssertMsgReturn(IS_DRIVER_OK(pVirtio), ("Guest driver not in ready state.\n"), VERR_INVALID_STATE);
1092
1093	Log6Func((" Copying device data to %s, [desc chain head idx:%u]\n",
1094	VIRTQNAME(pVirtio, uVirtq), pVirtqBuf->uHeadIdx));
1095	/*
1096	* Convert virtual memory simple buffer to guest physical memory (VirtIO descriptor chain)
1097	*/
1098	uint8_t pvBuf = (uint8_t )pv;
1099	size_t cbRemain = cb, cbCopy = 0;
1100	while (cbRemain)
1101	{
1102	cbCopy = RT_MIN(pSgPhysReturn->cbSegLeft, cbRemain);
1103	Assert(cbCopy > 0);
1104	virtioCoreGCPhysWrite(pVirtio, pDevIns, (RTGCPHYS)pSgPhysReturn->GCPhysCur, pvBuf, cbCopy);
1105	virtioCoreGCPhysChainAdvance(pSgPhysReturn, cbCopy);
1106	pvBuf += cbCopy;
1107	cbRemain -= cbCopy;
1108	}
1109	LogFunc((" ...%zu bytes, copied to %u byte buf@offset=%u. Residual: %zu bytes\n",
1110	cb , pVirtqBuf->cbPhysReturn,
1111	((virtioCoreGCPhysChainCalcBufSize(pVirtqBuf->pSgPhysReturn) -
1112	virtioCoreGCPhysChainCalcLengthLeft(pVirtqBuf->pSgPhysReturn)) - cb),
1113	virtioCoreGCPhysChainCalcLengthLeft(pVirtqBuf->pSgPhysReturn)));
1114
1115	if (cbEnqueue)
1116	{
1117	if (fFence)
1118	{
1119	RT_UNTRUSTED_NONVOLATILE_COPY_FENCE(); /* needed? */
1120	Assert(!(cbCopy >> 32));
1121	}
1122	/* Flag if write-ahead crosses threshold where guest driver indicated it wants event notification */
1123	if (pVirtio->uDriverFeatures & VIRTIO_F_EVENT_IDX)
1124	if (pVirtq->uUsedIdxShadow == virtioReadAvailUsedEvent(pDevIns, pVirtio, pVirtq))
1125	pVirtq->fUsedRingEvent = true;
1126	/*
1127	* Place used buffer's descriptor in used ring but don't update used ring's slot index.
1128	* That will be done with a subsequent client call to virtioCoreVirtqUsedRingSync()
1129	*/
1130	Log6Func((" Enqueue desc chain head idx %u to %s used ring @ %u\n", pVirtqBuf->uHeadIdx,
1131	VIRTQNAME(pVirtio, uVirtq), pVirtq->uUsedIdxShadow));
1132
1133	virtioWriteUsedElem(pDevIns, pVirtio, pVirtq, pVirtq->uUsedIdxShadow++, pVirtqBuf->uHeadIdx, (uint32_t)cbEnqueue);
1134
1135	#ifdef LOG_ENABLED
1136	if (LogIs6Enabled())
1137	{
1138	uint16_t uPending = virtioCoreR3CountPendingBufs(
1139	virtioReadUsedRingIdx(pDevIns, pVirtio, pVirtq),
1140	pVirtq->uUsedIdxShadow, pVirtq->uQueueSize);
1141
1142	LogFunc((" %u used buf%s not synced in %s\n",
1143	uPending, uPending == 1 ? "" : "s ", VIRTQNAME(pVirtio, uVirtq)));
1144	}
1145	#endif
1146	} /* fEnqueue */
1147
1148	return VINF_SUCCESS;
1149	}
1150
1151
1152	#endif /* IN_RING3 */
1153
1154	/** API function: See Header file */
1155	int virtioCoreVirtqUsedRingSync(PPDMDEVINS pDevIns, PVIRTIOCORE pVirtio, uint16_t uVirtq)
1156	{
1157	Assert(uVirtq < RT_ELEMENTS(pVirtio->aVirtqueues));
1158	PVIRTQUEUE pVirtq = &pVirtio->aVirtqueues[uVirtq];
1159
1160	if (!pVirtio->fLegacyDriver)
1161	AssertMsgReturn((pVirtio->fDeviceStatus & VIRTIO_STATUS_DRIVER_OK) && pVirtq->uEnable,
1162	("Guest driver not in ready state.\n"), VERR_INVALID_STATE);
1163
1164	Log6Func((" Sync %s used ring (%u -> idx)\n",
1165	pVirtq->szName, pVirtq->uUsedIdxShadow));
1166
1167	virtioWriteUsedRingIdx(pDevIns, pVirtio, pVirtq, pVirtq->uUsedIdxShadow);
1168	virtioCoreNotifyGuestDriver(pDevIns, pVirtio, uVirtq);
1169
1170	return VINF_SUCCESS;
1171	}
1172
1173	/**
1174	* This is called from the MMIO callback code when the guest does an MMIO access to the
1175	* mapped queue notification capability area corresponding to a particular queue, to notify
1176	* the queue handler of available data in the avail ring of the queue (VirtIO 1.0, 4.1.4.4.1)
1177	*
1178	* @param pDevIns The device instance.
1179	* @param pVirtio Pointer to the shared virtio state.
1180	* @param uVirtq Virtq to check for guest interrupt handling preference
1181	* @param uNotifyIdx Notification index
1182	*/
1183	static void virtioCoreVirtqNotified(PPDMDEVINS pDevIns, PVIRTIOCORE pVirtio, uint16_t uVirtq, uint16_t uNotifyIdx)
1184	{
1185	PVIRTIOCORECC pVirtioCC = PDMINS_2_DATA_CC(pDevIns, PVIRTIOCORECC);
1186
1187	/* VirtIO 1.0, section 4.1.5.2 implies uVirtq and uNotifyIdx should match. Disregarding any of
1188	* these notifications (if those indicies disagree) may break device/driver synchronization,
1189	* causing eternal throughput starvation, yet there's no specified way to disambiguate
1190	* which queue to wake-up in any awkward situation where the two parameters differ.
1191	*/
1192	AssertMsg(uNotifyIdx == uVirtq,
1193	("Guest kicked virtq %d's notify addr w/non-corresponding virtq idx %d\n",
1194	uVirtq, uNotifyIdx));
1195	RT_NOREF(uNotifyIdx);
1196
1197	AssertReturnVoid(uVirtq < RT_ELEMENTS(pVirtio->aVirtqueues));
1198	PVIRTQUEUE pVirtq = &pVirtio->aVirtqueues[uVirtq];
1199
1200	Log6Func(("%s: (desc chains: %u)\n", *pVirtq->szName ? pVirtq->szName : "?UNAMED QUEUE?",
1201	virtioCoreVirtqAvailCnt(pDevIns, pVirtio, pVirtq)));
1202
1203	/* Inform client */
1204	pVirtioCC->pfnVirtqNotified(pDevIns, pVirtio, uVirtq);
1205	RT_NOREF2(pVirtio, pVirtq);
1206	}
1207
1208	/**
1209	* Trigger MSI-X or INT# interrupt to notify guest of data added to used ring of
1210	* the specified virtq, depending on the interrupt configuration of the device
1211	* and depending on negotiated and realtime constraints flagged by the guest driver.
1212	*
1213	* See VirtIO 1.0 specification (section 2.4.7).
1214	*
1215	* @param pDevIns The device instance.
1216	* @param pVirtio Pointer to the shared virtio state.
1217	* @param uVirtq Virtq to check for guest interrupt handling preference
1218	*/
1219	static void virtioCoreNotifyGuestDriver(PPDMDEVINS pDevIns, PVIRTIOCORE pVirtio, uint16_t uVirtq)
1220	{
1221	Assert(uVirtq < RT_ELEMENTS(pVirtio->aVirtqueues));
1222	PVIRTQUEUE pVirtq = &pVirtio->aVirtqueues[uVirtq];
1223
1224	if (!IS_DRIVER_OK(pVirtio))
1225	{
1226	LogFunc(("Guest driver not in ready state.\n"));
1227	return;
1228	}
1229
1230	if (pVirtio->uDriverFeatures & VIRTIO_F_EVENT_IDX)
1231	{
1232	if (pVirtq->fUsedRingEvent)
1233	{
1234	#ifdef IN_RING3
1235	Log6Func(("...kicking guest %s, VIRTIO_F_EVENT_IDX set and threshold (%d) reached\n",
1236	pVirtq->szName, (uint16_t)virtioReadAvailUsedEvent(pDevIns, pVirtio, pVirtq)));
1237	#endif
1238	virtioNudgeGuest(pDevIns, pVirtio, VIRTIO_ISR_VIRTQ_INTERRUPT, pVirtq->uMsixVector);
1239	pVirtq->fUsedRingEvent = false;
1240	return;
1241	}
1242	#ifdef IN_RING3
1243	Log6Func(("...skip interrupt %s, VIRTIO_F_EVENT_IDX set but threshold (%d) not reached (%d)\n",
1244	pVirtq->szName,(uint16_t)virtioReadAvailUsedEvent(pDevIns, pVirtio, pVirtq), pVirtq->uUsedIdxShadow));
1245	#endif
1246	}
1247	else
1248	{
1249	/** If guest driver hasn't suppressed interrupts, interrupt */
1250	if (!(virtioReadAvailRingFlags(pDevIns, pVirtio, pVirtq) & VIRTQ_AVAIL_F_NO_INTERRUPT))
1251	{
1252	virtioNudgeGuest(pDevIns, pVirtio, VIRTIO_ISR_VIRTQ_INTERRUPT, pVirtq->uMsixVector);
1253	return;
1254	}
1255	Log6Func(("...skipping interrupt for %s (guest set VIRTQ_AVAIL_F_NO_INTERRUPT)\n", pVirtq->szName));
1256	}
1257	}
1258
1259	/**
1260	* Raise interrupt or MSI-X
1261	*
1262	* @param pDevIns The device instance.
1263	* @param pVirtio Pointer to the shared virtio state.
1264	* @param uCause Interrupt cause bit mask to set in PCI ISR port.
1265	* @param uVec MSI-X vector, if enabled
1266	*/
1267	static int virtioNudgeGuest(PPDMDEVINS pDevIns, PVIRTIOCORE pVirtio, uint8_t uCause, uint16_t uMsixVector)
1268	{
1269	if (uCause == VIRTIO_ISR_VIRTQ_INTERRUPT)
1270	Log6Func(("Reason for interrupt - buffer added to 'used' ring.\n"));
1271	else
1272	if (uCause == VIRTIO_ISR_DEVICE_CONFIG)
1273	Log6Func(("Reason for interrupt - device config change\n"));
1274
1275	if (!pVirtio->fMsiSupport)
1276	{
1277	pVirtio->uISR \|= uCause;
1278	PDMDevHlpPCISetIrq(pDevIns, 0, PDM_IRQ_LEVEL_HIGH);
1279	}
1280	else if (uMsixVector != VIRTIO_MSI_NO_VECTOR)
1281	PDMDevHlpPCISetIrq(pDevIns, uMsixVector, 1);
1282	return VINF_SUCCESS;
1283	}
1284
1285	/**
1286	* Lower interrupt (Called when guest reads ISR and when resetting)
1287	*
1288	* @param pDevIns The device instance.
1289	*/
1290	static void virtioLowerInterrupt(PPDMDEVINS pDevIns, uint16_t uMsixVector)
1291	{
1292	PVIRTIOCORE pVirtio = PDMINS_2_DATA(pDevIns, PVIRTIOCORE);
1293	if (!pVirtio->fMsiSupport)
1294	PDMDevHlpPCISetIrq(pDevIns, 0, PDM_IRQ_LEVEL_LOW);
1295	else if (uMsixVector != VIRTIO_MSI_NO_VECTOR)
1296	PDMDevHlpPCISetIrq(pDevIns, pVirtio->uMsixConfig, PDM_IRQ_LEVEL_LOW);
1297	}
1298
1299	#ifdef IN_RING3
1300	static void virtioResetVirtq(PVIRTIOCORE pVirtio, uint16_t uVirtq)
1301	{
1302	Assert(uVirtq < RT_ELEMENTS(pVirtio->aVirtqueues));
1303	PVIRTQUEUE pVirtq = &pVirtio->aVirtqueues[uVirtq];
1304
1305	pVirtq->uQueueSize = VIRTQ_SIZE;
1306	pVirtq->uEnable = false;
1307	pVirtq->uNotifyOffset = uVirtq;
1308	pVirtq->fUsedRingEvent = false;
1309	pVirtq->uAvailIdxShadow = 0;
1310	pVirtq->uUsedIdxShadow = 0;
1311	pVirtq->uMsixVector = uVirtq + 2;
1312
1313	if (!pVirtio->fMsiSupport) /* VirtIO 1.0, 4.1.4.3 and 4.1.5.1.2 */
1314	pVirtq->uMsixVector = VIRTIO_MSI_NO_VECTOR;
1315
1316	virtioLowerInterrupt(pVirtio->pDevInsR3, pVirtq->uMsixVector);
1317	}
1318
1319	static void virtioResetDevice(PPDMDEVINS pDevIns, PVIRTIOCORE pVirtio)
1320	{
1321	LogFunc(("Resetting device VirtIO state\n"));
1322	pVirtio->fLegacyDriver = pVirtio->fOfferLegacy; /* Cleared if VIRTIO_F_VERSION_1 feature ack'd */
1323	pVirtio->uDeviceFeaturesSelect = 0;
1324	pVirtio->uDriverFeaturesSelect = 0;
1325	pVirtio->uConfigGeneration = 0;
1326	pVirtio->fDeviceStatus = 0;
1327	pVirtio->uISR = 0;
1328
1329	if (!pVirtio->fMsiSupport)
1330	virtioLowerInterrupt(pDevIns, 0);
1331	else
1332	{
1333	virtioLowerInterrupt(pDevIns, pVirtio->uMsixConfig);
1334	for (int i = 0; i < VIRTQ_MAX_COUNT; i++)
1335	virtioLowerInterrupt(pDevIns, pVirtio->aVirtqueues[i].uMsixVector);
1336	}
1337
1338	if (!pVirtio->fMsiSupport) /* VirtIO 1.0, 4.1.4.3 and 4.1.5.1.2 */
1339	pVirtio->uMsixConfig = VIRTIO_MSI_NO_VECTOR;
1340
1341	for (uint16_t uVirtq = 0; uVirtq < VIRTQ_MAX_COUNT; uVirtq++)
1342	virtioResetVirtq(pVirtio, uVirtq);
1343	}
1344
1345	/**
1346	* Invoked by this implementation when guest driver resets the device.
1347	* The driver itself will not until the device has read the status change.
1348	*/
1349	static void virtioGuestR3WasReset(PPDMDEVINS pDevIns, PVIRTIOCORE pVirtio, PVIRTIOCORECC pVirtioCC)
1350	{
1351	Log(("%-23s: Guest reset the device\n", __FUNCTION__));
1352
1353	/* Let the client know */
1354	pVirtioCC->pfnStatusChanged(pVirtio, pVirtioCC, 0 /* fDriverOk */);
1355	virtioResetDevice(pDevIns, pVirtio);
1356	}
1357
1358	DECLHIDDEN(void) virtioCoreR3ResetDevice(PPDMDEVINS pDevIns, PVIRTIOCORE pVirtio, PVIRTIOCORECC pVirtioCC)
1359	{
1360	virtioGuestR3WasReset(pDevIns, pVirtio, pVirtioCC);
1361	}
1362	#endif /* IN_RING3 */
1363
1364	/*
1365	* Determines whether guest virtio driver is modern or legacy and does callback
1366	* informing device-specific code that feature negotiation is complete.
1367	* Should be called only once (coordinated via the 'toggle' flag)
1368	*/
1369	#ifdef IN_RING3
1370	DECLINLINE(void) virtioR3DoFeaturesCompleteOnceOnly(PVIRTIOCORE pVirtio, PVIRTIOCORECC pVirtioCC)
1371	{
1372	if (pVirtio->uDriverFeatures & VIRTIO_F_VERSION_1)
1373	{
1374	LogFunc(("VIRTIO_F_VERSION_1 feature ack'd by guest\n"));
1375	pVirtio->fLegacyDriver = 0;
1376	}
1377	else
1378	{
1379	if (pVirtio->fOfferLegacy)
1380	{
1381	pVirtio->fLegacyDriver = 1;
1382	LogFunc(("VIRTIO_F_VERSION_1 feature was NOT set by guest\n"));
1383	}
1384	else
1385	AssertMsgFailed(("Guest didn't accept VIRTIO_F_VERSION_1, but fLegacyOffered flag not set.\n"));
1386	}
1387	if (pVirtioCC->pfnFeatureNegotiationComplete)
1388	pVirtioCC->pfnFeatureNegotiationComplete(pVirtio, pVirtio->uDriverFeatures, pVirtio->fLegacyDriver);
1389	pVirtio->fDriverFeaturesWritten \|= DRIVER_FEATURES_COMPLETE_HANDLED;
1390	}
1391	#endif
1392
1393	/**
1394	* Handle accesses to Common Configuration capability
1395	*
1396	* @returns VBox status code
1397	*
1398	* @param pDevIns The device instance.
1399	* @param pVirtio Pointer to the shared virtio state.
1400	* @param pVirtioCC Pointer to the current context virtio state.
1401	* @param fWrite Set if write access, clear if read access.
1402	* @param uOffsetOfAccess The common configuration capability offset.
1403	* @param cb Number of bytes to read or write
1404	* @param pv Pointer to location to write to or read from
1405	*/
1406	static int virtioCommonCfgAccessed(PPDMDEVINS pDevIns, PVIRTIOCORE pVirtio, PVIRTIOCORECC pVirtioCC,
1407	int fWrite, uint32_t uOffsetOfAccess, unsigned cb, void *pv)
1408	{
1409	uint16_t uVirtq = pVirtio->uVirtqSelect;
1410	int rc = VINF_SUCCESS;
1411	uint64_t val;
1412	if (VIRTIO_DEV_CONFIG_MATCH_MEMBER(uDeviceFeatures, VIRTIO_PCI_COMMON_CFG_T, uOffsetOfAccess))
1413	{
1414	if (fWrite) /* Guest WRITE pCommonCfg>uDeviceFeatures */
1415	{
1416	/* VirtIO 1.0, 4.1.4.3 states device_feature is a (guest) driver readonly field,
1417	* yet the linux driver attempts to write/read it back twice */
1418	VIRTIO_DEV_CONFIG_LOG_ACCESS(uDeviceFeatures, VIRTIO_PCI_COMMON_CFG_T, uOffsetOfAccess);
1419	LogFunc(("... WARNING: Guest attempted to write readonly virtio_pci_common_cfg.device_feature (ignoring)\n"));
1420	return VINF_IOM_MMIO_UNUSED_00;
1421	}
1422	else /* Guest READ pCommonCfg->uDeviceFeatures */
1423	{
1424	switch (pVirtio->uDeviceFeaturesSelect)
1425	{
1426	case 0:
1427	val = pVirtio->uDeviceFeatures & UINT32_C(0xffffffff);
1428	memcpy(pv, &val, cb);
1429	VIRTIO_DEV_CONFIG_LOG_ACCESS(uDeviceFeatures, VIRTIO_PCI_COMMON_CFG_T, uOffsetOfAccess);
1430	break;
1431	case 1:
1432	val = pVirtio->uDeviceFeatures >> 32;
1433	memcpy(pv, &val, cb);
1434	VIRTIO_DEV_CONFIG_LOG_ACCESS(uDeviceFeatures, VIRTIO_PCI_COMMON_CFG_T, uOffsetOfAccess + sizeof(uint32_t));
1435	break;
1436	default:
1437	LogFunc(("Guest read uDeviceFeatures with out of range selector (%#x), returning 0\n",
1438	pVirtio->uDeviceFeaturesSelect));
1439	return VINF_IOM_MMIO_UNUSED_00;
1440	}
1441	}
1442	}
1443	else
1444	if (VIRTIO_DEV_CONFIG_MATCH_MEMBER(uDriverFeatures, VIRTIO_PCI_COMMON_CFG_T, uOffsetOfAccess))
1445	{
1446	if (fWrite) /* Guest WRITE pCommonCfg->udriverFeatures */
1447	{
1448	switch (pVirtio->uDriverFeaturesSelect)
1449	{
1450	case 0:
1451	memcpy(&pVirtio->uDriverFeatures, pv, cb);
1452	pVirtio->fDriverFeaturesWritten \|= DRIVER_FEATURES_0_WRITTEN;
1453	LogFunc(("Set DRIVER_FEATURES_0_WRITTEN. pVirtio->fDriverFeaturesWritten=%d\n", pVirtio->fDriverFeaturesWritten));
1454	if ( (pVirtio->fDriverFeaturesWritten & DRIVER_FEATURES_0_AND_1_WRITTEN) == DRIVER_FEATURES_0_AND_1_WRITTEN
1455	&& !(pVirtio->fDriverFeaturesWritten & DRIVER_FEATURES_COMPLETE_HANDLED))
1456	#ifdef IN_RING0
1457	return VINF_IOM_R3_MMIO_WRITE;
1458	#endif
1459	#ifdef IN_RING3
1460	virtioR3DoFeaturesCompleteOnceOnly(pVirtio, pVirtioCC);
1461	#endif
1462	VIRTIO_DEV_CONFIG_LOG_ACCESS(uDriverFeatures, VIRTIO_PCI_COMMON_CFG_T, uOffsetOfAccess);
1463	break;
1464	case 1:
1465	memcpy((char *)&pVirtio->uDriverFeatures + sizeof(uint32_t), pv, cb);
1466	pVirtio->fDriverFeaturesWritten \|= DRIVER_FEATURES_1_WRITTEN;
1467	LogFunc(("Set DRIVER_FEATURES_1_WRITTEN. pVirtio->fDriverFeaturesWritten=%d\n", pVirtio->fDriverFeaturesWritten));
1468	if ( (pVirtio->fDriverFeaturesWritten & DRIVER_FEATURES_0_AND_1_WRITTEN) == DRIVER_FEATURES_0_AND_1_WRITTEN
1469	&& !(pVirtio->fDriverFeaturesWritten & DRIVER_FEATURES_COMPLETE_HANDLED))
1470	#ifdef IN_RING0
1471	return VINF_IOM_R3_MMIO_WRITE;
1472	#endif
1473	#ifdef IN_RING3
1474	virtioR3DoFeaturesCompleteOnceOnly(pVirtio, pVirtioCC);
1475	#endif
1476	VIRTIO_DEV_CONFIG_LOG_ACCESS(uDriverFeatures, VIRTIO_PCI_COMMON_CFG_T, uOffsetOfAccess + sizeof(uint32_t));
1477	break;
1478	default:
1479	LogFunc(("Guest wrote uDriverFeatures with out of range selector (%#x), returning 0\n",
1480	pVirtio->uDriverFeaturesSelect));
1481	return VINF_SUCCESS;
1482	}
1483	}
1484	else /* Guest READ pCommonCfg->udriverFeatures */
1485	{
1486	switch (pVirtio->uDriverFeaturesSelect)
1487	{
1488	case 0:
1489	val = pVirtio->uDriverFeatures & 0xffffffff;
1490	memcpy(pv, &val, cb);
1491	VIRTIO_DEV_CONFIG_LOG_ACCESS(uDriverFeatures, VIRTIO_PCI_COMMON_CFG_T, uOffsetOfAccess);
1492	break;
1493	case 1:
1494	val = (pVirtio->uDriverFeatures >> 32) & 0xffffffff;
1495	memcpy(pv, &val, cb);
1496	VIRTIO_DEV_CONFIG_LOG_ACCESS(uDriverFeatures, VIRTIO_PCI_COMMON_CFG_T, uOffsetOfAccess + 4);
1497	break;
1498	default:
1499	LogFunc(("Guest read uDriverFeatures with out of range selector (%#x), returning 0\n",
1500	pVirtio->uDriverFeaturesSelect));
1501	return VINF_IOM_MMIO_UNUSED_00;
1502	}
1503	}
1504	}
1505	else
1506	if (VIRTIO_DEV_CONFIG_MATCH_MEMBER(uNumVirtqs, VIRTIO_PCI_COMMON_CFG_T, uOffsetOfAccess))
1507	{
1508	if (fWrite)
1509	{
1510	Log2Func(("Guest attempted to write readonly virtio_pci_common_cfg.num_queues\n"));
1511	return VINF_SUCCESS;
1512	}
1513	(uint16_t )pv = VIRTQ_MAX_COUNT;
1514	VIRTIO_DEV_CONFIG_LOG_ACCESS(uNumVirtqs, VIRTIO_PCI_COMMON_CFG_T, uOffsetOfAccess);
1515	}
1516	else
1517	if (VIRTIO_DEV_CONFIG_MATCH_MEMBER(fDeviceStatus, VIRTIO_PCI_COMMON_CFG_T, uOffsetOfAccess))
1518	{
1519	if (fWrite) /* Guest WRITE pCommonCfg->fDeviceStatus */
1520	{
1521	pVirtio->fDeviceStatus = (uint8_t )pv;
1522	bool fDeviceReset = pVirtio->fDeviceStatus == 0;
1523	#ifdef LOG_ENABLED
1524	if (LogIs7Enabled())
1525	{
1526	char szOut[80] = { 0 };
1527	virtioCoreFormatDeviceStatus(pVirtio->fDeviceStatus, szOut, sizeof(szOut));
1528	Log(("%-23s: Guest wrote fDeviceStatus ................ (%s)\n", __FUNCTION__, szOut));
1529	}
1530	#endif
1531	bool const fStatusChanged = IS_DRIVER_OK(pVirtio) != WAS_DRIVER_OK(pVirtio);
1532
1533	if (fDeviceReset \|\| fStatusChanged)
1534	{
1535	#ifdef IN_RING0
1536	/* Since VirtIO status changes are cumbersome by nature, e.g. not a benchmark priority,
1537	* handle the rest in R3 to facilitate logging or whatever dev-specific client needs to do */
1538	Log6(("%-23s: RING0 => RING3 (demote)\n", __FUNCTION__));
1539	return VINF_IOM_R3_MMIO_WRITE;
1540	#endif
1541	}
1542
1543	#ifdef IN_RING3
1544	/*
1545	* Notify client only if status actually changed from last time and when we're reset.
1546	*/
1547	if (fDeviceReset)
1548	virtioGuestR3WasReset(pDevIns, pVirtio, pVirtioCC);
1549
1550	if (fStatusChanged)
1551	pVirtioCC->pfnStatusChanged(pVirtio, pVirtioCC, IS_DRIVER_OK(pVirtio));
1552	#endif
1553	/*
1554	* Save the current status for the next write so we can see what changed.
1555	*/
1556	pVirtio->fPrevDeviceStatus = pVirtio->fDeviceStatus;
1557	}
1558	else /* Guest READ pCommonCfg->fDeviceStatus */
1559	{
1560	(uint8_t )pv = pVirtio->fDeviceStatus;
1561	#ifdef LOG_ENABLED
1562	if (LogIs7Enabled())
1563	{
1564	char szOut[80] = { 0 };
1565	virtioCoreFormatDeviceStatus(pVirtio->fDeviceStatus, szOut, sizeof(szOut));
1566	LogFunc(("Guest read fDeviceStatus ................ (%s)\n", szOut));
1567	}
1568	#endif
1569	}
1570	}
1571	else
1572	if (VIRTIO_DEV_CONFIG_MATCH_MEMBER( uMsixConfig, VIRTIO_PCI_COMMON_CFG_T, uOffsetOfAccess))
1573	VIRTIO_DEV_CONFIG_ACCESS( uMsixConfig, VIRTIO_PCI_COMMON_CFG_T, uOffsetOfAccess, pVirtio);
1574	else
1575	if (VIRTIO_DEV_CONFIG_MATCH_MEMBER( uDeviceFeaturesSelect, VIRTIO_PCI_COMMON_CFG_T, uOffsetOfAccess))
1576	VIRTIO_DEV_CONFIG_ACCESS( uDeviceFeaturesSelect, VIRTIO_PCI_COMMON_CFG_T, uOffsetOfAccess, pVirtio);
1577	else
1578	if (VIRTIO_DEV_CONFIG_MATCH_MEMBER( uDriverFeaturesSelect, VIRTIO_PCI_COMMON_CFG_T, uOffsetOfAccess))
1579	VIRTIO_DEV_CONFIG_ACCESS( uDriverFeaturesSelect, VIRTIO_PCI_COMMON_CFG_T, uOffsetOfAccess, pVirtio);
1580	else
1581	if (VIRTIO_DEV_CONFIG_MATCH_MEMBER( uConfigGeneration, VIRTIO_PCI_COMMON_CFG_T, uOffsetOfAccess))
1582	VIRTIO_DEV_CONFIG_ACCESS( uConfigGeneration, VIRTIO_PCI_COMMON_CFG_T, uOffsetOfAccess, pVirtio);
1583	else
1584	if (VIRTIO_DEV_CONFIG_MATCH_MEMBER( uVirtqSelect, VIRTIO_PCI_COMMON_CFG_T, uOffsetOfAccess))
1585	{
1586	if (fWrite) {
1587	uint16_t uVirtqNew = (uint16_t )pv;
1588
1589	if (uVirtqNew < RT_ELEMENTS(pVirtio->aVirtqueues))
1590	VIRTIO_DEV_CONFIG_ACCESS( uVirtqSelect, VIRTIO_PCI_COMMON_CFG_T, uOffsetOfAccess, pVirtio);
1591	else
1592	LogFunc(("... WARNING: Guest attempted to write invalid virtq selector (ignoring)\n"));
1593	}
1594	else
1595	VIRTIO_DEV_CONFIG_ACCESS( uVirtqSelect, VIRTIO_PCI_COMMON_CFG_T, uOffsetOfAccess, pVirtio);
1596	}
1597	else
1598	if (VIRTIO_DEV_CONFIG_MATCH_MEMBER( GCPhysVirtqDesc, VIRTIO_PCI_COMMON_CFG_T, uOffsetOfAccess))
1599	VIRTIO_DEV_CONFIG_ACCESS_INDEXED( GCPhysVirtqDesc, uVirtq, VIRTIO_PCI_COMMON_CFG_T, uOffsetOfAccess, pVirtio->aVirtqueues);
1600	else
1601	if (VIRTIO_DEV_CONFIG_MATCH_MEMBER( GCPhysVirtqAvail, VIRTIO_PCI_COMMON_CFG_T, uOffsetOfAccess))
1602	VIRTIO_DEV_CONFIG_ACCESS_INDEXED( GCPhysVirtqAvail, uVirtq, VIRTIO_PCI_COMMON_CFG_T, uOffsetOfAccess, pVirtio->aVirtqueues);
1603	else
1604	if (VIRTIO_DEV_CONFIG_MATCH_MEMBER( GCPhysVirtqUsed, VIRTIO_PCI_COMMON_CFG_T, uOffsetOfAccess))
1605	VIRTIO_DEV_CONFIG_ACCESS_INDEXED( GCPhysVirtqUsed, uVirtq, VIRTIO_PCI_COMMON_CFG_T, uOffsetOfAccess, pVirtio->aVirtqueues);
1606	else
1607	if (VIRTIO_DEV_CONFIG_MATCH_MEMBER( uQueueSize, VIRTIO_PCI_COMMON_CFG_T, uOffsetOfAccess))
1608	VIRTIO_DEV_CONFIG_ACCESS_INDEXED( uQueueSize, uVirtq, VIRTIO_PCI_COMMON_CFG_T, uOffsetOfAccess, pVirtio->aVirtqueues);
1609	else
1610	if (VIRTIO_DEV_CONFIG_MATCH_MEMBER( uEnable, VIRTIO_PCI_COMMON_CFG_T, uOffsetOfAccess))
1611	VIRTIO_DEV_CONFIG_ACCESS_INDEXED( uEnable, uVirtq, VIRTIO_PCI_COMMON_CFG_T, uOffsetOfAccess, pVirtio->aVirtqueues);
1612	else
1613	if (VIRTIO_DEV_CONFIG_MATCH_MEMBER( uNotifyOffset, VIRTIO_PCI_COMMON_CFG_T, uOffsetOfAccess))
1614	VIRTIO_DEV_CONFIG_ACCESS_INDEXED( uNotifyOffset, uVirtq, VIRTIO_PCI_COMMON_CFG_T, uOffsetOfAccess, pVirtio->aVirtqueues);
1615	else
1616	if (VIRTIO_DEV_CONFIG_MATCH_MEMBER( uMsixVector, VIRTIO_PCI_COMMON_CFG_T, uOffsetOfAccess))
1617	VIRTIO_DEV_CONFIG_ACCESS_INDEXED( uMsixVector, uVirtq, VIRTIO_PCI_COMMON_CFG_T, uOffsetOfAccess, pVirtio->aVirtqueues);
1618	else
1619	{
1620	Log2Func(("Bad guest %s access to virtio_pci_common_cfg: uOffsetOfAccess=%#x (%d), cb=%d\n",
1621	fWrite ? "write" : "read ", uOffsetOfAccess, uOffsetOfAccess, cb));
1622	return fWrite ? VINF_SUCCESS : VINF_IOM_MMIO_UNUSED_00;
1623	}
1624
1625	#ifndef IN_RING3
1626	RT_NOREF(pDevIns, pVirtioCC);
1627	#endif
1628	return rc;
1629	}
1630
1631	/**
1632	* @callback_method_impl{FNIOMIOPORTNEWIN)
1633	*
1634	* This I/O handler exists only to handle access from legacy drivers.
1635	*/
1636	static DECLCALLBACK(VBOXSTRICTRC) virtioLegacyIOPortIn(PPDMDEVINS pDevIns, void pvUser, RTIOPORT offPort, uint32_t pu32, unsigned cb)
1637	{
1638	PVIRTIOCORE pVirtio = PDMINS_2_DATA(pDevIns, PVIRTIOCORE);
1639	STAM_PROFILE_ADV_START(&pVirtio->CTX_SUFF(StatRead), a);
1640
1641	RT_NOREF(pvUser);
1642	Log(("%-23s: Port read at offset=%RTiop, cb=%#x%s",
1643	__FUNCTION__, offPort, cb,
1644	VIRTIO_DEV_CONFIG_MATCH_MEMBER(fIsrStatus, VIRTIO_LEGACY_PCI_COMMON_CFG_T, offPort) ? "" : "\n"));
1645
1646	void pv = pu32; / To use existing macros */
1647	int fWrite = 0; /* To use existing macros */
1648
1649	uint16_t uVirtq = pVirtio->uVirtqSelect;
1650
1651	if (VIRTIO_DEV_CONFIG_MATCH_MEMBER(uDeviceFeatures, VIRTIO_LEGACY_PCI_COMMON_CFG_T, offPort))
1652	{
1653	uint32_t val = pVirtio->uDeviceFeatures & UINT32_C(0xffffffff);
1654	memcpy(pu32, &val, cb);
1655	VIRTIO_DEV_CONFIG_LOG_ACCESS(uDeviceFeatures, VIRTIO_LEGACY_PCI_COMMON_CFG_T, offPort);
1656	}
1657	else
1658	if (VIRTIO_DEV_CONFIG_MATCH_MEMBER(uDriverFeatures, VIRTIO_LEGACY_PCI_COMMON_CFG_T, offPort))
1659	{
1660	uint32_t val = pVirtio->uDriverFeatures & UINT32_C(0xffffffff);
1661	memcpy(pu32, &val, cb);
1662	VIRTIO_DEV_CONFIG_LOG_ACCESS(uDriverFeatures, VIRTIO_LEGACY_PCI_COMMON_CFG_T, offPort);
1663	}
1664	else
1665	if (VIRTIO_DEV_CONFIG_MATCH_MEMBER(fDeviceStatus, VIRTIO_LEGACY_PCI_COMMON_CFG_T, offPort))
1666	{
1667	(uint8_t )pu32 = pVirtio->fDeviceStatus;
1668	#ifdef LOG_ENABLED
1669	if (LogIs7Enabled())
1670	{
1671	char szOut[80] = { 0 };
1672	virtioCoreFormatDeviceStatus(pVirtio->fDeviceStatus, szOut, sizeof(szOut));
1673	Log(("%-23s: Guest read fDeviceStatus ................ (%s)\n", __FUNCTION__, szOut));
1674	}
1675	#endif
1676	}
1677	else
1678	if (VIRTIO_DEV_CONFIG_MATCH_MEMBER(fIsrStatus, VIRTIO_LEGACY_PCI_COMMON_CFG_T, offPort))
1679	{
1680	ASSERT_GUEST_MSG(cb == 1, ("%d\n", cb));
1681	(uint8_t )pu32 = pVirtio->uISR;
1682	pVirtio->uISR = 0;
1683	virtioLowerInterrupt( pDevIns, 0);
1684	Log((" (ISR read and cleared)\n"));
1685	}
1686	else
1687	if (VIRTIO_DEV_CONFIG_MATCH_MEMBER( uVirtqSelect, VIRTIO_LEGACY_PCI_COMMON_CFG_T, offPort))
1688	VIRTIO_DEV_CONFIG_ACCESS( uVirtqSelect, VIRTIO_LEGACY_PCI_COMMON_CFG_T, offPort, pVirtio);
1689	else
1690	if (VIRTIO_DEV_CONFIG_MATCH_MEMBER( uVirtqPfn, VIRTIO_LEGACY_PCI_COMMON_CFG_T, offPort))
1691	{
1692	PVIRTQUEUE pVirtQueue = &pVirtio->aVirtqueues[uVirtq];
1693	*pu32 = pVirtQueue->GCPhysVirtqDesc >> GUEST_PAGE_SHIFT;
1694	Log(("%-23s: Guest read uVirtqPfn .................... %#x\n", __FUNCTION__, *pu32));
1695	}
1696	else
1697	if (VIRTIO_DEV_CONFIG_MATCH_MEMBER( uQueueSize, VIRTIO_LEGACY_PCI_COMMON_CFG_T, offPort))
1698	VIRTIO_DEV_CONFIG_ACCESS_INDEXED( uQueueSize, uVirtq, VIRTIO_LEGACY_PCI_COMMON_CFG_T, offPort, pVirtio->aVirtqueues);
1699	else
1700	if (VIRTIO_DEV_CONFIG_MATCH_MEMBER( uQueueNotify, VIRTIO_LEGACY_PCI_COMMON_CFG_T, offPort))
1701	VIRTIO_DEV_CONFIG_ACCESS( uQueueNotify, VIRTIO_LEGACY_PCI_COMMON_CFG_T, offPort, pVirtio);
1702	#ifdef LEGACY_MSIX_SUPPORTED
1703	else
1704	if (VIRTIO_DEV_CONFIG_MATCH_MEMBER( uMsixConfig, VIRTIO_LEGACY_PCI_COMMON_CFG_T, offPort))
1705	VIRTIO_DEV_CONFIG_ACCESS( uMsixConfig, VIRTIO_LEGACY_PCI_COMMON_CFG_T, offPort, pVirtio);
1706	else
1707	if (VIRTIO_DEV_CONFIG_MATCH_MEMBER( uMsixVector, VIRTIO_LEGACY_PCI_COMMON_CFG_T, offPort))
1708	VIRTIO_DEV_CONFIG_ACCESS_INDEXED( uMsixVector, uVirtq, VIRTIO_LEGACY_PCI_COMMON_CFG_T, offPort, pVirtio->aVirtqueues);
1709	#endif
1710	else if (offPort >= sizeof(VIRTIO_LEGACY_PCI_COMMON_CFG_T))
1711	{
1712	STAM_PROFILE_ADV_STOP(&pVirtio->CTX_SUFF(StatRead), a);
1713	#ifdef IN_RING3
1714	/* Access device-specific configuration */
1715	PVIRTIOCORECC pVirtioCC = PDMINS_2_DATA_CC(pDevIns, PVIRTIOCORECC);
1716	int rc = pVirtioCC->pfnDevCapRead(pDevIns, offPort - sizeof(VIRTIO_LEGACY_PCI_COMMON_CFG_T), pv, cb);
1717	return rc;
1718	#else
1719	return VINF_IOM_R3_IOPORT_READ;
1720	#endif
1721	}
1722	else
1723	{
1724	STAM_PROFILE_ADV_STOP(&pVirtio->CTX_SUFF(StatRead), a);
1725	Log2Func(("Bad guest read access to virtio_legacy_pci_common_cfg: offset=%#x, cb=%x\n",
1726	offPort, cb));
1727	int rc = PDMDevHlpDBGFStop(pDevIns, RT_SRC_POS,
1728	"virtioLegacyIOPortIn: no valid port at offset offset=%RTiop cb=%#x\n", offPort, cb);
1729	return rc;
1730	}
1731	STAM_PROFILE_ADV_STOP(&pVirtio->CTX_SUFF(StatRead), a);
1732	return VINF_SUCCESS;
1733	}
1734
1735	/**
1736	* @callback_method_impl{ * @callback_method_impl{FNIOMIOPORTNEWOUT}
1737	*
1738	* This I/O Port interface exists only to handle access from legacy drivers.
1739	*/
1740	static DECLCALLBACK(VBOXSTRICTRC) virtioLegacyIOPortOut(PPDMDEVINS pDevIns, void *pvUser, RTIOPORT offPort, uint32_t u32, unsigned cb)
1741	{
1742	PVIRTIOCORE pVirtio = PDMINS_2_DATA(pDevIns, PVIRTIOCORE);
1743	STAM_PROFILE_ADV_START(&pVirtio->CTX_SUFF(StatWrite), a);
1744	RT_NOREF(pvUser);
1745
1746	uint16_t uVirtq = pVirtio->uVirtqSelect;
1747	uint32_t u32OnStack = u32; /* allows us to use this impl's MMIO parsing macros */
1748	void pv = &u32OnStack; / To use existing macros */
1749	int fWrite = 1; /* To use existing macros */
1750
1751	Log(("%-23s: Port written at offset=%RTiop, cb=%#x, u32=%#x\n", __FUNCTION__, offPort, cb, u32));
1752
1753	if (VIRTIO_DEV_CONFIG_MATCH_MEMBER( uVirtqSelect, VIRTIO_LEGACY_PCI_COMMON_CFG_T, offPort))
1754	{
1755	if (u32 < RT_ELEMENTS(pVirtio->aVirtqueues))
1756	VIRTIO_DEV_CONFIG_ACCESS( uVirtqSelect, VIRTIO_LEGACY_PCI_COMMON_CFG_T, offPort, pVirtio);
1757	else
1758	LogFunc(("... WARNING: Guest attempted to write invalid virtq selector (ignoring)\n"));
1759	}
1760	else
1761	#ifdef LEGACY_MSIX_SUPPORTED
1762	if (VIRTIO_DEV_CONFIG_MATCH_MEMBER( uMsixConfig, VIRTIO_LEGACY_PCI_COMMON_CFG_T, offPort))
1763	VIRTIO_DEV_CONFIG_ACCESS( uMsixConfig, VIRTIO_LEGACY_PCI_COMMON_CFG_T, offPort, pVirtio);
1764	else
1765	if (VIRTIO_DEV_CONFIG_MATCH_MEMBER( uMsixVector, VIRTIO_LEGACY_PCI_COMMON_CFG_T, offPort))
1766	VIRTIO_DEV_CONFIG_ACCESS_INDEXED( uMsixVector, uVirtq, VIRTIO_LEGACY_PCI_COMMON_CFG_T, offPort, pVirtio->aVirtqueues);
1767	else
1768	#endif
1769	if (VIRTIO_DEV_CONFIG_MATCH_MEMBER(uDeviceFeatures, VIRTIO_LEGACY_PCI_COMMON_CFG_T, offPort))
1770	{
1771	/* Check to see if guest acknowledged unsupported features */
1772	VIRTIO_DEV_CONFIG_LOG_ACCESS(uDeviceFeatures, VIRTIO_LEGACY_PCI_COMMON_CFG_T, offPort);
1773	LogFunc(("... WARNING: Guest attempted to write readonly virtio_pci_common_cfg.device_feature (ignoring)\n"));
1774	STAM_PROFILE_ADV_STOP(&pVirtio->CTX_SUFF(StatWrite), a);
1775	return VINF_SUCCESS;
1776	}
1777	else
1778	if (VIRTIO_DEV_CONFIG_MATCH_MEMBER(uDriverFeatures, VIRTIO_LEGACY_PCI_COMMON_CFG_T, offPort))
1779	{
1780	memcpy(&pVirtio->uDriverFeatures, pv, cb);
1781	if ((pVirtio->uDriverFeatures & ~VIRTIO_DEV_INDEPENDENT_LEGACY_FEATURES_OFFERED) == 0)
1782	{
1783	Log(("Guest asked for features host does not support! (host=%x guest=%x)\n",
1784	VIRTIO_DEV_INDEPENDENT_LEGACY_FEATURES_OFFERED, pVirtio->uDriverFeatures));
1785	pVirtio->uDriverFeatures &= VIRTIO_DEV_INDEPENDENT_LEGACY_FEATURES_OFFERED;
1786	}
1787	if (!(pVirtio->fDriverFeaturesWritten & DRIVER_FEATURES_COMPLETE_HANDLED))
1788	{
1789	#ifdef IN_RING0
1790	Log6(("%-23s: RING0 => RING3 (demote)\n", __FUNCTION__));
1791	return VINF_IOM_R3_IOPORT_WRITE;
1792	#endif
1793	#ifdef IN_RING3
1794	PVIRTIOCORECC pVirtioCC = PDMINS_2_DATA_CC(pDevIns, PVIRTIOCORECC);
1795	virtioR3DoFeaturesCompleteOnceOnly(pVirtio, pVirtioCC);
1796	#endif
1797	}
1798	VIRTIO_DEV_CONFIG_LOG_ACCESS(uDriverFeatures, VIRTIO_LEGACY_PCI_COMMON_CFG_T, offPort);
1799	}
1800	else
1801	if (VIRTIO_DEV_CONFIG_MATCH_MEMBER(uQueueSize, VIRTIO_LEGACY_PCI_COMMON_CFG_T, offPort))
1802	{
1803	VIRTIO_DEV_CONFIG_LOG_ACCESS(uQueueSize, VIRTIO_LEGACY_PCI_COMMON_CFG_T, offPort);
1804	LogFunc(("... WARNING: Guest attempted to write readonly device_feature (queue size) (ignoring)\n"));
1805	return VINF_SUCCESS;
1806	}
1807	else
1808	if (VIRTIO_DEV_CONFIG_MATCH_MEMBER(fDeviceStatus, VIRTIO_LEGACY_PCI_COMMON_CFG_T, offPort))
1809	{
1810	bool const fDriverInitiatedReset = (pVirtio->fDeviceStatus = (uint8_t)u32) == 0;
1811	bool const fDriverStateImproved = IS_DRIVER_OK(pVirtio) && !WAS_DRIVER_OK(pVirtio);
1812	#ifdef LOG_ENABLED
1813	if (LogIs7Enabled())
1814	{
1815	char szOut[80] = { 0 };
1816	virtioCoreFormatDeviceStatus(pVirtio->fDeviceStatus, szOut, sizeof(szOut));
1817	Log(("%-23s: Guest wrote fDeviceStatus ................ (%s)\n", __FUNCTION__, szOut));
1818	}
1819	#endif
1820	if (fDriverStateImproved \|\| fDriverInitiatedReset)
1821	{
1822	#ifdef IN_RING0
1823	Log6(("%-23s: RING0 => RING3 (demote)\n", __FUNCTION__));
1824	STAM_PROFILE_ADV_STOP(&pVirtio->CTX_SUFF(StatWrite), a);
1825	return VINF_IOM_R3_IOPORT_WRITE;
1826	#endif
1827	}
1828
1829	#ifdef IN_RING3
1830	PVIRTIOCORECC pVirtioCC = PDMINS_2_DATA_CC(pDevIns, PVIRTIOCORECC);
1831	if (fDriverInitiatedReset)
1832	virtioGuestR3WasReset(pDevIns, pVirtio, pVirtioCC);
1833
1834	else if (fDriverStateImproved)
1835	pVirtioCC->pfnStatusChanged(pVirtio, pVirtioCC, 1 /* fDriverOk */);
1836
1837	#endif
1838	pVirtio->fPrevDeviceStatus = pVirtio->fDeviceStatus;
1839	}
1840	else
1841	if (VIRTIO_DEV_CONFIG_MATCH_MEMBER(uVirtqPfn, VIRTIO_LEGACY_PCI_COMMON_CFG_T, offPort))
1842	{
1843	PVIRTQUEUE pVirtq = &pVirtio->aVirtqueues[uVirtq];
1844	uint64_t uVirtqPfn = (uint64_t)u32;
1845
1846	if (uVirtqPfn)
1847	{
1848	/* Transitional devices calculate ring physical addresses using rigid spec-defined formulae,
1849	* instead of guest conveying respective address of each ring, as "modern" VirtIO drivers do,
1850	* thus there is no virtq PFN or single base queue address stored in instance data for
1851	* this transitional device, but rather it is derived, when read back, from GCPhysVirtqDesc */
1852
1853	pVirtq->GCPhysVirtqDesc = uVirtqPfn * VIRTIO_PAGE_SIZE;
1854	pVirtq->GCPhysVirtqAvail = pVirtq->GCPhysVirtqDesc + sizeof(VIRTQ_DESC_T) * pVirtq->uQueueSize;
1855	pVirtq->GCPhysVirtqUsed =
1856	RT_ALIGN(pVirtq->GCPhysVirtqAvail + RT_UOFFSETOF_DYN(VIRTQ_AVAIL_T, auRing[pVirtq->uQueueSize]), VIRTIO_PAGE_SIZE);
1857	}
1858	else
1859	{
1860	/* Don't set ring addresses for queue (to meaningless values), when guest resets the virtq's PFN */
1861	pVirtq->GCPhysVirtqDesc = 0;
1862	pVirtq->GCPhysVirtqAvail = 0;
1863	pVirtq->GCPhysVirtqUsed = 0;
1864	}
1865	Log(("%-23s: Guest wrote uVirtqPfn .................... %#x:\n"
1866	"%68s... %p -> GCPhysVirtqDesc\n%68s... %p -> GCPhysVirtqAvail\n%68s... %p -> GCPhysVirtqUsed\n",
1867	__FUNCTION__, u32, " ", pVirtq->GCPhysVirtqDesc, " ", pVirtq->GCPhysVirtqAvail, " ", pVirtq->GCPhysVirtqUsed));
1868	}
1869	else
1870	if (VIRTIO_DEV_CONFIG_MATCH_MEMBER(uQueueNotify, VIRTIO_LEGACY_PCI_COMMON_CFG_T, offPort))
1871	{
1872	#ifdef IN_RING3
1873	ASSERT_GUEST_MSG(cb == 2, ("cb=%u\n", cb));
1874	pVirtio->uQueueNotify = u32 & 0xFFFF;
1875	if (uVirtq < VIRTQ_MAX_COUNT)
1876	{
1877	RT_UNTRUSTED_VALIDATED_FENCE();
1878
1879	/* Need to check that queue is configured. Legacy spec didn't have a queue enabled flag */
1880	if (pVirtio->aVirtqueues[pVirtio->uQueueNotify].GCPhysVirtqDesc)
1881	virtioCoreVirtqNotified(pDevIns, pVirtio, pVirtio->uQueueNotify, pVirtio->uQueueNotify /* uNotifyIdx */);
1882	else
1883	Log(("The queue (#%d) being notified has not been initialized.\n", pVirtio->uQueueNotify));
1884	}
1885	else
1886	Log(("Invalid queue number (%d)\n", pVirtio->uQueueNotify));
1887	#else
1888	STAM_PROFILE_ADV_STOP(&pVirtio->CTX_SUFF(StatWrite), a);
1889	return VINF_IOM_R3_IOPORT_WRITE;
1890	#endif
1891	}
1892	else
1893	if (VIRTIO_DEV_CONFIG_MATCH_MEMBER(fIsrStatus, VIRTIO_LEGACY_PCI_COMMON_CFG_T, offPort))
1894	{
1895	VIRTIO_DEV_CONFIG_LOG_ACCESS( fIsrStatus, VIRTIO_LEGACY_PCI_COMMON_CFG_T, offPort);
1896	LogFunc(("... WARNING: Guest attempted to write readonly device_feature (ISR status) (ignoring)\n"));
1897	STAM_PROFILE_ADV_STOP(&pVirtio->CTX_SUFF(StatWrite), a);
1898	return VINF_SUCCESS;
1899	}
1900	else if (offPort >= sizeof(VIRTIO_LEGACY_PCI_COMMON_CFG_T))
1901	{
1902	#ifdef IN_RING3
1903
1904	/* Access device-specific configuration */
1905	PVIRTIOCORECC pVirtioCC = PDMINS_2_DATA_CC(pDevIns, PVIRTIOCORECC);
1906	return pVirtioCC->pfnDevCapWrite(pDevIns, offPort - sizeof(VIRTIO_LEGACY_PCI_COMMON_CFG_T), pv, cb);
1907	#else
1908	STAM_PROFILE_ADV_STOP(&pVirtio->CTX_SUFF(StatWrite), a);
1909	return VINF_IOM_R3_IOPORT_WRITE;
1910	#endif
1911	}
1912	else
1913	{
1914	Log2Func(("Bad guest write access to virtio_legacy_pci_common_cfg: offset=%#x, cb=0x%x\n",
1915	offPort, cb));
1916	STAM_PROFILE_ADV_STOP(&pVirtio->CTX_SUFF(StatWrite), a);
1917	int rc = PDMDevHlpDBGFStop(pDevIns, RT_SRC_POS,
1918	"virtioLegacyIOPortOut: no valid port at offset offset=%RTiop cb=0x%#x\n", offPort, cb);
1919	return rc;
1920	}
1921
1922	RT_NOREF(uVirtq);
1923	STAM_PROFILE_ADV_STOP(&pVirtio->CTX_SUFF(StatWrite), a);
1924	return VINF_SUCCESS;
1925	}
1926
1927
1928	/**
1929	* @callback_method_impl{FNIOMMMIONEWREAD,
1930	* Memory mapped I/O Handler for PCI Capabilities read operations.}
1931	*
1932	* This MMIO handler specifically supports the VIRTIO_PCI_CAP_PCI_CFG capability defined
1933	* in the VirtIO 1.0 specification, section 4.1.4.7, and as such is restricted to reads
1934	* of 1, 2 or 4 bytes, only.
1935	*
1936	*/
1937	static DECLCALLBACK(VBOXSTRICTRC) virtioMmioRead(PPDMDEVINS pDevIns, void pvUser, RTGCPHYS off, void pv, unsigned cb)
1938	{
1939	PVIRTIOCORE pVirtio = PDMINS_2_DATA(pDevIns, PVIRTIOCORE);
1940	PVIRTIOCORECC pVirtioCC = PDMINS_2_DATA_CC(pDevIns, PVIRTIOCORECC);
1941	AssertReturn(cb == 1 \|\| cb == 2 \|\| cb == 4, VERR_INVALID_PARAMETER);
1942	Assert(pVirtio == (PVIRTIOCORE)pvUser); RT_NOREF(pvUser);
1943	STAM_PROFILE_ADV_START(&pVirtio->CTX_SUFF(StatRead), a);
1944
1945
1946	uint32_t uOffset;
1947	if (MATCHES_VIRTIO_CAP_STRUCT(off, cb, uOffset, pVirtio->LocDeviceCap))
1948	{
1949	#ifdef IN_RING3
1950	/*
1951	* Callback to client to manage device-specific configuration.
1952	*/
1953	VBOXSTRICTRC rcStrict = pVirtioCC->pfnDevCapRead(pDevIns, uOffset, pv, cb);
1954
1955	/*
1956	* Anytime any part of the dev-specific dev config (which this virtio core implementation sees
1957	* as a blob, and virtio dev-specific code separates into fields) is READ, it must be compared
1958	* for deltas from previous read to maintain a config gen. seq. counter (VirtIO 1.0, section 4.1.4.3.1)
1959	*/
1960	bool fDevSpecificFieldChanged = RT_BOOL(memcmp(pVirtioCC->pbDevSpecificCfg + uOffset,
1961	pVirtioCC->pbPrevDevSpecificCfg + uOffset,
1962	RT_MIN(cb, pVirtioCC->cbDevSpecificCfg - uOffset)));
1963
1964	memcpy(pVirtioCC->pbPrevDevSpecificCfg, pVirtioCC->pbDevSpecificCfg, pVirtioCC->cbDevSpecificCfg);
1965
1966	if (pVirtio->fGenUpdatePending \|\| fDevSpecificFieldChanged)
1967	{
1968	++pVirtio->uConfigGeneration;
1969	Log6Func(("Bumped cfg. generation to %d because %s%s\n", pVirtio->uConfigGeneration,
1970	fDevSpecificFieldChanged ? "<dev cfg changed> " : "",
1971	pVirtio->fGenUpdatePending ? "<update was pending>" : ""));
1972	pVirtio->fGenUpdatePending = false;
1973	}
1974
1975	virtioLowerInterrupt(pDevIns, 0);
1976	STAM_PROFILE_ADV_STOP(&pVirtio->CTX_SUFF(StatRead), a);
1977	return rcStrict;
1978	#else
1979	STAM_PROFILE_ADV_STOP(&pVirtio->CTX_SUFF(StatRead), a);
1980	return VINF_IOM_R3_MMIO_READ;
1981	#endif
1982	}
1983
1984	if (MATCHES_VIRTIO_CAP_STRUCT(off, cb, uOffset, pVirtio->LocCommonCfgCap))
1985	return virtioCommonCfgAccessed(pDevIns, pVirtio, pVirtioCC, false /* fWrite */, uOffset, cb, pv);
1986
1987	if (MATCHES_VIRTIO_CAP_STRUCT(off, cb, uOffset, pVirtio->LocIsrCap))
1988	{
1989	(uint8_t )pv = pVirtio->uISR;
1990	Log6Func(("Read and clear ISR\n"));
1991	pVirtio->uISR = 0; /* VirtIO spec requires reads of ISR to clear it */
1992	virtioLowerInterrupt(pDevIns, 0);
1993	STAM_PROFILE_ADV_STOP(&pVirtio->CTX_SUFF(StatRead), a);
1994	return VINF_SUCCESS;
1995	}
1996
1997	ASSERT_GUEST_MSG_FAILED(("Bad read access to mapped capabilities region: off=%RGp cb=%u\n", off, cb));
1998	STAM_PROFILE_ADV_STOP(&pVirtio->CTX_SUFF(StatRead), a);
1999	int rc = PDMDevHlpDBGFStop(pDevIns, RT_SRC_POS,
2000	"virtioMmioRead: Bad MMIO access to capabilities, offset=%RTiop cb=%08x\n", off, cb);
2001	return rc;
2002	}
2003
2004	/**
2005	* @callback_method_impl{FNIOMMMIONEWREAD,
2006	* Memory mapped I/O Handler for PCI Capabilities write operations.}
2007	*
2008	* This MMIO handler specifically supports the VIRTIO_PCI_CAP_PCI_CFG capability defined
2009	* in the VirtIO 1.0 specification, section 4.1.4.7, and as such is restricted to writes
2010	* of 1, 2 or 4 bytes, only.
2011	*/
2012	static DECLCALLBACK(VBOXSTRICTRC) virtioMmioWrite(PPDMDEVINS pDevIns, void pvUser, RTGCPHYS off, void const pv, unsigned cb)
2013	{
2014	PVIRTIOCORE pVirtio = PDMINS_2_DATA(pDevIns, PVIRTIOCORE);
2015	PVIRTIOCORECC pVirtioCC = PDMINS_2_DATA_CC(pDevIns, PVIRTIOCORECC);
2016	AssertReturn(cb == 1 \|\| cb == 2 \|\| cb == 4, VERR_INVALID_PARAMETER);
2017	Assert(pVirtio == (PVIRTIOCORE)pvUser); RT_NOREF(pvUser);
2018	STAM_PROFILE_ADV_START(&pVirtio->CTX_SUFF(StatWrite), a);
2019
2020	uint32_t uOffset;
2021	if (MATCHES_VIRTIO_CAP_STRUCT(off, cb, uOffset, pVirtio->LocDeviceCap))
2022	{
2023	#ifdef IN_RING3
2024	/*
2025	* Foreward this MMIO write access for client to deal with.
2026	*/
2027	STAM_PROFILE_ADV_STOP(&pVirtio->CTX_SUFF(StatWrite), a);
2028	return pVirtioCC->pfnDevCapWrite(pDevIns, uOffset, pv, cb);
2029	#else
2030	STAM_PROFILE_ADV_STOP(&pVirtio->CTX_SUFF(StatWrite), a);
2031	Log6(("%-23s: RING0 => RING3 (demote)\n", __FUNCTION__));
2032	return VINF_IOM_R3_MMIO_WRITE;
2033	#endif
2034	}
2035
2036	if (MATCHES_VIRTIO_CAP_STRUCT(off, cb, uOffset, pVirtio->LocCommonCfgCap))
2037	{
2038	STAM_PROFILE_ADV_STOP(&pVirtio->CTX_SUFF(StatWrite), a);
2039	return virtioCommonCfgAccessed(pDevIns, pVirtio, pVirtioCC, true /* fWrite /, uOffset, cb, (void )pv);
2040	}
2041
2042	if (MATCHES_VIRTIO_CAP_STRUCT(off, cb, uOffset, pVirtio->LocIsrCap) && cb == sizeof(uint8_t))
2043	{
2044	pVirtio->uISR = (uint8_t )pv;
2045	Log6Func(("Setting uISR = 0x%02x (virtq interrupt: %d, dev confg interrupt: %d)\n",
2046	pVirtio->uISR & 0xff,
2047	pVirtio->uISR & VIRTIO_ISR_VIRTQ_INTERRUPT,
2048	RT_BOOL(pVirtio->uISR & VIRTIO_ISR_DEVICE_CONFIG)));
2049	STAM_PROFILE_ADV_STOP(&pVirtio->CTX_SUFF(StatWrite), a);
2050	return VINF_SUCCESS;
2051	}
2052
2053	/* This should be guest driver dropping index of a new descriptor in avail ring */
2054	if (MATCHES_VIRTIO_CAP_STRUCT(off, cb, uOffset, pVirtio->LocNotifyCap) && cb == sizeof(uint16_t))
2055	{
2056	virtioCoreVirtqNotified(pDevIns, pVirtio, uOffset / VIRTIO_NOTIFY_OFFSET_MULTIPLIER, (uint16_t )pv);
2057	STAM_PROFILE_ADV_STOP(&pVirtio->CTX_SUFF(StatWrite), a);
2058	return VINF_SUCCESS;
2059	}
2060
2061	ASSERT_GUEST_MSG_FAILED(("Bad write access to mapped capabilities region: off=%RGp pv=%#p{%.*Rhxs} cb=%u\n", off, pv, cb, pv, cb));
2062	STAM_PROFILE_ADV_STOP(&pVirtio->CTX_SUFF(StatWrite), a);
2063	int rc = PDMDevHlpDBGFStop(pDevIns, RT_SRC_POS,
2064	"virtioMmioRead: Bad MMIO access to capabilities, offset=%RTiop cb=%08x\n", off, cb);
2065	return rc;
2066	}
2067
2068	#ifdef IN_RING3
2069
2070	/**
2071	* @callback_method_impl{FNPCICONFIGREAD}
2072	*/
2073	static DECLCALLBACK(VBOXSTRICTRC) virtioR3PciConfigRead(PPDMDEVINS pDevIns, PPDMPCIDEV pPciDev,
2074	uint32_t uAddress, unsigned cb, uint32_t *pu32Value)
2075	{
2076	PVIRTIOCORE pVirtio = PDMINS_2_DATA(pDevIns, PVIRTIOCORE);
2077	PVIRTIOCORECC pVirtioCC = PDMINS_2_DATA_CC(pDevIns, PVIRTIOCORECC);
2078	RT_NOREF(pPciDev);
2079
2080	if (uAddress == pVirtio->uPciCfgDataOff)
2081	{
2082	/* See comments in PCI Cfg capability initialization (in capabilities setup section of this code) */
2083	struct virtio_pci_cap *pPciCap = &pVirtioCC->pPciCfgCap->pciCap;
2084	uint32_t uLength = pPciCap->uLength;
2085
2086	Log7Func((" pDevIns=%p pPciDev=%p uAddress=%#x%s cb=%u uLength=%d, bar=%d\n",
2087	pDevIns, pPciDev, uAddress, uAddress < 0x10 ? " " : "", cb, uLength, pPciCap->uBar));
2088
2089	if ( (uLength != 1 && uLength != 2 && uLength != 4)
2090	\|\| pPciCap->uBar != VIRTIO_REGION_PCI_CAP)
2091	{
2092	ASSERT_GUEST_MSG_FAILED(("Guest read virtio_pci_cfg_cap.pci_cfg_data using mismatching config. "
2093	"Ignoring\n"));
2094	*pu32Value = UINT32_MAX;
2095	return VINF_SUCCESS;
2096	}
2097
2098	VBOXSTRICTRC rcStrict = virtioMmioRead(pDevIns, pVirtio, pPciCap->uOffset, pu32Value, cb);
2099	Log7Func((" Guest read virtio_pci_cfg_cap.pci_cfg_data, bar=%d, offset=%d, length=%d, result=0x%x -> %Rrc\n",
2100	pPciCap->uBar, pPciCap->uOffset, uLength, *pu32Value, VBOXSTRICTRC_VAL(rcStrict)));
2101	return rcStrict;
2102	}
2103	Log7Func((" pDevIns=%p pPciDev=%p uAddress=%#x%s cb=%u pu32Value=%p\n",
2104	pDevIns, pPciDev, uAddress, uAddress < 0x10 ? " " : "", cb, pu32Value));
2105	return VINF_PDM_PCI_DO_DEFAULT;
2106	}
2107
2108	/**
2109	* @callback_method_impl{FNPCICONFIGWRITE}
2110	*/
2111	static DECLCALLBACK(VBOXSTRICTRC) virtioR3PciConfigWrite(PPDMDEVINS pDevIns, PPDMPCIDEV pPciDev,
2112	uint32_t uAddress, unsigned cb, uint32_t u32Value)
2113	{
2114	PVIRTIOCORE pVirtio = PDMINS_2_DATA(pDevIns, PVIRTIOCORE);
2115	PVIRTIOCORECC pVirtioCC = PDMINS_2_DATA_CC(pDevIns, PVIRTIOCORECC);
2116	RT_NOREF(pPciDev);
2117
2118	Log7Func(("pDevIns=%p pPciDev=%p uAddress=%#x %scb=%u u32Value=%#x\n", pDevIns, pPciDev, uAddress, uAddress < 0xf ? " " : "", cb, u32Value));
2119	if (uAddress == pVirtio->uPciCfgDataOff)
2120	{
2121	/* See comments in PCI Cfg capability initialization (in capabilities setup section of this code) */
2122	struct virtio_pci_cap *pPciCap = &pVirtioCC->pPciCfgCap->pciCap;
2123	uint32_t uLength = pPciCap->uLength;
2124
2125	if ( (uLength != 1 && uLength != 2 && uLength != 4)
2126	\|\| cb != uLength
2127	\|\| pPciCap->uBar != VIRTIO_REGION_PCI_CAP)
2128	{
2129	ASSERT_GUEST_MSG_FAILED(("Guest write virtio_pci_cfg_cap.pci_cfg_data using mismatching config. Ignoring\n"));
2130	return VINF_SUCCESS;
2131	}
2132
2133	VBOXSTRICTRC rcStrict = virtioMmioWrite(pDevIns, pVirtio, pPciCap->uOffset, &u32Value, cb);
2134	Log2Func(("Guest wrote virtio_pci_cfg_cap.pci_cfg_data, bar=%d, offset=%x, length=%x, value=%d -> %Rrc\n",
2135	pPciCap->uBar, pPciCap->uOffset, uLength, u32Value, VBOXSTRICTRC_VAL(rcStrict)));
2136	return rcStrict;
2137	}
2138	return VINF_PDM_PCI_DO_DEFAULT;
2139	}
2140
2141
2142	/*********************************************************************************************************************************
2143	* Saved state (SSM) *
2144	*********************************************************************************************************************************/
2145
2146
2147	/**
2148	* Loads a saved device state (called from device-specific code on SSM final pass)
2149	*
2150	* @param pVirtio Pointer to the shared virtio state.
2151	* @param pHlp The ring-3 device helpers.
2152	* @param pSSM The saved state handle.
2153	* @returns VBox status code.
2154	*/
2155	int virtioCoreR3LegacyDeviceLoadExec(PVIRTIOCORE pVirtio, PCPDMDEVHLPR3 pHlp,
2156	PSSMHANDLE pSSM, uint32_t uVersion, uint32_t uVirtioLegacy_3_1_Beta)
2157	{
2158	int rc;
2159	uint32_t uDriverFeaturesLegacy32bit;
2160
2161	rc = pHlp->pfnSSMGetU32( pSSM, &uDriverFeaturesLegacy32bit);
2162	AssertRCReturn(rc, rc);
2163	pVirtio->uDriverFeatures = (uint64_t)uDriverFeaturesLegacy32bit;
2164
2165	rc = pHlp->pfnSSMGetU16( pSSM, &pVirtio->uVirtqSelect);
2166	AssertRCReturn(rc, rc);
2167
2168	rc = pHlp->pfnSSMGetU8( pSSM, &pVirtio->fDeviceStatus);
2169	AssertRCReturn(rc, rc);
2170
2171	#ifdef LOG_ENABLED
2172	char szOut[80] = { 0 };
2173	virtioCoreFormatDeviceStatus(pVirtio->fDeviceStatus, szOut, sizeof(szOut));
2174	Log(("Loaded legacy device status = (%s)\n", szOut));
2175	#endif
2176
2177	rc = pHlp->pfnSSMGetU8( pSSM, &pVirtio->uISR);
2178	AssertRCReturn(rc, rc);
2179
2180	uint32_t cQueues = 3; /* This constant default value copied from earliest v0.9 code */
2181	if (uVersion > uVirtioLegacy_3_1_Beta)
2182	{
2183	rc = pHlp->pfnSSMGetU32(pSSM, &cQueues);
2184	AssertRCReturn(rc, rc);
2185	}
2186
2187	AssertLogRelMsgReturn(cQueues <= VIRTQ_MAX_COUNT, ("%#x\n", cQueues), VERR_SSM_LOAD_CONFIG_MISMATCH);
2188	AssertLogRelMsgReturn(pVirtio->uVirtqSelect < cQueues \|\| (cQueues == 0 && pVirtio->uVirtqSelect),
2189	("uVirtqSelect=%u cQueues=%u\n", pVirtio->uVirtqSelect, cQueues),
2190	VERR_SSM_LOAD_CONFIG_MISMATCH);
2191
2192	Log(("\nRestoring %d legacy-only virtio-net device queues from saved state:\n", cQueues));
2193	for (unsigned uVirtq = 0; uVirtq < cQueues; uVirtq++)
2194	{
2195	PVIRTQUEUE pVirtq = &pVirtio->aVirtqueues[uVirtq];
2196
2197	if (uVirtq == cQueues - 1)
2198	RTStrPrintf(pVirtq->szName, sizeof(pVirtq->szName), "legacy-ctrlq");
2199	else if (uVirtq % 2)
2200	RTStrPrintf(pVirtq->szName, sizeof(pVirtq->szName), "legacy-xmitq<%d>", uVirtq / 2);
2201	else
2202	RTStrPrintf(pVirtq->szName, sizeof(pVirtq->szName), "legacy-recvq<%d>", uVirtq / 2);
2203
2204	rc = pHlp->pfnSSMGetU16(pSSM, &pVirtq->uQueueSize);
2205	AssertRCReturn(rc, rc);
2206
2207	uint32_t uVirtqPfn;
2208	rc = pHlp->pfnSSMGetU32(pSSM, &uVirtqPfn);
2209	AssertRCReturn(rc, rc);
2210
2211	rc = pHlp->pfnSSMGetU16(pSSM, &pVirtq->uAvailIdxShadow);
2212	AssertRCReturn(rc, rc);
2213
2214	rc = pHlp->pfnSSMGetU16(pSSM, &pVirtq->uUsedIdxShadow);
2215	AssertRCReturn(rc, rc);
2216
2217	if (uVirtqPfn)
2218	{
2219	pVirtq->GCPhysVirtqDesc = (uint64_t)uVirtqPfn * VIRTIO_PAGE_SIZE;
2220	pVirtq->GCPhysVirtqAvail = pVirtq->GCPhysVirtqDesc + sizeof(VIRTQ_DESC_T) * pVirtq->uQueueSize;
2221	pVirtq->GCPhysVirtqUsed =
2222	RT_ALIGN(pVirtq->GCPhysVirtqAvail + RT_UOFFSETOF_DYN(VIRTQ_AVAIL_T, auRing[pVirtq->uQueueSize]), VIRTIO_PAGE_SIZE);
2223	pVirtq->uEnable = 1;
2224	}
2225	else
2226	{
2227	LogFunc(("WARNING: QUEUE \"%s\" PAGE NUMBER ZERO IN SAVED STATE\n", pVirtq->szName));
2228	pVirtq->uEnable = 0;
2229	}
2230	pVirtq->uNotifyOffset = 0; /* unused in legacy mode */
2231	pVirtq->uMsixVector = 0; /* unused in legacy mode */
2232	}
2233	pVirtio->fGenUpdatePending = 0; /* unused in legacy mode */
2234	pVirtio->uConfigGeneration = 0; /* unused in legacy mode */
2235	pVirtio->uPciCfgDataOff = 0; /* unused in legacy mode (port I/O used instead) */
2236
2237	return VINF_SUCCESS;
2238	}
2239
2240	/**
2241	* Loads a saved device state (called from device-specific code on SSM final pass)
2242	*
2243	* Note: This loads state saved by a Modern (VirtIO 1.0+) device, of which this transitional device is one,
2244	* and thus supports both legacy and modern guest virtio drivers.
2245	*
2246	* @param pVirtio Pointer to the shared virtio state.
2247	* @param pHlp The ring-3 device helpers.
2248	* @param pSSM The saved state handle.
2249	* @returns VBox status code.
2250	*/
2251	int virtioCoreR3ModernDeviceLoadExec(PVIRTIOCORE pVirtio, PCPDMDEVHLPR3 pHlp, PSSMHANDLE pSSM, uint32_t uVersion, uint32_t uTestVersion, uint32_t cQueues)
2252	{
2253	RT_NOREF2(cQueues, uVersion);
2254	LogFunc(("\n"));
2255	/*
2256	* Check the marker and (embedded) version number.
2257	*/
2258	uint64_t uMarker = 0;
2259	int rc;
2260
2261	rc = pHlp->pfnSSMGetU64(pSSM, &uMarker);
2262	AssertRCReturn(rc, rc);
2263	if (uMarker != VIRTIO_SAVEDSTATE_MARKER)
2264	return pHlp->pfnSSMSetLoadError(pSSM, VERR_SSM_DATA_UNIT_FORMAT_CHANGED, RT_SRC_POS,
2265	N_("Expected marker value %#RX64 found %#RX64 instead"),
2266	VIRTIO_SAVEDSTATE_MARKER, uMarker);
2267	uint32_t uVersionSaved = 0;
2268	rc = pHlp->pfnSSMGetU32(pSSM, &uVersionSaved);
2269	AssertRCReturn(rc, rc);
2270	if (uVersionSaved != uTestVersion)
2271	return pHlp->pfnSSMSetLoadError(pSSM, VERR_SSM_DATA_UNIT_FORMAT_CHANGED, RT_SRC_POS,
2272	N_("Unsupported virtio version: %u"), uVersionSaved);
2273	/*
2274	* Load the state.
2275	*/
2276	rc = pHlp->pfnSSMGetU32( pSSM, &pVirtio->fLegacyDriver);
2277	AssertRCReturn(rc, rc);
2278	rc = pHlp->pfnSSMGetBool( pSSM, &pVirtio->fGenUpdatePending);
2279	AssertRCReturn(rc, rc);
2280	rc = pHlp->pfnSSMGetU8( pSSM, &pVirtio->fDeviceStatus);
2281	AssertRCReturn(rc, rc);
2282	rc = pHlp->pfnSSMGetU8( pSSM, &pVirtio->uConfigGeneration);
2283	AssertRCReturn(rc, rc);
2284	rc = pHlp->pfnSSMGetU8( pSSM, &pVirtio->uPciCfgDataOff);
2285	AssertRCReturn(rc, rc);
2286	rc = pHlp->pfnSSMGetU8( pSSM, &pVirtio->uISR);
2287	AssertRCReturn(rc, rc);
2288	rc = pHlp->pfnSSMGetU16( pSSM, &pVirtio->uVirtqSelect);
2289	AssertRCReturn(rc, rc);
2290	rc = pHlp->pfnSSMGetU32( pSSM, &pVirtio->uDeviceFeaturesSelect);
2291	AssertRCReturn(rc, rc);
2292	rc = pHlp->pfnSSMGetU32( pSSM, &pVirtio->uDriverFeaturesSelect);
2293	AssertRCReturn(rc, rc);
2294	rc = pHlp->pfnSSMGetU64( pSSM, &pVirtio->uDriverFeatures);
2295	AssertRCReturn(rc, rc);
2296
2297	/** @todo Adapt this loop use cQueues argument instead of static queue count (safely with SSM versioning) */
2298	for (uint32_t i = 0; i < VIRTQ_MAX_COUNT; i++)
2299	{
2300	PVIRTQUEUE pVirtq = &pVirtio->aVirtqueues[i];
2301	rc = pHlp->pfnSSMGetGCPhys64( pSSM, &pVirtq->GCPhysVirtqDesc);
2302	AssertRCReturn(rc, rc);
2303	rc = pHlp->pfnSSMGetGCPhys64( pSSM, &pVirtq->GCPhysVirtqAvail);
2304	AssertRCReturn(rc, rc);
2305	rc = pHlp->pfnSSMGetGCPhys64( pSSM, &pVirtq->GCPhysVirtqUsed);
2306	AssertRCReturn(rc, rc);
2307	rc = pHlp->pfnSSMGetU16( pSSM, &pVirtq->uNotifyOffset);
2308	AssertRCReturn(rc, rc);
2309	rc = pHlp->pfnSSMGetU16( pSSM, &pVirtq->uMsixVector);
2310	AssertRCReturn(rc, rc);
2311	rc = pHlp->pfnSSMGetU16( pSSM, &pVirtq->uEnable);
2312	AssertRCReturn(rc, rc);
2313	rc = pHlp->pfnSSMGetU16( pSSM, &pVirtq->uQueueSize);
2314	AssertRCReturn(rc, rc);
2315	rc = pHlp->pfnSSMGetU16( pSSM, &pVirtq->uAvailIdxShadow);
2316	AssertRCReturn(rc, rc);
2317	rc = pHlp->pfnSSMGetU16( pSSM, &pVirtq->uUsedIdxShadow);
2318	AssertRCReturn(rc, rc);
2319	rc = pHlp->pfnSSMGetMem( pSSM, pVirtq->szName, sizeof(pVirtq->szName));
2320	AssertRCReturn(rc, rc);
2321	}
2322	return VINF_SUCCESS;
2323	}
2324
2325	/**
2326	* Called from the FNSSMDEVSAVEEXEC function of the device.
2327	*
2328	* @param pVirtio Pointer to the shared virtio state.
2329	* @param pHlp The ring-3 device helpers.
2330	* @param pSSM The saved state handle.
2331	* @returns VBox status code.
2332	*/
2333	int virtioCoreR3SaveExec(PVIRTIOCORE pVirtio, PCPDMDEVHLPR3 pHlp, PSSMHANDLE pSSM, uint32_t uVersion, uint32_t cQueues)
2334	{
2335	RT_NOREF(cQueues);
2336	/** @todo figure out a way to save cQueues (with SSM versioning) */
2337
2338	LogFunc(("\n"));
2339	pHlp->pfnSSMPutU64(pSSM, VIRTIO_SAVEDSTATE_MARKER);
2340	pHlp->pfnSSMPutU32(pSSM, uVersion);
2341
2342	pHlp->pfnSSMPutU32( pSSM, pVirtio->fLegacyDriver);
2343	pHlp->pfnSSMPutBool(pSSM, pVirtio->fGenUpdatePending);
2344	pHlp->pfnSSMPutU8( pSSM, pVirtio->fDeviceStatus);
2345	pHlp->pfnSSMPutU8( pSSM, pVirtio->uConfigGeneration);
2346	pHlp->pfnSSMPutU8( pSSM, pVirtio->uPciCfgDataOff);
2347	pHlp->pfnSSMPutU8( pSSM, pVirtio->uISR);
2348	pHlp->pfnSSMPutU16( pSSM, pVirtio->uVirtqSelect);
2349	pHlp->pfnSSMPutU32( pSSM, pVirtio->uDeviceFeaturesSelect);
2350	pHlp->pfnSSMPutU32( pSSM, pVirtio->uDriverFeaturesSelect);
2351	pHlp->pfnSSMPutU64( pSSM, pVirtio->uDriverFeatures);
2352
2353	for (uint32_t i = 0; i < VIRTQ_MAX_COUNT; i++)
2354	{
2355	PVIRTQUEUE pVirtq = &pVirtio->aVirtqueues[i];
2356
2357	pHlp->pfnSSMPutGCPhys64( pSSM, pVirtq->GCPhysVirtqDesc);
2358	pHlp->pfnSSMPutGCPhys64( pSSM, pVirtq->GCPhysVirtqAvail);
2359	pHlp->pfnSSMPutGCPhys64( pSSM, pVirtq->GCPhysVirtqUsed);
2360	pHlp->pfnSSMPutU16( pSSM, pVirtq->uNotifyOffset);
2361	pHlp->pfnSSMPutU16( pSSM, pVirtq->uMsixVector);
2362	pHlp->pfnSSMPutU16( pSSM, pVirtq->uEnable);
2363	pHlp->pfnSSMPutU16( pSSM, pVirtq->uQueueSize);
2364	pHlp->pfnSSMPutU16( pSSM, pVirtq->uAvailIdxShadow);
2365	pHlp->pfnSSMPutU16( pSSM, pVirtq->uUsedIdxShadow);
2366	int rc = pHlp->pfnSSMPutMem(pSSM, pVirtq->szName, 32);
2367	AssertRCReturn(rc, rc);
2368	}
2369	return VINF_SUCCESS;
2370	}
2371
2372
2373	/*********************************************************************************************************************************
2374	* Device Level *
2375	*********************************************************************************************************************************/
2376
2377	/**
2378	* This must be called by the client to handle VM state changes after the client takes care of its device-specific
2379	* tasks for the state change (i.e. reset, suspend, power-off, resume)
2380	*
2381	* @param pDevIns The device instance.
2382	* @param pVirtio Pointer to the shared virtio state.
2383	*/
2384	void virtioCoreR3VmStateChanged(PVIRTIOCORE pVirtio, VIRTIOVMSTATECHANGED enmState)
2385	{
2386	LogFunc(("State changing to %s\n",
2387	virtioCoreGetStateChangeText(enmState)));
2388
2389	switch(enmState)
2390	{
2391	case kvirtIoVmStateChangedReset:
2392	virtioCoreResetAll(pVirtio);
2393	break;
2394	case kvirtIoVmStateChangedSuspend:
2395	break;
2396	case kvirtIoVmStateChangedPowerOff:
2397	break;
2398	case kvirtIoVmStateChangedResume:
2399	for (int uVirtq = 0; uVirtq < VIRTQ_MAX_COUNT; uVirtq++)
2400	{
2401	if ((!pVirtio->fLegacyDriver && pVirtio->aVirtqueues[uVirtq].uEnable)
2402	\| pVirtio->aVirtqueues[uVirtq].GCPhysVirtqDesc)
2403	virtioCoreNotifyGuestDriver(pVirtio->pDevInsR3, pVirtio, uVirtq);
2404	}
2405	break;
2406	default:
2407	LogRelFunc(("Bad enum value"));
2408	return;
2409	}
2410	}
2411
2412	/**
2413	* This should be called from PDMDEVREGR3::pfnDestruct.
2414	*
2415	* @param pDevIns The device instance.
2416	* @param pVirtio Pointer to the shared virtio state.
2417	* @param pVirtioCC Pointer to the ring-3 virtio state.
2418	*/
2419	void virtioCoreR3Term(PPDMDEVINS pDevIns, PVIRTIOCORE pVirtio, PVIRTIOCORECC pVirtioCC)
2420	{
2421	if (pVirtioCC->pbPrevDevSpecificCfg)
2422	{
2423	RTMemFree(pVirtioCC->pbPrevDevSpecificCfg);
2424	pVirtioCC->pbPrevDevSpecificCfg = NULL;
2425	}
2426
2427	RT_NOREF(pDevIns, pVirtio);
2428	}
2429
2430	/** API Function: See header file */
2431	int virtioCoreR3Init(PPDMDEVINS pDevIns, PVIRTIOCORE pVirtio, PVIRTIOCORECC pVirtioCC, PVIRTIOPCIPARAMS pPciParams,
2432	const char *pcszInstance, uint64_t fDevSpecificFeatures, uint32_t fOfferLegacy,
2433	void *pvDevSpecificCfg, uint16_t cbDevSpecificCfg)
2434	{
2435	/*
2436	* Virtio state must be the first member of shared device instance data,
2437	* otherwise can't get our bearings in PCI config callbacks.
2438	*/
2439	AssertLogRelReturn(pVirtio == PDMINS_2_DATA(pDevIns, PVIRTIOCORE), VERR_STATE_CHANGED);
2440	AssertLogRelReturn(pVirtioCC == PDMINS_2_DATA_CC(pDevIns, PVIRTIOCORECC), VERR_STATE_CHANGED);
2441
2442	pVirtio->pDevInsR3 = pDevIns;
2443
2444	/*
2445	* Caller must initialize these.
2446	*/
2447	AssertReturn(pVirtioCC->pfnStatusChanged, VERR_INVALID_POINTER);
2448	AssertReturn(pVirtioCC->pfnVirtqNotified, VERR_INVALID_POINTER);
2449	AssertReturn(VIRTQ_SIZE > 0 && VIRTQ_SIZE <= 32768, VERR_OUT_OF_RANGE); /* VirtIO specification-defined limit */
2450
2451	#if 0 /* Until pdmR3DvHlp_PCISetIrq() impl is fixed and Assert that limits vec to 0 is removed
2452	* VBox legacy MSI support has not been implemented yet
2453	*/
2454	# ifdef VBOX_WITH_MSI_DEVICES
2455	pVirtio->fMsiSupport = true;
2456	# endif
2457	#endif
2458
2459	/*
2460	* Host features (presented as a smörgasbord for guest to select from)
2461	* include both dev-specific features & reserved dev-independent features (bitmask).
2462	*/
2463	pVirtio->uDeviceFeatures = VIRTIO_F_VERSION_1
2464	\| VIRTIO_DEV_INDEPENDENT_FEATURES_OFFERED
2465	\| fDevSpecificFeatures;
2466
2467	pVirtio->fLegacyDriver = pVirtio->fOfferLegacy = fOfferLegacy;
2468
2469	RTStrCopy(pVirtio->szInstance, sizeof(pVirtio->szInstance), pcszInstance);
2470	pVirtioCC->cbDevSpecificCfg = cbDevSpecificCfg;
2471	pVirtioCC->pbDevSpecificCfg = (uint8_t *)pvDevSpecificCfg;
2472	pVirtioCC->pbPrevDevSpecificCfg = (uint8_t *)RTMemDup(pvDevSpecificCfg, cbDevSpecificCfg);
2473	AssertLogRelReturn(pVirtioCC->pbPrevDevSpecificCfg, VERR_NO_MEMORY);
2474
2475	/* Set PCI config registers (assume 32-bit mode) */
2476	PPDMPCIDEV pPciDev = pDevIns->apPciDevs[0];
2477	PDMPCIDEV_ASSERT_VALID(pDevIns, pPciDev);
2478
2479	PDMPciDevSetVendorId(pPciDev, DEVICE_PCI_VENDOR_ID_VIRTIO);
2480	PDMPciDevSetDeviceId(pPciDev, pPciParams->uDeviceId);
2481
2482	if (pPciParams->uDeviceId < DEVICE_PCI_DEVICE_ID_VIRTIO_BASE)
2483	/* Transitional devices MUST have a PCI Revision ID of 0. */
2484	PDMPciDevSetRevisionId(pPciDev, DEVICE_PCI_REVISION_ID_VIRTIO_TRANS);
2485	else
2486	/* Non-transitional devices SHOULD have a PCI Revision ID of 1 or higher. */
2487	PDMPciDevSetRevisionId(pPciDev, DEVICE_PCI_REVISION_ID_VIRTIO_V1);
2488
2489	PDMPciDevSetSubSystemId(pPciDev, pPciParams->uSubsystemId);
2490	PDMPciDevSetSubSystemVendorId(pPciDev, DEVICE_PCI_VENDOR_ID_VIRTIO);
2491	PDMPciDevSetClassBase(pPciDev, pPciParams->uClassBase);
2492	PDMPciDevSetClassSub(pPciDev, pPciParams->uClassSub);
2493	PDMPciDevSetClassProg(pPciDev, pPciParams->uClassProg);
2494	PDMPciDevSetInterruptLine(pPciDev, pPciParams->uInterruptLine);
2495	PDMPciDevSetInterruptPin(pPciDev, pPciParams->uInterruptPin);
2496
2497	/* Register PCI device */
2498	int rc = PDMDevHlpPCIRegister(pDevIns, pPciDev);
2499	if (RT_FAILURE(rc))
2500	return PDMDEV_SET_ERROR(pDevIns, rc, N_("virtio: cannot register PCI Device")); /* can we put params in this error? */
2501
2502	rc = PDMDevHlpPCIInterceptConfigAccesses(pDevIns, pPciDev, virtioR3PciConfigRead, virtioR3PciConfigWrite);
2503	AssertRCReturn(rc, rc);
2504
2505	/* Construct & map PCI vendor-specific capabilities for virtio host negotiation with guest driver */
2506
2507	#define CFG_ADDR_2_IDX(addr) ((uint8_t)(((uintptr_t)(addr) - (uintptr_t)&pPciDev->abConfig[0])))
2508	#define SET_PCI_CAP_LOC(a_pPciDev, a_pCfg, a_LocCap, a_uMmioLengthAlign) \
2509	do { \
2510	(a_LocCap).offMmio = (a_pCfg)->uOffset; \
2511	(a_LocCap).cbMmio = RT_ALIGN_T((a_pCfg)->uLength, a_uMmioLengthAlign, uint16_t); \
2512	(a_LocCap).offPci = (uint16_t)(uintptr_t)((uint8_t *)(a_pCfg) - &(a_pPciDev)->abConfig[0]); \
2513	(a_LocCap).cbPci = (a_pCfg)->uCapLen; \
2514	} while (0)
2515
2516	PVIRTIO_PCI_CAP_T pCfg;
2517	uint32_t cbRegion = 0;
2518
2519	/*
2520	* Common capability (VirtIO 1.0, section 4.1.4.3)
2521	*/
2522	pCfg = (PVIRTIO_PCI_CAP_T)&pPciDev->abConfig[0x40];
2523	pCfg->uCfgType = VIRTIO_PCI_CAP_COMMON_CFG;
2524	pCfg->uCapVndr = VIRTIO_PCI_CAP_ID_VENDOR;
2525	pCfg->uCapLen = sizeof(VIRTIO_PCI_CAP_T);
2526	pCfg->uCapNext = CFG_ADDR_2_IDX(pCfg) + pCfg->uCapLen;
2527	pCfg->uBar = VIRTIO_REGION_PCI_CAP;
2528	pCfg->uOffset = RT_ALIGN_32(0, 4); /* Currently 0, but reminder to 32-bit align if changing this */
2529	pCfg->uLength = sizeof(VIRTIO_PCI_COMMON_CFG_T);
2530	cbRegion += pCfg->uLength;
2531	SET_PCI_CAP_LOC(pPciDev, pCfg, pVirtio->LocCommonCfgCap, 2);
2532	pVirtioCC->pCommonCfgCap = pCfg;
2533
2534	/*
2535	* Notify capability (VirtIO 1.0, section 4.1.4.4).
2536	*
2537	* The size of the spec-defined subregion described by this VirtIO capability is
2538	* based-on the choice of this implementation to make the notification area of each
2539	* queue equal to queue's ordinal position (e.g. queue selector value). The VirtIO
2540	* specification leaves it up to implementation to define queue notification area layout.
2541	*/
2542	pCfg = (PVIRTIO_PCI_CAP_T)&pPciDev->abConfig[pCfg->uCapNext];
2543	pCfg->uCfgType = VIRTIO_PCI_CAP_NOTIFY_CFG;
2544	pCfg->uCapVndr = VIRTIO_PCI_CAP_ID_VENDOR;
2545	pCfg->uCapLen = sizeof(VIRTIO_PCI_NOTIFY_CAP_T);
2546	pCfg->uCapNext = CFG_ADDR_2_IDX(pCfg) + pCfg->uCapLen;
2547	pCfg->uBar = VIRTIO_REGION_PCI_CAP;
2548	pCfg->uOffset = pVirtioCC->pCommonCfgCap->uOffset + pVirtioCC->pCommonCfgCap->uLength;
2549	pCfg->uOffset = RT_ALIGN_32(pCfg->uOffset, 4);
2550	pCfg->uLength = VIRTQ_MAX_COUNT * VIRTIO_NOTIFY_OFFSET_MULTIPLIER + 2; /* will change in VirtIO 1.1 */
2551	cbRegion += pCfg->uLength;
2552	SET_PCI_CAP_LOC(pPciDev, pCfg, pVirtio->LocNotifyCap, 1);
2553	pVirtioCC->pNotifyCap = (PVIRTIO_PCI_NOTIFY_CAP_T)pCfg;
2554	pVirtioCC->pNotifyCap->uNotifyOffMultiplier = VIRTIO_NOTIFY_OFFSET_MULTIPLIER;
2555
2556	/* ISR capability (VirtIO 1.0, section 4.1.4.5)
2557	*
2558	* VirtIO 1.0 spec says 8-bit, unaligned in MMIO space. The specification example/diagram
2559	* illustrates this capability as 32-bit field with upper bits 'reserved'. Those depictions
2560	* differ. The spec's wording, not the diagram, is seen to work in practice.
2561	*/
2562	pCfg = (PVIRTIO_PCI_CAP_T)&pPciDev->abConfig[pCfg->uCapNext];
2563	pCfg->uCfgType = VIRTIO_PCI_CAP_ISR_CFG;
2564	pCfg->uCapVndr = VIRTIO_PCI_CAP_ID_VENDOR;
2565	pCfg->uCapLen = sizeof(VIRTIO_PCI_CAP_T);
2566	pCfg->uCapNext = CFG_ADDR_2_IDX(pCfg) + pCfg->uCapLen;
2567	pCfg->uBar = VIRTIO_REGION_PCI_CAP;
2568	pCfg->uOffset = pVirtioCC->pNotifyCap->pciCap.uOffset + pVirtioCC->pNotifyCap->pciCap.uLength;
2569	pCfg->uOffset = RT_ALIGN_32(pCfg->uOffset, 4);
2570	pCfg->uLength = sizeof(uint8_t);
2571	cbRegion += pCfg->uLength;
2572	SET_PCI_CAP_LOC(pPciDev, pCfg, pVirtio->LocIsrCap, 4);
2573	pVirtioCC->pIsrCap = pCfg;
2574
2575	/* PCI Cfg capability (VirtIO 1.0, section 4.1.4.7)
2576	*
2577	* This capability facilitates early-boot access to this device (BIOS).
2578	* This region isn't page-MMIO mapped. PCI configuration accesses are intercepted,
2579	* wherein uBar, uOffset and uLength are modulated by consumers to locate and read/write
2580	* values in any part of any region. (NOTE: Linux driver doesn't utilize this feature.
2581	* This capability only appears in lspci output on Linux if uLength is non-zero, 4-byte aligned,
2582	* during initialization of linux virtio driver).
2583	*/
2584	pVirtio->uPciCfgDataOff = pCfg->uCapNext + RT_OFFSETOF(VIRTIO_PCI_CFG_CAP_T, uPciCfgData);
2585	pCfg = (PVIRTIO_PCI_CAP_T)&pPciDev->abConfig[pCfg->uCapNext];
2586	pCfg->uCfgType = VIRTIO_PCI_CAP_PCI_CFG;
2587	pCfg->uCapVndr = VIRTIO_PCI_CAP_ID_VENDOR;
2588	pCfg->uCapLen = sizeof(VIRTIO_PCI_CFG_CAP_T);
2589	pCfg->uCapNext = (pVirtio->fMsiSupport \|\| pVirtioCC->pbDevSpecificCfg) ? CFG_ADDR_2_IDX(pCfg) + pCfg->uCapLen : 0;
2590	pCfg->uBar = VIRTIO_REGION_PCI_CAP;
2591	pCfg->uOffset = 0;
2592	pCfg->uLength = 4;
2593	cbRegion += pCfg->uLength;
2594	SET_PCI_CAP_LOC(pPciDev, pCfg, pVirtio->LocPciCfgCap, 1);
2595	pVirtioCC->pPciCfgCap = (PVIRTIO_PCI_CFG_CAP_T)pCfg;
2596
2597	if (pVirtioCC->pbDevSpecificCfg)
2598	{
2599	/* Device-specific config capability (VirtIO 1.0, section 4.1.4.6).
2600	*
2601	* Client defines the device-specific config struct and passes size to virtioCoreR3Init()
2602	* to inform this.
2603	*/
2604	pCfg = (PVIRTIO_PCI_CAP_T)&pPciDev->abConfig[pCfg->uCapNext];
2605	pCfg->uCfgType = VIRTIO_PCI_CAP_DEVICE_CFG;
2606	pCfg->uCapVndr = VIRTIO_PCI_CAP_ID_VENDOR;
2607	pCfg->uCapLen = sizeof(VIRTIO_PCI_CAP_T);
2608	pCfg->uCapNext = pVirtio->fMsiSupport ? CFG_ADDR_2_IDX(pCfg) + pCfg->uCapLen : 0;
2609	pCfg->uBar = VIRTIO_REGION_PCI_CAP;
2610	pCfg->uOffset = pVirtioCC->pIsrCap->uOffset + pVirtioCC->pIsrCap->uLength;
2611	pCfg->uOffset = RT_ALIGN_32(pCfg->uOffset, 4);
2612	pCfg->uLength = cbDevSpecificCfg;
2613	cbRegion += pCfg->uLength;
2614	SET_PCI_CAP_LOC(pPciDev, pCfg, pVirtio->LocDeviceCap, 4);
2615	pVirtioCC->pDeviceCap = pCfg;
2616	}
2617	else
2618	Assert(pVirtio->LocDeviceCap.cbMmio == 0 && pVirtio->LocDeviceCap.cbPci == 0);
2619
2620	if (pVirtio->fMsiSupport)
2621	{
2622	PDMMSIREG aMsiReg;
2623	RT_ZERO(aMsiReg);
2624	aMsiReg.iMsixCapOffset = pCfg->uCapNext;
2625	aMsiReg.iMsixNextOffset = 0;
2626	aMsiReg.iMsixBar = VIRTIO_REGION_MSIX_CAP;
2627	aMsiReg.cMsixVectors = VBOX_MSIX_MAX_ENTRIES;
2628	rc = PDMDevHlpPCIRegisterMsi(pDevIns, &aMsiReg); /* see MsixR3init() */
2629	if (RT_FAILURE(rc))
2630	{
2631	/* See PDMDevHlp.cpp:pdmR3DevHlp_PCIRegisterMsi */
2632	LogFunc(("Failed to configure MSI-X (%Rrc). Reverting to INTx\n", rc));
2633	pVirtio->fMsiSupport = false;
2634	}
2635	else
2636	Log2Func(("Using MSI-X for guest driver notification\n"));
2637	}
2638	else
2639	LogFunc(("MSI-X not available for VBox, using INTx notification\n"));
2640
2641	/* Set offset to first capability and enable PCI dev capabilities */
2642	PDMPciDevSetCapabilityList(pPciDev, 0x40);
2643	PDMPciDevSetStatus(pPciDev, VBOX_PCI_STATUS_CAP_LIST);
2644
2645	size_t cbSize = RTStrPrintf(pVirtioCC->szMmioName, sizeof(pVirtioCC->szMmioName), "%s (modern)", pcszInstance);
2646	if (cbSize <= 0)
2647	return PDMDEV_SET_ERROR(pDevIns, rc, N_("virtio: out of memory allocating string")); /* can we put params in this error? */
2648
2649	cbSize = RTStrPrintf(pVirtioCC->szPortIoName, sizeof(pVirtioCC->szPortIoName), "%s (legacy)", pcszInstance);
2650	if (cbSize <= 0)
2651	return PDMDEV_SET_ERROR(pDevIns, rc, N_("virtio: out of memory allocating string")); /* can we put params in this error? */
2652
2653	if (pVirtio->fOfferLegacy)
2654	{
2655	/* As a transitional device that supports legacy VirtIO drivers, this VirtIO device generic implementation presents
2656	* legacy driver interface in I/O space at BAR0. The following maps the common (e.g. device independent)
2657	* dev config area as well as device-specific dev config area (whose size is passed to init function of this VirtIO
2658	* generic device code) for access via Port I/O, since legacy drivers (e.g. pre VirtIO 1.0) don't use MMIO callbacks.
2659	* (See VirtIO 1.1, Section 4.1.4.8).
2660	*/
2661	rc = PDMDevHlpPCIIORegionCreateIo(pDevIns, VIRTIO_REGION_LEGACY_IO, sizeof(VIRTIO_LEGACY_PCI_COMMON_CFG_T) + cbDevSpecificCfg,
2662	virtioLegacyIOPortOut, virtioLegacyIOPortIn, NULL /pvUser/, pVirtioCC->szPortIoName,
2663	NULL /paExtDescs/, &pVirtio->hLegacyIoPorts);
2664	AssertLogRelRCReturn(rc, PDMDEV_SET_ERROR(pDevIns, rc, N_("virtio: cannot register legacy config in I/O space at BAR0 */")));
2665	}
2666
2667	/* Note: The Linux driver at drivers/virtio/virtio_pci_modern.c tries to map at least a page for the
2668	* 'unknown' device-specific capability without querying the capability to determine size, so pad w/extra page.
2669	*/
2670	rc = PDMDevHlpPCIIORegionCreateMmio(pDevIns, VIRTIO_REGION_PCI_CAP, RT_ALIGN_32(cbRegion + VIRTIO_PAGE_SIZE, VIRTIO_PAGE_SIZE),
2671	PCI_ADDRESS_SPACE_MEM, virtioMmioWrite, virtioMmioRead, pVirtio,
2672	IOMMMIO_FLAGS_READ_PASSTHRU \| IOMMMIO_FLAGS_WRITE_PASSTHRU,
2673	pVirtioCC->szMmioName,
2674	&pVirtio->hMmioPciCap);
2675	AssertLogRelRCReturn(rc, PDMDEV_SET_ERROR(pDevIns, rc, N_("virtio: cannot register PCI Capabilities address space")));
2676	/*
2677	* Statistics.
2678	*/
2679	# ifdef VBOX_WITH_STATISTICS
2680	PDMDevHlpSTAMRegisterF(pDevIns, &pVirtio->StatDescChainsAllocated, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_COUNT,
2681	"Total number of allocated descriptor chains", "DescChainsAllocated");
2682	PDMDevHlpSTAMRegisterF(pDevIns, &pVirtio->StatDescChainsFreed, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_COUNT,
2683	"Total number of freed descriptor chains", "DescChainsFreed");
2684	PDMDevHlpSTAMRegisterF(pDevIns, &pVirtio->StatDescChainsSegsIn, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_COUNT,
2685	"Total number of inbound segments", "DescChainsSegsIn");
2686	PDMDevHlpSTAMRegisterF(pDevIns, &pVirtio->StatDescChainsSegsOut, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_COUNT,
2687	"Total number of outbound segments", "DescChainsSegsOut");
2688	PDMDevHlpSTAMRegister(pDevIns, &pVirtio->StatReadR3, STAMTYPE_PROFILE, "IO/ReadR3", STAMUNIT_TICKS_PER_CALL, "Profiling IO reads in R3");
2689	PDMDevHlpSTAMRegister(pDevIns, &pVirtio->StatReadR0, STAMTYPE_PROFILE, "IO/ReadR0", STAMUNIT_TICKS_PER_CALL, "Profiling IO reads in R0");
2690	PDMDevHlpSTAMRegister(pDevIns, &pVirtio->StatReadRC, STAMTYPE_PROFILE, "IO/ReadRC", STAMUNIT_TICKS_PER_CALL, "Profiling IO reads in RC");
2691	PDMDevHlpSTAMRegister(pDevIns, &pVirtio->StatWriteR3, STAMTYPE_PROFILE, "IO/WriteR3", STAMUNIT_TICKS_PER_CALL, "Profiling IO writes in R3");
2692	PDMDevHlpSTAMRegister(pDevIns, &pVirtio->StatWriteR0, STAMTYPE_PROFILE, "IO/WriteR0", STAMUNIT_TICKS_PER_CALL, "Profiling IO writes in R0");
2693	PDMDevHlpSTAMRegister(pDevIns, &pVirtio->StatWriteRC, STAMTYPE_PROFILE, "IO/WriteRC", STAMUNIT_TICKS_PER_CALL, "Profiling IO writes in RC");
2694	# endif /* VBOX_WITH_STATISTICS */
2695
2696	return VINF_SUCCESS;
2697	}
2698
2699	#else /* !IN_RING3 */
2700
2701	/**
2702	* Sets up the core ring-0/raw-mode virtio bits.
2703	*
2704	* @returns VBox status code.
2705	* @param pDevIns The device instance.
2706	* @param pVirtio Pointer to the shared virtio state. This must be the first
2707	* member in the shared device instance data!
2708	*/
2709	int virtioCoreRZInit(PPDMDEVINS pDevIns, PVIRTIOCORE pVirtio)
2710	{
2711	AssertLogRelReturn(pVirtio == PDMINS_2_DATA(pDevIns, PVIRTIOCORE), VERR_STATE_CHANGED);
2712	int rc;
2713	#ifdef FUTURE_OPTIMIZATION
2714	rc = PDMDevHlpSetDeviceCritSect(pDevIns, PDMDevHlpCritSectGetNop(pDevIns));
2715	AssertRCReturn(rc, rc);
2716	#endif
2717	rc = PDMDevHlpMmioSetUpContext(pDevIns, pVirtio->hMmioPciCap, virtioMmioWrite, virtioMmioRead, pVirtio);
2718	AssertRCReturn(rc, rc);
2719
2720	if (pVirtio->fOfferLegacy)
2721	{
2722	rc = PDMDevHlpIoPortSetUpContext(pDevIns, pVirtio->hLegacyIoPorts, virtioLegacyIOPortOut, virtioLegacyIOPortIn, NULL /pvUser/);
2723	AssertRCReturn(rc, rc);
2724	}
2725	return rc;
2726	}
2727
2728	#endif /* !IN_RING3 */
2729

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

source: vbox/trunk/src/VBox/Devices/VirtIO/VirtioCore.cpp@ 98661

Download in other formats: