*/
/**
* @file
- * @brief BFD global declarations
+ * @brief BFD UDP transport layer declarations
*/
#ifndef __included_bfd_udp_h__
#include <vnet/ip/ip6_packet.h>
#include <vnet/bfd/bfd_api.h>
-/* *INDENT-OFF* */
+/** identifier of BFD session based on UDP transport only */
typedef CLIB_PACKED (struct {
-
- u32 sw_if_index;
+ union {
+ /** interface to which the session is tied - single-hop */
+ u32 sw_if_index;
+ /** the FIB index the peer is in - multi-hop*/
+ u32 fib_index;
+ };
+ /** local address */
ip46_address_t local_addr;
+ /** peer address */
ip46_address_t peer_addr;
-
}) bfd_udp_key_t;
-/* *INDENT-ON* */
+/** UDP transport specific data embedded in bfd_session's union */
typedef struct
{
+ /** key identifying this session */
bfd_udp_key_t key;
-
+ /** adjacency index returned from adj lock call */
adj_index_t adj_index;
} bfd_udp_session_t;
-/* bfd udp echo packet trace capture */
+/** bfd udp echo packet trace capture */
typedef struct
{
u32 len;
struct bfd_session_s;
-int bfd_add_udp4_transport (vlib_main_t * vm, vlib_buffer_t * b,
+/**
+ * @brief add the necessary transport layer by prepending it to existing data
+ *
+ *
+ * @param is_echo 1 if this is echo packet, 0 if control frame
+ *
+ * @return 1 on success, 0 on failure
+ */
+int bfd_add_udp4_transport (vlib_main_t * vm, u32 bi,
const struct bfd_session_s *bs, int is_echo);
-int bfd_add_udp6_transport (vlib_main_t * vm, vlib_buffer_t * b,
+
+/**
+ * @brief add the necessary transport layer by prepending it to existing data
+ *
+ * @param is_echo 1 if this is echo packet, 0 if control frame
+ *
+ * @return 1 on success, 0 on failure
+ */
+int bfd_add_udp6_transport (vlib_main_t * vm, u32 bi,
const struct bfd_session_s *bs, int is_echo);
+/**
+ * @brief transport packet over udpv4
+ *
+ * @return 1 on success, 0 on failure
+ */
+int bfd_transport_udp4 (vlib_main_t *vm, u32 bi,
+ const struct bfd_session_s *bs, int is_echo);
+
+/**
+ * @brief transport packet over udpv6
+ *
+ * @return 1 on success, 0 on failure
+ */
+int bfd_transport_udp6 (vlib_main_t *vm, u32 bi,
+ const struct bfd_session_s *bs, int is_echo);
+
/**
* @brief check if the bfd udp layer is echo-capable at this time
*
*/
int bfd_udp_is_echo_available (bfd_transport_e transport);
-void
-bfd_udp_get_echo_source (int *is_set, u32 * sw_if_index, int *have_usable_ip4,
- ip4_address_t * ip4, int *have_usable_ip6,
- ip6_address_t * ip6);
+/**
+ * @brief get echo source information - used by CLI
+ */
+void bfd_udp_get_echo_source (int *is_set, u32 * sw_if_index,
+ int *have_usable_ip4, ip4_address_t * ip4,
+ int *have_usable_ip6, ip6_address_t * ip6);
#endif /* __included_bfd_udp_h__ */