rte_fib.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_FIB_H_
#define _RTE_FIB_H_

#include <stdint.h>

#include <rte_rcu_qsbr.h>

#ifdef __cplusplus
extern "C" {
#endif

struct rte_fib;
struct rte_rib;

#define RTE_FIB_MAXDEPTH    32

#define RTE_FIB_RCU_DQ_RECLAIM_MAX  16

#define RTE_FIB_RCU_DQ_RECLAIM_SZ   128

enum rte_fib_qsbr_mode {
    RTE_FIB_QSBR_MODE_DQ = 0,
    RTE_FIB_QSBR_MODE_SYNC
};

enum rte_fib_type {
    RTE_FIB_DUMMY,      
    RTE_FIB_DIR24_8     
};

typedef int (*rte_fib_modify_fn_t)(struct rte_fib *fib, uint32_t ip,
    uint8_t depth, uint64_t next_hop, int op);
typedef void (*rte_fib_lookup_fn_t)(void *fib, const uint32_t *ips,
    uint64_t *next_hops, const unsigned int n);

enum rte_fib_op {
    RTE_FIB_ADD,
    RTE_FIB_DEL,
};

enum rte_fib_dir24_8_nh_sz {
    RTE_FIB_DIR24_8_1B,
    RTE_FIB_DIR24_8_2B,
    RTE_FIB_DIR24_8_4B,
    RTE_FIB_DIR24_8_8B
};

enum rte_fib_lookup_type {
    RTE_FIB_LOOKUP_DEFAULT,
    RTE_FIB_LOOKUP_DIR24_8_SCALAR_MACRO,
    RTE_FIB_LOOKUP_DIR24_8_SCALAR_INLINE,
    RTE_FIB_LOOKUP_DIR24_8_SCALAR_UNI,
    RTE_FIB_LOOKUP_DIR24_8_VECTOR_AVX512
};

#define RTE_FIB_F_NETWORK_ORDER 1
#define RTE_FIB_ALLOWED_FLAGS   (RTE_FIB_F_NETWORK_ORDER)

struct rte_fib_conf {
    enum rte_fib_type type; 
    uint64_t default_nh;
    int max_routes;
    unsigned int rib_ext_sz;
    union {
        struct {
            enum rte_fib_dir24_8_nh_sz nh_sz;
            uint32_t    num_tbl8;
        } dir24_8;
    };
    unsigned int flags; 
};

struct rte_fib_rcu_config {
    struct rte_rcu_qsbr *v;
    enum rte_fib_qsbr_mode mode;
    uint32_t dq_size;
    uint32_t reclaim_thd;
    uint32_t reclaim_max;
};

struct rte_fib *
rte_fib_create(const char *name, int socket_id, struct rte_fib_conf *conf);

struct rte_fib *
rte_fib_find_existing(const char *name);

void
rte_fib_free(struct rte_fib *fib);

int
rte_fib_add(struct rte_fib *fib, uint32_t ip, uint8_t depth, uint64_t next_hop);

int
rte_fib_delete(struct rte_fib *fib, uint32_t ip, uint8_t depth);

int
rte_fib_lookup_bulk(struct rte_fib *fib, uint32_t *ips,
        uint64_t *next_hops, int n);
void *
rte_fib_get_dp(struct rte_fib *fib);

struct rte_rib *
rte_fib_get_rib(struct rte_fib *fib);

int
rte_fib_select_lookup(struct rte_fib *fib, enum rte_fib_lookup_type type);

__rte_experimental
int
rte_fib_rcu_qsbr_add(struct rte_fib *fib, struct rte_fib_rcu_config *cfg);

#ifdef __cplusplus
}
#endif

#endif /* _RTE_FIB_H_ */