1 /*********************************************************************
2 * Copyright 2013 Cumulus Networks, LLC. All rights reserved.
3 * Copyright 2014,2015,2016,2017 Cumulus Networks, Inc. All rights reserved.
5 * This program is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License as published by the Free
7 * Software Foundation; either version 2 of the License, or (at your option)
10 * This program is distributed in the hope that it will be useful, but WITHOUT
11 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
12 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
15 * You should have received a copy of the GNU General Public License along
16 * with this program; see the file COPYING; if not, write to the Free Software
17 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
19 * bfd.c: implements the BFD protocol.
23 * Shrijeet Mukherjee [shm@cumulusnetworks.com]
24 * Kanna Rajagopal [kanna@cumulusnetworks.com]
25 * Radhika Mahankali [Radhika@cumulusnetworks.com]
30 #include "lib/jhash.h"
34 DEFINE_MTYPE_STATIC(BFDD
, BFDD_CONFIG
, "long-lived configuration memory")
35 DEFINE_MTYPE_STATIC(BFDD
, BFDD_SESSION_OBSERVER
, "Session observer")
36 DEFINE_MTYPE_STATIC(BFDD
, BFDD_VRF
, "BFD VRF")
41 static uint32_t ptm_bfd_gen_ID(void);
42 static void ptm_bfd_echo_xmt_TO(struct bfd_session
*bfd
);
43 static struct bfd_session
*bfd_find_disc(struct sockaddr_any
*sa
,
45 static int bfd_session_update(struct bfd_session
*bs
, struct bfd_peer_cfg
*bpc
);
46 static const char *get_diag_str(int diag
);
48 static void bs_admin_down_handler(struct bfd_session
*bs
, int nstate
);
49 static void bs_down_handler(struct bfd_session
*bs
, int nstate
);
50 static void bs_init_handler(struct bfd_session
*bs
, int nstate
);
51 static void bs_up_handler(struct bfd_session
*bs
, int nstate
);
53 /* Zeroed array with the size of an IPv6 address. */
54 struct in6_addr zero_addr
;
59 void gen_bfd_key(struct bfd_key
*key
, struct sockaddr_any
*peer
,
60 struct sockaddr_any
*local
, bool mhop
, const char *ifname
,
63 memset(key
, 0, sizeof(*key
));
65 switch (peer
->sa_sin
.sin_family
) {
67 key
->family
= AF_INET
;
68 memcpy(&key
->peer
, &peer
->sa_sin
.sin_addr
,
69 sizeof(peer
->sa_sin
.sin_addr
));
70 memcpy(&key
->local
, &local
->sa_sin
.sin_addr
,
71 sizeof(local
->sa_sin
.sin_addr
));
74 key
->family
= AF_INET6
;
75 memcpy(&key
->peer
, &peer
->sa_sin6
.sin6_addr
,
76 sizeof(peer
->sa_sin6
.sin6_addr
));
77 memcpy(&key
->local
, &local
->sa_sin6
.sin6_addr
,
78 sizeof(local
->sa_sin6
.sin6_addr
));
83 if (ifname
&& ifname
[0])
84 strlcpy(key
->ifname
, ifname
, sizeof(key
->ifname
));
85 if (vrfname
&& vrfname
[0])
86 strlcpy(key
->vrfname
, vrfname
, sizeof(key
->vrfname
));
88 strlcpy(key
->vrfname
, VRF_DEFAULT_NAME
, sizeof(key
->vrfname
));
91 struct bfd_session
*bs_peer_find(struct bfd_peer_cfg
*bpc
)
93 struct bfd_session
*bs
;
94 struct peer_label
*pl
;
97 /* Try to find label first. */
98 if (bpc
->bpc_has_label
) {
99 pl
= pl_find(bpc
->bpc_label
);
106 /* Otherwise fallback to peer/local hash lookup. */
107 gen_bfd_key(&key
, &bpc
->bpc_peer
, &bpc
->bpc_local
, bpc
->bpc_mhop
,
108 bpc
->bpc_localif
, bpc
->bpc_vrfname
);
110 return bfd_key_lookup(key
);
114 * Starts a disabled BFD session.
116 * A session is disabled when the specified interface/VRF doesn't exist
117 * yet. It might happen on FRR boot or with virtual interfaces.
119 int bfd_session_enable(struct bfd_session
*bs
)
121 struct interface
*ifp
= NULL
;
122 struct vrf
*vrf
= NULL
;
126 * If the interface or VRF doesn't exist, then we must register
127 * the session but delay its start.
129 if (bs
->key
.vrfname
[0]) {
130 vrf
= vrf_lookup_by_name(bs
->key
.vrfname
);
133 "session-enable: specified VRF doesn't exists.");
138 if (bs
->key
.ifname
[0]) {
140 ifp
= if_lookup_by_name(bs
->key
.ifname
, vrf
->vrf_id
);
142 ifp
= if_lookup_by_name_all_vrf(bs
->key
.ifname
);
145 "session-enable: specified interface doesn't exists.");
148 if (bs
->key
.ifname
[0] && !vrf
) {
149 vrf
= vrf_lookup_by_id(ifp
->vrf_id
);
152 "session-enable: specified VRF doesn't exists.");
158 /* Assign interface/VRF pointers. */
161 bs
->vrf
= vrf_lookup_by_id(VRF_DEFAULT
);
163 if (bs
->key
.ifname
[0]
164 && BFD_CHECK_FLAG(bs
->flags
, BFD_SESS_FLAG_MH
) == 0)
167 /* Sanity check: don't leak open sockets. */
168 if (bs
->sock
!= -1) {
169 log_debug("session-enable: previous socket open");
175 * Get socket for transmitting control packets. Note that if we
176 * could use the destination port (3784) for the source
177 * port we wouldn't need a socket per session.
179 if (BFD_CHECK_FLAG(bs
->flags
, BFD_SESS_FLAG_IPV6
) == 0) {
180 psock
= bp_peer_socket(bs
);
184 psock
= bp_peer_socketv6(bs
);
190 * We've got a valid socket, lets start the timers and the
194 bfd_recvtimer_update(bs
);
195 ptm_bfd_start_xmt_timer(bs
, false);
201 * Disabled a running BFD session.
203 * A session is disabled when the specified interface/VRF gets removed
204 * (e.g. virtual interfaces).
206 void bfd_session_disable(struct bfd_session
*bs
)
208 /* Free up socket resources. */
209 if (bs
->sock
!= -1) {
214 /* Disable all timers. */
215 bfd_recvtimer_delete(bs
);
216 bfd_xmttimer_delete(bs
);
217 ptm_bfd_echo_stop(bs
);
221 /* Set session down so it doesn't report UP and disabled. */
222 ptm_bfd_sess_dn(bs
, BD_PATH_DOWN
);
225 static uint32_t ptm_bfd_gen_ID(void)
230 * RFC 5880, Section 6.8.1. recommends that we should generate
231 * random session identification numbers.
234 session_id
= ((random() << 16) & 0xFFFF0000)
235 | (random() & 0x0000FFFF);
236 } while (session_id
== 0 || bfd_id_lookup(session_id
) != NULL
);
241 void ptm_bfd_start_xmt_timer(struct bfd_session
*bfd
, bool is_echo
)
243 uint64_t jitter
, xmt_TO
;
246 xmt_TO
= is_echo
? bfd
->echo_xmt_TO
: bfd
->xmt_TO
;
249 * From section 6.5.2: trasmit interval should be randomly jittered
251 * 75% and 100% of nominal value, unless detect_mult is 1, then should
253 * between 75% and 90%.
255 maxpercent
= (bfd
->detect_mult
== 1) ? 16 : 26;
256 jitter
= (xmt_TO
* (75 + (random() % maxpercent
))) / 100;
257 /* XXX remove that division above */
260 bfd_echo_xmttimer_update(bfd
, jitter
);
262 bfd_xmttimer_update(bfd
, jitter
);
265 static void ptm_bfd_echo_xmt_TO(struct bfd_session
*bfd
)
267 /* Send the scheduled echo packet */
268 ptm_bfd_echo_snd(bfd
);
270 /* Restart the timer for next time */
271 ptm_bfd_start_xmt_timer(bfd
, true);
274 void ptm_bfd_xmt_TO(struct bfd_session
*bfd
, int fbit
)
276 /* Send the scheduled control packet */
277 ptm_bfd_snd(bfd
, fbit
);
279 /* Restart the timer for next time */
280 ptm_bfd_start_xmt_timer(bfd
, false);
283 void ptm_bfd_echo_stop(struct bfd_session
*bfd
)
285 bfd
->echo_xmt_TO
= 0;
286 bfd
->echo_detect_TO
= 0;
287 BFD_UNSET_FLAG(bfd
->flags
, BFD_SESS_FLAG_ECHO_ACTIVE
);
289 bfd_echo_xmttimer_delete(bfd
);
290 bfd_echo_recvtimer_delete(bfd
);
293 void ptm_bfd_echo_start(struct bfd_session
*bfd
)
295 bfd
->echo_detect_TO
= (bfd
->remote_detect_mult
* bfd
->echo_xmt_TO
);
296 if (bfd
->echo_detect_TO
> 0)
297 ptm_bfd_echo_xmt_TO(bfd
);
300 void ptm_bfd_sess_up(struct bfd_session
*bfd
)
302 int old_state
= bfd
->ses_state
;
305 bfd
->ses_state
= PTM_BFD_UP
;
306 monotime(&bfd
->uptime
);
308 /* Connection is up, lets negotiate timers. */
309 bfd_set_polling(bfd
);
311 /* Start sending control packets with poll bit immediately. */
316 if (old_state
!= bfd
->ses_state
) {
317 bfd
->stats
.session_up
++;
318 log_info("state-change: [%s] %s -> %s", bs_to_string(bfd
),
319 state_list
[old_state
].str
,
320 state_list
[bfd
->ses_state
].str
);
324 void ptm_bfd_sess_dn(struct bfd_session
*bfd
, uint8_t diag
)
326 int old_state
= bfd
->ses_state
;
328 bfd
->local_diag
= diag
;
329 bfd
->discrs
.remote_discr
= 0;
330 bfd
->ses_state
= PTM_BFD_DOWN
;
332 bfd
->demand_mode
= 0;
333 monotime(&bfd
->downtime
);
336 * Only attempt to send if we have a valid socket:
337 * this function might be called by session disablers and in
338 * this case we won't have a valid socket (i.e. interface was
339 * removed or VRF doesn't exist anymore).
344 /* Slow down the control packets, the connection is down. */
345 bs_set_slow_timers(bfd
);
347 /* only signal clients when going from up->down state */
348 if (old_state
== PTM_BFD_UP
)
351 /* Stop echo packet transmission if they are active */
352 if (BFD_CHECK_FLAG(bfd
->flags
, BFD_SESS_FLAG_ECHO_ACTIVE
))
353 ptm_bfd_echo_stop(bfd
);
355 if (old_state
!= bfd
->ses_state
) {
356 bfd
->stats
.session_down
++;
357 log_info("state-change: [%s] %s -> %s reason:%s",
358 bs_to_string(bfd
), state_list
[old_state
].str
,
359 state_list
[bfd
->ses_state
].str
,
360 get_diag_str(bfd
->local_diag
));
364 static struct bfd_session
*bfd_find_disc(struct sockaddr_any
*sa
,
367 struct bfd_session
*bs
;
369 bs
= bfd_id_lookup(ldisc
);
373 switch (bs
->key
.family
) {
375 if (memcmp(&sa
->sa_sin
.sin_addr
, &bs
->key
.peer
,
376 sizeof(sa
->sa_sin
.sin_addr
)))
380 if (memcmp(&sa
->sa_sin6
.sin6_addr
, &bs
->key
.peer
,
381 sizeof(sa
->sa_sin6
.sin6_addr
)))
389 struct bfd_session
*ptm_bfd_sess_find(struct bfd_pkt
*cp
,
390 struct sockaddr_any
*peer
,
391 struct sockaddr_any
*local
,
392 ifindex_t ifindex
, vrf_id_t vrfid
,
395 struct interface
*ifp
;
399 /* Find our session using the ID signaled by the remote end. */
400 if (cp
->discrs
.remote_discr
)
401 return bfd_find_disc(peer
, ntohl(cp
->discrs
.remote_discr
));
403 /* Search for session without using discriminator. */
404 ifp
= if_lookup_by_index(ifindex
, vrfid
);
406 vrf
= vrf_lookup_by_id(vrfid
);
408 gen_bfd_key(&key
, peer
, local
, is_mhop
, ifp
? ifp
->name
: NULL
,
409 vrf
? vrf
->name
: VRF_DEFAULT_NAME
);
411 /* XXX maybe remoteDiscr should be checked for remoteHeard cases. */
412 return bfd_key_lookup(key
);
415 int bfd_xmt_cb(struct thread
*t
)
417 struct bfd_session
*bs
= THREAD_ARG(t
);
419 ptm_bfd_xmt_TO(bs
, 0);
424 int bfd_echo_xmt_cb(struct thread
*t
)
426 struct bfd_session
*bs
= THREAD_ARG(t
);
428 if (bs
->echo_xmt_TO
> 0)
429 ptm_bfd_echo_xmt_TO(bs
);
434 /* Was ptm_bfd_detect_TO() */
435 int bfd_recvtimer_cb(struct thread
*t
)
437 struct bfd_session
*bs
= THREAD_ARG(t
);
439 switch (bs
->ses_state
) {
442 ptm_bfd_sess_dn(bs
, BD_CONTROL_EXPIRED
);
443 bfd_recvtimer_update(bs
);
447 /* Second detect time expiration, zero remote discr (section
450 bs
->discrs
.remote_discr
= 0;
457 /* Was ptm_bfd_echo_detect_TO() */
458 int bfd_echo_recvtimer_cb(struct thread
*t
)
460 struct bfd_session
*bs
= THREAD_ARG(t
);
462 switch (bs
->ses_state
) {
465 ptm_bfd_sess_dn(bs
, BD_ECHO_FAILED
);
472 struct bfd_session
*bfd_session_new(void)
474 struct bfd_session
*bs
;
476 bs
= XCALLOC(MTYPE_BFDD_CONFIG
, sizeof(*bs
));
478 bs
->timers
.desired_min_tx
= BFD_DEFDESIREDMINTX
;
479 bs
->timers
.required_min_rx
= BFD_DEFREQUIREDMINRX
;
480 bs
->timers
.required_min_echo
= BFD_DEF_REQ_MIN_ECHO
;
481 bs
->detect_mult
= BFD_DEFDETECTMULT
;
482 bs
->mh_ttl
= BFD_DEF_MHOP_TTL
;
483 bs
->ses_state
= PTM_BFD_DOWN
;
485 /* Initiate connection with slow timers. */
486 bs_set_slow_timers(bs
);
488 /* Initiate remote settings as well. */
489 bs
->remote_timers
= bs
->cur_timers
;
490 bs
->remote_detect_mult
= BFD_DEFDETECTMULT
;
493 monotime(&bs
->uptime
);
494 bs
->downtime
= bs
->uptime
;
499 int bfd_session_update_label(struct bfd_session
*bs
, const char *nlabel
)
501 /* New label treatment:
502 * - Check if the label is taken;
503 * - Try to allocate the memory for it and register;
505 if (bs
->pl
== NULL
) {
506 if (pl_find(nlabel
) != NULL
) {
507 /* Someone is already using it. */
511 if (pl_new(nlabel
, bs
) == NULL
)
518 * Test label change consistency:
519 * - Do nothing if it's the same label;
520 * - Check if the future label is already taken;
523 if (strcmp(nlabel
, bs
->pl
->pl_label
) == 0)
525 if (pl_find(nlabel
) != NULL
)
528 strlcpy(bs
->pl
->pl_label
, nlabel
, sizeof(bs
->pl
->pl_label
));
532 static void _bfd_session_update(struct bfd_session
*bs
,
533 struct bfd_peer_cfg
*bpc
)
536 /* Check if echo mode is already active. */
537 if (BFD_CHECK_FLAG(bs
->flags
, BFD_SESS_FLAG_ECHO
))
540 BFD_SET_FLAG(bs
->flags
, BFD_SESS_FLAG_ECHO
);
542 /* Activate/update echo receive timeout timer. */
543 bs_echo_timer_handler(bs
);
545 /* Check if echo mode is already disabled. */
546 if (!BFD_CHECK_FLAG(bs
->flags
, BFD_SESS_FLAG_ECHO
))
549 BFD_UNSET_FLAG(bs
->flags
, BFD_SESS_FLAG_ECHO
);
550 ptm_bfd_echo_stop(bs
);
554 if (bpc
->bpc_has_txinterval
)
555 bs
->timers
.desired_min_tx
= bpc
->bpc_txinterval
* 1000;
557 if (bpc
->bpc_has_recvinterval
)
558 bs
->timers
.required_min_rx
= bpc
->bpc_recvinterval
* 1000;
560 if (bpc
->bpc_has_detectmultiplier
)
561 bs
->detect_mult
= bpc
->bpc_detectmultiplier
;
563 if (bpc
->bpc_has_echointerval
)
564 bs
->timers
.required_min_echo
= bpc
->bpc_echointerval
* 1000;
566 if (bpc
->bpc_has_label
)
567 bfd_session_update_label(bs
, bpc
->bpc_label
);
569 if (bpc
->bpc_shutdown
) {
570 /* Check if already shutdown. */
571 if (BFD_CHECK_FLAG(bs
->flags
, BFD_SESS_FLAG_SHUTDOWN
))
574 BFD_SET_FLAG(bs
->flags
, BFD_SESS_FLAG_SHUTDOWN
);
576 /* Disable all events. */
577 bfd_recvtimer_delete(bs
);
578 bfd_echo_recvtimer_delete(bs
);
579 bfd_xmttimer_delete(bs
);
580 bfd_echo_xmttimer_delete(bs
);
582 /* Change and notify state change. */
583 bs
->ses_state
= PTM_BFD_ADM_DOWN
;
586 /* Don't try to send packets with a disabled session. */
590 /* Check if already working. */
591 if (!BFD_CHECK_FLAG(bs
->flags
, BFD_SESS_FLAG_SHUTDOWN
))
594 BFD_UNSET_FLAG(bs
->flags
, BFD_SESS_FLAG_SHUTDOWN
);
596 /* Change and notify state change. */
597 bs
->ses_state
= PTM_BFD_DOWN
;
600 /* Enable all timers. */
601 bfd_recvtimer_update(bs
);
602 bfd_xmttimer_update(bs
, bs
->xmt_TO
);
605 if (BFD_CHECK_FLAG(bs
->flags
, BFD_SESS_FLAG_CBIT
))
608 BFD_SET_FLAG(bs
->flags
, BFD_SESS_FLAG_CBIT
);
610 if (!BFD_CHECK_FLAG(bs
->flags
, BFD_SESS_FLAG_CBIT
))
613 BFD_UNSET_FLAG(bs
->flags
, BFD_SESS_FLAG_CBIT
);
617 static int bfd_session_update(struct bfd_session
*bs
, struct bfd_peer_cfg
*bpc
)
619 /* User didn't want to update, return failure. */
620 if (bpc
->bpc_createonly
)
623 _bfd_session_update(bs
, bpc
);
625 control_notify_config(BCM_NOTIFY_CONFIG_UPDATE
, bs
);
630 void bfd_session_free(struct bfd_session
*bs
)
632 struct bfd_session_observer
*bso
;
634 bfd_session_disable(bs
);
636 bfd_key_delete(bs
->key
);
637 bfd_id_delete(bs
->discrs
.my_discr
);
639 /* Remove observer if any. */
640 TAILQ_FOREACH(bso
, &bglobal
.bg_obslist
, bso_entry
) {
641 if (bso
->bso_bs
!= bs
)
647 bs_observer_del(bso
);
651 XFREE(MTYPE_BFDD_CONFIG
, bs
);
654 struct bfd_session
*ptm_bfd_sess_new(struct bfd_peer_cfg
*bpc
)
656 struct bfd_session
*bfd
, *l_bfd
;
658 /* check to see if this needs a new session */
659 l_bfd
= bs_peer_find(bpc
);
661 /* Requesting a duplicated peer means update configuration. */
662 if (bfd_session_update(l_bfd
, bpc
) == 0)
668 /* Get BFD session storage with its defaults. */
669 bfd
= bfd_session_new();
671 log_error("session-new: allocation failed");
676 * Store interface/VRF name in case we need to delay session
677 * start. See `bfd_session_enable` for more information.
679 if (bpc
->bpc_has_localif
)
680 strlcpy(bfd
->key
.ifname
, bpc
->bpc_localif
,
681 sizeof(bfd
->key
.ifname
));
683 if (bpc
->bpc_has_vrfname
)
684 strlcpy(bfd
->key
.vrfname
, bpc
->bpc_vrfname
,
685 sizeof(bfd
->key
.vrfname
));
687 strlcpy(bfd
->key
.vrfname
, VRF_DEFAULT_NAME
,
688 sizeof(bfd
->key
.vrfname
));
690 /* Copy remaining data. */
691 if (bpc
->bpc_ipv4
== false)
692 BFD_SET_FLAG(bfd
->flags
, BFD_SESS_FLAG_IPV6
);
694 bfd
->key
.family
= (bpc
->bpc_ipv4
) ? AF_INET
: AF_INET6
;
695 switch (bfd
->key
.family
) {
697 memcpy(&bfd
->key
.peer
, &bpc
->bpc_peer
.sa_sin
.sin_addr
,
698 sizeof(bpc
->bpc_peer
.sa_sin
.sin_addr
));
699 memcpy(&bfd
->key
.local
, &bpc
->bpc_local
.sa_sin
.sin_addr
,
700 sizeof(bpc
->bpc_local
.sa_sin
.sin_addr
));
704 memcpy(&bfd
->key
.peer
, &bpc
->bpc_peer
.sa_sin6
.sin6_addr
,
705 sizeof(bpc
->bpc_peer
.sa_sin6
.sin6_addr
));
706 memcpy(&bfd
->key
.local
, &bpc
->bpc_local
.sa_sin6
.sin6_addr
,
707 sizeof(bpc
->bpc_local
.sa_sin6
.sin6_addr
));
716 BFD_SET_FLAG(bfd
->flags
, BFD_SESS_FLAG_MH
);
718 bfd
->key
.mhop
= bpc
->bpc_mhop
;
720 if (bs_registrate(bfd
) == NULL
)
723 /* Apply other configurations. */
724 _bfd_session_update(bfd
, bpc
);
729 struct bfd_session
*bs_registrate(struct bfd_session
*bfd
)
731 /* Registrate session into data structures. */
733 bfd
->discrs
.my_discr
= ptm_bfd_gen_ID();
736 /* Try to enable session and schedule for packet receive/send. */
737 if (bfd_session_enable(bfd
) == -1) {
738 /* Unrecoverable failure, remove the session/peer. */
739 bfd_session_free(bfd
);
743 /* Add observer if we have moving parts. */
744 if (bfd
->key
.ifname
[0] || bfd
->key
.vrfname
[0] || bfd
->sock
== -1)
745 bs_observer_add(bfd
);
747 log_info("session-new: %s", bs_to_string(bfd
));
749 control_notify_config(BCM_NOTIFY_CONFIG_ADD
, bfd
);
754 int ptm_bfd_sess_del(struct bfd_peer_cfg
*bpc
)
756 struct bfd_session
*bs
;
758 /* Find session and call free(). */
759 bs
= bs_peer_find(bpc
);
763 /* This pointer is being referenced, don't let it be deleted. */
764 if (bs
->refcount
> 0) {
765 log_error("session-delete: refcount failure: %" PRIu64
771 log_info("session-delete: %s", bs_to_string(bs
));
773 control_notify_config(BCM_NOTIFY_CONFIG_DELETE
, bs
);
775 bfd_session_free(bs
);
780 void bfd_set_polling(struct bfd_session
*bs
)
783 * Start polling procedure: the only timers that require polling
784 * to change value without losing connection are:
786 * - Desired minimum transmission interval;
787 * - Required minimum receive interval;
789 * RFC 5880, Section 6.8.3.
795 * bs_<state>_handler() functions implement the BFD state machine
796 * transition mechanism. `<state>` is the current session state and
797 * the parameter `nstate` is the peer new state.
799 static void bs_admin_down_handler(struct bfd_session
*bs
800 __attribute__((__unused__
)),
801 int nstate
__attribute__((__unused__
)))
804 * We are administratively down, there is no state machine
809 static void bs_down_handler(struct bfd_session
*bs
, int nstate
)
812 case PTM_BFD_ADM_DOWN
:
814 * Remote peer doesn't want to talk, so lets keep the
818 /* Peer can't be up yet, wait it go to 'init' or 'down'. */
823 * Remote peer agreed that the path is down, lets try to
826 bs
->ses_state
= PTM_BFD_INIT
;
831 * Remote peer told us his path is up, lets turn
832 * activate the session.
838 log_debug("state-change: unhandled neighbor state: %d", nstate
);
843 static void bs_init_handler(struct bfd_session
*bs
, int nstate
)
846 case PTM_BFD_ADM_DOWN
:
848 * Remote peer doesn't want to talk, so lets make the
851 bs
->ses_state
= PTM_BFD_DOWN
;
855 /* Remote peer hasn't moved to first stage yet. */
860 /* We agreed on the settings and the path is up. */
865 log_debug("state-change: unhandled neighbor state: %d", nstate
);
870 static void bs_up_handler(struct bfd_session
*bs
, int nstate
)
873 case PTM_BFD_ADM_DOWN
:
875 /* Peer lost or asked to shutdown connection. */
876 ptm_bfd_sess_dn(bs
, BD_NEIGHBOR_DOWN
);
881 /* Path is up and working. */
885 log_debug("state-change: unhandled neighbor state: %d", nstate
);
890 void bs_state_handler(struct bfd_session
*bs
, int nstate
)
892 switch (bs
->ses_state
) {
893 case PTM_BFD_ADM_DOWN
:
894 bs_admin_down_handler(bs
, nstate
);
897 bs_down_handler(bs
, nstate
);
900 bs_init_handler(bs
, nstate
);
903 bs_up_handler(bs
, nstate
);
907 log_debug("state-change: [%s] is in invalid state: %d",
908 bs_to_string(bs
), nstate
);
914 * Handles echo timer manipulation after updating timer.
916 void bs_echo_timer_handler(struct bfd_session
*bs
)
921 * Before doing any echo handling, check if it is possible to
924 * - Check for `echo-mode` configuration.
925 * - Check that we are not using multi hop (RFC 5883,
927 * - Check that we are already at the up state.
929 if (BFD_CHECK_FLAG(bs
->flags
, BFD_SESS_FLAG_ECHO
) == 0
930 || BFD_CHECK_FLAG(bs
->flags
, BFD_SESS_FLAG_MH
)
931 || bs
->ses_state
!= PTM_BFD_UP
)
934 /* Remote peer asked to stop echo. */
935 if (bs
->remote_timers
.required_min_echo
== 0) {
936 if (BFD_CHECK_FLAG(bs
->flags
, BFD_SESS_FLAG_ECHO_ACTIVE
))
937 ptm_bfd_echo_stop(bs
);
943 * Calculate the echo transmission timer: we must not send
944 * echo packets faster than the minimum required time
945 * announced by the remote system.
947 * RFC 5880, Section 6.8.9.
949 old_timer
= bs
->echo_xmt_TO
;
950 if (bs
->remote_timers
.required_min_echo
> bs
->timers
.required_min_echo
)
951 bs
->echo_xmt_TO
= bs
->remote_timers
.required_min_echo
;
953 bs
->echo_xmt_TO
= bs
->timers
.required_min_echo
;
955 if (BFD_CHECK_FLAG(bs
->flags
, BFD_SESS_FLAG_ECHO_ACTIVE
) == 0
956 || old_timer
!= bs
->echo_xmt_TO
)
957 ptm_bfd_echo_start(bs
);
961 * RFC 5880 Section 6.5.
963 * When a BFD control packet with the final bit is received, we must
964 * update the session parameters.
966 void bs_final_handler(struct bfd_session
*bs
)
968 /* Start using our new timers. */
969 bs
->cur_timers
.desired_min_tx
= bs
->timers
.desired_min_tx
;
970 bs
->cur_timers
.required_min_rx
= bs
->timers
.required_min_rx
;
973 * TODO: demand mode. See RFC 5880 Section 6.1.
975 * When using demand mode we must disable the detection timer
976 * for lost control packets.
978 if (bs
->demand_mode
) {
979 /* Notify watchers about changed timers. */
980 control_notify_config(BCM_NOTIFY_CONFIG_UPDATE
, bs
);
985 * Calculate detection time based on new timers.
987 * Transmission calculation:
988 * We must respect the RequiredMinRxInterval from the remote
989 * system: if our desired transmission timer is more than the
990 * minimum receive rate, then we must lower it to at least the
991 * minimum receive interval.
993 * RFC 5880, Section 6.8.3.
995 if (bs
->timers
.desired_min_tx
> bs
->remote_timers
.required_min_rx
)
996 bs
->xmt_TO
= bs
->remote_timers
.required_min_rx
;
998 bs
->xmt_TO
= bs
->timers
.desired_min_tx
;
1000 /* Apply new transmission timer immediately. */
1001 ptm_bfd_start_xmt_timer(bs
, false);
1004 * Detection timeout calculation:
1005 * The minimum detection timeout is the remote detection
1006 * multipler (number of packets to be missed) times the agreed
1007 * transmission interval.
1009 * RFC 5880, Section 6.8.4.
1011 * TODO: support sending/counting more packets inside detection
1014 if (bs
->remote_timers
.required_min_rx
> bs
->timers
.desired_min_tx
)
1015 bs
->detect_TO
= bs
->remote_detect_mult
1016 * bs
->remote_timers
.required_min_rx
;
1018 bs
->detect_TO
= bs
->remote_detect_mult
1019 * bs
->timers
.desired_min_tx
;
1021 /* Apply new receive timer immediately. */
1022 bfd_recvtimer_update(bs
);
1024 /* Notify watchers about changed timers. */
1025 control_notify_config(BCM_NOTIFY_CONFIG_UPDATE
, bs
);
1028 void bs_set_slow_timers(struct bfd_session
*bs
)
1031 * BFD connection must use slow timers before going up or after
1032 * losing connectivity to avoid wasting bandwidth.
1034 * RFC 5880, Section 6.8.3.
1036 bs
->cur_timers
.desired_min_tx
= BFD_DEF_SLOWTX
;
1037 bs
->cur_timers
.required_min_rx
= BFD_DEF_SLOWTX
;
1038 bs
->cur_timers
.required_min_echo
= 0;
1040 /* Set the appropriated timeouts for slow connection. */
1041 bs
->detect_TO
= (BFD_DEFDETECTMULT
* BFD_DEF_SLOWTX
);
1042 bs
->xmt_TO
= BFD_DEF_SLOWTX
;
1048 static const char *get_diag_str(int diag
)
1050 for (int i
= 0; diag_list
[i
].str
; i
++) {
1051 if (diag_list
[i
].type
== diag
)
1052 return diag_list
[i
].str
;
1057 const char *satostr(struct sockaddr_any
*sa
)
1059 #define INETSTR_BUFCOUNT 8
1060 static char buf
[INETSTR_BUFCOUNT
][INET6_ADDRSTRLEN
];
1062 struct sockaddr_in
*sin
= &sa
->sa_sin
;
1063 struct sockaddr_in6
*sin6
= &sa
->sa_sin6
;
1065 bufidx
+= (bufidx
+ 1) % INETSTR_BUFCOUNT
;
1068 switch (sin
->sin_family
) {
1070 inet_ntop(AF_INET
, &sin
->sin_addr
, buf
[bufidx
],
1071 sizeof(buf
[bufidx
]));
1074 inet_ntop(AF_INET6
, &sin6
->sin6_addr
, buf
[bufidx
],
1075 sizeof(buf
[bufidx
]));
1079 strlcpy(buf
[bufidx
], "unknown", sizeof(buf
[bufidx
]));
1086 const char *diag2str(uint8_t diag
)
1092 return "control detection time expired";
1094 return "echo function failed";
1096 return "neighbor signaled session down";
1098 return "forwarding plane reset";
1102 return "concatenated path down";
1104 return "administratively down";
1106 return "reverse concatenated path down";
1112 int strtosa(const char *addr
, struct sockaddr_any
*sa
)
1114 memset(sa
, 0, sizeof(*sa
));
1116 if (inet_pton(AF_INET
, addr
, &sa
->sa_sin
.sin_addr
) == 1) {
1117 sa
->sa_sin
.sin_family
= AF_INET
;
1118 #ifdef HAVE_STRUCT_SOCKADDR_SA_LEN
1119 sa
->sa_sin
.sin_len
= sizeof(sa
->sa_sin
);
1120 #endif /* HAVE_STRUCT_SOCKADDR_SA_LEN */
1124 if (inet_pton(AF_INET6
, addr
, &sa
->sa_sin6
.sin6_addr
) == 1) {
1125 sa
->sa_sin6
.sin6_family
= AF_INET6
;
1126 #ifdef HAVE_STRUCT_SOCKADDR_SA_LEN
1127 sa
->sa_sin6
.sin6_len
= sizeof(sa
->sa_sin6
);
1128 #endif /* HAVE_STRUCT_SOCKADDR_SA_LEN */
1135 void integer2timestr(uint64_t time
, char *buf
, size_t buflen
)
1137 unsigned int year
, month
, day
, hour
, minute
, second
;
1140 #define MINUTES (60)
1141 #define HOURS (60 * MINUTES)
1142 #define DAYS (24 * HOURS)
1143 #define MONTHS (30 * DAYS)
1144 #define YEARS (12 * MONTHS)
1145 if (time
>= YEARS
) {
1146 year
= time
/ YEARS
;
1147 time
-= year
* YEARS
;
1149 rv
= snprintf(buf
, buflen
, "%u year(s), ", year
);
1153 if (time
>= MONTHS
) {
1154 month
= time
/ MONTHS
;
1155 time
-= month
* MONTHS
;
1157 rv
= snprintf(buf
, buflen
, "%u month(s), ", month
);
1165 rv
= snprintf(buf
, buflen
, "%u day(s), ", day
);
1169 if (time
>= HOURS
) {
1170 hour
= time
/ HOURS
;
1171 time
-= hour
* HOURS
;
1173 rv
= snprintf(buf
, buflen
, "%u hour(s), ", hour
);
1177 if (time
>= MINUTES
) {
1178 minute
= time
/ MINUTES
;
1179 time
-= minute
* MINUTES
;
1181 rv
= snprintf(buf
, buflen
, "%u minute(s), ", minute
);
1185 second
= time
% MINUTES
;
1186 snprintf(buf
, buflen
, "%u second(s)", second
);
1189 const char *bs_to_string(const struct bfd_session
*bs
)
1191 static char buf
[256];
1192 char addr_buf
[INET6_ADDRSTRLEN
];
1194 bool is_mhop
= BFD_CHECK_FLAG(bs
->flags
, BFD_SESS_FLAG_MH
);
1196 pos
= snprintf(buf
, sizeof(buf
), "mhop:%s", is_mhop
? "yes" : "no");
1197 pos
+= snprintf(buf
+ pos
, sizeof(buf
) - pos
, " peer:%s",
1198 inet_ntop(bs
->key
.family
, &bs
->key
.peer
, addr_buf
,
1200 pos
+= snprintf(buf
+ pos
, sizeof(buf
) - pos
, " local:%s",
1201 inet_ntop(bs
->key
.family
, &bs
->key
.local
, addr_buf
,
1203 if (bs
->key
.vrfname
[0])
1204 pos
+= snprintf(buf
+ pos
, sizeof(buf
) - pos
, " vrf:%s",
1206 if (bs
->key
.ifname
[0])
1207 pos
+= snprintf(buf
+ pos
, sizeof(buf
) - pos
, " ifname:%s",
1215 int bs_observer_add(struct bfd_session
*bs
)
1217 struct bfd_session_observer
*bso
;
1219 bso
= XCALLOC(MTYPE_BFDD_SESSION_OBSERVER
, sizeof(*bso
));
1221 bso
->bso_addr
.family
= bs
->key
.family
;
1222 memcpy(&bso
->bso_addr
.u
.prefix
, &bs
->key
.local
,
1223 sizeof(bs
->key
.local
));
1225 TAILQ_INSERT_TAIL(&bglobal
.bg_obslist
, bso
, bso_entry
);
1230 void bs_observer_del(struct bfd_session_observer
*bso
)
1232 TAILQ_REMOVE(&bglobal
.bg_obslist
, bso
, bso_entry
);
1233 XFREE(MTYPE_BFDD_SESSION_OBSERVER
, bso
);
1236 void bs_to_bpc(struct bfd_session
*bs
, struct bfd_peer_cfg
*bpc
)
1238 memset(bpc
, 0, sizeof(*bpc
));
1240 bpc
->bpc_ipv4
= (bs
->key
.family
== AF_INET
);
1241 bpc
->bpc_mhop
= bs
->key
.mhop
;
1243 switch (bs
->key
.family
) {
1245 bpc
->bpc_peer
.sa_sin
.sin_family
= AF_INET
;
1246 memcpy(&bpc
->bpc_peer
.sa_sin
.sin_addr
, &bs
->key
.peer
,
1247 sizeof(bpc
->bpc_peer
.sa_sin
.sin_addr
));
1249 if (memcmp(&bs
->key
.local
, &zero_addr
, sizeof(bs
->key
.local
))) {
1250 bpc
->bpc_local
.sa_sin
.sin_family
= AF_INET6
;
1251 memcpy(&bpc
->bpc_local
.sa_sin
.sin_addr
, &bs
->key
.local
,
1252 sizeof(bpc
->bpc_local
.sa_sin
.sin_addr
));
1257 bpc
->bpc_peer
.sa_sin
.sin_family
= AF_INET6
;
1258 memcpy(&bpc
->bpc_peer
.sa_sin6
.sin6_addr
, &bs
->key
.peer
,
1259 sizeof(bpc
->bpc_peer
.sa_sin6
.sin6_addr
));
1261 bpc
->bpc_local
.sa_sin6
.sin6_family
= AF_INET6
;
1262 memcpy(&bpc
->bpc_local
.sa_sin6
.sin6_addr
, &bs
->key
.local
,
1263 sizeof(bpc
->bpc_local
.sa_sin6
.sin6_addr
));
1267 if (bs
->key
.ifname
[0]) {
1268 bpc
->bpc_has_localif
= true;
1269 strlcpy(bpc
->bpc_localif
, bs
->key
.ifname
,
1270 sizeof(bpc
->bpc_localif
));
1273 if (bs
->key
.vrfname
[0]) {
1274 bpc
->bpc_has_vrfname
= true;
1275 strlcpy(bpc
->bpc_vrfname
, bs
->key
.vrfname
,
1276 sizeof(bpc
->bpc_vrfname
));
1282 * BFD hash data structures to find sessions.
1284 static struct hash
*bfd_id_hash
;
1285 static struct hash
*bfd_key_hash
;
1287 static unsigned int bfd_id_hash_do(const void *p
);
1288 static unsigned int bfd_key_hash_do(const void *p
);
1290 static void _bfd_free(struct hash_bucket
*hb
,
1291 void *arg
__attribute__((__unused__
)));
1293 /* BFD hash for our discriminator. */
1294 static unsigned int bfd_id_hash_do(const void *p
)
1296 const struct bfd_session
*bs
= p
;
1298 return jhash_1word(bs
->discrs
.my_discr
, 0);
1301 static bool bfd_id_hash_cmp(const void *n1
, const void *n2
)
1303 const struct bfd_session
*bs1
= n1
, *bs2
= n2
;
1305 return bs1
->discrs
.my_discr
== bs2
->discrs
.my_discr
;
1308 /* BFD hash for single hop. */
1309 static unsigned int bfd_key_hash_do(const void *p
)
1311 const struct bfd_session
*bs
= p
;
1313 return jhash(&bs
->key
, sizeof(bs
->key
), 0);
1316 static bool bfd_key_hash_cmp(const void *n1
, const void *n2
)
1318 const struct bfd_session
*bs1
= n1
, *bs2
= n2
;
1320 return memcmp(&bs1
->key
, &bs2
->key
, sizeof(bs1
->key
)) == 0;
1325 * Hash public interface / exported functions.
1328 /* Lookup functions. */
1329 struct bfd_session
*bfd_id_lookup(uint32_t id
)
1331 struct bfd_session bs
;
1333 bs
.discrs
.my_discr
= id
;
1335 return hash_lookup(bfd_id_hash
, &bs
);
1338 struct bfd_key_walk_partial_lookup
{
1339 struct bfd_session
*given
;
1340 struct bfd_session
*result
;
1343 /* ignore some parameters */
1344 static int bfd_key_lookup_ignore_partial_walker(struct hash_bucket
*b
,
1347 struct bfd_key_walk_partial_lookup
*ctx
=
1348 (struct bfd_key_walk_partial_lookup
*)data
;
1349 struct bfd_session
*given
= ctx
->given
;
1350 struct bfd_session
*parsed
= b
->data
;
1352 if (given
->key
.family
!= parsed
->key
.family
)
1353 return HASHWALK_CONTINUE
;
1354 if (given
->key
.mhop
!= parsed
->key
.mhop
)
1355 return HASHWALK_CONTINUE
;
1356 if (memcmp(&given
->key
.peer
, &parsed
->key
.peer
,
1357 sizeof(struct in6_addr
)))
1358 return HASHWALK_CONTINUE
;
1359 if (memcmp(given
->key
.vrfname
, parsed
->key
.vrfname
, MAXNAMELEN
))
1360 return HASHWALK_CONTINUE
;
1361 ctx
->result
= parsed
;
1362 /* ignore localaddr or interface */
1363 return HASHWALK_ABORT
;
1366 struct bfd_session
*bfd_key_lookup(struct bfd_key key
)
1368 struct bfd_session bs
, *bsp
;
1369 struct bfd_key_walk_partial_lookup ctx
;
1370 char peer_buf
[INET6_ADDRSTRLEN
];
1373 bsp
= hash_lookup(bfd_key_hash
, &bs
);
1377 inet_ntop(bs
.key
.family
, &bs
.key
.peer
, peer_buf
,
1379 /* Handle cases where local-address is optional. */
1380 if (bs
.key
.family
== AF_INET
) {
1381 memset(&bs
.key
.local
, 0, sizeof(bs
.key
.local
));
1382 bsp
= hash_lookup(bfd_key_hash
, &bs
);
1384 char addr_buf
[INET6_ADDRSTRLEN
];
1386 inet_ntop(bs
.key
.family
, &key
.local
, addr_buf
,
1388 log_debug(" peer %s found, but loc-addr %s ignored",
1389 peer_buf
, addr_buf
);
1395 /* Handle cases where ifname is optional. */
1396 if (bs
.key
.ifname
[0]) {
1397 memset(bs
.key
.ifname
, 0, sizeof(bs
.key
.ifname
));
1398 bsp
= hash_lookup(bfd_key_hash
, &bs
);
1400 log_debug(" peer %s found, but ifp %s ignored",
1401 peer_buf
, key
.ifname
);
1406 /* Handle cases where local-address and ifname are optional. */
1407 if (bs
.key
.family
== AF_INET
) {
1408 memset(&bs
.key
.local
, 0, sizeof(bs
.key
.local
));
1409 bsp
= hash_lookup(bfd_key_hash
, &bs
);
1411 char addr_buf
[INET6_ADDRSTRLEN
];
1413 inet_ntop(bs
.key
.family
, &bs
.key
.local
, addr_buf
,
1415 log_debug(" peer %s found, but ifp %s"
1416 " and loc-addr %s ignored",
1417 peer_buf
, key
.ifname
,
1424 /* Handle case where a context more complex ctx is present.
1425 * input has no iface nor local-address, but a context may
1430 hash_walk(bfd_key_hash
,
1431 &bfd_key_lookup_ignore_partial_walker
,
1436 log_debug(" peer %s found, but ifp"
1437 " and/or loc-addr params ignored", peer_buf
);
1445 * Delete functions searches and remove the item from the hash and
1446 * returns a pointer to the removed item data. If the item was not found
1447 * then it returns NULL.
1449 * The data stored inside the hash is not free()ed, so you must do it
1450 * manually after getting the pointer back.
1452 struct bfd_session
*bfd_id_delete(uint32_t id
)
1454 struct bfd_session bs
;
1456 bs
.discrs
.my_discr
= id
;
1458 return hash_release(bfd_id_hash
, &bs
);
1461 struct bfd_session
*bfd_key_delete(struct bfd_key key
)
1463 struct bfd_session bs
, *bsp
;
1466 bsp
= hash_lookup(bfd_key_hash
, &bs
);
1467 if (bsp
== NULL
&& key
.ifname
[0]) {
1468 memset(bs
.key
.ifname
, 0, sizeof(bs
.key
.ifname
));
1469 bsp
= hash_lookup(bfd_key_hash
, &bs
);
1472 return hash_release(bfd_key_hash
, bsp
);
1475 /* Iteration functions. */
1476 void bfd_id_iterate(hash_iter_func hif
, void *arg
)
1478 hash_iterate(bfd_id_hash
, hif
, arg
);
1481 void bfd_key_iterate(hash_iter_func hif
, void *arg
)
1483 hash_iterate(bfd_key_hash
, hif
, arg
);
1489 * Inserts session into hash and returns `true` on success, otherwise
1492 bool bfd_id_insert(struct bfd_session
*bs
)
1494 return (hash_get(bfd_id_hash
, bs
, hash_alloc_intern
) == bs
);
1497 bool bfd_key_insert(struct bfd_session
*bs
)
1499 return (hash_get(bfd_key_hash
, bs
, hash_alloc_intern
) == bs
);
1502 void bfd_initialize(void)
1504 bfd_id_hash
= hash_create(bfd_id_hash_do
, bfd_id_hash_cmp
,
1505 "BFD session discriminator hash");
1506 bfd_key_hash
= hash_create(bfd_key_hash_do
, bfd_key_hash_cmp
,
1507 "BFD session hash");
1510 static void _bfd_free(struct hash_bucket
*hb
,
1511 void *arg
__attribute__((__unused__
)))
1513 struct bfd_session
*bs
= hb
->data
;
1515 bfd_session_free(bs
);
1518 void bfd_shutdown(void)
1521 * Close and free all BFD sessions.
1523 * _bfd_free() will call bfd_session_free() which will take care
1524 * of removing the session from all hashes, so we just run an
1525 * assert() here to make sure it really happened.
1527 bfd_id_iterate(_bfd_free
, NULL
);
1528 assert(bfd_key_hash
->count
== 0);
1530 /* Now free the hashes themselves. */
1531 hash_free(bfd_id_hash
);
1532 hash_free(bfd_key_hash
);
1535 struct bfd_session_iterator
{
1538 const struct bfd_session
*bsi_bs
;
1541 static int _bfd_session_next(struct hash_bucket
*hb
, void *arg
)
1543 struct bfd_session_iterator
*bsi
= arg
;
1544 struct bfd_session
*bs
= hb
->data
;
1546 /* Previous entry signaled stop. */
1547 if (bsi
->bsi_stop
== 1) {
1548 /* Match the single/multi hop sessions. */
1549 if (bs
->key
.mhop
!= bsi
->bsi_mhop
)
1550 return HASHWALK_CONTINUE
;
1553 return HASHWALK_ABORT
;
1556 /* We found the current item, stop in the next one. */
1557 if (bsi
->bsi_bs
== hb
->data
) {
1559 /* Set entry to NULL to signal end of list. */
1561 } else if (bsi
->bsi_bs
== NULL
&& bsi
->bsi_mhop
== bs
->key
.mhop
) {
1562 /* We want the first list item. */
1564 bsi
->bsi_bs
= hb
->data
;
1565 return HASHWALK_ABORT
;
1568 return HASHWALK_CONTINUE
;
1572 * bfd_session_next: uses the current session to find the next.
1574 * `bs` might point to NULL to get the first item of the data structure.
1576 const struct bfd_session
*bfd_session_next(const struct bfd_session
*bs
,
1579 struct bfd_session_iterator bsi
;
1583 bsi
.bsi_mhop
= mhop
;
1584 hash_walk(bfd_key_hash
, _bfd_session_next
, &bsi
);
1585 if (bsi
.bsi_stop
== 0)
1591 static void _bfd_session_remove_manual(struct hash_bucket
*hb
,
1592 void *arg
__attribute__((__unused__
)))
1594 struct bfd_session
*bs
= hb
->data
;
1596 /* Delete only manually configured sessions. */
1597 if (BFD_CHECK_FLAG(bs
->flags
, BFD_SESS_FLAG_CONFIG
) == 0)
1601 BFD_UNSET_FLAG(bs
->flags
, BFD_SESS_FLAG_CONFIG
);
1603 /* Don't delete sessions still in use. */
1604 if (bs
->refcount
!= 0)
1607 bfd_session_free(bs
);
1611 * bfd_sessions_remove_manual: remove all manually configured sessions.
1613 * NOTE: this function doesn't remove automatically created sessions.
1615 void bfd_sessions_remove_manual(void)
1617 hash_iterate(bfd_key_hash
, _bfd_session_remove_manual
, NULL
);
1621 * VRF related functions.
1623 static int bfd_vrf_new(struct vrf
*vrf
)
1625 log_debug("VRF Created: %s(%u)", vrf
->name
, vrf
->vrf_id
);
1629 static int bfd_vrf_delete(struct vrf
*vrf
)
1631 log_debug("VRF Deletion: %s(%u)", vrf
->name
, vrf
->vrf_id
);
1635 static int bfd_vrf_update(struct vrf
*vrf
)
1637 if (!vrf_is_enabled(vrf
))
1639 log_debug("VRF update: %s(%u)", vrf
->name
, vrf
->vrf_id
);
1640 /* a different name is given; update bfd list */
1641 bfdd_sessions_enable_vrf(vrf
);
1645 static int bfd_vrf_enable(struct vrf
*vrf
)
1647 struct bfd_vrf_global
*bvrf
;
1649 /* a different name */
1651 bvrf
= XCALLOC(MTYPE_BFDD_VRF
, sizeof(struct bfd_vrf_global
));
1653 vrf
->info
= (void *)bvrf
;
1656 log_debug("VRF enable add %s id %u", vrf
->name
, vrf
->vrf_id
);
1657 if (vrf
->vrf_id
== VRF_DEFAULT
||
1658 vrf_get_backend() == VRF_BACKEND_NETNS
) {
1660 bvrf
->bg_shop
= bp_udp_shop(vrf
->vrf_id
);
1662 bvrf
->bg_mhop
= bp_udp_mhop(vrf
->vrf_id
);
1663 if (!bvrf
->bg_shop6
)
1664 bvrf
->bg_shop6
= bp_udp6_shop(vrf
->vrf_id
);
1665 if (!bvrf
->bg_mhop6
)
1666 bvrf
->bg_mhop6
= bp_udp6_mhop(vrf
->vrf_id
);
1668 bvrf
->bg_echo
= bp_echo_socket(vrf
->vrf_id
);
1669 if (!bvrf
->bg_echov6
)
1670 bvrf
->bg_echov6
= bp_echov6_socket(vrf
->vrf_id
);
1672 /* Add descriptors to the event loop. */
1673 if (!bvrf
->bg_ev
[0])
1674 thread_add_read(master
, bfd_recv_cb
, bvrf
, bvrf
->bg_shop
,
1676 if (!bvrf
->bg_ev
[1])
1677 thread_add_read(master
, bfd_recv_cb
, bvrf
, bvrf
->bg_mhop
,
1679 if (!bvrf
->bg_ev
[2])
1680 thread_add_read(master
, bfd_recv_cb
, bvrf
, bvrf
->bg_shop6
,
1682 if (!bvrf
->bg_ev
[3])
1683 thread_add_read(master
, bfd_recv_cb
, bvrf
, bvrf
->bg_mhop6
,
1685 if (!bvrf
->bg_ev
[4])
1686 thread_add_read(master
, bfd_recv_cb
, bvrf
, bvrf
->bg_echo
,
1688 if (!bvrf
->bg_ev
[5])
1689 thread_add_read(master
, bfd_recv_cb
, bvrf
, bvrf
->bg_echov6
,
1692 if (vrf
->vrf_id
!= VRF_DEFAULT
) {
1693 bfdd_zclient_register(vrf
->vrf_id
);
1694 bfdd_sessions_enable_vrf(vrf
);
1699 static int bfd_vrf_disable(struct vrf
*vrf
)
1701 struct bfd_vrf_global
*bvrf
;
1707 if (vrf
->vrf_id
!= VRF_DEFAULT
) {
1708 bfdd_sessions_disable_vrf(vrf
);
1709 bfdd_zclient_unregister(vrf
->vrf_id
);
1712 log_debug("VRF disable %s id %d", vrf
->name
, vrf
->vrf_id
);
1714 /* Disable read/write poll triggering. */
1715 THREAD_OFF(bvrf
->bg_ev
[0]);
1716 THREAD_OFF(bvrf
->bg_ev
[1]);
1717 THREAD_OFF(bvrf
->bg_ev
[2]);
1718 THREAD_OFF(bvrf
->bg_ev
[3]);
1719 THREAD_OFF(bvrf
->bg_ev
[4]);
1720 THREAD_OFF(bvrf
->bg_ev
[5]);
1722 /* Close all descriptors. */
1723 socket_close(&bvrf
->bg_echo
);
1724 socket_close(&bvrf
->bg_shop
);
1725 socket_close(&bvrf
->bg_mhop
);
1726 socket_close(&bvrf
->bg_shop6
);
1727 socket_close(&bvrf
->bg_mhop6
);
1728 socket_close(&bvrf
->bg_echo
);
1729 socket_close(&bvrf
->bg_echov6
);
1732 XFREE(MTYPE_BFDD_VRF
, bvrf
);
1738 void bfd_vrf_init(void)
1740 vrf_init(bfd_vrf_new
, bfd_vrf_enable
, bfd_vrf_disable
,
1741 bfd_vrf_delete
, bfd_vrf_update
);
1744 void bfd_vrf_terminate(void)
1749 struct bfd_vrf_global
*bfd_vrf_look_by_session(struct bfd_session
*bfd
)
1753 if (!vrf_is_backend_netns()) {
1754 vrf
= vrf_lookup_by_id(VRF_DEFAULT
);
1756 return (struct bfd_vrf_global
*)vrf
->info
;
1763 return bfd
->vrf
->info
;
1766 void bfd_session_update_vrf_name(struct bfd_session
*bs
, struct vrf
*vrf
)
1771 hash_release(bfd_key_hash
, bs
);
1773 * HACK: Change the BFD VRF in the running configuration directly,
1774 * bypassing the northbound layer. This is necessary to avoid deleting
1775 * the BFD and readding it in the new VRF, which would have
1776 * several implications.
1778 if (yang_module_find("frr-bfdd") && bs
->key
.vrfname
[0]) {
1779 struct lyd_node
*bfd_dnode
;
1780 char xpath
[XPATH_MAXLEN
], xpath_srcaddr
[XPATH_MAXLEN
+ 32];
1781 char addr_buf
[INET6_ADDRSTRLEN
];
1786 inet_ntop(bs
->key
.family
, &bs
->key
.local
, addr_buf
, sizeof(addr_buf
));
1787 snprintf(xpath_srcaddr
, sizeof(xpath_srcaddr
), "[source-addr='%s']",
1790 xpath_srcaddr
[0] = 0;
1791 inet_ntop(bs
->key
.family
, &bs
->key
.peer
, addr_buf
, sizeof(addr_buf
));
1792 slen
= snprintf(xpath
, sizeof(xpath
),
1793 "/frr-bfdd:bfdd/bfd/sessions/%s%s[dest-addr='%s']",
1794 bs
->key
.mhop
? "multi-hop" : "single-hop", xpath_srcaddr
,
1796 if (bs
->key
.ifname
[0])
1797 slen
+= snprintf(xpath
+ slen
, sizeof(xpath
) - slen
,
1798 "[interface='%s']", bs
->key
.ifname
);
1800 slen
+= snprintf(xpath
+ slen
, sizeof(xpath
) - slen
,
1802 snprintf(xpath
+ slen
, sizeof(xpath
) - slen
, "[vrf='%s']/vrf",
1805 bfd_dnode
= yang_dnode_get(running_config
->dnode
, xpath
,
1808 yang_dnode_change_leaf(bfd_dnode
, vrf
->name
);
1809 running_config
->version
++;
1812 memset(bs
->key
.vrfname
, 0, sizeof(bs
->key
.vrfname
));
1813 strlcpy(bs
->key
.vrfname
, vrf
->name
, sizeof(bs
->key
.vrfname
));
1814 hash_get(bfd_key_hash
, bs
, hash_alloc_intern
);