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