The Design and Implementation of the FreeBSD Operating System, Second Edition
Now available: The Design and Implementation of the FreeBSD Operating System (Second Edition)


[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ] [ list types ] [ track identifier ]

FreeBSD/Linux Kernel Cross Reference
sys/net/if.h

Version: -  FREEBSD  -  FREEBSD-13-STABLE  -  FREEBSD-13-0  -  FREEBSD-12-STABLE  -  FREEBSD-12-0  -  FREEBSD-11-STABLE  -  FREEBSD-11-0  -  FREEBSD-10-STABLE  -  FREEBSD-10-0  -  FREEBSD-9-STABLE  -  FREEBSD-9-0  -  FREEBSD-8-STABLE  -  FREEBSD-8-0  -  FREEBSD-7-STABLE  -  FREEBSD-7-0  -  FREEBSD-6-STABLE  -  FREEBSD-6-0  -  FREEBSD-5-STABLE  -  FREEBSD-5-0  -  FREEBSD-4-STABLE  -  FREEBSD-3-STABLE  -  FREEBSD22  -  l41  -  OPENBSD  -  linux-2.6  -  MK84  -  PLAN9  -  xnu-8792 
SearchContext: -  none  -  3  -  10 

    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 #ifdef __alpha__
  107         u_int   ifi_timepad;            /* time_t is int, not long on alpha */
  108 #endif
  109         struct  timeval ifi_lastchange; /* time of last administrative change */
  110 };
  111 
  112 /*-
  113  * Interface flags are of two types: network stack owned flags, and driver
  114  * owned flags.  Historically, these values were stored in the same ifnet
  115  * flags field, but with the advent of fine-grained locking, they have been
  116  * broken out such that the network stack is responsible for synchronizing
  117  * the stack-owned fields, and the device driver the device-owned fields.
  118  * Both halves can perform lockless reads of the other half's field, subject
  119  * to accepting the involved races.
  120  *
  121  * Both sets of flags come from the same number space, and should not be
  122  * permitted to conflict, as they are exposed to user space via a single
  123  * field.
  124  *
  125  * The following symbols identify read and write requirements for fields:
  126  *
  127  * (i) if_flags field set by device driver before attach, read-only there
  128  *     after.
  129  * (n) if_flags field written only by the network stack, read by either the
  130  *     stack or driver.
  131  * (d) if_drv_flags field written only by the device driver, read by either
  132  *     the stack or driver.
  133  */
  134 #define IFF_UP          0x1             /* (n) interface is up */
  135 #define IFF_BROADCAST   0x2             /* (i) broadcast address valid */
  136 #define IFF_DEBUG       0x4             /* (n) turn on debugging */
  137 #define IFF_LOOPBACK    0x8             /* (i) is a loopback net */
  138 #define IFF_POINTOPOINT 0x10            /* (i) is a point-to-point link */
  139 #define IFF_SMART       0x20            /* (i) interface manages own routes */
  140 #define IFF_DRV_RUNNING 0x40            /* (d) resources allocated */
  141 #define IFF_NOARP       0x80            /* (n) no address resolution protocol */
  142 #define IFF_PROMISC     0x100           /* (n) receive all packets */
  143 #define IFF_ALLMULTI    0x200           /* (n) receive all multicast packets */
  144 #define IFF_DRV_OACTIVE 0x400           /* (d) tx hardware queue is full */
  145 #define IFF_SIMPLEX     0x800           /* (i) can't hear own transmissions */
  146 #define IFF_LINK0       0x1000          /* per link layer defined bit */
  147 #define IFF_LINK1       0x2000          /* per link layer defined bit */
  148 #define IFF_LINK2       0x4000          /* per link layer defined bit */
  149 #define IFF_ALTPHYS     IFF_LINK2       /* use alternate physical connection */
  150 #define IFF_MULTICAST   0x8000          /* (i) supports multicast */
  151 /*                      0x10000         */
  152 #define IFF_PPROMISC    0x20000         /* (n) user-requested promisc mode */
  153 #define IFF_MONITOR     0x40000         /* (n) user-requested monitor mode */
  154 #define IFF_STATICARP   0x80000         /* (n) static ARP */
  155 #define IFF_NEEDSGIANT  0x100000        /* (i) hold Giant over if_start calls */
  156 
  157 /*
  158  * Old names for driver flags so that user space tools can continue to use
  159  * the old (portable) names.
  160  */
  161 #ifndef _KERNEL
  162 #define IFF_RUNNING     IFF_DRV_RUNNING
  163 #define IFF_OACTIVE     IFF_DRV_OACTIVE
  164 #endif
  165 
  166 /* flags set internally only: */
  167 #define IFF_CANTCHANGE \
  168         (IFF_BROADCAST|IFF_POINTOPOINT|IFF_DRV_RUNNING|IFF_DRV_OACTIVE|\
  169             IFF_SIMPLEX|IFF_MULTICAST|IFF_ALLMULTI|IFF_SMART|IFF_PROMISC)
  170 
  171 /*
  172  * Values for if_link_state.
  173  */
  174 #define LINK_STATE_UNKNOWN      0       /* link invalid/unknown */
  175 #define LINK_STATE_DOWN         1       /* link is down */
  176 #define LINK_STATE_UP           2       /* link is up */
  177 
  178 /*
  179  * Some convenience macros used for setting ifi_baudrate.
  180  * XXX 1000 vs. 1024? --thorpej@netbsd.org
  181  */
  182 #define IF_Kbps(x)      ((x) * 1000)            /* kilobits/sec. */
  183 #define IF_Mbps(x)      (IF_Kbps((x) * 1000))   /* megabits/sec. */
  184 #define IF_Gbps(x)      (IF_Mbps((x) * 1000))   /* gigabits/sec. */
  185 
  186 /* Capabilities that interfaces can advertise. */
  187 #define IFCAP_RXCSUM            0x0001  /* can offload checksum on RX */
  188 #define IFCAP_TXCSUM            0x0002  /* can offload checksum on TX */
  189 #define IFCAP_NETCONS           0x0004  /* can be a network console */
  190 #define IFCAP_VLAN_MTU          0x0008  /* VLAN-compatible MTU */
  191 #define IFCAP_VLAN_HWTAGGING    0x0010  /* hardware VLAN tag support */
  192 #define IFCAP_JUMBO_MTU         0x0020  /* 9000 byte MTU supported */
  193 #define IFCAP_POLLING           0x0040  /* driver supports polling */
  194 
  195 #define IFCAP_HWCSUM            (IFCAP_RXCSUM | IFCAP_TXCSUM)
  196 
  197 #define IFQ_MAXLEN      50
  198 #define IFNET_SLOWHZ    1               /* granularity is 1 second */
  199 
  200 /*
  201  * Message format for use in obtaining information about interfaces
  202  * from getkerninfo and the routing socket
  203  */
  204 struct if_msghdr {
  205         u_short ifm_msglen;     /* to skip over non-understood messages */
  206         u_char  ifm_version;    /* future binary compatibility */
  207         u_char  ifm_type;       /* message type */
  208         int     ifm_addrs;      /* like rtm_addrs */
  209         int     ifm_flags;      /* value of if_flags */
  210         u_short ifm_index;      /* index for associated ifp */
  211         struct  if_data ifm_data;/* statistics and other data about if */
  212 };
  213 
  214 /*
  215  * Message format for use in obtaining information about interface addresses
  216  * from getkerninfo and the routing socket
  217  */
  218 struct ifa_msghdr {
  219         u_short ifam_msglen;    /* to skip over non-understood messages */
  220         u_char  ifam_version;   /* future binary compatibility */
  221         u_char  ifam_type;      /* message type */
  222         int     ifam_addrs;     /* like rtm_addrs */
  223         int     ifam_flags;     /* value of ifa_flags */
  224         u_short ifam_index;     /* index for associated ifp */
  225         int     ifam_metric;    /* value of ifa_metric */
  226 };
  227 
  228 /*
  229  * Message format for use in obtaining information about multicast addresses
  230  * from the routing socket
  231  */
  232 struct ifma_msghdr {
  233         u_short ifmam_msglen;   /* to skip over non-understood messages */
  234         u_char  ifmam_version;  /* future binary compatibility */
  235         u_char  ifmam_type;     /* message type */
  236         int     ifmam_addrs;    /* like rtm_addrs */
  237         int     ifmam_flags;    /* value of ifa_flags */
  238         u_short ifmam_index;    /* index for associated ifp */
  239 };
  240 
  241 /*
  242  * Message format announcing the arrival or departure of a network interface.
  243  */
  244 struct if_announcemsghdr {
  245         u_short ifan_msglen;    /* to skip over non-understood messages */
  246         u_char  ifan_version;   /* future binary compatibility */
  247         u_char  ifan_type;      /* message type */
  248         u_short ifan_index;     /* index for associated ifp */
  249         char    ifan_name[IFNAMSIZ]; /* if name, e.g. "en0" */
  250         u_short ifan_what;      /* what type of announcement */
  251 };
  252 
  253 #define IFAN_ARRIVAL    0       /* interface arrival */
  254 #define IFAN_DEPARTURE  1       /* interface departure */
  255 
  256 /*
  257  * Interface request structure used for socket
  258  * ioctl's.  All interface ioctl's must have parameter
  259  * definitions which begin with ifr_name.  The
  260  * remainder may be interface specific.
  261  */
  262 struct  ifreq {
  263         char    ifr_name[IFNAMSIZ];             /* if name, e.g. "en0" */
  264         union {
  265                 struct  sockaddr ifru_addr;
  266                 struct  sockaddr ifru_dstaddr;
  267                 struct  sockaddr ifru_broadaddr;
  268                 short   ifru_flags[2];
  269                 short   ifru_index;
  270                 int     ifru_metric;
  271                 int     ifru_mtu;
  272                 int     ifru_phys;
  273                 int     ifru_media;
  274                 caddr_t ifru_data;
  275                 int     ifru_cap[2];
  276         } ifr_ifru;
  277 #define ifr_addr        ifr_ifru.ifru_addr      /* address */
  278 #define ifr_dstaddr     ifr_ifru.ifru_dstaddr   /* other end of p-to-p link */
  279 #define ifr_broadaddr   ifr_ifru.ifru_broadaddr /* broadcast address */
  280 #define ifr_flags       ifr_ifru.ifru_flags[0]  /* flags (low 16 bits) */
  281 #define ifr_flagshigh   ifr_ifru.ifru_flags[1]  /* flags (high 16 bits) */
  282 #define ifr_metric      ifr_ifru.ifru_metric    /* metric */
  283 #define ifr_mtu         ifr_ifru.ifru_mtu       /* mtu */
  284 #define ifr_phys        ifr_ifru.ifru_phys      /* physical wire */
  285 #define ifr_media       ifr_ifru.ifru_media     /* physical media */
  286 #define ifr_data        ifr_ifru.ifru_data      /* for use by interface */
  287 #define ifr_reqcap      ifr_ifru.ifru_cap[0]    /* requested capabilities */
  288 #define ifr_curcap      ifr_ifru.ifru_cap[1]    /* current capabilities */
  289 #define ifr_index       ifr_ifru.ifru_index     /* interface index */
  290 };
  291 
  292 #define _SIZEOF_ADDR_IFREQ(ifr) \
  293         ((ifr).ifr_addr.sa_len > sizeof(struct sockaddr) ? \
  294          (sizeof(struct ifreq) - sizeof(struct sockaddr) + \
  295           (ifr).ifr_addr.sa_len) : sizeof(struct ifreq))
  296 
  297 struct ifaliasreq {
  298         char    ifra_name[IFNAMSIZ];            /* if name, e.g. "en0" */
  299         struct  sockaddr ifra_addr;
  300         struct  sockaddr ifra_broadaddr;
  301         struct  sockaddr ifra_mask;
  302 };
  303 
  304 struct ifmediareq {
  305         char    ifm_name[IFNAMSIZ];     /* if name, e.g. "en0" */
  306         int     ifm_current;            /* current media options */
  307         int     ifm_mask;               /* don't care mask */
  308         int     ifm_status;             /* media status */
  309         int     ifm_active;             /* active options */
  310         int     ifm_count;              /* # entries in ifm_ulist array */
  311         int     *ifm_ulist;             /* media words */
  312 };
  313 
  314 struct  ifdrv {
  315         char            ifd_name[IFNAMSIZ];     /* if name, e.g. "en0" */
  316         unsigned long   ifd_cmd;
  317         size_t          ifd_len;
  318         void            *ifd_data;
  319 };
  320 
  321 /* 
  322  * Structure used to retrieve aux status data from interfaces.
  323  * Kernel suppliers to this interface should respect the formatting
  324  * needed by ifconfig(8): each line starts with a TAB and ends with
  325  * a newline.  The canonical example to copy and paste is in if_tun.c.
  326  */
  327 
  328 #define IFSTATMAX       800             /* 10 lines of text */
  329 struct ifstat {
  330         char    ifs_name[IFNAMSIZ];     /* if name, e.g. "en0" */
  331         char    ascii[IFSTATMAX + 1];
  332 };
  333 
  334 /*
  335  * Structure used in SIOCGIFCONF request.
  336  * Used to retrieve interface configuration
  337  * for machine (useful for programs which
  338  * must know all networks accessible).
  339  */
  340 struct  ifconf {
  341         int     ifc_len;                /* size of associated buffer */
  342         union {
  343                 caddr_t ifcu_buf;
  344                 struct  ifreq *ifcu_req;
  345         } ifc_ifcu;
  346 #define ifc_buf ifc_ifcu.ifcu_buf       /* buffer address */
  347 #define ifc_req ifc_ifcu.ifcu_req       /* array of structures returned */
  348 };
  349 
  350 #if defined (__amd64__)
  351 struct ifconf32 {
  352         int     ifc_len;                /* size of associated buffer */
  353         union {
  354                 u_int   ifcu_buf;
  355                 u_int   ifcu_req;
  356         } ifc_ifcu;
  357 };
  358 #endif
  359 
  360 /*
  361  * Structure for SIOC[AGD]LIFADDR
  362  */
  363 struct if_laddrreq {
  364         char    iflr_name[IFNAMSIZ];
  365         u_int   flags;
  366 #define IFLR_PREFIX     0x8000  /* in: prefix given  out: kernel fills id */
  367         u_int   prefixlen;         /* in/out */
  368         struct  sockaddr_storage addr;   /* in/out */
  369         struct  sockaddr_storage dstaddr; /* out */
  370 };
  371 
  372 #endif /* __BSD_VISIBLE */
  373 
  374 #ifdef _KERNEL
  375 #ifdef MALLOC_DECLARE
  376 MALLOC_DECLARE(M_IFADDR);
  377 MALLOC_DECLARE(M_IFMADDR);
  378 #endif
  379 #endif
  380 
  381 #ifndef _KERNEL
  382 struct if_nameindex {
  383         unsigned int    if_index;       /* 1, 2, ... */
  384         char            *if_name;       /* null terminated name: "le0", ... */
  385 };
  386 
  387 __BEGIN_DECLS
  388 void                     if_freenameindex(struct if_nameindex *);
  389 char                    *if_indextoname(unsigned int, char *);
  390 struct if_nameindex     *if_nameindex(void);
  391 unsigned int             if_nametoindex(const char *);
  392 __END_DECLS
  393 #endif
  394 
  395 #ifdef _KERNEL
  396 struct thread;
  397 
  398 /* XXX - this should go away soon. */
  399 #include <net/if_var.h>
  400 #endif
  401 
  402 #endif /* !_NET_IF_H_ */

Cache object: 6bc0c9472344a9a272703c9aeb291e3c


[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ] [ list types ] [ track identifier ]


This page is part of the FreeBSD/Linux Linux Kernel Cross-Reference, and was automatically generated using a modified version of the LXR engine.