diff options
Diffstat (limited to 'hicn-plugin/src/udp_tunnels')
| -rw-r--r-- | hicn-plugin/src/udp_tunnels/udp_decap.h | 16 | ||||
| -rw-r--r-- | hicn-plugin/src/udp_tunnels/udp_decap_node.c | 6 | ||||
| -rw-r--r-- | hicn-plugin/src/udp_tunnels/udp_tunnel.h | 59 |
3 files changed, 74 insertions, 7 deletions
diff --git a/hicn-plugin/src/udp_tunnels/udp_decap.h b/hicn-plugin/src/udp_tunnels/udp_decap.h index adbec3f03..9ddb8a73b 100644 --- a/hicn-plugin/src/udp_tunnels/udp_decap.h +++ b/hicn-plugin/src/udp_tunnels/udp_decap.h @@ -13,4 +13,20 @@ * limitations under the License. */ +#ifndef __UDP_DECAP_H__ +#define __UDP_DECAP_H__ + +/** + * @file udp_decap.h + * + * Implements the udp decapsulation for udp tunnels + * + * Udp decap nodes follow the ip4/6-local nodes and their purpose + * is to retrieve the udp tunnel for the incoming packet. If a tunnel does + * not exist the packet is dropped. + * The following node to the udp decap nodes are the ip4/6-lookup nodes. + */ + extern vlib_node_registration_t udp_decap_node; + +#endif // __UDP_DECAP_H__ diff --git a/hicn-plugin/src/udp_tunnels/udp_decap_node.c b/hicn-plugin/src/udp_tunnels/udp_decap_node.c index 6a5831c2b..5603f20f9 100644 --- a/hicn-plugin/src/udp_tunnels/udp_decap_node.c +++ b/hicn-plugin/src/udp_tunnels/udp_decap_node.c @@ -19,12 +19,6 @@ #include "../hicn.h" #include "../strategy_dpo_ctx.h" -/** - * @File - * - * Definition of the nodes for ip incomplete faces. - */ - vlib_node_registration_t udp_decap_node; static char *udp_decap_error_strings[] = { diff --git a/hicn-plugin/src/udp_tunnels/udp_tunnel.h b/hicn-plugin/src/udp_tunnels/udp_tunnel.h index 8f38a47e4..2ec92056c 100644 --- a/hicn-plugin/src/udp_tunnels/udp_tunnel.h +++ b/hicn-plugin/src/udp_tunnels/udp_tunnel.h @@ -20,6 +20,17 @@ #include <vppinfra/error.h> #include <vnet/udp/udp_encap.h> +/** + * @file udp_tunnel.h + * + * This file implements bidirectional udp tunnels. Udp tunnels exploit + * the udp encap functionality in vpp. In particular, a udp tunnel creates + * an udp encap object with the information for encapsulating packets and it + * implements the udp decap node. The udp decap node checks if a udp tunnel exists + * before performing the decapsulation. If the tunnel does not exist the packet + * is dropped. + */ + #define UDP_TUNNEL_INVALID ~0 extern dpo_type_t dpo_type_udp_ip4; @@ -28,7 +39,19 @@ extern dpo_type_t dpo_type_udp_ip6; extern vlib_node_registration_t udp4_decap_node; extern vlib_node_registration_t udp6_decap_node; - +/** + * @brief Create a udp tunnel + * + * @param proto FIB_PROTOCOL_IP4 or FIB_PROTOCOL_IP6 + * @param fib_index fib index to add to the udp encap + * @param src_ip source address of the tunnel + * @param dst_ip destination address of the tunnel + * @param src_port source port + * @param src_port destination port + * @param flags flags for the udp encap + * + * @return return the id of the tunnel + */ u32 udp_tunnel_add (fib_protocol_t proto, index_t fib_index, const ip46_address_t * src_ip, @@ -37,11 +60,35 @@ u32 udp_tunnel_add (fib_protocol_t proto, u16 dst_port, udp_encap_fixup_flags_t flags); +/** + * @brief Retrieve the index of a udp tunnel (same id of the udp encap) + * + * @param src_ip source address of the tunnel + * @param dst_ip destination address of the tunnel + * @param src_port source port + * @param src_port destination port + * + * @return id of the udp tunnel/encap + */ u32 udp_tunnel_get(const ip46_address_t * src_ip, const ip46_address_t * dst_ip, u16 src_port, u16 dst_port); +/** + * @brief Delete a udp tunnel + * + * @param proto FIB_PROTOCOL_IP4 or FIB_PROTOCOL_IP6 + * @param fib_index fib index to add to the udp encap + * @param src_ip source address of the tunnel + * @param dst_ip destination address of the tunnel + * @param src_port source port + * @param src_port destination port + * @param flags flags for the udp encap + * + * @return HICN_ERROR_UDP_TUNNEL_NOT_FOUND if the tunnel was not found + * or HICN_ERROR_NONE if the tunnel has been deleted + */ int udp_tunnel_del (fib_protocol_t proto, index_t fib_index, const ip46_address_t * src_ip, @@ -50,8 +97,18 @@ int udp_tunnel_del (fib_protocol_t proto, u16 dst_port, udp_encap_fixup_flags_t flags); +/** + * @brief Add a udp tunnel from an existing udp encap + * + * @param uei index of the udp encap object + * @param proto DPO_PROTO_IP6 or DPO_PROTO_IP4 + */ void udp_tunnel_add_existing (index_t uei, dpo_proto_t proto); +/** + * @brief Init the udp tunnel module + * + */ void udp_tunnel_init(); #endif |