rte_member.h

Go to the documentation of this file.

/* SPDX-License-Identifier: BSD-3-Clause
 * Copyright(c) 2017 Intel Corporation
 */

#ifndef _RTE_MEMBER_H_
#define _RTE_MEMBER_H_

#ifdef __cplusplus
extern "C" {
#endif

#include <stdint.h>
#include <stdbool.h>
#include <inttypes.h>

#include <rte_common.h>

typedef uint16_t member_set_t;
#define RTE_MEMBER_NO_MATCH 0

#define RTE_MEMBER_ENTRIES_MAX (1 << 30)

#define RTE_MEMBER_LOOKUP_BULK_MAX 64

#define RTE_MEMBER_BUCKET_ENTRIES 16

#define RTE_MEMBER_NAMESIZE 32

#define RTE_RAND_MAX      ~0LLU

#define RTE_MEMBER_SKETCH_ALWAYS_BOUNDED 0x01

#define RTE_MEMBER_SKETCH_COUNT_BYTE 0x02

#if defined(RTE_ARCH_X86) || defined(__ARM_FEATURE_CRC32)
#include <rte_hash_crc.h>
#define MEMBER_HASH_FUNC       rte_hash_crc
#else
#include <rte_jhash.h>
#define MEMBER_HASH_FUNC       rte_jhash
#endif

struct rte_member_setsum;

struct rte_member_parameters;

enum rte_member_setsum_type {
    RTE_MEMBER_TYPE_HT = 0,  
    RTE_MEMBER_TYPE_VBF,     
    RTE_MEMBER_TYPE_SKETCH,
    RTE_MEMBER_NUM_TYPE
};

enum rte_member_sig_compare_function {
    RTE_MEMBER_COMPARE_SCALAR = 0,
    RTE_MEMBER_COMPARE_AVX2,
    RTE_MEMBER_COMPARE_NUM
};

/* sketch update function with different implementations. */
typedef void (*sketch_update_fn_t)(const struct rte_member_setsum *ss,
                   const void *key,
                   uint32_t count);

/* sketch lookup function with different implementations. */
typedef uint64_t (*sketch_lookup_fn_t)(const struct rte_member_setsum *ss,
                       const void *key);

/* sketch delete function with different implementations. */
typedef void (*sketch_delete_fn_t)(const struct rte_member_setsum *ss,
                   const void *key);

struct __rte_cache_aligned rte_member_setsum {
    enum rte_member_setsum_type type; /* Type of the set summary. */
    uint32_t key_len;       /* Length of key. */
    uint32_t prim_hash_seed;    /* Primary hash function seed. */
    uint32_t sec_hash_seed;     /* Secondary hash function seed. */

    /* Hash table based. */
    uint32_t bucket_cnt;        /* Number of buckets. */
    uint32_t bucket_mask;       /* Bit mask to get bucket index. */
    /* For runtime selecting AVX, scalar, etc for signature comparison. */
    enum rte_member_sig_compare_function sig_cmp_fn;
    uint8_t cache;          /* If it is cache mode for ht based. */

    /* Vector bloom filter. */
    uint32_t num_set;       /* Number of set (bf) in vbf. */
    uint32_t bits;          /* Number of bits in each bf. */
    uint32_t bit_mask;  /* Bit mask to get bit location in bf. */
    uint32_t num_hashes;    /* Number of hash values to index bf. */

    /* Parameters for sketch */
    float error_rate;
    float sample_rate;
    uint32_t num_col;
    uint32_t num_row;
    int always_bounded;
    double converge_thresh;
    uint32_t topk;
    uint32_t count_byte;
    uint64_t *hash_seeds;
    sketch_update_fn_t sketch_update; /* Pointer to the sketch update function */
    sketch_lookup_fn_t sketch_lookup; /* Pointer to the sketch lookup function */
    sketch_delete_fn_t sketch_delete; /* Pointer to the sketch delete function */

    void *runtime_var;
    uint32_t mul_shift;  /* vbf internal variable used during bit test. */
    uint32_t div_shift;  /* vbf internal variable used during bit test. */

    void *table;    /* This is the handler of hash table or vBF array. */


    /* Second cache line should start here. */
    uint32_t socket_id;          /* NUMA Socket ID for memory. */
    char name[RTE_MEMBER_NAMESIZE]; /* Name of this set summary. */
#ifdef RTE_ARCH_X86
    bool use_avx512;
#endif
};

struct __rte_cache_aligned rte_member_parameters {
    const char *name;           
    enum rte_member_setsum_type type;

    uint8_t is_cache;

    uint32_t num_keys;

    uint32_t key_len;

    uint32_t num_set;

    float false_positive_rate;

    uint32_t prim_hash_seed;

    uint32_t sec_hash_seed;

    float error_rate;

    float sample_rate;

    uint32_t top_k;

    uint32_t extra_flag;

    int socket_id;          
};

struct rte_member_setsum *
rte_member_find_existing(const char *name);

struct rte_member_setsum *
rte_member_create(const struct rte_member_parameters *params);

int
rte_member_lookup(const struct rte_member_setsum *setsum, const void *key,
            member_set_t *set_id);

int
rte_member_lookup_bulk(const struct rte_member_setsum *setsum,
            const void **keys, uint32_t num_keys,
            member_set_t *set_ids);

int
rte_member_lookup_multi(const struct rte_member_setsum *setsum,
        const void *key, uint32_t max_match_per_key,
        member_set_t *set_id);

int
rte_member_lookup_multi_bulk(const struct rte_member_setsum *setsum,
        const void **keys, uint32_t num_keys,
        uint32_t max_match_per_key,
        uint32_t *match_count,
        member_set_t *set_ids);

int
rte_member_add(const struct rte_member_setsum *setsum, const void *key,
            member_set_t set_id);

int
rte_member_add_byte_count(const struct rte_member_setsum *setsum,
              const void *key, uint32_t byte_count);

int
rte_member_query_count(const struct rte_member_setsum *setsum,
               const void *key, uint64_t *count);


int
rte_member_report_heavyhitter(const struct rte_member_setsum *setsum,
                  void **keys, uint64_t *counts);


void
rte_member_free(struct rte_member_setsum *setsum);

void
rte_member_reset(const struct rte_member_setsum *setsum);

int
rte_member_delete(const struct rte_member_setsum *setsum, const void *key,
            member_set_t set_id);

#ifdef __cplusplus
}
#endif

#endif /* _RTE_MEMBER_H_ */