]> git.saurik.com Git - apple/xnu.git/blame - bsd/net/if.h
xnu-344.12.2.tar.gz
[apple/xnu.git] / bsd / net / if.h
CommitLineData
1c79356b
A
1/*
2 * Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
3 *
4 * @APPLE_LICENSE_HEADER_START@
5 *
6 * The contents of this file constitute Original Code as defined in and
7 * are subject to the Apple Public Source License Version 1.1 (the
8 * "License"). You may not use this file except in compliance with the
9 * License. Please obtain a copy of the License at
10 * http://www.apple.com/publicsource and read it before using this file.
11 *
12 * This Original Code and all software distributed under the License are
13 * distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
14 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
15 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
16 * FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT. Please see the
17 * License for the specific language governing rights and limitations
18 * under the License.
19 *
20 * @APPLE_LICENSE_HEADER_END@
21 */
22/*
23 * Copyright (c) 1982, 1986, 1989, 1993
24 * The Regents of the University of California. All rights reserved.
25 *
26 * Redistribution and use in source and binary forms, with or without
27 * modification, are permitted provided that the following conditions
28 * are met:
29 * 1. Redistributions of source code must retain the above copyright
30 * notice, this list of conditions and the following disclaimer.
31 * 2. Redistributions in binary form must reproduce the above copyright
32 * notice, this list of conditions and the following disclaimer in the
33 * documentation and/or other materials provided with the distribution.
34 * 3. All advertising materials mentioning features or use of this software
35 * must display the following acknowledgement:
36 * This product includes software developed by the University of
37 * California, Berkeley and its contributors.
38 * 4. Neither the name of the University nor the names of its contributors
39 * may be used to endorse or promote products derived from this software
40 * without specific prior written permission.
41 *
42 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
43 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
44 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
45 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
46 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
47 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
48 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
49 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
50 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
51 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
52 * SUCH DAMAGE.
53 *
54 * @(#)if.h 8.1 (Berkeley) 6/10/93
9bccf70c 55 * $FreeBSD: src/sys/net/if.h,v 1.58.2.2 2001/07/24 19:10:18 brooks Exp $
1c79356b
A
56 */
57
58#ifndef _NET_IF_H_
59#define _NET_IF_H_
9bccf70c 60#include <sys/appleapiopts.h>
1c79356b 61
9bccf70c 62#ifdef __APPLE__
1c79356b
A
63/*
64 * Define Data-Link event subclass, and associated
65 * events.
66 */
67
68#define KEV_DL_SUBCLASS 2
69
70#define KEV_DL_SIFFLAGS 1
71#define KEV_DL_SIFMETRICS 2
72#define KEV_DL_SIFMTU 3
73#define KEV_DL_SIFPHYS 4
74#define KEV_DL_SIFMEDIA 5
75#define KEV_DL_SIFGENERIC 6
76#define KEV_DL_ADDMULTI 7
77#define KEV_DL_DELMULTI 8
78#define KEV_DL_IF_ATTACHED 9
79#define KEV_DL_IF_DETACHING 10
80#define KEV_DL_IF_DETACHED 11
81#define KEV_DL_LINK_OFF 12
82#define KEV_DL_LINK_ON 13
0b4e3aa0
A
83#define KEV_DL_PROTO_ATTACHED 14
84#define KEV_DL_PROTO_DETACHED 15
9bccf70c 85#endif
1c79356b
A
86
87/*
88 * <net/if.h> does not depend on <sys/time.h> on most other systems. This
89 * helps userland compatability. (struct timeval ifi_lastchange)
90 */
1c79356b 91#include <sys/time.h>
9bccf70c
A
92
93#ifdef __APPLE__
1c79356b 94#include <net/if_var.h>
9bccf70c 95#endif
1c79356b
A
96
97
98#define IFF_UP 0x1 /* interface is up */
99#define IFF_BROADCAST 0x2 /* broadcast address valid */
100#define IFF_DEBUG 0x4 /* turn on debugging */
101#define IFF_LOOPBACK 0x8 /* is a loopback net */
102#define IFF_POINTOPOINT 0x10 /* interface is point-to-point link */
103#define IFF_NOTRAILERS 0x20 /* obsolete: avoid use of trailers */
104#define IFF_RUNNING 0x40 /* resources allocated */
105#define IFF_NOARP 0x80 /* no address resolution protocol */
106#define IFF_PROMISC 0x100 /* receive all packets */
107#define IFF_ALLMULTI 0x200 /* receive all multicast packets */
108#define IFF_OACTIVE 0x400 /* transmission in progress */
109#define IFF_SIMPLEX 0x800 /* can't hear own transmissions */
110#define IFF_LINK0 0x1000 /* per link layer defined bit */
111#define IFF_LINK1 0x2000 /* per link layer defined bit */
112#define IFF_LINK2 0x4000 /* per link layer defined bit */
113#define IFF_ALTPHYS IFF_LINK2 /* use alternate physical connection */
114#define IFF_MULTICAST 0x8000 /* supports multicast */
1c79356b 115
9bccf70c 116#if KERNEL_PRIVATE
0b4e3aa0
A
117/* extended flags definitions: (all bits are reserved for internal/future use) */
118#define IFEF_AUTOCONFIGURING 0x1
1c79356b 119#define IFEF_DVR_REENTRY_OK 0x20 /* When set, driver may be reentered from its own thread */
9bccf70c
A
120#define IFEF_INUSE 0x40000000 /* DLIL ifnet recycler, ifnet in use */
121#define IFEF_REUSE 0x20000000 /* DLIL ifnet recycler, ifnet is not new */
0b4e3aa0 122#endif KERNEL_PRIVATE
1c79356b
A
123
124
125/* flags set internally only: */
126#define IFF_CANTCHANGE \
127 (IFF_BROADCAST|IFF_POINTOPOINT|IFF_RUNNING|IFF_OACTIVE|\
128 IFF_SIMPLEX|IFF_MULTICAST|IFF_ALLMULTI)
129
130#define IFQ_MAXLEN 50
131#define IFNET_SLOWHZ 1 /* granularity is 1 second */
132
133/*
134 * Message format for use in obtaining information about interfaces
135 * from getkerninfo and the routing socket
136 */
137struct if_msghdr {
138 u_short ifm_msglen; /* to skip over non-understood messages */
139 u_char ifm_version; /* future binary compatability */
140 u_char ifm_type; /* message type */
141 int ifm_addrs; /* like rtm_addrs */
142 int ifm_flags; /* value of if_flags */
143 u_short ifm_index; /* index for associated ifp */
144 struct if_data ifm_data;/* statistics and other data about if */
145};
146
147/*
148 * Message format for use in obtaining information about interface addresses
149 * from getkerninfo and the routing socket
150 */
151struct ifa_msghdr {
152 u_short ifam_msglen; /* to skip over non-understood messages */
153 u_char ifam_version; /* future binary compatability */
154 u_char ifam_type; /* message type */
155 int ifam_addrs; /* like rtm_addrs */
156 int ifam_flags; /* value of ifa_flags */
157 u_short ifam_index; /* index for associated ifp */
158 int ifam_metric; /* value of ifa_metric */
159};
160
161/*
162 * Message format for use in obtaining information about multicast addresses
163 * from the routing socket
164 */
165struct ifma_msghdr {
166 u_short ifmam_msglen; /* to skip over non-understood messages */
167 u_char ifmam_version; /* future binary compatability */
168 u_char ifmam_type; /* message type */
169 int ifmam_addrs; /* like rtm_addrs */
170 int ifmam_flags; /* value of ifa_flags */
171 u_short ifmam_index; /* index for associated ifp */
172};
173
174/*
175 * Interface request structure used for socket
176 * ioctl's. All interface ioctl's must have parameter
177 * definitions which begin with ifr_name. The
178 * remainder may be interface specific.
179 */
180#define IF_NAMESIZE IFNAMSIZ
181struct ifreq {
182#define IFNAMSIZ 16
183 char ifr_name[IFNAMSIZ]; /* if name, e.g. "en0" */
184 union {
185 struct sockaddr ifru_addr;
186 struct sockaddr ifru_dstaddr;
187 struct sockaddr ifru_broadaddr;
188 short ifru_flags;
189 int ifru_metric;
190 int ifru_mtu;
191 int ifru_phys;
192 int ifru_media;
193 caddr_t ifru_data;
194 } ifr_ifru;
195#define ifr_addr ifr_ifru.ifru_addr /* address */
196#define ifr_dstaddr ifr_ifru.ifru_dstaddr /* other end of p-to-p link */
197#define ifr_broadaddr ifr_ifru.ifru_broadaddr /* broadcast address */
9bccf70c 198#ifdef __APPLE__
1c79356b 199#define ifr_flags ifr_ifru.ifru_flags /* flags */
9bccf70c
A
200#else
201#define ifr_flags ifr_ifru.ifru_flags[0] /* flags */
202#define ifr_prevflags ifr_ifru.ifru_flags[1] /* flags */
203#endif /* __APPLE__ */
1c79356b
A
204#define ifr_metric ifr_ifru.ifru_metric /* metric */
205#define ifr_mtu ifr_ifru.ifru_mtu /* mtu */
206#define ifr_phys ifr_ifru.ifru_phys /* physical wire */
207#define ifr_media ifr_ifru.ifru_media /* physical media */
208#define ifr_data ifr_ifru.ifru_data /* for use by interface */
209};
210
211#define _SIZEOF_ADDR_IFREQ(ifr) \
212 ((ifr).ifr_addr.sa_len > sizeof(struct sockaddr) ? \
213 (sizeof(struct ifreq) - sizeof(struct sockaddr) + \
214 (ifr).ifr_addr.sa_len) : sizeof(struct ifreq))
215
216struct ifaliasreq {
217 char ifra_name[IFNAMSIZ]; /* if name, e.g. "en0" */
218 struct sockaddr ifra_addr;
219 struct sockaddr ifra_broadaddr;
220 struct sockaddr ifra_mask;
221};
222
223struct rslvmulti_req {
224 struct sockaddr *sa;
225 struct sockaddr **llsa;
226};
227
228struct ifmediareq {
229 char ifm_name[IFNAMSIZ]; /* if name, e.g. "en0" */
230 int ifm_current; /* current media options */
231 int ifm_mask; /* don't care mask */
232 int ifm_status; /* media status */
233 int ifm_active; /* active options */
234 int ifm_count; /* # entries in ifm_ulist array */
235 int *ifm_ulist; /* media words */
236};
9bccf70c
A
237
238/*
239 * Structure used to retrieve aux status data from interfaces.
240 * Kernel suppliers to this interface should respect the formatting
241 * needed by ifconfig(8): each line starts with a TAB and ends with
242 * a newline. The canonical example to copy and paste is in if_tun.c.
243 */
244
245#define IFSTATMAX 800 /* 10 lines of text */
246struct ifstat {
247 char ifs_name[IFNAMSIZ]; /* if name, e.g. "en0" */
248 char ascii[IFSTATMAX + 1];
249};
250
1c79356b
A
251/*
252 * Structure used in SIOCGIFCONF request.
253 * Used to retrieve interface configuration
254 * for machine (useful for programs which
255 * must know all networks accessible).
256 */
257struct ifconf {
258 int ifc_len; /* size of associated buffer */
259 union {
260 caddr_t ifcu_buf;
261 struct ifreq *ifcu_req;
262 } ifc_ifcu;
263#define ifc_buf ifc_ifcu.ifcu_buf /* buffer address */
264#define ifc_req ifc_ifcu.ifcu_req /* array of structures returned */
265};
266
9bccf70c
A
267#ifdef __APPLE__
268#ifdef __APPLE_API_UNSTABLE
0b4e3aa0
A
269/*
270 * DLIL KEV_DL_PROTO_ATTACHED/DETACHED structure
271 */
272struct kev_dl_proto_data {
273 struct net_event_data link_data;
274 u_long proto_family;
275 u_long proto_remaining_count;
276};
9bccf70c
A
277#endif /* __APPLE_API_UNSTABLE */
278#endif
0b4e3aa0
A
279
280
1c79356b
A
281/*
282 * Structure for SIOC[AGD]LIFADDR
283 */
284struct if_laddrreq {
9bccf70c
A
285 char iflr_name[IFNAMSIZ];
286 u_int flags;
287#define IFLR_PREFIX 0x8000 /* in: prefix given out: kernel fills id */
288 u_int prefixlen; /* in/out */
289 struct sockaddr_storage addr; /* in/out */
290 struct sockaddr_storage dstaddr; /* out */
1c79356b
A
291};
292
1c79356b
A
293#ifdef KERNEL
294#ifdef MALLOC_DECLARE
295MALLOC_DECLARE(M_IFADDR);
296MALLOC_DECLARE(M_IFMADDR);
297#endif
298#endif
299
300#ifndef KERNEL
9bccf70c
A
301struct if_nameindex {
302 u_int if_index; /* 1, 2, ... */
303 char *if_name; /* null terminated name: "le0", ... */
304};
305
1c79356b 306__BEGIN_DECLS
9bccf70c
A
307u_int if_nametoindex __P((const char *));
308char *if_indextoname __P((u_int, char *));
309struct if_nameindex *if_nameindex __P((void));
310void if_freenameindex __P((struct if_nameindex *));
1c79356b
A
311__END_DECLS
312#endif
313
1c79356b 314#ifdef KERNEL
9bccf70c
A
315#ifndef __APPLE__
316struct proc;
317
318int prison_if __P((struct proc *p, struct sockaddr *sa));
319#endif
320
1c79356b
A
321#endif
322
323#endif /* !_NET_IF_H_ */