VirtualBox

source: vbox/trunk/src/VBox/Devices/Storage/DevVirtioSCSI.cpp@ 83582

Last change on this file since 83582 was 83582, checked in by vboxsync, 5 years ago

DevVirtioSCSI.cpp: doxygen fix. bugref:9440
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 116.6 KB
Line 
1 /* $Id: DevVirtioSCSI.cpp 83582 2020-04-06 01:54:09Z vboxsync $ $Revision: 83582 $ $Date: 2020-04-06 01:54:09 +0000 (Mon, 06 Apr 2020) $ $Author: vboxsync $ */
2/** @file
3 * VBox storage devices - Virtio SCSI Driver
4 *
5 * Log-levels used:
6 * - Level 1: The most important (but usually rare) things to note
7 * - Level 2: SCSI command logging
8 * - Level 3: Vector and I/O transfer summary (shows what client sent an expects and fulfillment)
9 * - Level 6: Device <-> Guest Driver negotation, traffic, notifications and state handling
10 * - Level 12: Brief formatted hex dumps of I/O data
11 */
12
13/*
14 * Copyright (C) 2006-2020 Oracle Corporation
15 *
16 * This file is part of VirtualBox Open Source Edition (OSE), as
17 * available from http://www.virtualbox.org. This file is free software;
18 * you can redistribute it and/or modify it under the terms of the GNU
19 * General Public License (GPL) as published by the Free Software
20 * Foundation, in version 2 as it comes in the "COPYING" file of the
21 * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
22 * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
23 */
24
25
26/*********************************************************************************************************************************
27* Header Files *
28*********************************************************************************************************************************/
29//#define LOG_GROUP LOG_GROUP_DRV_SCSI
30#define LOG_GROUP LOG_GROUP_DEV_VIRTIO
31
32#include <VBox/vmm/pdmdev.h>
33#include <VBox/vmm/pdmstorageifs.h>
34#include <VBox/vmm/pdmcritsect.h>
35#include <VBox/AssertGuest.h>
36#include <VBox/msi.h>
37#include <VBox/version.h>
38#include <VBox/log.h>
39#include <iprt/errcore.h>
40#include <iprt/assert.h>
41#include <iprt/string.h>
42#include <VBox/sup.h>
43#include "../build/VBoxDD.h"
44#include <VBox/scsi.h>
45#ifdef IN_RING3
46# include <iprt/alloc.h>
47# include <iprt/memcache.h>
48# include <iprt/semaphore.h>
49# include <iprt/sg.h>
50# include <iprt/param.h>
51# include <iprt/uuid.h>
52#endif
53#include "../VirtIO/Virtio_1_0.h"
54
55#include "VBoxSCSI.h"
56#include "VBoxDD.h"
57
58
59/*********************************************************************************************************************************
60* Defined Constants And Macros *
61*********************************************************************************************************************************/
62/** The current saved state version. */
63#define VIRTIOSCSI_SAVED_STATE_VERSION UINT32_C(1)
64
65
66#define LUN0 0
67/** @name VirtIO 1.0 SCSI Host feature bits (See VirtIO 1.0 specification, Section 5.6.3)
68 * @{ */
69#define VIRTIO_SCSI_F_INOUT RT_BIT_64(0) /** Request is device readable AND writeable */
70#define VIRTIO_SCSI_F_HOTPLUG RT_BIT_64(1) /** Host allows hotplugging SCSI LUNs & targets */
71#define VIRTIO_SCSI_F_CHANGE RT_BIT_64(2) /** Host LUNs chgs via VIRTIOSCSI_T_PARAM_CHANGE evt */
72#define VIRTIO_SCSI_F_T10_PI RT_BIT_64(3) /** Add T10 port info (DIF/DIX) in SCSI req hdr */
73/** @} */
74
75
76#define VIRTIOSCSI_HOST_SCSI_FEATURES_ALL \
77 (VIRTIO_SCSI_F_INOUT | VIRTIO_SCSI_F_HOTPLUG | VIRTIO_SCSI_F_CHANGE | VIRTIO_SCSI_F_T10_PI)
78
79#define VIRTIOSCSI_HOST_SCSI_FEATURES_NONE 0
80
81#define VIRTIOSCSI_HOST_SCSI_FEATURES_OFFERED VIRTIOSCSI_HOST_SCSI_FEATURES_NONE
82
83#define VIRTIOSCSI_REQ_QUEUE_CNT 4 /**< T.B.D. Consider increasing */
84#define VIRTIOSCSI_QUEUE_CNT (VIRTIOSCSI_REQ_QUEUE_CNT + 2)
85#define VIRTIOSCSI_MAX_TARGETS 256 /**< T.B.D. Figure out a a good value for this. */
86#define VIRTIOSCSI_MAX_LUN 256 /**< VirtIO specification, section 5.6.4 */
87#define VIRTIOSCSI_MAX_COMMANDS_PER_LUN 128 /**< T.B.D. What is a good value for this? */
88#define VIRTIOSCSI_MAX_SEG_COUNT 126 /**< T.B.D. What is a good value for this? */
89#define VIRTIOSCSI_MAX_SECTORS_HINT 0x10000 /**< VirtIO specification, section 5.6.4 */
90#define VIRTIOSCSI_MAX_CHANNEL_HINT 0 /**< VirtIO specification, section 5.6.4 should be 0 */
91
92#define PCI_DEVICE_ID_VIRTIOSCSI_HOST 0x1048 /**< Informs guest driver of type of VirtIO device */
93#define PCI_CLASS_BASE_MASS_STORAGE 0x01 /**< PCI Mass Storage device class */
94#define PCI_CLASS_SUB_SCSI_STORAGE_CONTROLLER 0x00 /**< PCI SCSI Controller subclass */
95#define PCI_CLASS_PROG_UNSPECIFIED 0x00 /**< Programming interface. N/A. */
96#define VIRTIOSCSI_PCI_CLASS 0x01 /**< Base class Mass Storage? */
97
98#define VIRTIOSCSI_SENSE_SIZE_DEFAULT 96 /**< VirtIO 1.0: 96 on reset, guest can change */
99#define VIRTIOSCSI_SENSE_SIZE_MAX 4096 /**< Picked out of thin air by bird. */
100#define VIRTIOSCSI_CDB_SIZE_DEFAULT 32 /**< VirtIO 1.0: 32 on reset, guest can change */
101#define VIRTIOSCSI_CDB_SIZE_MAX 255 /**< Picked out of thin air by bird. */
102#define VIRTIOSCSI_PI_BYTES_IN 1 /**< Value TBD (see section 5.6.6.1) */
103#define VIRTIOSCSI_PI_BYTES_OUT 1 /**< Value TBD (see section 5.6.6.1) */
104#define VIRTIOSCSI_DATA_OUT 512 /**< Value TBD (see section 5.6.6.1) */
105
106/**
107 * VirtIO SCSI Host Device device-specific queue indicies.
108 * (Note: # of request queues is determined by virtio_scsi_config.num_queues. VirtIO 1.0, 5.6.4)
109 */
110#define CONTROLQ_IDX 0 /**< Spec-defined Index of control queue */
111#define EVENTQ_IDX 1 /**< Spec-defined Index of event queue */
112#define VIRTQ_REQ_BASE 2 /**< Spec-defined base index of request queues */
113
114#define VIRTQNAME(qIdx) (pThis->aszVirtqNames[qIdx]) /**< Macro to get queue name from its index */
115#define CBVIRTQNAME(qIdx) RTStrNLen(VIRTQNAME(qIdx), sizeof(VIRTQNAME(qIdx)))
116
117#define IS_REQ_QUEUE(qIdx) (qIdx >= VIRTQ_REQ_BASE && qIdx < VIRTIOSCSI_QUEUE_CNT)
118
119#define VIRTIO_IS_IN_DIRECTION(pMediaExTxDirEnumValue) \
120 ((pMediaExTxDirEnumValue) == PDMMEDIAEXIOREQSCSITXDIR_FROM_DEVICE)
121
122#define VIRTIO_IS_OUT_DIRECTION(pMediaExTxDirEnumValue) \
123 ((pMediaExTxDirEnumValue) == PDMMEDIAEXIOREQSCSITXDIR_TO_DEVICE)
124
125
126/*********************************************************************************************************************************
127* Structures and Typedefs *
128*********************************************************************************************************************************/
129/**
130 * VirtIO SCSI Host Device device-specific configuration (see VirtIO 1.0, section 5.6.4)
131 * VBox VirtIO core issues callback to this VirtIO device-specific implementation to handle
132 * MMIO accesses to device-specific configuration parameters.
133 */
134typedef struct virtio_scsi_config
135{
136 uint32_t uNumQueues; /**< num_queues \# of req q's exposed by dev */
137 uint32_t uSegMax; /**< seg_max Max \# of segs allowed in cmd */
138 uint32_t uMaxSectors; /**< max_sectors Hint to guest max xfer to use */
139 uint32_t uCmdPerLun; /**< cmd_per_lun Max \# of link cmd sent per lun */
140 uint32_t uEventInfoSize; /**< event_info_size Fill max, evtq bufs */
141 uint32_t uSenseSize; /**< sense_size Max sense data size dev writes */
142 uint32_t uCdbSize; /**< cdb_size Max CDB size driver writes */
143 uint16_t uMaxChannel; /**< max_channel Hint to guest driver */
144 uint16_t uMaxTarget; /**< max_target Hint to guest driver */
145 uint32_t uMaxLun; /**< max_lun Hint to guest driver */
146} VIRTIOSCSI_CONFIG_T, PVIRTIOSCSI_CONFIG_T;
147
148/** @name VirtIO 1.0 SCSI Host Device device specific control types
149 * @{ */
150#define VIRTIOSCSI_T_NO_EVENT 0
151#define VIRTIOSCSI_T_TRANSPORT_RESET 1
152#define VIRTIOSCSI_T_ASYNC_NOTIFY 2 /**< Asynchronous notification */
153#define VIRTIOSCSI_T_PARAM_CHANGE 3
154/** @} */
155
156/**
157 * Device operation: eventq
158 */
159#define VIRTIOSCSI_T_EVENTS_MISSED UINT32_C(0x80000000)
160typedef struct virtio_scsi_event
161{
162 // Device-writable part
163 uint32_t uEvent; /**< event */
164 uint8_t abVirtioLun[8]; /**< lun */
165 uint32_t uReason; /**< reason */
166} VIRTIOSCSI_EVENT_T, *PVIRTIOSCSI_EVENT_T;
167
168/** @name VirtIO 1.0 SCSI Host Device device specific event types
169 * @{ */
170#define VIRTIOSCSI_EVT_RESET_HARD 0 /**< */
171#define VIRTIOSCSI_EVT_RESET_RESCAN 1 /**< */
172#define VIRTIOSCSI_EVT_RESET_REMOVED 2 /**< */
173/** @} */
174
175/**
176 * Device operation: reqestq
177 */
178#pragma pack(1)
179typedef struct REQ_CMD_HDR_T
180{
181 uint8_t abVirtioLun[8]; /**< lun */
182 uint64_t uId; /**< id */
183 uint8_t uTaskAttr; /**< task_attr */
184 uint8_t uPrio; /**< prio */
185 uint8_t uCrn; /**< crn */
186} REQ_CMD_HDR_T;
187#pragma pack()
188AssertCompileSize(REQ_CMD_HDR_T, 19);
189
190typedef struct REQ_CMD_PI_T
191{
192 uint32_t uPiBytesOut; /**< pi_bytesout */
193 uint32_t uPiBytesIn; /**< pi_bytesin */
194} REQ_CMD_PI_T;
195AssertCompileSize(REQ_CMD_PI_T, 8);
196
197typedef struct REQ_RESP_HDR_T
198{
199 uint32_t cbSenseLen; /**< sense_len */
200 uint32_t uResidual; /**< residual */
201 uint16_t uStatusQualifier; /**< status_qualifier */
202 uint8_t uStatus; /**< status SCSI status code */
203 uint8_t uResponse; /**< response */
204} REQ_RESP_HDR_T;
205AssertCompileSize(REQ_RESP_HDR_T, 12);
206
207#pragma pack(1)
208typedef struct VIRTIOSCSI_REQ_CMD_T
209{
210 /** Device-readable section
211 * @{ */
212 REQ_CMD_HDR_T ReqHdr;
213 uint8_t uCdb[1]; /**< cdb */
214
215 REQ_CMD_PI_T piHdr; /**< T10 Pi block integrity (optional feature) */
216 uint8_t uPiOut[1]; /**< pi_out[] T10 pi block integrity */
217 uint8_t uDataOut[1]; /**< dataout */
218 /** @} */
219
220 /** @name Device writable section
221 * @{ */
222 REQ_RESP_HDR_T respHdr;
223 uint8_t uSense[1]; /**< sense */
224 uint8_t uPiIn[1]; /**< pi_in[] T10 Pi block integrity */
225 uint8_t uDataIn[1]; /**< detain; */
226 /** @} */
227} VIRTIOSCSI_REQ_CMD_T, *PVIRTIOSCSI_REQ_CMD_T;
228#pragma pack()
229AssertCompileSize(VIRTIOSCSI_REQ_CMD_T, 19+8+12+6);
230
231/** @name VirtIO 1.0 SCSI Host Device Req command-specific response values
232 * @{ */
233#define VIRTIOSCSI_S_OK 0 /**< control, command */
234#define VIRTIOSCSI_S_OVERRUN 1 /**< control */
235#define VIRTIOSCSI_S_ABORTED 2 /**< control */
236#define VIRTIOSCSI_S_BAD_TARGET 3 /**< control, command */
237#define VIRTIOSCSI_S_RESET 4 /**< control */
238#define VIRTIOSCSI_S_BUSY 5 /**< control, command */
239#define VIRTIOSCSI_S_TRANSPORT_FAILURE 6 /**< control, command */
240#define VIRTIOSCSI_S_TARGET_FAILURE 7 /**< control, command */
241#define VIRTIOSCSI_S_NEXUS_FAILURE 8 /**< control, command */
242#define VIRTIOSCSI_S_FAILURE 9 /**< control, command */
243#define VIRTIOSCSI_S_INCORRECT_LUN 12 /**< command */
244/** @} */
245
246/** @name VirtIO 1.0 SCSI Host Device command-specific task_attr values
247 * @{ */
248#define VIRTIOSCSI_S_SIMPLE 0 /**< */
249#define VIRTIOSCSI_S_ORDERED 1 /**< */
250#define VIRTIOSCSI_S_HEAD 2 /**< */
251#define VIRTIOSCSI_S_ACA 3 /**< */
252/** @} */
253
254/**
255 * VirtIO 1.0 SCSI Host Device Control command before we know type (5.6.6.2)
256 */
257typedef struct VIRTIOSCSI_CTRL_T
258{
259 uint32_t uType;
260} VIRTIOSCSI_CTRL_T, *PVIRTIOSCSI_CTRL_T;
261
262/** @name VirtIO 1.0 SCSI Host Device command-specific TMF values
263 * @{ */
264#define VIRTIOSCSI_T_TMF 0 /**< */
265#define VIRTIOSCSI_T_TMF_ABORT_TASK 0 /**< */
266#define VIRTIOSCSI_T_TMF_ABORT_TASK_SET 1 /**< */
267#define VIRTIOSCSI_T_TMF_CLEAR_ACA 2 /**< */
268#define VIRTIOSCSI_T_TMF_CLEAR_TASK_SET 3 /**< */
269#define VIRTIOSCSI_T_TMF_I_T_NEXUS_RESET 4 /**< */
270#define VIRTIOSCSI_T_TMF_LOGICAL_UNIT_RESET 5 /**< */
271#define VIRTIOSCSI_T_TMF_QUERY_TASK 6 /**< */
272#define VIRTIOSCSI_T_TMF_QUERY_TASK_SET 7 /**< */
273/** @} */
274
275#pragma pack(1)
276typedef struct VIRTIOSCSI_CTRL_TMF_T
277{
278 uint32_t uType; /**< type */
279 uint32_t uSubtype; /**< subtype */
280 uint8_t abScsiLun[8]; /**< lun */
281 uint64_t uId; /**< id */
282} VIRTIOSCSI_CTRL_TMF_T, *PVIRTIOSCSI_CTRL_TMF_T;
283#pragma pack()
284AssertCompileSize(VIRTIOSCSI_CTRL_TMF_T, 24);
285
286/** VirtIO 1.0 section 5.6.6.2, CTRL TMF response is an 8-bit status */
287
288/** @name VirtIO 1.0 SCSI Host Device device specific tmf control response values
289 * @{ */
290#define VIRTIOSCSI_S_FUNCTION_COMPLETE 0 /**< */
291#define VIRTIOSCSI_S_FUNCTION_SUCCEEDED 10 /**< */
292#define VIRTIOSCSI_S_FUNCTION_REJECTED 11 /**< */
293/** @} */
294
295#define VIRTIOSCSI_T_AN_QUERY 1 /**< Asynchronous notification query */
296#define VIRTIOSCSI_T_AN_SUBSCRIBE 2 /**< Asynchronous notification subscription */
297
298#pragma pack(1)
299typedef struct VIRTIOSCSI_CTRL_AN_T
300{
301 uint32_t uType; /**< type */
302 uint8_t abScsiLun[8]; /**< lun */
303 uint32_t fEventsRequested; /**< event_requested */
304} VIRTIOSCSI_CTRL_AN_T, *PVIRTIOSCSI_CTRL_AN_T;
305#pragma pack()
306AssertCompileSize(VIRTIOSCSI_CTRL_AN_T, 16);
307
308/** VirtIO 1.0, Section 5.6.6.2, CTRL AN response is 4-byte evt mask + 8-bit status */
309
310typedef union VIRTIO_SCSI_CTRL_UNION_T
311{
312 VIRTIOSCSI_CTRL_T Type;
313 VIRTIOSCSI_CTRL_TMF_T Tmf;
314 VIRTIOSCSI_CTRL_AN_T AsyncNotify;
315 uint8_t ab[24];
316} VIRTIO_SCSI_CTRL_UNION_T, *PVIRTIO_SCSI_CTRL_UNION_T;
317AssertCompile(sizeof(VIRTIO_SCSI_CTRL_UNION_T) == 24); /* VIRTIOSCSI_CTRL_T forces 4 byte alignment, the other two are byte packed. */
318
319/** @name VirtIO 1.0 SCSI Host Device device specific tmf control response values
320 * @{ */
321#define VIRTIOSCSI_EVT_ASYNC_OPERATIONAL_CHANGE 2 /**< */
322#define VIRTIOSCSI_EVT_ASYNC_POWER_MGMT 4 /**< */
323#define VIRTIOSCSI_EVT_ASYNC_EXTERNAL_REQUEST 8 /**< */
324#define VIRTIOSCSI_EVT_ASYNC_MEDIA_CHANGE 16 /**< */
325#define VIRTIOSCSI_EVT_ASYNC_MULTI_HOST 32 /**< */
326#define VIRTIOSCSI_EVT_ASYNC_DEVICE_BUSY 64 /**< */
327/** @} */
328
329#define SUBSCRIBABLE_EVENTS \
330 ( VIRTIOSCSI_EVT_ASYNC_OPERATIONAL_CHANGE \
331 | VIRTIOSCSI_EVT_ASYNC_POWER_MGMT \
332 | VIRTIOSCSI_EVT_ASYNC_EXTERNAL_REQUEST \
333 | VIRTIOSCSI_EVT_ASYNC_MEDIA_CHANGE \
334 | VIRTIOSCSI_EVT_ASYNC_MULTI_HOST \
335 | VIRTIOSCSI_EVT_ASYNC_DEVICE_BUSY )
336
337#define SUPPORTED_EVENTS 0 /* TBD */
338
339/**
340 * Worker thread context, shared state.
341 */
342typedef struct VIRTIOSCSIWORKER
343{
344 SUPSEMEVENT hEvtProcess; /**< handle of associated sleep/wake-up semaphore */
345} VIRTIOSCSIWORKER;
346/** Pointer to a VirtIO SCSI worker. */
347typedef VIRTIOSCSIWORKER *PVIRTIOSCSIWORKER;
348
349/**
350 * Worker thread context, ring-3 state.
351 */
352typedef struct VIRTIOSCSIWORKERR3
353{
354 R3PTRTYPE(PPDMTHREAD) pThread; /**< pointer to worker thread's handle */
355 bool volatile fSleeping; /**< Flags whether worker thread is sleeping or not */
356 bool volatile fNotified; /**< Flags whether worker thread notified */
357 uint16_t auRedoDescs[VIRTQ_MAX_SIZE];/**< List of previously suspended reqs to re-submit */
358 uint16_t cRedoDescs; /**< Number of redo desc chain head desc idxes in list */
359} VIRTIOSCSIWORKERR3;
360/** Pointer to a VirtIO SCSI worker. */
361typedef VIRTIOSCSIWORKERR3 *PVIRTIOSCSIWORKERR3;
362
363/**
364 * State of a target attached to the VirtIO SCSI Host
365 */
366typedef struct VIRTIOSCSITARGET
367{
368 /** The ring-3 device instance so we can easily get our bearings. */
369 PPDMDEVINSR3 pDevIns;
370 PPDMDEVINSRC pDevInsRC;
371 PPDMDEVINSR0 pDevInsR0;
372
373 /** Pointer to attached driver's base interface. */
374 R3PTRTYPE(PPDMIBASE) pDrvBase;
375
376 /** Target number (PDM LUN) */
377 uint32_t uTarget;
378
379 /** Target Description */
380 R3PTRTYPE(char *) pszTargetName;
381
382 /** Target base interface. */
383 PDMIBASE IBase;
384
385 /** Flag whether device is present. */
386 bool fPresent;
387
388 /** Media port interface. */
389 PDMIMEDIAPORT IMediaPort;
390
391 /** Pointer to the attached driver's media interface. */
392 R3PTRTYPE(PPDMIMEDIA) pDrvMedia;
393
394 /** Extended media port interface. */
395 PDMIMEDIAEXPORT IMediaExPort;
396
397 /** Pointer to the attached driver's extended media interface. */
398 R3PTRTYPE(PPDMIMEDIAEX) pDrvMediaEx;
399
400 /** Status LED interface */
401 PDMILEDPORTS ILed;
402
403 /** The status LED state for this device. */
404 PDMLED led;
405
406} VIRTIOSCSITARGET, *PVIRTIOSCSITARGET;
407
408/**
409 * VirtIO Host SCSI device state, shared edition.
410 *
411 * @extends VIRTIOCORE
412 */
413typedef struct VIRTIOSCSI
414{
415 /** The core virtio state. */
416 VIRTIOCORE Virtio;
417
418 /** VirtIO Host SCSI device runtime configuration parameters */
419 VIRTIOSCSI_CONFIG_T virtioScsiConfig;
420
421 bool fBootable;
422 bool afPadding0[3];
423
424 /** Number of targets in paTargetInstances. */
425 uint32_t cTargets;
426
427 /** Per device-bound virtq worker-thread contexts (eventq slot unused) */
428 VIRTIOSCSIWORKER aWorkers[VIRTIOSCSI_QUEUE_CNT];
429
430 /** Instance name */
431 char szInstance[16];
432
433 /** Device-specific spec-based VirtIO VIRTQNAMEs */
434 char aszVirtqNames[VIRTIOSCSI_QUEUE_CNT][VIRTIO_MAX_QUEUE_NAME_SIZE];
435
436 /** Track which VirtIO queues we've attached to */
437 bool afQueueAttached[VIRTIOSCSI_QUEUE_CNT];
438
439 /** Set if events missed due to lack of bufs avail on eventq */
440 bool fEventsMissed;
441
442 /** Explicit alignment padding. */
443 bool afPadding1[2];
444
445 /** Mask of VirtIO Async Event types this device will deliver */
446 uint32_t fAsyncEvtsEnabled;
447
448 /** Total number of requests active across all targets */
449 volatile uint32_t cActiveReqs;
450
451
452 /** True if the guest/driver and VirtIO framework are in the ready state */
453 uint32_t fVirtioReady;
454
455 /** True if VIRTIO_SCSI_F_T10_PI was negotiated */
456 uint32_t fHasT10pi;
457
458 /** True if VIRTIO_SCSI_F_T10_PI was negotiated */
459 uint32_t fHasHotplug;
460
461 /** True if VIRTIO_SCSI_F_T10_PI was negotiated */
462 uint32_t fHasInOutBufs;
463
464 /** True if VIRTIO_SCSI_F_T10_PI was negotiated */
465 uint32_t fHasLunChange;
466
467 /** True if in the process of resetting */
468 uint32_t fResetting;
469
470} VIRTIOSCSI;
471/** Pointer to the shared state of the VirtIO Host SCSI device. */
472typedef VIRTIOSCSI *PVIRTIOSCSI;
473
474
475/**
476 * VirtIO Host SCSI device state, ring-3 edition.
477 *
478 * @extends VIRTIOCORER3
479 */
480typedef struct VIRTIOSCSIR3
481{
482 /** The core virtio ring-3 state. */
483 VIRTIOCORER3 Virtio;
484
485 /** Array of per-target data. */
486 R3PTRTYPE(PVIRTIOSCSITARGET) paTargetInstances;
487
488 /** Per device-bound virtq worker-thread contexts (eventq slot unused) */
489 VIRTIOSCSIWORKERR3 aWorkers[VIRTIOSCSI_QUEUE_CNT];
490
491 /** Device base interface. */
492 PDMIBASE IBase;
493
494 /** Pointer to the device instance.
495 * @note Only used in interface callbacks. */
496 PPDMDEVINSR3 pDevIns;
497
498 /** Status Target: LEDs port interface. */
499 PDMILEDPORTS ILeds;
500
501 /** IMediaExPort: Media ejection notification */
502 R3PTRTYPE(PPDMIMEDIANOTIFY) pMediaNotify;
503
504 /** Queue to send tasks to R3. - HC ptr */
505 R3PTRTYPE(PPDMQUEUE) pNotifierQueueR3;
506
507 /** True if in the process of quiescing I/O */
508 uint32_t fQuiescing;
509
510 /** For which purpose we're quiescing. */
511 VIRTIOVMSTATECHANGED enmQuiescingFor;
512
513} VIRTIOSCSIR3;
514/** Pointer to the ring-3 state of the VirtIO Host SCSI device. */
515typedef VIRTIOSCSIR3 *PVIRTIOSCSIR3;
516
517
518/**
519 * VirtIO Host SCSI device state, ring-0 edition.
520 */
521typedef struct VIRTIOSCSIR0
522{
523 /** The core virtio ring-0 state. */
524 VIRTIOCORER0 Virtio;
525} VIRTIOSCSIR0;
526/** Pointer to the ring-0 state of the VirtIO Host SCSI device. */
527typedef VIRTIOSCSIR0 *PVIRTIOSCSIR0;
528
529
530/**
531 * VirtIO Host SCSI device state, raw-mode edition.
532 */
533typedef struct VIRTIOSCSIRC
534{
535 /** The core virtio raw-mode state. */
536 VIRTIOCORERC Virtio;
537} VIRTIOSCSIRC;
538/** Pointer to the ring-0 state of the VirtIO Host SCSI device. */
539typedef VIRTIOSCSIRC *PVIRTIOSCSIRC;
540
541
542/** @typedef VIRTIOSCSICC
543 * The instance data for the current context. */
544typedef CTX_SUFF(VIRTIOSCSI) VIRTIOSCSICC;
545/** @typedef PVIRTIOSCSICC
546 * Pointer to the instance data for the current context. */
547typedef CTX_SUFF(PVIRTIOSCSI) PVIRTIOSCSICC;
548
549
550/**
551 * Request structure for IMediaEx (Associated Interfaces implemented by DrvSCSI)
552 * @note cbIn, cbOUt, cbDataOut mostly for debugging
553 */
554typedef struct VIRTIOSCSIREQ
555{
556 PDMMEDIAEXIOREQ hIoReq; /**< Handle of I/O request */
557 PVIRTIOSCSITARGET pTarget; /**< Target */
558 uint16_t qIdx; /**< Index of queue this request arrived on */
559 PVIRTIO_DESC_CHAIN_T pDescChain; /**< Prepared desc chain pulled from virtq avail ring */
560 uint32_t cbDataIn; /**< size of dataout buffer */
561 uint32_t cbDataOut; /**< size of dataout buffer */
562 uint16_t uDataInOff; /**< Fixed size of respHdr + sense (precede datain) */
563 uint16_t uDataOutOff; /**< Fixed size of respHdr + sense (precede datain) */
564 uint32_t cbSenseAlloc; /**< Size of sense buffer */
565 size_t cbSenseLen; /**< Receives \# bytes written into sense buffer */
566 uint8_t *pbSense; /**< Pointer to R3 sense buffer */
567 PDMMEDIAEXIOREQSCSITXDIR enmTxDir; /**< Receives transfer direction of I/O req */
568 uint8_t uStatus; /**< SCSI status code */
569} VIRTIOSCSIREQ;
570typedef VIRTIOSCSIREQ *PVIRTIOSCSIREQ;
571
572
573#ifdef IN_RING3 /* spans most of the file, at the moment. */
574
575
576DECLINLINE(void) virtioScsiSetVirtqNames(PVIRTIOSCSI pThis)
577{
578 RTStrCopy(pThis->aszVirtqNames[CONTROLQ_IDX], VIRTIO_MAX_QUEUE_NAME_SIZE, "controlq");
579 RTStrCopy(pThis->aszVirtqNames[EVENTQ_IDX], VIRTIO_MAX_QUEUE_NAME_SIZE, "eventq");
580 for (uint16_t qIdx = VIRTQ_REQ_BASE; qIdx < VIRTQ_REQ_BASE + VIRTIOSCSI_REQ_QUEUE_CNT; qIdx++)
581 RTStrPrintf(pThis->aszVirtqNames[qIdx], VIRTIO_MAX_QUEUE_NAME_SIZE,
582 "requestq<%d>", qIdx - VIRTQ_REQ_BASE);
583}
584
585#ifdef LOG_ENABLED
586
587
588DECLINLINE(const char *) virtioGetTxDirText(uint32_t enmTxDir)
589{
590 switch (enmTxDir)
591 {
592 case PDMMEDIAEXIOREQSCSITXDIR_UNKNOWN: return "<UNKNOWN>";
593 case PDMMEDIAEXIOREQSCSITXDIR_FROM_DEVICE: return "<DEV-TO-GUEST>";
594 case PDMMEDIAEXIOREQSCSITXDIR_TO_DEVICE: return "<GUEST-TO-DEV>";
595 case PDMMEDIAEXIOREQSCSITXDIR_NONE: return "<NONE>";
596 default: return "<BAD ENUM>";
597 }
598}
599
600DECLINLINE(const char *) virtioGetTMFTypeText(uint32_t uSubType)
601{
602 switch (uSubType)
603 {
604 case VIRTIOSCSI_T_TMF_ABORT_TASK: return "ABORT TASK";
605 case VIRTIOSCSI_T_TMF_ABORT_TASK_SET: return "ABORT TASK SET";
606 case VIRTIOSCSI_T_TMF_CLEAR_ACA: return "CLEAR ACA";
607 case VIRTIOSCSI_T_TMF_CLEAR_TASK_SET: return "CLEAR TASK SET";
608 case VIRTIOSCSI_T_TMF_I_T_NEXUS_RESET: return "I T NEXUS RESET";
609 case VIRTIOSCSI_T_TMF_LOGICAL_UNIT_RESET: return "LOGICAL UNIT RESET";
610 case VIRTIOSCSI_T_TMF_QUERY_TASK: return "QUERY TASK";
611 case VIRTIOSCSI_T_TMF_QUERY_TASK_SET: return "QUERY TASK SET";
612 default: return "<unknown>";
613 }
614}
615
616DECLINLINE(const char *) virtioGetReqRespText(uint32_t vboxRc)
617{
618 switch (vboxRc)
619 {
620 case VIRTIOSCSI_S_OK: return "OK/COMPLETE";
621 case VIRTIOSCSI_S_OVERRUN: return "OVERRRUN";
622 case VIRTIOSCSI_S_ABORTED: return "ABORTED";
623 case VIRTIOSCSI_S_BAD_TARGET: return "BAD TARGET";
624 case VIRTIOSCSI_S_RESET: return "RESET";
625 case VIRTIOSCSI_S_TRANSPORT_FAILURE: return "TRANSPORT FAILURE";
626 case VIRTIOSCSI_S_TARGET_FAILURE: return "TARGET FAILURE";
627 case VIRTIOSCSI_S_NEXUS_FAILURE: return "NEXUS FAILURE";
628 case VIRTIOSCSI_S_BUSY: return "BUSY";
629 case VIRTIOSCSI_S_FAILURE: return "FAILURE";
630 case VIRTIOSCSI_S_INCORRECT_LUN: return "INCORRECT LUN";
631 case VIRTIOSCSI_S_FUNCTION_SUCCEEDED: return "FUNCTION SUCCEEDED";
632 case VIRTIOSCSI_S_FUNCTION_REJECTED: return "FUNCTION REJECTED";
633 default: return "<unknown>";
634 }
635}
636
637DECLINLINE(void) virtioGetControlAsyncMaskText(char *pszOutput, uint32_t cbOutput, uint32_t fAsyncTypesMask)
638{
639 RTStrPrintf(pszOutput, cbOutput, "%s%s%s%s%s%s",
640 fAsyncTypesMask & VIRTIOSCSI_EVT_ASYNC_OPERATIONAL_CHANGE ? "CHANGE_OPERATION " : "",
641 fAsyncTypesMask & VIRTIOSCSI_EVT_ASYNC_POWER_MGMT ? "POWER_MGMT " : "",
642 fAsyncTypesMask & VIRTIOSCSI_EVT_ASYNC_EXTERNAL_REQUEST ? "EXTERNAL_REQ " : "",
643 fAsyncTypesMask & VIRTIOSCSI_EVT_ASYNC_MEDIA_CHANGE ? "MEDIA_CHANGE " : "",
644 fAsyncTypesMask & VIRTIOSCSI_EVT_ASYNC_MULTI_HOST ? "MULTI_HOST " : "",
645 fAsyncTypesMask & VIRTIOSCSI_EVT_ASYNC_DEVICE_BUSY ? "DEVICE_BUSY " : "");
646}
647
648static uint8_t virtioScsiEstimateCdbLen(uint8_t uCmd, uint8_t cbMax)
649{
650 if (uCmd < 0x1f)
651 return RT_MIN(6, cbMax);
652 if (uCmd >= 0x20 && uCmd < 0x60)
653 return RT_MIN(10, cbMax);
654 if (uCmd >= 0x60 && uCmd < 0x80)
655 return cbMax;
656 if (uCmd >= 0x80 && uCmd < 0xa0)
657 return RT_MIN(16, cbMax);
658 if (uCmd >= 0xa0 && uCmd < 0xc0)
659 return RT_MIN(12, cbMax);
660 return cbMax;
661}
662
663#endif /* LOG_ENABLED */
664
665static int virtioScsiR3SendEvent(PPDMDEVINS pDevIns, PVIRTIOSCSI pThis, uint16_t uTarget, uint32_t uEventType, uint32_t uReason)
666{
667 switch (uEventType)
668 {
669 case VIRTIOSCSI_T_NO_EVENT:
670 Log6Func(("(target=%d, LUN=%d): Warning event info guest queued is shorter than configured\n", uTarget, LUN0));
671 break;
672 case VIRTIOSCSI_T_NO_EVENT | VIRTIOSCSI_T_EVENTS_MISSED:
673 Log6Func(("(target=%d, LUN=%d): Warning driver that events were missed\n", uTarget, LUN0));
674 break;
675 case VIRTIOSCSI_T_TRANSPORT_RESET:
676 switch (uReason)
677 {
678 case VIRTIOSCSI_EVT_RESET_REMOVED:
679 Log6Func(("(target=%d, LUN=%d): Target or LUN removed\n", uTarget, LUN0));
680 break;
681 case VIRTIOSCSI_EVT_RESET_RESCAN:
682 Log6Func(("(target=%d, LUN=%d): Target or LUN added\n", uTarget, LUN0));
683 break;
684 case VIRTIOSCSI_EVT_RESET_HARD:
685 Log6Func(("(target=%d, LUN=%d): Target was reset\n", uTarget, LUN0));
686 break;
687 }
688 break;
689 case VIRTIOSCSI_T_ASYNC_NOTIFY:
690 {
691#ifdef LOG_ENABLED
692 char szTypeText[128];
693 virtioGetControlAsyncMaskText(szTypeText, sizeof(szTypeText), uReason);
694 Log6Func(("(target=%d, LUN=%d): Delivering subscribed async notification %s\n", uTarget, LUN0, szTypeText));
695#endif
696 break;
697 }
698 case VIRTIOSCSI_T_PARAM_CHANGE:
699 LogFunc(("(target=%d, LUN=%d): PARAM_CHANGE sense code: 0x%x sense qualifier: 0x%x\n",
700 uTarget, LUN0, uReason & 0xff, (uReason >> 8) & 0xff));
701 break;
702 default:
703 Log6Func(("(target=%d, LUN=%d): Unknown event type: %d, ignoring\n", uTarget, LUN0, uEventType));
704 return VINF_SUCCESS;
705 }
706
707 /** @todo r=bird: virtioCoreQueueIsEmpty() only differs in one step from what
708 * virtioCoreR3QueueGet() also does, and that is checking
709 * VIRTIO_STATUS_DRIVER_OK. So, why not combine the two and check the
710 * virtioCoreR3QueueGet status code?! (Actually, I've added a status
711 * check there myself, as we'll dump core if it fails and we don't.) */
712 if (virtioCoreQueueIsEmpty(pDevIns, &pThis->Virtio, EVENTQ_IDX))
713 {
714 LogFunc(("eventq is empty, events missed (driver didn't preload queue)!\n"));
715 ASMAtomicWriteBool(&pThis->fEventsMissed, true);
716 return VINF_SUCCESS;
717 }
718
719 PVIRTIO_DESC_CHAIN_T pDescChain;
720 int rc = virtioCoreR3QueueGet(pDevIns, &pThis->Virtio, EVENTQ_IDX, &pDescChain, true);
721 AssertRCReturn(rc, rc);
722
723 VIRTIOSCSI_EVENT_T Event;
724 Event.uEvent = uEventType;
725 Event.uReason = uReason;
726 Event.abVirtioLun[0] = 1;
727 Event.abVirtioLun[1] = uTarget;
728 Event.abVirtioLun[2] = (LUN0 >> 8) & 0x40;
729 Event.abVirtioLun[3] = LUN0 & 0xff;
730 Event.abVirtioLun[4] = 0;
731 Event.abVirtioLun[5] = 0;
732 Event.abVirtioLun[6] = 0;
733 Event.abVirtioLun[7] = 0;
734
735 RTSGSEG aReqSegs[1];
736 aReqSegs[0].pvSeg = &Event;
737 aReqSegs[0].cbSeg = sizeof(Event);
738
739 RTSGBUF ReqSgBuf;
740 RTSgBufInit(&ReqSgBuf, aReqSegs, RT_ELEMENTS(aReqSegs));
741
742 virtioCoreR3QueuePut(pDevIns, &pThis->Virtio, EVENTQ_IDX, &ReqSgBuf, pDescChain, true /*fFence*/);
743 virtioCoreQueueSync(pDevIns, &pThis->Virtio, EVENTQ_IDX);
744
745 return VINF_SUCCESS;
746}
747
748/** Internal worker. */
749static void virtioScsiR3FreeReq(PVIRTIOSCSITARGET pTarget, PVIRTIOSCSIREQ pReq)
750{
751 RTMemFree(pReq->pbSense);
752 pReq->pbSense = NULL;
753 pTarget->pDrvMediaEx->pfnIoReqFree(pTarget->pDrvMediaEx, pReq->hIoReq);
754}
755
756/**
757 * This is called to complete a request immediately
758 *
759 * @param pDevIns The device instance.
760 * @param pThis VirtIO SCSI shared instance data.
761 * @param pThisCC VirtIO SCSI ring-3 instance data.
762 * @param qIdx Queue index
763 * @param pDescChain Pointer to pre-processed descriptor chain pulled from virtq
764 * @param pRespHdr Response header
765 * @param pbSense Pointer to sense buffer or NULL if none.
766 * @param cbSenseCfg The configured sense buffer size.
767 *
768 * @returns VINF_SUCCESS
769 */
770static int virtioScsiR3ReqErr(PPDMDEVINS pDevIns, PVIRTIOSCSI pThis, PVIRTIOSCSICC pThisCC, uint16_t qIdx,
771 PVIRTIO_DESC_CHAIN_T pDescChain, REQ_RESP_HDR_T *pRespHdr, uint8_t *pbSense,
772 uint32_t cbSenseCfg)
773{
774 Log2Func((" status: %s response: %s\n",
775 SCSIStatusText(pRespHdr->uStatus), virtioGetReqRespText(pRespHdr->uResponse)));
776
777 RTSGSEG aReqSegs[2];
778
779 /* Segment #1: Request header*/
780 aReqSegs[0].pvSeg = pRespHdr;
781 aReqSegs[0].cbSeg = sizeof(*pRespHdr);
782
783 /* Segment #2: Sense data. */
784 uint8_t abSenseBuf[VIRTIOSCSI_SENSE_SIZE_MAX];
785 AssertCompile(VIRTIOSCSI_SENSE_SIZE_MAX <= 4096);
786 Assert(cbSenseCfg <= sizeof(abSenseBuf));
787
788 RT_ZERO(abSenseBuf);
789 if (pbSense && pRespHdr->cbSenseLen)
790 memcpy(abSenseBuf, pbSense, RT_MIN(pRespHdr->cbSenseLen, sizeof(abSenseBuf)));
791 else
792 pRespHdr->cbSenseLen = 0;
793
794 aReqSegs[1].pvSeg = abSenseBuf;
795 aReqSegs[1].cbSeg = cbSenseCfg;
796
797 /* Init S/G buffer. */
798 RTSGBUF ReqSgBuf;
799 RTSgBufInit(&ReqSgBuf, aReqSegs, RT_ELEMENTS(aReqSegs));
800
801 if (pThis->fResetting)
802 pRespHdr->uResponse = VIRTIOSCSI_S_RESET;
803
804 virtioCoreR3QueuePut(pDevIns, &pThis->Virtio, qIdx, &ReqSgBuf, pDescChain, true /* fFence */);
805 virtioCoreQueueSync(pDevIns, &pThis->Virtio, qIdx);
806
807 if (!ASMAtomicDecU32(&pThis->cActiveReqs) && pThisCC->fQuiescing)
808 PDMDevHlpAsyncNotificationCompleted(pDevIns);
809
810 Log2(("---------------------------------------------------------------------------------\n"));
811
812 return VINF_SUCCESS;
813}
814
815
816/**
817 * Variant of virtioScsiR3ReqErr that takes four (4) REQ_RESP_HDR_T member
818 * fields rather than a pointer to an initialized structure.
819 *
820 * @param pDevIns The device instance.
821 * @param pThis VirtIO SCSI shared instance data.
822 * @param pThisCC VirtIO SCSI ring-3 instance data.
823 * @param qIdx Queue index
824 * @param pDescChain Pointer to pre-processed descriptor chain pulled from virtq
825 * @param cbResidual The number of residual bytes or something like that.
826 * @param bStatus The SCSI status code.
827 * @param bResponse The virtio SCSI response code.
828 * @param pbSense Pointer to sense buffer or NULL if none.
829 * @param cbSense The number of bytes of sense data. Zero if none.
830 * @param cbSenseCfg The configured sense buffer size.
831 *
832 * @returns VINF_SUCCESS
833 */
834static int virtioScsiR3ReqErr4(PPDMDEVINS pDevIns, PVIRTIOSCSI pThis, PVIRTIOSCSICC pThisCC, uint16_t qIdx,
835 PVIRTIO_DESC_CHAIN_T pDescChain, uint32_t cbResidual, uint8_t bStatus, uint8_t bResponse,
836 uint8_t *pbSense, uint32_t cbSense, uint32_t cbSenseCfg)
837{
838 REQ_RESP_HDR_T RespHdr;
839 RespHdr.cbSenseLen = cbSense;
840 RespHdr.uResidual = cbResidual;
841 RespHdr.uStatusQualifier = 0;
842 RespHdr.uStatus = bStatus;
843 RespHdr.uResponse = bResponse;
844
845 return virtioScsiR3ReqErr(pDevIns, pThis, pThisCC, qIdx, pDescChain, &RespHdr, pbSense, cbSenseCfg);
846}
847
848static void virtioScsiR3SenseKeyToVirtioResp(REQ_RESP_HDR_T *respHdr, uint8_t uSenseKey)
849{
850 switch (uSenseKey)
851 {
852 case SCSI_SENSE_ABORTED_COMMAND:
853 respHdr->uResponse = VIRTIOSCSI_S_ABORTED;
854 break;
855 case SCSI_SENSE_COPY_ABORTED:
856 respHdr->uResponse = VIRTIOSCSI_S_ABORTED;
857 break;
858 case SCSI_SENSE_UNIT_ATTENTION:
859 respHdr->uResponse = VIRTIOSCSI_S_TARGET_FAILURE;
860 break;
861 case SCSI_SENSE_HARDWARE_ERROR:
862 respHdr->uResponse = VIRTIOSCSI_S_TARGET_FAILURE;
863 break;
864 case SCSI_SENSE_NOT_READY:
865 /* Not sure what to return for this. See choices at VirtIO 1.0, 5.6.6.1.1 */
866 respHdr->uResponse = VIRTIOSCSI_S_FAILURE;
867 /* respHdr->uResponse = VIRTIOSCSI_S_BUSY; */ /* BUSY is VirtIO's 'retryable' response */
868 break;
869 default:
870 respHdr->uResponse = VIRTIOSCSI_S_FAILURE;
871 break;
872 }
873}
874
875/**
876 * @interface_method_impl{PDMIMEDIAEXPORT,pfnIoReqCompleteNotify}
877 */
878static DECLCALLBACK(int) virtioScsiR3IoReqFinish(PPDMIMEDIAEXPORT pInterface, PDMMEDIAEXIOREQ hIoReq,
879 void *pvIoReqAlloc, int rcReq)
880{
881 PVIRTIOSCSITARGET pTarget = RT_FROM_MEMBER(pInterface, VIRTIOSCSITARGET, IMediaExPort);
882 PPDMDEVINS pDevIns = pTarget->pDevIns;
883 PVIRTIOSCSI pThis = PDMDEVINS_2_DATA(pDevIns, PVIRTIOSCSI);
884 PVIRTIOSCSICC pThisCC = PDMDEVINS_2_DATA_CC(pDevIns, PVIRTIOSCSICC);
885 PPDMIMEDIAEX pIMediaEx = pTarget->pDrvMediaEx;
886 PVIRTIOSCSIREQ pReq = (PVIRTIOSCSIREQ)pvIoReqAlloc;
887
888 size_t cbResidual = 0;
889 int rc = pIMediaEx->pfnIoReqQueryResidual(pIMediaEx, hIoReq, &cbResidual);
890 AssertRC(rc);
891
892 size_t cbXfer = 0;
893 rc = pIMediaEx->pfnIoReqQueryXferSize(pIMediaEx, hIoReq, &cbXfer);
894 AssertRC(rc);
895
896 /* Masking deals with data type size discrepancies between
897 * The APIs (virtio and VBox). Windows C-compiler complains otherwise */
898 Assert(!(cbXfer & 0xffffffff00000000));
899 uint32_t cbXfer32 = cbXfer & 0xffffffff;
900 REQ_RESP_HDR_T respHdr = { 0 };
901 respHdr.cbSenseLen = pReq->pbSense[2] == SCSI_SENSE_NONE ? 0 : (uint32_t)pReq->cbSenseLen;
902 AssertMsg(!(cbResidual & 0xffffffff00000000),
903 ("WARNING: Residual size larger than sizeof(uint32_t), truncating"));
904 respHdr.uResidual = (uint32_t)(cbResidual & 0xffffffff);
905 respHdr.uStatus = pReq->uStatus;
906
907 /* VirtIO 1.0 spec 5.6.6.1.1 says device MUST return a VirtIO response byte value.
908 * Some are returned during the submit phase, and a few are not mapped at all,
909 * wherein anything that can't map specifically gets mapped to VIRTIOSCSI_S_FAILURE
910 */
911 if (pThis->fResetting)
912 respHdr.uResponse = VIRTIOSCSI_S_RESET;
913 else
914 {
915 switch (rcReq)
916 {
917 case SCSI_STATUS_OK:
918 {
919 if (pReq->uStatus != SCSI_STATUS_CHECK_CONDITION)
920 respHdr.uResponse = VIRTIOSCSI_S_OK;
921 else
922 virtioScsiR3SenseKeyToVirtioResp(&respHdr, pReq->pbSense[2]);
923 break;
924 }
925 case SCSI_STATUS_CHECK_CONDITION:
926 virtioScsiR3SenseKeyToVirtioResp(&respHdr, pReq->pbSense[2]);
927 break;
928
929 default:
930 respHdr.uResponse = VIRTIOSCSI_S_FAILURE;
931 break;
932 }
933 }
934
935 Log2Func(("status: (%d) %s, response: (%d) %s\n", pReq->uStatus, SCSIStatusText(pReq->uStatus),
936 respHdr.uResponse, virtioGetReqRespText(respHdr.uResponse)));
937
938 if (RT_FAILURE(rcReq))
939 Log2Func(("rcReq: %s\n", RTErrGetDefine(rcReq)));
940
941 if (LogIs3Enabled())
942 {
943 LogFunc(("cbDataIn = %u, cbDataOut = %u (cbIn = %u, cbOut = %u)\n",
944 pReq->cbDataIn, pReq->cbDataOut, pReq->pDescChain->cbPhysReturn, pReq->pDescChain->cbPhysSend));
945 LogFunc(("xfer = %lu, residual = %u\n", cbXfer, cbResidual));
946 LogFunc(("xfer direction: %s, sense written = %d, sense size = %d\n",
947 virtioGetTxDirText(pReq->enmTxDir), respHdr.cbSenseLen, pThis->virtioScsiConfig.uSenseSize));
948 }
949
950 if (respHdr.cbSenseLen && LogIs2Enabled())
951 {
952 LogFunc(("Sense: %s\n", SCSISenseText(pReq->pbSense[2])));
953 LogFunc(("Sense Ext3: %s\n", SCSISenseExtText(pReq->pbSense[12], pReq->pbSense[13])));
954 }
955
956 if ( (VIRTIO_IS_IN_DIRECTION(pReq->enmTxDir) && cbXfer32 > pReq->cbDataIn)
957 || (VIRTIO_IS_OUT_DIRECTION(pReq->enmTxDir) && cbXfer32 > pReq->cbDataOut))
958 {
959 Log2Func((" * * * * Data overrun, returning sense\n"));
960 uint8_t abSense[] = { RT_BIT(7) | SCSI_SENSE_RESPONSE_CODE_CURR_FIXED,
961 0, SCSI_SENSE_ILLEGAL_REQUEST, 0, 0, 0, 0, 10, 0, 0, 0 };
962 respHdr.cbSenseLen = sizeof(abSense);
963 respHdr.uStatus = SCSI_STATUS_CHECK_CONDITION;
964 respHdr.uResponse = VIRTIOSCSI_S_OVERRUN;
965 respHdr.uResidual = pReq->cbDataIn;
966
967 virtioScsiR3ReqErr(pDevIns, pThis, pThisCC, pReq->qIdx, pReq->pDescChain, &respHdr, abSense,
968 RT_MIN(pThis->virtioScsiConfig.uSenseSize, VIRTIOSCSI_SENSE_SIZE_MAX));
969 }
970 else
971 {
972 Assert(pReq->pbSense != NULL);
973
974 /* req datain bytes already in guest phys mem. via virtioScsiIoReqCopyFromBuf() */
975 RTSGSEG aReqSegs[2];
976
977 aReqSegs[0].pvSeg = &respHdr;
978 aReqSegs[0].cbSeg = sizeof(respHdr);
979
980 aReqSegs[1].pvSeg = pReq->pbSense;
981 aReqSegs[1].cbSeg = pReq->cbSenseAlloc; /* VirtIO 1.0 spec 5.6.4/5.6.6.1 */
982
983 RTSGBUF ReqSgBuf;
984 RTSgBufInit(&ReqSgBuf, aReqSegs, RT_ELEMENTS(aReqSegs));
985
986 size_t cbReqSgBuf = RTSgBufCalcTotalLength(&ReqSgBuf);
987 /** @todo r=bird: Returning here looks a little bogus... */
988 AssertMsgReturn(cbReqSgBuf <= pReq->pDescChain->cbPhysReturn,
989 ("Guest expected less req data (space needed: %zu, avail: %u)\n",
990 cbReqSgBuf, pReq->pDescChain->cbPhysReturn),
991 VERR_BUFFER_OVERFLOW);
992
993 virtioCoreR3QueuePut(pDevIns, &pThis->Virtio, pReq->qIdx, &ReqSgBuf, pReq->pDescChain, true /* fFence TBD */);
994 virtioCoreQueueSync(pDevIns, &pThis->Virtio, pReq->qIdx);
995
996 Log2(("-----------------------------------------------------------------------------------------\n"));
997 }
998
999 virtioScsiR3FreeReq(pTarget, pReq);
1000
1001 if (!ASMAtomicDecU32(&pThis->cActiveReqs) && pThisCC->fQuiescing)
1002 PDMDevHlpAsyncNotificationCompleted(pDevIns);
1003
1004 return rc;
1005}
1006
1007/**
1008 * @interface_method_impl{PDMIMEDIAEXPORT,pfnIoReqCopyFromBuf}
1009 *
1010 * Copy virtual memory from VSCSI layer to guest physical memory
1011 */
1012static DECLCALLBACK(int) virtioScsiR3IoReqCopyFromBuf(PPDMIMEDIAEXPORT pInterface, PDMMEDIAEXIOREQ hIoReq,
1013 void *pvIoReqAlloc, uint32_t offDst, PRTSGBUF pSgBuf, size_t cbCopy)
1014{
1015 PVIRTIOSCSITARGET pTarget = RT_FROM_MEMBER(pInterface, VIRTIOSCSITARGET, IMediaExPort);
1016 PPDMDEVINS pDevIns = pTarget->pDevIns;
1017 PVIRTIOSCSIREQ pReq = (PVIRTIOSCSIREQ)pvIoReqAlloc;
1018 RT_NOREF(hIoReq, cbCopy);
1019
1020 if (!pReq->cbDataIn)
1021 return VINF_SUCCESS;
1022
1023 AssertReturn(pReq->pDescChain, VERR_INVALID_PARAMETER);
1024
1025 PVIRTIOSGBUF pSgPhysReturn = pReq->pDescChain->pSgPhysReturn;
1026 virtioCoreSgBufAdvance(pSgPhysReturn, offDst);
1027
1028 size_t cbCopied = 0;
1029 size_t cbRemain = pReq->cbDataIn;
1030
1031 /* Skip past the REQ_RESP_HDR_T and sense code if we're at the start of the buffer. */
1032 if (!pSgPhysReturn->idxSeg && pSgPhysReturn->cbSegLeft == pSgPhysReturn->paSegs[0].cbSeg)
1033 virtioCoreSgBufAdvance(pSgPhysReturn, pReq->uDataInOff);
1034
1035 while (cbRemain)
1036 {
1037 PVIRTIOSGSEG pSeg = &pSgPhysReturn->paSegs[pSgPhysReturn->idxSeg];
1038 /** @todo r=bird: add inline function for getting number of bytes left in the
1039 * current segment. Actually, shouldn't pSgPhysReturn->cbSegLeft have
1040 * this value? */
1041 cbCopied = RT_MIN(pSgBuf->cbSegLeft, pSeg->cbSeg - (size_t)(pSgPhysReturn->gcPhysCur - pSeg->gcPhys));
1042 Assert(cbCopied > 0);
1043 PDMDevHlpPCIPhysWrite(pDevIns, pSgPhysReturn->gcPhysCur, pSgBuf->pvSegCur, cbCopied);
1044 RTSgBufAdvance(pSgBuf, cbCopied);
1045 virtioCoreSgBufAdvance(pSgPhysReturn, cbCopied);
1046 cbRemain -= cbCopied;
1047 }
1048 RT_UNTRUSTED_NONVOLATILE_COPY_FENCE(); /* needed? */
1049
1050 Log3Func((".... Copied %lu bytes from %lu byte guest buffer, residual=%lu\n",
1051 cbCopy, pReq->pDescChain->cbPhysReturn, pReq->pDescChain->cbPhysReturn - cbCopy));
1052
1053 return VINF_SUCCESS;
1054}
1055
1056/**
1057 * @interface_method_impl{PDMIMEDIAEXPORT,pfnIoReqCopyToBuf}
1058 *
1059 * Copy guest physical memory to VSCSI layer virtual memory
1060 */
1061static DECLCALLBACK(int) virtioScsiR3IoReqCopyToBuf(PPDMIMEDIAEXPORT pInterface, PDMMEDIAEXIOREQ hIoReq,
1062 void *pvIoReqAlloc, uint32_t offSrc, PRTSGBUF pSgBuf, size_t cbCopy)
1063{
1064 PVIRTIOSCSITARGET pTarget = RT_FROM_MEMBER(pInterface, VIRTIOSCSITARGET, IMediaExPort);
1065 PPDMDEVINS pDevIns = pTarget->pDevIns;
1066 PVIRTIOSCSIREQ pReq = (PVIRTIOSCSIREQ)pvIoReqAlloc;
1067 RT_NOREF(hIoReq, cbCopy);
1068
1069 if (!pReq->cbDataOut)
1070 return VINF_SUCCESS;
1071
1072 PVIRTIOSGBUF pSgPhysSend = pReq->pDescChain->pSgPhysSend;
1073 virtioCoreSgBufAdvance(pSgPhysSend, offSrc);
1074
1075 size_t cbCopied = 0;
1076 size_t cbRemain = pReq->cbDataOut;
1077 while (cbRemain)
1078 {
1079 PVIRTIOSGSEG const pSeg = &pSgPhysSend->paSegs[pSgPhysSend->idxSeg];
1080 /** @todo r=bird: add inline function for getting number of bytes left in the
1081 * current segment. Actually, shouldn't pSgPhysSend->cbSegLeft have
1082 * this value? */
1083 cbCopied = RT_MIN(pSgBuf->cbSegLeft, pSeg->cbSeg - (size_t)(pSgPhysSend->gcPhysCur - pSeg->gcPhys));
1084 Assert(cbCopied > 0);
1085 PDMDevHlpPCIPhysRead(pDevIns, pSgPhysSend->gcPhysCur, pSgBuf->pvSegCur, cbCopied);
1086 RTSgBufAdvance(pSgBuf, cbCopied);
1087 virtioCoreSgBufAdvance(pSgPhysSend, cbCopied);
1088 cbRemain -= cbCopied;
1089 }
1090
1091 Log2Func((".... Copied %lu bytes to %lu byte guest buffer, residual=%lu\n",
1092 cbCopy, pReq->pDescChain->cbPhysReturn, pReq->pDescChain->cbPhysReturn - cbCopy));
1093
1094 return VINF_SUCCESS;
1095}
1096
1097/**
1098 * Handles request queues for/on a worker thread.
1099 *
1100 * @returns VBox status code (logged by caller).
1101 */
1102static int virtioScsiR3ReqSubmit(PPDMDEVINS pDevIns, PVIRTIOSCSI pThis, PVIRTIOSCSICC pThisCC,
1103 uint16_t qIdx, PVIRTIO_DESC_CHAIN_T pDescChain)
1104{
1105
1106 ASMAtomicIncU32(&pThis->cActiveReqs);
1107
1108 /*
1109 * Validate configuration values we use here before we start.
1110 */
1111 uint32_t const cbCdb = pThis->virtioScsiConfig.uCdbSize;
1112 uint32_t const cbSenseCfg = pThis->virtioScsiConfig.uSenseSize;
1113 /** @todo Report these as errors to the guest or does the caller do that? */
1114 ASSERT_GUEST_LOGREL_MSG_RETURN(cbCdb <= VIRTIOSCSI_CDB_SIZE_MAX, ("cbCdb=%#x\n", cbCdb), VERR_OUT_OF_RANGE);
1115 ASSERT_GUEST_LOGREL_MSG_RETURN(cbSenseCfg <= VIRTIOSCSI_SENSE_SIZE_MAX, ("cbSenseCfg=%#x\n", cbSenseCfg), VERR_OUT_OF_RANGE);
1116
1117 /*
1118 * Extract command header and CDB from guest physical memory
1119 * The max size is rather small here (19 + 255 = 274), so put
1120 * it on the stack.
1121 */
1122 size_t const cbReqHdr = sizeof(REQ_CMD_HDR_T) + cbCdb;
1123 AssertReturn(pDescChain->cbPhysSend >= cbReqHdr, VERR_INVALID_PARAMETER);
1124
1125 AssertCompile(VIRTIOSCSI_CDB_SIZE_MAX < 4096);
1126 union
1127 {
1128 /*VIRTIOSCSI_REQ_CMD_T ReqCmd; - not needed */
1129 RT_GCC_EXTENSION struct
1130 {
1131 REQ_CMD_HDR_T ReqHdr;
1132 uint8_t abCdb[VIRTIOSCSI_CDB_SIZE_MAX];
1133 } ;
1134 uint8_t ab[sizeof(REQ_CMD_HDR_T) + VIRTIOSCSI_CDB_SIZE_MAX];
1135 uint64_t au64Align[(sizeof(REQ_CMD_HDR_T) + VIRTIOSCSI_CDB_SIZE_MAX) / sizeof(uint64_t)];
1136 } VirtqReq;
1137 RT_ZERO(VirtqReq);
1138
1139 for (size_t offReq = 0; offReq < cbReqHdr; )
1140 {
1141 size_t cbSeg = cbReqHdr - offReq;
1142 RTGCPHYS GCPhys = virtioCoreSgBufGetNextSegment(pDescChain->pSgPhysSend, &cbSeg);
1143 PDMDevHlpPCIPhysRead(pDevIns, GCPhys, &VirtqReq.ab[offReq], cbSeg);
1144 offReq += cbSeg;
1145 }
1146
1147 uint8_t const uType = VirtqReq.ReqHdr.abVirtioLun[0];
1148 uint8_t const uTarget = VirtqReq.ReqHdr.abVirtioLun[1];
1149 uint32_t uScsiLun = RT_MAKE_U16(VirtqReq.ReqHdr.abVirtioLun[3], VirtqReq.ReqHdr.abVirtioLun[2]) & 0x3fff;
1150
1151 bool fBadLUNFormat = false;
1152 if (uType == 0xc1 && uTarget == 0x01)
1153 {
1154 LogRel(("* * * REPORT LUNS LU ACCESSED * * * "));
1155 /* Force rejection. */ /** @todo figure out right way to handle. Note this is a very
1156 * vague and confusing part of the VirtIO spec which deviates from the SCSI standard
1157 * I have not been able to determine how to implement this properly. Guest drivers
1158 * whose source code has been checked, so far, don't seem to use it. If it starts
1159 * showing up in the logs can try to work */
1160 uScsiLun = 0xff;
1161 }
1162 else
1163 if (uType != 1)
1164 fBadLUNFormat = true;
1165
1166 LogFunc(("[%s] (Target: %d LUN: %d) CDB: %.*Rhxs\n",
1167 SCSICmdText(VirtqReq.abCdb[0]), uTarget, uScsiLun,
1168 virtioScsiEstimateCdbLen(VirtqReq.abCdb[0], cbCdb), &VirtqReq.abCdb[0]));
1169
1170 Log3Func(("cmd id: %RX64, attr: %x, prio: %d, crn: %x\n",
1171 VirtqReq.ReqHdr.uId, VirtqReq.ReqHdr.uTaskAttr, VirtqReq.ReqHdr.uPrio, VirtqReq.ReqHdr.uCrn));
1172
1173 /*
1174 * Calculate request offsets and data sizes.
1175 */
1176 uint32_t const offDataOut = sizeof(REQ_CMD_HDR_T) + cbCdb;
1177 uint32_t const offDataIn = sizeof(REQ_RESP_HDR_T) + cbSenseCfg;
1178 uint32_t const cbDataOut = pDescChain->cbPhysSend - offDataOut;
1179 /** @todo r=bird: Validate cbPhysReturn properly? I've just RT_MAX'ed it for now. */
1180 uint32_t const cbDataIn = RT_MAX(pDescChain->cbPhysReturn, offDataIn) - offDataIn;
1181 Assert(offDataOut <= UINT16_MAX);
1182 Assert(offDataIn <= UINT16_MAX);
1183
1184 /*
1185 * Handle submission errors
1186 */
1187 if (RT_LIKELY(!fBadLUNFormat))
1188 { /* likely */ }
1189 else
1190 {
1191 Log2Func(("Error submitting request, bad LUN format\n"));
1192 return virtioScsiR3ReqErr4(pDevIns, pThis, pThisCC, qIdx, pDescChain, cbDataIn + cbDataOut, 0 /*bStatus*/,
1193 VIRTIOSCSI_S_FAILURE, NULL /*pbSense*/, 0 /*cbSense*/, cbSenseCfg);
1194 }
1195
1196 PVIRTIOSCSITARGET const pTarget = &pThisCC->paTargetInstances[uTarget];
1197 if (RT_LIKELY( uTarget < pThis->cTargets
1198 && pTarget->fPresent
1199 && pTarget->pDrvMediaEx))
1200 { /* likely */ }
1201 else
1202 {
1203 Log2Func(("Error submitting request to bad target (%d) or bad LUN (%d)\n", uTarget, uScsiLun));
1204 uint8_t abSense[] = { RT_BIT(7) | SCSI_SENSE_RESPONSE_CODE_CURR_FIXED,
1205 0, SCSI_SENSE_ILLEGAL_REQUEST,
1206 0, 0, 0, 0, 10, SCSI_ASC_LOGICAL_UNIT_NOT_SUPPORTED, 0, 0 };
1207 return virtioScsiR3ReqErr4(pDevIns, pThis, pThisCC, qIdx, pDescChain, cbDataIn + cbDataOut, SCSI_STATUS_CHECK_CONDITION,
1208 VIRTIOSCSI_S_BAD_TARGET, abSense, sizeof(abSense), cbSenseCfg);
1209 }
1210 if (RT_LIKELY(uScsiLun == 0))
1211 { /* likely */ }
1212 else
1213 {
1214 Log2Func(("Error submitting request to bad target (%d) or bad LUN (%d)\n", uTarget, uScsiLun));
1215 uint8_t abSense[] = { RT_BIT(7) | SCSI_SENSE_RESPONSE_CODE_CURR_FIXED,
1216 0, SCSI_SENSE_ILLEGAL_REQUEST,
1217 0, 0, 0, 0, 10, SCSI_ASC_LOGICAL_UNIT_NOT_SUPPORTED, 0, 0 };
1218 return virtioScsiR3ReqErr4(pDevIns, pThis, pThisCC, qIdx, pDescChain, cbDataIn + cbDataOut, SCSI_STATUS_CHECK_CONDITION,
1219 VIRTIOSCSI_S_OK, abSense, sizeof(abSense), cbSenseCfg);
1220 }
1221 if (RT_LIKELY(!pThis->fResetting))
1222 { /* likely */ }
1223 else
1224 {
1225 Log2Func(("Aborting req submission because reset is in progress\n"));
1226 return virtioScsiR3ReqErr4(pDevIns, pThis, pThisCC, qIdx, pDescChain, cbDataIn + cbDataOut, SCSI_STATUS_OK,
1227 VIRTIOSCSI_S_RESET, NULL /*pbSense*/, 0 /*cbSense*/, cbSenseCfg);
1228 }
1229
1230 if (RT_LIKELY(!cbDataIn || !cbDataOut || pThis->fHasInOutBufs)) /* VirtIO 1.0, 5.6.6.1.1 */
1231 { /* likely */ }
1232 else
1233 {
1234 Log2Func(("Error submitting request, got datain & dataout bufs w/o INOUT feature negotated\n"));
1235 uint8_t abSense[] = { RT_BIT(7) | SCSI_SENSE_RESPONSE_CODE_CURR_FIXED,
1236 0, SCSI_SENSE_ILLEGAL_REQUEST, 0, 0, 0, 0, 10, 0, 0, 0 };
1237 return virtioScsiR3ReqErr4(pDevIns, pThis, pThisCC, qIdx, pDescChain, cbDataIn + cbDataOut, SCSI_STATUS_CHECK_CONDITION,
1238 VIRTIOSCSI_S_FAILURE, abSense, sizeof(abSense), cbSenseCfg);
1239 }
1240
1241 /*
1242 * Have underlying driver allocate a req of size set during initialization of this device.
1243 */
1244 PDMMEDIAEXIOREQ hIoReq = NULL;
1245 PVIRTIOSCSIREQ pReq = NULL;
1246 PPDMIMEDIAEX pIMediaEx = pTarget->pDrvMediaEx;
1247
1248 int rc = pIMediaEx->pfnIoReqAlloc(pIMediaEx, &hIoReq, (void **)&pReq, 0 /* uIoReqId */,
1249 PDMIMEDIAEX_F_SUSPEND_ON_RECOVERABLE_ERR);
1250
1251 AssertMsgRCReturn(rc, ("Failed to allocate I/O request, rc=%Rrc\n", rc), rc);
1252
1253 pReq->hIoReq = hIoReq;
1254 pReq->pTarget = pTarget;
1255 pReq->qIdx = qIdx;
1256 pReq->cbDataIn = cbDataIn;
1257 pReq->cbDataOut = cbDataOut;
1258 pReq->pDescChain = pDescChain;
1259 pReq->uDataInOff = offDataIn;
1260 pReq->uDataOutOff = offDataOut;
1261
1262 pReq->cbSenseAlloc = cbSenseCfg;
1263 pReq->pbSense = (uint8_t *)RTMemAllocZ(pReq->cbSenseAlloc);
1264 AssertMsgReturnStmt(pReq->pbSense, ("Out of memory allocating sense buffer"),
1265 virtioScsiR3FreeReq(pTarget, pReq);, VERR_NO_MEMORY);
1266
1267 /* Note: DrvSCSI allocates one virtual memory buffer for input and output phases of the request */
1268 rc = pIMediaEx->pfnIoReqSendScsiCmd(pIMediaEx, pReq->hIoReq, uScsiLun,
1269 &VirtqReq.abCdb[0], cbCdb,
1270 PDMMEDIAEXIOREQSCSITXDIR_UNKNOWN, &pReq->enmTxDir,
1271 RT_MAX(cbDataIn, cbDataOut),
1272 pReq->pbSense, pReq->cbSenseAlloc, &pReq->cbSenseLen,
1273 &pReq->uStatus, RT_MS_30SEC);
1274
1275 if (rc != VINF_PDM_MEDIAEX_IOREQ_IN_PROGRESS)
1276 {
1277 /*
1278 * Getting here means the request failed in early in the submission to the lower level driver,
1279 * and there will be no callback to the finished/completion function for this request
1280 */
1281 Assert(RT_FAILURE_NP(rc));
1282 Log2Func(("Request submission error from lower-level driver\n"));
1283 uint8_t uASC, uASCQ = 0;
1284 switch (rc)
1285 {
1286 case VERR_NO_MEMORY:
1287 uASC = SCSI_ASC_SYSTEM_RESOURCE_FAILURE;
1288 break;
1289 default:
1290 uASC = SCSI_ASC_INTERNAL_TARGET_FAILURE;
1291 break;
1292 }
1293 uint8_t abSense[] = { RT_BIT(7) | SCSI_SENSE_RESPONSE_CODE_CURR_FIXED,
1294 0, SCSI_SENSE_VENDOR_SPECIFIC,
1295 0, 0, 0, 0, 10, uASC, uASCQ, 0 };
1296 REQ_RESP_HDR_T respHdr = { 0 };
1297 respHdr.cbSenseLen = sizeof(abSense);
1298 respHdr.uStatus = SCSI_STATUS_CHECK_CONDITION;
1299 respHdr.uResponse = VIRTIOSCSI_S_FAILURE;
1300 respHdr.uResidual = cbDataIn + cbDataOut;
1301 virtioScsiR3ReqErr(pDevIns, pThis, pThisCC, qIdx, pDescChain, &respHdr, abSense, cbSenseCfg);
1302 virtioScsiR3FreeReq(pTarget, pReq);
1303 }
1304
1305 return VINF_SUCCESS;
1306}
1307
1308/**
1309 * Handles control transfers for/on a worker thread.
1310 *
1311 * @returns VBox status code (ignored by the caller).
1312 * @param pDevIns The device instance.
1313 * @param pThis VirtIO SCSI shared instance data.
1314 * @param pThisCC VirtIO SCSI ring-3 instance data.
1315 * @param qIdx CONTROLQ_IDX
1316 * @param pDescChain Descriptor chain to process.
1317 */
1318static int virtioScsiR3Ctrl(PPDMDEVINS pDevIns, PVIRTIOSCSI pThis, PVIRTIOSCSICC pThisCC,
1319 uint16_t qIdx, PVIRTIO_DESC_CHAIN_T pDescChain)
1320{
1321 AssertReturn(pDescChain->cbPhysSend >= RT_MIN(sizeof(VIRTIOSCSI_CTRL_AN_T),
1322 sizeof(VIRTIOSCSI_CTRL_TMF_T)), 0);
1323
1324 /*
1325 * Allocate buffer and read in the control command
1326 */
1327 VIRTIO_SCSI_CTRL_UNION_T ScsiCtrlUnion;
1328 RT_ZERO(ScsiCtrlUnion);
1329
1330 size_t const cbCtrl = RT_MIN(pDescChain->cbPhysSend, sizeof(VIRTIO_SCSI_CTRL_UNION_T));
1331 for (size_t offCtrl = 0; offCtrl < cbCtrl; )
1332 {
1333 size_t cbSeg = cbCtrl - offCtrl;
1334 RTGCPHYS GCPhys = virtioCoreSgBufGetNextSegment(pDescChain->pSgPhysSend, &cbSeg);
1335 PDMDevHlpPCIPhysRead(pDevIns, GCPhys, &ScsiCtrlUnion.ab[offCtrl], cbSeg);
1336 offCtrl += cbSeg;
1337 }
1338
1339 AssertReturn( (ScsiCtrlUnion.Type.uType == VIRTIOSCSI_T_TMF
1340 && pDescChain->cbPhysSend >= sizeof(VIRTIOSCSI_CTRL_TMF_T))
1341 || ( ( ScsiCtrlUnion.Type.uType == VIRTIOSCSI_T_AN_QUERY
1342 || ScsiCtrlUnion.Type.uType == VIRTIOSCSI_T_AN_SUBSCRIBE)
1343 && pDescChain->cbPhysSend >= sizeof(VIRTIOSCSI_CTRL_AN_T)),
1344 0 /** @todo r=bird: what kind of status is '0' here? */);
1345
1346 union
1347 {
1348 uint32_t fSupportedEvents;
1349 } uData;
1350 uint8_t bResponse = VIRTIOSCSI_S_OK;
1351 uint8_t cSegs;
1352 RTSGSEG aReqSegs[2];
1353 switch (ScsiCtrlUnion.Type.uType)
1354 {
1355 case VIRTIOSCSI_T_TMF: /* Task Management Functions */
1356 {
1357 uint8_t uTarget = ScsiCtrlUnion.Tmf.abScsiLun[1];
1358 uint32_t uScsiLun = RT_MAKE_U16(ScsiCtrlUnion.Tmf.abScsiLun[3], ScsiCtrlUnion.Tmf.abScsiLun[2]) & 0x3fff;
1359 Log2Func(("[%s] (Target: %d LUN: %d) Task Mgt Function: %s\n",
1360 VIRTQNAME(qIdx), uTarget, uScsiLun, virtioGetTMFTypeText(ScsiCtrlUnion.Tmf.uSubtype)));
1361
1362 if (uTarget >= pThis->cTargets || !pThisCC->paTargetInstances[uTarget].fPresent)
1363 bResponse = VIRTIOSCSI_S_BAD_TARGET;
1364 else
1365 if (uScsiLun != 0)
1366 bResponse = VIRTIOSCSI_S_INCORRECT_LUN;
1367 else
1368 switch (ScsiCtrlUnion.Tmf.uSubtype)
1369 {
1370 case VIRTIOSCSI_T_TMF_ABORT_TASK:
1371 bResponse = VIRTIOSCSI_S_FUNCTION_SUCCEEDED;
1372 break;
1373 case VIRTIOSCSI_T_TMF_ABORT_TASK_SET:
1374 bResponse = VIRTIOSCSI_S_FUNCTION_SUCCEEDED;
1375 break;
1376 case VIRTIOSCSI_T_TMF_CLEAR_ACA:
1377 bResponse = VIRTIOSCSI_S_FUNCTION_SUCCEEDED;
1378 break;
1379 case VIRTIOSCSI_T_TMF_CLEAR_TASK_SET:
1380 bResponse = VIRTIOSCSI_S_FUNCTION_SUCCEEDED;
1381 break;
1382 case VIRTIOSCSI_T_TMF_I_T_NEXUS_RESET:
1383 bResponse = VIRTIOSCSI_S_FUNCTION_SUCCEEDED;
1384 break;
1385 case VIRTIOSCSI_T_TMF_LOGICAL_UNIT_RESET:
1386 bResponse = VIRTIOSCSI_S_FUNCTION_SUCCEEDED;
1387 break;
1388 case VIRTIOSCSI_T_TMF_QUERY_TASK:
1389 bResponse = VIRTIOSCSI_S_FUNCTION_REJECTED;
1390 break;
1391 case VIRTIOSCSI_T_TMF_QUERY_TASK_SET:
1392 bResponse = VIRTIOSCSI_S_FUNCTION_REJECTED;
1393 break;
1394 default:
1395 LogFunc(("Unknown TMF type\n"));
1396 bResponse = VIRTIOSCSI_S_FAILURE;
1397 }
1398 cSegs = 0; /* only bResponse */
1399 break;
1400 }
1401 case VIRTIOSCSI_T_AN_QUERY: /* Guest SCSI driver is querying supported async event notifications */
1402 {
1403 uint8_t uTarget = ScsiCtrlUnion.AsyncNotify.abScsiLun[1];
1404 uint32_t uScsiLun = RT_MAKE_U16(ScsiCtrlUnion.AsyncNotify.abScsiLun[3],
1405 ScsiCtrlUnion.AsyncNotify.abScsiLun[2]) & 0x3fff;
1406
1407 if (uTarget >= pThis->cTargets || !pThisCC->paTargetInstances[uTarget].fPresent)
1408 bResponse = VIRTIOSCSI_S_BAD_TARGET;
1409 else
1410 if (uScsiLun != 0)
1411 bResponse = VIRTIOSCSI_S_INCORRECT_LUN;
1412 else
1413 bResponse = VIRTIOSCSI_S_FUNCTION_COMPLETE;
1414
1415#ifdef LOG_ENABLED
1416 if (LogIs2Enabled())
1417 {
1418 char szTypeText[128];
1419 virtioGetControlAsyncMaskText(szTypeText, sizeof(szTypeText), ScsiCtrlUnion.AsyncNotify.fEventsRequested);
1420 Log2Func(("[%s] (Target: %d LUN: %d) Async. Notification Query: %s\n",
1421 VIRTQNAME(qIdx), uTarget, uScsiLun, szTypeText));
1422 }
1423#endif
1424 uData.fSupportedEvents = SUPPORTED_EVENTS;
1425 aReqSegs[0].pvSeg = &uData.fSupportedEvents;
1426 aReqSegs[0].cbSeg = sizeof(uData.fSupportedEvents);
1427 cSegs = 1;
1428 break;
1429 }
1430 case VIRTIOSCSI_T_AN_SUBSCRIBE: /* Guest SCSI driver is subscribing to async event notification(s) */
1431 {
1432 if (ScsiCtrlUnion.AsyncNotify.fEventsRequested & ~SUBSCRIBABLE_EVENTS)
1433 LogFunc(("Unsupported bits in event subscription event mask: %#x\n",
1434 ScsiCtrlUnion.AsyncNotify.fEventsRequested));
1435
1436 uint8_t uTarget = ScsiCtrlUnion.AsyncNotify.abScsiLun[1];
1437 uint32_t uScsiLun = RT_MAKE_U16(ScsiCtrlUnion.AsyncNotify.abScsiLun[3],
1438 ScsiCtrlUnion.AsyncNotify.abScsiLun[2]) & 0x3fff;
1439
1440#ifdef LOG_ENABLED
1441 if (LogIs2Enabled())
1442 {
1443 char szTypeText[128];
1444 virtioGetControlAsyncMaskText(szTypeText, sizeof(szTypeText), ScsiCtrlUnion.AsyncNotify.fEventsRequested);
1445 Log2Func(("[%s] (Target: %d LUN: %d) Async. Notification Subscribe: %s\n",
1446 VIRTQNAME(qIdx), uTarget, uScsiLun, szTypeText));
1447 }
1448#endif
1449 if (uTarget >= pThis->cTargets || !pThisCC->paTargetInstances[uTarget].fPresent)
1450 bResponse = VIRTIOSCSI_S_BAD_TARGET;
1451 else
1452 if (uScsiLun != 0)
1453 bResponse = VIRTIOSCSI_S_INCORRECT_LUN;
1454 else
1455 {
1456 bResponse = VIRTIOSCSI_S_FUNCTION_SUCCEEDED; /* or VIRTIOSCSI_S_FUNCTION_COMPLETE? */
1457 pThis->fAsyncEvtsEnabled = SUPPORTED_EVENTS & ScsiCtrlUnion.AsyncNotify.fEventsRequested;
1458 }
1459
1460 aReqSegs[0].pvSeg = &pThis->fAsyncEvtsEnabled;
1461 aReqSegs[0].cbSeg = sizeof(pThis->fAsyncEvtsEnabled);
1462 cSegs = 1;
1463 break;
1464 }
1465 default:
1466 {
1467 LogFunc(("Unknown control type extracted from %s: %u\n", VIRTQNAME(qIdx), ScsiCtrlUnion.Type.uType));
1468
1469 bResponse = VIRTIOSCSI_S_FAILURE;
1470 cSegs = 0; /* only bResponse */
1471 break;
1472 }
1473 }
1474
1475 /* Add the response code: */
1476 aReqSegs[cSegs].pvSeg = &bResponse;
1477 aReqSegs[cSegs].cbSeg = sizeof(bResponse);
1478 cSegs++;
1479 Assert(cSegs <= RT_ELEMENTS(aReqSegs));
1480
1481 LogFunc(("Response code: %s\n", virtioGetReqRespText(bResponse)));
1482
1483 RTSGBUF ReqSgBuf;
1484 RTSgBufInit(&ReqSgBuf, aReqSegs, cSegs);
1485
1486 virtioCoreR3QueuePut(pDevIns, &pThis->Virtio, qIdx, &ReqSgBuf, pDescChain, true /*fFence*/);
1487 virtioCoreQueueSync(pDevIns, &pThis->Virtio, qIdx);
1488
1489 return VINF_SUCCESS;
1490}
1491
1492/**
1493 * @callback_method_impl{FNPDMTHREADWAKEUPDEV}
1494 */
1495static DECLCALLBACK(int) virtioScsiR3WorkerWakeUp(PPDMDEVINS pDevIns, PPDMTHREAD pThread)
1496{
1497 PVIRTIOSCSI pThis = PDMDEVINS_2_DATA(pDevIns, PVIRTIOSCSI);
1498 return PDMDevHlpSUPSemEventSignal(pDevIns, pThis->aWorkers[(uintptr_t)pThread->pvUser].hEvtProcess);
1499}
1500
1501/**
1502 * @callback_method_impl{FNPDMTHREADDEV}
1503 */
1504static DECLCALLBACK(int) virtioScsiR3WorkerThread(PPDMDEVINS pDevIns, PPDMTHREAD pThread)
1505{
1506 uint16_t const qIdx = (uint16_t)(uintptr_t)pThread->pvUser;
1507 PVIRTIOSCSI pThis = PDMDEVINS_2_DATA(pDevIns, PVIRTIOSCSI);
1508 PVIRTIOSCSICC pThisCC = PDMDEVINS_2_DATA_CC(pDevIns, PVIRTIOSCSICC);
1509 PVIRTIOSCSIWORKER pWorker = &pThis->aWorkers[qIdx];
1510 PVIRTIOSCSIWORKERR3 pWorkerR3 = &pThisCC->aWorkers[qIdx];
1511
1512 if (pThread->enmState == PDMTHREADSTATE_INITIALIZING)
1513 return VINF_SUCCESS;
1514
1515 while (pThread->enmState == PDMTHREADSTATE_RUNNING)
1516 {
1517 if (!pWorkerR3->cRedoDescs && virtioCoreQueueIsEmpty(pDevIns, &pThis->Virtio, qIdx))
1518 {
1519 /* Atomic interlocks avoid missing alarm while going to sleep & notifier waking the awoken */
1520 ASMAtomicWriteBool(&pWorkerR3->fSleeping, true);
1521 bool fNotificationSent = ASMAtomicXchgBool(&pWorkerR3->fNotified, false);
1522 if (!fNotificationSent)
1523 {
1524 Log6Func(("%s worker sleeping...\n", VIRTQNAME(qIdx)));
1525 Assert(ASMAtomicReadBool(&pWorkerR3->fSleeping));
1526 int rc = PDMDevHlpSUPSemEventWaitNoResume(pDevIns, pWorker->hEvtProcess, RT_INDEFINITE_WAIT);
1527 AssertLogRelMsgReturn(RT_SUCCESS(rc) || rc == VERR_INTERRUPTED, ("%Rrc\n", rc), rc);
1528 if (RT_UNLIKELY(pThread->enmState != PDMTHREADSTATE_RUNNING))
1529 return VINF_SUCCESS;
1530 if (rc == VERR_INTERRUPTED)
1531 continue;
1532 Log6Func(("%s worker woken\n", VIRTQNAME(qIdx)));
1533 ASMAtomicWriteBool(&pWorkerR3->fNotified, false);
1534 }
1535 ASMAtomicWriteBool(&pWorkerR3->fSleeping, false);
1536 }
1537
1538 if (!pThis->afQueueAttached[qIdx])
1539 {
1540 LogFunc(("%s queue not attached, worker aborting...\n", VIRTQNAME(qIdx)));
1541 break;
1542 }
1543 if (!pThisCC->fQuiescing)
1544 {
1545 /* Process any reqs that were suspended saved to the redo queue in save exec. */
1546 for (int i = 0; i < pWorkerR3->cRedoDescs; i++)
1547 {
1548 PVIRTIO_DESC_CHAIN_T pDescChain;
1549 int rc = virtioCoreR3DescChainGet(pDevIns, &pThis->Virtio, qIdx,
1550 pWorkerR3->auRedoDescs[i], &pDescChain);
1551 if (RT_FAILURE(rc))
1552 LogRel(("Error fetching desc chain to redo, %Rrc", rc));
1553
1554 rc = virtioScsiR3ReqSubmit(pDevIns, pThis, pThisCC, qIdx, pDescChain);
1555 if (RT_FAILURE(rc))
1556 LogRel(("Error submitting req packet, resetting %Rrc", rc));
1557 }
1558 pWorkerR3->cRedoDescs = 0;
1559
1560 Log6Func(("fetching next descriptor chain from %s\n", VIRTQNAME(qIdx)));
1561 PVIRTIO_DESC_CHAIN_T pDescChain;
1562 int rc = virtioCoreR3QueueGet(pDevIns, &pThis->Virtio, qIdx, &pDescChain, true);
1563 if (rc == VERR_NOT_AVAILABLE)
1564 {
1565 Log6Func(("Nothing found in %s\n", VIRTQNAME(qIdx)));
1566 continue;
1567 }
1568
1569 AssertRC(rc);
1570 if (qIdx == CONTROLQ_IDX)
1571 virtioScsiR3Ctrl(pDevIns, pThis, pThisCC, qIdx, pDescChain);
1572 else /* request queue index */
1573 {
1574 rc = virtioScsiR3ReqSubmit(pDevIns, pThis, pThisCC, qIdx, pDescChain);
1575 if (RT_FAILURE(rc))
1576 LogRel(("Error submitting req packet, resetting %Rrc", rc));
1577 }
1578 }
1579 }
1580 return VINF_SUCCESS;
1581}
1582
1583
1584/*********************************************************************************************************************************
1585* Sending evnets
1586*********************************************************************************************************************************/
1587
1588DECLINLINE(void) virtioScsiR3ReportEventsMissed(PPDMDEVINS pDevIns, PVIRTIOSCSI pThis, uint16_t uTarget)
1589{
1590 virtioScsiR3SendEvent(pDevIns, pThis, uTarget, VIRTIOSCSI_T_NO_EVENT | VIRTIOSCSI_T_EVENTS_MISSED, 0);
1591}
1592
1593
1594#if 0
1595/* SUBSCRIBABLE EVENT - not sure when to call this or how to detect when media is added or removed
1596 * via the VBox GUI */
1597DECLINLINE(void) virtioScsiR3ReportMediaChange(PPDMDEVINS pDevIns, PVIRTIOSCSI pThis, uint16_t uTarget)
1598{
1599 if (pThis->fAsyncEvtsEnabled & VIRTIOSCSI_EVT_ASYNC_MEDIA_CHANGE)
1600 virtioScsiR3SendEvent(pDevIns, pThis, uTarget, VIRTIOSCSI_T_ASYNC_NOTIFY, VIRTIOSCSI_EVT_ASYNC_MEDIA_CHANGE);
1601}
1602
1603/* ESSENTIAL (NON-SUBSCRIBABLE) EVENT TYPES (most guest virtio-scsi drivers ignore?) */
1604
1605DECLINLINE(void) virtioScsiR3ReportTransportReset(PDMDEVINS pDevIns, PVIRTIOSCSI pThis, uint16_t uTarget)
1606{
1607 virtioScsiR3SendEvent(pDevIns, pThis, uTarget, VIRTIOSCSI_T_TRANSPORT_RESET, VIRTIOSCSI_EVT_RESET_HARD);
1608}
1609
1610DECLINLINE(void) virtioScsiR3ReportParamChange(PDMDEVINS pDevIns, PVIRTIOSCSI pThis, uint16_t uTarget,
1611 uint32_t uSenseCode, uint32_t uSenseQualifier)
1612{
1613 uint32_t uReason = uSenseQualifier << 8 | uSenseCode;
1614 virtioScsiR3SendEvent(pDevIns, pThis, uTarget, VIRTIOSCSI_T_PARAM_CHANGE, uReason);
1615
1616}
1617
1618DECLINLINE(void) virtioScsiR3ReportTargetRemoved(PDMDEVINS pDevIns, PVIRTIOSCSI pThis, uint16_t uTarget)
1619{
1620 if (pThis->fHasHotplug)
1621 virtioScsiR3SendEvent(pDevIns, pThis, uTarget, VIRTIOSCSI_T_TRANSPORT_RESET, VIRTIOSCSI_EVT_RESET_REMOVED);
1622}
1623
1624DECLINLINE(void) virtioScsiR3ReportTargetAdded(PDMDEVINS pDevInsPVIRTIOSCSI pThis, uint16_t uTarget)
1625{
1626 if (pThis->fHasHotplug)
1627 virtioScsiR3SendEvent(pDevIns, pThis, uTarget, VIRTIOSCSI_T_TRANSPORT_RESET, VIRTIOSCSI_EVT_RESET_RESCAN);
1628}
1629
1630#endif
1631
1632/**
1633 * @callback_method_impl{VIRTIOCORER3,pfnQueueNotified}
1634 */
1635static DECLCALLBACK(void) virtioScsiR3Notified(PVIRTIOCORE pVirtio, PVIRTIOCORECC pVirtioCC, uint16_t qIdx)
1636{
1637 PVIRTIOSCSI pThis = RT_FROM_MEMBER(pVirtio, VIRTIOSCSI, Virtio);
1638 PVIRTIOSCSICC pThisCC = RT_FROM_MEMBER(pVirtioCC, VIRTIOSCSICC, Virtio);
1639 PPDMDEVINS pDevIns = pThisCC->pDevIns;
1640 AssertReturnVoid(qIdx < VIRTIOSCSI_QUEUE_CNT);
1641 PVIRTIOSCSIWORKER pWorker = &pThis->aWorkers[qIdx];
1642 PVIRTIOSCSIWORKERR3 pWorkerR3 = &pThisCC->aWorkers[qIdx];
1643
1644#ifdef LOG_ENABLED
1645 RTLogFlush(NULL);
1646#endif
1647
1648 if (qIdx == CONTROLQ_IDX || IS_REQ_QUEUE(qIdx))
1649 {
1650 Log6Func(("%s has available data\n", VIRTQNAME(qIdx)));
1651 /* Wake queue's worker thread up if sleeping */
1652 if (!ASMAtomicXchgBool(&pWorkerR3->fNotified, true))
1653 {
1654 if (ASMAtomicReadBool(&pWorkerR3->fSleeping))
1655 {
1656 Log6Func(("waking %s worker.\n", VIRTQNAME(qIdx)));
1657 int rc = PDMDevHlpSUPSemEventSignal(pDevIns, pWorker->hEvtProcess);
1658 AssertRC(rc);
1659 }
1660 }
1661 }
1662 else if (qIdx == EVENTQ_IDX)
1663 {
1664 Log3Func(("Driver queued buffer(s) to %s\n", VIRTQNAME(qIdx)));
1665 if (ASMAtomicXchgBool(&pThis->fEventsMissed, false))
1666 virtioScsiR3ReportEventsMissed(pDevIns, pThis, 0);
1667 }
1668 else
1669 LogFunc(("Unexpected queue idx (ignoring): %d\n", qIdx));
1670}
1671
1672/**
1673 * @callback_method_impl{VIRTIOCORER3,pfnStatusChanged}
1674 */
1675static DECLCALLBACK(void) virtioScsiR3StatusChanged(PVIRTIOCORE pVirtio, PVIRTIOCORECC pVirtioCC, uint32_t fVirtioReady)
1676{
1677 PVIRTIOSCSI pThis = RT_FROM_MEMBER(pVirtio, VIRTIOSCSI, Virtio);
1678 PVIRTIOSCSICC pThisCC = RT_FROM_MEMBER(pVirtioCC, VIRTIOSCSICC, Virtio);
1679
1680 pThis->fVirtioReady = fVirtioReady;
1681
1682 if (fVirtioReady)
1683 {
1684 LogFunc(("VirtIO ready\n-----------------------------------------------------------------------------------------\n"));
1685 uint64_t fFeatures = virtioCoreGetNegotiatedFeatures(&pThis->Virtio);
1686 pThis->fHasT10pi = fFeatures & VIRTIO_SCSI_F_T10_PI;
1687 pThis->fHasHotplug = fFeatures & VIRTIO_SCSI_F_HOTPLUG;
1688 pThis->fHasInOutBufs = fFeatures & VIRTIO_SCSI_F_INOUT;
1689 pThis->fHasLunChange = fFeatures & VIRTIO_SCSI_F_CHANGE;
1690 pThis->fResetting = false;
1691 pThisCC->fQuiescing = false;
1692
1693 for (unsigned i = 0; i < VIRTIOSCSI_QUEUE_CNT; i++)
1694 pThis->afQueueAttached[i] = true;
1695 }
1696 else
1697 {
1698 LogFunc(("VirtIO is resetting\n"));
1699 for (unsigned i = 0; i < VIRTIOSCSI_QUEUE_CNT; i++)
1700 pThis->afQueueAttached[i] = false;
1701 }
1702}
1703
1704
1705/*********************************************************************************************************************************
1706* LEDs *
1707*********************************************************************************************************************************/
1708
1709/**
1710 * @interface_method_impl{PDMILEDPORTS,pfnQueryStatusLed, Target level.}
1711 */
1712static DECLCALLBACK(int) virtioScsiR3TargetQueryStatusLed(PPDMILEDPORTS pInterface, unsigned iLUN, PPDMLED *ppLed)
1713{
1714 PVIRTIOSCSITARGET pTarget = RT_FROM_MEMBER(pInterface, VIRTIOSCSITARGET, ILed);
1715 if (iLUN == 0)
1716 {
1717 *ppLed = &pTarget->led;
1718 Assert((*ppLed)->u32Magic == PDMLED_MAGIC);
1719 return VINF_SUCCESS;
1720 }
1721 return VERR_PDM_LUN_NOT_FOUND;
1722}
1723/**
1724 * @interface_method_impl{PDMILEDPORTS,pfnQueryStatusLed, Device level.}
1725 */
1726static DECLCALLBACK(int) virtioScsiR3DeviceQueryStatusLed(PPDMILEDPORTS pInterface, unsigned iLUN, PPDMLED *ppLed)
1727{
1728 PVIRTIOSCSICC pThisCC = RT_FROM_MEMBER(pInterface, VIRTIOSCSICC, ILeds);
1729 PVIRTIOSCSI pThis = PDMDEVINS_2_DATA(pThisCC->pDevIns, PVIRTIOSCSI);
1730 if (iLUN < pThis->cTargets)
1731 {
1732 *ppLed = &pThisCC->paTargetInstances[iLUN].led;
1733 Assert((*ppLed)->u32Magic == PDMLED_MAGIC);
1734 return VINF_SUCCESS;
1735 }
1736 return VERR_PDM_LUN_NOT_FOUND;
1737}
1738
1739
1740/*********************************************************************************************************************************
1741* PDMIMEDIAPORT (target) *
1742*********************************************************************************************************************************/
1743
1744/**
1745 * @interface_method_impl{PDMIMEDIAPORT,pfnQueryDeviceLocation, Target level.}
1746 */
1747static DECLCALLBACK(int) virtioScsiR3QueryDeviceLocation(PPDMIMEDIAPORT pInterface, const char **ppcszController,
1748 uint32_t *piInstance, uint32_t *piLUN)
1749{
1750 PVIRTIOSCSITARGET pTarget = RT_FROM_MEMBER(pInterface, VIRTIOSCSITARGET, IMediaPort);
1751 PPDMDEVINS pDevIns = pTarget->pDevIns;
1752
1753 AssertPtrReturn(ppcszController, VERR_INVALID_POINTER);
1754 AssertPtrReturn(piInstance, VERR_INVALID_POINTER);
1755 AssertPtrReturn(piLUN, VERR_INVALID_POINTER);
1756
1757 *ppcszController = pDevIns->pReg->szName;
1758 *piInstance = pDevIns->iInstance;
1759 *piLUN = pTarget->uTarget;
1760
1761 return VINF_SUCCESS;
1762}
1763
1764
1765/*********************************************************************************************************************************
1766* Virtio config. *
1767*********************************************************************************************************************************/
1768
1769/**
1770 * Resolves to boolean true if uOffset matches a field offset and size exactly,
1771 * (or if 64-bit field, if it accesses either 32-bit part as a 32-bit access)
1772 * Assumption is this critereon is mandated by VirtIO 1.0, Section 4.1.3.1)
1773 * (Easily re-written to allow unaligned bounded access to a field).
1774 *
1775 * @param member - Member of VIRTIO_PCI_COMMON_CFG_T
1776 * @result - true or false
1777 */
1778#define MATCH_SCSI_CONFIG(member) \
1779 ( ( RT_SIZEOFMEMB(VIRTIOSCSI_CONFIG_T, member) == 8 \
1780 && ( offConfig == RT_UOFFSETOF(VIRTIOSCSI_CONFIG_T, member) \
1781 || offConfig == RT_UOFFSETOF(VIRTIOSCSI_CONFIG_T, member) + sizeof(uint32_t)) \
1782 && cb == sizeof(uint32_t)) \
1783 || ( offConfig == RT_UOFFSETOF(VIRTIOSCSI_CONFIG_T, member) \
1784 && cb == RT_SIZEOFMEMB(VIRTIOSCSI_CONFIG_T, member)) )
1785
1786#ifdef LOG_ENABLED
1787# define LOG_SCSI_CONFIG_ACCESSOR(member) \
1788 virtioCoreLogMappedIoValue(__FUNCTION__, #member, RT_SIZEOFMEMB(VIRTIOSCSI_CONFIG_T, member), \
1789 pv, cb, offIntra, fWrite, false, 0);
1790#else
1791# define LOG_SCSI_CONFIG_ACCESSOR(member) do { } while (0)
1792#endif
1793
1794#define SCSI_CONFIG_ACCESSOR(member) \
1795 do \
1796 { \
1797 uint32_t offIntra = offConfig - RT_UOFFSETOF(VIRTIOSCSI_CONFIG_T, member); \
1798 if (fWrite) \
1799 memcpy((char *)&pThis->virtioScsiConfig.member + offIntra, pv, cb); \
1800 else \
1801 memcpy(pv, (const char *)&pThis->virtioScsiConfig.member + offIntra, cb); \
1802 LOG_SCSI_CONFIG_ACCESSOR(member); \
1803 } while(0)
1804
1805#define SCSI_CONFIG_ACCESSOR_READONLY(member) \
1806 do \
1807 { \
1808 uint32_t offIntra = offConfig - RT_UOFFSETOF(VIRTIOSCSI_CONFIG_T, member); \
1809 if (fWrite) \
1810 LogFunc(("Guest attempted to write readonly virtio_pci_common_cfg.%s\n", #member)); \
1811 else \
1812 { \
1813 memcpy(pv, (const char *)&pThis->virtioScsiConfig.member + offIntra, cb); \
1814 LOG_SCSI_CONFIG_ACCESSOR(member); \
1815 } \
1816 } while(0)
1817
1818/**
1819 * Worker for virtioScsiR3DevCapWrite and virtioScsiR3DevCapRead.
1820 */
1821static int virtioScsiR3CfgAccessed(PVIRTIOSCSI pThis, uint32_t offConfig, void *pv, uint32_t cb, bool fWrite)
1822{
1823 AssertReturn(pv && cb <= sizeof(uint32_t), fWrite ? VINF_SUCCESS : VINF_IOM_MMIO_UNUSED_00);
1824
1825 if (MATCH_SCSI_CONFIG(uNumQueues))
1826 SCSI_CONFIG_ACCESSOR_READONLY(uNumQueues);
1827 else
1828 if (MATCH_SCSI_CONFIG(uSegMax))
1829 SCSI_CONFIG_ACCESSOR_READONLY(uSegMax);
1830 else
1831 if (MATCH_SCSI_CONFIG(uMaxSectors))
1832 SCSI_CONFIG_ACCESSOR_READONLY(uMaxSectors);
1833 else
1834 if (MATCH_SCSI_CONFIG(uCmdPerLun))
1835 SCSI_CONFIG_ACCESSOR_READONLY(uCmdPerLun);
1836 else
1837 if (MATCH_SCSI_CONFIG(uEventInfoSize))
1838 SCSI_CONFIG_ACCESSOR_READONLY(uEventInfoSize);
1839 else
1840 if (MATCH_SCSI_CONFIG(uSenseSize))
1841 SCSI_CONFIG_ACCESSOR(uSenseSize);
1842 else
1843 if (MATCH_SCSI_CONFIG(uCdbSize))
1844 SCSI_CONFIG_ACCESSOR(uCdbSize);
1845 else
1846 if (MATCH_SCSI_CONFIG(uMaxChannel))
1847 SCSI_CONFIG_ACCESSOR_READONLY(uMaxChannel);
1848 else
1849 if (MATCH_SCSI_CONFIG(uMaxTarget))
1850 SCSI_CONFIG_ACCESSOR_READONLY(uMaxTarget);
1851 else
1852 if (MATCH_SCSI_CONFIG(uMaxLun))
1853 SCSI_CONFIG_ACCESSOR_READONLY(uMaxLun);
1854 else
1855 {
1856 LogFunc(("Bad access by guest to virtio_scsi_config: off=%u (%#x), cb=%u\n", offConfig, offConfig, cb));
1857 return fWrite ? VINF_SUCCESS : VINF_IOM_MMIO_UNUSED_00;
1858 }
1859 return VINF_SUCCESS;
1860}
1861
1862#undef SCSI_CONFIG_ACCESSOR_READONLY
1863#undef SCSI_CONFIG_ACCESSOR
1864#undef LOG_ACCESSOR
1865#undef MATCH_SCSI_CONFIG
1866
1867/**
1868 * @callback_method_impl{VIRTIOCORER3,pfnDevCapRead}
1869 */
1870static DECLCALLBACK(int) virtioScsiR3DevCapRead(PPDMDEVINS pDevIns, uint32_t uOffset, void *pv, uint32_t cb)
1871{
1872 return virtioScsiR3CfgAccessed(PDMDEVINS_2_DATA(pDevIns, PVIRTIOSCSI), uOffset, pv, cb, false /*fRead*/);
1873}
1874
1875/**
1876 * @callback_method_impl{VIRTIOCORER3,pfnDevCapWrite}
1877 */
1878static DECLCALLBACK(int) virtioScsiR3DevCapWrite(PPDMDEVINS pDevIns, uint32_t uOffset, const void *pv, uint32_t cb)
1879{
1880 return virtioScsiR3CfgAccessed(PDMDEVINS_2_DATA(pDevIns, PVIRTIOSCSI), uOffset, (void *)pv, cb, true /*fWrite*/);
1881}
1882
1883
1884/*********************************************************************************************************************************
1885* IBase for device and targets *
1886*********************************************************************************************************************************/
1887
1888/**
1889 * @interface_method_impl{PDMIBASE,pfnQueryInterface, Target level.}
1890 */
1891static DECLCALLBACK(void *) virtioScsiR3TargetQueryInterface(PPDMIBASE pInterface, const char *pszIID)
1892{
1893 PVIRTIOSCSITARGET pTarget = RT_FROM_MEMBER(pInterface, VIRTIOSCSITARGET, IBase);
1894 PDMIBASE_RETURN_INTERFACE(pszIID, PDMIBASE, &pTarget->IBase);
1895 PDMIBASE_RETURN_INTERFACE(pszIID, PDMIMEDIAPORT, &pTarget->IMediaPort);
1896 PDMIBASE_RETURN_INTERFACE(pszIID, PDMIMEDIAEXPORT, &pTarget->IMediaExPort);
1897 PDMIBASE_RETURN_INTERFACE(pszIID, PDMILEDPORTS, &pTarget->ILed);
1898 return NULL;
1899}
1900
1901/**
1902 * @interface_method_impl{PDMIBASE,pfnQueryInterface, Device level.}
1903 */
1904static DECLCALLBACK(void *) virtioScsiR3DeviceQueryInterface(PPDMIBASE pInterface, const char *pszIID)
1905{
1906 PVIRTIOSCSICC pThisCC = RT_FROM_MEMBER(pInterface, VIRTIOSCSICC, IBase);
1907
1908 PDMIBASE_RETURN_INTERFACE(pszIID, PDMIBASE, &pThisCC->IBase);
1909 PDMIBASE_RETURN_INTERFACE(pszIID, PDMILEDPORTS, &pThisCC->ILeds);
1910
1911 return NULL;
1912}
1913
1914
1915/*********************************************************************************************************************************
1916* Misc *
1917*********************************************************************************************************************************/
1918
1919/**
1920 * @callback_method_impl{FNDBGFHANDLERDEV, virtio-scsi debugger info callback.}
1921 */
1922static DECLCALLBACK(void) virtioScsiR3Info(PPDMDEVINS pDevIns, PCDBGFINFOHLP pHlp, const char *pszArgs)
1923{
1924 PVIRTIOSCSI pThis = PDMDEVINS_2_DATA(pDevIns, PVIRTIOSCSI);
1925
1926 /* Parse arguments. */
1927 RT_NOREF(pszArgs); //bool fVerbose = pszArgs && strstr(pszArgs, "verbose") != NULL;
1928
1929 /* Show basic information. */
1930 pHlp->pfnPrintf(pHlp, "%s#%d: virtio-scsci ",
1931 pDevIns->pReg->szName,
1932 pDevIns->iInstance);
1933 pHlp->pfnPrintf(pHlp, "numTargets=%lu", pThis->cTargets);
1934}
1935
1936
1937/*********************************************************************************************************************************
1938* Saved state *
1939*********************************************************************************************************************************/
1940
1941/**
1942 * @callback_method_impl{FNSSMDEVLOADEXEC}
1943 */
1944static DECLCALLBACK(int) virtioScsiR3LoadExec(PPDMDEVINS pDevIns, PSSMHANDLE pSSM, uint32_t uVersion, uint32_t uPass)
1945{
1946 PVIRTIOSCSI pThis = PDMDEVINS_2_DATA(pDevIns, PVIRTIOSCSI);
1947 PVIRTIOSCSICC pThisCC = PDMDEVINS_2_DATA_CC(pDevIns, PVIRTIOSCSICC);
1948 PCPDMDEVHLPR3 pHlp = pDevIns->pHlpR3;
1949
1950 LogFunc(("LOAD EXEC!!\n"));
1951
1952 AssertReturn(uPass == SSM_PASS_FINAL, VERR_SSM_UNEXPECTED_PASS);
1953 AssertLogRelMsgReturn(uVersion == VIRTIOSCSI_SAVED_STATE_VERSION,
1954 ("uVersion=%u\n", uVersion), VERR_SSM_UNSUPPORTED_DATA_UNIT_VERSION);
1955
1956 virtioScsiSetVirtqNames(pThis);
1957 for (int qIdx = 0; qIdx < VIRTIOSCSI_QUEUE_CNT; qIdx++)
1958 pHlp->pfnSSMGetBool(pSSM, &pThis->afQueueAttached[qIdx]);
1959
1960 pHlp->pfnSSMGetU32(pSSM, &pThis->virtioScsiConfig.uNumQueues);
1961 pHlp->pfnSSMGetU32(pSSM, &pThis->virtioScsiConfig.uSegMax);
1962 pHlp->pfnSSMGetU32(pSSM, &pThis->virtioScsiConfig.uMaxSectors);
1963 pHlp->pfnSSMGetU32(pSSM, &pThis->virtioScsiConfig.uCmdPerLun);
1964 pHlp->pfnSSMGetU32(pSSM, &pThis->virtioScsiConfig.uEventInfoSize);
1965 pHlp->pfnSSMGetU32(pSSM, &pThis->virtioScsiConfig.uSenseSize);
1966 pHlp->pfnSSMGetU32(pSSM, &pThis->virtioScsiConfig.uCdbSize);
1967 pHlp->pfnSSMGetU16(pSSM, &pThis->virtioScsiConfig.uMaxChannel);
1968 pHlp->pfnSSMGetU16(pSSM, &pThis->virtioScsiConfig.uMaxTarget);
1969 pHlp->pfnSSMGetU32(pSSM, &pThis->virtioScsiConfig.uMaxLun);
1970 pHlp->pfnSSMGetU32(pSSM, &pThis->fAsyncEvtsEnabled);
1971 pHlp->pfnSSMGetBool(pSSM, &pThis->fEventsMissed);
1972 pHlp->pfnSSMGetU32(pSSM, &pThis->fVirtioReady);
1973 pHlp->pfnSSMGetU32(pSSM, &pThis->fHasT10pi);
1974 pHlp->pfnSSMGetU32(pSSM, &pThis->fHasHotplug);
1975 pHlp->pfnSSMGetU32(pSSM, &pThis->fHasInOutBufs);
1976 pHlp->pfnSSMGetU32(pSSM, &pThis->fHasLunChange);
1977 pHlp->pfnSSMGetU32(pSSM, &pThis->fResetting);
1978
1979 pHlp->pfnSSMGetU32(pSSM, &pThis->cTargets);
1980
1981 for (uint16_t uTarget = 0; uTarget < pThis->cTargets; uTarget++)
1982 {
1983 uint16_t cReqsRedo;
1984 pHlp->pfnSSMGetU16(pSSM, &cReqsRedo);
1985 if (cReqsRedo >= VIRTQ_MAX_SIZE)
1986 {
1987 LogFunc(("Bad count of I/O transactions to re-do in SSM state data. Skipping\n"));
1988 continue;
1989 }
1990
1991 for (uint16_t qIdx = VIRTQ_REQ_BASE; qIdx < VIRTIOSCSI_QUEUE_CNT; qIdx++)
1992 {
1993 PVIRTIOSCSIWORKERR3 pWorkerR3 = &pThisCC->aWorkers[qIdx];
1994 pWorkerR3->cRedoDescs = 0;
1995 }
1996
1997 for (int i = 0; i < cReqsRedo; i++)
1998 {
1999 uint16_t qIdx, uHeadIdx;
2000
2001 pHlp->pfnSSMGetU16(pSSM, &qIdx);
2002 pHlp->pfnSSMGetU16(pSSM, &uHeadIdx);
2003
2004 if (qIdx >= VIRTIOSCSI_QUEUE_CNT)
2005 {
2006 LogFunc(("Bad queue index in SSM state data. Skipping\n"));
2007 continue;
2008 }
2009 if (uHeadIdx >= VIRTQ_MAX_SIZE)
2010 {
2011 LogFunc(("Bad queue elem index in SSM state data. Skipping\n"));
2012 continue;
2013 }
2014 PVIRTIOSCSIWORKERR3 pWorkerR3 = &pThisCC->aWorkers[qIdx];
2015 pWorkerR3->auRedoDescs[pWorkerR3->cRedoDescs++] = uHeadIdx;
2016 pWorkerR3->cRedoDescs %= VIRTQ_MAX_SIZE;
2017 }
2018 }
2019
2020 /*
2021 * Call the virtio core to let it load its state.
2022 */
2023 int rc = virtioCoreR3LoadExec(&pThis->Virtio, pDevIns->pHlpR3, pSSM);
2024
2025 /*
2026 * Nudge request queue workers
2027 */
2028 for (int qIdx = VIRTQ_REQ_BASE; qIdx < VIRTIOSCSI_QUEUE_CNT; qIdx++)
2029 {
2030 if (pThis->afQueueAttached[qIdx])
2031 {
2032 LogFunc(("Waking %s worker.\n", VIRTQNAME(qIdx)));
2033 rc = PDMDevHlpSUPSemEventSignal(pDevIns, pThis->aWorkers[qIdx].hEvtProcess);
2034 AssertRCReturn(rc, rc);
2035 }
2036 }
2037 return rc;
2038}
2039
2040/**
2041 * @callback_method_impl{FNSSMDEVSAVEEXEC}
2042 */
2043static DECLCALLBACK(int) virtioScsiR3SaveExec(PPDMDEVINS pDevIns, PSSMHANDLE pSSM)
2044{
2045 PVIRTIOSCSI pThis = PDMDEVINS_2_DATA(pDevIns, PVIRTIOSCSI);
2046 PVIRTIOSCSICC pThisCC = PDMDEVINS_2_DATA_CC(pDevIns, PVIRTIOSCSICC);
2047 PCPDMDEVHLPR3 pHlp = pDevIns->pHlpR3;
2048
2049 LogFunc(("SAVE EXEC!!\n"));
2050
2051 for (int qIdx = 0; qIdx < VIRTIOSCSI_QUEUE_CNT; qIdx++)
2052 pHlp->pfnSSMPutBool(pSSM, pThis->afQueueAttached[qIdx]);
2053
2054 pHlp->pfnSSMPutU32(pSSM, pThis->virtioScsiConfig.uNumQueues);
2055 pHlp->pfnSSMPutU32(pSSM, pThis->virtioScsiConfig.uSegMax);
2056 pHlp->pfnSSMPutU32(pSSM, pThis->virtioScsiConfig.uMaxSectors);
2057 pHlp->pfnSSMPutU32(pSSM, pThis->virtioScsiConfig.uCmdPerLun);
2058 pHlp->pfnSSMPutU32(pSSM, pThis->virtioScsiConfig.uEventInfoSize);
2059 pHlp->pfnSSMPutU32(pSSM, pThis->virtioScsiConfig.uSenseSize);
2060 pHlp->pfnSSMPutU32(pSSM, pThis->virtioScsiConfig.uCdbSize);
2061 pHlp->pfnSSMPutU16(pSSM, pThis->virtioScsiConfig.uMaxChannel);
2062 pHlp->pfnSSMPutU16(pSSM, pThis->virtioScsiConfig.uMaxTarget);
2063 pHlp->pfnSSMPutU32(pSSM, pThis->virtioScsiConfig.uMaxLun);
2064 pHlp->pfnSSMPutU32(pSSM, pThis->fAsyncEvtsEnabled);
2065 pHlp->pfnSSMPutBool(pSSM, pThis->fEventsMissed);
2066 pHlp->pfnSSMPutU32(pSSM, pThis->fVirtioReady);
2067 pHlp->pfnSSMPutU32(pSSM, pThis->fHasT10pi);
2068 pHlp->pfnSSMPutU32(pSSM, pThis->fHasHotplug);
2069 pHlp->pfnSSMPutU32(pSSM, pThis->fHasInOutBufs);
2070 pHlp->pfnSSMPutU32(pSSM, pThis->fHasLunChange);
2071 pHlp->pfnSSMPutU32(pSSM, pThis->fResetting);
2072
2073 AssertMsg(!pThis->cActiveReqs, ("There are still outstanding requests on this device\n"));
2074
2075 pHlp->pfnSSMPutU32(pSSM, pThis->cTargets);
2076
2077 for (uint16_t uTarget = 0; uTarget < pThis->cTargets; uTarget++)
2078 {
2079 PVIRTIOSCSITARGET pTarget = &pThisCC->paTargetInstances[uTarget];
2080
2081 /* Query all suspended requests and store them in the request queue. */
2082 if (pTarget->pDrvMediaEx)
2083 {
2084 uint32_t cReqsRedo = pTarget->pDrvMediaEx->pfnIoReqGetSuspendedCount(pTarget->pDrvMediaEx);
2085
2086 pHlp->pfnSSMPutU16(pSSM, cReqsRedo);
2087
2088 if (cReqsRedo)
2089 {
2090 PDMMEDIAEXIOREQ hIoReq;
2091 PVIRTIOSCSIREQ pReq;
2092
2093 int rc = pTarget->pDrvMediaEx->pfnIoReqQuerySuspendedStart(pTarget->pDrvMediaEx, &hIoReq,
2094 (void **)&pReq);
2095 AssertRCBreak(rc);
2096
2097 while(--cReqsRedo)
2098 {
2099 pHlp->pfnSSMPutU16(pSSM, pReq->qIdx);
2100 pHlp->pfnSSMPutU16(pSSM, pReq->pDescChain->uHeadIdx);
2101
2102 rc = pTarget->pDrvMediaEx->pfnIoReqQuerySuspendedNext(pTarget->pDrvMediaEx, hIoReq,
2103 &hIoReq, (void **)&pReq);
2104 AssertRCBreak(rc);
2105 }
2106 }
2107 }
2108 }
2109
2110 /*
2111 * Call the virtio core to let it save its state.
2112 */
2113 return virtioCoreR3SaveExec(&pThis->Virtio, pDevIns->pHlpR3, pSSM);
2114}
2115
2116
2117/*********************************************************************************************************************************
2118* Device interface. *
2119*********************************************************************************************************************************/
2120
2121/**
2122 * @interface_method_impl{PDMDEVREGR3,pfnDetach}
2123 *
2124 * One harddisk at one port has been unplugged.
2125 * The VM is suspended at this point.
2126 */
2127static DECLCALLBACK(void) virtioScsiR3Detach(PPDMDEVINS pDevIns, unsigned uTarget, uint32_t fFlags)
2128{
2129 PVIRTIOSCSI pThis = PDMDEVINS_2_DATA(pDevIns, PVIRTIOSCSI);
2130 PVIRTIOSCSICC pThisCC = PDMDEVINS_2_DATA_CC(pDevIns, PVIRTIOSCSICC);
2131 AssertReturnVoid(uTarget < pThis->cTargets);
2132 PVIRTIOSCSITARGET pTarget = &pThisCC->paTargetInstances[uTarget];
2133
2134 LogFunc((""));
2135
2136 AssertMsg(fFlags & PDM_TACH_FLAGS_NOT_HOT_PLUG,
2137 ("virtio-scsi: Device does not support hotplugging\n"));
2138 RT_NOREF(fFlags);
2139
2140 /*
2141 * Zero all important members.
2142 */
2143 pTarget->fPresent = false;
2144 pTarget->pDrvBase = NULL;
2145 pTarget->pDrvMedia = NULL;
2146 pTarget->pDrvMediaEx = NULL;
2147}
2148
2149/**
2150 * @interface_method_impl{PDMDEVREGR3,pfnAttach}
2151 *
2152 * This is called when we change block driver.
2153 */
2154static DECLCALLBACK(int) virtioScsiR3Attach(PPDMDEVINS pDevIns, unsigned uTarget, uint32_t fFlags)
2155{
2156 PVIRTIOSCSI pThis = PDMDEVINS_2_DATA(pDevIns, PVIRTIOSCSI);
2157 PVIRTIOSCSICC pThisCC = PDMDEVINS_2_DATA_CC(pDevIns, PVIRTIOSCSICC);
2158 AssertReturn(uTarget < pThis->cTargets, VERR_PDM_LUN_NOT_FOUND);
2159 PVIRTIOSCSITARGET pTarget = &pThisCC->paTargetInstances[uTarget];
2160
2161 Assert(pTarget->pDevIns == pDevIns);
2162 AssertMsgReturn(fFlags & PDM_TACH_FLAGS_NOT_HOT_PLUG,
2163 ("virtio-scsi: Device does not support hotplugging\n"),
2164 VERR_INVALID_PARAMETER);
2165
2166 AssertRelease(!pTarget->pDrvBase);
2167 Assert(pTarget->uTarget == uTarget);
2168
2169 /*
2170 * Try attach the SCSI driver and get the interfaces, required as well as optional.
2171 */
2172 int rc = PDMDevHlpDriverAttach(pDevIns, pTarget->uTarget, &pDevIns->IBase, &pTarget->pDrvBase, pTarget->pszTargetName);
2173 if (RT_SUCCESS(rc))
2174 {
2175 pTarget->fPresent = true;
2176 pTarget->pDrvMedia = PDMIBASE_QUERY_INTERFACE(pTarget->pDrvBase, PDMIMEDIA);
2177 AssertMsgReturn(VALID_PTR(pTarget->pDrvMedia),
2178 ("virtio-scsi configuration error: LUN#%d missing basic media interface!\n", uTarget),
2179 VERR_PDM_MISSING_INTERFACE);
2180
2181 /* Get the extended media interface. */
2182 pTarget->pDrvMediaEx = PDMIBASE_QUERY_INTERFACE(pTarget->pDrvBase, PDMIMEDIAEX);
2183 AssertMsgReturn(VALID_PTR(pTarget->pDrvMediaEx),
2184 ("virtio-scsi configuration error: LUN#%d missing extended media interface!\n", uTarget),
2185 VERR_PDM_MISSING_INTERFACE);
2186
2187 rc = pTarget->pDrvMediaEx->pfnIoReqAllocSizeSet(pTarget->pDrvMediaEx, sizeof(VIRTIOSCSIREQ));
2188 AssertMsgReturn(VALID_PTR(pTarget->pDrvMediaEx),
2189 ("virtio-scsi configuration error: LUN#%u: Failed to set I/O request size!\n", uTarget),
2190 rc);
2191 }
2192 else
2193 AssertMsgFailed(("Failed to attach %s. rc=%Rrc\n", pTarget->pszTargetName, rc));
2194
2195 if (RT_FAILURE(rc))
2196 {
2197 pTarget->fPresent = false;
2198 pTarget->pDrvBase = NULL;
2199 pTarget->pDrvMedia = NULL;
2200 pTarget->pDrvMediaEx = NULL;
2201 pThisCC->pMediaNotify = NULL;
2202 }
2203 return rc;
2204}
2205
2206/**
2207 * @callback_method_impl{FNPDMDEVASYNCNOTIFY}
2208 */
2209static DECLCALLBACK(bool) virtioScsiR3DeviceQuiesced(PPDMDEVINS pDevIns)
2210{
2211 PVIRTIOSCSI pThis = PDMDEVINS_2_DATA(pDevIns, PVIRTIOSCSI);
2212 PVIRTIOSCSICC pThisCC = PDMDEVINS_2_DATA_CC(pDevIns, PVIRTIOSCSICC);
2213
2214 if (ASMAtomicReadU32(&pThis->cActiveReqs))
2215 return false;
2216
2217 LogFunc(("Device I/O activity quiesced: %s\n",
2218 virtioCoreGetStateChangeText(pThisCC->enmQuiescingFor)));
2219
2220 virtioCoreR3VmStateChanged(&pThis->Virtio, pThisCC->enmQuiescingFor);
2221
2222 pThis->fResetting = false;
2223 pThisCC->fQuiescing = false;
2224
2225 return true;
2226}
2227
2228/**
2229 * Worker for virtioScsiR3Reset() and virtioScsiR3SuspendOrPowerOff().
2230 */
2231static void virtioScsiR3QuiesceDevice(PPDMDEVINS pDevIns, VIRTIOVMSTATECHANGED enmQuiscingFor)
2232{
2233 PVIRTIOSCSI pThis = PDMDEVINS_2_DATA(pDevIns, PVIRTIOSCSI);
2234 PVIRTIOSCSICC pThisCC = PDMDEVINS_2_DATA_CC(pDevIns, PVIRTIOSCSICC);
2235
2236 /* Prevent worker threads from removing/processing elements from virtq's */
2237 pThisCC->fQuiescing = true;
2238 pThisCC->enmQuiescingFor = enmQuiscingFor;
2239
2240 PDMDevHlpSetAsyncNotification(pDevIns, virtioScsiR3DeviceQuiesced);
2241
2242 /* If already quiesced invoke async callback. */
2243 if (!ASMAtomicReadU32(&pThis->cActiveReqs))
2244 PDMDevHlpAsyncNotificationCompleted(pDevIns);
2245}
2246
2247/**
2248 * @interface_method_impl{PDMDEVREGR3,pfnReset}
2249 */
2250static DECLCALLBACK(void) virtioScsiR3Reset(PPDMDEVINS pDevIns)
2251{
2252 LogFunc(("\n"));
2253 PVIRTIOSCSI pThis = PDMDEVINS_2_DATA(pDevIns, PVIRTIOSCSI);
2254 pThis->fResetting = true;
2255 virtioScsiR3QuiesceDevice(pDevIns, kvirtIoVmStateChangedReset);
2256}
2257
2258/**
2259 * @interface_method_impl{PDMDEVREGR3,pfnPowerOff}
2260 */
2261static DECLCALLBACK(void) virtioScsiR3SuspendOrPowerOff(PPDMDEVINS pDevIns, VIRTIOVMSTATECHANGED enmType)
2262{
2263 LogFunc(("\n"));
2264
2265 PVIRTIOSCSI pThis = PDMDEVINS_2_DATA(pDevIns, PVIRTIOSCSI);
2266 PVIRTIOSCSICC pThisCC = PDMDEVINS_2_DATA_CC(pDevIns, PVIRTIOSCSICC);
2267
2268 /* VM is halted, thus no new I/O being dumped into queues by the guest.
2269 * Workers have been flagged to stop pulling stuff already queued-up by the guest.
2270 * Now tell lower-level to to suspend reqs (for example, DrvVD suspends all reqs
2271 * on its wait queue, and we will get a callback as the state changes to
2272 * suspended (and later, resumed) for each).
2273 */
2274 for (uint32_t i = 0; i < pThis->cTargets; i++)
2275 {
2276 PVIRTIOSCSITARGET pTarget = &pThisCC->paTargetInstances[i];
2277 if (pTarget->pDrvMediaEx)
2278 pTarget->pDrvMediaEx->pfnNotifySuspend(pTarget->pDrvMediaEx);
2279 }
2280
2281 virtioScsiR3QuiesceDevice(pDevIns, enmType);
2282}
2283
2284/**
2285 * @interface_method_impl{PDMDEVREGR3,pfnSuspend}
2286 */
2287static DECLCALLBACK(void) virtioScsiR3PowerOff(PPDMDEVINS pDevIns)
2288{
2289 LogFunc(("\n"));
2290 virtioScsiR3SuspendOrPowerOff(pDevIns, kvirtIoVmStateChangedPowerOff);
2291}
2292
2293/**
2294 * @interface_method_impl{PDMDEVREGR3,pfnSuspend}
2295 */
2296static DECLCALLBACK(void) virtioScsiR3Suspend(PPDMDEVINS pDevIns)
2297{
2298 LogFunc(("\n"));
2299 virtioScsiR3SuspendOrPowerOff(pDevIns, kvirtIoVmStateChangedSuspend);
2300}
2301
2302/**
2303 * @interface_method_impl{PDMDEVREGR3,pfnResume}
2304 */
2305static DECLCALLBACK(void) virtioScsiR3Resume(PPDMDEVINS pDevIns)
2306{
2307 PVIRTIOSCSI pThis = PDMDEVINS_2_DATA(pDevIns, PVIRTIOSCSI);
2308 PVIRTIOSCSICC pThisCC = PDMDEVINS_2_DATA_CC(pDevIns, PVIRTIOSCSICC);
2309 LogFunc(("\n"));
2310
2311 pThisCC->fQuiescing = false;
2312
2313 /* Wake worker threads flagged to skip pulling queue entries during quiesce
2314 * to ensure they re-check their queues. Active request queues may already
2315 * be awake due to new reqs coming in.
2316 */
2317 for (uint16_t qIdx = 0; qIdx < VIRTIOSCSI_REQ_QUEUE_CNT; qIdx++)
2318 {
2319 if (ASMAtomicReadBool(&pThisCC->aWorkers[qIdx].fSleeping))
2320 {
2321 Log6Func(("waking %s worker.\n", VIRTQNAME(qIdx)));
2322 int rc = PDMDevHlpSUPSemEventSignal(pDevIns, pThis->aWorkers[qIdx].hEvtProcess);
2323 AssertRC(rc);
2324 }
2325 }
2326 /* Ensure guest is working the queues too. */
2327 virtioCoreR3VmStateChanged(&pThis->Virtio, kvirtIoVmStateChangedResume);
2328}
2329
2330/**
2331 * @interface_method_impl{PDMIMEDIAEXPORT,pfnMediumEjected}
2332 */
2333static DECLCALLBACK(void) virtioScsiR3MediumEjected(PPDMIMEDIAEXPORT pInterface)
2334{
2335 PVIRTIOSCSITARGET pTarget = RT_FROM_MEMBER(pInterface, VIRTIOSCSITARGET, IMediaExPort);
2336 PPDMDEVINS pDevIns = pTarget->pDevIns;
2337 PVIRTIOSCSICC pThisCC = PDMDEVINS_2_DATA_CC(pDevIns, PVIRTIOSCSICC);
2338
2339#if 0 /* need more info about how to use this event. The VirtIO 1.0 specification
2340 * lists several SCSI related event types but presumes the reader knows
2341 * how to use them without providing references. */
2342 virtioScsiR3ReportMediaChange(pDevIns, pThis, pTarget->uTarget);
2343#endif
2344
2345 if (pThisCC->pMediaNotify)
2346 {
2347 int rc = VMR3ReqCallNoWait(PDMDevHlpGetVM(pDevIns), VMCPUID_ANY,
2348 (PFNRT)pThisCC->pMediaNotify->pfnEjected, 2,
2349 pThisCC->pMediaNotify, pTarget->uTarget);
2350 AssertRC(rc);
2351 }
2352}
2353
2354/**
2355 * @interface_method_impl{PDMIMEDIAEXPORT,pfnIoReqStateChanged}
2356 */
2357static DECLCALLBACK(void) virtioScsiR3IoReqStateChanged(PPDMIMEDIAEXPORT pInterface, PDMMEDIAEXIOREQ hIoReq,
2358 void *pvIoReqAlloc, PDMMEDIAEXIOREQSTATE enmState)
2359{
2360 PVIRTIOSCSITARGET pTarget = RT_FROM_MEMBER(pInterface, VIRTIOSCSITARGET, IMediaExPort);
2361 PPDMDEVINS pDevIns = pTarget->pDevIns;
2362 PVIRTIOSCSI pThis = PDMDEVINS_2_DATA(pDevIns, PVIRTIOSCSI);
2363 PVIRTIOSCSICC pThisCC = PDMDEVINS_2_DATA_CC(pDevIns, PVIRTIOSCSICC);
2364 RT_NOREF(hIoReq, pvIoReqAlloc);
2365
2366 switch (enmState)
2367 {
2368 case PDMMEDIAEXIOREQSTATE_SUSPENDED:
2369 {
2370 /* Stop considering this request active */
2371 if (!ASMAtomicDecU32(&pThis->cActiveReqs) && pThisCC->fQuiescing)
2372 PDMDevHlpAsyncNotificationCompleted(pDevIns);
2373 break;
2374 }
2375 case PDMMEDIAEXIOREQSTATE_ACTIVE:
2376 ASMAtomicIncU32(&pThis->cActiveReqs);
2377 break;
2378 default:
2379 AssertMsgFailed(("Invalid request state given %u\n", enmState));
2380 }
2381}
2382
2383/**
2384 * @interface_method_impl{PDMDEVREGR3,pfnDestruct}
2385 */
2386static DECLCALLBACK(int) virtioScsiR3Destruct(PPDMDEVINS pDevIns)
2387{
2388 PDMDEV_CHECK_VERSIONS_RETURN_QUIET(pDevIns);
2389 PVIRTIOSCSI pThis = PDMDEVINS_2_DATA(pDevIns, PVIRTIOSCSI);
2390 PVIRTIOSCSICC pThisCC = PDMDEVINS_2_DATA_CC(pDevIns, PVIRTIOSCSICC);
2391
2392 RTMemFree(pThisCC->paTargetInstances);
2393 pThisCC->paTargetInstances = NULL;
2394 pThisCC->pMediaNotify = NULL;
2395
2396 for (unsigned qIdx = 0; qIdx < VIRTIOSCSI_QUEUE_CNT; qIdx++)
2397 {
2398 PVIRTIOSCSIWORKER pWorker = &pThis->aWorkers[qIdx];
2399 if (pWorker->hEvtProcess != NIL_SUPSEMEVENT)
2400 {
2401 PDMDevHlpSUPSemEventClose(pDevIns, pWorker->hEvtProcess);
2402 pWorker->hEvtProcess = NIL_SUPSEMEVENT;
2403 }
2404
2405 if (pThisCC->aWorkers[qIdx].pThread)
2406 {
2407 /* Destroy the thread. */
2408 int rcThread;
2409 int rc = PDMDevHlpThreadDestroy(pDevIns, pThisCC->aWorkers[qIdx].pThread, &rcThread);
2410 if (RT_FAILURE(rc) || RT_FAILURE(rcThread))
2411 AssertMsgFailed(("%s Failed to destroythread rc=%Rrc rcThread=%Rrc\n",
2412 __FUNCTION__, rc, rcThread));
2413 pThisCC->aWorkers[qIdx].pThread = NULL;
2414 }
2415 }
2416
2417 virtioCoreR3Term(pDevIns, &pThis->Virtio, &pThisCC->Virtio);
2418 return VINF_SUCCESS;
2419}
2420
2421/**
2422 * @interface_method_impl{PDMDEVREGR3,pfnConstruct}
2423 */
2424static DECLCALLBACK(int) virtioScsiR3Construct(PPDMDEVINS pDevIns, int iInstance, PCFGMNODE pCfg)
2425{
2426 PDMDEV_CHECK_VERSIONS_RETURN(pDevIns);
2427 PVIRTIOSCSI pThis = PDMDEVINS_2_DATA(pDevIns, PVIRTIOSCSI);
2428 PVIRTIOSCSICC pThisCC = PDMDEVINS_2_DATA_CC(pDevIns, PVIRTIOSCSICC);
2429 PCPDMDEVHLPR3 pHlp = pDevIns->pHlpR3;
2430
2431 /*
2432 * Quick initialization of the state data, making sure that the destructor always works.
2433 */
2434 pThisCC->pDevIns = pDevIns;
2435
2436 LogFunc(("PDM device instance: %d\n", iInstance));
2437 RTStrPrintf(pThis->szInstance, sizeof(pThis->szInstance), "VIRTIOSCSI%d", iInstance);
2438
2439 pThisCC->IBase.pfnQueryInterface = virtioScsiR3DeviceQueryInterface;
2440 pThisCC->ILeds.pfnQueryStatusLed = virtioScsiR3DeviceQueryStatusLed;
2441
2442 /*
2443 * Validate and read configuration.
2444 */
2445 PDMDEV_VALIDATE_CONFIG_RETURN(pDevIns, "NumTargets|Bootable", "");
2446
2447 int rc = pHlp->pfnCFGMQueryU32Def(pCfg, "NumTargets", &pThis->cTargets, 1);
2448 if (RT_FAILURE(rc))
2449 return PDMDEV_SET_ERROR(pDevIns, rc, N_("virtio-scsi configuration error: failed to read NumTargets as integer"));
2450 if (pThis->cTargets < 1 || pThis->cTargets > VIRTIOSCSI_MAX_TARGETS)
2451 return PDMDevHlpVMSetError(pDevIns, rc, RT_SRC_POS,
2452 N_("virtio-scsi configuration error: NumTargets=%u is out of range (1..%u)"),
2453 pThis->cTargets, VIRTIOSCSI_MAX_TARGETS);
2454
2455 rc = pHlp->pfnCFGMQueryBoolDef(pCfg, "Bootable", &pThis->fBootable, true);
2456 if (RT_FAILURE(rc))
2457 return PDMDEV_SET_ERROR(pDevIns, rc, N_("virtio-scsi configuration error: failed to read Bootable as boolean"));
2458
2459 LogRel(("%s: Targets=%u Bootable=%RTbool (unimplemented) R0Enabled=%RTbool RCEnabled=%RTbool\n",
2460 pThis->szInstance, pThis->cTargets, pThis->fBootable, pDevIns->fR0Enabled, pDevIns->fRCEnabled));
2461
2462
2463 /*
2464 * Do core virtio initialization.
2465 */
2466
2467 /* Configure virtio_scsi_config that transacts via VirtIO implementation's Dev. Specific Cap callbacks */
2468 pThis->virtioScsiConfig.uNumQueues = VIRTIOSCSI_REQ_QUEUE_CNT;
2469 pThis->virtioScsiConfig.uSegMax = VIRTIOSCSI_MAX_SEG_COUNT;
2470 pThis->virtioScsiConfig.uMaxSectors = VIRTIOSCSI_MAX_SECTORS_HINT;
2471 pThis->virtioScsiConfig.uCmdPerLun = VIRTIOSCSI_MAX_COMMANDS_PER_LUN;
2472 pThis->virtioScsiConfig.uEventInfoSize = sizeof(VIRTIOSCSI_EVENT_T); /*VirtIO 1.0 Spec says at least this size! */
2473 pThis->virtioScsiConfig.uSenseSize = VIRTIOSCSI_SENSE_SIZE_DEFAULT;
2474 pThis->virtioScsiConfig.uCdbSize = VIRTIOSCSI_CDB_SIZE_DEFAULT;
2475 pThis->virtioScsiConfig.uMaxChannel = VIRTIOSCSI_MAX_CHANNEL_HINT;
2476 pThis->virtioScsiConfig.uMaxTarget = pThis->cTargets;
2477 pThis->virtioScsiConfig.uMaxLun = VIRTIOSCSI_MAX_LUN;
2478
2479 /* Initialize the generic Virtio core: */
2480 pThisCC->Virtio.pfnStatusChanged = virtioScsiR3StatusChanged;
2481 pThisCC->Virtio.pfnQueueNotified = virtioScsiR3Notified;
2482 pThisCC->Virtio.pfnDevCapRead = virtioScsiR3DevCapRead;
2483 pThisCC->Virtio.pfnDevCapWrite = virtioScsiR3DevCapWrite;
2484
2485 VIRTIOPCIPARAMS VirtioPciParams;
2486 VirtioPciParams.uDeviceId = PCI_DEVICE_ID_VIRTIOSCSI_HOST;
2487 VirtioPciParams.uClassBase = PCI_CLASS_BASE_MASS_STORAGE;
2488 VirtioPciParams.uClassSub = PCI_CLASS_SUB_SCSI_STORAGE_CONTROLLER;
2489 VirtioPciParams.uClassProg = PCI_CLASS_PROG_UNSPECIFIED;
2490 VirtioPciParams.uSubsystemId = PCI_DEVICE_ID_VIRTIOSCSI_HOST; /* VirtIO 1.0 spec allows PCI Device ID here */
2491 VirtioPciParams.uInterruptLine = 0x00;
2492 VirtioPciParams.uInterruptPin = 0x01;
2493
2494 rc = virtioCoreR3Init(pDevIns, &pThis->Virtio, &pThisCC->Virtio, &VirtioPciParams, pThis->szInstance,
2495 VIRTIOSCSI_HOST_SCSI_FEATURES_OFFERED,
2496 &pThis->virtioScsiConfig /*pvDevSpecificCap*/, sizeof(pThis->virtioScsiConfig));
2497 if (RT_FAILURE(rc))
2498 return PDMDEV_SET_ERROR(pDevIns, rc, N_("virtio-scsi: failed to initialize VirtIO"));
2499
2500 /*
2501 * Initialize queues.
2502 */
2503
2504 virtioScsiSetVirtqNames(pThis);
2505
2506 /* Attach the queues and create worker threads for them: */
2507 for (uint16_t qIdx = 0; qIdx < VIRTIOSCSI_QUEUE_CNT; qIdx++)
2508 {
2509 rc = virtioCoreR3QueueAttach(&pThis->Virtio, qIdx, VIRTQNAME(qIdx));
2510 if (RT_FAILURE(rc))
2511 continue;
2512 if (qIdx == CONTROLQ_IDX || IS_REQ_QUEUE(qIdx))
2513 {
2514 rc = PDMDevHlpThreadCreate(pDevIns, &pThisCC->aWorkers[qIdx].pThread,
2515 (void *)(uintptr_t)qIdx, virtioScsiR3WorkerThread,
2516 virtioScsiR3WorkerWakeUp, 0, RTTHREADTYPE_IO, VIRTQNAME(qIdx));
2517 if (rc != VINF_SUCCESS)
2518 {
2519 LogRel(("Error creating thread for Virtual Queue %s: %Rrc\n", VIRTQNAME(qIdx), rc));
2520 return rc;
2521 }
2522
2523 rc = PDMDevHlpSUPSemEventCreate(pDevIns, &pThis->aWorkers[qIdx].hEvtProcess);
2524 if (RT_FAILURE(rc))
2525 return PDMDevHlpVMSetError(pDevIns, rc, RT_SRC_POS,
2526 N_("DevVirtioSCSI: Failed to create SUP event semaphore"));
2527 }
2528 pThis->afQueueAttached[qIdx] = true;
2529 }
2530
2531 /*
2532 * Initialize per device instances (targets).
2533 */
2534 Log2Func(("Probing %d targets ...\n", pThis->cTargets));
2535
2536 pThisCC->paTargetInstances = (PVIRTIOSCSITARGET)RTMemAllocZ(sizeof(VIRTIOSCSITARGET) * pThis->cTargets);
2537 if (!pThisCC->paTargetInstances)
2538 return PDMDEV_SET_ERROR(pDevIns, rc, N_("Failed to allocate memory for target states"));
2539
2540 for (uint32_t uTarget = 0; uTarget < pThis->cTargets; uTarget++)
2541 {
2542 PVIRTIOSCSITARGET pTarget = &pThisCC->paTargetInstances[uTarget];
2543
2544 if (RTStrAPrintf(&pTarget->pszTargetName, "VSCSI%u", uTarget) < 0)
2545 AssertLogRelFailedReturn(VERR_NO_MEMORY);
2546
2547 /* Initialize static parts of the device. */
2548 pTarget->pDevIns = pDevIns;
2549 pTarget->uTarget = uTarget;
2550
2551 pTarget->IBase.pfnQueryInterface = virtioScsiR3TargetQueryInterface;
2552
2553 /* IMediaPort and IMediaExPort interfaces provide callbacks for VD media and downstream driver access */
2554 pTarget->IMediaPort.pfnQueryDeviceLocation = virtioScsiR3QueryDeviceLocation;
2555 pTarget->IMediaPort.pfnQueryScsiInqStrings = NULL;
2556 pTarget->IMediaExPort.pfnIoReqCompleteNotify = virtioScsiR3IoReqFinish;
2557 pTarget->IMediaExPort.pfnIoReqCopyFromBuf = virtioScsiR3IoReqCopyFromBuf;
2558 pTarget->IMediaExPort.pfnIoReqCopyToBuf = virtioScsiR3IoReqCopyToBuf;
2559 pTarget->IMediaExPort.pfnIoReqStateChanged = virtioScsiR3IoReqStateChanged;
2560 pTarget->IMediaExPort.pfnMediumEjected = virtioScsiR3MediumEjected;
2561 pTarget->IMediaExPort.pfnIoReqQueryBuf = NULL; /* When used avoids copyFromBuf CopyToBuf*/
2562 pTarget->IMediaExPort.pfnIoReqQueryDiscardRanges = NULL;
2563
2564 pTarget->IBase.pfnQueryInterface = virtioScsiR3TargetQueryInterface;
2565 pTarget->ILed.pfnQueryStatusLed = virtioScsiR3TargetQueryStatusLed;
2566 pTarget->led.u32Magic = PDMLED_MAGIC;
2567
2568 LogFunc(("Attaching LUN: %s\n", pTarget->pszTargetName));
2569
2570 AssertReturn(uTarget < pThis->cTargets, VERR_PDM_NO_SUCH_LUN);
2571 rc = PDMDevHlpDriverAttach(pDevIns, uTarget, &pTarget->IBase, &pTarget->pDrvBase, pTarget->pszTargetName);
2572 if (RT_SUCCESS(rc))
2573 {
2574 pTarget->fPresent = true;
2575
2576 pTarget->pDrvMedia = PDMIBASE_QUERY_INTERFACE(pTarget->pDrvBase, PDMIMEDIA);
2577 AssertMsgReturn(VALID_PTR(pTarget->pDrvMedia),
2578 ("virtio-scsi configuration error: LUN#%d missing basic media interface!\n", uTarget),
2579 VERR_PDM_MISSING_INTERFACE);
2580 /* Get the extended media interface. */
2581 pTarget->pDrvMediaEx = PDMIBASE_QUERY_INTERFACE(pTarget->pDrvBase, PDMIMEDIAEX);
2582 AssertMsgReturn(VALID_PTR(pTarget->pDrvMediaEx),
2583 ("virtio-scsi configuration error: LUN#%d missing extended media interface!\n", uTarget),
2584 VERR_PDM_MISSING_INTERFACE);
2585
2586 rc = pTarget->pDrvMediaEx->pfnIoReqAllocSizeSet(pTarget->pDrvMediaEx, sizeof(VIRTIOSCSIREQ));
2587 AssertMsgReturn(VALID_PTR(pTarget->pDrvMediaEx),
2588 ("virtio-scsi configuration error: LUN#%u: Failed to set I/O request size!\n", uTarget),
2589 rc);
2590 }
2591 else if (rc == VERR_PDM_NO_ATTACHED_DRIVER)
2592 {
2593 pTarget->fPresent = false;
2594 pTarget->pDrvBase = NULL;
2595 Log(("virtio-scsi: no driver attached to device %s\n", pTarget->pszTargetName));
2596 rc = VINF_SUCCESS;
2597 }
2598 else
2599 {
2600 AssertLogRelMsgFailed(("virtio-scsi: Failed to attach %s: %Rrc\n", pTarget->pszTargetName, rc));
2601 return rc;
2602 }
2603 }
2604
2605 /*
2606 * Status driver (optional).
2607 */
2608 PPDMIBASE pUpBase;
2609 AssertCompile(PDM_STATUS_LUN >= VIRTIOSCSI_MAX_TARGETS);
2610 rc = PDMDevHlpDriverAttach(pDevIns, PDM_STATUS_LUN, &pThisCC->IBase, &pUpBase, "Status Port");
2611 if (RT_FAILURE(rc) && rc != VERR_PDM_NO_ATTACHED_DRIVER)
2612 return PDMDEV_SET_ERROR(pDevIns, rc, N_("Failed to attach the status LUN"));
2613 pThisCC->pMediaNotify = PDMIBASE_QUERY_INTERFACE(pUpBase, PDMIMEDIANOTIFY);
2614
2615
2616 /*
2617 * Register saved state.
2618 */
2619 rc = PDMDevHlpSSMRegister(pDevIns, VIRTIOSCSI_SAVED_STATE_VERSION, sizeof(*pThis),
2620 virtioScsiR3SaveExec, virtioScsiR3LoadExec);
2621 AssertRCReturn(rc, rc);
2622
2623 /*
2624 * Register the debugger info callback (ignore errors).
2625 */
2626 char szTmp[128];
2627 RTStrPrintf(szTmp, sizeof(szTmp), "%s%u", pDevIns->pReg->szName, pDevIns->iInstance);
2628 PDMDevHlpDBGFInfoRegister(pDevIns, szTmp, "virtio-scsi info", virtioScsiR3Info);
2629
2630 return rc;
2631}
2632
2633#else /* !IN_RING3 */
2634
2635/**
2636 * @callback_method_impl{PDMDEVREGR0,pfnConstruct}
2637 */
2638static DECLCALLBACK(int) virtioScsiRZConstruct(PPDMDEVINS pDevIns)
2639{
2640 PDMDEV_CHECK_VERSIONS_RETURN(pDevIns);
2641 PVIRTIOSCSI pThis = PDMDEVINS_2_DATA(pDevIns, PVIRTIOSCSI);
2642 PVIRTIOSCSICC pThisCC = PDMDEVINS_2_DATA_CC(pDevIns, PVIRTIOSCSICC);
2643
2644 return virtioCoreRZInit(pDevIns, &pThis->Virtio, &pThisCC->Virtio);
2645}
2646
2647#endif /* !IN_RING3 */
2648
2649
2650/**
2651 * The device registration structure.
2652 */
2653const PDMDEVREG g_DeviceVirtioSCSI =
2654{
2655 /* .u32Version = */ PDM_DEVREG_VERSION,
2656 /* .uReserved0 = */ 0,
2657 /* .szName = */ "virtio-scsi",
2658 /* .fFlags = */ PDM_DEVREG_FLAGS_DEFAULT_BITS | PDM_DEVREG_FLAGS_RZ | PDM_DEVREG_FLAGS_NEW_STYLE
2659 | PDM_DEVREG_FLAGS_FIRST_SUSPEND_NOTIFICATION
2660 | PDM_DEVREG_FLAGS_FIRST_POWEROFF_NOTIFICATION,
2661 /* .fClass = */ PDM_DEVREG_CLASS_STORAGE,
2662 /* .cMaxInstances = */ ~0U,
2663 /* .uSharedVersion = */ 42,
2664 /* .cbInstanceShared = */ sizeof(VIRTIOSCSI),
2665 /* .cbInstanceCC = */ sizeof(VIRTIOSCSICC),
2666 /* .cbInstanceRC = */ sizeof(VIRTIOSCSIRC),
2667 /* .cMaxPciDevices = */ 1,
2668 /* .cMaxMsixVectors = */ VBOX_MSIX_MAX_ENTRIES,
2669 /* .pszDescription = */ "Virtio Host SCSI.\n",
2670#if defined(IN_RING3)
2671 /* .pszRCMod = */ "VBoxDDRC.rc",
2672 /* .pszR0Mod = */ "VBoxDDR0.r0",
2673 /* .pfnConstruct = */ virtioScsiR3Construct,
2674 /* .pfnDestruct = */ virtioScsiR3Destruct,
2675 /* .pfnRelocate = */ NULL,
2676 /* .pfnMemSetup = */ NULL,
2677 /* .pfnPowerOn = */ NULL,
2678 /* .pfnReset = */ virtioScsiR3Reset,
2679 /* .pfnSuspend = */ virtioScsiR3Suspend,
2680 /* .pfnResume = */ virtioScsiR3Resume,
2681 /* .pfnAttach = */ virtioScsiR3Attach,
2682 /* .pfnDetach = */ virtioScsiR3Detach,
2683 /* .pfnQueryInterface = */ NULL,
2684 /* .pfnInitComplete = */ NULL,
2685 /* .pfnPowerOff = */ virtioScsiR3PowerOff,
2686 /* .pfnSoftReset = */ NULL,
2687 /* .pfnReserved0 = */ NULL,
2688 /* .pfnReserved1 = */ NULL,
2689 /* .pfnReserved2 = */ NULL,
2690 /* .pfnReserved3 = */ NULL,
2691 /* .pfnReserved4 = */ NULL,
2692 /* .pfnReserved5 = */ NULL,
2693 /* .pfnReserved6 = */ NULL,
2694 /* .pfnReserved7 = */ NULL,
2695#elif defined(IN_RING0)
2696 /* .pfnEarlyConstruct = */ NULL,
2697 /* .pfnConstruct = */ virtioScsiRZConstruct,
2698 /* .pfnDestruct = */ NULL,
2699 /* .pfnFinalDestruct = */ NULL,
2700 /* .pfnRequest = */ NULL,
2701 /* .pfnReserved0 = */ NULL,
2702 /* .pfnReserved1 = */ NULL,
2703 /* .pfnReserved2 = */ NULL,
2704 /* .pfnReserved3 = */ NULL,
2705 /* .pfnReserved4 = */ NULL,
2706 /* .pfnReserved5 = */ NULL,
2707 /* .pfnReserved6 = */ NULL,
2708 /* .pfnReserved7 = */ NULL,
2709#elif defined(IN_RC)
2710 /* .pfnConstruct = */ virtioScsiRZConstruct,
2711 /* .pfnReserved0 = */ NULL,
2712 /* .pfnReserved1 = */ NULL,
2713 /* .pfnReserved2 = */ NULL,
2714 /* .pfnReserved3 = */ NULL,
2715 /* .pfnReserved4 = */ NULL,
2716 /* .pfnReserved5 = */ NULL,
2717 /* .pfnReserved6 = */ NULL,
2718 /* .pfnReserved7 = */ NULL,
2719#else
2720# error "Not in IN_RING3, IN_RING0 or IN_RC!"
2721#endif
2722 /* .u32VersionEnd = */ PDM_DEVREG_VERSION
2723};
2724
Note: See TracBrowser for help on using the repository browser.

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