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_QOBJ_TYPE(bfd_session
);
39 static uint32_t ptm_bfd_gen_ID(void);
40 static void ptm_bfd_echo_xmt_TO(struct bfd_session
*bfd
);
41 static void bfd_session_free(struct bfd_session
*bs
);
42 static struct bfd_session
*bfd_session_new(int sd
);
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
);
52 struct bfd_session
*bs_peer_find(struct bfd_peer_cfg
*bpc
)
54 struct bfd_session
*bs
;
55 struct peer_label
*pl
;
56 struct bfd_mhop_key mhop
;
57 struct bfd_shop_key shop
;
59 /* Try to find label first. */
60 if (bpc
->bpc_has_label
) {
61 pl
= pl_find(bpc
->bpc_label
);
68 /* Otherwise fallback to peer/local hash lookup. */
70 memset(&mhop
, 0, sizeof(mhop
));
71 mhop
.peer
= bpc
->bpc_peer
;
72 mhop
.local
= bpc
->bpc_local
;
73 if (bpc
->bpc_has_vrfname
)
74 strlcpy(mhop
.vrf_name
, bpc
->bpc_vrfname
,
75 sizeof(mhop
.vrf_name
));
77 bs
= bfd_mhop_lookup(mhop
);
79 memset(&shop
, 0, sizeof(shop
));
80 shop
.peer
= bpc
->bpc_peer
;
81 if (!bpc
->bpc_has_vxlan
&& bpc
->bpc_has_localif
)
82 strlcpy(shop
.port_name
, bpc
->bpc_localif
,
83 sizeof(shop
.port_name
));
85 bs
= bfd_shop_lookup(shop
);
91 static uint32_t ptm_bfd_gen_ID(void)
93 static uint32_t sessionID
= 1;
98 void ptm_bfd_start_xmt_timer(struct bfd_session
*bfd
, bool is_echo
)
100 uint64_t jitter
, xmt_TO
;
103 xmt_TO
= is_echo
? bfd
->echo_xmt_TO
: bfd
->xmt_TO
;
106 * From section 6.5.2: trasmit interval should be randomly jittered
108 * 75% and 100% of nominal value, unless detect_mult is 1, then should
110 * between 75% and 90%.
112 maxpercent
= (bfd
->detect_mult
== 1) ? 16 : 26;
113 jitter
= (xmt_TO
* (75 + (random() % maxpercent
))) / 100;
114 /* XXX remove that division above */
117 bfd_echo_xmttimer_update(bfd
, jitter
);
119 bfd_xmttimer_update(bfd
, jitter
);
122 static void ptm_bfd_echo_xmt_TO(struct bfd_session
*bfd
)
124 /* Send the scheduled echo packet */
125 ptm_bfd_echo_snd(bfd
);
127 /* Restart the timer for next time */
128 ptm_bfd_start_xmt_timer(bfd
, true);
131 void ptm_bfd_xmt_TO(struct bfd_session
*bfd
, int fbit
)
133 /* Send the scheduled control packet */
134 ptm_bfd_snd(bfd
, fbit
);
136 /* Restart the timer for next time */
137 ptm_bfd_start_xmt_timer(bfd
, false);
140 void ptm_bfd_echo_stop(struct bfd_session
*bfd
, int polling
)
142 bfd
->echo_xmt_TO
= 0;
143 bfd
->echo_detect_TO
= 0;
144 BFD_UNSET_FLAG(bfd
->flags
, BFD_SESS_FLAG_ECHO_ACTIVE
);
146 bfd_echo_xmttimer_delete(bfd
);
147 bfd_echo_recvtimer_delete(bfd
);
150 bfd
->polling
= polling
;
151 bfd
->new_timers
.desired_min_tx
= bfd
->up_min_tx
;
152 bfd
->new_timers
.required_min_rx
= bfd
->timers
.required_min_rx
;
157 void ptm_bfd_echo_start(struct bfd_session
*bfd
)
159 bfd
->echo_detect_TO
= (bfd
->remote_detect_mult
* bfd
->echo_xmt_TO
);
160 ptm_bfd_echo_xmt_TO(bfd
);
163 bfd
->new_timers
.desired_min_tx
= bfd
->up_min_tx
;
164 bfd
->new_timers
.required_min_rx
= bfd
->timers
.required_min_rx
;
168 void ptm_bfd_ses_up(struct bfd_session
*bfd
)
170 int old_state
= bfd
->ses_state
;
173 bfd
->ses_state
= PTM_BFD_UP
;
175 monotime(&bfd
->uptime
);
177 /* If the peer is capable to receiving Echo pkts */
178 if (bfd
->echo_xmt_TO
&& !BFD_CHECK_FLAG(bfd
->flags
, BFD_SESS_FLAG_MH
)) {
179 ptm_bfd_echo_start(bfd
);
181 bfd
->new_timers
.desired_min_tx
= bfd
->up_min_tx
;
182 bfd
->new_timers
.required_min_rx
= bfd
->timers
.required_min_rx
;
188 if (old_state
!= bfd
->ses_state
) {
189 bfd
->stats
.session_up
++;
190 log_info("state-change: [%s] %s -> %s", bs_to_string(bfd
),
191 state_list
[old_state
].str
,
192 state_list
[bfd
->ses_state
].str
);
196 void ptm_bfd_ses_dn(struct bfd_session
*bfd
, uint8_t diag
)
198 int old_state
= bfd
->ses_state
;
200 bfd
->local_diag
= diag
;
201 bfd
->discrs
.remote_discr
= 0;
202 bfd
->ses_state
= PTM_BFD_DOWN
;
204 bfd
->demand_mode
= 0;
205 monotime(&bfd
->downtime
);
209 /* only signal clients when going from up->down state */
210 if (old_state
== PTM_BFD_UP
)
213 /* Stop echo packet transmission if they are active */
214 if (BFD_CHECK_FLAG(bfd
->flags
, BFD_SESS_FLAG_ECHO_ACTIVE
))
215 ptm_bfd_echo_stop(bfd
, 0);
217 if (old_state
!= bfd
->ses_state
) {
218 bfd
->stats
.session_down
++;
219 log_info("state-change: [%s] %s -> %s reason:%s",
220 bs_to_string(bfd
), state_list
[old_state
].str
,
221 state_list
[bfd
->ses_state
].str
,
222 get_diag_str(bfd
->local_diag
));
226 static int ptm_bfd_get_vrf_name(char *port_name
, char *vrf_name
)
228 struct bfd_iface
*iface
;
231 if ((port_name
== NULL
) || (vrf_name
== NULL
))
234 iface
= bfd_iface_lookup(port_name
);
236 vrf
= bfd_vrf_lookup(iface
->vrf_id
);
238 strlcpy(vrf_name
, vrf
->name
, sizeof(vrf
->name
));
245 static struct bfd_session
*bfd_find_disc(struct sockaddr_any
*sa
,
248 struct bfd_session
*bs
;
250 bs
= bfd_id_lookup(ldisc
);
254 /* Remove unused fields. */
255 switch (sa
->sa_sin
.sin_family
) {
257 sa
->sa_sin
.sin_port
= 0;
258 if (memcmp(sa
, &bs
->shop
.peer
, sizeof(sa
->sa_sin
)) == 0)
262 sa
->sa_sin6
.sin6_port
= 0;
263 if (memcmp(sa
, &bs
->shop
.peer
, sizeof(sa
->sa_sin6
)) == 0)
271 struct bfd_session
*ptm_bfd_sess_find(struct bfd_pkt
*cp
, char *port_name
,
272 struct sockaddr_any
*peer
,
273 struct sockaddr_any
*local
,
274 char *vrf_name
, bool is_mhop
)
276 struct bfd_session
*l_bfd
= NULL
;
277 struct bfd_mhop_key mhop
;
278 struct bfd_shop_key shop
;
279 char vrf_buf
[MAXNAMELEN
];
281 /* Find our session using the ID signaled by the remote end. */
282 if (cp
->discrs
.remote_discr
)
283 return bfd_find_disc(peer
, ntohl(cp
->discrs
.remote_discr
));
285 /* Search for session without using discriminator. */
287 memset(&mhop
, 0, sizeof(mhop
));
290 if (vrf_name
&& vrf_name
[0]) {
291 strlcpy(mhop
.vrf_name
, vrf_name
, sizeof(mhop
.vrf_name
));
292 } else if (port_name
&& port_name
[0]) {
293 memset(vrf_buf
, 0, sizeof(vrf_buf
));
294 if (ptm_bfd_get_vrf_name(port_name
, vrf_buf
) != -1)
295 strlcpy(mhop
.vrf_name
, vrf_buf
,
296 sizeof(mhop
.vrf_name
));
299 l_bfd
= bfd_mhop_lookup(mhop
);
301 memset(&shop
, 0, sizeof(shop
));
303 if (port_name
&& port_name
[0])
304 strlcpy(shop
.port_name
, port_name
,
305 sizeof(shop
.port_name
));
307 l_bfd
= bfd_shop_lookup(shop
);
310 /* XXX maybe remoteDiscr should be checked for remoteHeard cases. */
314 #if 0 /* TODO VxLAN Support */
316 _update_vxlan_sess_parms(struct bfd_session
*bfd
, bfd_sess_parms
*sess_parms
)
318 struct bfd_session_vxlan_info
*vxlan_info
= &bfd
->vxlan_info
;
319 bfd_parms_list
*parms
= &sess_parms
->parms
;
321 vxlan_info
->vnid
= parms
->vnid
;
322 vxlan_info
->check_tnl_key
= parms
->check_tnl_key
;
323 vxlan_info
->forwarding_if_rx
= parms
->forwarding_if_rx
;
324 vxlan_info
->cpath_down
= parms
->cpath_down
;
325 vxlan_info
->decay_min_rx
= parms
->decay_min_rx
;
327 inet_aton(parms
->local_dst_ip
, &vxlan_info
->local_dst_ip
);
328 inet_aton(parms
->remote_dst_ip
, &vxlan_info
->peer_dst_ip
);
330 memcpy(vxlan_info
->local_dst_mac
, parms
->local_dst_mac
, ETH_ALEN
);
331 memcpy(vxlan_info
->peer_dst_mac
, parms
->remote_dst_mac
, ETH_ALEN
);
333 /* The interface may change for Vxlan BFD sessions, so update
334 * the local mac and ifindex
336 bfd
->ifindex
= sess_parms
->ifindex
;
337 memcpy(bfd
->local_mac
, sess_parms
->local_mac
, sizeof(bfd
->local_mac
));
339 #endif /* VxLAN support */
341 int bfd_xmt_cb(struct thread
*t
)
343 struct bfd_session
*bs
= THREAD_ARG(t
);
345 ptm_bfd_xmt_TO(bs
, 0);
350 int bfd_echo_xmt_cb(struct thread
*t
)
352 struct bfd_session
*bs
= THREAD_ARG(t
);
354 ptm_bfd_echo_xmt_TO(bs
);
359 /* Was ptm_bfd_detect_TO() */
360 int bfd_recvtimer_cb(struct thread
*t
)
362 struct bfd_session
*bs
= THREAD_ARG(t
);
364 switch (bs
->ses_state
) {
367 ptm_bfd_ses_dn(bs
, BFD_DIAGDETECTTIME
);
368 bfd_recvtimer_update(bs
);
372 /* Second detect time expiration, zero remote discr (section
375 bs
->discrs
.remote_discr
= 0;
382 /* Was ptm_bfd_echo_detect_TO() */
383 int bfd_echo_recvtimer_cb(struct thread
*t
)
385 struct bfd_session
*bs
= THREAD_ARG(t
);
387 switch (bs
->ses_state
) {
390 ptm_bfd_ses_dn(bs
, BFD_DIAGDETECTTIME
);
397 static struct bfd_session
*bfd_session_new(int sd
)
399 struct bfd_session
*bs
;
401 bs
= XCALLOC(MTYPE_BFDD_CONFIG
, sizeof(*bs
));
405 QOBJ_REG(bs
, bfd_session
);
407 bs
->up_min_tx
= BFD_DEFDESIREDMINTX
;
408 bs
->timers
.required_min_rx
= BFD_DEFREQUIREDMINRX
;
409 bs
->timers
.required_min_echo
= BFD_DEF_REQ_MIN_ECHO
;
410 bs
->detect_mult
= BFD_DEFDETECTMULT
;
411 bs
->mh_ttl
= BFD_DEF_MHOP_TTL
;
414 monotime(&bs
->uptime
);
415 bs
->downtime
= bs
->uptime
;
420 int bfd_session_update_label(struct bfd_session
*bs
, const char *nlabel
)
422 /* New label treatment:
423 * - Check if the label is taken;
424 * - Try to allocate the memory for it and register;
426 if (bs
->pl
== NULL
) {
427 if (pl_find(nlabel
) != NULL
) {
428 /* Someone is already using it. */
432 if (pl_new(nlabel
, bs
) == NULL
)
439 * Test label change consistency:
440 * - Do nothing if it's the same label;
441 * - Check if the future label is already taken;
444 if (strcmp(nlabel
, bs
->pl
->pl_label
) == 0)
446 if (pl_find(nlabel
) != NULL
)
449 strlcpy(bs
->pl
->pl_label
, nlabel
, sizeof(bs
->pl
->pl_label
));
453 static void _bfd_session_update(struct bfd_session
*bs
,
454 struct bfd_peer_cfg
*bpc
)
457 /* Check if echo mode is already active. */
458 if (BFD_CHECK_FLAG(bs
->flags
, BFD_SESS_FLAG_ECHO
))
461 BFD_SET_FLAG(bs
->flags
, BFD_SESS_FLAG_ECHO
);
462 ptm_bfd_echo_start(bs
);
464 /* Activate/update echo receive timeout timer. */
465 bfd_echo_recvtimer_update(bs
);
467 /* Check if echo mode is already disabled. */
468 if (!BFD_CHECK_FLAG(bs
->flags
, BFD_SESS_FLAG_ECHO
))
471 BFD_UNSET_FLAG(bs
->flags
, BFD_SESS_FLAG_ECHO
);
472 ptm_bfd_echo_stop(bs
, 0);
476 if (bpc
->bpc_has_txinterval
)
477 bs
->up_min_tx
= bpc
->bpc_txinterval
* 1000;
479 if (bpc
->bpc_has_recvinterval
)
480 bs
->timers
.required_min_rx
= bpc
->bpc_recvinterval
* 1000;
482 if (bpc
->bpc_has_detectmultiplier
)
483 bs
->detect_mult
= bpc
->bpc_detectmultiplier
;
485 if (bpc
->bpc_has_echointerval
)
486 bs
->timers
.required_min_echo
= bpc
->bpc_echointerval
* 1000;
488 if (bpc
->bpc_has_label
)
489 bfd_session_update_label(bs
, bpc
->bpc_label
);
491 if (bpc
->bpc_shutdown
) {
492 /* Check if already shutdown. */
493 if (BFD_CHECK_FLAG(bs
->flags
, BFD_SESS_FLAG_SHUTDOWN
))
496 BFD_SET_FLAG(bs
->flags
, BFD_SESS_FLAG_SHUTDOWN
);
498 /* Disable all events. */
499 bfd_recvtimer_delete(bs
);
500 bfd_echo_recvtimer_delete(bs
);
501 bfd_xmttimer_delete(bs
);
502 bfd_echo_xmttimer_delete(bs
);
504 /* Change and notify state change. */
505 bs
->ses_state
= PTM_BFD_ADM_DOWN
;
510 /* Check if already working. */
511 if (!BFD_CHECK_FLAG(bs
->flags
, BFD_SESS_FLAG_SHUTDOWN
))
514 BFD_UNSET_FLAG(bs
->flags
, BFD_SESS_FLAG_SHUTDOWN
);
516 /* Change and notify state change. */
517 bs
->ses_state
= PTM_BFD_DOWN
;
520 /* Enable all timers. */
521 bfd_recvtimer_update(bs
);
522 bfd_xmttimer_update(bs
, bs
->xmt_TO
);
523 if (BFD_CHECK_FLAG(bs
->flags
, BFD_SESS_FLAG_ECHO
)) {
524 bfd_echo_recvtimer_update(bs
);
525 bfd_echo_xmttimer_update(bs
, bs
->echo_xmt_TO
);
530 static int bfd_session_update(struct bfd_session
*bs
, struct bfd_peer_cfg
*bpc
)
532 /* User didn't want to update, return failure. */
533 if (bpc
->bpc_createonly
)
536 _bfd_session_update(bs
, bpc
);
538 /* TODO add VxLAN support. */
540 control_notify_config(BCM_NOTIFY_CONFIG_UPDATE
, bs
);
545 static void bfd_session_free(struct bfd_session
*bs
)
550 bfd_recvtimer_delete(bs
);
551 bfd_echo_recvtimer_delete(bs
);
552 bfd_xmttimer_delete(bs
);
553 bfd_echo_xmttimer_delete(bs
);
555 bfd_id_delete(bs
->discrs
.my_discr
);
556 if (BFD_CHECK_FLAG(bs
->flags
, BFD_SESS_FLAG_MH
))
557 bfd_mhop_delete(bs
->mhop
);
559 bfd_shop_delete(bs
->shop
);
564 XFREE(MTYPE_BFDD_CONFIG
, bs
);
567 struct bfd_session
*ptm_bfd_sess_new(struct bfd_peer_cfg
*bpc
)
569 struct bfd_session
*bfd
, *l_bfd
;
572 /* check to see if this needs a new session */
573 l_bfd
= bs_peer_find(bpc
);
575 /* Requesting a duplicated peer means update configuration. */
576 if (bfd_session_update(l_bfd
, bpc
) == 0)
583 * Get socket for transmitting control packets. Note that if we
584 * could use the destination port (3784) for the source
585 * port we wouldn't need a socket per session.
588 psock
= bp_peer_socket(bpc
);
592 psock
= bp_peer_socketv6(bpc
);
598 bfd
= bfd_session_new(psock
);
600 log_error("session-new: allocation failed");
604 if (bpc
->bpc_has_localif
&& !bpc
->bpc_mhop
) {
605 bfd
->ifindex
= ptm_bfd_fetch_ifindex(bpc
->bpc_localif
);
606 ptm_bfd_fetch_local_mac(bpc
->bpc_localif
, bfd
->local_mac
);
609 if (bpc
->bpc_has_vxlan
)
610 BFD_SET_FLAG(bfd
->flags
, BFD_SESS_FLAG_VXLAN
);
612 if (bpc
->bpc_ipv4
== false) {
613 BFD_SET_FLAG(bfd
->flags
, BFD_SESS_FLAG_IPV6
);
615 /* Set the IPv6 scope id for link-local addresses. */
616 if (IN6_IS_ADDR_LINKLOCAL(&bpc
->bpc_local
.sa_sin6
.sin6_addr
))
617 bpc
->bpc_local
.sa_sin6
.sin6_scope_id
= bfd
->ifindex
;
618 if (IN6_IS_ADDR_LINKLOCAL(&bpc
->bpc_peer
.sa_sin6
.sin6_addr
))
619 bpc
->bpc_peer
.sa_sin6
.sin6_scope_id
= bfd
->ifindex
;
622 /* Initialize the session */
623 bfd
->ses_state
= PTM_BFD_DOWN
;
624 bfd
->discrs
.my_discr
= ptm_bfd_gen_ID();
625 bfd
->discrs
.remote_discr
= 0;
626 bfd
->local_ip
= bpc
->bpc_local
;
627 bfd
->local_address
= bpc
->bpc_local
;
628 bfd
->timers
.desired_min_tx
= bfd
->up_min_tx
;
629 bfd
->detect_TO
= (bfd
->detect_mult
* BFD_DEF_SLOWTX
);
631 /* Use detect_TO first for slow detection, then use recvtimer_update. */
632 bfd_recvtimer_update(bfd
);
637 BFD_SET_FLAG(bfd
->flags
, BFD_SESS_FLAG_MH
);
638 bfd
->mhop
.peer
= bpc
->bpc_peer
;
639 bfd
->mhop
.local
= bpc
->bpc_local
;
640 if (bpc
->bpc_has_vrfname
)
641 strlcpy(bfd
->mhop
.vrf_name
, bpc
->bpc_vrfname
,
642 sizeof(bfd
->mhop
.vrf_name
));
644 bfd_mhop_insert(bfd
);
646 bfd
->shop
.peer
= bpc
->bpc_peer
;
647 if (!bpc
->bpc_has_vxlan
&& bpc
->bpc_has_localif
)
648 strlcpy(bfd
->shop
.port_name
, bpc
->bpc_localif
,
649 sizeof(bfd
->shop
.port_name
));
651 bfd_shop_insert(bfd
);
654 if (BFD_CHECK_FLAG(bfd
->flags
, BFD_SESS_FLAG_VXLAN
)) {
655 static uint8_t bfd_def_vxlan_dmac
[] = {0x00, 0x23, 0x20,
657 memcpy(bfd
->peer_mac
, bfd_def_vxlan_dmac
,
658 sizeof(bfd_def_vxlan_dmac
));
661 else if (event
->rmac
) {
662 if (sscanf(event
->rmac
, "%hhx:%hhx:%hhx:%hhx:%hhx:%hhx",
663 &bfd
->peer_mac
[0], &bfd
->peer_mac
[1], &bfd
->peer_mac
[2],
664 &bfd
->peer_mac
[3], &bfd
->peer_mac
[4], &bfd
->peer_mac
[5])
666 DLOG("%s: Assigning remote mac = %s", __func__
,
672 * XXX: session update triggers echo start, so we must have our
673 * discriminator ID set first.
675 _bfd_session_update(bfd
, bpc
);
677 /* Start transmitting with slow interval until peer responds */
678 bfd
->xmt_TO
= BFD_DEF_SLOWTX
;
680 ptm_bfd_xmt_TO(bfd
, 0);
682 log_info("session-new: %s", bs_to_string(bfd
));
684 control_notify_config(BCM_NOTIFY_CONFIG_ADD
, bfd
);
689 int ptm_bfd_ses_del(struct bfd_peer_cfg
*bpc
)
691 struct bfd_session
*bs
;
693 /* Find session and call free(). */
694 bs
= bs_peer_find(bpc
);
698 /* This pointer is being referenced, don't let it be deleted. */
699 if (bs
->refcount
> 0) {
700 log_error("session-delete: refcount failure: %" PRIu64
706 log_info("session-delete: %s", bs_to_string(bs
));
708 control_notify_config(BCM_NOTIFY_CONFIG_DELETE
, bs
);
710 bfd_session_free(bs
);
715 void bfd_set_polling(struct bfd_session
*bs
)
717 bs
->new_timers
.desired_min_tx
= bs
->up_min_tx
;
718 bs
->new_timers
.required_min_rx
= bs
->timers
.required_min_rx
;
719 bs
->new_timers
.required_min_echo
= bs
->timers
.required_min_echo
;
727 static const char *get_diag_str(int diag
)
729 for (int i
= 0; diag_list
[i
].str
; i
++) {
730 if (diag_list
[i
].type
== diag
)
731 return diag_list
[i
].str
;
736 const char *satostr(struct sockaddr_any
*sa
)
738 #define INETSTR_BUFCOUNT 8
739 static char buf
[INETSTR_BUFCOUNT
][INET6_ADDRSTRLEN
];
741 struct sockaddr_in
*sin
= &sa
->sa_sin
;
742 struct sockaddr_in6
*sin6
= &sa
->sa_sin6
;
744 bufidx
+= (bufidx
+ 1) % INETSTR_BUFCOUNT
;
747 switch (sin
->sin_family
) {
749 inet_ntop(AF_INET
, &sin
->sin_addr
, buf
[bufidx
],
750 sizeof(buf
[bufidx
]));
753 inet_ntop(AF_INET6
, &sin6
->sin6_addr
, buf
[bufidx
],
754 sizeof(buf
[bufidx
]));
758 strlcpy(buf
[bufidx
], "unknown", sizeof(buf
[bufidx
]));
765 const char *diag2str(uint8_t diag
)
771 return "control detection time expired";
773 return "echo function failed";
775 return "neighbor signaled session down";
777 return "forwarding plane reset";
781 return "concatenated path down";
783 return "administratively down";
785 return "reverse concatenated path down";
791 int strtosa(const char *addr
, struct sockaddr_any
*sa
)
793 memset(sa
, 0, sizeof(*sa
));
795 if (inet_pton(AF_INET
, addr
, &sa
->sa_sin
.sin_addr
) == 1) {
796 sa
->sa_sin
.sin_family
= AF_INET
;
797 #ifdef HAVE_STRUCT_SOCKADDR_SA_LEN
798 sa
->sa_sin
.sin_len
= sizeof(sa
->sa_sin
);
799 #endif /* HAVE_STRUCT_SOCKADDR_SA_LEN */
803 if (inet_pton(AF_INET6
, addr
, &sa
->sa_sin6
.sin6_addr
) == 1) {
804 sa
->sa_sin6
.sin6_family
= AF_INET6
;
805 #ifdef HAVE_STRUCT_SOCKADDR_SA_LEN
806 sa
->sa_sin6
.sin6_len
= sizeof(sa
->sa_sin6
);
807 #endif /* HAVE_STRUCT_SOCKADDR_SA_LEN */
814 void integer2timestr(uint64_t time
, char *buf
, size_t buflen
)
816 unsigned int year
, month
, day
, hour
, minute
, second
;
820 #define HOURS (24 * MINUTES)
821 #define DAYS (30 * HOURS)
822 #define MONTHS (12 * DAYS)
823 #define YEARS (MONTHS)
826 time
-= year
* YEARS
;
828 rv
= snprintf(buf
, buflen
, "%u year(s), ", year
);
832 if (time
>= MONTHS
) {
833 month
= time
/ MONTHS
;
834 time
-= month
* MONTHS
;
836 rv
= snprintf(buf
, buflen
, "%u month(s), ", month
);
844 rv
= snprintf(buf
, buflen
, "%u day(s), ", day
);
850 time
-= hour
* HOURS
;
852 rv
= snprintf(buf
, buflen
, "%u hour(s), ", hour
);
856 if (time
>= MINUTES
) {
857 minute
= time
/ MINUTES
;
858 time
-= minute
* MINUTES
;
860 rv
= snprintf(buf
, buflen
, "%u minute(s), ", minute
);
864 second
= time
% MINUTES
;
865 snprintf(buf
, buflen
, "%u second(s)", second
);
868 const char *bs_to_string(struct bfd_session
*bs
)
870 static char buf
[256];
872 bool is_mhop
= BFD_CHECK_FLAG(bs
->flags
, BFD_SESS_FLAG_MH
);
874 pos
= snprintf(buf
, sizeof(buf
), "mhop:%s", is_mhop
? "yes" : "no");
875 if (BFD_CHECK_FLAG(bs
->flags
, BFD_SESS_FLAG_MH
)) {
876 pos
+= snprintf(buf
+ pos
, sizeof(buf
) - pos
,
877 " peer:%s local:%s", satostr(&bs
->mhop
.peer
),
878 satostr(&bs
->mhop
.local
));
880 if (bs
->mhop
.vrf_name
[0])
881 snprintf(buf
+ pos
, sizeof(buf
) - pos
, " vrf:%s",
884 pos
+= snprintf(buf
+ pos
, sizeof(buf
) - pos
, " peer:%s",
885 satostr(&bs
->shop
.peer
));
887 if (bs
->local_address
.sa_sin
.sin_family
)
888 pos
+= snprintf(buf
+ pos
, sizeof(buf
) - pos
,
890 satostr(&bs
->local_address
));
892 if (bs
->shop
.port_name
[0])
893 snprintf(buf
+ pos
, sizeof(buf
) - pos
, " interface:%s",
902 * BFD hash data structures to find sessions.
904 static struct hash
*bfd_id_hash
;
905 static struct hash
*bfd_shop_hash
;
906 static struct hash
*bfd_mhop_hash
;
907 static struct hash
*bfd_vrf_hash
;
908 static struct hash
*bfd_iface_hash
;
910 static unsigned int bfd_id_hash_do(void *p
);
911 static int bfd_id_hash_cmp(const void *n1
, const void *n2
);
912 static unsigned int bfd_shop_hash_do(void *p
);
913 static int bfd_shop_hash_cmp(const void *n1
, const void *n2
);
914 static unsigned int bfd_mhop_hash_do(void *p
);
915 static int bfd_mhop_hash_cmp(const void *n1
, const void *n2
);
916 static unsigned int bfd_vrf_hash_do(void *p
);
917 static int bfd_vrf_hash_cmp(const void *n1
, const void *n2
);
918 static unsigned int bfd_iface_hash_do(void *p
);
919 static int bfd_iface_hash_cmp(const void *n1
, const void *n2
);
921 static void _shop_key(struct bfd_session
*bs
, const struct bfd_shop_key
*shop
);
922 static void _shop_key2(struct bfd_session
*bs
, const struct bfd_shop_key
*shop
);
923 static void _mhop_key(struct bfd_session
*bs
, const struct bfd_mhop_key
*mhop
);
924 static int _iface_key(struct bfd_iface
*iface
, const char *ifname
);
926 static void _bfd_free(struct hash_backet
*hb
,
927 void *arg
__attribute__((__unused__
)));
928 static void _vrf_free(void *arg
);
929 static void _iface_free(void *arg
);
931 /* BFD hash for our discriminator. */
932 static unsigned int bfd_id_hash_do(void *p
)
934 struct bfd_session
*bs
= p
;
936 return jhash_1word(bs
->discrs
.my_discr
, 0);
939 static int bfd_id_hash_cmp(const void *n1
, const void *n2
)
941 const struct bfd_session
*bs1
= n1
, *bs2
= n2
;
943 return bs1
->discrs
.my_discr
== bs2
->discrs
.my_discr
;
946 /* BFD hash for single hop. */
947 static unsigned int bfd_shop_hash_do(void *p
)
949 struct bfd_session
*bs
= p
;
951 return jhash(&bs
->shop
, sizeof(bs
->shop
), 0);
954 static int bfd_shop_hash_cmp(const void *n1
, const void *n2
)
956 const struct bfd_session
*bs1
= n1
, *bs2
= n2
;
958 return memcmp(&bs1
->shop
, &bs2
->shop
, sizeof(bs1
->shop
)) == 0;
961 /* BFD hash for multi hop. */
962 static unsigned int bfd_mhop_hash_do(void *p
)
964 struct bfd_session
*bs
= p
;
966 return jhash(&bs
->mhop
, sizeof(bs
->mhop
), 0);
969 static int bfd_mhop_hash_cmp(const void *n1
, const void *n2
)
971 const struct bfd_session
*bs1
= n1
, *bs2
= n2
;
973 return memcmp(&bs1
->mhop
, &bs2
->mhop
, sizeof(bs1
->mhop
)) == 0;
976 /* BFD hash for VRFs. */
977 static unsigned int bfd_vrf_hash_do(void *p
)
979 struct bfd_vrf
*vrf
= p
;
981 return jhash_1word(vrf
->vrf_id
, 0);
984 static int bfd_vrf_hash_cmp(const void *n1
, const void *n2
)
986 const struct bfd_vrf
*v1
= n1
, *v2
= n2
;
988 return v1
->vrf_id
== v2
->vrf_id
;
991 /* BFD hash for interfaces. */
992 static unsigned int bfd_iface_hash_do(void *p
)
994 struct bfd_iface
*iface
= p
;
996 return string_hash_make(iface
->ifname
);
999 static int bfd_iface_hash_cmp(const void *n1
, const void *n2
)
1001 const struct bfd_iface
*i1
= n1
, *i2
= n2
;
1003 return strcmp(i1
->ifname
, i2
->ifname
) == 0;
1006 /* Helper functions */
1007 static void _shop_key(struct bfd_session
*bs
, const struct bfd_shop_key
*shop
)
1011 /* Remove unused fields. */
1012 switch (bs
->shop
.peer
.sa_sin
.sin_family
) {
1014 bs
->shop
.peer
.sa_sin
.sin_port
= 0;
1017 bs
->shop
.peer
.sa_sin6
.sin6_port
= 0;
1022 static void _shop_key2(struct bfd_session
*bs
, const struct bfd_shop_key
*shop
)
1024 _shop_key(bs
, shop
);
1025 memset(bs
->shop
.port_name
, 0, sizeof(bs
->shop
.port_name
));
1028 static void _mhop_key(struct bfd_session
*bs
, const struct bfd_mhop_key
*mhop
)
1032 /* Remove unused fields. */
1033 switch (bs
->mhop
.peer
.sa_sin
.sin_family
) {
1035 bs
->mhop
.peer
.sa_sin
.sin_port
= 0;
1036 bs
->mhop
.local
.sa_sin
.sin_port
= 0;
1039 bs
->mhop
.peer
.sa_sin6
.sin6_port
= 0;
1040 bs
->mhop
.local
.sa_sin6
.sin6_port
= 0;
1045 static int _iface_key(struct bfd_iface
*iface
, const char *ifname
)
1047 size_t slen
= sizeof(iface
->ifname
);
1049 memset(iface
->ifname
, 0, slen
);
1050 if (strlcpy(iface
->ifname
, ifname
, slen
) >= slen
)
1057 * Hash public interface / exported functions.
1060 /* Lookup functions. */
1061 struct bfd_session
*bfd_id_lookup(uint32_t id
)
1063 struct bfd_session bs
;
1065 bs
.discrs
.my_discr
= id
;
1067 return hash_lookup(bfd_id_hash
, &bs
);
1070 struct bfd_session
*bfd_shop_lookup(struct bfd_shop_key shop
)
1072 struct bfd_session bs
, *bsp
;
1074 _shop_key(&bs
, &shop
);
1076 bsp
= hash_lookup(bfd_shop_hash
, &bs
);
1077 if (bsp
== NULL
&& bs
.shop
.port_name
[0] != 0) {
1079 * Since the local interface spec is optional, try
1080 * searching the key without it as well.
1082 _shop_key2(&bs
, &shop
);
1083 bsp
= hash_lookup(bfd_shop_hash
, &bs
);
1089 struct bfd_session
*bfd_mhop_lookup(struct bfd_mhop_key mhop
)
1091 struct bfd_session bs
;
1093 _mhop_key(&bs
, &mhop
);
1095 return hash_lookup(bfd_shop_hash
, &bs
);
1098 struct bfd_vrf
*bfd_vrf_lookup(int vrf_id
)
1102 vrf
.vrf_id
= vrf_id
;
1104 return hash_lookup(bfd_vrf_hash
, &vrf
);
1107 struct bfd_iface
*bfd_iface_lookup(const char *ifname
)
1109 struct bfd_iface iface
;
1111 if (_iface_key(&iface
, ifname
) != 0)
1114 return hash_lookup(bfd_iface_hash
, &iface
);
1120 * Delete functions searches and remove the item from the hash and
1121 * returns a pointer to the removed item data. If the item was not found
1122 * then it returns NULL.
1124 * The data stored inside the hash is not free()ed, so you must do it
1125 * manually after getting the pointer back.
1127 struct bfd_session
*bfd_id_delete(uint32_t id
)
1129 struct bfd_session bs
;
1131 bs
.discrs
.my_discr
= id
;
1133 return hash_release(bfd_id_hash
, &bs
);
1136 struct bfd_session
*bfd_shop_delete(struct bfd_shop_key shop
)
1138 struct bfd_session bs
, *bsp
;
1140 _shop_key(&bs
, &shop
);
1141 bsp
= hash_release(bfd_shop_hash
, &bs
);
1142 if (bsp
== NULL
&& shop
.port_name
[0] != 0) {
1144 * Since the local interface spec is optional, try
1145 * searching the key without it as well.
1147 _shop_key2(&bs
, &shop
);
1148 bsp
= hash_release(bfd_shop_hash
, &bs
);
1154 struct bfd_session
*bfd_mhop_delete(struct bfd_mhop_key mhop
)
1156 struct bfd_session bs
;
1158 _mhop_key(&bs
, &mhop
);
1160 return hash_release(bfd_mhop_hash
, &bs
);
1163 struct bfd_vrf
*bfd_vrf_delete(int vrf_id
)
1167 vrf
.vrf_id
= vrf_id
;
1169 return hash_release(bfd_vrf_hash
, &vrf
);
1172 struct bfd_iface
*bfd_iface_delete(const char *ifname
)
1174 struct bfd_iface iface
;
1176 if (_iface_key(&iface
, ifname
) != 0)
1179 return hash_release(bfd_iface_hash
, &iface
);
1182 /* Iteration functions. */
1183 void bfd_id_iterate(hash_iter_func hif
, void *arg
)
1185 hash_iterate(bfd_id_hash
, hif
, arg
);
1188 void bfd_shop_iterate(hash_iter_func hif
, void *arg
)
1190 hash_iterate(bfd_shop_hash
, hif
, arg
);
1193 void bfd_mhop_iterate(hash_iter_func hif
, void *arg
)
1195 hash_iterate(bfd_mhop_hash
, hif
, arg
);
1198 void bfd_vrf_iterate(hash_iter_func hif
, void *arg
)
1200 hash_iterate(bfd_vrf_hash
, hif
, arg
);
1203 void bfd_iface_iterate(hash_iter_func hif
, void *arg
)
1205 hash_iterate(bfd_iface_hash
, hif
, arg
);
1211 * Inserts session into hash and returns `true` on success, otherwise
1214 bool bfd_id_insert(struct bfd_session
*bs
)
1216 return (hash_get(bfd_id_hash
, bs
, hash_alloc_intern
) == bs
);
1219 bool bfd_shop_insert(struct bfd_session
*bs
)
1221 return (hash_get(bfd_shop_hash
, bs
, hash_alloc_intern
) == bs
);
1224 bool bfd_mhop_insert(struct bfd_session
*bs
)
1226 return (hash_get(bfd_mhop_hash
, bs
, hash_alloc_intern
) == bs
);
1229 bool bfd_vrf_insert(struct bfd_vrf
*vrf
)
1231 return (hash_get(bfd_vrf_hash
, vrf
, hash_alloc_intern
) == vrf
);
1234 bool bfd_iface_insert(struct bfd_iface
*iface
)
1236 return (hash_get(bfd_iface_hash
, iface
, hash_alloc_intern
) == iface
);
1239 void bfd_initialize(void)
1241 bfd_id_hash
= hash_create(bfd_id_hash_do
, bfd_id_hash_cmp
,
1242 "BFD discriminator hash");
1243 bfd_shop_hash
= hash_create(bfd_shop_hash_do
, bfd_shop_hash_cmp
,
1244 "BFD single hop hash");
1245 bfd_mhop_hash
= hash_create(bfd_mhop_hash_do
, bfd_mhop_hash_cmp
,
1246 "BFD multihop hop hash");
1248 hash_create(bfd_vrf_hash_do
, bfd_vrf_hash_cmp
, "BFD VRF hash");
1249 bfd_iface_hash
= hash_create(bfd_iface_hash_do
, bfd_iface_hash_cmp
,
1250 "BFD interface hash");
1253 static void _bfd_free(struct hash_backet
*hb
,
1254 void *arg
__attribute__((__unused__
)))
1256 struct bfd_session
*bs
= hb
->data
;
1258 bfd_session_free(bs
);
1261 static void _vrf_free(void *arg
)
1263 struct bfd_vrf
*vrf
= arg
;
1265 XFREE(MTYPE_BFDD_CONFIG
, vrf
);
1268 static void _iface_free(void *arg
)
1270 struct bfd_iface
*iface
= arg
;
1272 XFREE(MTYPE_BFDD_CONFIG
, iface
);
1275 void bfd_shutdown(void)
1278 * Close and free all BFD sessions.
1280 * _bfd_free() will call bfd_session_free() which will take care
1281 * of removing the session from all hashes, so we just run an
1282 * assert() here to make sure it really happened.
1284 bfd_id_iterate(_bfd_free
, NULL
);
1285 assert(bfd_shop_hash
->count
== 0);
1286 assert(bfd_mhop_hash
->count
== 0);
1288 /* Clean the VRF and interface hashes. */
1289 hash_clean(bfd_vrf_hash
, _vrf_free
);
1290 hash_clean(bfd_iface_hash
, _iface_free
);
1292 /* Now free the hashes themselves. */
1293 hash_free(bfd_id_hash
);
1294 hash_free(bfd_shop_hash
);
1295 hash_free(bfd_mhop_hash
);
1296 hash_free(bfd_vrf_hash
);
1297 hash_free(bfd_iface_hash
);