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_validate (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 error = clib_error_return (0, "Skipping PCI device %U as host "
527 "interface %s is up",
528 format_vlib_pci_addr, addr, e->d_name);
535 vec_reset_length (s);
537 s = format (s, "%v/driver/unbind%c", dev_dir_name, 0);
538 clib_sysfs_write ((char *) s, "%U", format_vlib_pci_addr, addr);
539 vec_reset_length (s);
541 s = format (s, "%v/driver_override%c", dev_dir_name, 0);
542 if (access ((char *) s, F_OK) == 0)
544 clib_sysfs_write ((char *) s, "%s", uio_drv_name);
545 clear_driver_override = 1;
549 vec_reset_length (s);
550 s = format (s, "%s/%s/new_id%c", sysfs_pci_drv_path, uio_drv_name, 0);
551 clib_sysfs_write ((char *) s, "0x%04x 0x%04x", di->vendor_id,
554 vec_reset_length (s);
556 s = format (s, "%s/%s/bind%c", sysfs_pci_drv_path, uio_drv_name, 0);
557 clib_sysfs_write ((char *) s, "%U", format_vlib_pci_addr, addr);
558 vec_reset_length (s);
560 if (clear_driver_override)
562 s = format (s, "%v/driver_override%c", dev_dir_name, 0);
563 clib_sysfs_write ((char *) s, "%c", 0);
564 vec_reset_length (s);
570 vec_free (dev_dir_name);
571 vec_free (driver_name);
576 static clib_error_t *
577 scan_uio_dir (void *arg, u8 * path_name, u8 * file_name)
579 linux_pci_device_t *l = arg;
580 unformat_input_t input;
582 unformat_init_string (&input, (char *) file_name, vec_len (file_name));
584 if (!unformat (&input, "uio%d", &l->uio_minor))
587 unformat_free (&input);
591 static clib_error_t *
592 vfio_set_irqs (vlib_main_t * vm, linux_pci_device_t * p, u32 index, u32 start,
593 u32 count, u32 flags, int *efds)
595 int data_len = efds ? count * sizeof (int) : 0;
596 u8 buf[sizeof (struct vfio_irq_set) + data_len];
597 struct vfio_irq_info ii = { 0 };
598 struct vfio_irq_set *irq_set = (struct vfio_irq_set *) buf;
601 ii.argsz = sizeof (struct vfio_irq_info);
604 if (ioctl (p->fd, VFIO_DEVICE_GET_IRQ_INFO, &ii) < 0)
605 return clib_error_return_unix (0, "ioctl(VFIO_DEVICE_GET_IRQ_INFO) "
606 "'%U'", format_vlib_pci_addr, &p->addr);
608 pci_log_debug (vm, p, "%s index:%u count:%u flags: %s%s%s%s(0x%x)",
609 __func__, ii.index, ii.count,
610 ii.flags & VFIO_IRQ_INFO_EVENTFD ? "eventfd " : "",
611 ii.flags & VFIO_IRQ_INFO_MASKABLE ? "maskable " : "",
612 ii.flags & VFIO_IRQ_INFO_AUTOMASKED ? "automasked " : "",
613 ii.flags & VFIO_IRQ_INFO_NORESIZE ? "noresize " : "",
616 if (ii.count < start + count)
617 return clib_error_return_unix (0, "vfio_set_irq: unexistng interrupt on "
618 "'%U'", format_vlib_pci_addr, &p->addr);
623 flags |= VFIO_IRQ_SET_DATA_EVENTFD;
624 clib_memcpy_fast (&irq_set->data, efds, data_len);
627 flags |= VFIO_IRQ_SET_DATA_NONE;
629 ASSERT ((flags & (VFIO_IRQ_SET_DATA_NONE | VFIO_IRQ_SET_DATA_EVENTFD)) !=
630 (VFIO_IRQ_SET_DATA_NONE | VFIO_IRQ_SET_DATA_EVENTFD));
632 irq_set->argsz = sizeof (struct vfio_irq_set) + data_len;
633 irq_set->index = index;
634 irq_set->start = start;
635 irq_set->count = count;
636 irq_set->flags = flags;
638 if (ioctl (p->fd, VFIO_DEVICE_SET_IRQS, irq_set) < 0)
639 return clib_error_return_unix (0, "%U:ioctl(VFIO_DEVICE_SET_IRQS) "
640 "[index = %u, start = %u, count = %u, "
642 format_vlib_pci_addr, &p->addr,
643 index, start, count, flags);
647 static clib_error_t *
648 linux_pci_uio_read_ready (clib_file_t * uf)
650 vlib_main_t *vm = vlib_get_main ();
651 int __attribute__ ((unused)) rv;
652 vlib_pci_dev_handle_t h = uf->private_data;
653 linux_pci_device_t *p = linux_pci_get_device (h);
654 linux_pci_irq_t *irq = &p->intx_irq;
657 rv = read (uf->file_descriptor, &icount, 4);
659 if (irq->intx_handler)
660 irq->intx_handler (vm, h);
662 vlib_pci_intr_enable (vm, h);
664 return /* no error */ 0;
667 static clib_error_t *
668 linux_pci_vfio_unmask_intx (vlib_main_t * vm, linux_pci_device_t * d)
670 return vfio_set_irqs (vm, d, VFIO_PCI_INTX_IRQ_INDEX, 0, 1,
671 VFIO_IRQ_SET_ACTION_UNMASK, 0);
674 static clib_error_t *
675 linux_pci_uio_error_ready (clib_file_t * uf)
677 u32 error_index = (u32) uf->private_data;
679 return clib_error_return (0, "pci device %d: error", error_index);
682 static clib_error_t *
683 linux_pci_vfio_msix_read_ready (clib_file_t * uf)
685 vlib_main_t *vm = vlib_get_main ();
686 int __attribute__ ((unused)) rv;
687 vlib_pci_dev_handle_t h = uf->private_data >> 16;
688 u16 line = uf->private_data & 0xffff;
689 linux_pci_device_t *p = linux_pci_get_device (h);
690 linux_pci_irq_t *irq = vec_elt_at_index (p->msix_irqs, line);
693 rv = read (uf->file_descriptor, &icount, sizeof (icount));
695 if (irq->msix_handler)
696 irq->msix_handler (vm, h, line);
698 return /* no error */ 0;
701 static clib_error_t *
702 linux_pci_vfio_intx_read_ready (clib_file_t * uf)
704 vlib_main_t *vm = vlib_get_main ();
705 int __attribute__ ((unused)) rv;
706 vlib_pci_dev_handle_t h = uf->private_data;
707 linux_pci_device_t *p = linux_pci_get_device (h);
708 linux_pci_irq_t *irq = &p->intx_irq;
711 rv = read (uf->file_descriptor, &icount, sizeof (icount));
713 if (irq->intx_handler)
714 irq->intx_handler (vm, h);
716 linux_pci_vfio_unmask_intx (vm, p);
718 return /* no error */ 0;
721 static clib_error_t *
722 linux_pci_vfio_error_ready (clib_file_t * uf)
724 u32 error_index = (u32) uf->private_data;
726 return clib_error_return (0, "pci device %d: error", error_index);
729 static clib_error_t *
730 add_device_uio (vlib_main_t * vm, linux_pci_device_t * p,
731 vlib_pci_device_info_t * di, pci_device_registration_t * r)
733 linux_pci_main_t *lpm = &linux_pci_main;
734 clib_error_t *err = 0;
738 p->type = LINUX_PCI_DEVICE_TYPE_UIO;
740 s = format (s, "%s/%U/config%c", sysfs_pci_dev_path,
741 format_vlib_pci_addr, &di->addr, 0);
743 p->config_fd = open ((char *) s, O_RDWR);
744 p->config_offset = 0;
745 vec_reset_length (s);
747 if (p->config_fd == -1)
749 err = clib_error_return_unix (0, "open '%s'", s);
753 s = format (0, "%s/%U/uio%c", sysfs_pci_dev_path,
754 format_vlib_pci_addr, &di->addr, 0);
755 foreach_directory_file ((char *) s, scan_uio_dir, p, /* scan_dirs */
757 vec_reset_length (s);
759 s = format (s, "/dev/uio%d%c", p->uio_minor, 0);
760 p->fd = open ((char *) s, O_RDWR);
763 err = clib_error_return_unix (0, "open '%s'", s);
767 if (r && r->interrupt_handler)
768 vlib_pci_register_intx_handler (vm, p->handle, r->interrupt_handler);
770 if (r && r->init_function)
771 err = r->init_function (lpm->vlib_main, p->handle);
777 if (p->config_fd != -1)
778 close (p->config_fd);
786 vlib_pci_register_intx_handler (vlib_main_t * vm, vlib_pci_dev_handle_t h,
787 pci_intx_handler_function_t * intx_handler)
789 linux_pci_device_t *p = linux_pci_get_device (h);
790 clib_file_t t = { 0 };
791 linux_pci_irq_t *irq = &p->intx_irq;
792 ASSERT (irq->fd == -1);
794 if (p->type == LINUX_PCI_DEVICE_TYPE_VFIO)
796 struct vfio_irq_info ii = { 0 };
797 ii.argsz = sizeof (struct vfio_irq_info);
798 ii.index = VFIO_PCI_INTX_IRQ_INDEX;
799 if (ioctl (p->fd, VFIO_DEVICE_GET_IRQ_INFO, &ii) < 0)
800 return clib_error_return_unix (0, "ioctl(VFIO_DEVICE_GET_IRQ_INFO) '"
801 "%U'", format_vlib_pci_addr, &p->addr);
802 pci_log_debug (vm, p, "%s index:%u count:%u flags: %s%s%s%s(0x%x)",
803 __func__, ii.index, ii.count,
804 ii.flags & VFIO_IRQ_INFO_EVENTFD ? "eventfd " : "",
805 ii.flags & VFIO_IRQ_INFO_MASKABLE ? "maskable " : "",
806 ii.flags & VFIO_IRQ_INFO_AUTOMASKED ? "automasked " : "",
807 ii.flags & VFIO_IRQ_INFO_NORESIZE ? "noresize " : "",
810 return clib_error_return (0, "INTx interrupt does not exist on device"
811 "'%U'", format_vlib_pci_addr, &p->addr);
813 irq->fd = eventfd (0, EFD_NONBLOCK);
815 return clib_error_return_unix (0, "eventfd");
817 t.file_descriptor = irq->fd;
818 t.read_function = linux_pci_vfio_intx_read_ready;
820 else if (p->type == LINUX_PCI_DEVICE_TYPE_UIO)
822 t.file_descriptor = p->fd;
823 t.read_function = linux_pci_uio_read_ready;
828 t.error_function = linux_pci_uio_error_ready;
829 t.private_data = p->handle;
830 t.description = format (0, "PCI %U INTx", format_vlib_pci_addr, &p->addr);
831 irq->clib_file_index = clib_file_add (&file_main, &t);
832 irq->intx_handler = intx_handler;
837 vlib_pci_register_msix_handler (vlib_main_t * vm, vlib_pci_dev_handle_t h,
838 u32 start, u32 count,
839 pci_msix_handler_function_t * msix_handler)
841 clib_error_t *err = 0;
842 linux_pci_device_t *p = linux_pci_get_device (h);
845 if (p->type != LINUX_PCI_DEVICE_TYPE_VFIO)
846 return clib_error_return (0, "vfio driver is needed for MSI-X interrupt "
850 vec_validate_init_empty (p->msix_irqs, start + count - 1, (linux_pci_irq_t)
854 for (i = start; i < start + count; i++)
856 clib_file_t t = { 0 };
857 linux_pci_irq_t *irq = vec_elt_at_index (p->msix_irqs, i);
858 ASSERT (irq->fd == -1);
860 irq->fd = eventfd (0, EFD_NONBLOCK);
863 err = clib_error_return_unix (0, "eventfd");
867 t.read_function = linux_pci_vfio_msix_read_ready;
868 t.file_descriptor = irq->fd;
869 t.error_function = linux_pci_vfio_error_ready;
870 t.private_data = p->handle << 16 | i;
871 t.description = format (0, "PCI %U MSI-X #%u", format_vlib_pci_addr,
873 irq->clib_file_index = clib_file_add (&file_main, &t);
874 irq->msix_handler = msix_handler;
882 linux_pci_irq_t *irq = vec_elt_at_index (p->msix_irqs, i);
885 clib_file_del_by_index (&file_main, irq->clib_file_index);
894 vlib_pci_enable_msix_irq (vlib_main_t * vm, vlib_pci_dev_handle_t h,
895 u16 start, u16 count)
897 linux_pci_device_t *p = linux_pci_get_device (h);
901 if (p->type != LINUX_PCI_DEVICE_TYPE_VFIO)
902 return clib_error_return (0, "vfio driver is needed for MSI-X interrupt "
905 for (i = start; i < start + count; i++)
907 linux_pci_irq_t *irq = vec_elt_at_index (p->msix_irqs, i);
911 return vfio_set_irqs (vm, p, VFIO_PCI_MSIX_IRQ_INDEX, start, count,
912 VFIO_IRQ_SET_ACTION_TRIGGER, fds);
916 vlib_pci_disable_msix_irq (vlib_main_t * vm, vlib_pci_dev_handle_t h,
917 u16 start, u16 count)
919 linux_pci_device_t *p = linux_pci_get_device (h);
922 if (p->type != LINUX_PCI_DEVICE_TYPE_VFIO)
923 return clib_error_return (0, "vfio driver is needed for MSI-X interrupt "
926 for (i = start; i < start + count; i++)
929 return vfio_set_irqs (vm, p, VFIO_PCI_MSIX_IRQ_INDEX, start, count,
930 VFIO_IRQ_SET_ACTION_TRIGGER, fds);
933 static clib_error_t *
934 add_device_vfio (vlib_main_t * vm, linux_pci_device_t * p,
935 vlib_pci_device_info_t * di, pci_device_registration_t * r)
937 linux_pci_main_t *lpm = &linux_pci_main;
938 struct vfio_device_info device_info = { 0 };
939 struct vfio_region_info reg = { 0 };
940 clib_error_t *err = 0;
944 p->type = LINUX_PCI_DEVICE_TYPE_VFIO;
946 if ((err = linux_vfio_group_get_device_fd (&p->addr, &p->fd, &is_noiommu)))
950 p->supports_va_dma = 1;
952 device_info.argsz = sizeof (device_info);
953 if (ioctl (p->fd, VFIO_DEVICE_GET_INFO, &device_info) < 0)
955 err = clib_error_return_unix (0, "ioctl(VFIO_DEVICE_GET_INFO) '%U'",
956 format_vlib_pci_addr, &di->addr);
960 reg.argsz = sizeof (struct vfio_region_info);
961 reg.index = VFIO_PCI_CONFIG_REGION_INDEX;
962 if (ioctl (p->fd, VFIO_DEVICE_GET_REGION_INFO, ®) < 0)
964 err = clib_error_return_unix (0, "ioctl(VFIO_DEVICE_GET_INFO) '%U'",
965 format_vlib_pci_addr, &di->addr);
969 pci_log_debug (vm, p, "%s %U", __func__, format_vfio_region_info, ®);
971 p->config_offset = reg.offset;
972 p->config_fd = p->fd;
974 /* reset if device supports it */
975 if (device_info.flags & VFIO_DEVICE_FLAGS_RESET)
976 if (ioctl (p->fd, VFIO_DEVICE_RESET) < 0)
978 err = clib_error_return_unix (0, "ioctl(VFIO_DEVICE_RESET) '%U'",
979 format_vlib_pci_addr, &di->addr);
983 if (r && r->interrupt_handler)
985 vlib_pci_register_intx_handler (vm, p->handle, r->interrupt_handler);
986 linux_pci_vfio_unmask_intx (vm, p);
989 if (p->supports_va_dma)
991 vlib_buffer_pool_t *bp;
993 vec_foreach (bp, vm->buffer_main->buffer_pools)
996 vlib_physmem_map_t *pm;
997 pm = vlib_physmem_get_map (vm, bp->physmem_map_index);
998 for (i = 0; i < pm->n_pages; i++)
999 vfio_map_physmem_page (vm, pm->base + (i << pm->log2_page_size));
1004 if (r && r->init_function)
1005 err = r->init_function (lpm->vlib_main, p->handle);
1013 if (p->config_fd != -1 && p->config_fd != p->fd)
1014 close (p->config_fd);
1015 p->config_fd = p->fd = -1;
1020 /* Configuration space read/write. */
1022 vlib_pci_read_write_config (vlib_main_t * vm, vlib_pci_dev_handle_t h,
1023 vlib_read_or_write_t read_or_write,
1024 uword address, void *data, u32 n_bytes)
1026 linux_pci_device_t *p = linux_pci_get_device (h);
1029 if (read_or_write == VLIB_READ)
1030 n = pread (p->config_fd, data, n_bytes, p->config_offset + address);
1032 n = pwrite (p->config_fd, data, n_bytes, p->config_offset + address);
1035 return clib_error_return_unix (0, "%s",
1036 read_or_write == VLIB_READ
1037 ? "read" : "write");
1042 static clib_error_t *
1043 vlib_pci_region (vlib_main_t * vm, vlib_pci_dev_handle_t h, u32 bar, int *fd,
1044 u64 * size, u64 * offset)
1046 linux_pci_device_t *p = linux_pci_get_device (h);
1047 clib_error_t *error = 0;
1049 u64 _size = 0, _offset = 0;
1055 if (p->type == LINUX_PCI_DEVICE_TYPE_UIO)
1058 struct stat stat_buf;
1059 file_name = format (0, "%s/%U/resource%d%c", sysfs_pci_dev_path,
1060 format_vlib_pci_addr, &p->addr, bar, 0);
1062 _fd = open ((char *) file_name, O_RDWR);
1065 error = clib_error_return_unix (0, "open `%s'", file_name);
1066 vec_free (file_name);
1070 if (fstat (_fd, &stat_buf) < 0)
1072 error = clib_error_return_unix (0, "fstat `%s'", file_name);
1073 vec_free (file_name);
1078 vec_free (file_name);
1079 _size = stat_buf.st_size;
1082 else if (p->type == LINUX_PCI_DEVICE_TYPE_VFIO)
1084 struct vfio_region_info *r;
1085 u32 sz = sizeof (struct vfio_region_info);
1087 r = clib_mem_alloc (sz);
1088 clib_memset (r, 0, sz);
1091 if (ioctl (p->fd, VFIO_DEVICE_GET_REGION_INFO, r) < 0)
1092 return clib_error_return_unix (0, "ioctl(VFIO_DEVICE_GET_INFO) "
1093 "'%U'", format_vlib_pci_addr,
1103 _offset = r->offset;
1104 pci_log_debug (vm, p, "%s %U", __func__, format_vfio_region_info, r);
1117 static clib_error_t *
1118 vlib_pci_map_region_int (vlib_main_t * vm, vlib_pci_dev_handle_t h,
1119 u32 bar, u8 * addr, void **result)
1121 linux_pci_device_t *p = linux_pci_get_device (h);
1123 clib_error_t *error;
1124 int flags = MAP_SHARED;
1125 u64 size = 0, offset = 0;
1127 pci_log_debug (vm, p, "map region %u to va %p", bar, addr);
1129 if ((error = vlib_pci_region (vm, h, bar, &fd, &size, &offset)))
1132 if (p->type == LINUX_PCI_DEVICE_TYPE_UIO && addr != 0)
1135 *result = mmap (addr, size, PROT_READ | PROT_WRITE, flags, fd, offset);
1136 if (*result == (void *) -1)
1138 error = clib_error_return_unix (0, "mmap `BAR%u'", bar);
1139 if (p->type == LINUX_PCI_DEVICE_TYPE_UIO && (fd != -1))
1145 vec_validate_init_empty (p->regions, bar,
1146 (linux_pci_region_t) { .fd = -1});
1148 if (p->type == LINUX_PCI_DEVICE_TYPE_UIO)
1149 p->regions[bar].fd = fd;
1150 p->regions[bar].addr = *result;
1151 p->regions[bar].size = size;
1156 vlib_pci_map_region (vlib_main_t * vm, vlib_pci_dev_handle_t h, u32 resource,
1159 return (vlib_pci_map_region_int (vm, h, resource, 0 /* addr */ , result));
1163 vlib_pci_map_region_fixed (vlib_main_t * vm, vlib_pci_dev_handle_t h,
1164 u32 resource, u8 * addr, void **result)
1166 return (vlib_pci_map_region_int (vm, h, resource, addr, result));
1170 vlib_pci_io_region (vlib_main_t * vm, vlib_pci_dev_handle_t h, u32 resource)
1172 linux_pci_device_t *p = linux_pci_get_device (h);
1173 clib_error_t *error = 0;
1175 u64 size = 0, offset = 0;
1177 if ((error = vlib_pci_region (vm, h, resource, &fd, &size, &offset)))
1181 p->io_offset = offset;
1186 vlib_pci_read_write_io (vlib_main_t * vm, vlib_pci_dev_handle_t h,
1187 vlib_read_or_write_t read_or_write,
1188 uword offset, void *data, u32 length)
1190 linux_pci_device_t *p = linux_pci_get_device (h);
1193 if (read_or_write == VLIB_READ)
1194 n = pread (p->io_fd, data, length, p->io_offset + offset);
1196 n = pwrite (p->io_fd, data, length, p->io_offset + offset);
1199 return clib_error_return_unix (0, "%s",
1200 read_or_write == VLIB_READ
1201 ? "read" : "write");
1206 vlib_pci_map_dma (vlib_main_t * vm, vlib_pci_dev_handle_t h, void *ptr)
1208 linux_pci_device_t *p = linux_pci_get_device (h);
1210 if (!p->supports_va_dma)
1213 return vfio_map_physmem_page (vm, ptr);
1217 vlib_pci_supports_virtual_addr_dma (vlib_main_t * vm, vlib_pci_dev_handle_t h)
1219 linux_pci_device_t *p = linux_pci_get_device (h);
1221 return p->supports_va_dma != 0;
1225 vlib_pci_device_open (vlib_main_t * vm, vlib_pci_addr_t * addr,
1226 pci_device_id_t ids[], vlib_pci_dev_handle_t * handle)
1228 linux_pci_main_t *lpm = &linux_pci_main;
1229 vlib_pci_device_info_t *di;
1230 linux_pci_device_t *p;
1231 clib_error_t *err = 0;
1234 di = vlib_pci_get_device_info (vm, addr, &err);
1238 for (i = ids; i->vendor_id != 0; i++)
1239 if (i->vendor_id == di->vendor_id && i->device_id == di->device_id)
1242 if (i->vendor_id == 0)
1243 return clib_error_return (0, "Wrong vendor or device id");
1245 pool_get (lpm->linux_pci_devices, p);
1246 p->handle = p - lpm->linux_pci_devices;
1247 p->addr.as_u32 = di->addr.as_u32;
1248 p->intx_irq.fd = -1;
1249 p->intx_irq.clib_file_index = -1;
1250 p->numa_node = di->numa_node;
1252 * pci io bar read/write fd
1256 pci_log_debug (vm, p, "open vid:0x%04x did:0x%04x driver:%s iommu_group:%d",
1257 di->vendor_id, di->device_id, di->driver_name,
1260 if (clib_strncmp ("vfio-pci", (char *) di->driver_name, 8) == 0)
1261 err = add_device_vfio (vm, p, di, 0);
1262 else if (clib_strncmp ("uio_pci_generic", (char *) di->driver_name, 8) == 0)
1263 err = add_device_uio (vm, p, di, 0);
1265 err = clib_error_create ("device not bound to 'vfio-pci' or "
1266 "'uio_pci_generic' kernel module");
1270 *handle = p->handle;
1273 vlib_pci_free_device_info (di);
1276 pci_log_err (vm, p, "%U", format_clib_error, err);
1277 clib_memset (p, 0, sizeof (linux_pci_device_t));
1278 pool_put (lpm->linux_pci_devices, p);
1285 vlib_pci_device_close (vlib_main_t * vm, vlib_pci_dev_handle_t h)
1287 linux_pci_main_t *lpm = &linux_pci_main;
1288 linux_pci_device_t *p = linux_pci_get_device (h);
1289 linux_pci_irq_t *irq;
1290 linux_pci_region_t *res;
1291 clib_error_t *err = 0;
1293 if (p->type == LINUX_PCI_DEVICE_TYPE_UIO)
1296 if (irq->clib_file_index != -1)
1297 clib_file_del_by_index (&file_main, irq->clib_file_index);
1298 close (p->config_fd);
1302 else if (p->type == LINUX_PCI_DEVICE_TYPE_VFIO)
1305 /* close INTx irqs */
1308 err = vfio_set_irqs (vm, p, VFIO_PCI_INTX_IRQ_INDEX, 0, 0,
1309 VFIO_IRQ_SET_ACTION_TRIGGER, 0);
1310 clib_error_free (err);
1311 if (irq->clib_file_index != -1)
1312 clib_file_del_by_index (&file_main, irq->clib_file_index);
1316 /* close MSI-X irqs */
1317 if (vec_len (p->msix_irqs))
1319 err = vfio_set_irqs (vm, p, VFIO_PCI_MSIX_IRQ_INDEX, 0, 0,
1320 VFIO_IRQ_SET_ACTION_TRIGGER, 0);
1321 clib_error_free (err);
1323 vec_foreach (irq, p->msix_irqs)
1327 clib_file_del_by_index (&file_main, irq->clib_file_index);
1331 vec_free (p->msix_irqs);
1336 vec_foreach (res, p->regions)
1340 munmap (res->addr, res->size);
1345 vec_free (p->regions);
1348 clib_memset (p, 0, sizeof (linux_pci_device_t));
1349 pool_put (lpm->linux_pci_devices, p);
1353 init_device_from_registered (vlib_main_t * vm, vlib_pci_device_info_t * di)
1355 vlib_pci_main_t *pm = &pci_main;
1356 linux_pci_main_t *lpm = &linux_pci_main;
1357 pci_device_registration_t *r;
1359 clib_error_t *err = 0;
1360 linux_pci_device_t *p;
1362 pool_get (lpm->linux_pci_devices, p);
1363 p->handle = p - lpm->linux_pci_devices;
1364 p->intx_irq.fd = -1;
1366 r = pm->pci_device_registrations;
1370 for (i = r->supported_devices; i->vendor_id != 0; i++)
1371 if (i->vendor_id == di->vendor_id && i->device_id == di->device_id)
1373 if (di->iommu_group != -1)
1374 err = add_device_vfio (vm, p, di, r);
1376 err = add_device_uio (vm, p, di, r);
1379 clib_error_report (err);
1383 r = r->next_registration;
1386 /* No driver, close the PCI config-space FD */
1387 clib_memset (p, 0, sizeof (linux_pci_device_t));
1388 pool_put (lpm->linux_pci_devices, p);
1391 static clib_error_t *
1392 scan_pci_addr (void *arg, u8 * dev_dir_name, u8 * ignored)
1394 vlib_pci_addr_t addr, **addrv = arg;
1395 unformat_input_t input;
1396 clib_error_t *err = 0;
1398 unformat_init_string (&input, (char *) dev_dir_name,
1399 vec_len (dev_dir_name));
1401 if (!unformat (&input, "/sys/bus/pci/devices/%U",
1402 unformat_vlib_pci_addr, &addr))
1403 err = clib_error_return (0, "unformat error `%v`", dev_dir_name);
1405 unformat_free (&input);
1410 vec_add1 (*addrv, addr);
1415 pci_addr_cmp (void *v1, void *v2)
1417 vlib_pci_addr_t *a1 = v1;
1418 vlib_pci_addr_t *a2 = v2;
1420 if (a1->domain > a2->domain)
1422 if (a1->domain < a2->domain)
1424 if (a1->bus > a2->bus)
1426 if (a1->bus < a2->bus)
1428 if (a1->slot > a2->slot)
1430 if (a1->slot < a2->slot)
1432 if (a1->function > a2->function)
1434 if (a1->function < a2->function)
1440 vlib_pci_get_all_dev_addrs ()
1442 vlib_pci_addr_t *addrs = 0;
1444 err = foreach_directory_file ((char *) sysfs_pci_dev_path, scan_pci_addr,
1445 &addrs, /* scan_dirs */ 0);
1452 vec_sort_with_function (addrs, pci_addr_cmp);
1458 linux_pci_init (vlib_main_t * vm)
1460 vlib_pci_main_t *pm = &pci_main;
1461 vlib_pci_addr_t *addr = 0, *addrs;
1465 ASSERT (sizeof (vlib_pci_addr_t) == sizeof (u32));
1467 addrs = vlib_pci_get_all_dev_addrs ();
1469 vec_foreach (addr, addrs)
1471 vlib_pci_device_info_t *d;
1472 if ((d = vlib_pci_get_device_info (vm, addr, 0)))
1474 init_device_from_registered (vm, d);
1475 vlib_pci_free_device_info (d);
1484 VLIB_INIT_FUNCTION (linux_pci_init) =
1486 .runs_after = VLIB_INITS("unix_input_init"),
1491 * fd.io coding-style-patch-verification: ON
1494 * eval: (c-set-style "gnu")