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;
101 /* Resource file descriptors. */
102 linux_pci_region_t *regions;
104 /* File descriptor for config space read/write. */
108 /* Device File descriptor */
111 /* read/write file descriptor for io bar */
115 /* Minor device for uio device. */
118 /* Interrupt handlers */
119 linux_pci_irq_t intx_irq;
120 linux_pci_irq_t *msix_irqs;
127 } linux_pci_device_t;
129 /* Pool of PCI devices. */
132 vlib_main_t *vlib_main;
133 linux_pci_device_t *linux_pci_devices;
137 extern linux_pci_main_t linux_pci_main;
139 static linux_pci_device_t *
140 linux_pci_get_device (vlib_pci_dev_handle_t h)
142 linux_pci_main_t *lpm = &linux_pci_main;
143 return pool_elt_at_index (lpm->linux_pci_devices, h);
147 vlib_pci_get_private_data (vlib_main_t * vm, vlib_pci_dev_handle_t h)
149 linux_pci_device_t *d = linux_pci_get_device (h);
150 return d->private_data;
154 vlib_pci_set_private_data (vlib_main_t * vm, vlib_pci_dev_handle_t h,
157 linux_pci_device_t *d = linux_pci_get_device (h);
158 d->private_data = private_data;
162 vlib_pci_get_addr (vlib_main_t * vm, vlib_pci_dev_handle_t h)
164 linux_pci_device_t *d = linux_pci_get_device (h);
168 /* Call to allocate/initialize the pci subsystem.
169 This is not an init function so that users can explicitly enable
170 pci only when it's needed. */
171 clib_error_t *pci_bus_init (vlib_main_t * vm);
173 linux_pci_main_t linux_pci_main;
175 vlib_pci_device_info_t *
176 vlib_pci_get_device_info (vlib_main_t * vm, vlib_pci_addr_t * addr,
177 clib_error_t ** error)
179 linux_vfio_main_t *lvm = &vfio_main;
181 vlib_pci_device_info_t *di;
186 di = clib_mem_alloc (sizeof (vlib_pci_device_info_t));
187 clib_memset (di, 0, sizeof (vlib_pci_device_info_t));
188 di->addr.as_u32 = addr->as_u32;
190 u8 *dev_dir_name = format (0, "%s/%U", sysfs_pci_dev_path,
191 format_vlib_pci_addr, addr);
193 f = format (0, "%v/config%c", dev_dir_name, 0);
194 fd = open ((char *) f, O_RDWR);
196 /* Try read-only access if write fails. */
198 fd = open ((char *) f, O_RDONLY);
202 err = clib_error_return_unix (0, "open `%s'", f);
206 /* You can only read more that 64 bytes of config space as root; so we try to
207 read the full space but fall back to just the first 64 bytes. */
208 if (read (fd, &di->config_data, sizeof (di->config_data)) <
209 sizeof (di->config0))
211 err = clib_error_return_unix (0, "read `%s'", f);
217 static pci_config_header_t all_ones;
218 if (all_ones.vendor_id == 0)
219 clib_memset (&all_ones, ~0, sizeof (all_ones));
221 if (!memcmp (&di->config0.header, &all_ones, sizeof (all_ones)))
223 err = clib_error_return (0, "invalid PCI config for `%s'", f);
229 if (di->config0.header.header_type == 0)
230 pci_config_type0_little_to_host (&di->config0);
232 pci_config_type1_little_to_host (&di->config1);
235 vec_reset_length (f);
236 f = format (f, "%v/numa_node%c", dev_dir_name, 0);
237 err = clib_sysfs_read ((char *) f, "%u", &di->numa_node);
241 clib_error_free (err);
244 vec_reset_length (f);
245 f = format (f, "%v/class%c", dev_dir_name, 0);
246 err = clib_sysfs_read ((char *) f, "0x%x", &tmp);
249 di->device_class = tmp >> 8;
251 vec_reset_length (f);
252 f = format (f, "%v/vendor%c", dev_dir_name, 0);
253 err = clib_sysfs_read ((char *) f, "0x%x", &tmp);
258 vec_reset_length (f);
259 f = format (f, "%v/device%c", dev_dir_name, 0);
260 err = clib_sysfs_read ((char *) f, "0x%x", &tmp);
265 vec_reset_length (f);
266 f = format (f, "%v/driver%c", dev_dir_name, 0);
267 di->driver_name = clib_sysfs_link_to_name ((char *) f);
269 di->iommu_group = -1;
270 if (lvm->container_fd != -1)
273 vec_reset_length (f);
274 f = format (f, "%v/iommu_group%c", dev_dir_name, 0);
275 tmpstr = clib_sysfs_link_to_name ((char *) f);
278 di->iommu_group = atoi ((char *) tmpstr);
281 vec_reset_length (f);
282 f = format (f, "%v/iommu_group/name%c", dev_dir_name, 0);
283 err = clib_sysfs_read ((char *) f, "%s", &tmpstr);
286 if (strncmp ((char *) tmpstr, "vfio-noiommu", 12) == 0)
287 di->flags |= VLIB_PCI_DEVICE_INFO_F_NOIOMMU;
291 clib_error_free (err);
296 vec_reset_length (f);
297 f = format (f, "%v/vpd%c", dev_dir_name, 0);
298 fd = open ((char *) f, O_RDONLY);
307 if (read (fd, &tag, 3) != 3)
310 if (tag[0] != 0x82 && tag[0] != 0x90 && tag[0] != 0x91)
313 len = (tag[2] << 8) | tag[1];
314 vec_validate (data, len);
316 if (read (fd, data, len) != len)
322 di->product_name = data;
323 else if (tag[0] == 0x90)
325 else if (tag[0] == 0x91)
336 vlib_pci_free_device_info (di);
341 vec_free (dev_dir_name);
345 clib_error_free (err);
350 directory_exists (char *path)
352 struct stat s = { 0 };
353 if (stat (path, &s) == -1)
356 return S_ISDIR (s.st_mode);
360 vlib_pci_bind_to_uio (vlib_main_t * vm, vlib_pci_addr_t * addr,
363 clib_error_t *error = 0;
364 u8 *s = 0, *driver_name = 0;
367 vlib_pci_device_info_t *di;
368 int fd, clear_driver_override = 0;
369 u8 *dev_dir_name = format (0, "%s/%U", sysfs_pci_dev_path,
370 format_vlib_pci_addr, addr);
372 di = vlib_pci_get_device_info (vm, addr, &error);
377 if (strncmp ("auto", uio_drv_name, 5) == 0)
379 int vfio_pci_loaded = 0;
381 if (directory_exists ("/sys/module/vfio_pci"))
384 if (di->iommu_group != -1)
386 /* device is bound to IOMMU group */
387 if (!vfio_pci_loaded)
389 error = clib_error_return (0, "Skipping PCI device %U: device "
390 "is bound to IOMMU group and "
391 "vfio-pci driver is not loaded",
392 format_vlib_pci_addr, addr);
396 uio_drv_name = "vfio-pci";
400 /* device is not bound to IOMMU group so we have multiple options */
401 if (vfio_pci_loaded &&
402 (error = clib_sysfs_write (sysfs_mod_vfio_noiommu, "Y")) == 0)
403 uio_drv_name = "vfio-pci";
404 else if (directory_exists ("/sys/module/uio_pci_generic"))
405 uio_drv_name = "uio_pci_generic";
406 else if (directory_exists ("/sys/module/igb_uio"))
407 uio_drv_name = "igb_uio";
410 clib_error_free (error);
411 error = clib_error_return (0, "Skipping PCI device %U: missing "
412 "kernel VFIO or UIO driver",
413 format_vlib_pci_addr, addr);
416 clib_error_free (error);
420 s = format (s, "%v/driver%c", dev_dir_name, 0);
421 driver_name = clib_sysfs_link_to_name ((char *) s);
422 vec_reset_length (s);
425 ((strcmp ("vfio-pci", (char *) driver_name) == 0) ||
426 (strcmp ("uio_pci_generic", (char *) driver_name) == 0) ||
427 (strcmp ("igb_uio", (char *) driver_name) == 0)))
430 /* walk trough all linux interfaces and if interface belonging to
431 this device is founf check if interface is admin up */
432 dir = opendir ("/sys/class/net");
433 s = format (s, "%U%c", format_vlib_pci_addr, addr, 0);
437 error = clib_error_return (0, "Skipping PCI device %U: failed to "
438 "read /sys/class/net",
439 format_vlib_pci_addr, addr);
443 fd = socket (PF_INET, SOCK_DGRAM, 0);
446 error = clib_error_return_unix (0, "socket");
450 while ((e = readdir (dir)))
453 struct ethtool_drvinfo drvinfo;
455 if (e->d_name[0] == '.') /* skip . and .. */
458 clib_memset (&ifr, 0, sizeof ifr);
459 clib_memset (&drvinfo, 0, sizeof drvinfo);
460 ifr.ifr_data = (char *) &drvinfo;
461 strncpy (ifr.ifr_name, e->d_name, sizeof (ifr.ifr_name));
462 ifr.ifr_name[ARRAY_LEN (ifr.ifr_name) - 1] = '\0';
463 drvinfo.cmd = ETHTOOL_GDRVINFO;
464 if (ioctl (fd, SIOCETHTOOL, &ifr) < 0)
466 /* Some interfaces (eg "lo") don't support this ioctl */
467 if ((errno != ENOTSUP) && (errno != ENODEV))
468 clib_unix_warning ("ioctl fetch intf %s bus info error",
473 if (strcmp ((char *) s, drvinfo.bus_info))
476 clib_memset (&ifr, 0, sizeof (ifr));
477 strncpy (ifr.ifr_name, e->d_name, sizeof (ifr.ifr_name));
478 ifr.ifr_name[ARRAY_LEN (ifr.ifr_name) - 1] = '\0';
479 if (ioctl (fd, SIOCGIFFLAGS, &ifr) < 0)
481 error = clib_error_return_unix (0, "ioctl fetch intf %s flags",
487 if (ifr.ifr_flags & IFF_UP)
489 error = clib_error_return (0, "Skipping PCI device %U as host "
490 "interface %s is up",
491 format_vlib_pci_addr, addr, e->d_name);
498 vec_reset_length (s);
500 s = format (s, "%v/driver/unbind%c", dev_dir_name, 0);
501 clib_sysfs_write ((char *) s, "%U", format_vlib_pci_addr, addr);
502 vec_reset_length (s);
504 s = format (s, "%v/driver_override%c", dev_dir_name, 0);
505 if (access ((char *) s, F_OK) == 0)
507 clib_sysfs_write ((char *) s, "%s", uio_drv_name);
508 clear_driver_override = 1;
512 vec_reset_length (s);
513 s = format (s, "%s/%s/new_id%c", sysfs_pci_drv_path, uio_drv_name, 0);
514 clib_sysfs_write ((char *) s, "0x%04x 0x%04x", di->vendor_id,
517 vec_reset_length (s);
519 s = format (s, "%s/%s/bind%c", sysfs_pci_drv_path, uio_drv_name, 0);
520 clib_sysfs_write ((char *) s, "%U", format_vlib_pci_addr, addr);
521 vec_reset_length (s);
523 if (clear_driver_override)
525 s = format (s, "%v/driver_override%c", dev_dir_name, 0);
526 clib_sysfs_write ((char *) s, "%c", 0);
527 vec_reset_length (s);
533 vec_free (dev_dir_name);
534 vec_free (driver_name);
539 static clib_error_t *
540 scan_uio_dir (void *arg, u8 * path_name, u8 * file_name)
542 linux_pci_device_t *l = arg;
543 unformat_input_t input;
545 unformat_init_string (&input, (char *) file_name, vec_len (file_name));
547 if (!unformat (&input, "uio%d", &l->uio_minor))
550 unformat_free (&input);
554 static clib_error_t *
555 vfio_set_irqs (vlib_main_t * vm, linux_pci_device_t * p, u32 index, u32 start,
556 u32 count, u32 flags, int *efds)
558 int data_len = efds ? count * sizeof (int) : 0;
559 u8 buf[sizeof (struct vfio_irq_set) + data_len];
560 struct vfio_irq_info ii = { 0 };
561 struct vfio_irq_set *irq_set = (struct vfio_irq_set *) buf;
564 ii.argsz = sizeof (struct vfio_irq_info);
567 if (ioctl (p->fd, VFIO_DEVICE_GET_IRQ_INFO, &ii) < 0)
568 return clib_error_return_unix (0, "ioctl(VFIO_DEVICE_GET_IRQ_INFO) "
569 "'%U'", format_vlib_pci_addr, &p->addr);
571 pci_log_debug (vm, p, "%s index:%u count:%u flags: %s%s%s%s(0x%x)",
572 __func__, ii.index, ii.count,
573 ii.flags & VFIO_IRQ_INFO_EVENTFD ? "eventfd " : "",
574 ii.flags & VFIO_IRQ_INFO_MASKABLE ? "maskable " : "",
575 ii.flags & VFIO_IRQ_INFO_AUTOMASKED ? "automasked " : "",
576 ii.flags & VFIO_IRQ_INFO_NORESIZE ? "noresize " : "",
579 if (ii.count < start + count)
580 return clib_error_return_unix (0, "vfio_set_irq: unexistng interrupt on "
581 "'%U'", format_vlib_pci_addr, &p->addr);
586 flags |= VFIO_IRQ_SET_DATA_EVENTFD;
587 clib_memcpy (&irq_set->data, efds, data_len);
590 flags |= VFIO_IRQ_SET_DATA_NONE;
592 ASSERT ((flags & (VFIO_IRQ_SET_DATA_NONE | VFIO_IRQ_SET_DATA_EVENTFD)) !=
593 (VFIO_IRQ_SET_DATA_NONE | VFIO_IRQ_SET_DATA_EVENTFD));
595 irq_set->argsz = sizeof (struct vfio_irq_set) + data_len;
596 irq_set->index = index;
597 irq_set->start = start;
598 irq_set->count = count;
599 irq_set->flags = flags;
601 if (ioctl (p->fd, VFIO_DEVICE_SET_IRQS, irq_set) < 0)
602 return clib_error_return_unix (0, "%U:ioctl(VFIO_DEVICE_SET_IRQS) "
603 "[index = %u, start = %u, count = %u, "
605 format_vlib_pci_addr, &p->addr,
606 index, start, count, flags);
610 static clib_error_t *
611 linux_pci_uio_read_ready (clib_file_t * uf)
613 vlib_main_t *vm = vlib_get_main ();
614 int __attribute__ ((unused)) rv;
615 vlib_pci_dev_handle_t h = uf->private_data;
616 linux_pci_device_t *p = linux_pci_get_device (h);
617 linux_pci_irq_t *irq = &p->intx_irq;
620 rv = read (uf->file_descriptor, &icount, 4);
622 if (irq->intx_handler)
623 irq->intx_handler (vm, h);
625 vlib_pci_intr_enable (vm, h);
627 return /* no error */ 0;
630 static clib_error_t *
631 linux_pci_vfio_unmask_intx (vlib_main_t * vm, linux_pci_device_t * d)
633 return vfio_set_irqs (vm, d, VFIO_PCI_INTX_IRQ_INDEX, 0, 1,
634 VFIO_IRQ_SET_ACTION_UNMASK, 0);
637 static clib_error_t *
638 linux_pci_uio_error_ready (clib_file_t * uf)
640 u32 error_index = (u32) uf->private_data;
642 return clib_error_return (0, "pci device %d: error", error_index);
645 static clib_error_t *
646 linux_pci_vfio_msix_read_ready (clib_file_t * uf)
648 vlib_main_t *vm = vlib_get_main ();
649 int __attribute__ ((unused)) rv;
650 vlib_pci_dev_handle_t h = uf->private_data >> 16;
651 u16 line = uf->private_data & 0xffff;
652 linux_pci_device_t *p = linux_pci_get_device (h);
653 linux_pci_irq_t *irq = vec_elt_at_index (p->msix_irqs, line);
656 rv = read (uf->file_descriptor, &icount, sizeof (icount));
658 if (irq->msix_handler)
659 irq->msix_handler (vm, h, line);
661 return /* no error */ 0;
664 static clib_error_t *
665 linux_pci_vfio_intx_read_ready (clib_file_t * uf)
667 vlib_main_t *vm = vlib_get_main ();
668 int __attribute__ ((unused)) rv;
669 vlib_pci_dev_handle_t h = uf->private_data;
670 linux_pci_device_t *p = linux_pci_get_device (h);
671 linux_pci_irq_t *irq = &p->intx_irq;
674 rv = read (uf->file_descriptor, &icount, sizeof (icount));
676 if (irq->intx_handler)
677 irq->intx_handler (vm, h);
679 linux_pci_vfio_unmask_intx (vm, p);
681 return /* no error */ 0;
684 static clib_error_t *
685 linux_pci_vfio_error_ready (clib_file_t * uf)
687 u32 error_index = (u32) uf->private_data;
689 return clib_error_return (0, "pci device %d: error", error_index);
692 static clib_error_t *
693 add_device_uio (vlib_main_t * vm, linux_pci_device_t * p,
694 vlib_pci_device_info_t * di, pci_device_registration_t * r)
696 linux_pci_main_t *lpm = &linux_pci_main;
697 clib_error_t *err = 0;
701 p->type = LINUX_PCI_DEVICE_TYPE_UIO;
703 s = format (s, "%s/%U/config%c", sysfs_pci_dev_path,
704 format_vlib_pci_addr, &di->addr, 0);
706 p->config_fd = open ((char *) s, O_RDWR);
707 p->config_offset = 0;
708 vec_reset_length (s);
710 if (p->config_fd == -1)
712 err = clib_error_return_unix (0, "open '%s'", s);
716 s = format (0, "%s/%U/uio", sysfs_pci_dev_path,
717 format_vlib_pci_addr, &di->addr);
718 foreach_directory_file ((char *) s, scan_uio_dir, p, /* scan_dirs */
720 vec_reset_length (s);
722 s = format (s, "/dev/uio%d%c", p->uio_minor, 0);
723 p->fd = open ((char *) s, O_RDWR);
726 err = clib_error_return_unix (0, "open '%s'", s);
730 if (r && r->interrupt_handler)
731 vlib_pci_register_intx_handler (vm, p->handle, r->interrupt_handler);
733 if (r && r->init_function)
734 err = r->init_function (lpm->vlib_main, p->handle);
740 if (p->config_fd != -1)
741 close (p->config_fd);
749 vlib_pci_register_intx_handler (vlib_main_t * vm, vlib_pci_dev_handle_t h,
750 pci_intx_handler_function_t * intx_handler)
752 linux_pci_device_t *p = linux_pci_get_device (h);
753 clib_file_t t = { 0 };
754 linux_pci_irq_t *irq = &p->intx_irq;
755 ASSERT (irq->fd == -1);
757 if (p->type == LINUX_PCI_DEVICE_TYPE_VFIO)
759 struct vfio_irq_info ii = { 0 };
760 ii.argsz = sizeof (struct vfio_irq_info);
761 ii.index = VFIO_PCI_INTX_IRQ_INDEX;
762 if (ioctl (p->fd, VFIO_DEVICE_GET_IRQ_INFO, &ii) < 0)
763 return clib_error_return_unix (0, "ioctl(VFIO_DEVICE_GET_IRQ_INFO) '"
764 "%U'", format_vlib_pci_addr, &p->addr);
765 pci_log_debug (vm, p, "%s index:%u count:%u flags: %s%s%s%s(0x%x)",
766 __func__, ii.index, ii.count,
767 ii.flags & VFIO_IRQ_INFO_EVENTFD ? "eventfd " : "",
768 ii.flags & VFIO_IRQ_INFO_MASKABLE ? "maskable " : "",
769 ii.flags & VFIO_IRQ_INFO_AUTOMASKED ? "automasked " : "",
770 ii.flags & VFIO_IRQ_INFO_NORESIZE ? "noresize " : "",
773 return clib_error_return (0, "INTx interrupt does not exist on device"
774 "'%U'", format_vlib_pci_addr, &p->addr);
776 irq->fd = eventfd (0, EFD_NONBLOCK);
778 return clib_error_return_unix (0, "eventfd");
780 t.file_descriptor = irq->fd;
781 t.read_function = linux_pci_vfio_intx_read_ready;
783 else if (p->type == LINUX_PCI_DEVICE_TYPE_UIO)
785 t.file_descriptor = p->fd;
786 t.read_function = linux_pci_uio_read_ready;
791 t.error_function = linux_pci_uio_error_ready;
792 t.private_data = p->handle;
793 t.description = format (0, "PCI %U INTx", format_vlib_pci_addr, &p->addr);
794 irq->clib_file_index = clib_file_add (&file_main, &t);
795 irq->intx_handler = intx_handler;
800 vlib_pci_register_msix_handler (vlib_main_t * vm, vlib_pci_dev_handle_t h,
801 u32 start, u32 count,
802 pci_msix_handler_function_t * msix_handler)
804 clib_error_t *err = 0;
805 linux_pci_device_t *p = linux_pci_get_device (h);
808 if (p->type != LINUX_PCI_DEVICE_TYPE_VFIO)
809 return clib_error_return (0, "vfio driver is needed for MSI-X interrupt "
813 vec_validate_init_empty (p->msix_irqs, start + count - 1, (linux_pci_irq_t)
817 for (i = start; i < start + count; i++)
819 clib_file_t t = { 0 };
820 linux_pci_irq_t *irq = vec_elt_at_index (p->msix_irqs, i);
821 ASSERT (irq->fd == -1);
823 irq->fd = eventfd (0, EFD_NONBLOCK);
826 err = clib_error_return_unix (0, "eventfd");
830 t.read_function = linux_pci_vfio_msix_read_ready;
831 t.file_descriptor = irq->fd;
832 t.error_function = linux_pci_vfio_error_ready;
833 t.private_data = p->handle << 16 | i;
834 t.description = format (0, "PCI %U MSI-X #%u", format_vlib_pci_addr,
836 irq->clib_file_index = clib_file_add (&file_main, &t);
837 irq->msix_handler = msix_handler;
845 linux_pci_irq_t *irq = vec_elt_at_index (p->msix_irqs, i);
848 clib_file_del_by_index (&file_main, irq->clib_file_index);
857 vlib_pci_enable_msix_irq (vlib_main_t * vm, vlib_pci_dev_handle_t h,
858 u16 start, u16 count)
860 linux_pci_device_t *p = linux_pci_get_device (h);
864 if (p->type != LINUX_PCI_DEVICE_TYPE_VFIO)
865 return clib_error_return (0, "vfio driver is needed for MSI-X interrupt "
868 for (i = start; i < start + count; i++)
870 linux_pci_irq_t *irq = vec_elt_at_index (p->msix_irqs, i);
874 return vfio_set_irqs (vm, p, VFIO_PCI_MSIX_IRQ_INDEX, start, count,
875 VFIO_IRQ_SET_ACTION_TRIGGER, fds);
879 vlib_pci_disable_msix_irq (vlib_main_t * vm, vlib_pci_dev_handle_t h,
880 u16 start, u16 count)
882 linux_pci_device_t *p = linux_pci_get_device (h);
885 if (p->type != LINUX_PCI_DEVICE_TYPE_VFIO)
886 return clib_error_return (0, "vfio driver is needed for MSI-X interrupt "
889 for (i = start; i < start + count; i++)
892 return vfio_set_irqs (vm, p, VFIO_PCI_MSIX_IRQ_INDEX, start, count,
893 VFIO_IRQ_SET_ACTION_TRIGGER, fds);
896 static clib_error_t *
897 add_device_vfio (vlib_main_t * vm, linux_pci_device_t * p,
898 vlib_pci_device_info_t * di, pci_device_registration_t * r)
900 linux_pci_main_t *lpm = &linux_pci_main;
901 struct vfio_device_info device_info = { 0 };
902 struct vfio_region_info reg = { 0 };
903 clib_error_t *err = 0;
907 p->type = LINUX_PCI_DEVICE_TYPE_VFIO;
909 if ((err = linux_vfio_group_get_device_fd (&p->addr, &p->fd, &is_noiommu)))
913 p->supports_va_dma = 1;
915 device_info.argsz = sizeof (device_info);
916 if (ioctl (p->fd, VFIO_DEVICE_GET_INFO, &device_info) < 0)
918 err = clib_error_return_unix (0, "ioctl(VFIO_DEVICE_GET_INFO) '%U'",
919 format_vlib_pci_addr, &di->addr);
923 reg.argsz = sizeof (struct vfio_region_info);
924 reg.index = VFIO_PCI_CONFIG_REGION_INDEX;
925 if (ioctl (p->fd, VFIO_DEVICE_GET_REGION_INFO, ®) < 0)
927 err = clib_error_return_unix (0, "ioctl(VFIO_DEVICE_GET_INFO) '%U'",
928 format_vlib_pci_addr, &di->addr);
932 pci_log_debug (vm, p, "%s region_info index:%u size:0x%lx offset:0x%lx "
933 "flags: %s%s%s(0x%x)", __func__,
934 reg.index, reg.size, reg.offset,
935 reg.flags & VFIO_REGION_INFO_FLAG_READ ? "rd " : "",
936 reg.flags & VFIO_REGION_INFO_FLAG_WRITE ? "wr " : "",
937 reg.flags & VFIO_REGION_INFO_FLAG_MMAP ? "mmap " : "",
940 p->config_offset = reg.offset;
941 p->config_fd = p->fd;
943 /* reset if device supports it */
944 if (device_info.flags & VFIO_DEVICE_FLAGS_RESET)
945 if (ioctl (p->fd, VFIO_DEVICE_RESET) < 0)
947 err = clib_error_return_unix (0, "ioctl(VFIO_DEVICE_RESET) '%U'",
948 format_vlib_pci_addr, &di->addr);
952 if (r && r->interrupt_handler)
954 vlib_pci_register_intx_handler (vm, p->handle, r->interrupt_handler);
955 linux_pci_vfio_unmask_intx (vm, p);
958 if (p->supports_va_dma)
960 vlib_buffer_pool_t *bp;
962 vec_foreach (bp, buffer_main.buffer_pools)
965 vlib_physmem_map_t *pm;
966 pm = vlib_physmem_get_map (vm, bp->physmem_map_index);
967 for (i = 0; i < pm->n_pages; i++)
968 vfio_map_physmem_page (vm, pm->base + (i << pm->log2_page_size));
973 if (r && r->init_function)
974 err = r->init_function (lpm->vlib_main, p->handle);
982 if (p->config_fd != -1 && p->config_fd != p->fd)
983 close (p->config_fd);
984 p->config_fd = p->fd = -1;
989 /* Configuration space read/write. */
991 vlib_pci_read_write_config (vlib_main_t * vm, vlib_pci_dev_handle_t h,
992 vlib_read_or_write_t read_or_write,
993 uword address, void *data, u32 n_bytes)
995 linux_pci_device_t *p = linux_pci_get_device (h);
998 if (read_or_write == VLIB_READ)
999 n = pread (p->config_fd, data, n_bytes, p->config_offset + address);
1001 n = pwrite (p->config_fd, data, n_bytes, p->config_offset + address);
1004 return clib_error_return_unix (0, "%s",
1005 read_or_write == VLIB_READ
1006 ? "read" : "write");
1011 static clib_error_t *
1012 vlib_pci_region (vlib_main_t * vm, vlib_pci_dev_handle_t h, u32 bar, int *fd,
1013 u64 * size, u64 * offset)
1015 linux_pci_device_t *p = linux_pci_get_device (h);
1016 clib_error_t *error = 0;
1018 u64 _size = 0, _offset = 0;
1024 if (p->type == LINUX_PCI_DEVICE_TYPE_UIO)
1027 struct stat stat_buf;
1028 file_name = format (0, "%s/%U/resource%d%c", sysfs_pci_dev_path,
1029 format_vlib_pci_addr, &p->addr, bar, 0);
1031 _fd = open ((char *) file_name, O_RDWR);
1034 error = clib_error_return_unix (0, "open `%s'", file_name);
1035 vec_free (file_name);
1039 if (fstat (_fd, &stat_buf) < 0)
1041 error = clib_error_return_unix (0, "fstat `%s'", file_name);
1042 vec_free (file_name);
1047 vec_free (file_name);
1048 _size = stat_buf.st_size;
1051 else if (p->type == LINUX_PCI_DEVICE_TYPE_VFIO)
1053 struct vfio_region_info reg = { 0 };
1054 reg.argsz = sizeof (struct vfio_region_info);
1056 if (ioctl (p->fd, VFIO_DEVICE_GET_REGION_INFO, ®) < 0)
1057 return clib_error_return_unix (0, "ioctl(VFIO_DEVICE_GET_INFO) "
1058 "'%U'", format_vlib_pci_addr,
1062 _offset = reg.offset;
1063 pci_log_debug (vm, p, "%s region_info index:%u size:0x%lx offset:0x%lx "
1064 "flags: %s%s%s(0x%x)", __func__,
1065 reg.index, reg.size, reg.offset,
1066 reg.flags & VFIO_REGION_INFO_FLAG_READ ? "rd " : "",
1067 reg.flags & VFIO_REGION_INFO_FLAG_WRITE ? "wr " : "",
1068 reg.flags & VFIO_REGION_INFO_FLAG_MMAP ? "mmap " : "",
1081 static clib_error_t *
1082 vlib_pci_map_region_int (vlib_main_t * vm, vlib_pci_dev_handle_t h,
1083 u32 bar, u8 * addr, void **result)
1085 linux_pci_device_t *p = linux_pci_get_device (h);
1087 clib_error_t *error;
1088 int flags = MAP_SHARED;
1089 u64 size = 0, offset = 0;
1091 pci_log_debug (vm, p, "map region %u to va %p", bar, addr);
1093 if ((error = vlib_pci_region (vm, h, bar, &fd, &size, &offset)))
1096 if (p->type == LINUX_PCI_DEVICE_TYPE_UIO && addr != 0)
1099 *result = mmap (addr, size, PROT_READ | PROT_WRITE, flags, fd, offset);
1100 if (*result == (void *) -1)
1102 error = clib_error_return_unix (0, "mmap `BAR%u'", bar);
1103 if (p->type == LINUX_PCI_DEVICE_TYPE_UIO)
1109 vec_validate_init_empty (p->regions, bar,
1110 (linux_pci_region_t) { .fd = -1});
1112 if (p->type == LINUX_PCI_DEVICE_TYPE_UIO)
1113 p->regions[bar].fd = fd;
1114 p->regions[bar].addr = *result;
1115 p->regions[bar].size = size;
1120 vlib_pci_map_region (vlib_main_t * vm, vlib_pci_dev_handle_t h, u32 resource,
1123 return (vlib_pci_map_region_int (vm, h, resource, 0 /* addr */ , result));
1127 vlib_pci_map_region_fixed (vlib_main_t * vm, vlib_pci_dev_handle_t h,
1128 u32 resource, u8 * addr, void **result)
1130 return (vlib_pci_map_region_int (vm, h, resource, addr, result));
1134 vlib_pci_io_region (vlib_main_t * vm, vlib_pci_dev_handle_t h, u32 resource)
1136 linux_pci_device_t *p = linux_pci_get_device (h);
1137 clib_error_t *error = 0;
1139 u64 size = 0, offset = 0;
1141 if ((error = vlib_pci_region (vm, h, resource, &fd, &size, &offset)))
1145 p->io_offset = offset;
1150 vlib_pci_read_write_io (vlib_main_t * vm, vlib_pci_dev_handle_t h,
1151 vlib_read_or_write_t read_or_write,
1152 uword offset, void *data, u32 length)
1154 linux_pci_device_t *p = linux_pci_get_device (h);
1157 if (read_or_write == VLIB_READ)
1158 n = pread (p->io_fd, data, length, p->io_offset + offset);
1160 n = pwrite (p->io_fd, data, length, p->io_offset + offset);
1163 return clib_error_return_unix (0, "%s",
1164 read_or_write == VLIB_READ
1165 ? "read" : "write");
1170 vlib_pci_map_dma (vlib_main_t * vm, vlib_pci_dev_handle_t h, void *ptr)
1172 linux_pci_device_t *p = linux_pci_get_device (h);
1174 if (!p->supports_va_dma)
1177 return vfio_map_physmem_page (vm, ptr);
1181 vlib_pci_supports_virtual_addr_dma (vlib_main_t * vm, vlib_pci_dev_handle_t h)
1183 linux_pci_device_t *p = linux_pci_get_device (h);
1185 return p->supports_va_dma != 0;
1189 vlib_pci_device_open (vlib_main_t * vm, vlib_pci_addr_t * addr,
1190 pci_device_id_t ids[], vlib_pci_dev_handle_t * handle)
1192 linux_pci_main_t *lpm = &linux_pci_main;
1193 vlib_pci_device_info_t *di;
1194 linux_pci_device_t *p;
1195 clib_error_t *err = 0;
1198 di = vlib_pci_get_device_info (vm, addr, &err);
1202 for (i = ids; i->vendor_id != 0; i++)
1203 if (i->vendor_id == di->vendor_id && i->device_id == di->device_id)
1206 if (i->vendor_id == 0)
1207 return clib_error_return (0, "Wrong vendor or device id");
1209 pool_get (lpm->linux_pci_devices, p);
1210 p->handle = p - lpm->linux_pci_devices;
1211 p->addr.as_u32 = di->addr.as_u32;
1212 p->intx_irq.fd = -1;
1214 * pci io bar read/write fd
1218 pci_log_debug (vm, p, "open vid:0x%04x did:0x%04x driver:%s iommu_group:%d",
1219 di->vendor_id, di->device_id, di->driver_name,
1222 if (strncmp ("vfio-pci", (char *) di->driver_name, 8) == 0)
1223 err = add_device_vfio (vm, p, di, 0);
1224 else if (strncmp ("uio_pci_generic", (char *) di->driver_name, 8) == 0)
1225 err = add_device_uio (vm, p, di, 0);
1227 err = clib_error_create ("device not bound to 'vfio-pci' or "
1228 "'uio_pci_generic' kernel module");
1232 *handle = p->handle;
1235 vlib_pci_free_device_info (di);
1238 pci_log_err (vm, p, "%U", format_clib_error, err);
1239 clib_memset (p, 0, sizeof (linux_pci_device_t));
1240 pool_put (lpm->linux_pci_devices, p);
1247 vlib_pci_device_close (vlib_main_t * vm, vlib_pci_dev_handle_t h)
1249 linux_pci_main_t *lpm = &linux_pci_main;
1250 linux_pci_device_t *p = linux_pci_get_device (h);
1251 linux_pci_irq_t *irq;
1252 linux_pci_region_t *res;
1253 clib_error_t *err = 0;
1255 if (p->type == LINUX_PCI_DEVICE_TYPE_UIO)
1258 clib_file_del_by_index (&file_main, irq->clib_file_index);
1259 close (p->config_fd);
1263 else if (p->type == LINUX_PCI_DEVICE_TYPE_VFIO)
1266 /* close INTx irqs */
1269 err = vfio_set_irqs (vm, p, VFIO_PCI_INTX_IRQ_INDEX, 0, 0,
1270 VFIO_IRQ_SET_ACTION_TRIGGER, 0);
1271 clib_error_free (err);
1272 clib_file_del_by_index (&file_main, irq->clib_file_index);
1276 /* close MSI-X irqs */
1277 if (vec_len (p->msix_irqs))
1279 err = vfio_set_irqs (vm, p, VFIO_PCI_MSIX_IRQ_INDEX, 0, 0,
1280 VFIO_IRQ_SET_ACTION_TRIGGER, 0);
1281 clib_error_free (err);
1283 vec_foreach (irq, p->msix_irqs)
1287 clib_file_del_by_index (&file_main, irq->clib_file_index);
1291 vec_free (p->msix_irqs);
1296 vec_foreach (res, p->regions)
1300 munmap (res->addr, res->size);
1305 vec_free (p->regions);
1308 clib_memset (p, 0, sizeof (linux_pci_device_t));
1309 pool_put (lpm->linux_pci_devices, p);
1313 init_device_from_registered (vlib_main_t * vm, vlib_pci_device_info_t * di)
1315 vlib_pci_main_t *pm = &pci_main;
1316 linux_pci_main_t *lpm = &linux_pci_main;
1317 pci_device_registration_t *r;
1319 clib_error_t *err = 0;
1320 linux_pci_device_t *p;
1322 pool_get (lpm->linux_pci_devices, p);
1323 p->handle = p - lpm->linux_pci_devices;
1324 p->intx_irq.fd = -1;
1326 r = pm->pci_device_registrations;
1330 for (i = r->supported_devices; i->vendor_id != 0; i++)
1331 if (i->vendor_id == di->vendor_id && i->device_id == di->device_id)
1333 if (di->iommu_group != -1)
1334 err = add_device_vfio (vm, p, di, r);
1336 err = add_device_uio (vm, p, di, r);
1339 clib_error_report (err);
1343 r = r->next_registration;
1346 /* No driver, close the PCI config-space FD */
1347 clib_memset (p, 0, sizeof (linux_pci_device_t));
1348 pool_put (lpm->linux_pci_devices, p);
1351 static clib_error_t *
1352 scan_pci_addr (void *arg, u8 * dev_dir_name, u8 * ignored)
1354 vlib_pci_addr_t addr, **addrv = arg;
1355 unformat_input_t input;
1356 clib_error_t *err = 0;
1358 unformat_init_string (&input, (char *) dev_dir_name,
1359 vec_len (dev_dir_name));
1361 if (!unformat (&input, "/sys/bus/pci/devices/%U",
1362 unformat_vlib_pci_addr, &addr))
1363 err = clib_error_return (0, "unformat error `%v`", dev_dir_name);
1365 unformat_free (&input);
1370 vec_add1 (*addrv, addr);
1375 pci_addr_cmp (void *v1, void *v2)
1377 vlib_pci_addr_t *a1 = v1;
1378 vlib_pci_addr_t *a2 = v2;
1380 if (a1->domain > a2->domain)
1382 if (a1->domain < a2->domain)
1384 if (a1->bus > a2->bus)
1386 if (a1->bus < a2->bus)
1388 if (a1->slot > a2->slot)
1390 if (a1->slot < a2->slot)
1392 if (a1->function > a2->function)
1394 if (a1->function < a2->function)
1400 vlib_pci_get_all_dev_addrs ()
1402 vlib_pci_addr_t *addrs = 0;
1404 err = foreach_directory_file ((char *) sysfs_pci_dev_path, scan_pci_addr,
1405 &addrs, /* scan_dirs */ 0);
1412 vec_sort_with_function (addrs, pci_addr_cmp);
1418 linux_pci_init (vlib_main_t * vm)
1420 vlib_pci_main_t *pm = &pci_main;
1421 vlib_pci_addr_t *addr = 0, *addrs;
1422 clib_error_t *error;
1426 if ((error = vlib_call_init_function (vm, unix_input_init)))
1429 ASSERT (sizeof (vlib_pci_addr_t) == sizeof (u32));
1431 addrs = vlib_pci_get_all_dev_addrs ();
1433 vec_foreach (addr, addrs)
1435 vlib_pci_device_info_t *d;
1436 if ((d = vlib_pci_get_device_info (vm, addr, 0)))
1438 init_device_from_registered (vm, d);
1439 vlib_pci_free_device_info (d);
1447 VLIB_INIT_FUNCTION (linux_pci_init);
1450 * fd.io coding-style-patch-verification: ON
1453 * eval: (c-set-style "gnu")