drivers/virtio/virtio_pci_common.c

   1 /*
   2  * Virtio PCI driver - common functionality for all device versions
   3  *
   4  * This module allows virtio devices to be used over a virtual PCI device.
   5  * This can be used with QEMU based VMMs like KVM or Xen.
   6  *
   7  * Copyright IBM Corp. 2007
   8  * Copyright Red Hat, Inc. 2014
   9  *
  10  * Authors:
  11  *  Anthony Liguori  <aliguori@us.ibm.com>
  12  *  Rusty Russell <rusty@rustcorp.com.au>
  13  *  Michael S. Tsirkin <mst@redhat.com>
  14  *
  15  * This work is licensed under the terms of the GNU GPL, version 2 or later.
  16  * See the COPYING file in the top-level directory.
  17  *
  18  */
  19
  20 #include "virtio_pci_common.h"
  21
  22 static bool force_legacy = false;
  23
  24 #if IS_ENABLED(CONFIG_VIRTIO_PCI_LEGACY)
  25 module_param(force_legacy, bool, 0444);
  26 MODULE_PARM_DESC(force_legacy,
  27                  "Force legacy mode for transitional virtio 1 devices");
  28 #endif
  29
  30 /* wait for pending irq handlers */
  31 void vp_synchronize_vectors(struct virtio_device *vdev)
  32 {
  33         struct virtio_pci_device *vp_dev = to_vp_device(vdev);
  34         int i;
  35
  36         if (vp_dev->intx_enabled)
  37                 synchronize_irq(vp_dev->pci_dev->irq);
  38
  39         for (i = 0; i < vp_dev->msix_vectors; ++i)
  40                 synchronize_irq(pci_irq_vector(vp_dev->pci_dev, i));
  41 }
  42
  43 /* the notify function used when creating a virt queue */
  44 bool vp_notify(struct virtqueue *vq)
  45 {
  46         /* we write the queue's selector into the notification register to
  47          * signal the other end */
  48         iowrite16(vq->index, (void __iomem *)vq->priv);
  49         return true;
  50 }
  51
  52 /* Handle a configuration change: Tell driver if it wants to know. */
  53 static irqreturn_t vp_config_changed(int irq, void *opaque)
  54 {
  55         struct virtio_pci_device *vp_dev = opaque;
  56
  57         virtio_config_changed(&vp_dev->vdev);
  58         return IRQ_HANDLED;
  59 }
  60
  61 /* Notify all virtqueues on an interrupt. */
  62 static irqreturn_t vp_vring_interrupt(int irq, void *opaque)
  63 {
  64         struct virtio_pci_device *vp_dev = opaque;
  65         irqreturn_t ret = IRQ_NONE;
  66         struct virtqueue *vq;
  67
  68         list_for_each_entry(vq, &vp_dev->vdev.vqs, list) {
  69                 if (vq->callback && vring_interrupt(irq, vq) == IRQ_HANDLED)
  70                         ret = IRQ_HANDLED;
  71         }
  72
  73         return ret;
  74 }
  75
  76 /* A small wrapper to also acknowledge the interrupt when it's handled.
  77  * I really need an EIO hook for the vring so I can ack the interrupt once we
  78  * know that we'll be handling the IRQ but before we invoke the callback since
  79  * the callback may notify the host which results in the host attempting to
  80  * raise an interrupt that we would then mask once we acknowledged the
  81  * interrupt. */
  82 static irqreturn_t vp_interrupt(int irq, void *opaque)
  83 {
  84         struct virtio_pci_device *vp_dev = opaque;
  85         u8 isr;
  86
  87         /* reading the ISR has the effect of also clearing it so it's very
  88          * important to save off the value. */
  89         isr = ioread8(vp_dev->isr);
  90
  91         /* It's definitely not us if the ISR was not high */
  92         if (!isr)
  93                 return IRQ_NONE;
  94
  95         /* Configuration change?  Tell driver if it wants to know. */
  96         if (isr & VIRTIO_PCI_ISR_CONFIG)
  97                 vp_config_changed(irq, opaque);
  98
  99         return vp_vring_interrupt(irq, opaque);
 100 }
 101
 102 static int vp_request_msix_vectors(struct virtio_device *vdev, int nvectors,
 103                                    bool per_vq_vectors)
 104 {
 105         struct virtio_pci_device *vp_dev = to_vp_device(vdev);
 106         const char *name = dev_name(&vp_dev->vdev.dev);
 107         unsigned i, v;
 108         int err = -ENOMEM;
 109
 110         vp_dev->msix_vectors = nvectors;
 111
 112         vp_dev->msix_names = kmalloc(nvectors * sizeof *vp_dev->msix_names,
 113                                      GFP_KERNEL);
 114         if (!vp_dev->msix_names)
 115                 goto error;
 116         vp_dev->msix_affinity_masks
 117                 = kzalloc(nvectors * sizeof *vp_dev->msix_affinity_masks,
 118                           GFP_KERNEL);
 119         if (!vp_dev->msix_affinity_masks)
 120                 goto error;
 121         for (i = 0; i < nvectors; ++i)
 122                 if (!alloc_cpumask_var(&vp_dev->msix_affinity_masks[i],
 123                                         GFP_KERNEL))
 124                         goto error;
 125
 126         err = pci_alloc_irq_vectors(vp_dev->pci_dev, nvectors, nvectors,
 127                         PCI_IRQ_MSIX);
 128         if (err < 0)
 129                 goto error;
 130         vp_dev->msix_enabled = 1;
 131
 132         /* Set the vector used for configuration */
 133         v = vp_dev->msix_used_vectors;
 134         snprintf(vp_dev->msix_names[v], sizeof *vp_dev->msix_names,
 135                  "%s-config", name);
 136         err = request_irq(pci_irq_vector(vp_dev->pci_dev, v),
 137                           vp_config_changed, 0, vp_dev->msix_names[v],
 138                           vp_dev);
 139         if (err)
 140                 goto error;
 141         ++vp_dev->msix_used_vectors;
 142
 143         v = vp_dev->config_vector(vp_dev, v);
 144         /* Verify we had enough resources to assign the vector */
 145         if (v == VIRTIO_MSI_NO_VECTOR) {
 146                 err = -EBUSY;
 147                 goto error;
 148         }
 149
 150         if (!per_vq_vectors) {
 151                 /* Shared vector for all VQs */
 152                 v = vp_dev->msix_used_vectors;
 153                 snprintf(vp_dev->msix_names[v], sizeof *vp_dev->msix_names,
 154                          "%s-virtqueues", name);
 155                 err = request_irq(pci_irq_vector(vp_dev->pci_dev, v),
 156                                   vp_vring_interrupt, 0, vp_dev->msix_names[v],
 157                                   vp_dev);
 158                 if (err)
 159                         goto error;
 160                 ++vp_dev->msix_used_vectors;
 161         }
 162         return 0;
 163 error:
 164         return err;
 165 }
 166
 167 /* the config->del_vqs() implementation */
 168 void vp_del_vqs(struct virtio_device *vdev)
 169 {
 170         struct virtio_pci_device *vp_dev = to_vp_device(vdev);
 171         struct virtqueue *vq, *n;
 172         int i;
 173
 174         list_for_each_entry_safe(vq, n, &vdev->vqs, list) {
 175                 if (vp_dev->msix_vector_map) {
 176                         int v = vp_dev->msix_vector_map[vq->index];
 177
 178                         if (v != VIRTIO_MSI_NO_VECTOR)
 179                                 free_irq(pci_irq_vector(vp_dev->pci_dev, v),
 180                                         vq);
 181                 }
 182                 vp_dev->del_vq(vq);
 183         }
 184
 185         if (vp_dev->intx_enabled) {
 186                 free_irq(vp_dev->pci_dev->irq, vp_dev);
 187                 vp_dev->intx_enabled = 0;
 188         }
 189
 190         for (i = 0; i < vp_dev->msix_used_vectors; ++i)
 191                 free_irq(pci_irq_vector(vp_dev->pci_dev, i), vp_dev);
 192
 193         for (i = 0; i < vp_dev->msix_vectors; i++)
 194                 if (vp_dev->msix_affinity_masks[i])
 195                         free_cpumask_var(vp_dev->msix_affinity_masks[i]);
 196
 197         if (vp_dev->msix_enabled) {
 198                 /* Disable the vector used for configuration */
 199                 vp_dev->config_vector(vp_dev, VIRTIO_MSI_NO_VECTOR);
 200
 201                 pci_free_irq_vectors(vp_dev->pci_dev);
 202                 vp_dev->msix_enabled = 0;
 203         }
 204
 205         vp_dev->msix_vectors = 0;
 206         vp_dev->msix_used_vectors = 0;
 207         kfree(vp_dev->msix_names);
 208         vp_dev->msix_names = NULL;
 209         kfree(vp_dev->msix_affinity_masks);
 210         vp_dev->msix_affinity_masks = NULL;
 211         kfree(vp_dev->msix_vector_map);
 212         vp_dev->msix_vector_map = NULL;
 213 }
 214
 215 static int vp_find_vqs_msix(struct virtio_device *vdev, unsigned nvqs,
 216                               struct virtqueue *vqs[],
 217                               vq_callback_t *callbacks[],
 218                               const char * const names[],
 219                               bool per_vq_vectors)
 220 {
 221         struct virtio_pci_device *vp_dev = to_vp_device(vdev);
 222         u16 msix_vec;
 223         int i, err, nvectors, allocated_vectors;
 224
 225         if (per_vq_vectors) {
 226                 /* Best option: one for change interrupt, one per vq. */
 227                 nvectors = 1;
 228                 for (i = 0; i < nvqs; ++i)
 229                         if (callbacks[i])
 230                                 ++nvectors;
 231         } else {
 232                 /* Second best: one for change, shared for all vqs. */
 233                 nvectors = 2;
 234         }
 235
 236         err = vp_request_msix_vectors(vdev, nvectors, per_vq_vectors);
 237         if (err)
 238                 goto error_find;
 239
 240         if (per_vq_vectors) {
 241                 vp_dev->msix_vector_map = kmalloc_array(nvqs,
 242                                 sizeof(*vp_dev->msix_vector_map), GFP_KERNEL);
 243                 if (!vp_dev->msix_vector_map)
 244                         goto error_find;
 245         }
 246
 247         allocated_vectors = vp_dev->msix_used_vectors;
 248         for (i = 0; i < nvqs; ++i) {
 249                 if (!names[i]) {
 250                         vqs[i] = NULL;
 251                         continue;
 252                 }
 253
 254                 if (!callbacks[i])
 255                         msix_vec = VIRTIO_MSI_NO_VECTOR;
 256                 else if (per_vq_vectors)
 257                         msix_vec = allocated_vectors++;
 258                 else
 259                         msix_vec = VP_MSIX_VQ_VECTOR;
 260                 vqs[i] = vp_dev->setup_vq(vp_dev, i, callbacks[i], names[i],
 261                                 msix_vec);
 262                 if (IS_ERR(vqs[i])) {
 263                         err = PTR_ERR(vqs[i]);
 264                         goto error_find;
 265                 }
 266
 267                 if (!per_vq_vectors)
 268                         continue;
 269
 270                 if (msix_vec == VIRTIO_MSI_NO_VECTOR) {
 271                         vp_dev->msix_vector_map[i] = VIRTIO_MSI_NO_VECTOR;
 272                         continue;
 273                 }
 274
 275                 /* allocate per-vq irq if available and necessary */
 276                 snprintf(vp_dev->msix_names[msix_vec],
 277                          sizeof *vp_dev->msix_names,
 278                          "%s-%s",
 279                          dev_name(&vp_dev->vdev.dev), names[i]);
 280                 err = request_irq(pci_irq_vector(vp_dev->pci_dev, msix_vec),
 281                                   vring_interrupt, 0,
 282                                   vp_dev->msix_names[msix_vec],
 283                                   vqs[i]);
 284                 if (err) {
 285                         /* don't free this irq on error */
 286                         vp_dev->msix_vector_map[i] = VIRTIO_MSI_NO_VECTOR;
 287                         goto error_find;
 288                 }
 289                 vp_dev->msix_vector_map[i] = msix_vec;
 290         }
 291         return 0;
 292
 293 error_find:
 294         vp_del_vqs(vdev);
 295         return err;
 296 }
 297
 298 static int vp_find_vqs_intx(struct virtio_device *vdev, unsigned nvqs,
 299                 struct virtqueue *vqs[], vq_callback_t *callbacks[],
 300                 const char * const names[])
 301 {
 302         struct virtio_pci_device *vp_dev = to_vp_device(vdev);
 303         int i, err;
 304
 305         err = request_irq(vp_dev->pci_dev->irq, vp_interrupt, IRQF_SHARED,
 306                         dev_name(&vdev->dev), vp_dev);
 307         if (err)
 308                 goto out_del_vqs;
 309
 310         vp_dev->intx_enabled = 1;
 311         for (i = 0; i < nvqs; ++i) {
 312                 if (!names[i]) {
 313                         vqs[i] = NULL;
 314                         continue;
 315                 }
 316                 vqs[i] = vp_dev->setup_vq(vp_dev, i, callbacks[i], names[i],
 317                                 VIRTIO_MSI_NO_VECTOR);
 318                 if (IS_ERR(vqs[i])) {
 319                         err = PTR_ERR(vqs[i]);
 320                         goto out_del_vqs;
 321                 }
 322         }
 323
 324         return 0;
 325 out_del_vqs:
 326         vp_del_vqs(vdev);
 327         return err;
 328 }
 329
 330 /* the config->find_vqs() implementation */
 331 int vp_find_vqs(struct virtio_device *vdev, unsigned nvqs,
 332                 struct virtqueue *vqs[],
 333                 vq_callback_t *callbacks[],
 334                 const char * const names[])
 335 {
 336         int err;
 337
 338         /* Try MSI-X with one vector per queue. */
 339         err = vp_find_vqs_msix(vdev, nvqs, vqs, callbacks, names, true);
 340         if (!err)
 341                 return 0;
 342         /* Fallback: MSI-X with one vector for config, one shared for queues. */
 343         err = vp_find_vqs_msix(vdev, nvqs, vqs, callbacks, names, false);
 344         if (!err)
 345                 return 0;
 346         /* Finally fall back to regular interrupts. */
 347         return vp_find_vqs_intx(vdev, nvqs, vqs, callbacks, names);
 348 }
 349
 350 const char *vp_bus_name(struct virtio_device *vdev)
 351 {
 352         struct virtio_pci_device *vp_dev = to_vp_device(vdev);
 353
 354         return pci_name(vp_dev->pci_dev);
 355 }
 356
 357 /* Setup the affinity for a virtqueue:
 358  * - force the affinity for per vq vector
 359  * - OR over all affinities for shared MSI
 360  * - ignore the affinity request if we're using INTX
 361  */
 362 int vp_set_vq_affinity(struct virtqueue *vq, int cpu)
 363 {
 364         struct virtio_device *vdev = vq->vdev;
 365         struct virtio_pci_device *vp_dev = to_vp_device(vdev);
 366
 367         if (!vq->callback)
 368                 return -EINVAL;
 369
 370         if (vp_dev->msix_enabled) {
 371                 int vec = vp_dev->msix_vector_map[vq->index];
 372                 struct cpumask *mask = vp_dev->msix_affinity_masks[vec];
 373                 unsigned int irq = pci_irq_vector(vp_dev->pci_dev, vec);
 374
 375                 if (cpu == -1)
 376                         irq_set_affinity_hint(irq, NULL);
 377                 else {
 378                         cpumask_clear(mask);
 379                         cpumask_set_cpu(cpu, mask);
 380                         irq_set_affinity_hint(irq, mask);
 381                 }
 382         }
 383         return 0;
 384 }
 385
 386 #ifdef CONFIG_PM_SLEEP
 387 static int virtio_pci_freeze(struct device *dev)
 388 {
 389         struct pci_dev *pci_dev = to_pci_dev(dev);
 390         struct virtio_pci_device *vp_dev = pci_get_drvdata(pci_dev);
 391         int ret;
 392
 393         ret = virtio_device_freeze(&vp_dev->vdev);
 394
 395         if (!ret)
 396                 pci_disable_device(pci_dev);
 397         return ret;
 398 }
 399
 400 static int virtio_pci_restore(struct device *dev)
 401 {
 402         struct pci_dev *pci_dev = to_pci_dev(dev);
 403         struct virtio_pci_device *vp_dev = pci_get_drvdata(pci_dev);
 404         int ret;
 405
 406         ret = pci_enable_device(pci_dev);
 407         if (ret)
 408                 return ret;
 409
 410         pci_set_master(pci_dev);
 411         return virtio_device_restore(&vp_dev->vdev);
 412 }
 413
 414 static const struct dev_pm_ops virtio_pci_pm_ops = {
 415         SET_SYSTEM_SLEEP_PM_OPS(virtio_pci_freeze, virtio_pci_restore)
 416 };
 417 #endif
 418
 419
 420 /* Qumranet donated their vendor ID for devices 0x1000 thru 0x10FF. */
 421 static const struct pci_device_id virtio_pci_id_table[] = {
 422         { PCI_DEVICE(PCI_VENDOR_ID_REDHAT_QUMRANET, PCI_ANY_ID) },
 423         { 0 }
 424 };
 425
 426 MODULE_DEVICE_TABLE(pci, virtio_pci_id_table);
 427
 428 static void virtio_pci_release_dev(struct device *_d)
 429 {
 430         struct virtio_device *vdev = dev_to_virtio(_d);
 431         struct virtio_pci_device *vp_dev = to_vp_device(vdev);
 432
 433         /* As struct device is a kobject, it's not safe to
 434          * free the memory (including the reference counter itself)
 435          * until it's release callback. */
 436         kfree(vp_dev);
 437 }
 438
 439 static int virtio_pci_probe(struct pci_dev *pci_dev,
 440                             const struct pci_device_id *id)
 441 {
 442         struct virtio_pci_device *vp_dev;
 443         int rc;
 444
 445         /* allocate our structure and fill it out */
 446         vp_dev = kzalloc(sizeof(struct virtio_pci_device), GFP_KERNEL);
 447         if (!vp_dev)
 448                 return -ENOMEM;
 449
 450         pci_set_drvdata(pci_dev, vp_dev);
 451         vp_dev->vdev.dev.parent = &pci_dev->dev;
 452         vp_dev->vdev.dev.release = virtio_pci_release_dev;
 453         vp_dev->pci_dev = pci_dev;
 454
 455         /* enable the device */
 456         rc = pci_enable_device(pci_dev);
 457         if (rc)
 458                 goto err_enable_device;
 459
 460         if (force_legacy) {
 461                 rc = virtio_pci_legacy_probe(vp_dev);
 462                 /* Also try modern mode if we can't map BAR0 (no IO space). */
 463                 if (rc == -ENODEV || rc == -ENOMEM)
 464                         rc = virtio_pci_modern_probe(vp_dev);
 465                 if (rc)
 466                         goto err_probe;
 467         } else {
 468                 rc = virtio_pci_modern_probe(vp_dev);
 469                 if (rc == -ENODEV)
 470                         rc = virtio_pci_legacy_probe(vp_dev);
 471                 if (rc)
 472                         goto err_probe;
 473         }
 474
 475         pci_set_master(pci_dev);
 476
 477         rc = register_virtio_device(&vp_dev->vdev);
 478         if (rc)
 479                 goto err_register;
 480
 481         return 0;
 482
 483 err_register:
 484         if (vp_dev->ioaddr)
 485              virtio_pci_legacy_remove(vp_dev);
 486         else
 487              virtio_pci_modern_remove(vp_dev);
 488 err_probe:
 489         pci_disable_device(pci_dev);
 490 err_enable_device:
 491         kfree(vp_dev);
 492         return rc;
 493 }
 494
 495 static void virtio_pci_remove(struct pci_dev *pci_dev)
 496 {
 497         struct virtio_pci_device *vp_dev = pci_get_drvdata(pci_dev);
 498         struct device *dev = get_device(&vp_dev->vdev.dev);
 499
 500         unregister_virtio_device(&vp_dev->vdev);
 501
 502         if (vp_dev->ioaddr)
 503                 virtio_pci_legacy_remove(vp_dev);
 504         else
 505                 virtio_pci_modern_remove(vp_dev);
 506
 507         pci_disable_device(pci_dev);
 508         put_device(dev);
 509 }
 510
 511 static struct pci_driver virtio_pci_driver = {
 512         .name           = "virtio-pci",
 513         .id_table       = virtio_pci_id_table,
 514         .probe          = virtio_pci_probe,
 515         .remove         = virtio_pci_remove,
 516 #ifdef CONFIG_PM_SLEEP
 517         .driver.pm      = &virtio_pci_pm_ops,
 518 #endif
 519 };
 520
 521 module_pci_driver(virtio_pci_driver);
 522
 523 MODULE_AUTHOR("Anthony Liguori <aliguori@us.ibm.com>");
 524 MODULE_DESCRIPTION("virtio-pci");
 525 MODULE_LICENSE("GPL");
 526 MODULE_VERSION("1");