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