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         ret = driver->probe(dev);
 154         if (ret == 0)
 155                 dev->device.driver = &driver->driver;
 156         return ret;
 157 }
 158
 159 /* The caller shall be responsible for thread-safe */
 160 static struct rte_vdev_device *
 161 find_vdev(const char *name)
 162 {
 163         struct rte_vdev_device *dev;
 164
 165         if (!name)
 166                 return NULL;
 167
 168         TAILQ_FOREACH(dev, &vdev_device_list, next) {
 169                 const char *devname = rte_vdev_device_name(dev);
 170
 171                 if (!strcmp(devname, name))
 172                         return dev;
 173         }
 174
 175         return NULL;
 176 }
 177
 178 static struct rte_devargs *
 179 alloc_devargs(const char *name, const char *args)
 180 {
 181         struct rte_devargs *devargs;
 182         int ret;
 183
 184         devargs = calloc(1, sizeof(*devargs));
 185         if (!devargs)
 186                 return NULL;
 187
 188         devargs->bus = &rte_vdev_bus;
 189         if (args)
 190                 devargs->args = strdup(args);
 191         else
 192                 devargs->args = strdup("");
 193
 194         ret = snprintf(devargs->name, sizeof(devargs->name), "%s", name);
 195         if (ret < 0 || ret >= (int)sizeof(devargs->name)) {
 196                 free(devargs->args);
 197                 free(devargs);
 198                 return NULL;
 199         }
 200
 201         return devargs;
 202 }
 203
 204 static int
 205 insert_vdev(const char *name, const char *args, struct rte_vdev_device **p_dev)
 206 {
 207         struct rte_vdev_device *dev;
 208         struct rte_devargs *devargs;
 209         int ret;
 210
 211         if (name == NULL)
 212                 return -EINVAL;
 213
 214         devargs = alloc_devargs(name, args);
 215         if (!devargs)
 216                 return -ENOMEM;
 217
 218         dev = calloc(1, sizeof(*dev));
 219         if (!dev) {
 220                 ret = -ENOMEM;
 221                 goto fail;
 222         }
 223
 224         dev->device.bus = &rte_vdev_bus;
 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                 /*
 231                  * A vdev is expected to have only one port.
 232                  * So there is no reason to try probing again,
 233                  * even with new arguments.
 234                  */
 235                 ret = -EEXIST;
 236                 goto fail;
 237         }
 238
 239         TAILQ_INSERT_TAIL(&vdev_device_list, dev, next);
 240         rte_devargs_insert(devargs);
 241
 242         if (p_dev)
 243                 *p_dev = dev;
 244
 245         return 0;
 246 fail:
 247         free(devargs->args);
 248         free(devargs);
 249         free(dev);
 250         return ret;
 251 }
 252
 253 int
 254 rte_vdev_init(const char *name, const char *args)
 255 {
 256         struct rte_vdev_device *dev;
 257         int ret;
 258
 259         rte_spinlock_recursive_lock(&vdev_device_list_lock);
 260         ret = insert_vdev(name, args, &dev);
 261         if (ret == 0) {
 262                 ret = vdev_probe_all_drivers(dev);
 263                 if (ret) {
 264                         if (ret > 0)
 265                                 VDEV_LOG(ERR, "no driver found for %s", name);
 266                         /* If fails, remove it from vdev list */
 267                         TAILQ_REMOVE(&vdev_device_list, dev, next);
 268                         rte_devargs_remove(dev->device.devargs);
 269                         free(dev);
 270                 }
 271         }
 272         rte_spinlock_recursive_unlock(&vdev_device_list_lock);
 273         return ret;
 274 }
 275
 276 static int
 277 vdev_remove_driver(struct rte_vdev_device *dev)
 278 {
 279         const char *name = rte_vdev_device_name(dev);
 280         const struct rte_vdev_driver *driver;
 281
 282         if (!dev->device.driver) {
 283                 VDEV_LOG(DEBUG, "no driver attach to device %s", name);
 284                 return 1;
 285         }
 286
 287         driver = container_of(dev->device.driver, const struct rte_vdev_driver,
 288                 driver);
 289         return driver->remove(dev);
 290 }
 291
 292 int
 293 rte_vdev_uninit(const char *name)
 294 {
 295         struct rte_vdev_device *dev;
 296         int ret;
 297
 298         if (name == NULL)
 299                 return -EINVAL;
 300
 301         rte_spinlock_recursive_lock(&vdev_device_list_lock);
 302
 303         dev = find_vdev(name);
 304         if (!dev) {
 305                 ret = -ENOENT;
 306                 goto unlock;
 307         }
 308
 309         ret = vdev_remove_driver(dev);
 310         if (ret)
 311                 goto unlock;
 312
 313         TAILQ_REMOVE(&vdev_device_list, dev, next);
 314         rte_devargs_remove(dev->device.devargs);
 315         free(dev);
 316
 317 unlock:
 318         rte_spinlock_recursive_unlock(&vdev_device_list_lock);
 319         return ret;
 320 }
 321
 322 struct vdev_param {
 323 #define VDEV_SCAN_REQ   1
 324 #define VDEV_SCAN_ONE   2
 325 #define VDEV_SCAN_REP   3
 326         int type;
 327         int num;
 328         char name[RTE_DEV_NAME_MAX_LEN];
 329 };
 330
 331 static int vdev_plug(struct rte_device *dev);
 332
 333 /**
 334  * This function works as the action for both primary and secondary process
 335  * for static vdev discovery when a secondary process is booting.
 336  *
 337  * step 1, secondary process sends a sync request to ask for vdev in primary;
 338  * step 2, primary process receives the request, and send vdevs one by one;
 339  * step 3, primary process sends back reply, which indicates how many vdevs
 340  * are sent.
 341  */
 342 static int
 343 vdev_action(const struct rte_mp_msg *mp_msg, const void *peer)
 344 {
 345         struct rte_vdev_device *dev;
 346         struct rte_mp_msg mp_resp;
 347         struct vdev_param *ou = (struct vdev_param *)&mp_resp.param;
 348         const struct vdev_param *in = (const struct vdev_param *)mp_msg->param;
 349         const char *devname;
 350         int num;
 351         int ret;
 352
 353         strlcpy(mp_resp.name, VDEV_MP_KEY, sizeof(mp_resp.name));
 354         mp_resp.len_param = sizeof(*ou);
 355         mp_resp.num_fds = 0;
 356
 357         switch (in->type) {
 358         case VDEV_SCAN_REQ:
 359                 ou->type = VDEV_SCAN_ONE;
 360                 ou->num = 1;
 361                 num = 0;
 362
 363                 rte_spinlock_recursive_lock(&vdev_device_list_lock);
 364                 TAILQ_FOREACH(dev, &vdev_device_list, next) {
 365                         devname = rte_vdev_device_name(dev);
 366                         if (strlen(devname) == 0) {
 367                                 VDEV_LOG(INFO, "vdev with no name is not sent");
 368                                 continue;
 369                         }
 370                         VDEV_LOG(INFO, "send vdev, %s", devname);
 371                         strlcpy(ou->name, devname, RTE_DEV_NAME_MAX_LEN);
 372                         if (rte_mp_sendmsg(&mp_resp) < 0)
 373                                 VDEV_LOG(ERR, "send vdev, %s, failed, %s",
 374                                          devname, strerror(rte_errno));
 375                         num++;
 376                 }
 377                 rte_spinlock_recursive_unlock(&vdev_device_list_lock);
 378
 379                 ou->type = VDEV_SCAN_REP;
 380                 ou->num = num;
 381                 if (rte_mp_reply(&mp_resp, peer) < 0)
 382                         VDEV_LOG(ERR, "Failed to reply a scan request");
 383                 break;
 384         case VDEV_SCAN_ONE:
 385                 VDEV_LOG(INFO, "receive vdev, %s", in->name);
 386                 ret = insert_vdev(in->name, NULL, NULL);
 387                 if (ret == -EEXIST)
 388                         VDEV_LOG(DEBUG, "device already exist, %s", in->name);
 389                 else if (ret < 0)
 390                         VDEV_LOG(ERR, "failed to add vdev, %s", in->name);
 391                 break;
 392         default:
 393                 VDEV_LOG(ERR, "vdev cannot recognize this message");
 394         }
 395
 396         return 0;
 397 }
 398
 399 static int
 400 vdev_scan(void)
 401 {
 402         struct rte_vdev_device *dev;
 403         struct rte_devargs *devargs;
 404         struct vdev_custom_scan *custom_scan;
 405
 406         if (rte_mp_action_register(VDEV_MP_KEY, vdev_action) < 0 &&
 407             rte_errno != EEXIST) {
 408                 VDEV_LOG(ERR, "Failed to add vdev mp action");
 409                 return -1;
 410         }
 411
 412         if (rte_eal_process_type() == RTE_PROC_SECONDARY) {
 413                 struct rte_mp_msg mp_req, *mp_rep;
 414                 struct rte_mp_reply mp_reply;
 415                 struct timespec ts = {.tv_sec = 5, .tv_nsec = 0};
 416                 struct vdev_param *req = (struct vdev_param *)mp_req.param;
 417                 struct vdev_param *resp;
 418
 419                 strlcpy(mp_req.name, VDEV_MP_KEY, sizeof(mp_req.name));
 420                 mp_req.len_param = sizeof(*req);
 421                 mp_req.num_fds = 0;
 422                 req->type = VDEV_SCAN_REQ;
 423                 if (rte_mp_request_sync(&mp_req, &mp_reply, &ts) == 0 &&
 424                     mp_reply.nb_received == 1) {
 425                         mp_rep = &mp_reply.msgs[0];
 426                         resp = (struct vdev_param *)mp_rep->param;
 427                         VDEV_LOG(INFO, "Received %d vdevs", resp->num);
 428                         free(mp_reply.msgs);
 429                 } else
 430                         VDEV_LOG(ERR, "Failed to request vdev from primary");
 431
 432                 /* Fall through to allow private vdevs in secondary process */
 433         }
 434
 435         /* call custom scan callbacks if any */
 436         rte_spinlock_lock(&vdev_custom_scan_lock);
 437         TAILQ_FOREACH(custom_scan, &vdev_custom_scans, next) {
 438                 if (custom_scan->callback != NULL)
 439                         /*
 440                          * the callback should update devargs list
 441                          * by calling rte_devargs_insert() with
 442                          *     devargs.bus = rte_bus_find_by_name("vdev");
 443                          *     devargs.type = RTE_DEVTYPE_VIRTUAL;
 444                          *     devargs.policy = RTE_DEV_WHITELISTED;
 445                          */
 446                         custom_scan->callback(custom_scan->user_arg);
 447         }
 448         rte_spinlock_unlock(&vdev_custom_scan_lock);
 449
 450         /* for virtual devices we scan the devargs_list populated via cmdline */
 451         RTE_EAL_DEVARGS_FOREACH("vdev", devargs) {
 452
 453                 dev = calloc(1, sizeof(*dev));
 454                 if (!dev)
 455                         return -1;
 456
 457                 rte_spinlock_recursive_lock(&vdev_device_list_lock);
 458
 459                 if (find_vdev(devargs->name)) {
 460                         rte_spinlock_recursive_unlock(&vdev_device_list_lock);
 461                         free(dev);
 462                         continue;
 463                 }
 464
 465                 dev->device.bus = &rte_vdev_bus;
 466                 dev->device.devargs = devargs;
 467                 dev->device.numa_node = SOCKET_ID_ANY;
 468                 dev->device.name = devargs->name;
 469
 470                 TAILQ_INSERT_TAIL(&vdev_device_list, dev, next);
 471
 472                 rte_spinlock_recursive_unlock(&vdev_device_list_lock);
 473         }
 474
 475         return 0;
 476 }
 477
 478 static int
 479 vdev_probe(void)
 480 {
 481         struct rte_vdev_device *dev;
 482         int ret = 0;
 483
 484         /* call the init function for each virtual device */
 485         TAILQ_FOREACH(dev, &vdev_device_list, next) {
 486                 /* we don't use the vdev lock here, as it's only used in DPDK
 487                  * initialization; and we don't want to hold such a lock when
 488                  * we call each driver probe.
 489                  */
 490
 491                 if (rte_dev_is_probed(&dev->device))
 492                         continue;
 493
 494                 if (vdev_probe_all_drivers(dev)) {
 495                         VDEV_LOG(ERR, "failed to initialize %s device",
 496                                 rte_vdev_device_name(dev));
 497                         ret = -1;
 498                 }
 499         }
 500
 501         return ret;
 502 }
 503
 504 struct rte_device *
 505 rte_vdev_find_device(const struct rte_device *start, rte_dev_cmp_t cmp,
 506                      const void *data)
 507 {
 508         const struct rte_vdev_device *vstart;
 509         struct rte_vdev_device *dev;
 510
 511         rte_spinlock_recursive_lock(&vdev_device_list_lock);
 512         if (start != NULL) {
 513                 vstart = RTE_DEV_TO_VDEV_CONST(start);
 514                 dev = TAILQ_NEXT(vstart, next);
 515         } else {
 516                 dev = TAILQ_FIRST(&vdev_device_list);
 517         }
 518         while (dev != NULL) {
 519                 if (cmp(&dev->device, data) == 0)
 520                         break;
 521                 dev = TAILQ_NEXT(dev, next);
 522         }
 523         rte_spinlock_recursive_unlock(&vdev_device_list_lock);
 524
 525         return dev ? &dev->device : NULL;
 526 }
 527
 528 static int
 529 vdev_plug(struct rte_device *dev)
 530 {
 531         return vdev_probe_all_drivers(RTE_DEV_TO_VDEV(dev));
 532 }
 533
 534 static int
 535 vdev_unplug(struct rte_device *dev)
 536 {
 537         return rte_vdev_uninit(dev->name);
 538 }
 539
 540 static struct rte_bus rte_vdev_bus = {
 541         .scan = vdev_scan,
 542         .probe = vdev_probe,
 543         .find_device = rte_vdev_find_device,
 544         .plug = vdev_plug,
 545         .unplug = vdev_unplug,
 546         .parse = vdev_parse,
 547         .dev_iterate = rte_vdev_dev_iterate,
 548 };
 549
 550 RTE_REGISTER_BUS(vdev, rte_vdev_bus);
 551
 552 RTE_INIT(vdev_init_log)
 553 {
 554         vdev_logtype_bus = rte_log_register("bus.vdev");
 555         if (vdev_logtype_bus >= 0)
 556                 rte_log_set_level(vdev_logtype_bus, RTE_LOG_NOTICE);
 557 }