mm: allow memory hotplug and hibernation in the same kernel
[safe/jmp/linux-2.6] / mm / kmemleak.c
index 8172154..8bf765c 100644 (file)
 #include <linux/string.h>
 #include <linux/nodemask.h>
 #include <linux/mm.h>
+#include <linux/workqueue.h>
 
 #include <asm/sections.h>
 #include <asm/processor.h>
 #include <asm/atomic.h>
 
+#include <linux/kmemcheck.h>
 #include <linux/kmemleak.h>
 
 /*
@@ -121,6 +123,9 @@ struct kmemleak_scan_area {
        size_t length;
 };
 
+#define KMEMLEAK_GREY  0
+#define KMEMLEAK_BLACK -1
+
 /*
  * Structure holding the metadata for each allocated memory block.
  * Modifications to such objects should be made while holding the
@@ -162,6 +167,15 @@ struct kmemleak_object {
 /* flag set on newly allocated objects */
 #define OBJECT_NEW             (1 << 3)
 
+/* number of bytes to print per line; must be 16 or 32 */
+#define HEX_ROW_SIZE           16
+/* number of bytes to print at a time (1, 2, 4, 8) */
+#define HEX_GROUP_SIZE         1
+/* include ASCII after the hex output */
+#define HEX_ASCII              1
+/* max number of lines to be printed */
+#define HEX_MAX_LINES          2
+
 /* the list of all allocated objects */
 static LIST_HEAD(object_list);
 /* the list of gray-colored objects (see color_gray comment below) */
@@ -259,6 +273,35 @@ static void kmemleak_disable(void);
 } while (0)
 
 /*
+ * Printing of the objects hex dump to the seq file. The number of lines to be
+ * printed is limited to HEX_MAX_LINES to prevent seq file spamming. The
+ * actual number of printed bytes depends on HEX_ROW_SIZE. It must be called
+ * with the object->lock held.
+ */
+static void hex_dump_object(struct seq_file *seq,
+                           struct kmemleak_object *object)
+{
+       const u8 *ptr = (const u8 *)object->pointer;
+       int i, len, remaining;
+       unsigned char linebuf[HEX_ROW_SIZE * 5];
+
+       /* limit the number of lines to HEX_MAX_LINES */
+       remaining = len =
+               min(object->size, (size_t)(HEX_MAX_LINES * HEX_ROW_SIZE));
+
+       seq_printf(seq, "  hex dump (first %d bytes):\n", len);
+       for (i = 0; i < len; i += HEX_ROW_SIZE) {
+               int linelen = min(remaining, HEX_ROW_SIZE);
+
+               remaining -= HEX_ROW_SIZE;
+               hex_dump_to_buffer(ptr + i, linelen, HEX_ROW_SIZE,
+                                  HEX_GROUP_SIZE, linebuf, sizeof(linebuf),
+                                  HEX_ASCII);
+               seq_printf(seq, "    %s\n", linebuf);
+       }
+}
+
+/*
  * Object colors, encoded with count and min_count:
  * - white - orphan object, not enough references to it (count < min_count)
  * - gray  - not orphan, not marked as false positive (min_count == 0) or
@@ -268,19 +311,21 @@ static void kmemleak_disable(void);
  * Newly created objects don't have any color assigned (object->count == -1)
  * before the next memory scan when they become white.
  */
-static int color_white(const struct kmemleak_object *object)
+static bool color_white(const struct kmemleak_object *object)
 {
-       return object->count != -1 && object->count < object->min_count;
+       return object->count != KMEMLEAK_BLACK &&
+               object->count < object->min_count;
 }
 
-static int color_gray(const struct kmemleak_object *object)
+static bool color_gray(const struct kmemleak_object *object)
 {
-       return object->min_count != -1 && object->count >= object->min_count;
+       return object->min_count != KMEMLEAK_BLACK &&
+               object->count >= object->min_count;
 }
 
-static int color_black(const struct kmemleak_object *object)
+static bool color_black(const struct kmemleak_object *object)
 {
-       return object->min_count == -1;
+       return object->min_count == KMEMLEAK_BLACK;
 }
 
 /*
@@ -288,7 +333,7 @@ static int color_black(const struct kmemleak_object *object)
  * not be deleted and have a minimum age to avoid false positives caused by
  * pointers temporarily stored in CPU registers.
  */
-static int unreferenced_object(struct kmemleak_object *object)
+static bool unreferenced_object(struct kmemleak_object *object)
 {
        return (object->flags & OBJECT_ALLOCATED) && color_white(object) &&
                time_before_eq(object->jiffies + jiffies_min_age,
@@ -308,6 +353,7 @@ static void print_unreferenced(struct seq_file *seq,
                   object->pointer, object->size);
        seq_printf(seq, "  comm \"%s\", pid %d, jiffies %lu\n",
                   object->comm, object->pid, object->jiffies);
+       hex_dump_object(seq, object);
        seq_printf(seq, "  backtrace:\n");
 
        for (i = 0; i < object->trace_len; i++) {
@@ -509,6 +555,7 @@ static struct kmemleak_object *create_object(unsigned long ptr, size_t size,
        object->tree_node.last = ptr + size - 1;
 
        write_lock_irqsave(&kmemleak_lock, flags);
+
        min_addr = min(min_addr, ptr);
        max_addr = max(max_addr, ptr + size);
        node = prio_tree_insert(&object_tree_root, &object->tree_node);
@@ -519,14 +566,12 @@ static struct kmemleak_object *create_object(unsigned long ptr, size_t size,
         * random memory blocks.
         */
        if (node != &object->tree_node) {
-               unsigned long flags;
-
                kmemleak_stop("Cannot insert 0x%lx into the object search tree "
                              "(already existing)\n", ptr);
                object = lookup_object(ptr, 1);
-               spin_lock_irqsave(&object->lock, flags);
+               spin_lock(&object->lock);
                dump_object_info(object);
-               spin_unlock_irqrestore(&object->lock, flags);
+               spin_unlock(&object->lock);
 
                goto out;
        }
@@ -620,47 +665,55 @@ static void delete_object_part(unsigned long ptr, size_t size)
 
        put_object(object);
 }
-/*
- * Make a object permanently as gray-colored so that it can no longer be
- * reported as a leak. This is used in general to mark a false positive.
- */
-static void make_gray_object(unsigned long ptr)
+
+static void __paint_it(struct kmemleak_object *object, int color)
+{
+       object->min_count = color;
+       if (color == KMEMLEAK_BLACK)
+               object->flags |= OBJECT_NO_SCAN;
+}
+
+static void paint_it(struct kmemleak_object *object, int color)
 {
        unsigned long flags;
+
+       spin_lock_irqsave(&object->lock, flags);
+       __paint_it(object, color);
+       spin_unlock_irqrestore(&object->lock, flags);
+}
+
+static void paint_ptr(unsigned long ptr, int color)
+{
        struct kmemleak_object *object;
 
        object = find_and_get_object(ptr, 0);
        if (!object) {
-               kmemleak_warn("Graying unknown object at 0x%08lx\n", ptr);
+               kmemleak_warn("Trying to color unknown object "
+                             "at 0x%08lx as %s\n", ptr,
+                             (color == KMEMLEAK_GREY) ? "Grey" :
+                             (color == KMEMLEAK_BLACK) ? "Black" : "Unknown");
                return;
        }
-
-       spin_lock_irqsave(&object->lock, flags);
-       object->min_count = 0;
-       spin_unlock_irqrestore(&object->lock, flags);
+       paint_it(object, color);
        put_object(object);
 }
 
 /*
+ * Make a object permanently as gray-colored so that it can no longer be
+ * reported as a leak. This is used in general to mark a false positive.
+ */
+static void make_gray_object(unsigned long ptr)
+{
+       paint_ptr(ptr, KMEMLEAK_GREY);
+}
+
+/*
  * Mark the object as black-colored so that it is ignored from scans and
  * reporting.
  */
 static void make_black_object(unsigned long ptr)
 {
-       unsigned long flags;
-       struct kmemleak_object *object;
-
-       object = find_and_get_object(ptr, 0);
-       if (!object) {
-               kmemleak_warn("Blacking unknown object at 0x%08lx\n", ptr);
-               return;
-       }
-
-       spin_lock_irqsave(&object->lock, flags);
-       object->min_count = -1;
-       object->flags |= OBJECT_NO_SCAN;
-       spin_unlock_irqrestore(&object->lock, flags);
-       put_object(object);
+       paint_ptr(ptr, KMEMLEAK_BLACK);
 }
 
 /*
@@ -739,7 +792,8 @@ static void __init log_early(int op_type, const void *ptr, size_t size,
        struct early_log *log;
 
        if (crt_early_log >= ARRAY_SIZE(early_log)) {
-               pr_warning("Early log buffer exceeded\n");
+               pr_warning("Early log buffer exceeded, "
+                          "please increase DEBUG_KMEMLEAK_EARLY_LOG_SIZE\n");
                kmemleak_disable();
                return;
        }
@@ -779,12 +833,15 @@ static void early_alloc(struct early_log *log)
         */
        rcu_read_lock();
        object = create_object((unsigned long)log->ptr, log->size,
-                              log->min_count, GFP_KERNEL);
+                              log->min_count, GFP_ATOMIC);
+       if (!object)
+               goto out;
        spin_lock_irqsave(&object->lock, flags);
        for (i = 0; i < log->trace_len; i++)
                object->trace[i] = log->trace[i];
        object->trace_len = log->trace_len;
        spin_unlock_irqrestore(&object->lock, flags);
+out:
        rcu_read_unlock();
 }
 
@@ -928,15 +985,22 @@ static void scan_block(void *_start, void *_end,
        unsigned long *end = _end - (BYTES_PER_POINTER - 1);
 
        for (ptr = start; ptr < end; ptr++) {
-               unsigned long flags;
-               unsigned long pointer = *ptr;
                struct kmemleak_object *object;
+               unsigned long flags;
+               unsigned long pointer;
 
                if (allow_resched)
                        cond_resched();
                if (scan_should_stop())
                        break;
 
+               /* don't scan uninitialized memory */
+               if (!kmemcheck_is_obj_initialized((unsigned long)ptr,
+                                                 BYTES_PER_POINTER))
+                       continue;
+
+               pointer = *ptr;
+
                object = find_and_get_object(pointer, 1);
                if (!object)
                        continue;
@@ -1027,7 +1091,6 @@ static void kmemleak_scan(void)
 {
        unsigned long flags;
        struct kmemleak_object *object, *tmp;
-       struct task_struct *task;
        int i;
        int new_leaks = 0;
        int gray_list_pass = 0;
@@ -1094,15 +1157,16 @@ static void kmemleak_scan(void)
        }
 
        /*
-        * Scanning the task stacks may introduce false negatives and it is
-        * not enabled by default.
+        * Scanning the task stacks (may introduce false negatives).
         */
        if (kmemleak_stack_scan) {
+               struct task_struct *p, *g;
+
                read_lock(&tasklist_lock);
-               for_each_process(task)
-                       scan_block(task_stack_page(task),
-                                  task_stack_page(task) + THREAD_SIZE,
-                                  NULL, 0);
+               do_each_thread(g, p) {
+                       scan_block(task_stack_page(p), task_stack_page(p) +
+                                  THREAD_SIZE, NULL, 0);
+               } while_each_thread(g, p);
                read_unlock(&tasklist_lock);
        }
 
@@ -1227,7 +1291,7 @@ static int kmemleak_scan_thread(void *arg)
  * Start the automatic memory scanning thread. This function must be called
  * with the scan_mutex held.
  */
-void start_scan_thread(void)
+static void start_scan_thread(void)
 {
        if (scan_thread)
                return;
@@ -1242,7 +1306,7 @@ void start_scan_thread(void)
  * Stop the automatic memory scanning thread. This function must be called
  * with the scan_mutex held.
  */
-void stop_scan_thread(void)
+static void stop_scan_thread(void)
 {
        if (scan_thread) {
                kthread_stop(scan_thread);
@@ -1373,6 +1437,28 @@ static int dump_str_object_info(const char *str)
 }
 
 /*
+ * We use grey instead of black to ensure we can do future scans on the same
+ * objects. If we did not do future scans these black objects could
+ * potentially contain references to newly allocated objects in the future and
+ * we'd end up with false positives.
+ */
+static void kmemleak_clear(void)
+{
+       struct kmemleak_object *object;
+       unsigned long flags;
+
+       rcu_read_lock();
+       list_for_each_entry_rcu(object, &object_list, object_list) {
+               spin_lock_irqsave(&object->lock, flags);
+               if ((object->flags & OBJECT_REPORTED) &&
+                   unreferenced_object(object))
+                       __paint_it(object, KMEMLEAK_GREY);
+               spin_unlock_irqrestore(&object->lock, flags);
+       }
+       rcu_read_unlock();
+}
+
+/*
  * File write operation to configure kmemleak at run-time. The following
  * commands can be written to the /sys/kernel/debug/kmemleak file:
  *   off       - disable kmemleak (irreversible)
@@ -1383,6 +1469,8 @@ static int dump_str_object_info(const char *str)
  *   scan=...  - set the automatic memory scanning period in seconds (0 to
  *               disable it)
  *   scan      - trigger a memory scan
+ *   clear     - mark all current reported unreferenced kmemleak objects as
+ *               grey to ignore printing them
  *   dump=...  - dump information about the object found at the given address
  */
 static ssize_t kmemleak_write(struct file *file, const char __user *user_buf,
@@ -1424,6 +1512,8 @@ static ssize_t kmemleak_write(struct file *file, const char __user *user_buf,
                }
        } else if (strncmp(buf, "scan", 4) == 0)
                kmemleak_scan();
+       else if (strncmp(buf, "clear", 5) == 0)
+               kmemleak_clear();
        else if (strncmp(buf, "dump=", 5) == 0)
                ret = dump_str_object_info(buf + 5);
        else
@@ -1452,7 +1542,7 @@ static const struct file_operations kmemleak_fops = {
  * Perform the freeing of the kmemleak internal objects after waiting for any
  * current memory scan to complete.
  */
-static int kmemleak_cleanup_thread(void *arg)
+static void kmemleak_do_cleanup(struct work_struct *work)
 {
        struct kmemleak_object *object;
 
@@ -1464,22 +1554,9 @@ static int kmemleak_cleanup_thread(void *arg)
                delete_object_full(object->pointer);
        rcu_read_unlock();
        mutex_unlock(&scan_mutex);
-
-       return 0;
 }
 
-/*
- * Start the clean-up thread.
- */
-static void kmemleak_cleanup(void)
-{
-       struct task_struct *cleanup_thread;
-
-       cleanup_thread = kthread_run(kmemleak_cleanup_thread, NULL,
-                                    "kmemleak-clean");
-       if (IS_ERR(cleanup_thread))
-               pr_warning("Failed to create the clean-up thread\n");
-}
+static DECLARE_WORK(cleanup_work, kmemleak_do_cleanup);
 
 /*
  * Disable kmemleak. No memory allocation/freeing will be traced once this
@@ -1497,7 +1574,7 @@ static void kmemleak_disable(void)
 
        /* check whether it is too early for a kernel thread */
        if (atomic_read(&kmemleak_initialized))
-               kmemleak_cleanup();
+               schedule_work(&cleanup_work);
 
        pr_info("Kernel memory leak detector disabled\n");
 }
@@ -1593,7 +1670,7 @@ static int __init kmemleak_late_init(void)
                 * after setting kmemleak_initialized and we may end up with
                 * two clean-up threads but serialized by scan_mutex.
                 */
-               kmemleak_cleanup();
+               schedule_work(&cleanup_work);
                return -ENOMEM;
        }