src/vnet/bfd/bfd_api.c

   1 /*
   2  *------------------------------------------------------------------
   3  * bfd_api.c - bfd api
   4  *
   5  * Copyright (c) 2016 Cisco and/or its affiliates.
   6  * Licensed under the Apache License, Version 2.0 (the "License");
   7  * you may not use this file except in compliance with the License.
   8  * You may obtain a copy of the License at:
   9  *
  10  *     http://www.apache.org/licenses/LICENSE-2.0
  11  *
  12  * Unless required by applicable law or agreed to in writing, software
  13  * distributed under the License is distributed on an "AS IS" BASIS,
  14  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15  * See the License for the specific language governing permissions and
  16  * limitations under the License.
  17  *------------------------------------------------------------------
  18  */
  19 /**
  20  * @file
  21  * @brief BFD binary API implementation
  22  */
  23
  24 #include <vnet/vnet.h>
  25 #include <vlibmemory/api.h>
  26
  27 #include <vnet/interface.h>
  28 #include <vnet/api_errno.h>
  29 #include <vnet/bfd/bfd_main.h>
  30 #include <vnet/bfd/bfd_api.h>
  31
  32 #include <vnet/vnet_msg_enum.h>
  33
  34 #define vl_typedefs             /* define message structures */
  35 #include <vnet/vnet_all_api_h.h>
  36 #undef vl_typedefs
  37
  38 #define vl_endianfun            /* define message structures */
  39 #include <vnet/vnet_all_api_h.h>
  40 #undef vl_endianfun
  41
  42 /* instantiate all the print functions we know about */
  43 #define vl_print(handle, ...) vlib_cli_output (handle, __VA_ARGS__)
  44 #define vl_printfun
  45 #include <vnet/vnet_all_api_h.h>
  46 #undef vl_printfun
  47
  48 #include <vlibapi/api_helper_macros.h>
  49
  50 #define foreach_vpe_api_msg                                \
  51   _ (BFD_UDP_ADD, bfd_udp_add)                             \
  52   _ (BFD_UDP_MOD, bfd_udp_mod)                             \
  53   _ (BFD_UDP_DEL, bfd_udp_del)                             \
  54   _ (BFD_UDP_SESSION_DUMP, bfd_udp_session_dump)           \
  55   _ (BFD_UDP_SESSION_SET_FLAGS, bfd_udp_session_set_flags) \
  56   _ (WANT_BFD_EVENTS, want_bfd_events)                     \
  57   _ (BFD_AUTH_SET_KEY, bfd_auth_set_key)                   \
  58   _ (BFD_AUTH_DEL_KEY, bfd_auth_del_key)                   \
  59   _ (BFD_AUTH_KEYS_DUMP, bfd_auth_keys_dump)               \
  60   _ (BFD_UDP_AUTH_ACTIVATE, bfd_udp_auth_activate)         \
  61   _ (BFD_UDP_AUTH_DEACTIVATE, bfd_udp_auth_deactivate)     \
  62   _ (BFD_UDP_SET_ECHO_SOURCE, bfd_udp_set_echo_source)     \
  63   _ (BFD_UDP_DEL_ECHO_SOURCE, bfd_udp_del_echo_source)
  64
  65 pub_sub_handler (bfd_events, BFD_EVENTS);
  66
  67 #define BFD_UDP_API_PARAM_COMMON_CODE                                         \
  68   ip46_address_t local_addr;                                                  \
  69   memset (&local_addr, 0, sizeof (local_addr));                               \
  70   ip46_address_t peer_addr;                                                   \
  71   memset (&peer_addr, 0, sizeof (peer_addr));                                 \
  72   if (mp->is_ipv6)                                                            \
  73     {                                                                         \
  74       clib_memcpy (&local_addr.ip6, mp->local_addr, sizeof (local_addr.ip6)); \
  75       clib_memcpy (&peer_addr.ip6, mp->peer_addr, sizeof (peer_addr.ip6));    \
  76     }                                                                         \
  77   else                                                                        \
  78     {                                                                         \
  79       clib_memcpy (&local_addr.ip4, mp->local_addr, sizeof (local_addr.ip4)); \
  80       clib_memcpy (&peer_addr.ip4, mp->peer_addr, sizeof (peer_addr.ip4));    \
  81     }
  82
  83 #define BFD_UDP_API_PARAM_FROM_MP(mp) \
  84   clib_net_to_host_u32 (mp->sw_if_index), &local_addr, &peer_addr
  85
  86 static void
  87 vl_api_bfd_udp_add_t_handler (vl_api_bfd_udp_add_t * mp)
  88 {
  89   vl_api_bfd_udp_add_reply_t *rmp;
  90   int rv;
  91
  92   VALIDATE_SW_IF_INDEX (mp);
  93
  94   BFD_UDP_API_PARAM_COMMON_CODE;
  95
  96   rv = bfd_udp_add_session (BFD_UDP_API_PARAM_FROM_MP (mp),
  97                             clib_net_to_host_u32 (mp->desired_min_tx),
  98                             clib_net_to_host_u32 (mp->required_min_rx),
  99                             mp->detect_mult, mp->is_authenticated,
 100                             clib_net_to_host_u32 (mp->conf_key_id),
 101                             mp->bfd_key_id);
 102
 103   BAD_SW_IF_INDEX_LABEL;
 104   REPLY_MACRO (VL_API_BFD_UDP_ADD_REPLY);
 105 }
 106
 107 static void
 108 vl_api_bfd_udp_mod_t_handler (vl_api_bfd_udp_mod_t * mp)
 109 {
 110   vl_api_bfd_udp_mod_reply_t *rmp;
 111   int rv;
 112
 113   VALIDATE_SW_IF_INDEX (mp);
 114
 115   BFD_UDP_API_PARAM_COMMON_CODE;
 116
 117   rv = bfd_udp_mod_session (BFD_UDP_API_PARAM_FROM_MP (mp),
 118                             clib_net_to_host_u32 (mp->desired_min_tx),
 119                             clib_net_to_host_u32 (mp->required_min_rx),
 120                             mp->detect_mult);
 121
 122   BAD_SW_IF_INDEX_LABEL;
 123   REPLY_MACRO (VL_API_BFD_UDP_MOD_REPLY);
 124 }
 125
 126 static void
 127 vl_api_bfd_udp_del_t_handler (vl_api_bfd_udp_del_t * mp)
 128 {
 129   vl_api_bfd_udp_del_reply_t *rmp;
 130   int rv;
 131
 132   VALIDATE_SW_IF_INDEX (mp);
 133
 134   BFD_UDP_API_PARAM_COMMON_CODE;
 135
 136   rv = bfd_udp_del_session (BFD_UDP_API_PARAM_FROM_MP (mp));
 137
 138   BAD_SW_IF_INDEX_LABEL;
 139   REPLY_MACRO (VL_API_BFD_UDP_DEL_REPLY);
 140 }
 141
 142 void
 143 send_bfd_udp_session_details (svm_queue_t * q, u32 context,
 144                               bfd_session_t * bs)
 145 {
 146   if (bs->transport != BFD_TRANSPORT_UDP4 &&
 147       bs->transport != BFD_TRANSPORT_UDP6)
 148     {
 149       return;
 150     }
 151
 152   vl_api_bfd_udp_session_details_t *mp = vl_msg_api_alloc (sizeof (*mp));
 153   memset (mp, 0, sizeof (*mp));
 154   mp->_vl_msg_id = ntohs (VL_API_BFD_UDP_SESSION_DETAILS);
 155   mp->context = context;
 156   mp->state = bs->local_state;
 157   bfd_udp_session_t *bus = &bs->udp;
 158   bfd_udp_key_t *key = &bus->key;
 159   mp->sw_if_index = clib_host_to_net_u32 (key->sw_if_index);
 160   mp->is_ipv6 = !(ip46_address_is_ip4 (&key->local_addr));
 161   if ((!bs->auth.is_delayed && bs->auth.curr_key) ||
 162       (bs->auth.is_delayed && bs->auth.next_key))
 163     {
 164       mp->is_authenticated = 1;
 165     }
 166   if (bs->auth.is_delayed && bs->auth.next_key)
 167     {
 168       mp->bfd_key_id = bs->auth.next_bfd_key_id;
 169       mp->conf_key_id = clib_host_to_net_u32 (bs->auth.next_key->conf_key_id);
 170     }
 171   else if (!bs->auth.is_delayed && bs->auth.curr_key)
 172     {
 173       mp->bfd_key_id = bs->auth.curr_bfd_key_id;
 174       mp->conf_key_id = clib_host_to_net_u32 (bs->auth.curr_key->conf_key_id);
 175     }
 176   if (mp->is_ipv6)
 177     {
 178       clib_memcpy (mp->local_addr, &key->local_addr,
 179                    sizeof (key->local_addr));
 180       clib_memcpy (mp->peer_addr, &key->peer_addr, sizeof (key->peer_addr));
 181     }
 182   else
 183     {
 184       clib_memcpy (mp->local_addr, key->local_addr.ip4.data,
 185                    sizeof (key->local_addr.ip4.data));
 186       clib_memcpy (mp->peer_addr, key->peer_addr.ip4.data,
 187                    sizeof (key->peer_addr.ip4.data));
 188     }
 189
 190   mp->required_min_rx =
 191     clib_host_to_net_u32 (bs->config_required_min_rx_usec);
 192   mp->desired_min_tx = clib_host_to_net_u32 (bs->config_desired_min_tx_usec);
 193   mp->detect_mult = bs->local_detect_mult;
 194   vl_msg_api_send_shmem (q, (u8 *) & mp);
 195 }
 196
 197 void
 198 bfd_event (bfd_main_t * bm, bfd_session_t * bs)
 199 {
 200   vpe_api_main_t *vam = &vpe_api_main;
 201   vpe_client_registration_t *reg;
 202   svm_queue_t *q;
 203   /* *INDENT-OFF* */
 204   pool_foreach (reg, vam->bfd_events_registrations, ({
 205                   q = vl_api_client_index_to_input_queue (reg->client_index);
 206                   if (q)
 207                     {
 208                       switch (bs->transport)
 209                         {
 210                         case BFD_TRANSPORT_UDP4:
 211                         /* fallthrough */
 212                         case BFD_TRANSPORT_UDP6:
 213                           send_bfd_udp_session_details (q, 0, bs);
 214                         }
 215                     }
 216                 }));
 217   /* *INDENT-ON* */
 218 }
 219
 220 static void
 221 vl_api_bfd_udp_session_dump_t_handler (vl_api_bfd_udp_session_dump_t * mp)
 222 {
 223   svm_queue_t *q;
 224
 225   q = vl_api_client_index_to_input_queue (mp->client_index);
 226
 227   if (q == 0)
 228     return;
 229
 230   bfd_session_t *bs = NULL;
 231   /* *INDENT-OFF* */
 232   pool_foreach (bs, bfd_main.sessions, ({
 233                   if (bs->transport == BFD_TRANSPORT_UDP4 ||
 234                       bs->transport == BFD_TRANSPORT_UDP6)
 235                     send_bfd_udp_session_details (q, mp->context, bs);
 236                 }));
 237   /* *INDENT-ON* */
 238 }
 239
 240 static void
 241 vl_api_bfd_udp_session_set_flags_t_handler (vl_api_bfd_udp_session_set_flags_t
 242                                             * mp)
 243 {
 244   vl_api_bfd_udp_session_set_flags_reply_t *rmp;
 245   int rv;
 246
 247   BFD_UDP_API_PARAM_COMMON_CODE;
 248
 249   rv = bfd_udp_session_set_flags (BFD_UDP_API_PARAM_FROM_MP (mp),
 250                                   mp->admin_up_down);
 251
 252   REPLY_MACRO (VL_API_BFD_UDP_SESSION_SET_FLAGS_REPLY);
 253 }
 254
 255 static void
 256 vl_api_bfd_auth_set_key_t_handler (vl_api_bfd_auth_set_key_t * mp)
 257 {
 258   vl_api_bfd_auth_set_key_reply_t *rmp;
 259   int rv = bfd_auth_set_key (clib_net_to_host_u32 (mp->conf_key_id),
 260                              mp->auth_type, mp->key_len, mp->key);
 261
 262   REPLY_MACRO (VL_API_BFD_AUTH_SET_KEY_REPLY);
 263 }
 264
 265 static void
 266 vl_api_bfd_auth_del_key_t_handler (vl_api_bfd_auth_del_key_t * mp)
 267 {
 268   vl_api_bfd_auth_del_key_reply_t *rmp;
 269   int rv = bfd_auth_del_key (clib_net_to_host_u32 (mp->conf_key_id));
 270
 271   REPLY_MACRO (VL_API_BFD_AUTH_DEL_KEY_REPLY);
 272 }
 273
 274 static void
 275 vl_api_bfd_auth_keys_dump_t_handler (vl_api_bfd_auth_keys_dump_t * mp)
 276 {
 277   svm_queue_t *q;
 278
 279   q = vl_api_client_index_to_input_queue (mp->client_index);
 280
 281   if (q == 0)
 282     return;
 283
 284   bfd_auth_key_t *key = NULL;
 285   vl_api_bfd_auth_keys_details_t *rmp = NULL;
 286
 287   /* *INDENT-OFF* */
 288   pool_foreach (key, bfd_main.auth_keys, ({
 289                   rmp = vl_msg_api_alloc (sizeof (*rmp));
 290                   memset (rmp, 0, sizeof (*rmp));
 291                   rmp->_vl_msg_id = ntohs (VL_API_BFD_AUTH_KEYS_DETAILS);
 292                   rmp->context = mp->context;
 293                   rmp->conf_key_id = clib_host_to_net_u32 (key->conf_key_id);
 294                   rmp->auth_type = key->auth_type;
 295                   rmp->use_count = clib_host_to_net_u32 (key->use_count);
 296                   vl_msg_api_send_shmem (q, (u8 *)&rmp);
 297                 }));
 298   /* *INDENT-ON* */
 299 }
 300
 301 static void
 302 vl_api_bfd_udp_auth_activate_t_handler (vl_api_bfd_udp_auth_activate_t * mp)
 303 {
 304   vl_api_bfd_udp_auth_activate_reply_t *rmp;
 305   int rv;
 306
 307   VALIDATE_SW_IF_INDEX (mp);
 308
 309   BFD_UDP_API_PARAM_COMMON_CODE;
 310
 311   rv = bfd_udp_auth_activate (BFD_UDP_API_PARAM_FROM_MP (mp),
 312                               clib_net_to_host_u32 (mp->conf_key_id),
 313                               mp->bfd_key_id, mp->is_delayed);
 314
 315   BAD_SW_IF_INDEX_LABEL;
 316   REPLY_MACRO (VL_API_BFD_UDP_AUTH_ACTIVATE_REPLY);
 317 }
 318
 319 static void
 320 vl_api_bfd_udp_auth_deactivate_t_handler (vl_api_bfd_udp_auth_deactivate_t *
 321                                           mp)
 322 {
 323   vl_api_bfd_udp_auth_deactivate_reply_t *rmp;
 324   int rv;
 325
 326   VALIDATE_SW_IF_INDEX (mp);
 327
 328   BFD_UDP_API_PARAM_COMMON_CODE;
 329
 330   rv =
 331     bfd_udp_auth_deactivate (BFD_UDP_API_PARAM_FROM_MP (mp), mp->is_delayed);
 332
 333   BAD_SW_IF_INDEX_LABEL;
 334   REPLY_MACRO (VL_API_BFD_UDP_AUTH_DEACTIVATE_REPLY);
 335 }
 336
 337 static void
 338 vl_api_bfd_udp_set_echo_source_t_handler (vl_api_bfd_udp_set_echo_source_t *
 339                                           mp)
 340 {
 341   vl_api_bfd_udp_set_echo_source_reply_t *rmp;
 342   int rv;
 343
 344   VALIDATE_SW_IF_INDEX (mp);
 345
 346   rv = bfd_udp_set_echo_source (clib_net_to_host_u32 (mp->sw_if_index));
 347
 348   BAD_SW_IF_INDEX_LABEL;
 349   REPLY_MACRO (VL_API_BFD_UDP_SET_ECHO_SOURCE_REPLY);
 350 }
 351
 352 static void
 353 vl_api_bfd_udp_del_echo_source_t_handler (vl_api_bfd_udp_del_echo_source_t *
 354                                           mp)
 355 {
 356   vl_api_bfd_udp_del_echo_source_reply_t *rmp;
 357   int rv;
 358
 359   rv = bfd_udp_del_echo_source ();
 360
 361   REPLY_MACRO (VL_API_BFD_UDP_DEL_ECHO_SOURCE_REPLY);
 362 }
 363
 364 /*
 365  * bfd_api_hookup
 366  * Add vpe's API message handlers to the table.
 367  * vlib has alread mapped shared memory and
 368  * added the client registration handlers.
 369  * See .../vlib-api/vlibmemory/memclnt_vlib.c:memclnt_process()
 370  */
 371 #define vl_msg_name_crc_list
 372 #include <vnet/vnet_all_api_h.h>
 373 #undef vl_msg_name_crc_list
 374
 375 static void
 376 setup_message_id_table (api_main_t * am)
 377 {
 378 #define _(id, n, crc) vl_msg_api_add_msg_name_crc (am, #n "_" #crc, id);
 379   foreach_vl_msg_name_crc_bfd;
 380 #undef _
 381 }
 382
 383 static clib_error_t *
 384 bfd_api_hookup (vlib_main_t * vm)
 385 {
 386   api_main_t *am = &api_main;
 387
 388 #define _(N, n)                                                    \
 389   vl_msg_api_set_handlers (VL_API_##N, #n, vl_api_##n##_t_handler, \
 390                            vl_noop_handler, vl_api_##n##_t_endian, \
 391                            vl_api_##n##_t_print, sizeof (vl_api_##n##_t), 1);
 392   foreach_vpe_api_msg;
 393 #undef _
 394
 395   /*
 396    * Set up the (msg_name, crc, message-id) table
 397    */
 398   setup_message_id_table (am);
 399
 400   return 0;
 401 }
 402
 403 VLIB_API_INIT_FUNCTION (bfd_api_hookup);
 404
 405 /*
 406  * fd.io coding-style-patch-verification: ON
 407  *
 408  * Local Variables:
 409  * eval: (c-set-style "gnu")
 410  * End:
 411  */