[mirror_frr.git] / pimd / pim_igmpv3.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_IGMPV3_H
#define PIM_IGMPV3_H

#include <zebra.h>
#include "if.h"

#define IGMP_V3_CHECKSUM_OFFSET            (2)
#define IGMP_V3_REPORT_NUMGROUPS_OFFSET    (6)
#define IGMP_V3_REPORT_GROUPPRECORD_OFFSET (8)
#define IGMP_V3_NUMSOURCES_OFFSET          (10)
#define IGMP_V3_SOURCES_OFFSET             (12)

#define IGMP_GRP_REC_TYPE_MODE_IS_INCLUDE        (1)
#define IGMP_GRP_REC_TYPE_MODE_IS_EXCLUDE        (2)
#define IGMP_GRP_REC_TYPE_CHANGE_TO_INCLUDE_MODE (3)
#define IGMP_GRP_REC_TYPE_CHANGE_TO_EXCLUDE_MODE (4)
#define IGMP_GRP_REC_TYPE_ALLOW_NEW_SOURCES      (5)
#define IGMP_GRP_REC_TYPE_BLOCK_OLD_SOURCES      (6)

/* GMI: Group Membership Interval */
#define PIM_IGMP_GMI_MSEC(qrv,qqi,qri_dsec) ((qrv) * (1000 * (qqi)) + 100 * (qri_dsec))

/* OQPI: Other Querier Present Interval */
#define PIM_IGMP_OQPI_MSEC(qrv,qqi,qri_dsec) ((qrv) * (1000 * (qqi)) + 100 * ((qri_dsec) >> 1))

/* SQI: Startup Query Interval */
#define PIM_IGMP_SQI(qi) (((qi) < 4) ? 1 : ((qi) >> 2))

/* LMQT: Last Member Query Time */
#define PIM_IGMP_LMQT_MSEC(lmqi_dsec, lmqc) ((lmqc) * (100 * (lmqi_dsec)))

/* OHPI: Older Host Present Interval */
#define PIM_IGMP_OHPI_DSEC(qrv,qqi,qri_dsec) ((qrv) * (10 * (qqi)) + (qri_dsec))

void igmp_group_reset_gmi(struct igmp_group *group);
void igmp_source_reset_gmi(struct igmp_sock *igmp,
			   struct igmp_group *group,
			   struct igmp_source *source);

void igmp_source_free(struct igmp_source *source);
void igmp_source_delete(struct igmp_source *source);
void igmp_source_delete_expired(struct list *source_list);

void igmpv3_report_isin(struct igmp_sock *igmp, struct in_addr from,
			struct in_addr group_addr,
			int num_sources, struct in_addr *sources);
void igmpv3_report_isex(struct igmp_sock *igmp, struct in_addr from,
			struct in_addr group_addr,
                        int num_sources, struct in_addr *sources,
                        int from_igmp_v2_report);
void igmpv3_report_toin(struct igmp_sock *igmp, struct in_addr from,
			struct in_addr group_addr,
			int num_sources, struct in_addr *sources);
void igmpv3_report_toex(struct igmp_sock *igmp, struct in_addr from,
			struct in_addr group_addr,
			int num_sources, struct in_addr *sources);
void igmpv3_report_allow(struct igmp_sock *igmp, struct in_addr from,
			 struct in_addr group_addr,
			 int num_sources, struct in_addr *sources);
void igmpv3_report_block(struct igmp_sock *igmp, struct in_addr from,
			 struct in_addr group_addr,
			 int num_sources, struct in_addr *sources);

void igmp_group_timer_lower_to_lmqt(struct igmp_group *group);
void igmp_source_timer_lower_to_lmqt(struct igmp_source *source);

struct igmp_source *igmp_find_source_by_addr(struct igmp_group *group,
					     struct in_addr src_addr);

void igmp_v3_send_query (struct igmp_group *group,
                         int fd,
                         const char *ifname,
                         char *query_buf,
                         int query_buf_size,
                         int num_sources,
                         struct in_addr dst_addr,
                         struct in_addr group_addr,
                         int query_max_response_time_dsec,
                         uint8_t s_flag,
                         uint8_t querier_robustness_variable,
                         uint16_t querier_query_interval);

void igmp_v3_recv_query (struct igmp_sock *igmp, const char *from_str,
                         char *igmp_msg);

int igmp_v3_recv_report (struct igmp_sock *igmp,
                         struct in_addr from, const char *from_str,
                         char *igmp_msg, int igmp_msg_len);

#endif /* PIM_IGMPV3_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
	18	*/
12e41d03 DL	19
	20	#ifndef PIM_IGMPV3_H
	21	#define PIM_IGMPV3_H
	22
	23	#include <zebra.h>
	24	#include "if.h"
	25
	26	#define IGMP_V3_CHECKSUM_OFFSET (2)
	27	#define IGMP_V3_REPORT_NUMGROUPS_OFFSET (6)
	28	#define IGMP_V3_REPORT_GROUPPRECORD_OFFSET (8)
	29	#define IGMP_V3_NUMSOURCES_OFFSET (10)
	30	#define IGMP_V3_SOURCES_OFFSET (12)
	31
b05b72e8 DW	32	#define IGMP_GRP_REC_TYPE_MODE_IS_INCLUDE (1)
	33	#define IGMP_GRP_REC_TYPE_MODE_IS_EXCLUDE (2)
	34	#define IGMP_GRP_REC_TYPE_CHANGE_TO_INCLUDE_MODE (3)
	35	#define IGMP_GRP_REC_TYPE_CHANGE_TO_EXCLUDE_MODE (4)
	36	#define IGMP_GRP_REC_TYPE_ALLOW_NEW_SOURCES (5)
	37	#define IGMP_GRP_REC_TYPE_BLOCK_OLD_SOURCES (6)
	38
12e41d03 DL	39	/* GMI: Group Membership Interval */
	40	#define PIM_IGMP_GMI_MSEC(qrv,qqi,qri_dsec) ((qrv) * (1000 * (qqi)) + 100 * (qri_dsec))
	41
	42	/* OQPI: Other Querier Present Interval */
	43	#define PIM_IGMP_OQPI_MSEC(qrv,qqi,qri_dsec) ((qrv) * (1000 * (qqi)) + 100 * ((qri_dsec) >> 1))
	44
	45	/* SQI: Startup Query Interval */
	46	#define PIM_IGMP_SQI(qi) (((qi) < 4) ? 1 : ((qi) >> 2))
	47
	48	/* LMQT: Last Member Query Time */
	49	#define PIM_IGMP_LMQT_MSEC(lmqi_dsec, lmqc) ((lmqc) * (100 * (lmqi_dsec)))
	50
	51	/* OHPI: Older Host Present Interval */
	52	#define PIM_IGMP_OHPI_DSEC(qrv,qqi,qri_dsec) ((qrv) * (10 * (qqi)) + (qri_dsec))
	53
	54	void igmp_group_reset_gmi(struct igmp_group *group);
	55	void igmp_source_reset_gmi(struct igmp_sock *igmp,
	56	struct igmp_group *group,
	57	struct igmp_source *source);
	58
	59	void igmp_source_free(struct igmp_source *source);
	60	void igmp_source_delete(struct igmp_source *source);
	61	void igmp_source_delete_expired(struct list *source_list);
	62
12e41d03 DL	63	void igmpv3_report_isin(struct igmp_sock *igmp, struct in_addr from,
	64	struct in_addr group_addr,
	65	int num_sources, struct in_addr *sources);
	66	void igmpv3_report_isex(struct igmp_sock *igmp, struct in_addr from,
	67	struct in_addr group_addr,
b05b72e8 DW	68	int num_sources, struct in_addr *sources,
b05b72e8 DW	69	int from_igmp_v2_report);
12e41d03 DL	70	void igmpv3_report_toin(struct igmp_sock *igmp, struct in_addr from,
	71	struct in_addr group_addr,
	72	int num_sources, struct in_addr *sources);
	73	void igmpv3_report_toex(struct igmp_sock *igmp, struct in_addr from,
	74	struct in_addr group_addr,
	75	int num_sources, struct in_addr *sources);
	76	void igmpv3_report_allow(struct igmp_sock *igmp, struct in_addr from,
	77	struct in_addr group_addr,
	78	int num_sources, struct in_addr *sources);
	79	void igmpv3_report_block(struct igmp_sock *igmp, struct in_addr from,
	80	struct in_addr group_addr,
	81	int num_sources, struct in_addr *sources);
	82
	83	void igmp_group_timer_lower_to_lmqt(struct igmp_group *group);
	84	void igmp_source_timer_lower_to_lmqt(struct igmp_source *source);
	85
	86	struct igmp_source igmp_find_source_by_addr(struct igmp_group group,
	87	struct in_addr src_addr);
	88
b05b72e8 DW	89	void igmp_v3_send_query (struct igmp_group *group,
	90	int fd,
	91	const char *ifname,
	92	char *query_buf,
	93	int query_buf_size,
	94	int num_sources,
	95	struct in_addr dst_addr,
	96	struct in_addr group_addr,
	97	int query_max_response_time_dsec,
	98	uint8_t s_flag,
	99	uint8_t querier_robustness_variable,
	100	uint16_t querier_query_interval);
	101
	102	void igmp_v3_recv_query (struct igmp_sock igmp, const char from_str,
	103	char *igmp_msg);
	104
	105	int igmp_v3_recv_report (struct igmp_sock *igmp,
	106	struct in_addr from, const char *from_str,
	107	char *igmp_msg, int igmp_msg_len);
12e41d03 DL	108
12e41d03 DL	109	#endif /* PIM_IGMPV3_H */