[mirror_ubuntu-bionic-kernel.git] / include / linux / igmp.h

/*
 *	Linux NET3:	Internet Group Management Protocol  [IGMP]
 *
 *	Authors:
 *		Alan Cox <alan@lxorguk.ukuu.org.uk>
 *
 *	Extended to talk the BSD extended IGMP protocol of mrouted 3.6
 *
 *
 *	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.
 */

#ifndef _LINUX_IGMP_H
#define _LINUX_IGMP_H

#include <linux/types.h>
#include <asm/byteorder.h>

/*
 *	IGMP protocol structures
 */

/*
 *	Header in on cable format
 */

struct igmphdr {
	__u8 type;
	__u8 code;		/* For newer IGMP */
	__sum16 csum;
	__be32 group;
};

/* V3 group record types [grec_type] */
#define IGMPV3_MODE_IS_INCLUDE		1
#define IGMPV3_MODE_IS_EXCLUDE		2
#define IGMPV3_CHANGE_TO_INCLUDE	3
#define IGMPV3_CHANGE_TO_EXCLUDE	4
#define IGMPV3_ALLOW_NEW_SOURCES	5
#define IGMPV3_BLOCK_OLD_SOURCES	6

struct igmpv3_grec {
	__u8	grec_type;
	__u8	grec_auxwords;
	__be16	grec_nsrcs;
	__be32	grec_mca;
	__be32	grec_src[0];
};

struct igmpv3_report {
	__u8 type;
	__u8 resv1;
	__be16 csum;
	__be16 resv2;
	__be16 ngrec;
	struct igmpv3_grec grec[0];
};

struct igmpv3_query {
	__u8 type;
	__u8 code;
	__be16 csum;
	__be32 group;
#if defined(__LITTLE_ENDIAN_BITFIELD)
	__u8 qrv:3,
	     suppress:1,
	     resv:4;
#elif defined(__BIG_ENDIAN_BITFIELD)
	__u8 resv:4,
	     suppress:1,
	     qrv:3;
#else
#error "Please fix <asm/byteorder.h>"
#endif
	__u8 qqic;
	__be16 nsrcs;
	__be32 srcs[0];
};

#define IGMP_HOST_MEMBERSHIP_QUERY	0x11	/* From RFC1112 */
#define IGMP_HOST_MEMBERSHIP_REPORT	0x12	/* Ditto */
#define IGMP_DVMRP			0x13	/* DVMRP routing */
#define IGMP_PIM			0x14	/* PIM routing */
#define IGMP_TRACE			0x15
#define IGMPV2_HOST_MEMBERSHIP_REPORT	0x16	/* V2 version of 0x11 */
#define IGMP_HOST_LEAVE_MESSAGE 	0x17
#define IGMPV3_HOST_MEMBERSHIP_REPORT	0x22	/* V3 version of 0x11 */

#define IGMP_MTRACE_RESP		0x1e
#define IGMP_MTRACE			0x1f


/*
 *	Use the BSD names for these for compatibility
 */

#define IGMP_DELAYING_MEMBER		0x01
#define IGMP_IDLE_MEMBER		0x02
#define IGMP_LAZY_MEMBER		0x03
#define IGMP_SLEEPING_MEMBER		0x04
#define IGMP_AWAKENING_MEMBER		0x05

#define IGMP_MINLEN			8

#define IGMP_MAX_HOST_REPORT_DELAY	10	/* max delay for response to */
						/* query (in seconds)	*/

#define IGMP_TIMER_SCALE		10	/* denotes that the igmphdr->timer field */
						/* specifies time in 10th of seconds	 */

#define IGMP_AGE_THRESHOLD		400	/* If this host don't hear any IGMP V1	*/
						/* message in this period of time,	*/
						/* revert to IGMP v2 router.		*/

#define IGMP_ALL_HOSTS		htonl(0xE0000001L)
#define IGMP_ALL_ROUTER 	htonl(0xE0000002L)
#define IGMPV3_ALL_MCR	 	htonl(0xE0000016L)
#define IGMP_LOCAL_GROUP	htonl(0xE0000000L)
#define IGMP_LOCAL_GROUP_MASK	htonl(0xFFFFFF00L)

/*
 * struct for keeping the multicast list in
 */

#ifdef __KERNEL__
#include <linux/skbuff.h>
#include <linux/timer.h>
#include <linux/in.h>

static inline struct igmphdr *igmp_hdr(const struct sk_buff *skb)
{
	return (struct igmphdr *)skb_transport_header(skb);
}

static inline struct igmpv3_report *
			igmpv3_report_hdr(const struct sk_buff *skb)
{
	return (struct igmpv3_report *)skb_transport_header(skb);
}

static inline struct igmpv3_query *
			igmpv3_query_hdr(const struct sk_buff *skb)
{
	return (struct igmpv3_query *)skb_transport_header(skb);
}

extern int sysctl_igmp_max_memberships;
extern int sysctl_igmp_max_msf;

struct ip_sf_socklist {
	unsigned int		sl_max;
	unsigned int		sl_count;
	struct rcu_head		rcu;
	__be32			sl_addr[0];
};

#define IP_SFLSIZE(count)	(sizeof(struct ip_sf_socklist) + \
	(count) * sizeof(__be32))

#define IP_SFBLOCK	10	/* allocate this many at once */

/* ip_mc_socklist is real list now. Speed is not argument;
   this list never used in fast path code
 */

struct ip_mc_socklist {
	struct ip_mc_socklist	*next;
	struct ip_mreqn		multi;
	unsigned int		sfmode;		/* MCAST_{INCLUDE,EXCLUDE} */
	struct ip_sf_socklist	*sflist;
	struct rcu_head		rcu;
};

struct ip_sf_list {
	struct ip_sf_list	*sf_next;
	__be32			sf_inaddr;
	unsigned long		sf_count[2];	/* include/exclude counts */
	unsigned char		sf_gsresp;	/* include in g & s response? */
	unsigned char		sf_oldin;	/* change state */
	unsigned char		sf_crcount;	/* retrans. left to send */
};

struct ip_mc_list {
	struct in_device	*interface;
	__be32			multiaddr;
	struct ip_sf_list	*sources;
	struct ip_sf_list	*tomb;
	unsigned int		sfmode;
	unsigned long		sfcount[2];
	struct ip_mc_list	*next;
	struct timer_list	timer;
	int			users;
	atomic_t		refcnt;
	spinlock_t		lock;
	char			tm_running;
	char			reporter;
	char			unsolicit_count;
	char			loaded;
	unsigned char		gsquery;	/* check source marks? */
	unsigned char		crcount;
};

/* V3 exponential field decoding */
#define IGMPV3_MASK(value, nb) ((nb)>=32 ? (value) : ((1<<(nb))-1) & (value))
#define IGMPV3_EXP(thresh, nbmant, nbexp, value) \
	((value) < (thresh) ? (value) : \
        ((IGMPV3_MASK(value, nbmant) | (1<<(nbmant))) << \
         (IGMPV3_MASK((value) >> (nbmant), nbexp) + (nbexp))))

#define IGMPV3_QQIC(value) IGMPV3_EXP(0x80, 4, 3, value)
#define IGMPV3_MRC(value) IGMPV3_EXP(0x80, 4, 3, value)

extern int ip_check_mc(struct in_device *dev, __be32 mc_addr, __be32 src_addr, u16 proto);
extern int igmp_rcv(struct sk_buff *);
extern int ip_mc_join_group(struct sock *sk, struct ip_mreqn *imr);
extern int ip_mc_leave_group(struct sock *sk, struct ip_mreqn *imr);
extern void ip_mc_drop_socket(struct sock *sk);
extern int ip_mc_source(int add, int omode, struct sock *sk,
		struct ip_mreq_source *mreqs, int ifindex);
extern int ip_mc_msfilter(struct sock *sk, struct ip_msfilter *msf,int ifindex);
extern int ip_mc_msfget(struct sock *sk, struct ip_msfilter *msf,
		struct ip_msfilter __user *optval, int __user *optlen);
extern int ip_mc_gsfget(struct sock *sk, struct group_filter *gsf,
		struct group_filter __user *optval, int __user *optlen);
extern int ip_mc_sf_allow(struct sock *sk, __be32 local, __be32 rmt, int dif);
extern void ip_mc_init_dev(struct in_device *);
extern void ip_mc_destroy_dev(struct in_device *);
extern void ip_mc_up(struct in_device *);
extern void ip_mc_down(struct in_device *);
extern void ip_mc_unmap(struct in_device *);
extern void ip_mc_remap(struct in_device *);
extern void ip_mc_dec_group(struct in_device *in_dev, __be32 addr);
extern void ip_mc_inc_group(struct in_device *in_dev, __be32 addr);
extern void ip_mc_rejoin_group(struct ip_mc_list *im);

#endif
#endif
Commit	Line	Data
1da177e4 LT	1	/*
	2	* Linux NET3: Internet Group Management Protocol [IGMP]
	3	*
	4	* Authors:
113aa838	5	* Alan Cox <alan@lxorguk.ukuu.org.uk>
1da177e4 LT	6	*
	7	* Extended to talk the BSD extended IGMP protocol of mrouted 3.6
	8	*
	9	*
	10	* This program is free software; you can redistribute it and/or
	11	* modify it under the terms of the GNU General Public License
	12	* as published by the Free Software Foundation; either version
	13	* 2 of the License, or (at your option) any later version.
	14	*/
	15
	16	#ifndef _LINUX_IGMP_H
	17	#define _LINUX_IGMP_H
	18
de8b0bca	19	#include <linux/types.h>
1da177e4 LT	20	#include <asm/byteorder.h>
	21
	22	/*
	23	* IGMP protocol structures
	24	*/
	25
	26	/*
	27	* Header in on cable format
	28	*/
	29
d94d9fee	30	struct igmphdr {
1da177e4 LT	31	__u8 type;
1da177e4 LT	32	__u8 code; /* For newer IGMP */
9981a0e3	33	__sum16 csum;
942bf921	34	__be32 group;
1da177e4 LT	35	};
	36
	37	/* V3 group record types [grec_type] */
	38	#define IGMPV3_MODE_IS_INCLUDE 1
	39	#define IGMPV3_MODE_IS_EXCLUDE 2
	40	#define IGMPV3_CHANGE_TO_INCLUDE 3
	41	#define IGMPV3_CHANGE_TO_EXCLUDE 4
	42	#define IGMPV3_ALLOW_NEW_SOURCES 5
	43	#define IGMPV3_BLOCK_OLD_SOURCES 6
	44
	45	struct igmpv3_grec {
	46	__u8 grec_type;
	47	__u8 grec_auxwords;
942bf921 AV	48	__be16 grec_nsrcs;
	49	__be32 grec_mca;
	50	__be32 grec_src[0];
1da177e4 LT	51	};
	52
	53	struct igmpv3_report {
	54	__u8 type;
	55	__u8 resv1;
942bf921 AV	56	__be16 csum;
	57	__be16 resv2;
	58	__be16 ngrec;
1da177e4 LT	59	struct igmpv3_grec grec[0];
	60	};
	61
	62	struct igmpv3_query {
	63	__u8 type;
	64	__u8 code;
942bf921 AV	65	__be16 csum;
942bf921 AV	66	__be32 group;
1da177e4 LT	67	#if defined(__LITTLE_ENDIAN_BITFIELD)
	68	__u8 qrv:3,
	69	suppress:1,
	70	resv:4;
	71	#elif defined(__BIG_ENDIAN_BITFIELD)
	72	__u8 resv:4,
	73	suppress:1,
	74	qrv:3;
	75	#else
	76	#error "Please fix <asm/byteorder.h>"
	77	#endif
	78	__u8 qqic;
942bf921 AV	79	__be16 nsrcs;
942bf921 AV	80	__be32 srcs[0];
1da177e4 LT	81	};
	82
	83	#define IGMP_HOST_MEMBERSHIP_QUERY 0x11 /* From RFC1112 */
	84	#define IGMP_HOST_MEMBERSHIP_REPORT 0x12 /* Ditto */
	85	#define IGMP_DVMRP 0x13 /* DVMRP routing */
	86	#define IGMP_PIM 0x14 /* PIM routing */
	87	#define IGMP_TRACE 0x15
	88	#define IGMPV2_HOST_MEMBERSHIP_REPORT 0x16 /* V2 version of 0x11 */
	89	#define IGMP_HOST_LEAVE_MESSAGE 0x17
	90	#define IGMPV3_HOST_MEMBERSHIP_REPORT 0x22 /* V3 version of 0x11 */
	91
	92	#define IGMP_MTRACE_RESP 0x1e
	93	#define IGMP_MTRACE 0x1f
	94
	95
	96	/*
	97	* Use the BSD names for these for compatibility
	98	*/
	99
	100	#define IGMP_DELAYING_MEMBER 0x01
	101	#define IGMP_IDLE_MEMBER 0x02
	102	#define IGMP_LAZY_MEMBER 0x03
	103	#define IGMP_SLEEPING_MEMBER 0x04
	104	#define IGMP_AWAKENING_MEMBER 0x05
	105
	106	#define IGMP_MINLEN 8
	107
	108	#define IGMP_MAX_HOST_REPORT_DELAY 10 /* max delay for response to */
	109	/* query (in seconds) */
	110
	111	#define IGMP_TIMER_SCALE 10 /* denotes that the igmphdr->timer field */
	112	/* specifies time in 10th of seconds */
	113
	114	#define IGMP_AGE_THRESHOLD 400 /* If this host don't hear any IGMP V1 */
	115	/* message in this period of time, */
	116	/* revert to IGMP v2 router. */
	117
	118	#define IGMP_ALL_HOSTS htonl(0xE0000001L)
	119	#define IGMP_ALL_ROUTER htonl(0xE0000002L)
	120	#define IGMPV3_ALL_MCR htonl(0xE0000016L)
	121	#define IGMP_LOCAL_GROUP htonl(0xE0000000L)
	122	#define IGMP_LOCAL_GROUP_MASK htonl(0xFFFFFF00L)
	123
	124	/*
	125	* struct for keeping the multicast list in
	126	*/
	127
	128	#ifdef __KERNEL__
	129	#include <linux/skbuff.h>
d7fe0f24	130	#include <linux/timer.h>
1da177e4 LT	131	#include <linux/in.h>
1da177e4 LT	132
cc32e054 JP	133	static inline struct igmphdr igmp_hdr(const struct sk_buff skb)
	134	{
	135	return (struct igmphdr *)skb_transport_header(skb);
	136	}
	137
	138	static inline struct igmpv3_report *
	139	igmpv3_report_hdr(const struct sk_buff *skb)
	140	{
	141	return (struct igmpv3_report *)skb_transport_header(skb);
	142	}
	143
	144	static inline struct igmpv3_query *
	145	igmpv3_query_hdr(const struct sk_buff *skb)
	146	{
	147	return (struct igmpv3_query *)skb_transport_header(skb);
	148	}
	149
20380731 ACM	150	extern int sysctl_igmp_max_memberships;
	151	extern int sysctl_igmp_max_msf;
	152
d94d9fee	153	struct ip_sf_socklist {
1da177e4 LT	154	unsigned int sl_max;
1da177e4 LT	155	unsigned int sl_count;
c85bb41e	156	struct rcu_head rcu;
ea4d9e72	157	__be32 sl_addr[0];
1da177e4 LT	158	};
	159
	160	#define IP_SFLSIZE(count) (sizeof(struct ip_sf_socklist) + \
63007727	161	(count) * sizeof(__be32))
1da177e4 LT	162
	163	#define IP_SFBLOCK 10 /* allocate this many at once */
	164
	165	/* ip_mc_socklist is real list now. Speed is not argument;
	166	this list never used in fast path code
	167	*/
	168
d94d9fee	169	struct ip_mc_socklist {
1da177e4	170	struct ip_mc_socklist *next;
1da177e4 LT	171	struct ip_mreqn multi;
	172	unsigned int sfmode; /* MCAST_{INCLUDE,EXCLUDE} */
	173	struct ip_sf_socklist *sflist;
c85bb41e	174	struct rcu_head rcu;
1da177e4 LT	175	};
1da177e4 LT	176
d94d9fee	177	struct ip_sf_list {
1da177e4	178	struct ip_sf_list *sf_next;
ea4d9e72	179	__be32 sf_inaddr;
1da177e4 LT	180	unsigned long sf_count[2]; /* include/exclude counts */
	181	unsigned char sf_gsresp; /* include in g & s response? */
	182	unsigned char sf_oldin; /* change state */
	183	unsigned char sf_crcount; /* retrans. left to send */
	184	};
	185
d94d9fee	186	struct ip_mc_list {
1da177e4	187	struct in_device *interface;
338fcf98	188	__be32 multiaddr;
1da177e4 LT	189	struct ip_sf_list *sources;
	190	struct ip_sf_list *tomb;
	191	unsigned int sfmode;
	192	unsigned long sfcount[2];
	193	struct ip_mc_list *next;
	194	struct timer_list timer;
	195	int users;
	196	atomic_t refcnt;
	197	spinlock_t lock;
	198	char tm_running;
	199	char reporter;
	200	char unsolicit_count;
	201	char loaded;
	202	unsigned char gsquery; /* check source marks? */
	203	unsigned char crcount;
	204	};
	205
	206	/* V3 exponential field decoding */
	207	#define IGMPV3_MASK(value, nb) ((nb)>=32 ? (value) : ((1<<(nb))-1) & (value))
	208	#define IGMPV3_EXP(thresh, nbmant, nbexp, value) \
	209	((value) < (thresh) ? (value) : \
fb47ddb2	210	((IGMPV3_MASK(value, nbmant) \| (1<<(nbmant))) << \
1da177e4 LT	211	(IGMPV3_MASK((value) >> (nbmant), nbexp) + (nbexp))))
	212
	213	#define IGMPV3_QQIC(value) IGMPV3_EXP(0x80, 4, 3, value)
	214	#define IGMPV3_MRC(value) IGMPV3_EXP(0x80, 4, 3, value)
	215
a60c4923	216	extern int ip_check_mc(struct in_device *dev, __be32 mc_addr, __be32 src_addr, u16 proto);
1da177e4 LT	217	extern int igmp_rcv(struct sk_buff *);
	218	extern int ip_mc_join_group(struct sock sk, struct ip_mreqn imr);
	219	extern int ip_mc_leave_group(struct sock sk, struct ip_mreqn imr);
	220	extern void ip_mc_drop_socket(struct sock *sk);
	221	extern int ip_mc_source(int add, int omode, struct sock *sk,
	222	struct ip_mreq_source *mreqs, int ifindex);
	223	extern int ip_mc_msfilter(struct sock sk, struct ip_msfilter msf,int ifindex);
	224	extern int ip_mc_msfget(struct sock sk, struct ip_msfilter msf,
	225	struct ip_msfilter __user optval, int __user optlen);
	226	extern int ip_mc_gsfget(struct sock sk, struct group_filter gsf,
	227	struct group_filter __user optval, int __user optlen);
c0cda068	228	extern int ip_mc_sf_allow(struct sock *sk, __be32 local, __be32 rmt, int dif);
1da177e4 LT	229	extern void ip_mc_init_dev(struct in_device *);
	230	extern void ip_mc_destroy_dev(struct in_device *);
	231	extern void ip_mc_up(struct in_device *);
	232	extern void ip_mc_down(struct in_device *);
75c78500 MS	233	extern void ip_mc_unmap(struct in_device *);
75c78500 MS	234	extern void ip_mc_remap(struct in_device *);
8f935bbd AV	235	extern void ip_mc_dec_group(struct in_device *in_dev, __be32 addr);
8f935bbd AV	236	extern void ip_mc_inc_group(struct in_device *in_dev, __be32 addr);
a816c7c7 JV	237	extern void ip_mc_rejoin_group(struct ip_mc_list *im);
a816c7c7 JV	238
1da177e4 LT	239	#endif
1da177e4 LT	240	#endif