Loading...
1/*
2 * Virtio SCSI HBA driver
3 *
4 * Copyright IBM Corp. 2010
5 * Copyright Red Hat, Inc. 2011
6 *
7 * Authors:
8 * Stefan Hajnoczi <stefanha@linux.vnet.ibm.com>
9 * Paolo Bonzini <pbonzini@redhat.com>
10 *
11 * This work is licensed under the terms of the GNU GPL, version 2 or later.
12 * See the COPYING file in the top-level directory.
13 *
14 */
15
16#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
17
18#include <linux/module.h>
19#include <linux/slab.h>
20#include <linux/mempool.h>
21#include <linux/virtio.h>
22#include <linux/virtio_ids.h>
23#include <linux/virtio_config.h>
24#include <linux/virtio_scsi.h>
25#include <linux/cpu.h>
26#include <linux/blkdev.h>
27#include <scsi/scsi_host.h>
28#include <scsi/scsi_device.h>
29#include <scsi/scsi_cmnd.h>
30#include <scsi/scsi_tcq.h>
31#include <linux/seqlock.h>
32
33#define VIRTIO_SCSI_MEMPOOL_SZ 64
34#define VIRTIO_SCSI_EVENT_LEN 8
35#define VIRTIO_SCSI_VQ_BASE 2
36
37/* Command queue element */
38struct virtio_scsi_cmd {
39 struct scsi_cmnd *sc;
40 struct completion *comp;
41 union {
42 struct virtio_scsi_cmd_req cmd;
43 struct virtio_scsi_cmd_req_pi cmd_pi;
44 struct virtio_scsi_ctrl_tmf_req tmf;
45 struct virtio_scsi_ctrl_an_req an;
46 } req;
47 union {
48 struct virtio_scsi_cmd_resp cmd;
49 struct virtio_scsi_ctrl_tmf_resp tmf;
50 struct virtio_scsi_ctrl_an_resp an;
51 struct virtio_scsi_event evt;
52 } resp;
53} ____cacheline_aligned_in_smp;
54
55struct virtio_scsi_event_node {
56 struct virtio_scsi *vscsi;
57 struct virtio_scsi_event event;
58 struct work_struct work;
59};
60
61struct virtio_scsi_vq {
62 /* Protects vq */
63 spinlock_t vq_lock;
64
65 struct virtqueue *vq;
66};
67
68/*
69 * Per-target queue state.
70 *
71 * This struct holds the data needed by the queue steering policy. When a
72 * target is sent multiple requests, we need to drive them to the same queue so
73 * that FIFO processing order is kept. However, if a target was idle, we can
74 * choose a queue arbitrarily. In this case the queue is chosen according to
75 * the current VCPU, so the driver expects the number of request queues to be
76 * equal to the number of VCPUs. This makes it easy and fast to select the
77 * queue, and also lets the driver optimize the IRQ affinity for the virtqueues
78 * (each virtqueue's affinity is set to the CPU that "owns" the queue).
79 *
80 * tgt_seq is held to serialize reading and writing req_vq.
81 *
82 * Decrements of reqs are never concurrent with writes of req_vq: before the
83 * decrement reqs will be != 0; after the decrement the virtqueue completion
84 * routine will not use the req_vq so it can be changed by a new request.
85 * Thus they can happen outside the tgt_seq, provided of course we make reqs
86 * an atomic_t.
87 */
88struct virtio_scsi_target_state {
89 seqcount_t tgt_seq;
90
91 /* Count of outstanding requests. */
92 atomic_t reqs;
93
94 /* Currently active virtqueue for requests sent to this target. */
95 struct virtio_scsi_vq *req_vq;
96};
97
98/* Driver instance state */
99struct virtio_scsi {
100 struct virtio_device *vdev;
101
102 /* Get some buffers ready for event vq */
103 struct virtio_scsi_event_node event_list[VIRTIO_SCSI_EVENT_LEN];
104
105 u32 num_queues;
106
107 /* If the affinity hint is set for virtqueues */
108 bool affinity_hint_set;
109
110 /* CPU hotplug notifier */
111 struct notifier_block nb;
112
113 /* Protected by event_vq lock */
114 bool stop_events;
115
116 struct virtio_scsi_vq ctrl_vq;
117 struct virtio_scsi_vq event_vq;
118 struct virtio_scsi_vq req_vqs[];
119};
120
121static struct kmem_cache *virtscsi_cmd_cache;
122static mempool_t *virtscsi_cmd_pool;
123
124static inline struct Scsi_Host *virtio_scsi_host(struct virtio_device *vdev)
125{
126 return vdev->priv;
127}
128
129static void virtscsi_compute_resid(struct scsi_cmnd *sc, u32 resid)
130{
131 if (!resid)
132 return;
133
134 if (!scsi_bidi_cmnd(sc)) {
135 scsi_set_resid(sc, resid);
136 return;
137 }
138
139 scsi_in(sc)->resid = min(resid, scsi_in(sc)->length);
140 scsi_out(sc)->resid = resid - scsi_in(sc)->resid;
141}
142
143/**
144 * virtscsi_complete_cmd - finish a scsi_cmd and invoke scsi_done
145 *
146 * Called with vq_lock held.
147 */
148static void virtscsi_complete_cmd(struct virtio_scsi *vscsi, void *buf)
149{
150 struct virtio_scsi_cmd *cmd = buf;
151 struct scsi_cmnd *sc = cmd->sc;
152 struct virtio_scsi_cmd_resp *resp = &cmd->resp.cmd;
153 struct virtio_scsi_target_state *tgt =
154 scsi_target(sc->device)->hostdata;
155
156 dev_dbg(&sc->device->sdev_gendev,
157 "cmd %p response %u status %#02x sense_len %u\n",
158 sc, resp->response, resp->status, resp->sense_len);
159
160 sc->result = resp->status;
161 virtscsi_compute_resid(sc, virtio32_to_cpu(vscsi->vdev, resp->resid));
162 switch (resp->response) {
163 case VIRTIO_SCSI_S_OK:
164 set_host_byte(sc, DID_OK);
165 break;
166 case VIRTIO_SCSI_S_OVERRUN:
167 set_host_byte(sc, DID_ERROR);
168 break;
169 case VIRTIO_SCSI_S_ABORTED:
170 set_host_byte(sc, DID_ABORT);
171 break;
172 case VIRTIO_SCSI_S_BAD_TARGET:
173 set_host_byte(sc, DID_BAD_TARGET);
174 break;
175 case VIRTIO_SCSI_S_RESET:
176 set_host_byte(sc, DID_RESET);
177 break;
178 case VIRTIO_SCSI_S_BUSY:
179 set_host_byte(sc, DID_BUS_BUSY);
180 break;
181 case VIRTIO_SCSI_S_TRANSPORT_FAILURE:
182 set_host_byte(sc, DID_TRANSPORT_DISRUPTED);
183 break;
184 case VIRTIO_SCSI_S_TARGET_FAILURE:
185 set_host_byte(sc, DID_TARGET_FAILURE);
186 break;
187 case VIRTIO_SCSI_S_NEXUS_FAILURE:
188 set_host_byte(sc, DID_NEXUS_FAILURE);
189 break;
190 default:
191 scmd_printk(KERN_WARNING, sc, "Unknown response %d",
192 resp->response);
193 /* fall through */
194 case VIRTIO_SCSI_S_FAILURE:
195 set_host_byte(sc, DID_ERROR);
196 break;
197 }
198
199 WARN_ON(virtio32_to_cpu(vscsi->vdev, resp->sense_len) >
200 VIRTIO_SCSI_SENSE_SIZE);
201 if (sc->sense_buffer) {
202 memcpy(sc->sense_buffer, resp->sense,
203 min_t(u32,
204 virtio32_to_cpu(vscsi->vdev, resp->sense_len),
205 VIRTIO_SCSI_SENSE_SIZE));
206 if (resp->sense_len)
207 set_driver_byte(sc, DRIVER_SENSE);
208 }
209
210 sc->scsi_done(sc);
211
212 atomic_dec(&tgt->reqs);
213}
214
215static void virtscsi_vq_done(struct virtio_scsi *vscsi,
216 struct virtio_scsi_vq *virtscsi_vq,
217 void (*fn)(struct virtio_scsi *vscsi, void *buf))
218{
219 void *buf;
220 unsigned int len;
221 unsigned long flags;
222 struct virtqueue *vq = virtscsi_vq->vq;
223
224 spin_lock_irqsave(&virtscsi_vq->vq_lock, flags);
225 do {
226 virtqueue_disable_cb(vq);
227 while ((buf = virtqueue_get_buf(vq, &len)) != NULL)
228 fn(vscsi, buf);
229
230 if (unlikely(virtqueue_is_broken(vq)))
231 break;
232 } while (!virtqueue_enable_cb(vq));
233 spin_unlock_irqrestore(&virtscsi_vq->vq_lock, flags);
234}
235
236static void virtscsi_req_done(struct virtqueue *vq)
237{
238 struct Scsi_Host *sh = virtio_scsi_host(vq->vdev);
239 struct virtio_scsi *vscsi = shost_priv(sh);
240 int index = vq->index - VIRTIO_SCSI_VQ_BASE;
241 struct virtio_scsi_vq *req_vq = &vscsi->req_vqs[index];
242
243 virtscsi_vq_done(vscsi, req_vq, virtscsi_complete_cmd);
244};
245
246static void virtscsi_poll_requests(struct virtio_scsi *vscsi)
247{
248 int i, num_vqs;
249
250 num_vqs = vscsi->num_queues;
251 for (i = 0; i < num_vqs; i++)
252 virtscsi_vq_done(vscsi, &vscsi->req_vqs[i],
253 virtscsi_complete_cmd);
254}
255
256static void virtscsi_complete_free(struct virtio_scsi *vscsi, void *buf)
257{
258 struct virtio_scsi_cmd *cmd = buf;
259
260 if (cmd->comp)
261 complete_all(cmd->comp);
262}
263
264static void virtscsi_ctrl_done(struct virtqueue *vq)
265{
266 struct Scsi_Host *sh = virtio_scsi_host(vq->vdev);
267 struct virtio_scsi *vscsi = shost_priv(sh);
268
269 virtscsi_vq_done(vscsi, &vscsi->ctrl_vq, virtscsi_complete_free);
270};
271
272static void virtscsi_handle_event(struct work_struct *work);
273
274static int virtscsi_kick_event(struct virtio_scsi *vscsi,
275 struct virtio_scsi_event_node *event_node)
276{
277 int err;
278 struct scatterlist sg;
279 unsigned long flags;
280
281 INIT_WORK(&event_node->work, virtscsi_handle_event);
282 sg_init_one(&sg, &event_node->event, sizeof(struct virtio_scsi_event));
283
284 spin_lock_irqsave(&vscsi->event_vq.vq_lock, flags);
285
286 err = virtqueue_add_inbuf(vscsi->event_vq.vq, &sg, 1, event_node,
287 GFP_ATOMIC);
288 if (!err)
289 virtqueue_kick(vscsi->event_vq.vq);
290
291 spin_unlock_irqrestore(&vscsi->event_vq.vq_lock, flags);
292
293 return err;
294}
295
296static int virtscsi_kick_event_all(struct virtio_scsi *vscsi)
297{
298 int i;
299
300 for (i = 0; i < VIRTIO_SCSI_EVENT_LEN; i++) {
301 vscsi->event_list[i].vscsi = vscsi;
302 virtscsi_kick_event(vscsi, &vscsi->event_list[i]);
303 }
304
305 return 0;
306}
307
308static void virtscsi_cancel_event_work(struct virtio_scsi *vscsi)
309{
310 int i;
311
312 /* Stop scheduling work before calling cancel_work_sync. */
313 spin_lock_irq(&vscsi->event_vq.vq_lock);
314 vscsi->stop_events = true;
315 spin_unlock_irq(&vscsi->event_vq.vq_lock);
316
317 for (i = 0; i < VIRTIO_SCSI_EVENT_LEN; i++)
318 cancel_work_sync(&vscsi->event_list[i].work);
319}
320
321static void virtscsi_handle_transport_reset(struct virtio_scsi *vscsi,
322 struct virtio_scsi_event *event)
323{
324 struct scsi_device *sdev;
325 struct Scsi_Host *shost = virtio_scsi_host(vscsi->vdev);
326 unsigned int target = event->lun[1];
327 unsigned int lun = (event->lun[2] << 8) | event->lun[3];
328
329 switch (virtio32_to_cpu(vscsi->vdev, event->reason)) {
330 case VIRTIO_SCSI_EVT_RESET_RESCAN:
331 scsi_add_device(shost, 0, target, lun);
332 break;
333 case VIRTIO_SCSI_EVT_RESET_REMOVED:
334 sdev = scsi_device_lookup(shost, 0, target, lun);
335 if (sdev) {
336 scsi_remove_device(sdev);
337 scsi_device_put(sdev);
338 } else {
339 pr_err("SCSI device %d 0 %d %d not found\n",
340 shost->host_no, target, lun);
341 }
342 break;
343 default:
344 pr_info("Unsupport virtio scsi event reason %x\n", event->reason);
345 }
346}
347
348static void virtscsi_handle_param_change(struct virtio_scsi *vscsi,
349 struct virtio_scsi_event *event)
350{
351 struct scsi_device *sdev;
352 struct Scsi_Host *shost = virtio_scsi_host(vscsi->vdev);
353 unsigned int target = event->lun[1];
354 unsigned int lun = (event->lun[2] << 8) | event->lun[3];
355 u8 asc = virtio32_to_cpu(vscsi->vdev, event->reason) & 255;
356 u8 ascq = virtio32_to_cpu(vscsi->vdev, event->reason) >> 8;
357
358 sdev = scsi_device_lookup(shost, 0, target, lun);
359 if (!sdev) {
360 pr_err("SCSI device %d 0 %d %d not found\n",
361 shost->host_no, target, lun);
362 return;
363 }
364
365 /* Handle "Parameters changed", "Mode parameters changed", and
366 "Capacity data has changed". */
367 if (asc == 0x2a && (ascq == 0x00 || ascq == 0x01 || ascq == 0x09))
368 scsi_rescan_device(&sdev->sdev_gendev);
369
370 scsi_device_put(sdev);
371}
372
373static void virtscsi_handle_event(struct work_struct *work)
374{
375 struct virtio_scsi_event_node *event_node =
376 container_of(work, struct virtio_scsi_event_node, work);
377 struct virtio_scsi *vscsi = event_node->vscsi;
378 struct virtio_scsi_event *event = &event_node->event;
379
380 if (event->event &
381 cpu_to_virtio32(vscsi->vdev, VIRTIO_SCSI_T_EVENTS_MISSED)) {
382 event->event &= ~cpu_to_virtio32(vscsi->vdev,
383 VIRTIO_SCSI_T_EVENTS_MISSED);
384 scsi_scan_host(virtio_scsi_host(vscsi->vdev));
385 }
386
387 switch (virtio32_to_cpu(vscsi->vdev, event->event)) {
388 case VIRTIO_SCSI_T_NO_EVENT:
389 break;
390 case VIRTIO_SCSI_T_TRANSPORT_RESET:
391 virtscsi_handle_transport_reset(vscsi, event);
392 break;
393 case VIRTIO_SCSI_T_PARAM_CHANGE:
394 virtscsi_handle_param_change(vscsi, event);
395 break;
396 default:
397 pr_err("Unsupport virtio scsi event %x\n", event->event);
398 }
399 virtscsi_kick_event(vscsi, event_node);
400}
401
402static void virtscsi_complete_event(struct virtio_scsi *vscsi, void *buf)
403{
404 struct virtio_scsi_event_node *event_node = buf;
405
406 if (!vscsi->stop_events)
407 queue_work(system_freezable_wq, &event_node->work);
408}
409
410static void virtscsi_event_done(struct virtqueue *vq)
411{
412 struct Scsi_Host *sh = virtio_scsi_host(vq->vdev);
413 struct virtio_scsi *vscsi = shost_priv(sh);
414
415 virtscsi_vq_done(vscsi, &vscsi->event_vq, virtscsi_complete_event);
416};
417
418/**
419 * virtscsi_add_cmd - add a virtio_scsi_cmd to a virtqueue
420 * @vq : the struct virtqueue we're talking about
421 * @cmd : command structure
422 * @req_size : size of the request buffer
423 * @resp_size : size of the response buffer
424 */
425static int virtscsi_add_cmd(struct virtqueue *vq,
426 struct virtio_scsi_cmd *cmd,
427 size_t req_size, size_t resp_size)
428{
429 struct scsi_cmnd *sc = cmd->sc;
430 struct scatterlist *sgs[6], req, resp;
431 struct sg_table *out, *in;
432 unsigned out_num = 0, in_num = 0;
433
434 out = in = NULL;
435
436 if (sc && sc->sc_data_direction != DMA_NONE) {
437 if (sc->sc_data_direction != DMA_FROM_DEVICE)
438 out = &scsi_out(sc)->table;
439 if (sc->sc_data_direction != DMA_TO_DEVICE)
440 in = &scsi_in(sc)->table;
441 }
442
443 /* Request header. */
444 sg_init_one(&req, &cmd->req, req_size);
445 sgs[out_num++] = &req;
446
447 /* Data-out buffer. */
448 if (out) {
449 /* Place WRITE protection SGLs before Data OUT payload */
450 if (scsi_prot_sg_count(sc))
451 sgs[out_num++] = scsi_prot_sglist(sc);
452 sgs[out_num++] = out->sgl;
453 }
454
455 /* Response header. */
456 sg_init_one(&resp, &cmd->resp, resp_size);
457 sgs[out_num + in_num++] = &resp;
458
459 /* Data-in buffer */
460 if (in) {
461 /* Place READ protection SGLs before Data IN payload */
462 if (scsi_prot_sg_count(sc))
463 sgs[out_num + in_num++] = scsi_prot_sglist(sc);
464 sgs[out_num + in_num++] = in->sgl;
465 }
466
467 return virtqueue_add_sgs(vq, sgs, out_num, in_num, cmd, GFP_ATOMIC);
468}
469
470static int virtscsi_kick_cmd(struct virtio_scsi_vq *vq,
471 struct virtio_scsi_cmd *cmd,
472 size_t req_size, size_t resp_size)
473{
474 unsigned long flags;
475 int err;
476 bool needs_kick = false;
477
478 spin_lock_irqsave(&vq->vq_lock, flags);
479 err = virtscsi_add_cmd(vq->vq, cmd, req_size, resp_size);
480 if (!err)
481 needs_kick = virtqueue_kick_prepare(vq->vq);
482
483 spin_unlock_irqrestore(&vq->vq_lock, flags);
484
485 if (needs_kick)
486 virtqueue_notify(vq->vq);
487 return err;
488}
489
490static void virtio_scsi_init_hdr(struct virtio_device *vdev,
491 struct virtio_scsi_cmd_req *cmd,
492 struct scsi_cmnd *sc)
493{
494 cmd->lun[0] = 1;
495 cmd->lun[1] = sc->device->id;
496 cmd->lun[2] = (sc->device->lun >> 8) | 0x40;
497 cmd->lun[3] = sc->device->lun & 0xff;
498 cmd->tag = cpu_to_virtio64(vdev, (unsigned long)sc);
499 cmd->task_attr = VIRTIO_SCSI_S_SIMPLE;
500 cmd->prio = 0;
501 cmd->crn = 0;
502}
503
504#ifdef CONFIG_BLK_DEV_INTEGRITY
505static void virtio_scsi_init_hdr_pi(struct virtio_device *vdev,
506 struct virtio_scsi_cmd_req_pi *cmd_pi,
507 struct scsi_cmnd *sc)
508{
509 struct request *rq = sc->request;
510 struct blk_integrity *bi;
511
512 virtio_scsi_init_hdr(vdev, (struct virtio_scsi_cmd_req *)cmd_pi, sc);
513
514 if (!rq || !scsi_prot_sg_count(sc))
515 return;
516
517 bi = blk_get_integrity(rq->rq_disk);
518
519 if (sc->sc_data_direction == DMA_TO_DEVICE)
520 cmd_pi->pi_bytesout = cpu_to_virtio32(vdev,
521 blk_rq_sectors(rq) *
522 bi->tuple_size);
523 else if (sc->sc_data_direction == DMA_FROM_DEVICE)
524 cmd_pi->pi_bytesin = cpu_to_virtio32(vdev,
525 blk_rq_sectors(rq) *
526 bi->tuple_size);
527}
528#endif
529
530static int virtscsi_queuecommand(struct virtio_scsi *vscsi,
531 struct virtio_scsi_vq *req_vq,
532 struct scsi_cmnd *sc)
533{
534 struct Scsi_Host *shost = virtio_scsi_host(vscsi->vdev);
535 struct virtio_scsi_cmd *cmd = scsi_cmd_priv(sc);
536 int req_size;
537
538 BUG_ON(scsi_sg_count(sc) > shost->sg_tablesize);
539
540 /* TODO: check feature bit and fail if unsupported? */
541 BUG_ON(sc->sc_data_direction == DMA_BIDIRECTIONAL);
542
543 dev_dbg(&sc->device->sdev_gendev,
544 "cmd %p CDB: %#02x\n", sc, sc->cmnd[0]);
545
546 memset(cmd, 0, sizeof(*cmd));
547 cmd->sc = sc;
548
549 BUG_ON(sc->cmd_len > VIRTIO_SCSI_CDB_SIZE);
550
551#ifdef CONFIG_BLK_DEV_INTEGRITY
552 if (virtio_has_feature(vscsi->vdev, VIRTIO_SCSI_F_T10_PI)) {
553 virtio_scsi_init_hdr_pi(vscsi->vdev, &cmd->req.cmd_pi, sc);
554 memcpy(cmd->req.cmd_pi.cdb, sc->cmnd, sc->cmd_len);
555 req_size = sizeof(cmd->req.cmd_pi);
556 } else
557#endif
558 {
559 virtio_scsi_init_hdr(vscsi->vdev, &cmd->req.cmd, sc);
560 memcpy(cmd->req.cmd.cdb, sc->cmnd, sc->cmd_len);
561 req_size = sizeof(cmd->req.cmd);
562 }
563
564 if (virtscsi_kick_cmd(req_vq, cmd, req_size, sizeof(cmd->resp.cmd)) != 0)
565 return SCSI_MLQUEUE_HOST_BUSY;
566 return 0;
567}
568
569static int virtscsi_queuecommand_single(struct Scsi_Host *sh,
570 struct scsi_cmnd *sc)
571{
572 struct virtio_scsi *vscsi = shost_priv(sh);
573 struct virtio_scsi_target_state *tgt =
574 scsi_target(sc->device)->hostdata;
575
576 atomic_inc(&tgt->reqs);
577 return virtscsi_queuecommand(vscsi, &vscsi->req_vqs[0], sc);
578}
579
580static struct virtio_scsi_vq *virtscsi_pick_vq_mq(struct virtio_scsi *vscsi,
581 struct scsi_cmnd *sc)
582{
583 u32 tag = blk_mq_unique_tag(sc->request);
584 u16 hwq = blk_mq_unique_tag_to_hwq(tag);
585
586 return &vscsi->req_vqs[hwq];
587}
588
589static struct virtio_scsi_vq *virtscsi_pick_vq(struct virtio_scsi *vscsi,
590 struct virtio_scsi_target_state *tgt)
591{
592 struct virtio_scsi_vq *vq;
593 unsigned long flags;
594 u32 queue_num;
595
596 local_irq_save(flags);
597 if (atomic_inc_return(&tgt->reqs) > 1) {
598 unsigned long seq;
599
600 do {
601 seq = read_seqcount_begin(&tgt->tgt_seq);
602 vq = tgt->req_vq;
603 } while (read_seqcount_retry(&tgt->tgt_seq, seq));
604 } else {
605 /* no writes can be concurrent because of atomic_t */
606 write_seqcount_begin(&tgt->tgt_seq);
607
608 /* keep previous req_vq if a reader just arrived */
609 if (unlikely(atomic_read(&tgt->reqs) > 1)) {
610 vq = tgt->req_vq;
611 goto unlock;
612 }
613
614 queue_num = smp_processor_id();
615 while (unlikely(queue_num >= vscsi->num_queues))
616 queue_num -= vscsi->num_queues;
617 tgt->req_vq = vq = &vscsi->req_vqs[queue_num];
618 unlock:
619 write_seqcount_end(&tgt->tgt_seq);
620 }
621 local_irq_restore(flags);
622
623 return vq;
624}
625
626static int virtscsi_queuecommand_multi(struct Scsi_Host *sh,
627 struct scsi_cmnd *sc)
628{
629 struct virtio_scsi *vscsi = shost_priv(sh);
630 struct virtio_scsi_target_state *tgt =
631 scsi_target(sc->device)->hostdata;
632 struct virtio_scsi_vq *req_vq;
633
634 if (shost_use_blk_mq(sh))
635 req_vq = virtscsi_pick_vq_mq(vscsi, sc);
636 else
637 req_vq = virtscsi_pick_vq(vscsi, tgt);
638
639 return virtscsi_queuecommand(vscsi, req_vq, sc);
640}
641
642static int virtscsi_tmf(struct virtio_scsi *vscsi, struct virtio_scsi_cmd *cmd)
643{
644 DECLARE_COMPLETION_ONSTACK(comp);
645 int ret = FAILED;
646
647 cmd->comp = ∁
648 if (virtscsi_kick_cmd(&vscsi->ctrl_vq, cmd,
649 sizeof cmd->req.tmf, sizeof cmd->resp.tmf) < 0)
650 goto out;
651
652 wait_for_completion(&comp);
653 if (cmd->resp.tmf.response == VIRTIO_SCSI_S_OK ||
654 cmd->resp.tmf.response == VIRTIO_SCSI_S_FUNCTION_SUCCEEDED)
655 ret = SUCCESS;
656
657 /*
658 * The spec guarantees that all requests related to the TMF have
659 * been completed, but the callback might not have run yet if
660 * we're using independent interrupts (e.g. MSI). Poll the
661 * virtqueues once.
662 *
663 * In the abort case, sc->scsi_done will do nothing, because
664 * the block layer must have detected a timeout and as a result
665 * REQ_ATOM_COMPLETE has been set.
666 */
667 virtscsi_poll_requests(vscsi);
668
669out:
670 mempool_free(cmd, virtscsi_cmd_pool);
671 return ret;
672}
673
674static int virtscsi_device_reset(struct scsi_cmnd *sc)
675{
676 struct virtio_scsi *vscsi = shost_priv(sc->device->host);
677 struct virtio_scsi_cmd *cmd;
678
679 sdev_printk(KERN_INFO, sc->device, "device reset\n");
680 cmd = mempool_alloc(virtscsi_cmd_pool, GFP_NOIO);
681 if (!cmd)
682 return FAILED;
683
684 memset(cmd, 0, sizeof(*cmd));
685 cmd->sc = sc;
686 cmd->req.tmf = (struct virtio_scsi_ctrl_tmf_req){
687 .type = VIRTIO_SCSI_T_TMF,
688 .subtype = cpu_to_virtio32(vscsi->vdev,
689 VIRTIO_SCSI_T_TMF_LOGICAL_UNIT_RESET),
690 .lun[0] = 1,
691 .lun[1] = sc->device->id,
692 .lun[2] = (sc->device->lun >> 8) | 0x40,
693 .lun[3] = sc->device->lun & 0xff,
694 };
695 return virtscsi_tmf(vscsi, cmd);
696}
697
698/**
699 * virtscsi_change_queue_depth() - Change a virtscsi target's queue depth
700 * @sdev: Virtscsi target whose queue depth to change
701 * @qdepth: New queue depth
702 */
703static int virtscsi_change_queue_depth(struct scsi_device *sdev, int qdepth)
704{
705 struct Scsi_Host *shost = sdev->host;
706 int max_depth = shost->cmd_per_lun;
707
708 return scsi_change_queue_depth(sdev, min(max_depth, qdepth));
709}
710
711static int virtscsi_abort(struct scsi_cmnd *sc)
712{
713 struct virtio_scsi *vscsi = shost_priv(sc->device->host);
714 struct virtio_scsi_cmd *cmd;
715
716 scmd_printk(KERN_INFO, sc, "abort\n");
717 cmd = mempool_alloc(virtscsi_cmd_pool, GFP_NOIO);
718 if (!cmd)
719 return FAILED;
720
721 memset(cmd, 0, sizeof(*cmd));
722 cmd->sc = sc;
723 cmd->req.tmf = (struct virtio_scsi_ctrl_tmf_req){
724 .type = VIRTIO_SCSI_T_TMF,
725 .subtype = VIRTIO_SCSI_T_TMF_ABORT_TASK,
726 .lun[0] = 1,
727 .lun[1] = sc->device->id,
728 .lun[2] = (sc->device->lun >> 8) | 0x40,
729 .lun[3] = sc->device->lun & 0xff,
730 .tag = cpu_to_virtio64(vscsi->vdev, (unsigned long)sc),
731 };
732 return virtscsi_tmf(vscsi, cmd);
733}
734
735static int virtscsi_target_alloc(struct scsi_target *starget)
736{
737 struct Scsi_Host *sh = dev_to_shost(starget->dev.parent);
738 struct virtio_scsi *vscsi = shost_priv(sh);
739
740 struct virtio_scsi_target_state *tgt =
741 kmalloc(sizeof(*tgt), GFP_KERNEL);
742 if (!tgt)
743 return -ENOMEM;
744
745 seqcount_init(&tgt->tgt_seq);
746 atomic_set(&tgt->reqs, 0);
747 tgt->req_vq = &vscsi->req_vqs[0];
748
749 starget->hostdata = tgt;
750 return 0;
751}
752
753static void virtscsi_target_destroy(struct scsi_target *starget)
754{
755 struct virtio_scsi_target_state *tgt = starget->hostdata;
756 kfree(tgt);
757}
758
759static struct scsi_host_template virtscsi_host_template_single = {
760 .module = THIS_MODULE,
761 .name = "Virtio SCSI HBA",
762 .proc_name = "virtio_scsi",
763 .this_id = -1,
764 .cmd_size = sizeof(struct virtio_scsi_cmd),
765 .queuecommand = virtscsi_queuecommand_single,
766 .change_queue_depth = virtscsi_change_queue_depth,
767 .eh_abort_handler = virtscsi_abort,
768 .eh_device_reset_handler = virtscsi_device_reset,
769
770 .can_queue = 1024,
771 .dma_boundary = UINT_MAX,
772 .use_clustering = ENABLE_CLUSTERING,
773 .target_alloc = virtscsi_target_alloc,
774 .target_destroy = virtscsi_target_destroy,
775 .track_queue_depth = 1,
776};
777
778static struct scsi_host_template virtscsi_host_template_multi = {
779 .module = THIS_MODULE,
780 .name = "Virtio SCSI HBA",
781 .proc_name = "virtio_scsi",
782 .this_id = -1,
783 .cmd_size = sizeof(struct virtio_scsi_cmd),
784 .queuecommand = virtscsi_queuecommand_multi,
785 .change_queue_depth = virtscsi_change_queue_depth,
786 .eh_abort_handler = virtscsi_abort,
787 .eh_device_reset_handler = virtscsi_device_reset,
788
789 .can_queue = 1024,
790 .dma_boundary = UINT_MAX,
791 .use_clustering = ENABLE_CLUSTERING,
792 .target_alloc = virtscsi_target_alloc,
793 .target_destroy = virtscsi_target_destroy,
794 .track_queue_depth = 1,
795};
796
797#define virtscsi_config_get(vdev, fld) \
798 ({ \
799 typeof(((struct virtio_scsi_config *)0)->fld) __val; \
800 virtio_cread(vdev, struct virtio_scsi_config, fld, &__val); \
801 __val; \
802 })
803
804#define virtscsi_config_set(vdev, fld, val) \
805 do { \
806 typeof(((struct virtio_scsi_config *)0)->fld) __val = (val); \
807 virtio_cwrite(vdev, struct virtio_scsi_config, fld, &__val); \
808 } while(0)
809
810static void __virtscsi_set_affinity(struct virtio_scsi *vscsi, bool affinity)
811{
812 int i;
813 int cpu;
814
815 /* In multiqueue mode, when the number of cpu is equal
816 * to the number of request queues, we let the qeueues
817 * to be private to one cpu by setting the affinity hint
818 * to eliminate the contention.
819 */
820 if ((vscsi->num_queues == 1 ||
821 vscsi->num_queues != num_online_cpus()) && affinity) {
822 if (vscsi->affinity_hint_set)
823 affinity = false;
824 else
825 return;
826 }
827
828 if (affinity) {
829 i = 0;
830 for_each_online_cpu(cpu) {
831 virtqueue_set_affinity(vscsi->req_vqs[i].vq, cpu);
832 i++;
833 }
834
835 vscsi->affinity_hint_set = true;
836 } else {
837 for (i = 0; i < vscsi->num_queues; i++) {
838 if (!vscsi->req_vqs[i].vq)
839 continue;
840
841 virtqueue_set_affinity(vscsi->req_vqs[i].vq, -1);
842 }
843
844 vscsi->affinity_hint_set = false;
845 }
846}
847
848static void virtscsi_set_affinity(struct virtio_scsi *vscsi, bool affinity)
849{
850 get_online_cpus();
851 __virtscsi_set_affinity(vscsi, affinity);
852 put_online_cpus();
853}
854
855static int virtscsi_cpu_callback(struct notifier_block *nfb,
856 unsigned long action, void *hcpu)
857{
858 struct virtio_scsi *vscsi = container_of(nfb, struct virtio_scsi, nb);
859 switch(action) {
860 case CPU_ONLINE:
861 case CPU_ONLINE_FROZEN:
862 case CPU_DEAD:
863 case CPU_DEAD_FROZEN:
864 __virtscsi_set_affinity(vscsi, true);
865 break;
866 default:
867 break;
868 }
869 return NOTIFY_OK;
870}
871
872static void virtscsi_init_vq(struct virtio_scsi_vq *virtscsi_vq,
873 struct virtqueue *vq)
874{
875 spin_lock_init(&virtscsi_vq->vq_lock);
876 virtscsi_vq->vq = vq;
877}
878
879static void virtscsi_remove_vqs(struct virtio_device *vdev)
880{
881 struct Scsi_Host *sh = virtio_scsi_host(vdev);
882 struct virtio_scsi *vscsi = shost_priv(sh);
883
884 virtscsi_set_affinity(vscsi, false);
885
886 /* Stop all the virtqueues. */
887 vdev->config->reset(vdev);
888
889 vdev->config->del_vqs(vdev);
890}
891
892static int virtscsi_init(struct virtio_device *vdev,
893 struct virtio_scsi *vscsi)
894{
895 int err;
896 u32 i;
897 u32 num_vqs;
898 vq_callback_t **callbacks;
899 const char **names;
900 struct virtqueue **vqs;
901
902 num_vqs = vscsi->num_queues + VIRTIO_SCSI_VQ_BASE;
903 vqs = kmalloc(num_vqs * sizeof(struct virtqueue *), GFP_KERNEL);
904 callbacks = kmalloc(num_vqs * sizeof(vq_callback_t *), GFP_KERNEL);
905 names = kmalloc(num_vqs * sizeof(char *), GFP_KERNEL);
906
907 if (!callbacks || !vqs || !names) {
908 err = -ENOMEM;
909 goto out;
910 }
911
912 callbacks[0] = virtscsi_ctrl_done;
913 callbacks[1] = virtscsi_event_done;
914 names[0] = "control";
915 names[1] = "event";
916 for (i = VIRTIO_SCSI_VQ_BASE; i < num_vqs; i++) {
917 callbacks[i] = virtscsi_req_done;
918 names[i] = "request";
919 }
920
921 /* Discover virtqueues and write information to configuration. */
922 err = vdev->config->find_vqs(vdev, num_vqs, vqs, callbacks, names);
923 if (err)
924 goto out;
925
926 virtscsi_init_vq(&vscsi->ctrl_vq, vqs[0]);
927 virtscsi_init_vq(&vscsi->event_vq, vqs[1]);
928 for (i = VIRTIO_SCSI_VQ_BASE; i < num_vqs; i++)
929 virtscsi_init_vq(&vscsi->req_vqs[i - VIRTIO_SCSI_VQ_BASE],
930 vqs[i]);
931
932 virtscsi_set_affinity(vscsi, true);
933
934 virtscsi_config_set(vdev, cdb_size, VIRTIO_SCSI_CDB_SIZE);
935 virtscsi_config_set(vdev, sense_size, VIRTIO_SCSI_SENSE_SIZE);
936
937 err = 0;
938
939out:
940 kfree(names);
941 kfree(callbacks);
942 kfree(vqs);
943 if (err)
944 virtscsi_remove_vqs(vdev);
945 return err;
946}
947
948static int virtscsi_probe(struct virtio_device *vdev)
949{
950 struct Scsi_Host *shost;
951 struct virtio_scsi *vscsi;
952 int err;
953 u32 sg_elems, num_targets;
954 u32 cmd_per_lun;
955 u32 num_queues;
956 struct scsi_host_template *hostt;
957
958 if (!vdev->config->get) {
959 dev_err(&vdev->dev, "%s failure: config access disabled\n",
960 __func__);
961 return -EINVAL;
962 }
963
964 /* We need to know how many queues before we allocate. */
965 num_queues = virtscsi_config_get(vdev, num_queues) ? : 1;
966
967 num_targets = virtscsi_config_get(vdev, max_target) + 1;
968
969 if (num_queues == 1)
970 hostt = &virtscsi_host_template_single;
971 else
972 hostt = &virtscsi_host_template_multi;
973
974 shost = scsi_host_alloc(hostt,
975 sizeof(*vscsi) + sizeof(vscsi->req_vqs[0]) * num_queues);
976 if (!shost)
977 return -ENOMEM;
978
979 sg_elems = virtscsi_config_get(vdev, seg_max) ?: 1;
980 shost->sg_tablesize = sg_elems;
981 vscsi = shost_priv(shost);
982 vscsi->vdev = vdev;
983 vscsi->num_queues = num_queues;
984 vdev->priv = shost;
985
986 err = virtscsi_init(vdev, vscsi);
987 if (err)
988 goto virtscsi_init_failed;
989
990 vscsi->nb.notifier_call = &virtscsi_cpu_callback;
991 err = register_hotcpu_notifier(&vscsi->nb);
992 if (err) {
993 pr_err("registering cpu notifier failed\n");
994 goto scsi_add_host_failed;
995 }
996
997 cmd_per_lun = virtscsi_config_get(vdev, cmd_per_lun) ?: 1;
998 shost->cmd_per_lun = min_t(u32, cmd_per_lun, shost->can_queue);
999 shost->max_sectors = virtscsi_config_get(vdev, max_sectors) ?: 0xFFFF;
1000
1001 /* LUNs > 256 are reported with format 1, so they go in the range
1002 * 16640-32767.
1003 */
1004 shost->max_lun = virtscsi_config_get(vdev, max_lun) + 1 + 0x4000;
1005 shost->max_id = num_targets;
1006 shost->max_channel = 0;
1007 shost->max_cmd_len = VIRTIO_SCSI_CDB_SIZE;
1008 shost->nr_hw_queues = num_queues;
1009
1010#ifdef CONFIG_BLK_DEV_INTEGRITY
1011 if (virtio_has_feature(vdev, VIRTIO_SCSI_F_T10_PI)) {
1012 int host_prot;
1013
1014 host_prot = SHOST_DIF_TYPE1_PROTECTION | SHOST_DIF_TYPE2_PROTECTION |
1015 SHOST_DIF_TYPE3_PROTECTION | SHOST_DIX_TYPE1_PROTECTION |
1016 SHOST_DIX_TYPE2_PROTECTION | SHOST_DIX_TYPE3_PROTECTION;
1017
1018 scsi_host_set_prot(shost, host_prot);
1019 scsi_host_set_guard(shost, SHOST_DIX_GUARD_CRC);
1020 }
1021#endif
1022
1023 err = scsi_add_host(shost, &vdev->dev);
1024 if (err)
1025 goto scsi_add_host_failed;
1026
1027 virtio_device_ready(vdev);
1028
1029 if (virtio_has_feature(vdev, VIRTIO_SCSI_F_HOTPLUG))
1030 virtscsi_kick_event_all(vscsi);
1031
1032 scsi_scan_host(shost);
1033 return 0;
1034
1035scsi_add_host_failed:
1036 vdev->config->del_vqs(vdev);
1037virtscsi_init_failed:
1038 scsi_host_put(shost);
1039 return err;
1040}
1041
1042static void virtscsi_remove(struct virtio_device *vdev)
1043{
1044 struct Scsi_Host *shost = virtio_scsi_host(vdev);
1045 struct virtio_scsi *vscsi = shost_priv(shost);
1046
1047 if (virtio_has_feature(vdev, VIRTIO_SCSI_F_HOTPLUG))
1048 virtscsi_cancel_event_work(vscsi);
1049
1050 scsi_remove_host(shost);
1051
1052 unregister_hotcpu_notifier(&vscsi->nb);
1053
1054 virtscsi_remove_vqs(vdev);
1055 scsi_host_put(shost);
1056}
1057
1058#ifdef CONFIG_PM_SLEEP
1059static int virtscsi_freeze(struct virtio_device *vdev)
1060{
1061 struct Scsi_Host *sh = virtio_scsi_host(vdev);
1062 struct virtio_scsi *vscsi = shost_priv(sh);
1063
1064 unregister_hotcpu_notifier(&vscsi->nb);
1065 virtscsi_remove_vqs(vdev);
1066 return 0;
1067}
1068
1069static int virtscsi_restore(struct virtio_device *vdev)
1070{
1071 struct Scsi_Host *sh = virtio_scsi_host(vdev);
1072 struct virtio_scsi *vscsi = shost_priv(sh);
1073 int err;
1074
1075 err = virtscsi_init(vdev, vscsi);
1076 if (err)
1077 return err;
1078
1079 err = register_hotcpu_notifier(&vscsi->nb);
1080 if (err) {
1081 vdev->config->del_vqs(vdev);
1082 return err;
1083 }
1084
1085 virtio_device_ready(vdev);
1086
1087 if (virtio_has_feature(vdev, VIRTIO_SCSI_F_HOTPLUG))
1088 virtscsi_kick_event_all(vscsi);
1089
1090 return err;
1091}
1092#endif
1093
1094static struct virtio_device_id id_table[] = {
1095 { VIRTIO_ID_SCSI, VIRTIO_DEV_ANY_ID },
1096 { 0 },
1097};
1098
1099static unsigned int features[] = {
1100 VIRTIO_SCSI_F_HOTPLUG,
1101 VIRTIO_SCSI_F_CHANGE,
1102#ifdef CONFIG_BLK_DEV_INTEGRITY
1103 VIRTIO_SCSI_F_T10_PI,
1104#endif
1105};
1106
1107static struct virtio_driver virtio_scsi_driver = {
1108 .feature_table = features,
1109 .feature_table_size = ARRAY_SIZE(features),
1110 .driver.name = KBUILD_MODNAME,
1111 .driver.owner = THIS_MODULE,
1112 .id_table = id_table,
1113 .probe = virtscsi_probe,
1114#ifdef CONFIG_PM_SLEEP
1115 .freeze = virtscsi_freeze,
1116 .restore = virtscsi_restore,
1117#endif
1118 .remove = virtscsi_remove,
1119};
1120
1121static int __init init(void)
1122{
1123 int ret = -ENOMEM;
1124
1125 virtscsi_cmd_cache = KMEM_CACHE(virtio_scsi_cmd, 0);
1126 if (!virtscsi_cmd_cache) {
1127 pr_err("kmem_cache_create() for virtscsi_cmd_cache failed\n");
1128 goto error;
1129 }
1130
1131
1132 virtscsi_cmd_pool =
1133 mempool_create_slab_pool(VIRTIO_SCSI_MEMPOOL_SZ,
1134 virtscsi_cmd_cache);
1135 if (!virtscsi_cmd_pool) {
1136 pr_err("mempool_create() for virtscsi_cmd_pool failed\n");
1137 goto error;
1138 }
1139 ret = register_virtio_driver(&virtio_scsi_driver);
1140 if (ret < 0)
1141 goto error;
1142
1143 return 0;
1144
1145error:
1146 if (virtscsi_cmd_pool) {
1147 mempool_destroy(virtscsi_cmd_pool);
1148 virtscsi_cmd_pool = NULL;
1149 }
1150 if (virtscsi_cmd_cache) {
1151 kmem_cache_destroy(virtscsi_cmd_cache);
1152 virtscsi_cmd_cache = NULL;
1153 }
1154 return ret;
1155}
1156
1157static void __exit fini(void)
1158{
1159 unregister_virtio_driver(&virtio_scsi_driver);
1160 mempool_destroy(virtscsi_cmd_pool);
1161 kmem_cache_destroy(virtscsi_cmd_cache);
1162}
1163module_init(init);
1164module_exit(fini);
1165
1166MODULE_DEVICE_TABLE(virtio, id_table);
1167MODULE_DESCRIPTION("Virtio SCSI HBA driver");
1168MODULE_LICENSE("GPL");
1// SPDX-License-Identifier: GPL-2.0-or-later
2/*
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>
11 */
12
13#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
14
15#include <linux/module.h>
16#include <linux/slab.h>
17#include <linux/mempool.h>
18#include <linux/interrupt.h>
19#include <linux/virtio.h>
20#include <linux/virtio_ids.h>
21#include <linux/virtio_config.h>
22#include <linux/virtio_scsi.h>
23#include <linux/cpu.h>
24#include <linux/blkdev.h>
25#include <linux/blk-integrity.h>
26#include <scsi/scsi_host.h>
27#include <scsi/scsi_device.h>
28#include <scsi/scsi_cmnd.h>
29#include <scsi/scsi_tcq.h>
30#include <scsi/scsi_devinfo.h>
31#include <linux/seqlock.h>
32#include <linux/blk-mq-virtio.h>
33
34#include "sd.h"
35
36#define VIRTIO_SCSI_MEMPOOL_SZ 64
37#define VIRTIO_SCSI_EVENT_LEN 8
38#define VIRTIO_SCSI_VQ_BASE 2
39
40/* Command queue element */
41struct virtio_scsi_cmd {
42 struct scsi_cmnd *sc;
43 struct completion *comp;
44 union {
45 struct virtio_scsi_cmd_req cmd;
46 struct virtio_scsi_cmd_req_pi cmd_pi;
47 struct virtio_scsi_ctrl_tmf_req tmf;
48 struct virtio_scsi_ctrl_an_req an;
49 } req;
50 union {
51 struct virtio_scsi_cmd_resp cmd;
52 struct virtio_scsi_ctrl_tmf_resp tmf;
53 struct virtio_scsi_ctrl_an_resp an;
54 struct virtio_scsi_event evt;
55 } resp;
56} ____cacheline_aligned_in_smp;
57
58struct virtio_scsi_event_node {
59 struct virtio_scsi *vscsi;
60 struct virtio_scsi_event event;
61 struct work_struct work;
62};
63
64struct virtio_scsi_vq {
65 /* Protects vq */
66 spinlock_t vq_lock;
67
68 struct virtqueue *vq;
69};
70
71/* Driver instance state */
72struct virtio_scsi {
73 struct virtio_device *vdev;
74
75 /* Get some buffers ready for event vq */
76 struct virtio_scsi_event_node event_list[VIRTIO_SCSI_EVENT_LEN];
77
78 u32 num_queues;
79
80 struct hlist_node node;
81
82 /* Protected by event_vq lock */
83 bool stop_events;
84
85 struct virtio_scsi_vq ctrl_vq;
86 struct virtio_scsi_vq event_vq;
87 struct virtio_scsi_vq req_vqs[];
88};
89
90static struct kmem_cache *virtscsi_cmd_cache;
91static mempool_t *virtscsi_cmd_pool;
92
93static inline struct Scsi_Host *virtio_scsi_host(struct virtio_device *vdev)
94{
95 return vdev->priv;
96}
97
98static void virtscsi_compute_resid(struct scsi_cmnd *sc, u32 resid)
99{
100 if (resid)
101 scsi_set_resid(sc, min(resid, scsi_bufflen(sc)));
102}
103
104/*
105 * virtscsi_complete_cmd - finish a scsi_cmd and invoke scsi_done
106 *
107 * Called with vq_lock held.
108 */
109static void virtscsi_complete_cmd(struct virtio_scsi *vscsi, void *buf)
110{
111 struct virtio_scsi_cmd *cmd = buf;
112 struct scsi_cmnd *sc = cmd->sc;
113 struct virtio_scsi_cmd_resp *resp = &cmd->resp.cmd;
114
115 dev_dbg(&sc->device->sdev_gendev,
116 "cmd %p response %u status %#02x sense_len %u\n",
117 sc, resp->response, resp->status, resp->sense_len);
118
119 sc->result = resp->status;
120 virtscsi_compute_resid(sc, virtio32_to_cpu(vscsi->vdev, resp->resid));
121 switch (resp->response) {
122 case VIRTIO_SCSI_S_OK:
123 set_host_byte(sc, DID_OK);
124 break;
125 case VIRTIO_SCSI_S_OVERRUN:
126 set_host_byte(sc, DID_ERROR);
127 break;
128 case VIRTIO_SCSI_S_ABORTED:
129 set_host_byte(sc, DID_ABORT);
130 break;
131 case VIRTIO_SCSI_S_BAD_TARGET:
132 set_host_byte(sc, DID_BAD_TARGET);
133 break;
134 case VIRTIO_SCSI_S_RESET:
135 set_host_byte(sc, DID_RESET);
136 break;
137 case VIRTIO_SCSI_S_BUSY:
138 set_host_byte(sc, DID_BUS_BUSY);
139 break;
140 case VIRTIO_SCSI_S_TRANSPORT_FAILURE:
141 set_host_byte(sc, DID_TRANSPORT_DISRUPTED);
142 break;
143 case VIRTIO_SCSI_S_TARGET_FAILURE:
144 set_host_byte(sc, DID_BAD_TARGET);
145 break;
146 case VIRTIO_SCSI_S_NEXUS_FAILURE:
147 set_status_byte(sc, SAM_STAT_RESERVATION_CONFLICT);
148 break;
149 default:
150 scmd_printk(KERN_WARNING, sc, "Unknown response %d",
151 resp->response);
152 fallthrough;
153 case VIRTIO_SCSI_S_FAILURE:
154 set_host_byte(sc, DID_ERROR);
155 break;
156 }
157
158 WARN_ON(virtio32_to_cpu(vscsi->vdev, resp->sense_len) >
159 VIRTIO_SCSI_SENSE_SIZE);
160 if (resp->sense_len) {
161 memcpy(sc->sense_buffer, resp->sense,
162 min_t(u32,
163 virtio32_to_cpu(vscsi->vdev, resp->sense_len),
164 VIRTIO_SCSI_SENSE_SIZE));
165 }
166
167 scsi_done(sc);
168}
169
170static void virtscsi_vq_done(struct virtio_scsi *vscsi,
171 struct virtio_scsi_vq *virtscsi_vq,
172 void (*fn)(struct virtio_scsi *vscsi, void *buf))
173{
174 void *buf;
175 unsigned int len;
176 unsigned long flags;
177 struct virtqueue *vq = virtscsi_vq->vq;
178
179 spin_lock_irqsave(&virtscsi_vq->vq_lock, flags);
180 do {
181 virtqueue_disable_cb(vq);
182 while ((buf = virtqueue_get_buf(vq, &len)) != NULL)
183 fn(vscsi, buf);
184
185 if (unlikely(virtqueue_is_broken(vq)))
186 break;
187 } while (!virtqueue_enable_cb(vq));
188 spin_unlock_irqrestore(&virtscsi_vq->vq_lock, flags);
189}
190
191static void virtscsi_req_done(struct virtqueue *vq)
192{
193 struct Scsi_Host *sh = virtio_scsi_host(vq->vdev);
194 struct virtio_scsi *vscsi = shost_priv(sh);
195 int index = vq->index - VIRTIO_SCSI_VQ_BASE;
196 struct virtio_scsi_vq *req_vq = &vscsi->req_vqs[index];
197
198 virtscsi_vq_done(vscsi, req_vq, virtscsi_complete_cmd);
199};
200
201static void virtscsi_poll_requests(struct virtio_scsi *vscsi)
202{
203 int i, num_vqs;
204
205 num_vqs = vscsi->num_queues;
206 for (i = 0; i < num_vqs; i++)
207 virtscsi_vq_done(vscsi, &vscsi->req_vqs[i],
208 virtscsi_complete_cmd);
209}
210
211static void virtscsi_complete_free(struct virtio_scsi *vscsi, void *buf)
212{
213 struct virtio_scsi_cmd *cmd = buf;
214
215 if (cmd->comp)
216 complete(cmd->comp);
217}
218
219static void virtscsi_ctrl_done(struct virtqueue *vq)
220{
221 struct Scsi_Host *sh = virtio_scsi_host(vq->vdev);
222 struct virtio_scsi *vscsi = shost_priv(sh);
223
224 virtscsi_vq_done(vscsi, &vscsi->ctrl_vq, virtscsi_complete_free);
225};
226
227static void virtscsi_handle_event(struct work_struct *work);
228
229static int virtscsi_kick_event(struct virtio_scsi *vscsi,
230 struct virtio_scsi_event_node *event_node)
231{
232 int err;
233 struct scatterlist sg;
234 unsigned long flags;
235
236 INIT_WORK(&event_node->work, virtscsi_handle_event);
237 sg_init_one(&sg, &event_node->event, sizeof(struct virtio_scsi_event));
238
239 spin_lock_irqsave(&vscsi->event_vq.vq_lock, flags);
240
241 err = virtqueue_add_inbuf(vscsi->event_vq.vq, &sg, 1, event_node,
242 GFP_ATOMIC);
243 if (!err)
244 virtqueue_kick(vscsi->event_vq.vq);
245
246 spin_unlock_irqrestore(&vscsi->event_vq.vq_lock, flags);
247
248 return err;
249}
250
251static int virtscsi_kick_event_all(struct virtio_scsi *vscsi)
252{
253 int i;
254
255 for (i = 0; i < VIRTIO_SCSI_EVENT_LEN; i++) {
256 vscsi->event_list[i].vscsi = vscsi;
257 virtscsi_kick_event(vscsi, &vscsi->event_list[i]);
258 }
259
260 return 0;
261}
262
263static void virtscsi_cancel_event_work(struct virtio_scsi *vscsi)
264{
265 int i;
266
267 /* Stop scheduling work before calling cancel_work_sync. */
268 spin_lock_irq(&vscsi->event_vq.vq_lock);
269 vscsi->stop_events = true;
270 spin_unlock_irq(&vscsi->event_vq.vq_lock);
271
272 for (i = 0; i < VIRTIO_SCSI_EVENT_LEN; i++)
273 cancel_work_sync(&vscsi->event_list[i].work);
274}
275
276static void virtscsi_handle_transport_reset(struct virtio_scsi *vscsi,
277 struct virtio_scsi_event *event)
278{
279 struct scsi_device *sdev;
280 struct Scsi_Host *shost = virtio_scsi_host(vscsi->vdev);
281 unsigned int target = event->lun[1];
282 unsigned int lun = (event->lun[2] << 8) | event->lun[3];
283
284 switch (virtio32_to_cpu(vscsi->vdev, event->reason)) {
285 case VIRTIO_SCSI_EVT_RESET_RESCAN:
286 if (lun == 0) {
287 scsi_scan_target(&shost->shost_gendev, 0, target,
288 SCAN_WILD_CARD, SCSI_SCAN_INITIAL);
289 } else {
290 scsi_add_device(shost, 0, target, lun);
291 }
292 break;
293 case VIRTIO_SCSI_EVT_RESET_REMOVED:
294 sdev = scsi_device_lookup(shost, 0, target, lun);
295 if (sdev) {
296 scsi_remove_device(sdev);
297 scsi_device_put(sdev);
298 } else {
299 pr_err("SCSI device %d 0 %d %d not found\n",
300 shost->host_no, target, lun);
301 }
302 break;
303 default:
304 pr_info("Unsupported virtio scsi event reason %x\n", event->reason);
305 }
306}
307
308static void virtscsi_handle_param_change(struct virtio_scsi *vscsi,
309 struct virtio_scsi_event *event)
310{
311 struct scsi_device *sdev;
312 struct Scsi_Host *shost = virtio_scsi_host(vscsi->vdev);
313 unsigned int target = event->lun[1];
314 unsigned int lun = (event->lun[2] << 8) | event->lun[3];
315 u8 asc = virtio32_to_cpu(vscsi->vdev, event->reason) & 255;
316 u8 ascq = virtio32_to_cpu(vscsi->vdev, event->reason) >> 8;
317
318 sdev = scsi_device_lookup(shost, 0, target, lun);
319 if (!sdev) {
320 pr_err("SCSI device %d 0 %d %d not found\n",
321 shost->host_no, target, lun);
322 return;
323 }
324
325 /* Handle "Parameters changed", "Mode parameters changed", and
326 "Capacity data has changed". */
327 if (asc == 0x2a && (ascq == 0x00 || ascq == 0x01 || ascq == 0x09))
328 scsi_rescan_device(&sdev->sdev_gendev);
329
330 scsi_device_put(sdev);
331}
332
333static void virtscsi_rescan_hotunplug(struct virtio_scsi *vscsi)
334{
335 struct scsi_device *sdev;
336 struct Scsi_Host *shost = virtio_scsi_host(vscsi->vdev);
337 unsigned char scsi_cmd[MAX_COMMAND_SIZE];
338 int result, inquiry_len, inq_result_len = 256;
339 char *inq_result = kmalloc(inq_result_len, GFP_KERNEL);
340
341 shost_for_each_device(sdev, shost) {
342 inquiry_len = sdev->inquiry_len ? sdev->inquiry_len : 36;
343
344 memset(scsi_cmd, 0, sizeof(scsi_cmd));
345 scsi_cmd[0] = INQUIRY;
346 scsi_cmd[4] = (unsigned char) inquiry_len;
347
348 memset(inq_result, 0, inq_result_len);
349
350 result = scsi_execute_req(sdev, scsi_cmd, DMA_FROM_DEVICE,
351 inq_result, inquiry_len, NULL,
352 SD_TIMEOUT, SD_MAX_RETRIES, NULL);
353
354 if (result == 0 && inq_result[0] >> 5) {
355 /* PQ indicates the LUN is not attached */
356 scsi_remove_device(sdev);
357 } else if (result > 0 && host_byte(result) == DID_BAD_TARGET) {
358 /*
359 * If all LUNs of a virtio-scsi device are unplugged
360 * it will respond with BAD TARGET on any INQUIRY
361 * command.
362 * Remove the device in this case as well.
363 */
364 scsi_remove_device(sdev);
365 }
366 }
367
368 kfree(inq_result);
369}
370
371static void virtscsi_handle_event(struct work_struct *work)
372{
373 struct virtio_scsi_event_node *event_node =
374 container_of(work, struct virtio_scsi_event_node, work);
375 struct virtio_scsi *vscsi = event_node->vscsi;
376 struct virtio_scsi_event *event = &event_node->event;
377
378 if (event->event &
379 cpu_to_virtio32(vscsi->vdev, VIRTIO_SCSI_T_EVENTS_MISSED)) {
380 event->event &= ~cpu_to_virtio32(vscsi->vdev,
381 VIRTIO_SCSI_T_EVENTS_MISSED);
382 virtscsi_rescan_hotunplug(vscsi);
383 scsi_scan_host(virtio_scsi_host(vscsi->vdev));
384 }
385
386 switch (virtio32_to_cpu(vscsi->vdev, event->event)) {
387 case VIRTIO_SCSI_T_NO_EVENT:
388 break;
389 case VIRTIO_SCSI_T_TRANSPORT_RESET:
390 virtscsi_handle_transport_reset(vscsi, event);
391 break;
392 case VIRTIO_SCSI_T_PARAM_CHANGE:
393 virtscsi_handle_param_change(vscsi, event);
394 break;
395 default:
396 pr_err("Unsupported virtio scsi event %x\n", event->event);
397 }
398 virtscsi_kick_event(vscsi, event_node);
399}
400
401static void virtscsi_complete_event(struct virtio_scsi *vscsi, void *buf)
402{
403 struct virtio_scsi_event_node *event_node = buf;
404
405 if (!vscsi->stop_events)
406 queue_work(system_freezable_wq, &event_node->work);
407}
408
409static void virtscsi_event_done(struct virtqueue *vq)
410{
411 struct Scsi_Host *sh = virtio_scsi_host(vq->vdev);
412 struct virtio_scsi *vscsi = shost_priv(sh);
413
414 virtscsi_vq_done(vscsi, &vscsi->event_vq, virtscsi_complete_event);
415};
416
417static int __virtscsi_add_cmd(struct virtqueue *vq,
418 struct virtio_scsi_cmd *cmd,
419 size_t req_size, size_t resp_size)
420{
421 struct scsi_cmnd *sc = cmd->sc;
422 struct scatterlist *sgs[6], req, resp;
423 struct sg_table *out, *in;
424 unsigned out_num = 0, in_num = 0;
425
426 out = in = NULL;
427
428 if (sc && sc->sc_data_direction != DMA_NONE) {
429 if (sc->sc_data_direction != DMA_FROM_DEVICE)
430 out = &sc->sdb.table;
431 if (sc->sc_data_direction != DMA_TO_DEVICE)
432 in = &sc->sdb.table;
433 }
434
435 /* Request header. */
436 sg_init_one(&req, &cmd->req, req_size);
437 sgs[out_num++] = &req;
438
439 /* Data-out buffer. */
440 if (out) {
441 /* Place WRITE protection SGLs before Data OUT payload */
442 if (scsi_prot_sg_count(sc))
443 sgs[out_num++] = scsi_prot_sglist(sc);
444 sgs[out_num++] = out->sgl;
445 }
446
447 /* Response header. */
448 sg_init_one(&resp, &cmd->resp, resp_size);
449 sgs[out_num + in_num++] = &resp;
450
451 /* Data-in buffer */
452 if (in) {
453 /* Place READ protection SGLs before Data IN payload */
454 if (scsi_prot_sg_count(sc))
455 sgs[out_num + in_num++] = scsi_prot_sglist(sc);
456 sgs[out_num + in_num++] = in->sgl;
457 }
458
459 return virtqueue_add_sgs(vq, sgs, out_num, in_num, cmd, GFP_ATOMIC);
460}
461
462static void virtscsi_kick_vq(struct virtio_scsi_vq *vq)
463{
464 bool needs_kick;
465 unsigned long flags;
466
467 spin_lock_irqsave(&vq->vq_lock, flags);
468 needs_kick = virtqueue_kick_prepare(vq->vq);
469 spin_unlock_irqrestore(&vq->vq_lock, flags);
470
471 if (needs_kick)
472 virtqueue_notify(vq->vq);
473}
474
475/**
476 * virtscsi_add_cmd - add a virtio_scsi_cmd to a virtqueue, optionally kick it
477 * @vq : the struct virtqueue we're talking about
478 * @cmd : command structure
479 * @req_size : size of the request buffer
480 * @resp_size : size of the response buffer
481 * @kick : whether to kick the virtqueue immediately
482 */
483static int virtscsi_add_cmd(struct virtio_scsi_vq *vq,
484 struct virtio_scsi_cmd *cmd,
485 size_t req_size, size_t resp_size,
486 bool kick)
487{
488 unsigned long flags;
489 int err;
490 bool needs_kick = false;
491
492 spin_lock_irqsave(&vq->vq_lock, flags);
493 err = __virtscsi_add_cmd(vq->vq, cmd, req_size, resp_size);
494 if (!err && kick)
495 needs_kick = virtqueue_kick_prepare(vq->vq);
496
497 spin_unlock_irqrestore(&vq->vq_lock, flags);
498
499 if (needs_kick)
500 virtqueue_notify(vq->vq);
501 return err;
502}
503
504static void virtio_scsi_init_hdr(struct virtio_device *vdev,
505 struct virtio_scsi_cmd_req *cmd,
506 struct scsi_cmnd *sc)
507{
508 cmd->lun[0] = 1;
509 cmd->lun[1] = sc->device->id;
510 cmd->lun[2] = (sc->device->lun >> 8) | 0x40;
511 cmd->lun[3] = sc->device->lun & 0xff;
512 cmd->tag = cpu_to_virtio64(vdev, (unsigned long)sc);
513 cmd->task_attr = VIRTIO_SCSI_S_SIMPLE;
514 cmd->prio = 0;
515 cmd->crn = 0;
516}
517
518#ifdef CONFIG_BLK_DEV_INTEGRITY
519static void virtio_scsi_init_hdr_pi(struct virtio_device *vdev,
520 struct virtio_scsi_cmd_req_pi *cmd_pi,
521 struct scsi_cmnd *sc)
522{
523 struct request *rq = scsi_cmd_to_rq(sc);
524 struct blk_integrity *bi;
525
526 virtio_scsi_init_hdr(vdev, (struct virtio_scsi_cmd_req *)cmd_pi, sc);
527
528 if (!rq || !scsi_prot_sg_count(sc))
529 return;
530
531 bi = blk_get_integrity(rq->q->disk);
532
533 if (sc->sc_data_direction == DMA_TO_DEVICE)
534 cmd_pi->pi_bytesout = cpu_to_virtio32(vdev,
535 bio_integrity_bytes(bi,
536 blk_rq_sectors(rq)));
537 else if (sc->sc_data_direction == DMA_FROM_DEVICE)
538 cmd_pi->pi_bytesin = cpu_to_virtio32(vdev,
539 bio_integrity_bytes(bi,
540 blk_rq_sectors(rq)));
541}
542#endif
543
544static struct virtio_scsi_vq *virtscsi_pick_vq_mq(struct virtio_scsi *vscsi,
545 struct scsi_cmnd *sc)
546{
547 u32 tag = blk_mq_unique_tag(scsi_cmd_to_rq(sc));
548 u16 hwq = blk_mq_unique_tag_to_hwq(tag);
549
550 return &vscsi->req_vqs[hwq];
551}
552
553static int virtscsi_queuecommand(struct Scsi_Host *shost,
554 struct scsi_cmnd *sc)
555{
556 struct virtio_scsi *vscsi = shost_priv(shost);
557 struct virtio_scsi_vq *req_vq = virtscsi_pick_vq_mq(vscsi, sc);
558 struct virtio_scsi_cmd *cmd = scsi_cmd_priv(sc);
559 bool kick;
560 unsigned long flags;
561 int req_size;
562 int ret;
563
564 BUG_ON(scsi_sg_count(sc) > shost->sg_tablesize);
565
566 /* TODO: check feature bit and fail if unsupported? */
567 BUG_ON(sc->sc_data_direction == DMA_BIDIRECTIONAL);
568
569 dev_dbg(&sc->device->sdev_gendev,
570 "cmd %p CDB: %#02x\n", sc, sc->cmnd[0]);
571
572 cmd->sc = sc;
573
574 BUG_ON(sc->cmd_len > VIRTIO_SCSI_CDB_SIZE);
575
576#ifdef CONFIG_BLK_DEV_INTEGRITY
577 if (virtio_has_feature(vscsi->vdev, VIRTIO_SCSI_F_T10_PI)) {
578 virtio_scsi_init_hdr_pi(vscsi->vdev, &cmd->req.cmd_pi, sc);
579 memcpy(cmd->req.cmd_pi.cdb, sc->cmnd, sc->cmd_len);
580 req_size = sizeof(cmd->req.cmd_pi);
581 } else
582#endif
583 {
584 virtio_scsi_init_hdr(vscsi->vdev, &cmd->req.cmd, sc);
585 memcpy(cmd->req.cmd.cdb, sc->cmnd, sc->cmd_len);
586 req_size = sizeof(cmd->req.cmd);
587 }
588
589 kick = (sc->flags & SCMD_LAST) != 0;
590 ret = virtscsi_add_cmd(req_vq, cmd, req_size, sizeof(cmd->resp.cmd), kick);
591 if (ret == -EIO) {
592 cmd->resp.cmd.response = VIRTIO_SCSI_S_BAD_TARGET;
593 spin_lock_irqsave(&req_vq->vq_lock, flags);
594 virtscsi_complete_cmd(vscsi, cmd);
595 spin_unlock_irqrestore(&req_vq->vq_lock, flags);
596 } else if (ret != 0) {
597 return SCSI_MLQUEUE_HOST_BUSY;
598 }
599 return 0;
600}
601
602static int virtscsi_tmf(struct virtio_scsi *vscsi, struct virtio_scsi_cmd *cmd)
603{
604 DECLARE_COMPLETION_ONSTACK(comp);
605 int ret = FAILED;
606
607 cmd->comp = ∁
608 if (virtscsi_add_cmd(&vscsi->ctrl_vq, cmd,
609 sizeof cmd->req.tmf, sizeof cmd->resp.tmf, true) < 0)
610 goto out;
611
612 wait_for_completion(&comp);
613 if (cmd->resp.tmf.response == VIRTIO_SCSI_S_OK ||
614 cmd->resp.tmf.response == VIRTIO_SCSI_S_FUNCTION_SUCCEEDED)
615 ret = SUCCESS;
616
617 /*
618 * The spec guarantees that all requests related to the TMF have
619 * been completed, but the callback might not have run yet if
620 * we're using independent interrupts (e.g. MSI). Poll the
621 * virtqueues once.
622 *
623 * In the abort case, scsi_done() will do nothing, because the
624 * command timed out and hence SCMD_STATE_COMPLETE has been set.
625 */
626 virtscsi_poll_requests(vscsi);
627
628out:
629 mempool_free(cmd, virtscsi_cmd_pool);
630 return ret;
631}
632
633static int virtscsi_device_reset(struct scsi_cmnd *sc)
634{
635 struct virtio_scsi *vscsi = shost_priv(sc->device->host);
636 struct virtio_scsi_cmd *cmd;
637
638 sdev_printk(KERN_INFO, sc->device, "device reset\n");
639 cmd = mempool_alloc(virtscsi_cmd_pool, GFP_NOIO);
640 if (!cmd)
641 return FAILED;
642
643 memset(cmd, 0, sizeof(*cmd));
644 cmd->req.tmf = (struct virtio_scsi_ctrl_tmf_req){
645 .type = VIRTIO_SCSI_T_TMF,
646 .subtype = cpu_to_virtio32(vscsi->vdev,
647 VIRTIO_SCSI_T_TMF_LOGICAL_UNIT_RESET),
648 .lun[0] = 1,
649 .lun[1] = sc->device->id,
650 .lun[2] = (sc->device->lun >> 8) | 0x40,
651 .lun[3] = sc->device->lun & 0xff,
652 };
653 return virtscsi_tmf(vscsi, cmd);
654}
655
656static int virtscsi_device_alloc(struct scsi_device *sdevice)
657{
658 /*
659 * Passed through SCSI targets (e.g. with qemu's 'scsi-block')
660 * may have transfer limits which come from the host SCSI
661 * controller or something on the host side other than the
662 * target itself.
663 *
664 * To make this work properly, the hypervisor can adjust the
665 * target's VPD information to advertise these limits. But
666 * for that to work, the guest has to look at the VPD pages,
667 * which we won't do by default if it is an SPC-2 device, even
668 * if it does actually support it.
669 *
670 * So, set the blist to always try to read the VPD pages.
671 */
672 sdevice->sdev_bflags = BLIST_TRY_VPD_PAGES;
673
674 return 0;
675}
676
677
678/**
679 * virtscsi_change_queue_depth() - Change a virtscsi target's queue depth
680 * @sdev: Virtscsi target whose queue depth to change
681 * @qdepth: New queue depth
682 */
683static int virtscsi_change_queue_depth(struct scsi_device *sdev, int qdepth)
684{
685 struct Scsi_Host *shost = sdev->host;
686 int max_depth = shost->cmd_per_lun;
687
688 return scsi_change_queue_depth(sdev, min(max_depth, qdepth));
689}
690
691static int virtscsi_abort(struct scsi_cmnd *sc)
692{
693 struct virtio_scsi *vscsi = shost_priv(sc->device->host);
694 struct virtio_scsi_cmd *cmd;
695
696 scmd_printk(KERN_INFO, sc, "abort\n");
697 cmd = mempool_alloc(virtscsi_cmd_pool, GFP_NOIO);
698 if (!cmd)
699 return FAILED;
700
701 memset(cmd, 0, sizeof(*cmd));
702 cmd->req.tmf = (struct virtio_scsi_ctrl_tmf_req){
703 .type = VIRTIO_SCSI_T_TMF,
704 .subtype = VIRTIO_SCSI_T_TMF_ABORT_TASK,
705 .lun[0] = 1,
706 .lun[1] = sc->device->id,
707 .lun[2] = (sc->device->lun >> 8) | 0x40,
708 .lun[3] = sc->device->lun & 0xff,
709 .tag = cpu_to_virtio64(vscsi->vdev, (unsigned long)sc),
710 };
711 return virtscsi_tmf(vscsi, cmd);
712}
713
714static void virtscsi_map_queues(struct Scsi_Host *shost)
715{
716 struct virtio_scsi *vscsi = shost_priv(shost);
717 struct blk_mq_queue_map *qmap = &shost->tag_set.map[HCTX_TYPE_DEFAULT];
718
719 blk_mq_virtio_map_queues(qmap, vscsi->vdev, 2);
720}
721
722static void virtscsi_commit_rqs(struct Scsi_Host *shost, u16 hwq)
723{
724 struct virtio_scsi *vscsi = shost_priv(shost);
725
726 virtscsi_kick_vq(&vscsi->req_vqs[hwq]);
727}
728
729/*
730 * The host guarantees to respond to each command, although I/O
731 * latencies might be higher than on bare metal. Reset the timer
732 * unconditionally to give the host a chance to perform EH.
733 */
734static enum scsi_timeout_action virtscsi_eh_timed_out(struct scsi_cmnd *scmnd)
735{
736 return SCSI_EH_RESET_TIMER;
737}
738
739static struct scsi_host_template virtscsi_host_template = {
740 .module = THIS_MODULE,
741 .name = "Virtio SCSI HBA",
742 .proc_name = "virtio_scsi",
743 .this_id = -1,
744 .cmd_size = sizeof(struct virtio_scsi_cmd),
745 .queuecommand = virtscsi_queuecommand,
746 .commit_rqs = virtscsi_commit_rqs,
747 .change_queue_depth = virtscsi_change_queue_depth,
748 .eh_abort_handler = virtscsi_abort,
749 .eh_device_reset_handler = virtscsi_device_reset,
750 .eh_timed_out = virtscsi_eh_timed_out,
751 .slave_alloc = virtscsi_device_alloc,
752
753 .dma_boundary = UINT_MAX,
754 .map_queues = virtscsi_map_queues,
755 .track_queue_depth = 1,
756};
757
758#define virtscsi_config_get(vdev, fld) \
759 ({ \
760 __virtio_native_type(struct virtio_scsi_config, fld) __val; \
761 virtio_cread(vdev, struct virtio_scsi_config, fld, &__val); \
762 __val; \
763 })
764
765#define virtscsi_config_set(vdev, fld, val) \
766 do { \
767 __virtio_native_type(struct virtio_scsi_config, fld) __val = (val); \
768 virtio_cwrite(vdev, struct virtio_scsi_config, fld, &__val); \
769 } while(0)
770
771static void virtscsi_init_vq(struct virtio_scsi_vq *virtscsi_vq,
772 struct virtqueue *vq)
773{
774 spin_lock_init(&virtscsi_vq->vq_lock);
775 virtscsi_vq->vq = vq;
776}
777
778static void virtscsi_remove_vqs(struct virtio_device *vdev)
779{
780 /* Stop all the virtqueues. */
781 virtio_reset_device(vdev);
782 vdev->config->del_vqs(vdev);
783}
784
785static int virtscsi_init(struct virtio_device *vdev,
786 struct virtio_scsi *vscsi)
787{
788 int err;
789 u32 i;
790 u32 num_vqs;
791 vq_callback_t **callbacks;
792 const char **names;
793 struct virtqueue **vqs;
794 struct irq_affinity desc = { .pre_vectors = 2 };
795
796 num_vqs = vscsi->num_queues + VIRTIO_SCSI_VQ_BASE;
797 vqs = kmalloc_array(num_vqs, sizeof(struct virtqueue *), GFP_KERNEL);
798 callbacks = kmalloc_array(num_vqs, sizeof(vq_callback_t *),
799 GFP_KERNEL);
800 names = kmalloc_array(num_vqs, sizeof(char *), GFP_KERNEL);
801
802 if (!callbacks || !vqs || !names) {
803 err = -ENOMEM;
804 goto out;
805 }
806
807 callbacks[0] = virtscsi_ctrl_done;
808 callbacks[1] = virtscsi_event_done;
809 names[0] = "control";
810 names[1] = "event";
811 for (i = VIRTIO_SCSI_VQ_BASE; i < num_vqs; i++) {
812 callbacks[i] = virtscsi_req_done;
813 names[i] = "request";
814 }
815
816 /* Discover virtqueues and write information to configuration. */
817 err = virtio_find_vqs(vdev, num_vqs, vqs, callbacks, names, &desc);
818 if (err)
819 goto out;
820
821 virtscsi_init_vq(&vscsi->ctrl_vq, vqs[0]);
822 virtscsi_init_vq(&vscsi->event_vq, vqs[1]);
823 for (i = VIRTIO_SCSI_VQ_BASE; i < num_vqs; i++)
824 virtscsi_init_vq(&vscsi->req_vqs[i - VIRTIO_SCSI_VQ_BASE],
825 vqs[i]);
826
827 virtscsi_config_set(vdev, cdb_size, VIRTIO_SCSI_CDB_SIZE);
828 virtscsi_config_set(vdev, sense_size, VIRTIO_SCSI_SENSE_SIZE);
829
830 err = 0;
831
832out:
833 kfree(names);
834 kfree(callbacks);
835 kfree(vqs);
836 if (err)
837 virtscsi_remove_vqs(vdev);
838 return err;
839}
840
841static int virtscsi_probe(struct virtio_device *vdev)
842{
843 struct Scsi_Host *shost;
844 struct virtio_scsi *vscsi;
845 int err;
846 u32 sg_elems, num_targets;
847 u32 cmd_per_lun;
848 u32 num_queues;
849
850 if (!vdev->config->get) {
851 dev_err(&vdev->dev, "%s failure: config access disabled\n",
852 __func__);
853 return -EINVAL;
854 }
855
856 /* We need to know how many queues before we allocate. */
857 num_queues = virtscsi_config_get(vdev, num_queues) ? : 1;
858 num_queues = min_t(unsigned int, nr_cpu_ids, num_queues);
859
860 num_targets = virtscsi_config_get(vdev, max_target) + 1;
861
862 shost = scsi_host_alloc(&virtscsi_host_template,
863 struct_size(vscsi, req_vqs, num_queues));
864 if (!shost)
865 return -ENOMEM;
866
867 sg_elems = virtscsi_config_get(vdev, seg_max) ?: 1;
868 shost->sg_tablesize = sg_elems;
869 vscsi = shost_priv(shost);
870 vscsi->vdev = vdev;
871 vscsi->num_queues = num_queues;
872 vdev->priv = shost;
873
874 err = virtscsi_init(vdev, vscsi);
875 if (err)
876 goto virtscsi_init_failed;
877
878 shost->can_queue = virtqueue_get_vring_size(vscsi->req_vqs[0].vq);
879
880 cmd_per_lun = virtscsi_config_get(vdev, cmd_per_lun) ?: 1;
881 shost->cmd_per_lun = min_t(u32, cmd_per_lun, shost->can_queue);
882 shost->max_sectors = virtscsi_config_get(vdev, max_sectors) ?: 0xFFFF;
883
884 /* LUNs > 256 are reported with format 1, so they go in the range
885 * 16640-32767.
886 */
887 shost->max_lun = virtscsi_config_get(vdev, max_lun) + 1 + 0x4000;
888 shost->max_id = num_targets;
889 shost->max_channel = 0;
890 shost->max_cmd_len = VIRTIO_SCSI_CDB_SIZE;
891 shost->nr_hw_queues = num_queues;
892
893#ifdef CONFIG_BLK_DEV_INTEGRITY
894 if (virtio_has_feature(vdev, VIRTIO_SCSI_F_T10_PI)) {
895 int host_prot;
896
897 host_prot = SHOST_DIF_TYPE1_PROTECTION | SHOST_DIF_TYPE2_PROTECTION |
898 SHOST_DIF_TYPE3_PROTECTION | SHOST_DIX_TYPE1_PROTECTION |
899 SHOST_DIX_TYPE2_PROTECTION | SHOST_DIX_TYPE3_PROTECTION;
900
901 scsi_host_set_prot(shost, host_prot);
902 scsi_host_set_guard(shost, SHOST_DIX_GUARD_CRC);
903 }
904#endif
905
906 err = scsi_add_host(shost, &vdev->dev);
907 if (err)
908 goto scsi_add_host_failed;
909
910 virtio_device_ready(vdev);
911
912 if (virtio_has_feature(vdev, VIRTIO_SCSI_F_HOTPLUG))
913 virtscsi_kick_event_all(vscsi);
914
915 scsi_scan_host(shost);
916 return 0;
917
918scsi_add_host_failed:
919 vdev->config->del_vqs(vdev);
920virtscsi_init_failed:
921 scsi_host_put(shost);
922 return err;
923}
924
925static void virtscsi_remove(struct virtio_device *vdev)
926{
927 struct Scsi_Host *shost = virtio_scsi_host(vdev);
928 struct virtio_scsi *vscsi = shost_priv(shost);
929
930 if (virtio_has_feature(vdev, VIRTIO_SCSI_F_HOTPLUG))
931 virtscsi_cancel_event_work(vscsi);
932
933 scsi_remove_host(shost);
934 virtscsi_remove_vqs(vdev);
935 scsi_host_put(shost);
936}
937
938#ifdef CONFIG_PM_SLEEP
939static int virtscsi_freeze(struct virtio_device *vdev)
940{
941 virtscsi_remove_vqs(vdev);
942 return 0;
943}
944
945static int virtscsi_restore(struct virtio_device *vdev)
946{
947 struct Scsi_Host *sh = virtio_scsi_host(vdev);
948 struct virtio_scsi *vscsi = shost_priv(sh);
949 int err;
950
951 err = virtscsi_init(vdev, vscsi);
952 if (err)
953 return err;
954
955 virtio_device_ready(vdev);
956
957 if (virtio_has_feature(vdev, VIRTIO_SCSI_F_HOTPLUG))
958 virtscsi_kick_event_all(vscsi);
959
960 return err;
961}
962#endif
963
964static struct virtio_device_id id_table[] = {
965 { VIRTIO_ID_SCSI, VIRTIO_DEV_ANY_ID },
966 { 0 },
967};
968
969static unsigned int features[] = {
970 VIRTIO_SCSI_F_HOTPLUG,
971 VIRTIO_SCSI_F_CHANGE,
972#ifdef CONFIG_BLK_DEV_INTEGRITY
973 VIRTIO_SCSI_F_T10_PI,
974#endif
975};
976
977static struct virtio_driver virtio_scsi_driver = {
978 .feature_table = features,
979 .feature_table_size = ARRAY_SIZE(features),
980 .driver.name = KBUILD_MODNAME,
981 .driver.owner = THIS_MODULE,
982 .id_table = id_table,
983 .probe = virtscsi_probe,
984#ifdef CONFIG_PM_SLEEP
985 .freeze = virtscsi_freeze,
986 .restore = virtscsi_restore,
987#endif
988 .remove = virtscsi_remove,
989};
990
991static int __init virtio_scsi_init(void)
992{
993 int ret = -ENOMEM;
994
995 virtscsi_cmd_cache = KMEM_CACHE(virtio_scsi_cmd, 0);
996 if (!virtscsi_cmd_cache) {
997 pr_err("kmem_cache_create() for virtscsi_cmd_cache failed\n");
998 goto error;
999 }
1000
1001
1002 virtscsi_cmd_pool =
1003 mempool_create_slab_pool(VIRTIO_SCSI_MEMPOOL_SZ,
1004 virtscsi_cmd_cache);
1005 if (!virtscsi_cmd_pool) {
1006 pr_err("mempool_create() for virtscsi_cmd_pool failed\n");
1007 goto error;
1008 }
1009 ret = register_virtio_driver(&virtio_scsi_driver);
1010 if (ret < 0)
1011 goto error;
1012
1013 return 0;
1014
1015error:
1016 mempool_destroy(virtscsi_cmd_pool);
1017 virtscsi_cmd_pool = NULL;
1018 kmem_cache_destroy(virtscsi_cmd_cache);
1019 virtscsi_cmd_cache = NULL;
1020 return ret;
1021}
1022
1023static void __exit virtio_scsi_fini(void)
1024{
1025 unregister_virtio_driver(&virtio_scsi_driver);
1026 mempool_destroy(virtscsi_cmd_pool);
1027 kmem_cache_destroy(virtscsi_cmd_cache);
1028}
1029module_init(virtio_scsi_init);
1030module_exit(virtio_scsi_fini);
1031
1032MODULE_DEVICE_TABLE(virtio, id_table);
1033MODULE_DESCRIPTION("Virtio SCSI HBA driver");
1034MODULE_LICENSE("GPL");