VirtualBox

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

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

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