blob: fe158e0e20e6a5b7957d78925c9ed2a044f0f557 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * Linux NET3: Internet Group Management Protocol [IGMP]
3 *
4 * Authors:
Alan Cox113aa832008-10-13 19:01:08 -07005 * Alan Cox <alan@lxorguk.ukuu.org.uk>
Linus Torvalds1da177e2005-04-16 15:20:36 -07006 *
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
Jaswinder Singh Rajputde8b0bc2009-01-30 21:36:04 +053019#include <linux/types.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070020#include <asm/byteorder.h>
21
22/*
23 * IGMP protocol structures
24 */
25
26/*
27 * Header in on cable format
28 */
29
30struct igmphdr
31{
32 __u8 type;
33 __u8 code; /* For newer IGMP */
Al Viro9981a0e2006-11-14 21:24:30 -080034 __sum16 csum;
Al Viro942bf922006-09-27 18:30:28 -070035 __be32 group;
Linus Torvalds1da177e2005-04-16 15:20:36 -070036};
37
38/* V3 group record types [grec_type] */
39#define IGMPV3_MODE_IS_INCLUDE 1
40#define IGMPV3_MODE_IS_EXCLUDE 2
41#define IGMPV3_CHANGE_TO_INCLUDE 3
42#define IGMPV3_CHANGE_TO_EXCLUDE 4
43#define IGMPV3_ALLOW_NEW_SOURCES 5
44#define IGMPV3_BLOCK_OLD_SOURCES 6
45
46struct igmpv3_grec {
47 __u8 grec_type;
48 __u8 grec_auxwords;
Al Viro942bf922006-09-27 18:30:28 -070049 __be16 grec_nsrcs;
50 __be32 grec_mca;
51 __be32 grec_src[0];
Linus Torvalds1da177e2005-04-16 15:20:36 -070052};
53
54struct igmpv3_report {
55 __u8 type;
56 __u8 resv1;
Al Viro942bf922006-09-27 18:30:28 -070057 __be16 csum;
58 __be16 resv2;
59 __be16 ngrec;
Linus Torvalds1da177e2005-04-16 15:20:36 -070060 struct igmpv3_grec grec[0];
61};
62
63struct igmpv3_query {
64 __u8 type;
65 __u8 code;
Al Viro942bf922006-09-27 18:30:28 -070066 __be16 csum;
67 __be32 group;
Linus Torvalds1da177e2005-04-16 15:20:36 -070068#if defined(__LITTLE_ENDIAN_BITFIELD)
69 __u8 qrv:3,
70 suppress:1,
71 resv:4;
72#elif defined(__BIG_ENDIAN_BITFIELD)
73 __u8 resv:4,
74 suppress:1,
75 qrv:3;
76#else
77#error "Please fix <asm/byteorder.h>"
78#endif
79 __u8 qqic;
Al Viro942bf922006-09-27 18:30:28 -070080 __be16 nsrcs;
81 __be32 srcs[0];
Linus Torvalds1da177e2005-04-16 15:20:36 -070082};
83
84#define IGMP_HOST_MEMBERSHIP_QUERY 0x11 /* From RFC1112 */
85#define IGMP_HOST_MEMBERSHIP_REPORT 0x12 /* Ditto */
86#define IGMP_DVMRP 0x13 /* DVMRP routing */
87#define IGMP_PIM 0x14 /* PIM routing */
88#define IGMP_TRACE 0x15
89#define IGMPV2_HOST_MEMBERSHIP_REPORT 0x16 /* V2 version of 0x11 */
90#define IGMP_HOST_LEAVE_MESSAGE 0x17
91#define IGMPV3_HOST_MEMBERSHIP_REPORT 0x22 /* V3 version of 0x11 */
92
93#define IGMP_MTRACE_RESP 0x1e
94#define IGMP_MTRACE 0x1f
95
96
97/*
98 * Use the BSD names for these for compatibility
99 */
100
101#define IGMP_DELAYING_MEMBER 0x01
102#define IGMP_IDLE_MEMBER 0x02
103#define IGMP_LAZY_MEMBER 0x03
104#define IGMP_SLEEPING_MEMBER 0x04
105#define IGMP_AWAKENING_MEMBER 0x05
106
107#define IGMP_MINLEN 8
108
109#define IGMP_MAX_HOST_REPORT_DELAY 10 /* max delay for response to */
110 /* query (in seconds) */
111
112#define IGMP_TIMER_SCALE 10 /* denotes that the igmphdr->timer field */
113 /* specifies time in 10th of seconds */
114
115#define IGMP_AGE_THRESHOLD 400 /* If this host don't hear any IGMP V1 */
116 /* message in this period of time, */
117 /* revert to IGMP v2 router. */
118
119#define IGMP_ALL_HOSTS htonl(0xE0000001L)
120#define IGMP_ALL_ROUTER htonl(0xE0000002L)
121#define IGMPV3_ALL_MCR htonl(0xE0000016L)
122#define IGMP_LOCAL_GROUP htonl(0xE0000000L)
123#define IGMP_LOCAL_GROUP_MASK htonl(0xFFFFFF00L)
124
125/*
126 * struct for keeping the multicast list in
127 */
128
129#ifdef __KERNEL__
130#include <linux/skbuff.h>
Al Virod7fe0f22006-12-03 23:15:30 -0500131#include <linux/timer.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -0700132#include <linux/in.h>
133
Joe Perchescc32e052008-03-23 22:05:44 -0700134static inline struct igmphdr *igmp_hdr(const struct sk_buff *skb)
135{
136 return (struct igmphdr *)skb_transport_header(skb);
137}
138
139static inline struct igmpv3_report *
140 igmpv3_report_hdr(const struct sk_buff *skb)
141{
142 return (struct igmpv3_report *)skb_transport_header(skb);
143}
144
145static inline struct igmpv3_query *
146 igmpv3_query_hdr(const struct sk_buff *skb)
147{
148 return (struct igmpv3_query *)skb_transport_header(skb);
149}
150
Arnaldo Carvalho de Melo20380732005-08-16 02:18:02 -0300151extern int sysctl_igmp_max_memberships;
152extern int sysctl_igmp_max_msf;
153
Linus Torvalds1da177e2005-04-16 15:20:36 -0700154struct ip_sf_socklist
155{
156 unsigned int sl_max;
157 unsigned int sl_count;
Al Viroea4d9e72006-09-27 18:30:52 -0700158 __be32 sl_addr[0];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700159};
160
161#define IP_SFLSIZE(count) (sizeof(struct ip_sf_socklist) + \
Al Viro63007722006-09-27 18:31:32 -0700162 (count) * sizeof(__be32))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700163
164#define IP_SFBLOCK 10 /* allocate this many at once */
165
166/* ip_mc_socklist is real list now. Speed is not argument;
167 this list never used in fast path code
168 */
169
170struct ip_mc_socklist
171{
172 struct ip_mc_socklist *next;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700173 struct ip_mreqn multi;
174 unsigned int sfmode; /* MCAST_{INCLUDE,EXCLUDE} */
175 struct ip_sf_socklist *sflist;
176};
177
178struct ip_sf_list
179{
180 struct ip_sf_list *sf_next;
Al Viroea4d9e72006-09-27 18:30:52 -0700181 __be32 sf_inaddr;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700182 unsigned long sf_count[2]; /* include/exclude counts */
183 unsigned char sf_gsresp; /* include in g & s response? */
184 unsigned char sf_oldin; /* change state */
185 unsigned char sf_crcount; /* retrans. left to send */
186};
187
188struct ip_mc_list
189{
190 struct in_device *interface;
Alexey Dobriyan338fcf92006-06-05 21:04:39 -0700191 __be32 multiaddr;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700192 struct ip_sf_list *sources;
193 struct ip_sf_list *tomb;
194 unsigned int sfmode;
195 unsigned long sfcount[2];
196 struct ip_mc_list *next;
197 struct timer_list timer;
198 int users;
199 atomic_t refcnt;
200 spinlock_t lock;
201 char tm_running;
202 char reporter;
203 char unsolicit_count;
204 char loaded;
205 unsigned char gsquery; /* check source marks? */
206 unsigned char crcount;
207};
208
209/* V3 exponential field decoding */
210#define IGMPV3_MASK(value, nb) ((nb)>=32 ? (value) : ((1<<(nb))-1) & (value))
211#define IGMPV3_EXP(thresh, nbmant, nbexp, value) \
212 ((value) < (thresh) ? (value) : \
David L Stevensfb47ddb2006-11-19 10:38:39 -0800213 ((IGMPV3_MASK(value, nbmant) | (1<<(nbmant))) << \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700214 (IGMPV3_MASK((value) >> (nbmant), nbexp) + (nbexp))))
215
216#define IGMPV3_QQIC(value) IGMPV3_EXP(0x80, 4, 3, value)
217#define IGMPV3_MRC(value) IGMPV3_EXP(0x80, 4, 3, value)
218
Al Viroa60c4922006-09-26 21:28:34 -0700219extern int ip_check_mc(struct in_device *dev, __be32 mc_addr, __be32 src_addr, u16 proto);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700220extern int igmp_rcv(struct sk_buff *);
221extern int ip_mc_join_group(struct sock *sk, struct ip_mreqn *imr);
222extern int ip_mc_leave_group(struct sock *sk, struct ip_mreqn *imr);
223extern void ip_mc_drop_socket(struct sock *sk);
224extern int ip_mc_source(int add, int omode, struct sock *sk,
225 struct ip_mreq_source *mreqs, int ifindex);
226extern int ip_mc_msfilter(struct sock *sk, struct ip_msfilter *msf,int ifindex);
227extern int ip_mc_msfget(struct sock *sk, struct ip_msfilter *msf,
228 struct ip_msfilter __user *optval, int __user *optlen);
229extern int ip_mc_gsfget(struct sock *sk, struct group_filter *gsf,
230 struct group_filter __user *optval, int __user *optlen);
Al Viroc0cda062006-09-27 18:31:10 -0700231extern int ip_mc_sf_allow(struct sock *sk, __be32 local, __be32 rmt, int dif);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700232extern void ip_mc_init_dev(struct in_device *);
233extern void ip_mc_destroy_dev(struct in_device *);
234extern void ip_mc_up(struct in_device *);
235extern void ip_mc_down(struct in_device *);
Moni Shoua75c78502009-09-15 02:37:40 -0700236extern void ip_mc_unmap(struct in_device *);
237extern void ip_mc_remap(struct in_device *);
Al Viro8f935bb2006-09-27 18:30:07 -0700238extern void ip_mc_dec_group(struct in_device *in_dev, __be32 addr);
239extern void ip_mc_inc_group(struct in_device *in_dev, __be32 addr);
Jay Vosburgha816c7c2007-02-28 17:03:37 -0800240extern void ip_mc_rejoin_group(struct ip_mc_list *im);
241
Linus Torvalds1da177e2005-04-16 15:20:36 -0700242#endif
243#endif