bgpd/bgp_updgrp_adv.c

   1 /**
   2  * bgp_updgrp_adv.c: BGP update group advertisement and adjacency
   3  *                   maintenance
   4  *
   5  *
   6  * @copyright Copyright (C) 2014 Cumulus Networks, Inc.
   7  *
   8  * @author Avneesh Sachdev <avneesh@sproute.net>
   9  * @author Rajesh Varadarajan <rajesh@sproute.net>
  10  * @author Pradosh Mohapatra <pradosh@sproute.net>
  11  *
  12  * This file is part of GNU Zebra.
  13  *
  14  * GNU Zebra is free software; you can redistribute it and/or modify it
  15  * under the terms of the GNU General Public License as published by the
  16  * Free Software Foundation; either version 2, or (at your option) any
  17  * later version.
  18  *
  19  * GNU Zebra is distributed in the hope that it will be useful, but
  20  * WITHOUT ANY WARRANTY; without even the implied warranty of
  21  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  22  * General Public License for more details.
  23  *
  24  * You should have received a copy of the GNU General Public License along
  25  * with this program; see the file COPYING; if not, write to the Free Software
  26  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  27  */
  28
  29 #include <zebra.h>
  30
  31 #include "command.h"
  32 #include "memory.h"
  33 #include "prefix.h"
  34 #include "hash.h"
  35 #include "thread.h"
  36 #include "queue.h"
  37 #include "routemap.h"
  38 #include "filter.h"
  39
  40 #include "bgpd/bgpd.h"
  41 #include "bgpd/bgp_table.h"
  42 #include "bgpd/bgp_debug.h"
  43 #include "bgpd/bgp_route.h"
  44 #include "bgpd/bgp_advertise.h"
  45 #include "bgpd/bgp_attr.h"
  46 #include "bgpd/bgp_aspath.h"
  47 #include "bgpd/bgp_packet.h"
  48 #include "bgpd/bgp_fsm.h"
  49 #include "bgpd/bgp_mplsvpn.h"
  50 #include "bgpd/bgp_updgrp.h"
  51 #include "bgpd/bgp_advertise.h"
  52 #include "bgpd/bgp_addpath.h"
  53
  54
  55 /********************
  56  * PRIVATE FUNCTIONS
  57  ********************/
  58 static int bgp_adj_out_compare(const struct bgp_adj_out *o1,
  59                                const struct bgp_adj_out *o2)
  60 {
  61         if (o1->subgroup < o2->subgroup)
  62                 return -1;
  63
  64         if (o1->subgroup > o2->subgroup)
  65                 return 1;
  66
  67         if (o1->addpath_tx_id < o2->addpath_tx_id)
  68                 return -1;
  69
  70         if (o1->addpath_tx_id > o2->addpath_tx_id)
  71                 return 1;
  72
  73         return 0;
  74 }
  75 RB_GENERATE(bgp_adj_out_rb, bgp_adj_out, adj_entry, bgp_adj_out_compare);
  76
  77 static inline struct bgp_adj_out *adj_lookup(struct bgp_dest *dest,
  78                                              struct update_subgroup *subgrp,
  79                                              uint32_t addpath_tx_id)
  80 {
  81         struct bgp_adj_out lookup;
  82
  83         if (!dest || !subgrp)
  84                 return NULL;
  85
  86         /* update-groups that do not support addpath will pass 0 for
  87          * addpath_tx_id. */
  88         lookup.subgroup = subgrp;
  89         lookup.addpath_tx_id = addpath_tx_id;
  90
  91         return RB_FIND(bgp_adj_out_rb, &dest->adj_out, &lookup);
  92 }
  93
  94 static void adj_free(struct bgp_adj_out *adj)
  95 {
  96         TAILQ_REMOVE(&(adj->subgroup->adjq), adj, subgrp_adj_train);
  97         SUBGRP_DECR_STAT(adj->subgroup, adj_count);
  98
  99         RB_REMOVE(bgp_adj_out_rb, &adj->dest->adj_out, adj);
 100         bgp_dest_unlock_node(adj->dest);
 101
 102         XFREE(MTYPE_BGP_ADJ_OUT, adj);
 103 }
 104
 105 static void subgrp_withdraw_stale_addpath(struct updwalk_context *ctx,
 106                                           struct update_subgroup *subgrp)
 107 {
 108         struct bgp_adj_out *adj, *adj_next;
 109         uint32_t id;
 110         struct bgp_path_info *pi;
 111         afi_t afi = SUBGRP_AFI(subgrp);
 112         safi_t safi = SUBGRP_SAFI(subgrp);
 113         struct peer *peer = SUBGRP_PEER(subgrp);
 114
 115         /* Look through all of the paths we have advertised for this rn and send
 116          * a withdraw for the ones that are no longer present */
 117         RB_FOREACH_SAFE (adj, bgp_adj_out_rb, &ctx->dest->adj_out, adj_next) {
 118
 119                 if (adj->subgroup == subgrp) {
 120                         for (pi = bgp_dest_get_bgp_path_info(ctx->dest); pi;
 121                              pi = pi->next) {
 122                                 id = bgp_addpath_id_for_peer(peer, afi, safi,
 123                                         &pi->tx_addpath);
 124
 125                                 if (id == adj->addpath_tx_id) {
 126                                         break;
 127                                 }
 128                         }
 129
 130                         if (!pi) {
 131                                 subgroup_process_announce_selected(
 132                                         subgrp, NULL, ctx->dest,
 133                                         adj->addpath_tx_id);
 134                         }
 135                 }
 136         }
 137 }
 138
 139 static int group_announce_route_walkcb(struct update_group *updgrp, void *arg)
 140 {
 141         struct updwalk_context *ctx = arg;
 142         struct update_subgroup *subgrp;
 143         struct bgp_path_info *pi;
 144         afi_t afi;
 145         safi_t safi;
 146         struct peer *peer;
 147         struct bgp_adj_out *adj, *adj_next;
 148         int addpath_capable;
 149
 150         afi = UPDGRP_AFI(updgrp);
 151         safi = UPDGRP_SAFI(updgrp);
 152         peer = UPDGRP_PEER(updgrp);
 153         addpath_capable = bgp_addpath_encode_tx(peer, afi, safi);
 154
 155         if (BGP_DEBUG(update, UPDATE_OUT))
 156                 zlog_debug("%s: afi=%s, safi=%s, p=%pRN", __func__,
 157                            afi2str(afi), safi2str(safi),
 158                            bgp_dest_to_rnode(ctx->dest));
 159
 160         UPDGRP_FOREACH_SUBGRP (updgrp, subgrp) {
 161
 162                 /*
 163                  * Skip the subgroups that have coalesce timer running. We will
 164                  * walk the entire prefix table for those subgroups when the
 165                  * coalesce timer fires.
 166                  */
 167                 if (!subgrp->t_coalesce) {
 168                         /* An update-group that uses addpath */
 169                         if (addpath_capable) {
 170                                 subgrp_withdraw_stale_addpath(ctx, subgrp);
 171
 172                                 for (pi = bgp_dest_get_bgp_path_info(ctx->dest);
 173                                      pi; pi = pi->next) {
 174                                         /* Skip the bestpath for now */
 175                                         if (pi == ctx->pi)
 176                                                 continue;
 177
 178                                         subgroup_process_announce_selected(
 179                                                 subgrp, pi, ctx->dest,
 180                                                 bgp_addpath_id_for_peer(
 181                                                         peer, afi, safi,
 182                                                         &pi->tx_addpath));
 183                                 }
 184
 185                                 /* Process the bestpath last so the "show [ip]
 186                                  * bgp neighbor x.x.x.x advertised"
 187                                  * output shows the attributes from the bestpath
 188                                  */
 189                                 if (ctx->pi)
 190                                         subgroup_process_announce_selected(
 191                                                 subgrp, ctx->pi, ctx->dest,
 192                                                 bgp_addpath_id_for_peer(
 193                                                         peer, afi, safi,
 194                                                         &ctx->pi->tx_addpath));
 195                         }
 196
 197                         /* An update-group that does not use addpath */
 198                         else {
 199                                 if (ctx->pi) {
 200                                         subgroup_process_announce_selected(
 201                                                 subgrp, ctx->pi, ctx->dest,
 202                                                 bgp_addpath_id_for_peer(
 203                                                         peer, afi, safi,
 204                                                         &ctx->pi->tx_addpath));
 205                                 } else {
 206                                         /* Find the addpath_tx_id of the path we
 207                                          * had advertised and
 208                                          * send a withdraw */
 209                                         RB_FOREACH_SAFE (adj, bgp_adj_out_rb,
 210                                                          &ctx->dest->adj_out,
 211                                                          adj_next) {
 212                                                 if (adj->subgroup == subgrp) {
 213                                                         subgroup_process_announce_selected(
 214                                                                 subgrp, NULL,
 215                                                                 ctx->dest,
 216                                                                 adj->addpath_tx_id);
 217                                                 }
 218                                         }
 219                                 }
 220                         }
 221                 }
 222
 223                 /* Notify BGP Conditional advertisement */
 224                 bgp_notify_conditional_adv_scanner(subgrp);
 225         }
 226
 227         return UPDWALK_CONTINUE;
 228 }
 229
 230 static void subgrp_show_adjq_vty(struct update_subgroup *subgrp,
 231                                  struct vty *vty, uint8_t flags)
 232 {
 233         struct bgp_table *table;
 234         struct bgp_adj_out *adj;
 235         unsigned long output_count;
 236         struct bgp_dest *dest;
 237         int header1 = 1;
 238         struct bgp *bgp;
 239         int header2 = 1;
 240
 241         bgp = SUBGRP_INST(subgrp);
 242         if (!bgp)
 243                 return;
 244
 245         table = bgp->rib[SUBGRP_AFI(subgrp)][SUBGRP_SAFI(subgrp)];
 246
 247         output_count = 0;
 248
 249         for (dest = bgp_table_top(table); dest; dest = bgp_route_next(dest)) {
 250                 const struct prefix *dest_p = bgp_dest_get_prefix(dest);
 251
 252                 RB_FOREACH (adj, bgp_adj_out_rb, &dest->adj_out)
 253                         if (adj->subgroup == subgrp) {
 254                                 if (header1) {
 255                                         vty_out(vty,
 256                                                 "BGP table version is %" PRIu64
 257                                                 ", local router ID is %pI4\n",
 258                                                 table->version,
 259                                                 &bgp->router_id);
 260                                         vty_out(vty, BGP_SHOW_SCODE_HEADER);
 261                                         vty_out(vty, BGP_SHOW_OCODE_HEADER);
 262                                         header1 = 0;
 263                                 }
 264                                 if (header2) {
 265                                         vty_out(vty, BGP_SHOW_HEADER);
 266                                         header2 = 0;
 267                                 }
 268                                 if ((flags & UPDWALK_FLAGS_ADVQUEUE) && adj->adv
 269                                     && adj->adv->baa) {
 270                                         route_vty_out_tmp(vty, dest_p,
 271                                                           adj->adv->baa->attr,
 272                                                           SUBGRP_SAFI(subgrp),
 273                                                           0, NULL, false);
 274                                         output_count++;
 275                                 }
 276                                 if ((flags & UPDWALK_FLAGS_ADVERTISED)
 277                                     && adj->attr) {
 278                                         route_vty_out_tmp(vty, dest_p,
 279                                                           adj->attr,
 280                                                           SUBGRP_SAFI(subgrp),
 281                                                           0, NULL, false);
 282                                         output_count++;
 283                                 }
 284                         }
 285         }
 286         if (output_count != 0)
 287                 vty_out(vty, "\nTotal number of prefixes %ld\n", output_count);
 288 }
 289
 290 static int updgrp_show_adj_walkcb(struct update_group *updgrp, void *arg)
 291 {
 292         struct updwalk_context *ctx = arg;
 293         struct update_subgroup *subgrp;
 294         struct vty *vty;
 295
 296         vty = ctx->vty;
 297         UPDGRP_FOREACH_SUBGRP (updgrp, subgrp) {
 298                 if (ctx->subgrp_id && (ctx->subgrp_id != subgrp->id))
 299                         continue;
 300                 vty_out(vty, "update group %" PRIu64 ", subgroup %" PRIu64 "\n",
 301                         updgrp->id, subgrp->id);
 302                 subgrp_show_adjq_vty(subgrp, vty, ctx->flags);
 303         }
 304         return UPDWALK_CONTINUE;
 305 }
 306
 307 static void updgrp_show_adj(struct bgp *bgp, afi_t afi, safi_t safi,
 308                             struct vty *vty, uint64_t id, uint8_t flags)
 309 {
 310         struct updwalk_context ctx;
 311         memset(&ctx, 0, sizeof(ctx));
 312         ctx.vty = vty;
 313         ctx.subgrp_id = id;
 314         ctx.flags = flags;
 315
 316         update_group_af_walk(bgp, afi, safi, updgrp_show_adj_walkcb, &ctx);
 317 }
 318
 319 static int subgroup_coalesce_timer(struct thread *thread)
 320 {
 321         struct update_subgroup *subgrp;
 322         struct bgp *bgp;
 323
 324         subgrp = THREAD_ARG(thread);
 325         if (bgp_debug_update(NULL, NULL, subgrp->update_group, 0))
 326                 zlog_debug("u%" PRIu64 ":s%" PRIu64" announcing routes upon coalesce timer expiry(%u ms)",
 327                            (SUBGRP_UPDGRP(subgrp))->id, subgrp->id,
 328                            subgrp->v_coalesce);
 329         subgrp->t_coalesce = NULL;
 330         subgrp->v_coalesce = 0;
 331         bgp = SUBGRP_INST(subgrp);
 332         subgroup_announce_route(subgrp);
 333
 334
 335         /* While the announce_route() may kick off the route advertisement timer
 336          * for
 337          * the members of the subgroup, we'd like to send the initial updates
 338          * much
 339          * faster (i.e., without enforcing MRAI). Also, if there were no routes
 340          * to
 341          * announce, this is the method currently employed to trigger the EOR.
 342          */
 343         if (!bgp_update_delay_active(SUBGRP_INST(subgrp)) &&
 344             !(BGP_SUPPRESS_FIB_ENABLED(bgp))) {
 345                 struct peer_af *paf;
 346                 struct peer *peer;
 347
 348                 SUBGRP_FOREACH_PEER (subgrp, paf) {
 349                         peer = PAF_PEER(paf);
 350                         BGP_TIMER_OFF(peer->t_routeadv);
 351                         BGP_TIMER_ON(peer->t_routeadv, bgp_routeadv_timer, 0);
 352                 }
 353         }
 354
 355         return 0;
 356 }
 357
 358 static int update_group_announce_walkcb(struct update_group *updgrp, void *arg)
 359 {
 360         struct update_subgroup *subgrp;
 361
 362         UPDGRP_FOREACH_SUBGRP (updgrp, subgrp) {
 363                 subgroup_announce_all(subgrp);
 364         }
 365
 366         return UPDWALK_CONTINUE;
 367 }
 368
 369 static int update_group_announce_rrc_walkcb(struct update_group *updgrp,
 370                                             void *arg)
 371 {
 372         struct update_subgroup *subgrp;
 373         afi_t afi;
 374         safi_t safi;
 375         struct peer *peer;
 376
 377         afi = UPDGRP_AFI(updgrp);
 378         safi = UPDGRP_SAFI(updgrp);
 379         peer = UPDGRP_PEER(updgrp);
 380
 381         /* Only announce if this is a group of route-reflector-clients */
 382         if (CHECK_FLAG(peer->af_flags[afi][safi], PEER_FLAG_REFLECTOR_CLIENT)) {
 383                 UPDGRP_FOREACH_SUBGRP (updgrp, subgrp) {
 384                         subgroup_announce_all(subgrp);
 385                 }
 386         }
 387
 388         return UPDWALK_CONTINUE;
 389 }
 390
 391 /********************
 392  * PUBLIC FUNCTIONS
 393  ********************/
 394
 395 /**
 396  * Allocate an adj-out object. Do proper initialization of its fields,
 397  * primarily its association with the subgroup and the prefix.
 398  */
 399 struct bgp_adj_out *bgp_adj_out_alloc(struct update_subgroup *subgrp,
 400                                       struct bgp_dest *dest,
 401                                       uint32_t addpath_tx_id)
 402 {
 403         struct bgp_adj_out *adj;
 404
 405         adj = XCALLOC(MTYPE_BGP_ADJ_OUT, sizeof(struct bgp_adj_out));
 406         adj->subgroup = subgrp;
 407         adj->addpath_tx_id = addpath_tx_id;
 408
 409         RB_INSERT(bgp_adj_out_rb, &dest->adj_out, adj);
 410         bgp_dest_lock_node(dest);
 411         adj->dest = dest;
 412
 413         TAILQ_INSERT_TAIL(&(subgrp->adjq), adj, subgrp_adj_train);
 414         SUBGRP_INCR_STAT(subgrp, adj_count);
 415         return adj;
 416 }
 417
 418
 419 struct bgp_advertise *
 420 bgp_advertise_clean_subgroup(struct update_subgroup *subgrp,
 421                              struct bgp_adj_out *adj)
 422 {
 423         struct bgp_advertise *adv;
 424         struct bgp_advertise_attr *baa;
 425         struct bgp_advertise *next;
 426         struct bgp_adv_fifo_head *fhead;
 427
 428         adv = adj->adv;
 429         baa = adv->baa;
 430         next = NULL;
 431
 432         if (baa) {
 433                 fhead = &subgrp->sync->update;
 434
 435                 /* Unlink myself from advertise attribute FIFO.  */
 436                 bgp_advertise_delete(baa, adv);
 437
 438                 /* Fetch next advertise candidate. */
 439                 next = baa->adv;
 440
 441                 /* Unintern BGP advertise attribute.  */
 442                 bgp_advertise_unintern(subgrp->hash, baa);
 443         } else
 444                 fhead = &subgrp->sync->withdraw;
 445
 446
 447         /* Unlink myself from advertisement FIFO.  */
 448         bgp_adv_fifo_del(fhead, adv);
 449
 450         /* Free memory.  */
 451         bgp_advertise_free(adj->adv);
 452         adj->adv = NULL;
 453
 454         return next;
 455 }
 456
 457 void bgp_adj_out_set_subgroup(struct bgp_dest *dest,
 458                               struct update_subgroup *subgrp, struct attr *attr,
 459                               struct bgp_path_info *path)
 460 {
 461         struct bgp_adj_out *adj = NULL;
 462         struct bgp_advertise *adv;
 463         struct peer *peer;
 464         afi_t afi;
 465         safi_t safi;
 466         struct peer *adv_peer;
 467         struct peer_af *paf;
 468         struct bgp *bgp;
 469         uint32_t attr_hash = attrhash_key_make(attr);
 470
 471         peer = SUBGRP_PEER(subgrp);
 472         afi = SUBGRP_AFI(subgrp);
 473         safi = SUBGRP_SAFI(subgrp);
 474         bgp = SUBGRP_INST(subgrp);
 475
 476         if (DISABLE_BGP_ANNOUNCE)
 477                 return;
 478
 479         /* Look for adjacency information. */
 480         adj = adj_lookup(
 481                 dest, subgrp,
 482                 bgp_addpath_id_for_peer(peer, afi, safi, &path->tx_addpath));
 483
 484         if (!adj) {
 485                 adj = bgp_adj_out_alloc(
 486                         subgrp, dest,
 487                         bgp_addpath_id_for_peer(peer, afi, safi,
 488                                                 &path->tx_addpath));
 489                 if (!adj)
 490                         return;
 491         }
 492
 493         /* Check if we are sending the same route. This is needed to
 494          * avoid duplicate UPDATES. For instance, filtering communities
 495          * at egress, neighbors will see duplicate UPDATES despite
 496          * the route wasn't changed actually.
 497          * Do not suppress BGP UPDATES for route-refresh.
 498          */
 499         if (CHECK_FLAG(bgp->flags, BGP_FLAG_SUPPRESS_DUPLICATES)
 500             && !CHECK_FLAG(subgrp->sflags, SUBGRP_STATUS_FORCE_UPDATES)
 501             && adj->attr_hash == attr_hash) {
 502                 if (BGP_DEBUG(update, UPDATE_OUT)) {
 503                         char attr_str[BUFSIZ] = {0};
 504
 505                         bgp_dump_attr(attr, attr_str, sizeof(attr_str));
 506
 507                         zlog_debug("%s suppress UPDATE w/ attr: %s", peer->host,
 508                                    attr_str);
 509                 }
 510                 return;
 511         }
 512
 513         if (adj->adv)
 514                 bgp_advertise_clean_subgroup(subgrp, adj);
 515         adj->adv = bgp_advertise_new();
 516
 517         adv = adj->adv;
 518         adv->dest = dest;
 519         assert(adv->pathi == NULL);
 520         /* bgp_path_info adj_out reference */
 521         adv->pathi = bgp_path_info_lock(path);
 522
 523         adv->baa = bgp_advertise_intern(subgrp->hash, attr);
 524         adv->adj = adj;
 525         adj->attr_hash = attr_hash;
 526
 527         /* Add new advertisement to advertisement attribute list. */
 528         bgp_advertise_add(adv->baa, adv);
 529
 530         /*
 531          * If the update adv list is empty, trigger the member peers'
 532          * mrai timers so the socket writes can happen.
 533          */
 534         if (!bgp_adv_fifo_count(&subgrp->sync->update)) {
 535                 SUBGRP_FOREACH_PEER (subgrp, paf) {
 536                         /* If there are no routes in the withdraw list, set
 537                          * the flag PEER_STATUS_ADV_DELAY which will allow
 538                          * more routes to be sent in the update message
 539                          */
 540                         if (BGP_SUPPRESS_FIB_ENABLED(bgp)) {
 541                                 adv_peer = PAF_PEER(paf);
 542                                 if (!bgp_adv_fifo_count(
 543                                                 &subgrp->sync->withdraw))
 544                                         SET_FLAG(adv_peer->thread_flags,
 545                                                  PEER_THREAD_SUBGRP_ADV_DELAY);
 546                                 else
 547                                         UNSET_FLAG(adv_peer->thread_flags,
 548                                                 PEER_THREAD_SUBGRP_ADV_DELAY);
 549                         }
 550                         bgp_adjust_routeadv(PAF_PEER(paf));
 551                 }
 552         }
 553
 554         bgp_adv_fifo_add_tail(&subgrp->sync->update, adv);
 555
 556         subgrp->version = max(subgrp->version, dest->version);
 557 }
 558
 559 /* The only time 'withdraw' will be false is if we are sending
 560  * the "neighbor x.x.x.x default-originate" default and need to clear
 561  * bgp_adj_out for the 0.0.0.0/0 route in the BGP table.
 562  */
 563 void bgp_adj_out_unset_subgroup(struct bgp_dest *dest,
 564                                 struct update_subgroup *subgrp, char withdraw,
 565                                 uint32_t addpath_tx_id)
 566 {
 567         struct bgp_adj_out *adj;
 568         struct bgp_advertise *adv;
 569         bool trigger_write;
 570
 571         if (DISABLE_BGP_ANNOUNCE)
 572                 return;
 573
 574         /* Lookup existing adjacency */
 575         if ((adj = adj_lookup(dest, subgrp, addpath_tx_id)) != NULL) {
 576                 /* Clean up previous advertisement.  */
 577                 if (adj->adv)
 578                         bgp_advertise_clean_subgroup(subgrp, adj);
 579
 580                 /* If default originate is enabled and the route is default
 581                  * route, do not send withdraw. This will prevent deletion of
 582                  * the default route at the peer.
 583                  */
 584                 if (CHECK_FLAG(subgrp->sflags, SUBGRP_STATUS_DEFAULT_ORIGINATE)
 585                     && is_default_prefix(bgp_dest_get_prefix(dest)))
 586                         return;
 587
 588                 if (adj->attr && withdraw) {
 589                         /* We need advertisement structure.  */
 590                         adj->adv = bgp_advertise_new();
 591                         adv = adj->adv;
 592                         adv->dest = dest;
 593                         adv->adj = adj;
 594
 595                         /* Note if we need to trigger a packet write */
 596                         trigger_write =
 597                                 !bgp_adv_fifo_count(&subgrp->sync->withdraw);
 598
 599                         /* Add to synchronization entry for withdraw
 600                          * announcement.  */
 601                         bgp_adv_fifo_add_tail(&subgrp->sync->withdraw, adv);
 602
 603                         if (trigger_write)
 604                                 subgroup_trigger_write(subgrp);
 605                 } else {
 606                         /* Free allocated information.  */
 607                         adj_free(adj);
 608                 }
 609         }
 610
 611         subgrp->version = max(subgrp->version, dest->version);
 612 }
 613
 614 void bgp_adj_out_remove_subgroup(struct bgp_dest *dest, struct bgp_adj_out *adj,
 615                                  struct update_subgroup *subgrp)
 616 {
 617         if (adj->attr)
 618                 bgp_attr_unintern(&adj->attr);
 619
 620         if (adj->adv)
 621                 bgp_advertise_clean_subgroup(subgrp, adj);
 622
 623         adj_free(adj);
 624 }
 625
 626 /*
 627  * Go through all the routes and clean up the adj/adv structures corresponding
 628  * to the subgroup.
 629  */
 630 void subgroup_clear_table(struct update_subgroup *subgrp)
 631 {
 632         struct bgp_adj_out *aout, *taout;
 633
 634         SUBGRP_FOREACH_ADJ_SAFE (subgrp, aout, taout)
 635                 bgp_adj_out_remove_subgroup(aout->dest, aout, subgrp);
 636 }
 637
 638 /*
 639  * subgroup_announce_table
 640  */
 641 void subgroup_announce_table(struct update_subgroup *subgrp,
 642                              struct bgp_table *table)
 643 {
 644         struct bgp_dest *dest;
 645         struct bgp_path_info *ri;
 646         struct attr attr;
 647         struct peer *peer;
 648         afi_t afi;
 649         safi_t safi;
 650         int addpath_capable;
 651         struct bgp *bgp;
 652         bool advertise;
 653
 654         peer = SUBGRP_PEER(subgrp);
 655         afi = SUBGRP_AFI(subgrp);
 656         safi = SUBGRP_SAFI(subgrp);
 657         bgp = SUBGRP_INST(subgrp);
 658         addpath_capable = bgp_addpath_encode_tx(peer, afi, safi);
 659
 660         if (safi == SAFI_LABELED_UNICAST)
 661                 safi = SAFI_UNICAST;
 662
 663         if (!table)
 664                 table = peer->bgp->rib[afi][safi];
 665
 666         if (safi != SAFI_MPLS_VPN && safi != SAFI_ENCAP && safi != SAFI_EVPN
 667             && CHECK_FLAG(peer->af_flags[afi][safi],
 668                           PEER_FLAG_DEFAULT_ORIGINATE))
 669                 subgroup_default_originate(subgrp, 0);
 670
 671         for (dest = bgp_table_top(table); dest; dest = bgp_route_next(dest)) {
 672                 const struct prefix *dest_p = bgp_dest_get_prefix(dest);
 673
 674                 /* Check if the route can be advertised */
 675                 advertise = bgp_check_advertise(bgp, dest);
 676
 677                 for (ri = bgp_dest_get_bgp_path_info(dest); ri; ri = ri->next)
 678
 679                         if (CHECK_FLAG(ri->flags, BGP_PATH_SELECTED)
 680                             || (addpath_capable
 681                                 && bgp_addpath_tx_path(
 682                                            peer->addpath_type[afi][safi],
 683                                            ri))) {
 684                                 if (subgroup_announce_check(dest, ri, subgrp,
 685                                                             dest_p, &attr,
 686                                                             false)) {
 687                                         /* Check if route can be advertised */
 688                                         if (advertise)
 689                                                 bgp_adj_out_set_subgroup(dest,
 690                                                                          subgrp,
 691                                                                          &attr,
 692                                                                          ri);
 693                                 } else {
 694                                         /* If default originate is enabled for
 695                                          * the peer, do not send explicit
 696                                          * withdraw. This will prevent deletion
 697                                          * of default route advertised through
 698                                          * default originate
 699                                          */
 700                                         if (CHECK_FLAG(
 701                                                     peer->af_flags[afi][safi],
 702                                                     PEER_FLAG_DEFAULT_ORIGINATE)
 703                                             && is_default_prefix(bgp_dest_get_prefix(dest)))
 704                                                 break;
 705
 706                                         bgp_adj_out_unset_subgroup(
 707                                                 dest, subgrp, 1,
 708                                                 bgp_addpath_id_for_peer(
 709                                                         peer, afi, safi,
 710                                                         &ri->tx_addpath));
 711                                 }
 712                         }
 713         }
 714
 715         /*
 716          * We walked through the whole table -- make sure our version number
 717          * is consistent with the one on the table. This should allow
 718          * subgroups to merge sooner if a peer comes up when the route node
 719          * with the largest version is no longer in the table. This also
 720          * covers the pathological case where all routes in the table have
 721          * now been deleted.
 722          */
 723         subgrp->version = max(subgrp->version, table->version);
 724
 725         /*
 726          * Start a task to merge the subgroup if necessary.
 727          */
 728         update_subgroup_trigger_merge_check(subgrp, 0);
 729 }
 730
 731 /*
 732  * subgroup_announce_route
 733  *
 734  * Refresh all routes out to a subgroup.
 735  */
 736 void subgroup_announce_route(struct update_subgroup *subgrp)
 737 {
 738         struct bgp_dest *dest;
 739         struct bgp_table *table;
 740         struct peer *onlypeer;
 741
 742         if (update_subgroup_needs_refresh(subgrp)) {
 743                 update_subgroup_set_needs_refresh(subgrp, 0);
 744         }
 745
 746         /*
 747          * First update is deferred until ORF or ROUTE-REFRESH is received
 748          */
 749         onlypeer = ((SUBGRP_PCOUNT(subgrp) == 1) ? (SUBGRP_PFIRST(subgrp))->peer
 750                                                  : NULL);
 751         if (onlypeer && CHECK_FLAG(onlypeer->af_sflags[SUBGRP_AFI(subgrp)]
 752                                                       [SUBGRP_SAFI(subgrp)],
 753                                    PEER_STATUS_ORF_WAIT_REFRESH))
 754                 return;
 755
 756         if (SUBGRP_SAFI(subgrp) != SAFI_MPLS_VPN
 757             && SUBGRP_SAFI(subgrp) != SAFI_ENCAP
 758             && SUBGRP_SAFI(subgrp) != SAFI_EVPN)
 759                 subgroup_announce_table(subgrp, NULL);
 760         else
 761                 for (dest = bgp_table_top(update_subgroup_rib(subgrp)); dest;
 762                      dest = bgp_route_next(dest)) {
 763                         table = bgp_dest_get_bgp_table_info(dest);
 764                         if (!table)
 765                                 continue;
 766                         subgroup_announce_table(subgrp, table);
 767                 }
 768 }
 769
 770 void subgroup_default_originate(struct update_subgroup *subgrp, int withdraw)
 771 {
 772         struct bgp *bgp;
 773         struct attr attr;
 774         struct attr *new_attr = &attr;
 775         struct prefix p;
 776         struct peer *from;
 777         struct bgp_dest *dest;
 778         struct bgp_path_info *pi;
 779         struct peer *peer;
 780         struct bgp_adj_out *adj;
 781         route_map_result_t ret = RMAP_DENYMATCH;
 782         afi_t afi;
 783         safi_t safi;
 784
 785         if (!subgrp)
 786                 return;
 787
 788         peer = SUBGRP_PEER(subgrp);
 789         afi = SUBGRP_AFI(subgrp);
 790         safi = SUBGRP_SAFI(subgrp);
 791
 792         if (!(afi == AFI_IP || afi == AFI_IP6))
 793                 return;
 794
 795         bgp = peer->bgp;
 796         from = bgp->peer_self;
 797
 798         bgp_attr_default_set(&attr, BGP_ORIGIN_IGP);
 799
 800         attr.local_pref = bgp->default_local_pref;
 801
 802         if ((afi == AFI_IP6) || peer_cap_enhe(peer, afi, safi)) {
 803                 /* IPv6 global nexthop must be included. */
 804                 attr.mp_nexthop_len = BGP_ATTR_NHLEN_IPV6_GLOBAL;
 805
 806                 /* If the peer is on shared nextwork and we have link-local
 807                    nexthop set it. */
 808                 if (peer->shared_network
 809                     && !IN6_IS_ADDR_UNSPECIFIED(&peer->nexthop.v6_local))
 810                         attr.mp_nexthop_len = BGP_ATTR_NHLEN_IPV6_GLOBAL_AND_LL;
 811         }
 812
 813         if (peer->default_rmap[afi][safi].name) {
 814                 SET_FLAG(bgp->peer_self->rmap_type, PEER_RMAP_TYPE_DEFAULT);
 815
 816                 /* Iterate over the RIB to see if we can announce
 817                  * the default route. We announce the default
 818                  * route only if route-map has a match.
 819                  */
 820                 for (dest = bgp_table_top(bgp->rib[afi][safi]); dest;
 821                      dest = bgp_route_next(dest)) {
 822                         if (!bgp_dest_has_bgp_path_info_data(dest))
 823                                 continue;
 824
 825                         for (pi = bgp_dest_get_bgp_path_info(dest); pi;
 826                              pi = pi->next) {
 827                                 struct attr tmp_attr;
 828                                 struct bgp_path_info tmp_pi;
 829                                 struct bgp_path_info_extra tmp_pie;
 830
 831                                 tmp_attr = *pi->attr;
 832
 833                                 prep_for_rmap_apply(&tmp_pi, &tmp_pie, dest, pi,
 834                                                     pi->peer, &tmp_attr);
 835
 836                                 ret = route_map_apply(
 837                                         peer->default_rmap[afi][safi].map,
 838                                         bgp_dest_get_prefix(dest), &tmp_pi);
 839
 840                                 if (ret == RMAP_DENYMATCH) {
 841                                         bgp_attr_flush(&tmp_attr);
 842                                         continue;
 843                                 } else {
 844                                         new_attr = bgp_attr_intern(&tmp_attr);
 845                                         new_attr->aspath = attr.aspath;
 846
 847                                         subgroup_announce_reset_nhop(
 848                                                 (peer_cap_enhe(peer, afi, safi)
 849                                                          ? AF_INET6
 850                                                          : AF_INET),
 851                                                 new_attr);
 852
 853                                         break;
 854                                 }
 855                         }
 856                         if (ret == RMAP_PERMITMATCH) {
 857                                 bgp_dest_unlock_node(dest);
 858                                 break;
 859                         }
 860                 }
 861                 bgp->peer_self->rmap_type = 0;
 862
 863                 if (ret == RMAP_DENYMATCH)
 864                         withdraw = 1;
 865         }
 866
 867         /* Check if the default route is in local BGP RIB which is
 868          * installed through redistribute or network command
 869          */
 870         memset(&p, 0, sizeof(p));
 871         p.family = afi2family(afi);
 872         p.prefixlen = 0;
 873         dest = bgp_afi_node_lookup(bgp->rib[afi][safi], afi, safi, &p, NULL);
 874
 875         if (withdraw) {
 876                 /* Withdraw the default route advertised using default
 877                  * originate
 878                  */
 879                 if (CHECK_FLAG(subgrp->sflags, SUBGRP_STATUS_DEFAULT_ORIGINATE))
 880                         subgroup_default_withdraw_packet(subgrp);
 881                 UNSET_FLAG(subgrp->sflags, SUBGRP_STATUS_DEFAULT_ORIGINATE);
 882
 883                 /* If default route is present in the local RIB, advertise the
 884                  * route
 885                  */
 886                 if (dest != NULL) {
 887                         for (pi = bgp_dest_get_bgp_path_info(dest); pi;
 888                              pi = pi->next) {
 889                                 if (CHECK_FLAG(pi->flags, BGP_PATH_SELECTED))
 890                                         if (subgroup_announce_check(
 891                                                     dest, pi, subgrp,
 892                                                     bgp_dest_get_prefix(dest),
 893                                                     &attr, false))
 894                                                 bgp_adj_out_set_subgroup(
 895                                                         dest, subgrp, &attr,
 896                                                         pi);
 897                         }
 898                 }
 899         } else {
 900                 if (!CHECK_FLAG(subgrp->sflags,
 901                                 SUBGRP_STATUS_DEFAULT_ORIGINATE)) {
 902
 903                         /* The 'neighbor x.x.x.x default-originate' default will
 904                          * act as an
 905                          * implicit withdraw for any previous UPDATEs sent for
 906                          * 0.0.0.0/0 so
 907                          * clear adj_out for the 0.0.0.0/0 prefix in the BGP
 908                          * table.
 909                          */
 910                         if (dest != NULL) {
 911                                 /* Remove the adjacency for the previously
 912                                  * advertised default route
 913                                  */
 914                                 adj = adj_lookup(
 915                                        dest, subgrp,
 916                                        BGP_ADDPATH_TX_ID_FOR_DEFAULT_ORIGINATE);
 917                                 if (adj != NULL) {
 918                                         /* Clean up previous advertisement.  */
 919                                         if (adj->adv)
 920                                                 bgp_advertise_clean_subgroup(
 921                                                         subgrp, adj);
 922
 923                                         /* Free allocated information.  */
 924                                         adj_free(adj);
 925                                 }
 926                         }
 927
 928                         /* Advertise the default route */
 929                         if (bgp_in_graceful_shutdown(bgp))
 930                                 bgp_attr_add_gshut_community(new_attr);
 931
 932                         SET_FLAG(subgrp->sflags,
 933                                  SUBGRP_STATUS_DEFAULT_ORIGINATE);
 934                         subgroup_default_update_packet(subgrp, new_attr, from);
 935                 }
 936         }
 937 }
 938
 939 /*
 940  * Announce the BGP table to a subgroup.
 941  *
 942  * At startup, we try to optimize route announcement by coalescing the
 943  * peer-up events. This is done only the first time - from then on,
 944  * subgrp->v_coalesce will be set to zero and the normal logic
 945  * prevails.
 946  */
 947 void subgroup_announce_all(struct update_subgroup *subgrp)
 948 {
 949         if (!subgrp)
 950                 return;
 951
 952         /*
 953          * If coalesce timer value is not set, announce routes immediately.
 954          */
 955         if (!subgrp->v_coalesce) {
 956                 if (bgp_debug_update(NULL, NULL, subgrp->update_group, 0))
 957                         zlog_debug("u%" PRIu64 ":s%" PRIu64" announcing all routes",
 958                                    subgrp->update_group->id, subgrp->id);
 959                 subgroup_announce_route(subgrp);
 960                 return;
 961         }
 962
 963         /*
 964          * We should wait for the coalesce timer. Arm the timer if not done.
 965          */
 966         if (!subgrp->t_coalesce) {
 967                 thread_add_timer_msec(bm->master, subgroup_coalesce_timer,
 968                                       subgrp, subgrp->v_coalesce,
 969                                       &subgrp->t_coalesce);
 970         }
 971 }
 972
 973 /*
 974  * Go through all update subgroups and set up the adv queue for the
 975  * input route.
 976  */
 977 void group_announce_route(struct bgp *bgp, afi_t afi, safi_t safi,
 978                           struct bgp_dest *dest, struct bgp_path_info *pi)
 979 {
 980         struct updwalk_context ctx;
 981         ctx.pi = pi;
 982         ctx.dest = dest;
 983
 984         /* If suppress fib is enabled, the route will be advertised when
 985          * FIB status is received
 986          */
 987         if (!bgp_check_advertise(bgp, dest))
 988                 return;
 989
 990         update_group_af_walk(bgp, afi, safi, group_announce_route_walkcb, &ctx);
 991 }
 992
 993 void update_group_show_adj_queue(struct bgp *bgp, afi_t afi, safi_t safi,
 994                                  struct vty *vty, uint64_t id)
 995 {
 996         updgrp_show_adj(bgp, afi, safi, vty, id, UPDWALK_FLAGS_ADVQUEUE);
 997 }
 998
 999 void update_group_show_advertised(struct bgp *bgp, afi_t afi, safi_t safi,
1000                                   struct vty *vty, uint64_t id)
1001 {
1002         updgrp_show_adj(bgp, afi, safi, vty, id, UPDWALK_FLAGS_ADVERTISED);
1003 }
1004
1005 void update_group_announce(struct bgp *bgp)
1006 {
1007         update_group_walk(bgp, update_group_announce_walkcb, NULL);
1008 }
1009
1010 void update_group_announce_rrclients(struct bgp *bgp)
1011 {
1012         update_group_walk(bgp, update_group_announce_rrc_walkcb, NULL);
1013 }