VirtualBox

source: vbox/trunk/src/VBox/Devices/Network/DevVirtioNet.cpp@ 98064

Last change on this file since 98064 was 98064, checked in by vboxsync, 23 months ago

Devices: Remove the unused Virtio core code and legacy virtio-net device emulation, bugref:8651
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 162.5 KB
Line 
1/* $Id: DevVirtioNet.cpp 98064 2023-01-12 15:06:25Z vboxsync $ $Revision: 98064 $ $Date: 2023-01-12 15:06:25 +0000 (Thu, 12 Jan 2023) $ $Author: vboxsync $ */
2
3/** @file
4 * VBox storage devices - Virtio NET Driver
5 *
6 * Log-levels used:
7 * - Level 1: The most important (but usually rare) things to note
8 * - Level 2: NET command logging
9 * - Level 3: Vector and I/O transfer summary (shows what client sent an expects and fulfillment)
10 * - Level 6: Device <-> Guest Driver negotation, traffic, notifications and state handling
11 * - Level 12: Brief formatted hex dumps of I/O data
12 */
13
14/*
15 * Copyright (C) 2006-2022 Oracle and/or its affiliates.
16 *
17 * This file is part of VirtualBox base platform packages, as
18 * available from https://www.virtualbox.org.
19 *
20 * This program is free software; you can redistribute it and/or
21 * modify it under the terms of the GNU General Public License
22 * as published by the Free Software Foundation, in version 3 of the
23 * License.
24 *
25 * This program is distributed in the hope that it will be useful, but
26 * WITHOUT ANY WARRANTY; without even the implied warranty of
27 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
28 * General Public License for more details.
29 *
30 * You should have received a copy of the GNU General Public License
31 * along with this program; if not, see <https://www.gnu.org/licenses>.
32 *
33 * SPDX-License-Identifier: GPL-3.0-only
34 */
35
36/*******************************************************************************************************************************
37* Header Files *
38***************************************************************************************************************************** **/
39#define LOG_GROUP LOG_GROUP_DEV_VIRTIO
40#define VIRTIONET_WITH_GSO
41
42#include <iprt/types.h>
43#include <iprt/errcore.h>
44#include <iprt/assert.h>
45#include <iprt/string.h>
46
47#include <VBox/sup.h>
48#include <VBox/vmm/pdmdev.h>
49#include <VBox/vmm/stam.h>
50#include <VBox/vmm/pdmcritsect.h>
51#include <VBox/vmm/pdmnetifs.h>
52#include <VBox/msi.h>
53#include <VBox/version.h>
54#include <VBox/log.h>
55
56
57#ifdef IN_RING3
58# include <VBox/VBoxPktDmp.h>
59# include <iprt/alloc.h>
60# include <iprt/memcache.h>
61# include <iprt/semaphore.h>
62# include <iprt/sg.h>
63# include <iprt/param.h>
64# include <iprt/uuid.h>
65#endif
66#include "../VirtIO/VirtioCore.h"
67
68#include "VBoxDD.h"
69
70#define VIRTIONET_TRANSITIONAL_ENABLE_FLAG 1 /** < If set behave as VirtIO "transitional" device */
71
72/** The current saved state version for the virtio core. */
73#define VIRTIONET_SAVEDSTATE_VERSION UINT32_C(1)
74#define VIRTIONET_SAVEDSTATE_VERSION_3_1_BETA1_LEGACY UINT32_C(1) /**< Grandfathered in from DevVirtioNet.cpp */
75#define VIRTIONET_SAVEDSTATE_VERSION_LEGACY UINT32_C(2) /**< Grandfathered in from DevVirtioNet.cpp */
76#define VIRTIONET_VERSION_MARKER_MAC_ADDR { 0xff, 0xff, 0xff, 0xff, 0xff, 0xff } /** SSM handling */
77
78/*
79 * Glossary of networking acronyms used in feature names below:
80 *
81 * GSO = Generic Segmentation Offload
82 * TSO = TCP Segmentation Offload
83 * UFO = UDP Fragmentation Offload
84 * ECN = Explicit Congestion Notification
85 */
86
87/** @name VirtIO 1.0 NET Host feature bits (See VirtIO 1.0 specification, Section 5.6.3)
88 * @{ */
89#define VIRTIONET_F_CSUM RT_BIT_64(0) /**< Handle packets with partial checksum */
90#define VIRTIONET_F_GUEST_CSUM RT_BIT_64(1) /**< Handles packets with partial checksum */
91#define VIRTIONET_F_CTRL_GUEST_OFFLOADS RT_BIT_64(2) /**< Control channel offloads reconfig support */
92#define VIRTIONET_F_MAC RT_BIT_64(5) /**< Device has given MAC address */
93#define VIRTIONET_F_GUEST_TSO4 RT_BIT_64(7) /**< Driver can receive TSOv4 */
94#define VIRTIONET_F_GUEST_TSO6 RT_BIT_64(8) /**< Driver can receive TSOv6 */
95#define VIRTIONET_F_GUEST_ECN RT_BIT_64(9) /**< Driver can receive TSO with ECN */
96#define VIRTIONET_F_GUEST_UFO RT_BIT_64(10) /**< Driver can receive UFO */
97#define VIRTIONET_F_HOST_TSO4 RT_BIT_64(11) /**< Device can receive TSOv4 */
98#define VIRTIONET_F_HOST_TSO6 RT_BIT_64(12) /**< Device can receive TSOv6 */
99#define VIRTIONET_F_HOST_ECN RT_BIT_64(13) /**< Device can receive TSO with ECN */
100#define VIRTIONET_F_HOST_UFO RT_BIT_64(14) /**< Device can receive UFO */
101#define VIRTIONET_F_MRG_RXBUF RT_BIT_64(15) /**< Driver can merge receive buffers */
102#define VIRTIONET_F_STATUS RT_BIT_64(16) /**< Config status field is available */
103#define VIRTIONET_F_CTRL_VQ RT_BIT_64(17) /**< Control channel is available */
104#define VIRTIONET_F_CTRL_RX RT_BIT_64(18) /**< Control channel RX mode + MAC addr filtering */
105#define VIRTIONET_F_CTRL_VLAN RT_BIT_64(19) /**< Control channel VLAN filtering */
106#define VIRTIONET_F_CTRL_RX_EXTRA RT_BIT_64(20) /**< Control channel RX mode extra functions */
107#define VIRTIONET_F_GUEST_ANNOUNCE RT_BIT_64(21) /**< Driver can send gratuitous packets */
108#define VIRTIONET_F_MQ RT_BIT_64(22) /**< Support ultiqueue with auto receive steering */
109#define VIRTIONET_F_CTRL_MAC_ADDR RT_BIT_64(23) /**< Set MAC address through control channel */
110/** @} */
111
112#ifdef IN_RING3
113static const VIRTIO_FEATURES_LIST s_aDevSpecificFeatures[] =
114{
115 { VIRTIONET_F_STATUS, " STATUS Configuration status field is available.\n" },
116 { VIRTIONET_F_MAC, " MAC Host has given MAC address.\n" },
117 { VIRTIONET_F_CTRL_VQ, " CTRL_VQ Control channel is available.\n" },
118 { VIRTIONET_F_CTRL_MAC_ADDR, " CTRL_MAC_ADDR Set MAC address through control channel.\n" },
119 { VIRTIONET_F_CTRL_RX, " CTRL_RX Control channel RX mode support.\n" },
120 { VIRTIONET_F_CTRL_VLAN, " CTRL_VLAN Control channel VLAN filtering.\n" },
121 { VIRTIONET_F_CTRL_GUEST_OFFLOADS, " CTRL_GUEST_OFFLOADS Control channel offloads reconfiguration support.\n" },
122 { VIRTIONET_F_GUEST_CSUM, " GUEST_CSUM Guest handles packets with partial checksum.\n" },
123 { VIRTIONET_F_GUEST_ANNOUNCE, " GUEST_ANNOUNCE Guest can send gratuitous packets.\n" },
124 { VIRTIONET_F_GUEST_TSO4, " GUEST_TSO4 Guest can receive TSOv4.\n" },
125 { VIRTIONET_F_GUEST_TSO6, " GUEST_TSO6 Guest can receive TSOv6.\n" },
126 { VIRTIONET_F_GUEST_ECN, " GUEST_ECN Guest can receive TSO with ECN.\n" },
127 { VIRTIONET_F_GUEST_UFO, " GUEST_UFO Guest can receive UFO.\n" },
128 { VIRTIONET_F_HOST_TSO4, " HOST_TSO4 Host can receive TSOv4.\n" },
129 { VIRTIONET_F_HOST_TSO6, " HOST_TSO6 Host can receive TSOv6.\n" },
130 { VIRTIONET_F_HOST_ECN, " HOST_ECN Host can receive TSO with ECN.\n" },
131 { VIRTIONET_F_HOST_UFO, " HOST_UFO Host can receive UFO.\n" },
132 { VIRTIONET_F_MQ, " MQ Host supports multiqueue with automatic receive steering.\n" },
133 { VIRTIONET_F_CSUM, " CSUM Host handles packets with partial checksum.\n" },
134 { VIRTIONET_F_MRG_RXBUF, " MRG_RXBUF Guest can merge receive buffers.\n" },
135};
136#endif
137
138#ifdef VIRTIONET_WITH_GSO
139# define VIRTIONET_HOST_FEATURES_GSO \
140 VIRTIONET_F_CSUM \
141 | VIRTIONET_F_HOST_TSO4 \
142 | VIRTIONET_F_HOST_TSO6 \
143 | VIRTIONET_F_HOST_UFO \
144 | VIRTIONET_F_GUEST_TSO4 \
145 | VIRTIONET_F_GUEST_TSO6 \
146 | VIRTIONET_F_GUEST_UFO \
147 | VIRTIONET_F_GUEST_CSUM /* @bugref(4796) Guest must handle partial chksums */
148#else
149# define VIRTIONET_HOST_FEATURES_GSO
150#endif
151
152#define VIRTIONET_HOST_FEATURES_OFFERED \
153 VIRTIONET_F_STATUS \
154 | VIRTIONET_F_GUEST_ANNOUNCE \
155 | VIRTIONET_F_MAC \
156 | VIRTIONET_F_CTRL_VQ \
157 | VIRTIONET_F_CTRL_RX \
158 | VIRTIONET_F_CTRL_VLAN \
159 | VIRTIONET_HOST_FEATURES_GSO \
160 | VIRTIONET_F_MRG_RXBUF
161
162#define FEATURE_ENABLED(feature) RT_BOOL(!!(pThis->fNegotiatedFeatures & VIRTIONET_F_##feature))
163#define FEATURE_DISABLED(feature) (!FEATURE_ENABLED(feature))
164#define FEATURE_OFFERED(feature) VIRTIONET_HOST_FEATURES_OFFERED & VIRTIONET_F_##feature
165
166#if FEATURE_OFFERED(MQ)
167/* Instance data doesn't allow an array large enough to contain VIRTIONET_CTRL_MQ_VQ_PAIRS_MAX entries */
168# define VIRTIONET_MAX_QPAIRS 1 /* This should be increased at some point and made to work */
169#else
170# define VIRTIONET_MAX_QPAIRS VIRTIONET_CTRL_MQ_VQ_PAIRS_MIN /* default, VirtIO 1.0, 5.1.6.5.5 */
171#endif
172
173#define VIRTIONET_CTRL_MQ_VQ_PAIRS 64
174#define VIRTIONET_MAX_WORKERS VIRTIONET_MAX_QPAIRS + 1
175#define VIRTIONET_MAX_VIRTQS (VIRTIONET_MAX_QPAIRS * 2 + 1)
176#define VIRTIONET_MAX_FRAME_SIZE 65535 + 18 /**< Max IP pkt size + Eth. header w/VLAN tag */
177#define VIRTIONET_MAC_FILTER_LEN 64
178#define VIRTIONET_MAX_VLAN_ID 4096
179#define VIRTIONET_RX_SEG_COUNT 32
180
181#define VIRTQNAME(uVirtqNbr) (pThis->aVirtqs[uVirtqNbr]->szName)
182#define CBVIRTQNAME(uVirtqNbr) RTStrNLen(VIRTQNAME(uVirtqNbr), sizeof(VIRTQNAME(uVirtqNbr)))
183
184#define IS_TX_VIRTQ(n) ((n) != CTRLQIDX && ((n) & 1))
185#define IS_RX_VIRTQ(n) ((n) != CTRLQIDX && !IS_TX_VIRTQ(n))
186#define IS_CTRL_VIRTQ(n) ((n) == CTRLQIDX)
187
188/*
189 * Macros to calculate queue type-pecific index number regardless of scale. VirtIO 1.0, 5.1.2
190 */
191#define RXQIDX(qPairIdx) (qPairIdx * 2)
192#define TXQIDX(qPairIdx) (RXQIDX(qPairIdx) + 1)
193#define CTRLQIDX (FEATURE_ENABLED(MQ) ? ((VIRTIONET_MAX_QPAIRS - 1) * 2 + 2) : 2)
194
195#define IS_LINK_UP(pState) !!(pState->virtioNetConfig.uStatus & VIRTIONET_F_LINK_UP)
196#define IS_LINK_DOWN(pState) !IS_LINK_UP(pState)
197
198#define SET_LINK_UP(pState) \
199 LogFunc(("SET_LINK_UP\n")); \
200 pState->virtioNetConfig.uStatus |= VIRTIONET_F_LINK_UP; \
201 virtioCoreNotifyConfigChanged(&pThis->Virtio)
202
203#define SET_LINK_DOWN(pState) \
204 LogFunc(("SET_LINK_DOWN\n")); \
205 pState->virtioNetConfig.uStatus &= ~VIRTIONET_F_LINK_UP; \
206 virtioCoreNotifyConfigChanged(&pThis->Virtio)
207
208#define IS_VIRTQ_EMPTY(pDevIns, pVirtio, uVirtqNbr) \
209 (virtioCoreVirtqAvailBufCount(pDevIns, pVirtio, uVirtqNbr) == 0)
210
211#define PCI_DEVICE_ID_VIRTIONET_HOST 0x1000 /**< VirtIO transitional device ID for network card */
212#define PCI_CLASS_BASE_NETWORK_CONTROLLER 0x0200 /**< PCI Network device class */
213#define PCI_CLASS_SUB_NET_ETHERNET_CONTROLLER 0x00 /**< PCI NET Controller subclass */
214#define PCI_CLASS_PROG_UNSPECIFIED 0x00 /**< Programming interface. N/A. */
215#define VIRTIONET_PCI_CLASS 0x01 /**< Base class Mass Storage? */
216
217/**
218 * VirtIO Network (virtio-net) device-specific configuration subregion (VirtIO 1.0, 5.1.4)
219 * Guest MMIO is processed through callback to VirtIO core which forwards references to network configuration
220 * fields to this device-specific code through a callback.
221 */
222#pragma pack(1)
223
224 typedef struct virtio_net_config
225 {
226 RTMAC uMacAddress; /**< mac */
227
228#if FEATURE_OFFERED(STATUS)
229 uint16_t uStatus; /**< status */
230#endif
231
232#if FEATURE_OFFERED(MQ)
233 uint16_t uMaxVirtqPairs; /**< max_virtq_pairs */
234#endif
235
236 } VIRTIONET_CONFIG_T, PVIRTIONET_CONFIG_T;
237
238#pragma pack()
239
240#define VIRTIONET_F_LINK_UP 1 /**< config status: Link is up */
241#define VIRTIONET_F_ANNOUNCE 2 /**< config status: Announce */
242
243/** @name VirtIO 1.0 NET Host Device device specific control types
244 * @{ */
245#define VIRTIONET_HDR_F_NEEDS_CSUM 1 /**< flags: Packet needs checksum */
246#define VIRTIONET_HDR_GSO_NONE 0 /**< gso_type: No Global Segmentation Offset */
247#define VIRTIONET_HDR_GSO_TCPV4 1 /**< gso_type: Global Segment Offset for TCPV4 */
248#define VIRTIONET_HDR_GSO_UDP 3 /**< gso_type: Global Segment Offset for UDP */
249#define VIRTIONET_HDR_GSO_TCPV6 4 /**< gso_type: Global Segment Offset for TCPV6 */
250#define VIRTIONET_HDR_GSO_ECN 0x80 /**< gso_type: Explicit Congestion Notification */
251/** @} */
252
253/* Device operation: Net header packet (VirtIO 1.0, 5.1.6) */
254#pragma pack(1)
255struct virtio_net_pkt_hdr {
256 uint8_t uFlags; /**< flags */
257 uint8_t uGsoType; /**< gso_type */
258 uint16_t uHdrLen; /**< hdr_len */
259 uint16_t uGsoSize; /**< gso_size */
260 uint16_t uChksumStart; /**< Chksum_start */
261 uint16_t uChksumOffset; /**< Chksum_offset */
262 uint16_t uNumBuffers; /**< num_buffers */
263};
264#pragma pack()
265typedef virtio_net_pkt_hdr VIRTIONETPKTHDR, *PVIRTIONETPKTHDR;
266AssertCompileSize(VIRTIONETPKTHDR, 12);
267
268/* Control virtq: Command entry (VirtIO 1.0, 5.1.6.5) */
269#pragma pack(1)
270struct virtio_net_ctrl_hdr {
271 uint8_t uClass; /**< class */
272 uint8_t uCmd; /**< command */
273};
274#pragma pack()
275typedef virtio_net_ctrl_hdr VIRTIONET_CTRL_HDR_T, *PVIRTIONET_CTRL_HDR_T;
276
277typedef uint8_t VIRTIONET_CTRL_HDR_T_ACK;
278
279/* Command entry fAck values */
280#define VIRTIONET_OK 0 /**< Internal success status */
281#define VIRTIONET_ERROR 1 /**< Internal failure status */
282
283/** @name Control virtq: Receive filtering flags (VirtIO 1.0, 5.1.6.5.1)
284 * @{ */
285#define VIRTIONET_CTRL_RX 0 /**< Control class: Receive filtering */
286#define VIRTIONET_CTRL_RX_PROMISC 0 /**< Promiscuous mode */
287#define VIRTIONET_CTRL_RX_ALLMULTI 1 /**< All-multicast receive */
288#define VIRTIONET_CTRL_RX_ALLUNI 2 /**< All-unicast receive */
289#define VIRTIONET_CTRL_RX_NOMULTI 3 /**< No multicast receive */
290#define VIRTIONET_CTRL_RX_NOUNI 4 /**< No unicast receive */
291#define VIRTIONET_CTRL_RX_NOBCAST 5 /**< No broadcast receive */
292/** @} */
293
294typedef uint8_t VIRTIONET_MAC_ADDRESS[6];
295typedef uint32_t VIRTIONET_CTRL_MAC_TABLE_LEN;
296typedef uint8_t VIRTIONET_CTRL_MAC_ENTRIES[][6];
297
298/** @name Control virtq: MAC address filtering flags (VirtIO 1.0, 5.1.6.5.2)
299 * @{ */
300#define VIRTIONET_CTRL_MAC 1 /**< Control class: MAC address filtering */
301#define VIRTIONET_CTRL_MAC_TABLE_SET 0 /**< Set MAC table */
302#define VIRTIONET_CTRL_MAC_ADDR_SET 1 /**< Set default MAC address */
303/** @} */
304
305/** @name Control virtq: MAC address filtering flags (VirtIO 1.0, 5.1.6.5.3)
306 * @{ */
307#define VIRTIONET_CTRL_VLAN 2 /**< Control class: VLAN filtering */
308#define VIRTIONET_CTRL_VLAN_ADD 0 /**< Add VLAN to filter table */
309#define VIRTIONET_CTRL_VLAN_DEL 1 /**< Delete VLAN from filter table */
310/** @} */
311
312/** @name Control virtq: Gratuitous packet sending (VirtIO 1.0, 5.1.6.5.4)
313 * @{ */
314#define VIRTIONET_CTRL_ANNOUNCE 3 /**< Control class: Gratuitous Packet Sending */
315#define VIRTIONET_CTRL_ANNOUNCE_ACK 0 /**< Gratuitous Packet Sending ACK */
316/** @} */
317
318struct virtio_net_ctrl_mq {
319 uint16_t uVirtqueuePairs; /**< virtqueue_pairs */
320};
321
322/** @name Control virtq: Receive steering in multiqueue mode (VirtIO 1.0, 5.1.6.5.5)
323 * @{ */
324#define VIRTIONET_CTRL_MQ 4 /**< Control class: Receive steering */
325#define VIRTIONET_CTRL_MQ_VQ_PAIRS_SET 0 /**< Set number of TX/RX queues */
326#define VIRTIONET_CTRL_MQ_VQ_PAIRS_MIN 1 /**< Minimum number of TX/RX queues */
327#define VIRTIONET_CTRL_MQ_VQ_PAIRS_MAX 0x8000 /**< Maximum number of TX/RX queues */
328/** @} */
329
330uint64_t uOffloads; /**< offloads */
331
332/** @name Control virtq: Setting Offloads State (VirtIO 1.0, 5.1.6.5.6.1)
333 * @{ */
334#define VIRTIONET_CTRL_GUEST_OFFLOADS 5 /**< Control class: Offloads state configuration */
335#define VIRTIONET_CTRL_GUEST_OFFLOADS_SET 0 /**< Apply new offloads configuration */
336/** @} */
337
338typedef enum VIRTIONETPKTHDRTYPE
339{
340 kVirtioNetUninitializedPktHdrType = 0, /**< Uninitialized (default) packet header type */
341 kVirtioNetModernPktHdrWithoutMrgRx = 1, /**< Packets should not be merged (modern driver) */
342 kVirtioNetModernPktHdrWithMrgRx = 2, /**< Packets should be merged (modern driver) */
343 kVirtioNetLegacyPktHdrWithoutMrgRx = 3, /**< Packets should not be merged (legacy driver) */
344 kVirtioNetLegacyPktHdrWithMrgRx = 4, /**< Packets should be merged (legacy driver) */
345 kVirtioNetFor32BitHack = 0x7fffffff
346} VIRTIONETPKTHDRTYPE;
347
348/**
349 * device-specific queue info
350 */
351struct VIRTIONETWORKER;
352struct VIRTIONETWORKERR3;
353
354typedef struct VIRTIONETVIRTQ
355{
356 uint16_t uIdx; /**< Index of this queue */
357 uint16_t align;
358 bool fCtlVirtq; /**< If set this queue is the control queue */
359 bool fHasWorker; /**< If set this queue has an associated worker */
360 bool fAttachedToVirtioCore; /**< Set if queue attached to virtio core */
361 char szName[VIRTIO_MAX_VIRTQ_NAME_SIZE]; /**< Virtq name */
362} VIRTIONETVIRTQ, *PVIRTIONETVIRTQ;
363
364/**
365 * Worker thread context, shared state.
366 */
367typedef struct VIRTIONETWORKER
368{
369 SUPSEMEVENT hEvtProcess; /**< handle of associated sleep/wake-up semaphore */
370 uint16_t uIdx; /**< Index of this worker */
371 bool volatile fSleeping; /**< Flags whether worker thread is sleeping or not */
372 bool volatile fNotified; /**< Flags whether worker thread notified */
373 bool fAssigned; /**< Flags whether worker thread has been set up */
374 uint8_t pad;
375} VIRTIONETWORKER;
376/** Pointer to a virtio net worker. */
377typedef VIRTIONETWORKER *PVIRTIONETWORKER;
378
379/**
380 * Worker thread context, ring-3 state.
381 */
382typedef struct VIRTIONETWORKERR3
383{
384 R3PTRTYPE(PPDMTHREAD) pThread; /**< pointer to worker thread's handle */
385 uint16_t uIdx; /**< Index of this worker */
386 uint16_t pad;
387} VIRTIONETWORKERR3;
388/** Pointer to a virtio net worker. */
389typedef VIRTIONETWORKERR3 *PVIRTIONETWORKERR3;
390
391/**
392 * VirtIO Host NET device state, shared edition.
393 *
394 * @extends VIRTIOCORE
395 */
396typedef struct VIRTIONET
397{
398 /** The core virtio state. */
399 VIRTIOCORE Virtio;
400
401 /** Virtio device-specific configuration */
402 VIRTIONET_CONFIG_T virtioNetConfig;
403
404 /** Per device-bound virtq worker-thread contexts (eventq slot unused) */
405 VIRTIONETWORKER aWorkers[VIRTIONET_MAX_VIRTQS];
406
407 /** Track which VirtIO queues we've attached to */
408 VIRTIONETVIRTQ aVirtqs[VIRTIONET_MAX_VIRTQS];
409
410 /** PDM device Instance name */
411 char szInst[16];
412
413 /** VirtIO features negotiated with the guest, including generic core and device specific */
414 uint64_t fNegotiatedFeatures;
415
416 /** Number of Rx/Tx queue pairs (only one if MQ feature not negotiated */
417 uint16_t cVirtqPairs;
418
419 /** Number of Rx/Tx queue pairs that have already been initialized */
420 uint16_t cInitializedVirtqPairs;
421
422 /** Number of virtqueues total (which includes each queue of each pair plus one control queue */
423 uint16_t cVirtqs;
424
425 /** Number of worker threads (one for the control queue and one for each Tx queue) */
426 uint16_t cWorkers;
427
428 /** Alignment */
429 uint16_t alignment;
430
431 /** Indicates transmission in progress -- only one thread is allowed. */
432 uint32_t uIsTransmitting;
433
434 /** Link up delay (in milliseconds). */
435 uint32_t cMsLinkUpDelay;
436
437 /** The number of actually used slots in aMacMulticastFilter. */
438 uint32_t cMulticastFilterMacs;
439
440 /** The number of actually used slots in aMacUniicastFilter. */
441 uint32_t cUnicastFilterMacs;
442
443 /** Semaphore leaf device's thread waits on until guest driver sends empty Rx bufs */
444 SUPSEMEVENT hEventRxDescAvail;
445
446 /** Array of MAC multicast addresses accepted by RX filter. */
447 RTMAC aMacMulticastFilter[VIRTIONET_MAC_FILTER_LEN];
448
449 /** Array of MAC unicast addresses accepted by RX filter. */
450 RTMAC aMacUnicastFilter[VIRTIONET_MAC_FILTER_LEN];
451
452 /** Default MAC address which rx filtering accepts */
453 RTMAC rxFilterMacDefault;
454
455 /** MAC address obtained from the configuration. */
456 RTMAC macConfigured;
457
458 /** Bit array of VLAN filter, one bit per VLAN ID. */
459 uint8_t aVlanFilter[VIRTIONET_MAX_VLAN_ID / sizeof(uint8_t)];
460
461 /** Set if PDM leaf device at the network interface is starved for Rx buffers */
462 bool volatile fLeafWantsEmptyRxBufs;
463
464 /** Number of packet being sent/received to show in debug log. */
465 uint32_t uPktNo;
466
467 /** Flags whether VirtIO core is in ready state */
468 uint8_t fVirtioReady;
469
470 /** Resetting flag */
471 uint8_t fResetting;
472
473 /** Promiscuous mode -- RX filter accepts all packets. */
474 uint8_t fPromiscuous;
475
476 /** All multicast mode -- RX filter accepts all multicast packets. */
477 uint8_t fAllMulticast;
478
479 /** All unicast mode -- RX filter accepts all unicast packets. */
480 uint8_t fAllUnicast;
481
482 /** No multicast mode - Supresses multicast receive */
483 uint8_t fNoMulticast;
484
485 /** No unicast mode - Suppresses unicast receive */
486 uint8_t fNoUnicast;
487
488 /** No broadcast mode - Supresses broadcast receive */
489 uint8_t fNoBroadcast;
490
491 /** Type of network pkt header based on guest driver version/features */
492 VIRTIONETPKTHDRTYPE ePktHdrType;
493
494 /** Size of network pkt header based on guest driver version/features */
495 uint16_t cbPktHdr;
496
497 /** True if physical cable is attached in configuration. */
498 bool fCableConnected;
499
500 /** True if this device should offer legacy virtio support to the guest */
501 bool fOfferLegacy;
502
503 /** @name Statistic
504 * @{ */
505 STAMCOUNTER StatReceiveBytes;
506 STAMCOUNTER StatTransmitBytes;
507 STAMCOUNTER StatReceiveGSO;
508 STAMCOUNTER StatTransmitPackets;
509 STAMCOUNTER StatTransmitGSO;
510 STAMCOUNTER StatTransmitCSum;
511#ifdef VBOX_WITH_STATISTICS
512 STAMPROFILE StatReceive;
513 STAMPROFILE StatReceiveStore;
514 STAMPROFILEADV StatTransmit;
515 STAMPROFILE StatTransmitSend;
516 STAMPROFILE StatRxOverflow;
517 STAMCOUNTER StatRxOverflowWakeup;
518 STAMCOUNTER StatTransmitByNetwork;
519 STAMCOUNTER StatTransmitByThread;
520 /** @} */
521#endif
522} VIRTIONET;
523/** Pointer to the shared state of the VirtIO Host NET device. */
524typedef VIRTIONET *PVIRTIONET;
525
526/**
527 * VirtIO Host NET device state, ring-3 edition.
528 *
529 * @extends VIRTIOCORER3
530 */
531typedef struct VIRTIONETR3
532{
533 /** The core virtio ring-3 state. */
534 VIRTIOCORER3 Virtio;
535
536 /** Per device-bound virtq worker-thread contexts (eventq slot unused) */
537 VIRTIONETWORKERR3 aWorkers[VIRTIONET_MAX_VIRTQS];
538
539 /** The device instance.
540 * @note This is _only_ for use whxen dealing with interface callbacks. */
541 PPDMDEVINSR3 pDevIns;
542
543 /** Status LUN: Base interface. */
544 PDMIBASE IBase;
545
546 /** Status LUN: LED port interface. */
547 PDMILEDPORTS ILeds;
548
549 /** Status LUN: LED connector (peer). */
550 R3PTRTYPE(PPDMILEDCONNECTORS) pLedsConnector;
551
552 /** Status: LED */
553 PDMLED led;
554
555 /** Attached network driver. */
556 R3PTRTYPE(PPDMIBASE) pDrvBase;
557
558 /** Network port interface (down) */
559 PDMINETWORKDOWN INetworkDown;
560
561 /** Network config port interface (main). */
562 PDMINETWORKCONFIG INetworkConfig;
563
564 /** Connector of attached network driver. */
565 R3PTRTYPE(PPDMINETWORKUP) pDrv;
566
567 /** Link Up(/Restore) Timer. */
568 TMTIMERHANDLE hLinkUpTimer;
569
570} VIRTIONETR3;
571
572/** Pointer to the ring-3 state of the VirtIO Host NET device. */
573typedef VIRTIONETR3 *PVIRTIONETR3;
574
575/**
576 * VirtIO Host NET device state, ring-0 edition.
577 */
578typedef struct VIRTIONETR0
579{
580 /** The core virtio ring-0 state. */
581 VIRTIOCORER0 Virtio;
582} VIRTIONETR0;
583/** Pointer to the ring-0 state of the VirtIO Host NET device. */
584typedef VIRTIONETR0 *PVIRTIONETR0;
585
586/**
587 * VirtIO Host NET device state, raw-mode edition.
588 */
589typedef struct VIRTIONETRC
590{
591 /** The core virtio raw-mode state. */
592 VIRTIOCORERC Virtio;
593} VIRTIONETRC;
594/** Pointer to the ring-0 state of the VirtIO Host NET device. */
595typedef VIRTIONETRC *PVIRTIONETRC;
596
597/** @typedef VIRTIONETCC
598 * The instance data for the current context. */
599typedef CTX_SUFF(VIRTIONET) VIRTIONETCC;
600
601/** @typedef PVIRTIONETCC
602 * Pointer to the instance data for the current context. */
603typedef CTX_SUFF(PVIRTIONET) PVIRTIONETCC;
604
605#ifdef IN_RING3
606static DECLCALLBACK(int) virtioNetR3WorkerThread(PPDMDEVINS pDevIns, PPDMTHREAD pThread);
607static int virtioNetR3CreateWorkerThreads(PPDMDEVINS, PVIRTIONET, PVIRTIONETCC);
608
609/**
610 * Helper function used when logging state of a VM thread.
611 *
612 * @param Thread
613 *
614 * @return Associated name of thread as a pointer to a zero-terminated string.
615 */
616DECLINLINE(const char *) virtioNetThreadStateName(PPDMTHREAD pThread)
617{
618 if (!pThread)
619 return "<null>";
620
621 switch(pThread->enmState)
622 {
623 case PDMTHREADSTATE_INVALID:
624 return "invalid state";
625 case PDMTHREADSTATE_INITIALIZING:
626 return "initializing";
627 case PDMTHREADSTATE_SUSPENDING:
628 return "suspending";
629 case PDMTHREADSTATE_SUSPENDED:
630 return "suspended";
631 case PDMTHREADSTATE_RESUMING:
632 return "resuming";
633 case PDMTHREADSTATE_RUNNING:
634 return "running";
635 case PDMTHREADSTATE_TERMINATING:
636 return "terminating";
637 case PDMTHREADSTATE_TERMINATED:
638 return "terminated";
639 default:
640 return "unknown state";
641 }
642}
643#endif
644
645/**
646 * Wakeup PDM managed downstream (e.g. hierarchically inferior device's) RX thread
647 */
648static DECLCALLBACK(void) virtioNetWakeupRxBufWaiter(PPDMDEVINS pDevIns)
649{
650 PVIRTIONET pThis = PDMDEVINS_2_DATA(pDevIns, PVIRTIONET);
651
652 AssertReturnVoid(pThis->hEventRxDescAvail != NIL_SUPSEMEVENT);
653
654 STAM_COUNTER_INC(&pThis->StatRxOverflowWakeup);
655 if (pThis->hEventRxDescAvail != NIL_SUPSEMEVENT)
656 {
657 Log10Func(("[%s] Waking downstream device's Rx buf waiter thread\n", pThis->szInst));
658 int rc = PDMDevHlpSUPSemEventSignal(pDevIns, pThis->hEventRxDescAvail);
659 AssertRC(rc);
660 }
661}
662
663/**
664 * Guest notifying us of its activity with a queue. Figure out which queue and respond accordingly.
665 *
666 * @callback_method_impl{VIRTIOCORER0,pfnVirtqNotified}
667 */
668static DECLCALLBACK(void) virtioNetVirtqNotified(PPDMDEVINS pDevIns, PVIRTIOCORE pVirtio, uint16_t uVirtqNbr)
669{
670 RT_NOREF(pVirtio);
671 PVIRTIONET pThis = PDMDEVINS_2_DATA(pDevIns, PVIRTIONET);
672
673 PVIRTIONETVIRTQ pVirtq = &pThis->aVirtqs[uVirtqNbr];
674 PVIRTIONETWORKER pWorker = &pThis->aWorkers[uVirtqNbr];
675
676#if defined (IN_RING3) && defined (LOG_ENABLED)
677 RTLogFlush(NULL);
678#endif
679 if (IS_RX_VIRTQ(uVirtqNbr))
680 {
681 uint16_t cBufsAvailable = virtioCoreVirtqAvailBufCount(pDevIns, pVirtio, uVirtqNbr);
682
683 if (cBufsAvailable)
684 {
685 Log10Func(("%s %u empty bufs added to %s by guest (notifying leaf device)\n",
686 pThis->szInst, cBufsAvailable, pVirtq->szName));
687 virtioNetWakeupRxBufWaiter(pDevIns);
688 }
689 else
690 Log10Func(("%s \n\n***WARNING: %s notified but no empty bufs added by guest! (skip leaf dev. notification)\n\n",
691 pThis->szInst, pVirtq->szName));
692 }
693 else if (IS_TX_VIRTQ(uVirtqNbr) || IS_CTRL_VIRTQ(uVirtqNbr))
694 {
695 /* Wake queue's worker thread up if sleeping (e.g. a Tx queue, or the control queue */
696 if (!ASMAtomicXchgBool(&pWorker->fNotified, true))
697 {
698 if (ASMAtomicReadBool(&pWorker->fSleeping))
699 {
700 Log10Func(("[%s] %s has available buffers - waking worker.\n", pThis->szInst, pVirtq->szName));
701
702 int rc = PDMDevHlpSUPSemEventSignal(pDevIns, pWorker->hEvtProcess);
703 AssertRC(rc);
704 }
705 else
706 Log10Func(("[%s] %s has available buffers - worker already awake\n", pThis->szInst, pVirtq->szName));
707 }
708 else
709 Log10Func(("[%s] %s has available buffers - waking worker.\n", pThis->szInst, pVirtq->szName));
710 }
711 else
712 LogRelFunc(("[%s] unrecognized queue %s (idx=%d) notified\n", pThis->szInst, pVirtq->szName, uVirtqNbr));
713}
714
715#ifdef IN_RING3 /* spans most of the file, at the moment. */
716
717/**
718 * @callback_method_impl{FNPDMTHREADWAKEUPDEV}
719 */
720static DECLCALLBACK(int) virtioNetR3WakeupWorker(PPDMDEVINS pDevIns, PPDMTHREAD pThread)
721{
722 PVIRTIONET pThis = PDMDEVINS_2_DATA(pDevIns, PVIRTIONET);
723 PVIRTIONETWORKER pWorker = (PVIRTIONETWORKER)pThread->pvUser;
724
725 Log10Func(("[%s]\n", pThis->szInst));
726 RT_NOREF(pThis);
727 return PDMDevHlpSUPSemEventSignal(pDevIns, pWorker->hEvtProcess);
728}
729
730/**
731 * Set queue names, distinguishing between modern or legacy mode.
732 *
733 * @note This makes it obvious during logging which mode this transitional device is
734 * operating in, legacy or modern.
735 *
736 * @param pThis Device specific device state
737 * @param fLegacy (input) true if running in legacy mode
738 * false if running in modern mode
739 */
740DECLINLINE(void) virtioNetR3SetVirtqNames(PVIRTIONET pThis, uint32_t fLegacy)
741{
742 RTStrCopy(pThis->aVirtqs[CTRLQIDX].szName, VIRTIO_MAX_VIRTQ_NAME_SIZE, fLegacy ? "legacy-ctrlq" : " modern-ctrlq");
743 for (uint16_t qPairIdx = 0; qPairIdx < pThis->cVirtqPairs; qPairIdx++)
744 {
745 RTStrPrintf(pThis->aVirtqs[RXQIDX(qPairIdx)].szName, VIRTIO_MAX_VIRTQ_NAME_SIZE, "%s-recvq<%d>", fLegacy ? "legacy" : "modern", qPairIdx);
746 RTStrPrintf(pThis->aVirtqs[TXQIDX(qPairIdx)].szName, VIRTIO_MAX_VIRTQ_NAME_SIZE, "%s-xmitq<%d>", fLegacy ? "legacy" : "modern", qPairIdx);
747 }
748}
749
750/**
751 * Dump a packet to debug log.
752 *
753 * @param pThis The virtio-net shared instance data.
754 * @param pbPacket The packet.
755 * @param cb The size of the packet.
756 * @param pszText A string denoting direction of packet transfer.
757 */
758DECLINLINE(void) virtioNetR3PacketDump(PVIRTIONET pThis, const uint8_t *pbPacket, size_t cb, const char *pszText)
759{
760#ifdef LOG_ENABLED
761 if (!LogIs12Enabled())
762 return;
763#endif
764 vboxEthPacketDump(pThis->szInst, pszText, pbPacket, (uint32_t)cb);
765}
766
767#ifdef LOG_ENABLED
768void virtioNetDumpGcPhysRxBuf(PPDMDEVINS pDevIns, PVIRTIONETPKTHDR pRxPktHdr,
769 uint16_t cVirtqBufs, uint8_t *pvBuf, uint16_t cb, RTGCPHYS GCPhysRxBuf, uint8_t cbRxBuf)
770{
771 PVIRTIONET pThis = PDMDEVINS_2_DATA(pDevIns, PVIRTIONET);
772 pRxPktHdr->uNumBuffers = cVirtqBufs;
773 if (pRxPktHdr)
774 {
775 LogFunc(("%*c\nrxPktHdr\n"
776 " uFlags ......... %2.2x\n uGsoType ....... %2.2x\n uHdrLen ........ %4.4x\n"
777 " uGsoSize ....... %4.4x\n uChksumStart ... %4.4x\n uChksumOffset .. %4.4x\n",
778 60, ' ', pRxPktHdr->uFlags, pRxPktHdr->uGsoType, pRxPktHdr->uHdrLen, pRxPktHdr->uGsoSize,
779 pRxPktHdr->uChksumStart, pRxPktHdr->uChksumOffset));
780 if (!virtioCoreIsLegacyMode(&pThis->Virtio) || FEATURE_ENABLED(MRG_RXBUF))
781 LogFunc((" uNumBuffers .... %4.4x\n", pRxPktHdr->uNumBuffers));
782 virtioCoreHexDump((uint8_t *)pRxPktHdr, sizeof(VIRTIONETPKTHDR), 0, "Dump of virtual rPktHdr");
783 }
784 virtioNetR3PacketDump(pThis, (const uint8_t *)pvBuf, cb, "<-- Incoming");
785 LogFunc((". . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .\n"));
786 virtioCoreGCPhysHexDump(pDevIns, GCPhysRxBuf, cbRxBuf, 0, "Phys Mem Dump of Rx pkt");
787 LogFunc(("%*c", 60, '-'));
788}
789
790#endif /* LOG_ENABLED */
791
792/**
793 * @callback_method_impl{FNDBGFHANDLERDEV, virtio-net debugger info callback.}
794 */
795static DECLCALLBACK(void) virtioNetR3Info(PPDMDEVINS pDevIns, PCDBGFINFOHLP pHlp, const char *pszArgs)
796{
797 PVIRTIONET pThis = PDMDEVINS_2_DATA(pDevIns, PVIRTIONET);
798 PVIRTIONETCC pThisCC = PDMDEVINS_2_DATA_CC(pDevIns, PVIRTIONETCC);
799
800 bool fNone = pszArgs && *pszArgs == '\0';
801 bool fAll = pszArgs && (*pszArgs == 'a' || *pszArgs == 'A'); /* "all" */
802 bool fNetwork = pszArgs && (*pszArgs == 'n' || *pszArgs == 'N'); /* "network" */
803 bool fFeatures = pszArgs && (*pszArgs == 'f' || *pszArgs == 'F'); /* "features" */
804 bool fState = pszArgs && (*pszArgs == 's' || *pszArgs == 'S'); /* "state" */
805 bool fPointers = pszArgs && (*pszArgs == 'p' || *pszArgs == 'P'); /* "pointers" */
806 bool fVirtqs = pszArgs && (*pszArgs == 'q' || *pszArgs == 'Q'); /* "queues */
807
808 /* Show basic information. */
809 pHlp->pfnPrintf(pHlp,
810 "\n"
811 "---------------------------------------------------------------------------\n"
812 "Debug Info: %s\n"
813 " (options: [a]ll, [n]et, [f]eatures, [s]tate, [p]ointers, [q]ueues)\n"
814 "---------------------------------------------------------------------------\n\n",
815 pThis->szInst);
816
817 if (fNone)
818 return;
819
820 /* Show offered/unoffered, accepted/rejected features */
821 if (fAll || fFeatures)
822 {
823 virtioCorePrintDeviceFeatures(&pThis->Virtio, pHlp, s_aDevSpecificFeatures,
824 RT_ELEMENTS(s_aDevSpecificFeatures));
825 pHlp->pfnPrintf(pHlp, "\n");
826 }
827
828 /* Show queues (and associate worker info if applicable) */
829 if (fAll || fVirtqs)
830 {
831 pHlp->pfnPrintf(pHlp, "Virtq information:\n\n");
832 for (int uVirtqNbr = 0; uVirtqNbr < pThis->cVirtqs; uVirtqNbr++)
833 {
834 PVIRTIONETVIRTQ pVirtq = &pThis->aVirtqs[uVirtqNbr];
835
836 if (pVirtq->fHasWorker)
837 {
838 PVIRTIONETWORKER pWorker = &pThis->aWorkers[uVirtqNbr];
839 PVIRTIONETWORKERR3 pWorkerR3 = &pThisCC->aWorkers[uVirtqNbr];
840
841 Assert((pWorker->uIdx == pVirtq->uIdx));
842 Assert((pWorkerR3->uIdx == pVirtq->uIdx));
843
844 if (pWorker->fAssigned)
845 {
846 pHlp->pfnPrintf(pHlp, " %-15s (pThread: %p %s) ",
847 pVirtq->szName,
848 pWorkerR3->pThread,
849 virtioNetThreadStateName(pWorkerR3->pThread));
850 if (pVirtq->fAttachedToVirtioCore)
851 {
852 pHlp->pfnPrintf(pHlp, "worker: ");
853 pHlp->pfnPrintf(pHlp, "%s", pWorker->fSleeping ? "blocking" : "unblocked");
854 pHlp->pfnPrintf(pHlp, "%s", pWorker->fNotified ? ", notified" : "");
855 }
856 else
857 if (pWorker->fNotified)
858 pHlp->pfnPrintf(pHlp, "not attached to virtio core");
859 }
860 }
861 else
862 {
863 pHlp->pfnPrintf(pHlp, " %-15s (INetworkDown's thread) %s", pVirtq->szName,
864 pVirtq->fAttachedToVirtioCore ? "" : "not attached to virtio core");
865 }
866 pHlp->pfnPrintf(pHlp, "\n");
867 virtioCoreR3VirtqInfo(pDevIns, pHlp, pszArgs, uVirtqNbr);
868 pHlp->pfnPrintf(pHlp, " ---------------------------------------------------------------------\n");
869 pHlp->pfnPrintf(pHlp, "\n");
870 }
871 pHlp->pfnPrintf(pHlp, "\n");
872 }
873
874 /* Show various pointers */
875 if (fAll || fPointers)
876 {
877 pHlp->pfnPrintf(pHlp, "Internal Pointers (for instance \"%s\"):\n\n", pThis->szInst);
878 pHlp->pfnPrintf(pHlp, " pDevIns ................... %p\n", pDevIns);
879 pHlp->pfnPrintf(pHlp, " PVIRTIOCORE ............... %p\n", &pThis->Virtio);
880 pHlp->pfnPrintf(pHlp, " PVIRTIONET ................ %p\n", pThis);
881 pHlp->pfnPrintf(pHlp, " PVIRTIONETCC .............. %p\n", pThisCC);
882 pHlp->pfnPrintf(pHlp, " VIRTIONETVIRTQ[] .......... %p\n", pThis->aVirtqs);
883 pHlp->pfnPrintf(pHlp, " pDrvBase .................. %p\n", pThisCC->pDrvBase);
884 pHlp->pfnPrintf(pHlp, " pDrv ...................... %p\n", pThisCC->pDrv);
885 pHlp->pfnPrintf(pHlp, " pDrv ...................... %p\n", pThisCC->pDrv);
886 pHlp->pfnPrintf(pHlp, "\n");
887 }
888
889 /* Show device state info */
890 if (fAll || fState)
891 {
892 pHlp->pfnPrintf(pHlp, "Device state:\n\n");
893 uint32_t fTransmitting = ASMAtomicReadU32(&pThis->uIsTransmitting);
894
895 pHlp->pfnPrintf(pHlp, " Transmitting: ............. %s\n", fTransmitting ? "true" : "false");
896 pHlp->pfnPrintf(pHlp, "\n");
897 pHlp->pfnPrintf(pHlp, "Misc state\n");
898 pHlp->pfnPrintf(pHlp, "\n");
899 pHlp->pfnPrintf(pHlp, " fOfferLegacy .............. %d\n", pThis->fOfferLegacy);
900 pHlp->pfnPrintf(pHlp, " fVirtioReady .............. %d\n", pThis->fVirtioReady);
901 pHlp->pfnPrintf(pHlp, " fResetting ................ %d\n", pThis->fResetting);
902 pHlp->pfnPrintf(pHlp, " fGenUpdatePending ......... %d\n", pThis->Virtio.fGenUpdatePending);
903 pHlp->pfnPrintf(pHlp, " fMsiSupport ............... %d\n", pThis->Virtio.fMsiSupport);
904 pHlp->pfnPrintf(pHlp, " uConfigGeneration ......... %d\n", pThis->Virtio.uConfigGeneration);
905 pHlp->pfnPrintf(pHlp, " uDeviceStatus ............. 0x%x\n", pThis->Virtio.fDeviceStatus);
906 pHlp->pfnPrintf(pHlp, " cVirtqPairs .,............. %d\n", pThis->cVirtqPairs);
907 pHlp->pfnPrintf(pHlp, " cVirtqs .,................. %d\n", pThis->cVirtqs);
908 pHlp->pfnPrintf(pHlp, " cWorkers .................. %d\n", pThis->cWorkers);
909 pHlp->pfnPrintf(pHlp, " MMIO mapping name ......... %d\n", pThisCC->Virtio.szMmioName);
910 pHlp->pfnPrintf(pHlp, "\n");
911 }
912
913 /* Show network related information */
914 if (fAll || fNetwork)
915 {
916 pHlp->pfnPrintf(pHlp, "Network configuration:\n\n");
917 pHlp->pfnPrintf(pHlp, " MAC: ...................... %RTmac\n", &pThis->macConfigured);
918 pHlp->pfnPrintf(pHlp, "\n");
919 pHlp->pfnPrintf(pHlp, " Cable: .................... %s\n", pThis->fCableConnected ? "connected" : "disconnected");
920 pHlp->pfnPrintf(pHlp, " Link-up delay: ............ %d ms\n", pThis->cMsLinkUpDelay);
921 pHlp->pfnPrintf(pHlp, "\n");
922 pHlp->pfnPrintf(pHlp, " Accept all multicast: ..... %s\n", pThis->fAllMulticast ? "true" : "false");
923 pHlp->pfnPrintf(pHlp, " Suppress broadcast: ....... %s\n", pThis->fNoBroadcast ? "true" : "false");
924 pHlp->pfnPrintf(pHlp, " Suppress unicast: ......... %s\n", pThis->fNoUnicast ? "true" : "false");
925 pHlp->pfnPrintf(pHlp, " Suppress multicast: ....... %s\n", pThis->fNoMulticast ? "true" : "false");
926 pHlp->pfnPrintf(pHlp, " Promiscuous: .............. %s\n", pThis->fPromiscuous ? "true" : "false");
927 pHlp->pfnPrintf(pHlp, "\n");
928 pHlp->pfnPrintf(pHlp, " Default Rx MAC filter: .... %RTmac\n", pThis->rxFilterMacDefault);
929 pHlp->pfnPrintf(pHlp, "\n");
930
931 pHlp->pfnPrintf(pHlp, " Unicast filter MACs:\n");
932
933 if (!pThis->cUnicastFilterMacs)
934 pHlp->pfnPrintf(pHlp, " <none>\n");
935
936 for (uint32_t i = 0; i < pThis->cUnicastFilterMacs; i++)
937 pHlp->pfnPrintf(pHlp, " %RTmac\n", &pThis->aMacUnicastFilter[i]);
938
939 pHlp->pfnPrintf(pHlp, "\n Multicast filter MACs:\n");
940
941 if (!pThis->cMulticastFilterMacs)
942 pHlp->pfnPrintf(pHlp, " <none>\n");
943
944 for (uint32_t i = 0; i < pThis->cMulticastFilterMacs; i++)
945 pHlp->pfnPrintf(pHlp, " %RTmac\n", &pThis->aMacMulticastFilter[i]);
946
947 pHlp->pfnPrintf(pHlp, "\n\n");
948 pHlp->pfnPrintf(pHlp, " Leaf starved: ............. %s\n", pThis->fLeafWantsEmptyRxBufs ? "true" : "false");
949 pHlp->pfnPrintf(pHlp, "\n");
950 }
951 /** @todo implement this
952 * pHlp->pfnPrintf(pHlp, "\n");
953 * virtioCoreR3Info(pDevIns, pHlp, pszArgs);
954 */
955 pHlp->pfnPrintf(pHlp, "\n");
956}
957
958/**
959 * Checks whether certain mutually dependent negotiated features are clustered in required combinations.
960 *
961 * @note See VirtIO 1.0 spec, Section 5.1.3.1
962 *
963 * @param fFeatures Bitmask of negotiated features to evaluate
964 *
965 * @returns true if valid feature combination(s) found.
966 * false if non-valid feature set.
967 */
968DECLINLINE(bool) virtioNetValidateRequiredFeatures(uint32_t fFeatures)
969{
970 uint32_t fGuestChksumRequired = fFeatures & VIRTIONET_F_GUEST_TSO4
971 || fFeatures & VIRTIONET_F_GUEST_TSO6
972 || fFeatures & VIRTIONET_F_GUEST_UFO;
973
974 uint32_t fHostChksumRequired = fFeatures & VIRTIONET_F_HOST_TSO4
975 || fFeatures & VIRTIONET_F_HOST_TSO6
976 || fFeatures & VIRTIONET_F_HOST_UFO;
977
978 uint32_t fCtrlVqRequired = fFeatures & VIRTIONET_F_CTRL_RX
979 || fFeatures & VIRTIONET_F_CTRL_VLAN
980 || fFeatures & VIRTIONET_F_GUEST_ANNOUNCE
981 || fFeatures & VIRTIONET_F_MQ
982 || fFeatures & VIRTIONET_F_CTRL_MAC_ADDR;
983
984 if (fGuestChksumRequired && !(fFeatures & VIRTIONET_F_GUEST_CSUM))
985 return false;
986
987 if (fHostChksumRequired && !(fFeatures & VIRTIONET_F_CSUM))
988 return false;
989
990 if (fCtrlVqRequired && !(fFeatures & VIRTIONET_F_CTRL_VQ))
991 return false;
992
993 if ( fFeatures & VIRTIONET_F_GUEST_ECN
994 && !( fFeatures & VIRTIONET_F_GUEST_TSO4
995 || fFeatures & VIRTIONET_F_GUEST_TSO6))
996 return false;
997
998 if ( fFeatures & VIRTIONET_F_HOST_ECN
999 && !( fFeatures & VIRTIONET_F_HOST_TSO4
1000 || fFeatures & VIRTIONET_F_HOST_TSO6))
1001 return false;
1002 return true;
1003}
1004
1005/**
1006 * Read or write device-specific configuration parameters.
1007 * This is called by VirtIO core code a guest-initiated MMIO access is made to access device-specific
1008 * configuration
1009 *
1010 * @note See VirtIO 1.0 spec, 2.3 Device Configuration Space
1011 *
1012 * @param pThis Pointer to device-specific state
1013 * @param uOffsetOfAccess Offset (within VIRTIONET_CONFIG_T)
1014 * @param pv Pointer to data to read or write
1015 * @param cb Number of bytes to read or write
1016 * @param fWrite True if writing, false if reading
1017 *
1018 * @returns VINF_SUCCESS if successful, or VINF_IOM_MMIO_UNUSED if fails (bad offset or size)
1019 */
1020static int virtioNetR3DevCfgAccess(PVIRTIONET pThis, uint32_t uOffsetOfAccess, void *pv, uint32_t cb, bool fWrite)
1021{
1022 AssertReturn(pv && cb <= sizeof(uint32_t), fWrite ? VINF_SUCCESS : VINF_IOM_MMIO_UNUSED_00);
1023
1024 if (VIRTIO_DEV_CONFIG_SUBMATCH_MEMBER( uMacAddress, VIRTIONET_CONFIG_T, uOffsetOfAccess))
1025 VIRTIO_DEV_CONFIG_ACCESS_READONLY( uMacAddress, VIRTIONET_CONFIG_T, uOffsetOfAccess, &pThis->virtioNetConfig);
1026#if FEATURE_OFFERED(STATUS)
1027 else
1028 if (VIRTIO_DEV_CONFIG_SUBMATCH_MEMBER( uStatus, VIRTIONET_CONFIG_T, uOffsetOfAccess))
1029 VIRTIO_DEV_CONFIG_ACCESS_READONLY( uStatus, VIRTIONET_CONFIG_T, uOffsetOfAccess, &pThis->virtioNetConfig);
1030#endif
1031#if FEATURE_OFFERED(MQ)
1032 else
1033 if (VIRTIO_DEV_CONFIG_MATCH_MEMBER( uMaxVirtqPairs, VIRTIONET_CONFIG_T, uOffsetOfAccess))
1034 VIRTIO_DEV_CONFIG_ACCESS_READONLY( uMaxVirtqPairs, VIRTIONET_CONFIG_T, uOffsetOfAccess, &pThis->virtioNetConfig);
1035#endif
1036 else
1037 {
1038 LogFunc(("%s Bad access by guest to virtio_net_config: off=%u (%#x), cb=%u\n",
1039 pThis->szInst, uOffsetOfAccess, uOffsetOfAccess, cb));
1040 return fWrite ? VINF_SUCCESS : VINF_IOM_MMIO_UNUSED_00;
1041 }
1042 return VINF_SUCCESS;
1043}
1044
1045/**
1046 * @callback_method_impl{VIRTIOCORER3,pfnDevCapRead}
1047 */
1048static DECLCALLBACK(int) virtioNetR3DevCapRead(PPDMDEVINS pDevIns, uint32_t uOffset, void *pv, uint32_t cb)
1049{
1050 PVIRTIONET pThis = PDMDEVINS_2_DATA(pDevIns, PVIRTIONET);
1051
1052 RT_NOREF(pThis);
1053 return virtioNetR3DevCfgAccess(PDMDEVINS_2_DATA(pDevIns, PVIRTIONET), uOffset, pv, cb, false /*fRead*/);
1054}
1055
1056/**
1057 * @callback_method_impl{VIRTIOCORER3,pfnDevCapWrite}
1058 */
1059static DECLCALLBACK(int) virtioNetR3DevCapWrite(PPDMDEVINS pDevIns, uint32_t uOffset, const void *pv, uint32_t cb)
1060{
1061 PVIRTIONET pThis = PDMDEVINS_2_DATA(pDevIns, PVIRTIONET);
1062
1063 Log10Func(("[%s] uOffset: %u, cb: %u: %.*Rhxs\n", pThis->szInst, uOffset, cb, cb, pv));
1064 RT_NOREF(pThis);
1065 return virtioNetR3DevCfgAccess(PDMDEVINS_2_DATA(pDevIns, PVIRTIONET), uOffset, (void *)pv, cb, true /*fWrite*/);
1066}
1067
1068static int virtioNetR3VirtqDestroy(PVIRTIOCORE pVirtio, PVIRTIONETVIRTQ pVirtq)
1069{
1070 PVIRTIONET pThis = RT_FROM_MEMBER(pVirtio, VIRTIONET, Virtio);
1071 PVIRTIONETCC pThisCC = PDMDEVINS_2_DATA_CC(pVirtio->pDevInsR3, PVIRTIONETCC);
1072 PVIRTIONETWORKER pWorker = &pThis->aWorkers[pVirtq->uIdx];
1073 PVIRTIONETWORKERR3 pWorkerR3 = &pThisCC->aWorkers[pVirtq->uIdx];
1074
1075 int rc = VINF_SUCCESS, rcThread;
1076 Log10Func(("[%s] Destroying \"%s\"", pThis->szInst, pVirtq->szName));
1077 if (pVirtq->fHasWorker)
1078 {
1079 Log10((" and its worker"));
1080 rc = PDMDevHlpSUPSemEventClose(pVirtio->pDevInsR3, pWorker->hEvtProcess);
1081 AssertRCReturn(rc, rc);
1082 pWorker->hEvtProcess = 0;
1083 rc = PDMDevHlpThreadDestroy(pVirtio->pDevInsR3, pWorkerR3->pThread, &rcThread);
1084 AssertRCReturn(rc, rc);
1085 pWorkerR3->pThread = 0;
1086 pVirtq->fHasWorker = false;
1087 }
1088 pWorker->fAssigned = false;
1089 pVirtq->fCtlVirtq = false;
1090 Log10(("\n"));
1091 return rc;
1092}
1093
1094/**
1095 * Takes down the link temporarily if its current status is up.
1096 *
1097 * This is used during restore and when replumbing the network link.
1098 *
1099 * The temporary link outage is supposed to indicate to the OS that all network
1100 * connections have been lost and that it for instance is appropriate to
1101 * renegotiate any DHCP lease.
1102 *
1103 * @param pDevIns The device instance.
1104 * @param pThis The virtio-net shared instance data.
1105 * @param pThisCC The virtio-net ring-3 instance data.
1106 */
1107static void virtioNetR3TempLinkDown(PPDMDEVINS pDevIns, PVIRTIONET pThis, PVIRTIONETCC pThisCC)
1108{
1109 if (IS_LINK_UP(pThis))
1110 {
1111 SET_LINK_DOWN(pThis);
1112
1113 /* Re-establish link in 5 seconds. */
1114 int rc = PDMDevHlpTimerSetMillies(pDevIns, pThisCC->hLinkUpTimer, pThis->cMsLinkUpDelay);
1115 AssertRC(rc);
1116
1117 LogFunc(("[%s] Link is down temporarily\n", pThis->szInst));
1118 }
1119}
1120
1121
1122static void virtioNetConfigurePktHdr(PVIRTIONET pThis, uint32_t fLegacy)
1123{
1124 /* Calculate network packet header type and size based on what we know now */
1125 pThis->cbPktHdr = sizeof(VIRTIONETPKTHDR);
1126 if (!fLegacy)
1127 /* Modern (e.g. >= VirtIO 1.0) device specification's pkt size rules */
1128 if (FEATURE_ENABLED(MRG_RXBUF))
1129 pThis->ePktHdrType = kVirtioNetModernPktHdrWithMrgRx;
1130 else /* Modern guest driver with MRG_RX feature disabled */
1131 pThis->ePktHdrType = kVirtioNetModernPktHdrWithoutMrgRx;
1132 else
1133 {
1134 /* Legacy (e.g. < VirtIO 1.0) device specification's pkt size rules */
1135 if (FEATURE_ENABLED(MRG_RXBUF))
1136 pThis->ePktHdrType = kVirtioNetLegacyPktHdrWithMrgRx;
1137 else /* Legacy guest with MRG_RX feature disabled */
1138 {
1139 pThis->ePktHdrType = kVirtioNetLegacyPktHdrWithoutMrgRx;
1140 pThis->cbPktHdr -= RT_SIZEOFMEMB(VIRTIONETPKTHDR, uNumBuffers);
1141 }
1142 }
1143}
1144
1145
1146/*********************************************************************************************************************************
1147* Saved state *
1148*********************************************************************************************************************************/
1149
1150/**
1151 * @callback_method_impl{FNSSMDEVLOADEXEC}
1152 *
1153 * @note: This is included to accept and migrate VMs that had used the original VirtualBox legacy-only virtio-net (network card)
1154 * controller device emulator ("DevVirtioNet.cpp") to work with this superset of VirtIO compatibility known
1155 * as a transitional device (see PDM-invoked device constructor comments for more information)
1156 */
1157static DECLCALLBACK(int) virtioNetR3LegacyDeviceLoadExec(PPDMDEVINS pDevIns, PSSMHANDLE pSSM, uint32_t uVersion, uint32_t uPass,
1158 RTMAC uMacLoaded)
1159{
1160 PVIRTIONET pThis = PDMDEVINS_2_DATA(pDevIns, PVIRTIONET);
1161 PVIRTIONETCC pThisCC = PDMDEVINS_2_DATA_CC(pDevIns, PVIRTIONETCC);
1162 PCPDMDEVHLPR3 pHlp = pDevIns->pHlpR3;
1163 int rc;
1164
1165 Log7Func(("[%s] LOAD EXEC (LEGACY)!!\n", pThis->szInst));
1166
1167 if ( memcmp(&uMacLoaded.au8, &pThis->macConfigured.au8, sizeof(uMacLoaded))
1168 && ( uPass == 0
1169 || !PDMDevHlpVMTeleportedAndNotFullyResumedYet(pDevIns)))
1170 LogRelFunc(("[%s]: The mac address differs: config=%RTmac saved=%RTmac\n",
1171 pThis->szInst, &pThis->macConfigured, &uMacLoaded));
1172
1173 if (uPass == SSM_PASS_FINAL)
1174 {
1175 /* Call the virtio core to have it load legacy device state */
1176 rc = virtioCoreR3LegacyDeviceLoadExec(&pThis->Virtio, pDevIns->pHlpR3, pSSM, uVersion, VIRTIONET_SAVEDSTATE_VERSION_3_1_BETA1_LEGACY);
1177 AssertRCReturn(rc, rc);
1178 /*
1179 * Scan constructor-determined virtqs to determine if they are all valid-as-restored.
1180 * If so, nudge them with a signal, otherwise destroy the unusable queue(s)
1181 * to avoid tripping up the other queue processing logic.
1182 */
1183 int cVirtqsToRemove = 0;
1184 for (int uVirtqNbr = 0; uVirtqNbr < pThis->cVirtqs; uVirtqNbr++)
1185 {
1186 PVIRTIONETVIRTQ pVirtq = &pThis->aVirtqs[uVirtqNbr];
1187 if (pVirtq->fHasWorker)
1188 {
1189 if (!virtioCoreR3VirtqIsEnabled(&pThis->Virtio, uVirtqNbr))
1190 {
1191 virtioNetR3VirtqDestroy(&pThis->Virtio, pVirtq);
1192 ++cVirtqsToRemove;
1193 }
1194 else
1195 {
1196 if (virtioCoreR3VirtqIsAttached(&pThis->Virtio, uVirtqNbr))
1197 {
1198 Log7Func(("[%s] Waking %s worker.\n", pThis->szInst, pVirtq->szName));
1199 rc = PDMDevHlpSUPSemEventSignal(pDevIns, pThis->aWorkers[pVirtq->uIdx].hEvtProcess);
1200 AssertRCReturn(rc, rc);
1201 }
1202 }
1203 }
1204 }
1205 AssertMsg(cVirtqsToRemove < 2, ("Multiple unusable queues in saved state unexpected\n"));
1206 pThis->cVirtqs -= cVirtqsToRemove;
1207
1208 pThis->virtioNetConfig.uStatus = pThis->Virtio.fDeviceStatus;
1209 pThis->fVirtioReady = pThis->Virtio.fDeviceStatus & VIRTIO_STATUS_DRIVER_OK;
1210
1211 rc = pHlp->pfnSSMGetMem(pSSM, pThis->virtioNetConfig.uMacAddress.au8, sizeof(pThis->virtioNetConfig.uMacAddress));
1212 AssertRCReturn(rc, rc);
1213
1214 if (uVersion > VIRTIONET_SAVEDSTATE_VERSION_3_1_BETA1_LEGACY)
1215 {
1216 /* Zero-out the the Unicast/Multicast filter table */
1217 memset(&pThis->aMacUnicastFilter[0], 0, VIRTIONET_MAC_FILTER_LEN * sizeof(RTMAC));
1218
1219 rc = pHlp->pfnSSMGetU8( pSSM, &pThis->fPromiscuous);
1220 AssertRCReturn(rc, rc);
1221 rc = pHlp->pfnSSMGetU8( pSSM, &pThis->fAllMulticast);
1222 AssertRCReturn(rc, rc);
1223 /*
1224 * The 0.95 legacy virtio spec defines a control queue command VIRTIO_NET_CTRL_MAC_TABLE_SET,
1225 * wherein guest driver configures two variable length mac filter tables: A unicast filter,
1226 * and a multicast filter. However original VBox virtio-net saved both sets of filter entries
1227 * in a single table, abandoning the distinction between unicast and multicast filters. It preserved
1228 * only *one* filter's table length, leaving no way to separate table back out into respective unicast
1229 * and multicast tables this device implementation preserves. Deduced from legacy code, the original
1230 * assumption was that the both MAC filters are whitelists that can be processed identically
1231 * (from the standpoint of a *single* host receiver), such that the distinction between unicast and
1232 * multicast doesn't matter in any one VM's context. Little choice here but to save the undifferentiated
1233 * unicast & multicast MACs to the unicast filter table and leave multicast table empty/unused.
1234 */
1235 uint32_t cCombinedUnicastMulticastEntries;
1236 rc = pHlp->pfnSSMGetU32(pSSM, &cCombinedUnicastMulticastEntries);
1237 AssertRCReturn(rc, rc);
1238 AssertReturn(cCombinedUnicastMulticastEntries <= VIRTIONET_MAC_FILTER_LEN, VERR_OUT_OF_RANGE);
1239 pThis->cUnicastFilterMacs = cCombinedUnicastMulticastEntries;
1240 rc = pHlp->pfnSSMGetMem(pSSM, pThis->aMacUnicastFilter, cCombinedUnicastMulticastEntries * sizeof(RTMAC));
1241 AssertRCReturn(rc, rc);
1242 rc = pHlp->pfnSSMGetMem(pSSM, pThis->aVlanFilter, sizeof(pThis->aVlanFilter));
1243 AssertRCReturn(rc, rc);
1244 }
1245 else
1246 {
1247 pThis->fAllMulticast = false;
1248 pThis->cUnicastFilterMacs = 0;
1249 memset(&pThis->aMacUnicastFilter, 0, VIRTIONET_MAC_FILTER_LEN * sizeof(RTMAC));
1250
1251 memset(pThis->aVlanFilter, 0, sizeof(pThis->aVlanFilter));
1252
1253 pThis->fPromiscuous = true;
1254 if (pThisCC->pDrv)
1255 pThisCC->pDrv->pfnSetPromiscuousMode(pThisCC->pDrv, true);
1256 }
1257
1258 /*
1259 * Log the restored VirtIO feature selection.
1260 */
1261 pThis->fNegotiatedFeatures = virtioCoreGetNegotiatedFeatures(&pThis->Virtio);
1262 /** @todo shouldn't we update the virtio header size here? it depends on the negotiated features. */
1263 virtioCorePrintDeviceFeatures(&pThis->Virtio, NULL, s_aDevSpecificFeatures, RT_ELEMENTS(s_aDevSpecificFeatures));
1264
1265 /*
1266 * Configure remaining transitional device parameters presumably or deductively
1267 * as these weren't part of the legacy device code thus it didn't save them to SSM
1268 */
1269 pThis->fCableConnected = 1;
1270 pThis->fAllUnicast = 0;
1271 pThis->fNoMulticast = 0;
1272 pThis->fNoUnicast = 0;
1273 pThis->fNoBroadcast = 0;
1274
1275 /* Zero out the multicast table and count, all MAC filters, if any, are in the unicast filter table */
1276 pThis->cMulticastFilterMacs = 0;
1277 memset(&pThis->aMacMulticastFilter, 0, VIRTIONET_MAC_FILTER_LEN * sizeof(RTMAC));
1278 }
1279 return VINF_SUCCESS;
1280}
1281
1282/**
1283 * @callback_method_impl{FNSSMDEVLOADEXEC}
1284 *
1285 * @note: This loads state saved by a Modern (VirtIO 1.0+) device, of which this transitional device is one,
1286 * and thus supports both legacy and modern guest virtio drivers.
1287 */
1288static DECLCALLBACK(int) virtioNetR3ModernLoadExec(PPDMDEVINS pDevIns, PSSMHANDLE pSSM, uint32_t uVersion, uint32_t uPass)
1289{
1290 PVIRTIONET pThis = PDMDEVINS_2_DATA(pDevIns, PVIRTIONET);
1291 PVIRTIONETCC pThisCC = PDMDEVINS_2_DATA_CC(pDevIns, PVIRTIONETCC);
1292 PCPDMDEVHLPR3 pHlp = pDevIns->pHlpR3;
1293 int rc;
1294
1295 RT_NOREF(pThisCC);
1296
1297 RTMAC uMacLoaded, uVersionMarkerMac = { VIRTIONET_VERSION_MARKER_MAC_ADDR };
1298 rc = pHlp->pfnSSMGetMem(pSSM, &uMacLoaded.au8, sizeof(uMacLoaded.au8));
1299 AssertRCReturn(rc, rc);
1300 if (memcmp(&uMacLoaded.au8, uVersionMarkerMac.au8, sizeof(uVersionMarkerMac.au8)))
1301 {
1302 rc = virtioNetR3LegacyDeviceLoadExec(pDevIns, pSSM, uVersion, uPass, uMacLoaded);
1303 return rc;
1304 }
1305
1306 Log7Func(("[%s] LOAD EXEC!!\n", pThis->szInst));
1307
1308 AssertReturn(uPass == SSM_PASS_FINAL, VERR_SSM_UNEXPECTED_PASS);
1309 AssertLogRelMsgReturn(uVersion == VIRTIONET_SAVEDSTATE_VERSION,
1310 ("uVersion=%u\n", uVersion), VERR_SSM_UNSUPPORTED_DATA_UNIT_VERSION);
1311
1312 virtioNetR3SetVirtqNames(pThis, false /* fLegacy */);
1313
1314 pHlp->pfnSSMGetU64( pSSM, &pThis->fNegotiatedFeatures);
1315
1316 pHlp->pfnSSMGetU16( pSSM, &pThis->cVirtqs);
1317 AssertReturn(pThis->cVirtqs <= (VIRTIONET_MAX_QPAIRS * 2) + 1, VERR_OUT_OF_RANGE);
1318 pHlp->pfnSSMGetU16( pSSM, &pThis->cWorkers);
1319 AssertReturn(pThis->cWorkers <= VIRTIONET_MAX_WORKERS , VERR_OUT_OF_RANGE);
1320
1321 for (int uVirtqNbr = 0; uVirtqNbr < pThis->cVirtqs; uVirtqNbr++)
1322 pHlp->pfnSSMGetBool(pSSM, &pThis->aVirtqs[uVirtqNbr].fAttachedToVirtioCore);
1323
1324 /* Config checks */
1325 RTMAC macConfigured;
1326 rc = pHlp->pfnSSMGetMem(pSSM, &macConfigured.au8, sizeof(macConfigured.au8));
1327 AssertRCReturn(rc, rc);
1328 if (memcmp(&macConfigured.au8, &pThis->macConfigured.au8, sizeof(macConfigured.au8))
1329 && (uPass == 0 || !PDMDevHlpVMTeleportedAndNotFullyResumedYet(pDevIns)))
1330 LogRel(("%s: The mac address differs: config=%RTmac saved=%RTmac\n",
1331 pThis->szInst, &pThis->macConfigured, &macConfigured));
1332 memcpy(pThis->virtioNetConfig.uMacAddress.au8, macConfigured.au8, sizeof(macConfigured.au8));
1333
1334#if FEATURE_OFFERED(STATUS)
1335 uint16_t fChkStatus;
1336 pHlp->pfnSSMGetU16( pSSM, &fChkStatus);
1337 if (fChkStatus == 0xffff)
1338 {
1339 /* Dummy value in saved state because status feature wasn't enabled at the time */
1340 pThis->virtioNetConfig.uStatus = 0; /* VIRTIO_NET_S_ANNOUNCE disabled */
1341 pThis->virtioNetConfig.uStatus = !!IS_LINK_UP(pThis); /* VIRTIO_NET_IS_LINK_UP (bit 0) */
1342 }
1343 else
1344 pThis->virtioNetConfig.uStatus = fChkStatus;
1345#else
1346 uint16_t fDiscard;
1347 pHlp->pfnSSMGetU16( pSSM, &fDiscard);
1348#endif
1349
1350#if FEATURE_OFFERED(MQ)
1351 uint16_t uCheckMaxVirtqPairs;
1352 pHlp->pfnSSMGetU16( pSSM, &uCheckMaxVirtqPairs);
1353 if (uCheckMaxVirtqPairs)
1354 pThis->virtioNetConfig.uMaxVirtqPairs = uCheckMaxVirtqPairs;
1355 else
1356 pThis->virtioNetConfig.uMaxVirtqPairs = VIRTIONET_CTRL_MQ_VQ_PAIRS;
1357#else
1358 uint16_t fDiscard;
1359 pHlp->pfnSSMGetU16( pSSM, &fDiscard);
1360#endif
1361
1362 /* Save device-specific part */
1363 pHlp->pfnSSMGetBool( pSSM, &pThis->fCableConnected);
1364 pHlp->pfnSSMGetU8( pSSM, &pThis->fPromiscuous);
1365 pHlp->pfnSSMGetU8( pSSM, &pThis->fAllMulticast);
1366 pHlp->pfnSSMGetU8( pSSM, &pThis->fAllUnicast);
1367 pHlp->pfnSSMGetU8( pSSM, &pThis->fNoMulticast);
1368 pHlp->pfnSSMGetU8( pSSM, &pThis->fNoUnicast);
1369 pHlp->pfnSSMGetU8( pSSM, &pThis->fNoBroadcast);
1370
1371 pHlp->pfnSSMGetU32( pSSM, &pThis->cMulticastFilterMacs);
1372 AssertReturn(pThis->cMulticastFilterMacs <= VIRTIONET_MAC_FILTER_LEN, VERR_OUT_OF_RANGE);
1373 pHlp->pfnSSMGetMem( pSSM, pThis->aMacMulticastFilter, pThis->cMulticastFilterMacs * sizeof(RTMAC));
1374
1375 if (pThis->cMulticastFilterMacs < VIRTIONET_MAC_FILTER_LEN)
1376 memset(&pThis->aMacMulticastFilter[pThis->cMulticastFilterMacs], 0,
1377 (VIRTIONET_MAC_FILTER_LEN - pThis->cMulticastFilterMacs) * sizeof(RTMAC));
1378
1379 pHlp->pfnSSMGetU32( pSSM, &pThis->cUnicastFilterMacs);
1380 AssertReturn(pThis->cUnicastFilterMacs <= VIRTIONET_MAC_FILTER_LEN, VERR_OUT_OF_RANGE);
1381 pHlp->pfnSSMGetMem( pSSM, pThis->aMacUnicastFilter, pThis->cUnicastFilterMacs * sizeof(RTMAC));
1382
1383 if (pThis->cUnicastFilterMacs < VIRTIONET_MAC_FILTER_LEN)
1384 memset(&pThis->aMacUnicastFilter[pThis->cUnicastFilterMacs], 0,
1385 (VIRTIONET_MAC_FILTER_LEN - pThis->cUnicastFilterMacs) * sizeof(RTMAC));
1386
1387 rc = pHlp->pfnSSMGetMem(pSSM, pThis->aVlanFilter, sizeof(pThis->aVlanFilter));
1388 AssertRCReturn(rc, rc);
1389 /*
1390 * Call the virtio core to let it load its state.
1391 */
1392 rc = virtioCoreR3ModernDeviceLoadExec(&pThis->Virtio, pDevIns->pHlpR3, pSSM, uVersion,
1393 VIRTIONET_SAVEDSTATE_VERSION, pThis->cVirtqs);
1394 AssertRCReturn(rc, rc);
1395 /*
1396 * Since the control queue is created proactively in the constructor to accomodate worst-case
1397 * legacy guests, even though the queue may have been deducted from queue count while saving state,
1398 * we must explicitly remove queue and associated worker thread and context at this point,
1399 * or presence of bogus control queue will confuse operations.
1400 */
1401 PVIRTIONETVIRTQ pVirtq = &pThis->aVirtqs[CTRLQIDX];
1402 if (FEATURE_DISABLED(CTRL_VQ) || !virtioCoreIsVirtqEnabled(&pThis->Virtio, CTRLQIDX))
1403 {
1404 virtioCoreR3VirtqDetach(&pThis->Virtio, CTRLQIDX);
1405 virtioNetR3VirtqDestroy(&pThis->Virtio, pVirtq);
1406 pVirtq->fAttachedToVirtioCore = false;
1407 --pThis->cWorkers;
1408 }
1409 /*
1410 * Nudge queue workers
1411 */
1412 for (int uVirtqNbr = 0; uVirtqNbr < pThis->cVirtqs; uVirtqNbr++)
1413 {
1414 pVirtq = &pThis->aVirtqs[uVirtqNbr];
1415 if (pVirtq->fAttachedToVirtioCore)
1416 {
1417 if (pVirtq->fHasWorker)
1418 {
1419 PVIRTIONETWORKER pWorker = &pThis->aWorkers[uVirtqNbr];
1420 Log7Func(("[%s] Waking %s worker.\n", pThis->szInst, pVirtq->szName));
1421 rc = PDMDevHlpSUPSemEventSignal(pDevIns, pWorker->hEvtProcess);
1422 AssertRCReturn(rc, rc);
1423 }
1424 }
1425 }
1426 pThis->virtioNetConfig.uStatus = pThis->Virtio.fDeviceStatus; /* reflects state to guest driver */
1427 pThis->fVirtioReady = pThis->Virtio.fDeviceStatus & VIRTIO_STATUS_DRIVER_OK;
1428 virtioNetConfigurePktHdr(pThis, pThis->Virtio.fLegacyDriver);
1429 return rc;
1430}
1431
1432/**
1433 * @callback_method_impl{FNSSMDEVLOADDONE, Link status adjustments after
1434 * loading.}
1435 */
1436static DECLCALLBACK(int) virtioNetR3ModernLoadDone(PPDMDEVINS pDevIns, PSSMHANDLE pSSM)
1437{
1438 PVIRTIONET pThis = PDMDEVINS_2_DATA(pDevIns, PVIRTIONET);
1439 PVIRTIONETCC pThisCC = PDMDEVINS_2_DATA_CC(pDevIns, PVIRTIONETCC);
1440 RT_NOREF(pSSM);
1441
1442 if (pThisCC->pDrv)
1443 pThisCC->pDrv->pfnSetPromiscuousMode(pThisCC->pDrv, (pThis->fPromiscuous | pThis->fAllMulticast));
1444
1445 /*
1446 * Indicate link down to the guest OS that all network connections have
1447 * been lost, unless we've been teleported here.
1448 */
1449 if (!PDMDevHlpVMTeleportedAndNotFullyResumedYet(pDevIns))
1450 virtioNetR3TempLinkDown(pDevIns, pThis, pThisCC);
1451
1452 return VINF_SUCCESS;
1453}
1454
1455/**
1456 * @callback_method_impl{FNSSMDEVSAVEEXEC}
1457 */
1458static DECLCALLBACK(int) virtioNetR3ModernSaveExec(PPDMDEVINS pDevIns, PSSMHANDLE pSSM)
1459{
1460 PVIRTIONET pThis = PDMDEVINS_2_DATA(pDevIns, PVIRTIONET);
1461 PVIRTIONETCC pThisCC = PDMDEVINS_2_DATA_CC(pDevIns, PVIRTIONETCC);
1462 PCPDMDEVHLPR3 pHlp = pDevIns->pHlpR3;
1463
1464 RT_NOREF(pThisCC);
1465 Log7Func(("[%s] SAVE EXEC!!\n", pThis->szInst));
1466
1467 /* Store a dummy MAC address that would never be actually assigned to a NIC
1468 * so that when load exec handler is called it can be easily determined
1469 * whether saved state is modern or legacy. This works because original
1470 * legacy code stored assigned NIC address as the first item of SSM state
1471 */
1472 RTMAC uVersionMarkerMac = { VIRTIONET_VERSION_MARKER_MAC_ADDR };
1473 pHlp->pfnSSMPutMem(pSSM, &uVersionMarkerMac.au8, sizeof(uVersionMarkerMac.au8));
1474
1475 pHlp->pfnSSMPutU64( pSSM, pThis->fNegotiatedFeatures);
1476
1477 pHlp->pfnSSMPutU16( pSSM, pThis->cVirtqs);
1478 pHlp->pfnSSMPutU16( pSSM, pThis->cWorkers);
1479
1480 for (int uVirtqNbr = 0; uVirtqNbr < pThis->cVirtqs; uVirtqNbr++)
1481 pHlp->pfnSSMPutBool(pSSM, pThis->aVirtqs[uVirtqNbr].fAttachedToVirtioCore);
1482 /*
1483
1484 * Save device config area (accessed via MMIO)
1485 */
1486 pHlp->pfnSSMPutMem( pSSM, pThis->virtioNetConfig.uMacAddress.au8,
1487 sizeof(pThis->virtioNetConfig.uMacAddress.au8));
1488#if FEATURE_OFFERED(STATUS)
1489 pHlp->pfnSSMPutU16( pSSM, pThis->virtioNetConfig.uStatus);
1490#else
1491 /*
1492 * Relevant values are lower bits. Forcing this to 0xffff let's loadExec know this
1493 * feature was not enabled in saved state. VirtIO 1.0, 5.1.4
1494 */
1495 pHlp->pfnSSMPutU16( pSSM, 0xffff);
1496
1497#endif
1498#if FEATURE_OFFERED(MQ)
1499 pHlp->pfnSSMPutU16( pSSM, pThis->virtioNetConfig.uMaxVirtqPairs);
1500#else
1501 /*
1502 * Legal values for max_virtqueue_pairs are 0x1 -> 0x8000 *. Forcing zero let's loadExec know this
1503 * feature was not enabled in saved state. VirtIO 1.0, 5.1.4.1
1504 */
1505 pHlp->pfnSSMPutU16( pSSM, 0);
1506#endif
1507
1508 /* Save device-specific part */
1509 pHlp->pfnSSMPutBool( pSSM, pThis->fCableConnected);
1510 pHlp->pfnSSMPutU8( pSSM, pThis->fPromiscuous);
1511 pHlp->pfnSSMPutU8( pSSM, pThis->fAllMulticast);
1512 pHlp->pfnSSMPutU8( pSSM, pThis->fAllUnicast);
1513 pHlp->pfnSSMPutU8( pSSM, pThis->fNoMulticast);
1514 pHlp->pfnSSMPutU8( pSSM, pThis->fNoUnicast);
1515 pHlp->pfnSSMPutU8( pSSM, pThis->fNoBroadcast);
1516
1517 pHlp->pfnSSMPutU32( pSSM, pThis->cMulticastFilterMacs);
1518 pHlp->pfnSSMPutMem( pSSM, pThis->aMacMulticastFilter, pThis->cMulticastFilterMacs * sizeof(RTMAC));
1519
1520 pHlp->pfnSSMPutU32( pSSM, pThis->cUnicastFilterMacs);
1521 pHlp->pfnSSMPutMem( pSSM, pThis->aMacUnicastFilter, pThis->cUnicastFilterMacs * sizeof(RTMAC));
1522
1523 int rc = pHlp->pfnSSMPutMem(pSSM, pThis->aVlanFilter, sizeof(pThis->aVlanFilter));
1524 AssertRCReturn(rc, rc);
1525
1526 /*
1527 * Call the virtio core to let it save its state.
1528 */
1529 return virtioCoreR3SaveExec(&pThis->Virtio, pDevIns->pHlpR3, pSSM, VIRTIONET_SAVEDSTATE_VERSION, pThis->cVirtqs);
1530}
1531
1532
1533/*********************************************************************************************************************************
1534* Device interface. *
1535*********************************************************************************************************************************/
1536
1537#ifdef IN_RING3
1538
1539/**
1540 * Perform 16-bit 1's compliment checksum on provided packet in accordance with VirtIO specification,
1541 * pertinent to VIRTIO_NET_F_CSUM feature, which 'offloads' the Checksum feature from the driver
1542 * to save processor cycles, which is ironic in our case, where the controller device ('network card')
1543 * is emulated on the virtualization host.
1544 *
1545 * @note See VirtIO 1.0 spec, 5.1.6.2 Packet Transmission
1546 *
1547 * @param pBuf Pointer to r/w buffer with any portion to calculate checksum for
1548 * @param cbSize Number of bytes to checksum
1549 * @param uStart Where to start the checksum within the buffer
1550 * @param uOffset Offset past uStart point in the buffer to store checksum result
1551 *
1552 */
1553DECLINLINE(void) virtioNetR3Calc16BitChecksum(uint8_t *pBuf, size_t cb, uint16_t uStart, uint16_t uOffset)
1554{
1555 AssertReturnVoid(uStart < cb);
1556 AssertReturnVoid(uStart + uOffset + sizeof(uint16_t) <= cb);
1557
1558 uint32_t chksum = 0;
1559 uint16_t *pu = (uint16_t *)(pBuf + uStart);
1560
1561 cb -= uStart;
1562 while (cb > 1)
1563 {
1564 chksum += *pu++;
1565 cb -= 2;
1566 }
1567 if (cb)
1568 chksum += *(uint8_t *)pu;
1569 while (chksum >> 16)
1570 chksum = (chksum >> 16) + (chksum & 0xFFFF);
1571
1572 /* Store 1's compliment of calculated sum */
1573 *(uint16_t *)(pBuf + uStart + uOffset) = ~chksum;
1574}
1575
1576/**
1577 * Turns on/off the read status LED.
1578 *
1579 * @returns VBox status code.
1580 * @param pThis Pointer to the device state structure.
1581 * @param fOn New LED state.
1582 */
1583void virtioNetR3SetReadLed(PVIRTIONETR3 pThisR3, bool fOn)
1584{
1585 if (fOn)
1586 pThisR3->led.Asserted.s.fReading = pThisR3->led.Actual.s.fReading = 1;
1587 else
1588 pThisR3->led.Actual.s.fReading = fOn;
1589}
1590
1591/**
1592 * Turns on/off the write status LED.
1593 *
1594 * @returns VBox status code.
1595 * @param pThis Pointer to the device state structure.
1596 * @param fOn New LED state.
1597 */
1598void virtioNetR3SetWriteLed(PVIRTIONETR3 pThisR3, bool fOn)
1599{
1600 if (fOn)
1601 pThisR3->led.Asserted.s.fWriting = pThisR3->led.Actual.s.fWriting = 1;
1602 else
1603 pThisR3->led.Actual.s.fWriting = fOn;
1604}
1605
1606/**
1607 * Check that the core is setup and ready and co-configured with guest virtio driver,
1608 * and verifies that the VM is running.
1609 *
1610 * @returns true if VirtIO core and device are in a running and operational state
1611 */
1612DECLINLINE(bool) virtioNetIsOperational(PVIRTIONET pThis, PPDMDEVINS pDevIns)
1613{
1614 if (RT_LIKELY(pThis->fVirtioReady))
1615 {
1616 VMSTATE enmVMState = PDMDevHlpVMState(pDevIns);
1617 if (RT_LIKELY(enmVMState == VMSTATE_RUNNING || enmVMState == VMSTATE_RUNNING_LS))
1618 return true;
1619 }
1620 return false;
1621}
1622
1623/**
1624 * Check whether specific queue is ready and has Rx buffers (virtqueue descriptors)
1625 * available. This must be called before the pfnRecieve() method is called.
1626 *
1627 * @remarks As a side effect this function enables queue notification
1628 * if it cannot receive because the queue is empty.
1629 * It disables notification if it can receive.
1630 *
1631 * @returns VERR_NET_NO_BUFFER_SPACE if it cannot.
1632 * @thread RX
1633 */
1634static int virtioNetR3CheckRxBufsAvail(PPDMDEVINS pDevIns, PVIRTIONET pThis, PVIRTIONETVIRTQ pRxVirtq)
1635{
1636 int rc = VERR_INVALID_STATE;
1637 Log8Func(("[%s] ", pThis->szInst));
1638 if (!virtioNetIsOperational(pThis, pDevIns))
1639 Log8(("No Rx bufs available. (VirtIO core not ready)\n"));
1640
1641 else if (!virtioCoreIsVirtqEnabled(&pThis->Virtio, pRxVirtq->uIdx))
1642 Log8(("[No Rx bufs available. (%s not enabled)\n", pRxVirtq->szName));
1643
1644 else if (IS_VIRTQ_EMPTY(pDevIns, &pThis->Virtio, pRxVirtq->uIdx))
1645 Log8(("No Rx bufs available. (%s empty)\n", pRxVirtq->szName));
1646
1647 else
1648 {
1649 Log8(("%s has %d empty guest bufs in avail ring\n", pRxVirtq->szName,
1650 virtioCoreVirtqAvailBufCount(pDevIns, &pThis->Virtio, pRxVirtq->uIdx)));
1651 rc = VINF_SUCCESS;
1652 }
1653 virtioCoreVirtqEnableNotify(&pThis->Virtio, pRxVirtq->uIdx, rc == VERR_INVALID_STATE /* fEnable */);
1654 return rc;
1655}
1656
1657/**
1658 * Find an Rx queue that has Rx packets in it, if *any* do.
1659 *
1660 * @todo When multiqueue (MQ) mode is fully supported and tested, some kind of round-robin
1661 * or randomization scheme should probably be incorporated here.
1662 *
1663 * @returns true if Rx pkts avail on queue and sets pRxVirtq to point to queue w/pkts found
1664 * @thread RX
1665 *
1666 */
1667static bool virtioNetR3AreRxBufsAvail(PPDMDEVINS pDevIns, PVIRTIONET pThis, PVIRTIONETVIRTQ *pRxVirtq)
1668{
1669 for (int uVirtqPair = 0; uVirtqPair < pThis->cVirtqPairs; uVirtqPair++)
1670 {
1671 PVIRTIONETVIRTQ pThisRxVirtq = &pThis->aVirtqs[RXQIDX(uVirtqPair)];
1672 if (RT_SUCCESS(virtioNetR3CheckRxBufsAvail(pDevIns, pThis, pThisRxVirtq)))
1673 {
1674 if (pRxVirtq)
1675 *pRxVirtq = pThisRxVirtq;
1676 return true;
1677 }
1678 }
1679 return false;
1680}
1681
1682/**
1683 * @interface_method_impl{PDMINETWORKDOWN,pfnWaitReceiveAvail}
1684 */
1685static DECLCALLBACK(int) virtioNetR3NetworkDown_WaitReceiveAvail(PPDMINETWORKDOWN pInterface, RTMSINTERVAL timeoutMs)
1686{
1687 PVIRTIONETCC pThisCC = RT_FROM_MEMBER(pInterface, VIRTIONETCC, INetworkDown);
1688 PPDMDEVINS pDevIns = pThisCC->pDevIns;
1689 PVIRTIONET pThis = PDMDEVINS_2_DATA(pDevIns, PVIRTIONET);
1690
1691 if (!virtioNetIsOperational(pThis, pDevIns))
1692 return VERR_INTERRUPTED;
1693
1694 if (virtioNetR3AreRxBufsAvail(pDevIns, pThis, NULL /* pRxVirtq */))
1695 {
1696 Log10Func(("[%s] Rx bufs available, releasing waiter...\n", pThis->szInst));
1697 return VINF_SUCCESS;
1698 }
1699 if (!timeoutMs)
1700 return VERR_NET_NO_BUFFER_SPACE;
1701
1702 LogFunc(("[%s] %s\n", pThis->szInst, timeoutMs == RT_INDEFINITE_WAIT ? "<indefinite wait>" : ""));
1703
1704 ASMAtomicXchgBool(&pThis->fLeafWantsEmptyRxBufs, true);
1705 STAM_PROFILE_START(&pThis->StatRxOverflow, a);
1706
1707 do {
1708 if (virtioNetR3AreRxBufsAvail(pDevIns, pThis, NULL /* pRxVirtq */))
1709 {
1710 Log10Func(("[%s] Rx bufs now available, releasing waiter...\n", pThis->szInst));
1711 ASMAtomicXchgBool(&pThis->fLeafWantsEmptyRxBufs, false);
1712 return VINF_SUCCESS;
1713 }
1714 Log9Func(("[%s] Starved for empty guest Rx bufs. Waiting...\n", pThis->szInst));
1715
1716 int rc = PDMDevHlpSUPSemEventWaitNoResume(pDevIns, pThis->hEventRxDescAvail, timeoutMs);
1717
1718 if (rc == VERR_TIMEOUT || rc == VERR_INTERRUPTED)
1719 {
1720 LogFunc(("Woken due to %s\n", rc == VERR_TIMEOUT ? "timeout" : "getting interrupted"));
1721
1722 if (!virtioNetIsOperational(pThis, pDevIns))
1723 break;
1724
1725 continue;
1726 }
1727 if (RT_FAILURE(rc)) {
1728 LogFunc(("Waken due to failure %Rrc\n", rc));
1729 RTThreadSleep(1);
1730 }
1731 } while (virtioNetIsOperational(pThis, pDevIns));
1732
1733 STAM_PROFILE_STOP(&pThis->StatRxOverflow, a);
1734 ASMAtomicXchgBool(&pThis->fLeafWantsEmptyRxBufs, false);
1735
1736 Log7Func(("[%s] Wait for Rx buffers available was interrupted\n", pThis->szInst));
1737 return VERR_INTERRUPTED;
1738}
1739
1740/**
1741 * Sets up the GSO context according to the Virtio header.
1742 *
1743 * @param pGso The GSO context to setup.
1744 * @param pCtx The context descriptor.
1745 */
1746DECLINLINE(PPDMNETWORKGSO) virtioNetR3SetupGsoCtx(PPDMNETWORKGSO pGso, VIRTIONETPKTHDR const *pPktHdr)
1747{
1748 pGso->u8Type = PDMNETWORKGSOTYPE_INVALID;
1749
1750 if (pPktHdr->uGsoType & VIRTIONET_HDR_GSO_ECN)
1751 {
1752 AssertMsgFailed(("Unsupported flag in virtio header: ECN\n"));
1753 return NULL;
1754 }
1755 switch (pPktHdr->uGsoType & ~VIRTIONET_HDR_GSO_ECN)
1756 {
1757 case VIRTIONET_HDR_GSO_TCPV4:
1758 pGso->u8Type = PDMNETWORKGSOTYPE_IPV4_TCP;
1759 pGso->cbHdrsSeg = pPktHdr->uHdrLen;
1760 break;
1761 case VIRTIONET_HDR_GSO_TCPV6:
1762 pGso->u8Type = PDMNETWORKGSOTYPE_IPV6_TCP;
1763 pGso->cbHdrsSeg = pPktHdr->uHdrLen;
1764 break;
1765 case VIRTIONET_HDR_GSO_UDP:
1766 pGso->u8Type = PDMNETWORKGSOTYPE_IPV4_UDP;
1767 pGso->cbHdrsSeg = pPktHdr->uChksumStart;
1768 break;
1769 default:
1770 return NULL;
1771 }
1772 if (pPktHdr->uFlags & VIRTIONET_HDR_F_NEEDS_CSUM)
1773 pGso->offHdr2 = pPktHdr->uChksumStart;
1774 else
1775 {
1776 AssertMsgFailed(("GSO without checksum offloading!\n"));
1777 return NULL;
1778 }
1779 pGso->offHdr1 = sizeof(RTNETETHERHDR);
1780 pGso->cbHdrsTotal = pPktHdr->uHdrLen;
1781 pGso->cbMaxSeg = pPktHdr->uGsoSize;
1782 /* Mark GSO frames with zero MSS as PDMNETWORKGSOTYPE_INVALID, so they will be ignored by send. */
1783 if (pPktHdr->uGsoType != VIRTIONET_HDR_GSO_NONE && pPktHdr->uGsoSize == 0)
1784 pGso->u8Type = PDMNETWORKGSOTYPE_INVALID;
1785 return pGso;
1786}
1787
1788/**
1789 * @interface_method_impl{PDMINETWORKCONFIG,pfnGetMac}
1790 */
1791static DECLCALLBACK(int) virtioNetR3NetworkConfig_GetMac(PPDMINETWORKCONFIG pInterface, PRTMAC pMac)
1792{
1793 PVIRTIONETCC pThisCC = RT_FROM_MEMBER(pInterface, VIRTIONETCC, INetworkConfig);
1794 PVIRTIONET pThis = PDMDEVINS_2_DATA(pThisCC->pDevIns, PVIRTIONET);
1795 memcpy(pMac, pThis->virtioNetConfig.uMacAddress.au8, sizeof(RTMAC));
1796 return VINF_SUCCESS;
1797}
1798
1799/**
1800 * Returns true if it is a broadcast packet.
1801 *
1802 * @returns true if destination address indicates broadcast.
1803 * @param pvBuf The ethernet packet.
1804 */
1805DECLINLINE(bool) virtioNetR3IsBroadcast(const void *pvBuf)
1806{
1807 static const uint8_t s_abBcastAddr[] = { 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF };
1808 return memcmp(pvBuf, s_abBcastAddr, sizeof(s_abBcastAddr)) == 0;
1809}
1810
1811/**
1812 * Returns true if it is a multicast packet.
1813 *
1814 * @remarks returns true for broadcast packets as well.
1815 * @returns true if destination address indicates multicast.
1816 * @param pvBuf The ethernet packet.
1817 */
1818DECLINLINE(bool) virtioNetR3IsMulticast(const void *pvBuf)
1819{
1820 return (*(char*)pvBuf) & 1;
1821}
1822
1823/**
1824 * Determines if the packet is to be delivered to upper layer.
1825 *
1826 * @returns true if packet is intended for this node.
1827 * @param pThis Pointer to the state structure.
1828 * @param pvBuf The ethernet packet.
1829 * @param cb Number of bytes available in the packet.
1830 */
1831static bool virtioNetR3AddressFilter(PVIRTIONET pThis, const void *pvBuf, size_t cb)
1832{
1833
1834RT_NOREF(cb);
1835
1836#ifdef LOG_ENABLED
1837 if (LogIs11Enabled())
1838 {
1839 char *pszType;
1840 if (virtioNetR3IsMulticast(pvBuf))
1841 pszType = (char *)"mcast";
1842 else if (virtioNetR3IsBroadcast(pvBuf))
1843 pszType = (char *)"bcast";
1844 else
1845 pszType = (char *)"ucast";
1846
1847 LogFunc(("node(%RTmac%s%s), pkt(%RTmac, %s) ",
1848 pThis->virtioNetConfig.uMacAddress.au8,
1849 pThis->fPromiscuous ? " promisc" : "",
1850 pThis->fAllMulticast ? " all-mcast" : "",
1851 pvBuf, pszType));
1852 }
1853#endif
1854
1855 if (pThis->fPromiscuous) {
1856 Log11(("\n"));
1857 return true;
1858 }
1859
1860 /* Ignore everything outside of our VLANs */
1861 uint16_t *uPtr = (uint16_t *)pvBuf;
1862
1863 /* Compare TPID with VLAN Ether Type */
1864 if ( uPtr[6] == RT_H2BE_U16(0x8100)
1865 && !ASMBitTest(pThis->aVlanFilter, RT_BE2H_U16(uPtr[7]) & 0xFFF))
1866 {
1867 Log11Func(("\n[%s] not our VLAN, returning false\n", pThis->szInst));
1868 return false;
1869 }
1870
1871 if (virtioNetR3IsBroadcast(pvBuf))
1872 {
1873 Log11(("acpt (bcast)\n"));
1874#ifdef LOG_ENABLED
1875 if (LogIs12Enabled())
1876 virtioNetR3PacketDump(pThis, (const uint8_t *)pvBuf, cb, "<-- Incoming");
1877#endif
1878 return true;
1879 }
1880 if (pThis->fAllMulticast && virtioNetR3IsMulticast(pvBuf))
1881 {
1882 Log11(("acpt (all-mcast)\n"));
1883#ifdef LOG_ENABLED
1884 if (LogIs12Enabled())
1885 virtioNetR3PacketDump(pThis, (const uint8_t *)pvBuf, cb, "<-- Incoming");
1886#endif
1887 return true;
1888 }
1889
1890 if (!memcmp(pThis->virtioNetConfig.uMacAddress.au8, pvBuf, sizeof(RTMAC)))
1891 {
1892 Log11(("acpt (to-node)\n"));
1893#ifdef LOG_ENABLED
1894 if (LogIs12Enabled())
1895 virtioNetR3PacketDump(pThis, (const uint8_t *)pvBuf, cb, "<-- Incoming");
1896#endif
1897 return true;
1898 }
1899
1900 for (uint16_t i = 0; i < pThis->cMulticastFilterMacs; i++)
1901 {
1902 if (!memcmp(&pThis->aMacMulticastFilter[i], pvBuf, sizeof(RTMAC)))
1903 {
1904 Log11(("acpt (mcast whitelist)\n"));
1905#ifdef LOG_ENABLED
1906 if (LogIs12Enabled())
1907 virtioNetR3PacketDump(pThis, (const uint8_t *)pvBuf, cb, "<-- Incoming");
1908#endif
1909 return true;
1910 }
1911 }
1912
1913 for (uint16_t i = 0; i < pThis->cUnicastFilterMacs; i++)
1914 if (!memcmp(&pThis->aMacUnicastFilter[i], pvBuf, sizeof(RTMAC)))
1915 {
1916 Log11(("acpt (ucast whitelist)\n"));
1917 return true;
1918 }
1919#ifdef LOG_ENABLED
1920 if (LogIs11Enabled())
1921 Log(("... reject\n"));
1922#endif
1923
1924 return false;
1925}
1926
1927
1928/**
1929 * This handles the case where Rx packet must be transfered to guest driver via multiple buffers using
1930 * copy tactics slower than preferred method using a single virtq buf. Yet this is an available option
1931 * for guests. Although cited in the spec it's to accomodate guest that perhaps have memory constraints
1932 * wherein guest may benefit from smaller buffers (see MRG_RXBUF feature), in practice it is seen
1933 * that without MRG_RXBUF the linux guest enqueues 'huge' multi-segment buffers so that the largest
1934 * conceivable Rx packet can be contained in a single buffer, where for most transactions most of that
1935 * memory will be unfilled, so it is typically both wasteful and *slower* to avoid MRG_RXBUF.
1936 *
1937 * As an optimization, this multi-buffer copy is only used when:
1938 *
1939 * A. Guest has negotiated MRG_RXBUF
1940 * B. Next packet in the Rx avail queue isn't big enough to contain Rx pkt hdr+data.
1941 *
1942 * Architecture is defined in VirtIO 1.1 5.1.6 (Device Operations), which has improved
1943 * wording over the VirtIO 1.0 specification, but, as an implementation note, there is one
1944 * ambiguity that needs clarification:
1945 *
1946 * The VirtIO 1.1, 5.1.6.4 explains something in a potentially misleading way. And note,
1947 * the VirtIO spec makes a document-wide assertion that the distinction between
1948 * "SHOULD" and "MUST" is to be taken quite literally.
1949 *
1950 * The confusion is that VirtIO 1.1, 5.1.6.3.1 essentially says guest driver "SHOULD" populate
1951 * Rx queue with buffers large enough to accomodate full pkt hdr + data. That's a grammatical
1952 * error (dangling participle).
1953 *
1954 * In practice we MUST assume "SHOULD" strictly applies to the word *populate*, -not- to buffer
1955 * size, because ultimately buffer minimum size is predicated on configuration parameters,
1956 * specifically, when MRG_RXBUF feature is disabled, the driver *MUST* provide Rx bufs
1957 * (if and when it can provide them), that are *large enough* to hold pkt hdr + payload.
1958 *
1959 * Therefore, proper interpretation of 5.1.6.3.1 is, the guest *should* (ideally) keep Rx virtq
1960 * populated with appropriately sized buffers to *prevent starvation* (i.e. starvation may be
1961 * unavoidable thus can't be prohibited). As it would be a ludicrous to presume 5.1.6.3.1 is
1962 * giving guests leeway to violate MRG_RXBUF feature buf size constraints.
1963 *
1964 * @param pDevIns PDM instance
1965 * @param pThis Device instance
1966 * @param pvBuf Pointer to incoming GSO Rx data from downstream device
1967 * @param cb Amount of data given
1968 * @param rxPktHdr Rx pkt Header that's been massaged into VirtIO semantics
1969 * @param pRxVirtq Pointer to Rx virtq
1970 * @param pVirtqBuf Initial virtq buffer to start copying Rx hdr/pkt to guest into
1971 *
1972 */
1973static int virtioNetR3RxPktMultibufXfer(PPDMDEVINS pDevIns, PVIRTIONET pThis, uint8_t *pvPktBuf, size_t cb,
1974 PVIRTIONETPKTHDR pRxPktHdr, PVIRTIONETVIRTQ pRxVirtq, PVIRTQBUF pVirtqBuf)
1975{
1976
1977 size_t cbBufRemaining = pVirtqBuf->cbPhysReturn;
1978 size_t cbPktHdr = pThis->cbPktHdr;
1979
1980 AssertMsgReturn(cbBufRemaining >= pThis->cbPktHdr,
1981 ("guest-provided Rx buf not large enough to store pkt hdr"), VERR_INTERNAL_ERROR);
1982
1983 Log7Func((" Sending packet header to guest...\n"));
1984
1985 /* Copy packet header to rx buf provided by caller. */
1986 size_t cbHdrEnqueued = pVirtqBuf->cbPhysReturn == cbPktHdr ? cbPktHdr : 0;
1987 virtioCoreR3VirtqUsedBufPut(pDevIns, &pThis->Virtio, pRxVirtq->uIdx, cbPktHdr, pRxPktHdr, pVirtqBuf, cbHdrEnqueued);
1988
1989 /* Cache address of uNumBuffers field of pkthdr to update ex post facto */
1990 RTGCPHYS GCPhysNumBuffers = pVirtqBuf->pSgPhysReturn->paSegs[0].GCPhys + RT_UOFFSETOF(VIRTIONETPKTHDR, uNumBuffers);
1991 uint16_t cVirtqBufsUsed = 0;
1992 cbBufRemaining -= cbPktHdr;
1993 /*
1994 * Copy packet to guest using as many buffers as necessary, tracking and handling whether
1995 * the buf containing the packet header was already written to the Rx queue's used buffer ring.
1996 */
1997 uint64_t uPktOffset = 0;
1998 while(uPktOffset < cb)
1999 {
2000 Log7Func((" Sending packet data (in buffer #%d) to guest...\n", cVirtqBufsUsed));
2001 size_t cbBounded = RT_MIN(cbBufRemaining, cb - uPktOffset);
2002 (void) virtioCoreR3VirtqUsedBufPut(pDevIns, &pThis->Virtio, pRxVirtq->uIdx, cbBounded,
2003 pvPktBuf + uPktOffset, pVirtqBuf, cbBounded + (cbPktHdr - cbHdrEnqueued) /* cbEnqueue */);
2004 ++cVirtqBufsUsed;
2005 cbBufRemaining -= cbBounded;
2006 uPktOffset += cbBounded;
2007 if (uPktOffset < cb)
2008 {
2009 cbHdrEnqueued = cbPktHdr;
2010#ifdef VIRTIO_VBUF_ON_STACK
2011 int rc = virtioCoreR3VirtqAvailBufGet(pDevIns, &pThis->Virtio, pRxVirtq->uIdx, pVirtqBuf, true);
2012#else /* !VIRTIO_VBUF_ON_STACK */
2013 virtioCoreR3VirtqBufRelease(&pThis->Virtio, pVirtqBuf);
2014 int rc = virtioCoreR3VirtqAvailBufGet(pDevIns, &pThis->Virtio, pRxVirtq->uIdx, &pVirtqBuf, true);
2015#endif /* !VIRTIO_VBUF_ON_STACK */
2016
2017 AssertMsgReturn(rc == VINF_SUCCESS || rc == VERR_NOT_AVAILABLE, ("%Rrc\n", rc), rc);
2018
2019#ifdef VIRTIO_VBUF_ON_STACK
2020 AssertMsgReturn(rc == VINF_SUCCESS && pVirtqBuf->cbPhysReturn,
2021 ("Not enough Rx buffers in queue to accomodate ethernet packet\n"),
2022 VERR_INTERNAL_ERROR);
2023#else /* !VIRTIO_VBUF_ON_STACK */
2024 AssertMsgReturnStmt(rc == VINF_SUCCESS && pVirtqBuf->cbPhysReturn,
2025 ("Not enough Rx buffers in queue to accomodate ethernet packet\n"),
2026 virtioCoreR3VirtqBufRelease(&pThis->Virtio, pVirtqBuf),
2027 VERR_INTERNAL_ERROR);
2028#endif /* !VIRTIO_VBUF_ON_STACK */
2029 cbBufRemaining = pVirtqBuf->cbPhysReturn;
2030 }
2031 }
2032
2033 /* Fix-up pkthdr (in guest phys. memory) with number of buffers (descriptors) that were processed */
2034 int rc = virtioCoreGCPhysWrite(&pThis->Virtio, pDevIns, GCPhysNumBuffers, &cVirtqBufsUsed, sizeof(cVirtqBufsUsed));
2035 AssertMsgRCReturn(rc, ("Failure updating descriptor count in pkt hdr in guest physical memory\n"), rc);
2036
2037#ifndef VIRTIO_VBUF_ON_STACK
2038 virtioCoreR3VirtqBufRelease(&pThis->Virtio, pVirtqBuf);
2039#endif /* !VIRTIO_VBUF_ON_STACK */
2040 virtioCoreVirtqUsedRingSync(pDevIns, &pThis->Virtio, pRxVirtq->uIdx);
2041 Log7(("\n"));
2042 return rc;
2043}
2044
2045/**
2046 * Pad and store received packet.
2047 *
2048 * @remarks Make sure that the packet appears to upper layer as one coming
2049 * from real Ethernet: pad it and insert FCS.
2050 *
2051 * @returns VBox status code.
2052 * @param pDevIns The device instance.
2053 * @param pThis The virtio-net shared instance data.
2054 * @param pvBuf The available data.
2055 * @param cb Number of bytes available in the buffer.
2056 * @param pGso Pointer to Global Segmentation Offload structure
2057 * @param pRxVirtq Pointer to Rx virtqueue
2058 * @thread RX
2059 */
2060
2061static int virtioNetR3CopyRxPktToGuest(PPDMDEVINS pDevIns, PVIRTIONET pThis, PVIRTIONETCC pThisCC, const void *pvBuf, size_t cb,
2062 PVIRTIONETPKTHDR pRxPktHdr, uint8_t cbPktHdr, PVIRTIONETVIRTQ pRxVirtq)
2063{
2064 RT_NOREF(pThisCC);
2065#ifdef VIRTIO_VBUF_ON_STACK
2066 VIRTQBUF_T VirtqBuf;
2067
2068 VirtqBuf.u32Magic = VIRTQBUF_MAGIC;
2069 VirtqBuf.cRefs = 1;
2070
2071 PVIRTQBUF pVirtqBuf = &VirtqBuf;
2072 int rc = virtioCoreR3VirtqAvailBufGet(pDevIns, &pThis->Virtio, pRxVirtq->uIdx, pVirtqBuf, true);
2073#else /* !VIRTIO_VBUF_ON_STACK */
2074 PVIRTQBUF pVirtqBuf;
2075 int rc = virtioCoreR3VirtqAvailBufGet(pDevIns, &pThis->Virtio, pRxVirtq->uIdx, &pVirtqBuf, true);
2076#endif /* !VIRTIO_VBUF_ON_STACK */
2077
2078 AssertMsgReturn(rc == VINF_SUCCESS || rc == VERR_NOT_AVAILABLE, ("%Rrc\n", rc), rc);
2079
2080#ifdef VIRTIO_VBUF_ON_STACK
2081 AssertMsgReturn(rc == VINF_SUCCESS && pVirtqBuf->cbPhysReturn,
2082 ("Not enough Rx buffers or capacity to accommodate ethernet packet\n"),
2083 VERR_INTERNAL_ERROR);
2084#else /* !VIRTIO_VBUF_ON_STACK */
2085 AssertMsgReturnStmt(rc == VINF_SUCCESS && pVirtqBuf->cbPhysReturn,
2086 ("Not enough Rx buffers or capacity to accommodate ethernet packet\n"),
2087 virtioCoreR3VirtqBufRelease(&pThis->Virtio, pVirtqBuf),
2088 VERR_INTERNAL_ERROR);
2089#endif /* !VIRTIO_VBUF_ON_STACK */
2090 /*
2091 * Try to do fast (e.g. single-buffer) copy to guest, even if MRG_RXBUF feature is enabled
2092 */
2093 STAM_PROFILE_START(&pThis->StatReceiveStore, a);
2094 if (RT_LIKELY(FEATURE_DISABLED(MRG_RXBUF))
2095 || RT_LIKELY(pVirtqBuf->cbPhysReturn > cb + cbPktHdr))
2096 {
2097 Log7Func(("Send Rx packet header and data to guest (single-buffer copy)...\n"));
2098 pRxPktHdr->uNumBuffers = 1;
2099 rc = virtioCoreR3VirtqUsedBufPut(pDevIns, &pThis->Virtio, pRxVirtq->uIdx, cbPktHdr, pRxPktHdr, pVirtqBuf, 0 /* cbEnqueue */);
2100 if (rc == VINF_SUCCESS)
2101 rc = virtioCoreR3VirtqUsedBufPut(pDevIns, &pThis->Virtio, pRxVirtq->uIdx, cb, pvBuf, pVirtqBuf, cbPktHdr + cb /* cbEnqueue */);
2102#ifndef VIRTIO_VBUF_ON_STACK
2103 virtioCoreR3VirtqBufRelease(&pThis->Virtio, pVirtqBuf);
2104#endif /* !VIRTIO_VBUF_ON_STACK */
2105 virtioCoreVirtqUsedRingSync(pDevIns, &pThis->Virtio, pRxVirtq->uIdx);
2106 AssertMsgReturn(rc == VINF_SUCCESS, ("%Rrc\n", rc), rc);
2107 }
2108 else
2109 {
2110 Log7Func(("Send Rx pkt to guest (merged-buffer copy [MRG_RXBUF feature])...\n"));
2111 rc = virtioNetR3RxPktMultibufXfer(pDevIns, pThis, (uint8_t *)pvBuf, cb, pRxPktHdr, pRxVirtq, pVirtqBuf);
2112 return rc;
2113 }
2114 STAM_PROFILE_STOP(&pThis->StatReceiveStore, a);
2115 return VINF_SUCCESS;
2116}
2117
2118/**
2119 * @interface_method_impl{PDMINETWORKDOWN,pfnReceiveGso}
2120 */
2121static DECLCALLBACK(int) virtioNetR3NetworkDown_ReceiveGso(
2122 PPDMINETWORKDOWN pInterface, const void *pvBuf, size_t cb, PCPDMNETWORKGSO pGso)
2123{
2124 PVIRTIONETCC pThisCC = RT_FROM_MEMBER(pInterface, VIRTIONETCC, INetworkDown);
2125 PPDMDEVINS pDevIns = pThisCC->pDevIns;
2126 PVIRTIONET pThis = PDMDEVINS_2_DATA(pDevIns, PVIRTIONET);
2127 VIRTIONETPKTHDR rxPktHdr = { 0, VIRTIONET_HDR_GSO_NONE, 0, 0, 0, 0, 0 };
2128
2129 if (!pThis->fVirtioReady)
2130 {
2131 LogRelFunc(("VirtIO not ready, aborting downstream receive\n"));
2132 return VERR_INTERRUPTED;
2133 }
2134 /*
2135 * If GSO (Global Segment Offloading) was received from downstream PDM network device, massage the
2136 * PDM-provided GSO parameters into VirtIO semantics, which get passed to guest virtio-net via
2137 * Rx pkt header. See VirtIO 1.1, 5.1.6 Device Operation for more information.
2138 */
2139 if (pGso)
2140 {
2141 LogFunc(("[%s] (%RTmac) \n", pThis->szInst, pvBuf));
2142
2143 rxPktHdr.uFlags = VIRTIONET_HDR_F_NEEDS_CSUM;
2144 rxPktHdr.uHdrLen = pGso->cbHdrsTotal;
2145 rxPktHdr.uGsoSize = pGso->cbMaxSeg;
2146 rxPktHdr.uChksumStart = pGso->offHdr2;
2147
2148 switch (pGso->u8Type)
2149 {
2150 case PDMNETWORKGSOTYPE_IPV4_TCP:
2151 rxPktHdr.uGsoType = VIRTIONET_HDR_GSO_TCPV4;
2152 rxPktHdr.uChksumOffset = RT_OFFSETOF(RTNETTCP, th_sum);
2153 break;
2154 case PDMNETWORKGSOTYPE_IPV6_TCP:
2155 rxPktHdr.uGsoType = VIRTIONET_HDR_GSO_TCPV6;
2156 rxPktHdr.uChksumOffset = RT_OFFSETOF(RTNETTCP, th_sum);
2157 break;
2158 case PDMNETWORKGSOTYPE_IPV4_UDP:
2159 rxPktHdr.uGsoType = VIRTIONET_HDR_GSO_UDP;
2160 rxPktHdr.uChksumOffset = RT_OFFSETOF(RTNETUDP, uh_sum);
2161 break;
2162 default:
2163 LogFunc(("[%s] GSO type (0x%x) not supported\n", pThis->szInst, pGso->u8Type));
2164 return VERR_NOT_SUPPORTED;
2165 }
2166 STAM_REL_COUNTER_INC(&pThis->StatReceiveGSO);
2167 Log2Func(("[%s] gso type=%#x, cbHdrsTotal=%u cbHdrsSeg=%u mss=%u offHdr1=%#x offHdr2=%#x\n",
2168 pThis->szInst, pGso->u8Type, pGso->cbHdrsTotal, pGso->cbHdrsSeg,
2169 pGso->cbMaxSeg, pGso->offHdr1, pGso->offHdr2));
2170 }
2171
2172 /*
2173 * Find a virtq with Rx bufs on avail ring, if any, and copy the packet to the guest's Rx buffer.
2174 * @todo pk: PROBABLY NOT A SOPHISTICATED ENOUGH QUEUE SELECTION ALGORTITH FOR OPTIMAL MQ (FEATURE) SUPPORT
2175 */
2176 for (int uVirtqPair = 0; uVirtqPair < pThis->cVirtqPairs; uVirtqPair++)
2177 {
2178 PVIRTIONETVIRTQ pRxVirtq = &pThis->aVirtqs[RXQIDX(uVirtqPair)];
2179 if (RT_SUCCESS(virtioNetR3CheckRxBufsAvail(pDevIns, pThis, pRxVirtq)))
2180 {
2181 int rc = VINF_SUCCESS;
2182 STAM_PROFILE_START(&pThis->StatReceive, a);
2183 virtioNetR3SetReadLed(pThisCC, true);
2184 if (virtioNetR3AddressFilter(pThis, pvBuf, cb))
2185 {
2186 /* rxPktHdr is local stack variable that should not go out of scope in this use */
2187 rc = virtioNetR3CopyRxPktToGuest(pDevIns, pThis, pThisCC, pvBuf, cb, &rxPktHdr, pThis->cbPktHdr, pRxVirtq);
2188 STAM_REL_COUNTER_ADD(&pThis->StatReceiveBytes, cb);
2189 }
2190 virtioNetR3SetReadLed(pThisCC, false);
2191 STAM_PROFILE_STOP(&pThis->StatReceive, a);
2192 return rc;
2193 }
2194 }
2195 return VERR_INTERRUPTED;
2196}
2197
2198/**
2199 * @interface_method_impl{PDMINETWORKDOWN,pfnReceive}
2200 */
2201static DECLCALLBACK(int) virtioNetR3NetworkDown_Receive(PPDMINETWORKDOWN pInterface, const void *pvBuf, size_t cb)
2202{
2203
2204#ifdef LOG_ENABLED
2205 PVIRTIONETCC pThisCC = RT_FROM_MEMBER(pInterface, VIRTIONETCC, INetworkDown);
2206 PPDMDEVINS pDevIns = pThisCC->pDevIns;
2207 PVIRTIONET pThis = PDMDEVINS_2_DATA(pDevIns, PVIRTIONET);
2208 LogFunc(("[%s] (%RTmac)\n", pThis->szInst, pvBuf));
2209#endif
2210
2211 return virtioNetR3NetworkDown_ReceiveGso(pInterface, pvBuf, cb, NULL);
2212}
2213
2214/*
2215 * Dispatched to here from virtioNetR3Ctrl() to configure this virtio-net device's Rx packet receive filtering.
2216 * See VirtIO 1.0, 5.1.6.5.1
2217 *
2218 * @param pThis virtio-net instance
2219 * @param pCtrlPktHdr Control packet header (which includes command parameters)
2220 * @param pVirtqBuf Buffer from ctrlq buffer (contains command data)
2221 */
2222static uint8_t virtioNetR3CtrlRx(PVIRTIONET pThis, PVIRTIONETCC pThisCC,
2223 PVIRTIONET_CTRL_HDR_T pCtrlPktHdr, PVIRTQBUF pVirtqBuf)
2224{
2225
2226#define LOG_VIRTIONET_FLAG(fld) LogFunc(("[%s] Setting %s=%d\n", pThis->szInst, #fld, pThis->fld))
2227
2228 LogFunc(("[%s] Processing CTRL Rx command\n", pThis->szInst));
2229 switch(pCtrlPktHdr->uCmd)
2230 {
2231 case VIRTIONET_CTRL_RX_PROMISC:
2232 break;
2233 case VIRTIONET_CTRL_RX_ALLMULTI:
2234 break;
2235 case VIRTIONET_CTRL_RX_ALLUNI:
2236 /* fallthrough */
2237 case VIRTIONET_CTRL_RX_NOMULTI:
2238 /* fallthrough */
2239 case VIRTIONET_CTRL_RX_NOUNI:
2240 /* fallthrough */
2241 case VIRTIONET_CTRL_RX_NOBCAST:
2242 AssertMsgReturn(FEATURE_ENABLED(CTRL_RX_EXTRA),
2243 ("CTRL 'extra' cmd w/o VIRTIONET_F_CTRL_RX_EXTRA feature negotiated - skipping\n"),
2244 VIRTIONET_ERROR);
2245 /* fall out */
2246 }
2247
2248 uint8_t fOn, fPromiscChanged = false;
2249 virtioCoreR3VirtqBufDrain(&pThis->Virtio, pVirtqBuf, &fOn, (size_t)RT_MIN(pVirtqBuf->cbPhysSend, sizeof(fOn)));
2250
2251 switch(pCtrlPktHdr->uCmd)
2252 {
2253 case VIRTIONET_CTRL_RX_PROMISC:
2254 pThis->fPromiscuous = RT_BOOL(fOn);
2255 fPromiscChanged = true;
2256 LOG_VIRTIONET_FLAG(fPromiscuous);
2257 break;
2258 case VIRTIONET_CTRL_RX_ALLMULTI:
2259 pThis->fAllMulticast = RT_BOOL(fOn);
2260 fPromiscChanged = true;
2261 LOG_VIRTIONET_FLAG(fAllMulticast);
2262 break;
2263 case VIRTIONET_CTRL_RX_ALLUNI:
2264 pThis->fAllUnicast = RT_BOOL(fOn);
2265 LOG_VIRTIONET_FLAG(fAllUnicast);
2266 break;
2267 case VIRTIONET_CTRL_RX_NOMULTI:
2268 pThis->fNoMulticast = RT_BOOL(fOn);
2269 LOG_VIRTIONET_FLAG(fNoMulticast);
2270 break;
2271 case VIRTIONET_CTRL_RX_NOUNI:
2272 pThis->fNoUnicast = RT_BOOL(fOn);
2273 LOG_VIRTIONET_FLAG(fNoUnicast);
2274 break;
2275 case VIRTIONET_CTRL_RX_NOBCAST:
2276 pThis->fNoBroadcast = RT_BOOL(fOn);
2277 LOG_VIRTIONET_FLAG(fNoBroadcast);
2278 break;
2279 }
2280
2281 if (pThisCC->pDrv && fPromiscChanged)
2282 pThisCC->pDrv->pfnSetPromiscuousMode(pThisCC->pDrv, (pThis->fPromiscuous || pThis->fAllMulticast));
2283
2284 return VIRTIONET_OK;
2285}
2286
2287/*
2288 * Dispatched to here from virtioNetR3Ctrl() to configure this virtio-net device's MAC filter tables
2289 * See VirtIO 1.0, 5.1.6.5.2
2290 *
2291 * @param pThis virtio-net instance
2292 * @param pCtrlPktHdr Control packet header (which includes command parameters)
2293 * @param pVirtqBuf Buffer from ctrlq buffer (contains command data)
2294 */
2295static uint8_t virtioNetR3CtrlMac(PVIRTIONET pThis, PVIRTIONET_CTRL_HDR_T pCtrlPktHdr, PVIRTQBUF pVirtqBuf)
2296{
2297 LogFunc(("[%s] Processing CTRL MAC command\n", pThis->szInst));
2298
2299
2300 AssertMsgReturn(pVirtqBuf->cbPhysSend >= sizeof(*pCtrlPktHdr),
2301 ("insufficient descriptor space for ctrl pkt hdr"),
2302 VIRTIONET_ERROR);
2303
2304 size_t cbRemaining = pVirtqBuf->cbPhysSend;
2305 switch(pCtrlPktHdr->uCmd)
2306 {
2307 case VIRTIONET_CTRL_MAC_ADDR_SET:
2308 {
2309 /* Set default Rx filter MAC */
2310 AssertMsgReturn(cbRemaining >= sizeof(pThis->rxFilterMacDefault),
2311 ("DESC chain too small to process CTRL_MAC_ADDR_SET cmd\n"), VIRTIONET_ERROR);
2312
2313 virtioCoreR3VirtqBufDrain(&pThis->Virtio, pVirtqBuf, &pThis->rxFilterMacDefault, sizeof(RTMAC));
2314 break;
2315 }
2316 case VIRTIONET_CTRL_MAC_TABLE_SET:
2317 {
2318 VIRTIONET_CTRL_MAC_TABLE_LEN cMacs;
2319
2320 /* Load unicast MAC filter table */
2321 AssertMsgReturn(cbRemaining >= sizeof(cMacs),
2322 ("DESC chain too small to process CTRL_MAC_TABLE_SET cmd\n"), VIRTIONET_ERROR);
2323
2324 /* Fetch count of unicast filter MACs from guest buffer */
2325 virtioCoreR3VirtqBufDrain(&pThis->Virtio, pVirtqBuf, &cMacs, sizeof(cMacs));
2326 cbRemaining -= sizeof(cMacs);
2327
2328 Log7Func(("[%s] Guest provided %d unicast MAC Table entries\n", pThis->szInst, cMacs));
2329
2330 if (cMacs)
2331 {
2332 uint32_t cbMacs = cMacs * sizeof(RTMAC);
2333
2334 AssertMsgReturn(cbMacs <= sizeof(pThis->aMacUnicastFilter) / sizeof(RTMAC),
2335 ("Guest provided Unicast MAC filter table exceeds hardcoded table size"), VIRTIONET_ERROR);
2336
2337 AssertMsgReturn(cbRemaining >= cbMacs,
2338 ("Virtq buffer too small to process CTRL_MAC_TABLE_SET cmd\n"), VIRTIONET_ERROR);
2339
2340
2341 /* Fetch unicast table contents from guest buffer */
2342 virtioCoreR3VirtqBufDrain(&pThis->Virtio, pVirtqBuf, &pThis->aMacUnicastFilter, cbMacs);
2343 cbRemaining -= cbMacs;
2344 }
2345 pThis->cUnicastFilterMacs = cMacs;
2346
2347 /* Load multicast MAC filter table */
2348 AssertMsgReturn(cbRemaining >= sizeof(cMacs),
2349 ("Virtq buffer too small to process CTRL_MAC_TABLE_SET cmd\n"), VIRTIONET_ERROR);
2350
2351 /* Fetch count of multicast filter MACs from guest buffer */
2352 virtioCoreR3VirtqBufDrain(&pThis->Virtio, pVirtqBuf, &cMacs, sizeof(cMacs));
2353 cbRemaining -= sizeof(cMacs);
2354
2355 Log10Func(("[%s] Guest provided %d multicast MAC Table entries\n", pThis->szInst, cMacs));
2356
2357 if (cMacs)
2358 {
2359 uint32_t cbMacs = cMacs * sizeof(RTMAC);
2360
2361 AssertMsgReturn(cbMacs <= sizeof(pThis->aMacMulticastFilter) / sizeof(RTMAC),
2362 ("Guest provided Unicast MAC filter table exceeds hardcoded table size"), VIRTIONET_ERROR);
2363
2364 AssertMsgReturn(cbRemaining >= cbMacs,
2365 ("Virtq buffer too small to process CTRL_MAC_TABLE_SET cmd\n"), VIRTIONET_ERROR);
2366
2367 /* Fetch multicast table contents from guest buffer */
2368 virtioCoreR3VirtqBufDrain(&pThis->Virtio, pVirtqBuf, &pThis->aMacMulticastFilter, cbMacs);
2369 cbRemaining -= cbMacs;
2370 }
2371 pThis->cMulticastFilterMacs = cMacs;
2372
2373#ifdef LOG_ENABLED
2374 LogFunc(("[%s] unicast MACs:\n", pThis->szInst));
2375 for(unsigned i = 0; i < pThis->cUnicastFilterMacs; i++)
2376 LogFunc((" %RTmac\n", &pThis->aMacUnicastFilter[i]));
2377
2378 LogFunc(("[%s] multicast MACs:\n", pThis->szInst));
2379 for(unsigned i = 0; i < pThis->cMulticastFilterMacs; i++)
2380 LogFunc((" %RTmac\n", &pThis->aMacMulticastFilter[i]));
2381#endif
2382 break;
2383 }
2384 default:
2385 LogRelFunc(("Unrecognized MAC subcommand in CTRL pkt from guest\n"));
2386 return VIRTIONET_ERROR;
2387 }
2388 return VIRTIONET_OK;
2389}
2390
2391/*
2392 * Dispatched to here from virtioNetR3Ctrl() to configure this virtio-net device's MQ (multiqueue) operations.
2393 * See VirtIO 1.0, 5.1.6.5.5
2394 *
2395 * @param pThis virtio-net instance
2396 * @param pCtrlPktHdr Control packet header (which includes command parameters)
2397 * @param pVirtqBuf Buffer from ctrlq buffer (contains command data)
2398 */
2399static uint8_t virtioNetR3CtrlMultiQueue(PVIRTIONET pThis, PVIRTIONETCC pThisCC, PPDMDEVINS pDevIns, PVIRTIONET_CTRL_HDR_T pCtrlPktHdr, PVIRTQBUF pVirtqBuf)
2400{
2401 LogFunc(("[%s] Processing CTRL MQ command\n", pThis->szInst));
2402
2403 uint16_t cVirtqPairs;
2404 switch(pCtrlPktHdr->uCmd)
2405 {
2406 case VIRTIONET_CTRL_MQ_VQ_PAIRS_SET:
2407 {
2408 size_t cbRemaining = pVirtqBuf->cbPhysSend - sizeof(*pCtrlPktHdr);
2409
2410 AssertMsgReturn(cbRemaining > sizeof(cVirtqPairs),
2411 ("DESC chain too small for VIRTIONET_CTRL_MQ cmd processing"), VIRTIONET_ERROR);
2412
2413 /* Fetch number of virtq pairs from guest buffer */
2414 virtioCoreR3VirtqBufDrain(&pThis->Virtio, pVirtqBuf, &cVirtqPairs, sizeof(cVirtqPairs));
2415
2416 AssertMsgReturn(cVirtqPairs > VIRTIONET_MAX_QPAIRS,
2417 ("[%s] Guest CTRL MQ virtq pair count out of range [%d])\n", pThis->szInst, cVirtqPairs), VIRTIONET_ERROR);
2418
2419 LogFunc(("[%s] Guest specifies %d VQ pairs in use\n", pThis->szInst, cVirtqPairs));
2420 pThis->cVirtqPairs = cVirtqPairs;
2421 break;
2422 }
2423 default:
2424 LogRelFunc(("Unrecognized multiqueue subcommand in CTRL pkt from guest\n"));
2425 return VIRTIONET_ERROR;
2426 }
2427
2428 /*
2429 * The MQ control function is invoked by the guest in an RPC like manner to change
2430 * the Rx/Tx queue pair count. If the new value exceeds the number of queues
2431 * (and associated workers) already initialized initialize only the new queues and
2432 * respective workers.
2433 */
2434 if (pThis->cVirtqPairs > pThis->cInitializedVirtqPairs)
2435 {
2436 virtioNetR3SetVirtqNames(pThis, virtioCoreIsLegacyMode(&pThis->Virtio));
2437 int rc = virtioNetR3CreateWorkerThreads(pDevIns, pThis, pThisCC);
2438 if (RT_FAILURE(rc))
2439 {
2440 LogRelFunc(("Failed to create worker threads\n"));
2441 return VIRTIONET_ERROR;
2442 }
2443 }
2444 return VIRTIONET_OK;
2445}
2446
2447/*
2448 * Dispatched to here from virtioNetR3Ctrl() to configure this virtio-net device's VLAN filtering.
2449 * See VirtIO 1.0, 5.1.6.5.3
2450 *
2451 * @param pThis virtio-net instance
2452 * @param pCtrlPktHdr Control packet header (which includes command parameters)
2453 * @param pVirtqBuf Buffer from ctrlq buffer (contains command data)
2454 */
2455static uint8_t virtioNetR3CtrlVlan(PVIRTIONET pThis, PVIRTIONET_CTRL_HDR_T pCtrlPktHdr, PVIRTQBUF pVirtqBuf)
2456{
2457 LogFunc(("[%s] Processing CTRL VLAN command\n", pThis->szInst));
2458
2459 uint16_t uVlanId;
2460 size_t cbRemaining = pVirtqBuf->cbPhysSend - sizeof(*pCtrlPktHdr);
2461
2462 AssertMsgReturn(cbRemaining > sizeof(uVlanId),
2463 ("DESC chain too small for VIRTIONET_CTRL_VLAN cmd processing"), VIRTIONET_ERROR);
2464
2465 /* Fetch VLAN ID from guest buffer */
2466 virtioCoreR3VirtqBufDrain(&pThis->Virtio, pVirtqBuf, &uVlanId, sizeof(uVlanId));
2467
2468 AssertMsgReturn(uVlanId > VIRTIONET_MAX_VLAN_ID,
2469 ("%s VLAN ID out of range (VLAN ID=%u)\n", pThis->szInst, uVlanId), VIRTIONET_ERROR);
2470
2471 LogFunc(("[%s] uCommand=%u VLAN ID=%u\n", pThis->szInst, pCtrlPktHdr->uCmd, uVlanId));
2472
2473 switch (pCtrlPktHdr->uCmd)
2474 {
2475 case VIRTIONET_CTRL_VLAN_ADD:
2476 ASMBitSet(pThis->aVlanFilter, uVlanId);
2477 break;
2478 case VIRTIONET_CTRL_VLAN_DEL:
2479 ASMBitClear(pThis->aVlanFilter, uVlanId);
2480 break;
2481 default:
2482 LogRelFunc(("Unrecognized VLAN subcommand in CTRL pkt from guest\n"));
2483 return VIRTIONET_ERROR;
2484 }
2485 return VIRTIONET_OK;
2486}
2487
2488/**
2489 * Processes control command from guest.
2490 * See VirtIO 1.0 spec, 5.1.6 "Device Operation" and 5.1.6.5 "Control Virtqueue".
2491 *
2492 * The control command is contained in a virtio buffer pulled from the virtio-net defined control queue (ctrlq).
2493 * Command type is parsed is dispatched to a command-specific device-configuration handler function (e.g. RX, MAC, VLAN, MQ
2494 * and ANNOUNCE).
2495 *
2496 * This function handles all parts of the host-side of the ctrlq round-trip buffer processing.
2497 *
2498 * Invoked by worker for virtio-net control queue to process a queued control command buffer.
2499 *
2500 * @param pDevIns PDM device instance
2501 * @param pThis virtio-net device instance
2502 * @param pThisCC virtio-net device instance
2503 * @param pVirtqBuf pointer to buffer pulled from virtq (input to this function)
2504 */
2505static void virtioNetR3Ctrl(PPDMDEVINS pDevIns, PVIRTIONET pThis, PVIRTIONETCC pThisCC,
2506 PVIRTQBUF pVirtqBuf)
2507{
2508 if (!(pThis->fNegotiatedFeatures & VIRTIONET_F_CTRL_VQ))
2509 LogFunc(("[%s] WARNING: Guest using CTRL queue w/o negotiating VIRTIONET_F_CTRL_VQ feature\n", pThis->szInst));
2510
2511 LogFunc(("[%s] Received CTRL packet from guest\n", pThis->szInst));
2512
2513 if (pVirtqBuf->cbPhysSend < 2)
2514 {
2515 LogFunc(("[%s] CTRL packet from guest driver incomplete. Skipping ctrl cmd\n", pThis->szInst));
2516 return;
2517 }
2518 else if (pVirtqBuf->cbPhysReturn < sizeof(VIRTIONET_CTRL_HDR_T_ACK))
2519 {
2520 LogFunc(("[%s] Guest driver didn't allocate memory to receive ctrl pkt ACK. Skipping ctrl cmd\n", pThis->szInst));
2521 return;
2522 }
2523
2524 /*
2525 * Allocate buffer and read in the control command
2526 */
2527 AssertMsgReturnVoid(pVirtqBuf->cbPhysSend >= sizeof(VIRTIONET_CTRL_HDR_T),
2528 ("DESC chain too small for CTRL pkt header"));
2529
2530 VIRTIONET_CTRL_HDR_T CtrlPktHdr; RT_ZERO(CtrlPktHdr);
2531 virtioCoreR3VirtqBufDrain(&pThis->Virtio, pVirtqBuf, &CtrlPktHdr,
2532 RT_MIN(pVirtqBuf->cbPhysSend, sizeof(CtrlPktHdr)));
2533
2534 Log7Func(("[%s] CTRL COMMAND: class=%d command=%d\n", pThis->szInst, CtrlPktHdr.uClass, CtrlPktHdr.uCmd));
2535
2536 uint8_t uAck;
2537 switch (CtrlPktHdr.uClass)
2538 {
2539 case VIRTIONET_CTRL_RX:
2540 uAck = virtioNetR3CtrlRx(pThis, pThisCC, &CtrlPktHdr, pVirtqBuf);
2541 break;
2542 case VIRTIONET_CTRL_MAC:
2543 uAck = virtioNetR3CtrlMac(pThis, &CtrlPktHdr, pVirtqBuf);
2544 break;
2545 case VIRTIONET_CTRL_VLAN:
2546 uAck = virtioNetR3CtrlVlan(pThis, &CtrlPktHdr, pVirtqBuf);
2547 break;
2548 case VIRTIONET_CTRL_MQ:
2549 uAck = virtioNetR3CtrlMultiQueue(pThis, pThisCC, pDevIns, &CtrlPktHdr, pVirtqBuf);
2550 break;
2551 case VIRTIONET_CTRL_ANNOUNCE:
2552 uAck = VIRTIONET_OK;
2553 if (FEATURE_DISABLED(STATUS) || FEATURE_DISABLED(GUEST_ANNOUNCE))
2554 {
2555 LogFunc(("%s Ignoring CTRL class VIRTIONET_CTRL_ANNOUNCE.\n"
2556 "VIRTIO_F_STATUS or VIRTIO_F_GUEST_ANNOUNCE feature not enabled\n", pThis->szInst));
2557 break;
2558 }
2559 if (CtrlPktHdr.uCmd != VIRTIONET_CTRL_ANNOUNCE_ACK)
2560 {
2561 LogFunc(("[%s] Ignoring CTRL class VIRTIONET_CTRL_ANNOUNCE. Unrecognized uCmd\n", pThis->szInst));
2562 break;
2563 }
2564#if FEATURE_OFFERED(STATUS)
2565 pThis->virtioNetConfig.uStatus &= ~VIRTIONET_F_ANNOUNCE;
2566#endif
2567 Log7Func(("[%s] Clearing VIRTIONET_F_ANNOUNCE in config status\n", pThis->szInst));
2568 break;
2569 default:
2570 LogRelFunc(("Unrecognized CTRL pkt hdr class (%d)\n", CtrlPktHdr.uClass));
2571 uAck = VIRTIONET_ERROR;
2572 }
2573
2574 /* Return CTRL packet Ack byte (result code) to guest driver */
2575 RTSGSEG aStaticSegs[] = { { &uAck, sizeof(uAck) } };
2576 RTSGBUF SgBuf;
2577
2578 RTSgBufInit(&SgBuf, aStaticSegs, RT_ELEMENTS(aStaticSegs));
2579 virtioCoreR3VirtqUsedBufPut(pDevIns, &pThis->Virtio, CTRLQIDX, &SgBuf, pVirtqBuf, true /* fFence */);
2580 virtioCoreVirtqUsedRingSync(pDevIns, &pThis->Virtio, CTRLQIDX);
2581
2582 LogFunc(("%s Finished processing CTRL command with status %s\n",
2583 pThis->szInst, uAck == VIRTIONET_OK ? "VIRTIONET_OK" : "VIRTIONET_ERROR"));
2584}
2585
2586/**
2587 * Reads virtio-net pkt header from provided Phy. addr of virtio descriptor chain
2588 * (e.g. S/G segment from guest-driver provided buffer pulled from Tx virtq)
2589 * Verifies state and supported modes, sets TCP header size.
2590 *
2591 * @param pVirtio VirtIO core instance data
2592 * @param pThis virtio-net instance
2593 * @param pDevIns PDM device instance
2594 * @param GCPhys Phys. Address from where to read virtio-net pkt header
2595 * @param pPktHdr Where to store read Tx pkt hdr (virtio pkt hdr size is determined from instance configuration)
2596 * @param cbFrame Total pkt frame size to inform bounds check
2597 */
2598static int virtioNetR3ReadVirtioTxPktHdr(PVIRTIOCORE pVirtio, PVIRTIONET pThis, PPDMDEVINS pDevIns, RTGCPHYS GCPhys, PVIRTIONETPKTHDR pPktHdr, size_t cbFrame)
2599{
2600 int rc = virtioCoreGCPhysRead(pVirtio, pDevIns, GCPhys, pPktHdr, pThis->cbPktHdr);
2601 if (RT_FAILURE(rc))
2602 return rc;
2603
2604 LogFunc(("pktHdr (flags=%x gso-type=%x len=%x gso-size=%x Chksum-start=%x Chksum-offset=%x) cbFrame=%d\n",
2605 pPktHdr->uFlags, pPktHdr->uGsoType, pPktHdr->uHdrLen,
2606 pPktHdr->uGsoSize, pPktHdr->uChksumStart, pPktHdr->uChksumOffset, cbFrame));
2607
2608 if (pPktHdr->uGsoType)
2609 {
2610 /* Segmentation offloading cannot be done without checksumming, and we do not support ECN */
2611 AssertMsgReturn( RT_LIKELY(pPktHdr->uFlags & VIRTIONET_HDR_F_NEEDS_CSUM)
2612 && !(RT_UNLIKELY(pPktHdr->uGsoType & VIRTIONET_HDR_GSO_ECN)),
2613 ("Unsupported ECN request in pkt header\n"), VERR_NOT_SUPPORTED);
2614
2615 uint32_t uTcpHdrSize;
2616 switch (pPktHdr->uGsoType)
2617 {
2618 case VIRTIONET_HDR_GSO_TCPV4:
2619 case VIRTIONET_HDR_GSO_TCPV6:
2620 uTcpHdrSize = sizeof(RTNETTCP);
2621 break;
2622 case VIRTIONET_HDR_GSO_UDP:
2623 uTcpHdrSize = 0;
2624 break;
2625 default:
2626 LogFunc(("Bad GSO type in packet header\n"));
2627 return VERR_INVALID_PARAMETER;
2628 }
2629 /* Header + MSS must not exceed the packet size. */
2630 AssertMsgReturn(RT_LIKELY(uTcpHdrSize + pPktHdr->uChksumStart + pPktHdr->uGsoSize <= cbFrame),
2631 ("Header plus message exceeds packet size"), VERR_BUFFER_OVERFLOW);
2632 }
2633
2634 AssertMsgReturn( !(pPktHdr->uFlags & VIRTIONET_HDR_F_NEEDS_CSUM)
2635 || sizeof(uint16_t) + pPktHdr->uChksumStart + pPktHdr->uChksumOffset <= cbFrame,
2636 ("Checksum (%d bytes) doesn't fit into pkt header (%d bytes)\n",
2637 sizeof(uint16_t) + pPktHdr->uChksumStart + pPktHdr->uChksumOffset, cbFrame),
2638 VERR_BUFFER_OVERFLOW);
2639
2640 return VINF_SUCCESS;
2641}
2642
2643/**
2644 * Transmits single GSO frame via PDM framework to downstream PDM device, to emit from virtual NIC.
2645 *
2646 * This does final prep of GSO parameters including checksum calculation if configured
2647 * (e.g. if VIRTIONET_HDR_F_NEEDS_CSUM flag is set).
2648 *
2649 * @param pThis virtio-net instance
2650 * @param pThisCC virtio-net instance
2651 * @param pSgBuf PDM S/G buffer containing pkt and hdr to transmit
2652 * @param pGso GSO parameters used for the packet
2653 * @param pPktHdr virtio-net pkt header to adapt to PDM semantics
2654 */
2655static int virtioNetR3TransmitFrame(PVIRTIONET pThis, PVIRTIONETCC pThisCC, PPDMSCATTERGATHER pSgBuf,
2656 PPDMNETWORKGSO pGso, PVIRTIONETPKTHDR pPktHdr)
2657{
2658
2659 virtioNetR3PacketDump(pThis, (uint8_t *)pSgBuf->aSegs[0].pvSeg, pSgBuf->cbUsed, "--> Outgoing");
2660 if (pGso)
2661 {
2662 /* Some guests (RHEL) may report HdrLen excluding transport layer header!
2663 * Thus cannot use cdHdrs provided by the guest because of different ways
2664 * it gets filled out by different versions of kernels. */
2665 Log4Func(("%s HdrLen before adjustment %d.\n", pThis->szInst, pGso->cbHdrsTotal));
2666 switch (pGso->u8Type)
2667 {
2668 case PDMNETWORKGSOTYPE_IPV4_TCP:
2669 case PDMNETWORKGSOTYPE_IPV6_TCP:
2670 pGso->cbHdrsTotal = pPktHdr->uChksumStart +
2671 ((PRTNETTCP)(((uint8_t*)pSgBuf->aSegs[0].pvSeg) + pPktHdr->uChksumStart))->th_off * 4;
2672 AssertMsgReturn(pSgBuf->cbUsed > pGso->cbHdrsTotal,
2673 ("cbHdrsTotal exceeds size of frame"), VERR_BUFFER_OVERFLOW);
2674 pGso->cbHdrsSeg = pGso->cbHdrsTotal;
2675 break;
2676 case PDMNETWORKGSOTYPE_IPV4_UDP:
2677 pGso->cbHdrsTotal = (uint8_t)(pPktHdr->uChksumStart + sizeof(RTNETUDP));
2678 pGso->cbHdrsSeg = pPktHdr->uChksumStart;
2679 break;
2680 case PDMNETWORKGSOTYPE_INVALID:
2681 LogFunc(("%s ignoring invalid GSO frame\n", pThis->szInst));
2682 return VERR_INVALID_PARAMETER;
2683 }
2684 /* Update GSO structure embedded into the frame */
2685 ((PPDMNETWORKGSO)pSgBuf->pvUser)->cbHdrsTotal = pGso->cbHdrsTotal;
2686 ((PPDMNETWORKGSO)pSgBuf->pvUser)->cbHdrsSeg = pGso->cbHdrsSeg;
2687 Log4Func(("%s adjusted HdrLen to %d.\n",
2688 pThis->szInst, pGso->cbHdrsTotal));
2689 Log2Func(("%s gso type=%x cbHdrsTotal=%u cbHdrsSeg=%u mss=%u off1=0x%x off2=0x%x\n",
2690 pThis->szInst, pGso->u8Type, pGso->cbHdrsTotal, pGso->cbHdrsSeg,
2691 pGso->cbMaxSeg, pGso->offHdr1, pGso->offHdr2));
2692 STAM_REL_COUNTER_INC(&pThis->StatTransmitGSO);
2693 }
2694 else if (pPktHdr->uFlags & VIRTIONET_HDR_F_NEEDS_CSUM)
2695 {
2696 STAM_REL_COUNTER_INC(&pThis->StatTransmitCSum);
2697 /*
2698 * This is not GSO frame but checksum offloading is requested.
2699 */
2700 virtioNetR3Calc16BitChecksum((uint8_t*)pSgBuf->aSegs[0].pvSeg, pSgBuf->cbUsed,
2701 pPktHdr->uChksumStart, pPktHdr->uChksumOffset);
2702 }
2703
2704 return pThisCC->pDrv->pfnSendBuf(pThisCC->pDrv, pSgBuf, true /* fOnWorkerThread */);
2705}
2706
2707/**
2708 * Non-reentrant function transmits all available packets from specified Tx virtq to downstream
2709 * PDM device (if cable is connected). For each Tx pkt, virtio-net pkt header is converted
2710 * to required GSO information (VBox host network stack semantics)
2711 *
2712 * @param pDevIns PDM device instance
2713 * @param pThis virtio-net device instance
2714 * @param pThisCC virtio-net device instance
2715 * @param pTxVirtq Address of transmit virtq
2716 * @param fOnWorkerThread Flag to PDM whether to use caller's or or PDM transmit worker's thread.
2717 */
2718static int virtioNetR3TransmitPkts(PPDMDEVINS pDevIns, PVIRTIONET pThis, PVIRTIONETCC pThisCC,
2719 PVIRTIONETVIRTQ pTxVirtq, bool fOnWorkerThread)
2720{
2721 PVIRTIOCORE pVirtio = &pThis->Virtio;
2722
2723
2724 if (!pThis->fVirtioReady)
2725 {
2726 LogFunc(("%s Ignoring Tx requests. VirtIO not ready (status=0x%x)\n",
2727 pThis->szInst, pThis->virtioNetConfig.uStatus));
2728 return VERR_IGNORED;
2729 }
2730
2731 if (!pThis->fCableConnected)
2732 {
2733 Log(("[%s] Ignoring transmit requests while cable is disconnected.\n", pThis->szInst));
2734 return VERR_IGNORED;
2735 }
2736
2737 /*
2738 * Only one thread is allowed to transmit at a time, others should skip transmission as the packets
2739 * will be picked up by the transmitting thread.
2740 */
2741 if (!ASMAtomicCmpXchgU32(&pThis->uIsTransmitting, 1, 0))
2742 return VERR_IGNORED;
2743
2744 PPDMINETWORKUP pDrv = pThisCC->pDrv;
2745 if (pDrv)
2746 {
2747 int rc = pDrv->pfnBeginXmit(pDrv, fOnWorkerThread);
2748 Assert(rc == VINF_SUCCESS || rc == VERR_TRY_AGAIN);
2749 if (rc == VERR_TRY_AGAIN)
2750 {
2751 ASMAtomicWriteU32(&pThis->uIsTransmitting, 0);
2752 return VERR_TRY_AGAIN;
2753 }
2754 }
2755 int cPkts = virtioCoreVirtqAvailBufCount(pVirtio->pDevInsR3, pVirtio, pTxVirtq->uIdx);
2756 if (!cPkts)
2757 {
2758 LogFunc(("[%s] No packets to send found on %s\n", pThis->szInst, pTxVirtq->szName));
2759
2760 if (pDrv)
2761 pDrv->pfnEndXmit(pDrv);
2762
2763 ASMAtomicWriteU32(&pThis->uIsTransmitting, 0);
2764 return VERR_MISSING;
2765 }
2766 LogFunc(("[%s] About to transmit %d pending packet%c\n", pThis->szInst, cPkts, cPkts == 1 ? ' ' : 's'));
2767
2768 virtioNetR3SetWriteLed(pThisCC, true);
2769
2770 /* Disable notifications until all available descriptors have been processed */
2771 if (!(pVirtio->uDriverFeatures & VIRTIO_F_EVENT_IDX))
2772 virtioCoreVirtqEnableNotify(&pThis->Virtio, pTxVirtq->uIdx, false /* fEnable */);
2773
2774 int rc;
2775#ifdef VIRTIO_VBUF_ON_STACK
2776 VIRTQBUF_T VirtqBuf;
2777
2778 VirtqBuf.u32Magic = VIRTQBUF_MAGIC;
2779 VirtqBuf.cRefs = 1;
2780
2781 PVIRTQBUF pVirtqBuf = &VirtqBuf;
2782 while ((rc = virtioCoreR3VirtqAvailBufPeek(pVirtio->pDevInsR3, pVirtio, pTxVirtq->uIdx, pVirtqBuf)) == VINF_SUCCESS)
2783#else /* !VIRTIO_VBUF_ON_STACK */
2784 PVIRTQBUF pVirtqBuf = NULL;
2785 while ((rc = virtioCoreR3VirtqAvailBufPeek(pVirtio->pDevInsR3, pVirtio, pTxVirtq->uIdx, &pVirtqBuf)) == VINF_SUCCESS)
2786#endif /* !VIRTIO_VBUF_ON_STACK */
2787 {
2788 Log10Func(("[%s] fetched descriptor chain from %s\n", pThis->szInst, pTxVirtq->szName));
2789
2790 PVIRTIOSGBUF pSgPhysSend = pVirtqBuf->pSgPhysSend;
2791 PVIRTIOSGSEG paSegsFromGuest = pSgPhysSend->paSegs;
2792 uint32_t cSegsFromGuest = pSgPhysSend->cSegs;
2793 size_t uFrameSize = 0;
2794
2795 AssertMsgReturn(paSegsFromGuest[0].cbSeg >= pThis->cbPktHdr,
2796 ("Desc chain's first seg has insufficient space for pkt header!\n"),
2797 VERR_INTERNAL_ERROR);
2798
2799#ifdef VIRTIO_VBUF_ON_STACK
2800 VIRTIONETPKTHDR PktHdr;
2801 PVIRTIONETPKTHDR pPktHdr = &PktHdr;
2802#else /* !VIRTIO_VBUF_ON_STACK */
2803 PVIRTIONETPKTHDR pPktHdr = (PVIRTIONETPKTHDR)RTMemAllocZ(pThis->cbPktHdr);
2804 AssertMsgReturn(pPktHdr, ("Out of Memory\n"), VERR_NO_MEMORY);
2805#endif /* !VIRTIO_VBUF_ON_STACK */
2806
2807 /* Compute total frame size from guest (including virtio-net pkt hdr) */
2808 for (unsigned i = 0; i < cSegsFromGuest && uFrameSize < VIRTIONET_MAX_FRAME_SIZE; i++)
2809 uFrameSize += paSegsFromGuest[i].cbSeg;
2810
2811 Log5Func(("[%s] complete frame is %u bytes.\n", pThis->szInst, uFrameSize));
2812 Assert(uFrameSize <= VIRTIONET_MAX_FRAME_SIZE);
2813
2814 /* Truncate oversized frames. */
2815 if (uFrameSize > VIRTIONET_MAX_FRAME_SIZE)
2816 uFrameSize = VIRTIONET_MAX_FRAME_SIZE;
2817
2818 if (pThisCC->pDrv)
2819 {
2820 uFrameSize -= pThis->cbPktHdr;
2821 /*
2822 * Peel off pkt header and convert to PDM/GSO semantics.
2823 */
2824 rc = virtioNetR3ReadVirtioTxPktHdr(pVirtio, pThis, pDevIns, paSegsFromGuest[0].GCPhys, pPktHdr, uFrameSize /* cbFrame */);
2825 if (RT_FAILURE(rc))
2826 return rc;
2827 virtioCoreGCPhysChainAdvance(pSgPhysSend, pThis->cbPktHdr);
2828
2829 PDMNETWORKGSO Gso, *pGso = virtioNetR3SetupGsoCtx(&Gso, pPktHdr);
2830
2831 /* Allocate PDM transmit buffer to send guest provided network frame from to VBox network leaf device */
2832 PPDMSCATTERGATHER pSgBufToPdmLeafDevice;
2833 rc = pThisCC->pDrv->pfnAllocBuf(pThisCC->pDrv, uFrameSize, pGso, &pSgBufToPdmLeafDevice);
2834
2835 /*
2836 * Copy virtio-net guest S/G buffer to PDM leaf driver S/G buffer
2837 * converting from GCphys to virt memory at the same time
2838 */
2839 if (RT_SUCCESS(rc))
2840 {
2841 STAM_REL_COUNTER_INC(&pThis->StatTransmitPackets);
2842 STAM_PROFILE_START(&pThis->StatTransmitSend, a);
2843
2844 size_t cbCopied = 0;
2845 size_t cbRemain = pSgBufToPdmLeafDevice->cbUsed = uFrameSize;
2846 uint64_t uOffset = 0;
2847 while (cbRemain)
2848 {
2849 PVIRTIOSGSEG paSeg = &pSgPhysSend->paSegs[pSgPhysSend->idxSeg];
2850 uint64_t srcSgStart = (uint64_t)paSeg->GCPhys;
2851 uint64_t srcSgLen = (uint64_t)paSeg->cbSeg;
2852 uint64_t srcSgCur = (uint64_t)pSgPhysSend->GCPhysCur;
2853 cbCopied = RT_MIN((uint64_t)cbRemain, srcSgLen - (srcSgCur - srcSgStart));
2854 virtioCoreGCPhysRead(pVirtio, pDevIns,
2855 (RTGCPHYS)pSgPhysSend->GCPhysCur,
2856 ((uint8_t *)pSgBufToPdmLeafDevice->aSegs[0].pvSeg) + uOffset, cbCopied);
2857 virtioCoreGCPhysChainAdvance(pSgPhysSend, cbCopied);
2858 cbRemain -= cbCopied;
2859 uOffset += cbCopied;
2860 }
2861
2862 LogFunc((".... Copied %lu/%lu bytes to %lu byte guest buffer. Buf residual=%lu\n",
2863 uOffset, uFrameSize, pVirtqBuf->cbPhysSend, virtioCoreGCPhysChainCalcLengthLeft(pSgPhysSend)));
2864
2865 rc = virtioNetR3TransmitFrame(pThis, pThisCC, pSgBufToPdmLeafDevice, pGso, pPktHdr);
2866 if (RT_FAILURE(rc))
2867 {
2868 LogFunc(("[%s] Failed to transmit frame, rc = %Rrc\n", pThis->szInst, rc));
2869 STAM_PROFILE_STOP(&pThis->StatTransmitSend, a);
2870 STAM_PROFILE_ADV_STOP(&pThis->StatTransmit, a);
2871 pThisCC->pDrv->pfnFreeBuf(pThisCC->pDrv, pSgBufToPdmLeafDevice);
2872 }
2873 STAM_PROFILE_STOP(&pThis->StatTransmitSend, a);
2874 STAM_REL_COUNTER_ADD(&pThis->StatTransmitBytes, uOffset);
2875 }
2876 else
2877 {
2878 Log4Func(("Failed to allocate S/G buffer: frame size=%u rc=%Rrc\n", uFrameSize, rc));
2879 /* Stop trying to fetch TX descriptors until we get more bandwidth. */
2880#ifndef VIRTIO_VBUF_ON_STACK
2881 virtioCoreR3VirtqBufRelease(pVirtio, pVirtqBuf);
2882#endif /* !VIRTIO_VBUF_ON_STACK */
2883 break;
2884 }
2885
2886 virtioCoreR3VirtqAvailBufNext(pVirtio, pTxVirtq->uIdx);
2887
2888 /* No data to return to guest, but necessary to put elem (e.g. desc chain head idx) on used ring */
2889 virtioCoreR3VirtqUsedBufPut(pVirtio->pDevInsR3, pVirtio, pTxVirtq->uIdx, NULL, pVirtqBuf, true /* fFence */);
2890 virtioCoreVirtqUsedRingSync(pVirtio->pDevInsR3, pVirtio, pTxVirtq->uIdx);
2891 }
2892
2893#ifndef VIRTIO_VBUF_ON_STACK
2894 virtioCoreR3VirtqBufRelease(pVirtio, pVirtqBuf);
2895 pVirtqBuf = NULL;
2896#endif /* !VIRTIO_VBUF_ON_STACK */
2897 /* Before we break the loop we need to check if the queue is empty,
2898 * re-enable notifications, and then re-check again to avoid missing
2899 * a notification for the descriptor that is added to the queue
2900 * after we have checked it on being empty, but before we re-enabled
2901 * notifications.
2902 */
2903 if (!(pVirtio->uDriverFeatures & VIRTIO_F_EVENT_IDX)
2904 && IS_VIRTQ_EMPTY(pDevIns, &pThis->Virtio, pTxVirtq->uIdx))
2905 virtioCoreVirtqEnableNotify(&pThis->Virtio, pTxVirtq->uIdx, true /* fEnable */);
2906 }
2907 virtioNetR3SetWriteLed(pThisCC, false);
2908
2909 if (pDrv)
2910 pDrv->pfnEndXmit(pDrv);
2911
2912 ASMAtomicWriteU32(&pThis->uIsTransmitting, 0);
2913 return VINF_SUCCESS;
2914}
2915
2916/**
2917 * @interface_method_impl{PDMINETWORKDOWN,pfnXmitPending}
2918 */
2919static DECLCALLBACK(void) virtioNetR3NetworkDown_XmitPending(PPDMINETWORKDOWN pInterface)
2920{
2921 LogFunc(("\n"));
2922 PVIRTIONETCC pThisCC = RT_FROM_MEMBER(pInterface, VIRTIONETCC, INetworkDown);
2923 PPDMDEVINS pDevIns = pThisCC->pDevIns;
2924 PVIRTIONET pThis = PDMDEVINS_2_DATA(pThisCC->pDevIns, PVIRTIONET);
2925 PVIRTIONETVIRTQ pTxVirtq = &pThis->aVirtqs[TXQIDX(0)];
2926 STAM_COUNTER_INC(&pThis->StatTransmitByNetwork);
2927
2928 (void)virtioNetR3TransmitPkts(pDevIns, pThis, pThisCC, pTxVirtq, true /*fOnWorkerThread*/);
2929}
2930
2931/**
2932 * @callback_method_impl{FNTMTIMERDEV, Link Up Timer handler.}
2933 */
2934static DECLCALLBACK(void) virtioNetR3LinkUpTimer(PPDMDEVINS pDevIns, TMTIMERHANDLE hTimer, void *pvUser)
2935{
2936 PVIRTIONET pThis = PDMDEVINS_2_DATA(pDevIns, PVIRTIONET);
2937 PVIRTIONETCC pThisCC = PDMDEVINS_2_DATA_CC(pDevIns, PVIRTIONETCC);
2938
2939 SET_LINK_UP(pThis);
2940 virtioNetWakeupRxBufWaiter(pDevIns);
2941
2942 if (pThisCC->pDrv)
2943 pThisCC->pDrv->pfnNotifyLinkChanged(pThisCC->pDrv, PDMNETWORKLINKSTATE_UP);
2944
2945 LogFunc(("[%s] Link is up\n", pThis->szInst));
2946 RT_NOREF(hTimer, pvUser);
2947}
2948
2949/**
2950 * @interface_method_impl{PDMINETWORKCONFIG,pfnSetLinkState}
2951 */
2952static DECLCALLBACK(int) virtioNetR3NetworkConfig_SetLinkState(PPDMINETWORKCONFIG pInterface, PDMNETWORKLINKSTATE enmState)
2953{
2954 PVIRTIONETCC pThisCC = RT_FROM_MEMBER(pInterface, VIRTIONETCC, INetworkConfig);
2955 PPDMDEVINS pDevIns = pThisCC->pDevIns;
2956 PVIRTIONET pThis = PDMDEVINS_2_DATA(pDevIns, PVIRTIONET);
2957
2958 bool fRequestedLinkStateIsUp = (enmState == PDMNETWORKLINKSTATE_UP);
2959
2960#ifdef LOG_ENABLED
2961 if (LogIs7Enabled())
2962 {
2963 LogFunc(("[%s]", pThis->szInst));
2964 switch(enmState)
2965 {
2966 case PDMNETWORKLINKSTATE_UP:
2967 Log(("UP\n"));
2968 break;
2969 case PDMNETWORKLINKSTATE_DOWN:
2970 Log(("DOWN\n"));
2971 break;
2972 case PDMNETWORKLINKSTATE_DOWN_RESUME:
2973 Log(("DOWN (RESUME)\n"));
2974 break;
2975 default:
2976 Log(("UNKNOWN)\n"));
2977 }
2978 }
2979#endif
2980
2981 if (enmState == PDMNETWORKLINKSTATE_DOWN_RESUME)
2982 {
2983 if (IS_LINK_UP(pThis))
2984 {
2985 /*
2986 * We bother to bring the link down only if it was up previously. The UP link state
2987 * notification will be sent when the link actually goes up in virtioNetR3LinkUpTimer().
2988 */
2989 virtioNetR3TempLinkDown(pDevIns, pThis, pThisCC);
2990 if (pThisCC->pDrv)
2991 pThisCC->pDrv->pfnNotifyLinkChanged(pThisCC->pDrv, enmState);
2992 }
2993 }
2994 else if (fRequestedLinkStateIsUp != IS_LINK_UP(pThis))
2995 {
2996 if (fRequestedLinkStateIsUp)
2997 {
2998 Log(("[%s] Link is up\n", pThis->szInst));
2999 pThis->fCableConnected = true;
3000 SET_LINK_UP(pThis);
3001 }
3002 else /* Link requested to be brought down */
3003 {
3004 /* The link was brought down explicitly, make sure it won't come up by timer. */
3005 PDMDevHlpTimerStop(pDevIns, pThisCC->hLinkUpTimer);
3006 Log(("[%s] Link is down\n", pThis->szInst));
3007 pThis->fCableConnected = false;
3008 SET_LINK_DOWN(pThis);
3009 }
3010 if (pThisCC->pDrv)
3011 pThisCC->pDrv->pfnNotifyLinkChanged(pThisCC->pDrv, enmState);
3012 }
3013 return VINF_SUCCESS;
3014}
3015/**
3016 * @interface_method_impl{PDMINETWORKCONFIG,pfnGetLinkState}
3017 */
3018static DECLCALLBACK(PDMNETWORKLINKSTATE) virtioNetR3NetworkConfig_GetLinkState(PPDMINETWORKCONFIG pInterface)
3019{
3020 PVIRTIONETCC pThisCC = RT_FROM_MEMBER(pInterface, VIRTIONETCC, INetworkConfig);
3021 PVIRTIONET pThis = PDMDEVINS_2_DATA(pThisCC->pDevIns, PVIRTIONET);
3022
3023 return IS_LINK_UP(pThis) ? PDMNETWORKLINKSTATE_UP : PDMNETWORKLINKSTATE_DOWN;
3024}
3025
3026static int virtioNetR3DestroyWorkerThreads(PPDMDEVINS pDevIns, PVIRTIONET pThis, PVIRTIONETCC pThisCC)
3027{
3028 Log10Func(("[%s]\n", pThis->szInst));
3029 int rc = VINF_SUCCESS;
3030 for (unsigned uIdxWorker = 0; uIdxWorker < pThis->cWorkers; uIdxWorker++)
3031 {
3032 PVIRTIONETWORKER pWorker = &pThis->aWorkers[uIdxWorker];
3033 PVIRTIONETWORKERR3 pWorkerR3 = &pThisCC->aWorkers[uIdxWorker];
3034
3035 if (pWorker->hEvtProcess != NIL_SUPSEMEVENT)
3036 {
3037 PDMDevHlpSUPSemEventClose(pDevIns, pWorker->hEvtProcess);
3038 pWorker->hEvtProcess = NIL_SUPSEMEVENT;
3039 }
3040 if (pWorkerR3->pThread)
3041 {
3042 int rcThread;
3043 rc = PDMDevHlpThreadDestroy(pDevIns, pWorkerR3->pThread, &rcThread);
3044 if (RT_FAILURE(rc) || RT_FAILURE(rcThread))
3045 AssertMsgFailed(("%s Failed to destroythread rc=%Rrc rcThread=%Rrc\n", __FUNCTION__, rc, rcThread));
3046 pWorkerR3->pThread = NULL;
3047 }
3048 }
3049 return rc;
3050}
3051
3052/**
3053 * Creates a worker for specified queue, along with semaphore to throttle the worker.
3054 *
3055 * @param pDevIns - PDM device instance
3056 * @param pThis - virtio-net instance
3057 * @param pWorker - Pointer to worker state
3058 * @param pWorkerR3 - Pointer to worker state
3059 * @param pVirtq - Pointer to virtq
3060 */
3061static int virtioNetR3CreateOneWorkerThread(PPDMDEVINS pDevIns, PVIRTIONET pThis,
3062 PVIRTIONETWORKER pWorker, PVIRTIONETWORKERR3 pWorkerR3,
3063 PVIRTIONETVIRTQ pVirtq)
3064{
3065 Log10Func(("[%s]\n", pThis->szInst));
3066 RT_NOREF(pThis);
3067
3068 int rc = PDMDevHlpSUPSemEventCreate(pDevIns, &pWorker->hEvtProcess);
3069
3070 if (RT_FAILURE(rc))
3071 return PDMDevHlpVMSetError(pDevIns, rc, RT_SRC_POS,
3072 N_("DevVirtioNET: Failed to create SUP event semaphore"));
3073
3074 LogFunc(("creating thread for queue %s\n", pVirtq->szName));
3075
3076 rc = PDMDevHlpThreadCreate(pDevIns, &pWorkerR3->pThread,
3077 (void *)pWorker, virtioNetR3WorkerThread,
3078 virtioNetR3WakeupWorker, 0, RTTHREADTYPE_IO, pVirtq->szName);
3079 if (RT_FAILURE(rc))
3080 return PDMDevHlpVMSetError(pDevIns, rc, RT_SRC_POS,
3081 N_("Error creating thread for Virtual Virtq %s\n"), pVirtq->uIdx);
3082
3083 pWorker->fAssigned = true; /* Because worker's state in fixed-size array initialized w/empty slots */
3084
3085 LogFunc(("%s pThread: %p\n", pVirtq->szName, pWorkerR3->pThread));
3086
3087 return rc;
3088}
3089
3090static int virtioNetR3CreateWorkerThreads(PPDMDEVINS pDevIns, PVIRTIONET pThis, PVIRTIONETCC pThisCC)
3091{
3092 Log10Func(("[%s]\n", pThis->szInst));
3093 int rc;
3094
3095 /* Create the Control Queue worker anyway whether or not it is feature-negotiated or utilized by the guest.
3096 * See related comment for queue construction in the device constructor function for more context.
3097 */
3098
3099 PVIRTIONETVIRTQ pCtlVirtq = &pThis->aVirtqs[CTRLQIDX];
3100 rc = virtioNetR3CreateOneWorkerThread(pDevIns, pThis,
3101 &pThis->aWorkers[CTRLQIDX], &pThisCC->aWorkers[CTRLQIDX], pCtlVirtq);
3102 AssertRCReturn(rc, rc);
3103
3104 pCtlVirtq->fHasWorker = true;
3105
3106 for (uint16_t uVirtqPair = pThis->cInitializedVirtqPairs; uVirtqPair < pThis->cVirtqPairs; uVirtqPair++)
3107 {
3108 PVIRTIONETVIRTQ pTxVirtq = &pThis->aVirtqs[TXQIDX(uVirtqPair)];
3109 PVIRTIONETVIRTQ pRxVirtq = &pThis->aVirtqs[RXQIDX(uVirtqPair)];
3110
3111 rc = virtioNetR3CreateOneWorkerThread(pDevIns, pThis, &pThis->aWorkers[TXQIDX(uVirtqPair)],
3112 &pThisCC->aWorkers[TXQIDX(uVirtqPair)], pTxVirtq);
3113 AssertRCReturn(rc, rc);
3114
3115 pTxVirtq->fHasWorker = true;
3116 pRxVirtq->fHasWorker = false;
3117 }
3118
3119 if (pThis->cVirtqPairs > pThis->cInitializedVirtqPairs)
3120 pThis->cInitializedVirtqPairs = pThis->cVirtqPairs;
3121
3122 pThis->cWorkers = pThis->cVirtqPairs + 1 /* One control virtq */;
3123
3124 return rc;
3125}
3126
3127
3128/**
3129 * @callback_method_impl{FNPDMTHREADDEV}
3130 */
3131static DECLCALLBACK(int) virtioNetR3WorkerThread(PPDMDEVINS pDevIns, PPDMTHREAD pThread)
3132{
3133 PVIRTIONET pThis = PDMDEVINS_2_DATA(pDevIns, PVIRTIONET);
3134 PVIRTIONETCC pThisCC = PDMDEVINS_2_DATA_CC(pDevIns, PVIRTIONETCC);
3135 PVIRTIONETWORKER pWorker = (PVIRTIONETWORKER)pThread->pvUser;
3136 PVIRTIONETVIRTQ pVirtq = &pThis->aVirtqs[pWorker->uIdx];
3137 uint16_t uIdx = pWorker->uIdx;
3138
3139 ASMAtomicWriteBool(&pWorker->fSleeping, false);
3140
3141 Assert(pWorker->uIdx == pVirtq->uIdx);
3142
3143 if (pThread->enmState == PDMTHREADSTATE_INITIALIZING)
3144 return VINF_SUCCESS;
3145
3146 LogFunc(("[%s] worker thread idx=%d started for %s (virtq idx=%d)\n", pThis->szInst, pWorker->uIdx, pVirtq->szName, pVirtq->uIdx));
3147
3148 /** @todo Race w/guest enabling/disabling guest notifications cyclically.
3149 See BugRef #8651, Comment #82 */
3150 virtioCoreVirtqEnableNotify(&pThis->Virtio, uIdx, true /* fEnable */);
3151
3152 while ( pThread->enmState != PDMTHREADSTATE_TERMINATING
3153 && pThread->enmState != PDMTHREADSTATE_TERMINATED)
3154 {
3155 if (IS_VIRTQ_EMPTY(pDevIns, &pThis->Virtio, pVirtq->uIdx))
3156 {
3157 /* Precisely coordinated atomic interlocks avoid a race condition that results in hung thread
3158 * wherein a sloppily coordinated wake-up notification during a transition into or out
3159 * of sleep leaves notifier and target mutually confused about actual & intended state.
3160 */
3161 ASMAtomicWriteBool(&pWorker->fSleeping, true);
3162 bool fNotificationSent = ASMAtomicXchgBool(&pWorker->fNotified, false);
3163 if (!fNotificationSent)
3164 {
3165 Log10Func(("[%s] %s worker sleeping...\n\n", pThis->szInst, pVirtq->szName));
3166 Assert(ASMAtomicReadBool(&pWorker->fSleeping));
3167
3168 int rc = PDMDevHlpSUPSemEventWaitNoResume(pDevIns, pWorker->hEvtProcess, RT_INDEFINITE_WAIT);
3169 STAM_COUNTER_INC(&pThis->StatTransmitByThread);
3170 AssertLogRelMsgReturn(RT_SUCCESS(rc) || rc == VERR_INTERRUPTED, ("%Rrc\n", rc), rc);
3171 if (RT_UNLIKELY(pThread->enmState != PDMTHREADSTATE_RUNNING))
3172 return VINF_SUCCESS;
3173 if (rc == VERR_INTERRUPTED)
3174 continue;
3175 ASMAtomicWriteBool(&pWorker->fNotified, false);
3176 }
3177 ASMAtomicWriteBool(&pWorker->fSleeping, false);
3178 }
3179 /*
3180 * Dispatch to the handler for the queue this worker is set up to drive
3181 */
3182 if (pVirtq->fCtlVirtq)
3183 {
3184 Log10Func(("[%s] %s worker woken. Fetching desc chain\n", pThis->szInst, pVirtq->szName));
3185#ifdef VIRTIO_VBUF_ON_STACK
3186 VIRTQBUF_T VirtqBuf;
3187 PVIRTQBUF pVirtqBuf = &VirtqBuf;
3188 int rc = virtioCoreR3VirtqAvailBufGet(pDevIns, &pThis->Virtio, pVirtq->uIdx, pVirtqBuf, true);
3189#else /* !VIRTIO_VBUF_ON_STACK */
3190 PVIRTQBUF pVirtqBuf = NULL;
3191 int rc = virtioCoreR3VirtqAvailBufGet(pDevIns, &pThis->Virtio, pVirtq->uIdx, &pVirtqBuf, true);
3192#endif /* !VIRTIO_VBUF_ON_STACK */
3193 if (rc == VERR_NOT_AVAILABLE)
3194 {
3195 Log10Func(("[%s] %s worker woken. Nothing found in queue\n", pThis->szInst, pVirtq->szName));
3196 continue;
3197 }
3198 virtioNetR3Ctrl(pDevIns, pThis, pThisCC, pVirtqBuf);
3199#ifndef VIRTIO_VBUF_ON_STACK
3200 virtioCoreR3VirtqBufRelease(&pThis->Virtio, pVirtqBuf);
3201#endif /* !VIRTIO_VBUF_ON_STACK */
3202 }
3203 else /* Must be Tx queue */
3204 {
3205 Log10Func(("[%s] %s worker woken. Virtq has data to transmit\n", pThis->szInst, pVirtq->szName));
3206 virtioNetR3TransmitPkts(pDevIns, pThis, pThisCC, pVirtq, false /* fOnWorkerThread */);
3207 }
3208 /* Note: Surprise! Rx queues aren't handled by local worker threads. Instead, the PDM network leaf driver
3209 * invokes PDMINETWORKDOWN.pfnWaitReceiveAvail() callback, which waits until woken by virtioNetVirtqNotified()
3210 * indicating that guest IN buffers have been added to Rx virt queue.
3211 */
3212 }
3213 Log10(("[%s] %s worker thread exiting\n", pThis->szInst, pVirtq->szName));
3214 return VINF_SUCCESS;
3215}
3216
3217/**
3218 * @callback_method_impl{VIRTIOCORER3,pfnStatusChanged}
3219 *
3220 * Called back by the core code when VirtIO's ready state has changed.
3221 */
3222static DECLCALLBACK(void) virtioNetR3StatusChg(PVIRTIOCORE pVirtio, PVIRTIOCORECC pVirtioCC, uint32_t fVirtioReady)
3223{
3224 PVIRTIONET pThis = RT_FROM_MEMBER(pVirtio, VIRTIONET, Virtio);
3225 PVIRTIONETCC pThisCC = RT_FROM_MEMBER(pVirtioCC, VIRTIONETCC, Virtio);
3226
3227 pThis->fVirtioReady = fVirtioReady;
3228
3229 if (fVirtioReady)
3230 {
3231#ifdef LOG_ENABLED
3232 Log(("\n%-23s: %s *** VirtIO Ready ***\n\n", __FUNCTION__, pThis->szInst));
3233 virtioCorePrintDeviceFeatures(&pThis->Virtio, NULL, s_aDevSpecificFeatures, RT_ELEMENTS(s_aDevSpecificFeatures));
3234#endif
3235 pThis->fResetting = false;
3236 pThis->fNegotiatedFeatures = virtioCoreGetNegotiatedFeatures(pVirtio);
3237 /* Now we can properly figure out the size of virtio header! */
3238 virtioNetConfigurePktHdr(pThis, pThis->Virtio.fLegacyDriver);
3239 pThis->virtioNetConfig.uStatus = pThis->fCableConnected ? VIRTIONET_F_LINK_UP : 0;
3240
3241 for (unsigned uVirtqNbr = 0; uVirtqNbr < pThis->cVirtqs; uVirtqNbr++)
3242 {
3243 PVIRTIONETVIRTQ pVirtq = &pThis->aVirtqs[uVirtqNbr];
3244 PVIRTIONETWORKER pWorker = &pThis->aWorkers[uVirtqNbr];
3245
3246 Assert(pWorker->uIdx == uVirtqNbr);
3247 RT_NOREF(pWorker);
3248
3249 Assert(pVirtq->uIdx == pWorker->uIdx);
3250
3251 (void) virtioCoreR3VirtqAttach(&pThis->Virtio, pVirtq->uIdx, pVirtq->szName);
3252 pVirtq->fAttachedToVirtioCore = true;
3253 if (IS_VIRTQ_EMPTY(pThisCC->pDevIns, &pThis->Virtio, pVirtq->uIdx))
3254 virtioCoreVirtqEnableNotify(&pThis->Virtio, pVirtq->uIdx, true /* fEnable */);
3255 }
3256
3257 virtioNetWakeupRxBufWaiter(pThisCC->pDevIns);
3258 }
3259 else
3260 {
3261 Log(("\n%-23s: %s VirtIO is resetting ***\n", __FUNCTION__, pThis->szInst));
3262
3263 pThis->virtioNetConfig.uStatus = pThis->fCableConnected ? VIRTIONET_F_LINK_UP : 0;
3264 Log7(("%-23s: %s Link is %s\n", __FUNCTION__, pThis->szInst, pThis->fCableConnected ? "up" : "down"));
3265
3266 pThis->fPromiscuous = true;
3267 pThis->fAllMulticast = false;
3268 pThis->fAllUnicast = false;
3269 pThis->fNoMulticast = false;
3270 pThis->fNoUnicast = false;
3271 pThis->fNoBroadcast = false;
3272 pThis->uIsTransmitting = 0;
3273 pThis->cUnicastFilterMacs = 0;
3274 pThis->cMulticastFilterMacs = 0;
3275
3276 memset(pThis->aMacMulticastFilter, 0, sizeof(pThis->aMacMulticastFilter));
3277 memset(pThis->aMacUnicastFilter, 0, sizeof(pThis->aMacUnicastFilter));
3278 memset(pThis->aVlanFilter, 0, sizeof(pThis->aVlanFilter));
3279
3280 pThisCC->pDrv->pfnSetPromiscuousMode(pThisCC->pDrv, true);
3281
3282 for (uint16_t uVirtqNbr = 0; uVirtqNbr < pThis->cVirtqs; uVirtqNbr++)
3283 {
3284 virtioCoreR3VirtqDetach(&pThis->Virtio, uVirtqNbr);
3285 pThis->aVirtqs[uVirtqNbr].fAttachedToVirtioCore = false;
3286 }
3287 }
3288}
3289
3290/**
3291 * @callback_method_impl{VIRTIOCORER3,pfnFeatureNegotiationComplete}
3292 */
3293static DECLCALLBACK(void) pfnFeatureNegotiationComplete(PVIRTIOCORE pVirtio, uint64_t fDriverFeatures, uint32_t fLegacy)
3294{
3295 PVIRTIONET pThis = PDMDEVINS_2_DATA(pVirtio->pDevInsR3, PVIRTIONET);
3296
3297 LogFunc(("[Feature Negotiation Complete] Guest Driver version is: %s\n", fLegacy ? "legacy" : "modern"));
3298 virtioNetConfigurePktHdr(pThis, fLegacy);
3299 virtioNetR3SetVirtqNames(pThis, fLegacy);
3300
3301 /* Senseless for modern guest to use control queue in this case. (See Note 1 in PDM-invoked device constructor) */
3302 if (!fLegacy && !(fDriverFeatures & VIRTIONET_F_CTRL_VQ))
3303 virtioNetR3VirtqDestroy(pVirtio, &pThis->aVirtqs[CTRLQIDX]);
3304}
3305
3306#endif /* IN_RING3 */
3307
3308/**
3309 * @interface_method_impl{PDMDEVREGR3,pfnDetach}
3310 *
3311 * The VM is suspended at this point.
3312 */
3313static DECLCALLBACK(void) virtioNetR3Detach(PPDMDEVINS pDevIns, unsigned iLUN, uint32_t fFlags)
3314{
3315 RT_NOREF(fFlags);
3316
3317 PVIRTIONET pThis = PDMDEVINS_2_DATA(pDevIns, PVIRTIONET);
3318 PVIRTIONETCC pThisCC = PDMDEVINS_2_DATA_CC(pDevIns, PVIRTIONETCC);
3319
3320 Log7Func(("[%s]\n", pThis->szInst));
3321 RT_NOREF(pThis);
3322
3323 AssertLogRelReturnVoid(iLUN == 0);
3324
3325 pThisCC->pDrvBase = NULL;
3326 pThisCC->pDrv = NULL;
3327}
3328
3329/**
3330 * @interface_method_impl{PDMDEVREGR3,pfnAttach}
3331 *
3332 * This is called when we change block driver.
3333 */
3334static DECLCALLBACK(int) virtioNetR3Attach(PPDMDEVINS pDevIns, unsigned iLUN, uint32_t fFlags)
3335{
3336 PVIRTIONET pThis = PDMDEVINS_2_DATA(pDevIns, PVIRTIONET);
3337 PVIRTIONETCC pThisCC = PDMDEVINS_2_DATA_CC(pDevIns, PVIRTIONETCC);
3338
3339 Log7Func(("[%s]", pThis->szInst));
3340 AssertLogRelReturn(iLUN == 0, VERR_PDM_NO_SUCH_LUN);
3341
3342 int rc = PDMDevHlpDriverAttach(pDevIns, 0, &pThisCC->IBase, &pThisCC->pDrvBase, "Network Port");
3343 if (RT_SUCCESS(rc))
3344 {
3345 pThisCC->pDrv = PDMIBASE_QUERY_INTERFACE(pThisCC->pDrvBase, PDMINETWORKUP);
3346 AssertMsgStmt(pThisCC->pDrv, ("Failed to obtain the PDMINETWORKUP interface!\n"),
3347 rc = VERR_PDM_MISSING_INTERFACE_BELOW);
3348 }
3349 else if ( rc == VERR_PDM_NO_ATTACHED_DRIVER
3350 || rc == VERR_PDM_CFG_MISSING_DRIVER_NAME)
3351 Log(("[%s] No attached driver!\n", pThis->szInst));
3352
3353 RT_NOREF2(pThis, fFlags);
3354 return rc;
3355}
3356
3357/**
3358 * @interface_method_impl{PDMILEDPORTS,pfnQueryStatusLed}
3359 */
3360static DECLCALLBACK(int) virtioNetR3QueryStatusLed(PPDMILEDPORTS pInterface, unsigned iLUN, PPDMLED *ppLed)
3361{
3362 PVIRTIONETR3 pThisR3 = RT_FROM_MEMBER(pInterface, VIRTIONETR3, ILeds);
3363 if (iLUN)
3364 return VERR_PDM_LUN_NOT_FOUND;
3365 *ppLed = &pThisR3->led;
3366 return VINF_SUCCESS;
3367}
3368
3369/**
3370 * @interface_method_impl{PDMIBASE,pfnQueryInterface}
3371 */
3372static DECLCALLBACK(void *) virtioNetR3QueryInterface(struct PDMIBASE *pInterface, const char *pszIID)
3373{
3374 PVIRTIONETR3 pThisCC = RT_FROM_MEMBER(pInterface, VIRTIONETCC, IBase);
3375 PDMIBASE_RETURN_INTERFACE(pszIID, PDMINETWORKDOWN, &pThisCC->INetworkDown);
3376 PDMIBASE_RETURN_INTERFACE(pszIID, PDMINETWORKCONFIG, &pThisCC->INetworkConfig);
3377 PDMIBASE_RETURN_INTERFACE(pszIID, PDMIBASE, &pThisCC->IBase);
3378 PDMIBASE_RETURN_INTERFACE(pszIID, PDMILEDPORTS, &pThisCC->ILeds);
3379 return NULL;
3380}
3381
3382/**
3383 * @interface_method_impl{PDMDEVREGR3,pfnReset}
3384 */
3385static DECLCALLBACK(void) virtioNetR3Reset(PPDMDEVINS pDevIns)
3386{
3387 PVIRTIONET pThis = PDMDEVINS_2_DATA(pDevIns, PVIRTIONET);
3388 PVIRTIONETCC pThisCC = PDMDEVINS_2_DATA_CC(pDevIns, PVIRTIONETCC);
3389
3390 virtioCoreR3ResetDevice(pDevIns, &pThis->Virtio, &pThisCC->Virtio);
3391}
3392
3393/**
3394 * @interface_method_impl{PDMDEVREGR3,pfnDestruct}
3395 */
3396static DECLCALLBACK(int) virtioNetR3Destruct(PPDMDEVINS pDevIns)
3397{
3398 PDMDEV_CHECK_VERSIONS_RETURN_QUIET(pDevIns);
3399
3400 PVIRTIONET pThis = PDMDEVINS_2_DATA(pDevIns, PVIRTIONET);
3401 PVIRTIONETCC pThisCC = PDMDEVINS_2_DATA_CC(pDevIns, PVIRTIONETCC);
3402
3403 Log(("[%s] Destroying instance\n", pThis->szInst));
3404 if (pThis->hEventRxDescAvail != NIL_SUPSEMEVENT)
3405 {
3406 PDMDevHlpSUPSemEventSignal(pDevIns, pThis->hEventRxDescAvail);
3407 PDMDevHlpSUPSemEventClose(pDevIns, pThis->hEventRxDescAvail);
3408 pThis->hEventRxDescAvail = NIL_SUPSEMEVENT;
3409 }
3410
3411 virtioNetR3DestroyWorkerThreads(pDevIns, pThis, pThisCC);
3412 virtioCoreR3Term(pDevIns, &pThis->Virtio, &pThisCC->Virtio);
3413 return VINF_SUCCESS;
3414}
3415
3416/**
3417 * @interface_method_impl{PDMDEVREGR3,pfnConstruct}
3418 *
3419 * Notes about revising originally VirtIO 1.0+ only virtio-net device emulator to be "transitional",
3420 * a VirtIO term meaning this now interoperates with both "legacy" (e.g. pre-1.0) and "modern" (1.0+)
3421 * guest virtio-net drivers. The changes include migrating VMs saved using prior DevVirtioNet.cpp (0.95)
3422 * saveExec/loadExec semantics to use 1.0 save/load semantics.
3423 *
3424 * Regardless of the 1.0 spec's overall helpful guidance for implementing transitional devices,
3425 * A bit is left to the imagination, e.g. some things have to be determined deductively
3426 * (AKA "the hard way").
3427 *
3428 * Case in point: According to VirtIO 0.95 ("legacy") specification, section 2.2.1, "historically"
3429 * drivers may start driving prior to feature negotiation and prior to drivers setting DRIVER_OK
3430 * status, "provided driver doesn't use features that alter early use of this device". Interpreted
3431 * here to mean a virtio-net driver must respect default settings (such as implicit pkt header default
3432 * size, as determined per Note 1 below).
3433 *
3434 * ----------------------------------------------------------------------------------------------
3435 * Transitional device initialization Note 1: Identifying default value for network Rx pkt hdr size.
3436 * (VirtIO 1.0 specification section 5.1.6.1)
3437 *
3438 * Guest virtio legacy drivers may begin operations prematurely, regardless of early spec's
3439 * initialization sequence (see note 2 below). Legacy drivers implicitly default to using the
3440 * (historically) shortest-length network packet header *unless* VIRTIONET_F_MRG_RXBUF feature is
3441 * negotiated. If feature negotiation phase is [optionally] enacted by a legacy guest (i.e. we strictly
3442 * enforce full initialization protocol for modern guests), virtioNetConfigurePktHdr() is invoked again to
3443 * finalize device's network packet header size. Best-guess at default packet header size is deduced, e.g.
3444 * isn't documented, as follows: A legacy guest with VIRTIONET_F_MRG_RXBUF not-yet-negotiated is the only
3445 * case where network I/O could possibly occur with any reasonable assumption about packet type/size,
3446 * because logically other permutations couldn't possibly be inferred until feature negotiation
3447 * is complete. Specifically, those cases are:
3448 *
3449 * 1. A modern driver (detected only when VIRTIONET_F_VERSION_1 feature is ack'd by guest, and,
3450 * simultaneously, VIRTIONET_F_MRG_RXBUF feature is accepted or declined (determining network receive-packet
3451 * processing behavior).
3452 *
3453 * 2. A legacy driver that has agreed to use VIRTIONET_F_MRG_RXBUF feature, resulting in a two-byte larger pkt hdr,
3454 * (as well as deciding Rx packet processing behavior).
3455 *
3456 * ----------------------------------------------------------------------------------------------
3457 * Transitional device initialization Note 2: Creating unnegotiated control queue.
3458 * (VirtIO 1.0 spec, sections 5.1.5 and 5.1.6.5)
3459 *
3460 * Create all queues immediately, prior to feature negotiation, including control queue (irrespective
3461 * of the fact it's too early in initialization for control feature to be approved by guest). This
3462 * transitional device must deal with legacy guests which *can* (and on linux have been seen to) use
3463 * the control queue prior to feature negotiation.
3464 *
3465 * The initial assumption is *modern" guest virtio-net drivers out in the wild could never reasonably
3466 * attempt something as obviously risky as using ctrlq without first acking VIRTIO_NET_F_CTRL_VQ
3467 * feature to establish it. For now, we create the control queue proactively to accomodate a potentially
3468 * badly behaved but officially sanctioned legacy virtio-net driver, but *destroy* that same queue
3469 * if a driver announces as 'modern' during feature finalization yet leaves VIRTIO_NET_F_CTRL_VQ un-ack'd.
3470 */
3471static DECLCALLBACK(int) virtioNetR3Construct(PPDMDEVINS pDevIns, int iInstance, PCFGMNODE pCfg)
3472{
3473 PDMDEV_CHECK_VERSIONS_RETURN(pDevIns);
3474 PVIRTIONET pThis = PDMDEVINS_2_DATA(pDevIns, PVIRTIONET);
3475 PVIRTIONETCC pThisCC = PDMDEVINS_2_DATA_CC(pDevIns, PVIRTIONETCC);
3476 PCPDMDEVHLPR3 pHlp = pDevIns->pHlpR3;
3477
3478 /*
3479 * Quickly initialize state data to ensure destructor always works.
3480 */
3481 Log7Func(("PDM device instance: %d\n", iInstance));
3482 RTStrPrintf(pThis->szInst, sizeof(pThis->szInst), "virtio-net #%d", iInstance);
3483
3484 pThisCC->pDevIns = pDevIns;
3485 pThisCC->IBase.pfnQueryInterface = virtioNetR3QueryInterface;
3486 pThisCC->ILeds.pfnQueryStatusLed = virtioNetR3QueryStatusLed;
3487 pThisCC->led.u32Magic = PDMLED_MAGIC;
3488
3489 /* Interfaces */
3490 pThisCC->INetworkDown.pfnWaitReceiveAvail = virtioNetR3NetworkDown_WaitReceiveAvail;
3491 pThisCC->INetworkDown.pfnReceive = virtioNetR3NetworkDown_Receive;
3492 pThisCC->INetworkDown.pfnReceiveGso = virtioNetR3NetworkDown_ReceiveGso;
3493 pThisCC->INetworkDown.pfnXmitPending = virtioNetR3NetworkDown_XmitPending;
3494 pThisCC->INetworkConfig.pfnGetMac = virtioNetR3NetworkConfig_GetMac;
3495 pThisCC->INetworkConfig.pfnGetLinkState = virtioNetR3NetworkConfig_GetLinkState;
3496 pThisCC->INetworkConfig.pfnSetLinkState = virtioNetR3NetworkConfig_SetLinkState;
3497
3498 pThis->hEventRxDescAvail = NIL_SUPSEMEVENT;
3499
3500 /*
3501 * Validate configuration.
3502 */
3503 PDMDEV_VALIDATE_CONFIG_RETURN(pDevIns, "MAC|CableConnected|LineSpeed|LinkUpDelay|StatNo|Legacy", "");
3504
3505 /* Get config params */
3506 int rc = pHlp->pfnCFGMQueryBytes(pCfg, "MAC", pThis->macConfigured.au8, sizeof(pThis->macConfigured));
3507 if (RT_FAILURE(rc))
3508 return PDMDEV_SET_ERROR(pDevIns, rc, N_("Configuration error: Failed to get MAC address"));
3509
3510 rc = pHlp->pfnCFGMQueryBool(pCfg, "CableConnected", &pThis->fCableConnected);
3511 if (RT_FAILURE(rc))
3512 return PDMDEV_SET_ERROR(pDevIns, rc, N_("Configuration error: Failed to get the value of 'CableConnected'"));
3513
3514 uint32_t uStatNo = iInstance;
3515 rc = pHlp->pfnCFGMQueryU32Def(pCfg, "StatNo", &uStatNo, iInstance);
3516 if (RT_FAILURE(rc))
3517 return PDMDEV_SET_ERROR(pDevIns, rc, N_("Configuration error: Failed to get the \"StatNo\" value"));
3518
3519 rc = pHlp->pfnCFGMQueryU32Def(pCfg, "LinkUpDelay", &pThis->cMsLinkUpDelay, 5000); /* ms */
3520 if (RT_FAILURE(rc))
3521 return PDMDEV_SET_ERROR(pDevIns, rc, N_("Configuration error: Failed to get the value of 'LinkUpDelay'"));
3522
3523 Assert(pThis->cMsLinkUpDelay <= 300000); /* less than 5 minutes */
3524
3525 if (pThis->cMsLinkUpDelay > 5000 || pThis->cMsLinkUpDelay < 100)
3526 LogRel(("%s WARNING! Link up delay is set to %u seconds!\n",
3527 pThis->szInst, pThis->cMsLinkUpDelay / 1000));
3528
3529 Log(("[%s] Link up delay is set to %u seconds\n", pThis->szInst, pThis->cMsLinkUpDelay / 1000));
3530
3531 /* Copy the MAC address configured for the VM to the MMIO accessible Virtio dev-specific config area */
3532 memcpy(pThis->virtioNetConfig.uMacAddress.au8, pThis->macConfigured.au8, sizeof(pThis->virtioNetConfig.uMacAddress)); /* TBD */
3533
3534 Log(("Using MAC address for %s: %2x:%2x:%2x:%2x:%2x:%2x\n", pThis->szInst,
3535 pThis->macConfigured.au8[0], pThis->macConfigured.au8[1], pThis->macConfigured.au8[2],
3536 pThis->macConfigured.au8[3], pThis->macConfigured.au8[4], pThis->macConfigured.au8[5]));
3537
3538 LogFunc(("RC=%RTbool R0=%RTbool\n", pDevIns->fRCEnabled, pDevIns->fR0Enabled));
3539
3540 /*
3541 * Configure Virtio core (generic Virtio queue and infrastructure management) parameters.
3542 */
3543# if FEATURE_OFFERED(STATUS)
3544 pThis->virtioNetConfig.uStatus = 0;
3545# endif
3546
3547 pThis->virtioNetConfig.uMaxVirtqPairs = VIRTIONET_MAX_QPAIRS;
3548 pThisCC->Virtio.pfnFeatureNegotiationComplete = pfnFeatureNegotiationComplete;
3549 pThisCC->Virtio.pfnVirtqNotified = virtioNetVirtqNotified;
3550 pThisCC->Virtio.pfnStatusChanged = virtioNetR3StatusChg;
3551 pThisCC->Virtio.pfnDevCapRead = virtioNetR3DevCapRead;
3552 pThisCC->Virtio.pfnDevCapWrite = virtioNetR3DevCapWrite;
3553
3554 VIRTIOPCIPARAMS VirtioPciParams;
3555 VirtioPciParams.uDeviceId = PCI_DEVICE_ID_VIRTIONET_HOST;
3556 VirtioPciParams.uClassBase = PCI_CLASS_BASE_NETWORK_CONTROLLER;
3557 VirtioPciParams.uClassSub = PCI_CLASS_SUB_NET_ETHERNET_CONTROLLER;
3558 VirtioPciParams.uClassProg = PCI_CLASS_PROG_UNSPECIFIED;
3559 VirtioPciParams.uSubsystemId = DEVICE_PCI_NETWORK_SUBSYSTEM; /* VirtIO 1.0 allows PCI Device ID here */
3560 VirtioPciParams.uInterruptLine = 0x00;
3561 VirtioPciParams.uInterruptPin = 0x01;
3562
3563 /* Create semaphore used to synchronize/throttle the downstream LUN's Rx waiter thread. */
3564 rc = PDMDevHlpSUPSemEventCreate(pDevIns, &pThis->hEventRxDescAvail);
3565 if (RT_FAILURE(rc))
3566 return PDMDEV_SET_ERROR(pDevIns, rc, N_("Failed to create event semaphore"));
3567
3568 pThis->fOfferLegacy = VIRTIONET_TRANSITIONAL_ENABLE_FLAG;
3569 virtioNetConfigurePktHdr(pThis, pThis->fOfferLegacy); /* set defaults */
3570
3571 /* Initialize VirtIO core. (*pfnStatusChanged)() callback occurs when both host VirtIO core & guest driver are ready) */
3572 rc = virtioCoreR3Init(pDevIns, &pThis->Virtio, &pThisCC->Virtio, &VirtioPciParams, pThis->szInst,
3573 VIRTIONET_HOST_FEATURES_OFFERED, pThis->fOfferLegacy,
3574 &pThis->virtioNetConfig /*pvDevSpecificCap*/, sizeof(pThis->virtioNetConfig));
3575 if (RT_FAILURE(rc))
3576 return PDMDEV_SET_ERROR(pDevIns, rc, N_("virtio-net: failed to initialize VirtIO"));
3577
3578 pThis->fNegotiatedFeatures = virtioCoreGetNegotiatedFeatures(&pThis->Virtio);
3579 /** @todo validating features at this point is most probably pointless, as the negotiation hasn't started yet. */
3580 if (!virtioNetValidateRequiredFeatures(pThis->fNegotiatedFeatures))
3581 return PDMDEV_SET_ERROR(pDevIns, rc, N_("virtio-net: Required features not successfully negotiated."));
3582 pThis->cVirtqPairs = pThis->virtioNetConfig.uMaxVirtqPairs;
3583 pThis->cVirtqs += pThis->cVirtqPairs * 2 + 1;
3584 pThis->aVirtqs[CTRLQIDX].fCtlVirtq = true;
3585
3586 virtioNetR3SetVirtqNames(pThis, pThis->fOfferLegacy);
3587 for (unsigned uVirtqNbr = 0; uVirtqNbr < pThis->cVirtqs; uVirtqNbr++)
3588 {
3589 PVIRTIONETVIRTQ pVirtq = &pThis->aVirtqs[uVirtqNbr];
3590 PVIRTIONETWORKER pWorker = &pThis->aWorkers[uVirtqNbr];
3591 PVIRTIONETWORKERR3 pWorkerR3 = &pThisCC->aWorkers[uVirtqNbr];
3592 pVirtq->uIdx = pWorker->uIdx = pWorkerR3->uIdx = uVirtqNbr;
3593 }
3594 /*
3595 * Create queue workers for life of instance. (I.e. they persist through VirtIO bounces)
3596 */
3597 rc = virtioNetR3CreateWorkerThreads(pDevIns, pThis, pThisCC);
3598 if (RT_FAILURE(rc))
3599 return PDMDEV_SET_ERROR(pDevIns, rc, N_("Failed to create worker threads"));
3600
3601 /* Create Link Up Timer */
3602 rc = PDMDevHlpTimerCreate(pDevIns, TMCLOCK_VIRTUAL, virtioNetR3LinkUpTimer, NULL,
3603 TMTIMER_FLAGS_NO_CRIT_SECT | TMTIMER_FLAGS_NO_RING0,
3604 "VirtioNet Link Up", &pThisCC->hLinkUpTimer);
3605 /*
3606 * Attach network driver instance
3607 */
3608 rc = PDMDevHlpDriverAttach(pDevIns, 0, &pThisCC->IBase, &pThisCC->pDrvBase, "Network Port");
3609 if (RT_SUCCESS(rc))
3610 {
3611 pThisCC->pDrv = PDMIBASE_QUERY_INTERFACE(pThisCC->pDrvBase, PDMINETWORKUP);
3612 AssertMsgStmt(pThisCC->pDrv, ("Failed to obtain the PDMINETWORKUP interface!\n"),
3613 rc = VERR_PDM_MISSING_INTERFACE_BELOW);
3614 }
3615 else if ( rc == VERR_PDM_NO_ATTACHED_DRIVER
3616 || rc == VERR_PDM_CFG_MISSING_DRIVER_NAME)
3617 {
3618 Log(("[%s] No attached driver!\n", pThis->szInst));
3619 AssertRCReturn(rc, rc);
3620 }
3621 /*
3622 * Status driver
3623 */
3624 PPDMIBASE pUpBase;
3625 rc = PDMDevHlpDriverAttach(pDevIns, PDM_STATUS_LUN, &pThisCC->IBase, &pUpBase, "Status Port");
3626 if (RT_FAILURE(rc) && rc != VERR_PDM_NO_ATTACHED_DRIVER)
3627 return PDMDEV_SET_ERROR(pDevIns, rc, N_("Failed to attach the status LUN"));
3628
3629 pThisCC->pLedsConnector = PDMIBASE_QUERY_INTERFACE(pUpBase, PDMILEDCONNECTORS);
3630 /*
3631 * Register saved state.
3632 */
3633 rc = PDMDevHlpSSMRegisterEx(pDevIns, VIRTIONET_SAVEDSTATE_VERSION, sizeof(*pThis), NULL,
3634 NULL, NULL, NULL, /** @todo r=aeichner Teleportation? */
3635 NULL, virtioNetR3ModernSaveExec, NULL,
3636 NULL, virtioNetR3ModernLoadExec, virtioNetR3ModernLoadDone);
3637 AssertRCReturn(rc, rc);
3638 /*
3639 * Statistics and debug stuff.
3640 * The /Public/ bits are official and used by session info in the GUI.
3641 */
3642 PDMDevHlpSTAMRegisterF(pDevIns, &pThis->StatReceiveBytes, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_BYTES,
3643 "Amount of data received", "/Public/NetAdapter/%u/BytesReceived", uStatNo);
3644 PDMDevHlpSTAMRegisterF(pDevIns, &pThis->StatTransmitBytes, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_BYTES,
3645 "Amount of data transmitted", "/Public/NetAdapter/%u/BytesTransmitted", uStatNo);
3646 PDMDevHlpSTAMRegisterF(pDevIns, &pDevIns->iInstance, STAMTYPE_U32, STAMVISIBILITY_ALWAYS, STAMUNIT_NONE,
3647 "Device instance number", "/Public/NetAdapter/%u/%s", uStatNo, pDevIns->pReg->szName);
3648
3649 PDMDevHlpSTAMRegister(pDevIns, &pThis->StatReceiveBytes, STAMTYPE_COUNTER, "ReceiveBytes", STAMUNIT_BYTES, "Amount of data received");
3650 PDMDevHlpSTAMRegister(pDevIns, &pThis->StatTransmitBytes, STAMTYPE_COUNTER, "TransmitBytes", STAMUNIT_BYTES, "Amount of data transmitted");
3651 PDMDevHlpSTAMRegister(pDevIns, &pThis->StatReceiveGSO, STAMTYPE_COUNTER, "Packets/ReceiveGSO", STAMUNIT_COUNT, "Number of received GSO packets");
3652 PDMDevHlpSTAMRegister(pDevIns, &pThis->StatTransmitPackets, STAMTYPE_COUNTER, "Packets/Transmit", STAMUNIT_COUNT, "Number of sent packets");
3653 PDMDevHlpSTAMRegister(pDevIns, &pThis->StatTransmitGSO, STAMTYPE_COUNTER, "Packets/Transmit-Gso", STAMUNIT_COUNT, "Number of sent GSO packets");
3654 PDMDevHlpSTAMRegister(pDevIns, &pThis->StatTransmitCSum, STAMTYPE_COUNTER, "Packets/Transmit-Csum", STAMUNIT_COUNT, "Number of completed TX checksums");
3655# ifdef VBOX_WITH_STATISTICS
3656 PDMDevHlpSTAMRegister(pDevIns, &pThis->StatReceive, STAMTYPE_PROFILE, "Receive/Total", STAMUNIT_TICKS_PER_CALL, "Profiling receive");
3657 PDMDevHlpSTAMRegister(pDevIns, &pThis->StatReceiveStore, STAMTYPE_PROFILE, "Receive/Store", STAMUNIT_TICKS_PER_CALL, "Profiling receive storing");
3658 PDMDevHlpSTAMRegister(pDevIns, &pThis->StatRxOverflow, STAMTYPE_PROFILE, "RxOverflow", STAMUNIT_TICKS_PER_OCCURENCE, "Profiling RX overflows");
3659 PDMDevHlpSTAMRegister(pDevIns, &pThis->StatRxOverflowWakeup, STAMTYPE_COUNTER, "RxOverflowWakeup", STAMUNIT_OCCURENCES, "Nr of RX overflow wakeups");
3660 PDMDevHlpSTAMRegister(pDevIns, &pThis->StatTransmit, STAMTYPE_PROFILE, "Transmit/Total", STAMUNIT_TICKS_PER_CALL, "Profiling transmits in HC");
3661 PDMDevHlpSTAMRegister(pDevIns, &pThis->StatTransmitSend, STAMTYPE_PROFILE, "Transmit/Send", STAMUNIT_TICKS_PER_CALL, "Profiling send transmit in HC");
3662 PDMDevHlpSTAMRegister(pDevIns, &pThis->StatTransmitByNetwork, STAMTYPE_COUNTER, "Transmit/ByNetwork", STAMUNIT_COUNT, "Network-initiated transmissions");
3663 PDMDevHlpSTAMRegister(pDevIns, &pThis->StatTransmitByThread, STAMTYPE_COUNTER, "Transmit/ByThread", STAMUNIT_COUNT, "Thread-initiated transmissions");
3664# endif
3665 /*
3666 * Register the debugger info callback (ignore errors).
3667 */
3668 char szTmp[128];
3669 rc = PDMDevHlpDBGFInfoRegister(pDevIns, "virtio-net", "Display virtio-net info (help, net, features, state, pointers, queues, all)", virtioNetR3Info);
3670 if (RT_FAILURE(rc))
3671 LogRel(("Failed to register DBGF info for device %s\n", szTmp));
3672 return rc;
3673}
3674
3675#else /* !IN_RING3 */
3676
3677/**
3678 * @callback_method_impl{PDMDEVREGR0,pfnConstruct}
3679 */
3680static DECLCALLBACK(int) virtioNetRZConstruct(PPDMDEVINS pDevIns)
3681{
3682 PDMDEV_CHECK_VERSIONS_RETURN(pDevIns);
3683 PVIRTIONET pThis = PDMDEVINS_2_DATA(pDevIns, PVIRTIONET);
3684 PVIRTIONETCC pThisCC = PDMDEVINS_2_DATA_CC(pDevIns, PVIRTIONETCC);
3685 pThisCC->Virtio.pfnVirtqNotified = virtioNetVirtqNotified;
3686 return virtioCoreRZInit(pDevIns, &pThis->Virtio);
3687}
3688
3689#endif /* !IN_RING3 */
3690
3691/**
3692 * The device registration structure.
3693 */
3694const PDMDEVREG g_DeviceVirtioNet =
3695{
3696 /* .uVersion = */ PDM_DEVREG_VERSION,
3697 /* .uReserved0 = */ 0,
3698 /* .szName = */ "virtio-net",
3699 /* .fFlags = */ PDM_DEVREG_FLAGS_DEFAULT_BITS | PDM_DEVREG_FLAGS_NEW_STYLE | PDM_DEVREG_FLAGS_RZ,
3700 /* .fClass = */ PDM_DEVREG_CLASS_NETWORK,
3701 /* .cMaxInstances = */ ~0U,
3702 /* .uSharedVersion = */ 42,
3703 /* .cbInstanceShared = */ sizeof(VIRTIONET),
3704 /* .cbInstanceCC = */ sizeof(VIRTIONETCC),
3705 /* .cbInstanceRC = */ sizeof(VIRTIONETRC),
3706 /* .cMaxPciDevices = */ 1,
3707 /* .cMaxMsixVectors = */ VBOX_MSIX_MAX_ENTRIES,
3708 /* .pszDescription = */ "Virtio Host NET.\n",
3709#if defined(IN_RING3)
3710 /* .pszRCMod = */ "VBoxDDRC.rc",
3711 /* .pszR0Mod = */ "VBoxDDR0.r0",
3712 /* .pfnConstruct = */ virtioNetR3Construct,
3713 /* .pfnDestruct = */ virtioNetR3Destruct,
3714 /* .pfnRelocate = */ NULL,
3715 /* .pfnMemSetup = */ NULL,
3716 /* .pfnPowerOn = */ NULL,
3717 /* .pfnReset = */ virtioNetR3Reset,
3718 /* .pfnSuspend = */ virtioNetWakeupRxBufWaiter,
3719 /* .pfnResume = */ NULL,
3720 /* .pfnAttach = */ virtioNetR3Attach,
3721 /* .pfnDetach = */ virtioNetR3Detach,
3722 /* .pfnQueryInterface = */ NULL,
3723 /* .pfnInitComplete = */ NULL,
3724 /* .pfnPowerOff = */ virtioNetWakeupRxBufWaiter,
3725 /* .pfnSoftReset = */ NULL,
3726 /* .pfnReserved0 = */ NULL,
3727 /* .pfnReserved1 = */ NULL,
3728 /* .pfnReserved2 = */ NULL,
3729 /* .pfnReserved3 = */ NULL,
3730 /* .pfnReserved4 = */ NULL,
3731 /* .pfnReserved5 = */ NULL,
3732 /* .pfnReserved6 = */ NULL,
3733 /* .pfnReserved7 = */ NULL,
3734#elif defined(IN_RING0)
3735 /* .pfnEarlyConstruct = */ NULL,
3736 /* .pfnConstruct = */ virtioNetRZConstruct,
3737 /* .pfnDestruct = */ NULL,
3738 /* .pfnFinalDestruct = */ NULL,
3739 /* .pfnRequest = */ NULL,
3740 /* .pfnReserved0 = */ NULL,
3741 /* .pfnReserved1 = */ NULL,
3742 /* .pfnReserved2 = */ NULL,
3743 /* .pfnReserved3 = */ NULL,
3744 /* .pfnReserved4 = */ NULL,
3745 /* .pfnReserved5 = */ NULL,
3746 /* .pfnReserved6 = */ NULL,
3747 /* .pfnReserved7 = */ NULL,
3748#elif defined(IN_RC)
3749 /* .pfnConstruct = */ virtioNetRZConstruct,
3750 /* .pfnReserved0 = */ NULL,
3751 /* .pfnReserved1 = */ NULL,
3752 /* .pfnReserved2 = */ NULL,
3753 /* .pfnReserved3 = */ NULL,
3754 /* .pfnReserved4 = */ NULL,
3755 /* .pfnReserved5 = */ NULL,
3756 /* .pfnReserved6 = */ NULL,
3757 /* .pfnReserved7 = */ NULL,
3758#else
3759# error "Not in IN_RING3, IN_RING0 or IN_RC!"
3760#endif
3761 /* .uVersionEnd = */ PDM_DEVREG_VERSION
3762};
3763
Note: See TracBrowser for help on using the repository browser.

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette