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