]> git.proxmox.com Git - mirror_frr.git/blob - bfdd/bfd.h
Merge pull request #2805 from opensourcerouting/malloc-size
[mirror_frr.git] / bfdd / bfd.h
1 /*********************************************************************
2 * Copyright 2014,2015,2016,2017 Cumulus Networks, Inc. All rights reserved.
3 *
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)
7 * any later version.
8 *
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
12 * more details.
13 *
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
17 *
18 * bfd.h: implements the BFD protocol.
19 */
20
21 #ifndef _BFD_H_
22 #define _BFD_H_
23
24 #include <netinet/in.h>
25
26 #include <stdbool.h>
27 #include <stdarg.h>
28 #include <stdint.h>
29
30 #include "lib/hash.h"
31 #include "lib/libfrr.h"
32 #include "lib/qobj.h"
33 #include "lib/queue.h"
34
35 #include "bfdctl.h"
36
37 #define ETHERNET_ADDRESS_LENGTH 6
38
39 #ifdef BFD_DEBUG
40 #define BFDD_JSON_CONV_OPTIONS (JSON_C_TO_STRING_PRETTY)
41 #else
42 #define BFDD_JSON_CONV_OPTIONS (0)
43 #endif
44
45 DECLARE_MGROUP(BFDD);
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);
51
52 struct bfd_timers {
53 uint32_t desired_min_tx;
54 uint32_t required_min_rx;
55 uint32_t required_min_echo;
56 };
57
58 struct bfd_discrs {
59 uint32_t my_discr;
60 uint32_t remote_discr;
61 };
62
63 /*
64 * Format of control packet. From section 4)
65 */
66 struct bfd_pkt {
67 union {
68 uint32_t byteFields;
69 struct {
70 uint8_t diag;
71 uint8_t flags;
72 uint8_t detect_mult;
73 uint8_t len;
74 };
75 };
76 struct bfd_discrs discrs;
77 struct bfd_timers timers;
78 };
79
80 /*
81 * Format of Echo packet.
82 */
83 struct bfd_echo_pkt {
84 union {
85 uint32_t byteFields;
86 struct {
87 uint8_t ver;
88 uint8_t len;
89 uint16_t reserved;
90 };
91 };
92 uint32_t my_discr;
93 uint8_t pad[16];
94 };
95
96
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) \
112 { \
113 if ((val)) \
114 flags |= BFD_DEMANDBIT; \
115 }
116 #define BFD_SETPBIT(flags, val) \
117 { \
118 if ((val)) \
119 flags |= BFD_PBIT; \
120 }
121 #define BFD_GETPBIT(flags) (flags & BFD_PBIT)
122 #define BFD_SETFBIT(flags, val) \
123 { \
124 if ((val)) \
125 flags |= BFD_FBIT; \
126 }
127 #define BFD_GETFBIT(flags) (flags & BFD_FBIT)
128 #define BFD_SETSTATE(flags, val) \
129 { \
130 if ((val)) \
131 flags |= (val & 0x3) << 6; \
132 }
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 \
146 + BFD_CTRL_PKT_LEN))
147 #define BFD_RX_BUF_LEN 160
148
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
154 * actively
155 */
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
159 */
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
163 * expires
164 */
165 BFD_SESS_FLAG_SHUTDOWN = 1 << 7, /* disable BGP peer function */
166 };
167
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)
171
172 /* BFD session hash keys */
173 struct bfd_shop_key {
174 struct sockaddr_any peer;
175 char port_name[MAXNAMELEN + 1];
176 };
177
178 struct bfd_mhop_key {
179 struct sockaddr_any peer;
180 struct sockaddr_any local;
181 char vrf_name[MAXNAMELEN + 1];
182 };
183
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;
189 };
190
191 struct bfd_session_vxlan_info {
192 uint32_t vnid;
193 uint32_t decay_min_rx;
194 uint8_t forwarding_if_rx;
195 uint8_t cpath_down;
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;
201 };
202
203 /* bfd_session shortcut label forwarding. */
204 struct peer_label;
205
206 /*
207 * Session state information
208 */
209 struct bfd_session {
210
211 /* protocol state per RFC 5880*/
212 uint8_t ses_state;
213 struct bfd_discrs discrs;
214 uint8_t local_diag;
215 uint8_t demand_mode;
216 uint8_t detect_mult;
217 uint8_t remote_detect_mult;
218 uint8_t mh_ttl;
219
220 /* Timers */
221 struct bfd_timers timers;
222 struct bfd_timers new_timers;
223 uint32_t up_min_tx;
224 uint64_t detect_TO;
225 struct thread *echo_recvtimer_ev;
226 struct thread *recvtimer_ev;
227 uint64_t xmt_TO;
228 uint64_t echo_xmt_TO;
229 struct thread *xmttimer_ev;
230 struct thread *echo_xmttimer_ev;
231 uint64_t echo_detect_TO;
232
233 /* software object state */
234 uint8_t polling;
235
236 /* This and the localDiscr are the keys to state info */
237 struct peer_label *pl;
238 union {
239 struct bfd_shop_key shop;
240 struct bfd_mhop_key mhop;
241 };
242 int sock;
243
244 struct sockaddr_any local_address;
245 struct sockaddr_any local_ip;
246 int ifindex;
247 uint8_t local_mac[ETHERNET_ADDRESS_LENGTH];
248 uint8_t peer_mac[ETHERNET_ADDRESS_LENGTH];
249 uint16_t ip_id;
250
251 /* BFD session flags */
252 enum bfd_session_flags flags;
253
254 uint8_t echo_pkt[BFD_ECHO_PKT_TOT_LEN]; /* Save the Echo Packet
255 * which will be transmitted
256 */
257 struct bfd_session_stats stats;
258 struct bfd_session_vxlan_info vxlan_info;
259
260 struct timeval uptime; /* last up time */
261 struct timeval downtime; /* last down time */
262
263 /* Remote peer data (for debugging mostly) */
264 uint8_t remote_diag;
265 struct bfd_timers remote_timers;
266
267 uint64_t refcount; /* number of pointers referencing this. */
268
269 /* VTY context data. */
270 QOBJ_FIELDS;
271 };
272 DECLARE_QOBJ_TYPE(bfd_session);
273
274 struct peer_label {
275 TAILQ_ENTRY(peer_label) pl_entry;
276
277 struct bfd_session *pl_bs;
278 char pl_label[MAXNAMELEN];
279 };
280 TAILQ_HEAD(pllist, peer_label);
281
282 struct bfd_diag_str_list {
283 const char *str;
284 int type;
285 };
286
287 struct bfd_state_str_list {
288 const char *str;
289 int type;
290 };
291
292 struct bfd_vrf {
293 int vrf_id;
294 char name[MAXNAMELEN + 1];
295 } bfd_vrf;
296
297 struct bfd_iface {
298 int vrf_id;
299 char ifname[MAXNAMELEN + 1];
300 } bfd_iface;
301
302
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
307 #define PTM_BFD_UP 3
308
309
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
314
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)
336
337 /*
338 * control.c
339 *
340 * Daemon control code to speak with local consumers.
341 */
342
343 /* See 'bfdctrl.h' for client protocol definitions. */
344
345 struct bfd_control_buffer {
346 size_t bcb_left;
347 size_t bcb_pos;
348 union {
349 struct bfd_control_msg *bcb_bcm;
350 uint8_t *bcb_buf;
351 };
352 };
353
354 struct bfd_control_queue {
355 TAILQ_ENTRY(bfd_control_queue) bcq_entry;
356
357 struct bfd_control_buffer bcq_bcb;
358 };
359 TAILQ_HEAD(bcqueue, bfd_control_queue);
360
361 struct bfd_notify_peer {
362 TAILQ_ENTRY(bfd_notify_peer) bnp_entry;
363
364 struct bfd_session *bnp_bs;
365 };
366 TAILQ_HEAD(bnplist, bfd_notify_peer);
367
368 struct bfd_control_socket {
369 TAILQ_ENTRY(bfd_control_socket) bcs_entry;
370
371 int bcs_sd;
372 struct thread *bcs_ev;
373 struct thread *bcs_outev;
374 struct bcqueue bcs_bcqueue;
375
376 /* Notification data */
377 uint64_t bcs_notify;
378 struct bnplist bcs_bnplist;
379
380 enum bc_msg_version bcs_version;
381 enum bc_msg_type bcs_type;
382
383 /* Message buffering */
384 struct bfd_control_buffer bcs_bin;
385 struct bfd_control_buffer *bcs_bout;
386 };
387 TAILQ_HEAD(bcslist, bfd_control_socket);
388
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);
394
395
396 /*
397 * bfdd.c
398 *
399 * Daemon specific code.
400 */
401 struct bfd_global {
402 int bg_shop;
403 int bg_mhop;
404 int bg_shop6;
405 int bg_mhop6;
406 int bg_echo;
407 int bg_vxlan;
408 struct thread *bg_ev[6];
409
410 int bg_csock;
411 struct thread *bg_csockev;
412 struct bcslist bg_bcslist;
413
414 struct pllist bg_pllist;
415 };
416 extern struct bfd_global bglobal;
417 extern struct bfd_diag_str_list diag_list[];
418 extern struct bfd_state_str_list state_list[];
419
420 void socket_close(int *s);
421
422
423 /*
424 * config.c
425 *
426 * Contains the code related with loading/reloading configuration.
427 */
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);
434
435 typedef int (*bpc_handle)(struct bfd_peer_cfg *, void *arg);
436 int config_notify_request(struct bfd_control_socket *bcs, const char *jsonstr,
437 bpc_handle bh);
438
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);
442
443
444 /*
445 * log.c
446 *
447 * Contains code that does the logging procedures. Might implement multiple
448 * backends (e.g. zebra log, syslog or other logging lib).
449 */
450 enum blog_level {
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 */
457 };
458
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, ...);
466
467
468 /*
469 * bfd_packet.c
470 *
471 * Contains the code related with receiving/seding, packing/unpacking BFD data.
472 */
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);
478
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);
485
486 void ptm_bfd_snd(struct bfd_session *bfd, int fbit);
487 void ptm_bfd_echo_snd(struct bfd_session *bfd);
488
489 int bfd_recv_cb(struct thread *t);
490
491 uint16_t checksum(uint16_t *buf, int len);
492
493
494 /*
495 * event.c
496 *
497 * Contains the code related with event loop.
498 */
499 typedef void (*bfd_ev_cb)(struct thread *t);
500
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);
505
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);
510
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);
515
516
517 /*
518 * bfd.c
519 *
520 * BFD protocol specific code.
521 */
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);
535
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);
544
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);
553
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);
559
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);
565
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);
572
573 /* Export callback functions for `event.c`. */
574 extern struct thread_master *master;
575
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);
580
581
582 /*
583 * bfdd_vty.c
584 *
585 * BFD daemon vty shell commands.
586 */
587 void bfdd_vty_init(void);
588
589
590 /*
591 * ptm_adapter.c
592 */
593 void bfdd_zclient_init(struct zebra_privs_t *bfdd_priv);
594 void bfdd_zclient_stop(void);
595
596 int ptm_bfd_notify(struct bfd_session *bs);
597
598
599 /*
600 * OS compatibility functions.
601 */
602 struct udp_psuedo_header {
603 uint32_t saddr;
604 uint32_t daddr;
605 uint8_t reserved;
606 uint8_t protocol;
607 uint16_t len;
608 };
609
610 #define UDP_PSUEDO_HDR_LEN sizeof(struct udp_psuedo_header)
611
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 */
619
620 #ifdef BFD_LINUX
621 uint16_t udp4_checksum(struct iphdr *iph, uint8_t *buf, int len);
622 #endif /* BFD_LINUX */
623
624 #ifdef BFD_BSD
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);
629 #endif /* BFD_BSD */
630
631 #endif /* _BFD_H_ */