eaad0fe260
Stop depending on the AioContext lock and instead access SCSIDevice->requests from only one thread at a time: - When the VM is running only the BlockBackend's AioContext may access the requests list. - When the VM is stopped only the main loop may access the requests list. These constraints protect the requests list without the need for locking in the I/O code path. Note that multiple IOThreads are not supported yet because the code assumes all SCSIRequests are executed from a single AioContext. Leave that as future work. Signed-off-by: Stefan Hajnoczi <stefanha@redhat.com> Reviewed-by: Eric Blake <eblake@redhat.com> Message-ID: <20231204164259.1515217-2-stefanha@redhat.com> Signed-off-by: Kevin Wolf <kwolf@redhat.com>
257 lines
9.1 KiB
C
257 lines
9.1 KiB
C
#ifndef QEMU_HW_SCSI_H
|
|
#define QEMU_HW_SCSI_H
|
|
|
|
#include "block/aio.h"
|
|
#include "hw/block/block.h"
|
|
#include "hw/qdev-core.h"
|
|
#include "scsi/utils.h"
|
|
#include "qemu/notify.h"
|
|
#include "qom/object.h"
|
|
|
|
#define MAX_SCSI_DEVS 255
|
|
|
|
typedef struct SCSIBus SCSIBus;
|
|
typedef struct SCSIBusInfo SCSIBusInfo;
|
|
typedef struct SCSIDevice SCSIDevice;
|
|
typedef struct SCSIRequest SCSIRequest;
|
|
typedef struct SCSIReqOps SCSIReqOps;
|
|
|
|
#define SCSI_SENSE_BUF_SIZE_OLD 96
|
|
#define SCSI_SENSE_BUF_SIZE 252
|
|
#define DEFAULT_IO_TIMEOUT 30
|
|
|
|
struct SCSIRequest {
|
|
SCSIBus *bus;
|
|
SCSIDevice *dev;
|
|
const SCSIReqOps *ops;
|
|
uint32_t refcount;
|
|
uint32_t tag;
|
|
uint32_t lun;
|
|
int16_t status;
|
|
int16_t host_status;
|
|
void *hba_private;
|
|
uint64_t residual;
|
|
SCSICommand cmd;
|
|
NotifierList cancel_notifiers;
|
|
|
|
/* Note:
|
|
* - fields before sense are initialized by scsi_req_alloc;
|
|
* - sense[] is uninitialized;
|
|
* - fields after sense are memset to 0 by scsi_req_alloc.
|
|
* */
|
|
|
|
uint8_t sense[SCSI_SENSE_BUF_SIZE];
|
|
uint32_t sense_len;
|
|
bool enqueued;
|
|
bool io_canceled;
|
|
bool retry;
|
|
bool dma_started;
|
|
BlockAIOCB *aiocb;
|
|
QEMUSGList *sg;
|
|
QTAILQ_ENTRY(SCSIRequest) next;
|
|
};
|
|
|
|
#define TYPE_SCSI_DEVICE "scsi-device"
|
|
OBJECT_DECLARE_TYPE(SCSIDevice, SCSIDeviceClass, SCSI_DEVICE)
|
|
|
|
struct SCSIDeviceClass {
|
|
DeviceClass parent_class;
|
|
void (*realize)(SCSIDevice *dev, Error **errp);
|
|
void (*unrealize)(SCSIDevice *dev);
|
|
int (*parse_cdb)(SCSIDevice *dev, SCSICommand *cmd, uint8_t *buf,
|
|
size_t buf_len, void *hba_private);
|
|
SCSIRequest *(*alloc_req)(SCSIDevice *s, uint32_t tag, uint32_t lun,
|
|
uint8_t *buf, void *hba_private);
|
|
void (*unit_attention_reported)(SCSIDevice *s);
|
|
};
|
|
|
|
struct SCSIDevice
|
|
{
|
|
DeviceState qdev;
|
|
VMChangeStateEntry *vmsentry;
|
|
uint32_t id;
|
|
BlockConf conf;
|
|
SCSISense unit_attention;
|
|
bool sense_is_ua;
|
|
uint8_t sense[SCSI_SENSE_BUF_SIZE];
|
|
uint32_t sense_len;
|
|
|
|
/*
|
|
* The requests list is only accessed from the AioContext that executes
|
|
* requests or from the main loop when IOThread processing is stopped.
|
|
*/
|
|
QTAILQ_HEAD(, SCSIRequest) requests;
|
|
|
|
uint32_t channel;
|
|
uint32_t lun;
|
|
int blocksize;
|
|
int type;
|
|
uint64_t max_lba;
|
|
uint64_t wwn;
|
|
uint64_t port_wwn;
|
|
int scsi_version;
|
|
int default_scsi_version;
|
|
uint32_t io_timeout;
|
|
bool needs_vpd_bl_emulation;
|
|
bool hba_supports_iothread;
|
|
};
|
|
|
|
extern const VMStateDescription vmstate_scsi_device;
|
|
|
|
#define VMSTATE_SCSI_DEVICE(_field, _state) { \
|
|
.name = (stringify(_field)), \
|
|
.size = sizeof(SCSIDevice), \
|
|
.vmsd = &vmstate_scsi_device, \
|
|
.flags = VMS_STRUCT, \
|
|
.offset = vmstate_offset_value(_state, _field, SCSIDevice), \
|
|
}
|
|
|
|
/* cdrom.c */
|
|
int cdrom_read_toc(int nb_sectors, uint8_t *buf, int msf, int start_track);
|
|
int cdrom_read_toc_raw(int nb_sectors, uint8_t *buf, int msf, int session_num);
|
|
|
|
/* scsi-bus.c */
|
|
struct SCSIReqOps {
|
|
size_t size;
|
|
void (*init_req)(SCSIRequest *req);
|
|
void (*free_req)(SCSIRequest *req);
|
|
int32_t (*send_command)(SCSIRequest *req, uint8_t *buf);
|
|
void (*read_data)(SCSIRequest *req);
|
|
void (*write_data)(SCSIRequest *req);
|
|
uint8_t *(*get_buf)(SCSIRequest *req);
|
|
|
|
void (*save_request)(QEMUFile *f, SCSIRequest *req);
|
|
void (*load_request)(QEMUFile *f, SCSIRequest *req);
|
|
};
|
|
|
|
struct SCSIBusInfo {
|
|
int tcq;
|
|
int max_channel, max_target, max_lun;
|
|
int (*parse_cdb)(SCSIDevice *dev, SCSICommand *cmd, uint8_t *buf,
|
|
size_t buf_len, void *hba_private);
|
|
void (*transfer_data)(SCSIRequest *req, uint32_t arg);
|
|
void (*fail)(SCSIRequest *req);
|
|
void (*complete)(SCSIRequest *req, size_t residual);
|
|
void (*cancel)(SCSIRequest *req);
|
|
void (*change)(SCSIBus *bus, SCSIDevice *dev, SCSISense sense);
|
|
QEMUSGList *(*get_sg_list)(SCSIRequest *req);
|
|
|
|
void (*save_request)(QEMUFile *f, SCSIRequest *req);
|
|
void *(*load_request)(QEMUFile *f, SCSIRequest *req);
|
|
void (*free_request)(SCSIBus *bus, void *priv);
|
|
|
|
/*
|
|
* Temporarily stop submitting new requests between drained_begin() and
|
|
* drained_end(). Called from the main loop thread with the BQL held.
|
|
*
|
|
* Implement these callbacks if request processing is triggered by a file
|
|
* descriptor like an EventNotifier. Otherwise set them to NULL.
|
|
*/
|
|
void (*drained_begin)(SCSIBus *bus);
|
|
void (*drained_end)(SCSIBus *bus);
|
|
};
|
|
|
|
#define TYPE_SCSI_BUS "SCSI"
|
|
OBJECT_DECLARE_SIMPLE_TYPE(SCSIBus, SCSI_BUS)
|
|
|
|
struct SCSIBus {
|
|
BusState qbus;
|
|
int busnr;
|
|
|
|
SCSISense unit_attention;
|
|
const SCSIBusInfo *info;
|
|
|
|
int drain_count; /* protected by BQL */
|
|
};
|
|
|
|
/**
|
|
* scsi_bus_init_named: Initialize a SCSI bus with the specified name
|
|
* @bus: SCSIBus object to initialize
|
|
* @bus_size: size of @bus object
|
|
* @host: Device which owns the bus (generally the SCSI controller)
|
|
* @info: structure defining callbacks etc for the controller
|
|
* @bus_name: Name to use for this bus
|
|
*
|
|
* This in-place initializes @bus as a new SCSI bus with a name
|
|
* provided by the caller. It is the caller's responsibility to make
|
|
* sure that name does not clash with the name of any other bus in the
|
|
* system. Unless you need the new bus to have a specific name, you
|
|
* should use scsi_bus_init() instead.
|
|
*/
|
|
void scsi_bus_init_named(SCSIBus *bus, size_t bus_size, DeviceState *host,
|
|
const SCSIBusInfo *info, const char *bus_name);
|
|
|
|
/**
|
|
* scsi_bus_init: Initialize a SCSI bus
|
|
*
|
|
* This in-place-initializes @bus as a new SCSI bus and gives it
|
|
* an automatically generated unique name.
|
|
*/
|
|
static inline void scsi_bus_init(SCSIBus *bus, size_t bus_size,
|
|
DeviceState *host, const SCSIBusInfo *info)
|
|
{
|
|
scsi_bus_init_named(bus, bus_size, host, info, NULL);
|
|
}
|
|
|
|
static inline SCSIBus *scsi_bus_from_device(SCSIDevice *d)
|
|
{
|
|
return DO_UPCAST(SCSIBus, qbus, d->qdev.parent_bus);
|
|
}
|
|
|
|
SCSIDevice *scsi_bus_legacy_add_drive(SCSIBus *bus, BlockBackend *blk,
|
|
int unit, bool removable, int bootindex,
|
|
bool share_rw,
|
|
BlockdevOnError rerror,
|
|
BlockdevOnError werror,
|
|
const char *serial, Error **errp);
|
|
void scsi_bus_set_ua(SCSIBus *bus, SCSISense sense);
|
|
void scsi_bus_legacy_handle_cmdline(SCSIBus *bus);
|
|
|
|
SCSIRequest *scsi_req_alloc(const SCSIReqOps *reqops, SCSIDevice *d,
|
|
uint32_t tag, uint32_t lun, void *hba_private);
|
|
SCSIRequest *scsi_req_new(SCSIDevice *d, uint32_t tag, uint32_t lun,
|
|
uint8_t *buf, size_t buf_len, void *hba_private);
|
|
int32_t scsi_req_enqueue(SCSIRequest *req);
|
|
SCSIRequest *scsi_req_ref(SCSIRequest *req);
|
|
void scsi_req_unref(SCSIRequest *req);
|
|
|
|
int scsi_bus_parse_cdb(SCSIDevice *dev, SCSICommand *cmd, uint8_t *buf,
|
|
size_t buf_len, void *hba_private);
|
|
int scsi_req_parse_cdb(SCSIDevice *dev, SCSICommand *cmd, uint8_t *buf,
|
|
size_t buf_len);
|
|
void scsi_req_build_sense(SCSIRequest *req, SCSISense sense);
|
|
void scsi_req_print(SCSIRequest *req);
|
|
void scsi_req_continue(SCSIRequest *req);
|
|
void scsi_req_data(SCSIRequest *req, int len);
|
|
void scsi_req_complete(SCSIRequest *req, int status);
|
|
void scsi_req_complete_failed(SCSIRequest *req, int host_status);
|
|
uint8_t *scsi_req_get_buf(SCSIRequest *req);
|
|
int scsi_req_get_sense(SCSIRequest *req, uint8_t *buf, int len);
|
|
void scsi_req_cancel_complete(SCSIRequest *req);
|
|
void scsi_req_cancel(SCSIRequest *req);
|
|
void scsi_req_cancel_async(SCSIRequest *req, Notifier *notifier);
|
|
void scsi_req_retry(SCSIRequest *req);
|
|
void scsi_device_drained_begin(SCSIDevice *sdev);
|
|
void scsi_device_drained_end(SCSIDevice *sdev);
|
|
void scsi_device_purge_requests(SCSIDevice *sdev, SCSISense sense);
|
|
void scsi_device_set_ua(SCSIDevice *sdev, SCSISense sense);
|
|
void scsi_device_report_change(SCSIDevice *dev, SCSISense sense);
|
|
void scsi_device_unit_attention_reported(SCSIDevice *dev);
|
|
void scsi_generic_read_device_inquiry(SCSIDevice *dev);
|
|
int scsi_device_get_sense(SCSIDevice *dev, uint8_t *buf, int len, bool fixed);
|
|
int scsi_SG_IO_FROM_DEV(BlockBackend *blk, uint8_t *cmd, uint8_t cmd_size,
|
|
uint8_t *buf, uint8_t buf_size, uint32_t timeout);
|
|
SCSIDevice *scsi_device_find(SCSIBus *bus, int channel, int target, int lun);
|
|
SCSIDevice *scsi_device_get(SCSIBus *bus, int channel, int target, int lun);
|
|
|
|
/* scsi-generic.c. */
|
|
extern const SCSIReqOps scsi_generic_req_ops;
|
|
|
|
/* scsi-disk.c */
|
|
#define SCSI_DISK_QUIRK_MODE_PAGE_APPLE_VENDOR 0
|
|
#define SCSI_DISK_QUIRK_MODE_SENSE_ROM_USE_DBD 1
|
|
#define SCSI_DISK_QUIRK_MODE_PAGE_VENDOR_SPECIFIC_APPLE 2
|
|
#define SCSI_DISK_QUIRK_MODE_PAGE_TRUNCATED 3
|
|
|
|
#endif
|