xref: /dpdk/lib/node/rte_node_ip6_api.h (revision 2cfebc3f1046e4166e13b4f906e3ddc1c26c7eeb)

/* SPDX-License-Identifier: BSD-3-Clause
 * Copyright(C) 2023 Marvell.
 */

#ifndef __INCLUDE_RTE_NODE_IP6_API_H__
#define __INCLUDE_RTE_NODE_IP6_API_H__

/**
 * @file rte_node_ip6_api.h
 *
 * @warning
 * @b EXPERIMENTAL:
 * All functions in this file may be changed or removed without prior notice.
 *
 * This API allows to do control path functions of ip6_* nodes
 * like ip6_lookup, ip6_rewrite.
 */
#include <rte_common.h>
#include <rte_compat.h>
#include <rte_ip6.h>

#ifdef __cplusplus
extern "C" {
#endif

/**
 * IP6 lookup next nodes.
 */
enum rte_node_ip6_lookup_next {
	RTE_NODE_IP6_LOOKUP_NEXT_REWRITE,
	/**< Rewrite node. */
	RTE_NODE_IP6_LOOKUP_NEXT_PKT_DROP,
	/**< Packet drop node. */
};

/**
 * Add IPv6 route to lookup table.
 *
 * @param ip
 *   IPv6 address of route to be added.
 * @param depth
 *   Depth of the rule to be added.
 * @param next_hop
 *   Next hop id of the rule result to be added.
 * @param next_node
 *   Next node to redirect traffic to.
 *
 * @return
 *   0 on success, negative otherwise.
 */
__rte_experimental
int rte_node_ip6_route_add(const struct rte_ipv6_addr *ip, uint8_t depth, uint16_t next_hop,
			   enum rte_node_ip6_lookup_next next_node);

/**
 * Add a next hop's rewrite data.
 *
 * @param next_hop
 *   Next hop id to add rewrite data to.
 * @param rewrite_data
 *   Rewrite data.
 * @param rewrite_len
 *   Length of rewrite data.
 * @param dst_port
 *   Destination port to redirect traffic to.
 *
 * @return
 *   0 on success, negative otherwise.
 */
__rte_experimental
int rte_node_ip6_rewrite_add(uint16_t next_hop, uint8_t *rewrite_data,
			     uint8_t rewrite_len, uint16_t dst_port);

#ifdef __cplusplus
}
#endif

#endif /* __INCLUDE_RTE_NODE_IP6_API_H__ */