[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 "pim_igmp.h"
#include "pim_upstream.h"

#define PIM_IF_MASK_PIM                             (1 << 0)
#define PIM_IF_MASK_IGMP                            (1 << 1)
#define PIM_IF_MASK_IGMP_LISTEN_ALLROUTERS          (1 << 2)
#define PIM_IF_MASK_PIM_CAN_DISABLE_JOIN_SUPRESSION (1 << 3)

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

#define PIM_IF_TEST_PIM(options) (PIM_IF_MASK_PIM & (options))
#define PIM_IF_TEST_IGMP(options) (PIM_IF_MASK_IGMP & (options))
#define PIM_IF_TEST_IGMP_LISTEN_ALLROUTERS(options) (PIM_IF_MASK_IGMP_LISTEN_ALLROUTERS & (options))
#define PIM_IF_TEST_PIM_CAN_DISABLE_JOIN_SUPRESSION(options) (PIM_IF_MASK_PIM_CAN_DISABLE_JOIN_SUPRESSION & (options))

#define PIM_IF_DO_PIM(options) ((options) |= PIM_IF_MASK_PIM)
#define PIM_IF_DO_IGMP(options) ((options) |= PIM_IF_MASK_IGMP)
#define PIM_IF_DO_IGMP_LISTEN_ALLROUTERS(options) ((options) |= PIM_IF_MASK_IGMP_LISTEN_ALLROUTERS)
#define PIM_IF_DO_PIM_CAN_DISABLE_JOIN_SUPRESSION(options) ((options) |= PIM_IF_MASK_PIM_CAN_DISABLE_JOIN_SUPRESSION)

#define PIM_IF_DONT_PIM(options) ((options) &= ~PIM_IF_MASK_PIM)
#define PIM_IF_DONT_IGMP(options) ((options) &= ~PIM_IF_MASK_IGMP)
#define PIM_IF_DONT_IGMP_LISTEN_ALLROUTERS(options) ((options) &= ~PIM_IF_MASK_IGMP_LISTEN_ALLROUTERS)
#define PIM_IF_DONT_PIM_CAN_DISABLE_JOIN_SUPRESSION(options) ((options) &= ~PIM_IF_MASK_PIM_CAN_DISABLE_JOIN_SUPRESSION)

#define PIM_I_am_DR(pim_ifp) (pim_ifp)->pim_dr_addr.s_addr == (pim_ifp)->primary_address.s_addr

enum pim_interface_type {
  PIM_INTERFACE_SSM,
  PIM_INTERFACE_SM
};

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

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

struct pim_interface {
  enum pim_interface_type itype;
  uint32_t       options;                            /* bit vector */
  ifindex_t      mroute_vif_index;
  struct in_addr primary_address; /* remember addr to detect change */
  struct list    *sec_addr_list; /* list of struct pim_secondary_addr */
  struct in_addr update_source;  /* user can statically set the primary
                                  * address of the interface */

  int          igmp_version;                                /* IGMP version */
  int          igmp_default_robustness_variable;            /* IGMPv3 QRV */
  int          igmp_default_query_interval;                 /* IGMPv3 secs between general queries */
  int          igmp_query_max_response_time_dsec;           /* IGMPv3 Max Response Time in dsecs for general queries */
  int          igmp_specific_query_max_response_time_dsec;  /* IGMPv3 Max Response Time in dsecs for specific queries */
  struct list *igmp_socket_list;                            /* list of struct igmp_sock */
  struct list *igmp_join_list;                              /* list of struct igmp_join */

  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   *pim_ifchannel_list; /* list of struct pim_ifchannel */

  /* 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;
  struct in_addr pim_dr_addr;
  uint32_t       pim_dr_priority;            /* config */
  int            pim_dr_num_nondrpri_neighbors; /* neighbors without dr_pri */

  int64_t        pim_ifstat_start; /* start timestamp for stats */
  uint32_t       pim_ifstat_hello_sent;
  uint32_t       pim_ifstat_hello_sendfail;
  uint32_t       pim_ifstat_hello_recv;
  uint32_t       pim_ifstat_hello_recvfail;
};

extern struct interface *pim_regiface;
extern struct list *pim_ifchannel_list;
/*
  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(void);
void pim_if_terminate (void);

struct pim_interface *pim_if_new(struct interface *ifp, int igmp, int pim);
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);
void pim_if_addr_del_all_pim(struct interface *ifp);

struct interface *pim_if_lookup_address_vrf (struct in_addr src, vrf_id_t vrf_id);

int pim_if_add_vif(struct interface *ifp);
int pim_if_del_vif(struct interface *ifp);
void pim_if_add_vif_all(void);
void pim_if_del_vif_all(void);

struct interface *pim_if_find_by_vif_index(ifindex_t vif_index);
int pim_if_find_vifindex_by_ifindex(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,
					  struct in_addr addr);

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

struct in_addr pim_find_primary_addr(struct interface *ifp);

int 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,
				    struct in_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(void);

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

#endif /* PIM_IFACE_H */
Commit	Line	Data
12e41d03 DL	1	/*
	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
	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,
	18	MA 02110-1301 USA
83190a40	19	*/
12e41d03 DL	20
	21	#ifndef PIM_IFACE_H
	22	#define PIM_IFACE_H
	23
	24	#include <zebra.h>
	25
	26	#include "if.h"
	27	#include "vty.h"
	28
	29	#include "pim_igmp.h"
	30	#include "pim_upstream.h"
	31
	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)
	36
	37	#define PIM_IF_IS_DELETED(ifp) ((ifp)->ifindex == IFINDEX_INTERNAL)
	38
	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))
	43
	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)
	48
	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)
	53
df696e3f	54	#define PIM_I_am_DR(pim_ifp) (pim_ifp)->pim_dr_addr.s_addr == (pim_ifp)->primary_address.s_addr
84366c7e	55
981d6c7a DS	56	enum pim_interface_type {
	57	PIM_INTERFACE_SSM,
	58	PIM_INTERFACE_SM
	59	};
	60
7176984f	61	enum pim_secondary_addr_flags {
	62	PIM_SEC_ADDRF_NONE = 0,
	63	PIM_SEC_ADDRF_STALE = (1 << 0)
	64	};
	65
	66	struct pim_secondary_addr {
	67	struct in_addr addr;
	68	enum pim_secondary_addr_flags flags;
	69	};
	70
12e41d03	71	struct pim_interface {
981d6c7a	72	enum pim_interface_type itype;
12e41d03	73	uint32_t options; /* bit vector */
b892f1dd	74	ifindex_t mroute_vif_index;
12e41d03	75	struct in_addr primary_address; /* remember addr to detect change */
7176984f	76	struct list sec_addr_list; / list of struct pim_secondary_addr */
4763cd0e	77	struct in_addr update_source; /* user can statically set the primary
4763cd0e	78	* address of the interface */
12e41d03	79
b05b72e8	80	int igmp_version; /* IGMP version */
12e41d03 DL	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 */
	87
	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 */
	91
	92	struct thread *t_pim_hello_timer;
	93	int pim_hello_period;
	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 */
	101
	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;
	106
	107	/* DR Election */
	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 */
	114
	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;
	120	};
	121
c992c9a0	122	extern struct interface *pim_regiface;
ea4a71fc	123	extern struct list *pim_ifchannel_list;
12e41d03 DL	124	/*
	125	if default_holdtime is set (>= 0), use it;
	126	otherwise default_holdtime is 3.5 * hello_period
	127	*/
	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))
	132
	133	void pim_if_init(void);
ea4a71fc	134	void pim_if_terminate (void);
12e41d03 DL	135
	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);
	144
9f0edbc9 DS	145	struct interface *pim_if_lookup_address_vrf (struct in_addr src, vrf_id_t vrf_id);
9f0edbc9 DS	146
12e41d03 DL	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);
	151
b892f1dd PJ	152	struct interface *pim_if_find_by_vif_index(ifindex_t vif_index);
b892f1dd PJ	153	int pim_if_find_vifindex_by_ifindex(ifindex_t ifindex);
12e41d03 DL	154
	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);
	161
	162	long pim_if_t_suppressed_msec(struct interface *ifp);
	163	int pim_if_t_override_msec(struct interface *ifp);
	164
	165	struct in_addr pim_find_primary_addr(struct interface *ifp);
	166
	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);
	173
	174	void pim_if_update_could_assert(struct interface *ifp);
	175
	176	void pim_if_assert_on_neighbor_down(struct interface *ifp,
	177	struct in_addr neigh_addr);
	178
	179	void pim_if_rpf_interface_changed(struct interface *old_rpf_ifp,
	180	struct pim_upstream *up);
	181
	182	void pim_if_update_join_desired(struct pim_interface *pim_ifp);
	183
	184	void pim_if_update_assert_tracking_desired(struct interface *ifp);
	185
c992c9a0	186	void pim_if_create_pimreg(void);
3565202d DS	187
3565202d DS	188	int pim_if_connected_to_source (struct interface *ifp, struct in_addr src);
4763cd0e	189	int pim_update_source_set(struct interface *ifp, struct in_addr source);
3fdfd943	190
12e41d03	191	#endif /* PIM_IFACE_H */