]> git.ipfire.org Git - thirdparty/linux.git/blame - mm/kmemleak.c
drivers/s390/crypto/zcrypt_api.c: use seq_hex_dump() to dump buffers
[thirdparty/linux.git] / mm / kmemleak.c
CommitLineData
3c7b4e6b
CM
1/*
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
85d3a316 32 * blocks. The object_tree_root is a red black tree used to look-up
3c7b4e6b
CM
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
4698c1f2
CM
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
54 * pointer
3c7b4e6b 55 *
93ada579 56 * Locks and mutexes are acquired/nested in the following order:
9d5a4c73 57 *
93ada579
CM
58 * scan_mutex [-> object->lock] -> kmemleak_lock -> other_object->lock (SINGLE_DEPTH_NESTING)
59 *
60 * No kmemleak_lock and object->lock nesting is allowed outside scan_mutex
61 * regions.
9d5a4c73 62 *
3c7b4e6b
CM
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
68 * structure.
69 */
70
ae281064
JP
71#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
72
3c7b4e6b
CM
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>
b95f1b31 79#include <linux/export.h>
3c7b4e6b 80#include <linux/kthread.h>
85d3a316 81#include <linux/rbtree.h>
3c7b4e6b
CM
82#include <linux/fs.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>
179a8100 101#include <linux/workqueue.h>
04609ccc 102#include <linux/crc32.h>
3c7b4e6b
CM
103
104#include <asm/sections.h>
105#include <asm/processor.h>
60063497 106#include <linux/atomic.h>
3c7b4e6b 107
e79ed2f1 108#include <linux/kasan.h>
8e019366 109#include <linux/kmemcheck.h>
3c7b4e6b 110#include <linux/kmemleak.h>
029aeff5 111#include <linux/memory_hotplug.h>
3c7b4e6b
CM
112
113/*
114 * Kmemleak configuration and common defines.
115 */
116#define MAX_TRACE 16 /* stack trace length */
3c7b4e6b 117#define MSECS_MIN_AGE 5000 /* minimum object age for reporting */
3c7b4e6b
CM
118#define SECS_FIRST_SCAN 60 /* delay before the first scan */
119#define SECS_SCAN_WAIT 600 /* subsequent auto scanning delay */
af98603d 120#define MAX_SCAN_SIZE 4096 /* maximum size of a scanned block */
3c7b4e6b
CM
121
122#define BYTES_PER_POINTER sizeof(void *)
123
216c04b0 124/* GFP bitmask for kmemleak internal allocations */
8f4fc071
VD
125#define gfp_kmemleak_mask(gfp) (((gfp) & (GFP_KERNEL | GFP_ATOMIC | \
126 __GFP_NOACCOUNT)) | \
6ae4bd1f
CM
127 __GFP_NORETRY | __GFP_NOMEMALLOC | \
128 __GFP_NOWARN)
216c04b0 129
3c7b4e6b
CM
130/* scanning area inside a memory block */
131struct kmemleak_scan_area {
132 struct hlist_node node;
c017b4be
CM
133 unsigned long start;
134 size_t size;
3c7b4e6b
CM
135};
136
a1084c87
LR
137#define KMEMLEAK_GREY 0
138#define KMEMLEAK_BLACK -1
139
3c7b4e6b
CM
140/*
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
85d3a316 144 * rb_node are already protected by the corresponding locks or mutex (see
3c7b4e6b
CM
145 * the notes on locking above). These objects are reference-counted
146 * (use_count) and freed using the RCU mechanism.
147 */
148struct kmemleak_object {
149 spinlock_t lock;
150 unsigned long flags; /* object status flags */
151 struct list_head object_list;
152 struct list_head gray_list;
85d3a316 153 struct rb_node rb_node;
3c7b4e6b
CM
154 struct rcu_head rcu; /* object_list lockless traversal */
155 /* object usage count; object freed when use_count == 0 */
156 atomic_t use_count;
157 unsigned long pointer;
158 size_t size;
159 /* minimum number of a pointers found before it is considered leak */
160 int min_count;
161 /* the total number of pointers found pointing to this object */
162 int count;
04609ccc
CM
163 /* checksum for detecting modified objects */
164 u32 checksum;
3c7b4e6b
CM
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 */
172};
173
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)
180
0494e082
SS
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 */
186#define HEX_ASCII 1
187/* max number of lines to be printed */
188#define HEX_MAX_LINES 2
189
3c7b4e6b
CM
190/* the list of all allocated objects */
191static LIST_HEAD(object_list);
192/* the list of gray-colored objects (see color_gray comment below) */
193static LIST_HEAD(gray_list);
85d3a316
ML
194/* search tree for object boundaries */
195static struct rb_root object_tree_root = RB_ROOT;
196/* rw_lock protecting the access to object_list and object_tree_root */
3c7b4e6b
CM
197static DEFINE_RWLOCK(kmemleak_lock);
198
199/* allocation caches for kmemleak internal data */
200static struct kmem_cache *object_cache;
201static struct kmem_cache *scan_area_cache;
202
203/* set if tracing memory operations is enabled */
8910ae89 204static int kmemleak_enabled;
c5f3b1a5
CM
205/* same as above but only for the kmemleak_free() callback */
206static int kmemleak_free_enabled;
3c7b4e6b 207/* set in the late_initcall if there were no errors */
8910ae89 208static int kmemleak_initialized;
3c7b4e6b 209/* enables or disables early logging of the memory operations */
8910ae89 210static int kmemleak_early_log = 1;
5f79020c 211/* set if a kmemleak warning was issued */
8910ae89 212static int kmemleak_warning;
5f79020c 213/* set if a fatal kmemleak error has occurred */
8910ae89 214static int kmemleak_error;
3c7b4e6b
CM
215
216/* minimum and maximum address that may be valid pointers */
217static unsigned long min_addr = ULONG_MAX;
218static unsigned long max_addr;
219
3c7b4e6b 220static struct task_struct *scan_thread;
acf4968e 221/* used to avoid reporting of recently allocated objects */
3c7b4e6b 222static unsigned long jiffies_min_age;
acf4968e 223static unsigned long jiffies_last_scan;
3c7b4e6b
CM
224/* delay between automatic memory scannings */
225static signed long jiffies_scan_wait;
226/* enables or disables the task stacks scanning */
e0a2a160 227static int kmemleak_stack_scan = 1;
4698c1f2 228/* protects the memory scanning, parameters and debug/kmemleak file access */
3c7b4e6b 229static DEFINE_MUTEX(scan_mutex);
ab0155a2
JB
230/* setting kmemleak=on, will set this var, skipping the disable */
231static int kmemleak_skip_disable;
dc9b3f42
LZ
232/* If there are leaks that can be reported */
233static bool kmemleak_found_leaks;
3c7b4e6b 234
3c7b4e6b 235/*
2030117d 236 * Early object allocation/freeing logging. Kmemleak is initialized after the
3c7b4e6b 237 * kernel allocator. However, both the kernel allocator and kmemleak may
2030117d 238 * allocate memory blocks which need to be tracked. Kmemleak defines an
3c7b4e6b
CM
239 * arbitrary buffer to hold the allocation/freeing information before it is
240 * fully initialized.
241 */
242
243/* kmemleak operation type for early logging */
244enum {
245 KMEMLEAK_ALLOC,
f528f0b8 246 KMEMLEAK_ALLOC_PERCPU,
3c7b4e6b 247 KMEMLEAK_FREE,
53238a60 248 KMEMLEAK_FREE_PART,
f528f0b8 249 KMEMLEAK_FREE_PERCPU,
3c7b4e6b
CM
250 KMEMLEAK_NOT_LEAK,
251 KMEMLEAK_IGNORE,
252 KMEMLEAK_SCAN_AREA,
253 KMEMLEAK_NO_SCAN
254};
255
256/*
257 * Structure holding the information passed to kmemleak callbacks during the
258 * early logging.
259 */
260struct early_log {
261 int op_type; /* kmemleak operation type */
262 const void *ptr; /* allocated/freed memory block */
263 size_t size; /* memory block size */
264 int min_count; /* minimum reference count */
fd678967
CM
265 unsigned long trace[MAX_TRACE]; /* stack trace */
266 unsigned int trace_len; /* stack trace length */
3c7b4e6b
CM
267};
268
269/* early logging buffer and current position */
a6186d89
CM
270static struct early_log
271 early_log[CONFIG_DEBUG_KMEMLEAK_EARLY_LOG_SIZE] __initdata;
272static int crt_early_log __initdata;
3c7b4e6b
CM
273
274static void kmemleak_disable(void);
275
276/*
277 * Print a warning and dump the stack trace.
278 */
5f79020c
CM
279#define kmemleak_warn(x...) do { \
280 pr_warning(x); \
281 dump_stack(); \
8910ae89 282 kmemleak_warning = 1; \
3c7b4e6b
CM
283} while (0)
284
285/*
25985edc 286 * Macro invoked when a serious kmemleak condition occurred and cannot be
2030117d 287 * recovered from. Kmemleak will be disabled and further allocation/freeing
3c7b4e6b
CM
288 * tracing no longer available.
289 */
000814f4 290#define kmemleak_stop(x...) do { \
3c7b4e6b
CM
291 kmemleak_warn(x); \
292 kmemleak_disable(); \
293} while (0)
294
0494e082
SS
295/*
296 * Printing of the objects hex dump to the seq file. The number of lines to be
297 * printed is limited to HEX_MAX_LINES to prevent seq file spamming. The
298 * actual number of printed bytes depends on HEX_ROW_SIZE. It must be called
299 * with the object->lock held.
300 */
301static void hex_dump_object(struct seq_file *seq,
302 struct kmemleak_object *object)
303{
304 const u8 *ptr = (const u8 *)object->pointer;
305 int i, len, remaining;
306 unsigned char linebuf[HEX_ROW_SIZE * 5];
307
308 /* limit the number of lines to HEX_MAX_LINES */
309 remaining = len =
310 min(object->size, (size_t)(HEX_MAX_LINES * HEX_ROW_SIZE));
311
312 seq_printf(seq, " hex dump (first %d bytes):\n", len);
313 for (i = 0; i < len; i += HEX_ROW_SIZE) {
314 int linelen = min(remaining, HEX_ROW_SIZE);
315
316 remaining -= HEX_ROW_SIZE;
317 hex_dump_to_buffer(ptr + i, linelen, HEX_ROW_SIZE,
318 HEX_GROUP_SIZE, linebuf, sizeof(linebuf),
319 HEX_ASCII);
320 seq_printf(seq, " %s\n", linebuf);
321 }
322}
323
3c7b4e6b
CM
324/*
325 * Object colors, encoded with count and min_count:
326 * - white - orphan object, not enough references to it (count < min_count)
327 * - gray - not orphan, not marked as false positive (min_count == 0) or
328 * sufficient references to it (count >= min_count)
329 * - black - ignore, it doesn't contain references (e.g. text section)
330 * (min_count == -1). No function defined for this color.
331 * Newly created objects don't have any color assigned (object->count == -1)
332 * before the next memory scan when they become white.
333 */
4a558dd6 334static bool color_white(const struct kmemleak_object *object)
3c7b4e6b 335{
a1084c87
LR
336 return object->count != KMEMLEAK_BLACK &&
337 object->count < object->min_count;
3c7b4e6b
CM
338}
339
4a558dd6 340static bool color_gray(const struct kmemleak_object *object)
3c7b4e6b 341{
a1084c87
LR
342 return object->min_count != KMEMLEAK_BLACK &&
343 object->count >= object->min_count;
3c7b4e6b
CM
344}
345
3c7b4e6b
CM
346/*
347 * Objects are considered unreferenced only if their color is white, they have
348 * not be deleted and have a minimum age to avoid false positives caused by
349 * pointers temporarily stored in CPU registers.
350 */
4a558dd6 351static bool unreferenced_object(struct kmemleak_object *object)
3c7b4e6b 352{
04609ccc 353 return (color_white(object) && object->flags & OBJECT_ALLOCATED) &&
acf4968e
CM
354 time_before_eq(object->jiffies + jiffies_min_age,
355 jiffies_last_scan);
3c7b4e6b
CM
356}
357
358/*
bab4a34a
CM
359 * Printing of the unreferenced objects information to the seq file. The
360 * print_unreferenced function must be called with the object->lock held.
3c7b4e6b 361 */
3c7b4e6b
CM
362static void print_unreferenced(struct seq_file *seq,
363 struct kmemleak_object *object)
364{
365 int i;
fefdd336 366 unsigned int msecs_age = jiffies_to_msecs(jiffies - object->jiffies);
3c7b4e6b 367
bab4a34a
CM
368 seq_printf(seq, "unreferenced object 0x%08lx (size %zu):\n",
369 object->pointer, object->size);
fefdd336
CM
370 seq_printf(seq, " comm \"%s\", pid %d, jiffies %lu (age %d.%03ds)\n",
371 object->comm, object->pid, object->jiffies,
372 msecs_age / 1000, msecs_age % 1000);
0494e082 373 hex_dump_object(seq, object);
bab4a34a 374 seq_printf(seq, " backtrace:\n");
3c7b4e6b
CM
375
376 for (i = 0; i < object->trace_len; i++) {
377 void *ptr = (void *)object->trace[i];
bab4a34a 378 seq_printf(seq, " [<%p>] %pS\n", ptr, ptr);
3c7b4e6b
CM
379 }
380}
381
382/*
383 * Print the kmemleak_object information. This function is used mainly for
384 * debugging special cases when kmemleak operations. It must be called with
385 * the object->lock held.
386 */
387static void dump_object_info(struct kmemleak_object *object)
388{
389 struct stack_trace trace;
390
391 trace.nr_entries = object->trace_len;
392 trace.entries = object->trace;
393
ae281064 394 pr_notice("Object 0x%08lx (size %zu):\n",
85d3a316 395 object->pointer, object->size);
3c7b4e6b
CM
396 pr_notice(" comm \"%s\", pid %d, jiffies %lu\n",
397 object->comm, object->pid, object->jiffies);
398 pr_notice(" min_count = %d\n", object->min_count);
399 pr_notice(" count = %d\n", object->count);
189d84ed 400 pr_notice(" flags = 0x%lx\n", object->flags);
aae0ad7a 401 pr_notice(" checksum = %u\n", object->checksum);
3c7b4e6b
CM
402 pr_notice(" backtrace:\n");
403 print_stack_trace(&trace, 4);
404}
405
406/*
85d3a316 407 * Look-up a memory block metadata (kmemleak_object) in the object search
3c7b4e6b
CM
408 * tree based on a pointer value. If alias is 0, only values pointing to the
409 * beginning of the memory block are allowed. The kmemleak_lock must be held
410 * when calling this function.
411 */
412static struct kmemleak_object *lookup_object(unsigned long ptr, int alias)
413{
85d3a316
ML
414 struct rb_node *rb = object_tree_root.rb_node;
415
416 while (rb) {
417 struct kmemleak_object *object =
418 rb_entry(rb, struct kmemleak_object, rb_node);
419 if (ptr < object->pointer)
420 rb = object->rb_node.rb_left;
421 else if (object->pointer + object->size <= ptr)
422 rb = object->rb_node.rb_right;
423 else if (object->pointer == ptr || alias)
424 return object;
425 else {
5f79020c
CM
426 kmemleak_warn("Found object by alias at 0x%08lx\n",
427 ptr);
a7686a45 428 dump_object_info(object);
85d3a316 429 break;
3c7b4e6b 430 }
85d3a316
ML
431 }
432 return NULL;
3c7b4e6b
CM
433}
434
435/*
436 * Increment the object use_count. Return 1 if successful or 0 otherwise. Note
437 * that once an object's use_count reached 0, the RCU freeing was already
438 * registered and the object should no longer be used. This function must be
439 * called under the protection of rcu_read_lock().
440 */
441static int get_object(struct kmemleak_object *object)
442{
443 return atomic_inc_not_zero(&object->use_count);
444}
445
446/*
447 * RCU callback to free a kmemleak_object.
448 */
449static void free_object_rcu(struct rcu_head *rcu)
450{
b67bfe0d 451 struct hlist_node *tmp;
3c7b4e6b
CM
452 struct kmemleak_scan_area *area;
453 struct kmemleak_object *object =
454 container_of(rcu, struct kmemleak_object, rcu);
455
456 /*
457 * Once use_count is 0 (guaranteed by put_object), there is no other
458 * code accessing this object, hence no need for locking.
459 */
b67bfe0d
SL
460 hlist_for_each_entry_safe(area, tmp, &object->area_list, node) {
461 hlist_del(&area->node);
3c7b4e6b
CM
462 kmem_cache_free(scan_area_cache, area);
463 }
464 kmem_cache_free(object_cache, object);
465}
466
467/*
468 * Decrement the object use_count. Once the count is 0, free the object using
469 * an RCU callback. Since put_object() may be called via the kmemleak_free() ->
470 * delete_object() path, the delayed RCU freeing ensures that there is no
471 * recursive call to the kernel allocator. Lock-less RCU object_list traversal
472 * is also possible.
473 */
474static void put_object(struct kmemleak_object *object)
475{
476 if (!atomic_dec_and_test(&object->use_count))
477 return;
478
479 /* should only get here after delete_object was called */
480 WARN_ON(object->flags & OBJECT_ALLOCATED);
481
482 call_rcu(&object->rcu, free_object_rcu);
483}
484
485/*
85d3a316 486 * Look up an object in the object search tree and increase its use_count.
3c7b4e6b
CM
487 */
488static struct kmemleak_object *find_and_get_object(unsigned long ptr, int alias)
489{
490 unsigned long flags;
491 struct kmemleak_object *object = NULL;
492
493 rcu_read_lock();
494 read_lock_irqsave(&kmemleak_lock, flags);
93ada579 495 object = lookup_object(ptr, alias);
3c7b4e6b
CM
496 read_unlock_irqrestore(&kmemleak_lock, flags);
497
498 /* check whether the object is still available */
499 if (object && !get_object(object))
500 object = NULL;
501 rcu_read_unlock();
502
503 return object;
504}
505
e781a9ab
CM
506/*
507 * Look up an object in the object search tree and remove it from both
508 * object_tree_root and object_list. The returned object's use_count should be
509 * at least 1, as initially set by create_object().
510 */
511static struct kmemleak_object *find_and_remove_object(unsigned long ptr, int alias)
512{
513 unsigned long flags;
514 struct kmemleak_object *object;
515
516 write_lock_irqsave(&kmemleak_lock, flags);
517 object = lookup_object(ptr, alias);
518 if (object) {
519 rb_erase(&object->rb_node, &object_tree_root);
520 list_del_rcu(&object->object_list);
521 }
522 write_unlock_irqrestore(&kmemleak_lock, flags);
523
524 return object;
525}
526
fd678967
CM
527/*
528 * Save stack trace to the given array of MAX_TRACE size.
529 */
530static int __save_stack_trace(unsigned long *trace)
531{
532 struct stack_trace stack_trace;
533
534 stack_trace.max_entries = MAX_TRACE;
535 stack_trace.nr_entries = 0;
536 stack_trace.entries = trace;
537 stack_trace.skip = 2;
538 save_stack_trace(&stack_trace);
539
540 return stack_trace.nr_entries;
541}
542
3c7b4e6b
CM
543/*
544 * Create the metadata (struct kmemleak_object) corresponding to an allocated
545 * memory block and add it to the object_list and object_tree_root.
546 */
fd678967
CM
547static struct kmemleak_object *create_object(unsigned long ptr, size_t size,
548 int min_count, gfp_t gfp)
3c7b4e6b
CM
549{
550 unsigned long flags;
85d3a316
ML
551 struct kmemleak_object *object, *parent;
552 struct rb_node **link, *rb_parent;
3c7b4e6b 553
6ae4bd1f 554 object = kmem_cache_alloc(object_cache, gfp_kmemleak_mask(gfp));
3c7b4e6b 555 if (!object) {
6ae4bd1f
CM
556 pr_warning("Cannot allocate a kmemleak_object structure\n");
557 kmemleak_disable();
fd678967 558 return NULL;
3c7b4e6b
CM
559 }
560
561 INIT_LIST_HEAD(&object->object_list);
562 INIT_LIST_HEAD(&object->gray_list);
563 INIT_HLIST_HEAD(&object->area_list);
564 spin_lock_init(&object->lock);
565 atomic_set(&object->use_count, 1);
04609ccc 566 object->flags = OBJECT_ALLOCATED;
3c7b4e6b
CM
567 object->pointer = ptr;
568 object->size = size;
569 object->min_count = min_count;
04609ccc 570 object->count = 0; /* white color initially */
3c7b4e6b 571 object->jiffies = jiffies;
04609ccc 572 object->checksum = 0;
3c7b4e6b
CM
573
574 /* task information */
575 if (in_irq()) {
576 object->pid = 0;
577 strncpy(object->comm, "hardirq", sizeof(object->comm));
578 } else if (in_softirq()) {
579 object->pid = 0;
580 strncpy(object->comm, "softirq", sizeof(object->comm));
581 } else {
582 object->pid = current->pid;
583 /*
584 * There is a small chance of a race with set_task_comm(),
585 * however using get_task_comm() here may cause locking
586 * dependency issues with current->alloc_lock. In the worst
587 * case, the command line is not correct.
588 */
589 strncpy(object->comm, current->comm, sizeof(object->comm));
590 }
591
592 /* kernel backtrace */
fd678967 593 object->trace_len = __save_stack_trace(object->trace);
3c7b4e6b 594
3c7b4e6b 595 write_lock_irqsave(&kmemleak_lock, flags);
0580a181 596
3c7b4e6b
CM
597 min_addr = min(min_addr, ptr);
598 max_addr = max(max_addr, ptr + size);
85d3a316
ML
599 link = &object_tree_root.rb_node;
600 rb_parent = NULL;
601 while (*link) {
602 rb_parent = *link;
603 parent = rb_entry(rb_parent, struct kmemleak_object, rb_node);
604 if (ptr + size <= parent->pointer)
605 link = &parent->rb_node.rb_left;
606 else if (parent->pointer + parent->size <= ptr)
607 link = &parent->rb_node.rb_right;
608 else {
609 kmemleak_stop("Cannot insert 0x%lx into the object "
610 "search tree (overlaps existing)\n",
611 ptr);
9d5a4c73
CM
612 /*
613 * No need for parent->lock here since "parent" cannot
614 * be freed while the kmemleak_lock is held.
615 */
616 dump_object_info(parent);
85d3a316 617 kmem_cache_free(object_cache, object);
9d5a4c73 618 object = NULL;
85d3a316
ML
619 goto out;
620 }
3c7b4e6b 621 }
85d3a316
ML
622 rb_link_node(&object->rb_node, rb_parent, link);
623 rb_insert_color(&object->rb_node, &object_tree_root);
624
3c7b4e6b
CM
625 list_add_tail_rcu(&object->object_list, &object_list);
626out:
627 write_unlock_irqrestore(&kmemleak_lock, flags);
fd678967 628 return object;
3c7b4e6b
CM
629}
630
631/*
e781a9ab 632 * Mark the object as not allocated and schedule RCU freeing via put_object().
3c7b4e6b 633 */
53238a60 634static void __delete_object(struct kmemleak_object *object)
3c7b4e6b
CM
635{
636 unsigned long flags;
3c7b4e6b 637
3c7b4e6b 638 WARN_ON(!(object->flags & OBJECT_ALLOCATED));
e781a9ab 639 WARN_ON(atomic_read(&object->use_count) < 1);
3c7b4e6b
CM
640
641 /*
642 * Locking here also ensures that the corresponding memory block
643 * cannot be freed when it is being scanned.
644 */
645 spin_lock_irqsave(&object->lock, flags);
3c7b4e6b
CM
646 object->flags &= ~OBJECT_ALLOCATED;
647 spin_unlock_irqrestore(&object->lock, flags);
648 put_object(object);
649}
650
53238a60
CM
651/*
652 * Look up the metadata (struct kmemleak_object) corresponding to ptr and
653 * delete it.
654 */
655static void delete_object_full(unsigned long ptr)
656{
657 struct kmemleak_object *object;
658
e781a9ab 659 object = find_and_remove_object(ptr, 0);
53238a60
CM
660 if (!object) {
661#ifdef DEBUG
662 kmemleak_warn("Freeing unknown object at 0x%08lx\n",
663 ptr);
664#endif
665 return;
666 }
667 __delete_object(object);
53238a60
CM
668}
669
670/*
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.
674 */
675static void delete_object_part(unsigned long ptr, size_t size)
676{
677 struct kmemleak_object *object;
678 unsigned long start, end;
679
e781a9ab 680 object = find_and_remove_object(ptr, 1);
53238a60
CM
681 if (!object) {
682#ifdef DEBUG
683 kmemleak_warn("Partially freeing unknown object at 0x%08lx "
684 "(size %zu)\n", ptr, size);
685#endif
686 return;
687 }
53238a60
CM
688
689 /*
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.
695 */
696 start = object->pointer;
697 end = object->pointer + object->size;
698 if (ptr > start)
699 create_object(start, ptr - start, object->min_count,
700 GFP_KERNEL);
701 if (ptr + size < end)
702 create_object(ptr + size, end - ptr - size, object->min_count,
703 GFP_KERNEL);
704
e781a9ab 705 __delete_object(object);
53238a60 706}
a1084c87
LR
707
708static void __paint_it(struct kmemleak_object *object, int color)
709{
710 object->min_count = color;
711 if (color == KMEMLEAK_BLACK)
712 object->flags |= OBJECT_NO_SCAN;
713}
714
715static void paint_it(struct kmemleak_object *object, int color)
3c7b4e6b
CM
716{
717 unsigned long flags;
a1084c87
LR
718
719 spin_lock_irqsave(&object->lock, flags);
720 __paint_it(object, color);
721 spin_unlock_irqrestore(&object->lock, flags);
722}
723
724static void paint_ptr(unsigned long ptr, int color)
725{
3c7b4e6b
CM
726 struct kmemleak_object *object;
727
728 object = find_and_get_object(ptr, 0);
729 if (!object) {
a1084c87
LR
730 kmemleak_warn("Trying to color unknown object "
731 "at 0x%08lx as %s\n", ptr,
732 (color == KMEMLEAK_GREY) ? "Grey" :
733 (color == KMEMLEAK_BLACK) ? "Black" : "Unknown");
3c7b4e6b
CM
734 return;
735 }
a1084c87 736 paint_it(object, color);
3c7b4e6b
CM
737 put_object(object);
738}
739
a1084c87 740/*
145b64b9 741 * Mark an object permanently as gray-colored so that it can no longer be
a1084c87
LR
742 * reported as a leak. This is used in general to mark a false positive.
743 */
744static void make_gray_object(unsigned long ptr)
745{
746 paint_ptr(ptr, KMEMLEAK_GREY);
747}
748
3c7b4e6b
CM
749/*
750 * Mark the object as black-colored so that it is ignored from scans and
751 * reporting.
752 */
753static void make_black_object(unsigned long ptr)
754{
a1084c87 755 paint_ptr(ptr, KMEMLEAK_BLACK);
3c7b4e6b
CM
756}
757
758/*
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.
761 */
c017b4be 762static void add_scan_area(unsigned long ptr, size_t size, gfp_t gfp)
3c7b4e6b
CM
763{
764 unsigned long flags;
765 struct kmemleak_object *object;
766 struct kmemleak_scan_area *area;
767
c017b4be 768 object = find_and_get_object(ptr, 1);
3c7b4e6b 769 if (!object) {
ae281064
JP
770 kmemleak_warn("Adding scan area to unknown object at 0x%08lx\n",
771 ptr);
3c7b4e6b
CM
772 return;
773 }
774
6ae4bd1f 775 area = kmem_cache_alloc(scan_area_cache, gfp_kmemleak_mask(gfp));
3c7b4e6b 776 if (!area) {
6ae4bd1f 777 pr_warning("Cannot allocate a scan area\n");
3c7b4e6b
CM
778 goto out;
779 }
780
781 spin_lock_irqsave(&object->lock, flags);
7f88f88f
CM
782 if (size == SIZE_MAX) {
783 size = object->pointer + object->size - ptr;
784 } else if (ptr + size > object->pointer + object->size) {
ae281064 785 kmemleak_warn("Scan area larger than object 0x%08lx\n", ptr);
3c7b4e6b
CM
786 dump_object_info(object);
787 kmem_cache_free(scan_area_cache, area);
788 goto out_unlock;
789 }
790
791 INIT_HLIST_NODE(&area->node);
c017b4be
CM
792 area->start = ptr;
793 area->size = size;
3c7b4e6b
CM
794
795 hlist_add_head(&area->node, &object->area_list);
796out_unlock:
797 spin_unlock_irqrestore(&object->lock, flags);
798out:
799 put_object(object);
800}
801
802/*
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
805 * are searched.
806 */
807static void object_no_scan(unsigned long ptr)
808{
809 unsigned long flags;
810 struct kmemleak_object *object;
811
812 object = find_and_get_object(ptr, 0);
813 if (!object) {
ae281064 814 kmemleak_warn("Not scanning unknown object at 0x%08lx\n", ptr);
3c7b4e6b
CM
815 return;
816 }
817
818 spin_lock_irqsave(&object->lock, flags);
819 object->flags |= OBJECT_NO_SCAN;
820 spin_unlock_irqrestore(&object->lock, flags);
821 put_object(object);
822}
823
824/*
825 * Log an early kmemleak_* call to the early_log buffer. These calls will be
826 * processed later once kmemleak is fully initialized.
827 */
a6186d89 828static void __init log_early(int op_type, const void *ptr, size_t size,
c017b4be 829 int min_count)
3c7b4e6b
CM
830{
831 unsigned long flags;
832 struct early_log *log;
833
8910ae89 834 if (kmemleak_error) {
b6693005
CM
835 /* kmemleak stopped recording, just count the requests */
836 crt_early_log++;
837 return;
838 }
839
3c7b4e6b 840 if (crt_early_log >= ARRAY_SIZE(early_log)) {
21cd3a60 841 crt_early_log++;
a9d9058a 842 kmemleak_disable();
3c7b4e6b
CM
843 return;
844 }
845
846 /*
847 * There is no need for locking since the kernel is still in UP mode
848 * at this stage. Disabling the IRQs is enough.
849 */
850 local_irq_save(flags);
851 log = &early_log[crt_early_log];
852 log->op_type = op_type;
853 log->ptr = ptr;
854 log->size = size;
855 log->min_count = min_count;
5f79020c 856 log->trace_len = __save_stack_trace(log->trace);
3c7b4e6b
CM
857 crt_early_log++;
858 local_irq_restore(flags);
859}
860
fd678967
CM
861/*
862 * Log an early allocated block and populate the stack trace.
863 */
864static void early_alloc(struct early_log *log)
865{
866 struct kmemleak_object *object;
867 unsigned long flags;
868 int i;
869
8910ae89 870 if (!kmemleak_enabled || !log->ptr || IS_ERR(log->ptr))
fd678967
CM
871 return;
872
873 /*
874 * RCU locking needed to ensure object is not freed via put_object().
875 */
876 rcu_read_lock();
877 object = create_object((unsigned long)log->ptr, log->size,
c1bcd6b3 878 log->min_count, GFP_ATOMIC);
0d5d1aad
CM
879 if (!object)
880 goto out;
fd678967
CM
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);
0d5d1aad 886out:
fd678967
CM
887 rcu_read_unlock();
888}
889
f528f0b8
CM
890/*
891 * Log an early allocated block and populate the stack trace.
892 */
893static void early_alloc_percpu(struct early_log *log)
894{
895 unsigned int cpu;
896 const void __percpu *ptr = log->ptr;
897
898 for_each_possible_cpu(cpu) {
899 log->ptr = per_cpu_ptr(ptr, cpu);
900 early_alloc(log);
901 }
902}
903
a2b6bf63
CM
904/**
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
914 *
915 * This function is called from the kernel allocators when a new object
916 * (memory block) is allocated (kmem_cache_alloc, kmalloc, vmalloc etc.).
3c7b4e6b 917 */
a6186d89
CM
918void __ref kmemleak_alloc(const void *ptr, size_t size, int min_count,
919 gfp_t gfp)
3c7b4e6b
CM
920{
921 pr_debug("%s(0x%p, %zu, %d)\n", __func__, ptr, size, min_count);
922
8910ae89 923 if (kmemleak_enabled && ptr && !IS_ERR(ptr))
3c7b4e6b 924 create_object((unsigned long)ptr, size, min_count, gfp);
8910ae89 925 else if (kmemleak_early_log)
c017b4be 926 log_early(KMEMLEAK_ALLOC, ptr, size, min_count);
3c7b4e6b
CM
927}
928EXPORT_SYMBOL_GPL(kmemleak_alloc);
929
f528f0b8
CM
930/**
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
8a8c35fa 934 * @gfp: flags used for kmemleak internal memory allocations
f528f0b8
CM
935 *
936 * This function is called from the kernel percpu allocator when a new object
8a8c35fa 937 * (memory block) is allocated (alloc_percpu).
f528f0b8 938 */
8a8c35fa
LF
939void __ref kmemleak_alloc_percpu(const void __percpu *ptr, size_t size,
940 gfp_t gfp)
f528f0b8
CM
941{
942 unsigned int cpu;
943
944 pr_debug("%s(0x%p, %zu)\n", __func__, ptr, size);
945
946 /*
947 * Percpu allocations are only scanned and not reported as leaks
948 * (min_count is set to 0).
949 */
8910ae89 950 if (kmemleak_enabled && ptr && !IS_ERR(ptr))
f528f0b8
CM
951 for_each_possible_cpu(cpu)
952 create_object((unsigned long)per_cpu_ptr(ptr, cpu),
8a8c35fa 953 size, 0, gfp);
8910ae89 954 else if (kmemleak_early_log)
f528f0b8
CM
955 log_early(KMEMLEAK_ALLOC_PERCPU, ptr, size, 0);
956}
957EXPORT_SYMBOL_GPL(kmemleak_alloc_percpu);
958
a2b6bf63
CM
959/**
960 * kmemleak_free - unregister a previously registered object
961 * @ptr: pointer to beginning of the object
962 *
963 * This function is called from the kernel allocators when an object (memory
964 * block) is freed (kmem_cache_free, kfree, vfree etc.).
3c7b4e6b 965 */
a6186d89 966void __ref kmemleak_free(const void *ptr)
3c7b4e6b
CM
967{
968 pr_debug("%s(0x%p)\n", __func__, ptr);
969
c5f3b1a5 970 if (kmemleak_free_enabled && ptr && !IS_ERR(ptr))
53238a60 971 delete_object_full((unsigned long)ptr);
8910ae89 972 else if (kmemleak_early_log)
c017b4be 973 log_early(KMEMLEAK_FREE, ptr, 0, 0);
3c7b4e6b
CM
974}
975EXPORT_SYMBOL_GPL(kmemleak_free);
976
a2b6bf63
CM
977/**
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
982 *
983 * This function is called when only a part of a memory block is freed
984 * (usually from the bootmem allocator).
53238a60 985 */
a6186d89 986void __ref kmemleak_free_part(const void *ptr, size_t size)
53238a60
CM
987{
988 pr_debug("%s(0x%p)\n", __func__, ptr);
989
8910ae89 990 if (kmemleak_enabled && ptr && !IS_ERR(ptr))
53238a60 991 delete_object_part((unsigned long)ptr, size);
8910ae89 992 else if (kmemleak_early_log)
c017b4be 993 log_early(KMEMLEAK_FREE_PART, ptr, size, 0);
53238a60
CM
994}
995EXPORT_SYMBOL_GPL(kmemleak_free_part);
996
f528f0b8
CM
997/**
998 * kmemleak_free_percpu - unregister a previously registered __percpu object
999 * @ptr: __percpu pointer to beginning of the object
1000 *
1001 * This function is called from the kernel percpu allocator when an object
1002 * (memory block) is freed (free_percpu).
1003 */
1004void __ref kmemleak_free_percpu(const void __percpu *ptr)
1005{
1006 unsigned int cpu;
1007
1008 pr_debug("%s(0x%p)\n", __func__, ptr);
1009
c5f3b1a5 1010 if (kmemleak_free_enabled && ptr && !IS_ERR(ptr))
f528f0b8
CM
1011 for_each_possible_cpu(cpu)
1012 delete_object_full((unsigned long)per_cpu_ptr(ptr,
1013 cpu));
8910ae89 1014 else if (kmemleak_early_log)
f528f0b8
CM
1015 log_early(KMEMLEAK_FREE_PERCPU, ptr, 0, 0);
1016}
1017EXPORT_SYMBOL_GPL(kmemleak_free_percpu);
1018
ffe2c748
CM
1019/**
1020 * kmemleak_update_trace - update object allocation stack trace
1021 * @ptr: pointer to beginning of the object
1022 *
1023 * Override the object allocation stack trace for cases where the actual
1024 * allocation place is not always useful.
1025 */
1026void __ref kmemleak_update_trace(const void *ptr)
1027{
1028 struct kmemleak_object *object;
1029 unsigned long flags;
1030
1031 pr_debug("%s(0x%p)\n", __func__, ptr);
1032
1033 if (!kmemleak_enabled || IS_ERR_OR_NULL(ptr))
1034 return;
1035
1036 object = find_and_get_object((unsigned long)ptr, 1);
1037 if (!object) {
1038#ifdef DEBUG
1039 kmemleak_warn("Updating stack trace for unknown object at %p\n",
1040 ptr);
1041#endif
1042 return;
1043 }
1044
1045 spin_lock_irqsave(&object->lock, flags);
1046 object->trace_len = __save_stack_trace(object->trace);
1047 spin_unlock_irqrestore(&object->lock, flags);
1048
1049 put_object(object);
1050}
1051EXPORT_SYMBOL(kmemleak_update_trace);
1052
a2b6bf63
CM
1053/**
1054 * kmemleak_not_leak - mark an allocated object as false positive
1055 * @ptr: pointer to beginning of the object
1056 *
1057 * Calling this function on an object will cause the memory block to no longer
1058 * be reported as leak and always be scanned.
3c7b4e6b 1059 */
a6186d89 1060void __ref kmemleak_not_leak(const void *ptr)
3c7b4e6b
CM
1061{
1062 pr_debug("%s(0x%p)\n", __func__, ptr);
1063
8910ae89 1064 if (kmemleak_enabled && ptr && !IS_ERR(ptr))
3c7b4e6b 1065 make_gray_object((unsigned long)ptr);
8910ae89 1066 else if (kmemleak_early_log)
c017b4be 1067 log_early(KMEMLEAK_NOT_LEAK, ptr, 0, 0);
3c7b4e6b
CM
1068}
1069EXPORT_SYMBOL(kmemleak_not_leak);
1070
a2b6bf63
CM
1071/**
1072 * kmemleak_ignore - ignore an allocated object
1073 * @ptr: pointer to beginning of the object
1074 *
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.
3c7b4e6b 1079 */
a6186d89 1080void __ref kmemleak_ignore(const void *ptr)
3c7b4e6b
CM
1081{
1082 pr_debug("%s(0x%p)\n", __func__, ptr);
1083
8910ae89 1084 if (kmemleak_enabled && ptr && !IS_ERR(ptr))
3c7b4e6b 1085 make_black_object((unsigned long)ptr);
8910ae89 1086 else if (kmemleak_early_log)
c017b4be 1087 log_early(KMEMLEAK_IGNORE, ptr, 0, 0);
3c7b4e6b
CM
1088}
1089EXPORT_SYMBOL(kmemleak_ignore);
1090
a2b6bf63
CM
1091/**
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
1097 *
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.
3c7b4e6b 1101 */
c017b4be 1102void __ref kmemleak_scan_area(const void *ptr, size_t size, gfp_t gfp)
3c7b4e6b
CM
1103{
1104 pr_debug("%s(0x%p)\n", __func__, ptr);
1105
8910ae89 1106 if (kmemleak_enabled && ptr && size && !IS_ERR(ptr))
c017b4be 1107 add_scan_area((unsigned long)ptr, size, gfp);
8910ae89 1108 else if (kmemleak_early_log)
c017b4be 1109 log_early(KMEMLEAK_SCAN_AREA, ptr, size, 0);
3c7b4e6b
CM
1110}
1111EXPORT_SYMBOL(kmemleak_scan_area);
1112
a2b6bf63
CM
1113/**
1114 * kmemleak_no_scan - do not scan an allocated object
1115 * @ptr: pointer to beginning of the object
1116 *
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.
3c7b4e6b 1121 */
a6186d89 1122void __ref kmemleak_no_scan(const void *ptr)
3c7b4e6b
CM
1123{
1124 pr_debug("%s(0x%p)\n", __func__, ptr);
1125
8910ae89 1126 if (kmemleak_enabled && ptr && !IS_ERR(ptr))
3c7b4e6b 1127 object_no_scan((unsigned long)ptr);
8910ae89 1128 else if (kmemleak_early_log)
c017b4be 1129 log_early(KMEMLEAK_NO_SCAN, ptr, 0, 0);
3c7b4e6b
CM
1130}
1131EXPORT_SYMBOL(kmemleak_no_scan);
1132
04609ccc
CM
1133/*
1134 * Update an object's checksum and return true if it was modified.
1135 */
1136static bool update_checksum(struct kmemleak_object *object)
1137{
1138 u32 old_csum = object->checksum;
1139
1140 if (!kmemcheck_is_obj_initialized(object->pointer, object->size))
1141 return false;
1142
e79ed2f1 1143 kasan_disable_current();
04609ccc 1144 object->checksum = crc32(0, (void *)object->pointer, object->size);
e79ed2f1
AR
1145 kasan_enable_current();
1146
04609ccc
CM
1147 return object->checksum != old_csum;
1148}
1149
3c7b4e6b
CM
1150/*
1151 * Memory scanning is a long process and it needs to be interruptable. This
25985edc 1152 * function checks whether such interrupt condition occurred.
3c7b4e6b
CM
1153 */
1154static int scan_should_stop(void)
1155{
8910ae89 1156 if (!kmemleak_enabled)
3c7b4e6b
CM
1157 return 1;
1158
1159 /*
1160 * This function may be called from either process or kthread context,
1161 * hence the need to check for both stop conditions.
1162 */
1163 if (current->mm)
1164 return signal_pending(current);
1165 else
1166 return kthread_should_stop();
1167
1168 return 0;
1169}
1170
1171/*
1172 * Scan a memory block (exclusive range) for valid pointers and add those
1173 * found to the gray list.
1174 */
1175static void scan_block(void *_start, void *_end,
93ada579 1176 struct kmemleak_object *scanned)
3c7b4e6b
CM
1177{
1178 unsigned long *ptr;
1179 unsigned long *start = PTR_ALIGN(_start, BYTES_PER_POINTER);
1180 unsigned long *end = _end - (BYTES_PER_POINTER - 1);
93ada579 1181 unsigned long flags;
3c7b4e6b 1182
93ada579 1183 read_lock_irqsave(&kmemleak_lock, flags);
3c7b4e6b 1184 for (ptr = start; ptr < end; ptr++) {
3c7b4e6b 1185 struct kmemleak_object *object;
8e019366 1186 unsigned long pointer;
3c7b4e6b
CM
1187
1188 if (scan_should_stop())
1189 break;
1190
8e019366
PE
1191 /* don't scan uninitialized memory */
1192 if (!kmemcheck_is_obj_initialized((unsigned long)ptr,
1193 BYTES_PER_POINTER))
1194 continue;
1195
e79ed2f1 1196 kasan_disable_current();
8e019366 1197 pointer = *ptr;
e79ed2f1 1198 kasan_enable_current();
8e019366 1199
93ada579
CM
1200 if (pointer < min_addr || pointer >= max_addr)
1201 continue;
1202
1203 /*
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).
1208 */
1209 object = lookup_object(pointer, 1);
3c7b4e6b
CM
1210 if (!object)
1211 continue;
93ada579 1212 if (object == scanned)
3c7b4e6b 1213 /* self referenced, ignore */
3c7b4e6b 1214 continue;
3c7b4e6b
CM
1215
1216 /*
1217 * Avoid the lockdep recursive warning on object->lock being
1218 * previously acquired in scan_object(). These locks are
1219 * enclosed by scan_mutex.
1220 */
93ada579 1221 spin_lock_nested(&object->lock, SINGLE_DEPTH_NESTING);
3c7b4e6b
CM
1222 if (!color_white(object)) {
1223 /* non-orphan, ignored or new */
93ada579 1224 spin_unlock(&object->lock);
3c7b4e6b
CM
1225 continue;
1226 }
1227
1228 /*
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.
1233 */
1234 object->count++;
0587da40 1235 if (color_gray(object)) {
93ada579
CM
1236 /* put_object() called when removing from gray_list */
1237 WARN_ON(!get_object(object));
3c7b4e6b 1238 list_add_tail(&object->gray_list, &gray_list);
0587da40 1239 }
93ada579
CM
1240 spin_unlock(&object->lock);
1241 }
1242 read_unlock_irqrestore(&kmemleak_lock, flags);
1243}
0587da40 1244
93ada579
CM
1245/*
1246 * Scan a large memory block in MAX_SCAN_SIZE chunks to reduce the latency.
1247 */
1248static void scan_large_block(void *start, void *end)
1249{
1250 void *next;
1251
1252 while (start < end) {
1253 next = min(start + MAX_SCAN_SIZE, end);
1254 scan_block(start, next, NULL);
1255 start = next;
1256 cond_resched();
3c7b4e6b
CM
1257 }
1258}
1259
1260/*
1261 * Scan a memory block corresponding to a kmemleak_object. A condition is
1262 * that object->use_count >= 1.
1263 */
1264static void scan_object(struct kmemleak_object *object)
1265{
1266 struct kmemleak_scan_area *area;
3c7b4e6b
CM
1267 unsigned long flags;
1268
1269 /*
21ae2956
UKK
1270 * Once the object->lock is acquired, the corresponding memory block
1271 * cannot be freed (the same lock is acquired in delete_object).
3c7b4e6b
CM
1272 */
1273 spin_lock_irqsave(&object->lock, flags);
1274 if (object->flags & OBJECT_NO_SCAN)
1275 goto out;
1276 if (!(object->flags & OBJECT_ALLOCATED))
1277 /* already freed object */
1278 goto out;
af98603d
CM
1279 if (hlist_empty(&object->area_list)) {
1280 void *start = (void *)object->pointer;
1281 void *end = (void *)(object->pointer + object->size);
93ada579
CM
1282 void *next;
1283
1284 do {
1285 next = min(start + MAX_SCAN_SIZE, end);
1286 scan_block(start, next, object);
af98603d 1287
93ada579
CM
1288 start = next;
1289 if (start >= end)
1290 break;
af98603d
CM
1291
1292 spin_unlock_irqrestore(&object->lock, flags);
1293 cond_resched();
1294 spin_lock_irqsave(&object->lock, flags);
93ada579 1295 } while (object->flags & OBJECT_ALLOCATED);
af98603d 1296 } else
b67bfe0d 1297 hlist_for_each_entry(area, &object->area_list, node)
c017b4be
CM
1298 scan_block((void *)area->start,
1299 (void *)(area->start + area->size),
93ada579 1300 object);
3c7b4e6b
CM
1301out:
1302 spin_unlock_irqrestore(&object->lock, flags);
1303}
1304
04609ccc
CM
1305/*
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.
1308 */
1309static void scan_gray_list(void)
1310{
1311 struct kmemleak_object *object, *tmp;
1312
1313 /*
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.
1317 */
1318 object = list_entry(gray_list.next, typeof(*object), gray_list);
1319 while (&object->gray_list != &gray_list) {
1320 cond_resched();
1321
1322 /* may add new objects to the list */
1323 if (!scan_should_stop())
1324 scan_object(object);
1325
1326 tmp = list_entry(object->gray_list.next, typeof(*object),
1327 gray_list);
1328
1329 /* remove the object from the list and release it */
1330 list_del(&object->gray_list);
1331 put_object(object);
1332
1333 object = tmp;
1334 }
1335 WARN_ON(!list_empty(&gray_list));
1336}
1337
3c7b4e6b
CM
1338/*
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
1341 * scan_mutex held.
1342 */
1343static void kmemleak_scan(void)
1344{
1345 unsigned long flags;
04609ccc 1346 struct kmemleak_object *object;
3c7b4e6b 1347 int i;
4698c1f2 1348 int new_leaks = 0;
3c7b4e6b 1349
acf4968e
CM
1350 jiffies_last_scan = jiffies;
1351
3c7b4e6b
CM
1352 /* prepare the kmemleak_object's */
1353 rcu_read_lock();
1354 list_for_each_entry_rcu(object, &object_list, object_list) {
1355 spin_lock_irqsave(&object->lock, flags);
1356#ifdef DEBUG
1357 /*
1358 * With a few exceptions there should be a maximum of
1359 * 1 reference to any object at this point.
1360 */
1361 if (atomic_read(&object->use_count) > 1) {
ae281064 1362 pr_debug("object->use_count = %d\n",
3c7b4e6b
CM
1363 atomic_read(&object->use_count));
1364 dump_object_info(object);
1365 }
1366#endif
1367 /* reset the reference count (whiten the object) */
1368 object->count = 0;
1369 if (color_gray(object) && get_object(object))
1370 list_add_tail(&object->gray_list, &gray_list);
1371
1372 spin_unlock_irqrestore(&object->lock, flags);
1373 }
1374 rcu_read_unlock();
1375
1376 /* data/bss scanning */
93ada579
CM
1377 scan_large_block(_sdata, _edata);
1378 scan_large_block(__bss_start, __bss_stop);
3c7b4e6b
CM
1379
1380#ifdef CONFIG_SMP
1381 /* per-cpu sections scanning */
1382 for_each_possible_cpu(i)
93ada579
CM
1383 scan_large_block(__per_cpu_start + per_cpu_offset(i),
1384 __per_cpu_end + per_cpu_offset(i));
3c7b4e6b
CM
1385#endif
1386
1387 /*
029aeff5 1388 * Struct page scanning for each node.
3c7b4e6b 1389 */
bfc8c901 1390 get_online_mems();
3c7b4e6b 1391 for_each_online_node(i) {
108bcc96
CS
1392 unsigned long start_pfn = node_start_pfn(i);
1393 unsigned long end_pfn = node_end_pfn(i);
3c7b4e6b
CM
1394 unsigned long pfn;
1395
1396 for (pfn = start_pfn; pfn < end_pfn; pfn++) {
1397 struct page *page;
1398
1399 if (!pfn_valid(pfn))
1400 continue;
1401 page = pfn_to_page(pfn);
1402 /* only scan if page is in use */
1403 if (page_count(page) == 0)
1404 continue;
93ada579 1405 scan_block(page, page + 1, NULL);
3c7b4e6b
CM
1406 }
1407 }
bfc8c901 1408 put_online_mems();
3c7b4e6b
CM
1409
1410 /*
43ed5d6e 1411 * Scanning the task stacks (may introduce false negatives).
3c7b4e6b
CM
1412 */
1413 if (kmemleak_stack_scan) {
43ed5d6e
CM
1414 struct task_struct *p, *g;
1415
3c7b4e6b 1416 read_lock(&tasklist_lock);
43ed5d6e
CM
1417 do_each_thread(g, p) {
1418 scan_block(task_stack_page(p), task_stack_page(p) +
93ada579 1419 THREAD_SIZE, NULL);
43ed5d6e 1420 } while_each_thread(g, p);
3c7b4e6b
CM
1421 read_unlock(&tasklist_lock);
1422 }
1423
1424 /*
1425 * Scan the objects already referenced from the sections scanned
04609ccc 1426 * above.
3c7b4e6b 1427 */
04609ccc 1428 scan_gray_list();
2587362e
CM
1429
1430 /*
04609ccc
CM
1431 * Check for new or unreferenced objects modified since the previous
1432 * scan and color them gray until the next scan.
2587362e
CM
1433 */
1434 rcu_read_lock();
1435 list_for_each_entry_rcu(object, &object_list, object_list) {
1436 spin_lock_irqsave(&object->lock, flags);
04609ccc
CM
1437 if (color_white(object) && (object->flags & OBJECT_ALLOCATED)
1438 && update_checksum(object) && get_object(object)) {
1439 /* color it gray temporarily */
1440 object->count = object->min_count;
2587362e
CM
1441 list_add_tail(&object->gray_list, &gray_list);
1442 }
1443 spin_unlock_irqrestore(&object->lock, flags);
1444 }
1445 rcu_read_unlock();
1446
04609ccc
CM
1447 /*
1448 * Re-scan the gray list for modified unreferenced objects.
1449 */
1450 scan_gray_list();
4698c1f2 1451
17bb9e0d 1452 /*
04609ccc 1453 * If scanning was stopped do not report any new unreferenced objects.
17bb9e0d 1454 */
04609ccc 1455 if (scan_should_stop())
17bb9e0d
CM
1456 return;
1457
4698c1f2
CM
1458 /*
1459 * Scanning result reporting.
1460 */
1461 rcu_read_lock();
1462 list_for_each_entry_rcu(object, &object_list, object_list) {
1463 spin_lock_irqsave(&object->lock, flags);
1464 if (unreferenced_object(object) &&
1465 !(object->flags & OBJECT_REPORTED)) {
1466 object->flags |= OBJECT_REPORTED;
1467 new_leaks++;
1468 }
1469 spin_unlock_irqrestore(&object->lock, flags);
1470 }
1471 rcu_read_unlock();
1472
dc9b3f42
LZ
1473 if (new_leaks) {
1474 kmemleak_found_leaks = true;
1475
4698c1f2
CM
1476 pr_info("%d new suspected memory leaks (see "
1477 "/sys/kernel/debug/kmemleak)\n", new_leaks);
dc9b3f42 1478 }
4698c1f2 1479
3c7b4e6b
CM
1480}
1481
1482/*
1483 * Thread function performing automatic memory scanning. Unreferenced objects
1484 * at the end of a memory scan are reported but only the first time.
1485 */
1486static int kmemleak_scan_thread(void *arg)
1487{
1488 static int first_run = 1;
1489
ae281064 1490 pr_info("Automatic memory scanning thread started\n");
bf2a76b3 1491 set_user_nice(current, 10);
3c7b4e6b
CM
1492
1493 /*
1494 * Wait before the first scan to allow the system to fully initialize.
1495 */
1496 if (first_run) {
1497 first_run = 0;
1498 ssleep(SECS_FIRST_SCAN);
1499 }
1500
1501 while (!kthread_should_stop()) {
3c7b4e6b
CM
1502 signed long timeout = jiffies_scan_wait;
1503
1504 mutex_lock(&scan_mutex);
3c7b4e6b 1505 kmemleak_scan();
3c7b4e6b 1506 mutex_unlock(&scan_mutex);
4698c1f2 1507
3c7b4e6b
CM
1508 /* wait before the next scan */
1509 while (timeout && !kthread_should_stop())
1510 timeout = schedule_timeout_interruptible(timeout);
1511 }
1512
ae281064 1513 pr_info("Automatic memory scanning thread ended\n");
3c7b4e6b
CM
1514
1515 return 0;
1516}
1517
1518/*
1519 * Start the automatic memory scanning thread. This function must be called
4698c1f2 1520 * with the scan_mutex held.
3c7b4e6b 1521 */
7eb0d5e5 1522static void start_scan_thread(void)
3c7b4e6b
CM
1523{
1524 if (scan_thread)
1525 return;
1526 scan_thread = kthread_run(kmemleak_scan_thread, NULL, "kmemleak");
1527 if (IS_ERR(scan_thread)) {
ae281064 1528 pr_warning("Failed to create the scan thread\n");
3c7b4e6b
CM
1529 scan_thread = NULL;
1530 }
1531}
1532
1533/*
1534 * Stop the automatic memory scanning thread. This function must be called
4698c1f2 1535 * with the scan_mutex held.
3c7b4e6b 1536 */
7eb0d5e5 1537static void stop_scan_thread(void)
3c7b4e6b
CM
1538{
1539 if (scan_thread) {
1540 kthread_stop(scan_thread);
1541 scan_thread = NULL;
1542 }
1543}
1544
1545/*
1546 * Iterate over the object_list and return the first valid object at or after
1547 * the required position with its use_count incremented. The function triggers
1548 * a memory scanning when the pos argument points to the first position.
1549 */
1550static void *kmemleak_seq_start(struct seq_file *seq, loff_t *pos)
1551{
1552 struct kmemleak_object *object;
1553 loff_t n = *pos;
b87324d0
CM
1554 int err;
1555
1556 err = mutex_lock_interruptible(&scan_mutex);
1557 if (err < 0)
1558 return ERR_PTR(err);
3c7b4e6b 1559
3c7b4e6b
CM
1560 rcu_read_lock();
1561 list_for_each_entry_rcu(object, &object_list, object_list) {
1562 if (n-- > 0)
1563 continue;
1564 if (get_object(object))
1565 goto out;
1566 }
1567 object = NULL;
1568out:
3c7b4e6b
CM
1569 return object;
1570}
1571
1572/*
1573 * Return the next object in the object_list. The function decrements the
1574 * use_count of the previous object and increases that of the next one.
1575 */
1576static void *kmemleak_seq_next(struct seq_file *seq, void *v, loff_t *pos)
1577{
1578 struct kmemleak_object *prev_obj = v;
1579 struct kmemleak_object *next_obj = NULL;
58fac095 1580 struct kmemleak_object *obj = prev_obj;
3c7b4e6b
CM
1581
1582 ++(*pos);
3c7b4e6b 1583
58fac095 1584 list_for_each_entry_continue_rcu(obj, &object_list, object_list) {
52c3ce4e
CM
1585 if (get_object(obj)) {
1586 next_obj = obj;
3c7b4e6b 1587 break;
52c3ce4e 1588 }
3c7b4e6b 1589 }
288c857d 1590
3c7b4e6b
CM
1591 put_object(prev_obj);
1592 return next_obj;
1593}
1594
1595/*
1596 * Decrement the use_count of the last object required, if any.
1597 */
1598static void kmemleak_seq_stop(struct seq_file *seq, void *v)
1599{
b87324d0
CM
1600 if (!IS_ERR(v)) {
1601 /*
1602 * kmemleak_seq_start may return ERR_PTR if the scan_mutex
1603 * waiting was interrupted, so only release it if !IS_ERR.
1604 */
f5886c7f 1605 rcu_read_unlock();
b87324d0
CM
1606 mutex_unlock(&scan_mutex);
1607 if (v)
1608 put_object(v);
1609 }
3c7b4e6b
CM
1610}
1611
1612/*
1613 * Print the information for an unreferenced object to the seq file.
1614 */
1615static int kmemleak_seq_show(struct seq_file *seq, void *v)
1616{
1617 struct kmemleak_object *object = v;
1618 unsigned long flags;
1619
1620 spin_lock_irqsave(&object->lock, flags);
288c857d 1621 if ((object->flags & OBJECT_REPORTED) && unreferenced_object(object))
17bb9e0d 1622 print_unreferenced(seq, object);
3c7b4e6b
CM
1623 spin_unlock_irqrestore(&object->lock, flags);
1624 return 0;
1625}
1626
1627static const struct seq_operations kmemleak_seq_ops = {
1628 .start = kmemleak_seq_start,
1629 .next = kmemleak_seq_next,
1630 .stop = kmemleak_seq_stop,
1631 .show = kmemleak_seq_show,
1632};
1633
1634static int kmemleak_open(struct inode *inode, struct file *file)
1635{
b87324d0 1636 return seq_open(file, &kmemleak_seq_ops);
3c7b4e6b
CM
1637}
1638
189d84ed
CM
1639static int dump_str_object_info(const char *str)
1640{
1641 unsigned long flags;
1642 struct kmemleak_object *object;
1643 unsigned long addr;
1644
dc053733
AP
1645 if (kstrtoul(str, 0, &addr))
1646 return -EINVAL;
189d84ed
CM
1647 object = find_and_get_object(addr, 0);
1648 if (!object) {
1649 pr_info("Unknown object at 0x%08lx\n", addr);
1650 return -EINVAL;
1651 }
1652
1653 spin_lock_irqsave(&object->lock, flags);
1654 dump_object_info(object);
1655 spin_unlock_irqrestore(&object->lock, flags);
1656
1657 put_object(object);
1658 return 0;
1659}
1660
30b37101
LR
1661/*
1662 * We use grey instead of black to ensure we can do future scans on the same
1663 * objects. If we did not do future scans these black objects could
1664 * potentially contain references to newly allocated objects in the future and
1665 * we'd end up with false positives.
1666 */
1667static void kmemleak_clear(void)
1668{
1669 struct kmemleak_object *object;
1670 unsigned long flags;
1671
1672 rcu_read_lock();
1673 list_for_each_entry_rcu(object, &object_list, object_list) {
1674 spin_lock_irqsave(&object->lock, flags);
1675 if ((object->flags & OBJECT_REPORTED) &&
1676 unreferenced_object(object))
a1084c87 1677 __paint_it(object, KMEMLEAK_GREY);
30b37101
LR
1678 spin_unlock_irqrestore(&object->lock, flags);
1679 }
1680 rcu_read_unlock();
dc9b3f42
LZ
1681
1682 kmemleak_found_leaks = false;
30b37101
LR
1683}
1684
c89da70c
LZ
1685static void __kmemleak_do_cleanup(void);
1686
3c7b4e6b
CM
1687/*
1688 * File write operation to configure kmemleak at run-time. The following
1689 * commands can be written to the /sys/kernel/debug/kmemleak file:
1690 * off - disable kmemleak (irreversible)
1691 * stack=on - enable the task stacks scanning
1692 * stack=off - disable the tasks stacks scanning
1693 * scan=on - start the automatic memory scanning thread
1694 * scan=off - stop the automatic memory scanning thread
1695 * scan=... - set the automatic memory scanning period in seconds (0 to
1696 * disable it)
4698c1f2 1697 * scan - trigger a memory scan
30b37101 1698 * clear - mark all current reported unreferenced kmemleak objects as
c89da70c
LZ
1699 * grey to ignore printing them, or free all kmemleak objects
1700 * if kmemleak has been disabled.
189d84ed 1701 * dump=... - dump information about the object found at the given address
3c7b4e6b
CM
1702 */
1703static ssize_t kmemleak_write(struct file *file, const char __user *user_buf,
1704 size_t size, loff_t *ppos)
1705{
1706 char buf[64];
1707 int buf_size;
b87324d0 1708 int ret;
3c7b4e6b
CM
1709
1710 buf_size = min(size, (sizeof(buf) - 1));
1711 if (strncpy_from_user(buf, user_buf, buf_size) < 0)
1712 return -EFAULT;
1713 buf[buf_size] = 0;
1714
b87324d0
CM
1715 ret = mutex_lock_interruptible(&scan_mutex);
1716 if (ret < 0)
1717 return ret;
1718
c89da70c 1719 if (strncmp(buf, "clear", 5) == 0) {
8910ae89 1720 if (kmemleak_enabled)
c89da70c
LZ
1721 kmemleak_clear();
1722 else
1723 __kmemleak_do_cleanup();
1724 goto out;
1725 }
1726
8910ae89 1727 if (!kmemleak_enabled) {
c89da70c
LZ
1728 ret = -EBUSY;
1729 goto out;
1730 }
1731
3c7b4e6b
CM
1732 if (strncmp(buf, "off", 3) == 0)
1733 kmemleak_disable();
1734 else if (strncmp(buf, "stack=on", 8) == 0)
1735 kmemleak_stack_scan = 1;
1736 else if (strncmp(buf, "stack=off", 9) == 0)
1737 kmemleak_stack_scan = 0;
1738 else if (strncmp(buf, "scan=on", 7) == 0)
1739 start_scan_thread();
1740 else if (strncmp(buf, "scan=off", 8) == 0)
1741 stop_scan_thread();
1742 else if (strncmp(buf, "scan=", 5) == 0) {
1743 unsigned long secs;
3c7b4e6b 1744
3dbb95f7 1745 ret = kstrtoul(buf + 5, 0, &secs);
b87324d0
CM
1746 if (ret < 0)
1747 goto out;
3c7b4e6b
CM
1748 stop_scan_thread();
1749 if (secs) {
1750 jiffies_scan_wait = msecs_to_jiffies(secs * 1000);
1751 start_scan_thread();
1752 }
4698c1f2
CM
1753 } else if (strncmp(buf, "scan", 4) == 0)
1754 kmemleak_scan();
189d84ed
CM
1755 else if (strncmp(buf, "dump=", 5) == 0)
1756 ret = dump_str_object_info(buf + 5);
4698c1f2 1757 else
b87324d0
CM
1758 ret = -EINVAL;
1759
1760out:
1761 mutex_unlock(&scan_mutex);
1762 if (ret < 0)
1763 return ret;
3c7b4e6b
CM
1764
1765 /* ignore the rest of the buffer, only one command at a time */
1766 *ppos += size;
1767 return size;
1768}
1769
1770static const struct file_operations kmemleak_fops = {
1771 .owner = THIS_MODULE,
1772 .open = kmemleak_open,
1773 .read = seq_read,
1774 .write = kmemleak_write,
1775 .llseek = seq_lseek,
5f3bf19a 1776 .release = seq_release,
3c7b4e6b
CM
1777};
1778
c89da70c
LZ
1779static void __kmemleak_do_cleanup(void)
1780{
1781 struct kmemleak_object *object;
1782
1783 rcu_read_lock();
1784 list_for_each_entry_rcu(object, &object_list, object_list)
1785 delete_object_full(object->pointer);
1786 rcu_read_unlock();
1787}
1788
3c7b4e6b 1789/*
74341703
CM
1790 * Stop the memory scanning thread and free the kmemleak internal objects if
1791 * no previous scan thread (otherwise, kmemleak may still have some useful
1792 * information on memory leaks).
3c7b4e6b 1793 */
179a8100 1794static void kmemleak_do_cleanup(struct work_struct *work)
3c7b4e6b 1795{
3c7b4e6b 1796 stop_scan_thread();
3c7b4e6b 1797
c5f3b1a5
CM
1798 /*
1799 * Once the scan thread has stopped, it is safe to no longer track
1800 * object freeing. Ordering of the scan thread stopping and the memory
1801 * accesses below is guaranteed by the kthread_stop() function.
1802 */
1803 kmemleak_free_enabled = 0;
1804
c89da70c
LZ
1805 if (!kmemleak_found_leaks)
1806 __kmemleak_do_cleanup();
1807 else
1808 pr_info("Kmemleak disabled without freeing internal data. "
1809 "Reclaim the memory with \"echo clear > /sys/kernel/debug/kmemleak\"\n");
3c7b4e6b
CM
1810}
1811
179a8100 1812static DECLARE_WORK(cleanup_work, kmemleak_do_cleanup);
3c7b4e6b
CM
1813
1814/*
1815 * Disable kmemleak. No memory allocation/freeing will be traced once this
1816 * function is called. Disabling kmemleak is an irreversible operation.
1817 */
1818static void kmemleak_disable(void)
1819{
1820 /* atomically check whether it was already invoked */
8910ae89 1821 if (cmpxchg(&kmemleak_error, 0, 1))
3c7b4e6b
CM
1822 return;
1823
1824 /* stop any memory operation tracing */
8910ae89 1825 kmemleak_enabled = 0;
3c7b4e6b
CM
1826
1827 /* check whether it is too early for a kernel thread */
8910ae89 1828 if (kmemleak_initialized)
179a8100 1829 schedule_work(&cleanup_work);
c5f3b1a5
CM
1830 else
1831 kmemleak_free_enabled = 0;
3c7b4e6b
CM
1832
1833 pr_info("Kernel memory leak detector disabled\n");
1834}
1835
1836/*
1837 * Allow boot-time kmemleak disabling (enabled by default).
1838 */
1839static int kmemleak_boot_config(char *str)
1840{
1841 if (!str)
1842 return -EINVAL;
1843 if (strcmp(str, "off") == 0)
1844 kmemleak_disable();
ab0155a2
JB
1845 else if (strcmp(str, "on") == 0)
1846 kmemleak_skip_disable = 1;
1847 else
3c7b4e6b
CM
1848 return -EINVAL;
1849 return 0;
1850}
1851early_param("kmemleak", kmemleak_boot_config);
1852
5f79020c
CM
1853static void __init print_log_trace(struct early_log *log)
1854{
1855 struct stack_trace trace;
1856
1857 trace.nr_entries = log->trace_len;
1858 trace.entries = log->trace;
1859
1860 pr_notice("Early log backtrace:\n");
1861 print_stack_trace(&trace, 2);
1862}
1863
3c7b4e6b 1864/*
2030117d 1865 * Kmemleak initialization.
3c7b4e6b
CM
1866 */
1867void __init kmemleak_init(void)
1868{
1869 int i;
1870 unsigned long flags;
1871
ab0155a2
JB
1872#ifdef CONFIG_DEBUG_KMEMLEAK_DEFAULT_OFF
1873 if (!kmemleak_skip_disable) {
3551a928 1874 kmemleak_early_log = 0;
ab0155a2
JB
1875 kmemleak_disable();
1876 return;
1877 }
1878#endif
1879
3c7b4e6b
CM
1880 jiffies_min_age = msecs_to_jiffies(MSECS_MIN_AGE);
1881 jiffies_scan_wait = msecs_to_jiffies(SECS_SCAN_WAIT * 1000);
1882
1883 object_cache = KMEM_CACHE(kmemleak_object, SLAB_NOLEAKTRACE);
1884 scan_area_cache = KMEM_CACHE(kmemleak_scan_area, SLAB_NOLEAKTRACE);
3c7b4e6b 1885
21cd3a60 1886 if (crt_early_log > ARRAY_SIZE(early_log))
b6693005
CM
1887 pr_warning("Early log buffer exceeded (%d), please increase "
1888 "DEBUG_KMEMLEAK_EARLY_LOG_SIZE\n", crt_early_log);
1889
3c7b4e6b
CM
1890 /* the kernel is still in UP mode, so disabling the IRQs is enough */
1891 local_irq_save(flags);
3551a928 1892 kmemleak_early_log = 0;
8910ae89 1893 if (kmemleak_error) {
b6693005
CM
1894 local_irq_restore(flags);
1895 return;
c5f3b1a5 1896 } else {
8910ae89 1897 kmemleak_enabled = 1;
c5f3b1a5
CM
1898 kmemleak_free_enabled = 1;
1899 }
3c7b4e6b
CM
1900 local_irq_restore(flags);
1901
1902 /*
1903 * This is the point where tracking allocations is safe. Automatic
1904 * scanning is started during the late initcall. Add the early logged
1905 * callbacks to the kmemleak infrastructure.
1906 */
1907 for (i = 0; i < crt_early_log; i++) {
1908 struct early_log *log = &early_log[i];
1909
1910 switch (log->op_type) {
1911 case KMEMLEAK_ALLOC:
fd678967 1912 early_alloc(log);
3c7b4e6b 1913 break;
f528f0b8
CM
1914 case KMEMLEAK_ALLOC_PERCPU:
1915 early_alloc_percpu(log);
1916 break;
3c7b4e6b
CM
1917 case KMEMLEAK_FREE:
1918 kmemleak_free(log->ptr);
1919 break;
53238a60
CM
1920 case KMEMLEAK_FREE_PART:
1921 kmemleak_free_part(log->ptr, log->size);
1922 break;
f528f0b8
CM
1923 case KMEMLEAK_FREE_PERCPU:
1924 kmemleak_free_percpu(log->ptr);
1925 break;
3c7b4e6b
CM
1926 case KMEMLEAK_NOT_LEAK:
1927 kmemleak_not_leak(log->ptr);
1928 break;
1929 case KMEMLEAK_IGNORE:
1930 kmemleak_ignore(log->ptr);
1931 break;
1932 case KMEMLEAK_SCAN_AREA:
c017b4be 1933 kmemleak_scan_area(log->ptr, log->size, GFP_KERNEL);
3c7b4e6b
CM
1934 break;
1935 case KMEMLEAK_NO_SCAN:
1936 kmemleak_no_scan(log->ptr);
1937 break;
1938 default:
5f79020c
CM
1939 kmemleak_warn("Unknown early log operation: %d\n",
1940 log->op_type);
1941 }
1942
8910ae89 1943 if (kmemleak_warning) {
5f79020c 1944 print_log_trace(log);
8910ae89 1945 kmemleak_warning = 0;
3c7b4e6b
CM
1946 }
1947 }
1948}
1949
1950/*
1951 * Late initialization function.
1952 */
1953static int __init kmemleak_late_init(void)
1954{
1955 struct dentry *dentry;
1956
8910ae89 1957 kmemleak_initialized = 1;
3c7b4e6b 1958
8910ae89 1959 if (kmemleak_error) {
3c7b4e6b 1960 /*
25985edc 1961 * Some error occurred and kmemleak was disabled. There is a
3c7b4e6b
CM
1962 * small chance that kmemleak_disable() was called immediately
1963 * after setting kmemleak_initialized and we may end up with
1964 * two clean-up threads but serialized by scan_mutex.
1965 */
179a8100 1966 schedule_work(&cleanup_work);
3c7b4e6b
CM
1967 return -ENOMEM;
1968 }
1969
1970 dentry = debugfs_create_file("kmemleak", S_IRUGO, NULL, NULL,
1971 &kmemleak_fops);
1972 if (!dentry)
ae281064 1973 pr_warning("Failed to create the debugfs kmemleak file\n");
4698c1f2 1974 mutex_lock(&scan_mutex);
3c7b4e6b 1975 start_scan_thread();
4698c1f2 1976 mutex_unlock(&scan_mutex);
3c7b4e6b
CM
1977
1978 pr_info("Kernel memory leak detector initialized\n");
1979
1980 return 0;
1981}
1982late_initcall(kmemleak_late_init);