pimd/pim_iface.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_IFACE_H
  22 #define PIM_IFACE_H
  23
  24 #include <zebra.h>
  25
  26 #include "if.h"
  27 #include "vty.h"
  28
  29 #include "pim_igmp.h"
  30 #include "pim_upstream.h"
  31
  32 #define PIM_IF_MASK_PIM                             (1 << 0)
  33 #define PIM_IF_MASK_IGMP                            (1 << 1)
  34 #define PIM_IF_MASK_IGMP_LISTEN_ALLROUTERS          (1 << 2)
  35 #define PIM_IF_MASK_PIM_CAN_DISABLE_JOIN_SUPRESSION (1 << 3)
  36
  37 #define PIM_IF_IS_DELETED(ifp) ((ifp)->ifindex == IFINDEX_INTERNAL)
  38
  39 #define PIM_IF_TEST_PIM(options) (PIM_IF_MASK_PIM & (options))
  40 #define PIM_IF_TEST_IGMP(options) (PIM_IF_MASK_IGMP & (options))
  41 #define PIM_IF_TEST_IGMP_LISTEN_ALLROUTERS(options) (PIM_IF_MASK_IGMP_LISTEN_ALLROUTERS & (options))
  42 #define PIM_IF_TEST_PIM_CAN_DISABLE_JOIN_SUPRESSION(options) (PIM_IF_MASK_PIM_CAN_DISABLE_JOIN_SUPRESSION & (options))
  43
  44 #define PIM_IF_DO_PIM(options) ((options) |= PIM_IF_MASK_PIM)
  45 #define PIM_IF_DO_IGMP(options) ((options) |= PIM_IF_MASK_IGMP)
  46 #define PIM_IF_DO_IGMP_LISTEN_ALLROUTERS(options) ((options) |= PIM_IF_MASK_IGMP_LISTEN_ALLROUTERS)
  47 #define PIM_IF_DO_PIM_CAN_DISABLE_JOIN_SUPRESSION(options) ((options) |= PIM_IF_MASK_PIM_CAN_DISABLE_JOIN_SUPRESSION)
  48
  49 #define PIM_IF_DONT_PIM(options) ((options) &= ~PIM_IF_MASK_PIM)
  50 #define PIM_IF_DONT_IGMP(options) ((options) &= ~PIM_IF_MASK_IGMP)
  51 #define PIM_IF_DONT_IGMP_LISTEN_ALLROUTERS(options) ((options) &= ~PIM_IF_MASK_IGMP_LISTEN_ALLROUTERS)
  52 #define PIM_IF_DONT_PIM_CAN_DISABLE_JOIN_SUPRESSION(options) ((options) &= ~PIM_IF_MASK_PIM_CAN_DISABLE_JOIN_SUPRESSION)
  53
  54 #define PIM_I_am_DR(pim_ifp) (pim_ifp)->pim_dr_addr.s_addr == (pim_ifp)->primary_address.s_addr
  55
  56 struct pim_iface_upstream_switch {
  57         struct in_addr address;
  58         struct list *us;
  59 };
  60
  61 enum pim_secondary_addr_flags {
  62         PIM_SEC_ADDRF_NONE = 0,
  63         PIM_SEC_ADDRF_STALE = (1 << 0)
  64 };
  65
  66 struct pim_secondary_addr {
  67         struct in_addr addr;
  68         enum pim_secondary_addr_flags flags;
  69 };
  70
  71 struct pim_interface {
  72         uint32_t options; /* bit vector */
  73         ifindex_t mroute_vif_index;
  74         struct in_addr primary_address; /* remember addr to detect change */
  75         struct list *sec_addr_list;     /* list of struct pim_secondary_addr */
  76         struct in_addr update_source;   /* user can statically set the primary
  77                                          * address of the interface */
  78
  79         int igmp_version;                     /* IGMP version */
  80         int igmp_default_robustness_variable; /* IGMPv3 QRV */
  81         int
  82                 igmp_default_query_interval;   /* IGMPv3 secs between general
  83                                                   queries */
  84         int igmp_query_max_response_time_dsec; /* IGMPv3 Max Response Time in
  85                                                   dsecs for general queries */
  86         int igmp_specific_query_max_response_time_dsec; /* IGMPv3 Max Response
  87                                                            Time in dsecs for
  88                                                            specific queries */
  89         struct list *igmp_socket_list; /* list of struct igmp_sock */
  90         struct list *igmp_join_list;   /* list of struct igmp_join */
  91
  92         int pim_sock_fd;                /* PIM socket file descriptor */
  93         struct thread *t_pim_sock_read; /* thread for reading PIM socket */
  94         int64_t pim_sock_creation;      /* timestamp of PIM socket creation */
  95
  96         struct thread *t_pim_hello_timer;
  97         int pim_hello_period;
  98         int pim_default_holdtime;
  99         int pim_triggered_hello_delay;
 100         uint32_t pim_generation_id;
 101         uint16_t pim_propagation_delay_msec; /* config */
 102         uint16_t pim_override_interval_msec; /* config */
 103         struct list *pim_neighbor_list;      /* list of struct pim_neighbor */
 104         struct list *upstream_switch_list;
 105         struct list *pim_ifchannel_list; /* list of struct pim_ifchannel */
 106         struct hash *pim_ifchannel_hash;
 107
 108         /* neighbors without lan_delay */
 109         int pim_number_of_nonlandelay_neighbors;
 110         uint16_t pim_neighbors_highest_propagation_delay_msec;
 111         uint16_t pim_neighbors_highest_override_interval_msec;
 112
 113         /* DR Election */
 114         int64_t pim_dr_election_last; /* timestamp */
 115         int pim_dr_election_count;
 116         int pim_dr_election_changes;
 117         struct in_addr pim_dr_addr;
 118         uint32_t pim_dr_priority;         /* config */
 119         int pim_dr_num_nondrpri_neighbors; /* neighbors without dr_pri */
 120
 121         int64_t pim_ifstat_start; /* start timestamp for stats */
 122         uint32_t pim_ifstat_hello_sent;
 123         uint32_t pim_ifstat_hello_sendfail;
 124         uint32_t pim_ifstat_hello_recv;
 125         uint32_t pim_ifstat_hello_recvfail;
 126 };
 127
 128 extern struct interface *pim_regiface;
 129 extern struct list *pim_ifchannel_list;
 130 /*
 131   if default_holdtime is set (>= 0), use it;
 132   otherwise default_holdtime is 3.5 * hello_period
 133  */
 134 #define PIM_IF_DEFAULT_HOLDTIME(pim_ifp)                                       \
 135         (((pim_ifp)->pim_default_holdtime < 0)                                 \
 136                  ? ((pim_ifp)->pim_hello_period * 7 / 2)                       \
 137                  : ((pim_ifp)->pim_default_holdtime))
 138
 139 void pim_if_init(void);
 140 void pim_if_terminate(void);
 141
 142 struct pim_interface *pim_if_new(struct interface *ifp, int igmp, int pim);
 143 void pim_if_delete(struct interface *ifp);
 144 void pim_if_addr_add(struct connected *ifc);
 145 void pim_if_addr_del(struct connected *ifc, int force_prim_as_any);
 146 void pim_if_addr_add_all(struct interface *ifp);
 147 void pim_if_addr_del_all(struct interface *ifp);
 148 void pim_if_addr_del_all_igmp(struct interface *ifp);
 149 void pim_if_addr_del_all_pim(struct interface *ifp);
 150
 151 struct interface *pim_if_lookup_address_vrf(struct in_addr src,
 152                                             vrf_id_t vrf_id);
 153
 154 int pim_if_add_vif(struct interface *ifp);
 155 int pim_if_del_vif(struct interface *ifp);
 156 void pim_if_add_vif_all(void);
 157 void pim_if_del_vif_all(void);
 158
 159 struct interface *pim_if_find_by_vif_index(ifindex_t vif_index);
 160 int pim_if_find_vifindex_by_ifindex(ifindex_t ifindex);
 161
 162 int pim_if_lan_delay_enabled(struct interface *ifp);
 163 uint16_t pim_if_effective_propagation_delay_msec(struct interface *ifp);
 164 uint16_t pim_if_effective_override_interval_msec(struct interface *ifp);
 165 uint16_t pim_if_jp_override_interval_msec(struct interface *ifp);
 166 struct pim_neighbor *pim_if_find_neighbor(struct interface *ifp,
 167                                           struct in_addr addr);
 168
 169 long pim_if_t_suppressed_msec(struct interface *ifp);
 170 int pim_if_t_override_msec(struct interface *ifp);
 171
 172 struct in_addr pim_find_primary_addr(struct interface *ifp);
 173
 174 int pim_if_igmp_join_add(struct interface *ifp, struct in_addr group_addr,
 175                          struct in_addr source_addr);
 176 int pim_if_igmp_join_del(struct interface *ifp, struct in_addr group_addr,
 177                          struct in_addr source_addr);
 178
 179 void pim_if_update_could_assert(struct interface *ifp);
 180
 181 void pim_if_assert_on_neighbor_down(struct interface *ifp,
 182                                     struct in_addr neigh_addr);
 183
 184 void pim_if_rpf_interface_changed(struct interface *old_rpf_ifp,
 185                                   struct pim_upstream *up);
 186
 187 void pim_if_update_join_desired(struct pim_interface *pim_ifp);
 188
 189 void pim_if_update_assert_tracking_desired(struct interface *ifp);
 190
 191 void pim_if_create_pimreg(void);
 192
 193 int pim_if_connected_to_source(struct interface *ifp, struct in_addr src);
 194 int pim_update_source_set(struct interface *ifp, struct in_addr source);
 195
 196 #endif /* PIM_IFACE_H */