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 static const char *sysfs_pci_dev_path = "/sys/bus/pci/devices";
59 static const char *sysfs_pci_drv_path = "/sys/bus/pci/drivers";
60 static char *sysfs_mod_vfio_noiommu =
61 "/sys/module/vfio/parameters/enable_unsafe_noiommu_mode";
63 #define pci_log_debug(vm, dev, f, ...) \
64 vlib_log(VLIB_LOG_LEVEL_DEBUG, pci_main.log_default, "%U: " f, \
65 format_vlib_pci_addr, vlib_pci_get_addr(vm, dev->handle), ## __VA_ARGS__)
66 #define pci_log_err(vm, dev, f, ...) \
67 vlib_log(VLIB_LOG_LEVEL_ERR, pci_main.log_default, "%U: " f, \
68 format_vlib_pci_addr, vlib_pci_get_addr(vm, dev->handle), ## __VA_ARGS__)
83 pci_intx_handler_function_t *intx_handler;
84 pci_msix_handler_function_t *msix_handler;
90 LINUX_PCI_DEVICE_TYPE_UNKNOWN,
91 LINUX_PCI_DEVICE_TYPE_UIO,
92 LINUX_PCI_DEVICE_TYPE_VFIO,
93 } linux_pci_device_type_t;
97 linux_pci_device_type_t type;
98 vlib_pci_dev_handle_t handle;
102 /* Resource file descriptors. */
103 linux_pci_region_t *regions;
105 /* File descriptor for config space read/write. */
109 /* Device File descriptor */
112 /* read/write file descriptor for io bar */
116 /* Minor device for uio device. */
119 /* Interrupt handlers */
120 linux_pci_irq_t intx_irq;
121 linux_pci_irq_t *msix_irqs;
128 } linux_pci_device_t;
130 /* Pool of PCI devices. */
133 vlib_main_t *vlib_main;
134 linux_pci_device_t *linux_pci_devices;
138 extern linux_pci_main_t linux_pci_main;
140 static linux_pci_device_t *
141 linux_pci_get_device (vlib_pci_dev_handle_t h)
143 linux_pci_main_t *lpm = &linux_pci_main;
144 return pool_elt_at_index (lpm->linux_pci_devices, h);
148 vlib_pci_get_private_data (vlib_main_t * vm, vlib_pci_dev_handle_t h)
150 linux_pci_device_t *d = linux_pci_get_device (h);
151 return d->private_data;
155 vlib_pci_set_private_data (vlib_main_t * vm, vlib_pci_dev_handle_t h,
158 linux_pci_device_t *d = linux_pci_get_device (h);
159 d->private_data = private_data;
163 vlib_pci_get_addr (vlib_main_t * vm, vlib_pci_dev_handle_t h)
165 linux_pci_device_t *d = linux_pci_get_device (h);
170 vlib_pci_get_numa_node (vlib_main_t * vm, vlib_pci_dev_handle_t h)
172 linux_pci_device_t *d = linux_pci_get_device (h);
177 vlib_pci_get_num_msix_interrupts (vlib_main_t * vm, vlib_pci_dev_handle_t h)
179 linux_pci_device_t *d = linux_pci_get_device (h);
181 if (d->type == LINUX_PCI_DEVICE_TYPE_VFIO)
183 struct vfio_irq_info ii = { 0 };
185 ii.argsz = sizeof (struct vfio_irq_info);
186 ii.index = VFIO_PCI_MSIX_IRQ_INDEX;
187 if (ioctl (d->fd, VFIO_DEVICE_GET_IRQ_INFO, &ii) < 0)
194 /* Call to allocate/initialize the pci subsystem.
195 This is not an init function so that users can explicitly enable
196 pci only when it's needed. */
197 clib_error_t *pci_bus_init (vlib_main_t * vm);
199 linux_pci_main_t linux_pci_main;
201 vlib_pci_device_info_t *
202 vlib_pci_get_device_info (vlib_main_t * vm, vlib_pci_addr_t * addr,
203 clib_error_t ** error)
206 vlib_pci_device_info_t *di;
211 clib_bitmap_t *bmp = 0;
213 di = clib_mem_alloc (sizeof (vlib_pci_device_info_t));
214 clib_memset (di, 0, sizeof (vlib_pci_device_info_t));
215 di->addr.as_u32 = addr->as_u32;
217 u8 *dev_dir_name = format (0, "%s/%U", sysfs_pci_dev_path,
218 format_vlib_pci_addr, addr);
220 f = format (0, "%v/config%c", dev_dir_name, 0);
221 fd = open ((char *) f, O_RDWR);
223 /* Try read-only access if write fails. */
225 fd = open ((char *) f, O_RDONLY);
229 err = clib_error_return_unix (0, "open `%s'", f);
233 /* You can only read more that 64 bytes of config space as root; so we try to
234 read the full space but fall back to just the first 64 bytes. */
235 if (read (fd, &di->config_data, sizeof (di->config_data)) <
236 sizeof (di->config0))
238 err = clib_error_return_unix (0, "read `%s'", f);
244 static pci_config_header_t all_ones;
245 if (all_ones.vendor_id == 0)
246 clib_memset (&all_ones, ~0, sizeof (all_ones));
248 if (!memcmp (&di->config0.header, &all_ones, sizeof (all_ones)))
250 err = clib_error_return (0, "invalid PCI config for `%s'", f);
256 if (di->config0.header.header_type == 0)
257 pci_config_type0_little_to_host (&di->config0);
259 pci_config_type1_little_to_host (&di->config1);
262 vec_reset_length (f);
263 f = format (f, "%v/numa_node%c", dev_dir_name, 0);
264 err = clib_sysfs_read ((char *) f, "%d", &di->numa_node);
268 clib_error_free (err);
270 if (di->numa_node == -1)
272 /* if '/sys/bus/pci/devices/<device id>/numa_node' returns -1 and
273 it is a SMP system, set numa_node to 0. */
274 if ((err = clib_sysfs_read ("/sys/devices/system/node/online", "%U",
275 unformat_bitmap_list, &bmp)))
276 clib_error_free (err);
277 if (clib_bitmap_count_set_bits (bmp) == 1)
281 vec_reset_length (f);
282 f = format (f, "%v/class%c", dev_dir_name, 0);
283 err = clib_sysfs_read ((char *) f, "0x%x", &tmp);
286 di->device_class = tmp >> 8;
288 vec_reset_length (f);
289 f = format (f, "%v/vendor%c", dev_dir_name, 0);
290 err = clib_sysfs_read ((char *) f, "0x%x", &tmp);
295 vec_reset_length (f);
296 f = format (f, "%v/device%c", dev_dir_name, 0);
297 err = clib_sysfs_read ((char *) f, "0x%x", &tmp);
302 vec_reset_length (f);
303 f = format (f, "%v/driver%c", dev_dir_name, 0);
304 di->driver_name = clib_sysfs_link_to_name ((char *) f);
305 if (!di->driver_name)
306 di->driver_name = format (0, "<NONE>%c", 0);
308 di->iommu_group = -1;
309 vec_reset_length (f);
310 f = format (f, "%v/iommu_group%c", dev_dir_name, 0);
311 tmpstr = clib_sysfs_link_to_name ((char *) f);
314 di->iommu_group = atoi ((char *) tmpstr);
318 vec_reset_length (f);
319 f = format (f, "%v/iommu_group/name%c", dev_dir_name, 0);
320 err = clib_sysfs_read ((char *) f, "%s", &tmpstr);
323 if (strncmp ((char *) tmpstr, "vfio-noiommu", 12) == 0)
324 di->flags |= VLIB_PCI_DEVICE_INFO_F_NOIOMMU;
328 clib_error_free (err);
332 vec_reset_length (f);
333 f = format (f, "%v/vpd%c", dev_dir_name, 0);
334 fd = open ((char *) f, O_RDONLY);
343 if (read (fd, &tag, 3) != 3)
346 if (tag[0] != 0x82 && tag[0] != 0x90 && tag[0] != 0x91)
349 len = (tag[2] << 8) | tag[1];
350 vec_alloc (data, len);
352 if (read (fd, data, len) != len)
358 di->product_name = data;
359 else if (tag[0] == 0x90)
361 else if (tag[0] == 0x91)
372 vlib_pci_free_device_info (di);
378 vec_free (dev_dir_name);
382 clib_error_free (err);
387 directory_exists (char *path)
389 struct stat s = { 0 };
390 if (stat (path, &s) == -1)
393 return S_ISDIR (s.st_mode);
397 vlib_pci_bind_to_uio (vlib_main_t * vm, vlib_pci_addr_t * addr,
400 clib_error_t *error = 0;
401 u8 *s = 0, *driver_name = 0;
404 vlib_pci_device_info_t *di;
405 int fd, clear_driver_override = 0;
406 u8 *dev_dir_name = format (0, "%s/%U", sysfs_pci_dev_path,
407 format_vlib_pci_addr, addr);
409 di = vlib_pci_get_device_info (vm, addr, &error);
414 if (strncmp ("auto", uio_drv_name, 5) == 0)
416 int vfio_pci_loaded = 0;
418 if (directory_exists ("/sys/module/vfio_pci"))
421 if (di->iommu_group != -1)
423 /* device is bound to IOMMU group */
424 if (!vfio_pci_loaded)
426 error = clib_error_return (0, "Skipping PCI device %U: device "
427 "is bound to IOMMU group and "
428 "vfio-pci driver is not loaded",
429 format_vlib_pci_addr, addr);
433 uio_drv_name = "vfio-pci";
437 /* device is not bound to IOMMU group so we have multiple options */
438 if (vfio_pci_loaded &&
439 (error = clib_sysfs_write (sysfs_mod_vfio_noiommu, "Y")) == 0)
440 uio_drv_name = "vfio-pci";
441 else if (directory_exists ("/sys/module/uio_pci_generic"))
442 uio_drv_name = "uio_pci_generic";
443 else if (directory_exists ("/sys/module/igb_uio"))
444 uio_drv_name = "igb_uio";
447 clib_error_free (error);
448 error = clib_error_return (0, "Skipping PCI device %U: missing "
449 "kernel VFIO or UIO driver",
450 format_vlib_pci_addr, addr);
453 clib_error_free (error);
457 s = format (s, "%v/driver%c", dev_dir_name, 0);
458 driver_name = clib_sysfs_link_to_name ((char *) s);
459 vec_reset_length (s);
462 ((strcmp ("vfio-pci", (char *) driver_name) == 0) ||
463 (strcmp ("uio_pci_generic", (char *) driver_name) == 0) ||
464 (strcmp ("igb_uio", (char *) driver_name) == 0)))
467 /* walk trough all linux interfaces and if interface belonging to
468 this device is founf check if interface is admin up */
469 dir = opendir ("/sys/class/net");
470 s = format (s, "%U%c", format_vlib_pci_addr, addr, 0);
474 error = clib_error_return (0, "Skipping PCI device %U: failed to "
475 "read /sys/class/net",
476 format_vlib_pci_addr, addr);
480 fd = socket (PF_INET, SOCK_DGRAM, 0);
483 error = clib_error_return_unix (0, "socket");
487 while ((e = readdir (dir)))
490 struct ethtool_drvinfo drvinfo;
492 if (e->d_name[0] == '.') /* skip . and .. */
495 clib_memset (&ifr, 0, sizeof ifr);
496 clib_memset (&drvinfo, 0, sizeof drvinfo);
497 ifr.ifr_data = (char *) &drvinfo;
498 clib_strncpy (ifr.ifr_name, e->d_name, sizeof (ifr.ifr_name) - 1);
500 drvinfo.cmd = ETHTOOL_GDRVINFO;
501 if (ioctl (fd, SIOCETHTOOL, &ifr) < 0)
503 /* Some interfaces (eg "lo") don't support this ioctl */
504 if ((errno != ENOTSUP) && (errno != ENODEV))
505 clib_unix_warning ("ioctl fetch intf %s bus info error",
510 if (strcmp ((char *) s, drvinfo.bus_info))
513 clib_memset (&ifr, 0, sizeof (ifr));
514 clib_strncpy (ifr.ifr_name, e->d_name, sizeof (ifr.ifr_name) - 1);
516 if (ioctl (fd, SIOCGIFFLAGS, &ifr) < 0)
518 error = clib_error_return_unix (0, "ioctl fetch intf %s flags",
524 if (ifr.ifr_flags & IFF_UP)
526 vlib_log (VLIB_LOG_LEVEL_WARNING, pci_main.log_default,
527 "Skipping PCI device %U as host "
528 "interface %s is up", format_vlib_pci_addr, addr,
536 vec_reset_length (s);
538 s = format (s, "%v/driver/unbind%c", dev_dir_name, 0);
539 clib_sysfs_write ((char *) s, "%U", format_vlib_pci_addr, addr);
540 vec_reset_length (s);
542 s = format (s, "%v/driver_override%c", dev_dir_name, 0);
543 if (access ((char *) s, F_OK) == 0)
545 clib_sysfs_write ((char *) s, "%s", uio_drv_name);
546 clear_driver_override = 1;
550 vec_reset_length (s);
551 s = format (s, "%s/%s/new_id%c", sysfs_pci_drv_path, uio_drv_name, 0);
552 clib_sysfs_write ((char *) s, "0x%04x 0x%04x", di->vendor_id,
555 vec_reset_length (s);
557 s = format (s, "%s/%s/bind%c", sysfs_pci_drv_path, uio_drv_name, 0);
558 clib_sysfs_write ((char *) s, "%U", format_vlib_pci_addr, addr);
559 vec_reset_length (s);
561 if (clear_driver_override)
563 s = format (s, "%v/driver_override%c", dev_dir_name, 0);
564 clib_sysfs_write ((char *) s, "%c", 0);
565 vec_reset_length (s);
571 vec_free (dev_dir_name);
572 vec_free (driver_name);
577 static clib_error_t *
578 scan_uio_dir (void *arg, u8 * path_name, u8 * file_name)
580 linux_pci_device_t *l = arg;
581 unformat_input_t input;
583 unformat_init_string (&input, (char *) file_name, vec_len (file_name));
585 if (!unformat (&input, "uio%d", &l->uio_minor))
588 unformat_free (&input);
592 static clib_error_t *
593 vfio_set_irqs (vlib_main_t * vm, linux_pci_device_t * p, u32 index, u32 start,
594 u32 count, u32 flags, int *efds)
596 int data_len = efds ? count * sizeof (int) : 0;
597 u8 buf[sizeof (struct vfio_irq_set) + data_len];
598 struct vfio_irq_info ii = { 0 };
599 struct vfio_irq_set *irq_set = (struct vfio_irq_set *) buf;
602 ii.argsz = sizeof (struct vfio_irq_info);
605 if (ioctl (p->fd, VFIO_DEVICE_GET_IRQ_INFO, &ii) < 0)
606 return clib_error_return_unix (0, "ioctl(VFIO_DEVICE_GET_IRQ_INFO) "
607 "'%U'", format_vlib_pci_addr, &p->addr);
609 pci_log_debug (vm, p, "%s index:%u count:%u flags: %s%s%s%s(0x%x)",
610 __func__, ii.index, ii.count,
611 ii.flags & VFIO_IRQ_INFO_EVENTFD ? "eventfd " : "",
612 ii.flags & VFIO_IRQ_INFO_MASKABLE ? "maskable " : "",
613 ii.flags & VFIO_IRQ_INFO_AUTOMASKED ? "automasked " : "",
614 ii.flags & VFIO_IRQ_INFO_NORESIZE ? "noresize " : "",
617 if (ii.count < start + count)
618 return clib_error_return_unix (0, "vfio_set_irq: unexistng interrupt on "
619 "'%U'", format_vlib_pci_addr, &p->addr);
624 flags |= VFIO_IRQ_SET_DATA_EVENTFD;
625 clib_memcpy_fast (&irq_set->data, efds, data_len);
628 flags |= VFIO_IRQ_SET_DATA_NONE;
630 ASSERT ((flags & (VFIO_IRQ_SET_DATA_NONE | VFIO_IRQ_SET_DATA_EVENTFD)) !=
631 (VFIO_IRQ_SET_DATA_NONE | VFIO_IRQ_SET_DATA_EVENTFD));
633 irq_set->argsz = sizeof (struct vfio_irq_set) + data_len;
634 irq_set->index = index;
635 irq_set->start = start;
636 irq_set->count = count;
637 irq_set->flags = flags;
639 if (ioctl (p->fd, VFIO_DEVICE_SET_IRQS, irq_set) < 0)
640 return clib_error_return_unix (0, "%U:ioctl(VFIO_DEVICE_SET_IRQS) "
641 "[index = %u, start = %u, count = %u, "
643 format_vlib_pci_addr, &p->addr,
644 index, start, count, flags);
648 static clib_error_t *
649 linux_pci_uio_read_ready (clib_file_t * uf)
651 vlib_main_t *vm = vlib_get_main ();
652 int __attribute__ ((unused)) rv;
653 vlib_pci_dev_handle_t h = uf->private_data;
654 linux_pci_device_t *p = linux_pci_get_device (h);
655 linux_pci_irq_t *irq = &p->intx_irq;
658 rv = read (uf->file_descriptor, &icount, 4);
660 if (irq->intx_handler)
661 irq->intx_handler (vm, h);
663 vlib_pci_intr_enable (vm, h);
665 return /* no error */ 0;
668 static clib_error_t *
669 linux_pci_vfio_unmask_intx (vlib_main_t * vm, linux_pci_device_t * d)
671 return vfio_set_irqs (vm, d, VFIO_PCI_INTX_IRQ_INDEX, 0, 1,
672 VFIO_IRQ_SET_ACTION_UNMASK, 0);
675 static clib_error_t *
676 linux_pci_uio_error_ready (clib_file_t * uf)
678 u32 error_index = (u32) uf->private_data;
680 return clib_error_return (0, "pci device %d: error", error_index);
683 static clib_error_t *
684 linux_pci_vfio_msix_read_ready (clib_file_t * uf)
686 vlib_main_t *vm = vlib_get_main ();
687 int __attribute__ ((unused)) rv;
688 vlib_pci_dev_handle_t h = uf->private_data >> 16;
689 u16 line = uf->private_data & 0xffff;
690 linux_pci_device_t *p = linux_pci_get_device (h);
691 linux_pci_irq_t *irq = vec_elt_at_index (p->msix_irqs, line);
694 rv = read (uf->file_descriptor, &icount, sizeof (icount));
696 if (irq->msix_handler)
697 irq->msix_handler (vm, h, line);
699 return /* no error */ 0;
702 static clib_error_t *
703 linux_pci_vfio_intx_read_ready (clib_file_t * uf)
705 vlib_main_t *vm = vlib_get_main ();
706 int __attribute__ ((unused)) rv;
707 vlib_pci_dev_handle_t h = uf->private_data;
708 linux_pci_device_t *p = linux_pci_get_device (h);
709 linux_pci_irq_t *irq = &p->intx_irq;
712 rv = read (uf->file_descriptor, &icount, sizeof (icount));
714 if (irq->intx_handler)
715 irq->intx_handler (vm, h);
717 linux_pci_vfio_unmask_intx (vm, p);
719 return /* no error */ 0;
722 static clib_error_t *
723 linux_pci_vfio_error_ready (clib_file_t * uf)
725 u32 error_index = (u32) uf->private_data;
727 return clib_error_return (0, "pci device %d: error", error_index);
730 static clib_error_t *
731 add_device_uio (vlib_main_t * vm, linux_pci_device_t * p,
732 vlib_pci_device_info_t * di, pci_device_registration_t * r)
734 linux_pci_main_t *lpm = &linux_pci_main;
735 clib_error_t *err = 0;
739 p->type = LINUX_PCI_DEVICE_TYPE_UIO;
741 s = format (s, "%s/%U/config%c", sysfs_pci_dev_path,
742 format_vlib_pci_addr, &di->addr, 0);
744 p->config_fd = open ((char *) s, O_RDWR);
745 p->config_offset = 0;
746 vec_reset_length (s);
748 if (p->config_fd == -1)
750 err = clib_error_return_unix (0, "open '%s'", s);
754 s = format (0, "%s/%U/uio%c", sysfs_pci_dev_path,
755 format_vlib_pci_addr, &di->addr, 0);
756 foreach_directory_file ((char *) s, scan_uio_dir, p, /* scan_dirs */
758 vec_reset_length (s);
760 s = format (s, "/dev/uio%d%c", p->uio_minor, 0);
761 p->fd = open ((char *) s, O_RDWR);
764 err = clib_error_return_unix (0, "open '%s'", s);
768 if (r && r->interrupt_handler)
769 vlib_pci_register_intx_handler (vm, p->handle, r->interrupt_handler);
771 if (r && r->init_function)
772 err = r->init_function (lpm->vlib_main, p->handle);
778 if (p->config_fd != -1)
779 close (p->config_fd);
787 vlib_pci_register_intx_handler (vlib_main_t * vm, vlib_pci_dev_handle_t h,
788 pci_intx_handler_function_t * intx_handler)
790 linux_pci_device_t *p = linux_pci_get_device (h);
791 clib_file_t t = { 0 };
792 linux_pci_irq_t *irq = &p->intx_irq;
793 ASSERT (irq->fd == -1);
795 if (p->type == LINUX_PCI_DEVICE_TYPE_VFIO)
797 struct vfio_irq_info ii = { 0 };
798 ii.argsz = sizeof (struct vfio_irq_info);
799 ii.index = VFIO_PCI_INTX_IRQ_INDEX;
800 if (ioctl (p->fd, VFIO_DEVICE_GET_IRQ_INFO, &ii) < 0)
801 return clib_error_return_unix (0, "ioctl(VFIO_DEVICE_GET_IRQ_INFO) '"
802 "%U'", format_vlib_pci_addr, &p->addr);
803 pci_log_debug (vm, p, "%s index:%u count:%u flags: %s%s%s%s(0x%x)",
804 __func__, ii.index, ii.count,
805 ii.flags & VFIO_IRQ_INFO_EVENTFD ? "eventfd " : "",
806 ii.flags & VFIO_IRQ_INFO_MASKABLE ? "maskable " : "",
807 ii.flags & VFIO_IRQ_INFO_AUTOMASKED ? "automasked " : "",
808 ii.flags & VFIO_IRQ_INFO_NORESIZE ? "noresize " : "",
811 return clib_error_return (0, "INTx interrupt does not exist on device"
812 "'%U'", format_vlib_pci_addr, &p->addr);
814 irq->fd = eventfd (0, EFD_NONBLOCK);
816 return clib_error_return_unix (0, "eventfd");
818 t.file_descriptor = irq->fd;
819 t.read_function = linux_pci_vfio_intx_read_ready;
821 else if (p->type == LINUX_PCI_DEVICE_TYPE_UIO)
823 t.file_descriptor = p->fd;
824 t.read_function = linux_pci_uio_read_ready;
829 t.error_function = linux_pci_uio_error_ready;
830 t.private_data = p->handle;
831 t.description = format (0, "PCI %U INTx", format_vlib_pci_addr, &p->addr);
832 irq->clib_file_index = clib_file_add (&file_main, &t);
833 irq->intx_handler = intx_handler;
838 vlib_pci_register_msix_handler (vlib_main_t * vm, vlib_pci_dev_handle_t h,
839 u32 start, u32 count,
840 pci_msix_handler_function_t * msix_handler)
842 clib_error_t *err = 0;
843 linux_pci_device_t *p = linux_pci_get_device (h);
846 if (p->type != LINUX_PCI_DEVICE_TYPE_VFIO)
847 return clib_error_return (0, "vfio driver is needed for MSI-X interrupt "
851 vec_validate_init_empty (p->msix_irqs, start + count - 1, (linux_pci_irq_t)
855 for (i = start; i < start + count; i++)
857 clib_file_t t = { 0 };
858 linux_pci_irq_t *irq = vec_elt_at_index (p->msix_irqs, i);
859 ASSERT (irq->fd == -1);
861 irq->fd = eventfd (0, EFD_NONBLOCK);
864 err = clib_error_return_unix (0, "eventfd");
868 t.read_function = linux_pci_vfio_msix_read_ready;
869 t.file_descriptor = irq->fd;
870 t.error_function = linux_pci_vfio_error_ready;
871 t.private_data = p->handle << 16 | i;
872 t.description = format (0, "PCI %U MSI-X #%u", format_vlib_pci_addr,
874 irq->clib_file_index = clib_file_add (&file_main, &t);
875 irq->msix_handler = msix_handler;
883 linux_pci_irq_t *irq = vec_elt_at_index (p->msix_irqs, i);
886 clib_file_del_by_index (&file_main, irq->clib_file_index);
895 vlib_pci_enable_msix_irq (vlib_main_t * vm, vlib_pci_dev_handle_t h,
896 u16 start, u16 count)
898 linux_pci_device_t *p = linux_pci_get_device (h);
902 if (p->type != LINUX_PCI_DEVICE_TYPE_VFIO)
903 return clib_error_return (0, "vfio driver is needed for MSI-X interrupt "
906 for (i = start; i < start + count; i++)
908 linux_pci_irq_t *irq = vec_elt_at_index (p->msix_irqs, i);
912 return vfio_set_irqs (vm, p, VFIO_PCI_MSIX_IRQ_INDEX, start, count,
913 VFIO_IRQ_SET_ACTION_TRIGGER, fds);
917 vlib_pci_get_msix_file_index (vlib_main_t * vm, vlib_pci_dev_handle_t h,
920 linux_pci_device_t *p = linux_pci_get_device (h);
921 linux_pci_irq_t *irq = vec_elt_at_index (p->msix_irqs, index);
924 return irq->clib_file_index;
928 vlib_pci_disable_msix_irq (vlib_main_t * vm, vlib_pci_dev_handle_t h,
929 u16 start, u16 count)
931 linux_pci_device_t *p = linux_pci_get_device (h);
934 if (p->type != LINUX_PCI_DEVICE_TYPE_VFIO)
935 return clib_error_return (0, "vfio driver is needed for MSI-X interrupt "
938 for (i = start; i < start + count; i++)
941 return vfio_set_irqs (vm, p, VFIO_PCI_MSIX_IRQ_INDEX, start, count,
942 VFIO_IRQ_SET_ACTION_TRIGGER, fds);
945 static clib_error_t *
946 add_device_vfio (vlib_main_t * vm, linux_pci_device_t * p,
947 vlib_pci_device_info_t * di, pci_device_registration_t * r)
949 linux_pci_main_t *lpm = &linux_pci_main;
950 struct vfio_device_info device_info = { 0 };
951 struct vfio_region_info reg = { 0 };
952 clib_error_t *err = 0;
956 p->type = LINUX_PCI_DEVICE_TYPE_VFIO;
958 if ((err = linux_vfio_group_get_device_fd (&p->addr, &p->fd, &is_noiommu)))
962 p->supports_va_dma = 1;
964 device_info.argsz = sizeof (device_info);
965 if (ioctl (p->fd, VFIO_DEVICE_GET_INFO, &device_info) < 0)
967 err = clib_error_return_unix (0, "ioctl(VFIO_DEVICE_GET_INFO) '%U'",
968 format_vlib_pci_addr, &di->addr);
972 reg.argsz = sizeof (struct vfio_region_info);
973 reg.index = VFIO_PCI_CONFIG_REGION_INDEX;
974 if (ioctl (p->fd, VFIO_DEVICE_GET_REGION_INFO, ®) < 0)
976 err = clib_error_return_unix (0, "ioctl(VFIO_DEVICE_GET_INFO) '%U'",
977 format_vlib_pci_addr, &di->addr);
981 pci_log_debug (vm, p, "%s %U", __func__, format_vfio_region_info, ®);
983 p->config_offset = reg.offset;
984 p->config_fd = p->fd;
986 /* reset if device supports it */
987 if (device_info.flags & VFIO_DEVICE_FLAGS_RESET)
988 if (ioctl (p->fd, VFIO_DEVICE_RESET) < 0)
990 err = clib_error_return_unix (0, "ioctl(VFIO_DEVICE_RESET) '%U'",
991 format_vlib_pci_addr, &di->addr);
995 if (r && r->interrupt_handler)
997 vlib_pci_register_intx_handler (vm, p->handle, r->interrupt_handler);
998 linux_pci_vfio_unmask_intx (vm, p);
1001 if (p->supports_va_dma)
1003 vlib_buffer_pool_t *bp;
1005 vec_foreach (bp, vm->buffer_main->buffer_pools)
1008 vlib_physmem_map_t *pm;
1009 pm = vlib_physmem_get_map (vm, bp->physmem_map_index);
1010 for (i = 0; i < pm->n_pages; i++)
1011 vfio_map_physmem_page (vm, pm->base + (i << pm->log2_page_size));
1016 if (r && r->init_function)
1017 err = r->init_function (lpm->vlib_main, p->handle);
1025 if (p->config_fd != -1 && p->config_fd != p->fd)
1026 close (p->config_fd);
1027 p->config_fd = p->fd = -1;
1032 /* Configuration space read/write. */
1034 vlib_pci_read_write_config (vlib_main_t * vm, vlib_pci_dev_handle_t h,
1035 vlib_read_or_write_t read_or_write,
1036 uword address, void *data, u32 n_bytes)
1038 linux_pci_device_t *p = linux_pci_get_device (h);
1041 if (read_or_write == VLIB_READ)
1042 n = pread (p->config_fd, data, n_bytes, p->config_offset + address);
1044 n = pwrite (p->config_fd, data, n_bytes, p->config_offset + address);
1047 return clib_error_return_unix (0, "%s",
1048 read_or_write == VLIB_READ
1049 ? "read" : "write");
1054 static clib_error_t *
1055 vlib_pci_region (vlib_main_t * vm, vlib_pci_dev_handle_t h, u32 bar, int *fd,
1056 u64 * size, u64 * offset)
1058 linux_pci_device_t *p = linux_pci_get_device (h);
1059 clib_error_t *error = 0;
1061 u64 _size = 0, _offset = 0;
1067 if (p->type == LINUX_PCI_DEVICE_TYPE_UIO)
1070 struct stat stat_buf;
1071 file_name = format (0, "%s/%U/resource%d%c", sysfs_pci_dev_path,
1072 format_vlib_pci_addr, &p->addr, bar, 0);
1074 _fd = open ((char *) file_name, O_RDWR);
1077 error = clib_error_return_unix (0, "open `%s'", file_name);
1078 vec_free (file_name);
1082 if (fstat (_fd, &stat_buf) < 0)
1084 error = clib_error_return_unix (0, "fstat `%s'", file_name);
1085 vec_free (file_name);
1090 vec_free (file_name);
1091 _size = stat_buf.st_size;
1094 else if (p->type == LINUX_PCI_DEVICE_TYPE_VFIO)
1096 struct vfio_region_info *r;
1097 u32 sz = sizeof (struct vfio_region_info);
1099 r = clib_mem_alloc (sz);
1100 clib_memset (r, 0, sz);
1103 if (ioctl (p->fd, VFIO_DEVICE_GET_REGION_INFO, r) < 0)
1104 return clib_error_return_unix (0, "ioctl(VFIO_DEVICE_GET_INFO) "
1105 "'%U'", format_vlib_pci_addr,
1115 _offset = r->offset;
1116 pci_log_debug (vm, p, "%s %U", __func__, format_vfio_region_info, r);
1129 static clib_error_t *
1130 vlib_pci_map_region_int (vlib_main_t * vm, vlib_pci_dev_handle_t h,
1131 u32 bar, u8 * addr, void **result)
1133 linux_pci_device_t *p = linux_pci_get_device (h);
1135 clib_error_t *error;
1136 int flags = MAP_SHARED;
1137 u64 size = 0, offset = 0;
1140 pci_log_debug (vm, p, "map region %u to va %p", bar, addr);
1142 if ((error = vlib_pci_read_config_u16 (vm, h, 4, &command)))
1145 if (!(command & PCI_COMMAND_MEMORY))
1147 pci_log_debug (vm, p, "setting memory enable bit");
1148 command |= PCI_COMMAND_MEMORY;
1149 if ((error = vlib_pci_write_config_u16 (vm, h, 4, &command)))
1153 if ((error = vlib_pci_region (vm, h, bar, &fd, &size, &offset)))
1156 if (p->type == LINUX_PCI_DEVICE_TYPE_UIO && addr != 0)
1159 *result = clib_mem_vm_map_shared (addr, size, fd, offset,
1160 "PCIe %U region %u", format_vlib_pci_addr,
1161 vlib_pci_get_addr (vm, h), bar);
1162 if (*result == CLIB_MEM_VM_MAP_FAILED)
1164 error = clib_error_return_unix (0, "mmap `BAR%u'", bar);
1165 if (p->type == LINUX_PCI_DEVICE_TYPE_UIO && (fd != -1))
1171 vec_validate_init_empty (p->regions, bar,
1172 (linux_pci_region_t) { .fd = -1});
1174 if (p->type == LINUX_PCI_DEVICE_TYPE_UIO)
1175 p->regions[bar].fd = fd;
1176 p->regions[bar].addr = *result;
1177 p->regions[bar].size = size;
1182 vlib_pci_map_region (vlib_main_t * vm, vlib_pci_dev_handle_t h, u32 resource,
1185 return (vlib_pci_map_region_int (vm, h, resource, 0 /* addr */ , result));
1189 vlib_pci_map_region_fixed (vlib_main_t * vm, vlib_pci_dev_handle_t h,
1190 u32 resource, u8 * addr, void **result)
1192 return (vlib_pci_map_region_int (vm, h, resource, addr, result));
1196 vlib_pci_io_region (vlib_main_t * vm, vlib_pci_dev_handle_t h, u32 resource)
1198 linux_pci_device_t *p = linux_pci_get_device (h);
1199 clib_error_t *error = 0;
1201 u64 size = 0, offset = 0;
1203 if ((error = vlib_pci_region (vm, h, resource, &fd, &size, &offset)))
1207 p->io_offset = offset;
1212 vlib_pci_read_write_io (vlib_main_t * vm, vlib_pci_dev_handle_t h,
1213 vlib_read_or_write_t read_or_write,
1214 uword offset, void *data, u32 length)
1216 linux_pci_device_t *p = linux_pci_get_device (h);
1219 if (read_or_write == VLIB_READ)
1220 n = pread (p->io_fd, data, length, p->io_offset + offset);
1222 n = pwrite (p->io_fd, data, length, p->io_offset + offset);
1225 return clib_error_return_unix (0, "%s",
1226 read_or_write == VLIB_READ
1227 ? "read" : "write");
1232 vlib_pci_map_dma (vlib_main_t * vm, vlib_pci_dev_handle_t h, void *ptr)
1234 linux_pci_device_t *p = linux_pci_get_device (h);
1236 if (!p->supports_va_dma)
1239 return vfio_map_physmem_page (vm, ptr);
1243 vlib_pci_supports_virtual_addr_dma (vlib_main_t * vm, vlib_pci_dev_handle_t h)
1245 linux_pci_device_t *p = linux_pci_get_device (h);
1247 return p->supports_va_dma != 0;
1251 vlib_pci_device_open (vlib_main_t * vm, vlib_pci_addr_t * addr,
1252 pci_device_id_t ids[], vlib_pci_dev_handle_t * handle)
1254 linux_pci_main_t *lpm = &linux_pci_main;
1255 vlib_pci_device_info_t *di;
1256 linux_pci_device_t *p;
1257 clib_error_t *err = 0;
1260 di = vlib_pci_get_device_info (vm, addr, &err);
1264 for (i = ids; i->vendor_id != 0; i++)
1265 if (i->vendor_id == di->vendor_id && i->device_id == di->device_id)
1268 if (i->vendor_id == 0)
1269 return clib_error_return (0, "Wrong vendor or device id");
1271 pool_get (lpm->linux_pci_devices, p);
1272 p->handle = p - lpm->linux_pci_devices;
1273 p->addr.as_u32 = di->addr.as_u32;
1274 p->intx_irq.fd = -1;
1275 p->intx_irq.clib_file_index = -1;
1276 p->numa_node = di->numa_node;
1278 * pci io bar read/write fd
1282 pci_log_debug (vm, p, "open vid:0x%04x did:0x%04x driver:%s iommu_group:%d",
1283 di->vendor_id, di->device_id, di->driver_name,
1286 if (clib_strncmp ("vfio-pci", (char *) di->driver_name, 8) == 0)
1287 err = add_device_vfio (vm, p, di, 0);
1288 else if (clib_strncmp ("uio_pci_generic", (char *) di->driver_name, 8) == 0)
1289 err = add_device_uio (vm, p, di, 0);
1291 err = clib_error_create ("device not bound to 'vfio-pci' or "
1292 "'uio_pci_generic' kernel module");
1296 *handle = p->handle;
1299 vlib_pci_free_device_info (di);
1302 pci_log_err (vm, p, "%U", format_clib_error, err);
1303 clib_memset (p, 0, sizeof (linux_pci_device_t));
1304 pool_put (lpm->linux_pci_devices, p);
1311 vlib_pci_device_close (vlib_main_t * vm, vlib_pci_dev_handle_t h)
1313 linux_pci_main_t *lpm = &linux_pci_main;
1314 linux_pci_device_t *p = linux_pci_get_device (h);
1315 linux_pci_irq_t *irq;
1316 linux_pci_region_t *res;
1317 clib_error_t *err = 0;
1319 if (p->type == LINUX_PCI_DEVICE_TYPE_UIO)
1322 if (irq->clib_file_index != -1)
1323 clib_file_del_by_index (&file_main, irq->clib_file_index);
1324 close (p->config_fd);
1328 else if (p->type == LINUX_PCI_DEVICE_TYPE_VFIO)
1331 /* close INTx irqs */
1334 err = vfio_set_irqs (vm, p, VFIO_PCI_INTX_IRQ_INDEX, 0, 0,
1335 VFIO_IRQ_SET_ACTION_TRIGGER, 0);
1336 clib_error_free (err);
1337 if (irq->clib_file_index != -1)
1338 clib_file_del_by_index (&file_main, irq->clib_file_index);
1342 /* close MSI-X irqs */
1343 if (vec_len (p->msix_irqs))
1345 err = vfio_set_irqs (vm, p, VFIO_PCI_MSIX_IRQ_INDEX, 0, 0,
1346 VFIO_IRQ_SET_ACTION_TRIGGER, 0);
1347 clib_error_free (err);
1349 vec_foreach (irq, p->msix_irqs)
1353 clib_file_del_by_index (&file_main, irq->clib_file_index);
1357 vec_free (p->msix_irqs);
1362 vec_foreach (res, p->regions)
1366 clib_mem_vm_unmap (res->addr);
1371 vec_free (p->regions);
1374 clib_memset (p, 0, sizeof (linux_pci_device_t));
1375 pool_put (lpm->linux_pci_devices, p);
1379 init_device_from_registered (vlib_main_t * vm, vlib_pci_device_info_t * di)
1381 vlib_pci_main_t *pm = &pci_main;
1382 linux_pci_main_t *lpm = &linux_pci_main;
1383 pci_device_registration_t *r;
1385 clib_error_t *err = 0;
1386 linux_pci_device_t *p;
1388 pool_get (lpm->linux_pci_devices, p);
1389 p->handle = p - lpm->linux_pci_devices;
1390 p->intx_irq.fd = -1;
1392 r = pm->pci_device_registrations;
1396 for (i = r->supported_devices; i->vendor_id != 0; i++)
1397 if (i->vendor_id == di->vendor_id && i->device_id == di->device_id)
1399 if (di->iommu_group != -1)
1400 err = add_device_vfio (vm, p, di, r);
1402 err = add_device_uio (vm, p, di, r);
1405 clib_error_report (err);
1409 r = r->next_registration;
1412 /* No driver, close the PCI config-space FD */
1413 clib_memset (p, 0, sizeof (linux_pci_device_t));
1414 pool_put (lpm->linux_pci_devices, p);
1417 static clib_error_t *
1418 scan_pci_addr (void *arg, u8 * dev_dir_name, u8 * ignored)
1420 vlib_pci_addr_t addr, **addrv = arg;
1421 unformat_input_t input;
1422 clib_error_t *err = 0;
1424 unformat_init_string (&input, (char *) dev_dir_name,
1425 vec_len (dev_dir_name));
1427 if (!unformat (&input, "/sys/bus/pci/devices/%U",
1428 unformat_vlib_pci_addr, &addr))
1429 err = clib_error_return (0, "unformat error `%v`", dev_dir_name);
1431 unformat_free (&input);
1436 vec_add1 (*addrv, addr);
1441 pci_addr_cmp (void *v1, void *v2)
1443 vlib_pci_addr_t *a1 = v1;
1444 vlib_pci_addr_t *a2 = v2;
1446 if (a1->domain > a2->domain)
1448 if (a1->domain < a2->domain)
1450 if (a1->bus > a2->bus)
1452 if (a1->bus < a2->bus)
1454 if (a1->slot > a2->slot)
1456 if (a1->slot < a2->slot)
1458 if (a1->function > a2->function)
1460 if (a1->function < a2->function)
1466 vlib_pci_get_all_dev_addrs ()
1468 vlib_pci_addr_t *addrs = 0;
1470 err = foreach_directory_file ((char *) sysfs_pci_dev_path, scan_pci_addr,
1471 &addrs, /* scan_dirs */ 0);
1478 vec_sort_with_function (addrs, pci_addr_cmp);
1484 linux_pci_init (vlib_main_t * vm)
1486 vlib_pci_main_t *pm = &pci_main;
1487 vlib_pci_addr_t *addr = 0, *addrs;
1491 ASSERT (sizeof (vlib_pci_addr_t) == sizeof (u32));
1493 addrs = vlib_pci_get_all_dev_addrs ();
1495 vec_foreach (addr, addrs)
1497 vlib_pci_device_info_t *d;
1498 if ((d = vlib_pci_get_device_info (vm, addr, 0)))
1500 init_device_from_registered (vm, d);
1501 vlib_pci_free_device_info (d);
1510 VLIB_INIT_FUNCTION (linux_pci_init) =
1512 .runs_after = VLIB_INITS("unix_input_init"),
1517 * fd.io coding-style-patch-verification: ON
1520 * eval: (c-set-style "gnu")