1 /*- 2 * SPDX-License-Identifier: BSD-3-Clause 3 * 4 * Copyright (C) 1998 WIDE Project. 5 * All rights reserved. 6 * 7 * Redistribution and use in source and binary forms, with or without 8 * modification, are permitted provided that the following conditions 9 * are met: 10 * 1. Redistributions of source code must retain the above copyright 11 * notice, this list of conditions and the following disclaimer. 12 * 2. Redistributions in binary form must reproduce the above copyright 13 * notice, this list of conditions and the following disclaimer in the 14 * documentation and/or other materials provided with the distribution. 15 * 3. Neither the name of the project nor the names of its contributors 16 * may be used to endorse or promote products derived from this software 17 * without specific prior written permission. 18 * 19 * THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND 20 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 21 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 22 * ARE DISCLAIMED. IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE 23 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 24 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 25 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 26 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 27 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 28 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 29 * SUCH DAMAGE. 30 * 31 * $KAME: ip6_mroute.h,v 1.19 2001/06/14 06:12:55 suz Exp $ 32 */ 33 34 /* BSDI ip_mroute.h,v 2.5 1996/10/11 16:01:48 pjd Exp */ 35 36 /* 37 * Definitions for IP multicast forwarding. 38 * 39 * Written by David Waitzman, BBN Labs, August 1988. 40 * Modified by Steve Deering, Stanford, February 1989. 41 * Modified by Ajit Thyagarajan, PARC, August 1993. 42 * Modified by Ajit Thyagarajan, PARC, August 1994. 43 * Modified by Ahmed Helmy, USC, September 1996. 44 * 45 * MROUTING Revision: 1.2 46 */ 47 48 #ifndef _NETINET6_IP6_MROUTE_H_ 49 #define _NETINET6_IP6_MROUTE_H_ 50 51 #include <sys/_param.h> 52 #include <sys/types.h> 53 54 /* 55 * Multicast Routing set/getsockopt commands. 56 */ 57 #ifdef _KERNEL 58 #define MRT6_OINIT 100 /* initialize forwarder (omrt6msg) */ 59 #endif 60 #define MRT6_DONE 101 /* shut down forwarder */ 61 #define MRT6_ADD_MIF 102 /* add multicast interface */ 62 #define MRT6_DEL_MIF 103 /* delete multicast interface */ 63 #define MRT6_ADD_MFC 104 /* insert forwarding cache entry */ 64 #define MRT6_DEL_MFC 105 /* delete forwarding cache entry */ 65 #define MRT6_PIM 107 /* enable pim code */ 66 #define MRT6_INIT 108 /* initialize forwarder (mrt6msg) */ 67 68 #if BSD >= 199103 69 #define GET_TIME(t) microtime(&t) 70 #elif defined(sun) 71 #define GET_TIME(t) uniqtime(&t) 72 #else 73 #define GET_TIME(t) ((t) = time) 74 #endif 75 76 /* 77 * Types and macros for handling bitmaps with one bit per multicast interface. 78 */ 79 typedef u_short mifi_t; /* type of a mif index */ 80 #define MAXMIFS 64 81 82 #ifndef IF_SETSIZE 83 #define IF_SETSIZE 256 84 #endif 85 86 typedef u_int32_t if_mask; 87 #define NIFBITS (sizeof(if_mask) * NBBY) /* bits per mask */ 88 89 #ifndef howmany 90 #define howmany(x, y) (((x) + ((y) - 1)) / (y)) 91 #endif 92 93 typedef struct if_set { 94 if_mask ifs_bits[howmany(IF_SETSIZE, NIFBITS)]; 95 } if_set; 96 97 #define IF_SET(n, p) ((p)->ifs_bits[(n)/NIFBITS] |= (1 << ((n) % NIFBITS))) 98 #define IF_CLR(n, p) ((p)->ifs_bits[(n)/NIFBITS] &= ~(1 << ((n) % NIFBITS))) 99 #define IF_ISSET(n, p) ((p)->ifs_bits[(n)/NIFBITS] & (1 << ((n) % NIFBITS))) 100 #define IF_COPY(f, t) bcopy(f, t, sizeof(*(f))) 101 #define IF_ZERO(p) bzero(p, sizeof(*(p))) 102 103 /* 104 * Argument structure for MRT6_ADD_IF. 105 */ 106 struct mif6ctl { 107 mifi_t mif6c_mifi; /* the index of the mif to be added */ 108 u_char mif6c_flags; /* MIFF_ flags defined below */ 109 u_short mif6c_pifi; /* the index of the physical IF */ 110 }; 111 112 #define MIFF_REGISTER 0x1 /* mif represents a register end-point */ 113 114 /* 115 * Argument structure for MRT6_ADD_MFC and MRT6_DEL_MFC 116 */ 117 struct mf6cctl { 118 struct sockaddr_in6 mf6cc_origin; /* IPv6 origin of mcasts */ 119 struct sockaddr_in6 mf6cc_mcastgrp; /* multicast group associated */ 120 mifi_t mf6cc_parent; /* incoming ifindex */ 121 struct if_set mf6cc_ifset; /* set of forwarding ifs */ 122 }; 123 124 /* 125 * The kernel's multicast routing statistics. 126 */ 127 struct mrt6stat { 128 uint64_t mrt6s_mfc_lookups; /* # forw. cache hash table hits */ 129 uint64_t mrt6s_mfc_misses; /* # forw. cache hash table misses */ 130 uint64_t mrt6s_upcalls; /* # calls to multicast routing daemon */ 131 uint64_t mrt6s_no_route; /* no route for packet's origin */ 132 uint64_t mrt6s_bad_tunnel; /* malformed tunnel options */ 133 uint64_t mrt6s_cant_tunnel; /* no room for tunnel options */ 134 uint64_t mrt6s_wrong_if; /* arrived on wrong interface */ 135 uint64_t mrt6s_upq_ovflw; /* upcall Q overflow */ 136 uint64_t mrt6s_cache_cleanups; /* # entries with no upcalls */ 137 uint64_t mrt6s_drop_sel; /* pkts dropped selectively */ 138 uint64_t mrt6s_q_overflow; /* pkts dropped - Q overflow */ 139 uint64_t mrt6s_pkt2large; /* pkts dropped - size > BKT SIZE */ 140 uint64_t mrt6s_upq_sockfull; /* upcalls dropped - socket full */ 141 }; 142 143 #ifdef MRT6_OINIT 144 /* 145 * Struct used to communicate from kernel to multicast router 146 * note the convenient similarity to an IPv6 header. 147 * XXX old version, superseded by mrt6msg. 148 */ 149 struct omrt6msg { 150 u_long unused1; 151 u_char im6_msgtype; /* what type of message */ 152 u_char im6_mbz; /* must be zero */ 153 u_char im6_mif; /* mif rec'd on */ 154 u_char unused2; 155 struct in6_addr im6_src, im6_dst; 156 }; 157 #endif 158 159 /* 160 * Structure used to communicate from kernel to multicast router. 161 * We'll overlay the structure onto an MLD header (not an IPv6 header 162 * like igmpmsg{} used for IPv4 implementation). This is because this 163 * structure will be passed via an IPv6 raw socket, on which an application 164 * will only receive the payload i.e. the data after the IPv6 header and all 165 * the extension headers. (see Section 3 of RFC3542) 166 */ 167 struct mrt6msg { 168 #define MRT6MSG_NOCACHE 1 169 #define MRT6MSG_WRONGMIF 2 170 #define MRT6MSG_WHOLEPKT 3 /* used for user level encap*/ 171 u_char im6_mbz; /* must be zero */ 172 u_char im6_msgtype; /* what type of message */ 173 u_int16_t im6_mif; /* mif rec'd on */ 174 u_int32_t im6_pad; /* padding for 64bit arch */ 175 struct in6_addr im6_src, im6_dst; 176 }; 177 178 /* 179 * Argument structure used by multicast routing daemon to get src-grp 180 * packet counts 181 */ 182 struct sioc_sg_req6 { 183 struct sockaddr_in6 src; 184 struct sockaddr_in6 grp; 185 u_quad_t pktcnt; 186 u_quad_t bytecnt; 187 u_quad_t wrong_if; 188 }; 189 190 /* 191 * Argument structure used by mrouted to get mif pkt counts 192 */ 193 struct sioc_mif_req6 { 194 mifi_t mifi; /* mif number */ 195 u_quad_t icount; /* Input packet count on mif */ 196 u_quad_t ocount; /* Output packet count on mif */ 197 u_quad_t ibytes; /* Input byte count on mif */ 198 u_quad_t obytes; /* Output byte count on mif */ 199 }; 200 201 /* 202 * Structure to export 'struct mif6' to userland via sysctl. 203 */ 204 struct mif6_sctl { 205 u_char m6_flags; /* MIFF_ flags defined above */ 206 u_int m6_rate_limit; /* max rate */ 207 struct in6_addr m6_lcl_addr; /* local interface address */ 208 uint32_t m6_ifp; /* interface index */ 209 u_quad_t m6_pkt_in; /* # pkts in on interface */ 210 u_quad_t m6_pkt_out; /* # pkts out on interface */ 211 u_quad_t m6_bytes_in; /* # bytes in on interface */ 212 u_quad_t m6_bytes_out; /* # bytes out on interface */ 213 }; 214 215 #if defined(_KERNEL) || defined(KERNEL) 216 /* 217 * The kernel's multicast-interface structure. 218 */ 219 struct mif6 { 220 u_char m6_flags; /* MIFF_ flags defined above */ 221 u_int m6_rate_limit; /* max rate */ 222 struct in6_addr m6_lcl_addr; /* local interface address */ 223 struct ifnet *m6_ifp; /* pointer to interface */ 224 u_quad_t m6_pkt_in; /* # pkts in on interface */ 225 u_quad_t m6_pkt_out; /* # pkts out on interface */ 226 u_quad_t m6_bytes_in; /* # bytes in on interface */ 227 u_quad_t m6_bytes_out; /* # bytes out on interface */ 228 #ifdef notyet 229 u_int m6_rsvp_on; /* RSVP listening on this vif */ 230 struct socket *m6_rsvpd; /* RSVP daemon socket */ 231 #endif 232 }; 233 234 /* 235 * The kernel's multicast forwarding cache entry structure 236 */ 237 struct mf6c { 238 struct sockaddr_in6 mf6c_origin; /* IPv6 origin of mcasts */ 239 struct sockaddr_in6 mf6c_mcastgrp; /* multicast group associated*/ 240 mifi_t mf6c_parent; /* incoming IF */ 241 struct if_set mf6c_ifset; /* set of outgoing IFs */ 242 243 u_quad_t mf6c_pkt_cnt; /* pkt count for src-grp */ 244 u_quad_t mf6c_byte_cnt; /* byte count for src-grp */ 245 u_quad_t mf6c_wrong_if; /* wrong if for src-grp */ 246 int mf6c_expire; /* time to clean entry up */ 247 struct timeval mf6c_last_assert; /* last time I sent an assert*/ 248 struct rtdetq *mf6c_stall; /* pkts waiting for route */ 249 struct mf6c *mf6c_next; /* hash table linkage */ 250 }; 251 252 #define MF6C_INCOMPLETE_PARENT ((mifi_t)-1) 253 254 /* 255 * Argument structure used for pkt info. while upcall is made 256 */ 257 #ifndef _NETINET_IP_MROUTE_H_ 258 struct rtdetq { /* XXX: rtdetq is also defined in ip_mroute.h */ 259 struct mbuf *m; /* A copy of the packet */ 260 struct ifnet *ifp; /* Interface pkt came in on */ 261 #ifdef UPCALL_TIMING 262 struct timeval t; /* Timestamp */ 263 #endif /* UPCALL_TIMING */ 264 struct rtdetq *next; 265 }; 266 #endif /* _NETINET_IP_MROUTE_H_ */ 267 268 #define MF6CTBLSIZ 256 269 #if (MF6CTBLSIZ & (MF6CTBLSIZ - 1)) == 0 /* from sys:route.h */ 270 #define MF6CHASHMOD(h) ((h) & (MF6CTBLSIZ - 1)) 271 #else 272 #define MF6CHASHMOD(h) ((h) % MF6CTBLSIZ) 273 #endif 274 275 #define MAX_UPQ6 4 /* max. no of pkts in upcall Q */ 276 #endif /* _KERNEL || KERNEL */ 277 278 #ifdef _KERNEL 279 VNET_DECLARE(bool, ip6_mrouting_enabled); 280 #define V_ip6_mrouting_enabled VNET(ip6_mrouting_enabled) 281 282 struct ifnet; 283 struct ip6_hdr; 284 struct mbuf; 285 struct socket; 286 struct sockopt; 287 288 extern int (*ip6_mforward)(struct ip6_hdr *, struct ifnet *, 289 struct mbuf *); 290 extern int (*ip6_mrouter_set)(struct socket *so, struct sockopt *sopt); 291 extern int (*ip6_mrouter_get)(struct socket *so, struct sockopt *sopt); 292 extern void (*ip6_mrouter_done)(struct socket *so); 293 294 extern int (*mrt6_ioctl)(u_long, caddr_t, int); 295 #endif /* _KERNEL */ 296 297 #endif /* !_NETINET6_IP6_MROUTE_H_ */ 298