VirtualBox

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

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

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