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