common/mlx5: share protection domain object
[dpdk.git] / 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
14 #include "mlx5_common.h"
15 #include "mlx5_common_os.h"
16 #include "mlx5_common_log.h"
17 #include "mlx5_common_defs.h"
18 #include "mlx5_common_private.h"
19
20 uint8_t haswell_broadwell_cpu;
21
22 /* In case this is an x86_64 intel processor to check if
23  * we should use relaxed ordering.
24  */
25 #ifdef RTE_ARCH_X86_64
26 /**
27  * This function returns processor identification and feature information
28  * into the registers.
29  *
30  * @param eax, ebx, ecx, edx
31  *              Pointers to the registers that will hold cpu information.
32  * @param level
33  *              The main category of information returned.
34  */
35 static inline void mlx5_cpu_id(unsigned int level,
36                                 unsigned int *eax, unsigned int *ebx,
37                                 unsigned int *ecx, unsigned int *edx)
38 {
39         __asm__("cpuid\n\t"
40                 : "=a" (*eax), "=b" (*ebx), "=c" (*ecx), "=d" (*edx)
41                 : "0" (level));
42 }
43 #endif
44
45 RTE_LOG_REGISTER_DEFAULT(mlx5_common_logtype, NOTICE)
46
47 /* Head of list of drivers. */
48 static TAILQ_HEAD(mlx5_drivers, mlx5_class_driver) drivers_list =
49                                 TAILQ_HEAD_INITIALIZER(drivers_list);
50
51 /* Head of devices. */
52 static TAILQ_HEAD(mlx5_devices, mlx5_common_device) devices_list =
53                                 TAILQ_HEAD_INITIALIZER(devices_list);
54 static pthread_mutex_t devices_list_lock;
55
56 static const struct {
57         const char *name;
58         unsigned int drv_class;
59 } mlx5_classes[] = {
60         { .name = "vdpa", .drv_class = MLX5_CLASS_VDPA },
61         { .name = "eth", .drv_class = MLX5_CLASS_ETH },
62         /* Keep class "net" for backward compatibility. */
63         { .name = "net", .drv_class = MLX5_CLASS_ETH },
64         { .name = "regex", .drv_class = MLX5_CLASS_REGEX },
65         { .name = "compress", .drv_class = MLX5_CLASS_COMPRESS },
66         { .name = "crypto", .drv_class = MLX5_CLASS_CRYPTO },
67 };
68
69 static int
70 class_name_to_value(const char *class_name)
71 {
72         unsigned int i;
73
74         for (i = 0; i < RTE_DIM(mlx5_classes); i++) {
75                 if (strcmp(class_name, mlx5_classes[i].name) == 0)
76                         return mlx5_classes[i].drv_class;
77         }
78         return -EINVAL;
79 }
80
81 static struct mlx5_class_driver *
82 driver_get(uint32_t class)
83 {
84         struct mlx5_class_driver *driver;
85
86         TAILQ_FOREACH(driver, &drivers_list, next) {
87                 if ((uint32_t)driver->drv_class == class)
88                         return driver;
89         }
90         return NULL;
91 }
92
93 /**
94  * Verify and store value for devargs.
95  *
96  * @param[in] key
97  *   Key argument to verify.
98  * @param[in] val
99  *   Value associated with key.
100  * @param opaque
101  *   User data.
102  *
103  * @return
104  *   0 on success, a negative errno value otherwise and rte_errno is set.
105  */
106 static int
107 mlx5_common_args_check_handler(const char *key, const char *val, void *opaque)
108 {
109         struct mlx5_common_dev_config *config = opaque;
110         signed long tmp;
111
112         errno = 0;
113         tmp = strtol(val, NULL, 0);
114         if (errno) {
115                 rte_errno = errno;
116                 DRV_LOG(WARNING, "%s: \"%s\" is an invalid integer.", key, val);
117                 return -rte_errno;
118         }
119         if (strcmp(key, "tx_db_nc") == 0) {
120                 if (tmp != MLX5_TXDB_CACHED &&
121                     tmp != MLX5_TXDB_NCACHED &&
122                     tmp != MLX5_TXDB_HEURISTIC) {
123                         DRV_LOG(ERR, "Invalid Tx doorbell mapping parameter.");
124                         rte_errno = EINVAL;
125                         return -rte_errno;
126                 }
127                 config->dbnc = tmp;
128         } else if (strcmp(key, "mr_ext_memseg_en") == 0) {
129                 config->mr_ext_memseg_en = !!tmp;
130         } else if (strcmp(key, "mr_mempool_reg_en") == 0) {
131                 config->mr_mempool_reg_en = !!tmp;
132         } else if (strcmp(key, "sys_mem_en") == 0) {
133                 config->sys_mem_en = !!tmp;
134         }
135         return 0;
136 }
137
138 /**
139  * Parse common device parameters.
140  *
141  * @param devargs
142  *   Device arguments structure.
143  * @param config
144  *   Pointer to device configuration structure.
145  *
146  * @return
147  *   0 on success, a negative errno value otherwise and rte_errno is set.
148  */
149 static int
150 mlx5_common_config_get(struct rte_devargs *devargs,
151                        struct mlx5_common_dev_config *config)
152 {
153         struct rte_kvargs *kvlist;
154         int ret = 0;
155
156         /* Set defaults. */
157         config->mr_ext_memseg_en = 1;
158         config->mr_mempool_reg_en = 1;
159         config->sys_mem_en = 0;
160         config->dbnc = MLX5_ARG_UNSET;
161         if (devargs == NULL)
162                 return 0;
163         kvlist = rte_kvargs_parse(devargs->args, NULL);
164         if (kvlist == NULL) {
165                 rte_errno = EINVAL;
166                 return -rte_errno;
167         }
168         ret = rte_kvargs_process(kvlist, NULL, mlx5_common_args_check_handler,
169                                  config);
170         if (ret)
171                 ret = -rte_errno;
172         rte_kvargs_free(kvlist);
173         DRV_LOG(DEBUG, "mr_ext_memseg_en is %u.", config->mr_ext_memseg_en);
174         DRV_LOG(DEBUG, "mr_mempool_reg_en is %u.", config->mr_mempool_reg_en);
175         DRV_LOG(DEBUG, "sys_mem_en is %u.", config->sys_mem_en);
176         DRV_LOG(DEBUG, "Tx doorbell mapping parameter is %d.", config->dbnc);
177         return ret;
178 }
179
180 static int
181 devargs_class_handler(__rte_unused const char *key,
182                       const char *class_names, void *opaque)
183 {
184         int *ret = opaque;
185         int class_val;
186         char *scratch;
187         char *found;
188         char *refstr = NULL;
189
190         *ret = 0;
191         scratch = strdup(class_names);
192         if (scratch == NULL) {
193                 *ret = -ENOMEM;
194                 return *ret;
195         }
196         found = strtok_r(scratch, ":", &refstr);
197         if (found == NULL)
198                 /* Empty string. */
199                 goto err;
200         do {
201                 /* Extract each individual class name. Multiple
202                  * classes can be supplied as class=net:regex:foo:bar.
203                  */
204                 class_val = class_name_to_value(found);
205                 /* Check if its a valid class. */
206                 if (class_val < 0) {
207                         *ret = -EINVAL;
208                         goto err;
209                 }
210                 *ret |= class_val;
211                 found = strtok_r(NULL, ":", &refstr);
212         } while (found != NULL);
213 err:
214         free(scratch);
215         if (*ret < 0)
216                 DRV_LOG(ERR, "Invalid mlx5 class options: %s.\n", class_names);
217         return *ret;
218 }
219
220 static int
221 parse_class_options(const struct rte_devargs *devargs)
222 {
223         struct rte_kvargs *kvlist;
224         int ret = 0;
225
226         if (devargs == NULL)
227                 return 0;
228         if (devargs->cls != NULL && devargs->cls->name != NULL)
229                 /* Global syntax, only one class type. */
230                 return class_name_to_value(devargs->cls->name);
231         /* Legacy devargs support multiple classes. */
232         kvlist = rte_kvargs_parse(devargs->args, NULL);
233         if (kvlist == NULL)
234                 return 0;
235         rte_kvargs_process(kvlist, RTE_DEVARGS_KEY_CLASS,
236                            devargs_class_handler, &ret);
237         rte_kvargs_free(kvlist);
238         return ret;
239 }
240
241 static const unsigned int mlx5_class_invalid_combinations[] = {
242         MLX5_CLASS_ETH | MLX5_CLASS_VDPA,
243         /* New class combination should be added here. */
244 };
245
246 static int
247 is_valid_class_combination(uint32_t user_classes)
248 {
249         unsigned int i;
250
251         /* Verify if user specified unsupported combination. */
252         for (i = 0; i < RTE_DIM(mlx5_class_invalid_combinations); i++) {
253                 if ((mlx5_class_invalid_combinations[i] & user_classes) ==
254                     mlx5_class_invalid_combinations[i])
255                         return -EINVAL;
256         }
257         /* Not found any invalid class combination. */
258         return 0;
259 }
260
261 static bool
262 device_class_enabled(const struct mlx5_common_device *device, uint32_t class)
263 {
264         return (device->classes_loaded & class) > 0;
265 }
266
267 static bool
268 mlx5_bus_match(const struct mlx5_class_driver *drv,
269                const struct rte_device *dev)
270 {
271         if (mlx5_dev_is_pci(dev))
272                 return mlx5_dev_pci_match(drv, dev);
273         return true;
274 }
275
276 static struct mlx5_common_device *
277 to_mlx5_device(const struct rte_device *rte_dev)
278 {
279         struct mlx5_common_device *cdev;
280
281         TAILQ_FOREACH(cdev, &devices_list, next) {
282                 if (rte_dev == cdev->dev)
283                         return cdev;
284         }
285         return NULL;
286 }
287
288 int
289 mlx5_dev_to_pci_str(const struct rte_device *dev, char *addr, size_t size)
290 {
291         struct rte_pci_addr pci_addr = { 0 };
292         int ret;
293
294         if (mlx5_dev_is_pci(dev)) {
295                 /* Input might be <BDF>, format PCI address to <DBDF>. */
296                 ret = rte_pci_addr_parse(dev->name, &pci_addr);
297                 if (ret != 0)
298                         return -ENODEV;
299                 rte_pci_device_name(&pci_addr, addr, size);
300                 return 0;
301         }
302 #ifdef RTE_EXEC_ENV_LINUX
303         return mlx5_auxiliary_get_pci_str(RTE_DEV_TO_AUXILIARY_CONST(dev),
304                         addr, size);
305 #else
306         rte_errno = ENODEV;
307         return -rte_errno;
308 #endif
309 }
310
311 /**
312  * Uninitialize all HW global of device context.
313  *
314  * @param cdev
315  *   Pointer to mlx5 device structure.
316  *
317  * @return
318  *   0 on success, a negative errno value otherwise and rte_errno is set.
319  */
320 static void
321 mlx5_dev_hw_global_release(struct mlx5_common_device *cdev)
322 {
323         if (cdev->pd != NULL) {
324                 claim_zero(mlx5_os_dealloc_pd(cdev->pd));
325                 cdev->pd = NULL;
326         }
327         if (cdev->ctx != NULL) {
328                 claim_zero(mlx5_glue->close_device(cdev->ctx));
329                 cdev->ctx = NULL;
330         }
331 }
332
333 /**
334  * Initialize all HW global of device context.
335  *
336  * @param cdev
337  *   Pointer to mlx5 device structure.
338  * @param classes
339  *   Chosen classes come from user device arguments.
340  *
341  * @return
342  *   0 on success, a negative errno value otherwise and rte_errno is set.
343  */
344 static int
345 mlx5_dev_hw_global_prepare(struct mlx5_common_device *cdev, uint32_t classes)
346 {
347         int ret;
348
349         /* Create context device */
350         ret = mlx5_os_open_device(cdev, classes);
351         if (ret < 0)
352                 return ret;
353         /* Allocate Protection Domain object and extract its pdn. */
354         ret = mlx5_os_pd_create(cdev);
355         if (ret)
356                 goto error;
357         return 0;
358 error:
359         mlx5_dev_hw_global_release(cdev);
360         return ret;
361 }
362
363 static void
364 mlx5_common_dev_release(struct mlx5_common_device *cdev)
365 {
366         pthread_mutex_lock(&devices_list_lock);
367         TAILQ_REMOVE(&devices_list, cdev, next);
368         pthread_mutex_unlock(&devices_list_lock);
369         if (rte_eal_process_type() == RTE_PROC_PRIMARY)
370                 mlx5_dev_hw_global_release(cdev);
371         rte_free(cdev);
372 }
373
374 static struct mlx5_common_device *
375 mlx5_common_dev_create(struct rte_device *eal_dev, uint32_t classes)
376 {
377         struct mlx5_common_device *cdev;
378         int ret;
379
380         cdev = rte_zmalloc("mlx5_common_device", sizeof(*cdev), 0);
381         if (!cdev) {
382                 DRV_LOG(ERR, "Device allocation failure.");
383                 rte_errno = ENOMEM;
384                 return NULL;
385         }
386         cdev->dev = eal_dev;
387         if (rte_eal_process_type() != RTE_PROC_PRIMARY)
388                 goto exit;
389         /* Parse device parameters. */
390         ret = mlx5_common_config_get(eal_dev->devargs, &cdev->config);
391         if (ret < 0) {
392                 DRV_LOG(ERR, "Failed to process device arguments: %s",
393                         strerror(rte_errno));
394                 rte_free(cdev);
395                 return NULL;
396         }
397         mlx5_malloc_mem_select(cdev->config.sys_mem_en);
398         /* Initialize all HW global of device context. */
399         ret = mlx5_dev_hw_global_prepare(cdev, classes);
400         if (ret) {
401                 DRV_LOG(ERR, "Failed to initialize device context.");
402                 rte_free(cdev);
403                 return NULL;
404         }
405 exit:
406         pthread_mutex_lock(&devices_list_lock);
407         TAILQ_INSERT_HEAD(&devices_list, cdev, next);
408         pthread_mutex_unlock(&devices_list_lock);
409         return cdev;
410 }
411
412 static int
413 drivers_remove(struct mlx5_common_device *cdev, uint32_t enabled_classes)
414 {
415         struct mlx5_class_driver *driver;
416         int local_ret = -ENODEV;
417         unsigned int i = 0;
418         int ret = 0;
419
420         enabled_classes &= cdev->classes_loaded;
421         while (enabled_classes) {
422                 driver = driver_get(RTE_BIT64(i));
423                 if (driver != NULL) {
424                         local_ret = driver->remove(cdev);
425                         if (local_ret == 0)
426                                 cdev->classes_loaded &= ~RTE_BIT64(i);
427                         else if (ret == 0)
428                                 ret = local_ret;
429                 }
430                 enabled_classes &= ~RTE_BIT64(i);
431                 i++;
432         }
433         if (local_ret != 0 && ret == 0)
434                 ret = local_ret;
435         return ret;
436 }
437
438 static int
439 drivers_probe(struct mlx5_common_device *cdev, uint32_t user_classes)
440 {
441         struct mlx5_class_driver *driver;
442         uint32_t enabled_classes = 0;
443         bool already_loaded;
444         int ret;
445
446         TAILQ_FOREACH(driver, &drivers_list, next) {
447                 if ((driver->drv_class & user_classes) == 0)
448                         continue;
449                 if (!mlx5_bus_match(driver, cdev->dev))
450                         continue;
451                 already_loaded = cdev->classes_loaded & driver->drv_class;
452                 if (already_loaded && driver->probe_again == 0) {
453                         DRV_LOG(ERR, "Device %s is already probed",
454                                 cdev->dev->name);
455                         ret = -EEXIST;
456                         goto probe_err;
457                 }
458                 ret = driver->probe(cdev);
459                 if (ret < 0) {
460                         DRV_LOG(ERR, "Failed to load driver %s",
461                                 driver->name);
462                         goto probe_err;
463                 }
464                 enabled_classes |= driver->drv_class;
465         }
466         cdev->classes_loaded |= enabled_classes;
467         return 0;
468 probe_err:
469         /* Only unload drivers which are enabled which were enabled
470          * in this probe instance.
471          */
472         drivers_remove(cdev, enabled_classes);
473         return ret;
474 }
475
476 int
477 mlx5_common_dev_probe(struct rte_device *eal_dev)
478 {
479         struct mlx5_common_device *cdev;
480         uint32_t classes = 0;
481         bool new_device = false;
482         int ret;
483
484         DRV_LOG(INFO, "probe device \"%s\".", eal_dev->name);
485         ret = parse_class_options(eal_dev->devargs);
486         if (ret < 0) {
487                 DRV_LOG(ERR, "Unsupported mlx5 class type: %s",
488                         eal_dev->devargs->args);
489                 return ret;
490         }
491         classes = ret;
492         if (classes == 0)
493                 /* Default to net class. */
494                 classes = MLX5_CLASS_ETH;
495         cdev = to_mlx5_device(eal_dev);
496         if (!cdev) {
497                 cdev = mlx5_common_dev_create(eal_dev, classes);
498                 if (!cdev)
499                         return -ENOMEM;
500                 new_device = true;
501         }
502         /*
503          * Validate combination here.
504          * For new device, the classes_loaded field is 0 and it check only
505          * the classes given as user device arguments.
506          */
507         ret = is_valid_class_combination(classes | cdev->classes_loaded);
508         if (ret != 0) {
509                 DRV_LOG(ERR, "Unsupported mlx5 classes combination.");
510                 goto class_err;
511         }
512         ret = drivers_probe(cdev, classes);
513         if (ret)
514                 goto class_err;
515         return 0;
516 class_err:
517         if (new_device)
518                 mlx5_common_dev_release(cdev);
519         return ret;
520 }
521
522 int
523 mlx5_common_dev_remove(struct rte_device *eal_dev)
524 {
525         struct mlx5_common_device *cdev;
526         int ret;
527
528         cdev = to_mlx5_device(eal_dev);
529         if (!cdev)
530                 return -ENODEV;
531         /* Matching device found, cleanup and unload drivers. */
532         ret = drivers_remove(cdev, cdev->classes_loaded);
533         if (ret == 0)
534                 mlx5_common_dev_release(cdev);
535         return ret;
536 }
537
538 int
539 mlx5_common_dev_dma_map(struct rte_device *dev, void *addr, uint64_t iova,
540                         size_t len)
541 {
542         struct mlx5_class_driver *driver = NULL;
543         struct mlx5_class_driver *temp;
544         struct mlx5_common_device *mdev;
545         int ret = -EINVAL;
546
547         mdev = to_mlx5_device(dev);
548         if (!mdev)
549                 return -ENODEV;
550         TAILQ_FOREACH(driver, &drivers_list, next) {
551                 if (!device_class_enabled(mdev, driver->drv_class) ||
552                     driver->dma_map == NULL)
553                         continue;
554                 ret = driver->dma_map(dev, addr, iova, len);
555                 if (ret)
556                         goto map_err;
557         }
558         return ret;
559 map_err:
560         TAILQ_FOREACH(temp, &drivers_list, next) {
561                 if (temp == driver)
562                         break;
563                 if (device_class_enabled(mdev, temp->drv_class) &&
564                     temp->dma_map && temp->dma_unmap)
565                         temp->dma_unmap(dev, addr, iova, len);
566         }
567         return ret;
568 }
569
570 int
571 mlx5_common_dev_dma_unmap(struct rte_device *dev, void *addr, uint64_t iova,
572                           size_t len)
573 {
574         struct mlx5_class_driver *driver;
575         struct mlx5_common_device *mdev;
576         int local_ret = -EINVAL;
577         int ret = 0;
578
579         mdev = to_mlx5_device(dev);
580         if (!mdev)
581                 return -ENODEV;
582         /* There is no unmap error recovery in current implementation. */
583         TAILQ_FOREACH_REVERSE(driver, &drivers_list, mlx5_drivers, next) {
584                 if (!device_class_enabled(mdev, driver->drv_class) ||
585                     driver->dma_unmap == NULL)
586                         continue;
587                 local_ret = driver->dma_unmap(dev, addr, iova, len);
588                 if (local_ret && (ret == 0))
589                         ret = local_ret;
590         }
591         if (local_ret)
592                 ret = local_ret;
593         return ret;
594 }
595
596 void
597 mlx5_class_driver_register(struct mlx5_class_driver *driver)
598 {
599         mlx5_common_driver_on_register_pci(driver);
600         TAILQ_INSERT_TAIL(&drivers_list, driver, next);
601 }
602
603 static void mlx5_common_driver_init(void)
604 {
605         mlx5_common_pci_init();
606 #ifdef RTE_EXEC_ENV_LINUX
607         mlx5_common_auxiliary_init();
608 #endif
609 }
610
611 static bool mlx5_common_initialized;
612
613 /**
614  * One time innitialization routine for run-time dependency on glue library
615  * for multiple PMDs. Each mlx5 PMD that depends on mlx5_common module,
616  * must invoke in its constructor.
617  */
618 void
619 mlx5_common_init(void)
620 {
621         if (mlx5_common_initialized)
622                 return;
623
624         pthread_mutex_init(&devices_list_lock, NULL);
625         mlx5_glue_constructor();
626         mlx5_common_driver_init();
627         mlx5_common_initialized = true;
628 }
629
630 /**
631  * This function is responsible of initializing the variable
632  *  haswell_broadwell_cpu by checking if the cpu is intel
633  *  and reading the data returned from mlx5_cpu_id().
634  *  since haswell and broadwell cpus don't have improved performance
635  *  when using relaxed ordering we want to check the cpu type before
636  *  before deciding whether to enable RO or not.
637  *  if the cpu is haswell or broadwell the variable will be set to 1
638  *  otherwise it will be 0.
639  */
640 RTE_INIT_PRIO(mlx5_is_haswell_broadwell_cpu, LOG)
641 {
642 #ifdef RTE_ARCH_X86_64
643         unsigned int broadwell_models[4] = {0x3d, 0x47, 0x4F, 0x56};
644         unsigned int haswell_models[4] = {0x3c, 0x3f, 0x45, 0x46};
645         unsigned int i, model, family, brand_id, vendor;
646         unsigned int signature_intel_ebx = 0x756e6547;
647         unsigned int extended_model;
648         unsigned int eax = 0;
649         unsigned int ebx = 0;
650         unsigned int ecx = 0;
651         unsigned int edx = 0;
652         int max_level;
653
654         mlx5_cpu_id(0, &eax, &ebx, &ecx, &edx);
655         vendor = ebx;
656         max_level = eax;
657         if (max_level < 1) {
658                 haswell_broadwell_cpu = 0;
659                 return;
660         }
661         mlx5_cpu_id(1, &eax, &ebx, &ecx, &edx);
662         model = (eax >> 4) & 0x0f;
663         family = (eax >> 8) & 0x0f;
664         brand_id = ebx & 0xff;
665         extended_model = (eax >> 12) & 0xf0;
666         /* Check if the processor is Haswell or Broadwell */
667         if (vendor == signature_intel_ebx) {
668                 if (family == 0x06)
669                         model += extended_model;
670                 if (brand_id == 0 && family == 0x6) {
671                         for (i = 0; i < RTE_DIM(broadwell_models); i++)
672                                 if (model == broadwell_models[i]) {
673                                         haswell_broadwell_cpu = 1;
674                                         return;
675                                 }
676                         for (i = 0; i < RTE_DIM(haswell_models); i++)
677                                 if (model == haswell_models[i]) {
678                                         haswell_broadwell_cpu = 1;
679                                         return;
680                                 }
681                 }
682         }
683 #endif
684         haswell_broadwell_cpu = 0;
685 }
686
687 /**
688  * Allocate the User Access Region with DevX on specified device.
689  *
690  * @param [in] ctx
691  *   Infiniband device context to perform allocation on.
692  * @param [in] mapping
693  *   MLX5DV_UAR_ALLOC_TYPE_BF - allocate as cached memory with write-combining
694  *                              attributes (if supported by the host), the
695  *                              writes to the UAR registers must be followed
696  *                              by write memory barrier.
697  *   MLX5DV_UAR_ALLOC_TYPE_NC - allocate as non-cached nenory, all writes are
698  *                              promoted to the registers immediately, no
699  *                              memory barriers needed.
700  *   mapping < 0 - the first attempt is performed with MLX5DV_UAR_ALLOC_TYPE_BF,
701  *                 if this fails the next attempt with MLX5DV_UAR_ALLOC_TYPE_NC
702  *                 is performed. The drivers specifying negative values should
703  *                 always provide the write memory barrier operation after UAR
704  *                 register writings.
705  * If there is no definitions for the MLX5DV_UAR_ALLOC_TYPE_xx (older rdma
706  * library headers), the caller can specify 0.
707  *
708  * @return
709  *   UAR object pointer on success, NULL otherwise and rte_errno is set.
710  */
711 void *
712 mlx5_devx_alloc_uar(void *ctx, int mapping)
713 {
714         void *uar;
715         uint32_t retry, uar_mapping;
716         void *base_addr;
717
718         for (retry = 0; retry < MLX5_ALLOC_UAR_RETRY; ++retry) {
719 #ifdef MLX5DV_UAR_ALLOC_TYPE_NC
720                 /* Control the mapping type according to the settings. */
721                 uar_mapping = (mapping < 0) ?
722                               MLX5DV_UAR_ALLOC_TYPE_NC : mapping;
723 #else
724                 /*
725                  * It seems we have no way to control the memory mapping type
726                  * for the UAR, the default "Write-Combining" type is supposed.
727                  */
728                 uar_mapping = 0;
729                 RTE_SET_USED(mapping);
730 #endif
731                 uar = mlx5_glue->devx_alloc_uar(ctx, uar_mapping);
732 #ifdef MLX5DV_UAR_ALLOC_TYPE_NC
733                 if (!uar &&
734                     mapping < 0 &&
735                     uar_mapping == MLX5DV_UAR_ALLOC_TYPE_BF) {
736                         /*
737                          * In some environments like virtual machine the
738                          * Write Combining mapped might be not supported and
739                          * UAR allocation fails. We tried "Non-Cached" mapping
740                          * for the case.
741                          */
742                         DRV_LOG(WARNING, "Failed to allocate DevX UAR (BF)");
743                         uar_mapping = MLX5DV_UAR_ALLOC_TYPE_NC;
744                         uar = mlx5_glue->devx_alloc_uar(ctx, uar_mapping);
745                 } else if (!uar &&
746                            mapping < 0 &&
747                            uar_mapping == MLX5DV_UAR_ALLOC_TYPE_NC) {
748                         /*
749                          * If Verbs/kernel does not support "Non-Cached"
750                          * try the "Write-Combining".
751                          */
752                         DRV_LOG(WARNING, "Failed to allocate DevX UAR (NC)");
753                         uar_mapping = MLX5DV_UAR_ALLOC_TYPE_BF;
754                         uar = mlx5_glue->devx_alloc_uar(ctx, uar_mapping);
755                 }
756 #endif
757                 if (!uar) {
758                         DRV_LOG(ERR, "Failed to allocate DevX UAR (BF/NC)");
759                         rte_errno = ENOMEM;
760                         goto exit;
761                 }
762                 base_addr = mlx5_os_get_devx_uar_base_addr(uar);
763                 if (base_addr)
764                         break;
765                 /*
766                  * The UARs are allocated by rdma_core within the
767                  * IB device context, on context closure all UARs
768                  * will be freed, should be no memory/object leakage.
769                  */
770                 DRV_LOG(WARNING, "Retrying to allocate DevX UAR");
771                 uar = NULL;
772         }
773         /* Check whether we finally succeeded with valid UAR allocation. */
774         if (!uar) {
775                 DRV_LOG(ERR, "Failed to allocate DevX UAR (NULL base)");
776                 rte_errno = ENOMEM;
777         }
778         /*
779          * Return void * instead of struct mlx5dv_devx_uar *
780          * is for compatibility with older rdma-core library headers.
781          */
782 exit:
783         return uar;
784 }
785
786 RTE_PMD_EXPORT_NAME(mlx5_common_driver, __COUNTER__);