2 * bgp_bfd.c: BGP BFD handling routines
4 * @copyright Copyright (C) 2015 Cumulus Networks, Inc.
6 * This file is part of GNU Zebra.
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
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.
18 * You should have received a copy of the GNU General Public License
19 * along with GNU Zebra; see the file COPYING. If not, write to the Free
20 * Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
38 #include "bgpd/bgpd.h"
40 #include "bgpd/bgp_bfd.h"
41 #include "bgpd/bgp_debug.h"
42 #include "bgpd/bgp_vty.h"
44 extern struct zclient
*zclient
;
47 * bgp_bfd_peer_group2peer_copy - Copy the BFD information from peer group template
51 bgp_bfd_peer_group2peer_copy(struct peer
*conf
, struct peer
*peer
)
53 struct bfd_info
*bfd_info
;
54 struct bfd_info
*conf_bfd_info
;
59 conf_bfd_info
= (struct bfd_info
*)conf
->bfd_info
;
61 peer
->bfd_info
= bfd_info_create();
63 bfd_info
= (struct bfd_info
*)peer
->bfd_info
;
65 /* Copy BFD parameter values */
66 bfd_info
->required_min_rx
= conf_bfd_info
->required_min_rx
;
67 bfd_info
->desired_min_tx
= conf_bfd_info
->desired_min_tx
;
68 bfd_info
->detect_mult
= conf_bfd_info
->detect_mult
;
69 bfd_info
->type
= conf_bfd_info
->type
;
73 * bgp_bfd_is_peer_multihop - returns whether BFD peer is multi-hop or single hop.
76 bgp_bfd_is_peer_multihop(struct peer
*peer
)
78 struct bfd_info
*bfd_info
;
80 bfd_info
= (struct bfd_info
*)peer
->bfd_info
;
85 if((bfd_info
->type
== BFD_TYPE_MULTIHOP
) ||
86 ((peer
->sort
== BGP_PEER_IBGP
) && !peer
->shared_network
) ||
87 is_ebgp_multihop_configured(peer
))
94 * bgp_bfd_peer_sendmsg - Format and send a Peer register/Unregister
95 * command to Zebra to be forwarded to BFD
98 bgp_bfd_peer_sendmsg (struct peer
*peer
, int command
)
100 struct bfd_info
*bfd_info
;
101 vrf_id_t vrf_id
= VRF_DEFAULT
;
104 bfd_info
= (struct bfd_info
*)peer
->bfd_info
;
106 if (peer
->bgp
&& (peer
->bgp
->inst_type
== BGP_INSTANCE_TYPE_VRF
))
107 vrf_id
= peer
->bgp
->vrf_id
;
109 if (command
== ZEBRA_BFD_DEST_DEREGISTER
)
111 multihop
= CHECK_FLAG(bfd_info
->flags
, BFD_FLAG_BFD_TYPE_MULTIHOP
);
112 UNSET_FLAG(bfd_info
->flags
, BFD_FLAG_BFD_TYPE_MULTIHOP
);
116 multihop
= bgp_bfd_is_peer_multihop(peer
);
117 if ((command
== ZEBRA_BFD_DEST_REGISTER
) && multihop
)
118 SET_FLAG(bfd_info
->flags
, BFD_FLAG_BFD_TYPE_MULTIHOP
);
121 if (peer
->su
.sa
.sa_family
== AF_INET
)
122 bfd_peer_sendmsg (zclient
, bfd_info
, AF_INET
,
123 &peer
->su
.sin
.sin_addr
,
124 (peer
->su_local
) ? &peer
->su_local
->sin
.sin_addr
: NULL
,
125 (peer
->nexthop
.ifp
) ? peer
->nexthop
.ifp
->name
: NULL
,
126 peer
->ttl
, multihop
, command
, 1, vrf_id
);
127 else if (peer
->su
.sa
.sa_family
== AF_INET6
)
128 bfd_peer_sendmsg (zclient
, bfd_info
, AF_INET6
,
129 &peer
->su
.sin6
.sin6_addr
,
130 (peer
->su_local
) ? &peer
->su_local
->sin6
.sin6_addr
: NULL
,
131 (peer
->nexthop
.ifp
) ? peer
->nexthop
.ifp
->name
: NULL
,
132 peer
->ttl
, multihop
, command
, 1, vrf_id
);
136 * bgp_bfd_register_peer - register a peer with BFD through zebra
137 * for monitoring the peer rechahability.
140 bgp_bfd_register_peer (struct peer
*peer
)
142 struct bfd_info
*bfd_info
;
146 bfd_info
= (struct bfd_info
*)peer
->bfd_info
;
148 /* Check if BFD is enabled and peer has already been registered with BFD */
149 if (CHECK_FLAG(bfd_info
->flags
, BFD_FLAG_BFD_REG
))
152 bgp_bfd_peer_sendmsg(peer
, ZEBRA_BFD_DEST_REGISTER
);
156 * bgp_bfd_deregister_peer - deregister a peer with BFD through zebra
157 * for stopping the monitoring of the peer
161 bgp_bfd_deregister_peer (struct peer
*peer
)
163 struct bfd_info
*bfd_info
;
167 bfd_info
= (struct bfd_info
*)peer
->bfd_info
;
169 /* Check if BFD is eanbled and peer has not been registered */
170 if (!CHECK_FLAG(bfd_info
->flags
, BFD_FLAG_BFD_REG
))
173 bfd_info
->status
= BFD_STATUS_DOWN
;
174 bfd_info
->last_update
= bgp_clock();
176 bgp_bfd_peer_sendmsg(peer
, ZEBRA_BFD_DEST_DEREGISTER
);
180 * bgp_bfd_update_peer - update peer with BFD with new BFD paramters
184 bgp_bfd_update_peer (struct peer
*peer
)
186 struct bfd_info
*bfd_info
;
190 bfd_info
= (struct bfd_info
*)peer
->bfd_info
;
192 /* Check if the peer has been registered with BFD*/
193 if (!CHECK_FLAG(bfd_info
->flags
, BFD_FLAG_BFD_REG
))
196 bgp_bfd_peer_sendmsg(peer
, ZEBRA_BFD_DEST_UPDATE
);
200 * bgp_bfd_update_type - update session type with BFD through zebra.
203 bgp_bfd_update_type (struct peer
*peer
)
205 struct bfd_info
*bfd_info
;
210 bfd_info
= (struct bfd_info
*)peer
->bfd_info
;
212 /* Check if the peer has been registered with BFD*/
213 if (!CHECK_FLAG(bfd_info
->flags
, BFD_FLAG_BFD_REG
))
216 if (bfd_info
->type
== BFD_TYPE_NOT_CONFIGURED
)
218 multihop
= bgp_bfd_is_peer_multihop(peer
);
219 if ((multihop
&& !CHECK_FLAG(bfd_info
->flags
, BFD_FLAG_BFD_TYPE_MULTIHOP
)) ||
220 (!multihop
&& CHECK_FLAG(bfd_info
->flags
, BFD_FLAG_BFD_TYPE_MULTIHOP
)))
222 bgp_bfd_peer_sendmsg(peer
, ZEBRA_BFD_DEST_DEREGISTER
);
223 bgp_bfd_peer_sendmsg(peer
, ZEBRA_BFD_DEST_REGISTER
);
228 if ((bfd_info
->type
== BFD_TYPE_MULTIHOP
&&
229 !CHECK_FLAG(bfd_info
->flags
, BFD_FLAG_BFD_TYPE_MULTIHOP
)) ||
230 (bfd_info
->type
== BFD_TYPE_SINGLEHOP
&&
231 CHECK_FLAG(bfd_info
->flags
, BFD_FLAG_BFD_TYPE_MULTIHOP
)))
233 bgp_bfd_peer_sendmsg(peer
, ZEBRA_BFD_DEST_DEREGISTER
);
234 bgp_bfd_peer_sendmsg(peer
, ZEBRA_BFD_DEST_REGISTER
);
240 * bgp_bfd_dest_replay - Replay all the peers that have BFD enabled
244 bgp_bfd_dest_replay (int command
, struct zclient
*client
, zebra_size_t length
,
247 struct listnode
*mnode
, *node
, *nnode
;
251 if (BGP_DEBUG (zebra
, ZEBRA
))
252 zlog_debug("Zebra: BFD Dest replay request");
254 /* Send the client registration */
255 bfd_client_sendmsg(zclient
, ZEBRA_BFD_CLIENT_REGISTER
);
257 /* Replay the peer, if BFD is enabled in BGP */
259 for (ALL_LIST_ELEMENTS_RO (bm
->bgp
, mnode
, bgp
))
260 for (ALL_LIST_ELEMENTS (bgp
->peer
, node
, nnode
, peer
))
262 bgp_bfd_update_peer(peer
);
269 * bgp_bfd_peer_status_update - Update the BFD status if it has changed. Bring
270 * down the peer if the BFD session went down from * up.
273 bgp_bfd_peer_status_update (struct peer
*peer
, int status
)
275 struct bfd_info
*bfd_info
;
278 bfd_info
= (struct bfd_info
*)peer
->bfd_info
;
280 if (bfd_info
->status
== status
)
283 old_status
= bfd_info
->status
;
284 bfd_info
->status
= status
;
285 bfd_info
->last_update
= bgp_clock();
287 if ((status
== BFD_STATUS_DOWN
) && (old_status
== BFD_STATUS_UP
))
289 peer
->last_reset
= PEER_DOWN_BFD_DOWN
;
290 BGP_EVENT_ADD (peer
, BGP_Stop
);
295 * bgp_bfd_dest_update - Find the peer for which the BFD status
296 * has changed and bring down the peer
297 * connectivity if the BFD session went down.
300 bgp_bfd_dest_update (int command
, struct zclient
*zclient
,
301 zebra_size_t length
, vrf_id_t vrf_id
)
303 struct interface
*ifp
;
308 ifp
= bfd_get_peer_info (zclient
->ibuf
, &dp
, &sp
, &status
, vrf_id
);
310 if (BGP_DEBUG (zebra
, ZEBRA
))
312 char buf
[2][PREFIX2STR_BUFFER
];
313 prefix2str(&dp
, buf
[0], sizeof(buf
[0]));
316 zlog_debug("Zebra: vrf %d interface %s bfd destination %s %s",
317 vrf_id
, ifp
->name
, buf
[0], bfd_get_status_str(status
));
321 prefix2str(&sp
, buf
[1], sizeof(buf
[1]));
322 zlog_debug("Zebra: vrf %d source %s bfd destination %s %s",
323 vrf_id
, buf
[1], buf
[0], bfd_get_status_str(status
));
327 /* Bring the peer down if BFD is enabled in BGP */
329 struct listnode
*mnode
, *node
, *nnode
;
333 for (ALL_LIST_ELEMENTS_RO (bm
->bgp
, mnode
, bgp
))
334 for (ALL_LIST_ELEMENTS (bgp
->peer
, node
, nnode
, peer
))
339 if ((dp
.family
== AF_INET
) && (peer
->su
.sa
.sa_family
== AF_INET
))
341 if (dp
.u
.prefix4
.s_addr
!= peer
->su
.sin
.sin_addr
.s_addr
)
344 else if ((dp
.family
== AF_INET6
) &&
345 (peer
->su
.sa
.sa_family
== AF_INET6
))
347 if (memcmp(&dp
.u
.prefix6
, &peer
->su
.sin6
.sin6_addr
,
348 sizeof (struct in6_addr
)))
354 if (ifp
&& (ifp
== peer
->nexthop
.ifp
))
356 bgp_bfd_peer_status_update(peer
, status
);
363 if ((sp
.family
== AF_INET
) &&
364 (peer
->su_local
->sa
.sa_family
== AF_INET
))
366 if (sp
.u
.prefix4
.s_addr
!= peer
->su_local
->sin
.sin_addr
.s_addr
)
369 else if ((sp
.family
== AF_INET6
) &&
370 (peer
->su_local
->sa
.sa_family
== AF_INET6
))
372 if (memcmp(&sp
.u
.prefix6
, &peer
->su_local
->sin6
.sin6_addr
,
373 sizeof (struct in6_addr
)))
379 if ((vrf_id
!= VRF_DEFAULT
) && (peer
->bgp
->vrf_id
!= vrf_id
))
382 bgp_bfd_peer_status_update(peer
, status
);
391 * bgp_bfd_peer_param_set - Set the configured BFD paramter values for peer.
394 bgp_bfd_peer_param_set (struct peer
*peer
, u_int32_t min_rx
, u_int32_t min_tx
,
395 u_int8_t detect_mult
, int defaults
)
397 struct peer_group
*group
;
398 struct listnode
*node
, *nnode
;
401 bfd_set_param((struct bfd_info
**)&(peer
->bfd_info
), min_rx
, min_tx
,
402 detect_mult
, defaults
, &command
);
404 if (CHECK_FLAG (peer
->sflags
, PEER_STATUS_GROUP
))
407 for (ALL_LIST_ELEMENTS (group
->peer
, node
, nnode
, peer
))
410 bfd_set_param((struct bfd_info
**)&(peer
->bfd_info
), min_rx
, min_tx
,
411 detect_mult
, defaults
, &command
);
413 if ((peer
->status
== Established
) &&
414 (command
== ZEBRA_BFD_DEST_REGISTER
))
415 bgp_bfd_register_peer(peer
);
416 else if (command
== ZEBRA_BFD_DEST_UPDATE
)
417 bgp_bfd_update_peer(peer
);
422 if ((peer
->status
== Established
) &&
423 (command
== ZEBRA_BFD_DEST_REGISTER
))
424 bgp_bfd_register_peer(peer
);
425 else if (command
== ZEBRA_BFD_DEST_UPDATE
)
426 bgp_bfd_update_peer(peer
);
432 * bgp_bfd_peer_param_unset - Delete the configured BFD paramter values for peer.
435 bgp_bfd_peer_param_unset (struct peer
*peer
)
437 struct peer_group
*group
;
438 struct listnode
*node
, *nnode
;
443 if (CHECK_FLAG (peer
->sflags
, PEER_STATUS_GROUP
))
445 bfd_info_free(&(peer
->bfd_info
));
447 for (ALL_LIST_ELEMENTS (group
->peer
, node
, nnode
, peer
))
449 bgp_bfd_deregister_peer(peer
);
450 bfd_info_free(&(peer
->bfd_info
));
455 bgp_bfd_deregister_peer(peer
);
456 bfd_info_free(&(peer
->bfd_info
));
462 * bgp_bfd_peer_param_type_set - set the BFD session type (multihop or singlehop)
465 bgp_bfd_peer_param_type_set (struct peer
*peer
, enum bfd_sess_type type
)
467 struct peer_group
*group
;
468 struct listnode
*node
, *nnode
;
470 struct bfd_info
*bfd_info
;
473 bfd_set_param((struct bfd_info
**)&(peer
->bfd_info
), BFD_DEF_MIN_RX
,
474 BFD_DEF_MIN_TX
, BFD_DEF_DETECT_MULT
, 1, &command
);
476 bfd_info
= (struct bfd_info
*)peer
->bfd_info
;
477 bfd_info
->type
= type
;
479 if (CHECK_FLAG (peer
->sflags
, PEER_STATUS_GROUP
))
482 for (ALL_LIST_ELEMENTS (group
->peer
, node
, nnode
, peer
))
486 bfd_set_param((struct bfd_info
**)&(peer
->bfd_info
),
487 BFD_DEF_MIN_RX
, BFD_DEF_MIN_TX
,
488 BFD_DEF_DETECT_MULT
, 1, &command
);
490 bfd_info
= (struct bfd_info
*)peer
->bfd_info
;
491 bfd_info
->type
= type
;
493 if (peer
->status
== Established
)
495 if (command
== ZEBRA_BFD_DEST_REGISTER
)
496 bgp_bfd_register_peer(peer
);
498 bgp_bfd_update_type(peer
);
504 if (peer
->status
== Established
)
506 if (command
== ZEBRA_BFD_DEST_REGISTER
)
507 bgp_bfd_register_peer(peer
);
509 bgp_bfd_update_type(peer
);
517 * bgp_bfd_peer_config_write - Write the peer BFD configuration.
520 bgp_bfd_peer_config_write(struct vty
*vty
, struct peer
*peer
, char *addr
)
522 struct bfd_info
*bfd_info
;
527 bfd_info
= (struct bfd_info
*)peer
->bfd_info
;
529 if (CHECK_FLAG (bfd_info
->flags
, BFD_FLAG_PARAM_CFG
))
530 vty_out (vty
, " neighbor %s bfd %d %d %d%s", addr
,
531 bfd_info
->detect_mult
, bfd_info
->required_min_rx
,
532 bfd_info
->desired_min_tx
, VTY_NEWLINE
);
534 if (bfd_info
->type
!= BFD_TYPE_NOT_CONFIGURED
)
535 vty_out (vty
, " neighbor %s bfd %s%s", addr
,
536 (bfd_info
->type
== BFD_TYPE_MULTIHOP
) ? "multihop" : "singlehop",
539 if (!CHECK_FLAG (bfd_info
->flags
, BFD_FLAG_PARAM_CFG
) &&
540 (bfd_info
->type
== BFD_TYPE_NOT_CONFIGURED
))
541 vty_out (vty
, " neighbor %s bfd%s", addr
, VTY_NEWLINE
);
545 * bgp_bfd_show_info - Show the peer BFD information.
548 bgp_bfd_show_info(struct vty
*vty
, struct peer
*peer
, u_char use_json
, json_object
*json_neigh
)
550 bfd_show_info(vty
, (struct bfd_info
*)peer
->bfd_info
,
551 bgp_bfd_is_peer_multihop(peer
), 0, use_json
, json_neigh
);
556 "neighbor <A.B.C.D|X:X::X:X|WORD> bfd",
559 "Enables BFD support\n")
565 peer
= peer_and_group_lookup_vty (vty
, argv
[idx_peer
]->arg
);
569 ret
= bgp_bfd_peer_param_set (peer
, BFD_DEF_MIN_RX
, BFD_DEF_MIN_TX
,
570 BFD_DEF_DETECT_MULT
, 1);
572 return bgp_vty_return (vty
, ret
);
578 DEFUN (neighbor_bfd_param
,
579 neighbor_bfd_param_cmd
,
580 "neighbor <A.B.C.D|X:X::X:X|WORD> bfd (2-255) (50-60000) (50-60000)",
583 "Enables BFD support\n"
584 "Detect Multiplier\n"
585 "Required min receive interval\n"
586 "Desired min transmit interval\n")
589 int idx_number_1
= 3;
590 int idx_number_2
= 4;
591 int idx_number_3
= 5;
598 peer
= peer_and_group_lookup_vty (vty
, argv
[idx_peer
]->arg
);
602 if ((ret
= bfd_validate_param (vty
, argv
[idx_number_1
]->arg
, argv
[idx_number_2
]->arg
, argv
[idx_number_3
]->arg
, &dm_val
,
603 &rx_val
, &tx_val
)) != CMD_SUCCESS
)
606 ret
= bgp_bfd_peer_param_set (peer
, rx_val
, tx_val
, dm_val
, 0);
608 return bgp_vty_return (vty
, ret
);
614 DEFUN_HIDDEN (neighbor_bfd_type
,
615 neighbor_bfd_type_cmd
,
616 "neighbor <A.B.C.D|X:X::X:X|WORD> bfd <multihop|singlehop>",
619 "Enables BFD support\n"
621 "Single hop session\n")
626 enum bfd_sess_type type
;
629 peer
= peer_and_group_lookup_vty (vty
, argv
[idx_peer
]->arg
);
633 if (!strcmp(argv
[idx_hop
]->arg
, "singlehop"))
634 type
= BFD_TYPE_SINGLEHOP
;
635 else if (!strcmp(argv
[idx_hop
]->arg
, "multihop"))
636 type
= BFD_TYPE_MULTIHOP
;
640 ret
= bgp_bfd_peer_param_type_set (peer
, type
);
642 return bgp_vty_return (vty
, ret
);
647 DEFUN (no_neighbor_bfd
,
649 "no neighbor <A.B.C.D|X:X::X:X|WORD> bfd [(2-255) (50-60000) (50-60000)]",
653 "Disables BFD support\n"
654 "Detect Multiplier\n"
655 "Required min receive interval\n"
656 "Desired min transmit interval\n")
662 peer
= peer_and_group_lookup_vty (vty
, argv
[idx_peer
]->arg
);
666 ret
= bgp_bfd_peer_param_unset(peer
);
668 return bgp_vty_return (vty
, ret
);
674 DEFUN_HIDDEN (no_neighbor_bfd_type
,
675 no_neighbor_bfd_type_cmd
,
676 "no neighbor <A.B.C.D|X:X::X:X|WORD> bfd <multihop|singlehop>",
680 "Disables BFD support\n"
682 "Singlehop session\n")
688 peer
= peer_and_group_lookup_vty (vty
, argv
[idx_peer
]->arg
);
695 ret
= bgp_bfd_peer_param_type_set(peer
, BFD_TYPE_NOT_CONFIGURED
);
697 return bgp_vty_return (vty
, ret
);
707 /* Initialize BFD client functions */
708 zclient
->interface_bfd_dest_update
= bgp_bfd_dest_update
;
709 zclient
->bfd_dest_replay
= bgp_bfd_dest_replay
;
711 /* "neighbor bfd" commands. */
712 install_element (BGP_NODE
, &neighbor_bfd_cmd
);
713 install_element (BGP_NODE
, &neighbor_bfd_param_cmd
);
714 install_element (BGP_NODE
, &neighbor_bfd_type_cmd
);
715 install_element (BGP_NODE
, &no_neighbor_bfd_cmd
);
716 install_element (BGP_NODE
, &no_neighbor_bfd_type_cmd
);