VirtualBox

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

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

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