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
  16   along with this program; see the file COPYING; if not, write to the
  17   Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston,
  18   MA 02110-1301 USA
  19 */
  20
  21 #ifndef PIM_UPSTREAM_H
  22 #define PIM_UPSTREAM_H
  23
  24 #include <zebra.h>
  25 #include <prefix.h>
  26
  27 #include <pimd/pim_rpf.h>
  28
  29 #define PIM_UPSTREAM_FLAG_MASK_DR_JOIN_DESIRED         (1 << 0)
  30 #define PIM_UPSTREAM_FLAG_MASK_DR_JOIN_DESIRED_UPDATED (1 << 1)
  31 #define PIM_UPSTREAM_FLAG_MASK_FHR                     (1 << 2)
  32 #define PIM_UPSTREAM_FLAG_MASK_SRC_IGMP                (1 << 3)
  33 #define PIM_UPSTREAM_FLAG_MASK_SRC_PIM                 (1 << 4)
  34 #define PIM_UPSTREAM_FLAG_MASK_SRC_STREAM              (1 << 5)
  35 #define PIM_UPSTREAM_FLAG_MASK_SRC_MSDP                (1 << 6)
  36 #define PIM_UPSTREAM_FLAG_MASK_SEND_SG_RPT_PRUNE       (1 << 7)
  37 #define PIM_UPSTREAM_FLAG_MASK_SRC_LHR                 (1 << 8)
  38 #define PIM_UPSTREAM_FLAG_ALL 0xFFFFFFFF
  39
  40 #define PIM_UPSTREAM_FLAG_TEST_DR_JOIN_DESIRED(flags) ((flags) & PIM_UPSTREAM_FLAG_MASK_DR_JOIN_DESIRED)
  41 #define PIM_UPSTREAM_FLAG_TEST_DR_JOIN_DESIRED_UPDATED(flags) ((flags) & PIM_UPSTREAM_FLAG_MASK_DR_JOIN_DESIRED_UPDATED)
  42 #define PIM_UPSTREAM_FLAG_TEST_FHR(flags) ((flags) & PIM_UPSTREAM_FLAG_MASK_FHR)
  43 #define PIM_UPSTREAM_FLAG_TEST_SRC_IGMP(flags) ((flags) & PIM_UPSTREAM_FLAG_MASK_SRC_IGMP)
  44 #define PIM_UPSTREAM_FLAG_TEST_SRC_PIM(flags) ((flags) & PIM_UPSTREAM_FLAG_MASK_SRC_PIM)
  45 #define PIM_UPSTREAM_FLAG_TEST_SRC_STREAM(flags) ((flags) & PIM_UPSTREAM_FLAG_MASK_SRC_STREAM)
  46 #define PIM_UPSTREAM_FLAG_TEST_SRC_MSDP(flags) ((flags) & PIM_UPSTREAM_FLAG_MASK_SRC_MSDP)
  47 #define PIM_UPSTREAM_FLAG_TEST_SEND_SG_RPT_PRUNE(flags) ((flags) & PIM_UPSTREAM_FLAG_MASK_SEND_SG_RPT_PRUNE)
  48 #define PIM_UPSTREAM_FLAG_TEST_SRC_LHR(flags) ((flags) & PIM_UPSTREAM_FLAG_MASK_SRC_LHR)
  49
  50 #define PIM_UPSTREAM_FLAG_SET_DR_JOIN_DESIRED(flags) ((flags) |= PIM_UPSTREAM_FLAG_MASK_DR_JOIN_DESIRED)
  51 #define PIM_UPSTREAM_FLAG_SET_DR_JOIN_DESIRED_UPDATED(flags) ((flags) |= PIM_UPSTREAM_FLAG_MASK_DR_JOIN_DESIRED_UPDATED)
  52 #define PIM_UPSTREAM_FLAG_SET_FHR(flags) ((flags) |= PIM_UPSTREAM_FLAG_MASK_FHR)
  53 #define PIM_UPSTREAM_FLAG_SET_SRC_IGMP(flags) ((flags) |= PIM_UPSTREAM_FLAG_MASK_SRC_IGMP)
  54 #define PIM_UPSTREAM_FLAG_SET_SRC_PIM(flags) ((flags) |= PIM_UPSTREAM_FLAG_MASK_SRC_PIM)
  55 #define PIM_UPSTREAM_FLAG_SET_SRC_STREAM(flags) ((flags) |= PIM_UPSTREAM_FLAG_MASK_SRC_STREAM)
  56 #define PIM_UPSTREAM_FLAG_SET_SRC_MSDP(flags) ((flags) |= PIM_UPSTREAM_FLAG_MASK_SRC_MSDP)
  57 #define PIM_UPSTREAM_FLAG_SET_SEND_SG_RPT_PRUNE(flags) ((flags) |= PIM_UPSTREAM_FLAG_MASK_SEND_SG_RPT_PRUNE)
  58 #define PIM_UPSTREAM_FLAG_SET_SRC_LHR(flags) ((flags) |= PIM_UPSTREAM_FLAG_MASK_SRC_LHR)
  59
  60 #define PIM_UPSTREAM_FLAG_UNSET_DR_JOIN_DESIRED(flags) ((flags) &= ~PIM_UPSTREAM_FLAG_MASK_DR_JOIN_DESIRED)
  61 #define PIM_UPSTREAM_FLAG_UNSET_DR_JOIN_DESIRED_UPDATED(flags) ((flags) &= ~PIM_UPSTREAM_FLAG_MASK_DR_JOIN_DESIRED_UPDATED)
  62 #define PIM_UPSTREAM_FLAG_UNSET_FHR(flags) ((flags) &= ~PIM_UPSTREAM_FLAG_MASK_FHR)
  63 #define PIM_UPSTREAM_FLAG_UNSET_SRC_IGMP(flags) ((flags) &= ~PIM_UPSTREAM_FLAG_MASK_SRC_IGMP)
  64 #define PIM_UPSTREAM_FLAG_UNSET_SRC_PIM(flags) ((flags) &= ~PIM_UPSTREAM_FLAG_MASK_SRC_PIM)
  65 #define PIM_UPSTREAM_FLAG_UNSET_SRC_STREAM(flags) ((flags) &= ~PIM_UPSTREAM_FLAG_MASK_SRC_STREAM)
  66 #define PIM_UPSTREAM_FLAG_UNSET_SRC_MSDP(flags) ((flags) &= ~PIM_UPSTREAM_FLAG_MASK_SRC_MSDP)
  67 #define PIM_UPSTREAM_FLAG_UNSET_SEND_SG_RPT_PRUNE(flags) ((flags) &= ~PIM_UPSTREAM_FLAG_MASK_SEND_SG_RPT_PRUNE)
  68 #define PIM_UPSTREAM_FLAG_UNSET_SRC_LHR(flags) ((flags) &= ~PIM_UPSTREAM_FLAG_MASK_SRC_LHR)
  69
  70 enum pim_upstream_state {
  71   PIM_UPSTREAM_NOTJOINED,
  72   PIM_UPSTREAM_JOINED,
  73 };
  74
  75 enum pim_reg_state {
  76   PIM_REG_NOINFO,
  77   PIM_REG_JOIN,
  78   PIM_REG_JOIN_PENDING,
  79   PIM_REG_PRUNE,
  80 };
  81
  82 enum pim_upstream_sptbit {
  83   PIM_UPSTREAM_SPTBIT_FALSE,
  84   PIM_UPSTREAM_SPTBIT_TRUE
  85 };
  86
  87 /*
  88   Upstream (S,G) channel in Joined state
  89
  90   (S,G) in the "Not Joined" state is not represented
  91
  92   See RFC 4601: 4.5.7.  Sending (S,G) Join/Prune Message
  93 */
  94 struct pim_upstream {
  95   struct pim_upstream      *parent;
  96   struct in_addr           upstream_addr;/* Who we are talking to */
  97   struct in_addr           upstream_register; /*Who we received a register from*/
  98   struct prefix_sg         sg;           /* (S,G) group key */
  99   char                     sg_str[PIM_SG_LEN];
 100   uint32_t                 flags;
 101   struct channel_oil      *channel_oil;
 102   struct list             *sources;
 103   struct list             *ifchannels;
 104
 105   enum pim_upstream_state  join_state;
 106   enum pim_reg_state       reg_state;
 107   enum pim_upstream_sptbit sptbit;
 108
 109   int                      ref_count;
 110
 111   struct pim_rpf           rpf;
 112
 113   struct thread           *t_join_timer;
 114
 115   /*
 116    * RST(S,G)
 117    */
 118   struct thread           *t_rs_timer;
 119 #define PIM_REGISTER_SUPPRESSION_PERIOD (60)
 120 #define PIM_REGISTER_PROBE_PERIOD       (15)
 121
 122   /*
 123    * KAT(S,G)
 124    */
 125   struct thread           *t_ka_timer;
 126 #define PIM_KEEPALIVE_PERIOD  (210)
 127 #define PIM_RP_KEEPALIVE_PERIOD ( 3 * qpim_register_suppress_time + qpim_register_probe_time )
 128
 129   /* on the RP we restart a timer to indicate if registers are being rxed for
 130    * SG. This is needed by MSDP to determine its local SA cache */
 131   struct thread           *t_msdp_reg_timer;
 132 #define PIM_MSDP_REG_RXED_PERIOD (3 * (1.5 * qpim_register_suppress_time))
 133
 134   int64_t                  state_transition; /* Record current state uptime */
 135 };
 136
 137 struct list *pim_upstream_list;
 138 struct hash *pim_upstream_hash;
 139
 140 void pim_upstream_free(struct pim_upstream *up);
 141 struct pim_upstream *pim_upstream_find (struct prefix_sg *sg);
 142 struct pim_upstream *pim_upstream_find_or_add (struct prefix_sg *sg,
 143                                                struct interface *ifp, int flags,
 144                                                const char *name);
 145 struct pim_upstream *pim_upstream_add (struct prefix_sg *sg,
 146                                        struct interface *ifp, int flags,
 147                                        const char *name);
 148 void pim_upstream_ref (struct pim_upstream *up, int flags);
 149 struct pim_upstream *pim_upstream_del(struct pim_upstream *up, const char *name);
 150
 151 int pim_upstream_evaluate_join_desired(struct pim_upstream *up);
 152 int pim_upstream_evaluate_join_desired_interface(struct pim_upstream *up,
 153                                                  struct pim_ifchannel *ch,
 154                                                  struct pim_ifchannel *starch);
 155 void pim_upstream_update_join_desired(struct pim_upstream *up);
 156
 157 void pim_upstream_join_suppress(struct pim_upstream *up,
 158                                 struct in_addr rpf_addr,
 159                                 int holdtime);
 160
 161 void pim_upstream_join_timer_decrease_to_t_override(const char *debug_label,
 162                                                     struct pim_upstream *up);
 163
 164 void pim_upstream_join_timer_restart(struct pim_upstream *up, struct pim_rpf *old);
 165 void pim_upstream_rpf_genid_changed(struct in_addr neigh_addr);
 166 void pim_upstream_rpf_interface_changed(struct pim_upstream *up,
 167                                         struct interface *old_rpf_ifp);
 168
 169 void pim_upstream_update_could_assert(struct pim_upstream *up);
 170 void pim_upstream_update_my_assert_metric(struct pim_upstream *up);
 171
 172 void pim_upstream_keep_alive_timer_start (struct pim_upstream *up, uint32_t time);
 173
 174 int pim_upstream_switch_to_spt_desired (struct prefix_sg *sg);
 175 #define SwitchToSptDesired(sg) pim_upstream_switch_to_spt_desired (sg)
 176 int pim_upstream_is_sg_rpt (struct pim_upstream *up);
 177
 178 void pim_upstream_set_sptbit (struct pim_upstream *up, struct interface *incoming);
 179
 180 void pim_upstream_start_register_stop_timer (struct pim_upstream *up, int null_register);
 181
 182 void pim_upstream_send_join (struct pim_upstream *up);
 183
 184 void pim_upstream_switch (struct pim_upstream *up, enum pim_upstream_state new_state);
 185
 186 const char *pim_upstream_state2str (enum pim_upstream_state join_state);
 187 #define PIM_REG_STATE_STR_LEN 12
 188 const char *pim_reg_state2str (enum pim_reg_state state, char *state_str);
 189
 190 int pim_upstream_inherited_olist_decide (struct pim_upstream *up);
 191 int pim_upstream_inherited_olist (struct pim_upstream *up);
 192 int pim_upstream_empty_inherited_olist (struct pim_upstream *up);
 193
 194 void pim_upstream_find_new_rpf (void);
 195 void pim_upstream_msdp_reg_timer_start(struct pim_upstream *up);
 196
 197 void pim_upstream_init (void);
 198 void pim_upstream_terminate (void);
 199
 200 void join_timer_start (struct pim_upstream *up);
 201 int pim_upstream_compare (void *arg1, void *arg2);
 202 void pim_upstream_register_reevaluate (void);
 203
 204 void pim_upstream_add_lhr_star_pimreg (void);
 205 void pim_upstream_remove_lhr_star_pimreg (const char *nlist);
 206
 207 void pim_upstream_spt_prefix_list_update (struct prefix_list *pl);
 208 #endif /* PIM_UPSTREAM_H */