]>
Commit | Line | Data |
---|---|---|
7f342629 DS |
1 | /** |
2 | * bfd.c: BFD handling routines | |
3 | * | |
4 | * @copyright Copyright (C) 2015 Cumulus Networks, Inc. | |
5 | * | |
6 | * This file is part of GNU Zebra. | |
7 | * | |
8 | * GNU Zebra is free software; you can redistribute it and/or modify it | |
9 | * under the terms of the GNU General Public License as published by the | |
10 | * Free Software Foundation; either version 2, or (at your option) any | |
11 | * later version. | |
12 | * | |
13 | * GNU Zebra is distributed in the hope that it will be useful, but | |
14 | * WITHOUT ANY WARRANTY; without even the implied warranty of | |
15 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
16 | * General Public License for more details. | |
17 | * | |
896014f4 DL |
18 | * You should have received a copy of the GNU General Public License along |
19 | * with this program; see the file COPYING; if not, write to the Free Software | |
20 | * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA | |
7f342629 DS |
21 | */ |
22 | ||
23 | #include <zebra.h> | |
24 | ||
25 | #include "command.h" | |
26 | #include "memory.h" | |
27 | #include "prefix.h" | |
28 | #include "thread.h" | |
29 | #include "stream.h" | |
a099abe5 | 30 | #include "vrf.h" |
7f342629 DS |
31 | #include "zclient.h" |
32 | #include "table.h" | |
33 | #include "vty.h" | |
34 | #include "bfd.h" | |
35 | ||
bf8d3d6a | 36 | DEFINE_MTYPE_STATIC(LIB, BFD_INFO, "BFD info"); |
4a1ab8e4 | 37 | |
c97b34cf IR |
38 | /** |
39 | * BFD protocol integration configuration. | |
7f342629 | 40 | */ |
7f342629 | 41 | |
c97b34cf IR |
42 | /** Events definitions. */ |
43 | enum bfd_session_event { | |
44 | /** Remove the BFD session configuration. */ | |
45 | BSE_UNINSTALL, | |
46 | /** Install the BFD session configuration. */ | |
47 | BSE_INSTALL, | |
48 | }; | |
7f342629 | 49 | |
c97b34cf IR |
50 | /** |
51 | * Data structure to do the necessary tricks to hide the BFD protocol | |
52 | * integration internals. | |
7f342629 | 53 | */ |
c97b34cf IR |
54 | struct bfd_session_params { |
55 | /** Contains the session parameters and more. */ | |
56 | struct bfd_session_arg args; | |
57 | /** Contains the session state. */ | |
58 | struct bfd_session_status bss; | |
59 | /** Protocol implementation status update callback. */ | |
60 | bsp_status_update updatecb; | |
61 | /** Protocol implementation custom data pointer. */ | |
62 | void *arg; | |
7f342629 | 63 | |
c97b34cf IR |
64 | /** |
65 | * Next event. | |
66 | * | |
67 | * This variable controls what action to execute when the command batch | |
68 | * finishes. Normally we'd use `thread_add_event` value, however since | |
69 | * that function is going to be called multiple times and the value | |
70 | * might be different we'll use this variable to keep track of it. | |
71 | */ | |
72 | enum bfd_session_event lastev; | |
73 | /** | |
74 | * BFD session configuration event. | |
75 | * | |
76 | * Multiple actions might be asked during a command batch (either via | |
77 | * configuration load or northbound batch), so we'll use this to | |
78 | * install/uninstall the BFD session parameters only once. | |
79 | */ | |
80 | struct thread *installev; | |
d62a17ae | 81 | |
c97b34cf IR |
82 | /** BFD session installation state. */ |
83 | bool installed; | |
d62a17ae | 84 | |
c97b34cf IR |
85 | /** Global BFD paramaters list. */ |
86 | TAILQ_ENTRY(bfd_session_params) entry; | |
87 | }; | |
d62a17ae | 88 | |
c97b34cf IR |
89 | struct bfd_sessions_global { |
90 | /** | |
91 | * Global BFD session parameters list for (re)installation and update | |
92 | * without code duplication among daemons. | |
93 | */ | |
94 | TAILQ_HEAD(bsplist, bfd_session_params) bsplist; | |
18322efd | 95 | |
c97b34cf IR |
96 | /** Pointer to FRR's event manager. */ |
97 | struct thread_master *tm; | |
98 | /** Pointer to zebra client data structure. */ | |
99 | struct zclient *zc; | |
18322efd | 100 | |
c97b34cf IR |
101 | /** Debugging state. */ |
102 | bool debugging; | |
103 | /** Is shutting down? */ | |
104 | bool shutting_down; | |
105 | }; | |
18322efd | 106 | |
c97b34cf IR |
107 | /** Global configuration variable. */ |
108 | static struct bfd_sessions_global bsglobal; | |
7f342629 | 109 | |
c97b34cf IR |
110 | /** Global empty address for IPv4/IPv6. */ |
111 | static const struct in6_addr i6a_zero; | |
7f342629 DS |
112 | |
113 | /* | |
114 | * bfd_get_peer_info - Extract the Peer information for which the BFD session | |
115 | * went down from the message sent from Zebra to clients. | |
116 | */ | |
c97b34cf IR |
117 | static struct interface *bfd_get_peer_info(struct stream *s, struct prefix *dp, |
118 | struct prefix *sp, int *status, | |
119 | int *remote_cbit, vrf_id_t vrf_id) | |
7f342629 | 120 | { |
d62a17ae | 121 | unsigned int ifindex; |
122 | struct interface *ifp = NULL; | |
123 | int plen; | |
9beff0bd | 124 | int local_remote_cbit; |
d62a17ae | 125 | |
37a74717 DS |
126 | /* |
127 | * If the ifindex lookup fails the | |
128 | * rest of the data in the stream is | |
129 | * not read. All examples of this function | |
130 | * call immediately use the dp->family which | |
131 | * is not good. Ensure we are not using | |
132 | * random data | |
133 | */ | |
134 | memset(dp, 0, sizeof(*dp)); | |
135 | memset(sp, 0, sizeof(*sp)); | |
136 | ||
d62a17ae | 137 | /* Get interface index. */ |
9c39d197 | 138 | STREAM_GETL(s, ifindex); |
d62a17ae | 139 | |
140 | /* Lookup index. */ | |
141 | if (ifindex != 0) { | |
142 | ifp = if_lookup_by_index(ifindex, vrf_id); | |
143 | if (ifp == NULL) { | |
c97b34cf | 144 | if (bsglobal.debugging) |
d62a17ae | 145 | zlog_debug( |
8b3fd12c | 146 | "%s: Can't find interface by ifindex: %d ", |
147 | __func__, ifindex); | |
d62a17ae | 148 | return NULL; |
149 | } | |
150 | } | |
151 | ||
152 | /* Fetch destination address. */ | |
9c39d197 | 153 | STREAM_GETC(s, dp->family); |
d62a17ae | 154 | |
155 | plen = prefix_blen(dp); | |
9c39d197 RZ |
156 | STREAM_GET(&dp->u.prefix, s, plen); |
157 | STREAM_GETC(s, dp->prefixlen); | |
d62a17ae | 158 | |
159 | /* Get BFD status. */ | |
9c39d197 | 160 | STREAM_GETL(s, (*status)); |
d62a17ae | 161 | |
9c39d197 | 162 | STREAM_GETC(s, sp->family); |
37a74717 DS |
163 | |
164 | plen = prefix_blen(sp); | |
9c39d197 RZ |
165 | STREAM_GET(&sp->u.prefix, s, plen); |
166 | STREAM_GETC(s, sp->prefixlen); | |
d62a17ae | 167 | |
9c39d197 | 168 | STREAM_GETC(s, local_remote_cbit); |
9beff0bd PG |
169 | if (remote_cbit) |
170 | *remote_cbit = local_remote_cbit; | |
d62a17ae | 171 | return ifp; |
9c39d197 RZ |
172 | |
173 | stream_failure: | |
10f02a2a | 174 | /* |
175 | * Clean dp and sp because caller | |
176 | * will immediately check them valid or not | |
177 | */ | |
178 | memset(dp, 0, sizeof(*dp)); | |
179 | memset(sp, 0, sizeof(*sp)); | |
9c39d197 | 180 | return NULL; |
7f342629 | 181 | } |
68fe91d6 | 182 | |
183 | /* | |
184 | * bfd_get_status_str - Convert BFD status to a display string. | |
185 | */ | |
d62a17ae | 186 | const char *bfd_get_status_str(int status) |
68fe91d6 | 187 | { |
d62a17ae | 188 | switch (status) { |
189 | case BFD_STATUS_DOWN: | |
190 | return "Down"; | |
191 | case BFD_STATUS_UP: | |
192 | return "Up"; | |
7555dc61 S |
193 | case BFD_STATUS_ADMIN_DOWN: |
194 | return "Admin Down"; | |
d62a17ae | 195 | case BFD_STATUS_UNKNOWN: |
196 | default: | |
197 | return "Unknown"; | |
198 | } | |
68fe91d6 | 199 | } |
200 | ||
201 | /* | |
202 | * bfd_last_update - Calculate the last BFD update time and convert it | |
203 | * into a dd:hh:mm:ss display format. | |
204 | */ | |
d62a17ae | 205 | static void bfd_last_update(time_t last_update, char *buf, size_t len) |
68fe91d6 | 206 | { |
d62a17ae | 207 | time_t curr; |
208 | time_t diff; | |
a2700b50 | 209 | struct tm tm; |
d62a17ae | 210 | struct timeval tv; |
211 | ||
214d8a60 | 212 | /* If no BFD status update has ever been received, print `never'. */ |
d62a17ae | 213 | if (last_update == 0) { |
214 | snprintf(buf, len, "never"); | |
215 | return; | |
216 | } | |
217 | ||
218 | /* Get current time. */ | |
219 | monotime(&tv); | |
220 | curr = tv.tv_sec; | |
221 | diff = curr - last_update; | |
a2700b50 | 222 | gmtime_r(&diff, &tm); |
d62a17ae | 223 | |
a2700b50 MS |
224 | snprintf(buf, len, "%d:%02d:%02d:%02d", tm.tm_yday, tm.tm_hour, |
225 | tm.tm_min, tm.tm_sec); | |
68fe91d6 | 226 | } |
227 | ||
055c4dfc | 228 | /* |
229 | * bfd_client_sendmsg - Format and send a client register | |
230 | * command to Zebra to be forwarded to BFD | |
231 | */ | |
0945d5ed PG |
232 | void bfd_client_sendmsg(struct zclient *zclient, int command, |
233 | vrf_id_t vrf_id) | |
055c4dfc | 234 | { |
d62a17ae | 235 | struct stream *s; |
8a3f8f2e | 236 | enum zclient_send_status ret; |
d62a17ae | 237 | |
238 | /* Check socket. */ | |
239 | if (!zclient || zclient->sock < 0) { | |
c97b34cf | 240 | if (bsglobal.debugging) |
d62a17ae | 241 | zlog_debug( |
3efd0893 | 242 | "%s: Can't send BFD client register, Zebra client not established", |
15569c58 | 243 | __func__); |
d62a17ae | 244 | return; |
245 | } | |
246 | ||
247 | s = zclient->obuf; | |
248 | stream_reset(s); | |
0945d5ed | 249 | zclient_create_header(s, command, vrf_id); |
d62a17ae | 250 | |
251 | stream_putl(s, getpid()); | |
252 | ||
253 | stream_putw_at(s, 0, stream_get_endp(s)); | |
254 | ||
255 | ret = zclient_send_message(zclient); | |
256 | ||
8a3f8f2e | 257 | if (ret == ZCLIENT_SEND_FAILURE) { |
c97b34cf | 258 | if (bsglobal.debugging) |
d62a17ae | 259 | zlog_debug( |
8b3fd12c | 260 | "%s: %ld: zclient_send_message() failed", |
261 | __func__, (long)getpid()); | |
d62a17ae | 262 | return; |
263 | } | |
264 | ||
265 | return; | |
055c4dfc | 266 | } |
18322efd RZ |
267 | |
268 | int zclient_bfd_command(struct zclient *zc, struct bfd_session_arg *args) | |
269 | { | |
270 | struct stream *s; | |
271 | size_t addrlen; | |
272 | ||
bb99eb5d | 273 | /* Individual reg/dereg messages are suppressed during shutdown. */ |
c97b34cf IR |
274 | if (bsglobal.shutting_down) { |
275 | if (bsglobal.debugging) | |
bb99eb5d G |
276 | zlog_debug( |
277 | "%s: Suppressing BFD peer reg/dereg messages", | |
278 | __func__); | |
279 | return -1; | |
280 | } | |
281 | ||
18322efd RZ |
282 | /* Check socket. */ |
283 | if (!zc || zc->sock < 0) { | |
c97b34cf | 284 | if (bsglobal.debugging) |
18322efd RZ |
285 | zlog_debug("%s: zclient unavailable", __func__); |
286 | return -1; | |
287 | } | |
288 | ||
289 | s = zc->obuf; | |
290 | stream_reset(s); | |
291 | ||
292 | /* Create new message. */ | |
293 | zclient_create_header(s, args->command, args->vrf_id); | |
294 | stream_putl(s, getpid()); | |
295 | ||
296 | /* Encode destination address. */ | |
297 | stream_putw(s, args->family); | |
298 | addrlen = (args->family == AF_INET) ? sizeof(struct in_addr) | |
299 | : sizeof(struct in6_addr); | |
300 | stream_put(s, &args->dst, addrlen); | |
301 | ||
4b983eef RZ |
302 | /* |
303 | * For more BFD integration protocol details, see function | |
304 | * `_ptm_msg_read` in `bfdd/ptm_adapter.c`. | |
305 | */ | |
306 | #if HAVE_BFDD > 0 | |
307 | /* Session timers. */ | |
308 | stream_putl(s, args->min_rx); | |
309 | stream_putl(s, args->min_tx); | |
310 | stream_putc(s, args->detection_multiplier); | |
311 | ||
312 | /* Is multi hop? */ | |
313 | stream_putc(s, args->mhop != 0); | |
314 | ||
315 | /* Source address. */ | |
316 | stream_putw(s, args->family); | |
317 | stream_put(s, &args->src, addrlen); | |
318 | ||
03ff0db1 | 319 | /* Send the expected hops. */ |
320 | stream_putc(s, args->hops); | |
4b983eef RZ |
321 | |
322 | /* Send interface name if any. */ | |
b6c87c35 IR |
323 | if (args->mhop) { |
324 | /* Don't send interface. */ | |
325 | stream_putc(s, 0); | |
326 | if (bsglobal.debugging && args->ifnamelen) | |
327 | zlog_debug("%s: multi hop is configured, not sending interface", | |
328 | __func__); | |
329 | } else { | |
330 | stream_putc(s, args->ifnamelen); | |
331 | if (args->ifnamelen) | |
332 | stream_put(s, args->ifname, args->ifnamelen); | |
333 | } | |
4b983eef RZ |
334 | |
335 | /* Send the C bit indicator. */ | |
336 | stream_putc(s, args->cbit); | |
337 | ||
338 | /* Send profile name if any. */ | |
339 | stream_putc(s, args->profilelen); | |
340 | if (args->profilelen) | |
341 | stream_put(s, args->profile, args->profilelen); | |
342 | #else /* PTM BFD */ | |
18322efd RZ |
343 | /* Encode timers if this is a registration message. */ |
344 | if (args->command != ZEBRA_BFD_DEST_DEREGISTER) { | |
345 | stream_putl(s, args->min_rx); | |
346 | stream_putl(s, args->min_tx); | |
347 | stream_putc(s, args->detection_multiplier); | |
348 | } | |
349 | ||
350 | if (args->mhop) { | |
351 | /* Multi hop indicator. */ | |
352 | stream_putc(s, 1); | |
353 | ||
354 | /* Multi hop always sends the source address. */ | |
355 | stream_putw(s, args->family); | |
356 | stream_put(s, &args->src, addrlen); | |
357 | ||
03ff0db1 | 358 | /* Send the expected hops. */ |
359 | stream_putc(s, args->hops); | |
18322efd RZ |
360 | } else { |
361 | /* Multi hop indicator. */ | |
362 | stream_putc(s, 0); | |
363 | ||
364 | /* Single hop only sends the source address when IPv6. */ | |
365 | if (args->family == AF_INET6) { | |
366 | stream_putw(s, args->family); | |
367 | stream_put(s, &args->src, addrlen); | |
368 | } | |
369 | ||
370 | /* Send interface name if any. */ | |
371 | stream_putc(s, args->ifnamelen); | |
372 | if (args->ifnamelen) | |
373 | stream_put(s, args->ifname, args->ifnamelen); | |
374 | } | |
4cc6d2ce DS |
375 | |
376 | /* Send the C bit indicator. */ | |
377 | stream_putc(s, args->cbit); | |
18322efd RZ |
378 | #endif /* HAVE_BFDD */ |
379 | ||
380 | /* Finish the message by writing the size. */ | |
381 | stream_putw_at(s, 0, stream_get_endp(s)); | |
382 | ||
383 | /* Send message to zebra. */ | |
8a3f8f2e | 384 | if (zclient_send_message(zc) == ZCLIENT_SEND_FAILURE) { |
c97b34cf | 385 | if (bsglobal.debugging) |
18322efd RZ |
386 | zlog_debug("%s: zclient_send_message failed", __func__); |
387 | return -1; | |
388 | } | |
389 | ||
18322efd RZ |
390 | return 0; |
391 | } | |
a099abe5 | 392 | |
a099abe5 RZ |
393 | struct bfd_session_params *bfd_sess_new(bsp_status_update updatecb, void *arg) |
394 | { | |
395 | struct bfd_session_params *bsp; | |
396 | ||
397 | bsp = XCALLOC(MTYPE_BFD_INFO, sizeof(*bsp)); | |
398 | ||
399 | /* Save application data. */ | |
400 | bsp->updatecb = updatecb; | |
401 | bsp->arg = arg; | |
402 | ||
403 | /* Set defaults. */ | |
404 | bsp->args.detection_multiplier = BFD_DEF_DETECT_MULT; | |
03ff0db1 | 405 | bsp->args.hops = 1; |
a099abe5 RZ |
406 | bsp->args.min_rx = BFD_DEF_MIN_RX; |
407 | bsp->args.min_tx = BFD_DEF_MIN_TX; | |
408 | bsp->args.vrf_id = VRF_DEFAULT; | |
409 | ||
410 | /* Register in global list. */ | |
411 | TAILQ_INSERT_TAIL(&bsglobal.bsplist, bsp, entry); | |
412 | ||
413 | return bsp; | |
414 | } | |
415 | ||
416 | static bool _bfd_sess_valid(const struct bfd_session_params *bsp) | |
417 | { | |
418 | /* Peer/local address not configured. */ | |
419 | if (bsp->args.family == 0) | |
420 | return false; | |
421 | ||
422 | /* Address configured but invalid. */ | |
423 | if (bsp->args.family != AF_INET && bsp->args.family != AF_INET6) { | |
424 | if (bsglobal.debugging) | |
425 | zlog_debug("%s: invalid session family: %d", __func__, | |
426 | bsp->args.family); | |
427 | return false; | |
428 | } | |
429 | ||
430 | /* Invalid address. */ | |
431 | if (memcmp(&bsp->args.dst, &i6a_zero, sizeof(i6a_zero)) == 0) { | |
432 | if (bsglobal.debugging) { | |
433 | if (bsp->args.family == AF_INET) | |
434 | zlog_debug("%s: invalid address: %pI4", | |
435 | __func__, | |
436 | (struct in_addr *)&bsp->args.dst); | |
437 | else | |
438 | zlog_debug("%s: invalid address: %pI6", | |
439 | __func__, &bsp->args.dst); | |
440 | } | |
441 | return false; | |
442 | } | |
443 | ||
444 | /* Multi hop requires local address. */ | |
445 | if (bsp->args.mhop | |
446 | && memcmp(&i6a_zero, &bsp->args.src, sizeof(i6a_zero)) == 0) { | |
447 | if (bsglobal.debugging) | |
448 | zlog_debug( | |
449 | "%s: multi hop but no local address provided", | |
450 | __func__); | |
451 | return false; | |
452 | } | |
453 | ||
454 | /* Check VRF ID. */ | |
455 | if (bsp->args.vrf_id == VRF_UNKNOWN) { | |
456 | if (bsglobal.debugging) | |
457 | zlog_debug("%s: asked for unknown VRF", __func__); | |
458 | return false; | |
459 | } | |
460 | ||
461 | return true; | |
462 | } | |
463 | ||
cc9f21da | 464 | static void _bfd_sess_send(struct thread *t) |
a099abe5 RZ |
465 | { |
466 | struct bfd_session_params *bsp = THREAD_ARG(t); | |
467 | int rv; | |
468 | ||
469 | /* Validate configuration before trying to send bogus data. */ | |
470 | if (!_bfd_sess_valid(bsp)) | |
cc9f21da | 471 | return; |
a099abe5 RZ |
472 | |
473 | if (bsp->lastev == BSE_INSTALL) { | |
474 | bsp->args.command = bsp->installed ? ZEBRA_BFD_DEST_UPDATE | |
475 | : ZEBRA_BFD_DEST_REGISTER; | |
476 | } else | |
477 | bsp->args.command = ZEBRA_BFD_DEST_DEREGISTER; | |
478 | ||
479 | /* If not installed and asked for uninstall, do nothing. */ | |
480 | if (!bsp->installed && bsp->args.command == ZEBRA_BFD_DEST_DEREGISTER) | |
cc9f21da | 481 | return; |
a099abe5 RZ |
482 | |
483 | rv = zclient_bfd_command(bsglobal.zc, &bsp->args); | |
484 | /* Command was sent successfully. */ | |
485 | if (rv == 0) { | |
486 | /* Update installation status. */ | |
487 | if (bsp->args.command == ZEBRA_BFD_DEST_DEREGISTER) | |
488 | bsp->installed = false; | |
489 | else if (bsp->args.command == ZEBRA_BFD_DEST_REGISTER) | |
490 | bsp->installed = true; | |
e82acdce IR |
491 | } else { |
492 | struct ipaddr src, dst; | |
493 | ||
494 | src.ipa_type = bsp->args.family; | |
495 | src.ipaddr_v6 = bsp->args.src; | |
496 | dst.ipa_type = bsp->args.family; | |
497 | dst.ipaddr_v6 = bsp->args.dst; | |
498 | ||
499 | zlog_err( | |
500 | "%s: BFD session %pIA -> %pIA interface %s VRF %s(%u) was not %s", | |
501 | __func__, &src, &dst, | |
502 | bsp->args.ifnamelen ? bsp->args.ifname : "*", | |
503 | vrf_id_to_name(bsp->args.vrf_id), bsp->args.vrf_id, | |
504 | bsp->lastev == BSE_INSTALL ? "installed" | |
505 | : "uninstalled"); | |
a099abe5 | 506 | } |
a099abe5 RZ |
507 | } |
508 | ||
509 | static void _bfd_sess_remove(struct bfd_session_params *bsp) | |
510 | { | |
511 | /* Not installed, nothing to do. */ | |
512 | if (!bsp->installed) | |
513 | return; | |
514 | ||
515 | /* Cancel any pending installation request. */ | |
516 | THREAD_OFF(bsp->installev); | |
517 | ||
518 | /* Send request to remove any session. */ | |
519 | bsp->lastev = BSE_UNINSTALL; | |
520 | thread_execute(bsglobal.tm, _bfd_sess_send, bsp, 0); | |
521 | } | |
522 | ||
523 | void bfd_sess_free(struct bfd_session_params **bsp) | |
524 | { | |
525 | if (*bsp == NULL) | |
526 | return; | |
527 | ||
528 | /* Remove any installed session. */ | |
529 | _bfd_sess_remove(*bsp); | |
530 | ||
531 | /* Remove from global list. */ | |
532 | TAILQ_REMOVE(&bsglobal.bsplist, (*bsp), entry); | |
533 | ||
534 | /* Free the memory and point to NULL. */ | |
535 | XFREE(MTYPE_BFD_INFO, (*bsp)); | |
536 | } | |
537 | ||
ac506cb2 RZ |
538 | static bool bfd_sess_address_changed(const struct bfd_session_params *bsp, |
539 | uint32_t family, | |
540 | const struct in6_addr *src, | |
541 | const struct in6_addr *dst) | |
542 | { | |
543 | size_t addrlen; | |
544 | ||
545 | if (bsp->args.family != family) | |
546 | return true; | |
547 | ||
548 | addrlen = (family == AF_INET) ? sizeof(struct in_addr) | |
549 | : sizeof(struct in6_addr); | |
550 | if ((src == NULL && memcmp(&bsp->args.src, &i6a_zero, addrlen)) | |
551 | || (src && memcmp(src, &bsp->args.src, addrlen)) | |
552 | || memcmp(dst, &bsp->args.dst, addrlen)) | |
553 | return true; | |
554 | ||
555 | return false; | |
556 | } | |
557 | ||
a099abe5 | 558 | void bfd_sess_set_ipv4_addrs(struct bfd_session_params *bsp, |
ca30ac7f RZ |
559 | const struct in_addr *src, |
560 | const struct in_addr *dst) | |
a099abe5 | 561 | { |
ac506cb2 RZ |
562 | if (!bfd_sess_address_changed(bsp, AF_INET, (struct in6_addr *)src, |
563 | (struct in6_addr *)dst)) | |
564 | return; | |
565 | ||
a099abe5 RZ |
566 | /* If already installed, remove the old setting. */ |
567 | _bfd_sess_remove(bsp); | |
568 | ||
569 | bsp->args.family = AF_INET; | |
570 | ||
571 | /* Clean memory, set zero value and avoid static analyser warnings. */ | |
572 | memset(&bsp->args.src, 0, sizeof(bsp->args.src)); | |
573 | memset(&bsp->args.dst, 0, sizeof(bsp->args.dst)); | |
574 | ||
575 | /* Copy the equivalent of IPv4 to arguments structure. */ | |
576 | if (src) | |
577 | memcpy(&bsp->args.src, src, sizeof(struct in_addr)); | |
578 | ||
579 | assert(dst); | |
580 | memcpy(&bsp->args.dst, dst, sizeof(struct in_addr)); | |
581 | } | |
582 | ||
583 | void bfd_sess_set_ipv6_addrs(struct bfd_session_params *bsp, | |
ca30ac7f RZ |
584 | const struct in6_addr *src, |
585 | const struct in6_addr *dst) | |
a099abe5 | 586 | { |
ae094573 | 587 | if (!bfd_sess_address_changed(bsp, AF_INET6, src, dst)) |
ac506cb2 RZ |
588 | return; |
589 | ||
a099abe5 RZ |
590 | /* If already installed, remove the old setting. */ |
591 | _bfd_sess_remove(bsp); | |
592 | ||
593 | bsp->args.family = AF_INET6; | |
594 | ||
595 | /* Clean memory, set zero value and avoid static analyser warnings. */ | |
596 | memset(&bsp->args.src, 0, sizeof(bsp->args.src)); | |
597 | ||
598 | if (src) | |
599 | bsp->args.src = *src; | |
600 | ||
601 | assert(dst); | |
602 | bsp->args.dst = *dst; | |
603 | } | |
604 | ||
605 | void bfd_sess_set_interface(struct bfd_session_params *bsp, const char *ifname) | |
606 | { | |
ac506cb2 RZ |
607 | if ((ifname == NULL && bsp->args.ifnamelen == 0) |
608 | || (ifname && strcmp(bsp->args.ifname, ifname) == 0)) | |
609 | return; | |
610 | ||
a099abe5 RZ |
611 | /* If already installed, remove the old setting. */ |
612 | _bfd_sess_remove(bsp); | |
613 | ||
614 | if (ifname == NULL) { | |
615 | bsp->args.ifname[0] = 0; | |
616 | bsp->args.ifnamelen = 0; | |
617 | return; | |
618 | } | |
619 | ||
620 | if (strlcpy(bsp->args.ifname, ifname, sizeof(bsp->args.ifname)) | |
621 | > sizeof(bsp->args.ifname)) | |
622 | zlog_warn("%s: interface name truncated: %s", __func__, ifname); | |
623 | ||
624 | bsp->args.ifnamelen = strlen(bsp->args.ifname); | |
625 | } | |
626 | ||
627 | void bfd_sess_set_profile(struct bfd_session_params *bsp, const char *profile) | |
628 | { | |
629 | if (profile == NULL) { | |
630 | bsp->args.profile[0] = 0; | |
631 | bsp->args.profilelen = 0; | |
632 | return; | |
633 | } | |
634 | ||
635 | if (strlcpy(bsp->args.profile, profile, sizeof(bsp->args.profile)) | |
636 | > sizeof(bsp->args.profile)) | |
637 | zlog_warn("%s: profile name truncated: %s", __func__, profile); | |
638 | ||
639 | bsp->args.profilelen = strlen(bsp->args.profile); | |
640 | } | |
641 | ||
642 | void bfd_sess_set_vrf(struct bfd_session_params *bsp, vrf_id_t vrf_id) | |
643 | { | |
ac506cb2 RZ |
644 | if (bsp->args.vrf_id == vrf_id) |
645 | return; | |
646 | ||
a099abe5 RZ |
647 | /* If already installed, remove the old setting. */ |
648 | _bfd_sess_remove(bsp); | |
649 | ||
650 | bsp->args.vrf_id = vrf_id; | |
651 | } | |
652 | ||
92f85e65 | 653 | void bfd_sess_set_hop_count(struct bfd_session_params *bsp, uint8_t hops) |
a099abe5 | 654 | { |
03ff0db1 | 655 | if (bsp->args.hops == hops) |
ac506cb2 RZ |
656 | return; |
657 | ||
a099abe5 RZ |
658 | /* If already installed, remove the old setting. */ |
659 | _bfd_sess_remove(bsp); | |
660 | ||
03ff0db1 | 661 | bsp->args.hops = hops; |
92f85e65 | 662 | bsp->args.mhop = (hops > 1); |
a099abe5 RZ |
663 | } |
664 | ||
665 | ||
666 | void bfd_sess_set_cbit(struct bfd_session_params *bsp, bool enable) | |
667 | { | |
668 | bsp->args.cbit = enable; | |
669 | } | |
670 | ||
671 | void bfd_sess_set_timers(struct bfd_session_params *bsp, | |
672 | uint8_t detection_multiplier, uint32_t min_rx, | |
673 | uint32_t min_tx) | |
674 | { | |
675 | bsp->args.detection_multiplier = detection_multiplier; | |
676 | bsp->args.min_rx = min_rx; | |
677 | bsp->args.min_tx = min_tx; | |
678 | } | |
679 | ||
680 | void bfd_sess_install(struct bfd_session_params *bsp) | |
681 | { | |
a099abe5 RZ |
682 | bsp->lastev = BSE_INSTALL; |
683 | thread_add_event(bsglobal.tm, _bfd_sess_send, bsp, 0, &bsp->installev); | |
684 | } | |
685 | ||
686 | void bfd_sess_uninstall(struct bfd_session_params *bsp) | |
687 | { | |
688 | bsp->lastev = BSE_UNINSTALL; | |
689 | thread_add_event(bsglobal.tm, _bfd_sess_send, bsp, 0, &bsp->installev); | |
690 | } | |
691 | ||
692 | enum bfd_session_state bfd_sess_status(const struct bfd_session_params *bsp) | |
693 | { | |
694 | return bsp->bss.state; | |
695 | } | |
696 | ||
a099abe5 RZ |
697 | uint8_t bfd_sess_hop_count(const struct bfd_session_params *bsp) |
698 | { | |
03ff0db1 | 699 | return bsp->args.hops; |
a099abe5 RZ |
700 | } |
701 | ||
702 | const char *bfd_sess_profile(const struct bfd_session_params *bsp) | |
703 | { | |
704 | return bsp->args.profilelen ? bsp->args.profile : NULL; | |
705 | } | |
706 | ||
707 | void bfd_sess_addresses(const struct bfd_session_params *bsp, int *family, | |
708 | struct in6_addr *src, struct in6_addr *dst) | |
709 | { | |
710 | *family = bsp->args.family; | |
711 | if (src) | |
712 | *src = bsp->args.src; | |
713 | if (dst) | |
714 | *dst = bsp->args.dst; | |
715 | } | |
716 | ||
717 | const char *bfd_sess_interface(const struct bfd_session_params *bsp) | |
718 | { | |
719 | if (bsp->args.ifnamelen) | |
720 | return bsp->args.ifname; | |
721 | ||
722 | return NULL; | |
723 | } | |
724 | ||
725 | const char *bfd_sess_vrf(const struct bfd_session_params *bsp) | |
726 | { | |
727 | return vrf_id_to_name(bsp->args.vrf_id); | |
728 | } | |
729 | ||
730 | vrf_id_t bfd_sess_vrf_id(const struct bfd_session_params *bsp) | |
731 | { | |
732 | return bsp->args.vrf_id; | |
733 | } | |
734 | ||
735 | bool bfd_sess_cbit(const struct bfd_session_params *bsp) | |
736 | { | |
737 | return bsp->args.cbit; | |
738 | } | |
739 | ||
740 | void bfd_sess_timers(const struct bfd_session_params *bsp, | |
741 | uint8_t *detection_multiplier, uint32_t *min_rx, | |
742 | uint32_t *min_tx) | |
743 | { | |
744 | *detection_multiplier = bsp->args.detection_multiplier; | |
745 | *min_rx = bsp->args.min_rx; | |
746 | *min_tx = bsp->args.min_tx; | |
747 | } | |
748 | ||
749 | void bfd_sess_show(struct vty *vty, struct json_object *json, | |
750 | struct bfd_session_params *bsp) | |
751 | { | |
752 | json_object *json_bfd = NULL; | |
753 | char time_buf[64]; | |
754 | ||
83c44422 IR |
755 | if (!bsp) |
756 | return; | |
757 | ||
a099abe5 RZ |
758 | /* Show type. */ |
759 | if (json) { | |
760 | json_bfd = json_object_new_object(); | |
761 | if (bsp->args.mhop) | |
762 | json_object_string_add(json_bfd, "type", "multi hop"); | |
763 | else | |
764 | json_object_string_add(json_bfd, "type", "single hop"); | |
765 | } else | |
766 | vty_out(vty, " BFD: Type: %s\n", | |
767 | bsp->args.mhop ? "multi hop" : "single hop"); | |
768 | ||
769 | /* Show configuration. */ | |
770 | if (json) { | |
771 | json_object_int_add(json_bfd, "detectMultiplier", | |
772 | bsp->args.detection_multiplier); | |
773 | json_object_int_add(json_bfd, "rxMinInterval", | |
774 | bsp->args.min_rx); | |
775 | json_object_int_add(json_bfd, "txMinInterval", | |
776 | bsp->args.min_tx); | |
777 | } else { | |
778 | vty_out(vty, | |
779 | " Detect Multiplier: %d, Min Rx interval: %d, Min Tx interval: %d\n", | |
780 | bsp->args.detection_multiplier, bsp->args.min_rx, | |
781 | bsp->args.min_tx); | |
782 | } | |
783 | ||
784 | bfd_last_update(bsp->bss.last_event, time_buf, sizeof(time_buf)); | |
785 | if (json) { | |
786 | json_object_string_add(json_bfd, "status", | |
787 | bfd_get_status_str(bsp->bss.state)); | |
788 | json_object_string_add(json_bfd, "lastUpdate", time_buf); | |
789 | } else | |
790 | vty_out(vty, " Status: %s, Last update: %s\n", | |
791 | bfd_get_status_str(bsp->bss.state), time_buf); | |
792 | ||
793 | if (json) | |
794 | json_object_object_add(json, "peerBfdInfo", json_bfd); | |
795 | else | |
796 | vty_out(vty, "\n"); | |
797 | } | |
798 | ||
799 | /* | |
800 | * Zebra communication related. | |
801 | */ | |
802 | ||
803 | /** | |
804 | * Callback for reinstallation of all registered BFD sessions. | |
805 | * | |
806 | * Use this as `zclient` `bfd_dest_replay` callback. | |
807 | */ | |
3e51a84a | 808 | int zclient_bfd_session_replay(ZAPI_CALLBACK_ARGS) |
a099abe5 RZ |
809 | { |
810 | struct bfd_session_params *bsp; | |
811 | ||
a243d1db DL |
812 | if (!zclient->bfd_integration) |
813 | return 0; | |
814 | ||
a099abe5 RZ |
815 | /* Do nothing when shutting down. */ |
816 | if (bsglobal.shutting_down) | |
817 | return 0; | |
818 | ||
819 | if (bsglobal.debugging) | |
820 | zlog_debug("%s: sending all sessions registered", __func__); | |
821 | ||
822 | /* Send the client registration */ | |
823 | bfd_client_sendmsg(zclient, ZEBRA_BFD_CLIENT_REGISTER, vrf_id); | |
824 | ||
825 | /* Replay all activated peers. */ | |
826 | TAILQ_FOREACH (bsp, &bsglobal.bsplist, entry) { | |
e82acdce IR |
827 | /* Skip not installed sessions. */ |
828 | if (!bsp->installed) | |
a099abe5 RZ |
829 | continue; |
830 | ||
831 | /* We are reconnecting, so we must send installation. */ | |
832 | bsp->installed = false; | |
833 | ||
834 | /* Cancel any pending installation request. */ | |
835 | THREAD_OFF(bsp->installev); | |
836 | ||
837 | /* Ask for installation. */ | |
838 | bsp->lastev = BSE_INSTALL; | |
839 | thread_execute(bsglobal.tm, _bfd_sess_send, bsp, 0); | |
840 | } | |
841 | ||
842 | return 0; | |
843 | } | |
844 | ||
a243d1db | 845 | int zclient_bfd_session_update(ZAPI_CALLBACK_ARGS) |
a099abe5 | 846 | { |
464e6541 | 847 | struct bfd_session_params *bsp, *bspn; |
a099abe5 RZ |
848 | size_t sessions_updated = 0; |
849 | struct interface *ifp; | |
850 | int remote_cbit = false; | |
851 | int state = BFD_STATUS_UNKNOWN; | |
3e6376b8 | 852 | time_t now; |
a099abe5 RZ |
853 | size_t addrlen; |
854 | struct prefix dp; | |
855 | struct prefix sp; | |
856 | char ifstr[128], cbitstr[32]; | |
857 | ||
a243d1db DL |
858 | if (!zclient->bfd_integration) |
859 | return 0; | |
860 | ||
a099abe5 RZ |
861 | /* Do nothing when shutting down. */ |
862 | if (bsglobal.shutting_down) | |
863 | return 0; | |
864 | ||
865 | ifp = bfd_get_peer_info(zclient->ibuf, &dp, &sp, &state, &remote_cbit, | |
866 | vrf_id); | |
9c39d197 RZ |
867 | /* |
868 | * When interface lookup fails or an invalid stream is read, we must | |
869 | * not proceed otherwise it will trigger an assertion while checking | |
870 | * family type below. | |
871 | */ | |
872 | if (dp.family == 0 || sp.family == 0) | |
873 | return 0; | |
a099abe5 RZ |
874 | |
875 | if (bsglobal.debugging) { | |
876 | ifstr[0] = 0; | |
877 | if (ifp) | |
878 | snprintf(ifstr, sizeof(ifstr), " (interface %s)", | |
879 | ifp->name); | |
880 | ||
881 | snprintf(cbitstr, sizeof(cbitstr), " (CPI bit %s)", | |
882 | remote_cbit ? "yes" : "no"); | |
883 | ||
884 | zlog_debug("%s: %pFX -> %pFX%s VRF %s(%u)%s: %s", __func__, &sp, | |
885 | &dp, ifstr, vrf_id_to_name(vrf_id), vrf_id, cbitstr, | |
886 | bfd_get_status_str(state)); | |
887 | } | |
888 | ||
889 | switch (dp.family) { | |
890 | case AF_INET: | |
891 | addrlen = sizeof(struct in_addr); | |
892 | break; | |
893 | case AF_INET6: | |
894 | addrlen = sizeof(struct in6_addr); | |
895 | break; | |
896 | ||
897 | default: | |
898 | /* Unexpected value. */ | |
899 | assert(0); | |
900 | break; | |
901 | } | |
902 | ||
3e6376b8 RZ |
903 | /* Cache current time to avoid multiple monotime clock calls. */ |
904 | now = monotime(NULL); | |
905 | ||
a099abe5 | 906 | /* Notify all matching sessions about update. */ |
464e6541 | 907 | TAILQ_FOREACH_SAFE (bsp, &bsglobal.bsplist, entry, bspn) { |
e82acdce IR |
908 | /* Skip not installed entries. */ |
909 | if (!bsp->installed) | |
a099abe5 RZ |
910 | continue; |
911 | /* Skip different VRFs. */ | |
912 | if (bsp->args.vrf_id != vrf_id) | |
913 | continue; | |
914 | /* Skip different families. */ | |
915 | if (bsp->args.family != dp.family) | |
916 | continue; | |
917 | /* Skip different interface. */ | |
918 | if (bsp->args.ifnamelen && ifp | |
919 | && strcmp(bsp->args.ifname, ifp->name) != 0) | |
920 | continue; | |
921 | /* Skip non matching destination addresses. */ | |
922 | if (memcmp(&bsp->args.dst, &dp.u, addrlen) != 0) | |
923 | continue; | |
924 | /* | |
925 | * Source comparison test: | |
926 | * We will only compare source if BFD daemon provided the | |
927 | * source address and the protocol set a source address in | |
928 | * the configuration otherwise we'll just skip it. | |
929 | */ | |
930 | if (sp.family && memcmp(&bsp->args.src, &i6a_zero, addrlen) != 0 | |
931 | && memcmp(&sp.u, &i6a_zero, addrlen) != 0 | |
932 | && memcmp(&bsp->args.src, &sp.u, addrlen) != 0) | |
933 | continue; | |
934 | /* No session state change. */ | |
935 | if ((int)bsp->bss.state == state) | |
936 | continue; | |
937 | ||
3e6376b8 | 938 | bsp->bss.last_event = now; |
a099abe5 RZ |
939 | bsp->bss.previous_state = bsp->bss.state; |
940 | bsp->bss.state = state; | |
941 | bsp->bss.remote_cbit = remote_cbit; | |
942 | bsp->updatecb(bsp, &bsp->bss, bsp->arg); | |
943 | sessions_updated++; | |
944 | } | |
945 | ||
946 | if (bsglobal.debugging) | |
947 | zlog_debug("%s: sessions updated: %zu", __func__, | |
948 | sessions_updated); | |
949 | ||
950 | return 0; | |
951 | } | |
952 | ||
953 | void bfd_protocol_integration_init(struct zclient *zc, struct thread_master *tm) | |
954 | { | |
955 | /* Initialize data structure. */ | |
956 | TAILQ_INIT(&bsglobal.bsplist); | |
957 | ||
958 | /* Copy pointers. */ | |
959 | bsglobal.zc = zc; | |
960 | bsglobal.tm = tm; | |
961 | ||
a243d1db DL |
962 | /* Enable BFD callbacks. */ |
963 | zc->bfd_integration = true; | |
a099abe5 RZ |
964 | |
965 | /* Send the client registration */ | |
966 | bfd_client_sendmsg(zc, ZEBRA_BFD_CLIENT_REGISTER, VRF_DEFAULT); | |
967 | } | |
968 | ||
969 | void bfd_protocol_integration_set_debug(bool enable) | |
970 | { | |
971 | bsglobal.debugging = enable; | |
972 | } | |
973 | ||
974 | void bfd_protocol_integration_set_shutdown(bool enable) | |
975 | { | |
976 | bsglobal.shutting_down = enable; | |
977 | } | |
978 | ||
979 | bool bfd_protocol_integration_debug(void) | |
980 | { | |
981 | return bsglobal.debugging; | |
982 | } | |
983 | ||
984 | bool bfd_protocol_integration_shutting_down(void) | |
985 | { | |
986 | return bsglobal.shutting_down; | |
987 | } |