src/vnet/bfd/bfd_udp.h

   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:
   5  *
   6  *     http://www.apache.org/licenses/LICENSE-2.0
   7  *
   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.
  13  */
  14 /**
  15  * @file
  16  * @brief BFD UDP transport layer declarations
  17  */
  18
  19 #ifndef __included_bfd_udp_h__
  20 #define __included_bfd_udp_h__
  21
  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>
  26
  27 /* *INDENT-OFF* */
  28 /** identifier of BFD session based on UDP transport only */
  29 typedef CLIB_PACKED (struct {
  30   /** interface to which the session is tied */
  31   u32 sw_if_index;
  32   /** local address */
  33   ip46_address_t local_addr;
  34   /** peer address */
  35   ip46_address_t peer_addr;
  36 }) bfd_udp_key_t;
  37 /* *INDENT-ON* */
  38
  39 /** UDP transport specific data embedded in bfd_session's union */
  40 typedef struct
  41 {
  42   /** key identifying this session */
  43   bfd_udp_key_t key;
  44   /** adjacency index returned from adj lock call */
  45   adj_index_t adj_index;
  46 } bfd_udp_session_t;
  47
  48 /** bfd udp echo packet trace capture */
  49 typedef struct
  50 {
  51   u32 len;
  52   u8 data[400];
  53 } bfd_udp_echo_input_trace_t;
  54
  55 struct bfd_session_s;
  56
  57 /**
  58  * @brief add the necessary transport layer by prepending it to existing data
  59  *
  60  *
  61  * @param is_echo 1 if this is echo packet, 0 if control frame
  62  *
  63  * @return 1 on success, 0 on failure
  64  */
  65 int bfd_add_udp4_transport (vlib_main_t * vm, u32 bi,
  66                             const struct bfd_session_s *bs, int is_echo);
  67
  68 /**
  69  * @brief add the necessary transport layer by prepending it to existing data
  70  *
  71  * @param is_echo 1 if this is echo packet, 0 if control frame
  72  *
  73  * @return 1 on success, 0 on failure
  74  */
  75 int bfd_add_udp6_transport (vlib_main_t * vm, u32 bi,
  76                             const struct bfd_session_s *bs, int is_echo);
  77
  78 /**
  79  * @brief transport packet over udpv4
  80  *
  81  * @param is_echo 1 if this is echo packet, 0 if control frame
  82  *
  83  * @return 1 on success, 0 on failure
  84  */
  85 int bfd_transport_udp4 (vlib_main_t * vm, u32 bi,
  86                         const struct bfd_session_s *bs);
  87
  88 /**
  89  * @brief transport packet over udpv6
  90  *
  91  * @param is_echo 1 if this is echo packet, 0 if control frame
  92  *
  93  * @return 1 on success, 0 on failure
  94  */
  95 int bfd_transport_udp6 (vlib_main_t * vm, u32 bi,
  96                         const struct bfd_session_s *bs);
  97
  98 /**
  99  * @brief check if the bfd udp layer is echo-capable at this time
 100  *
 101  * @return 1 if available, 0 otherwise
 102  */
 103 int bfd_udp_is_echo_available (bfd_transport_e transport);
 104
 105 /**
 106  * @brief get echo source information - used by CLI
 107  */
 108 void bfd_udp_get_echo_source (int *is_set, u32 * sw_if_index,
 109                               int *have_usable_ip4, ip4_address_t * ip4,
 110                               int *have_usable_ip6, ip6_address_t * ip6);
 111
 112 #endif /* __included_bfd_udp_h__ */
 113
 114 /*
 115  * fd.io coding-style-patch-verification: ON
 116  *
 117  * Local Variables:
 118  * eval: (c-set-style "gnu")
 119  * End:
 120  */