2 * Virtio SCSI HBA driver
4 * Copyright IBM Corp. 2010
5 * Copyright Red Hat, Inc. 2011
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
{
37 struct completion
*comp
;
39 struct virtio_scsi_cmd_req cmd
;
40 struct virtio_scsi_ctrl_tmf_req tmf
;
41 struct virtio_scsi_ctrl_an_req an
;
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
;
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
{
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
90 struct virtio_scsi_target_state
{
91 /* This spinlock never held at the same time as vq_lock. */
94 /* Count of outstanding requests. */
97 /* Currently active virtqueue for requests sent to this target. */
98 struct virtio_scsi_vq
*req_vq
;
101 /* Driver instance state */
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
];
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
)
129 static void virtscsi_compute_resid(struct scsi_cmnd
*sc
, u32 resid
)
134 if (!scsi_bidi_cmnd(sc
)) {
135 scsi_set_resid(sc
, resid
);
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
);
166 case VIRTIO_SCSI_S_OVERRUN
:
167 set_host_byte(sc
, DID_ERROR
);
169 case VIRTIO_SCSI_S_ABORTED
:
170 set_host_byte(sc
, DID_ABORT
);
172 case VIRTIO_SCSI_S_BAD_TARGET
:
173 set_host_byte(sc
, DID_BAD_TARGET
);
175 case VIRTIO_SCSI_S_RESET
:
176 set_host_byte(sc
, DID_RESET
);
178 case VIRTIO_SCSI_S_BUSY
:
179 set_host_byte(sc
, DID_BUS_BUSY
);
181 case VIRTIO_SCSI_S_TRANSPORT_FAILURE
:
182 set_host_byte(sc
, DID_TRANSPORT_DISRUPTED
);
184 case VIRTIO_SCSI_S_TARGET_FAILURE
:
185 set_host_byte(sc
, DID_TARGET_FAILURE
);
187 case VIRTIO_SCSI_S_NEXUS_FAILURE
:
188 set_host_byte(sc
, DID_NEXUS_FAILURE
);
191 scmd_printk(KERN_WARNING
, sc
, "Unknown response %d",
194 case VIRTIO_SCSI_S_FAILURE
:
195 set_host_byte(sc
, DID_ERROR
);
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
));
204 set_driver_byte(sc
, DRIVER_SENSE
);
207 mempool_free(cmd
, virtscsi_cmd_pool
);
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
))
220 struct virtqueue
*vq
= virtscsi_vq
->vq
;
222 spin_lock_irqsave(&virtscsi_vq
->vq_lock
, flags
);
224 virtqueue_disable_cb(vq
);
225 while ((buf
= virtqueue_get_buf(vq
, &len
)) != NULL
)
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.
244 * CPU #0 virtscsi_queuecommand_multi (CPU #1)
245 * ------------------------------------------------------------
248 * read reqs (reqs = 1)
249 * write reqs (reqs = 0)
250 * increment reqs (reqs = 1)
253 * Possible reordering without barriers:
255 * CPU #0 virtscsi_queuecommand_multi (CPU #1)
256 * ------------------------------------------------------------
258 * read reqs (reqs = 1)
259 * write reqs (reqs = 0)
260 * increment reqs (reqs = 1)
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_poll_requests(struct virtio_scsi
*vscsi
)
277 num_vqs
= vscsi
->num_queues
;
278 for (i
= 0; i
< num_vqs
; i
++)
279 virtscsi_vq_done(vscsi
, &vscsi
->req_vqs
[i
],
280 virtscsi_complete_cmd
);
283 static void virtscsi_complete_free(struct virtio_scsi
*vscsi
, void *buf
)
285 struct virtio_scsi_cmd
*cmd
= buf
;
288 complete_all(cmd
->comp
);
290 mempool_free(cmd
, virtscsi_cmd_pool
);
293 static void virtscsi_ctrl_done(struct virtqueue
*vq
)
295 struct Scsi_Host
*sh
= virtio_scsi_host(vq
->vdev
);
296 struct virtio_scsi
*vscsi
= shost_priv(sh
);
298 virtscsi_vq_done(vscsi
, &vscsi
->ctrl_vq
, virtscsi_complete_free
);
301 static void virtscsi_handle_event(struct work_struct
*work
);
303 static int virtscsi_kick_event(struct virtio_scsi
*vscsi
,
304 struct virtio_scsi_event_node
*event_node
)
307 struct scatterlist sg
;
310 INIT_WORK(&event_node
->work
, virtscsi_handle_event
);
311 sg_init_one(&sg
, &event_node
->event
, sizeof(struct virtio_scsi_event
));
313 spin_lock_irqsave(&vscsi
->event_vq
.vq_lock
, flags
);
315 err
= virtqueue_add_inbuf(vscsi
->event_vq
.vq
, &sg
, 1, event_node
,
318 virtqueue_kick(vscsi
->event_vq
.vq
);
320 spin_unlock_irqrestore(&vscsi
->event_vq
.vq_lock
, flags
);
325 static int virtscsi_kick_event_all(struct virtio_scsi
*vscsi
)
329 for (i
= 0; i
< VIRTIO_SCSI_EVENT_LEN
; i
++) {
330 vscsi
->event_list
[i
].vscsi
= vscsi
;
331 virtscsi_kick_event(vscsi
, &vscsi
->event_list
[i
]);
337 static void virtscsi_cancel_event_work(struct virtio_scsi
*vscsi
)
341 for (i
= 0; i
< VIRTIO_SCSI_EVENT_LEN
; i
++)
342 cancel_work_sync(&vscsi
->event_list
[i
].work
);
345 static void virtscsi_handle_transport_reset(struct virtio_scsi
*vscsi
,
346 struct virtio_scsi_event
*event
)
348 struct scsi_device
*sdev
;
349 struct Scsi_Host
*shost
= virtio_scsi_host(vscsi
->vdev
);
350 unsigned int target
= event
->lun
[1];
351 unsigned int lun
= (event
->lun
[2] << 8) | event
->lun
[3];
353 switch (event
->reason
) {
354 case VIRTIO_SCSI_EVT_RESET_RESCAN
:
355 scsi_add_device(shost
, 0, target
, lun
);
357 case VIRTIO_SCSI_EVT_RESET_REMOVED
:
358 sdev
= scsi_device_lookup(shost
, 0, target
, lun
);
360 scsi_remove_device(sdev
);
361 scsi_device_put(sdev
);
363 pr_err("SCSI device %d 0 %d %d not found\n",
364 shost
->host_no
, target
, lun
);
368 pr_info("Unsupport virtio scsi event reason %x\n", event
->reason
);
372 static void virtscsi_handle_param_change(struct virtio_scsi
*vscsi
,
373 struct virtio_scsi_event
*event
)
375 struct scsi_device
*sdev
;
376 struct Scsi_Host
*shost
= virtio_scsi_host(vscsi
->vdev
);
377 unsigned int target
= event
->lun
[1];
378 unsigned int lun
= (event
->lun
[2] << 8) | event
->lun
[3];
379 u8 asc
= event
->reason
& 255;
380 u8 ascq
= event
->reason
>> 8;
382 sdev
= scsi_device_lookup(shost
, 0, target
, lun
);
384 pr_err("SCSI device %d 0 %d %d not found\n",
385 shost
->host_no
, target
, lun
);
389 /* Handle "Parameters changed", "Mode parameters changed", and
390 "Capacity data has changed". */
391 if (asc
== 0x2a && (ascq
== 0x00 || ascq
== 0x01 || ascq
== 0x09))
392 scsi_rescan_device(&sdev
->sdev_gendev
);
394 scsi_device_put(sdev
);
397 static void virtscsi_handle_event(struct work_struct
*work
)
399 struct virtio_scsi_event_node
*event_node
=
400 container_of(work
, struct virtio_scsi_event_node
, work
);
401 struct virtio_scsi
*vscsi
= event_node
->vscsi
;
402 struct virtio_scsi_event
*event
= &event_node
->event
;
404 if (event
->event
& VIRTIO_SCSI_T_EVENTS_MISSED
) {
405 event
->event
&= ~VIRTIO_SCSI_T_EVENTS_MISSED
;
406 scsi_scan_host(virtio_scsi_host(vscsi
->vdev
));
409 switch (event
->event
) {
410 case VIRTIO_SCSI_T_NO_EVENT
:
412 case VIRTIO_SCSI_T_TRANSPORT_RESET
:
413 virtscsi_handle_transport_reset(vscsi
, event
);
415 case VIRTIO_SCSI_T_PARAM_CHANGE
:
416 virtscsi_handle_param_change(vscsi
, event
);
419 pr_err("Unsupport virtio scsi event %x\n", event
->event
);
421 virtscsi_kick_event(vscsi
, event_node
);
424 static void virtscsi_complete_event(struct virtio_scsi
*vscsi
, void *buf
)
426 struct virtio_scsi_event_node
*event_node
= buf
;
428 schedule_work(&event_node
->work
);
431 static void virtscsi_event_done(struct virtqueue
*vq
)
433 struct Scsi_Host
*sh
= virtio_scsi_host(vq
->vdev
);
434 struct virtio_scsi
*vscsi
= shost_priv(sh
);
436 virtscsi_vq_done(vscsi
, &vscsi
->event_vq
, virtscsi_complete_event
);
440 * virtscsi_add_cmd - add a virtio_scsi_cmd to a virtqueue
441 * @vq : the struct virtqueue we're talking about
442 * @cmd : command structure
443 * @req_size : size of the request buffer
444 * @resp_size : size of the response buffer
445 * @gfp : flags to use for memory allocations
447 static int virtscsi_add_cmd(struct virtqueue
*vq
,
448 struct virtio_scsi_cmd
*cmd
,
449 size_t req_size
, size_t resp_size
, gfp_t gfp
)
451 struct scsi_cmnd
*sc
= cmd
->sc
;
452 struct scatterlist
*sgs
[4], req
, resp
;
453 struct sg_table
*out
, *in
;
454 unsigned out_num
= 0, in_num
= 0;
458 if (sc
&& sc
->sc_data_direction
!= DMA_NONE
) {
459 if (sc
->sc_data_direction
!= DMA_FROM_DEVICE
)
460 out
= &scsi_out(sc
)->table
;
461 if (sc
->sc_data_direction
!= DMA_TO_DEVICE
)
462 in
= &scsi_in(sc
)->table
;
465 /* Request header. */
466 sg_init_one(&req
, &cmd
->req
, req_size
);
467 sgs
[out_num
++] = &req
;
469 /* Data-out buffer. */
471 sgs
[out_num
++] = out
->sgl
;
473 /* Response header. */
474 sg_init_one(&resp
, &cmd
->resp
, resp_size
);
475 sgs
[out_num
+ in_num
++] = &resp
;
479 sgs
[out_num
+ in_num
++] = in
->sgl
;
481 return virtqueue_add_sgs(vq
, sgs
, out_num
, in_num
, cmd
, gfp
);
484 static int virtscsi_kick_cmd(struct virtio_scsi_vq
*vq
,
485 struct virtio_scsi_cmd
*cmd
,
486 size_t req_size
, size_t resp_size
, gfp_t gfp
)
490 bool needs_kick
= false;
492 spin_lock_irqsave(&vq
->vq_lock
, flags
);
493 err
= virtscsi_add_cmd(vq
->vq
, cmd
, req_size
, resp_size
, gfp
);
495 needs_kick
= virtqueue_kick_prepare(vq
->vq
);
497 spin_unlock_irqrestore(&vq
->vq_lock
, flags
);
500 virtqueue_notify(vq
->vq
);
504 static int virtscsi_queuecommand(struct virtio_scsi
*vscsi
,
505 struct virtio_scsi_vq
*req_vq
,
506 struct scsi_cmnd
*sc
)
508 struct virtio_scsi_cmd
*cmd
;
511 struct Scsi_Host
*shost
= virtio_scsi_host(vscsi
->vdev
);
512 BUG_ON(scsi_sg_count(sc
) > shost
->sg_tablesize
);
514 /* TODO: check feature bit and fail if unsupported? */
515 BUG_ON(sc
->sc_data_direction
== DMA_BIDIRECTIONAL
);
517 dev_dbg(&sc
->device
->sdev_gendev
,
518 "cmd %p CDB: %#02x\n", sc
, sc
->cmnd
[0]);
520 ret
= SCSI_MLQUEUE_HOST_BUSY
;
521 cmd
= mempool_alloc(virtscsi_cmd_pool
, GFP_ATOMIC
);
525 memset(cmd
, 0, sizeof(*cmd
));
527 cmd
->req
.cmd
= (struct virtio_scsi_cmd_req
){
529 .lun
[1] = sc
->device
->id
,
530 .lun
[2] = (sc
->device
->lun
>> 8) | 0x40,
531 .lun
[3] = sc
->device
->lun
& 0xff,
532 .tag
= (unsigned long)sc
,
533 .task_attr
= VIRTIO_SCSI_S_SIMPLE
,
538 BUG_ON(sc
->cmd_len
> VIRTIO_SCSI_CDB_SIZE
);
539 memcpy(cmd
->req
.cmd
.cdb
, sc
->cmnd
, sc
->cmd_len
);
541 if (virtscsi_kick_cmd(req_vq
, cmd
,
542 sizeof cmd
->req
.cmd
, sizeof cmd
->resp
.cmd
,
546 mempool_free(cmd
, virtscsi_cmd_pool
);
552 static int virtscsi_queuecommand_single(struct Scsi_Host
*sh
,
553 struct scsi_cmnd
*sc
)
555 struct virtio_scsi
*vscsi
= shost_priv(sh
);
556 struct virtio_scsi_target_state
*tgt
=
557 scsi_target(sc
->device
)->hostdata
;
559 atomic_inc(&tgt
->reqs
);
560 return virtscsi_queuecommand(vscsi
, &vscsi
->req_vqs
[0], sc
);
563 static struct virtio_scsi_vq
*virtscsi_pick_vq(struct virtio_scsi
*vscsi
,
564 struct virtio_scsi_target_state
*tgt
)
566 struct virtio_scsi_vq
*vq
;
570 spin_lock_irqsave(&tgt
->tgt_lock
, flags
);
573 * The memory barrier after atomic_inc_return matches
574 * the smp_read_barrier_depends() in virtscsi_req_done.
576 if (atomic_inc_return(&tgt
->reqs
) > 1)
577 vq
= ACCESS_ONCE(tgt
->req_vq
);
579 queue_num
= smp_processor_id();
580 while (unlikely(queue_num
>= vscsi
->num_queues
))
581 queue_num
-= vscsi
->num_queues
;
583 tgt
->req_vq
= vq
= &vscsi
->req_vqs
[queue_num
];
586 spin_unlock_irqrestore(&tgt
->tgt_lock
, flags
);
590 static int virtscsi_queuecommand_multi(struct Scsi_Host
*sh
,
591 struct scsi_cmnd
*sc
)
593 struct virtio_scsi
*vscsi
= shost_priv(sh
);
594 struct virtio_scsi_target_state
*tgt
=
595 scsi_target(sc
->device
)->hostdata
;
596 struct virtio_scsi_vq
*req_vq
= virtscsi_pick_vq(vscsi
, tgt
);
598 return virtscsi_queuecommand(vscsi
, req_vq
, sc
);
601 static int virtscsi_tmf(struct virtio_scsi
*vscsi
, struct virtio_scsi_cmd
*cmd
)
603 DECLARE_COMPLETION_ONSTACK(comp
);
607 if (virtscsi_kick_cmd(&vscsi
->ctrl_vq
, cmd
,
608 sizeof cmd
->req
.tmf
, sizeof cmd
->resp
.tmf
,
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
)
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
623 * In the abort case, sc->scsi_done will do nothing, because
624 * the block layer must have detected a timeout and as a result
625 * REQ_ATOM_COMPLETE has been set.
627 virtscsi_poll_requests(vscsi
);
630 mempool_free(cmd
, virtscsi_cmd_pool
);
634 static int virtscsi_device_reset(struct scsi_cmnd
*sc
)
636 struct virtio_scsi
*vscsi
= shost_priv(sc
->device
->host
);
637 struct virtio_scsi_cmd
*cmd
;
639 sdev_printk(KERN_INFO
, sc
->device
, "device reset\n");
640 cmd
= mempool_alloc(virtscsi_cmd_pool
, GFP_NOIO
);
644 memset(cmd
, 0, sizeof(*cmd
));
646 cmd
->req
.tmf
= (struct virtio_scsi_ctrl_tmf_req
){
647 .type
= VIRTIO_SCSI_T_TMF
,
648 .subtype
= VIRTIO_SCSI_T_TMF_LOGICAL_UNIT_RESET
,
650 .lun
[1] = sc
->device
->id
,
651 .lun
[2] = (sc
->device
->lun
>> 8) | 0x40,
652 .lun
[3] = sc
->device
->lun
& 0xff,
654 return virtscsi_tmf(vscsi
, cmd
);
657 static int virtscsi_abort(struct scsi_cmnd
*sc
)
659 struct virtio_scsi
*vscsi
= shost_priv(sc
->device
->host
);
660 struct virtio_scsi_cmd
*cmd
;
662 scmd_printk(KERN_INFO
, sc
, "abort\n");
663 cmd
= mempool_alloc(virtscsi_cmd_pool
, GFP_NOIO
);
667 memset(cmd
, 0, sizeof(*cmd
));
669 cmd
->req
.tmf
= (struct virtio_scsi_ctrl_tmf_req
){
670 .type
= VIRTIO_SCSI_T_TMF
,
671 .subtype
= VIRTIO_SCSI_T_TMF_ABORT_TASK
,
673 .lun
[1] = sc
->device
->id
,
674 .lun
[2] = (sc
->device
->lun
>> 8) | 0x40,
675 .lun
[3] = sc
->device
->lun
& 0xff,
676 .tag
= (unsigned long)sc
,
678 return virtscsi_tmf(vscsi
, cmd
);
681 static int virtscsi_target_alloc(struct scsi_target
*starget
)
683 struct virtio_scsi_target_state
*tgt
=
684 kmalloc(sizeof(*tgt
), GFP_KERNEL
);
688 spin_lock_init(&tgt
->tgt_lock
);
689 atomic_set(&tgt
->reqs
, 0);
692 starget
->hostdata
= tgt
;
696 static void virtscsi_target_destroy(struct scsi_target
*starget
)
698 struct virtio_scsi_target_state
*tgt
= starget
->hostdata
;
702 static struct scsi_host_template virtscsi_host_template_single
= {
703 .module
= THIS_MODULE
,
704 .name
= "Virtio SCSI HBA",
705 .proc_name
= "virtio_scsi",
707 .queuecommand
= virtscsi_queuecommand_single
,
708 .eh_abort_handler
= virtscsi_abort
,
709 .eh_device_reset_handler
= virtscsi_device_reset
,
712 .dma_boundary
= UINT_MAX
,
713 .use_clustering
= ENABLE_CLUSTERING
,
714 .target_alloc
= virtscsi_target_alloc
,
715 .target_destroy
= virtscsi_target_destroy
,
718 static struct scsi_host_template virtscsi_host_template_multi
= {
719 .module
= THIS_MODULE
,
720 .name
= "Virtio SCSI HBA",
721 .proc_name
= "virtio_scsi",
723 .queuecommand
= virtscsi_queuecommand_multi
,
724 .eh_abort_handler
= virtscsi_abort
,
725 .eh_device_reset_handler
= virtscsi_device_reset
,
728 .dma_boundary
= UINT_MAX
,
729 .use_clustering
= ENABLE_CLUSTERING
,
730 .target_alloc
= virtscsi_target_alloc
,
731 .target_destroy
= virtscsi_target_destroy
,
734 #define virtscsi_config_get(vdev, fld) \
736 typeof(((struct virtio_scsi_config *)0)->fld) __val; \
737 vdev->config->get(vdev, \
738 offsetof(struct virtio_scsi_config, fld), \
739 &__val, sizeof(__val)); \
743 #define virtscsi_config_set(vdev, fld, val) \
745 typeof(((struct virtio_scsi_config *)0)->fld) __val = (val); \
746 vdev->config->set(vdev, \
747 offsetof(struct virtio_scsi_config, fld), \
748 &__val, sizeof(__val)); \
751 static void __virtscsi_set_affinity(struct virtio_scsi
*vscsi
, bool affinity
)
756 /* In multiqueue mode, when the number of cpu is equal
757 * to the number of request queues, we let the qeueues
758 * to be private to one cpu by setting the affinity hint
759 * to eliminate the contention.
761 if ((vscsi
->num_queues
== 1 ||
762 vscsi
->num_queues
!= num_online_cpus()) && affinity
) {
763 if (vscsi
->affinity_hint_set
)
771 for_each_online_cpu(cpu
) {
772 virtqueue_set_affinity(vscsi
->req_vqs
[i
].vq
, cpu
);
776 vscsi
->affinity_hint_set
= true;
778 for (i
= 0; i
< vscsi
->num_queues
; i
++) {
779 if (!vscsi
->req_vqs
[i
].vq
)
782 virtqueue_set_affinity(vscsi
->req_vqs
[i
].vq
, -1);
785 vscsi
->affinity_hint_set
= false;
789 static void virtscsi_set_affinity(struct virtio_scsi
*vscsi
, bool affinity
)
792 __virtscsi_set_affinity(vscsi
, affinity
);
796 static int virtscsi_cpu_callback(struct notifier_block
*nfb
,
797 unsigned long action
, void *hcpu
)
799 struct virtio_scsi
*vscsi
= container_of(nfb
, struct virtio_scsi
, nb
);
802 case CPU_ONLINE_FROZEN
:
804 case CPU_DEAD_FROZEN
:
805 __virtscsi_set_affinity(vscsi
, true);
813 static void virtscsi_init_vq(struct virtio_scsi_vq
*virtscsi_vq
,
814 struct virtqueue
*vq
)
816 spin_lock_init(&virtscsi_vq
->vq_lock
);
817 virtscsi_vq
->vq
= vq
;
820 static void virtscsi_scan(struct virtio_device
*vdev
)
822 struct Scsi_Host
*shost
= (struct Scsi_Host
*)vdev
->priv
;
824 scsi_scan_host(shost
);
827 static void virtscsi_remove_vqs(struct virtio_device
*vdev
)
829 struct Scsi_Host
*sh
= virtio_scsi_host(vdev
);
830 struct virtio_scsi
*vscsi
= shost_priv(sh
);
832 virtscsi_set_affinity(vscsi
, false);
834 /* Stop all the virtqueues. */
835 vdev
->config
->reset(vdev
);
837 vdev
->config
->del_vqs(vdev
);
840 static int virtscsi_init(struct virtio_device
*vdev
,
841 struct virtio_scsi
*vscsi
)
846 vq_callback_t
**callbacks
;
848 struct virtqueue
**vqs
;
850 num_vqs
= vscsi
->num_queues
+ VIRTIO_SCSI_VQ_BASE
;
851 vqs
= kmalloc(num_vqs
* sizeof(struct virtqueue
*), GFP_KERNEL
);
852 callbacks
= kmalloc(num_vqs
* sizeof(vq_callback_t
*), GFP_KERNEL
);
853 names
= kmalloc(num_vqs
* sizeof(char *), GFP_KERNEL
);
855 if (!callbacks
|| !vqs
|| !names
) {
860 callbacks
[0] = virtscsi_ctrl_done
;
861 callbacks
[1] = virtscsi_event_done
;
862 names
[0] = "control";
864 for (i
= VIRTIO_SCSI_VQ_BASE
; i
< num_vqs
; i
++) {
865 callbacks
[i
] = virtscsi_req_done
;
866 names
[i
] = "request";
869 /* Discover virtqueues and write information to configuration. */
870 err
= vdev
->config
->find_vqs(vdev
, num_vqs
, vqs
, callbacks
, names
);
874 virtscsi_init_vq(&vscsi
->ctrl_vq
, vqs
[0]);
875 virtscsi_init_vq(&vscsi
->event_vq
, vqs
[1]);
876 for (i
= VIRTIO_SCSI_VQ_BASE
; i
< num_vqs
; i
++)
877 virtscsi_init_vq(&vscsi
->req_vqs
[i
- VIRTIO_SCSI_VQ_BASE
],
880 virtscsi_set_affinity(vscsi
, true);
882 virtscsi_config_set(vdev
, cdb_size
, VIRTIO_SCSI_CDB_SIZE
);
883 virtscsi_config_set(vdev
, sense_size
, VIRTIO_SCSI_SENSE_SIZE
);
885 if (virtio_has_feature(vdev
, VIRTIO_SCSI_F_HOTPLUG
))
886 virtscsi_kick_event_all(vscsi
);
895 virtscsi_remove_vqs(vdev
);
899 static int virtscsi_probe(struct virtio_device
*vdev
)
901 struct Scsi_Host
*shost
;
902 struct virtio_scsi
*vscsi
;
904 u32 sg_elems
, num_targets
;
907 struct scsi_host_template
*hostt
;
909 /* We need to know how many queues before we allocate. */
910 num_queues
= virtscsi_config_get(vdev
, num_queues
) ? : 1;
912 num_targets
= virtscsi_config_get(vdev
, max_target
) + 1;
915 hostt
= &virtscsi_host_template_single
;
917 hostt
= &virtscsi_host_template_multi
;
919 shost
= scsi_host_alloc(hostt
,
920 sizeof(*vscsi
) + sizeof(vscsi
->req_vqs
[0]) * num_queues
);
924 sg_elems
= virtscsi_config_get(vdev
, seg_max
) ?: 1;
925 shost
->sg_tablesize
= sg_elems
;
926 vscsi
= shost_priv(shost
);
928 vscsi
->num_queues
= num_queues
;
931 err
= virtscsi_init(vdev
, vscsi
);
933 goto virtscsi_init_failed
;
935 vscsi
->nb
.notifier_call
= &virtscsi_cpu_callback
;
936 err
= register_hotcpu_notifier(&vscsi
->nb
);
938 pr_err("registering cpu notifier failed\n");
939 goto scsi_add_host_failed
;
942 cmd_per_lun
= virtscsi_config_get(vdev
, cmd_per_lun
) ?: 1;
943 shost
->cmd_per_lun
= min_t(u32
, cmd_per_lun
, shost
->can_queue
);
944 shost
->max_sectors
= virtscsi_config_get(vdev
, max_sectors
) ?: 0xFFFF;
946 /* LUNs > 256 are reported with format 1, so they go in the range
949 shost
->max_lun
= virtscsi_config_get(vdev
, max_lun
) + 1 + 0x4000;
950 shost
->max_id
= num_targets
;
951 shost
->max_channel
= 0;
952 shost
->max_cmd_len
= VIRTIO_SCSI_CDB_SIZE
;
953 err
= scsi_add_host(shost
, &vdev
->dev
);
955 goto scsi_add_host_failed
;
957 * scsi_scan_host() happens in virtscsi_scan() via virtio_driver->scan()
958 * after VIRTIO_CONFIG_S_DRIVER_OK has been set..
962 scsi_add_host_failed
:
963 vdev
->config
->del_vqs(vdev
);
964 virtscsi_init_failed
:
965 scsi_host_put(shost
);
969 static void virtscsi_remove(struct virtio_device
*vdev
)
971 struct Scsi_Host
*shost
= virtio_scsi_host(vdev
);
972 struct virtio_scsi
*vscsi
= shost_priv(shost
);
974 if (virtio_has_feature(vdev
, VIRTIO_SCSI_F_HOTPLUG
))
975 virtscsi_cancel_event_work(vscsi
);
977 scsi_remove_host(shost
);
979 unregister_hotcpu_notifier(&vscsi
->nb
);
981 virtscsi_remove_vqs(vdev
);
982 scsi_host_put(shost
);
986 static int virtscsi_freeze(struct virtio_device
*vdev
)
988 struct Scsi_Host
*sh
= virtio_scsi_host(vdev
);
989 struct virtio_scsi
*vscsi
= shost_priv(sh
);
991 unregister_hotcpu_notifier(&vscsi
->nb
);
992 virtscsi_remove_vqs(vdev
);
996 static int virtscsi_restore(struct virtio_device
*vdev
)
998 struct Scsi_Host
*sh
= virtio_scsi_host(vdev
);
999 struct virtio_scsi
*vscsi
= shost_priv(sh
);
1002 err
= virtscsi_init(vdev
, vscsi
);
1006 err
= register_hotcpu_notifier(&vscsi
->nb
);
1008 vdev
->config
->del_vqs(vdev
);
1014 static struct virtio_device_id id_table
[] = {
1015 { VIRTIO_ID_SCSI
, VIRTIO_DEV_ANY_ID
},
1019 static unsigned int features
[] = {
1020 VIRTIO_SCSI_F_HOTPLUG
,
1021 VIRTIO_SCSI_F_CHANGE
,
1024 static struct virtio_driver virtio_scsi_driver
= {
1025 .feature_table
= features
,
1026 .feature_table_size
= ARRAY_SIZE(features
),
1027 .driver
.name
= KBUILD_MODNAME
,
1028 .driver
.owner
= THIS_MODULE
,
1029 .id_table
= id_table
,
1030 .probe
= virtscsi_probe
,
1031 .scan
= virtscsi_scan
,
1033 .freeze
= virtscsi_freeze
,
1034 .restore
= virtscsi_restore
,
1036 .remove
= virtscsi_remove
,
1039 static int __init
init(void)
1043 virtscsi_cmd_cache
= KMEM_CACHE(virtio_scsi_cmd
, 0);
1044 if (!virtscsi_cmd_cache
) {
1045 pr_err("kmem_cache_create() for virtscsi_cmd_cache failed\n");
1051 mempool_create_slab_pool(VIRTIO_SCSI_MEMPOOL_SZ
,
1052 virtscsi_cmd_cache
);
1053 if (!virtscsi_cmd_pool
) {
1054 pr_err("mempool_create() for virtscsi_cmd_pool failed\n");
1057 ret
= register_virtio_driver(&virtio_scsi_driver
);
1064 if (virtscsi_cmd_pool
) {
1065 mempool_destroy(virtscsi_cmd_pool
);
1066 virtscsi_cmd_pool
= NULL
;
1068 if (virtscsi_cmd_cache
) {
1069 kmem_cache_destroy(virtscsi_cmd_cache
);
1070 virtscsi_cmd_cache
= NULL
;
1075 static void __exit
fini(void)
1077 unregister_virtio_driver(&virtio_scsi_driver
);
1078 mempool_destroy(virtscsi_cmd_pool
);
1079 kmem_cache_destroy(virtscsi_cmd_cache
);
1084 MODULE_DEVICE_TABLE(virtio
, id_table
);
1085 MODULE_DESCRIPTION("Virtio SCSI HBA driver");
1086 MODULE_LICENSE("GPL");