2024-05-28 00:52:25

by Marilene A Garcia

[permalink] [raw]
Subject: [PATCH] ftrace: adding the missing parameter descriptions of unregister_ftrace_direct

Adding the description of the parameters addr and free_filters
of the function unregister_ftrace_direct.

Signed-off-by: MarileneGarcia <[email protected]>
---
Hello,
These changes fix the following compiler warnings of the function
unregister_ftrace_direct.

The warnings happen using GCC compiler, enabling the ftrace related
configs and using the command 'make W=1'.

kernel/trace/ftrace.c:5489: warning: Function parameter or struct member
'addr' not described in 'unregister_ftrace_direct'

kernel/trace/ftrace.c:5489: warning: Function parameter or struct member
'free_filters' not described in 'unregister_ftrace_direct'

kernel/trace/ftrace.c | 2 ++
1 file changed, 2 insertions(+)

diff --git a/kernel/trace/ftrace.c b/kernel/trace/ftrace.c
index 65208d3b5ed9..6062e4ce1957 100644
--- a/kernel/trace/ftrace.c
+++ b/kernel/trace/ftrace.c
@@ -5475,6 +5475,8 @@ EXPORT_SYMBOL_GPL(register_ftrace_direct);
* 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
+ * @addr: The address of the trampoline to call at @ops functions
+ * @free_filters: non zero to remove all filters for the ftrace_ops
*
* This is used to remove a direct calls to @addr from the nop locations
* of the functions registered in @ops (with by ftrace_set_filter_ip
--
2.34.1



2024-06-04 23:24:14

by Marilene A Garcia

[permalink] [raw]
Subject: Re: [PATCH] ftrace: adding the missing parameter descriptions of unregister_ftrace_direct

On 27/05/2024 21:50, MarileneGarcia wrote:
> Adding the description of the parameters addr and free_filters
> of the function unregister_ftrace_direct.
>
> Signed-off-by: MarileneGarcia <[email protected]>
> ---
> Hello,
> These changes fix the following compiler warnings of the function
> unregister_ftrace_direct.
>
> The warnings happen using GCC compiler, enabling the ftrace related
> configs and using the command 'make W=1'.
>
> kernel/trace/ftrace.c:5489: warning: Function parameter or struct member
> 'addr' not described in 'unregister_ftrace_direct'
>
> kernel/trace/ftrace.c:5489: warning: Function parameter or struct member
> 'free_filters' not described in 'unregister_ftrace_direct'
>
> kernel/trace/ftrace.c | 2 ++
> 1 file changed, 2 insertions(+)
>
> diff --git a/kernel/trace/ftrace.c b/kernel/trace/ftrace.c
> index 65208d3b5ed9..6062e4ce1957 100644
> --- a/kernel/trace/ftrace.c
> +++ b/kernel/trace/ftrace.c
> @@ -5475,6 +5475,8 @@ EXPORT_SYMBOL_GPL(register_ftrace_direct);
> * 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
> + * @addr: The address of the trampoline to call at @ops functions
> + * @free_filters: non zero to remove all filters for the ftrace_ops
> *
> * This is used to remove a direct calls to @addr from the nop locations
> * of the functions registered in @ops (with by ftrace_set_filter_ip

Hello everyone,
Do you have any feedback to me about the patch?

Thank you,
Marilene

2024-06-06 02:09:52

by Steven Rostedt

[permalink] [raw]
Subject: Re: [PATCH] ftrace: adding the missing parameter descriptions of unregister_ftrace_direct

On Mon, 27 May 2024 21:50:46 -0300
MarileneGarcia <[email protected]> wrote:

The subject for the tracing subsystem should start with a capital letter,
but it is a bit confusing anyway. Should be:

ftrace: Add missing kerneldoc parameters to unregister_ftrace_direct()


> Adding the description of the parameters addr and free_filters
> of the function unregister_ftrace_direct.

s/Adding/Add/ s/of the/to the/

>
> Signed-off-by: MarileneGarcia <[email protected]>
> ---
> Hello,
> These changes fix the following compiler warnings of the function
> unregister_ftrace_direct.
>
> The warnings happen using GCC compiler, enabling the ftrace related
> configs and using the command 'make W=1'.
>
> kernel/trace/ftrace.c:5489: warning: Function parameter or struct member
> 'addr' not described in 'unregister_ftrace_direct'
>
> kernel/trace/ftrace.c:5489: warning: Function parameter or struct member
> 'free_filters' not described in 'unregister_ftrace_direct'
>
> kernel/trace/ftrace.c | 2 ++
> 1 file changed, 2 insertions(+)
>
> diff --git a/kernel/trace/ftrace.c b/kernel/trace/ftrace.c
> index 65208d3b5ed9..6062e4ce1957 100644
> --- a/kernel/trace/ftrace.c
> +++ b/kernel/trace/ftrace.c
> @@ -5475,6 +5475,8 @@ EXPORT_SYMBOL_GPL(register_ftrace_direct);
> * 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
> + * @addr: The address of the trampoline to call at @ops functions

This is the unregister function. The above sounds like it will be called
instead of no longer being called.

@addr: The address of the direct function that are called by the @ops functions

> + * @free_filters: non zero to remove all filters for the ftrace_ops

It's a boolean value, there is no zero.

> *
> * This is used to remove a direct calls to @addr from the nop locations
> * of the functions registered in @ops (with by ftrace_set_filter_ip


-- Steve