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