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 91843A0C4E; Thu, 22 Jul 2021 11:33:12 +0200 (CEST) Received: from [217.70.189.124] (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 53C5D4014D; Thu, 22 Jul 2021 11:33:12 +0200 (CEST) Received: from shelob.oktetlabs.ru (shelob.oktetlabs.ru [91.220.146.113]) by mails.dpdk.org (Postfix) with ESMTP id 88EA440040; Thu, 22 Jul 2021 11:33:10 +0200 (CEST) Received: from [192.168.100.116] (unknown [37.139.99.76]) (using TLSv1.3 with cipher TLS_AES_128_GCM_SHA256 (128/128 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest SHA256) (No client certificate requested) by shelob.oktetlabs.ru (Postfix) with ESMTPSA id C127B7F529; Thu, 22 Jul 2021 12:33:09 +0300 (MSK) DKIM-Filter: OpenDKIM Filter v2.11.0 shelob.oktetlabs.ru C127B7F529 DKIM-Signature: v=1; a=rsa-sha256; c=simple/simple; d=oktetlabs.ru; s=default; t=1626946390; bh=zQ0yuDyfQKnznyv+7qsoBl05XaE3cYV+/oh3Nf8hpCw=; h=Subject:To:Cc:References:From:Date:In-Reply-To; b=ef4ZDIVHY01W5dVpikAKNURmIxu7ludDxZZ/+NoRfPRNfdkWkAUbbnYn3+95RcIyr Pt2UssE84O+2THg24doHQjAvhiISNXlDdXjDLAGCnunmoCMdOcXnBs+4kAIxTNhpEA YqJfqVHYnTfMrvqoJe9Ob1vrKP19dB23ndDs4MZc= To: Ferruh Yigit , dev@dpdk.org Cc: Ivan Ilchenko , stable@dpdk.org, Andy Moreton , Thomas Monjalon , Kuba Kozak References: <20210604144225.287678-1-andrew.rybchenko@oktetlabs.ru> <20210604144225.287678-5-andrew.rybchenko@oktetlabs.ru> <16f738a7-28b7-bd41-cfd2-60f35f868c32@intel.com> From: Andrew Rybchenko Message-ID: <7b25c75c-6a4a-fd51-09e9-af9ecac1a7cf@oktetlabs.ru> Date: Thu, 22 Jul 2021 12:33:08 +0300 User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:78.0) Gecko/20100101 Thunderbird/78.12.0 MIME-Version: 1.0 In-Reply-To: <16f738a7-28b7-bd41-cfd2-60f35f868c32@intel.com> Content-Type: text/plain; charset=utf-8; format=flowed Content-Language: en-US Content-Transfer-Encoding: 7bit Subject: Re: [dpdk-dev] [PATCH 04/11] 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/20/21 7:51 PM, Ferruh Yigit wrote: > On 6/4/2021 3:42 PM, 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. > > Should it mention _by_id detail? Yes, will fix in v2. >> + * >> + * @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. > > Should it mention _by_id detail? Yes, will fix in v2. >> + * For name count, set @p xstats_names and @p ids to NULL. >> + * > > isn't the 'count' part handled in the API? I think in the devops both should not > be NULL. No, eth_dev_get_xstats_count() uses the callback with NULL, NULL, 0. > >> + * @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. > > As far as I understand both _by_id APIs and devops behave same, so argument > descriptions/behavior should be same. In fact no, it is slightly different. For example, devops is never called with NULL ids and not NULL names or non-zero size. It allows to check less in drivers. >> + * @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 >> + * >> + * @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. > > Again as far as I can see these covered by API, not devops, am I missing something. See eth_dev_get_xstats_count() > >> + * - 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, >>