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>
58 #include <sys/eventfd.h>
60 #define SYSFS_DEVICES_PCI "/sys/devices/pci"
61 static const char *sysfs_pci_dev_path = "/sys/bus/pci/devices";
62 static const char *sysfs_pci_drv_path = "/sys/bus/pci/drivers";
63 static char *sysfs_mod_vfio_noiommu =
64 "/sys/module/vfio/parameters/enable_unsafe_noiommu_mode";
66 VLIB_REGISTER_LOG_CLASS (pci_log, static) = {
68 .subclass_name = "linux",
71 #define log_debug(p, f, ...) \
72 vlib_log (VLIB_LOG_LEVEL_DEBUG, pci_log.class, "%U: " f, \
73 format_vlib_pci_log, p->handle, ##__VA_ARGS__)
74 #define log_err(p, f, ...) \
75 vlib_log (VLIB_LOG_LEVEL_ERR, pci_log.class, "%U: " f, format_vlib_pci_log, \
76 p->handle, ##__VA_ARGS__)
91 pci_intx_handler_function_t *intx_handler;
92 pci_msix_handler_function_t *msix_handler;
98 LINUX_PCI_DEVICE_TYPE_UNKNOWN,
99 LINUX_PCI_DEVICE_TYPE_UIO,
100 LINUX_PCI_DEVICE_TYPE_VFIO,
101 } linux_pci_device_type_t;
105 linux_pci_device_type_t type;
106 vlib_pci_dev_handle_t handle;
107 vlib_pci_addr_t addr;
110 /* Resource file descriptors. */
111 linux_pci_region_t *regions;
113 /* File descriptor for config space read/write. */
117 /* Device File descriptor */
120 /* read/write file descriptor for io bar */
124 /* Minor device for uio device. */
127 /* Interrupt handlers */
128 linux_pci_irq_t intx_irq;
129 linux_pci_irq_t *msix_irqs;
136 } linux_pci_device_t;
138 /* Pool of PCI devices. */
141 vlib_main_t *vlib_main;
142 linux_pci_device_t *linux_pci_devices;
146 extern linux_pci_main_t linux_pci_main;
148 static linux_pci_device_t *
149 linux_pci_get_device (vlib_pci_dev_handle_t h)
151 linux_pci_main_t *lpm = &linux_pci_main;
152 return pool_elt_at_index (lpm->linux_pci_devices, h);
156 vlib_pci_get_private_data (vlib_main_t * vm, vlib_pci_dev_handle_t h)
158 linux_pci_device_t *d = linux_pci_get_device (h);
159 return d->private_data;
163 vlib_pci_set_private_data (vlib_main_t * vm, vlib_pci_dev_handle_t h,
166 linux_pci_device_t *d = linux_pci_get_device (h);
167 d->private_data = private_data;
171 vlib_pci_get_addr (vlib_main_t * vm, vlib_pci_dev_handle_t h)
173 linux_pci_device_t *d = linux_pci_get_device (h);
178 vlib_pci_get_numa_node (vlib_main_t * vm, vlib_pci_dev_handle_t h)
180 linux_pci_device_t *d = linux_pci_get_device (h);
185 vlib_pci_get_num_msix_interrupts (vlib_main_t * vm, vlib_pci_dev_handle_t h)
187 linux_pci_device_t *d = linux_pci_get_device (h);
189 if (d->type == LINUX_PCI_DEVICE_TYPE_VFIO)
191 struct vfio_irq_info ii = { 0 };
193 ii.argsz = sizeof (struct vfio_irq_info);
194 ii.index = VFIO_PCI_MSIX_IRQ_INDEX;
195 if (ioctl (d->fd, VFIO_DEVICE_GET_IRQ_INFO, &ii) < 0)
202 /* Call to allocate/initialize the pci subsystem.
203 This is not an init function so that users can explicitly enable
204 pci only when it's needed. */
205 clib_error_t *pci_bus_init (vlib_main_t * vm);
207 linux_pci_main_t linux_pci_main;
209 vlib_pci_device_info_t *
210 vlib_pci_get_device_info (vlib_main_t * vm, vlib_pci_addr_t * addr,
211 clib_error_t ** error)
214 vlib_pci_device_info_t *di;
219 clib_bitmap_t *bmp = 0;
221 di = clib_mem_alloc (sizeof (vlib_pci_device_info_t));
222 clib_memset (di, 0, sizeof (vlib_pci_device_info_t));
223 di->addr.as_u32 = addr->as_u32;
225 u8 *dev_dir_name = format (0, "%s/%U", sysfs_pci_dev_path,
226 format_vlib_pci_addr, addr);
228 f = format (0, "%v/config%c", dev_dir_name, 0);
229 fd = open ((char *) f, O_RDWR);
231 /* Try read-only access if write fails. */
233 fd = open ((char *) f, O_RDONLY);
237 err = clib_error_return_unix (0, "open `%s'", f);
241 /* You can only read more that 64 bytes of config space as root; so we try to
242 read the full space but fall back to just the first 64 bytes. */
243 if (read (fd, &di->config, sizeof (di->config)) <
244 sizeof (vlib_pci_config_hdr_t))
246 err = clib_error_return_unix (0, "read `%s'", f);
252 vec_reset_length (f);
253 f = format (f, "%v/numa_node%c", dev_dir_name, 0);
254 err = clib_sysfs_read ((char *) f, "%d", &di->numa_node);
258 clib_error_free (err);
260 if (di->numa_node == -1)
262 bmp = os_get_online_cpu_node_bitmap ();
263 if (clib_bitmap_count_set_bits (bmp) == 1)
267 vec_reset_length (f);
268 f = format (f, "%v/class%c", dev_dir_name, 0);
269 err = clib_sysfs_read ((char *) f, "0x%x", &tmp);
272 di->device_class = tmp >> 8;
274 vec_reset_length (f);
275 f = format (f, "%v/vendor%c", dev_dir_name, 0);
276 err = clib_sysfs_read ((char *) f, "0x%x", &tmp);
281 vec_reset_length (f);
282 f = format (f, "%v/device%c", dev_dir_name, 0);
283 err = clib_sysfs_read ((char *) f, "0x%x", &tmp);
288 vec_reset_length (f);
289 f = format (f, "%v/revision%c", dev_dir_name, 0);
290 err = clib_sysfs_read ((char *) f, "0x%x", &tmp);
296 clib_file_get_resolved_basename ("%v/driver", dev_dir_name);
297 if (!di->driver_name)
298 di->driver_name = format (0, "<NONE>%c", 0);
300 di->iommu_group = -1;
301 tmpstr = clib_file_get_resolved_basename ("%v/iommu_group", dev_dir_name);
304 di->iommu_group = atoi ((char *) tmpstr);
308 vec_reset_length (f);
309 f = format (f, "%v/iommu_group/name%c", dev_dir_name, 0);
310 err = clib_sysfs_read ((char *) f, "%s", &tmpstr);
313 if (strncmp ((char *) tmpstr, "vfio-noiommu", 12) == 0)
314 di->flags |= VLIB_PCI_DEVICE_INFO_F_NOIOMMU;
318 clib_error_free (err);
322 vec_reset_length (f);
323 f = format (f, "%v/vpd%c", dev_dir_name, 0);
324 fd = open ((char *) f, O_RDONLY);
333 if (read (fd, &tag, 3) != 3)
336 if (tag[0] != 0x82 && tag[0] != 0x90 && tag[0] != 0x91)
339 len = (tag[2] << 8) | tag[1];
340 vec_validate (data, len - 1);
342 if (read (fd, data, len) != len)
348 di->product_name = data;
349 else if (tag[0] == 0x90)
351 else if (tag[0] == 0x91)
362 vlib_pci_free_device_info (di);
368 vec_free (dev_dir_name);
372 clib_error_free (err);
376 clib_error_t *__attribute__ ((weak))
377 vlib_pci_get_device_root_bus (vlib_pci_addr_t *addr, vlib_pci_addr_t *root_bus)
379 u8 *rel_path = 0, *abs_path = 0, *link_path = 0;
380 unformat_input_t input;
381 int fd = open (sysfs_pci_dev_path, O_RDONLY);
384 clib_error_t *err = NULL;
387 return clib_error_return_unix (0, "failed to open %s", sysfs_pci_dev_path);
389 vec_alloc (rel_path, PATH_MAX);
390 vec_alloc (abs_path, PATH_MAX);
393 format (0, "%s/%U", sysfs_pci_dev_path, format_vlib_pci_addr, addr);
394 size = readlinkat (fd, (char *) link_path, (char *) rel_path, PATH_MAX);
397 err = clib_error_return_unix (0, "failed to read %s", rel_path);
401 rel_path[size] = '\0';
402 vec_free (link_path);
404 link_path = format (0, "%s/%s", sysfs_pci_dev_path, rel_path);
405 if (!realpath ((char *) link_path, (char *) abs_path))
407 err = clib_error_return_unix (0, "failed to resolve %s", link_path);
411 unformat_init_string (&input, (char *) abs_path,
412 clib_strnlen ((char *) abs_path, PATH_MAX));
414 if (!unformat (&input, SYSFS_DEVICES_PCI "%x:%x/%s", &domain, &bus,
417 err = clib_error_return (0, "unknown input '%U'", format_unformat_error,
422 root_bus->domain = domain;
427 vec_free (link_path);
435 directory_exists (char *path)
437 struct stat s = { 0 };
438 if (stat (path, &s) == -1)
441 return S_ISDIR (s.st_mode);
445 vlib_pci_bind_to_uio (vlib_main_t *vm, vlib_pci_addr_t *addr,
446 char *uio_drv_name, int force)
448 clib_error_t *error = 0;
449 u8 *s = 0, *driver_name = 0;
452 vlib_pci_device_info_t *di;
453 int fd, clear_driver_override = 0;
454 u8 *dev_dir_name = format (0, "%s/%U", sysfs_pci_dev_path,
455 format_vlib_pci_addr, addr);
457 di = vlib_pci_get_device_info (vm, addr, &error);
462 if (strncmp ("auto", uio_drv_name, 5) == 0)
464 int vfio_pci_loaded = 0;
466 if (directory_exists ("/sys/module/vfio_pci"))
469 if (di->iommu_group != -1)
471 /* device is bound to IOMMU group */
472 if (!vfio_pci_loaded)
474 error = clib_error_return (0, "Skipping PCI device %U: device "
475 "is bound to IOMMU group and "
476 "vfio-pci driver is not loaded",
477 format_vlib_pci_addr, addr);
481 uio_drv_name = "vfio-pci";
485 /* device is not bound to IOMMU group so we have multiple options */
486 if (vfio_pci_loaded &&
487 (error = clib_sysfs_write (sysfs_mod_vfio_noiommu, "Y")) == 0)
488 uio_drv_name = "vfio-pci";
489 else if (directory_exists ("/sys/module/uio_pci_generic"))
490 uio_drv_name = "uio_pci_generic";
491 else if (directory_exists ("/sys/module/igb_uio"))
492 uio_drv_name = "igb_uio";
495 clib_error_free (error);
496 error = clib_error_return (0, "Skipping PCI device %U: missing "
497 "kernel VFIO or UIO driver",
498 format_vlib_pci_addr, addr);
501 clib_error_free (error);
505 driver_name = clib_file_get_resolved_basename ("%v/driver", dev_dir_name);
508 ((strcmp ("vfio-pci", (char *) driver_name) == 0) ||
509 (strcmp ("uio_pci_generic", (char *) driver_name) == 0) ||
510 (strcmp ("igb_uio", (char *) driver_name) == 0)))
515 /* walk trough all linux interfaces and if interface belonging to
516 this device is found check if interface is admin up */
517 dir = opendir ("/sys/class/net");
518 s = format (s, "%U%c", format_vlib_pci_addr, addr, 0);
522 error = clib_error_return (0,
523 "Skipping PCI device %U: failed to "
524 "read /sys/class/net",
525 format_vlib_pci_addr, addr);
529 fd = socket (PF_INET, SOCK_DGRAM, 0);
532 error = clib_error_return_unix (0, "socket");
536 while ((e = readdir (dir)))
539 struct ethtool_drvinfo drvinfo;
541 if (e->d_name[0] == '.') /* skip . and .. */
544 clib_memset (&ifr, 0, sizeof ifr);
545 clib_memset (&drvinfo, 0, sizeof drvinfo);
546 ifr.ifr_data = (char *) &drvinfo;
547 clib_strncpy (ifr.ifr_name, e->d_name, sizeof (ifr.ifr_name) - 1);
549 drvinfo.cmd = ETHTOOL_GDRVINFO;
550 if (ioctl (fd, SIOCETHTOOL, &ifr) < 0)
552 /* Some interfaces (eg "lo") don't support this ioctl */
553 if ((errno != ENOTSUP) && (errno != ENODEV))
554 clib_unix_warning ("ioctl fetch intf %s bus info error",
559 if (strcmp ((char *) s, drvinfo.bus_info))
562 clib_memset (&ifr, 0, sizeof (ifr));
563 clib_strncpy (ifr.ifr_name, e->d_name, sizeof (ifr.ifr_name) - 1);
565 if (ioctl (fd, SIOCGIFFLAGS, &ifr) < 0)
567 error = clib_error_return_unix (0, "ioctl fetch intf %s flags",
573 if (ifr.ifr_flags & IFF_UP)
575 vlib_log (VLIB_LOG_LEVEL_WARNING, pci_main.log_default,
576 "Skipping PCI device %U as host "
577 "interface %s is up",
578 format_vlib_pci_addr, addr, e->d_name);
585 vec_reset_length (s);
588 s = format (s, "%v/driver/unbind%c", dev_dir_name, 0);
589 clib_sysfs_write ((char *) s, "%U", format_vlib_pci_addr, addr);
590 vec_reset_length (s);
592 s = format (s, "%v/driver_override%c", dev_dir_name, 0);
593 if (access ((char *) s, F_OK) == 0)
595 clib_sysfs_write ((char *) s, "%s", uio_drv_name);
596 clear_driver_override = 1;
600 vec_reset_length (s);
601 s = format (s, "%s/%s/new_id%c", sysfs_pci_drv_path, uio_drv_name, 0);
602 clib_sysfs_write ((char *) s, "0x%04x 0x%04x", di->vendor_id,
605 vec_reset_length (s);
607 s = format (s, "%s/%s/bind%c", sysfs_pci_drv_path, uio_drv_name, 0);
608 clib_sysfs_write ((char *) s, "%U", format_vlib_pci_addr, addr);
609 vec_reset_length (s);
611 if (clear_driver_override)
613 s = format (s, "%v/driver_override%c", dev_dir_name, 0);
614 clib_sysfs_write ((char *) s, "%c", 0);
615 vec_reset_length (s);
622 vec_free (dev_dir_name);
623 vec_free (driver_name);
628 static clib_error_t *
629 scan_uio_dir (void *arg, u8 * path_name, u8 * file_name)
631 linux_pci_device_t *l = arg;
632 unformat_input_t input;
634 unformat_init_string (&input, (char *) file_name, vec_len (file_name));
636 if (!unformat (&input, "uio%d", &l->uio_minor))
639 unformat_free (&input);
643 static clib_error_t *
644 vfio_set_irqs (vlib_main_t * vm, linux_pci_device_t * p, u32 index, u32 start,
645 u32 count, u32 flags, int *efds)
647 int data_len = efds ? count * sizeof (int) : 0;
648 u8 buf[sizeof (struct vfio_irq_set) + data_len];
649 struct vfio_irq_set *irq_set = (struct vfio_irq_set *) buf;
653 int *data = (int *) irq_set->data;
654 flags |= VFIO_IRQ_SET_DATA_EVENTFD;
655 for (u32 i = 0; i < count; i++)
659 flags |= VFIO_IRQ_SET_DATA_NONE;
661 ASSERT ((flags & (VFIO_IRQ_SET_DATA_NONE | VFIO_IRQ_SET_DATA_EVENTFD)) !=
662 (VFIO_IRQ_SET_DATA_NONE | VFIO_IRQ_SET_DATA_EVENTFD));
664 irq_set->argsz = sizeof (struct vfio_irq_set) + data_len;
665 irq_set->index = index;
666 irq_set->start = start;
667 irq_set->count = count;
668 irq_set->flags = flags;
670 if (ioctl (p->fd, VFIO_DEVICE_SET_IRQS, irq_set) < 0)
671 return clib_error_return_unix (0, "%U:ioctl(VFIO_DEVICE_SET_IRQS)\n%U",
672 format_vlib_pci_addr, &p->addr,
673 format_vfio_irq_set, irq_set);
675 log_debug (p, "%s:\n%U", __func__, format_vfio_irq_set, irq_set);
679 static clib_error_t *
680 linux_pci_uio_read_ready (clib_file_t * uf)
682 vlib_main_t *vm = vlib_get_main ();
683 int __attribute__ ((unused)) rv;
684 vlib_pci_dev_handle_t h = uf->private_data;
685 linux_pci_device_t *p = linux_pci_get_device (h);
686 linux_pci_irq_t *irq = &p->intx_irq;
689 rv = read (uf->file_descriptor, &icount, 4);
691 if (irq->intx_handler)
692 irq->intx_handler (vm, h);
694 vlib_pci_intr_enable (vm, h);
696 return /* no error */ 0;
699 static clib_error_t *
700 linux_pci_vfio_unmask_intx (vlib_main_t * vm, linux_pci_device_t * d)
702 return vfio_set_irqs (vm, d, VFIO_PCI_INTX_IRQ_INDEX, 0, 1,
703 VFIO_IRQ_SET_ACTION_UNMASK, 0);
706 static clib_error_t *
707 linux_pci_uio_error_ready (clib_file_t * uf)
709 u32 error_index = (u32) uf->private_data;
711 return clib_error_return (0, "pci device %d: error", error_index);
714 static clib_error_t *
715 linux_pci_vfio_msix_read_ready (clib_file_t * uf)
717 vlib_main_t *vm = vlib_get_main ();
718 int __attribute__ ((unused)) rv;
719 vlib_pci_dev_handle_t h = uf->private_data >> 16;
720 u16 line = uf->private_data & 0xffff;
721 linux_pci_device_t *p = linux_pci_get_device (h);
722 linux_pci_irq_t *irq = vec_elt_at_index (p->msix_irqs, line);
725 rv = read (uf->file_descriptor, &icount, sizeof (icount));
727 if (irq->msix_handler)
728 irq->msix_handler (vm, h, line);
730 return /* no error */ 0;
733 static clib_error_t *
734 linux_pci_vfio_intx_read_ready (clib_file_t * uf)
736 vlib_main_t *vm = vlib_get_main ();
737 int __attribute__ ((unused)) rv;
738 vlib_pci_dev_handle_t h = uf->private_data;
739 linux_pci_device_t *p = linux_pci_get_device (h);
740 linux_pci_irq_t *irq = &p->intx_irq;
743 rv = read (uf->file_descriptor, &icount, sizeof (icount));
745 if (irq->intx_handler)
746 irq->intx_handler (vm, h);
748 linux_pci_vfio_unmask_intx (vm, p);
750 return /* no error */ 0;
753 static clib_error_t *
754 linux_pci_vfio_error_ready (clib_file_t * uf)
756 u32 error_index = (u32) uf->private_data;
758 return clib_error_return (0, "pci device %d: error", error_index);
761 static clib_error_t *
762 add_device_uio (vlib_main_t * vm, linux_pci_device_t * p,
763 vlib_pci_device_info_t * di, pci_device_registration_t * r)
765 linux_pci_main_t *lpm = &linux_pci_main;
766 clib_error_t *err = 0;
770 p->type = LINUX_PCI_DEVICE_TYPE_UIO;
772 s = format (s, "%s/%U/config%c", sysfs_pci_dev_path,
773 format_vlib_pci_addr, &di->addr, 0);
775 p->config_fd = open ((char *) s, O_RDWR);
776 p->config_offset = 0;
777 vec_reset_length (s);
779 if (p->config_fd == -1)
781 err = clib_error_return_unix (0, "open '%s'", s);
785 s = format (0, "%s/%U/uio%c", sysfs_pci_dev_path,
786 format_vlib_pci_addr, &di->addr, 0);
787 foreach_directory_file ((char *) s, scan_uio_dir, p, /* scan_dirs */
789 vec_reset_length (s);
791 s = format (s, "/dev/uio%d%c", p->uio_minor, 0);
792 p->fd = open ((char *) s, O_RDWR);
795 err = clib_error_return_unix (0, "open '%s'", s);
799 if (r && r->interrupt_handler)
800 vlib_pci_register_intx_handler (vm, p->handle, r->interrupt_handler);
802 if (r && r->init_function)
803 err = r->init_function (lpm->vlib_main, p->handle);
809 if (p->config_fd != -1)
810 close (p->config_fd);
818 vlib_pci_register_intx_handler (vlib_main_t * vm, vlib_pci_dev_handle_t h,
819 pci_intx_handler_function_t * intx_handler)
821 linux_pci_device_t *p = linux_pci_get_device (h);
822 clib_file_t t = { 0 };
823 linux_pci_irq_t *irq = &p->intx_irq;
824 ASSERT (irq->fd == -1);
826 if (p->type == LINUX_PCI_DEVICE_TYPE_VFIO)
828 struct vfio_irq_info ii = { 0 };
829 ii.argsz = sizeof (struct vfio_irq_info);
830 ii.index = VFIO_PCI_INTX_IRQ_INDEX;
831 if (ioctl (p->fd, VFIO_DEVICE_GET_IRQ_INFO, &ii) < 0)
832 return clib_error_return_unix (0, "ioctl(VFIO_DEVICE_GET_IRQ_INFO) '"
833 "%U'", format_vlib_pci_addr, &p->addr);
835 p, "%s index:%u count:%u flags: %s%s%s%s(0x%x)", __func__, ii.index,
836 ii.count, ii.flags & VFIO_IRQ_INFO_EVENTFD ? "eventfd " : "",
837 ii.flags & VFIO_IRQ_INFO_MASKABLE ? "maskable " : "",
838 ii.flags & VFIO_IRQ_INFO_AUTOMASKED ? "automasked " : "",
839 ii.flags & VFIO_IRQ_INFO_NORESIZE ? "noresize " : "", ii.flags);
841 return clib_error_return (0, "INTx interrupt does not exist on device"
842 "'%U'", format_vlib_pci_addr, &p->addr);
844 irq->fd = eventfd (0, EFD_NONBLOCK);
846 return clib_error_return_unix (0, "eventfd");
848 t.file_descriptor = irq->fd;
849 t.read_function = linux_pci_vfio_intx_read_ready;
851 else if (p->type == LINUX_PCI_DEVICE_TYPE_UIO)
853 t.file_descriptor = p->fd;
854 t.read_function = linux_pci_uio_read_ready;
859 t.error_function = linux_pci_uio_error_ready;
860 t.private_data = p->handle;
861 t.description = format (0, "PCI %U INTx", format_vlib_pci_addr, &p->addr);
862 irq->clib_file_index = clib_file_add (&file_main, &t);
863 irq->intx_handler = intx_handler;
868 vlib_pci_unregister_intx_handler (vlib_main_t *vm, vlib_pci_dev_handle_t h)
870 linux_pci_device_t *p = linux_pci_get_device (h);
871 linux_pci_irq_t *irq = &p->intx_irq;
873 if (irq->intx_handler == 0)
876 clib_file_del_by_index (&file_main, irq->clib_file_index);
877 if (p->type == LINUX_PCI_DEVICE_TYPE_VFIO)
883 irq->intx_handler = 0;
889 vlib_pci_register_msix_handler (vlib_main_t * vm, vlib_pci_dev_handle_t h,
890 u32 start, u32 count,
891 pci_msix_handler_function_t * msix_handler)
893 clib_error_t *err = 0;
894 linux_pci_device_t *p = linux_pci_get_device (h);
897 if (p->type != LINUX_PCI_DEVICE_TYPE_VFIO)
898 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)
904 for (i = start; i < start + count; i++)
906 clib_file_t t = { 0 };
907 linux_pci_irq_t *irq = vec_elt_at_index (p->msix_irqs, i);
908 ASSERT (irq->fd == -1);
910 irq->fd = eventfd (0, EFD_NONBLOCK);
913 err = clib_error_return_unix (0, "eventfd");
917 t.read_function = linux_pci_vfio_msix_read_ready;
918 t.file_descriptor = irq->fd;
919 t.error_function = linux_pci_vfio_error_ready;
920 t.private_data = p->handle << 16 | i;
921 t.description = format (0, "PCI %U MSI-X #%u", format_vlib_pci_addr,
923 irq->clib_file_index = clib_file_add (&file_main, &t);
924 irq->msix_handler = msix_handler;
932 linux_pci_irq_t *irq = vec_elt_at_index (p->msix_irqs, i);
935 clib_file_del_by_index (&file_main, irq->clib_file_index);
944 vlib_pci_unregister_msix_handler (vlib_main_t *vm, vlib_pci_dev_handle_t h,
945 u32 start, u32 count)
947 clib_error_t *err = 0;
948 linux_pci_device_t *p = linux_pci_get_device (h);
951 if (p->type != LINUX_PCI_DEVICE_TYPE_VFIO)
952 return clib_error_return (0, "vfio driver is needed for MSI-X interrupt "
955 for (i = start; i < start + count; i++)
957 linux_pci_irq_t *irq = vec_elt_at_index (p->msix_irqs, i);
961 clib_file_del_by_index (&file_main, irq->clib_file_index);
971 vlib_pci_enable_msix_irq (vlib_main_t * vm, vlib_pci_dev_handle_t h,
972 u16 start, u16 count)
974 linux_pci_device_t *p = linux_pci_get_device (h);
978 if (p->type != LINUX_PCI_DEVICE_TYPE_VFIO)
979 return clib_error_return (0, "vfio driver is needed for MSI-X interrupt "
982 for (i = 0; i < count; i++)
984 linux_pci_irq_t *irq = vec_elt_at_index (p->msix_irqs, start + i);
988 return vfio_set_irqs (vm, p, VFIO_PCI_MSIX_IRQ_INDEX, start, count,
989 VFIO_IRQ_SET_ACTION_TRIGGER, fds);
993 vlib_pci_get_msix_file_index (vlib_main_t * vm, vlib_pci_dev_handle_t h,
996 linux_pci_device_t *p = linux_pci_get_device (h);
997 linux_pci_irq_t *irq = vec_elt_at_index (p->msix_irqs, index);
1000 return irq->clib_file_index;
1004 vlib_pci_disable_msix_irq (vlib_main_t * vm, vlib_pci_dev_handle_t h,
1005 u16 start, u16 count)
1007 linux_pci_device_t *p = linux_pci_get_device (h);
1010 if (p->type != LINUX_PCI_DEVICE_TYPE_VFIO)
1011 return clib_error_return (0, "vfio driver is needed for MSI-X interrupt "
1014 for (i = start; i < start + count; i++)
1017 return vfio_set_irqs (vm, p, VFIO_PCI_MSIX_IRQ_INDEX, start, count,
1018 VFIO_IRQ_SET_ACTION_TRIGGER, fds);
1021 static clib_error_t *
1022 add_device_vfio (vlib_main_t * vm, linux_pci_device_t * p,
1023 vlib_pci_device_info_t * di, pci_device_registration_t * r)
1025 linux_pci_main_t *lpm = &linux_pci_main;
1026 struct vfio_device_info device_info = { 0 };
1027 struct vfio_region_info reg = { 0 };
1028 clib_error_t *err = 0;
1032 p->type = LINUX_PCI_DEVICE_TYPE_VFIO;
1034 if ((err = linux_vfio_group_get_device_fd (&p->addr, &p->fd, &is_noiommu)))
1037 if (is_noiommu == 0)
1038 p->supports_va_dma = 1;
1040 device_info.argsz = sizeof (device_info);
1041 if (ioctl (p->fd, VFIO_DEVICE_GET_INFO, &device_info) < 0)
1043 err = clib_error_return_unix (0, "ioctl(VFIO_DEVICE_GET_INFO) '%U'",
1044 format_vlib_pci_addr, &di->addr);
1048 reg.argsz = sizeof (struct vfio_region_info);
1049 reg.index = VFIO_PCI_CONFIG_REGION_INDEX;
1050 if (ioctl (p->fd, VFIO_DEVICE_GET_REGION_INFO, ®) < 0)
1052 err = clib_error_return_unix (0, "ioctl(VFIO_DEVICE_GET_INFO) '%U'",
1053 format_vlib_pci_addr, &di->addr);
1057 log_debug (p, "%s %U", __func__, format_vfio_region_info, ®);
1059 p->config_offset = reg.offset;
1060 p->config_fd = p->fd;
1062 /* reset if device supports it */
1063 if (device_info.flags & VFIO_DEVICE_FLAGS_RESET)
1064 if (ioctl (p->fd, VFIO_DEVICE_RESET) < 0)
1066 err = clib_error_return_unix (0, "ioctl(VFIO_DEVICE_RESET) '%U'",
1067 format_vlib_pci_addr, &di->addr);
1071 if (r && r->interrupt_handler)
1073 vlib_pci_register_intx_handler (vm, p->handle, r->interrupt_handler);
1074 linux_pci_vfio_unmask_intx (vm, p);
1077 if (p->supports_va_dma)
1079 vlib_buffer_pool_t *bp;
1080 vec_foreach (bp, vm->buffer_main->buffer_pools)
1083 vlib_physmem_map_t *pm;
1084 pm = vlib_physmem_get_map (vm, bp->physmem_map_index);
1085 for (i = 0; i < pm->n_pages; i++)
1086 vfio_map_physmem_page (vm, pm->base + (i << pm->log2_page_size));
1090 if (r && r->init_function)
1091 err = r->init_function (lpm->vlib_main, p->handle);
1099 if (p->config_fd != -1 && p->config_fd != p->fd)
1100 close (p->config_fd);
1101 p->config_fd = p->fd = -1;
1106 /* Configuration space read/write. */
1108 vlib_pci_read_write_config (vlib_main_t * vm, vlib_pci_dev_handle_t h,
1109 vlib_read_or_write_t read_or_write,
1110 uword address, void *data, u32 n_bytes)
1112 linux_pci_device_t *p = linux_pci_get_device (h);
1115 if (read_or_write == VLIB_READ)
1116 n = pread (p->config_fd, data, n_bytes, p->config_offset + address);
1118 n = pwrite (p->config_fd, data, n_bytes, p->config_offset + address);
1121 return clib_error_return_unix (0, "%s",
1122 read_or_write == VLIB_READ
1123 ? "read" : "write");
1128 static clib_error_t *
1129 vlib_pci_region (vlib_main_t * vm, vlib_pci_dev_handle_t h, u32 bar, int *fd,
1130 u64 * size, u64 * offset)
1132 linux_pci_device_t *p = linux_pci_get_device (h);
1133 clib_error_t *error = 0;
1135 u64 _size = 0, _offset = 0;
1141 if (p->type == LINUX_PCI_DEVICE_TYPE_UIO)
1144 struct stat stat_buf;
1145 file_name = format (0, "%s/%U/resource%d%c", sysfs_pci_dev_path,
1146 format_vlib_pci_addr, &p->addr, bar, 0);
1148 _fd = open ((char *) file_name, O_RDWR);
1151 error = clib_error_return_unix (0, "open `%s'", file_name);
1152 vec_free (file_name);
1156 if (fstat (_fd, &stat_buf) < 0)
1158 error = clib_error_return_unix (0, "fstat `%s'", file_name);
1159 vec_free (file_name);
1164 vec_free (file_name);
1165 _size = stat_buf.st_size;
1168 else if (p->type == LINUX_PCI_DEVICE_TYPE_VFIO)
1170 struct vfio_region_info *r;
1171 u32 sz = sizeof (struct vfio_region_info);
1173 r = clib_mem_alloc (sz);
1174 clib_memset (r, 0, sz);
1177 if (ioctl (p->fd, VFIO_DEVICE_GET_REGION_INFO, r) < 0)
1178 return clib_error_return_unix (0, "ioctl(VFIO_DEVICE_GET_INFO) "
1179 "'%U'", format_vlib_pci_addr,
1189 _offset = r->offset;
1190 log_debug (p, "%s %U", __func__, format_vfio_region_info, r);
1203 static clib_error_t *
1204 vlib_pci_map_region_int (vlib_main_t * vm, vlib_pci_dev_handle_t h,
1205 u32 bar, u8 * addr, void **result)
1207 linux_pci_device_t *p = linux_pci_get_device (h);
1209 clib_error_t *error;
1210 u64 size = 0, offset = 0;
1211 vlib_pci_config_reg_command_t command;
1213 log_debug (p, "map region %u to va %p", bar, addr);
1215 if ((error = vlib_pci_read_config_u16 (vm, h, 4, &command.as_u16)))
1218 if (!(command.mem_space))
1220 log_debug (p, "setting memory enable bit");
1221 command.mem_space = 1;
1222 if ((error = vlib_pci_write_config_u16 (vm, h, 4, &command.as_u16)))
1226 if ((error = vlib_pci_region (vm, h, bar, &fd, &size, &offset)))
1229 *result = clib_mem_vm_map_shared (addr, size, fd, offset,
1230 "PCIe %U region %u", format_vlib_pci_addr,
1231 vlib_pci_get_addr (vm, h), bar);
1232 if (*result == CLIB_MEM_VM_MAP_FAILED)
1234 error = clib_error_return_unix (0, "mmap `BAR%u'", bar);
1235 if (p->type == LINUX_PCI_DEVICE_TYPE_UIO && (fd != -1))
1240 vec_validate_init_empty (p->regions, bar,
1241 (linux_pci_region_t) { .fd = -1});
1242 if (p->type == LINUX_PCI_DEVICE_TYPE_UIO)
1243 p->regions[bar].fd = fd;
1244 p->regions[bar].addr = *result;
1245 p->regions[bar].size = size;
1250 vlib_pci_map_region (vlib_main_t * vm, vlib_pci_dev_handle_t h, u32 resource,
1253 return (vlib_pci_map_region_int (vm, h, resource, 0 /* addr */ , result));
1257 vlib_pci_map_region_fixed (vlib_main_t * vm, vlib_pci_dev_handle_t h,
1258 u32 resource, u8 * addr, void **result)
1260 return (vlib_pci_map_region_int (vm, h, resource, addr, result));
1264 vlib_pci_io_region (vlib_main_t * vm, vlib_pci_dev_handle_t h, u32 resource)
1266 linux_pci_device_t *p = linux_pci_get_device (h);
1267 clib_error_t *error = 0;
1269 u64 size = 0, offset = 0;
1271 if ((error = vlib_pci_region (vm, h, resource, &fd, &size, &offset)))
1275 p->io_offset = offset;
1280 vlib_pci_read_write_io (vlib_main_t * vm, vlib_pci_dev_handle_t h,
1281 vlib_read_or_write_t read_or_write,
1282 uword offset, void *data, u32 length)
1284 linux_pci_device_t *p = linux_pci_get_device (h);
1287 if (read_or_write == VLIB_READ)
1288 n = pread (p->io_fd, data, length, p->io_offset + offset);
1290 n = pwrite (p->io_fd, data, length, p->io_offset + offset);
1293 return clib_error_return_unix (0, "%s",
1294 read_or_write == VLIB_READ
1295 ? "read" : "write");
1300 vlib_pci_map_dma (vlib_main_t * vm, vlib_pci_dev_handle_t h, void *ptr)
1302 linux_pci_device_t *p = linux_pci_get_device (h);
1304 if (!p->supports_va_dma)
1307 return vfio_map_physmem_page (vm, ptr);
1311 vlib_pci_supports_virtual_addr_dma (vlib_main_t * vm, vlib_pci_dev_handle_t h)
1313 linux_pci_device_t *p = linux_pci_get_device (h);
1315 return p->supports_va_dma != 0;
1319 vlib_pci_device_open (vlib_main_t * vm, vlib_pci_addr_t * addr,
1320 pci_device_id_t ids[], vlib_pci_dev_handle_t * handle)
1322 linux_pci_main_t *lpm = &linux_pci_main;
1323 vlib_pci_device_info_t *di;
1324 linux_pci_device_t *p;
1325 clib_error_t *err = 0;
1328 di = vlib_pci_get_device_info (vm, addr, &err);
1335 for (i = ids; i->vendor_id != 0; i++)
1336 if (i->vendor_id == di->vendor_id && i->device_id == di->device_id)
1339 if (i->vendor_id == 0)
1341 vlib_pci_free_device_info (di);
1342 return clib_error_return (0, "Wrong vendor or device id");
1346 pool_get (lpm->linux_pci_devices, p);
1347 p->handle = p - lpm->linux_pci_devices;
1348 p->addr.as_u32 = di->addr.as_u32;
1349 p->intx_irq.fd = -1;
1350 p->intx_irq.clib_file_index = -1;
1351 p->numa_node = di->numa_node;
1353 * pci io bar read/write fd
1357 log_debug (p, "open vid:0x%04x did:0x%04x driver:%s iommu_group:%d",
1358 di->vendor_id, di->device_id, di->driver_name, di->iommu_group);
1360 if (clib_strncmp ("vfio-pci", (char *) di->driver_name, 8) == 0)
1361 err = add_device_vfio (vm, p, di, 0);
1362 else if (clib_strncmp ("uio_pci_generic", (char *) di->driver_name, 8) == 0)
1363 err = add_device_uio (vm, p, di, 0);
1365 err = clib_error_create ("device not bound to 'vfio-pci' or "
1366 "'uio_pci_generic' kernel module");
1370 *handle = p->handle;
1373 vlib_pci_free_device_info (di);
1376 log_err (p, "%U", format_clib_error, err);
1377 clib_memset (p, 0, sizeof (linux_pci_device_t));
1378 pool_put (lpm->linux_pci_devices, p);
1385 vlib_pci_device_close (vlib_main_t * vm, vlib_pci_dev_handle_t h)
1387 linux_pci_main_t *lpm = &linux_pci_main;
1388 linux_pci_device_t *p = linux_pci_get_device (h);
1389 linux_pci_irq_t *irq;
1390 linux_pci_region_t *res;
1391 clib_error_t *err = 0;
1393 if (p->type == LINUX_PCI_DEVICE_TYPE_UIO)
1396 if (irq->clib_file_index != -1)
1397 clib_file_del_by_index (&file_main, irq->clib_file_index);
1398 close (p->config_fd);
1402 else if (p->type == LINUX_PCI_DEVICE_TYPE_VFIO)
1405 /* close INTx irqs */
1408 err = vfio_set_irqs (vm, p, VFIO_PCI_INTX_IRQ_INDEX, 0, 0,
1409 VFIO_IRQ_SET_ACTION_TRIGGER, 0);
1410 clib_error_free (err);
1411 if (irq->clib_file_index != -1)
1412 clib_file_del_by_index (&file_main, irq->clib_file_index);
1416 /* close MSI-X irqs */
1417 if (vec_len (p->msix_irqs))
1419 err = vfio_set_irqs (vm, p, VFIO_PCI_MSIX_IRQ_INDEX, 0, 0,
1420 VFIO_IRQ_SET_ACTION_TRIGGER, 0);
1421 clib_error_free (err);
1422 vec_foreach (irq, p->msix_irqs)
1426 clib_file_del_by_index (&file_main, irq->clib_file_index);
1429 vec_free (p->msix_irqs);
1433 vec_foreach (res, p->regions)
1437 clib_mem_vm_unmap (res->addr);
1441 vec_free (p->regions);
1444 clib_memset (p, 0, sizeof (linux_pci_device_t));
1445 pool_put (lpm->linux_pci_devices, p);
1449 init_device_from_registered (vlib_main_t * vm, vlib_pci_device_info_t * di)
1451 vlib_pci_main_t *pm = &pci_main;
1452 linux_pci_main_t *lpm = &linux_pci_main;
1453 pci_device_registration_t *r;
1455 clib_error_t *err = 0;
1456 linux_pci_device_t *p;
1458 pool_get (lpm->linux_pci_devices, p);
1459 p->handle = p - lpm->linux_pci_devices;
1460 p->intx_irq.fd = -1;
1462 r = pm->pci_device_registrations;
1466 for (i = r->supported_devices; i->vendor_id != 0; i++)
1467 if (i->vendor_id == di->vendor_id && i->device_id == di->device_id)
1469 if (di->iommu_group != -1)
1470 err = add_device_vfio (vm, p, di, r);
1472 err = add_device_uio (vm, p, di, r);
1475 clib_error_report (err);
1479 r = r->next_registration;
1482 /* No driver, close the PCI config-space FD */
1483 clib_memset (p, 0, sizeof (linux_pci_device_t));
1484 pool_put (lpm->linux_pci_devices, p);
1487 static clib_error_t *
1488 scan_pci_addr (void *arg, u8 * dev_dir_name, u8 * ignored)
1490 vlib_pci_addr_t addr, **addrv = arg;
1491 unformat_input_t input;
1492 clib_error_t *err = 0;
1494 unformat_init_string (&input, (char *) dev_dir_name,
1495 vec_len (dev_dir_name));
1497 if (!unformat (&input, "/sys/bus/pci/devices/%U",
1498 unformat_vlib_pci_addr, &addr))
1499 err = clib_error_return (0, "unformat error `%v`", dev_dir_name);
1501 unformat_free (&input);
1506 vec_add1 (*addrv, addr);
1511 pci_addr_cmp (void *v1, void *v2)
1513 vlib_pci_addr_t *a1 = v1;
1514 vlib_pci_addr_t *a2 = v2;
1516 if (a1->domain > a2->domain)
1518 if (a1->domain < a2->domain)
1520 if (a1->bus > a2->bus)
1522 if (a1->bus < a2->bus)
1524 if (a1->slot > a2->slot)
1526 if (a1->slot < a2->slot)
1528 if (a1->function > a2->function)
1530 if (a1->function < a2->function)
1536 vlib_pci_get_all_dev_addrs ()
1538 vlib_pci_addr_t *addrs = 0;
1540 err = foreach_directory_file ((char *) sysfs_pci_dev_path, scan_pci_addr,
1541 &addrs, /* scan_dirs */ 0);
1548 vec_sort_with_function (addrs, pci_addr_cmp);
1554 linux_pci_init (vlib_main_t * vm)
1556 vlib_pci_main_t *pm = &pci_main;
1557 vlib_pci_addr_t *addr = 0, *addrs;
1561 ASSERT (sizeof (vlib_pci_addr_t) == sizeof (u32));
1563 addrs = vlib_pci_get_all_dev_addrs ();
1564 vec_foreach (addr, addrs)
1566 vlib_pci_device_info_t *d;
1567 if ((d = vlib_pci_get_device_info (vm, addr, 0)))
1569 init_device_from_registered (vm, d);
1570 vlib_pci_free_device_info (d);
1577 VLIB_INIT_FUNCTION (linux_pci_init) =
1579 .runs_after = VLIB_INITS("unix_input_init"),
1583 * fd.io coding-style-patch-verification: ON
1586 * eval: (c-set-style "gnu")