xref: /netbsd-src/sys/netinet/ip_mroute.h (revision ae9172d6cd9432a6a1a56760d86b32c57a66c39c)
1 /*	$NetBSD: ip_mroute.h,v 1.6 1994/06/29 06:38:24 cgd Exp $	*/
2 
3 /*
4  * Copyright (c) 1989 Stephen Deering.
5  * Copyright (c) 1992 Regents of the University of California.
6  * All rights reserved.
7  *
8  * This code is derived from software contributed to Berkeley by
9  * Stephen Deering of Stanford University.
10  *
11  * Redistribution and use in source and binary forms, with or without
12  * modification, are permitted provided that the following conditions
13  * are met:
14  * 1. Redistributions of source code must retain the above copyright
15  *    notice, this list of conditions and the following disclaimer.
16  * 2. Redistributions in binary form must reproduce the above copyright
17  *    notice, this list of conditions and the following disclaimer in the
18  *    documentation and/or other materials provided with the distribution.
19  * 3. All advertising materials mentioning features or use of this software
20  *    must display the following acknowledgement:
21  *	This product includes software developed by the University of
22  *	California, Berkeley and its contributors.
23  * 4. Neither the name of the University nor the names of its contributors
24  *    may be used to endorse or promote products derived from this software
25  *    without specific prior written permission.
26  *
27  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
28  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
29  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
30  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
31  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
32  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
33  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
34  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
35  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
36  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
37  * SUCH DAMAGE.
38  *
39  *	@(#)ip_mroute.h	7.2 (Berkeley) 7/8/92
40  */
41 
42 /*
43  * Definitions for the kernel part of DVMRP,
44  * a Distance-Vector Multicast Routing Protocol.
45  * (See RFC-1075.)
46  *
47  * Written by David Waitzman, BBN Labs, August 1988.
48  * Modified by Steve Deering, Stanford, February 1989.
49  *
50  * MROUTING 1.0
51  */
52 
53 
54 /*
55  * DVMRP-specific setsockopt commands.
56  */
57 #define	DVMRP_INIT	100
58 #define	DVMRP_DONE	101
59 #define	DVMRP_ADD_VIF	102
60 #define	DVMRP_DEL_VIF	103
61 #define	DVMRP_ADD_LGRP	104
62 #define	DVMRP_DEL_LGRP	105
63 #define	DVMRP_ADD_MRT	106
64 #define	DVMRP_DEL_MRT	107
65 
66 
67 /*
68  * Types and macros for handling bitmaps with one bit per virtual interface.
69  */
70 #define	MAXVIFS 32
71 typedef u_long vifbitmap_t;
72 typedef u_short vifi_t;		/* type of a vif index */
73 
74 #define	VIFM_SET(n, m)		((m) |= (1 << (n)))
75 #define	VIFM_CLR(n, m)		((m) &= ~(1 << (n)))
76 #define	VIFM_ISSET(n, m)	((m) & (1 << (n)))
77 #define	VIFM_CLRALL(m)		((m) = 0x00000000)
78 #define	VIFM_COPY(mfrom, mto)	((mto) = (mfrom))
79 #define	VIFM_SAME(m1, m2)	((m1) == (m2))
80 
81 
82 /*
83  * Agument structure for DVMRP_ADD_VIF.
84  * (DVMRP_DEL_VIF takes a single vifi_t argument.)
85  */
86 struct vifctl {
87 	vifi_t	    vifc_vifi;	    	/* the index of the vif to be added */
88 	u_char	    vifc_flags;     	/* VIFF_ flags defined below */
89 	u_char	    vifc_threshold; 	/* min ttl required to forward on vif */
90 	struct	in_addr vifc_lcl_addr;	/* local interface address */
91 	struct	in_addr vifc_rmt_addr;	/* remote address (tunnels only) */
92 };
93 
94 #define	VIFF_TUNNEL	0x1		/* vif represents a tunnel end-point */
95 #define	VIFF_SRCRT	0x2		/* tunnel uses IP src routing */
96 
97 
98 /*
99  * Argument structure for DVMRP_ADD_LGRP and DVMRP_DEL_LGRP.
100  */
101 struct lgrplctl {
102 	vifi_t	lgc_vifi;
103 	struct	in_addr lgc_gaddr;
104 };
105 
106 
107 /*
108  * Argument structure for DVMRP_ADD_MRT.
109  * (DVMRP_DEL_MRT takes a single struct in_addr argument, containing origin.)
110  */
111 struct mrtctl {
112 	struct	in_addr mrtc_origin;	/* subnet origin of multicasts */
113 	struct	in_addr mrtc_originmask; /* subnet mask for origin */
114 	vifi_t	mrtc_parent;    	/* incoming vif */
115 	vifbitmap_t mrtc_children;	/* outgoing children vifs */
116 	vifbitmap_t mrtc_leaves;	/* subset of outgoing children vifs */
117 };
118 
119 
120 #ifdef KERNEL
121 
122 /*
123  * The kernel's virtual-interface structure.
124  */
125 struct vif {
126 	u_char	v_flags;		/* VIFF_ flags defined above */
127 	u_char	v_threshold;		/* min ttl required to forward on vif */
128 	struct	in_addr v_lcl_addr;	/* local interface address */
129 	struct	in_addr v_rmt_addr;	/* remote address (tunnels only) */
130 	struct	ifnet  *v_ifp;		/* pointer to interface */
131 	struct	in_addr *v_lcl_grps;	/* list of local grps (phyints only) */
132 	int	v_lcl_grps_max;		/* malloc'ed number of v_lcl_grps */
133 	int	v_lcl_grps_n;		/* used number of v_lcl_grps */
134 	u_long	v_cached_group;		/* last grp looked-up (phyints only) */
135 	int	v_cached_result;	/* last look-up result (phyints only) */
136 };
137 
138 /*
139  * The kernel's multicast route structure.
140  */
141 struct mrt {
142 	struct	in_addr mrt_origin;	/* subnet origin of multicasts */
143 	struct	in_addr mrt_originmask;	/* subnet mask for origin */
144 	vifi_t	mrt_parent;    		/* incoming vif */
145 	vifbitmap_t mrt_children;	/* outgoing children vifs */
146 	vifbitmap_t mrt_leaves;		/* subset of outgoing children vifs */
147 	struct	mrt *mrt_next;		/* forward link */
148 };
149 
150 
151 #define	MRTHASHSIZ	256
152 #if (MRTHASHSIZ & (MRTHASHSIZ - 1)) == 0	  /* from sys:route.h */
153 #define	MRTHASHMOD(h)	((h) & (MRTHASHSIZ - 1))
154 #else
155 #define	MRTHASHMOD(h)	((h) % MRTHASHSIZ)
156 #endif
157 
158 /*
159  * The kernel's multicast routing statistics.
160  */
161 struct mrtstat {
162 	u_long	mrts_mrt_lookups;	/* # multicast route lookups */
163 	u_long	mrts_mrt_misses;	/* # multicast route cache misses */
164 	u_long	mrts_grp_lookups;	/* # group address lookups */
165 	u_long	mrts_grp_misses;	/* # group address cache misses */
166 	u_long	mrts_no_route;		/* no route for packet's origin */
167 	u_long	mrts_bad_tunnel;	/* malformed tunnel options */
168 	u_long	mrts_cant_tunnel;	/* no room for tunnel options */
169 	u_long	mrts_wrong_if;		/* arrived on wrong interface */
170 };
171 
172 int	ip_mforward __P((struct mbuf *, struct ifnet *));
173 int	ip_mrouter_cmd __P((int, struct socket *, struct mbuf *));
174 int	ip_mrouter_done __P((void));
175 #endif /* KERNEL */
176