xref: /netbsd-src/sys/netinet6/mld6.c (revision d710132b4b8ce7f7cccaaf660cb16aa16b4077a0)
1 /*	$NetBSD: mld6.c,v 1.22 2003/06/06 08:13:44 itojun Exp $	*/
2 /*	$KAME: mld6.c,v 1.25 2001/01/16 14:14:18 itojun Exp $	*/
3 
4 /*
5  * Copyright (C) 1998 WIDE Project.
6  * All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice, this list of conditions and the following disclaimer.
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in the
15  *    documentation and/or other materials provided with the distribution.
16  * 3. Neither the name of the project nor the names of its contributors
17  *    may be used to endorse or promote products derived from this software
18  *    without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND
21  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23  * ARE DISCLAIMED.  IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE
24  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30  * SUCH DAMAGE.
31  */
32 
33 /*
34  * Copyright (c) 1988 Stephen Deering.
35  * Copyright (c) 1992, 1993
36  *	The Regents of the University of California.  All rights reserved.
37  *
38  * This code is derived from software contributed to Berkeley by
39  * Stephen Deering of Stanford University.
40  *
41  * Redistribution and use in source and binary forms, with or without
42  * modification, are permitted provided that the following conditions
43  * are met:
44  * 1. Redistributions of source code must retain the above copyright
45  *    notice, this list of conditions and the following disclaimer.
46  * 2. Redistributions in binary form must reproduce the above copyright
47  *    notice, this list of conditions and the following disclaimer in the
48  *    documentation and/or other materials provided with the distribution.
49  * 3. All advertising materials mentioning features or use of this software
50  *    must display the following acknowledgement:
51  *	This product includes software developed by the University of
52  *	California, Berkeley and its contributors.
53  * 4. Neither the name of the University nor the names of its contributors
54  *    may be used to endorse or promote products derived from this software
55  *    without specific prior written permission.
56  *
57  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
58  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
59  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
60  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
61  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
62  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
63  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
64  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
65  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
66  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
67  * SUCH DAMAGE.
68  *
69  *	@(#)igmp.c	8.1 (Berkeley) 7/19/93
70  */
71 
72 #include <sys/cdefs.h>
73 __KERNEL_RCSID(0, "$NetBSD: mld6.c,v 1.22 2003/06/06 08:13:44 itojun Exp $");
74 
75 #include "opt_inet.h"
76 
77 #include <sys/param.h>
78 #include <sys/systm.h>
79 #include <sys/mbuf.h>
80 #include <sys/socket.h>
81 #include <sys/protosw.h>
82 #include <sys/syslog.h>
83 
84 #include <net/if.h>
85 
86 #include <netinet/in.h>
87 #include <netinet/in_var.h>
88 #include <netinet/ip6.h>
89 #include <netinet6/ip6_var.h>
90 #include <netinet/icmp6.h>
91 #include <netinet6/mld6_var.h>
92 
93 #include <net/net_osdep.h>
94 
95 /*
96  * Protocol constants
97  */
98 
99 /* denotes that the MLD max response delay field specifies time in milliseconds */
100 #define MLD_TIMER_SCALE	1000
101 /*
102  * time between repetitions of a node's initial report of interest in a
103  * multicast address(in seconds)
104  */
105 #define MLD_UNSOLICITED_REPORT_INTERVAL	10
106 
107 static struct ip6_pktopts ip6_opts;
108 static int mld_timers_are_running;
109 /* XXX: These are necessary for KAME's link-local hack */
110 static struct in6_addr mld_all_nodes_linklocal = IN6ADDR_LINKLOCAL_ALLNODES_INIT;
111 static struct in6_addr mld_all_routers_linklocal = IN6ADDR_LINKLOCAL_ALLROUTERS_INIT;
112 
113 static void mld6_sendpkt __P((struct in6_multi *, int, const struct in6_addr *));
114 
115 void
116 mld6_init()
117 {
118 	static u_int8_t hbh_buf[8];
119 	struct ip6_hbh *hbh = (struct ip6_hbh *)hbh_buf;
120 	u_int16_t rtalert_code = htons((u_int16_t)IP6OPT_RTALERT_MLD);
121 
122 	mld_timers_are_running = 0;
123 
124 	/* ip6h_nxt will be fill in later */
125 	hbh->ip6h_len = 0;	/* (8 >> 3) - 1 */
126 
127 	/* XXX: grotty hard coding... */
128 	hbh_buf[2] = IP6OPT_PADN;	/* 2 byte padding */
129 	hbh_buf[3] = 0;
130 	hbh_buf[4] = IP6OPT_RTALERT;
131 	hbh_buf[5] = IP6OPT_RTALERT_LEN - 2;
132 	bcopy((caddr_t)&rtalert_code, &hbh_buf[6], sizeof(u_int16_t));
133 
134 	ip6_opts.ip6po_hbh = hbh;
135 	/* We will specify the hoplimit by a multicast option. */
136 	ip6_opts.ip6po_hlim = -1;
137 }
138 
139 void
140 mld6_start_listening(in6m)
141 	struct in6_multi *in6m;
142 {
143 	int s = splsoftnet();
144 
145 	/*
146 	 * RFC2710 page 10:
147 	 * The node never sends a Report or Done for the link-scope all-nodes
148 	 * address.
149 	 * MLD messages are never sent for multicast addresses whose scope is 0
150 	 * (reserved) or 1 (node-local).
151 	 */
152 	mld_all_nodes_linklocal.s6_addr16[1] =
153 	    htons(in6m->in6m_ifp->if_index); /* XXX */
154 	if (IN6_ARE_ADDR_EQUAL(&in6m->in6m_addr, &mld_all_nodes_linklocal) ||
155 	    IPV6_ADDR_MC_SCOPE(&in6m->in6m_addr) < IPV6_ADDR_SCOPE_LINKLOCAL) {
156 		in6m->in6m_timer = 0;
157 		in6m->in6m_state = MLD_OTHERLISTENER;
158 	} else {
159 		mld6_sendpkt(in6m, MLD_LISTENER_REPORT, NULL);
160 		in6m->in6m_timer =
161 		    MLD_RANDOM_DELAY(MLD_UNSOLICITED_REPORT_INTERVAL *
162 		    PR_FASTHZ);
163 		in6m->in6m_state = MLD_IREPORTEDLAST;
164 		mld_timers_are_running = 1;
165 	}
166 	splx(s);
167 }
168 
169 void
170 mld6_stop_listening(in6m)
171 	struct in6_multi *in6m;
172 {
173 	mld_all_nodes_linklocal.s6_addr16[1] =
174 	    htons(in6m->in6m_ifp->if_index); /* XXX */
175 	mld_all_routers_linklocal.s6_addr16[1] =
176 	    htons(in6m->in6m_ifp->if_index); /* XXX: necessary when mrouting */
177 
178 	if (in6m->in6m_state == MLD_IREPORTEDLAST &&
179 	    (!IN6_ARE_ADDR_EQUAL(&in6m->in6m_addr, &mld_all_nodes_linklocal)) &&
180 	    IPV6_ADDR_MC_SCOPE(&in6m->in6m_addr) > IPV6_ADDR_SCOPE_NODELOCAL)
181 		mld6_sendpkt(in6m, MLD_LISTENER_DONE,
182 		    &mld_all_routers_linklocal);
183 }
184 
185 void
186 mld6_input(m, off)
187 	struct mbuf *m;
188 	int off;
189 {
190 	struct ip6_hdr *ip6 = mtod(m, struct ip6_hdr *);
191 	struct mld_hdr *mldh;
192 	struct ifnet *ifp = m->m_pkthdr.rcvif;
193 	struct in6_multi *in6m;
194 	struct in6_ifaddr *ia;
195 	int timer;		/* timer value in the MLD query header */
196 
197 	IP6_EXTHDR_GET(mldh, struct mld_hdr *, m, off, sizeof(*mldh));
198 	if (mldh == NULL) {
199 		icmp6stat.icp6s_tooshort++;
200 		return;
201 	}
202 
203 	/* source address validation */
204 	ip6 = mtod(m, struct ip6_hdr *);/* in case mpullup */
205 	if (!IN6_IS_ADDR_LINKLOCAL(&ip6->ip6_src)) {
206 #if 0
207 		log(LOG_ERR,
208 		    "mld_input: src %s is not link-local (grp=%s)\n",
209 		    ip6_sprintf(&ip6->ip6_src),
210 		    ip6_sprintf(&mldh->mld_addr));
211 #endif
212 		/*
213 		 * spec (RFC2710) does not explicitly
214 		 * specify to discard the packet from a non link-local
215 		 * source address. But we believe it's expected to do so.
216 		 * XXX: do we have to allow :: as source?
217 		 */
218 		m_freem(m);
219 		return;
220 	}
221 
222 	/*
223 	 * In the MLD6 specification, there are 3 states and a flag.
224 	 *
225 	 * In Non-Listener state, we simply don't have a membership record.
226 	 * In Delaying Listener state, our timer is running (in6m->in6m_timer)
227 	 * In Idle Listener state, our timer is not running (in6m->in6m_timer==0)
228 	 *
229 	 * The flag is in6m->in6m_state, it is set to MLD_OTHERLISTENER if
230 	 * we have heard a report from another member, or MLD_IREPORTEDLAST
231 	 * if we sent the last report.
232 	 */
233 	switch (mldh->mld_type) {
234 	case MLD_LISTENER_QUERY:
235 		if (ifp->if_flags & IFF_LOOPBACK)
236 			break;
237 
238 		if (!IN6_IS_ADDR_UNSPECIFIED(&mldh->mld_addr) &&
239 		    !IN6_IS_ADDR_MULTICAST(&mldh->mld_addr))
240 			break;	/* print error or log stat? */
241 		if (IN6_IS_ADDR_MC_LINKLOCAL(&mldh->mld_addr))
242 			mldh->mld_addr.s6_addr16[1] =
243 			    htons(ifp->if_index); /* XXX */
244 
245 		/*
246 		 * - Start the timers in all of our membership records
247 		 *   that the query applies to for the interface on
248 		 *   which the query arrived excl. those that belong
249 		 *   to the "all-nodes" group (ff02::1).
250 		 * - Restart any timer that is already running but has
251 		 *   A value longer than the requested timeout.
252 		 * - Use the value specified in the query message as
253 		 *   the maximum timeout.
254 		 */
255 		IFP_TO_IA6(ifp, ia);
256 		if (ia == NULL)
257 			break;
258 
259 		/*
260 		 * XXX: System timer resolution is too low to handle Max
261 		 * Response Delay, so set 1 to the internal timer even if
262 		 * the calculated value equals to zero when Max Response
263 		 * Delay is positive.
264 		 */
265 		timer = ntohs(mldh->mld_maxdelay)*PR_FASTHZ/MLD_TIMER_SCALE;
266 		if (timer == 0 && mldh->mld_maxdelay)
267 			timer = 1;
268 		mld_all_nodes_linklocal.s6_addr16[1] =
269 			htons(ifp->if_index); /* XXX */
270 
271 		for (in6m = ia->ia6_multiaddrs.lh_first;
272 		     in6m;
273 		     in6m = in6m->in6m_entry.le_next)
274 		{
275 			if (IN6_ARE_ADDR_EQUAL(&in6m->in6m_addr,
276 						&mld_all_nodes_linklocal) ||
277 			    IPV6_ADDR_MC_SCOPE(&in6m->in6m_addr) <
278 			    IPV6_ADDR_SCOPE_LINKLOCAL)
279 				continue;
280 
281 			if (IN6_IS_ADDR_UNSPECIFIED(&mldh->mld_addr) ||
282 			    IN6_ARE_ADDR_EQUAL(&mldh->mld_addr,
283 						&in6m->in6m_addr))
284 			{
285 				if (timer == 0) {
286 					/* send a report immediately */
287 					mld6_sendpkt(in6m, MLD_LISTENER_REPORT,
288 					    NULL);
289 					in6m->in6m_timer = 0; /* reset timer */
290 					in6m->in6m_state = MLD_IREPORTEDLAST;
291 				}
292 				else if (in6m->in6m_timer == 0 || /*idle state*/
293 				    in6m->in6m_timer > timer) {
294 					in6m->in6m_timer =
295 					    MLD_RANDOM_DELAY(timer);
296 					mld_timers_are_running = 1;
297 				}
298 			}
299 		}
300 
301 		if (IN6_IS_ADDR_MC_LINKLOCAL(&mldh->mld_addr))
302 			mldh->mld_addr.s6_addr16[1] = 0; /* XXX */
303 		break;
304 	case MLD_LISTENER_REPORT:
305 		/*
306 		 * For fast leave to work, we have to know that we are the
307 		 * last person to send a report for this group.  Reports
308 		 * can potentially get looped back if we are a multicast
309 		 * router, so discard reports sourced by me.
310 		 * Note that it is impossible to check IFF_LOOPBACK flag of
311 		 * ifp for this purpose, since ip6_mloopback pass the physical
312 		 * interface to looutput.
313 		 */
314 		if (m->m_flags & M_LOOP) /* XXX: grotty flag, but efficient */
315 			break;
316 
317 		if (!IN6_IS_ADDR_MULTICAST(&mldh->mld_addr))
318 			break;
319 
320 		if (IN6_IS_ADDR_MC_LINKLOCAL(&mldh->mld_addr))
321 			mldh->mld_addr.s6_addr16[1] =
322 				htons(ifp->if_index); /* XXX */
323 		/*
324 		 * If we belong to the group being reported, stop
325 		 * our timer for that group.
326 		 */
327 		IN6_LOOKUP_MULTI(mldh->mld_addr, ifp, in6m);
328 		if (in6m) {
329 			in6m->in6m_timer = 0; /* transit to idle state */
330 			in6m->in6m_state = MLD_OTHERLISTENER; /* clear flag */
331 		}
332 
333 		if (IN6_IS_ADDR_MC_LINKLOCAL(&mldh->mld_addr))
334 			mldh->mld_addr.s6_addr16[1] = 0; /* XXX */
335 		break;
336 	default:		/* this is impossible */
337 #if 0
338 		/*
339 		 * this case should be impossible because of filtering in
340 		 * icmp6_input().  But we explicitly disabled this part
341 		 * just in case.
342 		 */
343 		log(LOG_ERR, "mld_input: illegal type(%d)", mldh->mld6_type);
344 #endif
345 		break;
346 	}
347 
348 	m_freem(m);
349 }
350 
351 void
352 mld6_fasttimeo()
353 {
354 	struct in6_multi *in6m;
355 	struct in6_multistep step;
356 	int s;
357 	/*
358 	 * Quick check to see if any work needs to be done, in order
359 	 * to minimize the overhead of fasttimo processing.
360 	 */
361 	if (!mld_timers_are_running)
362 		return;
363 
364 	s = splsoftnet();
365 	mld_timers_are_running = 0;
366 	IN6_FIRST_MULTI(step, in6m);
367 	while (in6m != NULL) {
368 		if (in6m->in6m_timer == 0) {
369 			/* do nothing */
370 		} else if (--in6m->in6m_timer == 0) {
371 			mld6_sendpkt(in6m, MLD_LISTENER_REPORT, NULL);
372 			in6m->in6m_state = MLD_IREPORTEDLAST;
373 		} else {
374 			mld_timers_are_running = 1;
375 		}
376 		IN6_NEXT_MULTI(step, in6m);
377 	}
378 	splx(s);
379 }
380 
381 static void
382 mld6_sendpkt(in6m, type, dst)
383 	struct in6_multi *in6m;
384 	int type;
385 	const struct in6_addr *dst;
386 {
387 	struct mbuf *mh, *md;
388 	struct mld_hdr *mldh;
389 	struct ip6_hdr *ip6;
390 	struct ip6_moptions im6o;
391 	struct in6_ifaddr *ia;
392 	struct ifnet *ifp = in6m->in6m_ifp;
393 	int ignflags;
394 
395 	/*
396 	 * At first, find a link local address on the outgoing interface
397 	 * to use as the source address of the MLD packet.
398 	 * We do not reject tentative addresses for MLD report to deal with
399 	 * the case where we first join a link-local address.
400 	 */
401 	ignflags = (IN6_IFF_NOTREADY|IN6_IFF_ANYCAST) & ~IN6_IFF_TENTATIVE;
402 	if ((ia = in6ifa_ifpforlinklocal(ifp, ignflags)) == NULL)
403 		return;
404 	if ((ia->ia6_flags & IN6_IFF_TENTATIVE))
405 		ia = NULL;
406 
407 	/*
408 	 * Allocate mbufs to store ip6 header and MLD header.
409 	 * We allocate 2 mbufs and make chain in advance because
410 	 * it is more convenient when inserting the hop-by-hop option later.
411 	 */
412 	MGETHDR(mh, M_DONTWAIT, MT_HEADER);
413 	if (mh == NULL)
414 		return;
415 	MGET(md, M_DONTWAIT, MT_DATA);
416 	if (md == NULL) {
417 		m_free(mh);
418 		return;
419 	}
420 	mh->m_next = md;
421 
422 	mh->m_pkthdr.rcvif = NULL;
423 	mh->m_pkthdr.len = sizeof(struct ip6_hdr) + sizeof(struct mld_hdr);
424 	mh->m_len = sizeof(struct ip6_hdr);
425 	MH_ALIGN(mh, sizeof(struct ip6_hdr));
426 
427 	/* fill in the ip6 header */
428 	ip6 = mtod(mh, struct ip6_hdr *);
429 	ip6->ip6_flow = 0;
430 	ip6->ip6_vfc &= ~IPV6_VERSION_MASK;
431 	ip6->ip6_vfc |= IPV6_VERSION;
432 	/* ip6_plen will be set later */
433 	ip6->ip6_nxt = IPPROTO_ICMPV6;
434 	/* ip6_hlim will be set by im6o.im6o_multicast_hlim */
435 	ip6->ip6_src = ia ? ia->ia_addr.sin6_addr : in6addr_any;
436 	ip6->ip6_dst = dst ? *dst : in6m->in6m_addr;
437 
438 	/* fill in the MLD header */
439 	md->m_len = sizeof(struct mld_hdr);
440 	mldh = mtod(md, struct mld_hdr *);
441 	mldh->mld_type = type;
442 	mldh->mld_code = 0;
443 	mldh->mld_cksum = 0;
444 	/* XXX: we assume the function will not be called for query messages */
445 	mldh->mld_maxdelay = 0;
446 	mldh->mld_reserved = 0;
447 	mldh->mld_addr = in6m->in6m_addr;
448 	if (IN6_IS_ADDR_MC_LINKLOCAL(&mldh->mld_addr))
449 		mldh->mld_addr.s6_addr16[1] = 0; /* XXX */
450 	mldh->mld_cksum = in6_cksum(mh, IPPROTO_ICMPV6, sizeof(struct ip6_hdr),
451 	    sizeof(struct mld_hdr));
452 
453 	/* construct multicast option */
454 	bzero(&im6o, sizeof(im6o));
455 	im6o.im6o_multicast_ifp = ifp;
456 	im6o.im6o_multicast_hlim = 1;
457 
458 	/*
459 	 * Request loopback of the report if we are acting as a multicast
460 	 * router, so that the process-level routing daemon can hear it.
461 	 */
462 	im6o.im6o_multicast_loop = (ip6_mrouter != NULL);
463 
464 	/* increment output statictics */
465 	icmp6stat.icp6s_outhist[type]++;
466 	icmp6_ifstat_inc(ifp, ifs6_out_msg);
467 	switch (type) {
468 	case MLD_LISTENER_QUERY:
469 		icmp6_ifstat_inc(ifp, ifs6_out_mldquery);
470 		break;
471 	case MLD_LISTENER_REPORT:
472 		icmp6_ifstat_inc(ifp, ifs6_out_mldreport);
473 		break;
474 	case MLD_LISTENER_DONE:
475 		icmp6_ifstat_inc(ifp, ifs6_out_mlddone);
476 		break;
477 	}
478 
479 	ip6_output(mh, &ip6_opts, NULL, ia ? 0 : IPV6_UNSPECSRC, &im6o, NULL);
480 }
481