bsd/net/if.h

   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
  55  */
  56
  57 #ifndef _NET_IF_H_
  58 #define _NET_IF_H_
  59
  60
  61 /*
  62  * Define Data-Link event subclass, and associated
  63  * events.
  64  */
  65
  66 #define KEV_DL_SUBCLASS 2
  67
  68 #define KEV_DL_SIFFLAGS     1
  69 #define KEV_DL_SIFMETRICS   2
  70 #define KEV_DL_SIFMTU       3
  71 #define KEV_DL_SIFPHYS      4
  72 #define KEV_DL_SIFMEDIA     5
  73 #define KEV_DL_SIFGENERIC   6
  74 #define KEV_DL_ADDMULTI     7
  75 #define KEV_DL_DELMULTI     8
  76 #define KEV_DL_IF_ATTACHED  9
  77 #define KEV_DL_IF_DETACHING 10
  78 #define KEV_DL_IF_DETACHED  11
  79 #define KEV_DL_LINK_OFF     12
  80 #define KEV_DL_LINK_ON      13
  81 #define KEV_DL_PROTO_ATTACHED   14
  82 #define KEV_DL_PROTO_DETACHED   15
  83
  84 /*
  85  * <net/if.h> does not depend on <sys/time.h> on most other systems.  This
  86  * helps userland compatability.  (struct timeval ifi_lastchange)
  87  */
  88
  89 #include <sys/time.h>
  90 #include <net/if_var.h>
  91
  92
  93 #define IFF_UP          0x1             /* interface is up */
  94 #define IFF_BROADCAST   0x2             /* broadcast address valid */
  95 #define IFF_DEBUG       0x4             /* turn on debugging */
  96 #define IFF_LOOPBACK    0x8             /* is a loopback net */
  97 #define IFF_POINTOPOINT 0x10            /* interface is point-to-point link */
  98 #define IFF_NOTRAILERS 0x20             /* obsolete: avoid use of trailers */
  99 #define IFF_RUNNING     0x40            /* resources allocated */
 100 #define IFF_NOARP       0x80            /* no address resolution protocol */
 101 #define IFF_PROMISC     0x100           /* receive all packets */
 102 #define IFF_ALLMULTI    0x200           /* receive all multicast packets */
 103 #define IFF_OACTIVE     0x400           /* transmission in progress */
 104 #define IFF_SIMPLEX     0x800           /* can't hear own transmissions */
 105 #define IFF_LINK0       0x1000          /* per link layer defined bit */
 106 #define IFF_LINK1       0x2000          /* per link layer defined bit */
 107 #define IFF_LINK2       0x4000          /* per link layer defined bit */
 108 #define IFF_ALTPHYS     IFF_LINK2       /* use alternate physical connection */
 109 #define IFF_MULTICAST   0x8000          /* supports multicast */
 110 #define IFF_SPLITTER    IFF_LINK2       /* Y splitter in force */
 111
 112 #ifdef KERNEL_PRIVATE
 113 /* extended flags definitions:  (all bits are reserved for internal/future use) */
 114 #define IFEF_AUTOCONFIGURING    0x1
 115 #define IFEF_DVR_REENTRY_OK     0x20    /* When set, driver may be reentered from its own thread */
 116 #define IFEF_DETACH_DISABLED    0x80000000
 117 #endif KERNEL_PRIVATE
 118
 119
 120 /* flags set internally only: */
 121 #define IFF_CANTCHANGE \
 122         (IFF_BROADCAST|IFF_POINTOPOINT|IFF_RUNNING|IFF_OACTIVE|\
 123             IFF_SIMPLEX|IFF_MULTICAST|IFF_ALLMULTI)
 124
 125 #define IFQ_MAXLEN      50
 126 #define IFNET_SLOWHZ    1               /* granularity is 1 second */
 127
 128 /*
 129  * Message format for use in obtaining information about interfaces
 130  * from getkerninfo and the routing socket
 131  */
 132 struct if_msghdr {
 133         u_short ifm_msglen;     /* to skip over non-understood messages */
 134         u_char  ifm_version;    /* future binary compatability */
 135         u_char  ifm_type;       /* message type */
 136         int     ifm_addrs;      /* like rtm_addrs */
 137         int     ifm_flags;      /* value of if_flags */
 138         u_short ifm_index;      /* index for associated ifp */
 139         struct  if_data ifm_data;/* statistics and other data about if */
 140 };
 141
 142 /*
 143  * Message format for use in obtaining information about interface addresses
 144  * from getkerninfo and the routing socket
 145  */
 146 struct ifa_msghdr {
 147         u_short ifam_msglen;    /* to skip over non-understood messages */
 148         u_char  ifam_version;   /* future binary compatability */
 149         u_char  ifam_type;      /* message type */
 150         int     ifam_addrs;     /* like rtm_addrs */
 151         int     ifam_flags;     /* value of ifa_flags */
 152         u_short ifam_index;     /* index for associated ifp */
 153         int     ifam_metric;    /* value of ifa_metric */
 154 };
 155
 156 /*
 157  * Message format for use in obtaining information about multicast addresses
 158  * from the routing socket
 159  */
 160 struct ifma_msghdr {
 161         u_short ifmam_msglen;   /* to skip over non-understood messages */
 162         u_char  ifmam_version;  /* future binary compatability */
 163         u_char  ifmam_type;     /* message type */
 164         int     ifmam_addrs;    /* like rtm_addrs */
 165         int     ifmam_flags;    /* value of ifa_flags */
 166         u_short ifmam_index;    /* index for associated ifp */
 167 };
 168
 169 /*
 170  * Interface request structure used for socket
 171  * ioctl's.  All interface ioctl's must have parameter
 172  * definitions which begin with ifr_name.  The
 173  * remainder may be interface specific.
 174  */
 175 #define IF_NAMESIZE     IFNAMSIZ
 176 struct  ifreq {
 177 #define IFNAMSIZ        16
 178         char    ifr_name[IFNAMSIZ];             /* if name, e.g. "en0" */
 179         union {
 180                 struct  sockaddr ifru_addr;
 181                 struct  sockaddr ifru_dstaddr;
 182                 struct  sockaddr ifru_broadaddr;
 183                 short   ifru_flags;
 184                 int     ifru_metric;
 185                 int     ifru_mtu;
 186                 int     ifru_phys;
 187                 int     ifru_media;
 188                 caddr_t ifru_data;
 189         } ifr_ifru;
 190 #define ifr_addr        ifr_ifru.ifru_addr      /* address */
 191 #define ifr_dstaddr     ifr_ifru.ifru_dstaddr   /* other end of p-to-p link */
 192 #define ifr_broadaddr   ifr_ifru.ifru_broadaddr /* broadcast address */
 193 #define ifr_flags       ifr_ifru.ifru_flags     /* flags */
 194 #define ifr_metric      ifr_ifru.ifru_metric    /* metric */
 195 #define ifr_mtu         ifr_ifru.ifru_mtu       /* mtu */
 196 #define ifr_phys        ifr_ifru.ifru_phys      /* physical wire */
 197 #define ifr_media       ifr_ifru.ifru_media     /* physical media */
 198 #define ifr_data        ifr_ifru.ifru_data      /* for use by interface */
 199 };
 200
 201 #define _SIZEOF_ADDR_IFREQ(ifr) \
 202         ((ifr).ifr_addr.sa_len > sizeof(struct sockaddr) ? \
 203          (sizeof(struct ifreq) - sizeof(struct sockaddr) + \
 204           (ifr).ifr_addr.sa_len) : sizeof(struct ifreq))
 205
 206 struct ifaliasreq {
 207         char    ifra_name[IFNAMSIZ];            /* if name, e.g. "en0" */
 208         struct  sockaddr ifra_addr;
 209         struct  sockaddr ifra_broadaddr;
 210         struct  sockaddr ifra_mask;
 211 };
 212
 213 struct rslvmulti_req {
 214      struct sockaddr *sa;
 215      struct sockaddr **llsa;
 216 };
 217
 218 struct ifmediareq {
 219         char    ifm_name[IFNAMSIZ];     /* if name, e.g. "en0" */
 220         int     ifm_current;            /* current media options */
 221         int     ifm_mask;               /* don't care mask */
 222         int     ifm_status;             /* media status */
 223         int     ifm_active;             /* active options */
 224         int     ifm_count;              /* # entries in ifm_ulist array */
 225         int     *ifm_ulist;             /* media words */
 226 };
 227 /*
 228  * Structure used in SIOCGIFCONF request.
 229  * Used to retrieve interface configuration
 230  * for machine (useful for programs which
 231  * must know all networks accessible).
 232  */
 233 struct  ifconf {
 234         int     ifc_len;                /* size of associated buffer */
 235         union {
 236                 caddr_t ifcu_buf;
 237                 struct  ifreq *ifcu_req;
 238         } ifc_ifcu;
 239 #define ifc_buf ifc_ifcu.ifcu_buf       /* buffer address */
 240 #define ifc_req ifc_ifcu.ifcu_req       /* array of structures returned */
 241 };
 242
 243 /*
 244  * DLIL KEV_DL_PROTO_ATTACHED/DETACHED structure
 245  */
 246 struct kev_dl_proto_data {
 247      struct net_event_data      link_data;
 248      u_long                     proto_family;
 249      u_long                     proto_remaining_count;
 250 };
 251
 252
 253 /*
 254  * Structure for SIOC[AGD]LIFADDR
 255  */
 256 struct if_laddrreq {
 257         char iflr_name[IFNAMSIZ];
 258         unsigned int flags;
 259 #define IFLR_PREFIX    0x8000  /* in: prefix given  out: kernel fills id */
 260         unsigned int prefixlen;         /* in/out */
 261         struct sockaddr_storage addr;   /* in/out */
 262         struct sockaddr_storage dstaddr; /* out */
 263 };
 264
 265
 266 #ifdef KERNEL
 267 #ifdef MALLOC_DECLARE
 268 MALLOC_DECLARE(M_IFADDR);
 269 MALLOC_DECLARE(M_IFMADDR);
 270 #endif
 271 #endif
 272
 273 #ifndef KERNEL
 274 struct if_nameindex {
 275         unsigned int    if_index;       /* 1, 2, ... */
 276         char            *if_name;       /* null terminated name: "le0", ... */
 277 };
 278
 279 __BEGIN_DECLS
 280 unsigned int if_nametoindex __P((const char *));
 281 char *if_indextoname __P((unsigned int, char *));
 282 struct if_nameindex *if_nameindex __P((void));
 283 void if_freenameindex __P((struct if_nameindex *));
 284 __END_DECLS
 285 #endif
 286
 287 /* XXX - this should go away soon */
 288 #ifdef KERNEL
 289 #include <net/if_var.h>
 290 #endif
 291
 292 #endif /* !_NET_IF_H_ */