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