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 #include "lib/vrf.h"
  35
  36 #include "bfdctl.h"
  37
  38 #ifdef BFD_DEBUG
  39 #define BFDD_JSON_CONV_OPTIONS (JSON_C_TO_STRING_PRETTY)
  40 #else
  41 #define BFDD_JSON_CONV_OPTIONS (0)
  42 #endif
  43
  44 DECLARE_MGROUP(BFDD)
  45 DECLARE_MTYPE(BFDD_CONTROL)
  46 DECLARE_MTYPE(BFDD_NOTIFICATION)
  47
  48 struct bfd_timers {
  49         uint32_t desired_min_tx;
  50         uint32_t required_min_rx;
  51         uint32_t required_min_echo;
  52 };
  53
  54 struct bfd_discrs {
  55         uint32_t my_discr;
  56         uint32_t remote_discr;
  57 };
  58
  59 /*
  60  * Format of control packet.  From section 4)
  61  */
  62 struct bfd_pkt {
  63         union {
  64                 uint32_t byteFields;
  65                 struct {
  66                         uint8_t diag;
  67                         uint8_t flags;
  68                         uint8_t detect_mult;
  69                         uint8_t len;
  70                 };
  71         };
  72         struct bfd_discrs discrs;
  73         struct bfd_timers timers;
  74 };
  75
  76 /*
  77  * Format of Echo packet.
  78  */
  79 struct bfd_echo_pkt {
  80         union {
  81                 uint32_t byteFields;
  82                 struct {
  83                         uint8_t ver;
  84                         uint8_t len;
  85                         uint16_t reserved;
  86                 };
  87         };
  88         uint32_t my_discr;
  89         uint8_t pad[16];
  90 };
  91
  92
  93 /* Macros for manipulating control packets */
  94 #define BFD_VERMASK 0x03
  95 #define BFD_DIAGMASK 0x1F
  96 #define BFD_GETVER(diag) ((diag >> 5) & BFD_VERMASK)
  97 #define BFD_SETVER(diag, val) ((diag) |= (val & BFD_VERMASK) << 5)
  98 #define BFD_VERSION 1
  99 #define BFD_PBIT 0x20
 100 #define BFD_FBIT 0x10
 101 #define BFD_CBIT 0x08
 102 #define BFD_ABIT 0x04
 103 #define BFD_DEMANDBIT 0x02
 104 #define BFD_SETDEMANDBIT(flags, val)                                           \
 105         {                                                                      \
 106                 if ((val))                                                     \
 107                         flags |= BFD_DEMANDBIT;                                \
 108         }
 109 #define BFD_SETPBIT(flags, val)                                                \
 110         {                                                                      \
 111                 if ((val))                                                     \
 112                         flags |= BFD_PBIT;                                     \
 113         }
 114 #define BFD_GETPBIT(flags) (flags & BFD_PBIT)
 115 #define BFD_SETFBIT(flags, val)                                                \
 116         {                                                                      \
 117                 if ((val))                                                     \
 118                         flags |= BFD_FBIT;                                     \
 119         }
 120 #define BFD_GETFBIT(flags) (flags & BFD_FBIT)
 121 #define BFD_SETSTATE(flags, val)                                               \
 122         {                                                                      \
 123                 if ((val))                                                     \
 124                         flags |= (val & 0x3) << 6;                             \
 125         }
 126 #define BFD_GETSTATE(flags) ((flags >> 6) & 0x3)
 127 #define BFD_SETCBIT(flags, val)                                                \
 128         {                                                                      \
 129                 if ((val))                                                     \
 130                         flags |= val;                                          \
 131         }
 132 #define BFD_GETCBIT(flags) (flags & BFD_FBIT)
 133 #define BFD_ECHO_VERSION 1
 134 #define BFD_ECHO_PKT_LEN sizeof(struct bfd_echo_pkt)
 135
 136 enum bfd_diagnosticis {
 137         BD_OK = 0,
 138         /* Control Detection Time Expired. */
 139         BD_CONTROL_EXPIRED = 1,
 140         /* Echo Function Failed. */
 141         BD_ECHO_FAILED = 2,
 142         /* Neighbor Signaled Session Down. */
 143         BD_NEIGHBOR_DOWN = 3,
 144         /* Forwarding Plane Reset. */
 145         BD_FORWARDING_RESET = 4,
 146         /* Path Down. */
 147         BD_PATH_DOWN = 5,
 148         /* Concatenated Path Down. */
 149         BD_CONCATPATH_DOWN = 6,
 150         /* Administratively Down. */
 151         BD_ADMIN_DOWN = 7,
 152         /* Reverse Concatenated Path Down. */
 153         BD_REVCONCATPATH_DOWN = 8,
 154         /* 9..31: reserved. */
 155 };
 156
 157 /* BFD session flags */
 158 enum bfd_session_flags {
 159         BFD_SESS_FLAG_NONE = 0,
 160         BFD_SESS_FLAG_ECHO = 1 << 0,    /* BFD Echo functionality */
 161         BFD_SESS_FLAG_ECHO_ACTIVE = 1 << 1, /* BFD Echo Packets are being sent
 162                                              * actively
 163                                              */
 164         BFD_SESS_FLAG_MH = 1 << 2,        /* BFD Multi-hop session */
 165         BFD_SESS_FLAG_IPV6 = 1 << 4,    /* BFD IPv6 session */
 166         BFD_SESS_FLAG_SEND_EVT_ACTIVE = 1 << 5, /* send event timer active */
 167         BFD_SESS_FLAG_SEND_EVT_IGNORE = 1 << 6, /* ignore send event when timer
 168                                                  * expires
 169                                                  */
 170         BFD_SESS_FLAG_SHUTDOWN = 1 << 7,        /* disable BGP peer function */
 171         BFD_SESS_FLAG_CONFIG = 1 << 8,  /* Session configured with bfd NB API */
 172         BFD_SESS_FLAG_CBIT = 1 << 9,    /* CBIT is set */
 173 };
 174
 175 #define BFD_SET_FLAG(field, flag) (field |= flag)
 176 #define BFD_UNSET_FLAG(field, flag) (field &= ~flag)
 177 #define BFD_CHECK_FLAG(field, flag) (field & flag)
 178
 179 /* BFD session hash keys */
 180 struct bfd_key {
 181         uint16_t family;
 182         uint8_t mhop;
 183         struct in6_addr peer;
 184         struct in6_addr local;
 185         char ifname[MAXNAMELEN];
 186         char vrfname[MAXNAMELEN];
 187 };
 188
 189 struct bfd_session_stats {
 190         uint64_t rx_ctrl_pkt;
 191         uint64_t tx_ctrl_pkt;
 192         uint64_t rx_echo_pkt;
 193         uint64_t tx_echo_pkt;
 194         uint64_t session_up;
 195         uint64_t session_down;
 196         uint64_t znotification;
 197 };
 198
 199 /* bfd_session shortcut label forwarding. */
 200 struct peer_label;
 201
 202 /*
 203  * Session state information
 204  */
 205 struct bfd_session {
 206
 207         /* protocol state per RFC 5880*/
 208         uint8_t ses_state;
 209         struct bfd_discrs discrs;
 210         uint8_t local_diag;
 211         uint8_t demand_mode;
 212         uint8_t detect_mult;
 213         uint8_t remote_detect_mult;
 214         uint8_t mh_ttl;
 215         uint8_t remote_cbit;
 216
 217         /* Timers */
 218         struct bfd_timers timers;
 219         struct bfd_timers cur_timers;
 220         uint64_t detect_TO;
 221         struct thread *echo_recvtimer_ev;
 222         struct thread *recvtimer_ev;
 223         uint64_t xmt_TO;
 224         uint64_t echo_xmt_TO;
 225         struct thread *xmttimer_ev;
 226         struct thread *echo_xmttimer_ev;
 227         uint64_t echo_detect_TO;
 228
 229         /* software object state */
 230         uint8_t polling;
 231
 232         /* This and the localDiscr are the keys to state info */
 233         struct bfd_key key;
 234         struct peer_label *pl;
 235
 236         struct sockaddr_any local_address;
 237         struct interface *ifp;
 238         struct vrf *vrf;
 239
 240         int sock;
 241
 242         /* BFD session flags */
 243         enum bfd_session_flags flags;
 244
 245         struct bfd_session_stats stats;
 246
 247         struct timeval uptime;   /* last up time */
 248         struct timeval downtime; /* last down time */
 249
 250         /* Remote peer data (for debugging mostly) */
 251         uint8_t remote_diag;
 252         struct bfd_timers remote_timers;
 253
 254         uint64_t refcount; /* number of pointers referencing this. */
 255 };
 256
 257 struct peer_label {
 258         TAILQ_ENTRY(peer_label) pl_entry;
 259
 260         struct bfd_session *pl_bs;
 261         char pl_label[MAXNAMELEN];
 262 };
 263 TAILQ_HEAD(pllist, peer_label);
 264
 265 struct bfd_diag_str_list {
 266         const char *str;
 267         int type;
 268 };
 269
 270 struct bfd_state_str_list {
 271         const char *str;
 272         int type;
 273 };
 274
 275 struct bfd_session_observer {
 276         struct bfd_session *bso_bs;
 277         char bso_entryname[MAXNAMELEN];
 278         struct prefix bso_addr;
 279
 280         TAILQ_ENTRY(bfd_session_observer) bso_entry;
 281 };
 282 TAILQ_HEAD(obslist, bfd_session_observer);
 283
 284
 285 /* States defined per 4.1 */
 286 #define PTM_BFD_ADM_DOWN 0
 287 #define PTM_BFD_DOWN 1
 288 #define PTM_BFD_INIT 2
 289 #define PTM_BFD_UP 3
 290
 291
 292 /* Various constants */
 293 /* Retrieved from ptm_timer.h from Cumulus PTM sources. */
 294 #define BFD_DEF_DEMAND 0
 295 #define BFD_DEFDETECTMULT 3
 296 #define BFD_DEFDESIREDMINTX (300 * 1000) /* microseconds. */
 297 #define BFD_DEFREQUIREDMINRX (300 * 1000) /* microseconds. */
 298 #define BFD_DEF_REQ_MIN_ECHO (50 * 1000) /* microseconds. */
 299 #define BFD_DEF_SLOWTX (1000 * 1000) /* microseconds. */
 300 #define BFD_DEF_MHOP_TTL 5
 301 #define BFD_PKT_LEN 24 /* Length of control packet */
 302 #define BFD_TTL_VAL 255
 303 #define BFD_RCV_TTL_VAL 1
 304 #define BFD_TOS_VAL 0xC0
 305 #define BFD_PKT_INFO_VAL 1
 306 #define BFD_IPV6_PKT_INFO_VAL 1
 307 #define BFD_IPV6_ONLY_VAL 1
 308 #define BFD_SRCPORTINIT 49152
 309 #define BFD_SRCPORTMAX 65535
 310 #define BFD_DEFDESTPORT 3784
 311 #define BFD_DEF_ECHO_PORT 3785
 312 #define BFD_DEF_MHOP_DEST_PORT 4784
 313
 314 /*
 315  * control.c
 316  *
 317  * Daemon control code to speak with local consumers.
 318  */
 319
 320 /* See 'bfdctrl.h' for client protocol definitions. */
 321
 322 struct bfd_control_buffer {
 323         size_t bcb_left;
 324         size_t bcb_pos;
 325         union {
 326                 struct bfd_control_msg *bcb_bcm;
 327                 uint8_t *bcb_buf;
 328         };
 329 };
 330
 331 struct bfd_control_queue {
 332         TAILQ_ENTRY(bfd_control_queue) bcq_entry;
 333
 334         struct bfd_control_buffer bcq_bcb;
 335 };
 336 TAILQ_HEAD(bcqueue, bfd_control_queue);
 337
 338 struct bfd_notify_peer {
 339         TAILQ_ENTRY(bfd_notify_peer) bnp_entry;
 340
 341         struct bfd_session *bnp_bs;
 342 };
 343 TAILQ_HEAD(bnplist, bfd_notify_peer);
 344
 345 struct bfd_control_socket {
 346         TAILQ_ENTRY(bfd_control_socket) bcs_entry;
 347
 348         int bcs_sd;
 349         struct thread *bcs_ev;
 350         struct thread *bcs_outev;
 351         struct bcqueue bcs_bcqueue;
 352
 353         /* Notification data */
 354         uint64_t bcs_notify;
 355         struct bnplist bcs_bnplist;
 356
 357         enum bc_msg_version bcs_version;
 358         enum bc_msg_type bcs_type;
 359
 360         /* Message buffering */
 361         struct bfd_control_buffer bcs_bin;
 362         struct bfd_control_buffer *bcs_bout;
 363 };
 364 TAILQ_HEAD(bcslist, bfd_control_socket);
 365
 366 int control_init(const char *path);
 367 void control_shutdown(void);
 368 int control_notify(struct bfd_session *bs, uint8_t notify_state);
 369 int control_notify_config(const char *op, struct bfd_session *bs);
 370 int control_accept(struct thread *t);
 371
 372
 373 /*
 374  * bfdd.c
 375  *
 376  * Daemon specific code.
 377  */
 378 struct bfd_vrf_global {
 379         int bg_shop;
 380         int bg_mhop;
 381         int bg_shop6;
 382         int bg_mhop6;
 383         int bg_echo;
 384         int bg_echov6;
 385         struct vrf *vrf;
 386
 387         struct thread *bg_ev[6];
 388 };
 389
 390 struct bfd_global {
 391         int bg_csock;
 392         struct thread *bg_csockev;
 393         struct bcslist bg_bcslist;
 394
 395         struct pllist bg_pllist;
 396
 397         struct obslist bg_obslist;
 398
 399         struct zebra_privs_t bfdd_privs;
 400 };
 401 extern struct bfd_global bglobal;
 402 extern const struct bfd_diag_str_list diag_list[];
 403 extern const struct bfd_state_str_list state_list[];
 404
 405 void socket_close(int *s);
 406
 407
 408 /*
 409  * config.c
 410  *
 411  * Contains the code related with loading/reloading configuration.
 412  */
 413 int parse_config(const char *fname);
 414 int config_request_add(const char *jsonstr);
 415 int config_request_del(const char *jsonstr);
 416 char *config_response(const char *status, const char *error);
 417 char *config_notify(struct bfd_session *bs);
 418 char *config_notify_config(const char *op, struct bfd_session *bs);
 419
 420 typedef int (*bpc_handle)(struct bfd_peer_cfg *, void *arg);
 421 int config_notify_request(struct bfd_control_socket *bcs, const char *jsonstr,
 422                           bpc_handle bh);
 423
 424 struct peer_label *pl_new(const char *label, struct bfd_session *bs);
 425 struct peer_label *pl_find(const char *label);
 426 void pl_free(struct peer_label *pl);
 427
 428
 429 /*
 430  * logging - alias to zebra log
 431  */
 432
 433 #define log_debug       zlog_debug
 434 #define log_info        zlog_info
 435 #define log_warning     zlog_warn
 436 #define log_error       zlog_err
 437
 438 #define log_fatal(msg, ...)                                                    \
 439         do {                                                                   \
 440                 zlog_err(msg, ## __VA_ARGS__);                                 \
 441                 assert(!msg);                                                  \
 442                 abort();                                                       \
 443         } while (0)
 444
 445
 446 /*
 447  * bfd_packet.c
 448  *
 449  * Contains the code related with receiving/seding, packing/unpacking BFD data.
 450  */
 451 int bp_set_ttlv6(int sd, uint8_t value);
 452 int bp_set_ttl(int sd, uint8_t value);
 453 int bp_set_tosv6(int sd, uint8_t value);
 454 int bp_set_tos(int sd, uint8_t value);
 455 int bp_bind_dev(int sd, const char *dev);
 456
 457 int bp_udp_shop(const struct vrf *vrf);
 458 int bp_udp_mhop(const struct vrf *vrf);
 459 int bp_udp6_shop(const struct vrf *vrf);
 460 int bp_udp6_mhop(const struct vrf *vrf);
 461 int bp_peer_socket(const struct bfd_session *bs);
 462 int bp_peer_socketv6(const struct bfd_session *bs);
 463 int bp_echo_socket(const struct vrf *vrf);
 464 int bp_echov6_socket(const struct vrf *vrf);
 465
 466 void ptm_bfd_snd(struct bfd_session *bfd, int fbit);
 467 void ptm_bfd_echo_snd(struct bfd_session *bfd);
 468
 469 int bfd_recv_cb(struct thread *t);
 470
 471
 472 /*
 473  * event.c
 474  *
 475  * Contains the code related with event loop.
 476  */
 477 typedef void (*bfd_ev_cb)(struct thread *t);
 478
 479 void bfd_recvtimer_update(struct bfd_session *bs);
 480 void bfd_echo_recvtimer_update(struct bfd_session *bs);
 481 void bfd_xmttimer_update(struct bfd_session *bs, uint64_t jitter);
 482 void bfd_echo_xmttimer_update(struct bfd_session *bs, uint64_t jitter);
 483
 484 void bfd_xmttimer_delete(struct bfd_session *bs);
 485 void bfd_echo_xmttimer_delete(struct bfd_session *bs);
 486 void bfd_recvtimer_delete(struct bfd_session *bs);
 487 void bfd_echo_recvtimer_delete(struct bfd_session *bs);
 488
 489 void bfd_recvtimer_assign(struct bfd_session *bs, bfd_ev_cb cb, int sd);
 490 void bfd_echo_recvtimer_assign(struct bfd_session *bs, bfd_ev_cb cb, int sd);
 491 void bfd_xmttimer_assign(struct bfd_session *bs, bfd_ev_cb cb);
 492 void bfd_echo_xmttimer_assign(struct bfd_session *bs, bfd_ev_cb cb);
 493
 494
 495 /*
 496  * bfd.c
 497  *
 498  * BFD protocol specific code.
 499  */
 500 int bfd_session_enable(struct bfd_session *bs);
 501 void bfd_session_disable(struct bfd_session *bs);
 502 struct bfd_session *ptm_bfd_sess_new(struct bfd_peer_cfg *bpc);
 503 int ptm_bfd_sess_del(struct bfd_peer_cfg *bpc);
 504 void ptm_bfd_sess_dn(struct bfd_session *bfd, uint8_t diag);
 505 void ptm_bfd_sess_up(struct bfd_session *bfd);
 506 void ptm_bfd_echo_stop(struct bfd_session *bfd);
 507 void ptm_bfd_echo_start(struct bfd_session *bfd);
 508 void ptm_bfd_xmt_TO(struct bfd_session *bfd, int fbit);
 509 void ptm_bfd_start_xmt_timer(struct bfd_session *bfd, bool is_echo);
 510 struct bfd_session *ptm_bfd_sess_find(struct bfd_pkt *cp,
 511                                       struct sockaddr_any *peer,
 512                                       struct sockaddr_any *local,
 513                                       ifindex_t ifindex, vrf_id_t vrfid,
 514                                       bool is_mhop);
 515
 516 struct bfd_session *bs_peer_find(struct bfd_peer_cfg *bpc);
 517 int bfd_session_update_label(struct bfd_session *bs, const char *nlabel);
 518 void bfd_set_polling(struct bfd_session *bs);
 519 void bs_state_handler(struct bfd_session *bs, int nstate);
 520 void bs_echo_timer_handler(struct bfd_session *bs);
 521 void bs_final_handler(struct bfd_session *bs);
 522 void bs_set_slow_timers(struct bfd_session *bs);
 523 const char *satostr(struct sockaddr_any *sa);
 524 const char *diag2str(uint8_t diag);
 525 int strtosa(const char *addr, struct sockaddr_any *sa);
 526 void integer2timestr(uint64_t time, char *buf, size_t buflen);
 527 const char *bs_to_string(const struct bfd_session *bs);
 528
 529 int bs_observer_add(struct bfd_session *bs);
 530 void bs_observer_del(struct bfd_session_observer *bso);
 531
 532 void bs_to_bpc(struct bfd_session *bs, struct bfd_peer_cfg *bpc);
 533
 534 void gen_bfd_key(struct bfd_key *key, struct sockaddr_any *peer,
 535                  struct sockaddr_any *local, bool mhop, const char *ifname,
 536                  const char *vrfname);
 537 struct bfd_session *bfd_session_new(void);
 538 struct bfd_session *bs_registrate(struct bfd_session *bs);
 539 void bfd_session_free(struct bfd_session *bs);
 540 const struct bfd_session *bfd_session_next(const struct bfd_session *bs,
 541                                            bool mhop);
 542 void bfd_sessions_remove_manual(void);
 543
 544 /* BFD hash data structures interface */
 545 void bfd_initialize(void);
 546 void bfd_shutdown(void);
 547 void bfd_vrf_init(void);
 548 void bfd_vrf_terminate(void);
 549 struct bfd_vrf_global *bfd_vrf_look_by_session(struct bfd_session *bfd);
 550 struct bfd_session *bfd_id_lookup(uint32_t id);
 551 struct bfd_session *bfd_key_lookup(struct bfd_key key);
 552
 553 struct bfd_session *bfd_id_delete(uint32_t id);
 554 struct bfd_session *bfd_key_delete(struct bfd_key key);
 555
 556 bool bfd_id_insert(struct bfd_session *bs);
 557 bool bfd_key_insert(struct bfd_session *bs);
 558
 559 typedef void (*hash_iter_func)(struct hash_bucket *hb, void *arg);
 560 void bfd_id_iterate(hash_iter_func hif, void *arg);
 561 void bfd_key_iterate(hash_iter_func hif, void *arg);
 562
 563 unsigned long bfd_get_session_count(void);
 564
 565 /* Export callback functions for `event.c`. */
 566 extern struct thread_master *master;
 567
 568 int bfd_recvtimer_cb(struct thread *t);
 569 int bfd_echo_recvtimer_cb(struct thread *t);
 570 int bfd_xmt_cb(struct thread *t);
 571 int bfd_echo_xmt_cb(struct thread *t);
 572
 573 extern struct in6_addr zero_addr;
 574
 575
 576 /*
 577  * bfdd_vty.c
 578  *
 579  * BFD daemon vty shell commands.
 580  */
 581 void bfdd_vty_init(void);
 582
 583
 584 /*
 585  * bfdd_cli.c
 586  *
 587  * BFD daemon CLI implementation.
 588  */
 589 void bfdd_cli_init(void);
 590
 591
 592 /*
 593  * ptm_adapter.c
 594  */
 595 void bfdd_zclient_init(struct zebra_privs_t *bfdd_priv);
 596 void bfdd_zclient_stop(void);
 597 void bfdd_zclient_unregister(vrf_id_t vrf_id);
 598 void bfdd_zclient_register(vrf_id_t vrf_id);
 599 void bfdd_sessions_enable_vrf(struct vrf *vrf);
 600 void bfdd_sessions_disable_vrf(struct vrf *vrf);
 601 void bfd_session_update_vrf_name(struct bfd_session *bs, struct vrf *vrf);
 602
 603 int ptm_bfd_notify(struct bfd_session *bs, uint8_t notify_state);
 604
 605 #endif /* _BFD_H_ */