[mirror_frr.git] / pimd / pim_iface.h

// SPDX-License-Identifier: GPL-2.0-or-later
/*
 * PIM for Quagga
 * Copyright (C) 2008  Everton da Silva Marques
 */

#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 event *t_pim_sock_read;	/* thread for reading PIM socket */
	int64_t pim_sock_creation;      /* timestamp of PIM socket creation */

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