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 <scsi/scsi_host.h>
  27 #include <scsi/scsi_device.h>
  28 #include <scsi/scsi_cmnd.h>
  29
  30 #define VIRTIO_SCSI_MEMPOOL_SZ 64
  31 #define VIRTIO_SCSI_EVENT_LEN 8
  32 #define VIRTIO_SCSI_VQ_BASE 2
  33
  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;
  50
  51 struct virtio_scsi_event_node {
  52         struct virtio_scsi *vscsi;
  53         struct virtio_scsi_event event;
  54         struct work_struct work;
  55 };
  56
  57 struct virtio_scsi_vq {
  58         /* Protects vq */
  59         spinlock_t vq_lock;
  60
  61         struct virtqueue *vq;
  62 };
  63
  64 /*
  65  * Per-target queue state.
  66  *
  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).
  75  *
  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:
  78  *
  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.
  82  *
  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.
  85  *
  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.
  89  */
  90 struct virtio_scsi_target_state {
  91         /* This spinlock never held at the same time as vq_lock. */
  92         spinlock_t tgt_lock;
  93
  94         /* Count of outstanding requests. */
  95         atomic_t reqs;
  96
  97         /* Currently active virtqueue for requests sent to this target. */
  98         struct virtio_scsi_vq *req_vq;
  99 };
 100
 101 /* Driver instance state */
 102 struct virtio_scsi {
 103         struct virtio_device *vdev;
 104
 105         /* Get some buffers ready for event vq */
 106         struct virtio_scsi_event_node event_list[VIRTIO_SCSI_EVENT_LEN];
 107
 108         u32 num_queues;
 109
 110         /* If the affinity hint is set for virtqueues */
 111         bool affinity_hint_set;
 112
 113         /* CPU hotplug notifier */
 114         struct notifier_block nb;
 115
 116         struct virtio_scsi_vq ctrl_vq;
 117         struct virtio_scsi_vq event_vq;
 118         struct virtio_scsi_vq req_vqs[];
 119 };
 120
 121 static struct kmem_cache *virtscsi_cmd_cache;
 122 static mempool_t *virtscsi_cmd_pool;
 123
 124 static inline struct Scsi_Host *virtio_scsi_host(struct virtio_device *vdev)
 125 {
 126         return vdev->priv;
 127 }
 128
 129 static void virtscsi_compute_resid(struct scsi_cmnd *sc, u32 resid)
 130 {
 131         if (!resid)
 132                 return;
 133
 134         if (!scsi_bidi_cmnd(sc)) {
 135                 scsi_set_resid(sc, resid);
 136                 return;
 137         }
 138
 139         scsi_in(sc)->resid = min(resid, scsi_in(sc)->length);
 140         scsi_out(sc)->resid = resid - scsi_in(sc)->resid;
 141 }
 142
 143 /**
 144  * virtscsi_complete_cmd - finish a scsi_cmd and invoke scsi_done
 145  *
 146  * Called with vq_lock held.
 147  */
 148 static void virtscsi_complete_cmd(struct virtio_scsi *vscsi, void *buf)
 149 {
 150         struct virtio_scsi_cmd *cmd = buf;
 151         struct scsi_cmnd *sc = cmd->sc;
 152         struct virtio_scsi_cmd_resp *resp = &cmd->resp.cmd;
 153         struct virtio_scsi_target_state *tgt =
 154                                 scsi_target(sc->device)->hostdata;
 155
 156         dev_dbg(&sc->device->sdev_gendev,
 157                 "cmd %p response %u status %#02x sense_len %u\n",
 158                 sc, resp->response, resp->status, resp->sense_len);
 159
 160         sc->result = resp->status;
 161         virtscsi_compute_resid(sc, resp->resid);
 162         switch (resp->response) {
 163         case VIRTIO_SCSI_S_OK:
 164                 set_host_byte(sc, DID_OK);
 165                 break;
 166         case VIRTIO_SCSI_S_OVERRUN:
 167                 set_host_byte(sc, DID_ERROR);
 168                 break;
 169         case VIRTIO_SCSI_S_ABORTED:
 170                 set_host_byte(sc, DID_ABORT);
 171                 break;
 172         case VIRTIO_SCSI_S_BAD_TARGET:
 173                 set_host_byte(sc, DID_BAD_TARGET);
 174                 break;
 175         case VIRTIO_SCSI_S_RESET:
 176                 set_host_byte(sc, DID_RESET);
 177                 break;
 178         case VIRTIO_SCSI_S_BUSY:
 179                 set_host_byte(sc, DID_BUS_BUSY);
 180                 break;
 181         case VIRTIO_SCSI_S_TRANSPORT_FAILURE:
 182                 set_host_byte(sc, DID_TRANSPORT_DISRUPTED);
 183                 break;
 184         case VIRTIO_SCSI_S_TARGET_FAILURE:
 185                 set_host_byte(sc, DID_TARGET_FAILURE);
 186                 break;
 187         case VIRTIO_SCSI_S_NEXUS_FAILURE:
 188                 set_host_byte(sc, DID_NEXUS_FAILURE);
 189                 break;
 190         default:
 191                 scmd_printk(KERN_WARNING, sc, "Unknown response %d",
 192                             resp->response);
 193                 /* fall through */
 194         case VIRTIO_SCSI_S_FAILURE:
 195                 set_host_byte(sc, DID_ERROR);
 196                 break;
 197         }
 198
 199         WARN_ON(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);
 205         }
 206
 207         mempool_free(cmd, virtscsi_cmd_pool);
 208         sc->scsi_done(sc);
 209
 210         atomic_dec(&tgt->reqs);
 211 }
 212
 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))
 216 {
 217         void *buf;
 218         unsigned int len;
 219         unsigned long flags;
 220         struct virtqueue *vq = virtscsi_vq->vq;
 221
 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);
 229 }
 230
 231 static void virtscsi_req_done(struct virtqueue *vq)
 232 {
 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];
 237
 238         /*
 239          * Read req_vq before decrementing the reqs field in
 240          * virtscsi_complete_cmd.
 241          *
 242          * With barriers:
 243          *
 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
 252          *
 253          * Possible reordering without barriers:
 254          *
 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
 263          *
 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.
 267          */
 268         smp_read_barrier_depends();
 269
 270         virtscsi_vq_done(vscsi, req_vq, virtscsi_complete_cmd);
 271 };
 272
 273 static void virtscsi_complete_free(struct virtio_scsi *vscsi, void *buf)
 274 {
 275         struct virtio_scsi_cmd *cmd = buf;
 276
 277         if (cmd->comp)
 278                 complete_all(cmd->comp);
 279         else
 280                 mempool_free(cmd, virtscsi_cmd_pool);
 281 }
 282
 283 static void virtscsi_ctrl_done(struct virtqueue *vq)
 284 {
 285         struct Scsi_Host *sh = virtio_scsi_host(vq->vdev);
 286         struct virtio_scsi *vscsi = shost_priv(sh);
 287
 288         virtscsi_vq_done(vscsi, &vscsi->ctrl_vq, virtscsi_complete_free);
 289 };
 290
 291 static void virtscsi_handle_event(struct work_struct *work);
 292
 293 static int virtscsi_kick_event(struct virtio_scsi *vscsi,
 294                                struct virtio_scsi_event_node *event_node)
 295 {
 296         int err;
 297         struct scatterlist sg;
 298         unsigned long flags;
 299
 300         INIT_WORK(&event_node->work, virtscsi_handle_event);
 301         sg_init_one(&sg, &event_node->event, sizeof(struct virtio_scsi_event));
 302
 303         spin_lock_irqsave(&vscsi->event_vq.vq_lock, flags);
 304
 305         err = virtqueue_add_inbuf(vscsi->event_vq.vq, &sg, 1, event_node,
 306                                   GFP_ATOMIC);
 307         if (!err)
 308                 virtqueue_kick(vscsi->event_vq.vq);
 309
 310         spin_unlock_irqrestore(&vscsi->event_vq.vq_lock, flags);
 311
 312         return err;
 313 }
 314
 315 static int virtscsi_kick_event_all(struct virtio_scsi *vscsi)
 316 {
 317         int i;
 318
 319         for (i = 0; i < VIRTIO_SCSI_EVENT_LEN; i++) {
 320                 vscsi->event_list[i].vscsi = vscsi;
 321                 virtscsi_kick_event(vscsi, &vscsi->event_list[i]);
 322         }
 323
 324         return 0;
 325 }
 326
 327 static void virtscsi_cancel_event_work(struct virtio_scsi *vscsi)
 328 {
 329         int i;
 330
 331         for (i = 0; i < VIRTIO_SCSI_EVENT_LEN; i++)
 332                 cancel_work_sync(&vscsi->event_list[i].work);
 333 }
 334
 335 static void virtscsi_handle_transport_reset(struct virtio_scsi *vscsi,
 336                                             struct virtio_scsi_event *event)
 337 {
 338         struct scsi_device *sdev;
 339         struct Scsi_Host *shost = virtio_scsi_host(vscsi->vdev);
 340         unsigned int target = event->lun[1];
 341         unsigned int lun = (event->lun[2] << 8) | event->lun[3];
 342
 343         switch (event->reason) {
 344         case VIRTIO_SCSI_EVT_RESET_RESCAN:
 345                 scsi_add_device(shost, 0, target, lun);
 346                 break;
 347         case VIRTIO_SCSI_EVT_RESET_REMOVED:
 348                 sdev = scsi_device_lookup(shost, 0, target, lun);
 349                 if (sdev) {
 350                         scsi_remove_device(sdev);
 351                         scsi_device_put(sdev);
 352                 } else {
 353                         pr_err("SCSI device %d 0 %d %d not found\n",
 354                                 shost->host_no, target, lun);
 355                 }
 356                 break;
 357         default:
 358                 pr_info("Unsupport virtio scsi event reason %x\n", event->reason);
 359         }
 360 }
 361
 362 static void virtscsi_handle_param_change(struct virtio_scsi *vscsi,
 363                                          struct virtio_scsi_event *event)
 364 {
 365         struct scsi_device *sdev;
 366         struct Scsi_Host *shost = virtio_scsi_host(vscsi->vdev);
 367         unsigned int target = event->lun[1];
 368         unsigned int lun = (event->lun[2] << 8) | event->lun[3];
 369         u8 asc = event->reason & 255;
 370         u8 ascq = event->reason >> 8;
 371
 372         sdev = scsi_device_lookup(shost, 0, target, lun);
 373         if (!sdev) {
 374                 pr_err("SCSI device %d 0 %d %d not found\n",
 375                         shost->host_no, target, lun);
 376                 return;
 377         }
 378
 379         /* Handle "Parameters changed", "Mode parameters changed", and
 380            "Capacity data has changed".  */
 381         if (asc == 0x2a && (ascq == 0x00 || ascq == 0x01 || ascq == 0x09))
 382                 scsi_rescan_device(&sdev->sdev_gendev);
 383
 384         scsi_device_put(sdev);
 385 }
 386
 387 static void virtscsi_handle_event(struct work_struct *work)
 388 {
 389         struct virtio_scsi_event_node *event_node =
 390                 container_of(work, struct virtio_scsi_event_node, work);
 391         struct virtio_scsi *vscsi = event_node->vscsi;
 392         struct virtio_scsi_event *event = &event_node->event;
 393
 394         if (event->event & VIRTIO_SCSI_T_EVENTS_MISSED) {
 395                 event->event &= ~VIRTIO_SCSI_T_EVENTS_MISSED;
 396                 scsi_scan_host(virtio_scsi_host(vscsi->vdev));
 397         }
 398
 399         switch (event->event) {
 400         case VIRTIO_SCSI_T_NO_EVENT:
 401                 break;
 402         case VIRTIO_SCSI_T_TRANSPORT_RESET:
 403                 virtscsi_handle_transport_reset(vscsi, event);
 404                 break;
 405         case VIRTIO_SCSI_T_PARAM_CHANGE:
 406                 virtscsi_handle_param_change(vscsi, event);
 407                 break;
 408         default:
 409                 pr_err("Unsupport virtio scsi event %x\n", event->event);
 410         }
 411         virtscsi_kick_event(vscsi, event_node);
 412 }
 413
 414 static void virtscsi_complete_event(struct virtio_scsi *vscsi, void *buf)
 415 {
 416         struct virtio_scsi_event_node *event_node = buf;
 417
 418         schedule_work(&event_node->work);
 419 }
 420
 421 static void virtscsi_event_done(struct virtqueue *vq)
 422 {
 423         struct Scsi_Host *sh = virtio_scsi_host(vq->vdev);
 424         struct virtio_scsi *vscsi = shost_priv(sh);
 425
 426         virtscsi_vq_done(vscsi, &vscsi->event_vq, virtscsi_complete_event);
 427 };
 428
 429 /**
 430  * virtscsi_add_cmd - add a virtio_scsi_cmd to a virtqueue
 431  * @vq          : the struct virtqueue we're talking about
 432  * @cmd         : command structure
 433  * @req_size    : size of the request buffer
 434  * @resp_size   : size of the response buffer
 435  * @gfp : flags to use for memory allocations
 436  */
 437 static int virtscsi_add_cmd(struct virtqueue *vq,
 438                             struct virtio_scsi_cmd *cmd,
 439                             size_t req_size, size_t resp_size, gfp_t gfp)
 440 {
 441         struct scsi_cmnd *sc = cmd->sc;
 442         struct scatterlist *sgs[4], req, resp;
 443         struct sg_table *out, *in;
 444         unsigned out_num = 0, in_num = 0;
 445
 446         out = in = NULL;
 447
 448         if (sc && sc->sc_data_direction != DMA_NONE) {
 449                 if (sc->sc_data_direction != DMA_FROM_DEVICE)
 450                         out = &scsi_out(sc)->table;
 451                 if (sc->sc_data_direction != DMA_TO_DEVICE)
 452                         in = &scsi_in(sc)->table;
 453         }
 454
 455         /* Request header.  */
 456         sg_init_one(&req, &cmd->req, req_size);
 457         sgs[out_num++] = &req;
 458
 459         /* Data-out buffer.  */
 460         if (out)
 461                 sgs[out_num++] = out->sgl;
 462
 463         /* Response header.  */
 464         sg_init_one(&resp, &cmd->resp, resp_size);
 465         sgs[out_num + in_num++] = &resp;
 466
 467         /* Data-in buffer */
 468         if (in)
 469                 sgs[out_num + in_num++] = in->sgl;
 470
 471         return virtqueue_add_sgs(vq, sgs, out_num, in_num, cmd, gfp);
 472 }
 473
 474 static int virtscsi_kick_cmd(struct virtio_scsi_vq *vq,
 475                              struct virtio_scsi_cmd *cmd,
 476                              size_t req_size, size_t resp_size, gfp_t gfp)
 477 {
 478         unsigned long flags;
 479         int err;
 480         bool needs_kick = false;
 481
 482         spin_lock_irqsave(&vq->vq_lock, flags);
 483         err = virtscsi_add_cmd(vq->vq, cmd, req_size, resp_size, gfp);
 484         if (!err)
 485                 needs_kick = virtqueue_kick_prepare(vq->vq);
 486
 487         spin_unlock_irqrestore(&vq->vq_lock, flags);
 488
 489         if (needs_kick)
 490                 virtqueue_notify(vq->vq);
 491         return err;
 492 }
 493
 494 static int virtscsi_queuecommand(struct virtio_scsi *vscsi,
 495                                  struct virtio_scsi_vq *req_vq,
 496                                  struct scsi_cmnd *sc)
 497 {
 498         struct virtio_scsi_cmd *cmd;
 499         int ret;
 500
 501         struct Scsi_Host *shost = virtio_scsi_host(vscsi->vdev);
 502         BUG_ON(scsi_sg_count(sc) > shost->sg_tablesize);
 503
 504         /* TODO: check feature bit and fail if unsupported?  */
 505         BUG_ON(sc->sc_data_direction == DMA_BIDIRECTIONAL);
 506
 507         dev_dbg(&sc->device->sdev_gendev,
 508                 "cmd %p CDB: %#02x\n", sc, sc->cmnd[0]);
 509
 510         ret = SCSI_MLQUEUE_HOST_BUSY;
 511         cmd = mempool_alloc(virtscsi_cmd_pool, GFP_ATOMIC);
 512         if (!cmd)
 513                 goto out;
 514
 515         memset(cmd, 0, sizeof(*cmd));
 516         cmd->sc = sc;
 517         cmd->req.cmd = (struct virtio_scsi_cmd_req){
 518                 .lun[0] = 1,
 519                 .lun[1] = sc->device->id,
 520                 .lun[2] = (sc->device->lun >> 8) | 0x40,
 521                 .lun[3] = sc->device->lun & 0xff,
 522                 .tag = (unsigned long)sc,
 523                 .task_attr = VIRTIO_SCSI_S_SIMPLE,
 524                 .prio = 0,
 525                 .crn = 0,
 526         };
 527
 528         BUG_ON(sc->cmd_len > VIRTIO_SCSI_CDB_SIZE);
 529         memcpy(cmd->req.cmd.cdb, sc->cmnd, sc->cmd_len);
 530
 531         if (virtscsi_kick_cmd(req_vq, cmd,
 532                               sizeof cmd->req.cmd, sizeof cmd->resp.cmd,
 533                               GFP_ATOMIC) == 0)
 534                 ret = 0;
 535         else
 536                 mempool_free(cmd, virtscsi_cmd_pool);
 537
 538 out:
 539         return ret;
 540 }
 541
 542 static int virtscsi_queuecommand_single(struct Scsi_Host *sh,
 543                                         struct scsi_cmnd *sc)
 544 {
 545         struct virtio_scsi *vscsi = shost_priv(sh);
 546         struct virtio_scsi_target_state *tgt =
 547                                 scsi_target(sc->device)->hostdata;
 548
 549         atomic_inc(&tgt->reqs);
 550         return virtscsi_queuecommand(vscsi, &vscsi->req_vqs[0], sc);
 551 }
 552
 553 static struct virtio_scsi_vq *virtscsi_pick_vq(struct virtio_scsi *vscsi,
 554                                                struct virtio_scsi_target_state *tgt)
 555 {
 556         struct virtio_scsi_vq *vq;
 557         unsigned long flags;
 558         u32 queue_num;
 559
 560         spin_lock_irqsave(&tgt->tgt_lock, flags);
 561
 562         /*
 563          * The memory barrier after atomic_inc_return matches
 564          * the smp_read_barrier_depends() in virtscsi_req_done.
 565          */
 566         if (atomic_inc_return(&tgt->reqs) > 1)
 567                 vq = ACCESS_ONCE(tgt->req_vq);
 568         else {
 569                 queue_num = smp_processor_id();
 570                 while (unlikely(queue_num >= vscsi->num_queues))
 571                         queue_num -= vscsi->num_queues;
 572
 573                 tgt->req_vq = vq = &vscsi->req_vqs[queue_num];
 574         }
 575
 576         spin_unlock_irqrestore(&tgt->tgt_lock, flags);
 577         return vq;
 578 }
 579
 580 static int virtscsi_queuecommand_multi(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         struct virtio_scsi_vq *req_vq = virtscsi_pick_vq(vscsi, tgt);
 587
 588         return virtscsi_queuecommand(vscsi, req_vq, sc);
 589 }
 590
 591 static int virtscsi_tmf(struct virtio_scsi *vscsi, struct virtio_scsi_cmd *cmd)
 592 {
 593         DECLARE_COMPLETION_ONSTACK(comp);
 594         int ret = FAILED;
 595
 596         cmd->comp = &comp;
 597         if (virtscsi_kick_cmd(&vscsi->ctrl_vq, cmd,
 598                               sizeof cmd->req.tmf, sizeof cmd->resp.tmf,
 599                               GFP_NOIO) < 0)
 600                 goto out;
 601
 602         wait_for_completion(&comp);
 603         if (cmd->resp.tmf.response == VIRTIO_SCSI_S_OK ||
 604             cmd->resp.tmf.response == VIRTIO_SCSI_S_FUNCTION_SUCCEEDED)
 605                 ret = SUCCESS;
 606
 607 out:
 608         mempool_free(cmd, virtscsi_cmd_pool);
 609         return ret;
 610 }
 611
 612 static int virtscsi_device_reset(struct scsi_cmnd *sc)
 613 {
 614         struct virtio_scsi *vscsi = shost_priv(sc->device->host);
 615         struct virtio_scsi_cmd *cmd;
 616
 617         sdev_printk(KERN_INFO, sc->device, "device reset\n");
 618         cmd = mempool_alloc(virtscsi_cmd_pool, GFP_NOIO);
 619         if (!cmd)
 620                 return FAILED;
 621
 622         memset(cmd, 0, sizeof(*cmd));
 623         cmd->sc = sc;
 624         cmd->req.tmf = (struct virtio_scsi_ctrl_tmf_req){
 625                 .type = VIRTIO_SCSI_T_TMF,
 626                 .subtype = VIRTIO_SCSI_T_TMF_LOGICAL_UNIT_RESET,
 627                 .lun[0] = 1,
 628                 .lun[1] = sc->device->id,
 629                 .lun[2] = (sc->device->lun >> 8) | 0x40,
 630                 .lun[3] = sc->device->lun & 0xff,
 631         };
 632         return virtscsi_tmf(vscsi, cmd);
 633 }
 634
 635 static int virtscsi_abort(struct scsi_cmnd *sc)
 636 {
 637         struct virtio_scsi *vscsi = shost_priv(sc->device->host);
 638         struct virtio_scsi_cmd *cmd;
 639
 640         scmd_printk(KERN_INFO, sc, "abort\n");
 641         cmd = mempool_alloc(virtscsi_cmd_pool, GFP_NOIO);
 642         if (!cmd)
 643                 return FAILED;
 644
 645         memset(cmd, 0, sizeof(*cmd));
 646         cmd->sc = sc;
 647         cmd->req.tmf = (struct virtio_scsi_ctrl_tmf_req){
 648                 .type = VIRTIO_SCSI_T_TMF,
 649                 .subtype = VIRTIO_SCSI_T_TMF_ABORT_TASK,
 650                 .lun[0] = 1,
 651                 .lun[1] = sc->device->id,
 652                 .lun[2] = (sc->device->lun >> 8) | 0x40,
 653                 .lun[3] = sc->device->lun & 0xff,
 654                 .tag = (unsigned long)sc,
 655         };
 656         return virtscsi_tmf(vscsi, cmd);
 657 }
 658
 659 static int virtscsi_target_alloc(struct scsi_target *starget)
 660 {
 661         struct virtio_scsi_target_state *tgt =
 662                                 kmalloc(sizeof(*tgt), GFP_KERNEL);
 663         if (!tgt)
 664                 return -ENOMEM;
 665
 666         spin_lock_init(&tgt->tgt_lock);
 667         atomic_set(&tgt->reqs, 0);
 668         tgt->req_vq = NULL;
 669
 670         starget->hostdata = tgt;
 671         return 0;
 672 }
 673
 674 static void virtscsi_target_destroy(struct scsi_target *starget)
 675 {
 676         struct virtio_scsi_target_state *tgt = starget->hostdata;
 677         kfree(tgt);
 678 }
 679
 680 static struct scsi_host_template virtscsi_host_template_single = {
 681         .module = THIS_MODULE,
 682         .name = "Virtio SCSI HBA",
 683         .proc_name = "virtio_scsi",
 684         .this_id = -1,
 685         .queuecommand = virtscsi_queuecommand_single,
 686         .eh_abort_handler = virtscsi_abort,
 687         .eh_device_reset_handler = virtscsi_device_reset,
 688
 689         .can_queue = 1024,
 690         .dma_boundary = UINT_MAX,
 691         .use_clustering = ENABLE_CLUSTERING,
 692         .target_alloc = virtscsi_target_alloc,
 693         .target_destroy = virtscsi_target_destroy,
 694 };
 695
 696 static struct scsi_host_template virtscsi_host_template_multi = {
 697         .module = THIS_MODULE,
 698         .name = "Virtio SCSI HBA",
 699         .proc_name = "virtio_scsi",
 700         .this_id = -1,
 701         .queuecommand = virtscsi_queuecommand_multi,
 702         .eh_abort_handler = virtscsi_abort,
 703         .eh_device_reset_handler = virtscsi_device_reset,
 704
 705         .can_queue = 1024,
 706         .dma_boundary = UINT_MAX,
 707         .use_clustering = ENABLE_CLUSTERING,
 708         .target_alloc = virtscsi_target_alloc,
 709         .target_destroy = virtscsi_target_destroy,
 710 };
 711
 712 #define virtscsi_config_get(vdev, fld) \
 713         ({ \
 714                 typeof(((struct virtio_scsi_config *)0)->fld) __val; \
 715                 vdev->config->get(vdev, \
 716                                   offsetof(struct virtio_scsi_config, fld), \
 717                                   &__val, sizeof(__val)); \
 718                 __val; \
 719         })
 720
 721 #define virtscsi_config_set(vdev, fld, val) \
 722         (void)({ \
 723                 typeof(((struct virtio_scsi_config *)0)->fld) __val = (val); \
 724                 vdev->config->set(vdev, \
 725                                   offsetof(struct virtio_scsi_config, fld), \
 726                                   &__val, sizeof(__val)); \
 727         })
 728
 729 static void __virtscsi_set_affinity(struct virtio_scsi *vscsi, bool affinity)
 730 {
 731         int i;
 732         int cpu;
 733
 734         /* In multiqueue mode, when the number of cpu is equal
 735          * to the number of request queues, we let the qeueues
 736          * to be private to one cpu by setting the affinity hint
 737          * to eliminate the contention.
 738          */
 739         if ((vscsi->num_queues == 1 ||
 740              vscsi->num_queues != num_online_cpus()) && affinity) {
 741                 if (vscsi->affinity_hint_set)
 742                         affinity = false;
 743                 else
 744                         return;
 745         }
 746
 747         if (affinity) {
 748                 i = 0;
 749                 for_each_online_cpu(cpu) {
 750                         virtqueue_set_affinity(vscsi->req_vqs[i].vq, cpu);
 751                         i++;
 752                 }
 753
 754                 vscsi->affinity_hint_set = true;
 755         } else {
 756                 for (i = 0; i < vscsi->num_queues; i++) {
 757                         if (!vscsi->req_vqs[i].vq)
 758                                 continue;
 759
 760                         virtqueue_set_affinity(vscsi->req_vqs[i].vq, -1);
 761                 }
 762
 763                 vscsi->affinity_hint_set = false;
 764         }
 765 }
 766
 767 static void virtscsi_set_affinity(struct virtio_scsi *vscsi, bool affinity)
 768 {
 769         get_online_cpus();
 770         __virtscsi_set_affinity(vscsi, affinity);
 771         put_online_cpus();
 772 }
 773
 774 static int virtscsi_cpu_callback(struct notifier_block *nfb,
 775                                  unsigned long action, void *hcpu)
 776 {
 777         struct virtio_scsi *vscsi = container_of(nfb, struct virtio_scsi, nb);
 778         switch(action) {
 779         case CPU_ONLINE:
 780         case CPU_ONLINE_FROZEN:
 781         case CPU_DEAD:
 782         case CPU_DEAD_FROZEN:
 783                 __virtscsi_set_affinity(vscsi, true);
 784                 break;
 785         default:
 786                 break;
 787         }
 788         return NOTIFY_OK;
 789 }
 790
 791 static void virtscsi_init_vq(struct virtio_scsi_vq *virtscsi_vq,
 792                              struct virtqueue *vq)
 793 {
 794         spin_lock_init(&virtscsi_vq->vq_lock);
 795         virtscsi_vq->vq = vq;
 796 }
 797
 798 static void virtscsi_scan(struct virtio_device *vdev)
 799 {
 800         struct Scsi_Host *shost = (struct Scsi_Host *)vdev->priv;
 801
 802         scsi_scan_host(shost);
 803 }
 804
 805 static void virtscsi_remove_vqs(struct virtio_device *vdev)
 806 {
 807         struct Scsi_Host *sh = virtio_scsi_host(vdev);
 808         struct virtio_scsi *vscsi = shost_priv(sh);
 809
 810         virtscsi_set_affinity(vscsi, false);
 811
 812         /* Stop all the virtqueues. */
 813         vdev->config->reset(vdev);
 814
 815         vdev->config->del_vqs(vdev);
 816 }
 817
 818 static int virtscsi_init(struct virtio_device *vdev,
 819                          struct virtio_scsi *vscsi)
 820 {
 821         int err;
 822         u32 i;
 823         u32 num_vqs;
 824         vq_callback_t **callbacks;
 825         const char **names;
 826         struct virtqueue **vqs;
 827
 828         num_vqs = vscsi->num_queues + VIRTIO_SCSI_VQ_BASE;
 829         vqs = kmalloc(num_vqs * sizeof(struct virtqueue *), GFP_KERNEL);
 830         callbacks = kmalloc(num_vqs * sizeof(vq_callback_t *), GFP_KERNEL);
 831         names = kmalloc(num_vqs * sizeof(char *), GFP_KERNEL);
 832
 833         if (!callbacks || !vqs || !names) {
 834                 err = -ENOMEM;
 835                 goto out;
 836         }
 837
 838         callbacks[0] = virtscsi_ctrl_done;
 839         callbacks[1] = virtscsi_event_done;
 840         names[0] = "control";
 841         names[1] = "event";
 842         for (i = VIRTIO_SCSI_VQ_BASE; i < num_vqs; i++) {
 843                 callbacks[i] = virtscsi_req_done;
 844                 names[i] = "request";
 845         }
 846
 847         /* Discover virtqueues and write information to configuration.  */
 848         err = vdev->config->find_vqs(vdev, num_vqs, vqs, callbacks, names);
 849         if (err)
 850                 goto out;
 851
 852         virtscsi_init_vq(&vscsi->ctrl_vq, vqs[0]);
 853         virtscsi_init_vq(&vscsi->event_vq, vqs[1]);
 854         for (i = VIRTIO_SCSI_VQ_BASE; i < num_vqs; i++)
 855                 virtscsi_init_vq(&vscsi->req_vqs[i - VIRTIO_SCSI_VQ_BASE],
 856                                  vqs[i]);
 857
 858         virtscsi_set_affinity(vscsi, true);
 859
 860         virtscsi_config_set(vdev, cdb_size, VIRTIO_SCSI_CDB_SIZE);
 861         virtscsi_config_set(vdev, sense_size, VIRTIO_SCSI_SENSE_SIZE);
 862
 863         if (virtio_has_feature(vdev, VIRTIO_SCSI_F_HOTPLUG))
 864                 virtscsi_kick_event_all(vscsi);
 865
 866         err = 0;
 867
 868 out:
 869         kfree(names);
 870         kfree(callbacks);
 871         kfree(vqs);
 872         if (err)
 873                 virtscsi_remove_vqs(vdev);
 874         return err;
 875 }
 876
 877 static int virtscsi_probe(struct virtio_device *vdev)
 878 {
 879         struct Scsi_Host *shost;
 880         struct virtio_scsi *vscsi;
 881         int err;
 882         u32 sg_elems, num_targets;
 883         u32 cmd_per_lun;
 884         u32 num_queues;
 885         struct scsi_host_template *hostt;
 886
 887         /* We need to know how many queues before we allocate. */
 888         num_queues = virtscsi_config_get(vdev, num_queues) ? : 1;
 889
 890         num_targets = virtscsi_config_get(vdev, max_target) + 1;
 891
 892         if (num_queues == 1)
 893                 hostt = &virtscsi_host_template_single;
 894         else
 895                 hostt = &virtscsi_host_template_multi;
 896
 897         shost = scsi_host_alloc(hostt,
 898                 sizeof(*vscsi) + sizeof(vscsi->req_vqs[0]) * num_queues);
 899         if (!shost)
 900                 return -ENOMEM;
 901
 902         sg_elems = virtscsi_config_get(vdev, seg_max) ?: 1;
 903         shost->sg_tablesize = sg_elems;
 904         vscsi = shost_priv(shost);
 905         vscsi->vdev = vdev;
 906         vscsi->num_queues = num_queues;
 907         vdev->priv = shost;
 908
 909         err = virtscsi_init(vdev, vscsi);
 910         if (err)
 911                 goto virtscsi_init_failed;
 912
 913         vscsi->nb.notifier_call = &virtscsi_cpu_callback;
 914         err = register_hotcpu_notifier(&vscsi->nb);
 915         if (err) {
 916                 pr_err("registering cpu notifier failed\n");
 917                 goto scsi_add_host_failed;
 918         }
 919
 920         cmd_per_lun = virtscsi_config_get(vdev, cmd_per_lun) ?: 1;
 921         shost->cmd_per_lun = min_t(u32, cmd_per_lun, shost->can_queue);
 922         shost->max_sectors = virtscsi_config_get(vdev, max_sectors) ?: 0xFFFF;
 923
 924         /* LUNs > 256 are reported with format 1, so they go in the range
 925          * 16640-32767.
 926          */
 927         shost->max_lun = virtscsi_config_get(vdev, max_lun) + 1 + 0x4000;
 928         shost->max_id = num_targets;
 929         shost->max_channel = 0;
 930         shost->max_cmd_len = VIRTIO_SCSI_CDB_SIZE;
 931         err = scsi_add_host(shost, &vdev->dev);
 932         if (err)
 933                 goto scsi_add_host_failed;
 934         /*
 935          * scsi_scan_host() happens in virtscsi_scan() via virtio_driver->scan()
 936          * after VIRTIO_CONFIG_S_DRIVER_OK has been set..
 937          */
 938         return 0;
 939
 940 scsi_add_host_failed:
 941         vdev->config->del_vqs(vdev);
 942 virtscsi_init_failed:
 943         scsi_host_put(shost);
 944         return err;
 945 }
 946
 947 static void virtscsi_remove(struct virtio_device *vdev)
 948 {
 949         struct Scsi_Host *shost = virtio_scsi_host(vdev);
 950         struct virtio_scsi *vscsi = shost_priv(shost);
 951
 952         if (virtio_has_feature(vdev, VIRTIO_SCSI_F_HOTPLUG))
 953                 virtscsi_cancel_event_work(vscsi);
 954
 955         scsi_remove_host(shost);
 956
 957         unregister_hotcpu_notifier(&vscsi->nb);
 958
 959         virtscsi_remove_vqs(vdev);
 960         scsi_host_put(shost);
 961 }
 962
 963 #ifdef CONFIG_PM
 964 static int virtscsi_freeze(struct virtio_device *vdev)
 965 {
 966         struct Scsi_Host *sh = virtio_scsi_host(vdev);
 967         struct virtio_scsi *vscsi = shost_priv(sh);
 968
 969         unregister_hotcpu_notifier(&vscsi->nb);
 970         virtscsi_remove_vqs(vdev);
 971         return 0;
 972 }
 973
 974 static int virtscsi_restore(struct virtio_device *vdev)
 975 {
 976         struct Scsi_Host *sh = virtio_scsi_host(vdev);
 977         struct virtio_scsi *vscsi = shost_priv(sh);
 978         int err;
 979
 980         err = virtscsi_init(vdev, vscsi);
 981         if (err)
 982                 return err;
 983
 984         err = register_hotcpu_notifier(&vscsi->nb);
 985         if (err)
 986                 vdev->config->del_vqs(vdev);
 987
 988         return err;
 989 }
 990 #endif
 991
 992 static struct virtio_device_id id_table[] = {
 993         { VIRTIO_ID_SCSI, VIRTIO_DEV_ANY_ID },
 994         { 0 },
 995 };
 996
 997 static unsigned int features[] = {
 998         VIRTIO_SCSI_F_HOTPLUG,
 999         VIRTIO_SCSI_F_CHANGE,
1000 };
1001
1002 static struct virtio_driver virtio_scsi_driver = {
1003         .feature_table = features,
1004         .feature_table_size = ARRAY_SIZE(features),
1005         .driver.name = KBUILD_MODNAME,
1006         .driver.owner = THIS_MODULE,
1007         .id_table = id_table,
1008         .probe = virtscsi_probe,
1009         .scan = virtscsi_scan,
1010 #ifdef CONFIG_PM
1011         .freeze = virtscsi_freeze,
1012         .restore = virtscsi_restore,
1013 #endif
1014         .remove = virtscsi_remove,
1015 };
1016
1017 static int __init init(void)
1018 {
1019         int ret = -ENOMEM;
1020
1021         virtscsi_cmd_cache = KMEM_CACHE(virtio_scsi_cmd, 0);
1022         if (!virtscsi_cmd_cache) {
1023                 pr_err("kmem_cache_create() for virtscsi_cmd_cache failed\n");
1024                 goto error;
1025         }
1026
1027
1028         virtscsi_cmd_pool =
1029                 mempool_create_slab_pool(VIRTIO_SCSI_MEMPOOL_SZ,
1030                                          virtscsi_cmd_cache);
1031         if (!virtscsi_cmd_pool) {
1032                 pr_err("mempool_create() for virtscsi_cmd_pool failed\n");
1033                 goto error;
1034         }
1035         ret = register_virtio_driver(&virtio_scsi_driver);
1036         if (ret < 0)
1037                 goto error;
1038
1039         return 0;
1040
1041 error:
1042         if (virtscsi_cmd_pool) {
1043                 mempool_destroy(virtscsi_cmd_pool);
1044                 virtscsi_cmd_pool = NULL;
1045         }
1046         if (virtscsi_cmd_cache) {
1047                 kmem_cache_destroy(virtscsi_cmd_cache);
1048                 virtscsi_cmd_cache = NULL;
1049         }
1050         return ret;
1051 }
1052
1053 static void __exit fini(void)
1054 {
1055         unregister_virtio_driver(&virtio_scsi_driver);
1056         mempool_destroy(virtscsi_cmd_pool);
1057         kmem_cache_destroy(virtscsi_cmd_cache);
1058 }
1059 module_init(init);
1060 module_exit(fini);
1061
1062 MODULE_DEVICE_TABLE(virtio, id_table);
1063 MODULE_DESCRIPTION("Virtio SCSI HBA driver");
1064 MODULE_LICENSE("GPL");