2 * Copyright (c) 2000-2004 Apple Computer, Inc. All rights reserved.
4 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
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.
15 * Please obtain a copy of the License at
16 * http://www.opensource.apple.com/apsl/ and read it before using this file.
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
20 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
21 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
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.
26 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
29 * Copyright (c) 1982, 1986, 1989, 1993
30 * The Regents of the University of California. All rights reserved.
32 * Redistribution and use in source and binary forms, with or without
33 * modification, are permitted provided that the following conditions
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.
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
60 * @(#)if.h 8.1 (Berkeley) 6/10/93
61 * $FreeBSD: src/sys/net/if.h,v 1.58.2.2 2001/07/24 19:10:18 brooks Exp $
67 #include <sys/cdefs.h>
69 #define IF_NAMESIZE 16
71 #if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
72 #include <sys/appleapiopts.h>
75 * Define Data-Link event subclass, and associated
79 #define KEV_DL_SUBCLASS 2
81 #define KEV_DL_SIFFLAGS 1
82 #define KEV_DL_SIFMETRICS 2
83 #define KEV_DL_SIFMTU 3
84 #define KEV_DL_SIFPHYS 4
85 #define KEV_DL_SIFMEDIA 5
86 #define KEV_DL_SIFGENERIC 6
87 #define KEV_DL_ADDMULTI 7
88 #define KEV_DL_DELMULTI 8
89 #define KEV_DL_IF_ATTACHED 9
90 #define KEV_DL_IF_DETACHING 10
91 #define KEV_DL_IF_DETACHED 11
92 #define KEV_DL_LINK_OFF 12
93 #define KEV_DL_LINK_ON 13
94 #define KEV_DL_PROTO_ATTACHED 14
95 #define KEV_DL_PROTO_DETACHED 15
96 #define KEV_DL_LINK_ADDRESS_CHANGED 16
98 #include <net/if_var.h>
99 #include <sys/types.h>
102 #ifdef KERNEL_PRIVATE
104 int ifcr_total
; /* total cloners (out) */
105 int ifcr_count
; /* room for this many in user buffer */
106 char *ifcr_buffer
; /* buffer for cloner names */
109 /* in-kernel, LP64-aware version of if_clonereq. all pointers
110 * grow when we're dealing with a 64-bit process.
111 * WARNING - keep in sync with if_clonereq
113 struct if_clonereq64
{
114 int ifcr_total
; /* total cloners (out) */
115 int ifcr_count
; /* room for this many in user buffer */
117 u_int64_t ifcru_buffer64
;
118 char * ifcru_buffer32
;
121 #endif KERNEL_PRIVATE
123 #define IFF_UP 0x1 /* interface is up */
124 #define IFF_BROADCAST 0x2 /* broadcast address valid */
125 #define IFF_DEBUG 0x4 /* turn on debugging */
126 #define IFF_LOOPBACK 0x8 /* is a loopback net */
127 #define IFF_POINTOPOINT 0x10 /* interface is point-to-point link */
128 #define IFF_NOTRAILERS 0x20 /* obsolete: avoid use of trailers */
129 #define IFF_RUNNING 0x40 /* resources allocated */
130 #define IFF_NOARP 0x80 /* no address resolution protocol */
131 #define IFF_PROMISC 0x100 /* receive all packets */
132 #define IFF_ALLMULTI 0x200 /* receive all multicast packets */
133 #define IFF_OACTIVE 0x400 /* transmission in progress */
134 #define IFF_SIMPLEX 0x800 /* can't hear own transmissions */
135 #define IFF_LINK0 0x1000 /* per link layer defined bit */
136 #define IFF_LINK1 0x2000 /* per link layer defined bit */
137 #define IFF_LINK2 0x4000 /* per link layer defined bit */
138 #define IFF_ALTPHYS IFF_LINK2 /* use alternate physical connection */
139 #define IFF_MULTICAST 0x8000 /* supports multicast */
141 #ifdef KERNEL_PRIVATE
142 /* extended flags definitions: (all bits are reserved for internal/future use) */
143 #define IFEF_AUTOCONFIGURING 0x1
144 #define IFEF_DVR_REENTRY_OK 0x20 /* When set, driver may be reentered from its own thread */
145 #define IFEF_ACCEPT_RTADVD 0x40 /* set to accept IPv6 router advertisement on the interface */
146 #define IFEF_DETACHING 0x80 /* Set when interface is detaching */
147 #define IFEF_USEKPI 0x100 /* Set when interface is created through the KPIs */
148 #define IFEF_VLAN 0x200 /* interface has one or more vlans */
149 #define IFEF_BOND 0x400 /* interface is part of bond */
150 #define IFEF_ARPLL 0x800 /* ARP for IPv4LL addresses on this port */
151 #define IFEF_SENDLIST 0x10000000 /* Interface supports sending a list of packets */
152 #define IFEF_REUSE 0x20000000 /* DLIL ifnet recycler, ifnet is not new */
153 #define IFEF_INUSE 0x40000000 /* DLIL ifnet recycler, ifnet in use */
154 #define IFEF_UPDOWNCHANGE 0x80000000 /* Interface's up/down state is changing */
156 /* flags set internally only: */
157 #define IFF_CANTCHANGE \
158 (IFF_BROADCAST|IFF_POINTOPOINT|IFF_RUNNING|IFF_OACTIVE|\
159 IFF_SIMPLEX|IFF_MULTICAST|IFF_ALLMULTI)
161 #endif /* KERNEL_PRIVATE */
163 #define IFQ_MAXLEN 50
164 #define IFNET_SLOWHZ 1 /* granularity is 1 second */
167 * Message format for use in obtaining information about interfaces
168 * from sysctl and the routing socket
171 unsigned short ifm_msglen
; /* to skip over non-understood messages */
172 unsigned char ifm_version
; /* future binary compatability */
173 unsigned char ifm_type
; /* message type */
174 int ifm_addrs
; /* like rtm_addrs */
175 int ifm_flags
; /* value of if_flags */
176 unsigned short ifm_index
; /* index for associated ifp */
177 struct if_data ifm_data
; /* statistics and other data about if */
181 * Message format for use in obtaining information about interface addresses
182 * from sysctl and the routing socket
185 unsigned short ifam_msglen
; /* to skip over non-understood messages */
186 unsigned char ifam_version
; /* future binary compatability */
187 unsigned char ifam_type
; /* message type */
188 int ifam_addrs
; /* like rtm_addrs */
189 int ifam_flags
; /* value of ifa_flags */
190 unsigned short ifam_index
; /* index for associated ifp */
191 int ifam_metric
; /* value of ifa_metric */
195 * Message format for use in obtaining information about multicast addresses
196 * from the routing socket
199 unsigned short ifmam_msglen
; /* to skip over non-understood messages */
200 unsigned char ifmam_version
; /* future binary compatability */
201 unsigned char ifmam_type
; /* message type */
202 int ifmam_addrs
; /* like rtm_addrs */
203 int ifmam_flags
; /* value of ifa_flags */
204 unsigned short ifmam_index
; /* index for associated ifp */
208 * Message format for use in obtaining information about interfaces
212 u_short ifm_msglen
; /* to skip over non-understood messages */
213 u_char ifm_version
; /* future binary compatability */
214 u_char ifm_type
; /* message type */
215 int ifm_addrs
; /* like rtm_addrs */
216 int ifm_flags
; /* value of if_flags */
217 u_short ifm_index
; /* index for associated ifp */
218 int ifm_snd_len
; /* instantaneous length of send queue */
219 int ifm_snd_maxlen
; /* maximum length of send queue */
220 int ifm_snd_drops
; /* number of drops in send queue */
221 int ifm_timer
; /* time until if_watchdog called */
222 struct if_data64 ifm_data
; /* statistics and other data about if */
226 * Message format for use in obtaining information about multicast addresses
229 struct ifma_msghdr2
{
230 u_short ifmam_msglen
; /* to skip over non-understood messages */
231 u_char ifmam_version
; /* future binary compatability */
232 u_char ifmam_type
; /* message type */
233 int ifmam_addrs
; /* like rtm_addrs */
234 int ifmam_flags
; /* value of ifa_flags */
235 u_short ifmam_index
; /* index for associated ifp */
236 int32_t ifmam_refcount
;
240 * ifdevmtu: interface device mtu
241 * Used with SIOCGIFDEVMTU to get the current mtu in use by the device,
242 * as well as the minimum and maximum mtu allowed by the device.
253 ifkpi: interface kpi ioctl
254 Used with SIOCSIFKPI and SIOCGIFKPI.
256 ifk_module_id - From in the kernel, a value from kev_vendor_code_find. From
257 user space, a value from SIOCGKEVVENDOR ioctl on a kernel event socket.
258 ifk_type - The type. Types are specific to each module id.
259 ifk_data - The data. ifk_ptr may be a 64bit pointer for 64 bit processes.
261 Copying data between user space and kernel space is done using copyin
262 and copyout. A process may be running in 64bit mode. In such a case,
263 the pointer will be a 64bit pointer, not a 32bit pointer. The following
264 sample is a safe way to copy the data in to the kernel from either a
265 32bit or 64bit process:
268 if (IS_64BIT_PROCESS(current_proc())) {
269 tmp_ptr = CAST_USER_ADDR_T(ifkpi.ifk_data.ifk_ptr64);
272 tmp_ptr = CAST_USER_ADDR_T(ifkpi.ifk_data.ifk_ptr);
274 error = copyin(tmp_ptr, allocated_dst_buffer, size of allocated_dst_buffer);
278 unsigned int ifk_module_id
;
279 unsigned int ifk_type
;
292 * Interface request structure used for socket
293 * ioctl's. All interface ioctl's must have parameter
294 * definitions which begin with ifr_name. The
295 * remainder may be interface specific.
299 #define IFNAMSIZ IF_NAMESIZE
301 char ifr_name
[IFNAMSIZ
]; /* if name, e.g. "en0" */
303 struct sockaddr ifru_addr
;
304 struct sockaddr ifru_dstaddr
;
305 struct sockaddr ifru_broadaddr
;
313 #ifdef KERNEL_PRIVATE
314 u_int64_t ifru_data64
; /* 64-bit ifru_data */
315 #endif KERNEL_PRIVATE
316 struct ifdevmtu ifru_devmtu
;
317 struct ifkpi ifru_kpi
;
319 #define ifr_addr ifr_ifru.ifru_addr /* address */
320 #define ifr_dstaddr ifr_ifru.ifru_dstaddr /* other end of p-to-p link */
321 #define ifr_broadaddr ifr_ifru.ifru_broadaddr /* broadcast address */
323 #define ifr_flags ifr_ifru.ifru_flags /* flags */
325 #define ifr_flags ifr_ifru.ifru_flags[0] /* flags */
326 #define ifr_prevflags ifr_ifru.ifru_flags[1] /* flags */
327 #endif /* __APPLE__ */
328 #define ifr_metric ifr_ifru.ifru_metric /* metric */
329 #define ifr_mtu ifr_ifru.ifru_mtu /* mtu */
330 #define ifr_phys ifr_ifru.ifru_phys /* physical wire */
331 #define ifr_media ifr_ifru.ifru_media /* physical media */
332 #define ifr_data ifr_ifru.ifru_data /* for use by interface */
333 #define ifr_devmtu ifr_ifru.ifru_devmtu
334 #define ifr_intval ifr_ifru.ifru_intval /* integer value */
335 #ifdef KERNEL_PRIVATE
336 #define ifr_data64 ifr_ifru.ifru_data64 /* 64-bit pointer */
337 #endif KERNEL_PRIVATE
338 #define ifr_kpi ifr_ifru.ifru_kpi
341 #define _SIZEOF_ADDR_IFREQ(ifr) \
342 ((ifr).ifr_addr.sa_len > sizeof(struct sockaddr) ? \
343 (sizeof(struct ifreq) - sizeof(struct sockaddr) + \
344 (ifr).ifr_addr.sa_len) : sizeof(struct ifreq))
347 char ifra_name
[IFNAMSIZ
]; /* if name, e.g. "en0" */
348 struct sockaddr ifra_addr
;
349 struct sockaddr ifra_broadaddr
;
350 struct sockaddr ifra_mask
;
353 struct rslvmulti_req
{
355 struct sockaddr
**llsa
;
361 char ifm_name
[IFNAMSIZ
]; /* if name, e.g. "en0" */
362 int ifm_current
; /* current media options */
363 int ifm_mask
; /* don't care mask */
364 int ifm_status
; /* media status */
365 int ifm_active
; /* active options */
366 int ifm_count
; /* # entries in ifm_ulist array */
367 int *ifm_ulist
; /* media words */
372 #ifdef KERNEL_PRIVATE
373 /* LP64 version of ifmediareq. all pointers
374 * grow when we're dealing with a 64-bit process.
375 * WARNING - keep in sync with ifmediareq
377 struct ifmediareq64
{
378 char ifm_name
[IFNAMSIZ
]; /* if name, e.g. "en0" */
379 int ifm_current
; /* current media options */
380 int ifm_mask
; /* don't care mask */
381 int ifm_status
; /* media status */
382 int ifm_active
; /* active options */
383 int ifm_count
; /* # entries in ifm_ulist array */
384 union { /* media words */
385 int * ifmu_ulist32
; /* 32-bit pointer */
386 u_int64_t ifmu_ulist64
; /* 64-bit pointer */
389 #endif // KERNEL_PRIVATE
392 * Structure used to retrieve aux status data from interfaces.
393 * Kernel suppliers to this interface should respect the formatting
394 * needed by ifconfig(8): each line starts with a TAB and ends with
395 * a newline. The canonical example to copy and paste is in if_tun.c.
398 #define IFSTATMAX 800 /* 10 lines of text */
400 char ifs_name
[IFNAMSIZ
]; /* if name, e.g. "en0" */
401 char ascii
[IFSTATMAX
+ 1];
407 * Structure used in SIOCGIFCONF request.
408 * Used to retrieve interface configuration
409 * for machine (useful for programs which
410 * must know all networks accessible).
413 int ifc_len
; /* size of associated buffer */
416 struct ifreq
*ifcu_req
;
419 #define ifc_buf ifc_ifcu.ifcu_buf /* buffer address */
420 #define ifc_req ifc_ifcu.ifcu_req /* array of structures returned */
424 #ifdef KERNEL_PRIVATE
425 /* LP64 version of ifconf. all pointers
426 * grow when we're dealing with a 64-bit process.
427 * WARNING - keep in sync with ifconf
430 int ifc_len
; /* size of associated buffer */
432 struct ifreq
* ifcu_req
;
433 u_int64_t ifcu_req64
;
436 #define ifc_req64 ifc_ifcu.ifcu_req64
437 #endif // KERNEL_PRIVATE
440 * DLIL KEV_DL_PROTO_ATTACHED/DETACHED structure
442 struct kev_dl_proto_data
{
443 struct net_event_data link_data
;
444 u_int32_t proto_family
;
445 u_int32_t proto_remaining_count
;
449 * Structure for SIOC[AGD]LIFADDR
452 char iflr_name
[IFNAMSIZ
];
454 #define IFLR_PREFIX 0x8000 /* in: prefix given out: kernel fills id */
455 unsigned int prefixlen
; /* in/out */
456 struct sockaddr_storage addr
; /* in/out */
457 struct sockaddr_storage dstaddr
; /* out */
461 #ifdef MALLOC_DECLARE
462 MALLOC_DECLARE(M_IFADDR
);
463 MALLOC_DECLARE(M_IFMADDR
);
466 #endif /* (_POSIX_C_SOURCE && !_DARWIN_C_SOURCE) */
469 struct if_nameindex
{
470 unsigned int if_index
; /* 1, 2, ... */
471 char *if_name
; /* null terminated name: "le0", ... */
475 unsigned int if_nametoindex(const char *);
476 char *if_indextoname(unsigned int, char *);
477 struct if_nameindex
*if_nameindex(void);
478 void if_freenameindex(struct if_nameindex
*);
483 #include <net/kpi_interface.h>
486 #endif /* !_NET_IF_H_ */