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