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