Home | History | Annotate | Line # | Download | only in netinet6
      1 /*	$NetBSD: ip6_mroute.h,v 1.20 2022/08/07 20:14:00 tsutsui 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 /*	BSDI ip_mroute.h,v 2.5 1996/10/11 16:01:48 pjd Exp	*/
     34 
     35 /*
     36  * Definitions for IP multicast forwarding.
     37  *
     38  * Written by David Waitzman, BBN Labs, August 1988.
     39  * Modified by Steve Deering, Stanford, February 1989.
     40  * Modified by Ajit Thyagarajan, PARC, August 1993.
     41  * Modified by Ajit Thyagarajan, PARC, August 1994.
     42  * Modified by Ahmed Helmy, USC, September 1996.
     43  *
     44  * MROUTING Revision: 1.2
     45  */
     46 
     47 #ifndef _NETINET6_IP6_MROUTE_H_
     48 #define _NETINET6_IP6_MROUTE_H_
     49 
     50 /*
     51  * Multicast Routing set/getsockopt commands.
     52  */
     53 #ifdef _KERNEL
     54 #define MRT6_OINIT		100	/* initialize forwarder (omrt6msg) */
     55 #endif
     56 #define MRT6_DONE		101	/* shut down forwarder */
     57 #define MRT6_ADD_MIF		102	/* add multicast interface */
     58 #define MRT6_DEL_MIF		103	/* delete multicast interface */
     59 #define MRT6_ADD_MFC		104	/* insert forwarding cache entry */
     60 #define MRT6_DEL_MFC		105	/* delete forwarding cache entry */
     61 #define MRT6_PIM                107     /* enable pim code */
     62 #define MRT6_INIT		108	/* initialize forwarder (mrt6msg) */
     63 
     64 #if BSD >= 199103
     65 #define GET_TIME(t)	microtime(&t)
     66 #elif defined(sun)
     67 #define GET_TIME(t)	uniqtime(&t)
     68 #else
     69 #define GET_TIME(t)	((t) = time)
     70 #endif
     71 
     72 /*
     73  * Types and macros for handling bitmaps with one bit per multicast interface.
     74  */
     75 typedef u_short mifi_t;		/* type of a mif index */
     76 #define MAXMIFS		64
     77 
     78 #ifndef	IF_SETSIZE
     79 #define	IF_SETSIZE	256
     80 #endif
     81 
     82 typedef	u_int32_t	if_mask;
     83 #define	NIFBITS	(sizeof(if_mask) * NBBY)	/* bits per mask */
     84 
     85 #ifndef howmany
     86 #define	howmany(x, y)	(((x) + ((y) - 1)) / (y))
     87 #endif
     88 
     89 typedef	struct if_set {
     90 	if_mask	ifs_bits[howmany(IF_SETSIZE, NIFBITS)];
     91 } if_set;
     92 
     93 #define	IF_SET(n, p)	((p)->ifs_bits[(n)/NIFBITS] |= (1 << ((n) % NIFBITS)))
     94 #define	IF_CLR(n, p)	((p)->ifs_bits[(n)/NIFBITS] &= ~(1 << ((n) % NIFBITS)))
     95 #define	IF_ISSET(n, p)	((p)->ifs_bits[(n)/NIFBITS] & (1 << ((n) % NIFBITS)))
     96 #define	IF_COPY(f, t)	memcpy(t, f, sizeof(*(f)))
     97 #define	IF_ZERO(p)	memset(p, 0, sizeof(*(p)))
     98 
     99 /*
    100  * Argument structure for MRT6_ADD_IF.
    101  */
    102 struct mif6ctl {
    103 	mifi_t	    mif6c_mifi;	    	/* the index of the mif to be added  */
    104 	u_char	    mif6c_flags;     	/* MIFF_ flags defined below         */
    105 	u_short	    mif6c_pifi;		/* the index of the physical IF */
    106 };
    107 
    108 #define	MIFF_REGISTER	0x1	/* mif represents a register end-point */
    109 
    110 /*
    111  * Argument structure for MRT6_ADD_MFC and MRT6_DEL_MFC
    112  */
    113 struct mf6cctl {
    114 	struct sockaddr_in6 mf6cc_origin;	/* IPv6 origin of mcasts */
    115 	struct sockaddr_in6 mf6cc_mcastgrp; /* multicast group associated */
    116 	mifi_t		mf6cc_parent;	/* incoming ifindex */
    117 	struct if_set	mf6cc_ifset;	/* set of forwarding ifs */
    118 };
    119 
    120 /*
    121  * The kernel's multicast routing statistics.
    122  */
    123 struct mrt6stat {
    124 	u_quad_t mrt6s_mfc_lookups;	/* # forw. cache hash table hits   */
    125 	u_quad_t mrt6s_mfc_misses;	/* # forw. cache hash table misses */
    126 	u_quad_t mrt6s_upcalls;		/* # calls to mrouted              */
    127 	u_quad_t mrt6s_no_route;	/* no route for packet's origin    */
    128 	u_quad_t mrt6s_bad_tunnel;	/* malformed tunnel options        */
    129 	u_quad_t mrt6s_cant_tunnel;	/* no room for tunnel options      */
    130 	u_quad_t mrt6s_wrong_if;	/* arrived on wrong interface	   */
    131 	u_quad_t mrt6s_upq_ovflw;	/* upcall Q overflow		   */
    132 	u_quad_t mrt6s_cache_cleanups;	/* # entries with no upcalls 	   */
    133 	u_quad_t mrt6s_drop_sel;     	/* pkts dropped selectively        */
    134 	u_quad_t mrt6s_q_overflow;    	/* pkts dropped - Q overflow       */
    135 	u_quad_t mrt6s_pkt2large;     	/* pkts dropped - size > BKT SIZE  */
    136 	u_quad_t mrt6s_upq_sockfull;	/* upcalls dropped - socket full   */
    137 };
    138 
    139 #ifdef MRT6_OINIT
    140 /*
    141  * Struct used to communicate from kernel to multicast router
    142  * note the convenient similarity to an IPv6 header.
    143  * XXX old version, superseded by mrt6msg.
    144  */
    145 struct omrt6msg {
    146 	u_long	    unused1;
    147 	u_char	    im6_msgtype;		/* what type of message	    */
    148 #if 0
    149 #define MRT6MSG_NOCACHE	1
    150 #define MRT6MSG_WRONGMIF	2
    151 #define MRT6MSG_WHOLEPKT	3		/* used for user level encap*/
    152 #endif
    153 	u_char	    im6_mbz;			/* must be zero		    */
    154 	u_char	    im6_mif;			/* mif rec'd on		    */
    155 	u_char	    unused2;
    156 	struct in6_addr  im6_src, im6_dst;
    157 };
    158 #endif
    159 
    160 /*
    161  * Structure used to communicate from kernel to multicast router.
    162  * We'll overlay the structure onto an MLD header (not an IPv6 header
    163  * like igmpmsg{} used for IPv4 implementation). This is because this
    164  * structure will be passed via an IPv6 raw socket, on which an application
    165  * will only receive the payload i.e. the data after the IPv6 header and all
    166  * the extension headers. (see Section 3 of draft-ietf-ipngwg-2292bis-01)
    167  */
    168 struct mrt6msg {
    169 #define MRT6MSG_NOCACHE		1
    170 #define MRT6MSG_WRONGMIF	2
    171 #define MRT6MSG_WHOLEPKT	3		/* used for user level encap*/
    172 	u_char	    im6_mbz;			/* must be zero		    */
    173 	u_char	    im6_msgtype;		/* what type of message	    */
    174 	u_int16_t   im6_mif;			/* mif rec'd on		    */
    175 	u_int32_t   im6_pad;			/* padding for 64bit arch   */
    176 	struct in6_addr  im6_src, im6_dst;
    177 };
    178 
    179 /*
    180  * Argument structure used by multicast routing daemon to get src-grp
    181  * packet counts
    182  */
    183 struct sioc_sg_req6 {
    184 	struct sockaddr_in6 src;
    185 	struct sockaddr_in6 grp;
    186 	u_quad_t pktcnt;
    187 	u_quad_t bytecnt;
    188 	u_quad_t wrong_if;
    189 };
    190 
    191 /*
    192  * Argument structure used by mrouted to get mif pkt counts
    193  */
    194 struct sioc_mif_req6 {
    195 	mifi_t mifi;		/* mif number				*/
    196 	u_quad_t icount;	/* Input packet count on mif		*/
    197 	u_quad_t ocount;	/* Output packet count on mif		*/
    198 	u_quad_t ibytes;	/* Input byte count on mif		*/
    199 	u_quad_t obytes;	/* Output byte count on mif		*/
    200 };
    201 
    202 #ifdef _KERNEL
    203 /*
    204  * The kernel's multicast-interface structure.
    205  */
    206 struct mif6 {
    207         u_char   	m6_flags;     	/* MIFF_ flags defined above         */
    208 	u_int      	m6_rate_limit; 	/* max rate			     */
    209 	struct in6_addr	m6_lcl_addr;   	/* local interface address           */
    210 	struct ifnet    *m6_ifp;     	/* pointer to interface              */
    211 	u_quad_t	m6_pkt_in;	/* # pkts in on interface            */
    212 	u_quad_t	m6_pkt_out;	/* # pkts out on interface           */
    213 	u_quad_t	m6_bytes_in;	/* # bytes in on interface	     */
    214 	u_quad_t	m6_bytes_out;	/* # bytes out on interface	     */
    215 };
    216 
    217 /*
    218  * The kernel's multicast forwarding cache entry structure
    219  */
    220 struct mf6c {
    221 	struct sockaddr_in6  mf6c_origin;	/* IPv6 origin of mcasts     */
    222 	struct sockaddr_in6  mf6c_mcastgrp;	/* multicast group associated*/
    223 	mifi_t	    	 mf6c_parent; 		/* incoming IF               */
    224 	struct if_set	 mf6c_ifset;		/* set of outgoing IFs */
    225 
    226 	u_quad_t    	mf6c_pkt_cnt;		/* pkt count for src-grp     */
    227 	u_quad_t    	mf6c_byte_cnt;		/* byte count for src-grp    */
    228 	u_quad_t    	mf6c_wrong_if;		/* wrong if for src-grp	     */
    229 	int	    	mf6c_expire;		/* time to clean entry up    */
    230 	struct timeval  mf6c_last_assert;	/* last time I sent an assert*/
    231 	struct rtdetq  *mf6c_stall;		/* pkts waiting for route */
    232 	struct mf6c    *mf6c_next;		/* hash table linkage */
    233 };
    234 
    235 #define MF6C_INCOMPLETE_PARENT ((mifi_t)-1)
    236 
    237 /*
    238  * Argument structure used for pkt info. while upcall is made
    239  */
    240 #ifndef _NETINET_IP_MROUTE_H_
    241 struct rtdetq {		/* XXX: rtdetq is also defined in ip_mroute.h */
    242     struct mbuf 	*m;		/* A copy of the packet	    	    */
    243     struct ifnet	*ifp;		/* Interface pkt came in on 	    */
    244 #ifdef UPCALL_TIMING
    245     struct timeval	t;		/* Timestamp */
    246 #endif /* UPCALL_TIMING */
    247     struct rtdetq	*next;
    248 };
    249 #endif /* _NETINET_IP_MROUTE_H_ */
    250 
    251 #define MF6CTBLSIZ	256
    252 #if (MF6CTBLSIZ & (MF6CTBLSIZ - 1)) == 0	  /* from sys:route.h */
    253 #define MF6CHASHMOD(h)	((h) & (MF6CTBLSIZ - 1))
    254 #else
    255 #define MF6CHASHMOD(h)	((h) % MF6CTBLSIZ)
    256 #endif
    257 
    258 #define MAX_UPQ6	4		/* max. no of pkts in upcall Q */
    259 
    260 int	ip6_mrouter_set(struct socket *, struct sockopt *);
    261 int	ip6_mrouter_get(struct socket *, struct sockopt *);
    262 int	ip6_mrouter_done(void);
    263 void	ip6_mrouter_detach(struct ifnet *);
    264 int	mrt6_ioctl(u_long, void *);
    265 #endif /* _KERNEL */
    266 
    267 #endif /* !_NETINET6_IP6_MROUTE_H_ */
    268