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. 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  *      From: @(#)if.h  8.1 (Berkeley) 6/10/93
  34  * $FreeBSD: src/sys/net/if_var.h,v 1.18.2.16 2003/04/15 18:11:19 fjoe Exp $
  35  */
  36
  37 #ifndef _NET_IF_VAR_H_
  38 #define _NET_IF_VAR_H_
  39
  40 #ifndef _SYS_SERIALIZE_H_
  41 #include <sys/serialize.h>
  42 #endif
  43 #ifndef _NET_IF_H_
  44 #include <net/if.h>
  45 #endif
  46 #ifndef _SYS_MUTEX_H_
  47 #include <sys/mutex.h>
  48 #endif
  49
  50 /*
  51  * Structures defining a network interface, providing a packet
  52  * transport mechanism (ala level 0 of the PUP protocols).
  53  *
  54  * Each interface accepts output datagrams of a specified maximum
  55  * length, and provides higher level routines with input datagrams
  56  * received from its medium.
  57  *
  58  * Output occurs when the routine if_output is called, with four parameters:
  59  *      ifp->if_output(ifp, m, dst, rt)
  60  * Here m is the mbuf chain to be sent and dst is the destination address.
  61  * The output routine encapsulates the supplied datagram if necessary,
  62  * and then transmits it on its medium.
  63  *
  64  * On input, each interface unwraps the data received by it, and either
  65  * places it on the input queue of a internetwork datagram routine
  66  * and posts the associated software interrupt, or passes the datagram to
  67  * the routine if_input. It is called with the mbuf chain as parameter:
  68  *      ifp->if_input(ifp, m)
  69  * The input routine removes the protocol dependent header if necessary.
  70  *
  71  * Routines exist for locating interfaces by their addresses
  72  * or for locating a interface on a certain network, as well as more general
  73  * routing and gateway routines maintaining information used to locate
  74  * interfaces.  These routines live in the files if.c and route.c
  75  */
  76
  77 /*
  78  * Forward structure declarations for function prototypes [sic].
  79  */
  80 struct  mbuf;
  81 struct  proc;
  82 struct  rtentry;
  83 struct  rt_addrinfo;
  84 struct  socket;
  85 struct  ether_header;
  86 struct  ucred;
  87 struct  lwkt_serialize;
  88 struct  ifaddr_container;
  89 struct  ifaddr;
  90 struct  lwkt_port;
  91 struct  lwkt_msg;
  92 union   netmsg;
  93 struct  pktinfo;
  94 struct  ifpoll_info;
  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/systm.h>          /* XXX */
 104 #include <sys/thread2.h>
 105 #endif /* _KERNEL */
 106
 107 #define IF_DUNIT_NONE   -1
 108
 109 TAILQ_HEAD(ifnethead, ifnet);   /* we use TAILQs so that the order of */
 110 TAILQ_HEAD(ifaddrhead, ifaddr_container); /* instantiation is preserved in the list */
 111 TAILQ_HEAD(ifprefixhead, ifprefix);
 112 TAILQ_HEAD(ifmultihead, ifmultiaddr);
 113
 114 /*
 115  * Structure defining a queue for a network interface.
 116  */
 117 struct  ifqueue {
 118         struct  mbuf *ifq_head;
 119         struct  mbuf *ifq_tail;
 120         int     ifq_len;
 121         int     ifq_maxlen;
 122         int     ifq_drops;
 123 };
 124
 125 /*
 126  * Note of IFPOLL_ENABLE
 127  * 1) Any file(*.c) that depends on IFPOLL_ENABLE supports in this
 128  *    file should include opt_ifpoll.h at its beginning.
 129  * 2) When struct changes, which are conditioned by IFPOLL_ENABLE,
 130  *    are to be introduced, please keep the struct's size and layout
 131  *    same, no matter whether IFPOLL_ENABLE is defined or not.
 132  *    See ifnet.if_npoll and ifnet.if_npoll_unused for example.
 133  */
 134
 135 enum ifnet_serialize {
 136         IFNET_SERIALIZE_ALL,
 137         IFNET_SERIALIZE_MAIN,
 138         IFNET_SERIALIZE_TX_BASE = 0x10000000,
 139         IFNET_SERIALIZE_RX_BASE = 0x20000000
 140 };
 141 #define IFNET_SERIALIZE_TX(i)   (IFNET_SERIALIZE_TX_BASE + (i))
 142 #define IFNET_SERIALIZE_RX(i)   (IFNET_SERIALIZE_RX_BASE + (i))
 143
 144 #if defined(_KERNEL) || defined(_KERNEL_STRUCTURES)
 145
 146 /*
 147  * Structure defining a network interface.
 148  *
 149  * (Would like to call this struct ``if'', but C isn't PL/1.)
 150  */
 151
 152 /*
 153  * NB: For FreeBSD, it is assumed that each NIC driver's softc starts with
 154  * one of these structures, typically held within an arpcom structure.
 155  *
 156  *      struct <foo>_softc {
 157  *              struct arpcom {
 158  *                      struct  ifnet ac_if;
 159  *                      ...
 160  *              } <arpcom> ;
 161  *              ...
 162  *      };
 163  *
 164  * The assumption is used in a number of places, including many
 165  * files in sys/net, device drivers, and sys/dev/mii.c:miibus_attach().
 166  *
 167  * Unfortunately devices' softc are opaque, so we depend on this layout
 168  * to locate the struct ifnet from the softc in the generic code.
 169  *
 170  * MPSAFE NOTES:
 171  *
 172  * ifnet is protected by calling if_serialize, if_tryserialize and
 173  * if_deserialize serialize functions with the ifnet_serialize parameter.
 174  * ifnet.if_snd is protected by its own spinlock.  Callers of if_ioctl,
 175  * if_watchdog, if_init, if_resolvemulti, and if_poll should call the
 176  * ifnet serialize functions with IFNET_SERIALIZE_ALL.  Callers of if_start
 177  * sould call the ifnet serialize functions with IFNET_SERIALIZE_TX.
 178  *
 179  * FIXME: Device drivers usually use the same serializer for their interrupt
 180  * FIXME: but this is not required.
 181  *
 182  * Caller of if_output must not serialize ifnet by calling ifnet serialize
 183  * functions; if_output will call the ifnet serialize functions based on
 184  * its own needs.  Caller of if_input does not necessarily hold the related
 185  * serializer.
 186  *
 187  * If a device driver installs the same serializer for its interrupt
 188  * as for ifnet, then the driver only really needs to worry about further
 189  * serialization in timeout based entry points.  All other entry points
 190  * will already be serialized.  Older ISA drivers still using the old
 191  * interrupt infrastructure will have to obtain and release the serializer
 192  * in their interrupt routine themselves.
 193  */
 194 struct ifnet {
 195         void    *if_softc;              /* pointer to driver state */
 196         void    *if_l2com;              /* pointer to protocol bits */
 197         TAILQ_ENTRY(ifnet) if_link;     /* all struct ifnets are chained */
 198         char    if_xname[IFNAMSIZ];     /* external name (name + unit) */
 199         const char *if_dname;           /* driver name */
 200         int     if_dunit;               /* unit or IF_DUNIT_NONE */
 201         void    *if_vlantrunks;         /* vlan trunks */
 202         struct  ifaddrhead *if_addrheads; /* array[NCPU] of TAILQs of addresses per if */
 203         int     if_pcount;              /* number of promiscuous listeners */
 204         void    *if_carp;               /* carp interfaces */
 205         struct  bpf_if *if_bpf;         /* packet filter structure */
 206         u_short if_index;               /* numeric abbreviation for this if  */
 207         short   if_timer;               /* time 'til if_watchdog called */
 208         int     if_flags;               /* up/down, broadcast, etc. */
 209         int     if_capabilities;        /* interface capabilities */
 210         int     if_capenable;           /* enabled features */
 211         void    *if_linkmib;            /* link-type-specific MIB data */
 212         size_t  if_linkmiblen;          /* length of above data */
 213         struct  if_data if_data;
 214         struct  ifmultihead if_multiaddrs; /* multicast addresses configured */
 215         int     if_amcount;             /* number of all-multicast requests */
 216 /* procedure handles */
 217         int     (*if_output)            /* output routine (enqueue) */
 218                 (struct ifnet *, struct mbuf *, struct sockaddr *,
 219                      struct rtentry *);
 220         void    (*if_input)             /* input routine from hardware driver */
 221                 (struct ifnet *, struct mbuf *);
 222         void    (*if_start)             /* initiate output routine */
 223                 (struct ifnet *, struct ifaltq_subque *);
 224         int     (*if_ioctl)             /* ioctl routine */
 225                 (struct ifnet *, u_long, caddr_t, struct ucred *);
 226         void    (*if_watchdog)          /* timer routine */
 227                 (struct ifnet *);
 228         void    (*if_init)              /* Init routine */
 229                 (void *);
 230         int     (*if_resolvemulti)      /* validate/resolve multicast */
 231                 (struct ifnet *, struct sockaddr **, struct sockaddr *);
 232         void    *if_unused5;
 233         TAILQ_HEAD(, ifg_list) if_groups; /* linked list of groups per if */
 234         void    (*if_unused1)(void);
 235         int     if_unused2;
 236         void    (*if_serialize)
 237                 (struct ifnet *, enum ifnet_serialize);
 238         void    (*if_deserialize)
 239                 (struct ifnet *, enum ifnet_serialize);
 240         int     (*if_tryserialize)
 241                 (struct ifnet *, enum ifnet_serialize);
 242 #ifdef INVARIANTS
 243         void    (*if_serialize_assert)
 244                 (struct ifnet *, enum ifnet_serialize, boolean_t);
 245 #else
 246         /* Place holder */
 247         void    (*if_serialize_unused)(void);
 248 #endif
 249 #ifdef IFPOLL_ENABLE
 250         void    (*if_npoll)
 251                 (struct ifnet *, struct ifpoll_info *);
 252 #else
 253         /* Place holder */
 254         void    (*if_npoll_unused)(void);
 255 #endif
 256         int     if_unused3;
 257         struct  ifaltq if_snd;          /* output queue (includes altq) */
 258         struct  ifprefixhead if_prefixhead; /* list of prefixes per if */
 259         const uint8_t   *if_broadcastaddr;
 260         void    *if_bridge;             /* bridge glue */
 261         void    *if_afdata[AF_MAX];
 262         struct ifaddr   *if_lladdr;
 263         struct lwkt_serialize *if_serializer;   /* serializer or MP lock */
 264         struct lwkt_serialize if_default_serializer; /* if not supplied */
 265         struct mtx      if_ioctl_mtx;   /* high-level ioctl serializing mutex */
 266         int     if_unused4;
 267         void    *if_unused6;
 268         void    *if_pf_kif; /* pf interface abstraction */
 269         void    *if_unused7;
 270 };
 271 typedef void if_init_f_t (void *);
 272
 273 #define if_mtu          if_data.ifi_mtu
 274 #define if_type         if_data.ifi_type
 275 #define if_physical     if_data.ifi_physical
 276 #define if_addrlen      if_data.ifi_addrlen
 277 #define if_hdrlen       if_data.ifi_hdrlen
 278 #define if_metric       if_data.ifi_metric
 279 #define if_link_state   if_data.ifi_link_state
 280 #define if_baudrate     if_data.ifi_baudrate
 281 #define if_hwassist     if_data.ifi_hwassist
 282 #define if_ipackets     if_data.ifi_ipackets
 283 #define if_ierrors      if_data.ifi_ierrors
 284 #define if_opackets     if_data.ifi_opackets
 285 #define if_oerrors      if_data.ifi_oerrors
 286 #define if_collisions   if_data.ifi_collisions
 287 #define if_ibytes       if_data.ifi_ibytes
 288 #define if_obytes       if_data.ifi_obytes
 289 #define if_imcasts      if_data.ifi_imcasts
 290 #define if_omcasts      if_data.ifi_omcasts
 291 #define if_iqdrops      if_data.ifi_iqdrops
 292 #define if_noproto      if_data.ifi_noproto
 293 #define if_lastchange   if_data.ifi_lastchange
 294 #define if_recvquota    if_data.ifi_recvquota
 295 #define if_xmitquota    if_data.ifi_xmitquota
 296 #define if_rawoutput(if, m, sa) if_output(if, m, sa, NULL)
 297
 298 /* for compatibility with other BSDs */
 299 #define if_list         if_link
 300
 301 #endif
 302
 303 /*
 304  * Device private output queues and input queues are queues of messages
 305  * stored on ifqueue structures (defined above).  Entries are added to
 306  * and deleted from these structures by these macros.
 307  */
 308 #define IF_QFULL(ifq)           ((ifq)->ifq_len >= (ifq)->ifq_maxlen)
 309 #define IF_DROP(ifq)            ((ifq)->ifq_drops++)
 310 #define IF_QLEN(ifq)            ((ifq)->ifq_len)
 311 #define IF_QEMPTY(ifq)          (IF_QLEN(ifq) == 0)
 312
 313 #define IF_ENQUEUE(ifq, m) do {                                         \
 314         (m)->m_nextpkt = NULL;                                          \
 315         if ((ifq)->ifq_tail == NULL)                                    \
 316                 (ifq)->ifq_head = m;                                    \
 317         else                                                            \
 318                 (ifq)->ifq_tail->m_nextpkt = m;                         \
 319         (ifq)->ifq_tail = m;                                            \
 320         (ifq)->ifq_len++;                                               \
 321 } while (0)
 322
 323 #define IF_PREPEND(ifq, m) do {                                         \
 324         (m)->m_nextpkt = (ifq)->ifq_head;                               \
 325         if ((ifq)->ifq_tail == NULL)                                    \
 326                 (ifq)->ifq_tail = (m);                                  \
 327         (ifq)->ifq_head = (m);                                          \
 328         (ifq)->ifq_len++;                                               \
 329 } while (0)
 330
 331 #define IF_DEQUEUE(ifq, m) do {                                         \
 332         (m) = (ifq)->ifq_head;                                          \
 333         if (m) {                                                        \
 334                 if (((ifq)->ifq_head = (m)->m_nextpkt) == NULL)         \
 335                         (ifq)->ifq_tail = NULL;                         \
 336                 (m)->m_nextpkt = NULL;                                  \
 337                 (ifq)->ifq_len--;                                       \
 338         }                                                               \
 339 } while (0)
 340
 341 #define IF_POLL(ifq, m)         ((m) = (ifq)->ifq_head)
 342
 343 #define IF_DRAIN(ifq) do {                                              \
 344         struct mbuf *m;                                                 \
 345         while (1) {                                                     \
 346                 IF_DEQUEUE(ifq, m);                                     \
 347                 if (m == NULL)                                          \
 348                         break;                                          \
 349                 m_freem(m);                                             \
 350         }                                                               \
 351 } while (0)
 352
 353 #ifdef _KERNEL
 354
 355 /* interface link layer address change event */
 356 typedef void (*iflladdr_event_handler_t)(void *, struct ifnet *);
 357 EVENTHANDLER_DECLARE(iflladdr_event, iflladdr_event_handler_t);
 358
 359 #ifdef INVARIANTS
 360 #define ASSERT_IFNET_SERIALIZED_ALL(ifp) \
 361         (ifp)->if_serialize_assert((ifp), IFNET_SERIALIZE_ALL, TRUE)
 362 #define ASSERT_IFNET_NOT_SERIALIZED_ALL(ifp) \
 363         (ifp)->if_serialize_assert((ifp), IFNET_SERIALIZE_ALL, FALSE)
 364
 365 #define ASSERT_IFNET_SERIALIZED_TX(ifp, ifsq) \
 366         (ifp)->if_serialize_assert((ifp), \
 367             IFNET_SERIALIZE_TX((ifsq)->ifsq_index), TRUE)
 368 #define ASSERT_IFNET_NOT_SERIALIZED_TX(ifp, ifsq) \
 369         (ifp)->if_serialize_assert((ifp), \
 370             IFNET_SERIALIZE_TX((ifsq)->ifsq_index), FALSE)
 371
 372 #define ASSERT_IFNET_SERIALIZED_MAIN(ifp) \
 373         (ifp)->if_serialize_assert((ifp), IFNET_SERIALIZE_MAIN, TRUE)
 374 #define ASSERT_IFNET_NOT_SERIALIZED_MAIN(ifp) \
 375         (ifp)->if_serialize_assert((ifp), IFNET_SERIALIZE_MAIN, FALSE)
 376 #else
 377 #define ASSERT_IFNET_SERIALIZED_ALL(ifp)        ((void)0)
 378 #define ASSERT_IFNET_NOT_SERIALIZED_ALL(ifp)    ((void)0)
 379 #define ASSERT_IFNET_SERIALIZED_TX(ifp, ifsq)   ((void)0)
 380 #define ASSERT_IFNET_NOT_SERIALIZED_TX(ifp, ifsq) ((void)0)
 381 #define ASSERT_IFNET_SERIALIZED_MAIN(ifp)       ((void)0)
 382 #define ASSERT_IFNET_NOT_SERIALIZED_MAIN(ifp)   ((void)0)
 383 #endif
 384
 385 static __inline void
 386 ifnet_serialize_all(struct ifnet *_ifp)
 387 {
 388         _ifp->if_serialize(_ifp, IFNET_SERIALIZE_ALL);
 389 }
 390
 391 static __inline void
 392 ifnet_deserialize_all(struct ifnet *_ifp)
 393 {
 394         _ifp->if_deserialize(_ifp, IFNET_SERIALIZE_ALL);
 395 }
 396
 397 static __inline int
 398 ifnet_tryserialize_all(struct ifnet *_ifp)
 399 {
 400         return _ifp->if_tryserialize(_ifp, IFNET_SERIALIZE_ALL);
 401 }
 402
 403 static __inline void
 404 ifnet_serialize_tx(struct ifnet *_ifp, const struct ifaltq_subque *_ifsq)
 405 {
 406         _ifp->if_serialize(_ifp, IFNET_SERIALIZE_TX(_ifsq->ifsq_index));
 407 }
 408
 409 static __inline void
 410 ifnet_deserialize_tx(struct ifnet *_ifp, const struct ifaltq_subque *_ifsq)
 411 {
 412         _ifp->if_deserialize(_ifp, IFNET_SERIALIZE_TX(_ifsq->ifsq_index));
 413 }
 414
 415 static __inline int
 416 ifnet_tryserialize_tx(struct ifnet *_ifp, const struct ifaltq_subque *_ifsq)
 417 {
 418         return _ifp->if_tryserialize(_ifp,
 419             IFNET_SERIALIZE_TX(_ifsq->ifsq_index));
 420 }
 421
 422 static __inline void
 423 ifnet_serialize_main(struct ifnet *_ifp)
 424 {
 425         _ifp->if_serialize(_ifp, IFNET_SERIALIZE_MAIN);
 426 }
 427
 428 static __inline void
 429 ifnet_deserialize_main(struct ifnet *_ifp)
 430 {
 431         _ifp->if_deserialize(_ifp, IFNET_SERIALIZE_MAIN);
 432 }
 433
 434 static __inline int
 435 ifnet_tryserialize_main(struct ifnet *_ifp)
 436 {
 437         return _ifp->if_tryserialize(_ifp, IFNET_SERIALIZE_MAIN);
 438 }
 439
 440 /*
 441  * 72 was chosen below because it is the size of a TCP/IP
 442  * header (40) + the minimum mss (32).
 443  */
 444 #define IF_MINMTU       72
 445 #define IF_MAXMTU       65535
 446
 447 #endif /* _KERNEL */
 448
 449 struct in_ifaddr;
 450
 451 struct in_ifaddr_container {
 452         struct in_ifaddr        *ia;
 453         LIST_ENTRY(in_ifaddr_container) ia_hash;
 454                                 /* entry in bucket of inet addresses */
 455         TAILQ_ENTRY(in_ifaddr_container) ia_link;
 456                                 /* list of internet addresses */
 457         struct ifaddr_container *ia_ifac; /* parent ifaddr_container */
 458 };
 459
 460 struct ifaddr_container {
 461 #define IFA_CONTAINER_MAGIC     0x19810219
 462 #define IFA_CONTAINER_DEAD      0xc0dedead
 463         uint32_t                ifa_magic;  /* IFA_CONTAINER_MAGIC */
 464         struct ifaddr           *ifa;
 465         TAILQ_ENTRY(ifaddr_container)   ifa_link;   /* queue macro glue */
 466         u_int                   ifa_refcnt; /* references to this structure */
 467         uint16_t                ifa_listmask;   /* IFA_LIST_ */
 468         uint16_t                ifa_prflags;    /* protocol specific flags */
 469
 470         /*
 471          * Protocol specific states
 472          */
 473         union {
 474                 struct in_ifaddr_container u_in_ifac;
 475         } ifa_proto_u;
 476 };
 477
 478 #define IFA_LIST_IFADDRHEAD     0x01    /* on ifnet.if_addrheads[cpuid] */
 479 #define IFA_LIST_IN_IFADDRHEAD  0x02    /* on in_ifaddrheads[cpuid] */
 480 #define IFA_LIST_IN_IFADDRHASH  0x04    /* on in_ifaddrhashtbls[cpuid] */
 481
 482 #define IFA_PRF_FLAG0           0x01
 483 #define IFA_PRF_FLAG1           0x02
 484 #define IFA_PRF_FLAG2           0x04
 485 #define IFA_PRF_FLAG3           0x08
 486
 487 /*
 488  * The ifaddr structure contains information about one address
 489  * of an interface.  They are maintained by the different address families,
 490  * are allocated and attached when an address is set, and are linked
 491  * together so all addresses for an interface can be located.
 492  */
 493 struct ifaddr {
 494         struct  sockaddr *ifa_addr;     /* address of interface */
 495         struct  sockaddr *ifa_dstaddr;  /* other end of p-to-p link */
 496 #define ifa_broadaddr   ifa_dstaddr     /* broadcast address interface */
 497         struct  sockaddr *ifa_netmask;  /* used to determine subnet */
 498         struct  if_data if_data;        /* not all members are meaningful */
 499         struct  ifnet *ifa_ifp;         /* back-pointer to interface */
 500         void    *ifa_link_pad;
 501         struct ifaddr_container *ifa_containers;
 502         void    (*ifa_rtrequest)        /* check or clean routes (+ or -)'d */
 503                 (int, struct rtentry *, struct rt_addrinfo *);
 504         u_short ifa_flags;              /* mostly rt_flags for cloning */
 505         int     ifa_ncnt;               /* # of valid ifaddr_container */
 506         int     ifa_metric;             /* cost of going out this interface */
 507 #ifdef notdef
 508         struct  rtentry *ifa_rt;        /* XXXX for ROUTETOIF ????? */
 509 #endif
 510         int (*ifa_claim_addr)           /* check if an addr goes to this if */
 511                 (struct ifaddr *, struct sockaddr *);
 512
 513 };
 514 #define IFA_ROUTE       RTF_UP          /* route installed */
 515
 516 /* for compatibility with other BSDs */
 517 #define ifa_list        ifa_link
 518
 519 /*
 520  * The prefix structure contains information about one prefix
 521  * of an interface.  They are maintained by the different address families,
 522  * are allocated and attached when an prefix or an address is set,
 523  * and are linked together so all prefixes for an interface can be located.
 524  */
 525 struct ifprefix {
 526         struct  sockaddr *ifpr_prefix;  /* prefix of interface */
 527         struct  ifnet *ifpr_ifp;        /* back-pointer to interface */
 528         TAILQ_ENTRY(ifprefix) ifpr_list; /* queue macro glue */
 529         u_char  ifpr_plen;              /* prefix length in bits */
 530         u_char  ifpr_type;              /* protocol dependent prefix type */
 531 };
 532
 533 /*
 534  * Multicast address structure.  This is analogous to the ifaddr
 535  * structure except that it keeps track of multicast addresses.
 536  * Also, the reference count here is a count of requests for this
 537  * address, not a count of pointers to this structure.
 538  */
 539 struct ifmultiaddr {
 540         TAILQ_ENTRY(ifmultiaddr) ifma_link; /* queue macro glue */
 541         struct  sockaddr *ifma_addr;    /* address this membership is for */
 542         struct  sockaddr *ifma_lladdr;  /* link-layer translation, if any */
 543         struct  ifnet *ifma_ifp;        /* back-pointer to interface */
 544         u_int   ifma_refcount;          /* reference count */
 545         void    *ifma_protospec;        /* protocol-specific state, if any */
 546 };
 547
 548 #ifdef _KERNEL
 549
 550 #ifndef _SYS_SERIALIZE2_H_
 551 #include <sys/serialize2.h>
 552 #endif
 553
 554 enum ifaddr_event {
 555         IFADDR_EVENT_ADD,
 556         IFADDR_EVENT_DELETE,
 557         IFADDR_EVENT_CHANGE
 558 };
 559
 560 /* interface address change event */
 561 typedef void (*ifaddr_event_handler_t)(void *, struct ifnet *,
 562         enum ifaddr_event, struct ifaddr *);
 563 EVENTHANDLER_DECLARE(ifaddr_event, ifaddr_event_handler_t);
 564 /* new interface attach event */
 565 typedef void (*ifnet_attach_event_handler_t)(void *, struct ifnet *);
 566 EVENTHANDLER_DECLARE(ifnet_attach_event, ifnet_attach_event_handler_t);
 567 /* interface detach event */
 568 typedef void (*ifnet_detach_event_handler_t)(void *, struct ifnet *);
 569 EVENTHANDLER_DECLARE(ifnet_detach_event, ifnet_detach_event_handler_t);
 570
 571 /*
 572  * interface groups
 573  */
 574 struct ifg_group {
 575         char                             ifg_group[IFNAMSIZ];
 576         u_int                            ifg_refcnt;
 577         void                            *ifg_pf_kif;
 578         int                              ifg_carp_demoted;
 579         TAILQ_HEAD(, ifg_member)         ifg_members;
 580         TAILQ_ENTRY(ifg_group)           ifg_next;
 581 };
 582
 583 struct ifg_member {
 584         TAILQ_ENTRY(ifg_member)  ifgm_next;
 585         struct ifnet            *ifgm_ifp;
 586 };
 587
 588 struct ifg_list {
 589         struct ifg_group        *ifgl_group;
 590         TAILQ_ENTRY(ifg_list)    ifgl_next;
 591 };
 592
 593 /* group attach event */
 594 typedef void (*group_attach_event_handler_t)(void *, struct ifg_group *);
 595 EVENTHANDLER_DECLARE(group_attach_event, group_attach_event_handler_t);
 596 /* group detach event */
 597 typedef void (*group_detach_event_handler_t)(void *, struct ifg_group *);
 598 EVENTHANDLER_DECLARE(group_detach_event, group_detach_event_handler_t);
 599 /* group change event */
 600 typedef void (*group_change_event_handler_t)(void *, const char *);
 601 EVENTHANDLER_DECLARE(group_change_event, group_change_event_handler_t);
 602
 603
 604 #ifdef INVARIANTS
 605 #define ASSERT_IFAC_VALID(ifac) do { \
 606         KKASSERT((ifac)->ifa_magic == IFA_CONTAINER_MAGIC); \
 607         KKASSERT((ifac)->ifa_refcnt > 0); \
 608 } while (0)
 609 #else
 610 #define ASSERT_IFAC_VALID(ifac) ((void)0)
 611 #endif
 612
 613 static __inline void
 614 _IFAREF(struct ifaddr *_ifa, int _cpu_id)
 615 {
 616         struct ifaddr_container *_ifac = &_ifa->ifa_containers[_cpu_id];
 617
 618         crit_enter();
 619         ASSERT_IFAC_VALID(_ifac);
 620         ++_ifac->ifa_refcnt;
 621         crit_exit();
 622 }
 623
 624 static __inline void
 625 IFAREF(struct ifaddr *_ifa)
 626 {
 627         _IFAREF(_ifa, mycpuid);
 628 }
 629
 630 #include <sys/malloc.h>
 631
 632 MALLOC_DECLARE(M_IFADDR);
 633 MALLOC_DECLARE(M_IFMADDR);
 634 MALLOC_DECLARE(M_IFNET);
 635
 636 void    ifac_free(struct ifaddr_container *, int);
 637
 638 static __inline void
 639 _IFAFREE(struct ifaddr *_ifa, int _cpu_id)
 640 {
 641         struct ifaddr_container *_ifac = &_ifa->ifa_containers[_cpu_id];
 642
 643         crit_enter();
 644         ASSERT_IFAC_VALID(_ifac);
 645         if (--_ifac->ifa_refcnt == 0)
 646                 ifac_free(_ifac, _cpu_id);
 647         crit_exit();
 648 }
 649
 650 static __inline void
 651 IFAFREE(struct ifaddr *_ifa)
 652 {
 653         _IFAFREE(_ifa, mycpuid);
 654 }
 655
 656 struct lwkt_port *ifnet_portfn(int);
 657 int     ifnet_domsg(struct lwkt_msg *, int);
 658 void    ifnet_sendmsg(struct lwkt_msg *, int);
 659 void    ifnet_forwardmsg(struct lwkt_msg *, int);
 660 struct ifnet *ifnet_byindex(unsigned short);
 661
 662 static __inline int
 663 ifa_domsg(struct lwkt_msg *_lmsg, int _cpu)
 664 {
 665         return ifnet_domsg(_lmsg, _cpu);
 666 }
 667
 668 static __inline void
 669 ifa_sendmsg(struct lwkt_msg *_lmsg, int _cpu)
 670 {
 671         ifnet_sendmsg(_lmsg, _cpu);
 672 }
 673
 674 static __inline void
 675 ifa_forwardmsg(struct lwkt_msg *_lmsg, int _nextcpu)
 676 {
 677         ifnet_forwardmsg(_lmsg, _nextcpu);
 678 }
 679
 680 static __inline int
 681 ifnet_serialize_array_index(int _arrcnt, int _txoff, int _rxoff,
 682     enum ifnet_serialize _slz)
 683 {
 684         int _off;
 685
 686         if (_slz == IFNET_SERIALIZE_MAIN) {
 687                 _off = 0;
 688         } else if (_slz & IFNET_SERIALIZE_TX_BASE) {
 689                 _off = (_slz & ~IFNET_SERIALIZE_TX_BASE) + _txoff;
 690                 KASSERT(_off < _arrcnt,
 691                     ("invalid TX serializer %#x", _slz));
 692         } else if (_slz & IFNET_SERIALIZE_RX_BASE) {
 693                 _off = (_slz & ~IFNET_SERIALIZE_RX_BASE) + _rxoff;
 694                 KASSERT(_off < _arrcnt,
 695                     ("invalid RX serializer %#x", _slz));
 696         } else {
 697                 panic("unknown serializer %#x", _slz);
 698         }
 699         return _off;
 700 }
 701
 702 static __inline void
 703 ifnet_serialize_array_enter(lwkt_serialize_t *_arr, int _arrcnt,
 704     int _txoff, int _rxoff, enum ifnet_serialize _slz)
 705 {
 706         int _off;
 707
 708         if (_slz == IFNET_SERIALIZE_ALL) {
 709                 lwkt_serialize_array_enter(_arr, _arrcnt, 0);
 710                 return;
 711         }
 712
 713         _off = ifnet_serialize_array_index(_arrcnt, _txoff, _rxoff, _slz);
 714         lwkt_serialize_enter(_arr[_off]);
 715 }
 716
 717 static __inline void
 718 ifnet_serialize_array_exit(lwkt_serialize_t *_arr, int _arrcnt,
 719     int _txoff, int _rxoff, enum ifnet_serialize _slz)
 720 {
 721         int _off;
 722
 723         if (_slz == IFNET_SERIALIZE_ALL) {
 724                 lwkt_serialize_array_exit(_arr, _arrcnt, 0);
 725                 return;
 726         }
 727
 728         _off = ifnet_serialize_array_index(_arrcnt, _txoff, _rxoff, _slz);
 729         lwkt_serialize_exit(_arr[_off]);
 730 }
 731
 732 static __inline int
 733 ifnet_serialize_array_try(lwkt_serialize_t *_arr, int _arrcnt,
 734     int _txoff, int _rxoff, enum ifnet_serialize _slz)
 735 {
 736         int _off;
 737
 738         if (_slz == IFNET_SERIALIZE_ALL)
 739                 return lwkt_serialize_array_try(_arr, _arrcnt, 0);
 740
 741         _off = ifnet_serialize_array_index(_arrcnt, _txoff, _rxoff, _slz);
 742         return lwkt_serialize_try(_arr[_off]);
 743 }
 744
 745 #ifdef INVARIANTS
 746
 747 static __inline void
 748 ifnet_serialize_array_assert(lwkt_serialize_t *_arr, int _arrcnt,
 749     int _txoff, int _rxoff, enum ifnet_serialize _slz, boolean_t _serialized)
 750 {
 751         int _off;
 752
 753         if (_slz == IFNET_SERIALIZE_ALL) {
 754                 int _i;
 755
 756                 if (_serialized) {
 757                         for (_i = 0; _i < _arrcnt; ++_i)
 758                                 ASSERT_SERIALIZED(_arr[_i]);
 759                 } else {
 760                         for (_i = 0; _i < _arrcnt; ++_i)
 761                                 ASSERT_NOT_SERIALIZED(_arr[_i]);
 762                 }
 763                 return;
 764         }
 765
 766         _off = ifnet_serialize_array_index(_arrcnt, _txoff, _rxoff, _slz);
 767         if (_serialized)
 768                 ASSERT_SERIALIZED(_arr[_off]);
 769         else
 770                 ASSERT_NOT_SERIALIZED(_arr[_off]);
 771 }
 772
 773 #endif  /* INVARIANTS */
 774
 775 #define REINPUT_KEEPRCVIF       0x0001  /* ether_reinput_oncpu() */
 776 #define REINPUT_RUNBPF          0x0002  /* ether_reinput_oncpu() */
 777
 778 extern  struct ifnethead ifnet;
 779 extern struct   ifnet   **ifindex2ifnet;
 780 extern  int ifqmaxlen;
 781 extern  struct ifnet loif[];
 782 extern  int if_index;
 783
 784 struct ip;
 785 struct tcphdr;
 786
 787 void    ether_ifattach(struct ifnet *, uint8_t *, struct lwkt_serialize *);
 788 void    ether_ifattach_bpf(struct ifnet *, uint8_t *, u_int, u_int,
 789                         struct lwkt_serialize *);
 790 void    ether_ifdetach(struct ifnet *);
 791 void    ether_demux(struct mbuf *);
 792 void    ether_demux_oncpu(struct ifnet *, struct mbuf *);
 793 void    ether_reinput_oncpu(struct ifnet *, struct mbuf *, int);
 794 void    ether_input_pkt(struct ifnet *, struct mbuf *, const struct pktinfo *);
 795 int     ether_output_frame(struct ifnet *, struct mbuf *);
 796 int     ether_ioctl(struct ifnet *, u_long, caddr_t);
 797 boolean_t ether_tso_pullup(struct mbuf **, int *, struct ip **, int *,
 798             struct tcphdr **, int *);
 799 struct ifnet *ether_bridge_interface(struct ifnet *ifp);
 800 uint32_t        ether_crc32_le(const uint8_t *, size_t);
 801 uint32_t        ether_crc32_be(const uint8_t *, size_t);
 802
 803 int     if_addmulti(struct ifnet *, struct sockaddr *, struct ifmultiaddr **);
 804 int     if_allmulti(struct ifnet *, int);
 805 void    if_attach(struct ifnet *, struct lwkt_serialize *);
 806 int     if_delmulti(struct ifnet *, struct sockaddr *);
 807 void    if_delallmulti(struct ifnet *ifp);
 808 void    if_purgeaddrs_nolink(struct ifnet *);
 809 void    if_detach(struct ifnet *);
 810 void    if_down(struct ifnet *);
 811 void    if_link_state_change(struct ifnet *);
 812 void    if_initname(struct ifnet *, const char *, int);
 813 int     if_getanyethermac(uint16_t *, int);
 814 int     if_printf(struct ifnet *, const char *, ...) __printflike(2, 3);
 815 struct ifnet *if_alloc(uint8_t);
 816 void    if_free(struct ifnet *);
 817 void    if_route(struct ifnet *, int flag, int fam);
 818 int     if_setlladdr(struct ifnet *, const u_char *, int);
 819 void    if_unroute(struct ifnet *, int flag, int fam);
 820 void    if_up(struct ifnet *);
 821 /*void  ifinit(void);*/ /* declared in systm.h for main() */
 822 int     ifioctl(struct socket *, u_long, caddr_t, struct ucred *);
 823 int     ifpromisc(struct ifnet *, int);
 824 struct  ifnet *ifunit(const char *);
 825 struct  ifnet *if_withname(struct sockaddr *);
 826
 827 struct  ifg_group *if_creategroup(const char *);
 828 int     if_addgroup(struct ifnet *, const char *);
 829 int     if_delgroup(struct ifnet *, const char *);
 830 int     if_getgroup(caddr_t, struct ifnet *);
 831 int     if_getgroupmembers(caddr_t);
 832
 833 struct  ifaddr *ifa_ifwithaddr(struct sockaddr *);
 834 struct  ifaddr *ifa_ifwithdstaddr(struct sockaddr *);
 835 struct  ifaddr *ifa_ifwithnet(struct sockaddr *);
 836 struct  ifaddr *ifa_ifwithroute(int, struct sockaddr *, struct sockaddr *);
 837 struct  ifaddr *ifaof_ifpforaddr(struct sockaddr *, struct ifnet *);
 838
 839 typedef void *if_com_alloc_t(u_char type, struct ifnet *ifp);
 840 typedef void if_com_free_t(void *com, u_char type);
 841 void    if_register_com_alloc(u_char, if_com_alloc_t *a, if_com_free_t *);
 842 void    if_deregister_com_alloc(u_char);
 843
 844 void    *ifa_create(int, int);
 845 void    ifa_destroy(struct ifaddr *);
 846 void    ifa_iflink(struct ifaddr *, struct ifnet *, int);
 847 void    ifa_ifunlink(struct ifaddr *, struct ifnet *);
 848
 849 struct ifaddr *ifaddr_byindex(unsigned short);
 850
 851 struct  ifmultiaddr *ifmaof_ifpforaddr(struct sockaddr *, struct ifnet *);
 852 int     if_simloop(struct ifnet *ifp, struct mbuf *m, int af, int hlen);
 853 void    if_devstart(struct ifnet *ifp); /* COMPAT */
 854 void    if_devstart_sched(struct ifnet *ifp); /* COMPAT */
 855 int     if_ring_count2(int cnt, int cnt_max);
 856
 857 #define IF_LLSOCKADDR(ifp)                                              \
 858     ((struct sockaddr_dl *)(ifp)->if_lladdr->ifa_addr)
 859 #define IF_LLADDR(ifp)  LLADDR(IF_LLSOCKADDR(ifp))
 860
 861 #ifdef IFPOLL_ENABLE
 862 int     ifpoll_register(struct ifnet *);
 863 int     ifpoll_deregister(struct ifnet *);
 864 #endif  /* IFPOLL_ENABLE */
 865
 866 #endif /* _KERNEL */
 867
 868 #endif /* !_NET_IF_VAR_H_ */