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