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 CB809A0C55; Mon, 6 Sep 2021 18:04:23 +0200 (CEST) Received: from [217.70.189.124] (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id DE85041134; Mon, 6 Sep 2021 18:04:10 +0200 (CEST) Received: from mga06.intel.com (mga06.intel.com [134.134.136.31]) by mails.dpdk.org (Postfix) with ESMTP id 6BA8441120 for ; Mon, 6 Sep 2021 18:04:09 +0200 (CEST) X-IronPort-AV: E=McAfee;i="6200,9189,10099"; a="281011527" X-IronPort-AV: E=Sophos;i="5.85,272,1624345200"; d="scan'208";a="281011527" Received: from fmsmga007.fm.intel.com ([10.253.24.52]) by orsmga104.jf.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 06 Sep 2021 09:04:09 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.85,272,1624345200"; d="scan'208";a="464093154" Received: from silpixa00400072.ir.intel.com ([10.237.222.213]) by fmsmga007.fm.intel.com with ESMTP; 06 Sep 2021 09:04:07 -0700 From: Vladimir Medvedkin To: dev@dpdk.org Cc: konstantin.ananyev@intel.com, andrey.chilikin@intel.com, yipeng1.wang@intel.com, sameh.gobriel@intel.com, bruce.richardson@intel.com, john.mcnamara@intel.com Date: Mon, 6 Sep 2021 17:03:57 +0100 Message-Id: <1630944239-363648-4-git-send-email-vladimir.medvedkin@intel.com> X-Mailer: git-send-email 2.7.4 In-Reply-To: <1630944239-363648-1-git-send-email-vladimir.medvedkin@intel.com> References: <1630944239-363648-1-git-send-email-vladimir.medvedkin@intel.com> Subject: [dpdk-dev] [PATCH 3/5] doc/hash: update documentation for the thash library 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" This patch adds documentation for the new optimized Toeplitz hash implementation using GFNI. Signed-off-by: Vladimir Medvedkin --- doc/guides/prog_guide/toeplitz_hash_lib.rst | 37 +++++++++++++++++++++++++---- doc/guides/rel_notes/release_21_11.rst | 4 ++++ 2 files changed, 37 insertions(+), 4 deletions(-) diff --git a/doc/guides/prog_guide/toeplitz_hash_lib.rst b/doc/guides/prog_guide/toeplitz_hash_lib.rst index f916857..6f50a18 100644 --- a/doc/guides/prog_guide/toeplitz_hash_lib.rst +++ b/doc/guides/prog_guide/toeplitz_hash_lib.rst @@ -19,24 +19,53 @@ to calculate the RSS hash sum to spread the traffic among the queues. Toeplitz hash function API -------------------------- -There are two functions that provide calculation of the Toeplitz hash sum: +There are four functions that provide calculation of the Toeplitz hash sum: * ``rte_softrss()`` * ``rte_softrss_be()`` +* ``rte_thash_gfni()`` +* ``rte_thash_gfni_x2()`` -Both of these functions take the parameters: +First two functions are scalar implementation and take the parameters: * A pointer to the tuple, containing fields extracted from the packet. * A length of this tuple counted in double words. * A pointer to the RSS hash key corresponding to the one installed on the NIC. -Both functions expect the tuple to be in "host" byte order -and a multiple of 4 bytes in length. +Both of abovementioned _softrss_ functions expect the tuple to be in +"host" byte order and a multiple of 4 bytes in length. The ``rte_softrss()`` function expects the ``rss_key`` to be exactly the same as the one installed on the NIC. The ``rte_softrss_be`` function is a faster implementation, but it expects ``rss_key`` to be converted to the host byte order. +The last two functions are vectorized implementations using +Galois Fields New Instructions. Could be used if ``rte_thash_gfni_supported`` is true. +They expect the tuple to be in network byte order. + +``rte_thash_gfni()`` calculates the hash value for a single tuple, and +``rte_thash_gfni_x2()`` calculates for a two independent tuples in one go. + +``rte_thash_gfni()`` takes the parameters: + +* A pointer to the matrixes derived from the RSS hash key using ``rte_thash_complete_matrix()``. +* A pointer to the tuple. +* A length of the tuple in bytes. + +``rte_thash_gfni_x2()`` takes the parameters: + +* A pointer to the matrices derived from the RSS hash key using ``rte_thash_complete_matrix()``. +* Two tuple pointers. +* A length of the longest tuple in bytes. +* Two pointers on the ``uint32_t`` to write results to. + +``rte_thash_complete_matrix()`` is a function that calculates matrices required by +GFNI implementations from the RSS hash key. It takes the parameters: + +* A pointer to the memory where the matrices will be written. +* A pointer to the RSS hash key. +* Length of the RSS hash key in bytes. + Predictable RSS --------------- diff --git a/doc/guides/rel_notes/release_21_11.rst b/doc/guides/rel_notes/release_21_11.rst index d707a55..df28642 100644 --- a/doc/guides/rel_notes/release_21_11.rst +++ b/doc/guides/rel_notes/release_21_11.rst @@ -55,6 +55,10 @@ New Features Also, make sure to start the actual text at the margin. ======================================================= +* **Added optimized Toeplitz hash implementation.** + + Added optimized Toeplitz hash implementation using Galois Fields New Instructions. + Removed Items ------------- -- 2.7.4