VirtualBox

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

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

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