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  * 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$
   35  */
   36 
   37 #ifndef _NET_IF_H_
   38 #define _NET_IF_H_
   39 
   40 #ifdef _KERNEL
   41 #include <sys/queue.h>
   42 #endif
   43 
   44 /*
   45  * <net/if.h> does not depend on <sys/time.h> on most other systems.  This
   46  * helps userland compatability.  (struct timeval ifi_lastchange)
   47  */
   48 #ifndef _KERNEL
   49 #include <sys/time.h>
   50 #endif
   51 
   52 struct ifnet;
   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         IFNAMSIZ        16
   59 #define         IF_NAMESIZE     IFNAMSIZ
   60 
   61 #ifdef _KERNEL
   62 /*
   63  * Structure describing a `cloning' interface.
   64  */
   65 struct if_clone {
   66         LIST_ENTRY(if_clone) ifc_list;  /* on list of cloners */
   67         const char *ifc_name;           /* name of device, e.g. `gif' */
   68         size_t ifc_namelen;             /* length of name */
   69 
   70         int     (*ifc_create)(struct if_clone *, int *);
   71         void    (*ifc_destroy)(struct ifnet *);
   72 };
   73 
   74 #define IF_CLONE_INITIALIZER(name, create, destroy)                     \
   75         { { 0 }, name, sizeof(name) - 1, create, destroy }
   76 #endif
   77 
   78 /*
   79  * Structure used to query names of interface cloners.
   80  */
   81 
   82 struct if_clonereq {
   83         int     ifcr_total;             /* total cloners (out) */
   84         int     ifcr_count;             /* room for this many in user buffer */
   85         char    *ifcr_buffer;           /* buffer for cloner names */
   86 };
   87 
   88 /*
   89  * Structure describing information about an interface
   90  * which may be of interest to management entities.
   91  */
   92 struct if_data {
   93         /* generic interface information */
   94         u_char  ifi_type;               /* ethernet, tokenring, etc */
   95         u_char  ifi_physical;           /* e.g., AUI, Thinnet, 10base-T, etc */
   96         u_char  ifi_addrlen;            /* media address length */
   97         u_char  ifi_hdrlen;             /* media header length */
   98         u_char  ifi_recvquota;          /* polling quota for receive intrs */
   99         u_char  ifi_xmitquota;          /* polling quota for xmit intrs */
  100         u_char  ifi_do_not_use;         /* pad for ifi_datalen's position */
  101         u_char  ifi_datalen;            /* length of this data struct */
  102         u_long  ifi_mtu;                /* maximum transmission unit */
  103         u_long  ifi_metric;             /* routing metric (external only) */
  104         u_long  ifi_baudrate;           /* linespeed */
  105         /* volatile statistics */
  106         u_long  ifi_ipackets;           /* packets received on interface */
  107         u_long  ifi_ierrors;            /* input errors on interface */
  108         u_long  ifi_opackets;           /* packets sent on interface */
  109         u_long  ifi_oerrors;            /* output errors on interface */
  110         u_long  ifi_collisions;         /* collisions on csma interfaces */
  111         u_long  ifi_ibytes;             /* total number of octets received */
  112         u_long  ifi_obytes;             /* total number of octets sent */
  113         u_long  ifi_imcasts;            /* packets received via multicast */
  114         u_long  ifi_omcasts;            /* packets sent via multicast */
  115         u_long  ifi_iqdrops;            /* dropped on input, this interface */
  116         u_long  ifi_noproto;            /* destined for unsupported protocol */
  117         u_long  ifi_hwassist;           /* HW offload capabilities */
  118         u_long  ifi_unused;             /* XXX was ifi_xmittiming */
  119         struct  timeval ifi_lastchange; /* time of last administrative change */
  120 };
  121 
  122 #define IFF_UP          0x1             /* interface is up */
  123 #define IFF_BROADCAST   0x2             /* broadcast address valid */
  124 #define IFF_DEBUG       0x4             /* turn on debugging */
  125 #define IFF_LOOPBACK    0x8             /* is a loopback net */
  126 #define IFF_POINTOPOINT 0x10            /* interface is point-to-point link */
  127 #define IFF_SMART       0x20            /* interface manages own routes */
  128 #define IFF_RUNNING     0x40            /* resources allocated */
  129 #define IFF_NOARP       0x80            /* no address resolution protocol */
  130 #define IFF_PROMISC     0x100           /* receive all packets */
  131 #define IFF_ALLMULTI    0x200           /* receive all multicast packets */
  132 #define IFF_OACTIVE     0x400           /* transmission in progress */
  133 #define IFF_SIMPLEX     0x800           /* can't hear own transmissions */
  134 #define IFF_LINK0       0x1000          /* per link layer defined bit */
  135 #define IFF_LINK1       0x2000          /* per link layer defined bit */
  136 #define IFF_LINK2       0x4000          /* per link layer defined bit */
  137 #define IFF_ALTPHYS     IFF_LINK2       /* use alternate physical connection */
  138 #define IFF_MULTICAST   0x8000          /* supports multicast */
  139 
  140 /*
  141  * The following flag(s) ought to go in if_flags, but we cannot change
  142  * struct ifnet because of binary compatibility, so we store them in
  143  * if_ipending, which is not used so far.
  144  * If possible, make sure the value is not conflicting with other
  145  * IFF flags, so we have an easier time when we want to merge them.
  146  */
  147 #define IFF_POLLING     0x10000         /* Interface is in polling mode. */
  148 #define IFF_PPROMISC    0x20000         /* user-requested promisc mode */
  149 #define IFF_STATICARP   0x80000         /* static ARP */
  150 
  151 /* flags set internally only: */
  152 #define IFF_CANTCHANGE \
  153         (IFF_BROADCAST|IFF_POINTOPOINT|IFF_RUNNING|IFF_OACTIVE|\
  154             IFF_SIMPLEX|IFF_MULTICAST|IFF_ALLMULTI|IFF_SMART|IFF_POLLING)
  155 
  156 /* Capabilities that interfaces can advertise. */
  157 #define IFCAP_RXCSUM            0x0001  /* can offload checksum on RX */
  158 #define IFCAP_TXCSUM            0x0002  /* can offload checksum on TX */
  159 #define IFCAP_NETCONS           0x0004  /* can be a network console */
  160 #define IFCAP_POLLING           0x0040  /* driver supports polling */
  161 
  162 #define IFCAP_HWCSUM            (IFCAP_RXCSUM | IFCAP_TXCSUM)
  163 
  164 #define IFQ_MAXLEN      50
  165 #define IFNET_SLOWHZ    1               /* granularity is 1 second */
  166 
  167 /*
  168  * Message format for use in obtaining information about interfaces
  169  * from getkerninfo and the routing socket
  170  */
  171 struct if_msghdr {
  172         u_short ifm_msglen;     /* to skip over non-understood messages */
  173         u_char  ifm_version;    /* future binary compatability */
  174         u_char  ifm_type;       /* message type */
  175         int     ifm_addrs;      /* like rtm_addrs */
  176         int     ifm_flags;      /* value of if_flags */
  177         u_short ifm_index;      /* index for associated ifp */
  178         struct  if_data ifm_data;/* statistics and other data about if */
  179 };
  180 
  181 /*
  182  * Message format for use in obtaining information about interface addresses
  183  * from getkerninfo and the routing socket
  184  */
  185 struct ifa_msghdr {
  186         u_short ifam_msglen;    /* to skip over non-understood messages */
  187         u_char  ifam_version;   /* future binary compatability */
  188         u_char  ifam_type;      /* message type */
  189         int     ifam_addrs;     /* like rtm_addrs */
  190         int     ifam_flags;     /* value of ifa_flags */
  191         u_short ifam_index;     /* index for associated ifp */
  192         int     ifam_metric;    /* value of ifa_metric */
  193 };
  194 
  195 /*
  196  * Message format for use in obtaining information about multicast addresses
  197  * from the routing socket
  198  */
  199 struct ifma_msghdr {
  200         u_short ifmam_msglen;   /* to skip over non-understood messages */
  201         u_char  ifmam_version;  /* future binary compatability */
  202         u_char  ifmam_type;     /* message type */
  203         int     ifmam_addrs;    /* like rtm_addrs */
  204         int     ifmam_flags;    /* value of ifa_flags */
  205         u_short ifmam_index;    /* index for associated ifp */
  206 };
  207 
  208 /*
  209  * Message format announcing the arrival or departure of a network interface.
  210  */
  211 struct if_announcemsghdr {
  212         u_short ifan_msglen;    /* to skip over non-understood messages */
  213         u_char  ifan_version;   /* future binary compatibility */
  214         u_char  ifan_type;      /* message type */
  215         u_short ifan_index;     /* index for associated ifp */
  216         char    ifan_name[IFNAMSIZ]; /* if name, e.g. "en0" */
  217         u_short ifan_what;      /* what type of announcement */
  218 };
  219 
  220 #define IFAN_ARRIVAL    0       /* interface arrival */
  221 #define IFAN_DEPARTURE  1       /* interface departure */
  222 
  223 /*
  224  * Interface request structure used for socket
  225  * ioctl's.  All interface ioctl's must have parameter
  226  * definitions which begin with ifr_name.  The
  227  * remainder may be interface specific.
  228  */
  229 struct  ifreq {
  230         char    ifr_name[IFNAMSIZ];             /* if name, e.g. "en0" */
  231         union {
  232                 struct  sockaddr ifru_addr;
  233                 struct  sockaddr ifru_dstaddr;
  234                 struct  sockaddr ifru_broadaddr;
  235                 short   ifru_flags[2];
  236                 int     ifru_metric;
  237                 int     ifru_mtu;
  238                 int     ifru_phys;
  239                 int     ifru_media;
  240                 caddr_t ifru_data;
  241                 int     ifru_cap[2];
  242         } ifr_ifru;
  243 #define ifr_addr        ifr_ifru.ifru_addr      /* address */
  244 #define ifr_dstaddr     ifr_ifru.ifru_dstaddr   /* other end of p-to-p link */
  245 #define ifr_broadaddr   ifr_ifru.ifru_broadaddr /* broadcast address */
  246 #define ifr_flags       ifr_ifru.ifru_flags[0]  /* flags (low 16 bits) */
  247 #define ifr_flagshigh   ifr_ifru.ifru_flags[1]  /* flags (high 16 bits) */
  248 #define ifr_metric      ifr_ifru.ifru_metric    /* metric */
  249 #define ifr_mtu         ifr_ifru.ifru_mtu       /* mtu */
  250 #define ifr_phys        ifr_ifru.ifru_phys      /* physical wire */
  251 #define ifr_media       ifr_ifru.ifru_media     /* physical media */
  252 #define ifr_data        ifr_ifru.ifru_data      /* for use by interface */
  253 #define ifr_reqcap      ifr_ifru.ifru_cap[0]    /* requested capabilities */
  254 #define ifr_curcap      ifr_ifru.ifru_cap[1]    /* current capabilities */
  255 };
  256 
  257 #define _SIZEOF_ADDR_IFREQ(ifr) \
  258         ((ifr).ifr_addr.sa_len > sizeof(struct sockaddr) ? \
  259          (sizeof(struct ifreq) - sizeof(struct sockaddr) + \
  260           (ifr).ifr_addr.sa_len) : sizeof(struct ifreq))
  261 
  262 struct ifaliasreq {
  263         char    ifra_name[IFNAMSIZ];            /* if name, e.g. "en0" */
  264         struct  sockaddr ifra_addr;
  265         struct  sockaddr ifra_broadaddr;
  266         struct  sockaddr ifra_mask;
  267 };
  268 
  269 struct ifmediareq {
  270         char    ifm_name[IFNAMSIZ];     /* if name, e.g. "en0" */
  271         int     ifm_current;            /* current media options */
  272         int     ifm_mask;               /* don't care mask */
  273         int     ifm_status;             /* media status */
  274         int     ifm_active;             /* active options */
  275         int     ifm_count;              /* # entries in ifm_ulist array */
  276         int     *ifm_ulist;             /* media words */
  277 };
  278 
  279 /* 
  280  * Structure used to retrieve aux status data from interfaces.
  281  * Kernel suppliers to this interface should respect the formatting
  282  * needed by ifconfig(8): each line starts with a TAB and ends with
  283  * a newline.  The canonical example to copy and paste is in if_tun.c.
  284  */
  285 
  286 #define IFSTATMAX       800             /* 10 lines of text */
  287 struct ifstat {
  288         char    ifs_name[IFNAMSIZ];     /* if name, e.g. "en0" */
  289         char    ascii[IFSTATMAX + 1];
  290 };
  291 
  292 /*
  293  * Structure used in SIOCGIFCONF request.
  294  * Used to retrieve interface configuration
  295  * for machine (useful for programs which
  296  * must know all networks accessible).
  297  */
  298 struct  ifconf {
  299         int     ifc_len;                /* size of associated buffer */
  300         union {
  301                 caddr_t ifcu_buf;
  302                 struct  ifreq *ifcu_req;
  303         } ifc_ifcu;
  304 #define ifc_buf ifc_ifcu.ifcu_buf       /* buffer address */
  305 #define ifc_req ifc_ifcu.ifcu_req       /* array of structures returned */
  306 };
  307 
  308 
  309 /*
  310  * Structure for SIOC[AGD]LIFADDR
  311  */
  312 struct if_laddrreq {
  313         char    iflr_name[IFNAMSIZ];
  314         u_int   flags;
  315 #define IFLR_PREFIX     0x8000  /* in: prefix given  out: kernel fills id */
  316         u_int   prefixlen;         /* in/out */
  317         struct  sockaddr_storage addr;   /* in/out */
  318         struct  sockaddr_storage dstaddr; /* out */
  319 };
  320 
  321 #ifdef _KERNEL
  322 #ifdef MALLOC_DECLARE
  323 MALLOC_DECLARE(M_IFADDR);
  324 MALLOC_DECLARE(M_IFMADDR);
  325 #endif
  326 #endif
  327 
  328 #ifndef _KERNEL
  329 struct if_nameindex {
  330         u_int   if_index;       /* 1, 2, ... */
  331         char    *if_name;       /* null terminated name: "le0", ... */
  332 };
  333 
  334 __BEGIN_DECLS
  335 u_int    if_nametoindex __P((const char *));
  336 char    *if_indextoname __P((u_int, char *));
  337 struct   if_nameindex *if_nameindex __P((void));
  338 void     if_freenameindex __P((struct if_nameindex *));
  339 __END_DECLS
  340 #endif
  341 
  342 #ifdef _KERNEL
  343 struct proc;
  344 
  345 int     prison_if __P((struct proc *p, struct sockaddr *sa));
  346 
  347 /* XXX - this should go away soon. */
  348 #include <net/if_var.h>
  349 #endif
  350 
  351 #endif /* !_NET_IF_H_ */

Cache object: a631606c29b830737fd561197d23a51e


[ 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.