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
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,
30 #include "pim_upstream.h"
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)
37 #define PIM_IF_IS_DELETED(ifp) ((ifp)->ifindex == IFINDEX_INTERNAL)
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))
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)
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)
54 #define PIM_I_am_DR(pim_ifp) (pim_ifp)->pim_dr_addr.s_addr == (pim_ifp)->primary_address.s_addr
56 enum pim_interface_type
{
61 enum pim_secondary_addr_flags
{
62 PIM_SEC_ADDRF_NONE
= 0,
63 PIM_SEC_ADDRF_STALE
= (1 << 0)
66 struct pim_secondary_addr
{
68 enum pim_secondary_addr_flags flags
;
71 struct pim_interface
{
72 enum pim_interface_type itype
;
73 uint32_t options
; /* bit vector */
74 ifindex_t mroute_vif_index
;
75 struct in_addr primary_address
; /* remember addr to detect change */
76 struct list
*sec_addr_list
; /* list of struct pim_secondary_addr */
77 struct in_addr update_source
; /* user can statically set the primary
78 * address of the interface */
80 int igmp_version
; /* IGMP version */
81 int igmp_default_robustness_variable
; /* IGMPv3 QRV */
82 int igmp_default_query_interval
; /* IGMPv3 secs between general queries */
83 int igmp_query_max_response_time_dsec
; /* IGMPv3 Max Response Time in dsecs for general queries */
84 int igmp_specific_query_max_response_time_dsec
; /* IGMPv3 Max Response Time in dsecs for specific queries */
85 struct list
*igmp_socket_list
; /* list of struct igmp_sock */
86 struct list
*igmp_join_list
; /* list of struct igmp_join */
88 int pim_sock_fd
; /* PIM socket file descriptor */
89 struct thread
*t_pim_sock_read
; /* thread for reading PIM socket */
90 int64_t pim_sock_creation
; /* timestamp of PIM socket creation */
92 struct thread
*t_pim_hello_timer
;
94 int pim_default_holdtime
;
95 int pim_triggered_hello_delay
;
96 uint32_t pim_generation_id
;
97 uint16_t pim_propagation_delay_msec
; /* config */
98 uint16_t pim_override_interval_msec
; /* config */
99 struct list
*pim_neighbor_list
; /* list of struct pim_neighbor */
100 struct list
*pim_ifchannel_list
; /* list of struct pim_ifchannel */
102 /* neighbors without lan_delay */
103 int pim_number_of_nonlandelay_neighbors
;
104 uint16_t pim_neighbors_highest_propagation_delay_msec
;
105 uint16_t pim_neighbors_highest_override_interval_msec
;
108 int64_t pim_dr_election_last
; /* timestamp */
109 int pim_dr_election_count
;
110 int pim_dr_election_changes
;
111 struct in_addr pim_dr_addr
;
112 uint32_t pim_dr_priority
; /* config */
113 int pim_dr_num_nondrpri_neighbors
; /* neighbors without dr_pri */
115 int64_t pim_ifstat_start
; /* start timestamp for stats */
116 uint32_t pim_ifstat_hello_sent
;
117 uint32_t pim_ifstat_hello_sendfail
;
118 uint32_t pim_ifstat_hello_recv
;
119 uint32_t pim_ifstat_hello_recvfail
;
122 extern struct interface
*pim_regiface
;
123 extern struct list
*pim_ifchannel_list
;
125 if default_holdtime is set (>= 0), use it;
126 otherwise default_holdtime is 3.5 * hello_period
128 #define PIM_IF_DEFAULT_HOLDTIME(pim_ifp) \
129 (((pim_ifp)->pim_default_holdtime < 0) ? \
130 ((pim_ifp)->pim_hello_period * 7 / 2) : \
131 ((pim_ifp)->pim_default_holdtime))
133 void pim_if_init(void);
134 void pim_if_terminate (void);
136 struct pim_interface
*pim_if_new(struct interface
*ifp
, int igmp
, int pim
);
137 void pim_if_delete(struct interface
*ifp
);
138 void pim_if_addr_add(struct connected
*ifc
);
139 void pim_if_addr_del(struct connected
*ifc
, int force_prim_as_any
);
140 void pim_if_addr_add_all(struct interface
*ifp
);
141 void pim_if_addr_del_all(struct interface
*ifp
);
142 void pim_if_addr_del_all_igmp(struct interface
*ifp
);
143 void pim_if_addr_del_all_pim(struct interface
*ifp
);
145 struct interface
*pim_if_lookup_address_vrf (struct in_addr src
, vrf_id_t vrf_id
);
147 int pim_if_add_vif(struct interface
*ifp
);
148 int pim_if_del_vif(struct interface
*ifp
);
149 void pim_if_add_vif_all(void);
150 void pim_if_del_vif_all(void);
152 struct interface
*pim_if_find_by_vif_index(ifindex_t vif_index
);
153 int pim_if_find_vifindex_by_ifindex(ifindex_t ifindex
);
155 int pim_if_lan_delay_enabled(struct interface
*ifp
);
156 uint16_t pim_if_effective_propagation_delay_msec(struct interface
*ifp
);
157 uint16_t pim_if_effective_override_interval_msec(struct interface
*ifp
);
158 uint16_t pim_if_jp_override_interval_msec(struct interface
*ifp
);
159 struct pim_neighbor
*pim_if_find_neighbor(struct interface
*ifp
,
160 struct in_addr addr
);
162 long pim_if_t_suppressed_msec(struct interface
*ifp
);
163 int pim_if_t_override_msec(struct interface
*ifp
);
165 struct in_addr
pim_find_primary_addr(struct interface
*ifp
);
167 int pim_if_igmp_join_add(struct interface
*ifp
,
168 struct in_addr group_addr
,
169 struct in_addr source_addr
);
170 int pim_if_igmp_join_del(struct interface
*ifp
,
171 struct in_addr group_addr
,
172 struct in_addr source_addr
);
174 void pim_if_update_could_assert(struct interface
*ifp
);
176 void pim_if_assert_on_neighbor_down(struct interface
*ifp
,
177 struct in_addr neigh_addr
);
179 void pim_if_rpf_interface_changed(struct interface
*old_rpf_ifp
,
180 struct pim_upstream
*up
);
182 void pim_if_update_join_desired(struct pim_interface
*pim_ifp
);
184 void pim_if_update_assert_tracking_desired(struct interface
*ifp
);
186 void pim_if_create_pimreg(void);
188 int pim_if_connected_to_source (struct interface
*ifp
, struct in_addr src
);
189 int pim_update_source_set(struct interface
*ifp
, struct in_addr source
);
191 #endif /* PIM_IFACE_H */