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 /* Minor device for uio device. */
114 /* Interrupt handlers */
115 linux_pci_irq_t intx_irq;
116 linux_pci_irq_t *msix_irqs;
123 } linux_pci_device_t;
125 /* Pool of PCI devices. */
128 vlib_main_t *vlib_main;
129 linux_pci_device_t *linux_pci_devices;
133 extern linux_pci_main_t linux_pci_main;
135 static linux_pci_device_t *
136 linux_pci_get_device (vlib_pci_dev_handle_t h)
138 linux_pci_main_t *lpm = &linux_pci_main;
139 return pool_elt_at_index (lpm->linux_pci_devices, h);
143 vlib_pci_get_private_data (vlib_main_t * vm, vlib_pci_dev_handle_t h)
145 linux_pci_device_t *d = linux_pci_get_device (h);
146 return d->private_data;
150 vlib_pci_set_private_data (vlib_main_t * vm, vlib_pci_dev_handle_t h,
153 linux_pci_device_t *d = linux_pci_get_device (h);
154 d->private_data = private_data;
158 vlib_pci_get_addr (vlib_main_t * vm, vlib_pci_dev_handle_t h)
160 linux_pci_device_t *d = linux_pci_get_device (h);
164 /* Call to allocate/initialize the pci subsystem.
165 This is not an init function so that users can explicitly enable
166 pci only when it's needed. */
167 clib_error_t *pci_bus_init (vlib_main_t * vm);
169 linux_pci_main_t linux_pci_main;
171 vlib_pci_device_info_t *
172 vlib_pci_get_device_info (vlib_main_t * vm, vlib_pci_addr_t * addr,
173 clib_error_t ** error)
175 linux_vfio_main_t *lvm = &vfio_main;
177 vlib_pci_device_info_t *di;
182 di = clib_mem_alloc (sizeof (vlib_pci_device_info_t));
183 clib_memset (di, 0, sizeof (vlib_pci_device_info_t));
184 di->addr.as_u32 = addr->as_u32;
186 u8 *dev_dir_name = format (0, "%s/%U", sysfs_pci_dev_path,
187 format_vlib_pci_addr, addr);
189 f = format (0, "%v/config%c", dev_dir_name, 0);
190 fd = open ((char *) f, O_RDWR);
192 /* Try read-only access if write fails. */
194 fd = open ((char *) f, O_RDONLY);
198 err = clib_error_return_unix (0, "open `%s'", f);
202 /* You can only read more that 64 bytes of config space as root; so we try to
203 read the full space but fall back to just the first 64 bytes. */
204 if (read (fd, &di->config_data, sizeof (di->config_data)) <
205 sizeof (di->config0))
207 err = clib_error_return_unix (0, "read `%s'", f);
213 static pci_config_header_t all_ones;
214 if (all_ones.vendor_id == 0)
215 clib_memset (&all_ones, ~0, sizeof (all_ones));
217 if (!memcmp (&di->config0.header, &all_ones, sizeof (all_ones)))
219 err = clib_error_return (0, "invalid PCI config for `%s'", f);
225 if (di->config0.header.header_type == 0)
226 pci_config_type0_little_to_host (&di->config0);
228 pci_config_type1_little_to_host (&di->config1);
231 vec_reset_length (f);
232 f = format (f, "%v/numa_node%c", dev_dir_name, 0);
233 err = clib_sysfs_read ((char *) f, "%u", &di->numa_node);
237 clib_error_free (err);
240 vec_reset_length (f);
241 f = format (f, "%v/class%c", dev_dir_name, 0);
242 err = clib_sysfs_read ((char *) f, "0x%x", &tmp);
245 di->device_class = tmp >> 8;
247 vec_reset_length (f);
248 f = format (f, "%v/vendor%c", dev_dir_name, 0);
249 err = clib_sysfs_read ((char *) f, "0x%x", &tmp);
254 vec_reset_length (f);
255 f = format (f, "%v/device%c", dev_dir_name, 0);
256 err = clib_sysfs_read ((char *) f, "0x%x", &tmp);
261 vec_reset_length (f);
262 f = format (f, "%v/driver%c", dev_dir_name, 0);
263 di->driver_name = clib_sysfs_link_to_name ((char *) f);
265 di->iommu_group = -1;
266 if (lvm->container_fd != -1)
269 vec_reset_length (f);
270 f = format (f, "%v/iommu_group%c", dev_dir_name, 0);
271 tmpstr = clib_sysfs_link_to_name ((char *) f);
274 di->iommu_group = atoi ((char *) tmpstr);
277 vec_reset_length (f);
278 f = format (f, "%v/iommu_group/name%c", dev_dir_name, 0);
279 err = clib_sysfs_read ((char *) f, "%s", &tmpstr);
282 if (strncmp ((char *) tmpstr, "vfio-noiommu", 12) == 0)
283 di->flags |= VLIB_PCI_DEVICE_INFO_F_NOIOMMU;
287 clib_error_free (err);
292 vec_reset_length (f);
293 f = format (f, "%v/vpd%c", dev_dir_name, 0);
294 fd = open ((char *) f, O_RDONLY);
303 if (read (fd, &tag, 3) != 3)
306 if (tag[0] != 0x82 && tag[0] != 0x90 && tag[0] != 0x91)
309 len = (tag[2] << 8) | tag[1];
310 vec_validate (data, len);
312 if (read (fd, data, len) != len)
318 di->product_name = data;
319 else if (tag[0] == 0x90)
321 else if (tag[0] == 0x91)
332 vlib_pci_free_device_info (di);
337 vec_free (dev_dir_name);
341 clib_error_free (err);
346 directory_exists (char *path)
348 struct stat s = { 0 };
349 if (stat (path, &s) == -1)
352 return S_ISDIR (s.st_mode);
356 vlib_pci_bind_to_uio (vlib_main_t * vm, vlib_pci_addr_t * addr,
359 clib_error_t *error = 0;
360 u8 *s = 0, *driver_name = 0;
363 vlib_pci_device_info_t *di;
364 int fd, clear_driver_override = 0;
365 u8 *dev_dir_name = format (0, "%s/%U", sysfs_pci_dev_path,
366 format_vlib_pci_addr, addr);
368 di = vlib_pci_get_device_info (vm, addr, &error);
373 if (strncmp ("auto", uio_drv_name, 5) == 0)
375 int vfio_pci_loaded = 0;
377 if (directory_exists ("/sys/module/vfio_pci"))
380 if (di->iommu_group != -1)
382 /* device is bound to IOMMU group */
383 if (!vfio_pci_loaded)
385 error = clib_error_return (0, "Skipping PCI device %U: device "
386 "is bound to IOMMU group and "
387 "vfio-pci driver is not loaded",
388 format_vlib_pci_addr, addr);
392 uio_drv_name = "vfio-pci";
396 /* device is not bound to IOMMU group so we have multiple options */
397 if (vfio_pci_loaded &&
398 (error = clib_sysfs_write (sysfs_mod_vfio_noiommu, "Y")) == 0)
399 uio_drv_name = "vfio-pci";
400 else if (directory_exists ("/sys/module/uio_pci_generic"))
401 uio_drv_name = "uio_pci_generic";
402 else if (directory_exists ("/sys/module/igb_uio"))
403 uio_drv_name = "igb_uio";
406 clib_error_free (error);
407 error = clib_error_return (0, "Skipping PCI device %U: missing "
408 "kernel VFIO or UIO driver",
409 format_vlib_pci_addr, addr);
412 clib_error_free (error);
416 s = format (s, "%v/driver%c", dev_dir_name, 0);
417 driver_name = clib_sysfs_link_to_name ((char *) s);
418 vec_reset_length (s);
421 ((strcmp ("vfio-pci", (char *) driver_name) == 0) ||
422 (strcmp ("uio_pci_generic", (char *) driver_name) == 0) ||
423 (strcmp ("igb_uio", (char *) driver_name) == 0)))
426 /* walk trough all linux interfaces and if interface belonging to
427 this device is founf check if interface is admin up */
428 dir = opendir ("/sys/class/net");
429 s = format (s, "%U%c", format_vlib_pci_addr, addr, 0);
433 error = clib_error_return (0, "Skipping PCI device %U: failed to "
434 "read /sys/class/net",
435 format_vlib_pci_addr, addr);
439 fd = socket (PF_INET, SOCK_DGRAM, 0);
442 error = clib_error_return_unix (0, "socket");
446 while ((e = readdir (dir)))
449 struct ethtool_drvinfo drvinfo;
451 if (e->d_name[0] == '.') /* skip . and .. */
454 clib_memset (&ifr, 0, sizeof ifr);
455 clib_memset (&drvinfo, 0, sizeof drvinfo);
456 ifr.ifr_data = (char *) &drvinfo;
457 strncpy (ifr.ifr_name, e->d_name, sizeof (ifr.ifr_name));
458 ifr.ifr_name[ARRAY_LEN (ifr.ifr_name) - 1] = '\0';
459 drvinfo.cmd = ETHTOOL_GDRVINFO;
460 if (ioctl (fd, SIOCETHTOOL, &ifr) < 0)
462 /* Some interfaces (eg "lo") don't support this ioctl */
463 if ((errno != ENOTSUP) && (errno != ENODEV))
464 clib_unix_warning ("ioctl fetch intf %s bus info error",
469 if (strcmp ((char *) s, drvinfo.bus_info))
472 clib_memset (&ifr, 0, sizeof (ifr));
473 strncpy (ifr.ifr_name, e->d_name, sizeof (ifr.ifr_name));
474 ifr.ifr_name[ARRAY_LEN (ifr.ifr_name) - 1] = '\0';
475 if (ioctl (fd, SIOCGIFFLAGS, &ifr) < 0)
477 error = clib_error_return_unix (0, "ioctl fetch intf %s flags",
483 if (ifr.ifr_flags & IFF_UP)
485 error = clib_error_return (0, "Skipping PCI device %U as host "
486 "interface %s is up",
487 format_vlib_pci_addr, addr, e->d_name);
494 vec_reset_length (s);
496 s = format (s, "%v/driver/unbind%c", dev_dir_name, 0);
497 clib_sysfs_write ((char *) s, "%U", format_vlib_pci_addr, addr);
498 vec_reset_length (s);
500 s = format (s, "%v/driver_override%c", dev_dir_name, 0);
501 if (access ((char *) s, F_OK) == 0)
503 clib_sysfs_write ((char *) s, "%s", uio_drv_name);
504 clear_driver_override = 1;
508 vec_reset_length (s);
509 s = format (s, "%s/%s/new_id%c", sysfs_pci_drv_path, uio_drv_name, 0);
510 clib_sysfs_write ((char *) s, "0x%04x 0x%04x", di->vendor_id,
513 vec_reset_length (s);
515 s = format (s, "%s/%s/bind%c", sysfs_pci_drv_path, uio_drv_name, 0);
516 clib_sysfs_write ((char *) s, "%U", format_vlib_pci_addr, addr);
517 vec_reset_length (s);
519 if (clear_driver_override)
521 s = format (s, "%v/driver_override%c", dev_dir_name, 0);
522 clib_sysfs_write ((char *) s, "%c", 0);
523 vec_reset_length (s);
529 vec_free (dev_dir_name);
530 vec_free (driver_name);
535 static clib_error_t *
536 scan_uio_dir (void *arg, u8 * path_name, u8 * file_name)
538 linux_pci_device_t *l = arg;
539 unformat_input_t input;
541 unformat_init_string (&input, (char *) file_name, vec_len (file_name));
543 if (!unformat (&input, "uio%d", &l->uio_minor))
546 unformat_free (&input);
550 static clib_error_t *
551 vfio_set_irqs (vlib_main_t * vm, linux_pci_device_t * p, u32 index, u32 start,
552 u32 count, u32 flags, int *efds)
554 int data_len = efds ? count * sizeof (int) : 0;
555 u8 buf[sizeof (struct vfio_irq_set) + data_len];
556 struct vfio_irq_info ii = { 0 };
557 struct vfio_irq_set *irq_set = (struct vfio_irq_set *) buf;
560 ii.argsz = sizeof (struct vfio_irq_info);
563 if (ioctl (p->fd, VFIO_DEVICE_GET_IRQ_INFO, &ii) < 0)
564 return clib_error_return_unix (0, "ioctl(VFIO_DEVICE_GET_IRQ_INFO) "
565 "'%U'", format_vlib_pci_addr, &p->addr);
567 pci_log_debug (vm, p, "%s index:%u count:%u flags: %s%s%s%s(0x%x)",
568 __func__, ii.index, ii.count,
569 ii.flags & VFIO_IRQ_INFO_EVENTFD ? "eventfd " : "",
570 ii.flags & VFIO_IRQ_INFO_MASKABLE ? "maskable " : "",
571 ii.flags & VFIO_IRQ_INFO_AUTOMASKED ? "automasked " : "",
572 ii.flags & VFIO_IRQ_INFO_NORESIZE ? "noresize " : "",
575 if (ii.count < start + count)
576 return clib_error_return_unix (0, "vfio_set_irq: unexistng interrupt on "
577 "'%U'", format_vlib_pci_addr, &p->addr);
582 flags |= VFIO_IRQ_SET_DATA_EVENTFD;
583 clib_memcpy (&irq_set->data, efds, data_len);
586 flags |= VFIO_IRQ_SET_DATA_NONE;
588 ASSERT ((flags & (VFIO_IRQ_SET_DATA_NONE | VFIO_IRQ_SET_DATA_EVENTFD)) !=
589 (VFIO_IRQ_SET_DATA_NONE | VFIO_IRQ_SET_DATA_EVENTFD));
591 irq_set->argsz = sizeof (struct vfio_irq_set) + data_len;
592 irq_set->index = index;
593 irq_set->start = start;
594 irq_set->count = count;
595 irq_set->flags = flags;
597 if (ioctl (p->fd, VFIO_DEVICE_SET_IRQS, irq_set) < 0)
598 return clib_error_return_unix (0, "%U:ioctl(VFIO_DEVICE_SET_IRQS) "
599 "[index = %u, start = %u, count = %u, "
601 format_vlib_pci_addr, &p->addr,
602 index, start, count, flags);
606 static clib_error_t *
607 linux_pci_uio_read_ready (clib_file_t * uf)
609 vlib_main_t *vm = vlib_get_main ();
610 int __attribute__ ((unused)) rv;
611 vlib_pci_dev_handle_t h = uf->private_data;
612 linux_pci_device_t *p = linux_pci_get_device (h);
613 linux_pci_irq_t *irq = &p->intx_irq;
616 rv = read (uf->file_descriptor, &icount, 4);
618 if (irq->intx_handler)
619 irq->intx_handler (vm, h);
621 vlib_pci_intr_enable (vm, h);
623 return /* no error */ 0;
626 static clib_error_t *
627 linux_pci_vfio_unmask_intx (vlib_main_t * vm, linux_pci_device_t * d)
629 return vfio_set_irqs (vm, d, VFIO_PCI_INTX_IRQ_INDEX, 0, 1,
630 VFIO_IRQ_SET_ACTION_UNMASK, 0);
633 static clib_error_t *
634 linux_pci_uio_error_ready (clib_file_t * uf)
636 u32 error_index = (u32) uf->private_data;
638 return clib_error_return (0, "pci device %d: error", error_index);
641 static clib_error_t *
642 linux_pci_vfio_msix_read_ready (clib_file_t * uf)
644 vlib_main_t *vm = vlib_get_main ();
645 int __attribute__ ((unused)) rv;
646 vlib_pci_dev_handle_t h = uf->private_data >> 16;
647 u16 line = uf->private_data & 0xffff;
648 linux_pci_device_t *p = linux_pci_get_device (h);
649 linux_pci_irq_t *irq = vec_elt_at_index (p->msix_irqs, line);
652 rv = read (uf->file_descriptor, &icount, sizeof (icount));
654 if (irq->msix_handler)
655 irq->msix_handler (vm, h, line);
657 return /* no error */ 0;
660 static clib_error_t *
661 linux_pci_vfio_intx_read_ready (clib_file_t * uf)
663 vlib_main_t *vm = vlib_get_main ();
664 int __attribute__ ((unused)) rv;
665 vlib_pci_dev_handle_t h = uf->private_data;
666 linux_pci_device_t *p = linux_pci_get_device (h);
667 linux_pci_irq_t *irq = &p->intx_irq;
670 rv = read (uf->file_descriptor, &icount, sizeof (icount));
672 if (irq->intx_handler)
673 irq->intx_handler (vm, h);
675 linux_pci_vfio_unmask_intx (vm, p);
677 return /* no error */ 0;
680 static clib_error_t *
681 linux_pci_vfio_error_ready (clib_file_t * uf)
683 u32 error_index = (u32) uf->private_data;
685 return clib_error_return (0, "pci device %d: error", error_index);
688 static clib_error_t *
689 add_device_uio (vlib_main_t * vm, linux_pci_device_t * p,
690 vlib_pci_device_info_t * di, pci_device_registration_t * r)
692 linux_pci_main_t *lpm = &linux_pci_main;
693 clib_error_t *err = 0;
697 p->type = LINUX_PCI_DEVICE_TYPE_UIO;
699 s = format (s, "%s/%U/config%c", sysfs_pci_dev_path,
700 format_vlib_pci_addr, &di->addr, 0);
702 p->config_fd = open ((char *) s, O_RDWR);
703 p->config_offset = 0;
704 vec_reset_length (s);
706 if (p->config_fd == -1)
708 err = clib_error_return_unix (0, "open '%s'", s);
712 s = format (0, "%s/%U/uio", sysfs_pci_dev_path,
713 format_vlib_pci_addr, &di->addr);
714 foreach_directory_file ((char *) s, scan_uio_dir, p, /* scan_dirs */
716 vec_reset_length (s);
718 s = format (s, "/dev/uio%d%c", p->uio_minor, 0);
719 p->fd = open ((char *) s, O_RDWR);
722 err = clib_error_return_unix (0, "open '%s'", s);
726 if (r && r->interrupt_handler)
727 vlib_pci_register_intx_handler (vm, p->handle, r->interrupt_handler);
729 if (r && r->init_function)
730 err = r->init_function (lpm->vlib_main, p->handle);
736 if (p->config_fd != -1)
737 close (p->config_fd);
745 vlib_pci_register_intx_handler (vlib_main_t * vm, vlib_pci_dev_handle_t h,
746 pci_intx_handler_function_t * intx_handler)
748 linux_pci_device_t *p = linux_pci_get_device (h);
749 clib_file_t t = { 0 };
750 linux_pci_irq_t *irq = &p->intx_irq;
751 ASSERT (irq->fd == -1);
753 if (p->type == LINUX_PCI_DEVICE_TYPE_VFIO)
755 struct vfio_irq_info ii = { 0 };
756 ii.argsz = sizeof (struct vfio_irq_info);
757 ii.index = VFIO_PCI_INTX_IRQ_INDEX;
758 if (ioctl (p->fd, VFIO_DEVICE_GET_IRQ_INFO, &ii) < 0)
759 return clib_error_return_unix (0, "ioctl(VFIO_DEVICE_GET_IRQ_INFO) '"
760 "%U'", format_vlib_pci_addr, &p->addr);
761 pci_log_debug (vm, p, "%s index:%u count:%u flags: %s%s%s%s(0x%x)",
762 __func__, ii.index, ii.count,
763 ii.flags & VFIO_IRQ_INFO_EVENTFD ? "eventfd " : "",
764 ii.flags & VFIO_IRQ_INFO_MASKABLE ? "maskable " : "",
765 ii.flags & VFIO_IRQ_INFO_AUTOMASKED ? "automasked " : "",
766 ii.flags & VFIO_IRQ_INFO_NORESIZE ? "noresize " : "",
769 return clib_error_return (0, "INTx interrupt does not exist on device"
770 "'%U'", format_vlib_pci_addr, &p->addr);
772 irq->fd = eventfd (0, EFD_NONBLOCK);
774 return clib_error_return_unix (0, "eventfd");
776 t.file_descriptor = irq->fd;
777 t.read_function = linux_pci_vfio_intx_read_ready;
779 else if (p->type == LINUX_PCI_DEVICE_TYPE_UIO)
781 t.file_descriptor = p->fd;
782 t.read_function = linux_pci_uio_read_ready;
787 t.error_function = linux_pci_uio_error_ready;
788 t.private_data = p->handle;
789 t.description = format (0, "PCI %U INTx", format_vlib_pci_addr, &p->addr);
790 irq->clib_file_index = clib_file_add (&file_main, &t);
791 irq->intx_handler = intx_handler;
796 vlib_pci_register_msix_handler (vlib_main_t * vm, vlib_pci_dev_handle_t h,
797 u32 start, u32 count,
798 pci_msix_handler_function_t * msix_handler)
800 clib_error_t *err = 0;
801 linux_pci_device_t *p = linux_pci_get_device (h);
804 if (p->type != LINUX_PCI_DEVICE_TYPE_VFIO)
805 return clib_error_return (0, "vfio driver is needed for MSI-X interrupt "
809 vec_validate_init_empty (p->msix_irqs, start + count - 1, (linux_pci_irq_t)
813 for (i = start; i < start + count; i++)
815 clib_file_t t = { 0 };
816 linux_pci_irq_t *irq = vec_elt_at_index (p->msix_irqs, i);
817 ASSERT (irq->fd == -1);
819 irq->fd = eventfd (0, EFD_NONBLOCK);
822 err = clib_error_return_unix (0, "eventfd");
826 t.read_function = linux_pci_vfio_msix_read_ready;
827 t.file_descriptor = irq->fd;
828 t.error_function = linux_pci_vfio_error_ready;
829 t.private_data = p->handle << 16 | i;
830 t.description = format (0, "PCI %U MSI-X #%u", format_vlib_pci_addr,
832 irq->clib_file_index = clib_file_add (&file_main, &t);
833 irq->msix_handler = msix_handler;
841 linux_pci_irq_t *irq = vec_elt_at_index (p->msix_irqs, i);
844 clib_file_del_by_index (&file_main, irq->clib_file_index);
853 vlib_pci_enable_msix_irq (vlib_main_t * vm, vlib_pci_dev_handle_t h,
854 u16 start, u16 count)
856 linux_pci_device_t *p = linux_pci_get_device (h);
860 if (p->type != LINUX_PCI_DEVICE_TYPE_VFIO)
861 return clib_error_return (0, "vfio driver is needed for MSI-X interrupt "
864 for (i = start; i < start + count; i++)
866 linux_pci_irq_t *irq = vec_elt_at_index (p->msix_irqs, i);
870 return vfio_set_irqs (vm, p, VFIO_PCI_MSIX_IRQ_INDEX, start, count,
871 VFIO_IRQ_SET_ACTION_TRIGGER, fds);
875 vlib_pci_disable_msix_irq (vlib_main_t * vm, vlib_pci_dev_handle_t h,
876 u16 start, u16 count)
878 linux_pci_device_t *p = linux_pci_get_device (h);
881 if (p->type != LINUX_PCI_DEVICE_TYPE_VFIO)
882 return clib_error_return (0, "vfio driver is needed for MSI-X interrupt "
885 for (i = start; i < start + count; i++)
888 return vfio_set_irqs (vm, p, VFIO_PCI_MSIX_IRQ_INDEX, start, count,
889 VFIO_IRQ_SET_ACTION_TRIGGER, fds);
892 static clib_error_t *
893 add_device_vfio (vlib_main_t * vm, linux_pci_device_t * p,
894 vlib_pci_device_info_t * di, pci_device_registration_t * r)
896 linux_pci_main_t *lpm = &linux_pci_main;
897 struct vfio_device_info device_info = { 0 };
898 struct vfio_region_info reg = { 0 };
899 clib_error_t *err = 0;
903 p->type = LINUX_PCI_DEVICE_TYPE_VFIO;
905 if ((err = linux_vfio_group_get_device_fd (&p->addr, &p->fd, &is_noiommu)))
909 p->supports_va_dma = 1;
911 device_info.argsz = sizeof (device_info);
912 if (ioctl (p->fd, VFIO_DEVICE_GET_INFO, &device_info) < 0)
914 err = clib_error_return_unix (0, "ioctl(VFIO_DEVICE_GET_INFO) '%U'",
915 format_vlib_pci_addr, &di->addr);
919 reg.argsz = sizeof (struct vfio_region_info);
920 reg.index = VFIO_PCI_CONFIG_REGION_INDEX;
921 if (ioctl (p->fd, VFIO_DEVICE_GET_REGION_INFO, ®) < 0)
923 err = clib_error_return_unix (0, "ioctl(VFIO_DEVICE_GET_INFO) '%U'",
924 format_vlib_pci_addr, &di->addr);
928 pci_log_debug (vm, p, "%s region_info index:%u size:0x%lx offset:0x%lx "
929 "flags: %s%s%s(0x%x)", __func__,
930 reg.index, reg.size, reg.offset,
931 reg.flags & VFIO_REGION_INFO_FLAG_READ ? "rd " : "",
932 reg.flags & VFIO_REGION_INFO_FLAG_WRITE ? "wr " : "",
933 reg.flags & VFIO_REGION_INFO_FLAG_MMAP ? "mmap " : "",
936 p->config_offset = reg.offset;
937 p->config_fd = p->fd;
939 /* reset if device supports it */
940 if (device_info.flags & VFIO_DEVICE_FLAGS_RESET)
941 if (ioctl (p->fd, VFIO_DEVICE_RESET) < 0)
943 err = clib_error_return_unix (0, "ioctl(VFIO_DEVICE_RESET) '%U'",
944 format_vlib_pci_addr, &di->addr);
948 if (r && r->interrupt_handler)
950 vlib_pci_register_intx_handler (vm, p->handle, r->interrupt_handler);
951 linux_pci_vfio_unmask_intx (vm, p);
954 if (r && r->init_function)
955 err = r->init_function (lpm->vlib_main, p->handle);
963 if (p->config_fd != -1 && p->config_fd != p->fd)
964 close (p->config_fd);
965 p->config_fd = p->fd = -1;
970 /* Configuration space read/write. */
972 vlib_pci_read_write_config (vlib_main_t * vm, vlib_pci_dev_handle_t h,
973 vlib_read_or_write_t read_or_write,
974 uword address, void *data, u32 n_bytes)
976 linux_pci_device_t *p = linux_pci_get_device (h);
979 if (read_or_write == VLIB_READ)
980 n = pread (p->config_fd, data, n_bytes, p->config_offset + address);
982 n = pwrite (p->config_fd, data, n_bytes, p->config_offset + address);
985 return clib_error_return_unix (0, "%s",
986 read_or_write == VLIB_READ
992 static clib_error_t *
993 vlib_pci_map_region_int (vlib_main_t * vm, vlib_pci_dev_handle_t h,
994 u32 bar, u8 * addr, void **result)
996 linux_pci_device_t *p = linux_pci_get_device (h);
999 int flags = MAP_SHARED;
1000 u64 size = 0, offset = 0;
1006 pci_log_debug (vm, p, "map region %u to va %p", bar, addr);
1008 if (p->type == LINUX_PCI_DEVICE_TYPE_UIO)
1011 struct stat stat_buf;
1012 file_name = format (0, "%s/%U/resource%d%c", sysfs_pci_dev_path,
1013 format_vlib_pci_addr, &p->addr, bar, 0);
1015 fd = open ((char *) file_name, O_RDWR);
1018 error = clib_error_return_unix (0, "open `%s'", file_name);
1019 vec_free (file_name);
1023 if (fstat (fd, &stat_buf) < 0)
1025 error = clib_error_return_unix (0, "fstat `%s'", file_name);
1026 vec_free (file_name);
1031 vec_free (file_name);
1034 size = stat_buf.st_size;
1037 else if (p->type == LINUX_PCI_DEVICE_TYPE_VFIO)
1039 struct vfio_region_info reg = { 0 };
1040 reg.argsz = sizeof (struct vfio_region_info);
1042 if (ioctl (p->fd, VFIO_DEVICE_GET_REGION_INFO, ®) < 0)
1043 return clib_error_return_unix (0, "ioctl(VFIO_DEVICE_GET_INFO) "
1044 "'%U'", format_vlib_pci_addr,
1048 offset = reg.offset;
1049 pci_log_debug (vm, p, "%s region_info index:%u size:0x%lx offset:0x%lx "
1050 "flags: %s%s%s(0x%x)", __func__,
1051 reg.index, reg.size, reg.offset,
1052 reg.flags & VFIO_REGION_INFO_FLAG_READ ? "rd " : "",
1053 reg.flags & VFIO_REGION_INFO_FLAG_WRITE ? "wr " : "",
1054 reg.flags & VFIO_REGION_INFO_FLAG_MMAP ? "mmap " : "",
1060 *result = mmap (addr, size, PROT_READ | PROT_WRITE, flags, fd, offset);
1061 if (*result == (void *) -1)
1063 error = clib_error_return_unix (0, "mmap `BAR%u'", bar);
1064 if (p->type == LINUX_PCI_DEVICE_TYPE_UIO)
1070 vec_validate_init_empty (p->regions, bar,
1071 (linux_pci_region_t) { .fd = -1});
1073 if (p->type == LINUX_PCI_DEVICE_TYPE_UIO)
1074 p->regions[bar].fd = fd;
1075 p->regions[bar].addr = *result;
1076 p->regions[bar].size = size;
1081 vlib_pci_map_region (vlib_main_t * vm, vlib_pci_dev_handle_t h, u32 resource,
1084 return (vlib_pci_map_region_int (vm, h, resource, 0 /* addr */ , result));
1088 vlib_pci_map_region_fixed (vlib_main_t * vm, vlib_pci_dev_handle_t h,
1089 u32 resource, u8 * addr, void **result)
1091 return (vlib_pci_map_region_int (vm, h, resource, addr, result));
1095 vlib_pci_device_open (vlib_main_t * vm, vlib_pci_addr_t * addr,
1096 pci_device_id_t ids[], vlib_pci_dev_handle_t * handle)
1098 linux_pci_main_t *lpm = &linux_pci_main;
1099 vlib_pci_device_info_t *di;
1100 linux_pci_device_t *p;
1101 clib_error_t *err = 0;
1104 di = vlib_pci_get_device_info (vm, addr, &err);
1108 for (i = ids; i->vendor_id != 0; i++)
1109 if (i->vendor_id == di->vendor_id && i->device_id == di->device_id)
1112 if (i->vendor_id == 0)
1113 return clib_error_return (0, "Wrong vendor or device id");
1115 pool_get (lpm->linux_pci_devices, p);
1116 p->handle = p - lpm->linux_pci_devices;
1117 p->addr.as_u32 = di->addr.as_u32;
1118 p->intx_irq.fd = -1;
1120 pci_log_debug (vm, p, "open vid:0x%04x did:0x%04x driver:%s iommu_group:%d",
1121 di->vendor_id, di->device_id, di->driver_name,
1124 if (strncmp ("vfio-pci", (char *) di->driver_name, 8) == 0)
1125 err = add_device_vfio (vm, p, di, 0);
1126 else if (strncmp ("uio_pci_generic", (char *) di->driver_name, 8) == 0)
1127 err = add_device_uio (vm, p, di, 0);
1129 err = clib_error_create ("device not bound to 'vfio-pci' or "
1130 "'uio_pci_generic' kernel module");
1134 *handle = p->handle;
1137 vlib_pci_free_device_info (di);
1140 pci_log_err (vm, p, "%U", format_clib_error, err);
1141 clib_memset (p, 0, sizeof (linux_pci_device_t));
1142 pool_put (lpm->linux_pci_devices, p);
1149 vlib_pci_device_close (vlib_main_t * vm, vlib_pci_dev_handle_t h)
1151 linux_pci_main_t *lpm = &linux_pci_main;
1152 linux_pci_device_t *p = linux_pci_get_device (h);
1153 linux_pci_irq_t *irq;
1154 linux_pci_region_t *res;
1155 clib_error_t *err = 0;
1157 if (p->type == LINUX_PCI_DEVICE_TYPE_UIO)
1160 clib_file_del_by_index (&file_main, irq->clib_file_index);
1161 close (p->config_fd);
1163 else if (p->type == LINUX_PCI_DEVICE_TYPE_VFIO)
1166 /* close INTx irqs */
1169 err = vfio_set_irqs (vm, p, VFIO_PCI_INTX_IRQ_INDEX, 0, 0,
1170 VFIO_IRQ_SET_ACTION_TRIGGER, 0);
1171 clib_error_free (err);
1172 clib_file_del_by_index (&file_main, irq->clib_file_index);
1176 /* close MSI-X irqs */
1177 if (vec_len (p->msix_irqs))
1179 err = vfio_set_irqs (vm, p, VFIO_PCI_MSIX_IRQ_INDEX, 0, 0,
1180 VFIO_IRQ_SET_ACTION_TRIGGER, 0);
1181 clib_error_free (err);
1183 vec_foreach (irq, p->msix_irqs)
1187 clib_file_del_by_index (&file_main, irq->clib_file_index);
1191 vec_free (p->msix_irqs);
1196 vec_foreach (res, p->regions)
1200 munmap (res->addr, res->size);
1205 vec_free (p->regions);
1208 clib_memset (p, 0, sizeof (linux_pci_device_t));
1209 pool_put (lpm->linux_pci_devices, p);
1213 init_device_from_registered (vlib_main_t * vm, vlib_pci_device_info_t * di)
1215 vlib_pci_main_t *pm = &pci_main;
1216 linux_pci_main_t *lpm = &linux_pci_main;
1217 pci_device_registration_t *r;
1219 clib_error_t *err = 0;
1220 linux_pci_device_t *p;
1222 pool_get (lpm->linux_pci_devices, p);
1223 p->handle = p - lpm->linux_pci_devices;
1224 p->intx_irq.fd = -1;
1226 r = pm->pci_device_registrations;
1230 for (i = r->supported_devices; i->vendor_id != 0; i++)
1231 if (i->vendor_id == di->vendor_id && i->device_id == di->device_id)
1233 if (di->iommu_group != -1)
1234 err = add_device_vfio (vm, p, di, r);
1236 err = add_device_uio (vm, p, di, r);
1239 clib_error_report (err);
1243 r = r->next_registration;
1246 /* No driver, close the PCI config-space FD */
1247 clib_memset (p, 0, sizeof (linux_pci_device_t));
1248 pool_put (lpm->linux_pci_devices, p);
1251 static clib_error_t *
1252 scan_pci_addr (void *arg, u8 * dev_dir_name, u8 * ignored)
1254 vlib_pci_addr_t addr, **addrv = arg;
1255 unformat_input_t input;
1256 clib_error_t *err = 0;
1258 unformat_init_string (&input, (char *) dev_dir_name,
1259 vec_len (dev_dir_name));
1261 if (!unformat (&input, "/sys/bus/pci/devices/%U",
1262 unformat_vlib_pci_addr, &addr))
1263 err = clib_error_return (0, "unformat error `%v`", dev_dir_name);
1265 unformat_free (&input);
1270 vec_add1 (*addrv, addr);
1275 pci_addr_cmp (void *v1, void *v2)
1277 vlib_pci_addr_t *a1 = v1;
1278 vlib_pci_addr_t *a2 = v2;
1280 if (a1->domain > a2->domain)
1282 if (a1->domain < a2->domain)
1284 if (a1->bus > a2->bus)
1286 if (a1->bus < a2->bus)
1288 if (a1->slot > a2->slot)
1290 if (a1->slot < a2->slot)
1292 if (a1->function > a2->function)
1294 if (a1->function < a2->function)
1300 vlib_pci_get_all_dev_addrs ()
1302 vlib_pci_addr_t *addrs = 0;
1304 err = foreach_directory_file ((char *) sysfs_pci_dev_path, scan_pci_addr,
1305 &addrs, /* scan_dirs */ 0);
1312 vec_sort_with_function (addrs, pci_addr_cmp);
1318 linux_pci_init (vlib_main_t * vm)
1320 vlib_pci_main_t *pm = &pci_main;
1321 vlib_pci_addr_t *addr = 0, *addrs;
1322 clib_error_t *error;
1326 if ((error = vlib_call_init_function (vm, unix_input_init)))
1329 ASSERT (sizeof (vlib_pci_addr_t) == sizeof (u32));
1331 addrs = vlib_pci_get_all_dev_addrs ();
1333 vec_foreach (addr, addrs)
1335 vlib_pci_device_info_t *d;
1336 if ((d = vlib_pci_get_device_info (vm, addr, 0)))
1338 init_device_from_registered (vm, d);
1339 vlib_pci_free_device_info (d);
1347 VLIB_INIT_FUNCTION (linux_pci_init);
1350 * fd.io coding-style-patch-verification: ON
1353 * eval: (c-set-style "gnu")