in_var.h revision 52904
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.2 (Berkeley) 1/9/95
34 * $FreeBSD: head/sys/netinet/in_var.h 52904 1999-11-05 14:41:39Z shin $
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 Internet address on an interface.
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	TAILQ_ENTRY(in_ifaddr) ia_link;	/* tailq macro glue */
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};
64
65struct	in_aliasreq {
66	char	ifra_name[IFNAMSIZ];		/* if name, e.g. "en0" */
67	struct	sockaddr_in ifra_addr;
68	struct	sockaddr_in ifra_broadaddr;
69#define ifra_dstaddr ifra_broadaddr
70	struct	sockaddr_in ifra_mask;
71};
72/*
73 * Given a pointer to an in_ifaddr (ifaddr),
74 * return a pointer to the addr as a sockaddr_in.
75 */
76#define IA_SIN(ia)    (&(((struct in_ifaddr *)(ia))->ia_addr))
77#define IA_DSTSIN(ia) (&(((struct in_ifaddr *)(ia))->ia_dstaddr))
78
79#define IN_LNAOF(in, ifa) \
80	((ntohl((in).s_addr) & ~((struct in_ifaddr *)(ifa)->ia_subnetmask))
81
82
83#ifdef	KERNEL
84extern	TAILQ_HEAD(in_ifaddrhead, in_ifaddr) in_ifaddrhead;
85extern	struct	ifqueue	ipintrq;		/* ip packet input queue */
86extern	struct	in_addr zeroin_addr;
87extern	u_char	inetctlerrmap[];
88
89/*
90 * Macro for finding the interface (ifnet structure) corresponding to one
91 * of our IP addresses.
92 */
93#define INADDR_TO_IFP(addr, ifp) \
94	/* struct in_addr addr; */ \
95	/* struct ifnet *ifp; */ \
96{ \
97	register struct in_ifaddr *ia; \
98\
99	for (ia = in_ifaddrhead.tqh_first; \
100	    ia != NULL && ((ia->ia_ifp->if_flags & IFF_POINTOPOINT)? \
101		IA_DSTSIN(ia):IA_SIN(ia))->sin_addr.s_addr != (addr).s_addr; \
102	    ia = ia->ia_link.tqe_next) \
103		 continue; \
104	if (ia == NULL) \
105	    for (ia = in_ifaddrhead.tqh_first; \
106		ia != NULL; \
107		ia = ia->ia_link.tqe_next) \
108		    if (ia->ia_ifp->if_flags & IFF_POINTOPOINT && \
109			IA_SIN(ia)->sin_addr.s_addr == (addr).s_addr) \
110			    break; \
111	(ifp) = (ia == NULL) ? NULL : ia->ia_ifp; \
112}
113
114/*
115 * Macro for finding the internet address structure (in_ifaddr) corresponding
116 * to a given interface (ifnet structure).
117 */
118#define IFP_TO_IA(ifp, ia) \
119	/* struct ifnet *ifp; */ \
120	/* struct in_ifaddr *ia; */ \
121{ \
122	for ((ia) = in_ifaddrhead.tqh_first; \
123	    (ia) != NULL && (ia)->ia_ifp != (ifp); \
124	    (ia) = (ia)->ia_link.tqe_next) \
125		continue; \
126}
127#endif
128
129/*
130 * This information should be part of the ifnet structure but we don't wish
131 * to change that - as it might break a number of things
132 */
133
134struct router_info {
135	struct ifnet *rti_ifp;
136	int    rti_type; /* type of router which is querier on this interface */
137	int    rti_time; /* # of slow timeouts since last old query */
138	struct router_info *rti_next;
139};
140
141/*
142 * Internet multicast address structure.  There is one of these for each IP
143 * multicast group to which this host belongs on a given network interface.
144 * For every entry on the interface's if_multiaddrs list which represents
145 * an IP multicast group, there is one of these structures.  They are also
146 * kept on a system-wide list to make it easier to keep our legacy IGMP code
147 * compatible with the rest of the world (see IN_FIRST_MULTI et al, below).
148 */
149struct in_multi {
150	LIST_ENTRY(in_multi) inm_link;	/* queue macro glue */
151	struct	in_addr inm_addr;	/* IP multicast address, convenience */
152	struct	ifnet *inm_ifp;		/* back pointer to ifnet */
153	struct	ifmultiaddr *inm_ifma;	/* back pointer to ifmultiaddr */
154	u_int	inm_timer;		/* IGMP membership report timer */
155	u_int	inm_state;		/*  state of the membership */
156	struct	router_info *inm_rti;	/* router info*/
157};
158
159#ifdef KERNEL
160
161#ifdef SYSCTL_DECL
162SYSCTL_DECL(_net_inet_ip);
163SYSCTL_DECL(_net_inet_raw);
164#endif
165
166extern LIST_HEAD(in_multihead, in_multi) in_multihead;
167
168/*
169 * Structure used by macros below to remember position when stepping through
170 * all of the in_multi records.
171 */
172struct in_multistep {
173	struct in_multi *i_inm;
174};
175
176/*
177 * Macro for looking up the in_multi record for a given IP multicast address
178 * on a given interface.  If no matching record is found, "inm" is set null.
179 */
180#define IN_LOOKUP_MULTI(addr, ifp, inm) \
181	/* struct in_addr addr; */ \
182	/* struct ifnet *ifp; */ \
183	/* struct in_multi *inm; */ \
184do { \
185	register struct ifmultiaddr *ifma; \
186\
187	for (ifma = (ifp)->if_multiaddrs.lh_first; ifma; \
188	     ifma = ifma->ifma_link.le_next) { \
189		if (ifma->ifma_addr->sa_family == AF_INET \
190		    && ((struct sockaddr_in *)ifma->ifma_addr)->sin_addr.s_addr == \
191		    (addr).s_addr) \
192			break; \
193	} \
194	(inm) = ifma ? ifma->ifma_protospec : 0; \
195} while(0)
196
197/*
198 * Macro to step through all of the in_multi records, one at a time.
199 * The current position is remembered in "step", which the caller must
200 * provide.  IN_FIRST_MULTI(), below, must be called to initialize "step"
201 * and get the first record.  Both macros return a NULL "inm" when there
202 * are no remaining records.
203 */
204#define IN_NEXT_MULTI(step, inm) \
205	/* struct in_multistep  step; */ \
206	/* struct in_multi *inm; */ \
207do { \
208	if (((inm) = (step).i_inm) != NULL) \
209		(step).i_inm = (step).i_inm->inm_link.le_next; \
210} while(0)
211
212#define IN_FIRST_MULTI(step, inm) \
213	/* struct in_multistep step; */ \
214	/* struct in_multi *inm; */ \
215do { \
216	(step).i_inm = in_multihead.lh_first; \
217	IN_NEXT_MULTI((step), (inm)); \
218} while(0)
219
220struct	route;
221struct	in_multi *in_addmulti __P((struct in_addr *, struct ifnet *));
222void	in_delmulti __P((struct in_multi *));
223int	in_control __P((struct socket *, u_long, caddr_t, struct ifnet *,
224			struct proc *));
225void	in_rtqdrain __P((void));
226void	ip_input __P((struct mbuf *));
227int	in_ifadown __P((struct ifaddr *ifa));
228void	in_ifscrub __P((struct ifnet *, struct in_ifaddr *));
229int	ipflow_fastforward __P((struct mbuf *));
230void	ipflow_create __P((const struct route *, struct mbuf *));
231void	ipflow_slowtimo __P((void));
232
233#endif /* KERNEL */
234
235/* INET6 stuff */
236#include <netinet6/in6_var.h>
237
238#endif /* _NETINET_IN_VAR_H_ */
239