ftrace: Rename _ftrace_direct_multi APIs to _ftrace_direct APIs
authorFlorent Revest <revest@chromium.org>
Tue, 21 Mar 2023 14:04:21 +0000 (15:04 +0100)
committerSteven Rostedt (Google) <rostedt@goodmis.org>
Tue, 21 Mar 2023 17:43:32 +0000 (13:43 -0400)
Now that the original _ftrace_direct APIs are gone, the "_multi"
suffixes only add confusion.

Link: https://lkml.kernel.org/r/20230321140424.345218-5-revest@chromium.org
Signed-off-by: Florent Revest <revest@chromium.org>
Acked-by: Mark Rutland <mark.rutland@arm.com>
Tested-by: Mark Rutland <mark.rutland@arm.com>
Acked-by: Jiri Olsa <jolsa@kernel.org>
Signed-off-by: Steven Rostedt (Google) <rostedt@goodmis.org>
include/linux/ftrace.h
kernel/bpf/trampoline.c
kernel/trace/ftrace.c
kernel/trace/trace_selftest.c
samples/Kconfig
samples/ftrace/ftrace-direct-modify.c
samples/ftrace/ftrace-direct-multi-modify.c
samples/ftrace/ftrace-direct-multi.c
samples/ftrace/ftrace-direct-too.c
samples/ftrace/ftrace-direct.c

index 2f400c9..abee608 100644 (file)
@@ -398,11 +398,11 @@ struct ftrace_func_entry {
 #ifdef CONFIG_DYNAMIC_FTRACE_WITH_DIRECT_CALLS
 extern int ftrace_direct_func_count;
 unsigned long ftrace_find_rec_direct(unsigned long ip);
-int register_ftrace_direct_multi(struct ftrace_ops *ops, unsigned long addr);
-int unregister_ftrace_direct_multi(struct ftrace_ops *ops, unsigned long addr,
-                                  bool free_filters);
-int modify_ftrace_direct_multi(struct ftrace_ops *ops, unsigned long addr);
-int modify_ftrace_direct_multi_nolock(struct ftrace_ops *ops, unsigned long addr);
+int register_ftrace_direct(struct ftrace_ops *ops, unsigned long addr);
+int unregister_ftrace_direct(struct ftrace_ops *ops, unsigned long addr,
+                            bool free_filters);
+int modify_ftrace_direct(struct ftrace_ops *ops, unsigned long addr);
+int modify_ftrace_direct_nolock(struct ftrace_ops *ops, unsigned long addr);
 
 #else
 struct ftrace_ops;
@@ -411,20 +411,20 @@ static inline unsigned long ftrace_find_rec_direct(unsigned long ip)
 {
        return 0;
 }
-static inline int register_ftrace_direct_multi(struct ftrace_ops *ops, unsigned long addr)
+static inline int register_ftrace_direct(struct ftrace_ops *ops, unsigned long addr)
 {
        return -ENODEV;
 }
-static inline int unregister_ftrace_direct_multi(struct ftrace_ops *ops, unsigned long addr,
-                                                bool free_filters)
+static inline int unregister_ftrace_direct(struct ftrace_ops *ops, unsigned long addr,
+                                          bool free_filters)
 {
        return -ENODEV;
 }
-static inline int modify_ftrace_direct_multi(struct ftrace_ops *ops, unsigned long addr)
+static inline int modify_ftrace_direct(struct ftrace_ops *ops, unsigned long addr)
 {
        return -ENODEV;
 }
-static inline int modify_ftrace_direct_multi_nolock(struct ftrace_ops *ops, unsigned long addr)
+static inline int modify_ftrace_direct_nolock(struct ftrace_ops *ops, unsigned long addr)
 {
        return -ENODEV;
 }
index 88bc23f..a14d0af 100644 (file)
@@ -45,8 +45,8 @@ static int bpf_tramp_ftrace_ops_func(struct ftrace_ops *ops, enum ftrace_ops_cmd
                lockdep_assert_held_once(&tr->mutex);
 
                /* Instead of updating the trampoline here, we propagate
-                * -EAGAIN to register_ftrace_direct_multi(). Then we can
-                * retry register_ftrace_direct_multi() after updating the
+                * -EAGAIN to register_ftrace_direct(). Then we can
+                * retry register_ftrace_direct() after updating the
                 * trampoline.
                 */
                if ((tr->flags & BPF_TRAMP_F_CALL_ORIG) &&
@@ -198,7 +198,7 @@ static int unregister_fentry(struct bpf_trampoline *tr, void *old_addr)
        int ret;
 
        if (tr->func.ftrace_managed)
-               ret = unregister_ftrace_direct_multi(tr->fops, (long)old_addr, false);
+               ret = unregister_ftrace_direct(tr->fops, (long)old_addr, false);
        else
                ret = bpf_arch_text_poke(ip, BPF_MOD_CALL, old_addr, NULL);
 
@@ -215,9 +215,9 @@ static int modify_fentry(struct bpf_trampoline *tr, void *old_addr, void *new_ad
 
        if (tr->func.ftrace_managed) {
                if (lock_direct_mutex)
-                       ret = modify_ftrace_direct_multi(tr->fops, (long)new_addr);
+                       ret = modify_ftrace_direct(tr->fops, (long)new_addr);
                else
-                       ret = modify_ftrace_direct_multi_nolock(tr->fops, (long)new_addr);
+                       ret = modify_ftrace_direct_nolock(tr->fops, (long)new_addr);
        } else {
                ret = bpf_arch_text_poke(ip, BPF_MOD_CALL, old_addr, new_addr);
        }
@@ -243,7 +243,7 @@ static int register_fentry(struct bpf_trampoline *tr, void *new_addr)
 
        if (tr->func.ftrace_managed) {
                ftrace_set_filter_ip(tr->fops, (unsigned long)ip, 0, 1);
-               ret = register_ftrace_direct_multi(tr->fops, (long)new_addr);
+               ret = register_ftrace_direct(tr->fops, (long)new_addr);
        } else {
                ret = bpf_arch_text_poke(ip, BPF_MOD_CALL, NULL, new_addr);
        }
index fbc9abf..845c401 100644 (file)
@@ -5318,7 +5318,7 @@ static void remove_direct_functions_hash(struct ftrace_hash *hash, unsigned long
 }
 
 /**
- * register_ftrace_direct_multi - Call a custom trampoline directly
+ * register_ftrace_direct - Call a custom trampoline directly
  * for multiple functions registered in @ops
  * @ops: The address of the struct ftrace_ops object
  * @addr: The address of the trampoline to call at @ops functions
@@ -5339,7 +5339,7 @@ static void remove_direct_functions_hash(struct ftrace_hash *hash, unsigned long
  *  -ENODEV  - @ip does not point to a ftrace nop location (or not supported)
  *  -ENOMEM  - There was an allocation failure.
  */
-int register_ftrace_direct_multi(struct ftrace_ops *ops, unsigned long addr)
+int register_ftrace_direct(struct ftrace_ops *ops, unsigned long addr)
 {
        struct ftrace_hash *hash, *free_hash = NULL;
        struct ftrace_func_entry *entry, *new;
@@ -5397,11 +5397,11 @@ int register_ftrace_direct_multi(struct ftrace_ops *ops, unsigned long addr)
        }
        return err;
 }
-EXPORT_SYMBOL_GPL(register_ftrace_direct_multi);
+EXPORT_SYMBOL_GPL(register_ftrace_direct);
 
 /**
- * unregister_ftrace_direct_multi - Remove calls to custom trampoline
- * previously registered by register_ftrace_direct_multi for @ops object.
+ * unregister_ftrace_direct - Remove calls to custom trampoline
+ * previously registered by register_ftrace_direct for @ops object.
  * @ops: The address of the struct ftrace_ops object
  *
  * This is used to remove a direct calls to @addr from the nop locations
@@ -5412,8 +5412,8 @@ EXPORT_SYMBOL_GPL(register_ftrace_direct_multi);
  *  0 on success
  *  -EINVAL - The @ops object was not properly registered.
  */
-int unregister_ftrace_direct_multi(struct ftrace_ops *ops, unsigned long addr,
-                                  bool free_filters)
+int unregister_ftrace_direct(struct ftrace_ops *ops, unsigned long addr,
+                            bool free_filters)
 {
        struct ftrace_hash *hash = ops->func_hash->filter_hash;
        int err;
@@ -5436,10 +5436,10 @@ int unregister_ftrace_direct_multi(struct ftrace_ops *ops, unsigned long addr,
                ftrace_free_filter(ops);
        return err;
 }
-EXPORT_SYMBOL_GPL(unregister_ftrace_direct_multi);
+EXPORT_SYMBOL_GPL(unregister_ftrace_direct);
 
 static int
-__modify_ftrace_direct_multi(struct ftrace_ops *ops, unsigned long addr)
+__modify_ftrace_direct(struct ftrace_ops *ops, unsigned long addr)
 {
        struct ftrace_hash *hash;
        struct ftrace_func_entry *entry, *iter;
@@ -5486,7 +5486,7 @@ __modify_ftrace_direct_multi(struct ftrace_ops *ops, unsigned long addr)
 }
 
 /**
- * modify_ftrace_direct_multi_nolock - Modify an existing direct 'multi' call
+ * modify_ftrace_direct_nolock - Modify an existing direct 'multi' call
  * to call something else
  * @ops: The address of the struct ftrace_ops object
  * @addr: The address of the new trampoline to call at @ops functions
@@ -5503,19 +5503,19 @@ __modify_ftrace_direct_multi(struct ftrace_ops *ops, unsigned long addr)
  * Returns: zero on success. Non zero on error, which includes:
  *  -EINVAL - The @ops object was not properly registered.
  */
-int modify_ftrace_direct_multi_nolock(struct ftrace_ops *ops, unsigned long addr)
+int modify_ftrace_direct_nolock(struct ftrace_ops *ops, unsigned long addr)
 {
        if (check_direct_multi(ops))
                return -EINVAL;
        if (!(ops->flags & FTRACE_OPS_FL_ENABLED))
                return -EINVAL;
 
-       return __modify_ftrace_direct_multi(ops, addr);
+       return __modify_ftrace_direct(ops, addr);
 }
-EXPORT_SYMBOL_GPL(modify_ftrace_direct_multi_nolock);
+EXPORT_SYMBOL_GPL(modify_ftrace_direct_nolock);
 
 /**
- * modify_ftrace_direct_multi - Modify an existing direct 'multi' call
+ * modify_ftrace_direct - Modify an existing direct 'multi' call
  * to call something else
  * @ops: The address of the struct ftrace_ops object
  * @addr: The address of the new trampoline to call at @ops functions
@@ -5529,7 +5529,7 @@ EXPORT_SYMBOL_GPL(modify_ftrace_direct_multi_nolock);
  * Returns: zero on success. Non zero on error, which includes:
  *  -EINVAL - The @ops object was not properly registered.
  */
-int modify_ftrace_direct_multi(struct ftrace_ops *ops, unsigned long addr)
+int modify_ftrace_direct(struct ftrace_ops *ops, unsigned long addr)
 {
        int err;
 
@@ -5539,11 +5539,11 @@ int modify_ftrace_direct_multi(struct ftrace_ops *ops, unsigned long addr)
                return -EINVAL;
 
        mutex_lock(&direct_mutex);
-       err = __modify_ftrace_direct_multi(ops, addr);
+       err = __modify_ftrace_direct(ops, addr);
        mutex_unlock(&direct_mutex);
        return err;
 }
-EXPORT_SYMBOL_GPL(modify_ftrace_direct_multi);
+EXPORT_SYMBOL_GPL(modify_ftrace_direct);
 #endif /* CONFIG_DYNAMIC_FTRACE_WITH_DIRECT_CALLS */
 
 /**
index 9ce80b3..84cd7ba 100644 (file)
@@ -872,7 +872,8 @@ trace_selftest_startup_function_graph(struct tracer *trace,
         * and make sure we get graph trace.
         */
        ftrace_set_filter_ip(&direct, (unsigned long)DYN_FTRACE_TEST_NAME, 0, 0);
-       ret = register_ftrace_direct_multi(&direct, (unsigned long)trace_direct_tramp);
+       ret = register_ftrace_direct(&direct,
+                                    (unsigned long)trace_direct_tramp);
        if (ret)
                goto out;
 
@@ -892,9 +893,9 @@ trace_selftest_startup_function_graph(struct tracer *trace,
 
        unregister_ftrace_graph(&fgraph_ops);
 
-       ret = unregister_ftrace_direct_multi(&direct,
-                                            (unsigned long) trace_direct_tramp,
-                                            true);
+       ret = unregister_ftrace_direct(&direct,
+                                      (unsigned long) trace_direct_tramp,
+                                      true);
        if (ret)
                goto out;
 
index 30ef8bd..fd24daa 100644 (file)
@@ -38,7 +38,7 @@ config SAMPLE_FTRACE_DIRECT
          that hooks to wake_up_process and prints the parameters.
 
 config SAMPLE_FTRACE_DIRECT_MULTI
-       tristate "Build register_ftrace_direct_multi() example"
+       tristate "Build register_ftrace_direct() on multiple ips example"
        depends on DYNAMIC_FTRACE_WITH_DIRECT_CALLS && m
        depends on HAVE_SAMPLE_FTRACE_DIRECT_MULTI
        help
index f01ac74..25fba66 100644 (file)
@@ -116,7 +116,7 @@ static int simple_thread(void *arg)
                if (ret)
                        continue;
                t ^= 1;
-               ret = modify_ftrace_direct_multi(&direct, tramps[t]);
+               ret = modify_ftrace_direct(&direct, tramps[t]);
                if (!ret)
                        my_tramp = tramps[t];
                WARN_ON_ONCE(ret);
@@ -132,7 +132,7 @@ static int __init ftrace_direct_init(void)
        int ret;
 
        ftrace_set_filter_ip(&direct, (unsigned long) my_ip, 0, 0);
-       ret = register_ftrace_direct_multi(&direct, my_tramp);
+       ret = register_ftrace_direct(&direct, my_tramp);
 
        if (!ret)
                simple_tsk = kthread_run(simple_thread, NULL, "event-sample-fn");
@@ -142,12 +142,12 @@ static int __init ftrace_direct_init(void)
 static void __exit ftrace_direct_exit(void)
 {
        kthread_stop(simple_tsk);
-       unregister_ftrace_direct_multi(&direct, my_tramp, true);
+       unregister_ftrace_direct(&direct, my_tramp, true);
 }
 
 module_init(ftrace_direct_init);
 module_exit(ftrace_direct_exit);
 
 MODULE_AUTHOR("Steven Rostedt");
-MODULE_DESCRIPTION("Example use case of using modify_ftrace_direct_multi()");
+MODULE_DESCRIPTION("Example use case of using modify_ftrace_direct()");
 MODULE_LICENSE("GPL");
index 196b439..f726238 100644 (file)
@@ -123,7 +123,7 @@ static int simple_thread(void *arg)
                if (ret)
                        continue;
                t ^= 1;
-               ret = modify_ftrace_direct_multi(&direct, tramps[t]);
+               ret = modify_ftrace_direct(&direct, tramps[t]);
                if (!ret)
                        my_tramp = tramps[t];
                WARN_ON_ONCE(ret);
@@ -141,7 +141,7 @@ static int __init ftrace_direct_multi_init(void)
        ftrace_set_filter_ip(&direct, (unsigned long) wake_up_process, 0, 0);
        ftrace_set_filter_ip(&direct, (unsigned long) schedule, 0, 0);
 
-       ret = register_ftrace_direct_multi(&direct, my_tramp);
+       ret = register_ftrace_direct(&direct, my_tramp);
 
        if (!ret)
                simple_tsk = kthread_run(simple_thread, NULL, "event-sample-fn");
@@ -151,12 +151,12 @@ static int __init ftrace_direct_multi_init(void)
 static void __exit ftrace_direct_multi_exit(void)
 {
        kthread_stop(simple_tsk);
-       unregister_ftrace_direct_multi(&direct, my_tramp, true);
+       unregister_ftrace_direct(&direct, my_tramp, true);
 }
 
 module_init(ftrace_direct_multi_init);
 module_exit(ftrace_direct_multi_exit);
 
 MODULE_AUTHOR("Jiri Olsa");
-MODULE_DESCRIPTION("Example use case of using modify_ftrace_direct_multi()");
+MODULE_DESCRIPTION("Example use case of using modify_ftrace_direct()");
 MODULE_LICENSE("GPL");
index ea0e88e..1547c2c 100644 (file)
@@ -73,12 +73,12 @@ static int __init ftrace_direct_multi_init(void)
        ftrace_set_filter_ip(&direct, (unsigned long) wake_up_process, 0, 0);
        ftrace_set_filter_ip(&direct, (unsigned long) schedule, 0, 0);
 
-       return register_ftrace_direct_multi(&direct, (unsigned long) my_tramp);
+       return register_ftrace_direct(&direct, (unsigned long) my_tramp);
 }
 
 static void __exit ftrace_direct_multi_exit(void)
 {
-       unregister_ftrace_direct_multi(&direct, (unsigned long) my_tramp, true);
+       unregister_ftrace_direct(&direct, (unsigned long) my_tramp, true);
 }
 
 module_init(ftrace_direct_multi_init);
index 05c3585..f28e7b9 100644 (file)
@@ -76,17 +76,17 @@ static int __init ftrace_direct_init(void)
 {
        ftrace_set_filter_ip(&direct, (unsigned long) handle_mm_fault, 0, 0);
 
-       return register_ftrace_direct_multi(&direct, (unsigned long) my_tramp);
+       return register_ftrace_direct(&direct, (unsigned long) my_tramp);
 }
 
 static void __exit ftrace_direct_exit(void)
 {
-       unregister_ftrace_direct_multi(&direct, (unsigned long)my_tramp, true);
+       unregister_ftrace_direct(&direct, (unsigned long)my_tramp, true);
 }
 
 module_init(ftrace_direct_init);
 module_exit(ftrace_direct_exit);
 
 MODULE_AUTHOR("Steven Rostedt");
-MODULE_DESCRIPTION("Another example use case of using register_ftrace_direct_multi()");
+MODULE_DESCRIPTION("Another example use case of using register_ftrace_direct()");
 MODULE_LICENSE("GPL");
index 42ec9e3..d81a947 100644 (file)
@@ -69,17 +69,17 @@ static int __init ftrace_direct_init(void)
 {
        ftrace_set_filter_ip(&direct, (unsigned long) wake_up_process, 0, 0);
 
-       return register_ftrace_direct_multi(&direct, (unsigned long) my_tramp);
+       return register_ftrace_direct(&direct, (unsigned long) my_tramp);
 }
 
 static void __exit ftrace_direct_exit(void)
 {
-       unregister_ftrace_direct_multi(&direct, (unsigned long)my_tramp, true);
+       unregister_ftrace_direct(&direct, (unsigned long)my_tramp, true);
 }
 
 module_init(ftrace_direct_init);
 module_exit(ftrace_direct_exit);
 
 MODULE_AUTHOR("Steven Rostedt");
-MODULE_DESCRIPTION("Example use case of using register_ftrace_direct_multi()");
+MODULE_DESCRIPTION("Example use case of using register_ftrace_direct()");
 MODULE_LICENSE("GPL");