2 * bfd.c: BFD handling routines
4 * @copyright Copyright (C) 2015 Cumulus Networks, Inc.
6 * This file is part of GNU Zebra.
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
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.
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
35 DEFINE_MTYPE_STATIC(LIB
, BFD_INFO
, "BFD info")
37 static int bfd_debug
= 0;
38 static struct bfd_gbl bfd_gbl
;
41 * bfd_gbl_init - Initialize the BFD global structure
43 void bfd_gbl_init(void)
45 memset(&bfd_gbl
, 0, sizeof(struct bfd_gbl
));
49 * bfd_gbl_exit - Called when daemon exits
51 void bfd_gbl_exit(void)
53 SET_FLAG(bfd_gbl
.flags
, BFD_GBL_FLAG_IN_SHUTDOWN
);
57 * bfd_info_create - Allocate the BFD information
59 struct bfd_info
*bfd_info_create(void)
61 struct bfd_info
*bfd_info
;
63 bfd_info
= XCALLOC(MTYPE_BFD_INFO
, sizeof(struct bfd_info
));
66 bfd_info
->status
= BFD_STATUS_UNKNOWN
;
67 bfd_info
->type
= BFD_TYPE_NOT_CONFIGURED
;
68 bfd_info
->last_update
= 0;
73 * bfd_info_free - Free the BFD information.
75 void bfd_info_free(struct bfd_info
**bfd_info
)
77 XFREE(MTYPE_BFD_INFO
, *bfd_info
);
81 * bfd_validate_param - Validate the BFD paramter information.
83 int bfd_validate_param(struct vty
*vty
, const char *dm_str
, const char *rx_str
,
84 const char *tx_str
, uint8_t *dm_val
, uint32_t *rx_val
,
87 *dm_val
= strtoul(dm_str
, NULL
, 10);
88 *rx_val
= strtoul(rx_str
, NULL
, 10);
89 *tx_val
= strtoul(tx_str
, NULL
, 10);
94 * bfd_set_param - Set the configured BFD paramter values
96 void bfd_set_param(struct bfd_info
**bfd_info
, uint32_t min_rx
, uint32_t min_tx
,
97 uint8_t detect_mult
, int defaults
, int *command
)
100 *bfd_info
= bfd_info_create();
101 *command
= ZEBRA_BFD_DEST_REGISTER
;
103 if (((*bfd_info
)->required_min_rx
!= min_rx
)
104 || ((*bfd_info
)->desired_min_tx
!= min_tx
)
105 || ((*bfd_info
)->detect_mult
!= detect_mult
))
106 *command
= ZEBRA_BFD_DEST_UPDATE
;
110 (*bfd_info
)->required_min_rx
= min_rx
;
111 (*bfd_info
)->desired_min_tx
= min_tx
;
112 (*bfd_info
)->detect_mult
= detect_mult
;
116 SET_FLAG((*bfd_info
)->flags
, BFD_FLAG_PARAM_CFG
);
118 UNSET_FLAG((*bfd_info
)->flags
, BFD_FLAG_PARAM_CFG
);
122 * bfd_peer_sendmsg - Format and send a peer register/Unregister
123 * command to Zebra to be forwarded to BFD
125 void bfd_peer_sendmsg(struct zclient
*zclient
, struct bfd_info
*bfd_info
,
126 int family
, void *dst_ip
, void *src_ip
, char *if_name
,
127 int ttl
, int multihop
, int cbit
, int command
,
128 int set_flag
, vrf_id_t vrf_id
)
134 /* Individual reg/dereg messages are suppressed during shutdown. */
135 if (CHECK_FLAG(bfd_gbl
.flags
, BFD_GBL_FLAG_IN_SHUTDOWN
)) {
138 "%s: Suppressing BFD peer reg/dereg messages",
144 if (!zclient
|| zclient
->sock
< 0) {
147 "%s: Can't send BFD peer register, Zebra client not "
155 zclient_create_header(s
, command
, vrf_id
);
157 stream_putl(s
, getpid());
159 stream_putw(s
, family
);
162 stream_put_in_addr(s
, (struct in_addr
*)dst_ip
);
165 stream_put(s
, dst_ip
, 16);
171 if (command
!= ZEBRA_BFD_DEST_DEREGISTER
) {
172 stream_putl(s
, bfd_info
->required_min_rx
);
173 stream_putl(s
, bfd_info
->desired_min_tx
);
174 stream_putc(s
, bfd_info
->detect_mult
);
179 /* Multi-hop destination send the source IP address to BFD */
181 stream_putw(s
, family
);
184 stream_put_in_addr(s
, (struct in_addr
*)src_ip
);
187 stream_put(s
, src_ip
, 16);
196 if ((family
== AF_INET6
) && (src_ip
)) {
197 stream_putw(s
, family
);
198 stream_put(s
, src_ip
, 16);
201 len
= strlen(if_name
);
203 stream_put(s
, if_name
, len
);
214 stream_putw_at(s
, 0, stream_get_endp(s
));
216 ret
= zclient_send_message(zclient
);
221 "bfd_peer_sendmsg: zclient_send_message() failed");
226 if (command
== ZEBRA_BFD_DEST_REGISTER
)
227 SET_FLAG(bfd_info
->flags
, BFD_FLAG_BFD_REG
);
228 else if (command
== ZEBRA_BFD_DEST_DEREGISTER
)
229 UNSET_FLAG(bfd_info
->flags
, BFD_FLAG_BFD_REG
);
236 * bfd_get_command_dbg_str - Convert command to a debug string.
238 const char *bfd_get_command_dbg_str(int command
)
241 case ZEBRA_BFD_DEST_REGISTER
:
243 case ZEBRA_BFD_DEST_DEREGISTER
:
245 case ZEBRA_BFD_DEST_UPDATE
:
253 * bfd_get_peer_info - Extract the Peer information for which the BFD session
254 * went down from the message sent from Zebra to clients.
256 struct interface
*bfd_get_peer_info(struct stream
*s
, struct prefix
*dp
,
257 struct prefix
*sp
, int *status
,
261 unsigned int ifindex
;
262 struct interface
*ifp
= NULL
;
264 int local_remote_cbit
;
266 /* Get interface index. */
267 ifindex
= stream_getl(s
);
271 ifp
= if_lookup_by_index(ifindex
, vrf_id
);
275 "zebra_interface_bfd_read: "
276 "Can't find interface by ifindex: %d ",
282 /* Fetch destination address. */
283 dp
->family
= stream_getc(s
);
285 plen
= prefix_blen(dp
);
286 stream_get(&dp
->u
.prefix
, s
, plen
);
287 dp
->prefixlen
= stream_getc(s
);
289 /* Get BFD status. */
290 *status
= stream_getl(s
);
293 sp
->family
= stream_getc(s
);
295 plen
= prefix_blen(sp
);
296 stream_get(&sp
->u
.prefix
, s
, plen
);
297 sp
->prefixlen
= stream_getc(s
);
299 local_remote_cbit
= stream_getc(s
);
301 *remote_cbit
= local_remote_cbit
;
306 * bfd_get_status_str - Convert BFD status to a display string.
308 const char *bfd_get_status_str(int status
)
311 case BFD_STATUS_DOWN
:
315 case BFD_STATUS_ADMIN_DOWN
:
317 case BFD_STATUS_UNKNOWN
:
324 * bfd_last_update - Calculate the last BFD update time and convert it
325 * into a dd:hh:mm:ss display format.
327 static void bfd_last_update(time_t last_update
, char *buf
, size_t len
)
334 /* If no BFD satatus update has ever been received, print `never'. */
335 if (last_update
== 0) {
336 snprintf(buf
, len
, "never");
340 /* Get current time. */
343 diff
= curr
- last_update
;
344 gmtime_r(&diff
, &tm
);
346 snprintf(buf
, len
, "%d:%02d:%02d:%02d", tm
.tm_yday
, tm
.tm_hour
,
347 tm
.tm_min
, tm
.tm_sec
);
351 * bfd_show_param - Show the BFD parameter information.
353 void bfd_show_param(struct vty
*vty
, struct bfd_info
*bfd_info
, int bfd_tag
,
354 int extra_space
, bool use_json
, json_object
*json_obj
)
356 json_object
*json_bfd
= NULL
;
363 json_bfd
= json_object_new_object();
367 json_object_int_add(json_bfd
, "detectMultiplier",
368 bfd_info
->detect_mult
);
369 json_object_int_add(json_bfd
, "rxMinInterval",
370 bfd_info
->required_min_rx
);
371 json_object_int_add(json_bfd
, "txMinInterval",
372 bfd_info
->desired_min_tx
);
374 json_object_object_add(json_obj
, "peerBfdInfo",
378 " %s%sDetect Multiplier: %d, Min Rx interval: %d,"
379 " Min Tx interval: %d\n",
380 (extra_space
) ? " " : "", (bfd_tag
) ? "BFD: " : " ",
381 bfd_info
->detect_mult
, bfd_info
->required_min_rx
,
382 bfd_info
->desired_min_tx
);
387 * bfd_show_status - Show the BFD status information.
389 static void bfd_show_status(struct vty
*vty
, struct bfd_info
*bfd_info
,
390 int bfd_tag
, int extra_space
, bool use_json
,
391 json_object
*json_bfd
)
398 bfd_last_update(bfd_info
->last_update
, time_buf
, 32);
400 json_object_string_add(json_bfd
, "status",
401 bfd_get_status_str(bfd_info
->status
));
402 json_object_string_add(json_bfd
, "lastUpdate", time_buf
);
404 vty_out(vty
, " %s%sStatus: %s, Last update: %s\n",
405 (extra_space
) ? " " : "", (bfd_tag
) ? "BFD: " : " ",
406 bfd_get_status_str(bfd_info
->status
), time_buf
);
411 * bfd_show_info - Show the BFD information.
413 void bfd_show_info(struct vty
*vty
, struct bfd_info
*bfd_info
, int multihop
,
414 int extra_space
, bool use_json
, json_object
*json_obj
)
416 json_object
*json_bfd
= NULL
;
422 json_bfd
= json_object_new_object();
424 json_object_string_add(json_bfd
, "type", "multi hop");
426 json_object_string_add(json_bfd
, "type", "single hop");
428 vty_out(vty
, " %sBFD: Type: %s\n", (extra_space
) ? " " : "",
429 (multihop
) ? "multi hop" : "single hop");
432 bfd_show_param(vty
, bfd_info
, 0, extra_space
, use_json
, json_bfd
);
433 bfd_show_status(vty
, bfd_info
, 0, extra_space
, use_json
, json_bfd
);
436 json_object_object_add(json_obj
, "peerBfdInfo", json_bfd
);
442 * bfd_client_sendmsg - Format and send a client register
443 * command to Zebra to be forwarded to BFD
445 void bfd_client_sendmsg(struct zclient
*zclient
, int command
,
452 if (!zclient
|| zclient
->sock
< 0) {
455 "%s: Can't send BFD client register, Zebra client not "
463 zclient_create_header(s
, command
, vrf_id
);
465 stream_putl(s
, getpid());
467 stream_putw_at(s
, 0, stream_get_endp(s
));
469 ret
= zclient_send_message(zclient
);
474 "bfd_client_sendmsg %ld: zclient_send_message() failed",