2 * Copyright (c) 2005 Topspin Communications. All rights reserved.
3 * Copyright (c) 2005 Mellanox Technologies. All rights reserved.
4 * Copyright (c) 2013 Cisco Systems. All rights reserved.
6 * This software is available to you under a choice of one of two
7 * licenses. You may choose to be licensed under the terms of the GNU
8 * General Public License (GPL) Version 2, available from the file
9 * COPYING in the main directory of this source tree, or the
12 * Redistribution and use in source and binary forms, with or
13 * without modification, are permitted provided that the following
16 * - Redistributions of source code must retain the above
17 * copyright notice, this list of conditions and the following
20 * - Redistributions in binary form must reproduce the above
21 * copyright notice, this list of conditions and the following
22 * disclaimer in the documentation and/or other materials
23 * provided with the distribution.
25 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
26 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
27 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
28 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
29 * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
30 * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
31 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
36 #include <linux/dma-mapping.h>
37 #include <linux/sched/signal.h>
38 #include <linux/sched/mm.h>
39 #include <linux/hugetlb.h>
40 #include <linux/iommu.h>
41 #include <linux/workqueue.h>
42 #include <linux/list.h>
43 #include <linux/pci.h>
44 #include <rdma/ib_verbs.h>
46 #include "usnic_log.h"
47 #include "usnic_uiom.h"
48 #include "usnic_uiom_interval_tree.h"
50 #define USNIC_UIOM_PAGE_CHUNK \
51 ((PAGE_SIZE - offsetof(struct usnic_uiom_chunk, page_list)) /\
52 ((void *) &((struct usnic_uiom_chunk *) 0)->page_list[1] - \
53 (void *) &((struct usnic_uiom_chunk *) 0)->page_list[0]))
55 static int usnic_uiom_dma_fault(struct iommu_domain
*domain
,
57 unsigned long iova
, int flags
,
60 usnic_err("Device %s iommu fault domain 0x%pK va 0x%lx flags 0x%x\n",
66 static void usnic_uiom_put_pages(struct list_head
*chunk_list
, int dirty
)
68 struct usnic_uiom_chunk
*chunk
, *tmp
;
70 struct scatterlist
*sg
;
74 list_for_each_entry_safe(chunk
, tmp
, chunk_list
, list
) {
75 for_each_sg(chunk
->page_list
, sg
, chunk
->nents
, i
) {
78 unpin_user_pages_dirty_lock(&page
, 1, dirty
);
79 usnic_dbg("pa: %pa\n", &pa
);
85 static int usnic_uiom_get_pages(unsigned long addr
, size_t size
, int writable
,
86 int dmasync
, struct usnic_uiom_reg
*uiomr
)
88 struct list_head
*chunk_list
= &uiomr
->chunk_list
;
89 struct page
**page_list
;
90 struct scatterlist
*sg
;
91 struct usnic_uiom_chunk
*chunk
;
93 unsigned long lock_limit
;
94 unsigned long cur_base
;
101 unsigned int gup_flags
;
102 struct mm_struct
*mm
;
105 * If the combination of the addr and size requested for this memory
106 * region causes an integer overflow, return error.
108 if (((addr
+ size
) < addr
) || PAGE_ALIGN(addr
+ size
) < (addr
+ size
))
117 INIT_LIST_HEAD(chunk_list
);
119 page_list
= (struct page
**) __get_free_page(GFP_KERNEL
);
123 npages
= PAGE_ALIGN(size
+ (addr
& ~PAGE_MASK
)) >> PAGE_SHIFT
;
125 uiomr
->owning_mm
= mm
= current
->mm
;
128 locked
= atomic64_add_return(npages
, ¤t
->mm
->pinned_vm
);
129 lock_limit
= rlimit(RLIMIT_MEMLOCK
) >> PAGE_SHIFT
;
131 if ((locked
> lock_limit
) && !capable(CAP_IPC_LOCK
)) {
136 flags
= IOMMU_READ
| IOMMU_CACHE
;
137 flags
|= (writable
) ? IOMMU_WRITE
: 0;
138 gup_flags
= FOLL_WRITE
;
139 gup_flags
|= (writable
) ? 0 : FOLL_FORCE
;
140 cur_base
= addr
& PAGE_MASK
;
144 ret
= pin_user_pages(cur_base
,
145 min_t(unsigned long, npages
,
146 PAGE_SIZE
/ sizeof(struct page
*)),
147 gup_flags
| FOLL_LONGTERM
,
157 chunk
= kmalloc(struct_size(chunk
, page_list
,
158 min_t(int, ret
, USNIC_UIOM_PAGE_CHUNK
)),
165 chunk
->nents
= min_t(int, ret
, USNIC_UIOM_PAGE_CHUNK
);
166 sg_init_table(chunk
->page_list
, chunk
->nents
);
167 for_each_sg(chunk
->page_list
, sg
, chunk
->nents
, i
) {
168 sg_set_page(sg
, page_list
[i
+ off
],
171 usnic_dbg("va: 0x%lx pa: %pa\n",
172 cur_base
+ i
*PAGE_SIZE
, &pa
);
174 cur_base
+= chunk
->nents
* PAGE_SIZE
;
177 list_add_tail(&chunk
->list
, chunk_list
);
185 usnic_uiom_put_pages(chunk_list
, 0);
186 atomic64_sub(npages
, ¤t
->mm
->pinned_vm
);
188 mmgrab(uiomr
->owning_mm
);
190 mmap_read_unlock(mm
);
191 free_page((unsigned long) page_list
);
195 static void usnic_uiom_unmap_sorted_intervals(struct list_head
*intervals
,
196 struct usnic_uiom_pd
*pd
)
198 struct usnic_uiom_interval_node
*interval
, *tmp
;
199 long unsigned va
, size
;
201 list_for_each_entry_safe(interval
, tmp
, intervals
, link
) {
202 va
= interval
->start
<< PAGE_SHIFT
;
203 size
= ((interval
->last
- interval
->start
) + 1) << PAGE_SHIFT
;
205 /* Workaround for RH 970401 */
206 usnic_dbg("va 0x%lx size 0x%lx", va
, PAGE_SIZE
);
207 iommu_unmap(pd
->domain
, va
, PAGE_SIZE
);
214 static void __usnic_uiom_reg_release(struct usnic_uiom_pd
*pd
,
215 struct usnic_uiom_reg
*uiomr
,
219 unsigned long vpn_start
, vpn_last
;
220 struct usnic_uiom_interval_node
*interval
, *tmp
;
222 LIST_HEAD(rm_intervals
);
224 npages
= PAGE_ALIGN(uiomr
->length
+ uiomr
->offset
) >> PAGE_SHIFT
;
225 vpn_start
= (uiomr
->va
& PAGE_MASK
) >> PAGE_SHIFT
;
226 vpn_last
= vpn_start
+ npages
- 1;
228 spin_lock(&pd
->lock
);
229 usnic_uiom_remove_interval(&pd
->root
, vpn_start
,
230 vpn_last
, &rm_intervals
);
231 usnic_uiom_unmap_sorted_intervals(&rm_intervals
, pd
);
233 list_for_each_entry_safe(interval
, tmp
, &rm_intervals
, link
) {
234 if (interval
->flags
& IOMMU_WRITE
)
236 list_del(&interval
->link
);
240 usnic_uiom_put_pages(&uiomr
->chunk_list
, dirty
& writable
);
241 spin_unlock(&pd
->lock
);
244 static int usnic_uiom_map_sorted_intervals(struct list_head
*intervals
,
245 struct usnic_uiom_reg
*uiomr
)
249 struct usnic_uiom_chunk
*chunk
;
250 struct usnic_uiom_interval_node
*interval_node
;
252 dma_addr_t pa_start
= 0;
253 dma_addr_t pa_end
= 0;
254 long int va_start
= -EINVAL
;
255 struct usnic_uiom_pd
*pd
= uiomr
->pd
;
256 long int va
= uiomr
->va
& PAGE_MASK
;
257 int flags
= IOMMU_READ
| IOMMU_CACHE
;
259 flags
|= (uiomr
->writable
) ? IOMMU_WRITE
: 0;
260 chunk
= list_first_entry(&uiomr
->chunk_list
, struct usnic_uiom_chunk
,
262 list_for_each_entry(interval_node
, intervals
, link
) {
264 for (i
= 0; i
< chunk
->nents
; i
++, va
+= PAGE_SIZE
) {
265 pa
= sg_phys(&chunk
->page_list
[i
]);
266 if ((va
>> PAGE_SHIFT
) < interval_node
->start
)
269 if ((va
>> PAGE_SHIFT
) == interval_node
->start
) {
270 /* First page of the interval */
276 WARN_ON(va_start
== -EINVAL
);
278 if ((pa_end
+ PAGE_SIZE
!= pa
) &&
280 /* PAs are not contiguous */
281 size
= pa_end
- pa_start
+ PAGE_SIZE
;
282 usnic_dbg("va 0x%lx pa %pa size 0x%zx flags 0x%x",
283 va_start
, &pa_start
, size
, flags
);
284 err
= iommu_map(pd
->domain
, va_start
, pa_start
,
287 usnic_err("Failed to map va 0x%lx pa %pa size 0x%zx with err %d\n",
288 va_start
, &pa_start
, size
, err
);
296 if ((va
>> PAGE_SHIFT
) == interval_node
->last
) {
297 /* Last page of the interval */
298 size
= pa
- pa_start
+ PAGE_SIZE
;
299 usnic_dbg("va 0x%lx pa %pa size 0x%zx flags 0x%x\n",
300 va_start
, &pa_start
, size
, flags
);
301 err
= iommu_map(pd
->domain
, va_start
, pa_start
,
304 usnic_err("Failed to map va 0x%lx pa %pa size 0x%zx with err %d\n",
305 va_start
, &pa_start
, size
, err
);
315 if (i
== chunk
->nents
) {
317 * Hit last entry of the chunk,
318 * hence advance to next chunk
320 chunk
= list_first_entry(&chunk
->list
,
321 struct usnic_uiom_chunk
,
330 usnic_uiom_unmap_sorted_intervals(intervals
, pd
);
334 struct usnic_uiom_reg
*usnic_uiom_reg_get(struct usnic_uiom_pd
*pd
,
335 unsigned long addr
, size_t size
,
336 int writable
, int dmasync
)
338 struct usnic_uiom_reg
*uiomr
;
339 unsigned long va_base
, vpn_start
, vpn_last
;
340 unsigned long npages
;
342 LIST_HEAD(sorted_diff_intervals
);
345 * Intel IOMMU map throws an error if a translation entry is
346 * changed from read to write. This module may not unmap
347 * and then remap the entry after fixing the permission
348 * b/c this open up a small windows where hw DMA may page fault
349 * Hence, make all entries to be writable.
353 va_base
= addr
& PAGE_MASK
;
354 offset
= addr
& ~PAGE_MASK
;
355 npages
= PAGE_ALIGN(size
+ offset
) >> PAGE_SHIFT
;
356 vpn_start
= (addr
& PAGE_MASK
) >> PAGE_SHIFT
;
357 vpn_last
= vpn_start
+ npages
- 1;
359 uiomr
= kmalloc(sizeof(*uiomr
), GFP_KERNEL
);
361 return ERR_PTR(-ENOMEM
);
364 uiomr
->offset
= offset
;
365 uiomr
->length
= size
;
366 uiomr
->writable
= writable
;
369 err
= usnic_uiom_get_pages(addr
, size
, writable
, dmasync
,
372 usnic_err("Failed get_pages vpn [0x%lx,0x%lx] err %d\n",
373 vpn_start
, vpn_last
, err
);
377 spin_lock(&pd
->lock
);
378 err
= usnic_uiom_get_intervals_diff(vpn_start
, vpn_last
,
379 (writable
) ? IOMMU_WRITE
: 0,
382 &sorted_diff_intervals
);
384 usnic_err("Failed disjoint interval vpn [0x%lx,0x%lx] err %d\n",
385 vpn_start
, vpn_last
, err
);
389 err
= usnic_uiom_map_sorted_intervals(&sorted_diff_intervals
, uiomr
);
391 usnic_err("Failed map interval vpn [0x%lx,0x%lx] err %d\n",
392 vpn_start
, vpn_last
, err
);
393 goto out_put_intervals
;
397 err
= usnic_uiom_insert_interval(&pd
->root
, vpn_start
, vpn_last
,
398 (writable
) ? IOMMU_WRITE
: 0);
400 usnic_err("Failed insert interval vpn [0x%lx,0x%lx] err %d\n",
401 vpn_start
, vpn_last
, err
);
402 goto out_unmap_intervals
;
405 usnic_uiom_put_interval_set(&sorted_diff_intervals
);
406 spin_unlock(&pd
->lock
);
411 usnic_uiom_unmap_sorted_intervals(&sorted_diff_intervals
, pd
);
413 usnic_uiom_put_interval_set(&sorted_diff_intervals
);
415 usnic_uiom_put_pages(&uiomr
->chunk_list
, 0);
416 spin_unlock(&pd
->lock
);
417 mmdrop(uiomr
->owning_mm
);
423 static void __usnic_uiom_release_tail(struct usnic_uiom_reg
*uiomr
)
425 mmdrop(uiomr
->owning_mm
);
429 static inline size_t usnic_uiom_num_pages(struct usnic_uiom_reg
*uiomr
)
431 return PAGE_ALIGN(uiomr
->length
+ uiomr
->offset
) >> PAGE_SHIFT
;
434 void usnic_uiom_reg_release(struct usnic_uiom_reg
*uiomr
)
436 __usnic_uiom_reg_release(uiomr
->pd
, uiomr
, 1);
438 atomic64_sub(usnic_uiom_num_pages(uiomr
), &uiomr
->owning_mm
->pinned_vm
);
439 __usnic_uiom_release_tail(uiomr
);
442 struct usnic_uiom_pd
*usnic_uiom_alloc_pd(void)
444 struct usnic_uiom_pd
*pd
;
447 pd
= kzalloc(sizeof(*pd
), GFP_KERNEL
);
449 return ERR_PTR(-ENOMEM
);
451 pd
->domain
= domain
= iommu_domain_alloc(&pci_bus_type
);
453 usnic_err("Failed to allocate IOMMU domain");
455 return ERR_PTR(-ENOMEM
);
458 iommu_set_fault_handler(pd
->domain
, usnic_uiom_dma_fault
, NULL
);
460 spin_lock_init(&pd
->lock
);
461 INIT_LIST_HEAD(&pd
->devs
);
466 void usnic_uiom_dealloc_pd(struct usnic_uiom_pd
*pd
)
468 iommu_domain_free(pd
->domain
);
472 int usnic_uiom_attach_dev_to_pd(struct usnic_uiom_pd
*pd
, struct device
*dev
)
474 struct usnic_uiom_dev
*uiom_dev
;
477 uiom_dev
= kzalloc(sizeof(*uiom_dev
), GFP_ATOMIC
);
482 err
= iommu_attach_device(pd
->domain
, dev
);
486 if (!iommu_capable(dev
->bus
, IOMMU_CAP_CACHE_COHERENCY
)) {
487 usnic_err("IOMMU of %s does not support cache coherency\n",
490 goto out_detach_device
;
493 spin_lock(&pd
->lock
);
494 list_add_tail(&uiom_dev
->link
, &pd
->devs
);
496 spin_unlock(&pd
->lock
);
501 iommu_detach_device(pd
->domain
, dev
);
507 void usnic_uiom_detach_dev_from_pd(struct usnic_uiom_pd
*pd
, struct device
*dev
)
509 struct usnic_uiom_dev
*uiom_dev
;
512 spin_lock(&pd
->lock
);
513 list_for_each_entry(uiom_dev
, &pd
->devs
, link
) {
514 if (uiom_dev
->dev
== dev
) {
521 usnic_err("Unable to free dev %s - not found\n",
523 spin_unlock(&pd
->lock
);
527 list_del(&uiom_dev
->link
);
529 spin_unlock(&pd
->lock
);
531 return iommu_detach_device(pd
->domain
, dev
);
534 struct device
**usnic_uiom_get_dev_list(struct usnic_uiom_pd
*pd
)
536 struct usnic_uiom_dev
*uiom_dev
;
537 struct device
**devs
;
540 spin_lock(&pd
->lock
);
541 devs
= kcalloc(pd
->dev_cnt
+ 1, sizeof(*devs
), GFP_ATOMIC
);
543 devs
= ERR_PTR(-ENOMEM
);
547 list_for_each_entry(uiom_dev
, &pd
->devs
, link
) {
548 devs
[i
++] = uiom_dev
->dev
;
551 spin_unlock(&pd
->lock
);
555 void usnic_uiom_free_dev_list(struct device
**devs
)
560 int usnic_uiom_init(char *drv_name
)
562 if (!iommu_present(&pci_bus_type
)) {
563 usnic_err("IOMMU required but not present or enabled. USNIC QPs will not function w/o enabling IOMMU\n");