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 #define pci_log_debug(vm, dev, f, ...) \
65 vlib_log(VLIB_LOG_LEVEL_DEBUG, pci_main.log_default, "%U: " f, \
66 format_vlib_pci_addr, vlib_pci_get_addr(vm, dev->handle), ## __VA_ARGS__)
67 #define pci_log_err(vm, dev, f, ...) \
68 vlib_log(VLIB_LOG_LEVEL_ERR, pci_main.log_default, "%U: " f, \
69 format_vlib_pci_addr, vlib_pci_get_addr(vm, dev->handle), ## __VA_ARGS__)
84 pci_intx_handler_function_t *intx_handler;
85 pci_msix_handler_function_t *msix_handler;
91 LINUX_PCI_DEVICE_TYPE_UNKNOWN,
92 LINUX_PCI_DEVICE_TYPE_UIO,
93 LINUX_PCI_DEVICE_TYPE_VFIO,
94 } linux_pci_device_type_t;
98 linux_pci_device_type_t type;
99 vlib_pci_dev_handle_t handle;
100 vlib_pci_addr_t addr;
103 /* Resource file descriptors. */
104 linux_pci_region_t *regions;
106 /* File descriptor for config space read/write. */
110 /* Device File descriptor */
113 /* read/write file descriptor for io bar */
117 /* Minor device for uio device. */
120 /* Interrupt handlers */
121 linux_pci_irq_t intx_irq;
122 linux_pci_irq_t *msix_irqs;
129 } linux_pci_device_t;
131 /* Pool of PCI devices. */
134 vlib_main_t *vlib_main;
135 linux_pci_device_t *linux_pci_devices;
139 extern linux_pci_main_t linux_pci_main;
141 static linux_pci_device_t *
142 linux_pci_get_device (vlib_pci_dev_handle_t h)
144 linux_pci_main_t *lpm = &linux_pci_main;
145 return pool_elt_at_index (lpm->linux_pci_devices, h);
149 vlib_pci_get_private_data (vlib_main_t * vm, vlib_pci_dev_handle_t h)
151 linux_pci_device_t *d = linux_pci_get_device (h);
152 return d->private_data;
156 vlib_pci_set_private_data (vlib_main_t * vm, vlib_pci_dev_handle_t h,
159 linux_pci_device_t *d = linux_pci_get_device (h);
160 d->private_data = private_data;
164 vlib_pci_get_addr (vlib_main_t * vm, vlib_pci_dev_handle_t h)
166 linux_pci_device_t *d = linux_pci_get_device (h);
171 vlib_pci_get_numa_node (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_num_msix_interrupts (vlib_main_t * vm, vlib_pci_dev_handle_t h)
180 linux_pci_device_t *d = linux_pci_get_device (h);
182 if (d->type == LINUX_PCI_DEVICE_TYPE_VFIO)
184 struct vfio_irq_info ii = { 0 };
186 ii.argsz = sizeof (struct vfio_irq_info);
187 ii.index = VFIO_PCI_MSIX_IRQ_INDEX;
188 if (ioctl (d->fd, VFIO_DEVICE_GET_IRQ_INFO, &ii) < 0)
195 /* Call to allocate/initialize the pci subsystem.
196 This is not an init function so that users can explicitly enable
197 pci only when it's needed. */
198 clib_error_t *pci_bus_init (vlib_main_t * vm);
200 linux_pci_main_t linux_pci_main;
202 vlib_pci_device_info_t *
203 vlib_pci_get_device_info (vlib_main_t * vm, vlib_pci_addr_t * addr,
204 clib_error_t ** error)
207 vlib_pci_device_info_t *di;
212 clib_bitmap_t *bmp = 0;
214 di = clib_mem_alloc (sizeof (vlib_pci_device_info_t));
215 clib_memset (di, 0, sizeof (vlib_pci_device_info_t));
216 di->addr.as_u32 = addr->as_u32;
218 u8 *dev_dir_name = format (0, "%s/%U", sysfs_pci_dev_path,
219 format_vlib_pci_addr, addr);
221 f = format (0, "%v/config%c", dev_dir_name, 0);
222 fd = open ((char *) f, O_RDWR);
224 /* Try read-only access if write fails. */
226 fd = open ((char *) f, O_RDONLY);
230 err = clib_error_return_unix (0, "open `%s'", f);
234 /* You can only read more that 64 bytes of config space as root; so we try to
235 read the full space but fall back to just the first 64 bytes. */
236 if (read (fd, &di->config_data, sizeof (di->config_data)) <
237 sizeof (di->config0))
239 err = clib_error_return_unix (0, "read `%s'", f);
245 static pci_config_header_t all_ones;
246 if (all_ones.vendor_id == 0)
247 clib_memset (&all_ones, ~0, sizeof (all_ones));
249 if (!memcmp (&di->config0.header, &all_ones, sizeof (all_ones)))
251 err = clib_error_return (0, "invalid PCI config for `%s'", f);
257 if (di->config0.header.header_type == 0)
258 pci_config_type0_little_to_host (&di->config0);
260 pci_config_type1_little_to_host (&di->config1);
263 vec_reset_length (f);
264 f = format (f, "%v/numa_node%c", dev_dir_name, 0);
265 err = clib_sysfs_read ((char *) f, "%d", &di->numa_node);
269 clib_error_free (err);
271 if (di->numa_node == -1)
273 /* if '/sys/bus/pci/devices/<device id>/numa_node' returns -1 and
274 it is a SMP system, set numa_node to 0. */
275 if ((err = clib_sysfs_read ("/sys/devices/system/node/online", "%U",
276 unformat_bitmap_list, &bmp)))
277 clib_error_free (err);
278 if (clib_bitmap_count_set_bits (bmp) == 1)
282 vec_reset_length (f);
283 f = format (f, "%v/class%c", dev_dir_name, 0);
284 err = clib_sysfs_read ((char *) f, "0x%x", &tmp);
287 di->device_class = tmp >> 8;
289 vec_reset_length (f);
290 f = format (f, "%v/vendor%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/device%c", dev_dir_name, 0);
298 err = clib_sysfs_read ((char *) f, "0x%x", &tmp);
303 vec_reset_length (f);
304 f = format (f, "%v/driver%c", dev_dir_name, 0);
305 di->driver_name = clib_sysfs_link_to_name ((char *) f);
306 if (!di->driver_name)
307 di->driver_name = format (0, "<NONE>%c", 0);
309 di->iommu_group = -1;
310 vec_reset_length (f);
311 f = format (f, "%v/iommu_group%c", dev_dir_name, 0);
312 tmpstr = clib_sysfs_link_to_name ((char *) f);
315 di->iommu_group = atoi ((char *) tmpstr);
319 vec_reset_length (f);
320 f = format (f, "%v/iommu_group/name%c", dev_dir_name, 0);
321 err = clib_sysfs_read ((char *) f, "%s", &tmpstr);
324 if (strncmp ((char *) tmpstr, "vfio-noiommu", 12) == 0)
325 di->flags |= VLIB_PCI_DEVICE_INFO_F_NOIOMMU;
329 clib_error_free (err);
333 vec_reset_length (f);
334 f = format (f, "%v/vpd%c", dev_dir_name, 0);
335 fd = open ((char *) f, O_RDONLY);
344 if (read (fd, &tag, 3) != 3)
347 if (tag[0] != 0x82 && tag[0] != 0x90 && tag[0] != 0x91)
350 len = (tag[2] << 8) | tag[1];
351 vec_validate (data, len - 1);
353 if (read (fd, data, len) != len)
359 di->product_name = data;
360 else if (tag[0] == 0x90)
362 else if (tag[0] == 0x91)
373 vlib_pci_free_device_info (di);
379 vec_free (dev_dir_name);
383 clib_error_free (err);
387 clib_error_t *__attribute__ ((weak))
388 vlib_pci_get_device_root_bus (vlib_pci_addr_t *addr, vlib_pci_addr_t *root_bus)
390 u8 *rel_path = 0, *abs_path = 0, *link_path = 0;
391 unformat_input_t input;
392 int fd = open (sysfs_pci_dev_path, O_RDONLY);
395 clib_error_t *err = NULL;
398 return clib_error_return_unix (0, "failed to open %s", sysfs_pci_dev_path);
400 vec_alloc (rel_path, PATH_MAX);
401 vec_alloc (abs_path, PATH_MAX);
404 format (0, "%s/%U", sysfs_pci_dev_path, format_vlib_pci_addr, addr);
405 size = readlinkat (fd, (char *) link_path, (char *) rel_path, PATH_MAX);
408 err = clib_error_return_unix (0, "failed to read %s", rel_path);
412 rel_path[size] = '\0';
413 vec_free (link_path);
415 link_path = format (0, "%s/%s", sysfs_pci_dev_path, rel_path);
416 if (!realpath ((char *) link_path, (char *) abs_path))
418 err = clib_error_return_unix (0, "failed to resolve %s", link_path);
422 unformat_init_string (&input, (char *) abs_path,
423 clib_strnlen ((char *) abs_path, PATH_MAX));
425 if (!unformat (&input, SYSFS_DEVICES_PCI "%x:%x/%s", &domain, &bus,
428 err = clib_error_return (0, "unknown input '%U'", format_unformat_error,
433 root_bus->domain = domain;
438 vec_free (link_path);
446 directory_exists (char *path)
448 struct stat s = { 0 };
449 if (stat (path, &s) == -1)
452 return S_ISDIR (s.st_mode);
456 vlib_pci_bind_to_uio (vlib_main_t *vm, vlib_pci_addr_t *addr,
457 char *uio_drv_name, int force)
459 clib_error_t *error = 0;
460 u8 *s = 0, *driver_name = 0;
463 vlib_pci_device_info_t *di;
464 int fd, clear_driver_override = 0;
465 u8 *dev_dir_name = format (0, "%s/%U", sysfs_pci_dev_path,
466 format_vlib_pci_addr, addr);
468 di = vlib_pci_get_device_info (vm, addr, &error);
473 if (strncmp ("auto", uio_drv_name, 5) == 0)
475 int vfio_pci_loaded = 0;
477 if (directory_exists ("/sys/module/vfio_pci"))
480 if (di->iommu_group != -1)
482 /* device is bound to IOMMU group */
483 if (!vfio_pci_loaded)
485 error = clib_error_return (0, "Skipping PCI device %U: device "
486 "is bound to IOMMU group and "
487 "vfio-pci driver is not loaded",
488 format_vlib_pci_addr, addr);
492 uio_drv_name = "vfio-pci";
496 /* device is not bound to IOMMU group so we have multiple options */
497 if (vfio_pci_loaded &&
498 (error = clib_sysfs_write (sysfs_mod_vfio_noiommu, "Y")) == 0)
499 uio_drv_name = "vfio-pci";
500 else if (directory_exists ("/sys/module/uio_pci_generic"))
501 uio_drv_name = "uio_pci_generic";
502 else if (directory_exists ("/sys/module/igb_uio"))
503 uio_drv_name = "igb_uio";
506 clib_error_free (error);
507 error = clib_error_return (0, "Skipping PCI device %U: missing "
508 "kernel VFIO or UIO driver",
509 format_vlib_pci_addr, addr);
512 clib_error_free (error);
516 s = format (s, "%v/driver%c", dev_dir_name, 0);
517 driver_name = clib_sysfs_link_to_name ((char *) s);
518 vec_reset_length (s);
521 ((strcmp ("vfio-pci", (char *) driver_name) == 0) ||
522 (strcmp ("uio_pci_generic", (char *) driver_name) == 0) ||
523 (strcmp ("igb_uio", (char *) driver_name) == 0)))
528 /* walk trough all linux interfaces and if interface belonging to
529 this device is found check if interface is admin up */
530 dir = opendir ("/sys/class/net");
531 s = format (s, "%U%c", format_vlib_pci_addr, addr, 0);
535 error = clib_error_return (0,
536 "Skipping PCI device %U: failed to "
537 "read /sys/class/net",
538 format_vlib_pci_addr, addr);
542 fd = socket (PF_INET, SOCK_DGRAM, 0);
545 error = clib_error_return_unix (0, "socket");
549 while ((e = readdir (dir)))
552 struct ethtool_drvinfo drvinfo;
554 if (e->d_name[0] == '.') /* skip . and .. */
557 clib_memset (&ifr, 0, sizeof ifr);
558 clib_memset (&drvinfo, 0, sizeof drvinfo);
559 ifr.ifr_data = (char *) &drvinfo;
560 clib_strncpy (ifr.ifr_name, e->d_name, sizeof (ifr.ifr_name) - 1);
562 drvinfo.cmd = ETHTOOL_GDRVINFO;
563 if (ioctl (fd, SIOCETHTOOL, &ifr) < 0)
565 /* Some interfaces (eg "lo") don't support this ioctl */
566 if ((errno != ENOTSUP) && (errno != ENODEV))
567 clib_unix_warning ("ioctl fetch intf %s bus info error",
572 if (strcmp ((char *) s, drvinfo.bus_info))
575 clib_memset (&ifr, 0, sizeof (ifr));
576 clib_strncpy (ifr.ifr_name, e->d_name, sizeof (ifr.ifr_name) - 1);
578 if (ioctl (fd, SIOCGIFFLAGS, &ifr) < 0)
580 error = clib_error_return_unix (0, "ioctl fetch intf %s flags",
586 if (ifr.ifr_flags & IFF_UP)
588 vlib_log (VLIB_LOG_LEVEL_WARNING, pci_main.log_default,
589 "Skipping PCI device %U as host "
590 "interface %s is up",
591 format_vlib_pci_addr, addr, e->d_name);
598 vec_reset_length (s);
601 s = format (s, "%v/driver/unbind%c", dev_dir_name, 0);
602 clib_sysfs_write ((char *) s, "%U", format_vlib_pci_addr, addr);
603 vec_reset_length (s);
605 s = format (s, "%v/driver_override%c", dev_dir_name, 0);
606 if (access ((char *) s, F_OK) == 0)
608 clib_sysfs_write ((char *) s, "%s", uio_drv_name);
609 clear_driver_override = 1;
613 vec_reset_length (s);
614 s = format (s, "%s/%s/new_id%c", sysfs_pci_drv_path, uio_drv_name, 0);
615 clib_sysfs_write ((char *) s, "0x%04x 0x%04x", di->vendor_id,
618 vec_reset_length (s);
620 s = format (s, "%s/%s/bind%c", sysfs_pci_drv_path, uio_drv_name, 0);
621 clib_sysfs_write ((char *) s, "%U", format_vlib_pci_addr, addr);
622 vec_reset_length (s);
624 if (clear_driver_override)
626 s = format (s, "%v/driver_override%c", dev_dir_name, 0);
627 clib_sysfs_write ((char *) s, "%c", 0);
628 vec_reset_length (s);
635 vec_free (dev_dir_name);
636 vec_free (driver_name);
641 static clib_error_t *
642 scan_uio_dir (void *arg, u8 * path_name, u8 * file_name)
644 linux_pci_device_t *l = arg;
645 unformat_input_t input;
647 unformat_init_string (&input, (char *) file_name, vec_len (file_name));
649 if (!unformat (&input, "uio%d", &l->uio_minor))
652 unformat_free (&input);
656 static clib_error_t *
657 vfio_set_irqs (vlib_main_t * vm, linux_pci_device_t * p, u32 index, u32 start,
658 u32 count, u32 flags, int *efds)
660 int data_len = efds ? count * sizeof (int) : 0;
661 u8 buf[sizeof (struct vfio_irq_set) + data_len];
662 struct vfio_irq_info ii = { 0 };
663 struct vfio_irq_set *irq_set = (struct vfio_irq_set *) buf;
666 ii.argsz = sizeof (struct vfio_irq_info);
669 if (ioctl (p->fd, VFIO_DEVICE_GET_IRQ_INFO, &ii) < 0)
670 return clib_error_return_unix (0, "ioctl(VFIO_DEVICE_GET_IRQ_INFO) "
671 "'%U'", format_vlib_pci_addr, &p->addr);
673 pci_log_debug (vm, p, "%s index:%u count:%u flags: %s%s%s%s(0x%x)",
674 __func__, ii.index, ii.count,
675 ii.flags & VFIO_IRQ_INFO_EVENTFD ? "eventfd " : "",
676 ii.flags & VFIO_IRQ_INFO_MASKABLE ? "maskable " : "",
677 ii.flags & VFIO_IRQ_INFO_AUTOMASKED ? "automasked " : "",
678 ii.flags & VFIO_IRQ_INFO_NORESIZE ? "noresize " : "",
681 if (ii.count < start + count)
682 return clib_error_return_unix (0, "vfio_set_irq: unexistng interrupt on "
683 "'%U'", format_vlib_pci_addr, &p->addr);
688 flags |= VFIO_IRQ_SET_DATA_EVENTFD;
689 clib_memcpy_fast (&irq_set->data, efds, data_len);
692 flags |= VFIO_IRQ_SET_DATA_NONE;
694 ASSERT ((flags & (VFIO_IRQ_SET_DATA_NONE | VFIO_IRQ_SET_DATA_EVENTFD)) !=
695 (VFIO_IRQ_SET_DATA_NONE | VFIO_IRQ_SET_DATA_EVENTFD));
697 irq_set->argsz = sizeof (struct vfio_irq_set) + data_len;
698 irq_set->index = index;
699 irq_set->start = start;
700 irq_set->count = count;
701 irq_set->flags = flags;
703 if (ioctl (p->fd, VFIO_DEVICE_SET_IRQS, irq_set) < 0)
704 return clib_error_return_unix (0, "%U:ioctl(VFIO_DEVICE_SET_IRQS) "
705 "[index = %u, start = %u, count = %u, "
707 format_vlib_pci_addr, &p->addr,
708 index, start, count, flags);
712 static clib_error_t *
713 linux_pci_uio_read_ready (clib_file_t * uf)
715 vlib_main_t *vm = vlib_get_main ();
716 int __attribute__ ((unused)) rv;
717 vlib_pci_dev_handle_t h = uf->private_data;
718 linux_pci_device_t *p = linux_pci_get_device (h);
719 linux_pci_irq_t *irq = &p->intx_irq;
722 rv = read (uf->file_descriptor, &icount, 4);
724 if (irq->intx_handler)
725 irq->intx_handler (vm, h);
727 vlib_pci_intr_enable (vm, h);
729 return /* no error */ 0;
732 static clib_error_t *
733 linux_pci_vfio_unmask_intx (vlib_main_t * vm, linux_pci_device_t * d)
735 return vfio_set_irqs (vm, d, VFIO_PCI_INTX_IRQ_INDEX, 0, 1,
736 VFIO_IRQ_SET_ACTION_UNMASK, 0);
739 static clib_error_t *
740 linux_pci_uio_error_ready (clib_file_t * uf)
742 u32 error_index = (u32) uf->private_data;
744 return clib_error_return (0, "pci device %d: error", error_index);
747 static clib_error_t *
748 linux_pci_vfio_msix_read_ready (clib_file_t * uf)
750 vlib_main_t *vm = vlib_get_main ();
751 int __attribute__ ((unused)) rv;
752 vlib_pci_dev_handle_t h = uf->private_data >> 16;
753 u16 line = uf->private_data & 0xffff;
754 linux_pci_device_t *p = linux_pci_get_device (h);
755 linux_pci_irq_t *irq = vec_elt_at_index (p->msix_irqs, line);
758 rv = read (uf->file_descriptor, &icount, sizeof (icount));
760 if (irq->msix_handler)
761 irq->msix_handler (vm, h, line);
763 return /* no error */ 0;
766 static clib_error_t *
767 linux_pci_vfio_intx_read_ready (clib_file_t * uf)
769 vlib_main_t *vm = vlib_get_main ();
770 int __attribute__ ((unused)) rv;
771 vlib_pci_dev_handle_t h = uf->private_data;
772 linux_pci_device_t *p = linux_pci_get_device (h);
773 linux_pci_irq_t *irq = &p->intx_irq;
776 rv = read (uf->file_descriptor, &icount, sizeof (icount));
778 if (irq->intx_handler)
779 irq->intx_handler (vm, h);
781 linux_pci_vfio_unmask_intx (vm, p);
783 return /* no error */ 0;
786 static clib_error_t *
787 linux_pci_vfio_error_ready (clib_file_t * uf)
789 u32 error_index = (u32) uf->private_data;
791 return clib_error_return (0, "pci device %d: error", error_index);
794 static clib_error_t *
795 add_device_uio (vlib_main_t * vm, linux_pci_device_t * p,
796 vlib_pci_device_info_t * di, pci_device_registration_t * r)
798 linux_pci_main_t *lpm = &linux_pci_main;
799 clib_error_t *err = 0;
803 p->type = LINUX_PCI_DEVICE_TYPE_UIO;
805 s = format (s, "%s/%U/config%c", sysfs_pci_dev_path,
806 format_vlib_pci_addr, &di->addr, 0);
808 p->config_fd = open ((char *) s, O_RDWR);
809 p->config_offset = 0;
810 vec_reset_length (s);
812 if (p->config_fd == -1)
814 err = clib_error_return_unix (0, "open '%s'", s);
818 s = format (0, "%s/%U/uio%c", sysfs_pci_dev_path,
819 format_vlib_pci_addr, &di->addr, 0);
820 foreach_directory_file ((char *) s, scan_uio_dir, p, /* scan_dirs */
822 vec_reset_length (s);
824 s = format (s, "/dev/uio%d%c", p->uio_minor, 0);
825 p->fd = open ((char *) s, O_RDWR);
828 err = clib_error_return_unix (0, "open '%s'", s);
832 if (r && r->interrupt_handler)
833 vlib_pci_register_intx_handler (vm, p->handle, r->interrupt_handler);
835 if (r && r->init_function)
836 err = r->init_function (lpm->vlib_main, p->handle);
842 if (p->config_fd != -1)
843 close (p->config_fd);
851 vlib_pci_register_intx_handler (vlib_main_t * vm, vlib_pci_dev_handle_t h,
852 pci_intx_handler_function_t * intx_handler)
854 linux_pci_device_t *p = linux_pci_get_device (h);
855 clib_file_t t = { 0 };
856 linux_pci_irq_t *irq = &p->intx_irq;
857 ASSERT (irq->fd == -1);
859 if (p->type == LINUX_PCI_DEVICE_TYPE_VFIO)
861 struct vfio_irq_info ii = { 0 };
862 ii.argsz = sizeof (struct vfio_irq_info);
863 ii.index = VFIO_PCI_INTX_IRQ_INDEX;
864 if (ioctl (p->fd, VFIO_DEVICE_GET_IRQ_INFO, &ii) < 0)
865 return clib_error_return_unix (0, "ioctl(VFIO_DEVICE_GET_IRQ_INFO) '"
866 "%U'", format_vlib_pci_addr, &p->addr);
867 pci_log_debug (vm, p, "%s index:%u count:%u flags: %s%s%s%s(0x%x)",
868 __func__, ii.index, ii.count,
869 ii.flags & VFIO_IRQ_INFO_EVENTFD ? "eventfd " : "",
870 ii.flags & VFIO_IRQ_INFO_MASKABLE ? "maskable " : "",
871 ii.flags & VFIO_IRQ_INFO_AUTOMASKED ? "automasked " : "",
872 ii.flags & VFIO_IRQ_INFO_NORESIZE ? "noresize " : "",
875 return clib_error_return (0, "INTx interrupt does not exist on device"
876 "'%U'", format_vlib_pci_addr, &p->addr);
878 irq->fd = eventfd (0, EFD_NONBLOCK);
880 return clib_error_return_unix (0, "eventfd");
882 t.file_descriptor = irq->fd;
883 t.read_function = linux_pci_vfio_intx_read_ready;
885 else if (p->type == LINUX_PCI_DEVICE_TYPE_UIO)
887 t.file_descriptor = p->fd;
888 t.read_function = linux_pci_uio_read_ready;
893 t.error_function = linux_pci_uio_error_ready;
894 t.private_data = p->handle;
895 t.description = format (0, "PCI %U INTx", format_vlib_pci_addr, &p->addr);
896 irq->clib_file_index = clib_file_add (&file_main, &t);
897 irq->intx_handler = intx_handler;
902 vlib_pci_register_msix_handler (vlib_main_t * vm, vlib_pci_dev_handle_t h,
903 u32 start, u32 count,
904 pci_msix_handler_function_t * msix_handler)
906 clib_error_t *err = 0;
907 linux_pci_device_t *p = linux_pci_get_device (h);
910 if (p->type != LINUX_PCI_DEVICE_TYPE_VFIO)
911 return clib_error_return (0, "vfio driver is needed for MSI-X interrupt "
915 vec_validate_init_empty (p->msix_irqs, start + count - 1, (linux_pci_irq_t)
919 for (i = start; i < start + count; i++)
921 clib_file_t t = { 0 };
922 linux_pci_irq_t *irq = vec_elt_at_index (p->msix_irqs, i);
923 ASSERT (irq->fd == -1);
925 irq->fd = eventfd (0, EFD_NONBLOCK);
928 err = clib_error_return_unix (0, "eventfd");
932 t.read_function = linux_pci_vfio_msix_read_ready;
933 t.file_descriptor = irq->fd;
934 t.error_function = linux_pci_vfio_error_ready;
935 t.private_data = p->handle << 16 | i;
936 t.description = format (0, "PCI %U MSI-X #%u", format_vlib_pci_addr,
938 irq->clib_file_index = clib_file_add (&file_main, &t);
939 irq->msix_handler = msix_handler;
947 linux_pci_irq_t *irq = vec_elt_at_index (p->msix_irqs, i);
950 clib_file_del_by_index (&file_main, irq->clib_file_index);
959 vlib_pci_enable_msix_irq (vlib_main_t * vm, vlib_pci_dev_handle_t h,
960 u16 start, u16 count)
962 linux_pci_device_t *p = linux_pci_get_device (h);
966 if (p->type != LINUX_PCI_DEVICE_TYPE_VFIO)
967 return clib_error_return (0, "vfio driver is needed for MSI-X interrupt "
970 for (i = start; i < start + count; i++)
972 linux_pci_irq_t *irq = vec_elt_at_index (p->msix_irqs, i);
976 return vfio_set_irqs (vm, p, VFIO_PCI_MSIX_IRQ_INDEX, start, count,
977 VFIO_IRQ_SET_ACTION_TRIGGER, fds);
981 vlib_pci_get_msix_file_index (vlib_main_t * vm, vlib_pci_dev_handle_t h,
984 linux_pci_device_t *p = linux_pci_get_device (h);
985 linux_pci_irq_t *irq = vec_elt_at_index (p->msix_irqs, index);
988 return irq->clib_file_index;
992 vlib_pci_disable_msix_irq (vlib_main_t * vm, vlib_pci_dev_handle_t h,
993 u16 start, u16 count)
995 linux_pci_device_t *p = linux_pci_get_device (h);
998 if (p->type != LINUX_PCI_DEVICE_TYPE_VFIO)
999 return clib_error_return (0, "vfio driver is needed for MSI-X interrupt "
1002 for (i = start; i < start + count; i++)
1005 return vfio_set_irqs (vm, p, VFIO_PCI_MSIX_IRQ_INDEX, start, count,
1006 VFIO_IRQ_SET_ACTION_TRIGGER, fds);
1009 static clib_error_t *
1010 add_device_vfio (vlib_main_t * vm, linux_pci_device_t * p,
1011 vlib_pci_device_info_t * di, pci_device_registration_t * r)
1013 linux_pci_main_t *lpm = &linux_pci_main;
1014 struct vfio_device_info device_info = { 0 };
1015 struct vfio_region_info reg = { 0 };
1016 clib_error_t *err = 0;
1020 p->type = LINUX_PCI_DEVICE_TYPE_VFIO;
1022 if ((err = linux_vfio_group_get_device_fd (&p->addr, &p->fd, &is_noiommu)))
1025 if (is_noiommu == 0)
1026 p->supports_va_dma = 1;
1028 device_info.argsz = sizeof (device_info);
1029 if (ioctl (p->fd, VFIO_DEVICE_GET_INFO, &device_info) < 0)
1031 err = clib_error_return_unix (0, "ioctl(VFIO_DEVICE_GET_INFO) '%U'",
1032 format_vlib_pci_addr, &di->addr);
1036 reg.argsz = sizeof (struct vfio_region_info);
1037 reg.index = VFIO_PCI_CONFIG_REGION_INDEX;
1038 if (ioctl (p->fd, VFIO_DEVICE_GET_REGION_INFO, ®) < 0)
1040 err = clib_error_return_unix (0, "ioctl(VFIO_DEVICE_GET_INFO) '%U'",
1041 format_vlib_pci_addr, &di->addr);
1045 pci_log_debug (vm, p, "%s %U", __func__, format_vfio_region_info, ®);
1047 p->config_offset = reg.offset;
1048 p->config_fd = p->fd;
1050 /* reset if device supports it */
1051 if (device_info.flags & VFIO_DEVICE_FLAGS_RESET)
1052 if (ioctl (p->fd, VFIO_DEVICE_RESET) < 0)
1054 err = clib_error_return_unix (0, "ioctl(VFIO_DEVICE_RESET) '%U'",
1055 format_vlib_pci_addr, &di->addr);
1059 if (r && r->interrupt_handler)
1061 vlib_pci_register_intx_handler (vm, p->handle, r->interrupt_handler);
1062 linux_pci_vfio_unmask_intx (vm, p);
1065 if (p->supports_va_dma)
1067 vlib_buffer_pool_t *bp;
1069 vec_foreach (bp, vm->buffer_main->buffer_pools)
1072 vlib_physmem_map_t *pm;
1073 pm = vlib_physmem_get_map (vm, bp->physmem_map_index);
1074 for (i = 0; i < pm->n_pages; i++)
1075 vfio_map_physmem_page (vm, pm->base + (i << pm->log2_page_size));
1080 if (r && r->init_function)
1081 err = r->init_function (lpm->vlib_main, p->handle);
1089 if (p->config_fd != -1 && p->config_fd != p->fd)
1090 close (p->config_fd);
1091 p->config_fd = p->fd = -1;
1096 /* Configuration space read/write. */
1098 vlib_pci_read_write_config (vlib_main_t * vm, vlib_pci_dev_handle_t h,
1099 vlib_read_or_write_t read_or_write,
1100 uword address, void *data, u32 n_bytes)
1102 linux_pci_device_t *p = linux_pci_get_device (h);
1105 if (read_or_write == VLIB_READ)
1106 n = pread (p->config_fd, data, n_bytes, p->config_offset + address);
1108 n = pwrite (p->config_fd, data, n_bytes, p->config_offset + address);
1111 return clib_error_return_unix (0, "%s",
1112 read_or_write == VLIB_READ
1113 ? "read" : "write");
1118 static clib_error_t *
1119 vlib_pci_region (vlib_main_t * vm, vlib_pci_dev_handle_t h, u32 bar, int *fd,
1120 u64 * size, u64 * offset)
1122 linux_pci_device_t *p = linux_pci_get_device (h);
1123 clib_error_t *error = 0;
1125 u64 _size = 0, _offset = 0;
1131 if (p->type == LINUX_PCI_DEVICE_TYPE_UIO)
1134 struct stat stat_buf;
1135 file_name = format (0, "%s/%U/resource%d%c", sysfs_pci_dev_path,
1136 format_vlib_pci_addr, &p->addr, bar, 0);
1138 _fd = open ((char *) file_name, O_RDWR);
1141 error = clib_error_return_unix (0, "open `%s'", file_name);
1142 vec_free (file_name);
1146 if (fstat (_fd, &stat_buf) < 0)
1148 error = clib_error_return_unix (0, "fstat `%s'", file_name);
1149 vec_free (file_name);
1154 vec_free (file_name);
1155 _size = stat_buf.st_size;
1158 else if (p->type == LINUX_PCI_DEVICE_TYPE_VFIO)
1160 struct vfio_region_info *r;
1161 u32 sz = sizeof (struct vfio_region_info);
1163 r = clib_mem_alloc (sz);
1164 clib_memset (r, 0, sz);
1167 if (ioctl (p->fd, VFIO_DEVICE_GET_REGION_INFO, r) < 0)
1168 return clib_error_return_unix (0, "ioctl(VFIO_DEVICE_GET_INFO) "
1169 "'%U'", format_vlib_pci_addr,
1179 _offset = r->offset;
1180 pci_log_debug (vm, p, "%s %U", __func__, format_vfio_region_info, r);
1193 static clib_error_t *
1194 vlib_pci_map_region_int (vlib_main_t * vm, vlib_pci_dev_handle_t h,
1195 u32 bar, u8 * addr, void **result)
1197 linux_pci_device_t *p = linux_pci_get_device (h);
1199 clib_error_t *error;
1200 u64 size = 0, offset = 0;
1203 pci_log_debug (vm, p, "map region %u to va %p", bar, addr);
1205 if ((error = vlib_pci_read_config_u16 (vm, h, 4, &command)))
1208 if (!(command & PCI_COMMAND_MEMORY))
1210 pci_log_debug (vm, p, "setting memory enable bit");
1211 command |= PCI_COMMAND_MEMORY;
1212 if ((error = vlib_pci_write_config_u16 (vm, h, 4, &command)))
1216 if ((error = vlib_pci_region (vm, h, bar, &fd, &size, &offset)))
1219 *result = clib_mem_vm_map_shared (addr, size, fd, offset,
1220 "PCIe %U region %u", format_vlib_pci_addr,
1221 vlib_pci_get_addr (vm, h), bar);
1222 if (*result == CLIB_MEM_VM_MAP_FAILED)
1224 error = clib_error_return_unix (0, "mmap `BAR%u'", bar);
1225 if (p->type == LINUX_PCI_DEVICE_TYPE_UIO && (fd != -1))
1231 vec_validate_init_empty (p->regions, bar,
1232 (linux_pci_region_t) { .fd = -1});
1234 if (p->type == LINUX_PCI_DEVICE_TYPE_UIO)
1235 p->regions[bar].fd = fd;
1236 p->regions[bar].addr = *result;
1237 p->regions[bar].size = size;
1242 vlib_pci_map_region (vlib_main_t * vm, vlib_pci_dev_handle_t h, u32 resource,
1245 return (vlib_pci_map_region_int (vm, h, resource, 0 /* addr */ , result));
1249 vlib_pci_map_region_fixed (vlib_main_t * vm, vlib_pci_dev_handle_t h,
1250 u32 resource, u8 * addr, void **result)
1252 return (vlib_pci_map_region_int (vm, h, resource, addr, result));
1256 vlib_pci_io_region (vlib_main_t * vm, vlib_pci_dev_handle_t h, u32 resource)
1258 linux_pci_device_t *p = linux_pci_get_device (h);
1259 clib_error_t *error = 0;
1261 u64 size = 0, offset = 0;
1263 if ((error = vlib_pci_region (vm, h, resource, &fd, &size, &offset)))
1267 p->io_offset = offset;
1272 vlib_pci_read_write_io (vlib_main_t * vm, vlib_pci_dev_handle_t h,
1273 vlib_read_or_write_t read_or_write,
1274 uword offset, void *data, u32 length)
1276 linux_pci_device_t *p = linux_pci_get_device (h);
1279 if (read_or_write == VLIB_READ)
1280 n = pread (p->io_fd, data, length, p->io_offset + offset);
1282 n = pwrite (p->io_fd, data, length, p->io_offset + offset);
1285 return clib_error_return_unix (0, "%s",
1286 read_or_write == VLIB_READ
1287 ? "read" : "write");
1292 vlib_pci_map_dma (vlib_main_t * vm, vlib_pci_dev_handle_t h, void *ptr)
1294 linux_pci_device_t *p = linux_pci_get_device (h);
1296 if (!p->supports_va_dma)
1299 return vfio_map_physmem_page (vm, ptr);
1303 vlib_pci_supports_virtual_addr_dma (vlib_main_t * vm, vlib_pci_dev_handle_t h)
1305 linux_pci_device_t *p = linux_pci_get_device (h);
1307 return p->supports_va_dma != 0;
1311 vlib_pci_device_open (vlib_main_t * vm, vlib_pci_addr_t * addr,
1312 pci_device_id_t ids[], vlib_pci_dev_handle_t * handle)
1314 linux_pci_main_t *lpm = &linux_pci_main;
1315 vlib_pci_device_info_t *di;
1316 linux_pci_device_t *p;
1317 clib_error_t *err = 0;
1320 di = vlib_pci_get_device_info (vm, addr, &err);
1324 for (i = ids; i->vendor_id != 0; i++)
1325 if (i->vendor_id == di->vendor_id && i->device_id == di->device_id)
1328 if (i->vendor_id == 0)
1329 return clib_error_return (0, "Wrong vendor or device id");
1331 pool_get (lpm->linux_pci_devices, p);
1332 p->handle = p - lpm->linux_pci_devices;
1333 p->addr.as_u32 = di->addr.as_u32;
1334 p->intx_irq.fd = -1;
1335 p->intx_irq.clib_file_index = -1;
1336 p->numa_node = di->numa_node;
1338 * pci io bar read/write fd
1342 pci_log_debug (vm, p, "open vid:0x%04x did:0x%04x driver:%s iommu_group:%d",
1343 di->vendor_id, di->device_id, di->driver_name,
1346 if (clib_strncmp ("vfio-pci", (char *) di->driver_name, 8) == 0)
1347 err = add_device_vfio (vm, p, di, 0);
1348 else if (clib_strncmp ("uio_pci_generic", (char *) di->driver_name, 8) == 0)
1349 err = add_device_uio (vm, p, di, 0);
1351 err = clib_error_create ("device not bound to 'vfio-pci' or "
1352 "'uio_pci_generic' kernel module");
1356 *handle = p->handle;
1359 vlib_pci_free_device_info (di);
1362 pci_log_err (vm, p, "%U", format_clib_error, err);
1363 clib_memset (p, 0, sizeof (linux_pci_device_t));
1364 pool_put (lpm->linux_pci_devices, p);
1371 vlib_pci_device_close (vlib_main_t * vm, vlib_pci_dev_handle_t h)
1373 linux_pci_main_t *lpm = &linux_pci_main;
1374 linux_pci_device_t *p = linux_pci_get_device (h);
1375 linux_pci_irq_t *irq;
1376 linux_pci_region_t *res;
1377 clib_error_t *err = 0;
1379 if (p->type == LINUX_PCI_DEVICE_TYPE_UIO)
1382 if (irq->clib_file_index != -1)
1383 clib_file_del_by_index (&file_main, irq->clib_file_index);
1384 close (p->config_fd);
1388 else if (p->type == LINUX_PCI_DEVICE_TYPE_VFIO)
1391 /* close INTx irqs */
1394 err = vfio_set_irqs (vm, p, VFIO_PCI_INTX_IRQ_INDEX, 0, 0,
1395 VFIO_IRQ_SET_ACTION_TRIGGER, 0);
1396 clib_error_free (err);
1397 if (irq->clib_file_index != -1)
1398 clib_file_del_by_index (&file_main, irq->clib_file_index);
1402 /* close MSI-X irqs */
1403 if (vec_len (p->msix_irqs))
1405 err = vfio_set_irqs (vm, p, VFIO_PCI_MSIX_IRQ_INDEX, 0, 0,
1406 VFIO_IRQ_SET_ACTION_TRIGGER, 0);
1407 clib_error_free (err);
1409 vec_foreach (irq, p->msix_irqs)
1413 clib_file_del_by_index (&file_main, irq->clib_file_index);
1417 vec_free (p->msix_irqs);
1422 vec_foreach (res, p->regions)
1426 clib_mem_vm_unmap (res->addr);
1431 vec_free (p->regions);
1434 clib_memset (p, 0, sizeof (linux_pci_device_t));
1435 pool_put (lpm->linux_pci_devices, p);
1439 init_device_from_registered (vlib_main_t * vm, vlib_pci_device_info_t * di)
1441 vlib_pci_main_t *pm = &pci_main;
1442 linux_pci_main_t *lpm = &linux_pci_main;
1443 pci_device_registration_t *r;
1445 clib_error_t *err = 0;
1446 linux_pci_device_t *p;
1448 pool_get (lpm->linux_pci_devices, p);
1449 p->handle = p - lpm->linux_pci_devices;
1450 p->intx_irq.fd = -1;
1452 r = pm->pci_device_registrations;
1456 for (i = r->supported_devices; i->vendor_id != 0; i++)
1457 if (i->vendor_id == di->vendor_id && i->device_id == di->device_id)
1459 if (di->iommu_group != -1)
1460 err = add_device_vfio (vm, p, di, r);
1462 err = add_device_uio (vm, p, di, r);
1465 clib_error_report (err);
1469 r = r->next_registration;
1472 /* No driver, close the PCI config-space FD */
1473 clib_memset (p, 0, sizeof (linux_pci_device_t));
1474 pool_put (lpm->linux_pci_devices, p);
1477 static clib_error_t *
1478 scan_pci_addr (void *arg, u8 * dev_dir_name, u8 * ignored)
1480 vlib_pci_addr_t addr, **addrv = arg;
1481 unformat_input_t input;
1482 clib_error_t *err = 0;
1484 unformat_init_string (&input, (char *) dev_dir_name,
1485 vec_len (dev_dir_name));
1487 if (!unformat (&input, "/sys/bus/pci/devices/%U",
1488 unformat_vlib_pci_addr, &addr))
1489 err = clib_error_return (0, "unformat error `%v`", dev_dir_name);
1491 unformat_free (&input);
1496 vec_add1 (*addrv, addr);
1501 pci_addr_cmp (void *v1, void *v2)
1503 vlib_pci_addr_t *a1 = v1;
1504 vlib_pci_addr_t *a2 = v2;
1506 if (a1->domain > a2->domain)
1508 if (a1->domain < a2->domain)
1510 if (a1->bus > a2->bus)
1512 if (a1->bus < a2->bus)
1514 if (a1->slot > a2->slot)
1516 if (a1->slot < a2->slot)
1518 if (a1->function > a2->function)
1520 if (a1->function < a2->function)
1526 vlib_pci_get_all_dev_addrs ()
1528 vlib_pci_addr_t *addrs = 0;
1530 err = foreach_directory_file ((char *) sysfs_pci_dev_path, scan_pci_addr,
1531 &addrs, /* scan_dirs */ 0);
1538 vec_sort_with_function (addrs, pci_addr_cmp);
1544 linux_pci_init (vlib_main_t * vm)
1546 vlib_pci_main_t *pm = &pci_main;
1547 vlib_pci_addr_t *addr = 0, *addrs;
1551 ASSERT (sizeof (vlib_pci_addr_t) == sizeof (u32));
1553 addrs = vlib_pci_get_all_dev_addrs ();
1555 vec_foreach (addr, addrs)
1557 vlib_pci_device_info_t *d;
1558 if ((d = vlib_pci_get_device_info (vm, addr, 0)))
1560 init_device_from_registered (vm, d);
1561 vlib_pci_free_device_info (d);
1570 VLIB_INIT_FUNCTION (linux_pci_init) =
1572 .runs_after = VLIB_INITS("unix_input_init"),
1577 * fd.io coding-style-patch-verification: ON
1580 * eval: (c-set-style "gnu")