VirtualBox

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

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

DevVirtioSCSI.cpp: Eliminated unnecessary memory allocations in virtioScsiR3Ctrl, fixing the reference to fSupportedEvents after it went out of scope. 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 83571 2020-04-05 21:53:37Z vboxsync $ $Revision: 83571 $ $Date: 2020-04-05 21:53:37 +0000 (Sun, 05 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 scsiCtrl;
313 VIRTIOSCSI_CTRL_TMF_T scsiCtrlTmf;
314 VIRTIOSCSI_CTRL_AN_T scsiCtrlAsyncNotify;
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 VIRTIOSCSI_EVENT_T event;
668 event.uEvent = uEventType;
669 event.uReason = uReason;
670 event.abVirtioLun[0] = 1;
671 event.abVirtioLun[1] = uTarget;
672 event.abVirtioLun[2] = (LUN0 >> 8) & 0x40;
673 event.abVirtioLun[3] = LUN0 & 0xff;
674 event.abVirtioLun[4] = event.abVirtioLun[5] = event.abVirtioLun[6] = event.abVirtioLun[7] = 0;
675
676 switch (uEventType)
677 {
678 case VIRTIOSCSI_T_NO_EVENT:
679 Log6Func(("(target=%d, LUN=%d): Warning event info guest queued is shorter than configured\n", uTarget, LUN0));
680 break;
681 case VIRTIOSCSI_T_NO_EVENT | VIRTIOSCSI_T_EVENTS_MISSED:
682 Log6Func(("(target=%d, LUN=%d): Warning driver that events were missed\n", uTarget, LUN0));
683 break;
684 case VIRTIOSCSI_T_TRANSPORT_RESET:
685 switch (uReason)
686 {
687 case VIRTIOSCSI_EVT_RESET_REMOVED:
688 Log6Func(("(target=%d, LUN=%d): Target or LUN removed\n", uTarget, LUN0));
689 break;
690 case VIRTIOSCSI_EVT_RESET_RESCAN:
691 Log6Func(("(target=%d, LUN=%d): Target or LUN added\n", uTarget, LUN0));
692 break;
693 case VIRTIOSCSI_EVT_RESET_HARD:
694 Log6Func(("(target=%d, LUN=%d): Target was reset\n", uTarget, LUN0));
695 break;
696 }
697 break;
698 case VIRTIOSCSI_T_ASYNC_NOTIFY:
699 {
700#ifdef LOG_ENABLED
701 char szTypeText[128];
702 virtioGetControlAsyncMaskText(szTypeText, sizeof(szTypeText), uReason);
703 Log6Func(("(target=%d, LUN=%d): Delivering subscribed async notification %s\n", uTarget, LUN0, szTypeText));
704#endif
705 break;
706 }
707 case VIRTIOSCSI_T_PARAM_CHANGE:
708 LogFunc(("(target=%d, LUN=%d): PARAM_CHANGE sense code: 0x%x sense qualifier: 0x%x\n",
709 uTarget, LUN0, uReason & 0xff, (uReason >> 8) & 0xff));
710 break;
711 default:
712 Log6Func(("(target=%d, LUN=%d): Unknown event type: %d, ignoring\n", uTarget, LUN0, uEventType));
713 return VINF_SUCCESS;
714 }
715
716 if (virtioCoreQueueIsEmpty(pDevIns, &pThis->Virtio, EVENTQ_IDX))
717 {
718 LogFunc(("eventq is empty, events missed (driver didn't preload queue)!\n"));
719 ASMAtomicWriteBool(&pThis->fEventsMissed, true);
720 return VINF_SUCCESS;
721 }
722
723 PVIRTIO_DESC_CHAIN_T pDescChain;
724 virtioCoreR3QueueGet(pDevIns, &pThis->Virtio, EVENTQ_IDX, &pDescChain, true);
725
726 PRTSGBUF pReqSegBuf = (PRTSGBUF)RTMemAllocZ(sizeof(RTSGBUF));
727 AssertReturn(pReqSegBuf, VERR_NO_MEMORY);
728
729 PRTSGSEG paReqSegs = (PRTSGSEG)RTMemAllocZ(sizeof(RTSGSEG) * 2);
730 AssertReturn(paReqSegs, VERR_NO_MEMORY);
731
732 /* Copy segment data to malloc'd memory to avoid stack out-of-scope errors sanitizer doesn't detect */
733 paReqSegs[0].pvSeg = RTMemAlloc(sizeof(event));
734 AssertReturn(paReqSegs[0].pvSeg, VERR_NO_MEMORY);
735 memcpy(paReqSegs[0].pvSeg, &event, sizeof(event));
736
737 RTSgBufInit(pReqSegBuf, paReqSegs, 1);
738
739 virtioCoreR3QueuePut(pDevIns, &pThis->Virtio, EVENTQ_IDX, pReqSegBuf, pDescChain, true /*fFence*/);
740 virtioCoreQueueSync(pDevIns, &pThis->Virtio, EVENTQ_IDX);
741
742 RTMemFree(paReqSegs[0].pvSeg);
743 RTMemFree(paReqSegs);
744 RTMemFree(pReqSegBuf);
745
746 return VINF_SUCCESS;
747}
748
749/** Internal worker. */
750static void virtioScsiR3FreeReq(PVIRTIOSCSITARGET pTarget, PVIRTIOSCSIREQ pReq)
751{
752 RTMemFree(pReq->pbSense);
753 pReq->pbSense = NULL;
754 pTarget->pDrvMediaEx->pfnIoReqFree(pTarget->pDrvMediaEx, pReq->hIoReq);
755}
756
757/**
758 * This is called to complete a request immediately
759 *
760 * @param pDevIns The device instance.
761 * @param pThis VirtIO SCSI shared instance data.
762 * @param pThisCC VirtIO SCSI ring-3 instance data.
763 * @param qIdx Queue index
764 * @param pDescChain Pointer to pre-processed descriptor chain pulled from virtq
765 * @param pRespHdr Response header
766 * @param pbSense Pointer to sense buffer or NULL if none.
767 * @param cbSenseCfg The configured sense buffer size.
768 *
769 * @returns VINF_SUCCESS
770 */
771static int virtioScsiR3ReqErr(PPDMDEVINS pDevIns, PVIRTIOSCSI pThis, PVIRTIOSCSICC pThisCC, uint16_t qIdx,
772 PVIRTIO_DESC_CHAIN_T pDescChain, REQ_RESP_HDR_T *pRespHdr, uint8_t *pbSense,
773 uint32_t cbSenseCfg)
774{
775 Log2Func((" status: %s response: %s\n",
776 SCSIStatusText(pRespHdr->uStatus), virtioGetReqRespText(pRespHdr->uResponse)));
777
778 RTSGSEG aReqSegs[2];
779
780 /* Segment #1: Request header*/
781 aReqSegs[0].pvSeg = pRespHdr;
782 aReqSegs[0].cbSeg = sizeof(*pRespHdr);
783
784 /* Segment #2: Sense data. */
785 uint8_t abSenseBuf[VIRTIOSCSI_SENSE_SIZE_MAX];
786 AssertCompile(VIRTIOSCSI_SENSE_SIZE_MAX <= 4096);
787 Assert(cbSenseCfg <= sizeof(abSenseBuf));
788
789 RT_ZERO(abSenseBuf);
790 if (pbSense && pRespHdr->cbSenseLen)
791 memcpy(abSenseBuf, pbSense, RT_MIN(pRespHdr->cbSenseLen, sizeof(abSenseBuf)));
792 else
793 pRespHdr->cbSenseLen = 0;
794
795 aReqSegs[1].pvSeg = abSenseBuf;
796 aReqSegs[1].cbSeg = cbSenseCfg;
797
798 /* Init S/G buffer. */
799 RTSGBUF ReqSgBuf;
800 RTSgBufInit(&ReqSgBuf, aReqSegs, RT_ELEMENTS(aReqSegs));
801
802 if (pThis->fResetting)
803 pRespHdr->uResponse = VIRTIOSCSI_S_RESET;
804
805 virtioCoreR3QueuePut(pDevIns, &pThis->Virtio, qIdx, &ReqSgBuf, pDescChain, true /* fFence */);
806 virtioCoreQueueSync(pDevIns, &pThis->Virtio, qIdx);
807
808 if (!ASMAtomicDecU32(&pThis->cActiveReqs) && pThisCC->fQuiescing)
809 PDMDevHlpAsyncNotificationCompleted(pDevIns);
810
811 Log2(("---------------------------------------------------------------------------------\n"));
812
813 return VINF_SUCCESS;
814}
815
816
817/**
818 * Variant of virtioScsiR3ReqErr that takes four (4) REQ_RESP_HDR_T member
819 * fields rather than a pointer to an initialized structure.
820 *
821 * @param pDevIns The device instance.
822 * @param pThis VirtIO SCSI shared instance data.
823 * @param pThisCC VirtIO SCSI ring-3 instance data.
824 * @param qIdx Queue index
825 * @param pDescChain Pointer to pre-processed descriptor chain pulled from virtq
826 * @param pRespHdr Response header
827 * @param cbResidual The number of residual bytes or something like that.
828 * @param bStatus The SCSI status code.
829 * @param bResponse The virtio SCSI response code.
830 * @param pbSense Pointer to sense buffer or NULL if none.
831 * @param cbSense The number of bytes of sense data. Zero if none.
832 * @param cbSenseCfg The configured sense buffer size.
833 *
834 * @returns VINF_SUCCESS
835 */
836static int virtioScsiR3ReqErr4(PPDMDEVINS pDevIns, PVIRTIOSCSI pThis, PVIRTIOSCSICC pThisCC, uint16_t qIdx,
837 PVIRTIO_DESC_CHAIN_T pDescChain, uint32_t cbResidual, uint8_t bStatus, uint8_t bResponse,
838 uint8_t *pbSense, uint32_t cbSense, uint32_t cbSenseCfg)
839{
840 REQ_RESP_HDR_T RespHdr;
841 RespHdr.cbSenseLen = cbSense;
842 RespHdr.uResidual = cbResidual;
843 RespHdr.uStatusQualifier = 0;
844 RespHdr.uStatus = bStatus;
845 RespHdr.uResponse = bResponse;
846
847 return virtioScsiR3ReqErr(pDevIns, pThis, pThisCC, qIdx, pDescChain, &RespHdr, pbSense, cbSenseCfg);
848}
849
850static void virtioScsiR3SenseKeyToVirtioResp(REQ_RESP_HDR_T *respHdr, uint8_t uSenseKey)
851{
852 switch (uSenseKey)
853 {
854 case SCSI_SENSE_ABORTED_COMMAND:
855 respHdr->uResponse = VIRTIOSCSI_S_ABORTED;
856 break;
857 case SCSI_SENSE_COPY_ABORTED:
858 respHdr->uResponse = VIRTIOSCSI_S_ABORTED;
859 break;
860 case SCSI_SENSE_UNIT_ATTENTION:
861 respHdr->uResponse = VIRTIOSCSI_S_TARGET_FAILURE;
862 break;
863 case SCSI_SENSE_HARDWARE_ERROR:
864 respHdr->uResponse = VIRTIOSCSI_S_TARGET_FAILURE;
865 break;
866 case SCSI_SENSE_NOT_READY:
867 /* Not sure what to return for this. See choices at VirtIO 1.0, 5.6.6.1.1 */
868 respHdr->uResponse = VIRTIOSCSI_S_FAILURE;
869 /* respHdr->uResponse = VIRTIOSCSI_S_BUSY; */ /* BUSY is VirtIO's 'retryable' response */
870 break;
871 default:
872 respHdr->uResponse = VIRTIOSCSI_S_FAILURE;
873 break;
874 }
875}
876
877/**
878 * @interface_method_impl{PDMIMEDIAEXPORT,pfnIoReqCompleteNotify}
879 */
880static DECLCALLBACK(int) virtioScsiR3IoReqFinish(PPDMIMEDIAEXPORT pInterface, PDMMEDIAEXIOREQ hIoReq,
881 void *pvIoReqAlloc, int rcReq)
882{
883 PVIRTIOSCSITARGET pTarget = RT_FROM_MEMBER(pInterface, VIRTIOSCSITARGET, IMediaExPort);
884 PPDMDEVINS pDevIns = pTarget->pDevIns;
885 PVIRTIOSCSI pThis = PDMDEVINS_2_DATA(pDevIns, PVIRTIOSCSI);
886 PVIRTIOSCSICC pThisCC = PDMDEVINS_2_DATA_CC(pDevIns, PVIRTIOSCSICC);
887 PPDMIMEDIAEX pIMediaEx = pTarget->pDrvMediaEx;
888 PVIRTIOSCSIREQ pReq = (PVIRTIOSCSIREQ)pvIoReqAlloc;
889
890 size_t cbResidual = 0;
891 int rc = pIMediaEx->pfnIoReqQueryResidual(pIMediaEx, hIoReq, &cbResidual);
892 AssertRC(rc);
893
894 size_t cbXfer = 0;
895 rc = pIMediaEx->pfnIoReqQueryXferSize(pIMediaEx, hIoReq, &cbXfer);
896 AssertRC(rc);
897
898 /* Masking deals with data type size discrepancies between
899 * The APIs (virtio and VBox). Windows C-compiler complains otherwise */
900 Assert(!(cbXfer & 0xffffffff00000000));
901 uint32_t cbXfer32 = cbXfer & 0xffffffff;
902 REQ_RESP_HDR_T respHdr = { 0 };
903 respHdr.cbSenseLen = pReq->pbSense[2] == SCSI_SENSE_NONE ? 0 : (uint32_t)pReq->cbSenseLen;
904 AssertMsg(!(cbResidual & 0xffffffff00000000),
905 ("WARNING: Residual size larger than sizeof(uint32_t), truncating"));
906 respHdr.uResidual = (uint32_t)(cbResidual & 0xffffffff);
907 respHdr.uStatus = pReq->uStatus;
908
909 /* VirtIO 1.0 spec 5.6.6.1.1 says device MUST return a VirtIO response byte value.
910 * Some are returned during the submit phase, and a few are not mapped at all,
911 * wherein anything that can't map specifically gets mapped to VIRTIOSCSI_S_FAILURE
912 */
913 if (pThis->fResetting)
914 respHdr.uResponse = VIRTIOSCSI_S_RESET;
915 else
916 {
917 switch (rcReq)
918 {
919 case SCSI_STATUS_OK:
920 {
921 if (pReq->uStatus != SCSI_STATUS_CHECK_CONDITION)
922 respHdr.uResponse = VIRTIOSCSI_S_OK;
923 else
924 virtioScsiR3SenseKeyToVirtioResp(&respHdr, pReq->pbSense[2]);
925 break;
926 }
927 case SCSI_STATUS_CHECK_CONDITION:
928 virtioScsiR3SenseKeyToVirtioResp(&respHdr, pReq->pbSense[2]);
929 break;
930
931 default:
932 respHdr.uResponse = VIRTIOSCSI_S_FAILURE;
933 break;
934 }
935 }
936
937 Log2Func(("status: (%d) %s, response: (%d) %s\n", pReq->uStatus, SCSIStatusText(pReq->uStatus),
938 respHdr.uResponse, virtioGetReqRespText(respHdr.uResponse)));
939
940 if (RT_FAILURE(rcReq))
941 Log2Func(("rcReq: %s\n", RTErrGetDefine(rcReq)));
942
943 if (LogIs3Enabled())
944 {
945 LogFunc(("cbDataIn = %u, cbDataOut = %u (cbIn = %u, cbOut = %u)\n",
946 pReq->cbDataIn, pReq->cbDataOut, pReq->pDescChain->cbPhysReturn, pReq->pDescChain->cbPhysSend));
947 LogFunc(("xfer = %lu, residual = %u\n", cbXfer, cbResidual));
948 LogFunc(("xfer direction: %s, sense written = %d, sense size = %d\n",
949 virtioGetTxDirText(pReq->enmTxDir), respHdr.cbSenseLen, pThis->virtioScsiConfig.uSenseSize));
950 }
951
952 if (respHdr.cbSenseLen && LogIs2Enabled())
953 {
954 LogFunc(("Sense: %s\n", SCSISenseText(pReq->pbSense[2])));
955 LogFunc(("Sense Ext3: %s\n", SCSISenseExtText(pReq->pbSense[12], pReq->pbSense[13])));
956 }
957
958 if ( (VIRTIO_IS_IN_DIRECTION(pReq->enmTxDir) && cbXfer32 > pReq->cbDataIn)
959 || (VIRTIO_IS_OUT_DIRECTION(pReq->enmTxDir) && cbXfer32 > pReq->cbDataOut))
960 {
961 Log2Func((" * * * * Data overrun, returning sense\n"));
962 uint8_t abSense[] = { RT_BIT(7) | SCSI_SENSE_RESPONSE_CODE_CURR_FIXED,
963 0, SCSI_SENSE_ILLEGAL_REQUEST, 0, 0, 0, 0, 10, 0, 0, 0 };
964 respHdr.cbSenseLen = sizeof(abSense);
965 respHdr.uStatus = SCSI_STATUS_CHECK_CONDITION;
966 respHdr.uResponse = VIRTIOSCSI_S_OVERRUN;
967 respHdr.uResidual = pReq->cbDataIn;
968
969 virtioScsiR3ReqErr(pDevIns, pThis, pThisCC, pReq->qIdx, pReq->pDescChain, &respHdr, abSense,
970 RT_MIN(pThis->virtioScsiConfig.uSenseSize, VIRTIOSCSI_SENSE_SIZE_MAX));
971 }
972 else
973 {
974 Assert(pReq->pbSense != NULL);
975
976 /* req datain bytes already in guest phys mem. via virtioScsiIoReqCopyFromBuf() */
977 RTSGSEG aReqSegs[2];
978
979 aReqSegs[0].pvSeg = &respHdr;
980 aReqSegs[0].cbSeg = sizeof(respHdr);
981
982 aReqSegs[1].pvSeg = pReq->pbSense;
983 aReqSegs[1].cbSeg = pReq->cbSenseAlloc; /* VirtIO 1.0 spec 5.6.4/5.6.6.1 */
984
985 RTSGBUF ReqSgBuf;
986 RTSgBufInit(&ReqSgBuf, aReqSegs, RT_ELEMENTS(aReqSegs));
987
988 size_t cbReqSgBuf = RTSgBufCalcTotalLength(&ReqSgBuf);
989 /** @todo r=bird: Returning here looks a little bogus... */
990 AssertMsgReturn(cbReqSgBuf <= pReq->pDescChain->cbPhysReturn,
991 ("Guest expected less req data (space needed: %zu, avail: %u)\n",
992 cbReqSgBuf, pReq->pDescChain->cbPhysReturn),
993 VERR_BUFFER_OVERFLOW);
994
995 virtioCoreR3QueuePut(pDevIns, &pThis->Virtio, pReq->qIdx, &ReqSgBuf, pReq->pDescChain, true /* fFence TBD */);
996 virtioCoreQueueSync(pDevIns, &pThis->Virtio, pReq->qIdx);
997
998 Log2(("-----------------------------------------------------------------------------------------\n"));
999 }
1000
1001 virtioScsiR3FreeReq(pTarget, pReq);
1002
1003 if (!ASMAtomicDecU32(&pThis->cActiveReqs) && pThisCC->fQuiescing)
1004 PDMDevHlpAsyncNotificationCompleted(pDevIns);
1005
1006 return rc;
1007}
1008
1009/**
1010 * @interface_method_impl{PDMIMEDIAEXPORT,pfnIoReqCopyFromBuf}
1011 *
1012 * Copy virtual memory from VSCSI layer to guest physical memory
1013 */
1014static DECLCALLBACK(int) virtioScsiR3IoReqCopyFromBuf(PPDMIMEDIAEXPORT pInterface, PDMMEDIAEXIOREQ hIoReq,
1015 void *pvIoReqAlloc, uint32_t offDst, PRTSGBUF pSgBuf, size_t cbCopy)
1016{
1017 PVIRTIOSCSITARGET pTarget = RT_FROM_MEMBER(pInterface, VIRTIOSCSITARGET, IMediaExPort);
1018 PPDMDEVINS pDevIns = pTarget->pDevIns;
1019 PVIRTIOSCSIREQ pReq = (PVIRTIOSCSIREQ)pvIoReqAlloc;
1020 RT_NOREF(hIoReq, cbCopy);
1021
1022 if (!pReq->cbDataIn)
1023 return VINF_SUCCESS;
1024
1025 AssertReturn(pReq->pDescChain, VERR_INVALID_PARAMETER);
1026
1027 PVIRTIOSGBUF pSgPhysReturn = pReq->pDescChain->pSgPhysReturn;
1028 virtioCoreSgBufAdvance(pSgPhysReturn, offDst);
1029
1030 size_t cbCopied = 0;
1031 size_t cbRemain = pReq->cbDataIn;
1032
1033 if (!pSgPhysReturn->idxSeg && pSgPhysReturn->cbSegLeft == pSgPhysReturn->paSegs[0].cbSeg)
1034 virtioCoreSgBufAdvance(pSgPhysReturn, pReq->uDataInOff);
1035
1036 while (cbRemain)
1037 {
1038 PVIRTIOSGSEG paSeg = &pSgPhysReturn->paSegs[pSgPhysReturn->idxSeg];
1039 uint64_t dstSgStart = (uint64_t)paSeg->gcPhys;
1040 uint64_t dstSgLen = (uint64_t)paSeg->cbSeg;
1041 uint64_t dstSgCur = (uint64_t)pSgPhysReturn->gcPhysCur;
1042 cbCopied = RT_MIN((uint64_t)pSgBuf->cbSegLeft, dstSgLen - (dstSgCur - dstSgStart));
1043 PDMDevHlpPCIPhysWrite(pDevIns, (RTGCPHYS)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 paSeg = &pSgPhysSend->paSegs[pSgPhysSend->idxSeg];
1080 uint64_t srcSgStart = (uint64_t)paSeg->gcPhys;
1081 uint64_t srcSgLen = (uint64_t)paSeg->cbSeg;
1082 uint64_t srcSgCur = (uint64_t)pSgPhysSend->gcPhysCur;
1083 cbCopied = RT_MIN((uint64_t)pSgBuf->cbSegLeft, srcSgLen - (srcSgCur - srcSgStart));
1084 PDMDevHlpPCIPhysRead(pDevIns,
1085 (RTGCPHYS)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 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.scsiCtrl.uType == VIRTIOSCSI_T_TMF
1340 && pDescChain->cbPhysSend >= sizeof(VIRTIOSCSI_CTRL_TMF_T))
1341 || ( ( ScsiCtrlUnion.scsiCtrl.uType == VIRTIOSCSI_T_AN_QUERY
1342 || ScsiCtrlUnion.scsiCtrl.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.scsiCtrl.uType)
1354 {
1355 case VIRTIOSCSI_T_TMF: /* Task Management Functions */
1356 {
1357 uint8_t uTarget = ScsiCtrlUnion.scsiCtrlTmf.abScsiLun[1];
1358 uint32_t uScsiLun = RT_MAKE_U16(ScsiCtrlUnion.scsiCtrlTmf.abScsiLun[3],
1359 ScsiCtrlUnion.scsiCtrlTmf.abScsiLun[2]) & 0x3fff;
1360 Log2Func(("[%s] (Target: %d LUN: %d) Task Mgt Function: %s\n",
1361 VIRTQNAME(qIdx), uTarget, uScsiLun, virtioGetTMFTypeText(ScsiCtrlUnion.scsiCtrlTmf.uSubtype)));
1362
1363 if (uTarget >= pThis->cTargets || !pThisCC->paTargetInstances[uTarget].fPresent)
1364 bResponse = VIRTIOSCSI_S_BAD_TARGET;
1365 else
1366 if (uScsiLun != 0)
1367 bResponse = VIRTIOSCSI_S_INCORRECT_LUN;
1368 else
1369 switch (ScsiCtrlUnion.scsiCtrlTmf.uSubtype)
1370 {
1371 case VIRTIOSCSI_T_TMF_ABORT_TASK:
1372 bResponse = VIRTIOSCSI_S_FUNCTION_SUCCEEDED;
1373 break;
1374 case VIRTIOSCSI_T_TMF_ABORT_TASK_SET:
1375 bResponse = VIRTIOSCSI_S_FUNCTION_SUCCEEDED;
1376 break;
1377 case VIRTIOSCSI_T_TMF_CLEAR_ACA:
1378 bResponse = VIRTIOSCSI_S_FUNCTION_SUCCEEDED;
1379 break;
1380 case VIRTIOSCSI_T_TMF_CLEAR_TASK_SET:
1381 bResponse = VIRTIOSCSI_S_FUNCTION_SUCCEEDED;
1382 break;
1383 case VIRTIOSCSI_T_TMF_I_T_NEXUS_RESET:
1384 bResponse = VIRTIOSCSI_S_FUNCTION_SUCCEEDED;
1385 break;
1386 case VIRTIOSCSI_T_TMF_LOGICAL_UNIT_RESET:
1387 bResponse = VIRTIOSCSI_S_FUNCTION_SUCCEEDED;
1388 break;
1389 case VIRTIOSCSI_T_TMF_QUERY_TASK:
1390 bResponse = VIRTIOSCSI_S_FUNCTION_REJECTED;
1391 break;
1392 case VIRTIOSCSI_T_TMF_QUERY_TASK_SET:
1393 bResponse = VIRTIOSCSI_S_FUNCTION_REJECTED;
1394 break;
1395 default:
1396 LogFunc(("Unknown TMF type\n"));
1397 bResponse = VIRTIOSCSI_S_FAILURE;
1398 }
1399 cSegs = 0; /* only bResponse */
1400 break;
1401 }
1402 case VIRTIOSCSI_T_AN_QUERY: /* Guest SCSI driver is querying supported async event notifications */
1403 {
1404 PVIRTIOSCSI_CTRL_AN_T const pScsiCtrlAnQuery = &ScsiCtrlUnion.scsiCtrlAsyncNotify;
1405
1406 uint8_t uTarget = pScsiCtrlAnQuery->abScsiLun[1];
1407 uint32_t uScsiLun = RT_MAKE_U16(pScsiCtrlAnQuery->abScsiLun[3], pScsiCtrlAnQuery->abScsiLun[2]) & 0x3fff;
1408
1409 if (uTarget >= pThis->cTargets || !pThisCC->paTargetInstances[uTarget].fPresent)
1410 bResponse = VIRTIOSCSI_S_BAD_TARGET;
1411 else
1412 if (uScsiLun != 0)
1413 bResponse = VIRTIOSCSI_S_INCORRECT_LUN;
1414 else
1415 bResponse = VIRTIOSCSI_S_FUNCTION_COMPLETE;
1416
1417#ifdef LOG_ENABLED
1418 if (LogIs2Enabled())
1419 {
1420 char szTypeText[128];
1421 virtioGetControlAsyncMaskText(szTypeText, sizeof(szTypeText), pScsiCtrlAnQuery->fEventsRequested);
1422 Log2Func(("[%s] (Target: %d LUN: %d) Async. Notification Query: %s\n",
1423 VIRTQNAME(qIdx), uTarget, uScsiLun, szTypeText));
1424 }
1425#endif
1426 uData.fSupportedEvents = SUPPORTED_EVENTS;
1427 aReqSegs[0].pvSeg = &uData.fSupportedEvents;
1428 aReqSegs[0].cbSeg = sizeof(uData.fSupportedEvents);
1429 cSegs = 1;
1430 break;
1431 }
1432 case VIRTIOSCSI_T_AN_SUBSCRIBE: /* Guest SCSI driver is subscribing to async event notification(s) */
1433 {
1434 PVIRTIOSCSI_CTRL_AN_T const pScsiCtrlAnSubscribe = &ScsiCtrlUnion.scsiCtrlAsyncNotify;
1435
1436 if (pScsiCtrlAnSubscribe->fEventsRequested & ~SUBSCRIBABLE_EVENTS)
1437 LogFunc(("Unsupported bits in event subscription event mask: %#x\n",
1438 pScsiCtrlAnSubscribe->fEventsRequested));
1439
1440 uint8_t uTarget = pScsiCtrlAnSubscribe->abScsiLun[1];
1441 uint32_t uScsiLun = RT_MAKE_U16(pScsiCtrlAnSubscribe->abScsiLun[3], pScsiCtrlAnSubscribe->abScsiLun[2]) & 0x3fff;
1442
1443#ifdef LOG_ENABLED
1444 if (LogIs2Enabled())
1445 {
1446 char szTypeText[128];
1447 virtioGetControlAsyncMaskText(szTypeText, sizeof(szTypeText), pScsiCtrlAnSubscribe->fEventsRequested);
1448 Log2Func(("[%s] (Target: %d LUN: %d) Async. Notification Subscribe: %s\n",
1449 VIRTQNAME(qIdx), uTarget, uScsiLun, szTypeText));
1450 }
1451#endif
1452 if (uTarget >= pThis->cTargets || !pThisCC->paTargetInstances[uTarget].fPresent)
1453 bResponse = VIRTIOSCSI_S_BAD_TARGET;
1454 else
1455 if (uScsiLun != 0)
1456 bResponse = VIRTIOSCSI_S_INCORRECT_LUN;
1457 else
1458 {
1459 bResponse = VIRTIOSCSI_S_FUNCTION_SUCCEEDED; /* or VIRTIOSCSI_S_FUNCTION_COMPLETE? */
1460 pThis->fAsyncEvtsEnabled = SUPPORTED_EVENTS & pScsiCtrlAnSubscribe->fEventsRequested;
1461 }
1462
1463 aReqSegs[0].pvSeg = &pThis->fAsyncEvtsEnabled;
1464 aReqSegs[0].cbSeg = sizeof(pThis->fAsyncEvtsEnabled);
1465 cSegs = 1;
1466 break;
1467 }
1468 default:
1469 {
1470 LogFunc(("Unknown control type extracted from %s: %u\n", VIRTQNAME(qIdx), ScsiCtrlUnion.scsiCtrl.uType));
1471
1472 bResponse = VIRTIOSCSI_S_FAILURE;
1473 cSegs = 0; /* only bResponse */
1474 break;
1475 }
1476 }
1477
1478 /* Add the response code: */
1479 aReqSegs[cSegs].pvSeg = &bResponse;
1480 aReqSegs[cSegs].cbSeg = sizeof(bResponse);
1481 cSegs++;
1482 Assert(cSegs <= RT_ELEMENTS(aReqSegs));
1483
1484 LogFunc(("Response code: %s\n", virtioGetReqRespText(bResponse)));
1485
1486 RTSGBUF ReqSgBuf;
1487 RTSgBufInit(&ReqSgBuf, aReqSegs, cSegs);
1488
1489 virtioCoreR3QueuePut(pDevIns, &pThis->Virtio, qIdx, &ReqSgBuf, pDescChain, true /*fFence*/);
1490 virtioCoreQueueSync(pDevIns, &pThis->Virtio, qIdx);
1491
1492 return VINF_SUCCESS;
1493}
1494
1495/**
1496 * @callback_method_impl{FNPDMTHREADWAKEUPDEV}
1497 */
1498static DECLCALLBACK(int) virtioScsiR3WorkerWakeUp(PPDMDEVINS pDevIns, PPDMTHREAD pThread)
1499{
1500 PVIRTIOSCSI pThis = PDMDEVINS_2_DATA(pDevIns, PVIRTIOSCSI);
1501 return PDMDevHlpSUPSemEventSignal(pDevIns, pThis->aWorkers[(uintptr_t)pThread->pvUser].hEvtProcess);
1502}
1503
1504/**
1505 * @callback_method_impl{FNPDMTHREADDEV}
1506 */
1507static DECLCALLBACK(int) virtioScsiR3WorkerThread(PPDMDEVINS pDevIns, PPDMTHREAD pThread)
1508{
1509 uint16_t const qIdx = (uint16_t)(uintptr_t)pThread->pvUser;
1510 PVIRTIOSCSI pThis = PDMDEVINS_2_DATA(pDevIns, PVIRTIOSCSI);
1511 PVIRTIOSCSICC pThisCC = PDMDEVINS_2_DATA_CC(pDevIns, PVIRTIOSCSICC);
1512 PVIRTIOSCSIWORKER pWorker = &pThis->aWorkers[qIdx];
1513 PVIRTIOSCSIWORKERR3 pWorkerR3 = &pThisCC->aWorkers[qIdx];
1514
1515 if (pThread->enmState == PDMTHREADSTATE_INITIALIZING)
1516 return VINF_SUCCESS;
1517
1518 while (pThread->enmState == PDMTHREADSTATE_RUNNING)
1519 {
1520 if (!pWorkerR3->cRedoDescs && virtioCoreQueueIsEmpty(pDevIns, &pThis->Virtio, qIdx))
1521 {
1522 /* Atomic interlocks avoid missing alarm while going to sleep & notifier waking the awoken */
1523 ASMAtomicWriteBool(&pWorkerR3->fSleeping, true);
1524 bool fNotificationSent = ASMAtomicXchgBool(&pWorkerR3->fNotified, false);
1525 if (!fNotificationSent)
1526 {
1527 Log6Func(("%s worker sleeping...\n", VIRTQNAME(qIdx)));
1528 Assert(ASMAtomicReadBool(&pWorkerR3->fSleeping));
1529 int rc = PDMDevHlpSUPSemEventWaitNoResume(pDevIns, pWorker->hEvtProcess, RT_INDEFINITE_WAIT);
1530 AssertLogRelMsgReturn(RT_SUCCESS(rc) || rc == VERR_INTERRUPTED, ("%Rrc\n", rc), rc);
1531 if (RT_UNLIKELY(pThread->enmState != PDMTHREADSTATE_RUNNING))
1532 return VINF_SUCCESS;
1533 if (rc == VERR_INTERRUPTED)
1534 continue;
1535 Log6Func(("%s worker woken\n", VIRTQNAME(qIdx)));
1536 ASMAtomicWriteBool(&pWorkerR3->fNotified, false);
1537 }
1538 ASMAtomicWriteBool(&pWorkerR3->fSleeping, false);
1539 }
1540
1541 if (!pThis->afQueueAttached[qIdx])
1542 {
1543 LogFunc(("%s queue not attached, worker aborting...\n", VIRTQNAME(qIdx)));
1544 break;
1545 }
1546 if (!pThisCC->fQuiescing)
1547 {
1548 /* Process any reqs that were suspended saved to the redo queue in save exec. */
1549 for (int i = 0; i < pWorkerR3->cRedoDescs; i++)
1550 {
1551 PVIRTIO_DESC_CHAIN_T pDescChain;
1552 int rc = virtioCoreR3DescChainGet(pDevIns, &pThis->Virtio, qIdx,
1553 pWorkerR3->auRedoDescs[i], &pDescChain);
1554 if (RT_FAILURE(rc))
1555 LogRel(("Error fetching desc chain to redo, %Rrc", rc));
1556
1557 rc = virtioScsiR3ReqSubmit(pDevIns, pThis, pThisCC, qIdx, pDescChain);
1558 if (RT_FAILURE(rc))
1559 LogRel(("Error submitting req packet, resetting %Rrc", rc));
1560 }
1561 pWorkerR3->cRedoDescs = 0;
1562
1563 Log6Func(("fetching next descriptor chain from %s\n", VIRTQNAME(qIdx)));
1564 PVIRTIO_DESC_CHAIN_T pDescChain;
1565 int rc = virtioCoreR3QueueGet(pDevIns, &pThis->Virtio, qIdx, &pDescChain, true);
1566 if (rc == VERR_NOT_AVAILABLE)
1567 {
1568 Log6Func(("Nothing found in %s\n", VIRTQNAME(qIdx)));
1569 continue;
1570 }
1571
1572 AssertRC(rc);
1573 if (qIdx == CONTROLQ_IDX)
1574 virtioScsiR3Ctrl(pDevIns, pThis, pThisCC, qIdx, pDescChain);
1575 else /* request queue index */
1576 {
1577 rc = virtioScsiR3ReqSubmit(pDevIns, pThis, pThisCC, qIdx, pDescChain);
1578 if (RT_FAILURE(rc))
1579 LogRel(("Error submitting req packet, resetting %Rrc", rc));
1580 }
1581 }
1582 }
1583 return VINF_SUCCESS;
1584}
1585
1586
1587/*********************************************************************************************************************************
1588* Sending evnets
1589*********************************************************************************************************************************/
1590
1591DECLINLINE(void) virtioScsiR3ReportEventsMissed(PPDMDEVINS pDevIns, PVIRTIOSCSI pThis, uint16_t uTarget)
1592{
1593 virtioScsiR3SendEvent(pDevIns, pThis, uTarget, VIRTIOSCSI_T_NO_EVENT | VIRTIOSCSI_T_EVENTS_MISSED, 0);
1594}
1595
1596
1597#if 0
1598/* SUBSCRIBABLE EVENT - not sure when to call this or how to detect when media is added or removed
1599 * via the VBox GUI */
1600DECLINLINE(void) virtioScsiR3ReportMediaChange(PPDMDEVINS pDevIns, PVIRTIOSCSI pThis, uint16_t uTarget)
1601{
1602 if (pThis->fAsyncEvtsEnabled & VIRTIOSCSI_EVT_ASYNC_MEDIA_CHANGE)
1603 virtioScsiR3SendEvent(pDevIns, pThis, uTarget, VIRTIOSCSI_T_ASYNC_NOTIFY, VIRTIOSCSI_EVT_ASYNC_MEDIA_CHANGE);
1604}
1605
1606/* ESSENTIAL (NON-SUBSCRIBABLE) EVENT TYPES (most guest virtio-scsi drivers ignore?) */
1607
1608DECLINLINE(void) virtioScsiR3ReportTransportReset(PDMDEVINS pDevIns, PVIRTIOSCSI pThis, uint16_t uTarget)
1609{
1610 virtioScsiR3SendEvent(pDevIns, pThis, uTarget, VIRTIOSCSI_T_TRANSPORT_RESET, VIRTIOSCSI_EVT_RESET_HARD);
1611}
1612
1613DECLINLINE(void) virtioScsiR3ReportParamChange(PDMDEVINS pDevIns, PVIRTIOSCSI pThis, uint16_t uTarget,
1614 uint32_t uSenseCode, uint32_t uSenseQualifier)
1615{
1616 uint32_t uReason = uSenseQualifier << 8 | uSenseCode;
1617 virtioScsiR3SendEvent(pDevIns, pThis, uTarget, VIRTIOSCSI_T_PARAM_CHANGE, uReason);
1618
1619}
1620
1621DECLINLINE(void) virtioScsiR3ReportTargetRemoved(PDMDEVINS pDevIns, PVIRTIOSCSI pThis, uint16_t uTarget)
1622{
1623 if (pThis->fHasHotplug)
1624 virtioScsiR3SendEvent(pDevIns, pThis, uTarget, VIRTIOSCSI_T_TRANSPORT_RESET, VIRTIOSCSI_EVT_RESET_REMOVED);
1625}
1626
1627DECLINLINE(void) virtioScsiR3ReportTargetAdded(PDMDEVINS pDevInsPVIRTIOSCSI pThis, uint16_t uTarget)
1628{
1629 if (pThis->fHasHotplug)
1630 virtioScsiR3SendEvent(pDevIns, pThis, uTarget, VIRTIOSCSI_T_TRANSPORT_RESET, VIRTIOSCSI_EVT_RESET_RESCAN);
1631}
1632
1633#endif
1634
1635/**
1636 * @callback_method_impl{VIRTIOCORER3,pfnQueueNotified}
1637 */
1638static DECLCALLBACK(void) virtioScsiR3Notified(PVIRTIOCORE pVirtio, PVIRTIOCORECC pVirtioCC, uint16_t qIdx)
1639{
1640 PVIRTIOSCSI pThis = RT_FROM_MEMBER(pVirtio, VIRTIOSCSI, Virtio);
1641 PVIRTIOSCSICC pThisCC = RT_FROM_MEMBER(pVirtioCC, VIRTIOSCSICC, Virtio);
1642 PPDMDEVINS pDevIns = pThisCC->pDevIns;
1643 AssertReturnVoid(qIdx < VIRTIOSCSI_QUEUE_CNT);
1644 PVIRTIOSCSIWORKER pWorker = &pThis->aWorkers[qIdx];
1645 PVIRTIOSCSIWORKERR3 pWorkerR3 = &pThisCC->aWorkers[qIdx];
1646
1647#ifdef LOG_ENABLED
1648 RTLogFlush(NULL);
1649#endif
1650
1651 if (qIdx == CONTROLQ_IDX || IS_REQ_QUEUE(qIdx))
1652 {
1653 Log6Func(("%s has available data\n", VIRTQNAME(qIdx)));
1654 /* Wake queue's worker thread up if sleeping */
1655 if (!ASMAtomicXchgBool(&pWorkerR3->fNotified, true))
1656 {
1657 if (ASMAtomicReadBool(&pWorkerR3->fSleeping))
1658 {
1659 Log6Func(("waking %s worker.\n", VIRTQNAME(qIdx)));
1660 int rc = PDMDevHlpSUPSemEventSignal(pDevIns, pWorker->hEvtProcess);
1661 AssertRC(rc);
1662 }
1663 }
1664 }
1665 else if (qIdx == EVENTQ_IDX)
1666 {
1667 Log3Func(("Driver queued buffer(s) to %s\n", VIRTQNAME(qIdx)));
1668 if (ASMAtomicXchgBool(&pThis->fEventsMissed, false))
1669 virtioScsiR3ReportEventsMissed(pDevIns, pThis, 0);
1670 }
1671 else
1672 LogFunc(("Unexpected queue idx (ignoring): %d\n", qIdx));
1673}
1674
1675/**
1676 * @callback_method_impl{VIRTIOCORER3,pfnStatusChanged}
1677 */
1678static DECLCALLBACK(void) virtioScsiR3StatusChanged(PVIRTIOCORE pVirtio, PVIRTIOCORECC pVirtioCC, uint32_t fVirtioReady)
1679{
1680 PVIRTIOSCSI pThis = RT_FROM_MEMBER(pVirtio, VIRTIOSCSI, Virtio);
1681 PVIRTIOSCSICC pThisCC = RT_FROM_MEMBER(pVirtioCC, VIRTIOSCSICC, Virtio);
1682
1683 pThis->fVirtioReady = fVirtioReady;
1684
1685 if (fVirtioReady)
1686 {
1687 LogFunc(("VirtIO ready\n-----------------------------------------------------------------------------------------\n"));
1688 uint64_t fFeatures = virtioCoreGetNegotiatedFeatures(&pThis->Virtio);
1689 pThis->fHasT10pi = fFeatures & VIRTIO_SCSI_F_T10_PI;
1690 pThis->fHasHotplug = fFeatures & VIRTIO_SCSI_F_HOTPLUG;
1691 pThis->fHasInOutBufs = fFeatures & VIRTIO_SCSI_F_INOUT;
1692 pThis->fHasLunChange = fFeatures & VIRTIO_SCSI_F_CHANGE;
1693 pThis->fResetting = false;
1694 pThisCC->fQuiescing = false;
1695
1696 for (unsigned i = 0; i < VIRTIOSCSI_QUEUE_CNT; i++)
1697 pThis->afQueueAttached[i] = true;
1698 }
1699 else
1700 {
1701 LogFunc(("VirtIO is resetting\n"));
1702 for (unsigned i = 0; i < VIRTIOSCSI_QUEUE_CNT; i++)
1703 pThis->afQueueAttached[i] = false;
1704 }
1705}
1706
1707
1708/*********************************************************************************************************************************
1709* LEDs *
1710*********************************************************************************************************************************/
1711
1712/**
1713 * @interface_method_impl{PDMILEDPORTS,pfnQueryStatusLed, Target level.}
1714 */
1715static DECLCALLBACK(int) virtioScsiR3TargetQueryStatusLed(PPDMILEDPORTS pInterface, unsigned iLUN, PPDMLED *ppLed)
1716{
1717 PVIRTIOSCSITARGET pTarget = RT_FROM_MEMBER(pInterface, VIRTIOSCSITARGET, ILed);
1718 if (iLUN == 0)
1719 {
1720 *ppLed = &pTarget->led;
1721 Assert((*ppLed)->u32Magic == PDMLED_MAGIC);
1722 return VINF_SUCCESS;
1723 }
1724 return VERR_PDM_LUN_NOT_FOUND;
1725}
1726/**
1727 * @interface_method_impl{PDMILEDPORTS,pfnQueryStatusLed, Device level.}
1728 */
1729static DECLCALLBACK(int) virtioScsiR3DeviceQueryStatusLed(PPDMILEDPORTS pInterface, unsigned iLUN, PPDMLED *ppLed)
1730{
1731 PVIRTIOSCSICC pThisCC = RT_FROM_MEMBER(pInterface, VIRTIOSCSICC, ILeds);
1732 PVIRTIOSCSI pThis = PDMDEVINS_2_DATA(pThisCC->pDevIns, PVIRTIOSCSI);
1733 if (iLUN < pThis->cTargets)
1734 {
1735 *ppLed = &pThisCC->paTargetInstances[iLUN].led;
1736 Assert((*ppLed)->u32Magic == PDMLED_MAGIC);
1737 return VINF_SUCCESS;
1738 }
1739 return VERR_PDM_LUN_NOT_FOUND;
1740}
1741
1742
1743/*********************************************************************************************************************************
1744* PDMIMEDIAPORT (target) *
1745*********************************************************************************************************************************/
1746
1747/**
1748 * @interface_method_impl{PDMIMEDIAPORT,pfnQueryDeviceLocation, Target level.}
1749 */
1750static DECLCALLBACK(int) virtioScsiR3QueryDeviceLocation(PPDMIMEDIAPORT pInterface, const char **ppcszController,
1751 uint32_t *piInstance, uint32_t *piLUN)
1752{
1753 PVIRTIOSCSITARGET pTarget = RT_FROM_MEMBER(pInterface, VIRTIOSCSITARGET, IMediaPort);
1754 PPDMDEVINS pDevIns = pTarget->pDevIns;
1755
1756 AssertPtrReturn(ppcszController, VERR_INVALID_POINTER);
1757 AssertPtrReturn(piInstance, VERR_INVALID_POINTER);
1758 AssertPtrReturn(piLUN, VERR_INVALID_POINTER);
1759
1760 *ppcszController = pDevIns->pReg->szName;
1761 *piInstance = pDevIns->iInstance;
1762 *piLUN = pTarget->uTarget;
1763
1764 return VINF_SUCCESS;
1765}
1766
1767
1768/*********************************************************************************************************************************
1769* Virtio config. *
1770*********************************************************************************************************************************/
1771
1772/**
1773 * Resolves to boolean true if uOffset matches a field offset and size exactly,
1774 * (or if 64-bit field, if it accesses either 32-bit part as a 32-bit access)
1775 * Assumption is this critereon is mandated by VirtIO 1.0, Section 4.1.3.1)
1776 * (Easily re-written to allow unaligned bounded access to a field).
1777 *
1778 * @param member - Member of VIRTIO_PCI_COMMON_CFG_T
1779 * @result - true or false
1780 */
1781#define MATCH_SCSI_CONFIG(member) \
1782 ( ( RT_SIZEOFMEMB(VIRTIOSCSI_CONFIG_T, member) == 8 \
1783 && ( offConfig == RT_UOFFSETOF(VIRTIOSCSI_CONFIG_T, member) \
1784 || offConfig == RT_UOFFSETOF(VIRTIOSCSI_CONFIG_T, member) + sizeof(uint32_t)) \
1785 && cb == sizeof(uint32_t)) \
1786 || ( offConfig == RT_UOFFSETOF(VIRTIOSCSI_CONFIG_T, member) \
1787 && cb == RT_SIZEOFMEMB(VIRTIOSCSI_CONFIG_T, member)) )
1788
1789#ifdef LOG_ENABLED
1790# define LOG_SCSI_CONFIG_ACCESSOR(member) \
1791 virtioCoreLogMappedIoValue(__FUNCTION__, #member, RT_SIZEOFMEMB(VIRTIOSCSI_CONFIG_T, member), \
1792 pv, cb, offIntra, fWrite, false, 0);
1793#else
1794# define LOG_SCSI_CONFIG_ACCESSOR(member) do { } while (0)
1795#endif
1796
1797#define SCSI_CONFIG_ACCESSOR(member) \
1798 do \
1799 { \
1800 uint32_t offIntra = offConfig - RT_UOFFSETOF(VIRTIOSCSI_CONFIG_T, member); \
1801 if (fWrite) \
1802 memcpy((char *)&pThis->virtioScsiConfig.member + offIntra, pv, cb); \
1803 else \
1804 memcpy(pv, (const char *)&pThis->virtioScsiConfig.member + offIntra, cb); \
1805 LOG_SCSI_CONFIG_ACCESSOR(member); \
1806 } while(0)
1807
1808#define SCSI_CONFIG_ACCESSOR_READONLY(member) \
1809 do \
1810 { \
1811 uint32_t offIntra = offConfig - RT_UOFFSETOF(VIRTIOSCSI_CONFIG_T, member); \
1812 if (fWrite) \
1813 LogFunc(("Guest attempted to write readonly virtio_pci_common_cfg.%s\n", #member)); \
1814 else \
1815 { \
1816 memcpy(pv, (const char *)&pThis->virtioScsiConfig.member + offIntra, cb); \
1817 LOG_SCSI_CONFIG_ACCESSOR(member); \
1818 } \
1819 } while(0)
1820
1821/**
1822 * Worker for virtioScsiR3DevCapWrite and virtioScsiR3DevCapRead.
1823 */
1824static int virtioScsiR3CfgAccessed(PVIRTIOSCSI pThis, uint32_t offConfig, void *pv, uint32_t cb, bool fWrite)
1825{
1826 AssertReturn(pv && cb <= sizeof(uint32_t), fWrite ? VINF_SUCCESS : VINF_IOM_MMIO_UNUSED_00);
1827
1828 if (MATCH_SCSI_CONFIG(uNumQueues))
1829 SCSI_CONFIG_ACCESSOR_READONLY(uNumQueues);
1830 else
1831 if (MATCH_SCSI_CONFIG(uSegMax))
1832 SCSI_CONFIG_ACCESSOR_READONLY(uSegMax);
1833 else
1834 if (MATCH_SCSI_CONFIG(uMaxSectors))
1835 SCSI_CONFIG_ACCESSOR_READONLY(uMaxSectors);
1836 else
1837 if (MATCH_SCSI_CONFIG(uCmdPerLun))
1838 SCSI_CONFIG_ACCESSOR_READONLY(uCmdPerLun);
1839 else
1840 if (MATCH_SCSI_CONFIG(uEventInfoSize))
1841 SCSI_CONFIG_ACCESSOR_READONLY(uEventInfoSize);
1842 else
1843 if (MATCH_SCSI_CONFIG(uSenseSize))
1844 SCSI_CONFIG_ACCESSOR(uSenseSize);
1845 else
1846 if (MATCH_SCSI_CONFIG(uCdbSize))
1847 SCSI_CONFIG_ACCESSOR(uCdbSize);
1848 else
1849 if (MATCH_SCSI_CONFIG(uMaxChannel))
1850 SCSI_CONFIG_ACCESSOR_READONLY(uMaxChannel);
1851 else
1852 if (MATCH_SCSI_CONFIG(uMaxTarget))
1853 SCSI_CONFIG_ACCESSOR_READONLY(uMaxTarget);
1854 else
1855 if (MATCH_SCSI_CONFIG(uMaxLun))
1856 SCSI_CONFIG_ACCESSOR_READONLY(uMaxLun);
1857 else
1858 {
1859 LogFunc(("Bad access by guest to virtio_scsi_config: off=%u (%#x), cb=%u\n", offConfig, offConfig, cb));
1860 return fWrite ? VINF_SUCCESS : VINF_IOM_MMIO_UNUSED_00;
1861 }
1862 return VINF_SUCCESS;
1863}
1864
1865#undef SCSI_CONFIG_ACCESSOR_READONLY
1866#undef SCSI_CONFIG_ACCESSOR
1867#undef LOG_ACCESSOR
1868#undef MATCH_SCSI_CONFIG
1869
1870/**
1871 * @callback_method_impl{VIRTIOCORER3,pfnDevCapRead}
1872 */
1873static DECLCALLBACK(int) virtioScsiR3DevCapRead(PPDMDEVINS pDevIns, uint32_t uOffset, void *pv, uint32_t cb)
1874{
1875 return virtioScsiR3CfgAccessed(PDMDEVINS_2_DATA(pDevIns, PVIRTIOSCSI), uOffset, pv, cb, false /*fRead*/);
1876}
1877
1878/**
1879 * @callback_method_impl{VIRTIOCORER3,pfnDevCapWrite}
1880 */
1881static DECLCALLBACK(int) virtioScsiR3DevCapWrite(PPDMDEVINS pDevIns, uint32_t uOffset, const void *pv, uint32_t cb)
1882{
1883 return virtioScsiR3CfgAccessed(PDMDEVINS_2_DATA(pDevIns, PVIRTIOSCSI), uOffset, (void *)pv, cb, true /*fWrite*/);
1884}
1885
1886
1887/*********************************************************************************************************************************
1888* IBase for device and targets *
1889*********************************************************************************************************************************/
1890
1891/**
1892 * @interface_method_impl{PDMIBASE,pfnQueryInterface, Target level.}
1893 */
1894static DECLCALLBACK(void *) virtioScsiR3TargetQueryInterface(PPDMIBASE pInterface, const char *pszIID)
1895{
1896 PVIRTIOSCSITARGET pTarget = RT_FROM_MEMBER(pInterface, VIRTIOSCSITARGET, IBase);
1897 PDMIBASE_RETURN_INTERFACE(pszIID, PDMIBASE, &pTarget->IBase);
1898 PDMIBASE_RETURN_INTERFACE(pszIID, PDMIMEDIAPORT, &pTarget->IMediaPort);
1899 PDMIBASE_RETURN_INTERFACE(pszIID, PDMIMEDIAEXPORT, &pTarget->IMediaExPort);
1900 PDMIBASE_RETURN_INTERFACE(pszIID, PDMILEDPORTS, &pTarget->ILed);
1901 return NULL;
1902}
1903
1904/**
1905 * @interface_method_impl{PDMIBASE,pfnQueryInterface, Device level.}
1906 */
1907static DECLCALLBACK(void *) virtioScsiR3DeviceQueryInterface(PPDMIBASE pInterface, const char *pszIID)
1908{
1909 PVIRTIOSCSICC pThisCC = RT_FROM_MEMBER(pInterface, VIRTIOSCSICC, IBase);
1910
1911 PDMIBASE_RETURN_INTERFACE(pszIID, PDMIBASE, &pThisCC->IBase);
1912 PDMIBASE_RETURN_INTERFACE(pszIID, PDMILEDPORTS, &pThisCC->ILeds);
1913
1914 return NULL;
1915}
1916
1917
1918/*********************************************************************************************************************************
1919* Misc *
1920*********************************************************************************************************************************/
1921
1922/**
1923 * @callback_method_impl{FNDBGFHANDLERDEV, virtio-scsi debugger info callback.}
1924 */
1925static DECLCALLBACK(void) virtioScsiR3Info(PPDMDEVINS pDevIns, PCDBGFINFOHLP pHlp, const char *pszArgs)
1926{
1927 PVIRTIOSCSI pThis = PDMDEVINS_2_DATA(pDevIns, PVIRTIOSCSI);
1928
1929 /* Parse arguments. */
1930 RT_NOREF(pszArgs); //bool fVerbose = pszArgs && strstr(pszArgs, "verbose") != NULL;
1931
1932 /* Show basic information. */
1933 pHlp->pfnPrintf(pHlp, "%s#%d: virtio-scsci ",
1934 pDevIns->pReg->szName,
1935 pDevIns->iInstance);
1936 pHlp->pfnPrintf(pHlp, "numTargets=%lu", pThis->cTargets);
1937}
1938
1939
1940/*********************************************************************************************************************************
1941* Saved state *
1942*********************************************************************************************************************************/
1943
1944/**
1945 * @callback_method_impl{FNSSMDEVLOADEXEC}
1946 */
1947static DECLCALLBACK(int) virtioScsiR3LoadExec(PPDMDEVINS pDevIns, PSSMHANDLE pSSM, uint32_t uVersion, uint32_t uPass)
1948{
1949 PVIRTIOSCSI pThis = PDMDEVINS_2_DATA(pDevIns, PVIRTIOSCSI);
1950 PVIRTIOSCSICC pThisCC = PDMDEVINS_2_DATA_CC(pDevIns, PVIRTIOSCSICC);
1951 PCPDMDEVHLPR3 pHlp = pDevIns->pHlpR3;
1952
1953 LogFunc(("LOAD EXEC!!\n"));
1954
1955 AssertReturn(uPass == SSM_PASS_FINAL, VERR_SSM_UNEXPECTED_PASS);
1956 AssertLogRelMsgReturn(uVersion == VIRTIOSCSI_SAVED_STATE_VERSION,
1957 ("uVersion=%u\n", uVersion), VERR_SSM_UNSUPPORTED_DATA_UNIT_VERSION);
1958
1959 virtioScsiSetVirtqNames(pThis);
1960 for (int qIdx = 0; qIdx < VIRTIOSCSI_QUEUE_CNT; qIdx++)
1961 pHlp->pfnSSMGetBool(pSSM, &pThis->afQueueAttached[qIdx]);
1962
1963 pHlp->pfnSSMGetU32(pSSM, &pThis->virtioScsiConfig.uNumQueues);
1964 pHlp->pfnSSMGetU32(pSSM, &pThis->virtioScsiConfig.uSegMax);
1965 pHlp->pfnSSMGetU32(pSSM, &pThis->virtioScsiConfig.uMaxSectors);
1966 pHlp->pfnSSMGetU32(pSSM, &pThis->virtioScsiConfig.uCmdPerLun);
1967 pHlp->pfnSSMGetU32(pSSM, &pThis->virtioScsiConfig.uEventInfoSize);
1968 pHlp->pfnSSMGetU32(pSSM, &pThis->virtioScsiConfig.uSenseSize);
1969 pHlp->pfnSSMGetU32(pSSM, &pThis->virtioScsiConfig.uCdbSize);
1970 pHlp->pfnSSMGetU16(pSSM, &pThis->virtioScsiConfig.uMaxChannel);
1971 pHlp->pfnSSMGetU16(pSSM, &pThis->virtioScsiConfig.uMaxTarget);
1972 pHlp->pfnSSMGetU32(pSSM, &pThis->virtioScsiConfig.uMaxLun);
1973 pHlp->pfnSSMGetU32(pSSM, &pThis->fAsyncEvtsEnabled);
1974 pHlp->pfnSSMGetBool(pSSM, &pThis->fEventsMissed);
1975 pHlp->pfnSSMGetU32(pSSM, &pThis->fVirtioReady);
1976 pHlp->pfnSSMGetU32(pSSM, &pThis->fHasT10pi);
1977 pHlp->pfnSSMGetU32(pSSM, &pThis->fHasHotplug);
1978 pHlp->pfnSSMGetU32(pSSM, &pThis->fHasInOutBufs);
1979 pHlp->pfnSSMGetU32(pSSM, &pThis->fHasLunChange);
1980 pHlp->pfnSSMGetU32(pSSM, &pThis->fResetting);
1981
1982 pHlp->pfnSSMGetU32(pSSM, &pThis->cTargets);
1983
1984 for (uint16_t uTarget = 0; uTarget < pThis->cTargets; uTarget++)
1985 {
1986 uint16_t cReqsRedo;
1987 pHlp->pfnSSMGetU16(pSSM, &cReqsRedo);
1988 if (cReqsRedo >= VIRTQ_MAX_SIZE)
1989 {
1990 LogFunc(("Bad count of I/O transactions to re-do in SSM state data. Skipping\n"));
1991 continue;
1992 }
1993
1994 for (uint16_t qIdx = VIRTQ_REQ_BASE; qIdx < VIRTIOSCSI_QUEUE_CNT; qIdx++)
1995 {
1996 PVIRTIOSCSIWORKERR3 pWorkerR3 = &pThisCC->aWorkers[qIdx];
1997 pWorkerR3->cRedoDescs = 0;
1998 }
1999
2000 for (int i = 0; i < cReqsRedo; i++)
2001 {
2002 uint16_t qIdx, uHeadIdx;
2003
2004 pHlp->pfnSSMGetU16(pSSM, &qIdx);
2005 pHlp->pfnSSMGetU16(pSSM, &uHeadIdx);
2006
2007 if (qIdx >= VIRTIOSCSI_QUEUE_CNT)
2008 {
2009 LogFunc(("Bad queue index in SSM state data. Skipping\n"));
2010 continue;
2011 }
2012 if (uHeadIdx >= VIRTQ_MAX_SIZE)
2013 {
2014 LogFunc(("Bad queue elem index in SSM state data. Skipping\n"));
2015 continue;
2016 }
2017 PVIRTIOSCSIWORKERR3 pWorkerR3 = &pThisCC->aWorkers[qIdx];
2018 pWorkerR3->auRedoDescs[pWorkerR3->cRedoDescs++] = uHeadIdx;
2019 pWorkerR3->cRedoDescs %= VIRTQ_MAX_SIZE;
2020 }
2021 }
2022
2023 /*
2024 * Call the virtio core to let it load its state.
2025 */
2026 int rc = virtioCoreR3LoadExec(&pThis->Virtio, pDevIns->pHlpR3, pSSM);
2027
2028 /*
2029 * Nudge request queue workers
2030 */
2031 for (int qIdx = VIRTQ_REQ_BASE; qIdx < VIRTIOSCSI_QUEUE_CNT; qIdx++)
2032 {
2033 if (pThis->afQueueAttached[qIdx])
2034 {
2035 LogFunc(("Waking %s worker.\n", VIRTQNAME(qIdx)));
2036 rc = PDMDevHlpSUPSemEventSignal(pDevIns, pThis->aWorkers[qIdx].hEvtProcess);
2037 AssertRCReturn(rc, rc);
2038 }
2039 }
2040 return rc;
2041}
2042
2043/**
2044 * @callback_method_impl{FNSSMDEVSAVEEXEC}
2045 */
2046static DECLCALLBACK(int) virtioScsiR3SaveExec(PPDMDEVINS pDevIns, PSSMHANDLE pSSM)
2047{
2048 PVIRTIOSCSI pThis = PDMDEVINS_2_DATA(pDevIns, PVIRTIOSCSI);
2049 PVIRTIOSCSICC pThisCC = PDMDEVINS_2_DATA_CC(pDevIns, PVIRTIOSCSICC);
2050 PCPDMDEVHLPR3 pHlp = pDevIns->pHlpR3;
2051
2052 LogFunc(("SAVE EXEC!!\n"));
2053
2054 for (int qIdx = 0; qIdx < VIRTIOSCSI_QUEUE_CNT; qIdx++)
2055 pHlp->pfnSSMPutBool(pSSM, pThis->afQueueAttached[qIdx]);
2056
2057 pHlp->pfnSSMPutU32(pSSM, pThis->virtioScsiConfig.uNumQueues);
2058 pHlp->pfnSSMPutU32(pSSM, pThis->virtioScsiConfig.uSegMax);
2059 pHlp->pfnSSMPutU32(pSSM, pThis->virtioScsiConfig.uMaxSectors);
2060 pHlp->pfnSSMPutU32(pSSM, pThis->virtioScsiConfig.uCmdPerLun);
2061 pHlp->pfnSSMPutU32(pSSM, pThis->virtioScsiConfig.uEventInfoSize);
2062 pHlp->pfnSSMPutU32(pSSM, pThis->virtioScsiConfig.uSenseSize);
2063 pHlp->pfnSSMPutU32(pSSM, pThis->virtioScsiConfig.uCdbSize);
2064 pHlp->pfnSSMPutU16(pSSM, pThis->virtioScsiConfig.uMaxChannel);
2065 pHlp->pfnSSMPutU16(pSSM, pThis->virtioScsiConfig.uMaxTarget);
2066 pHlp->pfnSSMPutU32(pSSM, pThis->virtioScsiConfig.uMaxLun);
2067 pHlp->pfnSSMPutU32(pSSM, pThis->fAsyncEvtsEnabled);
2068 pHlp->pfnSSMPutBool(pSSM, pThis->fEventsMissed);
2069 pHlp->pfnSSMPutU32(pSSM, pThis->fVirtioReady);
2070 pHlp->pfnSSMPutU32(pSSM, pThis->fHasT10pi);
2071 pHlp->pfnSSMPutU32(pSSM, pThis->fHasHotplug);
2072 pHlp->pfnSSMPutU32(pSSM, pThis->fHasInOutBufs);
2073 pHlp->pfnSSMPutU32(pSSM, pThis->fHasLunChange);
2074 pHlp->pfnSSMPutU32(pSSM, pThis->fResetting);
2075
2076 AssertMsg(!pThis->cActiveReqs, ("There are still outstanding requests on this device\n"));
2077
2078 pHlp->pfnSSMPutU32(pSSM, pThis->cTargets);
2079
2080 for (uint16_t uTarget = 0; uTarget < pThis->cTargets; uTarget++)
2081 {
2082 PVIRTIOSCSITARGET pTarget = &pThisCC->paTargetInstances[uTarget];
2083
2084 /* Query all suspended requests and store them in the request queue. */
2085 if (pTarget->pDrvMediaEx)
2086 {
2087 uint32_t cReqsRedo = pTarget->pDrvMediaEx->pfnIoReqGetSuspendedCount(pTarget->pDrvMediaEx);
2088
2089 pHlp->pfnSSMPutU16(pSSM, cReqsRedo);
2090
2091 if (cReqsRedo)
2092 {
2093 PDMMEDIAEXIOREQ hIoReq;
2094 PVIRTIOSCSIREQ pReq;
2095
2096 int rc = pTarget->pDrvMediaEx->pfnIoReqQuerySuspendedStart(pTarget->pDrvMediaEx, &hIoReq,
2097 (void **)&pReq);
2098 AssertRCBreak(rc);
2099
2100 while(--cReqsRedo)
2101 {
2102 pHlp->pfnSSMPutU16(pSSM, pReq->qIdx);
2103 pHlp->pfnSSMPutU16(pSSM, pReq->pDescChain->uHeadIdx);
2104
2105 rc = pTarget->pDrvMediaEx->pfnIoReqQuerySuspendedNext(pTarget->pDrvMediaEx, hIoReq,
2106 &hIoReq, (void **)&pReq);
2107 AssertRCBreak(rc);
2108 }
2109 }
2110 }
2111 }
2112
2113 /*
2114 * Call the virtio core to let it save its state.
2115 */
2116 return virtioCoreR3SaveExec(&pThis->Virtio, pDevIns->pHlpR3, pSSM);
2117}
2118
2119
2120/*********************************************************************************************************************************
2121* Device interface. *
2122*********************************************************************************************************************************/
2123
2124/**
2125 * @interface_method_impl{PDMDEVREGR3,pfnDetach}
2126 *
2127 * One harddisk at one port has been unplugged.
2128 * The VM is suspended at this point.
2129 */
2130static DECLCALLBACK(void) virtioScsiR3Detach(PPDMDEVINS pDevIns, unsigned uTarget, uint32_t fFlags)
2131{
2132 PVIRTIOSCSI pThis = PDMDEVINS_2_DATA(pDevIns, PVIRTIOSCSI);
2133 PVIRTIOSCSICC pThisCC = PDMDEVINS_2_DATA_CC(pDevIns, PVIRTIOSCSICC);
2134 AssertReturnVoid(uTarget < pThis->cTargets);
2135 PVIRTIOSCSITARGET pTarget = &pThisCC->paTargetInstances[uTarget];
2136
2137 LogFunc((""));
2138
2139 AssertMsg(fFlags & PDM_TACH_FLAGS_NOT_HOT_PLUG,
2140 ("virtio-scsi: Device does not support hotplugging\n"));
2141 RT_NOREF(fFlags);
2142
2143 /*
2144 * Zero all important members.
2145 */
2146 pTarget->fPresent = false;
2147 pTarget->pDrvBase = NULL;
2148 pTarget->pDrvMedia = NULL;
2149 pTarget->pDrvMediaEx = NULL;
2150}
2151
2152/**
2153 * @interface_method_impl{PDMDEVREGR3,pfnAttach}
2154 *
2155 * This is called when we change block driver.
2156 */
2157static DECLCALLBACK(int) virtioScsiR3Attach(PPDMDEVINS pDevIns, unsigned uTarget, uint32_t fFlags)
2158{
2159 PVIRTIOSCSI pThis = PDMDEVINS_2_DATA(pDevIns, PVIRTIOSCSI);
2160 PVIRTIOSCSICC pThisCC = PDMDEVINS_2_DATA_CC(pDevIns, PVIRTIOSCSICC);
2161 AssertReturn(uTarget < pThis->cTargets, VERR_PDM_LUN_NOT_FOUND);
2162 PVIRTIOSCSITARGET pTarget = &pThisCC->paTargetInstances[uTarget];
2163
2164 Assert(pTarget->pDevIns == pDevIns);
2165 AssertMsgReturn(fFlags & PDM_TACH_FLAGS_NOT_HOT_PLUG,
2166 ("virtio-scsi: Device does not support hotplugging\n"),
2167 VERR_INVALID_PARAMETER);
2168
2169 AssertRelease(!pTarget->pDrvBase);
2170 Assert(pTarget->uTarget == uTarget);
2171
2172 /*
2173 * Try attach the SCSI driver and get the interfaces, required as well as optional.
2174 */
2175 int rc = PDMDevHlpDriverAttach(pDevIns, pTarget->uTarget, &pDevIns->IBase, &pTarget->pDrvBase, pTarget->pszTargetName);
2176 if (RT_SUCCESS(rc))
2177 {
2178 pTarget->fPresent = true;
2179 pTarget->pDrvMedia = PDMIBASE_QUERY_INTERFACE(pTarget->pDrvBase, PDMIMEDIA);
2180 AssertMsgReturn(VALID_PTR(pTarget->pDrvMedia),
2181 ("virtio-scsi configuration error: LUN#%d missing basic media interface!\n", uTarget),
2182 VERR_PDM_MISSING_INTERFACE);
2183
2184 /* Get the extended media interface. */
2185 pTarget->pDrvMediaEx = PDMIBASE_QUERY_INTERFACE(pTarget->pDrvBase, PDMIMEDIAEX);
2186 AssertMsgReturn(VALID_PTR(pTarget->pDrvMediaEx),
2187 ("virtio-scsi configuration error: LUN#%d missing extended media interface!\n", uTarget),
2188 VERR_PDM_MISSING_INTERFACE);
2189
2190 rc = pTarget->pDrvMediaEx->pfnIoReqAllocSizeSet(pTarget->pDrvMediaEx, sizeof(VIRTIOSCSIREQ));
2191 AssertMsgReturn(VALID_PTR(pTarget->pDrvMediaEx),
2192 ("virtio-scsi configuration error: LUN#%u: Failed to set I/O request size!\n", uTarget),
2193 rc);
2194 }
2195 else
2196 AssertMsgFailed(("Failed to attach %s. rc=%Rrc\n", pTarget->pszTargetName, rc));
2197
2198 if (RT_FAILURE(rc))
2199 {
2200 pTarget->fPresent = false;
2201 pTarget->pDrvBase = NULL;
2202 pTarget->pDrvMedia = NULL;
2203 pTarget->pDrvMediaEx = NULL;
2204 pThisCC->pMediaNotify = NULL;
2205 }
2206 return rc;
2207}
2208
2209/**
2210 * @callback_method_impl{FNPDMDEVASYNCNOTIFY}
2211 */
2212static DECLCALLBACK(bool) virtioScsiR3DeviceQuiesced(PPDMDEVINS pDevIns)
2213{
2214 PVIRTIOSCSI pThis = PDMDEVINS_2_DATA(pDevIns, PVIRTIOSCSI);
2215 PVIRTIOSCSICC pThisCC = PDMDEVINS_2_DATA_CC(pDevIns, PVIRTIOSCSICC);
2216
2217 if (ASMAtomicReadU32(&pThis->cActiveReqs))
2218 return false;
2219
2220 LogFunc(("Device I/O activity quiesced: %s\n",
2221 virtioCoreGetStateChangeText(pThisCC->enmQuiescingFor)));
2222
2223 virtioCoreR3VmStateChanged(&pThis->Virtio, pThisCC->enmQuiescingFor);
2224
2225 pThis->fResetting = false;
2226 pThisCC->fQuiescing = false;
2227
2228 return true;
2229}
2230
2231/**
2232 * Worker for virtioScsiR3Reset() and virtioScsiR3SuspendOrPowerOff().
2233 */
2234static void virtioScsiR3QuiesceDevice(PPDMDEVINS pDevIns, VIRTIOVMSTATECHANGED enmQuiscingFor)
2235{
2236 PVIRTIOSCSI pThis = PDMDEVINS_2_DATA(pDevIns, PVIRTIOSCSI);
2237 PVIRTIOSCSICC pThisCC = PDMDEVINS_2_DATA_CC(pDevIns, PVIRTIOSCSICC);
2238
2239 /* Prevent worker threads from removing/processing elements from virtq's */
2240 pThisCC->fQuiescing = true;
2241 pThisCC->enmQuiescingFor = enmQuiscingFor;
2242
2243 PDMDevHlpSetAsyncNotification(pDevIns, virtioScsiR3DeviceQuiesced);
2244
2245 /* If already quiesced invoke async callback. */
2246 if (!ASMAtomicReadU32(&pThis->cActiveReqs))
2247 PDMDevHlpAsyncNotificationCompleted(pDevIns);
2248}
2249
2250/**
2251 * @interface_method_impl{PDMDEVREGR3,pfnReset}
2252 */
2253static DECLCALLBACK(void) virtioScsiR3Reset(PPDMDEVINS pDevIns)
2254{
2255 LogFunc(("\n"));
2256 PVIRTIOSCSI pThis = PDMDEVINS_2_DATA(pDevIns, PVIRTIOSCSI);
2257 pThis->fResetting = true;
2258 virtioScsiR3QuiesceDevice(pDevIns, kvirtIoVmStateChangedReset);
2259}
2260
2261/**
2262 * @interface_method_impl{PDMDEVREGR3,pfnPowerOff}
2263 */
2264static DECLCALLBACK(void) virtioScsiR3SuspendOrPowerOff(PPDMDEVINS pDevIns, VIRTIOVMSTATECHANGED enmType)
2265{
2266 LogFunc(("\n"));
2267
2268 PVIRTIOSCSI pThis = PDMDEVINS_2_DATA(pDevIns, PVIRTIOSCSI);
2269 PVIRTIOSCSICC pThisCC = PDMDEVINS_2_DATA_CC(pDevIns, PVIRTIOSCSICC);
2270
2271 /* VM is halted, thus no new I/O being dumped into queues by the guest.
2272 * Workers have been flagged to stop pulling stuff already queued-up by the guest.
2273 * Now tell lower-level to to suspend reqs (for example, DrvVD suspends all reqs
2274 * on its wait queue, and we will get a callback as the state changes to
2275 * suspended (and later, resumed) for each).
2276 */
2277 for (uint32_t i = 0; i < pThis->cTargets; i++)
2278 {
2279 PVIRTIOSCSITARGET pTarget = &pThisCC->paTargetInstances[i];
2280 if (pTarget->pDrvMediaEx)
2281 pTarget->pDrvMediaEx->pfnNotifySuspend(pTarget->pDrvMediaEx);
2282 }
2283
2284 virtioScsiR3QuiesceDevice(pDevIns, enmType);
2285}
2286
2287/**
2288 * @interface_method_impl{PDMDEVREGR3,pfnSuspend}
2289 */
2290static DECLCALLBACK(void) virtioScsiR3PowerOff(PPDMDEVINS pDevIns)
2291{
2292 LogFunc(("\n"));
2293 virtioScsiR3SuspendOrPowerOff(pDevIns, kvirtIoVmStateChangedPowerOff);
2294}
2295
2296/**
2297 * @interface_method_impl{PDMDEVREGR3,pfnSuspend}
2298 */
2299static DECLCALLBACK(void) virtioScsiR3Suspend(PPDMDEVINS pDevIns)
2300{
2301 LogFunc(("\n"));
2302 virtioScsiR3SuspendOrPowerOff(pDevIns, kvirtIoVmStateChangedSuspend);
2303}
2304
2305/**
2306 * @interface_method_impl{PDMDEVREGR3,pfnResume}
2307 */
2308static DECLCALLBACK(void) virtioScsiR3Resume(PPDMDEVINS pDevIns)
2309{
2310 PVIRTIOSCSI pThis = PDMDEVINS_2_DATA(pDevIns, PVIRTIOSCSI);
2311 PVIRTIOSCSICC pThisCC = PDMDEVINS_2_DATA_CC(pDevIns, PVIRTIOSCSICC);
2312 LogFunc(("\n"));
2313
2314 pThisCC->fQuiescing = false;
2315
2316 /* Wake worker threads flagged to skip pulling queue entries during quiesce
2317 * to ensure they re-check their queues. Active request queues may already
2318 * be awake due to new reqs coming in.
2319 */
2320 for (uint16_t qIdx = 0; qIdx < VIRTIOSCSI_REQ_QUEUE_CNT; qIdx++)
2321 {
2322 if (ASMAtomicReadBool(&pThisCC->aWorkers[qIdx].fSleeping))
2323 {
2324 Log6Func(("waking %s worker.\n", VIRTQNAME(qIdx)));
2325 int rc = PDMDevHlpSUPSemEventSignal(pDevIns, pThis->aWorkers[qIdx].hEvtProcess);
2326 AssertRC(rc);
2327 }
2328 }
2329 /* Ensure guest is working the queues too. */
2330 virtioCoreR3VmStateChanged(&pThis->Virtio, kvirtIoVmStateChangedResume);
2331}
2332
2333/**
2334 * @interface_method_impl{PDMIMEDIAEXPORT,pfnMediumEjected}
2335 */
2336static DECLCALLBACK(void) virtioScsiR3MediumEjected(PPDMIMEDIAEXPORT pInterface)
2337{
2338 PVIRTIOSCSITARGET pTarget = RT_FROM_MEMBER(pInterface, VIRTIOSCSITARGET, IMediaExPort);
2339 PPDMDEVINS pDevIns = pTarget->pDevIns;
2340 PVIRTIOSCSICC pThisCC = PDMDEVINS_2_DATA_CC(pDevIns, PVIRTIOSCSICC);
2341
2342#if 0 /* need more info about how to use this event. The VirtIO 1.0 specification
2343 * lists several SCSI related event types but presumes the reader knows
2344 * how to use them without providing references. */
2345 virtioScsiR3ReportMediaChange(pDevIns, pThis, pTarget->uTarget);
2346#endif
2347
2348 if (pThisCC->pMediaNotify)
2349 {
2350 int rc = VMR3ReqCallNoWait(PDMDevHlpGetVM(pDevIns), VMCPUID_ANY,
2351 (PFNRT)pThisCC->pMediaNotify->pfnEjected, 2,
2352 pThisCC->pMediaNotify, pTarget->uTarget);
2353 AssertRC(rc);
2354 }
2355}
2356
2357/**
2358 * @interface_method_impl{PDMIMEDIAEXPORT,pfnIoReqStateChanged}
2359 */
2360static DECLCALLBACK(void) virtioScsiR3IoReqStateChanged(PPDMIMEDIAEXPORT pInterface, PDMMEDIAEXIOREQ hIoReq,
2361 void *pvIoReqAlloc, PDMMEDIAEXIOREQSTATE enmState)
2362{
2363 PVIRTIOSCSITARGET pTarget = RT_FROM_MEMBER(pInterface, VIRTIOSCSITARGET, IMediaExPort);
2364 PPDMDEVINS pDevIns = pTarget->pDevIns;
2365 PVIRTIOSCSI pThis = PDMDEVINS_2_DATA(pDevIns, PVIRTIOSCSI);
2366 PVIRTIOSCSICC pThisCC = PDMDEVINS_2_DATA_CC(pDevIns, PVIRTIOSCSICC);
2367 RT_NOREF(hIoReq, pvIoReqAlloc);
2368
2369 switch (enmState)
2370 {
2371 case PDMMEDIAEXIOREQSTATE_SUSPENDED:
2372 {
2373 /* Stop considering this request active */
2374 if (!ASMAtomicDecU32(&pThis->cActiveReqs) && pThisCC->fQuiescing)
2375 PDMDevHlpAsyncNotificationCompleted(pDevIns);
2376 break;
2377 }
2378 case PDMMEDIAEXIOREQSTATE_ACTIVE:
2379 ASMAtomicIncU32(&pThis->cActiveReqs);
2380 break;
2381 default:
2382 AssertMsgFailed(("Invalid request state given %u\n", enmState));
2383 }
2384}
2385
2386/**
2387 * @interface_method_impl{PDMDEVREGR3,pfnDestruct}
2388 */
2389static DECLCALLBACK(int) virtioScsiR3Destruct(PPDMDEVINS pDevIns)
2390{
2391 PDMDEV_CHECK_VERSIONS_RETURN_QUIET(pDevIns);
2392 PVIRTIOSCSI pThis = PDMDEVINS_2_DATA(pDevIns, PVIRTIOSCSI);
2393 PVIRTIOSCSICC pThisCC = PDMDEVINS_2_DATA_CC(pDevIns, PVIRTIOSCSICC);
2394
2395 RTMemFree(pThisCC->paTargetInstances);
2396 pThisCC->paTargetInstances = NULL;
2397 pThisCC->pMediaNotify = NULL;
2398
2399 for (unsigned qIdx = 0; qIdx < VIRTIOSCSI_QUEUE_CNT; qIdx++)
2400 {
2401 PVIRTIOSCSIWORKER pWorker = &pThis->aWorkers[qIdx];
2402 if (pWorker->hEvtProcess != NIL_SUPSEMEVENT)
2403 {
2404 PDMDevHlpSUPSemEventClose(pDevIns, pWorker->hEvtProcess);
2405 pWorker->hEvtProcess = NIL_SUPSEMEVENT;
2406 }
2407
2408 if (pThisCC->aWorkers[qIdx].pThread)
2409 {
2410 /* Destroy the thread. */
2411 int rcThread;
2412 int rc = PDMDevHlpThreadDestroy(pDevIns, pThisCC->aWorkers[qIdx].pThread, &rcThread);
2413 if (RT_FAILURE(rc) || RT_FAILURE(rcThread))
2414 AssertMsgFailed(("%s Failed to destroythread rc=%Rrc rcThread=%Rrc\n",
2415 __FUNCTION__, rc, rcThread));
2416 pThisCC->aWorkers[qIdx].pThread = NULL;
2417 }
2418 }
2419
2420 virtioCoreR3Term(pDevIns, &pThis->Virtio, &pThisCC->Virtio);
2421 return VINF_SUCCESS;
2422}
2423
2424/**
2425 * @interface_method_impl{PDMDEVREGR3,pfnConstruct}
2426 */
2427static DECLCALLBACK(int) virtioScsiR3Construct(PPDMDEVINS pDevIns, int iInstance, PCFGMNODE pCfg)
2428{
2429 PDMDEV_CHECK_VERSIONS_RETURN(pDevIns);
2430 PVIRTIOSCSI pThis = PDMDEVINS_2_DATA(pDevIns, PVIRTIOSCSI);
2431 PVIRTIOSCSICC pThisCC = PDMDEVINS_2_DATA_CC(pDevIns, PVIRTIOSCSICC);
2432 PCPDMDEVHLPR3 pHlp = pDevIns->pHlpR3;
2433
2434 /*
2435 * Quick initialization of the state data, making sure that the destructor always works.
2436 */
2437 pThisCC->pDevIns = pDevIns;
2438
2439 LogFunc(("PDM device instance: %d\n", iInstance));
2440 RTStrPrintf(pThis->szInstance, sizeof(pThis->szInstance), "VIRTIOSCSI%d", iInstance);
2441
2442 pThisCC->IBase.pfnQueryInterface = virtioScsiR3DeviceQueryInterface;
2443 pThisCC->ILeds.pfnQueryStatusLed = virtioScsiR3DeviceQueryStatusLed;
2444
2445 /*
2446 * Validate and read configuration.
2447 */
2448 PDMDEV_VALIDATE_CONFIG_RETURN(pDevIns, "NumTargets|Bootable", "");
2449
2450 int rc = pHlp->pfnCFGMQueryU32Def(pCfg, "NumTargets", &pThis->cTargets, 1);
2451 if (RT_FAILURE(rc))
2452 return PDMDEV_SET_ERROR(pDevIns, rc, N_("virtio-scsi configuration error: failed to read NumTargets as integer"));
2453 if (pThis->cTargets < 1 || pThis->cTargets > VIRTIOSCSI_MAX_TARGETS)
2454 return PDMDevHlpVMSetError(pDevIns, rc, RT_SRC_POS,
2455 N_("virtio-scsi configuration error: NumTargets=%u is out of range (1..%u)"),
2456 pThis->cTargets, VIRTIOSCSI_MAX_TARGETS);
2457
2458 rc = pHlp->pfnCFGMQueryBoolDef(pCfg, "Bootable", &pThis->fBootable, true);
2459 if (RT_FAILURE(rc))
2460 return PDMDEV_SET_ERROR(pDevIns, rc, N_("virtio-scsi configuration error: failed to read Bootable as boolean"));
2461
2462 LogRel(("%s: Targets=%u Bootable=%RTbool (unimplemented) R0Enabled=%RTbool RCEnabled=%RTbool\n",
2463 pThis->szInstance, pThis->cTargets, pThis->fBootable, pDevIns->fR0Enabled, pDevIns->fRCEnabled));
2464
2465
2466 /*
2467 * Do core virtio initialization.
2468 */
2469
2470 /* Configure virtio_scsi_config that transacts via VirtIO implementation's Dev. Specific Cap callbacks */
2471 pThis->virtioScsiConfig.uNumQueues = VIRTIOSCSI_REQ_QUEUE_CNT;
2472 pThis->virtioScsiConfig.uSegMax = VIRTIOSCSI_MAX_SEG_COUNT;
2473 pThis->virtioScsiConfig.uMaxSectors = VIRTIOSCSI_MAX_SECTORS_HINT;
2474 pThis->virtioScsiConfig.uCmdPerLun = VIRTIOSCSI_MAX_COMMANDS_PER_LUN;
2475 pThis->virtioScsiConfig.uEventInfoSize = sizeof(VIRTIOSCSI_EVENT_T); /*VirtIO 1.0 Spec says at least this size! */
2476 pThis->virtioScsiConfig.uSenseSize = VIRTIOSCSI_SENSE_SIZE_DEFAULT;
2477 pThis->virtioScsiConfig.uCdbSize = VIRTIOSCSI_CDB_SIZE_DEFAULT;
2478 pThis->virtioScsiConfig.uMaxChannel = VIRTIOSCSI_MAX_CHANNEL_HINT;
2479 pThis->virtioScsiConfig.uMaxTarget = pThis->cTargets;
2480 pThis->virtioScsiConfig.uMaxLun = VIRTIOSCSI_MAX_LUN;
2481
2482 /* Initialize the generic Virtio core: */
2483 pThisCC->Virtio.pfnStatusChanged = virtioScsiR3StatusChanged;
2484 pThisCC->Virtio.pfnQueueNotified = virtioScsiR3Notified;
2485 pThisCC->Virtio.pfnDevCapRead = virtioScsiR3DevCapRead;
2486 pThisCC->Virtio.pfnDevCapWrite = virtioScsiR3DevCapWrite;
2487
2488 VIRTIOPCIPARAMS VirtioPciParams;
2489 VirtioPciParams.uDeviceId = PCI_DEVICE_ID_VIRTIOSCSI_HOST;
2490 VirtioPciParams.uClassBase = PCI_CLASS_BASE_MASS_STORAGE;
2491 VirtioPciParams.uClassSub = PCI_CLASS_SUB_SCSI_STORAGE_CONTROLLER;
2492 VirtioPciParams.uClassProg = PCI_CLASS_PROG_UNSPECIFIED;
2493 VirtioPciParams.uSubsystemId = PCI_DEVICE_ID_VIRTIOSCSI_HOST; /* VirtIO 1.0 spec allows PCI Device ID here */
2494 VirtioPciParams.uInterruptLine = 0x00;
2495 VirtioPciParams.uInterruptPin = 0x01;
2496
2497 rc = virtioCoreR3Init(pDevIns, &pThis->Virtio, &pThisCC->Virtio, &VirtioPciParams, pThis->szInstance,
2498 VIRTIOSCSI_HOST_SCSI_FEATURES_OFFERED,
2499 &pThis->virtioScsiConfig /*pvDevSpecificCap*/, sizeof(pThis->virtioScsiConfig));
2500 if (RT_FAILURE(rc))
2501 return PDMDEV_SET_ERROR(pDevIns, rc, N_("virtio-scsi: failed to initialize VirtIO"));
2502
2503 /*
2504 * Initialize queues.
2505 */
2506
2507 virtioScsiSetVirtqNames(pThis);
2508
2509 /* Attach the queues and create worker threads for them: */
2510 for (uint16_t qIdx = 0; qIdx < VIRTIOSCSI_QUEUE_CNT; qIdx++)
2511 {
2512 rc = virtioCoreR3QueueAttach(&pThis->Virtio, qIdx, VIRTQNAME(qIdx));
2513 if (RT_FAILURE(rc))
2514 continue;
2515 if (qIdx == CONTROLQ_IDX || IS_REQ_QUEUE(qIdx))
2516 {
2517 rc = PDMDevHlpThreadCreate(pDevIns, &pThisCC->aWorkers[qIdx].pThread,
2518 (void *)(uintptr_t)qIdx, virtioScsiR3WorkerThread,
2519 virtioScsiR3WorkerWakeUp, 0, RTTHREADTYPE_IO, VIRTQNAME(qIdx));
2520 if (rc != VINF_SUCCESS)
2521 {
2522 LogRel(("Error creating thread for Virtual Queue %s: %Rrc\n", VIRTQNAME(qIdx), rc));
2523 return rc;
2524 }
2525
2526 rc = PDMDevHlpSUPSemEventCreate(pDevIns, &pThis->aWorkers[qIdx].hEvtProcess);
2527 if (RT_FAILURE(rc))
2528 return PDMDevHlpVMSetError(pDevIns, rc, RT_SRC_POS,
2529 N_("DevVirtioSCSI: Failed to create SUP event semaphore"));
2530 }
2531 pThis->afQueueAttached[qIdx] = true;
2532 }
2533
2534 /*
2535 * Initialize per device instances (targets).
2536 */
2537 Log2Func(("Probing %d targets ...\n", pThis->cTargets));
2538
2539 pThisCC->paTargetInstances = (PVIRTIOSCSITARGET)RTMemAllocZ(sizeof(VIRTIOSCSITARGET) * pThis->cTargets);
2540 if (!pThisCC->paTargetInstances)
2541 return PDMDEV_SET_ERROR(pDevIns, rc, N_("Failed to allocate memory for target states"));
2542
2543 for (uint32_t uTarget = 0; uTarget < pThis->cTargets; uTarget++)
2544 {
2545 PVIRTIOSCSITARGET pTarget = &pThisCC->paTargetInstances[uTarget];
2546
2547 if (RTStrAPrintf(&pTarget->pszTargetName, "VSCSI%u", uTarget) < 0)
2548 AssertLogRelFailedReturn(VERR_NO_MEMORY);
2549
2550 /* Initialize static parts of the device. */
2551 pTarget->pDevIns = pDevIns;
2552 pTarget->uTarget = uTarget;
2553
2554 pTarget->IBase.pfnQueryInterface = virtioScsiR3TargetQueryInterface;
2555
2556 /* IMediaPort and IMediaExPort interfaces provide callbacks for VD media and downstream driver access */
2557 pTarget->IMediaPort.pfnQueryDeviceLocation = virtioScsiR3QueryDeviceLocation;
2558 pTarget->IMediaPort.pfnQueryScsiInqStrings = NULL;
2559 pTarget->IMediaExPort.pfnIoReqCompleteNotify = virtioScsiR3IoReqFinish;
2560 pTarget->IMediaExPort.pfnIoReqCopyFromBuf = virtioScsiR3IoReqCopyFromBuf;
2561 pTarget->IMediaExPort.pfnIoReqCopyToBuf = virtioScsiR3IoReqCopyToBuf;
2562 pTarget->IMediaExPort.pfnIoReqStateChanged = virtioScsiR3IoReqStateChanged;
2563 pTarget->IMediaExPort.pfnMediumEjected = virtioScsiR3MediumEjected;
2564 pTarget->IMediaExPort.pfnIoReqQueryBuf = NULL; /* When used avoids copyFromBuf CopyToBuf*/
2565 pTarget->IMediaExPort.pfnIoReqQueryDiscardRanges = NULL;
2566
2567 pTarget->IBase.pfnQueryInterface = virtioScsiR3TargetQueryInterface;
2568 pTarget->ILed.pfnQueryStatusLed = virtioScsiR3TargetQueryStatusLed;
2569 pTarget->led.u32Magic = PDMLED_MAGIC;
2570
2571 LogFunc(("Attaching LUN: %s\n", pTarget->pszTargetName));
2572
2573 AssertReturn(uTarget < pThis->cTargets, VERR_PDM_NO_SUCH_LUN);
2574 rc = PDMDevHlpDriverAttach(pDevIns, uTarget, &pTarget->IBase, &pTarget->pDrvBase, pTarget->pszTargetName);
2575 if (RT_SUCCESS(rc))
2576 {
2577 pTarget->fPresent = true;
2578
2579 pTarget->pDrvMedia = PDMIBASE_QUERY_INTERFACE(pTarget->pDrvBase, PDMIMEDIA);
2580 AssertMsgReturn(VALID_PTR(pTarget->pDrvMedia),
2581 ("virtio-scsi configuration error: LUN#%d missing basic media interface!\n", uTarget),
2582 VERR_PDM_MISSING_INTERFACE);
2583 /* Get the extended media interface. */
2584 pTarget->pDrvMediaEx = PDMIBASE_QUERY_INTERFACE(pTarget->pDrvBase, PDMIMEDIAEX);
2585 AssertMsgReturn(VALID_PTR(pTarget->pDrvMediaEx),
2586 ("virtio-scsi configuration error: LUN#%d missing extended media interface!\n", uTarget),
2587 VERR_PDM_MISSING_INTERFACE);
2588
2589 rc = pTarget->pDrvMediaEx->pfnIoReqAllocSizeSet(pTarget->pDrvMediaEx, sizeof(VIRTIOSCSIREQ));
2590 AssertMsgReturn(VALID_PTR(pTarget->pDrvMediaEx),
2591 ("virtio-scsi configuration error: LUN#%u: Failed to set I/O request size!\n", uTarget),
2592 rc);
2593 }
2594 else if (rc == VERR_PDM_NO_ATTACHED_DRIVER)
2595 {
2596 pTarget->fPresent = false;
2597 pTarget->pDrvBase = NULL;
2598 Log(("virtio-scsi: no driver attached to device %s\n", pTarget->pszTargetName));
2599 rc = VINF_SUCCESS;
2600 }
2601 else
2602 {
2603 AssertLogRelMsgFailed(("virtio-scsi: Failed to attach %s: %Rrc\n", pTarget->pszTargetName, rc));
2604 return rc;
2605 }
2606 }
2607
2608 /*
2609 * Status driver (optional).
2610 */
2611 PPDMIBASE pUpBase;
2612 AssertCompile(PDM_STATUS_LUN >= VIRTIOSCSI_MAX_TARGETS);
2613 rc = PDMDevHlpDriverAttach(pDevIns, PDM_STATUS_LUN, &pThisCC->IBase, &pUpBase, "Status Port");
2614 if (RT_FAILURE(rc) && rc != VERR_PDM_NO_ATTACHED_DRIVER)
2615 return PDMDEV_SET_ERROR(pDevIns, rc, N_("Failed to attach the status LUN"));
2616 pThisCC->pMediaNotify = PDMIBASE_QUERY_INTERFACE(pUpBase, PDMIMEDIANOTIFY);
2617
2618
2619 /*
2620 * Register saved state.
2621 */
2622 rc = PDMDevHlpSSMRegister(pDevIns, VIRTIOSCSI_SAVED_STATE_VERSION, sizeof(*pThis),
2623 virtioScsiR3SaveExec, virtioScsiR3LoadExec);
2624 AssertRCReturn(rc, rc);
2625
2626 /*
2627 * Register the debugger info callback (ignore errors).
2628 */
2629 char szTmp[128];
2630 RTStrPrintf(szTmp, sizeof(szTmp), "%s%u", pDevIns->pReg->szName, pDevIns->iInstance);
2631 PDMDevHlpDBGFInfoRegister(pDevIns, szTmp, "virtio-scsi info", virtioScsiR3Info);
2632
2633 return rc;
2634}
2635
2636#else /* !IN_RING3 */
2637
2638/**
2639 * @callback_method_impl{PDMDEVREGR0,pfnConstruct}
2640 */
2641static DECLCALLBACK(int) virtioScsiRZConstruct(PPDMDEVINS pDevIns)
2642{
2643 PDMDEV_CHECK_VERSIONS_RETURN(pDevIns);
2644 PVIRTIOSCSI pThis = PDMDEVINS_2_DATA(pDevIns, PVIRTIOSCSI);
2645 PVIRTIOSCSICC pThisCC = PDMDEVINS_2_DATA_CC(pDevIns, PVIRTIOSCSICC);
2646
2647 return virtioCoreRZInit(pDevIns, &pThis->Virtio, &pThisCC->Virtio);
2648}
2649
2650#endif /* !IN_RING3 */
2651
2652
2653/**
2654 * The device registration structure.
2655 */
2656const PDMDEVREG g_DeviceVirtioSCSI =
2657{
2658 /* .u32Version = */ PDM_DEVREG_VERSION,
2659 /* .uReserved0 = */ 0,
2660 /* .szName = */ "virtio-scsi",
2661 /* .fFlags = */ PDM_DEVREG_FLAGS_DEFAULT_BITS | PDM_DEVREG_FLAGS_RZ | PDM_DEVREG_FLAGS_NEW_STYLE
2662 | PDM_DEVREG_FLAGS_FIRST_SUSPEND_NOTIFICATION
2663 | PDM_DEVREG_FLAGS_FIRST_POWEROFF_NOTIFICATION,
2664 /* .fClass = */ PDM_DEVREG_CLASS_STORAGE,
2665 /* .cMaxInstances = */ ~0U,
2666 /* .uSharedVersion = */ 42,
2667 /* .cbInstanceShared = */ sizeof(VIRTIOSCSI),
2668 /* .cbInstanceCC = */ sizeof(VIRTIOSCSICC),
2669 /* .cbInstanceRC = */ sizeof(VIRTIOSCSIRC),
2670 /* .cMaxPciDevices = */ 1,
2671 /* .cMaxMsixVectors = */ VBOX_MSIX_MAX_ENTRIES,
2672 /* .pszDescription = */ "Virtio Host SCSI.\n",
2673#if defined(IN_RING3)
2674 /* .pszRCMod = */ "VBoxDDRC.rc",
2675 /* .pszR0Mod = */ "VBoxDDR0.r0",
2676 /* .pfnConstruct = */ virtioScsiR3Construct,
2677 /* .pfnDestruct = */ virtioScsiR3Destruct,
2678 /* .pfnRelocate = */ NULL,
2679 /* .pfnMemSetup = */ NULL,
2680 /* .pfnPowerOn = */ NULL,
2681 /* .pfnReset = */ virtioScsiR3Reset,
2682 /* .pfnSuspend = */ virtioScsiR3Suspend,
2683 /* .pfnResume = */ virtioScsiR3Resume,
2684 /* .pfnAttach = */ virtioScsiR3Attach,
2685 /* .pfnDetach = */ virtioScsiR3Detach,
2686 /* .pfnQueryInterface = */ NULL,
2687 /* .pfnInitComplete = */ NULL,
2688 /* .pfnPowerOff = */ virtioScsiR3PowerOff,
2689 /* .pfnSoftReset = */ NULL,
2690 /* .pfnReserved0 = */ NULL,
2691 /* .pfnReserved1 = */ NULL,
2692 /* .pfnReserved2 = */ NULL,
2693 /* .pfnReserved3 = */ NULL,
2694 /* .pfnReserved4 = */ NULL,
2695 /* .pfnReserved5 = */ NULL,
2696 /* .pfnReserved6 = */ NULL,
2697 /* .pfnReserved7 = */ NULL,
2698#elif defined(IN_RING0)
2699 /* .pfnEarlyConstruct = */ NULL,
2700 /* .pfnConstruct = */ virtioScsiRZConstruct,
2701 /* .pfnDestruct = */ NULL,
2702 /* .pfnFinalDestruct = */ NULL,
2703 /* .pfnRequest = */ NULL,
2704 /* .pfnReserved0 = */ NULL,
2705 /* .pfnReserved1 = */ NULL,
2706 /* .pfnReserved2 = */ NULL,
2707 /* .pfnReserved3 = */ NULL,
2708 /* .pfnReserved4 = */ NULL,
2709 /* .pfnReserved5 = */ NULL,
2710 /* .pfnReserved6 = */ NULL,
2711 /* .pfnReserved7 = */ NULL,
2712#elif defined(IN_RC)
2713 /* .pfnConstruct = */ virtioScsiRZConstruct,
2714 /* .pfnReserved0 = */ NULL,
2715 /* .pfnReserved1 = */ NULL,
2716 /* .pfnReserved2 = */ NULL,
2717 /* .pfnReserved3 = */ NULL,
2718 /* .pfnReserved4 = */ NULL,
2719 /* .pfnReserved5 = */ NULL,
2720 /* .pfnReserved6 = */ NULL,
2721 /* .pfnReserved7 = */ NULL,
2722#else
2723# error "Not in IN_RING3, IN_RING0 or IN_RC!"
2724#endif
2725 /* .u32VersionEnd = */ PDM_DEVREG_VERSION
2726};
2727
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