[1/3] bitrate: change reg implementation to match API description
Checks
Commit Message
rte_stats_bitrate_reg() API states it returns 'Zero on success'.
However, the implementation directly returns the return of
rte_metrics_reg_names() which may be zero or positive on success,
with a positive value also indicating the index.
The user of rte_stats_bitrate_reg() should not care about the
index as it is stored in the opaque rte_stats_bitrates struct.
Change the implementation of rte_stats_bitrate_reg() to match
the API description by always returning zero on success.
Fixes: 2ad7ba9a6567 ("bitrate: add bitrate statistics library")
Signed-off-by: Kevin Traynor <ktraynor@redhat.com>
---
lib/bitratestats/rte_bitrate.c | 4 +++-
1 file changed, 3 insertions(+), 1 deletion(-)
Comments
09/07/2021 17:19, Kevin Traynor:
> rte_stats_bitrate_reg() API states it returns 'Zero on success'.
>
> However, the implementation directly returns the return of
> rte_metrics_reg_names() which may be zero or positive on success,
> with a positive value also indicating the index.
>
> The user of rte_stats_bitrate_reg() should not care about the
> index as it is stored in the opaque rte_stats_bitrates struct.
>
> Change the implementation of rte_stats_bitrate_reg() to match
> the API description by always returning zero on success.
>
> Fixes: 2ad7ba9a6567 ("bitrate: add bitrate statistics library")
>
> Signed-off-by: Kevin Traynor <ktraynor@redhat.com>
Does it require a deprecation notice?
At least I suggest a release note in API section.
What is the target for this series? 21.11?
On 22/07/2021 20:46, Thomas Monjalon wrote:
> 09/07/2021 17:19, Kevin Traynor:
>> rte_stats_bitrate_reg() API states it returns 'Zero on success'.
>>
>> However, the implementation directly returns the return of
>> rte_metrics_reg_names() which may be zero or positive on success,
>> with a positive value also indicating the index.
>>
>> The user of rte_stats_bitrate_reg() should not care about the
>> index as it is stored in the opaque rte_stats_bitrates struct.
>>
>> Change the implementation of rte_stats_bitrate_reg() to match
>> the API description by always returning zero on success.
>>
>> Fixes: 2ad7ba9a6567 ("bitrate: add bitrate statistics library")
>>
>> Signed-off-by: Kevin Traynor <ktraynor@redhat.com>
>
> Does it require a deprecation notice?
I'm not certain, but I don't think it does. It is fixing the
implementation so it behaves as the API is documented to.
> At least I suggest a release note in API section.
>
> What is the target for this series? 21.11?
>
No urgency, 21.11 is fine for this set.
>
>
22/07/2021 22:24, Kevin Traynor:
> On 22/07/2021 20:46, Thomas Monjalon wrote:
> > 09/07/2021 17:19, Kevin Traynor:
> >> rte_stats_bitrate_reg() API states it returns 'Zero on success'.
> >>
> >> However, the implementation directly returns the return of
> >> rte_metrics_reg_names() which may be zero or positive on success,
> >> with a positive value also indicating the index.
> >>
> >> The user of rte_stats_bitrate_reg() should not care about the
> >> index as it is stored in the opaque rte_stats_bitrates struct.
> >>
> >> Change the implementation of rte_stats_bitrate_reg() to match
> >> the API description by always returning zero on success.
> >>
> >> Fixes: 2ad7ba9a6567 ("bitrate: add bitrate statistics library")
> >>
> >> Signed-off-by: Kevin Traynor <ktraynor@redhat.com>
> >
> > Does it require a deprecation notice?
>
> I'm not certain, but I don't think it does. It is fixing the
> implementation so it behaves as the API is documented to.
>
> > At least I suggest a release note in API section.
> >
> > What is the target for this series? 21.11?
> >
>
> No urgency, 21.11 is fine for this set.
Applied, thanks.
@@ -56,6 +56,8 @@ rte_stats_bitrate_reg(struct rte_stats_bitrates *bitrate_data)
return_value = rte_metrics_reg_names(&names[0], RTE_DIM(names));
- if (return_value >= 0)
+ if (return_value >= 0) {
bitrate_data->id_stats_set = return_value;
+ return 0;
+ }
return return_value;
}