blob: 8471f38b730e205eb57052305c154260864bee95 [file] [log] [blame]
Thomas Gleixnerf33f5fe2019-05-22 09:51:24 +02001// SPDX-License-Identifier: GPL-2.0-or-later
Paolo Bonzini4fe74b12012-02-05 12:16:00 +01002/*
3 * Virtio SCSI HBA driver
4 *
5 * Copyright IBM Corp. 2010
6 * Copyright Red Hat, Inc. 2011
7 *
8 * Authors:
9 * Stefan Hajnoczi <stefanha@linux.vnet.ibm.com>
10 * Paolo Bonzini <pbonzini@redhat.com>
Paolo Bonzini4fe74b12012-02-05 12:16:00 +010011 */
12
Wanlong Gaoba06d1e2013-03-12 15:34:40 +103013#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
14
Paolo Bonzini4fe74b12012-02-05 12:16:00 +010015#include <linux/module.h>
16#include <linux/slab.h>
17#include <linux/mempool.h>
Christoph Hellwig0d9f0a52017-02-05 18:15:26 +010018#include <linux/interrupt.h>
Paolo Bonzini4fe74b12012-02-05 12:16:00 +010019#include <linux/virtio.h>
20#include <linux/virtio_ids.h>
21#include <linux/virtio_config.h>
22#include <linux/virtio_scsi.h>
Paolo Bonzini9141a4c2013-04-08 23:03:25 +093023#include <linux/cpu.h>
Nicholas Bellingere6dc783a2014-02-22 18:23:33 -080024#include <linux/blkdev.h>
Christoph Hellwigfe45e632021-09-20 14:33:27 +020025#include <linux/blk-integrity.h>
Paolo Bonzini4fe74b12012-02-05 12:16:00 +010026#include <scsi/scsi_host.h>
27#include <scsi/scsi_device.h>
28#include <scsi/scsi_cmnd.h>
Venkatesh Srinivas761f1192014-07-06 16:39:27 +020029#include <scsi/scsi_tcq.h>
David Gibson25d1d502017-04-13 12:13:00 +100030#include <scsi/scsi_devinfo.h>
Ming Lei938ece72014-07-06 16:39:26 +020031#include <linux/seqlock.h>
Christoph Hellwig0d9f0a52017-02-05 18:15:26 +010032#include <linux/blk-mq-virtio.h>
Paolo Bonzini4fe74b12012-02-05 12:16:00 +010033
Matt Lupfer5ff84372019-09-05 18:19:28 +000034#include "sd.h"
35
Paolo Bonzini4fe74b12012-02-05 12:16:00 +010036#define VIRTIO_SCSI_MEMPOOL_SZ 64
Cong Meng365a7152012-07-05 17:06:43 +080037#define VIRTIO_SCSI_EVENT_LEN 8
Paolo Bonzini9141a4c2013-04-08 23:03:25 +093038#define VIRTIO_SCSI_VQ_BASE 2
Paolo Bonzini4fe74b12012-02-05 12:16:00 +010039
Mike Christie95e724962023-12-13 23:26:49 -060040static unsigned int virtscsi_poll_queues;
41module_param(virtscsi_poll_queues, uint, 0644);
42MODULE_PARM_DESC(virtscsi_poll_queues,
43 "The number of dedicated virtqueues for polling I/O");
44
Paolo Bonzini4fe74b12012-02-05 12:16:00 +010045/* Command queue element */
46struct virtio_scsi_cmd {
47 struct scsi_cmnd *sc;
48 struct completion *comp;
49 union {
50 struct virtio_scsi_cmd_req cmd;
Nicholas Bellingere6dc783a2014-02-22 18:23:33 -080051 struct virtio_scsi_cmd_req_pi cmd_pi;
Paolo Bonzini4fe74b12012-02-05 12:16:00 +010052 struct virtio_scsi_ctrl_tmf_req tmf;
53 struct virtio_scsi_ctrl_an_req an;
54 } req;
55 union {
56 struct virtio_scsi_cmd_resp cmd;
57 struct virtio_scsi_ctrl_tmf_resp tmf;
58 struct virtio_scsi_ctrl_an_resp an;
59 struct virtio_scsi_event evt;
60 } resp;
61} ____cacheline_aligned_in_smp;
62
Cong Meng365a7152012-07-05 17:06:43 +080063struct virtio_scsi_event_node {
64 struct virtio_scsi *vscsi;
65 struct virtio_scsi_event event;
66 struct work_struct work;
67};
68
Paolo Bonzini139fe452012-06-13 16:56:32 +020069struct virtio_scsi_vq {
70 /* Protects vq */
Paolo Bonzini4fe74b12012-02-05 12:16:00 +010071 spinlock_t vq_lock;
72
Paolo Bonzini139fe452012-06-13 16:56:32 +020073 struct virtqueue *vq;
74};
75
76/* Driver instance state */
77struct virtio_scsi {
Paolo Bonzini4fe74b12012-02-05 12:16:00 +010078 struct virtio_device *vdev;
Paolo Bonzini2bd37f02012-06-13 16:56:34 +020079
Cong Meng365a7152012-07-05 17:06:43 +080080 /* Get some buffers ready for event vq */
81 struct virtio_scsi_event_node event_list[VIRTIO_SCSI_EVENT_LEN];
Paolo Bonzini9141a4c2013-04-08 23:03:25 +093082
83 u32 num_queues;
Mike Christie95e724962023-12-13 23:26:49 -060084 int io_queues[HCTX_MAX_TYPES];
Paolo Bonzini9141a4c2013-04-08 23:03:25 +093085
Sebastian Andrzej Siewior8904f5a2016-09-06 19:04:46 +020086 struct hlist_node node;
Wanlong Gao285e71e2013-04-08 23:05:49 +093087
Michael S. Tsirkine67423c2014-10-15 10:22:33 +103088 /* Protected by event_vq lock */
89 bool stop_events;
90
Paolo Bonzini9141a4c2013-04-08 23:03:25 +093091 struct virtio_scsi_vq ctrl_vq;
92 struct virtio_scsi_vq event_vq;
93 struct virtio_scsi_vq req_vqs[];
Paolo Bonzini4fe74b12012-02-05 12:16:00 +010094};
95
96static struct kmem_cache *virtscsi_cmd_cache;
97static mempool_t *virtscsi_cmd_pool;
98
99static inline struct Scsi_Host *virtio_scsi_host(struct virtio_device *vdev)
100{
101 return vdev->priv;
102}
103
104static void virtscsi_compute_resid(struct scsi_cmnd *sc, u32 resid)
105{
Christoph Hellwigae3d56d2019-01-29 09:33:07 +0100106 if (resid)
Xie Yongji5f638e52021-06-15 18:52:18 +0800107 scsi_set_resid(sc, min(resid, scsi_bufflen(sc)));
Paolo Bonzini4fe74b12012-02-05 12:16:00 +0100108}
109
Lee Jonese31f2662020-07-13 08:59:49 +0100110/*
Paolo Bonzini4fe74b12012-02-05 12:16:00 +0100111 * virtscsi_complete_cmd - finish a scsi_cmd and invoke scsi_done
112 *
113 * Called with vq_lock held.
114 */
Paolo Bonzini7f82b3c2013-04-08 23:01:38 +0930115static void virtscsi_complete_cmd(struct virtio_scsi *vscsi, void *buf)
Paolo Bonzini4fe74b12012-02-05 12:16:00 +0100116{
117 struct virtio_scsi_cmd *cmd = buf;
118 struct scsi_cmnd *sc = cmd->sc;
119 struct virtio_scsi_cmd_resp *resp = &cmd->resp.cmd;
120
121 dev_dbg(&sc->device->sdev_gendev,
122 "cmd %p response %u status %#02x sense_len %u\n",
123 sc, resp->response, resp->status, resp->sense_len);
124
125 sc->result = resp->status;
Michael S. Tsirkind75dff32014-11-23 17:28:57 +0200126 virtscsi_compute_resid(sc, virtio32_to_cpu(vscsi->vdev, resp->resid));
Paolo Bonzini4fe74b12012-02-05 12:16:00 +0100127 switch (resp->response) {
128 case VIRTIO_SCSI_S_OK:
129 set_host_byte(sc, DID_OK);
130 break;
131 case VIRTIO_SCSI_S_OVERRUN:
132 set_host_byte(sc, DID_ERROR);
133 break;
134 case VIRTIO_SCSI_S_ABORTED:
135 set_host_byte(sc, DID_ABORT);
136 break;
137 case VIRTIO_SCSI_S_BAD_TARGET:
138 set_host_byte(sc, DID_BAD_TARGET);
139 break;
140 case VIRTIO_SCSI_S_RESET:
141 set_host_byte(sc, DID_RESET);
142 break;
143 case VIRTIO_SCSI_S_BUSY:
144 set_host_byte(sc, DID_BUS_BUSY);
145 break;
146 case VIRTIO_SCSI_S_TRANSPORT_FAILURE:
147 set_host_byte(sc, DID_TRANSPORT_DISRUPTED);
148 break;
149 case VIRTIO_SCSI_S_TARGET_FAILURE:
Mike Christiebeb4dac2022-08-11 20:00:21 -0500150 set_host_byte(sc, DID_BAD_TARGET);
Paolo Bonzini4fe74b12012-02-05 12:16:00 +0100151 break;
152 case VIRTIO_SCSI_S_NEXUS_FAILURE:
Mike Christie377a7b02022-08-11 20:00:22 -0500153 set_status_byte(sc, SAM_STAT_RESERVATION_CONFLICT);
Paolo Bonzini4fe74b12012-02-05 12:16:00 +0100154 break;
155 default:
156 scmd_printk(KERN_WARNING, sc, "Unknown response %d",
157 resp->response);
Gustavo A. R. Silvadf561f662020-08-23 17:36:59 -0500158 fallthrough;
Paolo Bonzini4fe74b12012-02-05 12:16:00 +0100159 case VIRTIO_SCSI_S_FAILURE:
160 set_host_byte(sc, DID_ERROR);
161 break;
162 }
163
Michael S. Tsirkind75dff32014-11-23 17:28:57 +0200164 WARN_ON(virtio32_to_cpu(vscsi->vdev, resp->sense_len) >
165 VIRTIO_SCSI_SENSE_SIZE);
Hannes Reineckec43ddbf2021-06-22 11:11:53 +0200166 if (resp->sense_len) {
Paolo Bonzini4fe74b12012-02-05 12:16:00 +0100167 memcpy(sc->sense_buffer, resp->sense,
Michael S. Tsirkind75dff32014-11-23 17:28:57 +0200168 min_t(u32,
169 virtio32_to_cpu(vscsi->vdev, resp->sense_len),
170 VIRTIO_SCSI_SENSE_SIZE));
Paolo Bonzini4fe74b12012-02-05 12:16:00 +0100171 }
172
Bart Van Asscheb4194fc2021-10-07 13:46:02 -0700173 scsi_done(sc);
Paolo Bonzini4fe74b12012-02-05 12:16:00 +0100174}
175
Paolo Bonzini10f34f62013-04-08 23:02:07 +0930176static void virtscsi_vq_done(struct virtio_scsi *vscsi,
177 struct virtio_scsi_vq *virtscsi_vq,
Paolo Bonzini7f82b3c2013-04-08 23:01:38 +0930178 void (*fn)(struct virtio_scsi *vscsi, void *buf))
Paolo Bonzini4fe74b12012-02-05 12:16:00 +0100179{
Paolo Bonzini4fe74b12012-02-05 12:16:00 +0100180 void *buf;
Paolo Bonzini4fe74b12012-02-05 12:16:00 +0100181 unsigned int len;
Paolo Bonzini10f34f62013-04-08 23:02:07 +0930182 unsigned long flags;
183 struct virtqueue *vq = virtscsi_vq->vq;
Paolo Bonzini4fe74b12012-02-05 12:16:00 +0100184
Paolo Bonzini10f34f62013-04-08 23:02:07 +0930185 spin_lock_irqsave(&virtscsi_vq->vq_lock, flags);
Paolo Bonzini4fe74b12012-02-05 12:16:00 +0100186 do {
187 virtqueue_disable_cb(vq);
188 while ((buf = virtqueue_get_buf(vq, &len)) != NULL)
Paolo Bonzini7f82b3c2013-04-08 23:01:38 +0930189 fn(vscsi, buf);
Heinz Graalfs2bf4fd32013-11-11 11:52:43 +1030190
Paolo Bonzini4fe74b12012-02-05 12:16:00 +0100191 } while (!virtqueue_enable_cb(vq));
Paolo Bonzini10f34f62013-04-08 23:02:07 +0930192 spin_unlock_irqrestore(&virtscsi_vq->vq_lock, flags);
Paolo Bonzini4fe74b12012-02-05 12:16:00 +0100193}
194
195static void virtscsi_req_done(struct virtqueue *vq)
196{
Paolo Bonzini139fe452012-06-13 16:56:32 +0200197 struct Scsi_Host *sh = virtio_scsi_host(vq->vdev);
198 struct virtio_scsi *vscsi = shost_priv(sh);
Paolo Bonzini9141a4c2013-04-08 23:03:25 +0930199 int index = vq->index - VIRTIO_SCSI_VQ_BASE;
200 struct virtio_scsi_vq *req_vq = &vscsi->req_vqs[index];
Paolo Bonzini139fe452012-06-13 16:56:32 +0200201
Paolo Bonzini9141a4c2013-04-08 23:03:25 +0930202 virtscsi_vq_done(vscsi, req_vq, virtscsi_complete_cmd);
Paolo Bonzini4fe74b12012-02-05 12:16:00 +0100203};
204
Paolo Bonzini8faeb522014-06-04 13:34:58 +0200205static void virtscsi_poll_requests(struct virtio_scsi *vscsi)
206{
207 int i, num_vqs;
208
209 num_vqs = vscsi->num_queues;
210 for (i = 0; i < num_vqs; i++)
211 virtscsi_vq_done(vscsi, &vscsi->req_vqs[i],
212 virtscsi_complete_cmd);
213}
214
Paolo Bonzini7f82b3c2013-04-08 23:01:38 +0930215static void virtscsi_complete_free(struct virtio_scsi *vscsi, void *buf)
Paolo Bonzini4fe74b12012-02-05 12:16:00 +0100216{
217 struct virtio_scsi_cmd *cmd = buf;
218
219 if (cmd->comp)
Daniel Wagnere8f81422016-09-13 10:58:50 +0200220 complete(cmd->comp);
Paolo Bonzini4fe74b12012-02-05 12:16:00 +0100221}
222
223static void virtscsi_ctrl_done(struct virtqueue *vq)
224{
Paolo Bonzini139fe452012-06-13 16:56:32 +0200225 struct Scsi_Host *sh = virtio_scsi_host(vq->vdev);
226 struct virtio_scsi *vscsi = shost_priv(sh);
Paolo Bonzini139fe452012-06-13 16:56:32 +0200227
Paolo Bonzini10f34f62013-04-08 23:02:07 +0930228 virtscsi_vq_done(vscsi, &vscsi->ctrl_vq, virtscsi_complete_free);
Paolo Bonzini4fe74b12012-02-05 12:16:00 +0100229};
230
Paolo Bonzinicdda0e52014-06-04 13:34:56 +0200231static void virtscsi_handle_event(struct work_struct *work);
232
Cong Meng365a7152012-07-05 17:06:43 +0800233static int virtscsi_kick_event(struct virtio_scsi *vscsi,
234 struct virtio_scsi_event_node *event_node)
235{
Rusty Russell4614e512012-10-16 23:56:16 +1030236 int err;
Cong Meng365a7152012-07-05 17:06:43 +0800237 struct scatterlist sg;
238 unsigned long flags;
239
Paolo Bonzinicdda0e52014-06-04 13:34:56 +0200240 INIT_WORK(&event_node->work, virtscsi_handle_event);
Richard W.M. Jones2e9c9df2012-10-02 17:25:46 +0200241 sg_init_one(&sg, &event_node->event, sizeof(struct virtio_scsi_event));
Cong Meng365a7152012-07-05 17:06:43 +0800242
243 spin_lock_irqsave(&vscsi->event_vq.vq_lock, flags);
244
Rusty Russellbf958292013-03-20 15:44:28 +1030245 err = virtqueue_add_inbuf(vscsi->event_vq.vq, &sg, 1, event_node,
246 GFP_ATOMIC);
Rusty Russell4614e512012-10-16 23:56:16 +1030247 if (!err)
Cong Meng365a7152012-07-05 17:06:43 +0800248 virtqueue_kick(vscsi->event_vq.vq);
249
250 spin_unlock_irqrestore(&vscsi->event_vq.vq_lock, flags);
251
Rusty Russell4614e512012-10-16 23:56:16 +1030252 return err;
Cong Meng365a7152012-07-05 17:06:43 +0800253}
254
255static int virtscsi_kick_event_all(struct virtio_scsi *vscsi)
256{
257 int i;
258
259 for (i = 0; i < VIRTIO_SCSI_EVENT_LEN; i++) {
260 vscsi->event_list[i].vscsi = vscsi;
261 virtscsi_kick_event(vscsi, &vscsi->event_list[i]);
262 }
263
264 return 0;
265}
266
267static void virtscsi_cancel_event_work(struct virtio_scsi *vscsi)
268{
269 int i;
270
Michael S. Tsirkine67423c2014-10-15 10:22:33 +1030271 /* Stop scheduling work before calling cancel_work_sync. */
272 spin_lock_irq(&vscsi->event_vq.vq_lock);
273 vscsi->stop_events = true;
274 spin_unlock_irq(&vscsi->event_vq.vq_lock);
275
Cong Meng365a7152012-07-05 17:06:43 +0800276 for (i = 0; i < VIRTIO_SCSI_EVENT_LEN; i++)
277 cancel_work_sync(&vscsi->event_list[i].work);
278}
279
280static void virtscsi_handle_transport_reset(struct virtio_scsi *vscsi,
Paolo Bonzini9141a4c2013-04-08 23:03:25 +0930281 struct virtio_scsi_event *event)
Cong Meng365a7152012-07-05 17:06:43 +0800282{
283 struct scsi_device *sdev;
284 struct Scsi_Host *shost = virtio_scsi_host(vscsi->vdev);
285 unsigned int target = event->lun[1];
286 unsigned int lun = (event->lun[2] << 8) | event->lun[3];
287
Michael S. Tsirkind75dff32014-11-23 17:28:57 +0200288 switch (virtio32_to_cpu(vscsi->vdev, event->reason)) {
Cong Meng365a7152012-07-05 17:06:43 +0800289 case VIRTIO_SCSI_EVT_RESET_RESCAN:
Matej Gencibeef6fd2020-08-28 12:21:35 +0000290 if (lun == 0) {
291 scsi_scan_target(&shost->shost_gendev, 0, target,
292 SCAN_WILD_CARD, SCSI_SCAN_INITIAL);
293 } else {
294 scsi_add_device(shost, 0, target, lun);
295 }
Cong Meng365a7152012-07-05 17:06:43 +0800296 break;
297 case VIRTIO_SCSI_EVT_RESET_REMOVED:
298 sdev = scsi_device_lookup(shost, 0, target, lun);
299 if (sdev) {
300 scsi_remove_device(sdev);
301 scsi_device_put(sdev);
302 } else {
303 pr_err("SCSI device %d 0 %d %d not found\n",
304 shost->host_no, target, lun);
305 }
306 break;
307 default:
Colin Ian Kingcced4c02021-09-25 00:03:30 +0100308 pr_info("Unsupported virtio scsi event reason %x\n", event->reason);
Cong Meng365a7152012-07-05 17:06:43 +0800309 }
310}
311
Paolo Bonzini865b58c2012-10-02 17:25:48 +0200312static void virtscsi_handle_param_change(struct virtio_scsi *vscsi,
313 struct virtio_scsi_event *event)
314{
315 struct scsi_device *sdev;
316 struct Scsi_Host *shost = virtio_scsi_host(vscsi->vdev);
317 unsigned int target = event->lun[1];
318 unsigned int lun = (event->lun[2] << 8) | event->lun[3];
Michael S. Tsirkind75dff32014-11-23 17:28:57 +0200319 u8 asc = virtio32_to_cpu(vscsi->vdev, event->reason) & 255;
320 u8 ascq = virtio32_to_cpu(vscsi->vdev, event->reason) >> 8;
Paolo Bonzini865b58c2012-10-02 17:25:48 +0200321
322 sdev = scsi_device_lookup(shost, 0, target, lun);
323 if (!sdev) {
324 pr_err("SCSI device %d 0 %d %d not found\n",
325 shost->host_no, target, lun);
326 return;
327 }
328
329 /* Handle "Parameters changed", "Mode parameters changed", and
330 "Capacity data has changed". */
331 if (asc == 0x2a && (ascq == 0x00 || ascq == 0x01 || ascq == 0x09))
Bart Van Assche79519522023-08-22 08:30:41 -0700332 scsi_rescan_device(sdev);
Paolo Bonzini865b58c2012-10-02 17:25:48 +0200333
334 scsi_device_put(sdev);
335}
336
Zheng Wang08707b52023-02-02 14:41:24 +0800337static int virtscsi_rescan_hotunplug(struct virtio_scsi *vscsi)
Matt Lupfer5ff84372019-09-05 18:19:28 +0000338{
339 struct scsi_device *sdev;
340 struct Scsi_Host *shost = virtio_scsi_host(vscsi->vdev);
341 unsigned char scsi_cmd[MAX_COMMAND_SIZE];
342 int result, inquiry_len, inq_result_len = 256;
343 char *inq_result = kmalloc(inq_result_len, GFP_KERNEL);
344
Christophe JAILLET0e5e41e2023-05-29 09:35:08 +0200345 if (!inq_result)
Zheng Wang08707b52023-02-02 14:41:24 +0800346 return -ENOMEM;
Zheng Wang08707b52023-02-02 14:41:24 +0800347
Matt Lupfer5ff84372019-09-05 18:19:28 +0000348 shost_for_each_device(sdev, shost) {
349 inquiry_len = sdev->inquiry_len ? sdev->inquiry_len : 36;
350
351 memset(scsi_cmd, 0, sizeof(scsi_cmd));
352 scsi_cmd[0] = INQUIRY;
353 scsi_cmd[4] = (unsigned char) inquiry_len;
354
355 memset(inq_result, 0, inq_result_len);
356
Mike Christie5314ce762022-12-29 13:01:51 -0600357 result = scsi_execute_cmd(sdev, scsi_cmd, REQ_OP_DRV_IN,
358 inq_result, inquiry_len,
Matt Lupfer5ff84372019-09-05 18:19:28 +0000359 SD_TIMEOUT, SD_MAX_RETRIES, NULL);
360
361 if (result == 0 && inq_result[0] >> 5) {
362 /* PQ indicates the LUN is not attached */
363 scsi_remove_device(sdev);
Hannes Reineckeced202f72021-04-27 10:30:12 +0200364 } else if (result > 0 && host_byte(result) == DID_BAD_TARGET) {
Maxim Levitskybb2e3312020-07-29 22:48:06 +0300365 /*
366 * If all LUNs of a virtio-scsi device are unplugged
367 * it will respond with BAD TARGET on any INQUIRY
368 * command.
369 * Remove the device in this case as well.
370 */
371 scsi_remove_device(sdev);
Matt Lupfer5ff84372019-09-05 18:19:28 +0000372 }
373 }
374
375 kfree(inq_result);
Zheng Wang08707b52023-02-02 14:41:24 +0800376 return 0;
Matt Lupfer5ff84372019-09-05 18:19:28 +0000377}
378
Cong Meng365a7152012-07-05 17:06:43 +0800379static void virtscsi_handle_event(struct work_struct *work)
380{
381 struct virtio_scsi_event_node *event_node =
382 container_of(work, struct virtio_scsi_event_node, work);
383 struct virtio_scsi *vscsi = event_node->vscsi;
384 struct virtio_scsi_event *event = &event_node->event;
385
Michael S. Tsirkind75dff32014-11-23 17:28:57 +0200386 if (event->event &
387 cpu_to_virtio32(vscsi->vdev, VIRTIO_SCSI_T_EVENTS_MISSED)) {
Zheng Wang08707b52023-02-02 14:41:24 +0800388 int ret;
389
Michael S. Tsirkind75dff32014-11-23 17:28:57 +0200390 event->event &= ~cpu_to_virtio32(vscsi->vdev,
391 VIRTIO_SCSI_T_EVENTS_MISSED);
Zheng Wang08707b52023-02-02 14:41:24 +0800392 ret = virtscsi_rescan_hotunplug(vscsi);
393 if (ret)
394 return;
Cong Meng365a7152012-07-05 17:06:43 +0800395 scsi_scan_host(virtio_scsi_host(vscsi->vdev));
396 }
397
Michael S. Tsirkind75dff32014-11-23 17:28:57 +0200398 switch (virtio32_to_cpu(vscsi->vdev, event->event)) {
Cong Meng365a7152012-07-05 17:06:43 +0800399 case VIRTIO_SCSI_T_NO_EVENT:
400 break;
401 case VIRTIO_SCSI_T_TRANSPORT_RESET:
402 virtscsi_handle_transport_reset(vscsi, event);
403 break;
Paolo Bonzini865b58c2012-10-02 17:25:48 +0200404 case VIRTIO_SCSI_T_PARAM_CHANGE:
405 virtscsi_handle_param_change(vscsi, event);
406 break;
Cong Meng365a7152012-07-05 17:06:43 +0800407 default:
Colin Ian Kingcced4c02021-09-25 00:03:30 +0100408 pr_err("Unsupported virtio scsi event %x\n", event->event);
Cong Meng365a7152012-07-05 17:06:43 +0800409 }
410 virtscsi_kick_event(vscsi, event_node);
411}
412
Paolo Bonzini7f82b3c2013-04-08 23:01:38 +0930413static void virtscsi_complete_event(struct virtio_scsi *vscsi, void *buf)
Cong Meng365a7152012-07-05 17:06:43 +0800414{
415 struct virtio_scsi_event_node *event_node = buf;
416
Michael S. Tsirkine67423c2014-10-15 10:22:33 +1030417 if (!vscsi->stop_events)
418 queue_work(system_freezable_wq, &event_node->work);
Cong Meng365a7152012-07-05 17:06:43 +0800419}
420
Paolo Bonzini4fe74b12012-02-05 12:16:00 +0100421static void virtscsi_event_done(struct virtqueue *vq)
422{
Paolo Bonzini139fe452012-06-13 16:56:32 +0200423 struct Scsi_Host *sh = virtio_scsi_host(vq->vdev);
424 struct virtio_scsi *vscsi = shost_priv(sh);
Paolo Bonzini139fe452012-06-13 16:56:32 +0200425
Paolo Bonzini10f34f62013-04-08 23:02:07 +0930426 virtscsi_vq_done(vscsi, &vscsi->event_vq, virtscsi_complete_event);
Paolo Bonzini4fe74b12012-02-05 12:16:00 +0100427};
428
Paolo Bonzini9e5470f2019-05-30 13:28:11 +0200429static int __virtscsi_add_cmd(struct virtqueue *vq,
Wanlong Gao682993b2013-03-20 15:44:28 +1030430 struct virtio_scsi_cmd *cmd,
Rusty Russellc77fba92014-05-21 11:25:04 +0930431 size_t req_size, size_t resp_size)
Paolo Bonzini4fe74b12012-02-05 12:16:00 +0100432{
433 struct scsi_cmnd *sc = cmd->sc;
Nicholas Bellingere6dc783a2014-02-22 18:23:33 -0800434 struct scatterlist *sgs[6], req, resp;
Wanlong Gao682993b2013-03-20 15:44:28 +1030435 struct sg_table *out, *in;
436 unsigned out_num = 0, in_num = 0;
437
438 out = in = NULL;
439
440 if (sc && sc->sc_data_direction != DMA_NONE) {
441 if (sc->sc_data_direction != DMA_FROM_DEVICE)
Christoph Hellwigae3d56d2019-01-29 09:33:07 +0100442 out = &sc->sdb.table;
Wanlong Gao682993b2013-03-20 15:44:28 +1030443 if (sc->sc_data_direction != DMA_TO_DEVICE)
Christoph Hellwigae3d56d2019-01-29 09:33:07 +0100444 in = &sc->sdb.table;
Wanlong Gao682993b2013-03-20 15:44:28 +1030445 }
Paolo Bonzini4fe74b12012-02-05 12:16:00 +0100446
Paolo Bonzini4fe74b12012-02-05 12:16:00 +0100447 /* Request header. */
Wanlong Gao682993b2013-03-20 15:44:28 +1030448 sg_init_one(&req, &cmd->req, req_size);
449 sgs[out_num++] = &req;
Paolo Bonzini4fe74b12012-02-05 12:16:00 +0100450
451 /* Data-out buffer. */
Nicholas Bellingere6dc783a2014-02-22 18:23:33 -0800452 if (out) {
453 /* Place WRITE protection SGLs before Data OUT payload */
454 if (scsi_prot_sg_count(sc))
455 sgs[out_num++] = scsi_prot_sglist(sc);
Wanlong Gao682993b2013-03-20 15:44:28 +1030456 sgs[out_num++] = out->sgl;
Nicholas Bellingere6dc783a2014-02-22 18:23:33 -0800457 }
Paolo Bonzini4fe74b12012-02-05 12:16:00 +0100458
459 /* Response header. */
Wanlong Gao682993b2013-03-20 15:44:28 +1030460 sg_init_one(&resp, &cmd->resp, resp_size);
461 sgs[out_num + in_num++] = &resp;
Paolo Bonzini4fe74b12012-02-05 12:16:00 +0100462
463 /* Data-in buffer */
Nicholas Bellingere6dc783a2014-02-22 18:23:33 -0800464 if (in) {
465 /* Place READ protection SGLs before Data IN payload */
466 if (scsi_prot_sg_count(sc))
467 sgs[out_num + in_num++] = scsi_prot_sglist(sc);
Wanlong Gao682993b2013-03-20 15:44:28 +1030468 sgs[out_num + in_num++] = in->sgl;
Nicholas Bellingere6dc783a2014-02-22 18:23:33 -0800469 }
Paolo Bonzini4fe74b12012-02-05 12:16:00 +0100470
Rusty Russellc77fba92014-05-21 11:25:04 +0930471 return virtqueue_add_sgs(vq, sgs, out_num, in_num, cmd, GFP_ATOMIC);
Paolo Bonzini4fe74b12012-02-05 12:16:00 +0100472}
473
Paolo Bonzini9e5470f2019-05-30 13:28:11 +0200474static void virtscsi_kick_vq(struct virtio_scsi_vq *vq)
475{
476 bool needs_kick;
477 unsigned long flags;
478
479 spin_lock_irqsave(&vq->vq_lock, flags);
480 needs_kick = virtqueue_kick_prepare(vq->vq);
481 spin_unlock_irqrestore(&vq->vq_lock, flags);
482
483 if (needs_kick)
484 virtqueue_notify(vq->vq);
485}
486
487/**
488 * virtscsi_add_cmd - add a virtio_scsi_cmd to a virtqueue, optionally kick it
489 * @vq : the struct virtqueue we're talking about
490 * @cmd : command structure
491 * @req_size : size of the request buffer
492 * @resp_size : size of the response buffer
493 * @kick : whether to kick the virtqueue immediately
494 */
495static int virtscsi_add_cmd(struct virtio_scsi_vq *vq,
Paolo Bonzini4fe74b12012-02-05 12:16:00 +0100496 struct virtio_scsi_cmd *cmd,
Paolo Bonzini9e5470f2019-05-30 13:28:11 +0200497 size_t req_size, size_t resp_size,
498 bool kick)
Paolo Bonzini4fe74b12012-02-05 12:16:00 +0100499{
Paolo Bonzini4fe74b12012-02-05 12:16:00 +0100500 unsigned long flags;
Rusty Russell4614e512012-10-16 23:56:16 +1030501 int err;
502 bool needs_kick = false;
Paolo Bonzini4fe74b12012-02-05 12:16:00 +0100503
Wanlong Gao682993b2013-03-20 15:44:28 +1030504 spin_lock_irqsave(&vq->vq_lock, flags);
Paolo Bonzini9e5470f2019-05-30 13:28:11 +0200505 err = __virtscsi_add_cmd(vq->vq, cmd, req_size, resp_size);
506 if (!err && kick)
Rusty Russell4614e512012-10-16 23:56:16 +1030507 needs_kick = virtqueue_kick_prepare(vq->vq);
Paolo Bonzini4fe74b12012-02-05 12:16:00 +0100508
Paolo Bonzinibce750b2012-06-13 16:56:33 +0200509 spin_unlock_irqrestore(&vq->vq_lock, flags);
Paolo Bonzini139fe452012-06-13 16:56:32 +0200510
Rusty Russell4614e512012-10-16 23:56:16 +1030511 if (needs_kick)
Paolo Bonzini139fe452012-06-13 16:56:32 +0200512 virtqueue_notify(vq->vq);
Rusty Russell4614e512012-10-16 23:56:16 +1030513 return err;
Paolo Bonzini4fe74b12012-02-05 12:16:00 +0100514}
515
Michael S. Tsirkind75dff32014-11-23 17:28:57 +0200516static void virtio_scsi_init_hdr(struct virtio_device *vdev,
517 struct virtio_scsi_cmd_req *cmd,
Nicholas Bellingere6dc783a2014-02-22 18:23:33 -0800518 struct scsi_cmnd *sc)
519{
520 cmd->lun[0] = 1;
521 cmd->lun[1] = sc->device->id;
522 cmd->lun[2] = (sc->device->lun >> 8) | 0x40;
523 cmd->lun[3] = sc->device->lun & 0xff;
Michael S. Tsirkind75dff32014-11-23 17:28:57 +0200524 cmd->tag = cpu_to_virtio64(vdev, (unsigned long)sc);
Nicholas Bellingere6dc783a2014-02-22 18:23:33 -0800525 cmd->task_attr = VIRTIO_SCSI_S_SIMPLE;
526 cmd->prio = 0;
527 cmd->crn = 0;
528}
529
Christoph Hellwigc5c25672015-04-27 14:56:14 +0200530#ifdef CONFIG_BLK_DEV_INTEGRITY
Michael S. Tsirkind75dff32014-11-23 17:28:57 +0200531static void virtio_scsi_init_hdr_pi(struct virtio_device *vdev,
532 struct virtio_scsi_cmd_req_pi *cmd_pi,
Nicholas Bellingere6dc783a2014-02-22 18:23:33 -0800533 struct scsi_cmnd *sc)
534{
Bart Van Assche7cc45542021-08-09 16:03:51 -0700535 struct request *rq = scsi_cmd_to_rq(sc);
Nicholas Bellingere6dc783a2014-02-22 18:23:33 -0800536 struct blk_integrity *bi;
537
Michael S. Tsirkind75dff32014-11-23 17:28:57 +0200538 virtio_scsi_init_hdr(vdev, (struct virtio_scsi_cmd_req *)cmd_pi, sc);
Nicholas Bellingere6dc783a2014-02-22 18:23:33 -0800539
540 if (!rq || !scsi_prot_sg_count(sc))
541 return;
542
Christoph Hellwigf3fa33a2021-11-26 13:18:00 +0100543 bi = blk_get_integrity(rq->q->disk);
Nicholas Bellingere6dc783a2014-02-22 18:23:33 -0800544
545 if (sc->sc_data_direction == DMA_TO_DEVICE)
Michael S. Tsirkind75dff32014-11-23 17:28:57 +0200546 cmd_pi->pi_bytesout = cpu_to_virtio32(vdev,
Greg Edwardscdcdcaa2018-07-26 15:52:54 -0400547 bio_integrity_bytes(bi,
548 blk_rq_sectors(rq)));
Nicholas Bellingere6dc783a2014-02-22 18:23:33 -0800549 else if (sc->sc_data_direction == DMA_FROM_DEVICE)
Michael S. Tsirkind75dff32014-11-23 17:28:57 +0200550 cmd_pi->pi_bytesin = cpu_to_virtio32(vdev,
Greg Edwardscdcdcaa2018-07-26 15:52:54 -0400551 bio_integrity_bytes(bi,
552 blk_rq_sectors(rq)));
Nicholas Bellingere6dc783a2014-02-22 18:23:33 -0800553}
Christoph Hellwigc5c25672015-04-27 14:56:14 +0200554#endif
Nicholas Bellingere6dc783a2014-02-22 18:23:33 -0800555
Ming Leic3506df2018-03-13 17:42:43 +0800556static struct virtio_scsi_vq *virtscsi_pick_vq_mq(struct virtio_scsi *vscsi,
557 struct scsi_cmnd *sc)
558{
Bart Van Assche7cc45542021-08-09 16:03:51 -0700559 u32 tag = blk_mq_unique_tag(scsi_cmd_to_rq(sc));
Ming Leic3506df2018-03-13 17:42:43 +0800560 u16 hwq = blk_mq_unique_tag_to_hwq(tag);
561
562 return &vscsi->req_vqs[hwq];
563}
564
565static int virtscsi_queuecommand(struct Scsi_Host *shost,
Paolo Bonzini9141a4c2013-04-08 23:03:25 +0930566 struct scsi_cmnd *sc)
Paolo Bonzini4fe74b12012-02-05 12:16:00 +0100567{
Ming Leic3506df2018-03-13 17:42:43 +0800568 struct virtio_scsi *vscsi = shost_priv(shost);
569 struct virtio_scsi_vq *req_vq = virtscsi_pick_vq_mq(vscsi, sc);
Christoph Hellwigb54197c2014-05-01 16:51:50 +0200570 struct virtio_scsi_cmd *cmd = scsi_cmd_priv(sc);
Paolo Bonzini9e5470f2019-05-30 13:28:11 +0200571 bool kick;
Eric Farman773c7222017-01-13 12:48:06 -0500572 unsigned long flags;
Linus Torvaldsed9ea4e2014-06-12 22:38:32 -0700573 int req_size;
Eric Farman773c7222017-01-13 12:48:06 -0500574 int ret;
Christoph Hellwigb54197c2014-05-01 16:51:50 +0200575
Paolo Bonzini2bd37f02012-06-13 16:56:34 +0200576 BUG_ON(scsi_sg_count(sc) > shost->sg_tablesize);
577
578 /* TODO: check feature bit and fail if unsupported? */
579 BUG_ON(sc->sc_data_direction == DMA_BIDIRECTIONAL);
580
Paolo Bonzini4fe74b12012-02-05 12:16:00 +0100581 dev_dbg(&sc->device->sdev_gendev,
582 "cmd %p CDB: %#02x\n", sc, sc->cmnd[0]);
583
Paolo Bonzini4fe74b12012-02-05 12:16:00 +0100584 cmd->sc = sc;
Paolo Bonzini4fe74b12012-02-05 12:16:00 +0100585
586 BUG_ON(sc->cmd_len > VIRTIO_SCSI_CDB_SIZE);
Paolo Bonzini4fe74b12012-02-05 12:16:00 +0100587
Christoph Hellwigc5c25672015-04-27 14:56:14 +0200588#ifdef CONFIG_BLK_DEV_INTEGRITY
Nicholas Bellingere6dc783a2014-02-22 18:23:33 -0800589 if (virtio_has_feature(vscsi->vdev, VIRTIO_SCSI_F_T10_PI)) {
Michael S. Tsirkind75dff32014-11-23 17:28:57 +0200590 virtio_scsi_init_hdr_pi(vscsi->vdev, &cmd->req.cmd_pi, sc);
Nicholas Bellingere6dc783a2014-02-22 18:23:33 -0800591 memcpy(cmd->req.cmd_pi.cdb, sc->cmnd, sc->cmd_len);
592 req_size = sizeof(cmd->req.cmd_pi);
Christoph Hellwigc5c25672015-04-27 14:56:14 +0200593 } else
594#endif
595 {
Michael S. Tsirkind75dff32014-11-23 17:28:57 +0200596 virtio_scsi_init_hdr(vscsi->vdev, &cmd->req.cmd, sc);
Nicholas Bellingere6dc783a2014-02-22 18:23:33 -0800597 memcpy(cmd->req.cmd.cdb, sc->cmnd, sc->cmd_len);
598 req_size = sizeof(cmd->req.cmd);
599 }
600
Paolo Bonzini9e5470f2019-05-30 13:28:11 +0200601 kick = (sc->flags & SCMD_LAST) != 0;
602 ret = virtscsi_add_cmd(req_vq, cmd, req_size, sizeof(cmd->resp.cmd), kick);
Eric Farman773c7222017-01-13 12:48:06 -0500603 if (ret == -EIO) {
604 cmd->resp.cmd.response = VIRTIO_SCSI_S_BAD_TARGET;
605 spin_lock_irqsave(&req_vq->vq_lock, flags);
606 virtscsi_complete_cmd(vscsi, cmd);
607 spin_unlock_irqrestore(&req_vq->vq_lock, flags);
608 } else if (ret != 0) {
Christoph Hellwigb54197c2014-05-01 16:51:50 +0200609 return SCSI_MLQUEUE_HOST_BUSY;
Eric Farman773c7222017-01-13 12:48:06 -0500610 }
Christoph Hellwigb54197c2014-05-01 16:51:50 +0200611 return 0;
Paolo Bonzini4fe74b12012-02-05 12:16:00 +0100612}
613
614static int virtscsi_tmf(struct virtio_scsi *vscsi, struct virtio_scsi_cmd *cmd)
615{
616 DECLARE_COMPLETION_ONSTACK(comp);
Paolo Bonzinie4594bb2012-05-04 12:32:04 +0200617 int ret = FAILED;
Paolo Bonzini4fe74b12012-02-05 12:16:00 +0100618
619 cmd->comp = &comp;
Paolo Bonzini9e5470f2019-05-30 13:28:11 +0200620 if (virtscsi_add_cmd(&vscsi->ctrl_vq, cmd,
621 sizeof cmd->req.tmf, sizeof cmd->resp.tmf, true) < 0)
Paolo Bonzinie4594bb2012-05-04 12:32:04 +0200622 goto out;
Paolo Bonzini4fe74b12012-02-05 12:16:00 +0100623
624 wait_for_completion(&comp);
Paolo Bonzinie4594bb2012-05-04 12:32:04 +0200625 if (cmd->resp.tmf.response == VIRTIO_SCSI_S_OK ||
626 cmd->resp.tmf.response == VIRTIO_SCSI_S_FUNCTION_SUCCEEDED)
627 ret = SUCCESS;
Paolo Bonzini4fe74b12012-02-05 12:16:00 +0100628
Paolo Bonzini8faeb522014-06-04 13:34:58 +0200629 /*
630 * The spec guarantees that all requests related to the TMF have
631 * been completed, but the callback might not have run yet if
632 * we're using independent interrupts (e.g. MSI). Poll the
633 * virtqueues once.
634 *
Bart Van Asscheb4194fc2021-10-07 13:46:02 -0700635 * In the abort case, scsi_done() will do nothing, because the
636 * command timed out and hence SCMD_STATE_COMPLETE has been set.
Paolo Bonzini8faeb522014-06-04 13:34:58 +0200637 */
638 virtscsi_poll_requests(vscsi);
639
Paolo Bonzinie4594bb2012-05-04 12:32:04 +0200640out:
641 mempool_free(cmd, virtscsi_cmd_pool);
642 return ret;
Paolo Bonzini4fe74b12012-02-05 12:16:00 +0100643}
644
645static int virtscsi_device_reset(struct scsi_cmnd *sc)
646{
647 struct virtio_scsi *vscsi = shost_priv(sc->device->host);
648 struct virtio_scsi_cmd *cmd;
649
650 sdev_printk(KERN_INFO, sc->device, "device reset\n");
651 cmd = mempool_alloc(virtscsi_cmd_pool, GFP_NOIO);
652 if (!cmd)
653 return FAILED;
654
655 memset(cmd, 0, sizeof(*cmd));
Paolo Bonzini4fe74b12012-02-05 12:16:00 +0100656 cmd->req.tmf = (struct virtio_scsi_ctrl_tmf_req){
657 .type = VIRTIO_SCSI_T_TMF,
Michael S. Tsirkind75dff32014-11-23 17:28:57 +0200658 .subtype = cpu_to_virtio32(vscsi->vdev,
659 VIRTIO_SCSI_T_TMF_LOGICAL_UNIT_RESET),
Paolo Bonzini4fe74b12012-02-05 12:16:00 +0100660 .lun[0] = 1,
661 .lun[1] = sc->device->id,
662 .lun[2] = (sc->device->lun >> 8) | 0x40,
663 .lun[3] = sc->device->lun & 0xff,
664 };
665 return virtscsi_tmf(vscsi, cmd);
666}
667
David Gibson25d1d502017-04-13 12:13:00 +1000668static int virtscsi_device_alloc(struct scsi_device *sdevice)
669{
670 /*
671 * Passed through SCSI targets (e.g. with qemu's 'scsi-block')
672 * may have transfer limits which come from the host SCSI
673 * controller or something on the host side other than the
674 * target itself.
675 *
676 * To make this work properly, the hypervisor can adjust the
677 * target's VPD information to advertise these limits. But
678 * for that to work, the guest has to look at the VPD pages,
679 * which we won't do by default if it is an SPC-2 device, even
680 * if it does actually support it.
681 *
682 * So, set the blist to always try to read the VPD pages.
683 */
684 sdevice->sdev_bflags = BLIST_TRY_VPD_PAGES;
685
686 return 0;
687}
688
689
Venkatesh Srinivas761f1192014-07-06 16:39:27 +0200690/**
691 * virtscsi_change_queue_depth() - Change a virtscsi target's queue depth
692 * @sdev: Virtscsi target whose queue depth to change
693 * @qdepth: New queue depth
Venkatesh Srinivas761f1192014-07-06 16:39:27 +0200694 */
Christoph Hellwigdb5ed4d2014-11-13 15:08:42 +0100695static int virtscsi_change_queue_depth(struct scsi_device *sdev, int qdepth)
Venkatesh Srinivas761f1192014-07-06 16:39:27 +0200696{
697 struct Scsi_Host *shost = sdev->host;
698 int max_depth = shost->cmd_per_lun;
699
Christoph Hellwigdb5ed4d2014-11-13 15:08:42 +0100700 return scsi_change_queue_depth(sdev, min(max_depth, qdepth));
Venkatesh Srinivas761f1192014-07-06 16:39:27 +0200701}
702
Paolo Bonzini4fe74b12012-02-05 12:16:00 +0100703static int virtscsi_abort(struct scsi_cmnd *sc)
704{
705 struct virtio_scsi *vscsi = shost_priv(sc->device->host);
706 struct virtio_scsi_cmd *cmd;
707
708 scmd_printk(KERN_INFO, sc, "abort\n");
709 cmd = mempool_alloc(virtscsi_cmd_pool, GFP_NOIO);
710 if (!cmd)
711 return FAILED;
712
713 memset(cmd, 0, sizeof(*cmd));
Paolo Bonzini4fe74b12012-02-05 12:16:00 +0100714 cmd->req.tmf = (struct virtio_scsi_ctrl_tmf_req){
715 .type = VIRTIO_SCSI_T_TMF,
716 .subtype = VIRTIO_SCSI_T_TMF_ABORT_TASK,
717 .lun[0] = 1,
718 .lun[1] = sc->device->id,
719 .lun[2] = (sc->device->lun >> 8) | 0x40,
720 .lun[3] = sc->device->lun & 0xff,
Michael S. Tsirkind75dff32014-11-23 17:28:57 +0200721 .tag = cpu_to_virtio64(vscsi->vdev, (unsigned long)sc),
Paolo Bonzini4fe74b12012-02-05 12:16:00 +0100722 };
723 return virtscsi_tmf(vscsi, cmd);
724}
725
Bart Van Asschea4e1d0b2022-08-15 10:00:43 -0700726static void virtscsi_map_queues(struct Scsi_Host *shost)
Christoph Hellwig0d9f0a52017-02-05 18:15:26 +0100727{
728 struct virtio_scsi *vscsi = shost_priv(shost);
Mike Christie95e724962023-12-13 23:26:49 -0600729 int i, qoff;
Christoph Hellwig0d9f0a52017-02-05 18:15:26 +0100730
Mike Christie95e724962023-12-13 23:26:49 -0600731 for (i = 0, qoff = 0; i < shost->nr_maps; i++) {
732 struct blk_mq_queue_map *map = &shost->tag_set.map[i];
733
734 map->nr_queues = vscsi->io_queues[i];
735 map->queue_offset = qoff;
736 qoff += map->nr_queues;
737
738 if (map->nr_queues == 0)
739 continue;
740
741 /*
742 * Regular queues have interrupts and hence CPU affinity is
743 * defined by the core virtio code, but polling queues have
744 * no interrupts so we let the block layer assign CPU affinity.
745 */
746 if (i == HCTX_TYPE_POLL)
747 blk_mq_map_queues(map);
748 else
749 blk_mq_virtio_map_queues(map, vscsi->vdev, 2);
750 }
751}
752
753static int virtscsi_mq_poll(struct Scsi_Host *shost, unsigned int queue_num)
754{
755 struct virtio_scsi *vscsi = shost_priv(shost);
756 struct virtio_scsi_vq *virtscsi_vq = &vscsi->req_vqs[queue_num];
757 unsigned long flags;
758 unsigned int len;
759 int found = 0;
760 void *buf;
761
762 spin_lock_irqsave(&virtscsi_vq->vq_lock, flags);
763
764 while ((buf = virtqueue_get_buf(virtscsi_vq->vq, &len)) != NULL) {
765 virtscsi_complete_cmd(vscsi, buf);
766 found++;
767 }
768
769 spin_unlock_irqrestore(&virtscsi_vq->vq_lock, flags);
770
771 return found;
Christoph Hellwig0d9f0a52017-02-05 18:15:26 +0100772}
773
Paolo Bonzini9e5470f2019-05-30 13:28:11 +0200774static void virtscsi_commit_rqs(struct Scsi_Host *shost, u16 hwq)
775{
776 struct virtio_scsi *vscsi = shost_priv(shost);
777
778 virtscsi_kick_vq(&vscsi->req_vqs[hwq]);
779}
780
Paolo Bonzinie72c9a22017-06-21 16:35:46 +0200781/*
782 * The host guarantees to respond to each command, although I/O
783 * latencies might be higher than on bare metal. Reset the timer
784 * unconditionally to give the host a chance to perform EH.
785 */
Bart Van Asschedee71212022-10-18 13:29:50 -0700786static enum scsi_timeout_action virtscsi_eh_timed_out(struct scsi_cmnd *scmnd)
Paolo Bonzinie72c9a22017-06-21 16:35:46 +0200787{
Bart Van Asschedee71212022-10-18 13:29:50 -0700788 return SCSI_EH_RESET_TIMER;
Paolo Bonzinie72c9a22017-06-21 16:35:46 +0200789}
790
Bart Van Assche273ab252023-03-22 12:55:09 -0700791static const struct scsi_host_template virtscsi_host_template = {
Paolo Bonzini4fe74b12012-02-05 12:16:00 +0100792 .module = THIS_MODULE,
793 .name = "Virtio SCSI HBA",
794 .proc_name = "virtio_scsi",
Paolo Bonzini4fe74b12012-02-05 12:16:00 +0100795 .this_id = -1,
Christoph Hellwigb54197c2014-05-01 16:51:50 +0200796 .cmd_size = sizeof(struct virtio_scsi_cmd),
Ming Leic3506df2018-03-13 17:42:43 +0800797 .queuecommand = virtscsi_queuecommand,
Mike Christie95e724962023-12-13 23:26:49 -0600798 .mq_poll = virtscsi_mq_poll,
Paolo Bonzini9e5470f2019-05-30 13:28:11 +0200799 .commit_rqs = virtscsi_commit_rqs,
Venkatesh Srinivas761f1192014-07-06 16:39:27 +0200800 .change_queue_depth = virtscsi_change_queue_depth,
Paolo Bonzini4fe74b12012-02-05 12:16:00 +0100801 .eh_abort_handler = virtscsi_abort,
802 .eh_device_reset_handler = virtscsi_device_reset,
Paolo Bonzinie72c9a22017-06-21 16:35:46 +0200803 .eh_timed_out = virtscsi_eh_timed_out,
Paolo Bonzinia680f1d2017-07-05 10:30:56 +0200804 .slave_alloc = virtscsi_device_alloc,
Paolo Bonzini4fe74b12012-02-05 12:16:00 +0100805
Paolo Bonzini4fe74b12012-02-05 12:16:00 +0100806 .dma_boundary = UINT_MAX,
Christoph Hellwig0d9f0a52017-02-05 18:15:26 +0100807 .map_queues = virtscsi_map_queues,
Christoph Hellwigc40ecc12014-11-13 14:25:11 +0100808 .track_queue_depth = 1,
Paolo Bonzini4fe74b12012-02-05 12:16:00 +0100809};
810
811#define virtscsi_config_get(vdev, fld) \
812 ({ \
Michael S. Tsirkin965b5352020-07-10 07:17:13 -0400813 __virtio_native_type(struct virtio_scsi_config, fld) __val; \
Rusty Russell855e0c52013-10-14 18:11:51 +1030814 virtio_cread(vdev, struct virtio_scsi_config, fld, &__val); \
Paolo Bonzini4fe74b12012-02-05 12:16:00 +0100815 __val; \
816 })
817
818#define virtscsi_config_set(vdev, fld, val) \
Rusty Russell855e0c52013-10-14 18:11:51 +1030819 do { \
Michael S. Tsirkin965b5352020-07-10 07:17:13 -0400820 __virtio_native_type(struct virtio_scsi_config, fld) __val = (val); \
Rusty Russell855e0c52013-10-14 18:11:51 +1030821 virtio_cwrite(vdev, struct virtio_scsi_config, fld, &__val); \
822 } while(0)
Paolo Bonzini4fe74b12012-02-05 12:16:00 +0100823
Paolo Bonzini139fe452012-06-13 16:56:32 +0200824static void virtscsi_init_vq(struct virtio_scsi_vq *virtscsi_vq,
825 struct virtqueue *vq)
826{
827 spin_lock_init(&virtscsi_vq->vq_lock);
828 virtscsi_vq->vq = vq;
829}
830
Paolo Bonzini2bd37f02012-06-13 16:56:34 +0200831static void virtscsi_remove_vqs(struct virtio_device *vdev)
832{
Paolo Bonzini2bd37f02012-06-13 16:56:34 +0200833 /* Stop all the virtqueues. */
Michael S. Tsirkind9679d02021-10-13 06:55:44 -0400834 virtio_reset_device(vdev);
Paolo Bonzini2bd37f02012-06-13 16:56:34 +0200835 vdev->config->del_vqs(vdev);
836}
837
Paolo Bonzini4fe74b12012-02-05 12:16:00 +0100838static int virtscsi_init(struct virtio_device *vdev,
Wanlong Gao5c370192013-04-08 23:01:16 +0930839 struct virtio_scsi *vscsi)
Paolo Bonzini4fe74b12012-02-05 12:16:00 +0100840{
841 int err;
Paolo Bonzini9141a4c2013-04-08 23:03:25 +0930842 u32 i;
Mike Christie95e724962023-12-13 23:26:49 -0600843 u32 num_vqs, num_poll_vqs, num_req_vqs;
Jiri Pirkoa6da2142024-07-08 09:48:09 +0200844 struct virtqueue_info *vqs_info;
Paolo Bonzini9141a4c2013-04-08 23:03:25 +0930845 struct virtqueue **vqs;
Christoph Hellwig0d9f0a52017-02-05 18:15:26 +0100846 struct irq_affinity desc = { .pre_vectors = 2 };
Paolo Bonzini2bd37f02012-06-13 16:56:34 +0200847
Mike Christie95e724962023-12-13 23:26:49 -0600848 num_req_vqs = vscsi->num_queues;
849 num_vqs = num_req_vqs + VIRTIO_SCSI_VQ_BASE;
Kees Cook6da2ec52018-06-12 13:55:00 -0700850 vqs = kmalloc_array(num_vqs, sizeof(struct virtqueue *), GFP_KERNEL);
Jiri Pirkoa6da2142024-07-08 09:48:09 +0200851 vqs_info = kcalloc(num_vqs, sizeof(*vqs_info), GFP_KERNEL);
Paolo Bonzini9141a4c2013-04-08 23:03:25 +0930852
Jiri Pirkoa6da2142024-07-08 09:48:09 +0200853 if (!vqs || !vqs_info) {
Paolo Bonzini9141a4c2013-04-08 23:03:25 +0930854 err = -ENOMEM;
855 goto out;
856 }
857
Mike Christie95e724962023-12-13 23:26:49 -0600858 num_poll_vqs = min_t(unsigned int, virtscsi_poll_queues,
859 num_req_vqs - 1);
860 vscsi->io_queues[HCTX_TYPE_DEFAULT] = num_req_vqs - num_poll_vqs;
861 vscsi->io_queues[HCTX_TYPE_READ] = 0;
862 vscsi->io_queues[HCTX_TYPE_POLL] = num_poll_vqs;
863
864 dev_info(&vdev->dev, "%d/%d/%d default/read/poll queues\n",
865 vscsi->io_queues[HCTX_TYPE_DEFAULT],
866 vscsi->io_queues[HCTX_TYPE_READ],
867 vscsi->io_queues[HCTX_TYPE_POLL]);
868
Jiri Pirkoa6da2142024-07-08 09:48:09 +0200869 vqs_info[0].callback = virtscsi_ctrl_done;
870 vqs_info[0].name = "control";
871 vqs_info[1].callback = virtscsi_event_done;
872 vqs_info[1].name = "event";
Mike Christie95e724962023-12-13 23:26:49 -0600873 for (i = VIRTIO_SCSI_VQ_BASE; i < num_vqs - num_poll_vqs; i++) {
Jiri Pirkoa6da2142024-07-08 09:48:09 +0200874 vqs_info[i].callback = virtscsi_req_done;
875 vqs_info[i].name = "request";
Paolo Bonzini9141a4c2013-04-08 23:03:25 +0930876 }
Paolo Bonzini4fe74b12012-02-05 12:16:00 +0100877
Jiri Pirkoa6da2142024-07-08 09:48:09 +0200878 for (; i < num_vqs; i++)
879 vqs_info[i].name = "request_poll";
Mike Christie95e724962023-12-13 23:26:49 -0600880
Paolo Bonzini4fe74b12012-02-05 12:16:00 +0100881 /* Discover virtqueues and write information to configuration. */
Jiri Pirko6c85d6b2024-07-08 09:48:14 +0200882 err = virtio_find_vqs(vdev, num_vqs, vqs, vqs_info, &desc);
Paolo Bonzini4fe74b12012-02-05 12:16:00 +0100883 if (err)
Paolo Bonzini9141a4c2013-04-08 23:03:25 +0930884 goto out;
Paolo Bonzini4fe74b12012-02-05 12:16:00 +0100885
Paolo Bonzini139fe452012-06-13 16:56:32 +0200886 virtscsi_init_vq(&vscsi->ctrl_vq, vqs[0]);
887 virtscsi_init_vq(&vscsi->event_vq, vqs[1]);
Paolo Bonzini9141a4c2013-04-08 23:03:25 +0930888 for (i = VIRTIO_SCSI_VQ_BASE; i < num_vqs; i++)
889 virtscsi_init_vq(&vscsi->req_vqs[i - VIRTIO_SCSI_VQ_BASE],
890 vqs[i]);
891
Paolo Bonzini4fe74b12012-02-05 12:16:00 +0100892 virtscsi_config_set(vdev, cdb_size, VIRTIO_SCSI_CDB_SIZE);
893 virtscsi_config_set(vdev, sense_size, VIRTIO_SCSI_SENSE_SIZE);
Paolo Bonzini2bd37f02012-06-13 16:56:34 +0200894
Paolo Bonzini9141a4c2013-04-08 23:03:25 +0930895 err = 0;
896
897out:
Jiri Pirkoa6da2142024-07-08 09:48:09 +0200898 kfree(vqs_info);
Paolo Bonzini9141a4c2013-04-08 23:03:25 +0930899 kfree(vqs);
900 if (err)
901 virtscsi_remove_vqs(vdev);
Paolo Bonzini2bd37f02012-06-13 16:56:34 +0200902 return err;
Paolo Bonzini4fe74b12012-02-05 12:16:00 +0100903}
904
Greg Kroah-Hartman6f039792012-12-21 13:08:55 -0800905static int virtscsi_probe(struct virtio_device *vdev)
Paolo Bonzini4fe74b12012-02-05 12:16:00 +0100906{
907 struct Scsi_Host *shost;
908 struct virtio_scsi *vscsi;
Stephen Rothwell908a5542015-06-30 10:59:04 +1000909 int err;
Paolo Bonzini2bd37f02012-06-13 16:56:34 +0200910 u32 sg_elems, num_targets;
Paolo Bonzini4fe74b12012-02-05 12:16:00 +0100911 u32 cmd_per_lun;
Paolo Bonzini9141a4c2013-04-08 23:03:25 +0930912 u32 num_queues;
Paolo Bonzini9141a4c2013-04-08 23:03:25 +0930913
Michael S. Tsirkin8cab3cd2015-01-12 16:23:37 +0200914 if (!vdev->config->get) {
915 dev_err(&vdev->dev, "%s failure: config access disabled\n",
916 __func__);
917 return -EINVAL;
918 }
919
Paolo Bonzini9141a4c2013-04-08 23:03:25 +0930920 /* We need to know how many queues before we allocate. */
921 num_queues = virtscsi_config_get(vdev, num_queues) ? : 1;
Dongli Zhang1978f302019-03-27 18:36:35 +0800922 num_queues = min_t(unsigned int, nr_cpu_ids, num_queues);
Paolo Bonzini4fe74b12012-02-05 12:16:00 +0100923
Paolo Bonzini2bd37f02012-06-13 16:56:34 +0200924 num_targets = virtscsi_config_get(vdev, max_target) + 1;
Paolo Bonzini4fe74b12012-02-05 12:16:00 +0100925
Ming Leic3506df2018-03-13 17:42:43 +0800926 shost = scsi_host_alloc(&virtscsi_host_template,
Gustavo A. R. Silva211f70ff2019-06-19 14:28:33 -0500927 struct_size(vscsi, req_vqs, num_queues));
Paolo Bonzini4fe74b12012-02-05 12:16:00 +0100928 if (!shost)
929 return -ENOMEM;
930
Paolo Bonzini2bd37f02012-06-13 16:56:34 +0200931 sg_elems = virtscsi_config_get(vdev, seg_max) ?: 1;
Paolo Bonzini4fe74b12012-02-05 12:16:00 +0100932 shost->sg_tablesize = sg_elems;
Mike Christie95e724962023-12-13 23:26:49 -0600933 shost->nr_maps = 1;
Paolo Bonzini4fe74b12012-02-05 12:16:00 +0100934 vscsi = shost_priv(shost);
935 vscsi->vdev = vdev;
Paolo Bonzini9141a4c2013-04-08 23:03:25 +0930936 vscsi->num_queues = num_queues;
Paolo Bonzini4fe74b12012-02-05 12:16:00 +0100937 vdev->priv = shost;
938
Wanlong Gao5c370192013-04-08 23:01:16 +0930939 err = virtscsi_init(vdev, vscsi);
Paolo Bonzini4fe74b12012-02-05 12:16:00 +0100940 if (err)
941 goto virtscsi_init_failed;
942
Mike Christie95e724962023-12-13 23:26:49 -0600943 if (vscsi->io_queues[HCTX_TYPE_POLL])
944 shost->nr_maps = HCTX_TYPE_POLL + 1;
945
Richard W.M. Jones582b0ab2017-08-10 17:56:52 +0100946 shost->can_queue = virtqueue_get_vring_size(vscsi->req_vqs[0].vq);
947
Paolo Bonzini4fe74b12012-02-05 12:16:00 +0100948 cmd_per_lun = virtscsi_config_get(vdev, cmd_per_lun) ?: 1;
949 shost->cmd_per_lun = min_t(u32, cmd_per_lun, shost->can_queue);
950 shost->max_sectors = virtscsi_config_get(vdev, max_sectors) ?: 0xFFFF;
Paolo Bonzini9da5f5a2012-10-02 17:25:47 +0200951
952 /* LUNs > 256 are reported with format 1, so they go in the range
953 * 16640-32767.
954 */
955 shost->max_lun = virtscsi_config_get(vdev, max_lun) + 1 + 0x4000;
Paolo Bonzini2bd37f02012-06-13 16:56:34 +0200956 shost->max_id = num_targets;
Paolo Bonzini4fe74b12012-02-05 12:16:00 +0100957 shost->max_channel = 0;
958 shost->max_cmd_len = VIRTIO_SCSI_CDB_SIZE;
Ming Leiccbedf12014-11-15 11:47:14 +0800959 shost->nr_hw_queues = num_queues;
Nicholas Bellingere6dc783a2014-02-22 18:23:33 -0800960
Christoph Hellwigc5c25672015-04-27 14:56:14 +0200961#ifdef CONFIG_BLK_DEV_INTEGRITY
Nicholas Bellingere6dc783a2014-02-22 18:23:33 -0800962 if (virtio_has_feature(vdev, VIRTIO_SCSI_F_T10_PI)) {
Stephen Rothwell908a5542015-06-30 10:59:04 +1000963 int host_prot;
964
Nicholas Bellingere6dc783a2014-02-22 18:23:33 -0800965 host_prot = SHOST_DIF_TYPE1_PROTECTION | SHOST_DIF_TYPE2_PROTECTION |
966 SHOST_DIF_TYPE3_PROTECTION | SHOST_DIX_TYPE1_PROTECTION |
967 SHOST_DIX_TYPE2_PROTECTION | SHOST_DIX_TYPE3_PROTECTION;
968
969 scsi_host_set_prot(shost, host_prot);
970 scsi_host_set_guard(shost, SHOST_DIX_GUARD_CRC);
971 }
Christoph Hellwigc5c25672015-04-27 14:56:14 +0200972#endif
Nicholas Bellingere6dc783a2014-02-22 18:23:33 -0800973
Paolo Bonzini4fe74b12012-02-05 12:16:00 +0100974 err = scsi_add_host(shost, &vdev->dev);
975 if (err)
976 goto scsi_add_host_failed;
Michael S. Tsirkin5d8f16d2014-10-15 10:22:33 +1030977
978 virtio_device_ready(vdev);
979
980 if (virtio_has_feature(vdev, VIRTIO_SCSI_F_HOTPLUG))
981 virtscsi_kick_event_all(vscsi);
982
983 scsi_scan_host(shost);
Paolo Bonzini4fe74b12012-02-05 12:16:00 +0100984 return 0;
985
986scsi_add_host_failed:
987 vdev->config->del_vqs(vdev);
988virtscsi_init_failed:
989 scsi_host_put(shost);
990 return err;
991}
992
Greg Kroah-Hartman6f039792012-12-21 13:08:55 -0800993static void virtscsi_remove(struct virtio_device *vdev)
Paolo Bonzini4fe74b12012-02-05 12:16:00 +0100994{
995 struct Scsi_Host *shost = virtio_scsi_host(vdev);
Cong Meng365a7152012-07-05 17:06:43 +0800996 struct virtio_scsi *vscsi = shost_priv(shost);
997
998 if (virtio_has_feature(vdev, VIRTIO_SCSI_F_HOTPLUG))
999 virtscsi_cancel_event_work(vscsi);
Paolo Bonzini4fe74b12012-02-05 12:16:00 +01001000
1001 scsi_remove_host(shost);
Paolo Bonzini4fe74b12012-02-05 12:16:00 +01001002 virtscsi_remove_vqs(vdev);
1003 scsi_host_put(shost);
1004}
1005
Aaron Lu89107002013-09-17 09:25:23 +09301006#ifdef CONFIG_PM_SLEEP
Paolo Bonzini4fe74b12012-02-05 12:16:00 +01001007static int virtscsi_freeze(struct virtio_device *vdev)
1008{
1009 virtscsi_remove_vqs(vdev);
1010 return 0;
1011}
1012
1013static int virtscsi_restore(struct virtio_device *vdev)
1014{
1015 struct Scsi_Host *sh = virtio_scsi_host(vdev);
1016 struct virtio_scsi *vscsi = shost_priv(sh);
Asias Hef466f752014-01-16 10:18:48 +10301017 int err;
Paolo Bonzini4fe74b12012-02-05 12:16:00 +01001018
Asias Hef466f752014-01-16 10:18:48 +10301019 err = virtscsi_init(vdev, vscsi);
1020 if (err)
1021 return err;
1022
Michael S. Tsirkin52c9cf12014-10-15 10:22:32 +10301023 virtio_device_ready(vdev);
1024
Michael S. Tsirkincd679042014-10-15 10:22:31 +10301025 if (virtio_has_feature(vdev, VIRTIO_SCSI_F_HOTPLUG))
1026 virtscsi_kick_event_all(vscsi);
Asias Hef466f752014-01-16 10:18:48 +10301027
1028 return err;
Paolo Bonzini4fe74b12012-02-05 12:16:00 +01001029}
1030#endif
1031
1032static struct virtio_device_id id_table[] = {
1033 { VIRTIO_ID_SCSI, VIRTIO_DEV_ANY_ID },
1034 { 0 },
1035};
1036
Cong Meng365a7152012-07-05 17:06:43 +08001037static unsigned int features[] = {
Paolo Bonzini865b58c2012-10-02 17:25:48 +02001038 VIRTIO_SCSI_F_HOTPLUG,
1039 VIRTIO_SCSI_F_CHANGE,
Christoph Hellwigc5c25672015-04-27 14:56:14 +02001040#ifdef CONFIG_BLK_DEV_INTEGRITY
Nicholas Bellingere6dc783a2014-02-22 18:23:33 -08001041 VIRTIO_SCSI_F_T10_PI,
Christoph Hellwigc5c25672015-04-27 14:56:14 +02001042#endif
Cong Meng365a7152012-07-05 17:06:43 +08001043};
1044
Paolo Bonzini4fe74b12012-02-05 12:16:00 +01001045static struct virtio_driver virtio_scsi_driver = {
Cong Meng365a7152012-07-05 17:06:43 +08001046 .feature_table = features,
1047 .feature_table_size = ARRAY_SIZE(features),
Paolo Bonzini4fe74b12012-02-05 12:16:00 +01001048 .driver.name = KBUILD_MODNAME,
Paolo Bonzini4fe74b12012-02-05 12:16:00 +01001049 .id_table = id_table,
1050 .probe = virtscsi_probe,
Aaron Lu89107002013-09-17 09:25:23 +09301051#ifdef CONFIG_PM_SLEEP
Paolo Bonzini4fe74b12012-02-05 12:16:00 +01001052 .freeze = virtscsi_freeze,
1053 .restore = virtscsi_restore,
1054#endif
Greg Kroah-Hartman6f039792012-12-21 13:08:55 -08001055 .remove = virtscsi_remove,
Paolo Bonzini4fe74b12012-02-05 12:16:00 +01001056};
1057
Randy Dunlap41b8c2a2022-03-16 12:20:06 -07001058static int __init virtio_scsi_init(void)
Paolo Bonzini4fe74b12012-02-05 12:16:00 +01001059{
1060 int ret = -ENOMEM;
1061
1062 virtscsi_cmd_cache = KMEM_CACHE(virtio_scsi_cmd, 0);
1063 if (!virtscsi_cmd_cache) {
Wanlong Gaoba06d1e2013-03-12 15:34:40 +10301064 pr_err("kmem_cache_create() for virtscsi_cmd_cache failed\n");
Paolo Bonzini4fe74b12012-02-05 12:16:00 +01001065 goto error;
1066 }
1067
1068
1069 virtscsi_cmd_pool =
1070 mempool_create_slab_pool(VIRTIO_SCSI_MEMPOOL_SZ,
1071 virtscsi_cmd_cache);
1072 if (!virtscsi_cmd_pool) {
Wanlong Gaoba06d1e2013-03-12 15:34:40 +10301073 pr_err("mempool_create() for virtscsi_cmd_pool failed\n");
Paolo Bonzini4fe74b12012-02-05 12:16:00 +01001074 goto error;
1075 }
1076 ret = register_virtio_driver(&virtio_scsi_driver);
1077 if (ret < 0)
1078 goto error;
1079
1080 return 0;
1081
1082error:
Xianting Tian92e8d032020-07-09 11:06:07 -04001083 mempool_destroy(virtscsi_cmd_pool);
1084 virtscsi_cmd_pool = NULL;
1085 kmem_cache_destroy(virtscsi_cmd_cache);
1086 virtscsi_cmd_cache = NULL;
Paolo Bonzini4fe74b12012-02-05 12:16:00 +01001087 return ret;
1088}
1089
Randy Dunlap41b8c2a2022-03-16 12:20:06 -07001090static void __exit virtio_scsi_fini(void)
Paolo Bonzini4fe74b12012-02-05 12:16:00 +01001091{
1092 unregister_virtio_driver(&virtio_scsi_driver);
Paolo Bonzini4fe74b12012-02-05 12:16:00 +01001093 mempool_destroy(virtscsi_cmd_pool);
1094 kmem_cache_destroy(virtscsi_cmd_cache);
1095}
Randy Dunlap41b8c2a2022-03-16 12:20:06 -07001096module_init(virtio_scsi_init);
1097module_exit(virtio_scsi_fini);
Paolo Bonzini4fe74b12012-02-05 12:16:00 +01001098
1099MODULE_DEVICE_TABLE(virtio, id_table);
1100MODULE_DESCRIPTION("Virtio SCSI HBA driver");
1101MODULE_LICENSE("GPL");