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