drivers/common/mlx5/mlx5_common.c

   1 /* SPDX-License-Identifier: BSD-3-Clause
   2  * Copyright 2019 Mellanox Technologies, Ltd
   3  */
   4
   5 #include <unistd.h>
   6 #include <string.h>
   7 #include <stdio.h>
   8
   9 #include <rte_errno.h>
  10 #include <rte_mempool.h>
  11 #include <rte_class.h>
  12 #include <rte_malloc.h>
  13 #include <rte_eal_paging.h>
  14
  15 #include "mlx5_common.h"
  16 #include "mlx5_common_os.h"
  17 #include "mlx5_common_mp.h"
  18 #include "mlx5_common_log.h"
  19 #include "mlx5_common_defs.h"
  20 #include "mlx5_common_private.h"
  21
  22 uint8_t haswell_broadwell_cpu;
  23
  24 /* In case this is an x86_64 intel processor to check if
  25  * we should use relaxed ordering.
  26  */
  27 #ifdef RTE_ARCH_X86_64
  28 /**
  29  * This function returns processor identification and feature information
  30  * into the registers.
  31  *
  32  * @param eax, ebx, ecx, edx
  33  *              Pointers to the registers that will hold cpu information.
  34  * @param level
  35  *              The main category of information returned.
  36  */
  37 static inline void mlx5_cpu_id(unsigned int level,
  38                                 unsigned int *eax, unsigned int *ebx,
  39                                 unsigned int *ecx, unsigned int *edx)
  40 {
  41         __asm__("cpuid\n\t"
  42                 : "=a" (*eax), "=b" (*ebx), "=c" (*ecx), "=d" (*edx)
  43                 : "0" (level));
  44 }
  45 #endif
  46
  47 RTE_LOG_REGISTER_DEFAULT(mlx5_common_logtype, NOTICE)
  48
  49 /* Head of list of drivers. */
  50 static TAILQ_HEAD(mlx5_drivers, mlx5_class_driver) drivers_list =
  51                                 TAILQ_HEAD_INITIALIZER(drivers_list);
  52
  53 /* Head of devices. */
  54 static TAILQ_HEAD(mlx5_devices, mlx5_common_device) devices_list =
  55                                 TAILQ_HEAD_INITIALIZER(devices_list);
  56 static pthread_mutex_t devices_list_lock;
  57
  58 static const struct {
  59         const char *name;
  60         unsigned int drv_class;
  61 } mlx5_classes[] = {
  62         { .name = "vdpa", .drv_class = MLX5_CLASS_VDPA },
  63         { .name = "eth", .drv_class = MLX5_CLASS_ETH },
  64         /* Keep class "net" for backward compatibility. */
  65         { .name = "net", .drv_class = MLX5_CLASS_ETH },
  66         { .name = "regex", .drv_class = MLX5_CLASS_REGEX },
  67         { .name = "compress", .drv_class = MLX5_CLASS_COMPRESS },
  68         { .name = "crypto", .drv_class = MLX5_CLASS_CRYPTO },
  69 };
  70
  71 static int
  72 class_name_to_value(const char *class_name)
  73 {
  74         unsigned int i;
  75
  76         for (i = 0; i < RTE_DIM(mlx5_classes); i++) {
  77                 if (strcmp(class_name, mlx5_classes[i].name) == 0)
  78                         return mlx5_classes[i].drv_class;
  79         }
  80         return -EINVAL;
  81 }
  82
  83 static struct mlx5_class_driver *
  84 driver_get(uint32_t class)
  85 {
  86         struct mlx5_class_driver *driver;
  87
  88         TAILQ_FOREACH(driver, &drivers_list, next) {
  89                 if ((uint32_t)driver->drv_class == class)
  90                         return driver;
  91         }
  92         return NULL;
  93 }
  94
  95 /**
  96  * Verify and store value for devargs.
  97  *
  98  * @param[in] key
  99  *   Key argument to verify.
 100  * @param[in] val
 101  *   Value associated with key.
 102  * @param opaque
 103  *   User data.
 104  *
 105  * @return
 106  *   0 on success, a negative errno value otherwise and rte_errno is set.
 107  */
 108 static int
 109 mlx5_common_args_check_handler(const char *key, const char *val, void *opaque)
 110 {
 111         struct mlx5_common_dev_config *config = opaque;
 112         signed long tmp;
 113
 114         if (val == NULL || *val == '\0') {
 115                 DRV_LOG(ERR, "Key %s is missing value.", key);
 116                 rte_errno = EINVAL;
 117                 return -rte_errno;
 118         }
 119         errno = 0;
 120         tmp = strtol(val, NULL, 0);
 121         if (errno) {
 122                 rte_errno = errno;
 123                 DRV_LOG(WARNING, "%s: \"%s\" is an invalid integer.", key, val);
 124                 return -rte_errno;
 125         }
 126         if (strcmp(key, "tx_db_nc") == 0) {
 127                 if (tmp != MLX5_TXDB_CACHED &&
 128                     tmp != MLX5_TXDB_NCACHED &&
 129                     tmp != MLX5_TXDB_HEURISTIC) {
 130                         DRV_LOG(ERR, "Invalid Tx doorbell mapping parameter.");
 131                         rte_errno = EINVAL;
 132                         return -rte_errno;
 133                 }
 134                 config->dbnc = tmp;
 135         } else if (strcmp(key, "mr_ext_memseg_en") == 0) {
 136                 config->mr_ext_memseg_en = !!tmp;
 137         } else if (strcmp(key, "mr_mempool_reg_en") == 0) {
 138                 config->mr_mempool_reg_en = !!tmp;
 139         } else if (strcmp(key, "sys_mem_en") == 0) {
 140                 config->sys_mem_en = !!tmp;
 141         }
 142         return 0;
 143 }
 144
 145 /**
 146  * Parse common device parameters.
 147  *
 148  * @param devargs
 149  *   Device arguments structure.
 150  * @param config
 151  *   Pointer to device configuration structure.
 152  *
 153  * @return
 154  *   0 on success, a negative errno value otherwise and rte_errno is set.
 155  */
 156 static int
 157 mlx5_common_config_get(struct rte_devargs *devargs,
 158                        struct mlx5_common_dev_config *config)
 159 {
 160         struct rte_kvargs *kvlist;
 161         int ret = 0;
 162
 163         /* Set defaults. */
 164         config->mr_ext_memseg_en = 1;
 165         config->mr_mempool_reg_en = 1;
 166         config->sys_mem_en = 0;
 167         config->dbnc = MLX5_ARG_UNSET;
 168         if (devargs == NULL)
 169                 return 0;
 170         kvlist = rte_kvargs_parse(devargs->args, NULL);
 171         if (kvlist == NULL) {
 172                 rte_errno = EINVAL;
 173                 return -rte_errno;
 174         }
 175         ret = rte_kvargs_process(kvlist, NULL, mlx5_common_args_check_handler,
 176                                  config);
 177         if (ret)
 178                 ret = -rte_errno;
 179         rte_kvargs_free(kvlist);
 180         DRV_LOG(DEBUG, "mr_ext_memseg_en is %u.", config->mr_ext_memseg_en);
 181         DRV_LOG(DEBUG, "mr_mempool_reg_en is %u.", config->mr_mempool_reg_en);
 182         DRV_LOG(DEBUG, "sys_mem_en is %u.", config->sys_mem_en);
 183         DRV_LOG(DEBUG, "Tx doorbell mapping parameter is %d.", config->dbnc);
 184         return ret;
 185 }
 186
 187 static int
 188 devargs_class_handler(__rte_unused const char *key,
 189                       const char *class_names, void *opaque)
 190 {
 191         int *ret = opaque;
 192         int class_val;
 193         char *scratch;
 194         char *found;
 195         char *refstr = NULL;
 196
 197         *ret = 0;
 198         scratch = strdup(class_names);
 199         if (scratch == NULL) {
 200                 *ret = -ENOMEM;
 201                 return *ret;
 202         }
 203         found = strtok_r(scratch, ":", &refstr);
 204         if (found == NULL)
 205                 /* Empty string. */
 206                 goto err;
 207         do {
 208                 /* Extract each individual class name. Multiple
 209                  * classes can be supplied as class=net:regex:foo:bar.
 210                  */
 211                 class_val = class_name_to_value(found);
 212                 /* Check if its a valid class. */
 213                 if (class_val < 0) {
 214                         *ret = -EINVAL;
 215                         goto err;
 216                 }
 217                 *ret |= class_val;
 218                 found = strtok_r(NULL, ":", &refstr);
 219         } while (found != NULL);
 220 err:
 221         free(scratch);
 222         if (*ret < 0)
 223                 DRV_LOG(ERR, "Invalid mlx5 class options: %s.\n", class_names);
 224         return *ret;
 225 }
 226
 227 static int
 228 parse_class_options(const struct rte_devargs *devargs)
 229 {
 230         struct rte_kvargs *kvlist;
 231         int ret = 0;
 232
 233         if (devargs == NULL)
 234                 return 0;
 235         if (devargs->cls != NULL && devargs->cls->name != NULL)
 236                 /* Global syntax, only one class type. */
 237                 return class_name_to_value(devargs->cls->name);
 238         /* Legacy devargs support multiple classes. */
 239         kvlist = rte_kvargs_parse(devargs->args, NULL);
 240         if (kvlist == NULL)
 241                 return 0;
 242         rte_kvargs_process(kvlist, RTE_DEVARGS_KEY_CLASS,
 243                            devargs_class_handler, &ret);
 244         rte_kvargs_free(kvlist);
 245         return ret;
 246 }
 247
 248 static const unsigned int mlx5_class_invalid_combinations[] = {
 249         MLX5_CLASS_ETH | MLX5_CLASS_VDPA,
 250         /* New class combination should be added here. */
 251 };
 252
 253 static int
 254 is_valid_class_combination(uint32_t user_classes)
 255 {
 256         unsigned int i;
 257
 258         /* Verify if user specified unsupported combination. */
 259         for (i = 0; i < RTE_DIM(mlx5_class_invalid_combinations); i++) {
 260                 if ((mlx5_class_invalid_combinations[i] & user_classes) ==
 261                     mlx5_class_invalid_combinations[i])
 262                         return -EINVAL;
 263         }
 264         /* Not found any invalid class combination. */
 265         return 0;
 266 }
 267
 268 static bool
 269 mlx5_bus_match(const struct mlx5_class_driver *drv,
 270                const struct rte_device *dev)
 271 {
 272         if (mlx5_dev_is_pci(dev))
 273                 return mlx5_dev_pci_match(drv, dev);
 274         return true;
 275 }
 276
 277 static struct mlx5_common_device *
 278 to_mlx5_device(const struct rte_device *rte_dev)
 279 {
 280         struct mlx5_common_device *cdev;
 281
 282         TAILQ_FOREACH(cdev, &devices_list, next) {
 283                 if (rte_dev == cdev->dev)
 284                         return cdev;
 285         }
 286         return NULL;
 287 }
 288
 289 int
 290 mlx5_dev_to_pci_str(const struct rte_device *dev, char *addr, size_t size)
 291 {
 292         struct rte_pci_addr pci_addr = { 0 };
 293         int ret;
 294
 295         if (mlx5_dev_is_pci(dev)) {
 296                 /* Input might be <BDF>, format PCI address to <DBDF>. */
 297                 ret = rte_pci_addr_parse(dev->name, &pci_addr);
 298                 if (ret != 0)
 299                         return -ENODEV;
 300                 rte_pci_device_name(&pci_addr, addr, size);
 301                 return 0;
 302         }
 303 #ifdef RTE_EXEC_ENV_LINUX
 304         return mlx5_auxiliary_get_pci_str(RTE_DEV_TO_AUXILIARY_CONST(dev),
 305                         addr, size);
 306 #else
 307         rte_errno = ENODEV;
 308         return -rte_errno;
 309 #endif
 310 }
 311
 312 /**
 313  * Register the mempool for the protection domain.
 314  *
 315  * @param cdev
 316  *   Pointer to the mlx5 common device.
 317  * @param mp
 318  *   Mempool being registered.
 319  *
 320  * @return
 321  *   0 on success, (-1) on failure and rte_errno is set.
 322  */
 323 static int
 324 mlx5_dev_mempool_register(struct mlx5_common_device *cdev,
 325                           struct rte_mempool *mp, bool is_extmem)
 326 {
 327         return mlx5_mr_mempool_register(cdev, mp, is_extmem);
 328 }
 329
 330 /**
 331  * Unregister the mempool from the protection domain.
 332  *
 333  * @param cdev
 334  *   Pointer to the mlx5 common device.
 335  * @param mp
 336  *   Mempool being unregistered.
 337  */
 338 void
 339 mlx5_dev_mempool_unregister(struct mlx5_common_device *cdev,
 340                             struct rte_mempool *mp)
 341 {
 342         if (mlx5_mr_mempool_unregister(cdev, mp) < 0)
 343                 DRV_LOG(WARNING, "Failed to unregister mempool %s for PD %p: %s",
 344                         mp->name, cdev->pd, rte_strerror(rte_errno));
 345 }
 346
 347 /**
 348  * rte_mempool_walk() callback to register mempools for the protection domain.
 349  *
 350  * @param mp
 351  *   The mempool being walked.
 352  * @param arg
 353  *   Pointer to the device shared context.
 354  */
 355 static void
 356 mlx5_dev_mempool_register_cb(struct rte_mempool *mp, void *arg)
 357 {
 358         struct mlx5_common_device *cdev = arg;
 359         int ret;
 360
 361         ret = mlx5_dev_mempool_register(cdev, mp, false);
 362         if (ret < 0 && rte_errno != EEXIST)
 363                 DRV_LOG(ERR,
 364                         "Failed to register existing mempool %s for PD %p: %s",
 365                         mp->name, cdev->pd, rte_strerror(rte_errno));
 366 }
 367
 368 /**
 369  * rte_mempool_walk() callback to unregister mempools
 370  * from the protection domain.
 371  *
 372  * @param mp
 373  *   The mempool being walked.
 374  * @param arg
 375  *   Pointer to the device shared context.
 376  */
 377 static void
 378 mlx5_dev_mempool_unregister_cb(struct rte_mempool *mp, void *arg)
 379 {
 380         mlx5_dev_mempool_unregister((struct mlx5_common_device *)arg, mp);
 381 }
 382
 383 /**
 384  * Mempool life cycle callback for mlx5 common devices.
 385  *
 386  * @param event
 387  *   Mempool life cycle event.
 388  * @param mp
 389  *   Associated mempool.
 390  * @param arg
 391  *   Pointer to a device shared context.
 392  */
 393 static void
 394 mlx5_dev_mempool_event_cb(enum rte_mempool_event event, struct rte_mempool *mp,
 395                           void *arg)
 396 {
 397         struct mlx5_common_device *cdev = arg;
 398
 399         switch (event) {
 400         case RTE_MEMPOOL_EVENT_READY:
 401                 if (mlx5_dev_mempool_register(cdev, mp, false) < 0)
 402                         DRV_LOG(ERR,
 403                                 "Failed to register new mempool %s for PD %p: %s",
 404                                 mp->name, cdev->pd, rte_strerror(rte_errno));
 405                 break;
 406         case RTE_MEMPOOL_EVENT_DESTROY:
 407                 mlx5_dev_mempool_unregister(cdev, mp);
 408                 break;
 409         }
 410 }
 411
 412 int
 413 mlx5_dev_mempool_subscribe(struct mlx5_common_device *cdev)
 414 {
 415         int ret = 0;
 416
 417         if (!cdev->config.mr_mempool_reg_en)
 418                 return 0;
 419         rte_rwlock_write_lock(&cdev->mr_scache.mprwlock);
 420         if (cdev->mr_scache.mp_cb_registered)
 421                 goto exit;
 422         /* Callback for this device may be already registered. */
 423         ret = rte_mempool_event_callback_register(mlx5_dev_mempool_event_cb,
 424                                                   cdev);
 425         if (ret != 0 && rte_errno != EEXIST)
 426                 goto exit;
 427         /* Register mempools only once for this device. */
 428         if (ret == 0)
 429                 rte_mempool_walk(mlx5_dev_mempool_register_cb, cdev);
 430         ret = 0;
 431         cdev->mr_scache.mp_cb_registered = 1;
 432 exit:
 433         rte_rwlock_write_unlock(&cdev->mr_scache.mprwlock);
 434         return ret;
 435 }
 436
 437 static void
 438 mlx5_dev_mempool_unsubscribe(struct mlx5_common_device *cdev)
 439 {
 440         int ret;
 441
 442         if (!cdev->mr_scache.mp_cb_registered ||
 443             !cdev->config.mr_mempool_reg_en)
 444                 return;
 445         /* Stop watching for mempool events and unregister all mempools. */
 446         ret = rte_mempool_event_callback_unregister(mlx5_dev_mempool_event_cb,
 447                                                     cdev);
 448         if (ret == 0)
 449                 rte_mempool_walk(mlx5_dev_mempool_unregister_cb, cdev);
 450 }
 451
 452 /**
 453  * Callback for memory event.
 454  *
 455  * @param event_type
 456  *   Memory event type.
 457  * @param addr
 458  *   Address of memory.
 459  * @param len
 460  *   Size of memory.
 461  */
 462 static void
 463 mlx5_mr_mem_event_cb(enum rte_mem_event event_type, const void *addr,
 464                      size_t len, void *arg __rte_unused)
 465 {
 466         struct mlx5_common_device *cdev;
 467
 468         /* Must be called from the primary process. */
 469         MLX5_ASSERT(rte_eal_process_type() == RTE_PROC_PRIMARY);
 470         switch (event_type) {
 471         case RTE_MEM_EVENT_FREE:
 472                 pthread_mutex_lock(&devices_list_lock);
 473                 /* Iterate all the existing mlx5 devices. */
 474                 TAILQ_FOREACH(cdev, &devices_list, next)
 475                         mlx5_free_mr_by_addr(&cdev->mr_scache,
 476                                              mlx5_os_get_ctx_device_name
 477                                                                     (cdev->ctx),
 478                                              addr, len);
 479                 pthread_mutex_unlock(&devices_list_lock);
 480                 break;
 481         case RTE_MEM_EVENT_ALLOC:
 482         default:
 483                 break;
 484         }
 485 }
 486
 487 /**
 488  * Uninitialize all HW global of device context.
 489  *
 490  * @param cdev
 491  *   Pointer to mlx5 device structure.
 492  *
 493  * @return
 494  *   0 on success, a negative errno value otherwise and rte_errno is set.
 495  */
 496 static void
 497 mlx5_dev_hw_global_release(struct mlx5_common_device *cdev)
 498 {
 499         if (cdev->pd != NULL) {
 500                 claim_zero(mlx5_os_dealloc_pd(cdev->pd));
 501                 cdev->pd = NULL;
 502         }
 503         if (cdev->ctx != NULL) {
 504                 claim_zero(mlx5_glue->close_device(cdev->ctx));
 505                 cdev->ctx = NULL;
 506         }
 507 }
 508
 509 /**
 510  * Initialize all HW global of device context.
 511  *
 512  * @param cdev
 513  *   Pointer to mlx5 device structure.
 514  * @param classes
 515  *   Chosen classes come from user device arguments.
 516  *
 517  * @return
 518  *   0 on success, a negative errno value otherwise and rte_errno is set.
 519  */
 520 static int
 521 mlx5_dev_hw_global_prepare(struct mlx5_common_device *cdev, uint32_t classes)
 522 {
 523         int ret;
 524
 525         /* Create context device */
 526         ret = mlx5_os_open_device(cdev, classes);
 527         if (ret < 0)
 528                 return ret;
 529         /* Allocate Protection Domain object and extract its pdn. */
 530         ret = mlx5_os_pd_create(cdev);
 531         if (ret)
 532                 goto error;
 533         /* All actions taken below are relevant only when DevX is supported */
 534         if (cdev->config.devx == 0)
 535                 return 0;
 536         /* Query HCA attributes. */
 537         ret = mlx5_devx_cmd_query_hca_attr(cdev->ctx, &cdev->config.hca_attr);
 538         if (ret) {
 539                 DRV_LOG(ERR, "Unable to read HCA capabilities.");
 540                 rte_errno = ENOTSUP;
 541                 goto error;
 542         }
 543         return 0;
 544 error:
 545         mlx5_dev_hw_global_release(cdev);
 546         return ret;
 547 }
 548
 549 static void
 550 mlx5_common_dev_release(struct mlx5_common_device *cdev)
 551 {
 552         pthread_mutex_lock(&devices_list_lock);
 553         TAILQ_REMOVE(&devices_list, cdev, next);
 554         pthread_mutex_unlock(&devices_list_lock);
 555         if (rte_eal_process_type() == RTE_PROC_PRIMARY) {
 556                 if (TAILQ_EMPTY(&devices_list))
 557                         rte_mem_event_callback_unregister("MLX5_MEM_EVENT_CB",
 558                                                           NULL);
 559                 mlx5_dev_mempool_unsubscribe(cdev);
 560                 mlx5_mr_release_cache(&cdev->mr_scache);
 561                 mlx5_dev_hw_global_release(cdev);
 562         }
 563         rte_free(cdev);
 564 }
 565
 566 static struct mlx5_common_device *
 567 mlx5_common_dev_create(struct rte_device *eal_dev, uint32_t classes)
 568 {
 569         struct mlx5_common_device *cdev;
 570         int ret;
 571
 572         cdev = rte_zmalloc("mlx5_common_device", sizeof(*cdev), 0);
 573         if (!cdev) {
 574                 DRV_LOG(ERR, "Device allocation failure.");
 575                 rte_errno = ENOMEM;
 576                 return NULL;
 577         }
 578         cdev->dev = eal_dev;
 579         if (rte_eal_process_type() != RTE_PROC_PRIMARY)
 580                 goto exit;
 581         /* Parse device parameters. */
 582         ret = mlx5_common_config_get(eal_dev->devargs, &cdev->config);
 583         if (ret < 0) {
 584                 DRV_LOG(ERR, "Failed to process device arguments: %s",
 585                         strerror(rte_errno));
 586                 rte_free(cdev);
 587                 return NULL;
 588         }
 589         mlx5_malloc_mem_select(cdev->config.sys_mem_en);
 590         /* Initialize all HW global of device context. */
 591         ret = mlx5_dev_hw_global_prepare(cdev, classes);
 592         if (ret) {
 593                 DRV_LOG(ERR, "Failed to initialize device context.");
 594                 rte_free(cdev);
 595                 return NULL;
 596         }
 597         /* Initialize global MR cache resources and update its functions. */
 598         ret = mlx5_mr_create_cache(&cdev->mr_scache, eal_dev->numa_node);
 599         if (ret) {
 600                 DRV_LOG(ERR, "Failed to initialize global MR share cache.");
 601                 mlx5_dev_hw_global_release(cdev);
 602                 rte_free(cdev);
 603                 return NULL;
 604         }
 605         /* Register callback function for global shared MR cache management. */
 606         if (TAILQ_EMPTY(&devices_list))
 607                 rte_mem_event_callback_register("MLX5_MEM_EVENT_CB",
 608                                                 mlx5_mr_mem_event_cb, NULL);
 609 exit:
 610         pthread_mutex_lock(&devices_list_lock);
 611         TAILQ_INSERT_HEAD(&devices_list, cdev, next);
 612         pthread_mutex_unlock(&devices_list_lock);
 613         return cdev;
 614 }
 615
 616 static int
 617 drivers_remove(struct mlx5_common_device *cdev, uint32_t enabled_classes)
 618 {
 619         struct mlx5_class_driver *driver;
 620         int local_ret = -ENODEV;
 621         unsigned int i = 0;
 622         int ret = 0;
 623
 624         while (enabled_classes) {
 625                 driver = driver_get(RTE_BIT64(i));
 626                 if (driver != NULL) {
 627                         local_ret = driver->remove(cdev);
 628                         if (local_ret == 0)
 629                                 cdev->classes_loaded &= ~RTE_BIT64(i);
 630                         else if (ret == 0)
 631                                 ret = local_ret;
 632                 }
 633                 enabled_classes &= ~RTE_BIT64(i);
 634                 i++;
 635         }
 636         if (local_ret != 0 && ret == 0)
 637                 ret = local_ret;
 638         return ret;
 639 }
 640
 641 static int
 642 drivers_probe(struct mlx5_common_device *cdev, uint32_t user_classes)
 643 {
 644         struct mlx5_class_driver *driver;
 645         uint32_t enabled_classes = 0;
 646         bool already_loaded;
 647         int ret;
 648
 649         TAILQ_FOREACH(driver, &drivers_list, next) {
 650                 if ((driver->drv_class & user_classes) == 0)
 651                         continue;
 652                 if (!mlx5_bus_match(driver, cdev->dev))
 653                         continue;
 654                 already_loaded = cdev->classes_loaded & driver->drv_class;
 655                 if (already_loaded && driver->probe_again == 0) {
 656                         DRV_LOG(ERR, "Device %s is already probed",
 657                                 cdev->dev->name);
 658                         ret = -EEXIST;
 659                         goto probe_err;
 660                 }
 661                 ret = driver->probe(cdev);
 662                 if (ret < 0) {
 663                         DRV_LOG(ERR, "Failed to load driver %s",
 664                                 driver->name);
 665                         goto probe_err;
 666                 }
 667                 enabled_classes |= driver->drv_class;
 668         }
 669         cdev->classes_loaded |= enabled_classes;
 670         return 0;
 671 probe_err:
 672         /*
 673          * Need to remove only drivers which were not probed before this probe
 674          * instance, but have already been probed before this failure.
 675          */
 676         enabled_classes &= ~cdev->classes_loaded;
 677         drivers_remove(cdev, enabled_classes);
 678         return ret;
 679 }
 680
 681 int
 682 mlx5_common_dev_probe(struct rte_device *eal_dev)
 683 {
 684         struct mlx5_common_device *cdev;
 685         uint32_t classes = 0;
 686         bool new_device = false;
 687         int ret;
 688
 689         DRV_LOG(INFO, "probe device \"%s\".", eal_dev->name);
 690         ret = parse_class_options(eal_dev->devargs);
 691         if (ret < 0) {
 692                 DRV_LOG(ERR, "Unsupported mlx5 class type: %s",
 693                         eal_dev->devargs->args);
 694                 return ret;
 695         }
 696         classes = ret;
 697         if (classes == 0)
 698                 /* Default to net class. */
 699                 classes = MLX5_CLASS_ETH;
 700         cdev = to_mlx5_device(eal_dev);
 701         if (!cdev) {
 702                 cdev = mlx5_common_dev_create(eal_dev, classes);
 703                 if (!cdev)
 704                         return -ENOMEM;
 705                 new_device = true;
 706         }
 707         /*
 708          * Validate combination here.
 709          * For new device, the classes_loaded field is 0 and it check only
 710          * the classes given as user device arguments.
 711          */
 712         ret = is_valid_class_combination(classes | cdev->classes_loaded);
 713         if (ret != 0) {
 714                 DRV_LOG(ERR, "Unsupported mlx5 classes combination.");
 715                 goto class_err;
 716         }
 717         ret = drivers_probe(cdev, classes);
 718         if (ret)
 719                 goto class_err;
 720         return 0;
 721 class_err:
 722         if (new_device)
 723                 mlx5_common_dev_release(cdev);
 724         return ret;
 725 }
 726
 727 int
 728 mlx5_common_dev_remove(struct rte_device *eal_dev)
 729 {
 730         struct mlx5_common_device *cdev;
 731         int ret;
 732
 733         cdev = to_mlx5_device(eal_dev);
 734         if (!cdev)
 735                 return -ENODEV;
 736         /* Matching device found, cleanup and unload drivers. */
 737         ret = drivers_remove(cdev, cdev->classes_loaded);
 738         if (ret == 0)
 739                 mlx5_common_dev_release(cdev);
 740         return ret;
 741 }
 742
 743 /**
 744  * Callback to DMA map external memory to a device.
 745  *
 746  * @param rte_dev
 747  *   Pointer to the generic device.
 748  * @param addr
 749  *   Starting virtual address of memory to be mapped.
 750  * @param iova
 751  *   Starting IOVA address of memory to be mapped.
 752  * @param len
 753  *   Length of memory segment being mapped.
 754  *
 755  * @return
 756  *   0 on success, negative value on error.
 757  */
 758 int
 759 mlx5_common_dev_dma_map(struct rte_device *rte_dev, void *addr,
 760                         uint64_t iova __rte_unused, size_t len)
 761 {
 762         struct mlx5_common_device *dev;
 763         struct mlx5_mr *mr;
 764
 765         dev = to_mlx5_device(rte_dev);
 766         if (!dev) {
 767                 DRV_LOG(WARNING,
 768                         "Unable to find matching mlx5 device to device %s",
 769                         rte_dev->name);
 770                 rte_errno = ENODEV;
 771                 return -1;
 772         }
 773         mr = mlx5_create_mr_ext(dev->pd, (uintptr_t)addr, len,
 774                                 SOCKET_ID_ANY, dev->mr_scache.reg_mr_cb);
 775         if (!mr) {
 776                 DRV_LOG(WARNING, "Device %s unable to DMA map", rte_dev->name);
 777                 rte_errno = EINVAL;
 778                 return -1;
 779         }
 780         rte_rwlock_write_lock(&dev->mr_scache.rwlock);
 781         LIST_INSERT_HEAD(&dev->mr_scache.mr_list, mr, mr);
 782         /* Insert to the global cache table. */
 783         mlx5_mr_insert_cache(&dev->mr_scache, mr);
 784         rte_rwlock_write_unlock(&dev->mr_scache.rwlock);
 785         return 0;
 786 }
 787
 788 /**
 789  * Callback to DMA unmap external memory to a device.
 790  *
 791  * @param rte_dev
 792  *   Pointer to the generic device.
 793  * @param addr
 794  *   Starting virtual address of memory to be unmapped.
 795  * @param iova
 796  *   Starting IOVA address of memory to be unmapped.
 797  * @param len
 798  *   Length of memory segment being unmapped.
 799  *
 800  * @return
 801  *   0 on success, negative value on error.
 802  */
 803 int
 804 mlx5_common_dev_dma_unmap(struct rte_device *rte_dev, void *addr,
 805                           uint64_t iova __rte_unused, size_t len __rte_unused)
 806 {
 807         struct mlx5_common_device *dev;
 808         struct mr_cache_entry entry;
 809         struct mlx5_mr *mr;
 810
 811         dev = to_mlx5_device(rte_dev);
 812         if (!dev) {
 813                 DRV_LOG(WARNING,
 814                         "Unable to find matching mlx5 device to device %s.",
 815                         rte_dev->name);
 816                 rte_errno = ENODEV;
 817                 return -1;
 818         }
 819         rte_rwlock_read_lock(&dev->mr_scache.rwlock);
 820         mr = mlx5_mr_lookup_list(&dev->mr_scache, &entry, (uintptr_t)addr);
 821         if (!mr) {
 822                 rte_rwlock_read_unlock(&dev->mr_scache.rwlock);
 823                 DRV_LOG(WARNING,
 824                         "Address 0x%" PRIxPTR " wasn't registered to device %s",
 825                         (uintptr_t)addr, rte_dev->name);
 826                 rte_errno = EINVAL;
 827                 return -1;
 828         }
 829         LIST_REMOVE(mr, mr);
 830         DRV_LOG(DEBUG, "MR(%p) is removed from list.", (void *)mr);
 831         mlx5_mr_free(mr, dev->mr_scache.dereg_mr_cb);
 832         mlx5_mr_rebuild_cache(&dev->mr_scache);
 833         /*
 834          * No explicit wmb is needed after updating dev_gen due to
 835          * store-release ordering in unlock that provides the
 836          * implicit barrier at the software visible level.
 837          */
 838         ++dev->mr_scache.dev_gen;
 839         DRV_LOG(DEBUG, "Broadcasting local cache flush, gen=%d.",
 840                 dev->mr_scache.dev_gen);
 841         rte_rwlock_read_unlock(&dev->mr_scache.rwlock);
 842         return 0;
 843 }
 844
 845 void
 846 mlx5_class_driver_register(struct mlx5_class_driver *driver)
 847 {
 848         mlx5_common_driver_on_register_pci(driver);
 849         TAILQ_INSERT_TAIL(&drivers_list, driver, next);
 850 }
 851
 852 static void mlx5_common_driver_init(void)
 853 {
 854         mlx5_common_pci_init();
 855 #ifdef RTE_EXEC_ENV_LINUX
 856         mlx5_common_auxiliary_init();
 857 #endif
 858 }
 859
 860 static bool mlx5_common_initialized;
 861
 862 /**
 863  * One time initialization routine for run-time dependency on glue library
 864  * for multiple PMDs. Each mlx5 PMD that depends on mlx5_common module,
 865  * must invoke in its constructor.
 866  */
 867 void
 868 mlx5_common_init(void)
 869 {
 870         if (mlx5_common_initialized)
 871                 return;
 872
 873         pthread_mutex_init(&devices_list_lock, NULL);
 874         mlx5_glue_constructor();
 875         mlx5_common_driver_init();
 876         mlx5_common_initialized = true;
 877 }
 878
 879 /**
 880  * This function is responsible of initializing the variable
 881  *  haswell_broadwell_cpu by checking if the cpu is intel
 882  *  and reading the data returned from mlx5_cpu_id().
 883  *  since haswell and broadwell cpus don't have improved performance
 884  *  when using relaxed ordering we want to check the cpu type before
 885  *  before deciding whether to enable RO or not.
 886  *  if the cpu is haswell or broadwell the variable will be set to 1
 887  *  otherwise it will be 0.
 888  */
 889 RTE_INIT_PRIO(mlx5_is_haswell_broadwell_cpu, LOG)
 890 {
 891 #ifdef RTE_ARCH_X86_64
 892         unsigned int broadwell_models[4] = {0x3d, 0x47, 0x4F, 0x56};
 893         unsigned int haswell_models[4] = {0x3c, 0x3f, 0x45, 0x46};
 894         unsigned int i, model, family, brand_id, vendor;
 895         unsigned int signature_intel_ebx = 0x756e6547;
 896         unsigned int extended_model;
 897         unsigned int eax = 0;
 898         unsigned int ebx = 0;
 899         unsigned int ecx = 0;
 900         unsigned int edx = 0;
 901         int max_level;
 902
 903         mlx5_cpu_id(0, &eax, &ebx, &ecx, &edx);
 904         vendor = ebx;
 905         max_level = eax;
 906         if (max_level < 1) {
 907                 haswell_broadwell_cpu = 0;
 908                 return;
 909         }
 910         mlx5_cpu_id(1, &eax, &ebx, &ecx, &edx);
 911         model = (eax >> 4) & 0x0f;
 912         family = (eax >> 8) & 0x0f;
 913         brand_id = ebx & 0xff;
 914         extended_model = (eax >> 12) & 0xf0;
 915         /* Check if the processor is Haswell or Broadwell */
 916         if (vendor == signature_intel_ebx) {
 917                 if (family == 0x06)
 918                         model += extended_model;
 919                 if (brand_id == 0 && family == 0x6) {
 920                         for (i = 0; i < RTE_DIM(broadwell_models); i++)
 921                                 if (model == broadwell_models[i]) {
 922                                         haswell_broadwell_cpu = 1;
 923                                         return;
 924                                 }
 925                         for (i = 0; i < RTE_DIM(haswell_models); i++)
 926                                 if (model == haswell_models[i]) {
 927                                         haswell_broadwell_cpu = 1;
 928                                         return;
 929                                 }
 930                 }
 931         }
 932 #endif
 933         haswell_broadwell_cpu = 0;
 934 }
 935
 936 /**
 937  * Allocate the User Access Region with DevX on specified device.
 938  * This routine handles the following UAR allocation issues:
 939  *
 940  *  - Try to allocate the UAR with the most appropriate memory mapping
 941  *    type from the ones supported by the host.
 942  *
 943  *  - Try to allocate the UAR with non-NULL base address OFED 5.0.x and
 944  *    Upstream rdma_core before v29 returned the NULL as UAR base address
 945  *    if UAR was not the first object in the UAR page.
 946  *    It caused the PMD failure and we should try to get another UAR till
 947  *    we get the first one with non-NULL base address returned.
 948  *
 949  * @param [in] cdev
 950  *   Pointer to mlx5 device structure to perform allocation on its context.
 951  *
 952  * @return
 953  *   UAR object pointer on success, NULL otherwise and rte_errno is set.
 954  */
 955 static void *
 956 mlx5_devx_alloc_uar(struct mlx5_common_device *cdev)
 957 {
 958         void *uar;
 959         uint32_t retry, uar_mapping;
 960         void *base_addr;
 961
 962         for (retry = 0; retry < MLX5_ALLOC_UAR_RETRY; ++retry) {
 963 #ifdef MLX5DV_UAR_ALLOC_TYPE_NC
 964                 /* Control the mapping type according to the settings. */
 965                 uar_mapping = (cdev->config.dbnc == MLX5_TXDB_NCACHED) ?
 966                             MLX5DV_UAR_ALLOC_TYPE_NC : MLX5DV_UAR_ALLOC_TYPE_BF;
 967 #else
 968                 /*
 969                  * It seems we have no way to control the memory mapping type
 970                  * for the UAR, the default "Write-Combining" type is supposed.
 971                  */
 972                 uar_mapping = 0;
 973 #endif
 974                 uar = mlx5_glue->devx_alloc_uar(cdev->ctx, uar_mapping);
 975 #ifdef MLX5DV_UAR_ALLOC_TYPE_NC
 976                 if (!uar && uar_mapping == MLX5DV_UAR_ALLOC_TYPE_BF) {
 977                         /*
 978                          * In some environments like virtual machine the
 979                          * Write Combining mapped might be not supported and
 980                          * UAR allocation fails. We tried "Non-Cached" mapping
 981                          * for the case.
 982                          */
 983                         DRV_LOG(DEBUG, "Failed to allocate DevX UAR (BF)");
 984                         uar_mapping = MLX5DV_UAR_ALLOC_TYPE_NC;
 985                         uar = mlx5_glue->devx_alloc_uar(cdev->ctx, uar_mapping);
 986                 } else if (!uar && uar_mapping == MLX5DV_UAR_ALLOC_TYPE_NC) {
 987                         /*
 988                          * If Verbs/kernel does not support "Non-Cached"
 989                          * try the "Write-Combining".
 990                          */
 991                         DRV_LOG(DEBUG, "Failed to allocate DevX UAR (NC)");
 992                         uar_mapping = MLX5DV_UAR_ALLOC_TYPE_BF;
 993                         uar = mlx5_glue->devx_alloc_uar(cdev->ctx, uar_mapping);
 994                 }
 995 #endif
 996                 if (!uar) {
 997                         DRV_LOG(ERR, "Failed to allocate DevX UAR (BF/NC)");
 998                         rte_errno = ENOMEM;
 999                         goto exit;
1000                 }
1001                 base_addr = mlx5_os_get_devx_uar_base_addr(uar);
1002                 if (base_addr)
1003                         break;
1004                 /*
1005                  * The UARs are allocated by rdma_core within the
1006                  * IB device context, on context closure all UARs
1007                  * will be freed, should be no memory/object leakage.
1008                  */
1009                 DRV_LOG(DEBUG, "Retrying to allocate DevX UAR");
1010                 uar = NULL;
1011         }
1012         /* Check whether we finally succeeded with valid UAR allocation. */
1013         if (!uar) {
1014                 DRV_LOG(ERR, "Failed to allocate DevX UAR (NULL base)");
1015                 rte_errno = ENOMEM;
1016         }
1017         /*
1018          * Return void * instead of struct mlx5dv_devx_uar *
1019          * is for compatibility with older rdma-core library headers.
1020          */
1021 exit:
1022         return uar;
1023 }
1024
1025 void
1026 mlx5_devx_uar_release(struct mlx5_uar *uar)
1027 {
1028         if (uar->obj != NULL)
1029                 mlx5_glue->devx_free_uar(uar->obj);
1030         memset(uar, 0, sizeof(*uar));
1031 }
1032
1033 int
1034 mlx5_devx_uar_prepare(struct mlx5_common_device *cdev, struct mlx5_uar *uar)
1035 {
1036         off_t uar_mmap_offset;
1037         const size_t page_size = rte_mem_page_size();
1038         void *base_addr;
1039         void *uar_obj;
1040
1041         if (page_size == (size_t)-1) {
1042                 DRV_LOG(ERR, "Failed to get mem page size");
1043                 rte_errno = ENOMEM;
1044                 return -1;
1045         }
1046         uar_obj = mlx5_devx_alloc_uar(cdev);
1047         if (uar_obj == NULL || mlx5_os_get_devx_uar_reg_addr(uar_obj) == NULL) {
1048                 rte_errno = errno;
1049                 DRV_LOG(ERR, "Failed to allocate UAR.");
1050                 return -1;
1051         }
1052         uar->obj = uar_obj;
1053         uar_mmap_offset = mlx5_os_get_devx_uar_mmap_offset(uar_obj);
1054         base_addr = mlx5_os_get_devx_uar_base_addr(uar_obj);
1055         uar->dbnc = mlx5_db_map_type_get(uar_mmap_offset, page_size);
1056         uar->bf_db.db = mlx5_os_get_devx_uar_reg_addr(uar_obj);
1057         uar->cq_db.db = RTE_PTR_ADD(base_addr, MLX5_CQ_DOORBELL);
1058 #ifndef RTE_ARCH_64
1059         rte_spinlock_init(&uar->bf_sl);
1060         rte_spinlock_init(&uar->cq_sl);
1061         uar->bf_db.sl_p = &uar->bf_sl;
1062         uar->cq_db.sl_p = &uar->cq_sl;
1063 #endif /* RTE_ARCH_64 */
1064         return 0;
1065 }
1066
1067 RTE_PMD_EXPORT_NAME(mlx5_common_driver, __COUNTER__);