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 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
37 #include "bgpd/bgpd.h"
39 #include "bgpd/bgp_bfd.h"
40 #include "bgpd/bgp_debug.h"
41 #include "bgpd/bgp_vty.h"
43 extern struct zclient
*zclient
;
46 * bgp_bfd_peer_group2peer_copy - Copy the BFD information from peer group
50 void bgp_bfd_peer_group2peer_copy(struct peer
*conf
, struct peer
*peer
)
52 struct bfd_info
*bfd_info
;
53 struct bfd_info
*conf_bfd_info
;
58 conf_bfd_info
= (struct bfd_info
*)conf
->bfd_info
;
60 peer
->bfd_info
= bfd_info_create();
62 bfd_info
= (struct bfd_info
*)peer
->bfd_info
;
64 /* Copy BFD parameter values */
65 bfd_info
->required_min_rx
= conf_bfd_info
->required_min_rx
;
66 bfd_info
->desired_min_tx
= conf_bfd_info
->desired_min_tx
;
67 bfd_info
->detect_mult
= conf_bfd_info
->detect_mult
;
68 bfd_info
->type
= conf_bfd_info
->type
;
72 * bgp_bfd_is_peer_multihop - returns whether BFD peer is multi-hop or single
75 int bgp_bfd_is_peer_multihop(struct peer
*peer
)
77 struct bfd_info
*bfd_info
;
79 bfd_info
= (struct bfd_info
*)peer
->bfd_info
;
84 if ((bfd_info
->type
== BFD_TYPE_MULTIHOP
)
85 || ((peer
->sort
== BGP_PEER_IBGP
) && !peer
->shared_network
)
86 || is_ebgp_multihop_configured(peer
))
93 * bgp_bfd_peer_sendmsg - Format and send a Peer register/Unregister
94 * command to Zebra to be forwarded to BFD
96 static void bgp_bfd_peer_sendmsg(struct peer
*peer
, int command
)
98 struct bfd_info
*bfd_info
;
99 vrf_id_t vrf_id
= VRF_DEFAULT
;
102 bfd_info
= (struct bfd_info
*)peer
->bfd_info
;
104 if (peer
->bgp
->inst_type
== BGP_INSTANCE_TYPE_VRF
)
105 vrf_id
= peer
->bgp
->vrf_id
;
107 if (command
== ZEBRA_BFD_DEST_DEREGISTER
) {
109 CHECK_FLAG(bfd_info
->flags
, BFD_FLAG_BFD_TYPE_MULTIHOP
);
110 UNSET_FLAG(bfd_info
->flags
, BFD_FLAG_BFD_TYPE_MULTIHOP
);
112 multihop
= bgp_bfd_is_peer_multihop(peer
);
113 if ((command
== ZEBRA_BFD_DEST_REGISTER
) && multihop
)
114 SET_FLAG(bfd_info
->flags
, BFD_FLAG_BFD_TYPE_MULTIHOP
);
117 if (peer
->su
.sa
.sa_family
== AF_INET
)
119 zclient
, bfd_info
, AF_INET
, &peer
->su
.sin
.sin_addr
,
120 (peer
->su_local
) ? &peer
->su_local
->sin
.sin_addr
: NULL
,
121 (peer
->nexthop
.ifp
) ? peer
->nexthop
.ifp
->name
: NULL
,
122 peer
->ttl
, multihop
, command
, 1, vrf_id
);
123 else if (peer
->su
.sa
.sa_family
== AF_INET6
)
125 zclient
, bfd_info
, AF_INET6
, &peer
->su
.sin6
.sin6_addr
,
126 (peer
->su_local
) ? &peer
->su_local
->sin6
.sin6_addr
128 (peer
->nexthop
.ifp
) ? peer
->nexthop
.ifp
->name
: NULL
,
129 peer
->ttl
, multihop
, command
, 1, vrf_id
);
133 * bgp_bfd_register_peer - register a peer with BFD through zebra
134 * for monitoring the peer rechahability.
136 void bgp_bfd_register_peer(struct peer
*peer
)
138 struct bfd_info
*bfd_info
;
142 bfd_info
= (struct bfd_info
*)peer
->bfd_info
;
144 /* Check if BFD is enabled and peer has already been registered with BFD
146 if (CHECK_FLAG(bfd_info
->flags
, BFD_FLAG_BFD_REG
))
149 bgp_bfd_peer_sendmsg(peer
, ZEBRA_BFD_DEST_REGISTER
);
153 * bgp_bfd_deregister_peer - deregister a peer with BFD through zebra
154 * for stopping the monitoring of the peer
157 void bgp_bfd_deregister_peer(struct peer
*peer
)
159 struct bfd_info
*bfd_info
;
163 bfd_info
= (struct bfd_info
*)peer
->bfd_info
;
165 /* Check if BFD is eanbled and peer has not been registered */
166 if (!CHECK_FLAG(bfd_info
->flags
, BFD_FLAG_BFD_REG
))
169 bfd_info
->status
= BFD_STATUS_DOWN
;
170 bfd_info
->last_update
= bgp_clock();
172 bgp_bfd_peer_sendmsg(peer
, ZEBRA_BFD_DEST_DEREGISTER
);
176 * bgp_bfd_update_peer - update peer with BFD with new BFD paramters
179 static void bgp_bfd_update_peer(struct peer
*peer
)
181 struct bfd_info
*bfd_info
;
185 bfd_info
= (struct bfd_info
*)peer
->bfd_info
;
187 /* Check if the peer has been registered with BFD*/
188 if (!CHECK_FLAG(bfd_info
->flags
, BFD_FLAG_BFD_REG
))
191 bgp_bfd_peer_sendmsg(peer
, ZEBRA_BFD_DEST_UPDATE
);
195 * bgp_bfd_update_type - update session type with BFD through zebra.
197 static void bgp_bfd_update_type(struct peer
*peer
)
199 struct bfd_info
*bfd_info
;
204 bfd_info
= (struct bfd_info
*)peer
->bfd_info
;
206 /* Check if the peer has been registered with BFD*/
207 if (!CHECK_FLAG(bfd_info
->flags
, BFD_FLAG_BFD_REG
))
210 if (bfd_info
->type
== BFD_TYPE_NOT_CONFIGURED
) {
211 multihop
= bgp_bfd_is_peer_multihop(peer
);
213 && !CHECK_FLAG(bfd_info
->flags
,
214 BFD_FLAG_BFD_TYPE_MULTIHOP
))
215 || (!multihop
&& CHECK_FLAG(bfd_info
->flags
,
216 BFD_FLAG_BFD_TYPE_MULTIHOP
))) {
217 bgp_bfd_peer_sendmsg(peer
, ZEBRA_BFD_DEST_DEREGISTER
);
218 bgp_bfd_peer_sendmsg(peer
, ZEBRA_BFD_DEST_REGISTER
);
221 if ((bfd_info
->type
== BFD_TYPE_MULTIHOP
222 && !CHECK_FLAG(bfd_info
->flags
,
223 BFD_FLAG_BFD_TYPE_MULTIHOP
))
224 || (bfd_info
->type
== BFD_TYPE_SINGLEHOP
225 && CHECK_FLAG(bfd_info
->flags
,
226 BFD_FLAG_BFD_TYPE_MULTIHOP
))) {
227 bgp_bfd_peer_sendmsg(peer
, ZEBRA_BFD_DEST_DEREGISTER
);
228 bgp_bfd_peer_sendmsg(peer
, ZEBRA_BFD_DEST_REGISTER
);
234 * bgp_bfd_dest_replay - Replay all the peers that have BFD enabled
237 static int bgp_bfd_dest_replay(ZAPI_CALLBACK_ARGS
)
239 struct listnode
*mnode
, *node
, *nnode
;
243 if (BGP_DEBUG(zebra
, ZEBRA
))
244 zlog_debug("Zebra: BFD Dest replay request");
246 /* Send the client registration */
247 bfd_client_sendmsg(zclient
, ZEBRA_BFD_CLIENT_REGISTER
);
249 /* Replay the peer, if BFD is enabled in BGP */
251 for (ALL_LIST_ELEMENTS_RO(bm
->bgp
, mnode
, bgp
))
252 for (ALL_LIST_ELEMENTS(bgp
->peer
, node
, nnode
, peer
)) {
253 bgp_bfd_update_peer(peer
);
260 * bgp_bfd_peer_status_update - Update the BFD status if it has changed. Bring
261 * down the peer if the BFD session went down from
264 static void bgp_bfd_peer_status_update(struct peer
*peer
, int status
)
266 struct bfd_info
*bfd_info
;
269 bfd_info
= (struct bfd_info
*)peer
->bfd_info
;
271 if (bfd_info
->status
== status
)
274 old_status
= bfd_info
->status
;
275 bfd_info
->status
= status
;
276 bfd_info
->last_update
= bgp_clock();
278 if (status
!= old_status
) {
279 if (BGP_DEBUG(neighbor_events
, NEIGHBOR_EVENTS
))
280 zlog_debug("[%s]: BFD %s", peer
->host
,
281 bfd_get_status_str(status
));
283 if ((status
== BFD_STATUS_DOWN
) && (old_status
== BFD_STATUS_UP
)) {
284 peer
->last_reset
= PEER_DOWN_BFD_DOWN
;
285 BGP_EVENT_ADD(peer
, BGP_Stop
);
287 if ((status
== BFD_STATUS_UP
) && (old_status
== BFD_STATUS_DOWN
)
288 && peer
->status
!= Established
) {
289 if (!BGP_PEER_START_SUPPRESSED(peer
)) {
290 bgp_fsm_event_update(peer
, 1);
291 BGP_EVENT_ADD(peer
, BGP_Start
);
297 * bgp_bfd_dest_update - Find the peer for which the BFD status
298 * has changed and bring down the peer
299 * connectivity if the BFD session went down.
301 static int bgp_bfd_dest_update(ZAPI_CALLBACK_ARGS
)
303 struct interface
*ifp
;
308 ifp
= bfd_get_peer_info(zclient
->ibuf
, &dp
, &sp
, &status
, vrf_id
);
310 if (BGP_DEBUG(zebra
, ZEBRA
)) {
311 char buf
[2][PREFIX2STR_BUFFER
];
312 prefix2str(&dp
, buf
[0], sizeof(buf
[0]));
315 "Zebra: vrf %u interface %s bfd destination %s %s",
316 vrf_id
, ifp
->name
, buf
[0],
317 bfd_get_status_str(status
));
319 prefix2str(&sp
, buf
[1], sizeof(buf
[1]));
321 "Zebra: vrf %u source %s bfd destination %s %s",
322 vrf_id
, buf
[1], buf
[0],
323 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
)) {
338 if ((dp
.family
== AF_INET
)
339 && (peer
->su
.sa
.sa_family
== AF_INET
)) {
340 if (dp
.u
.prefix4
.s_addr
341 != peer
->su
.sin
.sin_addr
.s_addr
)
343 } else if ((dp
.family
== AF_INET6
)
344 && (peer
->su
.sa
.sa_family
346 if (memcmp(&dp
.u
.prefix6
,
347 &peer
->su
.sin6
.sin6_addr
,
348 sizeof(struct in6_addr
)))
353 if (ifp
&& (ifp
== peer
->nexthop
.ifp
)) {
354 bgp_bfd_peer_status_update(peer
,
360 if ((sp
.family
== AF_INET
)
361 && (peer
->su_local
->sa
.sa_family
363 if (sp
.u
.prefix4
.s_addr
364 != peer
->su_local
->sin
367 } else if ((sp
.family
== AF_INET6
)
368 && (peer
->su_local
->sa
371 if (memcmp(&sp
.u
.prefix6
,
372 &peer
->su_local
->sin6
380 if ((vrf_id
!= VRF_DEFAULT
)
381 && (peer
->bgp
->vrf_id
!= vrf_id
))
384 bgp_bfd_peer_status_update(peer
,
394 * bgp_bfd_peer_param_set - Set the configured BFD paramter values for peer.
396 static int bgp_bfd_peer_param_set(struct peer
*peer
, uint32_t min_rx
,
397 uint32_t min_tx
, uint8_t detect_mult
,
400 struct peer_group
*group
;
401 struct listnode
*node
, *nnode
;
404 bfd_set_param((struct bfd_info
**)&(peer
->bfd_info
), min_rx
, min_tx
,
405 detect_mult
, defaults
, &command
);
407 if (CHECK_FLAG(peer
->sflags
, PEER_STATUS_GROUP
)) {
409 for (ALL_LIST_ELEMENTS(group
->peer
, node
, nnode
, peer
)) {
411 bfd_set_param((struct bfd_info
**)&(peer
->bfd_info
),
412 min_rx
, min_tx
, detect_mult
, defaults
,
415 if ((peer
->status
== Established
)
416 && (command
== ZEBRA_BFD_DEST_REGISTER
))
417 bgp_bfd_register_peer(peer
);
418 else if (command
== ZEBRA_BFD_DEST_UPDATE
)
419 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
435 static int 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
)) {
444 bfd_info_free(&(peer
->bfd_info
));
446 for (ALL_LIST_ELEMENTS(group
->peer
, node
, nnode
, peer
)) {
447 bgp_bfd_deregister_peer(peer
);
448 bfd_info_free(&(peer
->bfd_info
));
451 bgp_bfd_deregister_peer(peer
);
452 bfd_info_free(&(peer
->bfd_info
));
458 * bgp_bfd_peer_param_type_set - set the BFD session type (multihop or
461 static int bgp_bfd_peer_param_type_set(struct peer
*peer
,
462 enum bfd_sess_type type
)
464 struct peer_group
*group
;
465 struct listnode
*node
, *nnode
;
467 struct bfd_info
*bfd_info
;
470 bfd_set_param((struct bfd_info
**)&(peer
->bfd_info
),
471 BFD_DEF_MIN_RX
, BFD_DEF_MIN_TX
,
472 BFD_DEF_DETECT_MULT
, 1, &command
);
474 bfd_info
= (struct bfd_info
*)peer
->bfd_info
;
475 bfd_info
->type
= type
;
477 if (CHECK_FLAG(peer
->sflags
, PEER_STATUS_GROUP
)) {
479 for (ALL_LIST_ELEMENTS(group
->peer
, node
, nnode
, peer
)) {
483 (struct bfd_info
**)&(peer
->bfd_info
),
484 BFD_DEF_MIN_RX
, BFD_DEF_MIN_TX
,
485 BFD_DEF_DETECT_MULT
, 1, &command
);
487 bfd_info
= (struct bfd_info
*)peer
->bfd_info
;
488 bfd_info
->type
= type
;
490 if (peer
->status
== Established
) {
491 if (command
== ZEBRA_BFD_DEST_REGISTER
)
492 bgp_bfd_register_peer(peer
);
494 bgp_bfd_update_type(peer
);
498 if (peer
->status
== Established
) {
499 if (command
== ZEBRA_BFD_DEST_REGISTER
)
500 bgp_bfd_register_peer(peer
);
502 bgp_bfd_update_type(peer
);
510 * bgp_bfd_peer_config_write - Write the peer BFD configuration.
512 void bgp_bfd_peer_config_write(struct vty
*vty
, struct peer
*peer
, char *addr
)
514 struct bfd_info
*bfd_info
;
519 bfd_info
= (struct bfd_info
*)peer
->bfd_info
;
521 if (CHECK_FLAG(bfd_info
->flags
, BFD_FLAG_PARAM_CFG
))
523 vty_out(vty
, " neighbor %s bfd\n", addr
);
525 vty_out(vty
, " neighbor %s bfd %d %d %d\n", addr
,
526 bfd_info
->detect_mult
, bfd_info
->required_min_rx
,
527 bfd_info
->desired_min_tx
);
528 #endif /* HAVE_BFDD */
530 if (bfd_info
->type
!= BFD_TYPE_NOT_CONFIGURED
)
531 vty_out(vty
, " neighbor %s bfd %s\n", addr
,
532 (bfd_info
->type
== BFD_TYPE_MULTIHOP
) ? "multihop"
535 if (!CHECK_FLAG(bfd_info
->flags
, BFD_FLAG_PARAM_CFG
)
536 && (bfd_info
->type
== BFD_TYPE_NOT_CONFIGURED
))
537 vty_out(vty
, " neighbor %s bfd\n", addr
);
541 * bgp_bfd_show_info - Show the peer BFD information.
543 void bgp_bfd_show_info(struct vty
*vty
, struct peer
*peer
, bool use_json
,
544 json_object
*json_neigh
)
546 bfd_show_info(vty
, (struct bfd_info
*)peer
->bfd_info
,
547 bgp_bfd_is_peer_multihop(peer
), 0, use_json
, json_neigh
);
552 "neighbor <A.B.C.D|X:X::X:X|WORD> bfd",
555 "Enables BFD support\n")
561 peer
= peer_and_group_lookup_vty(vty
, argv
[idx_peer
]->arg
);
563 return CMD_WARNING_CONFIG_FAILED
;
565 ret
= bgp_bfd_peer_param_set(peer
, BFD_DEF_MIN_RX
, BFD_DEF_MIN_TX
,
566 BFD_DEF_DETECT_MULT
, 1);
568 return bgp_vty_return(vty
, ret
);
577 #endif /* HAVE_BFDD */
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
);
600 return CMD_WARNING_CONFIG_FAILED
;
602 if ((ret
= bfd_validate_param(
603 vty
, argv
[idx_number_1
]->arg
, argv
[idx_number_2
]->arg
,
604 argv
[idx_number_3
]->arg
, &dm_val
, &rx_val
, &tx_val
))
608 ret
= bgp_bfd_peer_param_set(peer
, rx_val
, tx_val
, dm_val
, 0);
610 return bgp_vty_return(vty
, ret
);
615 DEFUN_HIDDEN (neighbor_bfd_type
,
616 neighbor_bfd_type_cmd
,
617 "neighbor <A.B.C.D|X:X::X:X|WORD> bfd <multihop|singlehop>",
620 "Enables BFD support\n"
622 "Single hop session\n")
627 enum bfd_sess_type type
;
630 peer
= peer_and_group_lookup_vty(vty
, argv
[idx_peer
]->arg
);
632 return CMD_WARNING_CONFIG_FAILED
;
634 if (strmatch(argv
[idx_hop
]->text
, "singlehop"))
635 type
= BFD_TYPE_SINGLEHOP
;
636 else if (strmatch(argv
[idx_hop
]->text
, "multihop"))
637 type
= BFD_TYPE_MULTIHOP
;
639 return CMD_WARNING_CONFIG_FAILED
;
641 ret
= bgp_bfd_peer_param_type_set(peer
, type
);
643 return bgp_vty_return(vty
, ret
);
648 DEFUN (no_neighbor_bfd
,
651 "no neighbor <A.B.C.D|X:X::X:X|WORD> bfd",
653 "no neighbor <A.B.C.D|X:X::X:X|WORD> bfd [(2-255) (50-60000) (50-60000)]",
654 #endif /* HAVE_BFDD */
658 "Disables BFD support\n"
660 "Detect Multiplier\n"
661 "Required min receive interval\n"
662 "Desired min transmit interval\n"
663 #endif /* !HAVE_BFDD */
670 peer
= peer_and_group_lookup_vty(vty
, argv
[idx_peer
]->arg
);
672 return CMD_WARNING_CONFIG_FAILED
;
674 ret
= bgp_bfd_peer_param_unset(peer
);
676 return bgp_vty_return(vty
, ret
);
682 DEFUN_HIDDEN (no_neighbor_bfd_type
,
683 no_neighbor_bfd_type_cmd
,
684 "no neighbor <A.B.C.D|X:X::X:X|WORD> bfd <multihop|singlehop>",
688 "Disables BFD support\n"
690 "Singlehop session\n")
696 peer
= peer_and_group_lookup_vty(vty
, argv
[idx_peer
]->arg
);
698 return CMD_WARNING_CONFIG_FAILED
;
703 ret
= bgp_bfd_peer_param_type_set(peer
, BFD_TYPE_NOT_CONFIGURED
);
705 return bgp_vty_return(vty
, ret
);
710 void bgp_bfd_init(void)
714 /* Initialize BFD client functions */
715 zclient
->interface_bfd_dest_update
= bgp_bfd_dest_update
;
716 zclient
->bfd_dest_replay
= bgp_bfd_dest_replay
;
718 /* "neighbor bfd" commands. */
719 install_element(BGP_NODE
, &neighbor_bfd_cmd
);
720 install_element(BGP_NODE
, &neighbor_bfd_param_cmd
);
721 install_element(BGP_NODE
, &neighbor_bfd_type_cmd
);
722 install_element(BGP_NODE
, &no_neighbor_bfd_cmd
);
723 install_element(BGP_NODE
, &no_neighbor_bfd_type_cmd
);