FreeBSD/Linux Kernel Cross Reference
sys/netinet/in_var.h
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: src/sys/netinet/in_var.h,v 1.65 2008/11/19 09:39:34 zec Exp $
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 */
45 struct 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
63 struct 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
82 extern u_char inetctlerrmap[];
83
84 /*
85 * Hash table for IP addresses.
86 */
87 extern LIST_HEAD(in_ifaddrhashhead, in_ifaddr) *in_ifaddrhashtbl;
88 extern TAILQ_HEAD(in_ifaddrhead, in_ifaddr) in_ifaddrhead;
89 extern 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 (&V_in_ifaddrhashtbl[INADDR_HASHVAL(x) & V_in_ifaddrhmask])
96
97 /*
98 * Macro for finding the internet address structure (in_ifaddr)
99 * corresponding to one of our IP addresses (in_addr).
100 */
101 #define INADDR_TO_IFADDR(addr, ia) \
102 /* struct in_addr addr; */ \
103 /* struct in_ifaddr *ia; */ \
104 do { \
105 \
106 LIST_FOREACH(ia, INADDR_HASH((addr).s_addr), ia_hash) \
107 if (IA_SIN(ia)->sin_addr.s_addr == (addr).s_addr) \
108 break; \
109 } while (0)
110
111 /*
112 * Macro for finding the interface (ifnet structure) corresponding to one
113 * of our IP addresses.
114 */
115 #define INADDR_TO_IFP(addr, ifp) \
116 /* struct in_addr addr; */ \
117 /* struct ifnet *ifp; */ \
118 { \
119 struct in_ifaddr *ia; \
120 \
121 INADDR_TO_IFADDR(addr, ia); \
122 (ifp) = (ia == NULL) ? NULL : ia->ia_ifp; \
123 }
124
125 /*
126 * Macro for finding the internet address structure (in_ifaddr) corresponding
127 * to a given interface (ifnet structure).
128 */
129 #define IFP_TO_IA(ifp, ia) \
130 /* struct ifnet *ifp; */ \
131 /* struct in_ifaddr *ia; */ \
132 { \
133 for ((ia) = TAILQ_FIRST(&V_in_ifaddrhead); \
134 (ia) != NULL && (ia)->ia_ifp != (ifp); \
135 (ia) = TAILQ_NEXT((ia), ia_link)) \
136 continue; \
137 }
138 #endif
139
140 /*
141 * IP datagram reassembly.
142 */
143 #define IPREASS_NHASH_LOG2 6
144 #define IPREASS_NHASH (1 << IPREASS_NHASH_LOG2)
145 #define IPREASS_HMASK (IPREASS_NHASH - 1)
146 #define IPREASS_HASH(x,y) \
147 (((((x) & 0xF) | ((((x) >> 8) & 0xF) << 4)) ^ (y)) & IPREASS_HMASK)
148
149 /*
150 * This information should be part of the ifnet structure but we don't wish
151 * to change that - as it might break a number of things
152 */
153
154 struct router_info {
155 struct ifnet *rti_ifp;
156 int rti_type; /* type of router which is querier on this interface */
157 int rti_time; /* # of slow timeouts since last old query */
158 SLIST_ENTRY(router_info) rti_list;
159 #ifdef notyet
160 int rti_timev1; /* IGMPv1 querier present */
161 int rti_timev2; /* IGMPv2 querier present */
162 int rti_timer; /* report to general query */
163 int rti_qrv; /* querier robustness */
164 #endif
165 };
166
167 /*
168 * Internet multicast address structure. There is one of these for each IP
169 * multicast group to which this host belongs on a given network interface.
170 * For every entry on the interface's if_multiaddrs list which represents
171 * an IP multicast group, there is one of these structures. They are also
172 * kept on a system-wide list to make it easier to keep our legacy IGMP code
173 * compatible with the rest of the world (see IN_FIRST_MULTI et al, below).
174 */
175 struct in_multi {
176 LIST_ENTRY(in_multi) inm_link; /* queue macro glue */
177 struct in_addr inm_addr; /* IP multicast address, convenience */
178 struct ifnet *inm_ifp; /* back pointer to ifnet */
179 struct ifmultiaddr *inm_ifma; /* back pointer to ifmultiaddr */
180 u_int inm_timer; /* IGMP membership report timer */
181 u_int inm_state; /* state of the membership */
182 struct router_info *inm_rti; /* router info*/
183 u_int inm_refcount; /* reference count */
184 #ifdef notyet /* IGMPv3 source-specific multicast fields */
185 TAILQ_HEAD(, in_msfentry) inm_msf; /* all active source filters */
186 TAILQ_HEAD(, in_msfentry) inm_msf_record; /* recorded sources */
187 TAILQ_HEAD(, in_msfentry) inm_msf_exclude; /* exclude sources */
188 TAILQ_HEAD(, in_msfentry) inm_msf_include; /* include sources */
189 /* XXX: should this lot go to the router_info structure? */
190 /* XXX: can/should these be callouts? */
191 /* IGMP protocol timers */
192 int32_t inm_ti_curstate; /* current state timer */
193 int32_t inm_ti_statechg; /* state change timer */
194 /* IGMP report timers */
195 uint16_t inm_rpt_statechg; /* state change report timer */
196 uint16_t inm_rpt_toxx; /* fmode change report timer */
197 /* IGMP protocol state */
198 uint16_t inm_fmode; /* filter mode */
199 uint32_t inm_recsrc_count; /* # of recorded sources */
200 uint16_t inm_exclude_sock_count; /* # of exclude-mode sockets */
201 uint16_t inm_gass_count; /* # of g-a-s queries */
202 #endif
203 };
204
205 #ifdef notyet
206 /*
207 * Internet multicast source filter list. This list is used to store
208 * IP multicast source addresses for each membership on an interface.
209 * TODO: Allocate these structures using UMA.
210 * TODO: Find an easier way of linking the struct into two lists at once.
211 */
212 struct in_msfentry {
213 TAILQ_ENTRY(in_msfentry) isf_link; /* next filter in all-list */
214 TAILQ_ENTRY(in_msfentry) isf_next; /* next filter in queue */
215 struct in_addr isf_addr; /* the address of this source */
216 uint16_t isf_refcount; /* reference count */
217 uint16_t isf_reporttag; /* what to report to the IGMP router */
218 uint16_t isf_rexmit; /* retransmission state/count */
219 };
220 #endif
221
222 #ifdef _KERNEL
223
224 #ifdef SYSCTL_DECL
225 SYSCTL_DECL(_net_inet);
226 SYSCTL_DECL(_net_inet_ip);
227 SYSCTL_DECL(_net_inet_raw);
228 #endif
229
230 extern LIST_HEAD(in_multihead, in_multi) in_multihead;
231
232 /*
233 * Lock macros for IPv4 layer multicast address lists. IPv4 lock goes
234 * before link layer multicast locks in the lock order. In most cases,
235 * consumers of IN_*_MULTI() macros should acquire the locks before
236 * calling them; users of the in_{add,del}multi() functions should not.
237 */
238 extern struct mtx in_multi_mtx;
239 #define IN_MULTI_LOCK() mtx_lock(&in_multi_mtx)
240 #define IN_MULTI_UNLOCK() mtx_unlock(&in_multi_mtx)
241 #define IN_MULTI_LOCK_ASSERT() mtx_assert(&in_multi_mtx, MA_OWNED)
242
243 /*
244 * Structure used by macros below to remember position when stepping through
245 * all of the in_multi records.
246 */
247 struct in_multistep {
248 struct in_multi *i_inm;
249 };
250
251 /*
252 * Macro for looking up the in_multi record for a given IP multicast address
253 * on a given interface. If no matching record is found, "inm" is set null.
254 */
255 #define IN_LOOKUP_MULTI(addr, ifp, inm) \
256 /* struct in_addr addr; */ \
257 /* struct ifnet *ifp; */ \
258 /* struct in_multi *inm; */ \
259 do { \
260 struct ifmultiaddr *ifma; \
261 \
262 IN_MULTI_LOCK_ASSERT(); \
263 IF_ADDR_LOCK(ifp); \
264 TAILQ_FOREACH(ifma, &((ifp)->if_multiaddrs), ifma_link) { \
265 if (ifma->ifma_addr->sa_family == AF_INET \
266 && ((struct sockaddr_in *)ifma->ifma_addr)->sin_addr.s_addr == \
267 (addr).s_addr) \
268 break; \
269 } \
270 (inm) = ifma ? ifma->ifma_protospec : 0; \
271 IF_ADDR_UNLOCK(ifp); \
272 } while(0)
273
274 /*
275 * Macro to step through all of the in_multi records, one at a time.
276 * The current position is remembered in "step", which the caller must
277 * provide. IN_FIRST_MULTI(), below, must be called to initialize "step"
278 * and get the first record. Both macros return a NULL "inm" when there
279 * are no remaining records.
280 */
281 #define IN_NEXT_MULTI(step, inm) \
282 /* struct in_multistep step; */ \
283 /* struct in_multi *inm; */ \
284 do { \
285 IN_MULTI_LOCK_ASSERT(); \
286 if (((inm) = (step).i_inm) != NULL) \
287 (step).i_inm = LIST_NEXT((step).i_inm, inm_link); \
288 } while(0)
289
290 #define IN_FIRST_MULTI(step, inm) \
291 /* struct in_multistep step; */ \
292 /* struct in_multi *inm; */ \
293 do { \
294 IN_MULTI_LOCK_ASSERT(); \
295 (step).i_inm = LIST_FIRST(&V_in_multihead); \
296 IN_NEXT_MULTI((step), (inm)); \
297 } while(0)
298
299 struct rtentry;
300 struct route;
301 struct ip_moptions;
302
303 size_t imo_match_group(struct ip_moptions *, struct ifnet *,
304 struct sockaddr *);
305 struct in_msource *imo_match_source(struct ip_moptions *, size_t,
306 struct sockaddr *);
307 struct in_multi *in_addmulti(struct in_addr *, struct ifnet *);
308 void in_delmulti(struct in_multi *);
309 void in_delmulti_locked(struct in_multi *);
310 int in_control(struct socket *, u_long, caddr_t, struct ifnet *,
311 struct thread *);
312 void in_rtqdrain(void);
313 void ip_input(struct mbuf *);
314 int in_ifadown(struct ifaddr *ifa, int);
315 void in_ifscrub(struct ifnet *, struct in_ifaddr *);
316 struct mbuf *ip_fastforward(struct mbuf *);
317
318 /* XXX */
319 void in_rtalloc_ign(struct route *ro, u_long ignflags, u_int fibnum);
320 void in_rtalloc(struct route *ro, u_int fibnum);
321 struct rtentry *in_rtalloc1(struct sockaddr *, int, u_long, u_int);
322 void in_rtredirect(struct sockaddr *, struct sockaddr *,
323 struct sockaddr *, int, struct sockaddr *, u_int);
324 int in_rtrequest(int, struct sockaddr *,
325 struct sockaddr *, struct sockaddr *, int, struct rtentry **, u_int);
326
327 #if 0
328 int in_rt_getifa(struct rt_addrinfo *, u_int fibnum);
329 int in_rtioctl(u_long, caddr_t, u_int);
330 int in_rtrequest1(int, struct rt_addrinfo *, struct rtentry **, u_int);
331 #endif
332 #endif /* _KERNEL */
333
334 /* INET6 stuff */
335 #include <netinet6/in6_var.h>
336
337 #endif /* _NETINET_IN_VAR_H_ */
338
|