ip_mroute.h revision 1542 
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 */
39
40/*
41 * Definitions for the kernel part of DVMRP,
42 * a Distance-Vector Multicast Routing Protocol.
43 * (See RFC-1075.)
44 *
45 * Written by David Waitzman, BBN Labs, August 1988.
46 * Modified by Steve Deering, Stanford, February 1989.
47 *
48 * MROUTING 1.0
49 */
50
51
52/*
53 * DVMRP-specific setsockopt commands.
54 */
55#define	DVMRP_INIT	100
56#define	DVMRP_DONE	101
57#define	DVMRP_ADD_VIF	102
58#define	DVMRP_DEL_VIF	103
59#define	DVMRP_ADD_LGRP	104
60#define	DVMRP_DEL_LGRP	105
61#define	DVMRP_ADD_MRT	106
62#define	DVMRP_DEL_MRT	107
63
64
65/*
66 * Types and macros for handling bitmaps with one bit per virtual interface.
67 */
68#define	MAXVIFS 32
69typedef u_long vifbitmap_t;
70typedef u_short vifi_t;		/* type of a vif index */
71
72#define	VIFM_SET(n, m)		((m) |= (1 << (n)))
73#define	VIFM_CLR(n, m)		((m) &= ~(1 << (n)))
74#define	VIFM_ISSET(n, m)	((m) & (1 << (n)))
75#define	VIFM_CLRALL(m)		((m) = 0x00000000)
76#define	VIFM_COPY(mfrom, mto)	((mto) = (mfrom))
77#define	VIFM_SAME(m1, m2)	((m1) == (m2))
78
79
80/*
81 * Agument structure for DVMRP_ADD_VIF.
82 * (DVMRP_DEL_VIF takes a single vifi_t argument.)
83 */
84struct vifctl {
85	vifi_t	    vifc_vifi;	    	/* the index of the vif to be added */
86	u_char	    vifc_flags;     	/* VIFF_ flags defined below */
87	u_char	    vifc_threshold; 	/* min ttl required to forward on vif */
88	struct	in_addr vifc_lcl_addr;	/* local interface address */
89	struct	in_addr vifc_rmt_addr;	/* remote address (tunnels only) */
90};
91
92#define	VIFF_TUNNEL	0x1		/* vif represents a tunnel end-point */
93
94
95/*
96 * Argument structure for DVMRP_ADD_LGRP and DVMRP_DEL_LGRP.
97 */
98struct lgrplctl {
99	vifi_t	lgc_vifi;
100	struct	in_addr lgc_gaddr;
101};
102
103
104/*
105 * Argument structure for DVMRP_ADD_MRT.
106 * (DVMRP_DEL_MRT takes a single struct in_addr argument, containing origin.)
107 */
108struct mrtctl {
109	struct	in_addr mrtc_origin;	/* subnet origin of multicasts */
110	struct	in_addr mrtc_originmask; /* subnet mask for origin */
111	vifi_t	mrtc_parent;    	/* incoming vif */
112	vifbitmap_t mrtc_children;	/* outgoing children vifs */
113	vifbitmap_t mrtc_leaves;	/* subset of outgoing children vifs */
114};
115
116
117#ifdef KERNEL
118
119/*
120 * The kernel's virtual-interface structure.
121 */
122struct vif {
123	u_char	v_flags;		/* VIFF_ flags defined above */
124	u_char	v_threshold;		/* min ttl required to forward on vif */
125	struct	in_addr v_lcl_addr;	/* local interface address */
126	struct	in_addr v_rmt_addr;	/* remote address (tunnels only) */
127	struct	ifnet  *v_ifp;		/* pointer to interface */
128	struct	in_addr *v_lcl_grps;	/* list of local grps (phyints only) */
129	int	v_lcl_grps_max;		/* malloc'ed number of v_lcl_grps */
130	int	v_lcl_grps_n;		/* used number of v_lcl_grps */
131	u_long	v_cached_group;		/* last grp looked-up (phyints only) */
132	int	v_cached_result;	/* last look-up result (phyints only) */
133};
134
135/*
136 * The kernel's multicast route structure.
137 */
138struct mrt {
139	struct	in_addr mrt_origin;	/* subnet origin of multicasts */
140	struct	in_addr mrt_originmask;	/* subnet mask for origin */
141	vifi_t	mrt_parent;    		/* incoming vif */
142	vifbitmap_t mrt_children;	/* outgoing children vifs */
143	vifbitmap_t mrt_leaves;		/* subset of outgoing children vifs */
144	struct	mrt *mrt_next;		/* forward link */
145};
146
147
148#define	MRTHASHSIZ	64
149#if (MRTHASHSIZ & (MRTHASHSIZ - 1)) == 0	  /* from sys:route.h */
150#define	MRTHASHMOD(h)	((h) & (MRTHASHSIZ - 1))
151#else
152#define	MRTHASHMOD(h)	((h) % MRTHASHSIZ)
153#endif
154
155/*
156 * The kernel's multicast routing statistics.
157 */
158struct mrtstat {
159	u_long	mrts_mrt_lookups;	/* # multicast route lookups */
160	u_long	mrts_mrt_misses;	/* # multicast route cache misses */
161	u_long	mrts_grp_lookups;	/* # group address lookups */
162	u_long	mrts_grp_misses;	/* # group address cache misses */
163	u_long	mrts_no_route;		/* no route for packet's origin */
164	u_long	mrts_bad_tunnel;	/* malformed tunnel options */
165	u_long	mrts_cant_tunnel;	/* no room for tunnel options */
166};
167
168
169int	ip_mrouter_cmd __P((int, struct socket *, struct mbuf *));
170int	ip_mrouter_done __P((void));
171
172#endif /* KERNEL */
173
174