blob: 4facb03bf8336c94b43bf7662966ba3199b0b6f5 [file] [log] [blame]
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001/*
2 * mm/kmemleak.c
3 *
4 * Copyright (C) 2008 ARM Limited
5 * Written by Catalin Marinas <catalin.marinas@arm.com>
6 *
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License version 2 as
9 * published by the Free Software Foundation.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19 *
20 *
21 * For more information on the algorithm and kmemleak usage, please see
22 * Documentation/kmemleak.txt.
23 *
24 * Notes on locking
25 * ----------------
26 *
27 * The following locks and mutexes are used by kmemleak:
28 *
29 * - kmemleak_lock (rwlock): protects the object_list modifications and
30 * accesses to the object_tree_root. The object_list is the main list
31 * holding the metadata (struct kmemleak_object) for the allocated memory
32 * blocks. The object_tree_root is a priority search tree used to look-up
33 * metadata based on a pointer to the corresponding memory block. The
34 * kmemleak_object structures are added to the object_list and
35 * object_tree_root in the create_object() function called from the
36 * kmemleak_alloc() callback and removed in delete_object() called from the
37 * kmemleak_free() callback
38 * - kmemleak_object.lock (spinlock): protects a kmemleak_object. Accesses to
39 * the metadata (e.g. count) are protected by this lock. Note that some
40 * members of this structure may be protected by other means (atomic or
41 * kmemleak_lock). This lock is also held when scanning the corresponding
42 * memory block to avoid the kernel freeing it via the kmemleak_free()
43 * callback. This is less heavyweight than holding a global lock like
44 * kmemleak_lock during scanning
45 * - scan_mutex (mutex): ensures that only one thread may scan the memory for
46 * unreferenced objects at a time. The gray_list contains the objects which
47 * are already referenced or marked as false positives and need to be
48 * scanned. This list is only modified during a scanning episode when the
49 * scan_mutex is held. At the end of a scan, the gray_list is always empty.
50 * Note that the kmemleak_object.use_count is incremented when an object is
Catalin Marinas4698c1f2009-06-26 17:38:27 +010051 * added to the gray_list and therefore cannot be freed. This mutex also
52 * prevents multiple users of the "kmemleak" debugfs file together with
53 * modifications to the memory scanning parameters including the scan_thread
54 * pointer
Catalin Marinas3c7b4e62009-06-11 13:22:39 +010055 *
56 * The kmemleak_object structures have a use_count incremented or decremented
57 * using the get_object()/put_object() functions. When the use_count becomes
58 * 0, this count can no longer be incremented and put_object() schedules the
59 * kmemleak_object freeing via an RCU callback. All calls to the get_object()
60 * function must be protected by rcu_read_lock() to avoid accessing a freed
61 * structure.
62 */
63
Joe Perchesae281062009-06-23 14:40:26 +010064#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
65
Catalin Marinas3c7b4e62009-06-11 13:22:39 +010066#include <linux/init.h>
67#include <linux/kernel.h>
68#include <linux/list.h>
69#include <linux/sched.h>
70#include <linux/jiffies.h>
71#include <linux/delay.h>
72#include <linux/module.h>
73#include <linux/kthread.h>
74#include <linux/prio_tree.h>
Catalin Marinas3c7b4e62009-06-11 13:22:39 +010075#include <linux/fs.h>
76#include <linux/debugfs.h>
77#include <linux/seq_file.h>
78#include <linux/cpumask.h>
79#include <linux/spinlock.h>
80#include <linux/mutex.h>
81#include <linux/rcupdate.h>
82#include <linux/stacktrace.h>
83#include <linux/cache.h>
84#include <linux/percpu.h>
85#include <linux/hardirq.h>
86#include <linux/mmzone.h>
87#include <linux/slab.h>
88#include <linux/thread_info.h>
89#include <linux/err.h>
90#include <linux/uaccess.h>
91#include <linux/string.h>
92#include <linux/nodemask.h>
93#include <linux/mm.h>
Catalin Marinas179a8102009-09-07 10:14:42 +010094#include <linux/workqueue.h>
Catalin Marinas04609cc2009-10-28 13:33:12 +000095#include <linux/crc32.h>
Catalin Marinas3c7b4e62009-06-11 13:22:39 +010096
97#include <asm/sections.h>
98#include <asm/processor.h>
99#include <asm/atomic.h>
100
Pekka Enberg8e019362009-08-27 14:50:00 +0100101#include <linux/kmemcheck.h>
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100102#include <linux/kmemleak.h>
Laura Abbott94f202a2011-10-07 13:51:58 -0700103#include <linux/memory_hotplug.h>
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100104
105/*
106 * Kmemleak configuration and common defines.
107 */
108#define MAX_TRACE 16 /* stack trace length */
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100109#define MSECS_MIN_AGE 5000 /* minimum object age for reporting */
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100110#define SECS_FIRST_SCAN 60 /* delay before the first scan */
111#define SECS_SCAN_WAIT 600 /* subsequent auto scanning delay */
Catalin Marinasaf986032009-08-27 14:29:12 +0100112#define MAX_SCAN_SIZE 4096 /* maximum size of a scanned block */
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100113
114#define BYTES_PER_POINTER sizeof(void *)
115
Catalin Marinas216c04b2009-06-17 18:29:02 +0100116/* GFP bitmask for kmemleak internal allocations */
Catalin Marinas6ae4bd12011-01-27 10:30:26 +0000117#define gfp_kmemleak_mask(gfp) (((gfp) & (GFP_KERNEL | GFP_ATOMIC)) | \
118 __GFP_NORETRY | __GFP_NOMEMALLOC | \
119 __GFP_NOWARN)
Catalin Marinas216c04b2009-06-17 18:29:02 +0100120
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100121/* scanning area inside a memory block */
122struct kmemleak_scan_area {
123 struct hlist_node node;
Catalin Marinasc017b4b2009-10-28 13:33:09 +0000124 unsigned long start;
125 size_t size;
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100126};
127
Luis R. Rodrigueza1084c82009-09-04 17:44:52 -0700128#define KMEMLEAK_GREY 0
129#define KMEMLEAK_BLACK -1
130
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100131/*
132 * Structure holding the metadata for each allocated memory block.
133 * Modifications to such objects should be made while holding the
134 * object->lock. Insertions or deletions from object_list, gray_list or
135 * tree_node are already protected by the corresponding locks or mutex (see
136 * the notes on locking above). These objects are reference-counted
137 * (use_count) and freed using the RCU mechanism.
138 */
139struct kmemleak_object {
140 spinlock_t lock;
141 unsigned long flags; /* object status flags */
142 struct list_head object_list;
143 struct list_head gray_list;
144 struct prio_tree_node tree_node;
145 struct rcu_head rcu; /* object_list lockless traversal */
146 /* object usage count; object freed when use_count == 0 */
147 atomic_t use_count;
148 unsigned long pointer;
149 size_t size;
150 /* minimum number of a pointers found before it is considered leak */
151 int min_count;
152 /* the total number of pointers found pointing to this object */
153 int count;
Catalin Marinas04609cc2009-10-28 13:33:12 +0000154 /* checksum for detecting modified objects */
155 u32 checksum;
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100156 /* memory ranges to be scanned inside an object (empty for all) */
157 struct hlist_head area_list;
158 unsigned long trace[MAX_TRACE];
159 unsigned int trace_len;
160 unsigned long jiffies; /* creation timestamp */
161 pid_t pid; /* pid of the current task */
162 char comm[TASK_COMM_LEN]; /* executable name */
163};
164
165/* flag representing the memory block allocation status */
166#define OBJECT_ALLOCATED (1 << 0)
167/* flag set after the first reporting of an unreference object */
168#define OBJECT_REPORTED (1 << 1)
169/* flag set to not scan the object */
170#define OBJECT_NO_SCAN (1 << 2)
171
Sergey Senozhatsky0494e082009-08-27 14:29:18 +0100172/* number of bytes to print per line; must be 16 or 32 */
173#define HEX_ROW_SIZE 16
174/* number of bytes to print at a time (1, 2, 4, 8) */
175#define HEX_GROUP_SIZE 1
176/* include ASCII after the hex output */
177#define HEX_ASCII 1
178/* max number of lines to be printed */
179#define HEX_MAX_LINES 2
180
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100181/* the list of all allocated objects */
182static LIST_HEAD(object_list);
183/* the list of gray-colored objects (see color_gray comment below) */
184static LIST_HEAD(gray_list);
185/* prio search tree for object boundaries */
186static struct prio_tree_root object_tree_root;
187/* rw_lock protecting the access to object_list and prio_tree_root */
188static DEFINE_RWLOCK(kmemleak_lock);
189
190/* allocation caches for kmemleak internal data */
191static struct kmem_cache *object_cache;
192static struct kmem_cache *scan_area_cache;
193
194/* set if tracing memory operations is enabled */
195static atomic_t kmemleak_enabled = ATOMIC_INIT(0);
196/* set in the late_initcall if there were no errors */
197static atomic_t kmemleak_initialized = ATOMIC_INIT(0);
198/* enables or disables early logging of the memory operations */
199static atomic_t kmemleak_early_log = ATOMIC_INIT(1);
200/* set if a fata kmemleak error has occurred */
201static atomic_t kmemleak_error = ATOMIC_INIT(0);
202
203/* minimum and maximum address that may be valid pointers */
204static unsigned long min_addr = ULONG_MAX;
205static unsigned long max_addr;
206
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100207static struct task_struct *scan_thread;
Catalin Marinasacf49682009-06-26 17:38:29 +0100208/* used to avoid reporting of recently allocated objects */
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100209static unsigned long jiffies_min_age;
Catalin Marinasacf49682009-06-26 17:38:29 +0100210static unsigned long jiffies_last_scan;
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100211/* delay between automatic memory scannings */
212static signed long jiffies_scan_wait;
213/* enables or disables the task stacks scanning */
Catalin Marinase0a2a162009-06-26 17:38:25 +0100214static int kmemleak_stack_scan = 1;
Catalin Marinas4698c1f2009-06-26 17:38:27 +0100215/* protects the memory scanning, parameters and debug/kmemleak file access */
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100216static DEFINE_MUTEX(scan_mutex);
Jason Baronab0155a2010-07-19 11:54:17 +0100217/* setting kmemleak=on, will set this var, skipping the disable */
218static int kmemleak_skip_disable;
219
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100220
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100221/*
Catalin Marinas20301172009-06-17 18:29:04 +0100222 * Early object allocation/freeing logging. Kmemleak is initialized after the
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100223 * kernel allocator. However, both the kernel allocator and kmemleak may
Catalin Marinas20301172009-06-17 18:29:04 +0100224 * allocate memory blocks which need to be tracked. Kmemleak defines an
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100225 * arbitrary buffer to hold the allocation/freeing information before it is
226 * fully initialized.
227 */
228
229/* kmemleak operation type for early logging */
230enum {
231 KMEMLEAK_ALLOC,
232 KMEMLEAK_FREE,
Catalin Marinas53238a62009-07-07 10:33:00 +0100233 KMEMLEAK_FREE_PART,
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100234 KMEMLEAK_NOT_LEAK,
235 KMEMLEAK_IGNORE,
236 KMEMLEAK_SCAN_AREA,
237 KMEMLEAK_NO_SCAN
238};
239
240/*
241 * Structure holding the information passed to kmemleak callbacks during the
242 * early logging.
243 */
244struct early_log {
245 int op_type; /* kmemleak operation type */
246 const void *ptr; /* allocated/freed memory block */
247 size_t size; /* memory block size */
248 int min_count; /* minimum reference count */
Catalin Marinasfd678962009-08-27 14:29:17 +0100249 unsigned long trace[MAX_TRACE]; /* stack trace */
250 unsigned int trace_len; /* stack trace length */
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100251};
252
253/* early logging buffer and current position */
Catalin Marinasa6186d82009-08-27 14:29:16 +0100254static struct early_log
255 early_log[CONFIG_DEBUG_KMEMLEAK_EARLY_LOG_SIZE] __initdata;
256static int crt_early_log __initdata;
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100257
258static void kmemleak_disable(void);
259
260/*
261 * Print a warning and dump the stack trace.
262 */
263#define kmemleak_warn(x...) do { \
264 pr_warning(x); \
265 dump_stack(); \
266} while (0)
267
268/*
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300269 * Macro invoked when a serious kmemleak condition occurred and cannot be
Catalin Marinas20301172009-06-17 18:29:04 +0100270 * recovered from. Kmemleak will be disabled and further allocation/freeing
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100271 * tracing no longer available.
272 */
Catalin Marinas000814f2009-06-17 18:29:03 +0100273#define kmemleak_stop(x...) do { \
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100274 kmemleak_warn(x); \
275 kmemleak_disable(); \
276} while (0)
277
278/*
Sergey Senozhatsky0494e082009-08-27 14:29:18 +0100279 * Printing of the objects hex dump to the seq file. The number of lines to be
280 * printed is limited to HEX_MAX_LINES to prevent seq file spamming. The
281 * actual number of printed bytes depends on HEX_ROW_SIZE. It must be called
282 * with the object->lock held.
283 */
284static void hex_dump_object(struct seq_file *seq,
285 struct kmemleak_object *object)
286{
287 const u8 *ptr = (const u8 *)object->pointer;
288 int i, len, remaining;
289 unsigned char linebuf[HEX_ROW_SIZE * 5];
290
291 /* limit the number of lines to HEX_MAX_LINES */
292 remaining = len =
293 min(object->size, (size_t)(HEX_MAX_LINES * HEX_ROW_SIZE));
294
295 seq_printf(seq, " hex dump (first %d bytes):\n", len);
296 for (i = 0; i < len; i += HEX_ROW_SIZE) {
297 int linelen = min(remaining, HEX_ROW_SIZE);
298
299 remaining -= HEX_ROW_SIZE;
300 hex_dump_to_buffer(ptr + i, linelen, HEX_ROW_SIZE,
301 HEX_GROUP_SIZE, linebuf, sizeof(linebuf),
302 HEX_ASCII);
303 seq_printf(seq, " %s\n", linebuf);
304 }
305}
306
307/*
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100308 * Object colors, encoded with count and min_count:
309 * - white - orphan object, not enough references to it (count < min_count)
310 * - gray - not orphan, not marked as false positive (min_count == 0) or
311 * sufficient references to it (count >= min_count)
312 * - black - ignore, it doesn't contain references (e.g. text section)
313 * (min_count == -1). No function defined for this color.
314 * Newly created objects don't have any color assigned (object->count == -1)
315 * before the next memory scan when they become white.
316 */
Luis R. Rodriguez4a558dd2009-09-08 16:34:50 +0100317static bool color_white(const struct kmemleak_object *object)
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100318{
Luis R. Rodrigueza1084c82009-09-04 17:44:52 -0700319 return object->count != KMEMLEAK_BLACK &&
320 object->count < object->min_count;
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100321}
322
Luis R. Rodriguez4a558dd2009-09-08 16:34:50 +0100323static bool color_gray(const struct kmemleak_object *object)
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100324{
Luis R. Rodrigueza1084c82009-09-04 17:44:52 -0700325 return object->min_count != KMEMLEAK_BLACK &&
326 object->count >= object->min_count;
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100327}
328
329/*
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100330 * Objects are considered unreferenced only if their color is white, they have
331 * not be deleted and have a minimum age to avoid false positives caused by
332 * pointers temporarily stored in CPU registers.
333 */
Luis R. Rodriguez4a558dd2009-09-08 16:34:50 +0100334static bool unreferenced_object(struct kmemleak_object *object)
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100335{
Catalin Marinas04609cc2009-10-28 13:33:12 +0000336 return (color_white(object) && object->flags & OBJECT_ALLOCATED) &&
Catalin Marinasacf49682009-06-26 17:38:29 +0100337 time_before_eq(object->jiffies + jiffies_min_age,
338 jiffies_last_scan);
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100339}
340
341/*
Catalin Marinasbab4a342009-06-26 17:38:26 +0100342 * Printing of the unreferenced objects information to the seq file. The
343 * print_unreferenced function must be called with the object->lock held.
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100344 */
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100345static void print_unreferenced(struct seq_file *seq,
346 struct kmemleak_object *object)
347{
348 int i;
Catalin Marinasfefdd332009-10-28 13:33:12 +0000349 unsigned int msecs_age = jiffies_to_msecs(jiffies - object->jiffies);
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100350
Catalin Marinasbab4a342009-06-26 17:38:26 +0100351 seq_printf(seq, "unreferenced object 0x%08lx (size %zu):\n",
352 object->pointer, object->size);
Catalin Marinasfefdd332009-10-28 13:33:12 +0000353 seq_printf(seq, " comm \"%s\", pid %d, jiffies %lu (age %d.%03ds)\n",
354 object->comm, object->pid, object->jiffies,
355 msecs_age / 1000, msecs_age % 1000);
Sergey Senozhatsky0494e082009-08-27 14:29:18 +0100356 hex_dump_object(seq, object);
Catalin Marinasbab4a342009-06-26 17:38:26 +0100357 seq_printf(seq, " backtrace:\n");
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100358
359 for (i = 0; i < object->trace_len; i++) {
360 void *ptr = (void *)object->trace[i];
Catalin Marinasbab4a342009-06-26 17:38:26 +0100361 seq_printf(seq, " [<%p>] %pS\n", ptr, ptr);
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100362 }
363}
364
365/*
366 * Print the kmemleak_object information. This function is used mainly for
367 * debugging special cases when kmemleak operations. It must be called with
368 * the object->lock held.
369 */
370static void dump_object_info(struct kmemleak_object *object)
371{
372 struct stack_trace trace;
373
374 trace.nr_entries = object->trace_len;
375 trace.entries = object->trace;
376
Joe Perchesae281062009-06-23 14:40:26 +0100377 pr_notice("Object 0x%08lx (size %zu):\n",
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100378 object->tree_node.start, object->size);
379 pr_notice(" comm \"%s\", pid %d, jiffies %lu\n",
380 object->comm, object->pid, object->jiffies);
381 pr_notice(" min_count = %d\n", object->min_count);
382 pr_notice(" count = %d\n", object->count);
Catalin Marinas189d84e2009-08-27 14:29:15 +0100383 pr_notice(" flags = 0x%lx\n", object->flags);
Catalin Marinas04609cc2009-10-28 13:33:12 +0000384 pr_notice(" checksum = %d\n", object->checksum);
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100385 pr_notice(" backtrace:\n");
386 print_stack_trace(&trace, 4);
387}
388
389/*
390 * Look-up a memory block metadata (kmemleak_object) in the priority search
391 * tree based on a pointer value. If alias is 0, only values pointing to the
392 * beginning of the memory block are allowed. The kmemleak_lock must be held
393 * when calling this function.
394 */
395static struct kmemleak_object *lookup_object(unsigned long ptr, int alias)
396{
397 struct prio_tree_node *node;
398 struct prio_tree_iter iter;
399 struct kmemleak_object *object;
400
401 prio_tree_iter_init(&iter, &object_tree_root, ptr, ptr);
402 node = prio_tree_next(&iter);
403 if (node) {
404 object = prio_tree_entry(node, struct kmemleak_object,
405 tree_node);
406 if (!alias && object->pointer != ptr) {
Catalin Marinasa7686a42010-07-19 11:54:16 +0100407 pr_warning("Found object by alias at 0x%08lx\n", ptr);
408 dump_stack();
409 dump_object_info(object);
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100410 object = NULL;
411 }
412 } else
413 object = NULL;
414
415 return object;
416}
417
418/*
419 * Increment the object use_count. Return 1 if successful or 0 otherwise. Note
420 * that once an object's use_count reached 0, the RCU freeing was already
421 * registered and the object should no longer be used. This function must be
422 * called under the protection of rcu_read_lock().
423 */
424static int get_object(struct kmemleak_object *object)
425{
426 return atomic_inc_not_zero(&object->use_count);
427}
428
429/*
430 * RCU callback to free a kmemleak_object.
431 */
432static void free_object_rcu(struct rcu_head *rcu)
433{
434 struct hlist_node *elem, *tmp;
435 struct kmemleak_scan_area *area;
436 struct kmemleak_object *object =
437 container_of(rcu, struct kmemleak_object, rcu);
438
439 /*
440 * Once use_count is 0 (guaranteed by put_object), there is no other
441 * code accessing this object, hence no need for locking.
442 */
443 hlist_for_each_entry_safe(area, elem, tmp, &object->area_list, node) {
444 hlist_del(elem);
445 kmem_cache_free(scan_area_cache, area);
446 }
447 kmem_cache_free(object_cache, object);
448}
449
450/*
451 * Decrement the object use_count. Once the count is 0, free the object using
452 * an RCU callback. Since put_object() may be called via the kmemleak_free() ->
453 * delete_object() path, the delayed RCU freeing ensures that there is no
454 * recursive call to the kernel allocator. Lock-less RCU object_list traversal
455 * is also possible.
456 */
457static void put_object(struct kmemleak_object *object)
458{
459 if (!atomic_dec_and_test(&object->use_count))
460 return;
461
462 /* should only get here after delete_object was called */
463 WARN_ON(object->flags & OBJECT_ALLOCATED);
464
465 call_rcu(&object->rcu, free_object_rcu);
466}
467
468/*
469 * Look up an object in the prio search tree and increase its use_count.
470 */
471static struct kmemleak_object *find_and_get_object(unsigned long ptr, int alias)
472{
473 unsigned long flags;
474 struct kmemleak_object *object = NULL;
475
476 rcu_read_lock();
477 read_lock_irqsave(&kmemleak_lock, flags);
478 if (ptr >= min_addr && ptr < max_addr)
479 object = lookup_object(ptr, alias);
480 read_unlock_irqrestore(&kmemleak_lock, flags);
481
482 /* check whether the object is still available */
483 if (object && !get_object(object))
484 object = NULL;
485 rcu_read_unlock();
486
487 return object;
488}
489
490/*
Catalin Marinasfd678962009-08-27 14:29:17 +0100491 * Save stack trace to the given array of MAX_TRACE size.
492 */
493static int __save_stack_trace(unsigned long *trace)
494{
495 struct stack_trace stack_trace;
496
497 stack_trace.max_entries = MAX_TRACE;
498 stack_trace.nr_entries = 0;
499 stack_trace.entries = trace;
500 stack_trace.skip = 2;
501 save_stack_trace(&stack_trace);
502
503 return stack_trace.nr_entries;
504}
505
506/*
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100507 * Create the metadata (struct kmemleak_object) corresponding to an allocated
508 * memory block and add it to the object_list and object_tree_root.
509 */
Catalin Marinasfd678962009-08-27 14:29:17 +0100510static struct kmemleak_object *create_object(unsigned long ptr, size_t size,
511 int min_count, gfp_t gfp)
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100512{
513 unsigned long flags;
514 struct kmemleak_object *object;
515 struct prio_tree_node *node;
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100516
Catalin Marinas6ae4bd12011-01-27 10:30:26 +0000517 object = kmem_cache_alloc(object_cache, gfp_kmemleak_mask(gfp));
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100518 if (!object) {
Catalin Marinas6ae4bd12011-01-27 10:30:26 +0000519 pr_warning("Cannot allocate a kmemleak_object structure\n");
520 kmemleak_disable();
Catalin Marinasfd678962009-08-27 14:29:17 +0100521 return NULL;
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100522 }
523
524 INIT_LIST_HEAD(&object->object_list);
525 INIT_LIST_HEAD(&object->gray_list);
526 INIT_HLIST_HEAD(&object->area_list);
527 spin_lock_init(&object->lock);
528 atomic_set(&object->use_count, 1);
Catalin Marinas04609cc2009-10-28 13:33:12 +0000529 object->flags = OBJECT_ALLOCATED;
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100530 object->pointer = ptr;
531 object->size = size;
532 object->min_count = min_count;
Catalin Marinas04609cc2009-10-28 13:33:12 +0000533 object->count = 0; /* white color initially */
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100534 object->jiffies = jiffies;
Catalin Marinas04609cc2009-10-28 13:33:12 +0000535 object->checksum = 0;
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100536
537 /* task information */
538 if (in_irq()) {
539 object->pid = 0;
540 strncpy(object->comm, "hardirq", sizeof(object->comm));
541 } else if (in_softirq()) {
542 object->pid = 0;
543 strncpy(object->comm, "softirq", sizeof(object->comm));
544 } else {
545 object->pid = current->pid;
546 /*
547 * There is a small chance of a race with set_task_comm(),
548 * however using get_task_comm() here may cause locking
549 * dependency issues with current->alloc_lock. In the worst
550 * case, the command line is not correct.
551 */
552 strncpy(object->comm, current->comm, sizeof(object->comm));
553 }
554
555 /* kernel backtrace */
Catalin Marinasfd678962009-08-27 14:29:17 +0100556 object->trace_len = __save_stack_trace(object->trace);
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100557
558 INIT_PRIO_TREE_NODE(&object->tree_node);
559 object->tree_node.start = ptr;
560 object->tree_node.last = ptr + size - 1;
561
562 write_lock_irqsave(&kmemleak_lock, flags);
Luis R. Rodriguez0580a182009-09-08 17:32:34 +0100563
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100564 min_addr = min(min_addr, ptr);
565 max_addr = max(max_addr, ptr + size);
566 node = prio_tree_insert(&object_tree_root, &object->tree_node);
567 /*
568 * The code calling the kernel does not yet have the pointer to the
569 * memory block to be able to free it. However, we still hold the
570 * kmemleak_lock here in case parts of the kernel started freeing
571 * random memory blocks.
572 */
573 if (node != &object->tree_node) {
Joe Perchesae281062009-06-23 14:40:26 +0100574 kmemleak_stop("Cannot insert 0x%lx into the object search tree "
575 "(already existing)\n", ptr);
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100576 object = lookup_object(ptr, 1);
Luis R. Rodriguez0580a182009-09-08 17:32:34 +0100577 spin_lock(&object->lock);
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100578 dump_object_info(object);
Luis R. Rodriguez0580a182009-09-08 17:32:34 +0100579 spin_unlock(&object->lock);
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100580
581 goto out;
582 }
583 list_add_tail_rcu(&object->object_list, &object_list);
584out:
585 write_unlock_irqrestore(&kmemleak_lock, flags);
Catalin Marinasfd678962009-08-27 14:29:17 +0100586 return object;
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100587}
588
589/*
590 * Remove the metadata (struct kmemleak_object) for a memory block from the
591 * object_list and object_tree_root and decrement its use_count.
592 */
Catalin Marinas53238a62009-07-07 10:33:00 +0100593static void __delete_object(struct kmemleak_object *object)
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100594{
595 unsigned long flags;
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100596
597 write_lock_irqsave(&kmemleak_lock, flags);
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100598 prio_tree_remove(&object_tree_root, &object->tree_node);
599 list_del_rcu(&object->object_list);
600 write_unlock_irqrestore(&kmemleak_lock, flags);
601
602 WARN_ON(!(object->flags & OBJECT_ALLOCATED));
Catalin Marinas53238a62009-07-07 10:33:00 +0100603 WARN_ON(atomic_read(&object->use_count) < 2);
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100604
605 /*
606 * Locking here also ensures that the corresponding memory block
607 * cannot be freed when it is being scanned.
608 */
609 spin_lock_irqsave(&object->lock, flags);
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100610 object->flags &= ~OBJECT_ALLOCATED;
611 spin_unlock_irqrestore(&object->lock, flags);
612 put_object(object);
613}
614
615/*
Catalin Marinas53238a62009-07-07 10:33:00 +0100616 * Look up the metadata (struct kmemleak_object) corresponding to ptr and
617 * delete it.
618 */
619static void delete_object_full(unsigned long ptr)
620{
621 struct kmemleak_object *object;
622
623 object = find_and_get_object(ptr, 0);
624 if (!object) {
625#ifdef DEBUG
626 kmemleak_warn("Freeing unknown object at 0x%08lx\n",
627 ptr);
628#endif
629 return;
630 }
631 __delete_object(object);
632 put_object(object);
633}
634
635/*
636 * Look up the metadata (struct kmemleak_object) corresponding to ptr and
637 * delete it. If the memory block is partially freed, the function may create
638 * additional metadata for the remaining parts of the block.
639 */
640static void delete_object_part(unsigned long ptr, size_t size)
641{
642 struct kmemleak_object *object;
643 unsigned long start, end;
644
645 object = find_and_get_object(ptr, 1);
646 if (!object) {
647#ifdef DEBUG
648 kmemleak_warn("Partially freeing unknown object at 0x%08lx "
649 "(size %zu)\n", ptr, size);
650#endif
651 return;
652 }
653 __delete_object(object);
654
655 /*
656 * Create one or two objects that may result from the memory block
657 * split. Note that partial freeing is only done by free_bootmem() and
658 * this happens before kmemleak_init() is called. The path below is
659 * only executed during early log recording in kmemleak_init(), so
660 * GFP_KERNEL is enough.
661 */
662 start = object->pointer;
663 end = object->pointer + object->size;
664 if (ptr > start)
665 create_object(start, ptr - start, object->min_count,
666 GFP_KERNEL);
667 if (ptr + size < end)
668 create_object(ptr + size, end - ptr - size, object->min_count,
669 GFP_KERNEL);
670
671 put_object(object);
672}
Luis R. Rodrigueza1084c82009-09-04 17:44:52 -0700673
674static void __paint_it(struct kmemleak_object *object, int color)
675{
676 object->min_count = color;
677 if (color == KMEMLEAK_BLACK)
678 object->flags |= OBJECT_NO_SCAN;
679}
680
681static void paint_it(struct kmemleak_object *object, int color)
682{
683 unsigned long flags;
684
685 spin_lock_irqsave(&object->lock, flags);
686 __paint_it(object, color);
687 spin_unlock_irqrestore(&object->lock, flags);
688}
689
690static void paint_ptr(unsigned long ptr, int color)
691{
692 struct kmemleak_object *object;
693
694 object = find_and_get_object(ptr, 0);
695 if (!object) {
696 kmemleak_warn("Trying to color unknown object "
697 "at 0x%08lx as %s\n", ptr,
698 (color == KMEMLEAK_GREY) ? "Grey" :
699 (color == KMEMLEAK_BLACK) ? "Black" : "Unknown");
700 return;
701 }
702 paint_it(object, color);
703 put_object(object);
704}
705
Catalin Marinas53238a62009-07-07 10:33:00 +0100706/*
Holger Hans Peter Freyther145b64b2010-07-22 19:54:13 +0800707 * Mark an object permanently as gray-colored so that it can no longer be
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100708 * reported as a leak. This is used in general to mark a false positive.
709 */
710static void make_gray_object(unsigned long ptr)
711{
Luis R. Rodrigueza1084c82009-09-04 17:44:52 -0700712 paint_ptr(ptr, KMEMLEAK_GREY);
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100713}
714
715/*
716 * Mark the object as black-colored so that it is ignored from scans and
717 * reporting.
718 */
719static void make_black_object(unsigned long ptr)
720{
Luis R. Rodrigueza1084c82009-09-04 17:44:52 -0700721 paint_ptr(ptr, KMEMLEAK_BLACK);
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100722}
723
724/*
725 * Add a scanning area to the object. If at least one such area is added,
726 * kmemleak will only scan these ranges rather than the whole memory block.
727 */
Catalin Marinasc017b4b2009-10-28 13:33:09 +0000728static void add_scan_area(unsigned long ptr, size_t size, gfp_t gfp)
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100729{
730 unsigned long flags;
731 struct kmemleak_object *object;
732 struct kmemleak_scan_area *area;
733
Catalin Marinasc017b4b2009-10-28 13:33:09 +0000734 object = find_and_get_object(ptr, 1);
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100735 if (!object) {
Joe Perchesae281062009-06-23 14:40:26 +0100736 kmemleak_warn("Adding scan area to unknown object at 0x%08lx\n",
737 ptr);
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100738 return;
739 }
740
Catalin Marinas6ae4bd12011-01-27 10:30:26 +0000741 area = kmem_cache_alloc(scan_area_cache, gfp_kmemleak_mask(gfp));
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100742 if (!area) {
Catalin Marinas6ae4bd12011-01-27 10:30:26 +0000743 pr_warning("Cannot allocate a scan area\n");
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100744 goto out;
745 }
746
747 spin_lock_irqsave(&object->lock, flags);
Catalin Marinasc017b4b2009-10-28 13:33:09 +0000748 if (ptr + size > object->pointer + object->size) {
Joe Perchesae281062009-06-23 14:40:26 +0100749 kmemleak_warn("Scan area larger than object 0x%08lx\n", ptr);
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100750 dump_object_info(object);
751 kmem_cache_free(scan_area_cache, area);
752 goto out_unlock;
753 }
754
755 INIT_HLIST_NODE(&area->node);
Catalin Marinasc017b4b2009-10-28 13:33:09 +0000756 area->start = ptr;
757 area->size = size;
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100758
759 hlist_add_head(&area->node, &object->area_list);
760out_unlock:
761 spin_unlock_irqrestore(&object->lock, flags);
762out:
763 put_object(object);
764}
765
766/*
767 * Set the OBJECT_NO_SCAN flag for the object corresponding to the give
768 * pointer. Such object will not be scanned by kmemleak but references to it
769 * are searched.
770 */
771static void object_no_scan(unsigned long ptr)
772{
773 unsigned long flags;
774 struct kmemleak_object *object;
775
776 object = find_and_get_object(ptr, 0);
777 if (!object) {
Joe Perchesae281062009-06-23 14:40:26 +0100778 kmemleak_warn("Not scanning unknown object at 0x%08lx\n", ptr);
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100779 return;
780 }
781
782 spin_lock_irqsave(&object->lock, flags);
783 object->flags |= OBJECT_NO_SCAN;
784 spin_unlock_irqrestore(&object->lock, flags);
785 put_object(object);
786}
787
788/*
789 * Log an early kmemleak_* call to the early_log buffer. These calls will be
790 * processed later once kmemleak is fully initialized.
791 */
Catalin Marinasa6186d82009-08-27 14:29:16 +0100792static void __init log_early(int op_type, const void *ptr, size_t size,
Catalin Marinasc017b4b2009-10-28 13:33:09 +0000793 int min_count)
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100794{
795 unsigned long flags;
796 struct early_log *log;
797
798 if (crt_early_log >= ARRAY_SIZE(early_log)) {
Catalin Marinasaddd72c2009-09-11 10:42:09 +0100799 pr_warning("Early log buffer exceeded, "
800 "please increase DEBUG_KMEMLEAK_EARLY_LOG_SIZE\n");
Catalin Marinasa9d90582009-06-25 10:16:11 +0100801 kmemleak_disable();
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100802 return;
803 }
804
805 /*
806 * There is no need for locking since the kernel is still in UP mode
807 * at this stage. Disabling the IRQs is enough.
808 */
809 local_irq_save(flags);
810 log = &early_log[crt_early_log];
811 log->op_type = op_type;
812 log->ptr = ptr;
813 log->size = size;
814 log->min_count = min_count;
Catalin Marinasfd678962009-08-27 14:29:17 +0100815 if (op_type == KMEMLEAK_ALLOC)
816 log->trace_len = __save_stack_trace(log->trace);
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100817 crt_early_log++;
818 local_irq_restore(flags);
819}
820
821/*
Catalin Marinasfd678962009-08-27 14:29:17 +0100822 * Log an early allocated block and populate the stack trace.
823 */
824static void early_alloc(struct early_log *log)
825{
826 struct kmemleak_object *object;
827 unsigned long flags;
828 int i;
829
830 if (!atomic_read(&kmemleak_enabled) || !log->ptr || IS_ERR(log->ptr))
831 return;
832
833 /*
834 * RCU locking needed to ensure object is not freed via put_object().
835 */
836 rcu_read_lock();
837 object = create_object((unsigned long)log->ptr, log->size,
Tetsuo Handac1bcd6b2009-10-09 10:39:24 +0100838 log->min_count, GFP_ATOMIC);
Catalin Marinas0d5d1aa2009-10-09 10:30:34 +0100839 if (!object)
840 goto out;
Catalin Marinasfd678962009-08-27 14:29:17 +0100841 spin_lock_irqsave(&object->lock, flags);
842 for (i = 0; i < log->trace_len; i++)
843 object->trace[i] = log->trace[i];
844 object->trace_len = log->trace_len;
845 spin_unlock_irqrestore(&object->lock, flags);
Catalin Marinas0d5d1aa2009-10-09 10:30:34 +0100846out:
Catalin Marinasfd678962009-08-27 14:29:17 +0100847 rcu_read_unlock();
848}
849
Catalin Marinasa2b6bf62010-07-19 11:54:17 +0100850/**
851 * kmemleak_alloc - register a newly allocated object
852 * @ptr: pointer to beginning of the object
853 * @size: size of the object
854 * @min_count: minimum number of references to this object. If during memory
855 * scanning a number of references less than @min_count is found,
856 * the object is reported as a memory leak. If @min_count is 0,
857 * the object is never reported as a leak. If @min_count is -1,
858 * the object is ignored (not scanned and not reported as a leak)
859 * @gfp: kmalloc() flags used for kmemleak internal memory allocations
860 *
861 * This function is called from the kernel allocators when a new object
862 * (memory block) is allocated (kmem_cache_alloc, kmalloc, vmalloc etc.).
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100863 */
Catalin Marinasa6186d82009-08-27 14:29:16 +0100864void __ref kmemleak_alloc(const void *ptr, size_t size, int min_count,
865 gfp_t gfp)
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100866{
867 pr_debug("%s(0x%p, %zu, %d)\n", __func__, ptr, size, min_count);
868
869 if (atomic_read(&kmemleak_enabled) && ptr && !IS_ERR(ptr))
870 create_object((unsigned long)ptr, size, min_count, gfp);
871 else if (atomic_read(&kmemleak_early_log))
Catalin Marinasc017b4b2009-10-28 13:33:09 +0000872 log_early(KMEMLEAK_ALLOC, ptr, size, min_count);
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100873}
874EXPORT_SYMBOL_GPL(kmemleak_alloc);
875
Catalin Marinasa2b6bf62010-07-19 11:54:17 +0100876/**
877 * kmemleak_free - unregister a previously registered object
878 * @ptr: pointer to beginning of the object
879 *
880 * This function is called from the kernel allocators when an object (memory
881 * block) is freed (kmem_cache_free, kfree, vfree etc.).
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100882 */
Catalin Marinasa6186d82009-08-27 14:29:16 +0100883void __ref kmemleak_free(const void *ptr)
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100884{
885 pr_debug("%s(0x%p)\n", __func__, ptr);
886
887 if (atomic_read(&kmemleak_enabled) && ptr && !IS_ERR(ptr))
Catalin Marinas53238a62009-07-07 10:33:00 +0100888 delete_object_full((unsigned long)ptr);
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100889 else if (atomic_read(&kmemleak_early_log))
Catalin Marinasc017b4b2009-10-28 13:33:09 +0000890 log_early(KMEMLEAK_FREE, ptr, 0, 0);
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100891}
892EXPORT_SYMBOL_GPL(kmemleak_free);
893
Catalin Marinasa2b6bf62010-07-19 11:54:17 +0100894/**
895 * kmemleak_free_part - partially unregister a previously registered object
896 * @ptr: pointer to the beginning or inside the object. This also
897 * represents the start of the range to be freed
898 * @size: size to be unregistered
899 *
900 * This function is called when only a part of a memory block is freed
901 * (usually from the bootmem allocator).
Catalin Marinas53238a62009-07-07 10:33:00 +0100902 */
Catalin Marinasa6186d82009-08-27 14:29:16 +0100903void __ref kmemleak_free_part(const void *ptr, size_t size)
Catalin Marinas53238a62009-07-07 10:33:00 +0100904{
905 pr_debug("%s(0x%p)\n", __func__, ptr);
906
907 if (atomic_read(&kmemleak_enabled) && ptr && !IS_ERR(ptr))
908 delete_object_part((unsigned long)ptr, size);
909 else if (atomic_read(&kmemleak_early_log))
Catalin Marinasc017b4b2009-10-28 13:33:09 +0000910 log_early(KMEMLEAK_FREE_PART, ptr, size, 0);
Catalin Marinas53238a62009-07-07 10:33:00 +0100911}
912EXPORT_SYMBOL_GPL(kmemleak_free_part);
913
Catalin Marinasa2b6bf62010-07-19 11:54:17 +0100914/**
915 * kmemleak_not_leak - mark an allocated object as false positive
916 * @ptr: pointer to beginning of the object
917 *
918 * Calling this function on an object will cause the memory block to no longer
919 * be reported as leak and always be scanned.
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100920 */
Catalin Marinasa6186d82009-08-27 14:29:16 +0100921void __ref kmemleak_not_leak(const void *ptr)
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100922{
923 pr_debug("%s(0x%p)\n", __func__, ptr);
924
925 if (atomic_read(&kmemleak_enabled) && ptr && !IS_ERR(ptr))
926 make_gray_object((unsigned long)ptr);
927 else if (atomic_read(&kmemleak_early_log))
Catalin Marinasc017b4b2009-10-28 13:33:09 +0000928 log_early(KMEMLEAK_NOT_LEAK, ptr, 0, 0);
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100929}
930EXPORT_SYMBOL(kmemleak_not_leak);
931
Catalin Marinasa2b6bf62010-07-19 11:54:17 +0100932/**
933 * kmemleak_ignore - ignore an allocated object
934 * @ptr: pointer to beginning of the object
935 *
936 * Calling this function on an object will cause the memory block to be
937 * ignored (not scanned and not reported as a leak). This is usually done when
938 * it is known that the corresponding block is not a leak and does not contain
939 * any references to other allocated memory blocks.
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100940 */
Catalin Marinasa6186d82009-08-27 14:29:16 +0100941void __ref kmemleak_ignore(const void *ptr)
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100942{
943 pr_debug("%s(0x%p)\n", __func__, ptr);
944
945 if (atomic_read(&kmemleak_enabled) && ptr && !IS_ERR(ptr))
946 make_black_object((unsigned long)ptr);
947 else if (atomic_read(&kmemleak_early_log))
Catalin Marinasc017b4b2009-10-28 13:33:09 +0000948 log_early(KMEMLEAK_IGNORE, ptr, 0, 0);
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100949}
950EXPORT_SYMBOL(kmemleak_ignore);
951
Catalin Marinasa2b6bf62010-07-19 11:54:17 +0100952/**
953 * kmemleak_scan_area - limit the range to be scanned in an allocated object
954 * @ptr: pointer to beginning or inside the object. This also
955 * represents the start of the scan area
956 * @size: size of the scan area
957 * @gfp: kmalloc() flags used for kmemleak internal memory allocations
958 *
959 * This function is used when it is known that only certain parts of an object
960 * contain references to other objects. Kmemleak will only scan these areas
961 * reducing the number false negatives.
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100962 */
Catalin Marinasc017b4b2009-10-28 13:33:09 +0000963void __ref kmemleak_scan_area(const void *ptr, size_t size, gfp_t gfp)
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100964{
965 pr_debug("%s(0x%p)\n", __func__, ptr);
966
967 if (atomic_read(&kmemleak_enabled) && ptr && !IS_ERR(ptr))
Catalin Marinasc017b4b2009-10-28 13:33:09 +0000968 add_scan_area((unsigned long)ptr, size, gfp);
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100969 else if (atomic_read(&kmemleak_early_log))
Catalin Marinasc017b4b2009-10-28 13:33:09 +0000970 log_early(KMEMLEAK_SCAN_AREA, ptr, size, 0);
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100971}
972EXPORT_SYMBOL(kmemleak_scan_area);
973
Catalin Marinasa2b6bf62010-07-19 11:54:17 +0100974/**
975 * kmemleak_no_scan - do not scan an allocated object
976 * @ptr: pointer to beginning of the object
977 *
978 * This function notifies kmemleak not to scan the given memory block. Useful
979 * in situations where it is known that the given object does not contain any
980 * references to other objects. Kmemleak will not scan such objects reducing
981 * the number of false negatives.
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100982 */
Catalin Marinasa6186d82009-08-27 14:29:16 +0100983void __ref kmemleak_no_scan(const void *ptr)
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100984{
985 pr_debug("%s(0x%p)\n", __func__, ptr);
986
987 if (atomic_read(&kmemleak_enabled) && ptr && !IS_ERR(ptr))
988 object_no_scan((unsigned long)ptr);
989 else if (atomic_read(&kmemleak_early_log))
Catalin Marinasc017b4b2009-10-28 13:33:09 +0000990 log_early(KMEMLEAK_NO_SCAN, ptr, 0, 0);
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100991}
992EXPORT_SYMBOL(kmemleak_no_scan);
993
994/*
Catalin Marinas04609cc2009-10-28 13:33:12 +0000995 * Update an object's checksum and return true if it was modified.
996 */
997static bool update_checksum(struct kmemleak_object *object)
998{
999 u32 old_csum = object->checksum;
1000
1001 if (!kmemcheck_is_obj_initialized(object->pointer, object->size))
1002 return false;
1003
1004 object->checksum = crc32(0, (void *)object->pointer, object->size);
1005 return object->checksum != old_csum;
1006}
1007
1008/*
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001009 * Memory scanning is a long process and it needs to be interruptable. This
Lucas De Marchi25985ed2011-03-30 22:57:33 -03001010 * function checks whether such interrupt condition occurred.
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001011 */
1012static int scan_should_stop(void)
1013{
1014 if (!atomic_read(&kmemleak_enabled))
1015 return 1;
1016
1017 /*
1018 * This function may be called from either process or kthread context,
1019 * hence the need to check for both stop conditions.
1020 */
1021 if (current->mm)
1022 return signal_pending(current);
1023 else
1024 return kthread_should_stop();
1025
1026 return 0;
1027}
1028
1029/*
1030 * Scan a memory block (exclusive range) for valid pointers and add those
1031 * found to the gray list.
1032 */
1033static void scan_block(void *_start, void *_end,
Catalin Marinas4b8a9672009-07-07 10:32:56 +01001034 struct kmemleak_object *scanned, int allow_resched)
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001035{
1036 unsigned long *ptr;
1037 unsigned long *start = PTR_ALIGN(_start, BYTES_PER_POINTER);
1038 unsigned long *end = _end - (BYTES_PER_POINTER - 1);
1039
1040 for (ptr = start; ptr < end; ptr++) {
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001041 struct kmemleak_object *object;
Pekka Enberg8e019362009-08-27 14:50:00 +01001042 unsigned long flags;
1043 unsigned long pointer;
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001044
Catalin Marinas4b8a9672009-07-07 10:32:56 +01001045 if (allow_resched)
1046 cond_resched();
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001047 if (scan_should_stop())
1048 break;
1049
Pekka Enberg8e019362009-08-27 14:50:00 +01001050 /* don't scan uninitialized memory */
1051 if (!kmemcheck_is_obj_initialized((unsigned long)ptr,
1052 BYTES_PER_POINTER))
1053 continue;
1054
1055 pointer = *ptr;
1056
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001057 object = find_and_get_object(pointer, 1);
1058 if (!object)
1059 continue;
1060 if (object == scanned) {
1061 /* self referenced, ignore */
1062 put_object(object);
1063 continue;
1064 }
1065
1066 /*
1067 * Avoid the lockdep recursive warning on object->lock being
1068 * previously acquired in scan_object(). These locks are
1069 * enclosed by scan_mutex.
1070 */
1071 spin_lock_irqsave_nested(&object->lock, flags,
1072 SINGLE_DEPTH_NESTING);
1073 if (!color_white(object)) {
1074 /* non-orphan, ignored or new */
1075 spin_unlock_irqrestore(&object->lock, flags);
1076 put_object(object);
1077 continue;
1078 }
1079
1080 /*
1081 * Increase the object's reference count (number of pointers
1082 * to the memory block). If this count reaches the required
1083 * minimum, the object's color will become gray and it will be
1084 * added to the gray_list.
1085 */
1086 object->count++;
Catalin Marinas0587da42009-10-28 13:33:11 +00001087 if (color_gray(object)) {
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001088 list_add_tail(&object->gray_list, &gray_list);
Catalin Marinas0587da42009-10-28 13:33:11 +00001089 spin_unlock_irqrestore(&object->lock, flags);
1090 continue;
1091 }
1092
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001093 spin_unlock_irqrestore(&object->lock, flags);
Catalin Marinas0587da42009-10-28 13:33:11 +00001094 put_object(object);
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001095 }
1096}
1097
1098/*
1099 * Scan a memory block corresponding to a kmemleak_object. A condition is
1100 * that object->use_count >= 1.
1101 */
1102static void scan_object(struct kmemleak_object *object)
1103{
1104 struct kmemleak_scan_area *area;
1105 struct hlist_node *elem;
1106 unsigned long flags;
1107
1108 /*
Uwe Kleine-König21ae2952009-10-07 15:21:09 +02001109 * Once the object->lock is acquired, the corresponding memory block
1110 * cannot be freed (the same lock is acquired in delete_object).
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001111 */
1112 spin_lock_irqsave(&object->lock, flags);
1113 if (object->flags & OBJECT_NO_SCAN)
1114 goto out;
1115 if (!(object->flags & OBJECT_ALLOCATED))
1116 /* already freed object */
1117 goto out;
Catalin Marinasaf986032009-08-27 14:29:12 +01001118 if (hlist_empty(&object->area_list)) {
1119 void *start = (void *)object->pointer;
1120 void *end = (void *)(object->pointer + object->size);
1121
1122 while (start < end && (object->flags & OBJECT_ALLOCATED) &&
1123 !(object->flags & OBJECT_NO_SCAN)) {
1124 scan_block(start, min(start + MAX_SCAN_SIZE, end),
1125 object, 0);
1126 start += MAX_SCAN_SIZE;
1127
1128 spin_unlock_irqrestore(&object->lock, flags);
1129 cond_resched();
1130 spin_lock_irqsave(&object->lock, flags);
1131 }
1132 } else
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001133 hlist_for_each_entry(area, elem, &object->area_list, node)
Catalin Marinasc017b4b2009-10-28 13:33:09 +00001134 scan_block((void *)area->start,
1135 (void *)(area->start + area->size),
1136 object, 0);
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001137out:
1138 spin_unlock_irqrestore(&object->lock, flags);
1139}
1140
1141/*
Catalin Marinas04609cc2009-10-28 13:33:12 +00001142 * Scan the objects already referenced (gray objects). More objects will be
1143 * referenced and, if there are no memory leaks, all the objects are scanned.
1144 */
1145static void scan_gray_list(void)
1146{
1147 struct kmemleak_object *object, *tmp;
1148
1149 /*
1150 * The list traversal is safe for both tail additions and removals
1151 * from inside the loop. The kmemleak objects cannot be freed from
1152 * outside the loop because their use_count was incremented.
1153 */
1154 object = list_entry(gray_list.next, typeof(*object), gray_list);
1155 while (&object->gray_list != &gray_list) {
1156 cond_resched();
1157
1158 /* may add new objects to the list */
1159 if (!scan_should_stop())
1160 scan_object(object);
1161
1162 tmp = list_entry(object->gray_list.next, typeof(*object),
1163 gray_list);
1164
1165 /* remove the object from the list and release it */
1166 list_del(&object->gray_list);
1167 put_object(object);
1168
1169 object = tmp;
1170 }
1171 WARN_ON(!list_empty(&gray_list));
1172}
1173
1174/*
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001175 * Scan data sections and all the referenced memory blocks allocated via the
1176 * kernel's standard allocators. This function must be called with the
1177 * scan_mutex held.
1178 */
1179static void kmemleak_scan(void)
1180{
1181 unsigned long flags;
Catalin Marinas04609cc2009-10-28 13:33:12 +00001182 struct kmemleak_object *object;
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001183 int i;
Catalin Marinas4698c1f2009-06-26 17:38:27 +01001184 int new_leaks = 0;
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001185
Catalin Marinasacf49682009-06-26 17:38:29 +01001186 jiffies_last_scan = jiffies;
1187
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001188 /* prepare the kmemleak_object's */
1189 rcu_read_lock();
1190 list_for_each_entry_rcu(object, &object_list, object_list) {
1191 spin_lock_irqsave(&object->lock, flags);
1192#ifdef DEBUG
1193 /*
1194 * With a few exceptions there should be a maximum of
1195 * 1 reference to any object at this point.
1196 */
1197 if (atomic_read(&object->use_count) > 1) {
Joe Perchesae281062009-06-23 14:40:26 +01001198 pr_debug("object->use_count = %d\n",
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001199 atomic_read(&object->use_count));
1200 dump_object_info(object);
1201 }
1202#endif
1203 /* reset the reference count (whiten the object) */
1204 object->count = 0;
1205 if (color_gray(object) && get_object(object))
1206 list_add_tail(&object->gray_list, &gray_list);
1207
1208 spin_unlock_irqrestore(&object->lock, flags);
1209 }
1210 rcu_read_unlock();
1211
1212 /* data/bss scanning */
Catalin Marinas4b8a9672009-07-07 10:32:56 +01001213 scan_block(_sdata, _edata, NULL, 1);
1214 scan_block(__bss_start, __bss_stop, NULL, 1);
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001215
1216#ifdef CONFIG_SMP
1217 /* per-cpu sections scanning */
1218 for_each_possible_cpu(i)
1219 scan_block(__per_cpu_start + per_cpu_offset(i),
Catalin Marinas4b8a9672009-07-07 10:32:56 +01001220 __per_cpu_end + per_cpu_offset(i), NULL, 1);
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001221#endif
1222
1223 /*
Laura Abbott94f202a2011-10-07 13:51:58 -07001224 * Struct page scanning for each node.
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001225 */
Laura Abbott94f202a2011-10-07 13:51:58 -07001226 lock_memory_hotplug();
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001227 for_each_online_node(i) {
1228 pg_data_t *pgdat = NODE_DATA(i);
1229 unsigned long start_pfn = pgdat->node_start_pfn;
1230 unsigned long end_pfn = start_pfn + pgdat->node_spanned_pages;
1231 unsigned long pfn;
1232
1233 for (pfn = start_pfn; pfn < end_pfn; pfn++) {
1234 struct page *page;
1235
1236 if (!pfn_valid(pfn))
1237 continue;
1238 page = pfn_to_page(pfn);
1239 /* only scan if page is in use */
1240 if (page_count(page) == 0)
1241 continue;
Catalin Marinas4b8a9672009-07-07 10:32:56 +01001242 scan_block(page, page + 1, NULL, 1);
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001243 }
1244 }
Laura Abbott94f202a2011-10-07 13:51:58 -07001245 unlock_memory_hotplug();
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001246
1247 /*
Catalin Marinas43ed5d62009-09-01 11:12:44 +01001248 * Scanning the task stacks (may introduce false negatives).
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001249 */
1250 if (kmemleak_stack_scan) {
Catalin Marinas43ed5d62009-09-01 11:12:44 +01001251 struct task_struct *p, *g;
1252
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001253 read_lock(&tasklist_lock);
Catalin Marinas43ed5d62009-09-01 11:12:44 +01001254 do_each_thread(g, p) {
1255 scan_block(task_stack_page(p), task_stack_page(p) +
1256 THREAD_SIZE, NULL, 0);
1257 } while_each_thread(g, p);
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001258 read_unlock(&tasklist_lock);
1259 }
1260
1261 /*
1262 * Scan the objects already referenced from the sections scanned
Catalin Marinas04609cc2009-10-28 13:33:12 +00001263 * above.
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001264 */
Catalin Marinas04609cc2009-10-28 13:33:12 +00001265 scan_gray_list();
Catalin Marinas25873622009-07-07 10:32:58 +01001266
1267 /*
Catalin Marinas04609cc2009-10-28 13:33:12 +00001268 * Check for new or unreferenced objects modified since the previous
1269 * scan and color them gray until the next scan.
Catalin Marinas25873622009-07-07 10:32:58 +01001270 */
1271 rcu_read_lock();
1272 list_for_each_entry_rcu(object, &object_list, object_list) {
1273 spin_lock_irqsave(&object->lock, flags);
Catalin Marinas04609cc2009-10-28 13:33:12 +00001274 if (color_white(object) && (object->flags & OBJECT_ALLOCATED)
1275 && update_checksum(object) && get_object(object)) {
1276 /* color it gray temporarily */
1277 object->count = object->min_count;
Catalin Marinas25873622009-07-07 10:32:58 +01001278 list_add_tail(&object->gray_list, &gray_list);
1279 }
1280 spin_unlock_irqrestore(&object->lock, flags);
1281 }
1282 rcu_read_unlock();
1283
Catalin Marinas04609cc2009-10-28 13:33:12 +00001284 /*
1285 * Re-scan the gray list for modified unreferenced objects.
1286 */
1287 scan_gray_list();
Catalin Marinas4698c1f2009-06-26 17:38:27 +01001288
1289 /*
Catalin Marinas04609cc2009-10-28 13:33:12 +00001290 * If scanning was stopped do not report any new unreferenced objects.
Catalin Marinas17bb9e02009-06-29 17:13:56 +01001291 */
Catalin Marinas04609cc2009-10-28 13:33:12 +00001292 if (scan_should_stop())
Catalin Marinas17bb9e02009-06-29 17:13:56 +01001293 return;
1294
1295 /*
Catalin Marinas4698c1f2009-06-26 17:38:27 +01001296 * Scanning result reporting.
1297 */
1298 rcu_read_lock();
1299 list_for_each_entry_rcu(object, &object_list, object_list) {
1300 spin_lock_irqsave(&object->lock, flags);
1301 if (unreferenced_object(object) &&
1302 !(object->flags & OBJECT_REPORTED)) {
1303 object->flags |= OBJECT_REPORTED;
1304 new_leaks++;
1305 }
1306 spin_unlock_irqrestore(&object->lock, flags);
1307 }
1308 rcu_read_unlock();
1309
1310 if (new_leaks)
1311 pr_info("%d new suspected memory leaks (see "
1312 "/sys/kernel/debug/kmemleak)\n", new_leaks);
1313
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001314}
1315
1316/*
1317 * Thread function performing automatic memory scanning. Unreferenced objects
1318 * at the end of a memory scan are reported but only the first time.
1319 */
1320static int kmemleak_scan_thread(void *arg)
1321{
1322 static int first_run = 1;
1323
Joe Perchesae281062009-06-23 14:40:26 +01001324 pr_info("Automatic memory scanning thread started\n");
Catalin Marinasbf2a76b2009-07-07 10:32:55 +01001325 set_user_nice(current, 10);
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001326
1327 /*
1328 * Wait before the first scan to allow the system to fully initialize.
1329 */
1330 if (first_run) {
1331 first_run = 0;
1332 ssleep(SECS_FIRST_SCAN);
1333 }
1334
1335 while (!kthread_should_stop()) {
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001336 signed long timeout = jiffies_scan_wait;
1337
1338 mutex_lock(&scan_mutex);
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001339 kmemleak_scan();
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001340 mutex_unlock(&scan_mutex);
Catalin Marinas4698c1f2009-06-26 17:38:27 +01001341
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001342 /* wait before the next scan */
1343 while (timeout && !kthread_should_stop())
1344 timeout = schedule_timeout_interruptible(timeout);
1345 }
1346
Joe Perchesae281062009-06-23 14:40:26 +01001347 pr_info("Automatic memory scanning thread ended\n");
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001348
1349 return 0;
1350}
1351
1352/*
1353 * Start the automatic memory scanning thread. This function must be called
Catalin Marinas4698c1f2009-06-26 17:38:27 +01001354 * with the scan_mutex held.
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001355 */
Luis R. Rodriguez7eb0d5e2009-09-08 17:31:45 +01001356static void start_scan_thread(void)
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001357{
1358 if (scan_thread)
1359 return;
1360 scan_thread = kthread_run(kmemleak_scan_thread, NULL, "kmemleak");
1361 if (IS_ERR(scan_thread)) {
Joe Perchesae281062009-06-23 14:40:26 +01001362 pr_warning("Failed to create the scan thread\n");
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001363 scan_thread = NULL;
1364 }
1365}
1366
1367/*
1368 * Stop the automatic memory scanning thread. This function must be called
Catalin Marinas4698c1f2009-06-26 17:38:27 +01001369 * with the scan_mutex held.
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001370 */
Luis R. Rodriguez7eb0d5e2009-09-08 17:31:45 +01001371static void stop_scan_thread(void)
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001372{
1373 if (scan_thread) {
1374 kthread_stop(scan_thread);
1375 scan_thread = NULL;
1376 }
1377}
1378
1379/*
1380 * Iterate over the object_list and return the first valid object at or after
1381 * the required position with its use_count incremented. The function triggers
1382 * a memory scanning when the pos argument points to the first position.
1383 */
1384static void *kmemleak_seq_start(struct seq_file *seq, loff_t *pos)
1385{
1386 struct kmemleak_object *object;
1387 loff_t n = *pos;
Catalin Marinasb87324d2009-07-07 10:32:58 +01001388 int err;
1389
1390 err = mutex_lock_interruptible(&scan_mutex);
1391 if (err < 0)
1392 return ERR_PTR(err);
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001393
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001394 rcu_read_lock();
1395 list_for_each_entry_rcu(object, &object_list, object_list) {
1396 if (n-- > 0)
1397 continue;
1398 if (get_object(object))
1399 goto out;
1400 }
1401 object = NULL;
1402out:
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001403 return object;
1404}
1405
1406/*
1407 * Return the next object in the object_list. The function decrements the
1408 * use_count of the previous object and increases that of the next one.
1409 */
1410static void *kmemleak_seq_next(struct seq_file *seq, void *v, loff_t *pos)
1411{
1412 struct kmemleak_object *prev_obj = v;
1413 struct kmemleak_object *next_obj = NULL;
1414 struct list_head *n = &prev_obj->object_list;
1415
1416 ++(*pos);
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001417
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001418 list_for_each_continue_rcu(n, &object_list) {
Catalin Marinas52c3ce42011-04-27 16:44:26 +01001419 struct kmemleak_object *obj =
1420 list_entry(n, struct kmemleak_object, object_list);
1421 if (get_object(obj)) {
1422 next_obj = obj;
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001423 break;
Catalin Marinas52c3ce42011-04-27 16:44:26 +01001424 }
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001425 }
Catalin Marinas288c8572009-07-07 10:32:57 +01001426
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001427 put_object(prev_obj);
1428 return next_obj;
1429}
1430
1431/*
1432 * Decrement the use_count of the last object required, if any.
1433 */
1434static void kmemleak_seq_stop(struct seq_file *seq, void *v)
1435{
Catalin Marinasb87324d2009-07-07 10:32:58 +01001436 if (!IS_ERR(v)) {
1437 /*
1438 * kmemleak_seq_start may return ERR_PTR if the scan_mutex
1439 * waiting was interrupted, so only release it if !IS_ERR.
1440 */
Catalin Marinasf5886c72009-07-29 16:26:57 +01001441 rcu_read_unlock();
Catalin Marinasb87324d2009-07-07 10:32:58 +01001442 mutex_unlock(&scan_mutex);
1443 if (v)
1444 put_object(v);
1445 }
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001446}
1447
1448/*
1449 * Print the information for an unreferenced object to the seq file.
1450 */
1451static int kmemleak_seq_show(struct seq_file *seq, void *v)
1452{
1453 struct kmemleak_object *object = v;
1454 unsigned long flags;
1455
1456 spin_lock_irqsave(&object->lock, flags);
Catalin Marinas288c8572009-07-07 10:32:57 +01001457 if ((object->flags & OBJECT_REPORTED) && unreferenced_object(object))
Catalin Marinas17bb9e02009-06-29 17:13:56 +01001458 print_unreferenced(seq, object);
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001459 spin_unlock_irqrestore(&object->lock, flags);
1460 return 0;
1461}
1462
1463static const struct seq_operations kmemleak_seq_ops = {
1464 .start = kmemleak_seq_start,
1465 .next = kmemleak_seq_next,
1466 .stop = kmemleak_seq_stop,
1467 .show = kmemleak_seq_show,
1468};
1469
1470static int kmemleak_open(struct inode *inode, struct file *file)
1471{
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001472 if (!atomic_read(&kmemleak_enabled))
1473 return -EBUSY;
1474
Catalin Marinasb87324d2009-07-07 10:32:58 +01001475 return seq_open(file, &kmemleak_seq_ops);
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001476}
1477
1478static int kmemleak_release(struct inode *inode, struct file *file)
1479{
Catalin Marinasb87324d2009-07-07 10:32:58 +01001480 return seq_release(inode, file);
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001481}
1482
Catalin Marinas189d84e2009-08-27 14:29:15 +01001483static int dump_str_object_info(const char *str)
1484{
1485 unsigned long flags;
1486 struct kmemleak_object *object;
1487 unsigned long addr;
1488
1489 addr= simple_strtoul(str, NULL, 0);
1490 object = find_and_get_object(addr, 0);
1491 if (!object) {
1492 pr_info("Unknown object at 0x%08lx\n", addr);
1493 return -EINVAL;
1494 }
1495
1496 spin_lock_irqsave(&object->lock, flags);
1497 dump_object_info(object);
1498 spin_unlock_irqrestore(&object->lock, flags);
1499
1500 put_object(object);
1501 return 0;
1502}
1503
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001504/*
Luis R. Rodriguez30b37102009-09-04 17:44:51 -07001505 * We use grey instead of black to ensure we can do future scans on the same
1506 * objects. If we did not do future scans these black objects could
1507 * potentially contain references to newly allocated objects in the future and
1508 * we'd end up with false positives.
1509 */
1510static void kmemleak_clear(void)
1511{
1512 struct kmemleak_object *object;
1513 unsigned long flags;
1514
1515 rcu_read_lock();
1516 list_for_each_entry_rcu(object, &object_list, object_list) {
1517 spin_lock_irqsave(&object->lock, flags);
1518 if ((object->flags & OBJECT_REPORTED) &&
1519 unreferenced_object(object))
Luis R. Rodrigueza1084c82009-09-04 17:44:52 -07001520 __paint_it(object, KMEMLEAK_GREY);
Luis R. Rodriguez30b37102009-09-04 17:44:51 -07001521 spin_unlock_irqrestore(&object->lock, flags);
1522 }
1523 rcu_read_unlock();
1524}
1525
1526/*
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001527 * File write operation to configure kmemleak at run-time. The following
1528 * commands can be written to the /sys/kernel/debug/kmemleak file:
1529 * off - disable kmemleak (irreversible)
1530 * stack=on - enable the task stacks scanning
1531 * stack=off - disable the tasks stacks scanning
1532 * scan=on - start the automatic memory scanning thread
1533 * scan=off - stop the automatic memory scanning thread
1534 * scan=... - set the automatic memory scanning period in seconds (0 to
1535 * disable it)
Catalin Marinas4698c1f2009-06-26 17:38:27 +01001536 * scan - trigger a memory scan
Luis R. Rodriguez30b37102009-09-04 17:44:51 -07001537 * clear - mark all current reported unreferenced kmemleak objects as
1538 * grey to ignore printing them
Catalin Marinas189d84e2009-08-27 14:29:15 +01001539 * dump=... - dump information about the object found at the given address
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001540 */
1541static ssize_t kmemleak_write(struct file *file, const char __user *user_buf,
1542 size_t size, loff_t *ppos)
1543{
1544 char buf[64];
1545 int buf_size;
Catalin Marinasb87324d2009-07-07 10:32:58 +01001546 int ret;
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001547
1548 buf_size = min(size, (sizeof(buf) - 1));
1549 if (strncpy_from_user(buf, user_buf, buf_size) < 0)
1550 return -EFAULT;
1551 buf[buf_size] = 0;
1552
Catalin Marinasb87324d2009-07-07 10:32:58 +01001553 ret = mutex_lock_interruptible(&scan_mutex);
1554 if (ret < 0)
1555 return ret;
1556
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001557 if (strncmp(buf, "off", 3) == 0)
1558 kmemleak_disable();
1559 else if (strncmp(buf, "stack=on", 8) == 0)
1560 kmemleak_stack_scan = 1;
1561 else if (strncmp(buf, "stack=off", 9) == 0)
1562 kmemleak_stack_scan = 0;
1563 else if (strncmp(buf, "scan=on", 7) == 0)
1564 start_scan_thread();
1565 else if (strncmp(buf, "scan=off", 8) == 0)
1566 stop_scan_thread();
1567 else if (strncmp(buf, "scan=", 5) == 0) {
1568 unsigned long secs;
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001569
Catalin Marinasb87324d2009-07-07 10:32:58 +01001570 ret = strict_strtoul(buf + 5, 0, &secs);
1571 if (ret < 0)
1572 goto out;
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001573 stop_scan_thread();
1574 if (secs) {
1575 jiffies_scan_wait = msecs_to_jiffies(secs * 1000);
1576 start_scan_thread();
1577 }
Catalin Marinas4698c1f2009-06-26 17:38:27 +01001578 } else if (strncmp(buf, "scan", 4) == 0)
1579 kmemleak_scan();
Luis R. Rodriguez30b37102009-09-04 17:44:51 -07001580 else if (strncmp(buf, "clear", 5) == 0)
1581 kmemleak_clear();
Catalin Marinas189d84e2009-08-27 14:29:15 +01001582 else if (strncmp(buf, "dump=", 5) == 0)
1583 ret = dump_str_object_info(buf + 5);
Catalin Marinas4698c1f2009-06-26 17:38:27 +01001584 else
Catalin Marinasb87324d2009-07-07 10:32:58 +01001585 ret = -EINVAL;
1586
1587out:
1588 mutex_unlock(&scan_mutex);
1589 if (ret < 0)
1590 return ret;
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001591
1592 /* ignore the rest of the buffer, only one command at a time */
1593 *ppos += size;
1594 return size;
1595}
1596
1597static const struct file_operations kmemleak_fops = {
1598 .owner = THIS_MODULE,
1599 .open = kmemleak_open,
1600 .read = seq_read,
1601 .write = kmemleak_write,
1602 .llseek = seq_lseek,
1603 .release = kmemleak_release,
1604};
1605
1606/*
1607 * Perform the freeing of the kmemleak internal objects after waiting for any
1608 * current memory scan to complete.
1609 */
Catalin Marinas179a8102009-09-07 10:14:42 +01001610static void kmemleak_do_cleanup(struct work_struct *work)
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001611{
1612 struct kmemleak_object *object;
1613
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001614 mutex_lock(&scan_mutex);
Catalin Marinas4698c1f2009-06-26 17:38:27 +01001615 stop_scan_thread();
1616
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001617 rcu_read_lock();
1618 list_for_each_entry_rcu(object, &object_list, object_list)
Catalin Marinas53238a62009-07-07 10:33:00 +01001619 delete_object_full(object->pointer);
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001620 rcu_read_unlock();
1621 mutex_unlock(&scan_mutex);
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001622}
1623
Catalin Marinas179a8102009-09-07 10:14:42 +01001624static DECLARE_WORK(cleanup_work, kmemleak_do_cleanup);
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001625
1626/*
1627 * Disable kmemleak. No memory allocation/freeing will be traced once this
1628 * function is called. Disabling kmemleak is an irreversible operation.
1629 */
1630static void kmemleak_disable(void)
1631{
1632 /* atomically check whether it was already invoked */
1633 if (atomic_cmpxchg(&kmemleak_error, 0, 1))
1634 return;
1635
1636 /* stop any memory operation tracing */
1637 atomic_set(&kmemleak_early_log, 0);
1638 atomic_set(&kmemleak_enabled, 0);
1639
1640 /* check whether it is too early for a kernel thread */
1641 if (atomic_read(&kmemleak_initialized))
Catalin Marinas179a8102009-09-07 10:14:42 +01001642 schedule_work(&cleanup_work);
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001643
1644 pr_info("Kernel memory leak detector disabled\n");
1645}
1646
1647/*
1648 * Allow boot-time kmemleak disabling (enabled by default).
1649 */
1650static int kmemleak_boot_config(char *str)
1651{
1652 if (!str)
1653 return -EINVAL;
1654 if (strcmp(str, "off") == 0)
1655 kmemleak_disable();
Jason Baronab0155a2010-07-19 11:54:17 +01001656 else if (strcmp(str, "on") == 0)
1657 kmemleak_skip_disable = 1;
1658 else
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001659 return -EINVAL;
1660 return 0;
1661}
1662early_param("kmemleak", kmemleak_boot_config);
1663
1664/*
Catalin Marinas20301172009-06-17 18:29:04 +01001665 * Kmemleak initialization.
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001666 */
1667void __init kmemleak_init(void)
1668{
1669 int i;
1670 unsigned long flags;
1671
Jason Baronab0155a2010-07-19 11:54:17 +01001672#ifdef CONFIG_DEBUG_KMEMLEAK_DEFAULT_OFF
1673 if (!kmemleak_skip_disable) {
1674 kmemleak_disable();
1675 return;
1676 }
1677#endif
1678
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001679 jiffies_min_age = msecs_to_jiffies(MSECS_MIN_AGE);
1680 jiffies_scan_wait = msecs_to_jiffies(SECS_SCAN_WAIT * 1000);
1681
1682 object_cache = KMEM_CACHE(kmemleak_object, SLAB_NOLEAKTRACE);
1683 scan_area_cache = KMEM_CACHE(kmemleak_scan_area, SLAB_NOLEAKTRACE);
1684 INIT_PRIO_TREE_ROOT(&object_tree_root);
1685
1686 /* the kernel is still in UP mode, so disabling the IRQs is enough */
1687 local_irq_save(flags);
1688 if (!atomic_read(&kmemleak_error)) {
1689 atomic_set(&kmemleak_enabled, 1);
1690 atomic_set(&kmemleak_early_log, 0);
1691 }
1692 local_irq_restore(flags);
1693
1694 /*
1695 * This is the point where tracking allocations is safe. Automatic
1696 * scanning is started during the late initcall. Add the early logged
1697 * callbacks to the kmemleak infrastructure.
1698 */
1699 for (i = 0; i < crt_early_log; i++) {
1700 struct early_log *log = &early_log[i];
1701
1702 switch (log->op_type) {
1703 case KMEMLEAK_ALLOC:
Catalin Marinasfd678962009-08-27 14:29:17 +01001704 early_alloc(log);
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001705 break;
1706 case KMEMLEAK_FREE:
1707 kmemleak_free(log->ptr);
1708 break;
Catalin Marinas53238a62009-07-07 10:33:00 +01001709 case KMEMLEAK_FREE_PART:
1710 kmemleak_free_part(log->ptr, log->size);
1711 break;
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001712 case KMEMLEAK_NOT_LEAK:
1713 kmemleak_not_leak(log->ptr);
1714 break;
1715 case KMEMLEAK_IGNORE:
1716 kmemleak_ignore(log->ptr);
1717 break;
1718 case KMEMLEAK_SCAN_AREA:
Catalin Marinasc017b4b2009-10-28 13:33:09 +00001719 kmemleak_scan_area(log->ptr, log->size, GFP_KERNEL);
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001720 break;
1721 case KMEMLEAK_NO_SCAN:
1722 kmemleak_no_scan(log->ptr);
1723 break;
1724 default:
1725 WARN_ON(1);
1726 }
1727 }
1728}
1729
1730/*
1731 * Late initialization function.
1732 */
1733static int __init kmemleak_late_init(void)
1734{
1735 struct dentry *dentry;
1736
1737 atomic_set(&kmemleak_initialized, 1);
1738
1739 if (atomic_read(&kmemleak_error)) {
1740 /*
Lucas De Marchi25985ed2011-03-30 22:57:33 -03001741 * Some error occurred and kmemleak was disabled. There is a
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001742 * small chance that kmemleak_disable() was called immediately
1743 * after setting kmemleak_initialized and we may end up with
1744 * two clean-up threads but serialized by scan_mutex.
1745 */
Catalin Marinas179a8102009-09-07 10:14:42 +01001746 schedule_work(&cleanup_work);
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001747 return -ENOMEM;
1748 }
1749
1750 dentry = debugfs_create_file("kmemleak", S_IRUGO, NULL, NULL,
1751 &kmemleak_fops);
1752 if (!dentry)
Joe Perchesae281062009-06-23 14:40:26 +01001753 pr_warning("Failed to create the debugfs kmemleak file\n");
Catalin Marinas4698c1f2009-06-26 17:38:27 +01001754 mutex_lock(&scan_mutex);
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001755 start_scan_thread();
Catalin Marinas4698c1f2009-06-26 17:38:27 +01001756 mutex_unlock(&scan_mutex);
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001757
1758 pr_info("Kernel memory leak detector initialized\n");
1759
1760 return 0;
1761}
1762late_initcall(kmemleak_late_init);