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 276824236B; Thu, 12 Oct 2023 04:03:12 +0200 (CEST) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 0BB27402BA; Thu, 12 Oct 2023 04:03:12 +0200 (CEST) Received: from szxga01-in.huawei.com (szxga01-in.huawei.com [45.249.212.187]) by mails.dpdk.org (Postfix) with ESMTP id 39BE440279 for ; Thu, 12 Oct 2023 04:03:10 +0200 (CEST) Received: from kwepemi500020.china.huawei.com (unknown [172.30.72.54]) by szxga01-in.huawei.com (SkyGuard) with ESMTP id 4S5XsW6fqzzrTGJ; Thu, 12 Oct 2023 10:00:31 +0800 (CST) Received: from [10.67.121.175] (10.67.121.175) by kwepemi500020.china.huawei.com (7.221.188.8) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256) id 15.1.2507.31; Thu, 12 Oct 2023 10:03:06 +0800 Message-ID: <1c1c4a96-275d-ba61-c5b2-b99d59f5118f@huawei.com> Date: Thu, 12 Oct 2023 10:03:06 +0800 MIME-Version: 1.0 User-Agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:91.0) Gecko/20100101 Thunderbird/91.9.1 Subject: Re: [PATCH v5 01/40] ethdev: overwrite some comment related to RSS To: Ferruh Yigit , , Thomas Monjalon , Andrew Rybchenko , Ori Kam CC: , , References: <20230908080030.3837515-1-haijie1@huawei.com> <20231011092805.693171-1-haijie1@huawei.com> <20231011092805.693171-2-haijie1@huawei.com> <5886a6e6-1bd1-48e6-95c0-7384eac710e2@amd.com> From: Jie Hai In-Reply-To: <5886a6e6-1bd1-48e6-95c0-7384eac710e2@amd.com> Content-Type: text/plain; charset="UTF-8"; format=flowed Content-Transfer-Encoding: 7bit X-Originating-IP: [10.67.121.175] X-ClientProxiedBy: dggems704-chm.china.huawei.com (10.3.19.181) To kwepemi500020.china.huawei.com (7.221.188.8) X-CFilter-Loop: Reflected 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 On 2023/10/12 0:31, Ferruh Yigit wrote: > On 10/11/2023 10:27 AM, Jie Hai wrote: >> 1. overwrite the comments of fields of 'rte_eth_rss_conf'. >> 2. Add comments for RTE_ETH_HASH_FUNCTION_DEFAULT. >> >> Signed-off-by: Jie Hai >> --- >> lib/ethdev/rte_ethdev.h | 29 ++++++++++++++--------------- >> lib/ethdev/rte_flow.h | 3 +++ >> 2 files changed, 17 insertions(+), 15 deletions(-) >> >> diff --git a/lib/ethdev/rte_ethdev.h b/lib/ethdev/rte_ethdev.h >> index 8542257721c9..b9e4e21189d2 100644 >> --- a/lib/ethdev/rte_ethdev.h >> +++ b/lib/ethdev/rte_ethdev.h >> @@ -448,24 +448,23 @@ struct rte_vlan_filter_conf { >> /** >> * A structure used to configure the Receive Side Scaling (RSS) feature >> * of an Ethernet port. >> - * If not NULL, the *rss_key* pointer of the *rss_conf* structure points >> - * to an array holding the RSS key to use for hashing specific header >> - * fields of received packets. The length of this array should be indicated >> - * by *rss_key_len* below. Otherwise, a default random hash key is used by >> - * the device driver. >> - * >> - * The *rss_key_len* field of the *rss_conf* structure indicates the length >> - * in bytes of the array pointed by *rss_key*. To be compatible, this length >> - * will be checked in i40e only. Others assume 40 bytes to be used as before. >> - * >> - * The *rss_hf* field of the *rss_conf* structure indicates the different >> - * types of IPv4/IPv6 packets to which the RSS hashing must be applied. >> - * Supplying an *rss_hf* equal to zero disables the RSS feature. >> */ >> struct rte_eth_rss_conf { >> - uint8_t *rss_key; /**< If not NULL, 40-byte hash key. */ >> + /** >> + * If used to query, the'rss_key_len' indicates the size of rss key of >> + * the hardware. And only when rss_key_len is not zero, the 'rss_key' >> + * is valid. >> + * If used to configure, rss_key_len indicates the length of the >> + * 'rss_key' if 'rss_key' is not empty. >> > > Ahh, different APIs have different expectations :( > Can you please explicitly name the APIs, instead of "to query", "to > configure"? > > And there is a note in original comment that *rss_key_len* is only > checked by i40e, rest assume this value as 40 bytes. New comment doesn't > have it. > A new version is show below: * In rte_eth_dev_rss_hash_conf_get(), the *rss_key_len* indicates the * size of rss key of the hardware. And only when *rss_key_len* is not * zero, the *rss_key* is valid. * * In rte_eth_dev_rss_hash_update() or rte_eth_dev_configure(), the * *rss_key_len* indicates the length of the *rss_key* in bytes of * the array pointed by *rss_key*. Drivers are free to ignore the * *rss_key_len* and assume key length is 40 bytes. Please check it. Thanks > >> + */ >> + uint8_t *rss_key; >> uint8_t rss_key_len; /**< hash key length in bytes. */ >> - uint64_t rss_hf; /**< Hash functions to apply - see below. */ >> + /** >> + * Indicating which type of packets and which part of the packets >> + * to apply for RSS hash, (see RTE_ETH_RSS_*). >> > > There is something doesn't sound right from language perspective, > perhaps someone whose native language is English can help, what about: > > "Indicates the type of packets or the specific part of packets to which > RSS hashing is to be applied." > > Better, I will change it. >> + * Setting *rss_hf* to zero disables the RSS feature. >> + */ >> + uint64_t rss_hf; >> }; >> >> /* >> diff --git a/lib/ethdev/rte_flow.h b/lib/ethdev/rte_flow.h >> index b385741fba6d..5d9e3c68af7b 100644 >> --- a/lib/ethdev/rte_flow.h >> +++ b/lib/ethdev/rte_flow.h >> @@ -3227,6 +3227,9 @@ struct rte_flow_query_count { >> * Hash function types. >> */ >> enum rte_eth_hash_function { >> + /** >> + * DEFAULT means driver decides which hash algorithm to pick. >> + */ >> RTE_ETH_HASH_FUNCTION_DEFAULT = 0, >> RTE_ETH_HASH_FUNCTION_TOEPLITZ, /**< Toeplitz */ >> RTE_ETH_HASH_FUNCTION_SIMPLE_XOR, /**< Simple XOR */ > > .