2 * Copyright (c) 1989 Stephen Deering
3 * Copyright (c) 1992, 1993
4 * The Regents of the University of California. All rights reserved.
6 * This code is derived from software contributed to Berkeley by
7 * Stephen Deering of Stanford University.
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
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 * 4. Neither the name of the University 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.
21 * THIS SOFTWARE IS PROVIDED BY THE REGENTS 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 REGENTS 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
33 * @(#)ip_mroute.c 8.2 (Berkeley) 11/15/93
37 * IP multicast forwarding procedures
39 * Written by David Waitzman, BBN Labs, August 1988.
40 * Modified by Steve Deering, Stanford, February 1989.
41 * Modified by Mark J. Steiglitz, Stanford, May, 1991
42 * Modified by Van Jacobson, LBL, January 1993
43 * Modified by Ajit Thyagarajan, PARC, August 1993
44 * Modified by Bill Fenner, PARC, April 1995
45 * Modified by Ahmed Helmy, SGI, June 1996
46 * Modified by George Edmond Eddy (Rusty), ISI, February 1998
47 * Modified by Pavlin Radoslavov, USC/ISI, May 1998, August 1999, October 2000
48 * Modified by Hitoshi Asaeda, WIDE, August 2000
49 * Modified by Pavlin Radoslavov, ICSI, October 2002
51 * MROUTING Revision: 3.5
52 * and PIM-SMv2 and PIM-DM support, advanced API support,
53 * bandwidth metering and signaling
57 * TODO: Prefix functions with ipmf_.
58 * TODO: Maintain a refcount on if_allmulti() in ifnet or in the protocol
59 * domain attachment (if_afdata) so we can track consumers of that service.
60 * TODO: Deprecate routing socket path for SIOCGETSGCNT and SIOCGETVIFCNT,
61 * move it to socket options.
62 * TODO: Cleanup LSRR removal further.
63 * TODO: Push RSVP stubs into raw_ip.c.
64 * TODO: Use bitstring.h for vif set.
65 * TODO: Fix mrt6_ioctl dangling ref when dynamically loaded.
66 * TODO: Sync ip6_mroute.c with this file.
69 #include <sys/cdefs.h>
70 __FBSDID("$FreeBSD$");
73 #include "opt_mrouting.h"
77 #include <sys/param.h>
78 #include <sys/kernel.h>
79 #include <sys/stddef.h>
82 #include <sys/malloc.h>
84 #include <sys/module.h>
86 #include <sys/protosw.h>
87 #include <sys/signalvar.h>
88 #include <sys/socket.h>
89 #include <sys/socketvar.h>
90 #include <sys/sockio.h>
92 #include <sys/sysctl.h>
93 #include <sys/syslog.h>
94 #include <sys/systm.h>
98 #include <net/netisr.h>
99 #include <net/route.h>
100 #include <net/vnet.h>
102 #include <netinet/in.h>
103 #include <netinet/igmp.h>
104 #include <netinet/in_systm.h>
105 #include <netinet/in_var.h>
106 #include <netinet/ip.h>
107 #include <netinet/ip_encap.h>
108 #include <netinet/ip_mroute.h>
109 #include <netinet/ip_var.h>
110 #include <netinet/ip_options.h>
111 #include <netinet/pim.h>
112 #include <netinet/pim_var.h>
113 #include <netinet/udp.h>
115 #include <machine/in_cksum.h>
118 #define KTR_IPMF KTR_INET
121 #define VIFI_INVALID ((vifi_t) -1)
122 #define M_HASCL(m) ((m)->m_flags & M_EXT)
124 static VNET_DEFINE(uint32_t, last_tv_sec); /* last time we processed this */
125 #define V_last_tv_sec VNET(last_tv_sec)
127 static MALLOC_DEFINE(M_MRTABLE, "mroutetbl", "multicast forwarding cache");
130 * Locking. We use two locks: one for the virtual interface table and
131 * one for the forwarding table. These locks may be nested in which case
132 * the VIF lock must always be taken first. Note that each lock is used
133 * to cover not only the specific data structure but also related data
137 static struct mtx mrouter_mtx;
138 #define MROUTER_LOCK() mtx_lock(&mrouter_mtx)
139 #define MROUTER_UNLOCK() mtx_unlock(&mrouter_mtx)
140 #define MROUTER_LOCK_ASSERT() mtx_assert(&mrouter_mtx, MA_OWNED)
141 #define MROUTER_LOCK_INIT() \
142 mtx_init(&mrouter_mtx, "IPv4 multicast forwarding", NULL, MTX_DEF)
143 #define MROUTER_LOCK_DESTROY() mtx_destroy(&mrouter_mtx)
145 static int ip_mrouter_cnt; /* # of vnets with active mrouters */
146 static int ip_mrouter_unloading; /* Allow no more V_ip_mrouter sockets */
148 static VNET_DEFINE(struct mrtstat, mrtstat);
149 #define V_mrtstat VNET(mrtstat)
150 SYSCTL_VNET_STRUCT(_net_inet_ip, OID_AUTO, mrtstat, CTLFLAG_RW,
151 &VNET_NAME(mrtstat), mrtstat,
152 "IPv4 Multicast Forwarding Statistics (struct mrtstat, "
153 "netinet/ip_mroute.h)");
155 static VNET_DEFINE(u_long, mfchash);
156 #define V_mfchash VNET(mfchash)
157 #define MFCHASH(a, g) \
158 ((((a).s_addr >> 20) ^ ((a).s_addr >> 10) ^ (a).s_addr ^ \
159 ((g).s_addr >> 20) ^ ((g).s_addr >> 10) ^ (g).s_addr) & V_mfchash)
160 #define MFCHASHSIZE 256
162 static u_long mfchashsize; /* Hash size */
163 static VNET_DEFINE(u_char *, nexpire); /* 0..mfchashsize-1 */
164 #define V_nexpire VNET(nexpire)
165 static VNET_DEFINE(LIST_HEAD(mfchashhdr, mfc)*, mfchashtbl);
166 #define V_mfchashtbl VNET(mfchashtbl)
168 static struct mtx mfc_mtx;
169 #define MFC_LOCK() mtx_lock(&mfc_mtx)
170 #define MFC_UNLOCK() mtx_unlock(&mfc_mtx)
171 #define MFC_LOCK_ASSERT() mtx_assert(&mfc_mtx, MA_OWNED)
172 #define MFC_LOCK_INIT() \
173 mtx_init(&mfc_mtx, "IPv4 multicast forwarding cache", NULL, MTX_DEF)
174 #define MFC_LOCK_DESTROY() mtx_destroy(&mfc_mtx)
176 static VNET_DEFINE(vifi_t, numvifs);
177 #define V_numvifs VNET(numvifs)
178 static VNET_DEFINE(struct vif, viftable[MAXVIFS]);
179 #define V_viftable VNET(viftable)
180 SYSCTL_VNET_OPAQUE(_net_inet_ip, OID_AUTO, viftable, CTLFLAG_RD,
181 &VNET_NAME(viftable), sizeof(V_viftable), "S,vif[MAXVIFS]",
182 "IPv4 Multicast Interfaces (struct vif[MAXVIFS], netinet/ip_mroute.h)");
184 static struct mtx vif_mtx;
185 #define VIF_LOCK() mtx_lock(&vif_mtx)
186 #define VIF_UNLOCK() mtx_unlock(&vif_mtx)
187 #define VIF_LOCK_ASSERT() mtx_assert(&vif_mtx, MA_OWNED)
188 #define VIF_LOCK_INIT() \
189 mtx_init(&vif_mtx, "IPv4 multicast interfaces", NULL, MTX_DEF)
190 #define VIF_LOCK_DESTROY() mtx_destroy(&vif_mtx)
192 static eventhandler_tag if_detach_event_tag = NULL;
194 static VNET_DEFINE(struct callout, expire_upcalls_ch);
195 #define V_expire_upcalls_ch VNET(expire_upcalls_ch)
197 #define EXPIRE_TIMEOUT (hz / 4) /* 4x / second */
198 #define UPCALL_EXPIRE 6 /* number of timeouts */
201 * Bandwidth meter variables and constants
203 static MALLOC_DEFINE(M_BWMETER, "bwmeter", "multicast upcall bw meters");
205 * Pending timeouts are stored in a hash table, the key being the
206 * expiration time. Periodically, the entries are analysed and processed.
208 #define BW_METER_BUCKETS 1024
209 static VNET_DEFINE(struct bw_meter*, bw_meter_timers[BW_METER_BUCKETS]);
210 #define V_bw_meter_timers VNET(bw_meter_timers)
211 static VNET_DEFINE(struct callout, bw_meter_ch);
212 #define V_bw_meter_ch VNET(bw_meter_ch)
213 #define BW_METER_PERIOD (hz) /* periodical handling of bw meters */
216 * Pending upcalls are stored in a vector which is flushed when
217 * full, or periodically
219 static VNET_DEFINE(struct bw_upcall, bw_upcalls[BW_UPCALLS_MAX]);
220 #define V_bw_upcalls VNET(bw_upcalls)
221 static VNET_DEFINE(u_int, bw_upcalls_n); /* # of pending upcalls */
222 #define V_bw_upcalls_n VNET(bw_upcalls_n)
223 static VNET_DEFINE(struct callout, bw_upcalls_ch);
224 #define V_bw_upcalls_ch VNET(bw_upcalls_ch)
226 #define BW_UPCALLS_PERIOD (hz) /* periodical flush of bw upcalls */
228 static VNET_DEFINE(struct pimstat, pimstat);
229 #define V_pimstat VNET(pimstat)
231 SYSCTL_NODE(_net_inet, IPPROTO_PIM, pim, CTLFLAG_RW, 0, "PIM");
232 SYSCTL_VNET_STRUCT(_net_inet_pim, PIMCTL_STATS, stats, CTLFLAG_RD,
233 &VNET_NAME(pimstat), pimstat,
234 "PIM Statistics (struct pimstat, netinet/pim_var.h)");
236 static u_long pim_squelch_wholepkt = 0;
237 SYSCTL_ULONG(_net_inet_pim, OID_AUTO, squelch_wholepkt, CTLFLAG_RW,
238 &pim_squelch_wholepkt, 0,
239 "Disable IGMP_WHOLEPKT notifications if rendezvous point is unspecified");
241 extern struct domain inetdomain;
242 static const struct protosw in_pim_protosw = {
244 .pr_domain = &inetdomain,
245 .pr_protocol = IPPROTO_PIM,
246 .pr_flags = PR_ATOMIC|PR_ADDR|PR_LASTHDR,
247 .pr_input = pim_input,
248 .pr_output = (pr_output_t*)rip_output,
249 .pr_ctloutput = rip_ctloutput,
250 .pr_usrreqs = &rip_usrreqs
252 static const struct encaptab *pim_encap_cookie;
254 static int pim_encapcheck(const struct mbuf *, int, int, void *);
257 * Note: the PIM Register encapsulation adds the following in front of a
260 * struct pim_encap_hdr {
262 * struct pim_encap_pimhdr pim;
267 struct pim_encap_pimhdr {
271 #define PIM_ENCAP_TTL 64
273 static struct ip pim_encap_iphdr = {
274 #if BYTE_ORDER == LITTLE_ENDIAN
275 sizeof(struct ip) >> 2,
279 sizeof(struct ip) >> 2,
282 sizeof(struct ip), /* total length */
290 static struct pim_encap_pimhdr pim_encap_pimhdr = {
292 PIM_MAKE_VT(PIM_VERSION, PIM_REGISTER), /* PIM vers and message type */
299 static VNET_DEFINE(vifi_t, reg_vif_num) = VIFI_INVALID;
300 #define V_reg_vif_num VNET(reg_vif_num)
301 static VNET_DEFINE(struct ifnet, multicast_register_if);
302 #define V_multicast_register_if VNET(multicast_register_if)
308 static u_long X_ip_mcast_src(int);
309 static int X_ip_mforward(struct ip *, struct ifnet *, struct mbuf *,
310 struct ip_moptions *);
311 static int X_ip_mrouter_done(void);
312 static int X_ip_mrouter_get(struct socket *, struct sockopt *);
313 static int X_ip_mrouter_set(struct socket *, struct sockopt *);
314 static int X_legal_vif_num(int);
315 static int X_mrt_ioctl(u_long, caddr_t, int);
317 static int add_bw_upcall(struct bw_upcall *);
318 static int add_mfc(struct mfcctl2 *);
319 static int add_vif(struct vifctl *);
320 static void bw_meter_prepare_upcall(struct bw_meter *, struct timeval *);
321 static void bw_meter_process(void);
322 static void bw_meter_receive_packet(struct bw_meter *, int,
324 static void bw_upcalls_send(void);
325 static int del_bw_upcall(struct bw_upcall *);
326 static int del_mfc(struct mfcctl2 *);
327 static int del_vif(vifi_t);
328 static int del_vif_locked(vifi_t);
329 static void expire_bw_meter_process(void *);
330 static void expire_bw_upcalls_send(void *);
331 static void expire_mfc(struct mfc *);
332 static void expire_upcalls(void *);
333 static void free_bw_list(struct bw_meter *);
334 static int get_sg_cnt(struct sioc_sg_req *);
335 static int get_vif_cnt(struct sioc_vif_req *);
336 static void if_detached_event(void *, struct ifnet *);
337 static int ip_mdq(struct mbuf *, struct ifnet *, struct mfc *, vifi_t);
338 static int ip_mrouter_init(struct socket *, int);
339 static __inline struct mfc *
340 mfc_find(struct in_addr *, struct in_addr *);
341 static void phyint_send(struct ip *, struct vif *, struct mbuf *);
343 pim_register_prepare(struct ip *, struct mbuf *);
344 static int pim_register_send(struct ip *, struct vif *,
345 struct mbuf *, struct mfc *);
346 static int pim_register_send_rp(struct ip *, struct vif *,
347 struct mbuf *, struct mfc *);
348 static int pim_register_send_upcall(struct ip *, struct vif *,
349 struct mbuf *, struct mfc *);
350 static void schedule_bw_meter(struct bw_meter *, struct timeval *);
351 static void send_packet(struct vif *, struct mbuf *);
352 static int set_api_config(uint32_t *);
353 static int set_assert(int);
354 static int socket_send(struct socket *, struct mbuf *,
355 struct sockaddr_in *);
356 static void unschedule_bw_meter(struct bw_meter *);
359 * Kernel multicast forwarding API capabilities and setup.
360 * If more API capabilities are added to the kernel, they should be
361 * recorded in `mrt_api_support'.
363 #define MRT_API_VERSION 0x0305
365 static const int mrt_api_version = MRT_API_VERSION;
366 static const uint32_t mrt_api_support = (MRT_MFC_FLAGS_DISABLE_WRONGVIF |
367 MRT_MFC_FLAGS_BORDER_VIF |
370 static VNET_DEFINE(uint32_t, mrt_api_config);
371 #define V_mrt_api_config VNET(mrt_api_config)
372 static VNET_DEFINE(int, pim_assert_enabled);
373 #define V_pim_assert_enabled VNET(pim_assert_enabled)
374 static struct timeval pim_assert_interval = { 3, 0 }; /* Rate limit */
377 * Find a route for a given origin IP address and multicast group address.
378 * Statistics must be updated by the caller.
380 static __inline struct mfc *
381 mfc_find(struct in_addr *o, struct in_addr *g)
387 LIST_FOREACH(rt, &V_mfchashtbl[MFCHASH(*o, *g)], mfc_hash) {
388 if (in_hosteq(rt->mfc_origin, *o) &&
389 in_hosteq(rt->mfc_mcastgrp, *g) &&
390 TAILQ_EMPTY(&rt->mfc_stall))
398 * Handle MRT setsockopt commands to modify the multicast forwarding tables.
401 X_ip_mrouter_set(struct socket *so, struct sockopt *sopt)
407 struct bw_upcall bw_upcall;
410 if (so != V_ip_mrouter && sopt->sopt_name != MRT_INIT)
414 switch (sopt->sopt_name) {
416 error = sooptcopyin(sopt, &optval, sizeof optval, sizeof optval);
419 error = ip_mrouter_init(so, optval);
423 error = ip_mrouter_done();
427 error = sooptcopyin(sopt, &vifc, sizeof vifc, sizeof vifc);
430 error = add_vif(&vifc);
434 error = sooptcopyin(sopt, &vifi, sizeof vifi, sizeof vifi);
437 error = del_vif(vifi);
443 * select data size depending on API version.
445 if (sopt->sopt_name == MRT_ADD_MFC &&
446 V_mrt_api_config & MRT_API_FLAGS_ALL) {
447 error = sooptcopyin(sopt, &mfc, sizeof(struct mfcctl2),
448 sizeof(struct mfcctl2));
450 error = sooptcopyin(sopt, &mfc, sizeof(struct mfcctl),
451 sizeof(struct mfcctl));
452 bzero((caddr_t)&mfc + sizeof(struct mfcctl),
453 sizeof(mfc) - sizeof(struct mfcctl));
457 if (sopt->sopt_name == MRT_ADD_MFC)
458 error = add_mfc(&mfc);
460 error = del_mfc(&mfc);
464 error = sooptcopyin(sopt, &optval, sizeof optval, sizeof optval);
471 error = sooptcopyin(sopt, &i, sizeof i, sizeof i);
473 error = set_api_config(&i);
475 error = sooptcopyout(sopt, &i, sizeof i);
478 case MRT_ADD_BW_UPCALL:
479 case MRT_DEL_BW_UPCALL:
480 error = sooptcopyin(sopt, &bw_upcall, sizeof bw_upcall,
484 if (sopt->sopt_name == MRT_ADD_BW_UPCALL)
485 error = add_bw_upcall(&bw_upcall);
487 error = del_bw_upcall(&bw_upcall);
498 * Handle MRT getsockopt commands
501 X_ip_mrouter_get(struct socket *so, struct sockopt *sopt)
505 switch (sopt->sopt_name) {
507 error = sooptcopyout(sopt, &mrt_api_version, sizeof mrt_api_version);
511 error = sooptcopyout(sopt, &V_pim_assert_enabled,
512 sizeof V_pim_assert_enabled);
515 case MRT_API_SUPPORT:
516 error = sooptcopyout(sopt, &mrt_api_support, sizeof mrt_api_support);
520 error = sooptcopyout(sopt, &V_mrt_api_config, sizeof V_mrt_api_config);
531 * Handle ioctl commands to obtain information from the cache
534 X_mrt_ioctl(u_long cmd, caddr_t data, int fibnum __unused)
539 * Currently the only function calling this ioctl routine is rtioctl().
540 * Typically, only root can create the raw socket in order to execute
541 * this ioctl method, however the request might be coming from a prison
543 error = priv_check(curthread, PRIV_NETINET_MROUTE);
547 case (SIOCGETVIFCNT):
548 error = get_vif_cnt((struct sioc_vif_req *)data);
552 error = get_sg_cnt((struct sioc_sg_req *)data);
563 * returns the packet, byte, rpf-failure count for the source group provided
566 get_sg_cnt(struct sioc_sg_req *req)
571 rt = mfc_find(&req->src, &req->grp);
574 req->pktcnt = req->bytecnt = req->wrong_if = 0xffffffff;
575 return EADDRNOTAVAIL;
577 req->pktcnt = rt->mfc_pkt_cnt;
578 req->bytecnt = rt->mfc_byte_cnt;
579 req->wrong_if = rt->mfc_wrong_if;
585 * returns the input and output packet and byte counts on the vif provided
588 get_vif_cnt(struct sioc_vif_req *req)
590 vifi_t vifi = req->vifi;
593 if (vifi >= V_numvifs) {
598 req->icount = V_viftable[vifi].v_pkt_in;
599 req->ocount = V_viftable[vifi].v_pkt_out;
600 req->ibytes = V_viftable[vifi].v_bytes_in;
601 req->obytes = V_viftable[vifi].v_bytes_out;
608 if_detached_event(void *arg __unused, struct ifnet *ifp)
615 if (V_ip_mrouter == NULL) {
624 * Tear down multicast forwarder state associated with this ifnet.
625 * 1. Walk the vif list, matching vifs against this ifnet.
626 * 2. Walk the multicast forwarding cache (mfc) looking for
627 * inner matches with this vif's index.
628 * 3. Expire any matching multicast forwarding cache entries.
629 * 4. Free vif state. This should disable ALLMULTI on the interface.
631 for (vifi = 0; vifi < V_numvifs; vifi++) {
632 if (V_viftable[vifi].v_ifp != ifp)
634 for (i = 0; i < mfchashsize; i++) {
635 struct mfc *rt, *nrt;
636 for (rt = LIST_FIRST(&V_mfchashtbl[i]); rt; rt = nrt) {
637 nrt = LIST_NEXT(rt, mfc_hash);
638 if (rt->mfc_parent == vifi) {
643 del_vif_locked(vifi);
653 * Enable multicast forwarding.
656 ip_mrouter_init(struct socket *so, int version)
659 CTR3(KTR_IPMF, "%s: so_type %d, pr_protocol %d", __func__,
660 so->so_type, so->so_proto->pr_protocol);
662 if (so->so_type != SOCK_RAW || so->so_proto->pr_protocol != IPPROTO_IGMP)
670 if (ip_mrouter_unloading) {
675 if (V_ip_mrouter != NULL) {
680 V_mfchashtbl = hashinit_flags(mfchashsize, M_MRTABLE, &V_mfchash,
683 callout_reset(&V_expire_upcalls_ch, EXPIRE_TIMEOUT, expire_upcalls,
685 callout_reset(&V_bw_upcalls_ch, BW_UPCALLS_PERIOD, expire_bw_upcalls_send,
687 callout_reset(&V_bw_meter_ch, BW_METER_PERIOD, expire_bw_meter_process,
695 CTR1(KTR_IPMF, "%s: done", __func__);
701 * Disable multicast forwarding.
704 X_ip_mrouter_done(void)
713 if (V_ip_mrouter == NULL) {
719 * Detach/disable hooks to the reset of the system.
723 V_mrt_api_config = 0;
728 * For each phyint in use, disable promiscuous reception of all IP
731 for (vifi = 0; vifi < V_numvifs; vifi++) {
732 if (!in_nullhost(V_viftable[vifi].v_lcl_addr) &&
733 !(V_viftable[vifi].v_flags & (VIFF_TUNNEL | VIFF_REGISTER))) {
734 struct sockaddr_in *so = (struct sockaddr_in *)&(ifr.ifr_addr);
736 so->sin_len = sizeof(struct sockaddr_in);
737 so->sin_family = AF_INET;
738 so->sin_addr.s_addr = INADDR_ANY;
739 ifp = V_viftable[vifi].v_ifp;
743 bzero((caddr_t)V_viftable, sizeof(V_viftable));
745 V_pim_assert_enabled = 0;
749 callout_stop(&V_expire_upcalls_ch);
750 callout_stop(&V_bw_upcalls_ch);
751 callout_stop(&V_bw_meter_ch);
756 * Free all multicast forwarding cache entries.
757 * Do not use hashdestroy(), as we must perform other cleanup.
759 for (i = 0; i < mfchashsize; i++) {
760 struct mfc *rt, *nrt;
761 for (rt = LIST_FIRST(&V_mfchashtbl[i]); rt; rt = nrt) {
762 nrt = LIST_NEXT(rt, mfc_hash);
766 free(V_mfchashtbl, M_MRTABLE);
769 bzero(V_nexpire, sizeof(V_nexpire[0]) * mfchashsize);
772 bzero(V_bw_meter_timers, sizeof(V_bw_meter_timers));
776 V_reg_vif_num = VIFI_INVALID;
780 CTR1(KTR_IPMF, "%s: done", __func__);
786 * Set PIM assert processing global
791 if ((i != 1) && (i != 0))
794 V_pim_assert_enabled = i;
800 * Configure API capabilities
803 set_api_config(uint32_t *apival)
808 * We can set the API capabilities only if it is the first operation
809 * after MRT_INIT. I.e.:
810 * - there are no vifs installed
811 * - pim_assert is not enabled
812 * - the MFC table is empty
818 if (V_pim_assert_enabled) {
825 for (i = 0; i < mfchashsize; i++) {
826 if (LIST_FIRST(&V_mfchashtbl[i]) != NULL) {
834 V_mrt_api_config = *apival & mrt_api_support;
835 *apival = V_mrt_api_config;
841 * Add a vif to the vif table
844 add_vif(struct vifctl *vifcp)
846 struct vif *vifp = V_viftable + vifcp->vifc_vifi;
847 struct sockaddr_in sin = {sizeof sin, AF_INET};
853 if (vifcp->vifc_vifi >= MAXVIFS) {
857 /* rate limiting is no longer supported by this code */
858 if (vifcp->vifc_rate_limit != 0) {
859 log(LOG_ERR, "rate limiting is no longer supported\n");
863 if (!in_nullhost(vifp->v_lcl_addr)) {
867 if (in_nullhost(vifcp->vifc_lcl_addr)) {
869 return EADDRNOTAVAIL;
872 /* Find the interface with an address in AF_INET family */
873 if (vifcp->vifc_flags & VIFF_REGISTER) {
875 * XXX: Because VIFF_REGISTER does not really need a valid
876 * local interface (e.g. it could be 127.0.0.2), we don't
881 sin.sin_addr = vifcp->vifc_lcl_addr;
882 ifa = ifa_ifwithaddr((struct sockaddr *)&sin);
885 return EADDRNOTAVAIL;
891 if ((vifcp->vifc_flags & VIFF_TUNNEL) != 0) {
892 CTR1(KTR_IPMF, "%s: tunnels are no longer supported", __func__);
895 } else if (vifcp->vifc_flags & VIFF_REGISTER) {
896 ifp = &V_multicast_register_if;
897 CTR2(KTR_IPMF, "%s: add register vif for ifp %p", __func__, ifp);
898 if (V_reg_vif_num == VIFI_INVALID) {
899 if_initname(&V_multicast_register_if, "register_vif", 0);
900 V_multicast_register_if.if_flags = IFF_LOOPBACK;
901 V_reg_vif_num = vifcp->vifc_vifi;
903 } else { /* Make sure the interface supports multicast */
904 if ((ifp->if_flags & IFF_MULTICAST) == 0) {
909 /* Enable promiscuous reception of all IP multicasts from the if */
910 error = if_allmulti(ifp, 1);
917 vifp->v_flags = vifcp->vifc_flags;
918 vifp->v_threshold = vifcp->vifc_threshold;
919 vifp->v_lcl_addr = vifcp->vifc_lcl_addr;
920 vifp->v_rmt_addr = vifcp->vifc_rmt_addr;
922 /* initialize per vif pkt counters */
925 vifp->v_bytes_in = 0;
926 vifp->v_bytes_out = 0;
928 /* Adjust numvifs up if the vifi is higher than numvifs */
929 if (V_numvifs <= vifcp->vifc_vifi)
930 V_numvifs = vifcp->vifc_vifi + 1;
934 CTR4(KTR_IPMF, "%s: add vif %d laddr %s thresh %x", __func__,
935 (int)vifcp->vifc_vifi, inet_ntoa(vifcp->vifc_lcl_addr),
936 (int)vifcp->vifc_threshold);
942 * Delete a vif from the vif table
945 del_vif_locked(vifi_t vifi)
951 if (vifi >= V_numvifs) {
954 vifp = &V_viftable[vifi];
955 if (in_nullhost(vifp->v_lcl_addr)) {
956 return EADDRNOTAVAIL;
959 if (!(vifp->v_flags & (VIFF_TUNNEL | VIFF_REGISTER)))
960 if_allmulti(vifp->v_ifp, 0);
962 if (vifp->v_flags & VIFF_REGISTER)
963 V_reg_vif_num = VIFI_INVALID;
965 bzero((caddr_t)vifp, sizeof (*vifp));
967 CTR2(KTR_IPMF, "%s: delete vif %d", __func__, (int)vifi);
969 /* Adjust numvifs down */
970 for (vifi = V_numvifs; vifi > 0; vifi--)
971 if (!in_nullhost(V_viftable[vifi-1].v_lcl_addr))
984 cc = del_vif_locked(vifi);
991 * update an mfc entry without resetting counters and S,G addresses.
994 update_mfc_params(struct mfc *rt, struct mfcctl2 *mfccp)
998 rt->mfc_parent = mfccp->mfcc_parent;
999 for (i = 0; i < V_numvifs; i++) {
1000 rt->mfc_ttls[i] = mfccp->mfcc_ttls[i];
1001 rt->mfc_flags[i] = mfccp->mfcc_flags[i] & V_mrt_api_config &
1004 /* set the RP address */
1005 if (V_mrt_api_config & MRT_MFC_RP)
1006 rt->mfc_rp = mfccp->mfcc_rp;
1008 rt->mfc_rp.s_addr = INADDR_ANY;
1012 * fully initialize an mfc entry from the parameter.
1015 init_mfc_params(struct mfc *rt, struct mfcctl2 *mfccp)
1017 rt->mfc_origin = mfccp->mfcc_origin;
1018 rt->mfc_mcastgrp = mfccp->mfcc_mcastgrp;
1020 update_mfc_params(rt, mfccp);
1022 /* initialize pkt counters per src-grp */
1023 rt->mfc_pkt_cnt = 0;
1024 rt->mfc_byte_cnt = 0;
1025 rt->mfc_wrong_if = 0;
1026 timevalclear(&rt->mfc_last_assert);
1030 expire_mfc(struct mfc *rt)
1032 struct rtdetq *rte, *nrte;
1036 free_bw_list(rt->mfc_bw_meter);
1038 TAILQ_FOREACH_SAFE(rte, &rt->mfc_stall, rte_link, nrte) {
1040 TAILQ_REMOVE(&rt->mfc_stall, rte, rte_link);
1041 free(rte, M_MRTABLE);
1044 LIST_REMOVE(rt, mfc_hash);
1045 free(rt, M_MRTABLE);
1052 add_mfc(struct mfcctl2 *mfccp)
1055 struct rtdetq *rte, *nrte;
1062 rt = mfc_find(&mfccp->mfcc_origin, &mfccp->mfcc_mcastgrp);
1064 /* If an entry already exists, just update the fields */
1066 CTR4(KTR_IPMF, "%s: update mfc orig %s group %lx parent %x",
1067 __func__, inet_ntoa(mfccp->mfcc_origin),
1068 (u_long)ntohl(mfccp->mfcc_mcastgrp.s_addr),
1069 mfccp->mfcc_parent);
1070 update_mfc_params(rt, mfccp);
1077 * Find the entry for which the upcall was made and update
1080 hash = MFCHASH(mfccp->mfcc_origin, mfccp->mfcc_mcastgrp);
1081 LIST_FOREACH(rt, &V_mfchashtbl[hash], mfc_hash) {
1082 if (in_hosteq(rt->mfc_origin, mfccp->mfcc_origin) &&
1083 in_hosteq(rt->mfc_mcastgrp, mfccp->mfcc_mcastgrp) &&
1084 !TAILQ_EMPTY(&rt->mfc_stall)) {
1086 "%s: add mfc orig %s group %lx parent %x qh %p",
1087 __func__, inet_ntoa(mfccp->mfcc_origin),
1088 (u_long)ntohl(mfccp->mfcc_mcastgrp.s_addr),
1090 TAILQ_FIRST(&rt->mfc_stall));
1092 CTR1(KTR_IPMF, "%s: multiple matches", __func__);
1094 init_mfc_params(rt, mfccp);
1095 rt->mfc_expire = 0; /* Don't clean this guy up */
1098 /* Free queued packets, but attempt to forward them first. */
1099 TAILQ_FOREACH_SAFE(rte, &rt->mfc_stall, rte_link, nrte) {
1100 if (rte->ifp != NULL)
1101 ip_mdq(rte->m, rte->ifp, rt, -1);
1103 TAILQ_REMOVE(&rt->mfc_stall, rte, rte_link);
1105 free(rte, M_MRTABLE);
1111 * It is possible that an entry is being inserted without an upcall
1114 CTR1(KTR_IPMF, "%s: adding mfc w/o upcall", __func__);
1115 LIST_FOREACH(rt, &V_mfchashtbl[hash], mfc_hash) {
1116 if (in_hosteq(rt->mfc_origin, mfccp->mfcc_origin) &&
1117 in_hosteq(rt->mfc_mcastgrp, mfccp->mfcc_mcastgrp)) {
1118 init_mfc_params(rt, mfccp);
1126 if (rt == NULL) { /* no upcall, so make a new entry */
1127 rt = (struct mfc *)malloc(sizeof(*rt), M_MRTABLE, M_NOWAIT);
1134 init_mfc_params(rt, mfccp);
1135 TAILQ_INIT(&rt->mfc_stall);
1139 rt->mfc_bw_meter = NULL;
1141 /* insert new entry at head of hash chain */
1142 LIST_INSERT_HEAD(&V_mfchashtbl[hash], rt, mfc_hash);
1153 * Delete an mfc entry
1156 del_mfc(struct mfcctl2 *mfccp)
1158 struct in_addr origin;
1159 struct in_addr mcastgrp;
1162 origin = mfccp->mfcc_origin;
1163 mcastgrp = mfccp->mfcc_mcastgrp;
1165 CTR3(KTR_IPMF, "%s: delete mfc orig %s group %lx", __func__,
1166 inet_ntoa(origin), (u_long)ntohl(mcastgrp.s_addr));
1170 rt = mfc_find(&origin, &mcastgrp);
1173 return EADDRNOTAVAIL;
1177 * free the bw_meter entries
1179 free_bw_list(rt->mfc_bw_meter);
1180 rt->mfc_bw_meter = NULL;
1182 LIST_REMOVE(rt, mfc_hash);
1183 free(rt, M_MRTABLE);
1191 * Send a message to the routing daemon on the multicast routing socket.
1194 socket_send(struct socket *s, struct mbuf *mm, struct sockaddr_in *src)
1197 SOCKBUF_LOCK(&s->so_rcv);
1198 if (sbappendaddr_locked(&s->so_rcv, (struct sockaddr *)src, mm,
1200 sorwakeup_locked(s);
1203 SOCKBUF_UNLOCK(&s->so_rcv);
1210 * IP multicast forwarding function. This function assumes that the packet
1211 * pointed to by "ip" has arrived on (or is about to be sent to) the interface
1212 * pointed to by "ifp", and the packet is to be relayed to other networks
1213 * that have members of the packet's destination IP multicast group.
1215 * The packet is returned unscathed to the caller, unless it is
1216 * erroneous, in which case a non-zero return value tells the caller to
1220 #define TUNNEL_LEN 12 /* # bytes of IP option for tunnel encapsulation */
1223 X_ip_mforward(struct ip *ip, struct ifnet *ifp, struct mbuf *m,
1224 struct ip_moptions *imo)
1230 CTR3(KTR_IPMF, "ip_mforward: delete mfc orig %s group %lx ifp %p",
1231 inet_ntoa(ip->ip_src), (u_long)ntohl(ip->ip_dst.s_addr), ifp);
1233 if (ip->ip_hl < (sizeof(struct ip) + TUNNEL_LEN) >> 2 ||
1234 ((u_char *)(ip + 1))[1] != IPOPT_LSRR ) {
1236 * Packet arrived via a physical interface or
1237 * an encapsulated tunnel or a register_vif.
1241 * Packet arrived through a source-route tunnel.
1242 * Source-route tunnels are no longer supported.
1249 if (imo && ((vifi = imo->imo_multicast_vif) < V_numvifs)) {
1250 if (ip->ip_ttl < MAXTTL)
1251 ip->ip_ttl++; /* compensate for -1 in *_send routines */
1252 error = ip_mdq(m, ifp, NULL, vifi);
1259 * Don't forward a packet with time-to-live of zero or one,
1260 * or a packet destined to a local-only group.
1262 if (ip->ip_ttl <= 1 || IN_LOCAL_GROUP(ntohl(ip->ip_dst.s_addr))) {
1269 * Determine forwarding vifs from the forwarding cache table
1271 MRTSTAT_INC(mrts_mfc_lookups);
1272 rt = mfc_find(&ip->ip_src, &ip->ip_dst);
1274 /* Entry exists, so forward if necessary */
1276 error = ip_mdq(m, ifp, rt, -1);
1282 * If we don't have a route for packet's origin,
1283 * Make a copy of the packet & send message to routing daemon
1289 int hlen = ip->ip_hl << 2;
1291 MRTSTAT_INC(mrts_mfc_misses);
1292 MRTSTAT_INC(mrts_no_route);
1293 CTR2(KTR_IPMF, "ip_mforward: no mfc for (%s,%lx)",
1294 inet_ntoa(ip->ip_src), (u_long)ntohl(ip->ip_dst.s_addr));
1297 * Allocate mbufs early so that we don't do extra work if we are
1298 * just going to fail anyway. Make sure to pullup the header so
1299 * that other people can't step on it.
1301 rte = (struct rtdetq *)malloc((sizeof *rte), M_MRTABLE,
1309 mb0 = m_copypacket(m, M_NOWAIT);
1310 if (mb0 && (M_HASCL(mb0) || mb0->m_len < hlen))
1311 mb0 = m_pullup(mb0, hlen);
1313 free(rte, M_MRTABLE);
1319 /* is there an upcall waiting for this flow ? */
1320 hash = MFCHASH(ip->ip_src, ip->ip_dst);
1321 LIST_FOREACH(rt, &V_mfchashtbl[hash], mfc_hash) {
1322 if (in_hosteq(ip->ip_src, rt->mfc_origin) &&
1323 in_hosteq(ip->ip_dst, rt->mfc_mcastgrp) &&
1324 !TAILQ_EMPTY(&rt->mfc_stall))
1331 struct sockaddr_in k_igmpsrc = { sizeof k_igmpsrc, AF_INET };
1335 * Locate the vifi for the incoming interface for this packet.
1336 * If none found, drop packet.
1338 for (vifi = 0; vifi < V_numvifs &&
1339 V_viftable[vifi].v_ifp != ifp; vifi++)
1341 if (vifi >= V_numvifs) /* vif not found, drop packet */
1344 /* no upcall, so make a new entry */
1345 rt = (struct mfc *)malloc(sizeof(*rt), M_MRTABLE, M_NOWAIT);
1349 /* Make a copy of the header to send to the user level process */
1350 mm = m_copy(mb0, 0, hlen);
1355 * Send message to routing daemon to install
1356 * a route into the kernel table
1359 im = mtod(mm, struct igmpmsg *);
1360 im->im_msgtype = IGMPMSG_NOCACHE;
1364 MRTSTAT_INC(mrts_upcalls);
1366 k_igmpsrc.sin_addr = ip->ip_src;
1367 if (socket_send(V_ip_mrouter, mm, &k_igmpsrc) < 0) {
1368 CTR0(KTR_IPMF, "ip_mforward: socket queue full");
1369 MRTSTAT_INC(mrts_upq_sockfull);
1371 free(rt, M_MRTABLE);
1373 free(rte, M_MRTABLE);
1380 /* insert new entry at head of hash chain */
1381 rt->mfc_origin.s_addr = ip->ip_src.s_addr;
1382 rt->mfc_mcastgrp.s_addr = ip->ip_dst.s_addr;
1383 rt->mfc_expire = UPCALL_EXPIRE;
1385 for (i = 0; i < V_numvifs; i++) {
1386 rt->mfc_ttls[i] = 0;
1387 rt->mfc_flags[i] = 0;
1389 rt->mfc_parent = -1;
1391 /* clear the RP address */
1392 rt->mfc_rp.s_addr = INADDR_ANY;
1393 rt->mfc_bw_meter = NULL;
1395 /* initialize pkt counters per src-grp */
1396 rt->mfc_pkt_cnt = 0;
1397 rt->mfc_byte_cnt = 0;
1398 rt->mfc_wrong_if = 0;
1399 timevalclear(&rt->mfc_last_assert);
1401 TAILQ_INIT(&rt->mfc_stall);
1404 /* link into table */
1405 LIST_INSERT_HEAD(&V_mfchashtbl[hash], rt, mfc_hash);
1406 TAILQ_INSERT_HEAD(&rt->mfc_stall, rte, rte_link);
1410 /* determine if queue has overflowed */
1411 if (rt->mfc_nstall > MAX_UPQ) {
1412 MRTSTAT_INC(mrts_upq_ovflw);
1414 free(rte, M_MRTABLE);
1420 TAILQ_INSERT_TAIL(&rt->mfc_stall, rte, rte_link);
1435 * Clean up the cache entry if upcall is not serviced
1438 expire_upcalls(void *arg)
1442 CURVNET_SET((struct vnet *) arg);
1446 for (i = 0; i < mfchashsize; i++) {
1447 struct mfc *rt, *nrt;
1449 if (V_nexpire[i] == 0)
1452 for (rt = LIST_FIRST(&V_mfchashtbl[i]); rt; rt = nrt) {
1453 nrt = LIST_NEXT(rt, mfc_hash);
1455 if (TAILQ_EMPTY(&rt->mfc_stall))
1458 if (rt->mfc_expire == 0 || --rt->mfc_expire > 0)
1462 * free the bw_meter entries
1464 while (rt->mfc_bw_meter != NULL) {
1465 struct bw_meter *x = rt->mfc_bw_meter;
1467 rt->mfc_bw_meter = x->bm_mfc_next;
1471 MRTSTAT_INC(mrts_cache_cleanups);
1472 CTR3(KTR_IPMF, "%s: expire (%lx, %lx)", __func__,
1473 (u_long)ntohl(rt->mfc_origin.s_addr),
1474 (u_long)ntohl(rt->mfc_mcastgrp.s_addr));
1482 callout_reset(&V_expire_upcalls_ch, EXPIRE_TIMEOUT, expire_upcalls,
1489 * Packet forwarding routine once entry in the cache is made
1492 ip_mdq(struct mbuf *m, struct ifnet *ifp, struct mfc *rt, vifi_t xmt_vif)
1494 struct ip *ip = mtod(m, struct ip *);
1496 int plen = ntohs(ip->ip_len);
1501 * If xmt_vif is not -1, send on only the requested vif.
1503 * (since vifi_t is u_short, -1 becomes MAXUSHORT, which > numvifs.)
1505 if (xmt_vif < V_numvifs) {
1506 if (V_viftable[xmt_vif].v_flags & VIFF_REGISTER)
1507 pim_register_send(ip, V_viftable + xmt_vif, m, rt);
1509 phyint_send(ip, V_viftable + xmt_vif, m);
1514 * Don't forward if it didn't arrive from the parent vif for its origin.
1516 vifi = rt->mfc_parent;
1517 if ((vifi >= V_numvifs) || (V_viftable[vifi].v_ifp != ifp)) {
1518 CTR4(KTR_IPMF, "%s: rx on wrong ifp %p (vifi %d, v_ifp %p)",
1519 __func__, ifp, (int)vifi, V_viftable[vifi].v_ifp);
1520 MRTSTAT_INC(mrts_wrong_if);
1523 * If we are doing PIM assert processing, send a message
1524 * to the routing daemon.
1526 * XXX: A PIM-SM router needs the WRONGVIF detection so it
1527 * can complete the SPT switch, regardless of the type
1528 * of the iif (broadcast media, GRE tunnel, etc).
1530 if (V_pim_assert_enabled && (vifi < V_numvifs) &&
1531 V_viftable[vifi].v_ifp) {
1533 if (ifp == &V_multicast_register_if)
1534 PIMSTAT_INC(pims_rcv_registers_wrongiif);
1536 /* Get vifi for the incoming packet */
1537 for (vifi = 0; vifi < V_numvifs && V_viftable[vifi].v_ifp != ifp;
1540 if (vifi >= V_numvifs)
1541 return 0; /* The iif is not found: ignore the packet. */
1543 if (rt->mfc_flags[vifi] & MRT_MFC_FLAGS_DISABLE_WRONGVIF)
1544 return 0; /* WRONGVIF disabled: ignore the packet */
1546 if (ratecheck(&rt->mfc_last_assert, &pim_assert_interval)) {
1547 struct sockaddr_in k_igmpsrc = { sizeof k_igmpsrc, AF_INET };
1549 int hlen = ip->ip_hl << 2;
1550 struct mbuf *mm = m_copy(m, 0, hlen);
1552 if (mm && (M_HASCL(mm) || mm->m_len < hlen))
1553 mm = m_pullup(mm, hlen);
1557 im = mtod(mm, struct igmpmsg *);
1558 im->im_msgtype = IGMPMSG_WRONGVIF;
1562 MRTSTAT_INC(mrts_upcalls);
1564 k_igmpsrc.sin_addr = im->im_src;
1565 if (socket_send(V_ip_mrouter, mm, &k_igmpsrc) < 0) {
1566 CTR1(KTR_IPMF, "%s: socket queue full", __func__);
1567 MRTSTAT_INC(mrts_upq_sockfull);
1576 /* If I sourced this packet, it counts as output, else it was input. */
1577 if (in_hosteq(ip->ip_src, V_viftable[vifi].v_lcl_addr)) {
1578 V_viftable[vifi].v_pkt_out++;
1579 V_viftable[vifi].v_bytes_out += plen;
1581 V_viftable[vifi].v_pkt_in++;
1582 V_viftable[vifi].v_bytes_in += plen;
1585 rt->mfc_byte_cnt += plen;
1588 * For each vif, decide if a copy of the packet should be forwarded.
1590 * - the ttl exceeds the vif's threshold
1591 * - there are group members downstream on interface
1593 for (vifi = 0; vifi < V_numvifs; vifi++)
1594 if ((rt->mfc_ttls[vifi] > 0) && (ip->ip_ttl > rt->mfc_ttls[vifi])) {
1595 V_viftable[vifi].v_pkt_out++;
1596 V_viftable[vifi].v_bytes_out += plen;
1597 if (V_viftable[vifi].v_flags & VIFF_REGISTER)
1598 pim_register_send(ip, V_viftable + vifi, m, rt);
1600 phyint_send(ip, V_viftable + vifi, m);
1604 * Perform upcall-related bw measuring.
1606 if (rt->mfc_bw_meter != NULL) {
1612 for (x = rt->mfc_bw_meter; x != NULL; x = x->bm_mfc_next)
1613 bw_meter_receive_packet(x, plen, &now);
1620 * Check if a vif number is legal/ok. This is used by in_mcast.c.
1623 X_legal_vif_num(int vif)
1632 if (vif < V_numvifs)
1640 * Return the local address used by this vif
1643 X_ip_mcast_src(int vifi)
1652 if (vifi < V_numvifs)
1653 addr = V_viftable[vifi].v_lcl_addr.s_addr;
1660 phyint_send(struct ip *ip, struct vif *vifp, struct mbuf *m)
1662 struct mbuf *mb_copy;
1663 int hlen = ip->ip_hl << 2;
1668 * Make a new reference to the packet; make sure that
1669 * the IP header is actually copied, not just referenced,
1670 * so that ip_output() only scribbles on the copy.
1672 mb_copy = m_copypacket(m, M_NOWAIT);
1673 if (mb_copy && (M_HASCL(mb_copy) || mb_copy->m_len < hlen))
1674 mb_copy = m_pullup(mb_copy, hlen);
1675 if (mb_copy == NULL)
1678 send_packet(vifp, mb_copy);
1682 send_packet(struct vif *vifp, struct mbuf *m)
1684 struct ip_moptions imo;
1685 struct in_multi *imm[2];
1690 imo.imo_multicast_ifp = vifp->v_ifp;
1691 imo.imo_multicast_ttl = mtod(m, struct ip *)->ip_ttl - 1;
1692 imo.imo_multicast_loop = 1;
1693 imo.imo_multicast_vif = -1;
1694 imo.imo_num_memberships = 0;
1695 imo.imo_max_memberships = 2;
1696 imo.imo_membership = &imm[0];
1699 * Re-entrancy should not be a problem here, because
1700 * the packets that we send out and are looped back at us
1701 * should get rejected because they appear to come from
1702 * the loopback interface, thus preventing looping.
1704 error = ip_output(m, NULL, NULL, IP_FORWARDING, &imo, NULL);
1705 CTR3(KTR_IPMF, "%s: vif %td err %d", __func__,
1706 (ptrdiff_t)(vifp - V_viftable), error);
1710 * Stubs for old RSVP socket shim implementation.
1714 X_ip_rsvp_vif(struct socket *so __unused, struct sockopt *sopt __unused)
1717 return (EOPNOTSUPP);
1721 X_ip_rsvp_force_done(struct socket *so __unused)
1727 X_rsvp_input(struct mbuf *m, int off __unused)
1735 * Code for bandwidth monitors
1739 * Define common interface for timeval-related methods
1741 #define BW_TIMEVALCMP(tvp, uvp, cmp) timevalcmp((tvp), (uvp), cmp)
1742 #define BW_TIMEVALDECR(vvp, uvp) timevalsub((vvp), (uvp))
1743 #define BW_TIMEVALADD(vvp, uvp) timevaladd((vvp), (uvp))
1746 compute_bw_meter_flags(struct bw_upcall *req)
1750 if (req->bu_flags & BW_UPCALL_UNIT_PACKETS)
1751 flags |= BW_METER_UNIT_PACKETS;
1752 if (req->bu_flags & BW_UPCALL_UNIT_BYTES)
1753 flags |= BW_METER_UNIT_BYTES;
1754 if (req->bu_flags & BW_UPCALL_GEQ)
1755 flags |= BW_METER_GEQ;
1756 if (req->bu_flags & BW_UPCALL_LEQ)
1757 flags |= BW_METER_LEQ;
1763 * Add a bw_meter entry
1766 add_bw_upcall(struct bw_upcall *req)
1769 struct timeval delta = { BW_UPCALL_THRESHOLD_INTERVAL_MIN_SEC,
1770 BW_UPCALL_THRESHOLD_INTERVAL_MIN_USEC };
1775 if (!(V_mrt_api_config & MRT_MFC_BW_UPCALL))
1778 /* Test if the flags are valid */
1779 if (!(req->bu_flags & (BW_UPCALL_UNIT_PACKETS | BW_UPCALL_UNIT_BYTES)))
1781 if (!(req->bu_flags & (BW_UPCALL_GEQ | BW_UPCALL_LEQ)))
1783 if ((req->bu_flags & (BW_UPCALL_GEQ | BW_UPCALL_LEQ))
1784 == (BW_UPCALL_GEQ | BW_UPCALL_LEQ))
1787 /* Test if the threshold time interval is valid */
1788 if (BW_TIMEVALCMP(&req->bu_threshold.b_time, &delta, <))
1791 flags = compute_bw_meter_flags(req);
1794 * Find if we have already same bw_meter entry
1797 mfc = mfc_find(&req->bu_src, &req->bu_dst);
1800 return EADDRNOTAVAIL;
1802 for (x = mfc->mfc_bw_meter; x != NULL; x = x->bm_mfc_next) {
1803 if ((BW_TIMEVALCMP(&x->bm_threshold.b_time,
1804 &req->bu_threshold.b_time, ==)) &&
1805 (x->bm_threshold.b_packets == req->bu_threshold.b_packets) &&
1806 (x->bm_threshold.b_bytes == req->bu_threshold.b_bytes) &&
1807 (x->bm_flags & BW_METER_USER_FLAGS) == flags) {
1809 return 0; /* XXX Already installed */
1813 /* Allocate the new bw_meter entry */
1814 x = (struct bw_meter *)malloc(sizeof(*x), M_BWMETER, M_NOWAIT);
1820 /* Set the new bw_meter entry */
1821 x->bm_threshold.b_time = req->bu_threshold.b_time;
1823 x->bm_start_time = now;
1824 x->bm_threshold.b_packets = req->bu_threshold.b_packets;
1825 x->bm_threshold.b_bytes = req->bu_threshold.b_bytes;
1826 x->bm_measured.b_packets = 0;
1827 x->bm_measured.b_bytes = 0;
1828 x->bm_flags = flags;
1829 x->bm_time_next = NULL;
1830 x->bm_time_hash = BW_METER_BUCKETS;
1832 /* Add the new bw_meter entry to the front of entries for this MFC */
1834 x->bm_mfc_next = mfc->mfc_bw_meter;
1835 mfc->mfc_bw_meter = x;
1836 schedule_bw_meter(x, &now);
1843 free_bw_list(struct bw_meter *list)
1845 while (list != NULL) {
1846 struct bw_meter *x = list;
1848 list = list->bm_mfc_next;
1849 unschedule_bw_meter(x);
1855 * Delete one or multiple bw_meter entries
1858 del_bw_upcall(struct bw_upcall *req)
1863 if (!(V_mrt_api_config & MRT_MFC_BW_UPCALL))
1868 /* Find the corresponding MFC entry */
1869 mfc = mfc_find(&req->bu_src, &req->bu_dst);
1872 return EADDRNOTAVAIL;
1873 } else if (req->bu_flags & BW_UPCALL_DELETE_ALL) {
1875 * Delete all bw_meter entries for this mfc
1877 struct bw_meter *list;
1879 list = mfc->mfc_bw_meter;
1880 mfc->mfc_bw_meter = NULL;
1884 } else { /* Delete a single bw_meter entry */
1885 struct bw_meter *prev;
1888 flags = compute_bw_meter_flags(req);
1890 /* Find the bw_meter entry to delete */
1891 for (prev = NULL, x = mfc->mfc_bw_meter; x != NULL;
1892 prev = x, x = x->bm_mfc_next) {
1893 if ((BW_TIMEVALCMP(&x->bm_threshold.b_time,
1894 &req->bu_threshold.b_time, ==)) &&
1895 (x->bm_threshold.b_packets == req->bu_threshold.b_packets) &&
1896 (x->bm_threshold.b_bytes == req->bu_threshold.b_bytes) &&
1897 (x->bm_flags & BW_METER_USER_FLAGS) == flags)
1900 if (x != NULL) { /* Delete entry from the list for this MFC */
1902 prev->bm_mfc_next = x->bm_mfc_next; /* remove from middle*/
1904 x->bm_mfc->mfc_bw_meter = x->bm_mfc_next;/* new head of list */
1906 unschedule_bw_meter(x);
1908 /* Free the bw_meter entry */
1920 * Perform bandwidth measurement processing that may result in an upcall
1923 bw_meter_receive_packet(struct bw_meter *x, int plen, struct timeval *nowp)
1925 struct timeval delta;
1930 BW_TIMEVALDECR(&delta, &x->bm_start_time);
1932 if (x->bm_flags & BW_METER_GEQ) {
1934 * Processing for ">=" type of bw_meter entry
1936 if (BW_TIMEVALCMP(&delta, &x->bm_threshold.b_time, >)) {
1937 /* Reset the bw_meter entry */
1938 x->bm_start_time = *nowp;
1939 x->bm_measured.b_packets = 0;
1940 x->bm_measured.b_bytes = 0;
1941 x->bm_flags &= ~BW_METER_UPCALL_DELIVERED;
1944 /* Record that a packet is received */
1945 x->bm_measured.b_packets++;
1946 x->bm_measured.b_bytes += plen;
1949 * Test if we should deliver an upcall
1951 if (!(x->bm_flags & BW_METER_UPCALL_DELIVERED)) {
1952 if (((x->bm_flags & BW_METER_UNIT_PACKETS) &&
1953 (x->bm_measured.b_packets >= x->bm_threshold.b_packets)) ||
1954 ((x->bm_flags & BW_METER_UNIT_BYTES) &&
1955 (x->bm_measured.b_bytes >= x->bm_threshold.b_bytes))) {
1956 /* Prepare an upcall for delivery */
1957 bw_meter_prepare_upcall(x, nowp);
1958 x->bm_flags |= BW_METER_UPCALL_DELIVERED;
1961 } else if (x->bm_flags & BW_METER_LEQ) {
1963 * Processing for "<=" type of bw_meter entry
1965 if (BW_TIMEVALCMP(&delta, &x->bm_threshold.b_time, >)) {
1967 * We are behind time with the multicast forwarding table
1968 * scanning for "<=" type of bw_meter entries, so test now
1969 * if we should deliver an upcall.
1971 if (((x->bm_flags & BW_METER_UNIT_PACKETS) &&
1972 (x->bm_measured.b_packets <= x->bm_threshold.b_packets)) ||
1973 ((x->bm_flags & BW_METER_UNIT_BYTES) &&
1974 (x->bm_measured.b_bytes <= x->bm_threshold.b_bytes))) {
1975 /* Prepare an upcall for delivery */
1976 bw_meter_prepare_upcall(x, nowp);
1978 /* Reschedule the bw_meter entry */
1979 unschedule_bw_meter(x);
1980 schedule_bw_meter(x, nowp);
1983 /* Record that a packet is received */
1984 x->bm_measured.b_packets++;
1985 x->bm_measured.b_bytes += plen;
1988 * Test if we should restart the measuring interval
1990 if ((x->bm_flags & BW_METER_UNIT_PACKETS &&
1991 x->bm_measured.b_packets <= x->bm_threshold.b_packets) ||
1992 (x->bm_flags & BW_METER_UNIT_BYTES &&
1993 x->bm_measured.b_bytes <= x->bm_threshold.b_bytes)) {
1994 /* Don't restart the measuring interval */
1996 /* Do restart the measuring interval */
1998 * XXX: note that we don't unschedule and schedule, because this
1999 * might be too much overhead per packet. Instead, when we process
2000 * all entries for a given timer hash bin, we check whether it is
2001 * really a timeout. If not, we reschedule at that time.
2003 x->bm_start_time = *nowp;
2004 x->bm_measured.b_packets = 0;
2005 x->bm_measured.b_bytes = 0;
2006 x->bm_flags &= ~BW_METER_UPCALL_DELIVERED;
2012 * Prepare a bandwidth-related upcall
2015 bw_meter_prepare_upcall(struct bw_meter *x, struct timeval *nowp)
2017 struct timeval delta;
2018 struct bw_upcall *u;
2023 * Compute the measured time interval
2026 BW_TIMEVALDECR(&delta, &x->bm_start_time);
2029 * If there are too many pending upcalls, deliver them now
2031 if (V_bw_upcalls_n >= BW_UPCALLS_MAX)
2035 * Set the bw_upcall entry
2037 u = &V_bw_upcalls[V_bw_upcalls_n++];
2038 u->bu_src = x->bm_mfc->mfc_origin;
2039 u->bu_dst = x->bm_mfc->mfc_mcastgrp;
2040 u->bu_threshold.b_time = x->bm_threshold.b_time;
2041 u->bu_threshold.b_packets = x->bm_threshold.b_packets;
2042 u->bu_threshold.b_bytes = x->bm_threshold.b_bytes;
2043 u->bu_measured.b_time = delta;
2044 u->bu_measured.b_packets = x->bm_measured.b_packets;
2045 u->bu_measured.b_bytes = x->bm_measured.b_bytes;
2047 if (x->bm_flags & BW_METER_UNIT_PACKETS)
2048 u->bu_flags |= BW_UPCALL_UNIT_PACKETS;
2049 if (x->bm_flags & BW_METER_UNIT_BYTES)
2050 u->bu_flags |= BW_UPCALL_UNIT_BYTES;
2051 if (x->bm_flags & BW_METER_GEQ)
2052 u->bu_flags |= BW_UPCALL_GEQ;
2053 if (x->bm_flags & BW_METER_LEQ)
2054 u->bu_flags |= BW_UPCALL_LEQ;
2058 * Send the pending bandwidth-related upcalls
2061 bw_upcalls_send(void)
2064 int len = V_bw_upcalls_n * sizeof(V_bw_upcalls[0]);
2065 struct sockaddr_in k_igmpsrc = { sizeof k_igmpsrc, AF_INET };
2066 static struct igmpmsg igmpmsg = { 0, /* unused1 */
2068 IGMPMSG_BW_UPCALL,/* im_msgtype */
2073 { 0 } }; /* im_dst */
2077 if (V_bw_upcalls_n == 0)
2078 return; /* No pending upcalls */
2083 * Allocate a new mbuf, initialize it with the header and
2084 * the payload for the pending calls.
2086 MGETHDR(m, M_NOWAIT, MT_DATA);
2088 log(LOG_WARNING, "bw_upcalls_send: cannot allocate mbuf\n");
2092 m->m_len = m->m_pkthdr.len = 0;
2093 m_copyback(m, 0, sizeof(struct igmpmsg), (caddr_t)&igmpmsg);
2094 m_copyback(m, sizeof(struct igmpmsg), len, (caddr_t)&V_bw_upcalls[0]);
2098 * XXX do we need to set the address in k_igmpsrc ?
2100 MRTSTAT_INC(mrts_upcalls);
2101 if (socket_send(V_ip_mrouter, m, &k_igmpsrc) < 0) {
2102 log(LOG_WARNING, "bw_upcalls_send: ip_mrouter socket queue full\n");
2103 MRTSTAT_INC(mrts_upq_sockfull);
2108 * Compute the timeout hash value for the bw_meter entries
2110 #define BW_METER_TIMEHASH(bw_meter, hash) \
2112 struct timeval next_timeval = (bw_meter)->bm_start_time; \
2114 BW_TIMEVALADD(&next_timeval, &(bw_meter)->bm_threshold.b_time); \
2115 (hash) = next_timeval.tv_sec; \
2116 if (next_timeval.tv_usec) \
2117 (hash)++; /* XXX: make sure we don't timeout early */ \
2118 (hash) %= BW_METER_BUCKETS; \
2122 * Schedule a timer to process periodically bw_meter entry of type "<="
2123 * by linking the entry in the proper hash bucket.
2126 schedule_bw_meter(struct bw_meter *x, struct timeval *nowp)
2132 if (!(x->bm_flags & BW_METER_LEQ))
2133 return; /* XXX: we schedule timers only for "<=" entries */
2136 * Reset the bw_meter entry
2138 x->bm_start_time = *nowp;
2139 x->bm_measured.b_packets = 0;
2140 x->bm_measured.b_bytes = 0;
2141 x->bm_flags &= ~BW_METER_UPCALL_DELIVERED;
2144 * Compute the timeout hash value and insert the entry
2146 BW_METER_TIMEHASH(x, time_hash);
2147 x->bm_time_next = V_bw_meter_timers[time_hash];
2148 V_bw_meter_timers[time_hash] = x;
2149 x->bm_time_hash = time_hash;
2153 * Unschedule the periodic timer that processes bw_meter entry of type "<="
2154 * by removing the entry from the proper hash bucket.
2157 unschedule_bw_meter(struct bw_meter *x)
2160 struct bw_meter *prev, *tmp;
2164 if (!(x->bm_flags & BW_METER_LEQ))
2165 return; /* XXX: we schedule timers only for "<=" entries */
2168 * Compute the timeout hash value and delete the entry
2170 time_hash = x->bm_time_hash;
2171 if (time_hash >= BW_METER_BUCKETS)
2172 return; /* Entry was not scheduled */
2174 for (prev = NULL, tmp = V_bw_meter_timers[time_hash];
2175 tmp != NULL; prev = tmp, tmp = tmp->bm_time_next)
2180 panic("unschedule_bw_meter: bw_meter entry not found");
2183 prev->bm_time_next = x->bm_time_next;
2185 V_bw_meter_timers[time_hash] = x->bm_time_next;
2187 x->bm_time_next = NULL;
2188 x->bm_time_hash = BW_METER_BUCKETS;
2193 * Process all "<=" type of bw_meter that should be processed now,
2194 * and for each entry prepare an upcall if necessary. Each processed
2195 * entry is rescheduled again for the (periodic) processing.
2197 * This is run periodically (once per second normally). On each round,
2198 * all the potentially matching entries are in the hash slot that we are
2206 struct timeval now, process_endtime;
2209 if (V_last_tv_sec == now.tv_sec)
2210 return; /* nothing to do */
2212 loops = now.tv_sec - V_last_tv_sec;
2213 V_last_tv_sec = now.tv_sec;
2214 if (loops > BW_METER_BUCKETS)
2215 loops = BW_METER_BUCKETS;
2219 * Process all bins of bw_meter entries from the one after the last
2220 * processed to the current one. On entry, i points to the last bucket
2221 * visited, so we need to increment i at the beginning of the loop.
2223 for (i = (now.tv_sec - loops) % BW_METER_BUCKETS; loops > 0; loops--) {
2224 struct bw_meter *x, *tmp_list;
2226 if (++i >= BW_METER_BUCKETS)
2229 /* Disconnect the list of bw_meter entries from the bin */
2230 tmp_list = V_bw_meter_timers[i];
2231 V_bw_meter_timers[i] = NULL;
2233 /* Process the list of bw_meter entries */
2234 while (tmp_list != NULL) {
2236 tmp_list = tmp_list->bm_time_next;
2238 /* Test if the time interval is over */
2239 process_endtime = x->bm_start_time;
2240 BW_TIMEVALADD(&process_endtime, &x->bm_threshold.b_time);
2241 if (BW_TIMEVALCMP(&process_endtime, &now, >)) {
2242 /* Not yet: reschedule, but don't reset */
2245 BW_METER_TIMEHASH(x, time_hash);
2246 if (time_hash == i && process_endtime.tv_sec == now.tv_sec) {
2248 * XXX: somehow the bin processing is a bit ahead of time.
2249 * Put the entry in the next bin.
2251 if (++time_hash >= BW_METER_BUCKETS)
2254 x->bm_time_next = V_bw_meter_timers[time_hash];
2255 V_bw_meter_timers[time_hash] = x;
2256 x->bm_time_hash = time_hash;
2262 * Test if we should deliver an upcall
2264 if (((x->bm_flags & BW_METER_UNIT_PACKETS) &&
2265 (x->bm_measured.b_packets <= x->bm_threshold.b_packets)) ||
2266 ((x->bm_flags & BW_METER_UNIT_BYTES) &&
2267 (x->bm_measured.b_bytes <= x->bm_threshold.b_bytes))) {
2268 /* Prepare an upcall for delivery */
2269 bw_meter_prepare_upcall(x, &now);
2273 * Reschedule for next processing
2275 schedule_bw_meter(x, &now);
2279 /* Send all upcalls that are pending delivery */
2286 * A periodic function for sending all upcalls that are pending delivery
2289 expire_bw_upcalls_send(void *arg)
2291 CURVNET_SET((struct vnet *) arg);
2297 callout_reset(&V_bw_upcalls_ch, BW_UPCALLS_PERIOD, expire_bw_upcalls_send,
2303 * A periodic function for periodic scanning of the multicast forwarding
2304 * table for processing all "<=" bw_meter entries.
2307 expire_bw_meter_process(void *arg)
2309 CURVNET_SET((struct vnet *) arg);
2311 if (V_mrt_api_config & MRT_MFC_BW_UPCALL)
2314 callout_reset(&V_bw_meter_ch, BW_METER_PERIOD, expire_bw_meter_process,
2320 * End of bandwidth monitoring code
2324 * Send the packet up to the user daemon, or eventually do kernel encapsulation
2328 pim_register_send(struct ip *ip, struct vif *vifp, struct mbuf *m,
2331 struct mbuf *mb_copy, *mm;
2334 * Do not send IGMP_WHOLEPKT notifications to userland, if the
2335 * rendezvous point was unspecified, and we were told not to.
2337 if (pim_squelch_wholepkt != 0 && (V_mrt_api_config & MRT_MFC_RP) &&
2338 in_nullhost(rt->mfc_rp))
2341 mb_copy = pim_register_prepare(ip, m);
2342 if (mb_copy == NULL)
2346 * Send all the fragments. Note that the mbuf for each fragment
2347 * is freed by the sending machinery.
2349 for (mm = mb_copy; mm; mm = mb_copy) {
2350 mb_copy = mm->m_nextpkt;
2352 mm = m_pullup(mm, sizeof(struct ip));
2354 ip = mtod(mm, struct ip *);
2355 if ((V_mrt_api_config & MRT_MFC_RP) && !in_nullhost(rt->mfc_rp)) {
2356 pim_register_send_rp(ip, vifp, mm, rt);
2358 pim_register_send_upcall(ip, vifp, mm, rt);
2367 * Return a copy of the data packet that is ready for PIM Register
2369 * XXX: Note that in the returned copy the IP header is a valid one.
2371 static struct mbuf *
2372 pim_register_prepare(struct ip *ip, struct mbuf *m)
2374 struct mbuf *mb_copy = NULL;
2377 /* Take care of delayed checksums */
2378 if (m->m_pkthdr.csum_flags & CSUM_DELAY_DATA) {
2379 in_delayed_cksum(m);
2380 m->m_pkthdr.csum_flags &= ~CSUM_DELAY_DATA;
2384 * Copy the old packet & pullup its IP header into the
2385 * new mbuf so we can modify it.
2387 mb_copy = m_copypacket(m, M_NOWAIT);
2388 if (mb_copy == NULL)
2390 mb_copy = m_pullup(mb_copy, ip->ip_hl << 2);
2391 if (mb_copy == NULL)
2394 /* take care of the TTL */
2395 ip = mtod(mb_copy, struct ip *);
2398 /* Compute the MTU after the PIM Register encapsulation */
2399 mtu = 0xffff - sizeof(pim_encap_iphdr) - sizeof(pim_encap_pimhdr);
2401 if (ntohs(ip->ip_len) <= mtu) {
2402 /* Turn the IP header into a valid one */
2404 ip->ip_sum = in_cksum(mb_copy, ip->ip_hl << 2);
2406 /* Fragment the packet */
2407 mb_copy->m_pkthdr.csum_flags |= CSUM_IP;
2408 if (ip_fragment(ip, &mb_copy, mtu, 0) != 0) {
2417 * Send an upcall with the data packet to the user-level process.
2420 pim_register_send_upcall(struct ip *ip, struct vif *vifp,
2421 struct mbuf *mb_copy, struct mfc *rt)
2423 struct mbuf *mb_first;
2424 int len = ntohs(ip->ip_len);
2426 struct sockaddr_in k_igmpsrc = { sizeof k_igmpsrc, AF_INET };
2431 * Add a new mbuf with an upcall header
2433 MGETHDR(mb_first, M_NOWAIT, MT_DATA);
2434 if (mb_first == NULL) {
2438 mb_first->m_data += max_linkhdr;
2439 mb_first->m_pkthdr.len = len + sizeof(struct igmpmsg);
2440 mb_first->m_len = sizeof(struct igmpmsg);
2441 mb_first->m_next = mb_copy;
2443 /* Send message to routing daemon */
2444 im = mtod(mb_first, struct igmpmsg *);
2445 im->im_msgtype = IGMPMSG_WHOLEPKT;
2447 im->im_vif = vifp - V_viftable;
2448 im->im_src = ip->ip_src;
2449 im->im_dst = ip->ip_dst;
2451 k_igmpsrc.sin_addr = ip->ip_src;
2453 MRTSTAT_INC(mrts_upcalls);
2455 if (socket_send(V_ip_mrouter, mb_first, &k_igmpsrc) < 0) {
2456 CTR1(KTR_IPMF, "%s: socket queue full", __func__);
2457 MRTSTAT_INC(mrts_upq_sockfull);
2461 /* Keep statistics */
2462 PIMSTAT_INC(pims_snd_registers_msgs);
2463 PIMSTAT_ADD(pims_snd_registers_bytes, len);
2469 * Encapsulate the data packet in PIM Register message and send it to the RP.
2472 pim_register_send_rp(struct ip *ip, struct vif *vifp, struct mbuf *mb_copy,
2475 struct mbuf *mb_first;
2476 struct ip *ip_outer;
2477 struct pim_encap_pimhdr *pimhdr;
2478 int len = ntohs(ip->ip_len);
2479 vifi_t vifi = rt->mfc_parent;
2483 if ((vifi >= V_numvifs) || in_nullhost(V_viftable[vifi].v_lcl_addr)) {
2485 return EADDRNOTAVAIL; /* The iif vif is invalid */
2489 * Add a new mbuf with the encapsulating header
2491 MGETHDR(mb_first, M_NOWAIT, MT_DATA);
2492 if (mb_first == NULL) {
2496 mb_first->m_data += max_linkhdr;
2497 mb_first->m_len = sizeof(pim_encap_iphdr) + sizeof(pim_encap_pimhdr);
2498 mb_first->m_next = mb_copy;
2500 mb_first->m_pkthdr.len = len + mb_first->m_len;
2503 * Fill in the encapsulating IP and PIM header
2505 ip_outer = mtod(mb_first, struct ip *);
2506 *ip_outer = pim_encap_iphdr;
2507 ip_outer->ip_id = ip_newid();
2508 ip_outer->ip_len = htons(len + sizeof(pim_encap_iphdr) +
2509 sizeof(pim_encap_pimhdr));
2510 ip_outer->ip_src = V_viftable[vifi].v_lcl_addr;
2511 ip_outer->ip_dst = rt->mfc_rp;
2513 * Copy the inner header TOS to the outer header, and take care of the
2516 ip_outer->ip_tos = ip->ip_tos;
2517 if (ip->ip_off & htons(IP_DF))
2518 ip_outer->ip_off |= htons(IP_DF);
2519 pimhdr = (struct pim_encap_pimhdr *)((caddr_t)ip_outer
2520 + sizeof(pim_encap_iphdr));
2521 *pimhdr = pim_encap_pimhdr;
2522 /* If the iif crosses a border, set the Border-bit */
2523 if (rt->mfc_flags[vifi] & MRT_MFC_FLAGS_BORDER_VIF & V_mrt_api_config)
2524 pimhdr->flags |= htonl(PIM_BORDER_REGISTER);
2526 mb_first->m_data += sizeof(pim_encap_iphdr);
2527 pimhdr->pim.pim_cksum = in_cksum(mb_first, sizeof(pim_encap_pimhdr));
2528 mb_first->m_data -= sizeof(pim_encap_iphdr);
2530 send_packet(vifp, mb_first);
2532 /* Keep statistics */
2533 PIMSTAT_INC(pims_snd_registers_msgs);
2534 PIMSTAT_ADD(pims_snd_registers_bytes, len);
2540 * pim_encapcheck() is called by the encap4_input() path at runtime to
2541 * determine if a packet is for PIM; allowing PIM to be dynamically loaded
2545 pim_encapcheck(const struct mbuf *m, int off, int proto, void *arg)
2549 KASSERT(proto == IPPROTO_PIM, ("not for IPPROTO_PIM"));
2551 if (proto != IPPROTO_PIM)
2552 return 0; /* not for us; reject the datagram. */
2554 return 64; /* claim the datagram. */
2558 * PIM-SMv2 and PIM-DM messages processing.
2559 * Receives and verifies the PIM control messages, and passes them
2560 * up to the listening socket, using rip_input().
2561 * The only message with special processing is the PIM_REGISTER message
2562 * (used by PIM-SM): the PIM header is stripped off, and the inner packet
2563 * is passed to if_simloop().
2566 pim_input(struct mbuf *m, int off)
2568 struct ip *ip = mtod(m, struct ip *);
2571 int datalen = ntohs(ip->ip_len);
2575 /* Keep statistics */
2576 PIMSTAT_INC(pims_rcv_total_msgs);
2577 PIMSTAT_ADD(pims_rcv_total_bytes, datalen);
2582 if (datalen < PIM_MINLEN) {
2583 PIMSTAT_INC(pims_rcv_tooshort);
2584 CTR3(KTR_IPMF, "%s: short packet (%d) from %s",
2585 __func__, datalen, inet_ntoa(ip->ip_src));
2591 * If the packet is at least as big as a REGISTER, go agead
2592 * and grab the PIM REGISTER header size, to avoid another
2593 * possible m_pullup() later.
2595 * PIM_MINLEN == pimhdr + u_int32_t == 4 + 4 = 8
2596 * PIM_REG_MINLEN == pimhdr + reghdr + encap_iphdr == 4 + 4 + 20 = 28
2598 minlen = iphlen + (datalen >= PIM_REG_MINLEN ? PIM_REG_MINLEN : PIM_MINLEN);
2600 * Get the IP and PIM headers in contiguous memory, and
2601 * possibly the PIM REGISTER header.
2603 if ((m->m_flags & M_EXT || m->m_len < minlen) &&
2604 (m = m_pullup(m, minlen)) == 0) {
2605 CTR1(KTR_IPMF, "%s: m_pullup() failed", __func__);
2609 /* m_pullup() may have given us a new mbuf so reset ip. */
2610 ip = mtod(m, struct ip *);
2611 ip_tos = ip->ip_tos;
2613 /* adjust mbuf to point to the PIM header */
2614 m->m_data += iphlen;
2616 pim = mtod(m, struct pim *);
2619 * Validate checksum. If PIM REGISTER, exclude the data packet.
2621 * XXX: some older PIMv2 implementations don't make this distinction,
2622 * so for compatibility reason perform the checksum over part of the
2623 * message, and if error, then over the whole message.
2625 if (PIM_VT_T(pim->pim_vt) == PIM_REGISTER && in_cksum(m, PIM_MINLEN) == 0) {
2626 /* do nothing, checksum okay */
2627 } else if (in_cksum(m, datalen)) {
2628 PIMSTAT_INC(pims_rcv_badsum);
2629 CTR1(KTR_IPMF, "%s: invalid checksum", __func__);
2634 /* PIM version check */
2635 if (PIM_VT_V(pim->pim_vt) < PIM_VERSION) {
2636 PIMSTAT_INC(pims_rcv_badversion);
2637 CTR3(KTR_IPMF, "%s: bad version %d expect %d", __func__,
2638 (int)PIM_VT_V(pim->pim_vt), PIM_VERSION);
2643 /* restore mbuf back to the outer IP */
2644 m->m_data -= iphlen;
2647 if (PIM_VT_T(pim->pim_vt) == PIM_REGISTER) {
2649 * Since this is a REGISTER, we'll make a copy of the register
2650 * headers ip + pim + u_int32 + encap_ip, to be passed up to the
2653 struct sockaddr_in dst = { sizeof(dst), AF_INET };
2655 struct ip *encap_ip;
2660 if ((V_reg_vif_num >= V_numvifs) || (V_reg_vif_num == VIFI_INVALID)) {
2662 CTR2(KTR_IPMF, "%s: register vif not set: %d", __func__,
2663 (int)V_reg_vif_num);
2667 /* XXX need refcnt? */
2668 vifp = V_viftable[V_reg_vif_num].v_ifp;
2674 if (datalen < PIM_REG_MINLEN) {
2675 PIMSTAT_INC(pims_rcv_tooshort);
2676 PIMSTAT_INC(pims_rcv_badregisters);
2677 CTR1(KTR_IPMF, "%s: register packet size too small", __func__);
2682 reghdr = (u_int32_t *)(pim + 1);
2683 encap_ip = (struct ip *)(reghdr + 1);
2685 CTR3(KTR_IPMF, "%s: register: encap ip src %s len %d",
2686 __func__, inet_ntoa(encap_ip->ip_src), ntohs(encap_ip->ip_len));
2688 /* verify the version number of the inner packet */
2689 if (encap_ip->ip_v != IPVERSION) {
2690 PIMSTAT_INC(pims_rcv_badregisters);
2691 CTR1(KTR_IPMF, "%s: bad encap ip version", __func__);
2696 /* verify the inner packet is destined to a mcast group */
2697 if (!IN_MULTICAST(ntohl(encap_ip->ip_dst.s_addr))) {
2698 PIMSTAT_INC(pims_rcv_badregisters);
2699 CTR2(KTR_IPMF, "%s: bad encap ip dest %s", __func__,
2700 inet_ntoa(encap_ip->ip_dst));
2705 /* If a NULL_REGISTER, pass it to the daemon */
2706 if ((ntohl(*reghdr) & PIM_NULL_REGISTER))
2707 goto pim_input_to_daemon;
2710 * Copy the TOS from the outer IP header to the inner IP header.
2712 if (encap_ip->ip_tos != ip_tos) {
2713 /* Outer TOS -> inner TOS */
2714 encap_ip->ip_tos = ip_tos;
2715 /* Recompute the inner header checksum. Sigh... */
2717 /* adjust mbuf to point to the inner IP header */
2718 m->m_data += (iphlen + PIM_MINLEN);
2719 m->m_len -= (iphlen + PIM_MINLEN);
2721 encap_ip->ip_sum = 0;
2722 encap_ip->ip_sum = in_cksum(m, encap_ip->ip_hl << 2);
2724 /* restore mbuf to point back to the outer IP header */
2725 m->m_data -= (iphlen + PIM_MINLEN);
2726 m->m_len += (iphlen + PIM_MINLEN);
2730 * Decapsulate the inner IP packet and loopback to forward it
2731 * as a normal multicast packet. Also, make a copy of the
2732 * outer_iphdr + pimhdr + reghdr + encap_iphdr
2733 * to pass to the daemon later, so it can take the appropriate
2734 * actions (e.g., send back PIM_REGISTER_STOP).
2735 * XXX: here m->m_data points to the outer IP header.
2737 mcp = m_copy(m, 0, iphlen + PIM_REG_MINLEN);
2739 CTR1(KTR_IPMF, "%s: m_copy() failed", __func__);
2744 /* Keep statistics */
2745 /* XXX: registers_bytes include only the encap. mcast pkt */
2746 PIMSTAT_INC(pims_rcv_registers_msgs);
2747 PIMSTAT_ADD(pims_rcv_registers_bytes, ntohs(encap_ip->ip_len));
2750 * forward the inner ip packet; point m_data at the inner ip.
2752 m_adj(m, iphlen + PIM_MINLEN);
2755 "%s: forward decap'd REGISTER: src %lx dst %lx vif %d",
2757 (u_long)ntohl(encap_ip->ip_src.s_addr),
2758 (u_long)ntohl(encap_ip->ip_dst.s_addr),
2759 (int)V_reg_vif_num);
2761 /* NB: vifp was collected above; can it change on us? */
2762 if_simloop(vifp, m, dst.sin_family, 0);
2764 /* prepare the register head to send to the mrouting daemon */
2768 pim_input_to_daemon:
2770 * Pass the PIM message up to the daemon; if it is a Register message,
2771 * pass the 'head' only up to the daemon. This includes the
2772 * outer IP header, PIM header, PIM-Register header and the
2774 * XXX: the outer IP header pkt size of a Register is not adjust to
2775 * reflect the fact that the inner multicast data is truncated.
2777 rip_input(m, iphlen);
2783 sysctl_mfctable(SYSCTL_HANDLER_ARGS)
2790 if (V_mfchashtbl == NULL) /* XXX unlocked */
2792 error = sysctl_wire_old_buffer(req, 0);
2797 for (i = 0; i < mfchashsize; i++) {
2798 LIST_FOREACH(rt, &V_mfchashtbl[i], mfc_hash) {
2799 error = SYSCTL_OUT(req, rt, sizeof(struct mfc));
2809 static SYSCTL_NODE(_net_inet_ip, OID_AUTO, mfctable, CTLFLAG_RD,
2810 sysctl_mfctable, "IPv4 Multicast Forwarding Table "
2811 "(struct *mfc[mfchashsize], netinet/ip_mroute.h)");
2814 vnet_mroute_init(const void *unused __unused)
2817 MALLOC(V_nexpire, u_char *, mfchashsize, M_MRTABLE, M_WAITOK|M_ZERO);
2818 bzero(V_bw_meter_timers, sizeof(V_bw_meter_timers));
2819 callout_init(&V_expire_upcalls_ch, CALLOUT_MPSAFE);
2820 callout_init(&V_bw_upcalls_ch, CALLOUT_MPSAFE);
2821 callout_init(&V_bw_meter_ch, CALLOUT_MPSAFE);
2824 VNET_SYSINIT(vnet_mroute_init, SI_SUB_PSEUDO, SI_ORDER_ANY, vnet_mroute_init,
2828 vnet_mroute_uninit(const void *unused __unused)
2831 FREE(V_nexpire, M_MRTABLE);
2835 VNET_SYSUNINIT(vnet_mroute_uninit, SI_SUB_PSEUDO, SI_ORDER_MIDDLE,
2836 vnet_mroute_uninit, NULL);
2839 ip_mroute_modevent(module_t mod, int type, void *unused)
2844 MROUTER_LOCK_INIT();
2846 if_detach_event_tag = EVENTHANDLER_REGISTER(ifnet_departure_event,
2847 if_detached_event, NULL, EVENTHANDLER_PRI_ANY);
2848 if (if_detach_event_tag == NULL) {
2849 printf("ip_mroute: unable to ifnet_deperture_even handler\n");
2850 MROUTER_LOCK_DESTROY();
2857 mfchashsize = MFCHASHSIZE;
2858 if (TUNABLE_ULONG_FETCH("net.inet.ip.mfchashsize", &mfchashsize) &&
2859 !powerof2(mfchashsize)) {
2860 printf("WARNING: %s not a power of 2; using default\n",
2861 "net.inet.ip.mfchashsize");
2862 mfchashsize = MFCHASHSIZE;
2865 pim_squelch_wholepkt = 0;
2866 TUNABLE_ULONG_FETCH("net.inet.pim.squelch_wholepkt",
2867 &pim_squelch_wholepkt);
2869 pim_encap_cookie = encap_attach_func(AF_INET, IPPROTO_PIM,
2870 pim_encapcheck, &in_pim_protosw, NULL);
2871 if (pim_encap_cookie == NULL) {
2872 printf("ip_mroute: unable to attach pim encap\n");
2875 MROUTER_LOCK_DESTROY();
2879 ip_mcast_src = X_ip_mcast_src;
2880 ip_mforward = X_ip_mforward;
2881 ip_mrouter_done = X_ip_mrouter_done;
2882 ip_mrouter_get = X_ip_mrouter_get;
2883 ip_mrouter_set = X_ip_mrouter_set;
2885 ip_rsvp_force_done = X_ip_rsvp_force_done;
2886 ip_rsvp_vif = X_ip_rsvp_vif;
2888 legal_vif_num = X_legal_vif_num;
2889 mrt_ioctl = X_mrt_ioctl;
2890 rsvp_input_p = X_rsvp_input;
2895 * Typically module unload happens after the user-level
2896 * process has shutdown the kernel services (the check
2897 * below insures someone can't just yank the module out
2898 * from under a running process). But if the module is
2899 * just loaded and then unloaded w/o starting up a user
2900 * process we still need to cleanup.
2903 if (ip_mrouter_cnt != 0) {
2907 ip_mrouter_unloading = 1;
2910 EVENTHANDLER_DEREGISTER(ifnet_departure_event, if_detach_event_tag);
2912 if (pim_encap_cookie) {
2913 encap_detach(pim_encap_cookie);
2914 pim_encap_cookie = NULL;
2917 ip_mcast_src = NULL;
2919 ip_mrouter_done = NULL;
2920 ip_mrouter_get = NULL;
2921 ip_mrouter_set = NULL;
2923 ip_rsvp_force_done = NULL;
2926 legal_vif_num = NULL;
2928 rsvp_input_p = NULL;
2932 MROUTER_LOCK_DESTROY();
2941 static moduledata_t ip_mroutemod = {
2947 DECLARE_MODULE(ip_mroute, ip_mroutemod, SI_SUB_PSEUDO, SI_ORDER_MIDDLE);