pimd/pim_ifchannel.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_IFCHANNEL_H
  22 #define PIM_IFCHANNEL_H
  23
  24 #include <zebra.h>
  25
  26 #include "if.h"
  27 #include "prefix.h"
  28
  29 struct pim_ifchannel;
  30 #include "pim_upstream.h"
  31
  32 enum pim_ifmembership { PIM_IFMEMBERSHIP_NOINFO, PIM_IFMEMBERSHIP_INCLUDE };
  33
  34 enum pim_ifjoin_state {
  35         PIM_IFJOIN_NOINFO,
  36         PIM_IFJOIN_JOIN,
  37         PIM_IFJOIN_PRUNE,
  38         PIM_IFJOIN_PRUNE_PENDING,
  39         PIM_IFJOIN_PRUNE_TMP,
  40         PIM_IFJOIN_PRUNE_PENDING_TMP,
  41 };
  42
  43 enum pim_ifassert_state {
  44         PIM_IFASSERT_NOINFO,
  45         PIM_IFASSERT_I_AM_WINNER,
  46         PIM_IFASSERT_I_AM_LOSER
  47 };
  48
  49 struct pim_assert_metric {
  50         uint32_t rpt_bit_flag;
  51         uint32_t metric_preference;
  52         uint32_t route_metric;
  53         struct in_addr ip_address; /* neighbor router that sourced the Assert
  54                                       message */
  55 };
  56
  57 /*
  58   Flag to detect change in CouldAssert(S,G,I)
  59 */
  60 #define PIM_IF_FLAG_MASK_COULD_ASSERT (1 << 0)
  61 #define PIM_IF_FLAG_TEST_COULD_ASSERT(flags) ((flags) & PIM_IF_FLAG_MASK_COULD_ASSERT)
  62 #define PIM_IF_FLAG_SET_COULD_ASSERT(flags) ((flags) |= PIM_IF_FLAG_MASK_COULD_ASSERT)
  63 #define PIM_IF_FLAG_UNSET_COULD_ASSERT(flags) ((flags) &= ~PIM_IF_FLAG_MASK_COULD_ASSERT)
  64 /*
  65   Flag to detect change in AssertTrackingDesired(S,G,I)
  66 */
  67 #define PIM_IF_FLAG_MASK_ASSERT_TRACKING_DESIRED (1 << 1)
  68 #define PIM_IF_FLAG_TEST_ASSERT_TRACKING_DESIRED(flags) ((flags) & PIM_IF_FLAG_MASK_ASSERT_TRACKING_DESIRED)
  69 #define PIM_IF_FLAG_SET_ASSERT_TRACKING_DESIRED(flags) ((flags) |= PIM_IF_FLAG_MASK_ASSERT_TRACKING_DESIRED)
  70 #define PIM_IF_FLAG_UNSET_ASSERT_TRACKING_DESIRED(flags) ((flags) &= ~PIM_IF_FLAG_MASK_ASSERT_TRACKING_DESIRED)
  71
  72 /*
  73  * Flat to tell us if the ifchannel is (S,G,rpt)
  74  */
  75 #define PIM_IF_FLAG_MASK_S_G_RPT         (1 << 2)
  76 #define PIM_IF_FLAG_TEST_S_G_RPT(flags)  ((flags) & PIM_IF_FLAG_MASK_S_G_RPT)
  77 #define PIM_IF_FLAG_SET_S_G_RPT(flags)   ((flags) |= PIM_IF_FLAG_MASK_S_G_RPT)
  78 #define PIM_IF_FLAG_UNSET_S_G_RPT(flags) ((flags) &= ~PIM_IF_FLAG_MASK_S_G_RPT)
  79
  80 /*
  81   Per-interface (S,G) state
  82 */
  83 struct pim_ifchannel {
  84         struct pim_ifchannel *parent;
  85         struct list *sources;
  86         struct prefix_sg sg;
  87         char sg_str[PIM_SG_LEN];
  88         struct interface *interface; /* backpointer to interface */
  89         uint32_t flags;
  90
  91         /* IGMPv3 determined interface has local members for (S,G) ? */
  92         enum pim_ifmembership local_ifmembership;
  93
  94         /* Per-interface (S,G) Join/Prune State (Section 4.1.4 of RFC4601) */
  95         enum pim_ifjoin_state ifjoin_state;
  96         struct thread *t_ifjoin_expiry_timer;
  97         struct thread *t_ifjoin_prune_pending_timer;
  98         int64_t ifjoin_creation; /* Record uptime of ifjoin state */
  99
 100         /* Per-interface (S,G) Assert State (Section 4.6.1 of RFC4601) */
 101         enum pim_ifassert_state ifassert_state;
 102         struct thread *t_ifassert_timer;
 103         struct in_addr ifassert_winner;
 104         struct pim_assert_metric ifassert_winner_metric;
 105         int64_t ifassert_creation; /* Record uptime of ifassert state */
 106         struct pim_assert_metric ifassert_my_metric;
 107
 108         /* Upstream (S,G) state */
 109         struct pim_upstream *upstream;
 110 };
 111
 112 void pim_ifchannel_free(struct pim_ifchannel *ch);
 113 void pim_ifchannel_delete(struct pim_ifchannel *ch);
 114 void pim_ifchannel_delete_all(struct interface *ifp);
 115 void pim_ifchannel_membership_clear(struct interface *ifp);
 116 void pim_ifchannel_delete_on_noinfo(struct interface *ifp);
 117 struct pim_ifchannel *pim_ifchannel_find(struct interface *ifp,
 118                                          struct prefix_sg *sg);
 119 struct pim_ifchannel *pim_ifchannel_add(struct interface *ifp,
 120                                         struct prefix_sg *sg, int flags);
 121 void pim_ifchannel_join_add(struct interface *ifp, struct in_addr neigh_addr,
 122                             struct in_addr upstream, struct prefix_sg *sg,
 123                             uint8_t source_flags, uint16_t holdtime);
 124 void pim_ifchannel_prune(struct interface *ifp, struct in_addr upstream,
 125                          struct prefix_sg *sg, uint8_t source_flags,
 126                          uint16_t holdtime);
 127 int pim_ifchannel_local_membership_add(struct interface *ifp,
 128                                        struct prefix_sg *sg);
 129 void pim_ifchannel_local_membership_del(struct interface *ifp,
 130                                         struct prefix_sg *sg);
 131
 132 void pim_ifchannel_ifjoin_switch(const char *caller, struct pim_ifchannel *ch,
 133                                  enum pim_ifjoin_state new_state);
 134 const char *pim_ifchannel_ifjoin_name(enum pim_ifjoin_state ifjoin_state,
 135                                       int flags);
 136 const char *pim_ifchannel_ifassert_name(enum pim_ifassert_state ifassert_state);
 137
 138 int pim_ifchannel_isin_oiflist(struct pim_ifchannel *ch);
 139
 140 void reset_ifassert_state(struct pim_ifchannel *ch);
 141
 142 void pim_ifchannel_update_could_assert(struct pim_ifchannel *ch);
 143 void pim_ifchannel_update_my_assert_metric(struct pim_ifchannel *ch);
 144 void pim_ifchannel_update_assert_tracking_desired(struct pim_ifchannel *ch);
 145
 146 void pim_ifchannel_scan_forward_start(struct interface *new_ifp);
 147 void pim_ifchannel_set_star_g_join_state(struct pim_ifchannel *ch, int eom,
 148                                          uint8_t source_flags, uint8_t join,
 149                                          uint8_t starg_alone);
 150
 151 int pim_ifchannel_compare(struct pim_ifchannel *ch1, struct pim_ifchannel *ch2);
 152
 153 unsigned int pim_ifchannel_hash_key(void *arg);
 154 int pim_ifchannel_equal(const void *arg1, const void *arg2);
 155 #endif /* PIM_IFCHANNEL_H */