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  */
  36
  37 #ifndef _NET_IF_H_
  38 #define _NET_IF_H_
  39
  40 #include <sys/cdefs.h>
  41
  42 #if __BSD_VISIBLE
  43 /*
  44  * <net/if.h> does not depend on <sys/time.h> on most other systems.  This
  45  * helps userland compatibility.  (struct timeval ifi_lastchange)
  46  */
  47 #include <sys/socket.h>
  48 #ifndef _KERNEL
  49 #include <sys/time.h>
  50 #endif
  51 #endif
  52
  53 /*
  54  * Length of interface external name, including terminating '\0'.
  55  * Note: this is the same size as a generic device's external name.
  56  */
  57 #define         IF_NAMESIZE     16
  58 #if __BSD_VISIBLE
  59 #define         IFNAMSIZ        IF_NAMESIZE
  60 #define         IF_MAXUNIT      0x7fff          /* if_unit is 15bits */
  61
  62 /*
  63  * Structure used to query names of interface cloners.
  64  * XXX should be moved to net/if_clone.h
  65  */
  66 struct if_clonereq {
  67         int     ifcr_total;             /* total cloners (out) */
  68         int     ifcr_count;             /* room for this many in user buffer */
  69         char    *ifcr_buffer;           /* buffer for cloner names */
  70 };
  71
  72 /*
  73  * Structure describing information about an interface
  74  * which may be of interest to management entities.
  75  */
  76 struct if_data {
  77         /* generic interface information */
  78         u_char  ifi_type;               /* ethernet, tokenring, etc */
  79         u_char  ifi_physical;           /* e.g., AUI, Thinnet, 10base-T, etc */
  80         u_char  ifi_addrlen;            /* media address length */
  81         u_char  ifi_hdrlen;             /* media header length */
  82         u_char  ifi_recvquota;          /* polling quota for receive intrs */
  83         u_char  ifi_xmitquota;          /* polling quota for xmit intrs */
  84         u_long  ifi_mtu;                /* maximum transmission unit */
  85         u_long  ifi_metric;             /* routing metric (external only) */
  86         u_long  ifi_link_state;         /* current link state */
  87         uint64_t ifi_baudrate;          /* linespeed */
  88         /* volatile statistics */
  89         u_long  ifi_ipackets;           /* packets received on interface */
  90         u_long  ifi_ierrors;            /* input errors on interface */
  91         u_long  ifi_opackets;           /* packets sent on interface */
  92         u_long  ifi_oerrors;            /* output errors on interface */
  93         u_long  ifi_collisions;         /* collisions on csma interfaces */
  94         u_long  ifi_ibytes;             /* total number of octets received */
  95         u_long  ifi_obytes;             /* total number of octets sent */
  96         u_long  ifi_imcasts;            /* packets received via multicast */
  97         u_long  ifi_omcasts;            /* packets sent via multicast */
  98         u_long  ifi_iqdrops;            /* dropped on input, this interface */
  99         u_long  ifi_noproto;            /* destined for unsupported protocol */
 100         u_long  ifi_hwassist;           /* HW offload capabilities */
 101         u_long  ifi_unused;             /* XXX was ifi_xmittiming */
 102         struct  timeval ifi_lastchange; /* time of last administrative change */
 103 };
 104
 105 #define IFF_UP          0x1             /* interface is up */
 106 #define IFF_BROADCAST   0x2             /* broadcast address valid */
 107 #define IFF_DEBUG       0x4             /* turn on debugging */
 108 #define IFF_LOOPBACK    0x8             /* is a loopback net */
 109 #define IFF_POINTOPOINT 0x10            /* interface is point-to-point link */
 110 #define IFF_SMART       0x20            /* interface manages own routes */
 111 #define IFF_RUNNING     0x40            /* resources allocated */
 112 #define IFF_NOARP       0x80            /* no address resolution protocol */
 113 #define IFF_PROMISC     0x100           /* receive all packets */
 114 #define IFF_ALLMULTI    0x200           /* receive all multicast packets */
 115 #define IFF_OACTIVE_COMPAT 0x400        /* was transmission in progress */
 116 #define IFF_SIMPLEX     0x800           /* can't hear own transmissions */
 117 #define IFF_LINK0       0x1000          /* per link layer defined bit */
 118 #define IFF_LINK1       0x2000          /* per link layer defined bit */
 119 #define IFF_LINK2       0x4000          /* per link layer defined bit */
 120 #define IFF_ALTPHYS     IFF_LINK2       /* use alternate physical connection */
 121 #define IFF_MULTICAST   0x8000          /* supports multicast */
 122 #define IFF_POLLING_COMPAT 0x10000      /* was interface is in polling mode */
 123 #define IFF_PPROMISC    0x20000         /* user-requested promisc mode */
 124 #define IFF_MONITOR     0x40000         /* user-requested monitor mode */
 125 #define IFF_STATICARP   0x80000         /* static ARP */
 126 #define IFF_NPOLLING    0x100000        /* interface is in polling mode */
 127
 128 /* flags set internally only: */
 129 #define IFF_CANTCHANGE \
 130         (IFF_BROADCAST|IFF_POINTOPOINT|IFF_RUNNING|IFF_OACTIVE_COMPAT|\
 131          IFF_SIMPLEX|IFF_MULTICAST|IFF_ALLMULTI|IFF_SMART|IFF_POLLING_COMPAT|\
 132          IFF_NPOLLING)
 133
 134 #ifndef _KERNEL
 135 /*
 136  * User space compat
 137  */
 138 #define IFF_OACTIVE     IFF_OACTIVE_COMPAT
 139 #define IFF_POLLING     IFF_POLLING_COMPAT
 140 #endif
 141
 142 /*
 143  * Values for if_link_state.
 144  */
 145 #define LINK_STATE_UNKNOWN      0       /* link invalid/unknown */
 146 #define LINK_STATE_DOWN         1       /* link is down */
 147 #define LINK_STATE_UP           2       /* link is up */
 148 #define LINK_STATE_IS_UP(_s)    ((_s) >= LINK_STATE_UP)
 149
 150 /*
 151  * Some convenience macros used for setting ifi_baudrate.
 152  * XXX 1000 vs. 1024? --thorpej@netbsd.org
 153  */
 154 #define IF_Kbps(x)      ((x) * 1000)            /* kilobits/sec. */
 155 #define IF_Mbps(x)      (IF_Kbps((x) * 1000))   /* megabits/sec. */
 156 #define IF_Gbps(x)      (IF_Mbps((x) * 1000))   /* gigabits/sec. */
 157
 158 /* Capabilities that interfaces can advertise. */
 159 #define IFCAP_RXCSUM            0x00001 /* can offload checksum on RX */
 160 #define IFCAP_TXCSUM            0x00002 /* can offload checksum on TX */
 161 #define IFCAP_NETCONS           0x00004 /* can be a network console */
 162 #define IFCAP_VLAN_MTU          0x00008 /* VLAN-compatible MTU */
 163 #define IFCAP_VLAN_HWTAGGING    0x00010 /* hardware VLAN tag support */
 164 #define IFCAP_JUMBO_MTU         0x00020 /* 9000 byte MTU support */
 165 #define IFCAP_RSS               0x00040 /* Receive Side Scaling for IPv4 */
 166 #define IFCAP_VLAN_HWCSUM       0x00080 /* can do IFCAP_HWCSUM on VLANs */
 167 #define IFCAP_TSO4              0x00100 /* can offload TCP segmentation */
 168 #define IFCAP_TSO               IFCAP_TSO4
 169 #define IFCAP_TSO6              0x00200 /* can offload TCP6 segmentation */
 170
 171 #define IFCAP_HWCSUM    (IFCAP_RXCSUM | IFCAP_TXCSUM)
 172
 173
 174 #define IFQ_MAXLEN      250
 175 #define IFNET_SLOWHZ    1               /* granularity is 1 second */
 176
 177 /*
 178  * Message format for use in obtaining information about interfaces
 179  * from getkerninfo and the routing socket
 180  */
 181 struct if_msghdr {
 182         u_short ifm_msglen;     /* to skip over non-understood messages */
 183         u_char  ifm_version;    /* future binary compatibility */
 184         u_char  ifm_type;       /* message type */
 185         int     ifm_addrs;      /* like rtm_addrs */
 186         int     ifm_flags;      /* value of if_flags */
 187         u_short ifm_index;      /* index for associated ifp */
 188         struct  if_data ifm_data;/* statistics and other data about if */
 189 };
 190
 191 /*
 192  * Message format for use in obtaining information about interface addresses
 193  * from getkerninfo and the routing socket
 194  */
 195 struct ifa_msghdr {
 196         u_short ifam_msglen;    /* to skip over non-understood messages */
 197         u_char  ifam_version;   /* future binary compatibility */
 198         u_char  ifam_type;      /* message type */
 199         int     ifam_addrs;     /* like rtm_addrs */
 200         int     ifam_flags;     /* value of ifa_flags */
 201         u_short ifam_index;     /* index for associated ifp */
 202         int     ifam_metric;    /* value of ifa_metric */
 203 };
 204
 205 /*
 206  * Message format for use in obtaining information about multicast addresses
 207  * from the routing socket
 208  */
 209 struct ifma_msghdr {
 210         u_short ifmam_msglen;   /* to skip over non-understood messages */
 211         u_char  ifmam_version;  /* future binary compatibility */
 212         u_char  ifmam_type;     /* message type */
 213         int     ifmam_addrs;    /* like rtm_addrs */
 214         int     ifmam_flags;    /* value of ifa_flags */
 215         u_short ifmam_index;    /* index for associated ifp */
 216 };
 217
 218 /*
 219  * Message format announcing the arrival or departure of a network interface.
 220  */
 221 struct if_announcemsghdr {
 222         u_short ifan_msglen;    /* to skip over non-understood messages */
 223         u_char  ifan_version;   /* future binary compatibility */
 224         u_char  ifan_type;      /* message type */
 225         u_short ifan_index;     /* index for associated ifp */
 226         char    ifan_name[IFNAMSIZ]; /* if name, e.g. "en0" */
 227         u_short ifan_what;      /* what type of announcement */
 228 };
 229
 230 #define IFAN_ARRIVAL    0       /* interface arrival */
 231 #define IFAN_DEPARTURE  1       /* interface departure */
 232
 233 /*
 234  * Interface request structure used for socket
 235  * ioctl's.  All interface ioctl's must have parameter
 236  * definitions which begin with ifr_name.  The
 237  * remainder may be interface specific.
 238  */
 239 struct  ifreq {
 240         char    ifr_name[IFNAMSIZ];             /* if name, e.g. "en0" */
 241         union {
 242                 struct  sockaddr ifru_addr;
 243                 struct  sockaddr ifru_dstaddr;
 244                 struct  sockaddr ifru_broadaddr;
 245                 short   ifru_flags[2];
 246                 short   ifru_index;
 247                 int     ifru_metric;
 248                 int     ifru_mtu;
 249                 int     ifru_phys;
 250                 int     ifru_media;
 251                 void   *ifru_data;
 252                 int     ifru_cap[2];
 253                 int     ifru_pollcpu;
 254                 int     ifru_tsolen;
 255         } ifr_ifru;
 256 #define ifr_addr        ifr_ifru.ifru_addr      /* address */
 257 #define ifr_dstaddr     ifr_ifru.ifru_dstaddr   /* other end of p-to-p link */
 258 #define ifr_broadaddr   ifr_ifru.ifru_broadaddr /* broadcast address */
 259 #define ifr_flags       ifr_ifru.ifru_flags[0]  /* flags (low 16 bits) */
 260 #define ifr_flagshigh   ifr_ifru.ifru_flags[1]  /* flags (high 16 bits) */
 261 #define ifr_metric      ifr_ifru.ifru_metric    /* metric */
 262 #define ifr_mtu         ifr_ifru.ifru_mtu       /* mtu */
 263 #define ifr_phys        ifr_ifru.ifru_phys      /* physical wire */
 264 #define ifr_media       ifr_ifru.ifru_media     /* physical media */
 265 #define ifr_data        ifr_ifru.ifru_data      /* for use by interface */
 266 #define ifr_reqcap      ifr_ifru.ifru_cap[0]    /* requested capabilities */
 267 #define ifr_curcap      ifr_ifru.ifru_cap[1]    /* current capabilities */
 268 #define ifr_index       ifr_ifru.ifru_index     /* interface index */
 269 #define ifr_pollcpu     ifr_ifru.ifru_pollcpu   /* deprecated */
 270 #define ifr_tsolen      ifr_ifru.ifru_tsolen    /* max TSO length */
 271 };
 272
 273 #define _SIZEOF_ADDR_IFREQ(ifr) \
 274         ((ifr).ifr_addr.sa_len > sizeof(struct sockaddr) ? \
 275          (sizeof(struct ifreq) - sizeof(struct sockaddr) + \
 276           (ifr).ifr_addr.sa_len) : sizeof(struct ifreq))
 277
 278 struct ifaliasreq {
 279         char    ifra_name[IFNAMSIZ];            /* if name, e.g. "en0" */
 280         struct  sockaddr ifra_addr;
 281         struct  sockaddr ifra_broadaddr;
 282         struct  sockaddr ifra_mask;
 283 };
 284
 285 struct ifmediareq {
 286         char    ifm_name[IFNAMSIZ];     /* if name, e.g. "en0" */
 287         int     ifm_current;            /* current media options */
 288         int     ifm_mask;               /* don't care mask */
 289         int     ifm_status;             /* media status */
 290         int     ifm_active;             /* active options */
 291         int     ifm_count;              /* # entries in ifm_ulist array */
 292         int     *ifm_ulist;             /* media words */
 293 };
 294
 295 struct  ifdrv {
 296         char            ifd_name[IFNAMSIZ];     /* if name, e.g. "en0" */
 297         unsigned long   ifd_cmd;
 298         size_t          ifd_len;
 299         void            *ifd_data;
 300 };
 301
 302 /*
 303  * Structure used to retrieve aux status data from interfaces.
 304  * Kernel suppliers to this interface should respect the formatting
 305  * needed by ifconfig(8): each line starts with a TAB and ends with
 306  * a newline.  The canonical example to copy and paste is in if_tun.c.
 307  */
 308
 309 #define IFSTATMAX       800             /* 10 lines of text */
 310 struct ifstat {
 311         char    ifs_name[IFNAMSIZ];     /* if name, e.g. "en0" */
 312         char    ascii[IFSTATMAX + 1];
 313 };
 314
 315 /*
 316  * Structure used in SIOCGIFCONF request.
 317  * Used to retrieve interface configuration
 318  * for machine (useful for programs which
 319  * must know all networks accessible).
 320  */
 321 struct  ifconf {
 322         int     ifc_len;                /* size of associated buffer */
 323         union {
 324                 caddr_t ifcu_buf;
 325                 struct  ifreq *ifcu_req;
 326         } ifc_ifcu;
 327 #define ifc_buf ifc_ifcu.ifcu_buf       /* buffer address */
 328 #define ifc_req ifc_ifcu.ifcu_req       /* array of structures returned */
 329 };
 330
 331 /*
 332  * interface groups
 333  */
 334
 335 #define IFG_ALL         "all"           /* group contains all interfaces */
 336 /* XXX: will we implement this? */
 337 #define IFG_EGRESS      "egress"        /* if(s) default route(s) point to */
 338
 339 struct ifg_req {
 340         union {
 341                 char                     ifgrqu_group[IFNAMSIZ];
 342                 char                     ifgrqu_member[IFNAMSIZ];
 343         } ifgrq_ifgrqu;
 344 #define ifgrq_group     ifgrq_ifgrqu.ifgrqu_group
 345 #define ifgrq_member    ifgrq_ifgrqu.ifgrqu_member
 346 };
 347
 348 /*
 349  * Used to lookup groups for an interface
 350  */
 351 struct ifgroupreq {
 352         char    ifgr_name[IFNAMSIZ];
 353         u_int   ifgr_len;
 354         union {
 355                 char    ifgru_group[IFNAMSIZ];
 356                 struct  ifg_req *ifgru_groups;
 357         } ifgr_ifgru;
 358 #define ifgr_group      ifgr_ifgru.ifgru_group
 359 #define ifgr_groups     ifgr_ifgru.ifgru_groups
 360 };
 361
 362 /*
 363  * Structure for SIOC[AGD]LIFADDR
 364  */
 365 struct if_laddrreq {
 366         char    iflr_name[IFNAMSIZ];
 367         u_int   flags;
 368 #define IFLR_PREFIX     0x8000  /* in: prefix given  out: kernel fills id */
 369         u_int   prefixlen;         /* in/out */
 370         struct  sockaddr_storage addr;   /* in/out */
 371         struct  sockaddr_storage dstaddr; /* out */
 372 };
 373 #endif /* __BSD_VISIBLE */
 374
 375 #ifndef _KERNEL
 376 struct if_nameindex {
 377         unsigned int     if_index;      /* 1, 2, ... */
 378         char            *if_name;       /* null terminated name: "lnc0", ... */
 379 };
 380
 381 __BEGIN_DECLS
 382 unsigned int     if_nametoindex(const char *);
 383 char            *if_indextoname(unsigned int, char *);
 384 struct if_nameindex *if_nameindex(void);
 385 void             if_freenameindex(struct if_nameindex *);
 386 __END_DECLS
 387 #endif
 388
 389 #ifdef _KERNEL
 390 struct thread;
 391 struct ucred;
 392
 393 int     prison_if(struct ucred *cred, struct sockaddr *sa);
 394
 395 /* XXX - this should go away soon. */
 396 #include <net/if_var.h>
 397 #endif
 398
 399 #endif /* !_NET_IF_H_ */