lib/librte_eal/linuxapp/eal/eal_vfio.c

   1 /* SPDX-License-Identifier: BSD-3-Clause
   2  * Copyright(c) 2010-2018 Intel Corporation
   3  */
   4
   5 #include <inttypes.h>
   6 #include <string.h>
   7 #include <fcntl.h>
   8 #include <unistd.h>
   9 #include <sys/ioctl.h>
  10
  11 #include <rte_errno.h>
  12 #include <rte_log.h>
  13 #include <rte_memory.h>
  14 #include <rte_eal_memconfig.h>
  15 #include <rte_vfio.h>
  16
  17 #include "eal_filesystem.h"
  18 #include "eal_vfio.h"
  19 #include "eal_private.h"
  20
  21 #ifdef VFIO_PRESENT
  22
  23 #define VFIO_MEM_EVENT_CLB_NAME "vfio_mem_event_clb"
  24
  25 /* hot plug/unplug of VFIO groups may cause all DMA maps to be dropped. we can
  26  * recreate the mappings for DPDK segments, but we cannot do so for memory that
  27  * was registered by the user themselves, so we need to store the user mappings
  28  * somewhere, to recreate them later.
  29  */
  30 #define VFIO_MAX_USER_MEM_MAPS 256
  31 struct user_mem_map {
  32         uint64_t addr;
  33         uint64_t iova;
  34         uint64_t len;
  35 };
  36
  37 struct user_mem_maps {
  38         rte_spinlock_recursive_t lock;
  39         int n_maps;
  40         struct user_mem_map maps[VFIO_MAX_USER_MEM_MAPS];
  41 };
  42
  43 struct vfio_config {
  44         int vfio_enabled;
  45         int vfio_container_fd;
  46         int vfio_active_groups;
  47         const struct vfio_iommu_type *vfio_iommu_type;
  48         struct vfio_group vfio_groups[VFIO_MAX_GROUPS];
  49         struct user_mem_maps mem_maps;
  50 };
  51
  52 /* per-process VFIO config */
  53 static struct vfio_config vfio_cfgs[VFIO_MAX_CONTAINERS];
  54 static struct vfio_config *default_vfio_cfg = &vfio_cfgs[0];
  55
  56 static int vfio_type1_dma_map(int);
  57 static int vfio_type1_dma_mem_map(int, uint64_t, uint64_t, uint64_t, int);
  58 static int vfio_spapr_dma_map(int);
  59 static int vfio_spapr_dma_mem_map(int, uint64_t, uint64_t, uint64_t, int);
  60 static int vfio_noiommu_dma_map(int);
  61 static int vfio_noiommu_dma_mem_map(int, uint64_t, uint64_t, uint64_t, int);
  62 static int vfio_dma_mem_map(struct vfio_config *vfio_cfg, uint64_t vaddr,
  63                 uint64_t iova, uint64_t len, int do_map);
  64
  65 /* IOMMU types we support */
  66 static const struct vfio_iommu_type iommu_types[] = {
  67         /* x86 IOMMU, otherwise known as type 1 */
  68         {
  69                 .type_id = RTE_VFIO_TYPE1,
  70                 .name = "Type 1",
  71                 .dma_map_func = &vfio_type1_dma_map,
  72                 .dma_user_map_func = &vfio_type1_dma_mem_map
  73         },
  74         /* ppc64 IOMMU, otherwise known as spapr */
  75         {
  76                 .type_id = RTE_VFIO_SPAPR,
  77                 .name = "sPAPR",
  78                 .dma_map_func = &vfio_spapr_dma_map,
  79                 .dma_user_map_func = &vfio_spapr_dma_mem_map
  80         },
  81         /* IOMMU-less mode */
  82         {
  83                 .type_id = RTE_VFIO_NOIOMMU,
  84                 .name = "No-IOMMU",
  85                 .dma_map_func = &vfio_noiommu_dma_map,
  86                 .dma_user_map_func = &vfio_noiommu_dma_mem_map
  87         },
  88 };
  89
  90 static int
  91 is_null_map(const struct user_mem_map *map)
  92 {
  93         return map->addr == 0 && map->iova == 0 && map->len == 0;
  94 }
  95
  96 /* we may need to merge user mem maps together in case of user mapping/unmapping
  97  * chunks of memory, so we'll need a comparator function to sort segments.
  98  */
  99 static int
 100 user_mem_map_cmp(const void *a, const void *b)
 101 {
 102         const struct user_mem_map *umm_a = a;
 103         const struct user_mem_map *umm_b = b;
 104
 105         /* move null entries to end */
 106         if (is_null_map(umm_a))
 107                 return 1;
 108         if (is_null_map(umm_b))
 109                 return -1;
 110
 111         /* sort by iova first */
 112         if (umm_a->iova < umm_b->iova)
 113                 return -1;
 114         if (umm_a->iova > umm_b->iova)
 115                 return 1;
 116
 117         if (umm_a->addr < umm_b->addr)
 118                 return -1;
 119         if (umm_a->addr > umm_b->addr)
 120                 return 1;
 121
 122         if (umm_a->len < umm_b->len)
 123                 return -1;
 124         if (umm_a->len > umm_b->len)
 125                 return 1;
 126
 127         return 0;
 128 }
 129
 130 /* adjust user map entry. this may result in shortening of existing map, or in
 131  * splitting existing map in two pieces.
 132  */
 133 static void
 134 adjust_map(struct user_mem_map *src, struct user_mem_map *end,
 135                 uint64_t remove_va_start, uint64_t remove_len)
 136 {
 137         /* if va start is same as start address, we're simply moving start */
 138         if (remove_va_start == src->addr) {
 139                 src->addr += remove_len;
 140                 src->iova += remove_len;
 141                 src->len -= remove_len;
 142         } else if (remove_va_start + remove_len == src->addr + src->len) {
 143                 /* we're shrinking mapping from the end */
 144                 src->len -= remove_len;
 145         } else {
 146                 /* we're blowing a hole in the middle */
 147                 struct user_mem_map tmp;
 148                 uint64_t total_len = src->len;
 149
 150                 /* adjust source segment length */
 151                 src->len = remove_va_start - src->addr;
 152
 153                 /* create temporary segment in the middle */
 154                 tmp.addr = src->addr + src->len;
 155                 tmp.iova = src->iova + src->len;
 156                 tmp.len = remove_len;
 157
 158                 /* populate end segment - this one we will be keeping */
 159                 end->addr = tmp.addr + tmp.len;
 160                 end->iova = tmp.iova + tmp.len;
 161                 end->len = total_len - src->len - tmp.len;
 162         }
 163 }
 164
 165 /* try merging two maps into one, return 1 if succeeded */
 166 static int
 167 merge_map(struct user_mem_map *left, struct user_mem_map *right)
 168 {
 169         if (left->addr + left->len != right->addr)
 170                 return 0;
 171         if (left->iova + left->len != right->iova)
 172                 return 0;
 173
 174         left->len += right->len;
 175
 176         memset(right, 0, sizeof(*right));
 177
 178         return 1;
 179 }
 180
 181 static struct user_mem_map *
 182 find_user_mem_map(struct user_mem_maps *user_mem_maps, uint64_t addr,
 183                 uint64_t iova, uint64_t len)
 184 {
 185         uint64_t va_end = addr + len;
 186         uint64_t iova_end = iova + len;
 187         int i;
 188
 189         for (i = 0; i < user_mem_maps->n_maps; i++) {
 190                 struct user_mem_map *map = &user_mem_maps->maps[i];
 191                 uint64_t map_va_end = map->addr + map->len;
 192                 uint64_t map_iova_end = map->iova + map->len;
 193
 194                 /* check start VA */
 195                 if (addr < map->addr || addr >= map_va_end)
 196                         continue;
 197                 /* check if VA end is within boundaries */
 198                 if (va_end <= map->addr || va_end > map_va_end)
 199                         continue;
 200
 201                 /* check start IOVA */
 202                 if (iova < map->iova || iova >= map_iova_end)
 203                         continue;
 204                 /* check if IOVA end is within boundaries */
 205                 if (iova_end <= map->iova || iova_end > map_iova_end)
 206                         continue;
 207
 208                 /* we've found our map */
 209                 return map;
 210         }
 211         return NULL;
 212 }
 213
 214 /* this will sort all user maps, and merge/compact any adjacent maps */
 215 static void
 216 compact_user_maps(struct user_mem_maps *user_mem_maps)
 217 {
 218         int i, n_merged, cur_idx;
 219
 220         qsort(user_mem_maps->maps, user_mem_maps->n_maps,
 221                         sizeof(user_mem_maps->maps[0]), user_mem_map_cmp);
 222
 223         /* we'll go over the list backwards when merging */
 224         n_merged = 0;
 225         for (i = user_mem_maps->n_maps - 2; i >= 0; i--) {
 226                 struct user_mem_map *l, *r;
 227
 228                 l = &user_mem_maps->maps[i];
 229                 r = &user_mem_maps->maps[i + 1];
 230
 231                 if (is_null_map(l) || is_null_map(r))
 232                         continue;
 233
 234                 if (merge_map(l, r))
 235                         n_merged++;
 236         }
 237
 238         /* the entries are still sorted, but now they have holes in them, so
 239          * walk through the list and remove the holes
 240          */
 241         if (n_merged > 0) {
 242                 cur_idx = 0;
 243                 for (i = 0; i < user_mem_maps->n_maps; i++) {
 244                         if (!is_null_map(&user_mem_maps->maps[i])) {
 245                                 struct user_mem_map *src, *dst;
 246
 247                                 src = &user_mem_maps->maps[i];
 248                                 dst = &user_mem_maps->maps[cur_idx++];
 249
 250                                 if (src != dst) {
 251                                         memcpy(dst, src, sizeof(*src));
 252                                         memset(src, 0, sizeof(*src));
 253                                 }
 254                         }
 255                 }
 256                 user_mem_maps->n_maps = cur_idx;
 257         }
 258 }
 259
 260 static int
 261 vfio_open_group_fd(int iommu_group_num)
 262 {
 263         int vfio_group_fd;
 264         char filename[PATH_MAX];
 265         struct rte_mp_msg mp_req, *mp_rep;
 266         struct rte_mp_reply mp_reply;
 267         struct timespec ts = {.tv_sec = 5, .tv_nsec = 0};
 268         struct vfio_mp_param *p = (struct vfio_mp_param *)mp_req.param;
 269
 270         /* if primary, try to open the group */
 271         if (internal_config.process_type == RTE_PROC_PRIMARY) {
 272                 /* try regular group format */
 273                 snprintf(filename, sizeof(filename),
 274                                  VFIO_GROUP_FMT, iommu_group_num);
 275                 vfio_group_fd = open(filename, O_RDWR);
 276                 if (vfio_group_fd < 0) {
 277                         /* if file not found, it's not an error */
 278                         if (errno != ENOENT) {
 279                                 RTE_LOG(ERR, EAL, "Cannot open %s: %s\n", filename,
 280                                                 strerror(errno));
 281                                 return -1;
 282                         }
 283
 284                         /* special case: try no-IOMMU path as well */
 285                         snprintf(filename, sizeof(filename),
 286                                         VFIO_NOIOMMU_GROUP_FMT,
 287                                         iommu_group_num);
 288                         vfio_group_fd = open(filename, O_RDWR);
 289                         if (vfio_group_fd < 0) {
 290                                 if (errno != ENOENT) {
 291                                         RTE_LOG(ERR, EAL, "Cannot open %s: %s\n", filename,
 292                                                         strerror(errno));
 293                                         return -1;
 294                                 }
 295                                 return 0;
 296                         }
 297                         /* noiommu group found */
 298                 }
 299
 300                 return vfio_group_fd;
 301         }
 302         /* if we're in a secondary process, request group fd from the primary
 303          * process via mp channel.
 304          */
 305         p->req = SOCKET_REQ_GROUP;
 306         p->group_num = iommu_group_num;
 307         strcpy(mp_req.name, EAL_VFIO_MP);
 308         mp_req.len_param = sizeof(*p);
 309         mp_req.num_fds = 0;
 310
 311         vfio_group_fd = -1;
 312         if (rte_mp_request_sync(&mp_req, &mp_reply, &ts) == 0 &&
 313             mp_reply.nb_received == 1) {
 314                 mp_rep = &mp_reply.msgs[0];
 315                 p = (struct vfio_mp_param *)mp_rep->param;
 316                 if (p->result == SOCKET_OK && mp_rep->num_fds == 1) {
 317                         vfio_group_fd = mp_rep->fds[0];
 318                 } else if (p->result == SOCKET_NO_FD) {
 319                         RTE_LOG(ERR, EAL, "  bad VFIO group fd\n");
 320                         vfio_group_fd = 0;
 321                 }
 322                 free(mp_reply.msgs);
 323         }
 324
 325         if (vfio_group_fd < 0)
 326                 RTE_LOG(ERR, EAL, "  cannot request group fd\n");
 327         return vfio_group_fd;
 328 }
 329
 330 static struct vfio_config *
 331 get_vfio_cfg_by_group_num(int iommu_group_num)
 332 {
 333         struct vfio_config *vfio_cfg;
 334         int i, j;
 335
 336         for (i = 0; i < VFIO_MAX_CONTAINERS; i++) {
 337                 vfio_cfg = &vfio_cfgs[i];
 338                 for (j = 0; j < VFIO_MAX_GROUPS; j++) {
 339                         if (vfio_cfg->vfio_groups[j].group_num ==
 340                                         iommu_group_num)
 341                                 return vfio_cfg;
 342                 }
 343         }
 344
 345         return NULL;
 346 }
 347
 348 static int
 349 vfio_get_group_fd(struct vfio_config *vfio_cfg,
 350                 int iommu_group_num)
 351 {
 352         int i;
 353         int vfio_group_fd;
 354         struct vfio_group *cur_grp;
 355
 356         /* check if we already have the group descriptor open */
 357         for (i = 0; i < VFIO_MAX_GROUPS; i++)
 358                 if (vfio_cfg->vfio_groups[i].group_num == iommu_group_num)
 359                         return vfio_cfg->vfio_groups[i].fd;
 360
 361         /* Lets see first if there is room for a new group */
 362         if (vfio_cfg->vfio_active_groups == VFIO_MAX_GROUPS) {
 363                 RTE_LOG(ERR, EAL, "Maximum number of VFIO groups reached!\n");
 364                 return -1;
 365         }
 366
 367         /* Now lets get an index for the new group */
 368         for (i = 0; i < VFIO_MAX_GROUPS; i++)
 369                 if (vfio_cfg->vfio_groups[i].group_num == -1) {
 370                         cur_grp = &vfio_cfg->vfio_groups[i];
 371                         break;
 372                 }
 373
 374         /* This should not happen */
 375         if (i == VFIO_MAX_GROUPS) {
 376                 RTE_LOG(ERR, EAL, "No VFIO group free slot found\n");
 377                 return -1;
 378         }
 379
 380         vfio_group_fd = vfio_open_group_fd(iommu_group_num);
 381         if (vfio_group_fd < 0) {
 382                 RTE_LOG(ERR, EAL, "Failed to open group %d\n", iommu_group_num);
 383                 return -1;
 384         }
 385
 386         cur_grp->group_num = iommu_group_num;
 387         cur_grp->fd = vfio_group_fd;
 388         vfio_cfg->vfio_active_groups++;
 389
 390         return vfio_group_fd;
 391 }
 392
 393 static struct vfio_config *
 394 get_vfio_cfg_by_group_fd(int vfio_group_fd)
 395 {
 396         struct vfio_config *vfio_cfg;
 397         int i, j;
 398
 399         for (i = 0; i < VFIO_MAX_CONTAINERS; i++) {
 400                 vfio_cfg = &vfio_cfgs[i];
 401                 for (j = 0; j < VFIO_MAX_GROUPS; j++)
 402                         if (vfio_cfg->vfio_groups[j].fd == vfio_group_fd)
 403                                 return vfio_cfg;
 404         }
 405
 406         return NULL;
 407 }
 408
 409 static struct vfio_config *
 410 get_vfio_cfg_by_container_fd(int container_fd)
 411 {
 412         int i;
 413
 414         for (i = 0; i < VFIO_MAX_CONTAINERS; i++) {
 415                 if (vfio_cfgs[i].vfio_container_fd == container_fd)
 416                         return &vfio_cfgs[i];
 417         }
 418
 419         return NULL;
 420 }
 421
 422 int
 423 rte_vfio_get_group_fd(int iommu_group_num)
 424 {
 425         struct vfio_config *vfio_cfg;
 426
 427         /* get the vfio_config it belongs to */
 428         vfio_cfg = get_vfio_cfg_by_group_num(iommu_group_num);
 429         vfio_cfg = vfio_cfg ? vfio_cfg : default_vfio_cfg;
 430
 431         return vfio_get_group_fd(vfio_cfg, iommu_group_num);
 432 }
 433
 434 static int
 435 get_vfio_group_idx(int vfio_group_fd)
 436 {
 437         struct vfio_config *vfio_cfg;
 438         int i, j;
 439
 440         for (i = 0; i < VFIO_MAX_CONTAINERS; i++) {
 441                 vfio_cfg = &vfio_cfgs[i];
 442                 for (j = 0; j < VFIO_MAX_GROUPS; j++)
 443                         if (vfio_cfg->vfio_groups[j].fd == vfio_group_fd)
 444                                 return j;
 445         }
 446
 447         return -1;
 448 }
 449
 450 static void
 451 vfio_group_device_get(int vfio_group_fd)
 452 {
 453         struct vfio_config *vfio_cfg;
 454         int i;
 455
 456         vfio_cfg = get_vfio_cfg_by_group_fd(vfio_group_fd);
 457         if (vfio_cfg == NULL) {
 458                 RTE_LOG(ERR, EAL, "  invalid group fd!\n");
 459                 return;
 460         }
 461
 462         i = get_vfio_group_idx(vfio_group_fd);
 463         if (i < 0 || i > (VFIO_MAX_GROUPS - 1))
 464                 RTE_LOG(ERR, EAL, "  wrong vfio_group index (%d)\n", i);
 465         else
 466                 vfio_cfg->vfio_groups[i].devices++;
 467 }
 468
 469 static void
 470 vfio_group_device_put(int vfio_group_fd)
 471 {
 472         struct vfio_config *vfio_cfg;
 473         int i;
 474
 475         vfio_cfg = get_vfio_cfg_by_group_fd(vfio_group_fd);
 476         if (vfio_cfg == NULL) {
 477                 RTE_LOG(ERR, EAL, "  invalid group fd!\n");
 478                 return;
 479         }
 480
 481         i = get_vfio_group_idx(vfio_group_fd);
 482         if (i < 0 || i > (VFIO_MAX_GROUPS - 1))
 483                 RTE_LOG(ERR, EAL, "  wrong vfio_group index (%d)\n", i);
 484         else
 485                 vfio_cfg->vfio_groups[i].devices--;
 486 }
 487
 488 static int
 489 vfio_group_device_count(int vfio_group_fd)
 490 {
 491         struct vfio_config *vfio_cfg;
 492         int i;
 493
 494         vfio_cfg = get_vfio_cfg_by_group_fd(vfio_group_fd);
 495         if (vfio_cfg == NULL) {
 496                 RTE_LOG(ERR, EAL, "  invalid group fd!\n");
 497                 return -1;
 498         }
 499
 500         i = get_vfio_group_idx(vfio_group_fd);
 501         if (i < 0 || i > (VFIO_MAX_GROUPS - 1)) {
 502                 RTE_LOG(ERR, EAL, "  wrong vfio_group index (%d)\n", i);
 503                 return -1;
 504         }
 505
 506         return vfio_cfg->vfio_groups[i].devices;
 507 }
 508
 509 static void
 510 vfio_mem_event_callback(enum rte_mem_event type, const void *addr, size_t len,
 511                 void *arg __rte_unused)
 512 {
 513         struct rte_memseg_list *msl;
 514         struct rte_memseg *ms;
 515         size_t cur_len = 0;
 516
 517         msl = rte_mem_virt2memseg_list(addr);
 518
 519         /* for IOVA as VA mode, no need to care for IOVA addresses */
 520         if (rte_eal_iova_mode() == RTE_IOVA_VA && msl->external == 0) {
 521                 uint64_t vfio_va = (uint64_t)(uintptr_t)addr;
 522                 if (type == RTE_MEM_EVENT_ALLOC)
 523                         vfio_dma_mem_map(default_vfio_cfg, vfio_va, vfio_va,
 524                                         len, 1);
 525                 else
 526                         vfio_dma_mem_map(default_vfio_cfg, vfio_va, vfio_va,
 527                                         len, 0);
 528                 return;
 529         }
 530
 531         /* memsegs are contiguous in memory */
 532         ms = rte_mem_virt2memseg(addr, msl);
 533         while (cur_len < len) {
 534                 /* some memory segments may have invalid IOVA */
 535                 if (ms->iova == RTE_BAD_IOVA) {
 536                         RTE_LOG(DEBUG, EAL, "Memory segment at %p has bad IOVA, skipping\n",
 537                                         ms->addr);
 538                         goto next;
 539                 }
 540                 if (type == RTE_MEM_EVENT_ALLOC)
 541                         vfio_dma_mem_map(default_vfio_cfg, ms->addr_64,
 542                                         ms->iova, ms->len, 1);
 543                 else
 544                         vfio_dma_mem_map(default_vfio_cfg, ms->addr_64,
 545                                         ms->iova, ms->len, 0);
 546 next:
 547                 cur_len += ms->len;
 548                 ++ms;
 549         }
 550 }
 551
 552 int
 553 rte_vfio_clear_group(int vfio_group_fd)
 554 {
 555         int i;
 556         struct vfio_config *vfio_cfg;
 557
 558         vfio_cfg = get_vfio_cfg_by_group_fd(vfio_group_fd);
 559         if (vfio_cfg == NULL) {
 560                 RTE_LOG(ERR, EAL, "  invalid group fd!\n");
 561                 return -1;
 562         }
 563
 564         i = get_vfio_group_idx(vfio_group_fd);
 565         if (i < 0)
 566                 return -1;
 567         vfio_cfg->vfio_groups[i].group_num = -1;
 568         vfio_cfg->vfio_groups[i].fd = -1;
 569         vfio_cfg->vfio_groups[i].devices = 0;
 570         vfio_cfg->vfio_active_groups--;
 571
 572         return 0;
 573 }
 574
 575 int
 576 rte_vfio_setup_device(const char *sysfs_base, const char *dev_addr,
 577                 int *vfio_dev_fd, struct vfio_device_info *device_info)
 578 {
 579         struct rte_mem_config *mcfg = rte_eal_get_configuration()->mem_config;
 580         rte_rwlock_t *mem_lock = &mcfg->memory_hotplug_lock;
 581         struct vfio_group_status group_status = {
 582                         .argsz = sizeof(group_status)
 583         };
 584         struct vfio_config *vfio_cfg;
 585         struct user_mem_maps *user_mem_maps;
 586         int vfio_container_fd;
 587         int vfio_group_fd;
 588         int iommu_group_num;
 589         int i, ret;
 590
 591         /* get group number */
 592         ret = rte_vfio_get_group_num(sysfs_base, dev_addr, &iommu_group_num);
 593         if (ret == 0) {
 594                 RTE_LOG(WARNING, EAL, "  %s not managed by VFIO driver, skipping\n",
 595                         dev_addr);
 596                 return 1;
 597         }
 598
 599         /* if negative, something failed */
 600         if (ret < 0)
 601                 return -1;
 602
 603         /* get the actual group fd */
 604         vfio_group_fd = rte_vfio_get_group_fd(iommu_group_num);
 605         if (vfio_group_fd < 0)
 606                 return -1;
 607
 608         /* if group_fd == 0, that means the device isn't managed by VFIO */
 609         if (vfio_group_fd == 0) {
 610                 RTE_LOG(WARNING, EAL, " %s not managed by VFIO driver, skipping\n",
 611                                 dev_addr);
 612                 return 1;
 613         }
 614
 615         /*
 616          * at this point, we know that this group is viable (meaning, all devices
 617          * are either bound to VFIO or not bound to anything)
 618          */
 619
 620         /* check if the group is viable */
 621         ret = ioctl(vfio_group_fd, VFIO_GROUP_GET_STATUS, &group_status);
 622         if (ret) {
 623                 RTE_LOG(ERR, EAL, "  %s cannot get group status, "
 624                                 "error %i (%s)\n", dev_addr, errno, strerror(errno));
 625                 close(vfio_group_fd);
 626                 rte_vfio_clear_group(vfio_group_fd);
 627                 return -1;
 628         } else if (!(group_status.flags & VFIO_GROUP_FLAGS_VIABLE)) {
 629                 RTE_LOG(ERR, EAL, "  %s VFIO group is not viable!\n", dev_addr);
 630                 close(vfio_group_fd);
 631                 rte_vfio_clear_group(vfio_group_fd);
 632                 return -1;
 633         }
 634
 635         /* get the vfio_config it belongs to */
 636         vfio_cfg = get_vfio_cfg_by_group_num(iommu_group_num);
 637         vfio_cfg = vfio_cfg ? vfio_cfg : default_vfio_cfg;
 638         vfio_container_fd = vfio_cfg->vfio_container_fd;
 639         user_mem_maps = &vfio_cfg->mem_maps;
 640
 641         /* check if group does not have a container yet */
 642         if (!(group_status.flags & VFIO_GROUP_FLAGS_CONTAINER_SET)) {
 643
 644                 /* add group to a container */
 645                 ret = ioctl(vfio_group_fd, VFIO_GROUP_SET_CONTAINER,
 646                                 &vfio_container_fd);
 647                 if (ret) {
 648                         RTE_LOG(ERR, EAL, "  %s cannot add VFIO group to container, "
 649                                         "error %i (%s)\n", dev_addr, errno, strerror(errno));
 650                         close(vfio_group_fd);
 651                         rte_vfio_clear_group(vfio_group_fd);
 652                         return -1;
 653                 }
 654
 655                 /*
 656                  * pick an IOMMU type and set up DMA mappings for container
 657                  *
 658                  * needs to be done only once, only when first group is
 659                  * assigned to a container and only in primary process.
 660                  * Note this can happen several times with the hotplug
 661                  * functionality.
 662                  */
 663                 if (internal_config.process_type == RTE_PROC_PRIMARY &&
 664                                 vfio_cfg->vfio_active_groups == 1 &&
 665                                 vfio_group_device_count(vfio_group_fd) == 0) {
 666                         const struct vfio_iommu_type *t;
 667
 668                         /* select an IOMMU type which we will be using */
 669                         t = vfio_set_iommu_type(vfio_container_fd);
 670                         if (!t) {
 671                                 RTE_LOG(ERR, EAL,
 672                                         "  %s failed to select IOMMU type\n",
 673                                         dev_addr);
 674                                 close(vfio_group_fd);
 675                                 rte_vfio_clear_group(vfio_group_fd);
 676                                 return -1;
 677                         }
 678                         /* lock memory hotplug before mapping and release it
 679                          * after registering callback, to prevent races
 680                          */
 681                         rte_rwlock_read_lock(mem_lock);
 682                         if (vfio_cfg == default_vfio_cfg)
 683                                 ret = t->dma_map_func(vfio_container_fd);
 684                         else
 685                                 ret = 0;
 686                         if (ret) {
 687                                 RTE_LOG(ERR, EAL,
 688                                         "  %s DMA remapping failed, error %i (%s)\n",
 689                                         dev_addr, errno, strerror(errno));
 690                                 close(vfio_group_fd);
 691                                 rte_vfio_clear_group(vfio_group_fd);
 692                                 rte_rwlock_read_unlock(mem_lock);
 693                                 return -1;
 694                         }
 695
 696                         vfio_cfg->vfio_iommu_type = t;
 697
 698                         /* re-map all user-mapped segments */
 699                         rte_spinlock_recursive_lock(&user_mem_maps->lock);
 700
 701                         /* this IOMMU type may not support DMA mapping, but
 702                          * if we have mappings in the list - that means we have
 703                          * previously mapped something successfully, so we can
 704                          * be sure that DMA mapping is supported.
 705                          */
 706                         for (i = 0; i < user_mem_maps->n_maps; i++) {
 707                                 struct user_mem_map *map;
 708                                 map = &user_mem_maps->maps[i];
 709
 710                                 ret = t->dma_user_map_func(
 711                                                 vfio_container_fd,
 712                                                 map->addr, map->iova, map->len,
 713                                                 1);
 714                                 if (ret) {
 715                                         RTE_LOG(ERR, EAL, "Couldn't map user memory for DMA: "
 716                                                         "va: 0x%" PRIx64 " "
 717                                                         "iova: 0x%" PRIx64 " "
 718                                                         "len: 0x%" PRIu64 "\n",
 719                                                         map->addr, map->iova,
 720                                                         map->len);
 721                                         rte_spinlock_recursive_unlock(
 722                                                         &user_mem_maps->lock);
 723                                         rte_rwlock_read_unlock(mem_lock);
 724                                         return -1;
 725                                 }
 726                         }
 727                         rte_spinlock_recursive_unlock(&user_mem_maps->lock);
 728
 729                         /* register callback for mem events */
 730                         if (vfio_cfg == default_vfio_cfg)
 731                                 ret = rte_mem_event_callback_register(
 732                                         VFIO_MEM_EVENT_CLB_NAME,
 733                                         vfio_mem_event_callback, NULL);
 734                         else
 735                                 ret = 0;
 736                         /* unlock memory hotplug */
 737                         rte_rwlock_read_unlock(mem_lock);
 738
 739                         if (ret && rte_errno != ENOTSUP) {
 740                                 RTE_LOG(ERR, EAL, "Could not install memory event callback for VFIO\n");
 741                                 return -1;
 742                         }
 743                         if (ret)
 744                                 RTE_LOG(DEBUG, EAL, "Memory event callbacks not supported\n");
 745                         else
 746                                 RTE_LOG(DEBUG, EAL, "Installed memory event callback for VFIO\n");
 747                 }
 748         }
 749
 750         /* get a file descriptor for the device */
 751         *vfio_dev_fd = ioctl(vfio_group_fd, VFIO_GROUP_GET_DEVICE_FD, dev_addr);
 752         if (*vfio_dev_fd < 0) {
 753                 /* if we cannot get a device fd, this implies a problem with
 754                  * the VFIO group or the container not having IOMMU configured.
 755                  */
 756
 757                 RTE_LOG(WARNING, EAL, "Getting a vfio_dev_fd for %s failed\n",
 758                                 dev_addr);
 759                 close(vfio_group_fd);
 760                 rte_vfio_clear_group(vfio_group_fd);
 761                 return -1;
 762         }
 763
 764         /* test and setup the device */
 765         ret = ioctl(*vfio_dev_fd, VFIO_DEVICE_GET_INFO, device_info);
 766         if (ret) {
 767                 RTE_LOG(ERR, EAL, "  %s cannot get device info, "
 768                                 "error %i (%s)\n", dev_addr, errno,
 769                                 strerror(errno));
 770                 close(*vfio_dev_fd);
 771                 close(vfio_group_fd);
 772                 rte_vfio_clear_group(vfio_group_fd);
 773                 return -1;
 774         }
 775         vfio_group_device_get(vfio_group_fd);
 776
 777         return 0;
 778 }
 779
 780 int
 781 rte_vfio_release_device(const char *sysfs_base, const char *dev_addr,
 782                     int vfio_dev_fd)
 783 {
 784         struct rte_mem_config *mcfg = rte_eal_get_configuration()->mem_config;
 785         rte_rwlock_t *mem_lock = &mcfg->memory_hotplug_lock;
 786         struct vfio_group_status group_status = {
 787                         .argsz = sizeof(group_status)
 788         };
 789         struct vfio_config *vfio_cfg;
 790         int vfio_group_fd;
 791         int iommu_group_num;
 792         int ret;
 793
 794         /* we don't want any DMA mapping messages to come while we're detaching
 795          * VFIO device, because this might be the last device and we might need
 796          * to unregister the callback.
 797          */
 798         rte_rwlock_read_lock(mem_lock);
 799
 800         /* get group number */
 801         ret = rte_vfio_get_group_num(sysfs_base, dev_addr, &iommu_group_num);
 802         if (ret <= 0) {
 803                 RTE_LOG(WARNING, EAL, "  %s not managed by VFIO driver\n",
 804                         dev_addr);
 805                 /* This is an error at this point. */
 806                 ret = -1;
 807                 goto out;
 808         }
 809
 810         /* get the actual group fd */
 811         vfio_group_fd = rte_vfio_get_group_fd(iommu_group_num);
 812         if (vfio_group_fd <= 0) {
 813                 RTE_LOG(INFO, EAL, "rte_vfio_get_group_fd failed for %s\n",
 814                                    dev_addr);
 815                 ret = -1;
 816                 goto out;
 817         }
 818
 819         /* get the vfio_config it belongs to */
 820         vfio_cfg = get_vfio_cfg_by_group_num(iommu_group_num);
 821         vfio_cfg = vfio_cfg ? vfio_cfg : default_vfio_cfg;
 822
 823         /* At this point we got an active group. Closing it will make the
 824          * container detachment. If this is the last active group, VFIO kernel
 825          * code will unset the container and the IOMMU mappings.
 826          */
 827
 828         /* Closing a device */
 829         if (close(vfio_dev_fd) < 0) {
 830                 RTE_LOG(INFO, EAL, "Error when closing vfio_dev_fd for %s\n",
 831                                    dev_addr);
 832                 ret = -1;
 833                 goto out;
 834         }
 835
 836         /* An VFIO group can have several devices attached. Just when there is
 837          * no devices remaining should the group be closed.
 838          */
 839         vfio_group_device_put(vfio_group_fd);
 840         if (!vfio_group_device_count(vfio_group_fd)) {
 841
 842                 if (close(vfio_group_fd) < 0) {
 843                         RTE_LOG(INFO, EAL, "Error when closing vfio_group_fd for %s\n",
 844                                 dev_addr);
 845                         ret = -1;
 846                         goto out;
 847                 }
 848
 849                 if (rte_vfio_clear_group(vfio_group_fd) < 0) {
 850                         RTE_LOG(INFO, EAL, "Error when clearing group for %s\n",
 851                                            dev_addr);
 852                         ret = -1;
 853                         goto out;
 854                 }
 855         }
 856
 857         /* if there are no active device groups, unregister the callback to
 858          * avoid spurious attempts to map/unmap memory from VFIO.
 859          */
 860         if (vfio_cfg == default_vfio_cfg && vfio_cfg->vfio_active_groups == 0)
 861                 rte_mem_event_callback_unregister(VFIO_MEM_EVENT_CLB_NAME,
 862                                 NULL);
 863
 864         /* success */
 865         ret = 0;
 866
 867 out:
 868         rte_rwlock_read_unlock(mem_lock);
 869         return ret;
 870 }
 871
 872 int
 873 rte_vfio_enable(const char *modname)
 874 {
 875         /* initialize group list */
 876         int i, j;
 877         int vfio_available;
 878
 879         rte_spinlock_recursive_t lock = RTE_SPINLOCK_RECURSIVE_INITIALIZER;
 880
 881         for (i = 0; i < VFIO_MAX_CONTAINERS; i++) {
 882                 vfio_cfgs[i].vfio_container_fd = -1;
 883                 vfio_cfgs[i].vfio_active_groups = 0;
 884                 vfio_cfgs[i].vfio_iommu_type = NULL;
 885                 vfio_cfgs[i].mem_maps.lock = lock;
 886
 887                 for (j = 0; j < VFIO_MAX_GROUPS; j++) {
 888                         vfio_cfgs[i].vfio_groups[j].fd = -1;
 889                         vfio_cfgs[i].vfio_groups[j].group_num = -1;
 890                         vfio_cfgs[i].vfio_groups[j].devices = 0;
 891                 }
 892         }
 893
 894         /* inform the user that we are probing for VFIO */
 895         RTE_LOG(INFO, EAL, "Probing VFIO support...\n");
 896
 897         /* check if vfio module is loaded */
 898         vfio_available = rte_eal_check_module(modname);
 899
 900         /* return error directly */
 901         if (vfio_available == -1) {
 902                 RTE_LOG(INFO, EAL, "Could not get loaded module details!\n");
 903                 return -1;
 904         }
 905
 906         /* return 0 if VFIO modules not loaded */
 907         if (vfio_available == 0) {
 908                 RTE_LOG(DEBUG, EAL, "VFIO modules not loaded, "
 909                         "skipping VFIO support...\n");
 910                 return 0;
 911         }
 912
 913         default_vfio_cfg->vfio_container_fd = rte_vfio_get_container_fd();
 914
 915         /* check if we have VFIO driver enabled */
 916         if (default_vfio_cfg->vfio_container_fd != -1) {
 917                 RTE_LOG(NOTICE, EAL, "VFIO support initialized\n");
 918                 default_vfio_cfg->vfio_enabled = 1;
 919         } else {
 920                 RTE_LOG(NOTICE, EAL, "VFIO support could not be initialized\n");
 921         }
 922
 923         return 0;
 924 }
 925
 926 int
 927 rte_vfio_is_enabled(const char *modname)
 928 {
 929         const int mod_available = rte_eal_check_module(modname) > 0;
 930         return default_vfio_cfg->vfio_enabled && mod_available;
 931 }
 932
 933 const struct vfio_iommu_type *
 934 vfio_set_iommu_type(int vfio_container_fd)
 935 {
 936         unsigned idx;
 937         for (idx = 0; idx < RTE_DIM(iommu_types); idx++) {
 938                 const struct vfio_iommu_type *t = &iommu_types[idx];
 939
 940                 int ret = ioctl(vfio_container_fd, VFIO_SET_IOMMU,
 941                                 t->type_id);
 942                 if (!ret) {
 943                         RTE_LOG(NOTICE, EAL, "  using IOMMU type %d (%s)\n",
 944                                         t->type_id, t->name);
 945                         return t;
 946                 }
 947                 /* not an error, there may be more supported IOMMU types */
 948                 RTE_LOG(DEBUG, EAL, "  set IOMMU type %d (%s) failed, "
 949                                 "error %i (%s)\n", t->type_id, t->name, errno,
 950                                 strerror(errno));
 951         }
 952         /* if we didn't find a suitable IOMMU type, fail */
 953         return NULL;
 954 }
 955
 956 int
 957 vfio_has_supported_extensions(int vfio_container_fd)
 958 {
 959         int ret;
 960         unsigned idx, n_extensions = 0;
 961         for (idx = 0; idx < RTE_DIM(iommu_types); idx++) {
 962                 const struct vfio_iommu_type *t = &iommu_types[idx];
 963
 964                 ret = ioctl(vfio_container_fd, VFIO_CHECK_EXTENSION,
 965                                 t->type_id);
 966                 if (ret < 0) {
 967                         RTE_LOG(ERR, EAL, "  could not get IOMMU type, "
 968                                 "error %i (%s)\n", errno,
 969                                 strerror(errno));
 970                         close(vfio_container_fd);
 971                         return -1;
 972                 } else if (ret == 1) {
 973                         /* we found a supported extension */
 974                         n_extensions++;
 975                 }
 976                 RTE_LOG(DEBUG, EAL, "  IOMMU type %d (%s) is %s\n",
 977                                 t->type_id, t->name,
 978                                 ret ? "supported" : "not supported");
 979         }
 980
 981         /* if we didn't find any supported IOMMU types, fail */
 982         if (!n_extensions) {
 983                 close(vfio_container_fd);
 984                 return -1;
 985         }
 986
 987         return 0;
 988 }
 989
 990 int
 991 rte_vfio_get_container_fd(void)
 992 {
 993         int ret, vfio_container_fd;
 994         struct rte_mp_msg mp_req, *mp_rep;
 995         struct rte_mp_reply mp_reply;
 996         struct timespec ts = {.tv_sec = 5, .tv_nsec = 0};
 997         struct vfio_mp_param *p = (struct vfio_mp_param *)mp_req.param;
 998
 999
1000         /* if we're in a primary process, try to open the container */
1001         if (internal_config.process_type == RTE_PROC_PRIMARY) {
1002                 vfio_container_fd = open(VFIO_CONTAINER_PATH, O_RDWR);
1003                 if (vfio_container_fd < 0) {
1004                         RTE_LOG(ERR, EAL, "  cannot open VFIO container, "
1005                                         "error %i (%s)\n", errno, strerror(errno));
1006                         return -1;
1007                 }
1008
1009                 /* check VFIO API version */
1010                 ret = ioctl(vfio_container_fd, VFIO_GET_API_VERSION);
1011                 if (ret != VFIO_API_VERSION) {
1012                         if (ret < 0)
1013                                 RTE_LOG(ERR, EAL, "  could not get VFIO API version, "
1014                                                 "error %i (%s)\n", errno, strerror(errno));
1015                         else
1016                                 RTE_LOG(ERR, EAL, "  unsupported VFIO API version!\n");
1017                         close(vfio_container_fd);
1018                         return -1;
1019                 }
1020
1021                 ret = vfio_has_supported_extensions(vfio_container_fd);
1022                 if (ret) {
1023                         RTE_LOG(ERR, EAL, "  no supported IOMMU "
1024                                         "extensions found!\n");
1025                         return -1;
1026                 }
1027
1028                 return vfio_container_fd;
1029         }
1030         /*
1031          * if we're in a secondary process, request container fd from the
1032          * primary process via mp channel
1033          */
1034         p->req = SOCKET_REQ_CONTAINER;
1035         strcpy(mp_req.name, EAL_VFIO_MP);
1036         mp_req.len_param = sizeof(*p);
1037         mp_req.num_fds = 0;
1038
1039         vfio_container_fd = -1;
1040         if (rte_mp_request_sync(&mp_req, &mp_reply, &ts) == 0 &&
1041             mp_reply.nb_received == 1) {
1042                 mp_rep = &mp_reply.msgs[0];
1043                 p = (struct vfio_mp_param *)mp_rep->param;
1044                 if (p->result == SOCKET_OK && mp_rep->num_fds == 1) {
1045                         vfio_container_fd = mp_rep->fds[0];
1046                         free(mp_reply.msgs);
1047                         return vfio_container_fd;
1048                 }
1049                 free(mp_reply.msgs);
1050         }
1051
1052         RTE_LOG(ERR, EAL, "  cannot request container fd\n");
1053         return -1;
1054 }
1055
1056 int
1057 rte_vfio_get_group_num(const char *sysfs_base,
1058                 const char *dev_addr, int *iommu_group_num)
1059 {
1060         char linkname[PATH_MAX];
1061         char filename[PATH_MAX];
1062         char *tok[16], *group_tok, *end;
1063         int ret;
1064
1065         memset(linkname, 0, sizeof(linkname));
1066         memset(filename, 0, sizeof(filename));
1067
1068         /* try to find out IOMMU group for this device */
1069         snprintf(linkname, sizeof(linkname),
1070                          "%s/%s/iommu_group", sysfs_base, dev_addr);
1071
1072         ret = readlink(linkname, filename, sizeof(filename));
1073
1074         /* if the link doesn't exist, no VFIO for us */
1075         if (ret < 0)
1076                 return 0;
1077
1078         ret = rte_strsplit(filename, sizeof(filename),
1079                         tok, RTE_DIM(tok), '/');
1080
1081         if (ret <= 0) {
1082                 RTE_LOG(ERR, EAL, "  %s cannot get IOMMU group\n", dev_addr);
1083                 return -1;
1084         }
1085
1086         /* IOMMU group is always the last token */
1087         errno = 0;
1088         group_tok = tok[ret - 1];
1089         end = group_tok;
1090         *iommu_group_num = strtol(group_tok, &end, 10);
1091         if ((end != group_tok && *end != '\0') || errno != 0) {
1092                 RTE_LOG(ERR, EAL, "  %s error parsing IOMMU number!\n", dev_addr);
1093                 return -1;
1094         }
1095
1096         return 1;
1097 }
1098
1099 static int
1100 type1_map(const struct rte_memseg_list *msl, const struct rte_memseg *ms,
1101                 void *arg)
1102 {
1103         int *vfio_container_fd = arg;
1104
1105         if (msl->external)
1106                 return 0;
1107
1108         return vfio_type1_dma_mem_map(*vfio_container_fd, ms->addr_64, ms->iova,
1109                         ms->len, 1);
1110 }
1111
1112 static int
1113 vfio_type1_dma_mem_map(int vfio_container_fd, uint64_t vaddr, uint64_t iova,
1114                 uint64_t len, int do_map)
1115 {
1116         struct vfio_iommu_type1_dma_map dma_map;
1117         struct vfio_iommu_type1_dma_unmap dma_unmap;
1118         int ret;
1119
1120         if (do_map != 0) {
1121                 memset(&dma_map, 0, sizeof(dma_map));
1122                 dma_map.argsz = sizeof(struct vfio_iommu_type1_dma_map);
1123                 dma_map.vaddr = vaddr;
1124                 dma_map.size = len;
1125                 dma_map.iova = iova;
1126                 dma_map.flags = VFIO_DMA_MAP_FLAG_READ |
1127                                 VFIO_DMA_MAP_FLAG_WRITE;
1128
1129                 ret = ioctl(vfio_container_fd, VFIO_IOMMU_MAP_DMA, &dma_map);
1130                 if (ret) {
1131                         RTE_LOG(ERR, EAL, "  cannot set up DMA remapping, error %i (%s)\n",
1132                                 errno, strerror(errno));
1133                                 return -1;
1134                 }
1135         } else {
1136                 memset(&dma_unmap, 0, sizeof(dma_unmap));
1137                 dma_unmap.argsz = sizeof(struct vfio_iommu_type1_dma_unmap);
1138                 dma_unmap.size = len;
1139                 dma_unmap.iova = iova;
1140
1141                 ret = ioctl(vfio_container_fd, VFIO_IOMMU_UNMAP_DMA,
1142                                 &dma_unmap);
1143                 if (ret) {
1144                         RTE_LOG(ERR, EAL, "  cannot clear DMA remapping, error %i (%s)\n",
1145                                         errno, strerror(errno));
1146                         return -1;
1147                 }
1148         }
1149
1150         return 0;
1151 }
1152
1153 static int
1154 vfio_type1_dma_map(int vfio_container_fd)
1155 {
1156         return rte_memseg_walk(type1_map, &vfio_container_fd);
1157 }
1158
1159 static int
1160 vfio_spapr_dma_do_map(int vfio_container_fd, uint64_t vaddr, uint64_t iova,
1161                 uint64_t len, int do_map)
1162 {
1163         struct vfio_iommu_type1_dma_map dma_map;
1164         struct vfio_iommu_type1_dma_unmap dma_unmap;
1165         int ret;
1166         struct vfio_iommu_spapr_register_memory reg = {
1167                 .argsz = sizeof(reg),
1168                 .flags = 0
1169         };
1170         reg.vaddr = (uintptr_t) vaddr;
1171         reg.size = len;
1172
1173         if (do_map != 0) {
1174                 ret = ioctl(vfio_container_fd,
1175                                 VFIO_IOMMU_SPAPR_REGISTER_MEMORY, &reg);
1176                 if (ret) {
1177                         RTE_LOG(ERR, EAL, "  cannot register vaddr for IOMMU, "
1178                                 "error %i (%s)\n", errno, strerror(errno));
1179                         return -1;
1180                 }
1181
1182                 memset(&dma_map, 0, sizeof(dma_map));
1183                 dma_map.argsz = sizeof(struct vfio_iommu_type1_dma_map);
1184                 dma_map.vaddr = vaddr;
1185                 dma_map.size = len;
1186                 dma_map.iova = iova;
1187                 dma_map.flags = VFIO_DMA_MAP_FLAG_READ |
1188                                 VFIO_DMA_MAP_FLAG_WRITE;
1189
1190                 ret = ioctl(vfio_container_fd, VFIO_IOMMU_MAP_DMA, &dma_map);
1191                 if (ret) {
1192                         RTE_LOG(ERR, EAL, "  cannot set up DMA remapping, error %i (%s)\n",
1193                                 errno, strerror(errno));
1194                                 return -1;
1195                 }
1196
1197         } else {
1198                 ret = ioctl(vfio_container_fd,
1199                                 VFIO_IOMMU_SPAPR_UNREGISTER_MEMORY, &reg);
1200                 if (ret) {
1201                         RTE_LOG(ERR, EAL, "  cannot unregister vaddr for IOMMU, error %i (%s)\n",
1202                                         errno, strerror(errno));
1203                         return -1;
1204                 }
1205
1206                 memset(&dma_unmap, 0, sizeof(dma_unmap));
1207                 dma_unmap.argsz = sizeof(struct vfio_iommu_type1_dma_unmap);
1208                 dma_unmap.size = len;
1209                 dma_unmap.iova = iova;
1210
1211                 ret = ioctl(vfio_container_fd, VFIO_IOMMU_UNMAP_DMA,
1212                                 &dma_unmap);
1213                 if (ret) {
1214                         RTE_LOG(ERR, EAL, "  cannot clear DMA remapping, error %i (%s)\n",
1215                                         errno, strerror(errno));
1216                         return -1;
1217                 }
1218         }
1219
1220         return 0;
1221 }
1222
1223 static int
1224 vfio_spapr_map_walk(const struct rte_memseg_list *msl,
1225                 const struct rte_memseg *ms, void *arg)
1226 {
1227         int *vfio_container_fd = arg;
1228
1229         if (msl->external)
1230                 return 0;
1231
1232         return vfio_spapr_dma_do_map(*vfio_container_fd, ms->addr_64, ms->iova,
1233                         ms->len, 1);
1234 }
1235
1236 struct spapr_walk_param {
1237         uint64_t window_size;
1238         uint64_t hugepage_sz;
1239 };
1240 static int
1241 vfio_spapr_window_size_walk(const struct rte_memseg_list *msl,
1242                 const struct rte_memseg *ms, void *arg)
1243 {
1244         struct spapr_walk_param *param = arg;
1245         uint64_t max = ms->iova + ms->len;
1246
1247         if (msl->external)
1248                 return 0;
1249
1250         if (max > param->window_size) {
1251                 param->hugepage_sz = ms->hugepage_sz;
1252                 param->window_size = max;
1253         }
1254
1255         return 0;
1256 }
1257
1258 static int
1259 vfio_spapr_create_new_dma_window(int vfio_container_fd,
1260                 struct vfio_iommu_spapr_tce_create *create) {
1261         struct vfio_iommu_spapr_tce_remove remove = {
1262                 .argsz = sizeof(remove),
1263         };
1264         struct vfio_iommu_spapr_tce_info info = {
1265                 .argsz = sizeof(info),
1266         };
1267         int ret;
1268
1269         /* query spapr iommu info */
1270         ret = ioctl(vfio_container_fd, VFIO_IOMMU_SPAPR_TCE_GET_INFO, &info);
1271         if (ret) {
1272                 RTE_LOG(ERR, EAL, "  cannot get iommu info, "
1273                                 "error %i (%s)\n", errno, strerror(errno));
1274                 return -1;
1275         }
1276
1277         /* remove default DMA of 32 bit window */
1278         remove.start_addr = info.dma32_window_start;
1279         ret = ioctl(vfio_container_fd, VFIO_IOMMU_SPAPR_TCE_REMOVE, &remove);
1280         if (ret) {
1281                 RTE_LOG(ERR, EAL, "  cannot remove default DMA window, "
1282                                 "error %i (%s)\n", errno, strerror(errno));
1283                 return -1;
1284         }
1285
1286         /* create new DMA window */
1287         ret = ioctl(vfio_container_fd, VFIO_IOMMU_SPAPR_TCE_CREATE, create);
1288         if (ret) {
1289                 RTE_LOG(ERR, EAL, "  cannot create new DMA window, "
1290                                 "error %i (%s)\n", errno, strerror(errno));
1291                 return -1;
1292         }
1293
1294         if (create->start_addr != 0) {
1295                 RTE_LOG(ERR, EAL, "  DMA window start address != 0\n");
1296                 return -1;
1297         }
1298
1299         return 0;
1300 }
1301
1302 static int
1303 vfio_spapr_dma_mem_map(int vfio_container_fd, uint64_t vaddr, uint64_t iova,
1304                 uint64_t len, int do_map)
1305 {
1306         struct spapr_walk_param param;
1307         struct vfio_iommu_spapr_tce_create create = {
1308                 .argsz = sizeof(create),
1309         };
1310         struct vfio_config *vfio_cfg;
1311         struct user_mem_maps *user_mem_maps;
1312         int i, ret = 0;
1313
1314         vfio_cfg = get_vfio_cfg_by_container_fd(vfio_container_fd);
1315         if (vfio_cfg == NULL) {
1316                 RTE_LOG(ERR, EAL, "  invalid container fd!\n");
1317                 return -1;
1318         }
1319
1320         user_mem_maps = &vfio_cfg->mem_maps;
1321         rte_spinlock_recursive_lock(&user_mem_maps->lock);
1322
1323         /* check if window size needs to be adjusted */
1324         memset(&param, 0, sizeof(param));
1325
1326         /* we're inside a callback so use thread-unsafe version */
1327         if (rte_memseg_walk_thread_unsafe(vfio_spapr_window_size_walk,
1328                                 &param) < 0) {
1329                 RTE_LOG(ERR, EAL, "Could not get window size\n");
1330                 ret = -1;
1331                 goto out;
1332         }
1333
1334         /* also check user maps */
1335         for (i = 0; i < user_mem_maps->n_maps; i++) {
1336                 uint64_t max = user_mem_maps->maps[i].iova +
1337                                 user_mem_maps->maps[i].len;
1338                 create.window_size = RTE_MAX(create.window_size, max);
1339         }
1340
1341         /* sPAPR requires window size to be a power of 2 */
1342         create.window_size = rte_align64pow2(param.window_size);
1343         create.page_shift = __builtin_ctzll(param.hugepage_sz);
1344         create.levels = 1;
1345
1346         if (do_map) {
1347                 void *addr;
1348                 /* re-create window and remap the entire memory */
1349                 if (iova > create.window_size) {
1350                         if (vfio_spapr_create_new_dma_window(vfio_container_fd,
1351                                         &create) < 0) {
1352                                 RTE_LOG(ERR, EAL, "Could not create new DMA window\n");
1353                                 ret = -1;
1354                                 goto out;
1355                         }
1356                         /* we're inside a callback, so use thread-unsafe version
1357                          */
1358                         if (rte_memseg_walk_thread_unsafe(vfio_spapr_map_walk,
1359                                         &vfio_container_fd) < 0) {
1360                                 RTE_LOG(ERR, EAL, "Could not recreate DMA maps\n");
1361                                 ret = -1;
1362                                 goto out;
1363                         }
1364                         /* remap all user maps */
1365                         for (i = 0; i < user_mem_maps->n_maps; i++) {
1366                                 struct user_mem_map *map =
1367                                                 &user_mem_maps->maps[i];
1368                                 if (vfio_spapr_dma_do_map(vfio_container_fd,
1369                                                 map->addr, map->iova, map->len,
1370                                                 1)) {
1371                                         RTE_LOG(ERR, EAL, "Could not recreate user DMA maps\n");
1372                                         ret = -1;
1373                                         goto out;
1374                                 }
1375                         }
1376                 }
1377
1378                 /* now that we've remapped all of the memory that was present
1379                  * before, map the segment that we were requested to map.
1380                  *
1381                  * however, if we were called by the callback, the memory we
1382                  * were called with was already in the memseg list, so previous
1383                  * mapping should've mapped that segment already.
1384                  *
1385                  * virt2memseg_list is a relatively cheap check, so use that. if
1386                  * memory is within any memseg list, it's a memseg, so it's
1387                  * already mapped.
1388                  */
1389                 addr = (void *)(uintptr_t)vaddr;
1390                 if (rte_mem_virt2memseg_list(addr) == NULL &&
1391                                 vfio_spapr_dma_do_map(vfio_container_fd,
1392                                         vaddr, iova, len, 1) < 0) {
1393                         RTE_LOG(ERR, EAL, "Could not map segment\n");
1394                         ret = -1;
1395                         goto out;
1396                 }
1397         } else {
1398                 /* for unmap, check if iova within DMA window */
1399                 if (iova > create.window_size) {
1400                         RTE_LOG(ERR, EAL, "iova beyond DMA window for unmap");
1401                         ret = -1;
1402                         goto out;
1403                 }
1404
1405                 vfio_spapr_dma_do_map(vfio_container_fd, vaddr, iova, len, 0);
1406         }
1407 out:
1408         rte_spinlock_recursive_unlock(&user_mem_maps->lock);
1409         return ret;
1410 }
1411
1412 static int
1413 vfio_spapr_dma_map(int vfio_container_fd)
1414 {
1415         struct vfio_iommu_spapr_tce_create create = {
1416                 .argsz = sizeof(create),
1417         };
1418         struct spapr_walk_param param;
1419
1420         memset(&param, 0, sizeof(param));
1421
1422         /* create DMA window from 0 to max(phys_addr + len) */
1423         rte_memseg_walk(vfio_spapr_window_size_walk, &param);
1424
1425         /* sPAPR requires window size to be a power of 2 */
1426         create.window_size = rte_align64pow2(param.window_size);
1427         create.page_shift = __builtin_ctzll(param.hugepage_sz);
1428         create.levels = 1;
1429
1430         if (vfio_spapr_create_new_dma_window(vfio_container_fd, &create) < 0) {
1431                 RTE_LOG(ERR, EAL, "Could not create new DMA window\n");
1432                 return -1;
1433         }
1434
1435         /* map all DPDK segments for DMA. use 1:1 PA to IOVA mapping */
1436         if (rte_memseg_walk(vfio_spapr_map_walk, &vfio_container_fd) < 0)
1437                 return -1;
1438
1439         return 0;
1440 }
1441
1442 static int
1443 vfio_noiommu_dma_map(int __rte_unused vfio_container_fd)
1444 {
1445         /* No-IOMMU mode does not need DMA mapping */
1446         return 0;
1447 }
1448
1449 static int
1450 vfio_noiommu_dma_mem_map(int __rte_unused vfio_container_fd,
1451                          uint64_t __rte_unused vaddr,
1452                          uint64_t __rte_unused iova, uint64_t __rte_unused len,
1453                          int __rte_unused do_map)
1454 {
1455         /* No-IOMMU mode does not need DMA mapping */
1456         return 0;
1457 }
1458
1459 static int
1460 vfio_dma_mem_map(struct vfio_config *vfio_cfg, uint64_t vaddr, uint64_t iova,
1461                 uint64_t len, int do_map)
1462 {
1463         const struct vfio_iommu_type *t = vfio_cfg->vfio_iommu_type;
1464
1465         if (!t) {
1466                 RTE_LOG(ERR, EAL, "  VFIO support not initialized\n");
1467                 rte_errno = ENODEV;
1468                 return -1;
1469         }
1470
1471         if (!t->dma_user_map_func) {
1472                 RTE_LOG(ERR, EAL,
1473                         "  VFIO custom DMA region maping not supported by IOMMU %s\n",
1474                         t->name);
1475                 rte_errno = ENOTSUP;
1476                 return -1;
1477         }
1478
1479         return t->dma_user_map_func(vfio_cfg->vfio_container_fd, vaddr, iova,
1480                         len, do_map);
1481 }
1482
1483 static int
1484 container_dma_map(struct vfio_config *vfio_cfg, uint64_t vaddr, uint64_t iova,
1485                 uint64_t len)
1486 {
1487         struct user_mem_map *new_map;
1488         struct user_mem_maps *user_mem_maps;
1489         int ret = 0;
1490
1491         user_mem_maps = &vfio_cfg->mem_maps;
1492         rte_spinlock_recursive_lock(&user_mem_maps->lock);
1493         if (user_mem_maps->n_maps == VFIO_MAX_USER_MEM_MAPS) {
1494                 RTE_LOG(ERR, EAL, "No more space for user mem maps\n");
1495                 rte_errno = ENOMEM;
1496                 ret = -1;
1497                 goto out;
1498         }
1499         /* map the entry */
1500         if (vfio_dma_mem_map(vfio_cfg, vaddr, iova, len, 1)) {
1501                 /* technically, this will fail if there are currently no devices
1502                  * plugged in, even if a device were added later, this mapping
1503                  * might have succeeded. however, since we cannot verify if this
1504                  * is a valid mapping without having a device attached, consider
1505                  * this to be unsupported, because we can't just store any old
1506                  * mapping and pollute list of active mappings willy-nilly.
1507                  */
1508                 RTE_LOG(ERR, EAL, "Couldn't map new region for DMA\n");
1509                 ret = -1;
1510                 goto out;
1511         }
1512         /* create new user mem map entry */
1513         new_map = &user_mem_maps->maps[user_mem_maps->n_maps++];
1514         new_map->addr = vaddr;
1515         new_map->iova = iova;
1516         new_map->len = len;
1517
1518         compact_user_maps(user_mem_maps);
1519 out:
1520         rte_spinlock_recursive_unlock(&user_mem_maps->lock);
1521         return ret;
1522 }
1523
1524 static int
1525 container_dma_unmap(struct vfio_config *vfio_cfg, uint64_t vaddr, uint64_t iova,
1526                 uint64_t len)
1527 {
1528         struct user_mem_map *map, *new_map = NULL;
1529         struct user_mem_maps *user_mem_maps;
1530         int ret = 0;
1531
1532         user_mem_maps = &vfio_cfg->mem_maps;
1533         rte_spinlock_recursive_lock(&user_mem_maps->lock);
1534
1535         /* find our mapping */
1536         map = find_user_mem_map(user_mem_maps, vaddr, iova, len);
1537         if (!map) {
1538                 RTE_LOG(ERR, EAL, "Couldn't find previously mapped region\n");
1539                 rte_errno = EINVAL;
1540                 ret = -1;
1541                 goto out;
1542         }
1543         if (map->addr != vaddr || map->iova != iova || map->len != len) {
1544                 /* we're partially unmapping a previously mapped region, so we
1545                  * need to split entry into two.
1546                  */
1547                 if (user_mem_maps->n_maps == VFIO_MAX_USER_MEM_MAPS) {
1548                         RTE_LOG(ERR, EAL, "Not enough space to store partial mapping\n");
1549                         rte_errno = ENOMEM;
1550                         ret = -1;
1551                         goto out;
1552                 }
1553                 new_map = &user_mem_maps->maps[user_mem_maps->n_maps++];
1554         }
1555
1556         /* unmap the entry */
1557         if (vfio_dma_mem_map(vfio_cfg, vaddr, iova, len, 0)) {
1558                 /* there may not be any devices plugged in, so unmapping will
1559                  * fail with ENODEV/ENOTSUP rte_errno values, but that doesn't
1560                  * stop us from removing the mapping, as the assumption is we
1561                  * won't be needing this memory any more and thus will want to
1562                  * prevent it from being remapped again on hotplug. so, only
1563                  * fail if we indeed failed to unmap (e.g. if the mapping was
1564                  * within our mapped range but had invalid alignment).
1565                  */
1566                 if (rte_errno != ENODEV && rte_errno != ENOTSUP) {
1567                         RTE_LOG(ERR, EAL, "Couldn't unmap region for DMA\n");
1568                         ret = -1;
1569                         goto out;
1570                 } else {
1571                         RTE_LOG(DEBUG, EAL, "DMA unmapping failed, but removing mappings anyway\n");
1572                 }
1573         }
1574         /* remove map from the list of active mappings */
1575         if (new_map != NULL) {
1576                 adjust_map(map, new_map, vaddr, len);
1577
1578                 /* if we've created a new map by splitting, sort everything */
1579                 if (!is_null_map(new_map)) {
1580                         compact_user_maps(user_mem_maps);
1581                 } else {
1582                         /* we've created a new mapping, but it was unused */
1583                         user_mem_maps->n_maps--;
1584                 }
1585         } else {
1586                 memset(map, 0, sizeof(*map));
1587                 compact_user_maps(user_mem_maps);
1588                 user_mem_maps->n_maps--;
1589         }
1590
1591 out:
1592         rte_spinlock_recursive_unlock(&user_mem_maps->lock);
1593         return ret;
1594 }
1595
1596 int
1597 rte_vfio_dma_map(uint64_t vaddr, uint64_t iova, uint64_t len)
1598 {
1599         if (len == 0) {
1600                 rte_errno = EINVAL;
1601                 return -1;
1602         }
1603
1604         return container_dma_map(default_vfio_cfg, vaddr, iova, len);
1605 }
1606
1607 int
1608 rte_vfio_dma_unmap(uint64_t vaddr, uint64_t iova, uint64_t len)
1609 {
1610         if (len == 0) {
1611                 rte_errno = EINVAL;
1612                 return -1;
1613         }
1614
1615         return container_dma_unmap(default_vfio_cfg, vaddr, iova, len);
1616 }
1617
1618 int
1619 rte_vfio_noiommu_is_enabled(void)
1620 {
1621         int fd;
1622         ssize_t cnt;
1623         char c;
1624
1625         fd = open(VFIO_NOIOMMU_MODE, O_RDONLY);
1626         if (fd < 0) {
1627                 if (errno != ENOENT) {
1628                         RTE_LOG(ERR, EAL, "  cannot open vfio noiommu file %i (%s)\n",
1629                                         errno, strerror(errno));
1630                         return -1;
1631                 }
1632                 /*
1633                  * else the file does not exists
1634                  * i.e. noiommu is not enabled
1635                  */
1636                 return 0;
1637         }
1638
1639         cnt = read(fd, &c, 1);
1640         close(fd);
1641         if (cnt != 1) {
1642                 RTE_LOG(ERR, EAL, "  unable to read from vfio noiommu "
1643                                 "file %i (%s)\n", errno, strerror(errno));
1644                 return -1;
1645         }
1646
1647         return c == 'Y';
1648 }
1649
1650 int
1651 rte_vfio_container_create(void)
1652 {
1653         int i;
1654
1655         /* Find an empty slot to store new vfio config */
1656         for (i = 1; i < VFIO_MAX_CONTAINERS; i++) {
1657                 if (vfio_cfgs[i].vfio_container_fd == -1)
1658                         break;
1659         }
1660
1661         if (i == VFIO_MAX_CONTAINERS) {
1662                 RTE_LOG(ERR, EAL, "exceed max vfio container limit\n");
1663                 return -1;
1664         }
1665
1666         vfio_cfgs[i].vfio_container_fd = rte_vfio_get_container_fd();
1667         if (vfio_cfgs[i].vfio_container_fd < 0) {
1668                 RTE_LOG(NOTICE, EAL, "fail to create a new container\n");
1669                 return -1;
1670         }
1671
1672         return vfio_cfgs[i].vfio_container_fd;
1673 }
1674
1675 int __rte_experimental
1676 rte_vfio_container_destroy(int container_fd)
1677 {
1678         struct vfio_config *vfio_cfg;
1679         int i;
1680
1681         vfio_cfg = get_vfio_cfg_by_container_fd(container_fd);
1682         if (vfio_cfg == NULL) {
1683                 RTE_LOG(ERR, EAL, "Invalid container fd\n");
1684                 return -1;
1685         }
1686
1687         for (i = 0; i < VFIO_MAX_GROUPS; i++)
1688                 if (vfio_cfg->vfio_groups[i].group_num != -1)
1689                         rte_vfio_container_group_unbind(container_fd,
1690                                 vfio_cfg->vfio_groups[i].group_num);
1691
1692         close(container_fd);
1693         vfio_cfg->vfio_container_fd = -1;
1694         vfio_cfg->vfio_active_groups = 0;
1695         vfio_cfg->vfio_iommu_type = NULL;
1696
1697         return 0;
1698 }
1699
1700 int
1701 rte_vfio_container_group_bind(int container_fd, int iommu_group_num)
1702 {
1703         struct vfio_config *vfio_cfg;
1704
1705         vfio_cfg = get_vfio_cfg_by_container_fd(container_fd);
1706         if (vfio_cfg == NULL) {
1707                 RTE_LOG(ERR, EAL, "Invalid container fd\n");
1708                 return -1;
1709         }
1710
1711         return vfio_get_group_fd(vfio_cfg, iommu_group_num);
1712 }
1713
1714 int
1715 rte_vfio_container_group_unbind(int container_fd, int iommu_group_num)
1716 {
1717         struct vfio_config *vfio_cfg;
1718         struct vfio_group *cur_grp = NULL;
1719         int i;
1720
1721         vfio_cfg = get_vfio_cfg_by_container_fd(container_fd);
1722         if (vfio_cfg == NULL) {
1723                 RTE_LOG(ERR, EAL, "Invalid container fd\n");
1724                 return -1;
1725         }
1726
1727         for (i = 0; i < VFIO_MAX_GROUPS; i++) {
1728                 if (vfio_cfg->vfio_groups[i].group_num == iommu_group_num) {
1729                         cur_grp = &vfio_cfg->vfio_groups[i];
1730                         break;
1731                 }
1732         }
1733
1734         /* This should not happen */
1735         if (i == VFIO_MAX_GROUPS || cur_grp == NULL) {
1736                 RTE_LOG(ERR, EAL, "Specified group number not found\n");
1737                 return -1;
1738         }
1739
1740         if (cur_grp->fd >= 0 && close(cur_grp->fd) < 0) {
1741                 RTE_LOG(ERR, EAL, "Error when closing vfio_group_fd for"
1742                         " iommu_group_num %d\n", iommu_group_num);
1743                 return -1;
1744         }
1745         cur_grp->group_num = -1;
1746         cur_grp->fd = -1;
1747         cur_grp->devices = 0;
1748         vfio_cfg->vfio_active_groups--;
1749
1750         return 0;
1751 }
1752
1753 int
1754 rte_vfio_container_dma_map(int container_fd, uint64_t vaddr, uint64_t iova,
1755                 uint64_t len)
1756 {
1757         struct vfio_config *vfio_cfg;
1758
1759         if (len == 0) {
1760                 rte_errno = EINVAL;
1761                 return -1;
1762         }
1763
1764         vfio_cfg = get_vfio_cfg_by_container_fd(container_fd);
1765         if (vfio_cfg == NULL) {
1766                 RTE_LOG(ERR, EAL, "Invalid container fd\n");
1767                 return -1;
1768         }
1769
1770         return container_dma_map(vfio_cfg, vaddr, iova, len);
1771 }
1772
1773 int
1774 rte_vfio_container_dma_unmap(int container_fd, uint64_t vaddr, uint64_t iova,
1775                 uint64_t len)
1776 {
1777         struct vfio_config *vfio_cfg;
1778
1779         if (len == 0) {
1780                 rte_errno = EINVAL;
1781                 return -1;
1782         }
1783
1784         vfio_cfg = get_vfio_cfg_by_container_fd(container_fd);
1785         if (vfio_cfg == NULL) {
1786                 RTE_LOG(ERR, EAL, "Invalid container fd\n");
1787                 return -1;
1788         }
1789
1790         return container_dma_unmap(vfio_cfg, vaddr, iova, len);
1791 }
1792
1793 #else
1794
1795 int
1796 rte_vfio_dma_map(uint64_t __rte_unused vaddr, __rte_unused uint64_t iova,
1797                   __rte_unused uint64_t len)
1798 {
1799         return -1;
1800 }
1801
1802 int
1803 rte_vfio_dma_unmap(uint64_t __rte_unused vaddr, uint64_t __rte_unused iova,
1804                     __rte_unused uint64_t len)
1805 {
1806         return -1;
1807 }
1808
1809 int
1810 rte_vfio_setup_device(__rte_unused const char *sysfs_base,
1811                 __rte_unused const char *dev_addr,
1812                 __rte_unused int *vfio_dev_fd,
1813                 __rte_unused struct vfio_device_info *device_info)
1814 {
1815         return -1;
1816 }
1817
1818 int
1819 rte_vfio_release_device(__rte_unused const char *sysfs_base,
1820                 __rte_unused const char *dev_addr, __rte_unused int fd)
1821 {
1822         return -1;
1823 }
1824
1825 int
1826 rte_vfio_enable(__rte_unused const char *modname)
1827 {
1828         return -1;
1829 }
1830
1831 int
1832 rte_vfio_is_enabled(__rte_unused const char *modname)
1833 {
1834         return -1;
1835 }
1836
1837 int
1838 rte_vfio_noiommu_is_enabled(void)
1839 {
1840         return -1;
1841 }
1842
1843 int
1844 rte_vfio_clear_group(__rte_unused int vfio_group_fd)
1845 {
1846         return -1;
1847 }
1848
1849 int
1850 rte_vfio_get_group_num(__rte_unused const char *sysfs_base,
1851                 __rte_unused const char *dev_addr,
1852                 __rte_unused int *iommu_group_num)
1853 {
1854         return -1;
1855 }
1856
1857 int
1858 rte_vfio_get_container_fd(void)
1859 {
1860         return -1;
1861 }
1862
1863 int
1864 rte_vfio_get_group_fd(__rte_unused int iommu_group_num)
1865 {
1866         return -1;
1867 }
1868
1869 int
1870 rte_vfio_container_create(void)
1871 {
1872         return -1;
1873 }
1874
1875 int
1876 rte_vfio_container_destroy(__rte_unused int container_fd)
1877 {
1878         return -1;
1879 }
1880
1881 int
1882 rte_vfio_container_group_bind(__rte_unused int container_fd,
1883                 __rte_unused int iommu_group_num)
1884 {
1885         return -1;
1886 }
1887
1888 int
1889 rte_vfio_container_group_unbind(__rte_unused int container_fd,
1890                 __rte_unused int iommu_group_num)
1891 {
1892         return -1;
1893 }
1894
1895 int
1896 rte_vfio_container_dma_map(__rte_unused int container_fd,
1897                 __rte_unused uint64_t vaddr,
1898                 __rte_unused uint64_t iova,
1899                 __rte_unused uint64_t len)
1900 {
1901         return -1;
1902 }
1903
1904 int
1905 rte_vfio_container_dma_unmap(__rte_unused int container_fd,
1906                 __rte_unused uint64_t vaddr,
1907                 __rte_unused uint64_t iova,
1908                 __rte_unused uint64_t len)
1909 {
1910         return -1;
1911 }
1912
1913 #endif /* VFIO_PRESENT */