pbrd/pbr_zebra.c

   1 /*
   2  * Zebra connect code.
   3  * Copyright (C) 2018 Cumulus Networks, Inc.
   4  *               Donald Sharp
   5  *
   6  * FRR 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  * FRR 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 #include <zebra.h>
  21
  22 #include "thread.h"
  23 #include "command.h"
  24 #include "network.h"
  25 #include "prefix.h"
  26 #include "routemap.h"
  27 #include "table.h"
  28 #include "stream.h"
  29 #include "memory.h"
  30 #include "zclient.h"
  31 #include "filter.h"
  32 #include "plist.h"
  33 #include "log.h"
  34 #include "nexthop.h"
  35 #include "nexthop_group.h"
  36
  37 #include "pbr_nht.h"
  38 #include "pbr_map.h"
  39 #include "pbr_memory.h"
  40 #include "pbr_zebra.h"
  41 #include "pbr_debug.h"
  42
  43 DEFINE_MTYPE_STATIC(PBRD, PBR_INTERFACE, "PBR Interface")
  44
  45 /* Zebra structure to hold current status. */
  46 struct zclient *zclient;
  47
  48 struct pbr_interface *pbr_if_new(struct interface *ifp)
  49 {
  50         struct pbr_interface *pbr_ifp;
  51
  52         zassert(ifp);
  53         zassert(!ifp->info);
  54
  55         pbr_ifp = XCALLOC(MTYPE_PBR_INTERFACE, sizeof(*pbr_ifp));
  56
  57         ifp->info = pbr_ifp;
  58         return pbr_ifp;
  59 }
  60
  61 /* Inteface addition message from zebra. */
  62 static int interface_add(int command, struct zclient *zclient,
  63                                zebra_size_t length, vrf_id_t vrf_id)
  64 {
  65         struct interface *ifp;
  66
  67         ifp = zebra_interface_add_read(zclient->ibuf, vrf_id);
  68
  69         if (!ifp)
  70                 return 0;
  71
  72         DEBUGD(&pbr_dbg_zebra,
  73                "%s: %s", __PRETTY_FUNCTION__, ifp->name);
  74
  75         if (!ifp->info)
  76                 pbr_if_new(ifp);
  77
  78         pbr_nht_nexthop_interface_update(ifp);
  79
  80         return 0;
  81 }
  82
  83 static int interface_delete(int command, struct zclient *zclient,
  84                             zebra_size_t length, vrf_id_t vrf_id)
  85 {
  86         struct interface *ifp;
  87         struct stream *s;
  88
  89         s = zclient->ibuf;
  90         /* zebra_interface_state_read () updates interface structure in iflist
  91          */
  92         ifp = zebra_interface_state_read(s, vrf_id);
  93
  94         if (ifp == NULL)
  95                 return 0;
  96
  97         DEBUGD(&pbr_dbg_zebra,
  98                "%s: %s", __PRETTY_FUNCTION__, ifp->name);
  99
 100         if_set_index(ifp, IFINDEX_INTERNAL);
 101
 102         return 0;
 103 }
 104
 105 static int interface_address_add(int command, struct zclient *zclient,
 106                                  zebra_size_t length, vrf_id_t vrf_id)
 107 {
 108         struct connected *c;
 109         char buf[PREFIX_STRLEN];
 110
 111         c = zebra_interface_address_read(command, zclient->ibuf, vrf_id);
 112
 113         DEBUGD(&pbr_dbg_zebra,
 114                "%s: %s added %s", __PRETTY_FUNCTION__, c->ifp->name,
 115                prefix2str(c->address, buf, sizeof(buf)));
 116
 117         return 0;
 118 }
 119
 120 static int interface_address_delete(int command, struct zclient *zclient,
 121                                     zebra_size_t length, vrf_id_t vrf_id)
 122 {
 123         struct connected *c;
 124         char buf[PREFIX_STRLEN];
 125
 126         c = zebra_interface_address_read(command, zclient->ibuf, vrf_id);
 127
 128         if (!c)
 129                 return 0;
 130
 131         DEBUGD(&pbr_dbg_zebra,
 132                "%s: %s deleted %s", __PRETTY_FUNCTION__, c->ifp->name,
 133                prefix2str(c->address, buf, sizeof(buf)));
 134
 135         connected_free(c);
 136         return 0;
 137 }
 138
 139 static int interface_state_up(int command, struct zclient *zclient,
 140                               zebra_size_t length, vrf_id_t vrf_id)
 141 {
 142         struct interface *ifp;
 143
 144         ifp = zebra_interface_state_read(zclient->ibuf, vrf_id);
 145
 146         DEBUGD(&pbr_dbg_zebra,
 147                "%s: %s is up", __PRETTY_FUNCTION__, ifp->name);
 148
 149         pbr_nht_nexthop_interface_update(ifp);
 150
 151         return 0;
 152 }
 153
 154 static int interface_state_down(int command, struct zclient *zclient,
 155                                 zebra_size_t length, vrf_id_t vrf_id)
 156 {
 157         struct interface *ifp;
 158
 159         ifp = zebra_interface_state_read(zclient->ibuf, vrf_id);
 160
 161         DEBUGD(&pbr_dbg_zebra,
 162                "%s: %s is down", __PRETTY_FUNCTION__, ifp->name);
 163
 164         pbr_nht_nexthop_interface_update(ifp);
 165
 166         return 0;
 167 }
 168
 169 static int route_notify_owner(int command, struct zclient *zclient,
 170                               zebra_size_t length, vrf_id_t vrf_id)
 171 {
 172         struct prefix p;
 173         enum zapi_route_notify_owner note;
 174         uint32_t table_id;
 175         char buf[PREFIX_STRLEN];
 176
 177         if (!zapi_route_notify_decode(zclient->ibuf, &p, &table_id, &note))
 178                 return -1;
 179
 180         prefix2str(&p, buf, sizeof(buf));
 181
 182         switch (note) {
 183         case ZAPI_ROUTE_FAIL_INSTALL:
 184                 DEBUGD(&pbr_dbg_zebra,
 185                        "%s: [%s] Route install failure for table: %u",
 186                        __PRETTY_FUNCTION__, buf, table_id);
 187                 break;
 188         case ZAPI_ROUTE_BETTER_ADMIN_WON:
 189                 DEBUGD(&pbr_dbg_zebra,
 190                        "%s: [%s] Route better admin distance won for table: %u",
 191                        __PRETTY_FUNCTION__, buf, table_id);
 192                 break;
 193         case ZAPI_ROUTE_INSTALLED:
 194                 DEBUGD(&pbr_dbg_zebra,
 195                        "%s: [%s] Route installed succeeded for table: %u",
 196                        __PRETTY_FUNCTION__, buf, table_id);
 197                 pbr_nht_route_installed_for_table(table_id);
 198                 break;
 199         case ZAPI_ROUTE_REMOVED:
 200                 DEBUGD(&pbr_dbg_zebra,
 201                        "%s: [%s] Route Removed succeeded for table: %u",
 202                        __PRETTY_FUNCTION__, buf, table_id);
 203                 pbr_nht_route_removed_for_table(table_id);
 204                 break;
 205         case ZAPI_ROUTE_REMOVE_FAIL:
 206                 DEBUGD(&pbr_dbg_zebra,
 207                        "%s: [%s] Route remove fail for table: %u",
 208                        __PRETTY_FUNCTION__, buf, table_id);
 209                 break;
 210         }
 211
 212         return 0;
 213 }
 214
 215 static int rule_notify_owner(int command, struct zclient *zclient,
 216                              zebra_size_t length, vrf_id_t vrf_id)
 217 {
 218         uint32_t seqno, priority, unique;
 219         enum zapi_rule_notify_owner note;
 220         struct pbr_map_sequence *pbrms;
 221         struct pbr_map_interface *pmi;
 222         ifindex_t ifi;
 223         uint64_t installed;
 224
 225         if (!zapi_rule_notify_decode(zclient->ibuf, &seqno, &priority, &unique,
 226                                      &ifi, &note))
 227                 return -1;
 228
 229         pmi = NULL;
 230         pbrms = pbrms_lookup_unique(unique, ifi, &pmi);
 231         if (!pbrms) {
 232                 DEBUGD(&pbr_dbg_zebra,
 233                        "%s: Failure to lookup pbrms based upon %u",
 234                        __PRETTY_FUNCTION__, unique);
 235                 return 0;
 236         }
 237
 238         installed = 1 << pmi->install_bit;
 239
 240         switch (note) {
 241         case ZAPI_RULE_FAIL_INSTALL:
 242                 pbrms->installed &= ~installed;
 243                 DEBUGD(&pbr_dbg_zebra, "%s: Received RULE_FAIL_INSTALL: %lu",
 244                        __PRETTY_FUNCTION__, pbrms->installed);
 245                 break;
 246         case ZAPI_RULE_INSTALLED:
 247                 pbrms->installed |= installed;
 248                 DEBUGD(&pbr_dbg_zebra, "%s: Received RULE_INSTALLED: %lu",
 249                        __PRETTY_FUNCTION__, pbrms->installed);
 250                 break;
 251         case ZAPI_RULE_FAIL_REMOVE:
 252         case ZAPI_RULE_REMOVED:
 253                 pbrms->installed &= ~installed;
 254                 DEBUGD(&pbr_dbg_zebra, "%s: Received RULE REMOVED: %lu",
 255                        __PRETTY_FUNCTION__, pbrms->installed);
 256                 break;
 257         }
 258
 259         pbr_map_final_interface_deletion(pbrms->parent, pmi);
 260
 261         return 0;
 262 }
 263
 264 static void zebra_connected(struct zclient *zclient)
 265 {
 266         DEBUGD(&pbr_dbg_zebra, "%s: Registering for fun and profit",
 267                __PRETTY_FUNCTION__);
 268         zclient_send_reg_requests(zclient, VRF_DEFAULT);
 269 }
 270
 271 static void route_add_helper(struct zapi_route *api, struct nexthop_group nhg,
 272                              uint8_t install_afi)
 273 {
 274         struct zapi_nexthop *api_nh;
 275         char buf[PREFIX_STRLEN];
 276         struct nexthop *nhop;
 277         int i;
 278
 279         api->prefix.family = install_afi;
 280
 281         DEBUGD(&pbr_dbg_zebra, "\tEncoding %s",
 282                prefix2str(&api->prefix, buf, sizeof(buf)));
 283
 284         i = 0;
 285         for (ALL_NEXTHOPS(nhg, nhop)) {
 286                 api_nh = &api->nexthops[i];
 287                 api_nh->vrf_id = nhop->vrf_id;
 288                 api_nh->type = nhop->type;
 289                 switch (nhop->type) {
 290                 case NEXTHOP_TYPE_IPV4:
 291                         api_nh->gate.ipv4 = nhop->gate.ipv4;
 292                         break;
 293                 case NEXTHOP_TYPE_IPV4_IFINDEX:
 294                         api_nh->gate.ipv4 = nhop->gate.ipv4;
 295                         api_nh->ifindex = nhop->ifindex;
 296                         break;
 297                 case NEXTHOP_TYPE_IFINDEX:
 298                         api_nh->ifindex = nhop->ifindex;
 299                         break;
 300                 case NEXTHOP_TYPE_IPV6:
 301                         memcpy(&api_nh->gate.ipv6, &nhop->gate.ipv6, 16);
 302                         break;
 303                 case NEXTHOP_TYPE_IPV6_IFINDEX:
 304                         api_nh->ifindex = nhop->ifindex;
 305                         memcpy(&api_nh->gate.ipv6, &nhop->gate.ipv6, 16);
 306                         break;
 307                 case NEXTHOP_TYPE_BLACKHOLE:
 308                         api_nh->bh_type = nhop->bh_type;
 309                         break;
 310                 }
 311                 i++;
 312         }
 313         api->nexthop_num = i;
 314
 315         zclient_route_send(ZEBRA_ROUTE_ADD, zclient, api);
 316 }
 317
 318 /*
 319  * This function assumes a default route is being
 320  * installed into the appropriate tableid
 321  */
 322 void route_add(struct pbr_nexthop_group_cache *pnhgc, struct nexthop_group nhg,
 323                afi_t install_afi)
 324 {
 325         struct zapi_route api;
 326
 327         DEBUGD(&pbr_dbg_zebra, "%s for Table: %d", __PRETTY_FUNCTION__,
 328                pnhgc->table_id);
 329
 330         memset(&api, 0, sizeof(api));
 331
 332         api.vrf_id = VRF_DEFAULT;
 333         api.type = ZEBRA_ROUTE_PBR;
 334         api.safi = SAFI_UNICAST;
 335         /*
 336          * Sending a default route
 337          */
 338         api.tableid = pnhgc->table_id;
 339         SET_FLAG(api.flags, ZEBRA_FLAG_ALLOW_RECURSION);
 340         SET_FLAG(api.message, ZAPI_MESSAGE_TABLEID);
 341         SET_FLAG(api.message, ZAPI_MESSAGE_NEXTHOP);
 342         switch (install_afi) {
 343         case AFI_MAX:
 344                 route_add_helper(&api, nhg, AF_INET);
 345                 route_add_helper(&api, nhg, AF_INET6);
 346                 break;
 347         case AFI_IP:
 348                 route_add_helper(&api, nhg, AF_INET);
 349                 break;
 350         case AFI_IP6:
 351                 route_add_helper(&api, nhg, AF_INET6);
 352                 break;
 353         case AFI_L2VPN:
 354                 DEBUGD(&pbr_dbg_zebra,
 355                        "%s: Asked to install unsupported route type: L2VPN",
 356                        __PRETTY_FUNCTION__);
 357                 break;
 358         }
 359 }
 360
 361 /*
 362  * This function assumes a default route is being
 363  * removed from the appropriate tableid
 364  */
 365 void route_delete(struct pbr_nexthop_group_cache *pnhgc, afi_t afi)
 366 {
 367         struct zapi_route api;
 368
 369         DEBUGD(&pbr_dbg_zebra, "%s for Table: %d", __PRETTY_FUNCTION__,
 370                pnhgc->table_id);
 371
 372         memset(&api, 0, sizeof(api));
 373         api.vrf_id = VRF_DEFAULT;
 374         api.type = ZEBRA_ROUTE_PBR;
 375         api.safi = SAFI_UNICAST;
 376
 377         api.tableid = pnhgc->table_id;
 378         SET_FLAG(api.message, ZAPI_MESSAGE_TABLEID);
 379
 380         switch (afi) {
 381         case AFI_IP:
 382                 api.prefix.family = AF_INET;
 383                 zclient_route_send(ZEBRA_ROUTE_DELETE, zclient, &api);
 384                 break;
 385         case AFI_IP6:
 386                 api.prefix.family = AF_INET6;
 387                 zclient_route_send(ZEBRA_ROUTE_DELETE, zclient, &api);
 388                 break;
 389         case AFI_MAX:
 390                 api.prefix.family = AF_INET;
 391                 zclient_route_send(ZEBRA_ROUTE_DELETE, zclient, &api);
 392                 api.prefix.family = AF_INET6;
 393                 zclient_route_send(ZEBRA_ROUTE_DELETE, zclient, &api);
 394                 break;
 395         case AFI_L2VPN:
 396                 DEBUGD(&pbr_dbg_zebra,
 397                        "%s: Asked to delete unsupported route type: L2VPN",
 398                        __PRETTY_FUNCTION__);
 399                 break;
 400         }
 401 }
 402
 403 static int pbr_zebra_nexthop_update(int command, struct zclient *zclient,
 404                                     zebra_size_t length, vrf_id_t vrf_id)
 405 {
 406         struct zapi_route nhr;
 407         char buf[PREFIX2STR_BUFFER];
 408         uint32_t i;
 409
 410         if (!zapi_nexthop_update_decode(zclient->ibuf, &nhr)) {
 411                 zlog_warn("Failure to decode Nexthop update message");
 412                 return 0;
 413         }
 414
 415         if (DEBUG_MODE_CHECK(&pbr_dbg_zebra, DEBUG_MODE_ALL)) {
 416
 417                 DEBUGD(&pbr_dbg_zebra, "%s: Received Nexthop update: %s",
 418                        __PRETTY_FUNCTION__,
 419                        prefix2str(&nhr.prefix, buf, sizeof(buf)));
 420
 421                 DEBUGD(&pbr_dbg_zebra, "%s: (\tNexthops(%u)",
 422                        __PRETTY_FUNCTION__, nhr.nexthop_num);
 423
 424                 for (i = 0; i < nhr.nexthop_num; i++) {
 425                         DEBUGD(&pbr_dbg_zebra,
 426                                "%s: \tType: %d: vrf: %d, ifindex: %d gate: %s",
 427                                __PRETTY_FUNCTION__, nhr.nexthops[i].type,
 428                                nhr.nexthops[i].vrf_id, nhr.nexthops[i].ifindex,
 429                                inet_ntoa(nhr.nexthops[i].gate.ipv4));
 430                 }
 431         }
 432
 433         pbr_nht_nexthop_update(&nhr);
 434         return 1;
 435 }
 436
 437 extern struct zebra_privs_t pbr_privs;
 438
 439 void pbr_zebra_init(void)
 440 {
 441         struct zclient_options opt = { .receive_notify = true };
 442
 443         zclient = zclient_new(master, &opt);
 444
 445         zclient_init(zclient, ZEBRA_ROUTE_PBR, 0, &pbr_privs);
 446         zclient->zebra_connected = zebra_connected;
 447         zclient->interface_add = interface_add;
 448         zclient->interface_delete = interface_delete;
 449         zclient->interface_up = interface_state_up;
 450         zclient->interface_down = interface_state_down;
 451         zclient->interface_address_add = interface_address_add;
 452         zclient->interface_address_delete = interface_address_delete;
 453         zclient->route_notify_owner = route_notify_owner;
 454         zclient->rule_notify_owner = rule_notify_owner;
 455         zclient->nexthop_update = pbr_zebra_nexthop_update;
 456 }
 457
 458 void pbr_send_rnh(struct nexthop *nhop, bool reg)
 459 {
 460         uint32_t command;
 461         struct prefix p;
 462
 463         command = (reg) ?
 464                 ZEBRA_NEXTHOP_REGISTER : ZEBRA_NEXTHOP_UNREGISTER;
 465
 466         memset(&p, 0, sizeof(p));
 467         switch (nhop->type) {
 468         case NEXTHOP_TYPE_IFINDEX:
 469         case NEXTHOP_TYPE_BLACKHOLE:
 470                 return;
 471         case NEXTHOP_TYPE_IPV4:
 472         case NEXTHOP_TYPE_IPV4_IFINDEX:
 473                 p.family = AF_INET;
 474                 p.u.prefix4.s_addr = nhop->gate.ipv4.s_addr;
 475                 p.prefixlen = 32;
 476                 break;
 477         case NEXTHOP_TYPE_IPV6:
 478         case NEXTHOP_TYPE_IPV6_IFINDEX:
 479                 p.family = AF_INET6;
 480                 memcpy(&p.u.prefix6, &nhop->gate.ipv6, 16);
 481                 p.prefixlen = 128;
 482                 break;
 483         }
 484
 485         if (zclient_send_rnh(zclient, command, &p,
 486                              false, nhop->vrf_id) < 0) {
 487                 zlog_warn("%s: Failure to send nexthop to zebra",
 488                           __PRETTY_FUNCTION__);
 489         }
 490 }
 491
 492 static void pbr_encode_pbr_map_sequence_prefix(struct stream *s,
 493                                                struct prefix *p,
 494                                                unsigned char  family)
 495 {
 496         struct prefix any;
 497
 498         if (!p) {
 499                 memset(&any, 0, sizeof(any));
 500                 any.family = family;
 501                 p = &any;
 502         }
 503
 504         stream_putc(s, p->family);
 505         stream_putc(s, p->prefixlen);
 506         stream_put(s, &p->u.prefix, prefix_blen(p));
 507 }
 508
 509 static void pbr_encode_pbr_map_sequence(struct stream *s,
 510                                         struct pbr_map_sequence *pbrms,
 511                                         struct interface *ifp)
 512 {
 513         unsigned char family;
 514
 515         family = AF_INET;
 516         if (pbrms->family)
 517                 family = pbrms->family;
 518
 519         stream_putl(s, pbrms->seqno);
 520         stream_putl(s, pbrms->ruleno);
 521         stream_putl(s, pbrms->unique);
 522         pbr_encode_pbr_map_sequence_prefix(s, pbrms->src, family);
 523         stream_putw(s, 0);  /* src port */
 524         pbr_encode_pbr_map_sequence_prefix(s, pbrms->dst, family);
 525         stream_putw(s, 0);  /* dst port */
 526         stream_putl(s, 0);  /* fwmark */
 527         if (pbrms->nhgrp_name)
 528                 stream_putl(s, pbr_nht_get_table(pbrms->nhgrp_name));
 529         else if (pbrms->nhg)
 530                 stream_putl(s, pbr_nht_get_table(pbrms->internal_nhg_name));
 531         stream_putl(s, ifp->ifindex);
 532 }
 533
 534 void pbr_send_pbr_map(struct pbr_map_sequence *pbrms,
 535                       struct pbr_map_interface *pmi, bool install)
 536 {
 537         struct pbr_map *pbrm = pbrms->parent;
 538         struct stream *s;
 539         uint64_t is_installed = (uint64_t)1 << pmi->install_bit;
 540
 541         is_installed &= pbrms->installed;
 542
 543         DEBUGD(&pbr_dbg_zebra, "%s: for %s %d(%" PRIu64 ")",
 544                __PRETTY_FUNCTION__, pbrm->name, install, is_installed);
 545
 546         /*
 547          * If we are installed and asked to do so again
 548          * just return.  If we are not installed and asked
 549          * and asked to delete just return;
 550          */
 551         if (install && is_installed)
 552                 return;
 553
 554         if (!install && !is_installed)
 555                 return;
 556
 557         s = zclient->obuf;
 558         stream_reset(s);
 559
 560         zclient_create_header(s,
 561                               install ? ZEBRA_RULE_ADD : ZEBRA_RULE_DELETE,
 562                               VRF_DEFAULT);
 563
 564         /*
 565          * We are sending one item at a time at the moment
 566          */
 567         stream_putl(s, 1);
 568
 569         DEBUGD(&pbr_dbg_zebra, "%s: \t%s %s %d %s %u",
 570                __PRETTY_FUNCTION__, install ? "Installing" : "Deleting",
 571                pbrm->name, install, pmi->ifp->name, pmi->delete);
 572
 573         pbr_encode_pbr_map_sequence(s, pbrms, pmi->ifp);
 574
 575         stream_putw_at(s, 0, stream_get_endp(s));
 576
 577         zclient_send_message(zclient);
 578 }