VirtualBox

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

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

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