1 /* * Copyright (c) 2011-2016 Cisco and/or its affiliates.
2 * Licensed under the Apache License, Version 2.0 (the "License");
3 * you may not use this file except in compliance with the License.
4 * You may obtain a copy of the License at:
6 * http://www.apache.org/licenses/LICENSE-2.0
8 * Unless required by applicable law or agreed to in writing, software
9 * distributed under the License is distributed on an "AS IS" BASIS,
10 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
11 * See the License for the specific language governing permissions and
12 * limitations under the License.
16 * @brief BFD UDP transport layer declarations
19 #ifndef __included_bfd_udp_h__
20 #define __included_bfd_udp_h__
22 #include <vppinfra/clib.h>
23 #include <vnet/adj/adj_types.h>
24 #include <vnet/ip/ip6_packet.h>
25 #include <vnet/bfd/bfd_api.h>
28 /** identifier of BFD session based on UDP transport only */
29 typedef CLIB_PACKED (struct {
31 /** interface to which the session is tied - single-hop */
33 /** the FIB index the peer is in - multi-hop*/
37 ip46_address_t local_addr;
39 ip46_address_t peer_addr;
43 /** UDP transport specific data embedded in bfd_session's union */
46 /** key identifying this session */
48 /** adjacency index returned from adj lock call */
49 adj_index_t adj_index;
52 /** bfd udp echo packet trace capture */
57 } bfd_udp_echo_input_trace_t;
62 * @brief add the necessary transport layer by prepending it to existing data
65 * @param is_echo 1 if this is echo packet, 0 if control frame
67 * @return 1 on success, 0 on failure
69 int bfd_add_udp4_transport (vlib_main_t * vm, u32 bi,
70 const struct bfd_session_s *bs, int is_echo);
73 * @brief add the necessary transport layer by prepending it to existing data
75 * @param is_echo 1 if this is echo packet, 0 if control frame
77 * @return 1 on success, 0 on failure
79 int bfd_add_udp6_transport (vlib_main_t * vm, u32 bi,
80 const struct bfd_session_s *bs, int is_echo);
83 * @brief transport packet over udpv4
85 * @param is_echo 1 if this is echo packet, 0 if control frame
87 * @return 1 on success, 0 on failure
89 int bfd_transport_udp4 (vlib_main_t * vm, u32 bi,
90 const struct bfd_session_s *bs);
93 * @brief transport packet over udpv6
95 * @param is_echo 1 if this is echo packet, 0 if control frame
97 * @return 1 on success, 0 on failure
99 int bfd_transport_udp6 (vlib_main_t * vm, u32 bi,
100 const struct bfd_session_s *bs);
103 * @brief check if the bfd udp layer is echo-capable at this time
105 * @return 1 if available, 0 otherwise
107 int bfd_udp_is_echo_available (bfd_transport_e transport);
110 * @brief get echo source information - used by CLI
112 void bfd_udp_get_echo_source (int *is_set, u32 * sw_if_index,
113 int *have_usable_ip4, ip4_address_t * ip4,
114 int *have_usable_ip6, ip6_address_t * ip6);
116 #endif /* __included_bfd_udp_h__ */
119 * fd.io coding-style-patch-verification: ON
122 * eval: (c-set-style "gnu")