VirtualBox

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

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