Virtio.cpp@ 65620

Last change on this file since 65620 was 64834, checked in by vboxsync, 8 years ago
Devices/Virtio: In an unlikely event that the guest requests features we don't advertise, restrict requested features to supported ones, don't use all supported host features. While here refactor the code a bit to improve readability.
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 34.0 KB

Line
1	/* $Id: Virtio.cpp 64834 2016-12-12 16:35:07Z vboxsync $ */
2	/** @file
3	* Virtio - Virtio Common Functions (VRing, VQueue, Virtio PCI)
4	*/
5
6	/*
7	* Copyright (C) 2009-2016 Oracle Corporation
8	*
9	* This file is part of VirtualBox Open Source Edition (OSE), as
10	* available from http://www.virtualbox.org. This file is free software;
11	* you can redistribute it and/or modify it under the terms of the GNU
12	* General Public License (GPL) as published by the Free Software
13	* Foundation, in version 2 as it comes in the "COPYING" file of the
14	* VirtualBox OSE distribution. VirtualBox OSE is distributed in the
15	* hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
16	*/
17
18
19	/*********************************************************************************************************************************
20	* Header Files *
21	*********************************************************************************************************************************/
22	#define LOG_GROUP LOG_GROUP_DEV_VIRTIO
23
24	#include <iprt/param.h>
25	#include <iprt/uuid.h>
26	#include <VBox/vmm/pdmdev.h>
27	#include "Virtio.h"
28
29	#define INSTANCE(pState) pState->szInstance
30	#define IFACE_TO_STATE(pIface, ifaceName) ((VPCISTATE )((char)pIface - RT_OFFSETOF(VPCISTATE, ifaceName)))
31
32	#ifdef LOG_ENABLED
33	# define QUEUENAME(s, q) (q->pcszName)
34	#endif
35
36
37
38	#ifndef VBOX_DEVICE_STRUCT_TESTCASE
39
40	//RT_C_DECLS_BEGIN
41	//RT_C_DECLS_END
42
43
44	static void vqueueReset(PVQUEUE pQueue)
45	{
46	pQueue->VRing.addrDescriptors = 0;
47	pQueue->VRing.addrAvail = 0;
48	pQueue->VRing.addrUsed = 0;
49	pQueue->uNextAvailIndex = 0;
50	pQueue->uNextUsedIndex = 0;
51	pQueue->uPageNumber = 0;
52	}
53
54	static void vqueueInit(PVQUEUE pQueue, uint32_t uPageNumber)
55	{
56	pQueue->VRing.addrDescriptors = (uint64_t)uPageNumber << PAGE_SHIFT;
57	pQueue->VRing.addrAvail = pQueue->VRing.addrDescriptors
58	+ sizeof(VRINGDESC) * pQueue->VRing.uSize;
59	pQueue->VRing.addrUsed = RT_ALIGN(
60	pQueue->VRing.addrAvail + RT_OFFSETOF(VRINGAVAIL, auRing[pQueue->VRing.uSize]),
61	PAGE_SIZE); /* The used ring must start from the next page. */
62	pQueue->uNextAvailIndex = 0;
63	pQueue->uNextUsedIndex = 0;
64	}
65
66	// void vqueueElemFree(PVQUEUEELEM pElem)
67	// {
68	// }
69
70	void vringReadDesc(PVPCISTATE pState, PVRING pVRing, uint32_t uIndex, PVRINGDESC pDesc)
71	{
72	//Log(("%s vringReadDesc: ring=%p idx=%u\n", INSTANCE(pState), pVRing, uIndex));
73	PDMDevHlpPhysRead(pState->CTX_SUFF(pDevIns),
74	pVRing->addrDescriptors + sizeof(VRINGDESC) * (uIndex % pVRing->uSize),
75	pDesc, sizeof(VRINGDESC));
76	}
77
78	uint16_t vringReadAvail(PVPCISTATE pState, PVRING pVRing, uint32_t uIndex)
79	{
80	uint16_t tmp;
81
82	PDMDevHlpPhysRead(pState->CTX_SUFF(pDevIns),
83	pVRing->addrAvail + RT_OFFSETOF(VRINGAVAIL, auRing[uIndex % pVRing->uSize]),
84	&tmp, sizeof(tmp));
85	return tmp;
86	}
87
88	uint16_t vringReadAvailFlags(PVPCISTATE pState, PVRING pVRing)
89	{
90	uint16_t tmp;
91
92	PDMDevHlpPhysRead(pState->CTX_SUFF(pDevIns),
93	pVRing->addrAvail + RT_OFFSETOF(VRINGAVAIL, uFlags),
94	&tmp, sizeof(tmp));
95	return tmp;
96	}
97
98	void vringSetNotification(PVPCISTATE pState, PVRING pVRing, bool fEnabled)
99	{
100	uint16_t tmp;
101
102	PDMDevHlpPhysRead(pState->CTX_SUFF(pDevIns),
103	pVRing->addrUsed + RT_OFFSETOF(VRINGUSED, uFlags),
104	&tmp, sizeof(tmp));
105
106	if (fEnabled)
107	tmp &= ~ VRINGUSED_F_NO_NOTIFY;
108	else
109	tmp \|= VRINGUSED_F_NO_NOTIFY;
110
111	PDMDevHlpPCIPhysWrite(pState->CTX_SUFF(pDevIns),
112	pVRing->addrUsed + RT_OFFSETOF(VRINGUSED, uFlags),
113	&tmp, sizeof(tmp));
114	}
115
116	bool vqueueSkip(PVPCISTATE pState, PVQUEUE pQueue)
117	{
118	if (vqueueIsEmpty(pState, pQueue))
119	return false;
120
121	Log2(("%s vqueueSkip: %s avail_idx=%u\n", INSTANCE(pState),
122	QUEUENAME(pState, pQueue), pQueue->uNextAvailIndex));
123	pQueue->uNextAvailIndex++;
124	return true;
125	}
126
127	bool vqueueGet(PVPCISTATE pState, PVQUEUE pQueue, PVQUEUEELEM pElem, bool fRemove)
128	{
129	if (vqueueIsEmpty(pState, pQueue))
130	return false;
131
132	pElem->nIn = pElem->nOut = 0;
133
134	Log2(("%s vqueueGet: %s avail_idx=%u\n", INSTANCE(pState),
135	QUEUENAME(pState, pQueue), pQueue->uNextAvailIndex));
136
137	VRINGDESC desc;
138	uint16_t idx = vringReadAvail(pState, &pQueue->VRing, pQueue->uNextAvailIndex);
139	if (fRemove)
140	pQueue->uNextAvailIndex++;
141	pElem->uIndex = idx;
142	do
143	{
144	VQUEUESEG *pSeg;
145
146	/*
147	* Malicious guests may try to trick us into writing beyond aSegsIn or
148	* aSegsOut boundaries by linking several descriptors into a loop. We
149	* cannot possibly get a sequence of linked descriptors exceeding the
150	* total number of descriptors in the ring (see @bugref{8620}).
151	*/
152	if (pElem->nIn + pElem->nOut >= VRING_MAX_SIZE)
153	{
154	static volatile uint32_t s_cMessages = 0;
155	static volatile uint32_t s_cThreshold = 1;
156	if (ASMAtomicIncU32(&s_cMessages) == ASMAtomicReadU32(&s_cThreshold))
157	{
158	LogRel(("%s: too many linked descriptors; check if the guest arranges descriptors in a loop.\n",
159	INSTANCE(pState)));
160	if (ASMAtomicReadU32(&s_cMessages) != 1)
161	LogRel(("%s: (the above error has occured %u times so far)\n",
162	INSTANCE(pState), ASMAtomicReadU32(&s_cMessages)));
163	ASMAtomicWriteU32(&s_cThreshold, ASMAtomicReadU32(&s_cThreshold) * 10);
164	}
165	break;
166	}
167
168	vringReadDesc(pState, &pQueue->VRing, idx, &desc);
169	if (desc.u16Flags & VRINGDESC_F_WRITE)
170	{
171	Log2(("%s vqueueGet: %s IN seg=%u desc_idx=%u addr=%p cb=%u\n", INSTANCE(pState),
172	QUEUENAME(pState, pQueue), pElem->nIn, idx, desc.u64Addr, desc.uLen));
173	pSeg = &pElem->aSegsIn[pElem->nIn++];
174	}
175	else
176	{
177	Log2(("%s vqueueGet: %s OUT seg=%u desc_idx=%u addr=%p cb=%u\n", INSTANCE(pState),
178	QUEUENAME(pState, pQueue), pElem->nOut, idx, desc.u64Addr, desc.uLen));
179	pSeg = &pElem->aSegsOut[pElem->nOut++];
180	}
181
182	pSeg->addr = desc.u64Addr;
183	pSeg->cb = desc.uLen;
184	pSeg->pv = NULL;
185
186	idx = desc.u16Next;
187	} while (desc.u16Flags & VRINGDESC_F_NEXT);
188
189	Log2(("%s vqueueGet: %s head_desc_idx=%u nIn=%u nOut=%u\n", INSTANCE(pState),
190	QUEUENAME(pState, pQueue), pElem->uIndex, pElem->nIn, pElem->nOut));
191	return true;
192	}
193
194	uint16_t vringReadUsedIndex(PVPCISTATE pState, PVRING pVRing)
195	{
196	uint16_t tmp;
197	PDMDevHlpPhysRead(pState->CTX_SUFF(pDevIns),
198	pVRing->addrUsed + RT_OFFSETOF(VRINGUSED, uIndex),
199	&tmp, sizeof(tmp));
200	return tmp;
201	}
202
203	void vringWriteUsedIndex(PVPCISTATE pState, PVRING pVRing, uint16_t u16Value)
204	{
205	PDMDevHlpPCIPhysWrite(pState->CTX_SUFF(pDevIns),
206	pVRing->addrUsed + RT_OFFSETOF(VRINGUSED, uIndex),
207	&u16Value, sizeof(u16Value));
208	}
209
210	void vringWriteUsedElem(PVPCISTATE pState, PVRING pVRing, uint32_t uIndex, uint32_t uId, uint32_t uLen)
211	{
212	VRINGUSEDELEM elem;
213
214	elem.uId = uId;
215	elem.uLen = uLen;
216	PDMDevHlpPCIPhysWrite(pState->CTX_SUFF(pDevIns),
217	pVRing->addrUsed + RT_OFFSETOF(VRINGUSED, aRing[uIndex % pVRing->uSize]),
218	&elem, sizeof(elem));
219	}
220
221
222	void vqueuePut(PVPCISTATE pState, PVQUEUE pQueue,
223	PVQUEUEELEM pElem, uint32_t uTotalLen, uint32_t uReserved)
224	{
225	Log2(("%s vqueuePut: %s"
226	" desc_idx=%u acb=%u (%u)\n",
227	INSTANCE(pState), QUEUENAME(pState, pQueue),
228	pElem->uIndex, uTotalLen, uReserved));
229
230	Assert(uReserved < uTotalLen);
231
232	uint32_t cbLen = uTotalLen - uReserved;
233	uint32_t cbSkip = uReserved;
234
235	for (unsigned i = 0; i < pElem->nIn && cbLen > 0; ++i)
236	{
237	if (cbSkip >= pElem->aSegsIn[i].cb) /* segment completely skipped? */
238	{
239	cbSkip -= pElem->aSegsIn[i].cb;
240	continue;
241	}
242
243	uint32_t cbSegLen = pElem->aSegsIn[i].cb - cbSkip;
244	if (cbSegLen > cbLen) /* last segment only partially used? */
245	cbSegLen = cbLen;
246
247	/*
248	* XXX: We should assert pv != NULL, but we need to check and
249	* fix all callers first.
250	*/
251	if (pElem->aSegsIn[i].pv != NULL)
252	{
253	Log2(("%s vqueuePut: %s"
254	" used_idx=%u seg=%u addr=%p pv=%p cb=%u acb=%u\n",
255	INSTANCE(pState), QUEUENAME(pState, pQueue),
256	pQueue->uNextUsedIndex, i,
257	(void *)pElem->aSegsIn[i].addr, pElem->aSegsIn[i].pv,
258	pElem->aSegsIn[i].cb, cbSegLen));
259
260	PDMDevHlpPCIPhysWrite(pState->CTX_SUFF(pDevIns),
261	pElem->aSegsIn[i].addr + cbSkip,
262	pElem->aSegsIn[i].pv,
263	cbSegLen);
264	}
265
266	cbSkip = 0;
267	cbLen -= cbSegLen;
268	}
269
270	Log2(("%s vqueuePut: %s"
271	" used_idx=%u guest_used_idx=%u id=%u len=%u\n",
272	INSTANCE(pState), QUEUENAME(pState, pQueue),
273	pQueue->uNextUsedIndex, vringReadUsedIndex(pState, &pQueue->VRing),
274	pElem->uIndex, uTotalLen));
275
276	vringWriteUsedElem(pState, &pQueue->VRing,
277	pQueue->uNextUsedIndex++,
278	pElem->uIndex, uTotalLen);
279	}
280
281
282	void vqueueNotify(PVPCISTATE pState, PVQUEUE pQueue)
283	{
284	LogFlow(("%s vqueueNotify: %s availFlags=%x guestFeatures=%x vqueue is %sempty\n",
285	INSTANCE(pState), QUEUENAME(pState, pQueue),
286	vringReadAvailFlags(pState, &pQueue->VRing),
287	pState->uGuestFeatures, vqueueIsEmpty(pState, pQueue)?"":"not "));
288	if (!(vringReadAvailFlags(pState, &pQueue->VRing) & VRINGAVAIL_F_NO_INTERRUPT)
289	\|\| ((pState->uGuestFeatures & VPCI_F_NOTIFY_ON_EMPTY) && vqueueIsEmpty(pState, pQueue)))
290	{
291	int rc = vpciRaiseInterrupt(pState, VERR_INTERNAL_ERROR, VPCI_ISR_QUEUE);
292	if (RT_FAILURE(rc))
293	Log(("%s vqueueNotify: Failed to raise an interrupt (%Rrc).\n", INSTANCE(pState), rc));
294	}
295	else
296	{
297	STAM_COUNTER_INC(&pState->StatIntsSkipped);
298	}
299
300	}
301
302	void vqueueSync(PVPCISTATE pState, PVQUEUE pQueue)
303	{
304	Log2(("%s vqueueSync: %s old_used_idx=%u new_used_idx=%u\n", INSTANCE(pState),
305	QUEUENAME(pState, pQueue), vringReadUsedIndex(pState, &pQueue->VRing), pQueue->uNextUsedIndex));
306	vringWriteUsedIndex(pState, &pQueue->VRing, pQueue->uNextUsedIndex);
307	vqueueNotify(pState, pQueue);
308	}
309
310	void vpciReset(PVPCISTATE pState)
311	{
312	pState->uGuestFeatures = 0;
313	pState->uQueueSelector = 0;
314	pState->uStatus = 0;
315	pState->uISR = 0;
316
317	for (unsigned i = 0; i < pState->nQueues; i++)
318	vqueueReset(&pState->Queues[i]);
319	}
320
321
322	/**
323	* Raise interrupt.
324	*
325	* @param pState The device state structure.
326	* @param rcBusy Status code to return when the critical section is busy.
327	* @param u8IntCause Interrupt cause bit mask to set in PCI ISR port.
328	*/
329	int vpciRaiseInterrupt(VPCISTATE *pState, int rcBusy, uint8_t u8IntCause)
330	{
331	RT_NOREF_PV(rcBusy);
332	// int rc = vpciCsEnter(pState, rcBusy);
333	// if (RT_UNLIKELY(rc != VINF_SUCCESS))
334	// return rc;
335
336	STAM_COUNTER_INC(&pState->StatIntsRaised);
337	LogFlow(("%s vpciRaiseInterrupt: u8IntCause=%x\n",
338	INSTANCE(pState), u8IntCause));
339
340	pState->uISR \|= u8IntCause;
341	PDMDevHlpPCISetIrq(pState->CTX_SUFF(pDevIns), 0, 1);
342	// vpciCsLeave(pState);
343	return VINF_SUCCESS;
344	}
345
346	/**
347	* Lower interrupt.
348	*
349	* @param pState The device state structure.
350	*/
351	static void vpciLowerInterrupt(VPCISTATE *pState)
352	{
353	LogFlow(("%s vpciLowerInterrupt\n", INSTANCE(pState)));
354	PDMDevHlpPCISetIrq(pState->CTX_SUFF(pDevIns), 0, 0);
355	}
356
357	DECLINLINE(uint32_t) vpciGetHostFeatures(PVPCISTATE pState,
358	PFNGETHOSTFEATURES pfnGetHostFeatures)
359	{
360	return pfnGetHostFeatures(pState)
361	\| VPCI_F_NOTIFY_ON_EMPTY;
362	}
363
364	/**
365	* Port I/O Handler for IN operations.
366	*
367	* @returns VBox status code.
368	*
369	* @param pDevIns The device instance.
370	* @param pvUser Pointer to the device state structure.
371	* @param Port Port number used for the IN operation.
372	* @param pu32 Where to store the result.
373	* @param cb Number of bytes read.
374	* @param pCallbacks Pointer to the callbacks.
375	* @thread EMT
376	*/
377	int vpciIOPortIn(PPDMDEVINS pDevIns,
378	void *pvUser,
379	RTIOPORT Port,
380	uint32_t *pu32,
381	unsigned cb,
382	PCVPCIIOCALLBACKS pCallbacks)
383	{
384	VPCISTATE pState = PDMINS_2_DATA(pDevIns, VPCISTATE );
385	int rc = VINF_SUCCESS;
386	STAM_PROFILE_ADV_START(&pState->CTXSUFF(StatIORead), a);
387	RT_NOREF_PV(pvUser);
388
389	/*
390	* We probably do not need to enter critical section when reading registers
391	* as the most of them are either constant or being changed during
392	* initialization only, the exception being ISR which can be raced by all
393	* threads but I see no big harm in it. It also happens to be the most read
394	* register as it gets read in interrupt handler. By dropping cs protection
395	* here we gain the ability to deliver RX packets to the guest while TX is
396	* holding cs transmitting queued packets.
397	*
398	rc = vpciCsEnter(pState, VINF_IOM_R3_IOPORT_READ);
399	if (RT_UNLIKELY(rc != VINF_SUCCESS))
400	{
401	STAM_PROFILE_ADV_STOP(&pState->CTXSUFF(StatIORead), a);
402	return rc;
403	}*/
404
405	Port -= pState->IOPortBase;
406	switch (Port)
407	{
408	case VPCI_HOST_FEATURES:
409	/* Tell the guest what features we support. */
410	*pu32 = vpciGetHostFeatures(pState, pCallbacks->pfnGetHostFeatures)
411	\| VPCI_F_BAD_FEATURE;
412	break;
413
414	case VPCI_GUEST_FEATURES:
415	*pu32 = pState->uGuestFeatures;
416	break;
417
418	case VPCI_QUEUE_PFN:
419	*pu32 = pState->Queues[pState->uQueueSelector].uPageNumber;
420	break;
421
422	case VPCI_QUEUE_NUM:
423	Assert(cb == 2);
424	(uint16_t)pu32 = pState->Queues[pState->uQueueSelector].VRing.uSize;
425	break;
426
427	case VPCI_QUEUE_SEL:
428	Assert(cb == 2);
429	(uint16_t)pu32 = pState->uQueueSelector;
430	break;
431
432	case VPCI_STATUS:
433	Assert(cb == 1);
434	(uint8_t)pu32 = pState->uStatus;
435	break;
436
437	case VPCI_ISR:
438	Assert(cb == 1);
439	(uint8_t)pu32 = pState->uISR;
440	pState->uISR = 0; /* read clears all interrupts */
441	vpciLowerInterrupt(pState);
442	break;
443
444	default:
445	if (Port >= VPCI_CONFIG)
446	rc = pCallbacks->pfnGetConfig(pState, Port - VPCI_CONFIG, cb, pu32);
447	else
448	{
449	*pu32 = 0xFFFFFFFF;
450	rc = PDMDevHlpDBGFStop(pDevIns, RT_SRC_POS, "%s vpciIOPortIn: no valid port at offset port=%RTiop cb=%08x\n",
451	INSTANCE(pState), Port, cb);
452	}
453	break;
454	}
455	Log3(("%s vpciIOPortIn: At %RTiop in %0x\n", INSTANCE(pState), Port, cb2, *pu32));
456	STAM_PROFILE_ADV_STOP(&pState->CTXSUFF(StatIORead), a);
457	//vpciCsLeave(pState);
458	return rc;
459	}
460
461
462	/**
463	* Port I/O Handler for OUT operations.
464	*
465	* @returns VBox status code.
466	*
467	* @param pDevIns The device instance.
468	* @param pvUser User argument.
469	* @param Port Port number used for the IN operation.
470	* @param u32 The value to output.
471	* @param cb The value size in bytes.
472	* @param pCallbacks Pointer to the callbacks.
473	* @thread EMT
474	*/
475	int vpciIOPortOut(PPDMDEVINS pDevIns,
476	void *pvUser,
477	RTIOPORT Port,
478	uint32_t u32,
479	unsigned cb,
480	PCVPCIIOCALLBACKS pCallbacks)
481	{
482	VPCISTATE pState = PDMINS_2_DATA(pDevIns, VPCISTATE );
483	int rc = VINF_SUCCESS;
484	bool fHasBecomeReady;
485	STAM_PROFILE_ADV_START(&pState->CTXSUFF(StatIOWrite), a);
486	RT_NOREF_PV(pvUser);
487
488	Port -= pState->IOPortBase;
489	Log3(("%s virtioIOPortOut: At %RTiop out %0x\n", INSTANCE(pState), Port, cb2, u32));
490
491	switch (Port)
492	{
493	case VPCI_GUEST_FEATURES:
494	{
495	const uint32_t uHostFeatures = vpciGetHostFeatures(pState, pCallbacks->pfnGetHostFeatures);
496
497	if (RT_LIKELY((u32 & ~uHostFeatures) == 0))
498	{
499	pState->uGuestFeatures = u32;
500	}
501	else
502	{
503	/*
504	* Guest requests features we don't advertise. Stick
505	* to the minimum if negotiation looks completely
506	* botched, otherwise restrict to advertised features.
507	*/
508	if (u32 & VPCI_F_BAD_FEATURE)
509	{
510	Log(("%s WARNING! Guest failed to negotiate properly (guest=%x)\n",
511	INSTANCE(pState), u32));
512	pState->uGuestFeatures = pCallbacks->pfnGetHostMinimalFeatures(pState);
513	}
514	else
515	{
516	Log(("%s Guest asked for features host does not support! (host=%x guest=%x)\n",
517	INSTANCE(pState), uHostFeatures, u32));
518	pState->uGuestFeatures = u32 & uHostFeatures;
519	}
520	}
521	pCallbacks->pfnSetHostFeatures(pState, pState->uGuestFeatures);
522	break;
523	}
524
525	case VPCI_QUEUE_PFN:
526	/*
527	* The guest is responsible for allocating the pages for queues,
528	* here it provides us with the page number of descriptor table.
529	* Note that we provide the size of the queue to the guest via
530	* VIRTIO_PCI_QUEUE_NUM.
531	*/
532	pState->Queues[pState->uQueueSelector].uPageNumber = u32;
533	if (u32)
534	vqueueInit(&pState->Queues[pState->uQueueSelector], u32);
535	else
536	rc = pCallbacks->pfnReset(pState);
537	break;
538
539	case VPCI_QUEUE_SEL:
540	Assert(cb == 2);
541	u32 &= 0xFFFF;
542	if (u32 < pState->nQueues)
543	pState->uQueueSelector = u32;
544	else
545	Log3(("%s vpciIOPortOut: Invalid queue selector %08x\n", INSTANCE(pState), u32));
546	break;
547
548	case VPCI_QUEUE_NOTIFY:
549	#ifdef IN_RING3
550	Assert(cb == 2);
551	u32 &= 0xFFFF;
552	if (u32 < pState->nQueues)
553	if (pState->Queues[u32].VRing.addrDescriptors)
554	{
555	// rc = vpciCsEnter(pState, VERR_SEM_BUSY);
556	// if (RT_LIKELY(rc == VINF_SUCCESS))
557	// {
558	pState->Queues[u32].pfnCallback(pState, &pState->Queues[u32]);
559	// vpciCsLeave(pState);
560	// }
561	}
562	else
563	Log(("%s The queue (#%d) being notified has not been initialized.\n",
564	INSTANCE(pState), u32));
565	else
566	Log(("%s Invalid queue number (%d)\n", INSTANCE(pState), u32));
567	#else
568	rc = VINF_IOM_R3_IOPORT_WRITE;
569	#endif
570	break;
571
572	case VPCI_STATUS:
573	Assert(cb == 1);
574	u32 &= 0xFF;
575	fHasBecomeReady = !(pState->uStatus & VPCI_STATUS_DRV_OK) && (u32 & VPCI_STATUS_DRV_OK);
576	pState->uStatus = u32;
577	/* Writing 0 to the status port triggers device reset. */
578	if (u32 == 0)
579	rc = pCallbacks->pfnReset(pState);
580	else if (fHasBecomeReady)
581	pCallbacks->pfnReady(pState);
582	break;
583
584	default:
585	if (Port >= VPCI_CONFIG)
586	rc = pCallbacks->pfnSetConfig(pState, Port - VPCI_CONFIG, cb, &u32);
587	else
588	rc = PDMDevHlpDBGFStop(pDevIns, RT_SRC_POS, "%s vpciIOPortOut: no valid port at offset Port=%RTiop cb=%08x\n",
589	INSTANCE(pState), Port, cb);
590	break;
591	}
592
593	STAM_PROFILE_ADV_STOP(&pState->CTXSUFF(StatIOWrite), a);
594	return rc;
595	}
596
597	#ifdef IN_RING3
598
599	/**
600	* @interface_method_impl{PDMIBASE,pfnQueryInterface}
601	*/
602	void vpciQueryInterface(struct PDMIBASE pInterface, const char *pszIID)
603	{
604	VPCISTATE *pThis = IFACE_TO_STATE(pInterface, IBase);
605	Assert(&pThis->IBase == pInterface);
606
607	PDMIBASE_RETURN_INTERFACE(pszIID, PDMIBASE, &pThis->IBase);
608	PDMIBASE_RETURN_INTERFACE(pszIID, PDMILEDPORTS, &pThis->ILeds);
609	return NULL;
610	}
611
612	/**
613	* Gets the pointer to the status LED of a unit.
614	*
615	* @returns VBox status code.
616	* @param pInterface Pointer to the interface structure.
617	* @param iLUN The unit which status LED we desire.
618	* @param ppLed Where to store the LED pointer.
619	* @thread EMT
620	*/
621	static DECLCALLBACK(int) vpciQueryStatusLed(PPDMILEDPORTS pInterface, unsigned iLUN, PPDMLED *ppLed)
622	{
623	VPCISTATE *pState = IFACE_TO_STATE(pInterface, ILeds);
624	int rc = VERR_PDM_LUN_NOT_FOUND;
625
626	if (iLUN == 0)
627	{
628	*ppLed = &pState->led;
629	rc = VINF_SUCCESS;
630	}
631	return rc;
632	}
633
634	/**
635	* Turns on/off the write status LED.
636	*
637	* @returns VBox status code.
638	* @param pState Pointer to the device state structure.
639	* @param fOn New LED state.
640	*/
641	void vpciSetWriteLed(PVPCISTATE pState, bool fOn)
642	{
643	LogFlow(("%s vpciSetWriteLed: %s\n", INSTANCE(pState), fOn?"on":"off"));
644	if (fOn)
645	pState->led.Asserted.s.fWriting = pState->led.Actual.s.fWriting = 1;
646	else
647	pState->led.Actual.s.fWriting = fOn;
648	}
649
650	/**
651	* Turns on/off the read status LED.
652	*
653	* @returns VBox status code.
654	* @param pState Pointer to the device state structure.
655	* @param fOn New LED state.
656	*/
657	void vpciSetReadLed(PVPCISTATE pState, bool fOn)
658	{
659	LogFlow(("%s vpciSetReadLed: %s\n", INSTANCE(pState), fOn?"on":"off"));
660	if (fOn)
661	pState->led.Asserted.s.fReading = pState->led.Actual.s.fReading = 1;
662	else
663	pState->led.Actual.s.fReading = fOn;
664	}
665
666
667	#if 0 /* unused */
668	/**
669	* Sets 32-bit register in PCI configuration space.
670	* @param refPciDev The PCI device.
671	* @param uOffset The register offset.
672	* @param u32Value The value to store in the register.
673	* @thread EMT
674	*/
675	DECLINLINE(void) vpciCfgSetU32(PDMPCIDEV& refPciDev, uint32_t uOffset, uint32_t u32Value)
676	{
677	Assert(uOffset+sizeof(u32Value) <= sizeof(refPciDev.config));
678	(uint32_t)&refPciDev.config[uOffset] = u32Value;
679	}
680	#endif /* unused */
681
682
683	#ifdef DEBUG
684	static void vpciDumpState(PVPCISTATE pState, const char *pcszCaller)
685	{
686	Log2(("vpciDumpState: (called from %s)\n"
687	" uGuestFeatures = 0x%08x\n"
688	" uQueueSelector = 0x%04x\n"
689	" uStatus = 0x%02x\n"
690	" uISR = 0x%02x\n",
691	pcszCaller,
692	pState->uGuestFeatures,
693	pState->uQueueSelector,
694	pState->uStatus,
695	pState->uISR));
696
697	for (unsigned i = 0; i < pState->nQueues; i++)
698	Log2((" %s queue:\n"
699	" VRing.uSize = %u\n"
700	" VRing.addrDescriptors = %p\n"
701	" VRing.addrAvail = %p\n"
702	" VRing.addrUsed = %p\n"
703	" uNextAvailIndex = %u\n"
704	" uNextUsedIndex = %u\n"
705	" uPageNumber = %x\n",
706	pState->Queues[i].pcszName,
707	pState->Queues[i].VRing.uSize,
708	pState->Queues[i].VRing.addrDescriptors,
709	pState->Queues[i].VRing.addrAvail,
710	pState->Queues[i].VRing.addrUsed,
711	pState->Queues[i].uNextAvailIndex,
712	pState->Queues[i].uNextUsedIndex,
713	pState->Queues[i].uPageNumber));
714	}
715	#else
716	# define vpciDumpState(x, s) do {} while (0)
717	#endif
718
719	/**
720	* Saves the state of device.
721	*
722	* @returns VBox status code.
723	* @param pDevIns The device instance.
724	* @param pSSM The handle to the saved state.
725	*/
726	int vpciSaveExec(PVPCISTATE pState, PSSMHANDLE pSSM)
727	{
728	int rc;
729
730	vpciDumpState(pState, "vpciSaveExec");
731
732	rc = SSMR3PutU32(pSSM, pState->uGuestFeatures);
733	AssertRCReturn(rc, rc);
734	rc = SSMR3PutU16(pSSM, pState->uQueueSelector);
735	AssertRCReturn(rc, rc);
736	rc = SSMR3PutU8( pSSM, pState->uStatus);
737	AssertRCReturn(rc, rc);
738	rc = SSMR3PutU8( pSSM, pState->uISR);
739	AssertRCReturn(rc, rc);
740
741	/* Save queue states */
742	rc = SSMR3PutU32(pSSM, pState->nQueues);
743	AssertRCReturn(rc, rc);
744	for (unsigned i = 0; i < pState->nQueues; i++)
745	{
746	rc = SSMR3PutU16(pSSM, pState->Queues[i].VRing.uSize);
747	AssertRCReturn(rc, rc);
748	rc = SSMR3PutU32(pSSM, pState->Queues[i].uPageNumber);
749	AssertRCReturn(rc, rc);
750	rc = SSMR3PutU16(pSSM, pState->Queues[i].uNextAvailIndex);
751	AssertRCReturn(rc, rc);
752	rc = SSMR3PutU16(pSSM, pState->Queues[i].uNextUsedIndex);
753	AssertRCReturn(rc, rc);
754	}
755
756	return VINF_SUCCESS;
757	}
758
759	/**
760	* Loads a saved device state.
761	*
762	* @returns VBox status code.
763	* @param pDevIns The device instance.
764	* @param pSSM The handle to the saved state.
765	* @param uVersion The data unit version number.
766	* @param uPass The data pass.
767	*/
768	int vpciLoadExec(PVPCISTATE pState, PSSMHANDLE pSSM, uint32_t uVersion, uint32_t uPass, uint32_t nQueues)
769	{
770	int rc;
771
772	if (uPass == SSM_PASS_FINAL)
773	{
774	/* Restore state data */
775	rc = SSMR3GetU32(pSSM, &pState->uGuestFeatures);
776	AssertRCReturn(rc, rc);
777	rc = SSMR3GetU16(pSSM, &pState->uQueueSelector);
778	AssertRCReturn(rc, rc);
779	rc = SSMR3GetU8( pSSM, &pState->uStatus);
780	AssertRCReturn(rc, rc);
781	rc = SSMR3GetU8( pSSM, &pState->uISR);
782	AssertRCReturn(rc, rc);
783
784	/* Restore queues */
785	if (uVersion > VIRTIO_SAVEDSTATE_VERSION_3_1_BETA1)
786	{
787	rc = SSMR3GetU32(pSSM, &pState->nQueues);
788	AssertRCReturn(rc, rc);
789	}
790	else
791	pState->nQueues = nQueues;
792	for (unsigned i = 0; i < pState->nQueues; i++)
793	{
794	rc = SSMR3GetU16(pSSM, &pState->Queues[i].VRing.uSize);
795	AssertRCReturn(rc, rc);
796	rc = SSMR3GetU32(pSSM, &pState->Queues[i].uPageNumber);
797	AssertRCReturn(rc, rc);
798
799	if (pState->Queues[i].uPageNumber)
800	vqueueInit(&pState->Queues[i], pState->Queues[i].uPageNumber);
801
802	rc = SSMR3GetU16(pSSM, &pState->Queues[i].uNextAvailIndex);
803	AssertRCReturn(rc, rc);
804	rc = SSMR3GetU16(pSSM, &pState->Queues[i].uNextUsedIndex);
805	AssertRCReturn(rc, rc);
806	}
807	}
808
809	vpciDumpState(pState, "vpciLoadExec");
810
811	return VINF_SUCCESS;
812	}
813
814	/**
815	* Set PCI configuration space registers.
816	*
817	* @param pci Reference to PCI device structure.
818	* @param uDeviceId VirtiO Device Id
819	* @param uClass Class of PCI device (network, etc)
820	* @thread EMT
821	*/
822	static DECLCALLBACK(void) vpciConfigure(PDMPCIDEV& pci,
823	uint16_t uDeviceId,
824	uint16_t uClass)
825	{
826	/* Configure PCI Device, assume 32-bit mode ******************************/
827	PCIDevSetVendorId(&pci, DEVICE_PCI_VENDOR_ID);
828	PCIDevSetDeviceId(&pci, DEVICE_PCI_BASE_ID + uDeviceId);
829	PDMPciDevSetWord(&pci, VBOX_PCI_SUBSYSTEM_VENDOR_ID, DEVICE_PCI_SUBSYSTEM_VENDOR_ID);
830	PDMPciDevSetWord(&pci, VBOX_PCI_SUBSYSTEM_ID, DEVICE_PCI_SUBSYSTEM_BASE_ID + uDeviceId);
831
832	/* ABI version, must be equal 0 as of 2.6.30 kernel. */
833	PDMPciDevSetByte(&pci, VBOX_PCI_REVISION_ID, 0x00);
834	/* Ethernet adapter */
835	PDMPciDevSetByte(&pci, VBOX_PCI_CLASS_PROG, 0x00);
836	PDMPciDevSetWord(&pci, VBOX_PCI_CLASS_DEVICE, uClass);
837	/* Interrupt Pin: INTA# */
838	PDMPciDevSetByte(&pci, VBOX_PCI_INTERRUPT_PIN, 0x01);
839
840	#ifdef VBOX_WITH_MSI_DEVICES
841	PCIDevSetCapabilityList(&pci, 0x80);
842	PCIDevSetStatus( &pci, VBOX_PCI_STATUS_CAP_LIST);
843	#endif
844	}
845
846	#ifdef VBOX_WITH_STATISTICS
847	/* WARNING! This function must never be used in multithreaded context! */
848	static const char vpciCounter(const char pszDevFmt,
849	const char *pszCounter)
850	{
851	static char s_szCounterName[80];
852
853	RTStrPrintf(s_szCounterName, sizeof(s_szCounterName),
854	"/Devices/%s/%s", pszDevFmt, pszCounter);
855
856	return s_szCounterName;
857	}
858	#endif
859
860	/// @todo header
861	int vpciConstruct(PPDMDEVINS pDevIns, VPCISTATE *pState,
862	int iInstance, const char *pcszNameFmt,
863	uint16_t uDeviceId, uint16_t uClass,
864	uint32_t nQueues)
865	{
866	/* Init handles and log related stuff. */
867	RTStrPrintf(pState->szInstance, sizeof(pState->szInstance),
868	pcszNameFmt, iInstance);
869
870	pState->pDevInsR3 = pDevIns;
871	pState->pDevInsR0 = PDMDEVINS_2_R0PTR(pDevIns);
872	pState->pDevInsRC = PDMDEVINS_2_RCPTR(pDevIns);
873	pState->led.u32Magic = PDMLED_MAGIC;
874
875	pState->ILeds.pfnQueryStatusLed = vpciQueryStatusLed;
876
877	/* Initialize critical section. */
878	int rc = PDMDevHlpCritSectInit(pDevIns, &pState->cs, RT_SRC_POS, "%s", pState->szInstance);
879	if (RT_FAILURE(rc))
880	return rc;
881
882	/* Set PCI config registers */
883	vpciConfigure(pState->pciDevice, uDeviceId, uClass);
884	/* Register PCI device */
885	rc = PDMDevHlpPCIRegister(pDevIns, &pState->pciDevice);
886	if (RT_FAILURE(rc))
887	return rc;
888
889	#ifdef VBOX_WITH_MSI_DEVICES
890	#if 0
891	{
892	PDMMSIREG aMsiReg;
893
894	RT_ZERO(aMsiReg);
895	aMsiReg.cMsixVectors = 1;
896	aMsiReg.iMsixCapOffset = 0x80;
897	aMsiReg.iMsixNextOffset = 0x0;
898	aMsiReg.iMsixBar = 0;
899	rc = PDMDevHlpPCIRegisterMsi(pDevIns, &aMsiReg);
900	if (RT_FAILURE (rc))
901	PCIDevSetCapabilityList(&pState->pciDevice, 0x0);
902	}
903	#endif
904	#endif
905
906	/* Status driver */
907	PPDMIBASE pBase;
908	rc = PDMDevHlpDriverAttach(pDevIns, PDM_STATUS_LUN, &pState->IBase, &pBase, "Status Port");
909	if (RT_FAILURE(rc))
910	return PDMDEV_SET_ERROR(pDevIns, rc, N_("Failed to attach the status LUN"));
911	pState->pLedsConnector = PDMIBASE_QUERY_INTERFACE(pBase, PDMILEDCONNECTORS);
912
913	pState->nQueues = nQueues;
914
915	#if defined(VBOX_WITH_STATISTICS)
916	PDMDevHlpSTAMRegisterF(pDevIns, &pState->StatIOReadGC, STAMTYPE_PROFILE, STAMVISIBILITY_ALWAYS, STAMUNIT_TICKS_PER_CALL, "Profiling IO reads in GC", vpciCounter(pcszNameFmt, "IO/ReadGC"), iInstance);
917	PDMDevHlpSTAMRegisterF(pDevIns, &pState->StatIOReadHC, STAMTYPE_PROFILE, STAMVISIBILITY_ALWAYS, STAMUNIT_TICKS_PER_CALL, "Profiling IO reads in HC", vpciCounter(pcszNameFmt, "IO/ReadHC"), iInstance);
918	PDMDevHlpSTAMRegisterF(pDevIns, &pState->StatIOWriteGC, STAMTYPE_PROFILE, STAMVISIBILITY_ALWAYS, STAMUNIT_TICKS_PER_CALL, "Profiling IO writes in GC", vpciCounter(pcszNameFmt, "IO/WriteGC"), iInstance);
919	PDMDevHlpSTAMRegisterF(pDevIns, &pState->StatIOWriteHC, STAMTYPE_PROFILE, STAMVISIBILITY_ALWAYS, STAMUNIT_TICKS_PER_CALL, "Profiling IO writes in HC", vpciCounter(pcszNameFmt, "IO/WriteHC"), iInstance);
920	PDMDevHlpSTAMRegisterF(pDevIns, &pState->StatIntsRaised, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_OCCURENCES, "Number of raised interrupts", vpciCounter(pcszNameFmt, "Interrupts/Raised"), iInstance);
921	PDMDevHlpSTAMRegisterF(pDevIns, &pState->StatIntsSkipped, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_OCCURENCES, "Number of skipped interrupts", vpciCounter(pcszNameFmt, "Interrupts/Skipped"), iInstance);
922	PDMDevHlpSTAMRegisterF(pDevIns, &pState->StatCsGC, STAMTYPE_PROFILE, STAMVISIBILITY_ALWAYS, STAMUNIT_TICKS_PER_CALL, "Profiling CS wait in GC", vpciCounter(pcszNameFmt, "Cs/CsGC"), iInstance);
923	PDMDevHlpSTAMRegisterF(pDevIns, &pState->StatCsHC, STAMTYPE_PROFILE, STAMVISIBILITY_ALWAYS, STAMUNIT_TICKS_PER_CALL, "Profiling CS wait in HC", vpciCounter(pcszNameFmt, "Cs/CsHC"), iInstance);
924	#endif /* VBOX_WITH_STATISTICS */
925
926	return rc;
927	}
928
929	/**
930	* Destruct PCI-related part of device.
931	*
932	* We need to free non-VM resources only.
933	*
934	* @returns VBox status code.
935	* @param pState The device state structure.
936	*/
937	int vpciDestruct(VPCISTATE* pState)
938	{
939	Log(("%s Destroying PCI instance\n", INSTANCE(pState)));
940
941	if (PDMCritSectIsInitialized(&pState->cs))
942	PDMR3CritSectDelete(&pState->cs);
943
944	return VINF_SUCCESS;
945	}
946
947	/**
948	* Device relocation callback.
949	*
950	* When this callback is called the device instance data, and if the
951	* device have a GC component, is being relocated, or/and the selectors
952	* have been changed. The device must use the chance to perform the
953	* necessary pointer relocations and data updates.
954	*
955	* Before the GC code is executed the first time, this function will be
956	* called with a 0 delta so GC pointer calculations can be one in one place.
957	*
958	* @param pDevIns Pointer to the device instance.
959	* @param offDelta The relocation delta relative to the old location.
960	*
961	* @remark A relocation CANNOT fail.
962	*/
963	void vpciRelocate(PPDMDEVINS pDevIns, RTGCINTPTR offDelta)
964	{
965	RT_NOREF(offDelta);
966	VPCISTATE pState = PDMINS_2_DATA(pDevIns, VPCISTATE);
967	pState->pDevInsRC = PDMDEVINS_2_RCPTR(pDevIns);
968	// TBD
969	}
970
971	PVQUEUE vpciAddQueue(VPCISTATE* pState, unsigned uSize, PFNVPCIQUEUECALLBACK pfnCallback, const char *pcszName)
972	{
973	PVQUEUE pQueue = NULL;
974	/* Find an empty queue slot */
975	for (unsigned i = 0; i < pState->nQueues; i++)
976	{
977	if (pState->Queues[i].VRing.uSize == 0)
978	{
979	pQueue = &pState->Queues[i];
980	break;
981	}
982	}
983
984	if (!pQueue)
985	{
986	Log(("%s Too many queues being added, no empty slots available!\n", INSTANCE(pState)));
987	}
988	else
989	{
990	pQueue->VRing.uSize = uSize;
991	pQueue->VRing.addrDescriptors = 0;
992	pQueue->uPageNumber = 0;
993	pQueue->pfnCallback = pfnCallback;
994	pQueue->pcszName = pcszName;
995	}
996
997	return pQueue;
998	}
999
1000	#endif /* IN_RING3 */
1001
1002	#endif /* VBOX_DEVICE_STRUCT_TESTCASE */

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

source: vbox/trunk/src/VBox/Devices/VirtIO/Virtio.cpp@ 65620

Download in other formats: