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