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);
295 di->iommu_group = -1;
296 if (lvm->container_fd != -1)
299 vec_reset_length (f);
300 f = format (f, "%v/iommu_group%c", dev_dir_name, 0);
301 tmpstr = clib_sysfs_link_to_name ((char *) f);
304 di->iommu_group = atoi ((char *) tmpstr);
307 vec_reset_length (f);
308 f = format (f, "%v/iommu_group/name%c", dev_dir_name, 0);
309 err = clib_sysfs_read ((char *) f, "%s", &tmpstr);
312 if (strncmp ((char *) tmpstr, "vfio-noiommu", 12) == 0)
313 di->flags |= VLIB_PCI_DEVICE_INFO_F_NOIOMMU;
317 clib_error_free (err);
322 vec_reset_length (f);
323 f = format (f, "%v/vpd%c", dev_dir_name, 0);
324 fd = open ((char *) f, O_RDONLY);
333 if (read (fd, &tag, 3) != 3)
336 if (tag[0] != 0x82 && tag[0] != 0x90 && tag[0] != 0x91)
339 len = (tag[2] << 8) | tag[1];
340 vec_validate (data, len);
342 if (read (fd, data, len) != len)
348 di->product_name = data;
349 else if (tag[0] == 0x90)
351 else if (tag[0] == 0x91)
362 vlib_pci_free_device_info (di);
367 vec_free (dev_dir_name);
371 clib_error_free (err);
376 directory_exists (char *path)
378 struct stat s = { 0 };
379 if (stat (path, &s) == -1)
382 return S_ISDIR (s.st_mode);
386 vlib_pci_bind_to_uio (vlib_main_t * vm, vlib_pci_addr_t * addr,
389 clib_error_t *error = 0;
390 u8 *s = 0, *driver_name = 0;
393 vlib_pci_device_info_t *di;
394 int fd, clear_driver_override = 0;
395 u8 *dev_dir_name = format (0, "%s/%U", sysfs_pci_dev_path,
396 format_vlib_pci_addr, addr);
398 di = vlib_pci_get_device_info (vm, addr, &error);
403 if (strncmp ("auto", uio_drv_name, 5) == 0)
405 int vfio_pci_loaded = 0;
407 if (directory_exists ("/sys/module/vfio_pci"))
410 if (di->iommu_group != -1)
412 /* device is bound to IOMMU group */
413 if (!vfio_pci_loaded)
415 error = clib_error_return (0, "Skipping PCI device %U: device "
416 "is bound to IOMMU group and "
417 "vfio-pci driver is not loaded",
418 format_vlib_pci_addr, addr);
422 uio_drv_name = "vfio-pci";
426 /* device is not bound to IOMMU group so we have multiple options */
427 if (vfio_pci_loaded &&
428 (error = clib_sysfs_write (sysfs_mod_vfio_noiommu, "Y")) == 0)
429 uio_drv_name = "vfio-pci";
430 else if (directory_exists ("/sys/module/uio_pci_generic"))
431 uio_drv_name = "uio_pci_generic";
432 else if (directory_exists ("/sys/module/igb_uio"))
433 uio_drv_name = "igb_uio";
436 clib_error_free (error);
437 error = clib_error_return (0, "Skipping PCI device %U: missing "
438 "kernel VFIO or UIO driver",
439 format_vlib_pci_addr, addr);
442 clib_error_free (error);
446 s = format (s, "%v/driver%c", dev_dir_name, 0);
447 driver_name = clib_sysfs_link_to_name ((char *) s);
448 vec_reset_length (s);
451 ((strcmp ("vfio-pci", (char *) driver_name) == 0) ||
452 (strcmp ("uio_pci_generic", (char *) driver_name) == 0) ||
453 (strcmp ("igb_uio", (char *) driver_name) == 0)))
456 /* walk trough all linux interfaces and if interface belonging to
457 this device is founf check if interface is admin up */
458 dir = opendir ("/sys/class/net");
459 s = format (s, "%U%c", format_vlib_pci_addr, addr, 0);
463 error = clib_error_return (0, "Skipping PCI device %U: failed to "
464 "read /sys/class/net",
465 format_vlib_pci_addr, addr);
469 fd = socket (PF_INET, SOCK_DGRAM, 0);
472 error = clib_error_return_unix (0, "socket");
476 while ((e = readdir (dir)))
479 struct ethtool_drvinfo drvinfo;
481 if (e->d_name[0] == '.') /* skip . and .. */
484 clib_memset (&ifr, 0, sizeof ifr);
485 clib_memset (&drvinfo, 0, sizeof drvinfo);
486 ifr.ifr_data = (char *) &drvinfo;
487 clib_strncpy (ifr.ifr_name, e->d_name, sizeof (ifr.ifr_name) - 1);
489 drvinfo.cmd = ETHTOOL_GDRVINFO;
490 if (ioctl (fd, SIOCETHTOOL, &ifr) < 0)
492 /* Some interfaces (eg "lo") don't support this ioctl */
493 if ((errno != ENOTSUP) && (errno != ENODEV))
494 clib_unix_warning ("ioctl fetch intf %s bus info error",
499 if (strcmp ((char *) s, drvinfo.bus_info))
502 clib_memset (&ifr, 0, sizeof (ifr));
503 clib_strncpy (ifr.ifr_name, e->d_name, sizeof (ifr.ifr_name) - 1);
505 if (ioctl (fd, SIOCGIFFLAGS, &ifr) < 0)
507 error = clib_error_return_unix (0, "ioctl fetch intf %s flags",
513 if (ifr.ifr_flags & IFF_UP)
515 error = clib_error_return (0, "Skipping PCI device %U as host "
516 "interface %s is up",
517 format_vlib_pci_addr, addr, e->d_name);
524 vec_reset_length (s);
526 s = format (s, "%v/driver/unbind%c", dev_dir_name, 0);
527 clib_sysfs_write ((char *) s, "%U", format_vlib_pci_addr, addr);
528 vec_reset_length (s);
530 s = format (s, "%v/driver_override%c", dev_dir_name, 0);
531 if (access ((char *) s, F_OK) == 0)
533 clib_sysfs_write ((char *) s, "%s", uio_drv_name);
534 clear_driver_override = 1;
538 vec_reset_length (s);
539 s = format (s, "%s/%s/new_id%c", sysfs_pci_drv_path, uio_drv_name, 0);
540 clib_sysfs_write ((char *) s, "0x%04x 0x%04x", di->vendor_id,
543 vec_reset_length (s);
545 s = format (s, "%s/%s/bind%c", sysfs_pci_drv_path, uio_drv_name, 0);
546 clib_sysfs_write ((char *) s, "%U", format_vlib_pci_addr, addr);
547 vec_reset_length (s);
549 if (clear_driver_override)
551 s = format (s, "%v/driver_override%c", dev_dir_name, 0);
552 clib_sysfs_write ((char *) s, "%c", 0);
553 vec_reset_length (s);
559 vec_free (dev_dir_name);
560 vec_free (driver_name);
565 static clib_error_t *
566 scan_uio_dir (void *arg, u8 * path_name, u8 * file_name)
568 linux_pci_device_t *l = arg;
569 unformat_input_t input;
571 unformat_init_string (&input, (char *) file_name, vec_len (file_name));
573 if (!unformat (&input, "uio%d", &l->uio_minor))
576 unformat_free (&input);
580 static clib_error_t *
581 vfio_set_irqs (vlib_main_t * vm, linux_pci_device_t * p, u32 index, u32 start,
582 u32 count, u32 flags, int *efds)
584 int data_len = efds ? count * sizeof (int) : 0;
585 u8 buf[sizeof (struct vfio_irq_set) + data_len];
586 struct vfio_irq_info ii = { 0 };
587 struct vfio_irq_set *irq_set = (struct vfio_irq_set *) buf;
590 ii.argsz = sizeof (struct vfio_irq_info);
593 if (ioctl (p->fd, VFIO_DEVICE_GET_IRQ_INFO, &ii) < 0)
594 return clib_error_return_unix (0, "ioctl(VFIO_DEVICE_GET_IRQ_INFO) "
595 "'%U'", format_vlib_pci_addr, &p->addr);
597 pci_log_debug (vm, p, "%s index:%u count:%u flags: %s%s%s%s(0x%x)",
598 __func__, ii.index, ii.count,
599 ii.flags & VFIO_IRQ_INFO_EVENTFD ? "eventfd " : "",
600 ii.flags & VFIO_IRQ_INFO_MASKABLE ? "maskable " : "",
601 ii.flags & VFIO_IRQ_INFO_AUTOMASKED ? "automasked " : "",
602 ii.flags & VFIO_IRQ_INFO_NORESIZE ? "noresize " : "",
605 if (ii.count < start + count)
606 return clib_error_return_unix (0, "vfio_set_irq: unexistng interrupt on "
607 "'%U'", format_vlib_pci_addr, &p->addr);
612 flags |= VFIO_IRQ_SET_DATA_EVENTFD;
613 clib_memcpy_fast (&irq_set->data, efds, data_len);
616 flags |= VFIO_IRQ_SET_DATA_NONE;
618 ASSERT ((flags & (VFIO_IRQ_SET_DATA_NONE | VFIO_IRQ_SET_DATA_EVENTFD)) !=
619 (VFIO_IRQ_SET_DATA_NONE | VFIO_IRQ_SET_DATA_EVENTFD));
621 irq_set->argsz = sizeof (struct vfio_irq_set) + data_len;
622 irq_set->index = index;
623 irq_set->start = start;
624 irq_set->count = count;
625 irq_set->flags = flags;
627 if (ioctl (p->fd, VFIO_DEVICE_SET_IRQS, irq_set) < 0)
628 return clib_error_return_unix (0, "%U:ioctl(VFIO_DEVICE_SET_IRQS) "
629 "[index = %u, start = %u, count = %u, "
631 format_vlib_pci_addr, &p->addr,
632 index, start, count, flags);
636 static clib_error_t *
637 linux_pci_uio_read_ready (clib_file_t * uf)
639 vlib_main_t *vm = vlib_get_main ();
640 int __attribute__ ((unused)) rv;
641 vlib_pci_dev_handle_t h = uf->private_data;
642 linux_pci_device_t *p = linux_pci_get_device (h);
643 linux_pci_irq_t *irq = &p->intx_irq;
646 rv = read (uf->file_descriptor, &icount, 4);
648 if (irq->intx_handler)
649 irq->intx_handler (vm, h);
651 vlib_pci_intr_enable (vm, h);
653 return /* no error */ 0;
656 static clib_error_t *
657 linux_pci_vfio_unmask_intx (vlib_main_t * vm, linux_pci_device_t * d)
659 return vfio_set_irqs (vm, d, VFIO_PCI_INTX_IRQ_INDEX, 0, 1,
660 VFIO_IRQ_SET_ACTION_UNMASK, 0);
663 static clib_error_t *
664 linux_pci_uio_error_ready (clib_file_t * uf)
666 u32 error_index = (u32) uf->private_data;
668 return clib_error_return (0, "pci device %d: error", error_index);
671 static clib_error_t *
672 linux_pci_vfio_msix_read_ready (clib_file_t * uf)
674 vlib_main_t *vm = vlib_get_main ();
675 int __attribute__ ((unused)) rv;
676 vlib_pci_dev_handle_t h = uf->private_data >> 16;
677 u16 line = uf->private_data & 0xffff;
678 linux_pci_device_t *p = linux_pci_get_device (h);
679 linux_pci_irq_t *irq = vec_elt_at_index (p->msix_irqs, line);
682 rv = read (uf->file_descriptor, &icount, sizeof (icount));
684 if (irq->msix_handler)
685 irq->msix_handler (vm, h, line);
687 return /* no error */ 0;
690 static clib_error_t *
691 linux_pci_vfio_intx_read_ready (clib_file_t * uf)
693 vlib_main_t *vm = vlib_get_main ();
694 int __attribute__ ((unused)) rv;
695 vlib_pci_dev_handle_t h = uf->private_data;
696 linux_pci_device_t *p = linux_pci_get_device (h);
697 linux_pci_irq_t *irq = &p->intx_irq;
700 rv = read (uf->file_descriptor, &icount, sizeof (icount));
702 if (irq->intx_handler)
703 irq->intx_handler (vm, h);
705 linux_pci_vfio_unmask_intx (vm, p);
707 return /* no error */ 0;
710 static clib_error_t *
711 linux_pci_vfio_error_ready (clib_file_t * uf)
713 u32 error_index = (u32) uf->private_data;
715 return clib_error_return (0, "pci device %d: error", error_index);
718 static clib_error_t *
719 add_device_uio (vlib_main_t * vm, linux_pci_device_t * p,
720 vlib_pci_device_info_t * di, pci_device_registration_t * r)
722 linux_pci_main_t *lpm = &linux_pci_main;
723 clib_error_t *err = 0;
727 p->type = LINUX_PCI_DEVICE_TYPE_UIO;
729 s = format (s, "%s/%U/config%c", sysfs_pci_dev_path,
730 format_vlib_pci_addr, &di->addr, 0);
732 p->config_fd = open ((char *) s, O_RDWR);
733 p->config_offset = 0;
734 vec_reset_length (s);
736 if (p->config_fd == -1)
738 err = clib_error_return_unix (0, "open '%s'", s);
742 s = format (0, "%s/%U/uio", sysfs_pci_dev_path,
743 format_vlib_pci_addr, &di->addr);
744 foreach_directory_file ((char *) s, scan_uio_dir, p, /* scan_dirs */
746 vec_reset_length (s);
748 s = format (s, "/dev/uio%d%c", p->uio_minor, 0);
749 p->fd = open ((char *) s, O_RDWR);
752 err = clib_error_return_unix (0, "open '%s'", s);
756 if (r && r->interrupt_handler)
757 vlib_pci_register_intx_handler (vm, p->handle, r->interrupt_handler);
759 if (r && r->init_function)
760 err = r->init_function (lpm->vlib_main, p->handle);
766 if (p->config_fd != -1)
767 close (p->config_fd);
775 vlib_pci_register_intx_handler (vlib_main_t * vm, vlib_pci_dev_handle_t h,
776 pci_intx_handler_function_t * intx_handler)
778 linux_pci_device_t *p = linux_pci_get_device (h);
779 clib_file_t t = { 0 };
780 linux_pci_irq_t *irq = &p->intx_irq;
781 ASSERT (irq->fd == -1);
783 if (p->type == LINUX_PCI_DEVICE_TYPE_VFIO)
785 struct vfio_irq_info ii = { 0 };
786 ii.argsz = sizeof (struct vfio_irq_info);
787 ii.index = VFIO_PCI_INTX_IRQ_INDEX;
788 if (ioctl (p->fd, VFIO_DEVICE_GET_IRQ_INFO, &ii) < 0)
789 return clib_error_return_unix (0, "ioctl(VFIO_DEVICE_GET_IRQ_INFO) '"
790 "%U'", format_vlib_pci_addr, &p->addr);
791 pci_log_debug (vm, p, "%s index:%u count:%u flags: %s%s%s%s(0x%x)",
792 __func__, ii.index, ii.count,
793 ii.flags & VFIO_IRQ_INFO_EVENTFD ? "eventfd " : "",
794 ii.flags & VFIO_IRQ_INFO_MASKABLE ? "maskable " : "",
795 ii.flags & VFIO_IRQ_INFO_AUTOMASKED ? "automasked " : "",
796 ii.flags & VFIO_IRQ_INFO_NORESIZE ? "noresize " : "",
799 return clib_error_return (0, "INTx interrupt does not exist on device"
800 "'%U'", format_vlib_pci_addr, &p->addr);
802 irq->fd = eventfd (0, EFD_NONBLOCK);
804 return clib_error_return_unix (0, "eventfd");
806 t.file_descriptor = irq->fd;
807 t.read_function = linux_pci_vfio_intx_read_ready;
809 else if (p->type == LINUX_PCI_DEVICE_TYPE_UIO)
811 t.file_descriptor = p->fd;
812 t.read_function = linux_pci_uio_read_ready;
817 t.error_function = linux_pci_uio_error_ready;
818 t.private_data = p->handle;
819 t.description = format (0, "PCI %U INTx", format_vlib_pci_addr, &p->addr);
820 irq->clib_file_index = clib_file_add (&file_main, &t);
821 irq->intx_handler = intx_handler;
826 vlib_pci_register_msix_handler (vlib_main_t * vm, vlib_pci_dev_handle_t h,
827 u32 start, u32 count,
828 pci_msix_handler_function_t * msix_handler)
830 clib_error_t *err = 0;
831 linux_pci_device_t *p = linux_pci_get_device (h);
834 if (p->type != LINUX_PCI_DEVICE_TYPE_VFIO)
835 return clib_error_return (0, "vfio driver is needed for MSI-X interrupt "
839 vec_validate_init_empty (p->msix_irqs, start + count - 1, (linux_pci_irq_t)
843 for (i = start; i < start + count; i++)
845 clib_file_t t = { 0 };
846 linux_pci_irq_t *irq = vec_elt_at_index (p->msix_irqs, i);
847 ASSERT (irq->fd == -1);
849 irq->fd = eventfd (0, EFD_NONBLOCK);
852 err = clib_error_return_unix (0, "eventfd");
856 t.read_function = linux_pci_vfio_msix_read_ready;
857 t.file_descriptor = irq->fd;
858 t.error_function = linux_pci_vfio_error_ready;
859 t.private_data = p->handle << 16 | i;
860 t.description = format (0, "PCI %U MSI-X #%u", format_vlib_pci_addr,
862 irq->clib_file_index = clib_file_add (&file_main, &t);
863 irq->msix_handler = msix_handler;
871 linux_pci_irq_t *irq = vec_elt_at_index (p->msix_irqs, i);
874 clib_file_del_by_index (&file_main, irq->clib_file_index);
883 vlib_pci_enable_msix_irq (vlib_main_t * vm, vlib_pci_dev_handle_t h,
884 u16 start, u16 count)
886 linux_pci_device_t *p = linux_pci_get_device (h);
890 if (p->type != LINUX_PCI_DEVICE_TYPE_VFIO)
891 return clib_error_return (0, "vfio driver is needed for MSI-X interrupt "
894 for (i = start; i < start + count; i++)
896 linux_pci_irq_t *irq = vec_elt_at_index (p->msix_irqs, i);
900 return vfio_set_irqs (vm, p, VFIO_PCI_MSIX_IRQ_INDEX, start, count,
901 VFIO_IRQ_SET_ACTION_TRIGGER, fds);
905 vlib_pci_disable_msix_irq (vlib_main_t * vm, vlib_pci_dev_handle_t h,
906 u16 start, u16 count)
908 linux_pci_device_t *p = linux_pci_get_device (h);
911 if (p->type != LINUX_PCI_DEVICE_TYPE_VFIO)
912 return clib_error_return (0, "vfio driver is needed for MSI-X interrupt "
915 for (i = start; i < start + count; i++)
918 return vfio_set_irqs (vm, p, VFIO_PCI_MSIX_IRQ_INDEX, start, count,
919 VFIO_IRQ_SET_ACTION_TRIGGER, fds);
922 static clib_error_t *
923 add_device_vfio (vlib_main_t * vm, linux_pci_device_t * p,
924 vlib_pci_device_info_t * di, pci_device_registration_t * r)
926 linux_pci_main_t *lpm = &linux_pci_main;
927 struct vfio_device_info device_info = { 0 };
928 struct vfio_region_info reg = { 0 };
929 clib_error_t *err = 0;
933 p->type = LINUX_PCI_DEVICE_TYPE_VFIO;
935 if ((err = linux_vfio_group_get_device_fd (&p->addr, &p->fd, &is_noiommu)))
939 p->supports_va_dma = 1;
941 device_info.argsz = sizeof (device_info);
942 if (ioctl (p->fd, VFIO_DEVICE_GET_INFO, &device_info) < 0)
944 err = clib_error_return_unix (0, "ioctl(VFIO_DEVICE_GET_INFO) '%U'",
945 format_vlib_pci_addr, &di->addr);
949 reg.argsz = sizeof (struct vfio_region_info);
950 reg.index = VFIO_PCI_CONFIG_REGION_INDEX;
951 if (ioctl (p->fd, VFIO_DEVICE_GET_REGION_INFO, ®) < 0)
953 err = clib_error_return_unix (0, "ioctl(VFIO_DEVICE_GET_INFO) '%U'",
954 format_vlib_pci_addr, &di->addr);
958 pci_log_debug (vm, p, "%s region_info index:%u size:0x%lx offset:0x%lx "
959 "flags: %s%s%s(0x%x)", __func__,
960 reg.index, reg.size, reg.offset,
961 reg.flags & VFIO_REGION_INFO_FLAG_READ ? "rd " : "",
962 reg.flags & VFIO_REGION_INFO_FLAG_WRITE ? "wr " : "",
963 reg.flags & VFIO_REGION_INFO_FLAG_MMAP ? "mmap " : "",
966 p->config_offset = reg.offset;
967 p->config_fd = p->fd;
969 /* reset if device supports it */
970 if (device_info.flags & VFIO_DEVICE_FLAGS_RESET)
971 if (ioctl (p->fd, VFIO_DEVICE_RESET) < 0)
973 err = clib_error_return_unix (0, "ioctl(VFIO_DEVICE_RESET) '%U'",
974 format_vlib_pci_addr, &di->addr);
978 if (r && r->interrupt_handler)
980 vlib_pci_register_intx_handler (vm, p->handle, r->interrupt_handler);
981 linux_pci_vfio_unmask_intx (vm, p);
984 if (p->supports_va_dma)
986 vlib_buffer_pool_t *bp;
988 vec_foreach (bp, vm->buffer_main->buffer_pools)
991 vlib_physmem_map_t *pm;
992 pm = vlib_physmem_get_map (vm, bp->physmem_map_index);
993 for (i = 0; i < pm->n_pages; i++)
994 vfio_map_physmem_page (vm, pm->base + (i << pm->log2_page_size));
999 if (r && r->init_function)
1000 err = r->init_function (lpm->vlib_main, p->handle);
1008 if (p->config_fd != -1 && p->config_fd != p->fd)
1009 close (p->config_fd);
1010 p->config_fd = p->fd = -1;
1015 /* Configuration space read/write. */
1017 vlib_pci_read_write_config (vlib_main_t * vm, vlib_pci_dev_handle_t h,
1018 vlib_read_or_write_t read_or_write,
1019 uword address, void *data, u32 n_bytes)
1021 linux_pci_device_t *p = linux_pci_get_device (h);
1024 if (read_or_write == VLIB_READ)
1025 n = pread (p->config_fd, data, n_bytes, p->config_offset + address);
1027 n = pwrite (p->config_fd, data, n_bytes, p->config_offset + address);
1030 return clib_error_return_unix (0, "%s",
1031 read_or_write == VLIB_READ
1032 ? "read" : "write");
1037 static clib_error_t *
1038 vlib_pci_region (vlib_main_t * vm, vlib_pci_dev_handle_t h, u32 bar, int *fd,
1039 u64 * size, u64 * offset)
1041 linux_pci_device_t *p = linux_pci_get_device (h);
1042 clib_error_t *error = 0;
1044 u64 _size = 0, _offset = 0;
1050 if (p->type == LINUX_PCI_DEVICE_TYPE_UIO)
1053 struct stat stat_buf;
1054 file_name = format (0, "%s/%U/resource%d%c", sysfs_pci_dev_path,
1055 format_vlib_pci_addr, &p->addr, bar, 0);
1057 _fd = open ((char *) file_name, O_RDWR);
1060 error = clib_error_return_unix (0, "open `%s'", file_name);
1061 vec_free (file_name);
1065 if (fstat (_fd, &stat_buf) < 0)
1067 error = clib_error_return_unix (0, "fstat `%s'", file_name);
1068 vec_free (file_name);
1073 vec_free (file_name);
1074 _size = stat_buf.st_size;
1077 else if (p->type == LINUX_PCI_DEVICE_TYPE_VFIO)
1079 struct vfio_region_info reg = { 0 };
1080 reg.argsz = sizeof (struct vfio_region_info);
1082 if (ioctl (p->fd, VFIO_DEVICE_GET_REGION_INFO, ®) < 0)
1083 return clib_error_return_unix (0, "ioctl(VFIO_DEVICE_GET_INFO) "
1084 "'%U'", format_vlib_pci_addr,
1088 _offset = reg.offset;
1089 pci_log_debug (vm, p, "%s region_info index:%u size:0x%lx offset:0x%lx "
1090 "flags: %s%s%s(0x%x)", __func__,
1091 reg.index, reg.size, reg.offset,
1092 reg.flags & VFIO_REGION_INFO_FLAG_READ ? "rd " : "",
1093 reg.flags & VFIO_REGION_INFO_FLAG_WRITE ? "wr " : "",
1094 reg.flags & VFIO_REGION_INFO_FLAG_MMAP ? "mmap " : "",
1107 static clib_error_t *
1108 vlib_pci_map_region_int (vlib_main_t * vm, vlib_pci_dev_handle_t h,
1109 u32 bar, u8 * addr, void **result)
1111 linux_pci_device_t *p = linux_pci_get_device (h);
1113 clib_error_t *error;
1114 int flags = MAP_SHARED;
1115 u64 size = 0, offset = 0;
1117 pci_log_debug (vm, p, "map region %u to va %p", bar, addr);
1119 if ((error = vlib_pci_region (vm, h, bar, &fd, &size, &offset)))
1122 if (p->type == LINUX_PCI_DEVICE_TYPE_UIO && addr != 0)
1125 *result = mmap (addr, size, PROT_READ | PROT_WRITE, flags, fd, offset);
1126 if (*result == (void *) -1)
1128 error = clib_error_return_unix (0, "mmap `BAR%u'", bar);
1129 if (p->type == LINUX_PCI_DEVICE_TYPE_UIO)
1135 vec_validate_init_empty (p->regions, bar,
1136 (linux_pci_region_t) { .fd = -1});
1138 if (p->type == LINUX_PCI_DEVICE_TYPE_UIO)
1139 p->regions[bar].fd = fd;
1140 p->regions[bar].addr = *result;
1141 p->regions[bar].size = size;
1146 vlib_pci_map_region (vlib_main_t * vm, vlib_pci_dev_handle_t h, u32 resource,
1149 return (vlib_pci_map_region_int (vm, h, resource, 0 /* addr */ , result));
1153 vlib_pci_map_region_fixed (vlib_main_t * vm, vlib_pci_dev_handle_t h,
1154 u32 resource, u8 * addr, void **result)
1156 return (vlib_pci_map_region_int (vm, h, resource, addr, result));
1160 vlib_pci_io_region (vlib_main_t * vm, vlib_pci_dev_handle_t h, u32 resource)
1162 linux_pci_device_t *p = linux_pci_get_device (h);
1163 clib_error_t *error = 0;
1165 u64 size = 0, offset = 0;
1167 if ((error = vlib_pci_region (vm, h, resource, &fd, &size, &offset)))
1171 p->io_offset = offset;
1176 vlib_pci_read_write_io (vlib_main_t * vm, vlib_pci_dev_handle_t h,
1177 vlib_read_or_write_t read_or_write,
1178 uword offset, void *data, u32 length)
1180 linux_pci_device_t *p = linux_pci_get_device (h);
1183 if (read_or_write == VLIB_READ)
1184 n = pread (p->io_fd, data, length, p->io_offset + offset);
1186 n = pwrite (p->io_fd, data, length, p->io_offset + offset);
1189 return clib_error_return_unix (0, "%s",
1190 read_or_write == VLIB_READ
1191 ? "read" : "write");
1196 vlib_pci_map_dma (vlib_main_t * vm, vlib_pci_dev_handle_t h, void *ptr)
1198 linux_pci_device_t *p = linux_pci_get_device (h);
1200 if (!p->supports_va_dma)
1203 return vfio_map_physmem_page (vm, ptr);
1207 vlib_pci_supports_virtual_addr_dma (vlib_main_t * vm, vlib_pci_dev_handle_t h)
1209 linux_pci_device_t *p = linux_pci_get_device (h);
1211 return p->supports_va_dma != 0;
1215 vlib_pci_device_open (vlib_main_t * vm, vlib_pci_addr_t * addr,
1216 pci_device_id_t ids[], vlib_pci_dev_handle_t * handle)
1218 linux_pci_main_t *lpm = &linux_pci_main;
1219 vlib_pci_device_info_t *di;
1220 linux_pci_device_t *p;
1221 clib_error_t *err = 0;
1224 di = vlib_pci_get_device_info (vm, addr, &err);
1228 for (i = ids; i->vendor_id != 0; i++)
1229 if (i->vendor_id == di->vendor_id && i->device_id == di->device_id)
1232 if (i->vendor_id == 0)
1233 return clib_error_return (0, "Wrong vendor or device id");
1235 pool_get (lpm->linux_pci_devices, p);
1236 p->handle = p - lpm->linux_pci_devices;
1237 p->addr.as_u32 = di->addr.as_u32;
1238 p->intx_irq.fd = -1;
1239 p->intx_irq.clib_file_index = -1;
1240 p->numa_node = di->numa_node;
1242 * pci io bar read/write fd
1246 pci_log_debug (vm, p, "open vid:0x%04x did:0x%04x driver:%s iommu_group:%d",
1247 di->vendor_id, di->device_id, di->driver_name,
1250 if (strncmp ("vfio-pci", (char *) di->driver_name, 8) == 0)
1251 err = add_device_vfio (vm, p, di, 0);
1252 else if (strncmp ("uio_pci_generic", (char *) di->driver_name, 8) == 0)
1253 err = add_device_uio (vm, p, di, 0);
1255 err = clib_error_create ("device not bound to 'vfio-pci' or "
1256 "'uio_pci_generic' kernel module");
1260 *handle = p->handle;
1263 vlib_pci_free_device_info (di);
1266 pci_log_err (vm, p, "%U", format_clib_error, err);
1267 clib_memset (p, 0, sizeof (linux_pci_device_t));
1268 pool_put (lpm->linux_pci_devices, p);
1275 vlib_pci_device_close (vlib_main_t * vm, vlib_pci_dev_handle_t h)
1277 linux_pci_main_t *lpm = &linux_pci_main;
1278 linux_pci_device_t *p = linux_pci_get_device (h);
1279 linux_pci_irq_t *irq;
1280 linux_pci_region_t *res;
1281 clib_error_t *err = 0;
1283 if (p->type == LINUX_PCI_DEVICE_TYPE_UIO)
1286 if (irq->clib_file_index != -1)
1287 clib_file_del_by_index (&file_main, irq->clib_file_index);
1288 close (p->config_fd);
1292 else if (p->type == LINUX_PCI_DEVICE_TYPE_VFIO)
1295 /* close INTx irqs */
1298 err = vfio_set_irqs (vm, p, VFIO_PCI_INTX_IRQ_INDEX, 0, 0,
1299 VFIO_IRQ_SET_ACTION_TRIGGER, 0);
1300 clib_error_free (err);
1301 if (irq->clib_file_index != -1)
1302 clib_file_del_by_index (&file_main, irq->clib_file_index);
1306 /* close MSI-X irqs */
1307 if (vec_len (p->msix_irqs))
1309 err = vfio_set_irqs (vm, p, VFIO_PCI_MSIX_IRQ_INDEX, 0, 0,
1310 VFIO_IRQ_SET_ACTION_TRIGGER, 0);
1311 clib_error_free (err);
1313 vec_foreach (irq, p->msix_irqs)
1317 clib_file_del_by_index (&file_main, irq->clib_file_index);
1321 vec_free (p->msix_irqs);
1326 vec_foreach (res, p->regions)
1330 munmap (res->addr, res->size);
1335 vec_free (p->regions);
1338 clib_memset (p, 0, sizeof (linux_pci_device_t));
1339 pool_put (lpm->linux_pci_devices, p);
1343 init_device_from_registered (vlib_main_t * vm, vlib_pci_device_info_t * di)
1345 vlib_pci_main_t *pm = &pci_main;
1346 linux_pci_main_t *lpm = &linux_pci_main;
1347 pci_device_registration_t *r;
1349 clib_error_t *err = 0;
1350 linux_pci_device_t *p;
1352 pool_get (lpm->linux_pci_devices, p);
1353 p->handle = p - lpm->linux_pci_devices;
1354 p->intx_irq.fd = -1;
1356 r = pm->pci_device_registrations;
1360 for (i = r->supported_devices; i->vendor_id != 0; i++)
1361 if (i->vendor_id == di->vendor_id && i->device_id == di->device_id)
1363 if (di->iommu_group != -1)
1364 err = add_device_vfio (vm, p, di, r);
1366 err = add_device_uio (vm, p, di, r);
1369 clib_error_report (err);
1373 r = r->next_registration;
1376 /* No driver, close the PCI config-space FD */
1377 clib_memset (p, 0, sizeof (linux_pci_device_t));
1378 pool_put (lpm->linux_pci_devices, p);
1381 static clib_error_t *
1382 scan_pci_addr (void *arg, u8 * dev_dir_name, u8 * ignored)
1384 vlib_pci_addr_t addr, **addrv = arg;
1385 unformat_input_t input;
1386 clib_error_t *err = 0;
1388 unformat_init_string (&input, (char *) dev_dir_name,
1389 vec_len (dev_dir_name));
1391 if (!unformat (&input, "/sys/bus/pci/devices/%U",
1392 unformat_vlib_pci_addr, &addr))
1393 err = clib_error_return (0, "unformat error `%v`", dev_dir_name);
1395 unformat_free (&input);
1400 vec_add1 (*addrv, addr);
1405 pci_addr_cmp (void *v1, void *v2)
1407 vlib_pci_addr_t *a1 = v1;
1408 vlib_pci_addr_t *a2 = v2;
1410 if (a1->domain > a2->domain)
1412 if (a1->domain < a2->domain)
1414 if (a1->bus > a2->bus)
1416 if (a1->bus < a2->bus)
1418 if (a1->slot > a2->slot)
1420 if (a1->slot < a2->slot)
1422 if (a1->function > a2->function)
1424 if (a1->function < a2->function)
1430 vlib_pci_get_all_dev_addrs ()
1432 vlib_pci_addr_t *addrs = 0;
1434 err = foreach_directory_file ((char *) sysfs_pci_dev_path, scan_pci_addr,
1435 &addrs, /* scan_dirs */ 0);
1442 vec_sort_with_function (addrs, pci_addr_cmp);
1448 linux_pci_init (vlib_main_t * vm)
1450 vlib_pci_main_t *pm = &pci_main;
1451 vlib_pci_addr_t *addr = 0, *addrs;
1452 clib_error_t *error;
1456 if ((error = vlib_call_init_function (vm, unix_input_init)))
1459 ASSERT (sizeof (vlib_pci_addr_t) == sizeof (u32));
1461 addrs = vlib_pci_get_all_dev_addrs ();
1463 vec_foreach (addr, addrs)
1465 vlib_pci_device_info_t *d;
1466 if ((d = vlib_pci_get_device_info (vm, addr, 0)))
1468 init_device_from_registered (vm, d);
1469 vlib_pci_free_device_info (d);
1477 VLIB_INIT_FUNCTION (linux_pci_init);
1480 * fd.io coding-style-patch-verification: ON
1483 * eval: (c-set-style "gnu")