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);
296 vec_reset_length (f);
297 f = format (f, "%v/driver%c", dev_dir_name, 0);
298 di->driver_name = clib_sysfs_link_to_name ((char *) f);
299 if (!di->driver_name)
300 di->driver_name = format (0, "<NONE>%c", 0);
302 di->iommu_group = -1;
303 vec_reset_length (f);
304 f = format (f, "%v/iommu_group%c", dev_dir_name, 0);
305 tmpstr = clib_sysfs_link_to_name ((char *) f);
308 di->iommu_group = atoi ((char *) tmpstr);
312 vec_reset_length (f);
313 f = format (f, "%v/iommu_group/name%c", dev_dir_name, 0);
314 err = clib_sysfs_read ((char *) f, "%s", &tmpstr);
317 if (strncmp ((char *) tmpstr, "vfio-noiommu", 12) == 0)
318 di->flags |= VLIB_PCI_DEVICE_INFO_F_NOIOMMU;
322 clib_error_free (err);
326 vec_reset_length (f);
327 f = format (f, "%v/vpd%c", dev_dir_name, 0);
328 fd = open ((char *) f, O_RDONLY);
337 if (read (fd, &tag, 3) != 3)
340 if (tag[0] != 0x82 && tag[0] != 0x90 && tag[0] != 0x91)
343 len = (tag[2] << 8) | tag[1];
344 vec_validate (data, len - 1);
346 if (read (fd, data, len) != len)
352 di->product_name = data;
353 else if (tag[0] == 0x90)
355 else if (tag[0] == 0x91)
366 vlib_pci_free_device_info (di);
372 vec_free (dev_dir_name);
376 clib_error_free (err);
380 clib_error_t *__attribute__ ((weak))
381 vlib_pci_get_device_root_bus (vlib_pci_addr_t *addr, vlib_pci_addr_t *root_bus)
383 u8 *rel_path = 0, *abs_path = 0, *link_path = 0;
384 unformat_input_t input;
385 int fd = open (sysfs_pci_dev_path, O_RDONLY);
388 clib_error_t *err = NULL;
391 return clib_error_return_unix (0, "failed to open %s", sysfs_pci_dev_path);
393 vec_alloc (rel_path, PATH_MAX);
394 vec_alloc (abs_path, PATH_MAX);
397 format (0, "%s/%U", sysfs_pci_dev_path, format_vlib_pci_addr, addr);
398 size = readlinkat (fd, (char *) link_path, (char *) rel_path, PATH_MAX);
401 err = clib_error_return_unix (0, "failed to read %s", rel_path);
405 rel_path[size] = '\0';
406 vec_free (link_path);
408 link_path = format (0, "%s/%s", sysfs_pci_dev_path, rel_path);
409 if (!realpath ((char *) link_path, (char *) abs_path))
411 err = clib_error_return_unix (0, "failed to resolve %s", link_path);
415 unformat_init_string (&input, (char *) abs_path,
416 clib_strnlen ((char *) abs_path, PATH_MAX));
418 if (!unformat (&input, SYSFS_DEVICES_PCI "%x:%x/%s", &domain, &bus,
421 err = clib_error_return (0, "unknown input '%U'", format_unformat_error,
426 root_bus->domain = domain;
431 vec_free (link_path);
439 directory_exists (char *path)
441 struct stat s = { 0 };
442 if (stat (path, &s) == -1)
445 return S_ISDIR (s.st_mode);
449 vlib_pci_bind_to_uio (vlib_main_t *vm, vlib_pci_addr_t *addr,
450 char *uio_drv_name, int force)
452 clib_error_t *error = 0;
453 u8 *s = 0, *driver_name = 0;
456 vlib_pci_device_info_t *di;
457 int fd, clear_driver_override = 0;
458 u8 *dev_dir_name = format (0, "%s/%U", sysfs_pci_dev_path,
459 format_vlib_pci_addr, addr);
461 di = vlib_pci_get_device_info (vm, addr, &error);
466 if (strncmp ("auto", uio_drv_name, 5) == 0)
468 int vfio_pci_loaded = 0;
470 if (directory_exists ("/sys/module/vfio_pci"))
473 if (di->iommu_group != -1)
475 /* device is bound to IOMMU group */
476 if (!vfio_pci_loaded)
478 error = clib_error_return (0, "Skipping PCI device %U: device "
479 "is bound to IOMMU group and "
480 "vfio-pci driver is not loaded",
481 format_vlib_pci_addr, addr);
485 uio_drv_name = "vfio-pci";
489 /* device is not bound to IOMMU group so we have multiple options */
490 if (vfio_pci_loaded &&
491 (error = clib_sysfs_write (sysfs_mod_vfio_noiommu, "Y")) == 0)
492 uio_drv_name = "vfio-pci";
493 else if (directory_exists ("/sys/module/uio_pci_generic"))
494 uio_drv_name = "uio_pci_generic";
495 else if (directory_exists ("/sys/module/igb_uio"))
496 uio_drv_name = "igb_uio";
499 clib_error_free (error);
500 error = clib_error_return (0, "Skipping PCI device %U: missing "
501 "kernel VFIO or UIO driver",
502 format_vlib_pci_addr, addr);
505 clib_error_free (error);
509 s = format (s, "%v/driver%c", dev_dir_name, 0);
510 driver_name = clib_sysfs_link_to_name ((char *) s);
511 vec_reset_length (s);
514 ((strcmp ("vfio-pci", (char *) driver_name) == 0) ||
515 (strcmp ("uio_pci_generic", (char *) driver_name) == 0) ||
516 (strcmp ("igb_uio", (char *) driver_name) == 0)))
521 /* walk trough all linux interfaces and if interface belonging to
522 this device is found check if interface is admin up */
523 dir = opendir ("/sys/class/net");
524 s = format (s, "%U%c", format_vlib_pci_addr, addr, 0);
528 error = clib_error_return (0,
529 "Skipping PCI device %U: failed to "
530 "read /sys/class/net",
531 format_vlib_pci_addr, addr);
535 fd = socket (PF_INET, SOCK_DGRAM, 0);
538 error = clib_error_return_unix (0, "socket");
542 while ((e = readdir (dir)))
545 struct ethtool_drvinfo drvinfo;
547 if (e->d_name[0] == '.') /* skip . and .. */
550 clib_memset (&ifr, 0, sizeof ifr);
551 clib_memset (&drvinfo, 0, sizeof drvinfo);
552 ifr.ifr_data = (char *) &drvinfo;
553 clib_strncpy (ifr.ifr_name, e->d_name, sizeof (ifr.ifr_name) - 1);
555 drvinfo.cmd = ETHTOOL_GDRVINFO;
556 if (ioctl (fd, SIOCETHTOOL, &ifr) < 0)
558 /* Some interfaces (eg "lo") don't support this ioctl */
559 if ((errno != ENOTSUP) && (errno != ENODEV))
560 clib_unix_warning ("ioctl fetch intf %s bus info error",
565 if (strcmp ((char *) s, drvinfo.bus_info))
568 clib_memset (&ifr, 0, sizeof (ifr));
569 clib_strncpy (ifr.ifr_name, e->d_name, sizeof (ifr.ifr_name) - 1);
571 if (ioctl (fd, SIOCGIFFLAGS, &ifr) < 0)
573 error = clib_error_return_unix (0, "ioctl fetch intf %s flags",
579 if (ifr.ifr_flags & IFF_UP)
581 vlib_log (VLIB_LOG_LEVEL_WARNING, pci_main.log_default,
582 "Skipping PCI device %U as host "
583 "interface %s is up",
584 format_vlib_pci_addr, addr, e->d_name);
591 vec_reset_length (s);
594 s = format (s, "%v/driver/unbind%c", dev_dir_name, 0);
595 clib_sysfs_write ((char *) s, "%U", format_vlib_pci_addr, addr);
596 vec_reset_length (s);
598 s = format (s, "%v/driver_override%c", dev_dir_name, 0);
599 if (access ((char *) s, F_OK) == 0)
601 clib_sysfs_write ((char *) s, "%s", uio_drv_name);
602 clear_driver_override = 1;
606 vec_reset_length (s);
607 s = format (s, "%s/%s/new_id%c", sysfs_pci_drv_path, uio_drv_name, 0);
608 clib_sysfs_write ((char *) s, "0x%04x 0x%04x", di->vendor_id,
611 vec_reset_length (s);
613 s = format (s, "%s/%s/bind%c", sysfs_pci_drv_path, uio_drv_name, 0);
614 clib_sysfs_write ((char *) s, "%U", format_vlib_pci_addr, addr);
615 vec_reset_length (s);
617 if (clear_driver_override)
619 s = format (s, "%v/driver_override%c", dev_dir_name, 0);
620 clib_sysfs_write ((char *) s, "%c", 0);
621 vec_reset_length (s);
628 vec_free (dev_dir_name);
629 vec_free (driver_name);
634 static clib_error_t *
635 scan_uio_dir (void *arg, u8 * path_name, u8 * file_name)
637 linux_pci_device_t *l = arg;
638 unformat_input_t input;
640 unformat_init_string (&input, (char *) file_name, vec_len (file_name));
642 if (!unformat (&input, "uio%d", &l->uio_minor))
645 unformat_free (&input);
649 static clib_error_t *
650 vfio_set_irqs (vlib_main_t * vm, linux_pci_device_t * p, u32 index, u32 start,
651 u32 count, u32 flags, int *efds)
653 int data_len = efds ? count * sizeof (int) : 0;
654 u8 buf[sizeof (struct vfio_irq_set) + data_len];
655 struct vfio_irq_info ii = { 0 };
656 struct vfio_irq_set *irq_set = (struct vfio_irq_set *) buf;
659 ii.argsz = sizeof (struct vfio_irq_info);
662 if (ioctl (p->fd, VFIO_DEVICE_GET_IRQ_INFO, &ii) < 0)
663 return clib_error_return_unix (0, "ioctl(VFIO_DEVICE_GET_IRQ_INFO) "
664 "'%U'", format_vlib_pci_addr, &p->addr);
666 log_debug (p, "%s index:%u count:%u flags: %s%s%s%s(0x%x)", __func__,
668 ii.flags & VFIO_IRQ_INFO_EVENTFD ? "eventfd " : "",
669 ii.flags & VFIO_IRQ_INFO_MASKABLE ? "maskable " : "",
670 ii.flags & VFIO_IRQ_INFO_AUTOMASKED ? "automasked " : "",
671 ii.flags & VFIO_IRQ_INFO_NORESIZE ? "noresize " : "", ii.flags);
673 if (ii.count < start + count)
674 return clib_error_return_unix (0, "vfio_set_irq: unexistng interrupt on "
675 "'%U'", format_vlib_pci_addr, &p->addr);
680 flags |= VFIO_IRQ_SET_DATA_EVENTFD;
681 clib_memcpy_fast (&irq_set->data, efds, data_len);
684 flags |= VFIO_IRQ_SET_DATA_NONE;
686 ASSERT ((flags & (VFIO_IRQ_SET_DATA_NONE | VFIO_IRQ_SET_DATA_EVENTFD)) !=
687 (VFIO_IRQ_SET_DATA_NONE | VFIO_IRQ_SET_DATA_EVENTFD));
689 irq_set->argsz = sizeof (struct vfio_irq_set) + data_len;
690 irq_set->index = index;
691 irq_set->start = start;
692 irq_set->count = count;
693 irq_set->flags = flags;
695 if (ioctl (p->fd, VFIO_DEVICE_SET_IRQS, irq_set) < 0)
696 return clib_error_return_unix (0, "%U:ioctl(VFIO_DEVICE_SET_IRQS) "
697 "[index = %u, start = %u, count = %u, "
699 format_vlib_pci_addr, &p->addr,
700 index, start, count, flags);
704 static clib_error_t *
705 linux_pci_uio_read_ready (clib_file_t * uf)
707 vlib_main_t *vm = vlib_get_main ();
708 int __attribute__ ((unused)) rv;
709 vlib_pci_dev_handle_t h = uf->private_data;
710 linux_pci_device_t *p = linux_pci_get_device (h);
711 linux_pci_irq_t *irq = &p->intx_irq;
714 rv = read (uf->file_descriptor, &icount, 4);
716 if (irq->intx_handler)
717 irq->intx_handler (vm, h);
719 vlib_pci_intr_enable (vm, h);
721 return /* no error */ 0;
724 static clib_error_t *
725 linux_pci_vfio_unmask_intx (vlib_main_t * vm, linux_pci_device_t * d)
727 return vfio_set_irqs (vm, d, VFIO_PCI_INTX_IRQ_INDEX, 0, 1,
728 VFIO_IRQ_SET_ACTION_UNMASK, 0);
731 static clib_error_t *
732 linux_pci_uio_error_ready (clib_file_t * uf)
734 u32 error_index = (u32) uf->private_data;
736 return clib_error_return (0, "pci device %d: error", error_index);
739 static clib_error_t *
740 linux_pci_vfio_msix_read_ready (clib_file_t * uf)
742 vlib_main_t *vm = vlib_get_main ();
743 int __attribute__ ((unused)) rv;
744 vlib_pci_dev_handle_t h = uf->private_data >> 16;
745 u16 line = uf->private_data & 0xffff;
746 linux_pci_device_t *p = linux_pci_get_device (h);
747 linux_pci_irq_t *irq = vec_elt_at_index (p->msix_irqs, line);
750 rv = read (uf->file_descriptor, &icount, sizeof (icount));
752 if (irq->msix_handler)
753 irq->msix_handler (vm, h, line);
755 return /* no error */ 0;
758 static clib_error_t *
759 linux_pci_vfio_intx_read_ready (clib_file_t * uf)
761 vlib_main_t *vm = vlib_get_main ();
762 int __attribute__ ((unused)) rv;
763 vlib_pci_dev_handle_t h = uf->private_data;
764 linux_pci_device_t *p = linux_pci_get_device (h);
765 linux_pci_irq_t *irq = &p->intx_irq;
768 rv = read (uf->file_descriptor, &icount, sizeof (icount));
770 if (irq->intx_handler)
771 irq->intx_handler (vm, h);
773 linux_pci_vfio_unmask_intx (vm, p);
775 return /* no error */ 0;
778 static clib_error_t *
779 linux_pci_vfio_error_ready (clib_file_t * uf)
781 u32 error_index = (u32) uf->private_data;
783 return clib_error_return (0, "pci device %d: error", error_index);
786 static clib_error_t *
787 add_device_uio (vlib_main_t * vm, linux_pci_device_t * p,
788 vlib_pci_device_info_t * di, pci_device_registration_t * r)
790 linux_pci_main_t *lpm = &linux_pci_main;
791 clib_error_t *err = 0;
795 p->type = LINUX_PCI_DEVICE_TYPE_UIO;
797 s = format (s, "%s/%U/config%c", sysfs_pci_dev_path,
798 format_vlib_pci_addr, &di->addr, 0);
800 p->config_fd = open ((char *) s, O_RDWR);
801 p->config_offset = 0;
802 vec_reset_length (s);
804 if (p->config_fd == -1)
806 err = clib_error_return_unix (0, "open '%s'", s);
810 s = format (0, "%s/%U/uio%c", sysfs_pci_dev_path,
811 format_vlib_pci_addr, &di->addr, 0);
812 foreach_directory_file ((char *) s, scan_uio_dir, p, /* scan_dirs */
814 vec_reset_length (s);
816 s = format (s, "/dev/uio%d%c", p->uio_minor, 0);
817 p->fd = open ((char *) s, O_RDWR);
820 err = clib_error_return_unix (0, "open '%s'", s);
824 if (r && r->interrupt_handler)
825 vlib_pci_register_intx_handler (vm, p->handle, r->interrupt_handler);
827 if (r && r->init_function)
828 err = r->init_function (lpm->vlib_main, p->handle);
834 if (p->config_fd != -1)
835 close (p->config_fd);
843 vlib_pci_register_intx_handler (vlib_main_t * vm, vlib_pci_dev_handle_t h,
844 pci_intx_handler_function_t * intx_handler)
846 linux_pci_device_t *p = linux_pci_get_device (h);
847 clib_file_t t = { 0 };
848 linux_pci_irq_t *irq = &p->intx_irq;
849 ASSERT (irq->fd == -1);
851 if (p->type == LINUX_PCI_DEVICE_TYPE_VFIO)
853 struct vfio_irq_info ii = { 0 };
854 ii.argsz = sizeof (struct vfio_irq_info);
855 ii.index = VFIO_PCI_INTX_IRQ_INDEX;
856 if (ioctl (p->fd, VFIO_DEVICE_GET_IRQ_INFO, &ii) < 0)
857 return clib_error_return_unix (0, "ioctl(VFIO_DEVICE_GET_IRQ_INFO) '"
858 "%U'", format_vlib_pci_addr, &p->addr);
860 p, "%s index:%u count:%u flags: %s%s%s%s(0x%x)", __func__, ii.index,
861 ii.count, ii.flags & VFIO_IRQ_INFO_EVENTFD ? "eventfd " : "",
862 ii.flags & VFIO_IRQ_INFO_MASKABLE ? "maskable " : "",
863 ii.flags & VFIO_IRQ_INFO_AUTOMASKED ? "automasked " : "",
864 ii.flags & VFIO_IRQ_INFO_NORESIZE ? "noresize " : "", ii.flags);
866 return clib_error_return (0, "INTx interrupt does not exist on device"
867 "'%U'", format_vlib_pci_addr, &p->addr);
869 irq->fd = eventfd (0, EFD_NONBLOCK);
871 return clib_error_return_unix (0, "eventfd");
873 t.file_descriptor = irq->fd;
874 t.read_function = linux_pci_vfio_intx_read_ready;
876 else if (p->type == LINUX_PCI_DEVICE_TYPE_UIO)
878 t.file_descriptor = p->fd;
879 t.read_function = linux_pci_uio_read_ready;
884 t.error_function = linux_pci_uio_error_ready;
885 t.private_data = p->handle;
886 t.description = format (0, "PCI %U INTx", format_vlib_pci_addr, &p->addr);
887 irq->clib_file_index = clib_file_add (&file_main, &t);
888 irq->intx_handler = intx_handler;
893 vlib_pci_register_msix_handler (vlib_main_t * vm, vlib_pci_dev_handle_t h,
894 u32 start, u32 count,
895 pci_msix_handler_function_t * msix_handler)
897 clib_error_t *err = 0;
898 linux_pci_device_t *p = linux_pci_get_device (h);
901 if (p->type != LINUX_PCI_DEVICE_TYPE_VFIO)
902 return clib_error_return (0, "vfio driver is needed for MSI-X interrupt "
906 vec_validate_init_empty (p->msix_irqs, start + count - 1, (linux_pci_irq_t)
910 for (i = start; i < start + count; i++)
912 clib_file_t t = { 0 };
913 linux_pci_irq_t *irq = vec_elt_at_index (p->msix_irqs, i);
914 ASSERT (irq->fd == -1);
916 irq->fd = eventfd (0, EFD_NONBLOCK);
919 err = clib_error_return_unix (0, "eventfd");
923 t.read_function = linux_pci_vfio_msix_read_ready;
924 t.file_descriptor = irq->fd;
925 t.error_function = linux_pci_vfio_error_ready;
926 t.private_data = p->handle << 16 | i;
927 t.description = format (0, "PCI %U MSI-X #%u", format_vlib_pci_addr,
929 irq->clib_file_index = clib_file_add (&file_main, &t);
930 irq->msix_handler = msix_handler;
938 linux_pci_irq_t *irq = vec_elt_at_index (p->msix_irqs, i);
941 clib_file_del_by_index (&file_main, irq->clib_file_index);
950 vlib_pci_enable_msix_irq (vlib_main_t * vm, vlib_pci_dev_handle_t h,
951 u16 start, u16 count)
953 linux_pci_device_t *p = linux_pci_get_device (h);
957 if (p->type != LINUX_PCI_DEVICE_TYPE_VFIO)
958 return clib_error_return (0, "vfio driver is needed for MSI-X interrupt "
961 for (i = start; i < start + count; i++)
963 linux_pci_irq_t *irq = vec_elt_at_index (p->msix_irqs, i);
967 return vfio_set_irqs (vm, p, VFIO_PCI_MSIX_IRQ_INDEX, start, count,
968 VFIO_IRQ_SET_ACTION_TRIGGER, fds);
972 vlib_pci_get_msix_file_index (vlib_main_t * vm, vlib_pci_dev_handle_t h,
975 linux_pci_device_t *p = linux_pci_get_device (h);
976 linux_pci_irq_t *irq = vec_elt_at_index (p->msix_irqs, index);
979 return irq->clib_file_index;
983 vlib_pci_disable_msix_irq (vlib_main_t * vm, vlib_pci_dev_handle_t h,
984 u16 start, u16 count)
986 linux_pci_device_t *p = linux_pci_get_device (h);
989 if (p->type != LINUX_PCI_DEVICE_TYPE_VFIO)
990 return clib_error_return (0, "vfio driver is needed for MSI-X interrupt "
993 for (i = start; i < start + count; i++)
996 return vfio_set_irqs (vm, p, VFIO_PCI_MSIX_IRQ_INDEX, start, count,
997 VFIO_IRQ_SET_ACTION_TRIGGER, fds);
1000 static clib_error_t *
1001 add_device_vfio (vlib_main_t * vm, linux_pci_device_t * p,
1002 vlib_pci_device_info_t * di, pci_device_registration_t * r)
1004 linux_pci_main_t *lpm = &linux_pci_main;
1005 struct vfio_device_info device_info = { 0 };
1006 struct vfio_region_info reg = { 0 };
1007 clib_error_t *err = 0;
1011 p->type = LINUX_PCI_DEVICE_TYPE_VFIO;
1013 if ((err = linux_vfio_group_get_device_fd (&p->addr, &p->fd, &is_noiommu)))
1016 if (is_noiommu == 0)
1017 p->supports_va_dma = 1;
1019 device_info.argsz = sizeof (device_info);
1020 if (ioctl (p->fd, VFIO_DEVICE_GET_INFO, &device_info) < 0)
1022 err = clib_error_return_unix (0, "ioctl(VFIO_DEVICE_GET_INFO) '%U'",
1023 format_vlib_pci_addr, &di->addr);
1027 reg.argsz = sizeof (struct vfio_region_info);
1028 reg.index = VFIO_PCI_CONFIG_REGION_INDEX;
1029 if (ioctl (p->fd, VFIO_DEVICE_GET_REGION_INFO, ®) < 0)
1031 err = clib_error_return_unix (0, "ioctl(VFIO_DEVICE_GET_INFO) '%U'",
1032 format_vlib_pci_addr, &di->addr);
1036 log_debug (p, "%s %U", __func__, format_vfio_region_info, ®);
1038 p->config_offset = reg.offset;
1039 p->config_fd = p->fd;
1041 /* reset if device supports it */
1042 if (device_info.flags & VFIO_DEVICE_FLAGS_RESET)
1043 if (ioctl (p->fd, VFIO_DEVICE_RESET) < 0)
1045 err = clib_error_return_unix (0, "ioctl(VFIO_DEVICE_RESET) '%U'",
1046 format_vlib_pci_addr, &di->addr);
1050 if (r && r->interrupt_handler)
1052 vlib_pci_register_intx_handler (vm, p->handle, r->interrupt_handler);
1053 linux_pci_vfio_unmask_intx (vm, p);
1056 if (p->supports_va_dma)
1058 vlib_buffer_pool_t *bp;
1060 vec_foreach (bp, vm->buffer_main->buffer_pools)
1063 vlib_physmem_map_t *pm;
1064 pm = vlib_physmem_get_map (vm, bp->physmem_map_index);
1065 for (i = 0; i < pm->n_pages; i++)
1066 vfio_map_physmem_page (vm, pm->base + (i << pm->log2_page_size));
1071 if (r && r->init_function)
1072 err = r->init_function (lpm->vlib_main, p->handle);
1080 if (p->config_fd != -1 && p->config_fd != p->fd)
1081 close (p->config_fd);
1082 p->config_fd = p->fd = -1;
1087 /* Configuration space read/write. */
1089 vlib_pci_read_write_config (vlib_main_t * vm, vlib_pci_dev_handle_t h,
1090 vlib_read_or_write_t read_or_write,
1091 uword address, void *data, u32 n_bytes)
1093 linux_pci_device_t *p = linux_pci_get_device (h);
1096 if (read_or_write == VLIB_READ)
1097 n = pread (p->config_fd, data, n_bytes, p->config_offset + address);
1099 n = pwrite (p->config_fd, data, n_bytes, p->config_offset + address);
1102 return clib_error_return_unix (0, "%s",
1103 read_or_write == VLIB_READ
1104 ? "read" : "write");
1109 static clib_error_t *
1110 vlib_pci_region (vlib_main_t * vm, vlib_pci_dev_handle_t h, u32 bar, int *fd,
1111 u64 * size, u64 * offset)
1113 linux_pci_device_t *p = linux_pci_get_device (h);
1114 clib_error_t *error = 0;
1116 u64 _size = 0, _offset = 0;
1122 if (p->type == LINUX_PCI_DEVICE_TYPE_UIO)
1125 struct stat stat_buf;
1126 file_name = format (0, "%s/%U/resource%d%c", sysfs_pci_dev_path,
1127 format_vlib_pci_addr, &p->addr, bar, 0);
1129 _fd = open ((char *) file_name, O_RDWR);
1132 error = clib_error_return_unix (0, "open `%s'", file_name);
1133 vec_free (file_name);
1137 if (fstat (_fd, &stat_buf) < 0)
1139 error = clib_error_return_unix (0, "fstat `%s'", file_name);
1140 vec_free (file_name);
1145 vec_free (file_name);
1146 _size = stat_buf.st_size;
1149 else if (p->type == LINUX_PCI_DEVICE_TYPE_VFIO)
1151 struct vfio_region_info *r;
1152 u32 sz = sizeof (struct vfio_region_info);
1154 r = clib_mem_alloc (sz);
1155 clib_memset (r, 0, sz);
1158 if (ioctl (p->fd, VFIO_DEVICE_GET_REGION_INFO, r) < 0)
1159 return clib_error_return_unix (0, "ioctl(VFIO_DEVICE_GET_INFO) "
1160 "'%U'", format_vlib_pci_addr,
1170 _offset = r->offset;
1171 log_debug (p, "%s %U", __func__, format_vfio_region_info, r);
1184 static clib_error_t *
1185 vlib_pci_map_region_int (vlib_main_t * vm, vlib_pci_dev_handle_t h,
1186 u32 bar, u8 * addr, void **result)
1188 linux_pci_device_t *p = linux_pci_get_device (h);
1190 clib_error_t *error;
1191 u64 size = 0, offset = 0;
1192 vlib_pci_config_reg_command_t command;
1194 log_debug (p, "map region %u to va %p", bar, addr);
1196 if ((error = vlib_pci_read_config_u16 (vm, h, 4, &command.as_u16)))
1199 if (!(command.mem_space))
1201 log_debug (p, "setting memory enable bit");
1202 command.mem_space = 1;
1203 if ((error = vlib_pci_write_config_u16 (vm, h, 4, &command.as_u16)))
1207 if ((error = vlib_pci_region (vm, h, bar, &fd, &size, &offset)))
1210 *result = clib_mem_vm_map_shared (addr, size, fd, offset,
1211 "PCIe %U region %u", format_vlib_pci_addr,
1212 vlib_pci_get_addr (vm, h), bar);
1213 if (*result == CLIB_MEM_VM_MAP_FAILED)
1215 error = clib_error_return_unix (0, "mmap `BAR%u'", bar);
1216 if (p->type == LINUX_PCI_DEVICE_TYPE_UIO && (fd != -1))
1222 vec_validate_init_empty (p->regions, bar,
1223 (linux_pci_region_t) { .fd = -1});
1225 if (p->type == LINUX_PCI_DEVICE_TYPE_UIO)
1226 p->regions[bar].fd = fd;
1227 p->regions[bar].addr = *result;
1228 p->regions[bar].size = size;
1233 vlib_pci_map_region (vlib_main_t * vm, vlib_pci_dev_handle_t h, u32 resource,
1236 return (vlib_pci_map_region_int (vm, h, resource, 0 /* addr */ , result));
1240 vlib_pci_map_region_fixed (vlib_main_t * vm, vlib_pci_dev_handle_t h,
1241 u32 resource, u8 * addr, void **result)
1243 return (vlib_pci_map_region_int (vm, h, resource, addr, result));
1247 vlib_pci_io_region (vlib_main_t * vm, vlib_pci_dev_handle_t h, u32 resource)
1249 linux_pci_device_t *p = linux_pci_get_device (h);
1250 clib_error_t *error = 0;
1252 u64 size = 0, offset = 0;
1254 if ((error = vlib_pci_region (vm, h, resource, &fd, &size, &offset)))
1258 p->io_offset = offset;
1263 vlib_pci_read_write_io (vlib_main_t * vm, vlib_pci_dev_handle_t h,
1264 vlib_read_or_write_t read_or_write,
1265 uword offset, void *data, u32 length)
1267 linux_pci_device_t *p = linux_pci_get_device (h);
1270 if (read_or_write == VLIB_READ)
1271 n = pread (p->io_fd, data, length, p->io_offset + offset);
1273 n = pwrite (p->io_fd, data, length, p->io_offset + offset);
1276 return clib_error_return_unix (0, "%s",
1277 read_or_write == VLIB_READ
1278 ? "read" : "write");
1283 vlib_pci_map_dma (vlib_main_t * vm, vlib_pci_dev_handle_t h, void *ptr)
1285 linux_pci_device_t *p = linux_pci_get_device (h);
1287 if (!p->supports_va_dma)
1290 return vfio_map_physmem_page (vm, ptr);
1294 vlib_pci_supports_virtual_addr_dma (vlib_main_t * vm, vlib_pci_dev_handle_t h)
1296 linux_pci_device_t *p = linux_pci_get_device (h);
1298 return p->supports_va_dma != 0;
1302 vlib_pci_device_open (vlib_main_t * vm, vlib_pci_addr_t * addr,
1303 pci_device_id_t ids[], vlib_pci_dev_handle_t * handle)
1305 linux_pci_main_t *lpm = &linux_pci_main;
1306 vlib_pci_device_info_t *di;
1307 linux_pci_device_t *p;
1308 clib_error_t *err = 0;
1311 di = vlib_pci_get_device_info (vm, addr, &err);
1318 for (i = ids; i->vendor_id != 0; i++)
1319 if (i->vendor_id == di->vendor_id && i->device_id == di->device_id)
1322 if (i->vendor_id == 0)
1324 vlib_pci_free_device_info (di);
1325 return clib_error_return (0, "Wrong vendor or device id");
1329 pool_get (lpm->linux_pci_devices, p);
1330 p->handle = p - lpm->linux_pci_devices;
1331 p->addr.as_u32 = di->addr.as_u32;
1332 p->intx_irq.fd = -1;
1333 p->intx_irq.clib_file_index = -1;
1334 p->numa_node = di->numa_node;
1336 * pci io bar read/write fd
1340 log_debug (p, "open vid:0x%04x did:0x%04x driver:%s iommu_group:%d",
1341 di->vendor_id, di->device_id, di->driver_name, di->iommu_group);
1343 if (clib_strncmp ("vfio-pci", (char *) di->driver_name, 8) == 0)
1344 err = add_device_vfio (vm, p, di, 0);
1345 else if (clib_strncmp ("uio_pci_generic", (char *) di->driver_name, 8) == 0)
1346 err = add_device_uio (vm, p, di, 0);
1348 err = clib_error_create ("device not bound to 'vfio-pci' or "
1349 "'uio_pci_generic' kernel module");
1353 *handle = p->handle;
1356 vlib_pci_free_device_info (di);
1359 log_err (p, "%U", format_clib_error, err);
1360 clib_memset (p, 0, sizeof (linux_pci_device_t));
1361 pool_put (lpm->linux_pci_devices, p);
1368 vlib_pci_device_close (vlib_main_t * vm, vlib_pci_dev_handle_t h)
1370 linux_pci_main_t *lpm = &linux_pci_main;
1371 linux_pci_device_t *p = linux_pci_get_device (h);
1372 linux_pci_irq_t *irq;
1373 linux_pci_region_t *res;
1374 clib_error_t *err = 0;
1376 if (p->type == LINUX_PCI_DEVICE_TYPE_UIO)
1379 if (irq->clib_file_index != -1)
1380 clib_file_del_by_index (&file_main, irq->clib_file_index);
1381 close (p->config_fd);
1385 else if (p->type == LINUX_PCI_DEVICE_TYPE_VFIO)
1388 /* close INTx irqs */
1391 err = vfio_set_irqs (vm, p, VFIO_PCI_INTX_IRQ_INDEX, 0, 0,
1392 VFIO_IRQ_SET_ACTION_TRIGGER, 0);
1393 clib_error_free (err);
1394 if (irq->clib_file_index != -1)
1395 clib_file_del_by_index (&file_main, irq->clib_file_index);
1399 /* close MSI-X irqs */
1400 if (vec_len (p->msix_irqs))
1402 err = vfio_set_irqs (vm, p, VFIO_PCI_MSIX_IRQ_INDEX, 0, 0,
1403 VFIO_IRQ_SET_ACTION_TRIGGER, 0);
1404 clib_error_free (err);
1406 vec_foreach (irq, p->msix_irqs)
1410 clib_file_del_by_index (&file_main, irq->clib_file_index);
1414 vec_free (p->msix_irqs);
1419 vec_foreach (res, p->regions)
1423 clib_mem_vm_unmap (res->addr);
1428 vec_free (p->regions);
1431 clib_memset (p, 0, sizeof (linux_pci_device_t));
1432 pool_put (lpm->linux_pci_devices, p);
1436 init_device_from_registered (vlib_main_t * vm, vlib_pci_device_info_t * di)
1438 vlib_pci_main_t *pm = &pci_main;
1439 linux_pci_main_t *lpm = &linux_pci_main;
1440 pci_device_registration_t *r;
1442 clib_error_t *err = 0;
1443 linux_pci_device_t *p;
1445 pool_get (lpm->linux_pci_devices, p);
1446 p->handle = p - lpm->linux_pci_devices;
1447 p->intx_irq.fd = -1;
1449 r = pm->pci_device_registrations;
1453 for (i = r->supported_devices; i->vendor_id != 0; i++)
1454 if (i->vendor_id == di->vendor_id && i->device_id == di->device_id)
1456 if (di->iommu_group != -1)
1457 err = add_device_vfio (vm, p, di, r);
1459 err = add_device_uio (vm, p, di, r);
1462 clib_error_report (err);
1466 r = r->next_registration;
1469 /* No driver, close the PCI config-space FD */
1470 clib_memset (p, 0, sizeof (linux_pci_device_t));
1471 pool_put (lpm->linux_pci_devices, p);
1474 static clib_error_t *
1475 scan_pci_addr (void *arg, u8 * dev_dir_name, u8 * ignored)
1477 vlib_pci_addr_t addr, **addrv = arg;
1478 unformat_input_t input;
1479 clib_error_t *err = 0;
1481 unformat_init_string (&input, (char *) dev_dir_name,
1482 vec_len (dev_dir_name));
1484 if (!unformat (&input, "/sys/bus/pci/devices/%U",
1485 unformat_vlib_pci_addr, &addr))
1486 err = clib_error_return (0, "unformat error `%v`", dev_dir_name);
1488 unformat_free (&input);
1493 vec_add1 (*addrv, addr);
1498 pci_addr_cmp (void *v1, void *v2)
1500 vlib_pci_addr_t *a1 = v1;
1501 vlib_pci_addr_t *a2 = v2;
1503 if (a1->domain > a2->domain)
1505 if (a1->domain < a2->domain)
1507 if (a1->bus > a2->bus)
1509 if (a1->bus < a2->bus)
1511 if (a1->slot > a2->slot)
1513 if (a1->slot < a2->slot)
1515 if (a1->function > a2->function)
1517 if (a1->function < a2->function)
1523 vlib_pci_get_all_dev_addrs ()
1525 vlib_pci_addr_t *addrs = 0;
1527 err = foreach_directory_file ((char *) sysfs_pci_dev_path, scan_pci_addr,
1528 &addrs, /* scan_dirs */ 0);
1535 vec_sort_with_function (addrs, pci_addr_cmp);
1541 linux_pci_init (vlib_main_t * vm)
1543 vlib_pci_main_t *pm = &pci_main;
1544 vlib_pci_addr_t *addr = 0, *addrs;
1548 ASSERT (sizeof (vlib_pci_addr_t) == sizeof (u32));
1550 addrs = vlib_pci_get_all_dev_addrs ();
1552 vec_foreach (addr, addrs)
1554 vlib_pci_device_info_t *d;
1555 if ((d = vlib_pci_get_device_info (vm, addr, 0)))
1557 init_device_from_registered (vm, d);
1558 vlib_pci_free_device_info (d);
1567 VLIB_INIT_FUNCTION (linux_pci_init) =
1569 .runs_after = VLIB_INITS("unix_input_init"),
1574 * fd.io coding-style-patch-verification: ON
1577 * eval: (c-set-style "gnu")