devargs: add non-variadic parsing function
[dpdk.git] / lib / librte_eal / common / eal_common_dev.c
index 92a5a94..ce4b514 100644 (file)
@@ -1,35 +1,6 @@
-/*-
- *   BSD LICENSE
- *
- *   Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
- *   Copyright(c) 2014 6WIND S.A.
- *   All rights reserved.
- *
- *   Redistribution and use in source and binary forms, with or without
- *   modification, are permitted provided that the following conditions
- *   are met:
- *
- *     * Redistributions of source code must retain the above copyright
- *       notice, this list of conditions and the following disclaimer.
- *     * Redistributions in binary form must reproduce the above copyright
- *       notice, this list of conditions and the following disclaimer in
- *       the documentation and/or other materials provided with the
- *       distribution.
- *     * Neither the name of Intel Corporation nor the names of its
- *       contributors may be used to endorse or promote products derived
- *       from this software without specific prior written permission.
- *
- *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
- *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
- *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
- *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
- *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
- *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
- *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
- *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
- *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
- *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
- *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+/* SPDX-License-Identifier: BSD-3-Clause
+ * Copyright(c) 2010-2014 Intel Corporation.
+ * Copyright(c) 2014 6WIND S.A.
  */
 
 #include <stdio.h>
 #include <inttypes.h>
 #include <sys/queue.h>
 
+#include <rte_compat.h>
+#include <rte_bus.h>
 #include <rte_dev.h>
 #include <rte_devargs.h>
 #include <rte_debug.h>
-#include <rte_devargs.h>
 #include <rte_log.h>
+#include <rte_spinlock.h>
+#include <rte_malloc.h>
 
 #include "eal_private.h"
 
-/** Global list of device drivers. */
-static struct rte_driver_list dev_driver_list =
-       TAILQ_HEAD_INITIALIZER(dev_driver_list);
+/**
+ * The device event callback description.
+ *
+ * It contains callback address to be registered by user application,
+ * the pointer to the parameters for callback, and the device name.
+ */
+struct dev_event_callback {
+       TAILQ_ENTRY(dev_event_callback) next; /**< Callbacks list */
+       rte_dev_event_cb_fn cb_fn;            /**< Callback address */
+       void *cb_arg;                         /**< Callback parameter */
+       char *dev_name;  /**< Callback device name, NULL is for all device */
+       uint32_t active;                      /**< Callback is executing */
+};
 
-/* register a driver */
-void
-rte_eal_driver_register(struct rte_driver *driver)
+/** @internal Structure to keep track of registered callbacks */
+TAILQ_HEAD(dev_event_cb_list, dev_event_callback);
+
+/* The device event callback list for all registered callbacks. */
+static struct dev_event_cb_list dev_event_cbs;
+
+/* spinlock for device callbacks */
+static rte_spinlock_t dev_event_lock = RTE_SPINLOCK_INITIALIZER;
+
+static int cmp_detached_dev_name(const struct rte_device *dev,
+       const void *_name)
 {
-       TAILQ_INSERT_TAIL(&dev_driver_list, driver, next);
+       const char *name = _name;
+
+       /* skip attached devices */
+       if (dev->driver != NULL)
+               return 1;
+
+       return strcmp(dev->name, name);
 }
 
-/* unregister a driver */
-void
-rte_eal_driver_unregister(struct rte_driver *driver)
+static int cmp_dev_name(const struct rte_device *dev, const void *_name)
 {
-       TAILQ_REMOVE(&dev_driver_list, driver, next);
+       const char *name = _name;
+
+       return strcmp(dev->name, name);
 }
 
-int
-rte_eal_vdev_init(const char *name, const char *args)
+int rte_eal_dev_attach(const char *name, const char *devargs)
 {
-       struct rte_driver *driver;
+       struct rte_bus *bus;
 
-       if (name == NULL)
+       if (name == NULL || devargs == NULL) {
+               RTE_LOG(ERR, EAL, "Invalid device or arguments provided\n");
                return -EINVAL;
+       }
 
-       TAILQ_FOREACH(driver, &dev_driver_list, next) {
-               if (driver->type != PMD_VDEV)
-                       continue;
+       bus = rte_bus_find_by_device_name(name);
+       if (bus == NULL) {
+               RTE_LOG(ERR, EAL, "Unable to find a bus for the device '%s'\n",
+                       name);
+               return -EINVAL;
+       }
+       if (strcmp(bus->name, "pci") == 0 || strcmp(bus->name, "vdev") == 0)
+               return rte_eal_hotplug_add(bus->name, name, devargs);
 
-               /*
-                * search a driver prefix in virtual device name.
-                * For example, if the driver is pcap PMD, driver->name
-                * will be "eth_pcap", but "name" will be "eth_pcapN".
-                * So use strncmp to compare.
-                */
-               if (!strncmp(driver->name, name, strlen(driver->name)))
-                       return driver->init(name, args);
+       RTE_LOG(ERR, EAL,
+               "Device attach is only supported for PCI and vdev devices.\n");
+
+       return -ENOTSUP;
+}
+
+int rte_eal_dev_detach(struct rte_device *dev)
+{
+       struct rte_bus *bus;
+       int ret;
+
+       if (dev == NULL) {
+               RTE_LOG(ERR, EAL, "Invalid device provided.\n");
+               return -EINVAL;
+       }
+
+       bus = rte_bus_find_by_device(dev);
+       if (bus == NULL) {
+               RTE_LOG(ERR, EAL, "Cannot find bus for device (%s)\n",
+                       dev->name);
+               return -EINVAL;
        }
 
-       RTE_LOG(ERR, EAL, "no driver found for %s\n", name);
-       return -EINVAL;
+       if (bus->unplug == NULL) {
+               RTE_LOG(ERR, EAL, "Bus function not supported\n");
+               return -ENOTSUP;
+       }
+
+       ret = bus->unplug(dev);
+       if (ret)
+               RTE_LOG(ERR, EAL, "Driver cannot detach the device (%s)\n",
+                       dev->name);
+       return ret;
 }
 
-int
-rte_eal_dev_init(void)
+int __rte_experimental rte_eal_hotplug_add(const char *busname, const char *devname,
+                       const char *devargs)
 {
-       struct rte_devargs *devargs;
-       struct rte_driver *driver;
+       struct rte_bus *bus;
+       struct rte_device *dev;
+       struct rte_devargs *da;
+       int ret;
 
-       /*
-        * Note that the dev_driver_list is populated here
-        * from calls made to rte_eal_driver_register from constructor functions
-        * embedded into PMD modules via the PMD_REGISTER_DRIVER macro
-        */
+       bus = rte_bus_find_by_name(busname);
+       if (bus == NULL) {
+               RTE_LOG(ERR, EAL, "Cannot find bus (%s)\n", busname);
+               return -ENOENT;
+       }
 
-       /* call the init function for each virtual device */
-       TAILQ_FOREACH(devargs, &devargs_list, next) {
+       if (bus->plug == NULL) {
+               RTE_LOG(ERR, EAL, "Function plug not supported by bus (%s)\n",
+                       bus->name);
+               return -ENOTSUP;
+       }
 
-               if (devargs->type != RTE_DEVTYPE_VIRTUAL)
-                       continue;
+       da = calloc(1, sizeof(*da));
+       if (da == NULL)
+               return -ENOMEM;
+
+       ret = rte_devargs_parsef(da, "%s:%s,%s",
+                                busname, devname, devargs);
+       if (ret)
+               goto err_devarg;
+
+       ret = rte_devargs_insert(da);
+       if (ret)
+               goto err_devarg;
+
+       ret = bus->scan();
+       if (ret)
+               goto err_devarg;
+
+       dev = bus->find_device(NULL, cmp_detached_dev_name, devname);
+       if (dev == NULL) {
+               RTE_LOG(ERR, EAL, "Cannot find unplugged device (%s)\n",
+                       devname);
+               ret = -ENODEV;
+               goto err_devarg;
+       }
 
-               if (rte_eal_vdev_init(devargs->virtual.drv_name,
-                                       devargs->args)) {
-                       RTE_LOG(ERR, EAL, "failed to initialize %s device\n",
-                                       devargs->virtual.drv_name);
-                       return -1;
+       ret = bus->plug(dev);
+       if (ret) {
+               RTE_LOG(ERR, EAL, "Driver cannot attach the device (%s)\n",
+                       dev->name);
+               goto err_devarg;
+       }
+       return 0;
+
+err_devarg:
+       if (rte_devargs_remove(busname, devname)) {
+               free(da->args);
+               free(da);
+       }
+       return ret;
+}
+
+int __rte_experimental
+rte_eal_hotplug_remove(const char *busname, const char *devname)
+{
+       struct rte_bus *bus;
+       struct rte_device *dev;
+       int ret;
+
+       bus = rte_bus_find_by_name(busname);
+       if (bus == NULL) {
+               RTE_LOG(ERR, EAL, "Cannot find bus (%s)\n", busname);
+               return -ENOENT;
+       }
+
+       if (bus->unplug == NULL) {
+               RTE_LOG(ERR, EAL, "Function unplug not supported by bus (%s)\n",
+                       bus->name);
+               return -ENOTSUP;
+       }
+
+       dev = bus->find_device(NULL, cmp_dev_name, devname);
+       if (dev == NULL) {
+               RTE_LOG(ERR, EAL, "Cannot find plugged device (%s)\n", devname);
+               return -EINVAL;
+       }
+
+       ret = bus->unplug(dev);
+       if (ret)
+               RTE_LOG(ERR, EAL, "Driver cannot detach the device (%s)\n",
+                       dev->name);
+       rte_devargs_remove(busname, devname);
+       return ret;
+}
+
+int __rte_experimental
+rte_dev_event_callback_register(const char *device_name,
+                               rte_dev_event_cb_fn cb_fn,
+                               void *cb_arg)
+{
+       struct dev_event_callback *event_cb;
+       int ret;
+
+       if (!cb_fn)
+               return -EINVAL;
+
+       rte_spinlock_lock(&dev_event_lock);
+
+       if (TAILQ_EMPTY(&dev_event_cbs))
+               TAILQ_INIT(&dev_event_cbs);
+
+       TAILQ_FOREACH(event_cb, &dev_event_cbs, next) {
+               if (event_cb->cb_fn == cb_fn && event_cb->cb_arg == cb_arg) {
+                       if (device_name == NULL && event_cb->dev_name == NULL)
+                               break;
+                       if (device_name == NULL || event_cb->dev_name == NULL)
+                               continue;
+                       if (!strcmp(event_cb->dev_name, device_name))
+                               break;
                }
        }
 
-       /* Once the vdevs are initalized, start calling all the pdev drivers */
-       TAILQ_FOREACH(driver, &dev_driver_list, next) {
-               if (driver->type != PMD_PDEV)
-                       continue;
-               /* PDEV drivers don't get passed any parameters */
-               driver->init(NULL, NULL);
+       /* create a new callback. */
+       if (event_cb == NULL) {
+               event_cb = malloc(sizeof(struct dev_event_callback));
+               if (event_cb != NULL) {
+                       event_cb->cb_fn = cb_fn;
+                       event_cb->cb_arg = cb_arg;
+                       event_cb->active = 0;
+                       if (!device_name) {
+                               event_cb->dev_name = NULL;
+                       } else {
+                               event_cb->dev_name = strdup(device_name);
+                               if (event_cb->dev_name == NULL) {
+                                       ret = -ENOMEM;
+                                       goto error;
+                               }
+                       }
+                       TAILQ_INSERT_TAIL(&dev_event_cbs, event_cb, next);
+               } else {
+                       RTE_LOG(ERR, EAL,
+                               "Failed to allocate memory for device "
+                               "event callback.");
+                       ret = -ENOMEM;
+                       goto error;
+               }
+       } else {
+               RTE_LOG(ERR, EAL,
+                       "The callback is already exist, no need "
+                       "to register again.\n");
+               ret = -EEXIST;
        }
+
+       rte_spinlock_unlock(&dev_event_lock);
        return 0;
+error:
+       free(event_cb);
+       rte_spinlock_unlock(&dev_event_lock);
+       return ret;
 }
 
-#ifdef RTE_LIBRTE_EAL_HOTPLUG
-int
-rte_eal_vdev_uninit(const char *name)
+int __rte_experimental
+rte_dev_event_callback_unregister(const char *device_name,
+                                 rte_dev_event_cb_fn cb_fn,
+                                 void *cb_arg)
 {
-       struct rte_driver *driver;
+       int ret = 0;
+       struct dev_event_callback *event_cb, *next;
 
-       if (name == NULL)
+       if (!cb_fn)
                return -EINVAL;
 
-       TAILQ_FOREACH(driver, &dev_driver_list, next) {
-               if (driver->type != PMD_VDEV)
+       rte_spinlock_lock(&dev_event_lock);
+       /*walk through the callbacks and remove all that match. */
+       for (event_cb = TAILQ_FIRST(&dev_event_cbs); event_cb != NULL;
+            event_cb = next) {
+
+               next = TAILQ_NEXT(event_cb, next);
+
+               if (device_name != NULL && event_cb->dev_name != NULL) {
+                       if (!strcmp(event_cb->dev_name, device_name)) {
+                               if (event_cb->cb_fn != cb_fn ||
+                                   (cb_arg != (void *)-1 &&
+                                   event_cb->cb_arg != cb_arg))
+                                       continue;
+                       }
+               } else if (device_name != NULL) {
                        continue;
+               }
 
                /*
-                * search a driver prefix in virtual device name.
-                * For example, if the driver is pcap PMD, driver->name
-                * will be "eth_pcap", but "name" will be "eth_pcapN".
-                * So use strncmp to compare.
+                * if this callback is not executing right now,
+                * then remove it.
                 */
-               if (!strncmp(driver->name, name, strlen(driver->name)))
-                       return driver->uninit(name);
+               if (event_cb->active == 0) {
+                       TAILQ_REMOVE(&dev_event_cbs, event_cb, next);
+                       free(event_cb);
+                       ret++;
+               } else {
+                       continue;
+               }
        }
+       rte_spinlock_unlock(&dev_event_lock);
+       return ret;
+}
+
+void
+dev_callback_process(char *device_name, enum rte_dev_event_type event)
+{
+       struct dev_event_callback *cb_lst;
 
-       RTE_LOG(ERR, EAL, "no driver found for %s\n", name);
-       return -EINVAL;
+       if (device_name == NULL)
+               return;
+
+       rte_spinlock_lock(&dev_event_lock);
+
+       TAILQ_FOREACH(cb_lst, &dev_event_cbs, next) {
+               if (cb_lst->dev_name) {
+                       if (strcmp(cb_lst->dev_name, device_name))
+                               continue;
+               }
+               cb_lst->active = 1;
+               rte_spinlock_unlock(&dev_event_lock);
+               cb_lst->cb_fn(device_name, event,
+                               cb_lst->cb_arg);
+               rte_spinlock_lock(&dev_event_lock);
+               cb_lst->active = 0;
+       }
+       rte_spinlock_unlock(&dev_event_lock);
 }
-#endif /* RTE_LIBRTE_EAL_HOTPLUG */