2 * Copyright (c) 1985, 1986, 1993
3 * The Regents of the University of California. All rights reserved.
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
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.
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
29 * @(#)in_var.h 8.2 (Berkeley) 1/9/95
33 #ifndef _NETINET_IN_VAR_H_
34 #define _NETINET_IN_VAR_H_
36 #include <sys/queue.h>
37 #include <sys/fnv_hash.h>
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.
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 */
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;
71 * Given a pointer to an in_ifaddr (ifaddr),
72 * return a pointer to the addr as a sockaddr_in.
74 #define IA_SIN(ia) (&(((struct in_ifaddr *)(ia))->ia_addr))
75 #define IA_DSTSIN(ia) (&(((struct in_ifaddr *)(ia))->ia_dstaddr))
77 #define IN_LNAOF(in, ifa) \
78 ((ntohl((in).s_addr) & ~((struct in_ifaddr *)(ifa)->ia_subnetmask))
82 extern u_char inetctlerrmap[];
85 * Hash table for IP addresses.
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 */
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])
98 * Macro for finding the internet address structure (in_ifaddr)
99 * corresponding to one of our IP addresses (in_addr).
101 #define INADDR_TO_IFADDR(addr, ia) \
102 /* struct in_addr addr; */ \
103 /* struct in_ifaddr *ia; */ \
106 LIST_FOREACH(ia, INADDR_HASH((addr).s_addr), ia_hash) \
107 if (IA_SIN(ia)->sin_addr.s_addr == (addr).s_addr) \
112 * Macro for finding the interface (ifnet structure) corresponding to one
113 * of our IP addresses.
115 #define INADDR_TO_IFP(addr, ifp) \
116 /* struct in_addr addr; */ \
117 /* struct ifnet *ifp; */ \
119 struct in_ifaddr *ia; \
121 INADDR_TO_IFADDR(addr, ia); \
122 (ifp) = (ia == NULL) ? NULL : ia->ia_ifp; \
126 * Macro for finding the internet address structure (in_ifaddr) corresponding
127 * to a given interface (ifnet structure).
129 #define IFP_TO_IA(ifp, ia) \
130 /* struct ifnet *ifp; */ \
131 /* struct in_ifaddr *ia; */ \
133 for ((ia) = TAILQ_FIRST(&in_ifaddrhead); \
134 (ia) != NULL && (ia)->ia_ifp != (ifp); \
135 (ia) = TAILQ_NEXT((ia), ia_link)) \
141 * This information should be part of the ifnet structure but we don't wish
142 * to change that - as it might break a number of things
146 struct ifnet *rti_ifp;
147 int rti_type; /* type of router which is querier on this interface */
148 int rti_time; /* # of slow timeouts since last old query */
149 SLIST_ENTRY(router_info) rti_list;
151 int rti_timev1; /* IGMPv1 querier present */
152 int rti_timev2; /* IGMPv2 querier present */
153 int rti_timer; /* report to general query */
154 int rti_qrv; /* querier robustness */
159 * Internet multicast address structure. There is one of these for each IP
160 * multicast group to which this host belongs on a given network interface.
161 * For every entry on the interface's if_multiaddrs list which represents
162 * an IP multicast group, there is one of these structures. They are also
163 * kept on a system-wide list to make it easier to keep our legacy IGMP code
164 * compatible with the rest of the world (see IN_FIRST_MULTI et al, below).
167 LIST_ENTRY(in_multi) inm_link; /* queue macro glue */
168 struct in_addr inm_addr; /* IP multicast address, convenience */
169 struct ifnet *inm_ifp; /* back pointer to ifnet */
170 struct ifmultiaddr *inm_ifma; /* back pointer to ifmultiaddr */
171 u_int inm_timer; /* IGMP membership report timer */
172 u_int inm_state; /* state of the membership */
173 struct router_info *inm_rti; /* router info*/
174 u_int inm_refcount; /* reference count */
175 #ifdef notyet /* IGMPv3 source-specific multicast fields */
176 TAILQ_HEAD(, in_msfentry) inm_msf; /* all active source filters */
177 TAILQ_HEAD(, in_msfentry) inm_msf_record; /* recorded sources */
178 TAILQ_HEAD(, in_msfentry) inm_msf_exclude; /* exclude sources */
179 TAILQ_HEAD(, in_msfentry) inm_msf_include; /* include sources */
180 /* XXX: should this lot go to the router_info structure? */
181 /* XXX: can/should these be callouts? */
182 /* IGMP protocol timers */
183 int32_t inm_ti_curstate; /* current state timer */
184 int32_t inm_ti_statechg; /* state change timer */
185 /* IGMP report timers */
186 uint16_t inm_rpt_statechg; /* state change report timer */
187 uint16_t inm_rpt_toxx; /* fmode change report timer */
188 /* IGMP protocol state */
189 uint16_t inm_fmode; /* filter mode */
190 uint32_t inm_recsrc_count; /* # of recorded sources */
191 uint16_t inm_exclude_sock_count; /* # of exclude-mode sockets */
192 uint16_t inm_gass_count; /* # of g-a-s queries */
198 * Internet multicast source filter list. This list is used to store
199 * IP multicast source addresses for each membership on an interface.
200 * TODO: Allocate these structures using UMA.
201 * TODO: Find an easier way of linking the struct into two lists at once.
204 TAILQ_ENTRY(in_msfentry) isf_link; /* next filter in all-list */
205 TAILQ_ENTRY(in_msfentry) isf_next; /* next filter in queue */
206 struct in_addr isf_addr; /* the address of this source */
207 uint16_t isf_refcount; /* reference count */
208 uint16_t isf_reporttag; /* what to report to the IGMP router */
209 uint16_t isf_rexmit; /* retransmission state/count */
216 SYSCTL_DECL(_net_inet);
217 SYSCTL_DECL(_net_inet_ip);
218 SYSCTL_DECL(_net_inet_raw);
221 extern LIST_HEAD(in_multihead, in_multi) in_multihead;
224 * Lock macros for IPv4 layer multicast address lists. IPv4 lock goes
225 * before link layer multicast locks in the lock order. In most cases,
226 * consumers of IN_*_MULTI() macros should acquire the locks before
227 * calling them; users of the in_{add,del}multi() functions should not.
229 extern struct mtx in_multi_mtx;
230 #define IN_MULTI_LOCK() mtx_lock(&in_multi_mtx)
231 #define IN_MULTI_UNLOCK() mtx_unlock(&in_multi_mtx)
232 #define IN_MULTI_LOCK_ASSERT() mtx_assert(&in_multi_mtx, MA_OWNED)
235 * Structure used by macros below to remember position when stepping through
236 * all of the in_multi records.
238 struct in_multistep {
239 struct in_multi *i_inm;
243 * Macro for looking up the in_multi record for a given IP multicast address
244 * on a given interface. If no matching record is found, "inm" is set null.
246 #define IN_LOOKUP_MULTI(addr, ifp, inm) \
247 /* struct in_addr addr; */ \
248 /* struct ifnet *ifp; */ \
249 /* struct in_multi *inm; */ \
251 struct ifmultiaddr *ifma; \
253 IN_MULTI_LOCK_ASSERT(); \
255 TAILQ_FOREACH(ifma, &((ifp)->if_multiaddrs), ifma_link) { \
256 if (ifma->ifma_addr->sa_family == AF_INET \
257 && ((struct sockaddr_in *)ifma->ifma_addr)->sin_addr.s_addr == \
261 (inm) = ifma ? ifma->ifma_protospec : 0; \
262 IF_ADDR_UNLOCK(ifp); \
266 * Macro to step through all of the in_multi records, one at a time.
267 * The current position is remembered in "step", which the caller must
268 * provide. IN_FIRST_MULTI(), below, must be called to initialize "step"
269 * and get the first record. Both macros return a NULL "inm" when there
270 * are no remaining records.
272 #define IN_NEXT_MULTI(step, inm) \
273 /* struct in_multistep step; */ \
274 /* struct in_multi *inm; */ \
276 IN_MULTI_LOCK_ASSERT(); \
277 if (((inm) = (step).i_inm) != NULL) \
278 (step).i_inm = LIST_NEXT((step).i_inm, inm_link); \
281 #define IN_FIRST_MULTI(step, inm) \
282 /* struct in_multistep step; */ \
283 /* struct in_multi *inm; */ \
285 IN_MULTI_LOCK_ASSERT(); \
286 (step).i_inm = LIST_FIRST(&in_multihead); \
287 IN_NEXT_MULTI((step), (inm)); \
294 size_t imo_match_group(struct ip_moptions *, struct ifnet *,
296 struct in_msource *imo_match_source(struct ip_moptions *, size_t,
298 struct in_multi *in_addmulti(struct in_addr *, struct ifnet *);
299 void in_delmulti(struct in_multi *);
300 void in_delmulti_locked(struct in_multi *);
301 int in_control(struct socket *, u_long, caddr_t, struct ifnet *,
303 void in_rtqdrain(void);
304 void ip_input(struct mbuf *);
305 int in_ifadown(struct ifaddr *ifa, int);
306 void in_ifscrub(struct ifnet *, struct in_ifaddr *);
307 struct mbuf *ip_fastforward(struct mbuf *);
310 void in_rtalloc_ign(struct route *ro, u_long ignflags, u_int fibnum);
311 void in_rtalloc(struct route *ro, u_int fibnum);
312 struct rtentry *in_rtalloc1(struct sockaddr *, int, u_long, u_int);
313 void in_rtredirect(struct sockaddr *, struct sockaddr *,
314 struct sockaddr *, int, struct sockaddr *, u_int);
315 int in_rtrequest(int, struct sockaddr *,
316 struct sockaddr *, struct sockaddr *, int, struct rtentry **, u_int);
319 int in_rt_getifa(struct rt_addrinfo *, u_int fibnum);
320 int in_rtioctl(u_long, caddr_t, u_int);
321 int in_rtrequest1(int, struct rt_addrinfo *, struct rtentry **, u_int);
326 #include <netinet6/in6_var.h>
328 #endif /* _NETINET_IN_VAR_H_ */