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