VirtualBox

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

Last change on this file since 101400 was 101400, checked in by vboxsync, 13 months ago

Devices/DevVirtioNet.cpp: Improve checks, bugref:10521
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 160.5 KB
Line 
1/* $Id: DevVirtioNet.cpp 101400 2023-10-10 08:39:16Z vboxsync $ $Revision: 101400 $ $Date: 2023-10-10 08:39:16 +0000 (Tue, 10 Oct 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-2023 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#include <VBox/pci.h>
56
57
58#ifdef IN_RING3
59# include <VBox/VBoxPktDmp.h>
60# include <iprt/alloc.h>
61# include <iprt/memcache.h>
62# include <iprt/semaphore.h>
63# include <iprt/sg.h>
64# include <iprt/param.h>
65# include <iprt/uuid.h>
66#endif
67#include "../VirtIO/VirtioCore.h"
68
69#include "VBoxDD.h"
70
71#define VIRTIONET_TRANSITIONAL_ENABLE_FLAG 1 /** < If set behave as VirtIO "transitional" device */
72
73/** The current saved state version for the virtio core. */
74#define VIRTIONET_SAVEDSTATE_VERSION UINT32_C(1)
75#define VIRTIONET_SAVEDSTATE_VERSION_3_1_BETA1_LEGACY UINT32_C(1) /**< Grandfathered in from DevVirtioNet.cpp */
76#define VIRTIONET_SAVEDSTATE_VERSION_LEGACY UINT32_C(2) /**< Grandfathered in from DevVirtioNet.cpp */
77#define VIRTIONET_VERSION_MARKER_MAC_ADDR { 0xff, 0xff, 0xff, 0xff, 0xff, 0xff } /** SSM handling */
78
79/*
80 * Glossary of networking acronyms used in feature names below:
81 *
82 * GSO = Generic Segmentation Offload
83 * TSO = TCP Segmentation Offload
84 * UFO = UDP Fragmentation Offload
85 * ECN = Explicit Congestion Notification
86 */
87
88/** @name VirtIO 1.0 NET Host feature bits (See VirtIO 1.0 specification, Section 5.6.3)
89 * @{ */
90#define VIRTIONET_F_CSUM RT_BIT_64(0) /**< Handle packets with partial checksum */
91#define VIRTIONET_F_GUEST_CSUM RT_BIT_64(1) /**< Handles packets with partial checksum */
92#define VIRTIONET_F_CTRL_GUEST_OFFLOADS RT_BIT_64(2) /**< Control channel offloads reconfig support */
93#define VIRTIONET_F_MAC RT_BIT_64(5) /**< Device has given MAC address */
94#define VIRTIONET_F_GUEST_TSO4 RT_BIT_64(7) /**< Driver can receive TSOv4 */
95#define VIRTIONET_F_GUEST_TSO6 RT_BIT_64(8) /**< Driver can receive TSOv6 */
96#define VIRTIONET_F_GUEST_ECN RT_BIT_64(9) /**< Driver can receive TSO with ECN */
97#define VIRTIONET_F_GUEST_UFO RT_BIT_64(10) /**< Driver can receive UFO */
98#define VIRTIONET_F_HOST_TSO4 RT_BIT_64(11) /**< Device can receive TSOv4 */
99#define VIRTIONET_F_HOST_TSO6 RT_BIT_64(12) /**< Device can receive TSOv6 */
100#define VIRTIONET_F_HOST_ECN RT_BIT_64(13) /**< Device can receive TSO with ECN */
101#define VIRTIONET_F_HOST_UFO RT_BIT_64(14) /**< Device can receive UFO */
102#define VIRTIONET_F_MRG_RXBUF RT_BIT_64(15) /**< Driver can merge receive buffers */
103#define VIRTIONET_F_STATUS RT_BIT_64(16) /**< Config status field is available */
104#define VIRTIONET_F_CTRL_VQ RT_BIT_64(17) /**< Control channel is available */
105#define VIRTIONET_F_CTRL_RX RT_BIT_64(18) /**< Control channel RX mode + MAC addr filtering */
106#define VIRTIONET_F_CTRL_VLAN RT_BIT_64(19) /**< Control channel VLAN filtering */
107#define VIRTIONET_F_CTRL_RX_EXTRA RT_BIT_64(20) /**< Control channel RX mode extra functions */
108#define VIRTIONET_F_GUEST_ANNOUNCE RT_BIT_64(21) /**< Driver can send gratuitous packets */
109#define VIRTIONET_F_MQ RT_BIT_64(22) /**< Support ultiqueue with auto receive steering */
110#define VIRTIONET_F_CTRL_MAC_ADDR RT_BIT_64(23) /**< Set MAC address through control channel */
111/** @} */
112
113#ifdef IN_RING3
114static const VIRTIO_FEATURES_LIST s_aDevSpecificFeatures[] =
115{
116 { VIRTIONET_F_STATUS, " STATUS Configuration status field is available.\n" },
117 { VIRTIONET_F_MAC, " MAC Host has given MAC address.\n" },
118 { VIRTIONET_F_CTRL_VQ, " CTRL_VQ Control channel is available.\n" },
119 { VIRTIONET_F_CTRL_MAC_ADDR, " CTRL_MAC_ADDR Set MAC address through control channel.\n" },
120 { VIRTIONET_F_CTRL_RX, " CTRL_RX Control channel RX mode support.\n" },
121 { VIRTIONET_F_CTRL_VLAN, " CTRL_VLAN Control channel VLAN filtering.\n" },
122 { VIRTIONET_F_CTRL_GUEST_OFFLOADS, " CTRL_GUEST_OFFLOADS Control channel offloads reconfiguration support.\n" },
123 { VIRTIONET_F_GUEST_CSUM, " GUEST_CSUM Guest handles packets with partial checksum.\n" },
124 { VIRTIONET_F_GUEST_ANNOUNCE, " GUEST_ANNOUNCE Guest can send gratuitous packets.\n" },
125 { VIRTIONET_F_GUEST_TSO4, " GUEST_TSO4 Guest can receive TSOv4.\n" },
126 { VIRTIONET_F_GUEST_TSO6, " GUEST_TSO6 Guest can receive TSOv6.\n" },
127 { VIRTIONET_F_GUEST_ECN, " GUEST_ECN Guest can receive TSO with ECN.\n" },
128 { VIRTIONET_F_GUEST_UFO, " GUEST_UFO Guest can receive UFO.\n" },
129 { VIRTIONET_F_HOST_TSO4, " HOST_TSO4 Host can receive TSOv4.\n" },
130 { VIRTIONET_F_HOST_TSO6, " HOST_TSO6 Host can receive TSOv6.\n" },
131 { VIRTIONET_F_HOST_ECN, " HOST_ECN Host can receive TSO with ECN.\n" },
132 { VIRTIONET_F_HOST_UFO, " HOST_UFO Host can receive UFO.\n" },
133 { VIRTIONET_F_MQ, " MQ Host supports multiqueue with automatic receive steering.\n" },
134 { VIRTIONET_F_CSUM, " CSUM Host handles packets with partial checksum.\n" },
135 { VIRTIONET_F_MRG_RXBUF, " MRG_RXBUF Guest can merge receive buffers.\n" },
136};
137#endif
138
139#ifdef VIRTIONET_WITH_GSO
140# define VIRTIONET_HOST_FEATURES_GSO \
141 VIRTIONET_F_CSUM \
142 | VIRTIONET_F_HOST_TSO4 \
143 | VIRTIONET_F_HOST_TSO6 \
144 | VIRTIONET_F_HOST_UFO \
145 | VIRTIONET_F_GUEST_TSO4 \
146 | VIRTIONET_F_GUEST_TSO6 \
147 | VIRTIONET_F_GUEST_UFO \
148 | VIRTIONET_F_GUEST_CSUM /* @bugref(4796) Guest must handle partial chksums */
149#else
150# define VIRTIONET_HOST_FEATURES_GSO
151#endif
152
153#define VIRTIONET_HOST_FEATURES_OFFERED \
154 VIRTIONET_F_STATUS \
155 | VIRTIONET_F_GUEST_ANNOUNCE \
156 | VIRTIONET_F_MAC \
157 | VIRTIONET_F_CTRL_VQ \
158 | VIRTIONET_F_CTRL_RX \
159 | VIRTIONET_F_CTRL_VLAN \
160 | VIRTIONET_HOST_FEATURES_GSO \
161 | VIRTIONET_F_MRG_RXBUF
162
163#define FEATURE_ENABLED(feature) RT_BOOL(!!(pThis->fNegotiatedFeatures & VIRTIONET_F_##feature))
164#define FEATURE_DISABLED(feature) (!FEATURE_ENABLED(feature))
165#define FEATURE_OFFERED(feature) VIRTIONET_HOST_FEATURES_OFFERED & VIRTIONET_F_##feature
166
167#if FEATURE_OFFERED(MQ)
168/* Instance data doesn't allow an array large enough to contain VIRTIONET_CTRL_MQ_VQ_PAIRS_MAX entries */
169# define VIRTIONET_MAX_QPAIRS 1 /* This should be increased at some point and made to work */
170#else
171# define VIRTIONET_MAX_QPAIRS VIRTIONET_CTRL_MQ_VQ_PAIRS_MIN /* default, VirtIO 1.0, 5.1.6.5.5 */
172#endif
173
174#define VIRTIONET_CTRL_MQ_VQ_PAIRS 64
175#define VIRTIONET_MAX_WORKERS VIRTIONET_MAX_QPAIRS + 1
176#define VIRTIONET_MAX_VIRTQS (VIRTIONET_MAX_QPAIRS * 2 + 1)
177#define VIRTIONET_MAX_FRAME_SIZE 65535 + 18 /**< Max IP pkt size + Eth. header w/VLAN tag */
178#define VIRTIONET_MAC_FILTER_LEN 64
179#define VIRTIONET_MAX_VLAN_ID 4096
180#define VIRTIONET_RX_SEG_COUNT 32
181
182#define VIRTQNAME(uVirtqNbr) (pThis->aVirtqs[uVirtqNbr]->szName)
183#define CBVIRTQNAME(uVirtqNbr) RTStrNLen(VIRTQNAME(uVirtqNbr), sizeof(VIRTQNAME(uVirtqNbr)))
184
185#define IS_TX_VIRTQ(n) ((n) != CTRLQIDX && ((n) & 1))
186#define IS_RX_VIRTQ(n) ((n) != CTRLQIDX && !IS_TX_VIRTQ(n))
187#define IS_CTRL_VIRTQ(n) ((n) == CTRLQIDX)
188
189/*
190 * Macros to calculate queue type-pecific index number regardless of scale. VirtIO 1.0, 5.1.2
191 */
192#define RXQIDX(qPairIdx) (qPairIdx * 2)
193#define TXQIDX(qPairIdx) (RXQIDX(qPairIdx) + 1)
194#define CTRLQIDX (FEATURE_ENABLED(MQ) ? ((VIRTIONET_MAX_QPAIRS - 1) * 2 + 2) : 2)
195
196#define IS_LINK_UP(pState) !!(pState->virtioNetConfig.uStatus & VIRTIONET_F_LINK_UP)
197#define IS_LINK_DOWN(pState) !IS_LINK_UP(pState)
198
199#define SET_LINK_UP(pState) \
200 LogFunc(("SET_LINK_UP\n")); \
201 pState->virtioNetConfig.uStatus |= VIRTIONET_F_LINK_UP; \
202 virtioCoreNotifyConfigChanged(&pThis->Virtio)
203
204#define SET_LINK_DOWN(pState) \
205 LogFunc(("SET_LINK_DOWN\n")); \
206 pState->virtioNetConfig.uStatus &= ~VIRTIONET_F_LINK_UP; \
207 virtioCoreNotifyConfigChanged(&pThis->Virtio)
208
209#define IS_VIRTQ_EMPTY(pDevIns, pVirtio, uVirtqNbr) \
210 (virtioCoreVirtqAvailBufCount(pDevIns, pVirtio, uVirtqNbr) == 0)
211
212#define PCI_DEVICE_ID_VIRTIONET_HOST 0x1000 /**< VirtIO transitional device ID for network card */
213#define PCI_CLASS_PROG_UNSPECIFIED 0x00 /**< Programming interface. N/A. */
214#define VIRTIONET_PCI_CLASS 0x01 /**< Base class Mass Storage? */
215
216/**
217 * VirtIO Network (virtio-net) device-specific configuration subregion (VirtIO 1.0, 5.1.4)
218 * Guest MMIO is processed through callback to VirtIO core which forwards references to network configuration
219 * fields to this device-specific code through a callback.
220 */
221#pragma pack(1)
222
223 typedef struct virtio_net_config
224 {
225 RTMAC uMacAddress; /**< mac */
226
227#if FEATURE_OFFERED(STATUS)
228 uint16_t uStatus; /**< status */
229#endif
230
231#if FEATURE_OFFERED(MQ)
232 uint16_t uMaxVirtqPairs; /**< max_virtq_pairs */
233#endif
234
235 } VIRTIONET_CONFIG_T, PVIRTIONET_CONFIG_T;
236
237#pragma pack()
238
239#define VIRTIONET_F_LINK_UP 1 /**< config status: Link is up */
240#define VIRTIONET_F_ANNOUNCE 2 /**< config status: Announce */
241
242/** @name VirtIO 1.0 NET Host Device device specific control types
243 * @{ */
244#define VIRTIONET_HDR_F_NEEDS_CSUM 1 /**< flags: Packet needs checksum */
245#define VIRTIONET_HDR_GSO_NONE 0 /**< gso_type: No Global Segmentation Offset */
246#define VIRTIONET_HDR_GSO_TCPV4 1 /**< gso_type: Global Segment Offset for TCPV4 */
247#define VIRTIONET_HDR_GSO_UDP 3 /**< gso_type: Global Segment Offset for UDP */
248#define VIRTIONET_HDR_GSO_TCPV6 4 /**< gso_type: Global Segment Offset for TCPV6 */
249#define VIRTIONET_HDR_GSO_ECN 0x80 /**< gso_type: Explicit Congestion Notification */
250/** @} */
251
252/* Device operation: Net header packet (VirtIO 1.0, 5.1.6) */
253#pragma pack(1)
254struct virtio_net_pkt_hdr {
255 uint8_t uFlags; /**< flags */
256 uint8_t uGsoType; /**< gso_type */
257 uint16_t uHdrLen; /**< hdr_len */
258 uint16_t uGsoSize; /**< gso_size */
259 uint16_t uChksumStart; /**< Chksum_start */
260 uint16_t uChksumOffset; /**< Chksum_offset */
261 uint16_t uNumBuffers; /**< num_buffers */
262};
263#pragma pack()
264typedef virtio_net_pkt_hdr VIRTIONETPKTHDR, *PVIRTIONETPKTHDR;
265AssertCompileSize(VIRTIONETPKTHDR, 12);
266
267/* Control virtq: Command entry (VirtIO 1.0, 5.1.6.5) */
268#pragma pack(1)
269struct virtio_net_ctrl_hdr {
270 uint8_t uClass; /**< class */
271 uint8_t uCmd; /**< command */
272};
273#pragma pack()
274typedef virtio_net_ctrl_hdr VIRTIONET_CTRL_HDR_T, *PVIRTIONET_CTRL_HDR_T;
275
276typedef uint8_t VIRTIONET_CTRL_HDR_T_ACK;
277
278/* Command entry fAck values */
279#define VIRTIONET_OK 0 /**< Internal success status */
280#define VIRTIONET_ERROR 1 /**< Internal failure status */
281
282/** @name Control virtq: Receive filtering flags (VirtIO 1.0, 5.1.6.5.1)
283 * @{ */
284#define VIRTIONET_CTRL_RX 0 /**< Control class: Receive filtering */
285#define VIRTIONET_CTRL_RX_PROMISC 0 /**< Promiscuous mode */
286#define VIRTIONET_CTRL_RX_ALLMULTI 1 /**< All-multicast receive */
287#define VIRTIONET_CTRL_RX_ALLUNI 2 /**< All-unicast receive */
288#define VIRTIONET_CTRL_RX_NOMULTI 3 /**< No multicast receive */
289#define VIRTIONET_CTRL_RX_NOUNI 4 /**< No unicast receive */
290#define VIRTIONET_CTRL_RX_NOBCAST 5 /**< No broadcast receive */
291/** @} */
292
293typedef uint8_t VIRTIONET_MAC_ADDRESS[6];
294typedef uint32_t VIRTIONET_CTRL_MAC_TABLE_LEN;
295typedef uint8_t VIRTIONET_CTRL_MAC_ENTRIES[][6];
296
297/** @name Control virtq: MAC address filtering flags (VirtIO 1.0, 5.1.6.5.2)
298 * @{ */
299#define VIRTIONET_CTRL_MAC 1 /**< Control class: MAC address filtering */
300#define VIRTIONET_CTRL_MAC_TABLE_SET 0 /**< Set MAC table */
301#define VIRTIONET_CTRL_MAC_ADDR_SET 1 /**< Set default MAC address */
302/** @} */
303
304/** @name Control virtq: MAC address filtering flags (VirtIO 1.0, 5.1.6.5.3)
305 * @{ */
306#define VIRTIONET_CTRL_VLAN 2 /**< Control class: VLAN filtering */
307#define VIRTIONET_CTRL_VLAN_ADD 0 /**< Add VLAN to filter table */
308#define VIRTIONET_CTRL_VLAN_DEL 1 /**< Delete VLAN from filter table */
309/** @} */
310
311/** @name Control virtq: Gratuitous packet sending (VirtIO 1.0, 5.1.6.5.4)
312 * @{ */
313#define VIRTIONET_CTRL_ANNOUNCE 3 /**< Control class: Gratuitous Packet Sending */
314#define VIRTIONET_CTRL_ANNOUNCE_ACK 0 /**< Gratuitous Packet Sending ACK */
315/** @} */
316
317struct virtio_net_ctrl_mq {
318 uint16_t uVirtqueuePairs; /**< virtqueue_pairs */
319};
320
321/** @name Control virtq: Receive steering in multiqueue mode (VirtIO 1.0, 5.1.6.5.5)
322 * @{ */
323#define VIRTIONET_CTRL_MQ 4 /**< Control class: Receive steering */
324#define VIRTIONET_CTRL_MQ_VQ_PAIRS_SET 0 /**< Set number of TX/RX queues */
325#define VIRTIONET_CTRL_MQ_VQ_PAIRS_MIN 1 /**< Minimum number of TX/RX queues */
326#define VIRTIONET_CTRL_MQ_VQ_PAIRS_MAX 0x8000 /**< Maximum number of TX/RX queues */
327/** @} */
328
329uint64_t uOffloads; /**< offloads */
330
331/** @name Control virtq: Setting Offloads State (VirtIO 1.0, 5.1.6.5.6.1)
332 * @{ */
333#define VIRTIONET_CTRL_GUEST_OFFLOADS 5 /**< Control class: Offloads state configuration */
334#define VIRTIONET_CTRL_GUEST_OFFLOADS_SET 0 /**< Apply new offloads configuration */
335/** @} */
336
337typedef enum VIRTIONETPKTHDRTYPE
338{
339 kVirtioNetUninitializedPktHdrType = 0, /**< Uninitialized (default) packet header type */
340 kVirtioNetModernPktHdrWithoutMrgRx = 1, /**< Packets should not be merged (modern driver) */
341 kVirtioNetModernPktHdrWithMrgRx = 2, /**< Packets should be merged (modern driver) */
342 kVirtioNetLegacyPktHdrWithoutMrgRx = 3, /**< Packets should not be merged (legacy driver) */
343 kVirtioNetLegacyPktHdrWithMrgRx = 4, /**< Packets should be merged (legacy driver) */
344 kVirtioNetFor32BitHack = 0x7fffffff
345} VIRTIONETPKTHDRTYPE;
346
347/**
348 * device-specific queue info
349 */
350struct VIRTIONETWORKER;
351struct VIRTIONETWORKERR3;
352
353typedef struct VIRTIONETVIRTQ
354{
355 uint16_t uIdx; /**< Index of this queue */
356 uint16_t align;
357 bool fCtlVirtq; /**< If set this queue is the control queue */
358 bool fHasWorker; /**< If set this queue has an associated worker */
359 bool fAttachedToVirtioCore; /**< Set if queue attached to virtio core */
360 char szName[VIRTIO_MAX_VIRTQ_NAME_SIZE]; /**< Virtq name */
361} VIRTIONETVIRTQ, *PVIRTIONETVIRTQ;
362
363/**
364 * Worker thread context, shared state.
365 */
366typedef struct VIRTIONETWORKER
367{
368 SUPSEMEVENT hEvtProcess; /**< handle of associated sleep/wake-up semaphore */
369 uint16_t uIdx; /**< Index of this worker */
370 bool volatile fSleeping; /**< Flags whether worker thread is sleeping or not */
371 bool volatile fNotified; /**< Flags whether worker thread notified */
372 bool fAssigned; /**< Flags whether worker thread has been set up */
373 uint8_t pad;
374} VIRTIONETWORKER;
375/** Pointer to a virtio net worker. */
376typedef VIRTIONETWORKER *PVIRTIONETWORKER;
377
378/**
379 * Worker thread context, ring-3 state.
380 */
381typedef struct VIRTIONETWORKERR3
382{
383 R3PTRTYPE(PPDMTHREAD) pThread; /**< pointer to worker thread's handle */
384 uint16_t uIdx; /**< Index of this worker */
385 uint16_t pad;
386} VIRTIONETWORKERR3;
387/** Pointer to a virtio net worker. */
388typedef VIRTIONETWORKERR3 *PVIRTIONETWORKERR3;
389
390/**
391 * VirtIO Host NET device state, shared edition.
392 *
393 * @extends VIRTIOCORE
394 */
395typedef struct VIRTIONET
396{
397 /** The core virtio state. */
398 VIRTIOCORE Virtio;
399
400 /** Virtio device-specific configuration */
401 VIRTIONET_CONFIG_T virtioNetConfig;
402
403 /** Per device-bound virtq worker-thread contexts (eventq slot unused) */
404 VIRTIONETWORKER aWorkers[VIRTIONET_MAX_VIRTQS];
405
406 /** Track which VirtIO queues we've attached to */
407 VIRTIONETVIRTQ aVirtqs[VIRTIONET_MAX_VIRTQS];
408
409 /** PDM device Instance name */
410 char szInst[16];
411
412 /** VirtIO features negotiated with the guest, including generic core and device specific */
413 uint64_t fNegotiatedFeatures;
414
415 /** Number of Rx/Tx queue pairs (only one if MQ feature not negotiated */
416 uint16_t cVirtqPairs;
417
418 /** Number of Rx/Tx queue pairs that have already been initialized */
419 uint16_t cInitializedVirtqPairs;
420
421 /** Number of virtqueues total (which includes each queue of each pair plus one control queue */
422 uint16_t cVirtqs;
423
424 /** Number of worker threads (one for the control queue and one for each Tx queue) */
425 uint16_t cWorkers;
426
427 /** Alignment */
428 uint16_t alignment;
429
430 /** Indicates transmission in progress -- only one thread is allowed. */
431 uint32_t uIsTransmitting;
432
433 /** Link up delay (in milliseconds). */
434 uint32_t cMsLinkUpDelay;
435
436 /** The number of actually used slots in aMacMulticastFilter. */
437 uint32_t cMulticastFilterMacs;
438
439 /** The number of actually used slots in aMacUniicastFilter. */
440 uint32_t cUnicastFilterMacs;
441
442 /** Semaphore leaf device's thread waits on until guest driver sends empty Rx bufs */
443 SUPSEMEVENT hEventRxDescAvail;
444
445 /** Array of MAC multicast addresses accepted by RX filter. */
446 RTMAC aMacMulticastFilter[VIRTIONET_MAC_FILTER_LEN];
447
448 /** Array of MAC unicast addresses accepted by RX filter. */
449 RTMAC aMacUnicastFilter[VIRTIONET_MAC_FILTER_LEN];
450
451 /** Default MAC address which rx filtering accepts */
452 RTMAC rxFilterMacDefault;
453
454 /** MAC address obtained from the configuration. */
455 RTMAC macConfigured;
456
457 /** Bit array of VLAN filter, one bit per VLAN ID. */
458 uint8_t aVlanFilter[VIRTIONET_MAX_VLAN_ID / sizeof(uint8_t)];
459
460 /** Set if PDM leaf device at the network interface is starved for Rx buffers */
461 bool volatile fLeafWantsEmptyRxBufs;
462
463 /** Number of packet being sent/received to show in debug log. */
464 uint32_t uPktNo;
465
466 /** Flags whether VirtIO core is in ready state */
467 uint8_t fVirtioReady;
468
469 /** Resetting flag */
470 uint8_t fResetting;
471
472 /** Promiscuous mode -- RX filter accepts all packets. */
473 uint8_t fPromiscuous;
474
475 /** All multicast mode -- RX filter accepts all multicast packets. */
476 uint8_t fAllMulticast;
477
478 /** All unicast mode -- RX filter accepts all unicast packets. */
479 uint8_t fAllUnicast;
480
481 /** No multicast mode - Supresses multicast receive */
482 uint8_t fNoMulticast;
483
484 /** No unicast mode - Suppresses unicast receive */
485 uint8_t fNoUnicast;
486
487 /** No broadcast mode - Supresses broadcast receive */
488 uint8_t fNoBroadcast;
489
490 /** Type of network pkt header based on guest driver version/features */
491 VIRTIONETPKTHDRTYPE ePktHdrType;
492
493 /** Size of network pkt header based on guest driver version/features */
494 uint16_t cbPktHdr;
495
496 /** True if physical cable is attached in configuration. */
497 bool fCableConnected;
498
499 /** True if this device should offer legacy virtio support to the guest */
500 bool fOfferLegacy;
501
502 /** @name Statistic
503 * @{ */
504 STAMCOUNTER StatReceiveBytes;
505 STAMCOUNTER StatTransmitBytes;
506 STAMCOUNTER StatReceiveGSO;
507 STAMCOUNTER StatTransmitPackets;
508 STAMCOUNTER StatTransmitGSO;
509 STAMCOUNTER StatTransmitCSum;
510#ifdef VBOX_WITH_STATISTICS
511 STAMPROFILE StatReceive;
512 STAMPROFILE StatReceiveStore;
513 STAMPROFILEADV StatTransmit;
514 STAMPROFILE StatTransmitSend;
515 STAMPROFILE StatRxOverflow;
516 STAMCOUNTER StatRxOverflowWakeup;
517 STAMCOUNTER StatTransmitByNetwork;
518 STAMCOUNTER StatTransmitByThread;
519 /** @} */
520#endif
521} VIRTIONET;
522/** Pointer to the shared state of the VirtIO Host NET device. */
523typedef VIRTIONET *PVIRTIONET;
524
525/**
526 * VirtIO Host NET device state, ring-3 edition.
527 *
528 * @extends VIRTIOCORER3
529 */
530typedef struct VIRTIONETR3
531{
532 /** The core virtio ring-3 state. */
533 VIRTIOCORER3 Virtio;
534
535 /** Per device-bound virtq worker-thread contexts (eventq slot unused) */
536 VIRTIONETWORKERR3 aWorkers[VIRTIONET_MAX_VIRTQS];
537
538 /** The device instance.
539 * @note This is _only_ for use whxen dealing with interface callbacks. */
540 PPDMDEVINSR3 pDevIns;
541
542 /** Status LUN: Base interface. */
543 PDMIBASE IBase;
544
545 /** Status LUN: LED port interface. */
546 PDMILEDPORTS ILeds;
547
548 /** Status LUN: LED connector (peer). */
549 R3PTRTYPE(PPDMILEDCONNECTORS) pLedsConnector;
550
551 /** Status: LED */
552 PDMLED led;
553
554 /** Attached network driver. */
555 R3PTRTYPE(PPDMIBASE) pDrvBase;
556
557 /** Network port interface (down) */
558 PDMINETWORKDOWN INetworkDown;
559
560 /** Network config port interface (main). */
561 PDMINETWORKCONFIG INetworkConfig;
562
563 /** Connector of attached network driver. */
564 R3PTRTYPE(PPDMINETWORKUP) pDrv;
565
566 /** Link Up(/Restore) Timer. */
567 TMTIMERHANDLE hLinkUpTimer;
568
569} VIRTIONETR3;
570
571/** Pointer to the ring-3 state of the VirtIO Host NET device. */
572typedef VIRTIONETR3 *PVIRTIONETR3;
573
574/**
575 * VirtIO Host NET device state, ring-0 edition.
576 */
577typedef struct VIRTIONETR0
578{
579 /** The core virtio ring-0 state. */
580 VIRTIOCORER0 Virtio;
581} VIRTIONETR0;
582/** Pointer to the ring-0 state of the VirtIO Host NET device. */
583typedef VIRTIONETR0 *PVIRTIONETR0;
584
585/**
586 * VirtIO Host NET device state, raw-mode edition.
587 */
588typedef struct VIRTIONETRC
589{
590 /** The core virtio raw-mode state. */
591 VIRTIOCORERC Virtio;
592} VIRTIONETRC;
593/** Pointer to the ring-0 state of the VirtIO Host NET device. */
594typedef VIRTIONETRC *PVIRTIONETRC;
595
596/** @typedef VIRTIONETCC
597 * The instance data for the current context. */
598typedef CTX_SUFF(VIRTIONET) VIRTIONETCC;
599
600/** @typedef PVIRTIONETCC
601 * Pointer to the instance data for the current context. */
602typedef CTX_SUFF(PVIRTIONET) PVIRTIONETCC;
603
604#ifdef IN_RING3
605static DECLCALLBACK(int) virtioNetR3WorkerThread(PPDMDEVINS pDevIns, PPDMTHREAD pThread);
606static int virtioNetR3CreateWorkerThreads(PPDMDEVINS, PVIRTIONET, PVIRTIONETCC);
607
608/**
609 * Helper function used when logging state of a VM thread.
610 *
611 * @param Thread
612 *
613 * @return Associated name of thread as a pointer to a zero-terminated string.
614 */
615DECLINLINE(const char *) virtioNetThreadStateName(PPDMTHREAD pThread)
616{
617 if (!pThread)
618 return "<null>";
619
620 switch(pThread->enmState)
621 {
622 case PDMTHREADSTATE_INVALID:
623 return "invalid state";
624 case PDMTHREADSTATE_INITIALIZING:
625 return "initializing";
626 case PDMTHREADSTATE_SUSPENDING:
627 return "suspending";
628 case PDMTHREADSTATE_SUSPENDED:
629 return "suspended";
630 case PDMTHREADSTATE_RESUMING:
631 return "resuming";
632 case PDMTHREADSTATE_RUNNING:
633 return "running";
634 case PDMTHREADSTATE_TERMINATING:
635 return "terminating";
636 case PDMTHREADSTATE_TERMINATED:
637 return "terminated";
638 default:
639 return "unknown state";
640 }
641}
642#endif
643
644/**
645 * Wakeup PDM managed downstream (e.g. hierarchically inferior device's) RX thread
646 */
647static DECLCALLBACK(void) virtioNetWakeupRxBufWaiter(PPDMDEVINS pDevIns)
648{
649 PVIRTIONET pThis = PDMDEVINS_2_DATA(pDevIns, PVIRTIONET);
650
651 AssertReturnVoid(pThis->hEventRxDescAvail != NIL_SUPSEMEVENT);
652
653 STAM_COUNTER_INC(&pThis->StatRxOverflowWakeup);
654 if (pThis->hEventRxDescAvail != NIL_SUPSEMEVENT)
655 {
656 Log10Func(("[%s] Waking downstream device's Rx buf waiter thread\n", pThis->szInst));
657 int rc = PDMDevHlpSUPSemEventSignal(pDevIns, pThis->hEventRxDescAvail);
658 AssertRC(rc);
659 }
660}
661
662/**
663 * Guest notifying us of its activity with a queue. Figure out which queue and respond accordingly.
664 *
665 * @callback_method_impl{VIRTIOCORER0,pfnVirtqNotified}
666 */
667static DECLCALLBACK(void) virtioNetVirtqNotified(PPDMDEVINS pDevIns, PVIRTIOCORE pVirtio, uint16_t uVirtqNbr)
668{
669 RT_NOREF(pVirtio);
670 PVIRTIONET pThis = PDMDEVINS_2_DATA(pDevIns, PVIRTIONET);
671
672 PVIRTIONETVIRTQ pVirtq = &pThis->aVirtqs[uVirtqNbr];
673 PVIRTIONETWORKER pWorker = &pThis->aWorkers[uVirtqNbr];
674
675#if defined (IN_RING3) && defined (LOG_ENABLED)
676 RTLogFlush(NULL);
677#endif
678 if (IS_RX_VIRTQ(uVirtqNbr))
679 {
680 uint16_t cBufsAvailable = virtioCoreVirtqAvailBufCount(pDevIns, pVirtio, uVirtqNbr);
681
682 if (cBufsAvailable)
683 {
684 Log10Func(("%s %u empty bufs added to %s by guest (notifying leaf device)\n",
685 pThis->szInst, cBufsAvailable, pVirtq->szName));
686 virtioNetWakeupRxBufWaiter(pDevIns);
687 }
688 else
689 Log10Func(("%s \n\n***WARNING: %s notified but no empty bufs added by guest! (skip leaf dev. notification)\n\n",
690 pThis->szInst, pVirtq->szName));
691 }
692 else if (IS_TX_VIRTQ(uVirtqNbr) || IS_CTRL_VIRTQ(uVirtqNbr))
693 {
694 /* Wake queue's worker thread up if sleeping (e.g. a Tx queue, or the control queue */
695 if (!ASMAtomicXchgBool(&pWorker->fNotified, true))
696 {
697 if (ASMAtomicReadBool(&pWorker->fSleeping))
698 {
699 Log10Func(("[%s] %s has available buffers - waking worker.\n", pThis->szInst, pVirtq->szName));
700
701 int rc = PDMDevHlpSUPSemEventSignal(pDevIns, pWorker->hEvtProcess);
702 AssertRC(rc);
703 }
704 else
705 Log10Func(("[%s] %s has available buffers - worker already awake\n", pThis->szInst, pVirtq->szName));
706 }
707 else
708 Log10Func(("[%s] %s has available buffers - waking worker.\n", pThis->szInst, pVirtq->szName));
709 }
710 else
711 LogRelFunc(("[%s] unrecognized queue %s (idx=%d) notified\n", pThis->szInst, pVirtq->szName, uVirtqNbr));
712}
713
714#ifdef IN_RING3 /* spans most of the file, at the moment. */
715
716/**
717 * @callback_method_impl{FNPDMTHREADWAKEUPDEV}
718 */
719static DECLCALLBACK(int) virtioNetR3WakeupWorker(PPDMDEVINS pDevIns, PPDMTHREAD pThread)
720{
721 PVIRTIONET pThis = PDMDEVINS_2_DATA(pDevIns, PVIRTIONET);
722 PVIRTIONETWORKER pWorker = (PVIRTIONETWORKER)pThread->pvUser;
723
724 Log10Func(("[%s]\n", pThis->szInst));
725 RT_NOREF(pThis);
726 return PDMDevHlpSUPSemEventSignal(pDevIns, pWorker->hEvtProcess);
727}
728
729/**
730 * Set queue names, distinguishing between modern or legacy mode.
731 *
732 * @note This makes it obvious during logging which mode this transitional device is
733 * operating in, legacy or modern.
734 *
735 * @param pThis Device specific device state
736 * @param fLegacy (input) true if running in legacy mode
737 * false if running in modern mode
738 */
739DECLINLINE(void) virtioNetR3SetVirtqNames(PVIRTIONET pThis, uint32_t fLegacy)
740{
741 RTStrCopy(pThis->aVirtqs[CTRLQIDX].szName, VIRTIO_MAX_VIRTQ_NAME_SIZE, fLegacy ? "legacy-ctrlq" : " modern-ctrlq");
742 for (uint16_t qPairIdx = 0; qPairIdx < pThis->cVirtqPairs; qPairIdx++)
743 {
744 RTStrPrintf(pThis->aVirtqs[RXQIDX(qPairIdx)].szName, VIRTIO_MAX_VIRTQ_NAME_SIZE, "%s-recvq<%d>", fLegacy ? "legacy" : "modern", qPairIdx);
745 RTStrPrintf(pThis->aVirtqs[TXQIDX(qPairIdx)].szName, VIRTIO_MAX_VIRTQ_NAME_SIZE, "%s-xmitq<%d>", fLegacy ? "legacy" : "modern", qPairIdx);
746 }
747}
748
749/**
750 * Dump a packet to debug log.
751 *
752 * @param pThis The virtio-net shared instance data.
753 * @param pbPacket The packet.
754 * @param cb The size of the packet.
755 * @param pszText A string denoting direction of packet transfer.
756 */
757DECLINLINE(void) virtioNetR3PacketDump(PVIRTIONET pThis, const uint8_t *pbPacket, size_t cb, const char *pszText)
758{
759#ifdef LOG_ENABLED
760 if (!LogIs12Enabled())
761 return;
762#endif
763 vboxEthPacketDump(pThis->szInst, pszText, pbPacket, (uint32_t)cb);
764}
765
766#ifdef LOG_ENABLED
767void virtioNetDumpGcPhysRxBuf(PPDMDEVINS pDevIns, PVIRTIONETPKTHDR pRxPktHdr,
768 uint16_t cVirtqBufs, uint8_t *pvBuf, uint16_t cb, RTGCPHYS GCPhysRxBuf, uint8_t cbRxBuf)
769{
770 PVIRTIONET pThis = PDMDEVINS_2_DATA(pDevIns, PVIRTIONET);
771 pRxPktHdr->uNumBuffers = cVirtqBufs;
772 if (pRxPktHdr)
773 {
774 LogFunc(("%*c\nrxPktHdr\n"
775 " uFlags ......... %2.2x\n uGsoType ....... %2.2x\n uHdrLen ........ %4.4x\n"
776 " uGsoSize ....... %4.4x\n uChksumStart ... %4.4x\n uChksumOffset .. %4.4x\n",
777 60, ' ', pRxPktHdr->uFlags, pRxPktHdr->uGsoType, pRxPktHdr->uHdrLen, pRxPktHdr->uGsoSize,
778 pRxPktHdr->uChksumStart, pRxPktHdr->uChksumOffset));
779 if (!virtioCoreIsLegacyMode(&pThis->Virtio) || FEATURE_ENABLED(MRG_RXBUF))
780 LogFunc((" uNumBuffers .... %4.4x\n", pRxPktHdr->uNumBuffers));
781 virtioCoreHexDump((uint8_t *)pRxPktHdr, sizeof(VIRTIONETPKTHDR), 0, "Dump of virtual rPktHdr");
782 }
783 virtioNetR3PacketDump(pThis, (const uint8_t *)pvBuf, cb, "<-- Incoming");
784 LogFunc((". . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .\n"));
785 virtioCoreGCPhysHexDump(pDevIns, GCPhysRxBuf, cbRxBuf, 0, "Phys Mem Dump of Rx pkt");
786 LogFunc(("%*c", 60, '-'));
787}
788
789#endif /* LOG_ENABLED */
790
791/**
792 * @callback_method_impl{FNDBGFHANDLERDEV, virtio-net debugger info callback.}
793 */
794static DECLCALLBACK(void) virtioNetR3Info(PPDMDEVINS pDevIns, PCDBGFINFOHLP pHlp, const char *pszArgs)
795{
796 PVIRTIONET pThis = PDMDEVINS_2_DATA(pDevIns, PVIRTIONET);
797 PVIRTIONETCC pThisCC = PDMDEVINS_2_DATA_CC(pDevIns, PVIRTIONETCC);
798
799 bool fNone = pszArgs && *pszArgs == '\0';
800 bool fAll = pszArgs && (*pszArgs == 'a' || *pszArgs == 'A'); /* "all" */
801 bool fNetwork = pszArgs && (*pszArgs == 'n' || *pszArgs == 'N'); /* "network" */
802 bool fFeatures = pszArgs && (*pszArgs == 'f' || *pszArgs == 'F'); /* "features" */
803 bool fState = pszArgs && (*pszArgs == 's' || *pszArgs == 'S'); /* "state" */
804 bool fPointers = pszArgs && (*pszArgs == 'p' || *pszArgs == 'P'); /* "pointers" */
805 bool fVirtqs = pszArgs && (*pszArgs == 'q' || *pszArgs == 'Q'); /* "queues */
806
807 /* Show basic information. */
808 pHlp->pfnPrintf(pHlp,
809 "\n"
810 "---------------------------------------------------------------------------\n"
811 "Debug Info: %s\n"
812 " (options: [a]ll, [n]et, [f]eatures, [s]tate, [p]ointers, [q]ueues)\n"
813 "---------------------------------------------------------------------------\n\n",
814 pThis->szInst);
815
816 if (fNone)
817 return;
818
819 /* Show offered/unoffered, accepted/rejected features */
820 if (fAll || fFeatures)
821 {
822 virtioCorePrintDeviceFeatures(&pThis->Virtio, pHlp, s_aDevSpecificFeatures,
823 RT_ELEMENTS(s_aDevSpecificFeatures));
824 pHlp->pfnPrintf(pHlp, "\n");
825 }
826
827 /* Show queues (and associate worker info if applicable) */
828 if (fAll || fVirtqs)
829 {
830 pHlp->pfnPrintf(pHlp, "Virtq information:\n\n");
831 for (int uVirtqNbr = 0; uVirtqNbr < pThis->cVirtqs; uVirtqNbr++)
832 {
833 PVIRTIONETVIRTQ pVirtq = &pThis->aVirtqs[uVirtqNbr];
834
835 if (pVirtq->fHasWorker)
836 {
837 PVIRTIONETWORKER pWorker = &pThis->aWorkers[uVirtqNbr];
838 PVIRTIONETWORKERR3 pWorkerR3 = &pThisCC->aWorkers[uVirtqNbr];
839
840 Assert((pWorker->uIdx == pVirtq->uIdx));
841 Assert((pWorkerR3->uIdx == pVirtq->uIdx));
842
843 if (pWorker->fAssigned)
844 {
845 pHlp->pfnPrintf(pHlp, " %-15s (pThread: %p %s) ",
846 pVirtq->szName,
847 pWorkerR3->pThread,
848 virtioNetThreadStateName(pWorkerR3->pThread));
849 if (pVirtq->fAttachedToVirtioCore)
850 {
851 pHlp->pfnPrintf(pHlp, "worker: ");
852 pHlp->pfnPrintf(pHlp, "%s", pWorker->fSleeping ? "blocking" : "unblocked");
853 pHlp->pfnPrintf(pHlp, "%s", pWorker->fNotified ? ", notified" : "");
854 }
855 else
856 if (pWorker->fNotified)
857 pHlp->pfnPrintf(pHlp, "not attached to virtio core");
858 }
859 }
860 else
861 {
862 pHlp->pfnPrintf(pHlp, " %-15s (INetworkDown's thread) %s", pVirtq->szName,
863 pVirtq->fAttachedToVirtioCore ? "" : "not attached to virtio core");
864 }
865 pHlp->pfnPrintf(pHlp, "\n");
866 virtioCoreR3VirtqInfo(pDevIns, pHlp, pszArgs, uVirtqNbr);
867 pHlp->pfnPrintf(pHlp, " ---------------------------------------------------------------------\n");
868 pHlp->pfnPrintf(pHlp, "\n");
869 }
870 pHlp->pfnPrintf(pHlp, "\n");
871 }
872
873 /* Show various pointers */
874 if (fAll || fPointers)
875 {
876 pHlp->pfnPrintf(pHlp, "Internal Pointers (for instance \"%s\"):\n\n", pThis->szInst);
877 pHlp->pfnPrintf(pHlp, " pDevIns ................... %p\n", pDevIns);
878 pHlp->pfnPrintf(pHlp, " PVIRTIOCORE ............... %p\n", &pThis->Virtio);
879 pHlp->pfnPrintf(pHlp, " PVIRTIONET ................ %p\n", pThis);
880 pHlp->pfnPrintf(pHlp, " PVIRTIONETCC .............. %p\n", pThisCC);
881 pHlp->pfnPrintf(pHlp, " VIRTIONETVIRTQ[] .......... %p\n", pThis->aVirtqs);
882 pHlp->pfnPrintf(pHlp, " pDrvBase .................. %p\n", pThisCC->pDrvBase);
883 pHlp->pfnPrintf(pHlp, " pDrv ...................... %p\n", pThisCC->pDrv);
884 pHlp->pfnPrintf(pHlp, "\n");
885 }
886
887 /* Show device state info */
888 if (fAll || fState)
889 {
890 pHlp->pfnPrintf(pHlp, "Device state:\n\n");
891 uint32_t fTransmitting = ASMAtomicReadU32(&pThis->uIsTransmitting);
892
893 pHlp->pfnPrintf(pHlp, " Transmitting: ............. %s\n", fTransmitting ? "true" : "false");
894 pHlp->pfnPrintf(pHlp, "\n");
895 pHlp->pfnPrintf(pHlp, "Misc state\n");
896 pHlp->pfnPrintf(pHlp, "\n");
897 pHlp->pfnPrintf(pHlp, " fOfferLegacy .............. %d\n", pThis->fOfferLegacy);
898 pHlp->pfnPrintf(pHlp, " fVirtioReady .............. %d\n", pThis->fVirtioReady);
899 pHlp->pfnPrintf(pHlp, " fResetting ................ %d\n", pThis->fResetting);
900 pHlp->pfnPrintf(pHlp, " fGenUpdatePending ......... %d\n", pThis->Virtio.fGenUpdatePending);
901 pHlp->pfnPrintf(pHlp, " fMsiSupport ............... %d\n", pThis->Virtio.fMsiSupport);
902 pHlp->pfnPrintf(pHlp, " uConfigGeneration ......... %d\n", pThis->Virtio.uConfigGeneration);
903 pHlp->pfnPrintf(pHlp, " uDeviceStatus ............. 0x%x\n", pThis->Virtio.fDeviceStatus);
904 pHlp->pfnPrintf(pHlp, " cVirtqPairs .,............. %d\n", pThis->cVirtqPairs);
905 pHlp->pfnPrintf(pHlp, " cVirtqs .,................. %d\n", pThis->cVirtqs);
906 pHlp->pfnPrintf(pHlp, " cWorkers .................. %d\n", pThis->cWorkers);
907 pHlp->pfnPrintf(pHlp, " MMIO mapping name ......... %d\n", pThisCC->Virtio.szMmioName);
908 pHlp->pfnPrintf(pHlp, "\n");
909 }
910
911 /* Show network related information */
912 if (fAll || fNetwork)
913 {
914 pHlp->pfnPrintf(pHlp, "Network configuration:\n\n");
915 pHlp->pfnPrintf(pHlp, " MAC: ...................... %RTmac\n", &pThis->macConfigured);
916 pHlp->pfnPrintf(pHlp, "\n");
917 pHlp->pfnPrintf(pHlp, " Cable: .................... %s\n", pThis->fCableConnected ? "connected" : "disconnected");
918 pHlp->pfnPrintf(pHlp, " Link-up delay: ............ %d ms\n", pThis->cMsLinkUpDelay);
919 pHlp->pfnPrintf(pHlp, "\n");
920 pHlp->pfnPrintf(pHlp, " Accept all multicast: ..... %s\n", pThis->fAllMulticast ? "true" : "false");
921 pHlp->pfnPrintf(pHlp, " Suppress broadcast: ....... %s\n", pThis->fNoBroadcast ? "true" : "false");
922 pHlp->pfnPrintf(pHlp, " Suppress unicast: ......... %s\n", pThis->fNoUnicast ? "true" : "false");
923 pHlp->pfnPrintf(pHlp, " Suppress multicast: ....... %s\n", pThis->fNoMulticast ? "true" : "false");
924 pHlp->pfnPrintf(pHlp, " Promiscuous: .............. %s\n", pThis->fPromiscuous ? "true" : "false");
925 pHlp->pfnPrintf(pHlp, "\n");
926 pHlp->pfnPrintf(pHlp, " Default Rx MAC filter: .... %RTmac\n", pThis->rxFilterMacDefault);
927 pHlp->pfnPrintf(pHlp, "\n");
928
929 pHlp->pfnPrintf(pHlp, " Unicast filter MACs:\n");
930
931 if (!pThis->cUnicastFilterMacs)
932 pHlp->pfnPrintf(pHlp, " <none>\n");
933
934 for (uint32_t i = 0; i < pThis->cUnicastFilterMacs; i++)
935 pHlp->pfnPrintf(pHlp, " %RTmac\n", &pThis->aMacUnicastFilter[i]);
936
937 pHlp->pfnPrintf(pHlp, "\n Multicast filter MACs:\n");
938
939 if (!pThis->cMulticastFilterMacs)
940 pHlp->pfnPrintf(pHlp, " <none>\n");
941
942 for (uint32_t i = 0; i < pThis->cMulticastFilterMacs; i++)
943 pHlp->pfnPrintf(pHlp, " %RTmac\n", &pThis->aMacMulticastFilter[i]);
944
945 pHlp->pfnPrintf(pHlp, "\n\n");
946 pHlp->pfnPrintf(pHlp, " Leaf starved: ............. %s\n", pThis->fLeafWantsEmptyRxBufs ? "true" : "false");
947 pHlp->pfnPrintf(pHlp, "\n");
948 }
949 /** @todo implement this
950 * pHlp->pfnPrintf(pHlp, "\n");
951 * virtioCoreR3Info(pDevIns, pHlp, pszArgs);
952 */
953 pHlp->pfnPrintf(pHlp, "\n");
954}
955
956/**
957 * Checks whether certain mutually dependent negotiated features are clustered in required combinations.
958 *
959 * @note See VirtIO 1.0 spec, Section 5.1.3.1
960 *
961 * @param fFeatures Bitmask of negotiated features to evaluate
962 *
963 * @returns true if valid feature combination(s) found.
964 * false if non-valid feature set.
965 */
966DECLINLINE(bool) virtioNetValidateRequiredFeatures(uint32_t fFeatures)
967{
968 uint32_t fGuestChksumRequired = fFeatures & VIRTIONET_F_GUEST_TSO4
969 || fFeatures & VIRTIONET_F_GUEST_TSO6
970 || fFeatures & VIRTIONET_F_GUEST_UFO;
971
972 uint32_t fHostChksumRequired = fFeatures & VIRTIONET_F_HOST_TSO4
973 || fFeatures & VIRTIONET_F_HOST_TSO6
974 || fFeatures & VIRTIONET_F_HOST_UFO;
975
976 uint32_t fCtrlVqRequired = fFeatures & VIRTIONET_F_CTRL_RX
977 || fFeatures & VIRTIONET_F_CTRL_VLAN
978 || fFeatures & VIRTIONET_F_GUEST_ANNOUNCE
979 || fFeatures & VIRTIONET_F_MQ
980 || fFeatures & VIRTIONET_F_CTRL_MAC_ADDR;
981
982 if (fGuestChksumRequired && !(fFeatures & VIRTIONET_F_GUEST_CSUM))
983 return false;
984
985 if (fHostChksumRequired && !(fFeatures & VIRTIONET_F_CSUM))
986 return false;
987
988 if (fCtrlVqRequired && !(fFeatures & VIRTIONET_F_CTRL_VQ))
989 return false;
990
991 if ( fFeatures & VIRTIONET_F_GUEST_ECN
992 && !( fFeatures & VIRTIONET_F_GUEST_TSO4
993 || fFeatures & VIRTIONET_F_GUEST_TSO6))
994 return false;
995
996 if ( fFeatures & VIRTIONET_F_HOST_ECN
997 && !( fFeatures & VIRTIONET_F_HOST_TSO4
998 || fFeatures & VIRTIONET_F_HOST_TSO6))
999 return false;
1000 return true;
1001}
1002
1003/**
1004 * Read or write device-specific configuration parameters.
1005 * This is called by VirtIO core code a guest-initiated MMIO access is made to access device-specific
1006 * configuration
1007 *
1008 * @note See VirtIO 1.0 spec, 2.3 Device Configuration Space
1009 *
1010 * @param pThis Pointer to device-specific state
1011 * @param uOffsetOfAccess Offset (within VIRTIONET_CONFIG_T)
1012 * @param pv Pointer to data to read or write
1013 * @param cb Number of bytes to read or write
1014 * @param fWrite True if writing, false if reading
1015 *
1016 * @returns VINF_SUCCESS if successful, or VINF_IOM_MMIO_UNUSED if fails (bad offset or size)
1017 */
1018static int virtioNetR3DevCfgAccess(PVIRTIONET pThis, uint32_t uOffsetOfAccess, void *pv, uint32_t cb, bool fWrite)
1019{
1020 AssertReturn(pv && cb <= sizeof(uint32_t), fWrite ? VINF_SUCCESS : VINF_IOM_MMIO_UNUSED_00);
1021
1022 if (VIRTIO_DEV_CONFIG_SUBMATCH_MEMBER( uMacAddress, VIRTIONET_CONFIG_T, uOffsetOfAccess))
1023 VIRTIO_DEV_CONFIG_ACCESS_READONLY( uMacAddress, VIRTIONET_CONFIG_T, uOffsetOfAccess, &pThis->virtioNetConfig);
1024#if FEATURE_OFFERED(STATUS)
1025 else
1026 if (VIRTIO_DEV_CONFIG_SUBMATCH_MEMBER( uStatus, VIRTIONET_CONFIG_T, uOffsetOfAccess))
1027 VIRTIO_DEV_CONFIG_ACCESS_READONLY( uStatus, VIRTIONET_CONFIG_T, uOffsetOfAccess, &pThis->virtioNetConfig);
1028#endif
1029#if FEATURE_OFFERED(MQ)
1030 else
1031 if (VIRTIO_DEV_CONFIG_MATCH_MEMBER( uMaxVirtqPairs, VIRTIONET_CONFIG_T, uOffsetOfAccess))
1032 VIRTIO_DEV_CONFIG_ACCESS_READONLY( uMaxVirtqPairs, VIRTIONET_CONFIG_T, uOffsetOfAccess, &pThis->virtioNetConfig);
1033#endif
1034 else
1035 {
1036 LogFunc(("%s Bad access by guest to virtio_net_config: off=%u (%#x), cb=%u\n",
1037 pThis->szInst, uOffsetOfAccess, uOffsetOfAccess, cb));
1038 return fWrite ? VINF_SUCCESS : VINF_IOM_MMIO_UNUSED_00;
1039 }
1040 return VINF_SUCCESS;
1041}
1042
1043/**
1044 * @callback_method_impl{VIRTIOCORER3,pfnDevCapRead}
1045 */
1046static DECLCALLBACK(int) virtioNetR3DevCapRead(PPDMDEVINS pDevIns, uint32_t uOffset, void *pv, uint32_t cb)
1047{
1048 PVIRTIONET pThis = PDMDEVINS_2_DATA(pDevIns, PVIRTIONET);
1049
1050 RT_NOREF(pThis);
1051 return virtioNetR3DevCfgAccess(PDMDEVINS_2_DATA(pDevIns, PVIRTIONET), uOffset, pv, cb, false /*fRead*/);
1052}
1053
1054/**
1055 * @callback_method_impl{VIRTIOCORER3,pfnDevCapWrite}
1056 */
1057static DECLCALLBACK(int) virtioNetR3DevCapWrite(PPDMDEVINS pDevIns, uint32_t uOffset, const void *pv, uint32_t cb)
1058{
1059 PVIRTIONET pThis = PDMDEVINS_2_DATA(pDevIns, PVIRTIONET);
1060
1061 Log10Func(("[%s] uOffset: %u, cb: %u: %.*Rhxs\n", pThis->szInst, uOffset, cb, cb, pv));
1062 RT_NOREF(pThis);
1063 return virtioNetR3DevCfgAccess(PDMDEVINS_2_DATA(pDevIns, PVIRTIONET), uOffset, (void *)pv, cb, true /*fWrite*/);
1064}
1065
1066static int virtioNetR3VirtqDestroy(PVIRTIOCORE pVirtio, PVIRTIONETVIRTQ pVirtq)
1067{
1068 PVIRTIONET pThis = RT_FROM_MEMBER(pVirtio, VIRTIONET, Virtio);
1069 PVIRTIONETCC pThisCC = PDMDEVINS_2_DATA_CC(pVirtio->pDevInsR3, PVIRTIONETCC);
1070 PVIRTIONETWORKER pWorker = &pThis->aWorkers[pVirtq->uIdx];
1071 PVIRTIONETWORKERR3 pWorkerR3 = &pThisCC->aWorkers[pVirtq->uIdx];
1072
1073 int rc = VINF_SUCCESS, rcThread;
1074 Log10Func(("[%s] Destroying \"%s\"", pThis->szInst, pVirtq->szName));
1075 if (pVirtq->fHasWorker)
1076 {
1077 Log10((" and its worker"));
1078 rc = PDMDevHlpThreadDestroy(pVirtio->pDevInsR3, pWorkerR3->pThread, &rcThread);
1079 AssertRCReturn(rc, rc);
1080 pWorkerR3->pThread = 0;
1081
1082 rc = PDMDevHlpSUPSemEventClose(pVirtio->pDevInsR3, pWorker->hEvtProcess);
1083 AssertRCReturn(rc, rc);
1084 pWorker->hEvtProcess = 0;
1085
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 */
1583static void 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 */
1598static void 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 int rc = virtioCoreR3VirtqAvailBufGet(pDevIns, &pThis->Virtio, pRxVirtq->uIdx, pVirtqBuf, true);
2011 AssertMsgReturn(rc == VINF_SUCCESS || rc == VERR_NOT_AVAILABLE, ("%Rrc\n", rc), rc);
2012 AssertMsgReturn(rc == VINF_SUCCESS && pVirtqBuf->cbPhysReturn,
2013 ("Not enough Rx buffers in queue to accomodate ethernet packet\n"),
2014 VERR_INTERNAL_ERROR);
2015 cbBufRemaining = pVirtqBuf->cbPhysReturn;
2016 }
2017 }
2018
2019 /* Fix-up pkthdr (in guest phys. memory) with number of buffers (descriptors) that were processed */
2020 int rc = virtioCoreGCPhysWrite(&pThis->Virtio, pDevIns, GCPhysNumBuffers, &cVirtqBufsUsed, sizeof(cVirtqBufsUsed));
2021 AssertMsgRCReturn(rc, ("Failure updating descriptor count in pkt hdr in guest physical memory\n"), rc);
2022
2023 virtioCoreVirtqUsedRingSync(pDevIns, &pThis->Virtio, pRxVirtq->uIdx);
2024 Log7(("\n"));
2025 return rc;
2026}
2027
2028/**
2029 * Pad and store received packet.
2030 *
2031 * @remarks Make sure that the packet appears to upper layer as one coming
2032 * from real Ethernet: pad it and insert FCS.
2033 *
2034 * @returns VBox status code.
2035 * @param pDevIns The device instance.
2036 * @param pThis The virtio-net shared instance data.
2037 * @param pvBuf The available data.
2038 * @param cb Number of bytes available in the buffer.
2039 * @param pGso Pointer to Global Segmentation Offload structure
2040 * @param pRxVirtq Pointer to Rx virtqueue
2041 * @thread RX
2042 */
2043
2044static int virtioNetR3CopyRxPktToGuest(PPDMDEVINS pDevIns, PVIRTIONET pThis, PVIRTIONETCC pThisCC, const void *pvBuf, size_t cb,
2045 PVIRTIONETPKTHDR pRxPktHdr, uint8_t cbPktHdr, PVIRTIONETVIRTQ pRxVirtq)
2046{
2047 RT_NOREF(pThisCC);
2048 VIRTQBUF_T VirtqBuf;
2049
2050 VirtqBuf.u32Magic = VIRTQBUF_MAGIC;
2051 VirtqBuf.cRefs = 1;
2052
2053 PVIRTQBUF pVirtqBuf = &VirtqBuf;
2054 int rc = virtioCoreR3VirtqAvailBufGet(pDevIns, &pThis->Virtio, pRxVirtq->uIdx, pVirtqBuf, true);
2055 AssertMsgReturn(rc == VINF_SUCCESS || rc == VERR_NOT_AVAILABLE, ("%Rrc\n", rc), rc);
2056 AssertMsgReturn(rc == VINF_SUCCESS && pVirtqBuf->cbPhysReturn,
2057 ("Not enough Rx buffers or capacity to accommodate ethernet packet\n"),
2058 VERR_INTERNAL_ERROR);
2059
2060 /*
2061 * Try to do fast (e.g. single-buffer) copy to guest, even if MRG_RXBUF feature is enabled
2062 */
2063 STAM_PROFILE_START(&pThis->StatReceiveStore, a);
2064 if (RT_LIKELY(FEATURE_DISABLED(MRG_RXBUF))
2065 || RT_LIKELY(pVirtqBuf->cbPhysReturn > cb + cbPktHdr))
2066 {
2067 Log7Func(("Send Rx packet header and data to guest (single-buffer copy)...\n"));
2068 pRxPktHdr->uNumBuffers = 1;
2069 rc = virtioCoreR3VirtqUsedBufPut(pDevIns, &pThis->Virtio, pRxVirtq->uIdx, cbPktHdr, pRxPktHdr, pVirtqBuf, 0 /* cbEnqueue */);
2070 if (rc == VINF_SUCCESS)
2071 rc = virtioCoreR3VirtqUsedBufPut(pDevIns, &pThis->Virtio, pRxVirtq->uIdx, cb, pvBuf, pVirtqBuf, cbPktHdr + cb /* cbEnqueue */);
2072 virtioCoreVirtqUsedRingSync(pDevIns, &pThis->Virtio, pRxVirtq->uIdx);
2073 AssertMsgReturn(rc == VINF_SUCCESS, ("%Rrc\n", rc), rc);
2074 }
2075 else
2076 {
2077 Log7Func(("Send Rx pkt to guest (merged-buffer copy [MRG_RXBUF feature])...\n"));
2078 rc = virtioNetR3RxPktMultibufXfer(pDevIns, pThis, (uint8_t *)pvBuf, cb, pRxPktHdr, pRxVirtq, pVirtqBuf);
2079 return rc;
2080 }
2081 STAM_PROFILE_STOP(&pThis->StatReceiveStore, a);
2082 return VINF_SUCCESS;
2083}
2084
2085/**
2086 * @interface_method_impl{PDMINETWORKDOWN,pfnReceiveGso}
2087 */
2088static DECLCALLBACK(int) virtioNetR3NetworkDown_ReceiveGso(PPDMINETWORKDOWN pInterface, const void *pvBuf, size_t cb,
2089 PCPDMNETWORKGSO pGso)
2090{
2091 PVIRTIONETCC pThisCC = RT_FROM_MEMBER(pInterface, VIRTIONETCC, INetworkDown);
2092 PPDMDEVINS pDevIns = pThisCC->pDevIns;
2093 PVIRTIONET pThis = PDMDEVINS_2_DATA(pDevIns, PVIRTIONET);
2094 VIRTIONETPKTHDR rxPktHdr = { 0, VIRTIONET_HDR_GSO_NONE, 0, 0, 0, 0, 0 };
2095
2096 if (!pThis->fVirtioReady)
2097 {
2098 LogRelFunc(("VirtIO not ready, aborting downstream receive\n"));
2099 return VERR_INTERRUPTED;
2100 }
2101 /*
2102 * If GSO (Global Segment Offloading) was received from downstream PDM network device, massage the
2103 * PDM-provided GSO parameters into VirtIO semantics, which get passed to guest virtio-net via
2104 * Rx pkt header. See VirtIO 1.1, 5.1.6 Device Operation for more information.
2105 */
2106 if (pGso)
2107 {
2108 LogFunc(("[%s] (%RTmac) \n", pThis->szInst, pvBuf));
2109
2110 rxPktHdr.uFlags = VIRTIONET_HDR_F_NEEDS_CSUM;
2111 rxPktHdr.uHdrLen = pGso->cbHdrsTotal;
2112 rxPktHdr.uGsoSize = pGso->cbMaxSeg;
2113 rxPktHdr.uChksumStart = pGso->offHdr2;
2114
2115 switch (pGso->u8Type)
2116 {
2117 case PDMNETWORKGSOTYPE_IPV4_TCP:
2118 rxPktHdr.uGsoType = VIRTIONET_HDR_GSO_TCPV4;
2119 rxPktHdr.uChksumOffset = RT_OFFSETOF(RTNETTCP, th_sum);
2120 break;
2121 case PDMNETWORKGSOTYPE_IPV6_TCP:
2122 rxPktHdr.uGsoType = VIRTIONET_HDR_GSO_TCPV6;
2123 rxPktHdr.uChksumOffset = RT_OFFSETOF(RTNETTCP, th_sum);
2124 break;
2125 case PDMNETWORKGSOTYPE_IPV4_UDP:
2126 rxPktHdr.uGsoType = VIRTIONET_HDR_GSO_UDP;
2127 rxPktHdr.uChksumOffset = RT_OFFSETOF(RTNETUDP, uh_sum);
2128 break;
2129 default:
2130 LogFunc(("[%s] GSO type (0x%x) not supported\n", pThis->szInst, pGso->u8Type));
2131 return VERR_NOT_SUPPORTED;
2132 }
2133 STAM_REL_COUNTER_INC(&pThis->StatReceiveGSO);
2134 Log2Func(("[%s] gso type=%#x, cbHdrsTotal=%u cbHdrsSeg=%u mss=%u offHdr1=%#x offHdr2=%#x\n",
2135 pThis->szInst, pGso->u8Type, pGso->cbHdrsTotal, pGso->cbHdrsSeg,
2136 pGso->cbMaxSeg, pGso->offHdr1, pGso->offHdr2));
2137 }
2138
2139 /*
2140 * Find a virtq with Rx bufs on avail ring, if any, and copy the packet to the guest's Rx buffer.
2141 * @todo pk: PROBABLY NOT A SOPHISTICATED ENOUGH QUEUE SELECTION ALGORTITH FOR OPTIMAL MQ (FEATURE) SUPPORT
2142 */
2143 for (int uVirtqPair = 0; uVirtqPair < pThis->cVirtqPairs; uVirtqPair++)
2144 {
2145 PVIRTIONETVIRTQ pRxVirtq = &pThis->aVirtqs[RXQIDX(uVirtqPair)];
2146 if (RT_SUCCESS(virtioNetR3CheckRxBufsAvail(pDevIns, pThis, pRxVirtq)))
2147 {
2148 int rc = VINF_SUCCESS;
2149 STAM_PROFILE_START(&pThis->StatReceive, a);
2150 virtioNetR3SetReadLed(pThisCC, true);
2151 if (virtioNetR3AddressFilter(pThis, pvBuf, cb))
2152 {
2153 /* rxPktHdr is local stack variable that should not go out of scope in this use */
2154 rc = virtioNetR3CopyRxPktToGuest(pDevIns, pThis, pThisCC, pvBuf, cb, &rxPktHdr, pThis->cbPktHdr, pRxVirtq);
2155 STAM_REL_COUNTER_ADD(&pThis->StatReceiveBytes, cb);
2156 }
2157 virtioNetR3SetReadLed(pThisCC, false);
2158 STAM_PROFILE_STOP(&pThis->StatReceive, a);
2159 return rc;
2160 }
2161 }
2162 return VERR_INTERRUPTED;
2163}
2164
2165/**
2166 * @interface_method_impl{PDMINETWORKDOWN,pfnReceive}
2167 */
2168static DECLCALLBACK(int) virtioNetR3NetworkDown_Receive(PPDMINETWORKDOWN pInterface, const void *pvBuf, size_t cb)
2169{
2170
2171#ifdef LOG_ENABLED
2172 PVIRTIONETCC pThisCC = RT_FROM_MEMBER(pInterface, VIRTIONETCC, INetworkDown);
2173 PPDMDEVINS pDevIns = pThisCC->pDevIns;
2174 PVIRTIONET pThis = PDMDEVINS_2_DATA(pDevIns, PVIRTIONET);
2175 LogFunc(("[%s] (%RTmac)\n", pThis->szInst, pvBuf));
2176#endif
2177
2178 return virtioNetR3NetworkDown_ReceiveGso(pInterface, pvBuf, cb, NULL);
2179}
2180
2181/*
2182 * Dispatched to here from virtioNetR3Ctrl() to configure this virtio-net device's Rx packet receive filtering.
2183 * See VirtIO 1.0, 5.1.6.5.1
2184 *
2185 * @param pThis virtio-net instance
2186 * @param pCtrlPktHdr Control packet header (which includes command parameters)
2187 * @param pVirtqBuf Buffer from ctrlq buffer (contains command data)
2188 */
2189static uint8_t virtioNetR3CtrlRx(PVIRTIONET pThis, PVIRTIONETCC pThisCC,
2190 PVIRTIONET_CTRL_HDR_T pCtrlPktHdr, PVIRTQBUF pVirtqBuf)
2191{
2192
2193#define LOG_VIRTIONET_FLAG(fld) LogFunc(("[%s] Setting %s=%d\n", pThis->szInst, #fld, pThis->fld))
2194
2195 LogFunc(("[%s] Processing CTRL Rx command\n", pThis->szInst));
2196 switch(pCtrlPktHdr->uCmd)
2197 {
2198 case VIRTIONET_CTRL_RX_PROMISC:
2199 break;
2200 case VIRTIONET_CTRL_RX_ALLMULTI:
2201 break;
2202 case VIRTIONET_CTRL_RX_ALLUNI:
2203 /* fallthrough */
2204 case VIRTIONET_CTRL_RX_NOMULTI:
2205 /* fallthrough */
2206 case VIRTIONET_CTRL_RX_NOUNI:
2207 /* fallthrough */
2208 case VIRTIONET_CTRL_RX_NOBCAST:
2209 AssertMsgReturn(FEATURE_ENABLED(CTRL_RX_EXTRA),
2210 ("CTRL 'extra' cmd w/o VIRTIONET_F_CTRL_RX_EXTRA feature negotiated - skipping\n"),
2211 VIRTIONET_ERROR);
2212 /* fall out */
2213 }
2214
2215 uint8_t fOn, fPromiscChanged = false;
2216 virtioCoreR3VirtqBufDrain(&pThis->Virtio, pVirtqBuf, &fOn, (size_t)RT_MIN(pVirtqBuf->cbPhysSend, sizeof(fOn)));
2217
2218 switch(pCtrlPktHdr->uCmd)
2219 {
2220 case VIRTIONET_CTRL_RX_PROMISC:
2221 pThis->fPromiscuous = RT_BOOL(fOn);
2222 fPromiscChanged = true;
2223 LOG_VIRTIONET_FLAG(fPromiscuous);
2224 break;
2225 case VIRTIONET_CTRL_RX_ALLMULTI:
2226 pThis->fAllMulticast = RT_BOOL(fOn);
2227 fPromiscChanged = true;
2228 LOG_VIRTIONET_FLAG(fAllMulticast);
2229 break;
2230 case VIRTIONET_CTRL_RX_ALLUNI:
2231 pThis->fAllUnicast = RT_BOOL(fOn);
2232 LOG_VIRTIONET_FLAG(fAllUnicast);
2233 break;
2234 case VIRTIONET_CTRL_RX_NOMULTI:
2235 pThis->fNoMulticast = RT_BOOL(fOn);
2236 LOG_VIRTIONET_FLAG(fNoMulticast);
2237 break;
2238 case VIRTIONET_CTRL_RX_NOUNI:
2239 pThis->fNoUnicast = RT_BOOL(fOn);
2240 LOG_VIRTIONET_FLAG(fNoUnicast);
2241 break;
2242 case VIRTIONET_CTRL_RX_NOBCAST:
2243 pThis->fNoBroadcast = RT_BOOL(fOn);
2244 LOG_VIRTIONET_FLAG(fNoBroadcast);
2245 break;
2246 }
2247
2248 if (pThisCC->pDrv && fPromiscChanged)
2249 pThisCC->pDrv->pfnSetPromiscuousMode(pThisCC->pDrv, (pThis->fPromiscuous || pThis->fAllMulticast));
2250
2251 return VIRTIONET_OK;
2252}
2253
2254/*
2255 * Dispatched to here from virtioNetR3Ctrl() to configure this virtio-net device's MAC filter tables
2256 * See VirtIO 1.0, 5.1.6.5.2
2257 *
2258 * @param pThis virtio-net instance
2259 * @param pCtrlPktHdr Control packet header (which includes command parameters)
2260 * @param pVirtqBuf Buffer from ctrlq buffer (contains command data)
2261 */
2262static uint8_t virtioNetR3CtrlMac(PVIRTIONET pThis, PVIRTIONET_CTRL_HDR_T pCtrlPktHdr, PVIRTQBUF pVirtqBuf)
2263{
2264 LogFunc(("[%s] Processing CTRL MAC command\n", pThis->szInst));
2265
2266
2267 AssertMsgReturn(pVirtqBuf->cbPhysSend >= sizeof(*pCtrlPktHdr),
2268 ("insufficient descriptor space for ctrl pkt hdr"),
2269 VIRTIONET_ERROR);
2270
2271 size_t cbRemaining = pVirtqBuf->cbPhysSend;
2272 switch(pCtrlPktHdr->uCmd)
2273 {
2274 case VIRTIONET_CTRL_MAC_ADDR_SET:
2275 {
2276 /* Set default Rx filter MAC */
2277 AssertMsgReturn(cbRemaining >= sizeof(pThis->rxFilterMacDefault),
2278 ("DESC chain too small to process CTRL_MAC_ADDR_SET cmd\n"), VIRTIONET_ERROR);
2279
2280 virtioCoreR3VirtqBufDrain(&pThis->Virtio, pVirtqBuf, &pThis->rxFilterMacDefault, sizeof(RTMAC));
2281 break;
2282 }
2283 case VIRTIONET_CTRL_MAC_TABLE_SET:
2284 {
2285 VIRTIONET_CTRL_MAC_TABLE_LEN cMacs;
2286
2287 /* Load unicast MAC filter table */
2288 AssertMsgReturn(cbRemaining >= sizeof(cMacs),
2289 ("DESC chain too small to process CTRL_MAC_TABLE_SET cmd\n"), VIRTIONET_ERROR);
2290
2291 /* Fetch count of unicast filter MACs from guest buffer */
2292 virtioCoreR3VirtqBufDrain(&pThis->Virtio, pVirtqBuf, &cMacs, sizeof(cMacs));
2293 cbRemaining -= sizeof(cMacs);
2294
2295 Log7Func(("[%s] Guest provided %d unicast MAC Table entries\n", pThis->szInst, cMacs));
2296
2297 AssertMsgReturn(cMacs <= RT_ELEMENTS(pThis->aMacUnicastFilter),
2298 ("Guest provided Unicast MAC filter table exceeds hardcoded table size"), VIRTIONET_ERROR);
2299
2300 if (cMacs)
2301 {
2302 uint32_t cbMacs = cMacs * sizeof(RTMAC);
2303
2304 AssertMsgReturn(cbRemaining >= cbMacs,
2305 ("Virtq buffer too small to process CTRL_MAC_TABLE_SET cmd\n"), VIRTIONET_ERROR);
2306
2307
2308 /* Fetch unicast table contents from guest buffer */
2309 virtioCoreR3VirtqBufDrain(&pThis->Virtio, pVirtqBuf, &pThis->aMacUnicastFilter, cbMacs);
2310 cbRemaining -= cbMacs;
2311 }
2312 pThis->cUnicastFilterMacs = cMacs;
2313
2314 /* Load multicast MAC filter table */
2315 AssertMsgReturn(cbRemaining >= sizeof(cMacs),
2316 ("Virtq buffer too small to process CTRL_MAC_TABLE_SET cmd\n"), VIRTIONET_ERROR);
2317
2318 /* Fetch count of multicast filter MACs from guest buffer */
2319 virtioCoreR3VirtqBufDrain(&pThis->Virtio, pVirtqBuf, &cMacs, sizeof(cMacs));
2320 cbRemaining -= sizeof(cMacs);
2321
2322 Log10Func(("[%s] Guest provided %d multicast MAC Table entries\n", pThis->szInst, cMacs));
2323
2324 AssertMsgReturn(cMacs <= RT_ELEMENTS(pThis->aMacMulticastFilter),
2325 ("Guest provided Unicast MAC filter table exceeds hardcoded table size"), VIRTIONET_ERROR);
2326
2327 if (cMacs)
2328 {
2329 uint32_t cbMacs = cMacs * sizeof(RTMAC);
2330
2331 AssertMsgReturn(cbRemaining >= cbMacs,
2332 ("Virtq buffer too small to process CTRL_MAC_TABLE_SET cmd\n"), VIRTIONET_ERROR);
2333
2334 /* Fetch multicast table contents from guest buffer */
2335 virtioCoreR3VirtqBufDrain(&pThis->Virtio, pVirtqBuf, &pThis->aMacMulticastFilter, cbMacs);
2336 cbRemaining -= cbMacs;
2337 }
2338 pThis->cMulticastFilterMacs = cMacs;
2339
2340#ifdef LOG_ENABLED
2341 LogFunc(("[%s] unicast MACs:\n", pThis->szInst));
2342 for(unsigned i = 0; i < pThis->cUnicastFilterMacs; i++)
2343 LogFunc((" %RTmac\n", &pThis->aMacUnicastFilter[i]));
2344
2345 LogFunc(("[%s] multicast MACs:\n", pThis->szInst));
2346 for(unsigned i = 0; i < pThis->cMulticastFilterMacs; i++)
2347 LogFunc((" %RTmac\n", &pThis->aMacMulticastFilter[i]));
2348#endif
2349 break;
2350 }
2351 default:
2352 LogRelFunc(("Unrecognized MAC subcommand in CTRL pkt from guest\n"));
2353 return VIRTIONET_ERROR;
2354 }
2355 return VIRTIONET_OK;
2356}
2357
2358/*
2359 * Dispatched to here from virtioNetR3Ctrl() to configure this virtio-net device's MQ (multiqueue) operations.
2360 * See VirtIO 1.0, 5.1.6.5.5
2361 *
2362 * @param pThis virtio-net instance
2363 * @param pCtrlPktHdr Control packet header (which includes command parameters)
2364 * @param pVirtqBuf Buffer from ctrlq buffer (contains command data)
2365 */
2366static uint8_t virtioNetR3CtrlMultiQueue(PVIRTIONET pThis, PVIRTIONETCC pThisCC, PPDMDEVINS pDevIns, PVIRTIONET_CTRL_HDR_T pCtrlPktHdr, PVIRTQBUF pVirtqBuf)
2367{
2368 LogFunc(("[%s] Processing CTRL MQ command\n", pThis->szInst));
2369
2370 uint16_t cVirtqPairs;
2371 switch(pCtrlPktHdr->uCmd)
2372 {
2373 case VIRTIONET_CTRL_MQ_VQ_PAIRS_SET:
2374 {
2375 size_t cbRemaining = pVirtqBuf->cbPhysSend;
2376
2377 AssertMsgReturn(cbRemaining >= sizeof(cVirtqPairs),
2378 ("DESC chain too small for VIRTIONET_CTRL_MQ cmd processing"), VIRTIONET_ERROR);
2379
2380 /* Fetch number of virtq pairs from guest buffer */
2381 virtioCoreR3VirtqBufDrain(&pThis->Virtio, pVirtqBuf, &cVirtqPairs, sizeof(cVirtqPairs));
2382
2383 AssertMsgReturn(cVirtqPairs <= VIRTIONET_MAX_QPAIRS,
2384 ("[%s] Guest CTRL MQ virtq pair count out of range [%d])\n", pThis->szInst, cVirtqPairs), VIRTIONET_ERROR);
2385
2386 LogFunc(("[%s] Guest specifies %d VQ pairs in use\n", pThis->szInst, cVirtqPairs));
2387 pThis->cVirtqPairs = cVirtqPairs;
2388 break;
2389 }
2390 default:
2391 LogRelFunc(("Unrecognized multiqueue subcommand in CTRL pkt from guest\n"));
2392 return VIRTIONET_ERROR;
2393 }
2394
2395 /*
2396 * The MQ control function is invoked by the guest in an RPC like manner to change
2397 * the Rx/Tx queue pair count. If the new value exceeds the number of queues
2398 * (and associated workers) already initialized initialize only the new queues and
2399 * respective workers.
2400 */
2401 if (pThis->cVirtqPairs > pThis->cInitializedVirtqPairs)
2402 {
2403 virtioNetR3SetVirtqNames(pThis, virtioCoreIsLegacyMode(&pThis->Virtio));
2404 int rc = virtioNetR3CreateWorkerThreads(pDevIns, pThis, pThisCC);
2405 if (RT_FAILURE(rc))
2406 {
2407 LogRelFunc(("Failed to create worker threads\n"));
2408 return VIRTIONET_ERROR;
2409 }
2410 }
2411 return VIRTIONET_OK;
2412}
2413
2414/*
2415 * Dispatched to here from virtioNetR3Ctrl() to configure this virtio-net device's VLAN filtering.
2416 * See VirtIO 1.0, 5.1.6.5.3
2417 *
2418 * @param pThis virtio-net instance
2419 * @param pCtrlPktHdr Control packet header (which includes command parameters)
2420 * @param pVirtqBuf Buffer from ctrlq buffer (contains command data)
2421 */
2422static uint8_t virtioNetR3CtrlVlan(PVIRTIONET pThis, PVIRTIONET_CTRL_HDR_T pCtrlPktHdr, PVIRTQBUF pVirtqBuf)
2423{
2424 LogFunc(("[%s] Processing CTRL VLAN command\n", pThis->szInst));
2425
2426 uint16_t uVlanId;
2427 size_t cbRemaining = pVirtqBuf->cbPhysSend;
2428
2429 AssertMsgReturn(cbRemaining >= sizeof(uVlanId),
2430 ("DESC chain too small for VIRTIONET_CTRL_VLAN cmd processing"), VIRTIONET_ERROR);
2431
2432 /* Fetch VLAN ID from guest buffer */
2433 virtioCoreR3VirtqBufDrain(&pThis->Virtio, pVirtqBuf, &uVlanId, sizeof(uVlanId));
2434
2435 AssertMsgReturn(uVlanId < VIRTIONET_MAX_VLAN_ID,
2436 ("%s VLAN ID out of range (VLAN ID=%u)\n", pThis->szInst, uVlanId), VIRTIONET_ERROR);
2437
2438 LogFunc(("[%s] uCommand=%u VLAN ID=%u\n", pThis->szInst, pCtrlPktHdr->uCmd, uVlanId));
2439
2440 switch (pCtrlPktHdr->uCmd)
2441 {
2442 case VIRTIONET_CTRL_VLAN_ADD:
2443 ASMBitSet(pThis->aVlanFilter, uVlanId);
2444 break;
2445 case VIRTIONET_CTRL_VLAN_DEL:
2446 ASMBitClear(pThis->aVlanFilter, uVlanId);
2447 break;
2448 default:
2449 LogRelFunc(("Unrecognized VLAN subcommand in CTRL pkt from guest\n"));
2450 return VIRTIONET_ERROR;
2451 }
2452 return VIRTIONET_OK;
2453}
2454
2455/**
2456 * Processes control command from guest.
2457 * See VirtIO 1.0 spec, 5.1.6 "Device Operation" and 5.1.6.5 "Control Virtqueue".
2458 *
2459 * The control command is contained in a virtio buffer pulled from the virtio-net defined control queue (ctrlq).
2460 * Command type is parsed is dispatched to a command-specific device-configuration handler function (e.g. RX, MAC, VLAN, MQ
2461 * and ANNOUNCE).
2462 *
2463 * This function handles all parts of the host-side of the ctrlq round-trip buffer processing.
2464 *
2465 * Invoked by worker for virtio-net control queue to process a queued control command buffer.
2466 *
2467 * @param pDevIns PDM device instance
2468 * @param pThis virtio-net device instance
2469 * @param pThisCC virtio-net device instance
2470 * @param pVirtqBuf pointer to buffer pulled from virtq (input to this function)
2471 */
2472static void virtioNetR3Ctrl(PPDMDEVINS pDevIns, PVIRTIONET pThis, PVIRTIONETCC pThisCC,
2473 PVIRTQBUF pVirtqBuf)
2474{
2475 if (!(pThis->fNegotiatedFeatures & VIRTIONET_F_CTRL_VQ))
2476 LogFunc(("[%s] WARNING: Guest using CTRL queue w/o negotiating VIRTIONET_F_CTRL_VQ feature\n", pThis->szInst));
2477
2478 LogFunc(("[%s] Received CTRL packet from guest\n", pThis->szInst));
2479
2480 if (pVirtqBuf->cbPhysSend < 2)
2481 {
2482 LogFunc(("[%s] CTRL packet from guest driver incomplete. Skipping ctrl cmd\n", pThis->szInst));
2483 return;
2484 }
2485 else if (pVirtqBuf->cbPhysReturn < sizeof(VIRTIONET_CTRL_HDR_T_ACK))
2486 {
2487 LogFunc(("[%s] Guest driver didn't allocate memory to receive ctrl pkt ACK. Skipping ctrl cmd\n", pThis->szInst));
2488 return;
2489 }
2490
2491 /*
2492 * Allocate buffer and read in the control command
2493 */
2494 VIRTIONET_CTRL_HDR_T CtrlPktHdr; RT_ZERO(CtrlPktHdr);
2495 AssertLogRelMsgReturnVoid(pVirtqBuf->cbPhysSend >= sizeof(CtrlPktHdr),
2496 ("DESC chain too small for CTRL pkt header"));
2497 virtioCoreR3VirtqBufDrain(&pThis->Virtio, pVirtqBuf, &CtrlPktHdr, sizeof(CtrlPktHdr));
2498
2499 Log7Func(("[%s] CTRL COMMAND: class=%d command=%d\n", pThis->szInst, CtrlPktHdr.uClass, CtrlPktHdr.uCmd));
2500
2501 uint8_t uAck;
2502 switch (CtrlPktHdr.uClass)
2503 {
2504 case VIRTIONET_CTRL_RX:
2505 uAck = virtioNetR3CtrlRx(pThis, pThisCC, &CtrlPktHdr, pVirtqBuf);
2506 break;
2507 case VIRTIONET_CTRL_MAC:
2508 uAck = virtioNetR3CtrlMac(pThis, &CtrlPktHdr, pVirtqBuf);
2509 break;
2510 case VIRTIONET_CTRL_VLAN:
2511 uAck = virtioNetR3CtrlVlan(pThis, &CtrlPktHdr, pVirtqBuf);
2512 break;
2513 case VIRTIONET_CTRL_MQ:
2514 uAck = virtioNetR3CtrlMultiQueue(pThis, pThisCC, pDevIns, &CtrlPktHdr, pVirtqBuf);
2515 break;
2516 case VIRTIONET_CTRL_ANNOUNCE:
2517 uAck = VIRTIONET_OK;
2518 if (FEATURE_DISABLED(STATUS) || FEATURE_DISABLED(GUEST_ANNOUNCE))
2519 {
2520 LogFunc(("%s Ignoring CTRL class VIRTIONET_CTRL_ANNOUNCE.\n"
2521 "VIRTIO_F_STATUS or VIRTIO_F_GUEST_ANNOUNCE feature not enabled\n", pThis->szInst));
2522 break;
2523 }
2524 if (CtrlPktHdr.uCmd != VIRTIONET_CTRL_ANNOUNCE_ACK)
2525 {
2526 LogFunc(("[%s] Ignoring CTRL class VIRTIONET_CTRL_ANNOUNCE. Unrecognized uCmd\n", pThis->szInst));
2527 break;
2528 }
2529#if FEATURE_OFFERED(STATUS)
2530 pThis->virtioNetConfig.uStatus &= ~VIRTIONET_F_ANNOUNCE;
2531#endif
2532 Log7Func(("[%s] Clearing VIRTIONET_F_ANNOUNCE in config status\n", pThis->szInst));
2533 break;
2534 default:
2535 LogRelFunc(("Unrecognized CTRL pkt hdr class (%d)\n", CtrlPktHdr.uClass));
2536 uAck = VIRTIONET_ERROR;
2537 }
2538
2539 /* Return CTRL packet Ack byte (result code) to guest driver */
2540 RTSGSEG aStaticSegs[] = { { &uAck, sizeof(uAck) } };
2541 RTSGBUF SgBuf;
2542
2543 RTSgBufInit(&SgBuf, aStaticSegs, RT_ELEMENTS(aStaticSegs));
2544 virtioCoreR3VirtqUsedBufPut(pDevIns, &pThis->Virtio, CTRLQIDX, &SgBuf, pVirtqBuf, true /* fFence */);
2545 virtioCoreVirtqUsedRingSync(pDevIns, &pThis->Virtio, CTRLQIDX);
2546
2547 LogFunc(("%s Finished processing CTRL command with status %s\n",
2548 pThis->szInst, uAck == VIRTIONET_OK ? "VIRTIONET_OK" : "VIRTIONET_ERROR"));
2549}
2550
2551/**
2552 * Reads virtio-net pkt header from provided Phy. addr of virtio descriptor chain
2553 * (e.g. S/G segment from guest-driver provided buffer pulled from Tx virtq)
2554 * Verifies state and supported modes, sets TCP header size.
2555 *
2556 * @param pVirtio VirtIO core instance data
2557 * @param pThis virtio-net instance
2558 * @param pDevIns PDM device instance
2559 * @param GCPhys Phys. Address from where to read virtio-net pkt header
2560 * @param pPktHdr Where to store read Tx pkt hdr (virtio pkt hdr size is determined from instance configuration)
2561 * @param cbFrame Total pkt frame size to inform bounds check
2562 */
2563static int virtioNetR3ReadVirtioTxPktHdr(PVIRTIOCORE pVirtio, PVIRTIONET pThis, PPDMDEVINS pDevIns, RTGCPHYS GCPhys, PVIRTIONETPKTHDR pPktHdr, size_t cbFrame)
2564{
2565 int rc = virtioCoreGCPhysRead(pVirtio, pDevIns, GCPhys, pPktHdr, pThis->cbPktHdr);
2566 if (RT_FAILURE(rc))
2567 return rc;
2568
2569 LogFunc(("pktHdr (flags=%x gso-type=%x len=%x gso-size=%x Chksum-start=%x Chksum-offset=%x) cbFrame=%d\n",
2570 pPktHdr->uFlags, pPktHdr->uGsoType, pPktHdr->uHdrLen,
2571 pPktHdr->uGsoSize, pPktHdr->uChksumStart, pPktHdr->uChksumOffset, cbFrame));
2572
2573 if (pPktHdr->uGsoType)
2574 {
2575 /* Segmentation offloading cannot be done without checksumming, and we do not support ECN */
2576 AssertMsgReturn( RT_LIKELY(pPktHdr->uFlags & VIRTIONET_HDR_F_NEEDS_CSUM)
2577 && !(RT_UNLIKELY(pPktHdr->uGsoType & VIRTIONET_HDR_GSO_ECN)),
2578 ("Unsupported ECN request in pkt header\n"), VERR_NOT_SUPPORTED);
2579
2580 uint32_t uTcpHdrSize;
2581 switch (pPktHdr->uGsoType)
2582 {
2583 case VIRTIONET_HDR_GSO_TCPV4:
2584 case VIRTIONET_HDR_GSO_TCPV6:
2585 uTcpHdrSize = sizeof(RTNETTCP);
2586 break;
2587 case VIRTIONET_HDR_GSO_UDP:
2588 uTcpHdrSize = 0;
2589 break;
2590 default:
2591 LogFunc(("Bad GSO type in packet header\n"));
2592 return VERR_INVALID_PARAMETER;
2593 }
2594 /* Header + MSS must not exceed the packet size. */
2595 AssertMsgReturn(RT_LIKELY(uTcpHdrSize + pPktHdr->uChksumStart + pPktHdr->uGsoSize <= cbFrame),
2596 ("Header plus message exceeds packet size"), VERR_BUFFER_OVERFLOW);
2597 }
2598
2599 AssertMsgReturn( !(pPktHdr->uFlags & VIRTIONET_HDR_F_NEEDS_CSUM)
2600 || sizeof(uint16_t) + pPktHdr->uChksumStart + pPktHdr->uChksumOffset <= cbFrame,
2601 ("Checksum (%d bytes) doesn't fit into pkt header (%d bytes)\n",
2602 sizeof(uint16_t) + pPktHdr->uChksumStart + pPktHdr->uChksumOffset, cbFrame),
2603 VERR_BUFFER_OVERFLOW);
2604
2605 return VINF_SUCCESS;
2606}
2607
2608/**
2609 * Transmits single GSO frame via PDM framework to downstream PDM device, to emit from virtual NIC.
2610 *
2611 * This does final prep of GSO parameters including checksum calculation if configured
2612 * (e.g. if VIRTIONET_HDR_F_NEEDS_CSUM flag is set).
2613 *
2614 * @param pThis virtio-net instance
2615 * @param pThisCC virtio-net instance
2616 * @param pSgBuf PDM S/G buffer containing pkt and hdr to transmit
2617 * @param pGso GSO parameters used for the packet
2618 * @param pPktHdr virtio-net pkt header to adapt to PDM semantics
2619 */
2620static int virtioNetR3TransmitFrame(PVIRTIONET pThis, PVIRTIONETCC pThisCC, PPDMSCATTERGATHER pSgBuf,
2621 PPDMNETWORKGSO pGso, PVIRTIONETPKTHDR pPktHdr)
2622{
2623
2624 virtioNetR3PacketDump(pThis, (uint8_t *)pSgBuf->aSegs[0].pvSeg, pSgBuf->cbUsed, "--> Outgoing");
2625 if (pGso)
2626 {
2627 /* Some guests (RHEL) may report HdrLen excluding transport layer header!
2628 * Thus cannot use cdHdrs provided by the guest because of different ways
2629 * it gets filled out by different versions of kernels. */
2630 Log4Func(("%s HdrLen before adjustment %d.\n", pThis->szInst, pGso->cbHdrsTotal));
2631 switch (pGso->u8Type)
2632 {
2633 case PDMNETWORKGSOTYPE_IPV4_TCP:
2634 case PDMNETWORKGSOTYPE_IPV6_TCP:
2635 pGso->cbHdrsTotal = pPktHdr->uChksumStart +
2636 ((PRTNETTCP)(((uint8_t*)pSgBuf->aSegs[0].pvSeg) + pPktHdr->uChksumStart))->th_off * 4;
2637 AssertMsgReturn(pSgBuf->cbUsed > pGso->cbHdrsTotal,
2638 ("cbHdrsTotal exceeds size of frame"), VERR_BUFFER_OVERFLOW);
2639 pGso->cbHdrsSeg = pGso->cbHdrsTotal;
2640 break;
2641 case PDMNETWORKGSOTYPE_IPV4_UDP:
2642 pGso->cbHdrsTotal = (uint8_t)(pPktHdr->uChksumStart + sizeof(RTNETUDP));
2643 pGso->cbHdrsSeg = pPktHdr->uChksumStart;
2644 break;
2645 case PDMNETWORKGSOTYPE_INVALID:
2646 LogFunc(("%s ignoring invalid GSO frame\n", pThis->szInst));
2647 return VERR_INVALID_PARAMETER;
2648 }
2649 /* Update GSO structure embedded into the frame */
2650 ((PPDMNETWORKGSO)pSgBuf->pvUser)->cbHdrsTotal = pGso->cbHdrsTotal;
2651 ((PPDMNETWORKGSO)pSgBuf->pvUser)->cbHdrsSeg = pGso->cbHdrsSeg;
2652 Log4Func(("%s adjusted HdrLen to %d.\n",
2653 pThis->szInst, pGso->cbHdrsTotal));
2654 Log2Func(("%s gso type=%x cbHdrsTotal=%u cbHdrsSeg=%u mss=%u off1=0x%x off2=0x%x\n",
2655 pThis->szInst, pGso->u8Type, pGso->cbHdrsTotal, pGso->cbHdrsSeg,
2656 pGso->cbMaxSeg, pGso->offHdr1, pGso->offHdr2));
2657 STAM_REL_COUNTER_INC(&pThis->StatTransmitGSO);
2658 }
2659 else if (pPktHdr->uFlags & VIRTIONET_HDR_F_NEEDS_CSUM)
2660 {
2661 STAM_REL_COUNTER_INC(&pThis->StatTransmitCSum);
2662 /*
2663 * This is not GSO frame but checksum offloading is requested.
2664 */
2665 virtioNetR3Calc16BitChecksum((uint8_t*)pSgBuf->aSegs[0].pvSeg, pSgBuf->cbUsed,
2666 pPktHdr->uChksumStart, pPktHdr->uChksumOffset);
2667 }
2668
2669 return pThisCC->pDrv->pfnSendBuf(pThisCC->pDrv, pSgBuf, true /* fOnWorkerThread */);
2670}
2671
2672/**
2673 * Non-reentrant function transmits all available packets from specified Tx virtq to downstream
2674 * PDM device (if cable is connected). For each Tx pkt, virtio-net pkt header is converted
2675 * to required GSO information (VBox host network stack semantics)
2676 *
2677 * @param pDevIns PDM device instance
2678 * @param pThis virtio-net device instance
2679 * @param pThisCC virtio-net device instance
2680 * @param pTxVirtq Address of transmit virtq
2681 * @param fOnWorkerThread Flag to PDM whether to use caller's or or PDM transmit worker's thread.
2682 */
2683static int virtioNetR3TransmitPkts(PPDMDEVINS pDevIns, PVIRTIONET pThis, PVIRTIONETCC pThisCC,
2684 PVIRTIONETVIRTQ pTxVirtq, bool fOnWorkerThread)
2685{
2686 PVIRTIOCORE pVirtio = &pThis->Virtio;
2687
2688
2689 if (!pThis->fVirtioReady)
2690 {
2691 LogFunc(("%s Ignoring Tx requests. VirtIO not ready (status=0x%x)\n",
2692 pThis->szInst, pThis->virtioNetConfig.uStatus));
2693 return VERR_IGNORED;
2694 }
2695
2696 if (!pThis->fCableConnected)
2697 {
2698 Log(("[%s] Ignoring transmit requests while cable is disconnected.\n", pThis->szInst));
2699 return VERR_IGNORED;
2700 }
2701
2702 /*
2703 * Only one thread is allowed to transmit at a time, others should skip transmission as the packets
2704 * will be picked up by the transmitting thread.
2705 */
2706 if (!ASMAtomicCmpXchgU32(&pThis->uIsTransmitting, 1, 0))
2707 return VERR_IGNORED;
2708
2709 PPDMINETWORKUP pDrv = pThisCC->pDrv;
2710 if (pDrv)
2711 {
2712 int rc = pDrv->pfnBeginXmit(pDrv, fOnWorkerThread);
2713 Assert(rc == VINF_SUCCESS || rc == VERR_TRY_AGAIN);
2714 if (rc == VERR_TRY_AGAIN)
2715 {
2716 ASMAtomicWriteU32(&pThis->uIsTransmitting, 0);
2717 return VERR_TRY_AGAIN;
2718 }
2719 }
2720 int cPkts = virtioCoreVirtqAvailBufCount(pVirtio->pDevInsR3, pVirtio, pTxVirtq->uIdx);
2721 if (!cPkts)
2722 {
2723 LogFunc(("[%s] No packets to send found on %s\n", pThis->szInst, pTxVirtq->szName));
2724
2725 if (pDrv)
2726 pDrv->pfnEndXmit(pDrv);
2727
2728 ASMAtomicWriteU32(&pThis->uIsTransmitting, 0);
2729 return VERR_MISSING;
2730 }
2731 LogFunc(("[%s] About to transmit %d pending packet%c\n", pThis->szInst, cPkts, cPkts == 1 ? ' ' : 's'));
2732
2733 virtioNetR3SetWriteLed(pThisCC, true);
2734
2735 /* Disable notifications until all available descriptors have been processed */
2736 if (!(pVirtio->uDriverFeatures & VIRTIO_F_EVENT_IDX))
2737 virtioCoreVirtqEnableNotify(&pThis->Virtio, pTxVirtq->uIdx, false /* fEnable */);
2738
2739 int rc;
2740 VIRTQBUF_T VirtqBuf;
2741
2742 VirtqBuf.u32Magic = VIRTQBUF_MAGIC;
2743 VirtqBuf.cRefs = 1;
2744
2745 PVIRTQBUF pVirtqBuf = &VirtqBuf;
2746 while ((rc = virtioCoreR3VirtqAvailBufPeek(pVirtio->pDevInsR3, pVirtio, pTxVirtq->uIdx, pVirtqBuf)) == VINF_SUCCESS)
2747 {
2748 Log10Func(("[%s] fetched descriptor chain from %s\n", pThis->szInst, pTxVirtq->szName));
2749
2750 PVIRTIOSGBUF pSgPhysSend = pVirtqBuf->pSgPhysSend;
2751 PVIRTIOSGSEG paSegsFromGuest = pSgPhysSend->paSegs;
2752 uint32_t cSegsFromGuest = pSgPhysSend->cSegs;
2753 size_t uFrameSize = 0;
2754
2755 AssertMsgReturn(paSegsFromGuest[0].cbSeg >= pThis->cbPktHdr,
2756 ("Desc chain's first seg has insufficient space for pkt header!\n"),
2757 VERR_INTERNAL_ERROR);
2758
2759 VIRTIONETPKTHDR PktHdr;
2760 PVIRTIONETPKTHDR pPktHdr = &PktHdr;
2761
2762 /* Compute total frame size from guest (including virtio-net pkt hdr) */
2763 for (unsigned i = 0; i < cSegsFromGuest && uFrameSize < VIRTIONET_MAX_FRAME_SIZE; i++)
2764 uFrameSize += paSegsFromGuest[i].cbSeg;
2765
2766 Log5Func(("[%s] complete frame is %u bytes.\n", pThis->szInst, uFrameSize));
2767 Assert(uFrameSize <= VIRTIONET_MAX_FRAME_SIZE);
2768
2769 /* Truncate oversized frames. */
2770 if (uFrameSize > VIRTIONET_MAX_FRAME_SIZE)
2771 uFrameSize = VIRTIONET_MAX_FRAME_SIZE;
2772
2773 if (pThisCC->pDrv)
2774 {
2775 uFrameSize -= pThis->cbPktHdr;
2776 /*
2777 * Peel off pkt header and convert to PDM/GSO semantics.
2778 */
2779 rc = virtioNetR3ReadVirtioTxPktHdr(pVirtio, pThis, pDevIns, paSegsFromGuest[0].GCPhys, pPktHdr, uFrameSize /* cbFrame */);
2780 if (RT_FAILURE(rc))
2781 return rc;
2782 virtioCoreGCPhysChainAdvance(pSgPhysSend, pThis->cbPktHdr);
2783
2784 PDMNETWORKGSO Gso, *pGso = virtioNetR3SetupGsoCtx(&Gso, pPktHdr);
2785
2786 /* Allocate PDM transmit buffer to send guest provided network frame from to VBox network leaf device */
2787 PPDMSCATTERGATHER pSgBufToPdmLeafDevice;
2788 rc = pThisCC->pDrv->pfnAllocBuf(pThisCC->pDrv, uFrameSize, pGso, &pSgBufToPdmLeafDevice);
2789
2790 /*
2791 * Copy virtio-net guest S/G buffer to PDM leaf driver S/G buffer
2792 * converting from GCphys to virt memory at the same time
2793 */
2794 if (RT_SUCCESS(rc))
2795 {
2796 STAM_REL_COUNTER_INC(&pThis->StatTransmitPackets);
2797 STAM_PROFILE_START(&pThis->StatTransmitSend, a);
2798
2799 size_t cbCopied = 0;
2800 size_t cbRemain = pSgBufToPdmLeafDevice->cbUsed = uFrameSize;
2801 uint64_t uOffset = 0;
2802 while (cbRemain)
2803 {
2804 PVIRTIOSGSEG paSeg = &pSgPhysSend->paSegs[pSgPhysSend->idxSeg];
2805 uint64_t srcSgStart = (uint64_t)paSeg->GCPhys;
2806 uint64_t srcSgLen = (uint64_t)paSeg->cbSeg;
2807 uint64_t srcSgCur = (uint64_t)pSgPhysSend->GCPhysCur;
2808 cbCopied = RT_MIN((uint64_t)cbRemain, srcSgLen - (srcSgCur - srcSgStart));
2809 virtioCoreGCPhysRead(pVirtio, pDevIns,
2810 (RTGCPHYS)pSgPhysSend->GCPhysCur,
2811 ((uint8_t *)pSgBufToPdmLeafDevice->aSegs[0].pvSeg) + uOffset, cbCopied);
2812 virtioCoreGCPhysChainAdvance(pSgPhysSend, cbCopied);
2813 cbRemain -= cbCopied;
2814 uOffset += cbCopied;
2815 }
2816
2817 LogFunc((".... Copied %lu/%lu bytes to %lu byte guest buffer. Buf residual=%lu\n",
2818 uOffset, uFrameSize, pVirtqBuf->cbPhysSend, virtioCoreGCPhysChainCalcLengthLeft(pSgPhysSend)));
2819
2820 rc = virtioNetR3TransmitFrame(pThis, pThisCC, pSgBufToPdmLeafDevice, pGso, pPktHdr);
2821 if (RT_FAILURE(rc))
2822 {
2823 LogFunc(("[%s] Failed to transmit frame, rc = %Rrc\n", pThis->szInst, rc));
2824 STAM_PROFILE_STOP(&pThis->StatTransmitSend, a);
2825 STAM_PROFILE_ADV_STOP(&pThis->StatTransmit, a);
2826 pThisCC->pDrv->pfnFreeBuf(pThisCC->pDrv, pSgBufToPdmLeafDevice);
2827 }
2828 STAM_PROFILE_STOP(&pThis->StatTransmitSend, a);
2829 STAM_REL_COUNTER_ADD(&pThis->StatTransmitBytes, uOffset);
2830 }
2831 else
2832 {
2833 Log4Func(("Failed to allocate S/G buffer: frame size=%u rc=%Rrc\n", uFrameSize, rc));
2834 /* Stop trying to fetch TX descriptors until we get more bandwidth. */
2835 break;
2836 }
2837
2838 virtioCoreR3VirtqAvailBufNext(pVirtio, pTxVirtq->uIdx);
2839
2840 /* No data to return to guest, but necessary to put elem (e.g. desc chain head idx) on used ring */
2841 virtioCoreR3VirtqUsedBufPut(pVirtio->pDevInsR3, pVirtio, pTxVirtq->uIdx, NULL, pVirtqBuf, true /* fFence */);
2842 virtioCoreVirtqUsedRingSync(pVirtio->pDevInsR3, pVirtio, pTxVirtq->uIdx);
2843 }
2844
2845 /* Before we break the loop we need to check if the queue is empty,
2846 * re-enable notifications, and then re-check again to avoid missing
2847 * a notification for the descriptor that is added to the queue
2848 * after we have checked it on being empty, but before we re-enabled
2849 * notifications.
2850 */
2851 if (!(pVirtio->uDriverFeatures & VIRTIO_F_EVENT_IDX)
2852 && IS_VIRTQ_EMPTY(pDevIns, &pThis->Virtio, pTxVirtq->uIdx))
2853 virtioCoreVirtqEnableNotify(&pThis->Virtio, pTxVirtq->uIdx, true /* fEnable */);
2854 }
2855 virtioNetR3SetWriteLed(pThisCC, false);
2856
2857 if (pDrv)
2858 pDrv->pfnEndXmit(pDrv);
2859
2860 ASMAtomicWriteU32(&pThis->uIsTransmitting, 0);
2861 return VINF_SUCCESS;
2862}
2863
2864/**
2865 * @interface_method_impl{PDMINETWORKDOWN,pfnXmitPending}
2866 */
2867static DECLCALLBACK(void) virtioNetR3NetworkDown_XmitPending(PPDMINETWORKDOWN pInterface)
2868{
2869 LogFunc(("\n"));
2870 PVIRTIONETCC pThisCC = RT_FROM_MEMBER(pInterface, VIRTIONETCC, INetworkDown);
2871 PPDMDEVINS pDevIns = pThisCC->pDevIns;
2872 PVIRTIONET pThis = PDMDEVINS_2_DATA(pThisCC->pDevIns, PVIRTIONET);
2873 PVIRTIONETVIRTQ pTxVirtq = &pThis->aVirtqs[TXQIDX(0)];
2874 STAM_COUNTER_INC(&pThis->StatTransmitByNetwork);
2875
2876 (void)virtioNetR3TransmitPkts(pDevIns, pThis, pThisCC, pTxVirtq, true /*fOnWorkerThread*/);
2877}
2878
2879/**
2880 * @callback_method_impl{FNTMTIMERDEV, Link Up Timer handler.}
2881 */
2882static DECLCALLBACK(void) virtioNetR3LinkUpTimer(PPDMDEVINS pDevIns, TMTIMERHANDLE hTimer, void *pvUser)
2883{
2884 PVIRTIONET pThis = PDMDEVINS_2_DATA(pDevIns, PVIRTIONET);
2885 PVIRTIONETCC pThisCC = PDMDEVINS_2_DATA_CC(pDevIns, PVIRTIONETCC);
2886
2887 SET_LINK_UP(pThis);
2888 virtioNetWakeupRxBufWaiter(pDevIns);
2889
2890 if (pThisCC->pDrv)
2891 pThisCC->pDrv->pfnNotifyLinkChanged(pThisCC->pDrv, PDMNETWORKLINKSTATE_UP);
2892
2893 LogFunc(("[%s] Link is up\n", pThis->szInst));
2894 RT_NOREF(hTimer, pvUser);
2895}
2896
2897/**
2898 * @interface_method_impl{PDMINETWORKCONFIG,pfnSetLinkState}
2899 */
2900static DECLCALLBACK(int) virtioNetR3NetworkConfig_SetLinkState(PPDMINETWORKCONFIG pInterface, PDMNETWORKLINKSTATE enmState)
2901{
2902 PVIRTIONETCC pThisCC = RT_FROM_MEMBER(pInterface, VIRTIONETCC, INetworkConfig);
2903 PPDMDEVINS pDevIns = pThisCC->pDevIns;
2904 PVIRTIONET pThis = PDMDEVINS_2_DATA(pDevIns, PVIRTIONET);
2905
2906 bool fRequestedLinkStateIsUp = (enmState == PDMNETWORKLINKSTATE_UP);
2907
2908#ifdef LOG_ENABLED
2909 if (LogIs7Enabled())
2910 {
2911 LogFunc(("[%s]", pThis->szInst));
2912 switch(enmState)
2913 {
2914 case PDMNETWORKLINKSTATE_UP:
2915 Log(("UP\n"));
2916 break;
2917 case PDMNETWORKLINKSTATE_DOWN:
2918 Log(("DOWN\n"));
2919 break;
2920 case PDMNETWORKLINKSTATE_DOWN_RESUME:
2921 Log(("DOWN (RESUME)\n"));
2922 break;
2923 default:
2924 Log(("UNKNOWN)\n"));
2925 }
2926 }
2927#endif
2928
2929 if (enmState == PDMNETWORKLINKSTATE_DOWN_RESUME)
2930 {
2931 if (IS_LINK_UP(pThis))
2932 {
2933 /*
2934 * We bother to bring the link down only if it was up previously. The UP link state
2935 * notification will be sent when the link actually goes up in virtioNetR3LinkUpTimer().
2936 */
2937 virtioNetR3TempLinkDown(pDevIns, pThis, pThisCC);
2938 if (pThisCC->pDrv)
2939 pThisCC->pDrv->pfnNotifyLinkChanged(pThisCC->pDrv, enmState);
2940 }
2941 }
2942 else if (fRequestedLinkStateIsUp != IS_LINK_UP(pThis))
2943 {
2944 if (fRequestedLinkStateIsUp)
2945 {
2946 Log(("[%s] Link is up\n", pThis->szInst));
2947 pThis->fCableConnected = true;
2948 SET_LINK_UP(pThis);
2949 }
2950 else /* Link requested to be brought down */
2951 {
2952 /* The link was brought down explicitly, make sure it won't come up by timer. */
2953 PDMDevHlpTimerStop(pDevIns, pThisCC->hLinkUpTimer);
2954 Log(("[%s] Link is down\n", pThis->szInst));
2955 pThis->fCableConnected = false;
2956 SET_LINK_DOWN(pThis);
2957 }
2958 if (pThisCC->pDrv)
2959 pThisCC->pDrv->pfnNotifyLinkChanged(pThisCC->pDrv, enmState);
2960 }
2961 return VINF_SUCCESS;
2962}
2963/**
2964 * @interface_method_impl{PDMINETWORKCONFIG,pfnGetLinkState}
2965 */
2966static DECLCALLBACK(PDMNETWORKLINKSTATE) virtioNetR3NetworkConfig_GetLinkState(PPDMINETWORKCONFIG pInterface)
2967{
2968 PVIRTIONETCC pThisCC = RT_FROM_MEMBER(pInterface, VIRTIONETCC, INetworkConfig);
2969 PVIRTIONET pThis = PDMDEVINS_2_DATA(pThisCC->pDevIns, PVIRTIONET);
2970
2971 return IS_LINK_UP(pThis) ? PDMNETWORKLINKSTATE_UP : PDMNETWORKLINKSTATE_DOWN;
2972}
2973
2974static int virtioNetR3DestroyWorkerThreads(PPDMDEVINS pDevIns, PVIRTIONET pThis, PVIRTIONETCC pThisCC)
2975{
2976 Log10Func(("[%s]\n", pThis->szInst));
2977 int rc = VINF_SUCCESS;
2978 for (unsigned uIdxWorker = 0; uIdxWorker < pThis->cWorkers; uIdxWorker++)
2979 {
2980 PVIRTIONETWORKER pWorker = &pThis->aWorkers[uIdxWorker];
2981 PVIRTIONETWORKERR3 pWorkerR3 = &pThisCC->aWorkers[uIdxWorker];
2982
2983 if (pWorker->hEvtProcess != NIL_SUPSEMEVENT)
2984 {
2985 PDMDevHlpSUPSemEventClose(pDevIns, pWorker->hEvtProcess);
2986 pWorker->hEvtProcess = NIL_SUPSEMEVENT;
2987 }
2988 if (pWorkerR3->pThread)
2989 {
2990 int rcThread;
2991 rc = PDMDevHlpThreadDestroy(pDevIns, pWorkerR3->pThread, &rcThread);
2992 if (RT_FAILURE(rc) || RT_FAILURE(rcThread))
2993 AssertMsgFailed(("%s Failed to destroythread rc=%Rrc rcThread=%Rrc\n", __FUNCTION__, rc, rcThread));
2994 pWorkerR3->pThread = NULL;
2995 }
2996 }
2997 return rc;
2998}
2999
3000/**
3001 * Creates a worker for specified queue, along with semaphore to throttle the worker.
3002 *
3003 * @param pDevIns - PDM device instance
3004 * @param pThis - virtio-net instance
3005 * @param pWorker - Pointer to worker state
3006 * @param pWorkerR3 - Pointer to worker state
3007 * @param pVirtq - Pointer to virtq
3008 */
3009static int virtioNetR3CreateOneWorkerThread(PPDMDEVINS pDevIns, PVIRTIONET pThis,
3010 PVIRTIONETWORKER pWorker, PVIRTIONETWORKERR3 pWorkerR3,
3011 PVIRTIONETVIRTQ pVirtq)
3012{
3013 Log10Func(("[%s]\n", pThis->szInst));
3014 RT_NOREF(pThis);
3015
3016 int rc = PDMDevHlpSUPSemEventCreate(pDevIns, &pWorker->hEvtProcess);
3017
3018 if (RT_FAILURE(rc))
3019 return PDMDevHlpVMSetError(pDevIns, rc, RT_SRC_POS,
3020 N_("DevVirtioNET: Failed to create SUP event semaphore"));
3021
3022 LogFunc(("creating thread for queue %s\n", pVirtq->szName));
3023
3024 rc = PDMDevHlpThreadCreate(pDevIns, &pWorkerR3->pThread,
3025 (void *)pWorker, virtioNetR3WorkerThread,
3026 virtioNetR3WakeupWorker, 0, RTTHREADTYPE_IO, pVirtq->szName);
3027 if (RT_FAILURE(rc))
3028 return PDMDevHlpVMSetError(pDevIns, rc, RT_SRC_POS,
3029 N_("Error creating thread for Virtual Virtq %s\n"), pVirtq->uIdx);
3030
3031 pWorker->fAssigned = true; /* Because worker's state in fixed-size array initialized w/empty slots */
3032
3033 LogFunc(("%s pThread: %p\n", pVirtq->szName, pWorkerR3->pThread));
3034
3035 return rc;
3036}
3037
3038static int virtioNetR3CreateWorkerThreads(PPDMDEVINS pDevIns, PVIRTIONET pThis, PVIRTIONETCC pThisCC)
3039{
3040 Log10Func(("[%s]\n", pThis->szInst));
3041 int rc;
3042
3043 /* Create the Control Queue worker anyway whether or not it is feature-negotiated or utilized by the guest.
3044 * See related comment for queue construction in the device constructor function for more context.
3045 */
3046
3047 PVIRTIONETVIRTQ pCtlVirtq = &pThis->aVirtqs[CTRLQIDX];
3048 rc = virtioNetR3CreateOneWorkerThread(pDevIns, pThis,
3049 &pThis->aWorkers[CTRLQIDX], &pThisCC->aWorkers[CTRLQIDX], pCtlVirtq);
3050 AssertRCReturn(rc, rc);
3051
3052 pCtlVirtq->fHasWorker = true;
3053
3054 for (uint16_t uVirtqPair = pThis->cInitializedVirtqPairs; uVirtqPair < pThis->cVirtqPairs; uVirtqPair++)
3055 {
3056 PVIRTIONETVIRTQ pTxVirtq = &pThis->aVirtqs[TXQIDX(uVirtqPair)];
3057 PVIRTIONETVIRTQ pRxVirtq = &pThis->aVirtqs[RXQIDX(uVirtqPair)];
3058
3059 rc = virtioNetR3CreateOneWorkerThread(pDevIns, pThis, &pThis->aWorkers[TXQIDX(uVirtqPair)],
3060 &pThisCC->aWorkers[TXQIDX(uVirtqPair)], pTxVirtq);
3061 AssertRCReturn(rc, rc);
3062
3063 pTxVirtq->fHasWorker = true;
3064 pRxVirtq->fHasWorker = false;
3065 }
3066
3067 if (pThis->cVirtqPairs > pThis->cInitializedVirtqPairs)
3068 pThis->cInitializedVirtqPairs = pThis->cVirtqPairs;
3069
3070 pThis->cWorkers = pThis->cVirtqPairs + 1 /* One control virtq */;
3071
3072 return rc;
3073}
3074
3075
3076/**
3077 * @callback_method_impl{FNPDMTHREADDEV}
3078 */
3079static DECLCALLBACK(int) virtioNetR3WorkerThread(PPDMDEVINS pDevIns, PPDMTHREAD pThread)
3080{
3081 PVIRTIONET pThis = PDMDEVINS_2_DATA(pDevIns, PVIRTIONET);
3082 PVIRTIONETCC pThisCC = PDMDEVINS_2_DATA_CC(pDevIns, PVIRTIONETCC);
3083 PVIRTIONETWORKER pWorker = (PVIRTIONETWORKER)pThread->pvUser;
3084 PVIRTIONETVIRTQ pVirtq = &pThis->aVirtqs[pWorker->uIdx];
3085 uint16_t uIdx = pWorker->uIdx;
3086
3087 ASMAtomicWriteBool(&pWorker->fSleeping, false);
3088
3089 Assert(pWorker->uIdx == pVirtq->uIdx);
3090
3091 if (pThread->enmState == PDMTHREADSTATE_INITIALIZING)
3092 return VINF_SUCCESS;
3093
3094 LogFunc(("[%s] worker thread idx=%d started for %s (virtq idx=%d)\n", pThis->szInst, pWorker->uIdx, pVirtq->szName, pVirtq->uIdx));
3095
3096 /** @todo Race w/guest enabling/disabling guest notifications cyclically.
3097 See BugRef #8651, Comment #82 */
3098 virtioCoreVirtqEnableNotify(&pThis->Virtio, uIdx, true /* fEnable */);
3099
3100 while ( pThread->enmState != PDMTHREADSTATE_TERMINATING
3101 && pThread->enmState != PDMTHREADSTATE_TERMINATED)
3102 {
3103 if (IS_VIRTQ_EMPTY(pDevIns, &pThis->Virtio, pVirtq->uIdx))
3104 {
3105 /* Precisely coordinated atomic interlocks avoid a race condition that results in hung thread
3106 * wherein a sloppily coordinated wake-up notification during a transition into or out
3107 * of sleep leaves notifier and target mutually confused about actual & intended state.
3108 */
3109 ASMAtomicWriteBool(&pWorker->fSleeping, true);
3110 bool fNotificationSent = ASMAtomicXchgBool(&pWorker->fNotified, false);
3111 if (!fNotificationSent)
3112 {
3113 Log10Func(("[%s] %s worker sleeping...\n\n", pThis->szInst, pVirtq->szName));
3114 Assert(ASMAtomicReadBool(&pWorker->fSleeping));
3115
3116 int rc = PDMDevHlpSUPSemEventWaitNoResume(pDevIns, pWorker->hEvtProcess, RT_INDEFINITE_WAIT);
3117 STAM_COUNTER_INC(&pThis->StatTransmitByThread);
3118 AssertLogRelMsgReturn(RT_SUCCESS(rc) || rc == VERR_INTERRUPTED, ("%Rrc\n", rc), rc);
3119 if (RT_UNLIKELY(pThread->enmState != PDMTHREADSTATE_RUNNING))
3120 return VINF_SUCCESS;
3121 if (rc == VERR_INTERRUPTED)
3122 continue;
3123 ASMAtomicWriteBool(&pWorker->fNotified, false);
3124 }
3125 ASMAtomicWriteBool(&pWorker->fSleeping, false);
3126 }
3127 /*
3128 * Dispatch to the handler for the queue this worker is set up to drive
3129 */
3130 if (pVirtq->fCtlVirtq)
3131 {
3132 Log10Func(("[%s] %s worker woken. Fetching desc chain\n", pThis->szInst, pVirtq->szName));
3133 VIRTQBUF_T VirtqBuf;
3134 PVIRTQBUF pVirtqBuf = &VirtqBuf;
3135 int rc = virtioCoreR3VirtqAvailBufGet(pDevIns, &pThis->Virtio, pVirtq->uIdx, pVirtqBuf, true);
3136 if (rc == VERR_NOT_AVAILABLE)
3137 {
3138 Log10Func(("[%s] %s worker woken. Nothing found in queue\n", pThis->szInst, pVirtq->szName));
3139 continue;
3140 }
3141 virtioNetR3Ctrl(pDevIns, pThis, pThisCC, pVirtqBuf);
3142 }
3143 else /* Must be Tx queue */
3144 {
3145 Log10Func(("[%s] %s worker woken. Virtq has data to transmit\n", pThis->szInst, pVirtq->szName));
3146 virtioNetR3TransmitPkts(pDevIns, pThis, pThisCC, pVirtq, false /* fOnWorkerThread */);
3147 }
3148 /* Note: Surprise! Rx queues aren't handled by local worker threads. Instead, the PDM network leaf driver
3149 * invokes PDMINETWORKDOWN.pfnWaitReceiveAvail() callback, which waits until woken by virtioNetVirtqNotified()
3150 * indicating that guest IN buffers have been added to Rx virt queue.
3151 */
3152 }
3153 Log10(("[%s] %s worker thread exiting\n", pThis->szInst, pVirtq->szName));
3154 return VINF_SUCCESS;
3155}
3156
3157/**
3158 * @callback_method_impl{VIRTIOCORER3,pfnStatusChanged}
3159 *
3160 * Called back by the core code when VirtIO's ready state has changed.
3161 */
3162static DECLCALLBACK(void) virtioNetR3StatusChg(PVIRTIOCORE pVirtio, PVIRTIOCORECC pVirtioCC, uint32_t fVirtioReady)
3163{
3164 PVIRTIONET pThis = RT_FROM_MEMBER(pVirtio, VIRTIONET, Virtio);
3165 PVIRTIONETCC pThisCC = RT_FROM_MEMBER(pVirtioCC, VIRTIONETCC, Virtio);
3166
3167 pThis->fVirtioReady = fVirtioReady;
3168
3169 if (fVirtioReady)
3170 {
3171#ifdef LOG_ENABLED
3172 Log(("\n%-23s: %s *** VirtIO Ready ***\n\n", __FUNCTION__, pThis->szInst));
3173 virtioCorePrintDeviceFeatures(&pThis->Virtio, NULL, s_aDevSpecificFeatures, RT_ELEMENTS(s_aDevSpecificFeatures));
3174#endif
3175 pThis->fResetting = false;
3176 pThis->fNegotiatedFeatures = virtioCoreGetNegotiatedFeatures(pVirtio);
3177 /* Now we can properly figure out the size of virtio header! */
3178 virtioNetConfigurePktHdr(pThis, pThis->Virtio.fLegacyDriver);
3179 pThis->virtioNetConfig.uStatus = pThis->fCableConnected ? VIRTIONET_F_LINK_UP : 0;
3180
3181 for (unsigned uVirtqNbr = 0; uVirtqNbr < pThis->cVirtqs; uVirtqNbr++)
3182 {
3183 PVIRTIONETVIRTQ pVirtq = &pThis->aVirtqs[uVirtqNbr];
3184 PVIRTIONETWORKER pWorker = &pThis->aWorkers[uVirtqNbr];
3185
3186 Assert(pWorker->uIdx == uVirtqNbr);
3187 RT_NOREF(pWorker);
3188
3189 Assert(pVirtq->uIdx == pWorker->uIdx);
3190
3191 (void) virtioCoreR3VirtqAttach(&pThis->Virtio, pVirtq->uIdx, pVirtq->szName);
3192 pVirtq->fAttachedToVirtioCore = true;
3193 if (IS_VIRTQ_EMPTY(pThisCC->pDevIns, &pThis->Virtio, pVirtq->uIdx))
3194 virtioCoreVirtqEnableNotify(&pThis->Virtio, pVirtq->uIdx, true /* fEnable */);
3195 }
3196
3197 virtioNetWakeupRxBufWaiter(pThisCC->pDevIns);
3198 }
3199 else
3200 {
3201 Log(("\n%-23s: %s VirtIO is resetting ***\n", __FUNCTION__, pThis->szInst));
3202
3203 pThis->virtioNetConfig.uStatus = pThis->fCableConnected ? VIRTIONET_F_LINK_UP : 0;
3204 Log7(("%-23s: %s Link is %s\n", __FUNCTION__, pThis->szInst, pThis->fCableConnected ? "up" : "down"));
3205
3206 pThis->fPromiscuous = true;
3207 pThis->fAllMulticast = false;
3208 pThis->fAllUnicast = false;
3209 pThis->fNoMulticast = false;
3210 pThis->fNoUnicast = false;
3211 pThis->fNoBroadcast = false;
3212 pThis->uIsTransmitting = 0;
3213 pThis->cUnicastFilterMacs = 0;
3214 pThis->cMulticastFilterMacs = 0;
3215
3216 memset(pThis->aMacMulticastFilter, 0, sizeof(pThis->aMacMulticastFilter));
3217 memset(pThis->aMacUnicastFilter, 0, sizeof(pThis->aMacUnicastFilter));
3218 memset(pThis->aVlanFilter, 0, sizeof(pThis->aVlanFilter));
3219
3220 if (pThisCC->pDrv)
3221 pThisCC->pDrv->pfnSetPromiscuousMode(pThisCC->pDrv, true);
3222
3223 for (uint16_t uVirtqNbr = 0; uVirtqNbr < pThis->cVirtqs; uVirtqNbr++)
3224 {
3225 virtioCoreR3VirtqDetach(&pThis->Virtio, uVirtqNbr);
3226 pThis->aVirtqs[uVirtqNbr].fAttachedToVirtioCore = false;
3227 }
3228 }
3229}
3230
3231/**
3232 * @callback_method_impl{VIRTIOCORER3,pfnFeatureNegotiationComplete}
3233 */
3234static DECLCALLBACK(void) pfnFeatureNegotiationComplete(PVIRTIOCORE pVirtio, uint64_t fDriverFeatures, uint32_t fLegacy)
3235{
3236 PVIRTIONET pThis = PDMDEVINS_2_DATA(pVirtio->pDevInsR3, PVIRTIONET);
3237
3238 LogFunc(("[Feature Negotiation Complete] Guest Driver version is: %s\n", fLegacy ? "legacy" : "modern"));
3239 virtioNetConfigurePktHdr(pThis, fLegacy);
3240 virtioNetR3SetVirtqNames(pThis, fLegacy);
3241
3242 /** @todo r=aeichner We can't just destroy the control queue here because the UEFI firmware and the guest OS might have different
3243 * opinions on how to use the device and if the UEFI firmware causes the control queue to be destroyed Linux guests
3244 * will have a hard time using it. */
3245#if 0
3246 /* Senseless for modern guest to use control queue in this case. (See Note 1 in PDM-invoked device constructor) */
3247 if (!fLegacy && !(fDriverFeatures & VIRTIONET_F_CTRL_VQ))
3248 virtioNetR3VirtqDestroy(pVirtio, &pThis->aVirtqs[CTRLQIDX]);
3249#else
3250 RT_NOREF(fDriverFeatures);
3251#endif
3252}
3253
3254#endif /* IN_RING3 */
3255
3256/**
3257 * @interface_method_impl{PDMDEVREGR3,pfnDetach}
3258 *
3259 * The VM is suspended at this point.
3260 */
3261static DECLCALLBACK(void) virtioNetR3Detach(PPDMDEVINS pDevIns, unsigned iLUN, uint32_t fFlags)
3262{
3263 RT_NOREF(fFlags);
3264
3265 PVIRTIONET pThis = PDMDEVINS_2_DATA(pDevIns, PVIRTIONET);
3266 PVIRTIONETCC pThisCC = PDMDEVINS_2_DATA_CC(pDevIns, PVIRTIONETCC);
3267
3268 Log7Func(("[%s]\n", pThis->szInst));
3269 RT_NOREF(pThis);
3270
3271 AssertLogRelReturnVoid(iLUN == 0);
3272
3273 pThisCC->pDrvBase = NULL;
3274 pThisCC->pDrv = NULL;
3275}
3276
3277/**
3278 * @interface_method_impl{PDMDEVREGR3,pfnAttach}
3279 *
3280 * This is called when we change block driver.
3281 */
3282static DECLCALLBACK(int) virtioNetR3Attach(PPDMDEVINS pDevIns, unsigned iLUN, uint32_t fFlags)
3283{
3284 PVIRTIONET pThis = PDMDEVINS_2_DATA(pDevIns, PVIRTIONET);
3285 PVIRTIONETCC pThisCC = PDMDEVINS_2_DATA_CC(pDevIns, PVIRTIONETCC);
3286
3287 Log7Func(("[%s]", pThis->szInst));
3288 AssertLogRelReturn(iLUN == 0, VERR_PDM_NO_SUCH_LUN);
3289
3290 int rc = PDMDevHlpDriverAttach(pDevIns, 0, &pThisCC->IBase, &pThisCC->pDrvBase, "Network Port");
3291 if (RT_SUCCESS(rc))
3292 {
3293 pThisCC->pDrv = PDMIBASE_QUERY_INTERFACE(pThisCC->pDrvBase, PDMINETWORKUP);
3294 AssertMsgStmt(pThisCC->pDrv, ("Failed to obtain the PDMINETWORKUP interface!\n"),
3295 rc = VERR_PDM_MISSING_INTERFACE_BELOW);
3296 }
3297 else if ( rc == VERR_PDM_NO_ATTACHED_DRIVER
3298 || rc == VERR_PDM_CFG_MISSING_DRIVER_NAME)
3299 {
3300 /* This should never happen because this function is not called
3301 * if there is no driver to attach! */
3302 Log(("[%s] No attached driver!\n", pThis->szInst));
3303 }
3304
3305 RT_NOREF2(pThis, fFlags);
3306 return rc;
3307}
3308
3309/**
3310 * @interface_method_impl{PDMILEDPORTS,pfnQueryStatusLed}
3311 */
3312static DECLCALLBACK(int) virtioNetR3QueryStatusLed(PPDMILEDPORTS pInterface, unsigned iLUN, PPDMLED *ppLed)
3313{
3314 PVIRTIONETR3 pThisR3 = RT_FROM_MEMBER(pInterface, VIRTIONETR3, ILeds);
3315 if (iLUN)
3316 return VERR_PDM_LUN_NOT_FOUND;
3317 *ppLed = &pThisR3->led;
3318 return VINF_SUCCESS;
3319}
3320
3321/**
3322 * @interface_method_impl{PDMIBASE,pfnQueryInterface}
3323 */
3324static DECLCALLBACK(void *) virtioNetR3QueryInterface(struct PDMIBASE *pInterface, const char *pszIID)
3325{
3326 PVIRTIONETR3 pThisCC = RT_FROM_MEMBER(pInterface, VIRTIONETCC, IBase);
3327 PDMIBASE_RETURN_INTERFACE(pszIID, PDMINETWORKDOWN, &pThisCC->INetworkDown);
3328 PDMIBASE_RETURN_INTERFACE(pszIID, PDMINETWORKCONFIG, &pThisCC->INetworkConfig);
3329 PDMIBASE_RETURN_INTERFACE(pszIID, PDMIBASE, &pThisCC->IBase);
3330 PDMIBASE_RETURN_INTERFACE(pszIID, PDMILEDPORTS, &pThisCC->ILeds);
3331 return NULL;
3332}
3333
3334/**
3335 * @interface_method_impl{PDMDEVREGR3,pfnReset}
3336 */
3337static DECLCALLBACK(void) virtioNetR3Reset(PPDMDEVINS pDevIns)
3338{
3339 PVIRTIONET pThis = PDMDEVINS_2_DATA(pDevIns, PVIRTIONET);
3340 PVIRTIONETCC pThisCC = PDMDEVINS_2_DATA_CC(pDevIns, PVIRTIONETCC);
3341
3342 virtioCoreR3ResetDevice(pDevIns, &pThis->Virtio, &pThisCC->Virtio);
3343}
3344
3345/**
3346 * @interface_method_impl{PDMDEVREGR3,pfnDestruct}
3347 */
3348static DECLCALLBACK(int) virtioNetR3Destruct(PPDMDEVINS pDevIns)
3349{
3350 PDMDEV_CHECK_VERSIONS_RETURN_QUIET(pDevIns);
3351
3352 PVIRTIONET pThis = PDMDEVINS_2_DATA(pDevIns, PVIRTIONET);
3353 PVIRTIONETCC pThisCC = PDMDEVINS_2_DATA_CC(pDevIns, PVIRTIONETCC);
3354
3355 Log(("[%s] Destroying instance\n", pThis->szInst));
3356 if (pThis->hEventRxDescAvail != NIL_SUPSEMEVENT)
3357 {
3358 PDMDevHlpSUPSemEventSignal(pDevIns, pThis->hEventRxDescAvail);
3359 PDMDevHlpSUPSemEventClose(pDevIns, pThis->hEventRxDescAvail);
3360 pThis->hEventRxDescAvail = NIL_SUPSEMEVENT;
3361 }
3362
3363 virtioNetR3DestroyWorkerThreads(pDevIns, pThis, pThisCC);
3364 virtioCoreR3Term(pDevIns, &pThis->Virtio, &pThisCC->Virtio);
3365 return VINF_SUCCESS;
3366}
3367
3368/**
3369 * @interface_method_impl{PDMDEVREGR3,pfnConstruct}
3370 *
3371 * Notes about revising originally VirtIO 1.0+ only virtio-net device emulator to be "transitional",
3372 * a VirtIO term meaning this now interoperates with both "legacy" (e.g. pre-1.0) and "modern" (1.0+)
3373 * guest virtio-net drivers. The changes include migrating VMs saved using prior DevVirtioNet.cpp (0.95)
3374 * saveExec/loadExec semantics to use 1.0 save/load semantics.
3375 *
3376 * Regardless of the 1.0 spec's overall helpful guidance for implementing transitional devices,
3377 * A bit is left to the imagination, e.g. some things have to be determined deductively
3378 * (AKA "the hard way").
3379 *
3380 * Case in point: According to VirtIO 0.95 ("legacy") specification, section 2.2.1, "historically"
3381 * drivers may start driving prior to feature negotiation and prior to drivers setting DRIVER_OK
3382 * status, "provided driver doesn't use features that alter early use of this device". Interpreted
3383 * here to mean a virtio-net driver must respect default settings (such as implicit pkt header default
3384 * size, as determined per Note 1 below).
3385 *
3386 * ----------------------------------------------------------------------------------------------
3387 * Transitional device initialization Note 1: Identifying default value for network Rx pkt hdr size.
3388 * (VirtIO 1.0 specification section 5.1.6.1)
3389 *
3390 * Guest virtio legacy drivers may begin operations prematurely, regardless of early spec's
3391 * initialization sequence (see note 2 below). Legacy drivers implicitly default to using the
3392 * (historically) shortest-length network packet header *unless* VIRTIONET_F_MRG_RXBUF feature is
3393 * negotiated. If feature negotiation phase is [optionally] enacted by a legacy guest (i.e. we strictly
3394 * enforce full initialization protocol for modern guests), virtioNetConfigurePktHdr() is invoked again to
3395 * finalize device's network packet header size. Best-guess at default packet header size is deduced, e.g.
3396 * isn't documented, as follows: A legacy guest with VIRTIONET_F_MRG_RXBUF not-yet-negotiated is the only
3397 * case where network I/O could possibly occur with any reasonable assumption about packet type/size,
3398 * because logically other permutations couldn't possibly be inferred until feature negotiation
3399 * is complete. Specifically, those cases are:
3400 *
3401 * 1. A modern driver (detected only when VIRTIONET_F_VERSION_1 feature is ack'd by guest, and,
3402 * simultaneously, VIRTIONET_F_MRG_RXBUF feature is accepted or declined (determining network receive-packet
3403 * processing behavior).
3404 *
3405 * 2. A legacy driver that has agreed to use VIRTIONET_F_MRG_RXBUF feature, resulting in a two-byte larger pkt hdr,
3406 * (as well as deciding Rx packet processing behavior).
3407 *
3408 * ----------------------------------------------------------------------------------------------
3409 * Transitional device initialization Note 2: Creating unnegotiated control queue.
3410 * (VirtIO 1.0 spec, sections 5.1.5 and 5.1.6.5)
3411 *
3412 * Create all queues immediately, prior to feature negotiation, including control queue (irrespective
3413 * of the fact it's too early in initialization for control feature to be approved by guest). This
3414 * transitional device must deal with legacy guests which *can* (and on linux have been seen to) use
3415 * the control queue prior to feature negotiation.
3416 *
3417 * The initial assumption is *modern" guest virtio-net drivers out in the wild could never reasonably
3418 * attempt something as obviously risky as using ctrlq without first acking VIRTIO_NET_F_CTRL_VQ
3419 * feature to establish it. For now, we create the control queue proactively to accomodate a potentially
3420 * badly behaved but officially sanctioned legacy virtio-net driver, but *destroy* that same queue
3421 * if a driver announces as 'modern' during feature finalization yet leaves VIRTIO_NET_F_CTRL_VQ un-ack'd.
3422 */
3423static DECLCALLBACK(int) virtioNetR3Construct(PPDMDEVINS pDevIns, int iInstance, PCFGMNODE pCfg)
3424{
3425 PDMDEV_CHECK_VERSIONS_RETURN(pDevIns);
3426 PVIRTIONET pThis = PDMDEVINS_2_DATA(pDevIns, PVIRTIONET);
3427 PVIRTIONETCC pThisCC = PDMDEVINS_2_DATA_CC(pDevIns, PVIRTIONETCC);
3428 PCPDMDEVHLPR3 pHlp = pDevIns->pHlpR3;
3429
3430 /*
3431 * Quickly initialize state data to ensure destructor always works.
3432 */
3433 Log7Func(("PDM device instance: %d\n", iInstance));
3434 RTStrPrintf(pThis->szInst, sizeof(pThis->szInst), "virtio-net #%d", iInstance);
3435
3436 pThisCC->pDevIns = pDevIns;
3437 pThisCC->IBase.pfnQueryInterface = virtioNetR3QueryInterface;
3438 pThisCC->ILeds.pfnQueryStatusLed = virtioNetR3QueryStatusLed;
3439 pThisCC->led.u32Magic = PDMLED_MAGIC;
3440
3441 /* Interfaces */
3442 pThisCC->INetworkDown.pfnWaitReceiveAvail = virtioNetR3NetworkDown_WaitReceiveAvail;
3443 pThisCC->INetworkDown.pfnReceive = virtioNetR3NetworkDown_Receive;
3444 pThisCC->INetworkDown.pfnReceiveGso = virtioNetR3NetworkDown_ReceiveGso;
3445 pThisCC->INetworkDown.pfnXmitPending = virtioNetR3NetworkDown_XmitPending;
3446 pThisCC->INetworkConfig.pfnGetMac = virtioNetR3NetworkConfig_GetMac;
3447 pThisCC->INetworkConfig.pfnGetLinkState = virtioNetR3NetworkConfig_GetLinkState;
3448 pThisCC->INetworkConfig.pfnSetLinkState = virtioNetR3NetworkConfig_SetLinkState;
3449
3450 pThis->hEventRxDescAvail = NIL_SUPSEMEVENT;
3451
3452 /*
3453 * Validate configuration.
3454 */
3455 PDMDEV_VALIDATE_CONFIG_RETURN(pDevIns, "MAC"
3456 "|CableConnected"
3457 "|LineSpeed"
3458 "|LinkUpDelay"
3459 "|StatNo"
3460 "|Legacy"
3461 "|MmioBase"
3462 "|Irq", "");
3463
3464 /* Get config params */
3465 int rc = pHlp->pfnCFGMQueryBytes(pCfg, "MAC", pThis->macConfigured.au8, sizeof(pThis->macConfigured));
3466 if (RT_FAILURE(rc))
3467 return PDMDEV_SET_ERROR(pDevIns, rc, N_("Configuration error: Failed to get MAC address"));
3468
3469 rc = pHlp->pfnCFGMQueryBool(pCfg, "CableConnected", &pThis->fCableConnected);
3470 if (RT_FAILURE(rc))
3471 return PDMDEV_SET_ERROR(pDevIns, rc, N_("Configuration error: Failed to get the value of 'CableConnected'"));
3472
3473 uint32_t uStatNo = iInstance;
3474 rc = pHlp->pfnCFGMQueryU32Def(pCfg, "StatNo", &uStatNo, iInstance);
3475 if (RT_FAILURE(rc))
3476 return PDMDEV_SET_ERROR(pDevIns, rc, N_("Configuration error: Failed to get the \"StatNo\" value"));
3477
3478 rc = pHlp->pfnCFGMQueryU32Def(pCfg, "LinkUpDelay", &pThis->cMsLinkUpDelay, 5000); /* ms */
3479 if (RT_FAILURE(rc))
3480 return PDMDEV_SET_ERROR(pDevIns, rc, N_("Configuration error: Failed to get the value of 'LinkUpDelay'"));
3481
3482 Assert(pThis->cMsLinkUpDelay <= 300000); /* less than 5 minutes */
3483
3484 if (pThis->cMsLinkUpDelay > 5000 || pThis->cMsLinkUpDelay < 100)
3485 LogRel(("%s WARNING! Link up delay is set to %u seconds!\n",
3486 pThis->szInst, pThis->cMsLinkUpDelay / 1000));
3487
3488 Log(("[%s] Link up delay is set to %u seconds\n", pThis->szInst, pThis->cMsLinkUpDelay / 1000));
3489
3490 /* Copy the MAC address configured for the VM to the MMIO accessible Virtio dev-specific config area */
3491 memcpy(pThis->virtioNetConfig.uMacAddress.au8, pThis->macConfigured.au8, sizeof(pThis->virtioNetConfig.uMacAddress)); /* TBD */
3492
3493 Log(("Using MAC address for %s: %2x:%2x:%2x:%2x:%2x:%2x\n", pThis->szInst,
3494 pThis->macConfigured.au8[0], pThis->macConfigured.au8[1], pThis->macConfigured.au8[2],
3495 pThis->macConfigured.au8[3], pThis->macConfigured.au8[4], pThis->macConfigured.au8[5]));
3496
3497 LogFunc(("RC=%RTbool R0=%RTbool\n", pDevIns->fRCEnabled, pDevIns->fR0Enabled));
3498
3499 /*
3500 * Configure Virtio core (generic Virtio queue and infrastructure management) parameters.
3501 */
3502# if FEATURE_OFFERED(STATUS)
3503 pThis->virtioNetConfig.uStatus = 0;
3504# endif
3505
3506 pThis->virtioNetConfig.uMaxVirtqPairs = VIRTIONET_MAX_QPAIRS;
3507 pThisCC->Virtio.pfnFeatureNegotiationComplete = pfnFeatureNegotiationComplete;
3508 pThisCC->Virtio.pfnVirtqNotified = virtioNetVirtqNotified;
3509 pThisCC->Virtio.pfnStatusChanged = virtioNetR3StatusChg;
3510 pThisCC->Virtio.pfnDevCapRead = virtioNetR3DevCapRead;
3511 pThisCC->Virtio.pfnDevCapWrite = virtioNetR3DevCapWrite;
3512
3513 VIRTIOPCIPARAMS VirtioPciParams;
3514 VirtioPciParams.uDeviceId = PCI_DEVICE_ID_VIRTIONET_HOST;
3515 VirtioPciParams.uClassBase = VBOX_PCI_CLASS_NETWORK;
3516 VirtioPciParams.uClassSub = VBOX_PCI_SUB_NETWORK_ETHERNET;
3517 VirtioPciParams.uClassProg = PCI_CLASS_PROG_UNSPECIFIED;
3518 VirtioPciParams.uSubsystemId = DEVICE_PCI_NETWORK_SUBSYSTEM; /* VirtIO 1.0 allows PCI Device ID here */
3519 VirtioPciParams.uInterruptLine = 0x00;
3520 VirtioPciParams.uInterruptPin = 0x01;
3521 VirtioPciParams.uDeviceType = VIRTIO_DEVICE_TYPE_NETWORK;
3522
3523 /* Create semaphore used to synchronize/throttle the downstream LUN's Rx waiter thread. */
3524 rc = PDMDevHlpSUPSemEventCreate(pDevIns, &pThis->hEventRxDescAvail);
3525 if (RT_FAILURE(rc))
3526 return PDMDEV_SET_ERROR(pDevIns, rc, N_("Failed to create event semaphore"));
3527
3528 pThis->fOfferLegacy = VIRTIONET_TRANSITIONAL_ENABLE_FLAG;
3529 virtioNetConfigurePktHdr(pThis, pThis->fOfferLegacy); /* set defaults */
3530
3531 /* Initialize VirtIO core. (*pfnStatusChanged)() callback occurs when both host VirtIO core & guest driver are ready) */
3532 rc = virtioCoreR3Init(pDevIns, &pThis->Virtio, &pThisCC->Virtio, &VirtioPciParams, pThis->szInst,
3533 VIRTIONET_HOST_FEATURES_OFFERED, pThis->fOfferLegacy,
3534 &pThis->virtioNetConfig /*pvDevSpecificCap*/, sizeof(pThis->virtioNetConfig));
3535 if (RT_FAILURE(rc))
3536 return PDMDEV_SET_ERROR(pDevIns, rc, N_("virtio-net: failed to initialize VirtIO"));
3537
3538 pThis->fNegotiatedFeatures = virtioCoreGetNegotiatedFeatures(&pThis->Virtio);
3539 /** @todo validating features at this point is most probably pointless, as the negotiation hasn't started yet. */
3540 if (!virtioNetValidateRequiredFeatures(pThis->fNegotiatedFeatures))
3541 return PDMDEV_SET_ERROR(pDevIns, rc, N_("virtio-net: Required features not successfully negotiated."));
3542 pThis->cVirtqPairs = pThis->virtioNetConfig.uMaxVirtqPairs;
3543 pThis->cVirtqs += pThis->cVirtqPairs * 2 + 1;
3544 pThis->aVirtqs[CTRLQIDX].fCtlVirtq = true;
3545
3546 virtioNetR3SetVirtqNames(pThis, pThis->fOfferLegacy);
3547 for (unsigned uVirtqNbr = 0; uVirtqNbr < pThis->cVirtqs; uVirtqNbr++)
3548 {
3549 PVIRTIONETVIRTQ pVirtq = &pThis->aVirtqs[uVirtqNbr];
3550 PVIRTIONETWORKER pWorker = &pThis->aWorkers[uVirtqNbr];
3551 PVIRTIONETWORKERR3 pWorkerR3 = &pThisCC->aWorkers[uVirtqNbr];
3552 pVirtq->uIdx = pWorker->uIdx = pWorkerR3->uIdx = uVirtqNbr;
3553 }
3554 /*
3555 * Create queue workers for life of instance. (I.e. they persist through VirtIO bounces)
3556 */
3557 rc = virtioNetR3CreateWorkerThreads(pDevIns, pThis, pThisCC);
3558 if (RT_FAILURE(rc))
3559 return PDMDEV_SET_ERROR(pDevIns, rc, N_("Failed to create worker threads"));
3560
3561 /* Create Link Up Timer */
3562 rc = PDMDevHlpTimerCreate(pDevIns, TMCLOCK_VIRTUAL, virtioNetR3LinkUpTimer, NULL,
3563 TMTIMER_FLAGS_NO_CRIT_SECT | TMTIMER_FLAGS_NO_RING0,
3564 "VirtioNet Link Up", &pThisCC->hLinkUpTimer);
3565 /*
3566 * Attach network driver instance
3567 */
3568 rc = PDMDevHlpDriverAttach(pDevIns, 0, &pThisCC->IBase, &pThisCC->pDrvBase, "Network Port");
3569 if (RT_SUCCESS(rc))
3570 {
3571 pThisCC->pDrv = PDMIBASE_QUERY_INTERFACE(pThisCC->pDrvBase, PDMINETWORKUP);
3572 AssertMsgStmt(pThisCC->pDrv, ("Failed to obtain the PDMINETWORKUP interface!\n"),
3573 rc = VERR_PDM_MISSING_INTERFACE_BELOW);
3574 }
3575 else if ( rc == VERR_PDM_NO_ATTACHED_DRIVER
3576 || rc == VERR_PDM_CFG_MISSING_DRIVER_NAME)
3577 {
3578 /* No error! */
3579 Log(("[%s] No attached driver!\n", pThis->szInst));
3580 }
3581 else
3582 return PDMDEV_SET_ERROR(pDevIns, rc, N_("Failed to attach the network LUN"));
3583 /*
3584 * Status driver
3585 */
3586 PPDMIBASE pUpBase;
3587 rc = PDMDevHlpDriverAttach(pDevIns, PDM_STATUS_LUN, &pThisCC->IBase, &pUpBase, "Status Port");
3588 if (RT_SUCCESS(rc))
3589 pThisCC->pLedsConnector = PDMIBASE_QUERY_INTERFACE(pUpBase, PDMILEDCONNECTORS);
3590 else if (rc != VERR_PDM_NO_ATTACHED_DRIVER)
3591 return PDMDEV_SET_ERROR(pDevIns, rc, N_("Failed to attach the status LUN"));
3592
3593 /*
3594 * Register saved state.
3595 */
3596 rc = PDMDevHlpSSMRegisterEx(pDevIns, VIRTIONET_SAVEDSTATE_VERSION, sizeof(*pThis), NULL,
3597 NULL, NULL, NULL, /** @todo r=aeichner Teleportation? */
3598 NULL, virtioNetR3ModernSaveExec, NULL,
3599 NULL, virtioNetR3ModernLoadExec, virtioNetR3ModernLoadDone);
3600 AssertRCReturn(rc, rc);
3601 /*
3602 * Statistics and debug stuff.
3603 * The /Public/ bits are official and used by session info in the GUI.
3604 */
3605 PDMDevHlpSTAMRegisterF(pDevIns, &pThis->StatReceiveBytes, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_BYTES,
3606 "Amount of data received", "/Public/NetAdapter/%u/BytesReceived", uStatNo);
3607 PDMDevHlpSTAMRegisterF(pDevIns, &pThis->StatTransmitBytes, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_BYTES,
3608 "Amount of data transmitted", "/Public/NetAdapter/%u/BytesTransmitted", uStatNo);
3609 PDMDevHlpSTAMRegisterF(pDevIns, &pDevIns->iInstance, STAMTYPE_U32, STAMVISIBILITY_ALWAYS, STAMUNIT_NONE,
3610 "Device instance number", "/Public/NetAdapter/%u/%s", uStatNo, pDevIns->pReg->szName);
3611
3612 PDMDevHlpSTAMRegister(pDevIns, &pThis->StatReceiveBytes, STAMTYPE_COUNTER, "ReceiveBytes", STAMUNIT_BYTES, "Amount of data received");
3613 PDMDevHlpSTAMRegister(pDevIns, &pThis->StatTransmitBytes, STAMTYPE_COUNTER, "TransmitBytes", STAMUNIT_BYTES, "Amount of data transmitted");
3614 PDMDevHlpSTAMRegister(pDevIns, &pThis->StatReceiveGSO, STAMTYPE_COUNTER, "Packets/ReceiveGSO", STAMUNIT_COUNT, "Number of received GSO packets");
3615 PDMDevHlpSTAMRegister(pDevIns, &pThis->StatTransmitPackets, STAMTYPE_COUNTER, "Packets/Transmit", STAMUNIT_COUNT, "Number of sent packets");
3616 PDMDevHlpSTAMRegister(pDevIns, &pThis->StatTransmitGSO, STAMTYPE_COUNTER, "Packets/Transmit-Gso", STAMUNIT_COUNT, "Number of sent GSO packets");
3617 PDMDevHlpSTAMRegister(pDevIns, &pThis->StatTransmitCSum, STAMTYPE_COUNTER, "Packets/Transmit-Csum", STAMUNIT_COUNT, "Number of completed TX checksums");
3618# ifdef VBOX_WITH_STATISTICS
3619 PDMDevHlpSTAMRegister(pDevIns, &pThis->StatReceive, STAMTYPE_PROFILE, "Receive/Total", STAMUNIT_TICKS_PER_CALL, "Profiling receive");
3620 PDMDevHlpSTAMRegister(pDevIns, &pThis->StatReceiveStore, STAMTYPE_PROFILE, "Receive/Store", STAMUNIT_TICKS_PER_CALL, "Profiling receive storing");
3621 PDMDevHlpSTAMRegister(pDevIns, &pThis->StatRxOverflow, STAMTYPE_PROFILE, "RxOverflow", STAMUNIT_TICKS_PER_OCCURENCE, "Profiling RX overflows");
3622 PDMDevHlpSTAMRegister(pDevIns, &pThis->StatRxOverflowWakeup, STAMTYPE_COUNTER, "RxOverflowWakeup", STAMUNIT_OCCURENCES, "Nr of RX overflow wakeups");
3623 PDMDevHlpSTAMRegister(pDevIns, &pThis->StatTransmit, STAMTYPE_PROFILE, "Transmit/Total", STAMUNIT_TICKS_PER_CALL, "Profiling transmits in HC");
3624 PDMDevHlpSTAMRegister(pDevIns, &pThis->StatTransmitSend, STAMTYPE_PROFILE, "Transmit/Send", STAMUNIT_TICKS_PER_CALL, "Profiling send transmit in HC");
3625 PDMDevHlpSTAMRegister(pDevIns, &pThis->StatTransmitByNetwork, STAMTYPE_COUNTER, "Transmit/ByNetwork", STAMUNIT_COUNT, "Network-initiated transmissions");
3626 PDMDevHlpSTAMRegister(pDevIns, &pThis->StatTransmitByThread, STAMTYPE_COUNTER, "Transmit/ByThread", STAMUNIT_COUNT, "Thread-initiated transmissions");
3627# endif
3628 /*
3629 * Register the debugger info callback (ignore errors).
3630 */
3631 char szTmp[128];
3632 rc = PDMDevHlpDBGFInfoRegister(pDevIns, "virtio-net", "Display virtio-net info (help, net, features, state, pointers, queues, all)", virtioNetR3Info);
3633 if (RT_FAILURE(rc))
3634 LogRel(("Failed to register DBGF info for device %s\n", szTmp));
3635 return rc;
3636}
3637
3638#else /* !IN_RING3 */
3639
3640/**
3641 * @callback_method_impl{PDMDEVREGR0,pfnConstruct}
3642 */
3643static DECLCALLBACK(int) virtioNetRZConstruct(PPDMDEVINS pDevIns)
3644{
3645 PDMDEV_CHECK_VERSIONS_RETURN(pDevIns);
3646 PVIRTIONET pThis = PDMDEVINS_2_DATA(pDevIns, PVIRTIONET);
3647 PVIRTIONETCC pThisCC = PDMDEVINS_2_DATA_CC(pDevIns, PVIRTIONETCC);
3648 pThisCC->Virtio.pfnVirtqNotified = virtioNetVirtqNotified;
3649 return virtioCoreRZInit(pDevIns, &pThis->Virtio);
3650}
3651
3652#endif /* !IN_RING3 */
3653
3654/**
3655 * The device registration structure.
3656 */
3657const PDMDEVREG g_DeviceVirtioNet =
3658{
3659 /* .uVersion = */ PDM_DEVREG_VERSION,
3660 /* .uReserved0 = */ 0,
3661 /* .szName = */ "virtio-net",
3662 /* .fFlags = */ PDM_DEVREG_FLAGS_DEFAULT_BITS | PDM_DEVREG_FLAGS_NEW_STYLE | PDM_DEVREG_FLAGS_RZ,
3663 /* .fClass = */ PDM_DEVREG_CLASS_NETWORK,
3664 /* .cMaxInstances = */ ~0U,
3665 /* .uSharedVersion = */ 42,
3666 /* .cbInstanceShared = */ sizeof(VIRTIONET),
3667 /* .cbInstanceCC = */ sizeof(VIRTIONETCC),
3668 /* .cbInstanceRC = */ sizeof(VIRTIONETRC),
3669 /* .cMaxPciDevices = */ 1,
3670 /* .cMaxMsixVectors = */ VBOX_MSIX_MAX_ENTRIES,
3671 /* .pszDescription = */ "Virtio Host NET.\n",
3672#if defined(IN_RING3)
3673 /* .pszRCMod = */ "VBoxDDRC.rc",
3674 /* .pszR0Mod = */ "VBoxDDR0.r0",
3675 /* .pfnConstruct = */ virtioNetR3Construct,
3676 /* .pfnDestruct = */ virtioNetR3Destruct,
3677 /* .pfnRelocate = */ NULL,
3678 /* .pfnMemSetup = */ NULL,
3679 /* .pfnPowerOn = */ NULL,
3680 /* .pfnReset = */ virtioNetR3Reset,
3681 /* .pfnSuspend = */ virtioNetWakeupRxBufWaiter,
3682 /* .pfnResume = */ NULL,
3683 /* .pfnAttach = */ virtioNetR3Attach,
3684 /* .pfnDetach = */ virtioNetR3Detach,
3685 /* .pfnQueryInterface = */ NULL,
3686 /* .pfnInitComplete = */ NULL,
3687 /* .pfnPowerOff = */ virtioNetWakeupRxBufWaiter,
3688 /* .pfnSoftReset = */ NULL,
3689 /* .pfnReserved0 = */ NULL,
3690 /* .pfnReserved1 = */ NULL,
3691 /* .pfnReserved2 = */ NULL,
3692 /* .pfnReserved3 = */ NULL,
3693 /* .pfnReserved4 = */ NULL,
3694 /* .pfnReserved5 = */ NULL,
3695 /* .pfnReserved6 = */ NULL,
3696 /* .pfnReserved7 = */ NULL,
3697#elif defined(IN_RING0)
3698 /* .pfnEarlyConstruct = */ NULL,
3699 /* .pfnConstruct = */ virtioNetRZConstruct,
3700 /* .pfnDestruct = */ NULL,
3701 /* .pfnFinalDestruct = */ NULL,
3702 /* .pfnRequest = */ NULL,
3703 /* .pfnReserved0 = */ NULL,
3704 /* .pfnReserved1 = */ NULL,
3705 /* .pfnReserved2 = */ NULL,
3706 /* .pfnReserved3 = */ NULL,
3707 /* .pfnReserved4 = */ NULL,
3708 /* .pfnReserved5 = */ NULL,
3709 /* .pfnReserved6 = */ NULL,
3710 /* .pfnReserved7 = */ NULL,
3711#elif defined(IN_RC)
3712 /* .pfnConstruct = */ virtioNetRZConstruct,
3713 /* .pfnReserved0 = */ NULL,
3714 /* .pfnReserved1 = */ NULL,
3715 /* .pfnReserved2 = */ NULL,
3716 /* .pfnReserved3 = */ NULL,
3717 /* .pfnReserved4 = */ NULL,
3718 /* .pfnReserved5 = */ NULL,
3719 /* .pfnReserved6 = */ NULL,
3720 /* .pfnReserved7 = */ NULL,
3721#else
3722# error "Not in IN_RING3, IN_RING0 or IN_RC!"
3723#endif
3724 /* .uVersionEnd = */ PDM_DEVREG_VERSION
3725};
3726
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