Merge branch 'for-next' of git://git.kernel.org/pub/scm/linux/kernel/git/cooloney...
[linux-2.6.git] / drivers / scsi / virtio_scsi.c
blob2168258fb2c3a2cf5374a3592a302062d75bb305
1 /*
2 * Virtio SCSI HBA driver
4 * Copyright IBM Corp. 2010
5 * Copyright Red Hat, Inc. 2011
7 * Authors:
8 * Stefan Hajnoczi <stefanha@linux.vnet.ibm.com>
9 * Paolo Bonzini <pbonzini@redhat.com>
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.
16 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
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 <scsi/scsi_host.h>
27 #include <scsi/scsi_device.h>
28 #include <scsi/scsi_cmnd.h>
30 #define VIRTIO_SCSI_MEMPOOL_SZ 64
31 #define VIRTIO_SCSI_EVENT_LEN 8
32 #define VIRTIO_SCSI_VQ_BASE 2
34 /* Command queue element */
35 struct virtio_scsi_cmd {
36 struct scsi_cmnd *sc;
37 struct completion *comp;
38 union {
39 struct virtio_scsi_cmd_req cmd;
40 struct virtio_scsi_ctrl_tmf_req tmf;
41 struct virtio_scsi_ctrl_an_req an;
42 } req;
43 union {
44 struct virtio_scsi_cmd_resp cmd;
45 struct virtio_scsi_ctrl_tmf_resp tmf;
46 struct virtio_scsi_ctrl_an_resp an;
47 struct virtio_scsi_event evt;
48 } resp;
49 } ____cacheline_aligned_in_smp;
51 struct virtio_scsi_event_node {
52 struct virtio_scsi *vscsi;
53 struct virtio_scsi_event event;
54 struct work_struct work;
57 struct virtio_scsi_vq {
58 /* Protects vq */
59 spinlock_t vq_lock;
61 struct virtqueue *vq;
65 * Per-target queue state.
67 * This struct holds the data needed by the queue steering policy. When a
68 * target is sent multiple requests, we need to drive them to the same queue so
69 * that FIFO processing order is kept. However, if a target was idle, we can
70 * choose a queue arbitrarily. In this case the queue is chosen according to
71 * the current VCPU, so the driver expects the number of request queues to be
72 * equal to the number of VCPUs. This makes it easy and fast to select the
73 * queue, and also lets the driver optimize the IRQ affinity for the virtqueues
74 * (each virtqueue's affinity is set to the CPU that "owns" the queue).
76 * An interesting effect of this policy is that only writes to req_vq need to
77 * take the tgt_lock. Read can be done outside the lock because:
79 * - writes of req_vq only occur when atomic_inc_return(&tgt->reqs) returns 1.
80 * In that case, no other CPU is reading req_vq: even if they were in
81 * virtscsi_queuecommand_multi, they would be spinning on tgt_lock.
83 * - reads of req_vq only occur when the target is not idle (reqs != 0).
84 * A CPU that enters virtscsi_queuecommand_multi will not modify req_vq.
86 * Similarly, decrements of reqs are never concurrent with writes of req_vq.
87 * Thus they can happen outside the tgt_lock, provided of course we make reqs
88 * an atomic_t.
90 struct virtio_scsi_target_state {
91 /* This spinlock never held at the same time as vq_lock. */
92 spinlock_t tgt_lock;
94 /* Count of outstanding requests. */
95 atomic_t reqs;
97 /* Currently active virtqueue for requests sent to this target. */
98 struct virtio_scsi_vq *req_vq;
101 /* Driver instance state */
102 struct virtio_scsi {
103 struct virtio_device *vdev;
105 /* Get some buffers ready for event vq */
106 struct virtio_scsi_event_node event_list[VIRTIO_SCSI_EVENT_LEN];
108 u32 num_queues;
110 /* If the affinity hint is set for virtqueues */
111 bool affinity_hint_set;
113 /* CPU hotplug notifier */
114 struct notifier_block nb;
116 struct virtio_scsi_vq ctrl_vq;
117 struct virtio_scsi_vq event_vq;
118 struct virtio_scsi_vq req_vqs[];
121 static struct kmem_cache *virtscsi_cmd_cache;
122 static mempool_t *virtscsi_cmd_pool;
124 static inline struct Scsi_Host *virtio_scsi_host(struct virtio_device *vdev)
126 return vdev->priv;
129 static void virtscsi_compute_resid(struct scsi_cmnd *sc, u32 resid)
131 if (!resid)
132 return;
134 if (!scsi_bidi_cmnd(sc)) {
135 scsi_set_resid(sc, resid);
136 return;
139 scsi_in(sc)->resid = min(resid, scsi_in(sc)->length);
140 scsi_out(sc)->resid = resid - scsi_in(sc)->resid;
144 * virtscsi_complete_cmd - finish a scsi_cmd and invoke scsi_done
146 * Called with vq_lock held.
148 static void virtscsi_complete_cmd(struct virtio_scsi *vscsi, void *buf)
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;
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);
160 sc->result = resp->status;
161 virtscsi_compute_resid(sc, 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;
199 WARN_ON(resp->sense_len > VIRTIO_SCSI_SENSE_SIZE);
200 if (sc->sense_buffer) {
201 memcpy(sc->sense_buffer, resp->sense,
202 min_t(u32, resp->sense_len, VIRTIO_SCSI_SENSE_SIZE));
203 if (resp->sense_len)
204 set_driver_byte(sc, DRIVER_SENSE);
207 mempool_free(cmd, virtscsi_cmd_pool);
208 sc->scsi_done(sc);
210 atomic_dec(&tgt->reqs);
213 static void virtscsi_vq_done(struct virtio_scsi *vscsi,
214 struct virtio_scsi_vq *virtscsi_vq,
215 void (*fn)(struct virtio_scsi *vscsi, void *buf))
217 void *buf;
218 unsigned int len;
219 unsigned long flags;
220 struct virtqueue *vq = virtscsi_vq->vq;
222 spin_lock_irqsave(&virtscsi_vq->vq_lock, flags);
223 do {
224 virtqueue_disable_cb(vq);
225 while ((buf = virtqueue_get_buf(vq, &len)) != NULL)
226 fn(vscsi, buf);
227 } while (!virtqueue_enable_cb(vq));
228 spin_unlock_irqrestore(&virtscsi_vq->vq_lock, flags);
231 static void virtscsi_req_done(struct virtqueue *vq)
233 struct Scsi_Host *sh = virtio_scsi_host(vq->vdev);
234 struct virtio_scsi *vscsi = shost_priv(sh);
235 int index = vq->index - VIRTIO_SCSI_VQ_BASE;
236 struct virtio_scsi_vq *req_vq = &vscsi->req_vqs[index];
239 * Read req_vq before decrementing the reqs field in
240 * virtscsi_complete_cmd.
242 * With barriers:
244 * CPU #0 virtscsi_queuecommand_multi (CPU #1)
245 * ------------------------------------------------------------
246 * lock vq_lock
247 * read req_vq
248 * read reqs (reqs = 1)
249 * write reqs (reqs = 0)
250 * increment reqs (reqs = 1)
251 * write req_vq
253 * Possible reordering without barriers:
255 * CPU #0 virtscsi_queuecommand_multi (CPU #1)
256 * ------------------------------------------------------------
257 * lock vq_lock
258 * read reqs (reqs = 1)
259 * write reqs (reqs = 0)
260 * increment reqs (reqs = 1)
261 * write req_vq
262 * read (wrong) req_vq
264 * We do not need a full smp_rmb, because req_vq is required to get
265 * to tgt->reqs: tgt is &vscsi->tgt[sc->device->id], where sc is stored
266 * in the virtqueue as the user token.
268 smp_read_barrier_depends();
270 virtscsi_vq_done(vscsi, req_vq, virtscsi_complete_cmd);
273 static void virtscsi_complete_free(struct virtio_scsi *vscsi, void *buf)
275 struct virtio_scsi_cmd *cmd = buf;
277 if (cmd->comp)
278 complete_all(cmd->comp);
279 else
280 mempool_free(cmd, virtscsi_cmd_pool);
283 static void virtscsi_ctrl_done(struct virtqueue *vq)
285 struct Scsi_Host *sh = virtio_scsi_host(vq->vdev);
286 struct virtio_scsi *vscsi = shost_priv(sh);
288 virtscsi_vq_done(vscsi, &vscsi->ctrl_vq, virtscsi_complete_free);
291 static int virtscsi_kick_event(struct virtio_scsi *vscsi,
292 struct virtio_scsi_event_node *event_node)
294 int err;
295 struct scatterlist sg;
296 unsigned long flags;
298 sg_init_one(&sg, &event_node->event, sizeof(struct virtio_scsi_event));
300 spin_lock_irqsave(&vscsi->event_vq.vq_lock, flags);
302 err = virtqueue_add_inbuf(vscsi->event_vq.vq, &sg, 1, event_node,
303 GFP_ATOMIC);
304 if (!err)
305 virtqueue_kick(vscsi->event_vq.vq);
307 spin_unlock_irqrestore(&vscsi->event_vq.vq_lock, flags);
309 return err;
312 static int virtscsi_kick_event_all(struct virtio_scsi *vscsi)
314 int i;
316 for (i = 0; i < VIRTIO_SCSI_EVENT_LEN; i++) {
317 vscsi->event_list[i].vscsi = vscsi;
318 virtscsi_kick_event(vscsi, &vscsi->event_list[i]);
321 return 0;
324 static void virtscsi_cancel_event_work(struct virtio_scsi *vscsi)
326 int i;
328 for (i = 0; i < VIRTIO_SCSI_EVENT_LEN; i++)
329 cancel_work_sync(&vscsi->event_list[i].work);
332 static void virtscsi_handle_transport_reset(struct virtio_scsi *vscsi,
333 struct virtio_scsi_event *event)
335 struct scsi_device *sdev;
336 struct Scsi_Host *shost = virtio_scsi_host(vscsi->vdev);
337 unsigned int target = event->lun[1];
338 unsigned int lun = (event->lun[2] << 8) | event->lun[3];
340 switch (event->reason) {
341 case VIRTIO_SCSI_EVT_RESET_RESCAN:
342 scsi_add_device(shost, 0, target, lun);
343 break;
344 case VIRTIO_SCSI_EVT_RESET_REMOVED:
345 sdev = scsi_device_lookup(shost, 0, target, lun);
346 if (sdev) {
347 scsi_remove_device(sdev);
348 scsi_device_put(sdev);
349 } else {
350 pr_err("SCSI device %d 0 %d %d not found\n",
351 shost->host_no, target, lun);
353 break;
354 default:
355 pr_info("Unsupport virtio scsi event reason %x\n", event->reason);
359 static void virtscsi_handle_param_change(struct virtio_scsi *vscsi,
360 struct virtio_scsi_event *event)
362 struct scsi_device *sdev;
363 struct Scsi_Host *shost = virtio_scsi_host(vscsi->vdev);
364 unsigned int target = event->lun[1];
365 unsigned int lun = (event->lun[2] << 8) | event->lun[3];
366 u8 asc = event->reason & 255;
367 u8 ascq = event->reason >> 8;
369 sdev = scsi_device_lookup(shost, 0, target, lun);
370 if (!sdev) {
371 pr_err("SCSI device %d 0 %d %d not found\n",
372 shost->host_no, target, lun);
373 return;
376 /* Handle "Parameters changed", "Mode parameters changed", and
377 "Capacity data has changed". */
378 if (asc == 0x2a && (ascq == 0x00 || ascq == 0x01 || ascq == 0x09))
379 scsi_rescan_device(&sdev->sdev_gendev);
381 scsi_device_put(sdev);
384 static void virtscsi_handle_event(struct work_struct *work)
386 struct virtio_scsi_event_node *event_node =
387 container_of(work, struct virtio_scsi_event_node, work);
388 struct virtio_scsi *vscsi = event_node->vscsi;
389 struct virtio_scsi_event *event = &event_node->event;
391 if (event->event & VIRTIO_SCSI_T_EVENTS_MISSED) {
392 event->event &= ~VIRTIO_SCSI_T_EVENTS_MISSED;
393 scsi_scan_host(virtio_scsi_host(vscsi->vdev));
396 switch (event->event) {
397 case VIRTIO_SCSI_T_NO_EVENT:
398 break;
399 case VIRTIO_SCSI_T_TRANSPORT_RESET:
400 virtscsi_handle_transport_reset(vscsi, event);
401 break;
402 case VIRTIO_SCSI_T_PARAM_CHANGE:
403 virtscsi_handle_param_change(vscsi, event);
404 break;
405 default:
406 pr_err("Unsupport virtio scsi event %x\n", event->event);
408 virtscsi_kick_event(vscsi, event_node);
411 static void virtscsi_complete_event(struct virtio_scsi *vscsi, void *buf)
413 struct virtio_scsi_event_node *event_node = buf;
415 INIT_WORK(&event_node->work, virtscsi_handle_event);
416 schedule_work(&event_node->work);
419 static void virtscsi_event_done(struct virtqueue *vq)
421 struct Scsi_Host *sh = virtio_scsi_host(vq->vdev);
422 struct virtio_scsi *vscsi = shost_priv(sh);
424 virtscsi_vq_done(vscsi, &vscsi->event_vq, virtscsi_complete_event);
428 * virtscsi_add_cmd - add a virtio_scsi_cmd to a virtqueue
429 * @vq : the struct virtqueue we're talking about
430 * @cmd : command structure
431 * @req_size : size of the request buffer
432 * @resp_size : size of the response buffer
433 * @gfp : flags to use for memory allocations
435 static int virtscsi_add_cmd(struct virtqueue *vq,
436 struct virtio_scsi_cmd *cmd,
437 size_t req_size, size_t resp_size, gfp_t gfp)
439 struct scsi_cmnd *sc = cmd->sc;
440 struct scatterlist *sgs[4], req, resp;
441 struct sg_table *out, *in;
442 unsigned out_num = 0, in_num = 0;
444 out = in = NULL;
446 if (sc && sc->sc_data_direction != DMA_NONE) {
447 if (sc->sc_data_direction != DMA_FROM_DEVICE)
448 out = &scsi_out(sc)->table;
449 if (sc->sc_data_direction != DMA_TO_DEVICE)
450 in = &scsi_in(sc)->table;
453 /* Request header. */
454 sg_init_one(&req, &cmd->req, req_size);
455 sgs[out_num++] = &req;
457 /* Data-out buffer. */
458 if (out)
459 sgs[out_num++] = out->sgl;
461 /* Response header. */
462 sg_init_one(&resp, &cmd->resp, resp_size);
463 sgs[out_num + in_num++] = &resp;
465 /* Data-in buffer */
466 if (in)
467 sgs[out_num + in_num++] = in->sgl;
469 return virtqueue_add_sgs(vq, sgs, out_num, in_num, cmd, gfp);
472 static int virtscsi_kick_cmd(struct virtio_scsi_vq *vq,
473 struct virtio_scsi_cmd *cmd,
474 size_t req_size, size_t resp_size, gfp_t gfp)
476 unsigned long flags;
477 int err;
478 bool needs_kick = false;
480 spin_lock_irqsave(&vq->vq_lock, flags);
481 err = virtscsi_add_cmd(vq->vq, cmd, req_size, resp_size, gfp);
482 if (!err)
483 needs_kick = virtqueue_kick_prepare(vq->vq);
485 spin_unlock_irqrestore(&vq->vq_lock, flags);
487 if (needs_kick)
488 virtqueue_notify(vq->vq);
489 return err;
492 static int virtscsi_queuecommand(struct virtio_scsi *vscsi,
493 struct virtio_scsi_vq *req_vq,
494 struct scsi_cmnd *sc)
496 struct virtio_scsi_cmd *cmd;
497 int ret;
499 struct Scsi_Host *shost = virtio_scsi_host(vscsi->vdev);
500 BUG_ON(scsi_sg_count(sc) > shost->sg_tablesize);
502 /* TODO: check feature bit and fail if unsupported? */
503 BUG_ON(sc->sc_data_direction == DMA_BIDIRECTIONAL);
505 dev_dbg(&sc->device->sdev_gendev,
506 "cmd %p CDB: %#02x\n", sc, sc->cmnd[0]);
508 ret = SCSI_MLQUEUE_HOST_BUSY;
509 cmd = mempool_alloc(virtscsi_cmd_pool, GFP_ATOMIC);
510 if (!cmd)
511 goto out;
513 memset(cmd, 0, sizeof(*cmd));
514 cmd->sc = sc;
515 cmd->req.cmd = (struct virtio_scsi_cmd_req){
516 .lun[0] = 1,
517 .lun[1] = sc->device->id,
518 .lun[2] = (sc->device->lun >> 8) | 0x40,
519 .lun[3] = sc->device->lun & 0xff,
520 .tag = (unsigned long)sc,
521 .task_attr = VIRTIO_SCSI_S_SIMPLE,
522 .prio = 0,
523 .crn = 0,
526 BUG_ON(sc->cmd_len > VIRTIO_SCSI_CDB_SIZE);
527 memcpy(cmd->req.cmd.cdb, sc->cmnd, sc->cmd_len);
529 if (virtscsi_kick_cmd(req_vq, cmd,
530 sizeof cmd->req.cmd, sizeof cmd->resp.cmd,
531 GFP_ATOMIC) == 0)
532 ret = 0;
533 else
534 mempool_free(cmd, virtscsi_cmd_pool);
536 out:
537 return ret;
540 static int virtscsi_queuecommand_single(struct Scsi_Host *sh,
541 struct scsi_cmnd *sc)
543 struct virtio_scsi *vscsi = shost_priv(sh);
544 struct virtio_scsi_target_state *tgt =
545 scsi_target(sc->device)->hostdata;
547 atomic_inc(&tgt->reqs);
548 return virtscsi_queuecommand(vscsi, &vscsi->req_vqs[0], sc);
551 static struct virtio_scsi_vq *virtscsi_pick_vq(struct virtio_scsi *vscsi,
552 struct virtio_scsi_target_state *tgt)
554 struct virtio_scsi_vq *vq;
555 unsigned long flags;
556 u32 queue_num;
558 spin_lock_irqsave(&tgt->tgt_lock, flags);
561 * The memory barrier after atomic_inc_return matches
562 * the smp_read_barrier_depends() in virtscsi_req_done.
564 if (atomic_inc_return(&tgt->reqs) > 1)
565 vq = ACCESS_ONCE(tgt->req_vq);
566 else {
567 queue_num = smp_processor_id();
568 while (unlikely(queue_num >= vscsi->num_queues))
569 queue_num -= vscsi->num_queues;
571 tgt->req_vq = vq = &vscsi->req_vqs[queue_num];
574 spin_unlock_irqrestore(&tgt->tgt_lock, flags);
575 return vq;
578 static int virtscsi_queuecommand_multi(struct Scsi_Host *sh,
579 struct scsi_cmnd *sc)
581 struct virtio_scsi *vscsi = shost_priv(sh);
582 struct virtio_scsi_target_state *tgt =
583 scsi_target(sc->device)->hostdata;
584 struct virtio_scsi_vq *req_vq = virtscsi_pick_vq(vscsi, tgt);
586 return virtscsi_queuecommand(vscsi, req_vq, sc);
589 static int virtscsi_tmf(struct virtio_scsi *vscsi, struct virtio_scsi_cmd *cmd)
591 DECLARE_COMPLETION_ONSTACK(comp);
592 int ret = FAILED;
594 cmd->comp = &comp;
595 if (virtscsi_kick_cmd(&vscsi->ctrl_vq, cmd,
596 sizeof cmd->req.tmf, sizeof cmd->resp.tmf,
597 GFP_NOIO) < 0)
598 goto out;
600 wait_for_completion(&comp);
601 if (cmd->resp.tmf.response == VIRTIO_SCSI_S_OK ||
602 cmd->resp.tmf.response == VIRTIO_SCSI_S_FUNCTION_SUCCEEDED)
603 ret = SUCCESS;
605 out:
606 mempool_free(cmd, virtscsi_cmd_pool);
607 return ret;
610 static int virtscsi_device_reset(struct scsi_cmnd *sc)
612 struct virtio_scsi *vscsi = shost_priv(sc->device->host);
613 struct virtio_scsi_cmd *cmd;
615 sdev_printk(KERN_INFO, sc->device, "device reset\n");
616 cmd = mempool_alloc(virtscsi_cmd_pool, GFP_NOIO);
617 if (!cmd)
618 return FAILED;
620 memset(cmd, 0, sizeof(*cmd));
621 cmd->sc = sc;
622 cmd->req.tmf = (struct virtio_scsi_ctrl_tmf_req){
623 .type = VIRTIO_SCSI_T_TMF,
624 .subtype = VIRTIO_SCSI_T_TMF_LOGICAL_UNIT_RESET,
625 .lun[0] = 1,
626 .lun[1] = sc->device->id,
627 .lun[2] = (sc->device->lun >> 8) | 0x40,
628 .lun[3] = sc->device->lun & 0xff,
630 return virtscsi_tmf(vscsi, cmd);
633 static int virtscsi_abort(struct scsi_cmnd *sc)
635 struct virtio_scsi *vscsi = shost_priv(sc->device->host);
636 struct virtio_scsi_cmd *cmd;
638 scmd_printk(KERN_INFO, sc, "abort\n");
639 cmd = mempool_alloc(virtscsi_cmd_pool, GFP_NOIO);
640 if (!cmd)
641 return FAILED;
643 memset(cmd, 0, sizeof(*cmd));
644 cmd->sc = sc;
645 cmd->req.tmf = (struct virtio_scsi_ctrl_tmf_req){
646 .type = VIRTIO_SCSI_T_TMF,
647 .subtype = VIRTIO_SCSI_T_TMF_ABORT_TASK,
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 .tag = (unsigned long)sc,
654 return virtscsi_tmf(vscsi, cmd);
657 static int virtscsi_target_alloc(struct scsi_target *starget)
659 struct virtio_scsi_target_state *tgt =
660 kmalloc(sizeof(*tgt), GFP_KERNEL);
661 if (!tgt)
662 return -ENOMEM;
664 spin_lock_init(&tgt->tgt_lock);
665 atomic_set(&tgt->reqs, 0);
666 tgt->req_vq = NULL;
668 starget->hostdata = tgt;
669 return 0;
672 static void virtscsi_target_destroy(struct scsi_target *starget)
674 struct virtio_scsi_target_state *tgt = starget->hostdata;
675 kfree(tgt);
678 static struct scsi_host_template virtscsi_host_template_single = {
679 .module = THIS_MODULE,
680 .name = "Virtio SCSI HBA",
681 .proc_name = "virtio_scsi",
682 .this_id = -1,
683 .queuecommand = virtscsi_queuecommand_single,
684 .eh_abort_handler = virtscsi_abort,
685 .eh_device_reset_handler = virtscsi_device_reset,
687 .can_queue = 1024,
688 .dma_boundary = UINT_MAX,
689 .use_clustering = ENABLE_CLUSTERING,
690 .target_alloc = virtscsi_target_alloc,
691 .target_destroy = virtscsi_target_destroy,
694 static struct scsi_host_template virtscsi_host_template_multi = {
695 .module = THIS_MODULE,
696 .name = "Virtio SCSI HBA",
697 .proc_name = "virtio_scsi",
698 .this_id = -1,
699 .queuecommand = virtscsi_queuecommand_multi,
700 .eh_abort_handler = virtscsi_abort,
701 .eh_device_reset_handler = virtscsi_device_reset,
703 .can_queue = 1024,
704 .dma_boundary = UINT_MAX,
705 .use_clustering = ENABLE_CLUSTERING,
706 .target_alloc = virtscsi_target_alloc,
707 .target_destroy = virtscsi_target_destroy,
710 #define virtscsi_config_get(vdev, fld) \
711 ({ \
712 typeof(((struct virtio_scsi_config *)0)->fld) __val; \
713 vdev->config->get(vdev, \
714 offsetof(struct virtio_scsi_config, fld), \
715 &__val, sizeof(__val)); \
716 __val; \
719 #define virtscsi_config_set(vdev, fld, val) \
720 (void)({ \
721 typeof(((struct virtio_scsi_config *)0)->fld) __val = (val); \
722 vdev->config->set(vdev, \
723 offsetof(struct virtio_scsi_config, fld), \
724 &__val, sizeof(__val)); \
727 static void __virtscsi_set_affinity(struct virtio_scsi *vscsi, bool affinity)
729 int i;
730 int cpu;
732 /* In multiqueue mode, when the number of cpu is equal
733 * to the number of request queues, we let the qeueues
734 * to be private to one cpu by setting the affinity hint
735 * to eliminate the contention.
737 if ((vscsi->num_queues == 1 ||
738 vscsi->num_queues != num_online_cpus()) && affinity) {
739 if (vscsi->affinity_hint_set)
740 affinity = false;
741 else
742 return;
745 if (affinity) {
746 i = 0;
747 for_each_online_cpu(cpu) {
748 virtqueue_set_affinity(vscsi->req_vqs[i].vq, cpu);
749 i++;
752 vscsi->affinity_hint_set = true;
753 } else {
754 for (i = 0; i < vscsi->num_queues - VIRTIO_SCSI_VQ_BASE; i++)
755 virtqueue_set_affinity(vscsi->req_vqs[i].vq, -1);
757 vscsi->affinity_hint_set = false;
761 static void virtscsi_set_affinity(struct virtio_scsi *vscsi, bool affinity)
763 get_online_cpus();
764 __virtscsi_set_affinity(vscsi, affinity);
765 put_online_cpus();
768 static int virtscsi_cpu_callback(struct notifier_block *nfb,
769 unsigned long action, void *hcpu)
771 struct virtio_scsi *vscsi = container_of(nfb, struct virtio_scsi, nb);
772 switch(action) {
773 case CPU_ONLINE:
774 case CPU_ONLINE_FROZEN:
775 case CPU_DEAD:
776 case CPU_DEAD_FROZEN:
777 __virtscsi_set_affinity(vscsi, true);
778 break;
779 default:
780 break;
782 return NOTIFY_OK;
785 static void virtscsi_init_vq(struct virtio_scsi_vq *virtscsi_vq,
786 struct virtqueue *vq)
788 spin_lock_init(&virtscsi_vq->vq_lock);
789 virtscsi_vq->vq = vq;
792 static void virtscsi_scan(struct virtio_device *vdev)
794 struct Scsi_Host *shost = (struct Scsi_Host *)vdev->priv;
796 scsi_scan_host(shost);
799 static void virtscsi_remove_vqs(struct virtio_device *vdev)
801 struct Scsi_Host *sh = virtio_scsi_host(vdev);
802 struct virtio_scsi *vscsi = shost_priv(sh);
804 virtscsi_set_affinity(vscsi, false);
806 /* Stop all the virtqueues. */
807 vdev->config->reset(vdev);
809 vdev->config->del_vqs(vdev);
812 static int virtscsi_init(struct virtio_device *vdev,
813 struct virtio_scsi *vscsi)
815 int err;
816 u32 i;
817 u32 num_vqs;
818 vq_callback_t **callbacks;
819 const char **names;
820 struct virtqueue **vqs;
822 num_vqs = vscsi->num_queues + VIRTIO_SCSI_VQ_BASE;
823 vqs = kmalloc(num_vqs * sizeof(struct virtqueue *), GFP_KERNEL);
824 callbacks = kmalloc(num_vqs * sizeof(vq_callback_t *), GFP_KERNEL);
825 names = kmalloc(num_vqs * sizeof(char *), GFP_KERNEL);
827 if (!callbacks || !vqs || !names) {
828 err = -ENOMEM;
829 goto out;
832 callbacks[0] = virtscsi_ctrl_done;
833 callbacks[1] = virtscsi_event_done;
834 names[0] = "control";
835 names[1] = "event";
836 for (i = VIRTIO_SCSI_VQ_BASE; i < num_vqs; i++) {
837 callbacks[i] = virtscsi_req_done;
838 names[i] = "request";
841 /* Discover virtqueues and write information to configuration. */
842 err = vdev->config->find_vqs(vdev, num_vqs, vqs, callbacks, names);
843 if (err)
844 goto out;
846 virtscsi_init_vq(&vscsi->ctrl_vq, vqs[0]);
847 virtscsi_init_vq(&vscsi->event_vq, vqs[1]);
848 for (i = VIRTIO_SCSI_VQ_BASE; i < num_vqs; i++)
849 virtscsi_init_vq(&vscsi->req_vqs[i - VIRTIO_SCSI_VQ_BASE],
850 vqs[i]);
852 virtscsi_set_affinity(vscsi, true);
854 virtscsi_config_set(vdev, cdb_size, VIRTIO_SCSI_CDB_SIZE);
855 virtscsi_config_set(vdev, sense_size, VIRTIO_SCSI_SENSE_SIZE);
857 if (virtio_has_feature(vdev, VIRTIO_SCSI_F_HOTPLUG))
858 virtscsi_kick_event_all(vscsi);
860 err = 0;
862 out:
863 kfree(names);
864 kfree(callbacks);
865 kfree(vqs);
866 if (err)
867 virtscsi_remove_vqs(vdev);
868 return err;
871 static int virtscsi_probe(struct virtio_device *vdev)
873 struct Scsi_Host *shost;
874 struct virtio_scsi *vscsi;
875 int err;
876 u32 sg_elems, num_targets;
877 u32 cmd_per_lun;
878 u32 num_queues;
879 struct scsi_host_template *hostt;
881 /* We need to know how many queues before we allocate. */
882 num_queues = virtscsi_config_get(vdev, num_queues) ? : 1;
884 num_targets = virtscsi_config_get(vdev, max_target) + 1;
886 if (num_queues == 1)
887 hostt = &virtscsi_host_template_single;
888 else
889 hostt = &virtscsi_host_template_multi;
891 shost = scsi_host_alloc(hostt,
892 sizeof(*vscsi) + sizeof(vscsi->req_vqs[0]) * num_queues);
893 if (!shost)
894 return -ENOMEM;
896 sg_elems = virtscsi_config_get(vdev, seg_max) ?: 1;
897 shost->sg_tablesize = sg_elems;
898 vscsi = shost_priv(shost);
899 vscsi->vdev = vdev;
900 vscsi->num_queues = num_queues;
901 vdev->priv = shost;
903 err = virtscsi_init(vdev, vscsi);
904 if (err)
905 goto virtscsi_init_failed;
907 vscsi->nb.notifier_call = &virtscsi_cpu_callback;
908 err = register_hotcpu_notifier(&vscsi->nb);
909 if (err) {
910 pr_err("registering cpu notifier failed\n");
911 goto scsi_add_host_failed;
914 cmd_per_lun = virtscsi_config_get(vdev, cmd_per_lun) ?: 1;
915 shost->cmd_per_lun = min_t(u32, cmd_per_lun, shost->can_queue);
916 shost->max_sectors = virtscsi_config_get(vdev, max_sectors) ?: 0xFFFF;
918 /* LUNs > 256 are reported with format 1, so they go in the range
919 * 16640-32767.
921 shost->max_lun = virtscsi_config_get(vdev, max_lun) + 1 + 0x4000;
922 shost->max_id = num_targets;
923 shost->max_channel = 0;
924 shost->max_cmd_len = VIRTIO_SCSI_CDB_SIZE;
925 err = scsi_add_host(shost, &vdev->dev);
926 if (err)
927 goto scsi_add_host_failed;
929 * scsi_scan_host() happens in virtscsi_scan() via virtio_driver->scan()
930 * after VIRTIO_CONFIG_S_DRIVER_OK has been set..
932 return 0;
934 scsi_add_host_failed:
935 vdev->config->del_vqs(vdev);
936 virtscsi_init_failed:
937 scsi_host_put(shost);
938 return err;
941 static void virtscsi_remove(struct virtio_device *vdev)
943 struct Scsi_Host *shost = virtio_scsi_host(vdev);
944 struct virtio_scsi *vscsi = shost_priv(shost);
946 if (virtio_has_feature(vdev, VIRTIO_SCSI_F_HOTPLUG))
947 virtscsi_cancel_event_work(vscsi);
949 scsi_remove_host(shost);
951 unregister_hotcpu_notifier(&vscsi->nb);
953 virtscsi_remove_vqs(vdev);
954 scsi_host_put(shost);
957 #ifdef CONFIG_PM
958 static int virtscsi_freeze(struct virtio_device *vdev)
960 virtscsi_remove_vqs(vdev);
961 return 0;
964 static int virtscsi_restore(struct virtio_device *vdev)
966 struct Scsi_Host *sh = virtio_scsi_host(vdev);
967 struct virtio_scsi *vscsi = shost_priv(sh);
969 return virtscsi_init(vdev, vscsi);
971 #endif
973 static struct virtio_device_id id_table[] = {
974 { VIRTIO_ID_SCSI, VIRTIO_DEV_ANY_ID },
975 { 0 },
978 static unsigned int features[] = {
979 VIRTIO_SCSI_F_HOTPLUG,
980 VIRTIO_SCSI_F_CHANGE,
983 static struct virtio_driver virtio_scsi_driver = {
984 .feature_table = features,
985 .feature_table_size = ARRAY_SIZE(features),
986 .driver.name = KBUILD_MODNAME,
987 .driver.owner = THIS_MODULE,
988 .id_table = id_table,
989 .probe = virtscsi_probe,
990 .scan = virtscsi_scan,
991 #ifdef CONFIG_PM
992 .freeze = virtscsi_freeze,
993 .restore = virtscsi_restore,
994 #endif
995 .remove = virtscsi_remove,
998 static int __init init(void)
1000 int ret = -ENOMEM;
1002 virtscsi_cmd_cache = KMEM_CACHE(virtio_scsi_cmd, 0);
1003 if (!virtscsi_cmd_cache) {
1004 pr_err("kmem_cache_create() for virtscsi_cmd_cache failed\n");
1005 goto error;
1009 virtscsi_cmd_pool =
1010 mempool_create_slab_pool(VIRTIO_SCSI_MEMPOOL_SZ,
1011 virtscsi_cmd_cache);
1012 if (!virtscsi_cmd_pool) {
1013 pr_err("mempool_create() for virtscsi_cmd_pool failed\n");
1014 goto error;
1016 ret = register_virtio_driver(&virtio_scsi_driver);
1017 if (ret < 0)
1018 goto error;
1020 return 0;
1022 error:
1023 if (virtscsi_cmd_pool) {
1024 mempool_destroy(virtscsi_cmd_pool);
1025 virtscsi_cmd_pool = NULL;
1027 if (virtscsi_cmd_cache) {
1028 kmem_cache_destroy(virtscsi_cmd_cache);
1029 virtscsi_cmd_cache = NULL;
1031 return ret;
1034 static void __exit fini(void)
1036 unregister_virtio_driver(&virtio_scsi_driver);
1037 mempool_destroy(virtscsi_cmd_pool);
1038 kmem_cache_destroy(virtscsi_cmd_cache);
1040 module_init(init);
1041 module_exit(fini);
1043 MODULE_DEVICE_TABLE(virtio, id_table);
1044 MODULE_DESCRIPTION("Virtio SCSI HBA driver");
1045 MODULE_LICENSE("GPL");