tracing/kprobes: Return EADDRNOTAVAIL when func matches several symbols

When a kprobe is attached to a function that's name is not unique (is
static and shares the name with other functions in the kernel), the
kprobe is attached to the first function it finds. This is a bug as the
function that it is attaching to is not necessarily the one that the
user wants to attach to.

Instead of blindly picking a function to attach to what is ambiguous,
error with EADDRNOTAVAIL to let the user know that this function is not
unique, and that the user must use another unique function with an
address offset to get to the function they want to attach to.

Link: https://lore.kernel.org/all/20231020104250.9537-2-flaniel@linux.microsoft.com/
Cc: stable@vger.kernel.org
Fixes: 413d37d1eb69 ("tracing: Add kprobe-based event tracer")
Suggested-by: Masami Hiramatsu <mhiramat@kernel.org>
Signed-off-by: Francis Laniel <flaniel@linux.microsoft.com>
Link: https://lore.kernel.org/lkml/20230819101105.b0c104ae4494a7d1f2eea742@kernel.org/
Acked-by: Masami Hiramatsu (Google) <mhiramat@kernel.org>
Signed-off-by: Masami Hiramatsu (Google) <mhiramat@kernel.org>

diff --git a/kernel/trace/trace_kprobe.c b/kernel/trace/trace_kprobe.c
index 3d7a180a84272e891458c5274daa2897a91f867c..a8fef6ab087274286f5cc5d9a55cdc1b973b7384 100644 (file)
--- a/kernel/trace/trace_kprobe.c
+++ b/kernel/trace/trace_kprobe.c
@@ -705,6 +705,25 @@ static struct notifier_block trace_kprobe_module_nb = {
        .priority = 1   /* Invoked after kprobe module callback */
 };
 
+static int count_symbols(void *data, unsigned long unused)
+{
+       unsigned int *count = data;
+
+       (*count)++;
+
+       return 0;
+}
+
+static unsigned int number_of_same_symbols(char *func_name)
+{
+       unsigned int count;
+
+       count = 0;
+       kallsyms_on_each_match_symbol(count_symbols, func_name, &count);
+
+       return count;
+}
+
 static int __trace_kprobe_create(int argc, const char *argv[])
 {
        /*
@@ -836,6 +855,31 @@ static int __trace_kprobe_create(int argc, const char *argv[])
                }
        }
 
+       if (symbol && !strchr(symbol, ':')) {
+               unsigned int count;
+
+               count = number_of_same_symbols(symbol);
+               if (count > 1) {
+                       /*
+                        * Users should use ADDR to remove the ambiguity of
+                        * using KSYM only.
+                        */
+                       trace_probe_log_err(0, NON_UNIQ_SYMBOL);
+                       ret = -EADDRNOTAVAIL;
+
+                       goto error;
+               } else if (count == 0) {
+                       /*
+                        * We can return ENOENT earlier than when register the
+                        * kprobe.
+                        */
+                       trace_probe_log_err(0, BAD_PROBE_ADDR);
+                       ret = -ENOENT;
+
+                       goto error;
+               }
+       }
+
        trace_probe_log_set_index(0);
        if (event) {
                ret = traceprobe_parse_event_name(&event, &group, gbuf,
@@ -1695,6 +1739,7 @@ static int unregister_kprobe_event(struct trace_kprobe *tk)
 }
 
 #ifdef CONFIG_PERF_EVENTS
+
 /* create a trace_kprobe, but don't add it to global lists */
 struct trace_event_call *
 create_local_trace_kprobe(char *func, void *addr, unsigned long offs,
@@ -1705,6 +1750,24 @@ create_local_trace_kprobe(char *func, void *addr, unsigned long offs,
        int ret;
        char *event;
 
+       if (func) {
+               unsigned int count;
+
+               count = number_of_same_symbols(func);
+               if (count > 1)
+                       /*
+                        * Users should use addr to remove the ambiguity of
+                        * using func only.
+                        */
+                       return ERR_PTR(-EADDRNOTAVAIL);
+               else if (count == 0)
+                       /*
+                        * We can return ENOENT earlier than when register the
+                        * kprobe.
+                        */
+                       return ERR_PTR(-ENOENT);
+       }
+
        /*
         * local trace_kprobes are not added to dyn_event, so they are never
         * searched in find_trace_kprobe(). Therefore, there is no concern of

diff --git a/kernel/trace/trace_probe.h b/kernel/trace/trace_probe.h
index 02b432ae7513137922d90a73621dad3071ec0fb5..850d9ecb6765a8bd372b214ee6f302e3374ffa93 100644 (file)
--- a/kernel/trace/trace_probe.h
+++ b/kernel/trace/trace_probe.h
@@ -450,6 +450,7 @@ extern int traceprobe_define_arg_fields(struct trace_event_call *event_call,
        C(BAD_MAXACT,           "Invalid maxactive number"),            \
        C(MAXACT_TOO_BIG,       "Maxactive is too big"),                \
        C(BAD_PROBE_ADDR,       "Invalid probed address or symbol"),    \
+       C(NON_UNIQ_SYMBOL,      "The symbol is not unique"),            \
        C(BAD_RETPROBE,         "Retprobe address must be an function entry"), \
        C(NO_TRACEPOINT,        "Tracepoint is not found"),             \
        C(BAD_ADDR_SUFFIX,      "Invalid probed address suffix"), \