2 * SPDX-License-Identifier: BSD-3-Clause
4 * Copyright (c) 1989 Stephen Deering
5 * Copyright (c) 1992, 1993
6 * The Regents of the University of California. All rights reserved.
8 * This code is derived from software contributed to Berkeley by
9 * Stephen Deering of Stanford University.
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
14 * 1. Redistributions of source code must retain the above copyright
15 * notice, this list of conditions and the following disclaimer.
16 * 2. Redistributions in binary form must reproduce the above copyright
17 * notice, this list of conditions and the following disclaimer in the
18 * documentation and/or other materials provided with the distribution.
19 * 3. Neither the name of the University nor the names of its contributors
20 * may be used to endorse or promote products derived from this software
21 * without specific prior written permission.
23 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
24 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
27 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
28 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
29 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
32 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
35 * @(#)ip_mroute.c 8.2 (Berkeley) 11/15/93
39 * IP multicast forwarding procedures
41 * Written by David Waitzman, BBN Labs, August 1988.
42 * Modified by Steve Deering, Stanford, February 1989.
43 * Modified by Mark J. Steiglitz, Stanford, May, 1991
44 * Modified by Van Jacobson, LBL, January 1993
45 * Modified by Ajit Thyagarajan, PARC, August 1993
46 * Modified by Bill Fenner, PARC, April 1995
47 * Modified by Ahmed Helmy, SGI, June 1996
48 * Modified by George Edmond Eddy (Rusty), ISI, February 1998
49 * Modified by Pavlin Radoslavov, USC/ISI, May 1998, August 1999, October 2000
50 * Modified by Hitoshi Asaeda, WIDE, August 2000
51 * Modified by Pavlin Radoslavov, ICSI, October 2002
53 * MROUTING Revision: 3.5
54 * and PIM-SMv2 and PIM-DM support, advanced API support,
55 * bandwidth metering and signaling
59 * TODO: Prefix functions with ipmf_.
60 * TODO: Maintain a refcount on if_allmulti() in ifnet or in the protocol
61 * domain attachment (if_afdata) so we can track consumers of that service.
62 * TODO: Deprecate routing socket path for SIOCGETSGCNT and SIOCGETVIFCNT,
63 * move it to socket options.
64 * TODO: Cleanup LSRR removal further.
65 * TODO: Push RSVP stubs into raw_ip.c.
66 * TODO: Use bitstring.h for vif set.
67 * TODO: Fix mrt6_ioctl dangling ref when dynamically loaded.
68 * TODO: Sync ip6_mroute.c with this file.
71 #include <sys/cdefs.h>
72 __FBSDID("$FreeBSD$");
75 #include "opt_mrouting.h"
79 #include <sys/param.h>
80 #include <sys/kernel.h>
81 #include <sys/stddef.h>
82 #include <sys/eventhandler.h>
85 #include <sys/malloc.h>
87 #include <sys/module.h>
89 #include <sys/protosw.h>
90 #include <sys/signalvar.h>
91 #include <sys/socket.h>
92 #include <sys/socketvar.h>
93 #include <sys/sockio.h>
95 #include <sys/sysctl.h>
96 #include <sys/syslog.h>
97 #include <sys/systm.h>
99 #include <sys/counter.h>
102 #include <net/if_var.h>
103 #include <net/netisr.h>
104 #include <net/route.h>
105 #include <net/vnet.h>
107 #include <netinet/in.h>
108 #include <netinet/igmp.h>
109 #include <netinet/in_systm.h>
110 #include <netinet/in_var.h>
111 #include <netinet/ip.h>
112 #include <netinet/ip_encap.h>
113 #include <netinet/ip_mroute.h>
114 #include <netinet/ip_var.h>
115 #include <netinet/ip_options.h>
116 #include <netinet/pim.h>
117 #include <netinet/pim_var.h>
118 #include <netinet/udp.h>
120 #include <machine/in_cksum.h>
123 #define KTR_IPMF KTR_INET
126 #define VIFI_INVALID ((vifi_t) -1)
128 VNET_DEFINE_STATIC(uint32_t, last_tv_sec); /* last time we processed this */
129 #define V_last_tv_sec VNET(last_tv_sec)
131 static MALLOC_DEFINE(M_MRTABLE, "mroutetbl", "multicast forwarding cache");
134 * Locking. We use two locks: one for the virtual interface table and
135 * one for the forwarding table. These locks may be nested in which case
136 * the VIF lock must always be taken first. Note that each lock is used
137 * to cover not only the specific data structure but also related data
141 static struct mtx mrouter_mtx;
142 #define MROUTER_LOCK() mtx_lock(&mrouter_mtx)
143 #define MROUTER_UNLOCK() mtx_unlock(&mrouter_mtx)
144 #define MROUTER_LOCK_ASSERT() mtx_assert(&mrouter_mtx, MA_OWNED)
145 #define MROUTER_LOCK_INIT() \
146 mtx_init(&mrouter_mtx, "IPv4 multicast forwarding", NULL, MTX_DEF)
147 #define MROUTER_LOCK_DESTROY() mtx_destroy(&mrouter_mtx)
149 static int ip_mrouter_cnt; /* # of vnets with active mrouters */
150 static int ip_mrouter_unloading; /* Allow no more V_ip_mrouter sockets */
152 VNET_PCPUSTAT_DEFINE_STATIC(struct mrtstat, mrtstat);
153 VNET_PCPUSTAT_SYSINIT(mrtstat);
154 VNET_PCPUSTAT_SYSUNINIT(mrtstat);
155 SYSCTL_VNET_PCPUSTAT(_net_inet_ip, OID_AUTO, mrtstat, struct mrtstat,
156 mrtstat, "IPv4 Multicast Forwarding Statistics (struct mrtstat, "
157 "netinet/ip_mroute.h)");
159 VNET_DEFINE_STATIC(u_long, mfchash);
160 #define V_mfchash VNET(mfchash)
161 #define MFCHASH(a, g) \
162 ((((a).s_addr >> 20) ^ ((a).s_addr >> 10) ^ (a).s_addr ^ \
163 ((g).s_addr >> 20) ^ ((g).s_addr >> 10) ^ (g).s_addr) & V_mfchash)
164 #define MFCHASHSIZE 256
166 static u_long mfchashsize; /* Hash size */
167 VNET_DEFINE_STATIC(u_char *, nexpire); /* 0..mfchashsize-1 */
168 #define V_nexpire VNET(nexpire)
169 VNET_DEFINE_STATIC(LIST_HEAD(mfchashhdr, mfc)*, mfchashtbl);
170 #define V_mfchashtbl VNET(mfchashtbl)
172 static struct mtx mfc_mtx;
173 #define MFC_LOCK() mtx_lock(&mfc_mtx)
174 #define MFC_UNLOCK() mtx_unlock(&mfc_mtx)
175 #define MFC_LOCK_ASSERT() mtx_assert(&mfc_mtx, MA_OWNED)
176 #define MFC_LOCK_INIT() \
177 mtx_init(&mfc_mtx, "IPv4 multicast forwarding cache", NULL, MTX_DEF)
178 #define MFC_LOCK_DESTROY() mtx_destroy(&mfc_mtx)
180 VNET_DEFINE_STATIC(vifi_t, numvifs);
181 #define V_numvifs VNET(numvifs)
182 VNET_DEFINE_STATIC(struct vif *, viftable);
183 #define V_viftable VNET(viftable)
185 * No one should be able to "query" this before initialisation happened in
186 * vnet_mroute_init(), so we should still be fine.
188 SYSCTL_OPAQUE(_net_inet_ip, OID_AUTO, viftable, CTLFLAG_VNET | CTLFLAG_RD,
189 &VNET_NAME(viftable), sizeof(*V_viftable) * MAXVIFS, "S,vif[MAXVIFS]",
190 "IPv4 Multicast Interfaces (struct vif[MAXVIFS], netinet/ip_mroute.h)");
192 static struct mtx vif_mtx;
193 #define VIF_LOCK() mtx_lock(&vif_mtx)
194 #define VIF_UNLOCK() mtx_unlock(&vif_mtx)
195 #define VIF_LOCK_ASSERT() mtx_assert(&vif_mtx, MA_OWNED)
196 #define VIF_LOCK_INIT() \
197 mtx_init(&vif_mtx, "IPv4 multicast interfaces", NULL, MTX_DEF)
198 #define VIF_LOCK_DESTROY() mtx_destroy(&vif_mtx)
200 static eventhandler_tag if_detach_event_tag = NULL;
202 VNET_DEFINE_STATIC(struct callout, expire_upcalls_ch);
203 #define V_expire_upcalls_ch VNET(expire_upcalls_ch)
205 #define EXPIRE_TIMEOUT (hz / 4) /* 4x / second */
206 #define UPCALL_EXPIRE 6 /* number of timeouts */
209 * Bandwidth meter variables and constants
211 static MALLOC_DEFINE(M_BWMETER, "bwmeter", "multicast upcall bw meters");
213 * Pending timeouts are stored in a hash table, the key being the
214 * expiration time. Periodically, the entries are analysed and processed.
216 #define BW_METER_BUCKETS 1024
217 VNET_DEFINE_STATIC(struct bw_meter **, bw_meter_timers);
218 #define V_bw_meter_timers VNET(bw_meter_timers)
219 VNET_DEFINE_STATIC(struct callout, bw_meter_ch);
220 #define V_bw_meter_ch VNET(bw_meter_ch)
221 #define BW_METER_PERIOD (hz) /* periodical handling of bw meters */
224 * Pending upcalls are stored in a vector which is flushed when
225 * full, or periodically
227 VNET_DEFINE_STATIC(struct bw_upcall *, bw_upcalls);
228 #define V_bw_upcalls VNET(bw_upcalls)
229 VNET_DEFINE_STATIC(u_int, bw_upcalls_n); /* # of pending upcalls */
230 #define V_bw_upcalls_n VNET(bw_upcalls_n)
231 VNET_DEFINE_STATIC(struct callout, bw_upcalls_ch);
232 #define V_bw_upcalls_ch VNET(bw_upcalls_ch)
234 #define BW_UPCALLS_PERIOD (hz) /* periodical flush of bw upcalls */
236 VNET_PCPUSTAT_DEFINE_STATIC(struct pimstat, pimstat);
237 VNET_PCPUSTAT_SYSINIT(pimstat);
238 VNET_PCPUSTAT_SYSUNINIT(pimstat);
240 SYSCTL_NODE(_net_inet, IPPROTO_PIM, pim, CTLFLAG_RW, 0, "PIM");
241 SYSCTL_VNET_PCPUSTAT(_net_inet_pim, PIMCTL_STATS, stats, struct pimstat,
242 pimstat, "PIM Statistics (struct pimstat, netinet/pim_var.h)");
244 static u_long pim_squelch_wholepkt = 0;
245 SYSCTL_ULONG(_net_inet_pim, OID_AUTO, squelch_wholepkt, CTLFLAG_RW,
246 &pim_squelch_wholepkt, 0,
247 "Disable IGMP_WHOLEPKT notifications if rendezvous point is unspecified");
249 static const struct encaptab *pim_encap_cookie;
250 static int pim_encapcheck(const struct mbuf *, int, int, void *);
251 static int pim_input(struct mbuf *, int, int, void *);
253 static const struct encap_config ipv4_encap_cfg = {
254 .proto = IPPROTO_PIM,
255 .min_length = sizeof(struct ip) + PIM_MINLEN,
257 .check = pim_encapcheck,
262 * Note: the PIM Register encapsulation adds the following in front of a
265 * struct pim_encap_hdr {
267 * struct pim_encap_pimhdr pim;
272 struct pim_encap_pimhdr {
276 #define PIM_ENCAP_TTL 64
278 static struct ip pim_encap_iphdr = {
279 #if BYTE_ORDER == LITTLE_ENDIAN
280 sizeof(struct ip) >> 2,
284 sizeof(struct ip) >> 2,
287 sizeof(struct ip), /* total length */
295 static struct pim_encap_pimhdr pim_encap_pimhdr = {
297 PIM_MAKE_VT(PIM_VERSION, PIM_REGISTER), /* PIM vers and message type */
304 VNET_DEFINE_STATIC(vifi_t, reg_vif_num) = VIFI_INVALID;
305 #define V_reg_vif_num VNET(reg_vif_num)
306 VNET_DEFINE_STATIC(struct ifnet, multicast_register_if);
307 #define V_multicast_register_if VNET(multicast_register_if)
313 static u_long X_ip_mcast_src(int);
314 static int X_ip_mforward(struct ip *, struct ifnet *, struct mbuf *,
315 struct ip_moptions *);
316 static int X_ip_mrouter_done(void);
317 static int X_ip_mrouter_get(struct socket *, struct sockopt *);
318 static int X_ip_mrouter_set(struct socket *, struct sockopt *);
319 static int X_legal_vif_num(int);
320 static int X_mrt_ioctl(u_long, caddr_t, int);
322 static int add_bw_upcall(struct bw_upcall *);
323 static int add_mfc(struct mfcctl2 *);
324 static int add_vif(struct vifctl *);
325 static void bw_meter_prepare_upcall(struct bw_meter *, struct timeval *);
326 static void bw_meter_process(void);
327 static void bw_meter_receive_packet(struct bw_meter *, int,
329 static void bw_upcalls_send(void);
330 static int del_bw_upcall(struct bw_upcall *);
331 static int del_mfc(struct mfcctl2 *);
332 static int del_vif(vifi_t);
333 static int del_vif_locked(vifi_t);
334 static void expire_bw_meter_process(void *);
335 static void expire_bw_upcalls_send(void *);
336 static void expire_mfc(struct mfc *);
337 static void expire_upcalls(void *);
338 static void free_bw_list(struct bw_meter *);
339 static int get_sg_cnt(struct sioc_sg_req *);
340 static int get_vif_cnt(struct sioc_vif_req *);
341 static void if_detached_event(void *, struct ifnet *);
342 static int ip_mdq(struct mbuf *, struct ifnet *, struct mfc *, vifi_t);
343 static int ip_mrouter_init(struct socket *, int);
344 static __inline struct mfc *
345 mfc_find(struct in_addr *, struct in_addr *);
346 static void phyint_send(struct ip *, struct vif *, struct mbuf *);
348 pim_register_prepare(struct ip *, struct mbuf *);
349 static int pim_register_send(struct ip *, struct vif *,
350 struct mbuf *, struct mfc *);
351 static int pim_register_send_rp(struct ip *, struct vif *,
352 struct mbuf *, struct mfc *);
353 static int pim_register_send_upcall(struct ip *, struct vif *,
354 struct mbuf *, struct mfc *);
355 static void schedule_bw_meter(struct bw_meter *, struct timeval *);
356 static void send_packet(struct vif *, struct mbuf *);
357 static int set_api_config(uint32_t *);
358 static int set_assert(int);
359 static int socket_send(struct socket *, struct mbuf *,
360 struct sockaddr_in *);
361 static void unschedule_bw_meter(struct bw_meter *);
364 * Kernel multicast forwarding API capabilities and setup.
365 * If more API capabilities are added to the kernel, they should be
366 * recorded in `mrt_api_support'.
368 #define MRT_API_VERSION 0x0305
370 static const int mrt_api_version = MRT_API_VERSION;
371 static const uint32_t mrt_api_support = (MRT_MFC_FLAGS_DISABLE_WRONGVIF |
372 MRT_MFC_FLAGS_BORDER_VIF |
375 VNET_DEFINE_STATIC(uint32_t, mrt_api_config);
376 #define V_mrt_api_config VNET(mrt_api_config)
377 VNET_DEFINE_STATIC(int, pim_assert_enabled);
378 #define V_pim_assert_enabled VNET(pim_assert_enabled)
379 static struct timeval pim_assert_interval = { 3, 0 }; /* Rate limit */
382 * Find a route for a given origin IP address and multicast group address.
383 * Statistics must be updated by the caller.
385 static __inline struct mfc *
386 mfc_find(struct in_addr *o, struct in_addr *g)
392 LIST_FOREACH(rt, &V_mfchashtbl[MFCHASH(*o, *g)], mfc_hash) {
393 if (in_hosteq(rt->mfc_origin, *o) &&
394 in_hosteq(rt->mfc_mcastgrp, *g) &&
395 TAILQ_EMPTY(&rt->mfc_stall))
403 * Handle MRT setsockopt commands to modify the multicast forwarding tables.
406 X_ip_mrouter_set(struct socket *so, struct sockopt *sopt)
412 struct bw_upcall bw_upcall;
415 if (so != V_ip_mrouter && sopt->sopt_name != MRT_INIT)
419 switch (sopt->sopt_name) {
421 error = sooptcopyin(sopt, &optval, sizeof optval, sizeof optval);
424 error = ip_mrouter_init(so, optval);
428 error = ip_mrouter_done();
432 error = sooptcopyin(sopt, &vifc, sizeof vifc, sizeof vifc);
435 error = add_vif(&vifc);
439 error = sooptcopyin(sopt, &vifi, sizeof vifi, sizeof vifi);
442 error = del_vif(vifi);
448 * select data size depending on API version.
450 if (sopt->sopt_name == MRT_ADD_MFC &&
451 V_mrt_api_config & MRT_API_FLAGS_ALL) {
452 error = sooptcopyin(sopt, &mfc, sizeof(struct mfcctl2),
453 sizeof(struct mfcctl2));
455 error = sooptcopyin(sopt, &mfc, sizeof(struct mfcctl),
456 sizeof(struct mfcctl));
457 bzero((caddr_t)&mfc + sizeof(struct mfcctl),
458 sizeof(mfc) - sizeof(struct mfcctl));
462 if (sopt->sopt_name == MRT_ADD_MFC)
463 error = add_mfc(&mfc);
465 error = del_mfc(&mfc);
469 error = sooptcopyin(sopt, &optval, sizeof optval, sizeof optval);
476 error = sooptcopyin(sopt, &i, sizeof i, sizeof i);
478 error = set_api_config(&i);
480 error = sooptcopyout(sopt, &i, sizeof i);
483 case MRT_ADD_BW_UPCALL:
484 case MRT_DEL_BW_UPCALL:
485 error = sooptcopyin(sopt, &bw_upcall, sizeof bw_upcall,
489 if (sopt->sopt_name == MRT_ADD_BW_UPCALL)
490 error = add_bw_upcall(&bw_upcall);
492 error = del_bw_upcall(&bw_upcall);
503 * Handle MRT getsockopt commands
506 X_ip_mrouter_get(struct socket *so, struct sockopt *sopt)
510 switch (sopt->sopt_name) {
512 error = sooptcopyout(sopt, &mrt_api_version, sizeof mrt_api_version);
516 error = sooptcopyout(sopt, &V_pim_assert_enabled,
517 sizeof V_pim_assert_enabled);
520 case MRT_API_SUPPORT:
521 error = sooptcopyout(sopt, &mrt_api_support, sizeof mrt_api_support);
525 error = sooptcopyout(sopt, &V_mrt_api_config, sizeof V_mrt_api_config);
536 * Handle ioctl commands to obtain information from the cache
539 X_mrt_ioctl(u_long cmd, caddr_t data, int fibnum __unused)
544 * Currently the only function calling this ioctl routine is rtioctl_fib().
545 * Typically, only root can create the raw socket in order to execute
546 * this ioctl method, however the request might be coming from a prison
548 error = priv_check(curthread, PRIV_NETINET_MROUTE);
552 case (SIOCGETVIFCNT):
553 error = get_vif_cnt((struct sioc_vif_req *)data);
557 error = get_sg_cnt((struct sioc_sg_req *)data);
568 * returns the packet, byte, rpf-failure count for the source group provided
571 get_sg_cnt(struct sioc_sg_req *req)
576 rt = mfc_find(&req->src, &req->grp);
579 req->pktcnt = req->bytecnt = req->wrong_if = 0xffffffff;
580 return EADDRNOTAVAIL;
582 req->pktcnt = rt->mfc_pkt_cnt;
583 req->bytecnt = rt->mfc_byte_cnt;
584 req->wrong_if = rt->mfc_wrong_if;
590 * returns the input and output packet and byte counts on the vif provided
593 get_vif_cnt(struct sioc_vif_req *req)
595 vifi_t vifi = req->vifi;
598 if (vifi >= V_numvifs) {
603 req->icount = V_viftable[vifi].v_pkt_in;
604 req->ocount = V_viftable[vifi].v_pkt_out;
605 req->ibytes = V_viftable[vifi].v_bytes_in;
606 req->obytes = V_viftable[vifi].v_bytes_out;
613 if_detached_event(void *arg __unused, struct ifnet *ifp)
620 if (V_ip_mrouter == NULL) {
629 * Tear down multicast forwarder state associated with this ifnet.
630 * 1. Walk the vif list, matching vifs against this ifnet.
631 * 2. Walk the multicast forwarding cache (mfc) looking for
632 * inner matches with this vif's index.
633 * 3. Expire any matching multicast forwarding cache entries.
634 * 4. Free vif state. This should disable ALLMULTI on the interface.
636 for (vifi = 0; vifi < V_numvifs; vifi++) {
637 if (V_viftable[vifi].v_ifp != ifp)
639 for (i = 0; i < mfchashsize; i++) {
640 struct mfc *rt, *nrt;
642 LIST_FOREACH_SAFE(rt, &V_mfchashtbl[i], mfc_hash, nrt) {
643 if (rt->mfc_parent == vifi) {
648 del_vif_locked(vifi);
658 * Enable multicast forwarding.
661 ip_mrouter_init(struct socket *so, int version)
664 CTR3(KTR_IPMF, "%s: so_type %d, pr_protocol %d", __func__,
665 so->so_type, so->so_proto->pr_protocol);
667 if (so->so_type != SOCK_RAW || so->so_proto->pr_protocol != IPPROTO_IGMP)
675 if (ip_mrouter_unloading) {
680 if (V_ip_mrouter != NULL) {
685 V_mfchashtbl = hashinit_flags(mfchashsize, M_MRTABLE, &V_mfchash,
688 callout_reset(&V_expire_upcalls_ch, EXPIRE_TIMEOUT, expire_upcalls,
690 callout_reset(&V_bw_upcalls_ch, BW_UPCALLS_PERIOD, expire_bw_upcalls_send,
692 callout_reset(&V_bw_meter_ch, BW_METER_PERIOD, expire_bw_meter_process,
700 CTR1(KTR_IPMF, "%s: done", __func__);
706 * Disable multicast forwarding.
709 X_ip_mrouter_done(void)
717 if (V_ip_mrouter == NULL) {
723 * Detach/disable hooks to the reset of the system.
727 V_mrt_api_config = 0;
732 * For each phyint in use, disable promiscuous reception of all IP
735 for (vifi = 0; vifi < V_numvifs; vifi++) {
736 if (!in_nullhost(V_viftable[vifi].v_lcl_addr) &&
737 !(V_viftable[vifi].v_flags & (VIFF_TUNNEL | VIFF_REGISTER))) {
738 ifp = V_viftable[vifi].v_ifp;
742 bzero((caddr_t)V_viftable, sizeof(V_viftable));
744 V_pim_assert_enabled = 0;
748 callout_stop(&V_expire_upcalls_ch);
749 callout_stop(&V_bw_upcalls_ch);
750 callout_stop(&V_bw_meter_ch);
755 * Free all multicast forwarding cache entries.
756 * Do not use hashdestroy(), as we must perform other cleanup.
758 for (i = 0; i < mfchashsize; i++) {
759 struct mfc *rt, *nrt;
761 LIST_FOREACH_SAFE(rt, &V_mfchashtbl[i], mfc_hash, nrt) {
765 free(V_mfchashtbl, M_MRTABLE);
768 bzero(V_nexpire, sizeof(V_nexpire[0]) * mfchashsize);
771 bzero(V_bw_meter_timers, BW_METER_BUCKETS * sizeof(*V_bw_meter_timers));
775 V_reg_vif_num = VIFI_INVALID;
779 CTR1(KTR_IPMF, "%s: done", __func__);
785 * Set PIM assert processing global
790 if ((i != 1) && (i != 0))
793 V_pim_assert_enabled = i;
799 * Configure API capabilities
802 set_api_config(uint32_t *apival)
807 * We can set the API capabilities only if it is the first operation
808 * after MRT_INIT. I.e.:
809 * - there are no vifs installed
810 * - pim_assert is not enabled
811 * - the MFC table is empty
817 if (V_pim_assert_enabled) {
824 for (i = 0; i < mfchashsize; i++) {
825 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;
883 ifa = ifa_ifwithaddr((struct sockaddr *)&sin);
887 return EADDRNOTAVAIL;
893 if ((vifcp->vifc_flags & VIFF_TUNNEL) != 0) {
894 CTR1(KTR_IPMF, "%s: tunnels are no longer supported", __func__);
897 } else if (vifcp->vifc_flags & VIFF_REGISTER) {
898 ifp = &V_multicast_register_if;
899 CTR2(KTR_IPMF, "%s: add register vif for ifp %p", __func__, ifp);
900 if (V_reg_vif_num == VIFI_INVALID) {
901 if_initname(&V_multicast_register_if, "register_vif", 0);
902 V_multicast_register_if.if_flags = IFF_LOOPBACK;
903 V_reg_vif_num = vifcp->vifc_vifi;
905 } else { /* Make sure the interface supports multicast */
906 if ((ifp->if_flags & IFF_MULTICAST) == 0) {
911 /* Enable promiscuous reception of all IP multicasts from the if */
912 error = if_allmulti(ifp, 1);
919 vifp->v_flags = vifcp->vifc_flags;
920 vifp->v_threshold = vifcp->vifc_threshold;
921 vifp->v_lcl_addr = vifcp->vifc_lcl_addr;
922 vifp->v_rmt_addr = vifcp->vifc_rmt_addr;
924 /* initialize per vif pkt counters */
927 vifp->v_bytes_in = 0;
928 vifp->v_bytes_out = 0;
930 /* Adjust numvifs up if the vifi is higher than numvifs */
931 if (V_numvifs <= vifcp->vifc_vifi)
932 V_numvifs = vifcp->vifc_vifi + 1;
936 CTR4(KTR_IPMF, "%s: add vif %d laddr 0x%08x thresh %x", __func__,
937 (int)vifcp->vifc_vifi, ntohl(vifcp->vifc_lcl_addr.s_addr),
938 (int)vifcp->vifc_threshold);
944 * Delete a vif from the vif table
947 del_vif_locked(vifi_t vifi)
953 if (vifi >= V_numvifs) {
956 vifp = &V_viftable[vifi];
957 if (in_nullhost(vifp->v_lcl_addr)) {
958 return EADDRNOTAVAIL;
961 if (!(vifp->v_flags & (VIFF_TUNNEL | VIFF_REGISTER)))
962 if_allmulti(vifp->v_ifp, 0);
964 if (vifp->v_flags & VIFF_REGISTER)
965 V_reg_vif_num = VIFI_INVALID;
967 bzero((caddr_t)vifp, sizeof (*vifp));
969 CTR2(KTR_IPMF, "%s: delete vif %d", __func__, (int)vifi);
971 /* Adjust numvifs down */
972 for (vifi = V_numvifs; vifi > 0; vifi--)
973 if (!in_nullhost(V_viftable[vifi-1].v_lcl_addr))
986 cc = del_vif_locked(vifi);
993 * update an mfc entry without resetting counters and S,G addresses.
996 update_mfc_params(struct mfc *rt, struct mfcctl2 *mfccp)
1000 rt->mfc_parent = mfccp->mfcc_parent;
1001 for (i = 0; i < V_numvifs; i++) {
1002 rt->mfc_ttls[i] = mfccp->mfcc_ttls[i];
1003 rt->mfc_flags[i] = mfccp->mfcc_flags[i] & V_mrt_api_config &
1006 /* set the RP address */
1007 if (V_mrt_api_config & MRT_MFC_RP)
1008 rt->mfc_rp = mfccp->mfcc_rp;
1010 rt->mfc_rp.s_addr = INADDR_ANY;
1014 * fully initialize an mfc entry from the parameter.
1017 init_mfc_params(struct mfc *rt, struct mfcctl2 *mfccp)
1019 rt->mfc_origin = mfccp->mfcc_origin;
1020 rt->mfc_mcastgrp = mfccp->mfcc_mcastgrp;
1022 update_mfc_params(rt, mfccp);
1024 /* initialize pkt counters per src-grp */
1025 rt->mfc_pkt_cnt = 0;
1026 rt->mfc_byte_cnt = 0;
1027 rt->mfc_wrong_if = 0;
1028 timevalclear(&rt->mfc_last_assert);
1032 expire_mfc(struct mfc *rt)
1034 struct rtdetq *rte, *nrte;
1038 free_bw_list(rt->mfc_bw_meter);
1040 TAILQ_FOREACH_SAFE(rte, &rt->mfc_stall, rte_link, nrte) {
1042 TAILQ_REMOVE(&rt->mfc_stall, rte, rte_link);
1043 free(rte, M_MRTABLE);
1046 LIST_REMOVE(rt, mfc_hash);
1047 free(rt, M_MRTABLE);
1054 add_mfc(struct mfcctl2 *mfccp)
1057 struct rtdetq *rte, *nrte;
1064 rt = mfc_find(&mfccp->mfcc_origin, &mfccp->mfcc_mcastgrp);
1066 /* If an entry already exists, just update the fields */
1068 CTR4(KTR_IPMF, "%s: update mfc orig 0x%08x group %lx parent %x",
1069 __func__, ntohl(mfccp->mfcc_origin.s_addr),
1070 (u_long)ntohl(mfccp->mfcc_mcastgrp.s_addr),
1071 mfccp->mfcc_parent);
1072 update_mfc_params(rt, mfccp);
1079 * Find the entry for which the upcall was made and update
1082 hash = MFCHASH(mfccp->mfcc_origin, mfccp->mfcc_mcastgrp);
1083 LIST_FOREACH(rt, &V_mfchashtbl[hash], mfc_hash) {
1084 if (in_hosteq(rt->mfc_origin, mfccp->mfcc_origin) &&
1085 in_hosteq(rt->mfc_mcastgrp, mfccp->mfcc_mcastgrp) &&
1086 !TAILQ_EMPTY(&rt->mfc_stall)) {
1088 "%s: add mfc orig 0x%08x group %lx parent %x qh %p",
1089 __func__, ntohl(mfccp->mfcc_origin.s_addr),
1090 (u_long)ntohl(mfccp->mfcc_mcastgrp.s_addr),
1092 TAILQ_FIRST(&rt->mfc_stall));
1094 CTR1(KTR_IPMF, "%s: multiple matches", __func__);
1096 init_mfc_params(rt, mfccp);
1097 rt->mfc_expire = 0; /* Don't clean this guy up */
1100 /* Free queued packets, but attempt to forward them first. */
1101 TAILQ_FOREACH_SAFE(rte, &rt->mfc_stall, rte_link, nrte) {
1102 if (rte->ifp != NULL)
1103 ip_mdq(rte->m, rte->ifp, rt, -1);
1105 TAILQ_REMOVE(&rt->mfc_stall, rte, rte_link);
1107 free(rte, M_MRTABLE);
1113 * It is possible that an entry is being inserted without an upcall
1116 CTR1(KTR_IPMF, "%s: adding mfc w/o upcall", __func__);
1117 LIST_FOREACH(rt, &V_mfchashtbl[hash], mfc_hash) {
1118 if (in_hosteq(rt->mfc_origin, mfccp->mfcc_origin) &&
1119 in_hosteq(rt->mfc_mcastgrp, mfccp->mfcc_mcastgrp)) {
1120 init_mfc_params(rt, mfccp);
1128 if (rt == NULL) { /* no upcall, so make a new entry */
1129 rt = (struct mfc *)malloc(sizeof(*rt), M_MRTABLE, M_NOWAIT);
1136 init_mfc_params(rt, mfccp);
1137 TAILQ_INIT(&rt->mfc_stall);
1141 rt->mfc_bw_meter = NULL;
1143 /* insert new entry at head of hash chain */
1144 LIST_INSERT_HEAD(&V_mfchashtbl[hash], rt, mfc_hash);
1155 * Delete an mfc entry
1158 del_mfc(struct mfcctl2 *mfccp)
1160 struct in_addr origin;
1161 struct in_addr mcastgrp;
1164 origin = mfccp->mfcc_origin;
1165 mcastgrp = mfccp->mfcc_mcastgrp;
1167 CTR3(KTR_IPMF, "%s: delete mfc orig 0x%08x group %lx", __func__,
1168 ntohl(origin.s_addr), (u_long)ntohl(mcastgrp.s_addr));
1172 rt = mfc_find(&origin, &mcastgrp);
1175 return EADDRNOTAVAIL;
1179 * free the bw_meter entries
1181 free_bw_list(rt->mfc_bw_meter);
1182 rt->mfc_bw_meter = NULL;
1184 LIST_REMOVE(rt, mfc_hash);
1185 free(rt, M_MRTABLE);
1193 * Send a message to the routing daemon on the multicast routing socket.
1196 socket_send(struct socket *s, struct mbuf *mm, struct sockaddr_in *src)
1199 SOCKBUF_LOCK(&s->so_rcv);
1200 if (sbappendaddr_locked(&s->so_rcv, (struct sockaddr *)src, mm,
1202 sorwakeup_locked(s);
1205 SOCKBUF_UNLOCK(&s->so_rcv);
1212 * IP multicast forwarding function. This function assumes that the packet
1213 * pointed to by "ip" has arrived on (or is about to be sent to) the interface
1214 * pointed to by "ifp", and the packet is to be relayed to other networks
1215 * that have members of the packet's destination IP multicast group.
1217 * The packet is returned unscathed to the caller, unless it is
1218 * erroneous, in which case a non-zero return value tells the caller to
1222 #define TUNNEL_LEN 12 /* # bytes of IP option for tunnel encapsulation */
1225 X_ip_mforward(struct ip *ip, struct ifnet *ifp, struct mbuf *m,
1226 struct ip_moptions *imo)
1232 CTR3(KTR_IPMF, "ip_mforward: delete mfc orig 0x%08x group %lx ifp %p",
1233 ntohl(ip->ip_src.s_addr), (u_long)ntohl(ip->ip_dst.s_addr), ifp);
1235 if (ip->ip_hl < (sizeof(struct ip) + TUNNEL_LEN) >> 2 ||
1236 ((u_char *)(ip + 1))[1] != IPOPT_LSRR ) {
1238 * Packet arrived via a physical interface or
1239 * an encapsulated tunnel or a register_vif.
1243 * Packet arrived through a source-route tunnel.
1244 * Source-route tunnels are no longer supported.
1251 if (imo && ((vifi = imo->imo_multicast_vif) < V_numvifs)) {
1252 if (ip->ip_ttl < MAXTTL)
1253 ip->ip_ttl++; /* compensate for -1 in *_send routines */
1254 error = ip_mdq(m, ifp, NULL, vifi);
1261 * Don't forward a packet with time-to-live of zero or one,
1262 * or a packet destined to a local-only group.
1264 if (ip->ip_ttl <= 1 || IN_LOCAL_GROUP(ntohl(ip->ip_dst.s_addr))) {
1271 * Determine forwarding vifs from the forwarding cache table
1273 MRTSTAT_INC(mrts_mfc_lookups);
1274 rt = mfc_find(&ip->ip_src, &ip->ip_dst);
1276 /* Entry exists, so forward if necessary */
1278 error = ip_mdq(m, ifp, rt, -1);
1284 * If we don't have a route for packet's origin,
1285 * Make a copy of the packet & send message to routing daemon
1291 int hlen = ip->ip_hl << 2;
1293 MRTSTAT_INC(mrts_mfc_misses);
1294 MRTSTAT_INC(mrts_no_route);
1295 CTR2(KTR_IPMF, "ip_mforward: no mfc for (0x%08x,%lx)",
1296 ntohl(ip->ip_src.s_addr), (u_long)ntohl(ip->ip_dst.s_addr));
1299 * Allocate mbufs early so that we don't do extra work if we are
1300 * just going to fail anyway. Make sure to pullup the header so
1301 * that other people can't step on it.
1303 rte = (struct rtdetq *)malloc((sizeof *rte), M_MRTABLE,
1311 mb0 = m_copypacket(m, M_NOWAIT);
1312 if (mb0 && (!M_WRITABLE(mb0) || mb0->m_len < hlen))
1313 mb0 = m_pullup(mb0, hlen);
1315 free(rte, M_MRTABLE);
1321 /* is there an upcall waiting for this flow ? */
1322 hash = MFCHASH(ip->ip_src, ip->ip_dst);
1323 LIST_FOREACH(rt, &V_mfchashtbl[hash], mfc_hash) {
1324 if (in_hosteq(ip->ip_src, rt->mfc_origin) &&
1325 in_hosteq(ip->ip_dst, rt->mfc_mcastgrp) &&
1326 !TAILQ_EMPTY(&rt->mfc_stall))
1333 struct sockaddr_in k_igmpsrc = { sizeof k_igmpsrc, AF_INET };
1337 * Locate the vifi for the incoming interface for this packet.
1338 * If none found, drop packet.
1340 for (vifi = 0; vifi < V_numvifs &&
1341 V_viftable[vifi].v_ifp != ifp; vifi++)
1343 if (vifi >= V_numvifs) /* vif not found, drop packet */
1346 /* no upcall, so make a new entry */
1347 rt = (struct mfc *)malloc(sizeof(*rt), M_MRTABLE, M_NOWAIT);
1351 /* Make a copy of the header to send to the user level process */
1352 mm = m_copym(mb0, 0, hlen, M_NOWAIT);
1357 * Send message to routing daemon to install
1358 * a route into the kernel table
1361 im = mtod(mm, struct igmpmsg *);
1362 im->im_msgtype = IGMPMSG_NOCACHE;
1366 MRTSTAT_INC(mrts_upcalls);
1368 k_igmpsrc.sin_addr = ip->ip_src;
1369 if (socket_send(V_ip_mrouter, mm, &k_igmpsrc) < 0) {
1370 CTR0(KTR_IPMF, "ip_mforward: socket queue full");
1371 MRTSTAT_INC(mrts_upq_sockfull);
1373 free(rt, M_MRTABLE);
1375 free(rte, M_MRTABLE);
1382 /* insert new entry at head of hash chain */
1383 rt->mfc_origin.s_addr = ip->ip_src.s_addr;
1384 rt->mfc_mcastgrp.s_addr = ip->ip_dst.s_addr;
1385 rt->mfc_expire = UPCALL_EXPIRE;
1387 for (i = 0; i < V_numvifs; i++) {
1388 rt->mfc_ttls[i] = 0;
1389 rt->mfc_flags[i] = 0;
1391 rt->mfc_parent = -1;
1393 /* clear the RP address */
1394 rt->mfc_rp.s_addr = INADDR_ANY;
1395 rt->mfc_bw_meter = NULL;
1397 /* initialize pkt counters per src-grp */
1398 rt->mfc_pkt_cnt = 0;
1399 rt->mfc_byte_cnt = 0;
1400 rt->mfc_wrong_if = 0;
1401 timevalclear(&rt->mfc_last_assert);
1403 TAILQ_INIT(&rt->mfc_stall);
1406 /* link into table */
1407 LIST_INSERT_HEAD(&V_mfchashtbl[hash], rt, mfc_hash);
1408 TAILQ_INSERT_HEAD(&rt->mfc_stall, rte, rte_link);
1412 /* determine if queue has overflowed */
1413 if (rt->mfc_nstall > MAX_UPQ) {
1414 MRTSTAT_INC(mrts_upq_ovflw);
1416 free(rte, M_MRTABLE);
1422 TAILQ_INSERT_TAIL(&rt->mfc_stall, rte, rte_link);
1437 * Clean up the cache entry if upcall is not serviced
1440 expire_upcalls(void *arg)
1444 CURVNET_SET((struct vnet *) arg);
1448 for (i = 0; i < mfchashsize; i++) {
1449 struct mfc *rt, *nrt;
1451 if (V_nexpire[i] == 0)
1454 LIST_FOREACH_SAFE(rt, &V_mfchashtbl[i], mfc_hash, nrt) {
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_copym(m, 0, hlen, M_NOWAIT);
1552 if (mm && (!M_WRITABLE(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_WRITABLE(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;
1689 imo.imo_multicast_ifp = vifp->v_ifp;
1690 imo.imo_multicast_ttl = mtod(m, struct ip *)->ip_ttl - 1;
1691 imo.imo_multicast_loop = 1;
1692 imo.imo_multicast_vif = -1;
1693 STAILQ_INIT(&imo.imo_head);
1696 * Re-entrancy should not be a problem here, because
1697 * the packets that we send out and are looped back at us
1698 * should get rejected because they appear to come from
1699 * the loopback interface, thus preventing looping.
1701 error = ip_output(m, NULL, NULL, IP_FORWARDING, &imo, NULL);
1702 CTR3(KTR_IPMF, "%s: vif %td err %d", __func__,
1703 (ptrdiff_t)(vifp - V_viftable), error);
1707 * Stubs for old RSVP socket shim implementation.
1711 X_ip_rsvp_vif(struct socket *so __unused, struct sockopt *sopt __unused)
1714 return (EOPNOTSUPP);
1718 X_ip_rsvp_force_done(struct socket *so __unused)
1724 X_rsvp_input(struct mbuf **mp, int *offp, int proto)
1732 return (IPPROTO_DONE);
1736 * Code for bandwidth monitors
1740 * Define common interface for timeval-related methods
1742 #define BW_TIMEVALCMP(tvp, uvp, cmp) timevalcmp((tvp), (uvp), cmp)
1743 #define BW_TIMEVALDECR(vvp, uvp) timevalsub((vvp), (uvp))
1744 #define BW_TIMEVALADD(vvp, uvp) timevaladd((vvp), (uvp))
1747 compute_bw_meter_flags(struct bw_upcall *req)
1751 if (req->bu_flags & BW_UPCALL_UNIT_PACKETS)
1752 flags |= BW_METER_UNIT_PACKETS;
1753 if (req->bu_flags & BW_UPCALL_UNIT_BYTES)
1754 flags |= BW_METER_UNIT_BYTES;
1755 if (req->bu_flags & BW_UPCALL_GEQ)
1756 flags |= BW_METER_GEQ;
1757 if (req->bu_flags & BW_UPCALL_LEQ)
1758 flags |= BW_METER_LEQ;
1764 * Add a bw_meter entry
1767 add_bw_upcall(struct bw_upcall *req)
1770 struct timeval delta = { BW_UPCALL_THRESHOLD_INTERVAL_MIN_SEC,
1771 BW_UPCALL_THRESHOLD_INTERVAL_MIN_USEC };
1776 if (!(V_mrt_api_config & MRT_MFC_BW_UPCALL))
1779 /* Test if the flags are valid */
1780 if (!(req->bu_flags & (BW_UPCALL_UNIT_PACKETS | BW_UPCALL_UNIT_BYTES)))
1782 if (!(req->bu_flags & (BW_UPCALL_GEQ | BW_UPCALL_LEQ)))
1784 if ((req->bu_flags & (BW_UPCALL_GEQ | BW_UPCALL_LEQ))
1785 == (BW_UPCALL_GEQ | BW_UPCALL_LEQ))
1788 /* Test if the threshold time interval is valid */
1789 if (BW_TIMEVALCMP(&req->bu_threshold.b_time, &delta, <))
1792 flags = compute_bw_meter_flags(req);
1795 * Find if we have already same bw_meter entry
1798 mfc = mfc_find(&req->bu_src, &req->bu_dst);
1801 return EADDRNOTAVAIL;
1803 for (x = mfc->mfc_bw_meter; x != NULL; x = x->bm_mfc_next) {
1804 if ((BW_TIMEVALCMP(&x->bm_threshold.b_time,
1805 &req->bu_threshold.b_time, ==)) &&
1806 (x->bm_threshold.b_packets == req->bu_threshold.b_packets) &&
1807 (x->bm_threshold.b_bytes == req->bu_threshold.b_bytes) &&
1808 (x->bm_flags & BW_METER_USER_FLAGS) == flags) {
1810 return 0; /* XXX Already installed */
1814 /* Allocate the new bw_meter entry */
1815 x = (struct bw_meter *)malloc(sizeof(*x), M_BWMETER, M_NOWAIT);
1821 /* Set the new bw_meter entry */
1822 x->bm_threshold.b_time = req->bu_threshold.b_time;
1824 x->bm_start_time = now;
1825 x->bm_threshold.b_packets = req->bu_threshold.b_packets;
1826 x->bm_threshold.b_bytes = req->bu_threshold.b_bytes;
1827 x->bm_measured.b_packets = 0;
1828 x->bm_measured.b_bytes = 0;
1829 x->bm_flags = flags;
1830 x->bm_time_next = NULL;
1831 x->bm_time_hash = BW_METER_BUCKETS;
1833 /* Add the new bw_meter entry to the front of entries for this MFC */
1835 x->bm_mfc_next = mfc->mfc_bw_meter;
1836 mfc->mfc_bw_meter = x;
1837 schedule_bw_meter(x, &now);
1844 free_bw_list(struct bw_meter *list)
1846 while (list != NULL) {
1847 struct bw_meter *x = list;
1849 list = list->bm_mfc_next;
1850 unschedule_bw_meter(x);
1856 * Delete one or multiple bw_meter entries
1859 del_bw_upcall(struct bw_upcall *req)
1864 if (!(V_mrt_api_config & MRT_MFC_BW_UPCALL))
1869 /* Find the corresponding MFC entry */
1870 mfc = mfc_find(&req->bu_src, &req->bu_dst);
1873 return EADDRNOTAVAIL;
1874 } else if (req->bu_flags & BW_UPCALL_DELETE_ALL) {
1876 * Delete all bw_meter entries for this mfc
1878 struct bw_meter *list;
1880 list = mfc->mfc_bw_meter;
1881 mfc->mfc_bw_meter = NULL;
1885 } else { /* Delete a single bw_meter entry */
1886 struct bw_meter *prev;
1889 flags = compute_bw_meter_flags(req);
1891 /* Find the bw_meter entry to delete */
1892 for (prev = NULL, x = mfc->mfc_bw_meter; x != NULL;
1893 prev = x, x = x->bm_mfc_next) {
1894 if ((BW_TIMEVALCMP(&x->bm_threshold.b_time,
1895 &req->bu_threshold.b_time, ==)) &&
1896 (x->bm_threshold.b_packets == req->bu_threshold.b_packets) &&
1897 (x->bm_threshold.b_bytes == req->bu_threshold.b_bytes) &&
1898 (x->bm_flags & BW_METER_USER_FLAGS) == flags)
1901 if (x != NULL) { /* Delete entry from the list for this MFC */
1903 prev->bm_mfc_next = x->bm_mfc_next; /* remove from middle*/
1905 x->bm_mfc->mfc_bw_meter = x->bm_mfc_next;/* new head of list */
1907 unschedule_bw_meter(x);
1909 /* Free the bw_meter entry */
1921 * Perform bandwidth measurement processing that may result in an upcall
1924 bw_meter_receive_packet(struct bw_meter *x, int plen, struct timeval *nowp)
1926 struct timeval delta;
1931 BW_TIMEVALDECR(&delta, &x->bm_start_time);
1933 if (x->bm_flags & BW_METER_GEQ) {
1935 * Processing for ">=" type of bw_meter entry
1937 if (BW_TIMEVALCMP(&delta, &x->bm_threshold.b_time, >)) {
1938 /* Reset the bw_meter entry */
1939 x->bm_start_time = *nowp;
1940 x->bm_measured.b_packets = 0;
1941 x->bm_measured.b_bytes = 0;
1942 x->bm_flags &= ~BW_METER_UPCALL_DELIVERED;
1945 /* Record that a packet is received */
1946 x->bm_measured.b_packets++;
1947 x->bm_measured.b_bytes += plen;
1950 * Test if we should deliver an upcall
1952 if (!(x->bm_flags & BW_METER_UPCALL_DELIVERED)) {
1953 if (((x->bm_flags & BW_METER_UNIT_PACKETS) &&
1954 (x->bm_measured.b_packets >= x->bm_threshold.b_packets)) ||
1955 ((x->bm_flags & BW_METER_UNIT_BYTES) &&
1956 (x->bm_measured.b_bytes >= x->bm_threshold.b_bytes))) {
1957 /* Prepare an upcall for delivery */
1958 bw_meter_prepare_upcall(x, nowp);
1959 x->bm_flags |= BW_METER_UPCALL_DELIVERED;
1962 } else if (x->bm_flags & BW_METER_LEQ) {
1964 * Processing for "<=" type of bw_meter entry
1966 if (BW_TIMEVALCMP(&delta, &x->bm_threshold.b_time, >)) {
1968 * We are behind time with the multicast forwarding table
1969 * scanning for "<=" type of bw_meter entries, so test now
1970 * if we should deliver an upcall.
1972 if (((x->bm_flags & BW_METER_UNIT_PACKETS) &&
1973 (x->bm_measured.b_packets <= x->bm_threshold.b_packets)) ||
1974 ((x->bm_flags & BW_METER_UNIT_BYTES) &&
1975 (x->bm_measured.b_bytes <= x->bm_threshold.b_bytes))) {
1976 /* Prepare an upcall for delivery */
1977 bw_meter_prepare_upcall(x, nowp);
1979 /* Reschedule the bw_meter entry */
1980 unschedule_bw_meter(x);
1981 schedule_bw_meter(x, nowp);
1984 /* Record that a packet is received */
1985 x->bm_measured.b_packets++;
1986 x->bm_measured.b_bytes += plen;
1989 * Test if we should restart the measuring interval
1991 if ((x->bm_flags & BW_METER_UNIT_PACKETS &&
1992 x->bm_measured.b_packets <= x->bm_threshold.b_packets) ||
1993 (x->bm_flags & BW_METER_UNIT_BYTES &&
1994 x->bm_measured.b_bytes <= x->bm_threshold.b_bytes)) {
1995 /* Don't restart the measuring interval */
1997 /* Do restart the measuring interval */
1999 * XXX: note that we don't unschedule and schedule, because this
2000 * might be too much overhead per packet. Instead, when we process
2001 * all entries for a given timer hash bin, we check whether it is
2002 * really a timeout. If not, we reschedule at that time.
2004 x->bm_start_time = *nowp;
2005 x->bm_measured.b_packets = 0;
2006 x->bm_measured.b_bytes = 0;
2007 x->bm_flags &= ~BW_METER_UPCALL_DELIVERED;
2013 * Prepare a bandwidth-related upcall
2016 bw_meter_prepare_upcall(struct bw_meter *x, struct timeval *nowp)
2018 struct timeval delta;
2019 struct bw_upcall *u;
2024 * Compute the measured time interval
2027 BW_TIMEVALDECR(&delta, &x->bm_start_time);
2030 * If there are too many pending upcalls, deliver them now
2032 if (V_bw_upcalls_n >= BW_UPCALLS_MAX)
2036 * Set the bw_upcall entry
2038 u = &V_bw_upcalls[V_bw_upcalls_n++];
2039 u->bu_src = x->bm_mfc->mfc_origin;
2040 u->bu_dst = x->bm_mfc->mfc_mcastgrp;
2041 u->bu_threshold.b_time = x->bm_threshold.b_time;
2042 u->bu_threshold.b_packets = x->bm_threshold.b_packets;
2043 u->bu_threshold.b_bytes = x->bm_threshold.b_bytes;
2044 u->bu_measured.b_time = delta;
2045 u->bu_measured.b_packets = x->bm_measured.b_packets;
2046 u->bu_measured.b_bytes = x->bm_measured.b_bytes;
2048 if (x->bm_flags & BW_METER_UNIT_PACKETS)
2049 u->bu_flags |= BW_UPCALL_UNIT_PACKETS;
2050 if (x->bm_flags & BW_METER_UNIT_BYTES)
2051 u->bu_flags |= BW_UPCALL_UNIT_BYTES;
2052 if (x->bm_flags & BW_METER_GEQ)
2053 u->bu_flags |= BW_UPCALL_GEQ;
2054 if (x->bm_flags & BW_METER_LEQ)
2055 u->bu_flags |= BW_UPCALL_LEQ;
2059 * Send the pending bandwidth-related upcalls
2062 bw_upcalls_send(void)
2065 int len = V_bw_upcalls_n * sizeof(V_bw_upcalls[0]);
2066 struct sockaddr_in k_igmpsrc = { sizeof k_igmpsrc, AF_INET };
2067 static struct igmpmsg igmpmsg = { 0, /* unused1 */
2069 IGMPMSG_BW_UPCALL,/* im_msgtype */
2074 { 0 } }; /* im_dst */
2078 if (V_bw_upcalls_n == 0)
2079 return; /* No pending upcalls */
2084 * Allocate a new mbuf, initialize it with the header and
2085 * the payload for the pending calls.
2087 m = m_gethdr(M_NOWAIT, MT_DATA);
2089 log(LOG_WARNING, "bw_upcalls_send: cannot allocate mbuf\n");
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 mb_first = m_gethdr(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 mb_first = m_gethdr(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_len = htons(len + sizeof(pim_encap_iphdr) +
2508 sizeof(pim_encap_pimhdr));
2509 ip_outer->ip_src = V_viftable[vifi].v_lcl_addr;
2510 ip_outer->ip_dst = rt->mfc_rp;
2512 * Copy the inner header TOS to the outer header, and take care of the
2515 ip_outer->ip_tos = ip->ip_tos;
2516 if (ip->ip_off & htons(IP_DF))
2517 ip_outer->ip_off |= htons(IP_DF);
2518 ip_fillid(ip_outer);
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 __unused, int off __unused,
2546 int proto __unused, void *arg __unused)
2549 KASSERT(proto == IPPROTO_PIM, ("not for IPPROTO_PIM"));
2550 return (8); /* claim the datagram. */
2554 * PIM-SMv2 and PIM-DM messages processing.
2555 * Receives and verifies the PIM control messages, and passes them
2556 * up to the listening socket, using rip_input().
2557 * The only message with special processing is the PIM_REGISTER message
2558 * (used by PIM-SM): the PIM header is stripped off, and the inner packet
2559 * is passed to if_simloop().
2562 pim_input(struct mbuf *m, int off, int proto, void *arg __unused)
2564 struct ip *ip = mtod(m, struct ip *);
2568 int datalen = ntohs(ip->ip_len) - iphlen;
2571 /* Keep statistics */
2572 PIMSTAT_INC(pims_rcv_total_msgs);
2573 PIMSTAT_ADD(pims_rcv_total_bytes, datalen);
2578 if (datalen < PIM_MINLEN) {
2579 PIMSTAT_INC(pims_rcv_tooshort);
2580 CTR3(KTR_IPMF, "%s: short packet (%d) from 0x%08x",
2581 __func__, datalen, ntohl(ip->ip_src.s_addr));
2583 return (IPPROTO_DONE);
2587 * If the packet is at least as big as a REGISTER, go agead
2588 * and grab the PIM REGISTER header size, to avoid another
2589 * possible m_pullup() later.
2591 * PIM_MINLEN == pimhdr + u_int32_t == 4 + 4 = 8
2592 * PIM_REG_MINLEN == pimhdr + reghdr + encap_iphdr == 4 + 4 + 20 = 28
2594 minlen = iphlen + (datalen >= PIM_REG_MINLEN ? PIM_REG_MINLEN : PIM_MINLEN);
2596 * Get the IP and PIM headers in contiguous memory, and
2597 * possibly the PIM REGISTER header.
2599 if (m->m_len < minlen && (m = m_pullup(m, minlen)) == NULL) {
2600 CTR1(KTR_IPMF, "%s: m_pullup() failed", __func__);
2601 return (IPPROTO_DONE);
2604 /* m_pullup() may have given us a new mbuf so reset ip. */
2605 ip = mtod(m, struct ip *);
2606 ip_tos = ip->ip_tos;
2608 /* adjust mbuf to point to the PIM header */
2609 m->m_data += iphlen;
2611 pim = mtod(m, struct pim *);
2614 * Validate checksum. If PIM REGISTER, exclude the data packet.
2616 * XXX: some older PIMv2 implementations don't make this distinction,
2617 * so for compatibility reason perform the checksum over part of the
2618 * message, and if error, then over the whole message.
2620 if (PIM_VT_T(pim->pim_vt) == PIM_REGISTER && in_cksum(m, PIM_MINLEN) == 0) {
2621 /* do nothing, checksum okay */
2622 } else if (in_cksum(m, datalen)) {
2623 PIMSTAT_INC(pims_rcv_badsum);
2624 CTR1(KTR_IPMF, "%s: invalid checksum", __func__);
2626 return (IPPROTO_DONE);
2629 /* PIM version check */
2630 if (PIM_VT_V(pim->pim_vt) < PIM_VERSION) {
2631 PIMSTAT_INC(pims_rcv_badversion);
2632 CTR3(KTR_IPMF, "%s: bad version %d expect %d", __func__,
2633 (int)PIM_VT_V(pim->pim_vt), PIM_VERSION);
2635 return (IPPROTO_DONE);
2638 /* restore mbuf back to the outer IP */
2639 m->m_data -= iphlen;
2642 if (PIM_VT_T(pim->pim_vt) == PIM_REGISTER) {
2644 * Since this is a REGISTER, we'll make a copy of the register
2645 * headers ip + pim + u_int32 + encap_ip, to be passed up to the
2648 struct sockaddr_in dst = { sizeof(dst), AF_INET };
2650 struct ip *encap_ip;
2655 if ((V_reg_vif_num >= V_numvifs) || (V_reg_vif_num == VIFI_INVALID)) {
2657 CTR2(KTR_IPMF, "%s: register vif not set: %d", __func__,
2658 (int)V_reg_vif_num);
2660 return (IPPROTO_DONE);
2662 /* XXX need refcnt? */
2663 vifp = V_viftable[V_reg_vif_num].v_ifp;
2669 if (datalen < PIM_REG_MINLEN) {
2670 PIMSTAT_INC(pims_rcv_tooshort);
2671 PIMSTAT_INC(pims_rcv_badregisters);
2672 CTR1(KTR_IPMF, "%s: register packet size too small", __func__);
2674 return (IPPROTO_DONE);
2677 reghdr = (u_int32_t *)(pim + 1);
2678 encap_ip = (struct ip *)(reghdr + 1);
2680 CTR3(KTR_IPMF, "%s: register: encap ip src 0x%08x len %d",
2681 __func__, ntohl(encap_ip->ip_src.s_addr),
2682 ntohs(encap_ip->ip_len));
2684 /* verify the version number of the inner packet */
2685 if (encap_ip->ip_v != IPVERSION) {
2686 PIMSTAT_INC(pims_rcv_badregisters);
2687 CTR1(KTR_IPMF, "%s: bad encap ip version", __func__);
2689 return (IPPROTO_DONE);
2692 /* verify the inner packet is destined to a mcast group */
2693 if (!IN_MULTICAST(ntohl(encap_ip->ip_dst.s_addr))) {
2694 PIMSTAT_INC(pims_rcv_badregisters);
2695 CTR2(KTR_IPMF, "%s: bad encap ip dest 0x%08x", __func__,
2696 ntohl(encap_ip->ip_dst.s_addr));
2698 return (IPPROTO_DONE);
2701 /* If a NULL_REGISTER, pass it to the daemon */
2702 if ((ntohl(*reghdr) & PIM_NULL_REGISTER))
2703 goto pim_input_to_daemon;
2706 * Copy the TOS from the outer IP header to the inner IP header.
2708 if (encap_ip->ip_tos != ip_tos) {
2709 /* Outer TOS -> inner TOS */
2710 encap_ip->ip_tos = ip_tos;
2711 /* Recompute the inner header checksum. Sigh... */
2713 /* adjust mbuf to point to the inner IP header */
2714 m->m_data += (iphlen + PIM_MINLEN);
2715 m->m_len -= (iphlen + PIM_MINLEN);
2717 encap_ip->ip_sum = 0;
2718 encap_ip->ip_sum = in_cksum(m, encap_ip->ip_hl << 2);
2720 /* restore mbuf to point back to the outer IP header */
2721 m->m_data -= (iphlen + PIM_MINLEN);
2722 m->m_len += (iphlen + PIM_MINLEN);
2726 * Decapsulate the inner IP packet and loopback to forward it
2727 * as a normal multicast packet. Also, make a copy of the
2728 * outer_iphdr + pimhdr + reghdr + encap_iphdr
2729 * to pass to the daemon later, so it can take the appropriate
2730 * actions (e.g., send back PIM_REGISTER_STOP).
2731 * XXX: here m->m_data points to the outer IP header.
2733 mcp = m_copym(m, 0, iphlen + PIM_REG_MINLEN, M_NOWAIT);
2735 CTR1(KTR_IPMF, "%s: m_copym() failed", __func__);
2737 return (IPPROTO_DONE);
2740 /* Keep statistics */
2741 /* XXX: registers_bytes include only the encap. mcast pkt */
2742 PIMSTAT_INC(pims_rcv_registers_msgs);
2743 PIMSTAT_ADD(pims_rcv_registers_bytes, ntohs(encap_ip->ip_len));
2746 * forward the inner ip packet; point m_data at the inner ip.
2748 m_adj(m, iphlen + PIM_MINLEN);
2751 "%s: forward decap'd REGISTER: src %lx dst %lx vif %d",
2753 (u_long)ntohl(encap_ip->ip_src.s_addr),
2754 (u_long)ntohl(encap_ip->ip_dst.s_addr),
2755 (int)V_reg_vif_num);
2757 /* NB: vifp was collected above; can it change on us? */
2758 if_simloop(vifp, m, dst.sin_family, 0);
2760 /* prepare the register head to send to the mrouting daemon */
2764 pim_input_to_daemon:
2766 * Pass the PIM message up to the daemon; if it is a Register message,
2767 * pass the 'head' only up to the daemon. This includes the
2768 * outer IP header, PIM header, PIM-Register header and the
2770 * XXX: the outer IP header pkt size of a Register is not adjust to
2771 * reflect the fact that the inner multicast data is truncated.
2773 return (rip_input(&m, &off, proto));
2777 sysctl_mfctable(SYSCTL_HANDLER_ARGS)
2784 if (V_mfchashtbl == NULL) /* XXX unlocked */
2786 error = sysctl_wire_old_buffer(req, 0);
2791 for (i = 0; i < mfchashsize; i++) {
2792 LIST_FOREACH(rt, &V_mfchashtbl[i], mfc_hash) {
2793 error = SYSCTL_OUT(req, rt, sizeof(struct mfc));
2803 static SYSCTL_NODE(_net_inet_ip, OID_AUTO, mfctable, CTLFLAG_RD,
2804 sysctl_mfctable, "IPv4 Multicast Forwarding Table "
2805 "(struct *mfc[mfchashsize], netinet/ip_mroute.h)");
2808 vnet_mroute_init(const void *unused __unused)
2811 V_nexpire = malloc(mfchashsize, M_MRTABLE, M_WAITOK|M_ZERO);
2813 V_viftable = mallocarray(MAXVIFS, sizeof(*V_viftable),
2814 M_MRTABLE, M_WAITOK|M_ZERO);
2815 V_bw_meter_timers = mallocarray(BW_METER_BUCKETS,
2816 sizeof(*V_bw_meter_timers), M_MRTABLE, M_WAITOK|M_ZERO);
2817 V_bw_upcalls = mallocarray(BW_UPCALLS_MAX, sizeof(*V_bw_upcalls),
2818 M_MRTABLE, M_WAITOK|M_ZERO);
2820 callout_init(&V_expire_upcalls_ch, 1);
2821 callout_init(&V_bw_upcalls_ch, 1);
2822 callout_init(&V_bw_meter_ch, 1);
2825 VNET_SYSINIT(vnet_mroute_init, SI_SUB_PROTO_MC, SI_ORDER_ANY, vnet_mroute_init,
2829 vnet_mroute_uninit(const void *unused __unused)
2832 free(V_bw_upcalls, M_MRTABLE);
2833 free(V_bw_meter_timers, M_MRTABLE);
2834 free(V_viftable, M_MRTABLE);
2835 free(V_nexpire, M_MRTABLE);
2839 VNET_SYSUNINIT(vnet_mroute_uninit, SI_SUB_PROTO_MC, SI_ORDER_MIDDLE,
2840 vnet_mroute_uninit, NULL);
2843 ip_mroute_modevent(module_t mod, int type, void *unused)
2848 MROUTER_LOCK_INIT();
2850 if_detach_event_tag = EVENTHANDLER_REGISTER(ifnet_departure_event,
2851 if_detached_event, NULL, EVENTHANDLER_PRI_ANY);
2852 if (if_detach_event_tag == NULL) {
2853 printf("ip_mroute: unable to register "
2854 "ifnet_departure_event handler\n");
2855 MROUTER_LOCK_DESTROY();
2862 mfchashsize = MFCHASHSIZE;
2863 if (TUNABLE_ULONG_FETCH("net.inet.ip.mfchashsize", &mfchashsize) &&
2864 !powerof2(mfchashsize)) {
2865 printf("WARNING: %s not a power of 2; using default\n",
2866 "net.inet.ip.mfchashsize");
2867 mfchashsize = MFCHASHSIZE;
2870 pim_squelch_wholepkt = 0;
2871 TUNABLE_ULONG_FETCH("net.inet.pim.squelch_wholepkt",
2872 &pim_squelch_wholepkt);
2874 pim_encap_cookie = ip_encap_attach(&ipv4_encap_cfg, NULL, M_WAITOK);
2875 if (pim_encap_cookie == NULL) {
2876 printf("ip_mroute: unable to attach pim encap\n");
2879 MROUTER_LOCK_DESTROY();
2883 ip_mcast_src = X_ip_mcast_src;
2884 ip_mforward = X_ip_mforward;
2885 ip_mrouter_done = X_ip_mrouter_done;
2886 ip_mrouter_get = X_ip_mrouter_get;
2887 ip_mrouter_set = X_ip_mrouter_set;
2889 ip_rsvp_force_done = X_ip_rsvp_force_done;
2890 ip_rsvp_vif = X_ip_rsvp_vif;
2892 legal_vif_num = X_legal_vif_num;
2893 mrt_ioctl = X_mrt_ioctl;
2894 rsvp_input_p = X_rsvp_input;
2899 * Typically module unload happens after the user-level
2900 * process has shutdown the kernel services (the check
2901 * below insures someone can't just yank the module out
2902 * from under a running process). But if the module is
2903 * just loaded and then unloaded w/o starting up a user
2904 * process we still need to cleanup.
2907 if (ip_mrouter_cnt != 0) {
2911 ip_mrouter_unloading = 1;
2914 EVENTHANDLER_DEREGISTER(ifnet_departure_event, if_detach_event_tag);
2916 if (pim_encap_cookie) {
2917 ip_encap_detach(pim_encap_cookie);
2918 pim_encap_cookie = NULL;
2921 ip_mcast_src = NULL;
2923 ip_mrouter_done = NULL;
2924 ip_mrouter_get = NULL;
2925 ip_mrouter_set = NULL;
2927 ip_rsvp_force_done = NULL;
2930 legal_vif_num = NULL;
2932 rsvp_input_p = NULL;
2936 MROUTER_LOCK_DESTROY();
2945 static moduledata_t ip_mroutemod = {
2951 DECLARE_MODULE(ip_mroute, ip_mroutemod, SI_SUB_PROTO_MC, SI_ORDER_MIDDLE);