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