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