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_alloc (data, len);
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 u32 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,
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)))
526 /* walk trough all linux interfaces and if interface belonging to
527 this device is founf check if interface is admin up */
528 dir = opendir ("/sys/class/net");
529 s = format (s, "%U%c", format_vlib_pci_addr, addr, 0);
533 error = clib_error_return (0, "Skipping PCI device %U: failed to "
534 "read /sys/class/net",
535 format_vlib_pci_addr, addr);
539 fd = socket (PF_INET, SOCK_DGRAM, 0);
542 error = clib_error_return_unix (0, "socket");
546 while ((e = readdir (dir)))
549 struct ethtool_drvinfo drvinfo;
551 if (e->d_name[0] == '.') /* skip . and .. */
554 clib_memset (&ifr, 0, sizeof ifr);
555 clib_memset (&drvinfo, 0, sizeof drvinfo);
556 ifr.ifr_data = (char *) &drvinfo;
557 clib_strncpy (ifr.ifr_name, e->d_name, sizeof (ifr.ifr_name) - 1);
559 drvinfo.cmd = ETHTOOL_GDRVINFO;
560 if (ioctl (fd, SIOCETHTOOL, &ifr) < 0)
562 /* Some interfaces (eg "lo") don't support this ioctl */
563 if ((errno != ENOTSUP) && (errno != ENODEV))
564 clib_unix_warning ("ioctl fetch intf %s bus info error",
569 if (strcmp ((char *) s, drvinfo.bus_info))
572 clib_memset (&ifr, 0, sizeof (ifr));
573 clib_strncpy (ifr.ifr_name, e->d_name, sizeof (ifr.ifr_name) - 1);
575 if (ioctl (fd, SIOCGIFFLAGS, &ifr) < 0)
577 error = clib_error_return_unix (0, "ioctl fetch intf %s flags",
583 if (ifr.ifr_flags & IFF_UP)
585 vlib_log (VLIB_LOG_LEVEL_WARNING, pci_main.log_default,
586 "Skipping PCI device %U as host "
587 "interface %s is up", format_vlib_pci_addr, addr,
595 vec_reset_length (s);
597 s = format (s, "%v/driver/unbind%c", dev_dir_name, 0);
598 clib_sysfs_write ((char *) s, "%U", format_vlib_pci_addr, addr);
599 vec_reset_length (s);
601 s = format (s, "%v/driver_override%c", dev_dir_name, 0);
602 if (access ((char *) s, F_OK) == 0)
604 clib_sysfs_write ((char *) s, "%s", uio_drv_name);
605 clear_driver_override = 1;
609 vec_reset_length (s);
610 s = format (s, "%s/%s/new_id%c", sysfs_pci_drv_path, uio_drv_name, 0);
611 clib_sysfs_write ((char *) s, "0x%04x 0x%04x", di->vendor_id,
614 vec_reset_length (s);
616 s = format (s, "%s/%s/bind%c", sysfs_pci_drv_path, uio_drv_name, 0);
617 clib_sysfs_write ((char *) s, "%U", format_vlib_pci_addr, addr);
618 vec_reset_length (s);
620 if (clear_driver_override)
622 s = format (s, "%v/driver_override%c", dev_dir_name, 0);
623 clib_sysfs_write ((char *) s, "%c", 0);
624 vec_reset_length (s);
630 vec_free (dev_dir_name);
631 vec_free (driver_name);
636 static clib_error_t *
637 scan_uio_dir (void *arg, u8 * path_name, u8 * file_name)
639 linux_pci_device_t *l = arg;
640 unformat_input_t input;
642 unformat_init_string (&input, (char *) file_name, vec_len (file_name));
644 if (!unformat (&input, "uio%d", &l->uio_minor))
647 unformat_free (&input);
651 static clib_error_t *
652 vfio_set_irqs (vlib_main_t * vm, linux_pci_device_t * p, u32 index, u32 start,
653 u32 count, u32 flags, int *efds)
655 int data_len = efds ? count * sizeof (int) : 0;
656 u8 buf[sizeof (struct vfio_irq_set) + data_len];
657 struct vfio_irq_info ii = { 0 };
658 struct vfio_irq_set *irq_set = (struct vfio_irq_set *) buf;
661 ii.argsz = sizeof (struct vfio_irq_info);
664 if (ioctl (p->fd, VFIO_DEVICE_GET_IRQ_INFO, &ii) < 0)
665 return clib_error_return_unix (0, "ioctl(VFIO_DEVICE_GET_IRQ_INFO) "
666 "'%U'", format_vlib_pci_addr, &p->addr);
668 pci_log_debug (vm, p, "%s index:%u count:%u flags: %s%s%s%s(0x%x)",
669 __func__, ii.index, ii.count,
670 ii.flags & VFIO_IRQ_INFO_EVENTFD ? "eventfd " : "",
671 ii.flags & VFIO_IRQ_INFO_MASKABLE ? "maskable " : "",
672 ii.flags & VFIO_IRQ_INFO_AUTOMASKED ? "automasked " : "",
673 ii.flags & VFIO_IRQ_INFO_NORESIZE ? "noresize " : "",
676 if (ii.count < start + count)
677 return clib_error_return_unix (0, "vfio_set_irq: unexistng interrupt on "
678 "'%U'", format_vlib_pci_addr, &p->addr);
683 flags |= VFIO_IRQ_SET_DATA_EVENTFD;
684 clib_memcpy_fast (&irq_set->data, efds, data_len);
687 flags |= VFIO_IRQ_SET_DATA_NONE;
689 ASSERT ((flags & (VFIO_IRQ_SET_DATA_NONE | VFIO_IRQ_SET_DATA_EVENTFD)) !=
690 (VFIO_IRQ_SET_DATA_NONE | VFIO_IRQ_SET_DATA_EVENTFD));
692 irq_set->argsz = sizeof (struct vfio_irq_set) + data_len;
693 irq_set->index = index;
694 irq_set->start = start;
695 irq_set->count = count;
696 irq_set->flags = flags;
698 if (ioctl (p->fd, VFIO_DEVICE_SET_IRQS, irq_set) < 0)
699 return clib_error_return_unix (0, "%U:ioctl(VFIO_DEVICE_SET_IRQS) "
700 "[index = %u, start = %u, count = %u, "
702 format_vlib_pci_addr, &p->addr,
703 index, start, count, flags);
707 static clib_error_t *
708 linux_pci_uio_read_ready (clib_file_t * uf)
710 vlib_main_t *vm = vlib_get_main ();
711 int __attribute__ ((unused)) rv;
712 vlib_pci_dev_handle_t h = uf->private_data;
713 linux_pci_device_t *p = linux_pci_get_device (h);
714 linux_pci_irq_t *irq = &p->intx_irq;
717 rv = read (uf->file_descriptor, &icount, 4);
719 if (irq->intx_handler)
720 irq->intx_handler (vm, h);
722 vlib_pci_intr_enable (vm, h);
724 return /* no error */ 0;
727 static clib_error_t *
728 linux_pci_vfio_unmask_intx (vlib_main_t * vm, linux_pci_device_t * d)
730 return vfio_set_irqs (vm, d, VFIO_PCI_INTX_IRQ_INDEX, 0, 1,
731 VFIO_IRQ_SET_ACTION_UNMASK, 0);
734 static clib_error_t *
735 linux_pci_uio_error_ready (clib_file_t * uf)
737 u32 error_index = (u32) uf->private_data;
739 return clib_error_return (0, "pci device %d: error", error_index);
742 static clib_error_t *
743 linux_pci_vfio_msix_read_ready (clib_file_t * uf)
745 vlib_main_t *vm = vlib_get_main ();
746 int __attribute__ ((unused)) rv;
747 vlib_pci_dev_handle_t h = uf->private_data >> 16;
748 u16 line = uf->private_data & 0xffff;
749 linux_pci_device_t *p = linux_pci_get_device (h);
750 linux_pci_irq_t *irq = vec_elt_at_index (p->msix_irqs, line);
753 rv = read (uf->file_descriptor, &icount, sizeof (icount));
755 if (irq->msix_handler)
756 irq->msix_handler (vm, h, line);
758 return /* no error */ 0;
761 static clib_error_t *
762 linux_pci_vfio_intx_read_ready (clib_file_t * uf)
764 vlib_main_t *vm = vlib_get_main ();
765 int __attribute__ ((unused)) rv;
766 vlib_pci_dev_handle_t h = uf->private_data;
767 linux_pci_device_t *p = linux_pci_get_device (h);
768 linux_pci_irq_t *irq = &p->intx_irq;
771 rv = read (uf->file_descriptor, &icount, sizeof (icount));
773 if (irq->intx_handler)
774 irq->intx_handler (vm, h);
776 linux_pci_vfio_unmask_intx (vm, p);
778 return /* no error */ 0;
781 static clib_error_t *
782 linux_pci_vfio_error_ready (clib_file_t * uf)
784 u32 error_index = (u32) uf->private_data;
786 return clib_error_return (0, "pci device %d: error", error_index);
789 static clib_error_t *
790 add_device_uio (vlib_main_t * vm, linux_pci_device_t * p,
791 vlib_pci_device_info_t * di, pci_device_registration_t * r)
793 linux_pci_main_t *lpm = &linux_pci_main;
794 clib_error_t *err = 0;
798 p->type = LINUX_PCI_DEVICE_TYPE_UIO;
800 s = format (s, "%s/%U/config%c", sysfs_pci_dev_path,
801 format_vlib_pci_addr, &di->addr, 0);
803 p->config_fd = open ((char *) s, O_RDWR);
804 p->config_offset = 0;
805 vec_reset_length (s);
807 if (p->config_fd == -1)
809 err = clib_error_return_unix (0, "open '%s'", s);
813 s = format (0, "%s/%U/uio%c", sysfs_pci_dev_path,
814 format_vlib_pci_addr, &di->addr, 0);
815 foreach_directory_file ((char *) s, scan_uio_dir, p, /* scan_dirs */
817 vec_reset_length (s);
819 s = format (s, "/dev/uio%d%c", p->uio_minor, 0);
820 p->fd = open ((char *) s, O_RDWR);
823 err = clib_error_return_unix (0, "open '%s'", s);
827 if (r && r->interrupt_handler)
828 vlib_pci_register_intx_handler (vm, p->handle, r->interrupt_handler);
830 if (r && r->init_function)
831 err = r->init_function (lpm->vlib_main, p->handle);
837 if (p->config_fd != -1)
838 close (p->config_fd);
846 vlib_pci_register_intx_handler (vlib_main_t * vm, vlib_pci_dev_handle_t h,
847 pci_intx_handler_function_t * intx_handler)
849 linux_pci_device_t *p = linux_pci_get_device (h);
850 clib_file_t t = { 0 };
851 linux_pci_irq_t *irq = &p->intx_irq;
852 ASSERT (irq->fd == -1);
854 if (p->type == LINUX_PCI_DEVICE_TYPE_VFIO)
856 struct vfio_irq_info ii = { 0 };
857 ii.argsz = sizeof (struct vfio_irq_info);
858 ii.index = VFIO_PCI_INTX_IRQ_INDEX;
859 if (ioctl (p->fd, VFIO_DEVICE_GET_IRQ_INFO, &ii) < 0)
860 return clib_error_return_unix (0, "ioctl(VFIO_DEVICE_GET_IRQ_INFO) '"
861 "%U'", format_vlib_pci_addr, &p->addr);
862 pci_log_debug (vm, p, "%s index:%u count:%u flags: %s%s%s%s(0x%x)",
863 __func__, ii.index, ii.count,
864 ii.flags & VFIO_IRQ_INFO_EVENTFD ? "eventfd " : "",
865 ii.flags & VFIO_IRQ_INFO_MASKABLE ? "maskable " : "",
866 ii.flags & VFIO_IRQ_INFO_AUTOMASKED ? "automasked " : "",
867 ii.flags & VFIO_IRQ_INFO_NORESIZE ? "noresize " : "",
870 return clib_error_return (0, "INTx interrupt does not exist on device"
871 "'%U'", format_vlib_pci_addr, &p->addr);
873 irq->fd = eventfd (0, EFD_NONBLOCK);
875 return clib_error_return_unix (0, "eventfd");
877 t.file_descriptor = irq->fd;
878 t.read_function = linux_pci_vfio_intx_read_ready;
880 else if (p->type == LINUX_PCI_DEVICE_TYPE_UIO)
882 t.file_descriptor = p->fd;
883 t.read_function = linux_pci_uio_read_ready;
888 t.error_function = linux_pci_uio_error_ready;
889 t.private_data = p->handle;
890 t.description = format (0, "PCI %U INTx", format_vlib_pci_addr, &p->addr);
891 irq->clib_file_index = clib_file_add (&file_main, &t);
892 irq->intx_handler = intx_handler;
897 vlib_pci_register_msix_handler (vlib_main_t * vm, vlib_pci_dev_handle_t h,
898 u32 start, u32 count,
899 pci_msix_handler_function_t * msix_handler)
901 clib_error_t *err = 0;
902 linux_pci_device_t *p = linux_pci_get_device (h);
905 if (p->type != LINUX_PCI_DEVICE_TYPE_VFIO)
906 return clib_error_return (0, "vfio driver is needed for MSI-X interrupt "
910 vec_validate_init_empty (p->msix_irqs, start + count - 1, (linux_pci_irq_t)
914 for (i = start; i < start + count; i++)
916 clib_file_t t = { 0 };
917 linux_pci_irq_t *irq = vec_elt_at_index (p->msix_irqs, i);
918 ASSERT (irq->fd == -1);
920 irq->fd = eventfd (0, EFD_NONBLOCK);
923 err = clib_error_return_unix (0, "eventfd");
927 t.read_function = linux_pci_vfio_msix_read_ready;
928 t.file_descriptor = irq->fd;
929 t.error_function = linux_pci_vfio_error_ready;
930 t.private_data = p->handle << 16 | i;
931 t.description = format (0, "PCI %U MSI-X #%u", format_vlib_pci_addr,
933 irq->clib_file_index = clib_file_add (&file_main, &t);
934 irq->msix_handler = msix_handler;
942 linux_pci_irq_t *irq = vec_elt_at_index (p->msix_irqs, i);
945 clib_file_del_by_index (&file_main, irq->clib_file_index);
954 vlib_pci_enable_msix_irq (vlib_main_t * vm, vlib_pci_dev_handle_t h,
955 u16 start, u16 count)
957 linux_pci_device_t *p = linux_pci_get_device (h);
961 if (p->type != LINUX_PCI_DEVICE_TYPE_VFIO)
962 return clib_error_return (0, "vfio driver is needed for MSI-X interrupt "
965 for (i = start; i < start + count; i++)
967 linux_pci_irq_t *irq = vec_elt_at_index (p->msix_irqs, i);
971 return vfio_set_irqs (vm, p, VFIO_PCI_MSIX_IRQ_INDEX, start, count,
972 VFIO_IRQ_SET_ACTION_TRIGGER, fds);
976 vlib_pci_get_msix_file_index (vlib_main_t * vm, vlib_pci_dev_handle_t h,
979 linux_pci_device_t *p = linux_pci_get_device (h);
980 linux_pci_irq_t *irq = vec_elt_at_index (p->msix_irqs, index);
983 return irq->clib_file_index;
987 vlib_pci_disable_msix_irq (vlib_main_t * vm, vlib_pci_dev_handle_t h,
988 u16 start, u16 count)
990 linux_pci_device_t *p = linux_pci_get_device (h);
993 if (p->type != LINUX_PCI_DEVICE_TYPE_VFIO)
994 return clib_error_return (0, "vfio driver is needed for MSI-X interrupt "
997 for (i = start; i < start + count; i++)
1000 return vfio_set_irqs (vm, p, VFIO_PCI_MSIX_IRQ_INDEX, start, count,
1001 VFIO_IRQ_SET_ACTION_TRIGGER, fds);
1004 static clib_error_t *
1005 add_device_vfio (vlib_main_t * vm, linux_pci_device_t * p,
1006 vlib_pci_device_info_t * di, pci_device_registration_t * r)
1008 linux_pci_main_t *lpm = &linux_pci_main;
1009 struct vfio_device_info device_info = { 0 };
1010 struct vfio_region_info reg = { 0 };
1011 clib_error_t *err = 0;
1015 p->type = LINUX_PCI_DEVICE_TYPE_VFIO;
1017 if ((err = linux_vfio_group_get_device_fd (&p->addr, &p->fd, &is_noiommu)))
1020 if (is_noiommu == 0)
1021 p->supports_va_dma = 1;
1023 device_info.argsz = sizeof (device_info);
1024 if (ioctl (p->fd, VFIO_DEVICE_GET_INFO, &device_info) < 0)
1026 err = clib_error_return_unix (0, "ioctl(VFIO_DEVICE_GET_INFO) '%U'",
1027 format_vlib_pci_addr, &di->addr);
1031 reg.argsz = sizeof (struct vfio_region_info);
1032 reg.index = VFIO_PCI_CONFIG_REGION_INDEX;
1033 if (ioctl (p->fd, VFIO_DEVICE_GET_REGION_INFO, ®) < 0)
1035 err = clib_error_return_unix (0, "ioctl(VFIO_DEVICE_GET_INFO) '%U'",
1036 format_vlib_pci_addr, &di->addr);
1040 pci_log_debug (vm, p, "%s %U", __func__, format_vfio_region_info, ®);
1042 p->config_offset = reg.offset;
1043 p->config_fd = p->fd;
1045 /* reset if device supports it */
1046 if (device_info.flags & VFIO_DEVICE_FLAGS_RESET)
1047 if (ioctl (p->fd, VFIO_DEVICE_RESET) < 0)
1049 err = clib_error_return_unix (0, "ioctl(VFIO_DEVICE_RESET) '%U'",
1050 format_vlib_pci_addr, &di->addr);
1054 if (r && r->interrupt_handler)
1056 vlib_pci_register_intx_handler (vm, p->handle, r->interrupt_handler);
1057 linux_pci_vfio_unmask_intx (vm, p);
1060 if (p->supports_va_dma)
1062 vlib_buffer_pool_t *bp;
1064 vec_foreach (bp, vm->buffer_main->buffer_pools)
1067 vlib_physmem_map_t *pm;
1068 pm = vlib_physmem_get_map (vm, bp->physmem_map_index);
1069 for (i = 0; i < pm->n_pages; i++)
1070 vfio_map_physmem_page (vm, pm->base + (i << pm->log2_page_size));
1075 if (r && r->init_function)
1076 err = r->init_function (lpm->vlib_main, p->handle);
1084 if (p->config_fd != -1 && p->config_fd != p->fd)
1085 close (p->config_fd);
1086 p->config_fd = p->fd = -1;
1091 /* Configuration space read/write. */
1093 vlib_pci_read_write_config (vlib_main_t * vm, vlib_pci_dev_handle_t h,
1094 vlib_read_or_write_t read_or_write,
1095 uword address, void *data, u32 n_bytes)
1097 linux_pci_device_t *p = linux_pci_get_device (h);
1100 if (read_or_write == VLIB_READ)
1101 n = pread (p->config_fd, data, n_bytes, p->config_offset + address);
1103 n = pwrite (p->config_fd, data, n_bytes, p->config_offset + address);
1106 return clib_error_return_unix (0, "%s",
1107 read_or_write == VLIB_READ
1108 ? "read" : "write");
1113 static clib_error_t *
1114 vlib_pci_region (vlib_main_t * vm, vlib_pci_dev_handle_t h, u32 bar, int *fd,
1115 u64 * size, u64 * offset)
1117 linux_pci_device_t *p = linux_pci_get_device (h);
1118 clib_error_t *error = 0;
1120 u64 _size = 0, _offset = 0;
1126 if (p->type == LINUX_PCI_DEVICE_TYPE_UIO)
1129 struct stat stat_buf;
1130 file_name = format (0, "%s/%U/resource%d%c", sysfs_pci_dev_path,
1131 format_vlib_pci_addr, &p->addr, bar, 0);
1133 _fd = open ((char *) file_name, O_RDWR);
1136 error = clib_error_return_unix (0, "open `%s'", file_name);
1137 vec_free (file_name);
1141 if (fstat (_fd, &stat_buf) < 0)
1143 error = clib_error_return_unix (0, "fstat `%s'", file_name);
1144 vec_free (file_name);
1149 vec_free (file_name);
1150 _size = stat_buf.st_size;
1153 else if (p->type == LINUX_PCI_DEVICE_TYPE_VFIO)
1155 struct vfio_region_info *r;
1156 u32 sz = sizeof (struct vfio_region_info);
1158 r = clib_mem_alloc (sz);
1159 clib_memset (r, 0, sz);
1162 if (ioctl (p->fd, VFIO_DEVICE_GET_REGION_INFO, r) < 0)
1163 return clib_error_return_unix (0, "ioctl(VFIO_DEVICE_GET_INFO) "
1164 "'%U'", format_vlib_pci_addr,
1174 _offset = r->offset;
1175 pci_log_debug (vm, p, "%s %U", __func__, format_vfio_region_info, r);
1188 static clib_error_t *
1189 vlib_pci_map_region_int (vlib_main_t * vm, vlib_pci_dev_handle_t h,
1190 u32 bar, u8 * addr, void **result)
1192 linux_pci_device_t *p = linux_pci_get_device (h);
1194 clib_error_t *error;
1195 int flags = MAP_SHARED;
1196 u64 size = 0, offset = 0;
1199 pci_log_debug (vm, p, "map region %u to va %p", bar, addr);
1201 if ((error = vlib_pci_read_config_u16 (vm, h, 4, &command)))
1204 if (!(command & PCI_COMMAND_MEMORY))
1206 pci_log_debug (vm, p, "setting memory enable bit");
1207 command |= PCI_COMMAND_MEMORY;
1208 if ((error = vlib_pci_write_config_u16 (vm, h, 4, &command)))
1212 if ((error = vlib_pci_region (vm, h, bar, &fd, &size, &offset)))
1215 if (p->type == LINUX_PCI_DEVICE_TYPE_UIO && addr != 0)
1218 *result = clib_mem_vm_map_shared (addr, size, fd, offset,
1219 "PCIe %U region %u", format_vlib_pci_addr,
1220 vlib_pci_get_addr (vm, h), bar);
1221 if (*result == CLIB_MEM_VM_MAP_FAILED)
1223 error = clib_error_return_unix (0, "mmap `BAR%u'", bar);
1224 if (p->type == LINUX_PCI_DEVICE_TYPE_UIO && (fd != -1))
1230 vec_validate_init_empty (p->regions, bar,
1231 (linux_pci_region_t) { .fd = -1});
1233 if (p->type == LINUX_PCI_DEVICE_TYPE_UIO)
1234 p->regions[bar].fd = fd;
1235 p->regions[bar].addr = *result;
1236 p->regions[bar].size = size;
1241 vlib_pci_map_region (vlib_main_t * vm, vlib_pci_dev_handle_t h, u32 resource,
1244 return (vlib_pci_map_region_int (vm, h, resource, 0 /* addr */ , result));
1248 vlib_pci_map_region_fixed (vlib_main_t * vm, vlib_pci_dev_handle_t h,
1249 u32 resource, u8 * addr, void **result)
1251 return (vlib_pci_map_region_int (vm, h, resource, addr, result));
1255 vlib_pci_io_region (vlib_main_t * vm, vlib_pci_dev_handle_t h, u32 resource)
1257 linux_pci_device_t *p = linux_pci_get_device (h);
1258 clib_error_t *error = 0;
1260 u64 size = 0, offset = 0;
1262 if ((error = vlib_pci_region (vm, h, resource, &fd, &size, &offset)))
1266 p->io_offset = offset;
1271 vlib_pci_read_write_io (vlib_main_t * vm, vlib_pci_dev_handle_t h,
1272 vlib_read_or_write_t read_or_write,
1273 uword offset, void *data, u32 length)
1275 linux_pci_device_t *p = linux_pci_get_device (h);
1278 if (read_or_write == VLIB_READ)
1279 n = pread (p->io_fd, data, length, p->io_offset + offset);
1281 n = pwrite (p->io_fd, data, length, p->io_offset + offset);
1284 return clib_error_return_unix (0, "%s",
1285 read_or_write == VLIB_READ
1286 ? "read" : "write");
1291 vlib_pci_map_dma (vlib_main_t * vm, vlib_pci_dev_handle_t h, void *ptr)
1293 linux_pci_device_t *p = linux_pci_get_device (h);
1295 if (!p->supports_va_dma)
1298 return vfio_map_physmem_page (vm, ptr);
1302 vlib_pci_supports_virtual_addr_dma (vlib_main_t * vm, vlib_pci_dev_handle_t h)
1304 linux_pci_device_t *p = linux_pci_get_device (h);
1306 return p->supports_va_dma != 0;
1310 vlib_pci_device_open (vlib_main_t * vm, vlib_pci_addr_t * addr,
1311 pci_device_id_t ids[], vlib_pci_dev_handle_t * handle)
1313 linux_pci_main_t *lpm = &linux_pci_main;
1314 vlib_pci_device_info_t *di;
1315 linux_pci_device_t *p;
1316 clib_error_t *err = 0;
1319 di = vlib_pci_get_device_info (vm, addr, &err);
1323 for (i = ids; i->vendor_id != 0; i++)
1324 if (i->vendor_id == di->vendor_id && i->device_id == di->device_id)
1327 if (i->vendor_id == 0)
1328 return clib_error_return (0, "Wrong vendor or device id");
1330 pool_get (lpm->linux_pci_devices, p);
1331 p->handle = p - lpm->linux_pci_devices;
1332 p->addr.as_u32 = di->addr.as_u32;
1333 p->intx_irq.fd = -1;
1334 p->intx_irq.clib_file_index = -1;
1335 p->numa_node = di->numa_node;
1337 * pci io bar read/write fd
1341 pci_log_debug (vm, p, "open vid:0x%04x did:0x%04x driver:%s iommu_group:%d",
1342 di->vendor_id, di->device_id, di->driver_name,
1345 if (clib_strncmp ("vfio-pci", (char *) di->driver_name, 8) == 0)
1346 err = add_device_vfio (vm, p, di, 0);
1347 else if (clib_strncmp ("uio_pci_generic", (char *) di->driver_name, 8) == 0)
1348 err = add_device_uio (vm, p, di, 0);
1350 err = clib_error_create ("device not bound to 'vfio-pci' or "
1351 "'uio_pci_generic' kernel module");
1355 *handle = p->handle;
1358 vlib_pci_free_device_info (di);
1361 pci_log_err (vm, p, "%U", format_clib_error, err);
1362 clib_memset (p, 0, sizeof (linux_pci_device_t));
1363 pool_put (lpm->linux_pci_devices, p);
1370 vlib_pci_device_close (vlib_main_t * vm, vlib_pci_dev_handle_t h)
1372 linux_pci_main_t *lpm = &linux_pci_main;
1373 linux_pci_device_t *p = linux_pci_get_device (h);
1374 linux_pci_irq_t *irq;
1375 linux_pci_region_t *res;
1376 clib_error_t *err = 0;
1378 if (p->type == LINUX_PCI_DEVICE_TYPE_UIO)
1381 if (irq->clib_file_index != -1)
1382 clib_file_del_by_index (&file_main, irq->clib_file_index);
1383 close (p->config_fd);
1387 else if (p->type == LINUX_PCI_DEVICE_TYPE_VFIO)
1390 /* close INTx irqs */
1393 err = vfio_set_irqs (vm, p, VFIO_PCI_INTX_IRQ_INDEX, 0, 0,
1394 VFIO_IRQ_SET_ACTION_TRIGGER, 0);
1395 clib_error_free (err);
1396 if (irq->clib_file_index != -1)
1397 clib_file_del_by_index (&file_main, irq->clib_file_index);
1401 /* close MSI-X irqs */
1402 if (vec_len (p->msix_irqs))
1404 err = vfio_set_irqs (vm, p, VFIO_PCI_MSIX_IRQ_INDEX, 0, 0,
1405 VFIO_IRQ_SET_ACTION_TRIGGER, 0);
1406 clib_error_free (err);
1408 vec_foreach (irq, p->msix_irqs)
1412 clib_file_del_by_index (&file_main, irq->clib_file_index);
1416 vec_free (p->msix_irqs);
1421 vec_foreach (res, p->regions)
1425 clib_mem_vm_unmap (res->addr);
1430 vec_free (p->regions);
1433 clib_memset (p, 0, sizeof (linux_pci_device_t));
1434 pool_put (lpm->linux_pci_devices, p);
1438 init_device_from_registered (vlib_main_t * vm, vlib_pci_device_info_t * di)
1440 vlib_pci_main_t *pm = &pci_main;
1441 linux_pci_main_t *lpm = &linux_pci_main;
1442 pci_device_registration_t *r;
1444 clib_error_t *err = 0;
1445 linux_pci_device_t *p;
1447 pool_get (lpm->linux_pci_devices, p);
1448 p->handle = p - lpm->linux_pci_devices;
1449 p->intx_irq.fd = -1;
1451 r = pm->pci_device_registrations;
1455 for (i = r->supported_devices; i->vendor_id != 0; i++)
1456 if (i->vendor_id == di->vendor_id && i->device_id == di->device_id)
1458 if (di->iommu_group != -1)
1459 err = add_device_vfio (vm, p, di, r);
1461 err = add_device_uio (vm, p, di, r);
1464 clib_error_report (err);
1468 r = r->next_registration;
1471 /* No driver, close the PCI config-space FD */
1472 clib_memset (p, 0, sizeof (linux_pci_device_t));
1473 pool_put (lpm->linux_pci_devices, p);
1476 static clib_error_t *
1477 scan_pci_addr (void *arg, u8 * dev_dir_name, u8 * ignored)
1479 vlib_pci_addr_t addr, **addrv = arg;
1480 unformat_input_t input;
1481 clib_error_t *err = 0;
1483 unformat_init_string (&input, (char *) dev_dir_name,
1484 vec_len (dev_dir_name));
1486 if (!unformat (&input, "/sys/bus/pci/devices/%U",
1487 unformat_vlib_pci_addr, &addr))
1488 err = clib_error_return (0, "unformat error `%v`", dev_dir_name);
1490 unformat_free (&input);
1495 vec_add1 (*addrv, addr);
1500 pci_addr_cmp (void *v1, void *v2)
1502 vlib_pci_addr_t *a1 = v1;
1503 vlib_pci_addr_t *a2 = v2;
1505 if (a1->domain > a2->domain)
1507 if (a1->domain < a2->domain)
1509 if (a1->bus > a2->bus)
1511 if (a1->bus < a2->bus)
1513 if (a1->slot > a2->slot)
1515 if (a1->slot < a2->slot)
1517 if (a1->function > a2->function)
1519 if (a1->function < a2->function)
1525 vlib_pci_get_all_dev_addrs ()
1527 vlib_pci_addr_t *addrs = 0;
1529 err = foreach_directory_file ((char *) sysfs_pci_dev_path, scan_pci_addr,
1530 &addrs, /* scan_dirs */ 0);
1537 vec_sort_with_function (addrs, pci_addr_cmp);
1543 linux_pci_init (vlib_main_t * vm)
1545 vlib_pci_main_t *pm = &pci_main;
1546 vlib_pci_addr_t *addr = 0, *addrs;
1550 ASSERT (sizeof (vlib_pci_addr_t) == sizeof (u32));
1552 addrs = vlib_pci_get_all_dev_addrs ();
1554 vec_foreach (addr, addrs)
1556 vlib_pci_device_info_t *d;
1557 if ((d = vlib_pci_get_device_info (vm, addr, 0)))
1559 init_device_from_registered (vm, d);
1560 vlib_pci_free_device_info (d);
1569 VLIB_INIT_FUNCTION (linux_pci_init) =
1571 .runs_after = VLIB_INITS("unix_input_init"),
1576 * fd.io coding-style-patch-verification: ON
1579 * eval: (c-set-style "gnu")