New upstream version 18.11-rc1
[deb_dpdk.git] / 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         if (internal_config.process_type == RTE_PROC_PRIMARY) {
914                 /* open a new container */
915                 default_vfio_cfg->vfio_container_fd =
916                                 rte_vfio_get_container_fd();
917         } else {
918                 /* get the default container from the primary process */
919                 default_vfio_cfg->vfio_container_fd =
920                                 vfio_get_default_container_fd();
921         }
922
923         /* check if we have VFIO driver enabled */
924         if (default_vfio_cfg->vfio_container_fd != -1) {
925                 RTE_LOG(NOTICE, EAL, "VFIO support initialized\n");
926                 default_vfio_cfg->vfio_enabled = 1;
927         } else {
928                 RTE_LOG(NOTICE, EAL, "VFIO support could not be initialized\n");
929         }
930
931         return 0;
932 }
933
934 int
935 rte_vfio_is_enabled(const char *modname)
936 {
937         const int mod_available = rte_eal_check_module(modname) > 0;
938         return default_vfio_cfg->vfio_enabled && mod_available;
939 }
940
941 int
942 vfio_get_default_container_fd(void)
943 {
944         struct rte_mp_msg mp_req, *mp_rep;
945         struct rte_mp_reply mp_reply;
946         struct timespec ts = {.tv_sec = 5, .tv_nsec = 0};
947         struct vfio_mp_param *p = (struct vfio_mp_param *)mp_req.param;
948
949         if (default_vfio_cfg->vfio_enabled)
950                 return default_vfio_cfg->vfio_container_fd;
951
952         if (internal_config.process_type == RTE_PROC_PRIMARY) {
953                 /* if we were secondary process we would try requesting
954                  * container fd from the primary, but we're the primary
955                  * process so just exit here
956                  */
957                 return -1;
958         }
959
960         p->req = SOCKET_REQ_DEFAULT_CONTAINER;
961         strcpy(mp_req.name, EAL_VFIO_MP);
962         mp_req.len_param = sizeof(*p);
963         mp_req.num_fds = 0;
964
965         if (rte_mp_request_sync(&mp_req, &mp_reply, &ts) == 0 &&
966             mp_reply.nb_received == 1) {
967                 mp_rep = &mp_reply.msgs[0];
968                 p = (struct vfio_mp_param *)mp_rep->param;
969                 if (p->result == SOCKET_OK && mp_rep->num_fds == 1) {
970                         free(mp_reply.msgs);
971                         return mp_rep->fds[0];
972                 }
973                 free(mp_reply.msgs);
974         }
975
976         RTE_LOG(ERR, EAL, "  cannot request default container fd\n");
977         return -1;
978 }
979
980 const struct vfio_iommu_type *
981 vfio_set_iommu_type(int vfio_container_fd)
982 {
983         unsigned idx;
984         for (idx = 0; idx < RTE_DIM(iommu_types); idx++) {
985                 const struct vfio_iommu_type *t = &iommu_types[idx];
986
987                 int ret = ioctl(vfio_container_fd, VFIO_SET_IOMMU,
988                                 t->type_id);
989                 if (!ret) {
990                         RTE_LOG(NOTICE, EAL, "  using IOMMU type %d (%s)\n",
991                                         t->type_id, t->name);
992                         return t;
993                 }
994                 /* not an error, there may be more supported IOMMU types */
995                 RTE_LOG(DEBUG, EAL, "  set IOMMU type %d (%s) failed, "
996                                 "error %i (%s)\n", t->type_id, t->name, errno,
997                                 strerror(errno));
998         }
999         /* if we didn't find a suitable IOMMU type, fail */
1000         return NULL;
1001 }
1002
1003 int
1004 vfio_has_supported_extensions(int vfio_container_fd)
1005 {
1006         int ret;
1007         unsigned idx, n_extensions = 0;
1008         for (idx = 0; idx < RTE_DIM(iommu_types); idx++) {
1009                 const struct vfio_iommu_type *t = &iommu_types[idx];
1010
1011                 ret = ioctl(vfio_container_fd, VFIO_CHECK_EXTENSION,
1012                                 t->type_id);
1013                 if (ret < 0) {
1014                         RTE_LOG(ERR, EAL, "  could not get IOMMU type, "
1015                                 "error %i (%s)\n", errno,
1016                                 strerror(errno));
1017                         close(vfio_container_fd);
1018                         return -1;
1019                 } else if (ret == 1) {
1020                         /* we found a supported extension */
1021                         n_extensions++;
1022                 }
1023                 RTE_LOG(DEBUG, EAL, "  IOMMU type %d (%s) is %s\n",
1024                                 t->type_id, t->name,
1025                                 ret ? "supported" : "not supported");
1026         }
1027
1028         /* if we didn't find any supported IOMMU types, fail */
1029         if (!n_extensions) {
1030                 close(vfio_container_fd);
1031                 return -1;
1032         }
1033
1034         return 0;
1035 }
1036
1037 int
1038 rte_vfio_get_container_fd(void)
1039 {
1040         int ret, vfio_container_fd;
1041         struct rte_mp_msg mp_req, *mp_rep;
1042         struct rte_mp_reply mp_reply;
1043         struct timespec ts = {.tv_sec = 5, .tv_nsec = 0};
1044         struct vfio_mp_param *p = (struct vfio_mp_param *)mp_req.param;
1045
1046
1047         /* if we're in a primary process, try to open the container */
1048         if (internal_config.process_type == RTE_PROC_PRIMARY) {
1049                 vfio_container_fd = open(VFIO_CONTAINER_PATH, O_RDWR);
1050                 if (vfio_container_fd < 0) {
1051                         RTE_LOG(ERR, EAL, "  cannot open VFIO container, "
1052                                         "error %i (%s)\n", errno, strerror(errno));
1053                         return -1;
1054                 }
1055
1056                 /* check VFIO API version */
1057                 ret = ioctl(vfio_container_fd, VFIO_GET_API_VERSION);
1058                 if (ret != VFIO_API_VERSION) {
1059                         if (ret < 0)
1060                                 RTE_LOG(ERR, EAL, "  could not get VFIO API version, "
1061                                                 "error %i (%s)\n", errno, strerror(errno));
1062                         else
1063                                 RTE_LOG(ERR, EAL, "  unsupported VFIO API version!\n");
1064                         close(vfio_container_fd);
1065                         return -1;
1066                 }
1067
1068                 ret = vfio_has_supported_extensions(vfio_container_fd);
1069                 if (ret) {
1070                         RTE_LOG(ERR, EAL, "  no supported IOMMU "
1071                                         "extensions found!\n");
1072                         return -1;
1073                 }
1074
1075                 return vfio_container_fd;
1076         }
1077         /*
1078          * if we're in a secondary process, request container fd from the
1079          * primary process via mp channel
1080          */
1081         p->req = SOCKET_REQ_CONTAINER;
1082         strcpy(mp_req.name, EAL_VFIO_MP);
1083         mp_req.len_param = sizeof(*p);
1084         mp_req.num_fds = 0;
1085
1086         vfio_container_fd = -1;
1087         if (rte_mp_request_sync(&mp_req, &mp_reply, &ts) == 0 &&
1088             mp_reply.nb_received == 1) {
1089                 mp_rep = &mp_reply.msgs[0];
1090                 p = (struct vfio_mp_param *)mp_rep->param;
1091                 if (p->result == SOCKET_OK && mp_rep->num_fds == 1) {
1092                         vfio_container_fd = mp_rep->fds[0];
1093                         free(mp_reply.msgs);
1094                         return vfio_container_fd;
1095                 }
1096                 free(mp_reply.msgs);
1097         }
1098
1099         RTE_LOG(ERR, EAL, "  cannot request container fd\n");
1100         return -1;
1101 }
1102
1103 int
1104 rte_vfio_get_group_num(const char *sysfs_base,
1105                 const char *dev_addr, int *iommu_group_num)
1106 {
1107         char linkname[PATH_MAX];
1108         char filename[PATH_MAX];
1109         char *tok[16], *group_tok, *end;
1110         int ret;
1111
1112         memset(linkname, 0, sizeof(linkname));
1113         memset(filename, 0, sizeof(filename));
1114
1115         /* try to find out IOMMU group for this device */
1116         snprintf(linkname, sizeof(linkname),
1117                          "%s/%s/iommu_group", sysfs_base, dev_addr);
1118
1119         ret = readlink(linkname, filename, sizeof(filename));
1120
1121         /* if the link doesn't exist, no VFIO for us */
1122         if (ret < 0)
1123                 return 0;
1124
1125         ret = rte_strsplit(filename, sizeof(filename),
1126                         tok, RTE_DIM(tok), '/');
1127
1128         if (ret <= 0) {
1129                 RTE_LOG(ERR, EAL, "  %s cannot get IOMMU group\n", dev_addr);
1130                 return -1;
1131         }
1132
1133         /* IOMMU group is always the last token */
1134         errno = 0;
1135         group_tok = tok[ret - 1];
1136         end = group_tok;
1137         *iommu_group_num = strtol(group_tok, &end, 10);
1138         if ((end != group_tok && *end != '\0') || errno != 0) {
1139                 RTE_LOG(ERR, EAL, "  %s error parsing IOMMU number!\n", dev_addr);
1140                 return -1;
1141         }
1142
1143         return 1;
1144 }
1145
1146 static int
1147 type1_map(const struct rte_memseg_list *msl, const struct rte_memseg *ms,
1148                 void *arg)
1149 {
1150         int *vfio_container_fd = arg;
1151
1152         if (msl->external)
1153                 return 0;
1154
1155         return vfio_type1_dma_mem_map(*vfio_container_fd, ms->addr_64, ms->iova,
1156                         ms->len, 1);
1157 }
1158
1159 static int
1160 vfio_type1_dma_mem_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
1167         if (do_map != 0) {
1168                 memset(&dma_map, 0, sizeof(dma_map));
1169                 dma_map.argsz = sizeof(struct vfio_iommu_type1_dma_map);
1170                 dma_map.vaddr = vaddr;
1171                 dma_map.size = len;
1172                 dma_map.iova = iova;
1173                 dma_map.flags = VFIO_DMA_MAP_FLAG_READ |
1174                                 VFIO_DMA_MAP_FLAG_WRITE;
1175
1176                 ret = ioctl(vfio_container_fd, VFIO_IOMMU_MAP_DMA, &dma_map);
1177                 if (ret) {
1178                         RTE_LOG(ERR, EAL, "  cannot set up DMA remapping, error %i (%s)\n",
1179                                 errno, strerror(errno));
1180                                 return -1;
1181                 }
1182         } else {
1183                 memset(&dma_unmap, 0, sizeof(dma_unmap));
1184                 dma_unmap.argsz = sizeof(struct vfio_iommu_type1_dma_unmap);
1185                 dma_unmap.size = len;
1186                 dma_unmap.iova = iova;
1187
1188                 ret = ioctl(vfio_container_fd, VFIO_IOMMU_UNMAP_DMA,
1189                                 &dma_unmap);
1190                 if (ret) {
1191                         RTE_LOG(ERR, EAL, "  cannot clear DMA remapping, error %i (%s)\n",
1192                                         errno, strerror(errno));
1193                         return -1;
1194                 }
1195         }
1196
1197         return 0;
1198 }
1199
1200 static int
1201 vfio_type1_dma_map(int vfio_container_fd)
1202 {
1203         return rte_memseg_walk(type1_map, &vfio_container_fd);
1204 }
1205
1206 static int
1207 vfio_spapr_dma_do_map(int vfio_container_fd, uint64_t vaddr, uint64_t iova,
1208                 uint64_t len, int do_map)
1209 {
1210         struct vfio_iommu_type1_dma_map dma_map;
1211         struct vfio_iommu_type1_dma_unmap dma_unmap;
1212         int ret;
1213         struct vfio_iommu_spapr_register_memory reg = {
1214                 .argsz = sizeof(reg),
1215                 .flags = 0
1216         };
1217         reg.vaddr = (uintptr_t) vaddr;
1218         reg.size = len;
1219
1220         if (do_map != 0) {
1221                 ret = ioctl(vfio_container_fd,
1222                                 VFIO_IOMMU_SPAPR_REGISTER_MEMORY, &reg);
1223                 if (ret) {
1224                         RTE_LOG(ERR, EAL, "  cannot register vaddr for IOMMU, "
1225                                 "error %i (%s)\n", errno, strerror(errno));
1226                         return -1;
1227                 }
1228
1229                 memset(&dma_map, 0, sizeof(dma_map));
1230                 dma_map.argsz = sizeof(struct vfio_iommu_type1_dma_map);
1231                 dma_map.vaddr = vaddr;
1232                 dma_map.size = len;
1233                 dma_map.iova = iova;
1234                 dma_map.flags = VFIO_DMA_MAP_FLAG_READ |
1235                                 VFIO_DMA_MAP_FLAG_WRITE;
1236
1237                 ret = ioctl(vfio_container_fd, VFIO_IOMMU_MAP_DMA, &dma_map);
1238                 if (ret) {
1239                         RTE_LOG(ERR, EAL, "  cannot set up DMA remapping, error %i (%s)\n",
1240                                 errno, strerror(errno));
1241                                 return -1;
1242                 }
1243
1244         } else {
1245                 ret = ioctl(vfio_container_fd,
1246                                 VFIO_IOMMU_SPAPR_UNREGISTER_MEMORY, &reg);
1247                 if (ret) {
1248                         RTE_LOG(ERR, EAL, "  cannot unregister vaddr for IOMMU, error %i (%s)\n",
1249                                         errno, strerror(errno));
1250                         return -1;
1251                 }
1252
1253                 memset(&dma_unmap, 0, sizeof(dma_unmap));
1254                 dma_unmap.argsz = sizeof(struct vfio_iommu_type1_dma_unmap);
1255                 dma_unmap.size = len;
1256                 dma_unmap.iova = iova;
1257
1258                 ret = ioctl(vfio_container_fd, VFIO_IOMMU_UNMAP_DMA,
1259                                 &dma_unmap);
1260                 if (ret) {
1261                         RTE_LOG(ERR, EAL, "  cannot clear DMA remapping, error %i (%s)\n",
1262                                         errno, strerror(errno));
1263                         return -1;
1264                 }
1265         }
1266
1267         return 0;
1268 }
1269
1270 static int
1271 vfio_spapr_map_walk(const struct rte_memseg_list *msl,
1272                 const struct rte_memseg *ms, void *arg)
1273 {
1274         int *vfio_container_fd = arg;
1275
1276         if (msl->external)
1277                 return 0;
1278
1279         return vfio_spapr_dma_do_map(*vfio_container_fd, ms->addr_64, ms->iova,
1280                         ms->len, 1);
1281 }
1282
1283 struct spapr_walk_param {
1284         uint64_t window_size;
1285         uint64_t hugepage_sz;
1286 };
1287 static int
1288 vfio_spapr_window_size_walk(const struct rte_memseg_list *msl,
1289                 const struct rte_memseg *ms, void *arg)
1290 {
1291         struct spapr_walk_param *param = arg;
1292         uint64_t max = ms->iova + ms->len;
1293
1294         if (msl->external)
1295                 return 0;
1296
1297         if (max > param->window_size) {
1298                 param->hugepage_sz = ms->hugepage_sz;
1299                 param->window_size = max;
1300         }
1301
1302         return 0;
1303 }
1304
1305 static int
1306 vfio_spapr_create_new_dma_window(int vfio_container_fd,
1307                 struct vfio_iommu_spapr_tce_create *create) {
1308         struct vfio_iommu_spapr_tce_remove remove = {
1309                 .argsz = sizeof(remove),
1310         };
1311         struct vfio_iommu_spapr_tce_info info = {
1312                 .argsz = sizeof(info),
1313         };
1314         int ret;
1315
1316         /* query spapr iommu info */
1317         ret = ioctl(vfio_container_fd, VFIO_IOMMU_SPAPR_TCE_GET_INFO, &info);
1318         if (ret) {
1319                 RTE_LOG(ERR, EAL, "  cannot get iommu info, "
1320                                 "error %i (%s)\n", errno, strerror(errno));
1321                 return -1;
1322         }
1323
1324         /* remove default DMA of 32 bit window */
1325         remove.start_addr = info.dma32_window_start;
1326         ret = ioctl(vfio_container_fd, VFIO_IOMMU_SPAPR_TCE_REMOVE, &remove);
1327         if (ret) {
1328                 RTE_LOG(ERR, EAL, "  cannot remove default DMA window, "
1329                                 "error %i (%s)\n", errno, strerror(errno));
1330                 return -1;
1331         }
1332
1333         /* create new DMA window */
1334         ret = ioctl(vfio_container_fd, VFIO_IOMMU_SPAPR_TCE_CREATE, create);
1335         if (ret) {
1336                 RTE_LOG(ERR, EAL, "  cannot create new DMA window, "
1337                                 "error %i (%s)\n", errno, strerror(errno));
1338                 return -1;
1339         }
1340
1341         if (create->start_addr != 0) {
1342                 RTE_LOG(ERR, EAL, "  DMA window start address != 0\n");
1343                 return -1;
1344         }
1345
1346         return 0;
1347 }
1348
1349 static int
1350 vfio_spapr_dma_mem_map(int vfio_container_fd, uint64_t vaddr, uint64_t iova,
1351                 uint64_t len, int do_map)
1352 {
1353         struct spapr_walk_param param;
1354         struct vfio_iommu_spapr_tce_create create = {
1355                 .argsz = sizeof(create),
1356         };
1357         struct vfio_config *vfio_cfg;
1358         struct user_mem_maps *user_mem_maps;
1359         int i, ret = 0;
1360
1361         vfio_cfg = get_vfio_cfg_by_container_fd(vfio_container_fd);
1362         if (vfio_cfg == NULL) {
1363                 RTE_LOG(ERR, EAL, "  invalid container fd!\n");
1364                 return -1;
1365         }
1366
1367         user_mem_maps = &vfio_cfg->mem_maps;
1368         rte_spinlock_recursive_lock(&user_mem_maps->lock);
1369
1370         /* check if window size needs to be adjusted */
1371         memset(&param, 0, sizeof(param));
1372
1373         /* we're inside a callback so use thread-unsafe version */
1374         if (rte_memseg_walk_thread_unsafe(vfio_spapr_window_size_walk,
1375                                 &param) < 0) {
1376                 RTE_LOG(ERR, EAL, "Could not get window size\n");
1377                 ret = -1;
1378                 goto out;
1379         }
1380
1381         /* also check user maps */
1382         for (i = 0; i < user_mem_maps->n_maps; i++) {
1383                 uint64_t max = user_mem_maps->maps[i].iova +
1384                                 user_mem_maps->maps[i].len;
1385                 create.window_size = RTE_MAX(create.window_size, max);
1386         }
1387
1388         /* sPAPR requires window size to be a power of 2 */
1389         create.window_size = rte_align64pow2(param.window_size);
1390         create.page_shift = __builtin_ctzll(param.hugepage_sz);
1391         create.levels = 1;
1392
1393         if (do_map) {
1394                 void *addr;
1395                 /* re-create window and remap the entire memory */
1396                 if (iova > create.window_size) {
1397                         if (vfio_spapr_create_new_dma_window(vfio_container_fd,
1398                                         &create) < 0) {
1399                                 RTE_LOG(ERR, EAL, "Could not create new DMA window\n");
1400                                 ret = -1;
1401                                 goto out;
1402                         }
1403                         /* we're inside a callback, so use thread-unsafe version
1404                          */
1405                         if (rte_memseg_walk_thread_unsafe(vfio_spapr_map_walk,
1406                                         &vfio_container_fd) < 0) {
1407                                 RTE_LOG(ERR, EAL, "Could not recreate DMA maps\n");
1408                                 ret = -1;
1409                                 goto out;
1410                         }
1411                         /* remap all user maps */
1412                         for (i = 0; i < user_mem_maps->n_maps; i++) {
1413                                 struct user_mem_map *map =
1414                                                 &user_mem_maps->maps[i];
1415                                 if (vfio_spapr_dma_do_map(vfio_container_fd,
1416                                                 map->addr, map->iova, map->len,
1417                                                 1)) {
1418                                         RTE_LOG(ERR, EAL, "Could not recreate user DMA maps\n");
1419                                         ret = -1;
1420                                         goto out;
1421                                 }
1422                         }
1423                 }
1424
1425                 /* now that we've remapped all of the memory that was present
1426                  * before, map the segment that we were requested to map.
1427                  *
1428                  * however, if we were called by the callback, the memory we
1429                  * were called with was already in the memseg list, so previous
1430                  * mapping should've mapped that segment already.
1431                  *
1432                  * virt2memseg_list is a relatively cheap check, so use that. if
1433                  * memory is within any memseg list, it's a memseg, so it's
1434                  * already mapped.
1435                  */
1436                 addr = (void *)(uintptr_t)vaddr;
1437                 if (rte_mem_virt2memseg_list(addr) == NULL &&
1438                                 vfio_spapr_dma_do_map(vfio_container_fd,
1439                                         vaddr, iova, len, 1) < 0) {
1440                         RTE_LOG(ERR, EAL, "Could not map segment\n");
1441                         ret = -1;
1442                         goto out;
1443                 }
1444         } else {
1445                 /* for unmap, check if iova within DMA window */
1446                 if (iova > create.window_size) {
1447                         RTE_LOG(ERR, EAL, "iova beyond DMA window for unmap");
1448                         ret = -1;
1449                         goto out;
1450                 }
1451
1452                 vfio_spapr_dma_do_map(vfio_container_fd, vaddr, iova, len, 0);
1453         }
1454 out:
1455         rte_spinlock_recursive_unlock(&user_mem_maps->lock);
1456         return ret;
1457 }
1458
1459 static int
1460 vfio_spapr_dma_map(int vfio_container_fd)
1461 {
1462         struct vfio_iommu_spapr_tce_create create = {
1463                 .argsz = sizeof(create),
1464         };
1465         struct spapr_walk_param param;
1466
1467         memset(&param, 0, sizeof(param));
1468
1469         /* create DMA window from 0 to max(phys_addr + len) */
1470         rte_memseg_walk(vfio_spapr_window_size_walk, &param);
1471
1472         /* sPAPR requires window size to be a power of 2 */
1473         create.window_size = rte_align64pow2(param.window_size);
1474         create.page_shift = __builtin_ctzll(param.hugepage_sz);
1475         create.levels = 1;
1476
1477         if (vfio_spapr_create_new_dma_window(vfio_container_fd, &create) < 0) {
1478                 RTE_LOG(ERR, EAL, "Could not create new DMA window\n");
1479                 return -1;
1480         }
1481
1482         /* map all DPDK segments for DMA. use 1:1 PA to IOVA mapping */
1483         if (rte_memseg_walk(vfio_spapr_map_walk, &vfio_container_fd) < 0)
1484                 return -1;
1485
1486         return 0;
1487 }
1488
1489 static int
1490 vfio_noiommu_dma_map(int __rte_unused vfio_container_fd)
1491 {
1492         /* No-IOMMU mode does not need DMA mapping */
1493         return 0;
1494 }
1495
1496 static int
1497 vfio_noiommu_dma_mem_map(int __rte_unused vfio_container_fd,
1498                          uint64_t __rte_unused vaddr,
1499                          uint64_t __rte_unused iova, uint64_t __rte_unused len,
1500                          int __rte_unused do_map)
1501 {
1502         /* No-IOMMU mode does not need DMA mapping */
1503         return 0;
1504 }
1505
1506 static int
1507 vfio_dma_mem_map(struct vfio_config *vfio_cfg, uint64_t vaddr, uint64_t iova,
1508                 uint64_t len, int do_map)
1509 {
1510         const struct vfio_iommu_type *t = vfio_cfg->vfio_iommu_type;
1511
1512         if (!t) {
1513                 RTE_LOG(ERR, EAL, "  VFIO support not initialized\n");
1514                 rte_errno = ENODEV;
1515                 return -1;
1516         }
1517
1518         if (!t->dma_user_map_func) {
1519                 RTE_LOG(ERR, EAL,
1520                         "  VFIO custom DMA region maping not supported by IOMMU %s\n",
1521                         t->name);
1522                 rte_errno = ENOTSUP;
1523                 return -1;
1524         }
1525
1526         return t->dma_user_map_func(vfio_cfg->vfio_container_fd, vaddr, iova,
1527                         len, do_map);
1528 }
1529
1530 static int
1531 container_dma_map(struct vfio_config *vfio_cfg, uint64_t vaddr, uint64_t iova,
1532                 uint64_t len)
1533 {
1534         struct user_mem_map *new_map;
1535         struct user_mem_maps *user_mem_maps;
1536         int ret = 0;
1537
1538         user_mem_maps = &vfio_cfg->mem_maps;
1539         rte_spinlock_recursive_lock(&user_mem_maps->lock);
1540         if (user_mem_maps->n_maps == VFIO_MAX_USER_MEM_MAPS) {
1541                 RTE_LOG(ERR, EAL, "No more space for user mem maps\n");
1542                 rte_errno = ENOMEM;
1543                 ret = -1;
1544                 goto out;
1545         }
1546         /* map the entry */
1547         if (vfio_dma_mem_map(vfio_cfg, vaddr, iova, len, 1)) {
1548                 /* technically, this will fail if there are currently no devices
1549                  * plugged in, even if a device were added later, this mapping
1550                  * might have succeeded. however, since we cannot verify if this
1551                  * is a valid mapping without having a device attached, consider
1552                  * this to be unsupported, because we can't just store any old
1553                  * mapping and pollute list of active mappings willy-nilly.
1554                  */
1555                 RTE_LOG(ERR, EAL, "Couldn't map new region for DMA\n");
1556                 ret = -1;
1557                 goto out;
1558         }
1559         /* create new user mem map entry */
1560         new_map = &user_mem_maps->maps[user_mem_maps->n_maps++];
1561         new_map->addr = vaddr;
1562         new_map->iova = iova;
1563         new_map->len = len;
1564
1565         compact_user_maps(user_mem_maps);
1566 out:
1567         rte_spinlock_recursive_unlock(&user_mem_maps->lock);
1568         return ret;
1569 }
1570
1571 static int
1572 container_dma_unmap(struct vfio_config *vfio_cfg, uint64_t vaddr, uint64_t iova,
1573                 uint64_t len)
1574 {
1575         struct user_mem_map *map, *new_map = NULL;
1576         struct user_mem_maps *user_mem_maps;
1577         int ret = 0;
1578
1579         user_mem_maps = &vfio_cfg->mem_maps;
1580         rte_spinlock_recursive_lock(&user_mem_maps->lock);
1581
1582         /* find our mapping */
1583         map = find_user_mem_map(user_mem_maps, vaddr, iova, len);
1584         if (!map) {
1585                 RTE_LOG(ERR, EAL, "Couldn't find previously mapped region\n");
1586                 rte_errno = EINVAL;
1587                 ret = -1;
1588                 goto out;
1589         }
1590         if (map->addr != vaddr || map->iova != iova || map->len != len) {
1591                 /* we're partially unmapping a previously mapped region, so we
1592                  * need to split entry into two.
1593                  */
1594                 if (user_mem_maps->n_maps == VFIO_MAX_USER_MEM_MAPS) {
1595                         RTE_LOG(ERR, EAL, "Not enough space to store partial mapping\n");
1596                         rte_errno = ENOMEM;
1597                         ret = -1;
1598                         goto out;
1599                 }
1600                 new_map = &user_mem_maps->maps[user_mem_maps->n_maps++];
1601         }
1602
1603         /* unmap the entry */
1604         if (vfio_dma_mem_map(vfio_cfg, vaddr, iova, len, 0)) {
1605                 /* there may not be any devices plugged in, so unmapping will
1606                  * fail with ENODEV/ENOTSUP rte_errno values, but that doesn't
1607                  * stop us from removing the mapping, as the assumption is we
1608                  * won't be needing this memory any more and thus will want to
1609                  * prevent it from being remapped again on hotplug. so, only
1610                  * fail if we indeed failed to unmap (e.g. if the mapping was
1611                  * within our mapped range but had invalid alignment).
1612                  */
1613                 if (rte_errno != ENODEV && rte_errno != ENOTSUP) {
1614                         RTE_LOG(ERR, EAL, "Couldn't unmap region for DMA\n");
1615                         ret = -1;
1616                         goto out;
1617                 } else {
1618                         RTE_LOG(DEBUG, EAL, "DMA unmapping failed, but removing mappings anyway\n");
1619                 }
1620         }
1621         /* remove map from the list of active mappings */
1622         if (new_map != NULL) {
1623                 adjust_map(map, new_map, vaddr, len);
1624
1625                 /* if we've created a new map by splitting, sort everything */
1626                 if (!is_null_map(new_map)) {
1627                         compact_user_maps(user_mem_maps);
1628                 } else {
1629                         /* we've created a new mapping, but it was unused */
1630                         user_mem_maps->n_maps--;
1631                 }
1632         } else {
1633                 memset(map, 0, sizeof(*map));
1634                 compact_user_maps(user_mem_maps);
1635                 user_mem_maps->n_maps--;
1636         }
1637
1638 out:
1639         rte_spinlock_recursive_unlock(&user_mem_maps->lock);
1640         return ret;
1641 }
1642
1643 int
1644 rte_vfio_dma_map(uint64_t vaddr, uint64_t iova, uint64_t len)
1645 {
1646         if (len == 0) {
1647                 rte_errno = EINVAL;
1648                 return -1;
1649         }
1650
1651         return container_dma_map(default_vfio_cfg, vaddr, iova, len);
1652 }
1653
1654 int
1655 rte_vfio_dma_unmap(uint64_t vaddr, uint64_t iova, uint64_t len)
1656 {
1657         if (len == 0) {
1658                 rte_errno = EINVAL;
1659                 return -1;
1660         }
1661
1662         return container_dma_unmap(default_vfio_cfg, vaddr, iova, len);
1663 }
1664
1665 int
1666 rte_vfio_noiommu_is_enabled(void)
1667 {
1668         int fd;
1669         ssize_t cnt;
1670         char c;
1671
1672         fd = open(VFIO_NOIOMMU_MODE, O_RDONLY);
1673         if (fd < 0) {
1674                 if (errno != ENOENT) {
1675                         RTE_LOG(ERR, EAL, "  cannot open vfio noiommu file %i (%s)\n",
1676                                         errno, strerror(errno));
1677                         return -1;
1678                 }
1679                 /*
1680                  * else the file does not exists
1681                  * i.e. noiommu is not enabled
1682                  */
1683                 return 0;
1684         }
1685
1686         cnt = read(fd, &c, 1);
1687         close(fd);
1688         if (cnt != 1) {
1689                 RTE_LOG(ERR, EAL, "  unable to read from vfio noiommu "
1690                                 "file %i (%s)\n", errno, strerror(errno));
1691                 return -1;
1692         }
1693
1694         return c == 'Y';
1695 }
1696
1697 int
1698 rte_vfio_container_create(void)
1699 {
1700         int i;
1701
1702         /* Find an empty slot to store new vfio config */
1703         for (i = 1; i < VFIO_MAX_CONTAINERS; i++) {
1704                 if (vfio_cfgs[i].vfio_container_fd == -1)
1705                         break;
1706         }
1707
1708         if (i == VFIO_MAX_CONTAINERS) {
1709                 RTE_LOG(ERR, EAL, "exceed max vfio container limit\n");
1710                 return -1;
1711         }
1712
1713         vfio_cfgs[i].vfio_container_fd = rte_vfio_get_container_fd();
1714         if (vfio_cfgs[i].vfio_container_fd < 0) {
1715                 RTE_LOG(NOTICE, EAL, "fail to create a new container\n");
1716                 return -1;
1717         }
1718
1719         return vfio_cfgs[i].vfio_container_fd;
1720 }
1721
1722 int __rte_experimental
1723 rte_vfio_container_destroy(int container_fd)
1724 {
1725         struct vfio_config *vfio_cfg;
1726         int i;
1727
1728         vfio_cfg = get_vfio_cfg_by_container_fd(container_fd);
1729         if (vfio_cfg == NULL) {
1730                 RTE_LOG(ERR, EAL, "Invalid container fd\n");
1731                 return -1;
1732         }
1733
1734         for (i = 0; i < VFIO_MAX_GROUPS; i++)
1735                 if (vfio_cfg->vfio_groups[i].group_num != -1)
1736                         rte_vfio_container_group_unbind(container_fd,
1737                                 vfio_cfg->vfio_groups[i].group_num);
1738
1739         close(container_fd);
1740         vfio_cfg->vfio_container_fd = -1;
1741         vfio_cfg->vfio_active_groups = 0;
1742         vfio_cfg->vfio_iommu_type = NULL;
1743
1744         return 0;
1745 }
1746
1747 int
1748 rte_vfio_container_group_bind(int container_fd, int iommu_group_num)
1749 {
1750         struct vfio_config *vfio_cfg;
1751
1752         vfio_cfg = get_vfio_cfg_by_container_fd(container_fd);
1753         if (vfio_cfg == NULL) {
1754                 RTE_LOG(ERR, EAL, "Invalid container fd\n");
1755                 return -1;
1756         }
1757
1758         return vfio_get_group_fd(vfio_cfg, iommu_group_num);
1759 }
1760
1761 int
1762 rte_vfio_container_group_unbind(int container_fd, int iommu_group_num)
1763 {
1764         struct vfio_config *vfio_cfg;
1765         struct vfio_group *cur_grp = NULL;
1766         int i;
1767
1768         vfio_cfg = get_vfio_cfg_by_container_fd(container_fd);
1769         if (vfio_cfg == NULL) {
1770                 RTE_LOG(ERR, EAL, "Invalid container fd\n");
1771                 return -1;
1772         }
1773
1774         for (i = 0; i < VFIO_MAX_GROUPS; i++) {
1775                 if (vfio_cfg->vfio_groups[i].group_num == iommu_group_num) {
1776                         cur_grp = &vfio_cfg->vfio_groups[i];
1777                         break;
1778                 }
1779         }
1780
1781         /* This should not happen */
1782         if (i == VFIO_MAX_GROUPS || cur_grp == NULL) {
1783                 RTE_LOG(ERR, EAL, "Specified group number not found\n");
1784                 return -1;
1785         }
1786
1787         if (cur_grp->fd >= 0 && close(cur_grp->fd) < 0) {
1788                 RTE_LOG(ERR, EAL, "Error when closing vfio_group_fd for"
1789                         " iommu_group_num %d\n", iommu_group_num);
1790                 return -1;
1791         }
1792         cur_grp->group_num = -1;
1793         cur_grp->fd = -1;
1794         cur_grp->devices = 0;
1795         vfio_cfg->vfio_active_groups--;
1796
1797         return 0;
1798 }
1799
1800 int
1801 rte_vfio_container_dma_map(int container_fd, uint64_t vaddr, uint64_t iova,
1802                 uint64_t len)
1803 {
1804         struct vfio_config *vfio_cfg;
1805
1806         if (len == 0) {
1807                 rte_errno = EINVAL;
1808                 return -1;
1809         }
1810
1811         vfio_cfg = get_vfio_cfg_by_container_fd(container_fd);
1812         if (vfio_cfg == NULL) {
1813                 RTE_LOG(ERR, EAL, "Invalid container fd\n");
1814                 return -1;
1815         }
1816
1817         return container_dma_map(vfio_cfg, vaddr, iova, len);
1818 }
1819
1820 int
1821 rte_vfio_container_dma_unmap(int container_fd, uint64_t vaddr, uint64_t iova,
1822                 uint64_t len)
1823 {
1824         struct vfio_config *vfio_cfg;
1825
1826         if (len == 0) {
1827                 rte_errno = EINVAL;
1828                 return -1;
1829         }
1830
1831         vfio_cfg = get_vfio_cfg_by_container_fd(container_fd);
1832         if (vfio_cfg == NULL) {
1833                 RTE_LOG(ERR, EAL, "Invalid container fd\n");
1834                 return -1;
1835         }
1836
1837         return container_dma_unmap(vfio_cfg, vaddr, iova, len);
1838 }
1839
1840 #else
1841
1842 int
1843 rte_vfio_dma_map(uint64_t __rte_unused vaddr, __rte_unused uint64_t iova,
1844                   __rte_unused uint64_t len)
1845 {
1846         return -1;
1847 }
1848
1849 int
1850 rte_vfio_dma_unmap(uint64_t __rte_unused vaddr, uint64_t __rte_unused iova,
1851                     __rte_unused uint64_t len)
1852 {
1853         return -1;
1854 }
1855
1856 int
1857 rte_vfio_setup_device(__rte_unused const char *sysfs_base,
1858                 __rte_unused const char *dev_addr,
1859                 __rte_unused int *vfio_dev_fd,
1860                 __rte_unused struct vfio_device_info *device_info)
1861 {
1862         return -1;
1863 }
1864
1865 int
1866 rte_vfio_release_device(__rte_unused const char *sysfs_base,
1867                 __rte_unused const char *dev_addr, __rte_unused int fd)
1868 {
1869         return -1;
1870 }
1871
1872 int
1873 rte_vfio_enable(__rte_unused const char *modname)
1874 {
1875         return -1;
1876 }
1877
1878 int
1879 rte_vfio_is_enabled(__rte_unused const char *modname)
1880 {
1881         return -1;
1882 }
1883
1884 int
1885 rte_vfio_noiommu_is_enabled(void)
1886 {
1887         return -1;
1888 }
1889
1890 int
1891 rte_vfio_clear_group(__rte_unused int vfio_group_fd)
1892 {
1893         return -1;
1894 }
1895
1896 int
1897 rte_vfio_get_group_num(__rte_unused const char *sysfs_base,
1898                 __rte_unused const char *dev_addr,
1899                 __rte_unused int *iommu_group_num)
1900 {
1901         return -1;
1902 }
1903
1904 int
1905 rte_vfio_get_container_fd(void)
1906 {
1907         return -1;
1908 }
1909
1910 int
1911 rte_vfio_get_group_fd(__rte_unused int iommu_group_num)
1912 {
1913         return -1;
1914 }
1915
1916 int
1917 rte_vfio_container_create(void)
1918 {
1919         return -1;
1920 }
1921
1922 int
1923 rte_vfio_container_destroy(__rte_unused int container_fd)
1924 {
1925         return -1;
1926 }
1927
1928 int
1929 rte_vfio_container_group_bind(__rte_unused int container_fd,
1930                 __rte_unused int iommu_group_num)
1931 {
1932         return -1;
1933 }
1934
1935 int
1936 rte_vfio_container_group_unbind(__rte_unused int container_fd,
1937                 __rte_unused int iommu_group_num)
1938 {
1939         return -1;
1940 }
1941
1942 int
1943 rte_vfio_container_dma_map(__rte_unused int container_fd,
1944                 __rte_unused uint64_t vaddr,
1945                 __rte_unused uint64_t iova,
1946                 __rte_unused uint64_t len)
1947 {
1948         return -1;
1949 }
1950
1951 int
1952 rte_vfio_container_dma_unmap(__rte_unused int container_fd,
1953                 __rte_unused uint64_t vaddr,
1954                 __rte_unused uint64_t iova,
1955                 __rte_unused uint64_t len)
1956 {
1957         return -1;
1958 }
1959
1960 #endif /* VFIO_PRESENT */