Re: [PATCH] libperf: Rename arguments of perf_thread_map APIs

[Jiri Olsa <olsajiri@gmail.com>]

On Wed, Feb 23, 2022 at 12:27:34PM -0300, Arnaldo Carvalho de Melo wrote:
> Em Mon, Feb 21, 2022 at 08:46:40PM +0100, Jiri Olsa escreveu:
> > On Mon, Feb 21, 2022 at 12:26:12PM +0200, Tzvetomir Stoyanov (VMware) wrote:
> > > The "int thread" input arguments of some perf_thead_map APIs are index
> > > of the thread in the thread map. In order to avoid confusion and to
> > > make the APIs consistent with perf_cpu_map APIs, those arguments are
> > > renamed to "int idx".
> > > 
> > > Suggested-by: Arnaldo Carvalho de Melo <arnaldo.melo@gmail.com>
> > > Signed-off-by: Tzvetomir Stoyanov (VMware) <tz.stoyanov@gmail.com>
> > > ---
> > >  tools/lib/perf/Documentation/libperf.txt |  6 +++---
> > >  tools/lib/perf/include/perf/threadmap.h  |  6 +++---
> > >  tools/lib/perf/threadmap.c               | 12 ++++++------
> > >  3 files changed, 12 insertions(+), 12 deletions(-)
> > > 
> > > diff --git a/tools/lib/perf/Documentation/libperf.txt b/tools/lib/perf/Documentation/libperf.txt
> > > index 32c5051c24eb..a21f733b95b1 100644
> > > --- a/tools/lib/perf/Documentation/libperf.txt
> > > +++ b/tools/lib/perf/Documentation/libperf.txt
> > > @@ -63,10 +63,10 @@ SYNOPSIS
> > >  
> > >    struct perf_thread_map *perf_thread_map__new_dummy(void);
> > >  
> > > -  void perf_thread_map__set_pid(struct perf_thread_map *map, int thread, pid_t pid);
> > > -  char *perf_thread_map__comm(struct perf_thread_map *map, int thread);
> > > +  void perf_thread_map__set_pid(struct perf_thread_map *map, int idx, pid_t pid);
> > > +  char *perf_thread_map__comm(struct perf_thread_map *map, int idx);
> > >    int perf_thread_map__nr(struct perf_thread_map *threads);
> > > -  pid_t perf_thread_map__pid(struct perf_thread_map *map, int thread);
> > > +  pid_t perf_thread_map__pid(struct perf_thread_map *map, int idx);
> > >  
> > >    struct perf_thread_map *perf_thread_map__get(struct perf_thread_map *map);
> > >    void perf_thread_map__put(struct perf_thread_map *map);
> > > diff --git a/tools/lib/perf/include/perf/threadmap.h b/tools/lib/perf/include/perf/threadmap.h
> > > index a7c50de8d010..58f7fbdce446 100644
> > > --- a/tools/lib/perf/include/perf/threadmap.h
> > > +++ b/tools/lib/perf/include/perf/threadmap.h
> > > @@ -9,10 +9,10 @@ struct perf_thread_map;
> > >  
> > >  LIBPERF_API struct perf_thread_map *perf_thread_map__new_dummy(void);
> > >  
> > > -LIBPERF_API void perf_thread_map__set_pid(struct perf_thread_map *map, int thread, pid_t pid);
> > > -LIBPERF_API char *perf_thread_map__comm(struct perf_thread_map *map, int thread);
> > > +LIBPERF_API void perf_thread_map__set_pid(struct perf_thread_map *map, int idx, pid_t pid);
> > > +LIBPERF_API char *perf_thread_map__comm(struct perf_thread_map *map, int idx);
> > >  LIBPERF_API int perf_thread_map__nr(struct perf_thread_map *threads);
> > > -LIBPERF_API pid_t perf_thread_map__pid(struct perf_thread_map *map, int thread);
> > > +LIBPERF_API pid_t perf_thread_map__pid(struct perf_thread_map *map, int idx);
> > 
> > does this argument name change break abi? do we care at this point? ;-)
> > not sure if we already started to treat libperf properly in this regard
> 
> So, I don't think this changes the ABI, no semantic change, just a
> clarification.
> 
> Are you ok with it?

yes, I think it's ok

Acked-by: Jiri Olsa <jolsa@kernel.org>

thanks,
jirka