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