1 /*- 2 * SPDX-License-Identifier: BSD-3-Clause 3 * 4 * Copyright (c) 1989 Stephen Deering 5 * Copyright (c) 1992, 1993 6 * The Regents of the University of California. All rights reserved. 7 * 8 * This code is derived from software contributed to Berkeley by 9 * Stephen Deering of Stanford University. 10 * 11 * Redistribution and use in source and binary forms, with or without 12 * modification, are permitted provided that the following conditions 13 * are met: 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. 22 * 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 33 * SUCH DAMAGE. 34 * 35 * @(#)ip_mroute.c 8.2 (Berkeley) 11/15/93 36 */ 37 38 /* 39 * IP multicast forwarding procedures 40 * 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 52 * 53 * MROUTING Revision: 3.5 54 * and PIM-SMv2 and PIM-DM support, advanced API support, 55 * bandwidth metering and signaling 56 */ 57 58 /* 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. 69 */ 70 71 #include <sys/cdefs.h> 72 __FBSDID("$FreeBSD$"); 73 74 #include "opt_inet.h" 75 #include "opt_mrouting.h" 76 77 #define _PIM_VT 1 78 79 #include <sys/param.h> 80 #include <sys/kernel.h> 81 #include <sys/stddef.h> 82 #include <sys/eventhandler.h> 83 #include <sys/lock.h> 84 #include <sys/ktr.h> 85 #include <sys/malloc.h> 86 #include <sys/mbuf.h> 87 #include <sys/module.h> 88 #include <sys/priv.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> 94 #include <sys/sx.h> 95 #include <sys/sysctl.h> 96 #include <sys/syslog.h> 97 #include <sys/systm.h> 98 #include <sys/time.h> 99 #include <sys/counter.h> 100 101 #include <net/if.h> 102 #include <net/if_var.h> 103 #include <net/netisr.h> 104 #include <net/route.h> 105 #include <net/vnet.h> 106 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> 119 120 #include <machine/in_cksum.h> 121 122 #ifndef KTR_IPMF 123 #define KTR_IPMF KTR_INET 124 #endif 125 126 #define VIFI_INVALID ((vifi_t) -1) 127 128 VNET_DEFINE_STATIC(uint32_t, last_tv_sec); /* last time we processed this */ 129 #define V_last_tv_sec VNET(last_tv_sec) 130 131 static MALLOC_DEFINE(M_MRTABLE, "mroutetbl", "multicast forwarding cache"); 132 133 /* 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 138 * structures. 139 */ 140 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) 148 149 static int ip_mrouter_cnt; /* # of vnets with active mrouters */ 150 static int ip_mrouter_unloading; /* Allow no more V_ip_mrouter sockets */ 151 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)"); 158 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 165 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) 171 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) 179 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) 184 185 static struct mtx vif_mtx; 186 #define VIF_LOCK() mtx_lock(&vif_mtx) 187 #define VIF_UNLOCK() mtx_unlock(&vif_mtx) 188 #define VIF_LOCK_ASSERT() mtx_assert(&vif_mtx, MA_OWNED) 189 #define VIF_LOCK_INIT() \ 190 mtx_init(&vif_mtx, "IPv4 multicast interfaces", NULL, MTX_DEF) 191 #define VIF_LOCK_DESTROY() mtx_destroy(&vif_mtx) 192 193 static eventhandler_tag if_detach_event_tag = NULL; 194 195 VNET_DEFINE_STATIC(struct callout, expire_upcalls_ch); 196 #define V_expire_upcalls_ch VNET(expire_upcalls_ch) 197 198 #define EXPIRE_TIMEOUT (hz / 4) /* 4x / second */ 199 #define UPCALL_EXPIRE 6 /* number of timeouts */ 200 201 /* 202 * Bandwidth meter variables and constants 203 */ 204 static MALLOC_DEFINE(M_BWMETER, "bwmeter", "multicast upcall bw meters"); 205 /* 206 * Pending timeouts are stored in a hash table, the key being the 207 * expiration time. Periodically, the entries are analysed and processed. 208 */ 209 #define BW_METER_BUCKETS 1024 210 VNET_DEFINE_STATIC(struct bw_meter **, bw_meter_timers); 211 #define V_bw_meter_timers VNET(bw_meter_timers) 212 VNET_DEFINE_STATIC(struct callout, bw_meter_ch); 213 #define V_bw_meter_ch VNET(bw_meter_ch) 214 #define BW_METER_PERIOD (hz) /* periodical handling of bw meters */ 215 216 /* 217 * Pending upcalls are stored in a vector which is flushed when 218 * full, or periodically 219 */ 220 VNET_DEFINE_STATIC(struct bw_upcall *, bw_upcalls); 221 #define V_bw_upcalls VNET(bw_upcalls) 222 VNET_DEFINE_STATIC(u_int, bw_upcalls_n); /* # of pending upcalls */ 223 #define V_bw_upcalls_n VNET(bw_upcalls_n) 224 VNET_DEFINE_STATIC(struct callout, bw_upcalls_ch); 225 #define V_bw_upcalls_ch VNET(bw_upcalls_ch) 226 227 #define BW_UPCALLS_PERIOD (hz) /* periodical flush of bw upcalls */ 228 229 VNET_PCPUSTAT_DEFINE_STATIC(struct pimstat, pimstat); 230 VNET_PCPUSTAT_SYSINIT(pimstat); 231 VNET_PCPUSTAT_SYSUNINIT(pimstat); 232 233 SYSCTL_NODE(_net_inet, IPPROTO_PIM, pim, CTLFLAG_RW | CTLFLAG_MPSAFE, 0, 234 "PIM"); 235 SYSCTL_VNET_PCPUSTAT(_net_inet_pim, PIMCTL_STATS, stats, struct pimstat, 236 pimstat, "PIM Statistics (struct pimstat, netinet/pim_var.h)"); 237 238 static u_long pim_squelch_wholepkt = 0; 239 SYSCTL_ULONG(_net_inet_pim, OID_AUTO, squelch_wholepkt, CTLFLAG_RW, 240 &pim_squelch_wholepkt, 0, 241 "Disable IGMP_WHOLEPKT notifications if rendezvous point is unspecified"); 242 243 static const struct encaptab *pim_encap_cookie; 244 static int pim_encapcheck(const struct mbuf *, int, int, void *); 245 static int pim_input(struct mbuf *, int, int, void *); 246 247 extern int in_mcast_loop; 248 249 static const struct encap_config ipv4_encap_cfg = { 250 .proto = IPPROTO_PIM, 251 .min_length = sizeof(struct ip) + PIM_MINLEN, 252 .exact_match = 8, 253 .check = pim_encapcheck, 254 .input = pim_input 255 }; 256 257 /* 258 * Note: the PIM Register encapsulation adds the following in front of a 259 * data packet: 260 * 261 * struct pim_encap_hdr { 262 * struct ip ip; 263 * struct pim_encap_pimhdr pim; 264 * } 265 * 266 */ 267 268 struct pim_encap_pimhdr { 269 struct pim pim; 270 uint32_t flags; 271 }; 272 #define PIM_ENCAP_TTL 64 273 274 static struct ip pim_encap_iphdr = { 275 #if BYTE_ORDER == LITTLE_ENDIAN 276 sizeof(struct ip) >> 2, 277 IPVERSION, 278 #else 279 IPVERSION, 280 sizeof(struct ip) >> 2, 281 #endif 282 0, /* tos */ 283 sizeof(struct ip), /* total length */ 284 0, /* id */ 285 0, /* frag offset */ 286 PIM_ENCAP_TTL, 287 IPPROTO_PIM, 288 0, /* checksum */ 289 }; 290 291 static struct pim_encap_pimhdr pim_encap_pimhdr = { 292 { 293 PIM_MAKE_VT(PIM_VERSION, PIM_REGISTER), /* PIM vers and message type */ 294 0, /* reserved */ 295 0, /* checksum */ 296 }, 297 0 /* flags */ 298 }; 299 300 VNET_DEFINE_STATIC(vifi_t, reg_vif_num) = VIFI_INVALID; 301 #define V_reg_vif_num VNET(reg_vif_num) 302 VNET_DEFINE_STATIC(struct ifnet, multicast_register_if); 303 #define V_multicast_register_if VNET(multicast_register_if) 304 305 /* 306 * Private variables. 307 */ 308 309 static u_long X_ip_mcast_src(int); 310 static int X_ip_mforward(struct ip *, struct ifnet *, struct mbuf *, 311 struct ip_moptions *); 312 static int X_ip_mrouter_done(void); 313 static int X_ip_mrouter_get(struct socket *, struct sockopt *); 314 static int X_ip_mrouter_set(struct socket *, struct sockopt *); 315 static int X_legal_vif_num(int); 316 static int X_mrt_ioctl(u_long, caddr_t, int); 317 318 static int add_bw_upcall(struct bw_upcall *); 319 static int add_mfc(struct mfcctl2 *); 320 static int add_vif(struct vifctl *); 321 static void bw_meter_prepare_upcall(struct bw_meter *, struct timeval *); 322 static void bw_meter_process(void); 323 static void bw_meter_receive_packet(struct bw_meter *, int, 324 struct timeval *); 325 static void bw_upcalls_send(void); 326 static int del_bw_upcall(struct bw_upcall *); 327 static int del_mfc(struct mfcctl2 *); 328 static int del_vif(vifi_t); 329 static int del_vif_locked(vifi_t); 330 static void expire_bw_meter_process(void *); 331 static void expire_bw_upcalls_send(void *); 332 static void expire_mfc(struct mfc *); 333 static void expire_upcalls(void *); 334 static void free_bw_list(struct bw_meter *); 335 static int get_sg_cnt(struct sioc_sg_req *); 336 static int get_vif_cnt(struct sioc_vif_req *); 337 static void if_detached_event(void *, struct ifnet *); 338 static int ip_mdq(struct mbuf *, struct ifnet *, struct mfc *, vifi_t); 339 static int ip_mrouter_init(struct socket *, int); 340 static __inline struct mfc * 341 mfc_find(struct in_addr *, struct in_addr *); 342 static void phyint_send(struct ip *, struct vif *, struct mbuf *); 343 static struct mbuf * 344 pim_register_prepare(struct ip *, struct mbuf *); 345 static int pim_register_send(struct ip *, struct vif *, 346 struct mbuf *, struct mfc *); 347 static int pim_register_send_rp(struct ip *, struct vif *, 348 struct mbuf *, struct mfc *); 349 static int pim_register_send_upcall(struct ip *, struct vif *, 350 struct mbuf *, struct mfc *); 351 static void schedule_bw_meter(struct bw_meter *, struct timeval *); 352 static void send_packet(struct vif *, struct mbuf *); 353 static int set_api_config(uint32_t *); 354 static int set_assert(int); 355 static int socket_send(struct socket *, struct mbuf *, 356 struct sockaddr_in *); 357 static void unschedule_bw_meter(struct bw_meter *); 358 359 /* 360 * Kernel multicast forwarding API capabilities and setup. 361 * If more API capabilities are added to the kernel, they should be 362 * recorded in `mrt_api_support'. 363 */ 364 #define MRT_API_VERSION 0x0305 365 366 static const int mrt_api_version = MRT_API_VERSION; 367 static const uint32_t mrt_api_support = (MRT_MFC_FLAGS_DISABLE_WRONGVIF | 368 MRT_MFC_FLAGS_BORDER_VIF | 369 MRT_MFC_RP | 370 MRT_MFC_BW_UPCALL); 371 VNET_DEFINE_STATIC(uint32_t, mrt_api_config); 372 #define V_mrt_api_config VNET(mrt_api_config) 373 VNET_DEFINE_STATIC(int, pim_assert_enabled); 374 #define V_pim_assert_enabled VNET(pim_assert_enabled) 375 static struct timeval pim_assert_interval = { 3, 0 }; /* Rate limit */ 376 377 /* 378 * Find a route for a given origin IP address and multicast group address. 379 * Statistics must be updated by the caller. 380 */ 381 static __inline struct mfc * 382 mfc_find(struct in_addr *o, struct in_addr *g) 383 { 384 struct mfc *rt; 385 386 MFC_LOCK_ASSERT(); 387 388 LIST_FOREACH(rt, &V_mfchashtbl[MFCHASH(*o, *g)], mfc_hash) { 389 if (in_hosteq(rt->mfc_origin, *o) && 390 in_hosteq(rt->mfc_mcastgrp, *g) && 391 TAILQ_EMPTY(&rt->mfc_stall)) 392 break; 393 } 394 395 return (rt); 396 } 397 398 /* 399 * Handle MRT setsockopt commands to modify the multicast forwarding tables. 400 */ 401 static int 402 X_ip_mrouter_set(struct socket *so, struct sockopt *sopt) 403 { 404 int error, optval; 405 vifi_t vifi; 406 struct vifctl vifc; 407 struct mfcctl2 mfc; 408 struct bw_upcall bw_upcall; 409 uint32_t i; 410 411 if (so != V_ip_mrouter && sopt->sopt_name != MRT_INIT) 412 return EPERM; 413 414 error = 0; 415 switch (sopt->sopt_name) { 416 case MRT_INIT: 417 error = sooptcopyin(sopt, &optval, sizeof optval, sizeof optval); 418 if (error) 419 break; 420 error = ip_mrouter_init(so, optval); 421 break; 422 423 case MRT_DONE: 424 error = ip_mrouter_done(); 425 break; 426 427 case MRT_ADD_VIF: 428 error = sooptcopyin(sopt, &vifc, sizeof vifc, sizeof vifc); 429 if (error) 430 break; 431 error = add_vif(&vifc); 432 break; 433 434 case MRT_DEL_VIF: 435 error = sooptcopyin(sopt, &vifi, sizeof vifi, sizeof vifi); 436 if (error) 437 break; 438 error = del_vif(vifi); 439 break; 440 441 case MRT_ADD_MFC: 442 case MRT_DEL_MFC: 443 /* 444 * select data size depending on API version. 445 */ 446 if (sopt->sopt_name == MRT_ADD_MFC && 447 V_mrt_api_config & MRT_API_FLAGS_ALL) { 448 error = sooptcopyin(sopt, &mfc, sizeof(struct mfcctl2), 449 sizeof(struct mfcctl2)); 450 } else { 451 error = sooptcopyin(sopt, &mfc, sizeof(struct mfcctl), 452 sizeof(struct mfcctl)); 453 bzero((caddr_t)&mfc + sizeof(struct mfcctl), 454 sizeof(mfc) - sizeof(struct mfcctl)); 455 } 456 if (error) 457 break; 458 if (sopt->sopt_name == MRT_ADD_MFC) 459 error = add_mfc(&mfc); 460 else 461 error = del_mfc(&mfc); 462 break; 463 464 case MRT_ASSERT: 465 error = sooptcopyin(sopt, &optval, sizeof optval, sizeof optval); 466 if (error) 467 break; 468 set_assert(optval); 469 break; 470 471 case MRT_API_CONFIG: 472 error = sooptcopyin(sopt, &i, sizeof i, sizeof i); 473 if (!error) 474 error = set_api_config(&i); 475 if (!error) 476 error = sooptcopyout(sopt, &i, sizeof i); 477 break; 478 479 case MRT_ADD_BW_UPCALL: 480 case MRT_DEL_BW_UPCALL: 481 error = sooptcopyin(sopt, &bw_upcall, sizeof bw_upcall, 482 sizeof bw_upcall); 483 if (error) 484 break; 485 if (sopt->sopt_name == MRT_ADD_BW_UPCALL) 486 error = add_bw_upcall(&bw_upcall); 487 else 488 error = del_bw_upcall(&bw_upcall); 489 break; 490 491 default: 492 error = EOPNOTSUPP; 493 break; 494 } 495 return error; 496 } 497 498 /* 499 * Handle MRT getsockopt commands 500 */ 501 static int 502 X_ip_mrouter_get(struct socket *so, struct sockopt *sopt) 503 { 504 int error; 505 506 switch (sopt->sopt_name) { 507 case MRT_VERSION: 508 error = sooptcopyout(sopt, &mrt_api_version, sizeof mrt_api_version); 509 break; 510 511 case MRT_ASSERT: 512 error = sooptcopyout(sopt, &V_pim_assert_enabled, 513 sizeof V_pim_assert_enabled); 514 break; 515 516 case MRT_API_SUPPORT: 517 error = sooptcopyout(sopt, &mrt_api_support, sizeof mrt_api_support); 518 break; 519 520 case MRT_API_CONFIG: 521 error = sooptcopyout(sopt, &V_mrt_api_config, sizeof V_mrt_api_config); 522 break; 523 524 default: 525 error = EOPNOTSUPP; 526 break; 527 } 528 return error; 529 } 530 531 /* 532 * Handle ioctl commands to obtain information from the cache 533 */ 534 static int 535 X_mrt_ioctl(u_long cmd, caddr_t data, int fibnum __unused) 536 { 537 int error = 0; 538 539 /* 540 * Currently the only function calling this ioctl routine is rtioctl_fib(). 541 * Typically, only root can create the raw socket in order to execute 542 * this ioctl method, however the request might be coming from a prison 543 */ 544 error = priv_check(curthread, PRIV_NETINET_MROUTE); 545 if (error) 546 return (error); 547 switch (cmd) { 548 case (SIOCGETVIFCNT): 549 error = get_vif_cnt((struct sioc_vif_req *)data); 550 break; 551 552 case (SIOCGETSGCNT): 553 error = get_sg_cnt((struct sioc_sg_req *)data); 554 break; 555 556 default: 557 error = EINVAL; 558 break; 559 } 560 return error; 561 } 562 563 /* 564 * returns the packet, byte, rpf-failure count for the source group provided 565 */ 566 static int 567 get_sg_cnt(struct sioc_sg_req *req) 568 { 569 struct mfc *rt; 570 571 MFC_LOCK(); 572 rt = mfc_find(&req->src, &req->grp); 573 if (rt == NULL) { 574 MFC_UNLOCK(); 575 req->pktcnt = req->bytecnt = req->wrong_if = 0xffffffff; 576 return EADDRNOTAVAIL; 577 } 578 req->pktcnt = rt->mfc_pkt_cnt; 579 req->bytecnt = rt->mfc_byte_cnt; 580 req->wrong_if = rt->mfc_wrong_if; 581 MFC_UNLOCK(); 582 return 0; 583 } 584 585 /* 586 * returns the input and output packet and byte counts on the vif provided 587 */ 588 static int 589 get_vif_cnt(struct sioc_vif_req *req) 590 { 591 vifi_t vifi = req->vifi; 592 593 VIF_LOCK(); 594 if (vifi >= V_numvifs) { 595 VIF_UNLOCK(); 596 return EINVAL; 597 } 598 599 req->icount = V_viftable[vifi].v_pkt_in; 600 req->ocount = V_viftable[vifi].v_pkt_out; 601 req->ibytes = V_viftable[vifi].v_bytes_in; 602 req->obytes = V_viftable[vifi].v_bytes_out; 603 VIF_UNLOCK(); 604 605 return 0; 606 } 607 608 static void 609 if_detached_event(void *arg __unused, struct ifnet *ifp) 610 { 611 vifi_t vifi; 612 u_long i; 613 614 MROUTER_LOCK(); 615 616 if (V_ip_mrouter == NULL) { 617 MROUTER_UNLOCK(); 618 return; 619 } 620 621 VIF_LOCK(); 622 MFC_LOCK(); 623 624 /* 625 * Tear down multicast forwarder state associated with this ifnet. 626 * 1. Walk the vif list, matching vifs against this ifnet. 627 * 2. Walk the multicast forwarding cache (mfc) looking for 628 * inner matches with this vif's index. 629 * 3. Expire any matching multicast forwarding cache entries. 630 * 4. Free vif state. This should disable ALLMULTI on the interface. 631 */ 632 for (vifi = 0; vifi < V_numvifs; vifi++) { 633 if (V_viftable[vifi].v_ifp != ifp) 634 continue; 635 for (i = 0; i < mfchashsize; i++) { 636 struct mfc *rt, *nrt; 637 638 LIST_FOREACH_SAFE(rt, &V_mfchashtbl[i], mfc_hash, nrt) { 639 if (rt->mfc_parent == vifi) { 640 expire_mfc(rt); 641 } 642 } 643 } 644 del_vif_locked(vifi); 645 } 646 647 MFC_UNLOCK(); 648 VIF_UNLOCK(); 649 650 MROUTER_UNLOCK(); 651 } 652 653 /* 654 * Enable multicast forwarding. 655 */ 656 static int 657 ip_mrouter_init(struct socket *so, int version) 658 { 659 660 CTR3(KTR_IPMF, "%s: so_type %d, pr_protocol %d", __func__, 661 so->so_type, so->so_proto->pr_protocol); 662 663 if (so->so_type != SOCK_RAW || so->so_proto->pr_protocol != IPPROTO_IGMP) 664 return EOPNOTSUPP; 665 666 if (version != 1) 667 return ENOPROTOOPT; 668 669 MROUTER_LOCK(); 670 671 if (ip_mrouter_unloading) { 672 MROUTER_UNLOCK(); 673 return ENOPROTOOPT; 674 } 675 676 if (V_ip_mrouter != NULL) { 677 MROUTER_UNLOCK(); 678 return EADDRINUSE; 679 } 680 681 V_mfchashtbl = hashinit_flags(mfchashsize, M_MRTABLE, &V_mfchash, 682 HASH_NOWAIT); 683 684 callout_reset(&V_expire_upcalls_ch, EXPIRE_TIMEOUT, expire_upcalls, 685 curvnet); 686 callout_reset(&V_bw_upcalls_ch, BW_UPCALLS_PERIOD, expire_bw_upcalls_send, 687 curvnet); 688 callout_reset(&V_bw_meter_ch, BW_METER_PERIOD, expire_bw_meter_process, 689 curvnet); 690 691 V_ip_mrouter = so; 692 ip_mrouter_cnt++; 693 694 MROUTER_UNLOCK(); 695 696 CTR1(KTR_IPMF, "%s: done", __func__); 697 698 return 0; 699 } 700 701 /* 702 * Disable multicast forwarding. 703 */ 704 static int 705 X_ip_mrouter_done(void) 706 { 707 struct ifnet *ifp; 708 u_long i; 709 vifi_t vifi; 710 711 MROUTER_LOCK(); 712 713 if (V_ip_mrouter == NULL) { 714 MROUTER_UNLOCK(); 715 return EINVAL; 716 } 717 718 /* 719 * Detach/disable hooks to the reset of the system. 720 */ 721 V_ip_mrouter = NULL; 722 ip_mrouter_cnt--; 723 V_mrt_api_config = 0; 724 725 MROUTER_WAIT(); 726 727 VIF_LOCK(); 728 729 /* 730 * For each phyint in use, disable promiscuous reception of all IP 731 * multicasts. 732 */ 733 for (vifi = 0; vifi < V_numvifs; vifi++) { 734 if (!in_nullhost(V_viftable[vifi].v_lcl_addr) && 735 !(V_viftable[vifi].v_flags & (VIFF_TUNNEL | VIFF_REGISTER))) { 736 ifp = V_viftable[vifi].v_ifp; 737 if_allmulti(ifp, 0); 738 } 739 } 740 bzero((caddr_t)V_viftable, sizeof(*V_viftable) * MAXVIFS); 741 V_numvifs = 0; 742 V_pim_assert_enabled = 0; 743 744 VIF_UNLOCK(); 745 746 callout_stop(&V_expire_upcalls_ch); 747 callout_stop(&V_bw_upcalls_ch); 748 callout_stop(&V_bw_meter_ch); 749 750 MFC_LOCK(); 751 752 /* 753 * Free all multicast forwarding cache entries. 754 * Do not use hashdestroy(), as we must perform other cleanup. 755 */ 756 for (i = 0; i < mfchashsize; i++) { 757 struct mfc *rt, *nrt; 758 759 LIST_FOREACH_SAFE(rt, &V_mfchashtbl[i], mfc_hash, nrt) { 760 expire_mfc(rt); 761 } 762 } 763 free(V_mfchashtbl, M_MRTABLE); 764 V_mfchashtbl = NULL; 765 766 bzero(V_nexpire, sizeof(V_nexpire[0]) * mfchashsize); 767 768 V_bw_upcalls_n = 0; 769 bzero(V_bw_meter_timers, BW_METER_BUCKETS * sizeof(*V_bw_meter_timers)); 770 771 MFC_UNLOCK(); 772 773 V_reg_vif_num = VIFI_INVALID; 774 775 MROUTER_UNLOCK(); 776 777 CTR1(KTR_IPMF, "%s: done", __func__); 778 779 return 0; 780 } 781 782 /* 783 * Set PIM assert processing global 784 */ 785 static int 786 set_assert(int i) 787 { 788 if ((i != 1) && (i != 0)) 789 return EINVAL; 790 791 V_pim_assert_enabled = i; 792 793 return 0; 794 } 795 796 /* 797 * Configure API capabilities 798 */ 799 int 800 set_api_config(uint32_t *apival) 801 { 802 u_long i; 803 804 /* 805 * We can set the API capabilities only if it is the first operation 806 * after MRT_INIT. I.e.: 807 * - there are no vifs installed 808 * - pim_assert is not enabled 809 * - the MFC table is empty 810 */ 811 if (V_numvifs > 0) { 812 *apival = 0; 813 return EPERM; 814 } 815 if (V_pim_assert_enabled) { 816 *apival = 0; 817 return EPERM; 818 } 819 820 MFC_LOCK(); 821 822 for (i = 0; i < mfchashsize; i++) { 823 if (LIST_FIRST(&V_mfchashtbl[i]) != NULL) { 824 MFC_UNLOCK(); 825 *apival = 0; 826 return EPERM; 827 } 828 } 829 830 MFC_UNLOCK(); 831 832 V_mrt_api_config = *apival & mrt_api_support; 833 *apival = V_mrt_api_config; 834 835 return 0; 836 } 837 838 /* 839 * Add a vif to the vif table 840 */ 841 static int 842 add_vif(struct vifctl *vifcp) 843 { 844 struct vif *vifp = V_viftable + vifcp->vifc_vifi; 845 struct sockaddr_in sin = {sizeof sin, AF_INET}; 846 struct ifaddr *ifa; 847 struct ifnet *ifp; 848 int error; 849 850 VIF_LOCK(); 851 if (vifcp->vifc_vifi >= MAXVIFS) { 852 VIF_UNLOCK(); 853 return EINVAL; 854 } 855 /* rate limiting is no longer supported by this code */ 856 if (vifcp->vifc_rate_limit != 0) { 857 log(LOG_ERR, "rate limiting is no longer supported\n"); 858 VIF_UNLOCK(); 859 return EINVAL; 860 } 861 if (!in_nullhost(vifp->v_lcl_addr)) { 862 VIF_UNLOCK(); 863 return EADDRINUSE; 864 } 865 if (in_nullhost(vifcp->vifc_lcl_addr)) { 866 VIF_UNLOCK(); 867 return EADDRNOTAVAIL; 868 } 869 870 /* Find the interface with an address in AF_INET family */ 871 if (vifcp->vifc_flags & VIFF_REGISTER) { 872 /* 873 * XXX: Because VIFF_REGISTER does not really need a valid 874 * local interface (e.g. it could be 127.0.0.2), we don't 875 * check its address. 876 */ 877 ifp = NULL; 878 } else { 879 struct epoch_tracker et; 880 881 sin.sin_addr = vifcp->vifc_lcl_addr; 882 NET_EPOCH_ENTER(et); 883 ifa = ifa_ifwithaddr((struct sockaddr *)&sin); 884 if (ifa == NULL) { 885 NET_EPOCH_EXIT(et); 886 VIF_UNLOCK(); 887 return EADDRNOTAVAIL; 888 } 889 ifp = ifa->ifa_ifp; 890 /* XXX FIXME we need to take a ref on ifp and cleanup properly! */ 891 NET_EPOCH_EXIT(et); 892 } 893 894 if ((vifcp->vifc_flags & VIFF_TUNNEL) != 0) { 895 CTR1(KTR_IPMF, "%s: tunnels are no longer supported", __func__); 896 VIF_UNLOCK(); 897 return EOPNOTSUPP; 898 } else if (vifcp->vifc_flags & VIFF_REGISTER) { 899 ifp = &V_multicast_register_if; 900 CTR2(KTR_IPMF, "%s: add register vif for ifp %p", __func__, ifp); 901 if (V_reg_vif_num == VIFI_INVALID) { 902 if_initname(&V_multicast_register_if, "register_vif", 0); 903 V_multicast_register_if.if_flags = IFF_LOOPBACK; 904 V_reg_vif_num = vifcp->vifc_vifi; 905 } 906 } else { /* Make sure the interface supports multicast */ 907 if ((ifp->if_flags & IFF_MULTICAST) == 0) { 908 VIF_UNLOCK(); 909 return EOPNOTSUPP; 910 } 911 912 /* Enable promiscuous reception of all IP multicasts from the if */ 913 error = if_allmulti(ifp, 1); 914 if (error) { 915 VIF_UNLOCK(); 916 return error; 917 } 918 } 919 920 vifp->v_flags = vifcp->vifc_flags; 921 vifp->v_threshold = vifcp->vifc_threshold; 922 vifp->v_lcl_addr = vifcp->vifc_lcl_addr; 923 vifp->v_rmt_addr = vifcp->vifc_rmt_addr; 924 vifp->v_ifp = ifp; 925 /* initialize per vif pkt counters */ 926 vifp->v_pkt_in = 0; 927 vifp->v_pkt_out = 0; 928 vifp->v_bytes_in = 0; 929 vifp->v_bytes_out = 0; 930 931 /* Adjust numvifs up if the vifi is higher than numvifs */ 932 if (V_numvifs <= vifcp->vifc_vifi) 933 V_numvifs = vifcp->vifc_vifi + 1; 934 935 VIF_UNLOCK(); 936 937 CTR4(KTR_IPMF, "%s: add vif %d laddr 0x%08x thresh %x", __func__, 938 (int)vifcp->vifc_vifi, ntohl(vifcp->vifc_lcl_addr.s_addr), 939 (int)vifcp->vifc_threshold); 940 941 return 0; 942 } 943 944 /* 945 * Delete a vif from the vif table 946 */ 947 static int 948 del_vif_locked(vifi_t vifi) 949 { 950 struct vif *vifp; 951 952 VIF_LOCK_ASSERT(); 953 954 if (vifi >= V_numvifs) { 955 return EINVAL; 956 } 957 vifp = &V_viftable[vifi]; 958 if (in_nullhost(vifp->v_lcl_addr)) { 959 return EADDRNOTAVAIL; 960 } 961 962 if (!(vifp->v_flags & (VIFF_TUNNEL | VIFF_REGISTER))) 963 if_allmulti(vifp->v_ifp, 0); 964 965 if (vifp->v_flags & VIFF_REGISTER) 966 V_reg_vif_num = VIFI_INVALID; 967 968 bzero((caddr_t)vifp, sizeof (*vifp)); 969 970 CTR2(KTR_IPMF, "%s: delete vif %d", __func__, (int)vifi); 971 972 /* Adjust numvifs down */ 973 for (vifi = V_numvifs; vifi > 0; vifi--) 974 if (!in_nullhost(V_viftable[vifi-1].v_lcl_addr)) 975 break; 976 V_numvifs = vifi; 977 978 return 0; 979 } 980 981 static int 982 del_vif(vifi_t vifi) 983 { 984 int cc; 985 986 VIF_LOCK(); 987 cc = del_vif_locked(vifi); 988 VIF_UNLOCK(); 989 990 return cc; 991 } 992 993 /* 994 * update an mfc entry without resetting counters and S,G addresses. 995 */ 996 static void 997 update_mfc_params(struct mfc *rt, struct mfcctl2 *mfccp) 998 { 999 int i; 1000 1001 rt->mfc_parent = mfccp->mfcc_parent; 1002 for (i = 0; i < V_numvifs; i++) { 1003 rt->mfc_ttls[i] = mfccp->mfcc_ttls[i]; 1004 rt->mfc_flags[i] = mfccp->mfcc_flags[i] & V_mrt_api_config & 1005 MRT_MFC_FLAGS_ALL; 1006 } 1007 /* set the RP address */ 1008 if (V_mrt_api_config & MRT_MFC_RP) 1009 rt->mfc_rp = mfccp->mfcc_rp; 1010 else 1011 rt->mfc_rp.s_addr = INADDR_ANY; 1012 } 1013 1014 /* 1015 * fully initialize an mfc entry from the parameter. 1016 */ 1017 static void 1018 init_mfc_params(struct mfc *rt, struct mfcctl2 *mfccp) 1019 { 1020 rt->mfc_origin = mfccp->mfcc_origin; 1021 rt->mfc_mcastgrp = mfccp->mfcc_mcastgrp; 1022 1023 update_mfc_params(rt, mfccp); 1024 1025 /* initialize pkt counters per src-grp */ 1026 rt->mfc_pkt_cnt = 0; 1027 rt->mfc_byte_cnt = 0; 1028 rt->mfc_wrong_if = 0; 1029 timevalclear(&rt->mfc_last_assert); 1030 } 1031 1032 static void 1033 expire_mfc(struct mfc *rt) 1034 { 1035 struct rtdetq *rte, *nrte; 1036 1037 MFC_LOCK_ASSERT(); 1038 1039 free_bw_list(rt->mfc_bw_meter); 1040 1041 TAILQ_FOREACH_SAFE(rte, &rt->mfc_stall, rte_link, nrte) { 1042 m_freem(rte->m); 1043 TAILQ_REMOVE(&rt->mfc_stall, rte, rte_link); 1044 free(rte, M_MRTABLE); 1045 } 1046 1047 LIST_REMOVE(rt, mfc_hash); 1048 free(rt, M_MRTABLE); 1049 } 1050 1051 /* 1052 * Add an mfc entry 1053 */ 1054 static int 1055 add_mfc(struct mfcctl2 *mfccp) 1056 { 1057 struct mfc *rt; 1058 struct rtdetq *rte, *nrte; 1059 u_long hash = 0; 1060 u_short nstl; 1061 1062 VIF_LOCK(); 1063 MFC_LOCK(); 1064 1065 rt = mfc_find(&mfccp->mfcc_origin, &mfccp->mfcc_mcastgrp); 1066 1067 /* If an entry already exists, just update the fields */ 1068 if (rt) { 1069 CTR4(KTR_IPMF, "%s: update mfc orig 0x%08x group %lx parent %x", 1070 __func__, ntohl(mfccp->mfcc_origin.s_addr), 1071 (u_long)ntohl(mfccp->mfcc_mcastgrp.s_addr), 1072 mfccp->mfcc_parent); 1073 update_mfc_params(rt, mfccp); 1074 MFC_UNLOCK(); 1075 VIF_UNLOCK(); 1076 return (0); 1077 } 1078 1079 /* 1080 * Find the entry for which the upcall was made and update 1081 */ 1082 nstl = 0; 1083 hash = MFCHASH(mfccp->mfcc_origin, mfccp->mfcc_mcastgrp); 1084 LIST_FOREACH(rt, &V_mfchashtbl[hash], mfc_hash) { 1085 if (in_hosteq(rt->mfc_origin, mfccp->mfcc_origin) && 1086 in_hosteq(rt->mfc_mcastgrp, mfccp->mfcc_mcastgrp) && 1087 !TAILQ_EMPTY(&rt->mfc_stall)) { 1088 CTR5(KTR_IPMF, 1089 "%s: add mfc orig 0x%08x group %lx parent %x qh %p", 1090 __func__, ntohl(mfccp->mfcc_origin.s_addr), 1091 (u_long)ntohl(mfccp->mfcc_mcastgrp.s_addr), 1092 mfccp->mfcc_parent, 1093 TAILQ_FIRST(&rt->mfc_stall)); 1094 if (nstl++) 1095 CTR1(KTR_IPMF, "%s: multiple matches", __func__); 1096 1097 init_mfc_params(rt, mfccp); 1098 rt->mfc_expire = 0; /* Don't clean this guy up */ 1099 V_nexpire[hash]--; 1100 1101 /* Free queued packets, but attempt to forward them first. */ 1102 TAILQ_FOREACH_SAFE(rte, &rt->mfc_stall, rte_link, nrte) { 1103 if (rte->ifp != NULL) 1104 ip_mdq(rte->m, rte->ifp, rt, -1); 1105 m_freem(rte->m); 1106 TAILQ_REMOVE(&rt->mfc_stall, rte, rte_link); 1107 rt->mfc_nstall--; 1108 free(rte, M_MRTABLE); 1109 } 1110 } 1111 } 1112 1113 /* 1114 * It is possible that an entry is being inserted without an upcall 1115 */ 1116 if (nstl == 0) { 1117 CTR1(KTR_IPMF, "%s: adding mfc w/o upcall", __func__); 1118 LIST_FOREACH(rt, &V_mfchashtbl[hash], mfc_hash) { 1119 if (in_hosteq(rt->mfc_origin, mfccp->mfcc_origin) && 1120 in_hosteq(rt->mfc_mcastgrp, mfccp->mfcc_mcastgrp)) { 1121 init_mfc_params(rt, mfccp); 1122 if (rt->mfc_expire) 1123 V_nexpire[hash]--; 1124 rt->mfc_expire = 0; 1125 break; /* XXX */ 1126 } 1127 } 1128 1129 if (rt == NULL) { /* no upcall, so make a new entry */ 1130 rt = (struct mfc *)malloc(sizeof(*rt), M_MRTABLE, M_NOWAIT); 1131 if (rt == NULL) { 1132 MFC_UNLOCK(); 1133 VIF_UNLOCK(); 1134 return (ENOBUFS); 1135 } 1136 1137 init_mfc_params(rt, mfccp); 1138 TAILQ_INIT(&rt->mfc_stall); 1139 rt->mfc_nstall = 0; 1140 1141 rt->mfc_expire = 0; 1142 rt->mfc_bw_meter = NULL; 1143 1144 /* insert new entry at head of hash chain */ 1145 LIST_INSERT_HEAD(&V_mfchashtbl[hash], rt, mfc_hash); 1146 } 1147 } 1148 1149 MFC_UNLOCK(); 1150 VIF_UNLOCK(); 1151 1152 return (0); 1153 } 1154 1155 /* 1156 * Delete an mfc entry 1157 */ 1158 static int 1159 del_mfc(struct mfcctl2 *mfccp) 1160 { 1161 struct in_addr origin; 1162 struct in_addr mcastgrp; 1163 struct mfc *rt; 1164 1165 origin = mfccp->mfcc_origin; 1166 mcastgrp = mfccp->mfcc_mcastgrp; 1167 1168 CTR3(KTR_IPMF, "%s: delete mfc orig 0x%08x group %lx", __func__, 1169 ntohl(origin.s_addr), (u_long)ntohl(mcastgrp.s_addr)); 1170 1171 MFC_LOCK(); 1172 1173 rt = mfc_find(&origin, &mcastgrp); 1174 if (rt == NULL) { 1175 MFC_UNLOCK(); 1176 return EADDRNOTAVAIL; 1177 } 1178 1179 /* 1180 * free the bw_meter entries 1181 */ 1182 free_bw_list(rt->mfc_bw_meter); 1183 rt->mfc_bw_meter = NULL; 1184 1185 LIST_REMOVE(rt, mfc_hash); 1186 free(rt, M_MRTABLE); 1187 1188 MFC_UNLOCK(); 1189 1190 return (0); 1191 } 1192 1193 /* 1194 * Send a message to the routing daemon on the multicast routing socket. 1195 */ 1196 static int 1197 socket_send(struct socket *s, struct mbuf *mm, struct sockaddr_in *src) 1198 { 1199 if (s) { 1200 SOCKBUF_LOCK(&s->so_rcv); 1201 if (sbappendaddr_locked(&s->so_rcv, (struct sockaddr *)src, mm, 1202 NULL) != 0) { 1203 sorwakeup_locked(s); 1204 return 0; 1205 } 1206 SOCKBUF_UNLOCK(&s->so_rcv); 1207 } 1208 m_freem(mm); 1209 return -1; 1210 } 1211 1212 /* 1213 * IP multicast forwarding function. This function assumes that the packet 1214 * pointed to by "ip" has arrived on (or is about to be sent to) the interface 1215 * pointed to by "ifp", and the packet is to be relayed to other networks 1216 * that have members of the packet's destination IP multicast group. 1217 * 1218 * The packet is returned unscathed to the caller, unless it is 1219 * erroneous, in which case a non-zero return value tells the caller to 1220 * discard it. 1221 */ 1222 1223 #define TUNNEL_LEN 12 /* # bytes of IP option for tunnel encapsulation */ 1224 1225 static int 1226 X_ip_mforward(struct ip *ip, struct ifnet *ifp, struct mbuf *m, 1227 struct ip_moptions *imo) 1228 { 1229 struct mfc *rt; 1230 int error; 1231 vifi_t vifi; 1232 1233 CTR3(KTR_IPMF, "ip_mforward: delete mfc orig 0x%08x group %lx ifp %p", 1234 ntohl(ip->ip_src.s_addr), (u_long)ntohl(ip->ip_dst.s_addr), ifp); 1235 1236 if (ip->ip_hl < (sizeof(struct ip) + TUNNEL_LEN) >> 2 || 1237 ((u_char *)(ip + 1))[1] != IPOPT_LSRR ) { 1238 /* 1239 * Packet arrived via a physical interface or 1240 * an encapsulated tunnel or a register_vif. 1241 */ 1242 } else { 1243 /* 1244 * Packet arrived through a source-route tunnel. 1245 * Source-route tunnels are no longer supported. 1246 */ 1247 return (1); 1248 } 1249 1250 VIF_LOCK(); 1251 MFC_LOCK(); 1252 if (imo && ((vifi = imo->imo_multicast_vif) < V_numvifs)) { 1253 if (ip->ip_ttl < MAXTTL) 1254 ip->ip_ttl++; /* compensate for -1 in *_send routines */ 1255 error = ip_mdq(m, ifp, NULL, vifi); 1256 MFC_UNLOCK(); 1257 VIF_UNLOCK(); 1258 return error; 1259 } 1260 1261 /* 1262 * Don't forward a packet with time-to-live of zero or one, 1263 * or a packet destined to a local-only group. 1264 */ 1265 if (ip->ip_ttl <= 1 || IN_LOCAL_GROUP(ntohl(ip->ip_dst.s_addr))) { 1266 MFC_UNLOCK(); 1267 VIF_UNLOCK(); 1268 return 0; 1269 } 1270 1271 /* 1272 * Determine forwarding vifs from the forwarding cache table 1273 */ 1274 MRTSTAT_INC(mrts_mfc_lookups); 1275 rt = mfc_find(&ip->ip_src, &ip->ip_dst); 1276 1277 /* Entry exists, so forward if necessary */ 1278 if (rt != NULL) { 1279 error = ip_mdq(m, ifp, rt, -1); 1280 MFC_UNLOCK(); 1281 VIF_UNLOCK(); 1282 return error; 1283 } else { 1284 /* 1285 * If we don't have a route for packet's origin, 1286 * Make a copy of the packet & send message to routing daemon 1287 */ 1288 1289 struct mbuf *mb0; 1290 struct rtdetq *rte; 1291 u_long hash; 1292 int hlen = ip->ip_hl << 2; 1293 1294 MRTSTAT_INC(mrts_mfc_misses); 1295 MRTSTAT_INC(mrts_no_route); 1296 CTR2(KTR_IPMF, "ip_mforward: no mfc for (0x%08x,%lx)", 1297 ntohl(ip->ip_src.s_addr), (u_long)ntohl(ip->ip_dst.s_addr)); 1298 1299 /* 1300 * Allocate mbufs early so that we don't do extra work if we are 1301 * just going to fail anyway. Make sure to pullup the header so 1302 * that other people can't step on it. 1303 */ 1304 rte = (struct rtdetq *)malloc((sizeof *rte), M_MRTABLE, 1305 M_NOWAIT|M_ZERO); 1306 if (rte == NULL) { 1307 MFC_UNLOCK(); 1308 VIF_UNLOCK(); 1309 return ENOBUFS; 1310 } 1311 1312 mb0 = m_copypacket(m, M_NOWAIT); 1313 if (mb0 && (!M_WRITABLE(mb0) || mb0->m_len < hlen)) 1314 mb0 = m_pullup(mb0, hlen); 1315 if (mb0 == NULL) { 1316 free(rte, M_MRTABLE); 1317 MFC_UNLOCK(); 1318 VIF_UNLOCK(); 1319 return ENOBUFS; 1320 } 1321 1322 /* is there an upcall waiting for this flow ? */ 1323 hash = MFCHASH(ip->ip_src, ip->ip_dst); 1324 LIST_FOREACH(rt, &V_mfchashtbl[hash], mfc_hash) { 1325 if (in_hosteq(ip->ip_src, rt->mfc_origin) && 1326 in_hosteq(ip->ip_dst, rt->mfc_mcastgrp) && 1327 !TAILQ_EMPTY(&rt->mfc_stall)) 1328 break; 1329 } 1330 1331 if (rt == NULL) { 1332 int i; 1333 struct igmpmsg *im; 1334 struct sockaddr_in k_igmpsrc = { sizeof k_igmpsrc, AF_INET }; 1335 struct mbuf *mm; 1336 1337 /* 1338 * Locate the vifi for the incoming interface for this packet. 1339 * If none found, drop packet. 1340 */ 1341 for (vifi = 0; vifi < V_numvifs && 1342 V_viftable[vifi].v_ifp != ifp; vifi++) 1343 ; 1344 if (vifi >= V_numvifs) /* vif not found, drop packet */ 1345 goto non_fatal; 1346 1347 /* no upcall, so make a new entry */ 1348 rt = (struct mfc *)malloc(sizeof(*rt), M_MRTABLE, M_NOWAIT); 1349 if (rt == NULL) 1350 goto fail; 1351 1352 /* Make a copy of the header to send to the user level process */ 1353 mm = m_copym(mb0, 0, hlen, M_NOWAIT); 1354 if (mm == NULL) 1355 goto fail1; 1356 1357 /* 1358 * Send message to routing daemon to install 1359 * a route into the kernel table 1360 */ 1361 1362 im = mtod(mm, struct igmpmsg *); 1363 im->im_msgtype = IGMPMSG_NOCACHE; 1364 im->im_mbz = 0; 1365 im->im_vif = vifi; 1366 1367 MRTSTAT_INC(mrts_upcalls); 1368 1369 k_igmpsrc.sin_addr = ip->ip_src; 1370 if (socket_send(V_ip_mrouter, mm, &k_igmpsrc) < 0) { 1371 CTR0(KTR_IPMF, "ip_mforward: socket queue full"); 1372 MRTSTAT_INC(mrts_upq_sockfull); 1373 fail1: 1374 free(rt, M_MRTABLE); 1375 fail: 1376 free(rte, M_MRTABLE); 1377 m_freem(mb0); 1378 MFC_UNLOCK(); 1379 VIF_UNLOCK(); 1380 return ENOBUFS; 1381 } 1382 1383 /* insert new entry at head of hash chain */ 1384 rt->mfc_origin.s_addr = ip->ip_src.s_addr; 1385 rt->mfc_mcastgrp.s_addr = ip->ip_dst.s_addr; 1386 rt->mfc_expire = UPCALL_EXPIRE; 1387 V_nexpire[hash]++; 1388 for (i = 0; i < V_numvifs; i++) { 1389 rt->mfc_ttls[i] = 0; 1390 rt->mfc_flags[i] = 0; 1391 } 1392 rt->mfc_parent = -1; 1393 1394 /* clear the RP address */ 1395 rt->mfc_rp.s_addr = INADDR_ANY; 1396 rt->mfc_bw_meter = NULL; 1397 1398 /* initialize pkt counters per src-grp */ 1399 rt->mfc_pkt_cnt = 0; 1400 rt->mfc_byte_cnt = 0; 1401 rt->mfc_wrong_if = 0; 1402 timevalclear(&rt->mfc_last_assert); 1403 1404 TAILQ_INIT(&rt->mfc_stall); 1405 rt->mfc_nstall = 0; 1406 1407 /* link into table */ 1408 LIST_INSERT_HEAD(&V_mfchashtbl[hash], rt, mfc_hash); 1409 TAILQ_INSERT_HEAD(&rt->mfc_stall, rte, rte_link); 1410 rt->mfc_nstall++; 1411 1412 } else { 1413 /* determine if queue has overflowed */ 1414 if (rt->mfc_nstall > MAX_UPQ) { 1415 MRTSTAT_INC(mrts_upq_ovflw); 1416 non_fatal: 1417 free(rte, M_MRTABLE); 1418 m_freem(mb0); 1419 MFC_UNLOCK(); 1420 VIF_UNLOCK(); 1421 return (0); 1422 } 1423 TAILQ_INSERT_TAIL(&rt->mfc_stall, rte, rte_link); 1424 rt->mfc_nstall++; 1425 } 1426 1427 rte->m = mb0; 1428 rte->ifp = ifp; 1429 1430 MFC_UNLOCK(); 1431 VIF_UNLOCK(); 1432 1433 return 0; 1434 } 1435 } 1436 1437 /* 1438 * Clean up the cache entry if upcall is not serviced 1439 */ 1440 static void 1441 expire_upcalls(void *arg) 1442 { 1443 u_long i; 1444 1445 CURVNET_SET((struct vnet *) arg); 1446 1447 MFC_LOCK(); 1448 1449 for (i = 0; i < mfchashsize; i++) { 1450 struct mfc *rt, *nrt; 1451 1452 if (V_nexpire[i] == 0) 1453 continue; 1454 1455 LIST_FOREACH_SAFE(rt, &V_mfchashtbl[i], mfc_hash, nrt) { 1456 if (TAILQ_EMPTY(&rt->mfc_stall)) 1457 continue; 1458 1459 if (rt->mfc_expire == 0 || --rt->mfc_expire > 0) 1460 continue; 1461 1462 /* 1463 * free the bw_meter entries 1464 */ 1465 while (rt->mfc_bw_meter != NULL) { 1466 struct bw_meter *x = rt->mfc_bw_meter; 1467 1468 rt->mfc_bw_meter = x->bm_mfc_next; 1469 free(x, M_BWMETER); 1470 } 1471 1472 MRTSTAT_INC(mrts_cache_cleanups); 1473 CTR3(KTR_IPMF, "%s: expire (%lx, %lx)", __func__, 1474 (u_long)ntohl(rt->mfc_origin.s_addr), 1475 (u_long)ntohl(rt->mfc_mcastgrp.s_addr)); 1476 1477 expire_mfc(rt); 1478 } 1479 } 1480 1481 MFC_UNLOCK(); 1482 1483 callout_reset(&V_expire_upcalls_ch, EXPIRE_TIMEOUT, expire_upcalls, 1484 curvnet); 1485 1486 CURVNET_RESTORE(); 1487 } 1488 1489 /* 1490 * Packet forwarding routine once entry in the cache is made 1491 */ 1492 static int 1493 ip_mdq(struct mbuf *m, struct ifnet *ifp, struct mfc *rt, vifi_t xmt_vif) 1494 { 1495 struct ip *ip = mtod(m, struct ip *); 1496 vifi_t vifi; 1497 int plen = ntohs(ip->ip_len); 1498 1499 VIF_LOCK_ASSERT(); 1500 1501 /* 1502 * If xmt_vif is not -1, send on only the requested vif. 1503 * 1504 * (since vifi_t is u_short, -1 becomes MAXUSHORT, which > numvifs.) 1505 */ 1506 if (xmt_vif < V_numvifs) { 1507 if (V_viftable[xmt_vif].v_flags & VIFF_REGISTER) 1508 pim_register_send(ip, V_viftable + xmt_vif, m, rt); 1509 else 1510 phyint_send(ip, V_viftable + xmt_vif, m); 1511 return 1; 1512 } 1513 1514 /* 1515 * Don't forward if it didn't arrive from the parent vif for its origin. 1516 */ 1517 vifi = rt->mfc_parent; 1518 if ((vifi >= V_numvifs) || (V_viftable[vifi].v_ifp != ifp)) { 1519 CTR4(KTR_IPMF, "%s: rx on wrong ifp %p (vifi %d, v_ifp %p)", 1520 __func__, ifp, (int)vifi, V_viftable[vifi].v_ifp); 1521 MRTSTAT_INC(mrts_wrong_if); 1522 ++rt->mfc_wrong_if; 1523 /* 1524 * If we are doing PIM assert processing, send a message 1525 * to the routing daemon. 1526 * 1527 * XXX: A PIM-SM router needs the WRONGVIF detection so it 1528 * can complete the SPT switch, regardless of the type 1529 * of the iif (broadcast media, GRE tunnel, etc). 1530 */ 1531 if (V_pim_assert_enabled && (vifi < V_numvifs) && 1532 V_viftable[vifi].v_ifp) { 1533 if (ifp == &V_multicast_register_if) 1534 PIMSTAT_INC(pims_rcv_registers_wrongiif); 1535 1536 /* Get vifi for the incoming packet */ 1537 for (vifi = 0; vifi < V_numvifs && V_viftable[vifi].v_ifp != ifp; 1538 vifi++) 1539 ; 1540 if (vifi >= V_numvifs) 1541 return 0; /* The iif is not found: ignore the packet. */ 1542 1543 if (rt->mfc_flags[vifi] & MRT_MFC_FLAGS_DISABLE_WRONGVIF) 1544 return 0; /* WRONGVIF disabled: ignore the packet */ 1545 1546 if (ratecheck(&rt->mfc_last_assert, &pim_assert_interval)) { 1547 struct sockaddr_in k_igmpsrc = { sizeof k_igmpsrc, AF_INET }; 1548 struct igmpmsg *im; 1549 int hlen = ip->ip_hl << 2; 1550 struct mbuf *mm = m_copym(m, 0, hlen, M_NOWAIT); 1551 1552 if (mm && (!M_WRITABLE(mm) || mm->m_len < hlen)) 1553 mm = m_pullup(mm, hlen); 1554 if (mm == NULL) 1555 return ENOBUFS; 1556 1557 im = mtod(mm, struct igmpmsg *); 1558 im->im_msgtype = IGMPMSG_WRONGVIF; 1559 im->im_mbz = 0; 1560 im->im_vif = vifi; 1561 1562 MRTSTAT_INC(mrts_upcalls); 1563 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); 1568 return ENOBUFS; 1569 } 1570 } 1571 } 1572 return 0; 1573 } 1574 1575 /* If I sourced this packet, it counts as output, else it was input. */ 1576 if (in_hosteq(ip->ip_src, V_viftable[vifi].v_lcl_addr)) { 1577 V_viftable[vifi].v_pkt_out++; 1578 V_viftable[vifi].v_bytes_out += plen; 1579 } else { 1580 V_viftable[vifi].v_pkt_in++; 1581 V_viftable[vifi].v_bytes_in += plen; 1582 } 1583 rt->mfc_pkt_cnt++; 1584 rt->mfc_byte_cnt += plen; 1585 1586 /* 1587 * For each vif, decide if a copy of the packet should be forwarded. 1588 * Forward if: 1589 * - the ttl exceeds the vif's threshold 1590 * - there are group members downstream on interface 1591 */ 1592 for (vifi = 0; vifi < V_numvifs; vifi++) 1593 if ((rt->mfc_ttls[vifi] > 0) && (ip->ip_ttl > rt->mfc_ttls[vifi])) { 1594 V_viftable[vifi].v_pkt_out++; 1595 V_viftable[vifi].v_bytes_out += plen; 1596 if (V_viftable[vifi].v_flags & VIFF_REGISTER) 1597 pim_register_send(ip, V_viftable + vifi, m, rt); 1598 else 1599 phyint_send(ip, V_viftable + vifi, m); 1600 } 1601 1602 /* 1603 * Perform upcall-related bw measuring. 1604 */ 1605 if (rt->mfc_bw_meter != NULL) { 1606 struct bw_meter *x; 1607 struct timeval now; 1608 1609 microtime(&now); 1610 MFC_LOCK_ASSERT(); 1611 for (x = rt->mfc_bw_meter; x != NULL; x = x->bm_mfc_next) 1612 bw_meter_receive_packet(x, plen, &now); 1613 } 1614 1615 return 0; 1616 } 1617 1618 /* 1619 * Check if a vif number is legal/ok. This is used by in_mcast.c. 1620 */ 1621 static int 1622 X_legal_vif_num(int vif) 1623 { 1624 int ret; 1625 1626 ret = 0; 1627 if (vif < 0) 1628 return (ret); 1629 1630 VIF_LOCK(); 1631 if (vif < V_numvifs) 1632 ret = 1; 1633 VIF_UNLOCK(); 1634 1635 return (ret); 1636 } 1637 1638 /* 1639 * Return the local address used by this vif 1640 */ 1641 static u_long 1642 X_ip_mcast_src(int vifi) 1643 { 1644 in_addr_t addr; 1645 1646 addr = INADDR_ANY; 1647 if (vifi < 0) 1648 return (addr); 1649 1650 VIF_LOCK(); 1651 if (vifi < V_numvifs) 1652 addr = V_viftable[vifi].v_lcl_addr.s_addr; 1653 VIF_UNLOCK(); 1654 1655 return (addr); 1656 } 1657 1658 static void 1659 phyint_send(struct ip *ip, struct vif *vifp, struct mbuf *m) 1660 { 1661 struct mbuf *mb_copy; 1662 int hlen = ip->ip_hl << 2; 1663 1664 VIF_LOCK_ASSERT(); 1665 1666 /* 1667 * Make a new reference to the packet; make sure that 1668 * the IP header is actually copied, not just referenced, 1669 * so that ip_output() only scribbles on the copy. 1670 */ 1671 mb_copy = m_copypacket(m, M_NOWAIT); 1672 if (mb_copy && (!M_WRITABLE(mb_copy) || mb_copy->m_len < hlen)) 1673 mb_copy = m_pullup(mb_copy, hlen); 1674 if (mb_copy == NULL) 1675 return; 1676 1677 send_packet(vifp, mb_copy); 1678 } 1679 1680 static void 1681 send_packet(struct vif *vifp, struct mbuf *m) 1682 { 1683 struct ip_moptions imo; 1684 int error __unused; 1685 1686 VIF_LOCK_ASSERT(); 1687 1688 imo.imo_multicast_ifp = vifp->v_ifp; 1689 imo.imo_multicast_ttl = mtod(m, struct ip *)->ip_ttl - 1; 1690 imo.imo_multicast_loop = !!in_mcast_loop; 1691 imo.imo_multicast_vif = -1; 1692 STAILQ_INIT(&imo.imo_head); 1693 1694 /* 1695 * Re-entrancy should not be a problem here, because 1696 * the packets that we send out and are looped back at us 1697 * should get rejected because they appear to come from 1698 * the loopback interface, thus preventing looping. 1699 */ 1700 error = ip_output(m, NULL, NULL, IP_FORWARDING, &imo, NULL); 1701 CTR3(KTR_IPMF, "%s: vif %td err %d", __func__, 1702 (ptrdiff_t)(vifp - V_viftable), error); 1703 } 1704 1705 /* 1706 * Stubs for old RSVP socket shim implementation. 1707 */ 1708 1709 static int 1710 X_ip_rsvp_vif(struct socket *so __unused, struct sockopt *sopt __unused) 1711 { 1712 1713 return (EOPNOTSUPP); 1714 } 1715 1716 static void 1717 X_ip_rsvp_force_done(struct socket *so __unused) 1718 { 1719 1720 } 1721 1722 static int 1723 X_rsvp_input(struct mbuf **mp, int *offp, int proto) 1724 { 1725 struct mbuf *m; 1726 1727 m = *mp; 1728 *mp = NULL; 1729 if (!V_rsvp_on) 1730 m_freem(m); 1731 return (IPPROTO_DONE); 1732 } 1733 1734 /* 1735 * Code for bandwidth monitors 1736 */ 1737 1738 /* 1739 * Define common interface for timeval-related methods 1740 */ 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)) 1744 1745 static uint32_t 1746 compute_bw_meter_flags(struct bw_upcall *req) 1747 { 1748 uint32_t flags = 0; 1749 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; 1758 1759 return flags; 1760 } 1761 1762 /* 1763 * Add a bw_meter entry 1764 */ 1765 static int 1766 add_bw_upcall(struct bw_upcall *req) 1767 { 1768 struct mfc *mfc; 1769 struct timeval delta = { BW_UPCALL_THRESHOLD_INTERVAL_MIN_SEC, 1770 BW_UPCALL_THRESHOLD_INTERVAL_MIN_USEC }; 1771 struct timeval now; 1772 struct bw_meter *x; 1773 uint32_t flags; 1774 1775 if (!(V_mrt_api_config & MRT_MFC_BW_UPCALL)) 1776 return EOPNOTSUPP; 1777 1778 /* Test if the flags are valid */ 1779 if (!(req->bu_flags & (BW_UPCALL_UNIT_PACKETS | BW_UPCALL_UNIT_BYTES))) 1780 return EINVAL; 1781 if (!(req->bu_flags & (BW_UPCALL_GEQ | BW_UPCALL_LEQ))) 1782 return EINVAL; 1783 if ((req->bu_flags & (BW_UPCALL_GEQ | BW_UPCALL_LEQ)) 1784 == (BW_UPCALL_GEQ | BW_UPCALL_LEQ)) 1785 return EINVAL; 1786 1787 /* Test if the threshold time interval is valid */ 1788 if (BW_TIMEVALCMP(&req->bu_threshold.b_time, &delta, <)) 1789 return EINVAL; 1790 1791 flags = compute_bw_meter_flags(req); 1792 1793 /* 1794 * Find if we have already same bw_meter entry 1795 */ 1796 MFC_LOCK(); 1797 mfc = mfc_find(&req->bu_src, &req->bu_dst); 1798 if (mfc == NULL) { 1799 MFC_UNLOCK(); 1800 return EADDRNOTAVAIL; 1801 } 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) { 1808 MFC_UNLOCK(); 1809 return 0; /* XXX Already installed */ 1810 } 1811 } 1812 1813 /* Allocate the new bw_meter entry */ 1814 x = (struct bw_meter *)malloc(sizeof(*x), M_BWMETER, M_NOWAIT); 1815 if (x == NULL) { 1816 MFC_UNLOCK(); 1817 return ENOBUFS; 1818 } 1819 1820 /* Set the new bw_meter entry */ 1821 x->bm_threshold.b_time = req->bu_threshold.b_time; 1822 microtime(&now); 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; 1831 1832 /* Add the new bw_meter entry to the front of entries for this MFC */ 1833 x->bm_mfc = mfc; 1834 x->bm_mfc_next = mfc->mfc_bw_meter; 1835 mfc->mfc_bw_meter = x; 1836 schedule_bw_meter(x, &now); 1837 MFC_UNLOCK(); 1838 1839 return 0; 1840 } 1841 1842 static void 1843 free_bw_list(struct bw_meter *list) 1844 { 1845 while (list != NULL) { 1846 struct bw_meter *x = list; 1847 1848 list = list->bm_mfc_next; 1849 unschedule_bw_meter(x); 1850 free(x, M_BWMETER); 1851 } 1852 } 1853 1854 /* 1855 * Delete one or multiple bw_meter entries 1856 */ 1857 static int 1858 del_bw_upcall(struct bw_upcall *req) 1859 { 1860 struct mfc *mfc; 1861 struct bw_meter *x; 1862 1863 if (!(V_mrt_api_config & MRT_MFC_BW_UPCALL)) 1864 return EOPNOTSUPP; 1865 1866 MFC_LOCK(); 1867 1868 /* Find the corresponding MFC entry */ 1869 mfc = mfc_find(&req->bu_src, &req->bu_dst); 1870 if (mfc == NULL) { 1871 MFC_UNLOCK(); 1872 return EADDRNOTAVAIL; 1873 } else if (req->bu_flags & BW_UPCALL_DELETE_ALL) { 1874 /* 1875 * Delete all bw_meter entries for this mfc 1876 */ 1877 struct bw_meter *list; 1878 1879 list = mfc->mfc_bw_meter; 1880 mfc->mfc_bw_meter = NULL; 1881 free_bw_list(list); 1882 MFC_UNLOCK(); 1883 return 0; 1884 } else { /* Delete a single bw_meter entry */ 1885 struct bw_meter *prev; 1886 uint32_t flags = 0; 1887 1888 flags = compute_bw_meter_flags(req); 1889 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) 1898 break; 1899 } 1900 if (x != NULL) { /* Delete entry from the list for this MFC */ 1901 if (prev != NULL) 1902 prev->bm_mfc_next = x->bm_mfc_next; /* remove from middle*/ 1903 else 1904 x->bm_mfc->mfc_bw_meter = x->bm_mfc_next;/* new head of list */ 1905 1906 unschedule_bw_meter(x); 1907 MFC_UNLOCK(); 1908 /* Free the bw_meter entry */ 1909 free(x, M_BWMETER); 1910 return 0; 1911 } else { 1912 MFC_UNLOCK(); 1913 return EINVAL; 1914 } 1915 } 1916 /* NOTREACHED */ 1917 } 1918 1919 /* 1920 * Perform bandwidth measurement processing that may result in an upcall 1921 */ 1922 static void 1923 bw_meter_receive_packet(struct bw_meter *x, int plen, struct timeval *nowp) 1924 { 1925 struct timeval delta; 1926 1927 MFC_LOCK_ASSERT(); 1928 1929 delta = *nowp; 1930 BW_TIMEVALDECR(&delta, &x->bm_start_time); 1931 1932 if (x->bm_flags & BW_METER_GEQ) { 1933 /* 1934 * Processing for ">=" type of bw_meter entry 1935 */ 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; 1942 } 1943 1944 /* Record that a packet is received */ 1945 x->bm_measured.b_packets++; 1946 x->bm_measured.b_bytes += plen; 1947 1948 /* 1949 * Test if we should deliver an upcall 1950 */ 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; 1959 } 1960 } 1961 } else if (x->bm_flags & BW_METER_LEQ) { 1962 /* 1963 * Processing for "<=" type of bw_meter entry 1964 */ 1965 if (BW_TIMEVALCMP(&delta, &x->bm_threshold.b_time, >)) { 1966 /* 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. 1970 */ 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); 1977 } 1978 /* Reschedule the bw_meter entry */ 1979 unschedule_bw_meter(x); 1980 schedule_bw_meter(x, nowp); 1981 } 1982 1983 /* Record that a packet is received */ 1984 x->bm_measured.b_packets++; 1985 x->bm_measured.b_bytes += plen; 1986 1987 /* 1988 * Test if we should restart the measuring interval 1989 */ 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 */ 1995 } else { 1996 /* Do restart the measuring interval */ 1997 /* 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. 2002 */ 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; 2007 } 2008 } 2009 } 2010 2011 /* 2012 * Prepare a bandwidth-related upcall 2013 */ 2014 static void 2015 bw_meter_prepare_upcall(struct bw_meter *x, struct timeval *nowp) 2016 { 2017 struct timeval delta; 2018 struct bw_upcall *u; 2019 2020 MFC_LOCK_ASSERT(); 2021 2022 /* 2023 * Compute the measured time interval 2024 */ 2025 delta = *nowp; 2026 BW_TIMEVALDECR(&delta, &x->bm_start_time); 2027 2028 /* 2029 * If there are too many pending upcalls, deliver them now 2030 */ 2031 if (V_bw_upcalls_n >= BW_UPCALLS_MAX) 2032 bw_upcalls_send(); 2033 2034 /* 2035 * Set the bw_upcall entry 2036 */ 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; 2046 u->bu_flags = 0; 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; 2055 } 2056 2057 /* 2058 * Send the pending bandwidth-related upcalls 2059 */ 2060 static void 2061 bw_upcalls_send(void) 2062 { 2063 struct mbuf *m; 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 */ 2067 0, /* unused2 */ 2068 IGMPMSG_BW_UPCALL,/* im_msgtype */ 2069 0, /* im_mbz */ 2070 0, /* im_vif */ 2071 0, /* unused3 */ 2072 { 0 }, /* im_src */ 2073 { 0 } }; /* im_dst */ 2074 2075 MFC_LOCK_ASSERT(); 2076 2077 if (V_bw_upcalls_n == 0) 2078 return; /* No pending upcalls */ 2079 2080 V_bw_upcalls_n = 0; 2081 2082 /* 2083 * Allocate a new mbuf, initialize it with the header and 2084 * the payload for the pending calls. 2085 */ 2086 m = m_gethdr(M_NOWAIT, MT_DATA); 2087 if (m == NULL) { 2088 log(LOG_WARNING, "bw_upcalls_send: cannot allocate mbuf\n"); 2089 return; 2090 } 2091 2092 m_copyback(m, 0, sizeof(struct igmpmsg), (caddr_t)&igmpmsg); 2093 m_copyback(m, sizeof(struct igmpmsg), len, (caddr_t)&V_bw_upcalls[0]); 2094 2095 /* 2096 * Send the upcalls 2097 * XXX do we need to set the address in k_igmpsrc ? 2098 */ 2099 MRTSTAT_INC(mrts_upcalls); 2100 if (socket_send(V_ip_mrouter, m, &k_igmpsrc) < 0) { 2101 log(LOG_WARNING, "bw_upcalls_send: ip_mrouter socket queue full\n"); 2102 MRTSTAT_INC(mrts_upq_sockfull); 2103 } 2104 } 2105 2106 /* 2107 * Compute the timeout hash value for the bw_meter entries 2108 */ 2109 #define BW_METER_TIMEHASH(bw_meter, hash) \ 2110 do { \ 2111 struct timeval next_timeval = (bw_meter)->bm_start_time; \ 2112 \ 2113 BW_TIMEVALADD(&next_timeval, &(bw_meter)->bm_threshold.b_time); \ 2114 (hash) = next_timeval.tv_sec; \ 2115 if (next_timeval.tv_usec) \ 2116 (hash)++; /* XXX: make sure we don't timeout early */ \ 2117 (hash) %= BW_METER_BUCKETS; \ 2118 } while (0) 2119 2120 /* 2121 * Schedule a timer to process periodically bw_meter entry of type "<=" 2122 * by linking the entry in the proper hash bucket. 2123 */ 2124 static void 2125 schedule_bw_meter(struct bw_meter *x, struct timeval *nowp) 2126 { 2127 int time_hash; 2128 2129 MFC_LOCK_ASSERT(); 2130 2131 if (!(x->bm_flags & BW_METER_LEQ)) 2132 return; /* XXX: we schedule timers only for "<=" entries */ 2133 2134 /* 2135 * Reset the bw_meter entry 2136 */ 2137 x->bm_start_time = *nowp; 2138 x->bm_measured.b_packets = 0; 2139 x->bm_measured.b_bytes = 0; 2140 x->bm_flags &= ~BW_METER_UPCALL_DELIVERED; 2141 2142 /* 2143 * Compute the timeout hash value and insert the entry 2144 */ 2145 BW_METER_TIMEHASH(x, time_hash); 2146 x->bm_time_next = V_bw_meter_timers[time_hash]; 2147 V_bw_meter_timers[time_hash] = x; 2148 x->bm_time_hash = time_hash; 2149 } 2150 2151 /* 2152 * Unschedule the periodic timer that processes bw_meter entry of type "<=" 2153 * by removing the entry from the proper hash bucket. 2154 */ 2155 static void 2156 unschedule_bw_meter(struct bw_meter *x) 2157 { 2158 int time_hash; 2159 struct bw_meter *prev, *tmp; 2160 2161 MFC_LOCK_ASSERT(); 2162 2163 if (!(x->bm_flags & BW_METER_LEQ)) 2164 return; /* XXX: we schedule timers only for "<=" entries */ 2165 2166 /* 2167 * Compute the timeout hash value and delete the entry 2168 */ 2169 time_hash = x->bm_time_hash; 2170 if (time_hash >= BW_METER_BUCKETS) 2171 return; /* Entry was not scheduled */ 2172 2173 for (prev = NULL, tmp = V_bw_meter_timers[time_hash]; 2174 tmp != NULL; prev = tmp, tmp = tmp->bm_time_next) 2175 if (tmp == x) 2176 break; 2177 2178 if (tmp == NULL) 2179 panic("unschedule_bw_meter: bw_meter entry not found"); 2180 2181 if (prev != NULL) 2182 prev->bm_time_next = x->bm_time_next; 2183 else 2184 V_bw_meter_timers[time_hash] = x->bm_time_next; 2185 2186 x->bm_time_next = NULL; 2187 x->bm_time_hash = BW_METER_BUCKETS; 2188 } 2189 2190 /* 2191 * Process all "<=" type of bw_meter that should be processed now, 2192 * and for each entry prepare an upcall if necessary. Each processed 2193 * entry is rescheduled again for the (periodic) processing. 2194 * 2195 * This is run periodically (once per second normally). On each round, 2196 * all the potentially matching entries are in the hash slot that we are 2197 * looking at. 2198 */ 2199 static void 2200 bw_meter_process() 2201 { 2202 uint32_t loops; 2203 int i; 2204 struct timeval now, process_endtime; 2205 2206 microtime(&now); 2207 if (V_last_tv_sec == now.tv_sec) 2208 return; /* nothing to do */ 2209 2210 loops = now.tv_sec - V_last_tv_sec; 2211 V_last_tv_sec = now.tv_sec; 2212 if (loops > BW_METER_BUCKETS) 2213 loops = BW_METER_BUCKETS; 2214 2215 MFC_LOCK(); 2216 /* 2217 * Process all bins of bw_meter entries from the one after the last 2218 * processed to the current one. On entry, i points to the last bucket 2219 * visited, so we need to increment i at the beginning of the loop. 2220 */ 2221 for (i = (now.tv_sec - loops) % BW_METER_BUCKETS; loops > 0; loops--) { 2222 struct bw_meter *x, *tmp_list; 2223 2224 if (++i >= BW_METER_BUCKETS) 2225 i = 0; 2226 2227 /* Disconnect the list of bw_meter entries from the bin */ 2228 tmp_list = V_bw_meter_timers[i]; 2229 V_bw_meter_timers[i] = NULL; 2230 2231 /* Process the list of bw_meter entries */ 2232 while (tmp_list != NULL) { 2233 x = tmp_list; 2234 tmp_list = tmp_list->bm_time_next; 2235 2236 /* Test if the time interval is over */ 2237 process_endtime = x->bm_start_time; 2238 BW_TIMEVALADD(&process_endtime, &x->bm_threshold.b_time); 2239 if (BW_TIMEVALCMP(&process_endtime, &now, >)) { 2240 /* Not yet: reschedule, but don't reset */ 2241 int time_hash; 2242 2243 BW_METER_TIMEHASH(x, time_hash); 2244 if (time_hash == i && process_endtime.tv_sec == now.tv_sec) { 2245 /* 2246 * XXX: somehow the bin processing is a bit ahead of time. 2247 * Put the entry in the next bin. 2248 */ 2249 if (++time_hash >= BW_METER_BUCKETS) 2250 time_hash = 0; 2251 } 2252 x->bm_time_next = V_bw_meter_timers[time_hash]; 2253 V_bw_meter_timers[time_hash] = x; 2254 x->bm_time_hash = time_hash; 2255 2256 continue; 2257 } 2258 2259 /* 2260 * Test if we should deliver an upcall 2261 */ 2262 if (((x->bm_flags & BW_METER_UNIT_PACKETS) && 2263 (x->bm_measured.b_packets <= x->bm_threshold.b_packets)) || 2264 ((x->bm_flags & BW_METER_UNIT_BYTES) && 2265 (x->bm_measured.b_bytes <= x->bm_threshold.b_bytes))) { 2266 /* Prepare an upcall for delivery */ 2267 bw_meter_prepare_upcall(x, &now); 2268 } 2269 2270 /* 2271 * Reschedule for next processing 2272 */ 2273 schedule_bw_meter(x, &now); 2274 } 2275 } 2276 2277 /* Send all upcalls that are pending delivery */ 2278 bw_upcalls_send(); 2279 2280 MFC_UNLOCK(); 2281 } 2282 2283 /* 2284 * A periodic function for sending all upcalls that are pending delivery 2285 */ 2286 static void 2287 expire_bw_upcalls_send(void *arg) 2288 { 2289 CURVNET_SET((struct vnet *) arg); 2290 2291 MFC_LOCK(); 2292 bw_upcalls_send(); 2293 MFC_UNLOCK(); 2294 2295 callout_reset(&V_bw_upcalls_ch, BW_UPCALLS_PERIOD, expire_bw_upcalls_send, 2296 curvnet); 2297 CURVNET_RESTORE(); 2298 } 2299 2300 /* 2301 * A periodic function for periodic scanning of the multicast forwarding 2302 * table for processing all "<=" bw_meter entries. 2303 */ 2304 static void 2305 expire_bw_meter_process(void *arg) 2306 { 2307 CURVNET_SET((struct vnet *) arg); 2308 2309 if (V_mrt_api_config & MRT_MFC_BW_UPCALL) 2310 bw_meter_process(); 2311 2312 callout_reset(&V_bw_meter_ch, BW_METER_PERIOD, expire_bw_meter_process, 2313 curvnet); 2314 CURVNET_RESTORE(); 2315 } 2316 2317 /* 2318 * End of bandwidth monitoring code 2319 */ 2320 2321 /* 2322 * Send the packet up to the user daemon, or eventually do kernel encapsulation 2323 * 2324 */ 2325 static int 2326 pim_register_send(struct ip *ip, struct vif *vifp, struct mbuf *m, 2327 struct mfc *rt) 2328 { 2329 struct mbuf *mb_copy, *mm; 2330 2331 /* 2332 * Do not send IGMP_WHOLEPKT notifications to userland, if the 2333 * rendezvous point was unspecified, and we were told not to. 2334 */ 2335 if (pim_squelch_wholepkt != 0 && (V_mrt_api_config & MRT_MFC_RP) && 2336 in_nullhost(rt->mfc_rp)) 2337 return 0; 2338 2339 mb_copy = pim_register_prepare(ip, m); 2340 if (mb_copy == NULL) 2341 return ENOBUFS; 2342 2343 /* 2344 * Send all the fragments. Note that the mbuf for each fragment 2345 * is freed by the sending machinery. 2346 */ 2347 for (mm = mb_copy; mm; mm = mb_copy) { 2348 mb_copy = mm->m_nextpkt; 2349 mm->m_nextpkt = 0; 2350 mm = m_pullup(mm, sizeof(struct ip)); 2351 if (mm != NULL) { 2352 ip = mtod(mm, struct ip *); 2353 if ((V_mrt_api_config & MRT_MFC_RP) && !in_nullhost(rt->mfc_rp)) { 2354 pim_register_send_rp(ip, vifp, mm, rt); 2355 } else { 2356 pim_register_send_upcall(ip, vifp, mm, rt); 2357 } 2358 } 2359 } 2360 2361 return 0; 2362 } 2363 2364 /* 2365 * Return a copy of the data packet that is ready for PIM Register 2366 * encapsulation. 2367 * XXX: Note that in the returned copy the IP header is a valid one. 2368 */ 2369 static struct mbuf * 2370 pim_register_prepare(struct ip *ip, struct mbuf *m) 2371 { 2372 struct mbuf *mb_copy = NULL; 2373 int mtu; 2374 2375 /* Take care of delayed checksums */ 2376 if (m->m_pkthdr.csum_flags & CSUM_DELAY_DATA) { 2377 in_delayed_cksum(m); 2378 m->m_pkthdr.csum_flags &= ~CSUM_DELAY_DATA; 2379 } 2380 2381 /* 2382 * Copy the old packet & pullup its IP header into the 2383 * new mbuf so we can modify it. 2384 */ 2385 mb_copy = m_copypacket(m, M_NOWAIT); 2386 if (mb_copy == NULL) 2387 return NULL; 2388 mb_copy = m_pullup(mb_copy, ip->ip_hl << 2); 2389 if (mb_copy == NULL) 2390 return NULL; 2391 2392 /* take care of the TTL */ 2393 ip = mtod(mb_copy, struct ip *); 2394 --ip->ip_ttl; 2395 2396 /* Compute the MTU after the PIM Register encapsulation */ 2397 mtu = 0xffff - sizeof(pim_encap_iphdr) - sizeof(pim_encap_pimhdr); 2398 2399 if (ntohs(ip->ip_len) <= mtu) { 2400 /* Turn the IP header into a valid one */ 2401 ip->ip_sum = 0; 2402 ip->ip_sum = in_cksum(mb_copy, ip->ip_hl << 2); 2403 } else { 2404 /* Fragment the packet */ 2405 mb_copy->m_pkthdr.csum_flags |= CSUM_IP; 2406 if (ip_fragment(ip, &mb_copy, mtu, 0) != 0) { 2407 m_freem(mb_copy); 2408 return NULL; 2409 } 2410 } 2411 return mb_copy; 2412 } 2413 2414 /* 2415 * Send an upcall with the data packet to the user-level process. 2416 */ 2417 static int 2418 pim_register_send_upcall(struct ip *ip, struct vif *vifp, 2419 struct mbuf *mb_copy, struct mfc *rt) 2420 { 2421 struct mbuf *mb_first; 2422 int len = ntohs(ip->ip_len); 2423 struct igmpmsg *im; 2424 struct sockaddr_in k_igmpsrc = { sizeof k_igmpsrc, AF_INET }; 2425 2426 VIF_LOCK_ASSERT(); 2427 2428 /* 2429 * Add a new mbuf with an upcall header 2430 */ 2431 mb_first = m_gethdr(M_NOWAIT, MT_DATA); 2432 if (mb_first == NULL) { 2433 m_freem(mb_copy); 2434 return ENOBUFS; 2435 } 2436 mb_first->m_data += max_linkhdr; 2437 mb_first->m_pkthdr.len = len + sizeof(struct igmpmsg); 2438 mb_first->m_len = sizeof(struct igmpmsg); 2439 mb_first->m_next = mb_copy; 2440 2441 /* Send message to routing daemon */ 2442 im = mtod(mb_first, struct igmpmsg *); 2443 im->im_msgtype = IGMPMSG_WHOLEPKT; 2444 im->im_mbz = 0; 2445 im->im_vif = vifp - V_viftable; 2446 im->im_src = ip->ip_src; 2447 im->im_dst = ip->ip_dst; 2448 2449 k_igmpsrc.sin_addr = ip->ip_src; 2450 2451 MRTSTAT_INC(mrts_upcalls); 2452 2453 if (socket_send(V_ip_mrouter, mb_first, &k_igmpsrc) < 0) { 2454 CTR1(KTR_IPMF, "%s: socket queue full", __func__); 2455 MRTSTAT_INC(mrts_upq_sockfull); 2456 return ENOBUFS; 2457 } 2458 2459 /* Keep statistics */ 2460 PIMSTAT_INC(pims_snd_registers_msgs); 2461 PIMSTAT_ADD(pims_snd_registers_bytes, len); 2462 2463 return 0; 2464 } 2465 2466 /* 2467 * Encapsulate the data packet in PIM Register message and send it to the RP. 2468 */ 2469 static int 2470 pim_register_send_rp(struct ip *ip, struct vif *vifp, struct mbuf *mb_copy, 2471 struct mfc *rt) 2472 { 2473 struct mbuf *mb_first; 2474 struct ip *ip_outer; 2475 struct pim_encap_pimhdr *pimhdr; 2476 int len = ntohs(ip->ip_len); 2477 vifi_t vifi = rt->mfc_parent; 2478 2479 VIF_LOCK_ASSERT(); 2480 2481 if ((vifi >= V_numvifs) || in_nullhost(V_viftable[vifi].v_lcl_addr)) { 2482 m_freem(mb_copy); 2483 return EADDRNOTAVAIL; /* The iif vif is invalid */ 2484 } 2485 2486 /* 2487 * Add a new mbuf with the encapsulating header 2488 */ 2489 mb_first = m_gethdr(M_NOWAIT, MT_DATA); 2490 if (mb_first == NULL) { 2491 m_freem(mb_copy); 2492 return ENOBUFS; 2493 } 2494 mb_first->m_data += max_linkhdr; 2495 mb_first->m_len = sizeof(pim_encap_iphdr) + sizeof(pim_encap_pimhdr); 2496 mb_first->m_next = mb_copy; 2497 2498 mb_first->m_pkthdr.len = len + mb_first->m_len; 2499 2500 /* 2501 * Fill in the encapsulating IP and PIM header 2502 */ 2503 ip_outer = mtod(mb_first, struct ip *); 2504 *ip_outer = pim_encap_iphdr; 2505 ip_outer->ip_len = htons(len + sizeof(pim_encap_iphdr) + 2506 sizeof(pim_encap_pimhdr)); 2507 ip_outer->ip_src = V_viftable[vifi].v_lcl_addr; 2508 ip_outer->ip_dst = rt->mfc_rp; 2509 /* 2510 * Copy the inner header TOS to the outer header, and take care of the 2511 * IP_DF bit. 2512 */ 2513 ip_outer->ip_tos = ip->ip_tos; 2514 if (ip->ip_off & htons(IP_DF)) 2515 ip_outer->ip_off |= htons(IP_DF); 2516 ip_fillid(ip_outer); 2517 pimhdr = (struct pim_encap_pimhdr *)((caddr_t)ip_outer 2518 + sizeof(pim_encap_iphdr)); 2519 *pimhdr = pim_encap_pimhdr; 2520 /* If the iif crosses a border, set the Border-bit */ 2521 if (rt->mfc_flags[vifi] & MRT_MFC_FLAGS_BORDER_VIF & V_mrt_api_config) 2522 pimhdr->flags |= htonl(PIM_BORDER_REGISTER); 2523 2524 mb_first->m_data += sizeof(pim_encap_iphdr); 2525 pimhdr->pim.pim_cksum = in_cksum(mb_first, sizeof(pim_encap_pimhdr)); 2526 mb_first->m_data -= sizeof(pim_encap_iphdr); 2527 2528 send_packet(vifp, mb_first); 2529 2530 /* Keep statistics */ 2531 PIMSTAT_INC(pims_snd_registers_msgs); 2532 PIMSTAT_ADD(pims_snd_registers_bytes, len); 2533 2534 return 0; 2535 } 2536 2537 /* 2538 * pim_encapcheck() is called by the encap4_input() path at runtime to 2539 * determine if a packet is for PIM; allowing PIM to be dynamically loaded 2540 * into the kernel. 2541 */ 2542 static int 2543 pim_encapcheck(const struct mbuf *m __unused, int off __unused, 2544 int proto __unused, void *arg __unused) 2545 { 2546 2547 KASSERT(proto == IPPROTO_PIM, ("not for IPPROTO_PIM")); 2548 return (8); /* claim the datagram. */ 2549 } 2550 2551 /* 2552 * PIM-SMv2 and PIM-DM messages processing. 2553 * Receives and verifies the PIM control messages, and passes them 2554 * up to the listening socket, using rip_input(). 2555 * The only message with special processing is the PIM_REGISTER message 2556 * (used by PIM-SM): the PIM header is stripped off, and the inner packet 2557 * is passed to if_simloop(). 2558 */ 2559 static int 2560 pim_input(struct mbuf *m, int off, int proto, void *arg __unused) 2561 { 2562 struct ip *ip = mtod(m, struct ip *); 2563 struct pim *pim; 2564 int iphlen = off; 2565 int minlen; 2566 int datalen = ntohs(ip->ip_len) - iphlen; 2567 int ip_tos; 2568 2569 /* Keep statistics */ 2570 PIMSTAT_INC(pims_rcv_total_msgs); 2571 PIMSTAT_ADD(pims_rcv_total_bytes, datalen); 2572 2573 /* 2574 * Validate lengths 2575 */ 2576 if (datalen < PIM_MINLEN) { 2577 PIMSTAT_INC(pims_rcv_tooshort); 2578 CTR3(KTR_IPMF, "%s: short packet (%d) from 0x%08x", 2579 __func__, datalen, ntohl(ip->ip_src.s_addr)); 2580 m_freem(m); 2581 return (IPPROTO_DONE); 2582 } 2583 2584 /* 2585 * If the packet is at least as big as a REGISTER, go agead 2586 * and grab the PIM REGISTER header size, to avoid another 2587 * possible m_pullup() later. 2588 * 2589 * PIM_MINLEN == pimhdr + u_int32_t == 4 + 4 = 8 2590 * PIM_REG_MINLEN == pimhdr + reghdr + encap_iphdr == 4 + 4 + 20 = 28 2591 */ 2592 minlen = iphlen + (datalen >= PIM_REG_MINLEN ? PIM_REG_MINLEN : PIM_MINLEN); 2593 /* 2594 * Get the IP and PIM headers in contiguous memory, and 2595 * possibly the PIM REGISTER header. 2596 */ 2597 if (m->m_len < minlen && (m = m_pullup(m, minlen)) == NULL) { 2598 CTR1(KTR_IPMF, "%s: m_pullup() failed", __func__); 2599 return (IPPROTO_DONE); 2600 } 2601 2602 /* m_pullup() may have given us a new mbuf so reset ip. */ 2603 ip = mtod(m, struct ip *); 2604 ip_tos = ip->ip_tos; 2605 2606 /* adjust mbuf to point to the PIM header */ 2607 m->m_data += iphlen; 2608 m->m_len -= iphlen; 2609 pim = mtod(m, struct pim *); 2610 2611 /* 2612 * Validate checksum. If PIM REGISTER, exclude the data packet. 2613 * 2614 * XXX: some older PIMv2 implementations don't make this distinction, 2615 * so for compatibility reason perform the checksum over part of the 2616 * message, and if error, then over the whole message. 2617 */ 2618 if (PIM_VT_T(pim->pim_vt) == PIM_REGISTER && in_cksum(m, PIM_MINLEN) == 0) { 2619 /* do nothing, checksum okay */ 2620 } else if (in_cksum(m, datalen)) { 2621 PIMSTAT_INC(pims_rcv_badsum); 2622 CTR1(KTR_IPMF, "%s: invalid checksum", __func__); 2623 m_freem(m); 2624 return (IPPROTO_DONE); 2625 } 2626 2627 /* PIM version check */ 2628 if (PIM_VT_V(pim->pim_vt) < PIM_VERSION) { 2629 PIMSTAT_INC(pims_rcv_badversion); 2630 CTR3(KTR_IPMF, "%s: bad version %d expect %d", __func__, 2631 (int)PIM_VT_V(pim->pim_vt), PIM_VERSION); 2632 m_freem(m); 2633 return (IPPROTO_DONE); 2634 } 2635 2636 /* restore mbuf back to the outer IP */ 2637 m->m_data -= iphlen; 2638 m->m_len += iphlen; 2639 2640 if (PIM_VT_T(pim->pim_vt) == PIM_REGISTER) { 2641 /* 2642 * Since this is a REGISTER, we'll make a copy of the register 2643 * headers ip + pim + u_int32 + encap_ip, to be passed up to the 2644 * routing daemon. 2645 */ 2646 struct sockaddr_in dst = { sizeof(dst), AF_INET }; 2647 struct mbuf *mcp; 2648 struct ip *encap_ip; 2649 u_int32_t *reghdr; 2650 struct ifnet *vifp; 2651 2652 VIF_LOCK(); 2653 if ((V_reg_vif_num >= V_numvifs) || (V_reg_vif_num == VIFI_INVALID)) { 2654 VIF_UNLOCK(); 2655 CTR2(KTR_IPMF, "%s: register vif not set: %d", __func__, 2656 (int)V_reg_vif_num); 2657 m_freem(m); 2658 return (IPPROTO_DONE); 2659 } 2660 /* XXX need refcnt? */ 2661 vifp = V_viftable[V_reg_vif_num].v_ifp; 2662 VIF_UNLOCK(); 2663 2664 /* 2665 * Validate length 2666 */ 2667 if (datalen < PIM_REG_MINLEN) { 2668 PIMSTAT_INC(pims_rcv_tooshort); 2669 PIMSTAT_INC(pims_rcv_badregisters); 2670 CTR1(KTR_IPMF, "%s: register packet size too small", __func__); 2671 m_freem(m); 2672 return (IPPROTO_DONE); 2673 } 2674 2675 reghdr = (u_int32_t *)(pim + 1); 2676 encap_ip = (struct ip *)(reghdr + 1); 2677 2678 CTR3(KTR_IPMF, "%s: register: encap ip src 0x%08x len %d", 2679 __func__, ntohl(encap_ip->ip_src.s_addr), 2680 ntohs(encap_ip->ip_len)); 2681 2682 /* verify the version number of the inner packet */ 2683 if (encap_ip->ip_v != IPVERSION) { 2684 PIMSTAT_INC(pims_rcv_badregisters); 2685 CTR1(KTR_IPMF, "%s: bad encap ip version", __func__); 2686 m_freem(m); 2687 return (IPPROTO_DONE); 2688 } 2689 2690 /* verify the inner packet is destined to a mcast group */ 2691 if (!IN_MULTICAST(ntohl(encap_ip->ip_dst.s_addr))) { 2692 PIMSTAT_INC(pims_rcv_badregisters); 2693 CTR2(KTR_IPMF, "%s: bad encap ip dest 0x%08x", __func__, 2694 ntohl(encap_ip->ip_dst.s_addr)); 2695 m_freem(m); 2696 return (IPPROTO_DONE); 2697 } 2698 2699 /* If a NULL_REGISTER, pass it to the daemon */ 2700 if ((ntohl(*reghdr) & PIM_NULL_REGISTER)) 2701 goto pim_input_to_daemon; 2702 2703 /* 2704 * Copy the TOS from the outer IP header to the inner IP header. 2705 */ 2706 if (encap_ip->ip_tos != ip_tos) { 2707 /* Outer TOS -> inner TOS */ 2708 encap_ip->ip_tos = ip_tos; 2709 /* Recompute the inner header checksum. Sigh... */ 2710 2711 /* adjust mbuf to point to the inner IP header */ 2712 m->m_data += (iphlen + PIM_MINLEN); 2713 m->m_len -= (iphlen + PIM_MINLEN); 2714 2715 encap_ip->ip_sum = 0; 2716 encap_ip->ip_sum = in_cksum(m, encap_ip->ip_hl << 2); 2717 2718 /* restore mbuf to point back to the outer IP header */ 2719 m->m_data -= (iphlen + PIM_MINLEN); 2720 m->m_len += (iphlen + PIM_MINLEN); 2721 } 2722 2723 /* 2724 * Decapsulate the inner IP packet and loopback to forward it 2725 * as a normal multicast packet. Also, make a copy of the 2726 * outer_iphdr + pimhdr + reghdr + encap_iphdr 2727 * to pass to the daemon later, so it can take the appropriate 2728 * actions (e.g., send back PIM_REGISTER_STOP). 2729 * XXX: here m->m_data points to the outer IP header. 2730 */ 2731 mcp = m_copym(m, 0, iphlen + PIM_REG_MINLEN, M_NOWAIT); 2732 if (mcp == NULL) { 2733 CTR1(KTR_IPMF, "%s: m_copym() failed", __func__); 2734 m_freem(m); 2735 return (IPPROTO_DONE); 2736 } 2737 2738 /* Keep statistics */ 2739 /* XXX: registers_bytes include only the encap. mcast pkt */ 2740 PIMSTAT_INC(pims_rcv_registers_msgs); 2741 PIMSTAT_ADD(pims_rcv_registers_bytes, ntohs(encap_ip->ip_len)); 2742 2743 /* 2744 * forward the inner ip packet; point m_data at the inner ip. 2745 */ 2746 m_adj(m, iphlen + PIM_MINLEN); 2747 2748 CTR4(KTR_IPMF, 2749 "%s: forward decap'd REGISTER: src %lx dst %lx vif %d", 2750 __func__, 2751 (u_long)ntohl(encap_ip->ip_src.s_addr), 2752 (u_long)ntohl(encap_ip->ip_dst.s_addr), 2753 (int)V_reg_vif_num); 2754 2755 /* NB: vifp was collected above; can it change on us? */ 2756 if_simloop(vifp, m, dst.sin_family, 0); 2757 2758 /* prepare the register head to send to the mrouting daemon */ 2759 m = mcp; 2760 } 2761 2762 pim_input_to_daemon: 2763 /* 2764 * Pass the PIM message up to the daemon; if it is a Register message, 2765 * pass the 'head' only up to the daemon. This includes the 2766 * outer IP header, PIM header, PIM-Register header and the 2767 * inner IP header. 2768 * XXX: the outer IP header pkt size of a Register is not adjust to 2769 * reflect the fact that the inner multicast data is truncated. 2770 */ 2771 return (rip_input(&m, &off, proto)); 2772 } 2773 2774 static int 2775 sysctl_mfctable(SYSCTL_HANDLER_ARGS) 2776 { 2777 struct mfc *rt; 2778 int error, i; 2779 2780 if (req->newptr) 2781 return (EPERM); 2782 if (V_mfchashtbl == NULL) /* XXX unlocked */ 2783 return (0); 2784 error = sysctl_wire_old_buffer(req, 0); 2785 if (error) 2786 return (error); 2787 2788 MFC_LOCK(); 2789 for (i = 0; i < mfchashsize; i++) { 2790 LIST_FOREACH(rt, &V_mfchashtbl[i], mfc_hash) { 2791 error = SYSCTL_OUT(req, rt, sizeof(struct mfc)); 2792 if (error) 2793 goto out_locked; 2794 } 2795 } 2796 out_locked: 2797 MFC_UNLOCK(); 2798 return (error); 2799 } 2800 2801 static SYSCTL_NODE(_net_inet_ip, OID_AUTO, mfctable, 2802 CTLFLAG_RD | CTLFLAG_MPSAFE, sysctl_mfctable, 2803 "IPv4 Multicast Forwarding Table " 2804 "(struct *mfc[mfchashsize], netinet/ip_mroute.h)"); 2805 2806 static int 2807 sysctl_viflist(SYSCTL_HANDLER_ARGS) 2808 { 2809 int error; 2810 2811 if (req->newptr) 2812 return (EPERM); 2813 if (V_viftable == NULL) /* XXX unlocked */ 2814 return (0); 2815 error = sysctl_wire_old_buffer(req, sizeof(*V_viftable) * MAXVIFS); 2816 if (error) 2817 return (error); 2818 2819 VIF_LOCK(); 2820 error = SYSCTL_OUT(req, V_viftable, sizeof(*V_viftable) * MAXVIFS); 2821 VIF_UNLOCK(); 2822 return (error); 2823 } 2824 2825 SYSCTL_PROC(_net_inet_ip, OID_AUTO, viftable, 2826 CTLTYPE_OPAQUE | CTLFLAG_VNET | CTLFLAG_RD | CTLFLAG_MPSAFE, NULL, 0, 2827 sysctl_viflist, "S,vif[MAXVIFS]", 2828 "IPv4 Multicast Interfaces (struct vif[MAXVIFS], netinet/ip_mroute.h)"); 2829 2830 static void 2831 vnet_mroute_init(const void *unused __unused) 2832 { 2833 2834 V_nexpire = malloc(mfchashsize, M_MRTABLE, M_WAITOK|M_ZERO); 2835 2836 V_viftable = mallocarray(MAXVIFS, sizeof(*V_viftable), 2837 M_MRTABLE, M_WAITOK|M_ZERO); 2838 V_bw_meter_timers = mallocarray(BW_METER_BUCKETS, 2839 sizeof(*V_bw_meter_timers), M_MRTABLE, M_WAITOK|M_ZERO); 2840 V_bw_upcalls = mallocarray(BW_UPCALLS_MAX, sizeof(*V_bw_upcalls), 2841 M_MRTABLE, M_WAITOK|M_ZERO); 2842 2843 callout_init(&V_expire_upcalls_ch, 1); 2844 callout_init(&V_bw_upcalls_ch, 1); 2845 callout_init(&V_bw_meter_ch, 1); 2846 } 2847 2848 VNET_SYSINIT(vnet_mroute_init, SI_SUB_PROTO_MC, SI_ORDER_ANY, vnet_mroute_init, 2849 NULL); 2850 2851 static void 2852 vnet_mroute_uninit(const void *unused __unused) 2853 { 2854 2855 free(V_bw_upcalls, M_MRTABLE); 2856 free(V_bw_meter_timers, M_MRTABLE); 2857 free(V_viftable, M_MRTABLE); 2858 free(V_nexpire, M_MRTABLE); 2859 V_nexpire = NULL; 2860 } 2861 2862 VNET_SYSUNINIT(vnet_mroute_uninit, SI_SUB_PROTO_MC, SI_ORDER_MIDDLE, 2863 vnet_mroute_uninit, NULL); 2864 2865 static int 2866 ip_mroute_modevent(module_t mod, int type, void *unused) 2867 { 2868 2869 switch (type) { 2870 case MOD_LOAD: 2871 MROUTER_LOCK_INIT(); 2872 2873 if_detach_event_tag = EVENTHANDLER_REGISTER(ifnet_departure_event, 2874 if_detached_event, NULL, EVENTHANDLER_PRI_ANY); 2875 if (if_detach_event_tag == NULL) { 2876 printf("ip_mroute: unable to register " 2877 "ifnet_departure_event handler\n"); 2878 MROUTER_LOCK_DESTROY(); 2879 return (EINVAL); 2880 } 2881 2882 MFC_LOCK_INIT(); 2883 VIF_LOCK_INIT(); 2884 2885 mfchashsize = MFCHASHSIZE; 2886 if (TUNABLE_ULONG_FETCH("net.inet.ip.mfchashsize", &mfchashsize) && 2887 !powerof2(mfchashsize)) { 2888 printf("WARNING: %s not a power of 2; using default\n", 2889 "net.inet.ip.mfchashsize"); 2890 mfchashsize = MFCHASHSIZE; 2891 } 2892 2893 pim_squelch_wholepkt = 0; 2894 TUNABLE_ULONG_FETCH("net.inet.pim.squelch_wholepkt", 2895 &pim_squelch_wholepkt); 2896 2897 pim_encap_cookie = ip_encap_attach(&ipv4_encap_cfg, NULL, M_WAITOK); 2898 if (pim_encap_cookie == NULL) { 2899 printf("ip_mroute: unable to attach pim encap\n"); 2900 VIF_LOCK_DESTROY(); 2901 MFC_LOCK_DESTROY(); 2902 MROUTER_LOCK_DESTROY(); 2903 return (EINVAL); 2904 } 2905 2906 ip_mcast_src = X_ip_mcast_src; 2907 ip_mforward = X_ip_mforward; 2908 ip_mrouter_done = X_ip_mrouter_done; 2909 ip_mrouter_get = X_ip_mrouter_get; 2910 ip_mrouter_set = X_ip_mrouter_set; 2911 2912 ip_rsvp_force_done = X_ip_rsvp_force_done; 2913 ip_rsvp_vif = X_ip_rsvp_vif; 2914 2915 legal_vif_num = X_legal_vif_num; 2916 mrt_ioctl = X_mrt_ioctl; 2917 rsvp_input_p = X_rsvp_input; 2918 break; 2919 2920 case MOD_UNLOAD: 2921 /* 2922 * Typically module unload happens after the user-level 2923 * process has shutdown the kernel services (the check 2924 * below insures someone can't just yank the module out 2925 * from under a running process). But if the module is 2926 * just loaded and then unloaded w/o starting up a user 2927 * process we still need to cleanup. 2928 */ 2929 MROUTER_LOCK(); 2930 if (ip_mrouter_cnt != 0) { 2931 MROUTER_UNLOCK(); 2932 return (EINVAL); 2933 } 2934 ip_mrouter_unloading = 1; 2935 MROUTER_UNLOCK(); 2936 2937 EVENTHANDLER_DEREGISTER(ifnet_departure_event, if_detach_event_tag); 2938 2939 if (pim_encap_cookie) { 2940 ip_encap_detach(pim_encap_cookie); 2941 pim_encap_cookie = NULL; 2942 } 2943 2944 ip_mcast_src = NULL; 2945 ip_mforward = NULL; 2946 ip_mrouter_done = NULL; 2947 ip_mrouter_get = NULL; 2948 ip_mrouter_set = NULL; 2949 2950 ip_rsvp_force_done = NULL; 2951 ip_rsvp_vif = NULL; 2952 2953 legal_vif_num = NULL; 2954 mrt_ioctl = NULL; 2955 rsvp_input_p = NULL; 2956 2957 VIF_LOCK_DESTROY(); 2958 MFC_LOCK_DESTROY(); 2959 MROUTER_LOCK_DESTROY(); 2960 break; 2961 2962 default: 2963 return EOPNOTSUPP; 2964 } 2965 return 0; 2966 } 2967 2968 static moduledata_t ip_mroutemod = { 2969 "ip_mroute", 2970 ip_mroute_modevent, 2971 0 2972 }; 2973 2974 DECLARE_MODULE(ip_mroute, ip_mroutemod, SI_SUB_PROTO_MC, SI_ORDER_MIDDLE); 2975