2 * Copyright (c) 2016 Cisco and/or its affiliates.
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at:
7 * http://www.apache.org/licenses/LICENSE-2.0
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
16 * pci.c: Linux user space PCI bus management.
18 * Copyright (c) 2008 Eliot Dresselhaus
20 * Permission is hereby granted, free of charge, to any person obtaining
21 * a copy of this software and associated documentation files (the
22 * "Software"), to deal in the Software without restriction, including
23 * without limitation the rights to use, copy, modify, merge, publish,
24 * distribute, sublicense, and/or sell copies of the Software, and to
25 * permit persons to whom the Software is furnished to do so, subject to
26 * the following conditions:
28 * The above copyright notice and this permission notice shall be
29 * included in all copies or substantial portions of the Software.
31 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
32 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
33 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
34 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
35 * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
36 * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
37 * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
40 #include <vppinfra/linux/sysfs.h>
42 #include <vlib/vlib.h>
43 #include <vlib/pci/pci.h>
44 #include <vlib/unix/unix.h>
45 #include <vlib/linux/vfio.h>
47 #include <sys/types.h>
51 #include <sys/ioctl.h>
53 #include <linux/ethtool.h>
54 #include <linux/sockios.h>
55 #include <linux/vfio.h>
56 #include <sys/eventfd.h>
58 #define SYSFS_DEVICES_PCI "/sys/devices/pci"
59 static const char *sysfs_pci_dev_path = "/sys/bus/pci/devices";
60 static const char *sysfs_pci_drv_path = "/sys/bus/pci/drivers";
61 static char *sysfs_mod_vfio_noiommu =
62 "/sys/module/vfio/parameters/enable_unsafe_noiommu_mode";
64 VLIB_REGISTER_LOG_CLASS (pci_log, static) = {
66 .subclass_name = "linux",
69 #define log_debug(p, f, ...) \
70 vlib_log (VLIB_LOG_LEVEL_DEBUG, pci_log.class, "%U: " f, \
71 format_vlib_pci_log, p->handle, ##__VA_ARGS__)
72 #define log_err(p, f, ...) \
73 vlib_log (VLIB_LOG_LEVEL_ERR, pci_log.class, "%U: " f, format_vlib_pci_log, \
74 p->handle, ##__VA_ARGS__)
89 pci_intx_handler_function_t *intx_handler;
90 pci_msix_handler_function_t *msix_handler;
96 LINUX_PCI_DEVICE_TYPE_UNKNOWN,
97 LINUX_PCI_DEVICE_TYPE_UIO,
98 LINUX_PCI_DEVICE_TYPE_VFIO,
99 } linux_pci_device_type_t;
103 linux_pci_device_type_t type;
104 vlib_pci_dev_handle_t handle;
105 vlib_pci_addr_t addr;
108 /* Resource file descriptors. */
109 linux_pci_region_t *regions;
111 /* File descriptor for config space read/write. */
115 /* Device File descriptor */
118 /* read/write file descriptor for io bar */
122 /* Minor device for uio device. */
125 /* Interrupt handlers */
126 linux_pci_irq_t intx_irq;
127 linux_pci_irq_t *msix_irqs;
134 } linux_pci_device_t;
136 /* Pool of PCI devices. */
139 vlib_main_t *vlib_main;
140 linux_pci_device_t *linux_pci_devices;
144 extern linux_pci_main_t linux_pci_main;
146 static linux_pci_device_t *
147 linux_pci_get_device (vlib_pci_dev_handle_t h)
149 linux_pci_main_t *lpm = &linux_pci_main;
150 return pool_elt_at_index (lpm->linux_pci_devices, h);
154 vlib_pci_get_private_data (vlib_main_t * vm, vlib_pci_dev_handle_t h)
156 linux_pci_device_t *d = linux_pci_get_device (h);
157 return d->private_data;
161 vlib_pci_set_private_data (vlib_main_t * vm, vlib_pci_dev_handle_t h,
164 linux_pci_device_t *d = linux_pci_get_device (h);
165 d->private_data = private_data;
169 vlib_pci_get_addr (vlib_main_t * vm, vlib_pci_dev_handle_t h)
171 linux_pci_device_t *d = linux_pci_get_device (h);
176 vlib_pci_get_numa_node (vlib_main_t * vm, vlib_pci_dev_handle_t h)
178 linux_pci_device_t *d = linux_pci_get_device (h);
183 vlib_pci_get_num_msix_interrupts (vlib_main_t * vm, vlib_pci_dev_handle_t h)
185 linux_pci_device_t *d = linux_pci_get_device (h);
187 if (d->type == LINUX_PCI_DEVICE_TYPE_VFIO)
189 struct vfio_irq_info ii = { 0 };
191 ii.argsz = sizeof (struct vfio_irq_info);
192 ii.index = VFIO_PCI_MSIX_IRQ_INDEX;
193 if (ioctl (d->fd, VFIO_DEVICE_GET_IRQ_INFO, &ii) < 0)
200 /* Call to allocate/initialize the pci subsystem.
201 This is not an init function so that users can explicitly enable
202 pci only when it's needed. */
203 clib_error_t *pci_bus_init (vlib_main_t * vm);
205 linux_pci_main_t linux_pci_main;
207 vlib_pci_device_info_t *
208 vlib_pci_get_device_info (vlib_main_t * vm, vlib_pci_addr_t * addr,
209 clib_error_t ** error)
212 vlib_pci_device_info_t *di;
217 clib_bitmap_t *bmp = 0;
219 di = clib_mem_alloc (sizeof (vlib_pci_device_info_t));
220 clib_memset (di, 0, sizeof (vlib_pci_device_info_t));
221 di->addr.as_u32 = addr->as_u32;
223 u8 *dev_dir_name = format (0, "%s/%U", sysfs_pci_dev_path,
224 format_vlib_pci_addr, addr);
226 f = format (0, "%v/config%c", dev_dir_name, 0);
227 fd = open ((char *) f, O_RDWR);
229 /* Try read-only access if write fails. */
231 fd = open ((char *) f, O_RDONLY);
235 err = clib_error_return_unix (0, "open `%s'", f);
239 /* You can only read more that 64 bytes of config space as root; so we try to
240 read the full space but fall back to just the first 64 bytes. */
241 if (read (fd, &di->config, sizeof (di->config)) <
242 sizeof (vlib_pci_config_hdr_t))
244 err = clib_error_return_unix (0, "read `%s'", f);
250 vec_reset_length (f);
251 f = format (f, "%v/numa_node%c", dev_dir_name, 0);
252 err = clib_sysfs_read ((char *) f, "%d", &di->numa_node);
256 clib_error_free (err);
258 if (di->numa_node == -1)
260 /* if '/sys/bus/pci/devices/<device id>/numa_node' returns -1 and
261 it is a SMP system, set numa_node to 0. */
262 if ((err = clib_sysfs_read ("/sys/devices/system/node/online", "%U",
263 unformat_bitmap_list, &bmp)))
264 clib_error_free (err);
265 if (clib_bitmap_count_set_bits (bmp) == 1)
269 vec_reset_length (f);
270 f = format (f, "%v/class%c", dev_dir_name, 0);
271 err = clib_sysfs_read ((char *) f, "0x%x", &tmp);
274 di->device_class = tmp >> 8;
276 vec_reset_length (f);
277 f = format (f, "%v/vendor%c", dev_dir_name, 0);
278 err = clib_sysfs_read ((char *) f, "0x%x", &tmp);
283 vec_reset_length (f);
284 f = format (f, "%v/device%c", dev_dir_name, 0);
285 err = clib_sysfs_read ((char *) f, "0x%x", &tmp);
290 vec_reset_length (f);
291 f = format (f, "%v/revision%c", dev_dir_name, 0);
292 err = clib_sysfs_read ((char *) f, "0x%x", &tmp);
298 clib_file_get_resolved_basename ("%v/driver", dev_dir_name);
299 if (!di->driver_name)
300 di->driver_name = format (0, "<NONE>%c", 0);
302 di->iommu_group = -1;
303 tmpstr = clib_file_get_resolved_basename ("%v/iommu_group", dev_dir_name);
306 di->iommu_group = atoi ((char *) tmpstr);
310 vec_reset_length (f);
311 f = format (f, "%v/iommu_group/name%c", dev_dir_name, 0);
312 err = clib_sysfs_read ((char *) f, "%s", &tmpstr);
315 if (strncmp ((char *) tmpstr, "vfio-noiommu", 12) == 0)
316 di->flags |= VLIB_PCI_DEVICE_INFO_F_NOIOMMU;
320 clib_error_free (err);
324 vec_reset_length (f);
325 f = format (f, "%v/vpd%c", dev_dir_name, 0);
326 fd = open ((char *) f, O_RDONLY);
335 if (read (fd, &tag, 3) != 3)
338 if (tag[0] != 0x82 && tag[0] != 0x90 && tag[0] != 0x91)
341 len = (tag[2] << 8) | tag[1];
342 vec_validate (data, len - 1);
344 if (read (fd, data, len) != len)
350 di->product_name = data;
351 else if (tag[0] == 0x90)
353 else if (tag[0] == 0x91)
364 vlib_pci_free_device_info (di);
370 vec_free (dev_dir_name);
374 clib_error_free (err);
378 clib_error_t *__attribute__ ((weak))
379 vlib_pci_get_device_root_bus (vlib_pci_addr_t *addr, vlib_pci_addr_t *root_bus)
381 u8 *rel_path = 0, *abs_path = 0, *link_path = 0;
382 unformat_input_t input;
383 int fd = open (sysfs_pci_dev_path, O_RDONLY);
386 clib_error_t *err = NULL;
389 return clib_error_return_unix (0, "failed to open %s", sysfs_pci_dev_path);
391 vec_alloc (rel_path, PATH_MAX);
392 vec_alloc (abs_path, PATH_MAX);
395 format (0, "%s/%U", sysfs_pci_dev_path, format_vlib_pci_addr, addr);
396 size = readlinkat (fd, (char *) link_path, (char *) rel_path, PATH_MAX);
399 err = clib_error_return_unix (0, "failed to read %s", rel_path);
403 rel_path[size] = '\0';
404 vec_free (link_path);
406 link_path = format (0, "%s/%s", sysfs_pci_dev_path, rel_path);
407 if (!realpath ((char *) link_path, (char *) abs_path))
409 err = clib_error_return_unix (0, "failed to resolve %s", link_path);
413 unformat_init_string (&input, (char *) abs_path,
414 clib_strnlen ((char *) abs_path, PATH_MAX));
416 if (!unformat (&input, SYSFS_DEVICES_PCI "%x:%x/%s", &domain, &bus,
419 err = clib_error_return (0, "unknown input '%U'", format_unformat_error,
424 root_bus->domain = domain;
429 vec_free (link_path);
437 directory_exists (char *path)
439 struct stat s = { 0 };
440 if (stat (path, &s) == -1)
443 return S_ISDIR (s.st_mode);
447 vlib_pci_bind_to_uio (vlib_main_t *vm, vlib_pci_addr_t *addr,
448 char *uio_drv_name, int force)
450 clib_error_t *error = 0;
451 u8 *s = 0, *driver_name = 0;
454 vlib_pci_device_info_t *di;
455 int fd, clear_driver_override = 0;
456 u8 *dev_dir_name = format (0, "%s/%U", sysfs_pci_dev_path,
457 format_vlib_pci_addr, addr);
459 di = vlib_pci_get_device_info (vm, addr, &error);
464 if (strncmp ("auto", uio_drv_name, 5) == 0)
466 int vfio_pci_loaded = 0;
468 if (directory_exists ("/sys/module/vfio_pci"))
471 if (di->iommu_group != -1)
473 /* device is bound to IOMMU group */
474 if (!vfio_pci_loaded)
476 error = clib_error_return (0, "Skipping PCI device %U: device "
477 "is bound to IOMMU group and "
478 "vfio-pci driver is not loaded",
479 format_vlib_pci_addr, addr);
483 uio_drv_name = "vfio-pci";
487 /* device is not bound to IOMMU group so we have multiple options */
488 if (vfio_pci_loaded &&
489 (error = clib_sysfs_write (sysfs_mod_vfio_noiommu, "Y")) == 0)
490 uio_drv_name = "vfio-pci";
491 else if (directory_exists ("/sys/module/uio_pci_generic"))
492 uio_drv_name = "uio_pci_generic";
493 else if (directory_exists ("/sys/module/igb_uio"))
494 uio_drv_name = "igb_uio";
497 clib_error_free (error);
498 error = clib_error_return (0, "Skipping PCI device %U: missing "
499 "kernel VFIO or UIO driver",
500 format_vlib_pci_addr, addr);
503 clib_error_free (error);
507 driver_name = clib_file_get_resolved_basename ("%v/driver", dev_dir_name);
510 ((strcmp ("vfio-pci", (char *) driver_name) == 0) ||
511 (strcmp ("uio_pci_generic", (char *) driver_name) == 0) ||
512 (strcmp ("igb_uio", (char *) driver_name) == 0)))
517 /* walk trough all linux interfaces and if interface belonging to
518 this device is found check if interface is admin up */
519 dir = opendir ("/sys/class/net");
520 s = format (s, "%U%c", format_vlib_pci_addr, addr, 0);
524 error = clib_error_return (0,
525 "Skipping PCI device %U: failed to "
526 "read /sys/class/net",
527 format_vlib_pci_addr, addr);
531 fd = socket (PF_INET, SOCK_DGRAM, 0);
534 error = clib_error_return_unix (0, "socket");
538 while ((e = readdir (dir)))
541 struct ethtool_drvinfo drvinfo;
543 if (e->d_name[0] == '.') /* skip . and .. */
546 clib_memset (&ifr, 0, sizeof ifr);
547 clib_memset (&drvinfo, 0, sizeof drvinfo);
548 ifr.ifr_data = (char *) &drvinfo;
549 clib_strncpy (ifr.ifr_name, e->d_name, sizeof (ifr.ifr_name) - 1);
551 drvinfo.cmd = ETHTOOL_GDRVINFO;
552 if (ioctl (fd, SIOCETHTOOL, &ifr) < 0)
554 /* Some interfaces (eg "lo") don't support this ioctl */
555 if ((errno != ENOTSUP) && (errno != ENODEV))
556 clib_unix_warning ("ioctl fetch intf %s bus info error",
561 if (strcmp ((char *) s, drvinfo.bus_info))
564 clib_memset (&ifr, 0, sizeof (ifr));
565 clib_strncpy (ifr.ifr_name, e->d_name, sizeof (ifr.ifr_name) - 1);
567 if (ioctl (fd, SIOCGIFFLAGS, &ifr) < 0)
569 error = clib_error_return_unix (0, "ioctl fetch intf %s flags",
575 if (ifr.ifr_flags & IFF_UP)
577 vlib_log (VLIB_LOG_LEVEL_WARNING, pci_main.log_default,
578 "Skipping PCI device %U as host "
579 "interface %s is up",
580 format_vlib_pci_addr, addr, e->d_name);
587 vec_reset_length (s);
590 s = format (s, "%v/driver/unbind%c", dev_dir_name, 0);
591 clib_sysfs_write ((char *) s, "%U", format_vlib_pci_addr, addr);
592 vec_reset_length (s);
594 s = format (s, "%v/driver_override%c", dev_dir_name, 0);
595 if (access ((char *) s, F_OK) == 0)
597 clib_sysfs_write ((char *) s, "%s", uio_drv_name);
598 clear_driver_override = 1;
602 vec_reset_length (s);
603 s = format (s, "%s/%s/new_id%c", sysfs_pci_drv_path, uio_drv_name, 0);
604 clib_sysfs_write ((char *) s, "0x%04x 0x%04x", di->vendor_id,
607 vec_reset_length (s);
609 s = format (s, "%s/%s/bind%c", sysfs_pci_drv_path, uio_drv_name, 0);
610 clib_sysfs_write ((char *) s, "%U", format_vlib_pci_addr, addr);
611 vec_reset_length (s);
613 if (clear_driver_override)
615 s = format (s, "%v/driver_override%c", dev_dir_name, 0);
616 clib_sysfs_write ((char *) s, "%c", 0);
617 vec_reset_length (s);
624 vec_free (dev_dir_name);
625 vec_free (driver_name);
630 static clib_error_t *
631 scan_uio_dir (void *arg, u8 * path_name, u8 * file_name)
633 linux_pci_device_t *l = arg;
634 unformat_input_t input;
636 unformat_init_string (&input, (char *) file_name, vec_len (file_name));
638 if (!unformat (&input, "uio%d", &l->uio_minor))
641 unformat_free (&input);
645 static clib_error_t *
646 vfio_set_irqs (vlib_main_t * vm, linux_pci_device_t * p, u32 index, u32 start,
647 u32 count, u32 flags, int *efds)
649 int data_len = efds ? count * sizeof (int) : 0;
650 u8 buf[sizeof (struct vfio_irq_set) + data_len];
651 struct vfio_irq_info ii = { 0 };
652 struct vfio_irq_set *irq_set = (struct vfio_irq_set *) buf;
655 ii.argsz = sizeof (struct vfio_irq_info);
658 if (ioctl (p->fd, VFIO_DEVICE_GET_IRQ_INFO, &ii) < 0)
659 return clib_error_return_unix (0, "ioctl(VFIO_DEVICE_GET_IRQ_INFO) "
660 "'%U'", format_vlib_pci_addr, &p->addr);
662 log_debug (p, "%s index:%u count:%u flags: %s%s%s%s(0x%x)", __func__,
664 ii.flags & VFIO_IRQ_INFO_EVENTFD ? "eventfd " : "",
665 ii.flags & VFIO_IRQ_INFO_MASKABLE ? "maskable " : "",
666 ii.flags & VFIO_IRQ_INFO_AUTOMASKED ? "automasked " : "",
667 ii.flags & VFIO_IRQ_INFO_NORESIZE ? "noresize " : "", ii.flags);
669 if (ii.count < start + count)
670 return clib_error_return_unix (0, "vfio_set_irq: unexistng interrupt on "
671 "'%U'", format_vlib_pci_addr, &p->addr);
676 flags |= VFIO_IRQ_SET_DATA_EVENTFD;
677 clib_memcpy_fast (&irq_set->data, efds, data_len);
680 flags |= VFIO_IRQ_SET_DATA_NONE;
682 ASSERT ((flags & (VFIO_IRQ_SET_DATA_NONE | VFIO_IRQ_SET_DATA_EVENTFD)) !=
683 (VFIO_IRQ_SET_DATA_NONE | VFIO_IRQ_SET_DATA_EVENTFD));
685 irq_set->argsz = sizeof (struct vfio_irq_set) + data_len;
686 irq_set->index = index;
687 irq_set->start = start;
688 irq_set->count = count;
689 irq_set->flags = flags;
691 if (ioctl (p->fd, VFIO_DEVICE_SET_IRQS, irq_set) < 0)
692 return clib_error_return_unix (0, "%U:ioctl(VFIO_DEVICE_SET_IRQS) "
693 "[index = %u, start = %u, count = %u, "
695 format_vlib_pci_addr, &p->addr,
696 index, start, count, flags);
700 static clib_error_t *
701 linux_pci_uio_read_ready (clib_file_t * uf)
703 vlib_main_t *vm = vlib_get_main ();
704 int __attribute__ ((unused)) rv;
705 vlib_pci_dev_handle_t h = uf->private_data;
706 linux_pci_device_t *p = linux_pci_get_device (h);
707 linux_pci_irq_t *irq = &p->intx_irq;
710 rv = read (uf->file_descriptor, &icount, 4);
712 if (irq->intx_handler)
713 irq->intx_handler (vm, h);
715 vlib_pci_intr_enable (vm, h);
717 return /* no error */ 0;
720 static clib_error_t *
721 linux_pci_vfio_unmask_intx (vlib_main_t * vm, linux_pci_device_t * d)
723 return vfio_set_irqs (vm, d, VFIO_PCI_INTX_IRQ_INDEX, 0, 1,
724 VFIO_IRQ_SET_ACTION_UNMASK, 0);
727 static clib_error_t *
728 linux_pci_uio_error_ready (clib_file_t * uf)
730 u32 error_index = (u32) uf->private_data;
732 return clib_error_return (0, "pci device %d: error", error_index);
735 static clib_error_t *
736 linux_pci_vfio_msix_read_ready (clib_file_t * uf)
738 vlib_main_t *vm = vlib_get_main ();
739 int __attribute__ ((unused)) rv;
740 vlib_pci_dev_handle_t h = uf->private_data >> 16;
741 u16 line = uf->private_data & 0xffff;
742 linux_pci_device_t *p = linux_pci_get_device (h);
743 linux_pci_irq_t *irq = vec_elt_at_index (p->msix_irqs, line);
746 rv = read (uf->file_descriptor, &icount, sizeof (icount));
748 if (irq->msix_handler)
749 irq->msix_handler (vm, h, line);
751 return /* no error */ 0;
754 static clib_error_t *
755 linux_pci_vfio_intx_read_ready (clib_file_t * uf)
757 vlib_main_t *vm = vlib_get_main ();
758 int __attribute__ ((unused)) rv;
759 vlib_pci_dev_handle_t h = uf->private_data;
760 linux_pci_device_t *p = linux_pci_get_device (h);
761 linux_pci_irq_t *irq = &p->intx_irq;
764 rv = read (uf->file_descriptor, &icount, sizeof (icount));
766 if (irq->intx_handler)
767 irq->intx_handler (vm, h);
769 linux_pci_vfio_unmask_intx (vm, p);
771 return /* no error */ 0;
774 static clib_error_t *
775 linux_pci_vfio_error_ready (clib_file_t * uf)
777 u32 error_index = (u32) uf->private_data;
779 return clib_error_return (0, "pci device %d: error", error_index);
782 static clib_error_t *
783 add_device_uio (vlib_main_t * vm, linux_pci_device_t * p,
784 vlib_pci_device_info_t * di, pci_device_registration_t * r)
786 linux_pci_main_t *lpm = &linux_pci_main;
787 clib_error_t *err = 0;
791 p->type = LINUX_PCI_DEVICE_TYPE_UIO;
793 s = format (s, "%s/%U/config%c", sysfs_pci_dev_path,
794 format_vlib_pci_addr, &di->addr, 0);
796 p->config_fd = open ((char *) s, O_RDWR);
797 p->config_offset = 0;
798 vec_reset_length (s);
800 if (p->config_fd == -1)
802 err = clib_error_return_unix (0, "open '%s'", s);
806 s = format (0, "%s/%U/uio%c", sysfs_pci_dev_path,
807 format_vlib_pci_addr, &di->addr, 0);
808 foreach_directory_file ((char *) s, scan_uio_dir, p, /* scan_dirs */
810 vec_reset_length (s);
812 s = format (s, "/dev/uio%d%c", p->uio_minor, 0);
813 p->fd = open ((char *) s, O_RDWR);
816 err = clib_error_return_unix (0, "open '%s'", s);
820 if (r && r->interrupt_handler)
821 vlib_pci_register_intx_handler (vm, p->handle, r->interrupt_handler);
823 if (r && r->init_function)
824 err = r->init_function (lpm->vlib_main, p->handle);
830 if (p->config_fd != -1)
831 close (p->config_fd);
839 vlib_pci_register_intx_handler (vlib_main_t * vm, vlib_pci_dev_handle_t h,
840 pci_intx_handler_function_t * intx_handler)
842 linux_pci_device_t *p = linux_pci_get_device (h);
843 clib_file_t t = { 0 };
844 linux_pci_irq_t *irq = &p->intx_irq;
845 ASSERT (irq->fd == -1);
847 if (p->type == LINUX_PCI_DEVICE_TYPE_VFIO)
849 struct vfio_irq_info ii = { 0 };
850 ii.argsz = sizeof (struct vfio_irq_info);
851 ii.index = VFIO_PCI_INTX_IRQ_INDEX;
852 if (ioctl (p->fd, VFIO_DEVICE_GET_IRQ_INFO, &ii) < 0)
853 return clib_error_return_unix (0, "ioctl(VFIO_DEVICE_GET_IRQ_INFO) '"
854 "%U'", format_vlib_pci_addr, &p->addr);
856 p, "%s index:%u count:%u flags: %s%s%s%s(0x%x)", __func__, ii.index,
857 ii.count, ii.flags & VFIO_IRQ_INFO_EVENTFD ? "eventfd " : "",
858 ii.flags & VFIO_IRQ_INFO_MASKABLE ? "maskable " : "",
859 ii.flags & VFIO_IRQ_INFO_AUTOMASKED ? "automasked " : "",
860 ii.flags & VFIO_IRQ_INFO_NORESIZE ? "noresize " : "", ii.flags);
862 return clib_error_return (0, "INTx interrupt does not exist on device"
863 "'%U'", format_vlib_pci_addr, &p->addr);
865 irq->fd = eventfd (0, EFD_NONBLOCK);
867 return clib_error_return_unix (0, "eventfd");
869 t.file_descriptor = irq->fd;
870 t.read_function = linux_pci_vfio_intx_read_ready;
872 else if (p->type == LINUX_PCI_DEVICE_TYPE_UIO)
874 t.file_descriptor = p->fd;
875 t.read_function = linux_pci_uio_read_ready;
880 t.error_function = linux_pci_uio_error_ready;
881 t.private_data = p->handle;
882 t.description = format (0, "PCI %U INTx", format_vlib_pci_addr, &p->addr);
883 irq->clib_file_index = clib_file_add (&file_main, &t);
884 irq->intx_handler = intx_handler;
889 vlib_pci_unregister_intx_handler (vlib_main_t *vm, vlib_pci_dev_handle_t h)
891 linux_pci_device_t *p = linux_pci_get_device (h);
892 linux_pci_irq_t *irq = &p->intx_irq;
894 if (irq->intx_handler == 0)
897 clib_file_del_by_index (&file_main, irq->clib_file_index);
898 if (p->type == LINUX_PCI_DEVICE_TYPE_VFIO)
904 irq->intx_handler = 0;
910 vlib_pci_register_msix_handler (vlib_main_t * vm, vlib_pci_dev_handle_t h,
911 u32 start, u32 count,
912 pci_msix_handler_function_t * msix_handler)
914 clib_error_t *err = 0;
915 linux_pci_device_t *p = linux_pci_get_device (h);
918 if (p->type != LINUX_PCI_DEVICE_TYPE_VFIO)
919 return clib_error_return (0, "vfio driver is needed for MSI-X interrupt "
923 vec_validate_init_empty (p->msix_irqs, start + count - 1, (linux_pci_irq_t)
927 for (i = start; i < start + count; i++)
929 clib_file_t t = { 0 };
930 linux_pci_irq_t *irq = vec_elt_at_index (p->msix_irqs, i);
931 ASSERT (irq->fd == -1);
933 irq->fd = eventfd (0, EFD_NONBLOCK);
936 err = clib_error_return_unix (0, "eventfd");
940 t.read_function = linux_pci_vfio_msix_read_ready;
941 t.file_descriptor = irq->fd;
942 t.error_function = linux_pci_vfio_error_ready;
943 t.private_data = p->handle << 16 | i;
944 t.description = format (0, "PCI %U MSI-X #%u", format_vlib_pci_addr,
946 irq->clib_file_index = clib_file_add (&file_main, &t);
947 irq->msix_handler = msix_handler;
955 linux_pci_irq_t *irq = vec_elt_at_index (p->msix_irqs, i);
958 clib_file_del_by_index (&file_main, irq->clib_file_index);
967 vlib_pci_unregister_msix_handler (vlib_main_t *vm, vlib_pci_dev_handle_t h,
968 u32 start, u32 count)
970 clib_error_t *err = 0;
971 linux_pci_device_t *p = linux_pci_get_device (h);
974 if (p->type != LINUX_PCI_DEVICE_TYPE_VFIO)
975 return clib_error_return (0, "vfio driver is needed for MSI-X interrupt "
978 for (i = start; i < start + count; i++)
980 linux_pci_irq_t *irq = vec_elt_at_index (p->msix_irqs, i);
984 clib_file_del_by_index (&file_main, irq->clib_file_index);
994 vlib_pci_enable_msix_irq (vlib_main_t * vm, vlib_pci_dev_handle_t h,
995 u16 start, u16 count)
997 linux_pci_device_t *p = linux_pci_get_device (h);
1001 if (p->type != LINUX_PCI_DEVICE_TYPE_VFIO)
1002 return clib_error_return (0, "vfio driver is needed for MSI-X interrupt "
1005 for (i = start; i < start + count; i++)
1007 linux_pci_irq_t *irq = vec_elt_at_index (p->msix_irqs, i);
1011 return vfio_set_irqs (vm, p, VFIO_PCI_MSIX_IRQ_INDEX, start, count,
1012 VFIO_IRQ_SET_ACTION_TRIGGER, fds);
1016 vlib_pci_get_msix_file_index (vlib_main_t * vm, vlib_pci_dev_handle_t h,
1019 linux_pci_device_t *p = linux_pci_get_device (h);
1020 linux_pci_irq_t *irq = vec_elt_at_index (p->msix_irqs, index);
1023 return irq->clib_file_index;
1027 vlib_pci_disable_msix_irq (vlib_main_t * vm, vlib_pci_dev_handle_t h,
1028 u16 start, u16 count)
1030 linux_pci_device_t *p = linux_pci_get_device (h);
1033 if (p->type != LINUX_PCI_DEVICE_TYPE_VFIO)
1034 return clib_error_return (0, "vfio driver is needed for MSI-X interrupt "
1037 for (i = start; i < start + count; i++)
1040 return vfio_set_irqs (vm, p, VFIO_PCI_MSIX_IRQ_INDEX, start, count,
1041 VFIO_IRQ_SET_ACTION_TRIGGER, fds);
1044 static clib_error_t *
1045 add_device_vfio (vlib_main_t * vm, linux_pci_device_t * p,
1046 vlib_pci_device_info_t * di, pci_device_registration_t * r)
1048 linux_pci_main_t *lpm = &linux_pci_main;
1049 struct vfio_device_info device_info = { 0 };
1050 struct vfio_region_info reg = { 0 };
1051 clib_error_t *err = 0;
1055 p->type = LINUX_PCI_DEVICE_TYPE_VFIO;
1057 if ((err = linux_vfio_group_get_device_fd (&p->addr, &p->fd, &is_noiommu)))
1060 if (is_noiommu == 0)
1061 p->supports_va_dma = 1;
1063 device_info.argsz = sizeof (device_info);
1064 if (ioctl (p->fd, VFIO_DEVICE_GET_INFO, &device_info) < 0)
1066 err = clib_error_return_unix (0, "ioctl(VFIO_DEVICE_GET_INFO) '%U'",
1067 format_vlib_pci_addr, &di->addr);
1071 reg.argsz = sizeof (struct vfio_region_info);
1072 reg.index = VFIO_PCI_CONFIG_REGION_INDEX;
1073 if (ioctl (p->fd, VFIO_DEVICE_GET_REGION_INFO, ®) < 0)
1075 err = clib_error_return_unix (0, "ioctl(VFIO_DEVICE_GET_INFO) '%U'",
1076 format_vlib_pci_addr, &di->addr);
1080 log_debug (p, "%s %U", __func__, format_vfio_region_info, ®);
1082 p->config_offset = reg.offset;
1083 p->config_fd = p->fd;
1085 /* reset if device supports it */
1086 if (device_info.flags & VFIO_DEVICE_FLAGS_RESET)
1087 if (ioctl (p->fd, VFIO_DEVICE_RESET) < 0)
1089 err = clib_error_return_unix (0, "ioctl(VFIO_DEVICE_RESET) '%U'",
1090 format_vlib_pci_addr, &di->addr);
1094 if (r && r->interrupt_handler)
1096 vlib_pci_register_intx_handler (vm, p->handle, r->interrupt_handler);
1097 linux_pci_vfio_unmask_intx (vm, p);
1100 if (p->supports_va_dma)
1102 vlib_buffer_pool_t *bp;
1104 vec_foreach (bp, vm->buffer_main->buffer_pools)
1107 vlib_physmem_map_t *pm;
1108 pm = vlib_physmem_get_map (vm, bp->physmem_map_index);
1109 for (i = 0; i < pm->n_pages; i++)
1110 vfio_map_physmem_page (vm, pm->base + (i << pm->log2_page_size));
1115 if (r && r->init_function)
1116 err = r->init_function (lpm->vlib_main, p->handle);
1124 if (p->config_fd != -1 && p->config_fd != p->fd)
1125 close (p->config_fd);
1126 p->config_fd = p->fd = -1;
1131 /* Configuration space read/write. */
1133 vlib_pci_read_write_config (vlib_main_t * vm, vlib_pci_dev_handle_t h,
1134 vlib_read_or_write_t read_or_write,
1135 uword address, void *data, u32 n_bytes)
1137 linux_pci_device_t *p = linux_pci_get_device (h);
1140 if (read_or_write == VLIB_READ)
1141 n = pread (p->config_fd, data, n_bytes, p->config_offset + address);
1143 n = pwrite (p->config_fd, data, n_bytes, p->config_offset + address);
1146 return clib_error_return_unix (0, "%s",
1147 read_or_write == VLIB_READ
1148 ? "read" : "write");
1153 static clib_error_t *
1154 vlib_pci_region (vlib_main_t * vm, vlib_pci_dev_handle_t h, u32 bar, int *fd,
1155 u64 * size, u64 * offset)
1157 linux_pci_device_t *p = linux_pci_get_device (h);
1158 clib_error_t *error = 0;
1160 u64 _size = 0, _offset = 0;
1166 if (p->type == LINUX_PCI_DEVICE_TYPE_UIO)
1169 struct stat stat_buf;
1170 file_name = format (0, "%s/%U/resource%d%c", sysfs_pci_dev_path,
1171 format_vlib_pci_addr, &p->addr, bar, 0);
1173 _fd = open ((char *) file_name, O_RDWR);
1176 error = clib_error_return_unix (0, "open `%s'", file_name);
1177 vec_free (file_name);
1181 if (fstat (_fd, &stat_buf) < 0)
1183 error = clib_error_return_unix (0, "fstat `%s'", file_name);
1184 vec_free (file_name);
1189 vec_free (file_name);
1190 _size = stat_buf.st_size;
1193 else if (p->type == LINUX_PCI_DEVICE_TYPE_VFIO)
1195 struct vfio_region_info *r;
1196 u32 sz = sizeof (struct vfio_region_info);
1198 r = clib_mem_alloc (sz);
1199 clib_memset (r, 0, sz);
1202 if (ioctl (p->fd, VFIO_DEVICE_GET_REGION_INFO, r) < 0)
1203 return clib_error_return_unix (0, "ioctl(VFIO_DEVICE_GET_INFO) "
1204 "'%U'", format_vlib_pci_addr,
1214 _offset = r->offset;
1215 log_debug (p, "%s %U", __func__, format_vfio_region_info, r);
1228 static clib_error_t *
1229 vlib_pci_map_region_int (vlib_main_t * vm, vlib_pci_dev_handle_t h,
1230 u32 bar, u8 * addr, void **result)
1232 linux_pci_device_t *p = linux_pci_get_device (h);
1234 clib_error_t *error;
1235 u64 size = 0, offset = 0;
1236 vlib_pci_config_reg_command_t command;
1238 log_debug (p, "map region %u to va %p", bar, addr);
1240 if ((error = vlib_pci_read_config_u16 (vm, h, 4, &command.as_u16)))
1243 if (!(command.mem_space))
1245 log_debug (p, "setting memory enable bit");
1246 command.mem_space = 1;
1247 if ((error = vlib_pci_write_config_u16 (vm, h, 4, &command.as_u16)))
1251 if ((error = vlib_pci_region (vm, h, bar, &fd, &size, &offset)))
1254 *result = clib_mem_vm_map_shared (addr, size, fd, offset,
1255 "PCIe %U region %u", format_vlib_pci_addr,
1256 vlib_pci_get_addr (vm, h), bar);
1257 if (*result == CLIB_MEM_VM_MAP_FAILED)
1259 error = clib_error_return_unix (0, "mmap `BAR%u'", bar);
1260 if (p->type == LINUX_PCI_DEVICE_TYPE_UIO && (fd != -1))
1266 vec_validate_init_empty (p->regions, bar,
1267 (linux_pci_region_t) { .fd = -1});
1269 if (p->type == LINUX_PCI_DEVICE_TYPE_UIO)
1270 p->regions[bar].fd = fd;
1271 p->regions[bar].addr = *result;
1272 p->regions[bar].size = size;
1277 vlib_pci_map_region (vlib_main_t * vm, vlib_pci_dev_handle_t h, u32 resource,
1280 return (vlib_pci_map_region_int (vm, h, resource, 0 /* addr */ , result));
1284 vlib_pci_map_region_fixed (vlib_main_t * vm, vlib_pci_dev_handle_t h,
1285 u32 resource, u8 * addr, void **result)
1287 return (vlib_pci_map_region_int (vm, h, resource, addr, result));
1291 vlib_pci_io_region (vlib_main_t * vm, vlib_pci_dev_handle_t h, u32 resource)
1293 linux_pci_device_t *p = linux_pci_get_device (h);
1294 clib_error_t *error = 0;
1296 u64 size = 0, offset = 0;
1298 if ((error = vlib_pci_region (vm, h, resource, &fd, &size, &offset)))
1302 p->io_offset = offset;
1307 vlib_pci_read_write_io (vlib_main_t * vm, vlib_pci_dev_handle_t h,
1308 vlib_read_or_write_t read_or_write,
1309 uword offset, void *data, u32 length)
1311 linux_pci_device_t *p = linux_pci_get_device (h);
1314 if (read_or_write == VLIB_READ)
1315 n = pread (p->io_fd, data, length, p->io_offset + offset);
1317 n = pwrite (p->io_fd, data, length, p->io_offset + offset);
1320 return clib_error_return_unix (0, "%s",
1321 read_or_write == VLIB_READ
1322 ? "read" : "write");
1327 vlib_pci_map_dma (vlib_main_t * vm, vlib_pci_dev_handle_t h, void *ptr)
1329 linux_pci_device_t *p = linux_pci_get_device (h);
1331 if (!p->supports_va_dma)
1334 return vfio_map_physmem_page (vm, ptr);
1338 vlib_pci_supports_virtual_addr_dma (vlib_main_t * vm, vlib_pci_dev_handle_t h)
1340 linux_pci_device_t *p = linux_pci_get_device (h);
1342 return p->supports_va_dma != 0;
1346 vlib_pci_device_open (vlib_main_t * vm, vlib_pci_addr_t * addr,
1347 pci_device_id_t ids[], vlib_pci_dev_handle_t * handle)
1349 linux_pci_main_t *lpm = &linux_pci_main;
1350 vlib_pci_device_info_t *di;
1351 linux_pci_device_t *p;
1352 clib_error_t *err = 0;
1355 di = vlib_pci_get_device_info (vm, addr, &err);
1362 for (i = ids; i->vendor_id != 0; i++)
1363 if (i->vendor_id == di->vendor_id && i->device_id == di->device_id)
1366 if (i->vendor_id == 0)
1368 vlib_pci_free_device_info (di);
1369 return clib_error_return (0, "Wrong vendor or device id");
1373 pool_get (lpm->linux_pci_devices, p);
1374 p->handle = p - lpm->linux_pci_devices;
1375 p->addr.as_u32 = di->addr.as_u32;
1376 p->intx_irq.fd = -1;
1377 p->intx_irq.clib_file_index = -1;
1378 p->numa_node = di->numa_node;
1380 * pci io bar read/write fd
1384 log_debug (p, "open vid:0x%04x did:0x%04x driver:%s iommu_group:%d",
1385 di->vendor_id, di->device_id, di->driver_name, di->iommu_group);
1387 if (clib_strncmp ("vfio-pci", (char *) di->driver_name, 8) == 0)
1388 err = add_device_vfio (vm, p, di, 0);
1389 else if (clib_strncmp ("uio_pci_generic", (char *) di->driver_name, 8) == 0)
1390 err = add_device_uio (vm, p, di, 0);
1392 err = clib_error_create ("device not bound to 'vfio-pci' or "
1393 "'uio_pci_generic' kernel module");
1397 *handle = p->handle;
1400 vlib_pci_free_device_info (di);
1403 log_err (p, "%U", format_clib_error, err);
1404 clib_memset (p, 0, sizeof (linux_pci_device_t));
1405 pool_put (lpm->linux_pci_devices, p);
1412 vlib_pci_device_close (vlib_main_t * vm, vlib_pci_dev_handle_t h)
1414 linux_pci_main_t *lpm = &linux_pci_main;
1415 linux_pci_device_t *p = linux_pci_get_device (h);
1416 linux_pci_irq_t *irq;
1417 linux_pci_region_t *res;
1418 clib_error_t *err = 0;
1420 if (p->type == LINUX_PCI_DEVICE_TYPE_UIO)
1423 if (irq->clib_file_index != -1)
1424 clib_file_del_by_index (&file_main, irq->clib_file_index);
1425 close (p->config_fd);
1429 else if (p->type == LINUX_PCI_DEVICE_TYPE_VFIO)
1432 /* close INTx irqs */
1435 err = vfio_set_irqs (vm, p, VFIO_PCI_INTX_IRQ_INDEX, 0, 0,
1436 VFIO_IRQ_SET_ACTION_TRIGGER, 0);
1437 clib_error_free (err);
1438 if (irq->clib_file_index != -1)
1439 clib_file_del_by_index (&file_main, irq->clib_file_index);
1443 /* close MSI-X irqs */
1444 if (vec_len (p->msix_irqs))
1446 err = vfio_set_irqs (vm, p, VFIO_PCI_MSIX_IRQ_INDEX, 0, 0,
1447 VFIO_IRQ_SET_ACTION_TRIGGER, 0);
1448 clib_error_free (err);
1450 vec_foreach (irq, p->msix_irqs)
1454 clib_file_del_by_index (&file_main, irq->clib_file_index);
1458 vec_free (p->msix_irqs);
1463 vec_foreach (res, p->regions)
1467 clib_mem_vm_unmap (res->addr);
1472 vec_free (p->regions);
1475 clib_memset (p, 0, sizeof (linux_pci_device_t));
1476 pool_put (lpm->linux_pci_devices, p);
1480 init_device_from_registered (vlib_main_t * vm, vlib_pci_device_info_t * di)
1482 vlib_pci_main_t *pm = &pci_main;
1483 linux_pci_main_t *lpm = &linux_pci_main;
1484 pci_device_registration_t *r;
1486 clib_error_t *err = 0;
1487 linux_pci_device_t *p;
1489 pool_get (lpm->linux_pci_devices, p);
1490 p->handle = p - lpm->linux_pci_devices;
1491 p->intx_irq.fd = -1;
1493 r = pm->pci_device_registrations;
1497 for (i = r->supported_devices; i->vendor_id != 0; i++)
1498 if (i->vendor_id == di->vendor_id && i->device_id == di->device_id)
1500 if (di->iommu_group != -1)
1501 err = add_device_vfio (vm, p, di, r);
1503 err = add_device_uio (vm, p, di, r);
1506 clib_error_report (err);
1510 r = r->next_registration;
1513 /* No driver, close the PCI config-space FD */
1514 clib_memset (p, 0, sizeof (linux_pci_device_t));
1515 pool_put (lpm->linux_pci_devices, p);
1518 static clib_error_t *
1519 scan_pci_addr (void *arg, u8 * dev_dir_name, u8 * ignored)
1521 vlib_pci_addr_t addr, **addrv = arg;
1522 unformat_input_t input;
1523 clib_error_t *err = 0;
1525 unformat_init_string (&input, (char *) dev_dir_name,
1526 vec_len (dev_dir_name));
1528 if (!unformat (&input, "/sys/bus/pci/devices/%U",
1529 unformat_vlib_pci_addr, &addr))
1530 err = clib_error_return (0, "unformat error `%v`", dev_dir_name);
1532 unformat_free (&input);
1537 vec_add1 (*addrv, addr);
1542 pci_addr_cmp (void *v1, void *v2)
1544 vlib_pci_addr_t *a1 = v1;
1545 vlib_pci_addr_t *a2 = v2;
1547 if (a1->domain > a2->domain)
1549 if (a1->domain < a2->domain)
1551 if (a1->bus > a2->bus)
1553 if (a1->bus < a2->bus)
1555 if (a1->slot > a2->slot)
1557 if (a1->slot < a2->slot)
1559 if (a1->function > a2->function)
1561 if (a1->function < a2->function)
1567 vlib_pci_get_all_dev_addrs ()
1569 vlib_pci_addr_t *addrs = 0;
1571 err = foreach_directory_file ((char *) sysfs_pci_dev_path, scan_pci_addr,
1572 &addrs, /* scan_dirs */ 0);
1579 vec_sort_with_function (addrs, pci_addr_cmp);
1585 linux_pci_init (vlib_main_t * vm)
1587 vlib_pci_main_t *pm = &pci_main;
1588 vlib_pci_addr_t *addr = 0, *addrs;
1592 ASSERT (sizeof (vlib_pci_addr_t) == sizeof (u32));
1594 addrs = vlib_pci_get_all_dev_addrs ();
1596 vec_foreach (addr, addrs)
1598 vlib_pci_device_info_t *d;
1599 if ((d = vlib_pci_get_device_info (vm, addr, 0)))
1601 init_device_from_registered (vm, d);
1602 vlib_pci_free_device_info (d);
1611 VLIB_INIT_FUNCTION (linux_pci_init) =
1613 .runs_after = VLIB_INITS("unix_input_init"),
1618 * fd.io coding-style-patch-verification: ON
1621 * eval: (c-set-style "gnu")