[PATCH] tracing/kprobes: Fix the order of argument descriptions

[PATCH] tracing/kprobes: Fix the order of argument descriptions

[Yujie Liu]

The order of descriptions should be consistent with the argument list of
the function, so "kretprobe" should be the second one.

int __kprobe_event_gen_cmd_start(struct dynevent_cmd *cmd, bool kretprobe,
                                 const char *name, const char *loc, ...)

Fixes: 2a588dd1d5d6 ("tracing: Add kprobe event command generation functions")
Suggested-by: Mukesh Ojha <quic_mojha@quicinc.com>
Signed-off-by: Yujie Liu <yujie.liu@intel.com>
---
 kernel/trace/trace_kprobe.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/kernel/trace/trace_kprobe.c b/kernel/trace/trace_kprobe.c
index e834f149695b..47812aa16bb5 100644
--- a/kernel/trace/trace_kprobe.c
+++ b/kernel/trace/trace_kprobe.c
@@ -1020,9 +1020,9 @@ EXPORT_SYMBOL_GPL(kprobe_event_cmd_init);
 /**
  * __kprobe_event_gen_cmd_start - Generate a kprobe event command from arg list
  * @cmd: A pointer to the dynevent_cmd struct representing the new event
+ * @kretprobe: Is this a return probe?
  * @name: The name of the kprobe event
  * @loc: The location of the kprobe event
- * @kretprobe: Is this a return probe?
  * @...: Variable number of arg (pairs), one pair for each field
  *
  * NOTE: Users normally won't want to call this function directly, but
-- 
2.34.1

Re: [PATCH] tracing/kprobes: Fix the order of argument descriptions

[Mukesh Ojha]

On 10/31/2023 9:43 AM, Yujie Liu wrote:
> The order of descriptions should be consistent with the argument list of
> the function, so "kretprobe" should be the second one.
> 
> int __kprobe_event_gen_cmd_start(struct dynevent_cmd *cmd, bool kretprobe,
>                                   const char *name, const char *loc, ...)
> 
> Fixes: 2a588dd1d5d6 ("tracing: Add kprobe event command generation functions")
> Suggested-by: Mukesh Ojha <quic_mojha@quicinc.com>
> Signed-off-by: Yujie Liu <yujie.liu@intel.com>

Thanks.

Reviewed-by: Mukesh Ojha <quic_mojha@quicinc.com>

-Mukesh

> ---
>   kernel/trace/trace_kprobe.c | 2 +-
>   1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/kernel/trace/trace_kprobe.c b/kernel/trace/trace_kprobe.c
> index e834f149695b..47812aa16bb5 100644
> --- a/kernel/trace/trace_kprobe.c
> +++ b/kernel/trace/trace_kprobe.c
> @@ -1020,9 +1020,9 @@ EXPORT_SYMBOL_GPL(kprobe_event_cmd_init);
>   /**
>    * __kprobe_event_gen_cmd_start - Generate a kprobe event command from arg list
>    * @cmd: A pointer to the dynevent_cmd struct representing the new event
> + * @kretprobe: Is this a return probe?
>    * @name: The name of the kprobe event
>    * @loc: The location of the kprobe event
> - * @kretprobe: Is this a return probe?
>    * @...: Variable number of arg (pairs), one pair for each field
>    *
>    * NOTE: Users normally won't want to call this function directly, but

Re: [PATCH] tracing/kprobes: Fix the order of argument descriptions

[Masami Hiramatsu]

On Tue, 31 Oct 2023 15:18:14 +0530
Mukesh Ojha <quic_mojha@quicinc.com> wrote:

> 
> 
> On 10/31/2023 9:43 AM, Yujie Liu wrote:
> > The order of descriptions should be consistent with the argument list of
> > the function, so "kretprobe" should be the second one.
> > 
> > int __kprobe_event_gen_cmd_start(struct dynevent_cmd *cmd, bool kretprobe,
> >                                   const char *name, const char *loc, ...)
> > 
> > Fixes: 2a588dd1d5d6 ("tracing: Add kprobe event command generation functions")
> > Suggested-by: Mukesh Ojha <quic_mojha@quicinc.com>
> > Signed-off-by: Yujie Liu <yujie.liu@intel.com>
> 
> Thanks.
> 
> Reviewed-by: Mukesh Ojha <quic_mojha@quicinc.com>

OK, let me pick this to probes/fixes.

Thanks!

> 
> -Mukesh
> 
> > ---
> >   kernel/trace/trace_kprobe.c | 2 +-
> >   1 file changed, 1 insertion(+), 1 deletion(-)
> > 
> > diff --git a/kernel/trace/trace_kprobe.c b/kernel/trace/trace_kprobe.c
> > index e834f149695b..47812aa16bb5 100644
> > --- a/kernel/trace/trace_kprobe.c
> > +++ b/kernel/trace/trace_kprobe.c
> > @@ -1020,9 +1020,9 @@ EXPORT_SYMBOL_GPL(kprobe_event_cmd_init);
> >   /**
> >    * __kprobe_event_gen_cmd_start - Generate a kprobe event command from arg list
> >    * @cmd: A pointer to the dynevent_cmd struct representing the new event
> > + * @kretprobe: Is this a return probe?
> >    * @name: The name of the kprobe event
> >    * @loc: The location of the kprobe event
> > - * @kretprobe: Is this a return probe?
> >    * @...: Variable number of arg (pairs), one pair for each field
> >    *
> >    * NOTE: Users normally won't want to call this function directly, but


-- 
Masami Hiramatsu (Google) <mhiramat@kernel.org>