sys/netinet6/mld6.c

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