blob: b57383c17cf60706f45ae3d20b2295b181ed69a6 [file] [log] [blame]
Thomas Gleixner45051532019-05-29 16:57:47 -07001// SPDX-License-Identifier: GPL-2.0-only
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01002/*
3 * mm/kmemleak.c
4 *
5 * Copyright (C) 2008 ARM Limited
6 * Written by Catalin Marinas <catalin.marinas@arm.com>
7 *
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01008 * For more information on the algorithm and kmemleak usage, please see
Andreas Platschek22901c62016-12-12 16:42:01 -08009 * Documentation/dev-tools/kmemleak.rst.
Catalin Marinas3c7b4e62009-06-11 13:22:39 +010010 *
11 * Notes on locking
12 * ----------------
13 *
14 * The following locks and mutexes are used by kmemleak:
15 *
He Zhe8c96f1b2020-01-30 22:12:00 -080016 * - kmemleak_lock (raw_spinlock_t): protects the object_list modifications and
Catalin Marinas3c7b4e62009-06-11 13:22:39 +010017 * accesses to the object_tree_root. The object_list is the main list
18 * holding the metadata (struct kmemleak_object) for the allocated memory
Michel Lespinasse85d3a312012-10-08 16:31:27 -070019 * blocks. The object_tree_root is a red black tree used to look-up
Catalin Marinas3c7b4e62009-06-11 13:22:39 +010020 * metadata based on a pointer to the corresponding memory block. The
21 * kmemleak_object structures are added to the object_list and
22 * object_tree_root in the create_object() function called from the
23 * kmemleak_alloc() callback and removed in delete_object() called from the
24 * kmemleak_free() callback
He Zhe8c96f1b2020-01-30 22:12:00 -080025 * - kmemleak_object.lock (raw_spinlock_t): protects a kmemleak_object.
26 * Accesses to the metadata (e.g. count) are protected by this lock. Note
27 * that some members of this structure may be protected by other means
28 * (atomic or kmemleak_lock). This lock is also held when scanning the
29 * corresponding memory block to avoid the kernel freeing it via the
30 * kmemleak_free() callback. This is less heavyweight than holding a global
31 * lock like kmemleak_lock during scanning.
Catalin Marinas3c7b4e62009-06-11 13:22:39 +010032 * - scan_mutex (mutex): ensures that only one thread may scan the memory for
33 * unreferenced objects at a time. The gray_list contains the objects which
34 * are already referenced or marked as false positives and need to be
35 * scanned. This list is only modified during a scanning episode when the
36 * scan_mutex is held. At the end of a scan, the gray_list is always empty.
37 * Note that the kmemleak_object.use_count is incremented when an object is
Catalin Marinas4698c1f2009-06-26 17:38:27 +010038 * added to the gray_list and therefore cannot be freed. This mutex also
39 * prevents multiple users of the "kmemleak" debugfs file together with
40 * modifications to the memory scanning parameters including the scan_thread
41 * pointer
Catalin Marinas3c7b4e62009-06-11 13:22:39 +010042 *
Catalin Marinas93ada572015-06-24 16:58:37 -070043 * Locks and mutexes are acquired/nested in the following order:
Catalin Marinas9d5a4c72015-06-24 16:58:34 -070044 *
Catalin Marinas93ada572015-06-24 16:58:37 -070045 * scan_mutex [-> object->lock] -> kmemleak_lock -> other_object->lock (SINGLE_DEPTH_NESTING)
46 *
47 * No kmemleak_lock and object->lock nesting is allowed outside scan_mutex
48 * regions.
Catalin Marinas9d5a4c72015-06-24 16:58:34 -070049 *
Catalin Marinas3c7b4e62009-06-11 13:22:39 +010050 * The kmemleak_object structures have a use_count incremented or decremented
51 * using the get_object()/put_object() functions. When the use_count becomes
52 * 0, this count can no longer be incremented and put_object() schedules the
53 * kmemleak_object freeing via an RCU callback. All calls to the get_object()
54 * function must be protected by rcu_read_lock() to avoid accessing a freed
55 * structure.
56 */
57
Joe Perchesae281062009-06-23 14:40:26 +010058#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
59
Catalin Marinas3c7b4e62009-06-11 13:22:39 +010060#include <linux/init.h>
61#include <linux/kernel.h>
62#include <linux/list.h>
Ingo Molnar3f07c012017-02-08 18:51:30 +010063#include <linux/sched/signal.h>
Ingo Molnar29930022017-02-08 18:51:36 +010064#include <linux/sched/task.h>
Ingo Molnar68db0cf2017-02-08 18:51:37 +010065#include <linux/sched/task_stack.h>
Catalin Marinas3c7b4e62009-06-11 13:22:39 +010066#include <linux/jiffies.h>
67#include <linux/delay.h>
Paul Gortmakerb95f1b312011-10-16 02:01:52 -040068#include <linux/export.h>
Catalin Marinas3c7b4e62009-06-11 13:22:39 +010069#include <linux/kthread.h>
Michel Lespinasse85d3a312012-10-08 16:31:27 -070070#include <linux/rbtree.h>
Catalin Marinas3c7b4e62009-06-11 13:22:39 +010071#include <linux/fs.h>
72#include <linux/debugfs.h>
73#include <linux/seq_file.h>
74#include <linux/cpumask.h>
75#include <linux/spinlock.h>
Vincent Whitchurch154221c2018-10-26 15:03:42 -070076#include <linux/module.h>
Catalin Marinas3c7b4e62009-06-11 13:22:39 +010077#include <linux/mutex.h>
78#include <linux/rcupdate.h>
79#include <linux/stacktrace.h>
80#include <linux/cache.h>
81#include <linux/percpu.h>
Mike Rapoport57c8a662018-10-30 15:09:49 -070082#include <linux/memblock.h>
Catalin Marinas9099dae2016-10-11 13:55:11 -070083#include <linux/pfn.h>
Catalin Marinas3c7b4e62009-06-11 13:22:39 +010084#include <linux/mmzone.h>
85#include <linux/slab.h>
86#include <linux/thread_info.h>
87#include <linux/err.h>
88#include <linux/uaccess.h>
89#include <linux/string.h>
90#include <linux/nodemask.h>
91#include <linux/mm.h>
Catalin Marinas179a8102009-09-07 10:14:42 +010092#include <linux/workqueue.h>
Catalin Marinas04609ccc2009-10-28 13:33:12 +000093#include <linux/crc32.h>
Catalin Marinas3c7b4e62009-06-11 13:22:39 +010094
95#include <asm/sections.h>
96#include <asm/processor.h>
Arun Sharma600634972011-07-26 16:09:06 -070097#include <linux/atomic.h>
Catalin Marinas3c7b4e62009-06-11 13:22:39 +010098
Andrey Ryabinine79ed2f2015-02-13 14:39:49 -080099#include <linux/kasan.h>
Marco Elver95511582021-03-24 21:37:47 -0700100#include <linux/kfence.h>
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100101#include <linux/kmemleak.h>
Laura Abbott029aeff2011-11-15 23:49:09 +0000102#include <linux/memory_hotplug.h>
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100103
104/*
105 * Kmemleak configuration and common defines.
106 */
107#define MAX_TRACE 16 /* stack trace length */
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100108#define MSECS_MIN_AGE 5000 /* minimum object age for reporting */
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100109#define SECS_FIRST_SCAN 60 /* delay before the first scan */
110#define SECS_SCAN_WAIT 600 /* subsequent auto scanning delay */
Catalin Marinasaf986032009-08-27 14:29:12 +0100111#define MAX_SCAN_SIZE 4096 /* maximum size of a scanned block */
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100112
113#define BYTES_PER_POINTER sizeof(void *)
114
Catalin Marinas216c04b2009-06-17 18:29:02 +0100115/* GFP bitmask for kmemleak internal allocations */
Naohiro Aota79d37052021-09-08 18:10:17 -0700116#define gfp_kmemleak_mask(gfp) (((gfp) & (GFP_KERNEL | GFP_ATOMIC | \
117 __GFP_NOLOCKDEP)) | \
Catalin Marinas6ae4bd12011-01-27 10:30:26 +0000118 __GFP_NORETRY | __GFP_NOMEMALLOC | \
Yang Shidf9576d2019-08-02 21:48:37 -0700119 __GFP_NOWARN)
Catalin Marinas216c04b2009-06-17 18:29:02 +0100120
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100121/* scanning area inside a memory block */
122struct kmemleak_scan_area {
123 struct hlist_node node;
Catalin Marinasc017b4b2009-10-28 13:33:09 +0000124 unsigned long start;
125 size_t size;
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100126};
127
Luis R. Rodrigueza1084c82009-09-04 17:44:52 -0700128#define KMEMLEAK_GREY 0
129#define KMEMLEAK_BLACK -1
130
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100131/*
132 * Structure holding the metadata for each allocated memory block.
133 * Modifications to such objects should be made while holding the
134 * object->lock. Insertions or deletions from object_list, gray_list or
Michel Lespinasse85d3a312012-10-08 16:31:27 -0700135 * rb_node are already protected by the corresponding locks or mutex (see
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100136 * the notes on locking above). These objects are reference-counted
137 * (use_count) and freed using the RCU mechanism.
138 */
139struct kmemleak_object {
He Zhe8c96f1b2020-01-30 22:12:00 -0800140 raw_spinlock_t lock;
Catalin Marinasf66abf02017-07-06 15:40:16 -0700141 unsigned int flags; /* object status flags */
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100142 struct list_head object_list;
143 struct list_head gray_list;
Michel Lespinasse85d3a312012-10-08 16:31:27 -0700144 struct rb_node rb_node;
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100145 struct rcu_head rcu; /* object_list lockless traversal */
146 /* object usage count; object freed when use_count == 0 */
147 atomic_t use_count;
148 unsigned long pointer;
149 size_t size;
Catalin Marinas94f4a162017-07-06 15:40:22 -0700150 /* pass surplus references to this pointer */
151 unsigned long excess_ref;
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100152 /* minimum number of a pointers found before it is considered leak */
153 int min_count;
154 /* the total number of pointers found pointing to this object */
155 int count;
Catalin Marinas04609ccc2009-10-28 13:33:12 +0000156 /* checksum for detecting modified objects */
157 u32 checksum;
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100158 /* memory ranges to be scanned inside an object (empty for all) */
159 struct hlist_head area_list;
160 unsigned long trace[MAX_TRACE];
161 unsigned int trace_len;
162 unsigned long jiffies; /* creation timestamp */
163 pid_t pid; /* pid of the current task */
164 char comm[TASK_COMM_LEN]; /* executable name */
165};
166
167/* flag representing the memory block allocation status */
168#define OBJECT_ALLOCATED (1 << 0)
169/* flag set after the first reporting of an unreference object */
170#define OBJECT_REPORTED (1 << 1)
171/* flag set to not scan the object */
172#define OBJECT_NO_SCAN (1 << 2)
Catalin Marinasdba82d92019-09-23 15:33:59 -0700173/* flag set to fully scan the object when scan_area allocation failed */
174#define OBJECT_FULL_SCAN (1 << 3)
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100175
Vincent Whitchurch154221c2018-10-26 15:03:42 -0700176#define HEX_PREFIX " "
Sergey Senozhatsky0494e082009-08-27 14:29:18 +0100177/* number of bytes to print per line; must be 16 or 32 */
178#define HEX_ROW_SIZE 16
179/* number of bytes to print at a time (1, 2, 4, 8) */
180#define HEX_GROUP_SIZE 1
181/* include ASCII after the hex output */
182#define HEX_ASCII 1
183/* max number of lines to be printed */
184#define HEX_MAX_LINES 2
185
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100186/* the list of all allocated objects */
187static LIST_HEAD(object_list);
188/* the list of gray-colored objects (see color_gray comment below) */
189static LIST_HEAD(gray_list);
Catalin Marinas06473982019-09-23 15:34:02 -0700190/* memory pool allocation */
Catalin Marinasc5665862019-09-23 15:34:05 -0700191static struct kmemleak_object mem_pool[CONFIG_DEBUG_KMEMLEAK_MEM_POOL_SIZE];
Catalin Marinas06473982019-09-23 15:34:02 -0700192static int mem_pool_free_count = ARRAY_SIZE(mem_pool);
193static LIST_HEAD(mem_pool_free_list);
Michel Lespinasse85d3a312012-10-08 16:31:27 -0700194/* search tree for object boundaries */
195static struct rb_root object_tree_root = RB_ROOT;
He Zhe8c96f1b2020-01-30 22:12:00 -0800196/* protecting the access to object_list and object_tree_root */
197static DEFINE_RAW_SPINLOCK(kmemleak_lock);
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100198
199/* allocation caches for kmemleak internal data */
200static struct kmem_cache *object_cache;
201static struct kmem_cache *scan_area_cache;
202
203/* set if tracing memory operations is enabled */
Catalin Marinasc5665862019-09-23 15:34:05 -0700204static int kmemleak_enabled = 1;
Catalin Marinasc5f3b1a2015-06-24 16:58:26 -0700205/* same as above but only for the kmemleak_free() callback */
Catalin Marinasc5665862019-09-23 15:34:05 -0700206static int kmemleak_free_enabled = 1;
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100207/* set in the late_initcall if there were no errors */
Li Zefan8910ae892014-04-03 14:46:29 -0700208static int kmemleak_initialized;
Catalin Marinas5f790202011-09-28 12:17:03 +0100209/* set if a kmemleak warning was issued */
Li Zefan8910ae892014-04-03 14:46:29 -0700210static int kmemleak_warning;
Catalin Marinas5f790202011-09-28 12:17:03 +0100211/* set if a fatal kmemleak error has occurred */
Li Zefan8910ae892014-04-03 14:46:29 -0700212static int kmemleak_error;
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100213
214/* minimum and maximum address that may be valid pointers */
215static unsigned long min_addr = ULONG_MAX;
216static unsigned long max_addr;
217
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100218static struct task_struct *scan_thread;
Catalin Marinasacf49682009-06-26 17:38:29 +0100219/* used to avoid reporting of recently allocated objects */
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100220static unsigned long jiffies_min_age;
Catalin Marinasacf49682009-06-26 17:38:29 +0100221static unsigned long jiffies_last_scan;
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100222/* delay between automatic memory scannings */
Yanfei Xu54dd2002021-06-28 19:35:01 -0700223static unsigned long jiffies_scan_wait;
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100224/* enables or disables the task stacks scanning */
Catalin Marinase0a2a162009-06-26 17:38:25 +0100225static int kmemleak_stack_scan = 1;
Catalin Marinas4698c1f2009-06-26 17:38:27 +0100226/* protects the memory scanning, parameters and debug/kmemleak file access */
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100227static DEFINE_MUTEX(scan_mutex);
Jason Baronab0155a2010-07-19 11:54:17 +0100228/* setting kmemleak=on, will set this var, skipping the disable */
229static int kmemleak_skip_disable;
Li Zefandc9b3f42014-04-03 14:46:26 -0700230/* If there are leaks that can be reported */
231static bool kmemleak_found_leaks;
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100232
Vincent Whitchurch154221c2018-10-26 15:03:42 -0700233static bool kmemleak_verbose;
234module_param_named(verbose, kmemleak_verbose, bool, 0600);
235
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100236static void kmemleak_disable(void);
237
238/*
239 * Print a warning and dump the stack trace.
240 */
Catalin Marinas5f790202011-09-28 12:17:03 +0100241#define kmemleak_warn(x...) do { \
Joe Perches598d8092016-03-17 14:19:44 -0700242 pr_warn(x); \
Catalin Marinas5f790202011-09-28 12:17:03 +0100243 dump_stack(); \
Li Zefan8910ae892014-04-03 14:46:29 -0700244 kmemleak_warning = 1; \
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100245} while (0)
246
247/*
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300248 * Macro invoked when a serious kmemleak condition occurred and cannot be
Catalin Marinas20301172009-06-17 18:29:04 +0100249 * recovered from. Kmemleak will be disabled and further allocation/freeing
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100250 * tracing no longer available.
251 */
Catalin Marinas000814f2009-06-17 18:29:03 +0100252#define kmemleak_stop(x...) do { \
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100253 kmemleak_warn(x); \
254 kmemleak_disable(); \
255} while (0)
256
Vincent Whitchurch154221c2018-10-26 15:03:42 -0700257#define warn_or_seq_printf(seq, fmt, ...) do { \
258 if (seq) \
259 seq_printf(seq, fmt, ##__VA_ARGS__); \
260 else \
261 pr_warn(fmt, ##__VA_ARGS__); \
262} while (0)
263
264static void warn_or_seq_hex_dump(struct seq_file *seq, int prefix_type,
265 int rowsize, int groupsize, const void *buf,
266 size_t len, bool ascii)
267{
268 if (seq)
269 seq_hex_dump(seq, HEX_PREFIX, prefix_type, rowsize, groupsize,
270 buf, len, ascii);
271 else
272 print_hex_dump(KERN_WARNING, pr_fmt(HEX_PREFIX), prefix_type,
273 rowsize, groupsize, buf, len, ascii);
274}
275
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100276/*
Sergey Senozhatsky0494e082009-08-27 14:29:18 +0100277 * Printing of the objects hex dump to the seq file. The number of lines to be
278 * printed is limited to HEX_MAX_LINES to prevent seq file spamming. The
279 * actual number of printed bytes depends on HEX_ROW_SIZE. It must be called
280 * with the object->lock held.
281 */
282static void hex_dump_object(struct seq_file *seq,
283 struct kmemleak_object *object)
284{
285 const u8 *ptr = (const u8 *)object->pointer;
Andy Shevchenko6fc37c42015-09-09 15:38:45 -0700286 size_t len;
Sergey Senozhatsky0494e082009-08-27 14:29:18 +0100287
288 /* limit the number of lines to HEX_MAX_LINES */
Andy Shevchenko6fc37c42015-09-09 15:38:45 -0700289 len = min_t(size_t, object->size, HEX_MAX_LINES * HEX_ROW_SIZE);
Sergey Senozhatsky0494e082009-08-27 14:29:18 +0100290
Vincent Whitchurch154221c2018-10-26 15:03:42 -0700291 warn_or_seq_printf(seq, " hex dump (first %zu bytes):\n", len);
Dmitry Vyukov5c335fe2016-06-24 14:50:07 -0700292 kasan_disable_current();
Vincent Whitchurch154221c2018-10-26 15:03:42 -0700293 warn_or_seq_hex_dump(seq, DUMP_PREFIX_NONE, HEX_ROW_SIZE,
Kuan-Ying Lee6c7a00b2021-08-13 16:54:24 -0700294 HEX_GROUP_SIZE, kasan_reset_tag((void *)ptr), len, HEX_ASCII);
Dmitry Vyukov5c335fe2016-06-24 14:50:07 -0700295 kasan_enable_current();
Sergey Senozhatsky0494e082009-08-27 14:29:18 +0100296}
297
298/*
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100299 * Object colors, encoded with count and min_count:
300 * - white - orphan object, not enough references to it (count < min_count)
301 * - gray - not orphan, not marked as false positive (min_count == 0) or
302 * sufficient references to it (count >= min_count)
303 * - black - ignore, it doesn't contain references (e.g. text section)
304 * (min_count == -1). No function defined for this color.
305 * Newly created objects don't have any color assigned (object->count == -1)
306 * before the next memory scan when they become white.
307 */
Luis R. Rodriguez4a558dd2009-09-08 16:34:50 +0100308static bool color_white(const struct kmemleak_object *object)
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100309{
Luis R. Rodrigueza1084c82009-09-04 17:44:52 -0700310 return object->count != KMEMLEAK_BLACK &&
311 object->count < object->min_count;
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100312}
313
Luis R. Rodriguez4a558dd2009-09-08 16:34:50 +0100314static bool color_gray(const struct kmemleak_object *object)
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100315{
Luis R. Rodrigueza1084c82009-09-04 17:44:52 -0700316 return object->min_count != KMEMLEAK_BLACK &&
317 object->count >= object->min_count;
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100318}
319
320/*
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100321 * Objects are considered unreferenced only if their color is white, they have
322 * not be deleted and have a minimum age to avoid false positives caused by
323 * pointers temporarily stored in CPU registers.
324 */
Luis R. Rodriguez4a558dd2009-09-08 16:34:50 +0100325static bool unreferenced_object(struct kmemleak_object *object)
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100326{
Catalin Marinas04609ccc2009-10-28 13:33:12 +0000327 return (color_white(object) && object->flags & OBJECT_ALLOCATED) &&
Catalin Marinasacf49682009-06-26 17:38:29 +0100328 time_before_eq(object->jiffies + jiffies_min_age,
329 jiffies_last_scan);
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100330}
331
332/*
Catalin Marinasbab4a342009-06-26 17:38:26 +0100333 * Printing of the unreferenced objects information to the seq file. The
334 * print_unreferenced function must be called with the object->lock held.
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100335 */
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100336static void print_unreferenced(struct seq_file *seq,
337 struct kmemleak_object *object)
338{
339 int i;
Catalin Marinasfefdd332009-10-28 13:33:12 +0000340 unsigned int msecs_age = jiffies_to_msecs(jiffies - object->jiffies);
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100341
Vincent Whitchurch154221c2018-10-26 15:03:42 -0700342 warn_or_seq_printf(seq, "unreferenced object 0x%08lx (size %zu):\n",
Catalin Marinasbab4a342009-06-26 17:38:26 +0100343 object->pointer, object->size);
Vincent Whitchurch154221c2018-10-26 15:03:42 -0700344 warn_or_seq_printf(seq, " comm \"%s\", pid %d, jiffies %lu (age %d.%03ds)\n",
Catalin Marinasfefdd332009-10-28 13:33:12 +0000345 object->comm, object->pid, object->jiffies,
346 msecs_age / 1000, msecs_age % 1000);
Sergey Senozhatsky0494e082009-08-27 14:29:18 +0100347 hex_dump_object(seq, object);
Vincent Whitchurch154221c2018-10-26 15:03:42 -0700348 warn_or_seq_printf(seq, " backtrace:\n");
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100349
350 for (i = 0; i < object->trace_len; i++) {
351 void *ptr = (void *)object->trace[i];
Vincent Whitchurch154221c2018-10-26 15:03:42 -0700352 warn_or_seq_printf(seq, " [<%p>] %pS\n", ptr, ptr);
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100353 }
354}
355
356/*
357 * Print the kmemleak_object information. This function is used mainly for
358 * debugging special cases when kmemleak operations. It must be called with
359 * the object->lock held.
360 */
361static void dump_object_info(struct kmemleak_object *object)
362{
Joe Perchesae281062009-06-23 14:40:26 +0100363 pr_notice("Object 0x%08lx (size %zu):\n",
Michel Lespinasse85d3a312012-10-08 16:31:27 -0700364 object->pointer, object->size);
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100365 pr_notice(" comm \"%s\", pid %d, jiffies %lu\n",
366 object->comm, object->pid, object->jiffies);
367 pr_notice(" min_count = %d\n", object->min_count);
368 pr_notice(" count = %d\n", object->count);
Catalin Marinasf66abf02017-07-06 15:40:16 -0700369 pr_notice(" flags = 0x%x\n", object->flags);
Jianpeng Maaae0ad72014-06-06 14:38:16 -0700370 pr_notice(" checksum = %u\n", object->checksum);
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100371 pr_notice(" backtrace:\n");
Thomas Gleixner07984aa2019-04-25 11:45:01 +0200372 stack_trace_print(object->trace, object->trace_len, 4);
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100373}
374
375/*
Michel Lespinasse85d3a312012-10-08 16:31:27 -0700376 * Look-up a memory block metadata (kmemleak_object) in the object search
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100377 * tree based on a pointer value. If alias is 0, only values pointing to the
378 * beginning of the memory block are allowed. The kmemleak_lock must be held
379 * when calling this function.
380 */
381static struct kmemleak_object *lookup_object(unsigned long ptr, int alias)
382{
Michel Lespinasse85d3a312012-10-08 16:31:27 -0700383 struct rb_node *rb = object_tree_root.rb_node;
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100384
Michel Lespinasse85d3a312012-10-08 16:31:27 -0700385 while (rb) {
386 struct kmemleak_object *object =
387 rb_entry(rb, struct kmemleak_object, rb_node);
388 if (ptr < object->pointer)
389 rb = object->rb_node.rb_left;
390 else if (object->pointer + object->size <= ptr)
391 rb = object->rb_node.rb_right;
392 else if (object->pointer == ptr || alias)
393 return object;
394 else {
Catalin Marinas5f790202011-09-28 12:17:03 +0100395 kmemleak_warn("Found object by alias at 0x%08lx\n",
396 ptr);
Catalin Marinasa7686a42010-07-19 11:54:16 +0100397 dump_object_info(object);
Michel Lespinasse85d3a312012-10-08 16:31:27 -0700398 break;
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100399 }
Michel Lespinasse85d3a312012-10-08 16:31:27 -0700400 }
401 return NULL;
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100402}
403
404/*
405 * Increment the object use_count. Return 1 if successful or 0 otherwise. Note
406 * that once an object's use_count reached 0, the RCU freeing was already
407 * registered and the object should no longer be used. This function must be
408 * called under the protection of rcu_read_lock().
409 */
410static int get_object(struct kmemleak_object *object)
411{
412 return atomic_inc_not_zero(&object->use_count);
413}
414
415/*
Catalin Marinas06473982019-09-23 15:34:02 -0700416 * Memory pool allocation and freeing. kmemleak_lock must not be held.
417 */
418static struct kmemleak_object *mem_pool_alloc(gfp_t gfp)
419{
420 unsigned long flags;
421 struct kmemleak_object *object;
422
423 /* try the slab allocator first */
Catalin Marinasc5665862019-09-23 15:34:05 -0700424 if (object_cache) {
425 object = kmem_cache_alloc(object_cache, gfp_kmemleak_mask(gfp));
426 if (object)
427 return object;
428 }
Catalin Marinas06473982019-09-23 15:34:02 -0700429
430 /* slab allocation failed, try the memory pool */
He Zhe8c96f1b2020-01-30 22:12:00 -0800431 raw_spin_lock_irqsave(&kmemleak_lock, flags);
Catalin Marinas06473982019-09-23 15:34:02 -0700432 object = list_first_entry_or_null(&mem_pool_free_list,
433 typeof(*object), object_list);
434 if (object)
435 list_del(&object->object_list);
436 else if (mem_pool_free_count)
437 object = &mem_pool[--mem_pool_free_count];
Catalin Marinasc5665862019-09-23 15:34:05 -0700438 else
439 pr_warn_once("Memory pool empty, consider increasing CONFIG_DEBUG_KMEMLEAK_MEM_POOL_SIZE\n");
He Zhe8c96f1b2020-01-30 22:12:00 -0800440 raw_spin_unlock_irqrestore(&kmemleak_lock, flags);
Catalin Marinas06473982019-09-23 15:34:02 -0700441
442 return object;
443}
444
445/*
446 * Return the object to either the slab allocator or the memory pool.
447 */
448static void mem_pool_free(struct kmemleak_object *object)
449{
450 unsigned long flags;
451
452 if (object < mem_pool || object >= mem_pool + ARRAY_SIZE(mem_pool)) {
453 kmem_cache_free(object_cache, object);
454 return;
455 }
456
457 /* add the object to the memory pool free list */
He Zhe8c96f1b2020-01-30 22:12:00 -0800458 raw_spin_lock_irqsave(&kmemleak_lock, flags);
Catalin Marinas06473982019-09-23 15:34:02 -0700459 list_add(&object->object_list, &mem_pool_free_list);
He Zhe8c96f1b2020-01-30 22:12:00 -0800460 raw_spin_unlock_irqrestore(&kmemleak_lock, flags);
Catalin Marinas06473982019-09-23 15:34:02 -0700461}
462
463/*
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100464 * RCU callback to free a kmemleak_object.
465 */
466static void free_object_rcu(struct rcu_head *rcu)
467{
Sasha Levinb67bfe02013-02-27 17:06:00 -0800468 struct hlist_node *tmp;
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100469 struct kmemleak_scan_area *area;
470 struct kmemleak_object *object =
471 container_of(rcu, struct kmemleak_object, rcu);
472
473 /*
474 * Once use_count is 0 (guaranteed by put_object), there is no other
475 * code accessing this object, hence no need for locking.
476 */
Sasha Levinb67bfe02013-02-27 17:06:00 -0800477 hlist_for_each_entry_safe(area, tmp, &object->area_list, node) {
478 hlist_del(&area->node);
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100479 kmem_cache_free(scan_area_cache, area);
480 }
Catalin Marinas06473982019-09-23 15:34:02 -0700481 mem_pool_free(object);
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100482}
483
484/*
485 * Decrement the object use_count. Once the count is 0, free the object using
486 * an RCU callback. Since put_object() may be called via the kmemleak_free() ->
487 * delete_object() path, the delayed RCU freeing ensures that there is no
488 * recursive call to the kernel allocator. Lock-less RCU object_list traversal
489 * is also possible.
490 */
491static void put_object(struct kmemleak_object *object)
492{
493 if (!atomic_dec_and_test(&object->use_count))
494 return;
495
496 /* should only get here after delete_object was called */
497 WARN_ON(object->flags & OBJECT_ALLOCATED);
498
Catalin Marinasc5665862019-09-23 15:34:05 -0700499 /*
500 * It may be too early for the RCU callbacks, however, there is no
501 * concurrent object_list traversal when !object_cache and all objects
502 * came from the memory pool. Free the object directly.
503 */
504 if (object_cache)
505 call_rcu(&object->rcu, free_object_rcu);
506 else
507 free_object_rcu(&object->rcu);
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100508}
509
510/*
Michel Lespinasse85d3a312012-10-08 16:31:27 -0700511 * Look up an object in the object search tree and increase its use_count.
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100512 */
513static struct kmemleak_object *find_and_get_object(unsigned long ptr, int alias)
514{
515 unsigned long flags;
Alexey Klimov9fbed252015-11-05 18:45:57 -0800516 struct kmemleak_object *object;
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100517
518 rcu_read_lock();
He Zhe8c96f1b2020-01-30 22:12:00 -0800519 raw_spin_lock_irqsave(&kmemleak_lock, flags);
Catalin Marinas93ada572015-06-24 16:58:37 -0700520 object = lookup_object(ptr, alias);
He Zhe8c96f1b2020-01-30 22:12:00 -0800521 raw_spin_unlock_irqrestore(&kmemleak_lock, flags);
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100522
523 /* check whether the object is still available */
524 if (object && !get_object(object))
525 object = NULL;
526 rcu_read_unlock();
527
528 return object;
529}
530
531/*
Catalin Marinas2abd8392019-10-04 14:46:24 +0100532 * Remove an object from the object_tree_root and object_list. Must be called
533 * with the kmemleak_lock held _if_ kmemleak is still enabled.
534 */
535static void __remove_object(struct kmemleak_object *object)
536{
537 rb_erase(&object->rb_node, &object_tree_root);
538 list_del_rcu(&object->object_list);
539}
540
541/*
Catalin Marinase781a9a2015-06-24 16:58:29 -0700542 * Look up an object in the object search tree and remove it from both
543 * object_tree_root and object_list. The returned object's use_count should be
544 * at least 1, as initially set by create_object().
545 */
546static struct kmemleak_object *find_and_remove_object(unsigned long ptr, int alias)
547{
548 unsigned long flags;
549 struct kmemleak_object *object;
550
He Zhe8c96f1b2020-01-30 22:12:00 -0800551 raw_spin_lock_irqsave(&kmemleak_lock, flags);
Catalin Marinase781a9a2015-06-24 16:58:29 -0700552 object = lookup_object(ptr, alias);
Catalin Marinas2abd8392019-10-04 14:46:24 +0100553 if (object)
554 __remove_object(object);
He Zhe8c96f1b2020-01-30 22:12:00 -0800555 raw_spin_unlock_irqrestore(&kmemleak_lock, flags);
Catalin Marinase781a9a2015-06-24 16:58:29 -0700556
557 return object;
558}
559
560/*
Catalin Marinasfd678962009-08-27 14:29:17 +0100561 * Save stack trace to the given array of MAX_TRACE size.
562 */
563static int __save_stack_trace(unsigned long *trace)
564{
Thomas Gleixner07984aa2019-04-25 11:45:01 +0200565 return stack_trace_save(trace, MAX_TRACE, 2);
Catalin Marinasfd678962009-08-27 14:29:17 +0100566}
567
568/*
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100569 * Create the metadata (struct kmemleak_object) corresponding to an allocated
570 * memory block and add it to the object_list and object_tree_root.
571 */
Catalin Marinasfd678962009-08-27 14:29:17 +0100572static struct kmemleak_object *create_object(unsigned long ptr, size_t size,
573 int min_count, gfp_t gfp)
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100574{
575 unsigned long flags;
Michel Lespinasse85d3a312012-10-08 16:31:27 -0700576 struct kmemleak_object *object, *parent;
577 struct rb_node **link, *rb_parent;
Andrey Konovalova2f77572019-02-20 22:19:16 -0800578 unsigned long untagged_ptr;
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100579
Catalin Marinas06473982019-09-23 15:34:02 -0700580 object = mem_pool_alloc(gfp);
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100581 if (!object) {
Joe Perches598d8092016-03-17 14:19:44 -0700582 pr_warn("Cannot allocate a kmemleak_object structure\n");
Catalin Marinas6ae4bd12011-01-27 10:30:26 +0000583 kmemleak_disable();
Catalin Marinasfd678962009-08-27 14:29:17 +0100584 return NULL;
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100585 }
586
587 INIT_LIST_HEAD(&object->object_list);
588 INIT_LIST_HEAD(&object->gray_list);
589 INIT_HLIST_HEAD(&object->area_list);
He Zhe8c96f1b2020-01-30 22:12:00 -0800590 raw_spin_lock_init(&object->lock);
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100591 atomic_set(&object->use_count, 1);
Catalin Marinas04609ccc2009-10-28 13:33:12 +0000592 object->flags = OBJECT_ALLOCATED;
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100593 object->pointer = ptr;
Marco Elver95511582021-03-24 21:37:47 -0700594 object->size = kfence_ksize((void *)ptr) ?: size;
Catalin Marinas94f4a162017-07-06 15:40:22 -0700595 object->excess_ref = 0;
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100596 object->min_count = min_count;
Catalin Marinas04609ccc2009-10-28 13:33:12 +0000597 object->count = 0; /* white color initially */
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100598 object->jiffies = jiffies;
Catalin Marinas04609ccc2009-10-28 13:33:12 +0000599 object->checksum = 0;
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100600
601 /* task information */
Changbin Duea0eafe2021-09-07 19:56:12 -0700602 if (in_hardirq()) {
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100603 object->pid = 0;
604 strncpy(object->comm, "hardirq", sizeof(object->comm));
Dmitry Vyukov6ef90562019-07-11 20:53:39 -0700605 } else if (in_serving_softirq()) {
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100606 object->pid = 0;
607 strncpy(object->comm, "softirq", sizeof(object->comm));
608 } else {
609 object->pid = current->pid;
610 /*
611 * There is a small chance of a race with set_task_comm(),
612 * however using get_task_comm() here may cause locking
613 * dependency issues with current->alloc_lock. In the worst
614 * case, the command line is not correct.
615 */
616 strncpy(object->comm, current->comm, sizeof(object->comm));
617 }
618
619 /* kernel backtrace */
Catalin Marinasfd678962009-08-27 14:29:17 +0100620 object->trace_len = __save_stack_trace(object->trace);
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100621
He Zhe8c96f1b2020-01-30 22:12:00 -0800622 raw_spin_lock_irqsave(&kmemleak_lock, flags);
Luis R. Rodriguez0580a182009-09-08 17:32:34 +0100623
Andrey Konovalova2f77572019-02-20 22:19:16 -0800624 untagged_ptr = (unsigned long)kasan_reset_tag((void *)ptr);
625 min_addr = min(min_addr, untagged_ptr);
626 max_addr = max(max_addr, untagged_ptr + size);
Michel Lespinasse85d3a312012-10-08 16:31:27 -0700627 link = &object_tree_root.rb_node;
628 rb_parent = NULL;
629 while (*link) {
630 rb_parent = *link;
631 parent = rb_entry(rb_parent, struct kmemleak_object, rb_node);
632 if (ptr + size <= parent->pointer)
633 link = &parent->rb_node.rb_left;
634 else if (parent->pointer + parent->size <= ptr)
635 link = &parent->rb_node.rb_right;
636 else {
Joe Perches756a0252016-03-17 14:19:47 -0700637 kmemleak_stop("Cannot insert 0x%lx into the object search tree (overlaps existing)\n",
Michel Lespinasse85d3a312012-10-08 16:31:27 -0700638 ptr);
Catalin Marinas9d5a4c72015-06-24 16:58:34 -0700639 /*
640 * No need for parent->lock here since "parent" cannot
641 * be freed while the kmemleak_lock is held.
642 */
643 dump_object_info(parent);
Michel Lespinasse85d3a312012-10-08 16:31:27 -0700644 kmem_cache_free(object_cache, object);
Catalin Marinas9d5a4c72015-06-24 16:58:34 -0700645 object = NULL;
Michel Lespinasse85d3a312012-10-08 16:31:27 -0700646 goto out;
647 }
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100648 }
Michel Lespinasse85d3a312012-10-08 16:31:27 -0700649 rb_link_node(&object->rb_node, rb_parent, link);
650 rb_insert_color(&object->rb_node, &object_tree_root);
651
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100652 list_add_tail_rcu(&object->object_list, &object_list);
653out:
He Zhe8c96f1b2020-01-30 22:12:00 -0800654 raw_spin_unlock_irqrestore(&kmemleak_lock, flags);
Catalin Marinasfd678962009-08-27 14:29:17 +0100655 return object;
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100656}
657
658/*
Catalin Marinase781a9a2015-06-24 16:58:29 -0700659 * Mark the object as not allocated and schedule RCU freeing via put_object().
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100660 */
Catalin Marinas53238a62009-07-07 10:33:00 +0100661static void __delete_object(struct kmemleak_object *object)
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100662{
663 unsigned long flags;
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100664
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100665 WARN_ON(!(object->flags & OBJECT_ALLOCATED));
Catalin Marinase781a9a2015-06-24 16:58:29 -0700666 WARN_ON(atomic_read(&object->use_count) < 1);
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100667
668 /*
669 * Locking here also ensures that the corresponding memory block
670 * cannot be freed when it is being scanned.
671 */
He Zhe8c96f1b2020-01-30 22:12:00 -0800672 raw_spin_lock_irqsave(&object->lock, flags);
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100673 object->flags &= ~OBJECT_ALLOCATED;
He Zhe8c96f1b2020-01-30 22:12:00 -0800674 raw_spin_unlock_irqrestore(&object->lock, flags);
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100675 put_object(object);
676}
677
678/*
Catalin Marinas53238a62009-07-07 10:33:00 +0100679 * Look up the metadata (struct kmemleak_object) corresponding to ptr and
680 * delete it.
681 */
682static void delete_object_full(unsigned long ptr)
683{
684 struct kmemleak_object *object;
685
Catalin Marinase781a9a2015-06-24 16:58:29 -0700686 object = find_and_remove_object(ptr, 0);
Catalin Marinas53238a62009-07-07 10:33:00 +0100687 if (!object) {
688#ifdef DEBUG
689 kmemleak_warn("Freeing unknown object at 0x%08lx\n",
690 ptr);
691#endif
692 return;
693 }
694 __delete_object(object);
Catalin Marinas53238a62009-07-07 10:33:00 +0100695}
696
697/*
698 * Look up the metadata (struct kmemleak_object) corresponding to ptr and
699 * delete it. If the memory block is partially freed, the function may create
700 * additional metadata for the remaining parts of the block.
701 */
702static void delete_object_part(unsigned long ptr, size_t size)
703{
704 struct kmemleak_object *object;
705 unsigned long start, end;
706
Catalin Marinase781a9a2015-06-24 16:58:29 -0700707 object = find_and_remove_object(ptr, 1);
Catalin Marinas53238a62009-07-07 10:33:00 +0100708 if (!object) {
709#ifdef DEBUG
Joe Perches756a0252016-03-17 14:19:47 -0700710 kmemleak_warn("Partially freeing unknown object at 0x%08lx (size %zu)\n",
711 ptr, size);
Catalin Marinas53238a62009-07-07 10:33:00 +0100712#endif
713 return;
714 }
Catalin Marinas53238a62009-07-07 10:33:00 +0100715
716 /*
717 * Create one or two objects that may result from the memory block
718 * split. Note that partial freeing is only done by free_bootmem() and
Catalin Marinasc5665862019-09-23 15:34:05 -0700719 * this happens before kmemleak_init() is called.
Catalin Marinas53238a62009-07-07 10:33:00 +0100720 */
721 start = object->pointer;
722 end = object->pointer + object->size;
723 if (ptr > start)
724 create_object(start, ptr - start, object->min_count,
725 GFP_KERNEL);
726 if (ptr + size < end)
727 create_object(ptr + size, end - ptr - size, object->min_count,
728 GFP_KERNEL);
729
Catalin Marinase781a9a2015-06-24 16:58:29 -0700730 __delete_object(object);
Catalin Marinas53238a62009-07-07 10:33:00 +0100731}
Luis R. Rodrigueza1084c82009-09-04 17:44:52 -0700732
733static void __paint_it(struct kmemleak_object *object, int color)
734{
735 object->min_count = color;
736 if (color == KMEMLEAK_BLACK)
737 object->flags |= OBJECT_NO_SCAN;
738}
739
740static void paint_it(struct kmemleak_object *object, int color)
741{
742 unsigned long flags;
743
He Zhe8c96f1b2020-01-30 22:12:00 -0800744 raw_spin_lock_irqsave(&object->lock, flags);
Luis R. Rodrigueza1084c82009-09-04 17:44:52 -0700745 __paint_it(object, color);
He Zhe8c96f1b2020-01-30 22:12:00 -0800746 raw_spin_unlock_irqrestore(&object->lock, flags);
Luis R. Rodrigueza1084c82009-09-04 17:44:52 -0700747}
748
749static void paint_ptr(unsigned long ptr, int color)
750{
751 struct kmemleak_object *object;
752
753 object = find_and_get_object(ptr, 0);
754 if (!object) {
Joe Perches756a0252016-03-17 14:19:47 -0700755 kmemleak_warn("Trying to color unknown object at 0x%08lx as %s\n",
756 ptr,
Luis R. Rodrigueza1084c82009-09-04 17:44:52 -0700757 (color == KMEMLEAK_GREY) ? "Grey" :
758 (color == KMEMLEAK_BLACK) ? "Black" : "Unknown");
759 return;
760 }
761 paint_it(object, color);
762 put_object(object);
763}
764
Catalin Marinas53238a62009-07-07 10:33:00 +0100765/*
Holger Hans Peter Freyther145b64b2010-07-22 19:54:13 +0800766 * Mark an object permanently as gray-colored so that it can no longer be
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100767 * reported as a leak. This is used in general to mark a false positive.
768 */
769static void make_gray_object(unsigned long ptr)
770{
Luis R. Rodrigueza1084c82009-09-04 17:44:52 -0700771 paint_ptr(ptr, KMEMLEAK_GREY);
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100772}
773
774/*
775 * Mark the object as black-colored so that it is ignored from scans and
776 * reporting.
777 */
778static void make_black_object(unsigned long ptr)
779{
Luis R. Rodrigueza1084c82009-09-04 17:44:52 -0700780 paint_ptr(ptr, KMEMLEAK_BLACK);
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100781}
782
783/*
784 * Add a scanning area to the object. If at least one such area is added,
785 * kmemleak will only scan these ranges rather than the whole memory block.
786 */
Catalin Marinasc017b4b2009-10-28 13:33:09 +0000787static void add_scan_area(unsigned long ptr, size_t size, gfp_t gfp)
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100788{
789 unsigned long flags;
790 struct kmemleak_object *object;
Catalin Marinasc5665862019-09-23 15:34:05 -0700791 struct kmemleak_scan_area *area = NULL;
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100792
Catalin Marinasc017b4b2009-10-28 13:33:09 +0000793 object = find_and_get_object(ptr, 1);
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100794 if (!object) {
Joe Perchesae281062009-06-23 14:40:26 +0100795 kmemleak_warn("Adding scan area to unknown object at 0x%08lx\n",
796 ptr);
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100797 return;
798 }
799
Catalin Marinasc5665862019-09-23 15:34:05 -0700800 if (scan_area_cache)
801 area = kmem_cache_alloc(scan_area_cache, gfp_kmemleak_mask(gfp));
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100802
He Zhe8c96f1b2020-01-30 22:12:00 -0800803 raw_spin_lock_irqsave(&object->lock, flags);
Catalin Marinasdba82d92019-09-23 15:33:59 -0700804 if (!area) {
805 pr_warn_once("Cannot allocate a scan area, scanning the full object\n");
806 /* mark the object for full scan to avoid false positives */
807 object->flags |= OBJECT_FULL_SCAN;
808 goto out_unlock;
809 }
Catalin Marinas7f88f882013-11-12 15:07:45 -0800810 if (size == SIZE_MAX) {
811 size = object->pointer + object->size - ptr;
812 } else if (ptr + size > object->pointer + object->size) {
Joe Perchesae281062009-06-23 14:40:26 +0100813 kmemleak_warn("Scan area larger than object 0x%08lx\n", ptr);
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100814 dump_object_info(object);
815 kmem_cache_free(scan_area_cache, area);
816 goto out_unlock;
817 }
818
819 INIT_HLIST_NODE(&area->node);
Catalin Marinasc017b4b2009-10-28 13:33:09 +0000820 area->start = ptr;
821 area->size = size;
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100822
823 hlist_add_head(&area->node, &object->area_list);
824out_unlock:
He Zhe8c96f1b2020-01-30 22:12:00 -0800825 raw_spin_unlock_irqrestore(&object->lock, flags);
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100826 put_object(object);
827}
828
829/*
Catalin Marinas94f4a162017-07-06 15:40:22 -0700830 * Any surplus references (object already gray) to 'ptr' are passed to
831 * 'excess_ref'. This is used in the vmalloc() case where a pointer to
832 * vm_struct may be used as an alternative reference to the vmalloc'ed object
833 * (see free_thread_stack()).
834 */
835static void object_set_excess_ref(unsigned long ptr, unsigned long excess_ref)
836{
837 unsigned long flags;
838 struct kmemleak_object *object;
839
840 object = find_and_get_object(ptr, 0);
841 if (!object) {
842 kmemleak_warn("Setting excess_ref on unknown object at 0x%08lx\n",
843 ptr);
844 return;
845 }
846
He Zhe8c96f1b2020-01-30 22:12:00 -0800847 raw_spin_lock_irqsave(&object->lock, flags);
Catalin Marinas94f4a162017-07-06 15:40:22 -0700848 object->excess_ref = excess_ref;
He Zhe8c96f1b2020-01-30 22:12:00 -0800849 raw_spin_unlock_irqrestore(&object->lock, flags);
Catalin Marinas94f4a162017-07-06 15:40:22 -0700850 put_object(object);
851}
852
853/*
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100854 * Set the OBJECT_NO_SCAN flag for the object corresponding to the give
855 * pointer. Such object will not be scanned by kmemleak but references to it
856 * are searched.
857 */
858static void object_no_scan(unsigned long ptr)
859{
860 unsigned long flags;
861 struct kmemleak_object *object;
862
863 object = find_and_get_object(ptr, 0);
864 if (!object) {
Joe Perchesae281062009-06-23 14:40:26 +0100865 kmemleak_warn("Not scanning unknown object at 0x%08lx\n", ptr);
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100866 return;
867 }
868
He Zhe8c96f1b2020-01-30 22:12:00 -0800869 raw_spin_lock_irqsave(&object->lock, flags);
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100870 object->flags |= OBJECT_NO_SCAN;
He Zhe8c96f1b2020-01-30 22:12:00 -0800871 raw_spin_unlock_irqrestore(&object->lock, flags);
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100872 put_object(object);
873}
874
Catalin Marinasa2b6bf62010-07-19 11:54:17 +0100875/**
876 * kmemleak_alloc - register a newly allocated object
877 * @ptr: pointer to beginning of the object
878 * @size: size of the object
879 * @min_count: minimum number of references to this object. If during memory
880 * scanning a number of references less than @min_count is found,
881 * the object is reported as a memory leak. If @min_count is 0,
882 * the object is never reported as a leak. If @min_count is -1,
883 * the object is ignored (not scanned and not reported as a leak)
884 * @gfp: kmalloc() flags used for kmemleak internal memory allocations
885 *
886 * This function is called from the kernel allocators when a new object
Catalin Marinas94f4a162017-07-06 15:40:22 -0700887 * (memory block) is allocated (kmem_cache_alloc, kmalloc etc.).
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100888 */
Catalin Marinasa6186d82009-08-27 14:29:16 +0100889void __ref kmemleak_alloc(const void *ptr, size_t size, int min_count,
890 gfp_t gfp)
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100891{
892 pr_debug("%s(0x%p, %zu, %d)\n", __func__, ptr, size, min_count);
893
Li Zefan8910ae892014-04-03 14:46:29 -0700894 if (kmemleak_enabled && ptr && !IS_ERR(ptr))
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100895 create_object((unsigned long)ptr, size, min_count, gfp);
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100896}
897EXPORT_SYMBOL_GPL(kmemleak_alloc);
898
Catalin Marinasa2b6bf62010-07-19 11:54:17 +0100899/**
Catalin Marinasf528f0b2011-09-26 17:12:53 +0100900 * kmemleak_alloc_percpu - register a newly allocated __percpu object
901 * @ptr: __percpu pointer to beginning of the object
902 * @size: size of the object
Larry Finger8a8c35f2015-06-24 16:58:51 -0700903 * @gfp: flags used for kmemleak internal memory allocations
Catalin Marinasf528f0b2011-09-26 17:12:53 +0100904 *
905 * This function is called from the kernel percpu allocator when a new object
Larry Finger8a8c35f2015-06-24 16:58:51 -0700906 * (memory block) is allocated (alloc_percpu).
Catalin Marinasf528f0b2011-09-26 17:12:53 +0100907 */
Larry Finger8a8c35f2015-06-24 16:58:51 -0700908void __ref kmemleak_alloc_percpu(const void __percpu *ptr, size_t size,
909 gfp_t gfp)
Catalin Marinasf528f0b2011-09-26 17:12:53 +0100910{
911 unsigned int cpu;
912
913 pr_debug("%s(0x%p, %zu)\n", __func__, ptr, size);
914
915 /*
916 * Percpu allocations are only scanned and not reported as leaks
917 * (min_count is set to 0).
918 */
Li Zefan8910ae892014-04-03 14:46:29 -0700919 if (kmemleak_enabled && ptr && !IS_ERR(ptr))
Catalin Marinasf528f0b2011-09-26 17:12:53 +0100920 for_each_possible_cpu(cpu)
921 create_object((unsigned long)per_cpu_ptr(ptr, cpu),
Larry Finger8a8c35f2015-06-24 16:58:51 -0700922 size, 0, gfp);
Catalin Marinasf528f0b2011-09-26 17:12:53 +0100923}
924EXPORT_SYMBOL_GPL(kmemleak_alloc_percpu);
925
926/**
Catalin Marinas94f4a162017-07-06 15:40:22 -0700927 * kmemleak_vmalloc - register a newly vmalloc'ed object
928 * @area: pointer to vm_struct
929 * @size: size of the object
930 * @gfp: __vmalloc() flags used for kmemleak internal memory allocations
931 *
932 * This function is called from the vmalloc() kernel allocator when a new
933 * object (memory block) is allocated.
934 */
935void __ref kmemleak_vmalloc(const struct vm_struct *area, size_t size, gfp_t gfp)
936{
937 pr_debug("%s(0x%p, %zu)\n", __func__, area, size);
938
939 /*
940 * A min_count = 2 is needed because vm_struct contains a reference to
941 * the virtual address of the vmalloc'ed block.
942 */
943 if (kmemleak_enabled) {
944 create_object((unsigned long)area->addr, size, 2, gfp);
945 object_set_excess_ref((unsigned long)area,
946 (unsigned long)area->addr);
Catalin Marinas94f4a162017-07-06 15:40:22 -0700947 }
948}
949EXPORT_SYMBOL_GPL(kmemleak_vmalloc);
950
951/**
Catalin Marinasa2b6bf62010-07-19 11:54:17 +0100952 * kmemleak_free - unregister a previously registered object
953 * @ptr: pointer to beginning of the object
954 *
955 * This function is called from the kernel allocators when an object (memory
956 * block) is freed (kmem_cache_free, kfree, vfree etc.).
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100957 */
Catalin Marinasa6186d82009-08-27 14:29:16 +0100958void __ref kmemleak_free(const void *ptr)
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100959{
960 pr_debug("%s(0x%p)\n", __func__, ptr);
961
Catalin Marinasc5f3b1a2015-06-24 16:58:26 -0700962 if (kmemleak_free_enabled && ptr && !IS_ERR(ptr))
Catalin Marinas53238a62009-07-07 10:33:00 +0100963 delete_object_full((unsigned long)ptr);
Catalin Marinas3c7b4e62009-06-11 13:22:39 +0100964}
965EXPORT_SYMBOL_GPL(kmemleak_free);
966
Catalin Marinasa2b6bf62010-07-19 11:54:17 +0100967/**
968 * kmemleak_free_part - partially unregister a previously registered object
969 * @ptr: pointer to the beginning or inside the object. This also
970 * represents the start of the range to be freed
971 * @size: size to be unregistered
972 *
973 * This function is called when only a part of a memory block is freed
974 * (usually from the bootmem allocator).
Catalin Marinas53238a62009-07-07 10:33:00 +0100975 */
Catalin Marinasa6186d82009-08-27 14:29:16 +0100976void __ref kmemleak_free_part(const void *ptr, size_t size)
Catalin Marinas53238a62009-07-07 10:33:00 +0100977{
978 pr_debug("%s(0x%p)\n", __func__, ptr);
979
Li Zefan8910ae892014-04-03 14:46:29 -0700980 if (kmemleak_enabled && ptr && !IS_ERR(ptr))
Catalin Marinas53238a62009-07-07 10:33:00 +0100981 delete_object_part((unsigned long)ptr, size);
Catalin Marinas53238a62009-07-07 10:33:00 +0100982}
983EXPORT_SYMBOL_GPL(kmemleak_free_part);
984
Catalin Marinasa2b6bf62010-07-19 11:54:17 +0100985/**
Catalin Marinasf528f0b2011-09-26 17:12:53 +0100986 * kmemleak_free_percpu - unregister a previously registered __percpu object
987 * @ptr: __percpu pointer to beginning of the object
988 *
989 * This function is called from the kernel percpu allocator when an object
990 * (memory block) is freed (free_percpu).
991 */
992void __ref kmemleak_free_percpu(const void __percpu *ptr)
993{
994 unsigned int cpu;
995
996 pr_debug("%s(0x%p)\n", __func__, ptr);
997
Catalin Marinasc5f3b1a2015-06-24 16:58:26 -0700998 if (kmemleak_free_enabled && ptr && !IS_ERR(ptr))
Catalin Marinasf528f0b2011-09-26 17:12:53 +0100999 for_each_possible_cpu(cpu)
1000 delete_object_full((unsigned long)per_cpu_ptr(ptr,
1001 cpu));
Catalin Marinasf528f0b2011-09-26 17:12:53 +01001002}
1003EXPORT_SYMBOL_GPL(kmemleak_free_percpu);
1004
1005/**
Catalin Marinasffe2c742014-06-06 14:38:17 -07001006 * kmemleak_update_trace - update object allocation stack trace
1007 * @ptr: pointer to beginning of the object
1008 *
1009 * Override the object allocation stack trace for cases where the actual
1010 * allocation place is not always useful.
1011 */
1012void __ref kmemleak_update_trace(const void *ptr)
1013{
1014 struct kmemleak_object *object;
1015 unsigned long flags;
1016
1017 pr_debug("%s(0x%p)\n", __func__, ptr);
1018
1019 if (!kmemleak_enabled || IS_ERR_OR_NULL(ptr))
1020 return;
1021
1022 object = find_and_get_object((unsigned long)ptr, 1);
1023 if (!object) {
1024#ifdef DEBUG
1025 kmemleak_warn("Updating stack trace for unknown object at %p\n",
1026 ptr);
1027#endif
1028 return;
1029 }
1030
He Zhe8c96f1b2020-01-30 22:12:00 -08001031 raw_spin_lock_irqsave(&object->lock, flags);
Catalin Marinasffe2c742014-06-06 14:38:17 -07001032 object->trace_len = __save_stack_trace(object->trace);
He Zhe8c96f1b2020-01-30 22:12:00 -08001033 raw_spin_unlock_irqrestore(&object->lock, flags);
Catalin Marinasffe2c742014-06-06 14:38:17 -07001034
1035 put_object(object);
1036}
1037EXPORT_SYMBOL(kmemleak_update_trace);
1038
1039/**
Catalin Marinasa2b6bf62010-07-19 11:54:17 +01001040 * kmemleak_not_leak - mark an allocated object as false positive
1041 * @ptr: pointer to beginning of the object
1042 *
1043 * Calling this function on an object will cause the memory block to no longer
1044 * be reported as leak and always be scanned.
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001045 */
Catalin Marinasa6186d82009-08-27 14:29:16 +01001046void __ref kmemleak_not_leak(const void *ptr)
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001047{
1048 pr_debug("%s(0x%p)\n", __func__, ptr);
1049
Li Zefan8910ae892014-04-03 14:46:29 -07001050 if (kmemleak_enabled && ptr && !IS_ERR(ptr))
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001051 make_gray_object((unsigned long)ptr);
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001052}
1053EXPORT_SYMBOL(kmemleak_not_leak);
1054
Catalin Marinasa2b6bf62010-07-19 11:54:17 +01001055/**
1056 * kmemleak_ignore - ignore an allocated object
1057 * @ptr: pointer to beginning of the object
1058 *
1059 * Calling this function on an object will cause the memory block to be
1060 * ignored (not scanned and not reported as a leak). This is usually done when
1061 * it is known that the corresponding block is not a leak and does not contain
1062 * any references to other allocated memory blocks.
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001063 */
Catalin Marinasa6186d82009-08-27 14:29:16 +01001064void __ref kmemleak_ignore(const void *ptr)
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001065{
1066 pr_debug("%s(0x%p)\n", __func__, ptr);
1067
Li Zefan8910ae892014-04-03 14:46:29 -07001068 if (kmemleak_enabled && ptr && !IS_ERR(ptr))
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001069 make_black_object((unsigned long)ptr);
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001070}
1071EXPORT_SYMBOL(kmemleak_ignore);
1072
Catalin Marinasa2b6bf62010-07-19 11:54:17 +01001073/**
1074 * kmemleak_scan_area - limit the range to be scanned in an allocated object
1075 * @ptr: pointer to beginning or inside the object. This also
1076 * represents the start of the scan area
1077 * @size: size of the scan area
1078 * @gfp: kmalloc() flags used for kmemleak internal memory allocations
1079 *
1080 * This function is used when it is known that only certain parts of an object
1081 * contain references to other objects. Kmemleak will only scan these areas
1082 * reducing the number false negatives.
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001083 */
Catalin Marinasc017b4b2009-10-28 13:33:09 +00001084void __ref kmemleak_scan_area(const void *ptr, size_t size, gfp_t gfp)
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001085{
1086 pr_debug("%s(0x%p)\n", __func__, ptr);
1087
Li Zefan8910ae892014-04-03 14:46:29 -07001088 if (kmemleak_enabled && ptr && size && !IS_ERR(ptr))
Catalin Marinasc017b4b2009-10-28 13:33:09 +00001089 add_scan_area((unsigned long)ptr, size, gfp);
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001090}
1091EXPORT_SYMBOL(kmemleak_scan_area);
1092
Catalin Marinasa2b6bf62010-07-19 11:54:17 +01001093/**
1094 * kmemleak_no_scan - do not scan an allocated object
1095 * @ptr: pointer to beginning of the object
1096 *
1097 * This function notifies kmemleak not to scan the given memory block. Useful
1098 * in situations where it is known that the given object does not contain any
1099 * references to other objects. Kmemleak will not scan such objects reducing
1100 * the number of false negatives.
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001101 */
Catalin Marinasa6186d82009-08-27 14:29:16 +01001102void __ref kmemleak_no_scan(const void *ptr)
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001103{
1104 pr_debug("%s(0x%p)\n", __func__, ptr);
1105
Li Zefan8910ae892014-04-03 14:46:29 -07001106 if (kmemleak_enabled && ptr && !IS_ERR(ptr))
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001107 object_no_scan((unsigned long)ptr);
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001108}
1109EXPORT_SYMBOL(kmemleak_no_scan);
1110
Catalin Marinas9099dae2016-10-11 13:55:11 -07001111/**
1112 * kmemleak_alloc_phys - similar to kmemleak_alloc but taking a physical
1113 * address argument
Mike Rapoporte8b098f2018-04-05 16:24:57 -07001114 * @phys: physical address of the object
1115 * @size: size of the object
1116 * @min_count: minimum number of references to this object.
1117 * See kmemleak_alloc()
1118 * @gfp: kmalloc() flags used for kmemleak internal memory allocations
Catalin Marinas9099dae2016-10-11 13:55:11 -07001119 */
1120void __ref kmemleak_alloc_phys(phys_addr_t phys, size_t size, int min_count,
1121 gfp_t gfp)
1122{
1123 if (!IS_ENABLED(CONFIG_HIGHMEM) || PHYS_PFN(phys) < max_low_pfn)
1124 kmemleak_alloc(__va(phys), size, min_count, gfp);
1125}
1126EXPORT_SYMBOL(kmemleak_alloc_phys);
1127
1128/**
1129 * kmemleak_free_part_phys - similar to kmemleak_free_part but taking a
1130 * physical address argument
Mike Rapoporte8b098f2018-04-05 16:24:57 -07001131 * @phys: physical address if the beginning or inside an object. This
1132 * also represents the start of the range to be freed
1133 * @size: size to be unregistered
Catalin Marinas9099dae2016-10-11 13:55:11 -07001134 */
1135void __ref kmemleak_free_part_phys(phys_addr_t phys, size_t size)
1136{
1137 if (!IS_ENABLED(CONFIG_HIGHMEM) || PHYS_PFN(phys) < max_low_pfn)
1138 kmemleak_free_part(__va(phys), size);
1139}
1140EXPORT_SYMBOL(kmemleak_free_part_phys);
1141
1142/**
1143 * kmemleak_not_leak_phys - similar to kmemleak_not_leak but taking a physical
1144 * address argument
Mike Rapoporte8b098f2018-04-05 16:24:57 -07001145 * @phys: physical address of the object
Catalin Marinas9099dae2016-10-11 13:55:11 -07001146 */
1147void __ref kmemleak_not_leak_phys(phys_addr_t phys)
1148{
1149 if (!IS_ENABLED(CONFIG_HIGHMEM) || PHYS_PFN(phys) < max_low_pfn)
1150 kmemleak_not_leak(__va(phys));
1151}
1152EXPORT_SYMBOL(kmemleak_not_leak_phys);
1153
1154/**
1155 * kmemleak_ignore_phys - similar to kmemleak_ignore but taking a physical
1156 * address argument
Mike Rapoporte8b098f2018-04-05 16:24:57 -07001157 * @phys: physical address of the object
Catalin Marinas9099dae2016-10-11 13:55:11 -07001158 */
1159void __ref kmemleak_ignore_phys(phys_addr_t phys)
1160{
1161 if (!IS_ENABLED(CONFIG_HIGHMEM) || PHYS_PFN(phys) < max_low_pfn)
1162 kmemleak_ignore(__va(phys));
1163}
1164EXPORT_SYMBOL(kmemleak_ignore_phys);
1165
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001166/*
Catalin Marinas04609ccc2009-10-28 13:33:12 +00001167 * Update an object's checksum and return true if it was modified.
1168 */
1169static bool update_checksum(struct kmemleak_object *object)
1170{
1171 u32 old_csum = object->checksum;
1172
Andrey Ryabinine79ed2f2015-02-13 14:39:49 -08001173 kasan_disable_current();
Qian Cai69d0b542020-08-14 17:31:14 -07001174 kcsan_disable_current();
Kuan-Ying Lee6c7a00b2021-08-13 16:54:24 -07001175 object->checksum = crc32(0, kasan_reset_tag((void *)object->pointer), object->size);
Andrey Ryabinine79ed2f2015-02-13 14:39:49 -08001176 kasan_enable_current();
Qian Cai69d0b542020-08-14 17:31:14 -07001177 kcsan_enable_current();
Andrey Ryabinine79ed2f2015-02-13 14:39:49 -08001178
Catalin Marinas04609ccc2009-10-28 13:33:12 +00001179 return object->checksum != old_csum;
1180}
1181
1182/*
Catalin Marinas04f70d12017-07-06 15:40:19 -07001183 * Update an object's references. object->lock must be held by the caller.
1184 */
1185static void update_refs(struct kmemleak_object *object)
1186{
1187 if (!color_white(object)) {
1188 /* non-orphan, ignored or new */
1189 return;
1190 }
1191
1192 /*
1193 * Increase the object's reference count (number of pointers to the
1194 * memory block). If this count reaches the required minimum, the
1195 * object's color will become gray and it will be added to the
1196 * gray_list.
1197 */
1198 object->count++;
1199 if (color_gray(object)) {
1200 /* put_object() called when removing from gray_list */
1201 WARN_ON(!get_object(object));
1202 list_add_tail(&object->gray_list, &gray_list);
1203 }
1204}
1205
1206/*
Bhaskar Chowdhury0b5121e2021-04-29 22:54:54 -07001207 * Memory scanning is a long process and it needs to be interruptible. This
Lucas De Marchi25985ed2011-03-30 22:57:33 -03001208 * function checks whether such interrupt condition occurred.
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001209 */
1210static int scan_should_stop(void)
1211{
Li Zefan8910ae892014-04-03 14:46:29 -07001212 if (!kmemleak_enabled)
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001213 return 1;
1214
1215 /*
1216 * This function may be called from either process or kthread context,
1217 * hence the need to check for both stop conditions.
1218 */
1219 if (current->mm)
1220 return signal_pending(current);
1221 else
1222 return kthread_should_stop();
1223
1224 return 0;
1225}
1226
1227/*
1228 * Scan a memory block (exclusive range) for valid pointers and add those
1229 * found to the gray list.
1230 */
1231static void scan_block(void *_start, void *_end,
Catalin Marinas93ada572015-06-24 16:58:37 -07001232 struct kmemleak_object *scanned)
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001233{
1234 unsigned long *ptr;
1235 unsigned long *start = PTR_ALIGN(_start, BYTES_PER_POINTER);
1236 unsigned long *end = _end - (BYTES_PER_POINTER - 1);
Catalin Marinas93ada572015-06-24 16:58:37 -07001237 unsigned long flags;
Andrey Konovalova2f77572019-02-20 22:19:16 -08001238 unsigned long untagged_ptr;
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001239
He Zhe8c96f1b2020-01-30 22:12:00 -08001240 raw_spin_lock_irqsave(&kmemleak_lock, flags);
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001241 for (ptr = start; ptr < end; ptr++) {
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001242 struct kmemleak_object *object;
Pekka Enberg8e019362009-08-27 14:50:00 +01001243 unsigned long pointer;
Catalin Marinas94f4a162017-07-06 15:40:22 -07001244 unsigned long excess_ref;
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001245
1246 if (scan_should_stop())
1247 break;
1248
Andrey Ryabinine79ed2f2015-02-13 14:39:49 -08001249 kasan_disable_current();
Kuan-Ying Lee6c7a00b2021-08-13 16:54:24 -07001250 pointer = *(unsigned long *)kasan_reset_tag((void *)ptr);
Andrey Ryabinine79ed2f2015-02-13 14:39:49 -08001251 kasan_enable_current();
Pekka Enberg8e019362009-08-27 14:50:00 +01001252
Andrey Konovalova2f77572019-02-20 22:19:16 -08001253 untagged_ptr = (unsigned long)kasan_reset_tag((void *)pointer);
1254 if (untagged_ptr < min_addr || untagged_ptr >= max_addr)
Catalin Marinas93ada572015-06-24 16:58:37 -07001255 continue;
1256
1257 /*
1258 * No need for get_object() here since we hold kmemleak_lock.
1259 * object->use_count cannot be dropped to 0 while the object
1260 * is still present in object_tree_root and object_list
1261 * (with updates protected by kmemleak_lock).
1262 */
1263 object = lookup_object(pointer, 1);
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001264 if (!object)
1265 continue;
Catalin Marinas93ada572015-06-24 16:58:37 -07001266 if (object == scanned)
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001267 /* self referenced, ignore */
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001268 continue;
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001269
1270 /*
1271 * Avoid the lockdep recursive warning on object->lock being
1272 * previously acquired in scan_object(). These locks are
1273 * enclosed by scan_mutex.
1274 */
He Zhe8c96f1b2020-01-30 22:12:00 -08001275 raw_spin_lock_nested(&object->lock, SINGLE_DEPTH_NESTING);
Catalin Marinas94f4a162017-07-06 15:40:22 -07001276 /* only pass surplus references (object already gray) */
1277 if (color_gray(object)) {
1278 excess_ref = object->excess_ref;
1279 /* no need for update_refs() if object already gray */
1280 } else {
1281 excess_ref = 0;
1282 update_refs(object);
1283 }
He Zhe8c96f1b2020-01-30 22:12:00 -08001284 raw_spin_unlock(&object->lock);
Catalin Marinas94f4a162017-07-06 15:40:22 -07001285
1286 if (excess_ref) {
1287 object = lookup_object(excess_ref, 0);
1288 if (!object)
1289 continue;
1290 if (object == scanned)
1291 /* circular reference, ignore */
1292 continue;
He Zhe8c96f1b2020-01-30 22:12:00 -08001293 raw_spin_lock_nested(&object->lock, SINGLE_DEPTH_NESTING);
Catalin Marinas94f4a162017-07-06 15:40:22 -07001294 update_refs(object);
He Zhe8c96f1b2020-01-30 22:12:00 -08001295 raw_spin_unlock(&object->lock);
Catalin Marinas94f4a162017-07-06 15:40:22 -07001296 }
Catalin Marinas93ada572015-06-24 16:58:37 -07001297 }
He Zhe8c96f1b2020-01-30 22:12:00 -08001298 raw_spin_unlock_irqrestore(&kmemleak_lock, flags);
Catalin Marinas93ada572015-06-24 16:58:37 -07001299}
Catalin Marinas0587da42009-10-28 13:33:11 +00001300
Catalin Marinas93ada572015-06-24 16:58:37 -07001301/*
1302 * Scan a large memory block in MAX_SCAN_SIZE chunks to reduce the latency.
1303 */
Arnd Bergmanndce5b0b2019-04-18 17:50:48 -07001304#ifdef CONFIG_SMP
Catalin Marinas93ada572015-06-24 16:58:37 -07001305static void scan_large_block(void *start, void *end)
1306{
1307 void *next;
1308
1309 while (start < end) {
1310 next = min(start + MAX_SCAN_SIZE, end);
1311 scan_block(start, next, NULL);
1312 start = next;
1313 cond_resched();
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001314 }
1315}
Arnd Bergmanndce5b0b2019-04-18 17:50:48 -07001316#endif
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001317
1318/*
1319 * Scan a memory block corresponding to a kmemleak_object. A condition is
1320 * that object->use_count >= 1.
1321 */
1322static void scan_object(struct kmemleak_object *object)
1323{
1324 struct kmemleak_scan_area *area;
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001325 unsigned long flags;
1326
1327 /*
Uwe Kleine-König21ae2952009-10-07 15:21:09 +02001328 * Once the object->lock is acquired, the corresponding memory block
1329 * cannot be freed (the same lock is acquired in delete_object).
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001330 */
He Zhe8c96f1b2020-01-30 22:12:00 -08001331 raw_spin_lock_irqsave(&object->lock, flags);
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001332 if (object->flags & OBJECT_NO_SCAN)
1333 goto out;
1334 if (!(object->flags & OBJECT_ALLOCATED))
1335 /* already freed object */
1336 goto out;
Catalin Marinasdba82d92019-09-23 15:33:59 -07001337 if (hlist_empty(&object->area_list) ||
1338 object->flags & OBJECT_FULL_SCAN) {
Catalin Marinasaf986032009-08-27 14:29:12 +01001339 void *start = (void *)object->pointer;
1340 void *end = (void *)(object->pointer + object->size);
Catalin Marinas93ada572015-06-24 16:58:37 -07001341 void *next;
Catalin Marinasaf986032009-08-27 14:29:12 +01001342
Catalin Marinas93ada572015-06-24 16:58:37 -07001343 do {
1344 next = min(start + MAX_SCAN_SIZE, end);
1345 scan_block(start, next, object);
1346
1347 start = next;
1348 if (start >= end)
1349 break;
Catalin Marinasaf986032009-08-27 14:29:12 +01001350
He Zhe8c96f1b2020-01-30 22:12:00 -08001351 raw_spin_unlock_irqrestore(&object->lock, flags);
Catalin Marinasaf986032009-08-27 14:29:12 +01001352 cond_resched();
He Zhe8c96f1b2020-01-30 22:12:00 -08001353 raw_spin_lock_irqsave(&object->lock, flags);
Catalin Marinas93ada572015-06-24 16:58:37 -07001354 } while (object->flags & OBJECT_ALLOCATED);
Catalin Marinasaf986032009-08-27 14:29:12 +01001355 } else
Sasha Levinb67bfe02013-02-27 17:06:00 -08001356 hlist_for_each_entry(area, &object->area_list, node)
Catalin Marinasc017b4b2009-10-28 13:33:09 +00001357 scan_block((void *)area->start,
1358 (void *)(area->start + area->size),
Catalin Marinas93ada572015-06-24 16:58:37 -07001359 object);
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001360out:
He Zhe8c96f1b2020-01-30 22:12:00 -08001361 raw_spin_unlock_irqrestore(&object->lock, flags);
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001362}
1363
1364/*
Catalin Marinas04609ccc2009-10-28 13:33:12 +00001365 * Scan the objects already referenced (gray objects). More objects will be
1366 * referenced and, if there are no memory leaks, all the objects are scanned.
1367 */
1368static void scan_gray_list(void)
1369{
1370 struct kmemleak_object *object, *tmp;
1371
1372 /*
1373 * The list traversal is safe for both tail additions and removals
1374 * from inside the loop. The kmemleak objects cannot be freed from
1375 * outside the loop because their use_count was incremented.
1376 */
1377 object = list_entry(gray_list.next, typeof(*object), gray_list);
1378 while (&object->gray_list != &gray_list) {
1379 cond_resched();
1380
1381 /* may add new objects to the list */
1382 if (!scan_should_stop())
1383 scan_object(object);
1384
1385 tmp = list_entry(object->gray_list.next, typeof(*object),
1386 gray_list);
1387
1388 /* remove the object from the list and release it */
1389 list_del(&object->gray_list);
1390 put_object(object);
1391
1392 object = tmp;
1393 }
1394 WARN_ON(!list_empty(&gray_list));
1395}
1396
1397/*
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001398 * Scan data sections and all the referenced memory blocks allocated via the
1399 * kernel's standard allocators. This function must be called with the
1400 * scan_mutex held.
1401 */
1402static void kmemleak_scan(void)
1403{
1404 unsigned long flags;
Catalin Marinas04609ccc2009-10-28 13:33:12 +00001405 struct kmemleak_object *object;
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001406 int i;
Catalin Marinas4698c1f2009-06-26 17:38:27 +01001407 int new_leaks = 0;
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001408
Catalin Marinasacf49682009-06-26 17:38:29 +01001409 jiffies_last_scan = jiffies;
1410
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001411 /* prepare the kmemleak_object's */
1412 rcu_read_lock();
1413 list_for_each_entry_rcu(object, &object_list, object_list) {
He Zhe8c96f1b2020-01-30 22:12:00 -08001414 raw_spin_lock_irqsave(&object->lock, flags);
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001415#ifdef DEBUG
1416 /*
1417 * With a few exceptions there should be a maximum of
1418 * 1 reference to any object at this point.
1419 */
1420 if (atomic_read(&object->use_count) > 1) {
Joe Perchesae281062009-06-23 14:40:26 +01001421 pr_debug("object->use_count = %d\n",
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001422 atomic_read(&object->use_count));
1423 dump_object_info(object);
1424 }
1425#endif
1426 /* reset the reference count (whiten the object) */
1427 object->count = 0;
1428 if (color_gray(object) && get_object(object))
1429 list_add_tail(&object->gray_list, &gray_list);
1430
He Zhe8c96f1b2020-01-30 22:12:00 -08001431 raw_spin_unlock_irqrestore(&object->lock, flags);
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001432 }
1433 rcu_read_unlock();
1434
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001435#ifdef CONFIG_SMP
1436 /* per-cpu sections scanning */
1437 for_each_possible_cpu(i)
Catalin Marinas93ada572015-06-24 16:58:37 -07001438 scan_large_block(__per_cpu_start + per_cpu_offset(i),
1439 __per_cpu_end + per_cpu_offset(i));
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001440#endif
1441
1442 /*
Laura Abbott029aeff2011-11-15 23:49:09 +00001443 * Struct page scanning for each node.
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001444 */
Vladimir Davydovbfc8c902014-06-04 16:07:18 -07001445 get_online_mems();
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001446 for_each_online_node(i) {
Cody P Schafer108bcc92013-02-22 16:35:23 -08001447 unsigned long start_pfn = node_start_pfn(i);
1448 unsigned long end_pfn = node_end_pfn(i);
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001449 unsigned long pfn;
1450
1451 for (pfn = start_pfn; pfn < end_pfn; pfn++) {
Oscar Salvador9f1eb382018-12-28 00:37:57 -08001452 struct page *page = pfn_to_online_page(pfn);
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001453
Oscar Salvador9f1eb382018-12-28 00:37:57 -08001454 if (!page)
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001455 continue;
Oscar Salvador9f1eb382018-12-28 00:37:57 -08001456
1457 /* only scan pages belonging to this node */
1458 if (page_to_nid(page) != i)
1459 continue;
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001460 /* only scan if page is in use */
1461 if (page_count(page) == 0)
1462 continue;
Catalin Marinas93ada572015-06-24 16:58:37 -07001463 scan_block(page, page + 1, NULL);
Andrew Morton13ab183d2017-12-14 15:32:31 -08001464 if (!(pfn & 63))
Yisheng Xiebde5f6b2017-11-29 16:11:08 -08001465 cond_resched();
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001466 }
1467 }
Vladimir Davydovbfc8c902014-06-04 16:07:18 -07001468 put_online_mems();
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001469
1470 /*
Catalin Marinas43ed5d62009-09-01 11:12:44 +01001471 * Scanning the task stacks (may introduce false negatives).
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001472 */
1473 if (kmemleak_stack_scan) {
Catalin Marinas43ed5d62009-09-01 11:12:44 +01001474 struct task_struct *p, *g;
1475
Davidlohr Buesoc4b28962020-10-13 16:48:50 -07001476 rcu_read_lock();
1477 for_each_process_thread(g, p) {
Catalin Marinas37df49f2016-10-27 17:46:47 -07001478 void *stack = try_get_task_stack(p);
1479 if (stack) {
1480 scan_block(stack, stack + THREAD_SIZE, NULL);
1481 put_task_stack(p);
1482 }
Davidlohr Buesoc4b28962020-10-13 16:48:50 -07001483 }
1484 rcu_read_unlock();
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001485 }
1486
1487 /*
1488 * Scan the objects already referenced from the sections scanned
Catalin Marinas04609ccc2009-10-28 13:33:12 +00001489 * above.
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001490 */
Catalin Marinas04609ccc2009-10-28 13:33:12 +00001491 scan_gray_list();
Catalin Marinas25873622009-07-07 10:32:58 +01001492
1493 /*
Catalin Marinas04609ccc2009-10-28 13:33:12 +00001494 * Check for new or unreferenced objects modified since the previous
1495 * scan and color them gray until the next scan.
Catalin Marinas25873622009-07-07 10:32:58 +01001496 */
1497 rcu_read_lock();
1498 list_for_each_entry_rcu(object, &object_list, object_list) {
He Zhe8c96f1b2020-01-30 22:12:00 -08001499 raw_spin_lock_irqsave(&object->lock, flags);
Catalin Marinas04609ccc2009-10-28 13:33:12 +00001500 if (color_white(object) && (object->flags & OBJECT_ALLOCATED)
1501 && update_checksum(object) && get_object(object)) {
1502 /* color it gray temporarily */
1503 object->count = object->min_count;
Catalin Marinas25873622009-07-07 10:32:58 +01001504 list_add_tail(&object->gray_list, &gray_list);
1505 }
He Zhe8c96f1b2020-01-30 22:12:00 -08001506 raw_spin_unlock_irqrestore(&object->lock, flags);
Catalin Marinas25873622009-07-07 10:32:58 +01001507 }
1508 rcu_read_unlock();
1509
Catalin Marinas04609ccc2009-10-28 13:33:12 +00001510 /*
1511 * Re-scan the gray list for modified unreferenced objects.
1512 */
1513 scan_gray_list();
Catalin Marinas4698c1f2009-06-26 17:38:27 +01001514
1515 /*
Catalin Marinas04609ccc2009-10-28 13:33:12 +00001516 * If scanning was stopped do not report any new unreferenced objects.
Catalin Marinas17bb9e02009-06-29 17:13:56 +01001517 */
Catalin Marinas04609ccc2009-10-28 13:33:12 +00001518 if (scan_should_stop())
Catalin Marinas17bb9e02009-06-29 17:13:56 +01001519 return;
1520
1521 /*
Catalin Marinas4698c1f2009-06-26 17:38:27 +01001522 * Scanning result reporting.
1523 */
1524 rcu_read_lock();
1525 list_for_each_entry_rcu(object, &object_list, object_list) {
He Zhe8c96f1b2020-01-30 22:12:00 -08001526 raw_spin_lock_irqsave(&object->lock, flags);
Catalin Marinas4698c1f2009-06-26 17:38:27 +01001527 if (unreferenced_object(object) &&
1528 !(object->flags & OBJECT_REPORTED)) {
1529 object->flags |= OBJECT_REPORTED;
Vincent Whitchurch154221c2018-10-26 15:03:42 -07001530
1531 if (kmemleak_verbose)
1532 print_unreferenced(NULL, object);
1533
Catalin Marinas4698c1f2009-06-26 17:38:27 +01001534 new_leaks++;
1535 }
He Zhe8c96f1b2020-01-30 22:12:00 -08001536 raw_spin_unlock_irqrestore(&object->lock, flags);
Catalin Marinas4698c1f2009-06-26 17:38:27 +01001537 }
1538 rcu_read_unlock();
1539
Li Zefandc9b3f42014-04-03 14:46:26 -07001540 if (new_leaks) {
1541 kmemleak_found_leaks = true;
1542
Joe Perches756a0252016-03-17 14:19:47 -07001543 pr_info("%d new suspected memory leaks (see /sys/kernel/debug/kmemleak)\n",
1544 new_leaks);
Li Zefandc9b3f42014-04-03 14:46:26 -07001545 }
Catalin Marinas4698c1f2009-06-26 17:38:27 +01001546
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001547}
1548
1549/*
1550 * Thread function performing automatic memory scanning. Unreferenced objects
1551 * at the end of a memory scan are reported but only the first time.
1552 */
1553static int kmemleak_scan_thread(void *arg)
1554{
Sri Krishna chowdaryd53ce042018-12-28 00:38:54 -08001555 static int first_run = IS_ENABLED(CONFIG_DEBUG_KMEMLEAK_AUTO_SCAN);
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001556
Joe Perchesae281062009-06-23 14:40:26 +01001557 pr_info("Automatic memory scanning thread started\n");
Catalin Marinasbf2a76b2009-07-07 10:32:55 +01001558 set_user_nice(current, 10);
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001559
1560 /*
1561 * Wait before the first scan to allow the system to fully initialize.
1562 */
1563 if (first_run) {
Vegard Nossum98c42d92016-07-28 15:48:32 -07001564 signed long timeout = msecs_to_jiffies(SECS_FIRST_SCAN * 1000);
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001565 first_run = 0;
Vegard Nossum98c42d92016-07-28 15:48:32 -07001566 while (timeout && !kthread_should_stop())
1567 timeout = schedule_timeout_interruptible(timeout);
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001568 }
1569
1570 while (!kthread_should_stop()) {
Yanfei Xu54dd2002021-06-28 19:35:01 -07001571 signed long timeout = READ_ONCE(jiffies_scan_wait);
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001572
1573 mutex_lock(&scan_mutex);
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001574 kmemleak_scan();
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001575 mutex_unlock(&scan_mutex);
Catalin Marinas4698c1f2009-06-26 17:38:27 +01001576
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001577 /* wait before the next scan */
1578 while (timeout && !kthread_should_stop())
1579 timeout = schedule_timeout_interruptible(timeout);
1580 }
1581
Joe Perchesae281062009-06-23 14:40:26 +01001582 pr_info("Automatic memory scanning thread ended\n");
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001583
1584 return 0;
1585}
1586
1587/*
1588 * Start the automatic memory scanning thread. This function must be called
Catalin Marinas4698c1f2009-06-26 17:38:27 +01001589 * with the scan_mutex held.
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001590 */
Luis R. Rodriguez7eb0d5e2009-09-08 17:31:45 +01001591static void start_scan_thread(void)
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001592{
1593 if (scan_thread)
1594 return;
1595 scan_thread = kthread_run(kmemleak_scan_thread, NULL, "kmemleak");
1596 if (IS_ERR(scan_thread)) {
Joe Perches598d8092016-03-17 14:19:44 -07001597 pr_warn("Failed to create the scan thread\n");
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001598 scan_thread = NULL;
1599 }
1600}
1601
1602/*
Vinayak Menon914b6df2018-03-28 16:01:16 -07001603 * Stop the automatic memory scanning thread.
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001604 */
Luis R. Rodriguez7eb0d5e2009-09-08 17:31:45 +01001605static void stop_scan_thread(void)
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001606{
1607 if (scan_thread) {
1608 kthread_stop(scan_thread);
1609 scan_thread = NULL;
1610 }
1611}
1612
1613/*
1614 * Iterate over the object_list and return the first valid object at or after
1615 * the required position with its use_count incremented. The function triggers
1616 * a memory scanning when the pos argument points to the first position.
1617 */
1618static void *kmemleak_seq_start(struct seq_file *seq, loff_t *pos)
1619{
1620 struct kmemleak_object *object;
1621 loff_t n = *pos;
Catalin Marinasb87324d2009-07-07 10:32:58 +01001622 int err;
1623
1624 err = mutex_lock_interruptible(&scan_mutex);
1625 if (err < 0)
1626 return ERR_PTR(err);
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001627
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001628 rcu_read_lock();
1629 list_for_each_entry_rcu(object, &object_list, object_list) {
1630 if (n-- > 0)
1631 continue;
1632 if (get_object(object))
1633 goto out;
1634 }
1635 object = NULL;
1636out:
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001637 return object;
1638}
1639
1640/*
1641 * Return the next object in the object_list. The function decrements the
1642 * use_count of the previous object and increases that of the next one.
1643 */
1644static void *kmemleak_seq_next(struct seq_file *seq, void *v, loff_t *pos)
1645{
1646 struct kmemleak_object *prev_obj = v;
1647 struct kmemleak_object *next_obj = NULL;
Michael Wang58fac092012-08-17 12:33:34 +08001648 struct kmemleak_object *obj = prev_obj;
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001649
1650 ++(*pos);
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001651
Michael Wang58fac092012-08-17 12:33:34 +08001652 list_for_each_entry_continue_rcu(obj, &object_list, object_list) {
Catalin Marinas52c3ce42011-04-27 16:44:26 +01001653 if (get_object(obj)) {
1654 next_obj = obj;
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001655 break;
Catalin Marinas52c3ce42011-04-27 16:44:26 +01001656 }
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001657 }
Catalin Marinas288c8572009-07-07 10:32:57 +01001658
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001659 put_object(prev_obj);
1660 return next_obj;
1661}
1662
1663/*
1664 * Decrement the use_count of the last object required, if any.
1665 */
1666static void kmemleak_seq_stop(struct seq_file *seq, void *v)
1667{
Catalin Marinasb87324d2009-07-07 10:32:58 +01001668 if (!IS_ERR(v)) {
1669 /*
1670 * kmemleak_seq_start may return ERR_PTR if the scan_mutex
1671 * waiting was interrupted, so only release it if !IS_ERR.
1672 */
Catalin Marinasf5886c72009-07-29 16:26:57 +01001673 rcu_read_unlock();
Catalin Marinasb87324d2009-07-07 10:32:58 +01001674 mutex_unlock(&scan_mutex);
1675 if (v)
1676 put_object(v);
1677 }
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001678}
1679
1680/*
1681 * Print the information for an unreferenced object to the seq file.
1682 */
1683static int kmemleak_seq_show(struct seq_file *seq, void *v)
1684{
1685 struct kmemleak_object *object = v;
1686 unsigned long flags;
1687
He Zhe8c96f1b2020-01-30 22:12:00 -08001688 raw_spin_lock_irqsave(&object->lock, flags);
Catalin Marinas288c8572009-07-07 10:32:57 +01001689 if ((object->flags & OBJECT_REPORTED) && unreferenced_object(object))
Catalin Marinas17bb9e02009-06-29 17:13:56 +01001690 print_unreferenced(seq, object);
He Zhe8c96f1b2020-01-30 22:12:00 -08001691 raw_spin_unlock_irqrestore(&object->lock, flags);
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001692 return 0;
1693}
1694
1695static const struct seq_operations kmemleak_seq_ops = {
1696 .start = kmemleak_seq_start,
1697 .next = kmemleak_seq_next,
1698 .stop = kmemleak_seq_stop,
1699 .show = kmemleak_seq_show,
1700};
1701
1702static int kmemleak_open(struct inode *inode, struct file *file)
1703{
Catalin Marinasb87324d2009-07-07 10:32:58 +01001704 return seq_open(file, &kmemleak_seq_ops);
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001705}
1706
Catalin Marinas189d84e2009-08-27 14:29:15 +01001707static int dump_str_object_info(const char *str)
1708{
1709 unsigned long flags;
1710 struct kmemleak_object *object;
1711 unsigned long addr;
1712
Abhijit Pawardc053732012-12-18 14:23:27 -08001713 if (kstrtoul(str, 0, &addr))
1714 return -EINVAL;
Catalin Marinas189d84e2009-08-27 14:29:15 +01001715 object = find_and_get_object(addr, 0);
1716 if (!object) {
1717 pr_info("Unknown object at 0x%08lx\n", addr);
1718 return -EINVAL;
1719 }
1720
He Zhe8c96f1b2020-01-30 22:12:00 -08001721 raw_spin_lock_irqsave(&object->lock, flags);
Catalin Marinas189d84e2009-08-27 14:29:15 +01001722 dump_object_info(object);
He Zhe8c96f1b2020-01-30 22:12:00 -08001723 raw_spin_unlock_irqrestore(&object->lock, flags);
Catalin Marinas189d84e2009-08-27 14:29:15 +01001724
1725 put_object(object);
1726 return 0;
1727}
1728
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001729/*
Luis R. Rodriguez30b37102009-09-04 17:44:51 -07001730 * We use grey instead of black to ensure we can do future scans on the same
1731 * objects. If we did not do future scans these black objects could
1732 * potentially contain references to newly allocated objects in the future and
1733 * we'd end up with false positives.
1734 */
1735static void kmemleak_clear(void)
1736{
1737 struct kmemleak_object *object;
1738 unsigned long flags;
1739
1740 rcu_read_lock();
1741 list_for_each_entry_rcu(object, &object_list, object_list) {
He Zhe8c96f1b2020-01-30 22:12:00 -08001742 raw_spin_lock_irqsave(&object->lock, flags);
Luis R. Rodriguez30b37102009-09-04 17:44:51 -07001743 if ((object->flags & OBJECT_REPORTED) &&
1744 unreferenced_object(object))
Luis R. Rodrigueza1084c82009-09-04 17:44:52 -07001745 __paint_it(object, KMEMLEAK_GREY);
He Zhe8c96f1b2020-01-30 22:12:00 -08001746 raw_spin_unlock_irqrestore(&object->lock, flags);
Luis R. Rodriguez30b37102009-09-04 17:44:51 -07001747 }
1748 rcu_read_unlock();
Li Zefandc9b3f42014-04-03 14:46:26 -07001749
1750 kmemleak_found_leaks = false;
Luis R. Rodriguez30b37102009-09-04 17:44:51 -07001751}
1752
Li Zefanc89da702014-04-03 14:46:27 -07001753static void __kmemleak_do_cleanup(void);
1754
Luis R. Rodriguez30b37102009-09-04 17:44:51 -07001755/*
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001756 * File write operation to configure kmemleak at run-time. The following
1757 * commands can be written to the /sys/kernel/debug/kmemleak file:
1758 * off - disable kmemleak (irreversible)
1759 * stack=on - enable the task stacks scanning
1760 * stack=off - disable the tasks stacks scanning
1761 * scan=on - start the automatic memory scanning thread
1762 * scan=off - stop the automatic memory scanning thread
1763 * scan=... - set the automatic memory scanning period in seconds (0 to
1764 * disable it)
Catalin Marinas4698c1f2009-06-26 17:38:27 +01001765 * scan - trigger a memory scan
Luis R. Rodriguez30b37102009-09-04 17:44:51 -07001766 * clear - mark all current reported unreferenced kmemleak objects as
Li Zefanc89da702014-04-03 14:46:27 -07001767 * grey to ignore printing them, or free all kmemleak objects
1768 * if kmemleak has been disabled.
Catalin Marinas189d84e2009-08-27 14:29:15 +01001769 * dump=... - dump information about the object found at the given address
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001770 */
1771static ssize_t kmemleak_write(struct file *file, const char __user *user_buf,
1772 size_t size, loff_t *ppos)
1773{
1774 char buf[64];
1775 int buf_size;
Catalin Marinasb87324d2009-07-07 10:32:58 +01001776 int ret;
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001777
1778 buf_size = min(size, (sizeof(buf) - 1));
1779 if (strncpy_from_user(buf, user_buf, buf_size) < 0)
1780 return -EFAULT;
1781 buf[buf_size] = 0;
1782
Catalin Marinasb87324d2009-07-07 10:32:58 +01001783 ret = mutex_lock_interruptible(&scan_mutex);
1784 if (ret < 0)
1785 return ret;
1786
Li Zefanc89da702014-04-03 14:46:27 -07001787 if (strncmp(buf, "clear", 5) == 0) {
Li Zefan8910ae892014-04-03 14:46:29 -07001788 if (kmemleak_enabled)
Li Zefanc89da702014-04-03 14:46:27 -07001789 kmemleak_clear();
1790 else
1791 __kmemleak_do_cleanup();
1792 goto out;
1793 }
1794
Li Zefan8910ae892014-04-03 14:46:29 -07001795 if (!kmemleak_enabled) {
André Almeida4e4dfce2019-07-11 20:53:43 -07001796 ret = -EPERM;
Li Zefanc89da702014-04-03 14:46:27 -07001797 goto out;
1798 }
1799
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001800 if (strncmp(buf, "off", 3) == 0)
1801 kmemleak_disable();
1802 else if (strncmp(buf, "stack=on", 8) == 0)
1803 kmemleak_stack_scan = 1;
1804 else if (strncmp(buf, "stack=off", 9) == 0)
1805 kmemleak_stack_scan = 0;
1806 else if (strncmp(buf, "scan=on", 7) == 0)
1807 start_scan_thread();
1808 else if (strncmp(buf, "scan=off", 8) == 0)
1809 stop_scan_thread();
1810 else if (strncmp(buf, "scan=", 5) == 0) {
Yanfei Xu54dd2002021-06-28 19:35:01 -07001811 unsigned secs;
1812 unsigned long msecs;
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001813
Yanfei Xu54dd2002021-06-28 19:35:01 -07001814 ret = kstrtouint(buf + 5, 0, &secs);
Catalin Marinasb87324d2009-07-07 10:32:58 +01001815 if (ret < 0)
1816 goto out;
Yanfei Xu54dd2002021-06-28 19:35:01 -07001817
1818 msecs = secs * MSEC_PER_SEC;
1819 if (msecs > UINT_MAX)
1820 msecs = UINT_MAX;
1821
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001822 stop_scan_thread();
Yanfei Xu54dd2002021-06-28 19:35:01 -07001823 if (msecs) {
1824 WRITE_ONCE(jiffies_scan_wait, msecs_to_jiffies(msecs));
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001825 start_scan_thread();
1826 }
Catalin Marinas4698c1f2009-06-26 17:38:27 +01001827 } else if (strncmp(buf, "scan", 4) == 0)
1828 kmemleak_scan();
Catalin Marinas189d84e2009-08-27 14:29:15 +01001829 else if (strncmp(buf, "dump=", 5) == 0)
1830 ret = dump_str_object_info(buf + 5);
Catalin Marinas4698c1f2009-06-26 17:38:27 +01001831 else
Catalin Marinasb87324d2009-07-07 10:32:58 +01001832 ret = -EINVAL;
1833
1834out:
1835 mutex_unlock(&scan_mutex);
1836 if (ret < 0)
1837 return ret;
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001838
1839 /* ignore the rest of the buffer, only one command at a time */
1840 *ppos += size;
1841 return size;
1842}
1843
1844static const struct file_operations kmemleak_fops = {
1845 .owner = THIS_MODULE,
1846 .open = kmemleak_open,
1847 .read = seq_read,
1848 .write = kmemleak_write,
1849 .llseek = seq_lseek,
Li Zefan5f3bf192014-04-03 14:46:28 -07001850 .release = seq_release,
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001851};
1852
Li Zefanc89da702014-04-03 14:46:27 -07001853static void __kmemleak_do_cleanup(void)
1854{
Catalin Marinas2abd8392019-10-04 14:46:24 +01001855 struct kmemleak_object *object, *tmp;
Li Zefanc89da702014-04-03 14:46:27 -07001856
Catalin Marinas2abd8392019-10-04 14:46:24 +01001857 /*
1858 * Kmemleak has already been disabled, no need for RCU list traversal
1859 * or kmemleak_lock held.
1860 */
1861 list_for_each_entry_safe(object, tmp, &object_list, object_list) {
1862 __remove_object(object);
1863 __delete_object(object);
1864 }
Li Zefanc89da702014-04-03 14:46:27 -07001865}
1866
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001867/*
Catalin Marinas74341702011-09-29 11:50:07 +01001868 * Stop the memory scanning thread and free the kmemleak internal objects if
1869 * no previous scan thread (otherwise, kmemleak may still have some useful
1870 * information on memory leaks).
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001871 */
Catalin Marinas179a8102009-09-07 10:14:42 +01001872static void kmemleak_do_cleanup(struct work_struct *work)
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001873{
Catalin Marinas4698c1f2009-06-26 17:38:27 +01001874 stop_scan_thread();
1875
Vinayak Menon914b6df2018-03-28 16:01:16 -07001876 mutex_lock(&scan_mutex);
Catalin Marinasc5f3b1a2015-06-24 16:58:26 -07001877 /*
Vinayak Menon914b6df2018-03-28 16:01:16 -07001878 * Once it is made sure that kmemleak_scan has stopped, it is safe to no
1879 * longer track object freeing. Ordering of the scan thread stopping and
1880 * the memory accesses below is guaranteed by the kthread_stop()
1881 * function.
Catalin Marinasc5f3b1a2015-06-24 16:58:26 -07001882 */
1883 kmemleak_free_enabled = 0;
Vinayak Menon914b6df2018-03-28 16:01:16 -07001884 mutex_unlock(&scan_mutex);
Catalin Marinasc5f3b1a2015-06-24 16:58:26 -07001885
Li Zefanc89da702014-04-03 14:46:27 -07001886 if (!kmemleak_found_leaks)
1887 __kmemleak_do_cleanup();
1888 else
Joe Perches756a0252016-03-17 14:19:47 -07001889 pr_info("Kmemleak disabled without freeing internal data. Reclaim the memory with \"echo clear > /sys/kernel/debug/kmemleak\".\n");
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001890}
1891
Catalin Marinas179a8102009-09-07 10:14:42 +01001892static DECLARE_WORK(cleanup_work, kmemleak_do_cleanup);
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001893
1894/*
1895 * Disable kmemleak. No memory allocation/freeing will be traced once this
1896 * function is called. Disabling kmemleak is an irreversible operation.
1897 */
1898static void kmemleak_disable(void)
1899{
1900 /* atomically check whether it was already invoked */
Li Zefan8910ae892014-04-03 14:46:29 -07001901 if (cmpxchg(&kmemleak_error, 0, 1))
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001902 return;
1903
1904 /* stop any memory operation tracing */
Li Zefan8910ae892014-04-03 14:46:29 -07001905 kmemleak_enabled = 0;
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001906
1907 /* check whether it is too early for a kernel thread */
Li Zefan8910ae892014-04-03 14:46:29 -07001908 if (kmemleak_initialized)
Catalin Marinas179a8102009-09-07 10:14:42 +01001909 schedule_work(&cleanup_work);
Catalin Marinasc5f3b1a2015-06-24 16:58:26 -07001910 else
1911 kmemleak_free_enabled = 0;
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001912
1913 pr_info("Kernel memory leak detector disabled\n");
1914}
1915
1916/*
1917 * Allow boot-time kmemleak disabling (enabled by default).
1918 */
Dou Liyang8bd30c12018-04-05 16:23:46 -07001919static int __init kmemleak_boot_config(char *str)
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001920{
1921 if (!str)
1922 return -EINVAL;
1923 if (strcmp(str, "off") == 0)
1924 kmemleak_disable();
Jason Baronab0155a2010-07-19 11:54:17 +01001925 else if (strcmp(str, "on") == 0)
1926 kmemleak_skip_disable = 1;
1927 else
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001928 return -EINVAL;
1929 return 0;
1930}
1931early_param("kmemleak", kmemleak_boot_config);
1932
1933/*
Catalin Marinas20301172009-06-17 18:29:04 +01001934 * Kmemleak initialization.
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001935 */
1936void __init kmemleak_init(void)
1937{
Jason Baronab0155a2010-07-19 11:54:17 +01001938#ifdef CONFIG_DEBUG_KMEMLEAK_DEFAULT_OFF
1939 if (!kmemleak_skip_disable) {
1940 kmemleak_disable();
1941 return;
1942 }
1943#endif
1944
Catalin Marinasc5665862019-09-23 15:34:05 -07001945 if (kmemleak_error)
1946 return;
1947
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001948 jiffies_min_age = msecs_to_jiffies(MSECS_MIN_AGE);
1949 jiffies_scan_wait = msecs_to_jiffies(SECS_SCAN_WAIT * 1000);
1950
1951 object_cache = KMEM_CACHE(kmemleak_object, SLAB_NOLEAKTRACE);
1952 scan_area_cache = KMEM_CACHE(kmemleak_scan_area, SLAB_NOLEAKTRACE);
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001953
Catalin Marinas298a32b2019-04-05 18:38:49 -07001954 /* register the data/bss sections */
1955 create_object((unsigned long)_sdata, _edata - _sdata,
1956 KMEMLEAK_GREY, GFP_ATOMIC);
1957 create_object((unsigned long)__bss_start, __bss_stop - __bss_start,
1958 KMEMLEAK_GREY, GFP_ATOMIC);
1959 /* only register .data..ro_after_init if not within .data */
Nathan Chancellorb0d14fc2020-04-01 21:04:34 -07001960 if (&__start_ro_after_init < &_sdata || &__end_ro_after_init > &_edata)
Catalin Marinas298a32b2019-04-05 18:38:49 -07001961 create_object((unsigned long)__start_ro_after_init,
1962 __end_ro_after_init - __start_ro_after_init,
1963 KMEMLEAK_GREY, GFP_ATOMIC);
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001964}
1965
1966/*
1967 * Late initialization function.
1968 */
1969static int __init kmemleak_late_init(void)
1970{
Li Zefan8910ae892014-04-03 14:46:29 -07001971 kmemleak_initialized = 1;
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001972
Greg Kroah-Hartman282401d2019-01-22 16:21:12 +01001973 debugfs_create_file("kmemleak", 0644, NULL, NULL, &kmemleak_fops);
Vincent Whitchurchb3537562018-09-04 15:45:44 -07001974
Li Zefan8910ae892014-04-03 14:46:29 -07001975 if (kmemleak_error) {
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001976 /*
Lucas De Marchi25985ed2011-03-30 22:57:33 -03001977 * Some error occurred and kmemleak was disabled. There is a
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001978 * small chance that kmemleak_disable() was called immediately
1979 * after setting kmemleak_initialized and we may end up with
1980 * two clean-up threads but serialized by scan_mutex.
1981 */
Catalin Marinas179a8102009-09-07 10:14:42 +01001982 schedule_work(&cleanup_work);
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001983 return -ENOMEM;
1984 }
1985
Sri Krishna chowdaryd53ce042018-12-28 00:38:54 -08001986 if (IS_ENABLED(CONFIG_DEBUG_KMEMLEAK_AUTO_SCAN)) {
1987 mutex_lock(&scan_mutex);
1988 start_scan_thread();
1989 mutex_unlock(&scan_mutex);
1990 }
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001991
Qian Cai0e965a62019-09-23 15:34:07 -07001992 pr_info("Kernel memory leak detector initialized (mem pool available: %d)\n",
1993 mem_pool_free_count);
Catalin Marinas3c7b4e62009-06-11 13:22:39 +01001994
1995 return 0;
1996}
1997late_initcall(kmemleak_late_init);