]> bbs.cooldavid.org Git - net-next-2.6.git/blame - include/linux/igmp.h
[IPV4]: struct ip_sf_list and struct ip_sf_socklist annotated
[net-next-2.6.git] / include / linux / igmp.h
CommitLineData
1da177e4
LT
1/*
2 * Linux NET3: Internet Group Management Protocol [IGMP]
3 *
4 * Authors:
5 * Alan Cox <Alan.Cox@linux.org>
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
19#include <asm/byteorder.h>
20
21/*
22 * IGMP protocol structures
23 */
24
25/*
26 * Header in on cable format
27 */
28
29struct igmphdr
30{
31 __u8 type;
32 __u8 code; /* For newer IGMP */
942bf921
AV
33 __be16 csum;
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
45struct 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
53struct 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
62struct igmpv3_query {
63 __u8 type;
64 __u8 code;
942bf921
AV
65 __be16 csum;
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;
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>
130#include <linux/in.h>
131
20380731
ACM
132extern int sysctl_igmp_max_memberships;
133extern int sysctl_igmp_max_msf;
134
1da177e4
LT
135struct ip_sf_socklist
136{
137 unsigned int sl_max;
138 unsigned int sl_count;
ea4d9e72 139 __be32 sl_addr[0];
1da177e4
LT
140};
141
142#define IP_SFLSIZE(count) (sizeof(struct ip_sf_socklist) + \
143 (count) * sizeof(__u32))
144
145#define IP_SFBLOCK 10 /* allocate this many at once */
146
147/* ip_mc_socklist is real list now. Speed is not argument;
148 this list never used in fast path code
149 */
150
151struct ip_mc_socklist
152{
153 struct ip_mc_socklist *next;
1da177e4
LT
154 struct ip_mreqn multi;
155 unsigned int sfmode; /* MCAST_{INCLUDE,EXCLUDE} */
156 struct ip_sf_socklist *sflist;
157};
158
159struct ip_sf_list
160{
161 struct ip_sf_list *sf_next;
ea4d9e72 162 __be32 sf_inaddr;
1da177e4
LT
163 unsigned long sf_count[2]; /* include/exclude counts */
164 unsigned char sf_gsresp; /* include in g & s response? */
165 unsigned char sf_oldin; /* change state */
166 unsigned char sf_crcount; /* retrans. left to send */
167};
168
169struct ip_mc_list
170{
171 struct in_device *interface;
338fcf98 172 __be32 multiaddr;
1da177e4
LT
173 struct ip_sf_list *sources;
174 struct ip_sf_list *tomb;
175 unsigned int sfmode;
176 unsigned long sfcount[2];
177 struct ip_mc_list *next;
178 struct timer_list timer;
179 int users;
180 atomic_t refcnt;
181 spinlock_t lock;
182 char tm_running;
183 char reporter;
184 char unsolicit_count;
185 char loaded;
186 unsigned char gsquery; /* check source marks? */
187 unsigned char crcount;
188};
189
190/* V3 exponential field decoding */
191#define IGMPV3_MASK(value, nb) ((nb)>=32 ? (value) : ((1<<(nb))-1) & (value))
192#define IGMPV3_EXP(thresh, nbmant, nbexp, value) \
193 ((value) < (thresh) ? (value) : \
194 ((IGMPV3_MASK(value, nbmant) | (1<<(nbmant+nbexp))) << \
195 (IGMPV3_MASK((value) >> (nbmant), nbexp) + (nbexp))))
196
197#define IGMPV3_QQIC(value) IGMPV3_EXP(0x80, 4, 3, value)
198#define IGMPV3_MRC(value) IGMPV3_EXP(0x80, 4, 3, value)
199
a60c4923 200extern int ip_check_mc(struct in_device *dev, __be32 mc_addr, __be32 src_addr, u16 proto);
1da177e4
LT
201extern int igmp_rcv(struct sk_buff *);
202extern int ip_mc_join_group(struct sock *sk, struct ip_mreqn *imr);
203extern int ip_mc_leave_group(struct sock *sk, struct ip_mreqn *imr);
204extern void ip_mc_drop_socket(struct sock *sk);
205extern int ip_mc_source(int add, int omode, struct sock *sk,
206 struct ip_mreq_source *mreqs, int ifindex);
207extern int ip_mc_msfilter(struct sock *sk, struct ip_msfilter *msf,int ifindex);
208extern int ip_mc_msfget(struct sock *sk, struct ip_msfilter *msf,
209 struct ip_msfilter __user *optval, int __user *optlen);
210extern int ip_mc_gsfget(struct sock *sk, struct group_filter *gsf,
211 struct group_filter __user *optval, int __user *optlen);
212extern int ip_mc_sf_allow(struct sock *sk, u32 local, u32 rmt, int dif);
213extern void ip_mr_init(void);
214extern void ip_mc_init_dev(struct in_device *);
215extern void ip_mc_destroy_dev(struct in_device *);
216extern void ip_mc_up(struct in_device *);
217extern void ip_mc_down(struct in_device *);
8f935bbd
AV
218extern void ip_mc_dec_group(struct in_device *in_dev, __be32 addr);
219extern void ip_mc_inc_group(struct in_device *in_dev, __be32 addr);
1da177e4
LT
220#endif
221#endif