:orphan: .. index:: pair: group; Toeplitz hash .. _doxid-group__te__tools__te__toeplitz: Toeplitz hash ============= .. toctree:: :hidden: enum_te_toeplitz_hash_variant.rst Overview ~~~~~~~~ Definition of API to calculate hash used by RSS Copyright (C) 2004-2022 OKTET Labs Ltd. :ref:`More...` .. ref-code-block:: cpp :class: doxyrest-overview-code-block // typedefs typedef struct te_toeplitz_hash_cache :target:`te_toeplitz_hash_cache`; typedef enum :ref:`te_toeplitz_hash_variant` :ref:`te_toeplitz_hash_variant`; // enums enum :ref:`te_toeplitz_hash_variant`; // global functions uint32_t :ref:`te_toeplitz_hash_data`(const te_toeplitz_hash_cache* toeplitz_hash_cache, const uint8_t* input, unsigned int pos, unsigned int datalen); uint32_t :ref:`te_toeplitz_hash`(const te_toeplitz_hash_cache* toeplitz_hash_cache, unsigned int addr_size, const uint8_t* src_addr, uint16_t src_port, const uint8_t* dst_addr, uint16_t dst_port); :ref:`te_errno` :ref:`te_toeplitz_hash_sa`(const te_toeplitz_hash_cache* toeplitz_hash_cache, const struct sockaddr* src_addr, const struct sockaddr* dst_addr, :ref:`te_toeplitz_hash_variant` hash_var, uint32_t* hash_out); uint32_t :ref:`te_toeplitz_hash_sym_or_xor`(const te_toeplitz_hash_cache* toeplitz_hash_cache, unsigned int addr_size, const uint8_t* src_addr, uint16_t src_port, const uint8_t* dst_addr, uint16_t dst_port); void :ref:`te_toeplitz_hash_fini`(te_toeplitz_hash_cache* toeplitz_hash_cache); te_toeplitz_hash_cache* :ref:`te_toeplitz_cache_init`(const uint8_t* key); te_toeplitz_hash_cache* :ref:`te_toeplitz_cache_init_size`(const uint8_t* key, size_t key_size); .. _details-group__te__tools__te__toeplitz: Detailed Documentation ~~~~~~~~~~~~~~~~~~~~~~ Definition of API to calculate hash used by RSS Copyright (C) 2004-2022 OKTET Labs Ltd. All rights reserved. Typedefs -------- .. index:: pair: typedef; te_toeplitz_hash_variant .. _doxid-group__te__tools__te__toeplitz_1ga0823b643145d0d300b25f968265c0b74: .. ref-code-block:: cpp :class: doxyrest-title-code-block typedef enum :ref:`te_toeplitz_hash_variant` te_toeplitz_hash_variant Known variants of Toeplitz hash algorithm Global Functions ---------------- .. index:: pair: function; te_toeplitz_hash_data .. _doxid-group__te__tools__te__toeplitz_1ga2c62002eeebf1fe7c9462f52822dfe1c: .. ref-code-block:: cpp :class: doxyrest-title-code-block uint32_t te_toeplitz_hash_data(const te_toeplitz_hash_cache* toeplitz_hash_cache, const uint8_t* input, unsigned int pos, unsigned int datalen) Calculate a Toeplitz hash of input data .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - toeplitz_hash_cache - Pre-constructed cache * - input - Pointer to input data * - pos - Position of input data * - datalen - Length of input data in bytes * - RSS - hash value of input data .. index:: pair: function; te_toeplitz_hash .. _doxid-group__te__tools__te__toeplitz_1ga91c0e4532ac5907319e8e0cc8b44d716: .. ref-code-block:: cpp :class: doxyrest-title-code-block uint32_t te_toeplitz_hash(const te_toeplitz_hash_cache* toeplitz_hash_cache, unsigned int addr_size, const uint8_t* src_addr, uint16_t src_port, const uint8_t* dst_addr, uint16_t dst_port) Calculate a RSS hash using pre-calculated cache .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - toeplitz_hash_cache - Pre-constructed cache * - addr_size - IPv4 / IPv6 address length * - src_addr - Pointer to source address * - src_port - Source port number in network byte order * - dst_addr - Pointer to destination address * - dst_port - Desination port number in network byte order * - RSS - hash value .. index:: pair: function; te_toeplitz_hash_sa .. _doxid-group__te__tools__te__toeplitz_1ga83b192dff1fb875b640bab09615617d9: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` te_toeplitz_hash_sa(const te_toeplitz_hash_cache* toeplitz_hash_cache, const struct sockaddr* src_addr, const struct sockaddr* dst_addr, :ref:`te_toeplitz_hash_variant` hash_var, uint32_t* hash_out) Calculate a RSS hash for address/port pairs using pre-calculated cache. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - toeplitz_hash_cache - Pre-constructed cache * - src_addr - Source address/port * - dst_addr - Destination address/port * - hash_var - Hash variant * - hash_out - Where to save computed hash .. rubric:: Returns: Status code .. index:: pair: function; te_toeplitz_hash_sym_or_xor .. _doxid-group__te__tools__te__toeplitz_1ga9d475d243cbdf5f43667cf9f2e61b47f: .. ref-code-block:: cpp :class: doxyrest-title-code-block uint32_t te_toeplitz_hash_sym_or_xor(const te_toeplitz_hash_cache* toeplitz_hash_cache, unsigned int addr_size, const uint8_t* src_addr, uint16_t src_port, const uint8_t* dst_addr, uint16_t dst_port) Calculate a RSS hash using pre-calculated cache and symmetric algorithm with OR and XOR. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - toeplitz_hash_cache - Pre-constructed cache * - addr_size - IPv4 / IPv6 address length * - src_addr - Pointer to source address * - src_port - Source port number in network byte order * - dst_addr - Pointer to destination address * - dst_port - Desination port number in network byte order .. rubric:: Returns: RSS hash value. .. index:: pair: function; te_toeplitz_hash_fini .. _doxid-group__te__tools__te__toeplitz_1ga64b598d91680c245a967d7fe0641fd1f: .. ref-code-block:: cpp :class: doxyrest-title-code-block void te_toeplitz_hash_fini(te_toeplitz_hash_cache* toeplitz_hash_cache) Free pre-constructed cache .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - toeplitz_hash_cache - Pointer to cache .. index:: pair: function; te_toeplitz_cache_init .. _doxid-group__te__tools__te__toeplitz_1gac69ffd32b15ed85d87d4adff14542d20: .. ref-code-block:: cpp :class: doxyrest-title-code-block te_toeplitz_hash_cache* te_toeplitz_cache_init(const uint8_t* key) Pre-construct cache to use it for faster calculating of hash used by Toeplitz hash function .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - key - 40-byte hash key * - cache - or NULL in case of error .. index:: pair: function; te_toeplitz_cache_init_size .. _doxid-group__te__tools__te__toeplitz_1ga9141667f05ef29468132aabb1ece8a77: .. ref-code-block:: cpp :class: doxyrest-title-code-block te_toeplitz_hash_cache* te_toeplitz_cache_init_size(const uint8_t* key, size_t key_size) Pre-construct cache to use it for faster calculation of Toeplitz hash function. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - key - Hash key * - key_size - Length of the key in bytes * - cache - or NULL in case of error