xref: /openbsd/sys/netinet6/mld6.c (revision 610f49f8)
1 /*	$OpenBSD: mld6.c,v 1.12 2002/01/08 04:29:21 itojun Exp $	*/
2 /*	$KAME: mld6.c,v 1.26 2001/02/16 14:50:35 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/param.h>
73 #include <sys/systm.h>
74 #include <sys/mbuf.h>
75 #include <sys/socket.h>
76 #include <sys/protosw.h>
77 #include <sys/syslog.h>
78 #include <dev/rndvar.h>
79 
80 #include <net/if.h>
81 
82 #include <netinet/in.h>
83 #include <netinet/in_var.h>
84 #include <netinet/ip6.h>
85 #include <netinet6/ip6_var.h>
86 #include <netinet/icmp6.h>
87 #include <netinet6/mld6_var.h>
88 
89 /*
90  * Protocol constants
91  */
92 
93 /* denotes that the MLD max response delay field specifies time in milliseconds */
94 #define MLD6_TIMER_SCALE	1000
95 /*
96  * time between repetitions of a node's initial report of interest in a
97  * multicast address(in seconds)
98  */
99 #define MLD6_UNSOLICITED_REPORT_INTERVAL	10
100 
101 static struct ip6_pktopts ip6_opts;
102 static int mld6_timers_are_running;
103 /* XXX: These are necessary for KAME's link-local hack */
104 static struct in6_addr mld6_all_nodes_linklocal = IN6ADDR_LINKLOCAL_ALLNODES_INIT;
105 static struct in6_addr mld6_all_routers_linklocal = IN6ADDR_LINKLOCAL_ALLROUTERS_INIT;
106 
107 static void mld6_sendpkt __P((struct in6_multi *, int, const struct in6_addr *));
108 
109 void
110 mld6_init()
111 {
112 	static u_int8_t hbh_buf[8];
113 	struct ip6_hbh *hbh = (struct ip6_hbh *)hbh_buf;
114 	u_int16_t rtalert_code = htons((u_int16_t)IP6OPT_RTALERT_MLD);
115 
116 	mld6_timers_are_running = 0;
117 
118 	/* ip6h_nxt will be fill in later */
119 	hbh->ip6h_len = 0;	/* (8 >> 3) - 1 */
120 
121 	/* XXX: grotty hard coding... */
122 	hbh_buf[2] = IP6OPT_PADN;	/* 2 byte padding */
123 	hbh_buf[3] = 0;
124 	hbh_buf[4] = IP6OPT_RTALERT;
125 	hbh_buf[5] = IP6OPT_RTALERT_LEN - 2;
126 	bcopy((caddr_t)&rtalert_code, &hbh_buf[6], sizeof(u_int16_t));
127 
128 	ip6_opts.ip6po_hbh = hbh;
129 	/* We will specify the hoplimit by a multicast option. */
130 	ip6_opts.ip6po_hlim = -1;
131 }
132 
133 void
134 mld6_start_listening(in6m)
135 	struct in6_multi *in6m;
136 {
137 	int s = splnet();
138 
139 	/*
140 	 * RFC2710 page 10:
141 	 * The node never sends a Report or Done for the link-scope all-nodes
142 	 * address.
143 	 * MLD messages are never sent for multicast addresses whose scope is 0
144 	 * (reserved) or 1 (node-local).
145 	 */
146 	mld6_all_nodes_linklocal.s6_addr16[1] =
147 		htons(in6m->in6m_ifp->if_index); /* XXX */
148 	if (IN6_ARE_ADDR_EQUAL(&in6m->in6m_addr, &mld6_all_nodes_linklocal) ||
149 	    IPV6_ADDR_MC_SCOPE(&in6m->in6m_addr) < IPV6_ADDR_SCOPE_LINKLOCAL) {
150 		in6m->in6m_timer = 0;
151 		in6m->in6m_state = MLD6_OTHERLISTENER;
152 	} else {
153 		mld6_sendpkt(in6m, MLD6_LISTENER_REPORT, NULL);
154 		in6m->in6m_timer = MLD6_RANDOM_DELAY(
155 			MLD6_UNSOLICITED_REPORT_INTERVAL * PR_FASTHZ);
156 		in6m->in6m_state = MLD6_IREPORTEDLAST;
157 		mld6_timers_are_running = 1;
158 	}
159 	splx(s);
160 }
161 
162 void
163 mld6_stop_listening(in6m)
164 	struct in6_multi *in6m;
165 {
166 	mld6_all_nodes_linklocal.s6_addr16[1] =
167 		htons(in6m->in6m_ifp->if_index); /* XXX */
168 	mld6_all_routers_linklocal.s6_addr16[1] =
169 		htons(in6m->in6m_ifp->if_index); /* XXX: necessary when mrouting */
170 
171 	if (in6m->in6m_state == MLD6_IREPORTEDLAST &&
172 	    (!IN6_ARE_ADDR_EQUAL(&in6m->in6m_addr, &mld6_all_nodes_linklocal)) &&
173 	    IPV6_ADDR_MC_SCOPE(&in6m->in6m_addr) > IPV6_ADDR_SCOPE_NODELOCAL)
174 		mld6_sendpkt(in6m, MLD6_LISTENER_DONE,
175 			     &mld6_all_routers_linklocal);
176 }
177 
178 void
179 mld6_input(m, off)
180 	struct mbuf *m;
181 	int off;
182 {
183 	struct ip6_hdr *ip6 = mtod(m, struct ip6_hdr *);
184 	struct mld6_hdr *mldh;
185 	struct ifnet *ifp = m->m_pkthdr.rcvif;
186 	struct in6_multi *in6m;
187 	struct in6_ifaddr *ia;
188 	int timer;		/* timer value in the MLD query header */
189 
190 #ifndef PULLDOWN_TEST
191 	IP6_EXTHDR_CHECK(m, off, sizeof(*mldh),);
192 	mldh = (struct mld6_hdr *)(mtod(m, caddr_t) + off);
193 #else
194 	IP6_EXTHDR_GET(mldh, struct mld6_hdr *, m, off, sizeof(*mldh));
195 	if (mldh == NULL) {
196 		icmp6stat.icp6s_tooshort++;
197 		return;
198 	}
199 #endif
200 
201 	/* source address validation */
202 	ip6 = mtod(m, struct ip6_hdr *);/* in case mpullup */
203 	if (!IN6_IS_ADDR_LINKLOCAL(&ip6->ip6_src)) {
204 #if 0
205 		log(LOG_ERR,
206 		    "mld6_input: src %s is not link-local (grp=%s)\n",
207 		    ip6_sprintf(&ip6->ip6_src),
208 		    ip6_sprintf(&mldh->mld6_addr));
209 #endif
210 		/*
211 		 * spec (RFC2710) does not explicitly
212 		 * specify to discard the packet from a non link-local
213 		 * source address. But we believe it's expected to do so.
214 		 */
215 		m_freem(m);
216 		return;
217 	}
218 
219 	/*
220 	 * In the MLD6 specification, there are 3 states and a flag.
221 	 *
222 	 * In Non-Listener state, we simply don't have a membership record.
223 	 * In Delaying Listener state, our timer is running (in6m->in6m_timer)
224 	 * In Idle Listener state, our timer is not running (in6m->in6m_timer==0)
225 	 *
226 	 * The flag is in6m->in6m_state, it is set to MLD6_OTHERLISTENER if
227 	 * we have heard a report from another member, or MLD6_IREPORTEDLAST
228 	 * if we sent the last report.
229 	 */
230 	switch(mldh->mld6_type) {
231 	case MLD6_LISTENER_QUERY:
232 		if (ifp->if_flags & IFF_LOOPBACK)
233 			break;
234 
235 		if (!IN6_IS_ADDR_UNSPECIFIED(&mldh->mld6_addr) &&
236 		    !IN6_IS_ADDR_MULTICAST(&mldh->mld6_addr))
237 			break;	/* print error or log stat? */
238 		if (IN6_IS_ADDR_MC_LINKLOCAL(&mldh->mld6_addr))
239 			mldh->mld6_addr.s6_addr16[1] =
240 				htons(ifp->if_index); /* XXX */
241 
242 		/*
243 		 * - Start the timers in all of our membership records
244 		 *   that the query applies to for the interface on
245 		 *   which the query arrived excl. those that belong
246 		 *   to the "all-nodes" group (ff02::1).
247 		 * - Restart any timer that is already running but has
248 		 *   A value longer than the requested timeout.
249 		 * - Use the value specified in the query message as
250 		 *   the maximum timeout.
251 		 */
252 		IFP_TO_IA6(ifp, ia);
253 		if (ia == NULL)
254 			break;
255 
256 		/*
257 		 * XXX: System timer resolution is too low to handle Max
258 		 * Response Delay, so set 1 to the internal timer even if
259 		 * the calculated value equals to zero when Max Response
260 		 * Delay is positive.
261 		 */
262 		timer = ntohs(mldh->mld6_maxdelay)*PR_FASTHZ/MLD6_TIMER_SCALE;
263 		if (timer == 0 && mldh->mld6_maxdelay)
264 			timer = 1;
265 		mld6_all_nodes_linklocal.s6_addr16[1] =
266 			htons(ifp->if_index); /* XXX */
267 
268 		for (in6m = ia->ia6_multiaddrs.lh_first;
269 		     in6m;
270 		     in6m = in6m->in6m_entry.le_next)
271 		{
272 			if (IN6_ARE_ADDR_EQUAL(&in6m->in6m_addr,
273 						&mld6_all_nodes_linklocal) ||
274 			    IPV6_ADDR_MC_SCOPE(&in6m->in6m_addr) <
275 			    IPV6_ADDR_SCOPE_LINKLOCAL)
276 				continue;
277 
278 			if (IN6_IS_ADDR_UNSPECIFIED(&mldh->mld6_addr) ||
279 			    IN6_ARE_ADDR_EQUAL(&mldh->mld6_addr,
280 						&in6m->in6m_addr))
281 			{
282 				if (timer == 0) {
283 					/* send a report immediately */
284 					mld6_sendpkt(in6m, MLD6_LISTENER_REPORT,
285 						NULL);
286 					in6m->in6m_timer = 0; /* reset timer */
287 					in6m->in6m_state = MLD6_IREPORTEDLAST;
288 				}
289 				else if (in6m->in6m_timer == 0 || /* idle */
290 					in6m->in6m_timer > timer) {
291 					in6m->in6m_timer =
292 						MLD6_RANDOM_DELAY(timer);
293 					mld6_timers_are_running = 1;
294 				}
295 			}
296 		}
297 
298 		if (IN6_IS_ADDR_MC_LINKLOCAL(&mldh->mld6_addr))
299 			mldh->mld6_addr.s6_addr16[1] = 0; /* XXX */
300 		break;
301 	case MLD6_LISTENER_REPORT:
302 		/*
303 		 * For fast leave to work, we have to know that we are the
304 		 * last person to send a report for this group.  Reports
305 		 * can potentially get looped back if we are a multicast
306 		 * router, so discard reports sourced by me.
307 		 * Note that it is impossible to check IFF_LOOPBACK flag of
308 		 * ifp for this purpose, since ip6_mloopback pass the physical
309 		 * interface to looutput.
310 		 */
311 		if (m->m_flags & M_LOOP) /* XXX: grotty flag, but efficient */
312 			break;
313 
314 		if (!IN6_IS_ADDR_MULTICAST(&mldh->mld6_addr))
315 			break;
316 
317 		if (IN6_IS_ADDR_MC_LINKLOCAL(&mldh->mld6_addr))
318 			mldh->mld6_addr.s6_addr16[1] =
319 				htons(ifp->if_index); /* XXX */
320 		/*
321 		 * If we belong to the group being reported, stop
322 		 * our timer for that group.
323 		 */
324 		IN6_LOOKUP_MULTI(mldh->mld6_addr, ifp, in6m);
325 		if (in6m) {
326 			in6m->in6m_timer = 0; /* transit to idle state */
327 			in6m->in6m_state = MLD6_OTHERLISTENER; /* clear flag */
328 		}
329 
330 		if (IN6_IS_ADDR_MC_LINKLOCAL(&mldh->mld6_addr))
331 			mldh->mld6_addr.s6_addr16[1] = 0; /* XXX */
332 		break;
333 	default:		/* this is impossible */
334 #if 0
335 		log(LOG_ERR, "mld6_input: illegal type(%d)", mldh->mld6_type);
336 #endif
337 		break;
338 	}
339 
340 	m_freem(m);
341 }
342 
343 void
344 mld6_fasttimeo()
345 {
346 	struct in6_multi *in6m;
347 	struct in6_multistep step;
348 	int s;
349 
350 	/*
351 	 * Quick check to see if any work needs to be done, in order
352 	 * to minimize the overhead of fasttimo processing.
353 	 */
354 	if (!mld6_timers_are_running)
355 		return;
356 
357 	s = splnet();
358 
359 	mld6_timers_are_running = 0;
360 	IN6_FIRST_MULTI(step, in6m);
361 	while (in6m != NULL) {
362 		if (in6m->in6m_timer == 0) {
363 			/* do nothing */
364 		} else if (--in6m->in6m_timer == 0) {
365 			mld6_sendpkt(in6m, MLD6_LISTENER_REPORT, NULL);
366 			in6m->in6m_state = MLD6_IREPORTEDLAST;
367 		} else {
368 			mld6_timers_are_running = 1;
369 		}
370 		IN6_NEXT_MULTI(step, in6m);
371 	}
372 	splx(s);
373 }
374 
375 static void
376 mld6_sendpkt(in6m, type, dst)
377 	struct in6_multi *in6m;
378 	int type;
379 	const struct in6_addr *dst;
380 {
381 	struct mbuf *mh, *md;
382 	struct mld6_hdr *mldh;
383 	struct ip6_hdr *ip6;
384 	struct ip6_moptions im6o;
385 	struct in6_ifaddr *ia;
386 	struct ifnet *ifp = in6m->in6m_ifp;
387 	struct ifnet *outif = NULL;
388 
389 	/*
390 	 * At first, find a link local address on the outgoing interface
391 	 * to use as the source address of the MLD packet.
392 	 */
393 	if ((ia = in6ifa_ifpforlinklocal(ifp, IN6_IFF_NOTREADY|IN6_IFF_ANYCAST))
394 	    == NULL)
395 		return;
396 
397 	/*
398 	 * Allocate mbufs to store ip6 header and MLD header.
399 	 * We allocate 2 mbufs and make chain in advance because
400 	 * it is more convenient when inserting the hop-by-hop option later.
401 	 */
402 	MGETHDR(mh, M_DONTWAIT, MT_HEADER);
403 	if (mh == NULL)
404 		return;
405 	MGET(md, M_DONTWAIT, MT_DATA);
406 	if (md == NULL) {
407 		m_free(mh);
408 		return;
409 	}
410 	mh->m_next = md;
411 
412 	mh->m_pkthdr.len = sizeof(struct ip6_hdr) + sizeof(struct mld6_hdr);
413 	mh->m_len = sizeof(struct ip6_hdr);
414 	MH_ALIGN(mh, sizeof(struct ip6_hdr));
415 
416 	/* fill in the ip6 header */
417 	ip6 = mtod(mh, struct ip6_hdr *);
418 	ip6->ip6_flow = 0;
419 	ip6->ip6_vfc &= ~IPV6_VERSION_MASK;
420 	ip6->ip6_vfc |= IPV6_VERSION;
421 	/* ip6_plen will be set later */
422 	ip6->ip6_nxt = IPPROTO_ICMPV6;
423 	/* ip6_hlim will be set by im6o.im6o_multicast_hlim */
424 	ip6->ip6_src = ia->ia_addr.sin6_addr;
425 	ip6->ip6_dst = dst ? *dst : in6m->in6m_addr;
426 
427 	/* fill in the MLD header */
428 	md->m_len = sizeof(struct mld6_hdr);
429 	mldh = mtod(md, struct mld6_hdr *);
430 	mldh->mld6_type = type;
431 	mldh->mld6_code = 0;
432 	mldh->mld6_cksum = 0;
433 	/* XXX: we assume the function will not be called for query messages */
434 	mldh->mld6_maxdelay = 0;
435 	mldh->mld6_reserved = 0;
436 	mldh->mld6_addr = in6m->in6m_addr;
437 	if (IN6_IS_ADDR_MC_LINKLOCAL(&mldh->mld6_addr))
438 		mldh->mld6_addr.s6_addr16[1] = 0; /* XXX */
439 	mldh->mld6_cksum = in6_cksum(mh, IPPROTO_ICMPV6, sizeof(struct ip6_hdr),
440 				     sizeof(struct mld6_hdr));
441 
442 	/* construct multicast option */
443 	bzero(&im6o, sizeof(im6o));
444 	im6o.im6o_multicast_ifp = ifp;
445 	im6o.im6o_multicast_hlim = 1;
446 
447 	/*
448 	 * Request loopback of the report if we are acting as a multicast
449 	 * router, so that the process-level routing daemon can hear it.
450 	 */
451 	im6o.im6o_multicast_loop = (ip6_mrouter != NULL);
452 
453 	/* increment output statictics */
454 	icmp6stat.icp6s_outhist[type]++;
455 
456 	ip6_output(mh, &ip6_opts, NULL, 0, &im6o, &outif);
457 	if (outif) {
458 		icmp6_ifstat_inc(outif, ifs6_out_msg);
459 		switch (type) {
460 		case MLD6_LISTENER_QUERY:
461 			icmp6_ifstat_inc(outif, ifs6_out_mldquery);
462 			break;
463 		case MLD6_LISTENER_REPORT:
464 			icmp6_ifstat_inc(outif, ifs6_out_mldreport);
465 			break;
466 		case MLD6_LISTENER_DONE:
467 			icmp6_ifstat_inc(outif, ifs6_out_mlddone);
468 			break;
469 		}
470 	}
471 }
472