blob: 9722bd2dbc9bd5782e867c72f8b6893f9ab2c5ab [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>
Joerg Roedel788dcfa2009-01-09 13:13:27 +010025#include <linux/debugfs.h>
Joerg Roedel8a6fc702009-05-22 21:23:13 +020026#include <linux/uaccess.h>
Paul Gortmaker23a7bfa2011-07-01 16:23:59 -040027#include <linux/export.h>
Joerg Roedel2d62ece2009-01-09 14:10:26 +010028#include <linux/device.h>
Joerg Roedelf2f45e52009-01-09 12:19:52 +010029#include <linux/types.h>
Joerg Roedel2d62ece2009-01-09 14:10:26 +010030#include <linux/sched.h>
Joerg Roedel8a6fc702009-05-22 21:23:13 +020031#include <linux/ctype.h>
Joerg Roedelf2f45e52009-01-09 12:19:52 +010032#include <linux/list.h>
Joerg Roedel6bf07872009-01-09 12:54:42 +010033#include <linux/slab.h>
Joerg Roedelf2f45e52009-01-09 12:19:52 +010034
Joerg Roedel2e34bde2009-03-16 16:51:55 +010035#include <asm/sections.h>
36
Joerg Roedel30dfa902009-01-09 12:34:49 +010037#define HASH_SIZE 1024ULL
38#define HASH_FN_SHIFT 13
39#define HASH_FN_MASK (HASH_SIZE - 1)
40
Joerg Roedelf2f45e52009-01-09 12:19:52 +010041enum {
42 dma_debug_single,
43 dma_debug_page,
44 dma_debug_sg,
45 dma_debug_coherent,
46};
47
Shuah Khan6c9c6d62012-10-08 11:08:06 -060048enum map_err_types {
49 MAP_ERR_CHECK_NOT_APPLICABLE,
50 MAP_ERR_NOT_CHECKED,
51 MAP_ERR_CHECKED,
52};
53
David Woodhouse6c132d12009-01-19 16:52:39 +010054#define DMA_DEBUG_STACKTRACE_ENTRIES 5
55
Dan Williams0abdd7a2014-01-21 15:48:12 -080056/**
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
69 */
Joerg Roedelf2f45e52009-01-09 12:19:52 +010070struct dma_debug_entry {
71 struct list_head list;
72 struct device *dev;
73 int type;
Dan Williams0abdd7a2014-01-21 15:48:12 -080074 unsigned long pfn;
75 size_t offset;
Joerg Roedelf2f45e52009-01-09 12:19:52 +010076 u64 dev_addr;
77 u64 size;
78 int direction;
79 int sg_call_ents;
80 int sg_mapped_ents;
Shuah Khan6c9c6d62012-10-08 11:08:06 -060081 enum map_err_types map_err_type;
David Woodhouse6c132d12009-01-19 16:52:39 +010082#ifdef CONFIG_STACKTRACE
83 struct stack_trace stacktrace;
84 unsigned long st_entries[DMA_DEBUG_STACKTRACE_ENTRIES];
85#endif
Joerg Roedelf2f45e52009-01-09 12:19:52 +010086};
87
Neil Hormanc6a21d02011-08-08 15:13:54 -040088typedef bool (*match_fn)(struct dma_debug_entry *, struct dma_debug_entry *);
89
Joerg Roedel30dfa902009-01-09 12:34:49 +010090struct hash_bucket {
91 struct list_head list;
92 spinlock_t lock;
Joerg Roedel2d62ece2009-01-09 14:10:26 +010093} ____cacheline_aligned_in_smp;
Joerg Roedel30dfa902009-01-09 12:34:49 +010094
95/* Hash list to save the allocated dma addresses */
96static struct hash_bucket dma_entry_hash[HASH_SIZE];
Joerg Roedel3b1e79e2009-01-09 12:42:46 +010097/* List of pre-allocated dma_debug_entry's */
98static LIST_HEAD(free_entries);
99/* Lock for the list above */
100static DEFINE_SPINLOCK(free_entries_lock);
101
102/* Global disable flag - will be set in case of an error */
Dan Carpenter68ee6d22012-06-27 12:08:55 +0300103static u32 global_disable __read_mostly;
Joerg Roedel3b1e79e2009-01-09 12:42:46 +0100104
Florian Fainelli2ce8e7e2014-12-10 15:41:25 -0800105/* Early initialization disable flag, set at the end of dma_debug_init */
106static bool dma_debug_initialized __read_mostly;
107
Florian Fainelli01ce18b2014-12-10 15:41:23 -0800108static inline bool dma_debug_disabled(void)
109{
Florian Fainelli2ce8e7e2014-12-10 15:41:25 -0800110 return global_disable || !dma_debug_initialized;
Florian Fainelli01ce18b2014-12-10 15:41:23 -0800111}
112
Joerg Roedel788dcfa2009-01-09 13:13:27 +0100113/* Global error count */
114static u32 error_count;
115
116/* Global error show enable*/
117static u32 show_all_errors __read_mostly;
118/* Number of errors to show */
119static u32 show_num_errors = 1;
120
Joerg Roedel3b1e79e2009-01-09 12:42:46 +0100121static u32 num_free_entries;
122static u32 min_free_entries;
FUJITA Tomonorie6a1a892009-04-15 18:22:41 +0900123static u32 nr_total_entries;
Joerg Roedel30dfa902009-01-09 12:34:49 +0100124
Joerg Roedel59d3daa2009-01-09 13:01:56 +0100125/* number of preallocated entries requested by kernel cmdline */
126static u32 req_entries;
127
Joerg Roedel788dcfa2009-01-09 13:13:27 +0100128/* debugfs dentry's for the stuff above */
129static struct dentry *dma_debug_dent __read_mostly;
130static struct dentry *global_disable_dent __read_mostly;
131static struct dentry *error_count_dent __read_mostly;
132static struct dentry *show_all_errors_dent __read_mostly;
133static struct dentry *show_num_errors_dent __read_mostly;
134static struct dentry *num_free_entries_dent __read_mostly;
135static struct dentry *min_free_entries_dent __read_mostly;
Joerg Roedel8a6fc702009-05-22 21:23:13 +0200136static struct dentry *filter_dent __read_mostly;
Joerg Roedel788dcfa2009-01-09 13:13:27 +0100137
Joerg Roedel2e507d82009-05-22 18:24:20 +0200138/* per-driver filter related state */
139
140#define NAME_MAX_LEN 64
141
142static char current_driver_name[NAME_MAX_LEN] __read_mostly;
143static struct device_driver *current_driver __read_mostly;
144
145static DEFINE_RWLOCK(driver_name_lock);
Joerg Roedel30dfa902009-01-09 12:34:49 +0100146
Shuah Khan6c9c6d62012-10-08 11:08:06 -0600147static 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",
151};
152
Joerg Roedel2d62ece2009-01-09 14:10:26 +0100153static const char *type2name[4] = { "single", "page",
154 "scather-gather", "coherent" };
155
156static const char *dir2name[4] = { "DMA_BIDIRECTIONAL", "DMA_TO_DEVICE",
157 "DMA_FROM_DEVICE", "DMA_NONE" };
158
159/*
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:
164 *
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.
171 */
David Woodhouse6c132d12009-01-19 16:52:39 +0100172static inline void dump_entry_trace(struct dma_debug_entry *entry)
173{
174#ifdef CONFIG_STACKTRACE
175 if (entry) {
Joerg Roedele7ed70e2009-06-08 15:39:24 +0200176 pr_warning("Mapped at:\n");
David Woodhouse6c132d12009-01-19 16:52:39 +0100177 print_stack_trace(&entry->stacktrace, 0);
178 }
179#endif
180}
181
Joerg Roedel2e507d82009-05-22 18:24:20 +0200182static bool driver_filter(struct device *dev)
183{
Joerg Roedel0bf84122009-06-08 15:53:46 +0200184 struct device_driver *drv;
185 unsigned long flags;
186 bool ret;
187
Joerg Roedel2e507d82009-05-22 18:24:20 +0200188 /* driver filter off */
189 if (likely(!current_driver_name[0]))
190 return true;
191
192 /* driver filter on and initialized */
Kyle McMartinec9c96e2009-08-19 21:17:08 -0400193 if (current_driver && dev && dev->driver == current_driver)
Joerg Roedel2e507d82009-05-22 18:24:20 +0200194 return true;
195
Kyle McMartinec9c96e2009-08-19 21:17:08 -0400196 /* driver filter on, but we can't filter on a NULL device... */
197 if (!dev)
198 return false;
199
Joerg Roedel0bf84122009-06-08 15:53:46 +0200200 if (current_driver || !current_driver_name[0])
201 return false;
202
Joerg Roedel2e507d82009-05-22 18:24:20 +0200203 /* driver filter on but not yet initialized */
Alan Sternf3ff9242012-01-24 13:35:24 -0500204 drv = dev->driver;
Joerg Roedel0bf84122009-06-08 15:53:46 +0200205 if (!drv)
206 return false;
Joerg Roedel2e507d82009-05-22 18:24:20 +0200207
Joerg Roedel0bf84122009-06-08 15:53:46 +0200208 /* lock to protect against change of current_driver_name */
209 read_lock_irqsave(&driver_name_lock, flags);
Joerg Roedel2e507d82009-05-22 18:24:20 +0200210
Joerg Roedel0bf84122009-06-08 15:53:46 +0200211 ret = false;
212 if (drv->name &&
213 strncmp(current_driver_name, drv->name, NAME_MAX_LEN - 1) == 0) {
214 current_driver = drv;
215 ret = true;
Joerg Roedel2e507d82009-05-22 18:24:20 +0200216 }
217
Joerg Roedel0bf84122009-06-08 15:53:46 +0200218 read_unlock_irqrestore(&driver_name_lock, flags);
Joerg Roedel0bf84122009-06-08 15:53:46 +0200219
220 return ret;
Joerg Roedel2e507d82009-05-22 18:24:20 +0200221}
222
Kyle McMartinec9c96e2009-08-19 21:17:08 -0400223#define err_printk(dev, entry, format, arg...) do { \
224 error_count += 1; \
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); \
231 } \
232 if (!show_all_errors && show_num_errors > 0) \
233 show_num_errors -= 1; \
Joerg Roedel2d62ece2009-01-09 14:10:26 +0100234 } while (0);
235
Joerg Roedel30dfa902009-01-09 12:34:49 +0100236/*
237 * Hash related functions
238 *
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.
241 */
242static int hash_fn(struct dma_debug_entry *entry)
243{
244 /*
245 * Hash function is based on the dma address.
246 * We use bits 20-27 here as the index into the hash
247 */
248 return (entry->dev_addr >> HASH_FN_SHIFT) & HASH_FN_MASK;
249}
250
251/*
252 * Request exclusive access to a hash bucket for a given dma_debug_entry.
253 */
254static struct hash_bucket *get_hash_bucket(struct dma_debug_entry *entry,
255 unsigned long *flags)
256{
257 int idx = hash_fn(entry);
258 unsigned long __flags;
259
260 spin_lock_irqsave(&dma_entry_hash[idx].lock, __flags);
261 *flags = __flags;
262 return &dma_entry_hash[idx];
263}
264
265/*
266 * Give up exclusive access to the hash bucket
267 */
268static void put_hash_bucket(struct hash_bucket *bucket,
269 unsigned long *flags)
270{
271 unsigned long __flags = *flags;
272
273 spin_unlock_irqrestore(&bucket->lock, __flags);
274}
275
Neil Hormanc6a21d02011-08-08 15:13:54 -0400276static bool exact_match(struct dma_debug_entry *a, struct dma_debug_entry *b)
277{
Thomas Jarosch91ec37c2011-11-17 20:31:02 +0100278 return ((a->dev_addr == b->dev_addr) &&
Neil Hormanc6a21d02011-08-08 15:13:54 -0400279 (a->dev == b->dev)) ? true : false;
280}
281
282static bool containing_match(struct dma_debug_entry *a,
283 struct dma_debug_entry *b)
284{
285 if (a->dev != b->dev)
286 return false;
287
288 if ((b->dev_addr <= a->dev_addr) &&
289 ((b->dev_addr + b->size) >= (a->dev_addr + a->size)))
290 return true;
291
292 return false;
293}
294
Joerg Roedel30dfa902009-01-09 12:34:49 +0100295/*
296 * Search a given entry in the hash bucket list
297 */
Neil Hormanc6a21d02011-08-08 15:13:54 -0400298static struct dma_debug_entry *__hash_bucket_find(struct hash_bucket *bucket,
299 struct dma_debug_entry *ref,
300 match_fn match)
Joerg Roedel30dfa902009-01-09 12:34:49 +0100301{
Joerg Roedel7caf6a42009-06-05 12:01:35 +0200302 struct dma_debug_entry *entry, *ret = NULL;
Ming Leife73fbe2012-10-19 13:57:01 -0700303 int matches = 0, match_lvl, last_lvl = -1;
Joerg Roedel30dfa902009-01-09 12:34:49 +0100304
305 list_for_each_entry(entry, &bucket->list, list) {
Neil Hormanc6a21d02011-08-08 15:13:54 -0400306 if (!match(ref, entry))
Joerg Roedel7caf6a42009-06-05 12:01:35 +0200307 continue;
308
309 /*
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
André Goddard Rosaaf901ca2009-11-14 13:09:05 -0200314 * positives being reported. Therefore we implement a
Joerg Roedel7caf6a42009-06-05 12:01:35 +0200315 * 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.
318 */
319 matches += 1;
320 match_lvl = 0;
Joerg Roedele5e8c5b2009-06-11 10:03:42 +0200321 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;
Joerg Roedel7caf6a42009-06-05 12:01:35 +0200325
Joerg Roedele5e8c5b2009-06-11 10:03:42 +0200326 if (match_lvl == 4) {
Joerg Roedel7caf6a42009-06-05 12:01:35 +0200327 /* perfect-fit - return the result */
Joerg Roedel30dfa902009-01-09 12:34:49 +0100328 return entry;
Joerg Roedel7caf6a42009-06-05 12:01:35 +0200329 } else if (match_lvl > last_lvl) {
330 /*
331 * We found an entry that fits better then the
Ming Leife73fbe2012-10-19 13:57:01 -0700332 * previous one or it is the 1st match.
Joerg Roedel7caf6a42009-06-05 12:01:35 +0200333 */
334 last_lvl = match_lvl;
335 ret = entry;
336 }
Joerg Roedel30dfa902009-01-09 12:34:49 +0100337 }
338
Joerg Roedel7caf6a42009-06-05 12:01:35 +0200339 /*
340 * If we have multiple matches but no perfect-fit, just return
341 * NULL.
342 */
343 ret = (matches == 1) ? ret : NULL;
344
345 return ret;
Joerg Roedel30dfa902009-01-09 12:34:49 +0100346}
347
Neil Hormanc6a21d02011-08-08 15:13:54 -0400348static struct dma_debug_entry *bucket_find_exact(struct hash_bucket *bucket,
349 struct dma_debug_entry *ref)
350{
351 return __hash_bucket_find(bucket, ref, exact_match);
352}
353
354static struct dma_debug_entry *bucket_find_contain(struct hash_bucket **bucket,
355 struct dma_debug_entry *ref,
356 unsigned long *flags)
357{
358
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;
362
363 while (range <= max_range) {
364 entry = __hash_bucket_find(*bucket, &index, containing_match);
365
366 if (entry)
367 return entry;
368
369 /*
370 * Nothing found, go back a hash bucket
371 */
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);
376 }
377
378 return NULL;
379}
380
Joerg Roedel30dfa902009-01-09 12:34:49 +0100381/*
382 * Add an entry to a hash bucket
383 */
384static void hash_bucket_add(struct hash_bucket *bucket,
385 struct dma_debug_entry *entry)
386{
387 list_add_tail(&entry->list, &bucket->list);
388}
389
390/*
391 * Remove entry from a hash bucket list
392 */
393static void hash_bucket_del(struct dma_debug_entry *entry)
394{
395 list_del(&entry->list);
396}
397
Dan Williams0abdd7a2014-01-21 15:48:12 -0800398static unsigned long long phys_addr(struct dma_debug_entry *entry)
399{
400 return page_to_phys(pfn_to_page(entry->pfn)) + entry->offset;
401}
402
Joerg Roedel30dfa902009-01-09 12:34:49 +0100403/*
David Woodhouseac26c182009-02-12 16:19:13 +0100404 * Dump mapping entries for debugging purposes
405 */
406void debug_dma_dump_mappings(struct device *dev)
407{
408 int idx;
409
410 for (idx = 0; idx < HASH_SIZE; idx++) {
411 struct hash_bucket *bucket = &dma_entry_hash[idx];
412 struct dma_debug_entry *entry;
413 unsigned long flags;
414
415 spin_lock_irqsave(&bucket->lock, flags);
416
417 list_for_each_entry(entry, &bucket->list, list) {
418 if (!dev || dev == entry->dev) {
419 dev_info(entry->dev,
Dan Williams0abdd7a2014-01-21 15:48:12 -0800420 "%s idx %d P=%Lx N=%lx D=%Lx L=%Lx %s %s\n",
David Woodhouseac26c182009-02-12 16:19:13 +0100421 type2name[entry->type], idx,
Dan Williams0abdd7a2014-01-21 15:48:12 -0800422 phys_addr(entry), entry->pfn,
David Woodhouseac26c182009-02-12 16:19:13 +0100423 entry->dev_addr, entry->size,
Shuah Khan6c9c6d62012-10-08 11:08:06 -0600424 dir2name[entry->direction],
425 maperr2str[entry->map_err_type]);
David Woodhouseac26c182009-02-12 16:19:13 +0100426 }
427 }
428
429 spin_unlock_irqrestore(&bucket->lock, flags);
430 }
431}
432EXPORT_SYMBOL(debug_dma_dump_mappings);
433
434/*
Dan Williams3b7a6412014-03-03 15:38:21 -0800435 * 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
Dan Williams0abdd7a2014-01-21 15:48:12 -0800439 * dma_unmap_{single|sg|page} or dma_free_coherent delete the entry. If
Dan Williams3b7a6412014-03-03 15:38:21 -0800440 * the entry already exists at insertion time add a tag as a reference
Dan Williams0abdd7a2014-01-21 15:48:12 -0800441 * count for the overlapping mappings. For now, the overlap tracking
Dan Williams3b7a6412014-03-03 15:38:21 -0800442 * just ensures that 'unmaps' balance 'maps' before marking the
443 * cacheline idle, but we should also be flagging overlaps as an API
444 * violation.
Dan Williams0abdd7a2014-01-21 15:48:12 -0800445 *
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
Dan Williams3b7a6412014-03-03 15:38:21 -0800448 * 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.
Dan Williams0abdd7a2014-01-21 15:48:12 -0800453 *
454 * At any time debug_dma_assert_idle() can be called to trigger a
Dan Williams3b7a6412014-03-03 15:38:21 -0800455 * warning if any cachelines in the given page are in the active set.
Dan Williams0abdd7a2014-01-21 15:48:12 -0800456 */
Dan Williams3b7a6412014-03-03 15:38:21 -0800457static RADIX_TREE(dma_active_cacheline, GFP_NOWAIT);
Dan Williams0abdd7a2014-01-21 15:48:12 -0800458static DEFINE_SPINLOCK(radix_lock);
Dan Williams3b7a6412014-03-03 15:38:21 -0800459#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)
Dan Williams0abdd7a2014-01-21 15:48:12 -0800462
Dan Williams3b7a6412014-03-03 15:38:21 -0800463static phys_addr_t to_cacheline_number(struct dma_debug_entry *entry)
464{
465 return (entry->pfn << CACHELINE_PER_PAGE_SHIFT) +
466 (entry->offset >> L1_CACHE_SHIFT);
467}
468
469static int active_cacheline_read_overlap(phys_addr_t cln)
Dan Williams0abdd7a2014-01-21 15:48:12 -0800470{
471 int overlap = 0, i;
472
473 for (i = RADIX_TREE_MAX_TAGS - 1; i >= 0; i--)
Dan Williams3b7a6412014-03-03 15:38:21 -0800474 if (radix_tree_tag_get(&dma_active_cacheline, cln, i))
Dan Williams0abdd7a2014-01-21 15:48:12 -0800475 overlap |= 1 << i;
476 return overlap;
477}
478
Dan Williams3b7a6412014-03-03 15:38:21 -0800479static int active_cacheline_set_overlap(phys_addr_t cln, int overlap)
Dan Williams0abdd7a2014-01-21 15:48:12 -0800480{
481 int i;
482
Dan Williams3b7a6412014-03-03 15:38:21 -0800483 if (overlap > ACTIVE_CACHELINE_MAX_OVERLAP || overlap < 0)
Dan Williams59f2e7d2014-01-29 14:05:53 -0800484 return overlap;
Dan Williams0abdd7a2014-01-21 15:48:12 -0800485
486 for (i = RADIX_TREE_MAX_TAGS - 1; i >= 0; i--)
487 if (overlap & 1 << i)
Dan Williams3b7a6412014-03-03 15:38:21 -0800488 radix_tree_tag_set(&dma_active_cacheline, cln, i);
Dan Williams0abdd7a2014-01-21 15:48:12 -0800489 else
Dan Williams3b7a6412014-03-03 15:38:21 -0800490 radix_tree_tag_clear(&dma_active_cacheline, cln, i);
Dan Williams0abdd7a2014-01-21 15:48:12 -0800491
492 return overlap;
493}
494
Dan Williams3b7a6412014-03-03 15:38:21 -0800495static void active_cacheline_inc_overlap(phys_addr_t cln)
Dan Williams0abdd7a2014-01-21 15:48:12 -0800496{
Dan Williams3b7a6412014-03-03 15:38:21 -0800497 int overlap = active_cacheline_read_overlap(cln);
Dan Williams0abdd7a2014-01-21 15:48:12 -0800498
Dan Williams3b7a6412014-03-03 15:38:21 -0800499 overlap = active_cacheline_set_overlap(cln, ++overlap);
Dan Williams0abdd7a2014-01-21 15:48:12 -0800500
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
Dan Williams3b7a6412014-03-03 15:38:21 -0800504 * debug_dma_assert_idle() as the cacheline may be marked idle
Dan Williams0abdd7a2014-01-21 15:48:12 -0800505 * prematurely.
506 */
Dan Williams3b7a6412014-03-03 15:38:21 -0800507 WARN_ONCE(overlap > ACTIVE_CACHELINE_MAX_OVERLAP,
508 "DMA-API: exceeded %d overlapping mappings of cacheline %pa\n",
509 ACTIVE_CACHELINE_MAX_OVERLAP, &cln);
Dan Williams0abdd7a2014-01-21 15:48:12 -0800510}
511
Dan Williams3b7a6412014-03-03 15:38:21 -0800512static int active_cacheline_dec_overlap(phys_addr_t cln)
Dan Williams0abdd7a2014-01-21 15:48:12 -0800513{
Dan Williams3b7a6412014-03-03 15:38:21 -0800514 int overlap = active_cacheline_read_overlap(cln);
Dan Williams0abdd7a2014-01-21 15:48:12 -0800515
Dan Williams3b7a6412014-03-03 15:38:21 -0800516 return active_cacheline_set_overlap(cln, --overlap);
Dan Williams0abdd7a2014-01-21 15:48:12 -0800517}
518
Dan Williams3b7a6412014-03-03 15:38:21 -0800519static int active_cacheline_insert(struct dma_debug_entry *entry)
Dan Williams0abdd7a2014-01-21 15:48:12 -0800520{
Dan Williams3b7a6412014-03-03 15:38:21 -0800521 phys_addr_t cln = to_cacheline_number(entry);
Dan Williams0abdd7a2014-01-21 15:48:12 -0800522 unsigned long flags;
523 int rc;
524
Dan Williams3b7a6412014-03-03 15:38:21 -0800525 /* 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.
528 */
529 if (entry->direction == DMA_TO_DEVICE)
530 return 0;
531
Dan Williams0abdd7a2014-01-21 15:48:12 -0800532 spin_lock_irqsave(&radix_lock, flags);
Dan Williams3b7a6412014-03-03 15:38:21 -0800533 rc = radix_tree_insert(&dma_active_cacheline, cln, entry);
Dan Williams0abdd7a2014-01-21 15:48:12 -0800534 if (rc == -EEXIST)
Dan Williams3b7a6412014-03-03 15:38:21 -0800535 active_cacheline_inc_overlap(cln);
Dan Williams0abdd7a2014-01-21 15:48:12 -0800536 spin_unlock_irqrestore(&radix_lock, flags);
537
538 return rc;
539}
540
Dan Williams3b7a6412014-03-03 15:38:21 -0800541static void active_cacheline_remove(struct dma_debug_entry *entry)
Dan Williams0abdd7a2014-01-21 15:48:12 -0800542{
Dan Williams3b7a6412014-03-03 15:38:21 -0800543 phys_addr_t cln = to_cacheline_number(entry);
Dan Williams0abdd7a2014-01-21 15:48:12 -0800544 unsigned long flags;
545
Dan Williams3b7a6412014-03-03 15:38:21 -0800546 /* ...mirror the insert case */
547 if (entry->direction == DMA_TO_DEVICE)
548 return;
549
Dan Williams0abdd7a2014-01-21 15:48:12 -0800550 spin_lock_irqsave(&radix_lock, flags);
Dan Williams59f2e7d2014-01-29 14:05:53 -0800551 /* since we are counting overlaps the final put of the
Dan Williams3b7a6412014-03-03 15:38:21 -0800552 * cacheline will occur when the overlap count is 0.
553 * active_cacheline_dec_overlap() returns -1 in that case
Dan Williams59f2e7d2014-01-29 14:05:53 -0800554 */
Dan Williams3b7a6412014-03-03 15:38:21 -0800555 if (active_cacheline_dec_overlap(cln) < 0)
556 radix_tree_delete(&dma_active_cacheline, cln);
Dan Williams0abdd7a2014-01-21 15:48:12 -0800557 spin_unlock_irqrestore(&radix_lock, flags);
558}
559
560/**
561 * debug_dma_assert_idle() - assert that a page is not undergoing dma
Dan Williams3b7a6412014-03-03 15:38:21 -0800562 * @page: page to lookup in the dma_active_cacheline tree
Dan Williams0abdd7a2014-01-21 15:48:12 -0800563 *
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
566 * corruption.
567 */
568void debug_dma_assert_idle(struct page *page)
569{
Dan Williams3b7a6412014-03-03 15:38:21 -0800570 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;
Dan Williams0abdd7a2014-01-21 15:48:12 -0800574 unsigned long flags;
Dan Williams3b7a6412014-03-03 15:38:21 -0800575 phys_addr_t cln;
Dan Williams0abdd7a2014-01-21 15:48:12 -0800576
577 if (!page)
578 return;
579
Dan Williams3b7a6412014-03-03 15:38:21 -0800580 cln = (phys_addr_t) page_to_pfn(page) << CACHELINE_PER_PAGE_SHIFT;
Dan Williams0abdd7a2014-01-21 15:48:12 -0800581 spin_lock_irqsave(&radix_lock, flags);
Dan Williams3b7a6412014-03-03 15:38:21 -0800582 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]);
586
587 if (ent_cln == cln) {
588 entry = ents[i];
589 break;
590 } else if (ent_cln >= cln + CACHELINES_PER_PAGE)
591 break;
592 }
Dan Williams0abdd7a2014-01-21 15:48:12 -0800593 spin_unlock_irqrestore(&radix_lock, flags);
594
595 if (!entry)
596 return;
597
Dan Williams3b7a6412014-03-03 15:38:21 -0800598 cln = to_cacheline_number(entry);
Dan Williams0abdd7a2014-01-21 15:48:12 -0800599 err_printk(entry->dev, entry,
Dan Williams3b7a6412014-03-03 15:38:21 -0800600 "DMA-API: cpu touching an active dma mapped cacheline [cln=%pa]\n",
601 &cln);
Dan Williams0abdd7a2014-01-21 15:48:12 -0800602}
603
604/*
Joerg Roedel30dfa902009-01-09 12:34:49 +0100605 * Wrapper function for adding an entry to the hash.
606 * This function takes care of locking itself.
607 */
608static void add_dma_entry(struct dma_debug_entry *entry)
609{
610 struct hash_bucket *bucket;
611 unsigned long flags;
Dan Williams0abdd7a2014-01-21 15:48:12 -0800612 int rc;
Joerg Roedel30dfa902009-01-09 12:34:49 +0100613
614 bucket = get_hash_bucket(entry, &flags);
615 hash_bucket_add(bucket, entry);
616 put_hash_bucket(bucket, &flags);
Dan Williams0abdd7a2014-01-21 15:48:12 -0800617
Dan Williams3b7a6412014-03-03 15:38:21 -0800618 rc = active_cacheline_insert(entry);
Dan Williams0abdd7a2014-01-21 15:48:12 -0800619 if (rc == -ENOMEM) {
Dan Williams3b7a6412014-03-03 15:38:21 -0800620 pr_err("DMA-API: cacheline tracking ENOMEM, dma-debug disabled\n");
Dan Williams0abdd7a2014-01-21 15:48:12 -0800621 global_disable = true;
622 }
623
624 /* TODO: report -EEXIST errors here as overlapping mappings are
625 * not supported by the DMA API
626 */
Joerg Roedel30dfa902009-01-09 12:34:49 +0100627}
628
FUJITA Tomonorie6a1a892009-04-15 18:22:41 +0900629static struct dma_debug_entry *__dma_entry_alloc(void)
630{
631 struct dma_debug_entry *entry;
632
633 entry = list_entry(free_entries.next, struct dma_debug_entry, list);
634 list_del(&entry->list);
635 memset(entry, 0, sizeof(*entry));
636
637 num_free_entries -= 1;
638 if (num_free_entries < min_free_entries)
639 min_free_entries = num_free_entries;
640
641 return entry;
642}
643
Joerg Roedel3b1e79e2009-01-09 12:42:46 +0100644/* struct dma_entry allocator
645 *
646 * The next two functions implement the allocator for
647 * struct dma_debug_entries.
648 */
649static struct dma_debug_entry *dma_entry_alloc(void)
650{
Jakub Kicinski29cdd4e2012-04-04 03:19:10 +0200651 struct dma_debug_entry *entry;
Joerg Roedel3b1e79e2009-01-09 12:42:46 +0100652 unsigned long flags;
653
654 spin_lock_irqsave(&free_entries_lock, flags);
655
656 if (list_empty(&free_entries)) {
Joerg Roedele7ed70e2009-06-08 15:39:24 +0200657 pr_err("DMA-API: debugging out of memory - disabling\n");
Joerg Roedel3b1e79e2009-01-09 12:42:46 +0100658 global_disable = true;
Jakub Kicinski29cdd4e2012-04-04 03:19:10 +0200659 spin_unlock_irqrestore(&free_entries_lock, flags);
660 return NULL;
Joerg Roedel3b1e79e2009-01-09 12:42:46 +0100661 }
662
FUJITA Tomonorie6a1a892009-04-15 18:22:41 +0900663 entry = __dma_entry_alloc();
Joerg Roedel3b1e79e2009-01-09 12:42:46 +0100664
Jakub Kicinski29cdd4e2012-04-04 03:19:10 +0200665 spin_unlock_irqrestore(&free_entries_lock, flags);
666
David Woodhouse6c132d12009-01-19 16:52:39 +0100667#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);
672#endif
Joerg Roedel3b1e79e2009-01-09 12:42:46 +0100673
Joerg Roedel3b1e79e2009-01-09 12:42:46 +0100674 return entry;
675}
676
677static void dma_entry_free(struct dma_debug_entry *entry)
678{
679 unsigned long flags;
680
Dan Williams3b7a6412014-03-03 15:38:21 -0800681 active_cacheline_remove(entry);
Dan Williams0abdd7a2014-01-21 15:48:12 -0800682
Joerg Roedel3b1e79e2009-01-09 12:42:46 +0100683 /*
684 * add to beginning of the list - this way the entries are
685 * more likely cache hot when they are reallocated.
686 */
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);
691}
692
FUJITA Tomonorie6a1a892009-04-15 18:22:41 +0900693int dma_debug_resize_entries(u32 num_entries)
694{
695 int i, delta, ret = 0;
696 unsigned long flags;
697 struct dma_debug_entry *entry;
698 LIST_HEAD(tmp);
699
700 spin_lock_irqsave(&free_entries_lock, flags);
701
702 if (nr_total_entries < num_entries) {
703 delta = num_entries - nr_total_entries;
704
705 spin_unlock_irqrestore(&free_entries_lock, flags);
706
707 for (i = 0; i < delta; i++) {
708 entry = kzalloc(sizeof(*entry), GFP_KERNEL);
709 if (!entry)
710 break;
711
712 list_add_tail(&entry->list, &tmp);
713 }
714
715 spin_lock_irqsave(&free_entries_lock, flags);
716
717 list_splice(&tmp, &free_entries);
718 nr_total_entries += i;
719 num_free_entries += i;
720 } else {
721 delta = nr_total_entries - num_entries;
722
723 for (i = 0; i < delta && !list_empty(&free_entries); i++) {
724 entry = __dma_entry_alloc();
725 kfree(entry);
726 }
727
728 nr_total_entries -= i;
729 }
730
731 if (nr_total_entries != num_entries)
732 ret = 1;
733
734 spin_unlock_irqrestore(&free_entries_lock, flags);
735
736 return ret;
737}
738EXPORT_SYMBOL(dma_debug_resize_entries);
739
Joerg Roedel6bf07872009-01-09 12:54:42 +0100740/*
741 * DMA-API debugging init code
742 *
743 * The init code does two things:
744 * 1. Initialize core data structures
745 * 2. Preallocate a given number of dma_debug_entry structs
746 */
747
748static int prealloc_memory(u32 num_entries)
749{
750 struct dma_debug_entry *entry, *next_entry;
751 int i;
752
753 for (i = 0; i < num_entries; ++i) {
754 entry = kzalloc(sizeof(*entry), GFP_KERNEL);
755 if (!entry)
756 goto out_err;
757
758 list_add_tail(&entry->list, &free_entries);
759 }
760
761 num_free_entries = num_entries;
762 min_free_entries = num_entries;
763
Joerg Roedele7ed70e2009-06-08 15:39:24 +0200764 pr_info("DMA-API: preallocated %d debug entries\n", num_entries);
Joerg Roedel6bf07872009-01-09 12:54:42 +0100765
766 return 0;
767
768out_err:
769
770 list_for_each_entry_safe(entry, next_entry, &free_entries, list) {
771 list_del(&entry->list);
772 kfree(entry);
773 }
774
775 return -ENOMEM;
776}
777
Joerg Roedel8a6fc702009-05-22 21:23:13 +0200778static ssize_t filter_read(struct file *file, char __user *user_buf,
779 size_t count, loff_t *ppos)
780{
Joerg Roedel8a6fc702009-05-22 21:23:13 +0200781 char buf[NAME_MAX_LEN + 1];
Joerg Roedelc17e2cf2009-06-08 15:19:29 +0200782 unsigned long flags;
Joerg Roedel8a6fc702009-05-22 21:23:13 +0200783 int len;
784
785 if (!current_driver_name[0])
786 return 0;
787
788 /*
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.
792 */
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);
796
797 return simple_read_from_buffer(user_buf, count, ppos, buf, len);
798}
799
800static ssize_t filter_write(struct file *file, const char __user *userbuf,
801 size_t count, loff_t *ppos)
802{
Joerg Roedel8a6fc702009-05-22 21:23:13 +0200803 char buf[NAME_MAX_LEN];
Joerg Roedelc17e2cf2009-06-08 15:19:29 +0200804 unsigned long flags;
805 size_t len;
Joerg Roedel8a6fc702009-05-22 21:23:13 +0200806 int i;
807
808 /*
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
813 */
Joerg Roedele7ed70e2009-06-08 15:39:24 +0200814 len = min(count, (size_t)(NAME_MAX_LEN - 1));
Joerg Roedel8a6fc702009-05-22 21:23:13 +0200815 if (copy_from_user(buf, userbuf, len))
816 return -EFAULT;
817
818 buf[len] = 0;
819
820 write_lock_irqsave(&driver_name_lock, flags);
821
Joerg Roedel312325092009-06-08 15:07:08 +0200822 /*
823 * Now handle the string we got from userspace very carefully.
Joerg Roedel8a6fc702009-05-22 21:23:13 +0200824 * The rules are:
825 * - only use the first token we got
826 * - token delimiter is everything looking like a space
827 * character (' ', '\n', '\t' ...)
828 *
829 */
830 if (!isalnum(buf[0])) {
831 /*
Joerg Roedel312325092009-06-08 15:07:08 +0200832 * If the first character userspace gave us is not
Joerg Roedel8a6fc702009-05-22 21:23:13 +0200833 * alphanumerical then assume the filter should be
834 * switched off.
835 */
836 if (current_driver_name[0])
Joerg Roedele7ed70e2009-06-08 15:39:24 +0200837 pr_info("DMA-API: switching off dma-debug driver filter\n");
Joerg Roedel8a6fc702009-05-22 21:23:13 +0200838 current_driver_name[0] = 0;
839 current_driver = NULL;
840 goto out_unlock;
841 }
842
843 /*
844 * Now parse out the first token and use it as the name for the
845 * driver to filter for.
846 */
Dan Carpenter39a37ce2010-04-06 19:45:12 +0300847 for (i = 0; i < NAME_MAX_LEN - 1; ++i) {
Joerg Roedel8a6fc702009-05-22 21:23:13 +0200848 current_driver_name[i] = buf[i];
849 if (isspace(buf[i]) || buf[i] == ' ' || buf[i] == 0)
850 break;
851 }
852 current_driver_name[i] = 0;
853 current_driver = NULL;
854
Joerg Roedele7ed70e2009-06-08 15:39:24 +0200855 pr_info("DMA-API: enable driver filter for driver [%s]\n",
856 current_driver_name);
Joerg Roedel8a6fc702009-05-22 21:23:13 +0200857
858out_unlock:
859 write_unlock_irqrestore(&driver_name_lock, flags);
860
861 return count;
862}
863
Thiago Farinaaeb583d2010-01-18 18:57:33 -0500864static const struct file_operations filter_fops = {
Joerg Roedel8a6fc702009-05-22 21:23:13 +0200865 .read = filter_read,
866 .write = filter_write,
Arnd Bergmann6038f372010-08-15 18:52:59 +0200867 .llseek = default_llseek,
Joerg Roedel8a6fc702009-05-22 21:23:13 +0200868};
869
Joerg Roedel788dcfa2009-01-09 13:13:27 +0100870static int dma_debug_fs_init(void)
871{
872 dma_debug_dent = debugfs_create_dir("dma-api", NULL);
873 if (!dma_debug_dent) {
Joerg Roedele7ed70e2009-06-08 15:39:24 +0200874 pr_err("DMA-API: can not create debugfs directory\n");
Joerg Roedel788dcfa2009-01-09 13:13:27 +0100875 return -ENOMEM;
876 }
877
878 global_disable_dent = debugfs_create_bool("disabled", 0444,
879 dma_debug_dent,
Dan Carpenter68ee6d22012-06-27 12:08:55 +0300880 &global_disable);
Joerg Roedel788dcfa2009-01-09 13:13:27 +0100881 if (!global_disable_dent)
882 goto out_err;
883
884 error_count_dent = debugfs_create_u32("error_count", 0444,
885 dma_debug_dent, &error_count);
886 if (!error_count_dent)
887 goto out_err;
888
889 show_all_errors_dent = debugfs_create_u32("all_errors", 0644,
890 dma_debug_dent,
891 &show_all_errors);
892 if (!show_all_errors_dent)
893 goto out_err;
894
895 show_num_errors_dent = debugfs_create_u32("num_errors", 0644,
896 dma_debug_dent,
897 &show_num_errors);
898 if (!show_num_errors_dent)
899 goto out_err;
900
901 num_free_entries_dent = debugfs_create_u32("num_free_entries", 0444,
902 dma_debug_dent,
903 &num_free_entries);
904 if (!num_free_entries_dent)
905 goto out_err;
906
907 min_free_entries_dent = debugfs_create_u32("min_free_entries", 0444,
908 dma_debug_dent,
909 &min_free_entries);
910 if (!min_free_entries_dent)
911 goto out_err;
912
Joerg Roedel8a6fc702009-05-22 21:23:13 +0200913 filter_dent = debugfs_create_file("driver_filter", 0644,
914 dma_debug_dent, NULL, &filter_fops);
915 if (!filter_dent)
916 goto out_err;
917
Joerg Roedel788dcfa2009-01-09 13:13:27 +0100918 return 0;
919
920out_err:
921 debugfs_remove_recursive(dma_debug_dent);
922
923 return -ENOMEM;
924}
925
Stanislaw Gruszkaba4b87ad2011-03-31 08:08:09 -0400926static int device_dma_allocations(struct device *dev, struct dma_debug_entry **out_entry)
Joerg Roedeled888ae2009-05-22 17:16:04 +0200927{
928 struct dma_debug_entry *entry;
929 unsigned long flags;
930 int count = 0, i;
931
Joerg Roedelbe81c6e2009-06-08 15:46:19 +0200932 local_irq_save(flags);
933
Joerg Roedeled888ae2009-05-22 17:16:04 +0200934 for (i = 0; i < HASH_SIZE; ++i) {
Joerg Roedelbe81c6e2009-06-08 15:46:19 +0200935 spin_lock(&dma_entry_hash[i].lock);
Joerg Roedeled888ae2009-05-22 17:16:04 +0200936 list_for_each_entry(entry, &dma_entry_hash[i].list, list) {
Stanislaw Gruszkaba4b87ad2011-03-31 08:08:09 -0400937 if (entry->dev == dev) {
Joerg Roedeled888ae2009-05-22 17:16:04 +0200938 count += 1;
Stanislaw Gruszkaba4b87ad2011-03-31 08:08:09 -0400939 *out_entry = entry;
940 }
Joerg Roedeled888ae2009-05-22 17:16:04 +0200941 }
Joerg Roedelbe81c6e2009-06-08 15:46:19 +0200942 spin_unlock(&dma_entry_hash[i].lock);
Joerg Roedeled888ae2009-05-22 17:16:04 +0200943 }
944
Joerg Roedelbe81c6e2009-06-08 15:46:19 +0200945 local_irq_restore(flags);
946
Joerg Roedeled888ae2009-05-22 17:16:04 +0200947 return count;
948}
949
Ingo Molnara8fe9ea2009-12-31 15:16:23 +0100950static int dma_debug_device_change(struct notifier_block *nb, unsigned long action, void *data)
Joerg Roedeled888ae2009-05-22 17:16:04 +0200951{
952 struct device *dev = data;
Stanislaw Gruszkaba4b87ad2011-03-31 08:08:09 -0400953 struct dma_debug_entry *uninitialized_var(entry);
Joerg Roedeled888ae2009-05-22 17:16:04 +0200954 int count;
955
Florian Fainelli01ce18b2014-12-10 15:41:23 -0800956 if (dma_debug_disabled())
Ingo Molnara8fe9ea2009-12-31 15:16:23 +0100957 return 0;
Joerg Roedeled888ae2009-05-22 17:16:04 +0200958
959 switch (action) {
960 case BUS_NOTIFY_UNBOUND_DRIVER:
Stanislaw Gruszkaba4b87ad2011-03-31 08:08:09 -0400961 count = device_dma_allocations(dev, &entry);
Joerg Roedeled888ae2009-05-22 17:16:04 +0200962 if (count == 0)
963 break;
Stanislaw Gruszkaba4b87ad2011-03-31 08:08:09 -0400964 err_printk(dev, entry, "DMA-API: device driver has pending "
Joerg Roedeled888ae2009-05-22 17:16:04 +0200965 "DMA allocations while released from device "
Stanislaw Gruszkaba4b87ad2011-03-31 08:08:09 -0400966 "[count=%d]\n"
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]);
Joerg Roedeled888ae2009-05-22 17:16:04 +0200972 break;
973 default:
974 break;
975 }
976
977 return 0;
978}
979
Joerg Roedel41531c82009-03-16 17:32:14 +0100980void dma_debug_add_bus(struct bus_type *bus)
981{
Joerg Roedeled888ae2009-05-22 17:16:04 +0200982 struct notifier_block *nb;
983
Florian Fainelli01ce18b2014-12-10 15:41:23 -0800984 if (dma_debug_disabled())
Shaun Ruffellf797d982009-12-17 18:00:36 -0600985 return;
986
Joerg Roedeled888ae2009-05-22 17:16:04 +0200987 nb = kzalloc(sizeof(struct notifier_block), GFP_KERNEL);
988 if (nb == NULL) {
Joerg Roedele7ed70e2009-06-08 15:39:24 +0200989 pr_err("dma_debug_add_bus: out of memory\n");
Joerg Roedeled888ae2009-05-22 17:16:04 +0200990 return;
991 }
992
993 nb->notifier_call = dma_debug_device_change;
994
995 bus_register_notifier(bus, nb);
Joerg Roedel41531c82009-03-16 17:32:14 +0100996}
Joerg Roedel788dcfa2009-01-09 13:13:27 +0100997
Joerg Roedel6bf07872009-01-09 12:54:42 +0100998/*
999 * Let the architectures decide how many entries should be preallocated.
1000 */
1001void dma_debug_init(u32 num_entries)
1002{
1003 int i;
1004
Florian Fainelli2ce8e7e2014-12-10 15:41:25 -08001005 /* Do not use dma_debug_initialized here, since we really want to be
1006 * called to set dma_debug_initialized
1007 */
1008 if (global_disable)
Joerg Roedel6bf07872009-01-09 12:54:42 +01001009 return;
1010
1011 for (i = 0; i < HASH_SIZE; ++i) {
1012 INIT_LIST_HEAD(&dma_entry_hash[i].list);
Ingo Molnarb0a5b832009-06-16 16:11:14 +02001013 spin_lock_init(&dma_entry_hash[i].lock);
Joerg Roedel6bf07872009-01-09 12:54:42 +01001014 }
1015
Joerg Roedel788dcfa2009-01-09 13:13:27 +01001016 if (dma_debug_fs_init() != 0) {
Joerg Roedele7ed70e2009-06-08 15:39:24 +02001017 pr_err("DMA-API: error creating debugfs entries - disabling\n");
Joerg Roedel788dcfa2009-01-09 13:13:27 +01001018 global_disable = true;
1019
1020 return;
1021 }
1022
Joerg Roedel59d3daa2009-01-09 13:01:56 +01001023 if (req_entries)
1024 num_entries = req_entries;
1025
Joerg Roedel6bf07872009-01-09 12:54:42 +01001026 if (prealloc_memory(num_entries) != 0) {
Joerg Roedele7ed70e2009-06-08 15:39:24 +02001027 pr_err("DMA-API: debugging out of memory error - disabled\n");
Joerg Roedel6bf07872009-01-09 12:54:42 +01001028 global_disable = true;
1029
1030 return;
1031 }
1032
FUJITA Tomonorie6a1a892009-04-15 18:22:41 +09001033 nr_total_entries = num_free_entries;
1034
Florian Fainelli2ce8e7e2014-12-10 15:41:25 -08001035 dma_debug_initialized = true;
1036
Joerg Roedele7ed70e2009-06-08 15:39:24 +02001037 pr_info("DMA-API: debugging enabled by kernel config\n");
Joerg Roedel6bf07872009-01-09 12:54:42 +01001038}
1039
Joerg Roedel59d3daa2009-01-09 13:01:56 +01001040static __init int dma_debug_cmdline(char *str)
1041{
1042 if (!str)
1043 return -EINVAL;
1044
1045 if (strncmp(str, "off", 3) == 0) {
Joerg Roedele7ed70e2009-06-08 15:39:24 +02001046 pr_info("DMA-API: debugging disabled on kernel command line\n");
Joerg Roedel59d3daa2009-01-09 13:01:56 +01001047 global_disable = true;
1048 }
1049
1050 return 0;
1051}
1052
1053static __init int dma_debug_entries_cmdline(char *str)
1054{
1055 int res;
1056
1057 if (!str)
1058 return -EINVAL;
1059
1060 res = get_option(&str, &req_entries);
1061
1062 if (!res)
1063 req_entries = 0;
1064
1065 return 0;
1066}
1067
1068__setup("dma_debug=", dma_debug_cmdline);
1069__setup("dma_debug_entries=", dma_debug_entries_cmdline);
1070
Joerg Roedel2d62ece2009-01-09 14:10:26 +01001071static void check_unmap(struct dma_debug_entry *ref)
1072{
1073 struct dma_debug_entry *entry;
1074 struct hash_bucket *bucket;
1075 unsigned long flags;
1076
Joerg Roedel2d62ece2009-01-09 14:10:26 +01001077 bucket = get_hash_bucket(ref, &flags);
Neil Hormanc6a21d02011-08-08 15:13:54 -04001078 entry = bucket_find_exact(bucket, ref);
Joerg Roedel2d62ece2009-01-09 14:10:26 +01001079
1080 if (!entry) {
Alexander Duyck8d640a52013-03-22 15:04:48 -07001081 /* must drop lock before calling dma_mapping_error */
1082 put_hash_bucket(bucket, &flags);
1083
Shuah Khanbfe0fb02012-11-03 17:00:07 -06001084 if (dma_mapping_error(ref->dev, ref->dev_addr)) {
1085 err_printk(ref->dev, NULL,
Alexander Duyck8d640a52013-03-22 15:04:48 -07001086 "DMA-API: device driver tries to free an "
1087 "invalid DMA memory address\n");
1088 } else {
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);
Shuah Khanbfe0fb02012-11-03 17:00:07 -06001094 }
Alexander Duyck8d640a52013-03-22 15:04:48 -07001095 return;
Joerg Roedel2d62ece2009-01-09 14:10:26 +01001096 }
1097
1098 if (ref->size != entry->size) {
David Woodhouse6c132d12009-01-19 16:52:39 +01001099 err_printk(ref->dev, entry, "DMA-API: device driver frees "
Joerg Roedel2d62ece2009-01-09 14:10:26 +01001100 "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);
1104 }
1105
1106 if (ref->type != entry->type) {
David Woodhouse6c132d12009-01-19 16:52:39 +01001107 err_printk(ref->dev, entry, "DMA-API: device driver frees "
Joerg Roedel2d62ece2009-01-09 14:10:26 +01001108 "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) &&
Dan Williams0abdd7a2014-01-21 15:48:12 -08001114 (phys_addr(ref) != phys_addr(entry))) {
David Woodhouse6c132d12009-01-19 16:52:39 +01001115 err_printk(ref->dev, entry, "DMA-API: device driver frees "
Joerg Roedel2d62ece2009-01-09 14:10:26 +01001116 "DMA memory with different CPU address "
1117 "[device address=0x%016llx] [size=%llu bytes] "
Joerg Roedel59a40e702009-10-29 16:25:50 +01001118 "[cpu alloc address=0x%016llx] "
1119 "[cpu free address=0x%016llx]",
Joerg Roedel2d62ece2009-01-09 14:10:26 +01001120 ref->dev_addr, ref->size,
Dan Williams0abdd7a2014-01-21 15:48:12 -08001121 phys_addr(entry),
1122 phys_addr(ref));
Joerg Roedel2d62ece2009-01-09 14:10:26 +01001123 }
1124
1125 if (ref->sg_call_ents && ref->type == dma_debug_sg &&
1126 ref->sg_call_ents != entry->sg_call_ents) {
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 sg list with different entry count "
1129 "[map count=%d] [unmap count=%d]\n",
1130 entry->sg_call_ents, ref->sg_call_ents);
1131 }
1132
1133 /*
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
1136 */
1137 if (ref->direction != entry->direction) {
David Woodhouse6c132d12009-01-19 16:52:39 +01001138 err_printk(ref->dev, entry, "DMA-API: device driver frees "
Joerg Roedel2d62ece2009-01-09 14:10:26 +01001139 "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]);
1145 }
1146
Shuah Khan6c9c6d62012-10-08 11:08:06 -06001147 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] "
1151 "[mapped as %s]",
1152 ref->dev_addr, ref->size,
1153 type2name[entry->type]);
1154 }
1155
Joerg Roedel2d62ece2009-01-09 14:10:26 +01001156 hash_bucket_del(entry);
1157 dma_entry_free(entry);
1158
Joerg Roedel2d62ece2009-01-09 14:10:26 +01001159 put_hash_bucket(bucket, &flags);
1160}
1161
1162static void check_for_stack(struct device *dev, void *addr)
1163{
1164 if (object_is_on_stack(addr))
Horia Geantaf9134be2014-09-02 14:28:14 +03001165 err_printk(dev, NULL, "DMA-API: device driver maps memory from "
David Woodhouse6c132d12009-01-19 16:52:39 +01001166 "stack [addr=%p]\n", addr);
Joerg Roedel2d62ece2009-01-09 14:10:26 +01001167}
1168
Ingo Molnarf39d1b92009-07-10 21:38:02 +02001169static inline bool overlap(void *addr, unsigned long len, void *start, void *end)
Joerg Roedel2e34bde2009-03-16 16:51:55 +01001170{
Ingo Molnarf39d1b92009-07-10 21:38:02 +02001171 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;
Joerg Roedel2e34bde2009-03-16 16:51:55 +01001175
Ingo Molnarf39d1b92009-07-10 21:38:02 +02001176 return !(b1 <= a2 || a1 >= b2);
Joerg Roedel2e34bde2009-03-16 16:51:55 +01001177}
1178
Ingo Molnarf39d1b92009-07-10 21:38:02 +02001179static void check_for_illegal_area(struct device *dev, void *addr, unsigned long len)
Joerg Roedel2e34bde2009-03-16 16:51:55 +01001180{
Ingo Molnarf39d1b92009-07-10 21:38:02 +02001181 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);
Joerg Roedel2e34bde2009-03-16 16:51:55 +01001184}
1185
Joerg Roedelaa010ef2009-06-12 15:25:06 +02001186static void check_sync(struct device *dev,
1187 struct dma_debug_entry *ref,
1188 bool to_cpu)
Joerg Roedel2d62ece2009-01-09 14:10:26 +01001189{
Joerg Roedel2d62ece2009-01-09 14:10:26 +01001190 struct dma_debug_entry *entry;
1191 struct hash_bucket *bucket;
1192 unsigned long flags;
1193
Joerg Roedelaa010ef2009-06-12 15:25:06 +02001194 bucket = get_hash_bucket(ref, &flags);
Joerg Roedel2d62ece2009-01-09 14:10:26 +01001195
Neil Hormanc6a21d02011-08-08 15:13:54 -04001196 entry = bucket_find_contain(&bucket, ref, &flags);
Joerg Roedel2d62ece2009-01-09 14:10:26 +01001197
1198 if (!entry) {
David Woodhouse6c132d12009-01-19 16:52:39 +01001199 err_printk(dev, NULL, "DMA-API: device driver tries "
Joerg Roedel2d62ece2009-01-09 14:10:26 +01001200 "to sync DMA memory it has not allocated "
1201 "[device address=0x%016llx] [size=%llu bytes]\n",
Joerg Roedelaa010ef2009-06-12 15:25:06 +02001202 (unsigned long long)ref->dev_addr, ref->size);
Joerg Roedel2d62ece2009-01-09 14:10:26 +01001203 goto out;
1204 }
1205
Joerg Roedelaa010ef2009-06-12 15:25:06 +02001206 if (ref->size > entry->size) {
David Woodhouse6c132d12009-01-19 16:52:39 +01001207 err_printk(dev, entry, "DMA-API: device driver syncs"
Joerg Roedel2d62ece2009-01-09 14:10:26 +01001208 " DMA memory outside allocated range "
1209 "[device address=0x%016llx] "
Joerg Roedelaa010ef2009-06-12 15:25:06 +02001210 "[allocation size=%llu bytes] "
1211 "[sync offset+size=%llu]\n",
1212 entry->dev_addr, entry->size,
1213 ref->size);
Joerg Roedel2d62ece2009-01-09 14:10:26 +01001214 }
1215
Krzysztof Halasa42d53b42010-01-08 14:42:36 -08001216 if (entry->direction == DMA_BIDIRECTIONAL)
1217 goto out;
1218
Joerg Roedelaa010ef2009-06-12 15:25:06 +02001219 if (ref->direction != entry->direction) {
David Woodhouse6c132d12009-01-19 16:52:39 +01001220 err_printk(dev, entry, "DMA-API: device driver syncs "
Joerg Roedel2d62ece2009-01-09 14:10:26 +01001221 "DMA memory with different direction "
1222 "[device address=0x%016llx] [size=%llu bytes] "
1223 "[mapped with %s] [synced with %s]\n",
Joerg Roedelaa010ef2009-06-12 15:25:06 +02001224 (unsigned long long)ref->dev_addr, entry->size,
Joerg Roedel2d62ece2009-01-09 14:10:26 +01001225 dir2name[entry->direction],
Joerg Roedelaa010ef2009-06-12 15:25:06 +02001226 dir2name[ref->direction]);
Joerg Roedel2d62ece2009-01-09 14:10:26 +01001227 }
1228
Joerg Roedel2d62ece2009-01-09 14:10:26 +01001229 if (to_cpu && !(entry->direction == DMA_FROM_DEVICE) &&
Joerg Roedelaa010ef2009-06-12 15:25:06 +02001230 !(ref->direction == DMA_TO_DEVICE))
David Woodhouse6c132d12009-01-19 16:52:39 +01001231 err_printk(dev, entry, "DMA-API: device driver syncs "
Joerg Roedel2d62ece2009-01-09 14:10:26 +01001232 "device read-only DMA memory for cpu "
1233 "[device address=0x%016llx] [size=%llu bytes] "
1234 "[mapped with %s] [synced with %s]\n",
Joerg Roedelaa010ef2009-06-12 15:25:06 +02001235 (unsigned long long)ref->dev_addr, entry->size,
Joerg Roedel2d62ece2009-01-09 14:10:26 +01001236 dir2name[entry->direction],
Joerg Roedelaa010ef2009-06-12 15:25:06 +02001237 dir2name[ref->direction]);
Joerg Roedel2d62ece2009-01-09 14:10:26 +01001238
1239 if (!to_cpu && !(entry->direction == DMA_TO_DEVICE) &&
Joerg Roedelaa010ef2009-06-12 15:25:06 +02001240 !(ref->direction == DMA_FROM_DEVICE))
David Woodhouse6c132d12009-01-19 16:52:39 +01001241 err_printk(dev, entry, "DMA-API: device driver syncs "
Joerg Roedel2d62ece2009-01-09 14:10:26 +01001242 "device write-only DMA memory to device "
1243 "[device address=0x%016llx] [size=%llu bytes] "
1244 "[mapped with %s] [synced with %s]\n",
Joerg Roedelaa010ef2009-06-12 15:25:06 +02001245 (unsigned long long)ref->dev_addr, entry->size,
Joerg Roedel2d62ece2009-01-09 14:10:26 +01001246 dir2name[entry->direction],
Joerg Roedelaa010ef2009-06-12 15:25:06 +02001247 dir2name[ref->direction]);
Joerg Roedel2d62ece2009-01-09 14:10:26 +01001248
1249out:
1250 put_hash_bucket(bucket, &flags);
Joerg Roedel2d62ece2009-01-09 14:10:26 +01001251}
1252
Joerg Roedelf62bc982009-01-09 14:14:49 +01001253void debug_dma_map_page(struct device *dev, struct page *page, size_t offset,
1254 size_t size, int direction, dma_addr_t dma_addr,
1255 bool map_single)
1256{
1257 struct dma_debug_entry *entry;
1258
Florian Fainelli01ce18b2014-12-10 15:41:23 -08001259 if (unlikely(dma_debug_disabled()))
Joerg Roedelf62bc982009-01-09 14:14:49 +01001260 return;
1261
Shuah Khanbfe0fb02012-11-03 17:00:07 -06001262 if (dma_mapping_error(dev, dma_addr))
Joerg Roedelf62bc982009-01-09 14:14:49 +01001263 return;
1264
1265 entry = dma_entry_alloc();
1266 if (!entry)
1267 return;
1268
1269 entry->dev = dev;
1270 entry->type = dma_debug_page;
Dan Williams0abdd7a2014-01-21 15:48:12 -08001271 entry->pfn = page_to_pfn(page);
1272 entry->offset = offset,
Joerg Roedelf62bc982009-01-09 14:14:49 +01001273 entry->dev_addr = dma_addr;
1274 entry->size = size;
1275 entry->direction = direction;
Shuah Khan6c9c6d62012-10-08 11:08:06 -06001276 entry->map_err_type = MAP_ERR_NOT_CHECKED;
Joerg Roedelf62bc982009-01-09 14:14:49 +01001277
Joerg Roedel9537a482009-03-23 15:35:08 +01001278 if (map_single)
Joerg Roedelf62bc982009-01-09 14:14:49 +01001279 entry->type = dma_debug_single;
Joerg Roedel9537a482009-03-23 15:35:08 +01001280
1281 if (!PageHighMem(page)) {
Ingo Molnarf39d1b92009-07-10 21:38:02 +02001282 void *addr = page_address(page) + offset;
1283
Joerg Roedel2e34bde2009-03-16 16:51:55 +01001284 check_for_stack(dev, addr);
1285 check_for_illegal_area(dev, addr, size);
Joerg Roedelf62bc982009-01-09 14:14:49 +01001286 }
1287
1288 add_dma_entry(entry);
1289}
1290EXPORT_SYMBOL(debug_dma_map_page);
1291
Shuah Khan6c9c6d62012-10-08 11:08:06 -06001292void debug_dma_mapping_error(struct device *dev, dma_addr_t dma_addr)
1293{
1294 struct dma_debug_entry ref;
1295 struct dma_debug_entry *entry;
1296 struct hash_bucket *bucket;
1297 unsigned long flags;
1298
Florian Fainelli01ce18b2014-12-10 15:41:23 -08001299 if (unlikely(dma_debug_disabled()))
Shuah Khan6c9c6d62012-10-08 11:08:06 -06001300 return;
1301
1302 ref.dev = dev;
1303 ref.dev_addr = dma_addr;
1304 bucket = get_hash_bucket(&ref, &flags);
Shuah Khan6c9c6d62012-10-08 11:08:06 -06001305
Alexander Duyck96e7d7a2013-03-22 15:04:49 -07001306 list_for_each_entry(entry, &bucket->list, list) {
1307 if (!exact_match(&ref, entry))
1308 continue;
Shuah Khan6c9c6d62012-10-08 11:08:06 -06001309
Alexander Duyck96e7d7a2013-03-22 15:04:49 -07001310 /*
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.
1319 */
1320 if (entry->map_err_type == MAP_ERR_NOT_CHECKED) {
1321 entry->map_err_type = MAP_ERR_CHECKED;
1322 break;
1323 }
1324 }
1325
Shuah Khan6c9c6d62012-10-08 11:08:06 -06001326 put_hash_bucket(bucket, &flags);
1327}
1328EXPORT_SYMBOL(debug_dma_mapping_error);
1329
Joerg Roedelf62bc982009-01-09 14:14:49 +01001330void debug_dma_unmap_page(struct device *dev, dma_addr_t addr,
1331 size_t size, int direction, bool map_single)
1332{
1333 struct dma_debug_entry ref = {
1334 .type = dma_debug_page,
1335 .dev = dev,
1336 .dev_addr = addr,
1337 .size = size,
1338 .direction = direction,
1339 };
1340
Florian Fainelli01ce18b2014-12-10 15:41:23 -08001341 if (unlikely(dma_debug_disabled()))
Joerg Roedelf62bc982009-01-09 14:14:49 +01001342 return;
1343
1344 if (map_single)
1345 ref.type = dma_debug_single;
1346
1347 check_unmap(&ref);
1348}
1349EXPORT_SYMBOL(debug_dma_unmap_page);
1350
Joerg Roedel972aa452009-01-09 14:19:54 +01001351void debug_dma_map_sg(struct device *dev, struct scatterlist *sg,
1352 int nents, int mapped_ents, int direction)
1353{
1354 struct dma_debug_entry *entry;
1355 struct scatterlist *s;
1356 int i;
1357
Florian Fainelli01ce18b2014-12-10 15:41:23 -08001358 if (unlikely(dma_debug_disabled()))
Joerg Roedel972aa452009-01-09 14:19:54 +01001359 return;
1360
1361 for_each_sg(sg, s, mapped_ents, i) {
1362 entry = dma_entry_alloc();
1363 if (!entry)
1364 return;
1365
1366 entry->type = dma_debug_sg;
1367 entry->dev = dev;
Dan Williams0abdd7a2014-01-21 15:48:12 -08001368 entry->pfn = page_to_pfn(sg_page(s));
1369 entry->offset = s->offset,
FUJITA Tomonori884d0592009-05-27 09:43:02 +09001370 entry->size = sg_dma_len(s);
FUJITA Tomonori15aedea42009-05-27 09:43:01 +09001371 entry->dev_addr = sg_dma_address(s);
Joerg Roedel972aa452009-01-09 14:19:54 +01001372 entry->direction = direction;
1373 entry->sg_call_ents = nents;
1374 entry->sg_mapped_ents = mapped_ents;
1375
Joerg Roedel9537a482009-03-23 15:35:08 +01001376 if (!PageHighMem(sg_page(s))) {
1377 check_for_stack(dev, sg_virt(s));
FUJITA Tomonori884d0592009-05-27 09:43:02 +09001378 check_for_illegal_area(dev, sg_virt(s), sg_dma_len(s));
Joerg Roedel9537a482009-03-23 15:35:08 +01001379 }
Joerg Roedel972aa452009-01-09 14:19:54 +01001380
1381 add_dma_entry(entry);
1382 }
1383}
1384EXPORT_SYMBOL(debug_dma_map_sg);
1385
Joerg Roedelaa010ef2009-06-12 15:25:06 +02001386static int get_nr_mapped_entries(struct device *dev,
1387 struct dma_debug_entry *ref)
FUJITA Tomonori88f39072009-05-27 09:43:03 +09001388{
Joerg Roedelaa010ef2009-06-12 15:25:06 +02001389 struct dma_debug_entry *entry;
FUJITA Tomonori88f39072009-05-27 09:43:03 +09001390 struct hash_bucket *bucket;
1391 unsigned long flags;
Joerg Roedelc17e2cf2009-06-08 15:19:29 +02001392 int mapped_ents;
FUJITA Tomonori88f39072009-05-27 09:43:03 +09001393
Joerg Roedelaa010ef2009-06-12 15:25:06 +02001394 bucket = get_hash_bucket(ref, &flags);
Neil Hormanc6a21d02011-08-08 15:13:54 -04001395 entry = bucket_find_exact(bucket, ref);
Joerg Roedelc17e2cf2009-06-08 15:19:29 +02001396 mapped_ents = 0;
1397
FUJITA Tomonori88f39072009-05-27 09:43:03 +09001398 if (entry)
1399 mapped_ents = entry->sg_mapped_ents;
1400 put_hash_bucket(bucket, &flags);
1401
1402 return mapped_ents;
1403}
1404
Joerg Roedel972aa452009-01-09 14:19:54 +01001405void debug_dma_unmap_sg(struct device *dev, struct scatterlist *sglist,
1406 int nelems, int dir)
1407{
Joerg Roedel972aa452009-01-09 14:19:54 +01001408 struct scatterlist *s;
1409 int mapped_ents = 0, i;
Joerg Roedel972aa452009-01-09 14:19:54 +01001410
Florian Fainelli01ce18b2014-12-10 15:41:23 -08001411 if (unlikely(dma_debug_disabled()))
Joerg Roedel972aa452009-01-09 14:19:54 +01001412 return;
1413
1414 for_each_sg(sglist, s, nelems, i) {
1415
1416 struct dma_debug_entry ref = {
1417 .type = dma_debug_sg,
1418 .dev = dev,
Dan Williams0abdd7a2014-01-21 15:48:12 -08001419 .pfn = page_to_pfn(sg_page(s)),
1420 .offset = s->offset,
FUJITA Tomonori15aedea42009-05-27 09:43:01 +09001421 .dev_addr = sg_dma_address(s),
FUJITA Tomonori884d0592009-05-27 09:43:02 +09001422 .size = sg_dma_len(s),
Joerg Roedel972aa452009-01-09 14:19:54 +01001423 .direction = dir,
Joerg Roedele5e8c5b2009-06-11 10:03:42 +02001424 .sg_call_ents = nelems,
Joerg Roedel972aa452009-01-09 14:19:54 +01001425 };
1426
1427 if (mapped_ents && i >= mapped_ents)
1428 break;
1429
Joerg Roedele5e8c5b2009-06-11 10:03:42 +02001430 if (!i)
Joerg Roedelaa010ef2009-06-12 15:25:06 +02001431 mapped_ents = get_nr_mapped_entries(dev, &ref);
Joerg Roedel972aa452009-01-09 14:19:54 +01001432
1433 check_unmap(&ref);
1434 }
1435}
1436EXPORT_SYMBOL(debug_dma_unmap_sg);
1437
Joerg Roedel6bfd4492009-01-09 14:38:50 +01001438void debug_dma_alloc_coherent(struct device *dev, size_t size,
1439 dma_addr_t dma_addr, void *virt)
1440{
1441 struct dma_debug_entry *entry;
1442
Florian Fainelli01ce18b2014-12-10 15:41:23 -08001443 if (unlikely(dma_debug_disabled()))
Joerg Roedel6bfd4492009-01-09 14:38:50 +01001444 return;
1445
1446 if (unlikely(virt == NULL))
1447 return;
1448
1449 entry = dma_entry_alloc();
1450 if (!entry)
1451 return;
1452
1453 entry->type = dma_debug_coherent;
1454 entry->dev = dev;
Dan Williams0abdd7a2014-01-21 15:48:12 -08001455 entry->pfn = page_to_pfn(virt_to_page(virt));
1456 entry->offset = (size_t) virt & PAGE_MASK;
Joerg Roedel6bfd4492009-01-09 14:38:50 +01001457 entry->size = size;
1458 entry->dev_addr = dma_addr;
1459 entry->direction = DMA_BIDIRECTIONAL;
1460
1461 add_dma_entry(entry);
1462}
1463EXPORT_SYMBOL(debug_dma_alloc_coherent);
1464
1465void debug_dma_free_coherent(struct device *dev, size_t size,
1466 void *virt, dma_addr_t addr)
1467{
1468 struct dma_debug_entry ref = {
1469 .type = dma_debug_coherent,
1470 .dev = dev,
Dan Williams0abdd7a2014-01-21 15:48:12 -08001471 .pfn = page_to_pfn(virt_to_page(virt)),
1472 .offset = (size_t) virt & PAGE_MASK,
Joerg Roedel6bfd4492009-01-09 14:38:50 +01001473 .dev_addr = addr,
1474 .size = size,
1475 .direction = DMA_BIDIRECTIONAL,
1476 };
1477
Florian Fainelli01ce18b2014-12-10 15:41:23 -08001478 if (unlikely(dma_debug_disabled()))
Joerg Roedel6bfd4492009-01-09 14:38:50 +01001479 return;
1480
1481 check_unmap(&ref);
1482}
1483EXPORT_SYMBOL(debug_dma_free_coherent);
1484
Joerg Roedelb9d23172009-01-09 14:43:04 +01001485void debug_dma_sync_single_for_cpu(struct device *dev, dma_addr_t dma_handle,
1486 size_t size, int direction)
1487{
Joerg Roedelaa010ef2009-06-12 15:25:06 +02001488 struct dma_debug_entry ref;
1489
Florian Fainelli01ce18b2014-12-10 15:41:23 -08001490 if (unlikely(dma_debug_disabled()))
Joerg Roedelb9d23172009-01-09 14:43:04 +01001491 return;
1492
Joerg Roedelaa010ef2009-06-12 15:25:06 +02001493 ref.type = dma_debug_single;
1494 ref.dev = dev;
1495 ref.dev_addr = dma_handle;
1496 ref.size = size;
1497 ref.direction = direction;
1498 ref.sg_call_ents = 0;
1499
1500 check_sync(dev, &ref, true);
Joerg Roedelb9d23172009-01-09 14:43:04 +01001501}
1502EXPORT_SYMBOL(debug_dma_sync_single_for_cpu);
1503
1504void debug_dma_sync_single_for_device(struct device *dev,
1505 dma_addr_t dma_handle, size_t size,
1506 int direction)
1507{
Joerg Roedelaa010ef2009-06-12 15:25:06 +02001508 struct dma_debug_entry ref;
1509
Florian Fainelli01ce18b2014-12-10 15:41:23 -08001510 if (unlikely(dma_debug_disabled()))
Joerg Roedelb9d23172009-01-09 14:43:04 +01001511 return;
1512
Joerg Roedelaa010ef2009-06-12 15:25:06 +02001513 ref.type = dma_debug_single;
1514 ref.dev = dev;
1515 ref.dev_addr = dma_handle;
1516 ref.size = size;
1517 ref.direction = direction;
1518 ref.sg_call_ents = 0;
1519
1520 check_sync(dev, &ref, false);
Joerg Roedelb9d23172009-01-09 14:43:04 +01001521}
1522EXPORT_SYMBOL(debug_dma_sync_single_for_device);
1523
Joerg Roedel948408b2009-01-09 14:55:38 +01001524void debug_dma_sync_single_range_for_cpu(struct device *dev,
1525 dma_addr_t dma_handle,
1526 unsigned long offset, size_t size,
1527 int direction)
1528{
Joerg Roedelaa010ef2009-06-12 15:25:06 +02001529 struct dma_debug_entry ref;
1530
Florian Fainelli01ce18b2014-12-10 15:41:23 -08001531 if (unlikely(dma_debug_disabled()))
Joerg Roedel948408b2009-01-09 14:55:38 +01001532 return;
1533
Joerg Roedelaa010ef2009-06-12 15:25:06 +02001534 ref.type = dma_debug_single;
1535 ref.dev = dev;
1536 ref.dev_addr = dma_handle;
1537 ref.size = offset + size;
1538 ref.direction = direction;
1539 ref.sg_call_ents = 0;
1540
1541 check_sync(dev, &ref, true);
Joerg Roedel948408b2009-01-09 14:55:38 +01001542}
1543EXPORT_SYMBOL(debug_dma_sync_single_range_for_cpu);
1544
1545void 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)
1549{
Joerg Roedelaa010ef2009-06-12 15:25:06 +02001550 struct dma_debug_entry ref;
1551
Florian Fainelli01ce18b2014-12-10 15:41:23 -08001552 if (unlikely(dma_debug_disabled()))
Joerg Roedel948408b2009-01-09 14:55:38 +01001553 return;
1554
Joerg Roedelaa010ef2009-06-12 15:25:06 +02001555 ref.type = dma_debug_single;
1556 ref.dev = dev;
1557 ref.dev_addr = dma_handle;
1558 ref.size = offset + size;
1559 ref.direction = direction;
1560 ref.sg_call_ents = 0;
1561
1562 check_sync(dev, &ref, false);
Joerg Roedel948408b2009-01-09 14:55:38 +01001563}
1564EXPORT_SYMBOL(debug_dma_sync_single_range_for_device);
1565
Joerg Roedela31fba52009-01-09 15:01:12 +01001566void debug_dma_sync_sg_for_cpu(struct device *dev, struct scatterlist *sg,
1567 int nelems, int direction)
1568{
1569 struct scatterlist *s;
FUJITA Tomonori88f39072009-05-27 09:43:03 +09001570 int mapped_ents = 0, i;
Joerg Roedela31fba52009-01-09 15:01:12 +01001571
Florian Fainelli01ce18b2014-12-10 15:41:23 -08001572 if (unlikely(dma_debug_disabled()))
Joerg Roedela31fba52009-01-09 15:01:12 +01001573 return;
1574
1575 for_each_sg(sg, s, nelems, i) {
Joerg Roedelaa010ef2009-06-12 15:25:06 +02001576
1577 struct dma_debug_entry ref = {
1578 .type = dma_debug_sg,
1579 .dev = dev,
Dan Williams0abdd7a2014-01-21 15:48:12 -08001580 .pfn = page_to_pfn(sg_page(s)),
1581 .offset = s->offset,
Joerg Roedelaa010ef2009-06-12 15:25:06 +02001582 .dev_addr = sg_dma_address(s),
1583 .size = sg_dma_len(s),
1584 .direction = direction,
1585 .sg_call_ents = nelems,
1586 };
1587
FUJITA Tomonori88f39072009-05-27 09:43:03 +09001588 if (!i)
Joerg Roedelaa010ef2009-06-12 15:25:06 +02001589 mapped_ents = get_nr_mapped_entries(dev, &ref);
FUJITA Tomonori88f39072009-05-27 09:43:03 +09001590
1591 if (i >= mapped_ents)
1592 break;
1593
Joerg Roedelaa010ef2009-06-12 15:25:06 +02001594 check_sync(dev, &ref, true);
Joerg Roedela31fba52009-01-09 15:01:12 +01001595 }
1596}
1597EXPORT_SYMBOL(debug_dma_sync_sg_for_cpu);
1598
1599void debug_dma_sync_sg_for_device(struct device *dev, struct scatterlist *sg,
1600 int nelems, int direction)
1601{
1602 struct scatterlist *s;
FUJITA Tomonori88f39072009-05-27 09:43:03 +09001603 int mapped_ents = 0, i;
Joerg Roedela31fba52009-01-09 15:01:12 +01001604
Florian Fainelli01ce18b2014-12-10 15:41:23 -08001605 if (unlikely(dma_debug_disabled()))
Joerg Roedela31fba52009-01-09 15:01:12 +01001606 return;
1607
1608 for_each_sg(sg, s, nelems, i) {
Joerg Roedelaa010ef2009-06-12 15:25:06 +02001609
1610 struct dma_debug_entry ref = {
1611 .type = dma_debug_sg,
1612 .dev = dev,
Dan Williams0abdd7a2014-01-21 15:48:12 -08001613 .pfn = page_to_pfn(sg_page(s)),
1614 .offset = s->offset,
Joerg Roedelaa010ef2009-06-12 15:25:06 +02001615 .dev_addr = sg_dma_address(s),
1616 .size = sg_dma_len(s),
1617 .direction = direction,
1618 .sg_call_ents = nelems,
1619 };
FUJITA Tomonori88f39072009-05-27 09:43:03 +09001620 if (!i)
Joerg Roedelaa010ef2009-06-12 15:25:06 +02001621 mapped_ents = get_nr_mapped_entries(dev, &ref);
FUJITA Tomonori88f39072009-05-27 09:43:03 +09001622
1623 if (i >= mapped_ents)
1624 break;
1625
Joerg Roedelaa010ef2009-06-12 15:25:06 +02001626 check_sync(dev, &ref, false);
Joerg Roedela31fba52009-01-09 15:01:12 +01001627 }
1628}
1629EXPORT_SYMBOL(debug_dma_sync_sg_for_device);
1630
Joerg Roedel1745de52009-05-22 21:49:51 +02001631static int __init dma_debug_driver_setup(char *str)
1632{
1633 int i;
1634
1635 for (i = 0; i < NAME_MAX_LEN - 1; ++i, ++str) {
1636 current_driver_name[i] = *str;
1637 if (*str == 0)
1638 break;
1639 }
1640
1641 if (current_driver_name[0])
Joerg Roedele7ed70e2009-06-08 15:39:24 +02001642 pr_info("DMA-API: enable driver filter for driver [%s]\n",
1643 current_driver_name);
Joerg Roedel1745de52009-05-22 21:49:51 +02001644
1645
1646 return 1;
1647}
1648__setup("dma_debug_driver=", dma_debug_driver_setup);