zebra/zebra_ptm.c

   1 /* Kernel routing table updates using netlink over GNU/Linux system.
   2  * Copyright (C) 1997, 98, 99 Kunihiro Ishiguro
   3  *
   4  * This file is part of GNU Zebra.
   5  *
   6  * GNU Zebra is free software; you can redistribute it and/or modify it
   7  * under the terms of the GNU General Public License as published by the
   8  * Free Software Foundation; either version 2, or (at your option) any
   9  * later version.
  10  *
  11  * GNU Zebra is distributed in the hope that it will be useful, but
  12  * WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License along
  17  * with this program; see the file COPYING; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  19  */
  20
  21 #include <zebra.h>
  22
  23 #include <sys/un.h> /* for sockaddr_un */
  24 #include <net/if.h>
  25
  26 #include "bfd.h"
  27 #include "buffer.h"
  28 #include "command.h"
  29 #include "if.h"
  30 #include "network.h"
  31 #include "ptm_lib.h"
  32 #include "rib.h"
  33 #include "stream.h"
  34 #include "version.h"
  35 #include "vrf.h"
  36 #include "vty.h"
  37 #include "lib_errors.h"
  38
  39 #include "zebra/debug.h"
  40 #include "zebra/interface.h"
  41 #include "zebra/zebra_errors.h"
  42 #include "zebra/zebra_ptm.h"
  43 #include "zebra/zebra_ptm_redistribute.h"
  44 #include "zebra/zebra_router.h"
  45 #include "zebra_vrf.h"
  46
  47 /*
  48  * Choose the BFD implementation that we'll use.
  49  *
  50  * There are two implementations:
  51  * - PTM BFD: which uses an external daemon;
  52  * - bfdd: FRR's own BFD daemon;
  53  */
  54 #if HAVE_BFDD == 0
  55
  56 #define ZEBRA_PTM_RECONNECT_TIME_INITIAL 1 /* initial reconnect is 1s */
  57 #define ZEBRA_PTM_RECONNECT_TIME_MAX     300
  58
  59 #define PTM_MSG_LEN     4
  60 #define PTM_HEADER_LEN  37
  61
  62 const char ZEBRA_PTM_GET_STATUS_CMD[] = "get-status";
  63 const char ZEBRA_PTM_BFD_START_CMD[] = "start-bfd-sess";
  64 const char ZEBRA_PTM_BFD_STOP_CMD[] = "stop-bfd-sess";
  65 const char ZEBRA_PTM_BFD_CLIENT_REG_CMD[] = "reg-bfd-client";
  66 const char ZEBRA_PTM_BFD_CLIENT_DEREG_CMD[] = "dereg-bfd-client";
  67
  68 const char ZEBRA_PTM_CMD_STR[] = "cmd";
  69 const char ZEBRA_PTM_CMD_STATUS_STR[] = "cmd_status";
  70 const char ZEBRA_PTM_PORT_STR[] = "port";
  71 const char ZEBRA_PTM_CBL_STR[] = "cbl status";
  72 const char ZEBRA_PTM_PASS_STR[] = "pass";
  73 const char ZEBRA_PTM_FAIL_STR[] = "fail";
  74 const char ZEBRA_PTM_BFDSTATUS_STR[] = "state";
  75 const char ZEBRA_PTM_BFDSTATUS_UP_STR[] = "Up";
  76 const char ZEBRA_PTM_BFDSTATUS_DOWN_STR[] = "Down";
  77 const char ZEBRA_PTM_BFDDEST_STR[] = "peer";
  78 const char ZEBRA_PTM_BFDSRC_STR[] = "local";
  79 const char ZEBRA_PTM_BFDVRF_STR[] = "vrf";
  80 const char ZEBRA_PTM_INVALID_PORT_NAME[] = "N/A";
  81 const char ZEBRA_PTM_INVALID_SRC_IP[] = "N/A";
  82 const char ZEBRA_PTM_INVALID_VRF[] = "N/A";
  83
  84 const char ZEBRA_PTM_BFD_DST_IP_FIELD[] = "dstIPaddr";
  85 const char ZEBRA_PTM_BFD_SRC_IP_FIELD[] = "srcIPaddr";
  86 const char ZEBRA_PTM_BFD_MIN_RX_FIELD[] = "requiredMinRx";
  87 const char ZEBRA_PTM_BFD_MIN_TX_FIELD[] = "upMinTx";
  88 const char ZEBRA_PTM_BFD_DETECT_MULT_FIELD[] = "detectMult";
  89 const char ZEBRA_PTM_BFD_MULTI_HOP_FIELD[] = "multiHop";
  90 const char ZEBRA_PTM_BFD_CLIENT_FIELD[] = "client";
  91 const char ZEBRA_PTM_BFD_SEQID_FIELD[] = "seqid";
  92 const char ZEBRA_PTM_BFD_IFNAME_FIELD[] = "ifName";
  93 const char ZEBRA_PTM_BFD_MAX_HOP_CNT_FIELD[] = "maxHopCnt";
  94 const char ZEBRA_PTM_BFD_SEND_EVENT[] = "sendEvent";
  95 const char ZEBRA_PTM_BFD_VRF_NAME_FIELD[] = "vrfName";
  96 const char ZEBRA_PTM_BFD_CBIT_FIELD[] = "bfdcbit";
  97
  98 static ptm_lib_handle_t *ptm_hdl;
  99
 100 struct zebra_ptm_cb ptm_cb;
 101
 102 static int zebra_ptm_socket_init(void);
 103 int zebra_ptm_sock_read(struct thread *);
 104 static void zebra_ptm_install_commands(void);
 105 static int zebra_ptm_handle_msg_cb(void *arg, void *in_ctxt);
 106 void zebra_bfd_peer_replay_req(void);
 107 void zebra_ptm_send_status_req(void);
 108 void zebra_ptm_reset_status(int ptm_disable);
 109 static int zebra_ptm_bfd_client_deregister(struct zserv *client);
 110
 111 const char ZEBRA_PTM_SOCK_NAME[] = "\0/var/run/ptmd.socket";
 112
 113 void zebra_ptm_init(void)
 114 {
 115         char buf[64];
 116
 117         memset(&ptm_cb, 0, sizeof(struct zebra_ptm_cb));
 118
 119         ptm_cb.out_data = calloc(1, ZEBRA_PTM_SEND_MAX_SOCKBUF);
 120         if (!ptm_cb.out_data) {
 121                 zlog_debug("%s: Allocation of send data failed", __func__);
 122                 return;
 123         }
 124
 125         ptm_cb.in_data = calloc(1, ZEBRA_PTM_MAX_SOCKBUF);
 126         if (!ptm_cb.in_data) {
 127                 zlog_debug("%s: Allocation of recv data failed", __func__);
 128                 free(ptm_cb.out_data);
 129                 return;
 130         }
 131
 132         ptm_cb.pid = getpid();
 133         zebra_ptm_install_commands();
 134
 135         snprintf(buf, sizeof(buf), "%s", FRR_PTM_NAME);
 136         ptm_hdl = ptm_lib_register(buf, NULL, zebra_ptm_handle_msg_cb,
 137                                    zebra_ptm_handle_msg_cb);
 138         ptm_cb.wb = buffer_new(0);
 139
 140         ptm_cb.reconnect_time = ZEBRA_PTM_RECONNECT_TIME_INITIAL;
 141
 142         ptm_cb.ptm_sock = -1;
 143
 144         hook_register(zserv_client_close, zebra_ptm_bfd_client_deregister);
 145 }
 146
 147 void zebra_ptm_finish(void)
 148 {
 149         buffer_flush_all(ptm_cb.wb, ptm_cb.ptm_sock);
 150
 151         free(ptm_hdl);
 152
 153         if (ptm_cb.out_data)
 154                 free(ptm_cb.out_data);
 155
 156         if (ptm_cb.in_data)
 157                 free(ptm_cb.in_data);
 158
 159         /* Cancel events. */
 160         thread_cancel(&ptm_cb.t_read);
 161         thread_cancel(&ptm_cb.t_write);
 162         thread_cancel(&ptm_cb.t_timer);
 163
 164         if (ptm_cb.wb)
 165                 buffer_free(ptm_cb.wb);
 166
 167         if (ptm_cb.ptm_sock >= 0)
 168                 close(ptm_cb.ptm_sock);
 169 }
 170
 171 static int zebra_ptm_flush_messages(struct thread *thread)
 172 {
 173         ptm_cb.t_write = NULL;
 174
 175         if (ptm_cb.ptm_sock == -1)
 176                 return -1;
 177
 178         errno = 0;
 179
 180         switch (buffer_flush_available(ptm_cb.wb, ptm_cb.ptm_sock)) {
 181         case BUFFER_ERROR:
 182                 flog_err_sys(EC_LIB_SOCKET, "%s ptm socket error: %s", __func__,
 183                              safe_strerror(errno));
 184                 close(ptm_cb.ptm_sock);
 185                 ptm_cb.ptm_sock = -1;
 186                 zebra_ptm_reset_status(0);
 187                 ptm_cb.t_timer = NULL;
 188                 thread_add_timer(zrouter.master, zebra_ptm_connect, NULL,
 189                                  ptm_cb.reconnect_time, &ptm_cb.t_timer);
 190                 return -1;
 191         case BUFFER_PENDING:
 192                 ptm_cb.t_write = NULL;
 193                 thread_add_write(zrouter.master, zebra_ptm_flush_messages, NULL,
 194                                  ptm_cb.ptm_sock, &ptm_cb.t_write);
 195                 break;
 196         case BUFFER_EMPTY:
 197                 break;
 198         }
 199
 200         return 0;
 201 }
 202
 203 static int zebra_ptm_send_message(char *data, int size)
 204 {
 205         errno = 0;
 206         switch (buffer_write(ptm_cb.wb, ptm_cb.ptm_sock, data, size)) {
 207         case BUFFER_ERROR:
 208                 flog_err_sys(EC_LIB_SOCKET, "%s ptm socket error: %s", __func__,
 209                              safe_strerror(errno));
 210                 close(ptm_cb.ptm_sock);
 211                 ptm_cb.ptm_sock = -1;
 212                 zebra_ptm_reset_status(0);
 213                 ptm_cb.t_timer = NULL;
 214                 thread_add_timer(zrouter.master, zebra_ptm_connect, NULL,
 215                                  ptm_cb.reconnect_time, &ptm_cb.t_timer);
 216                 return -1;
 217         case BUFFER_EMPTY:
 218                 thread_cancel(&ptm_cb.t_write);
 219                 break;
 220         case BUFFER_PENDING:
 221                 thread_add_write(zrouter.master, zebra_ptm_flush_messages, NULL,
 222                                  ptm_cb.ptm_sock, &ptm_cb.t_write);
 223                 break;
 224         }
 225
 226         return 0;
 227 }
 228
 229 int zebra_ptm_connect(struct thread *t)
 230 {
 231         int init = 0;
 232
 233         if (ptm_cb.ptm_sock == -1) {
 234                 zebra_ptm_socket_init();
 235                 init = 1;
 236         }
 237
 238         if (ptm_cb.ptm_sock != -1) {
 239                 if (init) {
 240                         ptm_cb.t_read = NULL;
 241                         thread_add_read(zrouter.master, zebra_ptm_sock_read,
 242                                         NULL, ptm_cb.ptm_sock, &ptm_cb.t_read);
 243                         zebra_bfd_peer_replay_req();
 244                 }
 245                 zebra_ptm_send_status_req();
 246                 ptm_cb.reconnect_time = ZEBRA_PTM_RECONNECT_TIME_INITIAL;
 247         } else if (ptm_cb.reconnect_time < ZEBRA_PTM_RECONNECT_TIME_MAX) {
 248                 ptm_cb.reconnect_time *= 2;
 249                 if (ptm_cb.reconnect_time > ZEBRA_PTM_RECONNECT_TIME_MAX)
 250                         ptm_cb.reconnect_time = ZEBRA_PTM_RECONNECT_TIME_MAX;
 251
 252                 ptm_cb.t_timer = NULL;
 253                 thread_add_timer(zrouter.master, zebra_ptm_connect, NULL,
 254                                  ptm_cb.reconnect_time, &ptm_cb.t_timer);
 255         } else if (ptm_cb.reconnect_time >= ZEBRA_PTM_RECONNECT_TIME_MAX) {
 256                 ptm_cb.reconnect_time = ZEBRA_PTM_RECONNECT_TIME_INITIAL;
 257         }
 258
 259         return (errno);
 260 }
 261
 262 DEFUN (zebra_ptm_enable,
 263        zebra_ptm_enable_cmd,
 264        "ptm-enable",
 265        "Enable neighbor check with specified topology\n")
 266 {
 267         struct vrf *vrf;
 268         struct interface *ifp;
 269         struct zebra_if *if_data;
 270
 271         ptm_cb.ptm_enable = ZEBRA_IF_PTM_ENABLE_ON;
 272
 273         RB_FOREACH (vrf, vrf_name_head, &vrfs_by_name)
 274                 FOR_ALL_INTERFACES (vrf, ifp)
 275                         if (!ifp->ptm_enable) {
 276                                 if_data = (struct zebra_if *)ifp->info;
 277                                 if (if_data
 278                                     && (if_data->ptm_enable
 279                                         == ZEBRA_IF_PTM_ENABLE_UNSPEC)) {
 280                                         ifp->ptm_enable =
 281                                                 ZEBRA_IF_PTM_ENABLE_ON;
 282                                 }
 283                                 /* Assign a default unknown status */
 284                                 ifp->ptm_status = ZEBRA_PTM_STATUS_UNKNOWN;
 285                         }
 286
 287         zebra_ptm_connect(NULL);
 288
 289         return CMD_SUCCESS;
 290 }
 291
 292 DEFUN (no_zebra_ptm_enable,
 293        no_zebra_ptm_enable_cmd,
 294        "no ptm-enable",
 295        NO_STR
 296        "Enable neighbor check with specified topology\n")
 297 {
 298         ptm_cb.ptm_enable = ZEBRA_IF_PTM_ENABLE_OFF;
 299         zebra_ptm_reset_status(1);
 300         return CMD_SUCCESS;
 301 }
 302
 303 DEFUN (zebra_ptm_enable_if,
 304        zebra_ptm_enable_if_cmd,
 305        "ptm-enable",
 306        "Enable neighbor check with specified topology\n")
 307 {
 308         VTY_DECLVAR_CONTEXT(interface, ifp);
 309         struct zebra_if *if_data;
 310         int old_ptm_enable;
 311         int send_linkdown = 0;
 312
 313         if_data = ifp->info;
 314         if_data->ptm_enable = ZEBRA_IF_PTM_ENABLE_UNSPEC;
 315
 316         if (ifp->ifindex == IFINDEX_INTERNAL) {
 317                 return CMD_SUCCESS;
 318         }
 319
 320         old_ptm_enable = ifp->ptm_enable;
 321         ifp->ptm_enable = ptm_cb.ptm_enable;
 322
 323         if (if_is_no_ptm_operative(ifp))
 324                 send_linkdown = 1;
 325
 326         if (!old_ptm_enable && ptm_cb.ptm_enable) {
 327                 if (!if_is_operative(ifp) && send_linkdown) {
 328                         if (IS_ZEBRA_DEBUG_EVENT)
 329                                 zlog_debug("%s: Bringing down interface %s",
 330                                            __func__, ifp->name);
 331                         if_down(ifp);
 332                 }
 333         }
 334
 335         return CMD_SUCCESS;
 336 }
 337
 338 DEFUN (no_zebra_ptm_enable_if,
 339        no_zebra_ptm_enable_if_cmd,
 340        "no ptm-enable",
 341        NO_STR
 342        "Enable neighbor check with specified topology\n")
 343 {
 344         VTY_DECLVAR_CONTEXT(interface, ifp);
 345         int send_linkup = 0;
 346         struct zebra_if *if_data;
 347
 348         if ((ifp->ifindex != IFINDEX_INTERNAL) && (ifp->ptm_enable)) {
 349                 if (!if_is_operative(ifp))
 350                         send_linkup = 1;
 351
 352                 ifp->ptm_enable = ZEBRA_IF_PTM_ENABLE_OFF;
 353                 if (if_is_no_ptm_operative(ifp) && send_linkup) {
 354                         if (IS_ZEBRA_DEBUG_EVENT)
 355                                 zlog_debug("%s: Bringing up interface %s",
 356                                            __func__, ifp->name);
 357                         if_up(ifp);
 358                 }
 359         }
 360
 361         if_data = ifp->info;
 362         if_data->ptm_enable = ZEBRA_IF_PTM_ENABLE_OFF;
 363
 364         return CMD_SUCCESS;
 365 }
 366
 367
 368 void zebra_ptm_write(struct vty *vty)
 369 {
 370         if (ptm_cb.ptm_enable)
 371                 vty_out(vty, "ptm-enable\n");
 372
 373         return;
 374 }
 375
 376 static int zebra_ptm_socket_init(void)
 377 {
 378         int ret;
 379         int sock;
 380         struct sockaddr_un addr;
 381
 382         ptm_cb.ptm_sock = -1;
 383
 384         sock = socket(PF_UNIX, SOCK_STREAM, 0);
 385         if (sock < 0)
 386                 return -1;
 387         if (set_nonblocking(sock) < 0) {
 388                 if (IS_ZEBRA_DEBUG_EVENT)
 389                         zlog_debug("%s: Unable to set socket non blocking[%s]",
 390                                    __func__, safe_strerror(errno));
 391                 close(sock);
 392                 return -1;
 393         }
 394
 395         /* Make server socket. */
 396         memset(&addr, 0, sizeof(struct sockaddr_un));
 397         addr.sun_family = AF_UNIX;
 398         memcpy(&addr.sun_path, ZEBRA_PTM_SOCK_NAME,
 399                sizeof(ZEBRA_PTM_SOCK_NAME));
 400
 401         ret = connect(sock, (struct sockaddr *)&addr,
 402                       sizeof(addr.sun_family) + sizeof(ZEBRA_PTM_SOCK_NAME)
 403                               - 1);
 404         if (ret < 0) {
 405                 if (IS_ZEBRA_DEBUG_EVENT)
 406                         zlog_debug("%s: Unable to connect to socket %s [%s]",
 407                                    __func__, ZEBRA_PTM_SOCK_NAME,
 408                                    safe_strerror(errno));
 409                 close(sock);
 410                 return -1;
 411         }
 412         ptm_cb.ptm_sock = sock;
 413         return sock;
 414 }
 415
 416 static void zebra_ptm_install_commands(void)
 417 {
 418         install_element(CONFIG_NODE, &zebra_ptm_enable_cmd);
 419         install_element(CONFIG_NODE, &no_zebra_ptm_enable_cmd);
 420         install_element(INTERFACE_NODE, &zebra_ptm_enable_if_cmd);
 421         install_element(INTERFACE_NODE, &no_zebra_ptm_enable_if_cmd);
 422 }
 423
 424 /* BFD session goes down, send message to the protocols. */
 425 static void if_bfd_session_update(struct interface *ifp, struct prefix *dp,
 426                                   struct prefix *sp, int status,
 427                                   vrf_id_t vrf_id)
 428 {
 429         if (IS_ZEBRA_DEBUG_EVENT) {
 430                 char buf[2][INET6_ADDRSTRLEN];
 431
 432                 if (ifp) {
 433                         zlog_debug(
 434                                 "MESSAGE: ZEBRA_INTERFACE_BFD_DEST_UPDATE %s/%d on %s %s event",
 435                                 inet_ntop(dp->family, &dp->u.prefix, buf[0],
 436                                           INET6_ADDRSTRLEN),
 437                                 dp->prefixlen, ifp->name,
 438                                 bfd_get_status_str(status));
 439                 } else {
 440                         struct vrf *vrf = vrf_lookup_by_id(vrf_id);
 441
 442                         zlog_debug(
 443                                 "MESSAGE: ZEBRA_INTERFACE_BFD_DEST_UPDATE %s/%d with src %s/%d and vrf %s(%u) %s event",
 444                                 inet_ntop(dp->family, &dp->u.prefix, buf[0],
 445                                           INET6_ADDRSTRLEN),
 446                                 dp->prefixlen,
 447                                 inet_ntop(sp->family, &sp->u.prefix, buf[1],
 448                                           INET6_ADDRSTRLEN),
 449                                 sp->prefixlen, VRF_LOGNAME(vrf), vrf_id,
 450                                 bfd_get_status_str(status));
 451                 }
 452         }
 453
 454         zebra_interface_bfd_update(ifp, dp, sp, status, vrf_id);
 455 }
 456
 457 static int zebra_ptm_handle_bfd_msg(void *arg, void *in_ctxt,
 458                                     struct interface *ifp)
 459 {
 460         char bfdst_str[32];
 461         char dest_str[64];
 462         char src_str[64];
 463         char vrf_str[64];
 464         struct prefix dest_prefix;
 465         struct prefix src_prefix;
 466         vrf_id_t vrf_id;
 467
 468         ptm_lib_find_key_in_msg(in_ctxt, ZEBRA_PTM_BFDSTATUS_STR, bfdst_str);
 469
 470         if (bfdst_str[0] == '\0') {
 471                 return -1;
 472         }
 473
 474         ptm_lib_find_key_in_msg(in_ctxt, ZEBRA_PTM_BFDDEST_STR, dest_str);
 475
 476         if (dest_str[0] == '\0') {
 477                 zlog_debug("%s: Key %s not found in PTM msg", __func__,
 478                            ZEBRA_PTM_BFDDEST_STR);
 479                 return -1;
 480         }
 481
 482         ptm_lib_find_key_in_msg(in_ctxt, ZEBRA_PTM_BFDSRC_STR, src_str);
 483
 484         if (src_str[0] == '\0') {
 485                 zlog_debug("%s: Key %s not found in PTM msg", __func__,
 486                            ZEBRA_PTM_BFDSRC_STR);
 487                 return -1;
 488         }
 489
 490         ptm_lib_find_key_in_msg(in_ctxt, ZEBRA_PTM_BFDVRF_STR, vrf_str);
 491
 492         if (vrf_str[0] == '\0') {
 493                 zlog_debug("%s: Key %s not found in PTM msg", __func__,
 494                            ZEBRA_PTM_BFDVRF_STR);
 495                 return -1;
 496         }
 497
 498         if (IS_ZEBRA_DEBUG_EVENT)
 499                 zlog_debug(
 500                         "%s: Recv Port [%s] bfd status [%s] vrf [%s] peer [%s] local [%s]",
 501                         __func__, ifp ? ifp->name : "N/A", bfdst_str, vrf_str,
 502                         dest_str, src_str);
 503
 504         if (str2prefix(dest_str, &dest_prefix) == 0) {
 505                 flog_err(EC_ZEBRA_PREFIX_PARSE_ERROR,
 506                          "%s: Peer addr %s not found", __func__, dest_str);
 507                 return -1;
 508         }
 509
 510         memset(&src_prefix, 0, sizeof(struct prefix));
 511         if (strcmp(ZEBRA_PTM_INVALID_SRC_IP, src_str)) {
 512                 if (str2prefix(src_str, &src_prefix) == 0) {
 513                         flog_err(EC_ZEBRA_PREFIX_PARSE_ERROR,
 514                                  "%s: Local addr %s not found", __func__,
 515                                  src_str);
 516                         return -1;
 517                 }
 518         }
 519
 520         if (!strcmp(ZEBRA_PTM_INVALID_VRF, vrf_str) && ifp) {
 521                 vrf_id = ifp->vrf_id;
 522         } else {
 523                 vrf_id = vrf_name_to_id(vrf_str);
 524         }
 525
 526         if (!strcmp(bfdst_str, ZEBRA_PTM_BFDSTATUS_DOWN_STR)) {
 527                 if_bfd_session_update(ifp, &dest_prefix, &src_prefix,
 528                                       BFD_STATUS_DOWN, vrf_id);
 529         } else {
 530                 if_bfd_session_update(ifp, &dest_prefix, &src_prefix,
 531                                       BFD_STATUS_UP, vrf_id);
 532         }
 533
 534         return 0;
 535 }
 536
 537 static int zebra_ptm_handle_cbl_msg(void *arg, void *in_ctxt,
 538                                     struct interface *ifp, char *cbl_str)
 539 {
 540         int send_linkup = 0;
 541
 542         if (IS_ZEBRA_DEBUG_EVENT)
 543                 zlog_debug("%s: Recv Port [%s] cbl status [%s]", __func__,
 544                            ifp->name, cbl_str);
 545
 546         if (!strcmp(cbl_str, ZEBRA_PTM_PASS_STR)
 547             && (ifp->ptm_status != ZEBRA_PTM_STATUS_UP)) {
 548
 549                 if (ifp->ptm_status == ZEBRA_PTM_STATUS_DOWN)
 550                         send_linkup = 1;
 551                 ifp->ptm_status = ZEBRA_PTM_STATUS_UP;
 552                 if (ifp->ptm_enable && if_is_no_ptm_operative(ifp)
 553                     && send_linkup)
 554                         if_up(ifp);
 555         } else if (!strcmp(cbl_str, ZEBRA_PTM_FAIL_STR)
 556                    && (ifp->ptm_status != ZEBRA_PTM_STATUS_DOWN)) {
 557                 ifp->ptm_status = ZEBRA_PTM_STATUS_DOWN;
 558                 if (ifp->ptm_enable && if_is_no_ptm_operative(ifp))
 559                         if_down(ifp);
 560         }
 561
 562         return 0;
 563 }
 564
 565 /*
 566  * zebra_ptm_handle_msg_cb - The purpose of this callback function is to handle
 567  *  all the command responses and notifications received from PTM.
 568  *
 569  * Command responses: Upon establishing connection with PTM, Zebra requests
 570  *  status of all interfaces using 'get-status' command if global ptm-enable
 571  *  knob is enabled. As a response to the get-status command PTM sends status
 572  *  of all the interfaces as command responses. All other type of command
 573  *  responses with cmd_status key word  are dropped. The sole purpose of
 574  *  registering this function as callback for the command responses is to
 575  *  handle the responses to get-status command.
 576  *
 577  * Notifications: Cable status and BFD session status changes are sent as
 578  *  notifications by PTM. So, this function is also the callback function for
 579  *  processing all the notifications from the PTM.
 580  *
 581  */
 582 static int zebra_ptm_handle_msg_cb(void *arg, void *in_ctxt)
 583 {
 584         struct interface *ifp = NULL;
 585         char port_str[128];
 586         char cbl_str[32];
 587         char cmd_status_str[32];
 588
 589         ptm_lib_find_key_in_msg(in_ctxt, ZEBRA_PTM_CMD_STATUS_STR,
 590                                 cmd_status_str);
 591
 592         /* Drop command response messages */
 593         if (cmd_status_str[0] != '\0') {
 594                 return 0;
 595         }
 596
 597         ptm_lib_find_key_in_msg(in_ctxt, ZEBRA_PTM_PORT_STR, port_str);
 598
 599         if (port_str[0] == '\0') {
 600                 zlog_debug("%s: Key %s not found in PTM msg", __func__,
 601                            ZEBRA_PTM_PORT_STR);
 602                 return -1;
 603         }
 604
 605         if (strcmp(ZEBRA_PTM_INVALID_PORT_NAME, port_str)) {
 606                 ifp = if_lookup_by_name_all_vrf(port_str);
 607
 608                 if (!ifp) {
 609                         flog_warn(EC_ZEBRA_UNKNOWN_INTERFACE,
 610                                   "%s: %s not found in interface list",
 611                                   __func__, port_str);
 612                         return -1;
 613                 }
 614         }
 615
 616         ptm_lib_find_key_in_msg(in_ctxt, ZEBRA_PTM_CBL_STR, cbl_str);
 617
 618         if (cbl_str[0] == '\0') {
 619                 return zebra_ptm_handle_bfd_msg(arg, in_ctxt, ifp);
 620         } else {
 621                 if (ifp) {
 622                         return zebra_ptm_handle_cbl_msg(arg, in_ctxt, ifp,
 623                                                         cbl_str);
 624                 } else {
 625                         return -1;
 626                 }
 627         }
 628 }
 629
 630 int zebra_ptm_sock_read(struct thread *thread)
 631 {
 632         int sock;
 633         int rc;
 634
 635         errno = 0;
 636         sock = THREAD_FD(thread);
 637
 638         if (sock == -1)
 639                 return -1;
 640
 641         /* PTM communicates in CSV format */
 642         do {
 643                 rc = ptm_lib_process_msg(ptm_hdl, sock, ptm_cb.in_data,
 644                                          ZEBRA_PTM_MAX_SOCKBUF, NULL);
 645         } while (rc > 0);
 646
 647         if (((rc == 0) && !errno)
 648             || (errno && (errno != EWOULDBLOCK) && (errno != EAGAIN))) {
 649                 flog_err_sys(EC_LIB_SOCKET,
 650                              "%s routing socket error: %s(%d) bytes %d",
 651                              __func__, safe_strerror(errno), errno, rc);
 652
 653                 close(ptm_cb.ptm_sock);
 654                 ptm_cb.ptm_sock = -1;
 655                 zebra_ptm_reset_status(0);
 656                 ptm_cb.t_timer = NULL;
 657                 thread_add_timer(zrouter.master, zebra_ptm_connect, NULL,
 658                                  ptm_cb.reconnect_time,
 659                                  &ptm_cb.t_timer);
 660                 return -1;
 661         }
 662
 663         ptm_cb.t_read = NULL;
 664         thread_add_read(zrouter.master, zebra_ptm_sock_read, NULL,
 665                         ptm_cb.ptm_sock, &ptm_cb.t_read);
 666
 667         return 0;
 668 }
 669
 670 /* BFD peer/dst register/update */
 671 void zebra_ptm_bfd_dst_register(ZAPI_HANDLER_ARGS)
 672 {
 673         struct stream *s;
 674         struct prefix src_p;
 675         struct prefix dst_p;
 676         uint8_t multi_hop;
 677         uint8_t multi_hop_cnt;
 678         uint8_t detect_mul;
 679         unsigned int min_rx_timer;
 680         unsigned int min_tx_timer;
 681         char if_name[INTERFACE_NAMSIZ];
 682         uint8_t len;
 683         void *out_ctxt;
 684         char buf[INET6_ADDRSTRLEN];
 685         char tmp_buf[64];
 686         int data_len = ZEBRA_PTM_SEND_MAX_SOCKBUF;
 687         unsigned int pid;
 688         uint8_t cbit_set;
 689
 690         if (hdr->command == ZEBRA_BFD_DEST_UPDATE)
 691                 client->bfd_peer_upd8_cnt++;
 692         else
 693                 client->bfd_peer_add_cnt++;
 694
 695         if (IS_ZEBRA_DEBUG_EVENT)
 696                 zlog_debug("bfd_dst_register msg from client %s: length=%d",
 697                            zebra_route_string(client->proto), hdr->length);
 698
 699         if (ptm_cb.ptm_sock == -1) {
 700                 ptm_cb.t_timer = NULL;
 701                 thread_add_timer(zrouter.master, zebra_ptm_connect, NULL,
 702                                  ptm_cb.reconnect_time, &ptm_cb.t_timer);
 703                 return;
 704         }
 705
 706         ptm_lib_init_msg(ptm_hdl, 0, PTMLIB_MSG_TYPE_CMD, NULL, &out_ctxt);
 707         snprintf(tmp_buf, sizeof(tmp_buf), "%s", ZEBRA_PTM_BFD_START_CMD);
 708         ptm_lib_append_msg(ptm_hdl, out_ctxt, ZEBRA_PTM_CMD_STR, tmp_buf);
 709         snprintf(tmp_buf, sizeof(tmp_buf), "%s",
 710                  zebra_route_string(client->proto));
 711         ptm_lib_append_msg(ptm_hdl, out_ctxt, ZEBRA_PTM_BFD_CLIENT_FIELD,
 712                            tmp_buf);
 713
 714         s = msg;
 715
 716         STREAM_GETL(s, pid);
 717         snprintf(tmp_buf, sizeof(tmp_buf), "%d", pid);
 718         ptm_lib_append_msg(ptm_hdl, out_ctxt, ZEBRA_PTM_BFD_SEQID_FIELD,
 719                            tmp_buf);
 720
 721         STREAM_GETW(s, dst_p.family);
 722
 723         if (dst_p.family == AF_INET)
 724                 dst_p.prefixlen = IPV4_MAX_BYTELEN;
 725         else
 726                 dst_p.prefixlen = IPV6_MAX_BYTELEN;
 727
 728         STREAM_GET(&dst_p.u.prefix, s, dst_p.prefixlen);
 729         if (dst_p.family == AF_INET) {
 730                 inet_ntop(AF_INET, &dst_p.u.prefix4, buf, sizeof(buf));
 731                 ptm_lib_append_msg(ptm_hdl, out_ctxt,
 732                                    ZEBRA_PTM_BFD_DST_IP_FIELD, buf);
 733         } else {
 734                 inet_ntop(AF_INET6, &dst_p.u.prefix6, buf, sizeof(buf));
 735                 ptm_lib_append_msg(ptm_hdl, out_ctxt,
 736                                    ZEBRA_PTM_BFD_DST_IP_FIELD, buf);
 737         }
 738
 739         STREAM_GETL(s, min_rx_timer);
 740         snprintf(tmp_buf, sizeof(tmp_buf), "%d", min_rx_timer);
 741         ptm_lib_append_msg(ptm_hdl, out_ctxt, ZEBRA_PTM_BFD_MIN_RX_FIELD,
 742                            tmp_buf);
 743         STREAM_GETL(s, min_tx_timer);
 744         snprintf(tmp_buf, sizeof(tmp_buf), "%d", min_tx_timer);
 745         ptm_lib_append_msg(ptm_hdl, out_ctxt, ZEBRA_PTM_BFD_MIN_TX_FIELD,
 746                            tmp_buf);
 747         STREAM_GETC(s, detect_mul);
 748         snprintf(tmp_buf, sizeof(tmp_buf), "%d", detect_mul);
 749         ptm_lib_append_msg(ptm_hdl, out_ctxt, ZEBRA_PTM_BFD_DETECT_MULT_FIELD,
 750                            tmp_buf);
 751
 752         STREAM_GETC(s, multi_hop);
 753         if (multi_hop) {
 754                 snprintf(tmp_buf, sizeof(tmp_buf), "%d", 1);
 755                 ptm_lib_append_msg(ptm_hdl, out_ctxt,
 756                                    ZEBRA_PTM_BFD_MULTI_HOP_FIELD, tmp_buf);
 757                 STREAM_GETW(s, src_p.family);
 758
 759                 if (src_p.family == AF_INET)
 760                         src_p.prefixlen = IPV4_MAX_BYTELEN;
 761                 else
 762                         src_p.prefixlen = IPV6_MAX_BYTELEN;
 763
 764                 STREAM_GET(&src_p.u.prefix, s, src_p.prefixlen);
 765                 if (src_p.family == AF_INET) {
 766                         inet_ntop(AF_INET, &src_p.u.prefix4, buf, sizeof(buf));
 767                         ptm_lib_append_msg(ptm_hdl, out_ctxt,
 768                                            ZEBRA_PTM_BFD_SRC_IP_FIELD, buf);
 769                 } else {
 770                         inet_ntop(AF_INET6, &src_p.u.prefix6, buf, sizeof(buf));
 771                         ptm_lib_append_msg(ptm_hdl, out_ctxt,
 772                                            ZEBRA_PTM_BFD_SRC_IP_FIELD, buf);
 773                 }
 774
 775                 STREAM_GETC(s, multi_hop_cnt);
 776                 snprintf(tmp_buf, sizeof(tmp_buf), "%d", multi_hop_cnt);
 777                 ptm_lib_append_msg(ptm_hdl, out_ctxt,
 778                                    ZEBRA_PTM_BFD_MAX_HOP_CNT_FIELD, tmp_buf);
 779
 780                 if (zvrf_id(zvrf) != VRF_DEFAULT)
 781                         ptm_lib_append_msg(ptm_hdl, out_ctxt,
 782                                            ZEBRA_PTM_BFD_VRF_NAME_FIELD,
 783                                            zvrf_name(zvrf));
 784         } else {
 785                 if (dst_p.family == AF_INET6) {
 786                         STREAM_GETW(s, src_p.family);
 787
 788                         if (src_p.family == AF_INET)
 789                                 src_p.prefixlen = IPV4_MAX_BYTELEN;
 790                         else
 791                                 src_p.prefixlen = IPV6_MAX_BYTELEN;
 792
 793                         STREAM_GET(&src_p.u.prefix, s, src_p.prefixlen);
 794                         if (src_p.family == AF_INET) {
 795                                 inet_ntop(AF_INET, &src_p.u.prefix4, buf,
 796                                           sizeof(buf));
 797                                 ptm_lib_append_msg(ptm_hdl, out_ctxt,
 798                                                    ZEBRA_PTM_BFD_SRC_IP_FIELD,
 799                                                    buf);
 800                         } else {
 801                                 inet_ntop(AF_INET6, &src_p.u.prefix6, buf,
 802                                           sizeof(buf));
 803                                 ptm_lib_append_msg(ptm_hdl, out_ctxt,
 804                                                    ZEBRA_PTM_BFD_SRC_IP_FIELD,
 805                                                    buf);
 806                         }
 807                 }
 808                 STREAM_GETC(s, len);
 809                 STREAM_GET(if_name, s, len);
 810                 if_name[len] = '\0';
 811
 812                 ptm_lib_append_msg(ptm_hdl, out_ctxt,
 813                                    ZEBRA_PTM_BFD_IFNAME_FIELD, if_name);
 814         }
 815         STREAM_GETC(s, cbit_set);
 816         snprintf(tmp_buf, sizeof(tmp_buf), "%d", cbit_set);
 817         ptm_lib_append_msg(ptm_hdl, out_ctxt,
 818                            ZEBRA_PTM_BFD_CBIT_FIELD, tmp_buf);
 819
 820         snprintf(tmp_buf, sizeof(tmp_buf), "%d", 1);
 821         ptm_lib_append_msg(ptm_hdl, out_ctxt, ZEBRA_PTM_BFD_SEND_EVENT,
 822                            tmp_buf);
 823
 824         ptm_lib_complete_msg(ptm_hdl, out_ctxt, ptm_cb.out_data, &data_len);
 825
 826         if (IS_ZEBRA_DEBUG_SEND)
 827                 zlog_debug("%s: Sent message (%d) %s", __func__, data_len,
 828                            ptm_cb.out_data);
 829         zebra_ptm_send_message(ptm_cb.out_data, data_len);
 830
 831         return;
 832
 833 stream_failure:
 834         ptm_lib_cleanup_msg(ptm_hdl, out_ctxt);
 835 }
 836
 837 /* BFD peer/dst deregister */
 838 void zebra_ptm_bfd_dst_deregister(ZAPI_HANDLER_ARGS)
 839 {
 840         struct stream *s;
 841         struct prefix src_p;
 842         struct prefix dst_p;
 843         uint8_t multi_hop;
 844         char if_name[INTERFACE_NAMSIZ];
 845         uint8_t len;
 846         char buf[INET6_ADDRSTRLEN];
 847         char tmp_buf[64];
 848         int data_len = ZEBRA_PTM_SEND_MAX_SOCKBUF;
 849         void *out_ctxt;
 850         unsigned int pid;
 851
 852         client->bfd_peer_del_cnt++;
 853
 854         if (IS_ZEBRA_DEBUG_EVENT)
 855                 zlog_debug("bfd_dst_deregister msg from client %s: length=%d",
 856                            zebra_route_string(client->proto), hdr->length);
 857
 858         if (ptm_cb.ptm_sock == -1) {
 859                 ptm_cb.t_timer = NULL;
 860                 thread_add_timer(zrouter.master, zebra_ptm_connect, NULL,
 861                                  ptm_cb.reconnect_time, &ptm_cb.t_timer);
 862                 return;
 863         }
 864
 865         ptm_lib_init_msg(ptm_hdl, 0, PTMLIB_MSG_TYPE_CMD, NULL, &out_ctxt);
 866
 867         snprintf(tmp_buf, sizeof(tmp_buf), "%s", ZEBRA_PTM_BFD_STOP_CMD);
 868         ptm_lib_append_msg(ptm_hdl, out_ctxt, ZEBRA_PTM_CMD_STR, tmp_buf);
 869
 870         snprintf(tmp_buf, sizeof(tmp_buf), "%s",
 871                  zebra_route_string(client->proto));
 872         ptm_lib_append_msg(ptm_hdl, out_ctxt, ZEBRA_PTM_BFD_CLIENT_FIELD,
 873                            tmp_buf);
 874
 875         s = msg;
 876
 877         STREAM_GETL(s, pid);
 878         snprintf(tmp_buf, sizeof(tmp_buf), "%d", pid);
 879         ptm_lib_append_msg(ptm_hdl, out_ctxt, ZEBRA_PTM_BFD_SEQID_FIELD,
 880                            tmp_buf);
 881
 882         STREAM_GETW(s, dst_p.family);
 883
 884         if (dst_p.family == AF_INET)
 885                 dst_p.prefixlen = IPV4_MAX_BYTELEN;
 886         else
 887                 dst_p.prefixlen = IPV6_MAX_BYTELEN;
 888
 889         STREAM_GET(&dst_p.u.prefix, s, dst_p.prefixlen);
 890         if (dst_p.family == AF_INET)
 891                 inet_ntop(AF_INET, &dst_p.u.prefix4, buf, sizeof(buf));
 892         else
 893                 inet_ntop(AF_INET6, &dst_p.u.prefix6, buf, sizeof(buf));
 894         ptm_lib_append_msg(ptm_hdl, out_ctxt, ZEBRA_PTM_BFD_DST_IP_FIELD, buf);
 895
 896
 897         STREAM_GETC(s, multi_hop);
 898         if (multi_hop) {
 899                 snprintf(tmp_buf, sizeof(tmp_buf), "%d", 1);
 900                 ptm_lib_append_msg(ptm_hdl, out_ctxt,
 901                                    ZEBRA_PTM_BFD_MULTI_HOP_FIELD, tmp_buf);
 902
 903                 STREAM_GETW(s, src_p.family);
 904
 905                 if (src_p.family == AF_INET)
 906                         src_p.prefixlen = IPV4_MAX_BYTELEN;
 907                 else
 908                         src_p.prefixlen = IPV6_MAX_BYTELEN;
 909
 910                 STREAM_GET(&src_p.u.prefix, s, src_p.prefixlen);
 911                 if (src_p.family == AF_INET)
 912                         inet_ntop(AF_INET, &src_p.u.prefix4, buf, sizeof(buf));
 913                 else
 914                         inet_ntop(AF_INET6, &src_p.u.prefix6, buf, sizeof(buf));
 915                 ptm_lib_append_msg(ptm_hdl, out_ctxt,
 916                                    ZEBRA_PTM_BFD_SRC_IP_FIELD, buf);
 917
 918                 if (zvrf_id(zvrf) != VRF_DEFAULT)
 919                         ptm_lib_append_msg(ptm_hdl, out_ctxt,
 920                                            ZEBRA_PTM_BFD_VRF_NAME_FIELD,
 921                                            zvrf_name(zvrf));
 922         } else {
 923                 if (dst_p.family == AF_INET6) {
 924                         STREAM_GETW(s, src_p.family);
 925
 926                         if (src_p.family == AF_INET)
 927                                 src_p.prefixlen = IPV4_MAX_BYTELEN;
 928                         else
 929                                 src_p.prefixlen = IPV6_MAX_BYTELEN;
 930
 931                         STREAM_GET(&src_p.u.prefix, s, src_p.prefixlen);
 932                         if (src_p.family == AF_INET) {
 933                                 inet_ntop(AF_INET, &src_p.u.prefix4, buf,
 934                                           sizeof(buf));
 935                                 ptm_lib_append_msg(ptm_hdl, out_ctxt,
 936                                                    ZEBRA_PTM_BFD_SRC_IP_FIELD,
 937                                                    buf);
 938                         } else {
 939                                 inet_ntop(AF_INET6, &src_p.u.prefix6, buf,
 940                                           sizeof(buf));
 941                                 ptm_lib_append_msg(ptm_hdl, out_ctxt,
 942                                                    ZEBRA_PTM_BFD_SRC_IP_FIELD,
 943                                                    buf);
 944                         }
 945                 }
 946
 947                 STREAM_GETC(s, len);
 948                 STREAM_GET(if_name, s, len);
 949                 if_name[len] = '\0';
 950
 951                 ptm_lib_append_msg(ptm_hdl, out_ctxt,
 952                                    ZEBRA_PTM_BFD_IFNAME_FIELD, if_name);
 953         }
 954
 955         ptm_lib_complete_msg(ptm_hdl, out_ctxt, ptm_cb.out_data, &data_len);
 956         if (IS_ZEBRA_DEBUG_SEND)
 957                 zlog_debug("%s: Sent message (%d) %s", __func__, data_len,
 958                            ptm_cb.out_data);
 959
 960         zebra_ptm_send_message(ptm_cb.out_data, data_len);
 961
 962         return;
 963
 964 stream_failure:
 965         ptm_lib_cleanup_msg(ptm_hdl, out_ctxt);
 966 }
 967
 968 /* BFD client register */
 969 void zebra_ptm_bfd_client_register(ZAPI_HANDLER_ARGS)
 970 {
 971         struct stream *s;
 972         unsigned int pid;
 973         void *out_ctxt = NULL;
 974         char tmp_buf[64];
 975         int data_len = ZEBRA_PTM_SEND_MAX_SOCKBUF;
 976
 977         client->bfd_client_reg_cnt++;
 978
 979         if (IS_ZEBRA_DEBUG_EVENT)
 980                 zlog_debug("bfd_client_register msg from client %s: length=%d",
 981                            zebra_route_string(client->proto), hdr->length);
 982
 983         s = msg;
 984         STREAM_GETL(s, pid);
 985
 986         if (ptm_cb.ptm_sock == -1) {
 987                 ptm_cb.t_timer = NULL;
 988                 thread_add_timer(zrouter.master, zebra_ptm_connect, NULL,
 989                                  ptm_cb.reconnect_time, &ptm_cb.t_timer);
 990                 return;
 991         }
 992
 993         ptm_lib_init_msg(ptm_hdl, 0, PTMLIB_MSG_TYPE_CMD, NULL, &out_ctxt);
 994
 995         snprintf(tmp_buf, sizeof(tmp_buf), "%s", ZEBRA_PTM_BFD_CLIENT_REG_CMD);
 996         ptm_lib_append_msg(ptm_hdl, out_ctxt, ZEBRA_PTM_CMD_STR, tmp_buf);
 997
 998         snprintf(tmp_buf, sizeof(tmp_buf), "%s",
 999                  zebra_route_string(client->proto));
1000         ptm_lib_append_msg(ptm_hdl, out_ctxt, ZEBRA_PTM_BFD_CLIENT_FIELD,
1001                            tmp_buf);
1002
1003         snprintf(tmp_buf, sizeof(tmp_buf), "%d", pid);
1004         ptm_lib_append_msg(ptm_hdl, out_ctxt, ZEBRA_PTM_BFD_SEQID_FIELD,
1005                            tmp_buf);
1006
1007         ptm_lib_complete_msg(ptm_hdl, out_ctxt, ptm_cb.out_data, &data_len);
1008
1009         if (IS_ZEBRA_DEBUG_SEND)
1010                 zlog_debug("%s: Sent message (%d) %s", __func__, data_len,
1011                            ptm_cb.out_data);
1012         zebra_ptm_send_message(ptm_cb.out_data, data_len);
1013
1014         SET_FLAG(ptm_cb.client_flags[client->proto],
1015                  ZEBRA_PTM_BFD_CLIENT_FLAG_REG);
1016
1017         return;
1018
1019 stream_failure:
1020         /*
1021          * IF we ever add more STREAM_GETXXX functions after the out_ctxt
1022          * is allocated then we need to add this code back in
1023          *
1024          * if (out_ctxt)
1025          *      ptm_lib_cleanup_msg(ptm_hdl, out_ctxt);
1026          */
1027         return;
1028 }
1029
1030 /* BFD client deregister */
1031 int zebra_ptm_bfd_client_deregister(struct zserv *client)
1032 {
1033         uint8_t proto = client->proto;
1034         void *out_ctxt;
1035         char tmp_buf[64];
1036         int data_len = ZEBRA_PTM_SEND_MAX_SOCKBUF;
1037
1038         if (!IS_BFD_ENABLED_PROTOCOL(proto))
1039                 return 0;
1040
1041         if (IS_ZEBRA_DEBUG_EVENT)
1042                 zlog_debug("bfd_client_deregister msg for client %s",
1043                            zebra_route_string(proto));
1044
1045         if (ptm_cb.ptm_sock == -1) {
1046                 ptm_cb.t_timer = NULL;
1047                 thread_add_timer(zrouter.master, zebra_ptm_connect, NULL,
1048                                  ptm_cb.reconnect_time, &ptm_cb.t_timer);
1049                 return 0;
1050         }
1051
1052         ptm_lib_init_msg(ptm_hdl, 0, PTMLIB_MSG_TYPE_CMD, NULL, &out_ctxt);
1053
1054         snprintf(tmp_buf, sizeof(tmp_buf), "%s",
1055                  ZEBRA_PTM_BFD_CLIENT_DEREG_CMD);
1056         ptm_lib_append_msg(ptm_hdl, out_ctxt, ZEBRA_PTM_CMD_STR, tmp_buf);
1057
1058         snprintf(tmp_buf, sizeof(tmp_buf), "%s", zebra_route_string(proto));
1059         ptm_lib_append_msg(ptm_hdl, out_ctxt, ZEBRA_PTM_BFD_CLIENT_FIELD,
1060                            tmp_buf);
1061
1062         ptm_lib_complete_msg(ptm_hdl, out_ctxt, ptm_cb.out_data, &data_len);
1063
1064         if (IS_ZEBRA_DEBUG_SEND)
1065                 zlog_debug("%s: Sent message (%d) %s", __func__, data_len,
1066                            ptm_cb.out_data);
1067
1068         zebra_ptm_send_message(ptm_cb.out_data, data_len);
1069         UNSET_FLAG(ptm_cb.client_flags[proto], ZEBRA_PTM_BFD_CLIENT_FLAG_REG);
1070
1071         return 0;
1072 }
1073
1074 int zebra_ptm_get_enable_state(void)
1075 {
1076         return ptm_cb.ptm_enable;
1077 }
1078
1079 /*
1080  * zebra_ptm_get_status_str - Convert status to a display string.
1081  */
1082 static const char *zebra_ptm_get_status_str(int status)
1083 {
1084         switch (status) {
1085         case ZEBRA_PTM_STATUS_DOWN:
1086                 return "fail";
1087         case ZEBRA_PTM_STATUS_UP:
1088                 return "pass";
1089         case ZEBRA_PTM_STATUS_UNKNOWN:
1090         default:
1091                 return "n/a";
1092         }
1093 }
1094
1095 void zebra_ptm_show_status(struct vty *vty, struct interface *ifp)
1096 {
1097         vty_out(vty, "  PTM status: ");
1098         if (ifp->ptm_enable) {
1099                 vty_out(vty, "%s\n", zebra_ptm_get_status_str(ifp->ptm_status));
1100         } else {
1101                 vty_out(vty, "disabled\n");
1102         }
1103 }
1104
1105 void zebra_ptm_send_status_req(void)
1106 {
1107         void *out_ctxt;
1108         int len = ZEBRA_PTM_SEND_MAX_SOCKBUF;
1109
1110         if (ptm_cb.ptm_enable) {
1111                 ptm_lib_init_msg(ptm_hdl, 0, PTMLIB_MSG_TYPE_CMD, NULL,
1112                                  &out_ctxt);
1113                 ptm_lib_append_msg(ptm_hdl, out_ctxt, ZEBRA_PTM_CMD_STR,
1114                                    ZEBRA_PTM_GET_STATUS_CMD);
1115                 ptm_lib_complete_msg(ptm_hdl, out_ctxt, ptm_cb.out_data, &len);
1116
1117                 zebra_ptm_send_message(ptm_cb.out_data, len);
1118         }
1119 }
1120
1121 void zebra_ptm_reset_status(int ptm_disable)
1122 {
1123         struct vrf *vrf;
1124         struct interface *ifp;
1125         int send_linkup;
1126
1127         RB_FOREACH (vrf, vrf_id_head, &vrfs_by_id)
1128                 FOR_ALL_INTERFACES (vrf, ifp) {
1129                         send_linkup = 0;
1130                         if (ifp->ptm_enable) {
1131                                 if (!if_is_operative(ifp))
1132                                         send_linkup = 1;
1133
1134                                 if (ptm_disable)
1135                                         ifp->ptm_enable =
1136                                                 ZEBRA_IF_PTM_ENABLE_OFF;
1137                                 ifp->ptm_status = ZEBRA_PTM_STATUS_UNKNOWN;
1138
1139                                 if (if_is_operative(ifp) && send_linkup) {
1140                                         if (IS_ZEBRA_DEBUG_EVENT)
1141                                                 zlog_debug(
1142                                                         "%s: Bringing up interface %s",
1143                                                         __func__, ifp->name);
1144                                         if_up(ifp);
1145                                 }
1146                         }
1147                 }
1148 }
1149
1150 void zebra_ptm_if_init(struct zebra_if *zebra_ifp)
1151 {
1152         zebra_ifp->ptm_enable = ZEBRA_IF_PTM_ENABLE_UNSPEC;
1153 }
1154
1155 void zebra_ptm_if_set_ptm_state(struct interface *ifp,
1156                                 struct zebra_if *zebra_ifp)
1157 {
1158         if (zebra_ifp && zebra_ifp->ptm_enable != ZEBRA_IF_PTM_ENABLE_UNSPEC)
1159                 ifp->ptm_enable = zebra_ifp->ptm_enable;
1160 }
1161
1162 void zebra_ptm_if_write(struct vty *vty, struct zebra_if *zebra_ifp)
1163 {
1164         if (zebra_ifp->ptm_enable == ZEBRA_IF_PTM_ENABLE_OFF)
1165                 vty_out(vty, " no ptm-enable\n");
1166 }
1167
1168 #else /* HAVE_BFDD */
1169
1170 #include "zebra/zebra_memory.h"
1171
1172 /*
1173  * Data structures.
1174  */
1175 struct ptm_process {
1176         struct zserv *pp_zs;
1177         pid_t pp_pid;
1178
1179         TAILQ_ENTRY(ptm_process) pp_entry;
1180 };
1181 TAILQ_HEAD(ppqueue, ptm_process) ppqueue;
1182
1183 DEFINE_MTYPE_STATIC(ZEBRA, ZEBRA_PTM_BFD_PROCESS,
1184                     "PTM BFD process registration table.");
1185
1186 /*
1187  * Prototypes.
1188  */
1189 static struct ptm_process *pp_new(pid_t pid, struct zserv *zs);
1190 static struct ptm_process *pp_lookup_byzs(struct zserv *zs);
1191 static void pp_free(struct ptm_process *pp);
1192 static void pp_free_all(void);
1193
1194 static void zebra_ptm_send_bfdd(struct stream *msg);
1195 static void zebra_ptm_send_clients(struct stream *msg);
1196 static int _zebra_ptm_bfd_client_deregister(struct zserv *zs);
1197 static void _zebra_ptm_reroute(struct zserv *zs, struct zebra_vrf *zvrf,
1198                                struct stream *msg, uint32_t command);
1199
1200
1201 /*
1202  * Process PID registration.
1203  */
1204 static struct ptm_process *pp_new(pid_t pid, struct zserv *zs)
1205 {
1206         struct ptm_process *pp;
1207
1208 #ifdef PTM_DEBUG
1209         /* Sanity check: more than one client can't have the same PID. */
1210         TAILQ_FOREACH(pp, &ppqueue, pp_entry) {
1211                 if (pp->pp_pid == pid && pp->pp_zs != zs)
1212                         zlog_err("%s:%d pid and client pointer doesn't match",
1213                                  __FILE__, __LINE__);
1214         }
1215 #endif /* PTM_DEBUG */
1216
1217         /* Lookup for duplicates. */
1218         pp = pp_lookup_byzs(zs);
1219         if (pp != NULL)
1220                 return pp;
1221
1222         /* Allocate and register new process. */
1223         pp = XCALLOC(MTYPE_ZEBRA_PTM_BFD_PROCESS, sizeof(*pp));
1224
1225         pp->pp_pid = pid;
1226         pp->pp_zs = zs;
1227         TAILQ_INSERT_HEAD(&ppqueue, pp, pp_entry);
1228
1229         return pp;
1230 }
1231
1232 static struct ptm_process *pp_lookup_byzs(struct zserv *zs)
1233 {
1234         struct ptm_process *pp;
1235
1236         TAILQ_FOREACH(pp, &ppqueue, pp_entry) {
1237                 if (pp->pp_zs != zs)
1238                         continue;
1239
1240                 break;
1241         }
1242
1243         return pp;
1244 }
1245
1246 static void pp_free(struct ptm_process *pp)
1247 {
1248         if (pp == NULL)
1249                 return;
1250
1251         TAILQ_REMOVE(&ppqueue, pp, pp_entry);
1252         XFREE(MTYPE_ZEBRA_PTM_BFD_PROCESS, pp);
1253 }
1254
1255 static void pp_free_all(void)
1256 {
1257         struct ptm_process *pp;
1258
1259         while (!TAILQ_EMPTY(&ppqueue)) {
1260                 pp = TAILQ_FIRST(&ppqueue);
1261                 pp_free(pp);
1262         }
1263 }
1264
1265
1266 /*
1267  * Use the FRR's internal daemon implementation.
1268  */
1269 static void zebra_ptm_send_bfdd(struct stream *msg)
1270 {
1271         struct listnode *node;
1272         struct zserv *client;
1273         struct stream *msgc;
1274
1275         /* Create copy for replication. */
1276         msgc = stream_dup(msg);
1277         if (msgc == NULL) {
1278                 zlog_debug("%s: not enough memory", __func__);
1279                 return;
1280         }
1281
1282         /* Send message to all running BFDd daemons. */
1283         for (ALL_LIST_ELEMENTS_RO(zrouter.client_list, node, client)) {
1284                 if (client->proto != ZEBRA_ROUTE_BFD)
1285                         continue;
1286
1287                 zserv_send_message(client, msg);
1288
1289                 /* Allocate more messages. */
1290                 msg = stream_dup(msgc);
1291                 if (msg == NULL) {
1292                         zlog_debug("%s: not enough memory", __func__);
1293                         return;
1294                 }
1295         }
1296
1297         stream_free(msgc);
1298         stream_free(msg);
1299 }
1300
1301 static void zebra_ptm_send_clients(struct stream *msg)
1302 {
1303         struct listnode *node;
1304         struct zserv *client;
1305         struct stream *msgc;
1306
1307         /* Create copy for replication. */
1308         msgc = stream_dup(msg);
1309         if (msgc == NULL) {
1310                 zlog_debug("%s: not enough memory", __func__);
1311                 return;
1312         }
1313
1314         /* Send message to all running client daemons. */
1315         for (ALL_LIST_ELEMENTS_RO(zrouter.client_list, node, client)) {
1316                 if (!IS_BFD_ENABLED_PROTOCOL(client->proto))
1317                         continue;
1318
1319                 zserv_send_message(client, msg);
1320
1321                 /* Allocate more messages. */
1322                 msg = stream_dup(msgc);
1323                 if (msg == NULL) {
1324                         zlog_debug("%s: not enough memory", __func__);
1325                         return;
1326                 }
1327         }
1328
1329         stream_free(msgc);
1330         stream_free(msg);
1331 }
1332
1333 static int _zebra_ptm_bfd_client_deregister(struct zserv *zs)
1334 {
1335         struct stream *msg;
1336         struct ptm_process *pp;
1337
1338         if (!IS_BFD_ENABLED_PROTOCOL(zs->proto))
1339                 return 0;
1340
1341         /* Find daemon pid by zebra connection pointer. */
1342         pp = pp_lookup_byzs(zs);
1343         if (pp == NULL) {
1344                 zlog_err("%s:%d failed to find process pid registration",
1345                          __FILE__, __LINE__);
1346                 return -1;
1347         }
1348
1349         /* Generate, send message and free() daemon related data. */
1350         msg = stream_new(ZEBRA_MAX_PACKET_SIZ);
1351         if (msg == NULL) {
1352                 zlog_debug("%s: not enough memory", __func__);
1353                 return 0;
1354         }
1355
1356         /*
1357          * The message type will be BFD_DEST_REPLY so we can use only
1358          * one callback at the `bfdd` side, however the real command
1359          * number will be included right after the zebra header.
1360          */
1361         zclient_create_header(msg, ZEBRA_BFD_DEST_REPLAY, 0);
1362         stream_putl(msg, ZEBRA_BFD_CLIENT_DEREGISTER);
1363
1364         /* Put process PID. */
1365         stream_putl(msg, pp->pp_pid);
1366
1367         /* Update the data pointers. */
1368         stream_putw_at(msg, 0, stream_get_endp(msg));
1369
1370         zebra_ptm_send_bfdd(msg);
1371
1372         pp_free(pp);
1373
1374         return 0;
1375 }
1376
1377 void zebra_ptm_init(void)
1378 {
1379         /* Initialize the ptm process information list. */
1380         TAILQ_INIT(&ppqueue);
1381
1382         /*
1383          * Send deregistration messages to BFD daemon when some other
1384          * daemon closes. This will help avoid sending daemons
1385          * unnecessary notification messages.
1386          */
1387         hook_register(zserv_client_close, _zebra_ptm_bfd_client_deregister);
1388 }
1389
1390 void zebra_ptm_finish(void)
1391 {
1392         /* Remove the client disconnect hook and free all memory. */
1393         hook_unregister(zserv_client_close, _zebra_ptm_bfd_client_deregister);
1394         pp_free_all();
1395 }
1396
1397
1398 /*
1399  * Message handling.
1400  */
1401 static void _zebra_ptm_reroute(struct zserv *zs, struct zebra_vrf *zvrf,
1402                                struct stream *msg, uint32_t command)
1403 {
1404         struct stream *msgc;
1405         char buf[ZEBRA_MAX_PACKET_SIZ];
1406         pid_t ppid;
1407
1408         /* Create BFD header */
1409         msgc = stream_new(ZEBRA_MAX_PACKET_SIZ);
1410         zclient_create_header(msgc, ZEBRA_BFD_DEST_REPLAY, zvrf->vrf->vrf_id);
1411         stream_putl(msgc, command);
1412
1413         if (STREAM_READABLE(msg) > STREAM_WRITEABLE(msgc)) {
1414                 zlog_warn("Cannot fit extended BFD header plus original message contents into ZAPI packet; dropping message");
1415                 goto stream_failure;
1416         }
1417
1418         /* Copy original message, excluding header, into new message */
1419         stream_get_from(buf, msg, stream_get_getp(msg), STREAM_READABLE(msg));
1420         stream_put(msgc, buf, STREAM_READABLE(msg));
1421
1422         /* Update length field */
1423         stream_putw_at(msgc, 0, STREAM_READABLE(msgc));
1424
1425         zebra_ptm_send_bfdd(msgc);
1426         msgc = NULL;
1427
1428         /* Registrate process PID for shutdown hook. */
1429         STREAM_GETL(msg, ppid);
1430         pp_new(ppid, zs);
1431
1432         return;
1433
1434 stream_failure:
1435         if (msgc)
1436                 stream_free(msgc);
1437         zlog_err("%s:%d failed to registrate client pid", __FILE__, __LINE__);
1438 }
1439
1440 void zebra_ptm_bfd_dst_register(ZAPI_HANDLER_ARGS)
1441 {
1442         if (IS_ZEBRA_DEBUG_EVENT)
1443                 zlog_debug("bfd_dst_register msg from client %s: length=%d",
1444                            zebra_route_string(client->proto), hdr->length);
1445
1446         _zebra_ptm_reroute(client, zvrf, msg, ZEBRA_BFD_DEST_REGISTER);
1447 }
1448
1449 void zebra_ptm_bfd_dst_deregister(ZAPI_HANDLER_ARGS)
1450 {
1451         if (IS_ZEBRA_DEBUG_EVENT)
1452                 zlog_debug("bfd_dst_deregister msg from client %s: length=%d",
1453                            zebra_route_string(client->proto), hdr->length);
1454
1455         _zebra_ptm_reroute(client, zvrf, msg, ZEBRA_BFD_DEST_DEREGISTER);
1456 }
1457
1458 void zebra_ptm_bfd_client_register(ZAPI_HANDLER_ARGS)
1459 {
1460         if (IS_ZEBRA_DEBUG_EVENT)
1461                 zlog_debug("bfd_client_register msg from client %s: length=%d",
1462                            zebra_route_string(client->proto), hdr->length);
1463
1464         _zebra_ptm_reroute(client, zvrf, msg, ZEBRA_BFD_CLIENT_REGISTER);
1465 }
1466
1467 void zebra_ptm_bfd_dst_replay(ZAPI_HANDLER_ARGS)
1468 {
1469         struct stream *msgc;
1470         size_t zmsglen, zhdrlen;
1471         uint32_t cmd;
1472
1473         /*
1474          * NOTE:
1475          * Replay messages with HAVE_BFDD are meant to be replayed to
1476          * the client daemons. These messages are composed and
1477          * originated from the `bfdd` daemon.
1478          */
1479         if (IS_ZEBRA_DEBUG_EVENT)
1480                 zlog_debug("bfd_dst_update msg from client %s: length=%d",
1481                            zebra_route_string(client->proto), hdr->length);
1482
1483         /*
1484          * Client messages must be re-routed, otherwise do the `bfdd`
1485          * special treatment.
1486          */
1487         if (client->proto != ZEBRA_ROUTE_BFD) {
1488                 _zebra_ptm_reroute(client, zvrf, msg, ZEBRA_BFD_DEST_REPLAY);
1489                 return;
1490         }
1491
1492         /* Figure out if this is an DEST_UPDATE or DEST_REPLAY. */
1493         if (stream_getl2(msg, &cmd) == false) {
1494                 zlog_err("%s: expected at least 4 bytes (command)", __func__);
1495                 return;
1496         }
1497
1498         /*
1499          * Don't modify message in the zebra API. In order to do that we
1500          * need to allocate a new message stream and copy the message
1501          * provided by zebra.
1502          */
1503         msgc = stream_new(ZEBRA_MAX_PACKET_SIZ);
1504         if (msgc == NULL) {
1505                 zlog_debug("%s: not enough memory", __func__);
1506                 return;
1507         }
1508
1509         /* Calculate our header size plus the message contents. */
1510         if (cmd != ZEBRA_BFD_DEST_REPLAY) {
1511                 zhdrlen = ZEBRA_HEADER_SIZE;
1512                 zmsglen = msg->endp - msg->getp;
1513                 memcpy(msgc->data + zhdrlen, msg->data + msg->getp, zmsglen);
1514
1515                 zclient_create_header(msgc, cmd, zvrf_id(zvrf));
1516
1517                 msgc->getp = 0;
1518                 msgc->endp = zhdrlen + zmsglen;
1519         } else
1520                 zclient_create_header(msgc, cmd, zvrf_id(zvrf));
1521
1522         /* Update the data pointers. */
1523         stream_putw_at(msgc, 0, stream_get_endp(msgc));
1524
1525         zebra_ptm_send_clients(msgc);
1526 }
1527
1528 /*
1529  * Unused functions.
1530  */
1531 void zebra_ptm_if_init(struct zebra_if *zifp __attribute__((__unused__)))
1532 {
1533         /* NOTHING */
1534 }
1535
1536 int zebra_ptm_get_enable_state(void)
1537 {
1538         return 0;
1539 }
1540
1541 void zebra_ptm_show_status(struct vty *vty __attribute__((__unused__)),
1542                            struct interface *ifp __attribute__((__unused__)))
1543 {
1544         /* NOTHING */
1545 }
1546
1547 void zebra_ptm_write(struct vty *vty __attribute__((__unused__)))
1548 {
1549         /* NOTHING */
1550 }
1551
1552 void zebra_ptm_if_write(struct vty *vty __attribute__((__unused__)),
1553                         struct zebra_if *zifp __attribute__((__unused__)))
1554 {
1555         /* NOTHING */
1556 }
1557 void zebra_ptm_if_set_ptm_state(struct interface *i __attribute__((__unused__)),
1558                                 struct zebra_if *zi __attribute__((__unused__)))
1559 {
1560         /* NOTHING */
1561 }
1562
1563 #endif /* HAVE_BFDD */