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 /*      $NetBSD: if.h,v 1.140 2008/10/24 17:07:33 dyoung Exp $  */
    2 
    3 /*-
    4  * Copyright (c) 1999, 2000, 2001 The NetBSD Foundation, Inc.
    5  * All rights reserved.
    6  *
    7  * This code is derived from software contributed to The NetBSD Foundation
    8  * by William Studenmund and Jason R. Thorpe.
    9  *
   10  * Redistribution and use in source and binary forms, with or without
   11  * modification, are permitted provided that the following conditions
   12  * are met:
   13  * 1. Redistributions of source code must retain the above copyright
   14  *    notice, this list of conditions and the following disclaimer.
   15  * 2. Redistributions in binary form must reproduce the above copyright
   16  *    notice, this list of conditions and the following disclaimer in the
   17  *    documentation and/or other materials provided with the distribution.
   18  *
   19  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
   20  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
   21  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
   22  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
   23  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
   24  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
   25  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
   26  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
   27  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
   28  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
   29  * POSSIBILITY OF SUCH DAMAGE.
   30  */
   31 
   32 /*
   33  * Copyright (c) 1982, 1986, 1989, 1993
   34  *      The Regents of the University of California.  All rights reserved.
   35  *
   36  * Redistribution and use in source and binary forms, with or without
   37  * modification, are permitted provided that the following conditions
   38  * are met:
   39  * 1. Redistributions of source code must retain the above copyright
   40  *    notice, this list of conditions and the following disclaimer.
   41  * 2. Redistributions in binary form must reproduce the above copyright
   42  *    notice, this list of conditions and the following disclaimer in the
   43  *    documentation and/or other materials provided with the distribution.
   44  * 3. Neither the name of the University nor the names of its contributors
   45  *    may be used to endorse or promote products derived from this software
   46  *    without specific prior written permission.
   47  *
   48  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
   49  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
   50  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
   51  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
   52  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
   53  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
   54  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
   55  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
   56  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
   57  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
   58  * SUCH DAMAGE.
   59  *
   60  *      @(#)if.h        8.3 (Berkeley) 2/9/95
   61  */
   62 
   63 #ifndef _NET_IF_H_
   64 #define _NET_IF_H_
   65 
   66 #include <sys/featuretest.h>
   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 IF_NAMESIZE 16
   73 
   74 #if defined(_NETBSD_SOURCE)
   75 
   76 #include <sys/mutex.h>
   77 #include <sys/condvar.h>
   78 #include <sys/socket.h>
   79 #include <sys/queue.h>
   80 #include <net/dlt.h>
   81 #include <net/pfil.h>
   82 
   83 /*
   84  * Always include ALTQ glue here -- we use the ALTQ interface queue
   85  * structure even when ALTQ is not configured into the kernel so that
   86  * the size of struct ifnet does not changed based on the option.  The
   87  * ALTQ queue structure is API-compatible with the legacy ifqueue.
   88  */
   89 #include <altq/if_altq.h>
   90 
   91 /*
   92  * Structures defining a network interface, providing a packet
   93  * transport mechanism (ala level 0 of the PUP protocols).
   94  *
   95  * Each interface accepts output datagrams of a specified maximum
   96  * length, and provides higher level routines with input datagrams
   97  * received from its medium.
   98  *
   99  * Output occurs when the routine if_output is called, with four parameters:
  100  *      (*ifp->if_output)(ifp, m, dst, rt)
  101  * Here m is the mbuf chain to be sent and dst is the destination address.
  102  * The output routine encapsulates the supplied datagram if necessary,
  103  * and then transmits it on its medium.
  104  *
  105  * On input, each interface unwraps the data received by it, and either
  106  * places it on the input queue of a internetwork datagram routine
  107  * and posts the associated software interrupt, or passes the datagram to a raw
  108  * packet input routine.
  109  *
  110  * Routines exist for locating interfaces by their addresses
  111  * or for locating a interface on a certain network, as well as more general
  112  * routing and gateway routines maintaining information used to locate
  113  * interfaces.  These routines live in the files if.c and route.c
  114  */
  115 /*  XXX fast fix for SNMP, going away soon */
  116 #include <sys/time.h>
  117 
  118 #if defined(_KERNEL_OPT)
  119 #include "opt_compat_netbsd.h"
  120 #endif
  121 
  122 struct mbuf;
  123 struct proc;
  124 struct rtentry;
  125 struct socket;
  126 struct ether_header;
  127 struct ifaddr;
  128 struct ifnet;
  129 struct rt_addrinfo;
  130 
  131 #define IFNAMSIZ        IF_NAMESIZE
  132 
  133 /*
  134  * Structure describing a `cloning' interface.
  135  */
  136 struct if_clone {
  137         LIST_ENTRY(if_clone) ifc_list;  /* on list of cloners */
  138         const char *ifc_name;           /* name of device, e.g. `gif' */
  139         size_t ifc_namelen;             /* length of name */
  140 
  141         int     (*ifc_create)(struct if_clone *, int);
  142         int     (*ifc_destroy)(struct ifnet *);
  143 };
  144 
  145 #define IF_CLONE_INITIALIZER(name, create, destroy)                     \
  146         { { NULL, NULL }, name, sizeof(name) - 1, create, destroy }
  147 
  148 /*
  149  * Structure used to query names of interface cloners.
  150  */
  151 struct if_clonereq {
  152         int     ifcr_total;             /* total cloners (out) */
  153         int     ifcr_count;             /* room for this many in user buffer */
  154         char    *ifcr_buffer;           /* buffer for cloner names */
  155 };
  156 
  157 /*
  158  * Structure defining statistics and other data kept regarding a network
  159  * interface.
  160  */
  161 struct if_data {
  162         /* generic interface information */
  163         u_char  ifi_type;               /* ethernet, tokenring, etc. */
  164         u_char  ifi_addrlen;            /* media address length */
  165         u_char  ifi_hdrlen;             /* media header length */
  166         int     ifi_link_state;         /* current link state */
  167         u_quad_t ifi_mtu;               /* maximum transmission unit */
  168         u_quad_t ifi_metric;            /* routing metric (external only) */
  169         u_quad_t ifi_baudrate;          /* linespeed */
  170         /* volatile statistics */
  171         u_quad_t ifi_ipackets;          /* packets received on interface */
  172         u_quad_t ifi_ierrors;           /* input errors on interface */
  173         u_quad_t ifi_opackets;          /* packets sent on interface */
  174         u_quad_t ifi_oerrors;           /* output errors on interface */
  175         u_quad_t ifi_collisions;        /* collisions on csma interfaces */
  176         u_quad_t ifi_ibytes;            /* total number of octets received */
  177         u_quad_t ifi_obytes;            /* total number of octets sent */
  178         u_quad_t ifi_imcasts;           /* packets received via multicast */
  179         u_quad_t ifi_omcasts;           /* packets sent via multicast */
  180         u_quad_t ifi_iqdrops;           /* dropped on input, this interface */
  181         u_quad_t ifi_noproto;           /* destined for unsupported protocol */
  182         struct  timeval ifi_lastchange; /* last operational state change */
  183 };
  184 
  185 /*
  186  * Values for if_link_state.
  187  */
  188 #define LINK_STATE_UNKNOWN      0       /* link invalid/unknown */
  189 #define LINK_STATE_DOWN         1       /* link is down */
  190 #define LINK_STATE_UP           2       /* link is up */
  191 
  192 #if defined(_KERNEL) && defined(COMPAT_14)
  193 /* Pre-1.5 if_data struct */
  194 struct if_data14 {
  195         /* generic interface information */
  196         u_char  ifi_type;               /* ethernet, tokenring, etc. */
  197         u_char  ifi_addrlen;            /* media address length */
  198         u_char  ifi_hdrlen;             /* media header length */
  199         u_long  ifi_mtu;                /* maximum transmission unit */
  200         u_long  ifi_metric;             /* routing metric (external only) */
  201         u_long  ifi_baudrate;           /* linespeed */
  202         /* volatile statistics */
  203         u_long  ifi_ipackets;           /* packets received on interface */
  204         u_long  ifi_ierrors;            /* input errors on interface */
  205         u_long  ifi_opackets;           /* packets sent on interface */
  206         u_long  ifi_oerrors;            /* output errors on interface */
  207         u_long  ifi_collisions;         /* collisions on csma interfaces */
  208         u_long  ifi_ibytes;             /* total number of octets received */
  209         u_long  ifi_obytes;             /* total number of octets sent */
  210         u_long  ifi_imcasts;            /* packets received via multicast */
  211         u_long  ifi_omcasts;            /* packets sent via multicast */
  212         u_long  ifi_iqdrops;            /* dropped on input, this interface */
  213         u_long  ifi_noproto;            /* destined for unsupported protocol */
  214         struct  timeval ifi_lastchange; /* last operational state change */
  215 };
  216 #endif /* _KERNEL && COMPAT_14 */
  217 
  218 /*
  219  * Structure defining a queue for a network interface.
  220  */
  221 struct ifqueue {
  222         struct  mbuf *ifq_head;
  223         struct  mbuf *ifq_tail;
  224         int     ifq_len;
  225         int     ifq_maxlen;
  226         int     ifq_drops;
  227 };
  228 
  229 /*
  230  * Structure defining a queue for a network interface.
  231  *
  232  * (Would like to call this struct ``if'', but C isn't PL/1.)
  233  */
  234 TAILQ_HEAD(ifnet_head, ifnet);          /* the actual queue head */
  235 
  236 struct ifnet {                          /* and the entries */
  237         void    *if_softc;              /* lower-level data for this if */
  238         TAILQ_ENTRY(ifnet) if_list;     /* all struct ifnets are chained */
  239         TAILQ_HEAD(, ifaddr) if_addrlist; /* linked list of addresses per if */
  240         char    if_xname[IFNAMSIZ];     /* external name (name + unit) */
  241         int     if_pcount;              /* number of promiscuous listeners */
  242         void *  if_bpf;                 /* packet filter structure */
  243         u_short if_index;               /* numeric abbreviation for this if */
  244         short   if_timer;               /* time 'til if_watchdog called */
  245         short   if_flags;               /* up/down, broadcast, etc. */
  246         short   if__pad1;               /* be nice to m68k ports */
  247         struct  if_data if_data;        /* statistics and other data about if */
  248         /*
  249          * Procedure handles.  If you add more of these, don't forget the
  250          * corresponding NULL stub in if.c.
  251          */
  252         int     (*if_output)            /* output routine (enqueue) */
  253                     (struct ifnet *, struct mbuf *, const struct sockaddr *,
  254                      struct rtentry *);
  255         void    (*if_input)             /* input routine (from h/w driver) */
  256                     (struct ifnet *, struct mbuf *);
  257         void    (*if_start)             /* initiate output routine */
  258                     (struct ifnet *);
  259         int     (*if_ioctl)             /* ioctl routine */
  260                     (struct ifnet *, u_long, void *);
  261         int     (*if_init)              /* init routine */
  262                     (struct ifnet *);
  263         void    (*if_stop)              /* stop routine */
  264                     (struct ifnet *, int);
  265         void    (*if_watchdog)          /* timer routine */
  266                     (struct ifnet *);
  267         void    (*if_drain)             /* routine to release resources */
  268                     (struct ifnet *);
  269         struct ifaltq if_snd;           /* output queue (includes altq) */
  270         struct ifaddr   *if_dl;         /* identity of this interface. */
  271         const struct    sockaddr_dl *if_sadl;   /* pointer to our sockaddr_dl */
  272         const uint8_t *if_broadcastaddr;/* linklevel broadcast bytestring */
  273         void    *if_bridge;             /* bridge glue */
  274         int     if_dlt;                 /* data link type (<net/dlt.h>) */
  275         struct pfil_head if_pfil;       /* filtering point */
  276         uint64_t if_capabilities;       /* interface capabilities */
  277         uint64_t if_capenable;          /* capabilities enabled */
  278         union {
  279                 void *          carp_s; /* carp structure (used by !carp ifs) */
  280                 struct ifnet    *carp_d;/* ptr to carpdev (used by carp ifs) */
  281         } if_carp_ptr;
  282 #define if_carp         if_carp_ptr.carp_s
  283 #define if_carpdev      if_carp_ptr.carp_d
  284         /*
  285          * These are pre-computed based on an interfaces enabled
  286          * capabilities, for speed elsewhere.
  287          */
  288         int     if_csum_flags_tx;       /* M_CSUM_* flags for Tx */
  289         int     if_csum_flags_rx;       /* M_CSUM_* flags for Rx */
  290 
  291         void    *if_afdata[AF_MAX];
  292         struct  mowner *if_mowner;      /* who owns mbufs for this interface */
  293 
  294         void    *if_agrprivate;         /* used only when #if NAGR > 0 */
  295 
  296         /*
  297          * pf specific data, used only when #if NPF > 0.
  298          */
  299         void    *if_pf_kif;             /* pf interface abstraction */
  300         void    *if_pf_groups;          /* pf interface groups */
  301 };
  302 #define if_mtu          if_data.ifi_mtu
  303 #define if_type         if_data.ifi_type
  304 #define if_addrlen      if_data.ifi_addrlen
  305 #define if_hdrlen       if_data.ifi_hdrlen
  306 #define if_metric       if_data.ifi_metric
  307 #define if_link_state   if_data.ifi_link_state
  308 #define if_baudrate     if_data.ifi_baudrate
  309 #define if_ipackets     if_data.ifi_ipackets
  310 #define if_ierrors      if_data.ifi_ierrors
  311 #define if_opackets     if_data.ifi_opackets
  312 #define if_oerrors      if_data.ifi_oerrors
  313 #define if_collisions   if_data.ifi_collisions
  314 #define if_ibytes       if_data.ifi_ibytes
  315 #define if_obytes       if_data.ifi_obytes
  316 #define if_imcasts      if_data.ifi_imcasts
  317 #define if_omcasts      if_data.ifi_omcasts
  318 #define if_iqdrops      if_data.ifi_iqdrops
  319 #define if_noproto      if_data.ifi_noproto
  320 #define if_lastchange   if_data.ifi_lastchange
  321 
  322 #define IFF_UP          0x0001          /* interface is up */
  323 #define IFF_BROADCAST   0x0002          /* broadcast address valid */
  324 #define IFF_DEBUG       0x0004          /* turn on debugging */
  325 #define IFF_LOOPBACK    0x0008          /* is a loopback net */
  326 #define IFF_POINTOPOINT 0x0010          /* interface is point-to-point link */
  327 #define IFF_NOTRAILERS  0x0020          /* avoid use of trailers */
  328 #define IFF_RUNNING     0x0040          /* resources allocated */
  329 #define IFF_NOARP       0x0080          /* no address resolution protocol */
  330 #define IFF_PROMISC     0x0100          /* receive all packets */
  331 #define IFF_ALLMULTI    0x0200          /* receive all multicast packets */
  332 #define IFF_OACTIVE     0x0400          /* transmission in progress */
  333 #define IFF_SIMPLEX     0x0800          /* can't hear own transmissions */
  334 #define IFF_LINK0       0x1000          /* per link layer defined bit */
  335 #define IFF_LINK1       0x2000          /* per link layer defined bit */
  336 #define IFF_LINK2       0x4000          /* per link layer defined bit */
  337 #define IFF_MULTICAST   0x8000          /* supports multicast */
  338 
  339 #define IFFBITS \
  340     "\020\1UP\2BROADCAST\3DEBUG\4LOOPBACK\5POINTOPOINT\6NOTRAILERS" \
  341     "\7RUNNING\10NOARP\11PROMISC\12ALLMULTI\13OACTIVE\14SIMPLEX" \
  342     "\15LINK0\16LINK1\17LINK2\20MULTICAST"
  343 
  344 /* flags set internally only: */
  345 #define IFF_CANTCHANGE \
  346         (IFF_BROADCAST|IFF_POINTOPOINT|IFF_RUNNING|IFF_OACTIVE|\
  347             IFF_SIMPLEX|IFF_MULTICAST|IFF_ALLMULTI|IFF_PROMISC)
  348 
  349 /*
  350  * Some convenience macros used for setting ifi_baudrate.
  351  * XXX 1000 vs. 1024? --thorpej@NetBSD.org
  352  */
  353 #define IF_Kbps(x)      ((x) * 1000)            /* kilobits/sec. */
  354 #define IF_Mbps(x)      (IF_Kbps((x) * 1000))   /* megabits/sec. */
  355 #define IF_Gbps(x)      (IF_Mbps((x) * 1000))   /* gigabits/sec. */
  356 
  357 /* Capabilities that interfaces can advertise. */
  358 #define IFCAP_TSOv4             0x00080 /* can do TCPv4 segmentation offload */
  359 #define IFCAP_CSUM_IPv4_Rx      0x00100 /* can do IPv4 header checksums (Rx) */
  360 #define IFCAP_CSUM_IPv4_Tx      0x00200 /* can do IPv4 header checksums (Tx) */
  361 #define IFCAP_CSUM_TCPv4_Rx     0x00400 /* can do IPv4/TCP checksums (Rx) */
  362 #define IFCAP_CSUM_TCPv4_Tx     0x00800 /* can do IPv4/TCP checksums (Tx) */
  363 #define IFCAP_CSUM_UDPv4_Rx     0x01000 /* can do IPv4/UDP checksums (Rx) */
  364 #define IFCAP_CSUM_UDPv4_Tx     0x02000 /* can do IPv4/UDP checksums (Tx) */
  365 #define IFCAP_CSUM_TCPv6_Rx     0x04000 /* can do IPv6/TCP checksums (Rx) */
  366 #define IFCAP_CSUM_TCPv6_Tx     0x08000 /* can do IPv6/TCP checksums (Tx) */
  367 #define IFCAP_CSUM_UDPv6_Rx     0x10000 /* can do IPv6/UDP checksums (Rx) */
  368 #define IFCAP_CSUM_UDPv6_Tx     0x20000 /* can do IPv6/UDP checksums (Tx) */
  369 #define IFCAP_TSOv6             0x40000 /* can do TCPv6 segmentation offload */
  370 
  371 #define IFCAPBITS               \
  372         "\020"                  \
  373         "\10TSO4"               \
  374         "\11IP4CSUM_Rx"         \
  375         "\12IP4CSUM_Tx"         \
  376         "\13TCP4CSUM_Rx"        \
  377         "\14TCP4CSUM_Tx"        \
  378         "\15UDP4CSUM_Rx"        \
  379         "\16UDP4CSUM_Tx"        \
  380         "\17TCP6CSUM_Rx"        \
  381         "\20TCP6CSUM_Tx"        \
  382         "\21UDP6CSUM_Rx"        \
  383         "\22UDP6CSUM_Tx"        \
  384         "\23TSO6"
  385 
  386 /*
  387  * Output queues (ifp->if_snd) and internetwork datagram level (pup level 1)
  388  * input routines have queues of messages stored on ifqueue structures
  389  * (defined above).  Entries are added to and deleted from these structures
  390  * by these macros, which should be called with ipl raised to splnet().
  391  */
  392 #define IF_QFULL(ifq)           ((ifq)->ifq_len >= (ifq)->ifq_maxlen)
  393 #define IF_DROP(ifq)            ((ifq)->ifq_drops++)
  394 #define IF_ENQUEUE(ifq, m) do { \
  395         (m)->m_nextpkt = 0; \
  396         if ((ifq)->ifq_tail == 0) \
  397                 (ifq)->ifq_head = m; \
  398         else \
  399                 (ifq)->ifq_tail->m_nextpkt = m; \
  400         (ifq)->ifq_tail = m; \
  401         (ifq)->ifq_len++; \
  402 } while (/*CONSTCOND*/0)
  403 #define IF_PREPEND(ifq, m) do { \
  404         (m)->m_nextpkt = (ifq)->ifq_head; \
  405         if ((ifq)->ifq_tail == 0) \
  406                 (ifq)->ifq_tail = (m); \
  407         (ifq)->ifq_head = (m); \
  408         (ifq)->ifq_len++; \
  409 } while (/*CONSTCOND*/0)
  410 #define IF_DEQUEUE(ifq, m) do { \
  411         (m) = (ifq)->ifq_head; \
  412         if (m) { \
  413                 if (((ifq)->ifq_head = (m)->m_nextpkt) == 0) \
  414                         (ifq)->ifq_tail = 0; \
  415                 (m)->m_nextpkt = 0; \
  416                 (ifq)->ifq_len--; \
  417         } \
  418 } while (/*CONSTCOND*/0) 
  419 #define IF_POLL(ifq, m)         ((m) = (ifq)->ifq_head)
  420 #define IF_PURGE(ifq)                                                   \
  421 do {                                                                    \
  422         struct mbuf *__m0;                                              \
  423                                                                         \
  424         for (;;) {                                                      \
  425                 IF_DEQUEUE((ifq), __m0);                                \
  426                 if (__m0 == NULL)                                       \
  427                         break;                                          \
  428                 else                                                    \
  429                         m_freem(__m0);                                  \
  430         }                                                               \
  431 } while (/*CONSTCOND*/ 0)
  432 #define IF_IS_EMPTY(ifq)        ((ifq)->ifq_len == 0)
  433 
  434 #ifndef IFQ_MAXLEN
  435 #define IFQ_MAXLEN      256
  436 #endif
  437 #define IFNET_SLOWHZ    1               /* granularity is 1 second */
  438 
  439 /*
  440  * Structure defining statistics and other data kept regarding an address
  441  * on a network interface.
  442  */
  443 struct ifaddr_data {
  444         int64_t ifad_inbytes;
  445         int64_t ifad_outbytes;
  446 };
  447 
  448 /*
  449  * The ifaddr structure contains information about one address
  450  * of an interface.  They are maintained by the different address families,
  451  * are allocated and attached when an address is set, and are linked
  452  * together so all addresses for an interface can be located.
  453  */
  454 struct ifaddr {
  455         struct  sockaddr *ifa_addr;     /* address of interface */
  456         struct  sockaddr *ifa_dstaddr;  /* other end of p-to-p link */
  457 #define ifa_broadaddr   ifa_dstaddr     /* broadcast address interface */
  458         struct  sockaddr *ifa_netmask;  /* used to determine subnet */
  459         struct  ifnet *ifa_ifp;         /* back-pointer to interface */
  460         TAILQ_ENTRY(ifaddr) ifa_list;   /* list of addresses for interface */
  461         struct  ifaddr_data     ifa_data;       /* statistics on the address */
  462         void    (*ifa_rtrequest)        /* check or clean routes (+ or -)'d */
  463                         (int, struct rtentry *, const struct rt_addrinfo *);
  464         u_int   ifa_flags;              /* mostly rt_flags for cloning */
  465         int     ifa_refcnt;             /* count of references */
  466         int     ifa_metric;             /* cost of going out this interface */
  467         struct ifaddr   *(*ifa_getifa)(struct ifaddr *,
  468                                        const struct sockaddr *);
  469         uint32_t        *ifa_seqno;
  470         int16_t ifa_preference; /* preference level for this address */
  471 };
  472 #define IFA_ROUTE       RTF_UP  /* (0x01) route installed */
  473 
  474 /*
  475  * Message format for use in obtaining information about interfaces
  476  * from sysctl and the routing socket.
  477  */
  478 struct if_msghdr {
  479         u_short ifm_msglen;     /* to skip over non-understood messages */
  480         u_char  ifm_version;    /* future binary compatibility */
  481         u_char  ifm_type;       /* message type */
  482         int     ifm_addrs;      /* like rtm_addrs */
  483         int     ifm_flags;      /* value of if_flags */
  484         u_short ifm_index;      /* index for associated ifp */
  485         struct  if_data ifm_data;/* statistics and other data about if */
  486 };
  487 
  488 #if defined(_KERNEL) && defined(COMPAT_14)
  489 /* pre-1.5 if_msghdr (ifm_data changed) */
  490 struct if_msghdr14 {
  491         u_short ifm_msglen;     /* to skip over non-understood messages */
  492         u_char  ifm_version;    /* future binary compatibility */
  493         u_char  ifm_type;       /* message type */
  494         int     ifm_addrs;      /* like rtm_addrs */
  495         int     ifm_flags;      /* value of if_flags */
  496         u_short ifm_index;      /* index for associated ifp */
  497         struct  if_data14 ifm_data; /* statistics and other data about if */
  498 };
  499 #endif /* _KERNEL && COMPAT_14 */
  500 
  501 /*
  502  * Message format for use in obtaining information about interface addresses
  503  * from sysctl and the routing socket.
  504  */
  505 struct ifa_msghdr {
  506         u_short ifam_msglen;    /* to skip over non-understood messages */
  507         u_char  ifam_version;   /* future binary compatibility */
  508         u_char  ifam_type;      /* message type */
  509         int     ifam_addrs;     /* like rtm_addrs */
  510         int     ifam_flags;     /* value of ifa_flags */
  511         u_short ifam_index;     /* index for associated ifp */
  512         int     ifam_metric;    /* value of ifa_metric */
  513 };
  514 
  515 /*
  516  * Message format announcing the arrival or departure of a network interface.
  517  */
  518 struct if_announcemsghdr {
  519         u_short ifan_msglen;    /* to skip over non-understood messages */
  520         u_char  ifan_version;   /* future binary compatibility */
  521         u_char  ifan_type;      /* message type */
  522         u_short ifan_index;     /* index for associated ifp */
  523         char    ifan_name[IFNAMSIZ]; /* if name, e.g. "en0" */
  524         u_short ifan_what;      /* what type of announcement */
  525 };
  526 
  527 #define IFAN_ARRIVAL    0       /* interface arrival */
  528 #define IFAN_DEPARTURE  1       /* interface departure */
  529 
  530 /*
  531  * Interface request structure used for socket
  532  * ioctl's.  All interface ioctl's must have parameter
  533  * definitions which begin with ifr_name.  The
  534  * remainder may be interface specific.
  535  */
  536 struct  ifreq {
  537         char    ifr_name[IFNAMSIZ];             /* if name, e.g. "en0" */
  538         union {
  539                 struct  sockaddr ifru_addr;
  540                 struct  sockaddr ifru_dstaddr;
  541                 struct  sockaddr ifru_broadaddr;
  542                 struct  sockaddr_storage ifru_space;
  543                 short   ifru_flags;
  544                 int     ifru_metric;
  545                 int     ifru_mtu;
  546                 int     ifru_dlt;
  547                 u_int   ifru_value;
  548                 void *  ifru_data;
  549                 struct {
  550                         uint32_t        b_buflen;
  551                         void            *b_buf;
  552                 } ifru_b;
  553         } ifr_ifru;
  554 #define ifr_addr        ifr_ifru.ifru_addr      /* address */
  555 #define ifr_dstaddr     ifr_ifru.ifru_dstaddr   /* other end of p-to-p link */
  556 #define ifr_broadaddr   ifr_ifru.ifru_broadaddr /* broadcast address */
  557 #define ifr_space       ifr_ifru.ifru_space     /* sockaddr_storage */
  558 #define ifr_flags       ifr_ifru.ifru_flags     /* flags */
  559 #define ifr_metric      ifr_ifru.ifru_metric    /* metric */
  560 #define ifr_mtu         ifr_ifru.ifru_mtu       /* mtu */
  561 #define ifr_dlt         ifr_ifru.ifru_dlt       /* data link type (DLT_*) */
  562 #define ifr_value       ifr_ifru.ifru_value     /* generic value */
  563 #define ifr_media       ifr_ifru.ifru_metric    /* media options (overload) */
  564 #define ifr_data        ifr_ifru.ifru_data      /* for use by interface
  565                                                  * XXX deprecated
  566                                                  */
  567 #define ifr_buf         ifr_ifru.ifru_b.b_buf   /* new interface ioctls */
  568 #define ifr_buflen      ifr_ifru.ifru_b.b_buflen
  569 };
  570 
  571 #ifdef _KERNEL
  572 #define ifreq_setdstaddr        ifreq_setaddr
  573 #define ifreq_setbroadaddr      ifreq_setaddr
  574 #define ifreq_getdstaddr        ifreq_getaddr
  575 #define ifreq_getbroadaddr      ifreq_getaddr
  576 
  577 static inline const struct sockaddr *
  578 ifreq_getaddr(u_long cmd, const struct ifreq *ifr)
  579 {
  580         return &ifr->ifr_addr;
  581 }
  582 #endif /* _KERNEL */
  583 
  584 struct ifcapreq {
  585         char            ifcr_name[IFNAMSIZ];    /* if name, e.g. "en0" */
  586         uint64_t        ifcr_capabilities;      /* supported capabiliites */
  587         uint64_t        ifcr_capenable;         /* capabilities enabled */
  588 };
  589 
  590 struct ifaliasreq {
  591         char    ifra_name[IFNAMSIZ];            /* if name, e.g. "en0" */
  592         struct  sockaddr ifra_addr;
  593         struct  sockaddr ifra_dstaddr;
  594 #define ifra_broadaddr  ifra_dstaddr
  595         struct  sockaddr ifra_mask;
  596 };
  597 
  598 struct ifdatareq {
  599         char    ifdr_name[IFNAMSIZ];            /* if name, e.g. "en0" */
  600         struct  if_data ifdr_data;
  601 };
  602 
  603 struct ifmediareq {
  604         char    ifm_name[IFNAMSIZ];             /* if name, e.g. "en0" */
  605         int     ifm_current;                    /* current media options */
  606         int     ifm_mask;                       /* don't care mask */
  607         int     ifm_status;                     /* media status */
  608         int     ifm_active;                     /* active options */
  609         int     ifm_count;                      /* # entries in ifm_ulist
  610                                                    array */
  611         int     *ifm_ulist;                     /* media words */
  612 };
  613 
  614 
  615 struct  ifdrv {
  616         char            ifd_name[IFNAMSIZ];     /* if name, e.g. "en0" */
  617         unsigned long   ifd_cmd;
  618         size_t          ifd_len;
  619         void            *ifd_data;
  620 };
  621 
  622 /*
  623  * Structure used in SIOCGIFCONF request.
  624  * Used to retrieve interface configuration
  625  * for machine (useful for programs which
  626  * must know all networks accessible).
  627  */
  628 struct  ifconf {
  629         int     ifc_len;                /* size of associated buffer */
  630         union {
  631                 void *  ifcu_buf;
  632                 struct  ifreq *ifcu_req;
  633         } ifc_ifcu;
  634 #define ifc_buf ifc_ifcu.ifcu_buf       /* buffer address */
  635 #define ifc_req ifc_ifcu.ifcu_req       /* array of structures returned */
  636 };
  637 
  638 /*
  639  * Structure for SIOC[AGD]LIFADDR
  640  */
  641 struct if_laddrreq {
  642         char iflr_name[IFNAMSIZ];
  643         unsigned int flags;
  644 #define IFLR_PREFIX     0x8000  /* in: prefix given  out: kernel fills id */
  645 #define IFLR_ACTIVE     0x4000  /* in/out: link-layer address activation */
  646         unsigned int prefixlen;         /* in/out */
  647         struct sockaddr_storage addr;   /* in/out */
  648         struct sockaddr_storage dstaddr; /* out */
  649 };
  650 
  651 /*
  652  * Structure for SIOC[SG]IFADDRPREF
  653  */
  654 struct if_addrprefreq {
  655         char                    ifap_name[IFNAMSIZ];
  656         int16_t                 ifap_preference;        /* in/out */
  657         struct sockaddr_storage ifap_addr;              /* in/out */
  658 };
  659 
  660 #include <net/if_arp.h>
  661 
  662 #endif /* _NETBSD_SOURCE */
  663 
  664 #ifdef _KERNEL
  665 #ifdef IFAREF_DEBUG
  666 #define IFAREF(ifa)                                                     \
  667 do {                                                                    \
  668         printf("IFAREF: %s:%d %p -> %d\n", __FILE__, __LINE__,          \
  669             (ifa), ++(ifa)->ifa_refcnt);                                \
  670 } while (/*CONSTCOND*/ 0)
  671 
  672 #define IFAFREE(ifa)                                                    \
  673 do {                                                                    \
  674         if ((ifa)->ifa_refcnt <= 0)                                     \
  675                 panic("%s:%d: %p ifa_refcnt <= 0", __FILE__,            \
  676                     __LINE__, (ifa));                                   \
  677         printf("IFAFREE: %s:%d %p -> %d\n", __FILE__, __LINE__,         \
  678             (ifa), --(ifa)->ifa_refcnt);                                \
  679         if ((ifa)->ifa_refcnt == 0)                                     \
  680                 ifafree(ifa);                                           \
  681 } while (/*CONSTCOND*/ 0)
  682 #else
  683 #define IFAREF(ifa)     (ifa)->ifa_refcnt++
  684 
  685 #ifdef DIAGNOSTIC
  686 #define IFAFREE(ifa)                                                    \
  687 do {                                                                    \
  688         if ((ifa)->ifa_refcnt <= 0)                                     \
  689                 panic("%s:%d: %p ifa_refcnt <= 0", __FILE__,            \
  690                     __LINE__, (ifa));                                   \
  691         if (--(ifa)->ifa_refcnt == 0)                                   \
  692                 ifafree(ifa);                                           \
  693 } while (/*CONSTCOND*/ 0)
  694 #else
  695 #define IFAFREE(ifa)                                                    \
  696 do {                                                                    \
  697         if (--(ifa)->ifa_refcnt == 0)                                   \
  698                 ifafree(ifa);                                           \
  699 } while (/*CONSTCOND*/ 0)
  700 #endif /* DIAGNOSTIC */
  701 #endif /* IFAREF_DEBUG */
  702 
  703 #ifdef ALTQ
  704 #define ALTQ_DECL(x)            x
  705 #define ALTQ_COMMA              ,
  706 
  707 #define IFQ_ENQUEUE(ifq, m, pattr, err)                                 \
  708 do {                                                                    \
  709         if (ALTQ_IS_ENABLED((ifq)))                                     \
  710                 ALTQ_ENQUEUE((ifq), (m), (pattr), (err));               \
  711         else {                                                          \
  712                 if (IF_QFULL((ifq))) {                                  \
  713                         m_freem((m));                                   \
  714                         (err) = ENOBUFS;                                \
  715                 } else {                                                \
  716                         IF_ENQUEUE((ifq), (m));                         \
  717                         (err) = 0;                                      \
  718                 }                                                       \
  719         }                                                               \
  720         if ((err))                                                      \
  721                 (ifq)->ifq_drops++;                                     \
  722 } while (/*CONSTCOND*/ 0)
  723 
  724 #define IFQ_DEQUEUE(ifq, m)                                             \
  725 do {                                                                    \
  726         if (TBR_IS_ENABLED((ifq)))                                      \
  727                 (m) = tbr_dequeue((ifq), ALTDQ_REMOVE);                 \
  728         else if (ALTQ_IS_ENABLED((ifq)))                                \
  729                 ALTQ_DEQUEUE((ifq), (m));                               \
  730         else                                                            \
  731                 IF_DEQUEUE((ifq), (m));                                 \
  732 } while (/*CONSTCOND*/ 0)
  733 
  734 #define IFQ_POLL(ifq, m)                                                \
  735 do {                                                                    \
  736         if (TBR_IS_ENABLED((ifq)))                                      \
  737                 (m) = tbr_dequeue((ifq), ALTDQ_POLL);                   \
  738         else if (ALTQ_IS_ENABLED((ifq)))                                \
  739                 ALTQ_POLL((ifq), (m));                                  \
  740         else                                                            \
  741                 IF_POLL((ifq), (m));                                    \
  742 } while (/*CONSTCOND*/ 0)
  743 
  744 #define IFQ_PURGE(ifq)                                                  \
  745 do {                                                                    \
  746         if (ALTQ_IS_ENABLED((ifq)))                                     \
  747                 ALTQ_PURGE((ifq));                                      \
  748         else                                                            \
  749                 IF_PURGE((ifq));                                        \
  750 } while (/*CONSTCOND*/ 0)
  751 
  752 #define IFQ_SET_READY(ifq)                                              \
  753 do {                                                                    \
  754         (ifq)->altq_flags |= ALTQF_READY;                               \
  755 } while (/*CONSTCOND*/ 0)
  756 
  757 #define IFQ_CLASSIFY(ifq, m, af, pattr)                                 \
  758 do {                                                                    \
  759         if (ALTQ_IS_ENABLED((ifq))) {                                   \
  760                 if (ALTQ_NEEDS_CLASSIFY((ifq)))                         \
  761                         (pattr)->pattr_class = (*(ifq)->altq_classify)  \
  762                                 ((ifq)->altq_clfier, (m), (af));        \
  763                 (pattr)->pattr_af = (af);                               \
  764                 (pattr)->pattr_hdr = mtod((m), void *);         \
  765         }                                                               \
  766 } while (/*CONSTCOND*/ 0)
  767 #else /* ! ALTQ */
  768 #define ALTQ_DECL(x)            /* nothing */
  769 #define ALTQ_COMMA
  770 
  771 #define IFQ_ENQUEUE(ifq, m, pattr, err)                                 \
  772 do {                                                                    \
  773         if (IF_QFULL((ifq))) {                                          \
  774                 m_freem((m));                                           \
  775                 (err) = ENOBUFS;                                        \
  776         } else {                                                        \
  777                 IF_ENQUEUE((ifq), (m));                                 \
  778                 (err) = 0;                                              \
  779         }                                                               \
  780         if ((err))                                                      \
  781                 (ifq)->ifq_drops++;                                     \
  782 } while (/*CONSTCOND*/ 0)
  783 
  784 #define IFQ_DEQUEUE(ifq, m)     IF_DEQUEUE((ifq), (m))
  785 
  786 #define IFQ_POLL(ifq, m)        IF_POLL((ifq), (m))
  787 
  788 #define IFQ_PURGE(ifq)          IF_PURGE((ifq))
  789 
  790 #define IFQ_SET_READY(ifq)      /* nothing */
  791 
  792 #define IFQ_CLASSIFY(ifq, m, af, pattr) /* nothing */
  793 
  794 #endif /* ALTQ */
  795 
  796 #define IFQ_IS_EMPTY(ifq)               IF_IS_EMPTY((ifq))
  797 #define IFQ_INC_LEN(ifq)                ((ifq)->ifq_len++)
  798 #define IFQ_DEC_LEN(ifq)                (--(ifq)->ifq_len)
  799 #define IFQ_INC_DROPS(ifq)              ((ifq)->ifq_drops++)
  800 #define IFQ_SET_MAXLEN(ifq, len)        ((ifq)->ifq_maxlen = (len))
  801 
  802 #include <sys/mallocvar.h>
  803 MALLOC_DECLARE(M_IFADDR);
  804 MALLOC_DECLARE(M_IFMADDR);
  805 
  806 #define IFNET_FIRST()                   TAILQ_FIRST(&ifnet)
  807 #define IFNET_NEXT(__ifp)               TAILQ_NEXT((__ifp), if_list)
  808 #define IFNET_FOREACH(__ifp)            TAILQ_FOREACH(__ifp, &ifnet, if_list)
  809 #define IFADDR_FIRST(__ifp)             TAILQ_FIRST(&(__ifp)->if_addrlist)
  810 #define IFADDR_NEXT(__ifa)              TAILQ_NEXT((__ifa), ifa_list)
  811 #define IFADDR_FOREACH(__ifa, __ifp)    TAILQ_FOREACH(__ifa, \
  812                                             &(__ifp)->if_addrlist, ifa_list)
  813 #define IFADDR_EMPTY(__ifp)             TAILQ_EMPTY(&(__ifp)->if_addrlist)
  814 
  815 extern struct ifnet_head ifnet;
  816 extern struct ifnet **ifindex2ifnet;
  817 extern struct ifnet *lo0ifp;
  818 extern size_t if_indexlim;
  819 
  820 void    ether_input(struct ifnet *, struct mbuf *);
  821 
  822 int ifreq_setaddr(u_long, struct ifreq *, const struct sockaddr *);
  823 
  824 struct ifnet *if_alloc(u_char);
  825 void if_initname(struct ifnet *, const char *, int);
  826 struct ifaddr *if_dl_create(const struct ifnet *, const struct sockaddr_dl **);
  827 void if_activate_sadl(struct ifnet *, struct ifaddr *,
  828     const struct sockaddr_dl *);
  829 void    if_set_sadl(struct ifnet *, const void *, u_char);
  830 void    if_alloc_sadl(struct ifnet *);
  831 void    if_free_sadl(struct ifnet *);
  832 void    if_attach(struct ifnet *);
  833 void    if_attachdomain(void);
  834 void    if_attachdomain1(struct ifnet *);
  835 void    if_deactivate(struct ifnet *);
  836 void    if_purgeaddrs(struct ifnet *, int, void (*)(struct ifaddr *));
  837 void    if_detach(struct ifnet *);
  838 void    if_down(struct ifnet *);
  839 void    if_link_state_change(struct ifnet *, int);
  840 void    if_slowtimo(void *);
  841 void    if_up(struct ifnet *);
  842 int     ifconf(u_long, void *);
  843 void    ifinit(void);
  844 void    ifinit1(void);
  845 int     ifioctl(struct socket *, u_long, void *, struct lwp *);
  846 int     ifioctl_common(struct ifnet *, u_long, void *);
  847 int     ifpromisc(struct ifnet *, int);
  848 struct  ifnet *ifunit(const char *);
  849 
  850 void ifa_insert(struct ifnet *, struct ifaddr *);
  851 void ifa_remove(struct ifnet *, struct ifaddr *);
  852 
  853 struct  ifaddr *ifa_ifwithaddr(const struct sockaddr *);
  854 struct  ifaddr *ifa_ifwithaf(int);
  855 struct  ifaddr *ifa_ifwithdstaddr(const struct sockaddr *);
  856 struct  ifaddr *ifa_ifwithnet(const struct sockaddr *);
  857 struct  ifaddr *ifa_ifwithladdr(const struct sockaddr *);
  858 struct  ifaddr *ifa_ifwithroute(int, const struct sockaddr *,
  859                                         const struct sockaddr *);
  860 struct  ifaddr *ifaof_ifpforaddr(const struct sockaddr *, struct ifnet *);
  861 void    ifafree(struct ifaddr *);
  862 void    link_rtrequest(int, struct rtentry *, const struct rt_addrinfo *);
  863 
  864 void    if_clone_attach(struct if_clone *);
  865 void    if_clone_detach(struct if_clone *);
  866 
  867 int     if_clone_create(const char *);
  868 int     if_clone_destroy(const char *);
  869 
  870 int     ifq_enqueue(struct ifnet *, struct mbuf * ALTQ_COMMA
  871     ALTQ_DECL(struct altq_pktattr *));
  872 int     ifq_enqueue2(struct ifnet *, struct ifqueue *, struct mbuf * ALTQ_COMMA
  873     ALTQ_DECL(struct altq_pktattr *));
  874 
  875 int     loioctl(struct ifnet *, u_long, void *);
  876 void    loopattach(int);
  877 int     looutput(struct ifnet *,
  878            struct mbuf *, const struct sockaddr *, struct rtentry *);
  879 void    lortrequest(int, struct rtentry *, const struct rt_addrinfo *);
  880 
  881 /*
  882  * These are exported because they're an easy way to tell if
  883  * an interface is going away without having to burn a flag.
  884  */
  885 int     if_nulloutput(struct ifnet *, struct mbuf *,
  886             const struct sockaddr *, struct rtentry *);
  887 void    if_nullinput(struct ifnet *, struct mbuf *);
  888 void    if_nullstart(struct ifnet *);
  889 int     if_nullioctl(struct ifnet *, u_long, void *);
  890 int     if_nullinit(struct ifnet *);
  891 void    if_nullstop(struct ifnet *, int);
  892 void    if_nullwatchdog(struct ifnet *);
  893 void    if_nulldrain(struct ifnet *);
  894 #else
  895 struct if_nameindex {
  896         unsigned int    if_index;       /* 1, 2, ... */
  897         char            *if_name;       /* null terminated name: "le0", ... */
  898 };
  899 
  900 #include <sys/cdefs.h>
  901 __BEGIN_DECLS
  902 unsigned int if_nametoindex(const char *);
  903 char *  if_indextoname(unsigned int, char *);
  904 struct  if_nameindex * if_nameindex(void);
  905 void    if_freenameindex(struct if_nameindex *);
  906 __END_DECLS
  907 #endif /* _KERNEL */ /* XXX really ALTQ? */
  908 
  909 #ifdef _KERNEL
  910 /*
  911  * ifq sysctl support
  912  */
  913 int     sysctl_ifq(int *name, u_int namelen, void *oldp,
  914                        size_t *oldlenp, void *newp, size_t newlen,
  915                        struct ifqueue *ifq);
  916 /* symbolic names for terminal (per-protocol) CTL_IFQ_ nodes */
  917 #define IFQCTL_LEN 1
  918 #define IFQCTL_MAXLEN 2
  919 #define IFQCTL_PEAK 3
  920 #define IFQCTL_DROPS 4
  921 #define IFQCTL_MAXID 5
  922 
  923 #endif /* _KERNEL */
  924 
  925 #ifdef _NETBSD_SOURCE
  926 /*
  927  * sysctl for ifq (per-protocol packet input queue variant of ifqueue)
  928  */
  929 #define CTL_IFQ_NAMES  { \
  930         { 0, 0 }, \
  931         { "len", CTLTYPE_INT }, \
  932         { "maxlen", CTLTYPE_INT }, \
  933         { "peak", CTLTYPE_INT }, \
  934         { "drops", CTLTYPE_INT }, \
  935 }
  936 #endif /* _NETBSD_SOURCE */
  937 #endif /* !_NET_IF_H_ */

Cache object: c9b604a3a0535291d3d34234cd51d923


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