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
);
164 if (bs
->key
.ifname
[0]
165 && BFD_CHECK_FLAG(bs
->flags
, BFD_SESS_FLAG_MH
) == 0)
168 /* Sanity check: don't leak open sockets. */
169 if (bs
->sock
!= -1) {
170 log_debug("session-enable: previous socket open");
176 * Get socket for transmitting control packets. Note that if we
177 * could use the destination port (3784) for the source
178 * port we wouldn't need a socket per session.
180 if (BFD_CHECK_FLAG(bs
->flags
, BFD_SESS_FLAG_IPV6
) == 0) {
181 psock
= bp_peer_socket(bs
);
185 psock
= bp_peer_socketv6(bs
);
191 * We've got a valid socket, lets start the timers and the
195 bfd_recvtimer_update(bs
);
196 ptm_bfd_start_xmt_timer(bs
, false);
202 * Disabled a running BFD session.
204 * A session is disabled when the specified interface/VRF gets removed
205 * (e.g. virtual interfaces).
207 void bfd_session_disable(struct bfd_session
*bs
)
209 /* Free up socket resources. */
210 if (bs
->sock
!= -1) {
215 /* Disable all timers. */
216 bfd_recvtimer_delete(bs
);
217 bfd_xmttimer_delete(bs
);
218 ptm_bfd_echo_stop(bs
);
222 /* Set session down so it doesn't report UP and disabled. */
223 ptm_bfd_sess_dn(bs
, BD_PATH_DOWN
);
226 static uint32_t ptm_bfd_gen_ID(void)
231 * RFC 5880, Section 6.8.1. recommends that we should generate
232 * random session identification numbers.
235 session_id
= ((random() << 16) & 0xFFFF0000)
236 | (random() & 0x0000FFFF);
237 } while (session_id
== 0 || bfd_id_lookup(session_id
) != NULL
);
242 void ptm_bfd_start_xmt_timer(struct bfd_session
*bfd
, bool is_echo
)
244 uint64_t jitter
, xmt_TO
;
247 xmt_TO
= is_echo
? bfd
->echo_xmt_TO
: bfd
->xmt_TO
;
250 * From section 6.5.2: trasmit interval should be randomly jittered
252 * 75% and 100% of nominal value, unless detect_mult is 1, then should
254 * between 75% and 90%.
256 maxpercent
= (bfd
->detect_mult
== 1) ? 16 : 26;
257 jitter
= (xmt_TO
* (75 + (random() % maxpercent
))) / 100;
258 /* XXX remove that division above */
261 bfd_echo_xmttimer_update(bfd
, jitter
);
263 bfd_xmttimer_update(bfd
, jitter
);
266 static void ptm_bfd_echo_xmt_TO(struct bfd_session
*bfd
)
268 /* Send the scheduled echo packet */
269 ptm_bfd_echo_snd(bfd
);
271 /* Restart the timer for next time */
272 ptm_bfd_start_xmt_timer(bfd
, true);
275 void ptm_bfd_xmt_TO(struct bfd_session
*bfd
, int fbit
)
277 /* Send the scheduled control packet */
278 ptm_bfd_snd(bfd
, fbit
);
280 /* Restart the timer for next time */
281 ptm_bfd_start_xmt_timer(bfd
, false);
284 void ptm_bfd_echo_stop(struct bfd_session
*bfd
)
286 bfd
->echo_xmt_TO
= 0;
287 bfd
->echo_detect_TO
= 0;
288 BFD_UNSET_FLAG(bfd
->flags
, BFD_SESS_FLAG_ECHO_ACTIVE
);
290 bfd_echo_xmttimer_delete(bfd
);
291 bfd_echo_recvtimer_delete(bfd
);
294 void ptm_bfd_echo_start(struct bfd_session
*bfd
)
296 bfd
->echo_detect_TO
= (bfd
->remote_detect_mult
* bfd
->echo_xmt_TO
);
297 if (bfd
->echo_detect_TO
> 0)
298 ptm_bfd_echo_xmt_TO(bfd
);
301 void ptm_bfd_sess_up(struct bfd_session
*bfd
)
303 int old_state
= bfd
->ses_state
;
306 bfd
->ses_state
= PTM_BFD_UP
;
307 monotime(&bfd
->uptime
);
309 /* Connection is up, lets negotiate timers. */
310 bfd_set_polling(bfd
);
312 /* Start sending control packets with poll bit immediately. */
317 if (old_state
!= bfd
->ses_state
) {
318 bfd
->stats
.session_up
++;
319 log_info("state-change: [%s] %s -> %s", bs_to_string(bfd
),
320 state_list
[old_state
].str
,
321 state_list
[bfd
->ses_state
].str
);
325 void ptm_bfd_sess_dn(struct bfd_session
*bfd
, uint8_t diag
)
327 int old_state
= bfd
->ses_state
;
329 bfd
->local_diag
= diag
;
330 bfd
->discrs
.remote_discr
= 0;
331 bfd
->ses_state
= PTM_BFD_DOWN
;
333 bfd
->demand_mode
= 0;
334 monotime(&bfd
->downtime
);
337 * Only attempt to send if we have a valid socket:
338 * this function might be called by session disablers and in
339 * this case we won't have a valid socket (i.e. interface was
340 * removed or VRF doesn't exist anymore).
345 /* Slow down the control packets, the connection is down. */
346 bs_set_slow_timers(bfd
);
348 /* only signal clients when going from up->down state */
349 if (old_state
== PTM_BFD_UP
)
352 /* Stop echo packet transmission if they are active */
353 if (BFD_CHECK_FLAG(bfd
->flags
, BFD_SESS_FLAG_ECHO_ACTIVE
))
354 ptm_bfd_echo_stop(bfd
);
356 if (old_state
!= bfd
->ses_state
) {
357 bfd
->stats
.session_down
++;
358 log_info("state-change: [%s] %s -> %s reason:%s",
359 bs_to_string(bfd
), state_list
[old_state
].str
,
360 state_list
[bfd
->ses_state
].str
,
361 get_diag_str(bfd
->local_diag
));
365 static struct bfd_session
*bfd_find_disc(struct sockaddr_any
*sa
,
368 struct bfd_session
*bs
;
370 bs
= bfd_id_lookup(ldisc
);
374 switch (bs
->key
.family
) {
376 if (memcmp(&sa
->sa_sin
.sin_addr
, &bs
->key
.peer
,
377 sizeof(sa
->sa_sin
.sin_addr
)))
381 if (memcmp(&sa
->sa_sin6
.sin6_addr
, &bs
->key
.peer
,
382 sizeof(sa
->sa_sin6
.sin6_addr
)))
390 struct bfd_session
*ptm_bfd_sess_find(struct bfd_pkt
*cp
,
391 struct sockaddr_any
*peer
,
392 struct sockaddr_any
*local
,
393 ifindex_t ifindex
, vrf_id_t vrfid
,
396 struct interface
*ifp
;
400 /* Find our session using the ID signaled by the remote end. */
401 if (cp
->discrs
.remote_discr
)
402 return bfd_find_disc(peer
, ntohl(cp
->discrs
.remote_discr
));
404 /* Search for session without using discriminator. */
405 ifp
= if_lookup_by_index(ifindex
, vrfid
);
407 vrf
= vrf_lookup_by_id(vrfid
);
409 gen_bfd_key(&key
, peer
, local
, is_mhop
, ifp
? ifp
->name
: NULL
,
410 vrf
? vrf
->name
: VRF_DEFAULT_NAME
);
412 /* XXX maybe remoteDiscr should be checked for remoteHeard cases. */
413 return bfd_key_lookup(key
);
416 int bfd_xmt_cb(struct thread
*t
)
418 struct bfd_session
*bs
= THREAD_ARG(t
);
420 ptm_bfd_xmt_TO(bs
, 0);
425 int bfd_echo_xmt_cb(struct thread
*t
)
427 struct bfd_session
*bs
= THREAD_ARG(t
);
429 if (bs
->echo_xmt_TO
> 0)
430 ptm_bfd_echo_xmt_TO(bs
);
435 /* Was ptm_bfd_detect_TO() */
436 int bfd_recvtimer_cb(struct thread
*t
)
438 struct bfd_session
*bs
= THREAD_ARG(t
);
440 switch (bs
->ses_state
) {
443 ptm_bfd_sess_dn(bs
, BD_CONTROL_EXPIRED
);
444 bfd_recvtimer_update(bs
);
448 /* Second detect time expiration, zero remote discr (section
451 bs
->discrs
.remote_discr
= 0;
458 /* Was ptm_bfd_echo_detect_TO() */
459 int bfd_echo_recvtimer_cb(struct thread
*t
)
461 struct bfd_session
*bs
= THREAD_ARG(t
);
463 switch (bs
->ses_state
) {
466 ptm_bfd_sess_dn(bs
, BD_ECHO_FAILED
);
473 struct bfd_session
*bfd_session_new(void)
475 struct bfd_session
*bs
;
477 bs
= XCALLOC(MTYPE_BFDD_CONFIG
, sizeof(*bs
));
479 bs
->timers
.desired_min_tx
= BFD_DEFDESIREDMINTX
;
480 bs
->timers
.required_min_rx
= BFD_DEFREQUIREDMINRX
;
481 bs
->timers
.required_min_echo
= BFD_DEF_REQ_MIN_ECHO
;
482 bs
->detect_mult
= BFD_DEFDETECTMULT
;
483 bs
->mh_ttl
= BFD_DEF_MHOP_TTL
;
484 bs
->ses_state
= PTM_BFD_DOWN
;
486 /* Initiate connection with slow timers. */
487 bs_set_slow_timers(bs
);
489 /* Initiate remote settings as well. */
490 bs
->remote_timers
= bs
->cur_timers
;
491 bs
->remote_detect_mult
= BFD_DEFDETECTMULT
;
494 monotime(&bs
->uptime
);
495 bs
->downtime
= bs
->uptime
;
500 int bfd_session_update_label(struct bfd_session
*bs
, const char *nlabel
)
502 /* New label treatment:
503 * - Check if the label is taken;
504 * - Try to allocate the memory for it and register;
506 if (bs
->pl
== NULL
) {
507 if (pl_find(nlabel
) != NULL
) {
508 /* Someone is already using it. */
512 if (pl_new(nlabel
, bs
) == NULL
)
519 * Test label change consistency:
520 * - Do nothing if it's the same label;
521 * - Check if the future label is already taken;
524 if (strcmp(nlabel
, bs
->pl
->pl_label
) == 0)
526 if (pl_find(nlabel
) != NULL
)
529 strlcpy(bs
->pl
->pl_label
, nlabel
, sizeof(bs
->pl
->pl_label
));
533 static void _bfd_session_update(struct bfd_session
*bs
,
534 struct bfd_peer_cfg
*bpc
)
537 /* Check if echo mode is already active. */
538 if (BFD_CHECK_FLAG(bs
->flags
, BFD_SESS_FLAG_ECHO
))
541 BFD_SET_FLAG(bs
->flags
, BFD_SESS_FLAG_ECHO
);
543 /* Activate/update echo receive timeout timer. */
544 bs_echo_timer_handler(bs
);
546 /* Check if echo mode is already disabled. */
547 if (!BFD_CHECK_FLAG(bs
->flags
, BFD_SESS_FLAG_ECHO
))
550 BFD_UNSET_FLAG(bs
->flags
, BFD_SESS_FLAG_ECHO
);
551 ptm_bfd_echo_stop(bs
);
555 if (bpc
->bpc_has_txinterval
)
556 bs
->timers
.desired_min_tx
= bpc
->bpc_txinterval
* 1000;
558 if (bpc
->bpc_has_recvinterval
)
559 bs
->timers
.required_min_rx
= bpc
->bpc_recvinterval
* 1000;
561 if (bpc
->bpc_has_detectmultiplier
)
562 bs
->detect_mult
= bpc
->bpc_detectmultiplier
;
564 if (bpc
->bpc_has_echointerval
)
565 bs
->timers
.required_min_echo
= bpc
->bpc_echointerval
* 1000;
567 if (bpc
->bpc_has_label
)
568 bfd_session_update_label(bs
, bpc
->bpc_label
);
570 if (bpc
->bpc_shutdown
) {
571 /* Check if already shutdown. */
572 if (BFD_CHECK_FLAG(bs
->flags
, BFD_SESS_FLAG_SHUTDOWN
))
575 BFD_SET_FLAG(bs
->flags
, BFD_SESS_FLAG_SHUTDOWN
);
577 /* Disable all events. */
578 bfd_recvtimer_delete(bs
);
579 bfd_echo_recvtimer_delete(bs
);
580 bfd_xmttimer_delete(bs
);
581 bfd_echo_xmttimer_delete(bs
);
583 /* Change and notify state change. */
584 bs
->ses_state
= PTM_BFD_ADM_DOWN
;
587 /* Don't try to send packets with a disabled session. */
591 /* Check if already working. */
592 if (!BFD_CHECK_FLAG(bs
->flags
, BFD_SESS_FLAG_SHUTDOWN
))
595 BFD_UNSET_FLAG(bs
->flags
, BFD_SESS_FLAG_SHUTDOWN
);
597 /* Change and notify state change. */
598 bs
->ses_state
= PTM_BFD_DOWN
;
601 /* Enable all timers. */
602 bfd_recvtimer_update(bs
);
603 bfd_xmttimer_update(bs
, bs
->xmt_TO
);
606 if (BFD_CHECK_FLAG(bs
->flags
, BFD_SESS_FLAG_CBIT
))
609 BFD_SET_FLAG(bs
->flags
, BFD_SESS_FLAG_CBIT
);
611 if (!BFD_CHECK_FLAG(bs
->flags
, BFD_SESS_FLAG_CBIT
))
614 BFD_UNSET_FLAG(bs
->flags
, BFD_SESS_FLAG_CBIT
);
618 static int bfd_session_update(struct bfd_session
*bs
, struct bfd_peer_cfg
*bpc
)
620 /* User didn't want to update, return failure. */
621 if (bpc
->bpc_createonly
)
624 _bfd_session_update(bs
, bpc
);
626 control_notify_config(BCM_NOTIFY_CONFIG_UPDATE
, bs
);
631 void bfd_session_free(struct bfd_session
*bs
)
633 struct bfd_session_observer
*bso
;
635 bfd_session_disable(bs
);
637 bfd_key_delete(bs
->key
);
638 bfd_id_delete(bs
->discrs
.my_discr
);
640 /* Remove observer if any. */
641 TAILQ_FOREACH(bso
, &bglobal
.bg_obslist
, bso_entry
) {
642 if (bso
->bso_bs
!= bs
)
648 bs_observer_del(bso
);
652 XFREE(MTYPE_BFDD_CONFIG
, bs
);
655 struct bfd_session
*ptm_bfd_sess_new(struct bfd_peer_cfg
*bpc
)
657 struct bfd_session
*bfd
, *l_bfd
;
659 /* check to see if this needs a new session */
660 l_bfd
= bs_peer_find(bpc
);
662 /* Requesting a duplicated peer means update configuration. */
663 if (bfd_session_update(l_bfd
, bpc
) == 0)
669 /* Get BFD session storage with its defaults. */
670 bfd
= bfd_session_new();
672 log_error("session-new: allocation failed");
677 * Store interface/VRF name in case we need to delay session
678 * start. See `bfd_session_enable` for more information.
680 if (bpc
->bpc_has_localif
)
681 strlcpy(bfd
->key
.ifname
, bpc
->bpc_localif
,
682 sizeof(bfd
->key
.ifname
));
684 if (bpc
->bpc_has_vrfname
)
685 strlcpy(bfd
->key
.vrfname
, bpc
->bpc_vrfname
,
686 sizeof(bfd
->key
.vrfname
));
688 strlcpy(bfd
->key
.vrfname
, VRF_DEFAULT_NAME
,
689 sizeof(bfd
->key
.vrfname
));
691 /* Copy remaining data. */
692 if (bpc
->bpc_ipv4
== false)
693 BFD_SET_FLAG(bfd
->flags
, BFD_SESS_FLAG_IPV6
);
695 bfd
->key
.family
= (bpc
->bpc_ipv4
) ? AF_INET
: AF_INET6
;
696 switch (bfd
->key
.family
) {
698 memcpy(&bfd
->key
.peer
, &bpc
->bpc_peer
.sa_sin
.sin_addr
,
699 sizeof(bpc
->bpc_peer
.sa_sin
.sin_addr
));
700 memcpy(&bfd
->key
.local
, &bpc
->bpc_local
.sa_sin
.sin_addr
,
701 sizeof(bpc
->bpc_local
.sa_sin
.sin_addr
));
705 memcpy(&bfd
->key
.peer
, &bpc
->bpc_peer
.sa_sin6
.sin6_addr
,
706 sizeof(bpc
->bpc_peer
.sa_sin6
.sin6_addr
));
707 memcpy(&bfd
->key
.local
, &bpc
->bpc_local
.sa_sin6
.sin6_addr
,
708 sizeof(bpc
->bpc_local
.sa_sin6
.sin6_addr
));
717 BFD_SET_FLAG(bfd
->flags
, BFD_SESS_FLAG_MH
);
719 bfd
->key
.mhop
= bpc
->bpc_mhop
;
721 if (bs_registrate(bfd
) == NULL
)
724 /* Apply other configurations. */
725 _bfd_session_update(bfd
, bpc
);
730 struct bfd_session
*bs_registrate(struct bfd_session
*bfd
)
732 /* Registrate session into data structures. */
734 bfd
->discrs
.my_discr
= ptm_bfd_gen_ID();
737 /* Try to enable session and schedule for packet receive/send. */
738 if (bfd_session_enable(bfd
) == -1) {
739 /* Unrecoverable failure, remove the session/peer. */
740 bfd_session_free(bfd
);
744 /* Add observer if we have moving parts. */
745 if (bfd
->key
.ifname
[0] || bfd
->key
.vrfname
[0] || bfd
->sock
== -1)
746 bs_observer_add(bfd
);
748 log_info("session-new: %s", bs_to_string(bfd
));
750 control_notify_config(BCM_NOTIFY_CONFIG_ADD
, bfd
);
755 int ptm_bfd_sess_del(struct bfd_peer_cfg
*bpc
)
757 struct bfd_session
*bs
;
759 /* Find session and call free(). */
760 bs
= bs_peer_find(bpc
);
764 /* This pointer is being referenced, don't let it be deleted. */
765 if (bs
->refcount
> 0) {
766 log_error("session-delete: refcount failure: %" PRIu64
772 log_info("session-delete: %s", bs_to_string(bs
));
774 control_notify_config(BCM_NOTIFY_CONFIG_DELETE
, bs
);
776 bfd_session_free(bs
);
781 void bfd_set_polling(struct bfd_session
*bs
)
784 * Start polling procedure: the only timers that require polling
785 * to change value without losing connection are:
787 * - Desired minimum transmission interval;
788 * - Required minimum receive interval;
790 * RFC 5880, Section 6.8.3.
796 * bs_<state>_handler() functions implement the BFD state machine
797 * transition mechanism. `<state>` is the current session state and
798 * the parameter `nstate` is the peer new state.
800 static void bs_admin_down_handler(struct bfd_session
*bs
801 __attribute__((__unused__
)),
802 int nstate
__attribute__((__unused__
)))
805 * We are administratively down, there is no state machine
810 static void bs_down_handler(struct bfd_session
*bs
, int nstate
)
813 case PTM_BFD_ADM_DOWN
:
815 * Remote peer doesn't want to talk, so lets keep the
819 /* Peer can't be up yet, wait it go to 'init' or 'down'. */
824 * Remote peer agreed that the path is down, lets try to
827 bs
->ses_state
= PTM_BFD_INIT
;
832 * Remote peer told us his path is up, lets turn
833 * activate the session.
839 log_debug("state-change: unhandled neighbor state: %d", nstate
);
844 static void bs_init_handler(struct bfd_session
*bs
, int nstate
)
847 case PTM_BFD_ADM_DOWN
:
849 * Remote peer doesn't want to talk, so lets make the
852 bs
->ses_state
= PTM_BFD_DOWN
;
856 /* Remote peer hasn't moved to first stage yet. */
861 /* We agreed on the settings and the path is up. */
866 log_debug("state-change: unhandled neighbor state: %d", nstate
);
871 static void bs_up_handler(struct bfd_session
*bs
, int nstate
)
874 case PTM_BFD_ADM_DOWN
:
876 /* Peer lost or asked to shutdown connection. */
877 ptm_bfd_sess_dn(bs
, BD_NEIGHBOR_DOWN
);
882 /* Path is up and working. */
886 log_debug("state-change: unhandled neighbor state: %d", nstate
);
891 void bs_state_handler(struct bfd_session
*bs
, int nstate
)
893 switch (bs
->ses_state
) {
894 case PTM_BFD_ADM_DOWN
:
895 bs_admin_down_handler(bs
, nstate
);
898 bs_down_handler(bs
, nstate
);
901 bs_init_handler(bs
, nstate
);
904 bs_up_handler(bs
, nstate
);
908 log_debug("state-change: [%s] is in invalid state: %d",
909 bs_to_string(bs
), nstate
);
915 * Handles echo timer manipulation after updating timer.
917 void bs_echo_timer_handler(struct bfd_session
*bs
)
922 * Before doing any echo handling, check if it is possible to
925 * - Check for `echo-mode` configuration.
926 * - Check that we are not using multi hop (RFC 5883,
928 * - Check that we are already at the up state.
930 if (BFD_CHECK_FLAG(bs
->flags
, BFD_SESS_FLAG_ECHO
) == 0
931 || BFD_CHECK_FLAG(bs
->flags
, BFD_SESS_FLAG_MH
)
932 || bs
->ses_state
!= PTM_BFD_UP
)
935 /* Remote peer asked to stop echo. */
936 if (bs
->remote_timers
.required_min_echo
== 0) {
937 if (BFD_CHECK_FLAG(bs
->flags
, BFD_SESS_FLAG_ECHO_ACTIVE
))
938 ptm_bfd_echo_stop(bs
);
944 * Calculate the echo transmission timer: we must not send
945 * echo packets faster than the minimum required time
946 * announced by the remote system.
948 * RFC 5880, Section 6.8.9.
950 old_timer
= bs
->echo_xmt_TO
;
951 if (bs
->remote_timers
.required_min_echo
> bs
->timers
.required_min_echo
)
952 bs
->echo_xmt_TO
= bs
->remote_timers
.required_min_echo
;
954 bs
->echo_xmt_TO
= bs
->timers
.required_min_echo
;
956 if (BFD_CHECK_FLAG(bs
->flags
, BFD_SESS_FLAG_ECHO_ACTIVE
) == 0
957 || old_timer
!= bs
->echo_xmt_TO
)
958 ptm_bfd_echo_start(bs
);
962 * RFC 5880 Section 6.5.
964 * When a BFD control packet with the final bit is received, we must
965 * update the session parameters.
967 void bs_final_handler(struct bfd_session
*bs
)
969 /* Start using our new timers. */
970 bs
->cur_timers
.desired_min_tx
= bs
->timers
.desired_min_tx
;
971 bs
->cur_timers
.required_min_rx
= bs
->timers
.required_min_rx
;
974 * TODO: demand mode. See RFC 5880 Section 6.1.
976 * When using demand mode we must disable the detection timer
977 * for lost control packets.
979 if (bs
->demand_mode
) {
980 /* Notify watchers about changed timers. */
981 control_notify_config(BCM_NOTIFY_CONFIG_UPDATE
, bs
);
986 * Calculate detection time based on new timers.
988 * Transmission calculation:
989 * We must respect the RequiredMinRxInterval from the remote
990 * system: if our desired transmission timer is more than the
991 * minimum receive rate, then we must lower it to at least the
992 * minimum receive interval.
994 * RFC 5880, Section 6.8.3.
996 if (bs
->timers
.desired_min_tx
> bs
->remote_timers
.required_min_rx
)
997 bs
->xmt_TO
= bs
->remote_timers
.required_min_rx
;
999 bs
->xmt_TO
= bs
->timers
.desired_min_tx
;
1001 /* Apply new transmission timer immediately. */
1002 ptm_bfd_start_xmt_timer(bs
, false);
1005 * Detection timeout calculation:
1006 * The minimum detection timeout is the remote detection
1007 * multipler (number of packets to be missed) times the agreed
1008 * transmission interval.
1010 * RFC 5880, Section 6.8.4.
1012 * TODO: support sending/counting more packets inside detection
1015 if (bs
->remote_timers
.required_min_rx
> bs
->timers
.desired_min_tx
)
1016 bs
->detect_TO
= bs
->remote_detect_mult
1017 * bs
->remote_timers
.required_min_rx
;
1019 bs
->detect_TO
= bs
->remote_detect_mult
1020 * bs
->timers
.desired_min_tx
;
1022 /* Apply new receive timer immediately. */
1023 bfd_recvtimer_update(bs
);
1025 /* Notify watchers about changed timers. */
1026 control_notify_config(BCM_NOTIFY_CONFIG_UPDATE
, bs
);
1029 void bs_set_slow_timers(struct bfd_session
*bs
)
1032 * BFD connection must use slow timers before going up or after
1033 * losing connectivity to avoid wasting bandwidth.
1035 * RFC 5880, Section 6.8.3.
1037 bs
->cur_timers
.desired_min_tx
= BFD_DEF_SLOWTX
;
1038 bs
->cur_timers
.required_min_rx
= BFD_DEF_SLOWTX
;
1039 bs
->cur_timers
.required_min_echo
= 0;
1041 /* Set the appropriated timeouts for slow connection. */
1042 bs
->detect_TO
= (BFD_DEFDETECTMULT
* BFD_DEF_SLOWTX
);
1043 bs
->xmt_TO
= BFD_DEF_SLOWTX
;
1049 static const char *get_diag_str(int diag
)
1051 for (int i
= 0; diag_list
[i
].str
; i
++) {
1052 if (diag_list
[i
].type
== diag
)
1053 return diag_list
[i
].str
;
1058 const char *satostr(struct sockaddr_any
*sa
)
1060 #define INETSTR_BUFCOUNT 8
1061 static char buf
[INETSTR_BUFCOUNT
][INET6_ADDRSTRLEN
];
1063 struct sockaddr_in
*sin
= &sa
->sa_sin
;
1064 struct sockaddr_in6
*sin6
= &sa
->sa_sin6
;
1066 bufidx
+= (bufidx
+ 1) % INETSTR_BUFCOUNT
;
1069 switch (sin
->sin_family
) {
1071 inet_ntop(AF_INET
, &sin
->sin_addr
, buf
[bufidx
],
1072 sizeof(buf
[bufidx
]));
1075 inet_ntop(AF_INET6
, &sin6
->sin6_addr
, buf
[bufidx
],
1076 sizeof(buf
[bufidx
]));
1080 strlcpy(buf
[bufidx
], "unknown", sizeof(buf
[bufidx
]));
1087 const char *diag2str(uint8_t diag
)
1093 return "control detection time expired";
1095 return "echo function failed";
1097 return "neighbor signaled session down";
1099 return "forwarding plane reset";
1103 return "concatenated path down";
1105 return "administratively down";
1107 return "reverse concatenated path down";
1113 int strtosa(const char *addr
, struct sockaddr_any
*sa
)
1115 memset(sa
, 0, sizeof(*sa
));
1117 if (inet_pton(AF_INET
, addr
, &sa
->sa_sin
.sin_addr
) == 1) {
1118 sa
->sa_sin
.sin_family
= AF_INET
;
1119 #ifdef HAVE_STRUCT_SOCKADDR_SA_LEN
1120 sa
->sa_sin
.sin_len
= sizeof(sa
->sa_sin
);
1121 #endif /* HAVE_STRUCT_SOCKADDR_SA_LEN */
1125 if (inet_pton(AF_INET6
, addr
, &sa
->sa_sin6
.sin6_addr
) == 1) {
1126 sa
->sa_sin6
.sin6_family
= AF_INET6
;
1127 #ifdef HAVE_STRUCT_SOCKADDR_SA_LEN
1128 sa
->sa_sin6
.sin6_len
= sizeof(sa
->sa_sin6
);
1129 #endif /* HAVE_STRUCT_SOCKADDR_SA_LEN */
1136 void integer2timestr(uint64_t time
, char *buf
, size_t buflen
)
1138 unsigned int year
, month
, day
, hour
, minute
, second
;
1141 #define MINUTES (60)
1142 #define HOURS (60 * MINUTES)
1143 #define DAYS (24 * HOURS)
1144 #define MONTHS (30 * DAYS)
1145 #define YEARS (12 * MONTHS)
1146 if (time
>= YEARS
) {
1147 year
= time
/ YEARS
;
1148 time
-= year
* YEARS
;
1150 rv
= snprintf(buf
, buflen
, "%u year(s), ", year
);
1154 if (time
>= MONTHS
) {
1155 month
= time
/ MONTHS
;
1156 time
-= month
* MONTHS
;
1158 rv
= snprintf(buf
, buflen
, "%u month(s), ", month
);
1166 rv
= snprintf(buf
, buflen
, "%u day(s), ", day
);
1170 if (time
>= HOURS
) {
1171 hour
= time
/ HOURS
;
1172 time
-= hour
* HOURS
;
1174 rv
= snprintf(buf
, buflen
, "%u hour(s), ", hour
);
1178 if (time
>= MINUTES
) {
1179 minute
= time
/ MINUTES
;
1180 time
-= minute
* MINUTES
;
1182 rv
= snprintf(buf
, buflen
, "%u minute(s), ", minute
);
1186 second
= time
% MINUTES
;
1187 snprintf(buf
, buflen
, "%u second(s)", second
);
1190 const char *bs_to_string(const struct bfd_session
*bs
)
1192 static char buf
[256];
1193 char addr_buf
[INET6_ADDRSTRLEN
];
1195 bool is_mhop
= BFD_CHECK_FLAG(bs
->flags
, BFD_SESS_FLAG_MH
);
1197 pos
= snprintf(buf
, sizeof(buf
), "mhop:%s", is_mhop
? "yes" : "no");
1198 pos
+= snprintf(buf
+ pos
, sizeof(buf
) - pos
, " peer:%s",
1199 inet_ntop(bs
->key
.family
, &bs
->key
.peer
, addr_buf
,
1201 pos
+= snprintf(buf
+ pos
, sizeof(buf
) - pos
, " local:%s",
1202 inet_ntop(bs
->key
.family
, &bs
->key
.local
, addr_buf
,
1204 if (bs
->key
.vrfname
[0])
1205 pos
+= snprintf(buf
+ pos
, sizeof(buf
) - pos
, " vrf:%s",
1207 if (bs
->key
.ifname
[0])
1208 pos
+= snprintf(buf
+ pos
, sizeof(buf
) - pos
, " ifname:%s",
1216 int bs_observer_add(struct bfd_session
*bs
)
1218 struct bfd_session_observer
*bso
;
1220 bso
= XCALLOC(MTYPE_BFDD_SESSION_OBSERVER
, sizeof(*bso
));
1222 bso
->bso_addr
.family
= bs
->key
.family
;
1223 memcpy(&bso
->bso_addr
.u
.prefix
, &bs
->key
.local
,
1224 sizeof(bs
->key
.local
));
1226 TAILQ_INSERT_TAIL(&bglobal
.bg_obslist
, bso
, bso_entry
);
1231 void bs_observer_del(struct bfd_session_observer
*bso
)
1233 TAILQ_REMOVE(&bglobal
.bg_obslist
, bso
, bso_entry
);
1234 XFREE(MTYPE_BFDD_SESSION_OBSERVER
, bso
);
1237 void bs_to_bpc(struct bfd_session
*bs
, struct bfd_peer_cfg
*bpc
)
1239 memset(bpc
, 0, sizeof(*bpc
));
1241 bpc
->bpc_ipv4
= (bs
->key
.family
== AF_INET
);
1242 bpc
->bpc_mhop
= bs
->key
.mhop
;
1244 switch (bs
->key
.family
) {
1246 bpc
->bpc_peer
.sa_sin
.sin_family
= AF_INET
;
1247 memcpy(&bpc
->bpc_peer
.sa_sin
.sin_addr
, &bs
->key
.peer
,
1248 sizeof(bpc
->bpc_peer
.sa_sin
.sin_addr
));
1250 if (memcmp(&bs
->key
.local
, &zero_addr
, sizeof(bs
->key
.local
))) {
1251 bpc
->bpc_local
.sa_sin
.sin_family
= AF_INET6
;
1252 memcpy(&bpc
->bpc_local
.sa_sin
.sin_addr
, &bs
->key
.local
,
1253 sizeof(bpc
->bpc_local
.sa_sin
.sin_addr
));
1258 bpc
->bpc_peer
.sa_sin
.sin_family
= AF_INET6
;
1259 memcpy(&bpc
->bpc_peer
.sa_sin6
.sin6_addr
, &bs
->key
.peer
,
1260 sizeof(bpc
->bpc_peer
.sa_sin6
.sin6_addr
));
1262 bpc
->bpc_local
.sa_sin6
.sin6_family
= AF_INET6
;
1263 memcpy(&bpc
->bpc_local
.sa_sin6
.sin6_addr
, &bs
->key
.local
,
1264 sizeof(bpc
->bpc_local
.sa_sin6
.sin6_addr
));
1268 if (bs
->key
.ifname
[0]) {
1269 bpc
->bpc_has_localif
= true;
1270 strlcpy(bpc
->bpc_localif
, bs
->key
.ifname
,
1271 sizeof(bpc
->bpc_localif
));
1274 if (bs
->key
.vrfname
[0]) {
1275 bpc
->bpc_has_vrfname
= true;
1276 strlcpy(bpc
->bpc_vrfname
, bs
->key
.vrfname
,
1277 sizeof(bpc
->bpc_vrfname
));
1283 * BFD hash data structures to find sessions.
1285 static struct hash
*bfd_id_hash
;
1286 static struct hash
*bfd_key_hash
;
1288 static unsigned int bfd_id_hash_do(const void *p
);
1289 static unsigned int bfd_key_hash_do(const void *p
);
1291 static void _bfd_free(struct hash_bucket
*hb
,
1292 void *arg
__attribute__((__unused__
)));
1294 /* BFD hash for our discriminator. */
1295 static unsigned int bfd_id_hash_do(const void *p
)
1297 const struct bfd_session
*bs
= p
;
1299 return jhash_1word(bs
->discrs
.my_discr
, 0);
1302 static bool bfd_id_hash_cmp(const void *n1
, const void *n2
)
1304 const struct bfd_session
*bs1
= n1
, *bs2
= n2
;
1306 return bs1
->discrs
.my_discr
== bs2
->discrs
.my_discr
;
1309 /* BFD hash for single hop. */
1310 static unsigned int bfd_key_hash_do(const void *p
)
1312 const struct bfd_session
*bs
= p
;
1314 return jhash(&bs
->key
, sizeof(bs
->key
), 0);
1317 static bool bfd_key_hash_cmp(const void *n1
, const void *n2
)
1319 const struct bfd_session
*bs1
= n1
, *bs2
= n2
;
1321 return memcmp(&bs1
->key
, &bs2
->key
, sizeof(bs1
->key
)) == 0;
1326 * Hash public interface / exported functions.
1329 /* Lookup functions. */
1330 struct bfd_session
*bfd_id_lookup(uint32_t id
)
1332 struct bfd_session bs
;
1334 bs
.discrs
.my_discr
= id
;
1336 return hash_lookup(bfd_id_hash
, &bs
);
1339 struct bfd_key_walk_partial_lookup
{
1340 struct bfd_session
*given
;
1341 struct bfd_session
*result
;
1344 /* ignore some parameters */
1345 static int bfd_key_lookup_ignore_partial_walker(struct hash_bucket
*b
,
1348 struct bfd_key_walk_partial_lookup
*ctx
=
1349 (struct bfd_key_walk_partial_lookup
*)data
;
1350 struct bfd_session
*given
= ctx
->given
;
1351 struct bfd_session
*parsed
= b
->data
;
1353 if (given
->key
.family
!= parsed
->key
.family
)
1354 return HASHWALK_CONTINUE
;
1355 if (given
->key
.mhop
!= parsed
->key
.mhop
)
1356 return HASHWALK_CONTINUE
;
1357 if (memcmp(&given
->key
.peer
, &parsed
->key
.peer
,
1358 sizeof(struct in6_addr
)))
1359 return HASHWALK_CONTINUE
;
1360 if (memcmp(given
->key
.vrfname
, parsed
->key
.vrfname
, MAXNAMELEN
))
1361 return HASHWALK_CONTINUE
;
1362 ctx
->result
= parsed
;
1363 /* ignore localaddr or interface */
1364 return HASHWALK_ABORT
;
1367 struct bfd_session
*bfd_key_lookup(struct bfd_key key
)
1369 struct bfd_session bs
, *bsp
;
1370 struct bfd_key_walk_partial_lookup ctx
;
1371 char peer_buf
[INET6_ADDRSTRLEN
];
1374 bsp
= hash_lookup(bfd_key_hash
, &bs
);
1378 inet_ntop(bs
.key
.family
, &bs
.key
.peer
, peer_buf
,
1380 /* Handle cases where local-address is optional. */
1381 if (bs
.key
.family
== AF_INET
) {
1382 memset(&bs
.key
.local
, 0, sizeof(bs
.key
.local
));
1383 bsp
= hash_lookup(bfd_key_hash
, &bs
);
1385 char addr_buf
[INET6_ADDRSTRLEN
];
1387 inet_ntop(bs
.key
.family
, &key
.local
, addr_buf
,
1389 log_debug(" peer %s found, but loc-addr %s ignored",
1390 peer_buf
, addr_buf
);
1396 /* Handle cases where ifname is optional. */
1397 if (bs
.key
.ifname
[0]) {
1398 memset(bs
.key
.ifname
, 0, sizeof(bs
.key
.ifname
));
1399 bsp
= hash_lookup(bfd_key_hash
, &bs
);
1401 log_debug(" peer %s found, but ifp %s ignored",
1402 peer_buf
, key
.ifname
);
1407 /* Handle cases where local-address and ifname are optional. */
1408 if (bs
.key
.family
== AF_INET
) {
1409 memset(&bs
.key
.local
, 0, sizeof(bs
.key
.local
));
1410 bsp
= hash_lookup(bfd_key_hash
, &bs
);
1412 char addr_buf
[INET6_ADDRSTRLEN
];
1414 inet_ntop(bs
.key
.family
, &bs
.key
.local
, addr_buf
,
1416 log_debug(" peer %s found, but ifp %s"
1417 " and loc-addr %s ignored",
1418 peer_buf
, key
.ifname
,
1425 /* Handle case where a context more complex ctx is present.
1426 * input has no iface nor local-address, but a context may
1431 hash_walk(bfd_key_hash
,
1432 &bfd_key_lookup_ignore_partial_walker
,
1437 log_debug(" peer %s found, but ifp"
1438 " and/or loc-addr params ignored", peer_buf
);
1446 * Delete functions searches and remove the item from the hash and
1447 * returns a pointer to the removed item data. If the item was not found
1448 * then it returns NULL.
1450 * The data stored inside the hash is not free()ed, so you must do it
1451 * manually after getting the pointer back.
1453 struct bfd_session
*bfd_id_delete(uint32_t id
)
1455 struct bfd_session bs
;
1457 bs
.discrs
.my_discr
= id
;
1459 return hash_release(bfd_id_hash
, &bs
);
1462 struct bfd_session
*bfd_key_delete(struct bfd_key key
)
1464 struct bfd_session bs
, *bsp
;
1467 bsp
= hash_lookup(bfd_key_hash
, &bs
);
1468 if (bsp
== NULL
&& key
.ifname
[0]) {
1469 memset(bs
.key
.ifname
, 0, sizeof(bs
.key
.ifname
));
1470 bsp
= hash_lookup(bfd_key_hash
, &bs
);
1473 return hash_release(bfd_key_hash
, bsp
);
1476 /* Iteration functions. */
1477 void bfd_id_iterate(hash_iter_func hif
, void *arg
)
1479 hash_iterate(bfd_id_hash
, hif
, arg
);
1482 void bfd_key_iterate(hash_iter_func hif
, void *arg
)
1484 hash_iterate(bfd_key_hash
, hif
, arg
);
1490 * Inserts session into hash and returns `true` on success, otherwise
1493 bool bfd_id_insert(struct bfd_session
*bs
)
1495 return (hash_get(bfd_id_hash
, bs
, hash_alloc_intern
) == bs
);
1498 bool bfd_key_insert(struct bfd_session
*bs
)
1500 return (hash_get(bfd_key_hash
, bs
, hash_alloc_intern
) == bs
);
1503 void bfd_initialize(void)
1505 bfd_id_hash
= hash_create(bfd_id_hash_do
, bfd_id_hash_cmp
,
1506 "BFD session discriminator hash");
1507 bfd_key_hash
= hash_create(bfd_key_hash_do
, bfd_key_hash_cmp
,
1508 "BFD session hash");
1511 static void _bfd_free(struct hash_bucket
*hb
,
1512 void *arg
__attribute__((__unused__
)))
1514 struct bfd_session
*bs
= hb
->data
;
1516 bfd_session_free(bs
);
1519 void bfd_shutdown(void)
1522 * Close and free all BFD sessions.
1524 * _bfd_free() will call bfd_session_free() which will take care
1525 * of removing the session from all hashes, so we just run an
1526 * assert() here to make sure it really happened.
1528 bfd_id_iterate(_bfd_free
, NULL
);
1529 assert(bfd_key_hash
->count
== 0);
1531 /* Now free the hashes themselves. */
1532 hash_free(bfd_id_hash
);
1533 hash_free(bfd_key_hash
);
1536 struct bfd_session_iterator
{
1539 const struct bfd_session
*bsi_bs
;
1542 static int _bfd_session_next(struct hash_bucket
*hb
, void *arg
)
1544 struct bfd_session_iterator
*bsi
= arg
;
1545 struct bfd_session
*bs
= hb
->data
;
1547 /* Previous entry signaled stop. */
1548 if (bsi
->bsi_stop
== 1) {
1549 /* Match the single/multi hop sessions. */
1550 if (bs
->key
.mhop
!= bsi
->bsi_mhop
)
1551 return HASHWALK_CONTINUE
;
1554 return HASHWALK_ABORT
;
1557 /* We found the current item, stop in the next one. */
1558 if (bsi
->bsi_bs
== hb
->data
) {
1560 /* Set entry to NULL to signal end of list. */
1562 } else if (bsi
->bsi_bs
== NULL
&& bsi
->bsi_mhop
== bs
->key
.mhop
) {
1563 /* We want the first list item. */
1565 bsi
->bsi_bs
= hb
->data
;
1566 return HASHWALK_ABORT
;
1569 return HASHWALK_CONTINUE
;
1573 * bfd_session_next: uses the current session to find the next.
1575 * `bs` might point to NULL to get the first item of the data structure.
1577 const struct bfd_session
*bfd_session_next(const struct bfd_session
*bs
,
1580 struct bfd_session_iterator bsi
;
1584 bsi
.bsi_mhop
= mhop
;
1585 hash_walk(bfd_key_hash
, _bfd_session_next
, &bsi
);
1586 if (bsi
.bsi_stop
== 0)
1592 static void _bfd_session_remove_manual(struct hash_bucket
*hb
,
1593 void *arg
__attribute__((__unused__
)))
1595 struct bfd_session
*bs
= hb
->data
;
1597 /* Delete only manually configured sessions. */
1598 if (BFD_CHECK_FLAG(bs
->flags
, BFD_SESS_FLAG_CONFIG
) == 0)
1602 BFD_UNSET_FLAG(bs
->flags
, BFD_SESS_FLAG_CONFIG
);
1604 /* Don't delete sessions still in use. */
1605 if (bs
->refcount
!= 0)
1608 bfd_session_free(bs
);
1612 * bfd_sessions_remove_manual: remove all manually configured sessions.
1614 * NOTE: this function doesn't remove automatically created sessions.
1616 void bfd_sessions_remove_manual(void)
1618 hash_iterate(bfd_key_hash
, _bfd_session_remove_manual
, NULL
);
1622 * VRF related functions.
1624 static int bfd_vrf_new(struct vrf
*vrf
)
1626 log_debug("VRF Created: %s(%u)", vrf
->name
, vrf
->vrf_id
);
1630 static int bfd_vrf_delete(struct vrf
*vrf
)
1632 log_debug("VRF Deletion: %s(%u)", vrf
->name
, vrf
->vrf_id
);
1636 static int bfd_vrf_update(struct vrf
*vrf
)
1638 if (!vrf_is_enabled(vrf
))
1640 log_debug("VRF update: %s(%u)", vrf
->name
, vrf
->vrf_id
);
1641 /* a different name is given; update bfd list */
1642 bfdd_sessions_enable_vrf(vrf
);
1646 static int bfd_vrf_enable(struct vrf
*vrf
)
1648 struct bfd_vrf_global
*bvrf
;
1650 /* a different name */
1652 bvrf
= XCALLOC(MTYPE_BFDD_VRF
, sizeof(struct bfd_vrf_global
));
1654 vrf
->info
= (void *)bvrf
;
1657 log_debug("VRF enable add %s id %u", vrf
->name
, vrf
->vrf_id
);
1658 if (vrf
->vrf_id
== VRF_DEFAULT
||
1659 vrf_get_backend() == VRF_BACKEND_NETNS
) {
1661 bvrf
->bg_shop
= bp_udp_shop(vrf
->vrf_id
);
1663 bvrf
->bg_mhop
= bp_udp_mhop(vrf
->vrf_id
);
1664 if (!bvrf
->bg_shop6
)
1665 bvrf
->bg_shop6
= bp_udp6_shop(vrf
->vrf_id
);
1666 if (!bvrf
->bg_mhop6
)
1667 bvrf
->bg_mhop6
= bp_udp6_mhop(vrf
->vrf_id
);
1669 bvrf
->bg_echo
= bp_echo_socket(vrf
->vrf_id
);
1670 if (!bvrf
->bg_echov6
)
1671 bvrf
->bg_echov6
= bp_echov6_socket(vrf
->vrf_id
);
1673 /* Add descriptors to the event loop. */
1674 if (!bvrf
->bg_ev
[0])
1675 thread_add_read(master
, bfd_recv_cb
, bvrf
, bvrf
->bg_shop
,
1677 if (!bvrf
->bg_ev
[1])
1678 thread_add_read(master
, bfd_recv_cb
, bvrf
, bvrf
->bg_mhop
,
1680 if (!bvrf
->bg_ev
[2])
1681 thread_add_read(master
, bfd_recv_cb
, bvrf
, bvrf
->bg_shop6
,
1683 if (!bvrf
->bg_ev
[3])
1684 thread_add_read(master
, bfd_recv_cb
, bvrf
, bvrf
->bg_mhop6
,
1686 if (!bvrf
->bg_ev
[4])
1687 thread_add_read(master
, bfd_recv_cb
, bvrf
, bvrf
->bg_echo
,
1689 if (!bvrf
->bg_ev
[5])
1690 thread_add_read(master
, bfd_recv_cb
, bvrf
, bvrf
->bg_echov6
,
1693 if (vrf
->vrf_id
!= VRF_DEFAULT
) {
1694 bfdd_zclient_register(vrf
->vrf_id
);
1695 bfdd_sessions_enable_vrf(vrf
);
1700 static int bfd_vrf_disable(struct vrf
*vrf
)
1702 struct bfd_vrf_global
*bvrf
;
1708 if (vrf
->vrf_id
!= VRF_DEFAULT
) {
1709 bfdd_sessions_disable_vrf(vrf
);
1710 bfdd_zclient_unregister(vrf
->vrf_id
);
1713 log_debug("VRF disable %s id %d", vrf
->name
, vrf
->vrf_id
);
1715 /* Disable read/write poll triggering. */
1716 THREAD_OFF(bvrf
->bg_ev
[0]);
1717 THREAD_OFF(bvrf
->bg_ev
[1]);
1718 THREAD_OFF(bvrf
->bg_ev
[2]);
1719 THREAD_OFF(bvrf
->bg_ev
[3]);
1720 THREAD_OFF(bvrf
->bg_ev
[4]);
1721 THREAD_OFF(bvrf
->bg_ev
[5]);
1723 /* Close all descriptors. */
1724 socket_close(&bvrf
->bg_echo
);
1725 socket_close(&bvrf
->bg_shop
);
1726 socket_close(&bvrf
->bg_mhop
);
1727 socket_close(&bvrf
->bg_shop6
);
1728 socket_close(&bvrf
->bg_mhop6
);
1729 socket_close(&bvrf
->bg_echo
);
1730 socket_close(&bvrf
->bg_echov6
);
1733 XFREE(MTYPE_BFDD_VRF
, bvrf
);
1739 void bfd_vrf_init(void)
1741 vrf_init(bfd_vrf_new
, bfd_vrf_enable
, bfd_vrf_disable
,
1742 bfd_vrf_delete
, bfd_vrf_update
);
1745 void bfd_vrf_terminate(void)
1750 struct bfd_vrf_global
*bfd_vrf_look_by_session(struct bfd_session
*bfd
)
1754 if (!vrf_is_backend_netns()) {
1755 vrf
= vrf_lookup_by_id(VRF_DEFAULT
);
1757 return (struct bfd_vrf_global
*)vrf
->info
;
1764 return bfd
->vrf
->info
;
1767 void bfd_session_update_vrf_name(struct bfd_session
*bs
, struct vrf
*vrf
)
1772 hash_release(bfd_key_hash
, bs
);
1774 * HACK: Change the BFD VRF in the running configuration directly,
1775 * bypassing the northbound layer. This is necessary to avoid deleting
1776 * the BFD and readding it in the new VRF, which would have
1777 * several implications.
1779 if (yang_module_find("frr-bfdd") && bs
->key
.vrfname
[0]) {
1780 struct lyd_node
*bfd_dnode
;
1781 char xpath
[XPATH_MAXLEN
], xpath_srcaddr
[XPATH_MAXLEN
+ 32];
1782 char addr_buf
[INET6_ADDRSTRLEN
];
1787 inet_ntop(bs
->key
.family
, &bs
->key
.local
, addr_buf
, sizeof(addr_buf
));
1788 snprintf(xpath_srcaddr
, sizeof(xpath_srcaddr
), "[source-addr='%s']",
1791 xpath_srcaddr
[0] = 0;
1792 inet_ntop(bs
->key
.family
, &bs
->key
.peer
, addr_buf
, sizeof(addr_buf
));
1793 slen
= snprintf(xpath
, sizeof(xpath
),
1794 "/frr-bfdd:bfdd/bfd/sessions/%s%s[dest-addr='%s']",
1795 bs
->key
.mhop
? "multi-hop" : "single-hop", xpath_srcaddr
,
1797 if (bs
->key
.ifname
[0])
1798 slen
+= snprintf(xpath
+ slen
, sizeof(xpath
) - slen
,
1799 "[interface='%s']", bs
->key
.ifname
);
1801 slen
+= snprintf(xpath
+ slen
, sizeof(xpath
) - slen
,
1803 snprintf(xpath
+ slen
, sizeof(xpath
) - slen
, "[vrf='%s']/vrf",
1806 bfd_dnode
= yang_dnode_get(running_config
->dnode
, xpath
,
1809 yang_dnode_change_leaf(bfd_dnode
, vrf
->name
);
1810 running_config
->version
++;
1813 memset(bs
->key
.vrfname
, 0, sizeof(bs
->key
.vrfname
));
1814 strlcpy(bs
->key
.vrfname
, vrf
->name
, sizeof(bs
->key
.vrfname
));
1815 hash_get(bfd_key_hash
, bs
, hash_alloc_intern
);