pimd/pim_upstream.h

   1 /*
   2  * PIM for Quagga
   3  * Copyright (C) 2008  Everton da Silva Marques
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful, but
  11  * WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License along
  16  * with this program; see the file COPYING; if not, write to the Free Software
  17  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  18  */
  19
  20 #ifndef PIM_UPSTREAM_H
  21 #define PIM_UPSTREAM_H
  22
  23 #include <zebra.h>
  24 #include <prefix.h>
  25 #include "plist.h"
  26
  27 #include <pimd/pim_rpf.h>
  28 #include "pim_str.h"
  29 #include "pim_ifchannel.h"
  30
  31 #define PIM_UPSTREAM_FLAG_MASK_DR_JOIN_DESIRED         (1 << 0)
  32 #define PIM_UPSTREAM_FLAG_MASK_DR_JOIN_DESIRED_UPDATED (1 << 1)
  33 #define PIM_UPSTREAM_FLAG_MASK_FHR                     (1 << 2)
  34 #define PIM_UPSTREAM_FLAG_MASK_SRC_IGMP                (1 << 3)
  35 #define PIM_UPSTREAM_FLAG_MASK_SRC_PIM                 (1 << 4)
  36 #define PIM_UPSTREAM_FLAG_MASK_SRC_STREAM              (1 << 5)
  37 #define PIM_UPSTREAM_FLAG_MASK_SRC_MSDP                (1 << 6)
  38 #define PIM_UPSTREAM_FLAG_MASK_SEND_SG_RPT_PRUNE       (1 << 7)
  39 #define PIM_UPSTREAM_FLAG_MASK_SRC_LHR                 (1 << 8)
  40 /* In the case of pim vxlan we prime the pump by registering the
  41  * vxlan source and keeping the SPT (FHR-RP) alive by sending periodic
  42  * NULL registers. So we need to prevent KAT expiry because of the
  43  * lack of BUM traffic.
  44  */
  45 #define PIM_UPSTREAM_FLAG_MASK_DISABLE_KAT_EXPIRY      (1 << 9)
  46 /* for pim vxlan we need to pin the IIF to lo or MLAG-ISL on the
  47  * originating VTEP. This flag allows that by setting IIF to the
  48  * value specified and preventing next-hop-tracking on the entry
  49  */
  50 #define PIM_UPSTREAM_FLAG_MASK_STATIC_IIF              (1 << 10)
  51 #define PIM_UPSTREAM_FLAG_MASK_ALLOW_IIF_IN_OIL        (1 << 11)
  52 /* Disable pimreg encasulation for a flow */
  53 #define PIM_UPSTREAM_FLAG_MASK_NO_PIMREG_DATA          (1 << 12)
  54 /* For some MDTs we need to register the router as a source even
  55  * if the not DR or directly connected on the IIF. This is typically
  56  * needed on a VxLAN-AA (MLAG) setup.
  57  */
  58 #define PIM_UPSTREAM_FLAG_MASK_FORCE_PIMREG            (1 << 13)
  59 /* VxLAN origination mroute - SG was registered by EVPN where S is the
  60  * local VTEP IP and G is the BUM multicast group address
  61  */
  62 #define PIM_UPSTREAM_FLAG_MASK_SRC_VXLAN_ORIG          (1 << 14)
  63 /* VxLAN termination mroute - *G entry where G is the BUM multicast group
  64  * address
  65  */
  66 #define PIM_UPSTREAM_FLAG_MASK_SRC_VXLAN_TERM          (1 << 15)
  67 /* MLAG mroute - synced to the MLAG peer and subject to DF (designated
  68  * forwarder) election
  69  */
  70 #define PIM_UPSTREAM_FLAG_MASK_MLAG_VXLAN              (1 << 16)
  71 /* MLAG mroute that lost the DF election with peer and is installed in
  72  * a dormant state i.e. MLAG OIFs are removed from the MFC.
  73  * In most cases the OIL is empty (but not not always) simply
  74  * blackholing the traffic pulled down to the LHR.
  75  */
  76 #define PIM_UPSTREAM_FLAG_MASK_MLAG_NON_DF             (1 << 17)
  77 #define PIM_UPSTREAM_FLAG_ALL 0xFFFFFFFF
  78
  79 #define PIM_UPSTREAM_FLAG_TEST_DR_JOIN_DESIRED(flags) ((flags) & PIM_UPSTREAM_FLAG_MASK_DR_JOIN_DESIRED)
  80 #define PIM_UPSTREAM_FLAG_TEST_DR_JOIN_DESIRED_UPDATED(flags) ((flags) & PIM_UPSTREAM_FLAG_MASK_DR_JOIN_DESIRED_UPDATED)
  81 #define PIM_UPSTREAM_FLAG_TEST_FHR(flags) ((flags) & PIM_UPSTREAM_FLAG_MASK_FHR)
  82 #define PIM_UPSTREAM_FLAG_TEST_SRC_IGMP(flags) ((flags) & PIM_UPSTREAM_FLAG_MASK_SRC_IGMP)
  83 #define PIM_UPSTREAM_FLAG_TEST_SRC_PIM(flags) ((flags) & PIM_UPSTREAM_FLAG_MASK_SRC_PIM)
  84 #define PIM_UPSTREAM_FLAG_TEST_SRC_STREAM(flags) ((flags) & PIM_UPSTREAM_FLAG_MASK_SRC_STREAM)
  85 #define PIM_UPSTREAM_FLAG_TEST_SRC_MSDP(flags) ((flags) & PIM_UPSTREAM_FLAG_MASK_SRC_MSDP)
  86 #define PIM_UPSTREAM_FLAG_TEST_SEND_SG_RPT_PRUNE(flags) ((flags) & PIM_UPSTREAM_FLAG_MASK_SEND_SG_RPT_PRUNE)
  87 #define PIM_UPSTREAM_FLAG_TEST_SRC_LHR(flags) ((flags) & PIM_UPSTREAM_FLAG_MASK_SRC_LHR)
  88 #define PIM_UPSTREAM_FLAG_TEST_DISABLE_KAT_EXPIRY(flags) ((flags) & PIM_UPSTREAM_FLAG_MASK_DISABLE_KAT_EXPIRY)
  89 #define PIM_UPSTREAM_FLAG_TEST_STATIC_IIF(flags) ((flags) & PIM_UPSTREAM_FLAG_MASK_STATIC_IIF)
  90 #define PIM_UPSTREAM_FLAG_TEST_ALLOW_IIF_IN_OIL(flags) ((flags) & PIM_UPSTREAM_FLAG_MASK_ALLOW_IIF_IN_OIL)
  91 #define PIM_UPSTREAM_FLAG_TEST_NO_PIMREG_DATA(flags) ((flags) & PIM_UPSTREAM_FLAG_MASK_NO_PIMREG_DATA)
  92 #define PIM_UPSTREAM_FLAG_TEST_FORCE_PIMREG(flags) ((flags) & PIM_UPSTREAM_FLAG_MASK_FORCE_PIMREG)
  93 #define PIM_UPSTREAM_FLAG_TEST_SRC_VXLAN_ORIG(flags) ((flags) & PIM_UPSTREAM_FLAG_MASK_SRC_VXLAN_ORIG)
  94 #define PIM_UPSTREAM_FLAG_TEST_SRC_VXLAN_TERM(flags) ((flags) & PIM_UPSTREAM_FLAG_MASK_SRC_VXLAN_TERM)
  95 #define PIM_UPSTREAM_FLAG_TEST_SRC_VXLAN(flags) ((flags) & (PIM_UPSTREAM_FLAG_MASK_SRC_VXLAN_ORIG | PIM_UPSTREAM_FLAG_MASK_SRC_VXLAN_TERM))
  96 #define PIM_UPSTREAM_FLAG_TEST_MLAG_VXLAN(flags) ((flags) & PIM_UPSTREAM_FLAG_MASK_MLAG_VXLAN)
  97 #define PIM_UPSTREAM_FLAG_TEST_MLAG_NON_DF(flags) ((flags) & PIM_UPSTREAM_FLAG_MASK_MLAG_NON_DF)
  98
  99 #define PIM_UPSTREAM_FLAG_SET_DR_JOIN_DESIRED(flags) ((flags) |= PIM_UPSTREAM_FLAG_MASK_DR_JOIN_DESIRED)
 100 #define PIM_UPSTREAM_FLAG_SET_DR_JOIN_DESIRED_UPDATED(flags) ((flags) |= PIM_UPSTREAM_FLAG_MASK_DR_JOIN_DESIRED_UPDATED)
 101 #define PIM_UPSTREAM_FLAG_SET_FHR(flags) ((flags) |= PIM_UPSTREAM_FLAG_MASK_FHR)
 102 #define PIM_UPSTREAM_FLAG_SET_SRC_IGMP(flags) ((flags) |= PIM_UPSTREAM_FLAG_MASK_SRC_IGMP)
 103 #define PIM_UPSTREAM_FLAG_SET_SRC_PIM(flags) ((flags) |= PIM_UPSTREAM_FLAG_MASK_SRC_PIM)
 104 #define PIM_UPSTREAM_FLAG_SET_SRC_STREAM(flags) ((flags) |= PIM_UPSTREAM_FLAG_MASK_SRC_STREAM)
 105 #define PIM_UPSTREAM_FLAG_SET_SRC_MSDP(flags) ((flags) |= PIM_UPSTREAM_FLAG_MASK_SRC_MSDP)
 106 #define PIM_UPSTREAM_FLAG_SET_SEND_SG_RPT_PRUNE(flags) ((flags) |= PIM_UPSTREAM_FLAG_MASK_SEND_SG_RPT_PRUNE)
 107 #define PIM_UPSTREAM_FLAG_SET_SRC_LHR(flags) ((flags) |= PIM_UPSTREAM_FLAG_MASK_SRC_LHR)
 108 #define PIM_UPSTREAM_FLAG_SET_DISABLE_KAT_EXPIRY(flags) ((flags) |= PIM_UPSTREAM_FLAG_MASK_DISABLE_KAT_EXPIRY)
 109 #define PIM_UPSTREAM_FLAG_SET_STATIC_IIF(flags) ((flags) |= PIM_UPSTREAM_FLAG_MASK_STATIC_IIF)
 110 #define PIM_UPSTREAM_FLAG_SET_ALLOW_IIF_IN_OIL(flags) ((flags) |= PIM_UPSTREAM_FLAG_MASK_ALLOW_IIF_IN_OIL)
 111 #define PIM_UPSTREAM_FLAG_SET_NO_PIMREG_DATA(flags) ((flags) |= PIM_UPSTREAM_FLAG_MASK_NO_PIMREG_DATA)
 112 #define PIM_UPSTREAM_FLAG_SET_FORCE_PIMREG(flags) ((flags) |= PIM_UPSTREAM_FLAG_MASK_FORCE_PIMREG)
 113 #define PIM_UPSTREAM_FLAG_SET_SRC_VXLAN_ORIG(flags) ((flags) |= PIM_UPSTREAM_FLAG_MASK_SRC_VXLAN_ORIG)
 114 #define PIM_UPSTREAM_FLAG_SET_SRC_VXLAN_TERM(flags) ((flags) |= PIM_UPSTREAM_FLAG_MASK_SRC_VXLAN_TERM)
 115 #define PIM_UPSTREAM_FLAG_SET_MLAG_VXLAN(flags) ((flags) |= PIM_UPSTREAM_FLAG_MASK_MLAG_VXLAN)
 116 #define PIM_UPSTREAM_FLAG_SET_MLAG_NON_DF(flags) ((flags) |= PIM_UPSTREAM_FLAG_MASK_MLAG_NON_DF)
 117
 118 #define PIM_UPSTREAM_FLAG_UNSET_DR_JOIN_DESIRED(flags) ((flags) &= ~PIM_UPSTREAM_FLAG_MASK_DR_JOIN_DESIRED)
 119 #define PIM_UPSTREAM_FLAG_UNSET_DR_JOIN_DESIRED_UPDATED(flags) ((flags) &= ~PIM_UPSTREAM_FLAG_MASK_DR_JOIN_DESIRED_UPDATED)
 120 #define PIM_UPSTREAM_FLAG_UNSET_FHR(flags) ((flags) &= ~PIM_UPSTREAM_FLAG_MASK_FHR)
 121 #define PIM_UPSTREAM_FLAG_UNSET_SRC_IGMP(flags) ((flags) &= ~PIM_UPSTREAM_FLAG_MASK_SRC_IGMP)
 122 #define PIM_UPSTREAM_FLAG_UNSET_SRC_PIM(flags) ((flags) &= ~PIM_UPSTREAM_FLAG_MASK_SRC_PIM)
 123 #define PIM_UPSTREAM_FLAG_UNSET_SRC_STREAM(flags) ((flags) &= ~PIM_UPSTREAM_FLAG_MASK_SRC_STREAM)
 124 #define PIM_UPSTREAM_FLAG_UNSET_SRC_MSDP(flags) ((flags) &= ~PIM_UPSTREAM_FLAG_MASK_SRC_MSDP)
 125 #define PIM_UPSTREAM_FLAG_UNSET_SEND_SG_RPT_PRUNE(flags) ((flags) &= ~PIM_UPSTREAM_FLAG_MASK_SEND_SG_RPT_PRUNE)
 126 #define PIM_UPSTREAM_FLAG_UNSET_SRC_LHR(flags) ((flags) &= ~PIM_UPSTREAM_FLAG_MASK_SRC_LHR)
 127 #define PIM_UPSTREAM_FLAG_UNSET_DISABLE_KAT_EXPIRY(flags) ((flags) &= ~PIM_UPSTREAM_FLAG_MASK_DISABLE_KAT_EXPIRY)
 128 #define PIM_UPSTREAM_FLAG_UNSET_STATIC_IIF(flags) ((flags) &= ~PIM_UPSTREAM_FLAG_MASK_STATIC_IIF)
 129 #define PIM_UPSTREAM_FLAG_UNSET_ALLOW_IIF_IN_OIL(flags) ((flags) &= ~PIM_UPSTREAM_FLAG_MASK_ALLOW_IIF_IN_OIL)
 130 #define PIM_UPSTREAM_FLAG_UNSET_NO_PIMREG_DATA(flags) ((flags) &= ~PIM_UPSTREAM_FLAG_MASK_NO_PIMREG_DATA)
 131 #define PIM_UPSTREAM_FLAG_UNSET_FORCE_PIMREG(flags) ((flags) &= ~PIM_UPSTREAM_FLAG_MASK_FORCE_PIMREG)
 132 #define PIM_UPSTREAM_FLAG_UNSET_SRC_VXLAN_ORIG(flags) ((flags) &= ~PIM_UPSTREAM_FLAG_MASK_SRC_VXLAN_ORIG)
 133 #define PIM_UPSTREAM_FLAG_UNSET_SRC_VXLAN_TERM(flags) ((flags) &= ~PIM_UPSTREAM_FLAG_MASK_SRC_VXLAN_TERM)
 134 #define PIM_UPSTREAM_FLAG_UNSET_MLAG_VXLAN(flags) ((flags) &= ~PIM_UPSTREAM_FLAG_MASK_MLAG_VXLAN)
 135 #define PIM_UPSTREAM_FLAG_UNSET_MLAG_NON_DF(flags) ((flags) &= ~PIM_UPSTREAM_FLAG_MASK_MLAG_NON_DF)
 136
 137 enum pim_upstream_state {
 138         PIM_UPSTREAM_NOTJOINED,
 139         PIM_UPSTREAM_JOINED,
 140 };
 141
 142 enum pim_reg_state {
 143         PIM_REG_NOINFO,
 144         PIM_REG_JOIN,
 145         PIM_REG_JOIN_PENDING,
 146         PIM_REG_PRUNE,
 147 };
 148
 149 enum pim_upstream_sptbit {
 150         PIM_UPSTREAM_SPTBIT_FALSE,
 151         PIM_UPSTREAM_SPTBIT_TRUE
 152 };
 153
 154 /*
 155   Upstream (S,G) channel in Joined state
 156   (S,G) in the "Not Joined" state is not represented
 157   See RFC 4601: 4.5.7.  Sending (S,G) Join/Prune Message
 158
 159   upstream_addr : Who we are talking to.
 160   For (*, G), upstream_addr is RP address or INADDR_ANY(if RP not configured)
 161   For (S, G), upstream_addr is source address
 162
 163   rpf: contains the nexthop information to whom we are talking to.
 164
 165   join_state: JOINED/NOTJOINED
 166
 167   In the case when FRR receives IGMP/PIM (*, G) join for group G and RP is not
 168   configured, then create a pim_upstream with the below information.
 169   pim_upstream->upstream address: INADDR_ANY
 170   pim_upstream->rpf: Unknown
 171   pim_upstream->state: NOTJOINED
 172
 173   When a new RP gets configured for G, find the corresponding pim upstream (*,G)
 174   entries and update the upstream address as new RP address if it the better one
 175   for the group G.
 176
 177   When RP becomes reachable, populate the nexthop information in
 178   pim_upstream->rpf and update the state to JOINED.
 179
 180 */
 181 struct pim_upstream {
 182         struct pim_upstream *parent;
 183         struct in_addr upstream_addr;     /* Who we are talking to */
 184         struct in_addr upstream_register; /*Who we received a register from*/
 185         struct prefix_sg sg;              /* (S,G) group key */
 186         char sg_str[PIM_SG_LEN];
 187         uint32_t flags;
 188         struct channel_oil *channel_oil;
 189         struct list *sources;
 190         struct list *ifchannels;
 191
 192         enum pim_upstream_state join_state;
 193         enum pim_reg_state reg_state;
 194         enum pim_upstream_sptbit sptbit;
 195
 196         int ref_count;
 197
 198         struct pim_rpf rpf;
 199
 200         struct thread *t_join_timer;
 201
 202         /*
 203          * RST(S,G)
 204          */
 205         struct thread *t_rs_timer;
 206 #define PIM_REGISTER_SUPPRESSION_PERIOD (60)
 207 #define PIM_REGISTER_PROBE_PERIOD        (5)
 208
 209         /*
 210          * KAT(S,G)
 211          */
 212         struct thread *t_ka_timer;
 213 #define PIM_KEEPALIVE_PERIOD  (210)
 214 #define PIM_RP_KEEPALIVE_PERIOD                                                \
 215         (3 * router->register_suppress_time + router->register_probe_time)
 216
 217         /* on the RP we restart a timer to indicate if registers are being rxed
 218          * for
 219          * SG. This is needed by MSDP to determine its local SA cache */
 220         struct thread *t_msdp_reg_timer;
 221 #define PIM_MSDP_REG_RXED_PERIOD (3 * (1.5 * router->register_suppress_time))
 222
 223         int64_t state_transition; /* Record current state uptime */
 224 };
 225
 226 struct pim_upstream *pim_upstream_find(struct pim_instance *pim,
 227                                        struct prefix_sg *sg);
 228 struct pim_upstream *pim_upstream_find_or_add(struct prefix_sg *sg,
 229                                               struct interface *ifp, int flags,
 230                                               const char *name);
 231 struct pim_upstream *pim_upstream_add(struct pim_instance *pim,
 232                                       struct prefix_sg *sg,
 233                                       struct interface *ifp, int flags,
 234                                       const char *name,
 235                                       struct pim_ifchannel *ch);
 236 void pim_upstream_ref(struct pim_upstream *up, int flags, const char *name);
 237 struct pim_upstream *pim_upstream_del(struct pim_instance *pim,
 238                                       struct pim_upstream *up,
 239                                       const char *name);
 240
 241 int pim_upstream_evaluate_join_desired(struct pim_instance *pim,
 242                                        struct pim_upstream *up);
 243 int pim_upstream_evaluate_join_desired_interface(struct pim_upstream *up,
 244                                                  struct pim_ifchannel *ch,
 245                                                  struct pim_ifchannel *starch);
 246 void pim_upstream_update_join_desired(struct pim_instance *pim,
 247                                       struct pim_upstream *up);
 248
 249 void pim_upstream_join_suppress(struct pim_upstream *up,
 250                                 struct in_addr rpf_addr, int holdtime);
 251
 252 void pim_upstream_join_timer_decrease_to_t_override(const char *debug_label,
 253                                                     struct pim_upstream *up);
 254
 255 void pim_upstream_join_timer_restart(struct pim_upstream *up,
 256                                      struct pim_rpf *old);
 257 void pim_upstream_rpf_genid_changed(struct pim_instance *pim,
 258                                     struct in_addr neigh_addr);
 259 void pim_upstream_rpf_interface_changed(struct pim_upstream *up,
 260                                         struct interface *old_rpf_ifp);
 261
 262 void pim_upstream_update_could_assert(struct pim_upstream *up);
 263 void pim_upstream_update_my_assert_metric(struct pim_upstream *up);
 264
 265 void pim_upstream_keep_alive_timer_start(struct pim_upstream *up,
 266                                          uint32_t time);
 267
 268 int pim_upstream_switch_to_spt_desired(struct pim_instance *pim,
 269                                        struct prefix_sg *sg);
 270 #define SwitchToSptDesired(pim, sg) pim_upstream_switch_to_spt_desired (pim, sg)
 271 int pim_upstream_is_sg_rpt(struct pim_upstream *up);
 272
 273 void pim_upstream_set_sptbit(struct pim_upstream *up,
 274                              struct interface *incoming);
 275
 276 void pim_upstream_start_register_stop_timer(struct pim_upstream *up,
 277                                             int null_register);
 278
 279 void pim_upstream_send_join(struct pim_upstream *up);
 280
 281 void pim_upstream_switch(struct pim_instance *pim, struct pim_upstream *up,
 282                          enum pim_upstream_state new_state);
 283
 284 const char *pim_upstream_state2str(enum pim_upstream_state join_state);
 285 #define PIM_REG_STATE_STR_LEN 12
 286 const char *pim_reg_state2str(enum pim_reg_state state, char *state_str);
 287
 288 int pim_upstream_inherited_olist_decide(struct pim_instance *pim,
 289                                         struct pim_upstream *up);
 290 int pim_upstream_inherited_olist(struct pim_instance *pim,
 291                                  struct pim_upstream *up);
 292 int pim_upstream_empty_inherited_olist(struct pim_upstream *up);
 293
 294 void pim_upstream_find_new_rpf(struct pim_instance *pim);
 295 void pim_upstream_msdp_reg_timer_start(struct pim_upstream *up);
 296
 297 void pim_upstream_init(struct pim_instance *pim);
 298 void pim_upstream_terminate(struct pim_instance *pim);
 299
 300 void join_timer_start(struct pim_upstream *up);
 301 int pim_upstream_compare(void *arg1, void *arg2);
 302 void pim_upstream_register_reevaluate(struct pim_instance *pim);
 303
 304 void pim_upstream_add_lhr_star_pimreg(struct pim_instance *pim);
 305 void pim_upstream_remove_lhr_star_pimreg(struct pim_instance *pim,
 306                                          const char *nlist);
 307
 308 void pim_upstream_spt_prefix_list_update(struct pim_instance *pim,
 309                                          struct prefix_list *pl);
 310
 311 unsigned int pim_upstream_hash_key(void *arg);
 312 bool pim_upstream_equal(const void *arg1, const void *arg2);
 313 struct pim_upstream *pim_upstream_keep_alive_timer_proc(
 314                 struct pim_upstream *up);
 315 void pim_upstream_fill_static_iif(struct pim_upstream *up,
 316                                 struct interface *incoming);
 317 #endif /* PIM_UPSTREAM_H */