kmemleak.c 59.4 KB
Newer Older
C
Catalin Marinas 已提交
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21
/*
 * mm/kmemleak.c
 *
 * Copyright (C) 2008 ARM Limited
 * Written by Catalin Marinas <catalin.marinas@arm.com>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 *
 *
 * For more information on the algorithm and kmemleak usage, please see
22
 * Documentation/dev-tools/kmemleak.rst.
C
Catalin Marinas 已提交
23 24 25 26 27 28 29 30 31
 *
 * Notes on locking
 * ----------------
 *
 * The following locks and mutexes are used by kmemleak:
 *
 * - kmemleak_lock (rwlock): protects the object_list modifications and
 *   accesses to the object_tree_root. The object_list is the main list
 *   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
C
Catalin Marinas 已提交
33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50
 *   metadata based on a pointer to the corresponding memory block.  The
 *   kmemleak_object structures are added to the object_list and
 *   object_tree_root in the create_object() function called from the
 *   kmemleak_alloc() callback and removed in delete_object() called from the
 *   kmemleak_free() callback
 * - kmemleak_object.lock (spinlock): protects a kmemleak_object. Accesses to
 *   the metadata (e.g. count) are protected by this lock. Note that some
 *   members of this structure may be protected by other means (atomic or
 *   kmemleak_lock). This lock is also held when scanning the corresponding
 *   memory block to avoid the kernel freeing it via the kmemleak_free()
 *   callback. This is less heavyweight than holding a global lock like
 *   kmemleak_lock during scanning
 * - scan_mutex (mutex): ensures that only one thread may scan the memory for
 *   unreferenced objects at a time. The gray_list contains the objects which
 *   are already referenced or marked as false positives and need to be
 *   scanned. This list is only modified during a scanning episode when the
 *   scan_mutex is held. At the end of a scan, the gray_list is always empty.
 *   Note that the kmemleak_object.use_count is incremented when an object is
51 52 53 54
 *   added to the gray_list and therefore cannot be freed. This mutex also
 *   prevents multiple users of the "kmemleak" debugfs file together with
 *   modifications to the memory scanning parameters including the scan_thread
 *   pointer
C
Catalin Marinas 已提交
55
 *
56
 * Locks and mutexes are acquired/nested in the following order:
57
 *
58 59 60 61
 *   scan_mutex [-> object->lock] -> kmemleak_lock -> other_object->lock (SINGLE_DEPTH_NESTING)
 *
 * No kmemleak_lock and object->lock nesting is allowed outside scan_mutex
 * regions.
62
 *
C
Catalin Marinas 已提交
63 64 65 66 67 68 69 70
 * The kmemleak_object structures have a use_count incremented or decremented
 * using the get_object()/put_object() functions. When the use_count becomes
 * 0, this count can no longer be incremented and put_object() schedules the
 * kmemleak_object freeing via an RCU callback. All calls to the get_object()
 * function must be protected by rcu_read_lock() to avoid accessing a freed
 * structure.
 */

J
Joe Perches 已提交
71 72
#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt

C
Catalin Marinas 已提交
73 74 75
#include <linux/init.h>
#include <linux/kernel.h>
#include <linux/list.h>
76
#include <linux/sched/signal.h>
77
#include <linux/sched/task.h>
78
#include <linux/sched/task_stack.h>
C
Catalin Marinas 已提交
79 80
#include <linux/jiffies.h>
#include <linux/delay.h>
81
#include <linux/export.h>
C
Catalin Marinas 已提交
82
#include <linux/kthread.h>
83
#include <linux/rbtree.h>
C
Catalin Marinas 已提交
84 85 86 87 88 89 90 91 92 93
#include <linux/fs.h>
#include <linux/debugfs.h>
#include <linux/seq_file.h>
#include <linux/cpumask.h>
#include <linux/spinlock.h>
#include <linux/mutex.h>
#include <linux/rcupdate.h>
#include <linux/stacktrace.h>
#include <linux/cache.h>
#include <linux/percpu.h>
94 95
#include <linux/bootmem.h>
#include <linux/pfn.h>
C
Catalin Marinas 已提交
96 97 98 99 100 101 102 103
#include <linux/mmzone.h>
#include <linux/slab.h>
#include <linux/thread_info.h>
#include <linux/err.h>
#include <linux/uaccess.h>
#include <linux/string.h>
#include <linux/nodemask.h>
#include <linux/mm.h>
104
#include <linux/workqueue.h>
105
#include <linux/crc32.h>
C
Catalin Marinas 已提交
106 107 108

#include <asm/sections.h>
#include <asm/processor.h>
A
Arun Sharma 已提交
109
#include <linux/atomic.h>
C
Catalin Marinas 已提交
110

111
#include <linux/kasan.h>
C
Catalin Marinas 已提交
112
#include <linux/kmemleak.h>
113
#include <linux/memory_hotplug.h>
C
Catalin Marinas 已提交
114 115 116 117 118 119 120 121

/*
 * Kmemleak configuration and common defines.
 */
#define MAX_TRACE		16	/* stack trace length */
#define MSECS_MIN_AGE		5000	/* minimum object age for reporting */
#define SECS_FIRST_SCAN		60	/* delay before the first scan */
#define SECS_SCAN_WAIT		600	/* subsequent auto scanning delay */
122
#define MAX_SCAN_SIZE		4096	/* maximum size of a scanned block */
C
Catalin Marinas 已提交
123 124 125

#define BYTES_PER_POINTER	sizeof(void *)

126
/* GFP bitmask for kmemleak internal allocations */
127
#define gfp_kmemleak_mask(gfp)	(((gfp) & (GFP_KERNEL | GFP_ATOMIC)) | \
128
				 __GFP_NORETRY | __GFP_NOMEMALLOC | \
129
				 __GFP_NOWARN | __GFP_NOFAIL)
130

C
Catalin Marinas 已提交
131 132 133
/* scanning area inside a memory block */
struct kmemleak_scan_area {
	struct hlist_node node;
134 135
	unsigned long start;
	size_t size;
C
Catalin Marinas 已提交
136 137
};

138 139 140
#define KMEMLEAK_GREY	0
#define KMEMLEAK_BLACK	-1

C
Catalin Marinas 已提交
141 142 143 144
/*
 * Structure holding the metadata for each allocated memory block.
 * Modifications to such objects should be made while holding the
 * object->lock. Insertions or deletions from object_list, gray_list or
145
 * rb_node are already protected by the corresponding locks or mutex (see
C
Catalin Marinas 已提交
146 147 148 149 150
 * the notes on locking above). These objects are reference-counted
 * (use_count) and freed using the RCU mechanism.
 */
struct kmemleak_object {
	spinlock_t lock;
151
	unsigned int flags;		/* object status flags */
C
Catalin Marinas 已提交
152 153
	struct list_head object_list;
	struct list_head gray_list;
154
	struct rb_node rb_node;
C
Catalin Marinas 已提交
155 156 157 158 159
	struct rcu_head rcu;		/* object_list lockless traversal */
	/* object usage count; object freed when use_count == 0 */
	atomic_t use_count;
	unsigned long pointer;
	size_t size;
160 161
	/* pass surplus references to this pointer */
	unsigned long excess_ref;
C
Catalin Marinas 已提交
162 163 164 165
	/* minimum number of a pointers found before it is considered leak */
	int min_count;
	/* the total number of pointers found pointing to this object */
	int count;
166 167
	/* checksum for detecting modified objects */
	u32 checksum;
C
Catalin Marinas 已提交
168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183
	/* memory ranges to be scanned inside an object (empty for all) */
	struct hlist_head area_list;
	unsigned long trace[MAX_TRACE];
	unsigned int trace_len;
	unsigned long jiffies;		/* creation timestamp */
	pid_t pid;			/* pid of the current task */
	char comm[TASK_COMM_LEN];	/* executable name */
};

/* flag representing the memory block allocation status */
#define OBJECT_ALLOCATED	(1 << 0)
/* flag set after the first reporting of an unreference object */
#define OBJECT_REPORTED		(1 << 1)
/* flag set to not scan the object */
#define OBJECT_NO_SCAN		(1 << 2)

184 185 186 187 188 189 190 191 192
/* number of bytes to print per line; must be 16 or 32 */
#define HEX_ROW_SIZE		16
/* number of bytes to print at a time (1, 2, 4, 8) */
#define HEX_GROUP_SIZE		1
/* include ASCII after the hex output */
#define HEX_ASCII		1
/* max number of lines to be printed */
#define HEX_MAX_LINES		2

C
Catalin Marinas 已提交
193 194 195 196
/* the list of all allocated objects */
static LIST_HEAD(object_list);
/* the list of gray-colored objects (see color_gray comment below) */
static LIST_HEAD(gray_list);
197 198 199
/* search tree for object boundaries */
static struct rb_root object_tree_root = RB_ROOT;
/* rw_lock protecting the access to object_list and object_tree_root */
C
Catalin Marinas 已提交
200 201 202 203 204 205 206
static DEFINE_RWLOCK(kmemleak_lock);

/* allocation caches for kmemleak internal data */
static struct kmem_cache *object_cache;
static struct kmem_cache *scan_area_cache;

/* set if tracing memory operations is enabled */
207
static int kmemleak_enabled;
208 209
/* same as above but only for the kmemleak_free() callback */
static int kmemleak_free_enabled;
C
Catalin Marinas 已提交
210
/* set in the late_initcall if there were no errors */
211
static int kmemleak_initialized;
C
Catalin Marinas 已提交
212
/* enables or disables early logging of the memory operations */
213
static int kmemleak_early_log = 1;
214
/* set if a kmemleak warning was issued */
215
static int kmemleak_warning;
216
/* set if a fatal kmemleak error has occurred */
217
static int kmemleak_error;
C
Catalin Marinas 已提交
218 219 220 221 222 223

/* minimum and maximum address that may be valid pointers */
static unsigned long min_addr = ULONG_MAX;
static unsigned long max_addr;

static struct task_struct *scan_thread;
224
/* used to avoid reporting of recently allocated objects */
C
Catalin Marinas 已提交
225
static unsigned long jiffies_min_age;
226
static unsigned long jiffies_last_scan;
C
Catalin Marinas 已提交
227 228 229
/* delay between automatic memory scannings */
static signed long jiffies_scan_wait;
/* enables or disables the task stacks scanning */
230
static int kmemleak_stack_scan = 1;
231
/* protects the memory scanning, parameters and debug/kmemleak file access */
C
Catalin Marinas 已提交
232
static DEFINE_MUTEX(scan_mutex);
233 234
/* setting kmemleak=on, will set this var, skipping the disable */
static int kmemleak_skip_disable;
235 236
/* If there are leaks that can be reported */
static bool kmemleak_found_leaks;
C
Catalin Marinas 已提交
237 238

/*
239
 * Early object allocation/freeing logging. Kmemleak is initialized after the
C
Catalin Marinas 已提交
240
 * kernel allocator. However, both the kernel allocator and kmemleak may
241
 * allocate memory blocks which need to be tracked. Kmemleak defines an
C
Catalin Marinas 已提交
242 243 244 245 246 247 248
 * arbitrary buffer to hold the allocation/freeing information before it is
 * fully initialized.
 */

/* kmemleak operation type for early logging */
enum {
	KMEMLEAK_ALLOC,
249
	KMEMLEAK_ALLOC_PERCPU,
C
Catalin Marinas 已提交
250
	KMEMLEAK_FREE,
251
	KMEMLEAK_FREE_PART,
252
	KMEMLEAK_FREE_PERCPU,
C
Catalin Marinas 已提交
253 254 255
	KMEMLEAK_NOT_LEAK,
	KMEMLEAK_IGNORE,
	KMEMLEAK_SCAN_AREA,
256 257
	KMEMLEAK_NO_SCAN,
	KMEMLEAK_SET_EXCESS_REF
C
Catalin Marinas 已提交
258 259 260 261 262 263 264 265
};

/*
 * Structure holding the information passed to kmemleak callbacks during the
 * early logging.
 */
struct early_log {
	int op_type;			/* kmemleak operation type */
266
	int min_count;			/* minimum reference count */
C
Catalin Marinas 已提交
267
	const void *ptr;		/* allocated/freed memory block */
268 269 270 271
	union {
		size_t size;		/* memory block size */
		unsigned long excess_ref; /* surplus reference passing */
	};
272 273
	unsigned long trace[MAX_TRACE];	/* stack trace */
	unsigned int trace_len;		/* stack trace length */
C
Catalin Marinas 已提交
274 275 276
};

/* early logging buffer and current position */
277 278 279
static struct early_log
	early_log[CONFIG_DEBUG_KMEMLEAK_EARLY_LOG_SIZE] __initdata;
static int crt_early_log __initdata;
C
Catalin Marinas 已提交
280 281 282 283 284 285

static void kmemleak_disable(void);

/*
 * Print a warning and dump the stack trace.
 */
286
#define kmemleak_warn(x...)	do {		\
J
Joe Perches 已提交
287
	pr_warn(x);				\
288
	dump_stack();				\
289
	kmemleak_warning = 1;			\
C
Catalin Marinas 已提交
290 291 292
} while (0)

/*
L
Lucas De Marchi 已提交
293
 * Macro invoked when a serious kmemleak condition occurred and cannot be
294
 * recovered from. Kmemleak will be disabled and further allocation/freeing
C
Catalin Marinas 已提交
295 296
 * tracing no longer available.
 */
297
#define kmemleak_stop(x...)	do {	\
C
Catalin Marinas 已提交
298 299 300 301
	kmemleak_warn(x);		\
	kmemleak_disable();		\
} while (0)

302 303 304 305 306 307 308 309 310 311
/*
 * Printing of the objects hex dump to the seq file. The number of lines to be
 * printed is limited to HEX_MAX_LINES to prevent seq file spamming. The
 * actual number of printed bytes depends on HEX_ROW_SIZE. It must be called
 * with the object->lock held.
 */
static void hex_dump_object(struct seq_file *seq,
			    struct kmemleak_object *object)
{
	const u8 *ptr = (const u8 *)object->pointer;
312
	size_t len;
313 314

	/* limit the number of lines to HEX_MAX_LINES */
315
	len = min_t(size_t, object->size, HEX_MAX_LINES * HEX_ROW_SIZE);
316

317
	seq_printf(seq, "  hex dump (first %zu bytes):\n", len);
318
	kasan_disable_current();
319 320
	seq_hex_dump(seq, "    ", DUMP_PREFIX_NONE, HEX_ROW_SIZE,
		     HEX_GROUP_SIZE, ptr, len, HEX_ASCII);
321
	kasan_enable_current();
322 323
}

C
Catalin Marinas 已提交
324 325 326 327 328 329 330 331 332 333
/*
 * Object colors, encoded with count and min_count:
 * - white - orphan object, not enough references to it (count < min_count)
 * - gray  - not orphan, not marked as false positive (min_count == 0) or
 *		sufficient references to it (count >= min_count)
 * - black - ignore, it doesn't contain references (e.g. text section)
 *		(min_count == -1). No function defined for this color.
 * Newly created objects don't have any color assigned (object->count == -1)
 * before the next memory scan when they become white.
 */
334
static bool color_white(const struct kmemleak_object *object)
C
Catalin Marinas 已提交
335
{
336 337
	return object->count != KMEMLEAK_BLACK &&
		object->count < object->min_count;
C
Catalin Marinas 已提交
338 339
}

340
static bool color_gray(const struct kmemleak_object *object)
C
Catalin Marinas 已提交
341
{
342 343
	return object->min_count != KMEMLEAK_BLACK &&
		object->count >= object->min_count;
C
Catalin Marinas 已提交
344 345 346 347 348 349 350
}

/*
 * Objects are considered unreferenced only if their color is white, they have
 * not be deleted and have a minimum age to avoid false positives caused by
 * pointers temporarily stored in CPU registers.
 */
351
static bool unreferenced_object(struct kmemleak_object *object)
C
Catalin Marinas 已提交
352
{
353
	return (color_white(object) && object->flags & OBJECT_ALLOCATED) &&
354 355
		time_before_eq(object->jiffies + jiffies_min_age,
			       jiffies_last_scan);
C
Catalin Marinas 已提交
356 357 358
}

/*
359 360
 * Printing of the unreferenced objects information to the seq file. The
 * print_unreferenced function must be called with the object->lock held.
C
Catalin Marinas 已提交
361 362 363 364 365
 */
static void print_unreferenced(struct seq_file *seq,
			       struct kmemleak_object *object)
{
	int i;
366
	unsigned int msecs_age = jiffies_to_msecs(jiffies - object->jiffies);
C
Catalin Marinas 已提交
367

368 369
	seq_printf(seq, "unreferenced object 0x%08lx (size %zu):\n",
		   object->pointer, object->size);
370 371 372
	seq_printf(seq, "  comm \"%s\", pid %d, jiffies %lu (age %d.%03ds)\n",
		   object->comm, object->pid, object->jiffies,
		   msecs_age / 1000, msecs_age % 1000);
373
	hex_dump_object(seq, object);
374
	seq_printf(seq, "  backtrace:\n");
C
Catalin Marinas 已提交
375 376 377

	for (i = 0; i < object->trace_len; i++) {
		void *ptr = (void *)object->trace[i];
378
		seq_printf(seq, "    [<%p>] %pS\n", ptr, ptr);
C
Catalin Marinas 已提交
379 380 381 382 383 384 385 386 387 388 389 390 391 392 393
	}
}

/*
 * Print the kmemleak_object information. This function is used mainly for
 * debugging special cases when kmemleak operations. It must be called with
 * the object->lock held.
 */
static void dump_object_info(struct kmemleak_object *object)
{
	struct stack_trace trace;

	trace.nr_entries = object->trace_len;
	trace.entries = object->trace;

J
Joe Perches 已提交
394
	pr_notice("Object 0x%08lx (size %zu):\n",
395
		  object->pointer, object->size);
C
Catalin Marinas 已提交
396 397 398 399
	pr_notice("  comm \"%s\", pid %d, jiffies %lu\n",
		  object->comm, object->pid, object->jiffies);
	pr_notice("  min_count = %d\n", object->min_count);
	pr_notice("  count = %d\n", object->count);
400
	pr_notice("  flags = 0x%x\n", object->flags);
401
	pr_notice("  checksum = %u\n", object->checksum);
C
Catalin Marinas 已提交
402 403 404 405 406
	pr_notice("  backtrace:\n");
	print_stack_trace(&trace, 4);
}

/*
407
 * Look-up a memory block metadata (kmemleak_object) in the object search
C
Catalin Marinas 已提交
408 409 410 411 412 413
 * tree based on a pointer value. If alias is 0, only values pointing to the
 * beginning of the memory block are allowed. The kmemleak_lock must be held
 * when calling this function.
 */
static struct kmemleak_object *lookup_object(unsigned long ptr, int alias)
{
414 415 416 417 418 419 420 421 422 423 424 425
	struct rb_node *rb = object_tree_root.rb_node;

	while (rb) {
		struct kmemleak_object *object =
			rb_entry(rb, struct kmemleak_object, rb_node);
		if (ptr < object->pointer)
			rb = object->rb_node.rb_left;
		else if (object->pointer + object->size <= ptr)
			rb = object->rb_node.rb_right;
		else if (object->pointer == ptr || alias)
			return object;
		else {
426 427
			kmemleak_warn("Found object by alias at 0x%08lx\n",
				      ptr);
428
			dump_object_info(object);
429
			break;
C
Catalin Marinas 已提交
430
		}
431 432
	}
	return NULL;
C
Catalin Marinas 已提交
433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450
}

/*
 * Increment the object use_count. Return 1 if successful or 0 otherwise. Note
 * that once an object's use_count reached 0, the RCU freeing was already
 * registered and the object should no longer be used. This function must be
 * called under the protection of rcu_read_lock().
 */
static int get_object(struct kmemleak_object *object)
{
	return atomic_inc_not_zero(&object->use_count);
}

/*
 * RCU callback to free a kmemleak_object.
 */
static void free_object_rcu(struct rcu_head *rcu)
{
451
	struct hlist_node *tmp;
C
Catalin Marinas 已提交
452 453 454 455 456 457 458 459
	struct kmemleak_scan_area *area;
	struct kmemleak_object *object =
		container_of(rcu, struct kmemleak_object, rcu);

	/*
	 * Once use_count is 0 (guaranteed by put_object), there is no other
	 * code accessing this object, hence no need for locking.
	 */
460 461
	hlist_for_each_entry_safe(area, tmp, &object->area_list, node) {
		hlist_del(&area->node);
C
Catalin Marinas 已提交
462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485
		kmem_cache_free(scan_area_cache, area);
	}
	kmem_cache_free(object_cache, object);
}

/*
 * Decrement the object use_count. Once the count is 0, free the object using
 * an RCU callback. Since put_object() may be called via the kmemleak_free() ->
 * delete_object() path, the delayed RCU freeing ensures that there is no
 * recursive call to the kernel allocator. Lock-less RCU object_list traversal
 * is also possible.
 */
static void put_object(struct kmemleak_object *object)
{
	if (!atomic_dec_and_test(&object->use_count))
		return;

	/* should only get here after delete_object was called */
	WARN_ON(object->flags & OBJECT_ALLOCATED);

	call_rcu(&object->rcu, free_object_rcu);
}

/*
486
 * Look up an object in the object search tree and increase its use_count.
C
Catalin Marinas 已提交
487 488 489 490
 */
static struct kmemleak_object *find_and_get_object(unsigned long ptr, int alias)
{
	unsigned long flags;
491
	struct kmemleak_object *object;
C
Catalin Marinas 已提交
492 493 494

	rcu_read_lock();
	read_lock_irqsave(&kmemleak_lock, flags);
495
	object = lookup_object(ptr, alias);
C
Catalin Marinas 已提交
496 497 498 499 500 501 502 503 504 505
	read_unlock_irqrestore(&kmemleak_lock, flags);

	/* check whether the object is still available */
	if (object && !get_object(object))
		object = NULL;
	rcu_read_unlock();

	return object;
}

506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526
/*
 * Look up an object in the object search tree and remove it from both
 * object_tree_root and object_list. The returned object's use_count should be
 * at least 1, as initially set by create_object().
 */
static struct kmemleak_object *find_and_remove_object(unsigned long ptr, int alias)
{
	unsigned long flags;
	struct kmemleak_object *object;

	write_lock_irqsave(&kmemleak_lock, flags);
	object = lookup_object(ptr, alias);
	if (object) {
		rb_erase(&object->rb_node, &object_tree_root);
		list_del_rcu(&object->object_list);
	}
	write_unlock_irqrestore(&kmemleak_lock, flags);

	return object;
}

527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542
/*
 * Save stack trace to the given array of MAX_TRACE size.
 */
static int __save_stack_trace(unsigned long *trace)
{
	struct stack_trace stack_trace;

	stack_trace.max_entries = MAX_TRACE;
	stack_trace.nr_entries = 0;
	stack_trace.entries = trace;
	stack_trace.skip = 2;
	save_stack_trace(&stack_trace);

	return stack_trace.nr_entries;
}

C
Catalin Marinas 已提交
543 544 545 546
/*
 * Create the metadata (struct kmemleak_object) corresponding to an allocated
 * memory block and add it to the object_list and object_tree_root.
 */
547 548
static struct kmemleak_object *create_object(unsigned long ptr, size_t size,
					     int min_count, gfp_t gfp)
C
Catalin Marinas 已提交
549 550
{
	unsigned long flags;
551 552
	struct kmemleak_object *object, *parent;
	struct rb_node **link, *rb_parent;
C
Catalin Marinas 已提交
553

554
	object = kmem_cache_alloc(object_cache, gfp_kmemleak_mask(gfp));
C
Catalin Marinas 已提交
555
	if (!object) {
J
Joe Perches 已提交
556
		pr_warn("Cannot allocate a kmemleak_object structure\n");
557
		kmemleak_disable();
558
		return NULL;
C
Catalin Marinas 已提交
559 560 561 562 563 564 565
	}

	INIT_LIST_HEAD(&object->object_list);
	INIT_LIST_HEAD(&object->gray_list);
	INIT_HLIST_HEAD(&object->area_list);
	spin_lock_init(&object->lock);
	atomic_set(&object->use_count, 1);
566
	object->flags = OBJECT_ALLOCATED;
C
Catalin Marinas 已提交
567 568
	object->pointer = ptr;
	object->size = size;
569
	object->excess_ref = 0;
C
Catalin Marinas 已提交
570
	object->min_count = min_count;
571
	object->count = 0;			/* white color initially */
C
Catalin Marinas 已提交
572
	object->jiffies = jiffies;
573
	object->checksum = 0;
C
Catalin Marinas 已提交
574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593

	/* task information */
	if (in_irq()) {
		object->pid = 0;
		strncpy(object->comm, "hardirq", sizeof(object->comm));
	} else if (in_softirq()) {
		object->pid = 0;
		strncpy(object->comm, "softirq", sizeof(object->comm));
	} else {
		object->pid = current->pid;
		/*
		 * There is a small chance of a race with set_task_comm(),
		 * however using get_task_comm() here may cause locking
		 * dependency issues with current->alloc_lock. In the worst
		 * case, the command line is not correct.
		 */
		strncpy(object->comm, current->comm, sizeof(object->comm));
	}

	/* kernel backtrace */
594
	object->trace_len = __save_stack_trace(object->trace);
C
Catalin Marinas 已提交
595 596

	write_lock_irqsave(&kmemleak_lock, flags);
597

C
Catalin Marinas 已提交
598 599
	min_addr = min(min_addr, ptr);
	max_addr = max(max_addr, ptr + size);
600 601 602 603 604 605 606 607 608 609
	link = &object_tree_root.rb_node;
	rb_parent = NULL;
	while (*link) {
		rb_parent = *link;
		parent = rb_entry(rb_parent, struct kmemleak_object, rb_node);
		if (ptr + size <= parent->pointer)
			link = &parent->rb_node.rb_left;
		else if (parent->pointer + parent->size <= ptr)
			link = &parent->rb_node.rb_right;
		else {
J
Joe Perches 已提交
610
			kmemleak_stop("Cannot insert 0x%lx into the object search tree (overlaps existing)\n",
611
				      ptr);
612 613 614 615 616
			/*
			 * No need for parent->lock here since "parent" cannot
			 * be freed while the kmemleak_lock is held.
			 */
			dump_object_info(parent);
617
			kmem_cache_free(object_cache, object);
618
			object = NULL;
619 620
			goto out;
		}
C
Catalin Marinas 已提交
621
	}
622 623 624
	rb_link_node(&object->rb_node, rb_parent, link);
	rb_insert_color(&object->rb_node, &object_tree_root);

C
Catalin Marinas 已提交
625 626 627
	list_add_tail_rcu(&object->object_list, &object_list);
out:
	write_unlock_irqrestore(&kmemleak_lock, flags);
628
	return object;
C
Catalin Marinas 已提交
629 630 631
}

/*
632
 * Mark the object as not allocated and schedule RCU freeing via put_object().
C
Catalin Marinas 已提交
633
 */
634
static void __delete_object(struct kmemleak_object *object)
C
Catalin Marinas 已提交
635 636 637 638
{
	unsigned long flags;

	WARN_ON(!(object->flags & OBJECT_ALLOCATED));
639
	WARN_ON(atomic_read(&object->use_count) < 1);
C
Catalin Marinas 已提交
640 641 642 643 644 645 646 647 648 649 650

	/*
	 * Locking here also ensures that the corresponding memory block
	 * cannot be freed when it is being scanned.
	 */
	spin_lock_irqsave(&object->lock, flags);
	object->flags &= ~OBJECT_ALLOCATED;
	spin_unlock_irqrestore(&object->lock, flags);
	put_object(object);
}

651 652 653 654 655 656 657 658
/*
 * Look up the metadata (struct kmemleak_object) corresponding to ptr and
 * delete it.
 */
static void delete_object_full(unsigned long ptr)
{
	struct kmemleak_object *object;

659
	object = find_and_remove_object(ptr, 0);
660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679
	if (!object) {
#ifdef DEBUG
		kmemleak_warn("Freeing unknown object at 0x%08lx\n",
			      ptr);
#endif
		return;
	}
	__delete_object(object);
}

/*
 * Look up the metadata (struct kmemleak_object) corresponding to ptr and
 * delete it. If the memory block is partially freed, the function may create
 * additional metadata for the remaining parts of the block.
 */
static void delete_object_part(unsigned long ptr, size_t size)
{
	struct kmemleak_object *object;
	unsigned long start, end;

680
	object = find_and_remove_object(ptr, 1);
681 682
	if (!object) {
#ifdef DEBUG
J
Joe Perches 已提交
683 684
		kmemleak_warn("Partially freeing unknown object at 0x%08lx (size %zu)\n",
			      ptr, size);
685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704
#endif
		return;
	}

	/*
	 * Create one or two objects that may result from the memory block
	 * split. Note that partial freeing is only done by free_bootmem() and
	 * this happens before kmemleak_init() is called. The path below is
	 * only executed during early log recording in kmemleak_init(), so
	 * GFP_KERNEL is enough.
	 */
	start = object->pointer;
	end = object->pointer + object->size;
	if (ptr > start)
		create_object(start, ptr - start, object->min_count,
			      GFP_KERNEL);
	if (ptr + size < end)
		create_object(ptr + size, end - ptr - size, object->min_count,
			      GFP_KERNEL);

705
	__delete_object(object);
706
}
707 708 709 710 711 712 713 714 715

static void __paint_it(struct kmemleak_object *object, int color)
{
	object->min_count = color;
	if (color == KMEMLEAK_BLACK)
		object->flags |= OBJECT_NO_SCAN;
}

static void paint_it(struct kmemleak_object *object, int color)
C
Catalin Marinas 已提交
716 717
{
	unsigned long flags;
718 719 720 721 722 723 724 725

	spin_lock_irqsave(&object->lock, flags);
	__paint_it(object, color);
	spin_unlock_irqrestore(&object->lock, flags);
}

static void paint_ptr(unsigned long ptr, int color)
{
C
Catalin Marinas 已提交
726 727 728 729
	struct kmemleak_object *object;

	object = find_and_get_object(ptr, 0);
	if (!object) {
J
Joe Perches 已提交
730 731
		kmemleak_warn("Trying to color unknown object at 0x%08lx as %s\n",
			      ptr,
732 733
			      (color == KMEMLEAK_GREY) ? "Grey" :
			      (color == KMEMLEAK_BLACK) ? "Black" : "Unknown");
C
Catalin Marinas 已提交
734 735
		return;
	}
736
	paint_it(object, color);
C
Catalin Marinas 已提交
737 738 739
	put_object(object);
}

740
/*
741
 * Mark an object permanently as gray-colored so that it can no longer be
742 743 744 745 746 747 748
 * reported as a leak. This is used in general to mark a false positive.
 */
static void make_gray_object(unsigned long ptr)
{
	paint_ptr(ptr, KMEMLEAK_GREY);
}

C
Catalin Marinas 已提交
749 750 751 752 753 754
/*
 * Mark the object as black-colored so that it is ignored from scans and
 * reporting.
 */
static void make_black_object(unsigned long ptr)
{
755
	paint_ptr(ptr, KMEMLEAK_BLACK);
C
Catalin Marinas 已提交
756 757 758 759 760 761
}

/*
 * Add a scanning area to the object. If at least one such area is added,
 * 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)
C
Catalin Marinas 已提交
763 764 765 766 767
{
	unsigned long flags;
	struct kmemleak_object *object;
	struct kmemleak_scan_area *area;

768
	object = find_and_get_object(ptr, 1);
C
Catalin Marinas 已提交
769
	if (!object) {
J
Joe Perches 已提交
770 771
		kmemleak_warn("Adding scan area to unknown object at 0x%08lx\n",
			      ptr);
C
Catalin Marinas 已提交
772 773 774
		return;
	}

775
	area = kmem_cache_alloc(scan_area_cache, gfp_kmemleak_mask(gfp));
C
Catalin Marinas 已提交
776
	if (!area) {
J
Joe Perches 已提交
777
		pr_warn("Cannot allocate a scan area\n");
C
Catalin Marinas 已提交
778 779 780 781
		goto out;
	}

	spin_lock_irqsave(&object->lock, flags);
782 783 784
	if (size == SIZE_MAX) {
		size = object->pointer + object->size - ptr;
	} else if (ptr + size > object->pointer + object->size) {
J
Joe Perches 已提交
785
		kmemleak_warn("Scan area larger than object 0x%08lx\n", ptr);
C
Catalin Marinas 已提交
786 787 788 789 790 791
		dump_object_info(object);
		kmem_cache_free(scan_area_cache, area);
		goto out_unlock;
	}

	INIT_HLIST_NODE(&area->node);
792 793
	area->start = ptr;
	area->size = size;
C
Catalin Marinas 已提交
794 795 796 797 798 799 800 801

	hlist_add_head(&area->node, &object->area_list);
out_unlock:
	spin_unlock_irqrestore(&object->lock, flags);
out:
	put_object(object);
}

802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825
/*
 * Any surplus references (object already gray) to 'ptr' are passed to
 * 'excess_ref'. This is used in the vmalloc() case where a pointer to
 * vm_struct may be used as an alternative reference to the vmalloc'ed object
 * (see free_thread_stack()).
 */
static void object_set_excess_ref(unsigned long ptr, unsigned long excess_ref)
{
	unsigned long flags;
	struct kmemleak_object *object;

	object = find_and_get_object(ptr, 0);
	if (!object) {
		kmemleak_warn("Setting excess_ref on unknown object at 0x%08lx\n",
			      ptr);
		return;
	}

	spin_lock_irqsave(&object->lock, flags);
	object->excess_ref = excess_ref;
	spin_unlock_irqrestore(&object->lock, flags);
	put_object(object);
}

C
Catalin Marinas 已提交
826 827 828 829 830 831 832 833 834 835 836 837
/*
 * Set the OBJECT_NO_SCAN flag for the object corresponding to the give
 * pointer. Such object will not be scanned by kmemleak but references to it
 * are searched.
 */
static void object_no_scan(unsigned long ptr)
{
	unsigned long flags;
	struct kmemleak_object *object;

	object = find_and_get_object(ptr, 0);
	if (!object) {
J
Joe Perches 已提交
838
		kmemleak_warn("Not scanning unknown object at 0x%08lx\n", ptr);
C
Catalin Marinas 已提交
839 840 841 842 843 844 845 846 847 848 849 850 851
		return;
	}

	spin_lock_irqsave(&object->lock, flags);
	object->flags |= OBJECT_NO_SCAN;
	spin_unlock_irqrestore(&object->lock, flags);
	put_object(object);
}

/*
 * Log an early kmemleak_* call to the early_log buffer. These calls will be
 * processed later once kmemleak is fully initialized.
 */
852
static void __init log_early(int op_type, const void *ptr, size_t size,
853
			     int min_count)
C
Catalin Marinas 已提交
854 855 856 857
{
	unsigned long flags;
	struct early_log *log;

858
	if (kmemleak_error) {
859 860 861 862 863
		/* kmemleak stopped recording, just count the requests */
		crt_early_log++;
		return;
	}

C
Catalin Marinas 已提交
864
	if (crt_early_log >= ARRAY_SIZE(early_log)) {
865
		crt_early_log++;
866
		kmemleak_disable();
C
Catalin Marinas 已提交
867 868 869 870 871 872 873 874 875 876 877 878 879
		return;
	}

	/*
	 * There is no need for locking since the kernel is still in UP mode
	 * at this stage. Disabling the IRQs is enough.
	 */
	local_irq_save(flags);
	log = &early_log[crt_early_log];
	log->op_type = op_type;
	log->ptr = ptr;
	log->size = size;
	log->min_count = min_count;
880
	log->trace_len = __save_stack_trace(log->trace);
C
Catalin Marinas 已提交
881 882 883 884
	crt_early_log++;
	local_irq_restore(flags);
}

885 886 887 888 889 890 891 892 893
/*
 * Log an early allocated block and populate the stack trace.
 */
static void early_alloc(struct early_log *log)
{
	struct kmemleak_object *object;
	unsigned long flags;
	int i;

894
	if (!kmemleak_enabled || !log->ptr || IS_ERR(log->ptr))
895 896 897 898 899 900 901
		return;

	/*
	 * RCU locking needed to ensure object is not freed via put_object().
	 */
	rcu_read_lock();
	object = create_object((unsigned long)log->ptr, log->size,
902
			       log->min_count, GFP_ATOMIC);
903 904
	if (!object)
		goto out;
905 906 907 908 909
	spin_lock_irqsave(&object->lock, flags);
	for (i = 0; i < log->trace_len; i++)
		object->trace[i] = log->trace[i];
	object->trace_len = log->trace_len;
	spin_unlock_irqrestore(&object->lock, flags);
910
out:
911 912 913
	rcu_read_unlock();
}

914 915 916 917 918 919 920 921 922 923 924 925 926 927
/*
 * Log an early allocated block and populate the stack trace.
 */
static void early_alloc_percpu(struct early_log *log)
{
	unsigned int cpu;
	const void __percpu *ptr = log->ptr;

	for_each_possible_cpu(cpu) {
		log->ptr = per_cpu_ptr(ptr, cpu);
		early_alloc(log);
	}
}

928 929 930 931 932 933 934 935 936 937 938 939
/**
 * kmemleak_alloc - register a newly allocated object
 * @ptr:	pointer to beginning of the object
 * @size:	size of the object
 * @min_count:	minimum number of references to this object. If during memory
 *		scanning a number of references less than @min_count is found,
 *		the object is reported as a memory leak. If @min_count is 0,
 *		the object is never reported as a leak. If @min_count is -1,
 *		the object is ignored (not scanned and not reported as a leak)
 * @gfp:	kmalloc() flags used for kmemleak internal memory allocations
 *
 * This function is called from the kernel allocators when a new object
940
 * (memory block) is allocated (kmem_cache_alloc, kmalloc etc.).
C
Catalin Marinas 已提交
941
 */
942 943
void __ref kmemleak_alloc(const void *ptr, size_t size, int min_count,
			  gfp_t gfp)
C
Catalin Marinas 已提交
944 945 946
{
	pr_debug("%s(0x%p, %zu, %d)\n", __func__, ptr, size, min_count);

947
	if (kmemleak_enabled && ptr && !IS_ERR(ptr))
C
Catalin Marinas 已提交
948
		create_object((unsigned long)ptr, size, min_count, gfp);
949
	else if (kmemleak_early_log)
950
		log_early(KMEMLEAK_ALLOC, ptr, size, min_count);
C
Catalin Marinas 已提交
951 952 953
}
EXPORT_SYMBOL_GPL(kmemleak_alloc);

954 955 956 957
/**
 * kmemleak_alloc_percpu - register a newly allocated __percpu object
 * @ptr:	__percpu pointer to beginning of the object
 * @size:	size of the object
958
 * @gfp:	flags used for kmemleak internal memory allocations
959 960
 *
 * This function is called from the kernel percpu allocator when a new object
961
 * (memory block) is allocated (alloc_percpu).
962
 */
963 964
void __ref kmemleak_alloc_percpu(const void __percpu *ptr, size_t size,
				 gfp_t gfp)
965 966 967 968 969 970 971 972 973
{
	unsigned int cpu;

	pr_debug("%s(0x%p, %zu)\n", __func__, ptr, size);

	/*
	 * Percpu allocations are only scanned and not reported as leaks
	 * (min_count is set to 0).
	 */
974
	if (kmemleak_enabled && ptr && !IS_ERR(ptr))
975 976
		for_each_possible_cpu(cpu)
			create_object((unsigned long)per_cpu_ptr(ptr, cpu),
977
				      size, 0, gfp);
978
	else if (kmemleak_early_log)
979 980 981 982
		log_early(KMEMLEAK_ALLOC_PERCPU, ptr, size, 0);
}
EXPORT_SYMBOL_GPL(kmemleak_alloc_percpu);

983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012
/**
 * kmemleak_vmalloc - register a newly vmalloc'ed object
 * @area:	pointer to vm_struct
 * @size:	size of the object
 * @gfp:	__vmalloc() flags used for kmemleak internal memory allocations
 *
 * This function is called from the vmalloc() kernel allocator when a new
 * object (memory block) is allocated.
 */
void __ref kmemleak_vmalloc(const struct vm_struct *area, size_t size, gfp_t gfp)
{
	pr_debug("%s(0x%p, %zu)\n", __func__, area, size);

	/*
	 * A min_count = 2 is needed because vm_struct contains a reference to
	 * the virtual address of the vmalloc'ed block.
	 */
	if (kmemleak_enabled) {
		create_object((unsigned long)area->addr, size, 2, gfp);
		object_set_excess_ref((unsigned long)area,
				      (unsigned long)area->addr);
	} else if (kmemleak_early_log) {
		log_early(KMEMLEAK_ALLOC, area->addr, size, 2);
		/* reusing early_log.size for storing area->addr */
		log_early(KMEMLEAK_SET_EXCESS_REF,
			  area, (unsigned long)area->addr, 0);
	}
}
EXPORT_SYMBOL_GPL(kmemleak_vmalloc);

1013 1014 1015 1016 1017 1018
/**
 * kmemleak_free - unregister a previously registered object
 * @ptr:	pointer to beginning of the object
 *
 * This function is called from the kernel allocators when an object (memory
 * block) is freed (kmem_cache_free, kfree, vfree etc.).
C
Catalin Marinas 已提交
1019
 */
1020
void __ref kmemleak_free(const void *ptr)
C
Catalin Marinas 已提交
1021 1022 1023
{
	pr_debug("%s(0x%p)\n", __func__, ptr);

1024
	if (kmemleak_free_enabled && ptr && !IS_ERR(ptr))
1025
		delete_object_full((unsigned long)ptr);
1026
	else if (kmemleak_early_log)
1027
		log_early(KMEMLEAK_FREE, ptr, 0, 0);
C
Catalin Marinas 已提交
1028 1029 1030
}
EXPORT_SYMBOL_GPL(kmemleak_free);

1031 1032 1033 1034 1035 1036 1037 1038
/**
 * kmemleak_free_part - partially unregister a previously registered object
 * @ptr:	pointer to the beginning or inside the object. This also
 *		represents the start of the range to be freed
 * @size:	size to be unregistered
 *
 * This function is called when only a part of a memory block is freed
 * (usually from the bootmem allocator).
1039
 */
1040
void __ref kmemleak_free_part(const void *ptr, size_t size)
1041 1042 1043
{
	pr_debug("%s(0x%p)\n", __func__, ptr);

1044
	if (kmemleak_enabled && ptr && !IS_ERR(ptr))
1045
		delete_object_part((unsigned long)ptr, size);
1046
	else if (kmemleak_early_log)
1047
		log_early(KMEMLEAK_FREE_PART, ptr, size, 0);
1048 1049 1050
}
EXPORT_SYMBOL_GPL(kmemleak_free_part);

1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063
/**
 * kmemleak_free_percpu - unregister a previously registered __percpu object
 * @ptr:	__percpu pointer to beginning of the object
 *
 * This function is called from the kernel percpu allocator when an object
 * (memory block) is freed (free_percpu).
 */
void __ref kmemleak_free_percpu(const void __percpu *ptr)
{
	unsigned int cpu;

	pr_debug("%s(0x%p)\n", __func__, ptr);

1064
	if (kmemleak_free_enabled && ptr && !IS_ERR(ptr))
1065 1066 1067
		for_each_possible_cpu(cpu)
			delete_object_full((unsigned long)per_cpu_ptr(ptr,
								      cpu));
1068
	else if (kmemleak_early_log)
1069 1070 1071 1072
		log_early(KMEMLEAK_FREE_PERCPU, ptr, 0, 0);
}
EXPORT_SYMBOL_GPL(kmemleak_free_percpu);

1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106
/**
 * kmemleak_update_trace - update object allocation stack trace
 * @ptr:	pointer to beginning of the object
 *
 * Override the object allocation stack trace for cases where the actual
 * allocation place is not always useful.
 */
void __ref kmemleak_update_trace(const void *ptr)
{
	struct kmemleak_object *object;
	unsigned long flags;

	pr_debug("%s(0x%p)\n", __func__, ptr);

	if (!kmemleak_enabled || IS_ERR_OR_NULL(ptr))
		return;

	object = find_and_get_object((unsigned long)ptr, 1);
	if (!object) {
#ifdef DEBUG
		kmemleak_warn("Updating stack trace for unknown object at %p\n",
			      ptr);
#endif
		return;
	}

	spin_lock_irqsave(&object->lock, flags);
	object->trace_len = __save_stack_trace(object->trace);
	spin_unlock_irqrestore(&object->lock, flags);

	put_object(object);
}
EXPORT_SYMBOL(kmemleak_update_trace);

1107 1108 1109 1110 1111 1112
/**
 * kmemleak_not_leak - mark an allocated object as false positive
 * @ptr:	pointer to beginning of the object
 *
 * Calling this function on an object will cause the memory block to no longer
 * be reported as leak and always be scanned.
C
Catalin Marinas 已提交
1113
 */
1114
void __ref kmemleak_not_leak(const void *ptr)
C
Catalin Marinas 已提交
1115 1116 1117
{
	pr_debug("%s(0x%p)\n", __func__, ptr);

1118
	if (kmemleak_enabled && ptr && !IS_ERR(ptr))
C
Catalin Marinas 已提交
1119
		make_gray_object((unsigned long)ptr);
1120
	else if (kmemleak_early_log)
1121
		log_early(KMEMLEAK_NOT_LEAK, ptr, 0, 0);
C
Catalin Marinas 已提交
1122 1123 1124
}
EXPORT_SYMBOL(kmemleak_not_leak);

1125 1126 1127 1128 1129 1130 1131 1132
/**
 * kmemleak_ignore - ignore an allocated object
 * @ptr:	pointer to beginning of the object
 *
 * Calling this function on an object will cause the memory block to be
 * ignored (not scanned and not reported as a leak). This is usually done when
 * it is known that the corresponding block is not a leak and does not contain
 * any references to other allocated memory blocks.
C
Catalin Marinas 已提交
1133
 */
1134
void __ref kmemleak_ignore(const void *ptr)
C
Catalin Marinas 已提交
1135 1136 1137
{
	pr_debug("%s(0x%p)\n", __func__, ptr);

1138
	if (kmemleak_enabled && ptr && !IS_ERR(ptr))
C
Catalin Marinas 已提交
1139
		make_black_object((unsigned long)ptr);
1140
	else if (kmemleak_early_log)
1141
		log_early(KMEMLEAK_IGNORE, ptr, 0, 0);
C
Catalin Marinas 已提交
1142 1143 1144
}
EXPORT_SYMBOL(kmemleak_ignore);

1145 1146 1147 1148 1149 1150 1151 1152 1153 1154
/**
 * kmemleak_scan_area - limit the range to be scanned in an allocated object
 * @ptr:	pointer to beginning or inside the object. This also
 *		represents the start of the scan area
 * @size:	size of the scan area
 * @gfp:	kmalloc() flags used for kmemleak internal memory allocations
 *
 * This function is used when it is known that only certain parts of an object
 * contain references to other objects. Kmemleak will only scan these areas
 * reducing the number false negatives.
C
Catalin Marinas 已提交
1155
 */
1156
void __ref kmemleak_scan_area(const void *ptr, size_t size, gfp_t gfp)
C
Catalin Marinas 已提交
1157 1158 1159
{
	pr_debug("%s(0x%p)\n", __func__, ptr);

1160
	if (kmemleak_enabled && ptr && size && !IS_ERR(ptr))
1161
		add_scan_area((unsigned long)ptr, size, gfp);
1162
	else if (kmemleak_early_log)
1163
		log_early(KMEMLEAK_SCAN_AREA, ptr, size, 0);
C
Catalin Marinas 已提交
1164 1165 1166
}
EXPORT_SYMBOL(kmemleak_scan_area);

1167 1168 1169 1170 1171 1172 1173 1174
/**
 * kmemleak_no_scan - do not scan an allocated object
 * @ptr:	pointer to beginning of the object
 *
 * This function notifies kmemleak not to scan the given memory block. Useful
 * in situations where it is known that the given object does not contain any
 * references to other objects. Kmemleak will not scan such objects reducing
 * the number of false negatives.
C
Catalin Marinas 已提交
1175
 */
1176
void __ref kmemleak_no_scan(const void *ptr)
C
Catalin Marinas 已提交
1177 1178 1179
{
	pr_debug("%s(0x%p)\n", __func__, ptr);

1180
	if (kmemleak_enabled && ptr && !IS_ERR(ptr))
C
Catalin Marinas 已提交
1181
		object_no_scan((unsigned long)ptr);
1182
	else if (kmemleak_early_log)
1183
		log_early(KMEMLEAK_NO_SCAN, ptr, 0, 0);
C
Catalin Marinas 已提交
1184 1185 1186
}
EXPORT_SYMBOL(kmemleak_no_scan);

1187 1188 1189
/**
 * kmemleak_alloc_phys - similar to kmemleak_alloc but taking a physical
 *			 address argument
1190 1191 1192 1193 1194
 * @phys:	physical address of the object
 * @size:	size of the object
 * @min_count:	minimum number of references to this object.
 *              See kmemleak_alloc()
 * @gfp:	kmalloc() flags used for kmemleak internal memory allocations
1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206
 */
void __ref kmemleak_alloc_phys(phys_addr_t phys, size_t size, int min_count,
			       gfp_t gfp)
{
	if (!IS_ENABLED(CONFIG_HIGHMEM) || PHYS_PFN(phys) < max_low_pfn)
		kmemleak_alloc(__va(phys), size, min_count, gfp);
}
EXPORT_SYMBOL(kmemleak_alloc_phys);

/**
 * kmemleak_free_part_phys - similar to kmemleak_free_part but taking a
 *			     physical address argument
1207 1208 1209
 * @phys:	physical address if the beginning or inside an object. This
 *		also represents the start of the range to be freed
 * @size:	size to be unregistered
1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220
 */
void __ref kmemleak_free_part_phys(phys_addr_t phys, size_t size)
{
	if (!IS_ENABLED(CONFIG_HIGHMEM) || PHYS_PFN(phys) < max_low_pfn)
		kmemleak_free_part(__va(phys), size);
}
EXPORT_SYMBOL(kmemleak_free_part_phys);

/**
 * kmemleak_not_leak_phys - similar to kmemleak_not_leak but taking a physical
 *			    address argument
1221
 * @phys:	physical address of the object
1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232
 */
void __ref kmemleak_not_leak_phys(phys_addr_t phys)
{
	if (!IS_ENABLED(CONFIG_HIGHMEM) || PHYS_PFN(phys) < max_low_pfn)
		kmemleak_not_leak(__va(phys));
}
EXPORT_SYMBOL(kmemleak_not_leak_phys);

/**
 * kmemleak_ignore_phys - similar to kmemleak_ignore but taking a physical
 *			  address argument
1233
 * @phys:	physical address of the object
1234 1235 1236 1237 1238 1239 1240 1241
 */
void __ref kmemleak_ignore_phys(phys_addr_t phys)
{
	if (!IS_ENABLED(CONFIG_HIGHMEM) || PHYS_PFN(phys) < max_low_pfn)
		kmemleak_ignore(__va(phys));
}
EXPORT_SYMBOL(kmemleak_ignore_phys);

1242 1243 1244 1245 1246 1247 1248
/*
 * Update an object's checksum and return true if it was modified.
 */
static bool update_checksum(struct kmemleak_object *object)
{
	u32 old_csum = object->checksum;

1249
	kasan_disable_current();
1250
	object->checksum = crc32(0, (void *)object->pointer, object->size);
1251 1252
	kasan_enable_current();

1253 1254 1255
	return object->checksum != old_csum;
}

1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279
/*
 * Update an object's references. object->lock must be held by the caller.
 */
static void update_refs(struct kmemleak_object *object)
{
	if (!color_white(object)) {
		/* non-orphan, ignored or new */
		return;
	}

	/*
	 * Increase the object's reference count (number of pointers to the
	 * memory block). If this count reaches the required minimum, the
	 * object's color will become gray and it will be added to the
	 * gray_list.
	 */
	object->count++;
	if (color_gray(object)) {
		/* put_object() called when removing from gray_list */
		WARN_ON(!get_object(object));
		list_add_tail(&object->gray_list, &gray_list);
	}
}

C
Catalin Marinas 已提交
1280 1281
/*
 * Memory scanning is a long process and it needs to be interruptable. This
L
Lucas De Marchi 已提交
1282
 * function checks whether such interrupt condition occurred.
C
Catalin Marinas 已提交
1283 1284 1285
 */
static int scan_should_stop(void)
{
1286
	if (!kmemleak_enabled)
C
Catalin Marinas 已提交
1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305
		return 1;

	/*
	 * This function may be called from either process or kthread context,
	 * hence the need to check for both stop conditions.
	 */
	if (current->mm)
		return signal_pending(current);
	else
		return kthread_should_stop();

	return 0;
}

/*
 * Scan a memory block (exclusive range) for valid pointers and add those
 * found to the gray list.
 */
static void scan_block(void *_start, void *_end,
1306
		       struct kmemleak_object *scanned)
C
Catalin Marinas 已提交
1307 1308 1309 1310
{
	unsigned long *ptr;
	unsigned long *start = PTR_ALIGN(_start, BYTES_PER_POINTER);
	unsigned long *end = _end - (BYTES_PER_POINTER - 1);
1311
	unsigned long flags;
C
Catalin Marinas 已提交
1312

1313
	read_lock_irqsave(&kmemleak_lock, flags);
C
Catalin Marinas 已提交
1314 1315
	for (ptr = start; ptr < end; ptr++) {
		struct kmemleak_object *object;
1316
		unsigned long pointer;
1317
		unsigned long excess_ref;
C
Catalin Marinas 已提交
1318 1319 1320 1321

		if (scan_should_stop())
			break;

1322
		kasan_disable_current();
1323
		pointer = *ptr;
1324
		kasan_enable_current();
1325

1326 1327 1328 1329 1330 1331 1332 1333 1334 1335
		if (pointer < min_addr || pointer >= max_addr)
			continue;

		/*
		 * No need for get_object() here since we hold kmemleak_lock.
		 * object->use_count cannot be dropped to 0 while the object
		 * is still present in object_tree_root and object_list
		 * (with updates protected by kmemleak_lock).
		 */
		object = lookup_object(pointer, 1);
C
Catalin Marinas 已提交
1336 1337
		if (!object)
			continue;
1338
		if (object == scanned)
C
Catalin Marinas 已提交
1339 1340 1341 1342 1343 1344 1345 1346
			/* self referenced, ignore */
			continue;

		/*
		 * Avoid the lockdep recursive warning on object->lock being
		 * previously acquired in scan_object(). These locks are
		 * enclosed by scan_mutex.
		 */
1347
		spin_lock_nested(&object->lock, SINGLE_DEPTH_NESTING);
1348 1349 1350 1351 1352 1353 1354 1355
		/* only pass surplus references (object already gray) */
		if (color_gray(object)) {
			excess_ref = object->excess_ref;
			/* no need for update_refs() if object already gray */
		} else {
			excess_ref = 0;
			update_refs(object);
		}
1356
		spin_unlock(&object->lock);
1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368

		if (excess_ref) {
			object = lookup_object(excess_ref, 0);
			if (!object)
				continue;
			if (object == scanned)
				/* circular reference, ignore */
				continue;
			spin_lock_nested(&object->lock, SINGLE_DEPTH_NESTING);
			update_refs(object);
			spin_unlock(&object->lock);
		}
1369 1370 1371
	}
	read_unlock_irqrestore(&kmemleak_lock, flags);
}
1372

1373 1374 1375
/*
 * Scan a large memory block in MAX_SCAN_SIZE chunks to reduce the latency.
 */
1376
#ifdef CONFIG_SMP
1377 1378 1379 1380 1381 1382 1383 1384 1385
static void scan_large_block(void *start, void *end)
{
	void *next;

	while (start < end) {
		next = min(start + MAX_SCAN_SIZE, end);
		scan_block(start, next, NULL);
		start = next;
		cond_resched();
C
Catalin Marinas 已提交
1386 1387
	}
}
1388
#endif
C
Catalin Marinas 已提交
1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399

/*
 * Scan a memory block corresponding to a kmemleak_object. A condition is
 * that object->use_count >= 1.
 */
static void scan_object(struct kmemleak_object *object)
{
	struct kmemleak_scan_area *area;
	unsigned long flags;

	/*
1400 1401
	 * Once the object->lock is acquired, the corresponding memory block
	 * cannot be freed (the same lock is acquired in delete_object).
C
Catalin Marinas 已提交
1402 1403 1404 1405 1406 1407 1408
	 */
	spin_lock_irqsave(&object->lock, flags);
	if (object->flags & OBJECT_NO_SCAN)
		goto out;
	if (!(object->flags & OBJECT_ALLOCATED))
		/* already freed object */
		goto out;
1409 1410 1411
	if (hlist_empty(&object->area_list)) {
		void *start = (void *)object->pointer;
		void *end = (void *)(object->pointer + object->size);
1412 1413 1414 1415 1416
		void *next;

		do {
			next = min(start + MAX_SCAN_SIZE, end);
			scan_block(start, next, object);
1417

1418 1419 1420
			start = next;
			if (start >= end)
				break;
1421 1422 1423 1424

			spin_unlock_irqrestore(&object->lock, flags);
			cond_resched();
			spin_lock_irqsave(&object->lock, flags);
1425
		} while (object->flags & OBJECT_ALLOCATED);
1426
	} else
1427
		hlist_for_each_entry(area, &object->area_list, node)
1428 1429
			scan_block((void *)area->start,
				   (void *)(area->start + area->size),
1430
				   object);
C
Catalin Marinas 已提交
1431 1432 1433 1434
out:
	spin_unlock_irqrestore(&object->lock, flags);
}

1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467
/*
 * Scan the objects already referenced (gray objects). More objects will be
 * referenced and, if there are no memory leaks, all the objects are scanned.
 */
static void scan_gray_list(void)
{
	struct kmemleak_object *object, *tmp;

	/*
	 * The list traversal is safe for both tail additions and removals
	 * from inside the loop. The kmemleak objects cannot be freed from
	 * outside the loop because their use_count was incremented.
	 */
	object = list_entry(gray_list.next, typeof(*object), gray_list);
	while (&object->gray_list != &gray_list) {
		cond_resched();

		/* may add new objects to the list */
		if (!scan_should_stop())
			scan_object(object);

		tmp = list_entry(object->gray_list.next, typeof(*object),
				 gray_list);

		/* remove the object from the list and release it */
		list_del(&object->gray_list);
		put_object(object);

		object = tmp;
	}
	WARN_ON(!list_empty(&gray_list));
}

C
Catalin Marinas 已提交
1468 1469 1470 1471 1472 1473 1474 1475
/*
 * Scan data sections and all the referenced memory blocks allocated via the
 * kernel's standard allocators. This function must be called with the
 * scan_mutex held.
 */
static void kmemleak_scan(void)
{
	unsigned long flags;
1476
	struct kmemleak_object *object;
C
Catalin Marinas 已提交
1477
	int i;
1478
	int new_leaks = 0;
C
Catalin Marinas 已提交
1479

1480 1481
	jiffies_last_scan = jiffies;

C
Catalin Marinas 已提交
1482 1483 1484 1485 1486 1487 1488 1489 1490 1491
	/* prepare the kmemleak_object's */
	rcu_read_lock();
	list_for_each_entry_rcu(object, &object_list, object_list) {
		spin_lock_irqsave(&object->lock, flags);
#ifdef DEBUG
		/*
		 * With a few exceptions there should be a maximum of
		 * 1 reference to any object at this point.
		 */
		if (atomic_read(&object->use_count) > 1) {
J
Joe Perches 已提交
1492
			pr_debug("object->use_count = %d\n",
C
Catalin Marinas 已提交
1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508
				 atomic_read(&object->use_count));
			dump_object_info(object);
		}
#endif
		/* reset the reference count (whiten the object) */
		object->count = 0;
		if (color_gray(object) && get_object(object))
			list_add_tail(&object->gray_list, &gray_list);

		spin_unlock_irqrestore(&object->lock, flags);
	}
	rcu_read_unlock();

#ifdef CONFIG_SMP
	/* per-cpu sections scanning */
	for_each_possible_cpu(i)
1509 1510
		scan_large_block(__per_cpu_start + per_cpu_offset(i),
				 __per_cpu_end + per_cpu_offset(i));
C
Catalin Marinas 已提交
1511 1512 1513
#endif

	/*
1514
	 * Struct page scanning for each node.
C
Catalin Marinas 已提交
1515
	 */
1516
	get_online_mems();
C
Catalin Marinas 已提交
1517
	for_each_online_node(i) {
1518 1519
		unsigned long start_pfn = node_start_pfn(i);
		unsigned long end_pfn = node_end_pfn(i);
C
Catalin Marinas 已提交
1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530
		unsigned long pfn;

		for (pfn = start_pfn; pfn < end_pfn; pfn++) {
			struct page *page;

			if (!pfn_valid(pfn))
				continue;
			page = pfn_to_page(pfn);
			/* only scan if page is in use */
			if (page_count(page) == 0)
				continue;
1531
			scan_block(page, page + 1, NULL);
1532
			if (!(pfn & 63))
1533
				cond_resched();
C
Catalin Marinas 已提交
1534 1535
		}
	}
1536
	put_online_mems();
C
Catalin Marinas 已提交
1537 1538

	/*
1539
	 * Scanning the task stacks (may introduce false negatives).
C
Catalin Marinas 已提交
1540 1541
	 */
	if (kmemleak_stack_scan) {
1542 1543
		struct task_struct *p, *g;

C
Catalin Marinas 已提交
1544
		read_lock(&tasklist_lock);
1545
		do_each_thread(g, p) {
1546 1547 1548 1549 1550
			void *stack = try_get_task_stack(p);
			if (stack) {
				scan_block(stack, stack + THREAD_SIZE, NULL);
				put_task_stack(p);
			}
1551
		} while_each_thread(g, p);
C
Catalin Marinas 已提交
1552 1553 1554 1555 1556
		read_unlock(&tasklist_lock);
	}

	/*
	 * Scan the objects already referenced from the sections scanned
1557
	 * above.
C
Catalin Marinas 已提交
1558
	 */
1559
	scan_gray_list();
1560 1561

	/*
1562 1563
	 * Check for new or unreferenced objects modified since the previous
	 * scan and color them gray until the next scan.
1564 1565 1566 1567
	 */
	rcu_read_lock();
	list_for_each_entry_rcu(object, &object_list, object_list) {
		spin_lock_irqsave(&object->lock, flags);
1568 1569 1570 1571
		if (color_white(object) && (object->flags & OBJECT_ALLOCATED)
		    && update_checksum(object) && get_object(object)) {
			/* color it gray temporarily */
			object->count = object->min_count;
1572 1573 1574 1575 1576 1577
			list_add_tail(&object->gray_list, &gray_list);
		}
		spin_unlock_irqrestore(&object->lock, flags);
	}
	rcu_read_unlock();

1578 1579 1580 1581
	/*
	 * Re-scan the gray list for modified unreferenced objects.
	 */
	scan_gray_list();
1582

1583
	/*
1584
	 * If scanning was stopped do not report any new unreferenced objects.
1585
	 */
1586
	if (scan_should_stop())
1587 1588
		return;

1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603
	/*
	 * Scanning result reporting.
	 */
	rcu_read_lock();
	list_for_each_entry_rcu(object, &object_list, object_list) {
		spin_lock_irqsave(&object->lock, flags);
		if (unreferenced_object(object) &&
		    !(object->flags & OBJECT_REPORTED)) {
			object->flags |= OBJECT_REPORTED;
			new_leaks++;
		}
		spin_unlock_irqrestore(&object->lock, flags);
	}
	rcu_read_unlock();

1604 1605 1606
	if (new_leaks) {
		kmemleak_found_leaks = true;

J
Joe Perches 已提交
1607 1608
		pr_info("%d new suspected memory leaks (see /sys/kernel/debug/kmemleak)\n",
			new_leaks);
1609
	}
1610

C
Catalin Marinas 已提交
1611 1612 1613 1614 1615 1616 1617 1618 1619 1620
}

/*
 * Thread function performing automatic memory scanning. Unreferenced objects
 * at the end of a memory scan are reported but only the first time.
 */
static int kmemleak_scan_thread(void *arg)
{
	static int first_run = 1;

J
Joe Perches 已提交
1621
	pr_info("Automatic memory scanning thread started\n");
1622
	set_user_nice(current, 10);
C
Catalin Marinas 已提交
1623 1624 1625 1626 1627

	/*
	 * Wait before the first scan to allow the system to fully initialize.
	 */
	if (first_run) {
1628
		signed long timeout = msecs_to_jiffies(SECS_FIRST_SCAN * 1000);
C
Catalin Marinas 已提交
1629
		first_run = 0;
1630 1631
		while (timeout && !kthread_should_stop())
			timeout = schedule_timeout_interruptible(timeout);
C
Catalin Marinas 已提交
1632 1633 1634 1635 1636 1637 1638 1639
	}

	while (!kthread_should_stop()) {
		signed long timeout = jiffies_scan_wait;

		mutex_lock(&scan_mutex);
		kmemleak_scan();
		mutex_unlock(&scan_mutex);
1640

C
Catalin Marinas 已提交
1641 1642 1643 1644 1645
		/* wait before the next scan */
		while (timeout && !kthread_should_stop())
			timeout = schedule_timeout_interruptible(timeout);
	}

J
Joe Perches 已提交
1646
	pr_info("Automatic memory scanning thread ended\n");
C
Catalin Marinas 已提交
1647 1648 1649 1650 1651 1652

	return 0;
}

/*
 * Start the automatic memory scanning thread. This function must be called
1653
 * with the scan_mutex held.
C
Catalin Marinas 已提交
1654
 */
1655
static void start_scan_thread(void)
C
Catalin Marinas 已提交
1656 1657 1658 1659 1660
{
	if (scan_thread)
		return;
	scan_thread = kthread_run(kmemleak_scan_thread, NULL, "kmemleak");
	if (IS_ERR(scan_thread)) {
J
Joe Perches 已提交
1661
		pr_warn("Failed to create the scan thread\n");
C
Catalin Marinas 已提交
1662 1663 1664 1665 1666
		scan_thread = NULL;
	}
}

/*
1667
 * Stop the automatic memory scanning thread.
C
Catalin Marinas 已提交
1668
 */
1669
static void stop_scan_thread(void)
C
Catalin Marinas 已提交
1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685
{
	if (scan_thread) {
		kthread_stop(scan_thread);
		scan_thread = NULL;
	}
}

/*
 * Iterate over the object_list and return the first valid object at or after
 * the required position with its use_count incremented. The function triggers
 * a memory scanning when the pos argument points to the first position.
 */
static void *kmemleak_seq_start(struct seq_file *seq, loff_t *pos)
{
	struct kmemleak_object *object;
	loff_t n = *pos;
1686 1687 1688 1689 1690
	int err;

	err = mutex_lock_interruptible(&scan_mutex);
	if (err < 0)
		return ERR_PTR(err);
C
Catalin Marinas 已提交
1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711

	rcu_read_lock();
	list_for_each_entry_rcu(object, &object_list, object_list) {
		if (n-- > 0)
			continue;
		if (get_object(object))
			goto out;
	}
	object = NULL;
out:
	return object;
}

/*
 * Return the next object in the object_list. The function decrements the
 * use_count of the previous object and increases that of the next one.
 */
static void *kmemleak_seq_next(struct seq_file *seq, void *v, loff_t *pos)
{
	struct kmemleak_object *prev_obj = v;
	struct kmemleak_object *next_obj = NULL;
1712
	struct kmemleak_object *obj = prev_obj;
C
Catalin Marinas 已提交
1713 1714 1715

	++(*pos);

1716
	list_for_each_entry_continue_rcu(obj, &object_list, object_list) {
1717 1718
		if (get_object(obj)) {
			next_obj = obj;
C
Catalin Marinas 已提交
1719
			break;
1720
		}
C
Catalin Marinas 已提交
1721
	}
1722

C
Catalin Marinas 已提交
1723 1724 1725 1726 1727 1728 1729 1730 1731
	put_object(prev_obj);
	return next_obj;
}

/*
 * Decrement the use_count of the last object required, if any.
 */
static void kmemleak_seq_stop(struct seq_file *seq, void *v)
{
1732 1733 1734 1735 1736
	if (!IS_ERR(v)) {
		/*
		 * kmemleak_seq_start may return ERR_PTR if the scan_mutex
		 * waiting was interrupted, so only release it if !IS_ERR.
		 */
1737
		rcu_read_unlock();
1738 1739 1740 1741
		mutex_unlock(&scan_mutex);
		if (v)
			put_object(v);
	}
C
Catalin Marinas 已提交
1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752
}

/*
 * Print the information for an unreferenced object to the seq file.
 */
static int kmemleak_seq_show(struct seq_file *seq, void *v)
{
	struct kmemleak_object *object = v;
	unsigned long flags;

	spin_lock_irqsave(&object->lock, flags);
1753
	if ((object->flags & OBJECT_REPORTED) && unreferenced_object(object))
1754
		print_unreferenced(seq, object);
C
Catalin Marinas 已提交
1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767
	spin_unlock_irqrestore(&object->lock, flags);
	return 0;
}

static const struct seq_operations kmemleak_seq_ops = {
	.start = kmemleak_seq_start,
	.next  = kmemleak_seq_next,
	.stop  = kmemleak_seq_stop,
	.show  = kmemleak_seq_show,
};

static int kmemleak_open(struct inode *inode, struct file *file)
{
1768
	return seq_open(file, &kmemleak_seq_ops);
C
Catalin Marinas 已提交
1769 1770
}

1771 1772 1773 1774 1775 1776
static int dump_str_object_info(const char *str)
{
	unsigned long flags;
	struct kmemleak_object *object;
	unsigned long addr;

1777 1778
	if (kstrtoul(str, 0, &addr))
		return -EINVAL;
1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792
	object = find_and_get_object(addr, 0);
	if (!object) {
		pr_info("Unknown object at 0x%08lx\n", addr);
		return -EINVAL;
	}

	spin_lock_irqsave(&object->lock, flags);
	dump_object_info(object);
	spin_unlock_irqrestore(&object->lock, flags);

	put_object(object);
	return 0;
}

1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808
/*
 * We use grey instead of black to ensure we can do future scans on the same
 * objects. If we did not do future scans these black objects could
 * potentially contain references to newly allocated objects in the future and
 * we'd end up with false positives.
 */
static void kmemleak_clear(void)
{
	struct kmemleak_object *object;
	unsigned long flags;

	rcu_read_lock();
	list_for_each_entry_rcu(object, &object_list, object_list) {
		spin_lock_irqsave(&object->lock, flags);
		if ((object->flags & OBJECT_REPORTED) &&
		    unreferenced_object(object))
1809
			__paint_it(object, KMEMLEAK_GREY);
1810 1811 1812
		spin_unlock_irqrestore(&object->lock, flags);
	}
	rcu_read_unlock();
1813 1814

	kmemleak_found_leaks = false;
1815 1816
}

1817 1818
static void __kmemleak_do_cleanup(void);

C
Catalin Marinas 已提交
1819 1820 1821 1822 1823 1824 1825 1826 1827 1828
/*
 * File write operation to configure kmemleak at run-time. The following
 * commands can be written to the /sys/kernel/debug/kmemleak file:
 *   off	- disable kmemleak (irreversible)
 *   stack=on	- enable the task stacks scanning
 *   stack=off	- disable the tasks stacks scanning
 *   scan=on	- start the automatic memory scanning thread
 *   scan=off	- stop the automatic memory scanning thread
 *   scan=...	- set the automatic memory scanning period in seconds (0 to
 *		  disable it)
1829
 *   scan	- trigger a memory scan
1830
 *   clear	- mark all current reported unreferenced kmemleak objects as
1831 1832
 *		  grey to ignore printing them, or free all kmemleak objects
 *		  if kmemleak has been disabled.
1833
 *   dump=...	- dump information about the object found at the given address
C
Catalin Marinas 已提交
1834 1835 1836 1837 1838 1839
 */
static ssize_t kmemleak_write(struct file *file, const char __user *user_buf,
			      size_t size, loff_t *ppos)
{
	char buf[64];
	int buf_size;
1840
	int ret;
C
Catalin Marinas 已提交
1841 1842 1843 1844 1845 1846

	buf_size = min(size, (sizeof(buf) - 1));
	if (strncpy_from_user(buf, user_buf, buf_size) < 0)
		return -EFAULT;
	buf[buf_size] = 0;

1847 1848 1849 1850
	ret = mutex_lock_interruptible(&scan_mutex);
	if (ret < 0)
		return ret;

1851
	if (strncmp(buf, "clear", 5) == 0) {
1852
		if (kmemleak_enabled)
1853 1854 1855 1856 1857 1858
			kmemleak_clear();
		else
			__kmemleak_do_cleanup();
		goto out;
	}

1859
	if (!kmemleak_enabled) {
1860 1861 1862 1863
		ret = -EBUSY;
		goto out;
	}

C
Catalin Marinas 已提交
1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876
	if (strncmp(buf, "off", 3) == 0)
		kmemleak_disable();
	else if (strncmp(buf, "stack=on", 8) == 0)
		kmemleak_stack_scan = 1;
	else if (strncmp(buf, "stack=off", 9) == 0)
		kmemleak_stack_scan = 0;
	else if (strncmp(buf, "scan=on", 7) == 0)
		start_scan_thread();
	else if (strncmp(buf, "scan=off", 8) == 0)
		stop_scan_thread();
	else if (strncmp(buf, "scan=", 5) == 0) {
		unsigned long secs;

1877
		ret = kstrtoul(buf + 5, 0, &secs);
1878 1879
		if (ret < 0)
			goto out;
C
Catalin Marinas 已提交
1880 1881 1882 1883 1884
		stop_scan_thread();
		if (secs) {
			jiffies_scan_wait = msecs_to_jiffies(secs * 1000);
			start_scan_thread();
		}
1885 1886
	} else if (strncmp(buf, "scan", 4) == 0)
		kmemleak_scan();
1887 1888
	else if (strncmp(buf, "dump=", 5) == 0)
		ret = dump_str_object_info(buf + 5);
1889
	else
1890 1891 1892 1893 1894 1895
		ret = -EINVAL;

out:
	mutex_unlock(&scan_mutex);
	if (ret < 0)
		return ret;
C
Catalin Marinas 已提交
1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907

	/* ignore the rest of the buffer, only one command at a time */
	*ppos += size;
	return size;
}

static const struct file_operations kmemleak_fops = {
	.owner		= THIS_MODULE,
	.open		= kmemleak_open,
	.read		= seq_read,
	.write		= kmemleak_write,
	.llseek		= seq_lseek,
L
Li Zefan 已提交
1908
	.release	= seq_release,
C
Catalin Marinas 已提交
1909 1910
};

1911 1912 1913 1914 1915 1916 1917 1918 1919 1920
static void __kmemleak_do_cleanup(void)
{
	struct kmemleak_object *object;

	rcu_read_lock();
	list_for_each_entry_rcu(object, &object_list, object_list)
		delete_object_full(object->pointer);
	rcu_read_unlock();
}

C
Catalin Marinas 已提交
1921
/*
1922 1923 1924
 * Stop the memory scanning thread and free the kmemleak internal objects if
 * no previous scan thread (otherwise, kmemleak may still have some useful
 * information on memory leaks).
C
Catalin Marinas 已提交
1925
 */
1926
static void kmemleak_do_cleanup(struct work_struct *work)
C
Catalin Marinas 已提交
1927 1928 1929
{
	stop_scan_thread();

1930
	mutex_lock(&scan_mutex);
1931
	/*
1932 1933 1934 1935
	 * Once it is made sure that kmemleak_scan has stopped, it is safe to no
	 * longer track object freeing. Ordering of the scan thread stopping and
	 * the memory accesses below is guaranteed by the kthread_stop()
	 * function.
1936 1937
	 */
	kmemleak_free_enabled = 0;
1938
	mutex_unlock(&scan_mutex);
1939

1940 1941 1942
	if (!kmemleak_found_leaks)
		__kmemleak_do_cleanup();
	else
J
Joe Perches 已提交
1943
		pr_info("Kmemleak disabled without freeing internal data. Reclaim the memory with \"echo clear > /sys/kernel/debug/kmemleak\".\n");
C
Catalin Marinas 已提交
1944 1945
}

1946
static DECLARE_WORK(cleanup_work, kmemleak_do_cleanup);
C
Catalin Marinas 已提交
1947 1948 1949 1950 1951 1952 1953 1954

/*
 * Disable kmemleak. No memory allocation/freeing will be traced once this
 * function is called. Disabling kmemleak is an irreversible operation.
 */
static void kmemleak_disable(void)
{
	/* atomically check whether it was already invoked */
1955
	if (cmpxchg(&kmemleak_error, 0, 1))
C
Catalin Marinas 已提交
1956 1957 1958
		return;

	/* stop any memory operation tracing */
1959
	kmemleak_enabled = 0;
C
Catalin Marinas 已提交
1960 1961

	/* check whether it is too early for a kernel thread */
1962
	if (kmemleak_initialized)
1963
		schedule_work(&cleanup_work);
1964 1965
	else
		kmemleak_free_enabled = 0;
C
Catalin Marinas 已提交
1966 1967 1968 1969 1970 1971 1972

	pr_info("Kernel memory leak detector disabled\n");
}

/*
 * Allow boot-time kmemleak disabling (enabled by default).
 */
1973
static int __init kmemleak_boot_config(char *str)
C
Catalin Marinas 已提交
1974 1975 1976 1977 1978
{
	if (!str)
		return -EINVAL;
	if (strcmp(str, "off") == 0)
		kmemleak_disable();
1979 1980 1981
	else if (strcmp(str, "on") == 0)
		kmemleak_skip_disable = 1;
	else
C
Catalin Marinas 已提交
1982 1983 1984 1985 1986
		return -EINVAL;
	return 0;
}
early_param("kmemleak", kmemleak_boot_config);

1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997
static void __init print_log_trace(struct early_log *log)
{
	struct stack_trace trace;

	trace.nr_entries = log->trace_len;
	trace.entries = log->trace;

	pr_notice("Early log backtrace:\n");
	print_stack_trace(&trace, 2);
}

C
Catalin Marinas 已提交
1998
/*
1999
 * Kmemleak initialization.
C
Catalin Marinas 已提交
2000 2001 2002 2003 2004 2005
 */
void __init kmemleak_init(void)
{
	int i;
	unsigned long flags;

2006 2007
#ifdef CONFIG_DEBUG_KMEMLEAK_DEFAULT_OFF
	if (!kmemleak_skip_disable) {
2008
		kmemleak_early_log = 0;
2009 2010 2011 2012 2013
		kmemleak_disable();
		return;
	}
#endif

C
Catalin Marinas 已提交
2014 2015 2016 2017 2018 2019
	jiffies_min_age = msecs_to_jiffies(MSECS_MIN_AGE);
	jiffies_scan_wait = msecs_to_jiffies(SECS_SCAN_WAIT * 1000);

	object_cache = KMEM_CACHE(kmemleak_object, SLAB_NOLEAKTRACE);
	scan_area_cache = KMEM_CACHE(kmemleak_scan_area, SLAB_NOLEAKTRACE);

2020
	if (crt_early_log > ARRAY_SIZE(early_log))
J
Joe Perches 已提交
2021 2022
		pr_warn("Early log buffer exceeded (%d), please increase DEBUG_KMEMLEAK_EARLY_LOG_SIZE\n",
			crt_early_log);
2023

C
Catalin Marinas 已提交
2024 2025
	/* the kernel is still in UP mode, so disabling the IRQs is enough */
	local_irq_save(flags);
2026
	kmemleak_early_log = 0;
2027
	if (kmemleak_error) {
2028 2029
		local_irq_restore(flags);
		return;
2030
	} else {
2031
		kmemleak_enabled = 1;
2032 2033
		kmemleak_free_enabled = 1;
	}
C
Catalin Marinas 已提交
2034
	local_irq_restore(flags);
2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045

	/* register the data/bss sections */
	create_object((unsigned long)_sdata, _edata - _sdata,
		      KMEMLEAK_GREY, GFP_ATOMIC);
	create_object((unsigned long)__bss_start, __bss_stop - __bss_start,
		      KMEMLEAK_GREY, GFP_ATOMIC);
	/* only register .data..ro_after_init if not within .data */
	if (__start_ro_after_init < _sdata || __end_ro_after_init > _edata)
		create_object((unsigned long)__start_ro_after_init,
			      __end_ro_after_init - __start_ro_after_init,
			      KMEMLEAK_GREY, GFP_ATOMIC);
C
Catalin Marinas 已提交
2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056

	/*
	 * This is the point where tracking allocations is safe. Automatic
	 * scanning is started during the late initcall. Add the early logged
	 * callbacks to the kmemleak infrastructure.
	 */
	for (i = 0; i < crt_early_log; i++) {
		struct early_log *log = &early_log[i];

		switch (log->op_type) {
		case KMEMLEAK_ALLOC:
2057
			early_alloc(log);
C
Catalin Marinas 已提交
2058
			break;
2059 2060 2061
		case KMEMLEAK_ALLOC_PERCPU:
			early_alloc_percpu(log);
			break;
C
Catalin Marinas 已提交
2062 2063 2064
		case KMEMLEAK_FREE:
			kmemleak_free(log->ptr);
			break;
2065 2066 2067
		case KMEMLEAK_FREE_PART:
			kmemleak_free_part(log->ptr, log->size);
			break;
2068 2069 2070
		case KMEMLEAK_FREE_PERCPU:
			kmemleak_free_percpu(log->ptr);
			break;
C
Catalin Marinas 已提交
2071 2072 2073 2074 2075 2076 2077
		case KMEMLEAK_NOT_LEAK:
			kmemleak_not_leak(log->ptr);
			break;
		case KMEMLEAK_IGNORE:
			kmemleak_ignore(log->ptr);
			break;
		case KMEMLEAK_SCAN_AREA:
2078
			kmemleak_scan_area(log->ptr, log->size, GFP_KERNEL);
C
Catalin Marinas 已提交
2079 2080 2081 2082
			break;
		case KMEMLEAK_NO_SCAN:
			kmemleak_no_scan(log->ptr);
			break;
2083 2084 2085 2086
		case KMEMLEAK_SET_EXCESS_REF:
			object_set_excess_ref((unsigned long)log->ptr,
					      log->excess_ref);
			break;
C
Catalin Marinas 已提交
2087
		default:
2088 2089 2090 2091
			kmemleak_warn("Unknown early log operation: %d\n",
				      log->op_type);
		}

2092
		if (kmemleak_warning) {
2093
			print_log_trace(log);
2094
			kmemleak_warning = 0;
C
Catalin Marinas 已提交
2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105
		}
	}
}

/*
 * Late initialization function.
 */
static int __init kmemleak_late_init(void)
{
	struct dentry *dentry;

2106
	kmemleak_initialized = 1;
C
Catalin Marinas 已提交
2107

2108 2109 2110 2111 2112
	dentry = debugfs_create_file("kmemleak", 0644, NULL, NULL,
				     &kmemleak_fops);
	if (!dentry)
		pr_warn("Failed to create the debugfs kmemleak file\n");

2113
	if (kmemleak_error) {
C
Catalin Marinas 已提交
2114
		/*
L
Lucas De Marchi 已提交
2115
		 * Some error occurred and kmemleak was disabled. There is a
C
Catalin Marinas 已提交
2116 2117 2118 2119
		 * small chance that kmemleak_disable() was called immediately
		 * after setting kmemleak_initialized and we may end up with
		 * two clean-up threads but serialized by scan_mutex.
		 */
2120
		schedule_work(&cleanup_work);
C
Catalin Marinas 已提交
2121 2122 2123
		return -ENOMEM;
	}

2124
	mutex_lock(&scan_mutex);
C
Catalin Marinas 已提交
2125
	start_scan_thread();
2126
	mutex_unlock(&scan_mutex);
C
Catalin Marinas 已提交
2127 2128 2129 2130 2131 2132

	pr_info("Kernel memory leak detector initialized\n");

	return 0;
}
late_initcall(kmemleak_late_init);