145051539SThomas Gleixner // SPDX-License-Identifier: GPL-2.0-only
23c7b4e6bSCatalin Marinas /*
33c7b4e6bSCatalin Marinas * mm/kmemleak.c
43c7b4e6bSCatalin Marinas *
53c7b4e6bSCatalin Marinas * Copyright (C) 2008 ARM Limited
63c7b4e6bSCatalin Marinas * Written by Catalin Marinas <catalin.marinas@arm.com>
73c7b4e6bSCatalin Marinas *
83c7b4e6bSCatalin Marinas * For more information on the algorithm and kmemleak usage, please see
922901c6cSAndreas Platschek * Documentation/dev-tools/kmemleak.rst.
103c7b4e6bSCatalin Marinas *
113c7b4e6bSCatalin Marinas * Notes on locking
123c7b4e6bSCatalin Marinas * ----------------
133c7b4e6bSCatalin Marinas *
143c7b4e6bSCatalin Marinas * The following locks and mutexes are used by kmemleak:
153c7b4e6bSCatalin Marinas *
16782e4179SWaiman Long * - kmemleak_lock (raw_spinlock_t): protects the object_list as well as
1739042079SCatalin Marinas * del_state modifications and accesses to the object trees
1839042079SCatalin Marinas * (object_tree_root, object_phys_tree_root, object_percpu_tree_root). The
1939042079SCatalin Marinas * object_list is the main list holding the metadata (struct
2039042079SCatalin Marinas * kmemleak_object) for the allocated memory blocks. The object trees are
2139042079SCatalin Marinas * red black trees used to look-up metadata based on a pointer to the
2239042079SCatalin Marinas * corresponding memory block. The kmemleak_object structures are added to
2339042079SCatalin Marinas * the object_list and the object tree root in the create_object() function
2439042079SCatalin Marinas * called from the kmemleak_alloc{,_phys,_percpu}() callback and removed in
2539042079SCatalin Marinas * delete_object() called from the kmemleak_free{,_phys,_percpu}() callback
268c96f1bcSHe Zhe * - kmemleak_object.lock (raw_spinlock_t): protects a kmemleak_object.
278c96f1bcSHe Zhe * Accesses to the metadata (e.g. count) are protected by this lock. Note
288c96f1bcSHe Zhe * that some members of this structure may be protected by other means
298c96f1bcSHe Zhe * (atomic or kmemleak_lock). This lock is also held when scanning the
308c96f1bcSHe Zhe * corresponding memory block to avoid the kernel freeing it via the
318c96f1bcSHe Zhe * kmemleak_free() callback. This is less heavyweight than holding a global
328c96f1bcSHe Zhe * lock like kmemleak_lock during scanning.
333c7b4e6bSCatalin Marinas * - scan_mutex (mutex): ensures that only one thread may scan the memory for
343c7b4e6bSCatalin Marinas * unreferenced objects at a time. The gray_list contains the objects which
353c7b4e6bSCatalin Marinas * are already referenced or marked as false positives and need to be
363c7b4e6bSCatalin Marinas * scanned. This list is only modified during a scanning episode when the
373c7b4e6bSCatalin Marinas * scan_mutex is held. At the end of a scan, the gray_list is always empty.
383c7b4e6bSCatalin Marinas * Note that the kmemleak_object.use_count is incremented when an object is
394698c1f2SCatalin Marinas * added to the gray_list and therefore cannot be freed. This mutex also
404698c1f2SCatalin Marinas * prevents multiple users of the "kmemleak" debugfs file together with
414698c1f2SCatalin Marinas * modifications to the memory scanning parameters including the scan_thread
424698c1f2SCatalin Marinas * pointer
433c7b4e6bSCatalin Marinas *
4493ada579SCatalin Marinas * Locks and mutexes are acquired/nested in the following order:
459d5a4c73SCatalin Marinas *
4693ada579SCatalin Marinas * scan_mutex [-> object->lock] -> kmemleak_lock -> other_object->lock (SINGLE_DEPTH_NESTING)
4793ada579SCatalin Marinas *
4893ada579SCatalin Marinas * No kmemleak_lock and object->lock nesting is allowed outside scan_mutex
4993ada579SCatalin Marinas * regions.
509d5a4c73SCatalin Marinas *
513c7b4e6bSCatalin Marinas * The kmemleak_object structures have a use_count incremented or decremented
523c7b4e6bSCatalin Marinas * using the get_object()/put_object() functions. When the use_count becomes
533c7b4e6bSCatalin Marinas * 0, this count can no longer be incremented and put_object() schedules the
543c7b4e6bSCatalin Marinas * kmemleak_object freeing via an RCU callback. All calls to the get_object()
553c7b4e6bSCatalin Marinas * function must be protected by rcu_read_lock() to avoid accessing a freed
563c7b4e6bSCatalin Marinas * structure.
573c7b4e6bSCatalin Marinas */
583c7b4e6bSCatalin Marinas
59ae281064SJoe Perches #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
60ae281064SJoe Perches
613c7b4e6bSCatalin Marinas #include <linux/init.h>
623c7b4e6bSCatalin Marinas #include <linux/kernel.h>
633c7b4e6bSCatalin Marinas #include <linux/list.h>
643f07c014SIngo Molnar #include <linux/sched/signal.h>
6529930025SIngo Molnar #include <linux/sched/task.h>
6668db0cf1SIngo Molnar #include <linux/sched/task_stack.h>
673c7b4e6bSCatalin Marinas #include <linux/jiffies.h>
683c7b4e6bSCatalin Marinas #include <linux/delay.h>
69b95f1b31SPaul Gortmaker #include <linux/export.h>
703c7b4e6bSCatalin Marinas #include <linux/kthread.h>
7185d3a316SMichel Lespinasse #include <linux/rbtree.h>
723c7b4e6bSCatalin Marinas #include <linux/fs.h>
733c7b4e6bSCatalin Marinas #include <linux/debugfs.h>
743c7b4e6bSCatalin Marinas #include <linux/seq_file.h>
753c7b4e6bSCatalin Marinas #include <linux/cpumask.h>
763c7b4e6bSCatalin Marinas #include <linux/spinlock.h>
77154221c3SVincent Whitchurch #include <linux/module.h>
783c7b4e6bSCatalin Marinas #include <linux/mutex.h>
793c7b4e6bSCatalin Marinas #include <linux/rcupdate.h>
803c7b4e6bSCatalin Marinas #include <linux/stacktrace.h>
8156a61617SZhaoyang Huang #include <linux/stackdepot.h>
823c7b4e6bSCatalin Marinas #include <linux/cache.h>
833c7b4e6bSCatalin Marinas #include <linux/percpu.h>
8457c8a661SMike Rapoport #include <linux/memblock.h>
859099daedSCatalin Marinas #include <linux/pfn.h>
863c7b4e6bSCatalin Marinas #include <linux/mmzone.h>
873c7b4e6bSCatalin Marinas #include <linux/slab.h>
883c7b4e6bSCatalin Marinas #include <linux/thread_info.h>
893c7b4e6bSCatalin Marinas #include <linux/err.h>
903c7b4e6bSCatalin Marinas #include <linux/uaccess.h>
913c7b4e6bSCatalin Marinas #include <linux/string.h>
923c7b4e6bSCatalin Marinas #include <linux/nodemask.h>
933c7b4e6bSCatalin Marinas #include <linux/mm.h>
94179a8100SCatalin Marinas #include <linux/workqueue.h>
9504609cccSCatalin Marinas #include <linux/crc32.h>
963c7b4e6bSCatalin Marinas
973c7b4e6bSCatalin Marinas #include <asm/sections.h>
983c7b4e6bSCatalin Marinas #include <asm/processor.h>
9960063497SArun Sharma #include <linux/atomic.h>
1003c7b4e6bSCatalin Marinas
101e79ed2f1SAndrey Ryabinin #include <linux/kasan.h>
10295511580SMarco Elver #include <linux/kfence.h>
1033c7b4e6bSCatalin Marinas #include <linux/kmemleak.h>
104029aeff5SLaura Abbott #include <linux/memory_hotplug.h>
1053c7b4e6bSCatalin Marinas
1063c7b4e6bSCatalin Marinas /*
1073c7b4e6bSCatalin Marinas * Kmemleak configuration and common defines.
1083c7b4e6bSCatalin Marinas */
1093c7b4e6bSCatalin Marinas #define MAX_TRACE 16 /* stack trace length */
1103c7b4e6bSCatalin Marinas #define MSECS_MIN_AGE 5000 /* minimum object age for reporting */
1113c7b4e6bSCatalin Marinas #define SECS_FIRST_SCAN 60 /* delay before the first scan */
1123c7b4e6bSCatalin Marinas #define SECS_SCAN_WAIT 600 /* subsequent auto scanning delay */
113af98603dSCatalin Marinas #define MAX_SCAN_SIZE 4096 /* maximum size of a scanned block */
1143c7b4e6bSCatalin Marinas
1153c7b4e6bSCatalin Marinas #define BYTES_PER_POINTER sizeof(void *)
1163c7b4e6bSCatalin Marinas
1173c7b4e6bSCatalin Marinas /* scanning area inside a memory block */
1183c7b4e6bSCatalin Marinas struct kmemleak_scan_area {
1193c7b4e6bSCatalin Marinas struct hlist_node node;
120c017b4beSCatalin Marinas unsigned long start;
121c017b4beSCatalin Marinas size_t size;
1223c7b4e6bSCatalin Marinas };
1233c7b4e6bSCatalin Marinas
124a1084c87SLuis R. Rodriguez #define KMEMLEAK_GREY 0
125a1084c87SLuis R. Rodriguez #define KMEMLEAK_BLACK -1
126a1084c87SLuis R. Rodriguez
1273c7b4e6bSCatalin Marinas /*
1283c7b4e6bSCatalin Marinas * Structure holding the metadata for each allocated memory block.
1293c7b4e6bSCatalin Marinas * Modifications to such objects should be made while holding the
1303c7b4e6bSCatalin Marinas * object->lock. Insertions or deletions from object_list, gray_list or
13185d3a316SMichel Lespinasse * rb_node are already protected by the corresponding locks or mutex (see
1323c7b4e6bSCatalin Marinas * the notes on locking above). These objects are reference-counted
1333c7b4e6bSCatalin Marinas * (use_count) and freed using the RCU mechanism.
1343c7b4e6bSCatalin Marinas */
1353c7b4e6bSCatalin Marinas struct kmemleak_object {
1368c96f1bcSHe Zhe raw_spinlock_t lock;
137f66abf09SCatalin Marinas unsigned int flags; /* object status flags */
1383c7b4e6bSCatalin Marinas struct list_head object_list;
1393c7b4e6bSCatalin Marinas struct list_head gray_list;
14085d3a316SMichel Lespinasse struct rb_node rb_node;
1413c7b4e6bSCatalin Marinas struct rcu_head rcu; /* object_list lockless traversal */
1423c7b4e6bSCatalin Marinas /* object usage count; object freed when use_count == 0 */
1433c7b4e6bSCatalin Marinas atomic_t use_count;
144782e4179SWaiman Long unsigned int del_state; /* deletion state */
1453c7b4e6bSCatalin Marinas unsigned long pointer;
1463c7b4e6bSCatalin Marinas size_t size;
14794f4a161SCatalin Marinas /* pass surplus references to this pointer */
14894f4a161SCatalin Marinas unsigned long excess_ref;
1493c7b4e6bSCatalin Marinas /* minimum number of a pointers found before it is considered leak */
1503c7b4e6bSCatalin Marinas int min_count;
1513c7b4e6bSCatalin Marinas /* the total number of pointers found pointing to this object */
1523c7b4e6bSCatalin Marinas int count;
15304609cccSCatalin Marinas /* checksum for detecting modified objects */
15404609cccSCatalin Marinas u32 checksum;
155b04da042SWaiman Long depot_stack_handle_t trace_handle;
1563c7b4e6bSCatalin Marinas /* memory ranges to be scanned inside an object (empty for all) */
1573c7b4e6bSCatalin Marinas struct hlist_head area_list;
1583c7b4e6bSCatalin Marinas unsigned long jiffies; /* creation timestamp */
1593c7b4e6bSCatalin Marinas pid_t pid; /* pid of the current task */
1603c7b4e6bSCatalin Marinas char comm[TASK_COMM_LEN]; /* executable name */
1613c7b4e6bSCatalin Marinas };
1623c7b4e6bSCatalin Marinas
1633c7b4e6bSCatalin Marinas /* flag representing the memory block allocation status */
1643c7b4e6bSCatalin Marinas #define OBJECT_ALLOCATED (1 << 0)
1653c7b4e6bSCatalin Marinas /* flag set after the first reporting of an unreference object */
1663c7b4e6bSCatalin Marinas #define OBJECT_REPORTED (1 << 1)
1673c7b4e6bSCatalin Marinas /* flag set to not scan the object */
1683c7b4e6bSCatalin Marinas #define OBJECT_NO_SCAN (1 << 2)
169dba82d94SCatalin Marinas /* flag set to fully scan the object when scan_area allocation failed */
170dba82d94SCatalin Marinas #define OBJECT_FULL_SCAN (1 << 3)
1718e0c4ab3SPatrick Wang /* flag set for object allocated with physical address */
1728e0c4ab3SPatrick Wang #define OBJECT_PHYS (1 << 4)
17339042079SCatalin Marinas /* flag set for per-CPU pointers */
17439042079SCatalin Marinas #define OBJECT_PERCPU (1 << 5)
1753c7b4e6bSCatalin Marinas
176782e4179SWaiman Long /* set when __remove_object() called */
177782e4179SWaiman Long #define DELSTATE_REMOVED (1 << 0)
178782e4179SWaiman Long /* set to temporarily prevent deletion from object_list */
179782e4179SWaiman Long #define DELSTATE_NO_DELETE (1 << 1)
180782e4179SWaiman Long
181154221c3SVincent Whitchurch #define HEX_PREFIX " "
1820494e082SSergey Senozhatsky /* number of bytes to print per line; must be 16 or 32 */
1830494e082SSergey Senozhatsky #define HEX_ROW_SIZE 16
1840494e082SSergey Senozhatsky /* number of bytes to print at a time (1, 2, 4, 8) */
1850494e082SSergey Senozhatsky #define HEX_GROUP_SIZE 1
1860494e082SSergey Senozhatsky /* include ASCII after the hex output */
1870494e082SSergey Senozhatsky #define HEX_ASCII 1
1880494e082SSergey Senozhatsky /* max number of lines to be printed */
1890494e082SSergey Senozhatsky #define HEX_MAX_LINES 2
1900494e082SSergey Senozhatsky
1913c7b4e6bSCatalin Marinas /* the list of all allocated objects */
1923c7b4e6bSCatalin Marinas static LIST_HEAD(object_list);
1933c7b4e6bSCatalin Marinas /* the list of gray-colored objects (see color_gray comment below) */
1943c7b4e6bSCatalin Marinas static LIST_HEAD(gray_list);
1950647398aSCatalin Marinas /* memory pool allocation */
196c5665868SCatalin Marinas static struct kmemleak_object mem_pool[CONFIG_DEBUG_KMEMLEAK_MEM_POOL_SIZE];
1970647398aSCatalin Marinas static int mem_pool_free_count = ARRAY_SIZE(mem_pool);
1980647398aSCatalin Marinas static LIST_HEAD(mem_pool_free_list);
19985d3a316SMichel Lespinasse /* search tree for object boundaries */
20085d3a316SMichel Lespinasse static struct rb_root object_tree_root = RB_ROOT;
2010c24e061SPatrick Wang /* search tree for object (with OBJECT_PHYS flag) boundaries */
2020c24e061SPatrick Wang static struct rb_root object_phys_tree_root = RB_ROOT;
20339042079SCatalin Marinas /* search tree for object (with OBJECT_PERCPU flag) boundaries */
20439042079SCatalin Marinas static struct rb_root object_percpu_tree_root = RB_ROOT;
2050c24e061SPatrick Wang /* protecting the access to object_list, object_tree_root (or object_phys_tree_root) */
2068c96f1bcSHe Zhe static DEFINE_RAW_SPINLOCK(kmemleak_lock);
2073c7b4e6bSCatalin Marinas
2083c7b4e6bSCatalin Marinas /* allocation caches for kmemleak internal data */
2093c7b4e6bSCatalin Marinas static struct kmem_cache *object_cache;
2103c7b4e6bSCatalin Marinas static struct kmem_cache *scan_area_cache;
2113c7b4e6bSCatalin Marinas
2123c7b4e6bSCatalin Marinas /* set if tracing memory operations is enabled */
2130f428676SLuiz Capitulino static int kmemleak_enabled __read_mostly = 1;
214c5f3b1a5SCatalin Marinas /* same as above but only for the kmemleak_free() callback */
2150f428676SLuiz Capitulino static int kmemleak_free_enabled __read_mostly = 1;
2163c7b4e6bSCatalin Marinas /* set in the late_initcall if there were no errors */
217d160ef71SXiaolei Wang static int kmemleak_late_initialized;
2185f79020cSCatalin Marinas /* set if a fatal kmemleak error has occurred */
2198910ae89SLi Zefan static int kmemleak_error;
2203c7b4e6bSCatalin Marinas
2213c7b4e6bSCatalin Marinas /* minimum and maximum address that may be valid pointers */
2223c7b4e6bSCatalin Marinas static unsigned long min_addr = ULONG_MAX;
2233c7b4e6bSCatalin Marinas static unsigned long max_addr;
2243c7b4e6bSCatalin Marinas
2256c99d4ebSPavel Tikhomirov /* minimum and maximum address that may be valid per-CPU pointers */
2266c99d4ebSPavel Tikhomirov static unsigned long min_percpu_addr = ULONG_MAX;
2276c99d4ebSPavel Tikhomirov static unsigned long max_percpu_addr;
2286c99d4ebSPavel Tikhomirov
2293c7b4e6bSCatalin Marinas static struct task_struct *scan_thread;
230acf4968eSCatalin Marinas /* used to avoid reporting of recently allocated objects */
2313c7b4e6bSCatalin Marinas static unsigned long jiffies_min_age;
232acf4968eSCatalin Marinas static unsigned long jiffies_last_scan;
2333c7b4e6bSCatalin Marinas /* delay between automatic memory scannings */
23454dd200cSYanfei Xu static unsigned long jiffies_scan_wait;
2353c7b4e6bSCatalin Marinas /* enables or disables the task stacks scanning */
236e0a2a160SCatalin Marinas static int kmemleak_stack_scan = 1;
2374698c1f2SCatalin Marinas /* protects the memory scanning, parameters and debug/kmemleak file access */
2383c7b4e6bSCatalin Marinas static DEFINE_MUTEX(scan_mutex);
239ab0155a2SJason Baron /* setting kmemleak=on, will set this var, skipping the disable */
240ab0155a2SJason Baron static int kmemleak_skip_disable;
241dc9b3f42SLi Zefan /* If there are leaks that can be reported */
242dc9b3f42SLi Zefan static bool kmemleak_found_leaks;
2433c7b4e6bSCatalin Marinas
244*e9d973efSBreno Leitao static bool kmemleak_verbose = IS_ENABLED(CONFIG_DEBUG_KMEMLEAK_VERBOSE);
245154221c3SVincent Whitchurch module_param_named(verbose, kmemleak_verbose, bool, 0600);
246154221c3SVincent Whitchurch
2473c7b4e6bSCatalin Marinas static void kmemleak_disable(void);
2483c7b4e6bSCatalin Marinas
2493c7b4e6bSCatalin Marinas /*
2503c7b4e6bSCatalin Marinas * Print a warning and dump the stack trace.
2513c7b4e6bSCatalin Marinas */
2523c7b4e6bSCatalin Marinas #define kmemleak_warn(x...) do { \
253598d8091SJoe Perches pr_warn(x); \
2543c7b4e6bSCatalin Marinas dump_stack(); \
2553c7b4e6bSCatalin Marinas } while (0)
2563c7b4e6bSCatalin Marinas
2573c7b4e6bSCatalin Marinas /*
25825985edcSLucas De Marchi * Macro invoked when a serious kmemleak condition occurred and cannot be
2592030117dSCatalin Marinas * recovered from. Kmemleak will be disabled and further allocation/freeing
2603c7b4e6bSCatalin Marinas * tracing no longer available.
2613c7b4e6bSCatalin Marinas */
262000814f4SCatalin Marinas #define kmemleak_stop(x...) do { \
2633c7b4e6bSCatalin Marinas kmemleak_warn(x); \
2643c7b4e6bSCatalin Marinas kmemleak_disable(); \
2653c7b4e6bSCatalin Marinas } while (0)
2663c7b4e6bSCatalin Marinas
267154221c3SVincent Whitchurch #define warn_or_seq_printf(seq, fmt, ...) do { \
268154221c3SVincent Whitchurch if (seq) \
269154221c3SVincent Whitchurch seq_printf(seq, fmt, ##__VA_ARGS__); \
270154221c3SVincent Whitchurch else \
271154221c3SVincent Whitchurch pr_warn(fmt, ##__VA_ARGS__); \
272154221c3SVincent Whitchurch } while (0)
273154221c3SVincent Whitchurch
warn_or_seq_hex_dump(struct seq_file * seq,int prefix_type,int rowsize,int groupsize,const void * buf,size_t len,bool ascii)274154221c3SVincent Whitchurch static void warn_or_seq_hex_dump(struct seq_file *seq, int prefix_type,
275154221c3SVincent Whitchurch int rowsize, int groupsize, const void *buf,
276154221c3SVincent Whitchurch size_t len, bool ascii)
277154221c3SVincent Whitchurch {
278154221c3SVincent Whitchurch if (seq)
279154221c3SVincent Whitchurch seq_hex_dump(seq, HEX_PREFIX, prefix_type, rowsize, groupsize,
280154221c3SVincent Whitchurch buf, len, ascii);
281154221c3SVincent Whitchurch else
282154221c3SVincent Whitchurch print_hex_dump(KERN_WARNING, pr_fmt(HEX_PREFIX), prefix_type,
283154221c3SVincent Whitchurch rowsize, groupsize, buf, len, ascii);
284154221c3SVincent Whitchurch }
285154221c3SVincent Whitchurch
2863c7b4e6bSCatalin Marinas /*
2870494e082SSergey Senozhatsky * Printing of the objects hex dump to the seq file. The number of lines to be
2880494e082SSergey Senozhatsky * printed is limited to HEX_MAX_LINES to prevent seq file spamming. The
2890494e082SSergey Senozhatsky * actual number of printed bytes depends on HEX_ROW_SIZE. It must be called
2900494e082SSergey Senozhatsky * with the object->lock held.
2910494e082SSergey Senozhatsky */
hex_dump_object(struct seq_file * seq,struct kmemleak_object * object)2920494e082SSergey Senozhatsky static void hex_dump_object(struct seq_file *seq,
2930494e082SSergey Senozhatsky struct kmemleak_object *object)
2940494e082SSergey Senozhatsky {
2950494e082SSergey Senozhatsky const u8 *ptr = (const u8 *)object->pointer;
2966fc37c49SAndy Shevchenko size_t len;
2970494e082SSergey Senozhatsky
2986c99d4ebSPavel Tikhomirov if (WARN_ON_ONCE(object->flags & OBJECT_PHYS))
2990c24e061SPatrick Wang return;
3000c24e061SPatrick Wang
3016c99d4ebSPavel Tikhomirov if (object->flags & OBJECT_PERCPU)
3026c99d4ebSPavel Tikhomirov ptr = (const u8 *)this_cpu_ptr((void __percpu *)object->pointer);
3036c99d4ebSPavel Tikhomirov
3040494e082SSergey Senozhatsky /* limit the number of lines to HEX_MAX_LINES */
3056fc37c49SAndy Shevchenko len = min_t(size_t, object->size, HEX_MAX_LINES * HEX_ROW_SIZE);
3060494e082SSergey Senozhatsky
3076c99d4ebSPavel Tikhomirov if (object->flags & OBJECT_PERCPU)
3086c99d4ebSPavel Tikhomirov warn_or_seq_printf(seq, " hex dump (first %zu bytes on cpu %d):\n",
3096c99d4ebSPavel Tikhomirov len, raw_smp_processor_id());
3106c99d4ebSPavel Tikhomirov else
311154221c3SVincent Whitchurch warn_or_seq_printf(seq, " hex dump (first %zu bytes):\n", len);
3125c335fe0SDmitry Vyukov kasan_disable_current();
313154221c3SVincent Whitchurch warn_or_seq_hex_dump(seq, DUMP_PREFIX_NONE, HEX_ROW_SIZE,
3146c7a00b8SKuan-Ying Lee HEX_GROUP_SIZE, kasan_reset_tag((void *)ptr), len, HEX_ASCII);
3155c335fe0SDmitry Vyukov kasan_enable_current();
3160494e082SSergey Senozhatsky }
3170494e082SSergey Senozhatsky
3180494e082SSergey Senozhatsky /*
3193c7b4e6bSCatalin Marinas * Object colors, encoded with count and min_count:
3203c7b4e6bSCatalin Marinas * - white - orphan object, not enough references to it (count < min_count)
3213c7b4e6bSCatalin Marinas * - gray - not orphan, not marked as false positive (min_count == 0) or
3223c7b4e6bSCatalin Marinas * sufficient references to it (count >= min_count)
3233c7b4e6bSCatalin Marinas * - black - ignore, it doesn't contain references (e.g. text section)
3243c7b4e6bSCatalin Marinas * (min_count == -1). No function defined for this color.
3253c7b4e6bSCatalin Marinas */
color_white(const struct kmemleak_object * object)3264a558dd6SLuis R. Rodriguez static bool color_white(const struct kmemleak_object *object)
3273c7b4e6bSCatalin Marinas {
328a1084c87SLuis R. Rodriguez return object->count != KMEMLEAK_BLACK &&
329a1084c87SLuis R. Rodriguez object->count < object->min_count;
3303c7b4e6bSCatalin Marinas }
3313c7b4e6bSCatalin Marinas
color_gray(const struct kmemleak_object * object)3324a558dd6SLuis R. Rodriguez static bool color_gray(const struct kmemleak_object *object)
3333c7b4e6bSCatalin Marinas {
334a1084c87SLuis R. Rodriguez return object->min_count != KMEMLEAK_BLACK &&
335a1084c87SLuis R. Rodriguez object->count >= object->min_count;
3363c7b4e6bSCatalin Marinas }
3373c7b4e6bSCatalin Marinas
3383c7b4e6bSCatalin Marinas /*
3393c7b4e6bSCatalin Marinas * Objects are considered unreferenced only if their color is white, they have
3403c7b4e6bSCatalin Marinas * not be deleted and have a minimum age to avoid false positives caused by
3413c7b4e6bSCatalin Marinas * pointers temporarily stored in CPU registers.
3423c7b4e6bSCatalin Marinas */
unreferenced_object(struct kmemleak_object * object)3434a558dd6SLuis R. Rodriguez static bool unreferenced_object(struct kmemleak_object *object)
3443c7b4e6bSCatalin Marinas {
34504609cccSCatalin Marinas return (color_white(object) && object->flags & OBJECT_ALLOCATED) &&
346acf4968eSCatalin Marinas time_before_eq(object->jiffies + jiffies_min_age,
347acf4968eSCatalin Marinas jiffies_last_scan);
3483c7b4e6bSCatalin Marinas }
3493c7b4e6bSCatalin Marinas
__object_type_str(struct kmemleak_object * object)3507ddeb91fSCatalin Marinas static const char *__object_type_str(struct kmemleak_object *object)
3517ddeb91fSCatalin Marinas {
3527ddeb91fSCatalin Marinas if (object->flags & OBJECT_PHYS)
3537ddeb91fSCatalin Marinas return " (phys)";
3547ddeb91fSCatalin Marinas if (object->flags & OBJECT_PERCPU)
3557ddeb91fSCatalin Marinas return " (percpu)";
3567ddeb91fSCatalin Marinas return "";
3577ddeb91fSCatalin Marinas }
3587ddeb91fSCatalin Marinas
3593c7b4e6bSCatalin Marinas /*
360bab4a34aSCatalin Marinas * Printing of the unreferenced objects information to the seq file. The
361bab4a34aSCatalin Marinas * print_unreferenced function must be called with the object->lock held.
3623c7b4e6bSCatalin Marinas */
print_unreferenced(struct seq_file * seq,struct kmemleak_object * object)3633c7b4e6bSCatalin Marinas static void print_unreferenced(struct seq_file *seq,
3643c7b4e6bSCatalin Marinas struct kmemleak_object *object)
3653c7b4e6bSCatalin Marinas {
3663c7b4e6bSCatalin Marinas int i;
36756a61617SZhaoyang Huang unsigned long *entries;
36856a61617SZhaoyang Huang unsigned int nr_entries;
3693c7b4e6bSCatalin Marinas
37056a61617SZhaoyang Huang nr_entries = stack_depot_fetch(object->trace_handle, &entries);
3717ddeb91fSCatalin Marinas warn_or_seq_printf(seq, "unreferenced object%s 0x%08lx (size %zu):\n",
3727ddeb91fSCatalin Marinas __object_type_str(object),
3733c7b4e6bSCatalin Marinas object->pointer, object->size);
37488f9ee2bSJim Cromie warn_or_seq_printf(seq, " comm \"%s\", pid %d, jiffies %lu\n",
37588f9ee2bSJim Cromie object->comm, object->pid, object->jiffies);
3760494e082SSergey Senozhatsky hex_dump_object(seq, object);
37752c5d2bcSJim Cromie warn_or_seq_printf(seq, " backtrace (crc %x):\n", object->checksum);
3783c7b4e6bSCatalin Marinas
37956a61617SZhaoyang Huang for (i = 0; i < nr_entries; i++) {
38056a61617SZhaoyang Huang void *ptr = (void *)entries[i];
381cddc76b1SAlessandro Carminati warn_or_seq_printf(seq, " %pS\n", ptr);
3823c7b4e6bSCatalin Marinas }
3833c7b4e6bSCatalin Marinas }
3843c7b4e6bSCatalin Marinas
3853c7b4e6bSCatalin Marinas /*
3863c7b4e6bSCatalin Marinas * Print the kmemleak_object information. This function is used mainly for
3873c7b4e6bSCatalin Marinas * debugging special cases when kmemleak operations. It must be called with
3883c7b4e6bSCatalin Marinas * the object->lock held.
3893c7b4e6bSCatalin Marinas */
dump_object_info(struct kmemleak_object * object)3903c7b4e6bSCatalin Marinas static void dump_object_info(struct kmemleak_object *object)
3913c7b4e6bSCatalin Marinas {
3927ddeb91fSCatalin Marinas pr_notice("Object%s 0x%08lx (size %zu):\n",
3937ddeb91fSCatalin Marinas __object_type_str(object), object->pointer, object->size);
3943c7b4e6bSCatalin Marinas pr_notice(" comm \"%s\", pid %d, jiffies %lu\n",
3953c7b4e6bSCatalin Marinas object->comm, object->pid, object->jiffies);
3963c7b4e6bSCatalin Marinas pr_notice(" min_count = %d\n", object->min_count);
3973c7b4e6bSCatalin Marinas pr_notice(" count = %d\n", object->count);
398f66abf09SCatalin Marinas pr_notice(" flags = 0x%x\n", object->flags);
399aae0ad7aSJianpeng Ma pr_notice(" checksum = %u\n", object->checksum);
4003c7b4e6bSCatalin Marinas pr_notice(" backtrace:\n");
40156a61617SZhaoyang Huang if (object->trace_handle)
40256a61617SZhaoyang Huang stack_depot_print(object->trace_handle);
4033c7b4e6bSCatalin Marinas }
4043c7b4e6bSCatalin Marinas
object_tree(unsigned long objflags)40539042079SCatalin Marinas static struct rb_root *object_tree(unsigned long objflags)
40639042079SCatalin Marinas {
40739042079SCatalin Marinas if (objflags & OBJECT_PHYS)
40839042079SCatalin Marinas return &object_phys_tree_root;
40939042079SCatalin Marinas if (objflags & OBJECT_PERCPU)
41039042079SCatalin Marinas return &object_percpu_tree_root;
41139042079SCatalin Marinas return &object_tree_root;
41239042079SCatalin Marinas }
41339042079SCatalin Marinas
4143c7b4e6bSCatalin Marinas /*
41585d3a316SMichel Lespinasse * Look-up a memory block metadata (kmemleak_object) in the object search
4163c7b4e6bSCatalin Marinas * tree based on a pointer value. If alias is 0, only values pointing to the
4173c7b4e6bSCatalin Marinas * beginning of the memory block are allowed. The kmemleak_lock must be held
4183c7b4e6bSCatalin Marinas * when calling this function.
4193c7b4e6bSCatalin Marinas */
__lookup_object(unsigned long ptr,int alias,unsigned int objflags)4200c24e061SPatrick Wang static struct kmemleak_object *__lookup_object(unsigned long ptr, int alias,
42139042079SCatalin Marinas unsigned int objflags)
4223c7b4e6bSCatalin Marinas {
42339042079SCatalin Marinas struct rb_node *rb = object_tree(objflags)->rb_node;
424ad1a3e15SKuan-Ying Lee unsigned long untagged_ptr = (unsigned long)kasan_reset_tag((void *)ptr);
4253c7b4e6bSCatalin Marinas
42685d3a316SMichel Lespinasse while (rb) {
427ad1a3e15SKuan-Ying Lee struct kmemleak_object *object;
428ad1a3e15SKuan-Ying Lee unsigned long untagged_objp;
429ad1a3e15SKuan-Ying Lee
430ad1a3e15SKuan-Ying Lee object = rb_entry(rb, struct kmemleak_object, rb_node);
431ad1a3e15SKuan-Ying Lee untagged_objp = (unsigned long)kasan_reset_tag((void *)object->pointer);
432ad1a3e15SKuan-Ying Lee
433ad1a3e15SKuan-Ying Lee if (untagged_ptr < untagged_objp)
43485d3a316SMichel Lespinasse rb = object->rb_node.rb_left;
435ad1a3e15SKuan-Ying Lee else if (untagged_objp + object->size <= untagged_ptr)
43685d3a316SMichel Lespinasse rb = object->rb_node.rb_right;
437ad1a3e15SKuan-Ying Lee else if (untagged_objp == untagged_ptr || alias)
43885d3a316SMichel Lespinasse return object;
43985d3a316SMichel Lespinasse else {
440c873ccbbSGu Bowen /*
441c873ccbbSGu Bowen * Printk deferring due to the kmemleak_lock held.
442c873ccbbSGu Bowen * This is done to avoid deadlock.
443c873ccbbSGu Bowen */
444c873ccbbSGu Bowen printk_deferred_enter();
4455f79020cSCatalin Marinas kmemleak_warn("Found object by alias at 0x%08lx\n",
4465f79020cSCatalin Marinas ptr);
447a7686a45SCatalin Marinas dump_object_info(object);
448c873ccbbSGu Bowen printk_deferred_exit();
44985d3a316SMichel Lespinasse break;
4503c7b4e6bSCatalin Marinas }
45185d3a316SMichel Lespinasse }
45285d3a316SMichel Lespinasse return NULL;
4533c7b4e6bSCatalin Marinas }
4543c7b4e6bSCatalin Marinas
4550c24e061SPatrick Wang /* Look-up a kmemleak object which allocated with virtual address. */
lookup_object(unsigned long ptr,int alias)4560c24e061SPatrick Wang static struct kmemleak_object *lookup_object(unsigned long ptr, int alias)
4570c24e061SPatrick Wang {
45839042079SCatalin Marinas return __lookup_object(ptr, alias, 0);
4590c24e061SPatrick Wang }
4600c24e061SPatrick Wang
4613c7b4e6bSCatalin Marinas /*
4623c7b4e6bSCatalin Marinas * Increment the object use_count. Return 1 if successful or 0 otherwise. Note
4633c7b4e6bSCatalin Marinas * that once an object's use_count reached 0, the RCU freeing was already
4643c7b4e6bSCatalin Marinas * registered and the object should no longer be used. This function must be
4653c7b4e6bSCatalin Marinas * called under the protection of rcu_read_lock().
4663c7b4e6bSCatalin Marinas */
get_object(struct kmemleak_object * object)4673c7b4e6bSCatalin Marinas static int get_object(struct kmemleak_object *object)
4683c7b4e6bSCatalin Marinas {
4693c7b4e6bSCatalin Marinas return atomic_inc_not_zero(&object->use_count);
4703c7b4e6bSCatalin Marinas }
4713c7b4e6bSCatalin Marinas
4723c7b4e6bSCatalin Marinas /*
4730647398aSCatalin Marinas * Memory pool allocation and freeing. kmemleak_lock must not be held.
4740647398aSCatalin Marinas */
mem_pool_alloc(gfp_t gfp)4750647398aSCatalin Marinas static struct kmemleak_object *mem_pool_alloc(gfp_t gfp)
4760647398aSCatalin Marinas {
4770647398aSCatalin Marinas unsigned long flags;
4780647398aSCatalin Marinas struct kmemleak_object *object;
47947b0f6d8SBreno Leitao bool warn = false;
4800647398aSCatalin Marinas
4810647398aSCatalin Marinas /* try the slab allocator first */
482c5665868SCatalin Marinas if (object_cache) {
4831c00f936SDave Chinner object = kmem_cache_alloc_noprof(object_cache,
4841c00f936SDave Chinner gfp_nested_mask(gfp));
4850647398aSCatalin Marinas if (object)
4860647398aSCatalin Marinas return object;
487c5665868SCatalin Marinas }
4880647398aSCatalin Marinas
4890647398aSCatalin Marinas /* slab allocation failed, try the memory pool */
4908c96f1bcSHe Zhe raw_spin_lock_irqsave(&kmemleak_lock, flags);
4910647398aSCatalin Marinas object = list_first_entry_or_null(&mem_pool_free_list,
4920647398aSCatalin Marinas typeof(*object), object_list);
4930647398aSCatalin Marinas if (object)
4940647398aSCatalin Marinas list_del(&object->object_list);
4950647398aSCatalin Marinas else if (mem_pool_free_count)
4960647398aSCatalin Marinas object = &mem_pool[--mem_pool_free_count];
497c5665868SCatalin Marinas else
49847b0f6d8SBreno Leitao warn = true;
4998c96f1bcSHe Zhe raw_spin_unlock_irqrestore(&kmemleak_lock, flags);
50047b0f6d8SBreno Leitao if (warn)
50147b0f6d8SBreno Leitao pr_warn_once("Memory pool empty, consider increasing CONFIG_DEBUG_KMEMLEAK_MEM_POOL_SIZE\n");
5020647398aSCatalin Marinas
5030647398aSCatalin Marinas return object;
5040647398aSCatalin Marinas }
5050647398aSCatalin Marinas
5060647398aSCatalin Marinas /*
5070647398aSCatalin Marinas * Return the object to either the slab allocator or the memory pool.
5080647398aSCatalin Marinas */
mem_pool_free(struct kmemleak_object * object)5090647398aSCatalin Marinas static void mem_pool_free(struct kmemleak_object *object)
5100647398aSCatalin Marinas {
5110647398aSCatalin Marinas unsigned long flags;
5120647398aSCatalin Marinas
51361e9210eSAlejandro Colomar if (object < mem_pool || object >= ARRAY_END(mem_pool)) {
5140647398aSCatalin Marinas kmem_cache_free(object_cache, object);
5150647398aSCatalin Marinas return;
5160647398aSCatalin Marinas }
5170647398aSCatalin Marinas
5180647398aSCatalin Marinas /* add the object to the memory pool free list */
5198c96f1bcSHe Zhe raw_spin_lock_irqsave(&kmemleak_lock, flags);
5200647398aSCatalin Marinas list_add(&object->object_list, &mem_pool_free_list);
5218c96f1bcSHe Zhe raw_spin_unlock_irqrestore(&kmemleak_lock, flags);
5220647398aSCatalin Marinas }
5230647398aSCatalin Marinas
5240647398aSCatalin Marinas /*
5253c7b4e6bSCatalin Marinas * RCU callback to free a kmemleak_object.
5263c7b4e6bSCatalin Marinas */
free_object_rcu(struct rcu_head * rcu)5273c7b4e6bSCatalin Marinas static void free_object_rcu(struct rcu_head *rcu)
5283c7b4e6bSCatalin Marinas {
529b67bfe0dSSasha Levin struct hlist_node *tmp;
5303c7b4e6bSCatalin Marinas struct kmemleak_scan_area *area;
5313c7b4e6bSCatalin Marinas struct kmemleak_object *object =
5323c7b4e6bSCatalin Marinas container_of(rcu, struct kmemleak_object, rcu);
5333c7b4e6bSCatalin Marinas
5343c7b4e6bSCatalin Marinas /*
5353c7b4e6bSCatalin Marinas * Once use_count is 0 (guaranteed by put_object), there is no other
5363c7b4e6bSCatalin Marinas * code accessing this object, hence no need for locking.
5373c7b4e6bSCatalin Marinas */
538b67bfe0dSSasha Levin hlist_for_each_entry_safe(area, tmp, &object->area_list, node) {
539b67bfe0dSSasha Levin hlist_del(&area->node);
5403c7b4e6bSCatalin Marinas kmem_cache_free(scan_area_cache, area);
5413c7b4e6bSCatalin Marinas }
5420647398aSCatalin Marinas mem_pool_free(object);
5433c7b4e6bSCatalin Marinas }
5443c7b4e6bSCatalin Marinas
5453c7b4e6bSCatalin Marinas /*
5463c7b4e6bSCatalin Marinas * Decrement the object use_count. Once the count is 0, free the object using
5473c7b4e6bSCatalin Marinas * an RCU callback. Since put_object() may be called via the kmemleak_free() ->
5483c7b4e6bSCatalin Marinas * delete_object() path, the delayed RCU freeing ensures that there is no
5493c7b4e6bSCatalin Marinas * recursive call to the kernel allocator. Lock-less RCU object_list traversal
5503c7b4e6bSCatalin Marinas * is also possible.
5513c7b4e6bSCatalin Marinas */
put_object(struct kmemleak_object * object)5523c7b4e6bSCatalin Marinas static void put_object(struct kmemleak_object *object)
5533c7b4e6bSCatalin Marinas {
5543c7b4e6bSCatalin Marinas if (!atomic_dec_and_test(&object->use_count))
5553c7b4e6bSCatalin Marinas return;
5563c7b4e6bSCatalin Marinas
5573c7b4e6bSCatalin Marinas /* should only get here after delete_object was called */
5583c7b4e6bSCatalin Marinas WARN_ON(object->flags & OBJECT_ALLOCATED);
5593c7b4e6bSCatalin Marinas
560c5665868SCatalin Marinas /*
561c5665868SCatalin Marinas * It may be too early for the RCU callbacks, however, there is no
562c5665868SCatalin Marinas * concurrent object_list traversal when !object_cache and all objects
563c5665868SCatalin Marinas * came from the memory pool. Free the object directly.
564c5665868SCatalin Marinas */
565c5665868SCatalin Marinas if (object_cache)
5663c7b4e6bSCatalin Marinas call_rcu(&object->rcu, free_object_rcu);
567c5665868SCatalin Marinas else
568c5665868SCatalin Marinas free_object_rcu(&object->rcu);
5693c7b4e6bSCatalin Marinas }
5703c7b4e6bSCatalin Marinas
5713c7b4e6bSCatalin Marinas /*
57285d3a316SMichel Lespinasse * Look up an object in the object search tree and increase its use_count.
5733c7b4e6bSCatalin Marinas */
__find_and_get_object(unsigned long ptr,int alias,unsigned int objflags)5740c24e061SPatrick Wang static struct kmemleak_object *__find_and_get_object(unsigned long ptr, int alias,
57539042079SCatalin Marinas unsigned int objflags)
5763c7b4e6bSCatalin Marinas {
5773c7b4e6bSCatalin Marinas unsigned long flags;
5789fbed254SAlexey Klimov struct kmemleak_object *object;
5793c7b4e6bSCatalin Marinas
5803c7b4e6bSCatalin Marinas rcu_read_lock();
5818c96f1bcSHe Zhe raw_spin_lock_irqsave(&kmemleak_lock, flags);
58239042079SCatalin Marinas object = __lookup_object(ptr, alias, objflags);
5838c96f1bcSHe Zhe raw_spin_unlock_irqrestore(&kmemleak_lock, flags);
5843c7b4e6bSCatalin Marinas
5853c7b4e6bSCatalin Marinas /* check whether the object is still available */
5863c7b4e6bSCatalin Marinas if (object && !get_object(object))
5873c7b4e6bSCatalin Marinas object = NULL;
5883c7b4e6bSCatalin Marinas rcu_read_unlock();
5893c7b4e6bSCatalin Marinas
5903c7b4e6bSCatalin Marinas return object;
5913c7b4e6bSCatalin Marinas }
5923c7b4e6bSCatalin Marinas
5930c24e061SPatrick Wang /* Look up and get an object which allocated with virtual address. */
find_and_get_object(unsigned long ptr,int alias)5940c24e061SPatrick Wang static struct kmemleak_object *find_and_get_object(unsigned long ptr, int alias)
5950c24e061SPatrick Wang {
59639042079SCatalin Marinas return __find_and_get_object(ptr, alias, 0);
5970c24e061SPatrick Wang }
5980c24e061SPatrick Wang
5993c7b4e6bSCatalin Marinas /*
60039042079SCatalin Marinas * Remove an object from its object tree and object_list. Must be called with
60139042079SCatalin Marinas * the kmemleak_lock held _if_ kmemleak is still enabled.
6022abd839aSCatalin Marinas */
__remove_object(struct kmemleak_object * object)6032abd839aSCatalin Marinas static void __remove_object(struct kmemleak_object *object)
6042abd839aSCatalin Marinas {
60539042079SCatalin Marinas rb_erase(&object->rb_node, object_tree(object->flags));
606782e4179SWaiman Long if (!(object->del_state & DELSTATE_NO_DELETE))
6072abd839aSCatalin Marinas list_del_rcu(&object->object_list);
608782e4179SWaiman Long object->del_state |= DELSTATE_REMOVED;
6092abd839aSCatalin Marinas }
6102abd839aSCatalin Marinas
__find_and_remove_object(unsigned long ptr,int alias,unsigned int objflags)611858a195bSLiu Shixin static struct kmemleak_object *__find_and_remove_object(unsigned long ptr,
612858a195bSLiu Shixin int alias,
61339042079SCatalin Marinas unsigned int objflags)
614858a195bSLiu Shixin {
615858a195bSLiu Shixin struct kmemleak_object *object;
616858a195bSLiu Shixin
61739042079SCatalin Marinas object = __lookup_object(ptr, alias, objflags);
618858a195bSLiu Shixin if (object)
619858a195bSLiu Shixin __remove_object(object);
620858a195bSLiu Shixin
621858a195bSLiu Shixin return object;
622858a195bSLiu Shixin }
623858a195bSLiu Shixin
6242abd839aSCatalin Marinas /*
62539042079SCatalin Marinas * Look up an object in the object search tree and remove it from both object
62639042079SCatalin Marinas * tree root and object_list. The returned object's use_count should be at
62739042079SCatalin Marinas * least 1, as initially set by create_object().
628e781a9abSCatalin Marinas */
find_and_remove_object(unsigned long ptr,int alias,unsigned int objflags)6290c24e061SPatrick Wang static struct kmemleak_object *find_and_remove_object(unsigned long ptr, int alias,
63039042079SCatalin Marinas unsigned int objflags)
631e781a9abSCatalin Marinas {
632e781a9abSCatalin Marinas unsigned long flags;
633e781a9abSCatalin Marinas struct kmemleak_object *object;
634e781a9abSCatalin Marinas
6358c96f1bcSHe Zhe raw_spin_lock_irqsave(&kmemleak_lock, flags);
63639042079SCatalin Marinas object = __find_and_remove_object(ptr, alias, objflags);
6378c96f1bcSHe Zhe raw_spin_unlock_irqrestore(&kmemleak_lock, flags);
638e781a9abSCatalin Marinas
639e781a9abSCatalin Marinas return object;
640e781a9abSCatalin Marinas }
641e781a9abSCatalin Marinas
set_track_prepare(void)64256a61617SZhaoyang Huang static noinline depot_stack_handle_t set_track_prepare(void)
643fd678967SCatalin Marinas {
64456a61617SZhaoyang Huang depot_stack_handle_t trace_handle;
64556a61617SZhaoyang Huang unsigned long entries[MAX_TRACE];
64656a61617SZhaoyang Huang unsigned int nr_entries;
64756a61617SZhaoyang Huang
648835bc157SXiaolei Wang /*
649835bc157SXiaolei Wang * Use object_cache to determine whether kmemleak_init() has
650835bc157SXiaolei Wang * been invoked. stack_depot_early_init() is called before
651835bc157SXiaolei Wang * kmemleak_init() in mm_core_init().
652835bc157SXiaolei Wang */
653835bc157SXiaolei Wang if (!object_cache)
65456a61617SZhaoyang Huang return 0;
65556a61617SZhaoyang Huang nr_entries = stack_trace_save(entries, ARRAY_SIZE(entries), 3);
65656a61617SZhaoyang Huang trace_handle = stack_depot_save(entries, nr_entries, GFP_NOWAIT);
65756a61617SZhaoyang Huang
65856a61617SZhaoyang Huang return trace_handle;
659fd678967SCatalin Marinas }
660fd678967SCatalin Marinas
__alloc_object(gfp_t gfp)6610edd7b58SLiu Shixin static struct kmemleak_object *__alloc_object(gfp_t gfp)
6623c7b4e6bSCatalin Marinas {
6630edd7b58SLiu Shixin struct kmemleak_object *object;
6643c7b4e6bSCatalin Marinas
6650647398aSCatalin Marinas object = mem_pool_alloc(gfp);
6663c7b4e6bSCatalin Marinas if (!object) {
667598d8091SJoe Perches pr_warn("Cannot allocate a kmemleak_object structure\n");
6686ae4bd1fSCatalin Marinas kmemleak_disable();
6694eff7d62SLiu Shixin return NULL;
6703c7b4e6bSCatalin Marinas }
6713c7b4e6bSCatalin Marinas
6723c7b4e6bSCatalin Marinas INIT_LIST_HEAD(&object->object_list);
6733c7b4e6bSCatalin Marinas INIT_LIST_HEAD(&object->gray_list);
6743c7b4e6bSCatalin Marinas INIT_HLIST_HEAD(&object->area_list);
6758c96f1bcSHe Zhe raw_spin_lock_init(&object->lock);
6763c7b4e6bSCatalin Marinas atomic_set(&object->use_count, 1);
67794f4a161SCatalin Marinas object->excess_ref = 0;
67804609cccSCatalin Marinas object->count = 0; /* white color initially */
67904609cccSCatalin Marinas object->checksum = 0;
680782e4179SWaiman Long object->del_state = 0;
6813c7b4e6bSCatalin Marinas
6823c7b4e6bSCatalin Marinas /* task information */
683ea0eafeaSChangbin Du if (in_hardirq()) {
6843c7b4e6bSCatalin Marinas object->pid = 0;
6850b847801SKees Cook strscpy(object->comm, "hardirq");
6866ef90569SDmitry Vyukov } else if (in_serving_softirq()) {
6873c7b4e6bSCatalin Marinas object->pid = 0;
6880b847801SKees Cook strscpy(object->comm, "softirq");
6893c7b4e6bSCatalin Marinas } else {
6903c7b4e6bSCatalin Marinas object->pid = current->pid;
6913c7b4e6bSCatalin Marinas /*
6923c7b4e6bSCatalin Marinas * There is a small chance of a race with set_task_comm(),
6933c7b4e6bSCatalin Marinas * however using get_task_comm() here may cause locking
6943c7b4e6bSCatalin Marinas * dependency issues with current->alloc_lock. In the worst
6953c7b4e6bSCatalin Marinas * case, the command line is not correct.
6963c7b4e6bSCatalin Marinas */
6970b847801SKees Cook strscpy(object->comm, current->comm);
6983c7b4e6bSCatalin Marinas }
6993c7b4e6bSCatalin Marinas
7003c7b4e6bSCatalin Marinas /* kernel backtrace */
70156a61617SZhaoyang Huang object->trace_handle = set_track_prepare();
7023c7b4e6bSCatalin Marinas
7034eff7d62SLiu Shixin return object;
7044eff7d62SLiu Shixin }
7054eff7d62SLiu Shixin
__link_object(struct kmemleak_object * object,unsigned long ptr,size_t size,int min_count,unsigned int objflags)7064eff7d62SLiu Shixin static int __link_object(struct kmemleak_object *object, unsigned long ptr,
70739042079SCatalin Marinas size_t size, int min_count, unsigned int objflags)
7084eff7d62SLiu Shixin {
7094eff7d62SLiu Shixin
7104eff7d62SLiu Shixin struct kmemleak_object *parent;
7114eff7d62SLiu Shixin struct rb_node **link, *rb_parent;
7124eff7d62SLiu Shixin unsigned long untagged_ptr;
7134eff7d62SLiu Shixin unsigned long untagged_objp;
7144eff7d62SLiu Shixin
71539042079SCatalin Marinas object->flags = OBJECT_ALLOCATED | objflags;
7164eff7d62SLiu Shixin object->pointer = ptr;
7174eff7d62SLiu Shixin object->size = kfence_ksize((void *)ptr) ?: size;
7184eff7d62SLiu Shixin object->min_count = min_count;
7194eff7d62SLiu Shixin object->jiffies = jiffies;
7204eff7d62SLiu Shixin
721a2f77575SAndrey Konovalov untagged_ptr = (unsigned long)kasan_reset_tag((void *)ptr);
7220c24e061SPatrick Wang /*
7236c99d4ebSPavel Tikhomirov * Only update min_addr and max_addr with object storing virtual
7246c99d4ebSPavel Tikhomirov * address. And update min_percpu_addr max_percpu_addr for per-CPU
7256c99d4ebSPavel Tikhomirov * objects.
7260c24e061SPatrick Wang */
7276c99d4ebSPavel Tikhomirov if (objflags & OBJECT_PERCPU) {
7286c99d4ebSPavel Tikhomirov min_percpu_addr = min(min_percpu_addr, untagged_ptr);
7296c99d4ebSPavel Tikhomirov max_percpu_addr = max(max_percpu_addr, untagged_ptr + size);
7306c99d4ebSPavel Tikhomirov } else if (!(objflags & OBJECT_PHYS)) {
731a2f77575SAndrey Konovalov min_addr = min(min_addr, untagged_ptr);
732a2f77575SAndrey Konovalov max_addr = max(max_addr, untagged_ptr + size);
7330c24e061SPatrick Wang }
73439042079SCatalin Marinas link = &object_tree(objflags)->rb_node;
73585d3a316SMichel Lespinasse rb_parent = NULL;
73685d3a316SMichel Lespinasse while (*link) {
73785d3a316SMichel Lespinasse rb_parent = *link;
73885d3a316SMichel Lespinasse parent = rb_entry(rb_parent, struct kmemleak_object, rb_node);
739ad1a3e15SKuan-Ying Lee untagged_objp = (unsigned long)kasan_reset_tag((void *)parent->pointer);
740ad1a3e15SKuan-Ying Lee if (untagged_ptr + size <= untagged_objp)
74185d3a316SMichel Lespinasse link = &parent->rb_node.rb_left;
742ad1a3e15SKuan-Ying Lee else if (untagged_objp + parent->size <= untagged_ptr)
74385d3a316SMichel Lespinasse link = &parent->rb_node.rb_right;
74485d3a316SMichel Lespinasse else {
745c873ccbbSGu Bowen /*
746c873ccbbSGu Bowen * Printk deferring due to the kmemleak_lock held.
747c873ccbbSGu Bowen * This is done to avoid deadlock.
748c873ccbbSGu Bowen */
749c873ccbbSGu Bowen printk_deferred_enter();
750756a025fSJoe Perches kmemleak_stop("Cannot insert 0x%lx into the object search tree (overlaps existing)\n",
75185d3a316SMichel Lespinasse ptr);
7529d5a4c73SCatalin Marinas /*
7539d5a4c73SCatalin Marinas * No need for parent->lock here since "parent" cannot
7549d5a4c73SCatalin Marinas * be freed while the kmemleak_lock is held.
7559d5a4c73SCatalin Marinas */
7569d5a4c73SCatalin Marinas dump_object_info(parent);
757c873ccbbSGu Bowen printk_deferred_exit();
7582e1d4738SLiu Shixin return -EEXIST;
7593c7b4e6bSCatalin Marinas }
76085d3a316SMichel Lespinasse }
76185d3a316SMichel Lespinasse rb_link_node(&object->rb_node, rb_parent, link);
76239042079SCatalin Marinas rb_insert_color(&object->rb_node, object_tree(objflags));
7633c7b4e6bSCatalin Marinas list_add_tail_rcu(&object->object_list, &object_list);
7642e1d4738SLiu Shixin
7652e1d4738SLiu Shixin return 0;
7660edd7b58SLiu Shixin }
7670edd7b58SLiu Shixin
7680edd7b58SLiu Shixin /*
7690edd7b58SLiu Shixin * Create the metadata (struct kmemleak_object) corresponding to an allocated
77039042079SCatalin Marinas * memory block and add it to the object_list and object tree.
7710edd7b58SLiu Shixin */
__create_object(unsigned long ptr,size_t size,int min_count,gfp_t gfp,unsigned int objflags)7720edd7b58SLiu Shixin static void __create_object(unsigned long ptr, size_t size,
77339042079SCatalin Marinas int min_count, gfp_t gfp, unsigned int objflags)
7740edd7b58SLiu Shixin {
7750edd7b58SLiu Shixin struct kmemleak_object *object;
7760edd7b58SLiu Shixin unsigned long flags;
7772e1d4738SLiu Shixin int ret;
7780edd7b58SLiu Shixin
7790edd7b58SLiu Shixin object = __alloc_object(gfp);
7800edd7b58SLiu Shixin if (!object)
7810edd7b58SLiu Shixin return;
7820edd7b58SLiu Shixin
7830edd7b58SLiu Shixin raw_spin_lock_irqsave(&kmemleak_lock, flags);
78439042079SCatalin Marinas ret = __link_object(object, ptr, size, min_count, objflags);
7858c96f1bcSHe Zhe raw_spin_unlock_irqrestore(&kmemleak_lock, flags);
7862e1d4738SLiu Shixin if (ret)
7872e1d4738SLiu Shixin mem_pool_free(object);
7883c7b4e6bSCatalin Marinas }
7893c7b4e6bSCatalin Marinas
7908e0c4ab3SPatrick Wang /* Create kmemleak object which allocated with virtual address. */
create_object(unsigned long ptr,size_t size,int min_count,gfp_t gfp)791b955aa70SLiu Shixin static void create_object(unsigned long ptr, size_t size,
7928e0c4ab3SPatrick Wang int min_count, gfp_t gfp)
7938e0c4ab3SPatrick Wang {
79439042079SCatalin Marinas __create_object(ptr, size, min_count, gfp, 0);
7958e0c4ab3SPatrick Wang }
7968e0c4ab3SPatrick Wang
7978e0c4ab3SPatrick Wang /* Create kmemleak object which allocated with physical address. */
create_object_phys(unsigned long ptr,size_t size,int min_count,gfp_t gfp)798b955aa70SLiu Shixin static void create_object_phys(unsigned long ptr, size_t size,
7998e0c4ab3SPatrick Wang int min_count, gfp_t gfp)
8008e0c4ab3SPatrick Wang {
80139042079SCatalin Marinas __create_object(ptr, size, min_count, gfp, OBJECT_PHYS);
80239042079SCatalin Marinas }
80339042079SCatalin Marinas
80439042079SCatalin Marinas /* Create kmemleak object corresponding to a per-CPU allocation. */
create_object_percpu(unsigned long ptr,size_t size,int min_count,gfp_t gfp)80539042079SCatalin Marinas static void create_object_percpu(unsigned long ptr, size_t size,
80639042079SCatalin Marinas int min_count, gfp_t gfp)
80739042079SCatalin Marinas {
80839042079SCatalin Marinas __create_object(ptr, size, min_count, gfp, OBJECT_PERCPU);
8098e0c4ab3SPatrick Wang }
8108e0c4ab3SPatrick Wang
8113c7b4e6bSCatalin Marinas /*
812e781a9abSCatalin Marinas * Mark the object as not allocated and schedule RCU freeing via put_object().
8133c7b4e6bSCatalin Marinas */
__delete_object(struct kmemleak_object * object)81453238a60SCatalin Marinas static void __delete_object(struct kmemleak_object *object)
8153c7b4e6bSCatalin Marinas {
8163c7b4e6bSCatalin Marinas unsigned long flags;
8173c7b4e6bSCatalin Marinas
8183c7b4e6bSCatalin Marinas WARN_ON(!(object->flags & OBJECT_ALLOCATED));
819e781a9abSCatalin Marinas WARN_ON(atomic_read(&object->use_count) < 1);
8203c7b4e6bSCatalin Marinas
8213c7b4e6bSCatalin Marinas /*
8223c7b4e6bSCatalin Marinas * Locking here also ensures that the corresponding memory block
8233c7b4e6bSCatalin Marinas * cannot be freed when it is being scanned.
8243c7b4e6bSCatalin Marinas */
8258c96f1bcSHe Zhe raw_spin_lock_irqsave(&object->lock, flags);
8263c7b4e6bSCatalin Marinas object->flags &= ~OBJECT_ALLOCATED;
8278c96f1bcSHe Zhe raw_spin_unlock_irqrestore(&object->lock, flags);
8283c7b4e6bSCatalin Marinas put_object(object);
8293c7b4e6bSCatalin Marinas }
8303c7b4e6bSCatalin Marinas
8313c7b4e6bSCatalin Marinas /*
83253238a60SCatalin Marinas * Look up the metadata (struct kmemleak_object) corresponding to ptr and
83353238a60SCatalin Marinas * delete it.
83453238a60SCatalin Marinas */
delete_object_full(unsigned long ptr,unsigned int objflags)83539042079SCatalin Marinas static void delete_object_full(unsigned long ptr, unsigned int objflags)
83653238a60SCatalin Marinas {
83753238a60SCatalin Marinas struct kmemleak_object *object;
83853238a60SCatalin Marinas
83939042079SCatalin Marinas object = find_and_remove_object(ptr, 0, objflags);
840c4d6d782SHarry Yoo if (!object)
841c4d6d782SHarry Yoo /*
842c4d6d782SHarry Yoo * kmalloc_nolock() -> kfree() calls kmemleak_free()
843c4d6d782SHarry Yoo * without kmemleak_alloc().
844c4d6d782SHarry Yoo */
84553238a60SCatalin Marinas return;
84653238a60SCatalin Marinas __delete_object(object);
84753238a60SCatalin Marinas }
84853238a60SCatalin Marinas
84953238a60SCatalin Marinas /*
85053238a60SCatalin Marinas * Look up the metadata (struct kmemleak_object) corresponding to ptr and
85153238a60SCatalin Marinas * delete it. If the memory block is partially freed, the function may create
85253238a60SCatalin Marinas * additional metadata for the remaining parts of the block.
85353238a60SCatalin Marinas */
delete_object_part(unsigned long ptr,size_t size,unsigned int objflags)85439042079SCatalin Marinas static void delete_object_part(unsigned long ptr, size_t size,
85539042079SCatalin Marinas unsigned int objflags)
85653238a60SCatalin Marinas {
8575e4fc577SLiu Shixin struct kmemleak_object *object, *object_l, *object_r;
8585e4fc577SLiu Shixin unsigned long start, end, flags;
85953238a60SCatalin Marinas
8605e4fc577SLiu Shixin object_l = __alloc_object(GFP_KERNEL);
8615e4fc577SLiu Shixin if (!object_l)
8625e4fc577SLiu Shixin return;
8635e4fc577SLiu Shixin
8645e4fc577SLiu Shixin object_r = __alloc_object(GFP_KERNEL);
8655e4fc577SLiu Shixin if (!object_r)
8665e4fc577SLiu Shixin goto out;
8675e4fc577SLiu Shixin
8685e4fc577SLiu Shixin raw_spin_lock_irqsave(&kmemleak_lock, flags);
86939042079SCatalin Marinas object = __find_and_remove_object(ptr, 1, objflags);
870c873ccbbSGu Bowen if (!object)
8715e4fc577SLiu Shixin goto unlock;
87253238a60SCatalin Marinas
87353238a60SCatalin Marinas /*
87453238a60SCatalin Marinas * Create one or two objects that may result from the memory block
87553238a60SCatalin Marinas * split. Note that partial freeing is only done by free_bootmem() and
876c5665868SCatalin Marinas * this happens before kmemleak_init() is called.
87753238a60SCatalin Marinas */
87853238a60SCatalin Marinas start = object->pointer;
87953238a60SCatalin Marinas end = object->pointer + object->size;
8805e4fc577SLiu Shixin if ((ptr > start) &&
8815e4fc577SLiu Shixin !__link_object(object_l, start, ptr - start,
88239042079SCatalin Marinas object->min_count, objflags))
8835e4fc577SLiu Shixin object_l = NULL;
8845e4fc577SLiu Shixin if ((ptr + size < end) &&
8855e4fc577SLiu Shixin !__link_object(object_r, ptr + size, end - ptr - size,
88639042079SCatalin Marinas object->min_count, objflags))
8875e4fc577SLiu Shixin object_r = NULL;
88853238a60SCatalin Marinas
8895e4fc577SLiu Shixin unlock:
8905e4fc577SLiu Shixin raw_spin_unlock_irqrestore(&kmemleak_lock, flags);
891c873ccbbSGu Bowen if (object) {
892e781a9abSCatalin Marinas __delete_object(object);
893c873ccbbSGu Bowen } else {
894c873ccbbSGu Bowen #ifdef DEBUG
895c873ccbbSGu Bowen kmemleak_warn("Partially freeing unknown object at 0x%08lx (size %zu)\n",
896c873ccbbSGu Bowen ptr, size);
897c873ccbbSGu Bowen #endif
898c873ccbbSGu Bowen }
8995e4fc577SLiu Shixin
9005e4fc577SLiu Shixin out:
9015e4fc577SLiu Shixin if (object_l)
9025e4fc577SLiu Shixin mem_pool_free(object_l);
9035e4fc577SLiu Shixin if (object_r)
9045e4fc577SLiu Shixin mem_pool_free(object_r);
90553238a60SCatalin Marinas }
906a1084c87SLuis R. Rodriguez
__paint_it(struct kmemleak_object * object,int color)907a1084c87SLuis R. Rodriguez static void __paint_it(struct kmemleak_object *object, int color)
908a1084c87SLuis R. Rodriguez {
909a1084c87SLuis R. Rodriguez object->min_count = color;
910a1084c87SLuis R. Rodriguez if (color == KMEMLEAK_BLACK)
911a1084c87SLuis R. Rodriguez object->flags |= OBJECT_NO_SCAN;
912a1084c87SLuis R. Rodriguez }
913a1084c87SLuis R. Rodriguez
paint_it(struct kmemleak_object * object,int color)914a1084c87SLuis R. Rodriguez static void paint_it(struct kmemleak_object *object, int color)
915a1084c87SLuis R. Rodriguez {
916a1084c87SLuis R. Rodriguez unsigned long flags;
917a1084c87SLuis R. Rodriguez
9188c96f1bcSHe Zhe raw_spin_lock_irqsave(&object->lock, flags);
919a1084c87SLuis R. Rodriguez __paint_it(object, color);
9208c96f1bcSHe Zhe raw_spin_unlock_irqrestore(&object->lock, flags);
921a1084c87SLuis R. Rodriguez }
922a1084c87SLuis R. Rodriguez
paint_ptr(unsigned long ptr,int color,unsigned int objflags)92339042079SCatalin Marinas static void paint_ptr(unsigned long ptr, int color, unsigned int objflags)
924a1084c87SLuis R. Rodriguez {
925a1084c87SLuis R. Rodriguez struct kmemleak_object *object;
926a1084c87SLuis R. Rodriguez
92739042079SCatalin Marinas object = __find_and_get_object(ptr, 0, objflags);
928c4d6d782SHarry Yoo if (!object)
929c4d6d782SHarry Yoo /*
930c4d6d782SHarry Yoo * kmalloc_nolock() -> kfree_rcu() calls kmemleak_ignore()
931c4d6d782SHarry Yoo * without kmemleak_alloc().
932c4d6d782SHarry Yoo */
933a1084c87SLuis R. Rodriguez return;
934a1084c87SLuis R. Rodriguez paint_it(object, color);
935a1084c87SLuis R. Rodriguez put_object(object);
936a1084c87SLuis R. Rodriguez }
937a1084c87SLuis R. Rodriguez
93853238a60SCatalin Marinas /*
939145b64b9SHolger Hans Peter Freyther * Mark an object permanently as gray-colored so that it can no longer be
9403c7b4e6bSCatalin Marinas * reported as a leak. This is used in general to mark a false positive.
9413c7b4e6bSCatalin Marinas */
make_gray_object(unsigned long ptr)9423c7b4e6bSCatalin Marinas static void make_gray_object(unsigned long ptr)
9433c7b4e6bSCatalin Marinas {
94439042079SCatalin Marinas paint_ptr(ptr, KMEMLEAK_GREY, 0);
9453c7b4e6bSCatalin Marinas }
9463c7b4e6bSCatalin Marinas
9473c7b4e6bSCatalin Marinas /*
9483c7b4e6bSCatalin Marinas * Mark the object as black-colored so that it is ignored from scans and
9493c7b4e6bSCatalin Marinas * reporting.
9503c7b4e6bSCatalin Marinas */
make_black_object(unsigned long ptr,unsigned int objflags)95139042079SCatalin Marinas static void make_black_object(unsigned long ptr, unsigned int objflags)
9523c7b4e6bSCatalin Marinas {
95339042079SCatalin Marinas paint_ptr(ptr, KMEMLEAK_BLACK, objflags);
9543c7b4e6bSCatalin Marinas }
9553c7b4e6bSCatalin Marinas
9563c7b4e6bSCatalin Marinas /*
9577591c127SCatalin Marinas * Reset the checksum of an object. The immediate effect is that it will not
9587591c127SCatalin Marinas * be reported as a leak during the next scan until its checksum is updated.
9597591c127SCatalin Marinas */
reset_checksum(unsigned long ptr)9607591c127SCatalin Marinas static void reset_checksum(unsigned long ptr)
9617591c127SCatalin Marinas {
9627591c127SCatalin Marinas unsigned long flags;
9637591c127SCatalin Marinas struct kmemleak_object *object;
9647591c127SCatalin Marinas
9657591c127SCatalin Marinas object = find_and_get_object(ptr, 0);
9667591c127SCatalin Marinas if (!object) {
9677591c127SCatalin Marinas kmemleak_warn("Not resetting the checksum of an unknown object at 0x%08lx\n",
9687591c127SCatalin Marinas ptr);
9697591c127SCatalin Marinas return;
9707591c127SCatalin Marinas }
9717591c127SCatalin Marinas
9727591c127SCatalin Marinas raw_spin_lock_irqsave(&object->lock, flags);
9737591c127SCatalin Marinas object->checksum = 0;
9747591c127SCatalin Marinas raw_spin_unlock_irqrestore(&object->lock, flags);
9757591c127SCatalin Marinas put_object(object);
9767591c127SCatalin Marinas }
9777591c127SCatalin Marinas
9787591c127SCatalin Marinas /*
9793c7b4e6bSCatalin Marinas * Add a scanning area to the object. If at least one such area is added,
9803c7b4e6bSCatalin Marinas * kmemleak will only scan these ranges rather than the whole memory block.
9813c7b4e6bSCatalin Marinas */
add_scan_area(unsigned long ptr,size_t size,gfp_t gfp)982c017b4beSCatalin Marinas static void add_scan_area(unsigned long ptr, size_t size, gfp_t gfp)
9833c7b4e6bSCatalin Marinas {
9843c7b4e6bSCatalin Marinas unsigned long flags;
9853c7b4e6bSCatalin Marinas struct kmemleak_object *object;
986c5665868SCatalin Marinas struct kmemleak_scan_area *area = NULL;
987bfc8089fSKuan-Ying Lee unsigned long untagged_ptr;
988bfc8089fSKuan-Ying Lee unsigned long untagged_objp;
9893c7b4e6bSCatalin Marinas
990c017b4beSCatalin Marinas object = find_and_get_object(ptr, 1);
9913c7b4e6bSCatalin Marinas if (!object) {
992ae281064SJoe Perches kmemleak_warn("Adding scan area to unknown object at 0x%08lx\n",
993ae281064SJoe Perches ptr);
9943c7b4e6bSCatalin Marinas return;
9953c7b4e6bSCatalin Marinas }
9963c7b4e6bSCatalin Marinas
997bfc8089fSKuan-Ying Lee untagged_ptr = (unsigned long)kasan_reset_tag((void *)ptr);
998bfc8089fSKuan-Ying Lee untagged_objp = (unsigned long)kasan_reset_tag((void *)object->pointer);
999bfc8089fSKuan-Ying Lee
1000c5665868SCatalin Marinas if (scan_area_cache)
10011c00f936SDave Chinner area = kmem_cache_alloc_noprof(scan_area_cache,
10021c00f936SDave Chinner gfp_nested_mask(gfp));
10033c7b4e6bSCatalin Marinas
10048c96f1bcSHe Zhe raw_spin_lock_irqsave(&object->lock, flags);
1005dba82d94SCatalin Marinas if (!area) {
1006dba82d94SCatalin Marinas pr_warn_once("Cannot allocate a scan area, scanning the full object\n");
1007dba82d94SCatalin Marinas /* mark the object for full scan to avoid false positives */
1008dba82d94SCatalin Marinas object->flags |= OBJECT_FULL_SCAN;
1009dba82d94SCatalin Marinas goto out_unlock;
1010dba82d94SCatalin Marinas }
10117f88f88fSCatalin Marinas if (size == SIZE_MAX) {
1012bfc8089fSKuan-Ying Lee size = untagged_objp + object->size - untagged_ptr;
1013bfc8089fSKuan-Ying Lee } else if (untagged_ptr + size > untagged_objp + object->size) {
1014ae281064SJoe Perches kmemleak_warn("Scan area larger than object 0x%08lx\n", ptr);
10153c7b4e6bSCatalin Marinas dump_object_info(object);
10163c7b4e6bSCatalin Marinas kmem_cache_free(scan_area_cache, area);
10173c7b4e6bSCatalin Marinas goto out_unlock;
10183c7b4e6bSCatalin Marinas }
10193c7b4e6bSCatalin Marinas
10203c7b4e6bSCatalin Marinas INIT_HLIST_NODE(&area->node);
1021c017b4beSCatalin Marinas area->start = ptr;
1022c017b4beSCatalin Marinas area->size = size;
10233c7b4e6bSCatalin Marinas
10243c7b4e6bSCatalin Marinas hlist_add_head(&area->node, &object->area_list);
10253c7b4e6bSCatalin Marinas out_unlock:
10268c96f1bcSHe Zhe raw_spin_unlock_irqrestore(&object->lock, flags);
10273c7b4e6bSCatalin Marinas put_object(object);
10283c7b4e6bSCatalin Marinas }
10293c7b4e6bSCatalin Marinas
10303c7b4e6bSCatalin Marinas /*
103194f4a161SCatalin Marinas * Any surplus references (object already gray) to 'ptr' are passed to
103294f4a161SCatalin Marinas * 'excess_ref'. This is used in the vmalloc() case where a pointer to
103394f4a161SCatalin Marinas * vm_struct may be used as an alternative reference to the vmalloc'ed object
103494f4a161SCatalin Marinas * (see free_thread_stack()).
103594f4a161SCatalin Marinas */
object_set_excess_ref(unsigned long ptr,unsigned long excess_ref)103694f4a161SCatalin Marinas static void object_set_excess_ref(unsigned long ptr, unsigned long excess_ref)
103794f4a161SCatalin Marinas {
103894f4a161SCatalin Marinas unsigned long flags;
103994f4a161SCatalin Marinas struct kmemleak_object *object;
104094f4a161SCatalin Marinas
104194f4a161SCatalin Marinas object = find_and_get_object(ptr, 0);
104294f4a161SCatalin Marinas if (!object) {
104394f4a161SCatalin Marinas kmemleak_warn("Setting excess_ref on unknown object at 0x%08lx\n",
104494f4a161SCatalin Marinas ptr);
104594f4a161SCatalin Marinas return;
104694f4a161SCatalin Marinas }
104794f4a161SCatalin Marinas
10488c96f1bcSHe Zhe raw_spin_lock_irqsave(&object->lock, flags);
104994f4a161SCatalin Marinas object->excess_ref = excess_ref;
10508c96f1bcSHe Zhe raw_spin_unlock_irqrestore(&object->lock, flags);
105194f4a161SCatalin Marinas put_object(object);
105294f4a161SCatalin Marinas }
105394f4a161SCatalin Marinas
105494f4a161SCatalin Marinas /*
1055002c5d1cSMike Rapoport (Microsoft) * Set the OBJECT_NO_SCAN flag for the object corresponding to the given
10563c7b4e6bSCatalin Marinas * pointer. Such object will not be scanned by kmemleak but references to it
10573c7b4e6bSCatalin Marinas * are searched.
10583c7b4e6bSCatalin Marinas */
object_no_scan(unsigned long ptr)10593c7b4e6bSCatalin Marinas static void object_no_scan(unsigned long ptr)
10603c7b4e6bSCatalin Marinas {
10613c7b4e6bSCatalin Marinas unsigned long flags;
10623c7b4e6bSCatalin Marinas struct kmemleak_object *object;
10633c7b4e6bSCatalin Marinas
10643c7b4e6bSCatalin Marinas object = find_and_get_object(ptr, 0);
10653c7b4e6bSCatalin Marinas if (!object) {
1066ae281064SJoe Perches kmemleak_warn("Not scanning unknown object at 0x%08lx\n", ptr);
10673c7b4e6bSCatalin Marinas return;
10683c7b4e6bSCatalin Marinas }
10693c7b4e6bSCatalin Marinas
10708c96f1bcSHe Zhe raw_spin_lock_irqsave(&object->lock, flags);
10713c7b4e6bSCatalin Marinas object->flags |= OBJECT_NO_SCAN;
10728c96f1bcSHe Zhe raw_spin_unlock_irqrestore(&object->lock, flags);
10733c7b4e6bSCatalin Marinas put_object(object);
10743c7b4e6bSCatalin Marinas }
10753c7b4e6bSCatalin Marinas
1076a2b6bf63SCatalin Marinas /**
1077a2b6bf63SCatalin Marinas * kmemleak_alloc - register a newly allocated object
1078a2b6bf63SCatalin Marinas * @ptr: pointer to beginning of the object
1079a2b6bf63SCatalin Marinas * @size: size of the object
1080a2b6bf63SCatalin Marinas * @min_count: minimum number of references to this object. If during memory
1081a2b6bf63SCatalin Marinas * scanning a number of references less than @min_count is found,
1082a2b6bf63SCatalin Marinas * the object is reported as a memory leak. If @min_count is 0,
1083a2b6bf63SCatalin Marinas * the object is never reported as a leak. If @min_count is -1,
1084a2b6bf63SCatalin Marinas * the object is ignored (not scanned and not reported as a leak)
1085a2b6bf63SCatalin Marinas * @gfp: kmalloc() flags used for kmemleak internal memory allocations
1086a2b6bf63SCatalin Marinas *
1087a2b6bf63SCatalin Marinas * This function is called from the kernel allocators when a new object
108894f4a161SCatalin Marinas * (memory block) is allocated (kmem_cache_alloc, kmalloc etc.).
10893c7b4e6bSCatalin Marinas */
kmemleak_alloc(const void * ptr,size_t size,int min_count,gfp_t gfp)1090a6186d89SCatalin Marinas void __ref kmemleak_alloc(const void *ptr, size_t size, int min_count,
1091a6186d89SCatalin Marinas gfp_t gfp)
10923c7b4e6bSCatalin Marinas {
109362047e0fSLiu Shixin pr_debug("%s(0x%px, %zu, %d)\n", __func__, ptr, size, min_count);
10943c7b4e6bSCatalin Marinas
10958910ae89SLi Zefan if (kmemleak_enabled && ptr && !IS_ERR(ptr))
10963c7b4e6bSCatalin Marinas create_object((unsigned long)ptr, size, min_count, gfp);
10973c7b4e6bSCatalin Marinas }
10983c7b4e6bSCatalin Marinas EXPORT_SYMBOL_GPL(kmemleak_alloc);
10993c7b4e6bSCatalin Marinas
1100a2b6bf63SCatalin Marinas /**
1101f528f0b8SCatalin Marinas * kmemleak_alloc_percpu - register a newly allocated __percpu object
1102f528f0b8SCatalin Marinas * @ptr: __percpu pointer to beginning of the object
1103f528f0b8SCatalin Marinas * @size: size of the object
11048a8c35faSLarry Finger * @gfp: flags used for kmemleak internal memory allocations
1105f528f0b8SCatalin Marinas *
1106f528f0b8SCatalin Marinas * This function is called from the kernel percpu allocator when a new object
11078a8c35faSLarry Finger * (memory block) is allocated (alloc_percpu).
1108f528f0b8SCatalin Marinas */
kmemleak_alloc_percpu(const void __percpu * ptr,size_t size,gfp_t gfp)11098a8c35faSLarry Finger void __ref kmemleak_alloc_percpu(const void __percpu *ptr, size_t size,
11108a8c35faSLarry Finger gfp_t gfp)
1111f528f0b8SCatalin Marinas {
111262047e0fSLiu Shixin pr_debug("%s(0x%px, %zu)\n", __func__, ptr, size);
1113f528f0b8SCatalin Marinas
11148c868592SUros Bizjak if (kmemleak_enabled && ptr && !IS_ERR_PCPU(ptr))
111576d5d4c5SGuo Weikang create_object_percpu((__force unsigned long)ptr, size, 1, gfp);
1116f528f0b8SCatalin Marinas }
1117f528f0b8SCatalin Marinas EXPORT_SYMBOL_GPL(kmemleak_alloc_percpu);
1118f528f0b8SCatalin Marinas
1119f528f0b8SCatalin Marinas /**
112094f4a161SCatalin Marinas * kmemleak_vmalloc - register a newly vmalloc'ed object
112194f4a161SCatalin Marinas * @area: pointer to vm_struct
112294f4a161SCatalin Marinas * @size: size of the object
112394f4a161SCatalin Marinas * @gfp: __vmalloc() flags used for kmemleak internal memory allocations
112494f4a161SCatalin Marinas *
112594f4a161SCatalin Marinas * This function is called from the vmalloc() kernel allocator when a new
112694f4a161SCatalin Marinas * object (memory block) is allocated.
112794f4a161SCatalin Marinas */
kmemleak_vmalloc(const struct vm_struct * area,size_t size,gfp_t gfp)112894f4a161SCatalin Marinas void __ref kmemleak_vmalloc(const struct vm_struct *area, size_t size, gfp_t gfp)
112994f4a161SCatalin Marinas {
113062047e0fSLiu Shixin pr_debug("%s(0x%px, %zu)\n", __func__, area, size);
113194f4a161SCatalin Marinas
113294f4a161SCatalin Marinas /*
113394f4a161SCatalin Marinas * A min_count = 2 is needed because vm_struct contains a reference to
113494f4a161SCatalin Marinas * the virtual address of the vmalloc'ed block.
113594f4a161SCatalin Marinas */
113694f4a161SCatalin Marinas if (kmemleak_enabled) {
113794f4a161SCatalin Marinas create_object((unsigned long)area->addr, size, 2, gfp);
113894f4a161SCatalin Marinas object_set_excess_ref((unsigned long)area,
113994f4a161SCatalin Marinas (unsigned long)area->addr);
114094f4a161SCatalin Marinas }
114194f4a161SCatalin Marinas }
114294f4a161SCatalin Marinas EXPORT_SYMBOL_GPL(kmemleak_vmalloc);
114394f4a161SCatalin Marinas
114494f4a161SCatalin Marinas /**
1145a2b6bf63SCatalin Marinas * kmemleak_free - unregister a previously registered object
1146a2b6bf63SCatalin Marinas * @ptr: pointer to beginning of the object
1147a2b6bf63SCatalin Marinas *
1148a2b6bf63SCatalin Marinas * This function is called from the kernel allocators when an object (memory
1149a2b6bf63SCatalin Marinas * block) is freed (kmem_cache_free, kfree, vfree etc.).
11503c7b4e6bSCatalin Marinas */
kmemleak_free(const void * ptr)1151a6186d89SCatalin Marinas void __ref kmemleak_free(const void *ptr)
11523c7b4e6bSCatalin Marinas {
115362047e0fSLiu Shixin pr_debug("%s(0x%px)\n", __func__, ptr);
11543c7b4e6bSCatalin Marinas
1155c5f3b1a5SCatalin Marinas if (kmemleak_free_enabled && ptr && !IS_ERR(ptr))
115639042079SCatalin Marinas delete_object_full((unsigned long)ptr, 0);
11573c7b4e6bSCatalin Marinas }
11583c7b4e6bSCatalin Marinas EXPORT_SYMBOL_GPL(kmemleak_free);
11593c7b4e6bSCatalin Marinas
1160a2b6bf63SCatalin Marinas /**
1161a2b6bf63SCatalin Marinas * kmemleak_free_part - partially unregister a previously registered object
1162a2b6bf63SCatalin Marinas * @ptr: pointer to the beginning or inside the object. This also
1163a2b6bf63SCatalin Marinas * represents the start of the range to be freed
1164a2b6bf63SCatalin Marinas * @size: size to be unregistered
1165a2b6bf63SCatalin Marinas *
1166a2b6bf63SCatalin Marinas * This function is called when only a part of a memory block is freed
1167a2b6bf63SCatalin Marinas * (usually from the bootmem allocator).
116853238a60SCatalin Marinas */
kmemleak_free_part(const void * ptr,size_t size)1169a6186d89SCatalin Marinas void __ref kmemleak_free_part(const void *ptr, size_t size)
117053238a60SCatalin Marinas {
117162047e0fSLiu Shixin pr_debug("%s(0x%px)\n", __func__, ptr);
117253238a60SCatalin Marinas
11738910ae89SLi Zefan if (kmemleak_enabled && ptr && !IS_ERR(ptr))
117439042079SCatalin Marinas delete_object_part((unsigned long)ptr, size, 0);
117553238a60SCatalin Marinas }
117653238a60SCatalin Marinas EXPORT_SYMBOL_GPL(kmemleak_free_part);
117753238a60SCatalin Marinas
1178a2b6bf63SCatalin Marinas /**
1179f528f0b8SCatalin Marinas * kmemleak_free_percpu - unregister a previously registered __percpu object
1180f528f0b8SCatalin Marinas * @ptr: __percpu pointer to beginning of the object
1181f528f0b8SCatalin Marinas *
1182f528f0b8SCatalin Marinas * This function is called from the kernel percpu allocator when an object
1183f528f0b8SCatalin Marinas * (memory block) is freed (free_percpu).
1184f528f0b8SCatalin Marinas */
kmemleak_free_percpu(const void __percpu * ptr)1185f528f0b8SCatalin Marinas void __ref kmemleak_free_percpu(const void __percpu *ptr)
1186f528f0b8SCatalin Marinas {
118762047e0fSLiu Shixin pr_debug("%s(0x%px)\n", __func__, ptr);
1188f528f0b8SCatalin Marinas
11898c868592SUros Bizjak if (kmemleak_free_enabled && ptr && !IS_ERR_PCPU(ptr))
11908c868592SUros Bizjak delete_object_full((__force unsigned long)ptr, OBJECT_PERCPU);
1191f528f0b8SCatalin Marinas }
1192f528f0b8SCatalin Marinas EXPORT_SYMBOL_GPL(kmemleak_free_percpu);
1193f528f0b8SCatalin Marinas
1194f528f0b8SCatalin Marinas /**
1195ffe2c748SCatalin Marinas * kmemleak_update_trace - update object allocation stack trace
1196ffe2c748SCatalin Marinas * @ptr: pointer to beginning of the object
1197ffe2c748SCatalin Marinas *
1198ffe2c748SCatalin Marinas * Override the object allocation stack trace for cases where the actual
1199ffe2c748SCatalin Marinas * allocation place is not always useful.
1200ffe2c748SCatalin Marinas */
kmemleak_update_trace(const void * ptr)1201ffe2c748SCatalin Marinas void __ref kmemleak_update_trace(const void *ptr)
1202ffe2c748SCatalin Marinas {
1203ffe2c748SCatalin Marinas struct kmemleak_object *object;
1204d63385a7SLiu Shixin depot_stack_handle_t trace_handle;
1205ffe2c748SCatalin Marinas unsigned long flags;
1206ffe2c748SCatalin Marinas
120762047e0fSLiu Shixin pr_debug("%s(0x%px)\n", __func__, ptr);
1208ffe2c748SCatalin Marinas
1209ffe2c748SCatalin Marinas if (!kmemleak_enabled || IS_ERR_OR_NULL(ptr))
1210ffe2c748SCatalin Marinas return;
1211ffe2c748SCatalin Marinas
1212ffe2c748SCatalin Marinas object = find_and_get_object((unsigned long)ptr, 1);
1213ffe2c748SCatalin Marinas if (!object) {
1214ffe2c748SCatalin Marinas #ifdef DEBUG
1215ffe2c748SCatalin Marinas kmemleak_warn("Updating stack trace for unknown object at %p\n",
1216ffe2c748SCatalin Marinas ptr);
1217ffe2c748SCatalin Marinas #endif
1218ffe2c748SCatalin Marinas return;
1219ffe2c748SCatalin Marinas }
1220ffe2c748SCatalin Marinas
1221d63385a7SLiu Shixin trace_handle = set_track_prepare();
12228c96f1bcSHe Zhe raw_spin_lock_irqsave(&object->lock, flags);
1223d63385a7SLiu Shixin object->trace_handle = trace_handle;
12248c96f1bcSHe Zhe raw_spin_unlock_irqrestore(&object->lock, flags);
1225ffe2c748SCatalin Marinas
1226ffe2c748SCatalin Marinas put_object(object);
1227ffe2c748SCatalin Marinas }
1228ffe2c748SCatalin Marinas EXPORT_SYMBOL(kmemleak_update_trace);
1229ffe2c748SCatalin Marinas
1230ffe2c748SCatalin Marinas /**
1231a2b6bf63SCatalin Marinas * kmemleak_not_leak - mark an allocated object as false positive
1232a2b6bf63SCatalin Marinas * @ptr: pointer to beginning of the object
1233a2b6bf63SCatalin Marinas *
1234a2b6bf63SCatalin Marinas * Calling this function on an object will cause the memory block to no longer
1235a2b6bf63SCatalin Marinas * be reported as leak and always be scanned.
12363c7b4e6bSCatalin Marinas */
kmemleak_not_leak(const void * ptr)1237a6186d89SCatalin Marinas void __ref kmemleak_not_leak(const void *ptr)
12383c7b4e6bSCatalin Marinas {
123962047e0fSLiu Shixin pr_debug("%s(0x%px)\n", __func__, ptr);
12403c7b4e6bSCatalin Marinas
12418910ae89SLi Zefan if (kmemleak_enabled && ptr && !IS_ERR(ptr))
12423c7b4e6bSCatalin Marinas make_gray_object((unsigned long)ptr);
12433c7b4e6bSCatalin Marinas }
12443c7b4e6bSCatalin Marinas EXPORT_SYMBOL(kmemleak_not_leak);
12453c7b4e6bSCatalin Marinas
1246a2b6bf63SCatalin Marinas /**
12477591c127SCatalin Marinas * kmemleak_transient_leak - mark an allocated object as transient false positive
12487591c127SCatalin Marinas * @ptr: pointer to beginning of the object
12497591c127SCatalin Marinas *
12507591c127SCatalin Marinas * Calling this function on an object will cause the memory block to not be
12517591c127SCatalin Marinas * reported as a leak temporarily. This may happen, for example, if the object
12527591c127SCatalin Marinas * is part of a singly linked list and the ->next reference to it is changed.
12537591c127SCatalin Marinas */
kmemleak_transient_leak(const void * ptr)12547591c127SCatalin Marinas void __ref kmemleak_transient_leak(const void *ptr)
12557591c127SCatalin Marinas {
12567591c127SCatalin Marinas pr_debug("%s(0x%px)\n", __func__, ptr);
12577591c127SCatalin Marinas
12587591c127SCatalin Marinas if (kmemleak_enabled && ptr && !IS_ERR(ptr))
12597591c127SCatalin Marinas reset_checksum((unsigned long)ptr);
12607591c127SCatalin Marinas }
12617591c127SCatalin Marinas EXPORT_SYMBOL(kmemleak_transient_leak);
12627591c127SCatalin Marinas
12637591c127SCatalin Marinas /**
1264f5769359SHao Ge * kmemleak_ignore_percpu - similar to kmemleak_ignore but taking a percpu
1265f5769359SHao Ge * address argument
1266f5769359SHao Ge * @ptr: percpu address of the object
1267f5769359SHao Ge */
kmemleak_ignore_percpu(const void __percpu * ptr)1268f5769359SHao Ge void __ref kmemleak_ignore_percpu(const void __percpu *ptr)
1269f5769359SHao Ge {
1270f5769359SHao Ge pr_debug("%s(0x%px)\n", __func__, ptr);
1271f5769359SHao Ge
1272f5769359SHao Ge if (kmemleak_enabled && ptr && !IS_ERR_PCPU(ptr))
1273f5769359SHao Ge make_black_object((unsigned long)ptr, OBJECT_PERCPU);
1274f5769359SHao Ge }
1275f5769359SHao Ge EXPORT_SYMBOL_GPL(kmemleak_ignore_percpu);
1276f5769359SHao Ge
1277f5769359SHao Ge /**
1278a2b6bf63SCatalin Marinas * kmemleak_ignore - ignore an allocated object
1279a2b6bf63SCatalin Marinas * @ptr: pointer to beginning of the object
1280a2b6bf63SCatalin Marinas *
1281a2b6bf63SCatalin Marinas * Calling this function on an object will cause the memory block to be
1282a2b6bf63SCatalin Marinas * ignored (not scanned and not reported as a leak). This is usually done when
1283a2b6bf63SCatalin Marinas * it is known that the corresponding block is not a leak and does not contain
1284a2b6bf63SCatalin Marinas * any references to other allocated memory blocks.
12853c7b4e6bSCatalin Marinas */
kmemleak_ignore(const void * ptr)1286a6186d89SCatalin Marinas void __ref kmemleak_ignore(const void *ptr)
12873c7b4e6bSCatalin Marinas {
128862047e0fSLiu Shixin pr_debug("%s(0x%px)\n", __func__, ptr);
12893c7b4e6bSCatalin Marinas
12908910ae89SLi Zefan if (kmemleak_enabled && ptr && !IS_ERR(ptr))
129139042079SCatalin Marinas make_black_object((unsigned long)ptr, 0);
12923c7b4e6bSCatalin Marinas }
12933c7b4e6bSCatalin Marinas EXPORT_SYMBOL(kmemleak_ignore);
12943c7b4e6bSCatalin Marinas
1295a2b6bf63SCatalin Marinas /**
1296a2b6bf63SCatalin Marinas * kmemleak_scan_area - limit the range to be scanned in an allocated object
1297a2b6bf63SCatalin Marinas * @ptr: pointer to beginning or inside the object. This also
1298a2b6bf63SCatalin Marinas * represents the start of the scan area
1299a2b6bf63SCatalin Marinas * @size: size of the scan area
1300a2b6bf63SCatalin Marinas * @gfp: kmalloc() flags used for kmemleak internal memory allocations
1301a2b6bf63SCatalin Marinas *
1302a2b6bf63SCatalin Marinas * This function is used when it is known that only certain parts of an object
1303a2b6bf63SCatalin Marinas * contain references to other objects. Kmemleak will only scan these areas
1304a2b6bf63SCatalin Marinas * reducing the number false negatives.
13053c7b4e6bSCatalin Marinas */
kmemleak_scan_area(const void * ptr,size_t size,gfp_t gfp)1306c017b4beSCatalin Marinas void __ref kmemleak_scan_area(const void *ptr, size_t size, gfp_t gfp)
13073c7b4e6bSCatalin Marinas {
130862047e0fSLiu Shixin pr_debug("%s(0x%px)\n", __func__, ptr);
13093c7b4e6bSCatalin Marinas
13108910ae89SLi Zefan if (kmemleak_enabled && ptr && size && !IS_ERR(ptr))
1311c017b4beSCatalin Marinas add_scan_area((unsigned long)ptr, size, gfp);
13123c7b4e6bSCatalin Marinas }
13133c7b4e6bSCatalin Marinas EXPORT_SYMBOL(kmemleak_scan_area);
13143c7b4e6bSCatalin Marinas
1315a2b6bf63SCatalin Marinas /**
1316a2b6bf63SCatalin Marinas * kmemleak_no_scan - do not scan an allocated object
1317a2b6bf63SCatalin Marinas * @ptr: pointer to beginning of the object
1318a2b6bf63SCatalin Marinas *
1319a2b6bf63SCatalin Marinas * This function notifies kmemleak not to scan the given memory block. Useful
1320a2b6bf63SCatalin Marinas * in situations where it is known that the given object does not contain any
1321a2b6bf63SCatalin Marinas * references to other objects. Kmemleak will not scan such objects reducing
1322a2b6bf63SCatalin Marinas * the number of false negatives.
13233c7b4e6bSCatalin Marinas */
kmemleak_no_scan(const void * ptr)1324a6186d89SCatalin Marinas void __ref kmemleak_no_scan(const void *ptr)
13253c7b4e6bSCatalin Marinas {
132662047e0fSLiu Shixin pr_debug("%s(0x%px)\n", __func__, ptr);
13273c7b4e6bSCatalin Marinas
13288910ae89SLi Zefan if (kmemleak_enabled && ptr && !IS_ERR(ptr))
13293c7b4e6bSCatalin Marinas object_no_scan((unsigned long)ptr);
13303c7b4e6bSCatalin Marinas }
13313c7b4e6bSCatalin Marinas EXPORT_SYMBOL(kmemleak_no_scan);
13323c7b4e6bSCatalin Marinas
13339099daedSCatalin Marinas /**
13349099daedSCatalin Marinas * kmemleak_alloc_phys - similar to kmemleak_alloc but taking a physical
13359099daedSCatalin Marinas * address argument
1336e8b098fcSMike Rapoport * @phys: physical address of the object
1337e8b098fcSMike Rapoport * @size: size of the object
1338e8b098fcSMike Rapoport * @gfp: kmalloc() flags used for kmemleak internal memory allocations
13399099daedSCatalin Marinas */
kmemleak_alloc_phys(phys_addr_t phys,size_t size,gfp_t gfp)1340c200d900SPatrick Wang void __ref kmemleak_alloc_phys(phys_addr_t phys, size_t size, gfp_t gfp)
13419099daedSCatalin Marinas {
134262047e0fSLiu Shixin pr_debug("%s(0x%px, %zu)\n", __func__, &phys, size);
13438e0c4ab3SPatrick Wang
134484c32629SPatrick Wang if (kmemleak_enabled)
13458e0c4ab3SPatrick Wang /*
13468e0c4ab3SPatrick Wang * Create object with OBJECT_PHYS flag and
13478e0c4ab3SPatrick Wang * assume min_count 0.
13488e0c4ab3SPatrick Wang */
13490c24e061SPatrick Wang create_object_phys((unsigned long)phys, size, 0, gfp);
13509099daedSCatalin Marinas }
13519099daedSCatalin Marinas EXPORT_SYMBOL(kmemleak_alloc_phys);
13529099daedSCatalin Marinas
13539099daedSCatalin Marinas /**
13549099daedSCatalin Marinas * kmemleak_free_part_phys - similar to kmemleak_free_part but taking a
13559099daedSCatalin Marinas * physical address argument
1356e8b098fcSMike Rapoport * @phys: physical address if the beginning or inside an object. This
1357e8b098fcSMike Rapoport * also represents the start of the range to be freed
1358e8b098fcSMike Rapoport * @size: size to be unregistered
13599099daedSCatalin Marinas */
kmemleak_free_part_phys(phys_addr_t phys,size_t size)13609099daedSCatalin Marinas void __ref kmemleak_free_part_phys(phys_addr_t phys, size_t size)
13619099daedSCatalin Marinas {
136262047e0fSLiu Shixin pr_debug("%s(0x%px)\n", __func__, &phys);
13630c24e061SPatrick Wang
136484c32629SPatrick Wang if (kmemleak_enabled)
136539042079SCatalin Marinas delete_object_part((unsigned long)phys, size, OBJECT_PHYS);
13669099daedSCatalin Marinas }
13679099daedSCatalin Marinas EXPORT_SYMBOL(kmemleak_free_part_phys);
13689099daedSCatalin Marinas
13699099daedSCatalin Marinas /**
13709099daedSCatalin Marinas * kmemleak_ignore_phys - similar to kmemleak_ignore but taking a physical
13719099daedSCatalin Marinas * address argument
1372e8b098fcSMike Rapoport * @phys: physical address of the object
13739099daedSCatalin Marinas */
kmemleak_ignore_phys(phys_addr_t phys)13749099daedSCatalin Marinas void __ref kmemleak_ignore_phys(phys_addr_t phys)
13759099daedSCatalin Marinas {
137662047e0fSLiu Shixin pr_debug("%s(0x%px)\n", __func__, &phys);
13770c24e061SPatrick Wang
137884c32629SPatrick Wang if (kmemleak_enabled)
137939042079SCatalin Marinas make_black_object((unsigned long)phys, OBJECT_PHYS);
13809099daedSCatalin Marinas }
13819099daedSCatalin Marinas EXPORT_SYMBOL(kmemleak_ignore_phys);
13829099daedSCatalin Marinas
13833c7b4e6bSCatalin Marinas /*
138404609cccSCatalin Marinas * Update an object's checksum and return true if it was modified.
138504609cccSCatalin Marinas */
update_checksum(struct kmemleak_object * object)138604609cccSCatalin Marinas static bool update_checksum(struct kmemleak_object *object)
138704609cccSCatalin Marinas {
138804609cccSCatalin Marinas u32 old_csum = object->checksum;
138904609cccSCatalin Marinas
13906c99d4ebSPavel Tikhomirov if (WARN_ON_ONCE(object->flags & OBJECT_PHYS))
13910c24e061SPatrick Wang return false;
13920c24e061SPatrick Wang
1393e79ed2f1SAndrey Ryabinin kasan_disable_current();
139469d0b54dSQian Cai kcsan_disable_current();
13956c99d4ebSPavel Tikhomirov if (object->flags & OBJECT_PERCPU) {
13966c99d4ebSPavel Tikhomirov unsigned int cpu;
13976c99d4ebSPavel Tikhomirov
13986c99d4ebSPavel Tikhomirov object->checksum = 0;
13996c99d4ebSPavel Tikhomirov for_each_possible_cpu(cpu) {
14006c99d4ebSPavel Tikhomirov void *ptr = per_cpu_ptr((void __percpu *)object->pointer, cpu);
14016c99d4ebSPavel Tikhomirov
14026c99d4ebSPavel Tikhomirov object->checksum ^= crc32(0, kasan_reset_tag((void *)ptr), object->size);
14036c99d4ebSPavel Tikhomirov }
14046c99d4ebSPavel Tikhomirov } else {
14056c7a00b8SKuan-Ying Lee object->checksum = crc32(0, kasan_reset_tag((void *)object->pointer), object->size);
14066c99d4ebSPavel Tikhomirov }
1407e79ed2f1SAndrey Ryabinin kasan_enable_current();
140869d0b54dSQian Cai kcsan_enable_current();
1409e79ed2f1SAndrey Ryabinin
141004609cccSCatalin Marinas return object->checksum != old_csum;
141104609cccSCatalin Marinas }
141204609cccSCatalin Marinas
141304609cccSCatalin Marinas /*
141404f70d13SCatalin Marinas * Update an object's references. object->lock must be held by the caller.
141504f70d13SCatalin Marinas */
update_refs(struct kmemleak_object * object)141604f70d13SCatalin Marinas static void update_refs(struct kmemleak_object *object)
141704f70d13SCatalin Marinas {
141804f70d13SCatalin Marinas if (!color_white(object)) {
141904f70d13SCatalin Marinas /* non-orphan, ignored or new */
142004f70d13SCatalin Marinas return;
142104f70d13SCatalin Marinas }
142204f70d13SCatalin Marinas
142304f70d13SCatalin Marinas /*
142404f70d13SCatalin Marinas * Increase the object's reference count (number of pointers to the
142504f70d13SCatalin Marinas * memory block). If this count reaches the required minimum, the
142604f70d13SCatalin Marinas * object's color will become gray and it will be added to the
142704f70d13SCatalin Marinas * gray_list.
142804f70d13SCatalin Marinas */
142904f70d13SCatalin Marinas object->count++;
143004f70d13SCatalin Marinas if (color_gray(object)) {
143104f70d13SCatalin Marinas /* put_object() called when removing from gray_list */
143204f70d13SCatalin Marinas WARN_ON(!get_object(object));
143304f70d13SCatalin Marinas list_add_tail(&object->gray_list, &gray_list);
143404f70d13SCatalin Marinas }
143504f70d13SCatalin Marinas }
143604f70d13SCatalin Marinas
pointer_update_refs(struct kmemleak_object * scanned,unsigned long pointer,unsigned int objflags)14376c99d4ebSPavel Tikhomirov static void pointer_update_refs(struct kmemleak_object *scanned,
14386c99d4ebSPavel Tikhomirov unsigned long pointer, unsigned int objflags)
14396c99d4ebSPavel Tikhomirov {
14406c99d4ebSPavel Tikhomirov struct kmemleak_object *object;
14416c99d4ebSPavel Tikhomirov unsigned long untagged_ptr;
14426c99d4ebSPavel Tikhomirov unsigned long excess_ref;
14436c99d4ebSPavel Tikhomirov
14446c99d4ebSPavel Tikhomirov untagged_ptr = (unsigned long)kasan_reset_tag((void *)pointer);
14456c99d4ebSPavel Tikhomirov if (objflags & OBJECT_PERCPU) {
14466c99d4ebSPavel Tikhomirov if (untagged_ptr < min_percpu_addr || untagged_ptr >= max_percpu_addr)
14476c99d4ebSPavel Tikhomirov return;
14486c99d4ebSPavel Tikhomirov } else {
14496c99d4ebSPavel Tikhomirov if (untagged_ptr < min_addr || untagged_ptr >= max_addr)
14506c99d4ebSPavel Tikhomirov return;
14516c99d4ebSPavel Tikhomirov }
14526c99d4ebSPavel Tikhomirov
14536c99d4ebSPavel Tikhomirov /*
14546c99d4ebSPavel Tikhomirov * No need for get_object() here since we hold kmemleak_lock.
14556c99d4ebSPavel Tikhomirov * object->use_count cannot be dropped to 0 while the object
14566c99d4ebSPavel Tikhomirov * is still present in object_tree_root and object_list
14576c99d4ebSPavel Tikhomirov * (with updates protected by kmemleak_lock).
14586c99d4ebSPavel Tikhomirov */
14596c99d4ebSPavel Tikhomirov object = __lookup_object(pointer, 1, objflags);
14606c99d4ebSPavel Tikhomirov if (!object)
14616c99d4ebSPavel Tikhomirov return;
14626c99d4ebSPavel Tikhomirov if (object == scanned)
14636c99d4ebSPavel Tikhomirov /* self referenced, ignore */
14646c99d4ebSPavel Tikhomirov return;
14656c99d4ebSPavel Tikhomirov
14666c99d4ebSPavel Tikhomirov /*
14676c99d4ebSPavel Tikhomirov * Avoid the lockdep recursive warning on object->lock being
14686c99d4ebSPavel Tikhomirov * previously acquired in scan_object(). These locks are
14696c99d4ebSPavel Tikhomirov * enclosed by scan_mutex.
14706c99d4ebSPavel Tikhomirov */
14716c99d4ebSPavel Tikhomirov raw_spin_lock_nested(&object->lock, SINGLE_DEPTH_NESTING);
14726c99d4ebSPavel Tikhomirov /* only pass surplus references (object already gray) */
14736c99d4ebSPavel Tikhomirov if (color_gray(object)) {
14746c99d4ebSPavel Tikhomirov excess_ref = object->excess_ref;
14756c99d4ebSPavel Tikhomirov /* no need for update_refs() if object already gray */
14766c99d4ebSPavel Tikhomirov } else {
14776c99d4ebSPavel Tikhomirov excess_ref = 0;
14786c99d4ebSPavel Tikhomirov update_refs(object);
14796c99d4ebSPavel Tikhomirov }
14806c99d4ebSPavel Tikhomirov raw_spin_unlock(&object->lock);
14816c99d4ebSPavel Tikhomirov
14826c99d4ebSPavel Tikhomirov if (excess_ref) {
14836c99d4ebSPavel Tikhomirov object = lookup_object(excess_ref, 0);
14846c99d4ebSPavel Tikhomirov if (!object)
14856c99d4ebSPavel Tikhomirov return;
14866c99d4ebSPavel Tikhomirov if (object == scanned)
14876c99d4ebSPavel Tikhomirov /* circular reference, ignore */
14886c99d4ebSPavel Tikhomirov return;
14896c99d4ebSPavel Tikhomirov raw_spin_lock_nested(&object->lock, SINGLE_DEPTH_NESTING);
14906c99d4ebSPavel Tikhomirov update_refs(object);
14916c99d4ebSPavel Tikhomirov raw_spin_unlock(&object->lock);
14926c99d4ebSPavel Tikhomirov }
14936c99d4ebSPavel Tikhomirov }
14946c99d4ebSPavel Tikhomirov
149504f70d13SCatalin Marinas /*
14960b5121efSBhaskar Chowdhury * Memory scanning is a long process and it needs to be interruptible. This
149725985edcSLucas De Marchi * function checks whether such interrupt condition occurred.
14983c7b4e6bSCatalin Marinas */
scan_should_stop(void)14993c7b4e6bSCatalin Marinas static int scan_should_stop(void)
15003c7b4e6bSCatalin Marinas {
15018910ae89SLi Zefan if (!kmemleak_enabled)
15023c7b4e6bSCatalin Marinas return 1;
15033c7b4e6bSCatalin Marinas
15043c7b4e6bSCatalin Marinas /*
15053c7b4e6bSCatalin Marinas * This function may be called from either process or kthread context,
15063c7b4e6bSCatalin Marinas * hence the need to check for both stop conditions.
15073c7b4e6bSCatalin Marinas */
1508c2d91965SZhongqiu Han if (current->flags & PF_KTHREAD)
1509fc9ef297SZhongqiu Han return kthread_should_stop();
1510c2d91965SZhongqiu Han
1511c2d91965SZhongqiu Han return signal_pending(current);
15123c7b4e6bSCatalin Marinas }
15133c7b4e6bSCatalin Marinas
15143c7b4e6bSCatalin Marinas /*
15153c7b4e6bSCatalin Marinas * Scan a memory block (exclusive range) for valid pointers and add those
15163c7b4e6bSCatalin Marinas * found to the gray list.
15173c7b4e6bSCatalin Marinas */
scan_block(void * _start,void * _end,struct kmemleak_object * scanned)15183c7b4e6bSCatalin Marinas static void scan_block(void *_start, void *_end,
151993ada579SCatalin Marinas struct kmemleak_object *scanned)
15203c7b4e6bSCatalin Marinas {
15213c7b4e6bSCatalin Marinas unsigned long *ptr;
15223c7b4e6bSCatalin Marinas unsigned long *start = PTR_ALIGN(_start, BYTES_PER_POINTER);
15233c7b4e6bSCatalin Marinas unsigned long *end = _end - (BYTES_PER_POINTER - 1);
152493ada579SCatalin Marinas unsigned long flags;
15253c7b4e6bSCatalin Marinas
15268c96f1bcSHe Zhe raw_spin_lock_irqsave(&kmemleak_lock, flags);
15273c7b4e6bSCatalin Marinas for (ptr = start; ptr < end; ptr++) {
15288e019366SPekka Enberg unsigned long pointer;
15293c7b4e6bSCatalin Marinas
15303c7b4e6bSCatalin Marinas if (scan_should_stop())
15313c7b4e6bSCatalin Marinas break;
15323c7b4e6bSCatalin Marinas
1533e79ed2f1SAndrey Ryabinin kasan_disable_current();
15346c7a00b8SKuan-Ying Lee pointer = *(unsigned long *)kasan_reset_tag((void *)ptr);
1535e79ed2f1SAndrey Ryabinin kasan_enable_current();
15368e019366SPekka Enberg
15376c99d4ebSPavel Tikhomirov pointer_update_refs(scanned, pointer, 0);
15386c99d4ebSPavel Tikhomirov pointer_update_refs(scanned, pointer, OBJECT_PERCPU);
153994f4a161SCatalin Marinas }
15408c96f1bcSHe Zhe raw_spin_unlock_irqrestore(&kmemleak_lock, flags);
15410587da40SCatalin Marinas }
15420587da40SCatalin Marinas
154393ada579SCatalin Marinas /*
154493ada579SCatalin Marinas * Scan a large memory block in MAX_SCAN_SIZE chunks to reduce the latency.
154593ada579SCatalin Marinas */
1546dce5b0bdSArnd Bergmann #ifdef CONFIG_SMP
scan_large_block(void * start,void * end)154793ada579SCatalin Marinas static void scan_large_block(void *start, void *end)
154893ada579SCatalin Marinas {
154993ada579SCatalin Marinas void *next;
155093ada579SCatalin Marinas
155193ada579SCatalin Marinas while (start < end) {
155293ada579SCatalin Marinas next = min(start + MAX_SCAN_SIZE, end);
155393ada579SCatalin Marinas scan_block(start, next, NULL);
155493ada579SCatalin Marinas start = next;
155593ada579SCatalin Marinas cond_resched();
15563c7b4e6bSCatalin Marinas }
15573c7b4e6bSCatalin Marinas }
1558dce5b0bdSArnd Bergmann #endif
15593c7b4e6bSCatalin Marinas
15603c7b4e6bSCatalin Marinas /*
15613c7b4e6bSCatalin Marinas * Scan a memory block corresponding to a kmemleak_object. A condition is
15623c7b4e6bSCatalin Marinas * that object->use_count >= 1.
15633c7b4e6bSCatalin Marinas */
scan_object(struct kmemleak_object * object)15643c7b4e6bSCatalin Marinas static void scan_object(struct kmemleak_object *object)
15653c7b4e6bSCatalin Marinas {
15663c7b4e6bSCatalin Marinas struct kmemleak_scan_area *area;
15673c7b4e6bSCatalin Marinas unsigned long flags;
15683c7b4e6bSCatalin Marinas
15693c7b4e6bSCatalin Marinas /*
157021ae2956SUwe Kleine-König * Once the object->lock is acquired, the corresponding memory block
157121ae2956SUwe Kleine-König * cannot be freed (the same lock is acquired in delete_object).
15723c7b4e6bSCatalin Marinas */
15738c96f1bcSHe Zhe raw_spin_lock_irqsave(&object->lock, flags);
15743c7b4e6bSCatalin Marinas if (object->flags & OBJECT_NO_SCAN)
15753c7b4e6bSCatalin Marinas goto out;
15763c7b4e6bSCatalin Marinas if (!(object->flags & OBJECT_ALLOCATED))
15773c7b4e6bSCatalin Marinas /* already freed object */
15783c7b4e6bSCatalin Marinas goto out;
15790c24e061SPatrick Wang
158039042079SCatalin Marinas if (object->flags & OBJECT_PERCPU) {
158139042079SCatalin Marinas unsigned int cpu;
158239042079SCatalin Marinas
158339042079SCatalin Marinas for_each_possible_cpu(cpu) {
158439042079SCatalin Marinas void *start = per_cpu_ptr((void __percpu *)object->pointer, cpu);
158539042079SCatalin Marinas void *end = start + object->size;
158639042079SCatalin Marinas
158739042079SCatalin Marinas scan_block(start, end, object);
158839042079SCatalin Marinas
158939042079SCatalin Marinas raw_spin_unlock_irqrestore(&object->lock, flags);
159039042079SCatalin Marinas cond_resched();
159139042079SCatalin Marinas raw_spin_lock_irqsave(&object->lock, flags);
159239042079SCatalin Marinas if (!(object->flags & OBJECT_ALLOCATED))
159339042079SCatalin Marinas break;
159439042079SCatalin Marinas }
159539042079SCatalin Marinas } else if (hlist_empty(&object->area_list) ||
159639042079SCatalin Marinas object->flags & OBJECT_FULL_SCAN) {
159739042079SCatalin Marinas void *start = object->flags & OBJECT_PHYS ?
15980c24e061SPatrick Wang __va((phys_addr_t)object->pointer) :
15990c24e061SPatrick Wang (void *)object->pointer;
160039042079SCatalin Marinas void *end = start + object->size;
160193ada579SCatalin Marinas void *next;
1602af98603dSCatalin Marinas
160393ada579SCatalin Marinas do {
160493ada579SCatalin Marinas next = min(start + MAX_SCAN_SIZE, end);
160593ada579SCatalin Marinas scan_block(start, next, object);
160693ada579SCatalin Marinas
160793ada579SCatalin Marinas start = next;
160893ada579SCatalin Marinas if (start >= end)
160993ada579SCatalin Marinas break;
1610af98603dSCatalin Marinas
16118c96f1bcSHe Zhe raw_spin_unlock_irqrestore(&object->lock, flags);
1612af98603dSCatalin Marinas cond_resched();
16138c96f1bcSHe Zhe raw_spin_lock_irqsave(&object->lock, flags);
161493ada579SCatalin Marinas } while (object->flags & OBJECT_ALLOCATED);
161539042079SCatalin Marinas } else {
1616b67bfe0dSSasha Levin hlist_for_each_entry(area, &object->area_list, node)
1617c017b4beSCatalin Marinas scan_block((void *)area->start,
1618c017b4beSCatalin Marinas (void *)(area->start + area->size),
161993ada579SCatalin Marinas object);
162039042079SCatalin Marinas }
16213c7b4e6bSCatalin Marinas out:
16228c96f1bcSHe Zhe raw_spin_unlock_irqrestore(&object->lock, flags);
16233c7b4e6bSCatalin Marinas }
16243c7b4e6bSCatalin Marinas
16253c7b4e6bSCatalin Marinas /*
162604609cccSCatalin Marinas * Scan the objects already referenced (gray objects). More objects will be
162704609cccSCatalin Marinas * referenced and, if there are no memory leaks, all the objects are scanned.
162804609cccSCatalin Marinas */
scan_gray_list(void)162904609cccSCatalin Marinas static void scan_gray_list(void)
163004609cccSCatalin Marinas {
163104609cccSCatalin Marinas struct kmemleak_object *object, *tmp;
163204609cccSCatalin Marinas
163304609cccSCatalin Marinas /*
163404609cccSCatalin Marinas * The list traversal is safe for both tail additions and removals
163504609cccSCatalin Marinas * from inside the loop. The kmemleak objects cannot be freed from
163604609cccSCatalin Marinas * outside the loop because their use_count was incremented.
163704609cccSCatalin Marinas */
163804609cccSCatalin Marinas object = list_entry(gray_list.next, typeof(*object), gray_list);
163904609cccSCatalin Marinas while (&object->gray_list != &gray_list) {
164004609cccSCatalin Marinas cond_resched();
164104609cccSCatalin Marinas
164204609cccSCatalin Marinas /* may add new objects to the list */
164304609cccSCatalin Marinas if (!scan_should_stop())
164404609cccSCatalin Marinas scan_object(object);
164504609cccSCatalin Marinas
164604609cccSCatalin Marinas tmp = list_entry(object->gray_list.next, typeof(*object),
164704609cccSCatalin Marinas gray_list);
164804609cccSCatalin Marinas
164904609cccSCatalin Marinas /* remove the object from the list and release it */
165004609cccSCatalin Marinas list_del(&object->gray_list);
165104609cccSCatalin Marinas put_object(object);
165204609cccSCatalin Marinas
165304609cccSCatalin Marinas object = tmp;
165404609cccSCatalin Marinas }
165504609cccSCatalin Marinas WARN_ON(!list_empty(&gray_list));
165604609cccSCatalin Marinas }
165704609cccSCatalin Marinas
165804609cccSCatalin Marinas /*
165925e9fa22SYixuan Cao * Conditionally call resched() in an object iteration loop while making sure
1660984a6083SWaiman Long * that the given object won't go away without RCU read lock by performing a
16616061e740SWaiman Long * get_object() if necessaary.
1662984a6083SWaiman Long */
kmemleak_cond_resched(struct kmemleak_object * object)16636061e740SWaiman Long static void kmemleak_cond_resched(struct kmemleak_object *object)
1664984a6083SWaiman Long {
16656061e740SWaiman Long if (!get_object(object))
16666061e740SWaiman Long return; /* Try next object */
1667984a6083SWaiman Long
1668782e4179SWaiman Long raw_spin_lock_irq(&kmemleak_lock);
1669782e4179SWaiman Long if (object->del_state & DELSTATE_REMOVED)
1670782e4179SWaiman Long goto unlock_put; /* Object removed */
1671782e4179SWaiman Long object->del_state |= DELSTATE_NO_DELETE;
1672782e4179SWaiman Long raw_spin_unlock_irq(&kmemleak_lock);
1673782e4179SWaiman Long
1674984a6083SWaiman Long rcu_read_unlock();
1675984a6083SWaiman Long cond_resched();
1676984a6083SWaiman Long rcu_read_lock();
1677782e4179SWaiman Long
1678782e4179SWaiman Long raw_spin_lock_irq(&kmemleak_lock);
1679782e4179SWaiman Long if (object->del_state & DELSTATE_REMOVED)
1680782e4179SWaiman Long list_del_rcu(&object->object_list);
1681782e4179SWaiman Long object->del_state &= ~DELSTATE_NO_DELETE;
1682782e4179SWaiman Long unlock_put:
1683782e4179SWaiman Long raw_spin_unlock_irq(&kmemleak_lock);
1684984a6083SWaiman Long put_object(object);
1685984a6083SWaiman Long }
1686984a6083SWaiman Long
1687984a6083SWaiman Long /*
16883c7b4e6bSCatalin Marinas * Scan data sections and all the referenced memory blocks allocated via the
16893c7b4e6bSCatalin Marinas * kernel's standard allocators. This function must be called with the
16903c7b4e6bSCatalin Marinas * scan_mutex held.
16913c7b4e6bSCatalin Marinas */
kmemleak_scan(void)16923c7b4e6bSCatalin Marinas static void kmemleak_scan(void)
16933c7b4e6bSCatalin Marinas {
169404609cccSCatalin Marinas struct kmemleak_object *object;
1695c10a0f87SLang Yu struct zone *zone;
1696c10a0f87SLang Yu int __maybe_unused i;
16974698c1f2SCatalin Marinas int new_leaks = 0;
16983c7b4e6bSCatalin Marinas
1699acf4968eSCatalin Marinas jiffies_last_scan = jiffies;
1700acf4968eSCatalin Marinas
17013c7b4e6bSCatalin Marinas /* prepare the kmemleak_object's */
17023c7b4e6bSCatalin Marinas rcu_read_lock();
17033c7b4e6bSCatalin Marinas list_for_each_entry_rcu(object, &object_list, object_list) {
170400c15506SWaiman Long raw_spin_lock_irq(&object->lock);
17053c7b4e6bSCatalin Marinas #ifdef DEBUG
17063c7b4e6bSCatalin Marinas /*
17073c7b4e6bSCatalin Marinas * With a few exceptions there should be a maximum of
17083c7b4e6bSCatalin Marinas * 1 reference to any object at this point.
17093c7b4e6bSCatalin Marinas */
17103c7b4e6bSCatalin Marinas if (atomic_read(&object->use_count) > 1) {
1711ae281064SJoe Perches pr_debug("object->use_count = %d\n",
17123c7b4e6bSCatalin Marinas atomic_read(&object->use_count));
17133c7b4e6bSCatalin Marinas dump_object_info(object);
17143c7b4e6bSCatalin Marinas }
17153c7b4e6bSCatalin Marinas #endif
171684c32629SPatrick Wang
171784c32629SPatrick Wang /* ignore objects outside lowmem (paint them black) */
171884c32629SPatrick Wang if ((object->flags & OBJECT_PHYS) &&
171984c32629SPatrick Wang !(object->flags & OBJECT_NO_SCAN)) {
172084c32629SPatrick Wang unsigned long phys = object->pointer;
172184c32629SPatrick Wang
172284c32629SPatrick Wang if (PHYS_PFN(phys) < min_low_pfn ||
1723488b5b9eSCatalin Marinas PHYS_PFN(phys + object->size) > max_low_pfn)
172484c32629SPatrick Wang __paint_it(object, KMEMLEAK_BLACK);
172584c32629SPatrick Wang }
172684c32629SPatrick Wang
17273c7b4e6bSCatalin Marinas /* reset the reference count (whiten the object) */
17283c7b4e6bSCatalin Marinas object->count = 0;
17296061e740SWaiman Long if (color_gray(object) && get_object(object))
17303c7b4e6bSCatalin Marinas list_add_tail(&object->gray_list, &gray_list);
17313c7b4e6bSCatalin Marinas
173200c15506SWaiman Long raw_spin_unlock_irq(&object->lock);
17336edda04cSWaiman Long
17346061e740SWaiman Long if (need_resched())
17356061e740SWaiman Long kmemleak_cond_resched(object);
17363c7b4e6bSCatalin Marinas }
17373c7b4e6bSCatalin Marinas rcu_read_unlock();
17383c7b4e6bSCatalin Marinas
17393c7b4e6bSCatalin Marinas #ifdef CONFIG_SMP
17403c7b4e6bSCatalin Marinas /* per-cpu sections scanning */
17413c7b4e6bSCatalin Marinas for_each_possible_cpu(i)
174293ada579SCatalin Marinas scan_large_block(__per_cpu_start + per_cpu_offset(i),
174393ada579SCatalin Marinas __per_cpu_end + per_cpu_offset(i));
17443c7b4e6bSCatalin Marinas #endif
17453c7b4e6bSCatalin Marinas
17463c7b4e6bSCatalin Marinas /*
1747029aeff5SLaura Abbott * Struct page scanning for each node.
17483c7b4e6bSCatalin Marinas */
1749bfc8c901SVladimir Davydov get_online_mems();
1750c10a0f87SLang Yu for_each_populated_zone(zone) {
1751c10a0f87SLang Yu unsigned long start_pfn = zone->zone_start_pfn;
1752c10a0f87SLang Yu unsigned long end_pfn = zone_end_pfn(zone);
17533c7b4e6bSCatalin Marinas unsigned long pfn;
17543c7b4e6bSCatalin Marinas
17553c7b4e6bSCatalin Marinas for (pfn = start_pfn; pfn < end_pfn; pfn++) {
17569f1eb38eSOscar Salvador struct page *page = pfn_to_online_page(pfn);
17573c7b4e6bSCatalin Marinas
1758e68d343dSWaiman Long if (!(pfn & 63))
1759e68d343dSWaiman Long cond_resched();
1760e68d343dSWaiman Long
17619f1eb38eSOscar Salvador if (!page)
17623c7b4e6bSCatalin Marinas continue;
17639f1eb38eSOscar Salvador
1764c10a0f87SLang Yu /* only scan pages belonging to this zone */
1765c10a0f87SLang Yu if (page_zone(page) != zone)
17669f1eb38eSOscar Salvador continue;
17673c7b4e6bSCatalin Marinas /* only scan if page is in use */
17683c7b4e6bSCatalin Marinas if (page_count(page) == 0)
17693c7b4e6bSCatalin Marinas continue;
177093ada579SCatalin Marinas scan_block(page, page + 1, NULL);
17713c7b4e6bSCatalin Marinas }
17723c7b4e6bSCatalin Marinas }
1773bfc8c901SVladimir Davydov put_online_mems();
17743c7b4e6bSCatalin Marinas
17753c7b4e6bSCatalin Marinas /*
177643ed5d6eSCatalin Marinas * Scanning the task stacks (may introduce false negatives).
17773c7b4e6bSCatalin Marinas */
17783c7b4e6bSCatalin Marinas if (kmemleak_stack_scan) {
177943ed5d6eSCatalin Marinas struct task_struct *p, *g;
178043ed5d6eSCatalin Marinas
1781c4b28963SDavidlohr Bueso rcu_read_lock();
1782c4b28963SDavidlohr Bueso for_each_process_thread(g, p) {
178337df49f4SCatalin Marinas void *stack = try_get_task_stack(p);
178437df49f4SCatalin Marinas if (stack) {
178537df49f4SCatalin Marinas scan_block(stack, stack + THREAD_SIZE, NULL);
178637df49f4SCatalin Marinas put_task_stack(p);
178737df49f4SCatalin Marinas }
1788c4b28963SDavidlohr Bueso }
1789c4b28963SDavidlohr Bueso rcu_read_unlock();
17903c7b4e6bSCatalin Marinas }
17913c7b4e6bSCatalin Marinas
17923c7b4e6bSCatalin Marinas /*
17933c7b4e6bSCatalin Marinas * Scan the objects already referenced from the sections scanned
179404609cccSCatalin Marinas * above.
17953c7b4e6bSCatalin Marinas */
179604609cccSCatalin Marinas scan_gray_list();
17972587362eSCatalin Marinas
17982587362eSCatalin Marinas /*
179904609cccSCatalin Marinas * Check for new or unreferenced objects modified since the previous
180004609cccSCatalin Marinas * scan and color them gray until the next scan.
18012587362eSCatalin Marinas */
18022587362eSCatalin Marinas rcu_read_lock();
18032587362eSCatalin Marinas list_for_each_entry_rcu(object, &object_list, object_list) {
18046061e740SWaiman Long if (need_resched())
18056061e740SWaiman Long kmemleak_cond_resched(object);
1806984a6083SWaiman Long
1807984a6083SWaiman Long /*
180864977918SWaiman Long * This is racy but we can save the overhead of lock/unlock
180964977918SWaiman Long * calls. The missed objects, if any, should be caught in
181064977918SWaiman Long * the next scan.
181164977918SWaiman Long */
181264977918SWaiman Long if (!color_white(object))
181364977918SWaiman Long continue;
181400c15506SWaiman Long raw_spin_lock_irq(&object->lock);
181504609cccSCatalin Marinas if (color_white(object) && (object->flags & OBJECT_ALLOCATED)
181604609cccSCatalin Marinas && update_checksum(object) && get_object(object)) {
181704609cccSCatalin Marinas /* color it gray temporarily */
181804609cccSCatalin Marinas object->count = object->min_count;
18192587362eSCatalin Marinas list_add_tail(&object->gray_list, &gray_list);
18202587362eSCatalin Marinas }
182100c15506SWaiman Long raw_spin_unlock_irq(&object->lock);
18222587362eSCatalin Marinas }
18232587362eSCatalin Marinas rcu_read_unlock();
18242587362eSCatalin Marinas
182504609cccSCatalin Marinas /*
182604609cccSCatalin Marinas * Re-scan the gray list for modified unreferenced objects.
182704609cccSCatalin Marinas */
182804609cccSCatalin Marinas scan_gray_list();
18294698c1f2SCatalin Marinas
18304698c1f2SCatalin Marinas /*
183104609cccSCatalin Marinas * If scanning was stopped do not report any new unreferenced objects.
183217bb9e0dSCatalin Marinas */
183304609cccSCatalin Marinas if (scan_should_stop())
183417bb9e0dSCatalin Marinas return;
183517bb9e0dSCatalin Marinas
183617bb9e0dSCatalin Marinas /*
18374698c1f2SCatalin Marinas * Scanning result reporting.
18384698c1f2SCatalin Marinas */
18394698c1f2SCatalin Marinas rcu_read_lock();
18404698c1f2SCatalin Marinas list_for_each_entry_rcu(object, &object_list, object_list) {
18416061e740SWaiman Long if (need_resched())
18426061e740SWaiman Long kmemleak_cond_resched(object);
1843984a6083SWaiman Long
1844984a6083SWaiman Long /*
184564977918SWaiman Long * This is racy but we can save the overhead of lock/unlock
184664977918SWaiman Long * calls. The missed objects, if any, should be caught in
184764977918SWaiman Long * the next scan.
184864977918SWaiman Long */
184964977918SWaiman Long if (!color_white(object))
185064977918SWaiman Long continue;
185100c15506SWaiman Long raw_spin_lock_irq(&object->lock);
18524698c1f2SCatalin Marinas if (unreferenced_object(object) &&
18534698c1f2SCatalin Marinas !(object->flags & OBJECT_REPORTED)) {
18544698c1f2SCatalin Marinas object->flags |= OBJECT_REPORTED;
1855154221c3SVincent Whitchurch
1856154221c3SVincent Whitchurch if (kmemleak_verbose)
1857154221c3SVincent Whitchurch print_unreferenced(NULL, object);
1858154221c3SVincent Whitchurch
18594698c1f2SCatalin Marinas new_leaks++;
18604698c1f2SCatalin Marinas }
186100c15506SWaiman Long raw_spin_unlock_irq(&object->lock);
18624698c1f2SCatalin Marinas }
18634698c1f2SCatalin Marinas rcu_read_unlock();
18644698c1f2SCatalin Marinas
1865dc9b3f42SLi Zefan if (new_leaks) {
1866dc9b3f42SLi Zefan kmemleak_found_leaks = true;
1867dc9b3f42SLi Zefan
1868756a025fSJoe Perches pr_info("%d new suspected memory leaks (see /sys/kernel/debug/kmemleak)\n",
1869756a025fSJoe Perches new_leaks);
1870dc9b3f42SLi Zefan }
18714698c1f2SCatalin Marinas
18723c7b4e6bSCatalin Marinas }
18733c7b4e6bSCatalin Marinas
18743c7b4e6bSCatalin Marinas /*
18753c7b4e6bSCatalin Marinas * Thread function performing automatic memory scanning. Unreferenced objects
18763c7b4e6bSCatalin Marinas * at the end of a memory scan are reported but only the first time.
18773c7b4e6bSCatalin Marinas */
kmemleak_scan_thread(void * arg)18783c7b4e6bSCatalin Marinas static int kmemleak_scan_thread(void *arg)
18793c7b4e6bSCatalin Marinas {
1880d53ce042SSri Krishna chowdary static int first_run = IS_ENABLED(CONFIG_DEBUG_KMEMLEAK_AUTO_SCAN);
18813c7b4e6bSCatalin Marinas
1882ae281064SJoe Perches pr_info("Automatic memory scanning thread started\n");
1883bf2a76b3SCatalin Marinas set_user_nice(current, 10);
18843c7b4e6bSCatalin Marinas
18853c7b4e6bSCatalin Marinas /*
18863c7b4e6bSCatalin Marinas * Wait before the first scan to allow the system to fully initialize.
18873c7b4e6bSCatalin Marinas */
18883c7b4e6bSCatalin Marinas if (first_run) {
188984c398ceSEaswar Hariharan signed long timeout = secs_to_jiffies(SECS_FIRST_SCAN);
18903c7b4e6bSCatalin Marinas first_run = 0;
189198c42d94SVegard Nossum while (timeout && !kthread_should_stop())
189298c42d94SVegard Nossum timeout = schedule_timeout_interruptible(timeout);
18933c7b4e6bSCatalin Marinas }
18943c7b4e6bSCatalin Marinas
18953c7b4e6bSCatalin Marinas while (!kthread_should_stop()) {
189654dd200cSYanfei Xu signed long timeout = READ_ONCE(jiffies_scan_wait);
18973c7b4e6bSCatalin Marinas
18983c7b4e6bSCatalin Marinas mutex_lock(&scan_mutex);
18993c7b4e6bSCatalin Marinas kmemleak_scan();
19003c7b4e6bSCatalin Marinas mutex_unlock(&scan_mutex);
19014698c1f2SCatalin Marinas
19023c7b4e6bSCatalin Marinas /* wait before the next scan */
19033c7b4e6bSCatalin Marinas while (timeout && !kthread_should_stop())
19043c7b4e6bSCatalin Marinas timeout = schedule_timeout_interruptible(timeout);
19053c7b4e6bSCatalin Marinas }
19063c7b4e6bSCatalin Marinas
1907ae281064SJoe Perches pr_info("Automatic memory scanning thread ended\n");
19083c7b4e6bSCatalin Marinas
19093c7b4e6bSCatalin Marinas return 0;
19103c7b4e6bSCatalin Marinas }
19113c7b4e6bSCatalin Marinas
19123c7b4e6bSCatalin Marinas /*
19133c7b4e6bSCatalin Marinas * Start the automatic memory scanning thread. This function must be called
19144698c1f2SCatalin Marinas * with the scan_mutex held.
19153c7b4e6bSCatalin Marinas */
start_scan_thread(void)19167eb0d5e5SLuis R. Rodriguez static void start_scan_thread(void)
19173c7b4e6bSCatalin Marinas {
19183c7b4e6bSCatalin Marinas if (scan_thread)
19193c7b4e6bSCatalin Marinas return;
19203c7b4e6bSCatalin Marinas scan_thread = kthread_run(kmemleak_scan_thread, NULL, "kmemleak");
19213c7b4e6bSCatalin Marinas if (IS_ERR(scan_thread)) {
1922598d8091SJoe Perches pr_warn("Failed to create the scan thread\n");
19233c7b4e6bSCatalin Marinas scan_thread = NULL;
19243c7b4e6bSCatalin Marinas }
19253c7b4e6bSCatalin Marinas }
19263c7b4e6bSCatalin Marinas
19273c7b4e6bSCatalin Marinas /*
1928914b6dffSVinayak Menon * Stop the automatic memory scanning thread.
19293c7b4e6bSCatalin Marinas */
stop_scan_thread(void)19307eb0d5e5SLuis R. Rodriguez static void stop_scan_thread(void)
19313c7b4e6bSCatalin Marinas {
19323c7b4e6bSCatalin Marinas if (scan_thread) {
19333c7b4e6bSCatalin Marinas kthread_stop(scan_thread);
19343c7b4e6bSCatalin Marinas scan_thread = NULL;
19353c7b4e6bSCatalin Marinas }
19363c7b4e6bSCatalin Marinas }
19373c7b4e6bSCatalin Marinas
19383c7b4e6bSCatalin Marinas /*
19393c7b4e6bSCatalin Marinas * Iterate over the object_list and return the first valid object at or after
19403c7b4e6bSCatalin Marinas * the required position with its use_count incremented. The function triggers
19413c7b4e6bSCatalin Marinas * a memory scanning when the pos argument points to the first position.
19423c7b4e6bSCatalin Marinas */
kmemleak_seq_start(struct seq_file * seq,loff_t * pos)19433c7b4e6bSCatalin Marinas static void *kmemleak_seq_start(struct seq_file *seq, loff_t *pos)
19443c7b4e6bSCatalin Marinas {
19453c7b4e6bSCatalin Marinas struct kmemleak_object *object;
19463c7b4e6bSCatalin Marinas loff_t n = *pos;
1947b87324d0SCatalin Marinas int err;
1948b87324d0SCatalin Marinas
1949b87324d0SCatalin Marinas err = mutex_lock_interruptible(&scan_mutex);
1950b87324d0SCatalin Marinas if (err < 0)
1951b87324d0SCatalin Marinas return ERR_PTR(err);
19523c7b4e6bSCatalin Marinas
19533c7b4e6bSCatalin Marinas rcu_read_lock();
19543c7b4e6bSCatalin Marinas list_for_each_entry_rcu(object, &object_list, object_list) {
19553c7b4e6bSCatalin Marinas if (n-- > 0)
19563c7b4e6bSCatalin Marinas continue;
19573c7b4e6bSCatalin Marinas if (get_object(object))
19583c7b4e6bSCatalin Marinas goto out;
19593c7b4e6bSCatalin Marinas }
19603c7b4e6bSCatalin Marinas object = NULL;
19613c7b4e6bSCatalin Marinas out:
19623c7b4e6bSCatalin Marinas return object;
19633c7b4e6bSCatalin Marinas }
19643c7b4e6bSCatalin Marinas
19653c7b4e6bSCatalin Marinas /*
19663c7b4e6bSCatalin Marinas * Return the next object in the object_list. The function decrements the
19673c7b4e6bSCatalin Marinas * use_count of the previous object and increases that of the next one.
19683c7b4e6bSCatalin Marinas */
kmemleak_seq_next(struct seq_file * seq,void * v,loff_t * pos)19693c7b4e6bSCatalin Marinas static void *kmemleak_seq_next(struct seq_file *seq, void *v, loff_t *pos)
19703c7b4e6bSCatalin Marinas {
19713c7b4e6bSCatalin Marinas struct kmemleak_object *prev_obj = v;
19723c7b4e6bSCatalin Marinas struct kmemleak_object *next_obj = NULL;
197358fac095SMichael Wang struct kmemleak_object *obj = prev_obj;
19743c7b4e6bSCatalin Marinas
19753c7b4e6bSCatalin Marinas ++(*pos);
19763c7b4e6bSCatalin Marinas
197758fac095SMichael Wang list_for_each_entry_continue_rcu(obj, &object_list, object_list) {
197852c3ce4eSCatalin Marinas if (get_object(obj)) {
197952c3ce4eSCatalin Marinas next_obj = obj;
19803c7b4e6bSCatalin Marinas break;
19813c7b4e6bSCatalin Marinas }
198252c3ce4eSCatalin Marinas }
1983288c857dSCatalin Marinas
19843c7b4e6bSCatalin Marinas put_object(prev_obj);
19853c7b4e6bSCatalin Marinas return next_obj;
19863c7b4e6bSCatalin Marinas }
19873c7b4e6bSCatalin Marinas
19883c7b4e6bSCatalin Marinas /*
19893c7b4e6bSCatalin Marinas * Decrement the use_count of the last object required, if any.
19903c7b4e6bSCatalin Marinas */
kmemleak_seq_stop(struct seq_file * seq,void * v)19913c7b4e6bSCatalin Marinas static void kmemleak_seq_stop(struct seq_file *seq, void *v)
19923c7b4e6bSCatalin Marinas {
1993b87324d0SCatalin Marinas if (!IS_ERR(v)) {
1994b87324d0SCatalin Marinas /*
1995b87324d0SCatalin Marinas * kmemleak_seq_start may return ERR_PTR if the scan_mutex
1996b87324d0SCatalin Marinas * waiting was interrupted, so only release it if !IS_ERR.
1997b87324d0SCatalin Marinas */
1998f5886c7fSCatalin Marinas rcu_read_unlock();
1999b87324d0SCatalin Marinas mutex_unlock(&scan_mutex);
20003c7b4e6bSCatalin Marinas if (v)
20013c7b4e6bSCatalin Marinas put_object(v);
20023c7b4e6bSCatalin Marinas }
2003b87324d0SCatalin Marinas }
20043c7b4e6bSCatalin Marinas
20053c7b4e6bSCatalin Marinas /*
20063c7b4e6bSCatalin Marinas * Print the information for an unreferenced object to the seq file.
20073c7b4e6bSCatalin Marinas */
kmemleak_seq_show(struct seq_file * seq,void * v)20083c7b4e6bSCatalin Marinas static int kmemleak_seq_show(struct seq_file *seq, void *v)
20093c7b4e6bSCatalin Marinas {
20103c7b4e6bSCatalin Marinas struct kmemleak_object *object = v;
20113c7b4e6bSCatalin Marinas unsigned long flags;
20123c7b4e6bSCatalin Marinas
20138c96f1bcSHe Zhe raw_spin_lock_irqsave(&object->lock, flags);
2014288c857dSCatalin Marinas if ((object->flags & OBJECT_REPORTED) && unreferenced_object(object))
20153c7b4e6bSCatalin Marinas print_unreferenced(seq, object);
20168c96f1bcSHe Zhe raw_spin_unlock_irqrestore(&object->lock, flags);
20173c7b4e6bSCatalin Marinas return 0;
20183c7b4e6bSCatalin Marinas }
20193c7b4e6bSCatalin Marinas
20203c7b4e6bSCatalin Marinas static const struct seq_operations kmemleak_seq_ops = {
20213c7b4e6bSCatalin Marinas .start = kmemleak_seq_start,
20223c7b4e6bSCatalin Marinas .next = kmemleak_seq_next,
20233c7b4e6bSCatalin Marinas .stop = kmemleak_seq_stop,
20243c7b4e6bSCatalin Marinas .show = kmemleak_seq_show,
20253c7b4e6bSCatalin Marinas };
20263c7b4e6bSCatalin Marinas
kmemleak_open(struct inode * inode,struct file * file)20273c7b4e6bSCatalin Marinas static int kmemleak_open(struct inode *inode, struct file *file)
20283c7b4e6bSCatalin Marinas {
2029b87324d0SCatalin Marinas return seq_open(file, &kmemleak_seq_ops);
20303c7b4e6bSCatalin Marinas }
20313c7b4e6bSCatalin Marinas
__dump_str_object_info(unsigned long addr,unsigned int objflags)20327ddeb91fSCatalin Marinas static bool __dump_str_object_info(unsigned long addr, unsigned int objflags)
2033189d84edSCatalin Marinas {
2034189d84edSCatalin Marinas unsigned long flags;
2035189d84edSCatalin Marinas struct kmemleak_object *object;
2036189d84edSCatalin Marinas
20377ddeb91fSCatalin Marinas object = __find_and_get_object(addr, 1, objflags);
20387ddeb91fSCatalin Marinas if (!object)
20397ddeb91fSCatalin Marinas return false;
2040189d84edSCatalin Marinas
20418c96f1bcSHe Zhe raw_spin_lock_irqsave(&object->lock, flags);
2042189d84edSCatalin Marinas dump_object_info(object);
20438c96f1bcSHe Zhe raw_spin_unlock_irqrestore(&object->lock, flags);
2044189d84edSCatalin Marinas
2045189d84edSCatalin Marinas put_object(object);
20467ddeb91fSCatalin Marinas
20477ddeb91fSCatalin Marinas return true;
20487ddeb91fSCatalin Marinas }
20497ddeb91fSCatalin Marinas
dump_str_object_info(const char * str)20507ddeb91fSCatalin Marinas static int dump_str_object_info(const char *str)
20517ddeb91fSCatalin Marinas {
20527ddeb91fSCatalin Marinas unsigned long addr;
20537ddeb91fSCatalin Marinas bool found = false;
20547ddeb91fSCatalin Marinas
20557ddeb91fSCatalin Marinas if (kstrtoul(str, 0, &addr))
20567ddeb91fSCatalin Marinas return -EINVAL;
20577ddeb91fSCatalin Marinas
20587ddeb91fSCatalin Marinas found |= __dump_str_object_info(addr, 0);
20597ddeb91fSCatalin Marinas found |= __dump_str_object_info(addr, OBJECT_PHYS);
20607ddeb91fSCatalin Marinas found |= __dump_str_object_info(addr, OBJECT_PERCPU);
20617ddeb91fSCatalin Marinas
20627ddeb91fSCatalin Marinas if (!found) {
20637ddeb91fSCatalin Marinas pr_info("Unknown object at 0x%08lx\n", addr);
20647ddeb91fSCatalin Marinas return -EINVAL;
20657ddeb91fSCatalin Marinas }
20667ddeb91fSCatalin Marinas
2067189d84edSCatalin Marinas return 0;
2068189d84edSCatalin Marinas }
2069189d84edSCatalin Marinas
20703c7b4e6bSCatalin Marinas /*
207130b37101SLuis R. Rodriguez * We use grey instead of black to ensure we can do future scans on the same
207230b37101SLuis R. Rodriguez * objects. If we did not do future scans these black objects could
207330b37101SLuis R. Rodriguez * potentially contain references to newly allocated objects in the future and
207430b37101SLuis R. Rodriguez * we'd end up with false positives.
207530b37101SLuis R. Rodriguez */
kmemleak_clear(void)207630b37101SLuis R. Rodriguez static void kmemleak_clear(void)
207730b37101SLuis R. Rodriguez {
207830b37101SLuis R. Rodriguez struct kmemleak_object *object;
207930b37101SLuis R. Rodriguez
208030b37101SLuis R. Rodriguez rcu_read_lock();
208130b37101SLuis R. Rodriguez list_for_each_entry_rcu(object, &object_list, object_list) {
208200c15506SWaiman Long raw_spin_lock_irq(&object->lock);
208330b37101SLuis R. Rodriguez if ((object->flags & OBJECT_REPORTED) &&
208430b37101SLuis R. Rodriguez unreferenced_object(object))
2085a1084c87SLuis R. Rodriguez __paint_it(object, KMEMLEAK_GREY);
208600c15506SWaiman Long raw_spin_unlock_irq(&object->lock);
208730b37101SLuis R. Rodriguez }
208830b37101SLuis R. Rodriguez rcu_read_unlock();
2089dc9b3f42SLi Zefan
2090dc9b3f42SLi Zefan kmemleak_found_leaks = false;
209130b37101SLuis R. Rodriguez }
209230b37101SLuis R. Rodriguez
2093c89da70cSLi Zefan static void __kmemleak_do_cleanup(void);
2094c89da70cSLi Zefan
209530b37101SLuis R. Rodriguez /*
20963c7b4e6bSCatalin Marinas * File write operation to configure kmemleak at run-time. The following
20973c7b4e6bSCatalin Marinas * commands can be written to the /sys/kernel/debug/kmemleak file:
20983c7b4e6bSCatalin Marinas * off - disable kmemleak (irreversible)
20993c7b4e6bSCatalin Marinas * stack=on - enable the task stacks scanning
21003c7b4e6bSCatalin Marinas * stack=off - disable the tasks stacks scanning
21013c7b4e6bSCatalin Marinas * scan=on - start the automatic memory scanning thread
21023c7b4e6bSCatalin Marinas * scan=off - stop the automatic memory scanning thread
21033c7b4e6bSCatalin Marinas * scan=... - set the automatic memory scanning period in seconds (0 to
21043c7b4e6bSCatalin Marinas * disable it)
21054698c1f2SCatalin Marinas * scan - trigger a memory scan
210630b37101SLuis R. Rodriguez * clear - mark all current reported unreferenced kmemleak objects as
2107c89da70cSLi Zefan * grey to ignore printing them, or free all kmemleak objects
2108c89da70cSLi Zefan * if kmemleak has been disabled.
2109189d84edSCatalin Marinas * dump=... - dump information about the object found at the given address
21103c7b4e6bSCatalin Marinas */
kmemleak_write(struct file * file,const char __user * user_buf,size_t size,loff_t * ppos)21113c7b4e6bSCatalin Marinas static ssize_t kmemleak_write(struct file *file, const char __user *user_buf,
21123c7b4e6bSCatalin Marinas size_t size, loff_t *ppos)
21133c7b4e6bSCatalin Marinas {
21143c7b4e6bSCatalin Marinas char buf[64];
21153c7b4e6bSCatalin Marinas int buf_size;
2116b87324d0SCatalin Marinas int ret;
21173c7b4e6bSCatalin Marinas
21183c7b4e6bSCatalin Marinas buf_size = min(size, (sizeof(buf) - 1));
21193c7b4e6bSCatalin Marinas if (strncpy_from_user(buf, user_buf, buf_size) < 0)
21203c7b4e6bSCatalin Marinas return -EFAULT;
21213c7b4e6bSCatalin Marinas buf[buf_size] = 0;
21223c7b4e6bSCatalin Marinas
2123b87324d0SCatalin Marinas ret = mutex_lock_interruptible(&scan_mutex);
2124b87324d0SCatalin Marinas if (ret < 0)
2125b87324d0SCatalin Marinas return ret;
2126b87324d0SCatalin Marinas
2127c89da70cSLi Zefan if (strncmp(buf, "clear", 5) == 0) {
21288910ae89SLi Zefan if (kmemleak_enabled)
2129c89da70cSLi Zefan kmemleak_clear();
2130c89da70cSLi Zefan else
2131c89da70cSLi Zefan __kmemleak_do_cleanup();
2132c89da70cSLi Zefan goto out;
2133c89da70cSLi Zefan }
2134c89da70cSLi Zefan
21358910ae89SLi Zefan if (!kmemleak_enabled) {
21364e4dfce2SAndré Almeida ret = -EPERM;
2137c89da70cSLi Zefan goto out;
2138c89da70cSLi Zefan }
2139c89da70cSLi Zefan
21403c7b4e6bSCatalin Marinas if (strncmp(buf, "off", 3) == 0)
21413c7b4e6bSCatalin Marinas kmemleak_disable();
21423c7b4e6bSCatalin Marinas else if (strncmp(buf, "stack=on", 8) == 0)
21433c7b4e6bSCatalin Marinas kmemleak_stack_scan = 1;
21443c7b4e6bSCatalin Marinas else if (strncmp(buf, "stack=off", 9) == 0)
21453c7b4e6bSCatalin Marinas kmemleak_stack_scan = 0;
21463c7b4e6bSCatalin Marinas else if (strncmp(buf, "scan=on", 7) == 0)
21473c7b4e6bSCatalin Marinas start_scan_thread();
21483c7b4e6bSCatalin Marinas else if (strncmp(buf, "scan=off", 8) == 0)
21493c7b4e6bSCatalin Marinas stop_scan_thread();
21503c7b4e6bSCatalin Marinas else if (strncmp(buf, "scan=", 5) == 0) {
215154dd200cSYanfei Xu unsigned secs;
215254dd200cSYanfei Xu unsigned long msecs;
21533c7b4e6bSCatalin Marinas
215454dd200cSYanfei Xu ret = kstrtouint(buf + 5, 0, &secs);
2155b87324d0SCatalin Marinas if (ret < 0)
2156b87324d0SCatalin Marinas goto out;
215754dd200cSYanfei Xu
215854dd200cSYanfei Xu msecs = secs * MSEC_PER_SEC;
215954dd200cSYanfei Xu if (msecs > UINT_MAX)
216054dd200cSYanfei Xu msecs = UINT_MAX;
216154dd200cSYanfei Xu
21623c7b4e6bSCatalin Marinas stop_scan_thread();
216354dd200cSYanfei Xu if (msecs) {
216454dd200cSYanfei Xu WRITE_ONCE(jiffies_scan_wait, msecs_to_jiffies(msecs));
21653c7b4e6bSCatalin Marinas start_scan_thread();
21663c7b4e6bSCatalin Marinas }
21674698c1f2SCatalin Marinas } else if (strncmp(buf, "scan", 4) == 0)
21684698c1f2SCatalin Marinas kmemleak_scan();
2169189d84edSCatalin Marinas else if (strncmp(buf, "dump=", 5) == 0)
2170189d84edSCatalin Marinas ret = dump_str_object_info(buf + 5);
21714698c1f2SCatalin Marinas else
2172b87324d0SCatalin Marinas ret = -EINVAL;
2173b87324d0SCatalin Marinas
2174b87324d0SCatalin Marinas out:
2175b87324d0SCatalin Marinas mutex_unlock(&scan_mutex);
2176b87324d0SCatalin Marinas if (ret < 0)
2177b87324d0SCatalin Marinas return ret;
21783c7b4e6bSCatalin Marinas
21793c7b4e6bSCatalin Marinas /* ignore the rest of the buffer, only one command at a time */
21803c7b4e6bSCatalin Marinas *ppos += size;
21813c7b4e6bSCatalin Marinas return size;
21823c7b4e6bSCatalin Marinas }
21833c7b4e6bSCatalin Marinas
21843c7b4e6bSCatalin Marinas static const struct file_operations kmemleak_fops = {
21853c7b4e6bSCatalin Marinas .owner = THIS_MODULE,
21863c7b4e6bSCatalin Marinas .open = kmemleak_open,
21873c7b4e6bSCatalin Marinas .read = seq_read,
21883c7b4e6bSCatalin Marinas .write = kmemleak_write,
21893c7b4e6bSCatalin Marinas .llseek = seq_lseek,
21905f3bf19aSLi Zefan .release = seq_release,
21913c7b4e6bSCatalin Marinas };
21923c7b4e6bSCatalin Marinas
__kmemleak_do_cleanup(void)2193c89da70cSLi Zefan static void __kmemleak_do_cleanup(void)
2194c89da70cSLi Zefan {
21952abd839aSCatalin Marinas struct kmemleak_object *object, *tmp;
2196d1534ae2SWaiman Long unsigned int cnt = 0;
2197c89da70cSLi Zefan
21982abd839aSCatalin Marinas /*
21992abd839aSCatalin Marinas * Kmemleak has already been disabled, no need for RCU list traversal
22002abd839aSCatalin Marinas * or kmemleak_lock held.
22012abd839aSCatalin Marinas */
22022abd839aSCatalin Marinas list_for_each_entry_safe(object, tmp, &object_list, object_list) {
22032abd839aSCatalin Marinas __remove_object(object);
22042abd839aSCatalin Marinas __delete_object(object);
2205d1534ae2SWaiman Long
2206d1534ae2SWaiman Long /* Call cond_resched() once per 64 iterations to avoid soft lockup */
2207d1534ae2SWaiman Long if (!(++cnt & 0x3f))
2208d1534ae2SWaiman Long cond_resched();
22092abd839aSCatalin Marinas }
2210c89da70cSLi Zefan }
2211c89da70cSLi Zefan
22123c7b4e6bSCatalin Marinas /*
221374341703SCatalin Marinas * Stop the memory scanning thread and free the kmemleak internal objects if
221474341703SCatalin Marinas * no previous scan thread (otherwise, kmemleak may still have some useful
221574341703SCatalin Marinas * information on memory leaks).
22163c7b4e6bSCatalin Marinas */
kmemleak_do_cleanup(struct work_struct * work)2217179a8100SCatalin Marinas static void kmemleak_do_cleanup(struct work_struct *work)
22183c7b4e6bSCatalin Marinas {
22194698c1f2SCatalin Marinas stop_scan_thread();
22204698c1f2SCatalin Marinas
2221914b6dffSVinayak Menon mutex_lock(&scan_mutex);
2222c5f3b1a5SCatalin Marinas /*
2223914b6dffSVinayak Menon * Once it is made sure that kmemleak_scan has stopped, it is safe to no
2224914b6dffSVinayak Menon * longer track object freeing. Ordering of the scan thread stopping and
2225914b6dffSVinayak Menon * the memory accesses below is guaranteed by the kthread_stop()
2226914b6dffSVinayak Menon * function.
2227c5f3b1a5SCatalin Marinas */
2228c5f3b1a5SCatalin Marinas kmemleak_free_enabled = 0;
2229914b6dffSVinayak Menon mutex_unlock(&scan_mutex);
2230c5f3b1a5SCatalin Marinas
2231c89da70cSLi Zefan if (!kmemleak_found_leaks)
2232c89da70cSLi Zefan __kmemleak_do_cleanup();
2233c89da70cSLi Zefan else
2234756a025fSJoe Perches pr_info("Kmemleak disabled without freeing internal data. Reclaim the memory with \"echo clear > /sys/kernel/debug/kmemleak\".\n");
22353c7b4e6bSCatalin Marinas }
22363c7b4e6bSCatalin Marinas
2237179a8100SCatalin Marinas static DECLARE_WORK(cleanup_work, kmemleak_do_cleanup);
22383c7b4e6bSCatalin Marinas
22393c7b4e6bSCatalin Marinas /*
22403c7b4e6bSCatalin Marinas * Disable kmemleak. No memory allocation/freeing will be traced once this
22413c7b4e6bSCatalin Marinas * function is called. Disabling kmemleak is an irreversible operation.
22423c7b4e6bSCatalin Marinas */
kmemleak_disable(void)22433c7b4e6bSCatalin Marinas static void kmemleak_disable(void)
22443c7b4e6bSCatalin Marinas {
22453c7b4e6bSCatalin Marinas /* atomically check whether it was already invoked */
22468910ae89SLi Zefan if (cmpxchg(&kmemleak_error, 0, 1))
22473c7b4e6bSCatalin Marinas return;
22483c7b4e6bSCatalin Marinas
22493c7b4e6bSCatalin Marinas /* stop any memory operation tracing */
22508910ae89SLi Zefan kmemleak_enabled = 0;
22513c7b4e6bSCatalin Marinas
22523c7b4e6bSCatalin Marinas /* check whether it is too early for a kernel thread */
2253d160ef71SXiaolei Wang if (kmemleak_late_initialized)
2254179a8100SCatalin Marinas schedule_work(&cleanup_work);
2255c5f3b1a5SCatalin Marinas else
2256c5f3b1a5SCatalin Marinas kmemleak_free_enabled = 0;
22573c7b4e6bSCatalin Marinas
22583c7b4e6bSCatalin Marinas pr_info("Kernel memory leak detector disabled\n");
22593c7b4e6bSCatalin Marinas }
22603c7b4e6bSCatalin Marinas
22613c7b4e6bSCatalin Marinas /*
22623c7b4e6bSCatalin Marinas * Allow boot-time kmemleak disabling (enabled by default).
22633c7b4e6bSCatalin Marinas */
kmemleak_boot_config(char * str)22648bd30c10SDou Liyang static int __init kmemleak_boot_config(char *str)
22653c7b4e6bSCatalin Marinas {
22663c7b4e6bSCatalin Marinas if (!str)
22673c7b4e6bSCatalin Marinas return -EINVAL;
22683c7b4e6bSCatalin Marinas if (strcmp(str, "off") == 0)
22693c7b4e6bSCatalin Marinas kmemleak_disable();
2270993f57e0SZhaoyang Huang else if (strcmp(str, "on") == 0) {
2271ab0155a2SJason Baron kmemleak_skip_disable = 1;
22721c0310adSAndrey Konovalov stack_depot_request_early_init();
2273993f57e0SZhaoyang Huang }
2274ab0155a2SJason Baron else
22753c7b4e6bSCatalin Marinas return -EINVAL;
22763c7b4e6bSCatalin Marinas return 0;
22773c7b4e6bSCatalin Marinas }
22783c7b4e6bSCatalin Marinas early_param("kmemleak", kmemleak_boot_config);
22793c7b4e6bSCatalin Marinas
22803c7b4e6bSCatalin Marinas /*
22812030117dSCatalin Marinas * Kmemleak initialization.
22823c7b4e6bSCatalin Marinas */
kmemleak_init(void)22833c7b4e6bSCatalin Marinas void __init kmemleak_init(void)
22843c7b4e6bSCatalin Marinas {
2285ab0155a2SJason Baron #ifdef CONFIG_DEBUG_KMEMLEAK_DEFAULT_OFF
2286ab0155a2SJason Baron if (!kmemleak_skip_disable) {
2287ab0155a2SJason Baron kmemleak_disable();
2288ab0155a2SJason Baron return;
2289ab0155a2SJason Baron }
2290ab0155a2SJason Baron #endif
2291ab0155a2SJason Baron
2292c5665868SCatalin Marinas if (kmemleak_error)
2293c5665868SCatalin Marinas return;
2294c5665868SCatalin Marinas
22953c7b4e6bSCatalin Marinas jiffies_min_age = msecs_to_jiffies(MSECS_MIN_AGE);
229684c398ceSEaswar Hariharan jiffies_scan_wait = secs_to_jiffies(SECS_SCAN_WAIT);
22973c7b4e6bSCatalin Marinas
22983c7b4e6bSCatalin Marinas object_cache = KMEM_CACHE(kmemleak_object, SLAB_NOLEAKTRACE);
22993c7b4e6bSCatalin Marinas scan_area_cache = KMEM_CACHE(kmemleak_scan_area, SLAB_NOLEAKTRACE);
23003c7b4e6bSCatalin Marinas
2301298a32b1SCatalin Marinas /* register the data/bss sections */
2302298a32b1SCatalin Marinas create_object((unsigned long)_sdata, _edata - _sdata,
2303298a32b1SCatalin Marinas KMEMLEAK_GREY, GFP_ATOMIC);
2304298a32b1SCatalin Marinas create_object((unsigned long)__bss_start, __bss_stop - __bss_start,
2305298a32b1SCatalin Marinas KMEMLEAK_GREY, GFP_ATOMIC);
2306298a32b1SCatalin Marinas /* only register .data..ro_after_init if not within .data */
2307b0d14fc4SNathan Chancellor if (&__start_ro_after_init < &_sdata || &__end_ro_after_init > &_edata)
2308298a32b1SCatalin Marinas create_object((unsigned long)__start_ro_after_init,
2309298a32b1SCatalin Marinas __end_ro_after_init - __start_ro_after_init,
2310298a32b1SCatalin Marinas KMEMLEAK_GREY, GFP_ATOMIC);
23113c7b4e6bSCatalin Marinas }
23123c7b4e6bSCatalin Marinas
23133c7b4e6bSCatalin Marinas /*
23143c7b4e6bSCatalin Marinas * Late initialization function.
23153c7b4e6bSCatalin Marinas */
kmemleak_late_init(void)23163c7b4e6bSCatalin Marinas static int __init kmemleak_late_init(void)
23173c7b4e6bSCatalin Marinas {
2318d160ef71SXiaolei Wang kmemleak_late_initialized = 1;
23193c7b4e6bSCatalin Marinas
2320282401dfSGreg Kroah-Hartman debugfs_create_file("kmemleak", 0644, NULL, NULL, &kmemleak_fops);
2321b353756bSVincent Whitchurch
23228910ae89SLi Zefan if (kmemleak_error) {
23233c7b4e6bSCatalin Marinas /*
232425985edcSLucas De Marchi * Some error occurred and kmemleak was disabled. There is a
23253c7b4e6bSCatalin Marinas * small chance that kmemleak_disable() was called immediately
2326d160ef71SXiaolei Wang * after setting kmemleak_late_initialized and we may end up with
23273c7b4e6bSCatalin Marinas * two clean-up threads but serialized by scan_mutex.
23283c7b4e6bSCatalin Marinas */
2329179a8100SCatalin Marinas schedule_work(&cleanup_work);
23303c7b4e6bSCatalin Marinas return -ENOMEM;
23313c7b4e6bSCatalin Marinas }
23323c7b4e6bSCatalin Marinas
2333d53ce042SSri Krishna chowdary if (IS_ENABLED(CONFIG_DEBUG_KMEMLEAK_AUTO_SCAN)) {
23344698c1f2SCatalin Marinas mutex_lock(&scan_mutex);
23353c7b4e6bSCatalin Marinas start_scan_thread();
23364698c1f2SCatalin Marinas mutex_unlock(&scan_mutex);
2337d53ce042SSri Krishna chowdary }
23383c7b4e6bSCatalin Marinas
23390e965a6bSQian Cai pr_info("Kernel memory leak detector initialized (mem pool available: %d)\n",
23400e965a6bSQian Cai mem_pool_free_count);
23413c7b4e6bSCatalin Marinas
23423c7b4e6bSCatalin Marinas return 0;
23433c7b4e6bSCatalin Marinas }
23443c7b4e6bSCatalin Marinas late_initcall(kmemleak_late_init);
2345