ospfd/ospf_bfd.c

   1 /**
   2  * ospf_bfd.c: OSPF BFD handling routines
   3  *
   4  * @copyright Copyright (C) 2015 Cumulus Networks, Inc.
   5  *
   6  * This file is part of GNU Zebra.
   7  *
   8  * GNU Zebra is free software; you can redistribute it and/or modify it
   9  * under the terms of the GNU General Public License as published by the
  10  * Free Software Foundation; either version 2, or (at your option) any
  11  * later version.
  12  *
  13  * GNU Zebra is distributed in the hope that it will be useful, but
  14  * WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16  * General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License along
  19  * with this program; see the file COPYING; if not, write to the Free Software
  20  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  21  */
  22
  23 #include <zebra.h>
  24
  25 #include "command.h"
  26 #include "linklist.h"
  27 #include "memory.h"
  28 #include "prefix.h"
  29 #include "thread.h"
  30 #include "buffer.h"
  31 #include "stream.h"
  32 #include "zclient.h"
  33 #include "vty.h"
  34 #include "table.h"
  35 #include "bfd.h"
  36 #include "ospfd.h"
  37 #include "ospf_asbr.h"
  38 #include "ospf_lsa.h"
  39 #include "ospf_lsdb.h"
  40 #include "ospf_neighbor.h"
  41 #include "ospf_interface.h"
  42 #include "ospf_nsm.h"
  43 #include "ospf_bfd.h"
  44 #include "ospf_dump.h"
  45 #include "ospf_vty.h"
  46
  47 extern struct zclient *zclient;
  48
  49 /*
  50  * ospf_bfd_info_free - Free BFD info structure
  51  */
  52 void ospf_bfd_info_free(void **bfd_info)
  53 {
  54         bfd_info_free((struct bfd_info **)bfd_info);
  55 }
  56
  57 /*
  58  * ospf_bfd_reg_dereg_nbr - Register/Deregister a neighbor with BFD through
  59  *                          zebra for starting/stopping the monitoring of
  60  *                          the neighbor rechahability.
  61  */
  62 static void ospf_bfd_reg_dereg_nbr(struct ospf_neighbor *nbr, int command)
  63 {
  64         struct ospf_interface *oi = nbr->oi;
  65         struct interface *ifp = oi->ifp;
  66         struct ospf_if_params *params;
  67         struct bfd_info *bfd_info;
  68         int cbit;
  69
  70         /* Check if BFD is enabled */
  71         params = IF_DEF_PARAMS(ifp);
  72
  73         /* Check if BFD is enabled */
  74         if (!params->bfd_info)
  75                 return;
  76         bfd_info = (struct bfd_info *)params->bfd_info;
  77
  78         if (IS_DEBUG_OSPF(zebra, ZEBRA_INTERFACE))
  79                 zlog_debug("%s nbr (%s) with BFD. OSPF vrf %s",
  80                            bfd_get_command_dbg_str(command),
  81                            inet_ntoa(nbr->src),
  82                            ospf_vrf_id_to_name(oi->ospf->vrf_id));
  83
  84         cbit = CHECK_FLAG(bfd_info->flags, BFD_FLAG_BFD_CBIT_ON);
  85
  86         bfd_peer_sendmsg(zclient, bfd_info, AF_INET, &nbr->src, NULL, ifp->name,
  87                          0, 0, cbit, command, 0, oi->ospf->vrf_id);
  88 }
  89
  90 /*
  91  * ospf_bfd_trigger_event - Neighbor is registered/deregistered with BFD when
  92  *                          neighbor state is changed to/from 2way.
  93  */
  94 void ospf_bfd_trigger_event(struct ospf_neighbor *nbr, int old_state, int state)
  95 {
  96         if ((old_state < NSM_TwoWay) && (state >= NSM_TwoWay))
  97                 ospf_bfd_reg_dereg_nbr(nbr, ZEBRA_BFD_DEST_REGISTER);
  98         else if ((old_state >= NSM_TwoWay) && (state < NSM_TwoWay))
  99                 ospf_bfd_reg_dereg_nbr(nbr, ZEBRA_BFD_DEST_DEREGISTER);
 100 }
 101
 102 /*
 103  * ospf_bfd_reg_dereg_all_nbr - Register/Deregister all neighbors associated
 104  *                              with a interface with BFD through
 105  *                              zebra for starting/stopping the monitoring of
 106  *                              the neighbor rechahability.
 107  */
 108 static int ospf_bfd_reg_dereg_all_nbr(struct interface *ifp, int command)
 109 {
 110         struct ospf_interface *oi;
 111         struct route_table *nbrs;
 112         struct ospf_neighbor *nbr;
 113         struct route_node *irn;
 114         struct route_node *nrn;
 115
 116         for (irn = route_top(IF_OIFS(ifp)); irn; irn = route_next(irn)) {
 117                 if ((oi = irn->info) == NULL)
 118                         continue;
 119
 120                 if ((nbrs = oi->nbrs) == NULL)
 121                         continue;
 122
 123                 for (nrn = route_top(nbrs); nrn; nrn = route_next(nrn)) {
 124                         if ((nbr = nrn->info) == NULL || nbr == oi->nbr_self)
 125                                 continue;
 126
 127                         if (command != ZEBRA_BFD_DEST_DEREGISTER)
 128                                 ospf_bfd_info_nbr_create(oi, nbr);
 129                         else
 130                                 bfd_info_free(
 131                                         (struct bfd_info **)&nbr->bfd_info);
 132
 133                         if (nbr->state < NSM_TwoWay)
 134                                 continue;
 135
 136                         ospf_bfd_reg_dereg_nbr(nbr, command);
 137                 }
 138         }
 139
 140         return 0;
 141 }
 142
 143 /*
 144  * ospf_bfd_nbr_replay - Replay all the neighbors that have BFD enabled
 145  *                       to zebra
 146  */
 147 static int ospf_bfd_nbr_replay(ZAPI_CALLBACK_ARGS)
 148 {
 149         struct listnode *inode, *node, *onode;
 150         struct ospf *ospf;
 151         struct ospf_interface *oi;
 152         struct route_table *nbrs;
 153         struct route_node *rn;
 154         struct ospf_neighbor *nbr;
 155         struct ospf_if_params *params;
 156
 157         if (IS_DEBUG_OSPF(zebra, ZEBRA_INTERFACE)) {
 158                 zlog_debug("Zebra: BFD Dest replay request");
 159         }
 160
 161         /* Send the client registration */
 162         bfd_client_sendmsg(zclient, ZEBRA_BFD_CLIENT_REGISTER, vrf_id);
 163
 164         /* Replay the neighbor, if BFD is enabled in OSPF */
 165         for (ALL_LIST_ELEMENTS(om->ospf, node, onode, ospf)) {
 166                 for (ALL_LIST_ELEMENTS_RO(ospf->oiflist, inode, oi)) {
 167                         if ((nbrs = oi->nbrs) == NULL)
 168                                 continue;
 169
 170                         params = IF_DEF_PARAMS(oi->ifp);
 171                         if (!params->bfd_info)
 172                                 continue;
 173
 174                         for (rn = route_top(nbrs); rn; rn = route_next(rn)) {
 175                                 if ((nbr = rn->info) == NULL
 176                                     || nbr == oi->nbr_self)
 177                                         continue;
 178
 179                                 if (nbr->state < NSM_TwoWay)
 180                                         continue;
 181
 182                                 if (IS_DEBUG_OSPF(zebra, ZEBRA_INTERFACE))
 183                                         zlog_debug("Replaying nbr (%s) to BFD",
 184                                                    inet_ntoa(nbr->src));
 185
 186                                 ospf_bfd_reg_dereg_nbr(nbr,
 187                                                        ZEBRA_BFD_DEST_UPDATE);
 188                         }
 189                 }
 190         }
 191         return 0;
 192 }
 193
 194 /*
 195  * ospf_bfd_interface_dest_update - Find the neighbor for which the BFD status
 196  *                                  has changed and bring down the neighbor
 197  *                                  connectivity if the BFD status changed to
 198  *                                  down.
 199  */
 200 static int ospf_bfd_interface_dest_update(ZAPI_CALLBACK_ARGS)
 201 {
 202         struct interface *ifp;
 203         struct ospf_interface *oi;
 204         struct ospf_if_params *params;
 205         struct ospf_neighbor *nbr;
 206         struct route_node *node;
 207         struct prefix p;
 208         int status;
 209         int old_status;
 210         struct bfd_info *bfd_info;
 211         struct timeval tv;
 212
 213         ifp = bfd_get_peer_info(zclient->ibuf, &p, NULL, &status,
 214                                 NULL, vrf_id);
 215
 216         if ((ifp == NULL) || (p.family != AF_INET))
 217                 return 0;
 218
 219         if (IS_DEBUG_OSPF(zebra, ZEBRA_INTERFACE)) {
 220                 char buf[PREFIX2STR_BUFFER];
 221                 prefix2str(&p, buf, sizeof(buf));
 222                 zlog_debug("Zebra: interface %s bfd destination %s %s",
 223                            ifp->name, buf, bfd_get_status_str(status));
 224         }
 225
 226         params = IF_DEF_PARAMS(ifp);
 227         if (!params->bfd_info)
 228                 return 0;
 229
 230         for (node = route_top(IF_OIFS(ifp)); node; node = route_next(node)) {
 231                 if ((oi = node->info) == NULL)
 232                         continue;
 233
 234                 nbr = ospf_nbr_lookup_by_addr(oi->nbrs, &p.u.prefix4);
 235                 if (!nbr || !nbr->bfd_info)
 236                         continue;
 237
 238                 bfd_info = (struct bfd_info *)nbr->bfd_info;
 239                 if (bfd_info->status == status)
 240                         continue;
 241
 242                 old_status = bfd_info->status;
 243                 BFD_SET_CLIENT_STATUS(bfd_info->status, status);
 244                 monotime(&tv);
 245                 bfd_info->last_update = tv.tv_sec;
 246
 247                 if ((status == BFD_STATUS_DOWN)
 248                     && (old_status == BFD_STATUS_UP)) {
 249                         if (IS_DEBUG_OSPF(nsm, NSM_EVENTS))
 250                                 zlog_debug("NSM[%s:%s]: BFD Down",
 251                                            IF_NAME(nbr->oi),
 252                                            inet_ntoa(nbr->address.u.prefix4));
 253
 254                         OSPF_NSM_EVENT_SCHEDULE(nbr, NSM_InactivityTimer);
 255                 }
 256                 if ((status == BFD_STATUS_UP)
 257                     && (old_status == BFD_STATUS_DOWN)) {
 258                         if (IS_DEBUG_OSPF(nsm, NSM_EVENTS))
 259                                 zlog_debug("NSM[%s:%s]: BFD Up",
 260                                            IF_NAME(nbr->oi),
 261                                            inet_ntoa(nbr->address.u.prefix4));
 262                 }
 263         }
 264
 265         return 0;
 266 }
 267
 268 /*
 269  * ospf_bfd_info_nbr_create - Create/update BFD information for a neighbor.
 270  */
 271 void ospf_bfd_info_nbr_create(struct ospf_interface *oi,
 272                               struct ospf_neighbor *nbr)
 273 {
 274         struct bfd_info *oi_bfd_info;
 275         struct bfd_info *nbr_bfd_info;
 276         struct interface *ifp = oi->ifp;
 277         struct ospf_if_params *params;
 278
 279         /* Check if BFD is enabled */
 280         params = IF_DEF_PARAMS(ifp);
 281
 282         /* Check if BFD is enabled */
 283         if (!params->bfd_info)
 284                 return;
 285
 286         oi_bfd_info = (struct bfd_info *)params->bfd_info;
 287         if (!nbr->bfd_info)
 288                 nbr->bfd_info = bfd_info_create();
 289
 290         nbr_bfd_info = (struct bfd_info *)nbr->bfd_info;
 291         nbr_bfd_info->detect_mult = oi_bfd_info->detect_mult;
 292         nbr_bfd_info->desired_min_tx = oi_bfd_info->desired_min_tx;
 293         nbr_bfd_info->required_min_rx = oi_bfd_info->required_min_rx;
 294 }
 295
 296 /*
 297  * ospf_bfd_write_config - Write the interface BFD configuration.
 298  */
 299 void ospf_bfd_write_config(struct vty *vty, struct ospf_if_params *params)
 300
 301 {
 302 #if HAVE_BFDD == 0
 303         struct bfd_info *bfd_info;
 304 #endif /* ! HAVE_BFDD */
 305
 306         if (!params->bfd_info)
 307                 return;
 308
 309 #if HAVE_BFDD == 0
 310         bfd_info = (struct bfd_info *)params->bfd_info;
 311
 312         if (CHECK_FLAG(bfd_info->flags, BFD_FLAG_PARAM_CFG))
 313                 vty_out(vty, " ip ospf bfd %d %d %d\n", bfd_info->detect_mult,
 314                         bfd_info->required_min_rx, bfd_info->desired_min_tx);
 315         else
 316 #endif /* ! HAVE_BFDD */
 317                 vty_out(vty, " ip ospf bfd\n");
 318 }
 319
 320 /*
 321  * ospf_bfd_show_info - Show BFD info structure
 322  */
 323 void ospf_bfd_show_info(struct vty *vty, void *bfd_info, json_object *json_obj,
 324                         bool use_json, int param_only)
 325 {
 326         if (param_only)
 327                 bfd_show_param(vty, (struct bfd_info *)bfd_info, 1, 0, use_json,
 328                                json_obj);
 329         else
 330                 bfd_show_info(vty, (struct bfd_info *)bfd_info, 0, 1, use_json,
 331                               json_obj);
 332 }
 333
 334 /*
 335  * ospf_bfd_interface_show - Show the interface BFD configuration.
 336  */
 337 void ospf_bfd_interface_show(struct vty *vty, struct interface *ifp,
 338                              json_object *json_interface_sub, bool use_json)
 339 {
 340         struct ospf_if_params *params;
 341
 342         params = IF_DEF_PARAMS(ifp);
 343
 344         ospf_bfd_show_info(vty, params->bfd_info, json_interface_sub, use_json,
 345                            1);
 346 }
 347
 348 /*
 349  * ospf_bfd_if_param_set - Set the configured BFD paramter values for
 350  *                         interface.
 351  */
 352 static void ospf_bfd_if_param_set(struct interface *ifp, uint32_t min_rx,
 353                                   uint32_t min_tx, uint8_t detect_mult,
 354                                   int defaults)
 355 {
 356         struct ospf_if_params *params;
 357         int command = 0;
 358
 359         params = IF_DEF_PARAMS(ifp);
 360
 361         bfd_set_param((struct bfd_info **)&(params->bfd_info), min_rx, min_tx,
 362                       detect_mult, defaults, &command);
 363         if (command)
 364                 ospf_bfd_reg_dereg_all_nbr(ifp, command);
 365 }
 366
 367 DEFUN (ip_ospf_bfd,
 368        ip_ospf_bfd_cmd,
 369        "ip ospf bfd",
 370        "IP Information\n"
 371        "OSPF interface commands\n"
 372        "Enables BFD support\n")
 373 {
 374         VTY_DECLVAR_CONTEXT(interface, ifp);
 375         struct ospf_if_params *params;
 376         struct bfd_info *bfd_info;
 377
 378         assert(ifp);
 379         params = IF_DEF_PARAMS(ifp);
 380         bfd_info = params->bfd_info;
 381
 382         if (!bfd_info || !CHECK_FLAG(bfd_info->flags, BFD_FLAG_PARAM_CFG))
 383                 ospf_bfd_if_param_set(ifp, BFD_DEF_MIN_RX, BFD_DEF_MIN_TX,
 384                                       BFD_DEF_DETECT_MULT, 1);
 385
 386         return CMD_SUCCESS;
 387 }
 388
 389 #if HAVE_BFDD > 0
 390 DEFUN_HIDDEN(
 391 #else
 392 DEFUN(
 393 #endif /* HAVE_BFDD */
 394        ip_ospf_bfd_param,
 395        ip_ospf_bfd_param_cmd,
 396        "ip ospf bfd (2-255) (50-60000) (50-60000)",
 397        "IP Information\n"
 398        "OSPF interface commands\n"
 399        "Enables BFD support\n"
 400        "Detect Multiplier\n"
 401        "Required min receive interval\n"
 402        "Desired min transmit interval\n")
 403 {
 404         VTY_DECLVAR_CONTEXT(interface, ifp);
 405         int idx_number = 3;
 406         int idx_number_2 = 4;
 407         int idx_number_3 = 5;
 408         uint32_t rx_val;
 409         uint32_t tx_val;
 410         uint8_t dm_val;
 411         int ret;
 412
 413         assert(ifp);
 414
 415         if ((ret = bfd_validate_param(
 416                      vty, argv[idx_number]->arg, argv[idx_number_2]->arg,
 417                      argv[idx_number_3]->arg, &dm_val, &rx_val, &tx_val))
 418             != CMD_SUCCESS)
 419                 return ret;
 420
 421         ospf_bfd_if_param_set(ifp, rx_val, tx_val, dm_val, 0);
 422
 423         return CMD_SUCCESS;
 424 }
 425
 426 DEFUN (no_ip_ospf_bfd,
 427        no_ip_ospf_bfd_cmd,
 428 #if HAVE_BFDD > 0
 429        "no ip ospf bfd",
 430 #else
 431        "no ip ospf bfd [(2-255) (50-60000) (50-60000)]",
 432 #endif /* HAVE_BFDD */
 433        NO_STR
 434        "IP Information\n"
 435        "OSPF interface commands\n"
 436        "Disables BFD support\n"
 437 #if HAVE_BFDD == 0
 438        "Detect Multiplier\n"
 439        "Required min receive interval\n"
 440        "Desired min transmit interval\n"
 441 #endif /* !HAVE_BFDD */
 442 )
 443 {
 444         VTY_DECLVAR_CONTEXT(interface, ifp);
 445         struct ospf_if_params *params;
 446
 447         assert(ifp);
 448
 449         params = IF_DEF_PARAMS(ifp);
 450         if (params->bfd_info) {
 451                 ospf_bfd_reg_dereg_all_nbr(ifp, ZEBRA_BFD_DEST_DEREGISTER);
 452                 bfd_info_free(&(params->bfd_info));
 453         }
 454
 455         return CMD_SUCCESS;
 456 }
 457
 458 void ospf_bfd_init(void)
 459 {
 460         bfd_gbl_init();
 461
 462         /* Initialize BFD client functions */
 463         zclient->interface_bfd_dest_update = ospf_bfd_interface_dest_update;
 464         zclient->bfd_dest_replay = ospf_bfd_nbr_replay;
 465
 466         /* Install BFD command */
 467         install_element(INTERFACE_NODE, &ip_ospf_bfd_cmd);
 468         install_element(INTERFACE_NODE, &ip_ospf_bfd_param_cmd);
 469         install_element(INTERFACE_NODE, &no_ip_ospf_bfd_cmd);
 470 }