/*
- * Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
+ * Copyright (c) 2000-2009 Apple Inc. All rights reserved.
*
- * @APPLE_LICENSE_HEADER_START@
+ * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
*
- * The contents of this file constitute Original Code as defined in and
- * are subject to the Apple Public Source License Version 1.1 (the
- * "License"). You may not use this file except in compliance with the
- * License. Please obtain a copy of the License at
- * http://www.apple.com/publicsource and read it before using this file.
+ * This file contains Original Code and/or Modifications of Original Code
+ * as defined in and that are subject to the Apple Public Source License
+ * Version 2.0 (the 'License'). You may not use this file except in
+ * compliance with the License. The rights granted to you under the License
+ * may not be used to create, or enable the creation or redistribution of,
+ * unlawful or unlicensed copies of an Apple operating system, or to
+ * circumvent, violate, or enable the circumvention or violation of, any
+ * terms of an Apple operating system software license agreement.
*
- * This Original Code and all software distributed under the License are
- * distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
+ * Please obtain a copy of the License at
+ * http://www.opensource.apple.com/apsl/ and read it before using this file.
+ *
+ * The Original Code and all software distributed under the License are
+ * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT. Please see the
- * License for the specific language governing rights and limitations
- * under the License.
+ * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
+ * Please see the License for the specific language governing rights and
+ * limitations under the License.
*
- * @APPLE_LICENSE_HEADER_END@
+ * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
*/
/*
* Copyright (c) 1982, 1986, 1989, 1993
* SUCH DAMAGE.
*
* @(#)if.h 8.1 (Berkeley) 6/10/93
+ * $FreeBSD: src/sys/net/if.h,v 1.58.2.2 2001/07/24 19:10:18 brooks Exp $
*/
#ifndef _NET_IF_H_
#define _NET_IF_H_
+#include <sys/cdefs.h>
+
+#define IF_NAMESIZE 16
+#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
+#include <sys/appleapiopts.h>
+#ifdef __APPLE__
/*
* Define Data-Link event subclass, and associated
* events.
#define KEV_DL_LINK_ON 13
#define KEV_DL_PROTO_ATTACHED 14
#define KEV_DL_PROTO_DETACHED 15
+#define KEV_DL_LINK_ADDRESS_CHANGED 16
+#define KEV_DL_WAKEFLAGS_CHANGED 17
+#define KEV_DL_IF_IDLE_ROUTE_REFCNT 18
-/*
- * <net/if.h> does not depend on <sys/time.h> on most other systems. This
- * helps userland compatability. (struct timeval ifi_lastchange)
- */
-
-#include <sys/time.h>
#include <net/if_var.h>
+#include <sys/types.h>
+#endif
+
+#ifdef KERNEL_PRIVATE
+#define IF_MAXUNIT 0x7fff /* historical value */
+
+struct if_clonereq {
+ int ifcr_total; /* total cloners (out) */
+ int ifcr_count; /* room for this many in user buffer */
+ char *ifcr_buffer; /* buffer for cloner names */
+};
+struct if_clonereq64 {
+ int ifcr_total; /* total cloners (out) */
+ int ifcr_count; /* room for this many in user buffer */
+ user64_addr_t ifcru_buffer __attribute__((aligned(8)));
+};
+
+struct if_clonereq32 {
+ int ifcr_total; /* total cloners (out) */
+ int ifcr_count; /* room for this many in user buffer */
+ user32_addr_t ifcru_buffer;
+};
+#endif /* KERNEL_PRIVATE */
#define IFF_UP 0x1 /* interface is up */
#define IFF_BROADCAST 0x2 /* broadcast address valid */
#define IFF_LINK2 0x4000 /* per link layer defined bit */
#define IFF_ALTPHYS IFF_LINK2 /* use alternate physical connection */
#define IFF_MULTICAST 0x8000 /* supports multicast */
-#define IFF_SPLITTER IFF_LINK2 /* Y splitter in force */
#ifdef KERNEL_PRIVATE
/* extended flags definitions: (all bits are reserved for internal/future use) */
#define IFEF_AUTOCONFIGURING 0x1
#define IFEF_DVR_REENTRY_OK 0x20 /* When set, driver may be reentered from its own thread */
-#define IFEF_DETACH_DISABLED 0x80000000
-#endif KERNEL_PRIVATE
+#define IFEF_ACCEPT_RTADVD 0x40 /* set to accept IPv6 router advertisement on the interface */
+#define IFEF_DETACHING 0x80 /* Set when interface is detaching */
+#define IFEF_USEKPI 0x100 /* Set when interface is created through the KPIs */
+#define IFEF_VLAN 0x200 /* interface has one or more vlans */
+#define IFEF_BOND 0x400 /* interface is part of bond */
+#define IFEF_ARPLL 0x800 /* ARP for IPv4LL addresses on this port */
+#define IFEF_NOWINDOWSCALE 0x1000 /* Don't scale TCP window on iface */
+#define IFEF_NOAUTOIPV6LL 0x2000 /* Interface IPv6 LinkLocal address not provided by kernel */
+#define IFEF_SENDLIST 0x10000000 /* Interface supports sending a list of packets */
+#define IFEF_REUSE 0x20000000 /* DLIL ifnet recycler, ifnet is not new */
+#define IFEF_INUSE 0x40000000 /* DLIL ifnet recycler, ifnet in use */
+#define IFEF_UPDOWNCHANGE 0x80000000 /* Interface's up/down state is changing */
+/*
+ * !!! NOTE !!!
+ *
+ * if_idle_flags definitions: (all bits are reserved for internal/future
+ * use). Setting these flags MUST be done via the ifnet_set_idle_flags()
+ * KPI due to the associated reference counting. Clearing them may be done by
+ * calling the KPI, otherwise implicitly at interface detach time. Setting
+ * the if_idle_flags field to a non-zero value will cause the networking
+ * stack to aggressively purge expired objects (routes, etc.)
+ */
+#define IFRF_IDLE_NOTIFY 0x1 /* Generate notifications on idle */
/* flags set internally only: */
#define IFF_CANTCHANGE \
(IFF_BROADCAST|IFF_POINTOPOINT|IFF_RUNNING|IFF_OACTIVE|\
IFF_SIMPLEX|IFF_MULTICAST|IFF_ALLMULTI)
+#endif /* KERNEL_PRIVATE */
+
#define IFQ_MAXLEN 50
#define IFNET_SLOWHZ 1 /* granularity is 1 second */
/*
* Message format for use in obtaining information about interfaces
- * from getkerninfo and the routing socket
+ * from sysctl and the routing socket
*/
struct if_msghdr {
- u_short ifm_msglen; /* to skip over non-understood messages */
- u_char ifm_version; /* future binary compatability */
- u_char ifm_type; /* message type */
- int ifm_addrs; /* like rtm_addrs */
- int ifm_flags; /* value of if_flags */
- u_short ifm_index; /* index for associated ifp */
- struct if_data ifm_data;/* statistics and other data about if */
+ unsigned short ifm_msglen; /* to skip over non-understood messages */
+ unsigned char ifm_version; /* future binary compatability */
+ unsigned char ifm_type; /* message type */
+ int ifm_addrs; /* like rtm_addrs */
+ int ifm_flags; /* value of if_flags */
+ unsigned short ifm_index; /* index for associated ifp */
+ struct if_data ifm_data; /* statistics and other data about if */
};
/*
* Message format for use in obtaining information about interface addresses
- * from getkerninfo and the routing socket
+ * from sysctl and the routing socket
*/
struct ifa_msghdr {
- u_short ifam_msglen; /* to skip over non-understood messages */
- u_char ifam_version; /* future binary compatability */
- u_char ifam_type; /* message type */
- int ifam_addrs; /* like rtm_addrs */
- int ifam_flags; /* value of ifa_flags */
- u_short ifam_index; /* index for associated ifp */
- int ifam_metric; /* value of ifa_metric */
+ unsigned short ifam_msglen; /* to skip over non-understood messages */
+ unsigned char ifam_version; /* future binary compatability */
+ unsigned char ifam_type; /* message type */
+ int ifam_addrs; /* like rtm_addrs */
+ int ifam_flags; /* value of ifa_flags */
+ unsigned short ifam_index; /* index for associated ifp */
+ int ifam_metric; /* value of ifa_metric */
};
/*
* from the routing socket
*/
struct ifma_msghdr {
+ unsigned short ifmam_msglen; /* to skip over non-understood messages */
+ unsigned char ifmam_version; /* future binary compatability */
+ unsigned char ifmam_type; /* message type */
+ int ifmam_addrs; /* like rtm_addrs */
+ int ifmam_flags; /* value of ifa_flags */
+ unsigned short ifmam_index; /* index for associated ifp */
+};
+
+/*
+ * Message format for use in obtaining information about interfaces
+ * from sysctl
+ */
+struct if_msghdr2 {
+ u_short ifm_msglen; /* to skip over non-understood messages */
+ u_char ifm_version; /* future binary compatability */
+ u_char ifm_type; /* message type */
+ int ifm_addrs; /* like rtm_addrs */
+ int ifm_flags; /* value of if_flags */
+ u_short ifm_index; /* index for associated ifp */
+ int ifm_snd_len; /* instantaneous length of send queue */
+ int ifm_snd_maxlen; /* maximum length of send queue */
+ int ifm_snd_drops; /* number of drops in send queue */
+ int ifm_timer; /* time until if_watchdog called */
+ struct if_data64 ifm_data; /* statistics and other data about if */
+};
+
+/*
+ * Message format for use in obtaining information about multicast addresses
+ * from sysctl
+ */
+struct ifma_msghdr2 {
u_short ifmam_msglen; /* to skip over non-understood messages */
u_char ifmam_version; /* future binary compatability */
u_char ifmam_type; /* message type */
int ifmam_addrs; /* like rtm_addrs */
int ifmam_flags; /* value of ifa_flags */
u_short ifmam_index; /* index for associated ifp */
+ int32_t ifmam_refcount;
+};
+
+/*
+ * ifdevmtu: interface device mtu
+ * Used with SIOCGIFDEVMTU to get the current mtu in use by the device,
+ * as well as the minimum and maximum mtu allowed by the device.
+ */
+struct ifdevmtu {
+ int ifdm_current;
+ int ifdm_min;
+ int ifdm_max;
};
+#pragma pack(4)
+
+/*
+ ifkpi: interface kpi ioctl
+ Used with SIOCSIFKPI and SIOCGIFKPI.
+
+ ifk_module_id - From in the kernel, a value from kev_vendor_code_find. From
+ user space, a value from SIOCGKEVVENDOR ioctl on a kernel event socket.
+ ifk_type - The type. Types are specific to each module id.
+ ifk_data - The data. ifk_ptr may be a 64bit pointer for 64 bit processes.
+
+ Copying data between user space and kernel space is done using copyin
+ and copyout. A process may be running in 64bit mode. In such a case,
+ the pointer will be a 64bit pointer, not a 32bit pointer. The following
+ sample is a safe way to copy the data in to the kernel from either a
+ 32bit or 64bit process:
+
+ user_addr_t tmp_ptr;
+ if (IS_64BIT_PROCESS(current_proc())) {
+ tmp_ptr = CAST_USER_ADDR_T(ifkpi.ifk_data.ifk_ptr64);
+ }
+ else {
+ tmp_ptr = CAST_USER_ADDR_T(ifkpi.ifk_data.ifk_ptr);
+ }
+ error = copyin(tmp_ptr, allocated_dst_buffer, size of allocated_dst_buffer);
+ */
+
+struct ifkpi {
+ unsigned int ifk_module_id;
+ unsigned int ifk_type;
+ union {
+ void *ifk_ptr;
+ int ifk_value;
+#ifdef KERNEL
+ u_int64_t ifk_ptr64;
+#endif /* KERNEL */
+ } ifk_data;
+};
+
+/* Wake capabilities of a interface */
+#define IF_WAKE_ON_MAGIC_PACKET 0x01
+#ifdef KERNEL_PRIVATE
+#define IF_WAKE_VALID_FLAGS IF_WAKE_ON_MAGIC_PACKET
+#endif /* KERNEL_PRIVATE */
+
+
+#pragma pack()
+
/*
* Interface request structure used for socket
* ioctl's. All interface ioctl's must have parameter
* definitions which begin with ifr_name. The
* remainder may be interface specific.
*/
-#define IF_NAMESIZE IFNAMSIZ
struct ifreq {
-#define IFNAMSIZ 16
+#ifndef IFNAMSIZ
+#define IFNAMSIZ IF_NAMESIZE
+#endif
char ifr_name[IFNAMSIZ]; /* if name, e.g. "en0" */
union {
struct sockaddr ifru_addr;
int ifru_mtu;
int ifru_phys;
int ifru_media;
+ int ifru_intval;
caddr_t ifru_data;
+#ifdef KERNEL_PRIVATE
+ u_int64_t ifru_data64; /* 64-bit ifru_data */
+#endif /* KERNEL_PRIVATE */
+ struct ifdevmtu ifru_devmtu;
+ struct ifkpi ifru_kpi;
+ u_int32_t ifru_wake_flags;
+ u_int32_t ifru_route_refcnt;
} ifr_ifru;
#define ifr_addr ifr_ifru.ifru_addr /* address */
#define ifr_dstaddr ifr_ifru.ifru_dstaddr /* other end of p-to-p link */
#define ifr_broadaddr ifr_ifru.ifru_broadaddr /* broadcast address */
+#ifdef __APPLE__
#define ifr_flags ifr_ifru.ifru_flags /* flags */
+#else
+#define ifr_flags ifr_ifru.ifru_flags[0] /* flags */
+#define ifr_prevflags ifr_ifru.ifru_flags[1] /* flags */
+#endif /* __APPLE__ */
#define ifr_metric ifr_ifru.ifru_metric /* metric */
#define ifr_mtu ifr_ifru.ifru_mtu /* mtu */
#define ifr_phys ifr_ifru.ifru_phys /* physical wire */
#define ifr_media ifr_ifru.ifru_media /* physical media */
#define ifr_data ifr_ifru.ifru_data /* for use by interface */
+#define ifr_devmtu ifr_ifru.ifru_devmtu
+#define ifr_intval ifr_ifru.ifru_intval /* integer value */
+#ifdef KERNEL_PRIVATE
+#define ifr_data64 ifr_ifru.ifru_data64 /* 64-bit pointer */
+#endif /* KERNEL_PRIVATE */
+#define ifr_kpi ifr_ifru.ifru_kpi
+#define ifr_wake_flags ifr_ifru.ifru_wake_flags /* wake capabilities of devive */
+#define ifr_route_refcnt ifr_ifru.ifru_route_refcnt /* route references on interface */
};
#define _SIZEOF_ADDR_IFREQ(ifr) \
struct sockaddr **llsa;
};
+#if !defined(KERNEL) || defined(KERNEL_PRIVATE)
+#pragma pack(4)
+
struct ifmediareq {
char ifm_name[IFNAMSIZ]; /* if name, e.g. "en0" */
int ifm_current; /* current media options */
int ifm_count; /* # entries in ifm_ulist array */
int *ifm_ulist; /* media words */
};
+
+#pragma pack()
+#endif /* !KERNEL || KERNEL_PRIVATE */
+
+#ifdef KERNEL_PRIVATE
+#pragma pack(4)
+struct ifmediareq64 {
+ char ifm_name[IFNAMSIZ]; /* if name, e.g. "en0" */
+ int ifm_current; /* current media options */
+ int ifm_mask; /* don't care mask */
+ int ifm_status; /* media status */
+ int ifm_active; /* active options */
+ int ifm_count; /* # entries in ifm_ulist array */
+ user64_addr_t ifmu_ulist __attribute__((aligned(8)));
+};
+
+struct ifmediareq32 {
+ char ifm_name[IFNAMSIZ]; /* if name, e.g. "en0" */
+ int ifm_current; /* current media options */
+ int ifm_mask; /* don't care mask */
+ int ifm_status; /* media status */
+ int ifm_active; /* active options */
+ int ifm_count; /* # entries in ifm_ulist array */
+ user32_addr_t ifmu_ulist; /* 32-bit pointer */
+};
+#pragma pack()
+#endif /* KERNEL_PRIVATE */
+
+
+#pragma pack(4)
+struct ifdrv {
+ char ifd_name[IFNAMSIZ]; /* if name, e.g. "en0" */
+ unsigned long ifd_cmd;
+ size_t ifd_len;
+ void *ifd_data;
+};
+#pragma pack()
+
+#ifdef KERNEL_PRIVATE
+#pragma pack(4)
+struct ifdrv32 {
+ char ifd_name[IFNAMSIZ]; /* if name, e.g. "en0" */
+ u_int32_t ifd_cmd;
+ u_int32_t ifd_len;
+ user32_addr_t ifd_data;
+};
+
+struct ifdrv64 {
+ char ifd_name[IFNAMSIZ]; /* if name, e.g. "en0" */
+ u_int64_t ifd_cmd;
+ u_int64_t ifd_len;
+ user64_addr_t ifd_data;
+};
+#pragma pack()
+#endif /* KERNEL_PRIVATE */
+
+/*
+ * Structure used to retrieve aux status data from interfaces.
+ * Kernel suppliers to this interface should respect the formatting
+ * needed by ifconfig(8): each line starts with a TAB and ends with
+ * a newline. The canonical example to copy and paste is in if_tun.c.
+ */
+
+#define IFSTATMAX 800 /* 10 lines of text */
+struct ifstat {
+ char ifs_name[IFNAMSIZ]; /* if name, e.g. "en0" */
+ char ascii[IFSTATMAX + 1];
+};
+
+#if !defined(KERNEL) || defined(KERNEL_PRIVATE)
/*
* Structure used in SIOCGIFCONF request.
* Used to retrieve interface configuration
* for machine (useful for programs which
* must know all networks accessible).
*/
+#pragma pack(4)
struct ifconf {
int ifc_len; /* size of associated buffer */
union {
caddr_t ifcu_buf;
struct ifreq *ifcu_req;
} ifc_ifcu;
+};
+#pragma pack()
#define ifc_buf ifc_ifcu.ifcu_buf /* buffer address */
#define ifc_req ifc_ifcu.ifcu_req /* array of structures returned */
+#endif /* !KERNEL || KERNEL_PRIVATE */
+
+#if defined(KERNEL_PRIVATE)
+#pragma pack(4)
+struct ifconf32 {
+ int ifc_len; /* size of associated buffer */
+ struct {
+ user32_addr_t ifcu_req;
+ } ifc_ifcu;
+};
+
+struct ifconf64 {
+ int ifc_len; /* size of associated buffer */
+ struct {
+ user64_addr_t ifcu_req __attribute__((aligned(8)));
+ } ifc_ifcu;
};
+#pragma pack()
+#endif /* KERNEL_PRIVATE */
/*
* DLIL KEV_DL_PROTO_ATTACHED/DETACHED structure
*/
struct kev_dl_proto_data {
struct net_event_data link_data;
- u_long proto_family;
- u_long proto_remaining_count;
+ u_int32_t proto_family;
+ u_int32_t proto_remaining_count;
};
-
/*
* Structure for SIOC[AGD]LIFADDR
*/
struct if_laddrreq {
- char iflr_name[IFNAMSIZ];
- unsigned int flags;
-#define IFLR_PREFIX 0x8000 /* in: prefix given out: kernel fills id */
- unsigned int prefixlen; /* in/out */
- struct sockaddr_storage addr; /* in/out */
- struct sockaddr_storage dstaddr; /* out */
+ char iflr_name[IFNAMSIZ];
+ unsigned int flags;
+#define IFLR_PREFIX 0x8000 /* in: prefix given out: kernel fills id */
+ unsigned int prefixlen; /* in/out */
+ struct sockaddr_storage addr; /* in/out */
+ struct sockaddr_storage dstaddr; /* out */
};
-
#ifdef KERNEL
#ifdef MALLOC_DECLARE
MALLOC_DECLARE(M_IFADDR);
MALLOC_DECLARE(M_IFMADDR);
#endif
#endif
+#endif /* (_POSIX_C_SOURCE && !_DARWIN_C_SOURCE) */
#ifndef KERNEL
-struct if_nameindex {
- unsigned int if_index; /* 1, 2, ... */
- char *if_name; /* null terminated name: "le0", ... */
-};
-
+struct if_nameindex {
+ unsigned int if_index; /* 1, 2, ... */
+ char *if_name; /* null terminated name: "le0", ... */
+};
+
__BEGIN_DECLS
-unsigned int if_nametoindex __P((const char *));
-char *if_indextoname __P((unsigned int, char *));
-struct if_nameindex *if_nameindex __P((void));
-void if_freenameindex __P((struct if_nameindex *));
+unsigned int if_nametoindex(const char *);
+char *if_indextoname(unsigned int, char *);
+struct if_nameindex *if_nameindex(void);
+void if_freenameindex(struct if_nameindex *);
__END_DECLS
#endif
-/* XXX - this should go away soon */
#ifdef KERNEL
-#include <net/if_var.h>
+#include <net/kpi_interface.h>
#endif
#endif /* !_NET_IF_H_ */