pimd/pim_jp_agg.c

   1 /*
   2  * PIM for FRR - J/P Aggregation
   3  * Copyright (C) 2017 Cumulus Networks, Inc.
   4  * Donald Sharp
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program 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 "linklist.h"
  23 #include "log.h"
  24 #include "vrf.h"
  25 #include "if.h"
  26
  27 #include "pimd.h"
  28 #include "pim_msg.h"
  29 #include "pim_jp_agg.h"
  30 #include "pim_join.h"
  31 #include "pim_iface.h"
  32
  33 void pim_jp_agg_group_list_free(struct pim_jp_agg_group *jag)
  34 {
  35         list_delete(&jag->sources);
  36
  37         XFREE(MTYPE_PIM_JP_AGG_GROUP, jag);
  38 }
  39
  40 static void pim_jp_agg_src_free(struct pim_jp_sources *js)
  41 {
  42         struct pim_upstream *up = js->up;
  43
  44         /*
  45          * When we are being called here, we know
  46          * that the neighbor is going away start
  47          * the normal j/p timer so that it can
  48          * pick this shit back up when the
  49          * nbr comes back alive
  50          */
  51         if (up)
  52                 join_timer_start(js->up);
  53         XFREE(MTYPE_PIM_JP_AGG_SOURCE, js);
  54 }
  55
  56 int pim_jp_agg_group_list_cmp(void *arg1, void *arg2)
  57 {
  58         const struct pim_jp_agg_group *jag1 =
  59                 (const struct pim_jp_agg_group *)arg1;
  60         const struct pim_jp_agg_group *jag2 =
  61                 (const struct pim_jp_agg_group *)arg2;
  62
  63         if (jag1->group.s_addr < jag2->group.s_addr)
  64                 return -1;
  65
  66         if (jag1->group.s_addr > jag2->group.s_addr)
  67                 return 1;
  68
  69         return 0;
  70 }
  71
  72 static int pim_jp_agg_src_cmp(void *arg1, void *arg2)
  73 {
  74         const struct pim_jp_sources *js1 = (const struct pim_jp_sources *)arg1;
  75         const struct pim_jp_sources *js2 = (const struct pim_jp_sources *)arg2;
  76
  77         if (js1->is_join && !js2->is_join)
  78                 return -1;
  79
  80         if (!js1->is_join && js2->is_join)
  81                 return 1;
  82
  83         if ((uint32_t)js1->up->sg.src.s_addr < (uint32_t)js2->up->sg.src.s_addr)
  84                 return -1;
  85
  86         if ((uint32_t)js1->up->sg.src.s_addr > (uint32_t)js2->up->sg.src.s_addr)
  87                 return 1;
  88
  89         return 0;
  90 }
  91
  92 /*
  93  * This function is used by scan_oil to clear
  94  * the created jp_agg_group created when
  95  * figuring out where to send prunes
  96  * and joins.
  97  */
  98 void pim_jp_agg_clear_group(struct list *group)
  99 {
 100         struct listnode *gnode, *gnnode;
 101         struct listnode *snode, *snnode;
 102         struct pim_jp_agg_group *jag;
 103         struct pim_jp_sources *js;
 104
 105         for (ALL_LIST_ELEMENTS(group, gnode, gnnode, jag)) {
 106                 for (ALL_LIST_ELEMENTS(jag->sources, snode, snnode, js)) {
 107                         listnode_delete(jag->sources, js);
 108                         js->up = NULL;
 109                         XFREE(MTYPE_PIM_JP_AGG_SOURCE, js);
 110                 }
 111                 list_delete(&jag->sources);
 112                 listnode_delete(group, jag);
 113                 XFREE(MTYPE_PIM_JP_AGG_GROUP, jag);
 114         }
 115 }
 116
 117 static struct pim_iface_upstream_switch *
 118 pim_jp_agg_get_interface_upstream_switch_list(struct pim_rpf *rpf)
 119 {
 120         struct pim_interface *pim_ifp = rpf->source_nexthop.interface->info;
 121         struct pim_iface_upstream_switch *pius;
 122         struct listnode *node, *nnode;
 123
 124         /* Old interface is pim disabled */
 125         if (!pim_ifp)
 126                 return NULL;
 127
 128         for (ALL_LIST_ELEMENTS(pim_ifp->upstream_switch_list, node, nnode,
 129                                pius)) {
 130                 if (pius->address.s_addr == rpf->rpf_addr.u.prefix4.s_addr)
 131                         break;
 132         }
 133
 134         if (!pius) {
 135                 pius = XCALLOC(MTYPE_PIM_JP_AGG_GROUP,
 136                                sizeof(struct pim_iface_upstream_switch));
 137                 pius->address.s_addr = rpf->rpf_addr.u.prefix4.s_addr;
 138                 pius->us = list_new();
 139                 listnode_add_sort(pim_ifp->upstream_switch_list, pius);
 140         }
 141
 142         return pius;
 143 }
 144
 145 void pim_jp_agg_remove_group(struct list *group, struct pim_upstream *up)
 146 {
 147         struct listnode *node, *nnode;
 148         struct pim_jp_agg_group *jag = NULL;
 149         struct pim_jp_sources *js = NULL;
 150
 151         for (ALL_LIST_ELEMENTS(group, node, nnode, jag)) {
 152                 if (jag->group.s_addr == up->sg.grp.s_addr)
 153                         break;
 154         }
 155
 156         if (!jag)
 157                 return;
 158
 159         for (ALL_LIST_ELEMENTS(jag->sources, node, nnode, js)) {
 160                 if (js->up == up)
 161                         break;
 162         }
 163
 164         if (js) {
 165                 js->up = NULL;
 166                 listnode_delete(jag->sources, js);
 167                 XFREE(MTYPE_PIM_JP_AGG_SOURCE, js);
 168         }
 169
 170         if (jag->sources->count == 0) {
 171                 list_delete(&jag->sources);
 172                 listnode_delete(group, jag);
 173                 XFREE(MTYPE_PIM_JP_AGG_GROUP, jag);
 174         }
 175 }
 176
 177 int pim_jp_agg_is_in_list(struct list *group, struct pim_upstream *up)
 178 {
 179         struct listnode *node, *nnode;
 180         struct pim_jp_agg_group *jag = NULL;
 181         struct pim_jp_sources *js = NULL;
 182
 183         for (ALL_LIST_ELEMENTS(group, node, nnode, jag)) {
 184                 if (jag->group.s_addr == up->sg.grp.s_addr)
 185                         break;
 186         }
 187
 188         if (!jag)
 189                 return 0;
 190
 191         for (ALL_LIST_ELEMENTS(jag->sources, node, nnode, js)) {
 192                 if (js->up == up)
 193                         return 1;
 194         }
 195
 196         return 0;
 197 }
 198
 199 //#define PIM_JP_AGG_DEBUG 1
 200 /*
 201  * For the given upstream, check all the neighbor
 202  * jp_agg lists and ensure that it is not
 203  * in another list
 204  *
 205  * *IF* ignore is true we can skip
 206  * up->rpf.source_nexthop.interface particular interface for checking
 207  *
 208  * This is a debugging function, Probably
 209  * can be safely compiled out in real
 210  * builds
 211  */
 212 void pim_jp_agg_upstream_verification(struct pim_upstream *up, bool ignore)
 213 {
 214 #ifdef PIM_JP_AGG_DEBUG
 215         struct interface *ifp;
 216         struct pim_interface *pim_ifp;
 217         struct pim_instance *pim;
 218
 219         if (!up->rpf.source_nexthop.interface) {
 220                 if (PIM_DEBUG_TRACE)
 221                         zlog_debug("%s: up %s RPF is not present",
 222                                 __PRETTY_FUNCTION__, up->sg_str);
 223                 return;
 224         }
 225
 226         pim_ifp = up->rpf.source_nexthop.interface->info;
 227         pim = pim_ifp->pim;
 228
 229         FOR_ALL_INTERFACES (pim->vrf, ifp) {
 230                 pim_ifp = ifp->info;
 231                 struct listnode *nnode;
 232
 233                 if (ignore && ifp == up->rpf.source_nexthop.interface)
 234                         continue;
 235
 236                 if (pim_ifp) {
 237                         struct pim_neighbor *neigh;
 238                         for (ALL_LIST_ELEMENTS_RO(pim_ifp->pim_neighbor_list,
 239                                                   nnode, neigh)) {
 240                                 assert(!pim_jp_agg_is_in_list(
 241                                         neigh->upstream_jp_agg, up));
 242                         }
 243                 }
 244         }
 245 #else
 246         return;
 247 #endif
 248 }
 249
 250 void pim_jp_agg_add_group(struct list *group, struct pim_upstream *up,
 251                           bool is_join)
 252 {
 253         struct listnode *node, *nnode;
 254         struct pim_jp_agg_group *jag = NULL;
 255         struct pim_jp_sources *js = NULL;
 256
 257         for (ALL_LIST_ELEMENTS(group, node, nnode, jag)) {
 258                 if (jag->group.s_addr == up->sg.grp.s_addr)
 259                         break;
 260         }
 261
 262         if (!jag) {
 263                 jag = XCALLOC(MTYPE_PIM_JP_AGG_GROUP,
 264                               sizeof(struct pim_jp_agg_group));
 265                 jag->group.s_addr = up->sg.grp.s_addr;
 266                 jag->sources = list_new();
 267                 jag->sources->cmp = pim_jp_agg_src_cmp;
 268                 jag->sources->del = (void (*)(void *))pim_jp_agg_src_free;
 269                 listnode_add_sort(group, jag);
 270         }
 271
 272         for (ALL_LIST_ELEMENTS(jag->sources, node, nnode, js)) {
 273                 if (js->up == up)
 274                         break;
 275         }
 276
 277         if (!js) {
 278                 js = XCALLOC(MTYPE_PIM_JP_AGG_SOURCE,
 279                              sizeof(struct pim_jp_sources));
 280                 js->up = up;
 281                 js->is_join = is_join;
 282                 listnode_add_sort(jag->sources, js);
 283         } else {
 284                 if (js->is_join != is_join) {
 285                         listnode_delete(jag->sources, js);
 286                         js->is_join = is_join;
 287                         listnode_add_sort(jag->sources, js);
 288                 }
 289         }
 290 }
 291
 292 void pim_jp_agg_switch_interface(struct pim_rpf *orpf, struct pim_rpf *nrpf,
 293                                  struct pim_upstream *up)
 294 {
 295         struct pim_iface_upstream_switch *opius;
 296         struct pim_iface_upstream_switch *npius;
 297
 298         opius = pim_jp_agg_get_interface_upstream_switch_list(orpf);
 299         npius = pim_jp_agg_get_interface_upstream_switch_list(nrpf);
 300
 301         /*
 302          * RFC 4601: 4.5.7.  Sending (S,G) Join/Prune Messages
 303          *
 304          * Transitions from Joined State
 305          *
 306          * RPF'(S,G) changes not due to an Assert
 307          *
 308          * The upstream (S,G) state machine remains in Joined
 309          * state. Send Join(S,G) to the new upstream neighbor, which is
 310          * the new value of RPF'(S,G).  Send Prune(S,G) to the old
 311          * upstream neighbor, which is the old value of RPF'(S,G).  Set
 312          * the Join Timer (JT) to expire after t_periodic seconds.
 313          */
 314
 315         /* send Prune(S,G) to the old upstream neighbor */
 316         if (opius)
 317                 pim_jp_agg_add_group(opius->us, up, false);
 318
 319         /* send Join(S,G) to the current upstream neighbor */
 320         pim_jp_agg_add_group(npius->us, up, true);
 321 }
 322
 323
 324 void pim_jp_agg_single_upstream_send(struct pim_rpf *rpf,
 325                                      struct pim_upstream *up, bool is_join)
 326 {
 327         static struct list *groups = NULL;
 328         static struct pim_jp_agg_group jag;
 329         static struct pim_jp_sources js;
 330
 331         static bool first = true;
 332
 333         /* skip JP upstream messages if source is directly connected */
 334         if (!up || !rpf->source_nexthop.interface || pim_if_connected_to_source(
 335                                                              rpf->source_nexthop
 336                                                                      .interface,
 337                                                              up->sg.src))
 338                 return;
 339
 340         if (first) {
 341                 groups = list_new();
 342                 jag.sources = list_new();
 343
 344                 listnode_add(groups, &jag);
 345                 listnode_add(jag.sources, &js);
 346
 347                 first = false;
 348         }
 349
 350         jag.group.s_addr = up->sg.grp.s_addr;
 351         js.up = up;
 352         js.is_join = is_join;
 353
 354         pim_joinprune_send(rpf, groups);
 355 }