2 * Copyright (c) 2016 Cisco and/or its affiliates.
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at:
7 * http://www.apache.org/licenses/LICENSE-2.0
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
16 * pci.c: Linux user space PCI bus management.
18 * Copyright (c) 2008 Eliot Dresselhaus
20 * Permission is hereby granted, free of charge, to any person obtaining
21 * a copy of this software and associated documentation files (the
22 * "Software"), to deal in the Software without restriction, including
23 * without limitation the rights to use, copy, modify, merge, publish,
24 * distribute, sublicense, and/or sell copies of the Software, and to
25 * permit persons to whom the Software is furnished to do so, subject to
26 * the following conditions:
28 * The above copyright notice and this permission notice shall be
29 * included in all copies or substantial portions of the Software.
31 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
32 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
33 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
34 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
35 * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
36 * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
37 * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
40 #include <vppinfra/linux/sysfs.h>
41 #include <vppinfra/bitmap.h>
42 #include <vppinfra/unix.h>
44 #include <vlib/vlib.h>
45 #include <vlib/pci/pci.h>
46 #include <vlib/unix/unix.h>
47 #include <vlib/linux/vfio.h>
49 #include <sys/types.h>
53 #include <sys/ioctl.h>
55 #include <linux/ethtool.h>
56 #include <linux/sockios.h>
57 #include <linux/vfio.h>
59 #include <sys/eventfd.h>
61 #define SYSFS_DEVICES_PCI "/sys/devices/pci"
62 static const char *sysfs_pci_dev_path = "/sys/bus/pci/devices";
63 static const char *sysfs_pci_drv_path = "/sys/bus/pci/drivers";
64 static char *sysfs_mod_vfio_noiommu =
65 "/sys/module/vfio/parameters/enable_unsafe_noiommu_mode";
67 VLIB_REGISTER_LOG_CLASS (pci_log, static) = {
69 .subclass_name = "linux",
72 #define log_debug(p, f, ...) \
73 vlib_log (VLIB_LOG_LEVEL_DEBUG, pci_log.class, "%U: " f, \
74 format_vlib_pci_log, p->handle, ##__VA_ARGS__)
75 #define log_err(p, f, ...) \
76 vlib_log (VLIB_LOG_LEVEL_ERR, pci_log.class, "%U: " f, format_vlib_pci_log, \
77 p->handle, ##__VA_ARGS__)
92 pci_intx_handler_function_t *intx_handler;
93 pci_msix_handler_function_t *msix_handler;
99 LINUX_PCI_DEVICE_TYPE_UNKNOWN,
100 LINUX_PCI_DEVICE_TYPE_UIO,
101 LINUX_PCI_DEVICE_TYPE_VFIO,
102 } linux_pci_device_type_t;
106 linux_pci_device_type_t type;
107 vlib_pci_dev_handle_t handle;
108 vlib_pci_addr_t addr;
111 /* Resource file descriptors. */
112 linux_pci_region_t *regions;
114 /* File descriptor for config space read/write. */
118 /* Device File descriptor */
121 /* read/write file descriptor for io bar */
125 /* Minor device for uio device. */
128 /* Interrupt handlers */
129 linux_pci_irq_t intx_irq;
130 linux_pci_irq_t *msix_irqs;
137 } linux_pci_device_t;
139 /* Pool of PCI devices. */
142 vlib_main_t *vlib_main;
143 linux_pci_device_t *linux_pci_devices;
147 extern linux_pci_main_t linux_pci_main;
149 static linux_pci_device_t *
150 linux_pci_get_device (vlib_pci_dev_handle_t h)
152 linux_pci_main_t *lpm = &linux_pci_main;
153 return pool_elt_at_index (lpm->linux_pci_devices, h);
157 vlib_pci_get_private_data (vlib_main_t * vm, vlib_pci_dev_handle_t h)
159 linux_pci_device_t *d = linux_pci_get_device (h);
160 return d->private_data;
164 vlib_pci_set_private_data (vlib_main_t * vm, vlib_pci_dev_handle_t h,
167 linux_pci_device_t *d = linux_pci_get_device (h);
168 d->private_data = private_data;
172 vlib_pci_get_addr (vlib_main_t * vm, vlib_pci_dev_handle_t h)
174 linux_pci_device_t *d = linux_pci_get_device (h);
179 vlib_pci_get_numa_node (vlib_main_t * vm, vlib_pci_dev_handle_t h)
181 linux_pci_device_t *d = linux_pci_get_device (h);
186 vlib_pci_get_num_msix_interrupts (vlib_main_t * vm, vlib_pci_dev_handle_t h)
188 linux_pci_device_t *d = linux_pci_get_device (h);
190 if (d->type == LINUX_PCI_DEVICE_TYPE_VFIO)
192 struct vfio_irq_info ii = { 0 };
194 ii.argsz = sizeof (struct vfio_irq_info);
195 ii.index = VFIO_PCI_MSIX_IRQ_INDEX;
196 if (ioctl (d->fd, VFIO_DEVICE_GET_IRQ_INFO, &ii) < 0)
203 /* Call to allocate/initialize the pci subsystem.
204 This is not an init function so that users can explicitly enable
205 pci only when it's needed. */
206 clib_error_t *pci_bus_init (vlib_main_t * vm);
208 linux_pci_main_t linux_pci_main;
210 vlib_pci_device_info_t *
211 vlib_pci_get_device_info (vlib_main_t * vm, vlib_pci_addr_t * addr,
212 clib_error_t ** error)
215 vlib_pci_device_info_t *di;
220 clib_bitmap_t *bmp = 0;
222 di = clib_mem_alloc (sizeof (vlib_pci_device_info_t));
223 clib_memset (di, 0, sizeof (vlib_pci_device_info_t));
224 di->addr.as_u32 = addr->as_u32;
226 u8 *dev_dir_name = format (0, "%s/%U", sysfs_pci_dev_path,
227 format_vlib_pci_addr, addr);
229 f = format (0, "%v/config%c", dev_dir_name, 0);
230 fd = open ((char *) f, O_RDWR);
232 /* Try read-only access if write fails. */
234 fd = open ((char *) f, O_RDONLY);
238 err = clib_error_return_unix (0, "open `%s'", f);
242 /* You can only read more that 64 bytes of config space as root; so we try to
243 read the full space but fall back to just the first 64 bytes. */
244 if (read (fd, &di->config, sizeof (di->config)) <
245 sizeof (vlib_pci_config_hdr_t))
247 err = clib_error_return_unix (0, "read `%s'", f);
253 vec_reset_length (f);
254 f = format (f, "%v/numa_node%c", dev_dir_name, 0);
255 err = clib_sysfs_read ((char *) f, "%d", &di->numa_node);
259 clib_error_free (err);
261 if (di->numa_node == -1)
263 bmp = os_get_online_cpu_node_bitmap ();
264 if (clib_bitmap_count_set_bits (bmp) == 1)
268 vec_reset_length (f);
269 f = format (f, "%v/class%c", dev_dir_name, 0);
270 err = clib_sysfs_read ((char *) f, "0x%x", &tmp);
273 di->device_class = tmp >> 8;
275 vec_reset_length (f);
276 f = format (f, "%v/vendor%c", dev_dir_name, 0);
277 err = clib_sysfs_read ((char *) f, "0x%x", &tmp);
282 vec_reset_length (f);
283 f = format (f, "%v/device%c", dev_dir_name, 0);
284 err = clib_sysfs_read ((char *) f, "0x%x", &tmp);
289 vec_reset_length (f);
290 f = format (f, "%v/revision%c", dev_dir_name, 0);
291 err = clib_sysfs_read ((char *) f, "0x%x", &tmp);
297 clib_file_get_resolved_basename ("%v/driver", dev_dir_name);
298 if (!di->driver_name)
299 di->driver_name = format (0, "<NONE>%c", 0);
301 di->iommu_group = -1;
302 tmpstr = clib_file_get_resolved_basename ("%v/iommu_group", dev_dir_name);
305 di->iommu_group = atoi ((char *) tmpstr);
309 vec_reset_length (f);
310 f = format (f, "%v/iommu_group/name%c", dev_dir_name, 0);
311 err = clib_sysfs_read ((char *) f, "%s", &tmpstr);
314 if (strncmp ((char *) tmpstr, "vfio-noiommu", 12) == 0)
315 di->flags |= VLIB_PCI_DEVICE_INFO_F_NOIOMMU;
319 clib_error_free (err);
323 vec_reset_length (f);
324 f = format (f, "%v/vpd%c", dev_dir_name, 0);
325 fd = open ((char *) f, O_RDONLY);
334 if (read (fd, &tag, 3) != 3)
337 if (tag[0] != 0x82 && tag[0] != 0x90 && tag[0] != 0x91)
340 len = (tag[2] << 8) | tag[1];
341 vec_validate (data, len - 1);
343 if (read (fd, data, len) != len)
349 di->product_name = data;
350 else if (tag[0] == 0x90)
352 else if (tag[0] == 0x91)
363 vlib_pci_free_device_info (di);
369 vec_free (dev_dir_name);
373 clib_error_free (err);
377 clib_error_t *__attribute__ ((weak))
378 vlib_pci_get_device_root_bus (vlib_pci_addr_t *addr, vlib_pci_addr_t *root_bus)
380 u8 *rel_path = 0, *abs_path = 0, *link_path = 0;
381 unformat_input_t input;
382 int fd = open (sysfs_pci_dev_path, O_RDONLY);
385 clib_error_t *err = NULL;
388 return clib_error_return_unix (0, "failed to open %s", sysfs_pci_dev_path);
390 vec_alloc (rel_path, PATH_MAX);
391 vec_alloc (abs_path, PATH_MAX);
394 format (0, "%s/%U", sysfs_pci_dev_path, format_vlib_pci_addr, addr);
395 size = readlinkat (fd, (char *) link_path, (char *) rel_path, PATH_MAX);
398 err = clib_error_return_unix (0, "failed to read %s", rel_path);
402 rel_path[size] = '\0';
403 vec_free (link_path);
405 link_path = format (0, "%s/%s", sysfs_pci_dev_path, rel_path);
406 if (!realpath ((char *) link_path, (char *) abs_path))
408 err = clib_error_return_unix (0, "failed to resolve %s", link_path);
412 unformat_init_string (&input, (char *) abs_path,
413 clib_strnlen ((char *) abs_path, PATH_MAX));
415 if (!unformat (&input, SYSFS_DEVICES_PCI "%x:%x/%s", &domain, &bus,
418 err = clib_error_return (0, "unknown input '%U'", format_unformat_error,
423 root_bus->domain = domain;
428 vec_free (link_path);
436 directory_exists (char *path)
438 struct stat s = { 0 };
439 if (stat (path, &s) == -1)
442 return S_ISDIR (s.st_mode);
446 vlib_pci_bind_to_uio (vlib_main_t *vm, vlib_pci_addr_t *addr,
447 char *uio_drv_name, int force)
449 clib_error_t *error = 0;
450 u8 *s = 0, *driver_name = 0;
453 vlib_pci_device_info_t *di;
454 int fd, clear_driver_override = 0;
455 u8 *dev_dir_name = format (0, "%s/%U", sysfs_pci_dev_path,
456 format_vlib_pci_addr, addr);
458 di = vlib_pci_get_device_info (vm, addr, &error);
463 if (strncmp ("auto", uio_drv_name, 5) == 0)
465 int vfio_pci_loaded = 0;
467 if (directory_exists ("/sys/module/vfio_pci"))
470 if (di->iommu_group != -1)
472 /* device is bound to IOMMU group */
473 if (!vfio_pci_loaded)
475 error = clib_error_return (0, "Skipping PCI device %U: device "
476 "is bound to IOMMU group and "
477 "vfio-pci driver is not loaded",
478 format_vlib_pci_addr, addr);
482 uio_drv_name = "vfio-pci";
486 /* device is not bound to IOMMU group so we have multiple options */
487 if (vfio_pci_loaded &&
488 (error = clib_sysfs_write (sysfs_mod_vfio_noiommu, "Y")) == 0)
489 uio_drv_name = "vfio-pci";
490 else if (directory_exists ("/sys/module/uio_pci_generic"))
491 uio_drv_name = "uio_pci_generic";
492 else if (directory_exists ("/sys/module/igb_uio"))
493 uio_drv_name = "igb_uio";
496 clib_error_free (error);
497 error = clib_error_return (0, "Skipping PCI device %U: missing "
498 "kernel VFIO or UIO driver",
499 format_vlib_pci_addr, addr);
502 clib_error_free (error);
506 driver_name = clib_file_get_resolved_basename ("%v/driver", dev_dir_name);
509 ((strcmp ("vfio-pci", (char *) driver_name) == 0) ||
510 (strcmp ("uio_pci_generic", (char *) driver_name) == 0) ||
511 (strcmp ("igb_uio", (char *) driver_name) == 0)))
516 /* walk trough all linux interfaces and if interface belonging to
517 this device is found check if interface is admin up */
518 dir = opendir ("/sys/class/net");
519 s = format (s, "%U%c", format_vlib_pci_addr, addr, 0);
523 error = clib_error_return (0,
524 "Skipping PCI device %U: failed to "
525 "read /sys/class/net",
526 format_vlib_pci_addr, addr);
530 fd = socket (PF_INET, SOCK_DGRAM, 0);
533 error = clib_error_return_unix (0, "socket");
537 while ((e = readdir (dir)))
540 struct ethtool_drvinfo drvinfo;
542 if (e->d_name[0] == '.') /* skip . and .. */
545 clib_memset (&ifr, 0, sizeof ifr);
546 clib_memset (&drvinfo, 0, sizeof drvinfo);
547 ifr.ifr_data = (char *) &drvinfo;
548 clib_strncpy (ifr.ifr_name, e->d_name, sizeof (ifr.ifr_name) - 1);
550 drvinfo.cmd = ETHTOOL_GDRVINFO;
551 if (ioctl (fd, SIOCETHTOOL, &ifr) < 0)
553 /* Some interfaces (eg "lo") don't support this ioctl */
554 if ((errno != ENOTSUP) && (errno != ENODEV))
555 clib_unix_warning ("ioctl fetch intf %s bus info error",
560 if (strcmp ((char *) s, drvinfo.bus_info))
563 clib_memset (&ifr, 0, sizeof (ifr));
564 clib_strncpy (ifr.ifr_name, e->d_name, sizeof (ifr.ifr_name) - 1);
566 if (ioctl (fd, SIOCGIFFLAGS, &ifr) < 0)
568 error = clib_error_return_unix (0, "ioctl fetch intf %s flags",
574 if (ifr.ifr_flags & IFF_UP)
576 vlib_log (VLIB_LOG_LEVEL_WARNING, pci_main.log_default,
577 "Skipping PCI device %U as host "
578 "interface %s is up",
579 format_vlib_pci_addr, addr, e->d_name);
586 vec_reset_length (s);
589 s = format (s, "%v/driver/unbind%c", dev_dir_name, 0);
590 clib_sysfs_write ((char *) s, "%U", format_vlib_pci_addr, addr);
591 vec_reset_length (s);
593 s = format (s, "%v/driver_override%c", dev_dir_name, 0);
594 if (access ((char *) s, F_OK) == 0)
596 clib_sysfs_write ((char *) s, "%s", uio_drv_name);
597 clear_driver_override = 1;
601 vec_reset_length (s);
602 s = format (s, "%s/%s/new_id%c", sysfs_pci_drv_path, uio_drv_name, 0);
603 clib_sysfs_write ((char *) s, "0x%04x 0x%04x", di->vendor_id,
606 vec_reset_length (s);
608 s = format (s, "%s/%s/bind%c", sysfs_pci_drv_path, uio_drv_name, 0);
609 clib_sysfs_write ((char *) s, "%U", format_vlib_pci_addr, addr);
610 vec_reset_length (s);
612 if (clear_driver_override)
614 s = format (s, "%v/driver_override%c", dev_dir_name, 0);
615 clib_sysfs_write ((char *) s, "%c", 0);
616 vec_reset_length (s);
623 vec_free (dev_dir_name);
624 vec_free (driver_name);
629 static clib_error_t *
630 scan_uio_dir (void *arg, u8 * path_name, u8 * file_name)
632 linux_pci_device_t *l = arg;
633 unformat_input_t input;
635 unformat_init_string (&input, (char *) file_name, vec_len (file_name));
637 if (!unformat (&input, "uio%d", &l->uio_minor))
640 unformat_free (&input);
644 static clib_error_t *
645 vfio_set_irqs (vlib_main_t * vm, linux_pci_device_t * p, u32 index, u32 start,
646 u32 count, u32 flags, int *efds)
648 int data_len = efds ? count * sizeof (int) : 0;
649 u8 buf[sizeof (struct vfio_irq_set) + data_len];
650 struct vfio_irq_set *irq_set = (struct vfio_irq_set *) buf;
654 int *data = (int *) irq_set->data;
655 flags |= VFIO_IRQ_SET_DATA_EVENTFD;
656 for (u32 i = 0; i < count; i++)
660 flags |= VFIO_IRQ_SET_DATA_NONE;
662 ASSERT ((flags & (VFIO_IRQ_SET_DATA_NONE | VFIO_IRQ_SET_DATA_EVENTFD)) !=
663 (VFIO_IRQ_SET_DATA_NONE | VFIO_IRQ_SET_DATA_EVENTFD));
665 irq_set->argsz = sizeof (struct vfio_irq_set) + data_len;
666 irq_set->index = index;
667 irq_set->start = start;
668 irq_set->count = count;
669 irq_set->flags = flags;
671 if (ioctl (p->fd, VFIO_DEVICE_SET_IRQS, irq_set) < 0)
672 return clib_error_return_unix (0, "%U:ioctl(VFIO_DEVICE_SET_IRQS)\n%U",
673 format_vlib_pci_addr, &p->addr,
674 format_vfio_irq_set, irq_set);
676 log_debug (p, "%s:\n%U", __func__, format_vfio_irq_set, irq_set);
680 static clib_error_t *
681 linux_pci_uio_read_ready (clib_file_t * uf)
683 vlib_main_t *vm = vlib_get_main ();
684 int __attribute__ ((unused)) rv;
685 vlib_pci_dev_handle_t h = uf->private_data;
686 linux_pci_device_t *p = linux_pci_get_device (h);
687 linux_pci_irq_t *irq = &p->intx_irq;
690 rv = read (uf->file_descriptor, &icount, 4);
692 if (irq->intx_handler)
693 irq->intx_handler (vm, h);
695 vlib_pci_intr_enable (vm, h);
697 return /* no error */ 0;
700 static clib_error_t *
701 linux_pci_vfio_unmask_intx (vlib_main_t * vm, linux_pci_device_t * d)
703 return vfio_set_irqs (vm, d, VFIO_PCI_INTX_IRQ_INDEX, 0, 1,
704 VFIO_IRQ_SET_ACTION_UNMASK, 0);
707 static clib_error_t *
708 linux_pci_uio_error_ready (clib_file_t * uf)
710 u32 error_index = (u32) uf->private_data;
712 return clib_error_return (0, "pci device %d: error", error_index);
715 static clib_error_t *
716 linux_pci_vfio_msix_read_ready (clib_file_t * uf)
718 vlib_main_t *vm = vlib_get_main ();
719 int __attribute__ ((unused)) rv;
720 vlib_pci_dev_handle_t h = uf->private_data >> 16;
721 u16 line = uf->private_data & 0xffff;
722 linux_pci_device_t *p = linux_pci_get_device (h);
723 linux_pci_irq_t *irq = vec_elt_at_index (p->msix_irqs, line);
726 rv = read (uf->file_descriptor, &icount, sizeof (icount));
728 if (irq->msix_handler)
729 irq->msix_handler (vm, h, line);
731 return /* no error */ 0;
734 static clib_error_t *
735 linux_pci_vfio_intx_read_ready (clib_file_t * uf)
737 vlib_main_t *vm = vlib_get_main ();
738 int __attribute__ ((unused)) rv;
739 vlib_pci_dev_handle_t h = uf->private_data;
740 linux_pci_device_t *p = linux_pci_get_device (h);
741 linux_pci_irq_t *irq = &p->intx_irq;
744 rv = read (uf->file_descriptor, &icount, sizeof (icount));
746 if (irq->intx_handler)
747 irq->intx_handler (vm, h);
749 linux_pci_vfio_unmask_intx (vm, p);
751 return /* no error */ 0;
754 static clib_error_t *
755 linux_pci_vfio_error_ready (clib_file_t * uf)
757 u32 error_index = (u32) uf->private_data;
759 return clib_error_return (0, "pci device %d: error", error_index);
762 static clib_error_t *
763 add_device_uio (vlib_main_t * vm, linux_pci_device_t * p,
764 vlib_pci_device_info_t * di, pci_device_registration_t * r)
766 linux_pci_main_t *lpm = &linux_pci_main;
767 clib_error_t *err = 0;
771 p->type = LINUX_PCI_DEVICE_TYPE_UIO;
773 s = format (s, "%s/%U/config%c", sysfs_pci_dev_path,
774 format_vlib_pci_addr, &di->addr, 0);
776 p->config_fd = open ((char *) s, O_RDWR);
777 p->config_offset = 0;
778 vec_reset_length (s);
780 if (p->config_fd == -1)
782 err = clib_error_return_unix (0, "open '%s'", s);
786 s = format (0, "%s/%U/uio%c", sysfs_pci_dev_path,
787 format_vlib_pci_addr, &di->addr, 0);
788 foreach_directory_file ((char *) s, scan_uio_dir, p, /* scan_dirs */
790 vec_reset_length (s);
792 s = format (s, "/dev/uio%d%c", p->uio_minor, 0);
793 p->fd = open ((char *) s, O_RDWR);
796 err = clib_error_return_unix (0, "open '%s'", s);
800 if (r && r->interrupt_handler)
801 vlib_pci_register_intx_handler (vm, p->handle, r->interrupt_handler);
803 if (r && r->init_function)
804 err = r->init_function (lpm->vlib_main, p->handle);
810 if (p->config_fd != -1)
811 close (p->config_fd);
819 vlib_pci_register_intx_handler (vlib_main_t * vm, vlib_pci_dev_handle_t h,
820 pci_intx_handler_function_t * intx_handler)
822 linux_pci_device_t *p = linux_pci_get_device (h);
823 clib_file_t t = { 0 };
824 linux_pci_irq_t *irq = &p->intx_irq;
825 ASSERT (irq->fd == -1);
827 if (p->type == LINUX_PCI_DEVICE_TYPE_VFIO)
829 struct vfio_irq_info ii = { 0 };
830 ii.argsz = sizeof (struct vfio_irq_info);
831 ii.index = VFIO_PCI_INTX_IRQ_INDEX;
832 if (ioctl (p->fd, VFIO_DEVICE_GET_IRQ_INFO, &ii) < 0)
833 return clib_error_return_unix (0, "ioctl(VFIO_DEVICE_GET_IRQ_INFO) '"
834 "%U'", format_vlib_pci_addr, &p->addr);
836 p, "%s index:%u count:%u flags: %s%s%s%s(0x%x)", __func__, ii.index,
837 ii.count, ii.flags & VFIO_IRQ_INFO_EVENTFD ? "eventfd " : "",
838 ii.flags & VFIO_IRQ_INFO_MASKABLE ? "maskable " : "",
839 ii.flags & VFIO_IRQ_INFO_AUTOMASKED ? "automasked " : "",
840 ii.flags & VFIO_IRQ_INFO_NORESIZE ? "noresize " : "", ii.flags);
842 return clib_error_return (0, "INTx interrupt does not exist on device"
843 "'%U'", format_vlib_pci_addr, &p->addr);
845 irq->fd = eventfd (0, EFD_NONBLOCK);
847 return clib_error_return_unix (0, "eventfd");
849 t.file_descriptor = irq->fd;
850 t.read_function = linux_pci_vfio_intx_read_ready;
852 else if (p->type == LINUX_PCI_DEVICE_TYPE_UIO)
854 t.file_descriptor = p->fd;
855 t.read_function = linux_pci_uio_read_ready;
860 t.error_function = linux_pci_uio_error_ready;
861 t.private_data = p->handle;
862 t.description = format (0, "PCI %U INTx", format_vlib_pci_addr, &p->addr);
863 irq->clib_file_index = clib_file_add (&file_main, &t);
864 irq->intx_handler = intx_handler;
869 vlib_pci_unregister_intx_handler (vlib_main_t *vm, vlib_pci_dev_handle_t h)
871 linux_pci_device_t *p = linux_pci_get_device (h);
872 linux_pci_irq_t *irq = &p->intx_irq;
874 if (irq->intx_handler == 0)
877 clib_file_del_by_index (&file_main, irq->clib_file_index);
878 if (p->type == LINUX_PCI_DEVICE_TYPE_VFIO)
884 irq->intx_handler = 0;
890 vlib_pci_register_msix_handler (vlib_main_t * vm, vlib_pci_dev_handle_t h,
891 u32 start, u32 count,
892 pci_msix_handler_function_t * msix_handler)
894 clib_error_t *err = 0;
895 linux_pci_device_t *p = linux_pci_get_device (h);
898 if (p->type != LINUX_PCI_DEVICE_TYPE_VFIO)
899 return clib_error_return (0, "vfio driver is needed for MSI-X interrupt "
902 vec_validate_init_empty (p->msix_irqs, start + count - 1, (linux_pci_irq_t)
905 for (i = start; i < start + count; i++)
907 clib_file_t t = { 0 };
908 linux_pci_irq_t *irq = vec_elt_at_index (p->msix_irqs, i);
909 ASSERT (irq->fd == -1);
911 irq->fd = eventfd (0, EFD_NONBLOCK);
914 err = clib_error_return_unix (0, "eventfd");
918 t.read_function = linux_pci_vfio_msix_read_ready;
919 t.file_descriptor = irq->fd;
920 t.error_function = linux_pci_vfio_error_ready;
921 t.private_data = p->handle << 16 | i;
922 t.description = format (0, "PCI %U MSI-X #%u", format_vlib_pci_addr,
924 irq->clib_file_index = clib_file_add (&file_main, &t);
925 irq->msix_handler = msix_handler;
933 linux_pci_irq_t *irq = vec_elt_at_index (p->msix_irqs, i);
936 clib_file_del_by_index (&file_main, irq->clib_file_index);
945 vlib_pci_unregister_msix_handler (vlib_main_t *vm, vlib_pci_dev_handle_t h,
946 u32 start, u32 count)
948 clib_error_t *err = 0;
949 linux_pci_device_t *p = linux_pci_get_device (h);
952 if (p->type != LINUX_PCI_DEVICE_TYPE_VFIO)
953 return clib_error_return (0, "vfio driver is needed for MSI-X interrupt "
956 for (i = start; i < start + count; i++)
958 linux_pci_irq_t *irq = vec_elt_at_index (p->msix_irqs, i);
962 clib_file_del_by_index (&file_main, irq->clib_file_index);
972 vlib_pci_enable_msix_irq (vlib_main_t * vm, vlib_pci_dev_handle_t h,
973 u16 start, u16 count)
975 linux_pci_device_t *p = linux_pci_get_device (h);
979 if (p->type != LINUX_PCI_DEVICE_TYPE_VFIO)
980 return clib_error_return (0, "vfio driver is needed for MSI-X interrupt "
983 for (i = 0; i < count; i++)
985 linux_pci_irq_t *irq = vec_elt_at_index (p->msix_irqs, start + i);
989 return vfio_set_irqs (vm, p, VFIO_PCI_MSIX_IRQ_INDEX, start, count,
990 VFIO_IRQ_SET_ACTION_TRIGGER, fds);
994 vlib_pci_get_msix_file_index (vlib_main_t * vm, vlib_pci_dev_handle_t h,
997 linux_pci_device_t *p = linux_pci_get_device (h);
998 linux_pci_irq_t *irq = vec_elt_at_index (p->msix_irqs, index);
1001 return irq->clib_file_index;
1005 vlib_pci_disable_msix_irq (vlib_main_t * vm, vlib_pci_dev_handle_t h,
1006 u16 start, u16 count)
1008 linux_pci_device_t *p = linux_pci_get_device (h);
1011 if (p->type != LINUX_PCI_DEVICE_TYPE_VFIO)
1012 return clib_error_return (0, "vfio driver is needed for MSI-X interrupt "
1015 for (i = start; i < start + count; i++)
1018 return vfio_set_irqs (vm, p, VFIO_PCI_MSIX_IRQ_INDEX, start, count,
1019 VFIO_IRQ_SET_ACTION_TRIGGER, fds);
1022 static clib_error_t *
1023 add_device_vfio (vlib_main_t * vm, linux_pci_device_t * p,
1024 vlib_pci_device_info_t * di, pci_device_registration_t * r)
1026 linux_pci_main_t *lpm = &linux_pci_main;
1027 struct vfio_device_info device_info = { 0 };
1028 struct vfio_region_info reg = { 0 };
1029 clib_error_t *err = 0;
1033 p->type = LINUX_PCI_DEVICE_TYPE_VFIO;
1035 if ((err = linux_vfio_group_get_device_fd (&p->addr, &p->fd, &is_noiommu)))
1038 if (is_noiommu == 0)
1039 p->supports_va_dma = 1;
1041 device_info.argsz = sizeof (device_info);
1042 if (ioctl (p->fd, VFIO_DEVICE_GET_INFO, &device_info) < 0)
1044 err = clib_error_return_unix (0, "ioctl(VFIO_DEVICE_GET_INFO) '%U'",
1045 format_vlib_pci_addr, &di->addr);
1049 reg.argsz = sizeof (struct vfio_region_info);
1050 reg.index = VFIO_PCI_CONFIG_REGION_INDEX;
1051 if (ioctl (p->fd, VFIO_DEVICE_GET_REGION_INFO, ®) < 0)
1053 err = clib_error_return_unix (0, "ioctl(VFIO_DEVICE_GET_INFO) '%U'",
1054 format_vlib_pci_addr, &di->addr);
1058 log_debug (p, "%s %U", __func__, format_vfio_region_info, ®);
1060 p->config_offset = reg.offset;
1061 p->config_fd = p->fd;
1063 /* reset if device supports it */
1064 if (device_info.flags & VFIO_DEVICE_FLAGS_RESET)
1065 if (ioctl (p->fd, VFIO_DEVICE_RESET) < 0)
1067 err = clib_error_return_unix (0, "ioctl(VFIO_DEVICE_RESET) '%U'",
1068 format_vlib_pci_addr, &di->addr);
1072 if (r && r->interrupt_handler)
1074 vlib_pci_register_intx_handler (vm, p->handle, r->interrupt_handler);
1075 linux_pci_vfio_unmask_intx (vm, p);
1078 if (p->supports_va_dma)
1080 vlib_buffer_pool_t *bp;
1081 vec_foreach (bp, vm->buffer_main->buffer_pools)
1084 vlib_physmem_map_t *pm;
1085 pm = vlib_physmem_get_map (vm, bp->physmem_map_index);
1086 for (i = 0; i < pm->n_pages; i++)
1087 vfio_map_physmem_page (vm, pm->base + (i << pm->log2_page_size));
1091 if (r && r->init_function)
1092 err = r->init_function (lpm->vlib_main, p->handle);
1100 if (p->config_fd != -1 && p->config_fd != p->fd)
1101 close (p->config_fd);
1102 p->config_fd = p->fd = -1;
1107 /* Configuration space read/write. */
1109 vlib_pci_read_write_config (vlib_main_t * vm, vlib_pci_dev_handle_t h,
1110 vlib_read_or_write_t read_or_write,
1111 uword address, void *data, u32 n_bytes)
1113 linux_pci_device_t *p = linux_pci_get_device (h);
1116 if (read_or_write == VLIB_READ)
1117 n = pread (p->config_fd, data, n_bytes, p->config_offset + address);
1119 n = pwrite (p->config_fd, data, n_bytes, p->config_offset + address);
1122 return clib_error_return_unix (0, "%s",
1123 read_or_write == VLIB_READ
1124 ? "read" : "write");
1129 static clib_error_t *
1130 vlib_pci_region (vlib_main_t * vm, vlib_pci_dev_handle_t h, u32 bar, int *fd,
1131 u64 * size, u64 * offset)
1133 linux_pci_device_t *p = linux_pci_get_device (h);
1134 clib_error_t *error = 0;
1136 u64 _size = 0, _offset = 0;
1142 if (p->type == LINUX_PCI_DEVICE_TYPE_UIO)
1145 struct stat stat_buf;
1146 file_name = format (0, "%s/%U/resource%d%c", sysfs_pci_dev_path,
1147 format_vlib_pci_addr, &p->addr, bar, 0);
1149 _fd = open ((char *) file_name, O_RDWR);
1152 error = clib_error_return_unix (0, "open `%s'", file_name);
1153 vec_free (file_name);
1157 if (fstat (_fd, &stat_buf) < 0)
1159 error = clib_error_return_unix (0, "fstat `%s'", file_name);
1160 vec_free (file_name);
1165 vec_free (file_name);
1166 _size = stat_buf.st_size;
1169 else if (p->type == LINUX_PCI_DEVICE_TYPE_VFIO)
1171 struct vfio_region_info *r;
1172 u32 sz = sizeof (struct vfio_region_info);
1174 r = clib_mem_alloc (sz);
1175 clib_memset (r, 0, sz);
1178 if (ioctl (p->fd, VFIO_DEVICE_GET_REGION_INFO, r) < 0)
1179 return clib_error_return_unix (0, "ioctl(VFIO_DEVICE_GET_INFO) "
1180 "'%U'", format_vlib_pci_addr,
1190 _offset = r->offset;
1191 log_debug (p, "%s %U", __func__, format_vfio_region_info, r);
1204 static clib_error_t *
1205 vlib_pci_map_region_int (vlib_main_t * vm, vlib_pci_dev_handle_t h,
1206 u32 bar, u8 * addr, void **result)
1208 linux_pci_device_t *p = linux_pci_get_device (h);
1210 clib_error_t *error;
1211 u64 size = 0, offset = 0;
1212 vlib_pci_config_reg_command_t command;
1214 log_debug (p, "map region %u to va %p", bar, addr);
1216 if ((error = vlib_pci_read_config_u16 (vm, h, 4, &command.as_u16)))
1219 if (!(command.mem_space))
1221 log_debug (p, "setting memory enable bit");
1222 command.mem_space = 1;
1223 if ((error = vlib_pci_write_config_u16 (vm, h, 4, &command.as_u16)))
1227 if ((error = vlib_pci_region (vm, h, bar, &fd, &size, &offset)))
1230 *result = clib_mem_vm_map_shared (addr, size, fd, offset,
1231 "PCIe %U region %u", format_vlib_pci_addr,
1232 vlib_pci_get_addr (vm, h), bar);
1233 if (*result == CLIB_MEM_VM_MAP_FAILED)
1235 error = clib_error_return_unix (0, "mmap `BAR%u'", bar);
1236 if (p->type == LINUX_PCI_DEVICE_TYPE_UIO && (fd != -1))
1241 vec_validate_init_empty (p->regions, bar,
1242 (linux_pci_region_t) { .fd = -1});
1243 if (p->type == LINUX_PCI_DEVICE_TYPE_UIO)
1244 p->regions[bar].fd = fd;
1245 p->regions[bar].addr = *result;
1246 p->regions[bar].size = size;
1251 vlib_pci_map_region (vlib_main_t * vm, vlib_pci_dev_handle_t h, u32 resource,
1254 return (vlib_pci_map_region_int (vm, h, resource, 0 /* addr */ , result));
1258 vlib_pci_map_region_fixed (vlib_main_t * vm, vlib_pci_dev_handle_t h,
1259 u32 resource, u8 * addr, void **result)
1261 return (vlib_pci_map_region_int (vm, h, resource, addr, result));
1265 vlib_pci_io_region (vlib_main_t * vm, vlib_pci_dev_handle_t h, u32 resource)
1267 linux_pci_device_t *p = linux_pci_get_device (h);
1268 clib_error_t *error = 0;
1270 u64 size = 0, offset = 0;
1272 if ((error = vlib_pci_region (vm, h, resource, &fd, &size, &offset)))
1276 p->io_offset = offset;
1281 vlib_pci_read_write_io (vlib_main_t * vm, vlib_pci_dev_handle_t h,
1282 vlib_read_or_write_t read_or_write,
1283 uword offset, void *data, u32 length)
1285 linux_pci_device_t *p = linux_pci_get_device (h);
1288 if (read_or_write == VLIB_READ)
1289 n = pread (p->io_fd, data, length, p->io_offset + offset);
1291 n = pwrite (p->io_fd, data, length, p->io_offset + offset);
1294 return clib_error_return_unix (0, "%s",
1295 read_or_write == VLIB_READ
1296 ? "read" : "write");
1301 vlib_pci_map_dma (vlib_main_t * vm, vlib_pci_dev_handle_t h, void *ptr)
1303 linux_pci_device_t *p = linux_pci_get_device (h);
1305 if (!p->supports_va_dma)
1308 return vfio_map_physmem_page (vm, ptr);
1312 vlib_pci_supports_virtual_addr_dma (vlib_main_t * vm, vlib_pci_dev_handle_t h)
1314 linux_pci_device_t *p = linux_pci_get_device (h);
1316 return p->supports_va_dma != 0;
1320 vlib_pci_device_open (vlib_main_t * vm, vlib_pci_addr_t * addr,
1321 pci_device_id_t ids[], vlib_pci_dev_handle_t * handle)
1323 linux_pci_main_t *lpm = &linux_pci_main;
1324 vlib_pci_device_info_t *di;
1325 linux_pci_device_t *p;
1326 clib_error_t *err = 0;
1329 di = vlib_pci_get_device_info (vm, addr, &err);
1336 for (i = ids; i->vendor_id != 0; i++)
1337 if (i->vendor_id == di->vendor_id && i->device_id == di->device_id)
1340 if (i->vendor_id == 0)
1342 vlib_pci_free_device_info (di);
1343 return clib_error_return (0, "Wrong vendor or device id");
1347 pool_get (lpm->linux_pci_devices, p);
1348 p->handle = p - lpm->linux_pci_devices;
1349 p->addr.as_u32 = di->addr.as_u32;
1350 p->intx_irq.fd = -1;
1351 p->intx_irq.clib_file_index = -1;
1352 p->numa_node = di->numa_node;
1354 * pci io bar read/write fd
1358 log_debug (p, "open vid:0x%04x did:0x%04x driver:%s iommu_group:%d",
1359 di->vendor_id, di->device_id, di->driver_name, di->iommu_group);
1361 if (clib_strncmp ("vfio-pci", (char *) di->driver_name, 8) == 0)
1362 err = add_device_vfio (vm, p, di, 0);
1363 else if (clib_strncmp ("uio_pci_generic", (char *) di->driver_name, 8) == 0)
1364 err = add_device_uio (vm, p, di, 0);
1366 err = clib_error_create ("device not bound to 'vfio-pci' or "
1367 "'uio_pci_generic' kernel module");
1371 *handle = p->handle;
1374 vlib_pci_free_device_info (di);
1377 log_err (p, "%U", format_clib_error, err);
1378 clib_memset (p, 0, sizeof (linux_pci_device_t));
1379 pool_put (lpm->linux_pci_devices, p);
1386 vlib_pci_device_close (vlib_main_t * vm, vlib_pci_dev_handle_t h)
1388 linux_pci_main_t *lpm = &linux_pci_main;
1389 linux_pci_device_t *p = linux_pci_get_device (h);
1390 linux_pci_irq_t *irq;
1391 linux_pci_region_t *res;
1392 clib_error_t *err = 0;
1394 if (p->type == LINUX_PCI_DEVICE_TYPE_UIO)
1397 if (irq->clib_file_index != -1)
1398 clib_file_del_by_index (&file_main, irq->clib_file_index);
1399 close (p->config_fd);
1403 else if (p->type == LINUX_PCI_DEVICE_TYPE_VFIO)
1406 /* close INTx irqs */
1409 err = vfio_set_irqs (vm, p, VFIO_PCI_INTX_IRQ_INDEX, 0, 0,
1410 VFIO_IRQ_SET_ACTION_TRIGGER, 0);
1411 clib_error_free (err);
1412 if (irq->clib_file_index != -1)
1413 clib_file_del_by_index (&file_main, irq->clib_file_index);
1417 /* close MSI-X irqs */
1418 if (vec_len (p->msix_irqs))
1420 err = vfio_set_irqs (vm, p, VFIO_PCI_MSIX_IRQ_INDEX, 0, 0,
1421 VFIO_IRQ_SET_ACTION_TRIGGER, 0);
1422 clib_error_free (err);
1423 vec_foreach (irq, p->msix_irqs)
1427 clib_file_del_by_index (&file_main, irq->clib_file_index);
1430 vec_free (p->msix_irqs);
1434 vec_foreach (res, p->regions)
1438 clib_mem_vm_unmap (res->addr);
1442 vec_free (p->regions);
1445 clib_memset (p, 0, sizeof (linux_pci_device_t));
1446 pool_put (lpm->linux_pci_devices, p);
1450 init_device_from_registered (vlib_main_t * vm, vlib_pci_device_info_t * di)
1452 vlib_pci_main_t *pm = &pci_main;
1453 linux_pci_main_t *lpm = &linux_pci_main;
1454 pci_device_registration_t *r;
1456 clib_error_t *err = 0;
1457 linux_pci_device_t *p;
1459 pool_get (lpm->linux_pci_devices, p);
1460 p->handle = p - lpm->linux_pci_devices;
1461 p->intx_irq.fd = -1;
1463 r = pm->pci_device_registrations;
1467 for (i = r->supported_devices; i->vendor_id != 0; i++)
1468 if (i->vendor_id == di->vendor_id && i->device_id == di->device_id)
1470 if (di->iommu_group != -1)
1471 err = add_device_vfio (vm, p, di, r);
1473 err = add_device_uio (vm, p, di, r);
1476 clib_error_report (err);
1480 r = r->next_registration;
1483 /* No driver, close the PCI config-space FD */
1484 clib_memset (p, 0, sizeof (linux_pci_device_t));
1485 pool_put (lpm->linux_pci_devices, p);
1488 static clib_error_t *
1489 scan_pci_addr (void *arg, u8 * dev_dir_name, u8 * ignored)
1491 vlib_pci_addr_t addr, **addrv = arg;
1492 unformat_input_t input;
1493 clib_error_t *err = 0;
1495 unformat_init_string (&input, (char *) dev_dir_name,
1496 vec_len (dev_dir_name));
1498 if (!unformat (&input, "/sys/bus/pci/devices/%U",
1499 unformat_vlib_pci_addr, &addr))
1500 err = clib_error_return (0, "unformat error `%v`", dev_dir_name);
1502 unformat_free (&input);
1507 vec_add1 (*addrv, addr);
1512 pci_addr_cmp (void *v1, void *v2)
1514 vlib_pci_addr_t *a1 = v1;
1515 vlib_pci_addr_t *a2 = v2;
1517 if (a1->domain > a2->domain)
1519 if (a1->domain < a2->domain)
1521 if (a1->bus > a2->bus)
1523 if (a1->bus < a2->bus)
1525 if (a1->slot > a2->slot)
1527 if (a1->slot < a2->slot)
1529 if (a1->function > a2->function)
1531 if (a1->function < a2->function)
1537 vlib_pci_get_all_dev_addrs ()
1539 vlib_pci_addr_t *addrs = 0;
1541 err = foreach_directory_file ((char *) sysfs_pci_dev_path, scan_pci_addr,
1542 &addrs, /* scan_dirs */ 0);
1549 vec_sort_with_function (addrs, pci_addr_cmp);
1555 linux_pci_init (vlib_main_t * vm)
1557 vlib_pci_main_t *pm = &pci_main;
1558 vlib_pci_addr_t *addr = 0, *addrs;
1562 ASSERT (sizeof (vlib_pci_addr_t) == sizeof (u32));
1564 addrs = vlib_pci_get_all_dev_addrs ();
1565 vec_foreach (addr, addrs)
1567 vlib_pci_device_info_t *d;
1568 if ((d = vlib_pci_get_device_info (vm, addr, 0)))
1570 init_device_from_registered (vm, d);
1571 vlib_pci_free_device_info (d);
1578 VLIB_INIT_FUNCTION (linux_pci_init) =
1580 .runs_after = VLIB_INITS("unix_input_init"),
1584 * fd.io coding-style-patch-verification: ON
1587 * eval: (c-set-style "gnu")