]> git.saurik.com Git - apple/xnu.git/blame - bsd/netinet/in_var.h
xnu-1228.12.14.tar.gz
[apple/xnu.git] / bsd / netinet / in_var.h
CommitLineData
1c79356b 1/*
c910b4d9 2 * Copyright (c) 2000-2008 Apple Inc. All rights reserved.
5d5c5d0d 3 *
2d21ac55 4 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
1c79356b 5 *
2d21ac55
A
6 * This file contains Original Code and/or Modifications of Original Code
7 * as defined in and that are subject to the Apple Public Source License
8 * Version 2.0 (the 'License'). You may not use this file except in
9 * compliance with the License. The rights granted to you under the License
10 * may not be used to create, or enable the creation or redistribution of,
11 * unlawful or unlicensed copies of an Apple operating system, or to
12 * circumvent, violate, or enable the circumvention or violation of, any
13 * terms of an Apple operating system software license agreement.
8f6c56a5 14 *
2d21ac55
A
15 * Please obtain a copy of the License at
16 * http://www.opensource.apple.com/apsl/ and read it before using this file.
17 *
18 * The Original Code and all software distributed under the License are
19 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
8f6c56a5
A
20 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
21 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
2d21ac55
A
22 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
23 * Please see the License for the specific language governing rights and
24 * limitations under the License.
8f6c56a5 25 *
2d21ac55 26 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
1c79356b
A
27 */
28/*
29 * Copyright (c) 1985, 1986, 1993
30 * The Regents of the University of California. All rights reserved.
31 *
32 * Redistribution and use in source and binary forms, with or without
33 * modification, are permitted provided that the following conditions
34 * are met:
35 * 1. Redistributions of source code must retain the above copyright
36 * notice, this list of conditions and the following disclaimer.
37 * 2. Redistributions in binary form must reproduce the above copyright
38 * notice, this list of conditions and the following disclaimer in the
39 * documentation and/or other materials provided with the distribution.
40 * 3. All advertising materials mentioning features or use of this software
41 * must display the following acknowledgement:
42 * This product includes software developed by the University of
43 * California, Berkeley and its contributors.
44 * 4. Neither the name of the University nor the names of its contributors
45 * may be used to endorse or promote products derived from this software
46 * without specific prior written permission.
47 *
48 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
49 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
50 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
51 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
52 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
53 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
54 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
55 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
56 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
57 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
58 * SUCH DAMAGE.
59 *
60 * @(#)in_var.h 8.2 (Berkeley) 1/9/95
9bccf70c 61 * $FreeBSD: src/sys/netinet/in_var.h,v 1.33.2.2 2001/07/17 10:50:01 ru Exp $
1c79356b
A
62 */
63
64#ifndef _NETINET_IN_VAR_H_
65#define _NETINET_IN_VAR_H_
9bccf70c 66#include <sys/appleapiopts.h>
1c79356b
A
67
68#include <sys/queue.h>
9bccf70c 69#ifdef __APPLE__
1c79356b 70#include <sys/kern_event.h>
9bccf70c
A
71#endif
72
91447636 73#ifdef PRIVATE
2d21ac55 74#include <net/route.h>
1c79356b
A
75
76/*
77 * Interface address, Internet version. One of these structures
78 * is allocated for each Internet address on an interface.
79 * The ifaddr structure contains the protocol-independent part
80 * of the structure and is assumed to be first.
81 */
82struct in_ifaddr {
2d21ac55
A
83 struct ifaddr ia_ifa; /* protocol-independent info */
84#define ia_ifp ia_ifa.ifa_ifp
85#define ia_flags ia_ifa.ifa_flags
86 /* ia_{,sub}net{,mask} in host order */
87 u_long ia_net; /* network number of interface */
88 u_long ia_netmask; /* mask of net part */
89 u_long ia_subnet; /* subnet number, including net */
90 u_long ia_subnetmask; /* mask of subnet part */
91 struct in_addr ia_netbroadcast; /* to recognize net broadcasts */
92 TAILQ_ENTRY(in_ifaddr) ia_link; /* tailq macro glue */
93 struct sockaddr_in ia_addr; /* reserve space for interface name */
94 struct sockaddr_in ia_dstaddr; /* reserve space for broadcast addr */
95#define ia_broadaddr ia_dstaddr
96 struct sockaddr_in ia_sockmask; /* reserve space for general netmask */
1c79356b 97};
91447636 98#endif /* PRIVATE */
1c79356b
A
99
100struct in_aliasreq {
2d21ac55
A
101 char ifra_name[IFNAMSIZ]; /* if name, e.g. "en0" */
102 struct sockaddr_in ifra_addr;
103 struct sockaddr_in ifra_broadaddr;
104#define ifra_dstaddr ifra_broadaddr
105 struct sockaddr_in ifra_mask;
106 u_int32_t ifra_unused; /* not used: used to be 'dlt' */
1c79356b
A
107};
108
1c79356b
A
109/*
110 * Event data, internet style.
111 */
1c79356b 112struct kev_in_data {
55e303ae 113 struct net_event_data link_data;
2d21ac55
A
114 struct in_addr ia_addr;
115 u_int32_t ia_net; /* network number of interface */
116 u_int32_t ia_netmask; /* mask of net part */
117 u_int32_t ia_subnet; /* subnet number, including net */
118 u_int32_t ia_subnetmask; /* mask of subnet part */
119 struct in_addr ia_netbroadcast;/* to recognize net broadcasts */
120 struct in_addr ia_dstaddr;
1c79356b
A
121};
122
90556fb8 123struct kev_in_collision {
2d21ac55
A
124 struct net_event_data link_data; /* link colliding arp was received on */
125 struct in_addr ia_ipaddr; /* IP address we and another node are using */
126 u_char hw_len; /* length of hardware address */
127 u_char hw_addr[0]; /* variable length hardware address */
128};
129
130#ifdef __APPLE_API_PRIVATE
131struct kev_in_portinuse {
132 u_int16_t port; /* conflicting port number in host order */
133 u_int32_t req_pid; /* PID port requestor */
134 u_int32_t reserved[2];
90556fb8 135};
2d21ac55 136#endif
90556fb8 137
1c79356b 138
1c79356b
A
139/*
140 * Define inet event subclass and specific inet events.
141 */
142
143#define KEV_INET_SUBCLASS 1
144
145#define KEV_INET_NEW_ADDR 1
146#define KEV_INET_CHANGED_ADDR 2
147#define KEV_INET_ADDR_DELETED 3
148#define KEV_INET_SIFDSTADDR 4
149#define KEV_INET_SIFBRDADDR 5
150#define KEV_INET_SIFNETMASK 6
90556fb8 151#define KEV_INET_ARPCOLLISION 7 /* use kev_in_collision */
1c79356b 152
2d21ac55
A
153#ifdef __APPLE_API_PRIVATE
154#define KEV_INET_PORTINUSE 8 /* use ken_in_portinuse */
155#endif
156
91447636 157#ifdef KERNEL_PRIVATE
1c79356b
A
158/*
159 * Given a pointer to an in_ifaddr (ifaddr),
160 * return a pointer to the addr as a sockaddr_in.
161 */
162#define IA_SIN(ia) (&(((struct in_ifaddr *)(ia))->ia_addr))
163#define IA_DSTSIN(ia) (&(((struct in_ifaddr *)(ia))->ia_dstaddr))
164
165#define IN_LNAOF(in, ifa) \
166 ((ntohl((in).s_addr) & ~((struct in_ifaddr *)(ifa)->ia_subnetmask))
167
1c79356b
A
168extern TAILQ_HEAD(in_ifaddrhead, in_ifaddr) in_ifaddrhead;
169extern struct ifqueue ipintrq; /* ip packet input queue */
170extern struct in_addr zeroin_addr;
171extern u_char inetctlerrmap[];
91447636 172extern lck_mtx_t *rt_mtx;
1c79356b 173
2d21ac55
A
174extern int apple_hwcksum_tx;
175extern int apple_hwcksum_rx;
176
1c79356b
A
177/*
178 * Macro for finding the interface (ifnet structure) corresponding to one
179 * of our IP addresses.
180 */
181#define INADDR_TO_IFP(addr, ifp) \
182 /* struct in_addr addr; */ \
183 /* struct ifnet *ifp; */ \
184{ \
9bccf70c 185 struct in_ifaddr *ia; \
1c79356b 186\
91447636
A
187 lck_mtx_assert(rt_mtx, LCK_MTX_ASSERT_NOTOWNED); \
188 lck_mtx_lock(rt_mtx); \
9bccf70c
A
189 TAILQ_FOREACH(ia, &in_ifaddrhead, ia_link) \
190 if (IA_SIN(ia)->sin_addr.s_addr == (addr).s_addr) \
191 break; \
1c79356b 192 (ifp) = (ia == NULL) ? NULL : ia->ia_ifp; \
91447636 193 lck_mtx_unlock(rt_mtx); \
1c79356b
A
194}
195
196/*
197 * Macro for finding the internet address structure (in_ifaddr) corresponding
198 * to a given interface (ifnet structure).
199 */
200#define IFP_TO_IA(ifp, ia) \
201 /* struct ifnet *ifp; */ \
202 /* struct in_ifaddr *ia; */ \
203{ \
91447636
A
204 lck_mtx_assert(rt_mtx, LCK_MTX_ASSERT_NOTOWNED); \
205 lck_mtx_lock(rt_mtx); \
9bccf70c 206 for ((ia) = TAILQ_FIRST(&in_ifaddrhead); \
1c79356b 207 (ia) != NULL && (ia)->ia_ifp != (ifp); \
9bccf70c 208 (ia) = TAILQ_NEXT((ia), ia_link)) \
1c79356b 209 continue; \
91447636 210 lck_mtx_unlock(rt_mtx); \
1c79356b 211}
1c79356b
A
212
213/*
214 * This information should be part of the ifnet structure but we don't wish
215 * to change that - as it might break a number of things
216 */
217
218struct router_info {
219 struct ifnet *rti_ifp;
220 int rti_type; /* type of router which is querier on this interface */
221 int rti_time; /* # of slow timeouts since last old query */
222 struct router_info *rti_next;
223};
224
225/*
226 * Internet multicast address structure. There is one of these for each IP
227 * multicast group to which this host belongs on a given network interface.
228 * For every entry on the interface's if_multiaddrs list which represents
229 * an IP multicast group, there is one of these structures. They are also
230 * kept on a system-wide list to make it easier to keep our legacy IGMP code
231 * compatible with the rest of the world (see IN_FIRST_MULTI et al, below).
232 */
233struct in_multi {
234 LIST_ENTRY(in_multi) inm_link; /* queue macro glue */
235 struct in_addr inm_addr; /* IP multicast address, convenience */
236 struct ifnet *inm_ifp; /* back pointer to ifnet */
237 struct ifmultiaddr *inm_ifma; /* back pointer to ifmultiaddr */
238 u_int inm_timer; /* IGMP membership report timer */
239 u_int inm_state; /* state of the membership */
240 struct router_info *inm_rti; /* router info*/
241};
1c79356b
A
242
243#ifdef SYSCTL_DECL
244SYSCTL_DECL(_net_inet_ip);
245SYSCTL_DECL(_net_inet_raw);
246#endif
247
248extern LIST_HEAD(in_multihead, in_multi) in_multihead;
249
250/*
251 * Structure used by macros below to remember position when stepping through
252 * all of the in_multi records.
253 */
254struct in_multistep {
255 struct in_multi *i_inm;
256};
257
258/*
259 * Macro for looking up the in_multi record for a given IP multicast address
260 * on a given interface. If no matching record is found, "inm" is set null.
261 */
262#define IN_LOOKUP_MULTI(addr, ifp, inm) \
263 /* struct in_addr addr; */ \
264 /* struct ifnet *ifp; */ \
265 /* struct in_multi *inm; */ \
266do { \
9bccf70c 267 struct ifmultiaddr *ifma; \
1c79356b 268\
9bccf70c 269 LIST_FOREACH(ifma, &((ifp)->if_multiaddrs), ifma_link) { \
1c79356b
A
270 if (ifma->ifma_addr->sa_family == AF_INET \
271 && ((struct sockaddr_in *)ifma->ifma_addr)->sin_addr.s_addr == \
272 (addr).s_addr) \
273 break; \
274 } \
2d21ac55 275 (inm) = ifma ? ifma->ifma_protospec : NULL; \
1c79356b
A
276} while(0)
277
278/*
279 * Macro to step through all of the in_multi records, one at a time.
280 * The current position is remembered in "step", which the caller must
281 * provide. IN_FIRST_MULTI(), below, must be called to initialize "step"
282 * and get the first record. Both macros return a NULL "inm" when there
283 * are no remaining records.
284 */
285#define IN_NEXT_MULTI(step, inm) \
286 /* struct in_multistep step; */ \
287 /* struct in_multi *inm; */ \
288do { \
289 if (((inm) = (step).i_inm) != NULL) \
9bccf70c 290 (step).i_inm = LIST_NEXT((step).i_inm, inm_link); \
1c79356b
A
291} while(0)
292
293#define IN_FIRST_MULTI(step, inm) \
294 /* struct in_multistep step; */ \
295 /* struct in_multi *inm; */ \
296do { \
9bccf70c 297 (step).i_inm = LIST_FIRST(&in_multihead); \
1c79356b
A
298 IN_NEXT_MULTI((step), (inm)); \
299} while(0)
300
301struct route;
91447636
A
302struct in_multi *in_addmulti(struct in_addr *, struct ifnet *);
303void in_delmulti(struct in_multi **);
304int in_control(struct socket *, u_long, caddr_t, struct ifnet *,
305 struct proc *);
306void in_rtqdrain(void);
c910b4d9 307extern struct radix_node *in_validate(struct radix_node *);
91447636
A
308void ip_input(struct mbuf *);
309int in_ifadown(struct ifaddr *ifa, int);
310void in_ifscrub(struct ifnet *, struct in_ifaddr *, int);
311int ipflow_fastforward(struct mbuf *);
312void ipflow_create(const struct route *, struct mbuf *);
313void ipflow_slowtimo(void);
1c79356b 314
91447636 315#endif /* KERNEL_PRIVATE */
9bccf70c 316
1c79356b
A
317/* INET6 stuff */
318#include <netinet6/in6_var.h>
1c79356b
A
319
320#endif /* _NETINET_IN_VAR_H_ */