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