sys/net/if_var.h

   1 /*
   2  * Copyright (c) 1982, 1986, 1989, 1993
   3  *      The Regents of the University of California.  All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  * 3. 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  *      From: @(#)if.h  8.1 (Berkeley) 6/10/93
  30  * $FreeBSD: src/sys/net/if_var.h,v 1.18.2.16 2003/04/15 18:11:19 fjoe Exp $
  31  */
  32
  33 #ifndef _NET_IF_VAR_H_
  34 #define _NET_IF_VAR_H_
  35
  36 #ifndef _SYS_SERIALIZE_H_
  37 #include <sys/serialize.h>
  38 #endif
  39 #ifndef _NET_IF_H_
  40 #include <net/if.h>
  41 #endif
  42 #ifndef _SYS_MUTEX_H_
  43 #include <sys/mutex.h>
  44 #endif
  45
  46 /*
  47  * Structures defining a network interface, providing a packet
  48  * transport mechanism (ala level 0 of the PUP protocols).
  49  *
  50  * Each interface accepts output datagrams of a specified maximum
  51  * length, and provides higher level routines with input datagrams
  52  * received from its medium.
  53  *
  54  * Output occurs when the routine if_output is called, with four parameters:
  55  *
  56  *      ifp->if_output(ifp, m, dst, rt)
  57  *
  58  * Here m is the mbuf chain to be sent and dst is the destination address.
  59  * The output routine encapsulates the supplied datagram if necessary,
  60  * and then transmits it on its medium.
  61  *
  62  * On input, each interface unwraps the data received by it, and either
  63  * places it on the input queue of a internetwork datagram routine
  64  * and posts the associated software interrupt, or passes the datagram to
  65  * the routine if_input. It is called with four parameters:
  66  *
  67  *      ifp->if_input(ifp, m, pi, cpuid)
  68  *
  69  * Here m is the mbuf chain to be received. The input routine removes the
  70  * protocol dependent header if necessary. A driver may also call using
  71  * custom struct pktinfo reference pi and a cpuid to take advantage of
  72  * hardware supplied information. Otherwise, the defaults for pi and cpuid
  73  * are as follows:
  74  *
  75  *      ifp->if_input(ifp, m, NULL, -1);
  76  *
  77  * Routines exist for locating interfaces by their addresses
  78  * or for locating a interface on a certain network, as well as more general
  79  * routing and gateway routines maintaining information used to locate
  80  * interfaces.  These routines live in the files if.c and route.c
  81  */
  82
  83 /*
  84  * Forward structure declarations for function prototypes [sic].
  85  */
  86 struct  rtentry;                /* ifa_rtrequest */
  87 struct  socket;
  88 struct  ucred;
  89 struct  lwkt_serialize;
  90 struct  ifaddr_container;
  91 struct  ifaddr;
  92 struct  pktinfo;
  93 struct  ifpoll_info;
  94 struct  ifdata_pcpu;
  95
  96 #include <sys/queue.h>          /* get TAILQ macros */
  97
  98 #include <net/altq/if_altq.h>
  99
 100 #ifdef _KERNEL
 101 #include <sys/eventhandler.h>
 102 #include <sys/mbuf.h>
 103 #include <sys/thread2.h>
 104 #endif /* _KERNEL */
 105
 106 #define IF_DUNIT_NONE   -1
 107
 108 TAILQ_HEAD(ifnethead, ifnet);   /* we use TAILQs so that the order of */
 109 TAILQ_HEAD(ifaddrhead, ifaddr_container); /* instantiation is preserved in the list */
 110 TAILQ_HEAD(ifmultihead, ifmultiaddr);
 111
 112 /*
 113  * Structure defining a mbuf queue.
 114  */
 115 struct ifqueue {
 116         struct  mbuf *ifq_head;
 117         struct  mbuf *ifq_tail;
 118         int     ifq_len;
 119         int     ifq_maxlen;
 120         int     ifq_drops;
 121 };
 122
 123 /*
 124  * Note of IFPOLL_ENABLE
 125  * 1) Any file(*.c) that depends on IFPOLL_ENABLE supports in this
 126  *    file should include opt_ifpoll.h at its beginning.
 127  * 2) When struct changes, which are conditioned by IFPOLL_ENABLE,
 128  *    are to be introduced, please keep the struct's size and layout
 129  *    same, no matter whether IFPOLL_ENABLE is defined or not.
 130  *    See ifnet.if_npoll and ifnet.if_npoll_unused for example.
 131  */
 132
 133 /*
 134  * Network serialize/deserialize types
 135  */
 136 enum ifnet_serialize {
 137         IFNET_SERIALIZE_ALL     /* all serializers */
 138 };
 139
 140 #if defined(_KERNEL) || defined(_KERNEL_STRUCTURES)
 141
 142 /*
 143  * Structure defining a network interface.
 144  *
 145  * (Would like to call this struct ``if'', but C isn't PL/1.)
 146  */
 147
 148 /*
 149  * NB: For DragonFlyBSD, it is assumed that each NIC driver's softc starts
 150  * with one of these structures, typically held within an arpcom structure.
 151  *
 152  *      struct <foo>_softc {
 153  *              struct arpcom {
 154  *                      struct  ifnet ac_if;
 155  *                      ...
 156  *              } <arpcom> ;
 157  *              ...
 158  *      };
 159  *
 160  * The assumption is used in a number of places, including many
 161  * files in sys/net, device drivers, and sys/dev/mii.c:miibus_attach().
 162  *
 163  * Unfortunately devices' softc are opaque, so we depend on this layout
 164  * to locate the struct ifnet from the softc in the generic code.
 165  *
 166  *
 167  *
 168  * MPSAFE NOTES:
 169  *
 170  * ifnet is protected by calling if_serialize, if_tryserialize and
 171  * if_deserialize serialize functions with the ifnet_serialize parameter.
 172  * Callers of if_ioctl, if_watchdog, if_init, if_resolvemulti, and if_npoll
 173  * should call the ifnet serialize functions with IFNET_SERIALIZE_ALL.
 174  *
 175  * if_snd subqueues are protected by its own serializers.  Callers of
 176  * if_start should call ifsq_serialiize_hw(), ifsq_deserialize_hw() and
 177  * ifsq_tryserialize_hw() to properly serialize hardware for transmission.
 178  *
 179  * Caller of if_output MUST NOT serialize ifnet or if_snd by calling
 180  * the related serialize functions.
 181  *
 182  * For better tranmission performance, driver should setup if_snd subqueue
 183  * owner cpuid properly using ifsq_set_cpuid() (or ifq_set_cpuid(), if not
 184  * multiple transmit queue capable).  Normally, the if_snd subqueue owner
 185  * cpu is the one that processing the transmission interrupt.  And in driver,
 186  * direct call of if_start should be avoided, use ifsq_devstart() or
 187  * ifsq_devstart_sched() instead (or if_devstart()/if_devstart_sched(), if
 188  * not multiple transmit queue capable).
 189  *
 190  *
 191  *
 192  * STATISTICS:
 193  *
 194  * if_data is no longer used to hold per interface statistics, so DO NOT use
 195  * the old style ifp->if_ipackets++ to update statistics; instead IFNET_STAT_
 196  * macros should be used.
 197  *
 198  *
 199  *
 200  * SINGLE SERIALIZER MODE:
 201  *
 202  * In this mode, driver MUST NOT setup if_serialize, if_deserialize,
 203  * if_tryserialize or if_serialize_assert.  Driver could supply its own
 204  * serializer to be used (through the type specific attach function, e.g.
 205  * ether_ifattach()) or it could depend on the default serializer.  In this
 206  * mode if_serializer will be setup properly.
 207  *
 208  * If a device driver installs the same serializer for its interrupt
 209  * as for ifnet, then the driver only really needs to worry about further
 210  * serialization in timeout based entry points and device_method_t entry
 211  * points.  All other entry points will already be serialized.
 212  *
 213  *
 214  *
 215  * MULTI SERIALIZERS MODE:
 216  *
 217  * In this mode, driver MUST setup if_serialize, if_deserialize,
 218  * if_tryserialize and if_serialize_assert.  Driver MUST NOT supply its own
 219  * serializer to be used.  In this mode, if_serializer will be left as NULL.
 220  * And driver MUST setup if_snd subqueues' hardware serailizer properly by
 221  * calling ifsq_set_hw_serialize().
 222  *
 223  *
 224  *
 225  * MULTIPLE TRANSMIT QUEUES:
 226  *
 227  * This should be implemented in "MULTI SERIALIZERS MODE".  Legacy if_watchdog
 228  * method SHOULD NOT be used.
 229  *
 230  * 1) Attach
 231  *
 232  * Before the type specific attach, e.g. ether_ifattach(), driver should
 233  * setup the transmit queue count and cpuid to subqueue mapping method
 234  * properly (assume QCOUNT is power of 2):
 235  *
 236  *      ifq_set_subq_cnt(&ifp->if_snd, QCOUNT);
 237  *      ifp->if_mapsubq = ifq_mapsubq_modulo;
 238  *      ifq_set_subq_divisor(&ifp->if_snd, QCOUNT);
 239  *
 240  * After the type specific attach, driver should setup the subqueues owner
 241  * cpu, serializer and watchdog properly:
 242  *
 243  *      for (i = 0; i < QCOUNT, ++i) {
 244  *              struct ifaltq_subque *ifsq = ifq_get_subq(&ifp->if_snd, i);
 245  *
 246  *              ifsq_set_cpuid(ifsq, Q_CPUID);
 247  *              ifsq_set_hw_serialize(ifsq, Q_SLIZE);
 248  *              ifsq_watchdog_init(Q_WDOG, ifsq, Q_WDOG_FUNC);
 249  *      }
 250  *
 251  * Q_CPUID, the cpu which handles the hardware transmit queue interrupt
 252  * Q_SLIZE, the serializer protects the hardware transmit queue
 253  * Q_WDOG, per hardware transmit queue watchdog handler, struct ifsubq_watchdog
 254  * Q_WDOG_FUNC, watchdog function, probably should reset hardware
 255  *
 256  * 2) Stop
 257  *
 258  * Make sure per hardware transmit queue watchdog is stopped and oactive is
 259  * cleared:
 260  *
 261  *      for (i = 0; i < QCOUNT, ++i) {
 262  *              ifsq_clr_oactive(ifsq);
 263  *              ifsq_watchdog_stop(Q_WDOG);
 264  *      }
 265  *
 266  * 3) Initialize
 267  *
 268  * Make sure per hardware transmit queue watchdog is started and oactive is
 269  * cleared:
 270  *
 271  *      for (i = 0; i < QCOUNT, ++i) {
 272  *              ifsq_clr_oactive(ifsq);
 273  *              ifsq_watchdog_start(Q_WDOG);
 274  *      }
 275  *
 276  * 4) if_start
 277  *
 278  * if_start takes subqueue as parameter, so instead of using ifq_ functions
 279  * ifsq_ functions should be used.  If device could not be programmed to
 280  * transmit when no media link is not up, MAKE SURE to purge the subqueue:
 281  *
 282  *      if ((ifp->if_flags & IFF_RUNNING) == 0 || ifsq_is_oactive(ifsq))
 283  *              return;
 284  *      if (NO_LINK) {
 285  *              ifsq_purge(ifsq);
 286  *              return;
 287  *      }
 288  *      for (;;) {
 289  *              if (NO_FREE_DESC) {
 290  *                      ifsq_set_oactive(ifsq);
 291  *                      break;
 292  *              }
 293  *              m = ifsq_dequeue(ifsq);
 294  *              if (m != NULL)
 295  *                      DRIVER_ENCAP(m);
 296  *              Q_WDOG.wd_timer = WDOG_TIMEOUT;
 297  *      }
 298  *
 299  * 5) Transmission done, e.g. transmit queue interrupt processing
 300  *
 301  * Same as if_start, ifsq_ functions should be used:
 302  *
 303  *      DRIVER_COLLECT_DESC();
 304  *      if (HAS_FREE_DESC)
 305  *              ifsq_clr_oactive(ifsq);
 306  *      if (NO_PENDING_DESC)
 307  *              Q_WDOG.wd_timer = 0;
 308  *      if (!ifsq_is_empty(ifsq))
 309  *              ifsq_devstart(ifsq);
 310  */
 311 struct ifnet {
 312         void    *if_softc;              /* pointer to driver state */
 313         void    *if_l2com;              /* pointer to protocol bits */
 314         TAILQ_ENTRY(ifnet) if_link;     /* all struct ifnets are chained */
 315         char    if_xname[IFNAMSIZ];     /* external name (name + unit) */
 316         const char *if_dname;           /* driver name */
 317         int     if_dunit;               /* unit or IF_DUNIT_NONE */
 318         void    *if_vlantrunks;         /* vlan trunks */
 319         struct  ifaddrhead *if_addrheads; /* per-cpu per-if addresses */
 320         int     if_pcount;              /* number of promiscuous listeners */
 321         void    *if_carp;               /* carp interfaces */
 322         struct  bpf_if *if_bpf;         /* packet filter structure */
 323         u_short if_index;               /* numeric abbreviation for this if  */
 324         short   if_timer;               /* time 'til if_watchdog called */
 325         int     if_flags;               /* up/down, broadcast, etc. */
 326         int     if_capabilities;        /* interface capabilities */
 327         int     if_capenable;           /* enabled features */
 328         void    *if_linkmib;            /* link-type-specific MIB data */
 329         size_t  if_linkmiblen;          /* length of above data */
 330         struct  if_data if_data;        /* NOTE: stats are in if_data_pcpu */
 331         struct  ifmultihead if_multiaddrs; /* multicast addresses configured */
 332         int     if_amcount;             /* number of all-multicast requests */
 333 /* procedure handles */
 334         int     (*if_output)            /* output routine (enqueue) */
 335                 (struct ifnet *, struct mbuf *, struct sockaddr *,
 336                      struct rtentry *);
 337         void    (*if_input)             /* input routine from hardware driver */
 338                 (struct ifnet *, struct mbuf *,
 339                      const struct pktinfo *pi, int cpuid);
 340         void    (*if_start)             /* initiate output routine */
 341                 (struct ifnet *, struct ifaltq_subque *);
 342         int     (*if_ioctl)             /* ioctl routine */
 343                 (struct ifnet *, u_long, caddr_t, struct ucred *);
 344         void    (*if_watchdog)          /* timer routine */
 345                 (struct ifnet *);
 346         void    (*if_init)              /* init routine */
 347                 (void *);
 348         int     (*if_resolvemulti)      /* validate/resolve multicast */
 349                 (struct ifnet *, struct sockaddr **, struct sockaddr *);
 350         void    *if_unused5;
 351         TAILQ_HEAD(, ifg_list) if_groups; /* linked list of groups per if */
 352         int     (*if_mapsubq)           /* cpuid to if_snd subqueue map */
 353                 (struct ifaltq *, int);
 354         int     if_unused2;
 355
 356         /*
 357          * ifnet serialize functions
 358          */
 359         void    (*if_serialize)
 360                 (struct ifnet *, enum ifnet_serialize);
 361         void    (*if_deserialize)
 362                 (struct ifnet *, enum ifnet_serialize);
 363         int     (*if_tryserialize)
 364                 (struct ifnet *, enum ifnet_serialize);
 365 #ifdef INVARIANTS
 366         void    (*if_serialize_assert)
 367                 (struct ifnet *, enum ifnet_serialize, boolean_t);
 368 #else
 369         /* Place holder */
 370         void    (*if_serialize_unused)(void);
 371 #endif
 372
 373 #ifdef IFPOLL_ENABLE
 374         void    (*if_npoll)             /* polling config */
 375                 (struct ifnet *, struct ifpoll_info *);
 376 #else
 377         /* Place holder */
 378         void    (*if_npoll_unused)(void);
 379 #endif
 380         int     if_tsolen;              /* max TSO length */
 381         struct  ifaltq if_snd;          /* output subqueues */
 382         const uint8_t   *if_broadcastaddr;
 383         void    *if_bridge;             /* bridge glue */
 384         void    *if_lagg;               /* lagg glue */
 385         void    *if_afdata[AF_MAX];
 386         struct ifaddr   *if_lladdr;
 387
 388         /* serializer, in single serializer mode */
 389         struct lwkt_serialize *if_serializer;
 390         /*
 391          * default serializer, in single serializer mode,
 392          * if driver does not supply one
 393          */
 394         struct lwkt_serialize if_default_serializer;
 395
 396         int     if_unused4;
 397         struct ifdata_pcpu *if_data_pcpu; /* per-cpu stats */
 398         void    *if_pf_kif;             /* pf interface */
 399
 400         /*
 401          * Mbuf clusters/jclusters limits should be increased
 402          * by if_nmbclusters/if_nmbjclusters.  Mainly for mbuf
 403          * clusters/jclusters that could sit on the device
 404          * queues, e.g. reception queues, for quite some time.
 405          */
 406         int     if_nmbclusters;
 407         int     if_nmbjclusters;
 408 };
 409 typedef void if_init_f_t (void *);
 410
 411 #define if_mtu          if_data.ifi_mtu
 412 #define if_type         if_data.ifi_type
 413 #define if_physical     if_data.ifi_physical
 414 #define if_addrlen      if_data.ifi_addrlen
 415 #define if_hdrlen       if_data.ifi_hdrlen
 416 #define if_metric       if_data.ifi_metric
 417 #define if_link_state   if_data.ifi_link_state
 418 #define if_baudrate     if_data.ifi_baudrate
 419 #define if_hwassist     if_data.ifi_hwassist
 420 #define if_ipackets     if_data.ifi_ipackets
 421 #define if_ierrors      if_data.ifi_ierrors
 422 #define if_opackets     if_data.ifi_opackets
 423 #define if_oerrors      if_data.ifi_oerrors
 424 #define if_collisions   if_data.ifi_collisions
 425 #define if_ibytes       if_data.ifi_ibytes
 426 #define if_obytes       if_data.ifi_obytes
 427 #define if_imcasts      if_data.ifi_imcasts
 428 #define if_omcasts      if_data.ifi_omcasts
 429 #define if_iqdrops      if_data.ifi_iqdrops
 430 #define if_noproto      if_data.ifi_noproto
 431 #define if_oqdrops      if_data.ifi_oqdrops
 432 #define if_lastchange   if_data.ifi_lastchange
 433 #define if_recvquota    if_data.ifi_recvquota
 434 #define if_xmitquota    if_data.ifi_xmitquota
 435 #define if_rawoutput(if, m, sa) if_output(if, m, sa, NULL)
 436
 437 /* for compatibility with other BSDs */
 438 #define if_list         if_link
 439
 440 /*
 441  * Per-cpu interface statistics
 442  */
 443 struct ifdata_pcpu {
 444         u_long  ifd_ipackets;           /* packets received on interface */
 445         u_long  ifd_ierrors;            /* input errors on interface */
 446         u_long  ifd_opackets;           /* packets sent on interface */
 447         u_long  ifd_oerrors;            /* output errors on interface */
 448         u_long  ifd_collisions;         /* collisions on csma interfaces */
 449         u_long  ifd_ibytes;             /* total number of octets received */
 450         u_long  ifd_obytes;             /* total number of octets sent */
 451         u_long  ifd_imcasts;            /* packets received via multicast */
 452         u_long  ifd_omcasts;            /* packets sent via multicast */
 453         u_long  ifd_iqdrops;            /* dropped on input, this interface */
 454         u_long  ifd_noproto;            /* destined for unsupported protocol */
 455         u_long  ifd_oqdrops;            /* dropped on output, this interface */
 456 } __cachealign;
 457
 458 #endif  /* _KERNEL || _KERNEL_STRUCTURES */
 459
 460 /*
 461  * ifqueue operation macros
 462  */
 463 #define IF_QFULL(ifq)           ((ifq)->ifq_len >= (ifq)->ifq_maxlen)
 464 #define IF_DROP(ifq)            ((ifq)->ifq_drops++)
 465 #define IF_QLEN(ifq)            ((ifq)->ifq_len)
 466 #define IF_QEMPTY(ifq)          (IF_QLEN(ifq) == 0)
 467
 468 #define IF_ENQUEUE(ifq, m) do {                                         \
 469         (m)->m_nextpkt = NULL;                                          \
 470         if ((ifq)->ifq_tail == NULL)                                    \
 471                 (ifq)->ifq_head = m;                                    \
 472         else                                                            \
 473                 (ifq)->ifq_tail->m_nextpkt = m;                         \
 474         (ifq)->ifq_tail = m;                                            \
 475         (ifq)->ifq_len++;                                               \
 476 } while (0)
 477
 478 #define IF_PREPEND(ifq, m) do {                                         \
 479         (m)->m_nextpkt = (ifq)->ifq_head;                               \
 480         if ((ifq)->ifq_tail == NULL)                                    \
 481                 (ifq)->ifq_tail = (m);                                  \
 482         (ifq)->ifq_head = (m);                                          \
 483         (ifq)->ifq_len++;                                               \
 484 } while (0)
 485
 486 #define IF_DEQUEUE(ifq, m) do {                                         \
 487         (m) = (ifq)->ifq_head;                                          \
 488         if (m) {                                                        \
 489                 if (((ifq)->ifq_head = (m)->m_nextpkt) == NULL)         \
 490                         (ifq)->ifq_tail = NULL;                         \
 491                 (m)->m_nextpkt = NULL;                                  \
 492                 (ifq)->ifq_len--;                                       \
 493         }                                                               \
 494 } while (0)
 495
 496 #define IF_POLL(ifq, m)         ((m) = (ifq)->ifq_head)
 497
 498 #define IF_DRAIN(ifq) do {                                              \
 499         struct mbuf *m;                                                 \
 500         while (1) {                                                     \
 501                 IF_DEQUEUE(ifq, m);                                     \
 502                 if (m == NULL)                                          \
 503                         break;                                          \
 504                 m_freem(m);                                             \
 505         }                                                               \
 506 } while (0)
 507
 508 #ifdef _KERNEL
 509
 510 /* interface link layer address change event */
 511 typedef void (*iflladdr_event_handler_t)(void *, struct ifnet *);
 512 EVENTHANDLER_DECLARE(iflladdr_event, iflladdr_event_handler_t);
 513
 514 #ifdef INVARIANTS
 515 #define ASSERT_IFNET_SERIALIZED_ALL(ifp) \
 516         (ifp)->if_serialize_assert((ifp), IFNET_SERIALIZE_ALL, TRUE)
 517 #define ASSERT_IFNET_NOT_SERIALIZED_ALL(ifp) \
 518         (ifp)->if_serialize_assert((ifp), IFNET_SERIALIZE_ALL, FALSE)
 519 #else
 520 #define ASSERT_IFNET_SERIALIZED_ALL(ifp)        ((void)0)
 521 #define ASSERT_IFNET_NOT_SERIALIZED_ALL(ifp)    ((void)0)
 522 #endif
 523
 524 static __inline void
 525 ifnet_serialize_all(struct ifnet *_ifp)
 526 {
 527         _ifp->if_serialize(_ifp, IFNET_SERIALIZE_ALL);
 528 }
 529
 530 static __inline void
 531 ifnet_deserialize_all(struct ifnet *_ifp)
 532 {
 533         _ifp->if_deserialize(_ifp, IFNET_SERIALIZE_ALL);
 534 }
 535
 536 static __inline int
 537 ifnet_tryserialize_all(struct ifnet *_ifp)
 538 {
 539         return _ifp->if_tryserialize(_ifp, IFNET_SERIALIZE_ALL);
 540 }
 541
 542 /*
 543  * 72 was chosen below because it is the size of a TCP/IP
 544  * header (40) + the minimum mss (32).
 545  */
 546 #define IF_MINMTU       72
 547 #define IF_MAXMTU       65535
 548
 549 #endif /* _KERNEL */
 550
 551 struct in_ifaddr;
 552
 553 struct in_ifaddr_container {
 554         struct in_ifaddr        *ia;
 555         LIST_ENTRY(in_ifaddr_container) ia_hash;
 556                                 /* entry in bucket of inet addresses */
 557         TAILQ_ENTRY(in_ifaddr_container) ia_link;
 558                                 /* list of internet addresses */
 559         struct ifaddr_container *ia_ifac; /* parent ifaddr_container */
 560 };
 561
 562 /*
 563  * Per-cpu ifaddr container:
 564  * - per-cpu ifaddr reference count
 565  * - linkage to per-cpu addresses lists
 566  * - per-cpu ifaddr statistics
 567  */
 568 struct ifaddr_container {
 569 #define IFA_CONTAINER_MAGIC     0x19810219
 570 #define IFA_CONTAINER_DEAD      0xc0dedead
 571         uint32_t                ifa_magic;  /* IFA_CONTAINER_MAGIC */
 572         struct ifaddr           *ifa;
 573         TAILQ_ENTRY(ifaddr_container)   ifa_link;   /* queue macro glue */
 574         u_int                   ifa_refcnt; /* references to this structure */
 575         uint16_t                ifa_listmask;   /* IFA_LIST_ */
 576         uint16_t                ifa_prflags;    /* protocol specific flags */
 577
 578         u_long                  ifa_ipackets;   /* packets received on addr */
 579         u_long                  ifa_ibytes;     /* bytes received on addr */
 580         u_long                  ifa_opackets;   /* packets sent on addr */
 581         u_long                  ifa_obytes;     /* bytes sent on addr */
 582
 583         /*
 584          * Protocol specific states
 585          */
 586         union {
 587                 struct in_ifaddr_container u_in_ifac;
 588         } ifa_proto_u;
 589 } __cachealign;
 590
 591 #define IFA_LIST_IFADDRHEAD     0x01    /* on ifnet.if_addrheads[cpuid] */
 592 #define IFA_LIST_IN_IFADDRHEAD  0x02    /* on in_ifaddrheads[cpuid] */
 593 #define IFA_LIST_IN_IFADDRHASH  0x04    /* on in_ifaddrhashtbls[cpuid] */
 594
 595 #define IFA_PRF_FLAG0           0x01
 596 #define IFA_PRF_FLAG1           0x02
 597 #define IFA_PRF_FLAG2           0x04
 598 #define IFA_PRF_FLAG3           0x08
 599
 600 /*
 601  * The ifaddr structure contains information about one address
 602  * of an interface.  They are maintained by the different address families,
 603  * are allocated and attached when an address is set, and are linked
 604  * together so all addresses for an interface can be located.
 605  *
 606  * NOTE:
 607  * Statistics are no longer stored in if_data, instead, they are stored
 608  * in the per-cpu ifaddr_container.  So don't use the old style
 609  * ifa->if_ipackets++ to update statistics, use IFA_STAT_ macros.
 610  */
 611 struct ifaddr {
 612         struct  sockaddr *ifa_addr;     /* address of interface */
 613         struct  sockaddr *ifa_dstaddr;  /* other end of p-to-p link */
 614 #define ifa_broadaddr   ifa_dstaddr     /* broadcast address interface */
 615         struct  sockaddr *ifa_netmask;  /* used to determine subnet */
 616         struct  if_data if_data;        /* not all members are meaningful */
 617         struct  ifnet *ifa_ifp;         /* back-pointer to interface */
 618         void    *ifa_link_pad;
 619         struct ifaddr_container *ifa_containers; /* per-cpu data */
 620         void    (*ifa_rtrequest)        /* check or clean routes (+ or -)'d */
 621                 (int, struct rtentry *);
 622         u_short ifa_flags;              /* mostly rt_flags for cloning */
 623         int     ifa_ncnt;               /* # of valid ifaddr_container */
 624         int     ifa_metric;             /* cost of going out this interface */
 625 #ifdef notdef
 626         struct  rtentry *ifa_rt;        /* XXXX for ROUTETOIF ????? */
 627 #endif
 628         int (*ifa_claim_addr)           /* check if an addr goes to this if */
 629                 (struct ifaddr *, struct sockaddr *);
 630
 631 };
 632 #define IFA_ROUTE       RTF_UP          /* route installed */
 633
 634 /* for compatibility with other BSDs */
 635 #define ifa_list        ifa_link
 636
 637 /*
 638  * Multicast address structure.  This is analogous to the ifaddr
 639  * structure except that it keeps track of multicast addresses.
 640  * Also, the reference count here is a count of requests for this
 641  * address, not a count of pointers to this structure.
 642  */
 643 struct ifmultiaddr {
 644         TAILQ_ENTRY(ifmultiaddr) ifma_link; /* queue macro glue */
 645         struct  sockaddr *ifma_addr;    /* address this membership is for */
 646         struct  sockaddr *ifma_lladdr;  /* link-layer translation, if any */
 647         struct  ifnet *ifma_ifp;        /* back-pointer to interface */
 648         u_int   ifma_refcount;          /* reference count */
 649         void    *ifma_protospec;        /* protocol-specific state, if any */
 650 };
 651
 652 #ifdef _KERNEL
 653
 654 struct ifaddr_marker {
 655         struct ifaddr           ifa;
 656         struct ifaddr_container ifac;
 657         struct sockaddr         addr;
 658         struct sockaddr         netmask;
 659         struct sockaddr         dstaddr;
 660 };
 661
 662 /*
 663  * ifaddr statistics update macro
 664  */
 665 #define IFA_STAT_INC(ifa, name, v) \
 666 do { \
 667         (ifa)->ifa_containers[mycpuid].ifa_##name += (v); \
 668 } while (0)
 669
 670 /*
 671  * Interface (ifnet) statistics update macros
 672  */
 673 #define IFNET_STAT_INC(ifp, name, v) \
 674 do { \
 675         (ifp)->if_data_pcpu[mycpuid].ifd_##name += (v); \
 676 } while (0)
 677
 678 #define IFNET_STAT_SET(ifp, name, v) \
 679 do { \
 680         int _cpu; \
 681         (ifp)->if_data_pcpu[0].ifd_##name = (v); \
 682         for (_cpu = 1; _cpu < ncpus; ++_cpu) \
 683                 (ifp)->if_data_pcpu[_cpu].ifd_##name = 0; \
 684 } while (0)
 685
 686 #define IFNET_STAT_GET(ifp, name, v) \
 687 do { \
 688         int _cpu; \
 689         (v) = (ifp)->if_data_pcpu[0].ifd_##name; \
 690         for (_cpu = 1; _cpu < ncpus; ++_cpu) \
 691                 (v) += (ifp)->if_data_pcpu[_cpu].ifd_##name; \
 692 } while (0)
 693
 694 #ifndef _SYS_SERIALIZE2_H_
 695 #include <sys/serialize2.h>
 696 #endif
 697
 698 enum ifaddr_event {
 699         IFADDR_EVENT_ADD,
 700         IFADDR_EVENT_DELETE,
 701         IFADDR_EVENT_CHANGE
 702 };
 703
 704 /* interface address change event */
 705 typedef void (*ifaddr_event_handler_t)(void *, struct ifnet *,
 706         enum ifaddr_event, struct ifaddr *);
 707 EVENTHANDLER_DECLARE(ifaddr_event, ifaddr_event_handler_t);
 708 /* new interface attach event */
 709 typedef void (*ifnet_attach_event_handler_t)(void *, struct ifnet *);
 710 EVENTHANDLER_DECLARE(ifnet_attach_event, ifnet_attach_event_handler_t);
 711 /* interface detach event */
 712 typedef void (*ifnet_detach_event_handler_t)(void *, struct ifnet *);
 713 EVENTHANDLER_DECLARE(ifnet_detach_event, ifnet_detach_event_handler_t);
 714
 715 /* Array of all ifnets in the system */
 716 struct ifnet_array {
 717         int             ifnet_count;    /* # of elem. in ifnet_arr */
 718         int             ifnet_pad;      /* explicit */
 719         struct ifnet    *ifnet_arr[];
 720 };
 721
 722 /*
 723  * interface groups
 724  */
 725 struct ifg_group {
 726         char                             ifg_group[IFNAMSIZ];
 727         u_int                            ifg_refcnt;
 728         void                            *ifg_pf_kif;
 729         int                              ifg_carp_demoted;
 730         TAILQ_HEAD(, ifg_member)         ifg_members;
 731         TAILQ_ENTRY(ifg_group)           ifg_next;
 732 };
 733
 734 struct ifg_member {
 735         TAILQ_ENTRY(ifg_member)  ifgm_next;
 736         struct ifnet            *ifgm_ifp;
 737 };
 738
 739 struct ifg_list {
 740         struct ifg_group        *ifgl_group;
 741         TAILQ_ENTRY(ifg_list)    ifgl_next;
 742 };
 743
 744 /* group attach event */
 745 typedef void (*group_attach_event_handler_t)(void *, struct ifg_group *);
 746 EVENTHANDLER_DECLARE(group_attach_event, group_attach_event_handler_t);
 747 /* group detach event */
 748 typedef void (*group_detach_event_handler_t)(void *, struct ifg_group *);
 749 EVENTHANDLER_DECLARE(group_detach_event, group_detach_event_handler_t);
 750 /* group change event */
 751 typedef void (*group_change_event_handler_t)(void *, const char *);
 752 EVENTHANDLER_DECLARE(group_change_event, group_change_event_handler_t);
 753
 754
 755 #ifdef INVARIANTS
 756 #define ASSERT_IFAC_VALID(ifac) do { \
 757         KKASSERT((ifac)->ifa_magic == IFA_CONTAINER_MAGIC); \
 758         KKASSERT((ifac)->ifa_refcnt > 0); \
 759 } while (0)
 760 #else
 761 #define ASSERT_IFAC_VALID(ifac) ((void)0)
 762 #endif
 763
 764 static __inline void
 765 _IFAREF(struct ifaddr *_ifa, int _cpu_id)
 766 {
 767         struct ifaddr_container *_ifac = &_ifa->ifa_containers[_cpu_id];
 768
 769         crit_enter();
 770         ASSERT_IFAC_VALID(_ifac);
 771         ++_ifac->ifa_refcnt;
 772         crit_exit();
 773 }
 774
 775 static __inline void
 776 IFAREF(struct ifaddr *_ifa)
 777 {
 778         _IFAREF(_ifa, mycpuid);
 779 }
 780
 781 #include <sys/malloc.h>
 782
 783 MALLOC_DECLARE(M_IFADDR);
 784 MALLOC_DECLARE(M_IFMADDR);
 785 MALLOC_DECLARE(M_IFNET);
 786
 787 void    ifac_free(struct ifaddr_container *, int);
 788
 789 static __inline void
 790 _IFAFREE(struct ifaddr *_ifa, int _cpu_id)
 791 {
 792         struct ifaddr_container *_ifac = &_ifa->ifa_containers[_cpu_id];
 793
 794         crit_enter();
 795         ASSERT_IFAC_VALID(_ifac);
 796         if (--_ifac->ifa_refcnt == 0)
 797                 ifac_free(_ifac, _cpu_id);
 798         crit_exit();
 799 }
 800
 801 static __inline void
 802 IFAFREE(struct ifaddr *_ifa)
 803 {
 804         _IFAFREE(_ifa, mycpuid);
 805 }
 806
 807 static __inline void
 808 ifnet_serialize_array_enter(lwkt_serialize_t *_arr, int _arrcnt,
 809     enum ifnet_serialize _slz)
 810 {
 811         KKASSERT(_slz == IFNET_SERIALIZE_ALL);
 812         lwkt_serialize_array_enter(_arr, _arrcnt, 0);
 813 }
 814
 815 static __inline void
 816 ifnet_serialize_array_exit(lwkt_serialize_t *_arr, int _arrcnt,
 817     enum ifnet_serialize _slz)
 818 {
 819         KKASSERT(_slz == IFNET_SERIALIZE_ALL);
 820         lwkt_serialize_array_exit(_arr, _arrcnt, 0);
 821 }
 822
 823 static __inline int
 824 ifnet_serialize_array_try(lwkt_serialize_t *_arr, int _arrcnt,
 825     enum ifnet_serialize _slz)
 826 {
 827         KKASSERT(_slz == IFNET_SERIALIZE_ALL);
 828         return lwkt_serialize_array_try(_arr, _arrcnt, 0);
 829 }
 830
 831 #ifdef INVARIANTS
 832
 833 static __inline void
 834 ifnet_serialize_array_assert(lwkt_serialize_t *_arr, int _arrcnt,
 835     enum ifnet_serialize _slz, boolean_t _serialized)
 836 {
 837         int _i;
 838
 839         KKASSERT(_slz == IFNET_SERIALIZE_ALL);
 840         if (_serialized) {
 841                 for (_i = 0; _i < _arrcnt; ++_i)
 842                         ASSERT_SERIALIZED(_arr[_i]);
 843         } else {
 844                 for (_i = 0; _i < _arrcnt; ++_i)
 845                         ASSERT_NOT_SERIALIZED(_arr[_i]);
 846         }
 847 }
 848
 849 #endif  /* INVARIANTS */
 850
 851 #define REINPUT_KEEPRCVIF       0x0001  /* ether_reinput_oncpu() */
 852 #define REINPUT_RUNBPF          0x0002  /* ether_reinput_oncpu() */
 853
 854 /*
 855  * MPSAFE NOTE for ifnet queue (ifnet), ifnet array, ifunit() and
 856  * ifindex2ifnet.
 857  *
 858  * - ifnet queue must only be accessed by non-netisr threads and
 859  *   ifnet lock must be held (by ifnet_lock()).
 860  * - If accessing ifnet queue is needed in netisrs, ifnet array
 861  *   (obtained through ifnet_array_get()) must be used instead.
 862  *   There is no need to (must not, actually) hold ifnet lock for
 863  *   ifnet array accessing.
 864  * - ifindex2ifnet could be accessed by both non-netisr threads and
 865  *   netisrs.  Accessing ifindex2ifnet in non-netisr threads must be
 866  *   protected by ifnet lock (by ifnet_lock()).  Accessing
 867  *   ifindex2ifnet in netisrs is lockless MPSAFE and ifnet lock must
 868  *   not be held.  However, ifindex2ifnet should be saved in a stack
 869  *   variable to get a consistent view of ifindex2ifnet, if
 870  *   ifindex2ifnet is accessed multiple times from a function in
 871  *   netisrs.
 872  * - ifunit() must only be called in non-netisr threads and ifnet
 873  *   lock must be held before calling this function and for the
 874  *   accessing of the ifp returned by this function.
 875  * - If ifunit() is needed in netisr, ifunit_netisr() must be used
 876  *   instead.  There is no need to (must not, actually) hold ifnet
 877  *   lock for ifunit_netisr() and the returned ifp.
 878  */
 879 extern struct ifnethead ifnet;
 880 #define ifnetlist       ifnet   /* easily distinguished ifnet alias */
 881
 882 extern struct ifnet     **ifindex2ifnet;
 883 extern int              if_index;
 884
 885 struct ifnet            *ifunit(const char *);
 886 struct ifnet            *ifunit_netisr(const char *);
 887 const struct ifnet_array *ifnet_array_get(void);
 888 int                     ifnet_array_isempty(void);
 889
 890 extern  int ifqmaxlen;
 891 extern  struct ifnet *loif;
 892
 893 struct ip;
 894 struct tcphdr;
 895
 896 void    ether_ifattach(struct ifnet *, const uint8_t *,
 897             struct lwkt_serialize *);
 898 void    ether_ifattach_bpf(struct ifnet *, const uint8_t *, u_int, u_int,
 899             struct lwkt_serialize *);
 900 void    ether_ifdetach(struct ifnet *);
 901 void    ether_demux(struct mbuf *);
 902 void    ether_demux_oncpu(struct ifnet *, struct mbuf *);
 903 void    ether_reinput_oncpu(struct ifnet *, struct mbuf *, int);
 904 void    ether_input(struct ifnet *, struct mbuf *,
 905             const struct pktinfo *, int);
 906 int     ether_output_frame(struct ifnet *, struct mbuf *);
 907 int     ether_ioctl(struct ifnet *, u_long, caddr_t);
 908 u_char  *kether_aton(const char *, u_char *);
 909 char    *kether_ntoa(const u_char *, char *);
 910 struct ifnet *ether_bridge_interface(struct ifnet *ifp);
 911 uint32_t        ether_crc32_le(const uint8_t *, size_t);
 912 uint32_t        ether_crc32_be(const uint8_t *, size_t);
 913
 914 int     if_addmulti(struct ifnet *, struct sockaddr *, struct ifmultiaddr **);
 915 int     if_addmulti_serialized(struct ifnet *, struct sockaddr *,
 916             struct ifmultiaddr **);
 917 int     if_allmulti(struct ifnet *, int);
 918 void    if_attach(struct ifnet *, struct lwkt_serialize *);
 919 int     if_delmulti(struct ifnet *, struct sockaddr *);
 920 void    if_delallmulti_serialized(struct ifnet *ifp);
 921 void    if_purgeaddrs_nolink(struct ifnet *);
 922 void    if_detach(struct ifnet *);
 923 void    if_down(struct ifnet *);
 924 void    if_link_state_change(struct ifnet *);
 925 void    if_initname(struct ifnet *, const char *, int);
 926 int     if_getanyethermac(uint16_t *, int);
 927 int     if_printf(struct ifnet *, const char *, ...) __printflike(2, 3);
 928 struct ifnet *if_alloc(uint8_t);
 929 void    if_free(struct ifnet *);
 930 void    if_route(struct ifnet *, int flag, int fam);
 931 int     if_setlladdr(struct ifnet *, const u_char *, int);
 932 void    if_unroute(struct ifnet *, int flag, int fam);
 933 void    if_up(struct ifnet *);
 934 /*void  ifinit(void);*/ /* declared in systm.h for main() */
 935 int     ifioctl(struct socket *, u_long, caddr_t, struct ucred *);
 936 int     ifpromisc(struct ifnet *, int);
 937
 938 struct  ifg_group *if_creategroup(const char *);
 939 int     if_addgroup(struct ifnet *, const char *);
 940 int     if_delgroup(struct ifnet *, const char *);
 941 int     if_getgroup(caddr_t, struct ifnet *);
 942 int     if_getgroupmembers(caddr_t);
 943
 944 struct  ifaddr *ifa_ifwithaddr(struct sockaddr *);
 945 struct  ifaddr *ifa_ifwithdstaddr(struct sockaddr *);
 946 struct  ifaddr *ifa_ifwithnet(struct sockaddr *);
 947 struct  ifaddr *ifa_ifwithroute(int, struct sockaddr *, struct sockaddr *);
 948 struct  ifaddr *ifaof_ifpforaddr(struct sockaddr *, struct ifnet *);
 949
 950 typedef void *if_com_alloc_t(u_char type, struct ifnet *ifp);
 951 typedef void if_com_free_t(void *com, u_char type);
 952 void    if_register_com_alloc(u_char, if_com_alloc_t *a, if_com_free_t *);
 953 void    if_deregister_com_alloc(u_char);
 954
 955 void    *ifa_create(int);
 956 void    ifa_destroy(struct ifaddr *);
 957 void    ifa_iflink(struct ifaddr *, struct ifnet *, int);
 958 void    ifa_ifunlink(struct ifaddr *, struct ifnet *);
 959 void    ifa_marker_init(struct ifaddr_marker *, struct ifnet *);
 960
 961 struct  ifmultiaddr *ifmaof_ifpforaddr(struct sockaddr *, struct ifnet *);
 962 int     if_simloop(struct ifnet *ifp, struct mbuf *m, int af, int hlen);
 963 void    if_devstart(struct ifnet *ifp); /* COMPAT */
 964 void    if_devstart_sched(struct ifnet *ifp); /* COMPAT */
 965
 966 void    ifnet_lock(void);
 967 void    ifnet_unlock(void);
 968
 969 #define IF_LLSOCKADDR(ifp)                                              \
 970     ((struct sockaddr_dl *)(ifp)->if_lladdr->ifa_addr)
 971 #define IF_LLADDR(ifp)  LLADDR(IF_LLSOCKADDR(ifp))
 972
 973 #ifdef IFPOLL_ENABLE
 974 int     ifpoll_register(struct ifnet *);
 975 int     ifpoll_deregister(struct ifnet *);
 976 #endif  /* IFPOLL_ENABLE */
 977
 978 #endif /* _KERNEL */
 979
 980 #endif /* !_NET_IF_VAR_H_ */