]> git.proxmox.com Git - mirror_frr.git/blame - pimd/pim_iface.h
Merge pull request #5810 from donaldsharp/fix_yang_routemap
[mirror_frr.git] / pimd / pim_iface.h
CommitLineData
12e41d03 1/*
896014f4
DL
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
83190a40 18 */
12e41d03
DL
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"
ba4eb1bc
CS
27#include "vrf.h"
28#include "zclient.h"
37664928 29#include "ferr.h"
12e41d03
DL
30
31#include "pim_igmp.h"
32#include "pim_upstream.h"
ba4eb1bc 33#include "bfd.h"
12e41d03
DL
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
df696e3f 57#define PIM_I_am_DR(pim_ifp) (pim_ifp)->pim_dr_addr.s_addr == (pim_ifp)->primary_address.s_addr
84366c7e 58
982bff89 59struct pim_iface_upstream_switch {
d62a17ae 60 struct in_addr address;
61 struct list *us;
982bff89
DS
62};
63
7176984f 64enum pim_secondary_addr_flags {
d62a17ae 65 PIM_SEC_ADDRF_NONE = 0,
66 PIM_SEC_ADDRF_STALE = (1 << 0)
7176984f 67};
68
69struct pim_secondary_addr {
d62a17ae 70 struct prefix addr;
71 enum pim_secondary_addr_flags flags;
7176984f 72};
73
12e41d03 74struct pim_interface {
d62a17ae 75 uint32_t options; /* bit vector */
76 ifindex_t mroute_vif_index;
c3bd5a10
DS
77 struct pim_instance *pim;
78
d62a17ae 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
996c9314
LB
84 int igmp_version; /* IGMP version */
85 int igmp_default_robustness_variable; /* IGMPv3 QRV */
86 int igmp_default_query_interval; /* IGMPv3 secs between general
d62a17ae 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
59115451
SP
91 Time in dsecs called
92 as last member query
93 interval, defines the
94 maximum response time
95 advertised in IGMP
96 group-specific
97 queries */
98 int igmp_last_member_query_count; /* IGMP last member query count */
d62a17ae 99 struct list *igmp_socket_list; /* list of struct igmp_sock */
100 struct list *igmp_join_list; /* list of struct igmp_join */
101
102 int pim_sock_fd; /* PIM socket file descriptor */
103 struct thread *t_pim_sock_read; /* thread for reading PIM socket */
104 int64_t pim_sock_creation; /* timestamp of PIM socket creation */
105
106 struct thread *t_pim_hello_timer;
107 int pim_hello_period;
108 int pim_default_holdtime;
109 int pim_triggered_hello_delay;
110 uint32_t pim_generation_id;
111 uint16_t pim_propagation_delay_msec; /* config */
112 uint16_t pim_override_interval_msec; /* config */
113 struct list *pim_neighbor_list; /* list of struct pim_neighbor */
114 struct list *upstream_switch_list;
ad7b74c4 115 struct pim_ifchannel_rb ifchannel_rb;
d62a17ae 116
117 /* neighbors without lan_delay */
118 int pim_number_of_nonlandelay_neighbors;
119 uint16_t pim_neighbors_highest_propagation_delay_msec;
120 uint16_t pim_neighbors_highest_override_interval_msec;
121
122 /* DR Election */
123 int64_t pim_dr_election_last; /* timestamp */
124 int pim_dr_election_count;
125 int pim_dr_election_changes;
126 struct in_addr pim_dr_addr;
127 uint32_t pim_dr_priority; /* config */
128 int pim_dr_num_nondrpri_neighbors; /* neighbors without dr_pri */
129
b0f525a8
QY
130 /* boundary prefix-list */
131 char *boundary_oil_plist;
132
414d885a
DS
133 /* Turn on Active-Active for this interface */
134 bool activeactive;
135
d62a17ae 136 int64_t pim_ifstat_start; /* start timestamp for stats */
8a4dfb5d 137 uint64_t pim_ifstat_bsm_rx;
138 uint64_t pim_ifstat_bsm_tx;
d62a17ae 139 uint32_t pim_ifstat_hello_sent;
140 uint32_t pim_ifstat_hello_sendfail;
141 uint32_t pim_ifstat_hello_recv;
142 uint32_t pim_ifstat_hello_recvfail;
143 uint32_t pim_ifstat_join_recv;
144 uint32_t pim_ifstat_join_send;
145 uint32_t pim_ifstat_prune_recv;
146 uint32_t pim_ifstat_prune_send;
147 uint32_t pim_ifstat_reg_recv;
148 uint32_t pim_ifstat_reg_send;
149 uint32_t pim_ifstat_reg_stop_recv;
150 uint32_t pim_ifstat_reg_stop_send;
151 uint32_t pim_ifstat_assert_recv;
152 uint32_t pim_ifstat_assert_send;
8a4dfb5d 153 uint32_t pim_ifstat_bsm_cfg_miss;
154 uint32_t pim_ifstat_ucast_bsm_cfg_miss;
155 uint32_t pim_ifstat_bsm_invalid_sz;
d62a17ae 156 struct bfd_info *bfd_info;
8a4dfb5d 157 bool bsm_enable; /* bsm processing enable */
158 bool ucast_bsm_accept; /* ucast bsm processing */
12e41d03
DL
159};
160
161/*
162 if default_holdtime is set (>= 0), use it;
163 otherwise default_holdtime is 3.5 * hello_period
164 */
d62a17ae 165#define PIM_IF_DEFAULT_HOLDTIME(pim_ifp) \
166 (((pim_ifp)->pim_default_holdtime < 0) \
167 ? ((pim_ifp)->pim_hello_period * 7 / 2) \
168 : ((pim_ifp)->pim_default_holdtime))
12e41d03 169
f88df3a6
DS
170void pim_if_init(struct pim_instance *pim);
171void pim_if_terminate(struct pim_instance *pim);
12e41d03 172
85a13586 173struct pim_interface *pim_if_new(struct interface *ifp, bool igmp, bool pim,
b1891fa0 174 bool ispimreg, bool is_vxlan_term);
d62a17ae 175void pim_if_delete(struct interface *ifp);
12e41d03
DL
176void pim_if_addr_add(struct connected *ifc);
177void pim_if_addr_del(struct connected *ifc, int force_prim_as_any);
178void pim_if_addr_add_all(struct interface *ifp);
179void pim_if_addr_del_all(struct interface *ifp);
180void pim_if_addr_del_all_igmp(struct interface *ifp);
181void pim_if_addr_del_all_pim(struct interface *ifp);
182
b1891fa0 183int pim_if_add_vif(struct interface *ifp, bool ispimreg, bool is_vxlan_term);
12e41d03 184int pim_if_del_vif(struct interface *ifp);
f88df3a6
DS
185void pim_if_add_vif_all(struct pim_instance *pim);
186void pim_if_del_vif_all(struct pim_instance *pim);
12e41d03 187
7cfc7bcf
DS
188struct interface *pim_if_find_by_vif_index(struct pim_instance *pim,
189 ifindex_t vif_index);
190int pim_if_find_vifindex_by_ifindex(struct pim_instance *pim,
191 ifindex_t ifindex);
12e41d03
DL
192
193int pim_if_lan_delay_enabled(struct interface *ifp);
194uint16_t pim_if_effective_propagation_delay_msec(struct interface *ifp);
195uint16_t pim_if_effective_override_interval_msec(struct interface *ifp);
196uint16_t pim_if_jp_override_interval_msec(struct interface *ifp);
197struct pim_neighbor *pim_if_find_neighbor(struct interface *ifp,
198 struct in_addr addr);
199
200long pim_if_t_suppressed_msec(struct interface *ifp);
201int pim_if_t_override_msec(struct interface *ifp);
202
203struct in_addr pim_find_primary_addr(struct interface *ifp);
204
37664928
DS
205ferr_r pim_if_igmp_join_add(struct interface *ifp, struct in_addr group_addr,
206 struct in_addr source_addr);
d62a17ae 207int pim_if_igmp_join_del(struct interface *ifp, struct in_addr group_addr,
12e41d03
DL
208 struct in_addr source_addr);
209
210void pim_if_update_could_assert(struct interface *ifp);
211
212void pim_if_assert_on_neighbor_down(struct interface *ifp,
213 struct in_addr neigh_addr);
214
215void pim_if_rpf_interface_changed(struct interface *old_rpf_ifp,
216 struct pim_upstream *up);
217
218void pim_if_update_join_desired(struct pim_interface *pim_ifp);
219
220void pim_if_update_assert_tracking_desired(struct interface *ifp);
221
43e40fdf 222void pim_if_create_pimreg(struct pim_instance *pim);
3565202d 223
d62a17ae 224int pim_if_connected_to_source(struct interface *ifp, struct in_addr src);
4763cd0e 225int pim_update_source_set(struct interface *ifp, struct in_addr source);
3fdfd943 226
e55a43d4 227bool pim_if_is_vrf_device(struct interface *ifp);
ad7b74c4
DS
228
229int pim_if_ifchannel_count(struct pim_interface *pim_ifp);
138c5a74
DS
230
231extern int pim_ifp_create(struct interface *ifp);
232extern int pim_ifp_up(struct interface *ifp);
233extern int pim_ifp_down(struct interface *ifp);
234extern int pim_ifp_destroy(struct interface *ifp);
235
12e41d03 236#endif /* PIM_IFACE_H */