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