cne_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-2022 Intel Corporation
 */
 
#ifndef _CNE_FIB6_H_
#define _CNE_FIB6_H_
 
// IWYU pragma: no_include "private_fib6.h"
 
#include <stdint.h>        // for uint8_t, uint64_t, uint32_t
#include <cne_common.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
struct cne_fib6;
struct cne_rib6;
 
#define CNE_FIB6_IPV6_ADDR_SIZE 16
 
enum cne_fib6_type {
    CNE_FIB6_DUMMY, 
    CNE_FIB6_TRIE   
};
 
enum cne_fib_trie_nh_sz { CNE_FIB6_TRIE_2B = 1, CNE_FIB6_TRIE_4B, CNE_FIB6_TRIE_8B };
 
enum cne_fib6_lookup_type {
    CNE_FIB6_LOOKUP_DEFAULT,
    CNE_FIB6_LOOKUP_TRIE_SCALAR,       
    CNE_FIB6_LOOKUP_TRIE_VECTOR_AVX512 
};
 
struct cne_fib6_conf {
    enum cne_fib6_type type; 
    uint64_t default_nh;
    int max_routes;
    union {
        struct {
            enum cne_fib_trie_nh_sz nh_sz;
            uint32_t num_tbl8;
        } trie;
    };
};
 
struct cne_fib6 *cne_fib6_create(const char *name, struct cne_fib6_conf *conf);
 
void cne_fib6_free(struct cne_fib6 *fib);
 
int cne_fib6_add(struct cne_fib6 *fib, const uint8_t ip[CNE_FIB6_IPV6_ADDR_SIZE], uint8_t depth,
                 uint64_t next_hop);
 
int cne_fib6_delete(struct cne_fib6 *fib, const uint8_t ip[CNE_FIB6_IPV6_ADDR_SIZE], uint8_t depth);
 
int cne_fib6_lookup_bulk(struct cne_fib6 *fib, uint8_t ips[][CNE_FIB6_IPV6_ADDR_SIZE],
                         uint64_t *next_hops, int n);
 
void *cne_fib6_get_dp(struct cne_fib6 *fib);
 
struct cne_rib6 *cne_fib6_get_rib(struct cne_fib6 *fib);
 
int cne_fib6_select_lookup(struct cne_fib6 *fib, enum cne_fib6_lookup_type type);
 
#ifdef __cplusplus
}
#endif
 
#endif /* _CNE_FIB6_H_ */