blob: baafebabe3ac36799b8933cdd4d779ccba1da27f [file] [log] [blame]
Joerg Roedelf2f45e52009-01-09 12:19:52 +01001/*
2 * Copyright (C) 2008 Advanced Micro Devices, Inc.
3 *
4 * Author: Joerg Roedel <joerg.roedel@amd.com>
5 *
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.
9 *
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.
14 *
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
18 */
19
Joerg Roedel972aa452009-01-09 14:19:54 +010020#include <linux/scatterlist.h>
Joerg Roedel2d62ece2009-01-09 14:10:26 +010021#include <linux/dma-mapping.h>
David Woodhouse6c132d12009-01-19 16:52:39 +010022#include <linux/stacktrace.h>
Joerg Roedelf2f45e52009-01-09 12:19:52 +010023#include <linux/dma-debug.h>
Joerg Roedel30dfa902009-01-09 12:34:49 +010024#include <linux/spinlock.h>
Andy Lutomirskib4a0f532016-08-11 02:35:22 -070025#include <linux/vmalloc.h>
Joerg Roedel788dcfa2009-01-09 13:13:27 +010026#include <linux/debugfs.h>
Joerg Roedel8a6fc702009-05-22 21:23:13 +020027#include <linux/uaccess.h>
Paul Gortmaker23a7bfa2011-07-01 16:23:59 -040028#include <linux/export.h>
Joerg Roedel2d62ece2009-01-09 14:10:26 +010029#include <linux/device.h>
Joerg Roedelf2f45e52009-01-09 12:19:52 +010030#include <linux/types.h>
Joerg Roedel2d62ece2009-01-09 14:10:26 +010031#include <linux/sched.h>
Joerg Roedel8a6fc702009-05-22 21:23:13 +020032#include <linux/ctype.h>
Joerg Roedelf2f45e52009-01-09 12:19:52 +010033#include <linux/list.h>
Joerg Roedel6bf07872009-01-09 12:54:42 +010034#include <linux/slab.h>
Joerg Roedelf2f45e52009-01-09 12:19:52 +010035
Joerg Roedel2e34bde2009-03-16 16:51:55 +010036#include <asm/sections.h>
37
Joerg Roedel30dfa902009-01-09 12:34:49 +010038#define HASH_SIZE 1024ULL
39#define HASH_FN_SHIFT 13
40#define HASH_FN_MASK (HASH_SIZE - 1)
41
Joerg Roedelf2f45e52009-01-09 12:19:52 +010042enum {
43 dma_debug_single,
44 dma_debug_page,
45 dma_debug_sg,
46 dma_debug_coherent,
Niklas Söderlund0e74b342016-08-10 13:22:15 +020047 dma_debug_resource,
Joerg Roedelf2f45e52009-01-09 12:19:52 +010048};
49
Shuah Khan6c9c6d62012-10-08 11:08:06 -060050enum map_err_types {
51 MAP_ERR_CHECK_NOT_APPLICABLE,
52 MAP_ERR_NOT_CHECKED,
53 MAP_ERR_CHECKED,
54};
55
David Woodhouse6c132d12009-01-19 16:52:39 +010056#define DMA_DEBUG_STACKTRACE_ENTRIES 5
57
Dan Williams0abdd7a2014-01-21 15:48:12 -080058/**
59 * struct dma_debug_entry - track a dma_map* or dma_alloc_coherent mapping
60 * @list: node on pre-allocated free_entries list
61 * @dev: 'dev' argument to dma_map_{page|single|sg} or dma_alloc_coherent
62 * @type: single, page, sg, coherent
63 * @pfn: page frame of the start address
64 * @offset: offset of mapping relative to pfn
65 * @size: length of the mapping
66 * @direction: enum dma_data_direction
67 * @sg_call_ents: 'nents' from dma_map_sg
68 * @sg_mapped_ents: 'mapped_ents' from dma_map_sg
69 * @map_err_type: track whether dma_mapping_error() was checked
70 * @stacktrace: support backtraces when a violation is detected
71 */
Joerg Roedelf2f45e52009-01-09 12:19:52 +010072struct dma_debug_entry {
73 struct list_head list;
74 struct device *dev;
75 int type;
Dan Williams0abdd7a2014-01-21 15:48:12 -080076 unsigned long pfn;
77 size_t offset;
Joerg Roedelf2f45e52009-01-09 12:19:52 +010078 u64 dev_addr;
79 u64 size;
80 int direction;
81 int sg_call_ents;
82 int sg_mapped_ents;
Shuah Khan6c9c6d62012-10-08 11:08:06 -060083 enum map_err_types map_err_type;
David Woodhouse6c132d12009-01-19 16:52:39 +010084#ifdef CONFIG_STACKTRACE
85 struct stack_trace stacktrace;
86 unsigned long st_entries[DMA_DEBUG_STACKTRACE_ENTRIES];
87#endif
Joerg Roedelf2f45e52009-01-09 12:19:52 +010088};
89
Neil Hormanc6a21d02011-08-08 15:13:54 -040090typedef bool (*match_fn)(struct dma_debug_entry *, struct dma_debug_entry *);
91
Joerg Roedel30dfa902009-01-09 12:34:49 +010092struct hash_bucket {
93 struct list_head list;
94 spinlock_t lock;
Joerg Roedel2d62ece2009-01-09 14:10:26 +010095} ____cacheline_aligned_in_smp;
Joerg Roedel30dfa902009-01-09 12:34:49 +010096
97/* Hash list to save the allocated dma addresses */
98static struct hash_bucket dma_entry_hash[HASH_SIZE];
Joerg Roedel3b1e79e2009-01-09 12:42:46 +010099/* List of pre-allocated dma_debug_entry's */
100static LIST_HEAD(free_entries);
101/* Lock for the list above */
102static DEFINE_SPINLOCK(free_entries_lock);
103
104/* Global disable flag - will be set in case of an error */
Viresh Kumar621a5f72015-09-26 15:04:07 -0700105static bool global_disable __read_mostly;
Joerg Roedel3b1e79e2009-01-09 12:42:46 +0100106
Florian Fainelli2ce8e7e2014-12-10 15:41:25 -0800107/* Early initialization disable flag, set at the end of dma_debug_init */
108static bool dma_debug_initialized __read_mostly;
109
Florian Fainelli01ce18b2014-12-10 15:41:23 -0800110static inline bool dma_debug_disabled(void)
111{
Florian Fainelli2ce8e7e2014-12-10 15:41:25 -0800112 return global_disable || !dma_debug_initialized;
Florian Fainelli01ce18b2014-12-10 15:41:23 -0800113}
114
Joerg Roedel788dcfa2009-01-09 13:13:27 +0100115/* Global error count */
116static u32 error_count;
117
118/* Global error show enable*/
119static u32 show_all_errors __read_mostly;
120/* Number of errors to show */
121static u32 show_num_errors = 1;
122
Joerg Roedel3b1e79e2009-01-09 12:42:46 +0100123static u32 num_free_entries;
124static u32 min_free_entries;
FUJITA Tomonorie6a1a892009-04-15 18:22:41 +0900125static u32 nr_total_entries;
Joerg Roedel30dfa902009-01-09 12:34:49 +0100126
Joerg Roedel59d3daa2009-01-09 13:01:56 +0100127/* number of preallocated entries requested by kernel cmdline */
128static u32 req_entries;
129
Joerg Roedel788dcfa2009-01-09 13:13:27 +0100130/* debugfs dentry's for the stuff above */
131static struct dentry *dma_debug_dent __read_mostly;
132static struct dentry *global_disable_dent __read_mostly;
133static struct dentry *error_count_dent __read_mostly;
134static struct dentry *show_all_errors_dent __read_mostly;
135static struct dentry *show_num_errors_dent __read_mostly;
136static struct dentry *num_free_entries_dent __read_mostly;
137static struct dentry *min_free_entries_dent __read_mostly;
Joerg Roedel8a6fc702009-05-22 21:23:13 +0200138static struct dentry *filter_dent __read_mostly;
Joerg Roedel788dcfa2009-01-09 13:13:27 +0100139
Joerg Roedel2e507d82009-05-22 18:24:20 +0200140/* per-driver filter related state */
141
142#define NAME_MAX_LEN 64
143
144static char current_driver_name[NAME_MAX_LEN] __read_mostly;
145static struct device_driver *current_driver __read_mostly;
146
147static DEFINE_RWLOCK(driver_name_lock);
Joerg Roedel30dfa902009-01-09 12:34:49 +0100148
Shuah Khan6c9c6d62012-10-08 11:08:06 -0600149static const char *const maperr2str[] = {
150 [MAP_ERR_CHECK_NOT_APPLICABLE] = "dma map error check not applicable",
151 [MAP_ERR_NOT_CHECKED] = "dma map error not checked",
152 [MAP_ERR_CHECKED] = "dma map error checked",
153};
154
Niklas Söderlund0e74b342016-08-10 13:22:15 +0200155static const char *type2name[5] = { "single", "page",
156 "scather-gather", "coherent",
157 "resource" };
Joerg Roedel2d62ece2009-01-09 14:10:26 +0100158
159static const char *dir2name[4] = { "DMA_BIDIRECTIONAL", "DMA_TO_DEVICE",
160 "DMA_FROM_DEVICE", "DMA_NONE" };
161
162/*
163 * The access to some variables in this macro is racy. We can't use atomic_t
164 * here because all these variables are exported to debugfs. Some of them even
165 * writeable. This is also the reason why a lock won't help much. But anyway,
166 * the races are no big deal. Here is why:
167 *
168 * error_count: the addition is racy, but the worst thing that can happen is
169 * that we don't count some errors
170 * show_num_errors: the subtraction is racy. Also no big deal because in
171 * worst case this will result in one warning more in the
172 * system log than the user configured. This variable is
173 * writeable via debugfs.
174 */
David Woodhouse6c132d12009-01-19 16:52:39 +0100175static inline void dump_entry_trace(struct dma_debug_entry *entry)
176{
177#ifdef CONFIG_STACKTRACE
178 if (entry) {
Joerg Roedele7ed70e2009-06-08 15:39:24 +0200179 pr_warning("Mapped at:\n");
David Woodhouse6c132d12009-01-19 16:52:39 +0100180 print_stack_trace(&entry->stacktrace, 0);
181 }
182#endif
183}
184
Joerg Roedel2e507d82009-05-22 18:24:20 +0200185static bool driver_filter(struct device *dev)
186{
Joerg Roedel0bf84122009-06-08 15:53:46 +0200187 struct device_driver *drv;
188 unsigned long flags;
189 bool ret;
190
Joerg Roedel2e507d82009-05-22 18:24:20 +0200191 /* driver filter off */
192 if (likely(!current_driver_name[0]))
193 return true;
194
195 /* driver filter on and initialized */
Kyle McMartinec9c96e2009-08-19 21:17:08 -0400196 if (current_driver && dev && dev->driver == current_driver)
Joerg Roedel2e507d82009-05-22 18:24:20 +0200197 return true;
198
Kyle McMartinec9c96e2009-08-19 21:17:08 -0400199 /* driver filter on, but we can't filter on a NULL device... */
200 if (!dev)
201 return false;
202
Joerg Roedel0bf84122009-06-08 15:53:46 +0200203 if (current_driver || !current_driver_name[0])
204 return false;
205
Joerg Roedel2e507d82009-05-22 18:24:20 +0200206 /* driver filter on but not yet initialized */
Alan Sternf3ff9242012-01-24 13:35:24 -0500207 drv = dev->driver;
Joerg Roedel0bf84122009-06-08 15:53:46 +0200208 if (!drv)
209 return false;
Joerg Roedel2e507d82009-05-22 18:24:20 +0200210
Joerg Roedel0bf84122009-06-08 15:53:46 +0200211 /* lock to protect against change of current_driver_name */
212 read_lock_irqsave(&driver_name_lock, flags);
Joerg Roedel2e507d82009-05-22 18:24:20 +0200213
Joerg Roedel0bf84122009-06-08 15:53:46 +0200214 ret = false;
215 if (drv->name &&
216 strncmp(current_driver_name, drv->name, NAME_MAX_LEN - 1) == 0) {
217 current_driver = drv;
218 ret = true;
Joerg Roedel2e507d82009-05-22 18:24:20 +0200219 }
220
Joerg Roedel0bf84122009-06-08 15:53:46 +0200221 read_unlock_irqrestore(&driver_name_lock, flags);
Joerg Roedel0bf84122009-06-08 15:53:46 +0200222
223 return ret;
Joerg Roedel2e507d82009-05-22 18:24:20 +0200224}
225
Kyle McMartinec9c96e2009-08-19 21:17:08 -0400226#define err_printk(dev, entry, format, arg...) do { \
227 error_count += 1; \
228 if (driver_filter(dev) && \
229 (show_all_errors || show_num_errors > 0)) { \
230 WARN(1, "%s %s: " format, \
231 dev ? dev_driver_string(dev) : "NULL", \
232 dev ? dev_name(dev) : "NULL", ## arg); \
233 dump_entry_trace(entry); \
234 } \
235 if (!show_all_errors && show_num_errors > 0) \
236 show_num_errors -= 1; \
Joerg Roedel2d62ece2009-01-09 14:10:26 +0100237 } while (0);
238
Joerg Roedel30dfa902009-01-09 12:34:49 +0100239/*
240 * Hash related functions
241 *
242 * Every DMA-API request is saved into a struct dma_debug_entry. To
243 * have quick access to these structs they are stored into a hash.
244 */
245static int hash_fn(struct dma_debug_entry *entry)
246{
247 /*
248 * Hash function is based on the dma address.
249 * We use bits 20-27 here as the index into the hash
250 */
251 return (entry->dev_addr >> HASH_FN_SHIFT) & HASH_FN_MASK;
252}
253
254/*
255 * Request exclusive access to a hash bucket for a given dma_debug_entry.
256 */
257static struct hash_bucket *get_hash_bucket(struct dma_debug_entry *entry,
258 unsigned long *flags)
Stephen Boydd5dfc802016-07-26 15:21:08 -0700259 __acquires(&dma_entry_hash[idx].lock)
Joerg Roedel30dfa902009-01-09 12:34:49 +0100260{
261 int idx = hash_fn(entry);
262 unsigned long __flags;
263
264 spin_lock_irqsave(&dma_entry_hash[idx].lock, __flags);
265 *flags = __flags;
266 return &dma_entry_hash[idx];
267}
268
269/*
270 * Give up exclusive access to the hash bucket
271 */
272static void put_hash_bucket(struct hash_bucket *bucket,
273 unsigned long *flags)
Stephen Boydd5dfc802016-07-26 15:21:08 -0700274 __releases(&bucket->lock)
Joerg Roedel30dfa902009-01-09 12:34:49 +0100275{
276 unsigned long __flags = *flags;
277
278 spin_unlock_irqrestore(&bucket->lock, __flags);
279}
280
Neil Hormanc6a21d02011-08-08 15:13:54 -0400281static bool exact_match(struct dma_debug_entry *a, struct dma_debug_entry *b)
282{
Thomas Jarosch91ec37c2011-11-17 20:31:02 +0100283 return ((a->dev_addr == b->dev_addr) &&
Neil Hormanc6a21d02011-08-08 15:13:54 -0400284 (a->dev == b->dev)) ? true : false;
285}
286
287static bool containing_match(struct dma_debug_entry *a,
288 struct dma_debug_entry *b)
289{
290 if (a->dev != b->dev)
291 return false;
292
293 if ((b->dev_addr <= a->dev_addr) &&
294 ((b->dev_addr + b->size) >= (a->dev_addr + a->size)))
295 return true;
296
297 return false;
298}
299
Joerg Roedel30dfa902009-01-09 12:34:49 +0100300/*
301 * Search a given entry in the hash bucket list
302 */
Neil Hormanc6a21d02011-08-08 15:13:54 -0400303static struct dma_debug_entry *__hash_bucket_find(struct hash_bucket *bucket,
304 struct dma_debug_entry *ref,
305 match_fn match)
Joerg Roedel30dfa902009-01-09 12:34:49 +0100306{
Joerg Roedel7caf6a42009-06-05 12:01:35 +0200307 struct dma_debug_entry *entry, *ret = NULL;
Ming Leife73fbe2012-10-19 13:57:01 -0700308 int matches = 0, match_lvl, last_lvl = -1;
Joerg Roedel30dfa902009-01-09 12:34:49 +0100309
310 list_for_each_entry(entry, &bucket->list, list) {
Neil Hormanc6a21d02011-08-08 15:13:54 -0400311 if (!match(ref, entry))
Joerg Roedel7caf6a42009-06-05 12:01:35 +0200312 continue;
313
314 /*
315 * Some drivers map the same physical address multiple
316 * times. Without a hardware IOMMU this results in the
317 * same device addresses being put into the dma-debug
318 * hash multiple times too. This can result in false
André Goddard Rosaaf901ca2009-11-14 13:09:05 -0200319 * positives being reported. Therefore we implement a
Joerg Roedel7caf6a42009-06-05 12:01:35 +0200320 * best-fit algorithm here which returns the entry from
321 * the hash which fits best to the reference value
322 * instead of the first-fit.
323 */
324 matches += 1;
325 match_lvl = 0;
Joerg Roedele5e8c5b2009-06-11 10:03:42 +0200326 entry->size == ref->size ? ++match_lvl : 0;
327 entry->type == ref->type ? ++match_lvl : 0;
328 entry->direction == ref->direction ? ++match_lvl : 0;
329 entry->sg_call_ents == ref->sg_call_ents ? ++match_lvl : 0;
Joerg Roedel7caf6a42009-06-05 12:01:35 +0200330
Joerg Roedele5e8c5b2009-06-11 10:03:42 +0200331 if (match_lvl == 4) {
Joerg Roedel7caf6a42009-06-05 12:01:35 +0200332 /* perfect-fit - return the result */
Joerg Roedel30dfa902009-01-09 12:34:49 +0100333 return entry;
Joerg Roedel7caf6a42009-06-05 12:01:35 +0200334 } else if (match_lvl > last_lvl) {
335 /*
336 * We found an entry that fits better then the
Ming Leife73fbe2012-10-19 13:57:01 -0700337 * previous one or it is the 1st match.
Joerg Roedel7caf6a42009-06-05 12:01:35 +0200338 */
339 last_lvl = match_lvl;
340 ret = entry;
341 }
Joerg Roedel30dfa902009-01-09 12:34:49 +0100342 }
343
Joerg Roedel7caf6a42009-06-05 12:01:35 +0200344 /*
345 * If we have multiple matches but no perfect-fit, just return
346 * NULL.
347 */
348 ret = (matches == 1) ? ret : NULL;
349
350 return ret;
Joerg Roedel30dfa902009-01-09 12:34:49 +0100351}
352
Neil Hormanc6a21d02011-08-08 15:13:54 -0400353static struct dma_debug_entry *bucket_find_exact(struct hash_bucket *bucket,
354 struct dma_debug_entry *ref)
355{
356 return __hash_bucket_find(bucket, ref, exact_match);
357}
358
359static struct dma_debug_entry *bucket_find_contain(struct hash_bucket **bucket,
360 struct dma_debug_entry *ref,
361 unsigned long *flags)
362{
363
364 unsigned int max_range = dma_get_max_seg_size(ref->dev);
365 struct dma_debug_entry *entry, index = *ref;
366 unsigned int range = 0;
367
368 while (range <= max_range) {
Sebastian Otta7a2c022015-04-16 12:43:25 -0700369 entry = __hash_bucket_find(*bucket, ref, containing_match);
Neil Hormanc6a21d02011-08-08 15:13:54 -0400370
371 if (entry)
372 return entry;
373
374 /*
375 * Nothing found, go back a hash bucket
376 */
377 put_hash_bucket(*bucket, flags);
378 range += (1 << HASH_FN_SHIFT);
379 index.dev_addr -= (1 << HASH_FN_SHIFT);
380 *bucket = get_hash_bucket(&index, flags);
381 }
382
383 return NULL;
384}
385
Joerg Roedel30dfa902009-01-09 12:34:49 +0100386/*
387 * Add an entry to a hash bucket
388 */
389static void hash_bucket_add(struct hash_bucket *bucket,
390 struct dma_debug_entry *entry)
391{
392 list_add_tail(&entry->list, &bucket->list);
393}
394
395/*
396 * Remove entry from a hash bucket list
397 */
398static void hash_bucket_del(struct dma_debug_entry *entry)
399{
400 list_del(&entry->list);
401}
402
Dan Williams0abdd7a2014-01-21 15:48:12 -0800403static unsigned long long phys_addr(struct dma_debug_entry *entry)
404{
Niklas Söderlund0e74b342016-08-10 13:22:15 +0200405 if (entry->type == dma_debug_resource)
406 return __pfn_to_phys(entry->pfn) + entry->offset;
407
Dan Williams0abdd7a2014-01-21 15:48:12 -0800408 return page_to_phys(pfn_to_page(entry->pfn)) + entry->offset;
409}
410
Joerg Roedel30dfa902009-01-09 12:34:49 +0100411/*
David Woodhouseac26c182009-02-12 16:19:13 +0100412 * Dump mapping entries for debugging purposes
413 */
414void debug_dma_dump_mappings(struct device *dev)
415{
416 int idx;
417
418 for (idx = 0; idx < HASH_SIZE; idx++) {
419 struct hash_bucket *bucket = &dma_entry_hash[idx];
420 struct dma_debug_entry *entry;
421 unsigned long flags;
422
423 spin_lock_irqsave(&bucket->lock, flags);
424
425 list_for_each_entry(entry, &bucket->list, list) {
426 if (!dev || dev == entry->dev) {
427 dev_info(entry->dev,
Dan Williams0abdd7a2014-01-21 15:48:12 -0800428 "%s idx %d P=%Lx N=%lx D=%Lx L=%Lx %s %s\n",
David Woodhouseac26c182009-02-12 16:19:13 +0100429 type2name[entry->type], idx,
Dan Williams0abdd7a2014-01-21 15:48:12 -0800430 phys_addr(entry), entry->pfn,
David Woodhouseac26c182009-02-12 16:19:13 +0100431 entry->dev_addr, entry->size,
Shuah Khan6c9c6d62012-10-08 11:08:06 -0600432 dir2name[entry->direction],
433 maperr2str[entry->map_err_type]);
David Woodhouseac26c182009-02-12 16:19:13 +0100434 }
435 }
436
437 spin_unlock_irqrestore(&bucket->lock, flags);
Eric Dumazetbbed8ff2019-10-28 14:56:46 -0700438 cond_resched();
David Woodhouseac26c182009-02-12 16:19:13 +0100439 }
440}
441EXPORT_SYMBOL(debug_dma_dump_mappings);
442
443/*
Dan Williams3b7a6412014-03-03 15:38:21 -0800444 * For each mapping (initial cacheline in the case of
445 * dma_alloc_coherent/dma_map_page, initial cacheline in each page of a
446 * scatterlist, or the cacheline specified in dma_map_single) insert
447 * into this tree using the cacheline as the key. At
Dan Williams0abdd7a2014-01-21 15:48:12 -0800448 * dma_unmap_{single|sg|page} or dma_free_coherent delete the entry. If
Dan Williams3b7a6412014-03-03 15:38:21 -0800449 * the entry already exists at insertion time add a tag as a reference
Dan Williams0abdd7a2014-01-21 15:48:12 -0800450 * count for the overlapping mappings. For now, the overlap tracking
Dan Williams3b7a6412014-03-03 15:38:21 -0800451 * just ensures that 'unmaps' balance 'maps' before marking the
452 * cacheline idle, but we should also be flagging overlaps as an API
453 * violation.
Dan Williams0abdd7a2014-01-21 15:48:12 -0800454 *
455 * Memory usage is mostly constrained by the maximum number of available
456 * dma-debug entries in that we need a free dma_debug_entry before
Dan Williams3b7a6412014-03-03 15:38:21 -0800457 * inserting into the tree. In the case of dma_map_page and
458 * dma_alloc_coherent there is only one dma_debug_entry and one
459 * dma_active_cacheline entry to track per event. dma_map_sg(), on the
460 * other hand, consumes a single dma_debug_entry, but inserts 'nents'
461 * entries into the tree.
Dan Williams0abdd7a2014-01-21 15:48:12 -0800462 *
463 * At any time debug_dma_assert_idle() can be called to trigger a
Dan Williams3b7a6412014-03-03 15:38:21 -0800464 * warning if any cachelines in the given page are in the active set.
Dan Williams0abdd7a2014-01-21 15:48:12 -0800465 */
Mikulas Patockafb8067f2022-05-10 13:17:32 -0400466static RADIX_TREE(dma_active_cacheline, GFP_ATOMIC);
Dan Williams0abdd7a2014-01-21 15:48:12 -0800467static DEFINE_SPINLOCK(radix_lock);
Dan Williams3b7a6412014-03-03 15:38:21 -0800468#define ACTIVE_CACHELINE_MAX_OVERLAP ((1 << RADIX_TREE_MAX_TAGS) - 1)
469#define CACHELINE_PER_PAGE_SHIFT (PAGE_SHIFT - L1_CACHE_SHIFT)
470#define CACHELINES_PER_PAGE (1 << CACHELINE_PER_PAGE_SHIFT)
Dan Williams0abdd7a2014-01-21 15:48:12 -0800471
Dan Williams3b7a6412014-03-03 15:38:21 -0800472static phys_addr_t to_cacheline_number(struct dma_debug_entry *entry)
473{
474 return (entry->pfn << CACHELINE_PER_PAGE_SHIFT) +
475 (entry->offset >> L1_CACHE_SHIFT);
476}
477
478static int active_cacheline_read_overlap(phys_addr_t cln)
Dan Williams0abdd7a2014-01-21 15:48:12 -0800479{
480 int overlap = 0, i;
481
482 for (i = RADIX_TREE_MAX_TAGS - 1; i >= 0; i--)
Dan Williams3b7a6412014-03-03 15:38:21 -0800483 if (radix_tree_tag_get(&dma_active_cacheline, cln, i))
Dan Williams0abdd7a2014-01-21 15:48:12 -0800484 overlap |= 1 << i;
485 return overlap;
486}
487
Dan Williams3b7a6412014-03-03 15:38:21 -0800488static int active_cacheline_set_overlap(phys_addr_t cln, int overlap)
Dan Williams0abdd7a2014-01-21 15:48:12 -0800489{
490 int i;
491
Dan Williams3b7a6412014-03-03 15:38:21 -0800492 if (overlap > ACTIVE_CACHELINE_MAX_OVERLAP || overlap < 0)
Dan Williams59f2e7d2014-01-29 14:05:53 -0800493 return overlap;
Dan Williams0abdd7a2014-01-21 15:48:12 -0800494
495 for (i = RADIX_TREE_MAX_TAGS - 1; i >= 0; i--)
496 if (overlap & 1 << i)
Dan Williams3b7a6412014-03-03 15:38:21 -0800497 radix_tree_tag_set(&dma_active_cacheline, cln, i);
Dan Williams0abdd7a2014-01-21 15:48:12 -0800498 else
Dan Williams3b7a6412014-03-03 15:38:21 -0800499 radix_tree_tag_clear(&dma_active_cacheline, cln, i);
Dan Williams0abdd7a2014-01-21 15:48:12 -0800500
501 return overlap;
502}
503
Dan Williams3b7a6412014-03-03 15:38:21 -0800504static void active_cacheline_inc_overlap(phys_addr_t cln)
Dan Williams0abdd7a2014-01-21 15:48:12 -0800505{
Dan Williams3b7a6412014-03-03 15:38:21 -0800506 int overlap = active_cacheline_read_overlap(cln);
Dan Williams0abdd7a2014-01-21 15:48:12 -0800507
Dan Williams3b7a6412014-03-03 15:38:21 -0800508 overlap = active_cacheline_set_overlap(cln, ++overlap);
Dan Williams0abdd7a2014-01-21 15:48:12 -0800509
510 /* If we overflowed the overlap counter then we're potentially
511 * leaking dma-mappings. Otherwise, if maps and unmaps are
512 * balanced then this overflow may cause false negatives in
Dan Williams3b7a6412014-03-03 15:38:21 -0800513 * debug_dma_assert_idle() as the cacheline may be marked idle
Dan Williams0abdd7a2014-01-21 15:48:12 -0800514 * prematurely.
515 */
Dan Williams3b7a6412014-03-03 15:38:21 -0800516 WARN_ONCE(overlap > ACTIVE_CACHELINE_MAX_OVERLAP,
517 "DMA-API: exceeded %d overlapping mappings of cacheline %pa\n",
518 ACTIVE_CACHELINE_MAX_OVERLAP, &cln);
Dan Williams0abdd7a2014-01-21 15:48:12 -0800519}
520
Dan Williams3b7a6412014-03-03 15:38:21 -0800521static int active_cacheline_dec_overlap(phys_addr_t cln)
Dan Williams0abdd7a2014-01-21 15:48:12 -0800522{
Dan Williams3b7a6412014-03-03 15:38:21 -0800523 int overlap = active_cacheline_read_overlap(cln);
Dan Williams0abdd7a2014-01-21 15:48:12 -0800524
Dan Williams3b7a6412014-03-03 15:38:21 -0800525 return active_cacheline_set_overlap(cln, --overlap);
Dan Williams0abdd7a2014-01-21 15:48:12 -0800526}
527
Dan Williams3b7a6412014-03-03 15:38:21 -0800528static int active_cacheline_insert(struct dma_debug_entry *entry)
Dan Williams0abdd7a2014-01-21 15:48:12 -0800529{
Dan Williams3b7a6412014-03-03 15:38:21 -0800530 phys_addr_t cln = to_cacheline_number(entry);
Dan Williams0abdd7a2014-01-21 15:48:12 -0800531 unsigned long flags;
532 int rc;
533
Dan Williams3b7a6412014-03-03 15:38:21 -0800534 /* If the device is not writing memory then we don't have any
535 * concerns about the cpu consuming stale data. This mitigates
536 * legitimate usages of overlapping mappings.
537 */
538 if (entry->direction == DMA_TO_DEVICE)
539 return 0;
540
Dan Williams0abdd7a2014-01-21 15:48:12 -0800541 spin_lock_irqsave(&radix_lock, flags);
Dan Williams3b7a6412014-03-03 15:38:21 -0800542 rc = radix_tree_insert(&dma_active_cacheline, cln, entry);
Dan Williams0abdd7a2014-01-21 15:48:12 -0800543 if (rc == -EEXIST)
Dan Williams3b7a6412014-03-03 15:38:21 -0800544 active_cacheline_inc_overlap(cln);
Dan Williams0abdd7a2014-01-21 15:48:12 -0800545 spin_unlock_irqrestore(&radix_lock, flags);
546
547 return rc;
548}
549
Dan Williams3b7a6412014-03-03 15:38:21 -0800550static void active_cacheline_remove(struct dma_debug_entry *entry)
Dan Williams0abdd7a2014-01-21 15:48:12 -0800551{
Dan Williams3b7a6412014-03-03 15:38:21 -0800552 phys_addr_t cln = to_cacheline_number(entry);
Dan Williams0abdd7a2014-01-21 15:48:12 -0800553 unsigned long flags;
554
Dan Williams3b7a6412014-03-03 15:38:21 -0800555 /* ...mirror the insert case */
556 if (entry->direction == DMA_TO_DEVICE)
557 return;
558
Dan Williams0abdd7a2014-01-21 15:48:12 -0800559 spin_lock_irqsave(&radix_lock, flags);
Dan Williams59f2e7d2014-01-29 14:05:53 -0800560 /* since we are counting overlaps the final put of the
Dan Williams3b7a6412014-03-03 15:38:21 -0800561 * cacheline will occur when the overlap count is 0.
562 * active_cacheline_dec_overlap() returns -1 in that case
Dan Williams59f2e7d2014-01-29 14:05:53 -0800563 */
Dan Williams3b7a6412014-03-03 15:38:21 -0800564 if (active_cacheline_dec_overlap(cln) < 0)
565 radix_tree_delete(&dma_active_cacheline, cln);
Dan Williams0abdd7a2014-01-21 15:48:12 -0800566 spin_unlock_irqrestore(&radix_lock, flags);
567}
568
569/**
570 * debug_dma_assert_idle() - assert that a page is not undergoing dma
Dan Williams3b7a6412014-03-03 15:38:21 -0800571 * @page: page to lookup in the dma_active_cacheline tree
Dan Williams0abdd7a2014-01-21 15:48:12 -0800572 *
573 * Place a call to this routine in cases where the cpu touching the page
574 * before the dma completes (page is dma_unmapped) will lead to data
575 * corruption.
576 */
577void debug_dma_assert_idle(struct page *page)
578{
Dan Williams3b7a6412014-03-03 15:38:21 -0800579 static struct dma_debug_entry *ents[CACHELINES_PER_PAGE];
580 struct dma_debug_entry *entry = NULL;
581 void **results = (void **) &ents;
582 unsigned int nents, i;
Dan Williams0abdd7a2014-01-21 15:48:12 -0800583 unsigned long flags;
Dan Williams3b7a6412014-03-03 15:38:21 -0800584 phys_addr_t cln;
Dan Williams0abdd7a2014-01-21 15:48:12 -0800585
Haggai Eranc9d120b2015-07-17 16:24:06 -0700586 if (dma_debug_disabled())
587 return;
588
Dan Williams0abdd7a2014-01-21 15:48:12 -0800589 if (!page)
590 return;
591
Dan Williams3b7a6412014-03-03 15:38:21 -0800592 cln = (phys_addr_t) page_to_pfn(page) << CACHELINE_PER_PAGE_SHIFT;
Dan Williams0abdd7a2014-01-21 15:48:12 -0800593 spin_lock_irqsave(&radix_lock, flags);
Dan Williams3b7a6412014-03-03 15:38:21 -0800594 nents = radix_tree_gang_lookup(&dma_active_cacheline, results, cln,
595 CACHELINES_PER_PAGE);
596 for (i = 0; i < nents; i++) {
597 phys_addr_t ent_cln = to_cacheline_number(ents[i]);
598
599 if (ent_cln == cln) {
600 entry = ents[i];
601 break;
602 } else if (ent_cln >= cln + CACHELINES_PER_PAGE)
603 break;
604 }
Dan Williams0abdd7a2014-01-21 15:48:12 -0800605 spin_unlock_irqrestore(&radix_lock, flags);
606
607 if (!entry)
608 return;
609
Dan Williams3b7a6412014-03-03 15:38:21 -0800610 cln = to_cacheline_number(entry);
Dan Williams0abdd7a2014-01-21 15:48:12 -0800611 err_printk(entry->dev, entry,
Dan Williams3b7a6412014-03-03 15:38:21 -0800612 "DMA-API: cpu touching an active dma mapped cacheline [cln=%pa]\n",
613 &cln);
Dan Williams0abdd7a2014-01-21 15:48:12 -0800614}
615
616/*
Joerg Roedel30dfa902009-01-09 12:34:49 +0100617 * Wrapper function for adding an entry to the hash.
618 * This function takes care of locking itself.
619 */
620static void add_dma_entry(struct dma_debug_entry *entry)
621{
622 struct hash_bucket *bucket;
623 unsigned long flags;
Dan Williams0abdd7a2014-01-21 15:48:12 -0800624 int rc;
Joerg Roedel30dfa902009-01-09 12:34:49 +0100625
626 bucket = get_hash_bucket(entry, &flags);
627 hash_bucket_add(bucket, entry);
628 put_hash_bucket(bucket, &flags);
Dan Williams0abdd7a2014-01-21 15:48:12 -0800629
Dan Williams3b7a6412014-03-03 15:38:21 -0800630 rc = active_cacheline_insert(entry);
Dan Williams0abdd7a2014-01-21 15:48:12 -0800631 if (rc == -ENOMEM) {
Dan Williams3b7a6412014-03-03 15:38:21 -0800632 pr_err("DMA-API: cacheline tracking ENOMEM, dma-debug disabled\n");
Dan Williams0abdd7a2014-01-21 15:48:12 -0800633 global_disable = true;
634 }
635
636 /* TODO: report -EEXIST errors here as overlapping mappings are
637 * not supported by the DMA API
638 */
Joerg Roedel30dfa902009-01-09 12:34:49 +0100639}
640
FUJITA Tomonorie6a1a892009-04-15 18:22:41 +0900641static struct dma_debug_entry *__dma_entry_alloc(void)
642{
643 struct dma_debug_entry *entry;
644
645 entry = list_entry(free_entries.next, struct dma_debug_entry, list);
646 list_del(&entry->list);
647 memset(entry, 0, sizeof(*entry));
648
649 num_free_entries -= 1;
650 if (num_free_entries < min_free_entries)
651 min_free_entries = num_free_entries;
652
653 return entry;
654}
655
Joerg Roedel3b1e79e2009-01-09 12:42:46 +0100656/* struct dma_entry allocator
657 *
658 * The next two functions implement the allocator for
659 * struct dma_debug_entries.
660 */
661static struct dma_debug_entry *dma_entry_alloc(void)
662{
Jakub Kicinski29cdd4e2012-04-04 03:19:10 +0200663 struct dma_debug_entry *entry;
Joerg Roedel3b1e79e2009-01-09 12:42:46 +0100664 unsigned long flags;
665
666 spin_lock_irqsave(&free_entries_lock, flags);
667
668 if (list_empty(&free_entries)) {
Joerg Roedel3b1e79e2009-01-09 12:42:46 +0100669 global_disable = true;
Jakub Kicinski29cdd4e2012-04-04 03:19:10 +0200670 spin_unlock_irqrestore(&free_entries_lock, flags);
Ville Syrjälä3017cd62016-05-26 15:16:25 -0700671 pr_err("DMA-API: debugging out of memory - disabling\n");
Jakub Kicinski29cdd4e2012-04-04 03:19:10 +0200672 return NULL;
Joerg Roedel3b1e79e2009-01-09 12:42:46 +0100673 }
674
FUJITA Tomonorie6a1a892009-04-15 18:22:41 +0900675 entry = __dma_entry_alloc();
Joerg Roedel3b1e79e2009-01-09 12:42:46 +0100676
Jakub Kicinski29cdd4e2012-04-04 03:19:10 +0200677 spin_unlock_irqrestore(&free_entries_lock, flags);
678
David Woodhouse6c132d12009-01-19 16:52:39 +0100679#ifdef CONFIG_STACKTRACE
680 entry->stacktrace.max_entries = DMA_DEBUG_STACKTRACE_ENTRIES;
681 entry->stacktrace.entries = entry->st_entries;
682 entry->stacktrace.skip = 2;
683 save_stack_trace(&entry->stacktrace);
684#endif
Joerg Roedel3b1e79e2009-01-09 12:42:46 +0100685
Joerg Roedel3b1e79e2009-01-09 12:42:46 +0100686 return entry;
687}
688
689static void dma_entry_free(struct dma_debug_entry *entry)
690{
691 unsigned long flags;
692
Dan Williams3b7a6412014-03-03 15:38:21 -0800693 active_cacheline_remove(entry);
Dan Williams0abdd7a2014-01-21 15:48:12 -0800694
Joerg Roedel3b1e79e2009-01-09 12:42:46 +0100695 /*
696 * add to beginning of the list - this way the entries are
697 * more likely cache hot when they are reallocated.
698 */
699 spin_lock_irqsave(&free_entries_lock, flags);
700 list_add(&entry->list, &free_entries);
701 num_free_entries += 1;
702 spin_unlock_irqrestore(&free_entries_lock, flags);
703}
704
FUJITA Tomonorie6a1a892009-04-15 18:22:41 +0900705int dma_debug_resize_entries(u32 num_entries)
706{
707 int i, delta, ret = 0;
708 unsigned long flags;
709 struct dma_debug_entry *entry;
710 LIST_HEAD(tmp);
711
712 spin_lock_irqsave(&free_entries_lock, flags);
713
714 if (nr_total_entries < num_entries) {
715 delta = num_entries - nr_total_entries;
716
717 spin_unlock_irqrestore(&free_entries_lock, flags);
718
719 for (i = 0; i < delta; i++) {
720 entry = kzalloc(sizeof(*entry), GFP_KERNEL);
721 if (!entry)
722 break;
723
724 list_add_tail(&entry->list, &tmp);
725 }
726
727 spin_lock_irqsave(&free_entries_lock, flags);
728
729 list_splice(&tmp, &free_entries);
730 nr_total_entries += i;
731 num_free_entries += i;
732 } else {
733 delta = nr_total_entries - num_entries;
734
735 for (i = 0; i < delta && !list_empty(&free_entries); i++) {
736 entry = __dma_entry_alloc();
737 kfree(entry);
738 }
739
740 nr_total_entries -= i;
741 }
742
743 if (nr_total_entries != num_entries)
744 ret = 1;
745
746 spin_unlock_irqrestore(&free_entries_lock, flags);
747
748 return ret;
749}
750EXPORT_SYMBOL(dma_debug_resize_entries);
751
Joerg Roedel6bf07872009-01-09 12:54:42 +0100752/*
753 * DMA-API debugging init code
754 *
755 * The init code does two things:
756 * 1. Initialize core data structures
757 * 2. Preallocate a given number of dma_debug_entry structs
758 */
759
760static int prealloc_memory(u32 num_entries)
761{
762 struct dma_debug_entry *entry, *next_entry;
763 int i;
764
765 for (i = 0; i < num_entries; ++i) {
766 entry = kzalloc(sizeof(*entry), GFP_KERNEL);
767 if (!entry)
768 goto out_err;
769
770 list_add_tail(&entry->list, &free_entries);
771 }
772
773 num_free_entries = num_entries;
774 min_free_entries = num_entries;
775
Joerg Roedele7ed70e2009-06-08 15:39:24 +0200776 pr_info("DMA-API: preallocated %d debug entries\n", num_entries);
Joerg Roedel6bf07872009-01-09 12:54:42 +0100777
778 return 0;
779
780out_err:
781
782 list_for_each_entry_safe(entry, next_entry, &free_entries, list) {
783 list_del(&entry->list);
784 kfree(entry);
785 }
786
787 return -ENOMEM;
788}
789
Joerg Roedel8a6fc702009-05-22 21:23:13 +0200790static ssize_t filter_read(struct file *file, char __user *user_buf,
791 size_t count, loff_t *ppos)
792{
Joerg Roedel8a6fc702009-05-22 21:23:13 +0200793 char buf[NAME_MAX_LEN + 1];
Joerg Roedelc17e2cf2009-06-08 15:19:29 +0200794 unsigned long flags;
Joerg Roedel8a6fc702009-05-22 21:23:13 +0200795 int len;
796
797 if (!current_driver_name[0])
798 return 0;
799
800 /*
801 * We can't copy to userspace directly because current_driver_name can
802 * only be read under the driver_name_lock with irqs disabled. So
803 * create a temporary copy first.
804 */
805 read_lock_irqsave(&driver_name_lock, flags);
806 len = scnprintf(buf, NAME_MAX_LEN + 1, "%s\n", current_driver_name);
807 read_unlock_irqrestore(&driver_name_lock, flags);
808
809 return simple_read_from_buffer(user_buf, count, ppos, buf, len);
810}
811
812static ssize_t filter_write(struct file *file, const char __user *userbuf,
813 size_t count, loff_t *ppos)
814{
Joerg Roedel8a6fc702009-05-22 21:23:13 +0200815 char buf[NAME_MAX_LEN];
Joerg Roedelc17e2cf2009-06-08 15:19:29 +0200816 unsigned long flags;
817 size_t len;
Joerg Roedel8a6fc702009-05-22 21:23:13 +0200818 int i;
819
820 /*
821 * We can't copy from userspace directly. Access to
822 * current_driver_name is protected with a write_lock with irqs
823 * disabled. Since copy_from_user can fault and may sleep we
824 * need to copy to temporary buffer first
825 */
Joerg Roedele7ed70e2009-06-08 15:39:24 +0200826 len = min(count, (size_t)(NAME_MAX_LEN - 1));
Joerg Roedel8a6fc702009-05-22 21:23:13 +0200827 if (copy_from_user(buf, userbuf, len))
828 return -EFAULT;
829
830 buf[len] = 0;
831
832 write_lock_irqsave(&driver_name_lock, flags);
833
Joerg Roedel312325092009-06-08 15:07:08 +0200834 /*
835 * Now handle the string we got from userspace very carefully.
Joerg Roedel8a6fc702009-05-22 21:23:13 +0200836 * The rules are:
837 * - only use the first token we got
838 * - token delimiter is everything looking like a space
839 * character (' ', '\n', '\t' ...)
840 *
841 */
842 if (!isalnum(buf[0])) {
843 /*
Joerg Roedel312325092009-06-08 15:07:08 +0200844 * If the first character userspace gave us is not
Joerg Roedel8a6fc702009-05-22 21:23:13 +0200845 * alphanumerical then assume the filter should be
846 * switched off.
847 */
848 if (current_driver_name[0])
Joerg Roedele7ed70e2009-06-08 15:39:24 +0200849 pr_info("DMA-API: switching off dma-debug driver filter\n");
Joerg Roedel8a6fc702009-05-22 21:23:13 +0200850 current_driver_name[0] = 0;
851 current_driver = NULL;
852 goto out_unlock;
853 }
854
855 /*
856 * Now parse out the first token and use it as the name for the
857 * driver to filter for.
858 */
Dan Carpenter39a37ce2010-04-06 19:45:12 +0300859 for (i = 0; i < NAME_MAX_LEN - 1; ++i) {
Joerg Roedel8a6fc702009-05-22 21:23:13 +0200860 current_driver_name[i] = buf[i];
861 if (isspace(buf[i]) || buf[i] == ' ' || buf[i] == 0)
862 break;
863 }
864 current_driver_name[i] = 0;
865 current_driver = NULL;
866
Joerg Roedele7ed70e2009-06-08 15:39:24 +0200867 pr_info("DMA-API: enable driver filter for driver [%s]\n",
868 current_driver_name);
Joerg Roedel8a6fc702009-05-22 21:23:13 +0200869
870out_unlock:
871 write_unlock_irqrestore(&driver_name_lock, flags);
872
873 return count;
874}
875
Thiago Farinaaeb583d2010-01-18 18:57:33 -0500876static const struct file_operations filter_fops = {
Joerg Roedel8a6fc702009-05-22 21:23:13 +0200877 .read = filter_read,
878 .write = filter_write,
Arnd Bergmann6038f372010-08-15 18:52:59 +0200879 .llseek = default_llseek,
Joerg Roedel8a6fc702009-05-22 21:23:13 +0200880};
881
Joerg Roedel788dcfa2009-01-09 13:13:27 +0100882static int dma_debug_fs_init(void)
883{
884 dma_debug_dent = debugfs_create_dir("dma-api", NULL);
885 if (!dma_debug_dent) {
Joerg Roedele7ed70e2009-06-08 15:39:24 +0200886 pr_err("DMA-API: can not create debugfs directory\n");
Joerg Roedel788dcfa2009-01-09 13:13:27 +0100887 return -ENOMEM;
888 }
889
890 global_disable_dent = debugfs_create_bool("disabled", 0444,
891 dma_debug_dent,
Dan Carpenter68ee6d22012-06-27 12:08:55 +0300892 &global_disable);
Joerg Roedel788dcfa2009-01-09 13:13:27 +0100893 if (!global_disable_dent)
894 goto out_err;
895
896 error_count_dent = debugfs_create_u32("error_count", 0444,
897 dma_debug_dent, &error_count);
898 if (!error_count_dent)
899 goto out_err;
900
901 show_all_errors_dent = debugfs_create_u32("all_errors", 0644,
902 dma_debug_dent,
903 &show_all_errors);
904 if (!show_all_errors_dent)
905 goto out_err;
906
907 show_num_errors_dent = debugfs_create_u32("num_errors", 0644,
908 dma_debug_dent,
909 &show_num_errors);
910 if (!show_num_errors_dent)
911 goto out_err;
912
913 num_free_entries_dent = debugfs_create_u32("num_free_entries", 0444,
914 dma_debug_dent,
915 &num_free_entries);
916 if (!num_free_entries_dent)
917 goto out_err;
918
919 min_free_entries_dent = debugfs_create_u32("min_free_entries", 0444,
920 dma_debug_dent,
921 &min_free_entries);
922 if (!min_free_entries_dent)
923 goto out_err;
924
Joerg Roedel8a6fc702009-05-22 21:23:13 +0200925 filter_dent = debugfs_create_file("driver_filter", 0644,
926 dma_debug_dent, NULL, &filter_fops);
927 if (!filter_dent)
928 goto out_err;
929
Joerg Roedel788dcfa2009-01-09 13:13:27 +0100930 return 0;
931
932out_err:
933 debugfs_remove_recursive(dma_debug_dent);
934
935 return -ENOMEM;
936}
937
Stanislaw Gruszkaba4b87ad2011-03-31 08:08:09 -0400938static int device_dma_allocations(struct device *dev, struct dma_debug_entry **out_entry)
Joerg Roedeled888ae2009-05-22 17:16:04 +0200939{
940 struct dma_debug_entry *entry;
941 unsigned long flags;
942 int count = 0, i;
943
Joerg Roedelbe81c6e2009-06-08 15:46:19 +0200944 local_irq_save(flags);
945
Joerg Roedeled888ae2009-05-22 17:16:04 +0200946 for (i = 0; i < HASH_SIZE; ++i) {
Joerg Roedelbe81c6e2009-06-08 15:46:19 +0200947 spin_lock(&dma_entry_hash[i].lock);
Joerg Roedeled888ae2009-05-22 17:16:04 +0200948 list_for_each_entry(entry, &dma_entry_hash[i].list, list) {
Stanislaw Gruszkaba4b87ad2011-03-31 08:08:09 -0400949 if (entry->dev == dev) {
Joerg Roedeled888ae2009-05-22 17:16:04 +0200950 count += 1;
Stanislaw Gruszkaba4b87ad2011-03-31 08:08:09 -0400951 *out_entry = entry;
952 }
Joerg Roedeled888ae2009-05-22 17:16:04 +0200953 }
Joerg Roedelbe81c6e2009-06-08 15:46:19 +0200954 spin_unlock(&dma_entry_hash[i].lock);
Joerg Roedeled888ae2009-05-22 17:16:04 +0200955 }
956
Joerg Roedelbe81c6e2009-06-08 15:46:19 +0200957 local_irq_restore(flags);
958
Joerg Roedeled888ae2009-05-22 17:16:04 +0200959 return count;
960}
961
Ingo Molnara8fe9ea2009-12-31 15:16:23 +0100962static int dma_debug_device_change(struct notifier_block *nb, unsigned long action, void *data)
Joerg Roedeled888ae2009-05-22 17:16:04 +0200963{
964 struct device *dev = data;
Stanislaw Gruszkaba4b87ad2011-03-31 08:08:09 -0400965 struct dma_debug_entry *uninitialized_var(entry);
Joerg Roedeled888ae2009-05-22 17:16:04 +0200966 int count;
967
Florian Fainelli01ce18b2014-12-10 15:41:23 -0800968 if (dma_debug_disabled())
Ingo Molnara8fe9ea2009-12-31 15:16:23 +0100969 return 0;
Joerg Roedeled888ae2009-05-22 17:16:04 +0200970
971 switch (action) {
972 case BUS_NOTIFY_UNBOUND_DRIVER:
Stanislaw Gruszkaba4b87ad2011-03-31 08:08:09 -0400973 count = device_dma_allocations(dev, &entry);
Joerg Roedeled888ae2009-05-22 17:16:04 +0200974 if (count == 0)
975 break;
Stanislaw Gruszkaba4b87ad2011-03-31 08:08:09 -0400976 err_printk(dev, entry, "DMA-API: device driver has pending "
Joerg Roedeled888ae2009-05-22 17:16:04 +0200977 "DMA allocations while released from device "
Stanislaw Gruszkaba4b87ad2011-03-31 08:08:09 -0400978 "[count=%d]\n"
979 "One of leaked entries details: "
980 "[device address=0x%016llx] [size=%llu bytes] "
981 "[mapped with %s] [mapped as %s]\n",
982 count, entry->dev_addr, entry->size,
983 dir2name[entry->direction], type2name[entry->type]);
Joerg Roedeled888ae2009-05-22 17:16:04 +0200984 break;
985 default:
986 break;
987 }
988
989 return 0;
990}
991
Joerg Roedel41531c82009-03-16 17:32:14 +0100992void dma_debug_add_bus(struct bus_type *bus)
993{
Joerg Roedeled888ae2009-05-22 17:16:04 +0200994 struct notifier_block *nb;
995
Florian Fainelli01ce18b2014-12-10 15:41:23 -0800996 if (dma_debug_disabled())
Shaun Ruffellf797d982009-12-17 18:00:36 -0600997 return;
998
Joerg Roedeled888ae2009-05-22 17:16:04 +0200999 nb = kzalloc(sizeof(struct notifier_block), GFP_KERNEL);
1000 if (nb == NULL) {
Joerg Roedele7ed70e2009-06-08 15:39:24 +02001001 pr_err("dma_debug_add_bus: out of memory\n");
Joerg Roedeled888ae2009-05-22 17:16:04 +02001002 return;
1003 }
1004
1005 nb->notifier_call = dma_debug_device_change;
1006
1007 bus_register_notifier(bus, nb);
Joerg Roedel41531c82009-03-16 17:32:14 +01001008}
Joerg Roedel788dcfa2009-01-09 13:13:27 +01001009
Joerg Roedel6bf07872009-01-09 12:54:42 +01001010/*
1011 * Let the architectures decide how many entries should be preallocated.
1012 */
1013void dma_debug_init(u32 num_entries)
1014{
1015 int i;
1016
Florian Fainelli2ce8e7e2014-12-10 15:41:25 -08001017 /* Do not use dma_debug_initialized here, since we really want to be
1018 * called to set dma_debug_initialized
1019 */
1020 if (global_disable)
Joerg Roedel6bf07872009-01-09 12:54:42 +01001021 return;
1022
1023 for (i = 0; i < HASH_SIZE; ++i) {
1024 INIT_LIST_HEAD(&dma_entry_hash[i].list);
Ingo Molnarb0a5b832009-06-16 16:11:14 +02001025 spin_lock_init(&dma_entry_hash[i].lock);
Joerg Roedel6bf07872009-01-09 12:54:42 +01001026 }
1027
Joerg Roedel788dcfa2009-01-09 13:13:27 +01001028 if (dma_debug_fs_init() != 0) {
Joerg Roedele7ed70e2009-06-08 15:39:24 +02001029 pr_err("DMA-API: error creating debugfs entries - disabling\n");
Joerg Roedel788dcfa2009-01-09 13:13:27 +01001030 global_disable = true;
1031
1032 return;
1033 }
1034
Joerg Roedel59d3daa2009-01-09 13:01:56 +01001035 if (req_entries)
1036 num_entries = req_entries;
1037
Joerg Roedel6bf07872009-01-09 12:54:42 +01001038 if (prealloc_memory(num_entries) != 0) {
Joerg Roedele7ed70e2009-06-08 15:39:24 +02001039 pr_err("DMA-API: debugging out of memory error - disabled\n");
Joerg Roedel6bf07872009-01-09 12:54:42 +01001040 global_disable = true;
1041
1042 return;
1043 }
1044
FUJITA Tomonorie6a1a892009-04-15 18:22:41 +09001045 nr_total_entries = num_free_entries;
1046
Florian Fainelli2ce8e7e2014-12-10 15:41:25 -08001047 dma_debug_initialized = true;
1048
Joerg Roedele7ed70e2009-06-08 15:39:24 +02001049 pr_info("DMA-API: debugging enabled by kernel config\n");
Joerg Roedel6bf07872009-01-09 12:54:42 +01001050}
1051
Joerg Roedel59d3daa2009-01-09 13:01:56 +01001052static __init int dma_debug_cmdline(char *str)
1053{
1054 if (!str)
1055 return -EINVAL;
1056
1057 if (strncmp(str, "off", 3) == 0) {
Joerg Roedele7ed70e2009-06-08 15:39:24 +02001058 pr_info("DMA-API: debugging disabled on kernel command line\n");
Joerg Roedel59d3daa2009-01-09 13:01:56 +01001059 global_disable = true;
1060 }
1061
1062 return 0;
1063}
1064
1065static __init int dma_debug_entries_cmdline(char *str)
1066{
1067 int res;
1068
1069 if (!str)
1070 return -EINVAL;
1071
1072 res = get_option(&str, &req_entries);
1073
1074 if (!res)
1075 req_entries = 0;
1076
1077 return 0;
1078}
1079
1080__setup("dma_debug=", dma_debug_cmdline);
1081__setup("dma_debug_entries=", dma_debug_entries_cmdline);
1082
Joerg Roedel2d62ece2009-01-09 14:10:26 +01001083static void check_unmap(struct dma_debug_entry *ref)
1084{
1085 struct dma_debug_entry *entry;
1086 struct hash_bucket *bucket;
1087 unsigned long flags;
1088
Joerg Roedel2d62ece2009-01-09 14:10:26 +01001089 bucket = get_hash_bucket(ref, &flags);
Neil Hormanc6a21d02011-08-08 15:13:54 -04001090 entry = bucket_find_exact(bucket, ref);
Joerg Roedel2d62ece2009-01-09 14:10:26 +01001091
1092 if (!entry) {
Alexander Duyck8d640a52013-03-22 15:04:48 -07001093 /* must drop lock before calling dma_mapping_error */
1094 put_hash_bucket(bucket, &flags);
1095
Shuah Khanbfe0fb02012-11-03 17:00:07 -06001096 if (dma_mapping_error(ref->dev, ref->dev_addr)) {
1097 err_printk(ref->dev, NULL,
Alexander Duyck8d640a52013-03-22 15:04:48 -07001098 "DMA-API: device driver tries to free an "
1099 "invalid DMA memory address\n");
1100 } else {
1101 err_printk(ref->dev, NULL,
1102 "DMA-API: device driver tries to free DMA "
1103 "memory it has not allocated [device "
1104 "address=0x%016llx] [size=%llu bytes]\n",
1105 ref->dev_addr, ref->size);
Shuah Khanbfe0fb02012-11-03 17:00:07 -06001106 }
Alexander Duyck8d640a52013-03-22 15:04:48 -07001107 return;
Joerg Roedel2d62ece2009-01-09 14:10:26 +01001108 }
1109
1110 if (ref->size != entry->size) {
David Woodhouse6c132d12009-01-19 16:52:39 +01001111 err_printk(ref->dev, entry, "DMA-API: device driver frees "
Joerg Roedel2d62ece2009-01-09 14:10:26 +01001112 "DMA memory with different size "
1113 "[device address=0x%016llx] [map size=%llu bytes] "
1114 "[unmap size=%llu bytes]\n",
1115 ref->dev_addr, entry->size, ref->size);
1116 }
1117
1118 if (ref->type != entry->type) {
David Woodhouse6c132d12009-01-19 16:52:39 +01001119 err_printk(ref->dev, entry, "DMA-API: device driver frees "
Joerg Roedel2d62ece2009-01-09 14:10:26 +01001120 "DMA memory with wrong function "
1121 "[device address=0x%016llx] [size=%llu bytes] "
1122 "[mapped as %s] [unmapped as %s]\n",
1123 ref->dev_addr, ref->size,
1124 type2name[entry->type], type2name[ref->type]);
1125 } else if ((entry->type == dma_debug_coherent) &&
Dan Williams0abdd7a2014-01-21 15:48:12 -08001126 (phys_addr(ref) != phys_addr(entry))) {
David Woodhouse6c132d12009-01-19 16:52:39 +01001127 err_printk(ref->dev, entry, "DMA-API: device driver frees "
Joerg Roedel2d62ece2009-01-09 14:10:26 +01001128 "DMA memory with different CPU address "
1129 "[device address=0x%016llx] [size=%llu bytes] "
Joerg Roedel59a40e702009-10-29 16:25:50 +01001130 "[cpu alloc address=0x%016llx] "
1131 "[cpu free address=0x%016llx]",
Joerg Roedel2d62ece2009-01-09 14:10:26 +01001132 ref->dev_addr, ref->size,
Dan Williams0abdd7a2014-01-21 15:48:12 -08001133 phys_addr(entry),
1134 phys_addr(ref));
Joerg Roedel2d62ece2009-01-09 14:10:26 +01001135 }
1136
1137 if (ref->sg_call_ents && ref->type == dma_debug_sg &&
1138 ref->sg_call_ents != entry->sg_call_ents) {
David Woodhouse6c132d12009-01-19 16:52:39 +01001139 err_printk(ref->dev, entry, "DMA-API: device driver frees "
Joerg Roedel2d62ece2009-01-09 14:10:26 +01001140 "DMA sg list with different entry count "
1141 "[map count=%d] [unmap count=%d]\n",
1142 entry->sg_call_ents, ref->sg_call_ents);
1143 }
1144
1145 /*
1146 * This may be no bug in reality - but most implementations of the
1147 * DMA API don't handle this properly, so check for it here
1148 */
1149 if (ref->direction != entry->direction) {
David Woodhouse6c132d12009-01-19 16:52:39 +01001150 err_printk(ref->dev, entry, "DMA-API: device driver frees "
Joerg Roedel2d62ece2009-01-09 14:10:26 +01001151 "DMA memory with different direction "
1152 "[device address=0x%016llx] [size=%llu bytes] "
1153 "[mapped with %s] [unmapped with %s]\n",
1154 ref->dev_addr, ref->size,
1155 dir2name[entry->direction],
1156 dir2name[ref->direction]);
1157 }
1158
Shuah Khan6c9c6d62012-10-08 11:08:06 -06001159 if (entry->map_err_type == MAP_ERR_NOT_CHECKED) {
1160 err_printk(ref->dev, entry,
1161 "DMA-API: device driver failed to check map error"
1162 "[device address=0x%016llx] [size=%llu bytes] "
1163 "[mapped as %s]",
1164 ref->dev_addr, ref->size,
1165 type2name[entry->type]);
1166 }
1167
Joerg Roedel2d62ece2009-01-09 14:10:26 +01001168 hash_bucket_del(entry);
1169 dma_entry_free(entry);
1170
Joerg Roedel2d62ece2009-01-09 14:10:26 +01001171 put_hash_bucket(bucket, &flags);
1172}
1173
Andy Lutomirskib4a0f532016-08-11 02:35:22 -07001174static void check_for_stack(struct device *dev,
1175 struct page *page, size_t offset)
Joerg Roedel2d62ece2009-01-09 14:10:26 +01001176{
Andy Lutomirskib4a0f532016-08-11 02:35:22 -07001177 void *addr;
1178 struct vm_struct *stack_vm_area = task_stack_vm_area(current);
1179
1180 if (!stack_vm_area) {
1181 /* Stack is direct-mapped. */
1182 if (PageHighMem(page))
1183 return;
1184 addr = page_address(page) + offset;
1185 if (object_is_on_stack(addr))
1186 err_printk(dev, NULL, "DMA-API: device driver maps memory from stack [addr=%p]\n", addr);
1187 } else {
1188 /* Stack is vmalloced. */
1189 int i;
1190
1191 for (i = 0; i < stack_vm_area->nr_pages; i++) {
1192 if (page != stack_vm_area->pages[i])
1193 continue;
1194
1195 addr = (u8 *)current->stack + i * PAGE_SIZE + offset;
1196 err_printk(dev, NULL, "DMA-API: device driver maps memory from stack [probable addr=%p]\n", addr);
1197 break;
1198 }
1199 }
Joerg Roedel2d62ece2009-01-09 14:10:26 +01001200}
1201
Ingo Molnarf39d1b92009-07-10 21:38:02 +02001202static inline bool overlap(void *addr, unsigned long len, void *start, void *end)
Joerg Roedel2e34bde2009-03-16 16:51:55 +01001203{
Ingo Molnarf39d1b92009-07-10 21:38:02 +02001204 unsigned long a1 = (unsigned long)addr;
1205 unsigned long b1 = a1 + len;
1206 unsigned long a2 = (unsigned long)start;
1207 unsigned long b2 = (unsigned long)end;
Joerg Roedel2e34bde2009-03-16 16:51:55 +01001208
Ingo Molnarf39d1b92009-07-10 21:38:02 +02001209 return !(b1 <= a2 || a1 >= b2);
Joerg Roedel2e34bde2009-03-16 16:51:55 +01001210}
1211
Ingo Molnarf39d1b92009-07-10 21:38:02 +02001212static void check_for_illegal_area(struct device *dev, void *addr, unsigned long len)
Joerg Roedel2e34bde2009-03-16 16:51:55 +01001213{
Laura Abbottea535e42016-01-14 15:16:50 -08001214 if (overlap(addr, len, _stext, _etext) ||
Ingo Molnarf39d1b92009-07-10 21:38:02 +02001215 overlap(addr, len, __start_rodata, __end_rodata))
1216 err_printk(dev, NULL, "DMA-API: device driver maps memory from kernel text or rodata [addr=%p] [len=%lu]\n", addr, len);
Joerg Roedel2e34bde2009-03-16 16:51:55 +01001217}
1218
Joerg Roedelaa010ef2009-06-12 15:25:06 +02001219static void check_sync(struct device *dev,
1220 struct dma_debug_entry *ref,
1221 bool to_cpu)
Joerg Roedel2d62ece2009-01-09 14:10:26 +01001222{
Joerg Roedel2d62ece2009-01-09 14:10:26 +01001223 struct dma_debug_entry *entry;
1224 struct hash_bucket *bucket;
1225 unsigned long flags;
1226
Joerg Roedelaa010ef2009-06-12 15:25:06 +02001227 bucket = get_hash_bucket(ref, &flags);
Joerg Roedel2d62ece2009-01-09 14:10:26 +01001228
Neil Hormanc6a21d02011-08-08 15:13:54 -04001229 entry = bucket_find_contain(&bucket, ref, &flags);
Joerg Roedel2d62ece2009-01-09 14:10:26 +01001230
1231 if (!entry) {
David Woodhouse6c132d12009-01-19 16:52:39 +01001232 err_printk(dev, NULL, "DMA-API: device driver tries "
Joerg Roedel2d62ece2009-01-09 14:10:26 +01001233 "to sync DMA memory it has not allocated "
1234 "[device address=0x%016llx] [size=%llu bytes]\n",
Joerg Roedelaa010ef2009-06-12 15:25:06 +02001235 (unsigned long long)ref->dev_addr, ref->size);
Joerg Roedel2d62ece2009-01-09 14:10:26 +01001236 goto out;
1237 }
1238
Joerg Roedelaa010ef2009-06-12 15:25:06 +02001239 if (ref->size > entry->size) {
David Woodhouse6c132d12009-01-19 16:52:39 +01001240 err_printk(dev, entry, "DMA-API: device driver syncs"
Joerg Roedel2d62ece2009-01-09 14:10:26 +01001241 " DMA memory outside allocated range "
1242 "[device address=0x%016llx] "
Joerg Roedelaa010ef2009-06-12 15:25:06 +02001243 "[allocation size=%llu bytes] "
1244 "[sync offset+size=%llu]\n",
1245 entry->dev_addr, entry->size,
1246 ref->size);
Joerg Roedel2d62ece2009-01-09 14:10:26 +01001247 }
1248
Krzysztof Halasa42d53b42010-01-08 14:42:36 -08001249 if (entry->direction == DMA_BIDIRECTIONAL)
1250 goto out;
1251
Joerg Roedelaa010ef2009-06-12 15:25:06 +02001252 if (ref->direction != entry->direction) {
David Woodhouse6c132d12009-01-19 16:52:39 +01001253 err_printk(dev, entry, "DMA-API: device driver syncs "
Joerg Roedel2d62ece2009-01-09 14:10:26 +01001254 "DMA memory with different direction "
1255 "[device address=0x%016llx] [size=%llu bytes] "
1256 "[mapped with %s] [synced with %s]\n",
Joerg Roedelaa010ef2009-06-12 15:25:06 +02001257 (unsigned long long)ref->dev_addr, entry->size,
Joerg Roedel2d62ece2009-01-09 14:10:26 +01001258 dir2name[entry->direction],
Joerg Roedelaa010ef2009-06-12 15:25:06 +02001259 dir2name[ref->direction]);
Joerg Roedel2d62ece2009-01-09 14:10:26 +01001260 }
1261
Joerg Roedel2d62ece2009-01-09 14:10:26 +01001262 if (to_cpu && !(entry->direction == DMA_FROM_DEVICE) &&
Joerg Roedelaa010ef2009-06-12 15:25:06 +02001263 !(ref->direction == DMA_TO_DEVICE))
David Woodhouse6c132d12009-01-19 16:52:39 +01001264 err_printk(dev, entry, "DMA-API: device driver syncs "
Joerg Roedel2d62ece2009-01-09 14:10:26 +01001265 "device read-only DMA memory for cpu "
1266 "[device address=0x%016llx] [size=%llu bytes] "
1267 "[mapped with %s] [synced with %s]\n",
Joerg Roedelaa010ef2009-06-12 15:25:06 +02001268 (unsigned long long)ref->dev_addr, entry->size,
Joerg Roedel2d62ece2009-01-09 14:10:26 +01001269 dir2name[entry->direction],
Joerg Roedelaa010ef2009-06-12 15:25:06 +02001270 dir2name[ref->direction]);
Joerg Roedel2d62ece2009-01-09 14:10:26 +01001271
1272 if (!to_cpu && !(entry->direction == DMA_TO_DEVICE) &&
Joerg Roedelaa010ef2009-06-12 15:25:06 +02001273 !(ref->direction == DMA_FROM_DEVICE))
David Woodhouse6c132d12009-01-19 16:52:39 +01001274 err_printk(dev, entry, "DMA-API: device driver syncs "
Joerg Roedel2d62ece2009-01-09 14:10:26 +01001275 "device write-only DMA memory to device "
1276 "[device address=0x%016llx] [size=%llu bytes] "
1277 "[mapped with %s] [synced with %s]\n",
Joerg Roedelaa010ef2009-06-12 15:25:06 +02001278 (unsigned long long)ref->dev_addr, entry->size,
Joerg Roedel2d62ece2009-01-09 14:10:26 +01001279 dir2name[entry->direction],
Joerg Roedelaa010ef2009-06-12 15:25:06 +02001280 dir2name[ref->direction]);
Joerg Roedel2d62ece2009-01-09 14:10:26 +01001281
Robin Murphy7f830642015-11-06 16:32:55 -08001282 if (ref->sg_call_ents && ref->type == dma_debug_sg &&
1283 ref->sg_call_ents != entry->sg_call_ents) {
1284 err_printk(ref->dev, entry, "DMA-API: device driver syncs "
1285 "DMA sg list with different entry count "
1286 "[map count=%d] [sync count=%d]\n",
1287 entry->sg_call_ents, ref->sg_call_ents);
1288 }
1289
Joerg Roedel2d62ece2009-01-09 14:10:26 +01001290out:
1291 put_hash_bucket(bucket, &flags);
Joerg Roedel2d62ece2009-01-09 14:10:26 +01001292}
1293
Joerg Roedelf62bc982009-01-09 14:14:49 +01001294void debug_dma_map_page(struct device *dev, struct page *page, size_t offset,
1295 size_t size, int direction, dma_addr_t dma_addr,
1296 bool map_single)
1297{
1298 struct dma_debug_entry *entry;
1299
Florian Fainelli01ce18b2014-12-10 15:41:23 -08001300 if (unlikely(dma_debug_disabled()))
Joerg Roedelf62bc982009-01-09 14:14:49 +01001301 return;
1302
Shuah Khanbfe0fb02012-11-03 17:00:07 -06001303 if (dma_mapping_error(dev, dma_addr))
Joerg Roedelf62bc982009-01-09 14:14:49 +01001304 return;
1305
1306 entry = dma_entry_alloc();
1307 if (!entry)
1308 return;
1309
1310 entry->dev = dev;
1311 entry->type = dma_debug_page;
Dan Williams0abdd7a2014-01-21 15:48:12 -08001312 entry->pfn = page_to_pfn(page);
1313 entry->offset = offset,
Joerg Roedelf62bc982009-01-09 14:14:49 +01001314 entry->dev_addr = dma_addr;
1315 entry->size = size;
1316 entry->direction = direction;
Shuah Khan6c9c6d62012-10-08 11:08:06 -06001317 entry->map_err_type = MAP_ERR_NOT_CHECKED;
Joerg Roedelf62bc982009-01-09 14:14:49 +01001318
Joerg Roedel9537a482009-03-23 15:35:08 +01001319 if (map_single)
Joerg Roedelf62bc982009-01-09 14:14:49 +01001320 entry->type = dma_debug_single;
Joerg Roedel9537a482009-03-23 15:35:08 +01001321
Andy Lutomirskib4a0f532016-08-11 02:35:22 -07001322 check_for_stack(dev, page, offset);
1323
Joerg Roedel9537a482009-03-23 15:35:08 +01001324 if (!PageHighMem(page)) {
Ingo Molnarf39d1b92009-07-10 21:38:02 +02001325 void *addr = page_address(page) + offset;
1326
Joerg Roedel2e34bde2009-03-16 16:51:55 +01001327 check_for_illegal_area(dev, addr, size);
Joerg Roedelf62bc982009-01-09 14:14:49 +01001328 }
1329
1330 add_dma_entry(entry);
1331}
1332EXPORT_SYMBOL(debug_dma_map_page);
1333
Shuah Khan6c9c6d62012-10-08 11:08:06 -06001334void debug_dma_mapping_error(struct device *dev, dma_addr_t dma_addr)
1335{
1336 struct dma_debug_entry ref;
1337 struct dma_debug_entry *entry;
1338 struct hash_bucket *bucket;
1339 unsigned long flags;
1340
Florian Fainelli01ce18b2014-12-10 15:41:23 -08001341 if (unlikely(dma_debug_disabled()))
Shuah Khan6c9c6d62012-10-08 11:08:06 -06001342 return;
1343
1344 ref.dev = dev;
1345 ref.dev_addr = dma_addr;
1346 bucket = get_hash_bucket(&ref, &flags);
Shuah Khan6c9c6d62012-10-08 11:08:06 -06001347
Alexander Duyck96e7d7a2013-03-22 15:04:49 -07001348 list_for_each_entry(entry, &bucket->list, list) {
1349 if (!exact_match(&ref, entry))
1350 continue;
Shuah Khan6c9c6d62012-10-08 11:08:06 -06001351
Alexander Duyck96e7d7a2013-03-22 15:04:49 -07001352 /*
1353 * The same physical address can be mapped multiple
1354 * times. Without a hardware IOMMU this results in the
1355 * same device addresses being put into the dma-debug
1356 * hash multiple times too. This can result in false
1357 * positives being reported. Therefore we implement a
1358 * best-fit algorithm here which updates the first entry
1359 * from the hash which fits the reference value and is
1360 * not currently listed as being checked.
1361 */
1362 if (entry->map_err_type == MAP_ERR_NOT_CHECKED) {
1363 entry->map_err_type = MAP_ERR_CHECKED;
1364 break;
1365 }
1366 }
1367
Shuah Khan6c9c6d62012-10-08 11:08:06 -06001368 put_hash_bucket(bucket, &flags);
1369}
1370EXPORT_SYMBOL(debug_dma_mapping_error);
1371
Joerg Roedelf62bc982009-01-09 14:14:49 +01001372void debug_dma_unmap_page(struct device *dev, dma_addr_t addr,
1373 size_t size, int direction, bool map_single)
1374{
1375 struct dma_debug_entry ref = {
1376 .type = dma_debug_page,
1377 .dev = dev,
1378 .dev_addr = addr,
1379 .size = size,
1380 .direction = direction,
1381 };
1382
Florian Fainelli01ce18b2014-12-10 15:41:23 -08001383 if (unlikely(dma_debug_disabled()))
Joerg Roedelf62bc982009-01-09 14:14:49 +01001384 return;
1385
1386 if (map_single)
1387 ref.type = dma_debug_single;
1388
1389 check_unmap(&ref);
1390}
1391EXPORT_SYMBOL(debug_dma_unmap_page);
1392
Joerg Roedel972aa452009-01-09 14:19:54 +01001393void debug_dma_map_sg(struct device *dev, struct scatterlist *sg,
1394 int nents, int mapped_ents, int direction)
1395{
1396 struct dma_debug_entry *entry;
1397 struct scatterlist *s;
1398 int i;
1399
Florian Fainelli01ce18b2014-12-10 15:41:23 -08001400 if (unlikely(dma_debug_disabled()))
Joerg Roedel972aa452009-01-09 14:19:54 +01001401 return;
1402
1403 for_each_sg(sg, s, mapped_ents, i) {
1404 entry = dma_entry_alloc();
1405 if (!entry)
1406 return;
1407
1408 entry->type = dma_debug_sg;
1409 entry->dev = dev;
Dan Williams0abdd7a2014-01-21 15:48:12 -08001410 entry->pfn = page_to_pfn(sg_page(s));
1411 entry->offset = s->offset,
FUJITA Tomonori884d0592009-05-27 09:43:02 +09001412 entry->size = sg_dma_len(s);
FUJITA Tomonori15aedea42009-05-27 09:43:01 +09001413 entry->dev_addr = sg_dma_address(s);
Joerg Roedel972aa452009-01-09 14:19:54 +01001414 entry->direction = direction;
1415 entry->sg_call_ents = nents;
1416 entry->sg_mapped_ents = mapped_ents;
1417
Andy Lutomirskib4a0f532016-08-11 02:35:22 -07001418 check_for_stack(dev, sg_page(s), s->offset);
1419
Joerg Roedel9537a482009-03-23 15:35:08 +01001420 if (!PageHighMem(sg_page(s))) {
FUJITA Tomonori884d0592009-05-27 09:43:02 +09001421 check_for_illegal_area(dev, sg_virt(s), sg_dma_len(s));
Joerg Roedel9537a482009-03-23 15:35:08 +01001422 }
Joerg Roedel972aa452009-01-09 14:19:54 +01001423
1424 add_dma_entry(entry);
1425 }
1426}
1427EXPORT_SYMBOL(debug_dma_map_sg);
1428
Joerg Roedelaa010ef2009-06-12 15:25:06 +02001429static int get_nr_mapped_entries(struct device *dev,
1430 struct dma_debug_entry *ref)
FUJITA Tomonori88f39072009-05-27 09:43:03 +09001431{
Joerg Roedelaa010ef2009-06-12 15:25:06 +02001432 struct dma_debug_entry *entry;
FUJITA Tomonori88f39072009-05-27 09:43:03 +09001433 struct hash_bucket *bucket;
1434 unsigned long flags;
Joerg Roedelc17e2cf2009-06-08 15:19:29 +02001435 int mapped_ents;
FUJITA Tomonori88f39072009-05-27 09:43:03 +09001436
Joerg Roedelaa010ef2009-06-12 15:25:06 +02001437 bucket = get_hash_bucket(ref, &flags);
Neil Hormanc6a21d02011-08-08 15:13:54 -04001438 entry = bucket_find_exact(bucket, ref);
Joerg Roedelc17e2cf2009-06-08 15:19:29 +02001439 mapped_ents = 0;
1440
FUJITA Tomonori88f39072009-05-27 09:43:03 +09001441 if (entry)
1442 mapped_ents = entry->sg_mapped_ents;
1443 put_hash_bucket(bucket, &flags);
1444
1445 return mapped_ents;
1446}
1447
Joerg Roedel972aa452009-01-09 14:19:54 +01001448void debug_dma_unmap_sg(struct device *dev, struct scatterlist *sglist,
1449 int nelems, int dir)
1450{
Joerg Roedel972aa452009-01-09 14:19:54 +01001451 struct scatterlist *s;
1452 int mapped_ents = 0, i;
Joerg Roedel972aa452009-01-09 14:19:54 +01001453
Florian Fainelli01ce18b2014-12-10 15:41:23 -08001454 if (unlikely(dma_debug_disabled()))
Joerg Roedel972aa452009-01-09 14:19:54 +01001455 return;
1456
1457 for_each_sg(sglist, s, nelems, i) {
1458
1459 struct dma_debug_entry ref = {
1460 .type = dma_debug_sg,
1461 .dev = dev,
Dan Williams0abdd7a2014-01-21 15:48:12 -08001462 .pfn = page_to_pfn(sg_page(s)),
1463 .offset = s->offset,
FUJITA Tomonori15aedea42009-05-27 09:43:01 +09001464 .dev_addr = sg_dma_address(s),
FUJITA Tomonori884d0592009-05-27 09:43:02 +09001465 .size = sg_dma_len(s),
Joerg Roedel972aa452009-01-09 14:19:54 +01001466 .direction = dir,
Joerg Roedele5e8c5b2009-06-11 10:03:42 +02001467 .sg_call_ents = nelems,
Joerg Roedel972aa452009-01-09 14:19:54 +01001468 };
1469
1470 if (mapped_ents && i >= mapped_ents)
1471 break;
1472
Joerg Roedele5e8c5b2009-06-11 10:03:42 +02001473 if (!i)
Joerg Roedelaa010ef2009-06-12 15:25:06 +02001474 mapped_ents = get_nr_mapped_entries(dev, &ref);
Joerg Roedel972aa452009-01-09 14:19:54 +01001475
1476 check_unmap(&ref);
1477 }
1478}
1479EXPORT_SYMBOL(debug_dma_unmap_sg);
1480
Joerg Roedel6bfd4492009-01-09 14:38:50 +01001481void debug_dma_alloc_coherent(struct device *dev, size_t size,
1482 dma_addr_t dma_addr, void *virt)
1483{
1484 struct dma_debug_entry *entry;
1485
Florian Fainelli01ce18b2014-12-10 15:41:23 -08001486 if (unlikely(dma_debug_disabled()))
Joerg Roedel6bfd4492009-01-09 14:38:50 +01001487 return;
1488
1489 if (unlikely(virt == NULL))
1490 return;
1491
1492 entry = dma_entry_alloc();
1493 if (!entry)
1494 return;
1495
1496 entry->type = dma_debug_coherent;
1497 entry->dev = dev;
Dan Williams0abdd7a2014-01-21 15:48:12 -08001498 entry->pfn = page_to_pfn(virt_to_page(virt));
Daniel Mentz0354aec2015-12-15 17:38:48 -08001499 entry->offset = (size_t) virt & ~PAGE_MASK;
Joerg Roedel6bfd4492009-01-09 14:38:50 +01001500 entry->size = size;
1501 entry->dev_addr = dma_addr;
1502 entry->direction = DMA_BIDIRECTIONAL;
1503
1504 add_dma_entry(entry);
1505}
1506EXPORT_SYMBOL(debug_dma_alloc_coherent);
1507
1508void debug_dma_free_coherent(struct device *dev, size_t size,
1509 void *virt, dma_addr_t addr)
1510{
1511 struct dma_debug_entry ref = {
1512 .type = dma_debug_coherent,
1513 .dev = dev,
Dan Williams0abdd7a2014-01-21 15:48:12 -08001514 .pfn = page_to_pfn(virt_to_page(virt)),
Daniel Mentz0354aec2015-12-15 17:38:48 -08001515 .offset = (size_t) virt & ~PAGE_MASK,
Joerg Roedel6bfd4492009-01-09 14:38:50 +01001516 .dev_addr = addr,
1517 .size = size,
1518 .direction = DMA_BIDIRECTIONAL,
1519 };
1520
Florian Fainelli01ce18b2014-12-10 15:41:23 -08001521 if (unlikely(dma_debug_disabled()))
Joerg Roedel6bfd4492009-01-09 14:38:50 +01001522 return;
1523
1524 check_unmap(&ref);
1525}
1526EXPORT_SYMBOL(debug_dma_free_coherent);
1527
Niklas Söderlund0e74b342016-08-10 13:22:15 +02001528void debug_dma_map_resource(struct device *dev, phys_addr_t addr, size_t size,
1529 int direction, dma_addr_t dma_addr)
1530{
1531 struct dma_debug_entry *entry;
1532
1533 if (unlikely(dma_debug_disabled()))
1534 return;
1535
1536 entry = dma_entry_alloc();
1537 if (!entry)
1538 return;
1539
1540 entry->type = dma_debug_resource;
1541 entry->dev = dev;
Niklas Söderlund2e0cc302016-09-29 21:59:15 +02001542 entry->pfn = PHYS_PFN(addr);
Niklas Söderlund0e74b342016-08-10 13:22:15 +02001543 entry->offset = offset_in_page(addr);
1544 entry->size = size;
1545 entry->dev_addr = dma_addr;
1546 entry->direction = direction;
1547 entry->map_err_type = MAP_ERR_NOT_CHECKED;
1548
1549 add_dma_entry(entry);
1550}
1551EXPORT_SYMBOL(debug_dma_map_resource);
1552
1553void debug_dma_unmap_resource(struct device *dev, dma_addr_t dma_addr,
1554 size_t size, int direction)
1555{
1556 struct dma_debug_entry ref = {
1557 .type = dma_debug_resource,
1558 .dev = dev,
1559 .dev_addr = dma_addr,
1560 .size = size,
1561 .direction = direction,
1562 };
1563
1564 if (unlikely(dma_debug_disabled()))
1565 return;
1566
1567 check_unmap(&ref);
1568}
1569EXPORT_SYMBOL(debug_dma_unmap_resource);
1570
Joerg Roedelb9d23172009-01-09 14:43:04 +01001571void debug_dma_sync_single_for_cpu(struct device *dev, dma_addr_t dma_handle,
1572 size_t size, int direction)
1573{
Joerg Roedelaa010ef2009-06-12 15:25:06 +02001574 struct dma_debug_entry ref;
1575
Florian Fainelli01ce18b2014-12-10 15:41:23 -08001576 if (unlikely(dma_debug_disabled()))
Joerg Roedelb9d23172009-01-09 14:43:04 +01001577 return;
1578
Joerg Roedelaa010ef2009-06-12 15:25:06 +02001579 ref.type = dma_debug_single;
1580 ref.dev = dev;
1581 ref.dev_addr = dma_handle;
1582 ref.size = size;
1583 ref.direction = direction;
1584 ref.sg_call_ents = 0;
1585
1586 check_sync(dev, &ref, true);
Joerg Roedelb9d23172009-01-09 14:43:04 +01001587}
1588EXPORT_SYMBOL(debug_dma_sync_single_for_cpu);
1589
1590void debug_dma_sync_single_for_device(struct device *dev,
1591 dma_addr_t dma_handle, size_t size,
1592 int direction)
1593{
Joerg Roedelaa010ef2009-06-12 15:25:06 +02001594 struct dma_debug_entry ref;
1595
Florian Fainelli01ce18b2014-12-10 15:41:23 -08001596 if (unlikely(dma_debug_disabled()))
Joerg Roedelb9d23172009-01-09 14:43:04 +01001597 return;
1598
Joerg Roedelaa010ef2009-06-12 15:25:06 +02001599 ref.type = dma_debug_single;
1600 ref.dev = dev;
1601 ref.dev_addr = dma_handle;
1602 ref.size = size;
1603 ref.direction = direction;
1604 ref.sg_call_ents = 0;
1605
1606 check_sync(dev, &ref, false);
Joerg Roedelb9d23172009-01-09 14:43:04 +01001607}
1608EXPORT_SYMBOL(debug_dma_sync_single_for_device);
1609
Joerg Roedel948408b2009-01-09 14:55:38 +01001610void debug_dma_sync_single_range_for_cpu(struct device *dev,
1611 dma_addr_t dma_handle,
1612 unsigned long offset, size_t size,
1613 int direction)
1614{
Joerg Roedelaa010ef2009-06-12 15:25:06 +02001615 struct dma_debug_entry ref;
1616
Florian Fainelli01ce18b2014-12-10 15:41:23 -08001617 if (unlikely(dma_debug_disabled()))
Joerg Roedel948408b2009-01-09 14:55:38 +01001618 return;
1619
Joerg Roedelaa010ef2009-06-12 15:25:06 +02001620 ref.type = dma_debug_single;
1621 ref.dev = dev;
1622 ref.dev_addr = dma_handle;
1623 ref.size = offset + size;
1624 ref.direction = direction;
1625 ref.sg_call_ents = 0;
1626
1627 check_sync(dev, &ref, true);
Joerg Roedel948408b2009-01-09 14:55:38 +01001628}
1629EXPORT_SYMBOL(debug_dma_sync_single_range_for_cpu);
1630
1631void debug_dma_sync_single_range_for_device(struct device *dev,
1632 dma_addr_t dma_handle,
1633 unsigned long offset,
1634 size_t size, int direction)
1635{
Joerg Roedelaa010ef2009-06-12 15:25:06 +02001636 struct dma_debug_entry ref;
1637
Florian Fainelli01ce18b2014-12-10 15:41:23 -08001638 if (unlikely(dma_debug_disabled()))
Joerg Roedel948408b2009-01-09 14:55:38 +01001639 return;
1640
Joerg Roedelaa010ef2009-06-12 15:25:06 +02001641 ref.type = dma_debug_single;
1642 ref.dev = dev;
1643 ref.dev_addr = dma_handle;
1644 ref.size = offset + size;
1645 ref.direction = direction;
1646 ref.sg_call_ents = 0;
1647
1648 check_sync(dev, &ref, false);
Joerg Roedel948408b2009-01-09 14:55:38 +01001649}
1650EXPORT_SYMBOL(debug_dma_sync_single_range_for_device);
1651
Joerg Roedela31fba52009-01-09 15:01:12 +01001652void debug_dma_sync_sg_for_cpu(struct device *dev, struct scatterlist *sg,
1653 int nelems, int direction)
1654{
1655 struct scatterlist *s;
FUJITA Tomonori88f39072009-05-27 09:43:03 +09001656 int mapped_ents = 0, i;
Joerg Roedela31fba52009-01-09 15:01:12 +01001657
Florian Fainelli01ce18b2014-12-10 15:41:23 -08001658 if (unlikely(dma_debug_disabled()))
Joerg Roedela31fba52009-01-09 15:01:12 +01001659 return;
1660
1661 for_each_sg(sg, s, nelems, i) {
Joerg Roedelaa010ef2009-06-12 15:25:06 +02001662
1663 struct dma_debug_entry ref = {
1664 .type = dma_debug_sg,
1665 .dev = dev,
Dan Williams0abdd7a2014-01-21 15:48:12 -08001666 .pfn = page_to_pfn(sg_page(s)),
1667 .offset = s->offset,
Joerg Roedelaa010ef2009-06-12 15:25:06 +02001668 .dev_addr = sg_dma_address(s),
1669 .size = sg_dma_len(s),
1670 .direction = direction,
1671 .sg_call_ents = nelems,
1672 };
1673
FUJITA Tomonori88f39072009-05-27 09:43:03 +09001674 if (!i)
Joerg Roedelaa010ef2009-06-12 15:25:06 +02001675 mapped_ents = get_nr_mapped_entries(dev, &ref);
FUJITA Tomonori88f39072009-05-27 09:43:03 +09001676
1677 if (i >= mapped_ents)
1678 break;
1679
Joerg Roedelaa010ef2009-06-12 15:25:06 +02001680 check_sync(dev, &ref, true);
Joerg Roedela31fba52009-01-09 15:01:12 +01001681 }
1682}
1683EXPORT_SYMBOL(debug_dma_sync_sg_for_cpu);
1684
1685void debug_dma_sync_sg_for_device(struct device *dev, struct scatterlist *sg,
1686 int nelems, int direction)
1687{
1688 struct scatterlist *s;
FUJITA Tomonori88f39072009-05-27 09:43:03 +09001689 int mapped_ents = 0, i;
Joerg Roedela31fba52009-01-09 15:01:12 +01001690
Florian Fainelli01ce18b2014-12-10 15:41:23 -08001691 if (unlikely(dma_debug_disabled()))
Joerg Roedela31fba52009-01-09 15:01:12 +01001692 return;
1693
1694 for_each_sg(sg, s, nelems, i) {
Joerg Roedelaa010ef2009-06-12 15:25:06 +02001695
1696 struct dma_debug_entry ref = {
1697 .type = dma_debug_sg,
1698 .dev = dev,
Dan Williams0abdd7a2014-01-21 15:48:12 -08001699 .pfn = page_to_pfn(sg_page(s)),
1700 .offset = s->offset,
Joerg Roedelaa010ef2009-06-12 15:25:06 +02001701 .dev_addr = sg_dma_address(s),
1702 .size = sg_dma_len(s),
1703 .direction = direction,
1704 .sg_call_ents = nelems,
1705 };
FUJITA Tomonori88f39072009-05-27 09:43:03 +09001706 if (!i)
Joerg Roedelaa010ef2009-06-12 15:25:06 +02001707 mapped_ents = get_nr_mapped_entries(dev, &ref);
FUJITA Tomonori88f39072009-05-27 09:43:03 +09001708
1709 if (i >= mapped_ents)
1710 break;
1711
Joerg Roedelaa010ef2009-06-12 15:25:06 +02001712 check_sync(dev, &ref, false);
Joerg Roedela31fba52009-01-09 15:01:12 +01001713 }
1714}
1715EXPORT_SYMBOL(debug_dma_sync_sg_for_device);
1716
Joerg Roedel1745de52009-05-22 21:49:51 +02001717static int __init dma_debug_driver_setup(char *str)
1718{
1719 int i;
1720
1721 for (i = 0; i < NAME_MAX_LEN - 1; ++i, ++str) {
1722 current_driver_name[i] = *str;
1723 if (*str == 0)
1724 break;
1725 }
1726
1727 if (current_driver_name[0])
Joerg Roedele7ed70e2009-06-08 15:39:24 +02001728 pr_info("DMA-API: enable driver filter for driver [%s]\n",
1729 current_driver_name);
Joerg Roedel1745de52009-05-22 21:49:51 +02001730
1731
1732 return 1;
1733}
1734__setup("dma_debug_driver=", dma_debug_driver_setup);