drivers/bus/vdev/vdev.c

   1 /* SPDX-License-Identifier: BSD-3-Clause
   2  * Copyright(c) 2016 RehiveTech. All rights reserved.
   3  */
   4
   5 #include <string.h>
   6 #include <inttypes.h>
   7 #include <stdio.h>
   8 #include <stdlib.h>
   9 #include <stdint.h>
  10 #include <stdbool.h>
  11 #include <sys/queue.h>
  12
  13 #include <rte_eal.h>
  14 #include <rte_dev.h>
  15 #include <rte_bus.h>
  16 #include <rte_common.h>
  17 #include <rte_devargs.h>
  18 #include <rte_memory.h>
  19 #include <rte_tailq.h>
  20 #include <rte_spinlock.h>
  21 #include <rte_string_fns.h>
  22 #include <rte_errno.h>
  23
  24 #include "rte_bus_vdev.h"
  25 #include "vdev_logs.h"
  26 #include "vdev_private.h"
  27
  28 #define VDEV_MP_KEY     "bus_vdev_mp"
  29
  30 int vdev_logtype_bus;
  31
  32 /* Forward declare to access virtual bus name */
  33 static struct rte_bus rte_vdev_bus;
  34
  35 /** Double linked list of virtual device drivers. */
  36 TAILQ_HEAD(vdev_device_list, rte_vdev_device);
  37
  38 static struct vdev_device_list vdev_device_list =
  39         TAILQ_HEAD_INITIALIZER(vdev_device_list);
  40 /* The lock needs to be recursive because a vdev can manage another vdev. */
  41 static rte_spinlock_recursive_t vdev_device_list_lock =
  42         RTE_SPINLOCK_RECURSIVE_INITIALIZER;
  43
  44 struct vdev_driver_list vdev_driver_list =
  45         TAILQ_HEAD_INITIALIZER(vdev_driver_list);
  46
  47 struct vdev_custom_scan {
  48         TAILQ_ENTRY(vdev_custom_scan) next;
  49         rte_vdev_scan_callback callback;
  50         void *user_arg;
  51 };
  52 TAILQ_HEAD(vdev_custom_scans, vdev_custom_scan);
  53 static struct vdev_custom_scans vdev_custom_scans =
  54         TAILQ_HEAD_INITIALIZER(vdev_custom_scans);
  55 static rte_spinlock_t vdev_custom_scan_lock = RTE_SPINLOCK_INITIALIZER;
  56
  57 /* register a driver */
  58 void
  59 rte_vdev_register(struct rte_vdev_driver *driver)
  60 {
  61         TAILQ_INSERT_TAIL(&vdev_driver_list, driver, next);
  62 }
  63
  64 /* unregister a driver */
  65 void
  66 rte_vdev_unregister(struct rte_vdev_driver *driver)
  67 {
  68         TAILQ_REMOVE(&vdev_driver_list, driver, next);
  69 }
  70
  71 int
  72 rte_vdev_add_custom_scan(rte_vdev_scan_callback callback, void *user_arg)
  73 {
  74         struct vdev_custom_scan *custom_scan;
  75
  76         rte_spinlock_lock(&vdev_custom_scan_lock);
  77
  78         /* check if already registered */
  79         TAILQ_FOREACH(custom_scan, &vdev_custom_scans, next) {
  80                 if (custom_scan->callback == callback &&
  81                                 custom_scan->user_arg == user_arg)
  82                         break;
  83         }
  84
  85         if (custom_scan == NULL) {
  86                 custom_scan = malloc(sizeof(struct vdev_custom_scan));
  87                 if (custom_scan != NULL) {
  88                         custom_scan->callback = callback;
  89                         custom_scan->user_arg = user_arg;
  90                         TAILQ_INSERT_TAIL(&vdev_custom_scans, custom_scan, next);
  91                 }
  92         }
  93
  94         rte_spinlock_unlock(&vdev_custom_scan_lock);
  95
  96         return (custom_scan == NULL) ? -1 : 0;
  97 }
  98
  99 int
 100 rte_vdev_remove_custom_scan(rte_vdev_scan_callback callback, void *user_arg)
 101 {
 102         struct vdev_custom_scan *custom_scan, *tmp_scan;
 103
 104         rte_spinlock_lock(&vdev_custom_scan_lock);
 105         TAILQ_FOREACH_SAFE(custom_scan, &vdev_custom_scans, next, tmp_scan) {
 106                 if (custom_scan->callback != callback ||
 107                                 (custom_scan->user_arg != (void *)-1 &&
 108                                 custom_scan->user_arg != user_arg))
 109                         continue;
 110                 TAILQ_REMOVE(&vdev_custom_scans, custom_scan, next);
 111                 free(custom_scan);
 112         }
 113         rte_spinlock_unlock(&vdev_custom_scan_lock);
 114
 115         return 0;
 116 }
 117
 118 static int
 119 vdev_parse(const char *name, void *addr)
 120 {
 121         struct rte_vdev_driver **out = addr;
 122         struct rte_vdev_driver *driver = NULL;
 123
 124         TAILQ_FOREACH(driver, &vdev_driver_list, next) {
 125                 if (strncmp(driver->driver.name, name,
 126                             strlen(driver->driver.name)) == 0)
 127                         break;
 128                 if (driver->driver.alias &&
 129                     strncmp(driver->driver.alias, name,
 130                             strlen(driver->driver.alias)) == 0)
 131                         break;
 132         }
 133         if (driver != NULL &&
 134             addr != NULL)
 135                 *out = driver;
 136         return driver == NULL;
 137 }
 138
 139 static int
 140 vdev_probe_all_drivers(struct rte_vdev_device *dev)
 141 {
 142         const char *name;
 143         struct rte_vdev_driver *driver;
 144         int ret;
 145
 146         name = rte_vdev_device_name(dev);
 147
 148         VDEV_LOG(DEBUG, "Search driver %s to probe device %s", name,
 149                 rte_vdev_device_name(dev));
 150
 151         if (vdev_parse(name, &driver))
 152                 return -1;
 153         dev->device.driver = &driver->driver;
 154         ret = driver->probe(dev);
 155         if (ret)
 156                 dev->device.driver = NULL;
 157         return ret;
 158 }
 159
 160 /* The caller shall be responsible for thread-safe */
 161 static struct rte_vdev_device *
 162 find_vdev(const char *name)
 163 {
 164         struct rte_vdev_device *dev;
 165
 166         if (!name)
 167                 return NULL;
 168
 169         TAILQ_FOREACH(dev, &vdev_device_list, next) {
 170                 const char *devname = rte_vdev_device_name(dev);
 171
 172                 if (!strcmp(devname, name))
 173                         return dev;
 174         }
 175
 176         return NULL;
 177 }
 178
 179 static struct rte_devargs *
 180 alloc_devargs(const char *name, const char *args)
 181 {
 182         struct rte_devargs *devargs;
 183         int ret;
 184
 185         devargs = calloc(1, sizeof(*devargs));
 186         if (!devargs)
 187                 return NULL;
 188
 189         devargs->bus = &rte_vdev_bus;
 190         if (args)
 191                 devargs->args = strdup(args);
 192         else
 193                 devargs->args = strdup("");
 194
 195         ret = snprintf(devargs->name, sizeof(devargs->name), "%s", name);
 196         if (ret < 0 || ret >= (int)sizeof(devargs->name)) {
 197                 free(devargs->args);
 198                 free(devargs);
 199                 return NULL;
 200         }
 201
 202         return devargs;
 203 }
 204
 205 static int
 206 insert_vdev(const char *name, const char *args, struct rte_vdev_device **p_dev)
 207 {
 208         struct rte_vdev_device *dev;
 209         struct rte_devargs *devargs;
 210         int ret;
 211
 212         if (name == NULL)
 213                 return -EINVAL;
 214
 215         devargs = alloc_devargs(name, args);
 216         if (!devargs)
 217                 return -ENOMEM;
 218
 219         dev = calloc(1, sizeof(*dev));
 220         if (!dev) {
 221                 ret = -ENOMEM;
 222                 goto fail;
 223         }
 224
 225         dev->device.devargs = devargs;
 226         dev->device.numa_node = SOCKET_ID_ANY;
 227         dev->device.name = devargs->name;
 228
 229         if (find_vdev(name)) {
 230                 ret = -EEXIST;
 231                 goto fail;
 232         }
 233
 234         TAILQ_INSERT_TAIL(&vdev_device_list, dev, next);
 235         rte_devargs_insert(devargs);
 236
 237         if (p_dev)
 238                 *p_dev = dev;
 239
 240         return 0;
 241 fail:
 242         free(devargs->args);
 243         free(devargs);
 244         free(dev);
 245         return ret;
 246 }
 247
 248 int
 249 rte_vdev_init(const char *name, const char *args)
 250 {
 251         struct rte_vdev_device *dev;
 252         struct rte_devargs *devargs;
 253         int ret;
 254
 255         rte_spinlock_recursive_lock(&vdev_device_list_lock);
 256         ret = insert_vdev(name, args, &dev);
 257         if (ret == 0) {
 258                 ret = vdev_probe_all_drivers(dev);
 259                 if (ret) {
 260                         if (ret > 0)
 261                                 VDEV_LOG(ERR, "no driver found for %s", name);
 262                         /* If fails, remove it from vdev list */
 263                         devargs = dev->device.devargs;
 264                         TAILQ_REMOVE(&vdev_device_list, dev, next);
 265                         rte_devargs_remove(devargs->bus->name, devargs->name);
 266                         free(dev);
 267                 }
 268         }
 269         rte_spinlock_recursive_unlock(&vdev_device_list_lock);
 270         return ret;
 271 }
 272
 273 static int
 274 vdev_remove_driver(struct rte_vdev_device *dev)
 275 {
 276         const char *name = rte_vdev_device_name(dev);
 277         const struct rte_vdev_driver *driver;
 278
 279         if (!dev->device.driver) {
 280                 VDEV_LOG(DEBUG, "no driver attach to device %s", name);
 281                 return 1;
 282         }
 283
 284         driver = container_of(dev->device.driver, const struct rte_vdev_driver,
 285                 driver);
 286         return driver->remove(dev);
 287 }
 288
 289 int
 290 rte_vdev_uninit(const char *name)
 291 {
 292         struct rte_vdev_device *dev;
 293         struct rte_devargs *devargs;
 294         int ret;
 295
 296         if (name == NULL)
 297                 return -EINVAL;
 298
 299         rte_spinlock_recursive_lock(&vdev_device_list_lock);
 300
 301         dev = find_vdev(name);
 302         if (!dev) {
 303                 ret = -ENOENT;
 304                 goto unlock;
 305         }
 306
 307         ret = vdev_remove_driver(dev);
 308         if (ret)
 309                 goto unlock;
 310
 311         TAILQ_REMOVE(&vdev_device_list, dev, next);
 312         devargs = dev->device.devargs;
 313         rte_devargs_remove(devargs->bus->name, devargs->name);
 314         free(dev);
 315
 316 unlock:
 317         rte_spinlock_recursive_unlock(&vdev_device_list_lock);
 318         return ret;
 319 }
 320
 321 struct vdev_param {
 322 #define VDEV_SCAN_REQ   1
 323 #define VDEV_SCAN_ONE   2
 324 #define VDEV_SCAN_REP   3
 325         int type;
 326         int num;
 327         char name[RTE_DEV_NAME_MAX_LEN];
 328 };
 329
 330 static int vdev_plug(struct rte_device *dev);
 331
 332 /**
 333  * This function works as the action for both primary and secondary process
 334  * for static vdev discovery when a secondary process is booting.
 335  *
 336  * step 1, secondary process sends a sync request to ask for vdev in primary;
 337  * step 2, primary process receives the request, and send vdevs one by one;
 338  * step 3, primary process sends back reply, which indicates how many vdevs
 339  * are sent.
 340  */
 341 static int
 342 vdev_action(const struct rte_mp_msg *mp_msg, const void *peer)
 343 {
 344         struct rte_vdev_device *dev;
 345         struct rte_mp_msg mp_resp;
 346         struct vdev_param *ou = (struct vdev_param *)&mp_resp.param;
 347         const struct vdev_param *in = (const struct vdev_param *)mp_msg->param;
 348         const char *devname;
 349         int num;
 350         int ret;
 351
 352         strlcpy(mp_resp.name, VDEV_MP_KEY, sizeof(mp_resp.name));
 353         mp_resp.len_param = sizeof(*ou);
 354         mp_resp.num_fds = 0;
 355
 356         switch (in->type) {
 357         case VDEV_SCAN_REQ:
 358                 ou->type = VDEV_SCAN_ONE;
 359                 ou->num = 1;
 360                 num = 0;
 361
 362                 rte_spinlock_recursive_lock(&vdev_device_list_lock);
 363                 TAILQ_FOREACH(dev, &vdev_device_list, next) {
 364                         devname = rte_vdev_device_name(dev);
 365                         if (strlen(devname) == 0) {
 366                                 VDEV_LOG(INFO, "vdev with no name is not sent");
 367                                 continue;
 368                         }
 369                         VDEV_LOG(INFO, "send vdev, %s", devname);
 370                         strlcpy(ou->name, devname, RTE_DEV_NAME_MAX_LEN);
 371                         if (rte_mp_sendmsg(&mp_resp) < 0)
 372                                 VDEV_LOG(ERR, "send vdev, %s, failed, %s",
 373                                          devname, strerror(rte_errno));
 374                         num++;
 375                 }
 376                 rte_spinlock_recursive_unlock(&vdev_device_list_lock);
 377
 378                 ou->type = VDEV_SCAN_REP;
 379                 ou->num = num;
 380                 if (rte_mp_reply(&mp_resp, peer) < 0)
 381                         VDEV_LOG(ERR, "Failed to reply a scan request");
 382                 break;
 383         case VDEV_SCAN_ONE:
 384                 VDEV_LOG(INFO, "receive vdev, %s", in->name);
 385                 ret = insert_vdev(in->name, NULL, NULL);
 386                 if (ret == -EEXIST)
 387                         VDEV_LOG(DEBUG, "device already exist, %s", in->name);
 388                 else if (ret < 0)
 389                         VDEV_LOG(ERR, "failed to add vdev, %s", in->name);
 390                 break;
 391         default:
 392                 VDEV_LOG(ERR, "vdev cannot recognize this message");
 393         }
 394
 395         return 0;
 396 }
 397
 398 static int
 399 vdev_scan(void)
 400 {
 401         struct rte_vdev_device *dev;
 402         struct rte_devargs *devargs;
 403         struct vdev_custom_scan *custom_scan;
 404
 405         if (rte_mp_action_register(VDEV_MP_KEY, vdev_action) < 0 &&
 406             rte_errno != EEXIST) {
 407                 VDEV_LOG(ERR, "Failed to add vdev mp action");
 408                 return -1;
 409         }
 410
 411         if (rte_eal_process_type() == RTE_PROC_SECONDARY) {
 412                 struct rte_mp_msg mp_req, *mp_rep;
 413                 struct rte_mp_reply mp_reply;
 414                 struct timespec ts = {.tv_sec = 5, .tv_nsec = 0};
 415                 struct vdev_param *req = (struct vdev_param *)mp_req.param;
 416                 struct vdev_param *resp;
 417
 418                 strlcpy(mp_req.name, VDEV_MP_KEY, sizeof(mp_req.name));
 419                 mp_req.len_param = sizeof(*req);
 420                 mp_req.num_fds = 0;
 421                 req->type = VDEV_SCAN_REQ;
 422                 if (rte_mp_request_sync(&mp_req, &mp_reply, &ts) == 0 &&
 423                     mp_reply.nb_received == 1) {
 424                         mp_rep = &mp_reply.msgs[0];
 425                         resp = (struct vdev_param *)mp_rep->param;
 426                         VDEV_LOG(INFO, "Received %d vdevs", resp->num);
 427                 } else
 428                         VDEV_LOG(ERR, "Failed to request vdev from primary");
 429
 430                 /* Fall through to allow private vdevs in secondary process */
 431         }
 432
 433         /* call custom scan callbacks if any */
 434         rte_spinlock_lock(&vdev_custom_scan_lock);
 435         TAILQ_FOREACH(custom_scan, &vdev_custom_scans, next) {
 436                 if (custom_scan->callback != NULL)
 437                         /*
 438                          * the callback should update devargs list
 439                          * by calling rte_devargs_insert() with
 440                          *     devargs.bus = rte_bus_find_by_name("vdev");
 441                          *     devargs.type = RTE_DEVTYPE_VIRTUAL;
 442                          *     devargs.policy = RTE_DEV_WHITELISTED;
 443                          */
 444                         custom_scan->callback(custom_scan->user_arg);
 445         }
 446         rte_spinlock_unlock(&vdev_custom_scan_lock);
 447
 448         /* for virtual devices we scan the devargs_list populated via cmdline */
 449         RTE_EAL_DEVARGS_FOREACH("vdev", devargs) {
 450
 451                 dev = calloc(1, sizeof(*dev));
 452                 if (!dev)
 453                         return -1;
 454
 455                 rte_spinlock_recursive_lock(&vdev_device_list_lock);
 456
 457                 if (find_vdev(devargs->name)) {
 458                         rte_spinlock_recursive_unlock(&vdev_device_list_lock);
 459                         free(dev);
 460                         continue;
 461                 }
 462
 463                 dev->device.devargs = devargs;
 464                 dev->device.numa_node = SOCKET_ID_ANY;
 465                 dev->device.name = devargs->name;
 466
 467                 TAILQ_INSERT_TAIL(&vdev_device_list, dev, next);
 468
 469                 rte_spinlock_recursive_unlock(&vdev_device_list_lock);
 470         }
 471
 472         return 0;
 473 }
 474
 475 static int
 476 vdev_probe(void)
 477 {
 478         struct rte_vdev_device *dev;
 479         int ret = 0;
 480
 481         /* call the init function for each virtual device */
 482         TAILQ_FOREACH(dev, &vdev_device_list, next) {
 483                 /* we don't use the vdev lock here, as it's only used in DPDK
 484                  * initialization; and we don't want to hold such a lock when
 485                  * we call each driver probe.
 486                  */
 487
 488                 if (dev->device.driver)
 489                         continue;
 490
 491                 if (vdev_probe_all_drivers(dev)) {
 492                         VDEV_LOG(ERR, "failed to initialize %s device",
 493                                 rte_vdev_device_name(dev));
 494                         ret = -1;
 495                 }
 496         }
 497
 498         return ret;
 499 }
 500
 501 struct rte_device *
 502 rte_vdev_find_device(const struct rte_device *start, rte_dev_cmp_t cmp,
 503                      const void *data)
 504 {
 505         const struct rte_vdev_device *vstart;
 506         struct rte_vdev_device *dev;
 507
 508         rte_spinlock_recursive_lock(&vdev_device_list_lock);
 509         if (start != NULL) {
 510                 vstart = RTE_DEV_TO_VDEV_CONST(start);
 511                 dev = TAILQ_NEXT(vstart, next);
 512         } else {
 513                 dev = TAILQ_FIRST(&vdev_device_list);
 514         }
 515         while (dev != NULL) {
 516                 if (cmp(&dev->device, data) == 0)
 517                         break;
 518                 dev = TAILQ_NEXT(dev, next);
 519         }
 520         rte_spinlock_recursive_unlock(&vdev_device_list_lock);
 521
 522         return dev ? &dev->device : NULL;
 523 }
 524
 525 static int
 526 vdev_plug(struct rte_device *dev)
 527 {
 528         return vdev_probe_all_drivers(RTE_DEV_TO_VDEV(dev));
 529 }
 530
 531 static int
 532 vdev_unplug(struct rte_device *dev)
 533 {
 534         return rte_vdev_uninit(dev->name);
 535 }
 536
 537 static struct rte_bus rte_vdev_bus = {
 538         .scan = vdev_scan,
 539         .probe = vdev_probe,
 540         .find_device = rte_vdev_find_device,
 541         .plug = vdev_plug,
 542         .unplug = vdev_unplug,
 543         .parse = vdev_parse,
 544         .dev_iterate = rte_vdev_dev_iterate,
 545 };
 546
 547 RTE_REGISTER_BUS(vdev, rte_vdev_bus);
 548
 549 RTE_INIT(vdev_init_log)
 550 {
 551         vdev_logtype_bus = rte_log_register("bus.vdev");
 552         if (vdev_logtype_bus >= 0)
 553                 rte_log_set_level(vdev_logtype_bus, RTE_LOG_NOTICE);
 554 }