rte_rib.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_RIB_H_
#define _RTE_RIB_H_

#include <stdlib.h>
#include <stdint.h>

#include <rte_compat.h>

#ifdef __cplusplus
extern "C" {
#endif

enum {
    RTE_RIB_GET_NXT_ALL,
    RTE_RIB_GET_NXT_COVER
};

struct rte_rib;
struct rte_rib_node;

struct rte_rib_conf {
    size_t  ext_sz;
    /* size of rte_rib_node's pool */
    int max_nodes;
};

static inline uint32_t
rte_rib_depth_to_mask(uint8_t depth)
{
    return (uint32_t)(UINT64_MAX << (32 - depth));
}

__rte_experimental
struct rte_rib_node *
rte_rib_lookup(struct rte_rib *rib, uint32_t ip);

__rte_experimental
struct rte_rib_node *
rte_rib_lookup_parent(struct rte_rib_node *ent);

__rte_experimental
struct rte_rib_node *
rte_rib_lookup_exact(struct rte_rib *rib, uint32_t ip, uint8_t depth);

__rte_experimental
struct rte_rib_node *
rte_rib_get_nxt(struct rte_rib *rib, uint32_t ip, uint8_t depth,
    struct rte_rib_node *last, int flag);

__rte_experimental
void
rte_rib_remove(struct rte_rib *rib, uint32_t ip, uint8_t depth);

__rte_experimental
struct rte_rib_node *
rte_rib_insert(struct rte_rib *rib, uint32_t ip, uint8_t depth);

__rte_experimental
int
rte_rib_get_ip(const struct rte_rib_node *node, uint32_t *ip);

__rte_experimental
int
rte_rib_get_depth(const struct rte_rib_node *node, uint8_t *depth);

__rte_experimental
void *
rte_rib_get_ext(struct rte_rib_node *node);

__rte_experimental
int
rte_rib_get_nh(const struct rte_rib_node *node, uint64_t *nh);

__rte_experimental
int
rte_rib_set_nh(struct rte_rib_node *node, uint64_t nh);

__rte_experimental
struct rte_rib *
rte_rib_create(const char *name, int socket_id,
           const struct rte_rib_conf *conf);

__rte_experimental
struct rte_rib *
rte_rib_find_existing(const char *name);

__rte_experimental
void
rte_rib_free(struct rte_rib *rib);

#ifdef __cplusplus
}
#endif

#endif /* _RTE_RIB_H_ */