in_var.h revision 119180
1237410Sdelphij/*
2205466Sdelphij * Copyright (c) 1985, 1986, 1993
3205466Sdelphij *	The Regents of the University of California.  All rights reserved.
4205466Sdelphij *
5205466Sdelphij * Redistribution and use in source and binary forms, with or without
6237410Sdelphij * modification, are permitted provided that the following conditions
7237410Sdelphij * are met:
8237410Sdelphij * 1. Redistributions of source code must retain the above copyright
9250261Sdelphij *    notice, this list of conditions and the following disclaimer.
10250261Sdelphij * 2. Redistributions in binary form must reproduce the above copyright
11250261Sdelphij *    notice, this list of conditions and the following disclaimer in the
12205466Sdelphij *    documentation and/or other materials provided with the distribution.
13205466Sdelphij * 3. All advertising materials mentioning features or use of this software
14205466Sdelphij *    must display the following acknowledgement:
15205466Sdelphij *	This product includes software developed by the University of
16205466Sdelphij *	California, Berkeley and its contributors.
17205466Sdelphij * 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 119180 2003-08-20 17:09:01Z rwatson $
35 */
36
37#ifndef _NETINET_IN_VAR_H_
38#define _NETINET_IN_VAR_H_
39
40#include <sys/queue.h>
41#include <sys/fnv_hash.h>
42
43/*
44 * Interface address, Internet version.  One of these structures
45 * is allocated for each Internet address on an interface.
46 * The ifaddr structure contains the protocol-independent part
47 * of the structure and is assumed to be first.
48 */
49struct in_ifaddr {
50	struct	ifaddr ia_ifa;		/* protocol-independent info */
51#define	ia_ifp		ia_ifa.ifa_ifp
52#define ia_flags	ia_ifa.ifa_flags
53					/* ia_{,sub}net{,mask} in host order */
54	u_long	ia_net;			/* network number of interface */
55	u_long	ia_netmask;		/* mask of net part */
56	u_long	ia_subnet;		/* subnet number, including net */
57	u_long	ia_subnetmask;		/* mask of subnet part */
58	struct	in_addr ia_netbroadcast; /* to recognize net broadcasts */
59	LIST_ENTRY(in_ifaddr) ia_hash;	/* entry in bucket of inet addresses */
60	TAILQ_ENTRY(in_ifaddr) ia_link;	/* list of internet addresses */
61	struct	sockaddr_in ia_addr;	/* reserve space for interface name */
62	struct	sockaddr_in ia_dstaddr; /* reserve space for broadcast addr */
63#define	ia_broadaddr	ia_dstaddr
64	struct	sockaddr_in ia_sockmask; /* reserve space for general netmask */
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_addr zeroin_addr;
87extern	u_char	inetctlerrmap[];
88
89/*
90 * Hash table for IP addresses.
91 */
92extern	LIST_HEAD(in_ifaddrhashhead, in_ifaddr) *in_ifaddrhashtbl;
93extern	TAILQ_HEAD(in_ifaddrhead, in_ifaddr) in_ifaddrhead;
94extern	u_long in_ifaddrhmask;			/* mask for hash table */
95
96#define INADDR_NHASH_LOG2       9
97#define INADDR_NHASH		(1 << INADDR_NHASH_LOG2)
98#define INADDR_HASHVAL(x)	fnv_32_buf((&(x)), sizeof(x), FNV1_32_INIT)
99#define INADDR_HASH(x) \
100	(&in_ifaddrhashtbl[INADDR_HASHVAL(x) & in_ifaddrhmask])
101
102
103/*
104 * Macro for finding the interface (ifnet structure) corresponding to one
105 * of our IP addresses.
106 */
107#define INADDR_TO_IFP(addr, ifp) \
108	/* struct in_addr addr; */ \
109	/* struct ifnet *ifp; */ \
110{ \
111	struct in_ifaddr *ia; \
112\
113	LIST_FOREACH(ia, INADDR_HASH((addr).s_addr), ia_hash) \
114		if (IA_SIN(ia)->sin_addr.s_addr == (addr).s_addr) \
115			break; \
116	(ifp) = (ia == NULL) ? NULL : ia->ia_ifp; \
117}
118
119/*
120 * Macro for finding the internet address structure (in_ifaddr) corresponding
121 * to a given interface (ifnet structure).
122 */
123#define IFP_TO_IA(ifp, ia) \
124	/* struct ifnet *ifp; */ \
125	/* struct in_ifaddr *ia; */ \
126{ \
127	for ((ia) = TAILQ_FIRST(&in_ifaddrhead); \
128	    (ia) != NULL && (ia)->ia_ifp != (ifp); \
129	    (ia) = TAILQ_NEXT((ia), ia_link)) \
130		continue; \
131}
132#endif
133
134/*
135 * This information should be part of the ifnet structure but we don't wish
136 * to change that - as it might break a number of things
137 */
138
139struct router_info {
140	struct ifnet *rti_ifp;
141	int    rti_type; /* type of router which is querier on this interface */
142	int    rti_time; /* # of slow timeouts since last old query */
143	SLIST_ENTRY(router_info) rti_list;
144};
145
146/*
147 * Internet multicast address structure.  There is one of these for each IP
148 * multicast group to which this host belongs on a given network interface.
149 * For every entry on the interface's if_multiaddrs list which represents
150 * an IP multicast group, there is one of these structures.  They are also
151 * kept on a system-wide list to make it easier to keep our legacy IGMP code
152 * compatible with the rest of the world (see IN_FIRST_MULTI et al, below).
153 */
154struct in_multi {
155	LIST_ENTRY(in_multi) inm_link;	/* queue macro glue */
156	struct	in_addr inm_addr;	/* IP multicast address, convenience */
157	struct	ifnet *inm_ifp;		/* back pointer to ifnet */
158	struct	ifmultiaddr *inm_ifma;	/* back pointer to ifmultiaddr */
159	u_int	inm_timer;		/* IGMP membership report timer */
160	u_int	inm_state;		/*  state of the membership */
161	struct	router_info *inm_rti;	/* router info*/
162};
163
164#ifdef _KERNEL
165
166#ifdef SYSCTL_DECL
167SYSCTL_DECL(_net_inet_ip);
168SYSCTL_DECL(_net_inet_raw);
169#endif
170
171extern LIST_HEAD(in_multihead, in_multi) in_multihead;
172
173/*
174 * Structure used by macros below to remember position when stepping through
175 * all of the in_multi records.
176 */
177struct in_multistep {
178	struct in_multi *i_inm;
179};
180
181/*
182 * Macro for looking up the in_multi record for a given IP multicast address
183 * on a given interface.  If no matching record is found, "inm" is set null.
184 */
185#define IN_LOOKUP_MULTI(addr, ifp, inm) \
186	/* struct in_addr addr; */ \
187	/* struct ifnet *ifp; */ \
188	/* struct in_multi *inm; */ \
189do { \
190	struct ifmultiaddr *ifma; \
191\
192	TAILQ_FOREACH(ifma, &((ifp)->if_multiaddrs), ifma_link) { \
193		if (ifma->ifma_addr->sa_family == AF_INET \
194		    && ((struct sockaddr_in *)ifma->ifma_addr)->sin_addr.s_addr == \
195		    (addr).s_addr) \
196			break; \
197	} \
198	(inm) = ifma ? ifma->ifma_protospec : 0; \
199} while(0)
200
201/*
202 * Macro to step through all of the in_multi records, one at a time.
203 * The current position is remembered in "step", which the caller must
204 * provide.  IN_FIRST_MULTI(), below, must be called to initialize "step"
205 * and get the first record.  Both macros return a NULL "inm" when there
206 * are no remaining records.
207 */
208#define IN_NEXT_MULTI(step, inm) \
209	/* struct in_multistep  step; */ \
210	/* struct in_multi *inm; */ \
211do { \
212	if (((inm) = (step).i_inm) != NULL) \
213		(step).i_inm = LIST_NEXT((step).i_inm, inm_link); \
214} while(0)
215
216#define IN_FIRST_MULTI(step, inm) \
217	/* struct in_multistep step; */ \
218	/* struct in_multi *inm; */ \
219do { \
220	(step).i_inm = LIST_FIRST(&in_multihead); \
221	IN_NEXT_MULTI((step), (inm)); \
222} while(0)
223
224struct	route;
225struct	in_multi *in_addmulti(struct in_addr *, struct ifnet *);
226void	in_delmulti(struct in_multi *);
227int	in_control(struct socket *, u_long, caddr_t, struct ifnet *,
228	    struct thread *);
229void	in_rtqdrain(void);
230void	ip_input(struct mbuf *);
231int	in_ifadown(struct ifaddr *ifa, int);
232void	in_ifscrub(struct ifnet *, struct in_ifaddr *);
233int	ipflow_fastforward(struct mbuf *);
234void	ipflow_create(const struct route *, struct mbuf *);
235void	ipflow_slowtimo(void);
236
237#endif /* _KERNEL */
238
239/* INET6 stuff */
240#include <netinet6/in6_var.h>
241
242#endif /* _NETINET_IN_VAR_H_ */
243