ip_mroute.h revision 92723
1/* 2 * Copyright (c) 1989 Stephen Deering. 3 * Copyright (c) 1992, 1993 4 * The Regents of the University of California. All rights reserved. 5 * 6 * This code is derived from software contributed to Berkeley by 7 * Stephen Deering of Stanford University. 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. All advertising materials mentioning features or use of this software 18 * must display the following acknowledgement: 19 * This product includes software developed by the University of 20 * California, Berkeley and its contributors. 21 * 4. Neither the name of the University nor the names of its contributors 22 * may be used to endorse or promote products derived from this software 23 * without specific prior written permission. 24 * 25 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 26 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 27 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 28 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 29 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 30 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 31 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 32 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 33 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 34 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 35 * SUCH DAMAGE. 36 * 37 * @(#)ip_mroute.h 8.1 (Berkeley) 6/10/93 38 * $FreeBSD: head/sys/netinet/ip_mroute.h 92723 2002-03-19 21:25:46Z alfred $ 39 */ 40 41#ifndef _NETINET_IP_MROUTE_H_ 42#define _NETINET_IP_MROUTE_H_ 43 44/* 45 * Definitions for IP multicast forwarding. 46 * 47 * Written by David Waitzman, BBN Labs, August 1988. 48 * Modified by Steve Deering, Stanford, February 1989. 49 * Modified by Ajit Thyagarajan, PARC, August 1993. 50 * Modified by Ajit Thyagarajan, PARC, August 1994. 51 * 52 * MROUTING Revision: 3.3.1.3 53 */ 54 55 56/* 57 * Multicast Routing set/getsockopt commands. 58 */ 59#define MRT_INIT 100 /* initialize forwarder */ 60#define MRT_DONE 101 /* shut down forwarder */ 61#define MRT_ADD_VIF 102 /* create virtual interface */ 62#define MRT_DEL_VIF 103 /* delete virtual interface */ 63#define MRT_ADD_MFC 104 /* insert forwarding cache entry */ 64#define MRT_DEL_MFC 105 /* delete forwarding cache entry */ 65#define MRT_VERSION 106 /* get kernel version number */ 66#define MRT_ASSERT 107 /* enable PIM assert processing */ 67 68 69#define GET_TIME(t) microtime(&t) 70 71/* 72 * Types and macros for handling bitmaps with one bit per virtual interface. 73 */ 74#define MAXVIFS 32 75typedef u_long vifbitmap_t; 76typedef u_short vifi_t; /* type of a vif index */ 77#define ALL_VIFS (vifi_t)-1 78 79#define VIFM_SET(n, m) ((m) |= (1 << (n))) 80#define VIFM_CLR(n, m) ((m) &= ~(1 << (n))) 81#define VIFM_ISSET(n, m) ((m) & (1 << (n))) 82#define VIFM_CLRALL(m) ((m) = 0x00000000) 83#define VIFM_COPY(mfrom, mto) ((mto) = (mfrom)) 84#define VIFM_SAME(m1, m2) ((m1) == (m2)) 85 86 87/* 88 * Argument structure for MRT_ADD_VIF. 89 * (MRT_DEL_VIF takes a single vifi_t argument.) 90 */ 91struct vifctl { 92 vifi_t vifc_vifi; /* the index of the vif to be added */ 93 u_char vifc_flags; /* VIFF_ flags defined below */ 94 u_char vifc_threshold; /* min ttl required to forward on vif */ 95 u_int vifc_rate_limit; /* max rate */ 96 struct in_addr vifc_lcl_addr; /* local interface address */ 97 struct in_addr vifc_rmt_addr; /* remote address (tunnels only) */ 98}; 99 100#define VIFF_TUNNEL 0x1 /* vif represents a tunnel end-point */ 101#define VIFF_SRCRT 0x2 /* tunnel uses IP source routing */ 102 103/* 104 * Argument structure for MRT_ADD_MFC and MRT_DEL_MFC 105 * (mfcc_tos to be added at a future point) 106 */ 107struct mfcctl { 108 struct in_addr mfcc_origin; /* ip origin of mcasts */ 109 struct in_addr mfcc_mcastgrp; /* multicast group associated*/ 110 vifi_t mfcc_parent; /* incoming vif */ 111 u_char mfcc_ttls[MAXVIFS]; /* forwarding ttls on vifs */ 112}; 113 114/* 115 * The kernel's multicast routing statistics. 116 */ 117struct mrtstat { 118 u_long mrts_mfc_lookups; /* # forw. cache hash table hits */ 119 u_long mrts_mfc_misses; /* # forw. cache hash table misses */ 120 u_long mrts_upcalls; /* # calls to mrouted */ 121 u_long mrts_no_route; /* no route for packet's origin */ 122 u_long mrts_bad_tunnel; /* malformed tunnel options */ 123 u_long mrts_cant_tunnel; /* no room for tunnel options */ 124 u_long mrts_wrong_if; /* arrived on wrong interface */ 125 u_long mrts_upq_ovflw; /* upcall Q overflow */ 126 u_long mrts_cache_cleanups; /* # entries with no upcalls */ 127 u_long mrts_drop_sel; /* pkts dropped selectively */ 128 u_long mrts_q_overflow; /* pkts dropped - Q overflow */ 129 u_long mrts_pkt2large; /* pkts dropped - size > BKT SIZE */ 130 u_long mrts_upq_sockfull; /* upcalls dropped - socket full */ 131}; 132 133/* 134 * Argument structure used by mrouted to get src-grp pkt counts 135 */ 136struct sioc_sg_req { 137 struct in_addr src; 138 struct in_addr grp; 139 u_long pktcnt; 140 u_long bytecnt; 141 u_long wrong_if; 142}; 143 144/* 145 * Argument structure used by mrouted to get vif pkt counts 146 */ 147struct sioc_vif_req { 148 vifi_t vifi; /* vif number */ 149 u_long icount; /* Input packet count on vif */ 150 u_long ocount; /* Output packet count on vif */ 151 u_long ibytes; /* Input byte count on vif */ 152 u_long obytes; /* Output byte count on vif */ 153}; 154 155 156/* 157 * The kernel's virtual-interface structure. 158 */ 159struct vif { 160 u_char v_flags; /* VIFF_ flags defined above */ 161 u_char v_threshold; /* min ttl required to forward on vif*/ 162 u_int v_rate_limit; /* max rate */ 163 struct tbf *v_tbf; /* token bucket structure at intf. */ 164 struct in_addr v_lcl_addr; /* local interface address */ 165 struct in_addr v_rmt_addr; /* remote address (tunnels only) */ 166 struct ifnet *v_ifp; /* pointer to interface */ 167 u_long v_pkt_in; /* # pkts in on interface */ 168 u_long v_pkt_out; /* # pkts out on interface */ 169 u_long v_bytes_in; /* # bytes in on interface */ 170 u_long v_bytes_out; /* # bytes out on interface */ 171 struct route v_route; /* cached route if this is a tunnel */ 172 u_int v_rsvp_on; /* RSVP listening on this vif */ 173 struct socket *v_rsvpd; /* RSVP daemon socket */ 174}; 175 176/* 177 * The kernel's multicast forwarding cache entry structure 178 * (A field for the type of service (mfc_tos) is to be added 179 * at a future point) 180 */ 181struct mfc { 182 struct in_addr mfc_origin; /* IP origin of mcasts */ 183 struct in_addr mfc_mcastgrp; /* multicast group associated*/ 184 vifi_t mfc_parent; /* incoming vif */ 185 u_char mfc_ttls[MAXVIFS]; /* forwarding ttls on vifs */ 186 u_long mfc_pkt_cnt; /* pkt count for src-grp */ 187 u_long mfc_byte_cnt; /* byte count for src-grp */ 188 u_long mfc_wrong_if; /* wrong if for src-grp */ 189 int mfc_expire; /* time to clean entry up */ 190 struct timeval mfc_last_assert; /* last time I sent an assert*/ 191 struct rtdetq *mfc_stall; /* q of packets awaiting mfc */ 192 struct mfc *mfc_next; /* next mfc entry */ 193}; 194 195/* 196 * Struct used to communicate from kernel to multicast router 197 * note the convenient similarity to an IP packet 198 */ 199struct igmpmsg { 200 u_long unused1; 201 u_long unused2; 202 u_char im_msgtype; /* what type of message */ 203#define IGMPMSG_NOCACHE 1 204#define IGMPMSG_WRONGVIF 2 205 u_char im_mbz; /* must be zero */ 206 u_char im_vif; /* vif rec'd on */ 207 u_char unused3; 208 struct in_addr im_src, im_dst; 209}; 210 211/* 212 * Argument structure used for pkt info. while upcall is made 213 */ 214struct rtdetq { 215 struct mbuf *m; /* A copy of the packet */ 216 struct ifnet *ifp; /* Interface pkt came in on */ 217 vifi_t xmt_vif; /* Saved copy of imo_multicast_vif */ 218#ifdef UPCALL_TIMING 219 struct timeval t; /* Timestamp */ 220#endif /* UPCALL_TIMING */ 221 struct rtdetq *next; /* Next in list of packets */ 222}; 223 224#define MFCTBLSIZ 256 225#if (MFCTBLSIZ & (MFCTBLSIZ - 1)) == 0 /* from sys:route.h */ 226#define MFCHASHMOD(h) ((h) & (MFCTBLSIZ - 1)) 227#else 228#define MFCHASHMOD(h) ((h) % MFCTBLSIZ) 229#endif 230 231#define MAX_UPQ 4 /* max. no of pkts in upcall Q */ 232 233/* 234 * Token Bucket filter code 235 */ 236#define MAX_BKT_SIZE 10000 /* 10K bytes size */ 237#define MAXQSIZE 10 /* max # of pkts in queue */ 238 239/* 240 * the token bucket filter at each vif 241 */ 242struct tbf 243{ 244 struct timeval tbf_last_pkt_t; /* arr. time of last pkt */ 245 u_long tbf_n_tok; /* no of tokens in bucket */ 246 u_long tbf_q_len; /* length of queue at this vif */ 247 u_long tbf_max_q_len; /* max. queue length */ 248 struct mbuf *tbf_q; /* Packet queue */ 249 struct mbuf *tbf_t; /* tail-insertion pointer */ 250}; 251 252#ifdef _KERNEL 253 254struct sockopt; 255 256extern int (*ip_mrouter_set)(struct socket *, struct sockopt *); 257extern int (*ip_mrouter_get)(struct socket *, struct sockopt *); 258extern int (*ip_mrouter_done)(void); 259extern int (*mrt_ioctl)(int, caddr_t); 260 261#endif /* _KERNEL */ 262 263#endif /* _NETINET_IP_MROUTE_H_ */ 264