VirtualBox

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

Last change on this file since 81122 was 81122, checked in by vboxsync, 6 years ago

Storage/DevVirtioSCSI.cpp: Got MSI-X support implemented and a few other small inconsequential tweaks
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 101.8 KB
Line 
1/* $Id: DevVirtioSCSI.cpp 81122 2019-10-07 08:54:00Z vboxsync $ $Revision: 81122 $ $Date: 2019-10-07 08:54:00 +0000 (Mon, 07 Oct 2019) $ $Author: vboxsync $ */
2/** @file
3 * VBox storage devices - Virtio SCSI Driver
4 *
5 */
6
7/*
8 * Copyright (C) 2006-2019 Oracle Corporation
9 *
10 * This file is part of VirtualBox Open Source Edition (OSE), as
11 * available from http://www.virtualbox.org. This file is free software;
12 * you can redistribute it and/or modify it under the terms of the GNU
13 * General Public License (GPL) as published by the Free Software
14 * Foundation, in version 2 as it comes in the "COPYING" file of the
15 * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
16 * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
17 */
18
19
20/*********************************************************************************************************************************
21* Header Files *
22*********************************************************************************************************************************/
23//#define LOG_GROUP LOG_GROUP_DRV_SCSI
24#define LOG_GROUP LOG_GROUP_DEV_VIRTIO
25
26#include <VBox/vmm/pdmdev.h>
27#include <VBox/vmm/pdmstorageifs.h>
28#include <VBox/vmm/pdmcritsect.h>
29#include <VBox/msi.h>
30#include <VBox/version.h>
31#include <VBox/log.h>
32#include <iprt/errcore.h>
33#include <iprt/assert.h>
34#include <iprt/string.h>
35#include "../build/VBoxDD.h"
36#include <VBox/scsi.h>
37#ifdef IN_RING3
38# include <iprt/alloc.h>
39# include <iprt/memcache.h>
40# include <iprt/semaphore.h>
41# include <iprt/sg.h>
42# include <iprt/param.h>
43# include <iprt/uuid.h>
44#endif
45#include "../VirtIO/Virtio_1_0.h"
46
47#include "VBoxSCSI.h"
48#include "VBoxDD.h"
49
50/*
51 * RT log-levels used:
52 *
53 * Level 1: The most important (but usually rare) things to note
54 * Level 2: SCSI command logging
55 * Level 3: Vector and I/O transfer summary (shows what client sent an expects and fulfillment)
56 * Level 6: Device ⟷ Guest Driver negotation, traffic, notifications and state handling
57 * Level 12: Brief formatted hex dumps of I/O data
58 */
59
60#define LUN0 0
61/**
62 * @name VirtIO 1.0 SCSI Host feature bits (See VirtIO 1.0 specification, Section 5.6.3)
63 * @{ */
64#define VIRTIO_SCSI_F_INOUT RT_BIT_64(0) /** Request is device readable AND writeable */
65#define VIRTIO_SCSI_F_HOTPLUG RT_BIT_64(1) /** Host allows hotplugging SCSI LUNs & targets */
66#define VIRTIO_SCSI_F_CHANGE RT_BIT_64(2) /** Host LUNs chgs via VIRTIOSCSI_T_PARAM_CHANGE evt */
67#define VIRTIO_SCSI_F_T10_PI RT_BIT_64(3) /** Add T10 port info (DIF/DIX) in SCSI req hdr */
68/** @} */
69
70
71#define VIRTIOSCSI_HOST_SCSI_FEATURES_ALL \
72 (VIRTIO_SCSI_F_INOUT | VIRTIO_SCSI_F_HOTPLUG | VIRTIO_SCSI_F_CHANGE | VIRTIO_SCSI_F_T10_PI)
73
74#define VIRTIOSCSI_HOST_SCSI_FEATURES_NONE 0
75
76#define VIRTIOSCSI_HOST_SCSI_FEATURES_OFFERED \
77 VIRTIOSCSI_HOST_SCSI_FEATURES_NONE
78
79/*
80 * TEMPORARY NOTE: following parameter is set to 1 for early development. Will be increased later
81 */
82//#define VIRTIOSCSI_REQ_QUEUE_CNT 2 /**< Number of req queues exposed by dev. */
83//#define VIRTIOSCSI_QUEUE_CNT VIRTIOSCSI_REQ_QUEUE_CNT + 2
84//#define VIRTIOSCSI_MAX_LUN 256 /* < VirtIO specification, section 5.6.4 */
85//#define VIRTIOSCSI_MAX_COMMANDS_PER_LUN 1 /* < T.B.D. What is a good value for this? */
86//#define VIRTIOSCSI_MAX_SEG_COUNT 1024 /* < T.B.D. What is a good value for this? */
87//#define VIRTIOSCSI_MAX_SECTORS_HINT 0x10000 /* < VirtIO specification, section 5.6.4 */
88//#define VIRTIOSCSI_MAX_CHANNEL_HINT 0 /* < VirtIO specification, section 5.6.4 should be 0 */
89//#define VIRTIOSCSI_SAVED_STATE_MINOR_VERSION 0x01 /**< SSM version # */
90
91
92#define VIRTIOSCSI_REQ_QUEUE_CNT 1 /**< Number of req queues exposed by dev. */
93#define VIRTIOSCSI_QUEUE_CNT VIRTIOSCSI_REQ_QUEUE_CNT + 2
94#define VIRTIOSCSI_MAX_LUN 256 /* < VirtIO specification, section 5.6.4 */
95#define VIRTIOSCSI_MAX_COMMANDS_PER_LUN 128 /* < T.B.D. What is a good value for this? */
96#define VIRTIOSCSI_MAX_SEG_COUNT 126 /* < T.B.D. What is a good value for this? */
97#define VIRTIOSCSI_MAX_SECTORS_HINT 0x10000 /* < VirtIO specification, section 5.6.4 */
98#define VIRTIOSCSI_MAX_CHANNEL_HINT 0 /* < VirtIO specification, section 5.6.4 should be 0 */
99#define VIRTIOSCSI_SAVED_STATE_MINOR_VERSION 0x01 /**< SSM version # */
100
101
102#define PCI_DEVICE_ID_VIRTIOSCSI_HOST 0x1048 /**< Informs guest driver of type of VirtIO device */
103#define PCI_CLASS_BASE_MASS_STORAGE 0x01 /**< PCI Mass Storage device class */
104#define PCI_CLASS_SUB_SCSI_STORAGE_CONTROLLER 0x00 /**< PCI SCSI Controller subclass */
105#define PCI_CLASS_PROG_UNSPECIFIED 0x00 /**< Programming interface. N/A. */
106#define VIRTIOSCSI_PCI_CLASS 0x01 /**< Base class Mass Storage? */
107
108
109#define VIRTIOSCSI_SENSE_SIZE_DEFAULT 96 /**< VirtIO 1.0: 96 on reset, guest can change */
110#define VIRTIOSCSI_CDB_SIZE_DEFAULT 32 /**< VirtIO 1.0: 32 on reset, guest can change */
111#define VIRTIOSCSI_PI_BYTES_IN 1 /**< Value TBD (see section 5.6.6.1) */
112#define VIRTIOSCSI_PI_BYTES_OUT 1 /**< Value TBD (see section 5.6.6.1) */
113#define VIRTIOSCSI_DATA_OUT 512 /**< Value TBD (see section 5.6.6.1) */
114
115/**
116 * VirtIO SCSI Host Device device-specific queue indicies
117 *
118 * Virtqs (and their indices) are specified for a SCSI Host Device as described in the VirtIO 1.0 specification
119 * section 5.6. Thus there is no need to explicitly indicate the number of queues needed by this device. The number
120 * of req queues is variable and determined by virtio_scsi_config.num_queues. See VirtIO 1.0 spec section 5.6.4
121 */
122#define CONTROLQ_IDX 0 /**< Spec-defined Index of control queue */
123#define EVENTQ_IDX 1 /**< Spec-defined Index of event queue */
124#define VIRTQ_REQ_BASE 2 /**< Spec-defined base index of request queues */
125
126#define QUEUENAME(qIdx) (pThis->szQueueNames[qIdx]) /**< Macro to get queue name from its index */
127#define CBQUEUENAME(qIdx) RTStrNLen(QUEUENAME(qIdx), sizeof(QUEUENAME(qIdx)))
128
129
130#define IS_REQ_QUEUE(qIdx) (qIdx >= VIRTQ_REQ_BASE && qIdx < VIRTIOSCSI_QUEUE_CNT)
131
132/**
133 * Resolves to boolean true if uOffset matches a field offset and size exactly,
134 * (or if 64-bit field, if it accesses either 32-bit part as a 32-bit access)
135 * It is *assumed* this critereon is mandated by section 4.1.3.1 of the VirtIO 1.0 spec)
136 * This macro can be re-written to allow unaligned access to a field (within bounds).
137 *
138 * @param member - Member of VIRTIO_PCI_COMMON_CFG_T
139 * @result - true or false
140 */
141#define MATCH_SCSI_CONFIG(member) \
142 (RT_SIZEOFMEMB(VIRTIOSCSI_CONFIG_T, member) == 8 \
143 && ( uOffset == RT_UOFFSETOF(VIRTIOSCSI_CONFIG_T, member) \
144 || uOffset == RT_UOFFSETOF(VIRTIOSCSI_CONFIG_T, member) + sizeof(uint32_t)) \
145 && cb == sizeof(uint32_t)) \
146 || (uOffset == RT_UOFFSETOF(VIRTIOSCSI_CONFIG_T, member) \
147 && cb == RT_SIZEOFMEMB(VIRTIOSCSI_CONFIG_T, member))
148
149#define LOG_ACCESSOR(member) \
150 virtioLogMappedIoValue(__FUNCTION__, #member, RT_SIZEOFMEMB(VIRTIOSCSI_CONFIG_T, member), \
151 pv, cb, uIntraOffset, fWrite, false, 0);
152
153#define SCSI_CONFIG_ACCESSOR(member) \
154 do \
155 { \
156 uint32_t uIntraOffset = uOffset - RT_UOFFSETOF(VIRTIOSCSI_CONFIG_T, member); \
157 if (fWrite) \
158 memcpy(((char *)&pThis->virtioScsiConfig.member) + uIntraOffset, (const char *)pv, cb); \
159 else \
160 memcpy((char *)pv, (const char *)(((char *)&pThis->virtioScsiConfig.member) + uIntraOffset), cb); \
161 LOG_ACCESSOR(member); \
162 } while(0)
163
164#define SCSI_CONFIG_ACCESSOR_READONLY(member) \
165 do \
166 { \
167 uint32_t uIntraOffset = uOffset - RT_UOFFSETOF(VIRTIOSCSI_CONFIG_T, member); \
168 if (fWrite) \
169 LogFunc(("Guest attempted to write readonly virtio_pci_common_cfg.%s\n", #member)); \
170 else \
171 { \
172 memcpy((char *)pv, (const char *)(((char *)&pThis->virtioScsiConfig.member) + uIntraOffset), cb); \
173 LOG_ACCESSOR(member); \
174 } \
175 } while(0)
176
177#define VIRTIO_IN_DIRECTION(pMediaExTxDirEnumValue) \
178 pMediaExTxDirEnumValue == PDMMEDIAEXIOREQSCSITXDIR_FROM_DEVICE
179
180#define VIRTIO_OUT_DIRECTION(pMediaExTxDirEnumValue) \
181 pMediaExTxDirEnumValue == PDMMEDIAEXIOREQSCSITXDIR_TO_DEVICE
182/**
183 * The following struct is the VirtIO SCSI Host Device device-specific configuration described
184 * in section 5.6.4 of the VirtIO 1.0 spec. The VBox VirtIO framework calls back to this driver
185 * to handle MMIO accesses to the device-specific configuration parameters whenever any bytes in the
186 * device-specific region areaccessed, since which the generic portion shouldn't know anything about
187 * the device-specific VirtIO cfg data.
188 */
189typedef struct virtio_scsi_config
190{
191 uint32_t uNumQueues; /**< num_queues # of req q's exposed by dev */
192 uint32_t uSegMax; /**< seg_max Max # of segs allowed in cmd */
193 uint32_t uMaxSectors; /**< max_sectors Hint to guest max xfer to use */
194 uint32_t uCmdPerLun; /**< cmd_per_lun Max # of link cmd sent per lun */
195 uint32_t uEventInfoSize; /**< event_info_size Fill max, evtq bufs */
196 uint32_t uSenseSize; /**< sense_size Max sense data size dev writes */
197 uint32_t uCdbSize; /**< cdb_size Max CDB size driver writes */
198 uint16_t uMaxChannel; /**< max_channel Hint to guest driver */
199 uint16_t uMaxTarget; /**< max_target Hint to guest driver */
200 uint32_t uMaxLun; /**< max_lun Hint to guest driver */
201} VIRTIOSCSI_CONFIG_T, PVIRTIOSCSI_CONFIG_T;
202
203/**
204 * @name VirtIO 1.0 SCSI Host Device device specific control types
205 * @{ */
206#define VIRTIOSCSI_T_NO_EVENT 0
207#define VIRTIOSCSI_T_TRANSPORT_RESET 1
208#define VIRTIOSCSI_T_ASYNC_NOTIFY 2 /**< Asynchronous notification */
209#define VIRTIOSCSI_T_PARAM_CHANGE 3
210/** @} */
211
212/**
213 * Device operation: eventq
214 */
215#define VIRTIOSCSI_T_EVENTS_MISSED 0x80000000
216typedef struct virtio_scsi_event {
217 // Device-writable part
218 uint32_t uEvent; /**< event: */
219 uint8_t uVirtioLun[8]; /**< lun */
220 uint32_t uReason; /**< reason */
221} VIRTIOSCSI_EVENT_T, *PVIRTIOSCSI_EVENT_T;
222
223/**
224 * @name VirtIO 1.0 SCSI Host Device device specific event types
225 * @{ */
226#define VIRTIOSCSI_EVT_RESET_HARD 0 /**< */
227#define VIRTIOSCSI_EVT_RESET_RESCAN 1 /**< */
228#define VIRTIOSCSI_EVT_RESET_REMOVED 2 /**< */
229/** @} */
230
231
232#pragma pack(1)
233
234/**
235 * Device operation: reqestq
236 */
237struct REQ_CMD_HDR
238{
239 uint8_t uVirtioLun[8]; /**< lun */
240 uint64_t uId; /**< id */
241 uint8_t uTaskAttr; /**< task_attr */
242 uint8_t uPrio; /**< prio */
243 uint8_t uCrn; /**< crn */
244};
245
246struct REQ_CMD_PI
247{
248 uint32_t uPiBytesOut; /**< pi_bytesout */
249 uint32_t uPiBytesIn; /**< pi_bytesin */
250};
251
252struct REQ_RESP_HDR
253{
254 uint32_t uSenseLen; /**< sense_len */
255 uint32_t uResidual; /**< residual */
256 uint16_t uStatusQualifier; /**< status_qualifier */
257 uint8_t uStatus; /**< status SCSI status code */
258 uint8_t uResponse; /**< response */
259};
260
261typedef struct virtio_scsi_req_cmd
262{
263 /* Device-readable section */
264
265 struct REQ_CMD_HDR cmdHdr;
266 uint8_t uCdb[1]; /**< cdb */
267
268 struct REQ_CMD_PI piHdr; /** T10 Pi block integrity (optional feature) */
269 uint8_t uPiOut[1]; /**< pi_out[] T10 pi block integrity */
270 uint8_t uDataOut[1]; /**< dataout */
271
272 /** Device writable section */
273
274 struct REQ_RESP_HDR respHdr;
275 uint8_t uSense[1]; /**< sense */
276 uint8_t uPiIn[1]; /**< pi_in[] T10 Pi block integrity */
277 uint8_t uDataIn[1]; /**< detain; */
278
279} VIRTIOSCSI_REQ_CMD_T, *PVIRTIOSCSI_REQ_CMD_T;
280#pragma pack()
281
282/**
283 * @name VirtIO 1.0 SCSI Host Device Req command-specific response values
284 * @{ */
285#define VIRTIOSCSI_S_OK 0 /**< control, command */
286#define VIRTIOSCSI_S_OVERRUN 1 /**< control */
287#define VIRTIOSCSI_S_ABORTED 2 /**< control */
288#define VIRTIOSCSI_S_BAD_TARGET 3 /**< control, command */
289#define VIRTIOSCSI_S_RESET 4 /**< control */
290#define VIRTIOSCSI_S_BUSY 5 /**< control, command */
291#define VIRTIOSCSI_S_TRANSPORT_FAILURE 6 /**< control, command */
292#define VIRTIOSCSI_S_TARGET_FAILURE 7 /**< control, command */
293#define VIRTIOSCSI_S_NEXUS_FAILURE 8 /**< control, command */
294#define VIRTIOSCSI_S_FAILURE 9 /**< control, command */
295#define VIRTIOSCSI_S_INCORRECT_LUN 12 /**< command */
296/** @} */
297
298/**
299 * @name VirtIO 1.0 SCSI Host Device command-specific task_attr values
300 * @{ */
301#define VIRTIOSCSI_S_SIMPLE 0 /**< */
302#define VIRTIOSCSI_S_ORDERED 1 /**< */
303#define VIRTIOSCSI_S_HEAD 2 /**< */
304#define VIRTIOSCSI_S_ACA 3 /**< */
305/** @} */
306
307/**
308 * @name VirtIO 1.0 SCSI Host Device Control command before we know type (5.6.6.2)
309 * @{ */
310typedef struct virtio_scsi_ctrl
311{
312 uint32_t uType;
313} VIRTIOSCSI_CTRL_T, *PVIRTIOSCSI_CTRL_T;
314
315/**
316 * @name VirtIO 1.0 SCSI Host Device command-specific TMF values
317 * @{ */
318#define VIRTIOSCSI_T_TMF 0 /**< */
319#define VIRTIOSCSI_T_TMF_ABORT_TASK 0 /**< */
320#define VIRTIOSCSI_T_TMF_ABORT_TASK_SET 1 /**< */
321#define VIRTIOSCSI_T_TMF_CLEAR_ACA 2 /**< */
322#define VIRTIOSCSI_T_TMF_CLEAR_TASK_SET 3 /**< */
323#define VIRTIOSCSI_T_TMF_I_T_NEXUS_RESET 4 /**< */
324#define VIRTIOSCSI_T_TMF_LOGICAL_UNIT_RESET 5 /**< */
325#define VIRTIOSCSI_T_TMF_QUERY_TASK 6 /**< */
326#define VIRTIOSCSI_T_TMF_QUERY_TASK_SET 7 /**< */
327/*** @} */
328
329#pragma pack(1)
330typedef struct virtio_scsi_ctrl_tmf
331{
332 // Device-readable part
333 uint32_t uType; /** type */
334 uint32_t uSubtype; /** subtype */
335 uint8_t uScsiLun[8]; /** lun */
336 uint64_t uId; /** id */
337 // Device-writable part
338 uint8_t uResponse; /** response */
339} VIRTIOSCSI_CTRL_TMF_T, *PVIRTIOSCSI_CTRL_TMF_T;
340#pragma pack()
341
342/**
343 * @name VirtIO 1.0 SCSI Host Device device specific tmf control response values
344 * @{ */
345#define VIRTIOSCSI_S_FUNCTION_COMPLETE 0 /**< */
346#define VIRTIOSCSI_S_FUNCTION_SUCCEEDED 10 /**< */
347#define VIRTIOSCSI_S_FUNCTION_REJECTED 11 /**< */
348/** @} */
349
350#define VIRTIOSCSI_T_AN_QUERY 1 /** Asynchronous notification query */
351#define VIRTIOSCSI_T_AN_SUBSCRIBE 2 /** Asynchronous notification subscription */
352
353#pragma pack(1)
354typedef struct virtio_scsi_ctrl_an
355{
356 // Device-readable part
357 uint32_t uType; /** type */
358 uint8_t uScsiLun[8]; /** lun */
359 uint32_t uEventsRequested; /** event_requested */
360 // Device-writable part
361 uint32_t uEventActual; /** event_actual */
362 uint8_t uResponse; /** response */
363} VIRTIOSCSI_CTRL_AN, *PVIRTIOSCSI_CTRL_AN_T;
364#pragma pack()
365
366/**
367 * @name VirtIO 1.0 SCSI Host Device device specific tmf control response values
368 * @{ */
369#define VIRTIOSCSI_EVT_ASYNC_OPERATIONAL_CHANGE 2 /**< */
370#define VIRTIOSCSI_EVT_ASYNC_POWER_MGMT 4 /**< */
371#define VIRTIOSCSI_EVT_ASYNC_EXTERNAL_REQUEST 8 /**< */
372#define VIRTIOSCSI_EVT_ASYNC_MEDIA_CHANGE 16 /**< */
373#define VIRTIOSCSI_EVT_ASYNC_MULTI_HOST 32 /**< */
374#define VIRTIOSCSI_EVT_ASYNC_DEVICE_BUSY 64 /**< */
375/** @} */
376
377#define SUBSCRIBABLE_EVENTS \
378 VIRTIOSCSI_EVT_ASYNC_OPERATIONAL_CHANGE \
379 & VIRTIOSCSI_EVT_ASYNC_POWER_MGMT \
380 & VIRTIOSCSI_EVT_ASYNC_EXTERNAL_REQUEST \
381 & VIRTIOSCSI_EVT_ASYNC_MEDIA_CHANGE \
382 & VIRTIOSCSI_EVT_ASYNC_MULTI_HOST \
383 & VIRTIOSCSI_EVT_ASYNC_DEVICE_BUSY
384
385/**
386 * Worker thread context
387 */
388typedef struct WORKER
389{
390 R3PTRTYPE(PPDMTHREAD) pThread; /**< pointer to worker thread's handle */
391 SUPSEMEVENT hEvtProcess; /**< handle of associated sleep/wake-up semaphore */
392 bool fSleeping; /**< Flags whether worker thread is sleeping or not */
393 bool fNotified; /**< Flags whether worker thread notified */
394} WORKER, *PWORKER;
395
396/**
397 * State of a target attached to the VirtIO SCSI Host
398 */
399typedef struct VIRTIOSCSITARGET
400{
401 /** Pointer to PCI device that owns this target instance. - R3 pointer */
402 R3PTRTYPE(struct VIRTIOSCSI *) pVirtioScsi;
403
404 /** Pointer to attached driver's base interface. */
405 R3PTRTYPE(PPDMIBASE) pDrvBase;
406
407 /** Target number (PDM LUN) */
408 RTUINT iTarget;
409
410 /** Target Description */
411 char * pszTargetName;
412
413 /** Target base interface. */
414 PDMIBASE IBase;
415
416 /** Flag whether device is present. */
417 bool fPresent;
418
419 /** Media port interface. */
420 PDMIMEDIAPORT IMediaPort;
421
422 /** Pointer to the attached driver's media interface. */
423 R3PTRTYPE(PPDMIMEDIA) pDrvMedia;
424
425 /** Extended media port interface. */
426 PDMIMEDIAEXPORT IMediaExPort;
427
428 PPDMIMEDIANOTIFY pMediaNotify;
429
430 /** Pointer to the attached driver's extended media interface. */
431 R3PTRTYPE(PPDMIMEDIAEX) pDrvMediaEx;
432
433 /** Status LED interface */
434 PDMILEDPORTS ILed;
435
436 /** The status LED state for this device. */
437 PDMLED led;
438
439} VIRTIOSCSITARGET, *PVIRTIOSCSITARGET;
440
441/**
442 * PDM instance data (state) for VirtIO Host SCSI device
443 *
444 * @extends PDMPCIDEV
445 */
446typedef struct VIRTIOSCSI
447{
448 /* Opaque handle to VirtIO common framework (must be first item
449 * in this struct so PDMINS_2_DATA macro's casting works) */
450 VIRTIOHANDLE hVirtio;
451
452 /** Number of targets detected */
453 uint64_t cTargets;
454
455 R3PTRTYPE(PVIRTIOSCSITARGET) paTargetInstances;
456#if HC_ARCH_BITS == 32
457 RTR3PTR R3PtrPadding0;
458#endif
459
460 /** Per device-bound virtq worker-thread contexts (eventq slot unused) */
461 WORKER aWorker[VIRTIOSCSI_QUEUE_CNT];
462
463 bool fBootable;
464 bool fRCEnabled;
465 bool fR0Enabled;
466 /** Instance name */
467 const char szInstance[16];
468
469 /** Device-specific spec-based VirtIO queuenames */
470 const char szQueueNames[VIRTIOSCSI_QUEUE_CNT][VIRTIO_MAX_QUEUE_NAME_SIZE];
471
472 /** Track which VirtIO queues we've attached to */
473 bool fQueueAttached[VIRTIOSCSI_QUEUE_CNT];
474
475 /** Device base interface. */
476 PDMIBASE IBase;
477
478 /** Pointer to the device instance. - R3 ptr. */
479 PPDMDEVINSR3 pDevInsR3;
480
481 /** Pointer to the device instance. - R0 ptr. */
482 PPDMDEVINSR0 pDevInsR0;
483
484 /** Pointer to the device instance. - RC ptr. */
485 PPDMDEVINSRC pDevInsRC;
486
487 /** Status Target: LEDs port interface. */
488 PDMILEDPORTS ILeds;
489
490 /** Status Target: Partner of ILeds. */
491 R3PTRTYPE(PPDMILEDCONNECTORS) pLedsConnector;
492
493 /** IMediaExPort: Media ejection notification */
494 R3PTRTYPE(PPDMIMEDIANOTIFY) pMediaNotify;
495
496 /** Queue to send tasks to R3. - HC ptr */
497 R3PTRTYPE(PPDMQUEUE) pNotifierQueueR3;
498
499 /** The support driver session handle. */
500 R3R0PTRTYPE(PSUPDRVSESSION) pSupDrvSession;
501
502 /** Mask of VirtIO Async Event types this device will deliver */
503 uint32_t uAsyncEvtsEnabled;
504
505 /** Total number of requests active across all targets */
506 volatile uint32_t cActiveReqs;
507
508 /** True if PDMDevHlpAsyncNotificationCompleted should be called when port goes idle */
509 bool volatile fSignalIdle;
510
511 /** Events the guest has subscribed to get notifications of */
512 uint32_t uSubscribedEvents;
513
514 /** Set if events missed due to lack of bufs avail on eventq */
515 bool fEventsMissed;
516
517 /** VirtIO Host SCSI device runtime configuration parameters */
518 VIRTIOSCSI_CONFIG_T virtioScsiConfig;
519
520 /** True if the guest/driver and VirtIO framework are in the ready state */
521 unsigned fVirtioReady;
522
523 /** True if VIRTIO_SCSI_F_T10_PI was negotiated */
524 unsigned fHasT10pi;
525
526 /** True if VIRTIO_SCSI_F_T10_PI was negotiated */
527 unsigned fHasHotplug;
528
529 /** True if VIRTIO_SCSI_F_T10_PI was negotiated */
530 unsigned fHasInOutBufs;
531
532 /** True if VIRTIO_SCSI_F_T10_PI was negotiated */
533 unsigned fHasLunChange;
534
535 /** True if in the process of resetting */
536 unsigned fResetting;
537
538 /** True if in the process of quiescing I/O */
539 unsigned fQuiescing;
540
541} VIRTIOSCSI, *PVIRTIOSCSI;
542
543/**
544 * Request structure for IMediaEx (Associated Interfaces implemented by DrvSCSI)
545 * (NOTE: cbIn, cbOUt, cbDataOut mostly for debugging)
546 */
547typedef struct VIRTIOSCSIREQ
548{
549 PDMMEDIAEXIOREQ hIoReq; /**< Handle of I/O request */
550 PVIRTIOSCSITARGET pTarget; /**< Target */
551 uint16_t qIdx; /**< Index of queue this request arrived on */
552 uint32_t cbPiOut; /**< Size of T10 pi in buffer */
553 uint8_t *pbPiOut; /**< Address of pi out buffer */
554 uint8_t *pbDataOut; /**< dataout */
555 uint32_t cbDataOut; /**< size of dataout buffer */
556 uint32_t cbPiIn; /**< Size of T10 pi buffer */
557 uint8_t *pbPiIn; /**< Address of pi in buffer */
558 uint32_t cbDataIn; /**< Size of datain buffer */
559 uint8_t *pbDataIn; /**< datain */
560 uint32_t cbSense; /**< Size of sense buffer */
561 size_t uSenseLen; /**< Receives # bytes written into sense buffer */
562 uint8_t *pbSense; /**< Pointer to R3 sense buffer */
563 PDMMEDIAEXIOREQSCSITXDIR enmTxDir; /**< Receives transfer direction of I/O req */
564 uint8_t uStatus; /**< SCSI status code */
565 PVIRTIO_DESC_CHAIN_T pDescChain; /**< Prepared desc chain pulled from virtq avail ring */
566} VIRTIOSCSIREQ;
567
568DECLINLINE(bool) isBufZero(uint8_t *pv, uint32_t cb)
569{
570 for (uint32_t i = 0; i < cb; i++)
571 if (pv[i])
572 return false;
573 return true;
574}
575
576DECLINLINE(const char *) virtioGetTxDirText(uint32_t enmTxDir)
577{
578 switch (enmTxDir)
579 {
580 case PDMMEDIAEXIOREQSCSITXDIR_UNKNOWN: return "<UNKNOWN>";
581 case PDMMEDIAEXIOREQSCSITXDIR_FROM_DEVICE: return "<DEV-TO-GUEST>";
582 case PDMMEDIAEXIOREQSCSITXDIR_TO_DEVICE: return "<GUEST-TO-DEV>";
583 case PDMMEDIAEXIOREQSCSITXDIR_NONE: return "<NONE>";
584 default: return "<BAD ENUM>";
585 }
586}
587
588DECLINLINE(const char *) virtioGetTMFTypeText(uint32_t uSubType)
589{
590 switch (uSubType)
591 {
592 case VIRTIOSCSI_T_TMF_ABORT_TASK: return "ABORT TASK";
593 case VIRTIOSCSI_T_TMF_ABORT_TASK_SET: return "ABORT TASK SET";
594 case VIRTIOSCSI_T_TMF_CLEAR_ACA: return "CLEAR ACA";
595 case VIRTIOSCSI_T_TMF_CLEAR_TASK_SET: return "CLEAR TASK SET";
596 case VIRTIOSCSI_T_TMF_I_T_NEXUS_RESET: return "I T NEXUS RESET";
597 case VIRTIOSCSI_T_TMF_LOGICAL_UNIT_RESET: return "LOGICAL UNIT RESET";
598 case VIRTIOSCSI_T_TMF_QUERY_TASK: return "QUERY TASK";
599 case VIRTIOSCSI_T_TMF_QUERY_TASK_SET: return "QUERY TASK SET";
600 default: return "<unknown>";
601 }
602}
603
604DECLINLINE(const char *) virtioGetReqRespText(uint32_t vboxRc)
605{
606 switch (vboxRc)
607 {
608 case VIRTIOSCSI_S_OK: return "OK";
609 case VIRTIOSCSI_S_OVERRUN: return "OVERRRUN";
610 case VIRTIOSCSI_S_ABORTED: return "ABORTED";
611 case VIRTIOSCSI_S_BAD_TARGET: return "BAD TARGET";
612 case VIRTIOSCSI_S_RESET: return "RESET";
613 case VIRTIOSCSI_S_TRANSPORT_FAILURE: return "TRANSPORT FAILURE";
614 case VIRTIOSCSI_S_TARGET_FAILURE: return "TARGET FAILURE";
615 case VIRTIOSCSI_S_NEXUS_FAILURE: return "NEXUS FAILURE";
616 case VIRTIOSCSI_S_BUSY: return "BUSY";
617 case VIRTIOSCSI_S_FAILURE: return "FAILURE";
618 default: return "<unknown>";
619 }
620}
621
622DECLINLINE(const char *) virtioGetCtrlRespText(uint32_t vboxRc)
623{
624 switch (vboxRc)
625 {
626 case VIRTIOSCSI_S_OK: return "OK/COMPLETE";
627 case VIRTIOSCSI_S_BAD_TARGET: return "BAD TARGET";
628 case VIRTIOSCSI_S_BUSY: return "BUSY";
629 case VIRTIOSCSI_S_NEXUS_FAILURE: return "NEXUS FAILURE";
630 case VIRTIOSCSI_S_TRANSPORT_FAILURE: return "TRANSPORT FAILURE";
631 case VIRTIOSCSI_S_FAILURE: return "FAILURE";
632 case VIRTIOSCSI_S_INCORRECT_LUN: return "INCORRECT LUN";
633 case VIRTIOSCSI_S_FUNCTION_SUCCEEDED: return "FUNCTION SUCCEEDED";
634 case VIRTIOSCSI_S_FUNCTION_REJECTED: return "FUNCTION REJECTED";
635 default: return "<unknown>";
636 }
637}
638
639DECLINLINE(void) virtioGetControlAsyncMaskText(char *pszOutput, uint32_t cbOutput, uint32_t uAsyncTypesMask)
640{
641 RTStrPrintf(pszOutput, cbOutput, "%s%s%s%s%s%s",
642 (uAsyncTypesMask & VIRTIOSCSI_EVT_ASYNC_OPERATIONAL_CHANGE) ? "CHANGE_OPERATION " : "",
643 (uAsyncTypesMask & VIRTIOSCSI_EVT_ASYNC_POWER_MGMT) ? "POWER_MGMT " : "",
644 (uAsyncTypesMask & VIRTIOSCSI_EVT_ASYNC_EXTERNAL_REQUEST) ? "EXTERNAL_REQ " : "",
645 (uAsyncTypesMask & VIRTIOSCSI_EVT_ASYNC_MEDIA_CHANGE) ? "MEDIA_CHANGE " : "",
646 (uAsyncTypesMask & VIRTIOSCSI_EVT_ASYNC_MULTI_HOST) ? "MULTI_HOST " : "",
647 (uAsyncTypesMask & VIRTIOSCSI_EVT_ASYNC_DEVICE_BUSY) ? "DEVICE_BUSY " : "");
648}
649
650uint8_t virtioScsiEstimateCdbLen(uint8_t uCmd, uint8_t cbMax)
651{
652 if (uCmd < 0x1f)
653 return 6;
654 else if (uCmd >= 0x20 && uCmd < 0x60)
655 return 10;
656 else if (uCmd >= 0x60 && uCmd < 0x80)
657 return cbMax;
658 else if (uCmd >= 0x80 && uCmd < 0xa0)
659 return 16;
660 else if (uCmd >= 0xa0 && uCmd < 0xC0)
661 return 12;
662 else
663 return cbMax;
664}
665
666typedef struct VIRTIOSCSIREQ *PVIRTIOSCSIREQ;
667
668#ifdef BOOTABLE_SUPPORT_TBD
669/** @callback_method_impl{FNIOMIOPORTIN} */
670static DECLCALLBACK(int) virtioScsiBiosIoPortRead(PPDMDEVINS pDevIns, void *pvUser, RTIOPORT uPort, uint8_t *pbDst,
671 uint32_t *pcTransfers, unsigned cb);
672{
673}
674/** @callback_method_impl{FNIOMIOPORTOUT} */
675static DECLCALLBACK(int) virtioScsiBiosIoPortWrite(PPDMDEVINS pDevIns, void *pvUser, RTIOPORT uPort, uint32_t u32, unsigned cb);
676{
677}
678/** @callback_method_impl{FNIOMIOPORTOUTSTRING} */
679static DECLCALLBACK(int) virtioScsiBiosIoPortWriteStr(PPDMDEVINS pDevIns, void *pvUser, RTIOPORT uPort, const uint8_t *pbSrc,
680 uint32_t *pcTransfers, unsigned cb);
681{
682}
683/** @callback_method_impl{FNIOMIOPORTINSTRING} */
684static DECLCALLBACK(int) virtioScsiBiosIoPortReadStr(PPDMDEVINS pDevIns, void *pvUser, RTIOPORT uPort, uint8_t *pbDst,
685 uint32_t *pcTransfers, unsigned cb);
686{
687}
688#endif
689
690/**
691 * @interface_method_impl{PDMIMEDIAEXPORT,pfnIoReqCopyFromBuf}
692 */
693static DECLCALLBACK(int) virtioScsiIoReqCopyFromBuf(PPDMIMEDIAEXPORT pInterface, PDMMEDIAEXIOREQ hIoReq,
694 void *pvIoReqAlloc, uint32_t offDst, PRTSGBUF pSgBuf, size_t cbCopy)
695{
696 RT_NOREF2(hIoReq, pInterface);
697 PVIRTIOSCSIREQ pReq = (PVIRTIOSCSIREQ)pvIoReqAlloc;
698 if (pReq->pbDataIn)
699 RTSgBufCopyToBuf(pSgBuf, pReq->pbDataIn + offDst, cbCopy);
700 return VINF_SUCCESS;
701}
702
703/**
704 * @interface_method_impl{PDMIMEDIAEXPORT,pfnIoReqCopyToBuf}
705 */
706static DECLCALLBACK(int) virtioScsiIoReqCopyToBuf(PPDMIMEDIAEXPORT pInterface, PDMMEDIAEXIOREQ hIoReq,
707 void *pvIoReqAlloc, uint32_t offSrc, PRTSGBUF pSgBuf, size_t cbCopy)
708{
709 RT_NOREF2(hIoReq, pInterface);
710 PVIRTIOSCSIREQ pReq = (PVIRTIOSCSIREQ)pvIoReqAlloc;
711 if (pReq->pbDataOut)
712 RTSgBufCopyFromBuf(pSgBuf, pReq->pbDataOut + offSrc, cbCopy);
713
714 return VINF_SUCCESS;
715}
716
717static int virtioScsiSendEvent(PVIRTIOSCSI pThis, uint16_t uTarget, uint32_t uEventType, uint32_t uReason)
718{
719
720 VIRTIOSCSI_EVENT_T event;
721 event.uEvent = uEventType;
722 event.uReason = uReason;
723 event.uVirtioLun[0] = 1;
724 event.uVirtioLun[1] = uTarget;
725 event.uVirtioLun[2] = (LUN0 >> 8) & 0x40;
726 event.uVirtioLun[3] = LUN0 & 0xff;
727 event.uVirtioLun[4] = event.uVirtioLun[5] = event.uVirtioLun[6] = event.uVirtioLun[7] = 0;
728
729 switch(uEventType)
730 {
731 case VIRTIOSCSI_T_NO_EVENT:
732 if (uEventType & VIRTIOSCSI_T_EVENTS_MISSED)
733 Log6Func(("(target=%d, LUN=%d) Warning driver that events were missed\n", uTarget, LUN0));
734 else
735 Log6Func(("(target=%d, LUN=%d): Warning event info guest queued is shorter than configured\n",
736 uTarget, LUN0));
737 break;
738 case VIRTIOSCSI_T_TRANSPORT_RESET:
739 switch(uReason)
740 {
741 case VIRTIOSCSI_EVT_RESET_REMOVED:
742 Log6Func(("(target=%d, LUN=%d): Target or LUN removed\n", uTarget, LUN0));
743 break;
744 case VIRTIOSCSI_EVT_RESET_RESCAN:
745 Log6Func(("(target=%d, LUN=%d): Target or LUN added\n", uTarget, LUN0));
746 break;
747 case VIRTIOSCSI_EVT_RESET_HARD:
748 Log6Func(("(target=%d, LUN=%d): Target was reset\n", uTarget, LUN0));
749 break;
750 }
751 break;
752 case VIRTIOSCSI_T_ASYNC_NOTIFY:
753 char szTypeText[128];
754 virtioGetControlAsyncMaskText(szTypeText, sizeof(szTypeText), uReason);
755 Log6Func(("(target=%d, LUN=%d): Delivering subscribed async notification %s\n",
756 uTarget, LUN0, szTypeText));
757 break;
758 case VIRTIOSCSI_T_PARAM_CHANGE:
759 LogFunc(("(target=%d, LUN=%d): PARAM_CHANGE sense code: 0x%x sense qualifier: 0x%x\n",
760 uTarget, LUN0, uReason & 0xff, (uReason >> 8) & 0xff));
761 break;
762 default:
763 Log6Func(("(target=%d, LUN=%d): Unknown event type: %d, ignoring\n",
764 uTarget, LUN0, uEventType));
765 return VINF_SUCCESS;
766 }
767
768 if (virtioQueueIsEmpty(pThis->hVirtio, EVENTQ_IDX))
769 {
770 LogFunc(("eventq is empty, events missed (driver didn't preload queue)!\n"));
771 ASMAtomicWriteBool(&pThis->fEventsMissed, true);
772 return VINF_SUCCESS;
773 }
774
775 PVIRTIO_DESC_CHAIN_T pDescChain;
776 virtioQueueGet(pThis->hVirtio, EVENTQ_IDX, &pDescChain, true);
777
778 RTSGBUF reqSegBuf;
779 RTSGSEG aReqSegs[] = { { &event, sizeof(event) } };
780 RTSgBufInit(&reqSegBuf, aReqSegs, sizeof(aReqSegs) / sizeof(RTSGSEG));
781
782 virtioQueuePut (pThis->hVirtio, EVENTQ_IDX, &reqSegBuf, pDescChain, true);
783 virtioQueueSync(pThis->hVirtio, EVENTQ_IDX);
784
785 return VINF_SUCCESS;
786}
787
788static void virtioScsiFreeReq(PVIRTIOSCSITARGET pTarget, PVIRTIOSCSIREQ pReq)
789{
790 RTMemFree(pReq->pbSense);
791 RTMemFree(pReq->pbPiIn);
792 RTMemFree(pReq->pbDataIn);
793 pTarget->pDrvMediaEx->pfnIoReqFree(pTarget->pDrvMediaEx, pReq->hIoReq);
794}
795
796/**
797 * This is called to complete a request immediately
798 *
799 * @param pThis - PDM driver instance state
800 * @param qIdx - Queue index
801 * @param pDescChain - Pointer to pre-processed descriptor chain pulled from virtq
802 * @param pRespHdr - Response header
803 * @param pbSense - Pointer to sense buffer or NULL if none.
804 *
805 * @returns virtual box status code
806 */
807static int virtioScsiReqErr(PVIRTIOSCSI pThis, uint16_t qIdx, PVIRTIO_DESC_CHAIN_T pDescChain,
808 struct REQ_RESP_HDR *pRespHdr, uint8_t *pbSense)
809{
810 uint8_t *abSenseBuf = (uint8_t *)RTMemAllocZ(pThis->virtioScsiConfig.uSenseSize);
811 AssertReturn(abSenseBuf, VERR_NO_MEMORY);
812
813 const char *pszCtrlRespText = virtioGetCtrlRespText(pRespHdr->uResponse);
814 Log2Func((" status: %s response: %s\n",
815 SCSIStatusText(pRespHdr->uStatus), pszCtrlRespText));
816 RT_NOREF(pszCtrlRespText);
817
818 RTSGSEG aReqSegs[2];
819 aReqSegs[0].cbSeg = sizeof(pRespHdr);
820 aReqSegs[0].pvSeg = pRespHdr;
821 aReqSegs[1].cbSeg = pThis->virtioScsiConfig.uSenseSize;
822 aReqSegs[1].pvSeg = abSenseBuf;
823
824 if (pbSense && pRespHdr->uSenseLen)
825 memcpy(abSenseBuf, pbSense, pRespHdr->uSenseLen);
826 else
827 pRespHdr->uSenseLen = 0;
828
829 RTSGBUF reqSegBuf;
830 RTSgBufInit(&reqSegBuf, aReqSegs, RT_ELEMENTS(aReqSegs));
831
832 if (pThis->fResetting)
833 pRespHdr->uResponse = VIRTIOSCSI_S_RESET;
834
835 virtioQueuePut(pThis->hVirtio, qIdx, &reqSegBuf, pDescChain, true /* fFence */);
836 virtioQueueSync(pThis->hVirtio, qIdx);
837
838 RTMemFree(abSenseBuf);
839
840 if (!ASMAtomicDecU32(&pThis->cActiveReqs) && pThis->fQuiescing)
841 PDMDevHlpAsyncNotificationCompleted(pThis->CTX_SUFF(pDevIns));
842
843 Log2(("---------------------------------------------------------------------------------\n"));
844
845 return VINF_SUCCESS;
846}
847
848/**
849 * @interface_method_impl{PDMIMEDIAEXPORT,pfnIoReqCompleteNotify}
850 */
851static DECLCALLBACK(int) virtioScsiIoReqFinish(PPDMIMEDIAEXPORT pInterface, PDMMEDIAEXIOREQ hIoReq,
852 void *pvIoReqAlloc, int rcReq)
853{
854 RT_NOREF(pInterface);
855
856 PVIRTIOSCSIREQ pReq = (PVIRTIOSCSIREQ)pvIoReqAlloc;
857 PVIRTIOSCSITARGET pTarget = pReq->pTarget;
858 PVIRTIOSCSI pThis = pTarget->pVirtioScsi;
859 PPDMIMEDIAEX pIMediaEx = pTarget->pDrvMediaEx;
860
861 size_t cbResidual = 0;
862 int rc = pIMediaEx->pfnIoReqQueryResidual(pIMediaEx, hIoReq, &cbResidual);
863 AssertRC(rc);
864
865 size_t cbXfer = 0;
866 rc = pIMediaEx->pfnIoReqQueryXferSize(pIMediaEx, hIoReq, &cbXfer);
867 AssertRC(rc);
868
869 Assert(!(cbXfer & 0xffffffff00000000));
870 uint32_t cbXfer32 = cbXfer & 0xffffffff;
871
872 struct REQ_RESP_HDR respHdr = { 0 };
873 respHdr.uSenseLen = pReq->pbSense[2] == SCSI_SENSE_NONE ? 0 : (uint32_t)pReq->uSenseLen;
874 AssertMsg(!(cbResidual & 0xffffffff00000000),
875 ("WARNING: Residual size larger than sizeof(uint32_t), truncating"));
876 respHdr.uResidual = (uint32_t)(cbResidual & 0xffffffff);
877 respHdr.uStatus = pReq->uStatus;
878
879 /* VirtIO 1.0 spec 5.6.6.1.1 says device MUST return a VirtIO response byte value.
880 * Some are returned during the submit phase, and a few are not mapped at all,
881 * wherein anything that can't map specifically gets mapped to VIRTIOSCSI_S_FAILURE
882 */
883 if (pThis->fResetting)
884 respHdr.uResponse = VIRTIOSCSI_S_RESET;
885 else
886 {
887 switch(rcReq)
888 {
889 case SCSI_STATUS_OK:
890 {
891 if (pReq->uStatus != SCSI_STATUS_CHECK_CONDITION)
892 {
893 respHdr.uResponse = VIRTIOSCSI_S_OK;
894 break;
895 }
896 uint8_t uSenseKey = pReq->pbSense[2];
897 switch (uSenseKey)
898 {
899 case SCSI_SENSE_ABORTED_COMMAND:
900 respHdr.uResponse = VIRTIOSCSI_S_ABORTED;
901 break;
902 case SCSI_SENSE_COPY_ABORTED:
903 respHdr.uResponse = VIRTIOSCSI_S_ABORTED;
904 break;
905 case SCSI_SENSE_UNIT_ATTENTION:
906 respHdr.uResponse = VIRTIOSCSI_S_TARGET_FAILURE;
907 break;
908 case SCSI_SENSE_HARDWARE_ERROR:
909 respHdr.uResponse = VIRTIOSCSI_S_TARGET_FAILURE;
910 break;
911 case SCSI_SENSE_NOT_READY:
912 respHdr.uResponse = VIRTIOSCSI_S_BUSY; /* e.g. re-tryable */
913 break;
914 default:
915 respHdr.uResponse = VIRTIOSCSI_S_FAILURE;
916 break;
917 }
918 break;
919 }
920 case SCSI_STATUS_CHECK_CONDITION:
921 {
922 uint8_t uSenseKey = pReq->pbSense[2];
923 switch (uSenseKey)
924 {
925 case SCSI_SENSE_ABORTED_COMMAND:
926 respHdr.uResponse = VIRTIOSCSI_S_ABORTED;
927 break;
928 case SCSI_SENSE_COPY_ABORTED:
929 respHdr.uResponse = VIRTIOSCSI_S_ABORTED;
930 break;
931 case SCSI_SENSE_UNIT_ATTENTION:
932 respHdr.uResponse = VIRTIOSCSI_S_TARGET_FAILURE;
933 break;
934 case SCSI_SENSE_HARDWARE_ERROR:
935 respHdr.uResponse = VIRTIOSCSI_S_TARGET_FAILURE;
936 break;
937 case SCSI_SENSE_NOT_READY:
938 respHdr.uResponse = VIRTIOSCSI_S_BUSY; /* e.g. re-tryable */
939 break;
940 default:
941 respHdr.uResponse = VIRTIOSCSI_S_FAILURE;
942 break;
943 }
944 }
945 break;
946
947 default:
948 respHdr.uResponse = VIRTIOSCSI_S_FAILURE;
949 break;
950 }
951 }
952
953 const char *getReqRespText = virtioGetReqRespText(respHdr.uResponse);
954 Log2Func(("status: (%d) %s, response: (%d) %s\n",
955 pReq->uStatus, SCSIStatusText(pReq->uStatus),
956 respHdr.uResponse, getReqRespText));
957 RT_NOREF(getReqRespText);
958
959 if (RT_FAILURE(rcReq))
960 Log2Func(("rcReq: %s\n", RTErrGetDefine(rcReq)));
961
962 if (LogIs3Enabled())
963 {
964 LogFunc(("cbDataIn = %u, cbDataOut = %u (cbIn = %u, cbOut = %u)\n",
965 pReq->cbDataIn, pReq->cbDataOut, pReq->pDescChain->cbPhysDst, pReq->pDescChain->cbVirtSrc));
966 LogFunc(("xfer = %lu, residual = %u\n", cbXfer, cbResidual));
967 const char *pszTxDirText = virtioGetTxDirText(pReq->enmTxDir);
968 LogFunc(("xfer direction: %s, sense written = %d, sense size = %d\n",
969 pszTxDirText, respHdr.uSenseLen, pThis->virtioScsiConfig.uSenseSize));
970 RT_NOREF(pszTxDirText);
971 }
972
973 if (respHdr.uSenseLen && LogIs2Enabled())
974 {
975 LogFunc(("Sense: %s\n", SCSISenseText(pReq->pbSense[2])));
976 LogFunc(("Sense Ext3: %s\n", SCSISenseExtText(pReq->pbSense[12], pReq->pbSense[13])));
977 }
978
979 if (LogIs12Enabled())
980 {
981 uint32_t cb = RT_MIN(cbXfer32, 256);
982 if (VIRTIO_IN_DIRECTION(pReq->enmTxDir))
983 {
984 if (!isBufZero(pReq->pbDataIn, cb))
985 {
986 Log(("datain[showing the first %d of %d total bytes xferred]:\n", cb, cbXfer32));
987 VIRTIO_HEX_DUMP(RTLOGGRPFLAGS_LEVEL_12, pReq->pbDataIn, cb, 0, 0);
988 }
989 else
990 Log12Func(("First %d bytes transfered in this req are 0 --\n", cb));
991 }
992 else
993 if (VIRTIO_OUT_DIRECTION(pReq->enmTxDir))
994 {
995 if (!isBufZero(pReq->pbDataOut, cb))
996 {
997 Log(("dataout[showing the first %d of %d total bytes xferred]:\n", cb, cbXfer32));
998 VIRTIO_HEX_DUMP(RTLOGGRPFLAGS_LEVEL_12, pReq->pbDataOut, cb, 0, 0);
999 }
1000 else
1001 Log12Func(("First %d bytes transfered in this req are 0 --\n", cb));
1002 }
1003 }
1004
1005 int cSegs = 0;
1006
1007 if ( (VIRTIO_IN_DIRECTION(pReq->enmTxDir) && cbXfer32 > pReq->cbDataIn)
1008 || (VIRTIO_OUT_DIRECTION(pReq->enmTxDir) && cbXfer32 > pReq->cbDataOut))
1009 {
1010 Log2Func((" * * * * Data overrun, returning sense\n"));
1011 uint8_t abSense[] = { RT_BIT(7) | SCSI_SENSE_RESPONSE_CODE_CURR_FIXED,
1012 0, SCSI_SENSE_ILLEGAL_REQUEST, 0, 0, 0, 0, 10, 0, 0, 0 };
1013 respHdr.uSenseLen = sizeof(abSense);
1014 respHdr.uStatus = SCSI_STATUS_CHECK_CONDITION;
1015 respHdr.uResponse = VIRTIOSCSI_S_OVERRUN;
1016 respHdr.uResidual = pReq->cbDataIn;
1017
1018 virtioScsiReqErr(pThis, pReq->qIdx, pReq->pDescChain, &respHdr, abSense);
1019 return VINF_SUCCESS;
1020 }
1021 else
1022 {
1023 Assert(pReq->pbSense != NULL);
1024
1025 RTSGSEG aReqSegs[4];
1026 aReqSegs[cSegs].pvSeg = &respHdr;
1027 aReqSegs[cSegs++].cbSeg = sizeof(respHdr);
1028
1029 aReqSegs[cSegs].pvSeg = pReq->pbSense;
1030 aReqSegs[cSegs++].cbSeg = pReq->cbSense; /* VirtIO 1.0 spec 5.6.4/5.6.6.1 */
1031
1032 if (pReq->cbPiIn)
1033 {
1034 aReqSegs[cSegs].pvSeg = pReq->pbPiIn;
1035 aReqSegs[cSegs++].cbSeg = pReq->cbPiIn;
1036 }
1037 if (pReq->cbDataIn)
1038 {
1039 aReqSegs[cSegs].pvSeg = pReq->pbDataIn;
1040 aReqSegs[cSegs++].cbSeg = cbXfer;
1041 }
1042 RTSGBUF reqSegBuf;
1043 RTSgBufInit(&reqSegBuf, aReqSegs, cSegs);
1044
1045 size_t cbReqSgBuf = RTSgBufCalcTotalLength(&reqSegBuf);
1046 AssertMsgReturn(cbReqSgBuf <= pReq->pDescChain->cbPhysDst,
1047 ("Guest expected less req data (space needed: %d, avail: %d)\n",
1048 cbReqSgBuf, pReq->pDescChain->cbPhysDst),
1049 VERR_BUFFER_OVERFLOW);
1050
1051 virtioQueuePut(pThis->hVirtio, pReq->qIdx, &reqSegBuf, pReq->pDescChain, true /* fFence TBD */);
1052 virtioQueueSync(pThis->hVirtio, pReq->qIdx);
1053
1054
1055 Log2(("-----------------------------------------------------------------------------------------\n"));
1056 }
1057
1058 virtioScsiFreeReq(pTarget, pReq);
1059
1060 if (!ASMAtomicDecU32(&pThis->cActiveReqs) && pThis->fQuiescing)
1061 PDMDevHlpAsyncNotificationCompleted(pThis->CTX_SUFF(pDevIns));
1062
1063 return VINF_SUCCESS;
1064}
1065
1066static int virtioScsiReqSubmit(PVIRTIOSCSI pThis, uint16_t qIdx, PVIRTIO_DESC_CHAIN_T pDescChain)
1067{
1068 ASMAtomicIncU32(&pThis->cActiveReqs);
1069
1070 PVIRTIOSCSI_REQ_CMD_T pVirtqReq = (PVIRTIOSCSI_REQ_CMD_T)pDescChain->pVirtSrc;
1071
1072 uint8_t uTarget = pVirtqReq->cmdHdr.uVirtioLun[1];
1073 uint32_t uScsiLun = (pVirtqReq->cmdHdr.uVirtioLun[2] << 8 | pVirtqReq->cmdHdr.uVirtioLun[3]) & 0x3fff;
1074 PVIRTIOSCSITARGET pTarget = &pThis->paTargetInstances[uTarget];
1075
1076 LogFunc(("[%s] (Target: %d LUN: %d) CDB: %.*Rhxs\n",
1077 SCSICmdText(pVirtqReq->uCdb[0]), uTarget, uScsiLun,
1078 virtioScsiEstimateCdbLen(pVirtqReq->uCdb[0],
1079 pThis->virtioScsiConfig.uCdbSize), pVirtqReq->uCdb));
1080
1081 Log3Func(("id: %RX64, attr: %x, prio: %d, crn: %x\n",
1082 pVirtqReq->cmdHdr.uId, pVirtqReq->cmdHdr.uTaskAttr, pVirtqReq->cmdHdr.uPrio, pVirtqReq->cmdHdr.uCrn));
1083
1084 /*
1085 * Calculate request offsets
1086 */
1087 uint32_t cbPiIn = 0, cbPiOut = 0, cbPiHdr = 0;
1088 off_t piOutOff = 0;
1089
1090 if (pThis->fHasT10pi)
1091 {
1092 cbPiIn = pVirtqReq->piHdr.uPiBytesOut;
1093 cbPiOut = pVirtqReq->piHdr.uPiBytesIn;
1094 cbPiHdr = sizeof(REQ_CMD_PI) + cbPiOut;
1095 piOutOff = sizeof(REQ_CMD_HDR) + pThis->virtioScsiConfig.uCdbSize + sizeof(REQ_CMD_PI);
1096 }
1097
1098 off_t uDataOutOff = sizeof(REQ_CMD_HDR) + pThis->virtioScsiConfig.uCdbSize + cbPiHdr;
1099 off_t uDataInOff = sizeof(REQ_RESP_HDR) + pThis->virtioScsiConfig.uSenseSize + cbPiIn;
1100 uint8_t *pbDataOut = (uint8_t *)((uint64_t)pVirtqReq + uDataOutOff);
1101 uint32_t cbDataOut = pDescChain->cbVirtSrc - uDataOutOff;
1102 uint32_t cbDataIn = pDescChain->cbPhysDst - uDataInOff;
1103
1104 /**
1105 * Handle submission errors
1106 */
1107 if (RT_UNLIKELY(pThis->fResetting))
1108 {
1109 Log2Func(("Aborting req submission because reset is in progress\n"));
1110 struct REQ_RESP_HDR respHdr = { 0 };
1111 respHdr.uSenseLen = 0;
1112 respHdr.uStatus = SCSI_STATUS_OK;
1113 respHdr.uResponse = VIRTIOSCSI_S_RESET;
1114 respHdr.uResidual = cbDataIn + cbDataOut;
1115 virtioScsiReqErr(pThis, qIdx, pDescChain, &respHdr, NULL);
1116 return VINF_SUCCESS;
1117 }
1118 else
1119 if (RT_UNLIKELY(uTarget >= pThis->cTargets || uScsiLun != 0))
1120 {
1121 Log2Func(("Error submitting request to bad target (%d) or bad LUN (%d)\n", uTarget, uScsiLun));
1122 uint8_t abSense[] = { RT_BIT(7) | SCSI_SENSE_RESPONSE_CODE_CURR_FIXED,
1123 0, SCSI_SENSE_ILLEGAL_REQUEST,
1124 0, 0, 0, 0, 10, SCSI_ASC_LOGICAL_UNIT_NOT_SUPPORTED, 0, 0 };
1125 struct REQ_RESP_HDR respHdr = { 0 };
1126 respHdr.uSenseLen = sizeof(abSense);
1127 respHdr.uStatus = SCSI_STATUS_CHECK_CONDITION;
1128 respHdr.uResponse = (uTarget > pThis->cTargets) ? VIRTIOSCSI_S_BAD_TARGET : VIRTIOSCSI_S_OK;
1129 respHdr.uResidual = cbDataOut + cbDataIn;
1130 virtioScsiReqErr(pThis, qIdx, pDescChain, &respHdr, abSense);
1131 return VINF_SUCCESS;
1132 }
1133 else
1134 if (RT_UNLIKELY(!pTarget->fPresent))
1135 {
1136 Log2Func(("Error submitting request, target not present!!\n"));
1137 uint8_t abSense[] = { RT_BIT(7) | SCSI_SENSE_RESPONSE_CODE_CURR_FIXED,
1138 0, SCSI_SENSE_NOT_READY, 0, 0, 0, 0, 10, 0, 0, 0 };
1139 struct REQ_RESP_HDR respHdr = { 0 };
1140 respHdr.uSenseLen = sizeof(abSense);
1141 respHdr.uStatus = SCSI_STATUS_CHECK_CONDITION;
1142 respHdr.uResponse = VIRTIOSCSI_S_TARGET_FAILURE;
1143 respHdr.uResidual = cbDataIn + cbDataOut;
1144 virtioScsiReqErr(pThis, qIdx, pDescChain, &respHdr , abSense);
1145 return VINF_SUCCESS;
1146 }
1147 else
1148 if (RT_UNLIKELY(cbDataIn && cbDataOut && !pThis->fHasInOutBufs)) /* VirtIO 1.0, 5.6.6.1.1 */
1149 {
1150 Log2Func(("Error submitting request, got datain & dataout bufs w/o INOUT feature negotated\n"));
1151 uint8_t abSense[] = { RT_BIT(7) | SCSI_SENSE_RESPONSE_CODE_CURR_FIXED,
1152 0, SCSI_SENSE_ILLEGAL_REQUEST, 0, 0, 0, 0, 10, 0, 0, 0 };
1153 struct REQ_RESP_HDR respHdr = { 0 };
1154 respHdr.uSenseLen = sizeof(abSense);
1155 respHdr.uStatus = SCSI_STATUS_CHECK_CONDITION;
1156 respHdr.uResponse = VIRTIOSCSI_S_FAILURE;
1157 respHdr.uResidual = cbDataIn + cbDataOut;
1158 virtioScsiReqErr(pThis, qIdx, pDescChain, &respHdr , abSense);
1159 return VINF_SUCCESS;
1160 }
1161
1162 /*
1163 * Have underlying driver allocate a req of size set during initialization of this device.
1164 */
1165 PDMMEDIAEXIOREQ hIoReq = NULL;
1166 PVIRTIOSCSIREQ pReq;
1167 PPDMIMEDIAEX pIMediaEx = pTarget->pDrvMediaEx;
1168
1169 int rc = pIMediaEx->pfnIoReqAlloc(pIMediaEx, &hIoReq, (void **)&pReq, 0 /* uIoReqId */,
1170 PDMIMEDIAEX_F_SUSPEND_ON_RECOVERABLE_ERR);
1171
1172 AssertMsgRCReturn(rc, ("Failed to allocate I/O request, rc=%Rrc\n", rc), rc);
1173
1174 /*
1175 * Prepare req's parameters for submission
1176 */
1177 if (pThis->fHasT10pi)
1178 {
1179 pReq->cbPiOut = cbPiOut;
1180 pReq->pbPiOut = (uint8_t *)((uint64_t)pVirtqReq + piOutOff);
1181 pReq->cbPiIn = cbPiIn;
1182 pReq->pbPiIn = (uint8_t *)RTMemAlloc(cbPiIn);
1183 AssertMsgReturn(pReq->pbPiIn, ("Out of memory allocating pi_in buffer"), VERR_NO_MEMORY);
1184 }
1185
1186 pReq->hIoReq = hIoReq;
1187 pReq->pTarget = pTarget;
1188 pReq->qIdx = qIdx;
1189 pReq->cbDataOut = cbDataOut;
1190 pReq->pbDataOut = cbDataOut ? pbDataOut : 0;
1191 pReq->pDescChain = pDescChain;
1192 pReq->cbSense = pThis->virtioScsiConfig.uSenseSize;
1193 pReq->pbSense = (uint8_t *)RTMemAlloc(pReq->cbSense);
1194 AssertMsgReturn(pReq->pbSense, ("Out of memory allocating sense buffer"), VERR_NO_MEMORY);
1195
1196 if (cbDataIn)
1197 {
1198 pReq->cbDataIn = cbDataIn;
1199 pReq->pbDataIn = (uint8_t *)RTMemAlloc(cbDataIn);
1200 AssertMsgReturn(pReq->pbDataIn, ("Out of memory allocating datain buffer"), VERR_NO_MEMORY);
1201 }
1202
1203 rc = pIMediaEx->pfnIoReqSendScsiCmd(pIMediaEx, pReq->hIoReq, uScsiLun,
1204 pVirtqReq->uCdb, (size_t)pThis->virtioScsiConfig.uCdbSize,
1205 PDMMEDIAEXIOREQSCSITXDIR_UNKNOWN, &pReq->enmTxDir,
1206 (size_t)RT_MAX(cbDataIn, cbDataOut),
1207 pReq->pbSense, (size_t)pReq->cbSense, &pReq->uSenseLen,
1208 &pReq->uStatus, 30 * RT_MS_1SEC);
1209
1210 if (rc != VINF_PDM_MEDIAEX_IOREQ_IN_PROGRESS)
1211 {
1212 /*
1213 * Getting here means the request failed in early in the submission to the lower level driver,
1214 * and there will be no callback to the finished/completion function for this request
1215 */
1216 Log2Func(("Request submission error from lower-level driver\n"));
1217 uint8_t uASC, uASCQ = 0;
1218 switch (rc)
1219 {
1220 case VERR_NO_MEMORY:
1221 uASC = SCSI_ASC_SYSTEM_RESOURCE_FAILURE;
1222 break;
1223 default:
1224 uASC = SCSI_ASC_INTERNAL_TARGET_FAILURE;
1225 break;
1226 }
1227 uint8_t abSense[] = { RT_BIT(7) | SCSI_SENSE_RESPONSE_CODE_CURR_FIXED,
1228 0, SCSI_SENSE_VENDOR_SPECIFIC,
1229 0, 0, 0, 0, 10, uASC, uASCQ, 0 };
1230 struct REQ_RESP_HDR respHdr = { 0 };
1231 respHdr.uSenseLen = sizeof(abSense);
1232 respHdr.uStatus = SCSI_STATUS_CHECK_CONDITION;
1233 respHdr.uResponse = VIRTIOSCSI_S_FAILURE;
1234 respHdr.uResidual = cbDataIn + cbDataOut;
1235 virtioScsiReqErr(pThis, qIdx, pDescChain, &respHdr, abSense);
1236 virtioScsiFreeReq(pTarget, pReq);
1237 return VINF_SUCCESS;
1238 }
1239
1240 return VINF_SUCCESS;
1241}
1242
1243static int virtioScsiCtrl(PVIRTIOSCSI pThis, uint16_t qIdx, PVIRTIO_DESC_CHAIN_T pDescChain)
1244{
1245 RT_NOREF2(pThis, qIdx);
1246
1247 uint8_t uResponse = VIRTIOSCSI_S_OK;
1248
1249 PVIRTIOSCSI_CTRL_T pScsiCtrl = (PVIRTIOSCSI_CTRL_T)pDescChain->pVirtSrc;
1250
1251 /*
1252 * Mask of events to tell guest driver this device supports
1253 * See VirtIO 1.0 specification section 5.6.6.2
1254 */
1255 uint32_t uSubscribedEvents =
1256 VIRTIOSCSI_EVT_ASYNC_POWER_MGMT
1257 | VIRTIOSCSI_EVT_ASYNC_EXTERNAL_REQUEST
1258 | VIRTIOSCSI_EVT_ASYNC_MEDIA_CHANGE
1259 | VIRTIOSCSI_EVT_ASYNC_DEVICE_BUSY;
1260
1261 RTSGBUF reqSegBuf;
1262
1263 switch(pScsiCtrl->uType)
1264 {
1265 case VIRTIOSCSI_T_TMF: /* Task Management Functions */
1266 {
1267 PVIRTIOSCSI_CTRL_TMF_T pScsiCtrlTmf = (PVIRTIOSCSI_CTRL_TMF_T)pScsiCtrl;
1268 const char *pszTmfTypeText = virtioGetTMFTypeText(pScsiCtrlTmf->uSubtype);
1269 LogFunc(("%s, VirtIO LUN: %.8Rhxs\n%*sTask Mgt Function: %s (not yet implemented)\n",
1270 QUEUENAME(qIdx), pScsiCtrlTmf->uScsiLun,
1271 CBQUEUENAME(qIdx) + 18, "", pszTmfTypeText));
1272 RT_NOREF(pszTmfTypeText);
1273 switch(pScsiCtrlTmf->uSubtype)
1274 {
1275 case VIRTIOSCSI_T_TMF_ABORT_TASK:
1276 uResponse = VIRTIOSCSI_S_FUNCTION_SUCCEEDED;
1277 break;
1278 case VIRTIOSCSI_T_TMF_ABORT_TASK_SET:
1279 uResponse = VIRTIOSCSI_S_FUNCTION_SUCCEEDED;
1280 break;
1281 case VIRTIOSCSI_T_TMF_CLEAR_ACA:
1282 uResponse = VIRTIOSCSI_S_FUNCTION_SUCCEEDED;
1283 break;
1284 case VIRTIOSCSI_T_TMF_CLEAR_TASK_SET:
1285 uResponse = VIRTIOSCSI_S_FUNCTION_SUCCEEDED;
1286 break;
1287 case VIRTIOSCSI_T_TMF_I_T_NEXUS_RESET:
1288 uResponse = VIRTIOSCSI_S_FUNCTION_SUCCEEDED;
1289 break;
1290 case VIRTIOSCSI_T_TMF_LOGICAL_UNIT_RESET:
1291 uResponse = VIRTIOSCSI_S_FUNCTION_SUCCEEDED;
1292 break;
1293 case VIRTIOSCSI_T_TMF_QUERY_TASK:
1294 uResponse = VIRTIOSCSI_S_FUNCTION_SUCCEEDED;
1295 break;
1296 case VIRTIOSCSI_T_TMF_QUERY_TASK_SET:
1297 uResponse = VIRTIOSCSI_S_FUNCTION_SUCCEEDED;
1298 break;
1299 default:
1300 LogFunc(("Unknown TMF type\n"));
1301 uResponse = VIRTIOSCSI_S_FAILURE;
1302 }
1303
1304 RTSGSEG aReqSegs[] = { { &uResponse, sizeof(uResponse) } };
1305 RTSgBufInit(&reqSegBuf, aReqSegs, sizeof(aReqSegs) / sizeof(RTSGSEG));
1306
1307 break;
1308 }
1309 case VIRTIOSCSI_T_AN_QUERY: /* Guest SCSI driver is querying supported async event notifications */
1310 {
1311 PVIRTIOSCSI_CTRL_AN_T pScsiCtrlAnQuery = (PVIRTIOSCSI_CTRL_AN_T)pScsiCtrl;
1312
1313 uSubscribedEvents &= pScsiCtrlAnQuery->uEventsRequested;
1314 uResponse = VIRTIOSCSI_S_FUNCTION_COMPLETE;
1315
1316 if (LogIs3Enabled())
1317 {
1318 char szTypeText[128];
1319 virtioGetControlAsyncMaskText(szTypeText, sizeof(szTypeText), pScsiCtrlAnQuery->uEventsRequested);
1320
1321 LogFunc(("%s, VirtIO LUN: %.8Rhxs\n%*sAsync Query, types: %s\n",
1322 QUEUENAME(qIdx), pScsiCtrlAnQuery->uScsiLun, CBQUEUENAME(qIdx) + 30, "", szTypeText));
1323 }
1324
1325 RTSGSEG aReqSegs[] = { { &uSubscribedEvents, sizeof(uSubscribedEvents) }, { &uResponse, sizeof(uResponse) } };
1326 RTSgBufInit(&reqSegBuf, aReqSegs, sizeof(aReqSegs) / sizeof(RTSGSEG));
1327
1328 break;
1329 }
1330 case VIRTIOSCSI_T_AN_SUBSCRIBE: /* Guest SCSI driver is subscribing to async event notification(s) */
1331 {
1332 PVIRTIOSCSI_CTRL_AN_T pScsiCtrlAnSubscribe = (PVIRTIOSCSI_CTRL_AN_T)pScsiCtrl;
1333
1334 if (pScsiCtrlAnSubscribe->uEventsRequested & ~SUBSCRIBABLE_EVENTS)
1335 LogFunc(("Unsupported bits in event subscription event mask: 0x%x\n", pScsiCtrlAnSubscribe->uEventsRequested));
1336
1337 uSubscribedEvents &= pScsiCtrlAnSubscribe->uEventsRequested;
1338 pThis->uAsyncEvtsEnabled = uSubscribedEvents;
1339
1340 if (LogIs3Enabled())
1341 {
1342 char szTypeText[128];
1343 virtioGetControlAsyncMaskText(szTypeText, sizeof(szTypeText), pScsiCtrlAnSubscribe->uEventsRequested);
1344
1345 LogFunc(("%s, VirtIO LUN: %.8Rhxs\n%*sAsync Subscribe, types: %s\n",
1346 QUEUENAME(qIdx), pScsiCtrlAnSubscribe->uScsiLun, CBQUEUENAME(qIdx) + 30, "", szTypeText));
1347 }
1348
1349 /*
1350 * TBD: Verify correct status code if request mask is only partially fulfillable
1351 * and confirm when to use 'complete' vs. 'succeeded' See VirtIO 1.0 spec section 5.6.6.2
1352 * and read SAM docs*/
1353 if (uSubscribedEvents == pScsiCtrlAnSubscribe->uEventsRequested)
1354 uResponse = VIRTIOSCSI_S_FUNCTION_SUCCEEDED;
1355 else
1356 uResponse = VIRTIOSCSI_S_FUNCTION_COMPLETE;
1357
1358 RTSGSEG aReqSegs[] = { { &uSubscribedEvents, sizeof(uSubscribedEvents) }, { &uResponse, sizeof(uResponse) } };
1359 RTSgBufInit(&reqSegBuf, aReqSegs, sizeof(aReqSegs) / sizeof(RTSGSEG));
1360
1361 break;
1362 }
1363 default:
1364 LogFunc(("Unknown control type extracted from %s: %d\n", QUEUENAME(qIdx), pScsiCtrl->uType));
1365
1366 uResponse = VIRTIOSCSI_S_FAILURE;
1367
1368 RTSGSEG aReqSegs[] = { { &uResponse, sizeof(uResponse) } };
1369 RTSgBufInit(&reqSegBuf, aReqSegs, sizeof(aReqSegs) / sizeof(RTSGSEG));
1370 }
1371
1372 const char *pszCtrlRespText = virtioGetCtrlRespText(uResponse);
1373 LogFunc(("Response code: %s\n", pszCtrlRespText));
1374 RT_NOREF(pszCtrlRespText);
1375 virtioQueuePut (pThis->hVirtio, qIdx, &reqSegBuf, pDescChain, true);
1376 virtioQueueSync(pThis->hVirtio, qIdx);
1377
1378 return VINF_SUCCESS;
1379}
1380
1381/*
1382 * Unblock the worker thread so it can respond to a state change.
1383 *
1384 * @returns VBox status code.
1385 * @param pDevIns The pcnet device instance.
1386 * @param pThread The send thread.
1387 */
1388static DECLCALLBACK(int) virtioScsiWorkerWakeUp(PPDMDEVINS pDevIns, PPDMTHREAD pThread)
1389{
1390 RT_NOREF(pThread);
1391 uint16_t qIdx = ((uint64_t)pThread->pvUser) & 0xffff;
1392 PVIRTIOSCSI pThis = PDMINS_2_DATA(pDevIns, PVIRTIOSCSI);
1393 return SUPSemEventSignal(pThis->pSupDrvSession, pThis->aWorker[qIdx].hEvtProcess);
1394}
1395
1396static int virtioScsiWorker(PPDMDEVINS pDevIns, PPDMTHREAD pThread)
1397{
1398 int rc;
1399 uint16_t qIdx = ((uint64_t)pThread->pvUser) & 0xffff;
1400 PVIRTIOSCSI pThis = PDMINS_2_DATA(pDevIns, PVIRTIOSCSI);
1401 PWORKER pWorker = &pThis->aWorker[qIdx];
1402
1403 if (pThread->enmState == PDMTHREADSTATE_INITIALIZING)
1404 return VINF_SUCCESS;
1405
1406 while (pThread->enmState == PDMTHREADSTATE_RUNNING)
1407 {
1408 if (virtioQueueIsEmpty(pThis->hVirtio, qIdx))
1409 {
1410 /* Atomic interlocks avoid missing alarm while going to sleep & notifier waking the awoken */
1411 ASMAtomicWriteBool(&pWorker->fSleeping, true);
1412 bool fNotificationSent = ASMAtomicXchgBool(&pWorker->fNotified, false);
1413 if (!fNotificationSent)
1414 {
1415 Log6Func(("%s worker sleeping...\n", QUEUENAME(qIdx)));
1416 Assert(ASMAtomicReadBool(&pWorker->fSleeping));
1417 rc = SUPSemEventWaitNoResume(pThis->pSupDrvSession, pWorker->hEvtProcess, RT_INDEFINITE_WAIT);
1418 AssertLogRelMsgReturn(RT_SUCCESS(rc) || rc == VERR_INTERRUPTED, ("%Rrc\n", rc), rc);
1419 if (RT_UNLIKELY(pThread->enmState != PDMTHREADSTATE_RUNNING))
1420 break;
1421 Log6Func(("%s worker woken\n", QUEUENAME(qIdx)));
1422 ASMAtomicWriteBool(&pWorker->fNotified, false);
1423 }
1424 ASMAtomicWriteBool(&pWorker->fSleeping, false);
1425 }
1426
1427 if (!pThis->fQueueAttached[qIdx])
1428 {
1429 LogFunc(("%s queue not attached, worker aborting...\n", QUEUENAME(qIdx)));
1430 break;
1431 }
1432 if (!pThis->fQuiescing)
1433 {
1434 Log6Func(("fetching next descriptor chain from %s\n", QUEUENAME(qIdx)));
1435 PVIRTIO_DESC_CHAIN_T pDescChain;
1436 rc = virtioQueueGet(pThis->hVirtio, qIdx, &pDescChain, true);
1437 if (rc == VERR_NOT_AVAILABLE)
1438 {
1439 Log6Func(("Nothing found in %s\n", QUEUENAME(qIdx)));
1440 continue;
1441 }
1442
1443 AssertRC(rc);
1444 if (qIdx == CONTROLQ_IDX)
1445 virtioScsiCtrl(pThis, qIdx, pDescChain);
1446 else /* request queue index */
1447 {
1448 rc = virtioScsiReqSubmit(pThis, qIdx, pDescChain);
1449 if (RT_FAILURE(rc))
1450 {
1451 LogRel(("Error submitting req packet, resetting %Rrc", rc));
1452 }
1453 }
1454 }
1455 }
1456 return VINF_SUCCESS;
1457}
1458
1459
1460DECLINLINE(void) virtioScsiReportEventsMissed(PVIRTIOSCSI pThis, uint16_t uTarget)
1461{
1462 virtioScsiSendEvent(pThis, uTarget, VIRTIOSCSI_T_NO_EVENT | VIRTIOSCSI_T_EVENTS_MISSED, 0);
1463}
1464
1465#if 0
1466/* Only invoke this if VIRTIOSCSI_F_HOTPLUG is negotiated during intiailization
1467 * This effectively removes the SCSI Target/LUN on the guest side
1468 */
1469DECLINLINE(void) virtioScsiReportTargetRemoved(PVIRTIOSCSI pThis, uint16_t uTarget)
1470{
1471 if (pThis->fHasHotplug)
1472 virtioScsiSendEvent(pThis, uTarget, VIRTIOSCSI_T_TRANSPORT_RESET,
1473 VIRTIOSCSI_EVT_RESET_REMOVED);
1474}
1475
1476/* Only invoke thi if VIRTIOSCSI_F_HOTPLUG is negotiated during intiailization
1477 * This effectively adds the SCSI Target/LUN on the guest side
1478 */
1479DECLINLINE(void) virtioScsiReportTargetAdded(PVIRTIOSCSI pThis, uint16_t uTarget)
1480{
1481 if (pThis->fHasHotplug)
1482 virtioScsiSendEvent(pThis, uTarget, VIRTIOSCSI_T_TRANSPORT_RESET,
1483 VIRTIOSCSI_EVT_RESET_RESCAN);
1484}
1485
1486DECLINLINE(void) virtioScsiReportTargetReset(PVIRTIOSCSI pThis, uint16_t uTarget)
1487{
1488 virtioScsiSendEvent(pThis, uTarget, VIRTIOSCSI_T_TRANSPORT_RESET,
1489 VIRTIOSCSI_EVT_RESET_HARD);
1490}
1491
1492DECLINLINE(void) virtioScsiReportOperChange(PVIRTIOSCSI pThis, uint16_t uTarget)
1493{
1494 if (pThis->uSubscribedEvents & VIRTIOSCSI_EVT_ASYNC_OPERATIONAL_CHANGE)
1495 virtioScsiSendEvent(pThis, uTarget, VIRTIOSCSI_T_ASYNC_NOTIFY,
1496 VIRTIOSCSI_EVT_ASYNC_OPERATIONAL_CHANGE);
1497}
1498
1499DECLINLINE(void) virtioScsiReportPowerMsg(PVIRTIOSCSI pThis, uint16_t uTarget)
1500{
1501 if (pThis->uSubscribedEvents & VIRTIOSCSI_EVT_ASYNC_POWER_MGMT)
1502 virtioScsiSendEvent(pThis, uTarget, VIRTIOSCSI_T_ASYNC_NOTIFY,
1503 VIRTIOSCSI_EVT_ASYNC_POWER_MGMT);
1504}
1505
1506DECLINLINE(void) virtioScsiReportExtReq(PVIRTIOSCSI pThis, uint16_t uTarget)
1507{
1508 if (pThis->uSubscribedEvents & VIRTIOSCSI_EVT_ASYNC_EXTERNAL_REQUEST)
1509 virtioScsiSendEvent(pThis, uTarget, VIRTIOSCSI_T_ASYNC_NOTIFY,
1510 VIRTIOSCSI_EVT_ASYNC_EXTERNAL_REQUEST);
1511}
1512
1513DECLINLINE(void) virtioScsiReportMediaChange(PVIRTIOSCSI pThis, uint16_t uTarget)
1514{
1515 if (pThis->uSubscribedEvents & VIRTIOSCSI_EVT_ASYNC_MEDIA_CHANGE)
1516 virtioScsiSendEvent(pThis, uTarget, VIRTIOSCSI_T_ASYNC_NOTIFY,
1517 VIRTIOSCSI_EVT_ASYNC_MEDIA_CHANGE);
1518}
1519
1520DECLINLINE(void) virtioScsiReportMultiHost(PVIRTIOSCSI pThis, uint16_t uTarget)
1521{
1522 if (pThis->uSubscribedEvents & VIRTIOSCSI_EVT_ASYNC_MULTI_HOST)
1523 virtioScsiSendEvent(pThis, uTarget, VIRTIOSCSI_T_ASYNC_NOTIFY,
1524 VIRTIOSCSI_EVT_ASYNC_MULTI_HOST);
1525}
1526
1527DECLINLINE(void) virtioScsiReportDeviceBusy(PVIRTIOSCSI pThis, uint16_t uTarget)
1528{
1529 if (pThis->uSubscribedEvents & VIRTIOSCSI_EVT_ASYNC_DEVICE_BUSY)
1530 virtioScsiSendEvent(pThis, uTarget, VIRTIOSCSI_T_ASYNC_NOTIFY,
1531 VIRTIOSCSI_EVT_ASYNC_DEVICE_BUSY);
1532}
1533
1534DECLINLINE(void) virtioScsiReportParamChange(PVIRTIOSCSI pThis, uint16_t uTarget, uint32_t uSenseCode, uint32_t uSenseQualifier)
1535{
1536 uint32_t uReason = uSenseQualifier << 8 | uSenseCode;
1537 virtioScsiSendEvent(pThis, uTarget, VIRTIOSCSI_T_PARAM_CHANGE, uReason);
1538
1539}
1540
1541#endif
1542
1543static DECLCALLBACK(void) virtioScsiNotified(VIRTIOHANDLE hVirtio, void *pClient, uint16_t qIdx)
1544{
1545 RT_NOREF(hVirtio);
1546
1547 AssertReturnVoid(qIdx < VIRTIOSCSI_QUEUE_CNT);
1548 PVIRTIOSCSI pThis = (PVIRTIOSCSI)pClient;
1549 PWORKER pWorker = &pThis->aWorker[qIdx];
1550
1551 RTLogFlush(RTLogDefaultInstanceEx(RT_MAKE_U32(0, UINT16_MAX)));
1552
1553 if (qIdx == CONTROLQ_IDX || IS_REQ_QUEUE(qIdx))
1554 {
1555 Log6Func(("%s has available data\n", QUEUENAME(qIdx)));
1556 /* Wake queue's worker thread up if sleeping */
1557 if (!ASMAtomicXchgBool(&pWorker->fNotified, true))
1558 {
1559 if (ASMAtomicReadBool(&pWorker->fSleeping))
1560 {
1561 Log6Func(("waking %s worker.\n", QUEUENAME(qIdx)));
1562 int rc = SUPSemEventSignal(pThis->pSupDrvSession, pWorker->hEvtProcess);
1563 AssertRC(rc);
1564 }
1565 }
1566 }
1567 else if (qIdx == EVENTQ_IDX)
1568 {
1569 Log3Func(("Driver queued buffer(s) to %s\n", QUEUENAME(qIdx)));
1570 if (ASMAtomicXchgBool(&pThis->fEventsMissed, false))
1571 virtioScsiReportEventsMissed(pThis, 0);
1572 }
1573 else
1574 LogFunc(("Unexpected queue idx (ignoring): %d\n", qIdx));
1575}
1576
1577static DECLCALLBACK(void) virtioScsiStatusChanged(VIRTIOHANDLE hVirtio, void *pClient, uint32_t fVirtioReady)
1578{
1579 RT_NOREF(hVirtio);
1580 PVIRTIOSCSI pThis = (PVIRTIOSCSI)pClient;
1581
1582 pThis->fVirtioReady = fVirtioReady;
1583
1584 if (fVirtioReady)
1585 {
1586 LogFunc(("VirtIO ready\n-----------------------------------------------------------------------------------------\n"));
1587 uint64_t features = virtioGetNegotiatedFeatures(hVirtio);
1588 pThis->fHasT10pi = features & VIRTIO_SCSI_F_T10_PI;
1589 pThis->fHasHotplug = features & VIRTIO_SCSI_F_HOTPLUG;
1590 pThis->fHasInOutBufs = features & VIRTIO_SCSI_F_INOUT;
1591 pThis->fHasLunChange = features & VIRTIO_SCSI_F_CHANGE;
1592 pThis->fQuiescing = false;
1593 pThis->fResetting = false;
1594
1595 for (int i = 0; i < VIRTIOSCSI_QUEUE_CNT; i++)
1596 pThis->fQueueAttached[i] = true;
1597 }
1598 else
1599 {
1600 LogFunc(("VirtIO is resetting\n"));
1601 for (int i = 0; i < VIRTIOSCSI_QUEUE_CNT; i++)
1602 pThis->fQueueAttached[i] = false;
1603 }
1604}
1605
1606/**
1607 * virtio-scsi debugger info callback.
1608 *
1609 * @param pDevIns The device instance.
1610 * @param pHlp The output helpers.
1611 * @param pszArgs The arguments.
1612 */
1613static DECLCALLBACK(void) virtioScsiInfo(PPDMDEVINS pDevIns, PCDBGFINFOHLP pHlp, const char *pszArgs)
1614{
1615 PVIRTIOSCSI pThis = PDMINS_2_DATA(pDevIns, PVIRTIOSCSI);
1616 bool fVerbose = false;
1617
1618 /* Parse arguments. */
1619 if (pszArgs)
1620 fVerbose = strstr(pszArgs, "verbose") != NULL;
1621
1622 /* Show basic information. */
1623 pHlp->pfnPrintf(pHlp, "%s#%d: virtio-scsci ",
1624 pDevIns->pReg->szName,
1625 pDevIns->iInstance);
1626 pHlp->pfnPrintf(pHlp, "numTargets=%lu", pThis->cTargets);
1627}
1628
1629/**
1630 * @interface_method_impl{PDMIMEDIAEXPORT,pfnMediumEjected}
1631 */
1632static DECLCALLBACK(void) virtioScsiMediumEjected(PPDMIMEDIAEXPORT pInterface)
1633{
1634 PVIRTIOSCSITARGET pTarget = RT_FROM_MEMBER(pInterface, VIRTIOSCSITARGET, IMediaExPort);
1635 PVIRTIOSCSI pThis = pTarget->pVirtioScsi;
1636 LogFunc(("LUN %d Ejected!\n", pTarget->iTarget));
1637 if (pThis->pMediaNotify)
1638 {
1639 int rc = VMR3ReqCallNoWait(PDMDevHlpGetVM(pThis->CTX_SUFF(pDevIns)), VMCPUID_ANY,
1640 (PFNRT)pThis->pMediaNotify->pfnEjected, 2,
1641 pThis->pMediaNotify, pTarget->iTarget);
1642 AssertRC(rc);
1643 }
1644}
1645
1646/** @callback_method_impl{FNSSMDEVLIVEEXEC} */
1647static DECLCALLBACK(int) virtioScsiLiveExec(PPDMDEVINS pDevIns, PSSMHANDLE pSSM, uint32_t uPass)
1648{
1649 LogFunc(("callback"));
1650 PVIRTIOSCSI pThis = PDMINS_2_DATA(pDevIns, PVIRTIOSCSI);
1651 RT_NOREF(pThis);
1652 RT_NOREF(uPass);
1653 RT_NOREF(pSSM);
1654 return VINF_SSM_DONT_CALL_AGAIN;
1655}
1656
1657/** @callback_method_impl{FNSSMDEVLOADEXEC} */
1658static DECLCALLBACK(int) virtioScsiLoadExec(PPDMDEVINS pDevIns, PSSMHANDLE pSSM, uint32_t uVersion, uint32_t uPass)
1659{
1660 LogFunc(("callback"));
1661 PVIRTIOSCSI pThis = PDMINS_2_DATA(pDevIns, PVIRTIOSCSI);
1662 RT_NOREF(pThis);
1663 RT_NOREF(uPass);
1664 RT_NOREF(pSSM);
1665 RT_NOREF(uVersion);
1666 return VINF_SSM_DONT_CALL_AGAIN;
1667}
1668
1669/** @callback_method_impl{FNSSMDEVSAVEEXEC} */
1670static DECLCALLBACK(int) virtioScsiSaveExec(PPDMDEVINS pDevIns, PSSMHANDLE pSSM)
1671{
1672 LogFunc(("callback"));
1673 PVIRTIOSCSI pThis = PDMINS_2_DATA(pDevIns, PVIRTIOSCSI);
1674
1675 RT_NOREF(pThis);
1676 RT_NOREF(pSSM);
1677 return VINF_SUCCESS;
1678}
1679
1680/** @callback_method_impl{FNSSMDEVLOADDONE} */
1681static DECLCALLBACK(int) virtioScsiLoadDone(PPDMDEVINS pDevIns, PSSMHANDLE pSSM)
1682{
1683 LogFunc(("callback"));
1684 PVIRTIOSCSI pThis = PDMINS_2_DATA(pDevIns, PVIRTIOSCSI);
1685 RT_NOREF(pThis);
1686 RT_NOREF(pSSM);
1687 return VINF_SUCCESS;
1688}
1689
1690/**
1691 * Is asynchronous handling of suspend or power off notification completed?
1692 *
1693 * This is called to check whether the device has quiesced. Don't deadlock.
1694 * Avoid blocking. Do NOT wait for anything.
1695 *
1696 * @returns true if done, false if more work to be done.
1697 *
1698 * @param pDevIns The device instance.
1699 * @remarks The caller will enter the device critical section.
1700 * @thread EMT(0)
1701 */
1702static DECLCALLBACK(bool) virtioScsiDeviceQuiesced(PPDMDEVINS pDevIns)
1703{
1704 LogFunc(("Device I/O activity quiesced.\n"));
1705 PVIRTIOSCSI pThis = PDMINS_2_DATA(pDevIns, PVIRTIOSCSI);
1706
1707 pThis->fQuiescing = false;
1708
1709 return true;
1710}
1711
1712static void virtioScsiQuiesceDevice(PPDMDEVINS pDevIns)
1713{
1714 PVIRTIOSCSI pThis = PDMINS_2_DATA(pDevIns, PVIRTIOSCSI);
1715
1716 /* Prevent worker threads from removing/processing elements from virtq's */
1717 pThis->fQuiescing = true;
1718
1719 PDMDevHlpSetAsyncNotification(pDevIns, virtioScsiDeviceQuiesced);
1720
1721 /* If already quiesced invoke async callback. */
1722 if (!ASMAtomicReadU32(&pThis->cActiveReqs))
1723 PDMDevHlpAsyncNotificationCompleted(pDevIns);
1724}
1725
1726/**
1727 * @interface_method_impl{PDMIMEDIAEXPORT,pfnIoReqStateChanged}
1728 */
1729static DECLCALLBACK(void) virtioScsiIoReqStateChanged(PPDMIMEDIAEXPORT pInterface, PDMMEDIAEXIOREQ hIoReq,
1730 void *pvIoReqAlloc, PDMMEDIAEXIOREQSTATE enmState)
1731{
1732 RT_NOREF4(pInterface, hIoReq, pvIoReqAlloc, enmState);
1733 PVIRTIOSCSI pThis = RT_FROM_MEMBER(pInterface, VIRTIOSCSI, IBase);
1734
1735 switch (enmState)
1736 {
1737 case PDMMEDIAEXIOREQSTATE_SUSPENDED:
1738 {
1739 /* Stop considering this request active */
1740 if (!ASMAtomicDecU32(&pThis->cActiveReqs) && pThis->fQuiescing)
1741 PDMDevHlpAsyncNotificationCompleted(pThis->CTX_SUFF(pDevIns));
1742 break;
1743 }
1744 case PDMMEDIAEXIOREQSTATE_ACTIVE:
1745 ASMAtomicIncU32(&pThis->cActiveReqs);
1746 break;
1747 default:
1748 AssertMsgFailed(("Invalid request state given %u\n", enmState));
1749 }
1750}
1751
1752/**
1753 * @copydoc FNPDMDEVRESET
1754 */
1755static DECLCALLBACK(void) virtioScsiReset(PPDMDEVINS pDevIns)
1756{
1757 LogFunc(("\n"));
1758 PVIRTIOSCSI pThis = PDMINS_2_DATA(pDevIns, PVIRTIOSCSI);
1759 pThis->fResetting = true;
1760 virtioScsiQuiesceDevice(pDevIns);
1761}
1762
1763/**
1764 * @interface_method_impl{PDMDEVREG,pfnResume}
1765 */
1766static DECLCALLBACK(void) virtioScsiResume(PPDMDEVINS pDevIns)
1767{
1768 LogFunc(("\n"));
1769
1770 PVIRTIOSCSI pThis = PDMINS_2_DATA(pDevIns, PVIRTIOSCSI);
1771
1772 pThis->fQuiescing = false;
1773
1774 /* Wake worker threads flagged to skip pulling queue entries during quiesce
1775 * to ensure they re-check their queues. Active request queues may already
1776 * be awake due to new reqs coming in.
1777 */
1778 for (uint16_t qIdx = 0; qIdx < VIRTIOSCSI_REQ_QUEUE_CNT; qIdx++)
1779 {
1780 PWORKER pWorker = &pThis->aWorker[qIdx];
1781
1782 if (ASMAtomicReadBool(&pWorker->fSleeping))
1783 {
1784 Log6Func(("waking %s worker.\n", QUEUENAME(qIdx)));
1785 int rc = SUPSemEventSignal(pThis->pSupDrvSession, pWorker->hEvtProcess);
1786 AssertRC(rc);
1787 }
1788 }
1789
1790 /* Ensure guest is working the queues too. */
1791 virtioPropagateResumeNotification(pThis->hVirtio);
1792}
1793
1794/**
1795 * @interface_method_impl{PDMDEVREG,pfnSuspend}
1796 */
1797static DECLCALLBACK(void) virtioScsiSuspendOrPoweroff(PPDMDEVINS pDevIns)
1798{
1799 LogFunc(("\n"));
1800
1801 virtioScsiQuiesceDevice(pDevIns);
1802
1803 PVIRTIOSCSI pThis = PDMINS_2_DATA(pDevIns, PVIRTIOSCSI);
1804
1805 /* VM is halted, thus no new I/O being dumped into queues by the guest.
1806 * Workers have been flagged to stop pulling stuff already queued-up by the guest.
1807 * Now tell lower-level to to suspend reqs (for example, DrvVD suspends all reqs
1808 * on its wait queue, and we will get a callback as the state changes to
1809 * suspended (and later, resumed) for each).
1810 */
1811 for (uint32_t i = 0; i < pThis->cTargets; i++)
1812 {
1813 PVIRTIOSCSITARGET pTarget = &pThis->paTargetInstances[i];
1814 if (pTarget->pDrvBase)
1815 if (pTarget->pDrvMediaEx)
1816 pTarget->pDrvMediaEx->pfnNotifySuspend(pTarget->pDrvMediaEx);
1817 }
1818}
1819
1820/**
1821 * Turns on/off the write status LED.
1822 *
1823 * @param pTarget Pointer to the target device
1824 * @param fOn New LED state.
1825 */
1826void virtioScsiSetWriteLed(PVIRTIOSCSITARGET pTarget, bool fOn)
1827{
1828 LogFlow(("%s virtioSetWriteLed: %s\n", pTarget->pszTargetName, fOn ? "on" : "off"));
1829 if (fOn)
1830 pTarget->led.Asserted.s.fWriting = pTarget->led.Actual.s.fWriting = 1;
1831 else
1832 pTarget->led.Actual.s.fWriting = fOn;
1833}
1834
1835/**
1836 * Turns on/off the read status LED.
1837 *
1838 * @param pTarget Pointer to the device state structure.
1839 * @param fOn New LED state.
1840 */
1841void virtioScsiSetReadLed(PVIRTIOSCSITARGET pTarget, bool fOn)
1842{
1843 LogFlow(("%s virtioSetReadLed: %s\n", pTarget->pszTargetName, fOn ? "on" : "off"));
1844 if (fOn)
1845 pTarget->led.Asserted.s.fReading = pTarget->led.Actual.s.fReading = 1;
1846 else
1847 pTarget->led.Actual.s.fReading = fOn;
1848}
1849
1850/**
1851 * Gets the pointer to the status LED of a unit.
1852 *
1853 * @returns VBox status code.
1854 * @param pInterface Pointer to the interface structure containing the called function pointer.
1855 * @param iTarget The unit which status LED we desire.
1856 * @param ppLed Where to store the LED pointer.
1857 */
1858static DECLCALLBACK(int) virtioScsiTargetQueryStatusLed(PPDMILEDPORTS pInterface, unsigned iTarget, PPDMLED *ppLed)
1859{
1860 PVIRTIOSCSITARGET pTarget = RT_FROM_MEMBER(pInterface, VIRTIOSCSITARGET, ILed);
1861 if (iTarget == 0)
1862 {
1863 *ppLed = &pTarget->led;
1864 Assert((*ppLed)->u32Magic == PDMLED_MAGIC);
1865 return VINF_SUCCESS;
1866 }
1867 return VERR_PDM_LUN_NOT_FOUND;
1868}
1869
1870/**
1871 * Gets the pointer to the status LED of a unit.
1872 *
1873 * @returns VBox status code.
1874 * @param pInterface Pointer to the interface structure containing the called function pointer.
1875 * @param iTarget The unit which status LED we desire.
1876 * @param ppLed Where to store the LED pointer.
1877 */
1878static DECLCALLBACK(int) virtioScsiDeviceQueryStatusLed(PPDMILEDPORTS pInterface, unsigned iTarget, PPDMLED *ppLed)
1879{
1880 PVIRTIOSCSI pThis = RT_FROM_MEMBER(pInterface, VIRTIOSCSI, ILeds);
1881 if (iTarget < pThis->cTargets)
1882 {
1883 *ppLed = &pThis->paTargetInstances[iTarget].led;
1884 Assert((*ppLed)->u32Magic == PDMLED_MAGIC);
1885 return VINF_SUCCESS;
1886 }
1887 return VERR_PDM_LUN_NOT_FOUND;
1888 }
1889
1890static int virtioScsiCfgAccessed(PVIRTIOSCSI pThis, uint32_t uOffset,
1891 const void *pv, uint32_t cb, bool fWrite)
1892{
1893 int rc = VINF_SUCCESS;
1894 if (MATCH_SCSI_CONFIG(uNumQueues))
1895 SCSI_CONFIG_ACCESSOR_READONLY(uNumQueues);
1896 else
1897 if (MATCH_SCSI_CONFIG(uSegMax))
1898 SCSI_CONFIG_ACCESSOR_READONLY(uSegMax);
1899 else
1900 if (MATCH_SCSI_CONFIG(uMaxSectors))
1901 SCSI_CONFIG_ACCESSOR_READONLY(uMaxSectors);
1902 else
1903 if (MATCH_SCSI_CONFIG(uCmdPerLun))
1904 SCSI_CONFIG_ACCESSOR_READONLY(uCmdPerLun);
1905 else
1906 if (MATCH_SCSI_CONFIG(uEventInfoSize))
1907 SCSI_CONFIG_ACCESSOR_READONLY(uEventInfoSize);
1908 else
1909 if (MATCH_SCSI_CONFIG(uSenseSize))
1910 SCSI_CONFIG_ACCESSOR(uSenseSize);
1911 else
1912 if (MATCH_SCSI_CONFIG(uCdbSize))
1913 SCSI_CONFIG_ACCESSOR(uCdbSize);
1914 else
1915 if (MATCH_SCSI_CONFIG(uMaxChannel))
1916 SCSI_CONFIG_ACCESSOR_READONLY(uMaxChannel);
1917 else
1918 if (MATCH_SCSI_CONFIG(uMaxTarget))
1919 SCSI_CONFIG_ACCESSOR_READONLY(uMaxTarget);
1920 else
1921 if (MATCH_SCSI_CONFIG(uMaxLun))
1922 SCSI_CONFIG_ACCESSOR_READONLY(uMaxLun);
1923 else
1924 {
1925 LogFunc(("Bad access by guest to virtio_scsi_config: uoff=%d, cb=%d\n", uOffset, cb));
1926 rc = VERR_ACCESS_DENIED;
1927 }
1928 return rc;
1929}
1930
1931/**
1932 * virtio-scsi VirtIO Device-specific capabilities read callback
1933 * (other VirtIO capabilities and features are handled in VirtIO implementation)
1934 *
1935 * @param pDevIns The device instance.
1936 * @param uOffset Offset within device specific capabilities struct
1937 * @param pv Buffer in which to save read data
1938 * @param cb Number of bytes to read
1939 */
1940static DECLCALLBACK(int) virtioScsiDevCapRead(PPDMDEVINS pDevIns, uint32_t uOffset, const void *pv, uint32_t cb)
1941{
1942 int rc = VINF_SUCCESS;
1943 PVIRTIOSCSI pThis = PDMINS_2_DATA(pDevIns, PVIRTIOSCSI);
1944
1945 rc = virtioScsiCfgAccessed(pThis, uOffset, pv, cb, false);
1946
1947 return rc;
1948}
1949
1950/**
1951 * virtio-scsi VirtIO Device-specific capabilities read callback
1952 * (other VirtIO capabilities and features are handled in VirtIO implementation)
1953 *
1954 * @param pDevIns The device instance.
1955 * @param uOffset Offset within device specific capabilities struct
1956 * @param pv Buffer in which to save read data
1957 * @param cb Number of bytes to write
1958 */
1959static DECLCALLBACK(int) virtioScsiDevCapWrite(PPDMDEVINS pDevIns, uint32_t uOffset, const void *pv, uint32_t cb)
1960{
1961 int rc = VINF_SUCCESS;
1962 PVIRTIOSCSI pThis = PDMINS_2_DATA(pDevIns, PVIRTIOSCSI);
1963
1964 rc = virtioScsiCfgAccessed(pThis, uOffset, pv, cb, true);
1965
1966 return rc;
1967}
1968
1969/**
1970 * Device relocation callback.
1971 *
1972 * When this callback is called the device instance data, and if the
1973 * device have a GC component, is being relocated, or/and the selectors
1974 * have been changed. The device must use the chance to perform the
1975 * necessary pointer relocations and data updates.
1976 *
1977 * Before the GC code is executed the first time, this function will be
1978 * called with a 0 delta so GC pointer calculations can be one in one place.
1979 *
1980 * @param pDevIns Pointer to the device instance.
1981 * @param offDelta The relocation delta relative to the old location.
1982 *
1983 * @remark A relocation CANNOT fail.
1984 */
1985static DECLCALLBACK(void) virtioScsiRelocate(PPDMDEVINS pDevIns, RTGCINTPTR offDelta)
1986{
1987 LogFunc(("Relocating virtio-scsi"));
1988 RT_NOREF(offDelta);
1989 PVIRTIOSCSI pThis = PDMINS_2_DATA(pDevIns, PVIRTIOSCSI);
1990
1991 pThis->pDevInsR3 = pDevIns;
1992
1993 for (uint32_t i = 0; i < pThis->cTargets; i++)
1994 {
1995 PVIRTIOSCSITARGET pTarget = &pThis->paTargetInstances[i];
1996 pTarget->pVirtioScsi = pThis;
1997 }
1998
1999 /*
2000 * Important: Forward to virtio framework!
2001 */
2002 virtioRelocate(pDevIns, offDelta);
2003
2004}
2005
2006static DECLCALLBACK(int) virtioScsiQueryDeviceLocation(PPDMIMEDIAPORT pInterface, const char **ppcszController,
2007 uint32_t *piInstance, uint32_t *piTarget)
2008{
2009 PVIRTIOSCSITARGET pTarget = RT_FROM_MEMBER(pInterface, VIRTIOSCSITARGET, IMediaPort);
2010 PPDMDEVINS pDevIns = pTarget->pVirtioScsi->CTX_SUFF(pDevIns);
2011
2012 AssertPtrReturn(ppcszController, VERR_INVALID_POINTER);
2013 AssertPtrReturn(piInstance, VERR_INVALID_POINTER);
2014 AssertPtrReturn(piTarget, VERR_INVALID_POINTER);
2015
2016 *ppcszController = pDevIns->pReg->szName;
2017 *piInstance = pDevIns->iInstance;
2018 *piTarget = pTarget->iTarget;
2019
2020 return VINF_SUCCESS;
2021}
2022
2023/**
2024 * @interface_method_impl{PDMIBASE,pfnQueryInterface}
2025 */
2026static DECLCALLBACK(void *) virtioScsiTargetQueryInterface(PPDMIBASE pInterface, const char *pszIID)
2027{
2028 PVIRTIOSCSITARGET pTarget = RT_FROM_MEMBER(pInterface, VIRTIOSCSITARGET, IBase);
2029 PDMIBASE_RETURN_INTERFACE(pszIID, PDMIBASE, &pTarget->IBase);
2030 PDMIBASE_RETURN_INTERFACE(pszIID, PDMIMEDIAPORT, &pTarget->IMediaPort);
2031 PDMIBASE_RETURN_INTERFACE(pszIID, PDMIMEDIAEXPORT, &pTarget->IMediaExPort);
2032 PDMIBASE_RETURN_INTERFACE(pszIID, PDMILEDPORTS, &pTarget->ILed);
2033 return NULL;
2034}
2035
2036/**
2037 * @interface_method_impl{PDMIBASE,pfnQueryInterface}
2038 */
2039static DECLCALLBACK(void *) virtioScsiDeviceQueryInterface(PPDMIBASE pInterface, const char *pszIID)
2040{
2041 PVIRTIOSCSI pThis = RT_FROM_MEMBER(pInterface, VIRTIOSCSI, IBase);
2042
2043 PDMIBASE_RETURN_INTERFACE(pszIID, PDMIBASE, &pThis->IBase);
2044 PDMIBASE_RETURN_INTERFACE(pszIID, PDMILEDPORTS, &pThis->ILeds);
2045
2046 return NULL;
2047}
2048
2049/**
2050 * Detach notification.
2051 *
2052 * One harddisk at one port has been unplugged.
2053 * The VM is suspended at this point.
2054 *
2055 * @param pDevIns The device instance.
2056 * @param iTarget The logical unit which is being detached.
2057 * @param fFlags Flags, combination of the PDMDEVATT_FLAGS_* \#defines.
2058 */
2059static DECLCALLBACK(void) virtioScsiDetach(PPDMDEVINS pDevIns, unsigned iTarget, uint32_t fFlags)
2060{
2061 RT_NOREF(fFlags);
2062 PVIRTIOSCSI pThis = PDMINS_2_DATA(pDevIns, PVIRTIOSCSI);
2063 PVIRTIOSCSITARGET pTarget = &pThis->paTargetInstances[iTarget];
2064
2065 LogFunc((""));
2066
2067 AssertMsg(fFlags & PDM_TACH_FLAGS_NOT_HOT_PLUG,
2068 ("virtio-scsi: Device does not support hotplugging\n"));
2069
2070 /*
2071 * Zero some important members.
2072 */
2073 pTarget->fPresent = false;
2074 pTarget->pDrvBase = NULL;
2075}
2076
2077/**
2078 * Attach command.
2079 *
2080 * This is called when we change block driver.
2081 *
2082 * @returns VBox status code.
2083 * @param pDevIns The device instance.
2084 * @param iTarget The logical unit which is being detached.
2085 * @param fFlags Flags, combination of the PDMDEVATT_FLAGS_* \#defines.
2086 */
2087static DECLCALLBACK(int) virtioScsiAttach(PPDMDEVINS pDevIns, unsigned iTarget, uint32_t fFlags)
2088{
2089 PVIRTIOSCSI pThis = PDMINS_2_DATA(pDevIns, PVIRTIOSCSI);
2090 PVIRTIOSCSITARGET pTarget = &pThis->paTargetInstances[iTarget];
2091 int rc;
2092
2093 pThis->pDevInsR3 = pDevIns;
2094 pThis->pDevInsR0 = PDMDEVINS_2_R0PTR(pDevIns);
2095 pThis->pDevInsRC = PDMDEVINS_2_RCPTR(pDevIns);
2096
2097 AssertMsgReturn(fFlags & PDM_TACH_FLAGS_NOT_HOT_PLUG,
2098 ("virtio-scsi: Device does not support hotplugging\n"),
2099 VERR_INVALID_PARAMETER);
2100
2101 /* the usual paranoia */
2102 AssertRelease(!pTarget->pDrvBase);
2103 Assert(pTarget->iTarget == iTarget);
2104
2105 /*
2106 * Try attach the SCSI driver and get the interfaces,
2107 * required as well as optional.
2108 */
2109 rc = PDMDevHlpDriverAttach(pDevIns, pTarget->iTarget, &pDevIns->IBase,
2110 &pTarget->pDrvBase, (const char *)&pTarget->pszTargetName);
2111 if (RT_SUCCESS(rc))
2112 pTarget->fPresent = true;
2113 else
2114 AssertMsgFailed(("Failed to attach %s. rc=%Rrc\n", pTarget->pszTargetName, rc));
2115
2116 if (RT_FAILURE(rc))
2117 {
2118 pTarget->fPresent = false;
2119 pTarget->pDrvBase = NULL;
2120 }
2121 return rc;
2122}
2123
2124static DECLCALLBACK(int) virtioScsiDestruct(PPDMDEVINS pDevIns)
2125{
2126 /*
2127 * Check the versions here as well since the destructor is *always* called.
2128 */
2129
2130 PDMDEV_CHECK_VERSIONS_RETURN_QUIET(pDevIns);
2131
2132 PVIRTIOSCSI pThis = PDMINS_2_DATA(pDevIns, PVIRTIOSCSI);
2133
2134 RTMemFree(pThis->paTargetInstances);
2135 pThis->paTargetInstances = NULL;
2136 for (int qIdx = 0; qIdx < VIRTIOSCSI_QUEUE_CNT; qIdx++)
2137 {
2138 PWORKER pWorker = &pThis->aWorker[qIdx];
2139 if (pWorker->hEvtProcess != NIL_SUPSEMEVENT)
2140 {
2141 SUPSemEventClose(pThis->pSupDrvSession, pWorker->hEvtProcess);
2142 pWorker->hEvtProcess = NIL_SUPSEMEVENT;
2143 }
2144 }
2145 return VINF_SUCCESS;
2146}
2147
2148static DECLCALLBACK(int) virtioScsiConstruct(PPDMDEVINS pDevIns, int iInstance, PCFGMNODE pCfg){
2149
2150 PDMDEV_CHECK_VERSIONS_RETURN(pDevIns);
2151
2152 PVIRTIOSCSI pThis = PDMINS_2_DATA(pDevIns, PVIRTIOSCSI);
2153 int rc = VINF_SUCCESS;
2154
2155 pThis->pDevInsR3 = pDevIns;
2156 pThis->pDevInsR0 = PDMDEVINS_2_R0PTR(pDevIns);
2157 pThis->pDevInsRC = PDMDEVINS_2_RCPTR(pDevIns);
2158 pThis->pSupDrvSession = PDMDevHlpGetSupDrvSession(pDevIns);
2159
2160 LogFunc(("PDM device instance: %d\n", iInstance));
2161 RTStrPrintf((char *)pThis->szInstance, sizeof(pThis->szInstance), "VIRTIOSCSI%d", iInstance);
2162
2163 /* Usable defaults */
2164 pThis->cTargets = 1;
2165
2166 /*
2167 * Validate and read configuration.
2168 */
2169 if (!CFGMR3AreValuesValid(pCfg,"NumTargets\0"
2170 "Bootable\0"
2171 /* "GCEnabled\0" TBD */
2172 /* "R0Enabled\0" TBD */
2173 ))
2174 return PDMDEV_SET_ERROR(pDevIns, VERR_PDM_DEVINS_UNKNOWN_CFG_VALUES,
2175 N_("virtio-scsi configuration error: unknown option specified"));
2176
2177 rc = CFGMR3QueryIntegerDef(pCfg, "NumTargets", &pThis->cTargets, true);
2178 if (RT_FAILURE(rc))
2179 return PDMDEV_SET_ERROR(pDevIns, rc,
2180 N_("virtio-scsi configuration error: failed to read NumTargets as integer"));
2181 LogFunc(("NumTargets=%d\n", pThis->cTargets));
2182
2183 rc = CFGMR3QueryBoolDef(pCfg, "Bootable", &pThis->fBootable, true);
2184 if (RT_FAILURE(rc))
2185 return PDMDEV_SET_ERROR(pDevIns, rc,
2186 N_("virtio-scsi configuration error: failed to read Bootable as boolean"));
2187 LogFunc(("Bootable=%RTbool (unimplemented)\n", pThis->fBootable));
2188
2189 rc = CFGMR3QueryBoolDef(pCfg, "R0Enabled", &pThis->fR0Enabled, false);
2190 if (RT_FAILURE(rc))
2191 return PDMDEV_SET_ERROR(pDevIns, rc,
2192 N_("virtio-scsi configuration error: failed to read R0Enabled as boolean"));
2193
2194 rc = CFGMR3QueryBoolDef(pCfg, "RCEnabled", &pThis->fRCEnabled, false);
2195 if (RT_FAILURE(rc))
2196 return PDMDEV_SET_ERROR(pDevIns, rc,
2197 N_("virtio-scsi configuration error: failed to read RCEnabled as boolean"));
2198
2199 VIRTIOPCIPARAMS virtioPciParams, *pVirtioPciParams = &virtioPciParams;
2200 pVirtioPciParams->uDeviceId = PCI_DEVICE_ID_VIRTIOSCSI_HOST;
2201 pVirtioPciParams->uClassBase = PCI_CLASS_BASE_MASS_STORAGE;
2202 pVirtioPciParams->uClassSub = PCI_CLASS_SUB_SCSI_STORAGE_CONTROLLER;
2203 pVirtioPciParams->uClassProg = PCI_CLASS_PROG_UNSPECIFIED;
2204 pVirtioPciParams->uSubsystemId = PCI_DEVICE_ID_VIRTIOSCSI_HOST; /* Virtio 1.0 spec allows PCI Device ID here */
2205 pVirtioPciParams->uInterruptLine = 0x00;
2206 pVirtioPciParams->uInterruptPin = 0x01;
2207
2208 pThis->IBase.pfnQueryInterface = virtioScsiDeviceQueryInterface;
2209
2210 /* Configure virtio_scsi_config that transacts via VirtIO implementation's Dev. Specific Cap callbacks */
2211 pThis->virtioScsiConfig.uNumQueues = VIRTIOSCSI_REQ_QUEUE_CNT;
2212 pThis->virtioScsiConfig.uSegMax = VIRTIOSCSI_MAX_SEG_COUNT;
2213 pThis->virtioScsiConfig.uMaxSectors = VIRTIOSCSI_MAX_SECTORS_HINT;
2214 pThis->virtioScsiConfig.uCmdPerLun = VIRTIOSCSI_MAX_COMMANDS_PER_LUN;
2215 pThis->virtioScsiConfig.uEventInfoSize = sizeof(VIRTIOSCSI_EVENT_T); /* Spec says at least this size! */
2216 pThis->virtioScsiConfig.uSenseSize = VIRTIOSCSI_SENSE_SIZE_DEFAULT;
2217 pThis->virtioScsiConfig.uCdbSize = VIRTIOSCSI_CDB_SIZE_DEFAULT;
2218 pThis->virtioScsiConfig.uMaxChannel = VIRTIOSCSI_MAX_CHANNEL_HINT;
2219 pThis->virtioScsiConfig.uMaxTarget = pThis->cTargets;
2220 pThis->virtioScsiConfig.uMaxLun = VIRTIOSCSI_MAX_LUN;
2221
2222 rc = virtioConstruct(pDevIns, pThis, &pThis->hVirtio, pVirtioPciParams, pThis->szInstance,
2223 VIRTIOSCSI_HOST_SCSI_FEATURES_OFFERED,
2224 virtioScsiDevCapRead,
2225 virtioScsiDevCapWrite,
2226 virtioScsiStatusChanged,
2227 virtioScsiNotified,
2228 virtioScsiLiveExec,
2229 virtioScsiSaveExec,
2230 virtioScsiLoadExec,
2231 virtioScsiLoadDone,
2232 sizeof(VIRTIOSCSI_CONFIG_T) /* cbDevSpecificCap */,
2233 (void *)&pThis->virtioScsiConfig /* pDevSpecificCap */);
2234
2235 if (RT_FAILURE(rc))
2236 return PDMDEV_SET_ERROR(pDevIns, rc, N_("virtio-scsi: failed to initialize VirtIO"));
2237
2238 RTStrCopy((char *)pThis->szQueueNames[CONTROLQ_IDX], VIRTIO_MAX_QUEUE_NAME_SIZE, "controlq");
2239 RTStrCopy((char *)pThis->szQueueNames[EVENTQ_IDX], VIRTIO_MAX_QUEUE_NAME_SIZE, "eventq");
2240 for (uint16_t qIdx = VIRTQ_REQ_BASE; qIdx < VIRTQ_REQ_BASE + VIRTIOSCSI_REQ_QUEUE_CNT; qIdx++)
2241 RTStrPrintf((char *)pThis->szQueueNames[qIdx], VIRTIO_MAX_QUEUE_NAME_SIZE,
2242 "requestq<%d>", qIdx - VIRTQ_REQ_BASE);
2243
2244 for (uint16_t qIdx = 0; qIdx < VIRTIOSCSI_QUEUE_CNT; qIdx++)
2245 {
2246 rc = virtioQueueAttach(pThis->hVirtio, qIdx, QUEUENAME(qIdx));
2247 AssertMsgReturn(rc == VINF_SUCCESS, ("Failed to attach queue %s\n", QUEUENAME(qIdx)), rc);
2248 pThis->fQueueAttached[qIdx] = (rc == VINF_SUCCESS);
2249
2250 if (qIdx == CONTROLQ_IDX || IS_REQ_QUEUE(qIdx))
2251 {
2252 rc = PDMDevHlpThreadCreate(pDevIns, &pThis->aWorker[qIdx].pThread,
2253 (void *)(uint64_t)qIdx, virtioScsiWorker,
2254 virtioScsiWorkerWakeUp, 0, RTTHREADTYPE_IO, QUEUENAME(qIdx));
2255 if (rc != VINF_SUCCESS)
2256 {
2257 LogRel(("Error creating thread for Virtual Queue %s\n", QUEUENAME(qIdx)));
2258 return rc;
2259 }
2260
2261 rc = SUPSemEventCreate(pThis->pSupDrvSession, &pThis->aWorker[qIdx].hEvtProcess);
2262 if (RT_FAILURE(rc))
2263 return PDMDevHlpVMSetError(pDevIns, rc, RT_SRC_POS,
2264 N_("DevVirtioSCSI: Failed to create SUP event semaphore"));
2265 }
2266 }
2267
2268#ifdef BOOTABLE_SUPPORT_TBD
2269 if (fBootable)
2270 {
2271 /* Register I/O port space for BIOS access. */
2272 rc = PDMDevHlpIOPortRegister(pDevIns, VIRTIOSCSI_BIOS_IO_PORT, 4, NULL,
2273 virtioScsiBiosIoPortWrite, virtioScsiBiosIoPortRead,
2274 virtioScsiBiosIoPortWriteStr, virtioScsiBiosIoPortReadStr,
2275 "virtio-scsi BIOS");
2276 if (RT_FAILURE(rc))
2277 return PDMDEV_SET_ERROR(pDevIns, rc, N_("virtio-scsi cannot register BIOS I/O handlers"));
2278 }
2279#endif
2280
2281 /* Initialize per device instance. */
2282
2283 Log2Func(("Found %d targets attached to controller\n", pThis->cTargets));
2284
2285 pThis->paTargetInstances = (PVIRTIOSCSITARGET)RTMemAllocZ(sizeof(VIRTIOSCSITARGET) * pThis->cTargets);
2286 if (!pThis->paTargetInstances)
2287 return PDMDEV_SET_ERROR(pDevIns, rc, N_("Failed to allocate memory for target states"));
2288
2289 for (RTUINT iTarget = 0; iTarget < pThis->cTargets; iTarget++)
2290 {
2291 PVIRTIOSCSITARGET pTarget = &pThis->paTargetInstances[iTarget];
2292
2293 if (RTStrAPrintf(&pTarget->pszTargetName, "VSCSI%u", iTarget) < 0)
2294 AssertLogRelFailedReturn(VERR_NO_MEMORY);
2295
2296 /* Initialize static parts of the device. */
2297 pTarget->iTarget = iTarget;
2298 pTarget->pVirtioScsi = pThis;
2299 pTarget->led.u32Magic = PDMLED_MAGIC;
2300
2301 pTarget->IBase.pfnQueryInterface = virtioScsiTargetQueryInterface;
2302
2303 /* IMediaPort and IMediaExPort interfaces provide callbacks for VD media and downstream driver access */
2304 pTarget->IMediaPort.pfnQueryDeviceLocation = virtioScsiQueryDeviceLocation;
2305 pTarget->IMediaExPort.pfnIoReqCompleteNotify = virtioScsiIoReqFinish;
2306 pTarget->IMediaExPort.pfnIoReqCopyFromBuf = virtioScsiIoReqCopyFromBuf;
2307 pTarget->IMediaExPort.pfnIoReqCopyToBuf = virtioScsiIoReqCopyToBuf;
2308 pTarget->IMediaExPort.pfnIoReqStateChanged = virtioScsiIoReqStateChanged;
2309 pTarget->IMediaExPort.pfnMediumEjected = virtioScsiMediumEjected;
2310 pTarget->IMediaExPort.pfnIoReqQueryBuf = NULL; /* When used avoids copyFromBuf CopyToBuf*/
2311 pTarget->IMediaExPort.pfnIoReqQueryDiscardRanges = NULL;
2312
2313
2314 pTarget->IBase.pfnQueryInterface = virtioScsiTargetQueryInterface;
2315 pTarget->ILed.pfnQueryStatusLed = virtioScsiTargetQueryStatusLed;
2316 pThis->ILeds.pfnQueryStatusLed = virtioScsiDeviceQueryStatusLed;
2317 pTarget->led.u32Magic = PDMLED_MAGIC;
2318
2319 LogFunc(("Attaching LUN: %s\n", pTarget->pszTargetName));
2320
2321 AssertReturn(iTarget < pThis->cTargets, VERR_PDM_NO_SUCH_LUN);
2322 rc = PDMDevHlpDriverAttach(pDevIns, iTarget, &pTarget->IBase, &pTarget->pDrvBase, pTarget->pszTargetName);
2323 if (RT_SUCCESS(rc))
2324 {
2325 pTarget->fPresent = true;
2326
2327 pTarget->pDrvMedia = PDMIBASE_QUERY_INTERFACE(pTarget->pDrvBase, PDMIMEDIA);
2328 AssertMsgReturn(VALID_PTR(pTarget->pDrvMedia),
2329 ("virtio-scsi configuration error: LUN#%d missing basic media interface!\n", iTarget),
2330 VERR_PDM_MISSING_INTERFACE);
2331
2332 /* Get the extended media interface. */
2333 pTarget->pDrvMediaEx = PDMIBASE_QUERY_INTERFACE(pTarget->pDrvBase, PDMIMEDIAEX);
2334 AssertMsgReturn(VALID_PTR(pTarget->pDrvMediaEx),
2335 ("virtio-scsi configuration error: LUN#%d missing extended media interface!\n", iTarget),
2336 VERR_PDM_MISSING_INTERFACE);
2337
2338 rc = pTarget->pDrvMediaEx->pfnIoReqAllocSizeSet(pTarget->pDrvMediaEx, sizeof(VIRTIOSCSIREQ));
2339 AssertMsgReturn(VALID_PTR(pTarget->pDrvMediaEx),
2340 ("virtio-scsi configuration error: LUN#%u: Failed to set I/O request size!\n", iTarget),
2341 rc);
2342
2343 pTarget->pMediaNotify = PDMIBASE_QUERY_INTERFACE(pTarget->pDrvBase, PDMIMEDIANOTIFY);
2344 AssertMsgReturn(VALID_PTR(pTarget->pDrvMediaEx),
2345 ("virtio-scsi configuration error: LUN#%u: Failed to get set Media notify obj!\n",
2346 iTarget), rc);
2347
2348 }
2349 else if (rc == VERR_PDM_NO_ATTACHED_DRIVER)
2350 {
2351 pTarget->fPresent = false;
2352 pTarget->pDrvBase = NULL;
2353 rc = VINF_SUCCESS;
2354 Log(("virtio-scsi: no driver attached to device %s\n", pTarget->pszTargetName));
2355 }
2356 else
2357 {
2358 AssertLogRelMsgFailed(("virtio-scsi: Failed to attach %s: %Rrc\n", pTarget->pszTargetName, rc));
2359 return rc;
2360 }
2361 }
2362
2363 /* Status driver */
2364 PPDMIBASE pUpBase;
2365 rc = PDMDevHlpDriverAttach(pDevIns, PDM_STATUS_LUN, &pThis->IBase, &pUpBase, "Status Port");
2366 if (RT_FAILURE(rc))
2367 return PDMDEV_SET_ERROR(pDevIns, rc, N_("Failed to attach the status LUN"));
2368
2369 /*
2370 * Register the debugger info callback.
2371 */
2372 char szTmp[128];
2373 RTStrPrintf(szTmp, sizeof(szTmp), "%s%d", pDevIns->pReg->szName, pDevIns->iInstance);
2374 PDMDevHlpDBGFInfoRegister(pDevIns, szTmp, "virtio-scsi info", virtioScsiInfo);
2375
2376 return rc;
2377}
2378
2379/**
2380 * The device registration structure.
2381 */
2382const PDMDEVREG g_DeviceVirtioSCSI =
2383{
2384 /* .u32Version = */ PDM_DEVREG_VERSION,
2385 /* .uReserved0 = */ 0,
2386 /* .szName = */ "virtio-scsi",
2387#ifdef VIRTIOSCSI_GC_SUPPORT
2388 /* .fFlags = */ PDM_DEVREG_FLAGS_DEFAULT_BITS | PDM_DEVREG_FLAGS_RC | PDM_DEVREG_FLAGS_R0
2389 | PDM_DEVREG_FLAGS_FIRST_SUSPEND_NOTIFICATION
2390 | PDM_DEVREG_FLAGS_FIRST_POWEROFF_NOTIFICATION,
2391#else
2392 /* .fFlags = */ PDM_DEVREG_FLAGS_DEFAULT_BITS
2393 | PDM_DEVREG_FLAGS_FIRST_SUSPEND_NOTIFICATION
2394 | PDM_DEVREG_FLAGS_FIRST_POWEROFF_NOTIFICATION,
2395#endif
2396 /* .fClass = */ PDM_DEVREG_CLASS_MISC,
2397 /* .cMaxInstances = */ ~0U,
2398 /* .uSharedVersion = */ 42,
2399 /* .cbInstanceShared = */ sizeof(VIRTIOSCSI),
2400 /* .cbInstanceCC = */ 0,
2401 /* .cbInstanceRC = */ 0,
2402 /* .cMaxPciDevices = */ 1,
2403 /* .cMaxMsixVectors = */ VBOX_MSIX_MAX_ENTRIES,
2404 /* .pszDescription = */ "Virtio Host SCSI.\n",
2405#if defined(IN_RING3)
2406 /* .pszRCMod = */ "VBoxDDRC.rc",
2407 /* .pszR0Mod = */ "VBoxDDR0.r0",
2408 /* .pfnConstruct = */ virtioScsiConstruct,
2409 /* .pfnDestruct = */ virtioScsiDestruct,
2410 /* .pfnRelocate = */ virtioScsiRelocate,
2411 /* .pfnMemSetup = */ NULL,
2412 /* .pfnPowerOn = */ NULL,
2413 /* .pfnReset = */ virtioScsiReset,
2414 /* .pfnSuspend = */ virtioScsiSuspendOrPoweroff,
2415 /* .pfnResume = */ virtioScsiResume,
2416 /* .pfnAttach = */ virtioScsiAttach,
2417 /* .pfnDetach = */ virtioScsiDetach,
2418 /* .pfnQueryInterface = */ NULL,
2419 /* .pfnInitComplete = */ NULL,
2420 /* .pfnPowerOff = */ virtioScsiSuspendOrPoweroff,
2421 /* .pfnSoftReset = */ NULL,
2422 /* .pfnReserved0 = */ NULL,
2423 /* .pfnReserved1 = */ NULL,
2424 /* .pfnReserved2 = */ NULL,
2425 /* .pfnReserved3 = */ NULL,
2426 /* .pfnReserved4 = */ NULL,
2427 /* .pfnReserved5 = */ NULL,
2428 /* .pfnReserved6 = */ NULL,
2429 /* .pfnReserved7 = */ NULL,
2430#elif defined(IN_RING0)
2431 /* .pfnEarlyConstruct = */ NULL,
2432 /* .pfnConstruct = */ NULL,
2433 /* .pfnDestruct = */ NULL,
2434 /* .pfnFinalDestruct = */ NULL,
2435 /* .pfnRequest = */ NULL,
2436 /* .pfnReserved0 = */ NULL,
2437 /* .pfnReserved1 = */ NULL,
2438 /* .pfnReserved2 = */ NULL,
2439 /* .pfnReserved3 = */ NULL,
2440 /* .pfnReserved4 = */ NULL,
2441 /* .pfnReserved5 = */ NULL,
2442 /* .pfnReserved6 = */ NULL,
2443 /* .pfnReserved7 = */ NULL,
2444#elif defined(IN_RC)
2445 /* .pfnConstruct = */ NULL,
2446 /* .pfnReserved0 = */ NULL,
2447 /* .pfnReserved1 = */ NULL,
2448 /* .pfnReserved2 = */ NULL,
2449 /* .pfnReserved3 = */ NULL,
2450 /* .pfnReserved4 = */ NULL,
2451 /* .pfnReserved5 = */ NULL,
2452 /* .pfnReserved6 = */ NULL,
2453 /* .pfnReserved7 = */ NULL,
2454#else
2455# error "Not in IN_RING3, IN_RING0 or IN_RC!"
2456#endif
2457 /* .u32VersionEnd = */ PDM_DEVREG_VERSION
2458};
2459
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