blob: dace71fe41f707457468ec1ca3f8d94f756313a8 [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) {
Sebastian Otta7a2c02a42015-04-16 12:43:25 -0700364 entry = __hash_bucket_find(*bucket, ref, containing_match);
Neil Hormanc6a21d02011-08-08 15:13:54 -0400365
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
Haggai Eranc9d120b2015-07-17 16:24:06 -0700577 if (dma_debug_disabled())
578 return;
579
Dan Williams0abdd7a2014-01-21 15:48:12 -0800580 if (!page)
581 return;
582
Dan Williams3b7a6412014-03-03 15:38:21 -0800583 cln = (phys_addr_t) page_to_pfn(page) << CACHELINE_PER_PAGE_SHIFT;
Dan Williams0abdd7a2014-01-21 15:48:12 -0800584 spin_lock_irqsave(&radix_lock, flags);
Dan Williams3b7a6412014-03-03 15:38:21 -0800585 nents = radix_tree_gang_lookup(&dma_active_cacheline, results, cln,
586 CACHELINES_PER_PAGE);
587 for (i = 0; i < nents; i++) {
588 phys_addr_t ent_cln = to_cacheline_number(ents[i]);
589
590 if (ent_cln == cln) {
591 entry = ents[i];
592 break;
593 } else if (ent_cln >= cln + CACHELINES_PER_PAGE)
594 break;
595 }
Dan Williams0abdd7a2014-01-21 15:48:12 -0800596 spin_unlock_irqrestore(&radix_lock, flags);
597
598 if (!entry)
599 return;
600
Dan Williams3b7a6412014-03-03 15:38:21 -0800601 cln = to_cacheline_number(entry);
Dan Williams0abdd7a2014-01-21 15:48:12 -0800602 err_printk(entry->dev, entry,
Dan Williams3b7a6412014-03-03 15:38:21 -0800603 "DMA-API: cpu touching an active dma mapped cacheline [cln=%pa]\n",
604 &cln);
Dan Williams0abdd7a2014-01-21 15:48:12 -0800605}
606
607/*
Joerg Roedel30dfa902009-01-09 12:34:49 +0100608 * Wrapper function for adding an entry to the hash.
609 * This function takes care of locking itself.
610 */
611static void add_dma_entry(struct dma_debug_entry *entry)
612{
613 struct hash_bucket *bucket;
614 unsigned long flags;
Dan Williams0abdd7a2014-01-21 15:48:12 -0800615 int rc;
Joerg Roedel30dfa902009-01-09 12:34:49 +0100616
617 bucket = get_hash_bucket(entry, &flags);
618 hash_bucket_add(bucket, entry);
619 put_hash_bucket(bucket, &flags);
Dan Williams0abdd7a2014-01-21 15:48:12 -0800620
Dan Williams3b7a6412014-03-03 15:38:21 -0800621 rc = active_cacheline_insert(entry);
Dan Williams0abdd7a2014-01-21 15:48:12 -0800622 if (rc == -ENOMEM) {
Dan Williams3b7a6412014-03-03 15:38:21 -0800623 pr_err("DMA-API: cacheline tracking ENOMEM, dma-debug disabled\n");
Dan Williams0abdd7a2014-01-21 15:48:12 -0800624 global_disable = true;
625 }
626
627 /* TODO: report -EEXIST errors here as overlapping mappings are
628 * not supported by the DMA API
629 */
Joerg Roedel30dfa902009-01-09 12:34:49 +0100630}
631
FUJITA Tomonorie6a1a892009-04-15 18:22:41 +0900632static struct dma_debug_entry *__dma_entry_alloc(void)
633{
634 struct dma_debug_entry *entry;
635
636 entry = list_entry(free_entries.next, struct dma_debug_entry, list);
637 list_del(&entry->list);
638 memset(entry, 0, sizeof(*entry));
639
640 num_free_entries -= 1;
641 if (num_free_entries < min_free_entries)
642 min_free_entries = num_free_entries;
643
644 return entry;
645}
646
Joerg Roedel3b1e79e2009-01-09 12:42:46 +0100647/* struct dma_entry allocator
648 *
649 * The next two functions implement the allocator for
650 * struct dma_debug_entries.
651 */
652static struct dma_debug_entry *dma_entry_alloc(void)
653{
Jakub Kicinski29cdd4e2012-04-04 03:19:10 +0200654 struct dma_debug_entry *entry;
Joerg Roedel3b1e79e2009-01-09 12:42:46 +0100655 unsigned long flags;
656
657 spin_lock_irqsave(&free_entries_lock, flags);
658
659 if (list_empty(&free_entries)) {
Joerg Roedele7ed70e2009-06-08 15:39:24 +0200660 pr_err("DMA-API: debugging out of memory - disabling\n");
Joerg Roedel3b1e79e2009-01-09 12:42:46 +0100661 global_disable = true;
Jakub Kicinski29cdd4e2012-04-04 03:19:10 +0200662 spin_unlock_irqrestore(&free_entries_lock, flags);
663 return NULL;
Joerg Roedel3b1e79e2009-01-09 12:42:46 +0100664 }
665
FUJITA Tomonorie6a1a892009-04-15 18:22:41 +0900666 entry = __dma_entry_alloc();
Joerg Roedel3b1e79e2009-01-09 12:42:46 +0100667
Jakub Kicinski29cdd4e2012-04-04 03:19:10 +0200668 spin_unlock_irqrestore(&free_entries_lock, flags);
669
David Woodhouse6c132d12009-01-19 16:52:39 +0100670#ifdef CONFIG_STACKTRACE
671 entry->stacktrace.max_entries = DMA_DEBUG_STACKTRACE_ENTRIES;
672 entry->stacktrace.entries = entry->st_entries;
673 entry->stacktrace.skip = 2;
674 save_stack_trace(&entry->stacktrace);
675#endif
Joerg Roedel3b1e79e2009-01-09 12:42:46 +0100676
Joerg Roedel3b1e79e2009-01-09 12:42:46 +0100677 return entry;
678}
679
680static void dma_entry_free(struct dma_debug_entry *entry)
681{
682 unsigned long flags;
683
Dan Williams3b7a6412014-03-03 15:38:21 -0800684 active_cacheline_remove(entry);
Dan Williams0abdd7a2014-01-21 15:48:12 -0800685
Joerg Roedel3b1e79e2009-01-09 12:42:46 +0100686 /*
687 * add to beginning of the list - this way the entries are
688 * more likely cache hot when they are reallocated.
689 */
690 spin_lock_irqsave(&free_entries_lock, flags);
691 list_add(&entry->list, &free_entries);
692 num_free_entries += 1;
693 spin_unlock_irqrestore(&free_entries_lock, flags);
694}
695
FUJITA Tomonorie6a1a892009-04-15 18:22:41 +0900696int dma_debug_resize_entries(u32 num_entries)
697{
698 int i, delta, ret = 0;
699 unsigned long flags;
700 struct dma_debug_entry *entry;
701 LIST_HEAD(tmp);
702
703 spin_lock_irqsave(&free_entries_lock, flags);
704
705 if (nr_total_entries < num_entries) {
706 delta = num_entries - nr_total_entries;
707
708 spin_unlock_irqrestore(&free_entries_lock, flags);
709
710 for (i = 0; i < delta; i++) {
711 entry = kzalloc(sizeof(*entry), GFP_KERNEL);
712 if (!entry)
713 break;
714
715 list_add_tail(&entry->list, &tmp);
716 }
717
718 spin_lock_irqsave(&free_entries_lock, flags);
719
720 list_splice(&tmp, &free_entries);
721 nr_total_entries += i;
722 num_free_entries += i;
723 } else {
724 delta = nr_total_entries - num_entries;
725
726 for (i = 0; i < delta && !list_empty(&free_entries); i++) {
727 entry = __dma_entry_alloc();
728 kfree(entry);
729 }
730
731 nr_total_entries -= i;
732 }
733
734 if (nr_total_entries != num_entries)
735 ret = 1;
736
737 spin_unlock_irqrestore(&free_entries_lock, flags);
738
739 return ret;
740}
741EXPORT_SYMBOL(dma_debug_resize_entries);
742
Joerg Roedel6bf07872009-01-09 12:54:42 +0100743/*
744 * DMA-API debugging init code
745 *
746 * The init code does two things:
747 * 1. Initialize core data structures
748 * 2. Preallocate a given number of dma_debug_entry structs
749 */
750
751static int prealloc_memory(u32 num_entries)
752{
753 struct dma_debug_entry *entry, *next_entry;
754 int i;
755
756 for (i = 0; i < num_entries; ++i) {
757 entry = kzalloc(sizeof(*entry), GFP_KERNEL);
758 if (!entry)
759 goto out_err;
760
761 list_add_tail(&entry->list, &free_entries);
762 }
763
764 num_free_entries = num_entries;
765 min_free_entries = num_entries;
766
Joerg Roedele7ed70e2009-06-08 15:39:24 +0200767 pr_info("DMA-API: preallocated %d debug entries\n", num_entries);
Joerg Roedel6bf07872009-01-09 12:54:42 +0100768
769 return 0;
770
771out_err:
772
773 list_for_each_entry_safe(entry, next_entry, &free_entries, list) {
774 list_del(&entry->list);
775 kfree(entry);
776 }
777
778 return -ENOMEM;
779}
780
Joerg Roedel8a6fc702009-05-22 21:23:13 +0200781static ssize_t filter_read(struct file *file, char __user *user_buf,
782 size_t count, loff_t *ppos)
783{
Joerg Roedel8a6fc702009-05-22 21:23:13 +0200784 char buf[NAME_MAX_LEN + 1];
Joerg Roedelc17e2cf2009-06-08 15:19:29 +0200785 unsigned long flags;
Joerg Roedel8a6fc702009-05-22 21:23:13 +0200786 int len;
787
788 if (!current_driver_name[0])
789 return 0;
790
791 /*
792 * We can't copy to userspace directly because current_driver_name can
793 * only be read under the driver_name_lock with irqs disabled. So
794 * create a temporary copy first.
795 */
796 read_lock_irqsave(&driver_name_lock, flags);
797 len = scnprintf(buf, NAME_MAX_LEN + 1, "%s\n", current_driver_name);
798 read_unlock_irqrestore(&driver_name_lock, flags);
799
800 return simple_read_from_buffer(user_buf, count, ppos, buf, len);
801}
802
803static ssize_t filter_write(struct file *file, const char __user *userbuf,
804 size_t count, loff_t *ppos)
805{
Joerg Roedel8a6fc702009-05-22 21:23:13 +0200806 char buf[NAME_MAX_LEN];
Joerg Roedelc17e2cf2009-06-08 15:19:29 +0200807 unsigned long flags;
808 size_t len;
Joerg Roedel8a6fc702009-05-22 21:23:13 +0200809 int i;
810
811 /*
812 * We can't copy from userspace directly. Access to
813 * current_driver_name is protected with a write_lock with irqs
814 * disabled. Since copy_from_user can fault and may sleep we
815 * need to copy to temporary buffer first
816 */
Joerg Roedele7ed70e2009-06-08 15:39:24 +0200817 len = min(count, (size_t)(NAME_MAX_LEN - 1));
Joerg Roedel8a6fc702009-05-22 21:23:13 +0200818 if (copy_from_user(buf, userbuf, len))
819 return -EFAULT;
820
821 buf[len] = 0;
822
823 write_lock_irqsave(&driver_name_lock, flags);
824
Joerg Roedel312325092009-06-08 15:07:08 +0200825 /*
826 * Now handle the string we got from userspace very carefully.
Joerg Roedel8a6fc702009-05-22 21:23:13 +0200827 * The rules are:
828 * - only use the first token we got
829 * - token delimiter is everything looking like a space
830 * character (' ', '\n', '\t' ...)
831 *
832 */
833 if (!isalnum(buf[0])) {
834 /*
Joerg Roedel312325092009-06-08 15:07:08 +0200835 * If the first character userspace gave us is not
Joerg Roedel8a6fc702009-05-22 21:23:13 +0200836 * alphanumerical then assume the filter should be
837 * switched off.
838 */
839 if (current_driver_name[0])
Joerg Roedele7ed70e2009-06-08 15:39:24 +0200840 pr_info("DMA-API: switching off dma-debug driver filter\n");
Joerg Roedel8a6fc702009-05-22 21:23:13 +0200841 current_driver_name[0] = 0;
842 current_driver = NULL;
843 goto out_unlock;
844 }
845
846 /*
847 * Now parse out the first token and use it as the name for the
848 * driver to filter for.
849 */
Dan Carpenter39a37ce2010-04-06 19:45:12 +0300850 for (i = 0; i < NAME_MAX_LEN - 1; ++i) {
Joerg Roedel8a6fc702009-05-22 21:23:13 +0200851 current_driver_name[i] = buf[i];
852 if (isspace(buf[i]) || buf[i] == ' ' || buf[i] == 0)
853 break;
854 }
855 current_driver_name[i] = 0;
856 current_driver = NULL;
857
Joerg Roedele7ed70e2009-06-08 15:39:24 +0200858 pr_info("DMA-API: enable driver filter for driver [%s]\n",
859 current_driver_name);
Joerg Roedel8a6fc702009-05-22 21:23:13 +0200860
861out_unlock:
862 write_unlock_irqrestore(&driver_name_lock, flags);
863
864 return count;
865}
866
Thiago Farinaaeb583d2010-01-18 18:57:33 -0500867static const struct file_operations filter_fops = {
Joerg Roedel8a6fc702009-05-22 21:23:13 +0200868 .read = filter_read,
869 .write = filter_write,
Arnd Bergmann6038f372010-08-15 18:52:59 +0200870 .llseek = default_llseek,
Joerg Roedel8a6fc702009-05-22 21:23:13 +0200871};
872
Joerg Roedel788dcfa2009-01-09 13:13:27 +0100873static int dma_debug_fs_init(void)
874{
875 dma_debug_dent = debugfs_create_dir("dma-api", NULL);
876 if (!dma_debug_dent) {
Joerg Roedele7ed70e2009-06-08 15:39:24 +0200877 pr_err("DMA-API: can not create debugfs directory\n");
Joerg Roedel788dcfa2009-01-09 13:13:27 +0100878 return -ENOMEM;
879 }
880
881 global_disable_dent = debugfs_create_bool("disabled", 0444,
882 dma_debug_dent,
Dan Carpenter68ee6d22012-06-27 12:08:55 +0300883 &global_disable);
Joerg Roedel788dcfa2009-01-09 13:13:27 +0100884 if (!global_disable_dent)
885 goto out_err;
886
887 error_count_dent = debugfs_create_u32("error_count", 0444,
888 dma_debug_dent, &error_count);
889 if (!error_count_dent)
890 goto out_err;
891
892 show_all_errors_dent = debugfs_create_u32("all_errors", 0644,
893 dma_debug_dent,
894 &show_all_errors);
895 if (!show_all_errors_dent)
896 goto out_err;
897
898 show_num_errors_dent = debugfs_create_u32("num_errors", 0644,
899 dma_debug_dent,
900 &show_num_errors);
901 if (!show_num_errors_dent)
902 goto out_err;
903
904 num_free_entries_dent = debugfs_create_u32("num_free_entries", 0444,
905 dma_debug_dent,
906 &num_free_entries);
907 if (!num_free_entries_dent)
908 goto out_err;
909
910 min_free_entries_dent = debugfs_create_u32("min_free_entries", 0444,
911 dma_debug_dent,
912 &min_free_entries);
913 if (!min_free_entries_dent)
914 goto out_err;
915
Joerg Roedel8a6fc702009-05-22 21:23:13 +0200916 filter_dent = debugfs_create_file("driver_filter", 0644,
917 dma_debug_dent, NULL, &filter_fops);
918 if (!filter_dent)
919 goto out_err;
920
Joerg Roedel788dcfa2009-01-09 13:13:27 +0100921 return 0;
922
923out_err:
924 debugfs_remove_recursive(dma_debug_dent);
925
926 return -ENOMEM;
927}
928
Stanislaw Gruszkaba4b87ad2011-03-31 08:08:09 -0400929static int device_dma_allocations(struct device *dev, struct dma_debug_entry **out_entry)
Joerg Roedeled888ae2009-05-22 17:16:04 +0200930{
931 struct dma_debug_entry *entry;
932 unsigned long flags;
933 int count = 0, i;
934
Joerg Roedelbe81c6e2009-06-08 15:46:19 +0200935 local_irq_save(flags);
936
Joerg Roedeled888ae2009-05-22 17:16:04 +0200937 for (i = 0; i < HASH_SIZE; ++i) {
Joerg Roedelbe81c6e2009-06-08 15:46:19 +0200938 spin_lock(&dma_entry_hash[i].lock);
Joerg Roedeled888ae2009-05-22 17:16:04 +0200939 list_for_each_entry(entry, &dma_entry_hash[i].list, list) {
Stanislaw Gruszkaba4b87ad2011-03-31 08:08:09 -0400940 if (entry->dev == dev) {
Joerg Roedeled888ae2009-05-22 17:16:04 +0200941 count += 1;
Stanislaw Gruszkaba4b87ad2011-03-31 08:08:09 -0400942 *out_entry = entry;
943 }
Joerg Roedeled888ae2009-05-22 17:16:04 +0200944 }
Joerg Roedelbe81c6e2009-06-08 15:46:19 +0200945 spin_unlock(&dma_entry_hash[i].lock);
Joerg Roedeled888ae2009-05-22 17:16:04 +0200946 }
947
Joerg Roedelbe81c6e2009-06-08 15:46:19 +0200948 local_irq_restore(flags);
949
Joerg Roedeled888ae2009-05-22 17:16:04 +0200950 return count;
951}
952
Ingo Molnara8fe9ea2009-12-31 15:16:23 +0100953static int dma_debug_device_change(struct notifier_block *nb, unsigned long action, void *data)
Joerg Roedeled888ae2009-05-22 17:16:04 +0200954{
955 struct device *dev = data;
Stanislaw Gruszkaba4b87ad2011-03-31 08:08:09 -0400956 struct dma_debug_entry *uninitialized_var(entry);
Joerg Roedeled888ae2009-05-22 17:16:04 +0200957 int count;
958
Florian Fainelli01ce18b2014-12-10 15:41:23 -0800959 if (dma_debug_disabled())
Ingo Molnara8fe9ea2009-12-31 15:16:23 +0100960 return 0;
Joerg Roedeled888ae2009-05-22 17:16:04 +0200961
962 switch (action) {
963 case BUS_NOTIFY_UNBOUND_DRIVER:
Stanislaw Gruszkaba4b87ad2011-03-31 08:08:09 -0400964 count = device_dma_allocations(dev, &entry);
Joerg Roedeled888ae2009-05-22 17:16:04 +0200965 if (count == 0)
966 break;
Stanislaw Gruszkaba4b87ad2011-03-31 08:08:09 -0400967 err_printk(dev, entry, "DMA-API: device driver has pending "
Joerg Roedeled888ae2009-05-22 17:16:04 +0200968 "DMA allocations while released from device "
Stanislaw Gruszkaba4b87ad2011-03-31 08:08:09 -0400969 "[count=%d]\n"
970 "One of leaked entries details: "
971 "[device address=0x%016llx] [size=%llu bytes] "
972 "[mapped with %s] [mapped as %s]\n",
973 count, entry->dev_addr, entry->size,
974 dir2name[entry->direction], type2name[entry->type]);
Joerg Roedeled888ae2009-05-22 17:16:04 +0200975 break;
976 default:
977 break;
978 }
979
980 return 0;
981}
982
Joerg Roedel41531c82009-03-16 17:32:14 +0100983void dma_debug_add_bus(struct bus_type *bus)
984{
Joerg Roedeled888ae2009-05-22 17:16:04 +0200985 struct notifier_block *nb;
986
Florian Fainelli01ce18b2014-12-10 15:41:23 -0800987 if (dma_debug_disabled())
Shaun Ruffellf797d982009-12-17 18:00:36 -0600988 return;
989
Joerg Roedeled888ae2009-05-22 17:16:04 +0200990 nb = kzalloc(sizeof(struct notifier_block), GFP_KERNEL);
991 if (nb == NULL) {
Joerg Roedele7ed70e2009-06-08 15:39:24 +0200992 pr_err("dma_debug_add_bus: out of memory\n");
Joerg Roedeled888ae2009-05-22 17:16:04 +0200993 return;
994 }
995
996 nb->notifier_call = dma_debug_device_change;
997
998 bus_register_notifier(bus, nb);
Joerg Roedel41531c82009-03-16 17:32:14 +0100999}
Joerg Roedel788dcfa2009-01-09 13:13:27 +01001000
Joerg Roedel6bf07872009-01-09 12:54:42 +01001001/*
1002 * Let the architectures decide how many entries should be preallocated.
1003 */
1004void dma_debug_init(u32 num_entries)
1005{
1006 int i;
1007
Florian Fainelli2ce8e7e2014-12-10 15:41:25 -08001008 /* Do not use dma_debug_initialized here, since we really want to be
1009 * called to set dma_debug_initialized
1010 */
1011 if (global_disable)
Joerg Roedel6bf07872009-01-09 12:54:42 +01001012 return;
1013
1014 for (i = 0; i < HASH_SIZE; ++i) {
1015 INIT_LIST_HEAD(&dma_entry_hash[i].list);
Ingo Molnarb0a5b832009-06-16 16:11:14 +02001016 spin_lock_init(&dma_entry_hash[i].lock);
Joerg Roedel6bf07872009-01-09 12:54:42 +01001017 }
1018
Joerg Roedel788dcfa2009-01-09 13:13:27 +01001019 if (dma_debug_fs_init() != 0) {
Joerg Roedele7ed70e2009-06-08 15:39:24 +02001020 pr_err("DMA-API: error creating debugfs entries - disabling\n");
Joerg Roedel788dcfa2009-01-09 13:13:27 +01001021 global_disable = true;
1022
1023 return;
1024 }
1025
Joerg Roedel59d3daa2009-01-09 13:01:56 +01001026 if (req_entries)
1027 num_entries = req_entries;
1028
Joerg Roedel6bf07872009-01-09 12:54:42 +01001029 if (prealloc_memory(num_entries) != 0) {
Joerg Roedele7ed70e2009-06-08 15:39:24 +02001030 pr_err("DMA-API: debugging out of memory error - disabled\n");
Joerg Roedel6bf07872009-01-09 12:54:42 +01001031 global_disable = true;
1032
1033 return;
1034 }
1035
FUJITA Tomonorie6a1a892009-04-15 18:22:41 +09001036 nr_total_entries = num_free_entries;
1037
Florian Fainelli2ce8e7e2014-12-10 15:41:25 -08001038 dma_debug_initialized = true;
1039
Joerg Roedele7ed70e2009-06-08 15:39:24 +02001040 pr_info("DMA-API: debugging enabled by kernel config\n");
Joerg Roedel6bf07872009-01-09 12:54:42 +01001041}
1042
Joerg Roedel59d3daa2009-01-09 13:01:56 +01001043static __init int dma_debug_cmdline(char *str)
1044{
1045 if (!str)
1046 return -EINVAL;
1047
1048 if (strncmp(str, "off", 3) == 0) {
Joerg Roedele7ed70e2009-06-08 15:39:24 +02001049 pr_info("DMA-API: debugging disabled on kernel command line\n");
Joerg Roedel59d3daa2009-01-09 13:01:56 +01001050 global_disable = true;
1051 }
1052
1053 return 0;
1054}
1055
1056static __init int dma_debug_entries_cmdline(char *str)
1057{
1058 int res;
1059
1060 if (!str)
1061 return -EINVAL;
1062
1063 res = get_option(&str, &req_entries);
1064
1065 if (!res)
1066 req_entries = 0;
1067
1068 return 0;
1069}
1070
1071__setup("dma_debug=", dma_debug_cmdline);
1072__setup("dma_debug_entries=", dma_debug_entries_cmdline);
1073
Joerg Roedel2d62ece2009-01-09 14:10:26 +01001074static void check_unmap(struct dma_debug_entry *ref)
1075{
1076 struct dma_debug_entry *entry;
1077 struct hash_bucket *bucket;
1078 unsigned long flags;
1079
Joerg Roedel2d62ece2009-01-09 14:10:26 +01001080 bucket = get_hash_bucket(ref, &flags);
Neil Hormanc6a21d02011-08-08 15:13:54 -04001081 entry = bucket_find_exact(bucket, ref);
Joerg Roedel2d62ece2009-01-09 14:10:26 +01001082
1083 if (!entry) {
Alexander Duyck8d640a52013-03-22 15:04:48 -07001084 /* must drop lock before calling dma_mapping_error */
1085 put_hash_bucket(bucket, &flags);
1086
Shuah Khanbfe0fb02012-11-03 17:00:07 -06001087 if (dma_mapping_error(ref->dev, ref->dev_addr)) {
1088 err_printk(ref->dev, NULL,
Alexander Duyck8d640a52013-03-22 15:04:48 -07001089 "DMA-API: device driver tries to free an "
1090 "invalid DMA memory address\n");
1091 } else {
1092 err_printk(ref->dev, NULL,
1093 "DMA-API: device driver tries to free DMA "
1094 "memory it has not allocated [device "
1095 "address=0x%016llx] [size=%llu bytes]\n",
1096 ref->dev_addr, ref->size);
Shuah Khanbfe0fb02012-11-03 17:00:07 -06001097 }
Alexander Duyck8d640a52013-03-22 15:04:48 -07001098 return;
Joerg Roedel2d62ece2009-01-09 14:10:26 +01001099 }
1100
1101 if (ref->size != entry->size) {
David Woodhouse6c132d12009-01-19 16:52:39 +01001102 err_printk(ref->dev, entry, "DMA-API: device driver frees "
Joerg Roedel2d62ece2009-01-09 14:10:26 +01001103 "DMA memory with different size "
1104 "[device address=0x%016llx] [map size=%llu bytes] "
1105 "[unmap size=%llu bytes]\n",
1106 ref->dev_addr, entry->size, ref->size);
1107 }
1108
1109 if (ref->type != entry->type) {
David Woodhouse6c132d12009-01-19 16:52:39 +01001110 err_printk(ref->dev, entry, "DMA-API: device driver frees "
Joerg Roedel2d62ece2009-01-09 14:10:26 +01001111 "DMA memory with wrong function "
1112 "[device address=0x%016llx] [size=%llu bytes] "
1113 "[mapped as %s] [unmapped as %s]\n",
1114 ref->dev_addr, ref->size,
1115 type2name[entry->type], type2name[ref->type]);
1116 } else if ((entry->type == dma_debug_coherent) &&
Dan Williams0abdd7a2014-01-21 15:48:12 -08001117 (phys_addr(ref) != phys_addr(entry))) {
David Woodhouse6c132d12009-01-19 16:52:39 +01001118 err_printk(ref->dev, entry, "DMA-API: device driver frees "
Joerg Roedel2d62ece2009-01-09 14:10:26 +01001119 "DMA memory with different CPU address "
1120 "[device address=0x%016llx] [size=%llu bytes] "
Joerg Roedel59a40e702009-10-29 16:25:50 +01001121 "[cpu alloc address=0x%016llx] "
1122 "[cpu free address=0x%016llx]",
Joerg Roedel2d62ece2009-01-09 14:10:26 +01001123 ref->dev_addr, ref->size,
Dan Williams0abdd7a2014-01-21 15:48:12 -08001124 phys_addr(entry),
1125 phys_addr(ref));
Joerg Roedel2d62ece2009-01-09 14:10:26 +01001126 }
1127
1128 if (ref->sg_call_ents && ref->type == dma_debug_sg &&
1129 ref->sg_call_ents != entry->sg_call_ents) {
David Woodhouse6c132d12009-01-19 16:52:39 +01001130 err_printk(ref->dev, entry, "DMA-API: device driver frees "
Joerg Roedel2d62ece2009-01-09 14:10:26 +01001131 "DMA sg list with different entry count "
1132 "[map count=%d] [unmap count=%d]\n",
1133 entry->sg_call_ents, ref->sg_call_ents);
1134 }
1135
1136 /*
1137 * This may be no bug in reality - but most implementations of the
1138 * DMA API don't handle this properly, so check for it here
1139 */
1140 if (ref->direction != entry->direction) {
David Woodhouse6c132d12009-01-19 16:52:39 +01001141 err_printk(ref->dev, entry, "DMA-API: device driver frees "
Joerg Roedel2d62ece2009-01-09 14:10:26 +01001142 "DMA memory with different direction "
1143 "[device address=0x%016llx] [size=%llu bytes] "
1144 "[mapped with %s] [unmapped with %s]\n",
1145 ref->dev_addr, ref->size,
1146 dir2name[entry->direction],
1147 dir2name[ref->direction]);
1148 }
1149
Shuah Khan6c9c6d62012-10-08 11:08:06 -06001150 if (entry->map_err_type == MAP_ERR_NOT_CHECKED) {
1151 err_printk(ref->dev, entry,
1152 "DMA-API: device driver failed to check map error"
1153 "[device address=0x%016llx] [size=%llu bytes] "
1154 "[mapped as %s]",
1155 ref->dev_addr, ref->size,
1156 type2name[entry->type]);
1157 }
1158
Joerg Roedel2d62ece2009-01-09 14:10:26 +01001159 hash_bucket_del(entry);
1160 dma_entry_free(entry);
1161
Joerg Roedel2d62ece2009-01-09 14:10:26 +01001162 put_hash_bucket(bucket, &flags);
1163}
1164
1165static void check_for_stack(struct device *dev, void *addr)
1166{
1167 if (object_is_on_stack(addr))
Horia Geantaf9134be2014-09-02 14:28:14 +03001168 err_printk(dev, NULL, "DMA-API: device driver maps memory from "
David Woodhouse6c132d12009-01-19 16:52:39 +01001169 "stack [addr=%p]\n", addr);
Joerg Roedel2d62ece2009-01-09 14:10:26 +01001170}
1171
Ingo Molnarf39d1b92009-07-10 21:38:02 +02001172static inline bool overlap(void *addr, unsigned long len, void *start, void *end)
Joerg Roedel2e34bde2009-03-16 16:51:55 +01001173{
Ingo Molnarf39d1b92009-07-10 21:38:02 +02001174 unsigned long a1 = (unsigned long)addr;
1175 unsigned long b1 = a1 + len;
1176 unsigned long a2 = (unsigned long)start;
1177 unsigned long b2 = (unsigned long)end;
Joerg Roedel2e34bde2009-03-16 16:51:55 +01001178
Ingo Molnarf39d1b92009-07-10 21:38:02 +02001179 return !(b1 <= a2 || a1 >= b2);
Joerg Roedel2e34bde2009-03-16 16:51:55 +01001180}
1181
Ingo Molnarf39d1b92009-07-10 21:38:02 +02001182static void check_for_illegal_area(struct device *dev, void *addr, unsigned long len)
Joerg Roedel2e34bde2009-03-16 16:51:55 +01001183{
Ingo Molnarf39d1b92009-07-10 21:38:02 +02001184 if (overlap(addr, len, _text, _etext) ||
1185 overlap(addr, len, __start_rodata, __end_rodata))
1186 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 +01001187}
1188
Joerg Roedelaa010ef2009-06-12 15:25:06 +02001189static void check_sync(struct device *dev,
1190 struct dma_debug_entry *ref,
1191 bool to_cpu)
Joerg Roedel2d62ece2009-01-09 14:10:26 +01001192{
Joerg Roedel2d62ece2009-01-09 14:10:26 +01001193 struct dma_debug_entry *entry;
1194 struct hash_bucket *bucket;
1195 unsigned long flags;
1196
Joerg Roedelaa010ef2009-06-12 15:25:06 +02001197 bucket = get_hash_bucket(ref, &flags);
Joerg Roedel2d62ece2009-01-09 14:10:26 +01001198
Neil Hormanc6a21d02011-08-08 15:13:54 -04001199 entry = bucket_find_contain(&bucket, ref, &flags);
Joerg Roedel2d62ece2009-01-09 14:10:26 +01001200
1201 if (!entry) {
David Woodhouse6c132d12009-01-19 16:52:39 +01001202 err_printk(dev, NULL, "DMA-API: device driver tries "
Joerg Roedel2d62ece2009-01-09 14:10:26 +01001203 "to sync DMA memory it has not allocated "
1204 "[device address=0x%016llx] [size=%llu bytes]\n",
Joerg Roedelaa010ef2009-06-12 15:25:06 +02001205 (unsigned long long)ref->dev_addr, ref->size);
Joerg Roedel2d62ece2009-01-09 14:10:26 +01001206 goto out;
1207 }
1208
Joerg Roedelaa010ef2009-06-12 15:25:06 +02001209 if (ref->size > entry->size) {
David Woodhouse6c132d12009-01-19 16:52:39 +01001210 err_printk(dev, entry, "DMA-API: device driver syncs"
Joerg Roedel2d62ece2009-01-09 14:10:26 +01001211 " DMA memory outside allocated range "
1212 "[device address=0x%016llx] "
Joerg Roedelaa010ef2009-06-12 15:25:06 +02001213 "[allocation size=%llu bytes] "
1214 "[sync offset+size=%llu]\n",
1215 entry->dev_addr, entry->size,
1216 ref->size);
Joerg Roedel2d62ece2009-01-09 14:10:26 +01001217 }
1218
Krzysztof Halasa42d53b42010-01-08 14:42:36 -08001219 if (entry->direction == DMA_BIDIRECTIONAL)
1220 goto out;
1221
Joerg Roedelaa010ef2009-06-12 15:25:06 +02001222 if (ref->direction != entry->direction) {
David Woodhouse6c132d12009-01-19 16:52:39 +01001223 err_printk(dev, entry, "DMA-API: device driver syncs "
Joerg Roedel2d62ece2009-01-09 14:10:26 +01001224 "DMA memory with different direction "
1225 "[device address=0x%016llx] [size=%llu bytes] "
1226 "[mapped with %s] [synced with %s]\n",
Joerg Roedelaa010ef2009-06-12 15:25:06 +02001227 (unsigned long long)ref->dev_addr, entry->size,
Joerg Roedel2d62ece2009-01-09 14:10:26 +01001228 dir2name[entry->direction],
Joerg Roedelaa010ef2009-06-12 15:25:06 +02001229 dir2name[ref->direction]);
Joerg Roedel2d62ece2009-01-09 14:10:26 +01001230 }
1231
Joerg Roedel2d62ece2009-01-09 14:10:26 +01001232 if (to_cpu && !(entry->direction == DMA_FROM_DEVICE) &&
Joerg Roedelaa010ef2009-06-12 15:25:06 +02001233 !(ref->direction == DMA_TO_DEVICE))
David Woodhouse6c132d12009-01-19 16:52:39 +01001234 err_printk(dev, entry, "DMA-API: device driver syncs "
Joerg Roedel2d62ece2009-01-09 14:10:26 +01001235 "device read-only DMA memory for cpu "
1236 "[device address=0x%016llx] [size=%llu bytes] "
1237 "[mapped with %s] [synced with %s]\n",
Joerg Roedelaa010ef2009-06-12 15:25:06 +02001238 (unsigned long long)ref->dev_addr, entry->size,
Joerg Roedel2d62ece2009-01-09 14:10:26 +01001239 dir2name[entry->direction],
Joerg Roedelaa010ef2009-06-12 15:25:06 +02001240 dir2name[ref->direction]);
Joerg Roedel2d62ece2009-01-09 14:10:26 +01001241
1242 if (!to_cpu && !(entry->direction == DMA_TO_DEVICE) &&
Joerg Roedelaa010ef2009-06-12 15:25:06 +02001243 !(ref->direction == DMA_FROM_DEVICE))
David Woodhouse6c132d12009-01-19 16:52:39 +01001244 err_printk(dev, entry, "DMA-API: device driver syncs "
Joerg Roedel2d62ece2009-01-09 14:10:26 +01001245 "device write-only DMA memory to device "
1246 "[device address=0x%016llx] [size=%llu bytes] "
1247 "[mapped with %s] [synced with %s]\n",
Joerg Roedelaa010ef2009-06-12 15:25:06 +02001248 (unsigned long long)ref->dev_addr, entry->size,
Joerg Roedel2d62ece2009-01-09 14:10:26 +01001249 dir2name[entry->direction],
Joerg Roedelaa010ef2009-06-12 15:25:06 +02001250 dir2name[ref->direction]);
Joerg Roedel2d62ece2009-01-09 14:10:26 +01001251
1252out:
1253 put_hash_bucket(bucket, &flags);
Joerg Roedel2d62ece2009-01-09 14:10:26 +01001254}
1255
Joerg Roedelf62bc982009-01-09 14:14:49 +01001256void debug_dma_map_page(struct device *dev, struct page *page, size_t offset,
1257 size_t size, int direction, dma_addr_t dma_addr,
1258 bool map_single)
1259{
1260 struct dma_debug_entry *entry;
1261
Florian Fainelli01ce18b2014-12-10 15:41:23 -08001262 if (unlikely(dma_debug_disabled()))
Joerg Roedelf62bc982009-01-09 14:14:49 +01001263 return;
1264
Shuah Khanbfe0fb02012-11-03 17:00:07 -06001265 if (dma_mapping_error(dev, dma_addr))
Joerg Roedelf62bc982009-01-09 14:14:49 +01001266 return;
1267
1268 entry = dma_entry_alloc();
1269 if (!entry)
1270 return;
1271
1272 entry->dev = dev;
1273 entry->type = dma_debug_page;
Dan Williams0abdd7a2014-01-21 15:48:12 -08001274 entry->pfn = page_to_pfn(page);
1275 entry->offset = offset,
Joerg Roedelf62bc982009-01-09 14:14:49 +01001276 entry->dev_addr = dma_addr;
1277 entry->size = size;
1278 entry->direction = direction;
Shuah Khan6c9c6d62012-10-08 11:08:06 -06001279 entry->map_err_type = MAP_ERR_NOT_CHECKED;
Joerg Roedelf62bc982009-01-09 14:14:49 +01001280
Joerg Roedel9537a482009-03-23 15:35:08 +01001281 if (map_single)
Joerg Roedelf62bc982009-01-09 14:14:49 +01001282 entry->type = dma_debug_single;
Joerg Roedel9537a482009-03-23 15:35:08 +01001283
1284 if (!PageHighMem(page)) {
Ingo Molnarf39d1b92009-07-10 21:38:02 +02001285 void *addr = page_address(page) + offset;
1286
Joerg Roedel2e34bde2009-03-16 16:51:55 +01001287 check_for_stack(dev, addr);
1288 check_for_illegal_area(dev, addr, size);
Joerg Roedelf62bc982009-01-09 14:14:49 +01001289 }
1290
1291 add_dma_entry(entry);
1292}
1293EXPORT_SYMBOL(debug_dma_map_page);
1294
Shuah Khan6c9c6d62012-10-08 11:08:06 -06001295void debug_dma_mapping_error(struct device *dev, dma_addr_t dma_addr)
1296{
1297 struct dma_debug_entry ref;
1298 struct dma_debug_entry *entry;
1299 struct hash_bucket *bucket;
1300 unsigned long flags;
1301
Florian Fainelli01ce18b2014-12-10 15:41:23 -08001302 if (unlikely(dma_debug_disabled()))
Shuah Khan6c9c6d62012-10-08 11:08:06 -06001303 return;
1304
1305 ref.dev = dev;
1306 ref.dev_addr = dma_addr;
1307 bucket = get_hash_bucket(&ref, &flags);
Shuah Khan6c9c6d62012-10-08 11:08:06 -06001308
Alexander Duyck96e7d7a2013-03-22 15:04:49 -07001309 list_for_each_entry(entry, &bucket->list, list) {
1310 if (!exact_match(&ref, entry))
1311 continue;
Shuah Khan6c9c6d62012-10-08 11:08:06 -06001312
Alexander Duyck96e7d7a2013-03-22 15:04:49 -07001313 /*
1314 * The same physical address can be mapped multiple
1315 * times. Without a hardware IOMMU this results in the
1316 * same device addresses being put into the dma-debug
1317 * hash multiple times too. This can result in false
1318 * positives being reported. Therefore we implement a
1319 * best-fit algorithm here which updates the first entry
1320 * from the hash which fits the reference value and is
1321 * not currently listed as being checked.
1322 */
1323 if (entry->map_err_type == MAP_ERR_NOT_CHECKED) {
1324 entry->map_err_type = MAP_ERR_CHECKED;
1325 break;
1326 }
1327 }
1328
Shuah Khan6c9c6d62012-10-08 11:08:06 -06001329 put_hash_bucket(bucket, &flags);
1330}
1331EXPORT_SYMBOL(debug_dma_mapping_error);
1332
Joerg Roedelf62bc982009-01-09 14:14:49 +01001333void debug_dma_unmap_page(struct device *dev, dma_addr_t addr,
1334 size_t size, int direction, bool map_single)
1335{
1336 struct dma_debug_entry ref = {
1337 .type = dma_debug_page,
1338 .dev = dev,
1339 .dev_addr = addr,
1340 .size = size,
1341 .direction = direction,
1342 };
1343
Florian Fainelli01ce18b2014-12-10 15:41:23 -08001344 if (unlikely(dma_debug_disabled()))
Joerg Roedelf62bc982009-01-09 14:14:49 +01001345 return;
1346
1347 if (map_single)
1348 ref.type = dma_debug_single;
1349
1350 check_unmap(&ref);
1351}
1352EXPORT_SYMBOL(debug_dma_unmap_page);
1353
Joerg Roedel972aa452009-01-09 14:19:54 +01001354void debug_dma_map_sg(struct device *dev, struct scatterlist *sg,
1355 int nents, int mapped_ents, int direction)
1356{
1357 struct dma_debug_entry *entry;
1358 struct scatterlist *s;
1359 int i;
1360
Florian Fainelli01ce18b2014-12-10 15:41:23 -08001361 if (unlikely(dma_debug_disabled()))
Joerg Roedel972aa452009-01-09 14:19:54 +01001362 return;
1363
1364 for_each_sg(sg, s, mapped_ents, i) {
1365 entry = dma_entry_alloc();
1366 if (!entry)
1367 return;
1368
1369 entry->type = dma_debug_sg;
1370 entry->dev = dev;
Dan Williams0abdd7a2014-01-21 15:48:12 -08001371 entry->pfn = page_to_pfn(sg_page(s));
1372 entry->offset = s->offset,
FUJITA Tomonori884d0592009-05-27 09:43:02 +09001373 entry->size = sg_dma_len(s);
FUJITA Tomonori15aedea2009-05-27 09:43:01 +09001374 entry->dev_addr = sg_dma_address(s);
Joerg Roedel972aa452009-01-09 14:19:54 +01001375 entry->direction = direction;
1376 entry->sg_call_ents = nents;
1377 entry->sg_mapped_ents = mapped_ents;
1378
Joerg Roedel9537a482009-03-23 15:35:08 +01001379 if (!PageHighMem(sg_page(s))) {
1380 check_for_stack(dev, sg_virt(s));
FUJITA Tomonori884d0592009-05-27 09:43:02 +09001381 check_for_illegal_area(dev, sg_virt(s), sg_dma_len(s));
Joerg Roedel9537a482009-03-23 15:35:08 +01001382 }
Joerg Roedel972aa452009-01-09 14:19:54 +01001383
1384 add_dma_entry(entry);
1385 }
1386}
1387EXPORT_SYMBOL(debug_dma_map_sg);
1388
Joerg Roedelaa010ef2009-06-12 15:25:06 +02001389static int get_nr_mapped_entries(struct device *dev,
1390 struct dma_debug_entry *ref)
FUJITA Tomonori88f39072009-05-27 09:43:03 +09001391{
Joerg Roedelaa010ef2009-06-12 15:25:06 +02001392 struct dma_debug_entry *entry;
FUJITA Tomonori88f39072009-05-27 09:43:03 +09001393 struct hash_bucket *bucket;
1394 unsigned long flags;
Joerg Roedelc17e2cf2009-06-08 15:19:29 +02001395 int mapped_ents;
FUJITA Tomonori88f39072009-05-27 09:43:03 +09001396
Joerg Roedelaa010ef2009-06-12 15:25:06 +02001397 bucket = get_hash_bucket(ref, &flags);
Neil Hormanc6a21d02011-08-08 15:13:54 -04001398 entry = bucket_find_exact(bucket, ref);
Joerg Roedelc17e2cf2009-06-08 15:19:29 +02001399 mapped_ents = 0;
1400
FUJITA Tomonori88f39072009-05-27 09:43:03 +09001401 if (entry)
1402 mapped_ents = entry->sg_mapped_ents;
1403 put_hash_bucket(bucket, &flags);
1404
1405 return mapped_ents;
1406}
1407
Joerg Roedel972aa452009-01-09 14:19:54 +01001408void debug_dma_unmap_sg(struct device *dev, struct scatterlist *sglist,
1409 int nelems, int dir)
1410{
Joerg Roedel972aa452009-01-09 14:19:54 +01001411 struct scatterlist *s;
1412 int mapped_ents = 0, i;
Joerg Roedel972aa452009-01-09 14:19:54 +01001413
Florian Fainelli01ce18b2014-12-10 15:41:23 -08001414 if (unlikely(dma_debug_disabled()))
Joerg Roedel972aa452009-01-09 14:19:54 +01001415 return;
1416
1417 for_each_sg(sglist, s, nelems, i) {
1418
1419 struct dma_debug_entry ref = {
1420 .type = dma_debug_sg,
1421 .dev = dev,
Dan Williams0abdd7a2014-01-21 15:48:12 -08001422 .pfn = page_to_pfn(sg_page(s)),
1423 .offset = s->offset,
FUJITA Tomonori15aedea2009-05-27 09:43:01 +09001424 .dev_addr = sg_dma_address(s),
FUJITA Tomonori884d0592009-05-27 09:43:02 +09001425 .size = sg_dma_len(s),
Joerg Roedel972aa452009-01-09 14:19:54 +01001426 .direction = dir,
Joerg Roedele5e8c5b2009-06-11 10:03:42 +02001427 .sg_call_ents = nelems,
Joerg Roedel972aa452009-01-09 14:19:54 +01001428 };
1429
1430 if (mapped_ents && i >= mapped_ents)
1431 break;
1432
Joerg Roedele5e8c5b2009-06-11 10:03:42 +02001433 if (!i)
Joerg Roedelaa010ef2009-06-12 15:25:06 +02001434 mapped_ents = get_nr_mapped_entries(dev, &ref);
Joerg Roedel972aa452009-01-09 14:19:54 +01001435
1436 check_unmap(&ref);
1437 }
1438}
1439EXPORT_SYMBOL(debug_dma_unmap_sg);
1440
Joerg Roedel6bfd4492009-01-09 14:38:50 +01001441void debug_dma_alloc_coherent(struct device *dev, size_t size,
1442 dma_addr_t dma_addr, void *virt)
1443{
1444 struct dma_debug_entry *entry;
1445
Florian Fainelli01ce18b2014-12-10 15:41:23 -08001446 if (unlikely(dma_debug_disabled()))
Joerg Roedel6bfd4492009-01-09 14:38:50 +01001447 return;
1448
1449 if (unlikely(virt == NULL))
1450 return;
1451
1452 entry = dma_entry_alloc();
1453 if (!entry)
1454 return;
1455
1456 entry->type = dma_debug_coherent;
1457 entry->dev = dev;
Dan Williams0abdd7a2014-01-21 15:48:12 -08001458 entry->pfn = page_to_pfn(virt_to_page(virt));
1459 entry->offset = (size_t) virt & PAGE_MASK;
Joerg Roedel6bfd4492009-01-09 14:38:50 +01001460 entry->size = size;
1461 entry->dev_addr = dma_addr;
1462 entry->direction = DMA_BIDIRECTIONAL;
1463
1464 add_dma_entry(entry);
1465}
1466EXPORT_SYMBOL(debug_dma_alloc_coherent);
1467
1468void debug_dma_free_coherent(struct device *dev, size_t size,
1469 void *virt, dma_addr_t addr)
1470{
1471 struct dma_debug_entry ref = {
1472 .type = dma_debug_coherent,
1473 .dev = dev,
Dan Williams0abdd7a2014-01-21 15:48:12 -08001474 .pfn = page_to_pfn(virt_to_page(virt)),
1475 .offset = (size_t) virt & PAGE_MASK,
Joerg Roedel6bfd4492009-01-09 14:38:50 +01001476 .dev_addr = addr,
1477 .size = size,
1478 .direction = DMA_BIDIRECTIONAL,
1479 };
1480
Florian Fainelli01ce18b2014-12-10 15:41:23 -08001481 if (unlikely(dma_debug_disabled()))
Joerg Roedel6bfd4492009-01-09 14:38:50 +01001482 return;
1483
1484 check_unmap(&ref);
1485}
1486EXPORT_SYMBOL(debug_dma_free_coherent);
1487
Joerg Roedelb9d23172009-01-09 14:43:04 +01001488void debug_dma_sync_single_for_cpu(struct device *dev, dma_addr_t dma_handle,
1489 size_t size, int direction)
1490{
Joerg Roedelaa010ef2009-06-12 15:25:06 +02001491 struct dma_debug_entry ref;
1492
Florian Fainelli01ce18b2014-12-10 15:41:23 -08001493 if (unlikely(dma_debug_disabled()))
Joerg Roedelb9d23172009-01-09 14:43:04 +01001494 return;
1495
Joerg Roedelaa010ef2009-06-12 15:25:06 +02001496 ref.type = dma_debug_single;
1497 ref.dev = dev;
1498 ref.dev_addr = dma_handle;
1499 ref.size = size;
1500 ref.direction = direction;
1501 ref.sg_call_ents = 0;
1502
1503 check_sync(dev, &ref, true);
Joerg Roedelb9d23172009-01-09 14:43:04 +01001504}
1505EXPORT_SYMBOL(debug_dma_sync_single_for_cpu);
1506
1507void debug_dma_sync_single_for_device(struct device *dev,
1508 dma_addr_t dma_handle, size_t size,
1509 int direction)
1510{
Joerg Roedelaa010ef2009-06-12 15:25:06 +02001511 struct dma_debug_entry ref;
1512
Florian Fainelli01ce18b2014-12-10 15:41:23 -08001513 if (unlikely(dma_debug_disabled()))
Joerg Roedelb9d23172009-01-09 14:43:04 +01001514 return;
1515
Joerg Roedelaa010ef2009-06-12 15:25:06 +02001516 ref.type = dma_debug_single;
1517 ref.dev = dev;
1518 ref.dev_addr = dma_handle;
1519 ref.size = size;
1520 ref.direction = direction;
1521 ref.sg_call_ents = 0;
1522
1523 check_sync(dev, &ref, false);
Joerg Roedelb9d23172009-01-09 14:43:04 +01001524}
1525EXPORT_SYMBOL(debug_dma_sync_single_for_device);
1526
Joerg Roedel948408b2009-01-09 14:55:38 +01001527void debug_dma_sync_single_range_for_cpu(struct device *dev,
1528 dma_addr_t dma_handle,
1529 unsigned long offset, size_t size,
1530 int direction)
1531{
Joerg Roedelaa010ef2009-06-12 15:25:06 +02001532 struct dma_debug_entry ref;
1533
Florian Fainelli01ce18b2014-12-10 15:41:23 -08001534 if (unlikely(dma_debug_disabled()))
Joerg Roedel948408b2009-01-09 14:55:38 +01001535 return;
1536
Joerg Roedelaa010ef2009-06-12 15:25:06 +02001537 ref.type = dma_debug_single;
1538 ref.dev = dev;
1539 ref.dev_addr = dma_handle;
1540 ref.size = offset + size;
1541 ref.direction = direction;
1542 ref.sg_call_ents = 0;
1543
1544 check_sync(dev, &ref, true);
Joerg Roedel948408b2009-01-09 14:55:38 +01001545}
1546EXPORT_SYMBOL(debug_dma_sync_single_range_for_cpu);
1547
1548void debug_dma_sync_single_range_for_device(struct device *dev,
1549 dma_addr_t dma_handle,
1550 unsigned long offset,
1551 size_t size, int direction)
1552{
Joerg Roedelaa010ef2009-06-12 15:25:06 +02001553 struct dma_debug_entry ref;
1554
Florian Fainelli01ce18b2014-12-10 15:41:23 -08001555 if (unlikely(dma_debug_disabled()))
Joerg Roedel948408b2009-01-09 14:55:38 +01001556 return;
1557
Joerg Roedelaa010ef2009-06-12 15:25:06 +02001558 ref.type = dma_debug_single;
1559 ref.dev = dev;
1560 ref.dev_addr = dma_handle;
1561 ref.size = offset + size;
1562 ref.direction = direction;
1563 ref.sg_call_ents = 0;
1564
1565 check_sync(dev, &ref, false);
Joerg Roedel948408b2009-01-09 14:55:38 +01001566}
1567EXPORT_SYMBOL(debug_dma_sync_single_range_for_device);
1568
Joerg Roedela31fba52009-01-09 15:01:12 +01001569void debug_dma_sync_sg_for_cpu(struct device *dev, struct scatterlist *sg,
1570 int nelems, int direction)
1571{
1572 struct scatterlist *s;
FUJITA Tomonori88f39072009-05-27 09:43:03 +09001573 int mapped_ents = 0, i;
Joerg Roedela31fba52009-01-09 15:01:12 +01001574
Florian Fainelli01ce18b2014-12-10 15:41:23 -08001575 if (unlikely(dma_debug_disabled()))
Joerg Roedela31fba52009-01-09 15:01:12 +01001576 return;
1577
1578 for_each_sg(sg, s, nelems, i) {
Joerg Roedelaa010ef2009-06-12 15:25:06 +02001579
1580 struct dma_debug_entry ref = {
1581 .type = dma_debug_sg,
1582 .dev = dev,
Dan Williams0abdd7a2014-01-21 15:48:12 -08001583 .pfn = page_to_pfn(sg_page(s)),
1584 .offset = s->offset,
Joerg Roedelaa010ef2009-06-12 15:25:06 +02001585 .dev_addr = sg_dma_address(s),
1586 .size = sg_dma_len(s),
1587 .direction = direction,
1588 .sg_call_ents = nelems,
1589 };
1590
FUJITA Tomonori88f39072009-05-27 09:43:03 +09001591 if (!i)
Joerg Roedelaa010ef2009-06-12 15:25:06 +02001592 mapped_ents = get_nr_mapped_entries(dev, &ref);
FUJITA Tomonori88f39072009-05-27 09:43:03 +09001593
1594 if (i >= mapped_ents)
1595 break;
1596
Joerg Roedelaa010ef2009-06-12 15:25:06 +02001597 check_sync(dev, &ref, true);
Joerg Roedela31fba52009-01-09 15:01:12 +01001598 }
1599}
1600EXPORT_SYMBOL(debug_dma_sync_sg_for_cpu);
1601
1602void debug_dma_sync_sg_for_device(struct device *dev, struct scatterlist *sg,
1603 int nelems, int direction)
1604{
1605 struct scatterlist *s;
FUJITA Tomonori88f39072009-05-27 09:43:03 +09001606 int mapped_ents = 0, i;
Joerg Roedela31fba52009-01-09 15:01:12 +01001607
Florian Fainelli01ce18b2014-12-10 15:41:23 -08001608 if (unlikely(dma_debug_disabled()))
Joerg Roedela31fba52009-01-09 15:01:12 +01001609 return;
1610
1611 for_each_sg(sg, s, nelems, i) {
Joerg Roedelaa010ef2009-06-12 15:25:06 +02001612
1613 struct dma_debug_entry ref = {
1614 .type = dma_debug_sg,
1615 .dev = dev,
Dan Williams0abdd7a2014-01-21 15:48:12 -08001616 .pfn = page_to_pfn(sg_page(s)),
1617 .offset = s->offset,
Joerg Roedelaa010ef2009-06-12 15:25:06 +02001618 .dev_addr = sg_dma_address(s),
1619 .size = sg_dma_len(s),
1620 .direction = direction,
1621 .sg_call_ents = nelems,
1622 };
FUJITA Tomonori88f39072009-05-27 09:43:03 +09001623 if (!i)
Joerg Roedelaa010ef2009-06-12 15:25:06 +02001624 mapped_ents = get_nr_mapped_entries(dev, &ref);
FUJITA Tomonori88f39072009-05-27 09:43:03 +09001625
1626 if (i >= mapped_ents)
1627 break;
1628
Joerg Roedelaa010ef2009-06-12 15:25:06 +02001629 check_sync(dev, &ref, false);
Joerg Roedela31fba52009-01-09 15:01:12 +01001630 }
1631}
1632EXPORT_SYMBOL(debug_dma_sync_sg_for_device);
1633
Joerg Roedel1745de52009-05-22 21:49:51 +02001634static int __init dma_debug_driver_setup(char *str)
1635{
1636 int i;
1637
1638 for (i = 0; i < NAME_MAX_LEN - 1; ++i, ++str) {
1639 current_driver_name[i] = *str;
1640 if (*str == 0)
1641 break;
1642 }
1643
1644 if (current_driver_name[0])
Joerg Roedele7ed70e2009-06-08 15:39:24 +02001645 pr_info("DMA-API: enable driver filter for driver [%s]\n",
1646 current_driver_name);
Joerg Roedel1745de52009-05-22 21:49:51 +02001647
1648
1649 return 1;
1650}
1651__setup("dma_debug_driver=", dma_debug_driver_setup);