Blame view

mm/kmemleak.c 56.1 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
  /*
   * 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
85d3a316c   Michel Lespinasse   kmemleak: use rbt...
32
   *   blocks. The object_tree_root is a red black tree used to look-up
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
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
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
   *
93ada579b   Catalin Marinas   mm: kmemleak: opt...
56
   * Locks and mutexes are acquired/nested in the following order:
9d5a4c730   Catalin Marinas   mm: kmemleak: avo...
57
   *
93ada579b   Catalin Marinas   mm: kmemleak: opt...
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.
9d5a4c730   Catalin Marinas   mm: kmemleak: avo...
62
   *
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
63
64
65
66
67
68
69
   * 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
70
  #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
71
72
73
74
75
76
  #include <linux/init.h>
  #include <linux/kernel.h>
  #include <linux/list.h>
  #include <linux/sched.h>
  #include <linux/jiffies.h>
  #include <linux/delay.h>
b95f1b31b   Paul Gortmaker   mm: Map most file...
77
  #include <linux/export.h>
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
78
  #include <linux/kthread.h>
85d3a316c   Michel Lespinasse   kmemleak: use rbt...
79
  #include <linux/rbtree.h>
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
80
81
82
83
84
85
86
87
88
89
90
  #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>
9099daed9   Catalin Marinas   mm: kmemleak: avo...
91
92
  #include <linux/bootmem.h>
  #include <linux/pfn.h>
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
93
94
95
96
97
98
99
100
  #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...
101
  #include <linux/workqueue.h>
04609ccc4   Catalin Marinas   kmemleak: Reduce ...
102
  #include <linux/crc32.h>
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
103
104
105
  
  #include <asm/sections.h>
  #include <asm/processor.h>
60063497a   Arun Sharma   atomic: use <linu...
106
  #include <linux/atomic.h>
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
107

e79ed2f13   Andrey Ryabinin   kmemleak: disable...
108
  #include <linux/kasan.h>
8e019366b   Pekka Enberg   kmemleak: Don't s...
109
  #include <linux/kmemcheck.h>
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
110
  #include <linux/kmemleak.h>
029aeff5d   Laura Abbott   kmemleak: Add sup...
111
  #include <linux/memory_hotplug.h>
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
112
113
114
115
116
  
  /*
   * Kmemleak configuration and common defines.
   */
  #define MAX_TRACE		16	/* stack trace length */
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
117
  #define MSECS_MIN_AGE		5000	/* minimum object age for reporting */
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
118
119
  #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...
120
  #define MAX_SCAN_SIZE		4096	/* maximum size of a scanned block */
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
121
122
  
  #define BYTES_PER_POINTER	sizeof(void *)
216c04b0d   Catalin Marinas   kmemleak: Only us...
123
  /* GFP bitmask for kmemleak internal allocations */
20b5c3039   Vladimir Davydov   Revert "gfp: add ...
124
  #define gfp_kmemleak_mask(gfp)	(((gfp) & (GFP_KERNEL | GFP_ATOMIC)) | \
6ae4bd1f0   Catalin Marinas   kmemleak: Allow k...
125
126
  				 __GFP_NORETRY | __GFP_NOMEMALLOC | \
  				 __GFP_NOWARN)
216c04b0d   Catalin Marinas   kmemleak: Only us...
127

3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
128
129
130
  /* scanning area inside a memory block */
  struct kmemleak_scan_area {
  	struct hlist_node node;
c017b4be3   Catalin Marinas   kmemleak: Simplif...
131
132
  	unsigned long start;
  	size_t size;
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
133
  };
a1084c877   Luis R. Rodriguez   kmemleak: move co...
134
135
  #define KMEMLEAK_GREY	0
  #define KMEMLEAK_BLACK	-1
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
136
137
138
139
  /*
   * 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
85d3a316c   Michel Lespinasse   kmemleak: use rbt...
140
   * rb_node are already protected by the corresponding locks or mutex (see
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
141
142
143
144
145
146
147
148
   * 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;
85d3a316c   Michel Lespinasse   kmemleak: use rbt...
149
  	struct rb_node rb_node;
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
150
151
152
153
154
155
156
157
158
  	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 ...
159
160
  	/* checksum for detecting modified objects */
  	u32 checksum;
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
  	/* 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...
176
177
178
179
180
181
182
183
  /* 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...
184
185
186
187
  /* 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);
85d3a316c   Michel Lespinasse   kmemleak: use rbt...
188
189
190
  /* 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 */
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
191
192
193
194
195
196
197
  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 */
8910ae896   Li Zefan   kmemleak: change ...
198
  static int kmemleak_enabled;
c5f3b1a51   Catalin Marinas   mm: kmemleak: all...
199
200
  /* same as above but only for the kmemleak_free() callback */
  static int kmemleak_free_enabled;
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
201
  /* set in the late_initcall if there were no errors */
8910ae896   Li Zefan   kmemleak: change ...
202
  static int kmemleak_initialized;
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
203
  /* enables or disables early logging of the memory operations */
8910ae896   Li Zefan   kmemleak: change ...
204
  static int kmemleak_early_log = 1;
5f79020cb   Catalin Marinas   kmemleak: Show wh...
205
  /* set if a kmemleak warning was issued */
8910ae896   Li Zefan   kmemleak: change ...
206
  static int kmemleak_warning;
5f79020cb   Catalin Marinas   kmemleak: Show wh...
207
  /* set if a fatal kmemleak error has occurred */
8910ae896   Li Zefan   kmemleak: change ...
208
  static int kmemleak_error;
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
209
210
211
212
  
  /* 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...
213
  static struct task_struct *scan_thread;
acf4968ec   Catalin Marinas   kmemleak: Slightl...
214
  /* used to avoid reporting of recently allocated objects */
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
215
  static unsigned long jiffies_min_age;
acf4968ec   Catalin Marinas   kmemleak: Slightl...
216
  static unsigned long jiffies_last_scan;
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
217
218
219
  /* delay between automatic memory scannings */
  static signed long jiffies_scan_wait;
  /* enables or disables the task stacks scanning */
e0a2a1601   Catalin Marinas   kmemleak: Enable ...
220
  static int kmemleak_stack_scan = 1;
4698c1f2b   Catalin Marinas   kmemleak: Do not ...
221
  /* protects the memory scanning, parameters and debug/kmemleak file access */
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
222
  static DEFINE_MUTEX(scan_mutex);
ab0155a22   Jason Baron   kmemleak: Introdu...
223
224
  /* setting kmemleak=on, will set this var, skipping the disable */
  static int kmemleak_skip_disable;
dc9b3f424   Li Zefan   kmemleak: free in...
225
226
  /* If there are leaks that can be reported */
  static bool kmemleak_found_leaks;
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
227

3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
228
  /*
2030117d2   Catalin Marinas   kmemleak: Fix som...
229
   * Early object allocation/freeing logging. Kmemleak is initialized after the
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
230
   * kernel allocator. However, both the kernel allocator and kmemleak may
2030117d2   Catalin Marinas   kmemleak: Fix som...
231
   * allocate memory blocks which need to be tracked. Kmemleak defines an
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
232
233
234
235
236
237
238
   * arbitrary buffer to hold the allocation/freeing information before it is
   * fully initialized.
   */
  
  /* kmemleak operation type for early logging */
  enum {
  	KMEMLEAK_ALLOC,
f528f0b8e   Catalin Marinas   kmemleak: Handle ...
239
  	KMEMLEAK_ALLOC_PERCPU,
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
240
  	KMEMLEAK_FREE,
53238a60d   Catalin Marinas   kmemleak: Allow p...
241
  	KMEMLEAK_FREE_PART,
f528f0b8e   Catalin Marinas   kmemleak: Handle ...
242
  	KMEMLEAK_FREE_PERCPU,
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
  	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...
258
259
  	unsigned long trace[MAX_TRACE];	/* stack trace */
  	unsigned int trace_len;		/* stack trace length */
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
260
261
262
  };
  
  /* early logging buffer and current position */
a6186d89c   Catalin Marinas   kmemleak: Mark th...
263
264
265
  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...
266
267
268
269
270
271
  
  static void kmemleak_disable(void);
  
  /*
   * Print a warning and dump the stack trace.
   */
5f79020cb   Catalin Marinas   kmemleak: Show wh...
272
  #define kmemleak_warn(x...)	do {		\
598d80914   Joe Perches   mm: convert pr_wa...
273
  	pr_warn(x);				\
5f79020cb   Catalin Marinas   kmemleak: Show wh...
274
  	dump_stack();				\
8910ae896   Li Zefan   kmemleak: change ...
275
  	kmemleak_warning = 1;			\
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
276
277
278
  } while (0)
  
  /*
25985edce   Lucas De Marchi   Fix common misspe...
279
   * Macro invoked when a serious kmemleak condition occurred and cannot be
2030117d2   Catalin Marinas   kmemleak: Fix som...
280
   * recovered from. Kmemleak will be disabled and further allocation/freeing
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
281
282
   * tracing no longer available.
   */
000814f44   Catalin Marinas   kmemleak: Rename ...
283
  #define kmemleak_stop(x...)	do {	\
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
284
285
286
287
288
  	kmemleak_warn(x);		\
  	kmemleak_disable();		\
  } while (0)
  
  /*
0494e0828   Sergey Senozhatsky   kmemleak: Printin...
289
290
291
292
293
294
295
296
297
   * 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;
6fc37c490   Andy Shevchenko   kmemleak: use seq...
298
  	size_t len;
0494e0828   Sergey Senozhatsky   kmemleak: Printin...
299
300
  
  	/* limit the number of lines to HEX_MAX_LINES */
6fc37c490   Andy Shevchenko   kmemleak: use seq...
301
  	len = min_t(size_t, object->size, HEX_MAX_LINES * HEX_ROW_SIZE);
0494e0828   Sergey Senozhatsky   kmemleak: Printin...
302

6fc37c490   Andy Shevchenko   kmemleak: use seq...
303
304
  	seq_printf(seq, "  hex dump (first %zu bytes):
  ", len);
5c335fe02   Dmitry Vyukov   mm: prevent KASAN...
305
  	kasan_disable_current();
6fc37c490   Andy Shevchenko   kmemleak: use seq...
306
307
  	seq_hex_dump(seq, "    ", DUMP_PREFIX_NONE, HEX_ROW_SIZE,
  		     HEX_GROUP_SIZE, ptr, len, HEX_ASCII);
5c335fe02   Dmitry Vyukov   mm: prevent KASAN...
308
  	kasan_enable_current();
0494e0828   Sergey Senozhatsky   kmemleak: Printin...
309
310
311
  }
  
  /*
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
312
313
314
315
316
317
318
319
320
   * 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...
321
  static bool color_white(const struct kmemleak_object *object)
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
322
  {
a1084c877   Luis R. Rodriguez   kmemleak: move co...
323
324
  	return object->count != KMEMLEAK_BLACK &&
  		object->count < object->min_count;
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
325
  }
4a558dd6f   Luis R. Rodriguez   kmemleak: use boo...
326
  static bool color_gray(const struct kmemleak_object *object)
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
327
  {
a1084c877   Luis R. Rodriguez   kmemleak: move co...
328
329
  	return object->min_count != KMEMLEAK_BLACK &&
  		object->count >= object->min_count;
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
330
331
332
  }
  
  /*
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
333
334
335
336
   * 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...
337
  static bool unreferenced_object(struct kmemleak_object *object)
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
338
  {
04609ccc4   Catalin Marinas   kmemleak: Reduce ...
339
  	return (color_white(object) && object->flags & OBJECT_ALLOCATED) &&
acf4968ec   Catalin Marinas   kmemleak: Slightl...
340
341
  		time_before_eq(object->jiffies + jiffies_min_age,
  			       jiffies_last_scan);
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
342
343
344
  }
  
  /*
bab4a34af   Catalin Marinas   kmemleak: Simplif...
345
346
   * 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...
347
   */
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
348
349
350
351
  static void print_unreferenced(struct seq_file *seq,
  			       struct kmemleak_object *object)
  {
  	int i;
fefdd336b   Catalin Marinas   kmemleak: Show th...
352
  	unsigned int msecs_age = jiffies_to_msecs(jiffies - object->jiffies);
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
353

bab4a34af   Catalin Marinas   kmemleak: Simplif...
354
355
356
  	seq_printf(seq, "unreferenced object 0x%08lx (size %zu):
  ",
  		   object->pointer, object->size);
fefdd336b   Catalin Marinas   kmemleak: Show th...
357
358
359
360
  	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...
361
  	hex_dump_object(seq, object);
bab4a34af   Catalin Marinas   kmemleak: Simplif...
362
363
  	seq_printf(seq, "  backtrace:
  ");
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
364
365
366
  
  	for (i = 0; i < object->trace_len; i++) {
  		void *ptr = (void *)object->trace[i];
bab4a34af   Catalin Marinas   kmemleak: Simplif...
367
368
  		seq_printf(seq, "    [<%p>] %pS
  ", ptr, ptr);
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
369
370
371
372
373
374
375
376
377
378
379
380
381
382
  	}
  }
  
  /*
   * 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
383
384
  	pr_notice("Object 0x%08lx (size %zu):
  ",
85d3a316c   Michel Lespinasse   kmemleak: use rbt...
385
  		  object->pointer, object->size);
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
386
387
388
389
390
391
392
  	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...
393
394
  	pr_notice("  flags = 0x%lx
  ", object->flags);
aae0ad7ae   Jianpeng Ma   mm/kmemleak.c: us...
395
396
  	pr_notice("  checksum = %u
  ", object->checksum);
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
397
398
399
400
401
402
  	pr_notice("  backtrace:
  ");
  	print_stack_trace(&trace, 4);
  }
  
  /*
85d3a316c   Michel Lespinasse   kmemleak: use rbt...
403
   * Look-up a memory block metadata (kmemleak_object) in the object search
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
404
405
406
407
408
409
   * 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)
  {
85d3a316c   Michel Lespinasse   kmemleak: use rbt...
410
411
412
413
414
415
416
417
418
419
420
421
  	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 {
5f79020cb   Catalin Marinas   kmemleak: Show wh...
422
423
424
  			kmemleak_warn("Found object by alias at 0x%08lx
  ",
  				      ptr);
a7686a45c   Catalin Marinas   kmemleak: Show mo...
425
  			dump_object_info(object);
85d3a316c   Michel Lespinasse   kmemleak: use rbt...
426
  			break;
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
427
  		}
85d3a316c   Michel Lespinasse   kmemleak: use rbt...
428
429
  	}
  	return NULL;
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
  }
  
  /*
   * 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)
  {
b67bfe0d4   Sasha Levin   hlist: drop the n...
448
  	struct hlist_node *tmp;
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
449
450
451
452
453
454
455
456
  	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.
  	 */
b67bfe0d4   Sasha Levin   hlist: drop the n...
457
458
  	hlist_for_each_entry_safe(area, tmp, &object->area_list, node) {
  		hlist_del(&area->node);
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
  		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);
  }
  
  /*
85d3a316c   Michel Lespinasse   kmemleak: use rbt...
483
   * Look up an object in the object search tree and increase its use_count.
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
484
485
486
487
   */
  static struct kmemleak_object *find_and_get_object(unsigned long ptr, int alias)
  {
  	unsigned long flags;
9fbed2540   Alexey Klimov   mm/kmemleak.c: re...
488
  	struct kmemleak_object *object;
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
489
490
491
  
  	rcu_read_lock();
  	read_lock_irqsave(&kmemleak_lock, flags);
93ada579b   Catalin Marinas   mm: kmemleak: opt...
492
  	object = lookup_object(ptr, alias);
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
493
494
495
496
497
498
499
500
501
502
503
  	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;
  }
  
  /*
e781a9ab4   Catalin Marinas   mm: kmemleak: fix...
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
   * 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;
  }
  
  /*
fd6789675   Catalin Marinas   kmemleak: Save th...
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
   * 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...
541
542
543
   * 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...
544
545
  static struct kmemleak_object *create_object(unsigned long ptr, size_t size,
  					     int min_count, gfp_t gfp)
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
546
547
  {
  	unsigned long flags;
85d3a316c   Michel Lespinasse   kmemleak: use rbt...
548
549
  	struct kmemleak_object *object, *parent;
  	struct rb_node **link, *rb_parent;
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
550

6ae4bd1f0   Catalin Marinas   kmemleak: Allow k...
551
  	object = kmem_cache_alloc(object_cache, gfp_kmemleak_mask(gfp));
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
552
  	if (!object) {
598d80914   Joe Perches   mm: convert pr_wa...
553
554
  		pr_warn("Cannot allocate a kmemleak_object structure
  ");
6ae4bd1f0   Catalin Marinas   kmemleak: Allow k...
555
  		kmemleak_disable();
fd6789675   Catalin Marinas   kmemleak: Save th...
556
  		return NULL;
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
557
558
559
560
561
562
563
  	}
  
  	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 ...
564
  	object->flags = OBJECT_ALLOCATED;
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
565
566
567
  	object->pointer = ptr;
  	object->size = size;
  	object->min_count = min_count;
04609ccc4   Catalin Marinas   kmemleak: Reduce ...
568
  	object->count = 0;			/* white color initially */
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
569
  	object->jiffies = jiffies;
04609ccc4   Catalin Marinas   kmemleak: Reduce ...
570
  	object->checksum = 0;
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
  
  	/* 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...
591
  	object->trace_len = __save_stack_trace(object->trace);
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
592

3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
593
  	write_lock_irqsave(&kmemleak_lock, flags);
0580a1819   Luis R. Rodriguez   kmemleak: fix spa...
594

3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
595
596
  	min_addr = min(min_addr, ptr);
  	max_addr = max(max_addr, ptr + size);
85d3a316c   Michel Lespinasse   kmemleak: use rbt...
597
598
599
600
601
602
603
604
605
606
  	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 {
756a025f0   Joe Perches   mm: coalesce spli...
607
608
  			kmemleak_stop("Cannot insert 0x%lx into the object search tree (overlaps existing)
  ",
85d3a316c   Michel Lespinasse   kmemleak: use rbt...
609
  				      ptr);
9d5a4c730   Catalin Marinas   mm: kmemleak: avo...
610
611
612
613
614
  			/*
  			 * No need for parent->lock here since "parent" cannot
  			 * be freed while the kmemleak_lock is held.
  			 */
  			dump_object_info(parent);
85d3a316c   Michel Lespinasse   kmemleak: use rbt...
615
  			kmem_cache_free(object_cache, object);
9d5a4c730   Catalin Marinas   mm: kmemleak: avo...
616
  			object = NULL;
85d3a316c   Michel Lespinasse   kmemleak: use rbt...
617
618
  			goto out;
  		}
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
619
  	}
85d3a316c   Michel Lespinasse   kmemleak: use rbt...
620
621
  	rb_link_node(&object->rb_node, rb_parent, link);
  	rb_insert_color(&object->rb_node, &object_tree_root);
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
622
623
624
  	list_add_tail_rcu(&object->object_list, &object_list);
  out:
  	write_unlock_irqrestore(&kmemleak_lock, flags);
fd6789675   Catalin Marinas   kmemleak: Save th...
625
  	return object;
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
626
627
628
  }
  
  /*
e781a9ab4   Catalin Marinas   mm: kmemleak: fix...
629
   * Mark the object as not allocated and schedule RCU freeing via put_object().
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
630
   */
53238a60d   Catalin Marinas   kmemleak: Allow p...
631
  static void __delete_object(struct kmemleak_object *object)
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
632
633
  {
  	unsigned long flags;
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
634

3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
635
  	WARN_ON(!(object->flags & OBJECT_ALLOCATED));
e781a9ab4   Catalin Marinas   mm: kmemleak: fix...
636
  	WARN_ON(atomic_read(&object->use_count) < 1);
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
637
638
639
640
641
642
  
  	/*
  	 * 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...
643
644
645
646
647
648
  	object->flags &= ~OBJECT_ALLOCATED;
  	spin_unlock_irqrestore(&object->lock, flags);
  	put_object(object);
  }
  
  /*
53238a60d   Catalin Marinas   kmemleak: Allow p...
649
650
651
652
653
654
   * 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;
e781a9ab4   Catalin Marinas   mm: kmemleak: fix...
655
  	object = find_and_remove_object(ptr, 0);
53238a60d   Catalin Marinas   kmemleak: Allow p...
656
657
658
659
660
661
662
663
664
  	if (!object) {
  #ifdef DEBUG
  		kmemleak_warn("Freeing unknown object at 0x%08lx
  ",
  			      ptr);
  #endif
  		return;
  	}
  	__delete_object(object);
53238a60d   Catalin Marinas   kmemleak: Allow p...
665
666
667
668
669
670
671
672
673
674
675
  }
  
  /*
   * 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;
e781a9ab4   Catalin Marinas   mm: kmemleak: fix...
676
  	object = find_and_remove_object(ptr, 1);
53238a60d   Catalin Marinas   kmemleak: Allow p...
677
678
  	if (!object) {
  #ifdef DEBUG
756a025f0   Joe Perches   mm: coalesce spli...
679
680
681
  		kmemleak_warn("Partially freeing unknown object at 0x%08lx (size %zu)
  ",
  			      ptr, size);
53238a60d   Catalin Marinas   kmemleak: Allow p...
682
683
684
  #endif
  		return;
  	}
53238a60d   Catalin Marinas   kmemleak: Allow p...
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
  
  	/*
  	 * 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);
e781a9ab4   Catalin Marinas   mm: kmemleak: fix...
701
  	__delete_object(object);
53238a60d   Catalin Marinas   kmemleak: Allow p...
702
  }
a1084c877   Luis R. Rodriguez   kmemleak: move co...
703
704
705
706
707
708
709
710
711
  
  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...
712
713
  {
  	unsigned long flags;
a1084c877   Luis R. Rodriguez   kmemleak: move co...
714
715
716
717
718
719
720
721
  
  	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...
722
723
724
725
  	struct kmemleak_object *object;
  
  	object = find_and_get_object(ptr, 0);
  	if (!object) {
756a025f0   Joe Perches   mm: coalesce spli...
726
727
728
  		kmemleak_warn("Trying to color unknown object at 0x%08lx as %s
  ",
  			      ptr,
a1084c877   Luis R. Rodriguez   kmemleak: move co...
729
730
  			      (color == KMEMLEAK_GREY) ? "Grey" :
  			      (color == KMEMLEAK_BLACK) ? "Black" : "Unknown");
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
731
732
  		return;
  	}
a1084c877   Luis R. Rodriguez   kmemleak: move co...
733
  	paint_it(object, color);
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
734
735
736
737
  	put_object(object);
  }
  
  /*
145b64b95   Holger Hans Peter Freyther   kmemleak: Fix typ...
738
   * Mark an object permanently as gray-colored so that it can no longer be
a1084c877   Luis R. Rodriguez   kmemleak: move co...
739
740
741
742
743
744
745
746
   * 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...
747
748
749
750
751
   * 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...
752
  	paint_ptr(ptr, KMEMLEAK_BLACK);
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
753
754
755
756
757
758
  }
  
  /*
   * 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...
759
  static void add_scan_area(unsigned long ptr, size_t size, gfp_t gfp)
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
760
761
762
763
  {
  	unsigned long flags;
  	struct kmemleak_object *object;
  	struct kmemleak_scan_area *area;
c017b4be3   Catalin Marinas   kmemleak: Simplif...
764
  	object = find_and_get_object(ptr, 1);
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
765
  	if (!object) {
ae281064b   Joe Perches   kmemleak: use pr_fmt
766
767
768
  		kmemleak_warn("Adding scan area to unknown object at 0x%08lx
  ",
  			      ptr);
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
769
770
  		return;
  	}
6ae4bd1f0   Catalin Marinas   kmemleak: Allow k...
771
  	area = kmem_cache_alloc(scan_area_cache, gfp_kmemleak_mask(gfp));
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
772
  	if (!area) {
598d80914   Joe Perches   mm: convert pr_wa...
773
774
  		pr_warn("Cannot allocate a scan area
  ");
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
775
776
777
778
  		goto out;
  	}
  
  	spin_lock_irqsave(&object->lock, flags);
7f88f88f8   Catalin Marinas   mm: kmemleak: avo...
779
780
781
  	if (size == SIZE_MAX) {
  		size = object->pointer + object->size - ptr;
  	} else if (ptr + size > object->pointer + object->size) {
ae281064b   Joe Perches   kmemleak: use pr_fmt
782
783
  		kmemleak_warn("Scan area larger than object 0x%08lx
  ", ptr);
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
784
785
786
787
788
789
  		dump_object_info(object);
  		kmem_cache_free(scan_area_cache, area);
  		goto out_unlock;
  	}
  
  	INIT_HLIST_NODE(&area->node);
c017b4be3   Catalin Marinas   kmemleak: Simplif...
790
791
  	area->start = ptr;
  	area->size = size;
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
  
  	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
812
813
  		kmemleak_warn("Not scanning unknown object at 0x%08lx
  ", ptr);
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
814
815
816
817
818
819
820
821
822
823
824
825
826
  		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...
827
  static void __init log_early(int op_type, const void *ptr, size_t size,
c017b4be3   Catalin Marinas   kmemleak: Simplif...
828
  			     int min_count)
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
829
830
831
  {
  	unsigned long flags;
  	struct early_log *log;
8910ae896   Li Zefan   kmemleak: change ...
832
  	if (kmemleak_error) {
b66930052   Catalin Marinas   kmemleak: When th...
833
834
835
836
  		/* kmemleak stopped recording, just count the requests */
  		crt_early_log++;
  		return;
  	}
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
837
  	if (crt_early_log >= ARRAY_SIZE(early_log)) {
21cd3a604   Wang Kai   kmemleak: record ...
838
  		crt_early_log++;
a9d9058ab   Catalin Marinas   kmemleak: Allow t...
839
  		kmemleak_disable();
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
840
841
842
843
844
845
846
847
848
849
850
851
852
  		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;
5f79020cb   Catalin Marinas   kmemleak: Show wh...
853
  	log->trace_len = __save_stack_trace(log->trace);
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
854
855
856
857
858
  	crt_early_log++;
  	local_irq_restore(flags);
  }
  
  /*
fd6789675   Catalin Marinas   kmemleak: Save th...
859
860
861
862
863
864
865
   * 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;
8910ae896   Li Zefan   kmemleak: change ...
866
  	if (!kmemleak_enabled || !log->ptr || IS_ERR(log->ptr))
fd6789675   Catalin Marinas   kmemleak: Save th...
867
868
869
870
871
872
873
  		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...
874
  			       log->min_count, GFP_ATOMIC);
0d5d1aadc   Catalin Marinas   kmemleak: Check f...
875
876
  	if (!object)
  		goto out;
fd6789675   Catalin Marinas   kmemleak: Save th...
877
878
879
880
881
  	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...
882
  out:
fd6789675   Catalin Marinas   kmemleak: Save th...
883
884
  	rcu_read_unlock();
  }
f528f0b8e   Catalin Marinas   kmemleak: Handle ...
885
886
887
888
889
890
891
892
893
894
895
896
897
  /*
   * 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);
  	}
  }
a2b6bf63c   Catalin Marinas   kmemleak: Add Doc...
898
899
900
901
902
903
904
905
906
907
908
909
910
  /**
   * 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
   * (memory block) is allocated (kmem_cache_alloc, kmalloc, vmalloc etc.).
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
911
   */
a6186d89c   Catalin Marinas   kmemleak: Mark th...
912
913
  void __ref kmemleak_alloc(const void *ptr, size_t size, int min_count,
  			  gfp_t gfp)
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
914
915
916
  {
  	pr_debug("%s(0x%p, %zu, %d)
  ", __func__, ptr, size, min_count);
8910ae896   Li Zefan   kmemleak: change ...
917
  	if (kmemleak_enabled && ptr && !IS_ERR(ptr))
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
918
  		create_object((unsigned long)ptr, size, min_count, gfp);
8910ae896   Li Zefan   kmemleak: change ...
919
  	else if (kmemleak_early_log)
c017b4be3   Catalin Marinas   kmemleak: Simplif...
920
  		log_early(KMEMLEAK_ALLOC, ptr, size, min_count);
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
921
922
  }
  EXPORT_SYMBOL_GPL(kmemleak_alloc);
a2b6bf63c   Catalin Marinas   kmemleak: Add Doc...
923
  /**
f528f0b8e   Catalin Marinas   kmemleak: Handle ...
924
925
926
   * kmemleak_alloc_percpu - register a newly allocated __percpu object
   * @ptr:	__percpu pointer to beginning of the object
   * @size:	size of the object
8a8c35fad   Larry Finger   mm: kmemleak_allo...
927
   * @gfp:	flags used for kmemleak internal memory allocations
f528f0b8e   Catalin Marinas   kmemleak: Handle ...
928
929
   *
   * This function is called from the kernel percpu allocator when a new object
8a8c35fad   Larry Finger   mm: kmemleak_allo...
930
   * (memory block) is allocated (alloc_percpu).
f528f0b8e   Catalin Marinas   kmemleak: Handle ...
931
   */
8a8c35fad   Larry Finger   mm: kmemleak_allo...
932
933
  void __ref kmemleak_alloc_percpu(const void __percpu *ptr, size_t size,
  				 gfp_t gfp)
f528f0b8e   Catalin Marinas   kmemleak: Handle ...
934
935
936
937
938
939
940
941
942
943
  {
  	unsigned int cpu;
  
  	pr_debug("%s(0x%p, %zu)
  ", __func__, ptr, size);
  
  	/*
  	 * Percpu allocations are only scanned and not reported as leaks
  	 * (min_count is set to 0).
  	 */
8910ae896   Li Zefan   kmemleak: change ...
944
  	if (kmemleak_enabled && ptr && !IS_ERR(ptr))
f528f0b8e   Catalin Marinas   kmemleak: Handle ...
945
946
  		for_each_possible_cpu(cpu)
  			create_object((unsigned long)per_cpu_ptr(ptr, cpu),
8a8c35fad   Larry Finger   mm: kmemleak_allo...
947
  				      size, 0, gfp);
8910ae896   Li Zefan   kmemleak: change ...
948
  	else if (kmemleak_early_log)
f528f0b8e   Catalin Marinas   kmemleak: Handle ...
949
950
951
952
953
  		log_early(KMEMLEAK_ALLOC_PERCPU, ptr, size, 0);
  }
  EXPORT_SYMBOL_GPL(kmemleak_alloc_percpu);
  
  /**
a2b6bf63c   Catalin Marinas   kmemleak: Add Doc...
954
955
956
957
958
   * 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.).
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
959
   */
a6186d89c   Catalin Marinas   kmemleak: Mark th...
960
  void __ref kmemleak_free(const void *ptr)
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
961
962
963
  {
  	pr_debug("%s(0x%p)
  ", __func__, ptr);
c5f3b1a51   Catalin Marinas   mm: kmemleak: all...
964
  	if (kmemleak_free_enabled && ptr && !IS_ERR(ptr))
53238a60d   Catalin Marinas   kmemleak: Allow p...
965
  		delete_object_full((unsigned long)ptr);
8910ae896   Li Zefan   kmemleak: change ...
966
  	else if (kmemleak_early_log)
c017b4be3   Catalin Marinas   kmemleak: Simplif...
967
  		log_early(KMEMLEAK_FREE, ptr, 0, 0);
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
968
969
  }
  EXPORT_SYMBOL_GPL(kmemleak_free);
a2b6bf63c   Catalin Marinas   kmemleak: Add Doc...
970
971
972
973
974
975
976
977
  /**
   * 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).
53238a60d   Catalin Marinas   kmemleak: Allow p...
978
   */
a6186d89c   Catalin Marinas   kmemleak: Mark th...
979
  void __ref kmemleak_free_part(const void *ptr, size_t size)
53238a60d   Catalin Marinas   kmemleak: Allow p...
980
981
982
  {
  	pr_debug("%s(0x%p)
  ", __func__, ptr);
8910ae896   Li Zefan   kmemleak: change ...
983
  	if (kmemleak_enabled && ptr && !IS_ERR(ptr))
53238a60d   Catalin Marinas   kmemleak: Allow p...
984
  		delete_object_part((unsigned long)ptr, size);
8910ae896   Li Zefan   kmemleak: change ...
985
  	else if (kmemleak_early_log)
c017b4be3   Catalin Marinas   kmemleak: Simplif...
986
  		log_early(KMEMLEAK_FREE_PART, ptr, size, 0);
53238a60d   Catalin Marinas   kmemleak: Allow p...
987
988
  }
  EXPORT_SYMBOL_GPL(kmemleak_free_part);
a2b6bf63c   Catalin Marinas   kmemleak: Add Doc...
989
  /**
f528f0b8e   Catalin Marinas   kmemleak: Handle ...
990
991
992
993
994
995
996
997
998
999
1000
1001
   * 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)
  ", __func__, ptr);
c5f3b1a51   Catalin Marinas   mm: kmemleak: all...
1002
  	if (kmemleak_free_enabled && ptr && !IS_ERR(ptr))
f528f0b8e   Catalin Marinas   kmemleak: Handle ...
1003
1004
1005
  		for_each_possible_cpu(cpu)
  			delete_object_full((unsigned long)per_cpu_ptr(ptr,
  								      cpu));
8910ae896   Li Zefan   kmemleak: change ...
1006
  	else if (kmemleak_early_log)
f528f0b8e   Catalin Marinas   kmemleak: Handle ...
1007
1008
1009
1010
1011
  		log_early(KMEMLEAK_FREE_PERCPU, ptr, 0, 0);
  }
  EXPORT_SYMBOL_GPL(kmemleak_free_percpu);
  
  /**
ffe2c748e   Catalin Marinas   mm: introduce kme...
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
   * 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)
  ", __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
  ",
  			      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);
  
  /**
a2b6bf63c   Catalin Marinas   kmemleak: Add Doc...
1048
1049
1050
1051
1052
   * 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.
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1053
   */
a6186d89c   Catalin Marinas   kmemleak: Mark th...
1054
  void __ref kmemleak_not_leak(const void *ptr)
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1055
1056
1057
  {
  	pr_debug("%s(0x%p)
  ", __func__, ptr);
8910ae896   Li Zefan   kmemleak: change ...
1058
  	if (kmemleak_enabled && ptr && !IS_ERR(ptr))
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1059
  		make_gray_object((unsigned long)ptr);
8910ae896   Li Zefan   kmemleak: change ...
1060
  	else if (kmemleak_early_log)
c017b4be3   Catalin Marinas   kmemleak: Simplif...
1061
  		log_early(KMEMLEAK_NOT_LEAK, ptr, 0, 0);
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1062
1063
  }
  EXPORT_SYMBOL(kmemleak_not_leak);
a2b6bf63c   Catalin Marinas   kmemleak: Add Doc...
1064
1065
1066
1067
1068
1069
1070
1071
  /**
   * 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.
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1072
   */
a6186d89c   Catalin Marinas   kmemleak: Mark th...
1073
  void __ref kmemleak_ignore(const void *ptr)
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1074
1075
1076
  {
  	pr_debug("%s(0x%p)
  ", __func__, ptr);
8910ae896   Li Zefan   kmemleak: change ...
1077
  	if (kmemleak_enabled && ptr && !IS_ERR(ptr))
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1078
  		make_black_object((unsigned long)ptr);
8910ae896   Li Zefan   kmemleak: change ...
1079
  	else if (kmemleak_early_log)
c017b4be3   Catalin Marinas   kmemleak: Simplif...
1080
  		log_early(KMEMLEAK_IGNORE, ptr, 0, 0);
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1081
1082
  }
  EXPORT_SYMBOL(kmemleak_ignore);
a2b6bf63c   Catalin Marinas   kmemleak: Add Doc...
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
  /**
   * 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.
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1093
   */
c017b4be3   Catalin Marinas   kmemleak: Simplif...
1094
  void __ref kmemleak_scan_area(const void *ptr, size_t size, gfp_t gfp)
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1095
1096
1097
  {
  	pr_debug("%s(0x%p)
  ", __func__, ptr);
8910ae896   Li Zefan   kmemleak: change ...
1098
  	if (kmemleak_enabled && ptr && size && !IS_ERR(ptr))
c017b4be3   Catalin Marinas   kmemleak: Simplif...
1099
  		add_scan_area((unsigned long)ptr, size, gfp);
8910ae896   Li Zefan   kmemleak: change ...
1100
  	else if (kmemleak_early_log)
c017b4be3   Catalin Marinas   kmemleak: Simplif...
1101
  		log_early(KMEMLEAK_SCAN_AREA, ptr, size, 0);
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1102
1103
  }
  EXPORT_SYMBOL(kmemleak_scan_area);
a2b6bf63c   Catalin Marinas   kmemleak: Add Doc...
1104
1105
1106
1107
1108
1109
1110
1111
  /**
   * 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.
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1112
   */
a6186d89c   Catalin Marinas   kmemleak: Mark th...
1113
  void __ref kmemleak_no_scan(const void *ptr)
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1114
1115
1116
  {
  	pr_debug("%s(0x%p)
  ", __func__, ptr);
8910ae896   Li Zefan   kmemleak: change ...
1117
  	if (kmemleak_enabled && ptr && !IS_ERR(ptr))
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1118
  		object_no_scan((unsigned long)ptr);
8910ae896   Li Zefan   kmemleak: change ...
1119
  	else if (kmemleak_early_log)
c017b4be3   Catalin Marinas   kmemleak: Simplif...
1120
  		log_early(KMEMLEAK_NO_SCAN, ptr, 0, 0);
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1121
1122
  }
  EXPORT_SYMBOL(kmemleak_no_scan);
9099daed9   Catalin Marinas   mm: kmemleak: avo...
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
  /**
   * kmemleak_alloc_phys - similar to kmemleak_alloc but taking a physical
   *			 address argument
   */
  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
   */
  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
   */
  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
   */
  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);
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1167
  /*
04609ccc4   Catalin Marinas   kmemleak: Reduce ...
1168
1169
1170
1171
1172
1173
1174
1175
   * 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;
e79ed2f13   Andrey Ryabinin   kmemleak: disable...
1176
  	kasan_disable_current();
04609ccc4   Catalin Marinas   kmemleak: Reduce ...
1177
  	object->checksum = crc32(0, (void *)object->pointer, object->size);
e79ed2f13   Andrey Ryabinin   kmemleak: disable...
1178
  	kasan_enable_current();
04609ccc4   Catalin Marinas   kmemleak: Reduce ...
1179
1180
1181
1182
  	return object->checksum != old_csum;
  }
  
  /*
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1183
   * Memory scanning is a long process and it needs to be interruptable. This
25985edce   Lucas De Marchi   Fix common misspe...
1184
   * function checks whether such interrupt condition occurred.
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1185
1186
1187
   */
  static int scan_should_stop(void)
  {
8910ae896   Li Zefan   kmemleak: change ...
1188
  	if (!kmemleak_enabled)
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
  		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,
93ada579b   Catalin Marinas   mm: kmemleak: opt...
1208
  		       struct kmemleak_object *scanned)
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1209
1210
1211
1212
  {
  	unsigned long *ptr;
  	unsigned long *start = PTR_ALIGN(_start, BYTES_PER_POINTER);
  	unsigned long *end = _end - (BYTES_PER_POINTER - 1);
93ada579b   Catalin Marinas   mm: kmemleak: opt...
1213
  	unsigned long flags;
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1214

93ada579b   Catalin Marinas   mm: kmemleak: opt...
1215
  	read_lock_irqsave(&kmemleak_lock, flags);
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1216
  	for (ptr = start; ptr < end; ptr++) {
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1217
  		struct kmemleak_object *object;
8e019366b   Pekka Enberg   kmemleak: Don't s...
1218
  		unsigned long pointer;
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1219
1220
1221
  
  		if (scan_should_stop())
  			break;
8e019366b   Pekka Enberg   kmemleak: Don't s...
1222
1223
1224
1225
  		/* don't scan uninitialized memory */
  		if (!kmemcheck_is_obj_initialized((unsigned long)ptr,
  						  BYTES_PER_POINTER))
  			continue;
e79ed2f13   Andrey Ryabinin   kmemleak: disable...
1226
  		kasan_disable_current();
8e019366b   Pekka Enberg   kmemleak: Don't s...
1227
  		pointer = *ptr;
e79ed2f13   Andrey Ryabinin   kmemleak: disable...
1228
  		kasan_enable_current();
8e019366b   Pekka Enberg   kmemleak: Don't s...
1229

93ada579b   Catalin Marinas   mm: kmemleak: opt...
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
  		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);
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1240
1241
  		if (!object)
  			continue;
93ada579b   Catalin Marinas   mm: kmemleak: opt...
1242
  		if (object == scanned)
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1243
  			/* self referenced, ignore */
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1244
  			continue;
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1245
1246
1247
1248
1249
1250
  
  		/*
  		 * Avoid the lockdep recursive warning on object->lock being
  		 * previously acquired in scan_object(). These locks are
  		 * enclosed by scan_mutex.
  		 */
93ada579b   Catalin Marinas   mm: kmemleak: opt...
1251
  		spin_lock_nested(&object->lock, SINGLE_DEPTH_NESTING);
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1252
1253
  		if (!color_white(object)) {
  			/* non-orphan, ignored or new */
93ada579b   Catalin Marinas   mm: kmemleak: opt...
1254
  			spin_unlock(&object->lock);
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
  			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...
1265
  		if (color_gray(object)) {
93ada579b   Catalin Marinas   mm: kmemleak: opt...
1266
1267
  			/* put_object() called when removing from gray_list */
  			WARN_ON(!get_object(object));
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1268
  			list_add_tail(&object->gray_list, &gray_list);
0587da40b   Catalin Marinas   kmemleak: Release...
1269
  		}
93ada579b   Catalin Marinas   mm: kmemleak: opt...
1270
1271
1272
1273
  		spin_unlock(&object->lock);
  	}
  	read_unlock_irqrestore(&kmemleak_lock, flags);
  }
0587da40b   Catalin Marinas   kmemleak: Release...
1274

93ada579b   Catalin Marinas   mm: kmemleak: opt...
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
  /*
   * Scan a large memory block in MAX_SCAN_SIZE chunks to reduce the latency.
   */
  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();
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
  	}
  }
  
  /*
   * 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;
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1297
1298
1299
  	unsigned long flags;
  
  	/*
21ae2956c   Uwe Kleine-König   tree-wide: fix ty...
1300
1301
  	 * 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...
1302
1303
1304
1305
1306
1307
1308
  	 */
  	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...
1309
1310
1311
  	if (hlist_empty(&object->area_list)) {
  		void *start = (void *)object->pointer;
  		void *end = (void *)(object->pointer + object->size);
93ada579b   Catalin Marinas   mm: kmemleak: opt...
1312
1313
1314
1315
1316
  		void *next;
  
  		do {
  			next = min(start + MAX_SCAN_SIZE, end);
  			scan_block(start, next, object);
af98603da   Catalin Marinas   kmemleak: Allow r...
1317

93ada579b   Catalin Marinas   mm: kmemleak: opt...
1318
1319
1320
  			start = next;
  			if (start >= end)
  				break;
af98603da   Catalin Marinas   kmemleak: Allow r...
1321
1322
1323
1324
  
  			spin_unlock_irqrestore(&object->lock, flags);
  			cond_resched();
  			spin_lock_irqsave(&object->lock, flags);
93ada579b   Catalin Marinas   mm: kmemleak: opt...
1325
  		} while (object->flags & OBJECT_ALLOCATED);
af98603da   Catalin Marinas   kmemleak: Allow r...
1326
  	} else
b67bfe0d4   Sasha Levin   hlist: drop the n...
1327
  		hlist_for_each_entry(area, &object->area_list, node)
c017b4be3   Catalin Marinas   kmemleak: Simplif...
1328
1329
  			scan_block((void *)area->start,
  				   (void *)(area->start + area->size),
93ada579b   Catalin Marinas   mm: kmemleak: opt...
1330
  				   object);
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1331
1332
1333
1334
1335
  out:
  	spin_unlock_irqrestore(&object->lock, flags);
  }
  
  /*
04609ccc4   Catalin Marinas   kmemleak: Reduce ...
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
   * 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...
1369
1370
1371
1372
1373
1374
1375
   * 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 ...
1376
  	struct kmemleak_object *object;
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1377
  	int i;
4698c1f2b   Catalin Marinas   kmemleak: Do not ...
1378
  	int new_leaks = 0;
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1379

acf4968ec   Catalin Marinas   kmemleak: Slightl...
1380
  	jiffies_last_scan = jiffies;
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
  	/* 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
1391
1392
  			pr_debug("object->use_count = %d
  ",
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
  				 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 */
93ada579b   Catalin Marinas   mm: kmemleak: opt...
1407
1408
  	scan_large_block(_sdata, _edata);
  	scan_large_block(__bss_start, __bss_stop);
d7c19b066   Jakub Kicinski   mm: kmemleak: sca...
1409
  	scan_large_block(__start_data_ro_after_init, __end_data_ro_after_init);
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1410
1411
1412
1413
  
  #ifdef CONFIG_SMP
  	/* per-cpu sections scanning */
  	for_each_possible_cpu(i)
93ada579b   Catalin Marinas   mm: kmemleak: opt...
1414
1415
  		scan_large_block(__per_cpu_start + per_cpu_offset(i),
  				 __per_cpu_end + per_cpu_offset(i));
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1416
1417
1418
  #endif
  
  	/*
029aeff5d   Laura Abbott   kmemleak: Add sup...
1419
  	 * Struct page scanning for each node.
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1420
  	 */
bfc8c9013   Vladimir Davydov   mem-hotplug: impl...
1421
  	get_online_mems();
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1422
  	for_each_online_node(i) {
108bcc96e   Cody P Schafer   mm: add & use zon...
1423
1424
  		unsigned long start_pfn = node_start_pfn(i);
  		unsigned long end_pfn = node_end_pfn(i);
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
  		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;
93ada579b   Catalin Marinas   mm: kmemleak: opt...
1436
  			scan_block(page, page + 1, NULL);
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1437
1438
  		}
  	}
bfc8c9013   Vladimir Davydov   mem-hotplug: impl...
1439
  	put_online_mems();
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1440
1441
  
  	/*
43ed5d6ee   Catalin Marinas   kmemleak: Scan al...
1442
  	 * Scanning the task stacks (may introduce false negatives).
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1443
1444
  	 */
  	if (kmemleak_stack_scan) {
43ed5d6ee   Catalin Marinas   kmemleak: Scan al...
1445
  		struct task_struct *p, *g;
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1446
  		read_lock(&tasklist_lock);
43ed5d6ee   Catalin Marinas   kmemleak: Scan al...
1447
  		do_each_thread(g, p) {
37df49f43   Catalin Marinas   mm: kmemleak: ens...
1448
1449
1450
1451
1452
  			void *stack = try_get_task_stack(p);
  			if (stack) {
  				scan_block(stack, stack + THREAD_SIZE, NULL);
  				put_task_stack(p);
  			}
43ed5d6ee   Catalin Marinas   kmemleak: Scan al...
1453
  		} while_each_thread(g, p);
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1454
1455
1456
1457
1458
  		read_unlock(&tasklist_lock);
  	}
  
  	/*
  	 * Scan the objects already referenced from the sections scanned
04609ccc4   Catalin Marinas   kmemleak: Reduce ...
1459
  	 * above.
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1460
  	 */
04609ccc4   Catalin Marinas   kmemleak: Reduce ...
1461
  	scan_gray_list();
2587362ea   Catalin Marinas   kmemleak: Scan ob...
1462
1463
  
  	/*
04609ccc4   Catalin Marinas   kmemleak: Reduce ...
1464
1465
  	 * 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...
1466
1467
1468
1469
  	 */
  	rcu_read_lock();
  	list_for_each_entry_rcu(object, &object_list, object_list) {
  		spin_lock_irqsave(&object->lock, flags);
04609ccc4   Catalin Marinas   kmemleak: Reduce ...
1470
1471
1472
1473
  		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...
1474
1475
1476
1477
1478
  			list_add_tail(&object->gray_list, &gray_list);
  		}
  		spin_unlock_irqrestore(&object->lock, flags);
  	}
  	rcu_read_unlock();
04609ccc4   Catalin Marinas   kmemleak: Reduce ...
1479
1480
1481
1482
  	/*
  	 * Re-scan the gray list for modified unreferenced objects.
  	 */
  	scan_gray_list();
4698c1f2b   Catalin Marinas   kmemleak: Do not ...
1483
1484
  
  	/*
04609ccc4   Catalin Marinas   kmemleak: Reduce ...
1485
  	 * If scanning was stopped do not report any new unreferenced objects.
17bb9e0d9   Catalin Marinas   kmemleak: Do not ...
1486
  	 */
04609ccc4   Catalin Marinas   kmemleak: Reduce ...
1487
  	if (scan_should_stop())
17bb9e0d9   Catalin Marinas   kmemleak: Do not ...
1488
1489
1490
  		return;
  
  	/*
4698c1f2b   Catalin Marinas   kmemleak: Do not ...
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
  	 * 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();
dc9b3f424   Li Zefan   kmemleak: free in...
1504
1505
  	if (new_leaks) {
  		kmemleak_found_leaks = true;
756a025f0   Joe Perches   mm: coalesce spli...
1506
1507
1508
  		pr_info("%d new suspected memory leaks (see /sys/kernel/debug/kmemleak)
  ",
  			new_leaks);
dc9b3f424   Li Zefan   kmemleak: free in...
1509
  	}
4698c1f2b   Catalin Marinas   kmemleak: Do not ...
1510

3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1511
1512
1513
1514
1515
1516
1517
1518
1519
  }
  
  /*
   * 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
1520
1521
  	pr_info("Automatic memory scanning thread started
  ");
bf2a76b31   Catalin Marinas   kmemleak: Renice ...
1522
  	set_user_nice(current, 10);
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1523
1524
1525
1526
1527
  
  	/*
  	 * Wait before the first scan to allow the system to fully initialize.
  	 */
  	if (first_run) {
98c42d945   Vegard Nossum   kmemleak: don't h...
1528
  		signed long timeout = msecs_to_jiffies(SECS_FIRST_SCAN * 1000);
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1529
  		first_run = 0;
98c42d945   Vegard Nossum   kmemleak: don't h...
1530
1531
  		while (timeout && !kthread_should_stop())
  			timeout = schedule_timeout_interruptible(timeout);
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1532
1533
1534
  	}
  
  	while (!kthread_should_stop()) {
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1535
1536
1537
  		signed long timeout = jiffies_scan_wait;
  
  		mutex_lock(&scan_mutex);
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1538
  		kmemleak_scan();
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1539
  		mutex_unlock(&scan_mutex);
4698c1f2b   Catalin Marinas   kmemleak: Do not ...
1540

3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1541
1542
1543
1544
  		/* wait before the next scan */
  		while (timeout && !kthread_should_stop())
  			timeout = schedule_timeout_interruptible(timeout);
  	}
ae281064b   Joe Perches   kmemleak: use pr_fmt
1545
1546
  	pr_info("Automatic memory scanning thread ended
  ");
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1547
1548
1549
1550
1551
1552
  
  	return 0;
  }
  
  /*
   * Start the automatic memory scanning thread. This function must be called
4698c1f2b   Catalin Marinas   kmemleak: Do not ...
1553
   * with the scan_mutex held.
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1554
   */
7eb0d5e5b   Luis R. Rodriguez   kmemleak: fix spa...
1555
  static void start_scan_thread(void)
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1556
1557
1558
1559
1560
  {
  	if (scan_thread)
  		return;
  	scan_thread = kthread_run(kmemleak_scan_thread, NULL, "kmemleak");
  	if (IS_ERR(scan_thread)) {
598d80914   Joe Perches   mm: convert pr_wa...
1561
1562
  		pr_warn("Failed to create the scan thread
  ");
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1563
1564
1565
1566
1567
1568
  		scan_thread = NULL;
  	}
  }
  
  /*
   * Stop the automatic memory scanning thread. This function must be called
4698c1f2b   Catalin Marinas   kmemleak: Do not ...
1569
   * with the scan_mutex held.
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1570
   */
7eb0d5e5b   Luis R. Rodriguez   kmemleak: fix spa...
1571
  static void stop_scan_thread(void)
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
  {
  	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 ...
1588
1589
1590
1591
1592
  	int err;
  
  	err = mutex_lock_interruptible(&scan_mutex);
  	if (err < 0)
  		return ERR_PTR(err);
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1593

3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1594
1595
1596
1597
1598
1599
1600
1601
1602
  	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...
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
  	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;
58fac0956   Michael Wang   kmemleak: Replace...
1614
  	struct kmemleak_object *obj = prev_obj;
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1615
1616
  
  	++(*pos);
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1617

58fac0956   Michael Wang   kmemleak: Replace...
1618
  	list_for_each_entry_continue_rcu(obj, &object_list, object_list) {
52c3ce4ec   Catalin Marinas   kmemleak: Do not ...
1619
1620
  		if (get_object(obj)) {
  			next_obj = obj;
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1621
  			break;
52c3ce4ec   Catalin Marinas   kmemleak: Do not ...
1622
  		}
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1623
  	}
288c857d6   Catalin Marinas   kmemleak: Remove ...
1624

3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1625
1626
1627
1628
1629
1630
1631
1632
1633
  	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 ...
1634
1635
1636
1637
1638
  	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...
1639
  		rcu_read_unlock();
b87324d08   Catalin Marinas   kmemleak: Do not ...
1640
1641
1642
1643
  		mutex_unlock(&scan_mutex);
  		if (v)
  			put_object(v);
  	}
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
  }
  
  /*
   * 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 ...
1655
  	if ((object->flags & OBJECT_REPORTED) && unreferenced_object(object))
17bb9e0d9   Catalin Marinas   kmemleak: Do not ...
1656
  		print_unreferenced(seq, object);
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
  	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)
  {
b87324d08   Catalin Marinas   kmemleak: Do not ...
1670
  	return seq_open(file, &kmemleak_seq_ops);
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1671
  }
189d84ed5   Catalin Marinas   kmemleak: Dump ob...
1672
1673
1674
1675
1676
  static int dump_str_object_info(const char *str)
  {
  	unsigned long flags;
  	struct kmemleak_object *object;
  	unsigned long addr;
dc053733e   Abhijit Pawar   mm/kmemleak.c: re...
1677
1678
  	if (kstrtoul(str, 0, &addr))
  		return -EINVAL;
189d84ed5   Catalin Marinas   kmemleak: Dump ob...
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
  	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...
1693
  /*
30b371010   Luis R. Rodriguez   kmemleak: add cle...
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
   * 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...
1709
  			__paint_it(object, KMEMLEAK_GREY);
30b371010   Luis R. Rodriguez   kmemleak: add cle...
1710
1711
1712
  		spin_unlock_irqrestore(&object->lock, flags);
  	}
  	rcu_read_unlock();
dc9b3f424   Li Zefan   kmemleak: free in...
1713
1714
  
  	kmemleak_found_leaks = false;
30b371010   Luis R. Rodriguez   kmemleak: add cle...
1715
  }
c89da70c7   Li Zefan   kmemleak: allow f...
1716
  static void __kmemleak_do_cleanup(void);
30b371010   Luis R. Rodriguez   kmemleak: add cle...
1717
  /*
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1718
1719
1720
1721
1722
1723
1724
1725
1726
   * 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 ...
1727
   *   scan	- trigger a memory scan
30b371010   Luis R. Rodriguez   kmemleak: add cle...
1728
   *   clear	- mark all current reported unreferenced kmemleak objects as
c89da70c7   Li Zefan   kmemleak: allow f...
1729
1730
   *		  grey to ignore printing them, or free all kmemleak objects
   *		  if kmemleak has been disabled.
189d84ed5   Catalin Marinas   kmemleak: Dump ob...
1731
   *   dump=...	- dump information about the object found at the given address
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1732
1733
1734
1735
1736
1737
   */
  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 ...
1738
  	int ret;
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1739
1740
1741
1742
1743
  
  	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 ...
1744
1745
1746
  	ret = mutex_lock_interruptible(&scan_mutex);
  	if (ret < 0)
  		return ret;
c89da70c7   Li Zefan   kmemleak: allow f...
1747
  	if (strncmp(buf, "clear", 5) == 0) {
8910ae896   Li Zefan   kmemleak: change ...
1748
  		if (kmemleak_enabled)
c89da70c7   Li Zefan   kmemleak: allow f...
1749
1750
1751
1752
1753
  			kmemleak_clear();
  		else
  			__kmemleak_do_cleanup();
  		goto out;
  	}
8910ae896   Li Zefan   kmemleak: change ...
1754
  	if (!kmemleak_enabled) {
c89da70c7   Li Zefan   kmemleak: allow f...
1755
1756
1757
  		ret = -EBUSY;
  		goto out;
  	}
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
  	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...
1770

3dbb95f78   Jingoo Han   mm: replace stric...
1771
  		ret = kstrtoul(buf + 5, 0, &secs);
b87324d08   Catalin Marinas   kmemleak: Do not ...
1772
1773
  		if (ret < 0)
  			goto out;
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1774
1775
1776
1777
1778
  		stop_scan_thread();
  		if (secs) {
  			jiffies_scan_wait = msecs_to_jiffies(secs * 1000);
  			start_scan_thread();
  		}
4698c1f2b   Catalin Marinas   kmemleak: Do not ...
1779
1780
  	} else if (strncmp(buf, "scan", 4) == 0)
  		kmemleak_scan();
189d84ed5   Catalin Marinas   kmemleak: Dump ob...
1781
1782
  	else if (strncmp(buf, "dump=", 5) == 0)
  		ret = dump_str_object_info(buf + 5);
4698c1f2b   Catalin Marinas   kmemleak: Do not ...
1783
  	else
b87324d08   Catalin Marinas   kmemleak: Do not ...
1784
1785
1786
1787
1788
1789
  		ret = -EINVAL;
  
  out:
  	mutex_unlock(&scan_mutex);
  	if (ret < 0)
  		return ret;
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
  
  	/* 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,
5f3bf19ae   Li Zefan   kmemleak: remove ...
1802
  	.release	= seq_release,
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1803
  };
c89da70c7   Li Zefan   kmemleak: allow f...
1804
1805
1806
1807
1808
1809
1810
1811
1812
  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();
  }
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1813
  /*
74341703e   Catalin Marinas   kmemleak: Report ...
1814
1815
1816
   * 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).
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1817
   */
179a8100e   Catalin Marinas   kmemleak: Do no c...
1818
  static void kmemleak_do_cleanup(struct work_struct *work)
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1819
  {
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1820
  	stop_scan_thread();
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1821

c5f3b1a51   Catalin Marinas   mm: kmemleak: all...
1822
1823
1824
1825
1826
1827
  	/*
  	 * Once the scan thread 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.
  	 */
  	kmemleak_free_enabled = 0;
c89da70c7   Li Zefan   kmemleak: allow f...
1828
1829
1830
  	if (!kmemleak_found_leaks)
  		__kmemleak_do_cleanup();
  	else
756a025f0   Joe Perches   mm: coalesce spli...
1831
1832
  		pr_info("Kmemleak disabled without freeing internal data. Reclaim the memory with \"echo clear > /sys/kernel/debug/kmemleak\".
  ");
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1833
  }
179a8100e   Catalin Marinas   kmemleak: Do no c...
1834
  static DECLARE_WORK(cleanup_work, kmemleak_do_cleanup);
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1835
1836
1837
1838
1839
1840
1841
1842
  
  /*
   * 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 */
8910ae896   Li Zefan   kmemleak: change ...
1843
  	if (cmpxchg(&kmemleak_error, 0, 1))
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1844
1845
1846
  		return;
  
  	/* stop any memory operation tracing */
8910ae896   Li Zefan   kmemleak: change ...
1847
  	kmemleak_enabled = 0;
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1848
1849
  
  	/* check whether it is too early for a kernel thread */
8910ae896   Li Zefan   kmemleak: change ...
1850
  	if (kmemleak_initialized)
179a8100e   Catalin Marinas   kmemleak: Do no c...
1851
  		schedule_work(&cleanup_work);
c5f3b1a51   Catalin Marinas   mm: kmemleak: all...
1852
1853
  	else
  		kmemleak_free_enabled = 0;
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
  
  	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();
ab0155a22   Jason Baron   kmemleak: Introdu...
1868
1869
1870
  	else if (strcmp(str, "on") == 0)
  		kmemleak_skip_disable = 1;
  	else
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1871
1872
1873
1874
  		return -EINVAL;
  	return 0;
  }
  early_param("kmemleak", kmemleak_boot_config);
5f79020cb   Catalin Marinas   kmemleak: Show wh...
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
  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:
  ");
  	print_stack_trace(&trace, 2);
  }
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1886
  /*
2030117d2   Catalin Marinas   kmemleak: Fix som...
1887
   * Kmemleak initialization.
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1888
1889
1890
1891
1892
   */
  void __init kmemleak_init(void)
  {
  	int i;
  	unsigned long flags;
ab0155a22   Jason Baron   kmemleak: Introdu...
1893
1894
  #ifdef CONFIG_DEBUG_KMEMLEAK_DEFAULT_OFF
  	if (!kmemleak_skip_disable) {
3551a9280   Catalin Marinas   mm: postpone the ...
1895
  		kmemleak_early_log = 0;
ab0155a22   Jason Baron   kmemleak: Introdu...
1896
1897
1898
1899
  		kmemleak_disable();
  		return;
  	}
  #endif
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1900
1901
1902
1903
1904
  	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);
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1905

21cd3a604   Wang Kai   kmemleak: record ...
1906
  	if (crt_early_log > ARRAY_SIZE(early_log))
598d80914   Joe Perches   mm: convert pr_wa...
1907
1908
1909
  		pr_warn("Early log buffer exceeded (%d), please increase DEBUG_KMEMLEAK_EARLY_LOG_SIZE
  ",
  			crt_early_log);
b66930052   Catalin Marinas   kmemleak: When th...
1910

3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1911
1912
  	/* the kernel is still in UP mode, so disabling the IRQs is enough */
  	local_irq_save(flags);
3551a9280   Catalin Marinas   mm: postpone the ...
1913
  	kmemleak_early_log = 0;
8910ae896   Li Zefan   kmemleak: change ...
1914
  	if (kmemleak_error) {
b66930052   Catalin Marinas   kmemleak: When th...
1915
1916
  		local_irq_restore(flags);
  		return;
c5f3b1a51   Catalin Marinas   mm: kmemleak: all...
1917
  	} else {
8910ae896   Li Zefan   kmemleak: change ...
1918
  		kmemleak_enabled = 1;
c5f3b1a51   Catalin Marinas   mm: kmemleak: all...
1919
1920
  		kmemleak_free_enabled = 1;
  	}
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
  	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...
1933
  			early_alloc(log);
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1934
  			break;
f528f0b8e   Catalin Marinas   kmemleak: Handle ...
1935
1936
1937
  		case KMEMLEAK_ALLOC_PERCPU:
  			early_alloc_percpu(log);
  			break;
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1938
1939
1940
  		case KMEMLEAK_FREE:
  			kmemleak_free(log->ptr);
  			break;
53238a60d   Catalin Marinas   kmemleak: Allow p...
1941
1942
1943
  		case KMEMLEAK_FREE_PART:
  			kmemleak_free_part(log->ptr, log->size);
  			break;
f528f0b8e   Catalin Marinas   kmemleak: Handle ...
1944
1945
1946
  		case KMEMLEAK_FREE_PERCPU:
  			kmemleak_free_percpu(log->ptr);
  			break;
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1947
1948
1949
1950
1951
1952
1953
  		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...
1954
  			kmemleak_scan_area(log->ptr, log->size, GFP_KERNEL);
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1955
1956
1957
1958
1959
  			break;
  		case KMEMLEAK_NO_SCAN:
  			kmemleak_no_scan(log->ptr);
  			break;
  		default:
5f79020cb   Catalin Marinas   kmemleak: Show wh...
1960
1961
1962
1963
  			kmemleak_warn("Unknown early log operation: %d
  ",
  				      log->op_type);
  		}
8910ae896   Li Zefan   kmemleak: change ...
1964
  		if (kmemleak_warning) {
5f79020cb   Catalin Marinas   kmemleak: Show wh...
1965
  			print_log_trace(log);
8910ae896   Li Zefan   kmemleak: change ...
1966
  			kmemleak_warning = 0;
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
  		}
  	}
  }
  
  /*
   * Late initialization function.
   */
  static int __init kmemleak_late_init(void)
  {
  	struct dentry *dentry;
8910ae896   Li Zefan   kmemleak: change ...
1977
  	kmemleak_initialized = 1;
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1978

8910ae896   Li Zefan   kmemleak: change ...
1979
  	if (kmemleak_error) {
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1980
  		/*
25985edce   Lucas De Marchi   Fix common misspe...
1981
  		 * Some error occurred and kmemleak was disabled. There is a
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1982
1983
1984
1985
  		 * 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...
1986
  		schedule_work(&cleanup_work);
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1987
1988
1989
1990
1991
1992
  		return -ENOMEM;
  	}
  
  	dentry = debugfs_create_file("kmemleak", S_IRUGO, NULL, NULL,
  				     &kmemleak_fops);
  	if (!dentry)
598d80914   Joe Perches   mm: convert pr_wa...
1993
1994
  		pr_warn("Failed to create the debugfs kmemleak file
  ");
4698c1f2b   Catalin Marinas   kmemleak: Do not ...
1995
  	mutex_lock(&scan_mutex);
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1996
  	start_scan_thread();
4698c1f2b   Catalin Marinas   kmemleak: Do not ...
1997
  	mutex_unlock(&scan_mutex);
3c7b4e6b8   Catalin Marinas   kmemleak: Add the...
1998
1999
2000
2001
2002
2003
2004
  
  	pr_info("Kernel memory leak detector initialized
  ");
  
  	return 0;
  }
  late_initcall(kmemleak_late_init);