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