Blame view

mm/kmemleak.c 47.5 KB
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
  /*
   * 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
   * Documentation/kmemleak.txt.
   *
   * 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
   *   blocks. The object_tree_root is a priority search tree used to look-up
   *   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
4698c1f2b   Catalin Marinas   kmemleak: Do not ...
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
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
55
56
57
58
59
60
61
62
   *
   * 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.
   */
ae281064b   Joe Perches   kmemleak: use pr_fmt
63
  #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
  #include <linux/init.h>
  #include <linux/kernel.h>
  #include <linux/list.h>
  #include <linux/sched.h>
  #include <linux/jiffies.h>
  #include <linux/delay.h>
  #include <linux/module.h>
  #include <linux/kthread.h>
  #include <linux/prio_tree.h>
  #include <linux/gfp.h>
  #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>
  #include <linux/hardirq.h>
  #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>
179a8100e   Catalin Marinas   kmemleak: Do no c...
93
  #include <linux/workqueue.h>
04609ccc4   Catalin Marinas   kmemleak: Reduce ...
94
  #include <linux/crc32.h>
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
95
96
97
98
  
  #include <asm/sections.h>
  #include <asm/processor.h>
  #include <asm/atomic.h>
8e019366b   Pekka Enberg   kmemleak: Don't s...
99
  #include <linux/kmemcheck.h>
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
100
101
102
103
104
105
  #include <linux/kmemleak.h>
  
  /*
   * Kmemleak configuration and common defines.
   */
  #define MAX_TRACE		16	/* stack trace length */
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
106
  #define MSECS_MIN_AGE		5000	/* minimum object age for reporting */
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
107
108
  #define SECS_FIRST_SCAN		60	/* delay before the first scan */
  #define SECS_SCAN_WAIT		600	/* subsequent auto scanning delay */
af98603da   Catalin Marinas   kmemleak: Allow r...
109
  #define MAX_SCAN_SIZE		4096	/* maximum size of a scanned block */
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
110
111
  
  #define BYTES_PER_POINTER	sizeof(void *)
216c04b0d   Catalin Marinas   kmemleak: Only us...
112
113
  /* GFP bitmask for kmemleak internal allocations */
  #define GFP_KMEMLEAK_MASK	(GFP_KERNEL | GFP_ATOMIC)
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
114
115
116
  /* scanning area inside a memory block */
  struct kmemleak_scan_area {
  	struct hlist_node node;
c017b4be3   Catalin Marinas   kmemleak: Simplif...
117
118
  	unsigned long start;
  	size_t size;
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
119
  };
a1084c877   Luis R. Rodriguez   kmemleak: move co...
120
121
  #define KMEMLEAK_GREY	0
  #define KMEMLEAK_BLACK	-1
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
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
   * tree_node are already protected by the corresponding locks or mutex (see
   * the notes on locking above). These objects are reference-counted
   * (use_count) and freed using the RCU mechanism.
   */
  struct kmemleak_object {
  	spinlock_t lock;
  	unsigned long flags;		/* object status flags */
  	struct list_head object_list;
  	struct list_head gray_list;
  	struct prio_tree_node tree_node;
  	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;
  	/* 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;
04609ccc4   Catalin Marinas   kmemleak: Reduce ...
145
146
  	/* checksum for detecting modified objects */
  	u32 checksum;
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
  	/* 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)
0494e0828   Sergey Senozhatsky   kmemleak: Printin...
162
163
164
165
166
167
168
169
  /* 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
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
  /* 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);
  /* prio search tree for object boundaries */
  static struct prio_tree_root object_tree_root;
  /* rw_lock protecting the access to object_list and prio_tree_root */
  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 */
  static atomic_t kmemleak_enabled = ATOMIC_INIT(0);
  /* set in the late_initcall if there were no errors */
  static atomic_t kmemleak_initialized = ATOMIC_INIT(0);
  /* enables or disables early logging of the memory operations */
  static atomic_t kmemleak_early_log = ATOMIC_INIT(1);
  /* set if a fata kmemleak error has occurred */
  static atomic_t kmemleak_error = ATOMIC_INIT(0);
  
  /* minimum and maximum address that may be valid pointers */
  static unsigned long min_addr = ULONG_MAX;
  static unsigned long max_addr;
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
195
  static struct task_struct *scan_thread;
acf4968ec   Catalin Marinas   kmemleak: Slightl...
196
  /* used to avoid reporting of recently allocated objects */
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
197
  static unsigned long jiffies_min_age;
acf4968ec   Catalin Marinas   kmemleak: Slightl...
198
  static unsigned long jiffies_last_scan;
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
199
200
201
  /* delay between automatic memory scannings */
  static signed long jiffies_scan_wait;
  /* enables or disables the task stacks scanning */
e0a2a1601   Catalin Marinas   kmemleak: Enable ...
202
  static int kmemleak_stack_scan = 1;
4698c1f2b   Catalin Marinas   kmemleak: Do not ...
203
  /* protects the memory scanning, parameters and debug/kmemleak file access */
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
204
  static DEFINE_MUTEX(scan_mutex);
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
205

3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
206
  /*
2030117d2   Catalin Marinas   kmemleak: Fix som...
207
   * Early object allocation/freeing logging. Kmemleak is initialized after the
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
208
   * kernel allocator. However, both the kernel allocator and kmemleak may
2030117d2   Catalin Marinas   kmemleak: Fix som...
209
   * allocate memory blocks which need to be tracked. Kmemleak defines an
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
210
211
212
213
214
215
216
217
   * arbitrary buffer to hold the allocation/freeing information before it is
   * fully initialized.
   */
  
  /* kmemleak operation type for early logging */
  enum {
  	KMEMLEAK_ALLOC,
  	KMEMLEAK_FREE,
53238a60d   Catalin Marinas   kmemleak: Allow p...
218
  	KMEMLEAK_FREE_PART,
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
  	KMEMLEAK_NOT_LEAK,
  	KMEMLEAK_IGNORE,
  	KMEMLEAK_SCAN_AREA,
  	KMEMLEAK_NO_SCAN
  };
  
  /*
   * Structure holding the information passed to kmemleak callbacks during the
   * early logging.
   */
  struct early_log {
  	int op_type;			/* kmemleak operation type */
  	const void *ptr;		/* allocated/freed memory block */
  	size_t size;			/* memory block size */
  	int min_count;			/* minimum reference count */
fd6789675   Catalin Marinas   kmemleak: Save th...
234
235
  	unsigned long trace[MAX_TRACE];	/* stack trace */
  	unsigned int trace_len;		/* stack trace length */
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
236
237
238
  };
  
  /* early logging buffer and current position */
a6186d89c   Catalin Marinas   kmemleak: Mark th...
239
240
241
  static struct early_log
  	early_log[CONFIG_DEBUG_KMEMLEAK_EARLY_LOG_SIZE] __initdata;
  static int crt_early_log __initdata;
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
242
243
244
245
246
247
248
249
250
251
252
253
254
  
  static void kmemleak_disable(void);
  
  /*
   * Print a warning and dump the stack trace.
   */
  #define kmemleak_warn(x...)	do {	\
  	pr_warning(x);			\
  	dump_stack();			\
  } while (0)
  
  /*
   * Macro invoked when a serious kmemleak condition occured and cannot be
2030117d2   Catalin Marinas   kmemleak: Fix som...
255
   * recovered from. Kmemleak will be disabled and further allocation/freeing
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
256
257
   * tracing no longer available.
   */
000814f44   Catalin Marinas   kmemleak: Rename ...
258
  #define kmemleak_stop(x...)	do {	\
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
259
260
261
262
263
  	kmemleak_warn(x);		\
  	kmemleak_disable();		\
  } while (0)
  
  /*
0494e0828   Sergey Senozhatsky   kmemleak: Printin...
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
   * 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;
  	int i, len, remaining;
  	unsigned char linebuf[HEX_ROW_SIZE * 5];
  
  	/* limit the number of lines to HEX_MAX_LINES */
  	remaining = len =
  		min(object->size, (size_t)(HEX_MAX_LINES * HEX_ROW_SIZE));
  
  	seq_printf(seq, "  hex dump (first %d bytes):
  ", len);
  	for (i = 0; i < len; i += HEX_ROW_SIZE) {
  		int linelen = min(remaining, HEX_ROW_SIZE);
  
  		remaining -= HEX_ROW_SIZE;
  		hex_dump_to_buffer(ptr + i, linelen, HEX_ROW_SIZE,
  				   HEX_GROUP_SIZE, linebuf, sizeof(linebuf),
  				   HEX_ASCII);
  		seq_printf(seq, "    %s
  ", linebuf);
  	}
  }
  
  /*
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
295
296
297
298
299
300
301
302
303
   * 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.
   */
4a558dd6f   Luis R. Rodriguez   kmemleak: use boo...
304
  static bool color_white(const struct kmemleak_object *object)
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
305
  {
a1084c877   Luis R. Rodriguez   kmemleak: move co...
306
307
  	return object->count != KMEMLEAK_BLACK &&
  		object->count < object->min_count;
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
308
  }
4a558dd6f   Luis R. Rodriguez   kmemleak: use boo...
309
  static bool color_gray(const struct kmemleak_object *object)
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
310
  {
a1084c877   Luis R. Rodriguez   kmemleak: move co...
311
312
  	return object->min_count != KMEMLEAK_BLACK &&
  		object->count >= object->min_count;
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
313
314
315
  }
  
  /*
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
316
317
318
319
   * 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.
   */
4a558dd6f   Luis R. Rodriguez   kmemleak: use boo...
320
  static bool unreferenced_object(struct kmemleak_object *object)
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
321
  {
04609ccc4   Catalin Marinas   kmemleak: Reduce ...
322
  	return (color_white(object) && object->flags & OBJECT_ALLOCATED) &&
acf4968ec   Catalin Marinas   kmemleak: Slightl...
323
324
  		time_before_eq(object->jiffies + jiffies_min_age,
  			       jiffies_last_scan);
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
325
326
327
  }
  
  /*
bab4a34af   Catalin Marinas   kmemleak: Simplif...
328
329
   * Printing of the unreferenced objects information to the seq file. The
   * print_unreferenced function must be called with the object->lock held.
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
330
   */
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
331
332
333
334
  static void print_unreferenced(struct seq_file *seq,
  			       struct kmemleak_object *object)
  {
  	int i;
fefdd336b   Catalin Marinas   kmemleak: Show th...
335
  	unsigned int msecs_age = jiffies_to_msecs(jiffies - object->jiffies);
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
336

bab4a34af   Catalin Marinas   kmemleak: Simplif...
337
338
339
  	seq_printf(seq, "unreferenced object 0x%08lx (size %zu):
  ",
  		   object->pointer, object->size);
fefdd336b   Catalin Marinas   kmemleak: Show th...
340
341
342
343
  	seq_printf(seq, "  comm \"%s\", pid %d, jiffies %lu (age %d.%03ds)
  ",
  		   object->comm, object->pid, object->jiffies,
  		   msecs_age / 1000, msecs_age % 1000);
0494e0828   Sergey Senozhatsky   kmemleak: Printin...
344
  	hex_dump_object(seq, object);
bab4a34af   Catalin Marinas   kmemleak: Simplif...
345
346
  	seq_printf(seq, "  backtrace:
  ");
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
347
348
349
  
  	for (i = 0; i < object->trace_len; i++) {
  		void *ptr = (void *)object->trace[i];
bab4a34af   Catalin Marinas   kmemleak: Simplif...
350
351
  		seq_printf(seq, "    [<%p>] %pS
  ", ptr, ptr);
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
352
353
354
355
356
357
358
359
360
361
362
363
364
365
  	}
  }
  
  /*
   * 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;
ae281064b   Joe Perches   kmemleak: use pr_fmt
366
367
  	pr_notice("Object 0x%08lx (size %zu):
  ",
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
368
369
370
371
372
373
374
375
  		  object->tree_node.start, object->size);
  	pr_notice("  comm \"%s\", pid %d, jiffies %lu
  ",
  		  object->comm, object->pid, object->jiffies);
  	pr_notice("  min_count = %d
  ", object->min_count);
  	pr_notice("  count = %d
  ", object->count);
189d84ed5   Catalin Marinas   kmemleak: Dump ob...
376
377
  	pr_notice("  flags = 0x%lx
  ", object->flags);
04609ccc4   Catalin Marinas   kmemleak: Reduce ...
378
379
  	pr_notice("  checksum = %d
  ", object->checksum);
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
  	pr_notice("  backtrace:
  ");
  	print_stack_trace(&trace, 4);
  }
  
  /*
   * Look-up a memory block metadata (kmemleak_object) in the priority search
   * 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)
  {
  	struct prio_tree_node *node;
  	struct prio_tree_iter iter;
  	struct kmemleak_object *object;
  
  	prio_tree_iter_init(&iter, &object_tree_root, ptr, ptr);
  	node = prio_tree_next(&iter);
  	if (node) {
  		object = prio_tree_entry(node, struct kmemleak_object,
  					 tree_node);
  		if (!alias && object->pointer != ptr) {
ae281064b   Joe Perches   kmemleak: use pr_fmt
403
  			kmemleak_warn("Found object by alias");
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
  			object = NULL;
  		}
  	} else
  		object = NULL;
  
  	return object;
  }
  
  /*
   * 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)
  {
  	struct hlist_node *elem, *tmp;
  	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.
  	 */
  	hlist_for_each_entry_safe(area, elem, tmp, &object->area_list, node) {
  		hlist_del(elem);
  		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);
  }
  
  /*
   * Look up an object in the prio search tree and increase its use_count.
   */
  static struct kmemleak_object *find_and_get_object(unsigned long ptr, int alias)
  {
  	unsigned long flags;
  	struct kmemleak_object *object = NULL;
  
  	rcu_read_lock();
  	read_lock_irqsave(&kmemleak_lock, flags);
  	if (ptr >= min_addr && ptr < max_addr)
  		object = lookup_object(ptr, alias);
  	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;
  }
  
  /*
fd6789675   Catalin Marinas   kmemleak: Save th...
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
   * 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;
  }
  
  /*
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
501
502
503
   * Create the metadata (struct kmemleak_object) corresponding to an allocated
   * memory block and add it to the object_list and object_tree_root.
   */
fd6789675   Catalin Marinas   kmemleak: Save th...
504
505
  static struct kmemleak_object *create_object(unsigned long ptr, size_t size,
  					     int min_count, gfp_t gfp)
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
506
507
508
509
  {
  	unsigned long flags;
  	struct kmemleak_object *object;
  	struct prio_tree_node *node;
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
510

216c04b0d   Catalin Marinas   kmemleak: Only us...
511
  	object = kmem_cache_alloc(object_cache, gfp & GFP_KMEMLEAK_MASK);
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
512
  	if (!object) {
ae281064b   Joe Perches   kmemleak: use pr_fmt
513
514
  		kmemleak_stop("Cannot allocate a kmemleak_object structure
  ");
fd6789675   Catalin Marinas   kmemleak: Save th...
515
  		return NULL;
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
516
517
518
519
520
521
522
  	}
  
  	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);
04609ccc4   Catalin Marinas   kmemleak: Reduce ...
523
  	object->flags = OBJECT_ALLOCATED;
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
524
525
526
  	object->pointer = ptr;
  	object->size = size;
  	object->min_count = min_count;
04609ccc4   Catalin Marinas   kmemleak: Reduce ...
527
  	object->count = 0;			/* white color initially */
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
528
  	object->jiffies = jiffies;
04609ccc4   Catalin Marinas   kmemleak: Reduce ...
529
  	object->checksum = 0;
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
  
  	/* 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 */
fd6789675   Catalin Marinas   kmemleak: Save th...
550
  	object->trace_len = __save_stack_trace(object->trace);
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
551
552
553
554
555
556
  
  	INIT_PRIO_TREE_NODE(&object->tree_node);
  	object->tree_node.start = ptr;
  	object->tree_node.last = ptr + size - 1;
  
  	write_lock_irqsave(&kmemleak_lock, flags);
0580a1819   Luis R. Rodriguez   kmemleak: fix spa...
557

3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
558
559
560
561
562
563
564
565
566
567
  	min_addr = min(min_addr, ptr);
  	max_addr = max(max_addr, ptr + size);
  	node = prio_tree_insert(&object_tree_root, &object->tree_node);
  	/*
  	 * The code calling the kernel does not yet have the pointer to the
  	 * memory block to be able to free it.  However, we still hold the
  	 * kmemleak_lock here in case parts of the kernel started freeing
  	 * random memory blocks.
  	 */
  	if (node != &object->tree_node) {
ae281064b   Joe Perches   kmemleak: use pr_fmt
568
569
570
  		kmemleak_stop("Cannot insert 0x%lx into the object search tree "
  			      "(already existing)
  ", ptr);
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
571
  		object = lookup_object(ptr, 1);
0580a1819   Luis R. Rodriguez   kmemleak: fix spa...
572
  		spin_lock(&object->lock);
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
573
  		dump_object_info(object);
0580a1819   Luis R. Rodriguez   kmemleak: fix spa...
574
  		spin_unlock(&object->lock);
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
575
576
577
578
579
580
  
  		goto out;
  	}
  	list_add_tail_rcu(&object->object_list, &object_list);
  out:
  	write_unlock_irqrestore(&kmemleak_lock, flags);
fd6789675   Catalin Marinas   kmemleak: Save th...
581
  	return object;
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
582
583
584
585
586
587
  }
  
  /*
   * Remove the metadata (struct kmemleak_object) for a memory block from the
   * object_list and object_tree_root and decrement its use_count.
   */
53238a60d   Catalin Marinas   kmemleak: Allow p...
588
  static void __delete_object(struct kmemleak_object *object)
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
589
590
  {
  	unsigned long flags;
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
591
592
  
  	write_lock_irqsave(&kmemleak_lock, flags);
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
593
594
595
596
597
  	prio_tree_remove(&object_tree_root, &object->tree_node);
  	list_del_rcu(&object->object_list);
  	write_unlock_irqrestore(&kmemleak_lock, flags);
  
  	WARN_ON(!(object->flags & OBJECT_ALLOCATED));
53238a60d   Catalin Marinas   kmemleak: Allow p...
598
  	WARN_ON(atomic_read(&object->use_count) < 2);
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
599
600
601
602
603
604
  
  	/*
  	 * Locking here also ensures that the corresponding memory block
  	 * cannot be freed when it is being scanned.
  	 */
  	spin_lock_irqsave(&object->lock, flags);
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
605
606
607
608
609
610
  	object->flags &= ~OBJECT_ALLOCATED;
  	spin_unlock_irqrestore(&object->lock, flags);
  	put_object(object);
  }
  
  /*
53238a60d   Catalin Marinas   kmemleak: Allow p...
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
   * 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;
  
  	object = find_and_get_object(ptr, 0);
  	if (!object) {
  #ifdef DEBUG
  		kmemleak_warn("Freeing unknown object at 0x%08lx
  ",
  			      ptr);
  #endif
  		return;
  	}
  	__delete_object(object);
  	put_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;
  
  	object = find_and_get_object(ptr, 1);
  	if (!object) {
  #ifdef DEBUG
  		kmemleak_warn("Partially freeing unknown object at 0x%08lx "
  			      "(size %zu)
  ", ptr, size);
  #endif
  		return;
  	}
  	__delete_object(object);
  
  	/*
  	 * 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);
  
  	put_object(object);
  }
a1084c877   Luis R. Rodriguez   kmemleak: move co...
670
671
672
673
674
675
676
677
678
  
  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)
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
679
680
  {
  	unsigned long flags;
a1084c877   Luis R. Rodriguez   kmemleak: move co...
681
682
683
684
685
686
687
688
  
  	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)
  {
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
689
690
691
692
  	struct kmemleak_object *object;
  
  	object = find_and_get_object(ptr, 0);
  	if (!object) {
a1084c877   Luis R. Rodriguez   kmemleak: move co...
693
694
695
696
697
  		kmemleak_warn("Trying to color unknown object "
  			      "at 0x%08lx as %s
  ", ptr,
  			      (color == KMEMLEAK_GREY) ? "Grey" :
  			      (color == KMEMLEAK_BLACK) ? "Black" : "Unknown");
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
698
699
  		return;
  	}
a1084c877   Luis R. Rodriguez   kmemleak: move co...
700
  	paint_it(object, color);
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
701
702
703
704
  	put_object(object);
  }
  
  /*
a1084c877   Luis R. Rodriguez   kmemleak: move co...
705
706
707
708
709
710
711
712
713
   * Make a object permanently as gray-colored so that it can no longer be
   * 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);
  }
  
  /*
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
714
715
716
717
718
   * Mark the object as black-colored so that it is ignored from scans and
   * reporting.
   */
  static void make_black_object(unsigned long ptr)
  {
a1084c877   Luis R. Rodriguez   kmemleak: move co...
719
  	paint_ptr(ptr, KMEMLEAK_BLACK);
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
720
721
722
723
724
725
  }
  
  /*
   * 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.
   */
c017b4be3   Catalin Marinas   kmemleak: Simplif...
726
  static void add_scan_area(unsigned long ptr, size_t size, gfp_t gfp)
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
727
728
729
730
  {
  	unsigned long flags;
  	struct kmemleak_object *object;
  	struct kmemleak_scan_area *area;
c017b4be3   Catalin Marinas   kmemleak: Simplif...
731
  	object = find_and_get_object(ptr, 1);
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
732
  	if (!object) {
ae281064b   Joe Perches   kmemleak: use pr_fmt
733
734
735
  		kmemleak_warn("Adding scan area to unknown object at 0x%08lx
  ",
  			      ptr);
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
736
737
  		return;
  	}
216c04b0d   Catalin Marinas   kmemleak: Only us...
738
  	area = kmem_cache_alloc(scan_area_cache, gfp & GFP_KMEMLEAK_MASK);
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
739
  	if (!area) {
ae281064b   Joe Perches   kmemleak: use pr_fmt
740
741
  		kmemleak_warn("Cannot allocate a scan area
  ");
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
742
743
744
745
  		goto out;
  	}
  
  	spin_lock_irqsave(&object->lock, flags);
c017b4be3   Catalin Marinas   kmemleak: Simplif...
746
  	if (ptr + size > object->pointer + object->size) {
ae281064b   Joe Perches   kmemleak: use pr_fmt
747
748
  		kmemleak_warn("Scan area larger than object 0x%08lx
  ", ptr);
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
749
750
751
752
753
754
  		dump_object_info(object);
  		kmem_cache_free(scan_area_cache, area);
  		goto out_unlock;
  	}
  
  	INIT_HLIST_NODE(&area->node);
c017b4be3   Catalin Marinas   kmemleak: Simplif...
755
756
  	area->start = ptr;
  	area->size = size;
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
  
  	hlist_add_head(&area->node, &object->area_list);
  out_unlock:
  	spin_unlock_irqrestore(&object->lock, flags);
  out:
  	put_object(object);
  }
  
  /*
   * 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) {
ae281064b   Joe Perches   kmemleak: use pr_fmt
777
778
  		kmemleak_warn("Not scanning unknown object at 0x%08lx
  ", ptr);
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
779
780
781
782
783
784
785
786
787
788
789
790
791
  		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.
   */
a6186d89c   Catalin Marinas   kmemleak: Mark th...
792
  static void __init log_early(int op_type, const void *ptr, size_t size,
c017b4be3   Catalin Marinas   kmemleak: Simplif...
793
  			     int min_count)
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
794
795
796
797
798
  {
  	unsigned long flags;
  	struct early_log *log;
  
  	if (crt_early_log >= ARRAY_SIZE(early_log)) {
addd72c1a   Catalin Marinas   kmemleak: Improve...
799
800
801
  		pr_warning("Early log buffer exceeded, "
  			   "please increase DEBUG_KMEMLEAK_EARLY_LOG_SIZE
  ");
a9d9058ab   Catalin Marinas   kmemleak: Allow t...
802
  		kmemleak_disable();
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
803
804
805
806
807
808
809
810
811
812
813
814
815
  		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;
fd6789675   Catalin Marinas   kmemleak: Save th...
816
817
  	if (op_type == KMEMLEAK_ALLOC)
  		log->trace_len = __save_stack_trace(log->trace);
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
818
819
820
821
822
  	crt_early_log++;
  	local_irq_restore(flags);
  }
  
  /*
fd6789675   Catalin Marinas   kmemleak: Save th...
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
   * 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;
  
  	if (!atomic_read(&kmemleak_enabled) || !log->ptr || IS_ERR(log->ptr))
  		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,
c1bcd6b32   Tetsuo Handa   kmemleak: Use GFP...
839
  			       log->min_count, GFP_ATOMIC);
0d5d1aadc   Catalin Marinas   kmemleak: Check f...
840
841
  	if (!object)
  		goto out;
fd6789675   Catalin Marinas   kmemleak: Save th...
842
843
844
845
846
  	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);
0d5d1aadc   Catalin Marinas   kmemleak: Check f...
847
  out:
fd6789675   Catalin Marinas   kmemleak: Save th...
848
849
850
851
  	rcu_read_unlock();
  }
  
  /*
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
852
853
854
855
   * Memory allocation function callback. This function is called from the
   * kernel allocators when a new block is allocated (kmem_cache_alloc, kmalloc,
   * vmalloc etc.).
   */
a6186d89c   Catalin Marinas   kmemleak: Mark th...
856
857
  void __ref kmemleak_alloc(const void *ptr, size_t size, int min_count,
  			  gfp_t gfp)
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
858
859
860
861
862
863
864
  {
  	pr_debug("%s(0x%p, %zu, %d)
  ", __func__, ptr, size, min_count);
  
  	if (atomic_read(&kmemleak_enabled) && ptr && !IS_ERR(ptr))
  		create_object((unsigned long)ptr, size, min_count, gfp);
  	else if (atomic_read(&kmemleak_early_log))
c017b4be3   Catalin Marinas   kmemleak: Simplif...
865
  		log_early(KMEMLEAK_ALLOC, ptr, size, min_count);
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
866
867
868
869
870
871
872
  }
  EXPORT_SYMBOL_GPL(kmemleak_alloc);
  
  /*
   * Memory freeing function callback. This function is called from the kernel
   * allocators when a block is freed (kmem_cache_free, kfree, vfree etc.).
   */
a6186d89c   Catalin Marinas   kmemleak: Mark th...
873
  void __ref kmemleak_free(const void *ptr)
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
874
875
876
877
878
  {
  	pr_debug("%s(0x%p)
  ", __func__, ptr);
  
  	if (atomic_read(&kmemleak_enabled) && ptr && !IS_ERR(ptr))
53238a60d   Catalin Marinas   kmemleak: Allow p...
879
  		delete_object_full((unsigned long)ptr);
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
880
  	else if (atomic_read(&kmemleak_early_log))
c017b4be3   Catalin Marinas   kmemleak: Simplif...
881
  		log_early(KMEMLEAK_FREE, ptr, 0, 0);
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
882
883
884
885
  }
  EXPORT_SYMBOL_GPL(kmemleak_free);
  
  /*
53238a60d   Catalin Marinas   kmemleak: Allow p...
886
887
888
   * Partial memory freeing function callback. This function is usually called
   * from bootmem allocator when (part of) a memory block is freed.
   */
a6186d89c   Catalin Marinas   kmemleak: Mark th...
889
  void __ref kmemleak_free_part(const void *ptr, size_t size)
53238a60d   Catalin Marinas   kmemleak: Allow p...
890
891
892
893
894
895
896
  {
  	pr_debug("%s(0x%p)
  ", __func__, ptr);
  
  	if (atomic_read(&kmemleak_enabled) && ptr && !IS_ERR(ptr))
  		delete_object_part((unsigned long)ptr, size);
  	else if (atomic_read(&kmemleak_early_log))
c017b4be3   Catalin Marinas   kmemleak: Simplif...
897
  		log_early(KMEMLEAK_FREE_PART, ptr, size, 0);
53238a60d   Catalin Marinas   kmemleak: Allow p...
898
899
900
901
  }
  EXPORT_SYMBOL_GPL(kmemleak_free_part);
  
  /*
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
902
903
904
   * Mark an already allocated memory block as a false positive. This will cause
   * the block to no longer be reported as leak and always be scanned.
   */
a6186d89c   Catalin Marinas   kmemleak: Mark th...
905
  void __ref kmemleak_not_leak(const void *ptr)
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
906
907
908
909
910
911
912
  {
  	pr_debug("%s(0x%p)
  ", __func__, ptr);
  
  	if (atomic_read(&kmemleak_enabled) && ptr && !IS_ERR(ptr))
  		make_gray_object((unsigned long)ptr);
  	else if (atomic_read(&kmemleak_early_log))
c017b4be3   Catalin Marinas   kmemleak: Simplif...
913
  		log_early(KMEMLEAK_NOT_LEAK, ptr, 0, 0);
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
914
915
916
917
918
919
920
921
  }
  EXPORT_SYMBOL(kmemleak_not_leak);
  
  /*
   * Ignore a memory block. 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.
   */
a6186d89c   Catalin Marinas   kmemleak: Mark th...
922
  void __ref kmemleak_ignore(const void *ptr)
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
923
924
925
926
927
928
929
  {
  	pr_debug("%s(0x%p)
  ", __func__, ptr);
  
  	if (atomic_read(&kmemleak_enabled) && ptr && !IS_ERR(ptr))
  		make_black_object((unsigned long)ptr);
  	else if (atomic_read(&kmemleak_early_log))
c017b4be3   Catalin Marinas   kmemleak: Simplif...
930
  		log_early(KMEMLEAK_IGNORE, ptr, 0, 0);
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
931
932
933
934
935
936
  }
  EXPORT_SYMBOL(kmemleak_ignore);
  
  /*
   * Limit the range to be scanned in an allocated memory block.
   */
c017b4be3   Catalin Marinas   kmemleak: Simplif...
937
  void __ref kmemleak_scan_area(const void *ptr, size_t size, gfp_t gfp)
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
938
939
940
941
942
  {
  	pr_debug("%s(0x%p)
  ", __func__, ptr);
  
  	if (atomic_read(&kmemleak_enabled) && ptr && !IS_ERR(ptr))
c017b4be3   Catalin Marinas   kmemleak: Simplif...
943
  		add_scan_area((unsigned long)ptr, size, gfp);
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
944
  	else if (atomic_read(&kmemleak_early_log))
c017b4be3   Catalin Marinas   kmemleak: Simplif...
945
  		log_early(KMEMLEAK_SCAN_AREA, ptr, size, 0);
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
946
947
948
949
950
951
  }
  EXPORT_SYMBOL(kmemleak_scan_area);
  
  /*
   * Inform kmemleak not to scan the given memory block.
   */
a6186d89c   Catalin Marinas   kmemleak: Mark th...
952
  void __ref kmemleak_no_scan(const void *ptr)
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
953
954
955
956
957
958
959
  {
  	pr_debug("%s(0x%p)
  ", __func__, ptr);
  
  	if (atomic_read(&kmemleak_enabled) && ptr && !IS_ERR(ptr))
  		object_no_scan((unsigned long)ptr);
  	else if (atomic_read(&kmemleak_early_log))
c017b4be3   Catalin Marinas   kmemleak: Simplif...
960
  		log_early(KMEMLEAK_NO_SCAN, ptr, 0, 0);
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
961
962
963
964
  }
  EXPORT_SYMBOL(kmemleak_no_scan);
  
  /*
04609ccc4   Catalin Marinas   kmemleak: Reduce ...
965
966
967
968
969
970
971
972
973
974
975
976
977
978
   * 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;
  
  	if (!kmemcheck_is_obj_initialized(object->pointer, object->size))
  		return false;
  
  	object->checksum = crc32(0, (void *)object->pointer, object->size);
  	return object->checksum != old_csum;
  }
  
  /*
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
   * Memory scanning is a long process and it needs to be interruptable. This
   * function checks whether such interrupt condition occured.
   */
  static int scan_should_stop(void)
  {
  	if (!atomic_read(&kmemleak_enabled))
  		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,
4b8a96744   Catalin Marinas   kmemleak: Add mor...
1004
  		       struct kmemleak_object *scanned, int allow_resched)
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1005
1006
1007
1008
1009
1010
  {
  	unsigned long *ptr;
  	unsigned long *start = PTR_ALIGN(_start, BYTES_PER_POINTER);
  	unsigned long *end = _end - (BYTES_PER_POINTER - 1);
  
  	for (ptr = start; ptr < end; ptr++) {
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1011
  		struct kmemleak_object *object;
8e019366b   Pekka Enberg   kmemleak: Don't s...
1012
1013
  		unsigned long flags;
  		unsigned long pointer;
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1014

4b8a96744   Catalin Marinas   kmemleak: Add mor...
1015
1016
  		if (allow_resched)
  			cond_resched();
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1017
1018
  		if (scan_should_stop())
  			break;
8e019366b   Pekka Enberg   kmemleak: Don't s...
1019
1020
1021
1022
1023
1024
  		/* don't scan uninitialized memory */
  		if (!kmemcheck_is_obj_initialized((unsigned long)ptr,
  						  BYTES_PER_POINTER))
  			continue;
  
  		pointer = *ptr;
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
  		object = find_and_get_object(pointer, 1);
  		if (!object)
  			continue;
  		if (object == scanned) {
  			/* self referenced, ignore */
  			put_object(object);
  			continue;
  		}
  
  		/*
  		 * Avoid the lockdep recursive warning on object->lock being
  		 * previously acquired in scan_object(). These locks are
  		 * enclosed by scan_mutex.
  		 */
  		spin_lock_irqsave_nested(&object->lock, flags,
  					 SINGLE_DEPTH_NESTING);
  		if (!color_white(object)) {
  			/* non-orphan, ignored or new */
  			spin_unlock_irqrestore(&object->lock, flags);
  			put_object(object);
  			continue;
  		}
  
  		/*
  		 * 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++;
0587da40b   Catalin Marinas   kmemleak: Release...
1055
  		if (color_gray(object)) {
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1056
  			list_add_tail(&object->gray_list, &gray_list);
0587da40b   Catalin Marinas   kmemleak: Release...
1057
1058
1059
  			spin_unlock_irqrestore(&object->lock, flags);
  			continue;
  		}
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1060
  		spin_unlock_irqrestore(&object->lock, flags);
0587da40b   Catalin Marinas   kmemleak: Release...
1061
  		put_object(object);
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
  	}
  }
  
  /*
   * 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;
  	struct hlist_node *elem;
  	unsigned long flags;
  
  	/*
21ae2956c   Uwe Kleine-König   tree-wide: fix ty...
1076
1077
  	 * Once the object->lock is acquired, the corresponding memory block
  	 * cannot be freed (the same lock is acquired in delete_object).
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1078
1079
1080
1081
1082
1083
1084
  	 */
  	spin_lock_irqsave(&object->lock, flags);
  	if (object->flags & OBJECT_NO_SCAN)
  		goto out;
  	if (!(object->flags & OBJECT_ALLOCATED))
  		/* already freed object */
  		goto out;
af98603da   Catalin Marinas   kmemleak: Allow r...
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
  	if (hlist_empty(&object->area_list)) {
  		void *start = (void *)object->pointer;
  		void *end = (void *)(object->pointer + object->size);
  
  		while (start < end && (object->flags & OBJECT_ALLOCATED) &&
  		       !(object->flags & OBJECT_NO_SCAN)) {
  			scan_block(start, min(start + MAX_SCAN_SIZE, end),
  				   object, 0);
  			start += MAX_SCAN_SIZE;
  
  			spin_unlock_irqrestore(&object->lock, flags);
  			cond_resched();
  			spin_lock_irqsave(&object->lock, flags);
  		}
  	} else
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1100
  		hlist_for_each_entry(area, elem, &object->area_list, node)
c017b4be3   Catalin Marinas   kmemleak: Simplif...
1101
1102
1103
  			scan_block((void *)area->start,
  				   (void *)(area->start + area->size),
  				   object, 0);
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1104
1105
1106
1107
1108
  out:
  	spin_unlock_irqrestore(&object->lock, flags);
  }
  
  /*
04609ccc4   Catalin Marinas   kmemleak: Reduce ...
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
   * 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));
  }
  
  /*
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1142
1143
1144
1145
1146
1147
1148
   * 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;
04609ccc4   Catalin Marinas   kmemleak: Reduce ...
1149
  	struct kmemleak_object *object;
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1150
  	int i;
4698c1f2b   Catalin Marinas   kmemleak: Do not ...
1151
  	int new_leaks = 0;
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1152

acf4968ec   Catalin Marinas   kmemleak: Slightl...
1153
  	jiffies_last_scan = jiffies;
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
  	/* 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) {
ae281064b   Joe Perches   kmemleak: use pr_fmt
1164
1165
  			pr_debug("object->use_count = %d
  ",
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
  				 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();
  
  	/* data/bss scanning */
4b8a96744   Catalin Marinas   kmemleak: Add mor...
1180
1181
  	scan_block(_sdata, _edata, NULL, 1);
  	scan_block(__bss_start, __bss_stop, NULL, 1);
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1182
1183
1184
1185
1186
  
  #ifdef CONFIG_SMP
  	/* per-cpu sections scanning */
  	for_each_possible_cpu(i)
  		scan_block(__per_cpu_start + per_cpu_offset(i),
4b8a96744   Catalin Marinas   kmemleak: Add mor...
1187
  			   __per_cpu_end + per_cpu_offset(i), NULL, 1);
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
  #endif
  
  	/*
  	 * Struct page scanning for each node. The code below is not yet safe
  	 * with MEMORY_HOTPLUG.
  	 */
  	for_each_online_node(i) {
  		pg_data_t *pgdat = NODE_DATA(i);
  		unsigned long start_pfn = pgdat->node_start_pfn;
  		unsigned long end_pfn = start_pfn + pgdat->node_spanned_pages;
  		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;
4b8a96744   Catalin Marinas   kmemleak: Add mor...
1209
  			scan_block(page, page + 1, NULL, 1);
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1210
1211
1212
1213
  		}
  	}
  
  	/*
43ed5d6ee   Catalin Marinas   kmemleak: Scan al...
1214
  	 * Scanning the task stacks (may introduce false negatives).
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1215
1216
  	 */
  	if (kmemleak_stack_scan) {
43ed5d6ee   Catalin Marinas   kmemleak: Scan al...
1217
  		struct task_struct *p, *g;
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1218
  		read_lock(&tasklist_lock);
43ed5d6ee   Catalin Marinas   kmemleak: Scan al...
1219
1220
1221
1222
  		do_each_thread(g, p) {
  			scan_block(task_stack_page(p), task_stack_page(p) +
  				   THREAD_SIZE, NULL, 0);
  		} while_each_thread(g, p);
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1223
1224
1225
1226
1227
  		read_unlock(&tasklist_lock);
  	}
  
  	/*
  	 * Scan the objects already referenced from the sections scanned
04609ccc4   Catalin Marinas   kmemleak: Reduce ...
1228
  	 * above.
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1229
  	 */
04609ccc4   Catalin Marinas   kmemleak: Reduce ...
1230
  	scan_gray_list();
2587362ea   Catalin Marinas   kmemleak: Scan ob...
1231
1232
  
  	/*
04609ccc4   Catalin Marinas   kmemleak: Reduce ...
1233
1234
  	 * Check for new or unreferenced objects modified since the previous
  	 * scan and color them gray until the next scan.
2587362ea   Catalin Marinas   kmemleak: Scan ob...
1235
1236
1237
1238
  	 */
  	rcu_read_lock();
  	list_for_each_entry_rcu(object, &object_list, object_list) {
  		spin_lock_irqsave(&object->lock, flags);
04609ccc4   Catalin Marinas   kmemleak: Reduce ...
1239
1240
1241
1242
  		if (color_white(object) && (object->flags & OBJECT_ALLOCATED)
  		    && update_checksum(object) && get_object(object)) {
  			/* color it gray temporarily */
  			object->count = object->min_count;
2587362ea   Catalin Marinas   kmemleak: Scan ob...
1243
1244
1245
1246
1247
  			list_add_tail(&object->gray_list, &gray_list);
  		}
  		spin_unlock_irqrestore(&object->lock, flags);
  	}
  	rcu_read_unlock();
04609ccc4   Catalin Marinas   kmemleak: Reduce ...
1248
1249
1250
1251
  	/*
  	 * Re-scan the gray list for modified unreferenced objects.
  	 */
  	scan_gray_list();
4698c1f2b   Catalin Marinas   kmemleak: Do not ...
1252
1253
  
  	/*
04609ccc4   Catalin Marinas   kmemleak: Reduce ...
1254
  	 * If scanning was stopped do not report any new unreferenced objects.
17bb9e0d9   Catalin Marinas   kmemleak: Do not ...
1255
  	 */
04609ccc4   Catalin Marinas   kmemleak: Reduce ...
1256
  	if (scan_should_stop())
17bb9e0d9   Catalin Marinas   kmemleak: Do not ...
1257
1258
1259
  		return;
  
  	/*
4698c1f2b   Catalin Marinas   kmemleak: Do not ...
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
  	 * 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();
  
  	if (new_leaks)
  		pr_info("%d new suspected memory leaks (see "
  			"/sys/kernel/debug/kmemleak)
  ", new_leaks);
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1278
1279
1280
1281
1282
1283
1284
1285
1286
  }
  
  /*
   * 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;
ae281064b   Joe Perches   kmemleak: use pr_fmt
1287
1288
  	pr_info("Automatic memory scanning thread started
  ");
bf2a76b31   Catalin Marinas   kmemleak: Renice ...
1289
  	set_user_nice(current, 10);
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
  
  	/*
  	 * Wait before the first scan to allow the system to fully initialize.
  	 */
  	if (first_run) {
  		first_run = 0;
  		ssleep(SECS_FIRST_SCAN);
  	}
  
  	while (!kthread_should_stop()) {
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1300
1301
1302
  		signed long timeout = jiffies_scan_wait;
  
  		mutex_lock(&scan_mutex);
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1303
  		kmemleak_scan();
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1304
  		mutex_unlock(&scan_mutex);
4698c1f2b   Catalin Marinas   kmemleak: Do not ...
1305

3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1306
1307
1308
1309
  		/* wait before the next scan */
  		while (timeout && !kthread_should_stop())
  			timeout = schedule_timeout_interruptible(timeout);
  	}
ae281064b   Joe Perches   kmemleak: use pr_fmt
1310
1311
  	pr_info("Automatic memory scanning thread ended
  ");
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1312
1313
1314
1315
1316
1317
  
  	return 0;
  }
  
  /*
   * Start the automatic memory scanning thread. This function must be called
4698c1f2b   Catalin Marinas   kmemleak: Do not ...
1318
   * with the scan_mutex held.
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1319
   */
7eb0d5e5b   Luis R. Rodriguez   kmemleak: fix spa...
1320
  static void start_scan_thread(void)
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1321
1322
1323
1324
1325
  {
  	if (scan_thread)
  		return;
  	scan_thread = kthread_run(kmemleak_scan_thread, NULL, "kmemleak");
  	if (IS_ERR(scan_thread)) {
ae281064b   Joe Perches   kmemleak: use pr_fmt
1326
1327
  		pr_warning("Failed to create the scan thread
  ");
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1328
1329
1330
1331
1332
1333
  		scan_thread = NULL;
  	}
  }
  
  /*
   * Stop the automatic memory scanning thread. This function must be called
4698c1f2b   Catalin Marinas   kmemleak: Do not ...
1334
   * with the scan_mutex held.
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1335
   */
7eb0d5e5b   Luis R. Rodriguez   kmemleak: fix spa...
1336
  static void stop_scan_thread(void)
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
  {
  	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;
b87324d08   Catalin Marinas   kmemleak: Do not ...
1353
1354
1355
1356
1357
  	int err;
  
  	err = mutex_lock_interruptible(&scan_mutex);
  	if (err < 0)
  		return ERR_PTR(err);
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1358

3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1359
1360
1361
1362
1363
1364
1365
1366
1367
  	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:
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
  	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;
  	struct list_head *n = &prev_obj->object_list;
  
  	++(*pos);
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1382

3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1383
1384
1385
1386
1387
  	list_for_each_continue_rcu(n, &object_list) {
  		next_obj = list_entry(n, struct kmemleak_object, object_list);
  		if (get_object(next_obj))
  			break;
  	}
288c857d6   Catalin Marinas   kmemleak: Remove ...
1388

3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1389
1390
1391
1392
1393
1394
1395
1396
1397
  	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)
  {
b87324d08   Catalin Marinas   kmemleak: Do not ...
1398
1399
1400
1401
1402
  	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.
  		 */
f5886c7f9   Catalin Marinas   kmemleak: Protect...
1403
  		rcu_read_unlock();
b87324d08   Catalin Marinas   kmemleak: Do not ...
1404
1405
1406
1407
  		mutex_unlock(&scan_mutex);
  		if (v)
  			put_object(v);
  	}
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
  }
  
  /*
   * 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);
288c857d6   Catalin Marinas   kmemleak: Remove ...
1419
  	if ((object->flags & OBJECT_REPORTED) && unreferenced_object(object))
17bb9e0d9   Catalin Marinas   kmemleak: Do not ...
1420
  		print_unreferenced(seq, object);
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
  	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)
  {
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1434
1435
  	if (!atomic_read(&kmemleak_enabled))
  		return -EBUSY;
b87324d08   Catalin Marinas   kmemleak: Do not ...
1436
  	return seq_open(file, &kmemleak_seq_ops);
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1437
1438
1439
1440
  }
  
  static int kmemleak_release(struct inode *inode, struct file *file)
  {
b87324d08   Catalin Marinas   kmemleak: Do not ...
1441
  	return seq_release(inode, file);
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1442
  }
189d84ed5   Catalin Marinas   kmemleak: Dump ob...
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
  static int dump_str_object_info(const char *str)
  {
  	unsigned long flags;
  	struct kmemleak_object *object;
  	unsigned long addr;
  
  	addr= simple_strtoul(str, NULL, 0);
  	object = find_and_get_object(addr, 0);
  	if (!object) {
  		pr_info("Unknown object at 0x%08lx
  ", addr);
  		return -EINVAL;
  	}
  
  	spin_lock_irqsave(&object->lock, flags);
  	dump_object_info(object);
  	spin_unlock_irqrestore(&object->lock, flags);
  
  	put_object(object);
  	return 0;
  }
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1464
  /*
30b371010   Luis R. Rodriguez   kmemleak: add cle...
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
   * 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))
a1084c877   Luis R. Rodriguez   kmemleak: move co...
1480
  			__paint_it(object, KMEMLEAK_GREY);
30b371010   Luis R. Rodriguez   kmemleak: add cle...
1481
1482
1483
1484
1485
1486
  		spin_unlock_irqrestore(&object->lock, flags);
  	}
  	rcu_read_unlock();
  }
  
  /*
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1487
1488
1489
1490
1491
1492
1493
1494
1495
   * 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)
4698c1f2b   Catalin Marinas   kmemleak: Do not ...
1496
   *   scan	- trigger a memory scan
30b371010   Luis R. Rodriguez   kmemleak: add cle...
1497
1498
   *   clear	- mark all current reported unreferenced kmemleak objects as
   *		  grey to ignore printing them
189d84ed5   Catalin Marinas   kmemleak: Dump ob...
1499
   *   dump=...	- dump information about the object found at the given address
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1500
1501
1502
1503
1504
1505
   */
  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;
b87324d08   Catalin Marinas   kmemleak: Do not ...
1506
  	int ret;
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1507
1508
1509
1510
1511
  
  	buf_size = min(size, (sizeof(buf) - 1));
  	if (strncpy_from_user(buf, user_buf, buf_size) < 0)
  		return -EFAULT;
  	buf[buf_size] = 0;
b87324d08   Catalin Marinas   kmemleak: Do not ...
1512
1513
1514
  	ret = mutex_lock_interruptible(&scan_mutex);
  	if (ret < 0)
  		return ret;
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
  	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;
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1527

b87324d08   Catalin Marinas   kmemleak: Do not ...
1528
1529
1530
  		ret = strict_strtoul(buf + 5, 0, &secs);
  		if (ret < 0)
  			goto out;
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1531
1532
1533
1534
1535
  		stop_scan_thread();
  		if (secs) {
  			jiffies_scan_wait = msecs_to_jiffies(secs * 1000);
  			start_scan_thread();
  		}
4698c1f2b   Catalin Marinas   kmemleak: Do not ...
1536
1537
  	} else if (strncmp(buf, "scan", 4) == 0)
  		kmemleak_scan();
30b371010   Luis R. Rodriguez   kmemleak: add cle...
1538
1539
  	else if (strncmp(buf, "clear", 5) == 0)
  		kmemleak_clear();
189d84ed5   Catalin Marinas   kmemleak: Dump ob...
1540
1541
  	else if (strncmp(buf, "dump=", 5) == 0)
  		ret = dump_str_object_info(buf + 5);
4698c1f2b   Catalin Marinas   kmemleak: Do not ...
1542
  	else
b87324d08   Catalin Marinas   kmemleak: Do not ...
1543
1544
1545
1546
1547
1548
  		ret = -EINVAL;
  
  out:
  	mutex_unlock(&scan_mutex);
  	if (ret < 0)
  		return ret;
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
  
  	/* 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,
  	.release	= kmemleak_release,
  };
  
  /*
   * Perform the freeing of the kmemleak internal objects after waiting for any
   * current memory scan to complete.
   */
179a8100e   Catalin Marinas   kmemleak: Do no c...
1568
  static void kmemleak_do_cleanup(struct work_struct *work)
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1569
1570
  {
  	struct kmemleak_object *object;
4698c1f2b   Catalin Marinas   kmemleak: Do not ...
1571
  	mutex_lock(&scan_mutex);
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1572
  	stop_scan_thread();
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1573

3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1574
1575
  	rcu_read_lock();
  	list_for_each_entry_rcu(object, &object_list, object_list)
53238a60d   Catalin Marinas   kmemleak: Allow p...
1576
  		delete_object_full(object->pointer);
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1577
1578
  	rcu_read_unlock();
  	mutex_unlock(&scan_mutex);
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1579
  }
179a8100e   Catalin Marinas   kmemleak: Do no c...
1580
  static DECLARE_WORK(cleanup_work, kmemleak_do_cleanup);
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
  
  /*
   * 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 */
  	if (atomic_cmpxchg(&kmemleak_error, 0, 1))
  		return;
  
  	/* stop any memory operation tracing */
  	atomic_set(&kmemleak_early_log, 0);
  	atomic_set(&kmemleak_enabled, 0);
  
  	/* check whether it is too early for a kernel thread */
  	if (atomic_read(&kmemleak_initialized))
179a8100e   Catalin Marinas   kmemleak: Do no c...
1598
  		schedule_work(&cleanup_work);
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
  
  	pr_info("Kernel memory leak detector disabled
  ");
  }
  
  /*
   * Allow boot-time kmemleak disabling (enabled by default).
   */
  static int kmemleak_boot_config(char *str)
  {
  	if (!str)
  		return -EINVAL;
  	if (strcmp(str, "off") == 0)
  		kmemleak_disable();
  	else if (strcmp(str, "on") != 0)
  		return -EINVAL;
  	return 0;
  }
  early_param("kmemleak", kmemleak_boot_config);
  
  /*
2030117d2   Catalin Marinas   kmemleak: Fix som...
1620
   * Kmemleak initialization.
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1621
1622
1623
1624
1625
   */
  void __init kmemleak_init(void)
  {
  	int i;
  	unsigned long flags;
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
  	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);
  	INIT_PRIO_TREE_ROOT(&object_tree_root);
  
  	/* the kernel is still in UP mode, so disabling the IRQs is enough */
  	local_irq_save(flags);
  	if (!atomic_read(&kmemleak_error)) {
  		atomic_set(&kmemleak_enabled, 1);
  		atomic_set(&kmemleak_early_log, 0);
  	}
  	local_irq_restore(flags);
  
  	/*
  	 * 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:
fd6789675   Catalin Marinas   kmemleak: Save th...
1651
  			early_alloc(log);
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1652
1653
1654
1655
  			break;
  		case KMEMLEAK_FREE:
  			kmemleak_free(log->ptr);
  			break;
53238a60d   Catalin Marinas   kmemleak: Allow p...
1656
1657
1658
  		case KMEMLEAK_FREE_PART:
  			kmemleak_free_part(log->ptr, log->size);
  			break;
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1659
1660
1661
1662
1663
1664
1665
  		case KMEMLEAK_NOT_LEAK:
  			kmemleak_not_leak(log->ptr);
  			break;
  		case KMEMLEAK_IGNORE:
  			kmemleak_ignore(log->ptr);
  			break;
  		case KMEMLEAK_SCAN_AREA:
c017b4be3   Catalin Marinas   kmemleak: Simplif...
1666
  			kmemleak_scan_area(log->ptr, log->size, GFP_KERNEL);
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
  			break;
  		case KMEMLEAK_NO_SCAN:
  			kmemleak_no_scan(log->ptr);
  			break;
  		default:
  			WARN_ON(1);
  		}
  	}
  }
  
  /*
   * Late initialization function.
   */
  static int __init kmemleak_late_init(void)
  {
  	struct dentry *dentry;
  
  	atomic_set(&kmemleak_initialized, 1);
  
  	if (atomic_read(&kmemleak_error)) {
  		/*
  		 * Some error occured and kmemleak was disabled. There is a
  		 * 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.
  		 */
179a8100e   Catalin Marinas   kmemleak: Do no c...
1693
  		schedule_work(&cleanup_work);
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1694
1695
1696
1697
1698
1699
  		return -ENOMEM;
  	}
  
  	dentry = debugfs_create_file("kmemleak", S_IRUGO, NULL, NULL,
  				     &kmemleak_fops);
  	if (!dentry)
ae281064b   Joe Perches   kmemleak: use pr_fmt
1700
1701
  		pr_warning("Failed to create the debugfs kmemleak file
  ");
4698c1f2b   Catalin Marinas   kmemleak: Do not ...
1702
  	mutex_lock(&scan_mutex);
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1703
  	start_scan_thread();
4698c1f2b   Catalin Marinas   kmemleak: Do not ...
1704
  	mutex_unlock(&scan_mutex);
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1705
1706
1707
1708
1709
1710
1711
  
  	pr_info("Kernel memory leak detector initialized
  ");
  
  	return 0;
  }
  late_initcall(kmemleak_late_init);