[mirror_frr.git] / pimd / pim_iface.h

/*
 * PIM for Quagga
 * Copyright (C) 2008  Everton da Silva Marques
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program; see the file COPYING; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
 */

#ifndef PIM_IFACE_H
#define PIM_IFACE_H

#include <zebra.h>

#include "if.h"
#include "vty.h"
#include "vrf.h"
#include "zclient.h"
#include "ferr.h"

#include "pim_igmp.h"
#include "pim_upstream.h"
#include "bfd.h"
#include "pim_str.h"

#define PIM_IF_IS_DELETED(ifp) ((ifp)->ifindex == IFINDEX_INTERNAL)

#define PIM_I_am_DR(pim_ifp)                                                   \
	!pim_addr_cmp((pim_ifp)->pim_dr_addr, (pim_ifp)->primary_address)
#define PIM_I_am_DualActive(pim_ifp) (pim_ifp)->activeactive == true

/* Macros for interface flags */

/*
 * PIM needs to know if hello is required to send before other PIM messages
 * like Join, prune, assert would go out
 */
#define PIM_IF_FLAG_HELLO_SENT (1 << 0)

#define PIM_IF_FLAG_TEST_HELLO_SENT(flags) ((flags)&PIM_IF_FLAG_HELLO_SENT)

#define PIM_IF_FLAG_SET_HELLO_SENT(flags) ((flags) |= PIM_IF_FLAG_HELLO_SENT)

#define PIM_IF_FLAG_UNSET_HELLO_SENT(flags) ((flags) &= ~PIM_IF_FLAG_HELLO_SENT)

struct pim_iface_upstream_switch {
	pim_addr address;
	struct list *us;
};

enum pim_secondary_addr_flags {
	PIM_SEC_ADDRF_NONE = 0,
	PIM_SEC_ADDRF_STALE = (1 << 0)
};

struct pim_secondary_addr {
	struct prefix addr;
	enum pim_secondary_addr_flags flags;
};

struct gm_if;

struct pim_interface {
	bool pim_enable : 1;
	bool pim_can_disable_join_suppression : 1;
	bool pim_passive_enable : 1;

	bool gm_enable : 1;

	ifindex_t mroute_vif_index;
	struct pim_instance *pim;

#if PIM_IPV == 6
	/* link-locals: MLD uses lowest addr, PIM uses highest... */
	pim_addr ll_lowest;
	pim_addr ll_highest;
#endif

	pim_addr primary_address;       /* remember addr to detect change */
	struct list *sec_addr_list;     /* list of struct pim_secondary_addr */
	pim_addr update_source;		/* user can statically set the primary
					 * address of the interface */

	int igmp_version;		     /* IGMP version */
	int mld_version;
	int gm_default_robustness_variable;  /* IGMP or MLD QRV */
	int gm_default_query_interval;       /* IGMP or MLD secs between general
						  queries */
	int gm_query_max_response_time_dsec; /* IGMP or MLD Max Response Time in
						  dsecs for general queries */
	int gm_specific_query_max_response_time_dsec; /* IGMP or MLD Max
							 Response Time in dsecs
							 called as last member
							 query interval, defines
							 the maximum response
							 time advertised in IGMP
							 group-specific
							 queries */
	int gm_last_member_query_count;		      /* IGMP or MLD last member
							 query count
						       */
	struct list *gm_socket_list; /* list of struct IGMP or MLD sock */
	struct list *gm_join_list;   /* list of struct IGMP or MLD join */
	struct list *gm_group_list;  /* list of struct IGMP or MLD group */
	struct hash *gm_group_hash;

	struct gm_if *mld;

	int pim_sock_fd;		/* PIM socket file descriptor */
	struct thread *t_pim_sock_read; /* thread for reading PIM socket */
	int64_t pim_sock_creation;      /* timestamp of PIM socket creation */

	struct thread *t_pim_hello_timer;
	int pim_hello_period;
	int pim_default_holdtime;
	int pim_triggered_hello_delay;
	uint32_t pim_generation_id;
	uint16_t pim_propagation_delay_msec; /* config */
	uint16_t pim_override_interval_msec; /* config */
	struct list *pim_neighbor_list;      /* list of struct pim_neighbor */
	struct list *upstream_switch_list;
	struct pim_ifchannel_rb ifchannel_rb;

	/* neighbors without lan_delay */
	int pim_number_of_nonlandelay_neighbors;
	uint16_t pim_neighbors_highest_propagation_delay_msec;
	uint16_t pim_neighbors_highest_override_interval_msec;

	/* DR Election */
	int64_t pim_dr_election_last; /* timestamp */
	int pim_dr_election_count;
	int pim_dr_election_changes;
	pim_addr pim_dr_addr;
	uint32_t pim_dr_priority;	  /* config */
	int pim_dr_num_nondrpri_neighbors; /* neighbors without dr_pri */

	/* boundary prefix-list */
	char *boundary_oil_plist;

	/* Turn on Active-Active for this interface */
	bool activeactive;
	bool am_i_dr;

	int64_t pim_ifstat_start; /* start timestamp for stats */
	uint64_t pim_ifstat_bsm_rx;
	uint64_t pim_ifstat_bsm_tx;
	uint32_t pim_ifstat_hello_sent;
	uint32_t pim_ifstat_hello_sendfail;
	uint32_t pim_ifstat_hello_recv;
	uint32_t pim_ifstat_hello_recvfail;
	uint32_t pim_ifstat_join_recv;
	uint32_t pim_ifstat_join_send;
	uint32_t pim_ifstat_prune_recv;
	uint32_t pim_ifstat_prune_send;
	uint32_t pim_ifstat_reg_recv;
	uint32_t pim_ifstat_reg_send;
	uint32_t pim_ifstat_reg_stop_recv;
	uint32_t pim_ifstat_reg_stop_send;
	uint32_t pim_ifstat_assert_recv;
	uint32_t pim_ifstat_assert_send;
	uint32_t pim_ifstat_bsm_cfg_miss;
	uint32_t pim_ifstat_ucast_bsm_cfg_miss;
	uint32_t pim_ifstat_bsm_invalid_sz;
	uint8_t flags;
	bool bsm_enable; /* bsm processing enable */
	bool ucast_bsm_accept; /* ucast bsm processing */

	uint32_t igmp_ifstat_joins_sent;
	uint32_t igmp_ifstat_joins_failed;
	uint32_t igmp_peak_group_count;

	struct {
		bool enabled;
		uint32_t min_rx;
		uint32_t min_tx;
		uint8_t detection_multiplier;
		char *profile;
	} bfd_config;
};

/*
 * if default_holdtime is set (>= 0), use it;
 * otherwise default_holdtime is 3.5 * hello_period
 */
#define PIM_IF_DEFAULT_HOLDTIME(pim_ifp)                                       \
	(((pim_ifp)->pim_default_holdtime < 0)                                 \
		 ? ((pim_ifp)->pim_hello_period * 7 / 2)                       \
		 : ((pim_ifp)->pim_default_holdtime))

void pim_if_init(struct pim_instance *pim);
void pim_if_terminate(struct pim_instance *pim);

struct pim_interface *pim_if_new(struct interface *ifp, bool igmp, bool pim,
				 bool ispimreg, bool is_vxlan_term);
void pim_if_delete(struct interface *ifp);
void pim_if_addr_add(struct connected *ifc);
void pim_if_addr_del(struct connected *ifc, int force_prim_as_any);
void pim_if_addr_add_all(struct interface *ifp);
void pim_if_addr_del_all(struct interface *ifp);
void pim_if_addr_del_all_igmp(struct interface *ifp);

int pim_if_add_vif(struct interface *ifp, bool ispimreg, bool is_vxlan_term);
int pim_if_del_vif(struct interface *ifp);
void pim_if_add_vif_all(struct pim_instance *pim);
void pim_if_del_vif_all(struct pim_instance *pim);

struct interface *pim_if_find_by_vif_index(struct pim_instance *pim,
					   ifindex_t vif_index);
int pim_if_find_vifindex_by_ifindex(struct pim_instance *pim,
				    ifindex_t ifindex);

int pim_if_lan_delay_enabled(struct interface *ifp);
uint16_t pim_if_effective_propagation_delay_msec(struct interface *ifp);
uint16_t pim_if_effective_override_interval_msec(struct interface *ifp);
uint16_t pim_if_jp_override_interval_msec(struct interface *ifp);
struct pim_neighbor *pim_if_find_neighbor(struct interface *ifp, pim_addr addr);

long pim_if_t_suppressed_msec(struct interface *ifp);
int pim_if_t_override_msec(struct interface *ifp);

pim_addr pim_find_primary_addr(struct interface *ifp);

ferr_r pim_if_igmp_join_add(struct interface *ifp, struct in_addr group_addr,
			    struct in_addr source_addr);
int pim_if_igmp_join_del(struct interface *ifp, struct in_addr group_addr,
			 struct in_addr source_addr);

void pim_if_update_could_assert(struct interface *ifp);

void pim_if_assert_on_neighbor_down(struct interface *ifp, pim_addr neigh_addr);

void pim_if_rpf_interface_changed(struct interface *old_rpf_ifp,
				  struct pim_upstream *up);

void pim_if_update_join_desired(struct pim_interface *pim_ifp);

void pim_if_update_assert_tracking_desired(struct interface *ifp);

void pim_if_create_pimreg(struct pim_instance *pim);

struct prefix *pim_if_connected_to_source(struct interface *ifp, pim_addr src);
int pim_update_source_set(struct interface *ifp, pim_addr source);

bool pim_if_is_vrf_device(struct interface *ifp);

int pim_if_ifchannel_count(struct pim_interface *pim_ifp);

void pim_iface_init(void);

#endif /* PIM_IFACE_H */
Commit	Line	Data
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"
ba4eb1bc CS	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"
568b78b5	34	#include "pim_str.h"
12e41d03	35
12e41d03 DL	36	#define PIM_IF_IS_DELETED(ifp) ((ifp)->ifindex == IFINDEX_INTERNAL)
12e41d03 DL	37
883052c6 DL	38	#define PIM_I_am_DR(pim_ifp) \
883052c6 DL	39	!pim_addr_cmp((pim_ifp)->pim_dr_addr, (pim_ifp)->primary_address)
22c35834	40	#define PIM_I_am_DualActive(pim_ifp) (pim_ifp)->activeactive == true
84366c7e	41
79992e8a MR	42	/* Macros for interface flags */
	43
	44	/*
	45	* PIM needs to know if hello is required to send before other PIM messages
	46	* like Join, prune, assert would go out
	47	*/
	48	#define PIM_IF_FLAG_HELLO_SENT (1 << 0)
	49
	50	#define PIM_IF_FLAG_TEST_HELLO_SENT(flags) ((flags)&PIM_IF_FLAG_HELLO_SENT)
	51
	52	#define PIM_IF_FLAG_SET_HELLO_SENT(flags) ((flags) \|= PIM_IF_FLAG_HELLO_SENT)
	53
	54	#define PIM_IF_FLAG_UNSET_HELLO_SENT(flags) ((flags) &= ~PIM_IF_FLAG_HELLO_SENT)
	55
982bff89	56	struct pim_iface_upstream_switch {
568b78b5	57	pim_addr address;
d62a17ae	58	struct list *us;
982bff89 DS	59	};
982bff89 DS	60
7176984f	61	enum pim_secondary_addr_flags {
d62a17ae	62	PIM_SEC_ADDRF_NONE = 0,
d62a17ae	63	PIM_SEC_ADDRF_STALE = (1 << 0)
7176984f	64	};
	65
	66	struct pim_secondary_addr {
d62a17ae	67	struct prefix addr;
d62a17ae	68	enum pim_secondary_addr_flags flags;
7176984f	69	};
7176984f	70
5e5034b0 DL	71	struct gm_if;
5e5034b0 DL	72
12e41d03	73	struct pim_interface {
b6fcc0b7 DL	74	bool pim_enable : 1;
b6fcc0b7 DL	75	bool pim_can_disable_join_suppression : 1;
78039cb2	76	bool pim_passive_enable : 1;
b6fcc0b7	77
4fecac21	78	bool gm_enable : 1;
b6fcc0b7	79
d62a17ae	80	ifindex_t mroute_vif_index;
c3bd5a10	81	struct pim_instance *pim;
cfef6155 DL	82
	83	#if PIM_IPV == 6
	84	/* link-locals: MLD uses lowest addr, PIM uses highest... */
	85	pim_addr ll_lowest;
	86	pim_addr ll_highest;
	87	#endif
	88
12e76340	89	pim_addr primary_address; /* remember addr to detect change */
d62a17ae	90	struct list sec_addr_list; / list of struct pim_secondary_addr */
12e76340	91	pim_addr update_source; /* user can statically set the primary
d62a17ae	92	* address of the interface */
18adcff1 SG	93
18adcff1 SG	94	int igmp_version; /* IGMP version */
5e5034b0	95	int mld_version;
18adcff1 SG	96	int gm_default_robustness_variable; /* IGMP or MLD QRV */
	97	int gm_default_query_interval; /* IGMP or MLD secs between general
	98	queries */
	99	int gm_query_max_response_time_dsec; /* IGMP or MLD Max Response Time in
d62a17ae	100	dsecs for general queries */
18adcff1 SG	101	int gm_specific_query_max_response_time_dsec; /* IGMP or MLD Max
	102	Response Time in dsecs
	103	called as last member
	104	query interval, defines
	105	the maximum response
	106	time advertised in IGMP
	107	group-specific
	108	queries */
	109	int gm_last_member_query_count; /* IGMP or MLD last member
	110	query count
	111	*/
	112	struct list gm_socket_list; / list of struct IGMP or MLD sock */
	113	struct list gm_join_list; / list of struct IGMP or MLD join */
	114	struct list gm_group_list; / list of struct IGMP or MLD group */
	115	struct hash *gm_group_hash;
d62a17ae	116
5e5034b0 DL	117	struct gm_if *mld;
5e5034b0 DL	118
d62a17ae	119	int pim_sock_fd; /* PIM socket file descriptor */
	120	struct thread t_pim_sock_read; / thread for reading PIM socket */
	121	int64_t pim_sock_creation; /* timestamp of PIM socket creation */
	122
	123	struct thread *t_pim_hello_timer;
	124	int pim_hello_period;
	125	int pim_default_holdtime;
	126	int pim_triggered_hello_delay;
	127	uint32_t pim_generation_id;
	128	uint16_t pim_propagation_delay_msec; /* config */
	129	uint16_t pim_override_interval_msec; /* config */
	130	struct list pim_neighbor_list; / list of struct pim_neighbor */
	131	struct list *upstream_switch_list;
ad7b74c4	132	struct pim_ifchannel_rb ifchannel_rb;
d62a17ae	133
	134	/* neighbors without lan_delay */
	135	int pim_number_of_nonlandelay_neighbors;
	136	uint16_t pim_neighbors_highest_propagation_delay_msec;
	137	uint16_t pim_neighbors_highest_override_interval_msec;
	138
	139	/* DR Election */
	140	int64_t pim_dr_election_last; /* timestamp */
	141	int pim_dr_election_count;
	142	int pim_dr_election_changes;
12e76340	143	pim_addr pim_dr_addr;
d62a17ae	144	uint32_t pim_dr_priority; /* config */
	145	int pim_dr_num_nondrpri_neighbors; /* neighbors without dr_pri */
	146
b0f525a8 QY	147	/* boundary prefix-list */
	148	char *boundary_oil_plist;
	149
414d885a DS	150	/* Turn on Active-Active for this interface */
414d885a DS	151	bool activeactive;
46a9ea8b	152	bool am_i_dr;
414d885a	153
d62a17ae	154	int64_t pim_ifstat_start; /* start timestamp for stats */
8a4dfb5d	155	uint64_t pim_ifstat_bsm_rx;
8a4dfb5d	156	uint64_t pim_ifstat_bsm_tx;
d62a17ae	157	uint32_t pim_ifstat_hello_sent;
	158	uint32_t pim_ifstat_hello_sendfail;
	159	uint32_t pim_ifstat_hello_recv;
	160	uint32_t pim_ifstat_hello_recvfail;
	161	uint32_t pim_ifstat_join_recv;
	162	uint32_t pim_ifstat_join_send;
	163	uint32_t pim_ifstat_prune_recv;
	164	uint32_t pim_ifstat_prune_send;
	165	uint32_t pim_ifstat_reg_recv;
	166	uint32_t pim_ifstat_reg_send;
	167	uint32_t pim_ifstat_reg_stop_recv;
	168	uint32_t pim_ifstat_reg_stop_send;
	169	uint32_t pim_ifstat_assert_recv;
	170	uint32_t pim_ifstat_assert_send;
8a4dfb5d	171	uint32_t pim_ifstat_bsm_cfg_miss;
	172	uint32_t pim_ifstat_ucast_bsm_cfg_miss;
	173	uint32_t pim_ifstat_bsm_invalid_sz;
79992e8a	174	uint8_t flags;
8a4dfb5d	175	bool bsm_enable; /* bsm processing enable */
8a4dfb5d	176	bool ucast_bsm_accept; /* ucast bsm processing */
1f3e6bf5	177
f2058cb4 DA	178	uint32_t igmp_ifstat_joins_sent;
f2058cb4 DA	179	uint32_t igmp_ifstat_joins_failed;
3e5d8665	180	uint32_t igmp_peak_group_count;
f2058cb4	181
1f3e6bf5 RZ	182	struct {
	183	bool enabled;
	184	uint32_t min_rx;
	185	uint32_t min_tx;
	186	uint8_t detection_multiplier;
745b8d4a	187	char *profile;
1f3e6bf5	188	} bfd_config;
12e41d03 DL	189	};
	190
	191	/*
18adcff1 SG	192	* if default_holdtime is set (>= 0), use it;
18adcff1 SG	193	* otherwise default_holdtime is 3.5 * hello_period
12e41d03	194	*/
d62a17ae	195	#define PIM_IF_DEFAULT_HOLDTIME(pim_ifp) \
	196	(((pim_ifp)->pim_default_holdtime < 0) \
	197	? ((pim_ifp)->pim_hello_period * 7 / 2) \
	198	: ((pim_ifp)->pim_default_holdtime))
12e41d03	199
f88df3a6 DS	200	void pim_if_init(struct pim_instance *pim);
f88df3a6 DS	201	void pim_if_terminate(struct pim_instance *pim);
12e41d03	202
85a13586	203	struct pim_interface pim_if_new(struct interface ifp, bool igmp, bool pim,
b1891fa0	204	bool ispimreg, bool is_vxlan_term);
d62a17ae	205	void pim_if_delete(struct interface *ifp);
12e41d03 DL	206	void pim_if_addr_add(struct connected *ifc);
	207	void pim_if_addr_del(struct connected *ifc, int force_prim_as_any);
	208	void pim_if_addr_add_all(struct interface *ifp);
	209	void pim_if_addr_del_all(struct interface *ifp);
	210	void pim_if_addr_del_all_igmp(struct interface *ifp);
12e41d03	211
b1891fa0	212	int pim_if_add_vif(struct interface *ifp, bool ispimreg, bool is_vxlan_term);
12e41d03	213	int pim_if_del_vif(struct interface *ifp);
f88df3a6 DS	214	void pim_if_add_vif_all(struct pim_instance *pim);
f88df3a6 DS	215	void pim_if_del_vif_all(struct pim_instance *pim);
12e41d03	216
7cfc7bcf DS	217	struct interface pim_if_find_by_vif_index(struct pim_instance pim,
	218	ifindex_t vif_index);
	219	int pim_if_find_vifindex_by_ifindex(struct pim_instance *pim,
	220	ifindex_t ifindex);
12e41d03 DL	221
	222	int pim_if_lan_delay_enabled(struct interface *ifp);
	223	uint16_t pim_if_effective_propagation_delay_msec(struct interface *ifp);
	224	uint16_t pim_if_effective_override_interval_msec(struct interface *ifp);
	225	uint16_t pim_if_jp_override_interval_msec(struct interface *ifp);
9bb93fa0	226	struct pim_neighbor pim_if_find_neighbor(struct interface ifp, pim_addr addr);
12e41d03 DL	227
	228	long pim_if_t_suppressed_msec(struct interface *ifp);
	229	int pim_if_t_override_msec(struct interface *ifp);
	230
034db86b	231	pim_addr pim_find_primary_addr(struct interface *ifp);
12e41d03	232
37664928 DS	233	ferr_r pim_if_igmp_join_add(struct interface *ifp, struct in_addr group_addr,
37664928 DS	234	struct in_addr source_addr);
d62a17ae	235	int pim_if_igmp_join_del(struct interface *ifp, struct in_addr group_addr,
12e41d03 DL	236	struct in_addr source_addr);
	237
	238	void pim_if_update_could_assert(struct interface *ifp);
	239
9bb93fa0	240	void pim_if_assert_on_neighbor_down(struct interface *ifp, pim_addr neigh_addr);
12e41d03 DL	241
	242	void pim_if_rpf_interface_changed(struct interface *old_rpf_ifp,
	243	struct pim_upstream *up);
	244
	245	void pim_if_update_join_desired(struct pim_interface *pim_ifp);
	246
	247	void pim_if_update_assert_tracking_desired(struct interface *ifp);
	248
43e40fdf	249	void pim_if_create_pimreg(struct pim_instance *pim);
3565202d	250
034db86b DL	251	struct prefix pim_if_connected_to_source(struct interface ifp, pim_addr src);
034db86b DL	252	int pim_update_source_set(struct interface *ifp, pim_addr source);
3fdfd943	253
e55a43d4	254	bool pim_if_is_vrf_device(struct interface *ifp);
ad7b74c4 DS	255
ad7b74c4 DS	256	int pim_if_ifchannel_count(struct pim_interface *pim_ifp);
138c5a74	257
6b88faa7	258	void pim_iface_init(void);
138c5a74	259
12e41d03	260	#endif /* PIM_IFACE_H */