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: src/sys/net/if.h,v 1.58.2.9 2002/08/30 14:23:38 sobomax Exp $
  35  * $DragonFly: src/sys/net/if.h,v 1.21 2008/08/30 16:07:59 hasso Exp $
  36  */
  37
  38 #ifndef _NET_IF_H_
  39 #define _NET_IF_H_
  40
  41 #ifndef _SYS_TYPES_H_
  42 #include <sys/types.h>
  43 #endif
  44 #ifndef _SYS_TIME_H_
  45 #include <sys/time.h>
  46 #endif
  47 #ifndef _SYS_SOCKET_H_
  48 #include <sys/socket.h>
  49 #endif
  50
  51 #ifdef _KERNEL
  52
  53 #ifndef _SYS_QUEUE_H_
  54 #include <sys/queue.h>
  55 #endif
  56
  57 #endif
  58
  59 /*
  60  * Values for if_link_state.
  61  */
  62 #define LINK_STATE_UNKNOWN      0       /* link invalid/unknown */
  63 #define LINK_STATE_DOWN         1       /* link is down */
  64 #define LINK_STATE_UP           2       /* link is up */
  65 #define LINK_STATE_IS_UP(_s)    ((_s) >= LINK_STATE_UP)
  66
  67 struct ifnet;
  68
  69 /*
  70  * Length of interface external name, including terminating '\0'.
  71  * Note: this is the same size as a generic device's external name.
  72  */
  73 #define         IFNAMSIZ        16
  74 #define         IF_NAMESIZE     IFNAMSIZ
  75 #define         IF_MAXUNIT      0x7fff          /* if_unit is 15bits */
  76
  77 /*
  78  * Structure used to query names of interface cloners.
  79  * XXX should be moved to net/if_clone.h
  80  */
  81 struct if_clonereq {
  82         int     ifcr_total;             /* total cloners (out) */
  83         int     ifcr_count;             /* room for this many in user buffer */
  84         char    *ifcr_buffer;           /* buffer for cloner names */
  85 };
  86
  87 /*
  88  * Structure describing information about an interface
  89  * which may be of interest to management entities.
  90  */
  91 struct if_data {
  92         /* generic interface information */
  93         u_char  ifi_type;               /* ethernet, tokenring, etc */
  94         u_char  ifi_physical;           /* e.g., AUI, Thinnet, 10base-T, etc */
  95         u_char  ifi_addrlen;            /* media address length */
  96         u_char  ifi_hdrlen;             /* media header length */
  97         u_char  ifi_recvquota;          /* polling quota for receive intrs */
  98         u_char  ifi_xmitquota;          /* polling quota for xmit intrs */
  99         u_long  ifi_mtu;                /* maximum transmission unit */
 100         u_long  ifi_metric;             /* routing metric (external only) */
 101         u_long  ifi_link_state;         /* current link state */
 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 #define IFF_POLLING     0x10000         /* Interface is in polling mode. */
 138 #define IFF_PPROMISC    0x20000         /* user-requested promisc mode */
 139 #define IFF_MONITOR     0x40000         /* user-requested monitor mode */
 140 #define IFF_STATICARP   0x80000         /* static ARP */
 141 #define IFF_NPOLLING    0x100000        /* ifpoll is used */
 142
 143 /* flags set internally only: */
 144 #define IFF_CANTCHANGE \
 145         (IFF_BROADCAST|IFF_POINTOPOINT|IFF_RUNNING|IFF_OACTIVE|\
 146          IFF_SIMPLEX|IFF_MULTICAST|IFF_ALLMULTI|IFF_SMART|IFF_POLLING|\
 147          IFF_NPOLLING)
 148
 149 /*
 150  * Some convenience macros used for setting ifi_baudrate.
 151  * XXX 1000 vs. 1024? --thorpej@netbsd.org
 152  */
 153 #define IF_Kbps(x)      ((x) * 1000)            /* kilobits/sec. */
 154 #define IF_Mbps(x)      (IF_Kbps((x) * 1000))   /* megabits/sec. */
 155 #define IF_Gbps(x)      (IF_Mbps((x) * 1000))   /* gigabits/sec. */
 156
 157 /* Capabilities that interfaces can advertise. */
 158 #define IFCAP_RXCSUM            0x00001 /* can offload checksum on RX */
 159 #define IFCAP_TXCSUM            0x00002 /* can offload checksum on TX */
 160 #define IFCAP_NETCONS           0x00004 /* can be a network console */
 161 #define IFCAP_VLAN_MTU          0x00008 /* VLAN-compatible MTU */
 162 #define IFCAP_VLAN_HWTAGGING    0x00010 /* hardware VLAN tag support */
 163 #define IFCAP_JUMBO_MTU         0x00020 /* 9000 byte MTU support */
 164 #define IFCAP_RSS               0x00040 /* Receive Side Scaling for IPv4 */
 165 #define IFCAP_VLAN_HWCSUM       0x00080 /* can do IFCAP_HWCSUM on VLANs */
 166 #define IFCAP_TSO4              0x00100 /* can do TCP Segmentation Offload */
 167 #define IFCAP_TSO6              0x00200 /* can do TCP6 Segmentation Offload */
 168 #define IFCAP_LRO               0x00400 /* can do Large Receive Offload */
 169 #define IFCAP_WOL_UCAST         0x00800 /* wake on any unicast frame */
 170 #define IFCAP_WOL_MCAST         0x01000 /* wake on any multicast frame */
 171 #define IFCAP_WOL_MAGIC         0x02000 /* wake on any Magic Packet */
 172 #define IFCAP_TOE4              0x04000 /* interface can offload TCP */
 173 #define IFCAP_TOE6              0x08000 /* interface can offload TCP6 */
 174 #define IFCAP_VLAN_HWFILTER     0x10000 /* interface hw can filter vlan tag */
 175 #define IFCAP_POLLING_NOCOUNT   0x20000 /* polling ticks cannot be fragmented */
 176 #define IFCAP_VLAN_HWTSO        0x40000 /* can do IFCAP_TSO on VLANs */
 177
 178
 179 #define IFCAP_HWCSUM    (IFCAP_RXCSUM | IFCAP_TXCSUM)
 180 #define IFCAP_TSO       (IFCAP_TSO4 | IFCAP_TSO6)
 181 #define IFCAP_WOL       (IFCAP_WOL_UCAST | IFCAP_WOL_MCAST | IFCAP_WOL_MAGIC)
 182 #define IFCAP_TOE       (IFCAP_TOE4 | IFCAP_TOE6)
 183
 184
 185 #define IFQ_MAXLEN      50
 186 #define IFNET_SLOWHZ    1               /* granularity is 1 second */
 187
 188 /*
 189  * Message format for use in obtaining information about interfaces
 190  * from getkerninfo and the routing socket
 191  */
 192 struct if_msghdr {
 193         u_short ifm_msglen;     /* to skip over non-understood messages */
 194         u_char  ifm_version;    /* future binary compatibility */
 195         u_char  ifm_type;       /* message type */
 196         int     ifm_addrs;      /* like rtm_addrs */
 197         int     ifm_flags;      /* value of if_flags */
 198         u_short ifm_index;      /* index for associated ifp */
 199         struct  if_data ifm_data;/* statistics and other data about if */
 200 };
 201
 202 /*
 203  * Message format for use in obtaining information about interface addresses
 204  * from getkerninfo and the routing socket
 205  */
 206 struct ifa_msghdr {
 207         u_short ifam_msglen;    /* to skip over non-understood messages */
 208         u_char  ifam_version;   /* future binary compatibility */
 209         u_char  ifam_type;      /* message type */
 210         int     ifam_addrs;     /* like rtm_addrs */
 211         int     ifam_flags;     /* value of ifa_flags */
 212         u_short ifam_index;     /* index for associated ifp */
 213         int     ifam_metric;    /* value of ifa_metric */
 214 };
 215
 216 /*
 217  * Message format for use in obtaining information about multicast addresses
 218  * from the routing socket
 219  */
 220 struct ifma_msghdr {
 221         u_short ifmam_msglen;   /* to skip over non-understood messages */
 222         u_char  ifmam_version;  /* future binary compatibility */
 223         u_char  ifmam_type;     /* message type */
 224         int     ifmam_addrs;    /* like rtm_addrs */
 225         int     ifmam_flags;    /* value of ifa_flags */
 226         u_short ifmam_index;    /* index for associated ifp */
 227 };
 228
 229 /*
 230  * Message format announcing the arrival or departure of a network interface.
 231  */
 232 struct if_announcemsghdr {
 233         u_short ifan_msglen;    /* to skip over non-understood messages */
 234         u_char  ifan_version;   /* future binary compatibility */
 235         u_char  ifan_type;      /* message type */
 236         u_short ifan_index;     /* index for associated ifp */
 237         char    ifan_name[IFNAMSIZ]; /* if name, e.g. "en0" */
 238         u_short ifan_what;      /* what type of announcement */
 239 };
 240
 241 #define IFAN_ARRIVAL    0       /* interface arrival */
 242 #define IFAN_DEPARTURE  1       /* interface departure */
 243
 244 /*
 245  * Interface request structure used for socket
 246  * ioctl's.  All interface ioctl's must have parameter
 247  * definitions which begin with ifr_name.  The
 248  * remainder may be interface specific.
 249  */
 250 struct  ifreq {
 251         char    ifr_name[IFNAMSIZ];             /* if name, e.g. "en0" */
 252         union {
 253                 struct  sockaddr ifru_addr;
 254                 struct  sockaddr ifru_dstaddr;
 255                 struct  sockaddr ifru_broadaddr;
 256                 short   ifru_flags[2];
 257                 short   ifru_index;
 258                 int     ifru_metric;
 259                 int     ifru_mtu;
 260                 int     ifru_phys;
 261                 int     ifru_media;
 262                 void   *ifru_data;
 263                 int     ifru_cap[2];
 264                 int     ifru_pollcpu;
 265         } ifr_ifru;
 266 #define ifr_addr        ifr_ifru.ifru_addr      /* address */
 267 #define ifr_dstaddr     ifr_ifru.ifru_dstaddr   /* other end of p-to-p link */
 268 #define ifr_broadaddr   ifr_ifru.ifru_broadaddr /* broadcast address */
 269 #define ifr_flags       ifr_ifru.ifru_flags[0]  /* flags (low 16 bits) */
 270 #define ifr_flagshigh   ifr_ifru.ifru_flags[1]  /* flags (high 16 bits) */
 271 #define ifr_metric      ifr_ifru.ifru_metric    /* metric */
 272 #define ifr_mtu         ifr_ifru.ifru_mtu       /* mtu */
 273 #define ifr_phys        ifr_ifru.ifru_phys      /* physical wire */
 274 #define ifr_media       ifr_ifru.ifru_media     /* physical media */
 275 #define ifr_data        ifr_ifru.ifru_data      /* for use by interface */
 276 #define ifr_reqcap      ifr_ifru.ifru_cap[0]    /* requested capabilities */
 277 #define ifr_curcap      ifr_ifru.ifru_cap[1]    /* current capabilities */
 278 #define ifr_index       ifr_ifru.ifru_index     /* interface index */
 279 #define ifr_pollcpu     ifr_ifru.ifru_pollcpu   /* polling(4) cpu */
 280 };
 281
 282 #define _SIZEOF_ADDR_IFREQ(ifr) \
 283         ((ifr).ifr_addr.sa_len > sizeof(struct sockaddr) ? \
 284          (sizeof(struct ifreq) - sizeof(struct sockaddr) + \
 285           (ifr).ifr_addr.sa_len) : sizeof(struct ifreq))
 286
 287 struct ifaliasreq {
 288         char    ifra_name[IFNAMSIZ];            /* if name, e.g. "en0" */
 289         struct  sockaddr ifra_addr;
 290         struct  sockaddr ifra_broadaddr;
 291         struct  sockaddr ifra_mask;
 292 };
 293
 294 struct ifmediareq {
 295         char    ifm_name[IFNAMSIZ];     /* if name, e.g. "en0" */
 296         int     ifm_current;            /* current media options */
 297         int     ifm_mask;               /* don't care mask */
 298         int     ifm_status;             /* media status */
 299         int     ifm_active;             /* active options */
 300         int     ifm_count;              /* # entries in ifm_ulist array */
 301         int     *ifm_ulist;             /* media words */
 302 };
 303
 304 struct  ifdrv {
 305         char            ifd_name[IFNAMSIZ];     /* if name, e.g. "en0" */
 306         unsigned long   ifd_cmd;
 307         size_t          ifd_len;
 308         void            *ifd_data;
 309 };
 310
 311 /*
 312  * Structure used to retrieve aux status data from interfaces.
 313  * Kernel suppliers to this interface should respect the formatting
 314  * needed by ifconfig(8): each line starts with a TAB and ends with
 315  * a newline.  The canonical example to copy and paste is in if_tun.c.
 316  */
 317
 318 #define IFSTATMAX       800             /* 10 lines of text */
 319 struct ifstat {
 320         char    ifs_name[IFNAMSIZ];     /* if name, e.g. "en0" */
 321         char    ascii[IFSTATMAX + 1];
 322 };
 323
 324 /*
 325  * Structure used in SIOCGIFCONF request.
 326  * Used to retrieve interface configuration
 327  * for machine (useful for programs which
 328  * must know all networks accessible).
 329  */
 330 struct  ifconf {
 331         int     ifc_len;                /* size of associated buffer */
 332         union {
 333                 caddr_t ifcu_buf;
 334                 struct  ifreq *ifcu_req;
 335         } ifc_ifcu;
 336 #define ifc_buf ifc_ifcu.ifcu_buf       /* buffer address */
 337 #define ifc_req ifc_ifcu.ifcu_req       /* array of structures returned */
 338 };
 339
 340
 341 /*
 342  * Structure for SIOC[AGD]LIFADDR
 343  */
 344 struct if_laddrreq {
 345         char    iflr_name[IFNAMSIZ];
 346         u_int   flags;
 347 #define IFLR_PREFIX     0x8000  /* in: prefix given  out: kernel fills id */
 348         u_int   prefixlen;         /* in/out */
 349         struct  sockaddr_storage addr;   /* in/out */
 350         struct  sockaddr_storage dstaddr; /* out */
 351 };
 352
 353 #ifndef _KERNEL
 354 struct if_nameindex {
 355         u_int    if_index;      /* 1, 2, ... */
 356         char    *if_name;       /* null terminated name: "le0", ... */
 357 };
 358
 359 __BEGIN_DECLS
 360 u_int    if_nametoindex (const char *);
 361 char    *if_indextoname(u_int, char *);
 362 struct   if_nameindex *if_nameindex (void);
 363 void     if_freenameindex (struct if_nameindex *);
 364 __END_DECLS
 365 #endif
 366
 367 #ifdef _KERNEL
 368 struct thread;
 369 struct ucred;
 370
 371 int     prison_if (struct ucred *cred, struct sockaddr *sa);
 372
 373 /* XXX - this should go away soon. */
 374 #include <net/if_var.h>
 375 #endif
 376
 377 #endif /* !_NET_IF_H_ */