LCOV - code coverage report
Current view: top level - lib/env_dpdk - pci.c (source / functions) Hit Total Coverage
Test: ut_cov_unit.info Lines: 0 677 0.0 %
Date: 2024-12-04 07:59:36 Functions: 0 69 0.0 %

          Line data    Source code
       1             : /*   SPDX-License-Identifier: BSD-3-Clause
       2             :  *   Copyright (C) 2015 Intel Corporation.
       3             :  *   All rights reserved.
       4             :  */
       5             : 
       6             : #include "env_internal.h"
       7             : #include "pci_dpdk.h"
       8             : 
       9             : #include <rte_alarm.h>
      10             : #include <rte_devargs.h>
      11             : #include <rte_pci.h>
      12             : #include "spdk/env.h"
      13             : #include "spdk/log.h"
      14             : #include "spdk/string.h"
      15             : #include "spdk/memory.h"
      16             : 
      17             : #define SYSFS_PCI_DRIVERS       "/sys/bus/pci/drivers"
      18             : 
      19             : #define PCI_CFG_SIZE            256
      20             : #define PCI_EXT_CAP_ID_SN       0x03
      21             : 
      22             : /* DPDK 18.11+ hotplug isn't robust. Multiple apps starting at the same time
      23             :  * might cause the internal IPC to misbehave. Just retry in such case.
      24             :  */
      25             : #define DPDK_HOTPLUG_RETRY_COUNT 4
      26             : 
      27             : /* DPDK alarm/interrupt thread */
      28             : static pthread_mutex_t g_pci_mutex = PTHREAD_MUTEX_INITIALIZER;
      29             : static TAILQ_HEAD(, spdk_pci_device) g_pci_devices = TAILQ_HEAD_INITIALIZER(g_pci_devices);
      30             : /* devices hotplugged on a dpdk thread */
      31             : static TAILQ_HEAD(, spdk_pci_device) g_pci_hotplugged_devices =
      32             :         TAILQ_HEAD_INITIALIZER(g_pci_hotplugged_devices);
      33             : static TAILQ_HEAD(, spdk_pci_driver) g_pci_drivers = TAILQ_HEAD_INITIALIZER(g_pci_drivers);
      34             : static TAILQ_HEAD(, spdk_pci_device_provider) g_pci_device_providers =
      35             :         TAILQ_HEAD_INITIALIZER(g_pci_device_providers);
      36             : 
      37             : int pci_device_init(struct rte_pci_driver *driver, struct rte_pci_device *device);
      38             : int pci_device_fini(struct rte_pci_device *device);
      39             : 
      40             : struct env_devargs {
      41             :         struct rte_bus  *bus;
      42             :         char            name[128];
      43             :         uint64_t        allowed_at;
      44             :         TAILQ_ENTRY(env_devargs) link;
      45             : };
      46             : static TAILQ_HEAD(, env_devargs) g_env_devargs = TAILQ_HEAD_INITIALIZER(g_env_devargs);
      47             : 
      48             : static struct env_devargs *
      49           0 : find_env_devargs(struct rte_bus *bus, const char *name)
      50             : {
      51           0 :         struct env_devargs *da;
      52             : 
      53           0 :         TAILQ_FOREACH(da, &g_env_devargs, link) {
      54           0 :                 if (bus == da->bus && !strcmp(name, da->name)) {
      55           0 :                         return da;
      56             :                 }
      57           0 :         }
      58             : 
      59           0 :         return NULL;
      60           0 : }
      61             : 
      62             : static int
      63           0 : map_bar_rte(struct spdk_pci_device *device, uint32_t bar,
      64             :             void **mapped_addr, uint64_t *phys_addr, uint64_t *size)
      65             : {
      66           0 :         struct rte_mem_resource *res;
      67             : 
      68           0 :         res = dpdk_pci_device_get_mem_resource(device->dev_handle, bar);
      69           0 :         *mapped_addr = res->addr;
      70           0 :         *phys_addr = (uint64_t)res->phys_addr;
      71           0 :         *size = (uint64_t)res->len;
      72             : 
      73           0 :         return 0;
      74           0 : }
      75             : 
      76             : static int
      77           0 : unmap_bar_rte(struct spdk_pci_device *device, uint32_t bar, void *addr)
      78             : {
      79           0 :         return 0;
      80             : }
      81             : 
      82             : static int
      83           0 : cfg_read_rte(struct spdk_pci_device *dev, void *value, uint32_t len, uint32_t offset)
      84             : {
      85           0 :         return dpdk_pci_device_read_config(dev->dev_handle, value, len, offset);
      86             : }
      87             : 
      88             : static int
      89           0 : cfg_write_rte(struct spdk_pci_device *dev, void *value, uint32_t len, uint32_t offset)
      90             : {
      91           0 :         return dpdk_pci_device_write_config(dev->dev_handle, value, len, offset);
      92             : }
      93             : 
      94             : static void
      95           0 : remove_rte_dev(struct rte_pci_device *rte_dev)
      96             : {
      97           0 :         char bdf[32];
      98           0 :         int i = 0, rc;
      99             : 
     100           0 :         snprintf(bdf, sizeof(bdf), "%s", dpdk_pci_device_get_name(rte_dev));
     101           0 :         do {
     102           0 :                 rc = rte_eal_hotplug_remove("pci", bdf);
     103           0 :         } while (rc == -ENOMSG && ++i <= DPDK_HOTPLUG_RETRY_COUNT);
     104           0 : }
     105             : 
     106             : static void
     107           0 : detach_rte_cb(void *_dev)
     108             : {
     109           0 :         remove_rte_dev(_dev);
     110           0 : }
     111             : 
     112             : /* if it's a physical device we need to deal with DPDK on
     113             :  * a different process and we can't just unset one flag
     114             :  * here. We also want to stop using any device resources
     115             :  * so that the device isn't "in use" by the userspace driver
     116             :  * once we detach it. This would allow attaching the device
     117             :  * to a different process, or to a kernel driver like nvme.
     118             :  */
     119             : static void
     120           0 : detach_rte(struct spdk_pci_device *dev)
     121             : {
     122           0 :         struct rte_pci_device *rte_dev = dev->dev_handle;
     123           0 :         int i;
     124           0 :         bool removed;
     125             : 
     126           0 :         if (!spdk_process_is_primary()) {
     127           0 :                 return;
     128             :         }
     129             : 
     130           0 :         pthread_mutex_lock(&g_pci_mutex);
     131           0 :         dev->internal.attached = false;
     132             :         /* prevent the hotremove notification from removing this device */
     133           0 :         dev->internal.pending_removal = true;
     134           0 :         pthread_mutex_unlock(&g_pci_mutex);
     135             : 
     136           0 :         rte_eal_alarm_set(1, detach_rte_cb, rte_dev);
     137             : 
     138             :         /* wait up to 2s for the cb to execute */
     139           0 :         for (i = 2000; i > 0; i--) {
     140             : 
     141           0 :                 spdk_delay_us(1000);
     142           0 :                 pthread_mutex_lock(&g_pci_mutex);
     143           0 :                 removed = dev->internal.removed;
     144           0 :                 pthread_mutex_unlock(&g_pci_mutex);
     145             : 
     146           0 :                 if (removed) {
     147           0 :                         break;
     148             :                 }
     149           0 :         }
     150             : 
     151             :         /* besides checking the removed flag, we also need to wait
     152             :          * for the dpdk detach function to unwind, as it's doing some
     153             :          * operations even after calling our detach callback. Simply
     154             :          * cancel the alarm - if it started executing already, this
     155             :          * call will block and wait for it to finish.
     156             :          */
     157           0 :         rte_eal_alarm_cancel(detach_rte_cb, rte_dev);
     158             : 
     159             :         /* the device could have been finally removed, so just check
     160             :          * it again.
     161             :          */
     162           0 :         pthread_mutex_lock(&g_pci_mutex);
     163           0 :         removed = dev->internal.removed;
     164           0 :         pthread_mutex_unlock(&g_pci_mutex);
     165           0 :         if (!removed) {
     166           0 :                 SPDK_ERRLOG("Timeout waiting for DPDK to remove PCI device %s.\n",
     167             :                             dpdk_pci_device_get_name(rte_dev));
     168             :                 /* If we reach this state, then the device couldn't be removed and most likely
     169             :                    a subsequent hot add of a device in the same BDF will fail */
     170           0 :         }
     171           0 : }
     172             : 
     173             : void
     174           0 : spdk_pci_driver_register(const char *name, struct spdk_pci_id *id_table, uint32_t flags)
     175             : {
     176           0 :         struct spdk_pci_driver *driver;
     177             : 
     178           0 :         driver = calloc(1, sizeof(*driver));
     179           0 :         if (!driver) {
     180             :                 /* we can't do any better than bailing atm */
     181           0 :                 return;
     182             :         }
     183             : 
     184           0 :         driver->name = name;
     185           0 :         driver->id_table = id_table;
     186           0 :         driver->drv_flags = flags;
     187           0 :         driver->driver = (struct rte_pci_driver *)driver->driver_buf;
     188           0 :         TAILQ_INSERT_TAIL(&g_pci_drivers, driver, tailq);
     189           0 : }
     190             : 
     191             : struct spdk_pci_driver *
     192           0 : spdk_pci_nvme_get_driver(void)
     193             : {
     194           0 :         return spdk_pci_get_driver("nvme");
     195             : }
     196             : 
     197             : struct spdk_pci_driver *
     198           0 : spdk_pci_get_driver(const char *name)
     199             : {
     200           0 :         struct spdk_pci_driver *driver;
     201             : 
     202           0 :         TAILQ_FOREACH(driver, &g_pci_drivers, tailq) {
     203           0 :                 if (strcmp(driver->name, name) == 0) {
     204           0 :                         return driver;
     205             :                 }
     206           0 :         }
     207             : 
     208           0 :         return NULL;
     209           0 : }
     210             : 
     211             : static void
     212           0 : pci_device_rte_dev_event(const char *device_name,
     213             :                          enum rte_dev_event_type event,
     214             :                          void *cb_arg)
     215             : {
     216           0 :         struct spdk_pci_device *dev;
     217           0 :         bool can_detach = false;
     218             : 
     219           0 :         switch (event) {
     220             :         default:
     221             :         case RTE_DEV_EVENT_ADD:
     222             :                 /* Nothing to do here yet. */
     223           0 :                 break;
     224             :         case RTE_DEV_EVENT_REMOVE:
     225           0 :                 pthread_mutex_lock(&g_pci_mutex);
     226           0 :                 TAILQ_FOREACH(dev, &g_pci_devices, internal.tailq) {
     227           0 :                         struct rte_pci_device *rte_dev = dev->dev_handle;
     228             : 
     229           0 :                         if (strcmp(dpdk_pci_device_get_name(rte_dev), device_name)) {
     230           0 :                                 continue;
     231             :                         }
     232             : 
     233             :                         /* Note: these ERRLOGs are useful for triaging issue #2983. */
     234           0 :                         if (dev->internal.pending_removal || dev->internal.removed) {
     235           0 :                                 SPDK_ERRLOG("Received event for device SPDK already tried to remove\n");
     236           0 :                                 SPDK_ERRLOG("pending_removal=%d removed=%d\n", dev->internal.pending_removal,
     237             :                                             dev->internal.removed);
     238           0 :                         }
     239             : 
     240           0 :                         if (!dev->internal.pending_removal) {
     241           0 :                                 can_detach = !dev->internal.attached;
     242             :                                 /* prevent any further attaches */
     243           0 :                                 dev->internal.pending_removal = true;
     244           0 :                                 break;
     245             :                         }
     246           0 :                 }
     247           0 :                 pthread_mutex_unlock(&g_pci_mutex);
     248             : 
     249           0 :                 if (can_detach) {
     250             :                         /* if device is not attached we can remove it right away.
     251             :                          * Otherwise it will be removed at detach.
     252             :                          *
     253             :                          * Because the user's callback is invoked in eal interrupt
     254             :                          * callback, the interrupt callback need to be finished before
     255             :                          * it can be unregistered when detaching device. So finish
     256             :                          * callback soon and use a deferred removal to detach device
     257             :                          * is need. It is a workaround, once the device detaching be
     258             :                          * moved into the eal in the future, the deferred removal could
     259             :                          * be deleted.
     260             :                          */
     261           0 :                         assert(dev != NULL);
     262           0 :                         rte_eal_alarm_set(1, detach_rte_cb, dev->dev_handle);
     263           0 :                 }
     264           0 :                 break;
     265             :         }
     266           0 : }
     267             : 
     268             : static void
     269           0 : cleanup_pci_devices(void)
     270             : {
     271           0 :         struct spdk_pci_device *dev, *tmp;
     272             : 
     273           0 :         pthread_mutex_lock(&g_pci_mutex);
     274             :         /* cleanup removed devices */
     275           0 :         TAILQ_FOREACH_SAFE(dev, &g_pci_devices, internal.tailq, tmp) {
     276           0 :                 if (!dev->internal.removed) {
     277           0 :                         continue;
     278             :                 }
     279             : 
     280           0 :                 vtophys_pci_device_removed(dev->dev_handle);
     281           0 :                 TAILQ_REMOVE(&g_pci_devices, dev, internal.tailq);
     282           0 :                 free(dev);
     283           0 :         }
     284             : 
     285             :         /* add newly-attached devices */
     286           0 :         TAILQ_FOREACH_SAFE(dev, &g_pci_hotplugged_devices, internal.tailq, tmp) {
     287           0 :                 TAILQ_REMOVE(&g_pci_hotplugged_devices, dev, internal.tailq);
     288           0 :                 TAILQ_INSERT_TAIL(&g_pci_devices, dev, internal.tailq);
     289           0 :                 vtophys_pci_device_added(dev->dev_handle);
     290           0 :         }
     291           0 :         pthread_mutex_unlock(&g_pci_mutex);
     292           0 : }
     293             : 
     294             : static int scan_pci_bus(bool delay_init);
     295             : 
     296             : static inline void
     297           0 : _pci_env_init(void)
     298             : {
     299             :         /* We assume devices were present on the bus for more than 2 seconds
     300             :          * before initializing SPDK and there's no need to wait more. We scan
     301             :          * the bus, but we don't block any devices.
     302             :          */
     303           0 :         scan_pci_bus(false);
     304             : 
     305             :         /* Register a single hotremove callback for all devices. */
     306           0 :         if (spdk_process_is_primary()) {
     307           0 :                 rte_dev_event_callback_register(NULL, pci_device_rte_dev_event, NULL);
     308           0 :         }
     309           0 : }
     310             : 
     311             : int
     312           0 : pci_env_init(void)
     313             : {
     314           0 :         struct spdk_pci_driver *driver;
     315           0 :         int rc;
     316             : 
     317           0 :         rc = dpdk_pci_init();
     318           0 :         if (rc) {
     319           0 :                 return rc;
     320             :         }
     321             : 
     322           0 :         TAILQ_FOREACH(driver, &g_pci_drivers, tailq) {
     323           0 :                 dpdk_pci_driver_register(driver, pci_device_init, pci_device_fini);
     324           0 :         }
     325             : 
     326           0 :         _pci_env_init();
     327           0 :         return 0;
     328           0 : }
     329             : 
     330             : void
     331           0 : pci_env_reinit(void)
     332             : {
     333             :         /* There is no need to register pci drivers again, since they were
     334             :          * already pre-registered in pci_env_init.
     335             :          */
     336             : 
     337           0 :         _pci_env_init();
     338           0 : }
     339             : 
     340             : void
     341           0 : pci_env_fini(void)
     342             : {
     343           0 :         struct spdk_pci_device *dev;
     344           0 :         char bdf[32];
     345             : 
     346           0 :         cleanup_pci_devices();
     347           0 :         TAILQ_FOREACH(dev, &g_pci_devices, internal.tailq) {
     348           0 :                 if (dev->internal.attached) {
     349           0 :                         spdk_pci_addr_fmt(bdf, sizeof(bdf), &dev->addr);
     350           0 :                         SPDK_ERRLOG("Device %s is still attached at shutdown!\n", bdf);
     351           0 :                 }
     352           0 :         }
     353             : 
     354           0 :         if (spdk_process_is_primary()) {
     355           0 :                 rte_dev_event_callback_unregister(NULL, pci_device_rte_dev_event, NULL);
     356           0 :         }
     357           0 : }
     358             : 
     359             : int
     360           0 : pci_device_init(struct rte_pci_driver *_drv,
     361             :                 struct rte_pci_device *_dev)
     362             : {
     363           0 :         struct spdk_pci_driver *driver = (struct spdk_pci_driver *)_drv;
     364           0 :         struct spdk_pci_device *dev;
     365           0 :         struct rte_pci_addr *addr;
     366           0 :         struct rte_pci_id *id;
     367           0 :         int rc;
     368             : 
     369           0 :         dev = calloc(1, sizeof(*dev));
     370           0 :         if (dev == NULL) {
     371           0 :                 return -1;
     372             :         }
     373             : 
     374           0 :         dev->dev_handle = _dev;
     375             : 
     376           0 :         addr = dpdk_pci_device_get_addr(_dev);
     377           0 :         dev->addr.domain = addr->domain;
     378           0 :         dev->addr.bus = addr->bus;
     379           0 :         dev->addr.dev = addr->devid;
     380           0 :         dev->addr.func = addr->function;
     381             : 
     382           0 :         id = dpdk_pci_device_get_id(_dev);
     383           0 :         dev->id.class_id = id->class_id;
     384           0 :         dev->id.vendor_id = id->vendor_id;
     385           0 :         dev->id.device_id = id->device_id;
     386           0 :         dev->id.subvendor_id = id->subsystem_vendor_id;
     387           0 :         dev->id.subdevice_id = id->subsystem_device_id;
     388             : 
     389           0 :         dev->numa_id = dpdk_pci_device_get_numa_node(_dev);
     390           0 :         dev->type = "pci";
     391             : 
     392           0 :         dev->map_bar = map_bar_rte;
     393           0 :         dev->unmap_bar = unmap_bar_rte;
     394           0 :         dev->cfg_read = cfg_read_rte;
     395           0 :         dev->cfg_write = cfg_write_rte;
     396             : 
     397           0 :         dev->internal.driver = driver;
     398           0 :         dev->internal.claim_fd = -1;
     399             : 
     400           0 :         if (driver->cb_fn != NULL) {
     401           0 :                 rc = driver->cb_fn(driver->cb_arg, dev);
     402           0 :                 if (rc != 0) {
     403           0 :                         free(dev);
     404           0 :                         return rc;
     405             :                 }
     406           0 :                 dev->internal.attached = true;
     407           0 :         }
     408             : 
     409           0 :         pthread_mutex_lock(&g_pci_mutex);
     410           0 :         TAILQ_INSERT_TAIL(&g_pci_hotplugged_devices, dev, internal.tailq);
     411           0 :         pthread_mutex_unlock(&g_pci_mutex);
     412           0 :         return 0;
     413           0 : }
     414             : 
     415             : static void
     416           0 : set_allowed_at(struct rte_devargs *rte_da, uint64_t tsc)
     417             : {
     418           0 :         struct env_devargs *env_da;
     419             : 
     420           0 :         env_da = find_env_devargs(rte_da->bus, rte_da->name);
     421           0 :         if (env_da == NULL) {
     422           0 :                 env_da = calloc(1, sizeof(*env_da));
     423           0 :                 if (env_da == NULL) {
     424           0 :                         SPDK_ERRLOG("could not set_allowed_at for device %s\n", rte_da->name);
     425           0 :                         return;
     426             :                 }
     427           0 :                 env_da->bus = rte_da->bus;
     428           0 :                 spdk_strcpy_pad(env_da->name, rte_da->name, sizeof(env_da->name), 0);
     429           0 :                 TAILQ_INSERT_TAIL(&g_env_devargs, env_da, link);
     430           0 :         }
     431             : 
     432           0 :         env_da->allowed_at = tsc;
     433           0 : }
     434             : 
     435             : static uint64_t
     436           0 : get_allowed_at(struct rte_devargs *rte_da)
     437             : {
     438           0 :         struct env_devargs *env_da;
     439             : 
     440           0 :         env_da = find_env_devargs(rte_da->bus, rte_da->name);
     441           0 :         if (env_da) {
     442           0 :                 return env_da->allowed_at;
     443             :         } else {
     444           0 :                 return 0;
     445             :         }
     446           0 : }
     447             : 
     448             : int
     449           0 : pci_device_fini(struct rte_pci_device *_dev)
     450             : {
     451           0 :         struct spdk_pci_device *dev;
     452             : 
     453           0 :         pthread_mutex_lock(&g_pci_mutex);
     454           0 :         TAILQ_FOREACH(dev, &g_pci_devices, internal.tailq) {
     455           0 :                 if (dev->dev_handle == _dev) {
     456           0 :                         break;
     457             :                 }
     458           0 :         }
     459             : 
     460           0 :         if (dev == NULL || dev->internal.attached) {
     461             :                 /* The device might be still referenced somewhere in SPDK. */
     462           0 :                 pthread_mutex_unlock(&g_pci_mutex);
     463           0 :                 return -EBUSY;
     464             :         }
     465             : 
     466             :         /* remove our allowed_at option */
     467           0 :         if (dpdk_pci_device_get_devargs(_dev)) {
     468           0 :                 set_allowed_at(dpdk_pci_device_get_devargs(_dev), 0);
     469           0 :         }
     470             : 
     471             :         /* It is possible that removed flag was already set when there is a race
     472             :          * between the remove notification for this process, and another process
     473             :          * that is also detaching from this same device (for example, when using
     474             :          * nvme driver in multi-process mode.  So do not assert here.  See
     475             :          * #2456 for additional details.
     476             :          */
     477           0 :         dev->internal.removed = true;
     478           0 :         pthread_mutex_unlock(&g_pci_mutex);
     479           0 :         return 0;
     480             : 
     481           0 : }
     482             : 
     483             : void
     484           0 : spdk_pci_device_detach(struct spdk_pci_device *dev)
     485             : {
     486           0 :         struct spdk_pci_device_provider *provider;
     487             : 
     488           0 :         assert(dev->internal.attached);
     489             : 
     490           0 :         if (dev->internal.claim_fd >= 0) {
     491           0 :                 spdk_pci_device_unclaim(dev);
     492           0 :         }
     493             : 
     494           0 :         TAILQ_FOREACH(provider, &g_pci_device_providers, tailq) {
     495           0 :                 if (strcmp(dev->type, provider->name) == 0) {
     496           0 :                         break;
     497             :                 }
     498           0 :         }
     499             : 
     500           0 :         assert(provider != NULL);
     501           0 :         dev->internal.attached = false;
     502           0 :         provider->detach_cb(dev);
     503             : 
     504           0 :         cleanup_pci_devices();
     505           0 : }
     506             : 
     507             : static int
     508           0 : scan_pci_bus(bool delay_init)
     509             : {
     510           0 :         struct rte_dev_iterator it;
     511           0 :         struct rte_device *rte_dev;
     512           0 :         uint64_t now;
     513             : 
     514           0 :         dpdk_bus_scan();
     515           0 :         now = spdk_get_ticks();
     516             : 
     517           0 :         if (!TAILQ_FIRST(&g_pci_drivers)) {
     518           0 :                 return 0;
     519             :         }
     520             : 
     521           0 :         RTE_DEV_FOREACH(rte_dev, "bus=pci", &it) {
     522           0 :                 struct rte_devargs *da;
     523             : 
     524           0 :                 da = dpdk_device_get_devargs(rte_dev);
     525           0 :                 if (!da) {
     526           0 :                         char devargs_str[128];
     527             : 
     528             :                         /* the device was never blocked or allowed */
     529           0 :                         da = calloc(1, sizeof(*da));
     530           0 :                         if (!da) {
     531           0 :                                 return -1;
     532             :                         }
     533             : 
     534           0 :                         snprintf(devargs_str, sizeof(devargs_str), "pci:%s", dpdk_device_get_name(rte_dev));
     535           0 :                         if (rte_devargs_parse(da, devargs_str) != 0) {
     536           0 :                                 free(da);
     537           0 :                                 return -1;
     538             :                         }
     539             : 
     540           0 :                         rte_devargs_insert(&da);
     541           0 :                         dpdk_device_set_devargs(rte_dev, da);
     542           0 :                 }
     543             : 
     544           0 :                 if (get_allowed_at(da)) {
     545           0 :                         uint64_t allowed_at = get_allowed_at(da);
     546             : 
     547             :                         /* this device was seen by spdk before... */
     548           0 :                         if (da->policy == RTE_DEV_BLOCKED && allowed_at <= now) {
     549           0 :                                 da->policy = RTE_DEV_ALLOWED;
     550           0 :                         }
     551           0 :                 } else if ((dpdk_device_scan_allowed(rte_dev) && da->policy == RTE_DEV_ALLOWED) ||
     552           0 :                            da->policy != RTE_DEV_BLOCKED) {
     553             :                         /* override the policy only if not permanently blocked */
     554             : 
     555           0 :                         if (delay_init) {
     556           0 :                                 da->policy = RTE_DEV_BLOCKED;
     557           0 :                                 set_allowed_at(da, now + 2 * spdk_get_ticks_hz());
     558           0 :                         } else {
     559           0 :                                 da->policy = RTE_DEV_ALLOWED;
     560           0 :                                 set_allowed_at(da, now);
     561             :                         }
     562           0 :                 }
     563           0 :         }
     564             : 
     565           0 :         return 0;
     566           0 : }
     567             : 
     568             : static int
     569           0 : pci_attach_rte(const struct spdk_pci_addr *addr)
     570             : {
     571           0 :         char bdf[32];
     572           0 :         int rc, i = 0;
     573             : 
     574           0 :         spdk_pci_addr_fmt(bdf, sizeof(bdf), addr);
     575             : 
     576           0 :         do {
     577           0 :                 rc = rte_eal_hotplug_add("pci", bdf, "");
     578           0 :         } while (rc == -ENOMSG && ++i <= DPDK_HOTPLUG_RETRY_COUNT);
     579             : 
     580           0 :         if (i > 1 && rc == -EEXIST) {
     581             :                 /* Even though the previous request timed out, the device
     582             :                  * was attached successfully.
     583             :                  */
     584           0 :                 rc = 0;
     585           0 :         }
     586             : 
     587           0 :         return rc;
     588           0 : }
     589             : 
     590             : static struct spdk_pci_device_provider g_pci_rte_provider = {
     591             :         .name = "pci",
     592             :         .attach_cb = pci_attach_rte,
     593             :         .detach_cb = detach_rte,
     594             : };
     595             : 
     596           0 : SPDK_PCI_REGISTER_DEVICE_PROVIDER(pci, &g_pci_rte_provider);
     597             : 
     598             : int
     599           0 : spdk_pci_device_attach(struct spdk_pci_driver *driver,
     600             :                        spdk_pci_enum_cb enum_cb,
     601             :                        void *enum_ctx, struct spdk_pci_addr *pci_address)
     602             : {
     603           0 :         struct spdk_pci_device *dev;
     604           0 :         struct spdk_pci_device_provider *provider;
     605           0 :         struct rte_pci_device *rte_dev;
     606           0 :         struct rte_devargs *da;
     607           0 :         int rc;
     608             : 
     609           0 :         cleanup_pci_devices();
     610             : 
     611           0 :         TAILQ_FOREACH(dev, &g_pci_devices, internal.tailq) {
     612           0 :                 if (spdk_pci_addr_compare(&dev->addr, pci_address) == 0) {
     613           0 :                         break;
     614             :                 }
     615           0 :         }
     616             : 
     617           0 :         if (dev != NULL && dev->internal.driver == driver) {
     618           0 :                 pthread_mutex_lock(&g_pci_mutex);
     619           0 :                 if (dev->internal.attached || dev->internal.pending_removal) {
     620           0 :                         pthread_mutex_unlock(&g_pci_mutex);
     621           0 :                         return -1;
     622             :                 }
     623             : 
     624           0 :                 rc = enum_cb(enum_ctx, dev);
     625           0 :                 if (rc == 0) {
     626           0 :                         dev->internal.attached = true;
     627           0 :                 }
     628           0 :                 pthread_mutex_unlock(&g_pci_mutex);
     629           0 :                 return rc;
     630             :         }
     631             : 
     632           0 :         driver->cb_fn = enum_cb;
     633           0 :         driver->cb_arg = enum_ctx;
     634             : 
     635           0 :         rc = -ENODEV;
     636           0 :         TAILQ_FOREACH(provider, &g_pci_device_providers, tailq) {
     637           0 :                 rc = provider->attach_cb(pci_address);
     638           0 :                 if (rc == 0) {
     639           0 :                         break;
     640             :                 }
     641           0 :         }
     642             : 
     643           0 :         driver->cb_arg = NULL;
     644           0 :         driver->cb_fn = NULL;
     645             : 
     646           0 :         cleanup_pci_devices();
     647             : 
     648           0 :         if (rc != 0) {
     649           0 :                 return -1;
     650             :         }
     651             : 
     652             :         /* explicit attach ignores the allowlist, so if we blocked this
     653             :          * device before let's enable it now - just for clarity.
     654             :          */
     655           0 :         TAILQ_FOREACH(dev, &g_pci_devices, internal.tailq) {
     656           0 :                 if (spdk_pci_addr_compare(&dev->addr, pci_address) == 0) {
     657           0 :                         break;
     658             :                 }
     659           0 :         }
     660           0 :         assert(dev != NULL);
     661             : 
     662           0 :         rte_dev = dev->dev_handle;
     663           0 :         if (rte_dev != NULL) {
     664           0 :                 da = dpdk_pci_device_get_devargs(rte_dev);
     665           0 :                 if (da && get_allowed_at(da)) {
     666           0 :                         set_allowed_at(da, spdk_get_ticks());
     667           0 :                         da->policy = RTE_DEV_ALLOWED;
     668           0 :                 }
     669           0 :         }
     670             : 
     671           0 :         return 0;
     672           0 : }
     673             : 
     674             : /* Note: You can call spdk_pci_enumerate from more than one thread
     675             :  *       simultaneously safely, but you cannot call spdk_pci_enumerate
     676             :  *       and rte_eal_pci_probe simultaneously.
     677             :  */
     678             : int
     679           0 : spdk_pci_enumerate(struct spdk_pci_driver *driver,
     680             :                    spdk_pci_enum_cb enum_cb,
     681             :                    void *enum_ctx)
     682             : {
     683           0 :         struct spdk_pci_device *dev;
     684           0 :         int rc;
     685             : 
     686           0 :         cleanup_pci_devices();
     687             : 
     688           0 :         pthread_mutex_lock(&g_pci_mutex);
     689           0 :         TAILQ_FOREACH(dev, &g_pci_devices, internal.tailq) {
     690           0 :                 if (dev->internal.attached ||
     691           0 :                     dev->internal.driver != driver ||
     692           0 :                     dev->internal.pending_removal) {
     693           0 :                         continue;
     694             :                 }
     695             : 
     696           0 :                 rc = enum_cb(enum_ctx, dev);
     697           0 :                 if (rc == 0) {
     698           0 :                         dev->internal.attached = true;
     699           0 :                 } else if (rc < 0) {
     700           0 :                         pthread_mutex_unlock(&g_pci_mutex);
     701           0 :                         return -1;
     702             :                 }
     703           0 :         }
     704           0 :         pthread_mutex_unlock(&g_pci_mutex);
     705             : 
     706           0 :         if (scan_pci_bus(true) != 0) {
     707           0 :                 return -1;
     708             :         }
     709             : 
     710           0 :         driver->cb_fn = enum_cb;
     711           0 :         driver->cb_arg = enum_ctx;
     712             : 
     713           0 :         if (dpdk_bus_probe() != 0) {
     714           0 :                 driver->cb_arg = NULL;
     715           0 :                 driver->cb_fn = NULL;
     716           0 :                 return -1;
     717             :         }
     718             : 
     719           0 :         driver->cb_arg = NULL;
     720           0 :         driver->cb_fn = NULL;
     721             : 
     722           0 :         cleanup_pci_devices();
     723           0 :         return 0;
     724           0 : }
     725             : 
     726             : void
     727           0 : spdk_pci_for_each_device(void *ctx, void (*fn)(void *ctx, struct spdk_pci_device *dev))
     728             : {
     729           0 :         struct spdk_pci_device *dev, *tmp;
     730             : 
     731           0 :         pthread_mutex_lock(&g_pci_mutex);
     732           0 :         TAILQ_FOREACH_SAFE(dev, &g_pci_devices, internal.tailq, tmp) {
     733           0 :                 fn(ctx, dev);
     734           0 :         }
     735           0 :         pthread_mutex_unlock(&g_pci_mutex);
     736           0 : }
     737             : 
     738             : int
     739           0 : spdk_pci_device_map_bar(struct spdk_pci_device *dev, uint32_t bar,
     740             :                         void **mapped_addr, uint64_t *phys_addr, uint64_t *size)
     741             : {
     742           0 :         int rc;
     743             : 
     744           0 :         rc = dev->map_bar(dev, bar, mapped_addr, phys_addr, size);
     745           0 :         if (rc) {
     746           0 :                 return rc;
     747             :         }
     748             : 
     749             : #if VFIO_ENABLED
     750             :         /* Automatically map the BAR to the IOMMU */
     751           0 :         if (!spdk_iommu_is_enabled()) {
     752           0 :                 return 0;
     753             :         }
     754             : 
     755           0 :         if (rte_eal_iova_mode() == RTE_IOVA_VA) {
     756             :                 /* We'll use the virtual address as the iova to match DPDK. */
     757           0 :                 rc = vtophys_iommu_map_dma_bar((uint64_t)(*mapped_addr), (uint64_t) * mapped_addr, *size);
     758           0 :                 if (rc) {
     759           0 :                         dev->unmap_bar(dev, bar, *mapped_addr);
     760           0 :                         return -EFAULT;
     761             :                 }
     762             : 
     763           0 :                 *phys_addr = (uint64_t)(*mapped_addr);
     764           0 :         } else {
     765             :                 /* We'll use the physical address as the iova to match DPDK. */
     766           0 :                 rc = vtophys_iommu_map_dma_bar((uint64_t)(*mapped_addr), *phys_addr, *size);
     767           0 :                 if (rc) {
     768           0 :                         dev->unmap_bar(dev, bar, *mapped_addr);
     769           0 :                         return -EFAULT;
     770             :                 }
     771             :         }
     772             : #endif
     773           0 :         return rc;
     774           0 : }
     775             : 
     776             : int
     777           0 : spdk_pci_device_unmap_bar(struct spdk_pci_device *dev, uint32_t bar, void *addr)
     778             : {
     779             : #if VFIO_ENABLED
     780           0 :         int rc;
     781             : 
     782           0 :         if (spdk_iommu_is_enabled()) {
     783           0 :                 rc = vtophys_iommu_unmap_dma_bar((uint64_t)addr);
     784           0 :                 if (rc) {
     785           0 :                         return -EFAULT;
     786             :                 }
     787           0 :         }
     788             : #endif
     789             : 
     790           0 :         return dev->unmap_bar(dev, bar, addr);
     791           0 : }
     792             : 
     793             : int
     794           0 : spdk_pci_device_enable_interrupt(struct spdk_pci_device *dev)
     795             : {
     796           0 :         return dpdk_pci_device_enable_interrupt(dev->dev_handle);
     797             : }
     798             : 
     799             : int
     800           0 : spdk_pci_device_disable_interrupt(struct spdk_pci_device *dev)
     801             : {
     802           0 :         return dpdk_pci_device_disable_interrupt(dev->dev_handle);
     803             : }
     804             : 
     805             : int
     806           0 : spdk_pci_device_get_interrupt_efd(struct spdk_pci_device *dev)
     807             : {
     808           0 :         return dpdk_pci_device_get_interrupt_efd(dev->dev_handle);
     809             : }
     810             : 
     811             : int
     812           0 : spdk_pci_device_enable_interrupts(struct spdk_pci_device *dev, uint32_t efd_count)
     813             : {
     814           0 :         struct rte_pci_device *rte_dev = dev->dev_handle;
     815           0 :         int rc;
     816             : 
     817           0 :         if (efd_count == 0) {
     818           0 :                 SPDK_ERRLOG("Invalid efd_count (%u)\n", efd_count);
     819           0 :                 return -EINVAL;
     820             :         }
     821             : 
     822             :         /* Detect if device has MSI-X capability */
     823           0 :         if (dpdk_pci_device_interrupt_cap_multi(rte_dev) != 1) {
     824           0 :                 SPDK_ERRLOG("VFIO MSI-X capability not present for device %s\n",
     825             :                             dpdk_pci_device_get_name(rte_dev));
     826           0 :                 return -ENOTSUP;
     827             :         }
     828             : 
     829             :         /* Create event file descriptors */
     830           0 :         rc = dpdk_pci_device_create_interrupt_efds(rte_dev, efd_count);
     831           0 :         if (rc) {
     832           0 :                 SPDK_ERRLOG("Can't setup eventfd (%u)\n", efd_count);
     833           0 :                 return rc;
     834             :         }
     835             : 
     836             :         /* Bind each event fd to each interrupt vector */
     837           0 :         rc = dpdk_pci_device_enable_interrupt(rte_dev);
     838           0 :         if (rc) {
     839           0 :                 SPDK_ERRLOG("Failed to enable interrupt for PCI device %s\n",
     840             :                             dpdk_pci_device_get_name(rte_dev));
     841           0 :                 dpdk_pci_device_delete_interrupt_efds(rte_dev);
     842           0 :                 return rc;
     843             :         }
     844             : 
     845           0 :         return 0;
     846           0 : }
     847             : 
     848             : int
     849           0 : spdk_pci_device_disable_interrupts(struct spdk_pci_device *dev)
     850             : {
     851           0 :         struct rte_pci_device *rte_dev = dev->dev_handle;
     852           0 :         int rc;
     853             : 
     854           0 :         rc = dpdk_pci_device_disable_interrupt(rte_dev);
     855           0 :         if (rc) {
     856           0 :                 SPDK_ERRLOG("Failed to disable interrupt for PCI device %s\n",
     857             :                             dpdk_pci_device_get_name(rte_dev));
     858           0 :                 return rc;
     859             :         }
     860             : 
     861           0 :         dpdk_pci_device_delete_interrupt_efds(rte_dev);
     862             : 
     863           0 :         return 0;
     864           0 : }
     865             : 
     866             : int
     867           0 : spdk_pci_device_get_interrupt_efd_by_index(struct spdk_pci_device *dev, uint32_t index)
     868             : {
     869           0 :         if (index == 0) {
     870           0 :                 return dpdk_pci_device_get_interrupt_efd(dev->dev_handle);
     871             :         } else {
     872             :                 /* Note: The interrupt vector offset starts from 1, and in DPDK these
     873             :                  * are mapped to efd index 0 onwards.
     874             :                  */
     875           0 :                 return dpdk_pci_device_get_interrupt_efd_by_index(dev->dev_handle, index - 1);
     876             :         }
     877           0 : }
     878             : 
     879             : uint32_t
     880           0 : spdk_pci_device_get_domain(struct spdk_pci_device *dev)
     881             : {
     882           0 :         return dev->addr.domain;
     883             : }
     884             : 
     885             : uint8_t
     886           0 : spdk_pci_device_get_bus(struct spdk_pci_device *dev)
     887             : {
     888           0 :         return dev->addr.bus;
     889             : }
     890             : 
     891             : uint8_t
     892           0 : spdk_pci_device_get_dev(struct spdk_pci_device *dev)
     893             : {
     894           0 :         return dev->addr.dev;
     895             : }
     896             : 
     897             : uint8_t
     898           0 : spdk_pci_device_get_func(struct spdk_pci_device *dev)
     899             : {
     900           0 :         return dev->addr.func;
     901             : }
     902             : 
     903             : uint16_t
     904           0 : spdk_pci_device_get_vendor_id(struct spdk_pci_device *dev)
     905             : {
     906           0 :         return dev->id.vendor_id;
     907             : }
     908             : 
     909             : uint16_t
     910           0 : spdk_pci_device_get_device_id(struct spdk_pci_device *dev)
     911             : {
     912           0 :         return dev->id.device_id;
     913             : }
     914             : 
     915             : uint16_t
     916           0 : spdk_pci_device_get_subvendor_id(struct spdk_pci_device *dev)
     917             : {
     918           0 :         return dev->id.subvendor_id;
     919             : }
     920             : 
     921             : uint16_t
     922           0 : spdk_pci_device_get_subdevice_id(struct spdk_pci_device *dev)
     923             : {
     924           0 :         return dev->id.subdevice_id;
     925             : }
     926             : 
     927             : struct spdk_pci_id
     928           0 : spdk_pci_device_get_id(struct spdk_pci_device *dev)
     929             : {
     930           0 :         return dev->id;
     931             : }
     932             : 
     933             : int
     934           0 : spdk_pci_device_get_numa_id(struct spdk_pci_device *dev)
     935             : {
     936           0 :         return dev->numa_id;
     937             : }
     938             : 
     939           0 : SPDK_LOG_DEPRECATION_REGISTER(pci_device_socket_id, "spdk_pci_device_get_socket_id", "v25.05", 0);
     940             : 
     941             : int
     942           0 : spdk_pci_device_get_socket_id(struct spdk_pci_device *dev)
     943             : {
     944           0 :         SPDK_LOG_DEPRECATED(pci_device_socket_id);
     945           0 :         return spdk_pci_device_get_numa_id(dev);
     946             : }
     947             : 
     948             : int
     949           0 : spdk_pci_device_cfg_read(struct spdk_pci_device *dev, void *value, uint32_t len, uint32_t offset)
     950             : {
     951           0 :         return dev->cfg_read(dev, value, len, offset);
     952             : }
     953             : 
     954             : int
     955           0 : spdk_pci_device_cfg_write(struct spdk_pci_device *dev, void *value, uint32_t len, uint32_t offset)
     956             : {
     957           0 :         return dev->cfg_write(dev, value, len, offset);
     958             : }
     959             : 
     960             : int
     961           0 : spdk_pci_device_cfg_read8(struct spdk_pci_device *dev, uint8_t *value, uint32_t offset)
     962             : {
     963           0 :         return spdk_pci_device_cfg_read(dev, value, 1, offset);
     964             : }
     965             : 
     966             : int
     967           0 : spdk_pci_device_cfg_write8(struct spdk_pci_device *dev, uint8_t value, uint32_t offset)
     968             : {
     969           0 :         return spdk_pci_device_cfg_write(dev, &value, 1, offset);
     970             : }
     971             : 
     972             : int
     973           0 : spdk_pci_device_cfg_read16(struct spdk_pci_device *dev, uint16_t *value, uint32_t offset)
     974             : {
     975           0 :         return spdk_pci_device_cfg_read(dev, value, 2, offset);
     976             : }
     977             : 
     978             : int
     979           0 : spdk_pci_device_cfg_write16(struct spdk_pci_device *dev, uint16_t value, uint32_t offset)
     980             : {
     981           0 :         return spdk_pci_device_cfg_write(dev, &value, 2, offset);
     982             : }
     983             : 
     984             : int
     985           0 : spdk_pci_device_cfg_read32(struct spdk_pci_device *dev, uint32_t *value, uint32_t offset)
     986             : {
     987           0 :         return spdk_pci_device_cfg_read(dev, value, 4, offset);
     988             : }
     989             : 
     990             : int
     991           0 : spdk_pci_device_cfg_write32(struct spdk_pci_device *dev, uint32_t value, uint32_t offset)
     992             : {
     993           0 :         return spdk_pci_device_cfg_write(dev, &value, 4, offset);
     994             : }
     995             : 
     996             : int
     997           0 : spdk_pci_device_get_serial_number(struct spdk_pci_device *dev, char *sn, size_t len)
     998             : {
     999           0 :         int err;
    1000           0 :         uint32_t pos, header = 0;
    1001           0 :         uint32_t i, buf[2];
    1002             : 
    1003           0 :         if (len < 17) {
    1004           0 :                 return -1;
    1005             :         }
    1006             : 
    1007           0 :         err = spdk_pci_device_cfg_read32(dev, &header, PCI_CFG_SIZE);
    1008           0 :         if (err || !header) {
    1009           0 :                 return -1;
    1010             :         }
    1011             : 
    1012           0 :         pos = PCI_CFG_SIZE;
    1013           0 :         while (1) {
    1014           0 :                 if ((header & 0x0000ffff) == PCI_EXT_CAP_ID_SN) {
    1015           0 :                         if (pos) {
    1016             :                                 /* skip the header */
    1017           0 :                                 pos += 4;
    1018           0 :                                 for (i = 0; i < 2; i++) {
    1019           0 :                                         err = spdk_pci_device_cfg_read32(dev, &buf[i], pos + 4 * i);
    1020           0 :                                         if (err) {
    1021           0 :                                                 return -1;
    1022             :                                         }
    1023           0 :                                 }
    1024           0 :                                 snprintf(sn, len, "%08x%08x", buf[1], buf[0]);
    1025           0 :                                 return 0;
    1026             :                         }
    1027           0 :                 }
    1028           0 :                 pos = (header >> 20) & 0xffc;
    1029             :                 /* 0 if no other items exist */
    1030           0 :                 if (pos < PCI_CFG_SIZE) {
    1031           0 :                         return -1;
    1032             :                 }
    1033           0 :                 err = spdk_pci_device_cfg_read32(dev, &header, pos);
    1034           0 :                 if (err) {
    1035           0 :                         return -1;
    1036             :                 }
    1037             :         }
    1038             :         return -1;
    1039           0 : }
    1040             : 
    1041             : struct spdk_pci_addr
    1042           0 : spdk_pci_device_get_addr(struct spdk_pci_device *dev)
    1043             : {
    1044           0 :         return dev->addr;
    1045             : }
    1046             : 
    1047             : bool
    1048           0 : spdk_pci_device_is_removed(struct spdk_pci_device *dev)
    1049             : {
    1050           0 :         return dev->internal.pending_removal;
    1051             : }
    1052             : 
    1053             : int
    1054           0 : spdk_pci_addr_compare(const struct spdk_pci_addr *a1, const struct spdk_pci_addr *a2)
    1055             : {
    1056           0 :         if (a1->domain > a2->domain) {
    1057           0 :                 return 1;
    1058           0 :         } else if (a1->domain < a2->domain) {
    1059           0 :                 return -1;
    1060           0 :         } else if (a1->bus > a2->bus) {
    1061           0 :                 return 1;
    1062           0 :         } else if (a1->bus < a2->bus) {
    1063           0 :                 return -1;
    1064           0 :         } else if (a1->dev > a2->dev) {
    1065           0 :                 return 1;
    1066           0 :         } else if (a1->dev < a2->dev) {
    1067           0 :                 return -1;
    1068           0 :         } else if (a1->func > a2->func) {
    1069           0 :                 return 1;
    1070           0 :         } else if (a1->func < a2->func) {
    1071           0 :                 return -1;
    1072             :         }
    1073             : 
    1074           0 :         return 0;
    1075           0 : }
    1076             : 
    1077             : #ifdef __linux__
    1078             : int
    1079           0 : spdk_pci_device_claim(struct spdk_pci_device *dev)
    1080             : {
    1081           0 :         int dev_fd;
    1082           0 :         char dev_name[64];
    1083           0 :         int pid;
    1084           0 :         void *dev_map;
    1085           0 :         struct flock pcidev_lock = {
    1086             :                 .l_type = F_WRLCK,
    1087             :                 .l_whence = SEEK_SET,
    1088             :                 .l_start = 0,
    1089             :                 .l_len = 0,
    1090             :         };
    1091             : 
    1092           0 :         snprintf(dev_name, sizeof(dev_name), "/var/tmp/spdk_pci_lock_%04x:%02x:%02x.%x",
    1093           0 :                  dev->addr.domain, dev->addr.bus, dev->addr.dev, dev->addr.func);
    1094             : 
    1095           0 :         dev_fd = open(dev_name, O_RDWR | O_CREAT, S_IRUSR | S_IWUSR);
    1096           0 :         if (dev_fd == -1) {
    1097           0 :                 SPDK_ERRLOG("could not open %s\n", dev_name);
    1098           0 :                 return -errno;
    1099             :         }
    1100             : 
    1101           0 :         if (ftruncate(dev_fd, sizeof(int)) != 0) {
    1102           0 :                 SPDK_ERRLOG("could not truncate %s\n", dev_name);
    1103           0 :                 close(dev_fd);
    1104           0 :                 return -errno;
    1105             :         }
    1106             : 
    1107           0 :         dev_map = mmap(NULL, sizeof(int), PROT_READ | PROT_WRITE,
    1108           0 :                        MAP_SHARED, dev_fd, 0);
    1109           0 :         if (dev_map == MAP_FAILED) {
    1110           0 :                 SPDK_ERRLOG("could not mmap dev %s (%d)\n", dev_name, errno);
    1111           0 :                 close(dev_fd);
    1112           0 :                 return -errno;
    1113             :         }
    1114             : 
    1115           0 :         if (fcntl(dev_fd, F_SETLK, &pcidev_lock) != 0) {
    1116           0 :                 pid = *(int *)dev_map;
    1117           0 :                 SPDK_ERRLOG("Cannot create lock on device %s, probably"
    1118             :                             " process %d has claimed it\n", dev_name, pid);
    1119           0 :                 munmap(dev_map, sizeof(int));
    1120           0 :                 close(dev_fd);
    1121             :                 /* F_SETLK returns unspecified errnos, normalize them */
    1122           0 :                 return -EACCES;
    1123             :         }
    1124             : 
    1125           0 :         *(int *)dev_map = (int)getpid();
    1126           0 :         munmap(dev_map, sizeof(int));
    1127           0 :         dev->internal.claim_fd = dev_fd;
    1128             :         /* Keep dev_fd open to maintain the lock. */
    1129           0 :         return 0;
    1130           0 : }
    1131             : 
    1132             : void
    1133           0 : spdk_pci_device_unclaim(struct spdk_pci_device *dev)
    1134             : {
    1135           0 :         char dev_name[64];
    1136             : 
    1137           0 :         snprintf(dev_name, sizeof(dev_name), "/var/tmp/spdk_pci_lock_%04x:%02x:%02x.%x",
    1138           0 :                  dev->addr.domain, dev->addr.bus, dev->addr.dev, dev->addr.func);
    1139             : 
    1140           0 :         close(dev->internal.claim_fd);
    1141           0 :         dev->internal.claim_fd = -1;
    1142           0 :         unlink(dev_name);
    1143           0 : }
    1144             : #else /* !__linux__ */
    1145             : int
    1146             : spdk_pci_device_claim(struct spdk_pci_device *dev)
    1147             : {
    1148             :         /* TODO */
    1149             :         return 0;
    1150             : }
    1151             : 
    1152             : void
    1153             : spdk_pci_device_unclaim(struct spdk_pci_device *dev)
    1154             : {
    1155             :         /* TODO */
    1156             : }
    1157             : #endif /* __linux__ */
    1158             : 
    1159             : int
    1160           0 : spdk_pci_addr_parse(struct spdk_pci_addr *addr, const char *bdf)
    1161             : {
    1162           0 :         unsigned domain, bus, dev, func;
    1163             : 
    1164           0 :         if (addr == NULL || bdf == NULL) {
    1165           0 :                 return -EINVAL;
    1166             :         }
    1167             : 
    1168           0 :         if ((sscanf(bdf, "%x:%x:%x.%x", &domain, &bus, &dev, &func) == 4) ||
    1169           0 :             (sscanf(bdf, "%x.%x.%x.%x", &domain, &bus, &dev, &func) == 4)) {
    1170             :                 /* Matched a full address - all variables are initialized */
    1171           0 :         } else if (sscanf(bdf, "%x:%x:%x", &domain, &bus, &dev) == 3) {
    1172           0 :                 func = 0;
    1173           0 :         } else if ((sscanf(bdf, "%x:%x.%x", &bus, &dev, &func) == 3) ||
    1174           0 :                    (sscanf(bdf, "%x.%x.%x", &bus, &dev, &func) == 3)) {
    1175           0 :                 domain = 0;
    1176           0 :         } else if ((sscanf(bdf, "%x:%x", &bus, &dev) == 2) ||
    1177           0 :                    (sscanf(bdf, "%x.%x", &bus, &dev) == 2)) {
    1178           0 :                 domain = 0;
    1179           0 :                 func = 0;
    1180           0 :         } else {
    1181           0 :                 return -EINVAL;
    1182             :         }
    1183             : 
    1184           0 :         if (bus > 0xFF || dev > 0x1F || func > 7) {
    1185           0 :                 return -EINVAL;
    1186             :         }
    1187             : 
    1188           0 :         addr->domain = domain;
    1189           0 :         addr->bus = bus;
    1190           0 :         addr->dev = dev;
    1191           0 :         addr->func = func;
    1192             : 
    1193           0 :         return 0;
    1194           0 : }
    1195             : 
    1196             : int
    1197           0 : spdk_pci_addr_fmt(char *bdf, size_t sz, const struct spdk_pci_addr *addr)
    1198             : {
    1199           0 :         int rc;
    1200             : 
    1201           0 :         rc = snprintf(bdf, sz, "%04x:%02x:%02x.%x",
    1202           0 :                       addr->domain, addr->bus,
    1203           0 :                       addr->dev, addr->func);
    1204             : 
    1205           0 :         if (rc > 0 && (size_t)rc < sz) {
    1206           0 :                 return 0;
    1207             :         }
    1208             : 
    1209           0 :         return -1;
    1210           0 : }
    1211             : 
    1212             : int
    1213           0 : spdk_pci_hook_device(struct spdk_pci_driver *drv, struct spdk_pci_device *dev)
    1214             : {
    1215           0 :         int rc;
    1216             : 
    1217           0 :         assert(dev->map_bar != NULL);
    1218           0 :         assert(dev->unmap_bar != NULL);
    1219           0 :         assert(dev->cfg_read != NULL);
    1220           0 :         assert(dev->cfg_write != NULL);
    1221           0 :         dev->internal.driver = drv;
    1222             : 
    1223           0 :         if (drv->cb_fn != NULL) {
    1224           0 :                 rc = drv->cb_fn(drv->cb_arg, dev);
    1225           0 :                 if (rc != 0) {
    1226           0 :                         return -ECANCELED;
    1227             :                 }
    1228             : 
    1229           0 :                 dev->internal.attached = true;
    1230           0 :         }
    1231             : 
    1232           0 :         TAILQ_INSERT_TAIL(&g_pci_devices, dev, internal.tailq);
    1233             : 
    1234           0 :         return 0;
    1235           0 : }
    1236             : 
    1237             : void
    1238           0 : spdk_pci_unhook_device(struct spdk_pci_device *dev)
    1239             : {
    1240           0 :         assert(!dev->internal.attached);
    1241           0 :         TAILQ_REMOVE(&g_pci_devices, dev, internal.tailq);
    1242           0 : }
    1243             : 
    1244             : void
    1245           0 : spdk_pci_register_device_provider(struct spdk_pci_device_provider *provider)
    1246             : {
    1247           0 :         TAILQ_INSERT_TAIL(&g_pci_device_providers, provider, tailq);
    1248           0 : }
    1249             : 
    1250             : const char *
    1251           0 : spdk_pci_device_get_type(const struct spdk_pci_device *dev)
    1252             : {
    1253           0 :         return dev->type;
    1254             : }
    1255             : 
    1256             : int
    1257           0 : spdk_pci_device_allow(struct spdk_pci_addr *pci_addr)
    1258             : {
    1259           0 :         struct rte_devargs *da;
    1260           0 :         char devargs_str[128];
    1261             : 
    1262           0 :         da = calloc(1, sizeof(*da));
    1263           0 :         if (da == NULL) {
    1264           0 :                 SPDK_ERRLOG("could not allocate rte_devargs\n");
    1265           0 :                 return -ENOMEM;
    1266             :         }
    1267             : 
    1268           0 :         snprintf(devargs_str, sizeof(devargs_str), "pci:%04x:%02x:%02x.%x",
    1269           0 :                  pci_addr->domain, pci_addr->bus, pci_addr->dev, pci_addr->func);
    1270           0 :         if (rte_devargs_parse(da, devargs_str) != 0) {
    1271           0 :                 SPDK_ERRLOG("rte_devargs_parse() failed on '%s'\n", devargs_str);
    1272           0 :                 free(da);
    1273           0 :                 return -EINVAL;
    1274             :         }
    1275           0 :         da->policy = RTE_DEV_ALLOWED;
    1276             :         /* Note: if a devargs already exists for this device address, it just gets
    1277             :          * overridden.  So we do not need to check if the devargs already exists.
    1278             :          * DPDK will take care of memory management for the devargs structure after
    1279             :          * it has been inserted, so there's nothing SPDK needs to track.
    1280             :          */
    1281           0 :         if (rte_devargs_insert(&da) != 0) {
    1282           0 :                 SPDK_ERRLOG("rte_devargs_insert() failed on '%s'\n", devargs_str);
    1283           0 :                 free(da);
    1284           0 :                 return -EINVAL;
    1285             :         }
    1286             : 
    1287           0 :         return 0;
    1288           0 : }

Generated by: LCOV version 1.15