sys/net/if.h

   1 /*
   2  * Copyright (c) 1982, 1986, 1989, 1993
   3  *      The Regents of the University of California.  All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  * 3. All advertising materials mentioning features or use of this software
  14  *    must display the following acknowledgement:
  15  *      This product includes software developed by the University of
  16  *      California, Berkeley and its contributors.
  17  * 4. Neither the name of the University nor the names of its contributors
  18  *    may be used to endorse or promote products derived from this software
  19  *    without specific prior written permission.
  20  *
  21  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  22  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  24  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  25  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  26  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  27  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  28  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  30  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  31  * SUCH DAMAGE.
  32  *
  33  *      @(#)if.h        8.1 (Berkeley) 6/10/93
  34  * $FreeBSD$
  35  */
  36
  37 #ifndef _NET_IF_H_
  38 #define _NET_IF_H_
  39
  40 #include <sys/queue.h>
  41
  42 /*
  43  * <net/if.h> does not depend on <sys/time.h> on most other systems.  This
  44  * helps userland compatibility.  (struct timeval ifi_lastchange)
  45  */
  46 #ifndef _KERNEL
  47 #include <sys/time.h>
  48 #endif
  49
  50 struct ifnet;
  51
  52 /*
  53  * Length of interface external name, including terminating '\0'.
  54  * Note: this is the same size as a generic device's external name.
  55  */
  56 #define         IFNAMSIZ        16
  57 #define         IF_NAMESIZE     IFNAMSIZ
  58 #define         IF_MAXUNIT      0x7fff  /* ifp->if_unit is only 15 bits */
  59
  60 /*
  61  * Structure describing a `cloning' interface.
  62  */
  63 struct if_clone {
  64         LIST_ENTRY(if_clone) ifc_list;  /* on list of cloners */
  65         const char *ifc_name;           /* name of device, e.g. `gif' */
  66         size_t ifc_namelen;             /* length of name */
  67         int ifc_maxunit;                /* maximum unit number */
  68         unsigned char *ifc_units;       /* bitmap to handle units */
  69         int ifc_bmlen;                  /* bitmap length */
  70
  71         int     (*ifc_create)(struct if_clone *, int);
  72         int     (*ifc_destroy)(struct ifnet *);
  73 };
  74
  75 #define IF_CLONE_INITIALIZER(name, create, destroy, maxunit)            \
  76         { { 0 }, name, sizeof(name) - 1, maxunit, NULL, 0, create, destroy }
  77
  78 /*
  79  * Structure used to query names of interface cloners.
  80  */
  81
  82 struct if_clonereq {
  83         int     ifcr_total;             /* total cloners (out) */
  84         int     ifcr_count;             /* room for this many in user buffer */
  85         char    *ifcr_buffer;           /* buffer for cloner names */
  86 };
  87
  88 /*
  89  * Structure describing information about an interface
  90  * which may be of interest to management entities.
  91  */
  92 struct if_data {
  93         /* generic interface information */
  94         u_char  ifi_type;               /* ethernet, tokenring, etc */
  95         u_char  ifi_physical;           /* e.g., AUI, Thinnet, 10base-T, etc */
  96         u_char  ifi_addrlen;            /* media address length */
  97         u_char  ifi_hdrlen;             /* media header length */
  98         u_char  ifi_recvquota;          /* polling quota for receive intrs */
  99         u_char  ifi_xmitquota;          /* polling quota for xmit intrs */
 100         u_long  ifi_mtu;                /* maximum transmission unit */
 101         u_long  ifi_metric;             /* routing metric (external only) */
 102         u_long  ifi_baudrate;           /* linespeed */
 103         /* volatile statistics */
 104         u_long  ifi_ipackets;           /* packets received on interface */
 105         u_long  ifi_ierrors;            /* input errors on interface */
 106         u_long  ifi_opackets;           /* packets sent on interface */
 107         u_long  ifi_oerrors;            /* output errors on interface */
 108         u_long  ifi_collisions;         /* collisions on csma interfaces */
 109         u_long  ifi_ibytes;             /* total number of octets received */
 110         u_long  ifi_obytes;             /* total number of octets sent */
 111         u_long  ifi_imcasts;            /* packets received via multicast */
 112         u_long  ifi_omcasts;            /* packets sent via multicast */
 113         u_long  ifi_iqdrops;            /* dropped on input, this interface */
 114         u_long  ifi_noproto;            /* destined for unsupported protocol */
 115         u_long  ifi_hwassist;           /* HW offload capabilities */
 116         u_long  ifi_unused;             /* XXX was ifi_xmittiming */
 117         struct  timeval ifi_lastchange; /* time of last administrative change */
 118 };
 119
 120 #define IFF_UP          0x1             /* interface is up */
 121 #define IFF_BROADCAST   0x2             /* broadcast address valid */
 122 #define IFF_DEBUG       0x4             /* turn on debugging */
 123 #define IFF_LOOPBACK    0x8             /* is a loopback net */
 124 #define IFF_POINTOPOINT 0x10            /* interface is point-to-point link */
 125 #define IFF_SMART       0x20            /* interface manages own routes */
 126 #define IFF_RUNNING     0x40            /* resources allocated */
 127 #define IFF_NOARP       0x80            /* no address resolution protocol */
 128 #define IFF_PROMISC     0x100           /* receive all packets */
 129 #define IFF_ALLMULTI    0x200           /* receive all multicast packets */
 130 #define IFF_OACTIVE     0x400           /* transmission in progress */
 131 #define IFF_SIMPLEX     0x800           /* can't hear own transmissions */
 132 #define IFF_LINK0       0x1000          /* per link layer defined bit */
 133 #define IFF_LINK1       0x2000          /* per link layer defined bit */
 134 #define IFF_LINK2       0x4000          /* per link layer defined bit */
 135 #define IFF_ALTPHYS     IFF_LINK2       /* use alternate physical connection */
 136 #define IFF_MULTICAST   0x8000          /* supports multicast */
 137
 138 /*
 139  * The following flag(s) ought to go in if_flags, but we cannot change
 140  * struct ifnet because of binary compatibility, so we store them in
 141  * if_ipending, which is not used so far.
 142  * If possible, make sure the value is not conflicting with other
 143  * IFF flags, so we have an easier time when we want to merge them.
 144  */
 145 #define IFF_POLLING     0x10000         /* Interface is in polling mode. */
 146
 147 /* flags set internally only: */
 148 #define IFF_CANTCHANGE \
 149         (IFF_BROADCAST|IFF_POINTOPOINT|IFF_RUNNING|IFF_OACTIVE|\
 150             IFF_SIMPLEX|IFF_MULTICAST|IFF_ALLMULTI|IFF_SMART)
 151
 152 /* Capabilities that interfaces can advertise. */
 153 #define IFCAP_RXCSUM            0x0001  /* can offload checksum on RX */
 154 #define IFCAP_TXCSUM            0x0002  /* can offload checksum on TX */
 155 #define IFCAP_NETCONS           0x0004  /* can be a network console */
 156
 157 #define IFCAP_HWCSUM            (IFCAP_RXCSUM | IFCAP_TXCSUM)
 158
 159 #define IFQ_MAXLEN      50
 160 #define IFNET_SLOWHZ    1               /* granularity is 1 second */
 161
 162 /*
 163  * Message format for use in obtaining information about interfaces
 164  * from getkerninfo and the routing socket
 165  */
 166 struct if_msghdr {
 167         u_short ifm_msglen;     /* to skip over non-understood messages */
 168         u_char  ifm_version;    /* future binary compatibility */
 169         u_char  ifm_type;       /* message type */
 170         int     ifm_addrs;      /* like rtm_addrs */
 171         int     ifm_flags;      /* value of if_flags */
 172         u_short ifm_index;      /* index for associated ifp */
 173         struct  if_data ifm_data;/* statistics and other data about if */
 174 };
 175
 176 /*
 177  * Message format for use in obtaining information about interface addresses
 178  * from getkerninfo and the routing socket
 179  */
 180 struct ifa_msghdr {
 181         u_short ifam_msglen;    /* to skip over non-understood messages */
 182         u_char  ifam_version;   /* future binary compatibility */
 183         u_char  ifam_type;      /* message type */
 184         int     ifam_addrs;     /* like rtm_addrs */
 185         int     ifam_flags;     /* value of ifa_flags */
 186         u_short ifam_index;     /* index for associated ifp */
 187         int     ifam_metric;    /* value of ifa_metric */
 188 };
 189
 190 /*
 191  * Message format for use in obtaining information about multicast addresses
 192  * from the routing socket
 193  */
 194 struct ifma_msghdr {
 195         u_short ifmam_msglen;   /* to skip over non-understood messages */
 196         u_char  ifmam_version;  /* future binary compatibility */
 197         u_char  ifmam_type;     /* message type */
 198         int     ifmam_addrs;    /* like rtm_addrs */
 199         int     ifmam_flags;    /* value of ifa_flags */
 200         u_short ifmam_index;    /* index for associated ifp */
 201 };
 202
 203 /*
 204  * Message format announcing the arrival or departure of a network interface.
 205  */
 206 struct if_announcemsghdr {
 207         u_short ifan_msglen;    /* to skip over non-understood messages */
 208         u_char  ifan_version;   /* future binary compatibility */
 209         u_char  ifan_type;      /* message type */
 210         u_short ifan_index;     /* index for associated ifp */
 211         char    ifan_name[IFNAMSIZ]; /* if name, e.g. "en0" */
 212         u_short ifan_what;      /* what type of announcement */
 213 };
 214
 215 #define IFAN_ARRIVAL    0       /* interface arrival */
 216 #define IFAN_DEPARTURE  1       /* interface departure */
 217
 218 /*
 219  * Interface request structure used for socket
 220  * ioctl's.  All interface ioctl's must have parameter
 221  * definitions which begin with ifr_name.  The
 222  * remainder may be interface specific.
 223  */
 224 struct  ifreq {
 225         char    ifr_name[IFNAMSIZ];             /* if name, e.g. "en0" */
 226         union {
 227                 struct  sockaddr ifru_addr;
 228                 struct  sockaddr ifru_dstaddr;
 229                 struct  sockaddr ifru_broadaddr;
 230                 short   ifru_flags[2];
 231                 short   ifru_index;
 232                 int     ifru_metric;
 233                 int     ifru_mtu;
 234                 int     ifru_phys;
 235                 int     ifru_media;
 236                 caddr_t ifru_data;
 237                 int     ifru_cap[2];
 238         } ifr_ifru;
 239 #define ifr_addr        ifr_ifru.ifru_addr      /* address */
 240 #define ifr_dstaddr     ifr_ifru.ifru_dstaddr   /* other end of p-to-p link */
 241 #define ifr_broadaddr   ifr_ifru.ifru_broadaddr /* broadcast address */
 242 #define ifr_flags       ifr_ifru.ifru_flags[0]  /* flags */
 243 #define ifr_prevflags   ifr_ifru.ifru_flags[1]  /* flags */
 244 #define ifr_metric      ifr_ifru.ifru_metric    /* metric */
 245 #define ifr_mtu         ifr_ifru.ifru_mtu       /* mtu */
 246 #define ifr_phys        ifr_ifru.ifru_phys      /* physical wire */
 247 #define ifr_media       ifr_ifru.ifru_media     /* physical media */
 248 #define ifr_data        ifr_ifru.ifru_data      /* for use by interface */
 249 #define ifr_reqcap      ifr_ifru.ifru_cap[0]    /* requested capabilities */
 250 #define ifr_curcap      ifr_ifru.ifru_cap[1]    /* current capabilities */
 251 #define ifr_index       ifr_ifru.ifru_index     /* interface index */
 252 };
 253
 254 #define _SIZEOF_ADDR_IFREQ(ifr) \
 255         ((ifr).ifr_addr.sa_len > sizeof(struct sockaddr) ? \
 256          (sizeof(struct ifreq) - sizeof(struct sockaddr) + \
 257           (ifr).ifr_addr.sa_len) : sizeof(struct ifreq))
 258
 259 struct ifaliasreq {
 260         char    ifra_name[IFNAMSIZ];            /* if name, e.g. "en0" */
 261         struct  sockaddr ifra_addr;
 262         struct  sockaddr ifra_broadaddr;
 263         struct  sockaddr ifra_mask;
 264 };
 265
 266 struct ifmediareq {
 267         char    ifm_name[IFNAMSIZ];     /* if name, e.g. "en0" */
 268         int     ifm_current;            /* current media options */
 269         int     ifm_mask;               /* don't care mask */
 270         int     ifm_status;             /* media status */
 271         int     ifm_active;             /* active options */
 272         int     ifm_count;              /* # entries in ifm_ulist array */
 273         int     *ifm_ulist;             /* media words */
 274 };
 275
 276 /*
 277  * Structure used to retrieve aux status data from interfaces.
 278  * Kernel suppliers to this interface should respect the formatting
 279  * needed by ifconfig(8): each line starts with a TAB and ends with
 280  * a newline.  The canonical example to copy and paste is in if_tun.c.
 281  */
 282
 283 #define IFSTATMAX       800             /* 10 lines of text */
 284 struct ifstat {
 285         char    ifs_name[IFNAMSIZ];     /* if name, e.g. "en0" */
 286         char    ascii[IFSTATMAX + 1];
 287 };
 288
 289 /*
 290  * Structure used in SIOCGIFCONF request.
 291  * Used to retrieve interface configuration
 292  * for machine (useful for programs which
 293  * must know all networks accessible).
 294  */
 295 struct  ifconf {
 296         int     ifc_len;                /* size of associated buffer */
 297         union {
 298                 caddr_t ifcu_buf;
 299                 struct  ifreq *ifcu_req;
 300         } ifc_ifcu;
 301 #define ifc_buf ifc_ifcu.ifcu_buf       /* buffer address */
 302 #define ifc_req ifc_ifcu.ifcu_req       /* array of structures returned */
 303 };
 304
 305
 306 /*
 307  * Structure for SIOC[AGD]LIFADDR
 308  */
 309 struct if_laddrreq {
 310         char    iflr_name[IFNAMSIZ];
 311         u_int   flags;
 312 #define IFLR_PREFIX     0x8000  /* in: prefix given  out: kernel fills id */
 313         u_int   prefixlen;         /* in/out */
 314         struct  sockaddr_storage addr;   /* in/out */
 315         struct  sockaddr_storage dstaddr; /* out */
 316 };
 317
 318 #ifdef _KERNEL
 319 #ifdef MALLOC_DECLARE
 320 MALLOC_DECLARE(M_IFADDR);
 321 MALLOC_DECLARE(M_IFMADDR);
 322 #endif
 323 #endif
 324
 325 #ifndef _KERNEL
 326 struct if_nameindex {
 327         u_int   if_index;       /* 1, 2, ... */
 328         char    *if_name;       /* null terminated name: "le0", ... */
 329 };
 330
 331 __BEGIN_DECLS
 332 u_int    if_nametoindex __P((const char *));
 333 char    *if_indextoname __P((u_int, char *));
 334 struct   if_nameindex *if_nameindex __P((void));
 335 void     if_freenameindex __P((struct if_nameindex *));
 336 __END_DECLS
 337 #endif
 338
 339 #ifdef _KERNEL
 340 struct thread;
 341
 342 /* XXX - this should go away soon. */
 343 #include <net/if_var.h>
 344 #endif
 345
 346 #endif /* !_NET_IF_H_ */