in_var.h revision 8876
1/*
2 * Copyright (c) 1985, 1986, 1993
3 *	The Regents of the University of California.  All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 * 1. Redistributions of source code must retain the above copyright
9 *    notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 *    notice, this list of conditions and the following disclaimer in the
12 *    documentation and/or other materials provided with the distribution.
13 * 3. All advertising materials mentioning features or use of this software
14 *    must display the following acknowledgement:
15 *	This product includes software developed by the University of
16 *	California, Berkeley and its contributors.
17 * 4. Neither the name of the University nor the names of its contributors
18 *    may be used to endorse or promote products derived from this software
19 *    without specific prior written permission.
20 *
21 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
22 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
25 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31 * SUCH DAMAGE.
32 *
33 *	@(#)in_var.h	8.1 (Berkeley) 6/10/93
34 * $Id: in_var.h,v 1.9 1995/03/23 18:14:41 wollman Exp $
35 */
36
37#ifndef _NETINET_IN_VAR_H_
38#define _NETINET_IN_VAR_H_
39
40#include <sys/queue.h>
41
42/*
43 * Interface address, Internet version.  One of these structures
44 * is allocated for each interface with an Internet address.
45 * The ifaddr structure contains the protocol-independent part
46 * of the structure and is assumed to be first.
47 */
48struct in_ifaddr {
49	struct	ifaddr ia_ifa;		/* protocol-independent info */
50#define	ia_ifp		ia_ifa.ifa_ifp
51#define ia_flags	ia_ifa.ifa_flags
52					/* ia_{,sub}net{,mask} in host order */
53	u_long	ia_net;			/* network number of interface */
54	u_long	ia_netmask;		/* mask of net part */
55	u_long	ia_subnet;		/* subnet number, including net */
56	u_long	ia_subnetmask;		/* mask of subnet part */
57	struct	in_addr ia_netbroadcast; /* to recognize net broadcasts */
58	struct	in_ifaddr *ia_next;	/* next in list of internet addresses */
59	struct	sockaddr_in ia_addr;	/* reserve space for interface name */
60	struct	sockaddr_in ia_dstaddr; /* reserve space for broadcast addr */
61#define	ia_broadaddr	ia_dstaddr
62	struct	sockaddr_in ia_sockmask; /* reserve space for general netmask */
63	LIST_HEAD(in_multihead, in_multi) ia_multiaddrs;
64					/* list of multicast addresses */
65};
66
67struct	in_aliasreq {
68	char	ifra_name[IFNAMSIZ];		/* if name, e.g. "en0" */
69	struct	sockaddr_in ifra_addr;
70	struct	sockaddr_in ifra_broadaddr;
71#define ifra_dstaddr ifra_broadaddr
72	struct	sockaddr_in ifra_mask;
73};
74/*
75 * Given a pointer to an in_ifaddr (ifaddr),
76 * return a pointer to the addr as a sockaddr_in.
77 */
78#define IA_SIN(ia)    (&(((struct in_ifaddr *)(ia))->ia_addr))
79#define IA_DSTSIN(ia) (&(((struct in_ifaddr *)(ia))->ia_dstaddr))
80
81#define IN_LNAOF(in, ifa) \
82	((ntohl((in).s_addr) & ~((struct in_ifaddr *)(ifa)->ia_subnetmask))
83
84
85#ifdef	KERNEL
86extern	struct	in_ifaddr *in_ifaddr;
87extern	struct	ifqueue	ipintrq;		/* ip packet input queue */
88extern	struct	in_addr zeroin_addr;
89extern	u_char	inetctlerrmap[];
90extern	int rtq_reallyold;	/* XXX */
91extern	int rtq_minreallyold;	/* XXX */
92extern	int rtq_toomany;	/* XXX */
93
94/*
95 * Macro for finding the interface (ifnet structure) corresponding to one
96 * of our IP addresses.
97 */
98#define INADDR_TO_IFP(addr, ifp) \
99	/* struct in_addr addr; */ \
100	/* struct ifnet *ifp; */ \
101{ \
102	register struct in_ifaddr *ia; \
103\
104	for (ia = in_ifaddr; \
105	    ia != NULL && ((ia->ia_ifp->if_flags & IFF_POINTOPOINT)? \
106		IA_DSTSIN(ia):IA_SIN(ia))->sin_addr.s_addr != (addr).s_addr; \
107	    ia = ia->ia_next) \
108		 continue; \
109	(ifp) = (ia == NULL) ? NULL : ia->ia_ifp; \
110}
111
112/*
113 * Macro for finding the internet address structure (in_ifaddr) corresponding
114 * to a given interface (ifnet structure).
115 */
116#define IFP_TO_IA(ifp, ia) \
117	/* struct ifnet *ifp; */ \
118	/* struct in_ifaddr *ia; */ \
119{ \
120	for ((ia) = in_ifaddr; \
121	    (ia) != NULL && (ia)->ia_ifp != (ifp); \
122	    (ia) = (ia)->ia_next) \
123		continue; \
124}
125#endif
126
127/*
128 * This information should be part of the ifnet structure but we don't wish
129 * to change that - as it might break a number of things
130 */
131
132struct router_info {
133	struct ifnet *ifp;
134	int    type; /* type of router which is querier on this interface */
135	int    time; /* # of slow timeouts since last old query */
136	struct router_info *next;
137};
138
139/*
140 * Internet multicast address structure.  There is one of these for each IP
141 * multicast group to which this host belongs on a given network interface.
142 * They are kept in a linked list, rooted in the interface's in_ifaddr
143 * structure.
144 */
145struct in_multi {
146	LIST_ENTRY(in_multi) inm_entry; /* list glue */
147	struct	in_addr inm_addr;	/* IP multicast address */
148	struct	ifnet *inm_ifp;		/* back pointer to ifnet */
149	struct	in_ifaddr *inm_ia;	/* back pointer to in_ifaddr */
150	u_int	inm_refcount;		/* no. membership claims by sockets */
151	u_int	inm_timer;		/* IGMP membership report timer */
152	u_int	inm_state;		/*  state of the membership */
153	struct	router_info *inm_rti;	/* router info*/
154};
155
156#ifdef KERNEL
157/*
158 * Structure used by macros below to remember position when stepping through
159 * all of the in_multi records.
160 */
161struct in_multistep {
162	struct in_ifaddr *i_ia;
163	struct in_multi *i_inm;
164};
165
166/*
167 * Macro for looking up the in_multi record for a given IP multicast address
168 * on a given interface.  If no matching record is found, "inm" returns NULL.
169 */
170#define IN_LOOKUP_MULTI(addr, ifp, inm) \
171	/* struct in_addr addr; */ \
172	/* struct ifnet *ifp; */ \
173	/* struct in_multi *inm; */ \
174{ \
175	register struct in_ifaddr *ia; \
176\
177	IFP_TO_IA((ifp), ia); \
178	if (ia == NULL) \
179		(inm) = NULL; \
180	else \
181		for ((inm) = ia->ia_multiaddrs.lh_first; \
182		    (inm) != NULL && (inm)->inm_addr.s_addr != (addr).s_addr; \
183		     (inm) = inm->inm_entry.le_next) \
184			 continue; \
185}
186
187/*
188 * Macro to step through all of the in_multi records, one at a time.
189 * The current position is remembered in "step", which the caller must
190 * provide.  IN_FIRST_MULTI(), below, must be called to initialize "step"
191 * and get the first record.  Both macros return a NULL "inm" when there
192 * are no remaining records.
193 */
194#define IN_NEXT_MULTI(step, inm) \
195	/* struct in_multistep  step; */ \
196	/* struct in_multi *inm; */ \
197{ \
198	if (((inm) = (step).i_inm) != NULL) \
199		(step).i_inm = (inm)->inm_entry.le_next; \
200	else \
201		while ((step).i_ia != NULL) { \
202			(inm) = (step).i_ia->ia_multiaddrs.lh_first; \
203			(step).i_ia = (step).i_ia->ia_next; \
204			if ((inm) != NULL) { \
205				(step).i_inm = (inm)->inm_entry.le_next; \
206				break; \
207			} \
208		} \
209}
210
211#define IN_FIRST_MULTI(step, inm) \
212	/* struct in_multistep step; */ \
213	/* struct in_multi *inm; */ \
214{ \
215	(step).i_ia = in_ifaddr; \
216	(step).i_inm = NULL; \
217	IN_NEXT_MULTI((step), (inm)); \
218}
219
220int	in_ifinit __P((struct ifnet *,
221	    struct in_ifaddr *, struct sockaddr_in *, int));
222struct	in_multi *in_addmulti __P((struct in_addr *, struct ifnet *));
223void	in_delmulti __P((struct in_multi *));
224void	in_ifscrub __P((struct ifnet *, struct in_ifaddr *));
225int	in_control __P((struct socket *, int, caddr_t, struct ifnet *));
226
227#endif
228#endif
229