packages/net/bsd_tcpip/v2_0/include/net/if.h

   1 //==========================================================================
   2 //
   3 //      include/net/if.h
   4 //
   5 //==========================================================================
   6 //####BSDCOPYRIGHTBEGIN####
   7 //
   8 // -------------------------------------------
   9 //
  10 // Portions of this software may have been derived from OpenBSD,
  11 // FreeBSD or other sources, and are covered by the appropriate
  12 // copyright disclaimers included herein.
  13 //
  14 // Portions created by Red Hat are
  15 // Copyright (C) 2002 Red Hat, Inc. All Rights Reserved.
  16 //
  17 // -------------------------------------------
  18 //
  19 //####BSDCOPYRIGHTEND####
  20 //==========================================================================
  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  * $FreeBSD: src/sys/net/if.h,v 1.58.2.2 2001/07/24 19:10:18 brooks Exp $
  56  */
  57
  58 #ifndef _NET_IF_H_
  59 #define _NET_IF_H_
  60
  61 #include <sys/queue.h>
  62
  63 /*
  64  * <net/if.h> does not depend on <sys/time.h> on most other systems.  This
  65  * helps userland compatability.  (struct timeval ifi_lastchange)
  66  */
  67 #ifndef _KERNEL
  68 #include <sys/time.h>
  69 #endif
  70
  71 struct ifnet;
  72
  73 /*
  74  * Length of interface external name, including terminating '\0'.
  75  * Note: this is the same size as a generic device's external name.
  76  */
  77 #define         IFNAMSIZ        16
  78 #define         IF_NAMESIZE     IFNAMSIZ
  79
  80 /*
  81  * Structure describing a `cloning' interface.
  82  */
  83 struct if_clone {
  84         LIST_ENTRY(if_clone) ifc_list;  /* on list of cloners */
  85         const char *ifc_name;           /* name of device, e.g. `gif' */
  86         size_t ifc_namelen;             /* length of name */
  87
  88         int     (*ifc_create)(struct if_clone *, int *);
  89         void    (*ifc_destroy)(struct ifnet *);
  90 };
  91
  92 #define IF_CLONE_INITIALIZER(name, create, destroy)                     \
  93         { { 0 }, name, sizeof(name) - 1, create, destroy }
  94
  95 /*
  96  * Structure used to query names of interface cloners.
  97  */
  98
  99 struct if_clonereq {
 100         int     ifcr_total;             /* total cloners (out) */
 101         int     ifcr_count;             /* room for this many in user buffer */
 102         char    *ifcr_buffer;           /* buffer for cloner names */
 103 };
 104
 105 /*
 106  * Structure describing information about an interface
 107  * which may be of interest to management entities.
 108  */
 109 struct if_data {
 110         /* generic interface information */
 111         u_char  ifi_type;               /* ethernet, tokenring, etc */
 112         u_char  ifi_physical;           /* e.g., AUI, Thinnet, 10base-T, etc */
 113         u_char  ifi_addrlen;            /* media address length */
 114         u_char  ifi_hdrlen;             /* media header length */
 115         u_char  ifi_recvquota;          /* polling quota for receive intrs */
 116         u_char  ifi_xmitquota;          /* polling quota for xmit intrs */
 117         u_long  ifi_mtu;                /* maximum transmission unit */
 118         u_long  ifi_metric;             /* routing metric (external only) */
 119         u_long  ifi_baudrate;           /* linespeed */
 120         /* volatile statistics */
 121         u_long  ifi_ipackets;           /* packets received on interface */
 122         u_long  ifi_ierrors;            /* input errors on interface */
 123         u_long  ifi_opackets;           /* packets sent on interface */
 124         u_long  ifi_oerrors;            /* output errors on interface */
 125         u_long  ifi_collisions;         /* collisions on csma interfaces */
 126         u_long  ifi_ibytes;             /* total number of octets received */
 127         u_long  ifi_obytes;             /* total number of octets sent */
 128         u_long  ifi_imcasts;            /* packets received via multicast */
 129         u_long  ifi_omcasts;            /* packets sent via multicast */
 130         u_long  ifi_iqdrops;            /* dropped on input, this interface */
 131         u_long  ifi_noproto;            /* destined for unsupported protocol */
 132         u_long  ifi_hwassist;           /* HW offload capabilities */
 133         u_long  ifi_unused;             /* XXX was ifi_xmittiming */
 134         struct  timeval ifi_lastchange; /* time of last administrative change */
 135 };
 136
 137 #define IFF_UP          0x1             /* interface is up */
 138 #define IFF_BROADCAST   0x2             /* broadcast address valid */
 139 #define IFF_DEBUG       0x4             /* turn on debugging */
 140 #define IFF_LOOPBACK    0x8             /* is a loopback net */
 141 #define IFF_POINTOPOINT 0x10            /* interface is point-to-point link */
 142 #define IFF_SMART       0x20            /* interface manages own routes */
 143 #define IFF_RUNNING     0x40            /* resources allocated */
 144 #define IFF_NOARP       0x80            /* no address resolution protocol */
 145 #define IFF_PROMISC     0x100           /* receive all packets */
 146 #define IFF_ALLMULTI    0x200           /* receive all multicast packets */
 147 #define IFF_OACTIVE     0x400           /* transmission in progress */
 148 #define IFF_SIMPLEX     0x800           /* can't hear own transmissions */
 149 #define IFF_LINK0       0x1000          /* per link layer defined bit */
 150 #define IFF_LINK1       0x2000          /* per link layer defined bit */
 151 #define IFF_LINK2       0x4000          /* per link layer defined bit */
 152 #define IFF_ALTPHYS     IFF_LINK2       /* use alternate physical connection */
 153 #define IFF_MULTICAST   0x8000          /* supports multicast */
 154
 155 /* flags set internally only: */
 156 #define IFF_CANTCHANGE \
 157         (IFF_BROADCAST|IFF_POINTOPOINT|IFF_RUNNING|IFF_OACTIVE|\
 158             IFF_LOOPBACK|IFF_SIMPLEX|IFF_MULTICAST|IFF_ALLMULTI|IFF_SMART)
 159
 160 #define IFQ_MAXLEN      50
 161 #define IFNET_SLOWHZ    1               /* granularity is 1 second */
 162
 163 /*
 164  * Message format for use in obtaining information about interfaces
 165  * from getkerninfo and the routing socket
 166  */
 167 struct if_msghdr {
 168         u_short ifm_msglen;     /* to skip over non-understood messages */
 169         u_char  ifm_version;    /* future binary compatability */
 170         u_char  ifm_type;       /* message type */
 171         int     ifm_addrs;      /* like rtm_addrs */
 172         int     ifm_flags;      /* value of if_flags */
 173         u_short ifm_index;      /* index for associated ifp */
 174         struct  if_data ifm_data;/* statistics and other data about if */
 175 };
 176
 177 /*
 178  * Message format for use in obtaining information about interface addresses
 179  * from getkerninfo and the routing socket
 180  */
 181 struct ifa_msghdr {
 182         u_short ifam_msglen;    /* to skip over non-understood messages */
 183         u_char  ifam_version;   /* future binary compatability */
 184         u_char  ifam_type;      /* message type */
 185         int     ifam_addrs;     /* like rtm_addrs */
 186         int     ifam_flags;     /* value of ifa_flags */
 187         u_short ifam_index;     /* index for associated ifp */
 188         int     ifam_metric;    /* value of ifa_metric */
 189 };
 190
 191 /*
 192  * Message format for use in obtaining information about multicast addresses
 193  * from the routing socket
 194  */
 195 struct ifma_msghdr {
 196         u_short ifmam_msglen;   /* to skip over non-understood messages */
 197         u_char  ifmam_version;  /* future binary compatability */
 198         u_char  ifmam_type;     /* message type */
 199         int     ifmam_addrs;    /* like rtm_addrs */
 200         int     ifmam_flags;    /* value of ifa_flags */
 201         u_short ifmam_index;    /* index for associated ifp */
 202 };
 203
 204 /*
 205  * Interface request structure used for socket
 206  * ioctl's.  All interface ioctl's must have parameter
 207  * definitions which begin with ifr_name.  The
 208  * remainder may be interface specific.
 209  */
 210 struct  ifreq {
 211 #define IFHWADDRLEN  6
 212         char    ifr_name[IFNAMSIZ];             /* if name, e.g. "en0" */
 213         union {
 214                 struct  sockaddr ifru_addr;
 215                 struct  sockaddr ifru_dstaddr;
 216                 struct  sockaddr ifru_broadaddr;
 217                 struct  sockaddr ifru_hwaddr;
 218                 short   ifru_flags[2];
 219                 int     ifru_metric;
 220                 int     ifru_mtu;
 221                 int     ifru_phys;
 222                 int     ifru_media;
 223                 caddr_t ifru_data;
 224         } ifr_ifru;
 225 #define ifr_addr        ifr_ifru.ifru_addr      /* address */
 226 #define ifr_hwaddr      ifr_ifru.ifru_hwaddr    /* MAC address */
 227 #define ifr_dstaddr     ifr_ifru.ifru_dstaddr   /* other end of p-to-p link */
 228 #define ifr_broadaddr   ifr_ifru.ifru_broadaddr /* broadcast address */
 229 #define ifr_flags       ifr_ifru.ifru_flags[0]  /* flags */
 230 #define ifr_prevflags   ifr_ifru.ifru_flags[1]  /* flags */
 231 #define ifr_metric      ifr_ifru.ifru_metric    /* metric */
 232 #define ifr_mtu         ifr_ifru.ifru_mtu       /* mtu */
 233 #define ifr_phys        ifr_ifru.ifru_phys      /* physical wire */
 234 #define ifr_media       ifr_ifru.ifru_media     /* physical media */
 235 #define ifr_data        ifr_ifru.ifru_data      /* for use by interface */
 236 };
 237
 238 #define _SIZEOF_ADDR_IFREQ(ifr) \
 239         ((ifr).ifr_addr.sa_len > sizeof(struct sockaddr) ? \
 240          (sizeof(struct ifreq) - sizeof(struct sockaddr) + \
 241           (ifr).ifr_addr.sa_len) : sizeof(struct ifreq))
 242
 243 struct ifaliasreq {
 244         char    ifra_name[IFNAMSIZ];            /* if name, e.g. "en0" */
 245         struct  sockaddr ifra_addr;
 246         struct  sockaddr ifra_broadaddr;
 247         struct  sockaddr ifra_mask;
 248 };
 249
 250 struct ifmediareq {
 251         char    ifm_name[IFNAMSIZ];     /* if name, e.g. "en0" */
 252         int     ifm_current;            /* current media options */
 253         int     ifm_mask;               /* don't care mask */
 254         int     ifm_status;             /* media status */
 255         int     ifm_active;             /* active options */
 256         int     ifm_count;              /* # entries in ifm_ulist array */
 257         int     *ifm_ulist;             /* media words */
 258 };
 259
 260 /*
 261  * Structure used to retrieve aux status data from interfaces.
 262  * Kernel suppliers to this interface should respect the formatting
 263  * needed by ifconfig(8): each line starts with a TAB and ends with
 264  * a newline.  The canonical example to copy and paste is in if_tun.c.
 265  */
 266
 267 #define IFSTATMAX       800             /* 10 lines of text */
 268 struct ifstat {
 269         char    ifs_name[IFNAMSIZ];     /* if name, e.g. "en0" */
 270         char    ascii[IFSTATMAX + 1];
 271 };
 272
 273 /*
 274  * Structure used in SIOCGIFCONF request.
 275  * Used to retrieve interface configuration
 276  * for machine (useful for programs which
 277  * must know all networks accessible).
 278  */
 279 struct  ifconf {
 280         int     ifc_len;                /* size of associated buffer */
 281         union {
 282                 caddr_t ifcu_buf;
 283                 struct  ifreq *ifcu_req;
 284         } ifc_ifcu;
 285 #define ifc_buf ifc_ifcu.ifcu_buf       /* buffer address */
 286 #define ifc_req ifc_ifcu.ifcu_req       /* array of structures returned */
 287 };
 288
 289
 290 /*
 291  * Structure for SIOC[AGD]LIFADDR
 292  */
 293 struct if_laddrreq {
 294         char    iflr_name[IFNAMSIZ];
 295         u_int   flags;
 296 #define IFLR_PREFIX     0x8000  /* in: prefix given  out: kernel fills id */
 297         u_int   prefixlen;         /* in/out */
 298         struct  sockaddr_storage addr;   /* in/out */
 299         struct  sockaddr_storage dstaddr; /* out */
 300 };
 301
 302 #ifdef _KERNEL
 303 #ifdef MALLOC_DECLARE
 304 MALLOC_DECLARE(M_IFADDR);
 305 MALLOC_DECLARE(M_IFMADDR);
 306 #endif
 307 #endif
 308
 309 #ifndef _KERNEL
 310 struct if_nameindex {
 311         u_int   if_index;       /* 1, 2, ... */
 312         char    *if_name;       /* null terminated name: "le0", ... */
 313 };
 314
 315 __BEGIN_DECLS
 316 u_int    if_nametoindex __P((const char *));
 317 char    *if_indextoname __P((u_int, char *));
 318 struct   if_nameindex *if_nameindex __P((void));
 319 void     if_freenameindex __P((struct if_nameindex *));
 320 __END_DECLS
 321 #endif
 322
 323 #ifdef _KERNEL
 324 /* XXX - this should go away soon. */
 325 #include <net/if_var.h>
 326 #endif
 327
 328 #endif /* !_NET_IF_H_ */