From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id 155ECA0C4C; Tue, 28 Sep 2021 14:04:15 +0200 (CEST) Received: from [217.70.189.124] (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 98787410D7; Tue, 28 Sep 2021 14:04:14 +0200 (CEST) Received: from shelob.oktetlabs.ru (shelob.oktetlabs.ru [91.220.146.113]) by mails.dpdk.org (Postfix) with ESMTP id 89A8740E3C; Tue, 28 Sep 2021 14:04:13 +0200 (CEST) Received: from [192.168.38.17] (aros.oktetlabs.ru [192.168.38.17]) (using TLSv1.3 with cipher TLS_AES_128_GCM_SHA256 (128/128 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits)) (No client certificate requested) by shelob.oktetlabs.ru (Postfix) with ESMTPSA id 136DB7F50B; Tue, 28 Sep 2021 15:04:13 +0300 (MSK) DKIM-Filter: OpenDKIM Filter v2.11.0 shelob.oktetlabs.ru 136DB7F50B DKIM-Signature: v=1; a=rsa-sha256; c=simple/simple; d=oktetlabs.ru; s=default; t=1632830653; bh=WF03sHJTe7rXg/jlzlwoe9FTs3GMUEgJknxSiuBsqXQ=; h=Subject:To:Cc:References:From:Date:In-Reply-To; b=US3u126aYJwKfe3uPEj0lAkuNCKmiflQTtrYO9p9SmUfxO/F42wVrOEIf2a495W9Q VvaBGCg3u+HptgWa3sGEcz1lQUTSoOfDejfe5z2oTLZV+YNpvmyY8dgSIZIOIeuoYn 69tU5Di4szbz4D/4L81BB+0zmQTWSKCAcoGwvXE8= To: Olivier Matz Cc: dev@dpdk.org, Thomas Monjalon , Ferruh Yigit , Kuba Kozak , Ivan Ilchenko , stable@dpdk.org, Andy Moreton References: <20210604144225.287678-1-andrew.rybchenko@oktetlabs.ru> <20210724123314.2970537-1-andrew.rybchenko@oktetlabs.ru> <20210724123314.2970537-2-andrew.rybchenko@oktetlabs.ru> From: Andrew Rybchenko Organization: OKTET Labs Message-ID: <1ff2031f-2208-ba54-bb90-8e2a56326092@oktetlabs.ru> Date: Tue, 28 Sep 2021 15:04:12 +0300 User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:78.0) Gecko/20100101 Thunderbird/78.13.0 MIME-Version: 1.0 In-Reply-To: Content-Type: text/plain; charset=utf-8 Content-Language: en-US Content-Transfer-Encoding: 7bit Subject: Re: [dpdk-dev] [PATCH v4 2/2] ethdev: fix docs of drivers callbacks getting xstats by IDs X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" On 7/26/21 1:13 PM, Olivier Matz wrote: > On Sat, Jul 24, 2021 at 03:33:14PM +0300, Andrew Rybchenko wrote: >> From: Ivan Ilchenko >> >> Update xstats by IDs callbacks documentation in accordance with >> ethdev usage of these callbacks. Document valid combinations of >> input arguments to make driver implementation simpler. >> >> Fixes: 79c913a42f0 ("ethdev: retrieve xstats by ID") >> Cc: stable@dpdk.org >> >> Signed-off-by: Ivan Ilchenko >> Signed-off-by: Andrew Rybchenko >> Reviewed-by: Andy Moreton >> --- >> lib/ethdev/ethdev_driver.h | 43 ++++++++++++++++++++++++++++++++++++-- >> 1 file changed, 41 insertions(+), 2 deletions(-) >> >> diff --git a/lib/ethdev/ethdev_driver.h b/lib/ethdev/ethdev_driver.h >> index 40e474aa7e..fd5b7ca550 100644 >> --- a/lib/ethdev/ethdev_driver.h >> +++ b/lib/ethdev/ethdev_driver.h >> @@ -187,11 +187,28 @@ typedef int (*eth_xstats_get_t)(struct rte_eth_dev *dev, >> struct rte_eth_xstat *stats, unsigned int n); >> /**< @internal Get extended stats of an Ethernet device. */ >> >> +/** >> + * @internal >> + * Get extended stats of an Ethernet device. >> + * >> + * @param dev >> + * ethdev handle of port. >> + * @param ids >> + * IDs array to retrieve specific statistics. Must not be NULL. >> + * @param values >> + * A pointer to a table to be filled with device statistics values. >> + * Must not be NULL. >> + * @param n >> + * Element count in @p ids and @p values >> + * >> + * @return >> + * - A number of filled in stats. >> + * - A negative value on error. >> + */ >> typedef int (*eth_xstats_get_by_id_t)(struct rte_eth_dev *dev, >> const uint64_t *ids, >> uint64_t *values, >> unsigned int n); >> -/**< @internal Get extended stats of an Ethernet device. */ >> >> /** >> * @internal >> @@ -218,10 +235,32 @@ typedef int (*eth_xstats_get_names_t)(struct rte_eth_dev *dev, >> struct rte_eth_xstat_name *xstats_names, unsigned int size); >> /**< @internal Get names of extended stats of an Ethernet device. */ >> >> +/** >> + * @internal >> + * Get names of extended stats of an Ethernet device. >> + * For name count, set @p xstats_names and @p ids to NULL. >> + * >> + * @param dev >> + * ethdev handle of port. >> + * @param xstats_names >> + * An rte_eth_xstat_name array of at least *size* elements to >> + * be filled. Can be NULL together with @p ids to retrieve number of >> + * available statistics. >> + * @param ids >> + * IDs array to retrieve specific statistics. Can be NULL together >> + * with @p xstats_names to retrieve number of available statistics. >> + * @param size >> + * Size of ids and xstats_names arrays. >> + * Element count in @p ids and @p xstats_names > > I think only the second line should be kept. Thanks, fixed in v5. > > Shouldn't we also say here that size should be 0 if arrays are NULL? In this particular case I don't think so. ethdev layer guarantees that the parameter is 0 if both array pointers are NULL. PMD should not care about it. > >> + * >> + * @return >> + * - A number of filled in stats if both xstats_names and ids are not NULL. >> + * - A number of available stats if both xstats_names and ids are NULL. >> + * - A negative value on error. >> + */ >> typedef int (*eth_xstats_get_names_by_id_t)(struct rte_eth_dev *dev, >> struct rte_eth_xstat_name *xstats_names, const uint64_t *ids, >> unsigned int size); >> -/**< @internal Get names of extended stats of an Ethernet device. */ >> >> typedef int (*eth_queue_stats_mapping_set_t)(struct rte_eth_dev *dev, >> uint16_t queue_id, >> -- >> 2.30.2 >>