in_var.h revision 139823
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 * 4. Neither the name of the University nor the names of its contributors
14 *    may be used to endorse or promote products derived from this software
15 *    without specific prior written permission.
16 *
17 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27 * SUCH DAMAGE.
28 *
29 *	@(#)in_var.h	8.2 (Berkeley) 1/9/95
30 * $FreeBSD: head/sys/netinet/in_var.h 139823 2005-01-07 01:45:51Z imp $
31 */
32
33#ifndef _NETINET_IN_VAR_H_
34#define _NETINET_IN_VAR_H_
35
36#include <sys/queue.h>
37#include <sys/fnv_hash.h>
38
39/*
40 * Interface address, Internet version.  One of these structures
41 * is allocated for each Internet address on an interface.
42 * The ifaddr structure contains the protocol-independent part
43 * of the structure and is assumed to be first.
44 */
45struct in_ifaddr {
46	struct	ifaddr ia_ifa;		/* protocol-independent info */
47#define	ia_ifp		ia_ifa.ifa_ifp
48#define ia_flags	ia_ifa.ifa_flags
49					/* ia_{,sub}net{,mask} in host order */
50	u_long	ia_net;			/* network number of interface */
51	u_long	ia_netmask;		/* mask of net part */
52	u_long	ia_subnet;		/* subnet number, including net */
53	u_long	ia_subnetmask;		/* mask of subnet part */
54	struct	in_addr ia_netbroadcast; /* to recognize net broadcasts */
55	LIST_ENTRY(in_ifaddr) ia_hash;	/* entry in bucket of inet addresses */
56	TAILQ_ENTRY(in_ifaddr) ia_link;	/* list of internet addresses */
57	struct	sockaddr_in ia_addr;	/* reserve space for interface name */
58	struct	sockaddr_in ia_dstaddr; /* reserve space for broadcast addr */
59#define	ia_broadaddr	ia_dstaddr
60	struct	sockaddr_in ia_sockmask; /* reserve space for general netmask */
61};
62
63struct	in_aliasreq {
64	char	ifra_name[IFNAMSIZ];		/* if name, e.g. "en0" */
65	struct	sockaddr_in ifra_addr;
66	struct	sockaddr_in ifra_broadaddr;
67#define ifra_dstaddr ifra_broadaddr
68	struct	sockaddr_in ifra_mask;
69};
70/*
71 * Given a pointer to an in_ifaddr (ifaddr),
72 * return a pointer to the addr as a sockaddr_in.
73 */
74#define IA_SIN(ia)    (&(((struct in_ifaddr *)(ia))->ia_addr))
75#define IA_DSTSIN(ia) (&(((struct in_ifaddr *)(ia))->ia_dstaddr))
76
77#define IN_LNAOF(in, ifa) \
78	((ntohl((in).s_addr) & ~((struct in_ifaddr *)(ifa)->ia_subnetmask))
79
80
81#ifdef	_KERNEL
82extern	u_char	inetctlerrmap[];
83
84/*
85 * Hash table for IP addresses.
86 */
87extern	LIST_HEAD(in_ifaddrhashhead, in_ifaddr) *in_ifaddrhashtbl;
88extern	TAILQ_HEAD(in_ifaddrhead, in_ifaddr) in_ifaddrhead;
89extern	u_long in_ifaddrhmask;			/* mask for hash table */
90
91#define INADDR_NHASH_LOG2       9
92#define INADDR_NHASH		(1 << INADDR_NHASH_LOG2)
93#define INADDR_HASHVAL(x)	fnv_32_buf((&(x)), sizeof(x), FNV1_32_INIT)
94#define INADDR_HASH(x) \
95	(&in_ifaddrhashtbl[INADDR_HASHVAL(x) & in_ifaddrhmask])
96
97
98/*
99 * Macro for finding the interface (ifnet structure) corresponding to one
100 * of our IP addresses.
101 */
102#define INADDR_TO_IFP(addr, ifp) \
103	/* struct in_addr addr; */ \
104	/* struct ifnet *ifp; */ \
105{ \
106	struct in_ifaddr *ia; \
107\
108	LIST_FOREACH(ia, INADDR_HASH((addr).s_addr), ia_hash) \
109		if (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) = TAILQ_FIRST(&in_ifaddrhead); \
123	    (ia) != NULL && (ia)->ia_ifp != (ifp); \
124	    (ia) = TAILQ_NEXT((ia), ia_link)) \
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	SLIST_ENTRY(router_info) rti_list;
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);
163SYSCTL_DECL(_net_inet_ip);
164SYSCTL_DECL(_net_inet_raw);
165#endif
166
167extern LIST_HEAD(in_multihead, in_multi) in_multihead;
168
169/*
170 * Structure used by macros below to remember position when stepping through
171 * all of the in_multi records.
172 */
173struct in_multistep {
174	struct in_multi *i_inm;
175};
176
177/*
178 * Macro for looking up the in_multi record for a given IP multicast address
179 * on a given interface.  If no matching record is found, "inm" is set null.
180 */
181#define IN_LOOKUP_MULTI(addr, ifp, inm) \
182	/* struct in_addr addr; */ \
183	/* struct ifnet *ifp; */ \
184	/* struct in_multi *inm; */ \
185do { \
186	struct ifmultiaddr *ifma; \
187\
188	TAILQ_FOREACH(ifma, &((ifp)->if_multiaddrs), ifma_link) { \
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 = LIST_NEXT((step).i_inm, inm_link); \
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 = LIST_FIRST(&in_multihead); \
217	IN_NEXT_MULTI((step), (inm)); \
218} while(0)
219
220struct	route;
221struct	in_multi *in_addmulti(struct in_addr *, struct ifnet *);
222void	in_delmulti(struct in_multi *);
223int	in_control(struct socket *, u_long, caddr_t, struct ifnet *,
224	    struct thread *);
225void	in_rtqdrain(void);
226void	ip_input(struct mbuf *);
227int	in_ifadown(struct ifaddr *ifa, int);
228void	in_ifscrub(struct ifnet *, struct in_ifaddr *);
229int	ip_fastforward(struct mbuf *);
230
231#endif /* _KERNEL */
232
233/* INET6 stuff */
234#include <netinet6/in6_var.h>
235
236#endif /* _NETINET_IN_VAR_H_ */
237