summaryrefslogtreecommitdiffstats
path: root/lib/bfd.c
blob: 5db08fea60a67769463044f344e11d067cd7b37c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
/**
 * bfd.c: BFD handling routines
 *
 * @copyright Copyright (C) 2015 Cumulus Networks, Inc.
 *
 * This file is part of GNU Zebra.
 *
 * GNU Zebra is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License as published by the
 * Free Software Foundation; either version 2, or (at your option) any
 * later version.
 *
 * GNU Zebra is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with GNU Zebra; see the file COPYING.  If not, write to the Free
 * Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
 * 02111-1307, USA.
 */

#include <zebra.h>

#include "command.h"
#include "memory.h"
#include "prefix.h"
#include "thread.h"
#include "stream.h"
#include "zclient.h"
#include "table.h"
#include "vty.h"
#include "bfd.h"

DEFINE_MTYPE_STATIC(LIB, BFD_INFO, "BFD info")

int bfd_debug = 0;
struct bfd_gbl bfd_gbl;

/*
 * bfd_gbl_init - Initialize the BFD global structure
 */
void
bfd_gbl_init(void)
{
  memset(&bfd_gbl, 0, sizeof (struct bfd_gbl));
}

/*
 * bfd_gbl_exit - Called when daemon exits
 */
void
bfd_gbl_exit(void)
{
  SET_FLAG (bfd_gbl.flags, BFD_GBL_FLAG_IN_SHUTDOWN);
}

/*
 * bfd_info_create - Allocate the BFD information
 */
struct bfd_info *
bfd_info_create(void)
{
  struct bfd_info *bfd_info;

  bfd_info = XCALLOC (MTYPE_BFD_INFO, sizeof (struct bfd_info));
  assert(bfd_info);

  bfd_info->status = BFD_STATUS_UNKNOWN;
  bfd_info->type = BFD_TYPE_NOT_CONFIGURED;
  bfd_info->last_update = 0;
  return bfd_info;
}

/*
 * bfd_info_free - Free the BFD information.
 */
void
bfd_info_free(struct bfd_info **bfd_info)
{
  if (*bfd_info)
    {
      XFREE (MTYPE_BFD_INFO, *bfd_info);
      *bfd_info = NULL;
    }
}

/*
 * bfd_validate_param - Validate the BFD paramter information.
 */
int
bfd_validate_param(struct vty *vty, const char *dm_str, const char *rx_str,
                    const char *tx_str, u_int8_t *dm_val, u_int32_t *rx_val,
                    u_int32_t *tx_val)
{
  VTY_GET_INTEGER_RANGE ("detect-mul", *dm_val, dm_str,
                         BFD_MIN_DETECT_MULT, BFD_MAX_DETECT_MULT);
  VTY_GET_INTEGER_RANGE ("min-rx", *rx_val, rx_str,
                         BFD_MIN_MIN_RX, BFD_MAX_MIN_RX);
  VTY_GET_INTEGER_RANGE ("min-tx", *tx_val, tx_str,
                         BFD_MIN_MIN_TX, BFD_MAX_MIN_TX);
  return CMD_SUCCESS;
}

/*
 * bfd_set_param - Set the configured BFD paramter values
 */
void
bfd_set_param (struct bfd_info **bfd_info, u_int32_t min_rx, u_int32_t min_tx,
               u_int8_t detect_mult, int defaults, int *command)
{
  if (!*bfd_info)
    {
      *bfd_info = bfd_info_create();
      *command = ZEBRA_BFD_DEST_REGISTER;
    }
  else
    {
      if (((*bfd_info)->required_min_rx != min_rx) ||
          ((*bfd_info)->desired_min_tx != min_tx) ||
          ((*bfd_info)->detect_mult != detect_mult))
        *command = ZEBRA_BFD_DEST_UPDATE;
    }

  if (*command)
    {
      (*bfd_info)->required_min_rx = min_rx;
      (*bfd_info)->desired_min_tx = min_tx;
      (*bfd_info)->detect_mult = detect_mult;
    }

  if (!defaults)
    SET_FLAG ((*bfd_info)->flags, BFD_FLAG_PARAM_CFG);
  else
    UNSET_FLAG ((*bfd_info)->flags, BFD_FLAG_PARAM_CFG);
}

/*
 * bfd_peer_sendmsg - Format and send a peer register/Unregister
 *                    command to Zebra to be forwarded to BFD
 */
void
bfd_peer_sendmsg (struct zclient *zclient, struct bfd_info *bfd_info,
                  int family, void *dst_ip, void *src_ip, char *if_name,
                  int ttl, int multihop, int command, int set_flag,
                  vrf_id_t vrf_id)
{
  struct stream *s;
  int ret;
  int len;

  /* Individual reg/dereg messages are supressed during shutdown. */
  if (CHECK_FLAG (bfd_gbl.flags, BFD_GBL_FLAG_IN_SHUTDOWN))
    {
      if (bfd_debug)
	zlog_debug("%s: Suppressing BFD peer reg/dereg messages", __FUNCTION__);
      return;
    }

  /* Check socket. */
  if (!zclient || zclient->sock < 0)
    {
      if (bfd_debug)
	zlog_debug("%s: Can't send BFD peer register, Zebra client not "
		   "established", __FUNCTION__);
      return;
    }

  s = zclient->obuf;
  stream_reset (s);
  zclient_create_header (s, command, vrf_id);

  stream_putl(s, getpid());

  stream_putw(s, family);
  switch (family)
    {
    case AF_INET:
      stream_put_in_addr (s, (struct in_addr *)dst_ip);
      break;
    case AF_INET6:
      stream_put(s, dst_ip, 16);
      break;
    default:
      break;
    }

  if (command != ZEBRA_BFD_DEST_DEREGISTER)
    {
      stream_putl(s, bfd_info->required_min_rx);
      stream_putl(s, bfd_info->desired_min_tx);
      stream_putc(s, bfd_info->detect_mult);
    }

  if (multihop)
    {
      stream_putc(s, 1);
      /* Multi-hop destination send the source IP address to BFD */
      if (src_ip)
        {
          stream_putw(s, family);
          switch (family)
            {
            case AF_INET:
              stream_put_in_addr (s, (struct in_addr *) src_ip);
              break;
            case AF_INET6:
              stream_put(s, src_ip, 16);
              break;
            default:
              break;
            }
        }
      stream_putc(s, ttl);
    }
  else
    {
      stream_putc(s, 0);
      if ((family == AF_INET6) && (src_ip))
        {
          stream_putw(s, family);
          stream_put(s, src_ip, 16);
        }
      if (if_name)
        {
          len = strlen(if_name);
          stream_putc(s, len);
          stream_put(s, if_name, len);
        }
      else
        {
          stream_putc(s, 0);
        }
    }

  stream_putw_at (s, 0, stream_get_endp (s));

  ret = zclient_send_message(zclient);

  if (ret < 0)
    {
      if (bfd_debug)
	zlog_debug("bfd_peer_sendmsg: zclient_send_message() failed");
      return;
    }

  if (set_flag)
    {
      if (command == ZEBRA_BFD_DEST_REGISTER)
        SET_FLAG(bfd_info->flags, BFD_FLAG_BFD_REG);
      else if (command == ZEBRA_BFD_DEST_DEREGISTER)
        UNSET_FLAG(bfd_info->flags, BFD_FLAG_BFD_REG);
    }

  return;
}

/*
 * bfd_get_command_dbg_str - Convert command to a debug string.
 */
const char *
bfd_get_command_dbg_str(int command)
{
  switch (command)
  {
    case ZEBRA_BFD_DEST_REGISTER:
      return "Register";
    case ZEBRA_BFD_DEST_DEREGISTER:
      return "Deregister";
    case ZEBRA_BFD_DEST_UPDATE:
      return "Update";
    default:
      return "Unknown";
  }
}

/*
 * bfd_get_peer_info - Extract the Peer information for which the BFD session
 *                     went down from the message sent from Zebra to clients.
 */
struct interface *
bfd_get_peer_info (struct stream *s, struct prefix *dp, struct prefix *sp,
                    int *status, vrf_id_t vrf_id)
{
  unsigned int ifindex;
  struct interface *ifp = NULL;
  int plen;

  /* Get interface index. */
  ifindex = stream_getl (s);

  /* Lookup index. */
  if (ifindex != 0)
    {
      ifp = if_lookup_by_index_vrf (ifindex, vrf_id);
      if (ifp == NULL)
        {
	  if (bfd_debug)
	    zlog_debug ("zebra_interface_bfd_read: "
			"Can't find interface by ifindex: %d ", ifindex);
          return NULL;
        }
    }

  /* Fetch destination address. */
  dp->family = stream_getc (s);

  plen = prefix_blen (dp);
  stream_get (&dp->u.prefix, s, plen);
  dp->prefixlen = stream_getc (s);

  /* Get BFD status. */
  *status = stream_getl (s);

  if (sp)
    {
      sp->family = stream_getc (s);

      plen = prefix_blen (sp);
      stream_get (&sp->u.prefix, s, plen);
      sp->prefixlen = stream_getc (s);
    }
  return ifp;
}

/*
 * bfd_get_status_str - Convert BFD status to a display string.
 */
const char *
bfd_get_status_str(int status)
{
  switch (status)
  {
    case BFD_STATUS_DOWN:
      return "Down";
    case BFD_STATUS_UP:
      return "Up";
    case BFD_STATUS_UNKNOWN:
    default:
      return "Unknown";
  }
}

/*
 * bfd_last_update - Calculate the last BFD update time and convert it
 *                   into a dd:hh:mm:ss display format.
 */
static void
bfd_last_update (time_t last_update, char *buf, size_t len)
{
  time_t curr;
  time_t diff;
  struct tm *tm;
  struct timeval tv;

  /* If no BFD satatus update has ever been received, print `never'. */
  if (last_update == 0)
    {
      snprintf (buf, len, "never");
      return;
    }

  /* Get current time. */
  quagga_gettime(QUAGGA_CLK_MONOTONIC, &tv);
  curr = tv.tv_sec;
  diff = curr - last_update;
  tm = gmtime (&diff);

  snprintf (buf, len, "%d:%02d:%02d:%02d",
            tm->tm_yday, tm->tm_hour, tm->tm_min, tm->tm_sec);
}

/*
 * bfd_show_param - Show the BFD parameter information.
 */
void
bfd_show_param(struct vty *vty, struct bfd_info *bfd_info, int bfd_tag,
                int extra_space, u_char use_json, json_object *json_obj)
{
  json_object *json_bfd = NULL;

  if (!bfd_info)
    return;

  if (use_json)
    {
      if (bfd_tag)
        json_bfd = json_object_new_object();
      else
        json_bfd = json_obj;

      json_object_int_add(json_bfd, "detectMultiplier", bfd_info->detect_mult);
      json_object_int_add(json_bfd, "rxMinInterval", bfd_info->required_min_rx);
      json_object_int_add(json_bfd, "txMinInterval", bfd_info->desired_min_tx);
      if (bfd_tag)
        json_object_object_add(json_obj, "peerBfdInfo", json_bfd);
    }
  else
    {
      vty_out (vty, "  %s%sDetect Mul: %d, Min Rx interval: %d,"
                " Min Tx interval: %d%s",
                    (extra_space) ? "  ": "", (bfd_tag) ? "BFD: " : "  ",
                    bfd_info->detect_mult, bfd_info->required_min_rx,
                    bfd_info->desired_min_tx, VTY_NEWLINE);
    }
}

/*
 * bfd_show_status - Show the BFD status information.
 */
static void
bfd_show_status(struct vty *vty, struct bfd_info *bfd_info, int bfd_tag,
                int extra_space, u_char use_json, json_object *json_bfd)
{
  char time_buf[32];

  if (!bfd_info)
    return;

  bfd_last_update(bfd_info->last_update, time_buf, 32);
  if (use_json)
    {
      json_object_string_add(json_bfd, "status",
                              bfd_get_status_str(bfd_info->status));
      json_object_string_add(json_bfd, "lastUpdate", time_buf);
    }
  else
    {
      vty_out (vty, "  %s%sStatus: %s, Last update: %s%s",
                  (extra_space) ? "  ": "", (bfd_tag) ? "BFD: " : "  ",
                  bfd_get_status_str(bfd_info->status), time_buf, VTY_NEWLINE);
    }
}

/*
 * bfd_show_info - Show the BFD information.
 */
void
bfd_show_info(struct vty *vty, struct bfd_info *bfd_info, int multihop,
              int extra_space, u_char use_json, json_object *json_obj)
{
  json_object *json_bfd = NULL;

  if (!bfd_info)
    return;

  if (use_json)
    {
      json_bfd = json_object_new_object();
      if (multihop)
        json_object_string_add(json_bfd, "type", "multi hop");
      else
        json_object_string_add(json_bfd, "type", "single hop");
    }
  else
    {
      vty_out (vty, "  %sBFD: Type: %s%s", (extra_space) ? "  " : "",
              (multihop) ? "multi hop" : "single hop", VTY_NEWLINE);
    }

  bfd_show_param(vty, bfd_info, 0, extra_space, use_json, json_bfd);
  bfd_show_status(vty, bfd_info, 0, extra_space, use_json, json_bfd);

  if (use_json)
    json_object_object_add(json_obj, "peerBfdInfo", json_bfd);
  else
    vty_out (vty, "%s", VTY_NEWLINE);
}

/*
 * bfd_client_sendmsg - Format and send a client register
 *                    command to Zebra to be forwarded to BFD
 */
void
bfd_client_sendmsg (struct zclient *zclient, int command)
{
  struct stream *s;
  int ret;

  /* Check socket. */
  if (!zclient || zclient->sock < 0)
    {
      if (bfd_debug)
	zlog_debug ("%s: Can't send BFD client register, Zebra client not "
		   "established", __FUNCTION__);
      return;
    }

  s = zclient->obuf;
  stream_reset (s);
  zclient_create_header (s, command, VRF_DEFAULT);

  stream_putl(s, getpid());

  stream_putw_at (s, 0, stream_get_endp (s));

  ret = zclient_send_message(zclient);

  if (ret < 0)
    {
      if (bfd_debug)
	zlog_debug ("bfd_client_sendmsg %ld: zclient_send_message() failed",
		   (long) getpid());
      return;
    }

  return;
}