bsd/net/if.h

   1 /*
   2  * Copyright (c) 2000-2008 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
   5  *
   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.
  14  *
  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
  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.
  25  *
  26  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
  27  */
  28 /*
  29  * Copyright (c) 1982, 1986, 1989, 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  *      @(#)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 $
  62  */
  63
  64 #ifndef _NET_IF_H_
  65 #define _NET_IF_H_
  66
  67 #include <sys/cdefs.h>
  68
  69 #define IF_NAMESIZE     16
  70
  71 #if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
  72 #include <sys/appleapiopts.h>
  73 #ifdef __APPLE__
  74 /*
  75  * Define Data-Link event subclass, and associated
  76  * events.
  77  */
  78
  79 #define KEV_DL_SUBCLASS 2
  80
  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
  97 #define KEV_DL_WAKEFLAGS_CHANGED        17
  98
  99 #include <net/if_var.h>
 100 #include <sys/types.h>
 101 #endif
 102
 103 #ifdef KERNEL_PRIVATE
 104 struct if_clonereq {
 105         int     ifcr_total;             /* total cloners (out) */
 106         int     ifcr_count;             /* room for this many in user buffer */
 107         char    *ifcr_buffer;           /* buffer for cloner names */
 108 };
 109
 110 struct if_clonereq64 {
 111         int     ifcr_total;             /* total cloners (out) */
 112         int     ifcr_count;             /* room for this many in user buffer */
 113         user64_addr_t ifcru_buffer      __attribute__((aligned(8)));
 114 };
 115
 116 struct if_clonereq32 {
 117         int     ifcr_total;             /* total cloners (out) */
 118         int     ifcr_count;             /* room for this many in user buffer */
 119         user32_addr_t ifcru_buffer;
 120 };
 121 #endif /* KERNEL_PRIVATE */
 122
 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 */
 140
 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_NOWINDOWSCALE      0x1000  /* Don't scale TCP window on iface */
 152 #define IFEF_NOAUTOIPV6LL       0x2000  /* Interface IPv6 LinkLocal address not provided by kernel */
 153 #define IFEF_SENDLIST   0x10000000 /* Interface supports sending a list of packets */
 154 #define IFEF_REUSE      0x20000000 /* DLIL ifnet recycler, ifnet is not new */
 155 #define IFEF_INUSE      0x40000000 /* DLIL ifnet recycler, ifnet in use */
 156 #define IFEF_UPDOWNCHANGE       0x80000000 /* Interface's up/down state is changing */
 157
 158 /* flags set internally only: */
 159 #define IFF_CANTCHANGE \
 160         (IFF_BROADCAST|IFF_POINTOPOINT|IFF_RUNNING|IFF_OACTIVE|\
 161             IFF_SIMPLEX|IFF_MULTICAST|IFF_ALLMULTI)
 162
 163 #endif /* KERNEL_PRIVATE */
 164
 165 #define IFQ_MAXLEN      50
 166 #define IFNET_SLOWHZ    1               /* granularity is 1 second */
 167
 168 /*
 169  * Message format for use in obtaining information about interfaces
 170  * from sysctl and the routing socket
 171  */
 172 struct if_msghdr {
 173         unsigned short  ifm_msglen;     /* to skip over non-understood messages */
 174         unsigned char   ifm_version;    /* future binary compatability */
 175         unsigned char   ifm_type;       /* message type */
 176         int             ifm_addrs;      /* like rtm_addrs */
 177         int             ifm_flags;      /* value of if_flags */
 178         unsigned short  ifm_index;      /* index for associated ifp */
 179         struct  if_data ifm_data;       /* statistics and other data about if */
 180 };
 181
 182 /*
 183  * Message format for use in obtaining information about interface addresses
 184  * from sysctl and the routing socket
 185  */
 186 struct ifa_msghdr {
 187         unsigned short  ifam_msglen;    /* to skip over non-understood messages */
 188         unsigned char   ifam_version;   /* future binary compatability */
 189         unsigned char   ifam_type;      /* message type */
 190         int             ifam_addrs;     /* like rtm_addrs */
 191         int             ifam_flags;     /* value of ifa_flags */
 192         unsigned short  ifam_index;     /* index for associated ifp */
 193         int             ifam_metric;    /* value of ifa_metric */
 194 };
 195
 196 /*
 197  * Message format for use in obtaining information about multicast addresses
 198  * from the routing socket
 199  */
 200 struct ifma_msghdr {
 201         unsigned short  ifmam_msglen;   /* to skip over non-understood messages */
 202         unsigned char   ifmam_version;  /* future binary compatability */
 203         unsigned char   ifmam_type;     /* message type */
 204         int             ifmam_addrs;    /* like rtm_addrs */
 205         int             ifmam_flags;    /* value of ifa_flags */
 206         unsigned short  ifmam_index;    /* index for associated ifp */
 207 };
 208
 209 /*
 210  * Message format for use in obtaining information about interfaces
 211  * from sysctl
 212  */
 213 struct if_msghdr2 {
 214         u_short ifm_msglen;     /* to skip over non-understood messages */
 215         u_char  ifm_version;    /* future binary compatability */
 216         u_char  ifm_type;       /* message type */
 217         int     ifm_addrs;      /* like rtm_addrs */
 218         int     ifm_flags;      /* value of if_flags */
 219         u_short ifm_index;      /* index for associated ifp */
 220         int     ifm_snd_len;    /* instantaneous length of send queue */
 221         int     ifm_snd_maxlen; /* maximum length of send queue */
 222         int     ifm_snd_drops;  /* number of drops in send queue */
 223         int     ifm_timer;      /* time until if_watchdog called */
 224         struct if_data64        ifm_data;       /* statistics and other data about if */
 225 };
 226
 227 /*
 228  * Message format for use in obtaining information about multicast addresses
 229  * from sysctl
 230  */
 231 struct ifma_msghdr2 {
 232         u_short ifmam_msglen;   /* to skip over non-understood messages */
 233         u_char  ifmam_version;  /* future binary compatability */
 234         u_char  ifmam_type;     /* message type */
 235         int     ifmam_addrs;    /* like rtm_addrs */
 236         int     ifmam_flags;    /* value of ifa_flags */
 237         u_short ifmam_index;    /* index for associated ifp */
 238         int32_t ifmam_refcount;
 239 };
 240
 241 /*
 242  * ifdevmtu: interface device mtu
 243  *    Used with SIOCGIFDEVMTU to get the current mtu in use by the device,
 244  *    as well as the minimum and maximum mtu allowed by the device.
 245  */
 246 struct ifdevmtu {
 247         int     ifdm_current;
 248         int     ifdm_min;
 249         int     ifdm_max;
 250 };
 251
 252 #pragma pack(4)
 253
 254 /*
 255  ifkpi: interface kpi ioctl
 256  Used with SIOCSIFKPI and SIOCGIFKPI.
 257
 258  ifk_module_id - From in the kernel, a value from kev_vendor_code_find. From
 259         user space, a value from SIOCGKEVVENDOR ioctl on a kernel event socket.
 260  ifk_type - The type. Types are specific to each module id.
 261  ifk_data - The data. ifk_ptr may be a 64bit pointer for 64 bit processes.
 262
 263  Copying data between user space and kernel space is done using copyin
 264  and copyout. A process may be running in 64bit mode. In such a case,
 265  the pointer will be a 64bit pointer, not a 32bit pointer. The following
 266  sample is a safe way to copy the data in to the kernel from either a
 267  32bit or 64bit process:
 268
 269  user_addr_t tmp_ptr;
 270  if (IS_64BIT_PROCESS(current_proc())) {
 271         tmp_ptr = CAST_USER_ADDR_T(ifkpi.ifk_data.ifk_ptr64);
 272  }
 273  else {
 274         tmp_ptr = CAST_USER_ADDR_T(ifkpi.ifk_data.ifk_ptr);
 275  }
 276  error = copyin(tmp_ptr, allocated_dst_buffer, size of allocated_dst_buffer);
 277  */
 278
 279 struct ifkpi {
 280         unsigned int    ifk_module_id;
 281         unsigned int    ifk_type;
 282         union {
 283                 void            *ifk_ptr;
 284                 int             ifk_value;
 285 #ifdef KERNEL
 286                 u_int64_t       ifk_ptr64;
 287 #endif /* KERNEL */
 288         } ifk_data;
 289 };
 290
 291 /* Wake capabilities of a interface */
 292 #define IF_WAKE_ON_MAGIC_PACKET         0x01
 293 #ifdef KERNEL_PRIVATE
 294 #define IF_WAKE_VALID_FLAGS IF_WAKE_ON_MAGIC_PACKET
 295 #endif /* KERNEL_PRIVATE */
 296
 297
 298 #pragma pack()
 299
 300 /*
 301  * Interface request structure used for socket
 302  * ioctl's.  All interface ioctl's must have parameter
 303  * definitions which begin with ifr_name.  The
 304  * remainder may be interface specific.
 305  */
 306 struct  ifreq {
 307 #ifndef IFNAMSIZ
 308 #define IFNAMSIZ        IF_NAMESIZE
 309 #endif
 310         char    ifr_name[IFNAMSIZ];             /* if name, e.g. "en0" */
 311         union {
 312                 struct  sockaddr ifru_addr;
 313                 struct  sockaddr ifru_dstaddr;
 314                 struct  sockaddr ifru_broadaddr;
 315                 short   ifru_flags;
 316                 int     ifru_metric;
 317                 int     ifru_mtu;
 318                 int     ifru_phys;
 319                 int     ifru_media;
 320                 int     ifru_intval;
 321                 caddr_t ifru_data;
 322 #ifdef KERNEL_PRIVATE
 323                 u_int64_t ifru_data64;  /* 64-bit ifru_data */
 324 #endif /* KERNEL_PRIVATE */
 325                 struct  ifdevmtu ifru_devmtu;
 326                 struct  ifkpi   ifru_kpi;
 327                 u_int32_t ifru_wake_flags;
 328         } ifr_ifru;
 329 #define ifr_addr        ifr_ifru.ifru_addr      /* address */
 330 #define ifr_dstaddr     ifr_ifru.ifru_dstaddr   /* other end of p-to-p link */
 331 #define ifr_broadaddr   ifr_ifru.ifru_broadaddr /* broadcast address */
 332 #ifdef __APPLE__
 333 #define ifr_flags       ifr_ifru.ifru_flags     /* flags */
 334 #else
 335 #define ifr_flags       ifr_ifru.ifru_flags[0]  /* flags */
 336 #define ifr_prevflags   ifr_ifru.ifru_flags[1]  /* flags */
 337 #endif /* __APPLE__ */
 338 #define ifr_metric      ifr_ifru.ifru_metric    /* metric */
 339 #define ifr_mtu         ifr_ifru.ifru_mtu       /* mtu */
 340 #define ifr_phys        ifr_ifru.ifru_phys      /* physical wire */
 341 #define ifr_media       ifr_ifru.ifru_media     /* physical media */
 342 #define ifr_data        ifr_ifru.ifru_data      /* for use by interface */
 343 #define ifr_devmtu      ifr_ifru.ifru_devmtu
 344 #define ifr_intval      ifr_ifru.ifru_intval    /* integer value */
 345 #ifdef KERNEL_PRIVATE
 346 #define ifr_data64      ifr_ifru.ifru_data64    /* 64-bit pointer */
 347 #endif /* KERNEL_PRIVATE */
 348 #define ifr_kpi         ifr_ifru.ifru_kpi
 349 #define ifr_wake_flags  ifr_ifru.ifru_wake_flags /* wake capabilities of devive */
 350 };
 351
 352 #define _SIZEOF_ADDR_IFREQ(ifr) \
 353         ((ifr).ifr_addr.sa_len > sizeof(struct sockaddr) ? \
 354          (sizeof(struct ifreq) - sizeof(struct sockaddr) + \
 355           (ifr).ifr_addr.sa_len) : sizeof(struct ifreq))
 356
 357 struct ifaliasreq {
 358         char    ifra_name[IFNAMSIZ];            /* if name, e.g. "en0" */
 359         struct  sockaddr ifra_addr;
 360         struct  sockaddr ifra_broadaddr;
 361         struct  sockaddr ifra_mask;
 362 };
 363
 364 struct rslvmulti_req {
 365      struct sockaddr *sa;
 366      struct sockaddr **llsa;
 367 };
 368
 369 #if !defined(KERNEL) || defined(KERNEL_PRIVATE)
 370 #pragma pack(4)
 371
 372 struct ifmediareq {
 373         char    ifm_name[IFNAMSIZ];     /* if name, e.g. "en0" */
 374         int     ifm_current;            /* current media options */
 375         int     ifm_mask;               /* don't care mask */
 376         int     ifm_status;             /* media status */
 377         int     ifm_active;             /* active options */
 378         int     ifm_count;              /* # entries in ifm_ulist array */
 379         int     *ifm_ulist;             /* media words */
 380 };
 381
 382 #pragma pack()
 383 #endif /* !KERNEL || KERNEL_PRIVATE */
 384
 385 #ifdef KERNEL_PRIVATE
 386 #pragma pack(4)
 387 struct ifmediareq64 {
 388         char    ifm_name[IFNAMSIZ];     /* if name, e.g. "en0" */
 389         int     ifm_current;            /* current media options */
 390         int     ifm_mask;               /* don't care mask */
 391         int     ifm_status;             /* media status */
 392         int     ifm_active;             /* active options */
 393         int     ifm_count;              /* # entries in ifm_ulist array */
 394         user64_addr_t ifmu_ulist __attribute__((aligned(8)));
 395 };
 396
 397 struct ifmediareq32 {
 398         char    ifm_name[IFNAMSIZ];     /* if name, e.g. "en0" */
 399         int     ifm_current;            /* current media options */
 400         int     ifm_mask;               /* don't care mask */
 401         int     ifm_status;             /* media status */
 402         int     ifm_active;             /* active options */
 403         int     ifm_count;              /* # entries in ifm_ulist array */
 404         user32_addr_t ifmu_ulist;       /* 32-bit pointer */
 405 };
 406 #pragma pack()
 407 #endif /* KERNEL_PRIVATE */
 408
 409 /*
 410  * Structure used to retrieve aux status data from interfaces.
 411  * Kernel suppliers to this interface should respect the formatting
 412  * needed by ifconfig(8): each line starts with a TAB and ends with
 413  * a newline.  The canonical example to copy and paste is in if_tun.c.
 414  */
 415
 416 #define IFSTATMAX       800             /* 10 lines of text */
 417 struct ifstat {
 418         char    ifs_name[IFNAMSIZ];     /* if name, e.g. "en0" */
 419         char    ascii[IFSTATMAX + 1];
 420 };
 421
 422 #if !defined(KERNEL) || defined(KERNEL_PRIVATE)
 423 /*
 424  * Structure used in SIOCGIFCONF request.
 425  * Used to retrieve interface configuration
 426  * for machine (useful for programs which
 427  * must know all networks accessible).
 428  */
 429 #pragma pack(4)
 430 struct  ifconf {
 431         int     ifc_len;                /* size of associated buffer */
 432         union {
 433                 caddr_t ifcu_buf;
 434                 struct  ifreq *ifcu_req;
 435         } ifc_ifcu;
 436 };
 437 #pragma pack()
 438 #define ifc_buf ifc_ifcu.ifcu_buf       /* buffer address */
 439 #define ifc_req ifc_ifcu.ifcu_req       /* array of structures returned */
 440 #endif /* !KERNEL || KERNEL_PRIVATE */
 441
 442 #if defined(KERNEL_PRIVATE)
 443 #pragma pack(4)
 444 struct ifconf32 {
 445         int     ifc_len;                /* size of associated buffer */
 446         struct {
 447                 user32_addr_t ifcu_req;
 448         } ifc_ifcu;
 449 };
 450
 451 struct ifconf64 {
 452         int     ifc_len;                /* size of associated buffer */
 453         struct {
 454                 user64_addr_t ifcu_req  __attribute__((aligned(8)));
 455         } ifc_ifcu;
 456 };
 457 #pragma pack()
 458 #endif /* KERNEL_PRIVATE */
 459
 460 /*
 461  * DLIL KEV_DL_PROTO_ATTACHED/DETACHED structure
 462  */
 463 struct kev_dl_proto_data {
 464      struct net_event_data      link_data;
 465      u_int32_t                  proto_family;
 466      u_int32_t                  proto_remaining_count;
 467 };
 468
 469 /*
 470  * Structure for SIOC[AGD]LIFADDR
 471  */
 472 struct if_laddrreq {
 473         char                    iflr_name[IFNAMSIZ];
 474         unsigned int            flags;
 475 #define IFLR_PREFIX     0x8000  /* in: prefix given  out: kernel fills id */
 476         unsigned int            prefixlen;         /* in/out */
 477         struct sockaddr_storage addr;   /* in/out */
 478         struct sockaddr_storage dstaddr; /* out */
 479 };
 480
 481 #ifdef KERNEL
 482 #ifdef MALLOC_DECLARE
 483 MALLOC_DECLARE(M_IFADDR);
 484 MALLOC_DECLARE(M_IFMADDR);
 485 #endif
 486 #endif
 487 #endif /* (_POSIX_C_SOURCE && !_DARWIN_C_SOURCE) */
 488
 489 #ifndef KERNEL
 490 struct if_nameindex {
 491         unsigned int     if_index;      /* 1, 2, ... */
 492         char            *if_name;       /* null terminated name: "le0", ... */
 493 };
 494
 495 __BEGIN_DECLS
 496 unsigned int     if_nametoindex(const char *);
 497 char            *if_indextoname(unsigned int, char *);
 498 struct           if_nameindex *if_nameindex(void);
 499 void             if_freenameindex(struct if_nameindex *);
 500 __END_DECLS
 501 #endif
 502
 503 #ifdef KERNEL
 504 #include <net/kpi_interface.h>
 505 #endif
 506
 507 #endif /* !_NET_IF_H_ */