cne_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-2022 Intel Corporation
 */
 
#ifndef _CNE_FIB_H_
#define _CNE_FIB_H_
 
#include <stdint.h>        // for uint32_t, uint64_t, uint8_t
#include <cne_common.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
struct cne_fib;
struct cne_rib;
 
#define CNE_FIB_MAXDEPTH 32
 
enum cne_fib_type {
    CNE_FIB_DUMMY,  
    CNE_FIB_DIR24_8 
};
 
typedef int (*cne_fib_modify_fn_t)(struct cne_fib *fib, uint32_t ip, uint8_t depth,
                                   uint64_t next_hop, int op);
typedef void (*cne_fib_lookup_fn_t)(void *fib, const uint32_t *ips, uint64_t *next_hops,
                                    const unsigned int n);
 
enum cne_fib_op {
    CNE_FIB_ADD,
    CNE_FIB_DEL,
};
 
enum cne_fib_dir24_8_nh_sz {
    CNE_FIB_DIR24_8_1B,
    CNE_FIB_DIR24_8_2B,
    CNE_FIB_DIR24_8_4B,
    CNE_FIB_DIR24_8_8B
};
 
enum cne_fib_lookup_type {
    CNE_FIB_LOOKUP_DEFAULT,
    CNE_FIB_LOOKUP_DIR24_8_SCALAR_MACRO,
    CNE_FIB_LOOKUP_DIR24_8_SCALAR_INLINE,
    CNE_FIB_LOOKUP_DIR24_8_SCALAR_UNI,
    CNE_FIB_LOOKUP_DIR24_8_VECTOR_AVX512
};
 
struct cne_fib_conf {
    enum cne_fib_type type; 
    uint64_t default_nh;
    int max_routes;
    union {
        struct {
            enum cne_fib_dir24_8_nh_sz nh_sz;
            uint32_t num_tbl8;
        } dir24_8;
    };
};
 
struct cne_fib *cne_fib_create(const char *name, struct cne_fib_conf *conf);
 
void cne_fib_free(struct cne_fib *fib);
 
int cne_fib_add(struct cne_fib *fib, uint32_t ip, uint8_t depth, uint64_t next_hop);
 
int cne_fib_delete(struct cne_fib *fib, uint32_t ip, uint8_t depth);
 
int cne_fib_lookup_bulk(struct cne_fib *fib, uint32_t *ips, uint64_t *next_hops, int n);
 
void *cne_fib_get_dp(struct cne_fib *fib);
 
struct cne_rib *cne_fib_get_rib(struct cne_fib *fib);
 
int cne_fib_select_lookup(struct cne_fib *fib, enum cne_fib_lookup_type type);
 
#ifdef __cplusplus
}
#endif
 
#endif /* _CNE_FIB_H_ */