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)
205 linux_vfio_main_t *lvm = &vfio_main;
207 vlib_pci_device_info_t *di;
212 di = clib_mem_alloc (sizeof (vlib_pci_device_info_t));
213 clib_memset (di, 0, sizeof (vlib_pci_device_info_t));
214 di->addr.as_u32 = addr->as_u32;
216 u8 *dev_dir_name = format (0, "%s/%U", sysfs_pci_dev_path,
217 format_vlib_pci_addr, addr);
219 f = format (0, "%v/config%c", dev_dir_name, 0);
220 fd = open ((char *) f, O_RDWR);
222 /* Try read-only access if write fails. */
224 fd = open ((char *) f, O_RDONLY);
228 err = clib_error_return_unix (0, "open `%s'", f);
232 /* You can only read more that 64 bytes of config space as root; so we try to
233 read the full space but fall back to just the first 64 bytes. */
234 if (read (fd, &di->config_data, sizeof (di->config_data)) <
235 sizeof (di->config0))
237 err = clib_error_return_unix (0, "read `%s'", f);
243 static pci_config_header_t all_ones;
244 if (all_ones.vendor_id == 0)
245 clib_memset (&all_ones, ~0, sizeof (all_ones));
247 if (!memcmp (&di->config0.header, &all_ones, sizeof (all_ones)))
249 err = clib_error_return (0, "invalid PCI config for `%s'", f);
255 if (di->config0.header.header_type == 0)
256 pci_config_type0_little_to_host (&di->config0);
258 pci_config_type1_little_to_host (&di->config1);
261 vec_reset_length (f);
262 f = format (f, "%v/numa_node%c", dev_dir_name, 0);
263 err = clib_sysfs_read ((char *) f, "%u", &di->numa_node);
267 clib_error_free (err);
270 vec_reset_length (f);
271 f = format (f, "%v/class%c", dev_dir_name, 0);
272 err = clib_sysfs_read ((char *) f, "0x%x", &tmp);
275 di->device_class = tmp >> 8;
277 vec_reset_length (f);
278 f = format (f, "%v/vendor%c", dev_dir_name, 0);
279 err = clib_sysfs_read ((char *) f, "0x%x", &tmp);
284 vec_reset_length (f);
285 f = format (f, "%v/device%c", dev_dir_name, 0);
286 err = clib_sysfs_read ((char *) f, "0x%x", &tmp);
291 vec_reset_length (f);
292 f = format (f, "%v/driver%c", dev_dir_name, 0);
293 di->driver_name = clib_sysfs_link_to_name ((char *) f);
294 if (!di->driver_name)
295 di->driver_name = format (0, "<NONE>%c", 0);
297 di->iommu_group = -1;
298 if (lvm->container_fd != -1)
301 vec_reset_length (f);
302 f = format (f, "%v/iommu_group%c", dev_dir_name, 0);
303 tmpstr = clib_sysfs_link_to_name ((char *) f);
306 di->iommu_group = atoi ((char *) tmpstr);
309 vec_reset_length (f);
310 f = format (f, "%v/iommu_group/name%c", dev_dir_name, 0);
311 err = clib_sysfs_read ((char *) f, "%s", &tmpstr);
314 if (strncmp ((char *) tmpstr, "vfio-noiommu", 12) == 0)
315 di->flags |= VLIB_PCI_DEVICE_INFO_F_NOIOMMU;
319 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);
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);
369 vec_free (dev_dir_name);
373 clib_error_free (err);
378 directory_exists (char *path)
380 struct stat s = { 0 };
381 if (stat (path, &s) == -1)
384 return S_ISDIR (s.st_mode);
388 vlib_pci_bind_to_uio (vlib_main_t * vm, vlib_pci_addr_t * addr,
391 clib_error_t *error = 0;
392 u8 *s = 0, *driver_name = 0;
395 vlib_pci_device_info_t *di;
396 int fd, clear_driver_override = 0;
397 u8 *dev_dir_name = format (0, "%s/%U", sysfs_pci_dev_path,
398 format_vlib_pci_addr, addr);
400 di = vlib_pci_get_device_info (vm, addr, &error);
405 if (strncmp ("auto", uio_drv_name, 5) == 0)
407 int vfio_pci_loaded = 0;
409 if (directory_exists ("/sys/module/vfio_pci"))
412 if (di->iommu_group != -1)
414 /* device is bound to IOMMU group */
415 if (!vfio_pci_loaded)
417 error = clib_error_return (0, "Skipping PCI device %U: device "
418 "is bound to IOMMU group and "
419 "vfio-pci driver is not loaded",
420 format_vlib_pci_addr, addr);
424 uio_drv_name = "vfio-pci";
428 /* device is not bound to IOMMU group so we have multiple options */
429 if (vfio_pci_loaded &&
430 (error = clib_sysfs_write (sysfs_mod_vfio_noiommu, "Y")) == 0)
431 uio_drv_name = "vfio-pci";
432 else if (directory_exists ("/sys/module/uio_pci_generic"))
433 uio_drv_name = "uio_pci_generic";
434 else if (directory_exists ("/sys/module/igb_uio"))
435 uio_drv_name = "igb_uio";
438 clib_error_free (error);
439 error = clib_error_return (0, "Skipping PCI device %U: missing "
440 "kernel VFIO or UIO driver",
441 format_vlib_pci_addr, addr);
444 clib_error_free (error);
448 s = format (s, "%v/driver%c", dev_dir_name, 0);
449 driver_name = clib_sysfs_link_to_name ((char *) s);
450 vec_reset_length (s);
453 ((strcmp ("vfio-pci", (char *) driver_name) == 0) ||
454 (strcmp ("uio_pci_generic", (char *) driver_name) == 0) ||
455 (strcmp ("igb_uio", (char *) driver_name) == 0)))
458 /* walk trough all linux interfaces and if interface belonging to
459 this device is founf check if interface is admin up */
460 dir = opendir ("/sys/class/net");
461 s = format (s, "%U%c", format_vlib_pci_addr, addr, 0);
465 error = clib_error_return (0, "Skipping PCI device %U: failed to "
466 "read /sys/class/net",
467 format_vlib_pci_addr, addr);
471 fd = socket (PF_INET, SOCK_DGRAM, 0);
474 error = clib_error_return_unix (0, "socket");
478 while ((e = readdir (dir)))
481 struct ethtool_drvinfo drvinfo;
483 if (e->d_name[0] == '.') /* skip . and .. */
486 clib_memset (&ifr, 0, sizeof ifr);
487 clib_memset (&drvinfo, 0, sizeof drvinfo);
488 ifr.ifr_data = (char *) &drvinfo;
489 clib_strncpy (ifr.ifr_name, e->d_name, sizeof (ifr.ifr_name) - 1);
491 drvinfo.cmd = ETHTOOL_GDRVINFO;
492 if (ioctl (fd, SIOCETHTOOL, &ifr) < 0)
494 /* Some interfaces (eg "lo") don't support this ioctl */
495 if ((errno != ENOTSUP) && (errno != ENODEV))
496 clib_unix_warning ("ioctl fetch intf %s bus info error",
501 if (strcmp ((char *) s, drvinfo.bus_info))
504 clib_memset (&ifr, 0, sizeof (ifr));
505 clib_strncpy (ifr.ifr_name, e->d_name, sizeof (ifr.ifr_name) - 1);
507 if (ioctl (fd, SIOCGIFFLAGS, &ifr) < 0)
509 error = clib_error_return_unix (0, "ioctl fetch intf %s flags",
515 if (ifr.ifr_flags & IFF_UP)
517 error = clib_error_return (0, "Skipping PCI device %U as host "
518 "interface %s is up",
519 format_vlib_pci_addr, addr, e->d_name);
526 vec_reset_length (s);
528 s = format (s, "%v/driver/unbind%c", dev_dir_name, 0);
529 clib_sysfs_write ((char *) s, "%U", format_vlib_pci_addr, addr);
530 vec_reset_length (s);
532 s = format (s, "%v/driver_override%c", dev_dir_name, 0);
533 if (access ((char *) s, F_OK) == 0)
535 clib_sysfs_write ((char *) s, "%s", uio_drv_name);
536 clear_driver_override = 1;
540 vec_reset_length (s);
541 s = format (s, "%s/%s/new_id%c", sysfs_pci_drv_path, uio_drv_name, 0);
542 clib_sysfs_write ((char *) s, "0x%04x 0x%04x", di->vendor_id,
545 vec_reset_length (s);
547 s = format (s, "%s/%s/bind%c", sysfs_pci_drv_path, uio_drv_name, 0);
548 clib_sysfs_write ((char *) s, "%U", format_vlib_pci_addr, addr);
549 vec_reset_length (s);
551 if (clear_driver_override)
553 s = format (s, "%v/driver_override%c", dev_dir_name, 0);
554 clib_sysfs_write ((char *) s, "%c", 0);
555 vec_reset_length (s);
561 vec_free (dev_dir_name);
562 vec_free (driver_name);
567 static clib_error_t *
568 scan_uio_dir (void *arg, u8 * path_name, u8 * file_name)
570 linux_pci_device_t *l = arg;
571 unformat_input_t input;
573 unformat_init_string (&input, (char *) file_name, vec_len (file_name));
575 if (!unformat (&input, "uio%d", &l->uio_minor))
578 unformat_free (&input);
582 static clib_error_t *
583 vfio_set_irqs (vlib_main_t * vm, linux_pci_device_t * p, u32 index, u32 start,
584 u32 count, u32 flags, int *efds)
586 int data_len = efds ? count * sizeof (int) : 0;
587 u8 buf[sizeof (struct vfio_irq_set) + data_len];
588 struct vfio_irq_info ii = { 0 };
589 struct vfio_irq_set *irq_set = (struct vfio_irq_set *) buf;
592 ii.argsz = sizeof (struct vfio_irq_info);
595 if (ioctl (p->fd, VFIO_DEVICE_GET_IRQ_INFO, &ii) < 0)
596 return clib_error_return_unix (0, "ioctl(VFIO_DEVICE_GET_IRQ_INFO) "
597 "'%U'", format_vlib_pci_addr, &p->addr);
599 pci_log_debug (vm, p, "%s index:%u count:%u flags: %s%s%s%s(0x%x)",
600 __func__, ii.index, ii.count,
601 ii.flags & VFIO_IRQ_INFO_EVENTFD ? "eventfd " : "",
602 ii.flags & VFIO_IRQ_INFO_MASKABLE ? "maskable " : "",
603 ii.flags & VFIO_IRQ_INFO_AUTOMASKED ? "automasked " : "",
604 ii.flags & VFIO_IRQ_INFO_NORESIZE ? "noresize " : "",
607 if (ii.count < start + count)
608 return clib_error_return_unix (0, "vfio_set_irq: unexistng interrupt on "
609 "'%U'", format_vlib_pci_addr, &p->addr);
614 flags |= VFIO_IRQ_SET_DATA_EVENTFD;
615 clib_memcpy_fast (&irq_set->data, efds, data_len);
618 flags |= VFIO_IRQ_SET_DATA_NONE;
620 ASSERT ((flags & (VFIO_IRQ_SET_DATA_NONE | VFIO_IRQ_SET_DATA_EVENTFD)) !=
621 (VFIO_IRQ_SET_DATA_NONE | VFIO_IRQ_SET_DATA_EVENTFD));
623 irq_set->argsz = sizeof (struct vfio_irq_set) + data_len;
624 irq_set->index = index;
625 irq_set->start = start;
626 irq_set->count = count;
627 irq_set->flags = flags;
629 if (ioctl (p->fd, VFIO_DEVICE_SET_IRQS, irq_set) < 0)
630 return clib_error_return_unix (0, "%U:ioctl(VFIO_DEVICE_SET_IRQS) "
631 "[index = %u, start = %u, count = %u, "
633 format_vlib_pci_addr, &p->addr,
634 index, start, count, flags);
638 static clib_error_t *
639 linux_pci_uio_read_ready (clib_file_t * uf)
641 vlib_main_t *vm = vlib_get_main ();
642 int __attribute__ ((unused)) rv;
643 vlib_pci_dev_handle_t h = uf->private_data;
644 linux_pci_device_t *p = linux_pci_get_device (h);
645 linux_pci_irq_t *irq = &p->intx_irq;
648 rv = read (uf->file_descriptor, &icount, 4);
650 if (irq->intx_handler)
651 irq->intx_handler (vm, h);
653 vlib_pci_intr_enable (vm, h);
655 return /* no error */ 0;
658 static clib_error_t *
659 linux_pci_vfio_unmask_intx (vlib_main_t * vm, linux_pci_device_t * d)
661 return vfio_set_irqs (vm, d, VFIO_PCI_INTX_IRQ_INDEX, 0, 1,
662 VFIO_IRQ_SET_ACTION_UNMASK, 0);
665 static clib_error_t *
666 linux_pci_uio_error_ready (clib_file_t * uf)
668 u32 error_index = (u32) uf->private_data;
670 return clib_error_return (0, "pci device %d: error", error_index);
673 static clib_error_t *
674 linux_pci_vfio_msix_read_ready (clib_file_t * uf)
676 vlib_main_t *vm = vlib_get_main ();
677 int __attribute__ ((unused)) rv;
678 vlib_pci_dev_handle_t h = uf->private_data >> 16;
679 u16 line = uf->private_data & 0xffff;
680 linux_pci_device_t *p = linux_pci_get_device (h);
681 linux_pci_irq_t *irq = vec_elt_at_index (p->msix_irqs, line);
684 rv = read (uf->file_descriptor, &icount, sizeof (icount));
686 if (irq->msix_handler)
687 irq->msix_handler (vm, h, line);
689 return /* no error */ 0;
692 static clib_error_t *
693 linux_pci_vfio_intx_read_ready (clib_file_t * uf)
695 vlib_main_t *vm = vlib_get_main ();
696 int __attribute__ ((unused)) rv;
697 vlib_pci_dev_handle_t h = uf->private_data;
698 linux_pci_device_t *p = linux_pci_get_device (h);
699 linux_pci_irq_t *irq = &p->intx_irq;
702 rv = read (uf->file_descriptor, &icount, sizeof (icount));
704 if (irq->intx_handler)
705 irq->intx_handler (vm, h);
707 linux_pci_vfio_unmask_intx (vm, p);
709 return /* no error */ 0;
712 static clib_error_t *
713 linux_pci_vfio_error_ready (clib_file_t * uf)
715 u32 error_index = (u32) uf->private_data;
717 return clib_error_return (0, "pci device %d: error", error_index);
720 static clib_error_t *
721 add_device_uio (vlib_main_t * vm, linux_pci_device_t * p,
722 vlib_pci_device_info_t * di, pci_device_registration_t * r)
724 linux_pci_main_t *lpm = &linux_pci_main;
725 clib_error_t *err = 0;
729 p->type = LINUX_PCI_DEVICE_TYPE_UIO;
731 s = format (s, "%s/%U/config%c", sysfs_pci_dev_path,
732 format_vlib_pci_addr, &di->addr, 0);
734 p->config_fd = open ((char *) s, O_RDWR);
735 p->config_offset = 0;
736 vec_reset_length (s);
738 if (p->config_fd == -1)
740 err = clib_error_return_unix (0, "open '%s'", s);
744 s = format (0, "%s/%U/uio", sysfs_pci_dev_path,
745 format_vlib_pci_addr, &di->addr);
746 foreach_directory_file ((char *) s, scan_uio_dir, p, /* scan_dirs */
748 vec_reset_length (s);
750 s = format (s, "/dev/uio%d%c", p->uio_minor, 0);
751 p->fd = open ((char *) s, O_RDWR);
754 err = clib_error_return_unix (0, "open '%s'", s);
758 if (r && r->interrupt_handler)
759 vlib_pci_register_intx_handler (vm, p->handle, r->interrupt_handler);
761 if (r && r->init_function)
762 err = r->init_function (lpm->vlib_main, p->handle);
768 if (p->config_fd != -1)
769 close (p->config_fd);
777 vlib_pci_register_intx_handler (vlib_main_t * vm, vlib_pci_dev_handle_t h,
778 pci_intx_handler_function_t * intx_handler)
780 linux_pci_device_t *p = linux_pci_get_device (h);
781 clib_file_t t = { 0 };
782 linux_pci_irq_t *irq = &p->intx_irq;
783 ASSERT (irq->fd == -1);
785 if (p->type == LINUX_PCI_DEVICE_TYPE_VFIO)
787 struct vfio_irq_info ii = { 0 };
788 ii.argsz = sizeof (struct vfio_irq_info);
789 ii.index = VFIO_PCI_INTX_IRQ_INDEX;
790 if (ioctl (p->fd, VFIO_DEVICE_GET_IRQ_INFO, &ii) < 0)
791 return clib_error_return_unix (0, "ioctl(VFIO_DEVICE_GET_IRQ_INFO) '"
792 "%U'", format_vlib_pci_addr, &p->addr);
793 pci_log_debug (vm, p, "%s index:%u count:%u flags: %s%s%s%s(0x%x)",
794 __func__, ii.index, ii.count,
795 ii.flags & VFIO_IRQ_INFO_EVENTFD ? "eventfd " : "",
796 ii.flags & VFIO_IRQ_INFO_MASKABLE ? "maskable " : "",
797 ii.flags & VFIO_IRQ_INFO_AUTOMASKED ? "automasked " : "",
798 ii.flags & VFIO_IRQ_INFO_NORESIZE ? "noresize " : "",
801 return clib_error_return (0, "INTx interrupt does not exist on device"
802 "'%U'", format_vlib_pci_addr, &p->addr);
804 irq->fd = eventfd (0, EFD_NONBLOCK);
806 return clib_error_return_unix (0, "eventfd");
808 t.file_descriptor = irq->fd;
809 t.read_function = linux_pci_vfio_intx_read_ready;
811 else if (p->type == LINUX_PCI_DEVICE_TYPE_UIO)
813 t.file_descriptor = p->fd;
814 t.read_function = linux_pci_uio_read_ready;
819 t.error_function = linux_pci_uio_error_ready;
820 t.private_data = p->handle;
821 t.description = format (0, "PCI %U INTx", format_vlib_pci_addr, &p->addr);
822 irq->clib_file_index = clib_file_add (&file_main, &t);
823 irq->intx_handler = intx_handler;
828 vlib_pci_register_msix_handler (vlib_main_t * vm, vlib_pci_dev_handle_t h,
829 u32 start, u32 count,
830 pci_msix_handler_function_t * msix_handler)
832 clib_error_t *err = 0;
833 linux_pci_device_t *p = linux_pci_get_device (h);
836 if (p->type != LINUX_PCI_DEVICE_TYPE_VFIO)
837 return clib_error_return (0, "vfio driver is needed for MSI-X interrupt "
841 vec_validate_init_empty (p->msix_irqs, start + count - 1, (linux_pci_irq_t)
845 for (i = start; i < start + count; i++)
847 clib_file_t t = { 0 };
848 linux_pci_irq_t *irq = vec_elt_at_index (p->msix_irqs, i);
849 ASSERT (irq->fd == -1);
851 irq->fd = eventfd (0, EFD_NONBLOCK);
854 err = clib_error_return_unix (0, "eventfd");
858 t.read_function = linux_pci_vfio_msix_read_ready;
859 t.file_descriptor = irq->fd;
860 t.error_function = linux_pci_vfio_error_ready;
861 t.private_data = p->handle << 16 | i;
862 t.description = format (0, "PCI %U MSI-X #%u", format_vlib_pci_addr,
864 irq->clib_file_index = clib_file_add (&file_main, &t);
865 irq->msix_handler = msix_handler;
873 linux_pci_irq_t *irq = vec_elt_at_index (p->msix_irqs, i);
876 clib_file_del_by_index (&file_main, irq->clib_file_index);
885 vlib_pci_enable_msix_irq (vlib_main_t * vm, vlib_pci_dev_handle_t h,
886 u16 start, u16 count)
888 linux_pci_device_t *p = linux_pci_get_device (h);
892 if (p->type != LINUX_PCI_DEVICE_TYPE_VFIO)
893 return clib_error_return (0, "vfio driver is needed for MSI-X interrupt "
896 for (i = start; i < start + count; i++)
898 linux_pci_irq_t *irq = vec_elt_at_index (p->msix_irqs, i);
902 return vfio_set_irqs (vm, p, VFIO_PCI_MSIX_IRQ_INDEX, start, count,
903 VFIO_IRQ_SET_ACTION_TRIGGER, fds);
907 vlib_pci_disable_msix_irq (vlib_main_t * vm, vlib_pci_dev_handle_t h,
908 u16 start, u16 count)
910 linux_pci_device_t *p = linux_pci_get_device (h);
913 if (p->type != LINUX_PCI_DEVICE_TYPE_VFIO)
914 return clib_error_return (0, "vfio driver is needed for MSI-X interrupt "
917 for (i = start; i < start + count; i++)
920 return vfio_set_irqs (vm, p, VFIO_PCI_MSIX_IRQ_INDEX, start, count,
921 VFIO_IRQ_SET_ACTION_TRIGGER, fds);
924 static clib_error_t *
925 add_device_vfio (vlib_main_t * vm, linux_pci_device_t * p,
926 vlib_pci_device_info_t * di, pci_device_registration_t * r)
928 linux_pci_main_t *lpm = &linux_pci_main;
929 struct vfio_device_info device_info = { 0 };
930 struct vfio_region_info reg = { 0 };
931 clib_error_t *err = 0;
935 p->type = LINUX_PCI_DEVICE_TYPE_VFIO;
937 if ((err = linux_vfio_group_get_device_fd (&p->addr, &p->fd, &is_noiommu)))
941 p->supports_va_dma = 1;
943 device_info.argsz = sizeof (device_info);
944 if (ioctl (p->fd, VFIO_DEVICE_GET_INFO, &device_info) < 0)
946 err = clib_error_return_unix (0, "ioctl(VFIO_DEVICE_GET_INFO) '%U'",
947 format_vlib_pci_addr, &di->addr);
951 reg.argsz = sizeof (struct vfio_region_info);
952 reg.index = VFIO_PCI_CONFIG_REGION_INDEX;
953 if (ioctl (p->fd, VFIO_DEVICE_GET_REGION_INFO, ®) < 0)
955 err = clib_error_return_unix (0, "ioctl(VFIO_DEVICE_GET_INFO) '%U'",
956 format_vlib_pci_addr, &di->addr);
960 pci_log_debug (vm, p, "%s region_info index:%u size:0x%lx offset:0x%lx "
961 "flags: %s%s%s(0x%x)", __func__,
962 reg.index, reg.size, reg.offset,
963 reg.flags & VFIO_REGION_INFO_FLAG_READ ? "rd " : "",
964 reg.flags & VFIO_REGION_INFO_FLAG_WRITE ? "wr " : "",
965 reg.flags & VFIO_REGION_INFO_FLAG_MMAP ? "mmap " : "",
968 p->config_offset = reg.offset;
969 p->config_fd = p->fd;
971 /* reset if device supports it */
972 if (device_info.flags & VFIO_DEVICE_FLAGS_RESET)
973 if (ioctl (p->fd, VFIO_DEVICE_RESET) < 0)
975 err = clib_error_return_unix (0, "ioctl(VFIO_DEVICE_RESET) '%U'",
976 format_vlib_pci_addr, &di->addr);
980 if (r && r->interrupt_handler)
982 vlib_pci_register_intx_handler (vm, p->handle, r->interrupt_handler);
983 linux_pci_vfio_unmask_intx (vm, p);
986 if (p->supports_va_dma)
988 vlib_buffer_pool_t *bp;
990 vec_foreach (bp, vm->buffer_main->buffer_pools)
993 vlib_physmem_map_t *pm;
994 pm = vlib_physmem_get_map (vm, bp->physmem_map_index);
995 for (i = 0; i < pm->n_pages; i++)
996 vfio_map_physmem_page (vm, pm->base + (i << pm->log2_page_size));
1001 if (r && r->init_function)
1002 err = r->init_function (lpm->vlib_main, p->handle);
1010 if (p->config_fd != -1 && p->config_fd != p->fd)
1011 close (p->config_fd);
1012 p->config_fd = p->fd = -1;
1017 /* Configuration space read/write. */
1019 vlib_pci_read_write_config (vlib_main_t * vm, vlib_pci_dev_handle_t h,
1020 vlib_read_or_write_t read_or_write,
1021 uword address, void *data, u32 n_bytes)
1023 linux_pci_device_t *p = linux_pci_get_device (h);
1026 if (read_or_write == VLIB_READ)
1027 n = pread (p->config_fd, data, n_bytes, p->config_offset + address);
1029 n = pwrite (p->config_fd, data, n_bytes, p->config_offset + address);
1032 return clib_error_return_unix (0, "%s",
1033 read_or_write == VLIB_READ
1034 ? "read" : "write");
1039 static clib_error_t *
1040 vlib_pci_region (vlib_main_t * vm, vlib_pci_dev_handle_t h, u32 bar, int *fd,
1041 u64 * size, u64 * offset)
1043 linux_pci_device_t *p = linux_pci_get_device (h);
1044 clib_error_t *error = 0;
1046 u64 _size = 0, _offset = 0;
1052 if (p->type == LINUX_PCI_DEVICE_TYPE_UIO)
1055 struct stat stat_buf;
1056 file_name = format (0, "%s/%U/resource%d%c", sysfs_pci_dev_path,
1057 format_vlib_pci_addr, &p->addr, bar, 0);
1059 _fd = open ((char *) file_name, O_RDWR);
1062 error = clib_error_return_unix (0, "open `%s'", file_name);
1063 vec_free (file_name);
1067 if (fstat (_fd, &stat_buf) < 0)
1069 error = clib_error_return_unix (0, "fstat `%s'", file_name);
1070 vec_free (file_name);
1075 vec_free (file_name);
1076 _size = stat_buf.st_size;
1079 else if (p->type == LINUX_PCI_DEVICE_TYPE_VFIO)
1081 struct vfio_region_info reg = { 0 };
1082 reg.argsz = sizeof (struct vfio_region_info);
1084 if (ioctl (p->fd, VFIO_DEVICE_GET_REGION_INFO, ®) < 0)
1085 return clib_error_return_unix (0, "ioctl(VFIO_DEVICE_GET_INFO) "
1086 "'%U'", format_vlib_pci_addr,
1090 _offset = reg.offset;
1091 pci_log_debug (vm, p, "%s region_info index:%u size:0x%lx offset:0x%lx "
1092 "flags: %s%s%s(0x%x)", __func__,
1093 reg.index, reg.size, reg.offset,
1094 reg.flags & VFIO_REGION_INFO_FLAG_READ ? "rd " : "",
1095 reg.flags & VFIO_REGION_INFO_FLAG_WRITE ? "wr " : "",
1096 reg.flags & VFIO_REGION_INFO_FLAG_MMAP ? "mmap " : "",
1109 static clib_error_t *
1110 vlib_pci_map_region_int (vlib_main_t * vm, vlib_pci_dev_handle_t h,
1111 u32 bar, u8 * addr, void **result)
1113 linux_pci_device_t *p = linux_pci_get_device (h);
1115 clib_error_t *error;
1116 int flags = MAP_SHARED;
1117 u64 size = 0, offset = 0;
1119 pci_log_debug (vm, p, "map region %u to va %p", bar, addr);
1121 if ((error = vlib_pci_region (vm, h, bar, &fd, &size, &offset)))
1124 if (p->type == LINUX_PCI_DEVICE_TYPE_UIO && addr != 0)
1127 *result = mmap (addr, size, PROT_READ | PROT_WRITE, flags, fd, offset);
1128 if (*result == (void *) -1)
1130 error = clib_error_return_unix (0, "mmap `BAR%u'", bar);
1131 if (p->type == LINUX_PCI_DEVICE_TYPE_UIO)
1137 vec_validate_init_empty (p->regions, bar,
1138 (linux_pci_region_t) { .fd = -1});
1140 if (p->type == LINUX_PCI_DEVICE_TYPE_UIO)
1141 p->regions[bar].fd = fd;
1142 p->regions[bar].addr = *result;
1143 p->regions[bar].size = size;
1148 vlib_pci_map_region (vlib_main_t * vm, vlib_pci_dev_handle_t h, u32 resource,
1151 return (vlib_pci_map_region_int (vm, h, resource, 0 /* addr */ , result));
1155 vlib_pci_map_region_fixed (vlib_main_t * vm, vlib_pci_dev_handle_t h,
1156 u32 resource, u8 * addr, void **result)
1158 return (vlib_pci_map_region_int (vm, h, resource, addr, result));
1162 vlib_pci_io_region (vlib_main_t * vm, vlib_pci_dev_handle_t h, u32 resource)
1164 linux_pci_device_t *p = linux_pci_get_device (h);
1165 clib_error_t *error = 0;
1167 u64 size = 0, offset = 0;
1169 if ((error = vlib_pci_region (vm, h, resource, &fd, &size, &offset)))
1173 p->io_offset = offset;
1178 vlib_pci_read_write_io (vlib_main_t * vm, vlib_pci_dev_handle_t h,
1179 vlib_read_or_write_t read_or_write,
1180 uword offset, void *data, u32 length)
1182 linux_pci_device_t *p = linux_pci_get_device (h);
1185 if (read_or_write == VLIB_READ)
1186 n = pread (p->io_fd, data, length, p->io_offset + offset);
1188 n = pwrite (p->io_fd, data, length, p->io_offset + offset);
1191 return clib_error_return_unix (0, "%s",
1192 read_or_write == VLIB_READ
1193 ? "read" : "write");
1198 vlib_pci_map_dma (vlib_main_t * vm, vlib_pci_dev_handle_t h, void *ptr)
1200 linux_pci_device_t *p = linux_pci_get_device (h);
1202 if (!p->supports_va_dma)
1205 return vfio_map_physmem_page (vm, ptr);
1209 vlib_pci_supports_virtual_addr_dma (vlib_main_t * vm, vlib_pci_dev_handle_t h)
1211 linux_pci_device_t *p = linux_pci_get_device (h);
1213 return p->supports_va_dma != 0;
1217 vlib_pci_device_open (vlib_main_t * vm, vlib_pci_addr_t * addr,
1218 pci_device_id_t ids[], vlib_pci_dev_handle_t * handle)
1220 linux_pci_main_t *lpm = &linux_pci_main;
1221 vlib_pci_device_info_t *di;
1222 linux_pci_device_t *p;
1223 clib_error_t *err = 0;
1226 di = vlib_pci_get_device_info (vm, addr, &err);
1230 for (i = ids; i->vendor_id != 0; i++)
1231 if (i->vendor_id == di->vendor_id && i->device_id == di->device_id)
1234 if (i->vendor_id == 0)
1235 return clib_error_return (0, "Wrong vendor or device id");
1237 pool_get (lpm->linux_pci_devices, p);
1238 p->handle = p - lpm->linux_pci_devices;
1239 p->addr.as_u32 = di->addr.as_u32;
1240 p->intx_irq.fd = -1;
1241 p->intx_irq.clib_file_index = -1;
1242 p->numa_node = di->numa_node;
1244 * pci io bar read/write fd
1248 pci_log_debug (vm, p, "open vid:0x%04x did:0x%04x driver:%s iommu_group:%d",
1249 di->vendor_id, di->device_id, di->driver_name,
1252 if (clib_strncmp ("vfio-pci", (char *) di->driver_name, 8) == 0)
1253 err = add_device_vfio (vm, p, di, 0);
1254 else if (clib_strncmp ("uio_pci_generic", (char *) di->driver_name, 8) == 0)
1255 err = add_device_uio (vm, p, di, 0);
1257 err = clib_error_create ("device not bound to 'vfio-pci' or "
1258 "'uio_pci_generic' kernel module");
1262 *handle = p->handle;
1265 vlib_pci_free_device_info (di);
1268 pci_log_err (vm, p, "%U", format_clib_error, err);
1269 clib_memset (p, 0, sizeof (linux_pci_device_t));
1270 pool_put (lpm->linux_pci_devices, p);
1277 vlib_pci_device_close (vlib_main_t * vm, vlib_pci_dev_handle_t h)
1279 linux_pci_main_t *lpm = &linux_pci_main;
1280 linux_pci_device_t *p = linux_pci_get_device (h);
1281 linux_pci_irq_t *irq;
1282 linux_pci_region_t *res;
1283 clib_error_t *err = 0;
1285 if (p->type == LINUX_PCI_DEVICE_TYPE_UIO)
1288 if (irq->clib_file_index != -1)
1289 clib_file_del_by_index (&file_main, irq->clib_file_index);
1290 close (p->config_fd);
1294 else if (p->type == LINUX_PCI_DEVICE_TYPE_VFIO)
1297 /* close INTx irqs */
1300 err = vfio_set_irqs (vm, p, VFIO_PCI_INTX_IRQ_INDEX, 0, 0,
1301 VFIO_IRQ_SET_ACTION_TRIGGER, 0);
1302 clib_error_free (err);
1303 if (irq->clib_file_index != -1)
1304 clib_file_del_by_index (&file_main, irq->clib_file_index);
1308 /* close MSI-X irqs */
1309 if (vec_len (p->msix_irqs))
1311 err = vfio_set_irqs (vm, p, VFIO_PCI_MSIX_IRQ_INDEX, 0, 0,
1312 VFIO_IRQ_SET_ACTION_TRIGGER, 0);
1313 clib_error_free (err);
1315 vec_foreach (irq, p->msix_irqs)
1319 clib_file_del_by_index (&file_main, irq->clib_file_index);
1323 vec_free (p->msix_irqs);
1328 vec_foreach (res, p->regions)
1332 munmap (res->addr, res->size);
1337 vec_free (p->regions);
1340 clib_memset (p, 0, sizeof (linux_pci_device_t));
1341 pool_put (lpm->linux_pci_devices, p);
1345 init_device_from_registered (vlib_main_t * vm, vlib_pci_device_info_t * di)
1347 vlib_pci_main_t *pm = &pci_main;
1348 linux_pci_main_t *lpm = &linux_pci_main;
1349 pci_device_registration_t *r;
1351 clib_error_t *err = 0;
1352 linux_pci_device_t *p;
1354 pool_get (lpm->linux_pci_devices, p);
1355 p->handle = p - lpm->linux_pci_devices;
1356 p->intx_irq.fd = -1;
1358 r = pm->pci_device_registrations;
1362 for (i = r->supported_devices; i->vendor_id != 0; i++)
1363 if (i->vendor_id == di->vendor_id && i->device_id == di->device_id)
1365 if (di->iommu_group != -1)
1366 err = add_device_vfio (vm, p, di, r);
1368 err = add_device_uio (vm, p, di, r);
1371 clib_error_report (err);
1375 r = r->next_registration;
1378 /* No driver, close the PCI config-space FD */
1379 clib_memset (p, 0, sizeof (linux_pci_device_t));
1380 pool_put (lpm->linux_pci_devices, p);
1383 static clib_error_t *
1384 scan_pci_addr (void *arg, u8 * dev_dir_name, u8 * ignored)
1386 vlib_pci_addr_t addr, **addrv = arg;
1387 unformat_input_t input;
1388 clib_error_t *err = 0;
1390 unformat_init_string (&input, (char *) dev_dir_name,
1391 vec_len (dev_dir_name));
1393 if (!unformat (&input, "/sys/bus/pci/devices/%U",
1394 unformat_vlib_pci_addr, &addr))
1395 err = clib_error_return (0, "unformat error `%v`", dev_dir_name);
1397 unformat_free (&input);
1402 vec_add1 (*addrv, addr);
1407 pci_addr_cmp (void *v1, void *v2)
1409 vlib_pci_addr_t *a1 = v1;
1410 vlib_pci_addr_t *a2 = v2;
1412 if (a1->domain > a2->domain)
1414 if (a1->domain < a2->domain)
1416 if (a1->bus > a2->bus)
1418 if (a1->bus < a2->bus)
1420 if (a1->slot > a2->slot)
1422 if (a1->slot < a2->slot)
1424 if (a1->function > a2->function)
1426 if (a1->function < a2->function)
1432 vlib_pci_get_all_dev_addrs ()
1434 vlib_pci_addr_t *addrs = 0;
1436 err = foreach_directory_file ((char *) sysfs_pci_dev_path, scan_pci_addr,
1437 &addrs, /* scan_dirs */ 0);
1444 vec_sort_with_function (addrs, pci_addr_cmp);
1450 linux_pci_init (vlib_main_t * vm)
1452 vlib_pci_main_t *pm = &pci_main;
1453 vlib_pci_addr_t *addr = 0, *addrs;
1457 ASSERT (sizeof (vlib_pci_addr_t) == sizeof (u32));
1459 addrs = vlib_pci_get_all_dev_addrs ();
1461 vec_foreach (addr, addrs)
1463 vlib_pci_device_info_t *d;
1464 if ((d = vlib_pci_get_device_info (vm, addr, 0)))
1466 init_device_from_registered (vm, d);
1467 vlib_pci_free_device_info (d);
1476 VLIB_INIT_FUNCTION (linux_pci_init) =
1478 .runs_after = VLIB_INITS("unix_input_init"),
1483 * fd.io coding-style-patch-verification: ON
1486 * eval: (c-set-style "gnu")