rte_thash.h

Go to the documentation of this file.

/* SPDX-License-Identifier: BSD-3-Clause
 * Copyright(c) 2015-2019 Vladimir Medvedkin <medvedkinv@gmail.com>
 * Copyright(c) 2021 Intel Corporation
 */

#ifndef _RTE_THASH_H
#define _RTE_THASH_H

#ifdef __cplusplus
extern "C" {
#endif

#include <stdint.h>
#include <rte_byteorder.h>
#include <rte_config.h>
#include <rte_ip.h>
#include <rte_common.h>

#if defined(RTE_ARCH_X86) || defined(__ARM_NEON)
#include <rte_vect.h>
#endif

#ifdef RTE_ARCH_X86
/* Byte swap mask used for converting IPv6 address
 * 4-byte chunks to CPU byte order
 */
static const __m128i rte_thash_ipv6_bswap_mask = {
        0x0405060700010203ULL, 0x0C0D0E0F08090A0BULL};
#endif

#define RTE_THASH_V4_L3_LEN ((sizeof(struct rte_ipv4_tuple) -   \
            sizeof(((struct rte_ipv4_tuple *)0)->sctp_tag)) / 4)

#define RTE_THASH_V4_L4_LEN  ((sizeof(struct rte_ipv4_tuple)) / 4)

#define RTE_THASH_V6_L3_LEN ((sizeof(struct rte_ipv6_tuple) -       \
            sizeof(((struct rte_ipv6_tuple *)0)->sctp_tag)) / 4)

#define RTE_THASH_V6_L4_LEN ((sizeof(struct rte_ipv6_tuple)) / 4)

struct rte_ipv4_tuple {
    uint32_t    src_addr;
    uint32_t    dst_addr;
    RTE_STD_C11
    union {
        struct {
            uint16_t dport;
            uint16_t sport;
        };
        uint32_t        sctp_tag;
    };
};

struct rte_ipv6_tuple {
    uint8_t     src_addr[16];
    uint8_t     dst_addr[16];
    RTE_STD_C11
    union {
        struct {
            uint16_t dport;
            uint16_t sport;
        };
        uint32_t        sctp_tag;
    };
};

union rte_thash_tuple {
    struct rte_ipv4_tuple   v4;
    struct rte_ipv6_tuple   v6;
#ifdef RTE_ARCH_X86
} __rte_aligned(XMM_SIZE);
#else
};
#endif

static inline void
rte_convert_rss_key(const uint32_t *orig, uint32_t *targ, int len)
{
    int i;

    for (i = 0; i < (len >> 2); i++)
        targ[i] = rte_be_to_cpu_32(orig[i]);
}

static inline void
rte_thash_load_v6_addrs(const struct rte_ipv6_hdr *orig,
            union rte_thash_tuple *targ)
{
#ifdef RTE_ARCH_X86
    __m128i ipv6 = _mm_loadu_si128((const __m128i *)orig->src_addr);
    *(__m128i *)targ->v6.src_addr =
            _mm_shuffle_epi8(ipv6, rte_thash_ipv6_bswap_mask);
    ipv6 = _mm_loadu_si128((const __m128i *)orig->dst_addr);
    *(__m128i *)targ->v6.dst_addr =
            _mm_shuffle_epi8(ipv6, rte_thash_ipv6_bswap_mask);
#elif defined(__ARM_NEON)
    uint8x16_t ipv6 = vld1q_u8((uint8_t const *)orig->src_addr);
    vst1q_u8((uint8_t *)targ->v6.src_addr, vrev32q_u8(ipv6));
    ipv6 = vld1q_u8((uint8_t const *)orig->dst_addr);
    vst1q_u8((uint8_t *)targ->v6.dst_addr, vrev32q_u8(ipv6));
#else
    int i;
    for (i = 0; i < 4; i++) {
        *((uint32_t *)targ->v6.src_addr + i) =
            rte_be_to_cpu_32(*((const uint32_t *)orig->src_addr + i));
        *((uint32_t *)targ->v6.dst_addr + i) =
            rte_be_to_cpu_32(*((const uint32_t *)orig->dst_addr + i));
    }
#endif
}

static inline uint32_t
rte_softrss(uint32_t *input_tuple, uint32_t input_len,
        const uint8_t *rss_key)
{
    uint32_t i, j, map, ret = 0;

    for (j = 0; j < input_len; j++) {
        for (map = input_tuple[j]; map; map &= (map - 1)) {
            i = rte_bsf32(map);
            ret ^= rte_cpu_to_be_32(((const uint32_t *)rss_key)[j]) << (31 - i) |
                    (uint32_t)((uint64_t)(rte_cpu_to_be_32(((const uint32_t *)rss_key)[j + 1])) >>
                    (i + 1));
        }
    }
    return ret;
}

static inline uint32_t
rte_softrss_be(uint32_t *input_tuple, uint32_t input_len,
        const uint8_t *rss_key)
{
    uint32_t i, j, map, ret = 0;

    for (j = 0; j < input_len; j++) {
        for (map = input_tuple[j]; map; map &= (map - 1)) {
            i = rte_bsf32(map);
            ret ^= ((const uint32_t *)rss_key)[j] << (31 - i) |
                (uint32_t)((uint64_t)(((const uint32_t *)rss_key)[j + 1]) >> (i + 1));
        }
    }
    return ret;
}

#define RTE_THASH_RETA_SZ_MIN   2U

#define RTE_THASH_RETA_SZ_MAX   16U

#define RTE_THASH_IGNORE_PERIOD_OVERFLOW    0x1

#define RTE_THASH_MINIMAL_SEQ           0x2

struct rte_thash_ctx;
struct rte_thash_subtuple_helper;

__rte_experimental
struct rte_thash_ctx *
rte_thash_init_ctx(const char *name, uint32_t key_len, uint32_t reta_sz,
    uint8_t *key, uint32_t flags);

__rte_experimental
struct rte_thash_ctx *
rte_thash_find_existing(const char *name);

__rte_experimental
void
rte_thash_free_ctx(struct rte_thash_ctx *ctx);

__rte_experimental
int
rte_thash_add_helper(struct rte_thash_ctx *ctx, const char *name, uint32_t len,
    uint32_t offset);

__rte_experimental
struct rte_thash_subtuple_helper *
rte_thash_get_helper(struct rte_thash_ctx *ctx, const char *name);

__rte_experimental
uint32_t
rte_thash_get_complement(struct rte_thash_subtuple_helper *h,
    uint32_t hash, uint32_t desired_hash);

__rte_experimental
const uint8_t *
rte_thash_get_key(struct rte_thash_ctx *ctx);

typedef int (*rte_thash_check_tuple_t)(void *userdata, uint8_t *tuple);

__rte_experimental
int
rte_thash_adjust_tuple(struct rte_thash_ctx *ctx,
    struct rte_thash_subtuple_helper *h,
    uint8_t *tuple, unsigned int tuple_len,
    uint32_t desired_value, unsigned int attempts,
    rte_thash_check_tuple_t fn, void *userdata);

#ifdef __cplusplus
}
#endif

#endif /* _RTE_THASH_H */