rte_fib6.h

Go to the documentation of this file.

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

#ifndef _RTE_FIB6_H_
#define _RTE_FIB6_H_

#include <stdint.h>

#include <rte_common.h>
#include <rte_ip6.h>
#include <rte_rcu_qsbr.h>

#ifdef __cplusplus
extern "C" {
#endif

#define RTE_FIB6_IPV6_ADDR_SIZE (RTE_DEPRECATED(RTE_FIB6_IPV6_ADDR_SIZE) RTE_IPV6_ADDR_SIZE)

#define RTE_FIB6_MAXDEPTH (RTE_DEPRECATED(RTE_FIB6_MAXDEPTH) RTE_IPV6_MAX_DEPTH)

/* Maximum length of a FIB name. */
#define RTE_FIB6_NAMESIZE   64

struct rte_fib6;
struct rte_rib6;

#define RTE_FIB6_RCU_DQ_RECLAIM_MAX     16

#define RTE_FIB6_RCU_DQ_RECLAIM_SZ      128

enum rte_fib6_qsbr_mode {
    RTE_FIB6_QSBR_MODE_DQ = 0,
    RTE_FIB6_QSBR_MODE_SYNC
};

enum rte_fib6_type {
    RTE_FIB6_DUMMY,     
    RTE_FIB6_TRIE       
};

typedef int (*rte_fib6_modify_fn_t)(struct rte_fib6 *fib,
    const struct rte_ipv6_addr *ip, uint8_t depth,
    uint64_t next_hop, int op);
typedef void (*rte_fib6_lookup_fn_t)(void *fib,
    const struct rte_ipv6_addr *ips,
    uint64_t *next_hops, const unsigned int n);

enum rte_fib6_op {
    RTE_FIB6_ADD,
    RTE_FIB6_DEL,
};

enum rte_fib_trie_nh_sz {
    RTE_FIB6_TRIE_2B = 1,
    RTE_FIB6_TRIE_4B,
    RTE_FIB6_TRIE_8B
};

enum rte_fib6_lookup_type {
    RTE_FIB6_LOOKUP_DEFAULT,
    RTE_FIB6_LOOKUP_TRIE_SCALAR, 
    RTE_FIB6_LOOKUP_TRIE_VECTOR_AVX512 
};

struct rte_fib6_conf {
    enum rte_fib6_type type; 
    uint64_t default_nh;
    int max_routes;
    unsigned int rib_ext_sz;
    union {
        struct {
            enum rte_fib_trie_nh_sz nh_sz;
            uint32_t    num_tbl8;
        } trie;
    };
};

struct rte_fib6_rcu_config {
    struct rte_rcu_qsbr *v;
    enum rte_fib6_qsbr_mode mode;
    uint32_t dq_size;
    uint32_t reclaim_thd;
    uint32_t reclaim_max;
};

void
rte_fib6_free(struct rte_fib6 *fib);

struct rte_fib6 *
rte_fib6_create(const char *name, int socket_id, struct rte_fib6_conf *conf)
    __rte_malloc __rte_dealloc(rte_fib6_free, 1);

struct rte_fib6 *
rte_fib6_find_existing(const char *name);

int
rte_fib6_add(struct rte_fib6 *fib, const struct rte_ipv6_addr *ip,
    uint8_t depth, uint64_t next_hop);

int
rte_fib6_delete(struct rte_fib6 *fib,
    const struct rte_ipv6_addr *ip, uint8_t depth);

int
rte_fib6_lookup_bulk(struct rte_fib6 *fib,
    const struct rte_ipv6_addr *ips,
    uint64_t *next_hops, int n);

void *
rte_fib6_get_dp(struct rte_fib6 *fib);

struct rte_rib6 *
rte_fib6_get_rib(struct rte_fib6 *fib);

int
rte_fib6_select_lookup(struct rte_fib6 *fib, enum rte_fib6_lookup_type type);

__rte_experimental
int
rte_fib6_rcu_qsbr_add(struct rte_fib6 *fib, struct rte_fib6_rcu_config *cfg);

#ifdef __cplusplus
}
#endif

#endif /* _RTE_FIB6_H_ */