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;
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 vec_reset_length (f);
299 f = format (f, "%v/iommu_group%c", dev_dir_name, 0);
300 tmpstr = clib_sysfs_link_to_name ((char *) f);
303 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);
321 vec_reset_length (f);
322 f = format (f, "%v/vpd%c", dev_dir_name, 0);
323 fd = open ((char *) f, O_RDONLY);
332 if (read (fd, &tag, 3) != 3)
335 if (tag[0] != 0x82 && tag[0] != 0x90 && tag[0] != 0x91)
338 len = (tag[2] << 8) | tag[1];
339 vec_validate (data, len);
341 if (read (fd, data, len) != len)
347 di->product_name = data;
348 else if (tag[0] == 0x90)
350 else if (tag[0] == 0x91)
361 vlib_pci_free_device_info (di);
366 vec_free (dev_dir_name);
370 clib_error_free (err);
375 directory_exists (char *path)
377 struct stat s = { 0 };
378 if (stat (path, &s) == -1)
381 return S_ISDIR (s.st_mode);
385 vlib_pci_bind_to_uio (vlib_main_t * vm, vlib_pci_addr_t * addr,
388 clib_error_t *error = 0;
389 u8 *s = 0, *driver_name = 0;
392 vlib_pci_device_info_t *di;
393 int fd, clear_driver_override = 0;
394 u8 *dev_dir_name = format (0, "%s/%U", sysfs_pci_dev_path,
395 format_vlib_pci_addr, addr);
397 di = vlib_pci_get_device_info (vm, addr, &error);
402 if (strncmp ("auto", uio_drv_name, 5) == 0)
404 int vfio_pci_loaded = 0;
406 if (directory_exists ("/sys/module/vfio_pci"))
409 if (di->iommu_group != -1)
411 /* device is bound to IOMMU group */
412 if (!vfio_pci_loaded)
414 error = clib_error_return (0, "Skipping PCI device %U: device "
415 "is bound to IOMMU group and "
416 "vfio-pci driver is not loaded",
417 format_vlib_pci_addr, addr);
421 uio_drv_name = "vfio-pci";
425 /* device is not bound to IOMMU group so we have multiple options */
426 if (vfio_pci_loaded &&
427 (error = clib_sysfs_write (sysfs_mod_vfio_noiommu, "Y")) == 0)
428 uio_drv_name = "vfio-pci";
429 else if (directory_exists ("/sys/module/uio_pci_generic"))
430 uio_drv_name = "uio_pci_generic";
431 else if (directory_exists ("/sys/module/igb_uio"))
432 uio_drv_name = "igb_uio";
435 clib_error_free (error);
436 error = clib_error_return (0, "Skipping PCI device %U: missing "
437 "kernel VFIO or UIO driver",
438 format_vlib_pci_addr, addr);
441 clib_error_free (error);
445 s = format (s, "%v/driver%c", dev_dir_name, 0);
446 driver_name = clib_sysfs_link_to_name ((char *) s);
447 vec_reset_length (s);
450 ((strcmp ("vfio-pci", (char *) driver_name) == 0) ||
451 (strcmp ("uio_pci_generic", (char *) driver_name) == 0) ||
452 (strcmp ("igb_uio", (char *) driver_name) == 0)))
455 /* walk trough all linux interfaces and if interface belonging to
456 this device is founf check if interface is admin up */
457 dir = opendir ("/sys/class/net");
458 s = format (s, "%U%c", format_vlib_pci_addr, addr, 0);
462 error = clib_error_return (0, "Skipping PCI device %U: failed to "
463 "read /sys/class/net",
464 format_vlib_pci_addr, addr);
468 fd = socket (PF_INET, SOCK_DGRAM, 0);
471 error = clib_error_return_unix (0, "socket");
475 while ((e = readdir (dir)))
478 struct ethtool_drvinfo drvinfo;
480 if (e->d_name[0] == '.') /* skip . and .. */
483 clib_memset (&ifr, 0, sizeof ifr);
484 clib_memset (&drvinfo, 0, sizeof drvinfo);
485 ifr.ifr_data = (char *) &drvinfo;
486 clib_strncpy (ifr.ifr_name, e->d_name, sizeof (ifr.ifr_name) - 1);
488 drvinfo.cmd = ETHTOOL_GDRVINFO;
489 if (ioctl (fd, SIOCETHTOOL, &ifr) < 0)
491 /* Some interfaces (eg "lo") don't support this ioctl */
492 if ((errno != ENOTSUP) && (errno != ENODEV))
493 clib_unix_warning ("ioctl fetch intf %s bus info error",
498 if (strcmp ((char *) s, drvinfo.bus_info))
501 clib_memset (&ifr, 0, sizeof (ifr));
502 clib_strncpy (ifr.ifr_name, e->d_name, sizeof (ifr.ifr_name) - 1);
504 if (ioctl (fd, SIOCGIFFLAGS, &ifr) < 0)
506 error = clib_error_return_unix (0, "ioctl fetch intf %s flags",
512 if (ifr.ifr_flags & IFF_UP)
514 error = clib_error_return (0, "Skipping PCI device %U as host "
515 "interface %s is up",
516 format_vlib_pci_addr, addr, e->d_name);
523 vec_reset_length (s);
525 s = format (s, "%v/driver/unbind%c", dev_dir_name, 0);
526 clib_sysfs_write ((char *) s, "%U", format_vlib_pci_addr, addr);
527 vec_reset_length (s);
529 s = format (s, "%v/driver_override%c", dev_dir_name, 0);
530 if (access ((char *) s, F_OK) == 0)
532 clib_sysfs_write ((char *) s, "%s", uio_drv_name);
533 clear_driver_override = 1;
537 vec_reset_length (s);
538 s = format (s, "%s/%s/new_id%c", sysfs_pci_drv_path, uio_drv_name, 0);
539 clib_sysfs_write ((char *) s, "0x%04x 0x%04x", di->vendor_id,
542 vec_reset_length (s);
544 s = format (s, "%s/%s/bind%c", sysfs_pci_drv_path, uio_drv_name, 0);
545 clib_sysfs_write ((char *) s, "%U", format_vlib_pci_addr, addr);
546 vec_reset_length (s);
548 if (clear_driver_override)
550 s = format (s, "%v/driver_override%c", dev_dir_name, 0);
551 clib_sysfs_write ((char *) s, "%c", 0);
552 vec_reset_length (s);
558 vec_free (dev_dir_name);
559 vec_free (driver_name);
564 static clib_error_t *
565 scan_uio_dir (void *arg, u8 * path_name, u8 * file_name)
567 linux_pci_device_t *l = arg;
568 unformat_input_t input;
570 unformat_init_string (&input, (char *) file_name, vec_len (file_name));
572 if (!unformat (&input, "uio%d", &l->uio_minor))
575 unformat_free (&input);
579 static clib_error_t *
580 vfio_set_irqs (vlib_main_t * vm, linux_pci_device_t * p, u32 index, u32 start,
581 u32 count, u32 flags, int *efds)
583 int data_len = efds ? count * sizeof (int) : 0;
584 u8 buf[sizeof (struct vfio_irq_set) + data_len];
585 struct vfio_irq_info ii = { 0 };
586 struct vfio_irq_set *irq_set = (struct vfio_irq_set *) buf;
589 ii.argsz = sizeof (struct vfio_irq_info);
592 if (ioctl (p->fd, VFIO_DEVICE_GET_IRQ_INFO, &ii) < 0)
593 return clib_error_return_unix (0, "ioctl(VFIO_DEVICE_GET_IRQ_INFO) "
594 "'%U'", format_vlib_pci_addr, &p->addr);
596 pci_log_debug (vm, p, "%s index:%u count:%u flags: %s%s%s%s(0x%x)",
597 __func__, ii.index, ii.count,
598 ii.flags & VFIO_IRQ_INFO_EVENTFD ? "eventfd " : "",
599 ii.flags & VFIO_IRQ_INFO_MASKABLE ? "maskable " : "",
600 ii.flags & VFIO_IRQ_INFO_AUTOMASKED ? "automasked " : "",
601 ii.flags & VFIO_IRQ_INFO_NORESIZE ? "noresize " : "",
604 if (ii.count < start + count)
605 return clib_error_return_unix (0, "vfio_set_irq: unexistng interrupt on "
606 "'%U'", format_vlib_pci_addr, &p->addr);
611 flags |= VFIO_IRQ_SET_DATA_EVENTFD;
612 clib_memcpy_fast (&irq_set->data, efds, data_len);
615 flags |= VFIO_IRQ_SET_DATA_NONE;
617 ASSERT ((flags & (VFIO_IRQ_SET_DATA_NONE | VFIO_IRQ_SET_DATA_EVENTFD)) !=
618 (VFIO_IRQ_SET_DATA_NONE | VFIO_IRQ_SET_DATA_EVENTFD));
620 irq_set->argsz = sizeof (struct vfio_irq_set) + data_len;
621 irq_set->index = index;
622 irq_set->start = start;
623 irq_set->count = count;
624 irq_set->flags = flags;
626 if (ioctl (p->fd, VFIO_DEVICE_SET_IRQS, irq_set) < 0)
627 return clib_error_return_unix (0, "%U:ioctl(VFIO_DEVICE_SET_IRQS) "
628 "[index = %u, start = %u, count = %u, "
630 format_vlib_pci_addr, &p->addr,
631 index, start, count, flags);
635 static clib_error_t *
636 linux_pci_uio_read_ready (clib_file_t * uf)
638 vlib_main_t *vm = vlib_get_main ();
639 int __attribute__ ((unused)) rv;
640 vlib_pci_dev_handle_t h = uf->private_data;
641 linux_pci_device_t *p = linux_pci_get_device (h);
642 linux_pci_irq_t *irq = &p->intx_irq;
645 rv = read (uf->file_descriptor, &icount, 4);
647 if (irq->intx_handler)
648 irq->intx_handler (vm, h);
650 vlib_pci_intr_enable (vm, h);
652 return /* no error */ 0;
655 static clib_error_t *
656 linux_pci_vfio_unmask_intx (vlib_main_t * vm, linux_pci_device_t * d)
658 return vfio_set_irqs (vm, d, VFIO_PCI_INTX_IRQ_INDEX, 0, 1,
659 VFIO_IRQ_SET_ACTION_UNMASK, 0);
662 static clib_error_t *
663 linux_pci_uio_error_ready (clib_file_t * uf)
665 u32 error_index = (u32) uf->private_data;
667 return clib_error_return (0, "pci device %d: error", error_index);
670 static clib_error_t *
671 linux_pci_vfio_msix_read_ready (clib_file_t * uf)
673 vlib_main_t *vm = vlib_get_main ();
674 int __attribute__ ((unused)) rv;
675 vlib_pci_dev_handle_t h = uf->private_data >> 16;
676 u16 line = uf->private_data & 0xffff;
677 linux_pci_device_t *p = linux_pci_get_device (h);
678 linux_pci_irq_t *irq = vec_elt_at_index (p->msix_irqs, line);
681 rv = read (uf->file_descriptor, &icount, sizeof (icount));
683 if (irq->msix_handler)
684 irq->msix_handler (vm, h, line);
686 return /* no error */ 0;
689 static clib_error_t *
690 linux_pci_vfio_intx_read_ready (clib_file_t * uf)
692 vlib_main_t *vm = vlib_get_main ();
693 int __attribute__ ((unused)) rv;
694 vlib_pci_dev_handle_t h = uf->private_data;
695 linux_pci_device_t *p = linux_pci_get_device (h);
696 linux_pci_irq_t *irq = &p->intx_irq;
699 rv = read (uf->file_descriptor, &icount, sizeof (icount));
701 if (irq->intx_handler)
702 irq->intx_handler (vm, h);
704 linux_pci_vfio_unmask_intx (vm, p);
706 return /* no error */ 0;
709 static clib_error_t *
710 linux_pci_vfio_error_ready (clib_file_t * uf)
712 u32 error_index = (u32) uf->private_data;
714 return clib_error_return (0, "pci device %d: error", error_index);
717 static clib_error_t *
718 add_device_uio (vlib_main_t * vm, linux_pci_device_t * p,
719 vlib_pci_device_info_t * di, pci_device_registration_t * r)
721 linux_pci_main_t *lpm = &linux_pci_main;
722 clib_error_t *err = 0;
726 p->type = LINUX_PCI_DEVICE_TYPE_UIO;
728 s = format (s, "%s/%U/config%c", sysfs_pci_dev_path,
729 format_vlib_pci_addr, &di->addr, 0);
731 p->config_fd = open ((char *) s, O_RDWR);
732 p->config_offset = 0;
733 vec_reset_length (s);
735 if (p->config_fd == -1)
737 err = clib_error_return_unix (0, "open '%s'", s);
741 s = format (0, "%s/%U/uio%c", sysfs_pci_dev_path,
742 format_vlib_pci_addr, &di->addr, 0);
743 foreach_directory_file ((char *) s, scan_uio_dir, p, /* scan_dirs */
745 vec_reset_length (s);
747 s = format (s, "/dev/uio%d%c", p->uio_minor, 0);
748 p->fd = open ((char *) s, O_RDWR);
751 err = clib_error_return_unix (0, "open '%s'", s);
755 if (r && r->interrupt_handler)
756 vlib_pci_register_intx_handler (vm, p->handle, r->interrupt_handler);
758 if (r && r->init_function)
759 err = r->init_function (lpm->vlib_main, p->handle);
765 if (p->config_fd != -1)
766 close (p->config_fd);
774 vlib_pci_register_intx_handler (vlib_main_t * vm, vlib_pci_dev_handle_t h,
775 pci_intx_handler_function_t * intx_handler)
777 linux_pci_device_t *p = linux_pci_get_device (h);
778 clib_file_t t = { 0 };
779 linux_pci_irq_t *irq = &p->intx_irq;
780 ASSERT (irq->fd == -1);
782 if (p->type == LINUX_PCI_DEVICE_TYPE_VFIO)
784 struct vfio_irq_info ii = { 0 };
785 ii.argsz = sizeof (struct vfio_irq_info);
786 ii.index = VFIO_PCI_INTX_IRQ_INDEX;
787 if (ioctl (p->fd, VFIO_DEVICE_GET_IRQ_INFO, &ii) < 0)
788 return clib_error_return_unix (0, "ioctl(VFIO_DEVICE_GET_IRQ_INFO) '"
789 "%U'", format_vlib_pci_addr, &p->addr);
790 pci_log_debug (vm, p, "%s index:%u count:%u flags: %s%s%s%s(0x%x)",
791 __func__, ii.index, ii.count,
792 ii.flags & VFIO_IRQ_INFO_EVENTFD ? "eventfd " : "",
793 ii.flags & VFIO_IRQ_INFO_MASKABLE ? "maskable " : "",
794 ii.flags & VFIO_IRQ_INFO_AUTOMASKED ? "automasked " : "",
795 ii.flags & VFIO_IRQ_INFO_NORESIZE ? "noresize " : "",
798 return clib_error_return (0, "INTx interrupt does not exist on device"
799 "'%U'", format_vlib_pci_addr, &p->addr);
801 irq->fd = eventfd (0, EFD_NONBLOCK);
803 return clib_error_return_unix (0, "eventfd");
805 t.file_descriptor = irq->fd;
806 t.read_function = linux_pci_vfio_intx_read_ready;
808 else if (p->type == LINUX_PCI_DEVICE_TYPE_UIO)
810 t.file_descriptor = p->fd;
811 t.read_function = linux_pci_uio_read_ready;
816 t.error_function = linux_pci_uio_error_ready;
817 t.private_data = p->handle;
818 t.description = format (0, "PCI %U INTx", format_vlib_pci_addr, &p->addr);
819 irq->clib_file_index = clib_file_add (&file_main, &t);
820 irq->intx_handler = intx_handler;
825 vlib_pci_register_msix_handler (vlib_main_t * vm, vlib_pci_dev_handle_t h,
826 u32 start, u32 count,
827 pci_msix_handler_function_t * msix_handler)
829 clib_error_t *err = 0;
830 linux_pci_device_t *p = linux_pci_get_device (h);
833 if (p->type != LINUX_PCI_DEVICE_TYPE_VFIO)
834 return clib_error_return (0, "vfio driver is needed for MSI-X interrupt "
838 vec_validate_init_empty (p->msix_irqs, start + count - 1, (linux_pci_irq_t)
842 for (i = start; i < start + count; i++)
844 clib_file_t t = { 0 };
845 linux_pci_irq_t *irq = vec_elt_at_index (p->msix_irqs, i);
846 ASSERT (irq->fd == -1);
848 irq->fd = eventfd (0, EFD_NONBLOCK);
851 err = clib_error_return_unix (0, "eventfd");
855 t.read_function = linux_pci_vfio_msix_read_ready;
856 t.file_descriptor = irq->fd;
857 t.error_function = linux_pci_vfio_error_ready;
858 t.private_data = p->handle << 16 | i;
859 t.description = format (0, "PCI %U MSI-X #%u", format_vlib_pci_addr,
861 irq->clib_file_index = clib_file_add (&file_main, &t);
862 irq->msix_handler = msix_handler;
870 linux_pci_irq_t *irq = vec_elt_at_index (p->msix_irqs, i);
873 clib_file_del_by_index (&file_main, irq->clib_file_index);
882 vlib_pci_enable_msix_irq (vlib_main_t * vm, vlib_pci_dev_handle_t h,
883 u16 start, u16 count)
885 linux_pci_device_t *p = linux_pci_get_device (h);
889 if (p->type != LINUX_PCI_DEVICE_TYPE_VFIO)
890 return clib_error_return (0, "vfio driver is needed for MSI-X interrupt "
893 for (i = start; i < start + count; i++)
895 linux_pci_irq_t *irq = vec_elt_at_index (p->msix_irqs, i);
899 return vfio_set_irqs (vm, p, VFIO_PCI_MSIX_IRQ_INDEX, start, count,
900 VFIO_IRQ_SET_ACTION_TRIGGER, fds);
904 vlib_pci_disable_msix_irq (vlib_main_t * vm, vlib_pci_dev_handle_t h,
905 u16 start, u16 count)
907 linux_pci_device_t *p = linux_pci_get_device (h);
910 if (p->type != LINUX_PCI_DEVICE_TYPE_VFIO)
911 return clib_error_return (0, "vfio driver is needed for MSI-X interrupt "
914 for (i = start; i < start + count; i++)
917 return vfio_set_irqs (vm, p, VFIO_PCI_MSIX_IRQ_INDEX, start, count,
918 VFIO_IRQ_SET_ACTION_TRIGGER, fds);
921 static clib_error_t *
922 add_device_vfio (vlib_main_t * vm, linux_pci_device_t * p,
923 vlib_pci_device_info_t * di, pci_device_registration_t * r)
925 linux_pci_main_t *lpm = &linux_pci_main;
926 struct vfio_device_info device_info = { 0 };
927 struct vfio_region_info reg = { 0 };
928 clib_error_t *err = 0;
932 p->type = LINUX_PCI_DEVICE_TYPE_VFIO;
934 if ((err = linux_vfio_group_get_device_fd (&p->addr, &p->fd, &is_noiommu)))
938 p->supports_va_dma = 1;
940 device_info.argsz = sizeof (device_info);
941 if (ioctl (p->fd, VFIO_DEVICE_GET_INFO, &device_info) < 0)
943 err = clib_error_return_unix (0, "ioctl(VFIO_DEVICE_GET_INFO) '%U'",
944 format_vlib_pci_addr, &di->addr);
948 reg.argsz = sizeof (struct vfio_region_info);
949 reg.index = VFIO_PCI_CONFIG_REGION_INDEX;
950 if (ioctl (p->fd, VFIO_DEVICE_GET_REGION_INFO, ®) < 0)
952 err = clib_error_return_unix (0, "ioctl(VFIO_DEVICE_GET_INFO) '%U'",
953 format_vlib_pci_addr, &di->addr);
957 pci_log_debug (vm, p, "%s region_info index:%u size:0x%lx offset:0x%lx "
958 "flags: %s%s%s(0x%x)", __func__,
959 reg.index, reg.size, reg.offset,
960 reg.flags & VFIO_REGION_INFO_FLAG_READ ? "rd " : "",
961 reg.flags & VFIO_REGION_INFO_FLAG_WRITE ? "wr " : "",
962 reg.flags & VFIO_REGION_INFO_FLAG_MMAP ? "mmap " : "",
965 p->config_offset = reg.offset;
966 p->config_fd = p->fd;
968 /* reset if device supports it */
969 if (device_info.flags & VFIO_DEVICE_FLAGS_RESET)
970 if (ioctl (p->fd, VFIO_DEVICE_RESET) < 0)
972 err = clib_error_return_unix (0, "ioctl(VFIO_DEVICE_RESET) '%U'",
973 format_vlib_pci_addr, &di->addr);
977 if (r && r->interrupt_handler)
979 vlib_pci_register_intx_handler (vm, p->handle, r->interrupt_handler);
980 linux_pci_vfio_unmask_intx (vm, p);
983 if (p->supports_va_dma)
985 vlib_buffer_pool_t *bp;
987 vec_foreach (bp, vm->buffer_main->buffer_pools)
990 vlib_physmem_map_t *pm;
991 pm = vlib_physmem_get_map (vm, bp->physmem_map_index);
992 for (i = 0; i < pm->n_pages; i++)
993 vfio_map_physmem_page (vm, pm->base + (i << pm->log2_page_size));
998 if (r && r->init_function)
999 err = r->init_function (lpm->vlib_main, p->handle);
1007 if (p->config_fd != -1 && p->config_fd != p->fd)
1008 close (p->config_fd);
1009 p->config_fd = p->fd = -1;
1014 /* Configuration space read/write. */
1016 vlib_pci_read_write_config (vlib_main_t * vm, vlib_pci_dev_handle_t h,
1017 vlib_read_or_write_t read_or_write,
1018 uword address, void *data, u32 n_bytes)
1020 linux_pci_device_t *p = linux_pci_get_device (h);
1023 if (read_or_write == VLIB_READ)
1024 n = pread (p->config_fd, data, n_bytes, p->config_offset + address);
1026 n = pwrite (p->config_fd, data, n_bytes, p->config_offset + address);
1029 return clib_error_return_unix (0, "%s",
1030 read_or_write == VLIB_READ
1031 ? "read" : "write");
1036 static clib_error_t *
1037 vlib_pci_region (vlib_main_t * vm, vlib_pci_dev_handle_t h, u32 bar, int *fd,
1038 u64 * size, u64 * offset)
1040 linux_pci_device_t *p = linux_pci_get_device (h);
1041 clib_error_t *error = 0;
1043 u64 _size = 0, _offset = 0;
1049 if (p->type == LINUX_PCI_DEVICE_TYPE_UIO)
1052 struct stat stat_buf;
1053 file_name = format (0, "%s/%U/resource%d%c", sysfs_pci_dev_path,
1054 format_vlib_pci_addr, &p->addr, bar, 0);
1056 _fd = open ((char *) file_name, O_RDWR);
1059 error = clib_error_return_unix (0, "open `%s'", file_name);
1060 vec_free (file_name);
1064 if (fstat (_fd, &stat_buf) < 0)
1066 error = clib_error_return_unix (0, "fstat `%s'", file_name);
1067 vec_free (file_name);
1072 vec_free (file_name);
1073 _size = stat_buf.st_size;
1076 else if (p->type == LINUX_PCI_DEVICE_TYPE_VFIO)
1078 struct vfio_region_info reg = { 0 };
1079 reg.argsz = sizeof (struct vfio_region_info);
1081 if (ioctl (p->fd, VFIO_DEVICE_GET_REGION_INFO, ®) < 0)
1082 return clib_error_return_unix (0, "ioctl(VFIO_DEVICE_GET_INFO) "
1083 "'%U'", format_vlib_pci_addr,
1087 _offset = reg.offset;
1088 pci_log_debug (vm, p, "%s region_info index:%u size:0x%lx offset:0x%lx "
1089 "flags: %s%s%s(0x%x)", __func__,
1090 reg.index, reg.size, reg.offset,
1091 reg.flags & VFIO_REGION_INFO_FLAG_READ ? "rd " : "",
1092 reg.flags & VFIO_REGION_INFO_FLAG_WRITE ? "wr " : "",
1093 reg.flags & VFIO_REGION_INFO_FLAG_MMAP ? "mmap " : "",
1106 static clib_error_t *
1107 vlib_pci_map_region_int (vlib_main_t * vm, vlib_pci_dev_handle_t h,
1108 u32 bar, u8 * addr, void **result)
1110 linux_pci_device_t *p = linux_pci_get_device (h);
1112 clib_error_t *error;
1113 int flags = MAP_SHARED;
1114 u64 size = 0, offset = 0;
1116 pci_log_debug (vm, p, "map region %u to va %p", bar, addr);
1118 if ((error = vlib_pci_region (vm, h, bar, &fd, &size, &offset)))
1121 if (p->type == LINUX_PCI_DEVICE_TYPE_UIO && addr != 0)
1124 *result = mmap (addr, size, PROT_READ | PROT_WRITE, flags, fd, offset);
1125 if (*result == (void *) -1)
1127 error = clib_error_return_unix (0, "mmap `BAR%u'", bar);
1128 if (p->type == LINUX_PCI_DEVICE_TYPE_UIO)
1134 vec_validate_init_empty (p->regions, bar,
1135 (linux_pci_region_t) { .fd = -1});
1137 if (p->type == LINUX_PCI_DEVICE_TYPE_UIO)
1138 p->regions[bar].fd = fd;
1139 p->regions[bar].addr = *result;
1140 p->regions[bar].size = size;
1145 vlib_pci_map_region (vlib_main_t * vm, vlib_pci_dev_handle_t h, u32 resource,
1148 return (vlib_pci_map_region_int (vm, h, resource, 0 /* addr */ , result));
1152 vlib_pci_map_region_fixed (vlib_main_t * vm, vlib_pci_dev_handle_t h,
1153 u32 resource, u8 * addr, void **result)
1155 return (vlib_pci_map_region_int (vm, h, resource, addr, result));
1159 vlib_pci_io_region (vlib_main_t * vm, vlib_pci_dev_handle_t h, u32 resource)
1161 linux_pci_device_t *p = linux_pci_get_device (h);
1162 clib_error_t *error = 0;
1164 u64 size = 0, offset = 0;
1166 if ((error = vlib_pci_region (vm, h, resource, &fd, &size, &offset)))
1170 p->io_offset = offset;
1175 vlib_pci_read_write_io (vlib_main_t * vm, vlib_pci_dev_handle_t h,
1176 vlib_read_or_write_t read_or_write,
1177 uword offset, void *data, u32 length)
1179 linux_pci_device_t *p = linux_pci_get_device (h);
1182 if (read_or_write == VLIB_READ)
1183 n = pread (p->io_fd, data, length, p->io_offset + offset);
1185 n = pwrite (p->io_fd, data, length, p->io_offset + offset);
1188 return clib_error_return_unix (0, "%s",
1189 read_or_write == VLIB_READ
1190 ? "read" : "write");
1195 vlib_pci_map_dma (vlib_main_t * vm, vlib_pci_dev_handle_t h, void *ptr)
1197 linux_pci_device_t *p = linux_pci_get_device (h);
1199 if (!p->supports_va_dma)
1202 return vfio_map_physmem_page (vm, ptr);
1206 vlib_pci_supports_virtual_addr_dma (vlib_main_t * vm, vlib_pci_dev_handle_t h)
1208 linux_pci_device_t *p = linux_pci_get_device (h);
1210 return p->supports_va_dma != 0;
1214 vlib_pci_device_open (vlib_main_t * vm, vlib_pci_addr_t * addr,
1215 pci_device_id_t ids[], vlib_pci_dev_handle_t * handle)
1217 linux_pci_main_t *lpm = &linux_pci_main;
1218 vlib_pci_device_info_t *di;
1219 linux_pci_device_t *p;
1220 clib_error_t *err = 0;
1223 di = vlib_pci_get_device_info (vm, addr, &err);
1227 for (i = ids; i->vendor_id != 0; i++)
1228 if (i->vendor_id == di->vendor_id && i->device_id == di->device_id)
1231 if (i->vendor_id == 0)
1232 return clib_error_return (0, "Wrong vendor or device id");
1234 pool_get (lpm->linux_pci_devices, p);
1235 p->handle = p - lpm->linux_pci_devices;
1236 p->addr.as_u32 = di->addr.as_u32;
1237 p->intx_irq.fd = -1;
1238 p->intx_irq.clib_file_index = -1;
1239 p->numa_node = di->numa_node;
1241 * pci io bar read/write fd
1245 pci_log_debug (vm, p, "open vid:0x%04x did:0x%04x driver:%s iommu_group:%d",
1246 di->vendor_id, di->device_id, di->driver_name,
1249 if (clib_strncmp ("vfio-pci", (char *) di->driver_name, 8) == 0)
1250 err = add_device_vfio (vm, p, di, 0);
1251 else if (clib_strncmp ("uio_pci_generic", (char *) di->driver_name, 8) == 0)
1252 err = add_device_uio (vm, p, di, 0);
1254 err = clib_error_create ("device not bound to 'vfio-pci' or "
1255 "'uio_pci_generic' kernel module");
1259 *handle = p->handle;
1262 vlib_pci_free_device_info (di);
1265 pci_log_err (vm, p, "%U", format_clib_error, err);
1266 clib_memset (p, 0, sizeof (linux_pci_device_t));
1267 pool_put (lpm->linux_pci_devices, p);
1274 vlib_pci_device_close (vlib_main_t * vm, vlib_pci_dev_handle_t h)
1276 linux_pci_main_t *lpm = &linux_pci_main;
1277 linux_pci_device_t *p = linux_pci_get_device (h);
1278 linux_pci_irq_t *irq;
1279 linux_pci_region_t *res;
1280 clib_error_t *err = 0;
1282 if (p->type == LINUX_PCI_DEVICE_TYPE_UIO)
1285 if (irq->clib_file_index != -1)
1286 clib_file_del_by_index (&file_main, irq->clib_file_index);
1287 close (p->config_fd);
1291 else if (p->type == LINUX_PCI_DEVICE_TYPE_VFIO)
1294 /* close INTx irqs */
1297 err = vfio_set_irqs (vm, p, VFIO_PCI_INTX_IRQ_INDEX, 0, 0,
1298 VFIO_IRQ_SET_ACTION_TRIGGER, 0);
1299 clib_error_free (err);
1300 if (irq->clib_file_index != -1)
1301 clib_file_del_by_index (&file_main, irq->clib_file_index);
1305 /* close MSI-X irqs */
1306 if (vec_len (p->msix_irqs))
1308 err = vfio_set_irqs (vm, p, VFIO_PCI_MSIX_IRQ_INDEX, 0, 0,
1309 VFIO_IRQ_SET_ACTION_TRIGGER, 0);
1310 clib_error_free (err);
1312 vec_foreach (irq, p->msix_irqs)
1316 clib_file_del_by_index (&file_main, irq->clib_file_index);
1320 vec_free (p->msix_irqs);
1325 vec_foreach (res, p->regions)
1329 munmap (res->addr, res->size);
1334 vec_free (p->regions);
1337 clib_memset (p, 0, sizeof (linux_pci_device_t));
1338 pool_put (lpm->linux_pci_devices, p);
1342 init_device_from_registered (vlib_main_t * vm, vlib_pci_device_info_t * di)
1344 vlib_pci_main_t *pm = &pci_main;
1345 linux_pci_main_t *lpm = &linux_pci_main;
1346 pci_device_registration_t *r;
1348 clib_error_t *err = 0;
1349 linux_pci_device_t *p;
1351 pool_get (lpm->linux_pci_devices, p);
1352 p->handle = p - lpm->linux_pci_devices;
1353 p->intx_irq.fd = -1;
1355 r = pm->pci_device_registrations;
1359 for (i = r->supported_devices; i->vendor_id != 0; i++)
1360 if (i->vendor_id == di->vendor_id && i->device_id == di->device_id)
1362 if (di->iommu_group != -1)
1363 err = add_device_vfio (vm, p, di, r);
1365 err = add_device_uio (vm, p, di, r);
1368 clib_error_report (err);
1372 r = r->next_registration;
1375 /* No driver, close the PCI config-space FD */
1376 clib_memset (p, 0, sizeof (linux_pci_device_t));
1377 pool_put (lpm->linux_pci_devices, p);
1380 static clib_error_t *
1381 scan_pci_addr (void *arg, u8 * dev_dir_name, u8 * ignored)
1383 vlib_pci_addr_t addr, **addrv = arg;
1384 unformat_input_t input;
1385 clib_error_t *err = 0;
1387 unformat_init_string (&input, (char *) dev_dir_name,
1388 vec_len (dev_dir_name));
1390 if (!unformat (&input, "/sys/bus/pci/devices/%U",
1391 unformat_vlib_pci_addr, &addr))
1392 err = clib_error_return (0, "unformat error `%v`", dev_dir_name);
1394 unformat_free (&input);
1399 vec_add1 (*addrv, addr);
1404 pci_addr_cmp (void *v1, void *v2)
1406 vlib_pci_addr_t *a1 = v1;
1407 vlib_pci_addr_t *a2 = v2;
1409 if (a1->domain > a2->domain)
1411 if (a1->domain < a2->domain)
1413 if (a1->bus > a2->bus)
1415 if (a1->bus < a2->bus)
1417 if (a1->slot > a2->slot)
1419 if (a1->slot < a2->slot)
1421 if (a1->function > a2->function)
1423 if (a1->function < a2->function)
1429 vlib_pci_get_all_dev_addrs ()
1431 vlib_pci_addr_t *addrs = 0;
1433 err = foreach_directory_file ((char *) sysfs_pci_dev_path, scan_pci_addr,
1434 &addrs, /* scan_dirs */ 0);
1441 vec_sort_with_function (addrs, pci_addr_cmp);
1447 linux_pci_init (vlib_main_t * vm)
1449 vlib_pci_main_t *pm = &pci_main;
1450 vlib_pci_addr_t *addr = 0, *addrs;
1454 ASSERT (sizeof (vlib_pci_addr_t) == sizeof (u32));
1456 addrs = vlib_pci_get_all_dev_addrs ();
1458 vec_foreach (addr, addrs)
1460 vlib_pci_device_info_t *d;
1461 if ((d = vlib_pci_get_device_info (vm, addr, 0)))
1463 init_device_from_registered (vm, d);
1464 vlib_pci_free_device_info (d);
1473 VLIB_INIT_FUNCTION (linux_pci_init) =
1475 .runs_after = VLIB_INITS("unix_input_init"),
1480 * fd.io coding-style-patch-verification: ON
1483 * eval: (c-set-style "gnu")