4 * Copyright (C) 2008 ARM Limited
5 * Written by Catalin Marinas <catalin.marinas@arm.com>
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.
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.
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
21 * For more information on the algorithm and kmemleak usage, please see
22 * Documentation/kmemleak.txt.
27 * The following locks and mutexes are used by kmemleak:
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 red black 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
51 * 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
56 * Locks and mutexes are acquired/nested in the following order:
58 * scan_mutex [-> object->lock] -> kmemleak_lock -> other_object->lock (SINGLE_DEPTH_NESTING)
60 * No kmemleak_lock and object->lock nesting is allowed outside scan_mutex
63 * The kmemleak_object structures have a use_count incremented or decremented
64 * using the get_object()/put_object() functions. When the use_count becomes
65 * 0, this count can no longer be incremented and put_object() schedules the
66 * kmemleak_object freeing via an RCU callback. All calls to the get_object()
67 * function must be protected by rcu_read_lock() to avoid accessing a freed
71 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
73 #include <linux/init.h>
74 #include <linux/kernel.h>
75 #include <linux/list.h>
76 #include <linux/sched.h>
77 #include <linux/jiffies.h>
78 #include <linux/delay.h>
79 #include <linux/export.h>
80 #include <linux/kthread.h>
81 #include <linux/rbtree.h>
83 #include <linux/debugfs.h>
84 #include <linux/seq_file.h>
85 #include <linux/cpumask.h>
86 #include <linux/spinlock.h>
87 #include <linux/mutex.h>
88 #include <linux/rcupdate.h>
89 #include <linux/stacktrace.h>
90 #include <linux/cache.h>
91 #include <linux/percpu.h>
92 #include <linux/hardirq.h>
93 #include <linux/mmzone.h>
94 #include <linux/slab.h>
95 #include <linux/thread_info.h>
96 #include <linux/err.h>
97 #include <linux/uaccess.h>
98 #include <linux/string.h>
99 #include <linux/nodemask.h>
100 #include <linux/mm.h>
101 #include <linux/workqueue.h>
102 #include <linux/crc32.h>
104 #include <asm/sections.h>
105 #include <asm/processor.h>
106 #include <linux/atomic.h>
108 #include <linux/kasan.h>
109 #include <linux/kmemcheck.h>
110 #include <linux/kmemleak.h>
111 #include <linux/memory_hotplug.h>
114 * Kmemleak configuration and common defines.
116 #define MAX_TRACE 16 /* stack trace length */
117 #define MSECS_MIN_AGE 5000 /* minimum object age for reporting */
118 #define SECS_FIRST_SCAN 60 /* delay before the first scan */
119 #define SECS_SCAN_WAIT 600 /* subsequent auto scanning delay */
120 #define MAX_SCAN_SIZE 4096 /* maximum size of a scanned block */
122 #define BYTES_PER_POINTER sizeof(void *)
124 /* GFP bitmask for kmemleak internal allocations */
125 #define gfp_kmemleak_mask(gfp) (((gfp) & (GFP_KERNEL | GFP_ATOMIC | \
126 __GFP_NOACCOUNT)) | \
127 __GFP_NORETRY | __GFP_NOMEMALLOC | \
130 /* scanning area inside a memory block */
131 struct kmemleak_scan_area {
132 struct hlist_node node;
137 #define KMEMLEAK_GREY 0
138 #define KMEMLEAK_BLACK -1
141 * Structure holding the metadata for each allocated memory block.
142 * Modifications to such objects should be made while holding the
143 * object->lock. Insertions or deletions from object_list, gray_list or
144 * rb_node are already protected by the corresponding locks or mutex (see
145 * the notes on locking above). These objects are reference-counted
146 * (use_count) and freed using the RCU mechanism.
148 struct kmemleak_object {
150 unsigned long flags; /* object status flags */
151 struct list_head object_list;
152 struct list_head gray_list;
153 struct rb_node rb_node;
154 struct rcu_head rcu; /* object_list lockless traversal */
155 /* object usage count; object freed when use_count == 0 */
157 unsigned long pointer;
159 /* minimum number of a pointers found before it is considered leak */
161 /* the total number of pointers found pointing to this object */
163 /* checksum for detecting modified objects */
165 /* memory ranges to be scanned inside an object (empty for all) */
166 struct hlist_head area_list;
167 unsigned long trace[MAX_TRACE];
168 unsigned int trace_len;
169 unsigned long jiffies; /* creation timestamp */
170 pid_t pid; /* pid of the current task */
171 char comm[TASK_COMM_LEN]; /* executable name */
174 /* flag representing the memory block allocation status */
175 #define OBJECT_ALLOCATED (1 << 0)
176 /* flag set after the first reporting of an unreference object */
177 #define OBJECT_REPORTED (1 << 1)
178 /* flag set to not scan the object */
179 #define OBJECT_NO_SCAN (1 << 2)
181 /* number of bytes to print per line; must be 16 or 32 */
182 #define HEX_ROW_SIZE 16
183 /* number of bytes to print at a time (1, 2, 4, 8) */
184 #define HEX_GROUP_SIZE 1
185 /* include ASCII after the hex output */
187 /* max number of lines to be printed */
188 #define HEX_MAX_LINES 2
190 /* the list of all allocated objects */
191 static LIST_HEAD(object_list);
192 /* the list of gray-colored objects (see color_gray comment below) */
193 static LIST_HEAD(gray_list);
194 /* search tree for object boundaries */
195 static struct rb_root object_tree_root = RB_ROOT;
196 /* rw_lock protecting the access to object_list and object_tree_root */
197 static DEFINE_RWLOCK(kmemleak_lock);
199 /* allocation caches for kmemleak internal data */
200 static struct kmem_cache *object_cache;
201 static struct kmem_cache *scan_area_cache;
203 /* set if tracing memory operations is enabled */
204 static int kmemleak_enabled;
205 /* same as above but only for the kmemleak_free() callback */
206 static int kmemleak_free_enabled;
207 /* set in the late_initcall if there were no errors */
208 static int kmemleak_initialized;
209 /* enables or disables early logging of the memory operations */
210 static int kmemleak_early_log = 1;
211 /* set if a kmemleak warning was issued */
212 static int kmemleak_warning;
213 /* set if a fatal kmemleak error has occurred */
214 static int kmemleak_error;
216 /* minimum and maximum address that may be valid pointers */
217 static unsigned long min_addr = ULONG_MAX;
218 static unsigned long max_addr;
220 static struct task_struct *scan_thread;
221 /* used to avoid reporting of recently allocated objects */
222 static unsigned long jiffies_min_age;
223 static unsigned long jiffies_last_scan;
224 /* delay between automatic memory scannings */
225 static signed long jiffies_scan_wait;
227 /* Enables or disables the task stacks scanning.
228 * Set to 1 if at compile time we want it enabled.
229 * Else set to 0 to have it disabled by default.
230 * This can be enabled by writing to "stack=on" using
231 * kmemleak debugfs entry.*/
232 #ifdef CONFIG_DEBUG_TASK_STACK_SCAN_OFF
233 static int kmemleak_stack_scan;
235 static int kmemleak_stack_scan = 1;
238 /* protects the memory scanning, parameters and debug/kmemleak file access */
239 static DEFINE_MUTEX(scan_mutex);
240 /* setting kmemleak=on, will set this var, skipping the disable */
241 static int kmemleak_skip_disable;
242 /* If there are leaks that can be reported */
243 static bool kmemleak_found_leaks;
246 * Early object allocation/freeing logging. Kmemleak is initialized after the
247 * kernel allocator. However, both the kernel allocator and kmemleak may
248 * allocate memory blocks which need to be tracked. Kmemleak defines an
249 * arbitrary buffer to hold the allocation/freeing information before it is
253 /* kmemleak operation type for early logging */
256 KMEMLEAK_ALLOC_PERCPU,
259 KMEMLEAK_FREE_PERCPU,
267 * Structure holding the information passed to kmemleak callbacks during the
271 int op_type; /* kmemleak operation type */
272 const void *ptr; /* allocated/freed memory block */
273 size_t size; /* memory block size */
274 int min_count; /* minimum reference count */
275 unsigned long trace[MAX_TRACE]; /* stack trace */
276 unsigned int trace_len; /* stack trace length */
279 /* early logging buffer and current position */
280 static struct early_log
281 early_log[CONFIG_DEBUG_KMEMLEAK_EARLY_LOG_SIZE] __initdata;
282 static int crt_early_log __initdata;
284 static void kmemleak_disable(void);
287 * Print a warning and dump the stack trace.
289 #define kmemleak_warn(x...) do { \
292 kmemleak_warning = 1; \
296 * Macro invoked when a serious kmemleak condition occurred and cannot be
297 * recovered from. Kmemleak will be disabled and further allocation/freeing
298 * tracing no longer available.
300 #define kmemleak_stop(x...) do { \
302 kmemleak_disable(); \
306 * Printing of the objects hex dump to the seq file. The number of lines to be
307 * printed is limited to HEX_MAX_LINES to prevent seq file spamming. The
308 * actual number of printed bytes depends on HEX_ROW_SIZE. It must be called
309 * with the object->lock held.
311 static void hex_dump_object(struct seq_file *seq,
312 struct kmemleak_object *object)
314 const u8 *ptr = (const u8 *)object->pointer;
317 /* limit the number of lines to HEX_MAX_LINES */
318 len = min_t(size_t, object->size, HEX_MAX_LINES * HEX_ROW_SIZE);
320 seq_printf(seq, " hex dump (first %zu bytes):\n", len);
321 seq_hex_dump(seq, " ", DUMP_PREFIX_NONE, HEX_ROW_SIZE,
322 HEX_GROUP_SIZE, ptr, len, HEX_ASCII);
326 * Object colors, encoded with count and min_count:
327 * - white - orphan object, not enough references to it (count < min_count)
328 * - gray - not orphan, not marked as false positive (min_count == 0) or
329 * sufficient references to it (count >= min_count)
330 * - black - ignore, it doesn't contain references (e.g. text section)
331 * (min_count == -1). No function defined for this color.
332 * Newly created objects don't have any color assigned (object->count == -1)
333 * before the next memory scan when they become white.
335 static bool color_white(const struct kmemleak_object *object)
337 return object->count != KMEMLEAK_BLACK &&
338 object->count < object->min_count;
341 static bool color_gray(const struct kmemleak_object *object)
343 return object->min_count != KMEMLEAK_BLACK &&
344 object->count >= object->min_count;
348 * Objects are considered unreferenced only if their color is white, they have
349 * not be deleted and have a minimum age to avoid false positives caused by
350 * pointers temporarily stored in CPU registers.
352 static bool unreferenced_object(struct kmemleak_object *object)
354 return (color_white(object) && object->flags & OBJECT_ALLOCATED) &&
355 time_before_eq(object->jiffies + jiffies_min_age,
360 * Printing of the unreferenced objects information to the seq file. The
361 * print_unreferenced function must be called with the object->lock held.
363 static void print_unreferenced(struct seq_file *seq,
364 struct kmemleak_object *object)
367 unsigned int msecs_age = jiffies_to_msecs(jiffies - object->jiffies);
369 seq_printf(seq, "unreferenced object 0x%08lx (size %zu):\n",
370 object->pointer, object->size);
371 seq_printf(seq, " comm \"%s\", pid %d, jiffies %lu (age %d.%03ds)\n",
372 object->comm, object->pid, object->jiffies,
373 msecs_age / 1000, msecs_age % 1000);
374 hex_dump_object(seq, object);
375 seq_printf(seq, " backtrace:\n");
377 for (i = 0; i < object->trace_len; i++) {
378 void *ptr = (void *)object->trace[i];
379 seq_printf(seq, " [<%p>] %pS\n", ptr, ptr);
384 * Print the kmemleak_object information. This function is used mainly for
385 * debugging special cases when kmemleak operations. It must be called with
386 * the object->lock held.
388 static void dump_object_info(struct kmemleak_object *object)
390 struct stack_trace trace;
392 trace.nr_entries = object->trace_len;
393 trace.entries = object->trace;
395 pr_notice("Object 0x%08lx (size %zu):\n",
396 object->pointer, object->size);
397 pr_notice(" comm \"%s\", pid %d, jiffies %lu\n",
398 object->comm, object->pid, object->jiffies);
399 pr_notice(" min_count = %d\n", object->min_count);
400 pr_notice(" count = %d\n", object->count);
401 pr_notice(" flags = 0x%lx\n", object->flags);
402 pr_notice(" checksum = %u\n", object->checksum);
403 pr_notice(" backtrace:\n");
404 print_stack_trace(&trace, 4);
408 * Look-up a memory block metadata (kmemleak_object) in the object search
409 * tree based on a pointer value. If alias is 0, only values pointing to the
410 * beginning of the memory block are allowed. The kmemleak_lock must be held
411 * when calling this function.
413 static struct kmemleak_object *lookup_object(unsigned long ptr, int alias)
415 struct rb_node *rb = object_tree_root.rb_node;
418 struct kmemleak_object *object =
419 rb_entry(rb, struct kmemleak_object, rb_node);
420 if (ptr < object->pointer)
421 rb = object->rb_node.rb_left;
422 else if (object->pointer + object->size <= ptr)
423 rb = object->rb_node.rb_right;
424 else if (object->pointer == ptr || alias)
427 kmemleak_warn("Found object by alias at 0x%08lx\n",
429 dump_object_info(object);
437 * Increment the object use_count. Return 1 if successful or 0 otherwise. Note
438 * that once an object's use_count reached 0, the RCU freeing was already
439 * registered and the object should no longer be used. This function must be
440 * called under the protection of rcu_read_lock().
442 static int get_object(struct kmemleak_object *object)
444 return atomic_inc_not_zero(&object->use_count);
448 * RCU callback to free a kmemleak_object.
450 static void free_object_rcu(struct rcu_head *rcu)
452 struct hlist_node *tmp;
453 struct kmemleak_scan_area *area;
454 struct kmemleak_object *object =
455 container_of(rcu, struct kmemleak_object, rcu);
458 * Once use_count is 0 (guaranteed by put_object), there is no other
459 * code accessing this object, hence no need for locking.
461 hlist_for_each_entry_safe(area, tmp, &object->area_list, node) {
462 hlist_del(&area->node);
463 kmem_cache_free(scan_area_cache, area);
465 kmem_cache_free(object_cache, object);
469 * Decrement the object use_count. Once the count is 0, free the object using
470 * an RCU callback. Since put_object() may be called via the kmemleak_free() ->
471 * delete_object() path, the delayed RCU freeing ensures that there is no
472 * recursive call to the kernel allocator. Lock-less RCU object_list traversal
475 static void put_object(struct kmemleak_object *object)
477 if (!atomic_dec_and_test(&object->use_count))
480 /* should only get here after delete_object was called */
481 WARN_ON(object->flags & OBJECT_ALLOCATED);
483 call_rcu(&object->rcu, free_object_rcu);
487 * Look up an object in the object search tree and increase its use_count.
489 static struct kmemleak_object *find_and_get_object(unsigned long ptr, int alias)
492 struct kmemleak_object *object;
495 read_lock_irqsave(&kmemleak_lock, flags);
496 object = lookup_object(ptr, alias);
497 read_unlock_irqrestore(&kmemleak_lock, flags);
499 /* check whether the object is still available */
500 if (object && !get_object(object))
508 * Look up an object in the object search tree and remove it from both
509 * object_tree_root and object_list. The returned object's use_count should be
510 * at least 1, as initially set by create_object().
512 static struct kmemleak_object *find_and_remove_object(unsigned long ptr, int alias)
515 struct kmemleak_object *object;
517 write_lock_irqsave(&kmemleak_lock, flags);
518 object = lookup_object(ptr, alias);
520 rb_erase(&object->rb_node, &object_tree_root);
521 list_del_rcu(&object->object_list);
523 write_unlock_irqrestore(&kmemleak_lock, flags);
529 * Save stack trace to the given array of MAX_TRACE size.
531 static int __save_stack_trace(unsigned long *trace)
533 struct stack_trace stack_trace;
535 stack_trace.max_entries = MAX_TRACE;
536 stack_trace.nr_entries = 0;
537 stack_trace.entries = trace;
538 stack_trace.skip = 2;
539 save_stack_trace(&stack_trace);
541 return stack_trace.nr_entries;
545 * Create the metadata (struct kmemleak_object) corresponding to an allocated
546 * memory block and add it to the object_list and object_tree_root.
548 static struct kmemleak_object *create_object(unsigned long ptr, size_t size,
549 int min_count, gfp_t gfp)
552 struct kmemleak_object *object, *parent;
553 struct rb_node **link, *rb_parent;
555 object = kmem_cache_alloc(object_cache, gfp_kmemleak_mask(gfp));
557 pr_warning("Cannot allocate a kmemleak_object structure\n");
562 INIT_LIST_HEAD(&object->object_list);
563 INIT_LIST_HEAD(&object->gray_list);
564 INIT_HLIST_HEAD(&object->area_list);
565 spin_lock_init(&object->lock);
566 atomic_set(&object->use_count, 1);
567 object->flags = OBJECT_ALLOCATED;
568 object->pointer = ptr;
570 object->min_count = min_count;
571 object->count = 0; /* white color initially */
572 object->jiffies = jiffies;
573 object->checksum = 0;
575 /* task information */
578 strncpy(object->comm, "hardirq", sizeof(object->comm));
579 } else if (in_serving_softirq()) {
581 strncpy(object->comm, "softirq", sizeof(object->comm));
583 object->pid = current->pid;
585 * There is a small chance of a race with set_task_comm(),
586 * however using get_task_comm() here may cause locking
587 * dependency issues with current->alloc_lock. In the worst
588 * case, the command line is not correct.
590 strncpy(object->comm, current->comm, sizeof(object->comm));
593 /* kernel backtrace */
594 object->trace_len = __save_stack_trace(object->trace);
596 write_lock_irqsave(&kmemleak_lock, flags);
598 min_addr = min(min_addr, ptr);
599 max_addr = max(max_addr, ptr + size);
600 link = &object_tree_root.rb_node;
604 parent = rb_entry(rb_parent, struct kmemleak_object, rb_node);
605 if (ptr + size <= parent->pointer)
606 link = &parent->rb_node.rb_left;
607 else if (parent->pointer + parent->size <= ptr)
608 link = &parent->rb_node.rb_right;
610 kmemleak_stop("Cannot insert 0x%lx into the object search tree (overlaps existing)\n",
613 * No need for parent->lock here since "parent" cannot
614 * be freed while the kmemleak_lock is held.
616 dump_object_info(parent);
617 kmem_cache_free(object_cache, object);
622 rb_link_node(&object->rb_node, rb_parent, link);
623 rb_insert_color(&object->rb_node, &object_tree_root);
625 list_add_tail_rcu(&object->object_list, &object_list);
627 write_unlock_irqrestore(&kmemleak_lock, flags);
632 * Mark the object as not allocated and schedule RCU freeing via put_object().
634 static void __delete_object(struct kmemleak_object *object)
638 WARN_ON(!(object->flags & OBJECT_ALLOCATED));
639 WARN_ON(atomic_read(&object->use_count) < 1);
642 * Locking here also ensures that the corresponding memory block
643 * cannot be freed when it is being scanned.
645 spin_lock_irqsave(&object->lock, flags);
646 object->flags &= ~OBJECT_ALLOCATED;
647 spin_unlock_irqrestore(&object->lock, flags);
652 * Look up the metadata (struct kmemleak_object) corresponding to ptr and
655 static void delete_object_full(unsigned long ptr)
657 struct kmemleak_object *object;
659 object = find_and_remove_object(ptr, 0);
662 kmemleak_warn("Freeing unknown object at 0x%08lx\n",
667 __delete_object(object);
671 * Look up the metadata (struct kmemleak_object) corresponding to ptr and
672 * delete it. If the memory block is partially freed, the function may create
673 * additional metadata for the remaining parts of the block.
675 static void delete_object_part(unsigned long ptr, size_t size)
677 struct kmemleak_object *object;
678 unsigned long start, end;
680 object = find_and_remove_object(ptr, 1);
683 kmemleak_warn("Partially freeing unknown object at 0x%08lx (size %zu)\n",
690 * Create one or two objects that may result from the memory block
691 * split. Note that partial freeing is only done by free_bootmem() and
692 * this happens before kmemleak_init() is called. The path below is
693 * only executed during early log recording in kmemleak_init(), so
694 * GFP_KERNEL is enough.
696 start = object->pointer;
697 end = object->pointer + object->size;
699 create_object(start, ptr - start, object->min_count,
701 if (ptr + size < end)
702 create_object(ptr + size, end - ptr - size, object->min_count,
705 __delete_object(object);
708 static void __paint_it(struct kmemleak_object *object, int color)
710 object->min_count = color;
711 if (color == KMEMLEAK_BLACK)
712 object->flags |= OBJECT_NO_SCAN;
715 static void paint_it(struct kmemleak_object *object, int color)
719 spin_lock_irqsave(&object->lock, flags);
720 __paint_it(object, color);
721 spin_unlock_irqrestore(&object->lock, flags);
724 static void paint_ptr(unsigned long ptr, int color)
726 struct kmemleak_object *object;
728 object = find_and_get_object(ptr, 0);
730 kmemleak_warn("Trying to color unknown object at 0x%08lx as %s\n",
732 (color == KMEMLEAK_GREY) ? "Grey" :
733 (color == KMEMLEAK_BLACK) ? "Black" : "Unknown");
736 paint_it(object, color);
741 * Mark an object permanently as gray-colored so that it can no longer be
742 * reported as a leak. This is used in general to mark a false positive.
744 static void make_gray_object(unsigned long ptr)
746 paint_ptr(ptr, KMEMLEAK_GREY);
750 * Mark the object as black-colored so that it is ignored from scans and
753 static void make_black_object(unsigned long ptr)
755 paint_ptr(ptr, KMEMLEAK_BLACK);
759 * Add a scanning area to the object. If at least one such area is added,
760 * kmemleak will only scan these ranges rather than the whole memory block.
762 static void add_scan_area(unsigned long ptr, size_t size, gfp_t gfp)
765 struct kmemleak_object *object;
766 struct kmemleak_scan_area *area;
768 object = find_and_get_object(ptr, 1);
770 kmemleak_warn("Adding scan area to unknown object at 0x%08lx\n",
775 area = kmem_cache_alloc(scan_area_cache, gfp_kmemleak_mask(gfp));
777 pr_warning("Cannot allocate a scan area\n");
781 spin_lock_irqsave(&object->lock, flags);
782 if (size == SIZE_MAX) {
783 size = object->pointer + object->size - ptr;
784 } else if (ptr + size > object->pointer + object->size) {
785 kmemleak_warn("Scan area larger than object 0x%08lx\n", ptr);
786 dump_object_info(object);
787 kmem_cache_free(scan_area_cache, area);
791 INIT_HLIST_NODE(&area->node);
795 hlist_add_head(&area->node, &object->area_list);
797 spin_unlock_irqrestore(&object->lock, flags);
803 * Set the OBJECT_NO_SCAN flag for the object corresponding to the give
804 * pointer. Such object will not be scanned by kmemleak but references to it
807 static void object_no_scan(unsigned long ptr)
810 struct kmemleak_object *object;
812 object = find_and_get_object(ptr, 0);
814 kmemleak_warn("Not scanning unknown object at 0x%08lx\n", ptr);
818 spin_lock_irqsave(&object->lock, flags);
819 object->flags |= OBJECT_NO_SCAN;
820 spin_unlock_irqrestore(&object->lock, flags);
825 * Log an early kmemleak_* call to the early_log buffer. These calls will be
826 * processed later once kmemleak is fully initialized.
828 static void __init log_early(int op_type, const void *ptr, size_t size,
832 struct early_log *log;
834 if (kmemleak_error) {
835 /* kmemleak stopped recording, just count the requests */
840 if (crt_early_log >= ARRAY_SIZE(early_log)) {
847 * There is no need for locking since the kernel is still in UP mode
848 * at this stage. Disabling the IRQs is enough.
850 local_irq_save(flags);
851 log = &early_log[crt_early_log];
852 log->op_type = op_type;
855 log->min_count = min_count;
856 log->trace_len = __save_stack_trace(log->trace);
858 local_irq_restore(flags);
862 * Log an early allocated block and populate the stack trace.
864 static void early_alloc(struct early_log *log)
866 struct kmemleak_object *object;
870 if (!kmemleak_enabled || !log->ptr || IS_ERR(log->ptr))
874 * RCU locking needed to ensure object is not freed via put_object().
877 object = create_object((unsigned long)log->ptr, log->size,
878 log->min_count, GFP_ATOMIC);
881 spin_lock_irqsave(&object->lock, flags);
882 for (i = 0; i < log->trace_len; i++)
883 object->trace[i] = log->trace[i];
884 object->trace_len = log->trace_len;
885 spin_unlock_irqrestore(&object->lock, flags);
891 * Log an early allocated block and populate the stack trace.
893 static void early_alloc_percpu(struct early_log *log)
896 const void __percpu *ptr = log->ptr;
898 for_each_possible_cpu(cpu) {
899 log->ptr = per_cpu_ptr(ptr, cpu);
905 * kmemleak_alloc - register a newly allocated object
906 * @ptr: pointer to beginning of the object
907 * @size: size of the object
908 * @min_count: minimum number of references to this object. If during memory
909 * scanning a number of references less than @min_count is found,
910 * the object is reported as a memory leak. If @min_count is 0,
911 * the object is never reported as a leak. If @min_count is -1,
912 * the object is ignored (not scanned and not reported as a leak)
913 * @gfp: kmalloc() flags used for kmemleak internal memory allocations
915 * This function is called from the kernel allocators when a new object
916 * (memory block) is allocated (kmem_cache_alloc, kmalloc, vmalloc etc.).
918 void __ref kmemleak_alloc(const void *ptr, size_t size, int min_count,
921 pr_debug("%s(0x%p, %zu, %d)\n", __func__, ptr, size, min_count);
923 if (kmemleak_enabled && ptr && !IS_ERR(ptr))
924 create_object((unsigned long)ptr, size, min_count, gfp);
925 else if (kmemleak_early_log)
926 log_early(KMEMLEAK_ALLOC, ptr, size, min_count);
928 EXPORT_SYMBOL_GPL(kmemleak_alloc);
931 * kmemleak_alloc_percpu - register a newly allocated __percpu object
932 * @ptr: __percpu pointer to beginning of the object
933 * @size: size of the object
934 * @gfp: flags used for kmemleak internal memory allocations
936 * This function is called from the kernel percpu allocator when a new object
937 * (memory block) is allocated (alloc_percpu).
939 void __ref kmemleak_alloc_percpu(const void __percpu *ptr, size_t size,
944 pr_debug("%s(0x%p, %zu)\n", __func__, ptr, size);
947 * Percpu allocations are only scanned and not reported as leaks
948 * (min_count is set to 0).
950 if (kmemleak_enabled && ptr && !IS_ERR(ptr))
951 for_each_possible_cpu(cpu)
952 create_object((unsigned long)per_cpu_ptr(ptr, cpu),
954 else if (kmemleak_early_log)
955 log_early(KMEMLEAK_ALLOC_PERCPU, ptr, size, 0);
957 EXPORT_SYMBOL_GPL(kmemleak_alloc_percpu);
960 * kmemleak_free - unregister a previously registered object
961 * @ptr: pointer to beginning of the object
963 * This function is called from the kernel allocators when an object (memory
964 * block) is freed (kmem_cache_free, kfree, vfree etc.).
966 void __ref kmemleak_free(const void *ptr)
968 pr_debug("%s(0x%p)\n", __func__, ptr);
970 if (kmemleak_free_enabled && ptr && !IS_ERR(ptr))
971 delete_object_full((unsigned long)ptr);
972 else if (kmemleak_early_log)
973 log_early(KMEMLEAK_FREE, ptr, 0, 0);
975 EXPORT_SYMBOL_GPL(kmemleak_free);
978 * kmemleak_free_part - partially unregister a previously registered object
979 * @ptr: pointer to the beginning or inside the object. This also
980 * represents the start of the range to be freed
981 * @size: size to be unregistered
983 * This function is called when only a part of a memory block is freed
984 * (usually from the bootmem allocator).
986 void __ref kmemleak_free_part(const void *ptr, size_t size)
988 pr_debug("%s(0x%p)\n", __func__, ptr);
990 if (kmemleak_enabled && ptr && !IS_ERR(ptr))
991 delete_object_part((unsigned long)ptr, size);
992 else if (kmemleak_early_log)
993 log_early(KMEMLEAK_FREE_PART, ptr, size, 0);
995 EXPORT_SYMBOL_GPL(kmemleak_free_part);
998 * kmemleak_free_percpu - unregister a previously registered __percpu object
999 * @ptr: __percpu pointer to beginning of the object
1001 * This function is called from the kernel percpu allocator when an object
1002 * (memory block) is freed (free_percpu).
1004 void __ref kmemleak_free_percpu(const void __percpu *ptr)
1008 pr_debug("%s(0x%p)\n", __func__, ptr);
1010 if (kmemleak_free_enabled && ptr && !IS_ERR(ptr))
1011 for_each_possible_cpu(cpu)
1012 delete_object_full((unsigned long)per_cpu_ptr(ptr,
1014 else if (kmemleak_early_log)
1015 log_early(KMEMLEAK_FREE_PERCPU, ptr, 0, 0);
1017 EXPORT_SYMBOL_GPL(kmemleak_free_percpu);
1020 * kmemleak_update_trace - update object allocation stack trace
1021 * @ptr: pointer to beginning of the object
1023 * Override the object allocation stack trace for cases where the actual
1024 * allocation place is not always useful.
1026 void __ref kmemleak_update_trace(const void *ptr)
1028 struct kmemleak_object *object;
1029 unsigned long flags;
1031 pr_debug("%s(0x%p)\n", __func__, ptr);
1033 if (!kmemleak_enabled || IS_ERR_OR_NULL(ptr))
1036 object = find_and_get_object((unsigned long)ptr, 1);
1039 kmemleak_warn("Updating stack trace for unknown object at %p\n",
1045 spin_lock_irqsave(&object->lock, flags);
1046 object->trace_len = __save_stack_trace(object->trace);
1047 spin_unlock_irqrestore(&object->lock, flags);
1051 EXPORT_SYMBOL(kmemleak_update_trace);
1054 * kmemleak_not_leak - mark an allocated object as false positive
1055 * @ptr: pointer to beginning of the object
1057 * Calling this function on an object will cause the memory block to no longer
1058 * be reported as leak and always be scanned.
1060 void __ref kmemleak_not_leak(const void *ptr)
1062 pr_debug("%s(0x%p)\n", __func__, ptr);
1064 if (kmemleak_enabled && ptr && !IS_ERR(ptr))
1065 make_gray_object((unsigned long)ptr);
1066 else if (kmemleak_early_log)
1067 log_early(KMEMLEAK_NOT_LEAK, ptr, 0, 0);
1069 EXPORT_SYMBOL(kmemleak_not_leak);
1072 * kmemleak_ignore - ignore an allocated object
1073 * @ptr: pointer to beginning of the object
1075 * Calling this function on an object will cause the memory block to be
1076 * ignored (not scanned and not reported as a leak). This is usually done when
1077 * it is known that the corresponding block is not a leak and does not contain
1078 * any references to other allocated memory blocks.
1080 void __ref kmemleak_ignore(const void *ptr)
1082 pr_debug("%s(0x%p)\n", __func__, ptr);
1084 if (kmemleak_enabled && ptr && !IS_ERR(ptr))
1085 make_black_object((unsigned long)ptr);
1086 else if (kmemleak_early_log)
1087 log_early(KMEMLEAK_IGNORE, ptr, 0, 0);
1089 EXPORT_SYMBOL(kmemleak_ignore);
1092 * kmemleak_scan_area - limit the range to be scanned in an allocated object
1093 * @ptr: pointer to beginning or inside the object. This also
1094 * represents the start of the scan area
1095 * @size: size of the scan area
1096 * @gfp: kmalloc() flags used for kmemleak internal memory allocations
1098 * This function is used when it is known that only certain parts of an object
1099 * contain references to other objects. Kmemleak will only scan these areas
1100 * reducing the number false negatives.
1102 void __ref kmemleak_scan_area(const void *ptr, size_t size, gfp_t gfp)
1104 pr_debug("%s(0x%p)\n", __func__, ptr);
1106 if (kmemleak_enabled && ptr && size && !IS_ERR(ptr))
1107 add_scan_area((unsigned long)ptr, size, gfp);
1108 else if (kmemleak_early_log)
1109 log_early(KMEMLEAK_SCAN_AREA, ptr, size, 0);
1111 EXPORT_SYMBOL(kmemleak_scan_area);
1114 * kmemleak_no_scan - do not scan an allocated object
1115 * @ptr: pointer to beginning of the object
1117 * This function notifies kmemleak not to scan the given memory block. Useful
1118 * in situations where it is known that the given object does not contain any
1119 * references to other objects. Kmemleak will not scan such objects reducing
1120 * the number of false negatives.
1122 void __ref kmemleak_no_scan(const void *ptr)
1124 pr_debug("%s(0x%p)\n", __func__, ptr);
1126 if (kmemleak_enabled && ptr && !IS_ERR(ptr))
1127 object_no_scan((unsigned long)ptr);
1128 else if (kmemleak_early_log)
1129 log_early(KMEMLEAK_NO_SCAN, ptr, 0, 0);
1131 EXPORT_SYMBOL(kmemleak_no_scan);
1134 * Update an object's checksum and return true if it was modified.
1136 static bool update_checksum(struct kmemleak_object *object)
1138 u32 old_csum = object->checksum;
1140 if (!kmemcheck_is_obj_initialized(object->pointer, object->size))
1143 kasan_disable_current();
1144 object->checksum = crc32(0, (void *)object->pointer, object->size);
1145 kasan_enable_current();
1147 return object->checksum != old_csum;
1151 * Memory scanning is a long process and it needs to be interruptable. This
1152 * function checks whether such interrupt condition occurred.
1154 static int scan_should_stop(void)
1156 if (!kmemleak_enabled)
1160 * This function may be called from either process or kthread context,
1161 * hence the need to check for both stop conditions.
1164 return signal_pending(current);
1166 return kthread_should_stop();
1172 * Scan a memory block (exclusive range) for valid pointers and add those
1173 * found to the gray list.
1175 static void scan_block(void *_start, void *_end,
1176 struct kmemleak_object *scanned)
1179 unsigned long *start = PTR_ALIGN(_start, BYTES_PER_POINTER);
1180 unsigned long *end = _end - (BYTES_PER_POINTER - 1);
1181 unsigned long flags;
1183 read_lock_irqsave(&kmemleak_lock, flags);
1184 for (ptr = start; ptr < end; ptr++) {
1185 struct kmemleak_object *object;
1186 unsigned long pointer;
1188 if (scan_should_stop())
1191 /* don't scan uninitialized memory */
1192 if (!kmemcheck_is_obj_initialized((unsigned long)ptr,
1196 kasan_disable_current();
1198 kasan_enable_current();
1200 if (pointer < min_addr || pointer >= max_addr)
1204 * No need for get_object() here since we hold kmemleak_lock.
1205 * object->use_count cannot be dropped to 0 while the object
1206 * is still present in object_tree_root and object_list
1207 * (with updates protected by kmemleak_lock).
1209 object = lookup_object(pointer, 1);
1212 if (object == scanned)
1213 /* self referenced, ignore */
1217 * Avoid the lockdep recursive warning on object->lock being
1218 * previously acquired in scan_object(). These locks are
1219 * enclosed by scan_mutex.
1221 spin_lock_nested(&object->lock, SINGLE_DEPTH_NESTING);
1222 if (!color_white(object)) {
1223 /* non-orphan, ignored or new */
1224 spin_unlock(&object->lock);
1229 * Increase the object's reference count (number of pointers
1230 * to the memory block). If this count reaches the required
1231 * minimum, the object's color will become gray and it will be
1232 * added to the gray_list.
1235 if (color_gray(object)) {
1236 /* put_object() called when removing from gray_list */
1237 WARN_ON(!get_object(object));
1238 list_add_tail(&object->gray_list, &gray_list);
1240 spin_unlock(&object->lock);
1242 read_unlock_irqrestore(&kmemleak_lock, flags);
1246 * Scan a large memory block in MAX_SCAN_SIZE chunks to reduce the latency.
1248 static void scan_large_block(void *start, void *end)
1252 while (start < end) {
1253 next = min(start + MAX_SCAN_SIZE, end);
1254 scan_block(start, next, NULL);
1261 * Scan a memory block corresponding to a kmemleak_object. A condition is
1262 * that object->use_count >= 1.
1264 static void scan_object(struct kmemleak_object *object)
1266 struct kmemleak_scan_area *area;
1267 unsigned long flags;
1270 * Once the object->lock is acquired, the corresponding memory block
1271 * cannot be freed (the same lock is acquired in delete_object).
1273 spin_lock_irqsave(&object->lock, flags);
1274 if (object->flags & OBJECT_NO_SCAN)
1276 if (!(object->flags & OBJECT_ALLOCATED))
1277 /* already freed object */
1279 if (hlist_empty(&object->area_list)) {
1280 void *start = (void *)object->pointer;
1281 void *end = (void *)(object->pointer + object->size);
1285 next = min(start + MAX_SCAN_SIZE, end);
1286 scan_block(start, next, object);
1292 spin_unlock_irqrestore(&object->lock, flags);
1294 spin_lock_irqsave(&object->lock, flags);
1295 } while (object->flags & OBJECT_ALLOCATED);
1297 hlist_for_each_entry(area, &object->area_list, node)
1298 scan_block((void *)area->start,
1299 (void *)(area->start + area->size),
1302 spin_unlock_irqrestore(&object->lock, flags);
1306 * Scan the objects already referenced (gray objects). More objects will be
1307 * referenced and, if there are no memory leaks, all the objects are scanned.
1309 static void scan_gray_list(void)
1311 struct kmemleak_object *object, *tmp;
1314 * The list traversal is safe for both tail additions and removals
1315 * from inside the loop. The kmemleak objects cannot be freed from
1316 * outside the loop because their use_count was incremented.
1318 object = list_entry(gray_list.next, typeof(*object), gray_list);
1319 while (&object->gray_list != &gray_list) {
1322 /* may add new objects to the list */
1323 if (!scan_should_stop())
1324 scan_object(object);
1326 tmp = list_entry(object->gray_list.next, typeof(*object),
1329 /* remove the object from the list and release it */
1330 list_del(&object->gray_list);
1335 WARN_ON(!list_empty(&gray_list));
1339 * Scan data sections and all the referenced memory blocks allocated via the
1340 * kernel's standard allocators. This function must be called with the
1343 static void kmemleak_scan(void)
1345 unsigned long flags;
1346 struct kmemleak_object *object;
1350 jiffies_last_scan = jiffies;
1352 /* prepare the kmemleak_object's */
1354 list_for_each_entry_rcu(object, &object_list, object_list) {
1355 spin_lock_irqsave(&object->lock, flags);
1358 * With a few exceptions there should be a maximum of
1359 * 1 reference to any object at this point.
1361 if (atomic_read(&object->use_count) > 1) {
1362 pr_debug("object->use_count = %d\n",
1363 atomic_read(&object->use_count));
1364 dump_object_info(object);
1367 /* reset the reference count (whiten the object) */
1369 if (color_gray(object) && get_object(object))
1370 list_add_tail(&object->gray_list, &gray_list);
1372 spin_unlock_irqrestore(&object->lock, flags);
1376 /* data/bss scanning */
1377 scan_large_block(_sdata, _edata);
1378 scan_large_block(__bss_start, __bss_stop);
1381 /* per-cpu sections scanning */
1382 for_each_possible_cpu(i)
1383 scan_large_block(__per_cpu_start + per_cpu_offset(i),
1384 __per_cpu_end + per_cpu_offset(i));
1388 * Struct page scanning for each node.
1391 for_each_online_node(i) {
1392 unsigned long start_pfn = node_start_pfn(i);
1393 unsigned long end_pfn = node_end_pfn(i);
1396 for (pfn = start_pfn; pfn < end_pfn; pfn++) {
1399 if (!pfn_valid(pfn))
1401 page = pfn_to_page(pfn);
1402 /* only scan if page is in use */
1403 if (page_count(page) == 0)
1405 scan_block(page, page + 1, NULL);
1406 if (!(pfn % (MAX_SCAN_SIZE / sizeof(*page))))
1413 * Scanning the task stacks (may introduce false negatives).
1415 if (kmemleak_stack_scan) {
1416 struct task_struct *p, *g;
1418 read_lock(&tasklist_lock);
1419 do_each_thread(g, p) {
1420 scan_block(task_stack_page(p), task_stack_page(p) +
1422 } while_each_thread(g, p);
1423 read_unlock(&tasklist_lock);
1427 * Scan the objects already referenced from the sections scanned
1433 * Check for new or unreferenced objects modified since the previous
1434 * scan and color them gray until the next scan.
1437 list_for_each_entry_rcu(object, &object_list, object_list) {
1438 spin_lock_irqsave(&object->lock, flags);
1439 if (color_white(object) && (object->flags & OBJECT_ALLOCATED)
1440 && update_checksum(object) && get_object(object)) {
1441 /* color it gray temporarily */
1442 object->count = object->min_count;
1443 list_add_tail(&object->gray_list, &gray_list);
1445 spin_unlock_irqrestore(&object->lock, flags);
1450 * Re-scan the gray list for modified unreferenced objects.
1455 * If scanning was stopped do not report any new unreferenced objects.
1457 if (scan_should_stop())
1461 * Scanning result reporting.
1464 list_for_each_entry_rcu(object, &object_list, object_list) {
1465 spin_lock_irqsave(&object->lock, flags);
1466 if (unreferenced_object(object) &&
1467 !(object->flags & OBJECT_REPORTED)) {
1468 object->flags |= OBJECT_REPORTED;
1471 spin_unlock_irqrestore(&object->lock, flags);
1476 kmemleak_found_leaks = true;
1478 pr_info("%d new suspected memory leaks (see /sys/kernel/debug/kmemleak)\n",
1485 * Thread function performing automatic memory scanning. Unreferenced objects
1486 * at the end of a memory scan are reported but only the first time.
1488 static int kmemleak_scan_thread(void *arg)
1490 static int first_run = 1;
1492 pr_info("Automatic memory scanning thread started\n");
1493 set_user_nice(current, 10);
1496 * Wait before the first scan to allow the system to fully initialize.
1500 ssleep(SECS_FIRST_SCAN);
1503 while (!kthread_should_stop()) {
1504 signed long timeout = jiffies_scan_wait;
1506 mutex_lock(&scan_mutex);
1508 mutex_unlock(&scan_mutex);
1510 /* wait before the next scan */
1511 while (timeout && !kthread_should_stop())
1512 timeout = schedule_timeout_interruptible(timeout);
1515 pr_info("Automatic memory scanning thread ended\n");
1521 * Start the automatic memory scanning thread. This function must be called
1522 * with the scan_mutex held.
1524 static void start_scan_thread(void)
1528 scan_thread = kthread_run(kmemleak_scan_thread, NULL, "kmemleak");
1529 if (IS_ERR(scan_thread)) {
1530 pr_warning("Failed to create the scan thread\n");
1536 * Stop the automatic memory scanning thread.
1538 static void stop_scan_thread(void)
1541 kthread_stop(scan_thread);
1547 * Iterate over the object_list and return the first valid object at or after
1548 * the required position with its use_count incremented. The function triggers
1549 * a memory scanning when the pos argument points to the first position.
1551 static void *kmemleak_seq_start(struct seq_file *seq, loff_t *pos)
1553 struct kmemleak_object *object;
1557 err = mutex_lock_interruptible(&scan_mutex);
1559 return ERR_PTR(err);
1562 list_for_each_entry_rcu(object, &object_list, object_list) {
1565 if (get_object(object))
1574 * Return the next object in the object_list. The function decrements the
1575 * use_count of the previous object and increases that of the next one.
1577 static void *kmemleak_seq_next(struct seq_file *seq, void *v, loff_t *pos)
1579 struct kmemleak_object *prev_obj = v;
1580 struct kmemleak_object *next_obj = NULL;
1581 struct kmemleak_object *obj = prev_obj;
1585 list_for_each_entry_continue_rcu(obj, &object_list, object_list) {
1586 if (get_object(obj)) {
1592 put_object(prev_obj);
1597 * Decrement the use_count of the last object required, if any.
1599 static void kmemleak_seq_stop(struct seq_file *seq, void *v)
1603 * kmemleak_seq_start may return ERR_PTR if the scan_mutex
1604 * waiting was interrupted, so only release it if !IS_ERR.
1607 mutex_unlock(&scan_mutex);
1614 * Print the information for an unreferenced object to the seq file.
1616 static int kmemleak_seq_show(struct seq_file *seq, void *v)
1618 struct kmemleak_object *object = v;
1619 unsigned long flags;
1621 spin_lock_irqsave(&object->lock, flags);
1622 if ((object->flags & OBJECT_REPORTED) && unreferenced_object(object))
1623 print_unreferenced(seq, object);
1624 spin_unlock_irqrestore(&object->lock, flags);
1628 static const struct seq_operations kmemleak_seq_ops = {
1629 .start = kmemleak_seq_start,
1630 .next = kmemleak_seq_next,
1631 .stop = kmemleak_seq_stop,
1632 .show = kmemleak_seq_show,
1635 static int kmemleak_open(struct inode *inode, struct file *file)
1637 return seq_open(file, &kmemleak_seq_ops);
1640 static int dump_str_object_info(const char *str)
1642 unsigned long flags;
1643 struct kmemleak_object *object;
1646 if (kstrtoul(str, 0, &addr))
1648 object = find_and_get_object(addr, 0);
1650 pr_info("Unknown object at 0x%08lx\n", addr);
1654 spin_lock_irqsave(&object->lock, flags);
1655 dump_object_info(object);
1656 spin_unlock_irqrestore(&object->lock, flags);
1663 * We use grey instead of black to ensure we can do future scans on the same
1664 * objects. If we did not do future scans these black objects could
1665 * potentially contain references to newly allocated objects in the future and
1666 * we'd end up with false positives.
1668 static void kmemleak_clear(void)
1670 struct kmemleak_object *object;
1671 unsigned long flags;
1674 list_for_each_entry_rcu(object, &object_list, object_list) {
1675 spin_lock_irqsave(&object->lock, flags);
1676 if ((object->flags & OBJECT_REPORTED) &&
1677 unreferenced_object(object))
1678 __paint_it(object, KMEMLEAK_GREY);
1679 spin_unlock_irqrestore(&object->lock, flags);
1683 kmemleak_found_leaks = false;
1686 static void __kmemleak_do_cleanup(void);
1689 * File write operation to configure kmemleak at run-time. The following
1690 * commands can be written to the /sys/kernel/debug/kmemleak file:
1691 * off - disable kmemleak (irreversible)
1692 * stack=on - enable the task stacks scanning
1693 * stack=off - disable the tasks stacks scanning
1694 * scan=on - start the automatic memory scanning thread
1695 * scan=off - stop the automatic memory scanning thread
1696 * scan=... - set the automatic memory scanning period in seconds (0 to
1698 * scan - trigger a memory scan
1699 * clear - mark all current reported unreferenced kmemleak objects as
1700 * grey to ignore printing them, or free all kmemleak objects
1701 * if kmemleak has been disabled.
1702 * dump=... - dump information about the object found at the given address
1704 static ssize_t kmemleak_write(struct file *file, const char __user *user_buf,
1705 size_t size, loff_t *ppos)
1711 buf_size = min(size, (sizeof(buf) - 1));
1712 if (strncpy_from_user(buf, user_buf, buf_size) < 0)
1716 ret = mutex_lock_interruptible(&scan_mutex);
1720 if (strncmp(buf, "clear", 5) == 0) {
1721 if (kmemleak_enabled)
1724 __kmemleak_do_cleanup();
1728 if (!kmemleak_enabled) {
1733 if (strncmp(buf, "off", 3) == 0)
1735 else if (strncmp(buf, "stack=on", 8) == 0)
1736 kmemleak_stack_scan = 1;
1737 else if (strncmp(buf, "stack=off", 9) == 0)
1738 kmemleak_stack_scan = 0;
1739 else if (strncmp(buf, "scan=on", 7) == 0)
1740 start_scan_thread();
1741 else if (strncmp(buf, "scan=off", 8) == 0)
1743 else if (strncmp(buf, "scan=", 5) == 0) {
1746 ret = kstrtoul(buf + 5, 0, &secs);
1751 jiffies_scan_wait = msecs_to_jiffies(secs * 1000);
1752 start_scan_thread();
1754 } else if (strncmp(buf, "scan", 4) == 0)
1756 else if (strncmp(buf, "dump=", 5) == 0)
1757 ret = dump_str_object_info(buf + 5);
1762 mutex_unlock(&scan_mutex);
1766 /* ignore the rest of the buffer, only one command at a time */
1771 static const struct file_operations kmemleak_fops = {
1772 .owner = THIS_MODULE,
1773 .open = kmemleak_open,
1775 .write = kmemleak_write,
1776 .llseek = seq_lseek,
1777 .release = seq_release,
1780 static void __kmemleak_do_cleanup(void)
1782 struct kmemleak_object *object;
1785 list_for_each_entry_rcu(object, &object_list, object_list)
1786 delete_object_full(object->pointer);
1791 * Stop the memory scanning thread and free the kmemleak internal objects if
1792 * no previous scan thread (otherwise, kmemleak may still have some useful
1793 * information on memory leaks).
1795 static void kmemleak_do_cleanup(struct work_struct *work)
1799 mutex_lock(&scan_mutex);
1801 * Once it is made sure that kmemleak_scan has stopped, it is safe to no
1802 * longer track object freeing. Ordering of the scan thread stopping and
1803 * the memory accesses below is guaranteed by the kthread_stop()
1806 kmemleak_free_enabled = 0;
1807 mutex_unlock(&scan_mutex);
1809 if (!kmemleak_found_leaks)
1810 __kmemleak_do_cleanup();
1812 pr_info("Kmemleak disabled without freeing internal data. Reclaim the memory with \"echo clear > /sys/kernel/debug/kmemleak\".\n");
1815 static DECLARE_WORK(cleanup_work, kmemleak_do_cleanup);
1818 * Disable kmemleak. No memory allocation/freeing will be traced once this
1819 * function is called. Disabling kmemleak is an irreversible operation.
1821 static void kmemleak_disable(void)
1823 /* atomically check whether it was already invoked */
1824 if (cmpxchg(&kmemleak_error, 0, 1))
1827 /* stop any memory operation tracing */
1828 kmemleak_enabled = 0;
1830 /* check whether it is too early for a kernel thread */
1831 if (kmemleak_initialized)
1832 schedule_work(&cleanup_work);
1834 kmemleak_free_enabled = 0;
1836 pr_info("Kernel memory leak detector disabled\n");
1840 * Allow boot-time kmemleak disabling (enabled by default).
1842 static int kmemleak_boot_config(char *str)
1846 if (strcmp(str, "off") == 0)
1848 else if (strcmp(str, "on") == 0)
1849 kmemleak_skip_disable = 1;
1854 early_param("kmemleak", kmemleak_boot_config);
1856 static void __init print_log_trace(struct early_log *log)
1858 struct stack_trace trace;
1860 trace.nr_entries = log->trace_len;
1861 trace.entries = log->trace;
1863 pr_notice("Early log backtrace:\n");
1864 print_stack_trace(&trace, 2);
1868 * Kmemleak initialization.
1870 void __init kmemleak_init(void)
1873 unsigned long flags;
1875 #ifdef CONFIG_DEBUG_KMEMLEAK_DEFAULT_OFF
1876 if (!kmemleak_skip_disable) {
1877 kmemleak_early_log = 0;
1883 jiffies_min_age = msecs_to_jiffies(MSECS_MIN_AGE);
1884 jiffies_scan_wait = msecs_to_jiffies(SECS_SCAN_WAIT * 1000);
1886 object_cache = KMEM_CACHE(kmemleak_object, SLAB_NOLEAKTRACE);
1887 scan_area_cache = KMEM_CACHE(kmemleak_scan_area, SLAB_NOLEAKTRACE);
1889 if (crt_early_log > ARRAY_SIZE(early_log))
1890 pr_warning("Early log buffer exceeded (%d), please increase "
1891 "DEBUG_KMEMLEAK_EARLY_LOG_SIZE\n", crt_early_log);
1893 /* the kernel is still in UP mode, so disabling the IRQs is enough */
1894 local_irq_save(flags);
1895 kmemleak_early_log = 0;
1896 if (kmemleak_error) {
1897 local_irq_restore(flags);
1900 kmemleak_enabled = 1;
1901 kmemleak_free_enabled = 1;
1903 local_irq_restore(flags);
1906 * This is the point where tracking allocations is safe. Automatic
1907 * scanning is started during the late initcall. Add the early logged
1908 * callbacks to the kmemleak infrastructure.
1910 for (i = 0; i < crt_early_log; i++) {
1911 struct early_log *log = &early_log[i];
1913 switch (log->op_type) {
1914 case KMEMLEAK_ALLOC:
1917 case KMEMLEAK_ALLOC_PERCPU:
1918 early_alloc_percpu(log);
1921 kmemleak_free(log->ptr);
1923 case KMEMLEAK_FREE_PART:
1924 kmemleak_free_part(log->ptr, log->size);
1926 case KMEMLEAK_FREE_PERCPU:
1927 kmemleak_free_percpu(log->ptr);
1929 case KMEMLEAK_NOT_LEAK:
1930 kmemleak_not_leak(log->ptr);
1932 case KMEMLEAK_IGNORE:
1933 kmemleak_ignore(log->ptr);
1935 case KMEMLEAK_SCAN_AREA:
1936 kmemleak_scan_area(log->ptr, log->size, GFP_KERNEL);
1938 case KMEMLEAK_NO_SCAN:
1939 kmemleak_no_scan(log->ptr);
1942 kmemleak_warn("Unknown early log operation: %d\n",
1946 if (kmemleak_warning) {
1947 print_log_trace(log);
1948 kmemleak_warning = 0;
1954 * Late initialization function.
1956 static int __init kmemleak_late_init(void)
1958 struct dentry *dentry;
1960 kmemleak_initialized = 1;
1962 if (kmemleak_error) {
1964 * Some error occurred and kmemleak was disabled. There is a
1965 * small chance that kmemleak_disable() was called immediately
1966 * after setting kmemleak_initialized and we may end up with
1967 * two clean-up threads but serialized by scan_mutex.
1969 schedule_work(&cleanup_work);
1973 dentry = debugfs_create_file("kmemleak", S_IRUGO, NULL, NULL,
1976 pr_warning("Failed to create the debugfs kmemleak file\n");
1977 mutex_lock(&scan_mutex);
1978 start_scan_thread();
1979 mutex_unlock(&scan_mutex);
1981 pr_info("Kernel memory leak detector initialized\n");
1985 late_initcall(kmemleak_late_init);