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