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>
42 #include <vlib/vlib.h>
43 #include <vlib/pci/pci.h>
44 #include <vlib/unix/unix.h>
45 #include <vlib/linux/vfio.h>
47 #include <sys/types.h>
51 #include <sys/ioctl.h>
53 #include <linux/ethtool.h>
54 #include <linux/sockios.h>
55 #include <linux/vfio.h>
56 #include <sys/eventfd.h>
58 #define SYSFS_DEVICES_PCI "/sys/devices/pci"
59 static const char *sysfs_pci_dev_path = "/sys/bus/pci/devices";
60 static const char *sysfs_pci_drv_path = "/sys/bus/pci/drivers";
61 static char *sysfs_mod_vfio_noiommu =
62 "/sys/module/vfio/parameters/enable_unsafe_noiommu_mode";
64 VLIB_REGISTER_LOG_CLASS (pci_log, static) = {
66 .subclass_name = "linux",
69 #define log_debug(p, f, ...) \
70 vlib_log (VLIB_LOG_LEVEL_DEBUG, pci_log.class, "%U: " f, \
71 format_vlib_pci_log, p->handle, ##__VA_ARGS__)
72 #define log_err(p, f, ...) \
73 vlib_log (VLIB_LOG_LEVEL_ERR, pci_log.class, "%U: " f, format_vlib_pci_log, \
74 p->handle, ##__VA_ARGS__)
89 pci_intx_handler_function_t *intx_handler;
90 pci_msix_handler_function_t *msix_handler;
96 LINUX_PCI_DEVICE_TYPE_UNKNOWN,
97 LINUX_PCI_DEVICE_TYPE_UIO,
98 LINUX_PCI_DEVICE_TYPE_VFIO,
99 } linux_pci_device_type_t;
103 linux_pci_device_type_t type;
104 vlib_pci_dev_handle_t handle;
105 vlib_pci_addr_t addr;
108 /* Resource file descriptors. */
109 linux_pci_region_t *regions;
111 /* File descriptor for config space read/write. */
115 /* Device File descriptor */
118 /* read/write file descriptor for io bar */
122 /* Minor device for uio device. */
125 /* Interrupt handlers */
126 linux_pci_irq_t intx_irq;
127 linux_pci_irq_t *msix_irqs;
134 } linux_pci_device_t;
136 /* Pool of PCI devices. */
139 vlib_main_t *vlib_main;
140 linux_pci_device_t *linux_pci_devices;
144 extern linux_pci_main_t linux_pci_main;
146 static linux_pci_device_t *
147 linux_pci_get_device (vlib_pci_dev_handle_t h)
149 linux_pci_main_t *lpm = &linux_pci_main;
150 return pool_elt_at_index (lpm->linux_pci_devices, h);
154 vlib_pci_get_private_data (vlib_main_t * vm, vlib_pci_dev_handle_t h)
156 linux_pci_device_t *d = linux_pci_get_device (h);
157 return d->private_data;
161 vlib_pci_set_private_data (vlib_main_t * vm, vlib_pci_dev_handle_t h,
164 linux_pci_device_t *d = linux_pci_get_device (h);
165 d->private_data = private_data;
169 vlib_pci_get_addr (vlib_main_t * vm, vlib_pci_dev_handle_t h)
171 linux_pci_device_t *d = linux_pci_get_device (h);
176 vlib_pci_get_numa_node (vlib_main_t * vm, vlib_pci_dev_handle_t h)
178 linux_pci_device_t *d = linux_pci_get_device (h);
183 vlib_pci_get_num_msix_interrupts (vlib_main_t * vm, vlib_pci_dev_handle_t h)
185 linux_pci_device_t *d = linux_pci_get_device (h);
187 if (d->type == LINUX_PCI_DEVICE_TYPE_VFIO)
189 struct vfio_irq_info ii = { 0 };
191 ii.argsz = sizeof (struct vfio_irq_info);
192 ii.index = VFIO_PCI_MSIX_IRQ_INDEX;
193 if (ioctl (d->fd, VFIO_DEVICE_GET_IRQ_INFO, &ii) < 0)
200 /* Call to allocate/initialize the pci subsystem.
201 This is not an init function so that users can explicitly enable
202 pci only when it's needed. */
203 clib_error_t *pci_bus_init (vlib_main_t * vm);
205 linux_pci_main_t linux_pci_main;
207 vlib_pci_device_info_t *
208 vlib_pci_get_device_info (vlib_main_t * vm, vlib_pci_addr_t * addr,
209 clib_error_t ** error)
212 vlib_pci_device_info_t *di;
217 clib_bitmap_t *bmp = 0;
219 di = clib_mem_alloc (sizeof (vlib_pci_device_info_t));
220 clib_memset (di, 0, sizeof (vlib_pci_device_info_t));
221 di->addr.as_u32 = addr->as_u32;
223 u8 *dev_dir_name = format (0, "%s/%U", sysfs_pci_dev_path,
224 format_vlib_pci_addr, addr);
226 f = format (0, "%v/config%c", dev_dir_name, 0);
227 fd = open ((char *) f, O_RDWR);
229 /* Try read-only access if write fails. */
231 fd = open ((char *) f, O_RDONLY);
235 err = clib_error_return_unix (0, "open `%s'", f);
239 /* You can only read more that 64 bytes of config space as root; so we try to
240 read the full space but fall back to just the first 64 bytes. */
241 if (read (fd, &di->config, sizeof (di->config)) < sizeof (di->config))
243 err = clib_error_return_unix (0, "read `%s'", f);
249 vec_reset_length (f);
250 f = format (f, "%v/numa_node%c", dev_dir_name, 0);
251 err = clib_sysfs_read ((char *) f, "%d", &di->numa_node);
255 clib_error_free (err);
257 if (di->numa_node == -1)
259 /* if '/sys/bus/pci/devices/<device id>/numa_node' returns -1 and
260 it is a SMP system, set numa_node to 0. */
261 if ((err = clib_sysfs_read ("/sys/devices/system/node/online", "%U",
262 unformat_bitmap_list, &bmp)))
263 clib_error_free (err);
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_info ii = { 0 };
651 struct vfio_irq_set *irq_set = (struct vfio_irq_set *) buf;
654 ii.argsz = sizeof (struct vfio_irq_info);
657 if (ioctl (p->fd, VFIO_DEVICE_GET_IRQ_INFO, &ii) < 0)
658 return clib_error_return_unix (0, "ioctl(VFIO_DEVICE_GET_IRQ_INFO) "
659 "'%U'", format_vlib_pci_addr, &p->addr);
661 log_debug (p, "%s index:%u count:%u flags: %s%s%s%s(0x%x)", __func__,
663 ii.flags & VFIO_IRQ_INFO_EVENTFD ? "eventfd " : "",
664 ii.flags & VFIO_IRQ_INFO_MASKABLE ? "maskable " : "",
665 ii.flags & VFIO_IRQ_INFO_AUTOMASKED ? "automasked " : "",
666 ii.flags & VFIO_IRQ_INFO_NORESIZE ? "noresize " : "", ii.flags);
668 if (ii.count < start + count)
669 return clib_error_return_unix (0, "vfio_set_irq: unexistng interrupt on "
670 "'%U'", format_vlib_pci_addr, &p->addr);
675 flags |= VFIO_IRQ_SET_DATA_EVENTFD;
676 clib_memcpy_fast (&irq_set->data, efds, data_len);
679 flags |= VFIO_IRQ_SET_DATA_NONE;
681 ASSERT ((flags & (VFIO_IRQ_SET_DATA_NONE | VFIO_IRQ_SET_DATA_EVENTFD)) !=
682 (VFIO_IRQ_SET_DATA_NONE | VFIO_IRQ_SET_DATA_EVENTFD));
684 irq_set->argsz = sizeof (struct vfio_irq_set) + data_len;
685 irq_set->index = index;
686 irq_set->start = start;
687 irq_set->count = count;
688 irq_set->flags = flags;
690 if (ioctl (p->fd, VFIO_DEVICE_SET_IRQS, irq_set) < 0)
691 return clib_error_return_unix (0, "%U:ioctl(VFIO_DEVICE_SET_IRQS) "
692 "[index = %u, start = %u, count = %u, "
694 format_vlib_pci_addr, &p->addr,
695 index, start, count, flags);
699 static clib_error_t *
700 linux_pci_uio_read_ready (clib_file_t * uf)
702 vlib_main_t *vm = vlib_get_main ();
703 int __attribute__ ((unused)) rv;
704 vlib_pci_dev_handle_t h = uf->private_data;
705 linux_pci_device_t *p = linux_pci_get_device (h);
706 linux_pci_irq_t *irq = &p->intx_irq;
709 rv = read (uf->file_descriptor, &icount, 4);
711 if (irq->intx_handler)
712 irq->intx_handler (vm, h);
714 vlib_pci_intr_enable (vm, h);
716 return /* no error */ 0;
719 static clib_error_t *
720 linux_pci_vfio_unmask_intx (vlib_main_t * vm, linux_pci_device_t * d)
722 return vfio_set_irqs (vm, d, VFIO_PCI_INTX_IRQ_INDEX, 0, 1,
723 VFIO_IRQ_SET_ACTION_UNMASK, 0);
726 static clib_error_t *
727 linux_pci_uio_error_ready (clib_file_t * uf)
729 u32 error_index = (u32) uf->private_data;
731 return clib_error_return (0, "pci device %d: error", error_index);
734 static clib_error_t *
735 linux_pci_vfio_msix_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 >> 16;
740 u16 line = uf->private_data & 0xffff;
741 linux_pci_device_t *p = linux_pci_get_device (h);
742 linux_pci_irq_t *irq = vec_elt_at_index (p->msix_irqs, line);
745 rv = read (uf->file_descriptor, &icount, sizeof (icount));
747 if (irq->msix_handler)
748 irq->msix_handler (vm, h, line);
750 return /* no error */ 0;
753 static clib_error_t *
754 linux_pci_vfio_intx_read_ready (clib_file_t * uf)
756 vlib_main_t *vm = vlib_get_main ();
757 int __attribute__ ((unused)) rv;
758 vlib_pci_dev_handle_t h = uf->private_data;
759 linux_pci_device_t *p = linux_pci_get_device (h);
760 linux_pci_irq_t *irq = &p->intx_irq;
763 rv = read (uf->file_descriptor, &icount, sizeof (icount));
765 if (irq->intx_handler)
766 irq->intx_handler (vm, h);
768 linux_pci_vfio_unmask_intx (vm, p);
770 return /* no error */ 0;
773 static clib_error_t *
774 linux_pci_vfio_error_ready (clib_file_t * uf)
776 u32 error_index = (u32) uf->private_data;
778 return clib_error_return (0, "pci device %d: error", error_index);
781 static clib_error_t *
782 add_device_uio (vlib_main_t * vm, linux_pci_device_t * p,
783 vlib_pci_device_info_t * di, pci_device_registration_t * r)
785 linux_pci_main_t *lpm = &linux_pci_main;
786 clib_error_t *err = 0;
790 p->type = LINUX_PCI_DEVICE_TYPE_UIO;
792 s = format (s, "%s/%U/config%c", sysfs_pci_dev_path,
793 format_vlib_pci_addr, &di->addr, 0);
795 p->config_fd = open ((char *) s, O_RDWR);
796 p->config_offset = 0;
797 vec_reset_length (s);
799 if (p->config_fd == -1)
801 err = clib_error_return_unix (0, "open '%s'", s);
805 s = format (0, "%s/%U/uio%c", sysfs_pci_dev_path,
806 format_vlib_pci_addr, &di->addr, 0);
807 foreach_directory_file ((char *) s, scan_uio_dir, p, /* scan_dirs */
809 vec_reset_length (s);
811 s = format (s, "/dev/uio%d%c", p->uio_minor, 0);
812 p->fd = open ((char *) s, O_RDWR);
815 err = clib_error_return_unix (0, "open '%s'", s);
819 if (r && r->interrupt_handler)
820 vlib_pci_register_intx_handler (vm, p->handle, r->interrupt_handler);
822 if (r && r->init_function)
823 err = r->init_function (lpm->vlib_main, p->handle);
829 if (p->config_fd != -1)
830 close (p->config_fd);
838 vlib_pci_register_intx_handler (vlib_main_t * vm, vlib_pci_dev_handle_t h,
839 pci_intx_handler_function_t * intx_handler)
841 linux_pci_device_t *p = linux_pci_get_device (h);
842 clib_file_t t = { 0 };
843 linux_pci_irq_t *irq = &p->intx_irq;
844 ASSERT (irq->fd == -1);
846 if (p->type == LINUX_PCI_DEVICE_TYPE_VFIO)
848 struct vfio_irq_info ii = { 0 };
849 ii.argsz = sizeof (struct vfio_irq_info);
850 ii.index = VFIO_PCI_INTX_IRQ_INDEX;
851 if (ioctl (p->fd, VFIO_DEVICE_GET_IRQ_INFO, &ii) < 0)
852 return clib_error_return_unix (0, "ioctl(VFIO_DEVICE_GET_IRQ_INFO) '"
853 "%U'", format_vlib_pci_addr, &p->addr);
855 p, "%s index:%u count:%u flags: %s%s%s%s(0x%x)", __func__, ii.index,
856 ii.count, ii.flags & VFIO_IRQ_INFO_EVENTFD ? "eventfd " : "",
857 ii.flags & VFIO_IRQ_INFO_MASKABLE ? "maskable " : "",
858 ii.flags & VFIO_IRQ_INFO_AUTOMASKED ? "automasked " : "",
859 ii.flags & VFIO_IRQ_INFO_NORESIZE ? "noresize " : "", ii.flags);
861 return clib_error_return (0, "INTx interrupt does not exist on device"
862 "'%U'", format_vlib_pci_addr, &p->addr);
864 irq->fd = eventfd (0, EFD_NONBLOCK);
866 return clib_error_return_unix (0, "eventfd");
868 t.file_descriptor = irq->fd;
869 t.read_function = linux_pci_vfio_intx_read_ready;
871 else if (p->type == LINUX_PCI_DEVICE_TYPE_UIO)
873 t.file_descriptor = p->fd;
874 t.read_function = linux_pci_uio_read_ready;
879 t.error_function = linux_pci_uio_error_ready;
880 t.private_data = p->handle;
881 t.description = format (0, "PCI %U INTx", format_vlib_pci_addr, &p->addr);
882 irq->clib_file_index = clib_file_add (&file_main, &t);
883 irq->intx_handler = intx_handler;
888 vlib_pci_register_msix_handler (vlib_main_t * vm, vlib_pci_dev_handle_t h,
889 u32 start, u32 count,
890 pci_msix_handler_function_t * msix_handler)
892 clib_error_t *err = 0;
893 linux_pci_device_t *p = linux_pci_get_device (h);
896 if (p->type != LINUX_PCI_DEVICE_TYPE_VFIO)
897 return clib_error_return (0, "vfio driver is needed for MSI-X interrupt "
901 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_enable_msix_irq (vlib_main_t * vm, vlib_pci_dev_handle_t h,
946 u16 start, u16 count)
948 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 return vfio_set_irqs (vm, p, VFIO_PCI_MSIX_IRQ_INDEX, start, count,
963 VFIO_IRQ_SET_ACTION_TRIGGER, fds);
967 vlib_pci_get_msix_file_index (vlib_main_t * vm, vlib_pci_dev_handle_t h,
970 linux_pci_device_t *p = linux_pci_get_device (h);
971 linux_pci_irq_t *irq = vec_elt_at_index (p->msix_irqs, index);
974 return irq->clib_file_index;
978 vlib_pci_disable_msix_irq (vlib_main_t * vm, vlib_pci_dev_handle_t h,
979 u16 start, u16 count)
981 linux_pci_device_t *p = linux_pci_get_device (h);
984 if (p->type != LINUX_PCI_DEVICE_TYPE_VFIO)
985 return clib_error_return (0, "vfio driver is needed for MSI-X interrupt "
988 for (i = start; i < start + count; i++)
991 return vfio_set_irqs (vm, p, VFIO_PCI_MSIX_IRQ_INDEX, start, count,
992 VFIO_IRQ_SET_ACTION_TRIGGER, fds);
995 static clib_error_t *
996 add_device_vfio (vlib_main_t * vm, linux_pci_device_t * p,
997 vlib_pci_device_info_t * di, pci_device_registration_t * r)
999 linux_pci_main_t *lpm = &linux_pci_main;
1000 struct vfio_device_info device_info = { 0 };
1001 struct vfio_region_info reg = { 0 };
1002 clib_error_t *err = 0;
1006 p->type = LINUX_PCI_DEVICE_TYPE_VFIO;
1008 if ((err = linux_vfio_group_get_device_fd (&p->addr, &p->fd, &is_noiommu)))
1011 if (is_noiommu == 0)
1012 p->supports_va_dma = 1;
1014 device_info.argsz = sizeof (device_info);
1015 if (ioctl (p->fd, VFIO_DEVICE_GET_INFO, &device_info) < 0)
1017 err = clib_error_return_unix (0, "ioctl(VFIO_DEVICE_GET_INFO) '%U'",
1018 format_vlib_pci_addr, &di->addr);
1022 reg.argsz = sizeof (struct vfio_region_info);
1023 reg.index = VFIO_PCI_CONFIG_REGION_INDEX;
1024 if (ioctl (p->fd, VFIO_DEVICE_GET_REGION_INFO, ®) < 0)
1026 err = clib_error_return_unix (0, "ioctl(VFIO_DEVICE_GET_INFO) '%U'",
1027 format_vlib_pci_addr, &di->addr);
1031 log_debug (p, "%s %U", __func__, format_vfio_region_info, ®);
1033 p->config_offset = reg.offset;
1034 p->config_fd = p->fd;
1036 /* reset if device supports it */
1037 if (device_info.flags & VFIO_DEVICE_FLAGS_RESET)
1038 if (ioctl (p->fd, VFIO_DEVICE_RESET) < 0)
1040 err = clib_error_return_unix (0, "ioctl(VFIO_DEVICE_RESET) '%U'",
1041 format_vlib_pci_addr, &di->addr);
1045 if (r && r->interrupt_handler)
1047 vlib_pci_register_intx_handler (vm, p->handle, r->interrupt_handler);
1048 linux_pci_vfio_unmask_intx (vm, p);
1051 if (p->supports_va_dma)
1053 vlib_buffer_pool_t *bp;
1055 vec_foreach (bp, vm->buffer_main->buffer_pools)
1058 vlib_physmem_map_t *pm;
1059 pm = vlib_physmem_get_map (vm, bp->physmem_map_index);
1060 for (i = 0; i < pm->n_pages; i++)
1061 vfio_map_physmem_page (vm, pm->base + (i << pm->log2_page_size));
1066 if (r && r->init_function)
1067 err = r->init_function (lpm->vlib_main, p->handle);
1075 if (p->config_fd != -1 && p->config_fd != p->fd)
1076 close (p->config_fd);
1077 p->config_fd = p->fd = -1;
1082 /* Configuration space read/write. */
1084 vlib_pci_read_write_config (vlib_main_t * vm, vlib_pci_dev_handle_t h,
1085 vlib_read_or_write_t read_or_write,
1086 uword address, void *data, u32 n_bytes)
1088 linux_pci_device_t *p = linux_pci_get_device (h);
1091 if (read_or_write == VLIB_READ)
1092 n = pread (p->config_fd, data, n_bytes, p->config_offset + address);
1094 n = pwrite (p->config_fd, data, n_bytes, p->config_offset + address);
1097 return clib_error_return_unix (0, "%s",
1098 read_or_write == VLIB_READ
1099 ? "read" : "write");
1104 static clib_error_t *
1105 vlib_pci_region (vlib_main_t * vm, vlib_pci_dev_handle_t h, u32 bar, int *fd,
1106 u64 * size, u64 * offset)
1108 linux_pci_device_t *p = linux_pci_get_device (h);
1109 clib_error_t *error = 0;
1111 u64 _size = 0, _offset = 0;
1117 if (p->type == LINUX_PCI_DEVICE_TYPE_UIO)
1120 struct stat stat_buf;
1121 file_name = format (0, "%s/%U/resource%d%c", sysfs_pci_dev_path,
1122 format_vlib_pci_addr, &p->addr, bar, 0);
1124 _fd = open ((char *) file_name, O_RDWR);
1127 error = clib_error_return_unix (0, "open `%s'", file_name);
1128 vec_free (file_name);
1132 if (fstat (_fd, &stat_buf) < 0)
1134 error = clib_error_return_unix (0, "fstat `%s'", file_name);
1135 vec_free (file_name);
1140 vec_free (file_name);
1141 _size = stat_buf.st_size;
1144 else if (p->type == LINUX_PCI_DEVICE_TYPE_VFIO)
1146 struct vfio_region_info *r;
1147 u32 sz = sizeof (struct vfio_region_info);
1149 r = clib_mem_alloc (sz);
1150 clib_memset (r, 0, sz);
1153 if (ioctl (p->fd, VFIO_DEVICE_GET_REGION_INFO, r) < 0)
1154 return clib_error_return_unix (0, "ioctl(VFIO_DEVICE_GET_INFO) "
1155 "'%U'", format_vlib_pci_addr,
1165 _offset = r->offset;
1166 log_debug (p, "%s %U", __func__, format_vfio_region_info, r);
1179 static clib_error_t *
1180 vlib_pci_map_region_int (vlib_main_t * vm, vlib_pci_dev_handle_t h,
1181 u32 bar, u8 * addr, void **result)
1183 linux_pci_device_t *p = linux_pci_get_device (h);
1185 clib_error_t *error;
1186 u64 size = 0, offset = 0;
1187 vlib_pci_config_reg_command_t command;
1189 log_debug (p, "map region %u to va %p", bar, addr);
1191 if ((error = vlib_pci_read_config_u16 (vm, h, 4, &command.as_u16)))
1194 if (!(command.mem_space))
1196 log_debug (p, "setting memory enable bit");
1197 command.mem_space = 1;
1198 if ((error = vlib_pci_write_config_u16 (vm, h, 4, &command.as_u16)))
1202 if ((error = vlib_pci_region (vm, h, bar, &fd, &size, &offset)))
1205 *result = clib_mem_vm_map_shared (addr, size, fd, offset,
1206 "PCIe %U region %u", format_vlib_pci_addr,
1207 vlib_pci_get_addr (vm, h), bar);
1208 if (*result == CLIB_MEM_VM_MAP_FAILED)
1210 error = clib_error_return_unix (0, "mmap `BAR%u'", bar);
1211 if (p->type == LINUX_PCI_DEVICE_TYPE_UIO && (fd != -1))
1217 vec_validate_init_empty (p->regions, bar,
1218 (linux_pci_region_t) { .fd = -1});
1220 if (p->type == LINUX_PCI_DEVICE_TYPE_UIO)
1221 p->regions[bar].fd = fd;
1222 p->regions[bar].addr = *result;
1223 p->regions[bar].size = size;
1228 vlib_pci_map_region (vlib_main_t * vm, vlib_pci_dev_handle_t h, u32 resource,
1231 return (vlib_pci_map_region_int (vm, h, resource, 0 /* addr */ , result));
1235 vlib_pci_map_region_fixed (vlib_main_t * vm, vlib_pci_dev_handle_t h,
1236 u32 resource, u8 * addr, void **result)
1238 return (vlib_pci_map_region_int (vm, h, resource, addr, result));
1242 vlib_pci_io_region (vlib_main_t * vm, vlib_pci_dev_handle_t h, u32 resource)
1244 linux_pci_device_t *p = linux_pci_get_device (h);
1245 clib_error_t *error = 0;
1247 u64 size = 0, offset = 0;
1249 if ((error = vlib_pci_region (vm, h, resource, &fd, &size, &offset)))
1253 p->io_offset = offset;
1258 vlib_pci_read_write_io (vlib_main_t * vm, vlib_pci_dev_handle_t h,
1259 vlib_read_or_write_t read_or_write,
1260 uword offset, void *data, u32 length)
1262 linux_pci_device_t *p = linux_pci_get_device (h);
1265 if (read_or_write == VLIB_READ)
1266 n = pread (p->io_fd, data, length, p->io_offset + offset);
1268 n = pwrite (p->io_fd, data, length, p->io_offset + offset);
1271 return clib_error_return_unix (0, "%s",
1272 read_or_write == VLIB_READ
1273 ? "read" : "write");
1278 vlib_pci_map_dma (vlib_main_t * vm, vlib_pci_dev_handle_t h, void *ptr)
1280 linux_pci_device_t *p = linux_pci_get_device (h);
1282 if (!p->supports_va_dma)
1285 return vfio_map_physmem_page (vm, ptr);
1289 vlib_pci_supports_virtual_addr_dma (vlib_main_t * vm, vlib_pci_dev_handle_t h)
1291 linux_pci_device_t *p = linux_pci_get_device (h);
1293 return p->supports_va_dma != 0;
1297 vlib_pci_device_open (vlib_main_t * vm, vlib_pci_addr_t * addr,
1298 pci_device_id_t ids[], vlib_pci_dev_handle_t * handle)
1300 linux_pci_main_t *lpm = &linux_pci_main;
1301 vlib_pci_device_info_t *di;
1302 linux_pci_device_t *p;
1303 clib_error_t *err = 0;
1306 di = vlib_pci_get_device_info (vm, addr, &err);
1313 for (i = ids; i->vendor_id != 0; i++)
1314 if (i->vendor_id == di->vendor_id && i->device_id == di->device_id)
1317 if (i->vendor_id == 0)
1319 vlib_pci_free_device_info (di);
1320 return clib_error_return (0, "Wrong vendor or device id");
1324 pool_get (lpm->linux_pci_devices, p);
1325 p->handle = p - lpm->linux_pci_devices;
1326 p->addr.as_u32 = di->addr.as_u32;
1327 p->intx_irq.fd = -1;
1328 p->intx_irq.clib_file_index = -1;
1329 p->numa_node = di->numa_node;
1331 * pci io bar read/write fd
1335 log_debug (p, "open vid:0x%04x did:0x%04x driver:%s iommu_group:%d",
1336 di->vendor_id, di->device_id, di->driver_name, di->iommu_group);
1338 if (clib_strncmp ("vfio-pci", (char *) di->driver_name, 8) == 0)
1339 err = add_device_vfio (vm, p, di, 0);
1340 else if (clib_strncmp ("uio_pci_generic", (char *) di->driver_name, 8) == 0)
1341 err = add_device_uio (vm, p, di, 0);
1343 err = clib_error_create ("device not bound to 'vfio-pci' or "
1344 "'uio_pci_generic' kernel module");
1348 *handle = p->handle;
1351 vlib_pci_free_device_info (di);
1354 log_err (p, "%U", format_clib_error, err);
1355 clib_memset (p, 0, sizeof (linux_pci_device_t));
1356 pool_put (lpm->linux_pci_devices, p);
1363 vlib_pci_device_close (vlib_main_t * vm, vlib_pci_dev_handle_t h)
1365 linux_pci_main_t *lpm = &linux_pci_main;
1366 linux_pci_device_t *p = linux_pci_get_device (h);
1367 linux_pci_irq_t *irq;
1368 linux_pci_region_t *res;
1369 clib_error_t *err = 0;
1371 if (p->type == LINUX_PCI_DEVICE_TYPE_UIO)
1374 if (irq->clib_file_index != -1)
1375 clib_file_del_by_index (&file_main, irq->clib_file_index);
1376 close (p->config_fd);
1380 else if (p->type == LINUX_PCI_DEVICE_TYPE_VFIO)
1383 /* close INTx irqs */
1386 err = vfio_set_irqs (vm, p, VFIO_PCI_INTX_IRQ_INDEX, 0, 0,
1387 VFIO_IRQ_SET_ACTION_TRIGGER, 0);
1388 clib_error_free (err);
1389 if (irq->clib_file_index != -1)
1390 clib_file_del_by_index (&file_main, irq->clib_file_index);
1394 /* close MSI-X irqs */
1395 if (vec_len (p->msix_irqs))
1397 err = vfio_set_irqs (vm, p, VFIO_PCI_MSIX_IRQ_INDEX, 0, 0,
1398 VFIO_IRQ_SET_ACTION_TRIGGER, 0);
1399 clib_error_free (err);
1401 vec_foreach (irq, p->msix_irqs)
1405 clib_file_del_by_index (&file_main, irq->clib_file_index);
1409 vec_free (p->msix_irqs);
1414 vec_foreach (res, p->regions)
1418 clib_mem_vm_unmap (res->addr);
1423 vec_free (p->regions);
1426 clib_memset (p, 0, sizeof (linux_pci_device_t));
1427 pool_put (lpm->linux_pci_devices, p);
1431 init_device_from_registered (vlib_main_t * vm, vlib_pci_device_info_t * di)
1433 vlib_pci_main_t *pm = &pci_main;
1434 linux_pci_main_t *lpm = &linux_pci_main;
1435 pci_device_registration_t *r;
1437 clib_error_t *err = 0;
1438 linux_pci_device_t *p;
1440 pool_get (lpm->linux_pci_devices, p);
1441 p->handle = p - lpm->linux_pci_devices;
1442 p->intx_irq.fd = -1;
1444 r = pm->pci_device_registrations;
1448 for (i = r->supported_devices; i->vendor_id != 0; i++)
1449 if (i->vendor_id == di->vendor_id && i->device_id == di->device_id)
1451 if (di->iommu_group != -1)
1452 err = add_device_vfio (vm, p, di, r);
1454 err = add_device_uio (vm, p, di, r);
1457 clib_error_report (err);
1461 r = r->next_registration;
1464 /* No driver, close the PCI config-space FD */
1465 clib_memset (p, 0, sizeof (linux_pci_device_t));
1466 pool_put (lpm->linux_pci_devices, p);
1469 static clib_error_t *
1470 scan_pci_addr (void *arg, u8 * dev_dir_name, u8 * ignored)
1472 vlib_pci_addr_t addr, **addrv = arg;
1473 unformat_input_t input;
1474 clib_error_t *err = 0;
1476 unformat_init_string (&input, (char *) dev_dir_name,
1477 vec_len (dev_dir_name));
1479 if (!unformat (&input, "/sys/bus/pci/devices/%U",
1480 unformat_vlib_pci_addr, &addr))
1481 err = clib_error_return (0, "unformat error `%v`", dev_dir_name);
1483 unformat_free (&input);
1488 vec_add1 (*addrv, addr);
1493 pci_addr_cmp (void *v1, void *v2)
1495 vlib_pci_addr_t *a1 = v1;
1496 vlib_pci_addr_t *a2 = v2;
1498 if (a1->domain > a2->domain)
1500 if (a1->domain < a2->domain)
1502 if (a1->bus > a2->bus)
1504 if (a1->bus < a2->bus)
1506 if (a1->slot > a2->slot)
1508 if (a1->slot < a2->slot)
1510 if (a1->function > a2->function)
1512 if (a1->function < a2->function)
1518 vlib_pci_get_all_dev_addrs ()
1520 vlib_pci_addr_t *addrs = 0;
1522 err = foreach_directory_file ((char *) sysfs_pci_dev_path, scan_pci_addr,
1523 &addrs, /* scan_dirs */ 0);
1530 vec_sort_with_function (addrs, pci_addr_cmp);
1536 linux_pci_init (vlib_main_t * vm)
1538 vlib_pci_main_t *pm = &pci_main;
1539 vlib_pci_addr_t *addr = 0, *addrs;
1543 ASSERT (sizeof (vlib_pci_addr_t) == sizeof (u32));
1545 addrs = vlib_pci_get_all_dev_addrs ();
1547 vec_foreach (addr, addrs)
1549 vlib_pci_device_info_t *d;
1550 if ((d = vlib_pci_get_device_info (vm, addr, 0)))
1552 init_device_from_registered (vm, d);
1553 vlib_pci_free_device_info (d);
1562 VLIB_INIT_FUNCTION (linux_pci_init) =
1564 .runs_after = VLIB_INITS("unix_input_init"),
1569 * fd.io coding-style-patch-verification: ON
1572 * eval: (c-set-style "gnu")