1 /*********************************************************************
2 * Copyright 2014,2015,2016,2017 Cumulus Networks, Inc. All rights reserved.
4 * This program is free software; you can redistribute it and/or modify it
5 * under the terms of the GNU General Public License as published by the Free
6 * Software Foundation; either version 2 of the License, or (at your option)
9 * This program is distributed in the hope that it will be useful, but WITHOUT
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
14 * You should have received a copy of the GNU General Public License along
15 * with this program; see the file COPYING; if not, write to the Free Software
16 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
18 * bfd.h: implements the BFD protocol.
24 #include <netinet/in.h>
31 #include "lib/libfrr.h"
33 #include "lib/queue.h"
37 #define ETHERNET_ADDRESS_LENGTH 6
40 #define BFDD_JSON_CONV_OPTIONS (JSON_C_TO_STRING_PRETTY)
42 #define BFDD_JSON_CONV_OPTIONS (0)
46 DECLARE_MTYPE(BFDD_TMP
);
47 DECLARE_MTYPE(BFDD_CONFIG
);
48 DECLARE_MTYPE(BFDD_LABEL
);
49 DECLARE_MTYPE(BFDD_CONTROL
);
50 DECLARE_MTYPE(BFDD_NOTIFICATION
);
53 uint32_t desired_min_tx
;
54 uint32_t required_min_rx
;
55 uint32_t required_min_echo
;
60 uint32_t remote_discr
;
64 * Format of control packet. From section 4)
76 struct bfd_discrs discrs
;
77 struct bfd_timers timers
;
81 * Format of Echo packet.
97 /* Macros for manipulating control packets */
98 #define BFD_VERMASK 0x03
99 #define BFD_DIAGMASK 0x1F
100 #define BFD_GETVER(diag) ((diag >> 5) & BFD_VERMASK)
101 #define BFD_SETVER(diag, val) ((diag) |= (val & BFD_VERMASK) << 5)
102 #define BFD_VERSION 1
103 #define BFD_PBIT 0x20
104 #define BFD_FBIT 0x10
105 #define BFD_CBIT 0x08
106 #define BFD_ABIT 0x04
107 #define BFD_DEMANDBIT 0x02
108 #define BFD_DIAGNEIGHDOWN 3
109 #define BFD_DIAGDETECTTIME 1
110 #define BFD_DIAGADMINDOWN 7
111 #define BFD_SETDEMANDBIT(flags, val) \
114 flags |= BFD_DEMANDBIT; \
116 #define BFD_SETPBIT(flags, val) \
121 #define BFD_GETPBIT(flags) (flags & BFD_PBIT)
122 #define BFD_SETFBIT(flags, val) \
127 #define BFD_GETFBIT(flags) (flags & BFD_FBIT)
128 #define BFD_SETSTATE(flags, val) \
131 flags |= (val & 0x3) << 6; \
133 #define BFD_GETSTATE(flags) ((flags >> 6) & 0x3)
134 #define BFD_ECHO_VERSION 1
135 #define BFD_ECHO_PKT_LEN sizeof(struct bfd_echo_pkt)
136 #define BFD_CTRL_PKT_LEN sizeof(struct bfd_pkt)
137 #define IP_HDR_LEN 20
138 #define UDP_HDR_LEN 8
139 #define ETH_HDR_LEN 14
140 #define VXLAN_HDR_LEN 8
141 #define HEADERS_MIN_LEN (ETH_HDR_LEN + IP_HDR_LEN + UDP_HDR_LEN)
142 #define BFD_ECHO_PKT_TOT_LEN \
143 ((int)(ETH_HDR_LEN + IP_HDR_LEN + UDP_HDR_LEN + BFD_ECHO_PKT_LEN))
144 #define BFD_VXLAN_PKT_TOT_LEN \
145 ((int)(VXLAN_HDR_LEN + ETH_HDR_LEN + IP_HDR_LEN + UDP_HDR_LEN \
147 #define BFD_RX_BUF_LEN 160
149 /* BFD session flags */
150 enum bfd_session_flags
{
151 BFD_SESS_FLAG_NONE
= 0,
152 BFD_SESS_FLAG_ECHO
= 1 << 0, /* BFD Echo functionality */
153 BFD_SESS_FLAG_ECHO_ACTIVE
= 1 << 1, /* BFD Echo Packets are being sent
156 BFD_SESS_FLAG_MH
= 1 << 2, /* BFD Multi-hop session */
157 BFD_SESS_FLAG_VXLAN
= 1 << 3, /* BFD Multi-hop session which is
158 * used to monitor vxlan tunnel
160 BFD_SESS_FLAG_IPV6
= 1 << 4, /* BFD IPv6 session */
161 BFD_SESS_FLAG_SEND_EVT_ACTIVE
= 1 << 5, /* send event timer active */
162 BFD_SESS_FLAG_SEND_EVT_IGNORE
= 1 << 6, /* ignore send event when timer
165 BFD_SESS_FLAG_SHUTDOWN
= 1 << 7, /* disable BGP peer function */
168 #define BFD_SET_FLAG(field, flag) (field |= flag)
169 #define BFD_UNSET_FLAG(field, flag) (field &= ~flag)
170 #define BFD_CHECK_FLAG(field, flag) (field & flag)
172 /* BFD session hash keys */
173 struct bfd_shop_key
{
174 struct sockaddr_any peer
;
175 char port_name
[MAXNAMELEN
+ 1];
178 struct bfd_mhop_key
{
179 struct sockaddr_any peer
;
180 struct sockaddr_any local
;
181 char vrf_name
[MAXNAMELEN
+ 1];
184 struct bfd_session_stats
{
185 uint64_t rx_ctrl_pkt
;
186 uint64_t tx_ctrl_pkt
;
187 uint64_t rx_echo_pkt
;
188 uint64_t tx_echo_pkt
;
191 struct bfd_session_vxlan_info
{
193 uint32_t decay_min_rx
;
194 uint8_t forwarding_if_rx
;
196 uint8_t check_tnl_key
;
197 uint8_t local_dst_mac
[ETHERNET_ADDRESS_LENGTH
];
198 uint8_t peer_dst_mac
[ETHERNET_ADDRESS_LENGTH
];
199 struct in_addr local_dst_ip
;
200 struct in_addr peer_dst_ip
;
203 /* bfd_session shortcut label forwarding. */
207 * Session state information
211 /* protocol state per RFC 5880*/
213 struct bfd_discrs discrs
;
217 uint8_t remote_detect_mult
;
221 struct bfd_timers timers
;
222 struct bfd_timers new_timers
;
225 struct thread
*echo_recvtimer_ev
;
226 struct thread
*recvtimer_ev
;
228 uint64_t echo_xmt_TO
;
229 struct thread
*xmttimer_ev
;
230 struct thread
*echo_xmttimer_ev
;
231 uint64_t echo_detect_TO
;
233 /* software object state */
236 /* This and the localDiscr are the keys to state info */
237 struct peer_label
*pl
;
239 struct bfd_shop_key shop
;
240 struct bfd_mhop_key mhop
;
244 struct sockaddr_any local_address
;
245 struct sockaddr_any local_ip
;
247 uint8_t local_mac
[ETHERNET_ADDRESS_LENGTH
];
248 uint8_t peer_mac
[ETHERNET_ADDRESS_LENGTH
];
251 /* BFD session flags */
252 enum bfd_session_flags flags
;
254 uint8_t echo_pkt
[BFD_ECHO_PKT_TOT_LEN
]; /* Save the Echo Packet
255 * which will be transmitted
257 struct bfd_session_stats stats
;
258 struct bfd_session_vxlan_info vxlan_info
;
260 struct timeval uptime
; /* last up time */
261 struct timeval downtime
; /* last down time */
263 /* Remote peer data (for debugging mostly) */
265 struct bfd_timers remote_timers
;
267 uint64_t refcount
; /* number of pointers referencing this. */
269 /* VTY context data. */
272 DECLARE_QOBJ_TYPE(bfd_session
);
275 TAILQ_ENTRY(peer_label
) pl_entry
;
277 struct bfd_session
*pl_bs
;
278 char pl_label
[MAXNAMELEN
];
280 TAILQ_HEAD(pllist
, peer_label
);
282 struct bfd_diag_str_list
{
287 struct bfd_state_str_list
{
294 char name
[MAXNAMELEN
+ 1];
299 char ifname
[MAXNAMELEN
+ 1];
303 /* States defined per 4.1 */
304 #define PTM_BFD_ADM_DOWN 0
305 #define PTM_BFD_DOWN 1
306 #define PTM_BFD_INIT 2
310 /* Various constants */
311 /* Retrieved from ptm_timer.h from Cumulus PTM sources. */
312 #define MSEC_PER_SEC 1000L
313 #define NSEC_PER_MSEC 1000000L
315 #define BFD_DEF_DEMAND 0
316 #define BFD_DEFDETECTMULT 3
317 #define BFD_DEFDESIREDMINTX (300 * MSEC_PER_SEC)
318 #define BFD_DEFREQUIREDMINRX (300 * MSEC_PER_SEC)
319 #define BFD_DEF_REQ_MIN_ECHO (50 * MSEC_PER_SEC)
320 #define BFD_DEF_SLOWTX (2000 * MSEC_PER_SEC)
321 #define BFD_DEF_MHOP_TTL 5
322 #define BFD_PKT_LEN 24 /* Length of control packet */
323 #define BFD_TTL_VAL 255
324 #define BFD_RCV_TTL_VAL 1
325 #define BFD_TOS_VAL 0xC0
326 #define BFD_PKT_INFO_VAL 1
327 #define BFD_IPV6_PKT_INFO_VAL 1
328 #define BFD_IPV6_ONLY_VAL 1
329 #define BFD_SRCPORTINIT 49142
330 #define BFD_SRCPORTMAX 65536
331 #define BFD_DEFDESTPORT 3784
332 #define BFD_DEF_ECHO_PORT 3785
333 #define BFD_DEF_MHOP_DEST_PORT 4784
334 #define BFD_CMD_STRING_LEN (MAXNAMELEN + 50)
335 #define BFD_BUFFER_LEN (BFD_CMD_STRING_LEN + MAXNAMELEN + 1)
340 * Daemon control code to speak with local consumers.
343 /* See 'bfdctrl.h' for client protocol definitions. */
345 struct bfd_control_buffer
{
349 struct bfd_control_msg
*bcb_bcm
;
354 struct bfd_control_queue
{
355 TAILQ_ENTRY(bfd_control_queue
) bcq_entry
;
357 struct bfd_control_buffer bcq_bcb
;
359 TAILQ_HEAD(bcqueue
, bfd_control_queue
);
361 struct bfd_notify_peer
{
362 TAILQ_ENTRY(bfd_notify_peer
) bnp_entry
;
364 struct bfd_session
*bnp_bs
;
366 TAILQ_HEAD(bnplist
, bfd_notify_peer
);
368 struct bfd_control_socket
{
369 TAILQ_ENTRY(bfd_control_socket
) bcs_entry
;
372 struct thread
*bcs_ev
;
373 struct thread
*bcs_outev
;
374 struct bcqueue bcs_bcqueue
;
376 /* Notification data */
378 struct bnplist bcs_bnplist
;
380 enum bc_msg_version bcs_version
;
381 enum bc_msg_type bcs_type
;
383 /* Message buffering */
384 struct bfd_control_buffer bcs_bin
;
385 struct bfd_control_buffer
*bcs_bout
;
387 TAILQ_HEAD(bcslist
, bfd_control_socket
);
389 int control_init(const char *path
);
390 void control_shutdown(void);
391 int control_notify(struct bfd_session
*bs
);
392 int control_notify_config(const char *op
, struct bfd_session
*bs
);
393 int control_accept(struct thread
*t
);
399 * Daemon specific code.
408 struct thread
*bg_ev
[6];
411 struct thread
*bg_csockev
;
412 struct bcslist bg_bcslist
;
414 struct pllist bg_pllist
;
416 extern struct bfd_global bglobal
;
417 extern struct bfd_diag_str_list diag_list
[];
418 extern struct bfd_state_str_list state_list
[];
420 void socket_close(int *s
);
426 * Contains the code related with loading/reloading configuration.
428 int parse_config(const char *fname
);
429 int config_request_add(const char *jsonstr
);
430 int config_request_del(const char *jsonstr
);
431 char *config_response(const char *status
, const char *error
);
432 char *config_notify(struct bfd_session
*bs
);
433 char *config_notify_config(const char *op
, struct bfd_session
*bs
);
435 typedef int (*bpc_handle
)(struct bfd_peer_cfg
*, void *arg
);
436 int config_notify_request(struct bfd_control_socket
*bcs
, const char *jsonstr
,
439 struct peer_label
*pl_new(const char *label
, struct bfd_session
*bs
);
440 struct peer_label
*pl_find(const char *label
);
441 void pl_free(struct peer_label
*pl
);
447 * Contains code that does the logging procedures. Might implement multiple
448 * backends (e.g. zebra log, syslog or other logging lib).
451 /* level vs syslog equivalent */
452 BLOG_DEBUG
= 0, /* LOG_DEBUG */
453 BLOG_INFO
= 1, /* LOG_INFO */
454 BLOG_WARNING
= 2, /* LOG_WARNING */
455 BLOG_ERROR
= 3, /* LOG_ERR */
456 BLOG_FATAL
= 4, /* LOG_CRIT */
459 void log_init(int foreground
, enum blog_level level
,
460 struct frr_daemon_info
*fdi
);
461 void log_info(const char *fmt
, ...);
462 void log_debug(const char *fmt
, ...);
463 void log_warning(const char *fmt
, ...);
464 void log_error(const char *fmt
, ...);
465 void log_fatal(const char *fmt
, ...);
471 * Contains the code related with receiving/seding, packing/unpacking BFD data.
473 int bp_set_ttlv6(int sd
);
474 int bp_set_ttl(int sd
);
475 int bp_set_tosv6(int sd
);
476 int bp_set_tos(int sd
);
477 int bp_bind_dev(int sd
, const char *dev
);
479 int bp_udp_shop(void);
480 int bp_udp_mhop(void);
481 int bp_udp6_shop(void);
482 int bp_udp6_mhop(void);
483 int bp_peer_socket(struct bfd_peer_cfg
*bpc
);
484 int bp_peer_socketv6(struct bfd_peer_cfg
*bpc
);
486 void ptm_bfd_snd(struct bfd_session
*bfd
, int fbit
);
487 void ptm_bfd_echo_snd(struct bfd_session
*bfd
);
489 int bfd_recv_cb(struct thread
*t
);
491 uint16_t checksum(uint16_t *buf
, int len
);
497 * Contains the code related with event loop.
499 typedef void (*bfd_ev_cb
)(struct thread
*t
);
501 void bfd_recvtimer_update(struct bfd_session
*bs
);
502 void bfd_echo_recvtimer_update(struct bfd_session
*bs
);
503 void bfd_xmttimer_update(struct bfd_session
*bs
, uint64_t jitter
);
504 void bfd_echo_xmttimer_update(struct bfd_session
*bs
, uint64_t jitter
);
506 void bfd_xmttimer_delete(struct bfd_session
*bs
);
507 void bfd_echo_xmttimer_delete(struct bfd_session
*bs
);
508 void bfd_recvtimer_delete(struct bfd_session
*bs
);
509 void bfd_echo_recvtimer_delete(struct bfd_session
*bs
);
511 void bfd_recvtimer_assign(struct bfd_session
*bs
, bfd_ev_cb cb
, int sd
);
512 void bfd_echo_recvtimer_assign(struct bfd_session
*bs
, bfd_ev_cb cb
, int sd
);
513 void bfd_xmttimer_assign(struct bfd_session
*bs
, bfd_ev_cb cb
);
514 void bfd_echo_xmttimer_assign(struct bfd_session
*bs
, bfd_ev_cb cb
);
520 * BFD protocol specific code.
522 struct bfd_session
*ptm_bfd_sess_new(struct bfd_peer_cfg
*bpc
);
523 int ptm_bfd_ses_del(struct bfd_peer_cfg
*bpc
);
524 void ptm_bfd_ses_dn(struct bfd_session
*bfd
, uint8_t diag
);
525 void ptm_bfd_ses_up(struct bfd_session
*bfd
);
526 void fetch_portname_from_ifindex(int ifindex
, char *ifname
, size_t ifnamelen
);
527 void ptm_bfd_echo_stop(struct bfd_session
*bfd
, int polling
);
528 void ptm_bfd_echo_start(struct bfd_session
*bfd
);
529 void ptm_bfd_xmt_TO(struct bfd_session
*bfd
, int fbit
);
530 void ptm_bfd_start_xmt_timer(struct bfd_session
*bfd
, bool is_echo
);
531 struct bfd_session
*ptm_bfd_sess_find(struct bfd_pkt
*cp
, char *port_name
,
532 struct sockaddr_any
*peer
,
533 struct sockaddr_any
*local
,
534 char *vrf_name
, bool is_mhop
);
536 struct bfd_session
*bs_peer_find(struct bfd_peer_cfg
*bpc
);
537 int bfd_session_update_label(struct bfd_session
*bs
, const char *nlabel
);
538 void bfd_set_polling(struct bfd_session
*bs
);
539 const char *satostr(struct sockaddr_any
*sa
);
540 const char *diag2str(uint8_t diag
);
541 int strtosa(const char *addr
, struct sockaddr_any
*sa
);
542 void integer2timestr(uint64_t time
, char *buf
, size_t buflen
);
543 const char *bs_to_string(struct bfd_session
*bs
);
545 /* BFD hash data structures interface */
546 void bfd_initialize(void);
547 void bfd_shutdown(void);
548 struct bfd_session
*bfd_id_lookup(uint32_t id
);
549 struct bfd_session
*bfd_shop_lookup(struct bfd_shop_key shop
);
550 struct bfd_session
*bfd_mhop_lookup(struct bfd_mhop_key mhop
);
551 struct bfd_vrf
*bfd_vrf_lookup(int vrf_id
);
552 struct bfd_iface
*bfd_iface_lookup(const char *ifname
);
554 struct bfd_session
*bfd_id_delete(uint32_t id
);
555 struct bfd_session
*bfd_shop_delete(struct bfd_shop_key shop
);
556 struct bfd_session
*bfd_mhop_delete(struct bfd_mhop_key mhop
);
557 struct bfd_vrf
*bfd_vrf_delete(int vrf_id
);
558 struct bfd_iface
*bfd_iface_delete(const char *ifname
);
560 bool bfd_id_insert(struct bfd_session
*bs
);
561 bool bfd_shop_insert(struct bfd_session
*bs
);
562 bool bfd_mhop_insert(struct bfd_session
*bs
);
563 bool bfd_vrf_insert(struct bfd_vrf
*vrf
);
564 bool bfd_iface_insert(struct bfd_iface
*iface
);
566 typedef void (*hash_iter_func
)(struct hash_backet
*hb
, void *arg
);
567 void bfd_id_iterate(hash_iter_func hif
, void *arg
);
568 void bfd_shop_iterate(hash_iter_func hif
, void *arg
);
569 void bfd_mhop_iterate(hash_iter_func hif
, void *arg
);
570 void bfd_vrf_iterate(hash_iter_func hif
, void *arg
);
571 void bfd_iface_iterate(hash_iter_func hif
, void *arg
);
573 /* Export callback functions for `event.c`. */
574 extern struct thread_master
*master
;
576 int bfd_recvtimer_cb(struct thread
*t
);
577 int bfd_echo_recvtimer_cb(struct thread
*t
);
578 int bfd_xmt_cb(struct thread
*t
);
579 int bfd_echo_xmt_cb(struct thread
*t
);
585 * BFD daemon vty shell commands.
587 void bfdd_vty_init(void);
593 void bfdd_zclient_init(struct zebra_privs_t
*bfdd_priv
);
594 void bfdd_zclient_stop(void);
596 int ptm_bfd_notify(struct bfd_session
*bs
);
600 * OS compatibility functions.
602 struct udp_psuedo_header
{
610 #define UDP_PSUEDO_HDR_LEN sizeof(struct udp_psuedo_header)
612 #if defined(BFD_LINUX) || defined(BFD_BSD)
613 int ptm_bfd_fetch_ifindex(const char *ifname
);
614 void ptm_bfd_fetch_local_mac(const char *ifname
, uint8_t *mac
);
615 void fetch_portname_from_ifindex(int ifindex
, char *ifname
, size_t ifnamelen
);
616 int ptm_bfd_echo_sock_init(void);
617 int ptm_bfd_vxlan_sock_init(void);
618 #endif /* BFD_LINUX || BFD_BSD */
621 uint16_t udp4_checksum(struct iphdr
*iph
, uint8_t *buf
, int len
);
622 #endif /* BFD_LINUX */
625 uint16_t udp4_checksum(struct ip
*ip
, uint8_t *buf
, int len
);
626 ssize_t
bsd_echo_sock_read(int sd
, uint8_t *buf
, ssize_t
*buflen
,
627 struct sockaddr_storage
*ss
, socklen_t
*sslen
,
628 uint8_t *ttl
, uint32_t *id
);