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