2 * Copyright (C) 2008 Advanced Micro Devices, Inc.
4 * Author: Joerg Roedel <joerg.roedel@amd.com>
6 * This program is free software; you can redistribute it and/or modify it
7 * under the terms of the GNU General Public License version 2 as published
8 * by the Free Software Foundation.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
20 #include <linux/scatterlist.h>
21 #include <linux/dma-mapping.h>
22 #include <linux/stacktrace.h>
23 #include <linux/dma-debug.h>
24 #include <linux/spinlock.h>
25 #include <linux/debugfs.h>
26 #include <linux/uaccess.h>
27 #include <linux/export.h>
28 #include <linux/device.h>
29 #include <linux/types.h>
30 #include <linux/sched.h>
31 #include <linux/ctype.h>
32 #include <linux/list.h>
33 #include <linux/slab.h>
35 #include <asm/sections.h>
37 #define HASH_SIZE 1024ULL
38 #define HASH_FN_SHIFT 13
39 #define HASH_FN_MASK (HASH_SIZE - 1)
49 MAP_ERR_CHECK_NOT_APPLICABLE
,
54 #define DMA_DEBUG_STACKTRACE_ENTRIES 5
57 * struct dma_debug_entry - track a dma_map* or dma_alloc_coherent mapping
58 * @list: node on pre-allocated free_entries list
59 * @dev: 'dev' argument to dma_map_{page|single|sg} or dma_alloc_coherent
60 * @type: single, page, sg, coherent
61 * @pfn: page frame of the start address
62 * @offset: offset of mapping relative to pfn
63 * @size: length of the mapping
64 * @direction: enum dma_data_direction
65 * @sg_call_ents: 'nents' from dma_map_sg
66 * @sg_mapped_ents: 'mapped_ents' from dma_map_sg
67 * @map_err_type: track whether dma_mapping_error() was checked
68 * @stacktrace: support backtraces when a violation is detected
70 struct dma_debug_entry
{
71 struct list_head list
;
81 enum map_err_types map_err_type
;
82 #ifdef CONFIG_STACKTRACE
83 struct stack_trace stacktrace
;
84 unsigned long st_entries
[DMA_DEBUG_STACKTRACE_ENTRIES
];
88 typedef bool (*match_fn
)(struct dma_debug_entry
*, struct dma_debug_entry
*);
91 struct list_head list
;
93 } ____cacheline_aligned_in_smp
;
95 /* Hash list to save the allocated dma addresses */
96 static struct hash_bucket dma_entry_hash
[HASH_SIZE
];
97 /* List of pre-allocated dma_debug_entry's */
98 static LIST_HEAD(free_entries
);
99 /* Lock for the list above */
100 static DEFINE_SPINLOCK(free_entries_lock
);
102 /* Global disable flag - will be set in case of an error */
103 static u32 global_disable __read_mostly
;
105 /* Early initialization disable flag, set at the end of dma_debug_init */
106 static bool dma_debug_initialized __read_mostly
;
108 static inline bool dma_debug_disabled(void)
110 return global_disable
|| !dma_debug_initialized
;
113 /* Global error count */
114 static u32 error_count
;
116 /* Global error show enable*/
117 static u32 show_all_errors __read_mostly
;
118 /* Number of errors to show */
119 static u32 show_num_errors
= 1;
121 static u32 num_free_entries
;
122 static u32 min_free_entries
;
123 static u32 nr_total_entries
;
125 /* number of preallocated entries requested by kernel cmdline */
126 static u32 req_entries
;
128 /* debugfs dentry's for the stuff above */
129 static struct dentry
*dma_debug_dent __read_mostly
;
130 static struct dentry
*global_disable_dent __read_mostly
;
131 static struct dentry
*error_count_dent __read_mostly
;
132 static struct dentry
*show_all_errors_dent __read_mostly
;
133 static struct dentry
*show_num_errors_dent __read_mostly
;
134 static struct dentry
*num_free_entries_dent __read_mostly
;
135 static struct dentry
*min_free_entries_dent __read_mostly
;
136 static struct dentry
*filter_dent __read_mostly
;
138 /* per-driver filter related state */
140 #define NAME_MAX_LEN 64
142 static char current_driver_name
[NAME_MAX_LEN
] __read_mostly
;
143 static struct device_driver
*current_driver __read_mostly
;
145 static DEFINE_RWLOCK(driver_name_lock
);
147 static const char *const maperr2str
[] = {
148 [MAP_ERR_CHECK_NOT_APPLICABLE
] = "dma map error check not applicable",
149 [MAP_ERR_NOT_CHECKED
] = "dma map error not checked",
150 [MAP_ERR_CHECKED
] = "dma map error checked",
153 static const char *type2name
[4] = { "single", "page",
154 "scather-gather", "coherent" };
156 static const char *dir2name
[4] = { "DMA_BIDIRECTIONAL", "DMA_TO_DEVICE",
157 "DMA_FROM_DEVICE", "DMA_NONE" };
160 * The access to some variables in this macro is racy. We can't use atomic_t
161 * here because all these variables are exported to debugfs. Some of them even
162 * writeable. This is also the reason why a lock won't help much. But anyway,
163 * the races are no big deal. Here is why:
165 * error_count: the addition is racy, but the worst thing that can happen is
166 * that we don't count some errors
167 * show_num_errors: the subtraction is racy. Also no big deal because in
168 * worst case this will result in one warning more in the
169 * system log than the user configured. This variable is
170 * writeable via debugfs.
172 static inline void dump_entry_trace(struct dma_debug_entry
*entry
)
174 #ifdef CONFIG_STACKTRACE
176 pr_warning("Mapped at:\n");
177 print_stack_trace(&entry
->stacktrace
, 0);
182 static bool driver_filter(struct device
*dev
)
184 struct device_driver
*drv
;
188 /* driver filter off */
189 if (likely(!current_driver_name
[0]))
192 /* driver filter on and initialized */
193 if (current_driver
&& dev
&& dev
->driver
== current_driver
)
196 /* driver filter on, but we can't filter on a NULL device... */
200 if (current_driver
|| !current_driver_name
[0])
203 /* driver filter on but not yet initialized */
208 /* lock to protect against change of current_driver_name */
209 read_lock_irqsave(&driver_name_lock
, flags
);
213 strncmp(current_driver_name
, drv
->name
, NAME_MAX_LEN
- 1) == 0) {
214 current_driver
= drv
;
218 read_unlock_irqrestore(&driver_name_lock
, flags
);
223 #define err_printk(dev, entry, format, arg...) do { \
225 if (driver_filter(dev) && \
226 (show_all_errors || show_num_errors > 0)) { \
227 WARN(1, "%s %s: " format, \
228 dev ? dev_driver_string(dev) : "NULL", \
229 dev ? dev_name(dev) : "NULL", ## arg); \
230 dump_entry_trace(entry); \
232 if (!show_all_errors && show_num_errors > 0) \
233 show_num_errors -= 1; \
237 * Hash related functions
239 * Every DMA-API request is saved into a struct dma_debug_entry. To
240 * have quick access to these structs they are stored into a hash.
242 static int hash_fn(struct dma_debug_entry
*entry
)
245 * Hash function is based on the dma address.
246 * We use bits 20-27 here as the index into the hash
248 return (entry
->dev_addr
>> HASH_FN_SHIFT
) & HASH_FN_MASK
;
252 * Request exclusive access to a hash bucket for a given dma_debug_entry.
254 static struct hash_bucket
*get_hash_bucket(struct dma_debug_entry
*entry
,
255 unsigned long *flags
)
257 int idx
= hash_fn(entry
);
258 unsigned long __flags
;
260 spin_lock_irqsave(&dma_entry_hash
[idx
].lock
, __flags
);
262 return &dma_entry_hash
[idx
];
266 * Give up exclusive access to the hash bucket
268 static void put_hash_bucket(struct hash_bucket
*bucket
,
269 unsigned long *flags
)
271 unsigned long __flags
= *flags
;
273 spin_unlock_irqrestore(&bucket
->lock
, __flags
);
276 static bool exact_match(struct dma_debug_entry
*a
, struct dma_debug_entry
*b
)
278 return ((a
->dev_addr
== b
->dev_addr
) &&
279 (a
->dev
== b
->dev
)) ? true : false;
282 static bool containing_match(struct dma_debug_entry
*a
,
283 struct dma_debug_entry
*b
)
285 if (a
->dev
!= b
->dev
)
288 if ((b
->dev_addr
<= a
->dev_addr
) &&
289 ((b
->dev_addr
+ b
->size
) >= (a
->dev_addr
+ a
->size
)))
296 * Search a given entry in the hash bucket list
298 static struct dma_debug_entry
*__hash_bucket_find(struct hash_bucket
*bucket
,
299 struct dma_debug_entry
*ref
,
302 struct dma_debug_entry
*entry
, *ret
= NULL
;
303 int matches
= 0, match_lvl
, last_lvl
= -1;
305 list_for_each_entry(entry
, &bucket
->list
, list
) {
306 if (!match(ref
, entry
))
310 * Some drivers map the same physical address multiple
311 * times. Without a hardware IOMMU this results in the
312 * same device addresses being put into the dma-debug
313 * hash multiple times too. This can result in false
314 * positives being reported. Therefore we implement a
315 * best-fit algorithm here which returns the entry from
316 * the hash which fits best to the reference value
317 * instead of the first-fit.
321 entry
->size
== ref
->size
? ++match_lvl
: 0;
322 entry
->type
== ref
->type
? ++match_lvl
: 0;
323 entry
->direction
== ref
->direction
? ++match_lvl
: 0;
324 entry
->sg_call_ents
== ref
->sg_call_ents
? ++match_lvl
: 0;
326 if (match_lvl
== 4) {
327 /* perfect-fit - return the result */
329 } else if (match_lvl
> last_lvl
) {
331 * We found an entry that fits better then the
332 * previous one or it is the 1st match.
334 last_lvl
= match_lvl
;
340 * If we have multiple matches but no perfect-fit, just return
343 ret
= (matches
== 1) ? ret
: NULL
;
348 static struct dma_debug_entry
*bucket_find_exact(struct hash_bucket
*bucket
,
349 struct dma_debug_entry
*ref
)
351 return __hash_bucket_find(bucket
, ref
, exact_match
);
354 static struct dma_debug_entry
*bucket_find_contain(struct hash_bucket
**bucket
,
355 struct dma_debug_entry
*ref
,
356 unsigned long *flags
)
359 unsigned int max_range
= dma_get_max_seg_size(ref
->dev
);
360 struct dma_debug_entry
*entry
, index
= *ref
;
361 unsigned int range
= 0;
363 while (range
<= max_range
) {
364 entry
= __hash_bucket_find(*bucket
, &index
, containing_match
);
370 * Nothing found, go back a hash bucket
372 put_hash_bucket(*bucket
, flags
);
373 range
+= (1 << HASH_FN_SHIFT
);
374 index
.dev_addr
-= (1 << HASH_FN_SHIFT
);
375 *bucket
= get_hash_bucket(&index
, flags
);
382 * Add an entry to a hash bucket
384 static void hash_bucket_add(struct hash_bucket
*bucket
,
385 struct dma_debug_entry
*entry
)
387 list_add_tail(&entry
->list
, &bucket
->list
);
391 * Remove entry from a hash bucket list
393 static void hash_bucket_del(struct dma_debug_entry
*entry
)
395 list_del(&entry
->list
);
398 static unsigned long long phys_addr(struct dma_debug_entry
*entry
)
400 return page_to_phys(pfn_to_page(entry
->pfn
)) + entry
->offset
;
404 * Dump mapping entries for debugging purposes
406 void debug_dma_dump_mappings(struct device
*dev
)
410 for (idx
= 0; idx
< HASH_SIZE
; idx
++) {
411 struct hash_bucket
*bucket
= &dma_entry_hash
[idx
];
412 struct dma_debug_entry
*entry
;
415 spin_lock_irqsave(&bucket
->lock
, flags
);
417 list_for_each_entry(entry
, &bucket
->list
, list
) {
418 if (!dev
|| dev
== entry
->dev
) {
420 "%s idx %d P=%Lx N=%lx D=%Lx L=%Lx %s %s\n",
421 type2name
[entry
->type
], idx
,
422 phys_addr(entry
), entry
->pfn
,
423 entry
->dev_addr
, entry
->size
,
424 dir2name
[entry
->direction
],
425 maperr2str
[entry
->map_err_type
]);
429 spin_unlock_irqrestore(&bucket
->lock
, flags
);
432 EXPORT_SYMBOL(debug_dma_dump_mappings
);
435 * For each mapping (initial cacheline in the case of
436 * dma_alloc_coherent/dma_map_page, initial cacheline in each page of a
437 * scatterlist, or the cacheline specified in dma_map_single) insert
438 * into this tree using the cacheline as the key. At
439 * dma_unmap_{single|sg|page} or dma_free_coherent delete the entry. If
440 * the entry already exists at insertion time add a tag as a reference
441 * count for the overlapping mappings. For now, the overlap tracking
442 * just ensures that 'unmaps' balance 'maps' before marking the
443 * cacheline idle, but we should also be flagging overlaps as an API
446 * Memory usage is mostly constrained by the maximum number of available
447 * dma-debug entries in that we need a free dma_debug_entry before
448 * inserting into the tree. In the case of dma_map_page and
449 * dma_alloc_coherent there is only one dma_debug_entry and one
450 * dma_active_cacheline entry to track per event. dma_map_sg(), on the
451 * other hand, consumes a single dma_debug_entry, but inserts 'nents'
452 * entries into the tree.
454 * At any time debug_dma_assert_idle() can be called to trigger a
455 * warning if any cachelines in the given page are in the active set.
457 static RADIX_TREE(dma_active_cacheline
, GFP_NOWAIT
);
458 static DEFINE_SPINLOCK(radix_lock
);
459 #define ACTIVE_CACHELINE_MAX_OVERLAP ((1 << RADIX_TREE_MAX_TAGS) - 1)
460 #define CACHELINE_PER_PAGE_SHIFT (PAGE_SHIFT - L1_CACHE_SHIFT)
461 #define CACHELINES_PER_PAGE (1 << CACHELINE_PER_PAGE_SHIFT)
463 static phys_addr_t
to_cacheline_number(struct dma_debug_entry
*entry
)
465 return (entry
->pfn
<< CACHELINE_PER_PAGE_SHIFT
) +
466 (entry
->offset
>> L1_CACHE_SHIFT
);
469 static int active_cacheline_read_overlap(phys_addr_t cln
)
473 for (i
= RADIX_TREE_MAX_TAGS
- 1; i
>= 0; i
--)
474 if (radix_tree_tag_get(&dma_active_cacheline
, cln
, i
))
479 static int active_cacheline_set_overlap(phys_addr_t cln
, int overlap
)
483 if (overlap
> ACTIVE_CACHELINE_MAX_OVERLAP
|| overlap
< 0)
486 for (i
= RADIX_TREE_MAX_TAGS
- 1; i
>= 0; i
--)
487 if (overlap
& 1 << i
)
488 radix_tree_tag_set(&dma_active_cacheline
, cln
, i
);
490 radix_tree_tag_clear(&dma_active_cacheline
, cln
, i
);
495 static void active_cacheline_inc_overlap(phys_addr_t cln
)
497 int overlap
= active_cacheline_read_overlap(cln
);
499 overlap
= active_cacheline_set_overlap(cln
, ++overlap
);
501 /* If we overflowed the overlap counter then we're potentially
502 * leaking dma-mappings. Otherwise, if maps and unmaps are
503 * balanced then this overflow may cause false negatives in
504 * debug_dma_assert_idle() as the cacheline may be marked idle
507 WARN_ONCE(overlap
> ACTIVE_CACHELINE_MAX_OVERLAP
,
508 "DMA-API: exceeded %d overlapping mappings of cacheline %pa\n",
509 ACTIVE_CACHELINE_MAX_OVERLAP
, &cln
);
512 static int active_cacheline_dec_overlap(phys_addr_t cln
)
514 int overlap
= active_cacheline_read_overlap(cln
);
516 return active_cacheline_set_overlap(cln
, --overlap
);
519 static int active_cacheline_insert(struct dma_debug_entry
*entry
)
521 phys_addr_t cln
= to_cacheline_number(entry
);
525 /* If the device is not writing memory then we don't have any
526 * concerns about the cpu consuming stale data. This mitigates
527 * legitimate usages of overlapping mappings.
529 if (entry
->direction
== DMA_TO_DEVICE
)
532 spin_lock_irqsave(&radix_lock
, flags
);
533 rc
= radix_tree_insert(&dma_active_cacheline
, cln
, entry
);
535 active_cacheline_inc_overlap(cln
);
536 spin_unlock_irqrestore(&radix_lock
, flags
);
541 static void active_cacheline_remove(struct dma_debug_entry
*entry
)
543 phys_addr_t cln
= to_cacheline_number(entry
);
546 /* ...mirror the insert case */
547 if (entry
->direction
== DMA_TO_DEVICE
)
550 spin_lock_irqsave(&radix_lock
, flags
);
551 /* since we are counting overlaps the final put of the
552 * cacheline will occur when the overlap count is 0.
553 * active_cacheline_dec_overlap() returns -1 in that case
555 if (active_cacheline_dec_overlap(cln
) < 0)
556 radix_tree_delete(&dma_active_cacheline
, cln
);
557 spin_unlock_irqrestore(&radix_lock
, flags
);
561 * debug_dma_assert_idle() - assert that a page is not undergoing dma
562 * @page: page to lookup in the dma_active_cacheline tree
564 * Place a call to this routine in cases where the cpu touching the page
565 * before the dma completes (page is dma_unmapped) will lead to data
568 void debug_dma_assert_idle(struct page
*page
)
570 static struct dma_debug_entry
*ents
[CACHELINES_PER_PAGE
];
571 struct dma_debug_entry
*entry
= NULL
;
572 void **results
= (void **) &ents
;
573 unsigned int nents
, i
;
580 cln
= (phys_addr_t
) page_to_pfn(page
) << CACHELINE_PER_PAGE_SHIFT
;
581 spin_lock_irqsave(&radix_lock
, flags
);
582 nents
= radix_tree_gang_lookup(&dma_active_cacheline
, results
, cln
,
583 CACHELINES_PER_PAGE
);
584 for (i
= 0; i
< nents
; i
++) {
585 phys_addr_t ent_cln
= to_cacheline_number(ents
[i
]);
587 if (ent_cln
== cln
) {
590 } else if (ent_cln
>= cln
+ CACHELINES_PER_PAGE
)
593 spin_unlock_irqrestore(&radix_lock
, flags
);
598 cln
= to_cacheline_number(entry
);
599 err_printk(entry
->dev
, entry
,
600 "DMA-API: cpu touching an active dma mapped cacheline [cln=%pa]\n",
605 * Wrapper function for adding an entry to the hash.
606 * This function takes care of locking itself.
608 static void add_dma_entry(struct dma_debug_entry
*entry
)
610 struct hash_bucket
*bucket
;
614 bucket
= get_hash_bucket(entry
, &flags
);
615 hash_bucket_add(bucket
, entry
);
616 put_hash_bucket(bucket
, &flags
);
618 rc
= active_cacheline_insert(entry
);
620 pr_err("DMA-API: cacheline tracking ENOMEM, dma-debug disabled\n");
621 global_disable
= true;
624 /* TODO: report -EEXIST errors here as overlapping mappings are
625 * not supported by the DMA API
629 static struct dma_debug_entry
*__dma_entry_alloc(void)
631 struct dma_debug_entry
*entry
;
633 entry
= list_entry(free_entries
.next
, struct dma_debug_entry
, list
);
634 list_del(&entry
->list
);
635 memset(entry
, 0, sizeof(*entry
));
637 num_free_entries
-= 1;
638 if (num_free_entries
< min_free_entries
)
639 min_free_entries
= num_free_entries
;
644 /* struct dma_entry allocator
646 * The next two functions implement the allocator for
647 * struct dma_debug_entries.
649 static struct dma_debug_entry
*dma_entry_alloc(void)
651 struct dma_debug_entry
*entry
;
654 spin_lock_irqsave(&free_entries_lock
, flags
);
656 if (list_empty(&free_entries
)) {
657 pr_err("DMA-API: debugging out of memory - disabling\n");
658 global_disable
= true;
659 spin_unlock_irqrestore(&free_entries_lock
, flags
);
663 entry
= __dma_entry_alloc();
665 spin_unlock_irqrestore(&free_entries_lock
, flags
);
667 #ifdef CONFIG_STACKTRACE
668 entry
->stacktrace
.max_entries
= DMA_DEBUG_STACKTRACE_ENTRIES
;
669 entry
->stacktrace
.entries
= entry
->st_entries
;
670 entry
->stacktrace
.skip
= 2;
671 save_stack_trace(&entry
->stacktrace
);
677 static void dma_entry_free(struct dma_debug_entry
*entry
)
681 active_cacheline_remove(entry
);
684 * add to beginning of the list - this way the entries are
685 * more likely cache hot when they are reallocated.
687 spin_lock_irqsave(&free_entries_lock
, flags
);
688 list_add(&entry
->list
, &free_entries
);
689 num_free_entries
+= 1;
690 spin_unlock_irqrestore(&free_entries_lock
, flags
);
693 int dma_debug_resize_entries(u32 num_entries
)
695 int i
, delta
, ret
= 0;
697 struct dma_debug_entry
*entry
;
700 spin_lock_irqsave(&free_entries_lock
, flags
);
702 if (nr_total_entries
< num_entries
) {
703 delta
= num_entries
- nr_total_entries
;
705 spin_unlock_irqrestore(&free_entries_lock
, flags
);
707 for (i
= 0; i
< delta
; i
++) {
708 entry
= kzalloc(sizeof(*entry
), GFP_KERNEL
);
712 list_add_tail(&entry
->list
, &tmp
);
715 spin_lock_irqsave(&free_entries_lock
, flags
);
717 list_splice(&tmp
, &free_entries
);
718 nr_total_entries
+= i
;
719 num_free_entries
+= i
;
721 delta
= nr_total_entries
- num_entries
;
723 for (i
= 0; i
< delta
&& !list_empty(&free_entries
); i
++) {
724 entry
= __dma_entry_alloc();
728 nr_total_entries
-= i
;
731 if (nr_total_entries
!= num_entries
)
734 spin_unlock_irqrestore(&free_entries_lock
, flags
);
738 EXPORT_SYMBOL(dma_debug_resize_entries
);
741 * DMA-API debugging init code
743 * The init code does two things:
744 * 1. Initialize core data structures
745 * 2. Preallocate a given number of dma_debug_entry structs
748 static int prealloc_memory(u32 num_entries
)
750 struct dma_debug_entry
*entry
, *next_entry
;
753 for (i
= 0; i
< num_entries
; ++i
) {
754 entry
= kzalloc(sizeof(*entry
), GFP_KERNEL
);
758 list_add_tail(&entry
->list
, &free_entries
);
761 num_free_entries
= num_entries
;
762 min_free_entries
= num_entries
;
764 pr_info("DMA-API: preallocated %d debug entries\n", num_entries
);
770 list_for_each_entry_safe(entry
, next_entry
, &free_entries
, list
) {
771 list_del(&entry
->list
);
778 static ssize_t
filter_read(struct file
*file
, char __user
*user_buf
,
779 size_t count
, loff_t
*ppos
)
781 char buf
[NAME_MAX_LEN
+ 1];
785 if (!current_driver_name
[0])
789 * We can't copy to userspace directly because current_driver_name can
790 * only be read under the driver_name_lock with irqs disabled. So
791 * create a temporary copy first.
793 read_lock_irqsave(&driver_name_lock
, flags
);
794 len
= scnprintf(buf
, NAME_MAX_LEN
+ 1, "%s\n", current_driver_name
);
795 read_unlock_irqrestore(&driver_name_lock
, flags
);
797 return simple_read_from_buffer(user_buf
, count
, ppos
, buf
, len
);
800 static ssize_t
filter_write(struct file
*file
, const char __user
*userbuf
,
801 size_t count
, loff_t
*ppos
)
803 char buf
[NAME_MAX_LEN
];
809 * We can't copy from userspace directly. Access to
810 * current_driver_name is protected with a write_lock with irqs
811 * disabled. Since copy_from_user can fault and may sleep we
812 * need to copy to temporary buffer first
814 len
= min(count
, (size_t)(NAME_MAX_LEN
- 1));
815 if (copy_from_user(buf
, userbuf
, len
))
820 write_lock_irqsave(&driver_name_lock
, flags
);
823 * Now handle the string we got from userspace very carefully.
825 * - only use the first token we got
826 * - token delimiter is everything looking like a space
827 * character (' ', '\n', '\t' ...)
830 if (!isalnum(buf
[0])) {
832 * If the first character userspace gave us is not
833 * alphanumerical then assume the filter should be
836 if (current_driver_name
[0])
837 pr_info("DMA-API: switching off dma-debug driver filter\n");
838 current_driver_name
[0] = 0;
839 current_driver
= NULL
;
844 * Now parse out the first token and use it as the name for the
845 * driver to filter for.
847 for (i
= 0; i
< NAME_MAX_LEN
- 1; ++i
) {
848 current_driver_name
[i
] = buf
[i
];
849 if (isspace(buf
[i
]) || buf
[i
] == ' ' || buf
[i
] == 0)
852 current_driver_name
[i
] = 0;
853 current_driver
= NULL
;
855 pr_info("DMA-API: enable driver filter for driver [%s]\n",
856 current_driver_name
);
859 write_unlock_irqrestore(&driver_name_lock
, flags
);
864 static const struct file_operations filter_fops
= {
866 .write
= filter_write
,
867 .llseek
= default_llseek
,
870 static int dma_debug_fs_init(void)
872 dma_debug_dent
= debugfs_create_dir("dma-api", NULL
);
873 if (!dma_debug_dent
) {
874 pr_err("DMA-API: can not create debugfs directory\n");
878 global_disable_dent
= debugfs_create_bool("disabled", 0444,
881 if (!global_disable_dent
)
884 error_count_dent
= debugfs_create_u32("error_count", 0444,
885 dma_debug_dent
, &error_count
);
886 if (!error_count_dent
)
889 show_all_errors_dent
= debugfs_create_u32("all_errors", 0644,
892 if (!show_all_errors_dent
)
895 show_num_errors_dent
= debugfs_create_u32("num_errors", 0644,
898 if (!show_num_errors_dent
)
901 num_free_entries_dent
= debugfs_create_u32("num_free_entries", 0444,
904 if (!num_free_entries_dent
)
907 min_free_entries_dent
= debugfs_create_u32("min_free_entries", 0444,
910 if (!min_free_entries_dent
)
913 filter_dent
= debugfs_create_file("driver_filter", 0644,
914 dma_debug_dent
, NULL
, &filter_fops
);
921 debugfs_remove_recursive(dma_debug_dent
);
926 static int device_dma_allocations(struct device
*dev
, struct dma_debug_entry
**out_entry
)
928 struct dma_debug_entry
*entry
;
932 local_irq_save(flags
);
934 for (i
= 0; i
< HASH_SIZE
; ++i
) {
935 spin_lock(&dma_entry_hash
[i
].lock
);
936 list_for_each_entry(entry
, &dma_entry_hash
[i
].list
, list
) {
937 if (entry
->dev
== dev
) {
942 spin_unlock(&dma_entry_hash
[i
].lock
);
945 local_irq_restore(flags
);
950 static int dma_debug_device_change(struct notifier_block
*nb
, unsigned long action
, void *data
)
952 struct device
*dev
= data
;
953 struct dma_debug_entry
*uninitialized_var(entry
);
956 if (dma_debug_disabled())
960 case BUS_NOTIFY_UNBOUND_DRIVER
:
961 count
= device_dma_allocations(dev
, &entry
);
964 err_printk(dev
, entry
, "DMA-API: device driver has pending "
965 "DMA allocations while released from device "
967 "One of leaked entries details: "
968 "[device address=0x%016llx] [size=%llu bytes] "
969 "[mapped with %s] [mapped as %s]\n",
970 count
, entry
->dev_addr
, entry
->size
,
971 dir2name
[entry
->direction
], type2name
[entry
->type
]);
980 void dma_debug_add_bus(struct bus_type
*bus
)
982 struct notifier_block
*nb
;
984 if (dma_debug_disabled())
987 nb
= kzalloc(sizeof(struct notifier_block
), GFP_KERNEL
);
989 pr_err("dma_debug_add_bus: out of memory\n");
993 nb
->notifier_call
= dma_debug_device_change
;
995 bus_register_notifier(bus
, nb
);
999 * Let the architectures decide how many entries should be preallocated.
1001 void dma_debug_init(u32 num_entries
)
1005 /* Do not use dma_debug_initialized here, since we really want to be
1006 * called to set dma_debug_initialized
1011 for (i
= 0; i
< HASH_SIZE
; ++i
) {
1012 INIT_LIST_HEAD(&dma_entry_hash
[i
].list
);
1013 spin_lock_init(&dma_entry_hash
[i
].lock
);
1016 if (dma_debug_fs_init() != 0) {
1017 pr_err("DMA-API: error creating debugfs entries - disabling\n");
1018 global_disable
= true;
1024 num_entries
= req_entries
;
1026 if (prealloc_memory(num_entries
) != 0) {
1027 pr_err("DMA-API: debugging out of memory error - disabled\n");
1028 global_disable
= true;
1033 nr_total_entries
= num_free_entries
;
1035 dma_debug_initialized
= true;
1037 pr_info("DMA-API: debugging enabled by kernel config\n");
1040 static __init
int dma_debug_cmdline(char *str
)
1045 if (strncmp(str
, "off", 3) == 0) {
1046 pr_info("DMA-API: debugging disabled on kernel command line\n");
1047 global_disable
= true;
1053 static __init
int dma_debug_entries_cmdline(char *str
)
1060 res
= get_option(&str
, &req_entries
);
1068 __setup("dma_debug=", dma_debug_cmdline
);
1069 __setup("dma_debug_entries=", dma_debug_entries_cmdline
);
1071 static void check_unmap(struct dma_debug_entry
*ref
)
1073 struct dma_debug_entry
*entry
;
1074 struct hash_bucket
*bucket
;
1075 unsigned long flags
;
1077 bucket
= get_hash_bucket(ref
, &flags
);
1078 entry
= bucket_find_exact(bucket
, ref
);
1081 /* must drop lock before calling dma_mapping_error */
1082 put_hash_bucket(bucket
, &flags
);
1084 if (dma_mapping_error(ref
->dev
, ref
->dev_addr
)) {
1085 err_printk(ref
->dev
, NULL
,
1086 "DMA-API: device driver tries to free an "
1087 "invalid DMA memory address\n");
1089 err_printk(ref
->dev
, NULL
,
1090 "DMA-API: device driver tries to free DMA "
1091 "memory it has not allocated [device "
1092 "address=0x%016llx] [size=%llu bytes]\n",
1093 ref
->dev_addr
, ref
->size
);
1098 if (ref
->size
!= entry
->size
) {
1099 err_printk(ref
->dev
, entry
, "DMA-API: device driver frees "
1100 "DMA memory with different size "
1101 "[device address=0x%016llx] [map size=%llu bytes] "
1102 "[unmap size=%llu bytes]\n",
1103 ref
->dev_addr
, entry
->size
, ref
->size
);
1106 if (ref
->type
!= entry
->type
) {
1107 err_printk(ref
->dev
, entry
, "DMA-API: device driver frees "
1108 "DMA memory with wrong function "
1109 "[device address=0x%016llx] [size=%llu bytes] "
1110 "[mapped as %s] [unmapped as %s]\n",
1111 ref
->dev_addr
, ref
->size
,
1112 type2name
[entry
->type
], type2name
[ref
->type
]);
1113 } else if ((entry
->type
== dma_debug_coherent
) &&
1114 (phys_addr(ref
) != phys_addr(entry
))) {
1115 err_printk(ref
->dev
, entry
, "DMA-API: device driver frees "
1116 "DMA memory with different CPU address "
1117 "[device address=0x%016llx] [size=%llu bytes] "
1118 "[cpu alloc address=0x%016llx] "
1119 "[cpu free address=0x%016llx]",
1120 ref
->dev_addr
, ref
->size
,
1125 if (ref
->sg_call_ents
&& ref
->type
== dma_debug_sg
&&
1126 ref
->sg_call_ents
!= entry
->sg_call_ents
) {
1127 err_printk(ref
->dev
, entry
, "DMA-API: device driver frees "
1128 "DMA sg list with different entry count "
1129 "[map count=%d] [unmap count=%d]\n",
1130 entry
->sg_call_ents
, ref
->sg_call_ents
);
1134 * This may be no bug in reality - but most implementations of the
1135 * DMA API don't handle this properly, so check for it here
1137 if (ref
->direction
!= entry
->direction
) {
1138 err_printk(ref
->dev
, entry
, "DMA-API: device driver frees "
1139 "DMA memory with different direction "
1140 "[device address=0x%016llx] [size=%llu bytes] "
1141 "[mapped with %s] [unmapped with %s]\n",
1142 ref
->dev_addr
, ref
->size
,
1143 dir2name
[entry
->direction
],
1144 dir2name
[ref
->direction
]);
1147 if (entry
->map_err_type
== MAP_ERR_NOT_CHECKED
) {
1148 err_printk(ref
->dev
, entry
,
1149 "DMA-API: device driver failed to check map error"
1150 "[device address=0x%016llx] [size=%llu bytes] "
1152 ref
->dev_addr
, ref
->size
,
1153 type2name
[entry
->type
]);
1156 hash_bucket_del(entry
);
1157 dma_entry_free(entry
);
1159 put_hash_bucket(bucket
, &flags
);
1162 static void check_for_stack(struct device
*dev
, void *addr
)
1164 if (object_is_on_stack(addr
))
1165 err_printk(dev
, NULL
, "DMA-API: device driver maps memory from "
1166 "stack [addr=%p]\n", addr
);
1169 static inline bool overlap(void *addr
, unsigned long len
, void *start
, void *end
)
1171 unsigned long a1
= (unsigned long)addr
;
1172 unsigned long b1
= a1
+ len
;
1173 unsigned long a2
= (unsigned long)start
;
1174 unsigned long b2
= (unsigned long)end
;
1176 return !(b1
<= a2
|| a1
>= b2
);
1179 static void check_for_illegal_area(struct device
*dev
, void *addr
, unsigned long len
)
1181 if (overlap(addr
, len
, _text
, _etext
) ||
1182 overlap(addr
, len
, __start_rodata
, __end_rodata
))
1183 err_printk(dev
, NULL
, "DMA-API: device driver maps memory from kernel text or rodata [addr=%p] [len=%lu]\n", addr
, len
);
1186 static void check_sync(struct device
*dev
,
1187 struct dma_debug_entry
*ref
,
1190 struct dma_debug_entry
*entry
;
1191 struct hash_bucket
*bucket
;
1192 unsigned long flags
;
1194 bucket
= get_hash_bucket(ref
, &flags
);
1196 entry
= bucket_find_contain(&bucket
, ref
, &flags
);
1199 err_printk(dev
, NULL
, "DMA-API: device driver tries "
1200 "to sync DMA memory it has not allocated "
1201 "[device address=0x%016llx] [size=%llu bytes]\n",
1202 (unsigned long long)ref
->dev_addr
, ref
->size
);
1206 if (ref
->size
> entry
->size
) {
1207 err_printk(dev
, entry
, "DMA-API: device driver syncs"
1208 " DMA memory outside allocated range "
1209 "[device address=0x%016llx] "
1210 "[allocation size=%llu bytes] "
1211 "[sync offset+size=%llu]\n",
1212 entry
->dev_addr
, entry
->size
,
1216 if (entry
->direction
== DMA_BIDIRECTIONAL
)
1219 if (ref
->direction
!= entry
->direction
) {
1220 err_printk(dev
, entry
, "DMA-API: device driver syncs "
1221 "DMA memory with different direction "
1222 "[device address=0x%016llx] [size=%llu bytes] "
1223 "[mapped with %s] [synced with %s]\n",
1224 (unsigned long long)ref
->dev_addr
, entry
->size
,
1225 dir2name
[entry
->direction
],
1226 dir2name
[ref
->direction
]);
1229 if (to_cpu
&& !(entry
->direction
== DMA_FROM_DEVICE
) &&
1230 !(ref
->direction
== DMA_TO_DEVICE
))
1231 err_printk(dev
, entry
, "DMA-API: device driver syncs "
1232 "device read-only DMA memory for cpu "
1233 "[device address=0x%016llx] [size=%llu bytes] "
1234 "[mapped with %s] [synced with %s]\n",
1235 (unsigned long long)ref
->dev_addr
, entry
->size
,
1236 dir2name
[entry
->direction
],
1237 dir2name
[ref
->direction
]);
1239 if (!to_cpu
&& !(entry
->direction
== DMA_TO_DEVICE
) &&
1240 !(ref
->direction
== DMA_FROM_DEVICE
))
1241 err_printk(dev
, entry
, "DMA-API: device driver syncs "
1242 "device write-only DMA memory to device "
1243 "[device address=0x%016llx] [size=%llu bytes] "
1244 "[mapped with %s] [synced with %s]\n",
1245 (unsigned long long)ref
->dev_addr
, entry
->size
,
1246 dir2name
[entry
->direction
],
1247 dir2name
[ref
->direction
]);
1250 put_hash_bucket(bucket
, &flags
);
1253 void debug_dma_map_page(struct device
*dev
, struct page
*page
, size_t offset
,
1254 size_t size
, int direction
, dma_addr_t dma_addr
,
1257 struct dma_debug_entry
*entry
;
1259 if (unlikely(dma_debug_disabled()))
1262 if (dma_mapping_error(dev
, dma_addr
))
1265 entry
= dma_entry_alloc();
1270 entry
->type
= dma_debug_page
;
1271 entry
->pfn
= page_to_pfn(page
);
1272 entry
->offset
= offset
,
1273 entry
->dev_addr
= dma_addr
;
1275 entry
->direction
= direction
;
1276 entry
->map_err_type
= MAP_ERR_NOT_CHECKED
;
1279 entry
->type
= dma_debug_single
;
1281 if (!PageHighMem(page
)) {
1282 void *addr
= page_address(page
) + offset
;
1284 check_for_stack(dev
, addr
);
1285 check_for_illegal_area(dev
, addr
, size
);
1288 add_dma_entry(entry
);
1290 EXPORT_SYMBOL(debug_dma_map_page
);
1292 void debug_dma_mapping_error(struct device
*dev
, dma_addr_t dma_addr
)
1294 struct dma_debug_entry ref
;
1295 struct dma_debug_entry
*entry
;
1296 struct hash_bucket
*bucket
;
1297 unsigned long flags
;
1299 if (unlikely(dma_debug_disabled()))
1303 ref
.dev_addr
= dma_addr
;
1304 bucket
= get_hash_bucket(&ref
, &flags
);
1306 list_for_each_entry(entry
, &bucket
->list
, list
) {
1307 if (!exact_match(&ref
, entry
))
1311 * The same physical address can be mapped multiple
1312 * times. Without a hardware IOMMU this results in the
1313 * same device addresses being put into the dma-debug
1314 * hash multiple times too. This can result in false
1315 * positives being reported. Therefore we implement a
1316 * best-fit algorithm here which updates the first entry
1317 * from the hash which fits the reference value and is
1318 * not currently listed as being checked.
1320 if (entry
->map_err_type
== MAP_ERR_NOT_CHECKED
) {
1321 entry
->map_err_type
= MAP_ERR_CHECKED
;
1326 put_hash_bucket(bucket
, &flags
);
1328 EXPORT_SYMBOL(debug_dma_mapping_error
);
1330 void debug_dma_unmap_page(struct device
*dev
, dma_addr_t addr
,
1331 size_t size
, int direction
, bool map_single
)
1333 struct dma_debug_entry ref
= {
1334 .type
= dma_debug_page
,
1338 .direction
= direction
,
1341 if (unlikely(dma_debug_disabled()))
1345 ref
.type
= dma_debug_single
;
1349 EXPORT_SYMBOL(debug_dma_unmap_page
);
1351 void debug_dma_map_sg(struct device
*dev
, struct scatterlist
*sg
,
1352 int nents
, int mapped_ents
, int direction
)
1354 struct dma_debug_entry
*entry
;
1355 struct scatterlist
*s
;
1358 if (unlikely(dma_debug_disabled()))
1361 for_each_sg(sg
, s
, mapped_ents
, i
) {
1362 entry
= dma_entry_alloc();
1366 entry
->type
= dma_debug_sg
;
1368 entry
->pfn
= page_to_pfn(sg_page(s
));
1369 entry
->offset
= s
->offset
,
1370 entry
->size
= sg_dma_len(s
);
1371 entry
->dev_addr
= sg_dma_address(s
);
1372 entry
->direction
= direction
;
1373 entry
->sg_call_ents
= nents
;
1374 entry
->sg_mapped_ents
= mapped_ents
;
1376 if (!PageHighMem(sg_page(s
))) {
1377 check_for_stack(dev
, sg_virt(s
));
1378 check_for_illegal_area(dev
, sg_virt(s
), sg_dma_len(s
));
1381 add_dma_entry(entry
);
1384 EXPORT_SYMBOL(debug_dma_map_sg
);
1386 static int get_nr_mapped_entries(struct device
*dev
,
1387 struct dma_debug_entry
*ref
)
1389 struct dma_debug_entry
*entry
;
1390 struct hash_bucket
*bucket
;
1391 unsigned long flags
;
1394 bucket
= get_hash_bucket(ref
, &flags
);
1395 entry
= bucket_find_exact(bucket
, ref
);
1399 mapped_ents
= entry
->sg_mapped_ents
;
1400 put_hash_bucket(bucket
, &flags
);
1405 void debug_dma_unmap_sg(struct device
*dev
, struct scatterlist
*sglist
,
1406 int nelems
, int dir
)
1408 struct scatterlist
*s
;
1409 int mapped_ents
= 0, i
;
1411 if (unlikely(dma_debug_disabled()))
1414 for_each_sg(sglist
, s
, nelems
, i
) {
1416 struct dma_debug_entry ref
= {
1417 .type
= dma_debug_sg
,
1419 .pfn
= page_to_pfn(sg_page(s
)),
1420 .offset
= s
->offset
,
1421 .dev_addr
= sg_dma_address(s
),
1422 .size
= sg_dma_len(s
),
1424 .sg_call_ents
= nelems
,
1427 if (mapped_ents
&& i
>= mapped_ents
)
1431 mapped_ents
= get_nr_mapped_entries(dev
, &ref
);
1436 EXPORT_SYMBOL(debug_dma_unmap_sg
);
1438 void debug_dma_alloc_coherent(struct device
*dev
, size_t size
,
1439 dma_addr_t dma_addr
, void *virt
)
1441 struct dma_debug_entry
*entry
;
1443 if (unlikely(dma_debug_disabled()))
1446 if (unlikely(virt
== NULL
))
1449 entry
= dma_entry_alloc();
1453 entry
->type
= dma_debug_coherent
;
1455 entry
->pfn
= page_to_pfn(virt_to_page(virt
));
1456 entry
->offset
= (size_t) virt
& PAGE_MASK
;
1458 entry
->dev_addr
= dma_addr
;
1459 entry
->direction
= DMA_BIDIRECTIONAL
;
1461 add_dma_entry(entry
);
1463 EXPORT_SYMBOL(debug_dma_alloc_coherent
);
1465 void debug_dma_free_coherent(struct device
*dev
, size_t size
,
1466 void *virt
, dma_addr_t addr
)
1468 struct dma_debug_entry ref
= {
1469 .type
= dma_debug_coherent
,
1471 .pfn
= page_to_pfn(virt_to_page(virt
)),
1472 .offset
= (size_t) virt
& PAGE_MASK
,
1475 .direction
= DMA_BIDIRECTIONAL
,
1478 if (unlikely(dma_debug_disabled()))
1483 EXPORT_SYMBOL(debug_dma_free_coherent
);
1485 void debug_dma_sync_single_for_cpu(struct device
*dev
, dma_addr_t dma_handle
,
1486 size_t size
, int direction
)
1488 struct dma_debug_entry ref
;
1490 if (unlikely(dma_debug_disabled()))
1493 ref
.type
= dma_debug_single
;
1495 ref
.dev_addr
= dma_handle
;
1497 ref
.direction
= direction
;
1498 ref
.sg_call_ents
= 0;
1500 check_sync(dev
, &ref
, true);
1502 EXPORT_SYMBOL(debug_dma_sync_single_for_cpu
);
1504 void debug_dma_sync_single_for_device(struct device
*dev
,
1505 dma_addr_t dma_handle
, size_t size
,
1508 struct dma_debug_entry ref
;
1510 if (unlikely(dma_debug_disabled()))
1513 ref
.type
= dma_debug_single
;
1515 ref
.dev_addr
= dma_handle
;
1517 ref
.direction
= direction
;
1518 ref
.sg_call_ents
= 0;
1520 check_sync(dev
, &ref
, false);
1522 EXPORT_SYMBOL(debug_dma_sync_single_for_device
);
1524 void debug_dma_sync_single_range_for_cpu(struct device
*dev
,
1525 dma_addr_t dma_handle
,
1526 unsigned long offset
, size_t size
,
1529 struct dma_debug_entry ref
;
1531 if (unlikely(dma_debug_disabled()))
1534 ref
.type
= dma_debug_single
;
1536 ref
.dev_addr
= dma_handle
;
1537 ref
.size
= offset
+ size
;
1538 ref
.direction
= direction
;
1539 ref
.sg_call_ents
= 0;
1541 check_sync(dev
, &ref
, true);
1543 EXPORT_SYMBOL(debug_dma_sync_single_range_for_cpu
);
1545 void debug_dma_sync_single_range_for_device(struct device
*dev
,
1546 dma_addr_t dma_handle
,
1547 unsigned long offset
,
1548 size_t size
, int direction
)
1550 struct dma_debug_entry ref
;
1552 if (unlikely(dma_debug_disabled()))
1555 ref
.type
= dma_debug_single
;
1557 ref
.dev_addr
= dma_handle
;
1558 ref
.size
= offset
+ size
;
1559 ref
.direction
= direction
;
1560 ref
.sg_call_ents
= 0;
1562 check_sync(dev
, &ref
, false);
1564 EXPORT_SYMBOL(debug_dma_sync_single_range_for_device
);
1566 void debug_dma_sync_sg_for_cpu(struct device
*dev
, struct scatterlist
*sg
,
1567 int nelems
, int direction
)
1569 struct scatterlist
*s
;
1570 int mapped_ents
= 0, i
;
1572 if (unlikely(dma_debug_disabled()))
1575 for_each_sg(sg
, s
, nelems
, i
) {
1577 struct dma_debug_entry ref
= {
1578 .type
= dma_debug_sg
,
1580 .pfn
= page_to_pfn(sg_page(s
)),
1581 .offset
= s
->offset
,
1582 .dev_addr
= sg_dma_address(s
),
1583 .size
= sg_dma_len(s
),
1584 .direction
= direction
,
1585 .sg_call_ents
= nelems
,
1589 mapped_ents
= get_nr_mapped_entries(dev
, &ref
);
1591 if (i
>= mapped_ents
)
1594 check_sync(dev
, &ref
, true);
1597 EXPORT_SYMBOL(debug_dma_sync_sg_for_cpu
);
1599 void debug_dma_sync_sg_for_device(struct device
*dev
, struct scatterlist
*sg
,
1600 int nelems
, int direction
)
1602 struct scatterlist
*s
;
1603 int mapped_ents
= 0, i
;
1605 if (unlikely(dma_debug_disabled()))
1608 for_each_sg(sg
, s
, nelems
, i
) {
1610 struct dma_debug_entry ref
= {
1611 .type
= dma_debug_sg
,
1613 .pfn
= page_to_pfn(sg_page(s
)),
1614 .offset
= s
->offset
,
1615 .dev_addr
= sg_dma_address(s
),
1616 .size
= sg_dma_len(s
),
1617 .direction
= direction
,
1618 .sg_call_ents
= nelems
,
1621 mapped_ents
= get_nr_mapped_entries(dev
, &ref
);
1623 if (i
>= mapped_ents
)
1626 check_sync(dev
, &ref
, false);
1629 EXPORT_SYMBOL(debug_dma_sync_sg_for_device
);
1631 static int __init
dma_debug_driver_setup(char *str
)
1635 for (i
= 0; i
< NAME_MAX_LEN
- 1; ++i
, ++str
) {
1636 current_driver_name
[i
] = *str
;
1641 if (current_driver_name
[0])
1642 pr_info("DMA-API: enable driver filter for driver [%s]\n",
1643 current_driver_name
);
1648 __setup("dma_debug_driver=", dma_debug_driver_setup
);