perf symbols: Simplify symbol machinery setup

And also express its configuration toggles via a struct.

Now all one has to do is to call symbol__init(NULL) if the
defaults are OK, or pass a struct symbol_conf pointer with the
desired configuration.

If a tool uses kernel_maps__find_symbol() to look at the kernel
and modules mappings for a symbol but didn't call symbol__init()
first, that will generate a one time warning too, alerting the
subcommand developer that symbol__init() must be called.

Signed-off-by: Arnaldo Carvalho de Melo <acme@redhat.com>
Cc: Frédéric Weisbecker <fweisbec@gmail.com>
Cc: Mike Galbraith <efault@gmx.de>
Cc: Peter Zijlstra <a.p.zijlstra@chello.nl>
Cc: Paul Mackerras <paulus@samba.org>
LKML-Reference: <1259071517-3242-2-git-send-email-acme@infradead.org>
Signed-off-by: Ingo Molnar <mingo@elte.hu>

12 files changed, 85 insertions, 60 deletions

diff --git a/tools/perf/builtin-annotate.c b/tools/perf/builtin-annotate.c
index 59b6123abec2..cd97c2b1cc3b 100644
--- a/tools/perf/builtin-annotate.c
+++ b/tools/perf/builtin-annotate.c
@@ -34,11 +34,9 @@ static int		input;
 static int              full_paths;
 
 static int              print_line;
-static bool             use_modules;
 
 static unsigned long    page_size;
 static unsigned long    mmap_window = 32;
-const char              *vmlinux_name;
 
 struct sym_hist {
         u64             sum;
@@ -56,6 +54,11 @@ struct sym_priv {
         struct sym_ext  *ext;
 };
 
+static struct symbol_conf symbol_conf = {
+        .priv_size        = sizeof(struct sym_priv),
+        .try_vmlinux_path = true,
+};
+
 static const char *sym_hist_filter;
 
 static int symbol_filter(struct map *map __used, struct symbol *sym)
@@ -586,11 +589,6 @@ static int __cmd_annotate(void)
                 exit(0);
         }
 
-        if (kernel_maps__init(vmlinux_name, true, use_modules) < 0) {
-                pr_err("failed to create kernel maps for symbol resolution\b");
-                return -1;
-        }
-
 remap:
         buf = (char *)mmap(NULL, page_size * mmap_window, PROT_READ,
                            MAP_SHARED, input, offset);
@@ -691,8 +689,9 @@ static const struct option options[] = {
                     "be more verbose (show symbol address, etc)"),
         OPT_BOOLEAN('D', "dump-raw-trace", &dump_trace,
                     "dump raw trace in ASCII"),
-        OPT_STRING('k', "vmlinux", &vmlinux_name, "file", "vmlinux pathname"),
-        OPT_BOOLEAN('m', "modules", &use_modules,
+        OPT_STRING('k', "vmlinux", &symbol_conf.vmlinux_name,
+                   "file", "vmlinux pathname"),
+        OPT_BOOLEAN('m', "modules", &symbol_conf.use_modules,
                     "load module symbols - WARNING: use only with -k and LIVE kernel"),
         OPT_BOOLEAN('l', "print-line", &print_line,
                     "print matching source lines (may be slow)"),
@@ -718,7 +717,8 @@ static void setup_sorting(void)
 
 int cmd_annotate(int argc, const char **argv, const char *prefix __used)
 {
-        symbol__init(sizeof(struct sym_priv));
+        if (symbol__init(&symbol_conf) < 0)
+                return -1;
 
         page_size = getpagesize();
 
diff --git a/tools/perf/builtin-kmem.c b/tools/perf/builtin-kmem.c
index 173d6db42ecb..330dbc762f9e 100644
--- a/tools/perf/builtin-kmem.c
+++ b/tools/perf/builtin-kmem.c
@@ -412,7 +412,7 @@ static int read_events(void)
         register_idle_thread();
         register_perf_file_handler(&file_handler);
 
-        return mmap_dispatch_perf_file(&header, input_name, NULL, false, 0, 0,
+        return mmap_dispatch_perf_file(&header, input_name, 0, 0,
                                        &cwdlen, &cwd);
 }
 
diff --git a/tools/perf/builtin-report.c b/tools/perf/builtin-report.c
index 1826be719b58..0ee3d05a0409 100644
--- a/tools/perf/builtin-report.c
+++ b/tools/perf/builtin-report.c
@@ -39,7 +39,6 @@ static char		*dso_list_str, *comm_list_str, *sym_list_str,
 static struct strlist   *dso_list, *comm_list, *sym_list;
 
 static int              force;
-static bool             use_modules;
 
 static int              full_paths;
 static int              show_nr_samples;
@@ -53,12 +52,13 @@ static char		*pretty_printing_style = default_pretty_printing_style;
 static int              exclude_other = 1;
 
 static char             callchain_default_opt[] = "fractal,0.5";
-const char              *vmlinux_name;
 
 static struct perf_header *header;
 
 static u64              sample_type;
 
+struct symbol_conf      symbol_conf;
+
 
 static size_t
 callchain__fprintf_left_margin(FILE *fp, int left_margin)
@@ -865,8 +865,7 @@ static int __cmd_report(void)
 
         register_perf_file_handler(&file_handler);
 
-        ret = mmap_dispatch_perf_file(&header, input_name, vmlinux_name,
-                                      !vmlinux_name, force,
+        ret = mmap_dispatch_perf_file(&header, input_name, force,
                                       full_paths, &cwdlen, &cwd);
         if (ret)
                 return ret;
@@ -963,9 +962,10 @@ static const struct option options[] = {
                     "be more verbose (show symbol address, etc)"),
         OPT_BOOLEAN('D', "dump-raw-trace", &dump_trace,
                     "dump raw trace in ASCII"),
-        OPT_STRING('k', "vmlinux", &vmlinux_name, "file", "vmlinux pathname"),
+        OPT_STRING('k', "vmlinux", &symbol_conf.vmlinux_name,
+                   "file", "vmlinux pathname"),
         OPT_BOOLEAN('f', "force", &force, "don't complain, do it"),
-        OPT_BOOLEAN('m', "modules", &use_modules,
+        OPT_BOOLEAN('m', "modules", &symbol_conf.use_modules,
                     "load module symbols - WARNING: use only with -k and LIVE kernel"),
         OPT_BOOLEAN('n', "show-nr-samples", &show_nr_samples,
                     "Show a column with the number of samples"),
@@ -1035,7 +1035,8 @@ static void setup_list(struct strlist **list, const char *list_str,
 
 int cmd_report(int argc, const char **argv, const char *prefix __used)
 {
-        symbol__init(0);
+        if (symbol__init(&symbol_conf) < 0)
+                return -1;
 
         argc = parse_options(argc, argv, options, report_usage, 0);
 
diff --git a/tools/perf/builtin-sched.c b/tools/perf/builtin-sched.c
index 260f57a72ee0..dbf089b12def 100644
--- a/tools/perf/builtin-sched.c
+++ b/tools/perf/builtin-sched.c
@@ -1718,7 +1718,7 @@ static int read_events(void)
         register_idle_thread();
         register_perf_file_handler(&file_handler);
 
-        return mmap_dispatch_perf_file(&header, input_name, NULL, false, 0, 0,
+        return mmap_dispatch_perf_file(&header, input_name, 0, 0,
                                        &cwdlen, &cwd);
 }
 
diff --git a/tools/perf/builtin-top.c b/tools/perf/builtin-top.c
index b9a321fd184e..a21247543fc1 100644
--- a/tools/perf/builtin-top.c
+++ b/tools/perf/builtin-top.c
@@ -79,7 +79,7 @@ static int			dump_symtab                     =      0;
 static bool                     hide_kernel_symbols             =  false;
 static bool                     hide_user_symbols               =  false;
 static struct winsize           winsize;
-const char                      *vmlinux_name;
+struct symbol_conf              symbol_conf;
 
 /*
  * Source
@@ -128,7 +128,7 @@ struct sym_entry {
 
 static inline struct symbol *sym_entry__symbol(struct sym_entry *self)
 {
-       return ((void *)self) + symbol__priv_size;
+       return ((void *)self) + symbol_conf.priv_size;
 }
 
 static void get_term_dimensions(struct winsize *ws)
@@ -695,7 +695,7 @@ static void print_mapped_keys(void)
 
         fprintf(stdout, "\t[f]     profile display filter (count).    \t(%d)\n", count_filter);
 
-        if (vmlinux_name) {
+        if (symbol_conf.vmlinux_name) {
                 fprintf(stdout, "\t[F]     annotate display filter (percent). \t(%d%%)\n", sym_pcnt_filter);
                 fprintf(stdout, "\t[s]     annotate symbol.                   \t(%s)\n", name?: "NULL");
                 fprintf(stdout, "\t[S]     stop annotation.\n");
@@ -732,7 +732,7 @@ static int key_mapped(int c)
                 case 'F':
                 case 's':
                 case 'S':
-                        return vmlinux_name ? 1 : 0;
+                        return symbol_conf.vmlinux_name ? 1 : 0;
                 default:
                         break;
         }
@@ -1261,7 +1261,8 @@ static const struct option options[] = {
                             "system-wide collection from all CPUs"),
         OPT_INTEGER('C', "CPU", &profile_cpu,
                     "CPU to profile on"),
-        OPT_STRING('k', "vmlinux", &vmlinux_name, "file", "vmlinux pathname"),
+        OPT_STRING('k', "vmlinux", &symbol_conf.vmlinux_name,
+                   "file", "vmlinux pathname"),
         OPT_BOOLEAN('K', "hide_kernel_symbols", &hide_kernel_symbols,
                     "hide kernel symbols"),
         OPT_INTEGER('m', "mmap-pages", &mmap_pages,
@@ -1295,7 +1296,7 @@ static const struct option options[] = {
 
 int cmd_top(int argc, const char **argv, const char *prefix __used)
 {
-        int counter, err;
+        int counter;
 
         page_size = sysconf(_SC_PAGE_SIZE);
 
@@ -1313,15 +1314,16 @@ int cmd_top(int argc, const char **argv, const char *prefix __used)
         if (!nr_counters)
                 nr_counters = 1;
 
-        symbol__init(sizeof(struct sym_entry) +
-                     (nr_counters + 1) * sizeof(unsigned long));
+        symbol_conf.priv_size = (sizeof(struct sym_entry) +
+                                 (nr_counters + 1) * sizeof(unsigned long));
+        if (symbol_conf.vmlinux_name == NULL)
+                symbol_conf.try_vmlinux_path = true;
+        if (symbol__init(&symbol_conf) < 0)
+                return -1;
 
         if (delay_secs < 1)
                 delay_secs = 1;
 
-        err = kernel_maps__init(vmlinux_name, !vmlinux_name, true);
-        if (err < 0)
-                return err;
         parse_source(sym_filter_entry);
 
         /*
diff --git a/tools/perf/builtin-trace.c b/tools/perf/builtin-trace.c
index b71198e5dc14..75972fd073df 100644
--- a/tools/perf/builtin-trace.c
+++ b/tools/perf/builtin-trace.c
@@ -131,7 +131,7 @@ static int __cmd_trace(void)
         register_idle_thread();
         register_perf_file_handler(&file_handler);
 
-        return mmap_dispatch_perf_file(&header, input_name, NULL, false,
+        return mmap_dispatch_perf_file(&header, input_name,
                                        0, 0, &cwdlen, &cwd);
 }
 
diff --git a/tools/perf/util/data_map.c b/tools/perf/util/data_map.c
index f318d19b2562..b238462b8983 100644
--- a/tools/perf/util/data_map.c
+++ b/tools/perf/util/data_map.c
@@ -101,8 +101,6 @@ out:
 
 int mmap_dispatch_perf_file(struct perf_header **pheader,
                             const char *input_name,
-                            const char *vmlinux_name,
-                            bool try_vmlinux_path,
                             int force,
                             int full_paths,
                             int *cwdlen,
@@ -172,12 +170,6 @@ int mmap_dispatch_perf_file(struct perf_header **pheader,
             curr_handler->sample_type_check(sample_type) < 0)
                 goto out_delete;
 
-        err = -ENOMEM;
-        if (kernel_maps__init(vmlinux_name, try_vmlinux_path, true) < 0) {
-                pr_err("failed to setup the kernel maps to resolve symbols\n");
-                goto out_delete;
-        }
-
         if (!full_paths) {
                 if (getcwd(__cwd, sizeof(__cwd)) == NULL) {
                         pr_err("failed to get the current directory\n");
diff --git a/tools/perf/util/data_map.h b/tools/perf/util/data_map.h
index 3f0d21b3819e..ae036ecd7625 100644
--- a/tools/perf/util/data_map.h
+++ b/tools/perf/util/data_map.h
@@ -23,8 +23,6 @@ struct perf_file_handler {
 void register_perf_file_handler(struct perf_file_handler *handler);
 int mmap_dispatch_perf_file(struct perf_header **pheader,
                             const char *input_name,
-                            const char *vmlinux_name,
-                            bool try_vmlinux_path,
                             int force,
                             int full_paths,
                             int *cwdlen,
diff --git a/tools/perf/util/header.c b/tools/perf/util/header.c
index 1332f8ec04aa..271a1600e6f7 100644
--- a/tools/perf/util/header.c
+++ b/tools/perf/util/header.c
@@ -253,12 +253,6 @@ static int perf_header__adds_write(struct perf_header *self, int fd)
 
                 buildid_sec = &feat_sec[idx++];
 
-                /*
-                 * Read the kernel buildid nad the list of loaded modules with
-                 * its build_ids:
-                 */
-                kernel_maps__init(NULL, false, true);
-
                 /* Write build-ids */
                 buildid_sec->offset = lseek(fd, 0, SEEK_CUR);
                 err = dsos__write_buildid_table(fd);
diff --git a/tools/perf/util/include/asm/bug.h b/tools/perf/util/include/asm/bug.h
new file mode 100644
index 000000000000..7fcc6810adc2
--- /dev/null
+++ b/tools/perf/util/include/asm/bug.h
@@ -0,0 +1,22 @@
+#ifndef _PERF_ASM_GENERIC_BUG_H
+#define _PERF_ASM_GENERIC_BUG_H
+
+#define __WARN_printf(arg...)   do { fprintf(stderr, arg); } while (0)
+
+#define WARN(condition, format...) ({           \
+        int __ret_warn_on = !!(condition);      \
+        if (unlikely(__ret_warn_on))            \
+                __WARN_printf(format);          \
+        unlikely(__ret_warn_on);                \
+})
+
+#define WARN_ONCE(condition, format...) ({      \
+        static int __warned;                    \
+        int __ret_warn_once = !!(condition);    \
+                                                \
+        if (unlikely(__ret_warn_once))          \
+                if (WARN(!__warned, format))    \
+                        __warned = 1;           \
+        unlikely(__ret_warn_once);              \
+})
+#endif
diff --git a/tools/perf/util/symbol.c b/tools/perf/util/symbol.c
index 44d81d5ae8cf..c4ca974b36e3 100644
--- a/tools/perf/util/symbol.c
+++ b/tools/perf/util/symbol.c
@@ -6,6 +6,7 @@
 
 #include "debug.h"
 
+#include <asm/bug.h>
 #include <libelf.h>
 #include <gelf.h>
 #include <elf.h>
@@ -37,6 +38,11 @@ unsigned int symbol__priv_size;
 static int vmlinux_path__nr_entries;
 static char **vmlinux_path;
 
+static struct symbol_conf symbol_conf__defaults = {
+        .use_modules      = true,
+        .try_vmlinux_path = true,
+};
+
 static struct rb_root kernel_maps;
 
 static void dso__fixup_sym_end(struct dso *self)
@@ -1166,7 +1172,9 @@ struct symbol *kernel_maps__find_symbol(u64 ip, struct map **mapp,
         if (map) {
                 ip = map->map_ip(map, ip);
                 return map__find_symbol(map, ip, filter);
-        }
+        } else
+                WARN_ONCE(RB_EMPTY_ROOT(&kernel_maps),
+                          "Empty kernel_maps, was symbol__init() called?\n");
 
         return NULL;
 }
@@ -1485,9 +1493,9 @@ size_t dsos__fprintf_buildid(FILE *fp)
         return ret;
 }
 
-static int kernel_maps__create_kernel_map(const char *vmlinux_name)
+static int kernel_maps__create_kernel_map(const struct symbol_conf *conf)
 {
-        struct dso *kernel = dso__new(vmlinux_name ?: "[kernel.kallsyms]");
+        struct dso *kernel = dso__new(conf->vmlinux_name ?: "[kernel.kallsyms]");
 
         if (kernel == NULL)
                 return -1;
@@ -1577,18 +1585,21 @@ out_fail:
         return -1;
 }
 
-int kernel_maps__init(const char *vmlinux_name, bool try_vmlinux_path,
-                      bool use_modules)
+static int kernel_maps__init(const struct symbol_conf *conf)
 {
-        if (try_vmlinux_path && vmlinux_path__init() < 0)
+        const struct symbol_conf *pconf = conf ?: &symbol_conf__defaults;
+
+        symbol__priv_size = pconf->priv_size;
+
+        if (pconf->try_vmlinux_path && vmlinux_path__init() < 0)
                 return -1;
 
-        if (kernel_maps__create_kernel_map(vmlinux_name) < 0) {
+        if (kernel_maps__create_kernel_map(pconf) < 0) {
                 vmlinux_path__exit();
                 return -1;
         }
 
-        if (use_modules && kernel_maps__create_module_maps() < 0)
+        if (pconf->use_modules && kernel_maps__create_module_maps() < 0)
                 pr_debug("Failed to load list of modules in use, "
                          "continuing...\n");
         /*
@@ -1598,8 +1609,8 @@ int kernel_maps__init(const char *vmlinux_name, bool try_vmlinux_path,
         return 0;
 }
 
-void symbol__init(unsigned int priv_size)
+int symbol__init(struct symbol_conf *conf)
 {
         elf_version(EV_CURRENT);
-        symbol__priv_size = priv_size;
+        return kernel_maps__init(conf);
 }
diff --git a/tools/perf/util/symbol.h b/tools/perf/util/symbol.h
index 8c4d026e067a..5538691494af 100644
--- a/tools/perf/util/symbol.h
+++ b/tools/perf/util/symbol.h
@@ -49,6 +49,13 @@ struct symbol {
         char            name[0];
 };
 
+struct symbol_conf {
+        unsigned short  priv_size;
+        bool            try_vmlinux_path,
+                        use_modules;
+        const char      *vmlinux_name;
+};
+
 extern unsigned int symbol__priv_size;
 
 static inline void *symbol__priv(struct symbol *self)
@@ -93,11 +100,9 @@ int sysfs__read_build_id(const char *filename, void *bf, size_t size);
 bool dsos__read_build_ids(void);
 int build_id__sprintf(u8 *self, int len, char *bf);
 
-int kernel_maps__init(const char *vmlinux_name, bool try_vmlinux_path,
-                      bool use_modules);
 size_t kernel_maps__fprintf(FILE *fp);
 
-void symbol__init(unsigned int priv_size);
+int symbol__init(struct symbol_conf *conf);
 
 extern struct list_head dsos;
 extern struct map *kernel_map;