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  * $DragonFly: src/sys/net/if_var.h,v 1.71 2008/11/22 04:00:53 sephe Exp $
  36  */
  37
  38 #ifndef _NET_IF_VAR_H_
  39 #define _NET_IF_VAR_H_
  40
  41 #ifndef _SYS_SERIALIZE_H_
  42 #include <sys/serialize.h>
  43 #endif
  44 #ifndef _NET_IF_H_
  45 #include <net/if.h>
  46 #endif
  47 #ifndef _SYS_MUTEX_H_
  48 #include <sys/mutex.h>
  49 #endif
  50
  51 /*
  52  * Structures defining a network interface, providing a packet
  53  * transport mechanism (ala level 0 of the PUP protocols).
  54  *
  55  * Each interface accepts output datagrams of a specified maximum
  56  * length, and provides higher level routines with input datagrams
  57  * received from its medium.
  58  *
  59  * Output occurs when the routine if_output is called, with four parameters:
  60  *      ifp->if_output(ifp, m, dst, rt)
  61  * Here m is the mbuf chain to be sent and dst is the destination address.
  62  * The output routine encapsulates the supplied datagram if necessary,
  63  * and then transmits it on its medium.
  64  *
  65  * On input, each interface unwraps the data received by it, and either
  66  * places it on the input queue of a internetwork datagram routine
  67  * and posts the associated software interrupt, or passes the datagram to
  68  * the routine if_input. It is called with the mbuf chain as parameter:
  69  *      ifp->if_input(ifp, m)
  70  * The input routine removes the protocol dependent header if necessary.
  71  *
  72  * Routines exist for locating interfaces by their addresses
  73  * or for locating a interface on a certain network, as well as more general
  74  * routing and gateway routines maintaining information used to locate
  75  * interfaces.  These routines live in the files if.c and route.c
  76  */
  77
  78 /*
  79  * Forward structure declarations for function prototypes [sic].
  80  */
  81 struct  mbuf;
  82 struct  mbuf_chain;
  83 struct  proc;
  84 struct  rtentry;
  85 struct  rt_addrinfo;
  86 struct  socket;
  87 struct  ether_header;
  88 struct  ucred;
  89 struct  lwkt_serialize;
  90 struct  ifaddr_container;
  91 struct  ifaddr;
  92 struct  lwkt_port;
  93 struct  lwkt_msg;
  94 union   netmsg;
  95 struct  pktinfo;
  96 struct  ifpoll_info;
  97
  98 #include <sys/queue.h>          /* get TAILQ macros */
  99
 100 #include <net/altq/if_altq.h>
 101
 102 #ifdef _KERNEL
 103 #include <sys/eventhandler.h>
 104 #include <sys/mbuf.h>
 105 #include <sys/systm.h>          /* XXX */
 106 #include <sys/thread2.h>
 107 #endif /* _KERNEL */
 108
 109 #define IF_DUNIT_NONE   -1
 110
 111 TAILQ_HEAD(ifnethead, ifnet);   /* we use TAILQs so that the order of */
 112 TAILQ_HEAD(ifaddrhead, ifaddr_container); /* instantiation is preserved in the list */
 113 TAILQ_HEAD(ifprefixhead, ifprefix);
 114 TAILQ_HEAD(ifmultihead, ifmultiaddr);
 115
 116 /*
 117  * Structure defining a queue for a network interface.
 118  */
 119 struct  ifqueue {
 120         struct  mbuf *ifq_head;
 121         struct  mbuf *ifq_tail;
 122         int     ifq_len;
 123         int     ifq_maxlen;
 124         int     ifq_drops;
 125 };
 126
 127 /*
 128  * Note of DEVICE_POLLING
 129  * 1) Any file(*.c) that depends on DEVICE_POLLING supports in this
 130  *    file should include opt_polling.h at its beginning.
 131  * 2) When struct changes, which are conditioned by DEVICE_POLLING,
 132  *    are to be introduced, please keep the struct's size and layout
 133  *    same, no matter whether DEVICE_POLLING is defined or not.
 134  *    See ifnet.if_poll and ifnet.if_poll_unused for example.
 135  */
 136
 137 #ifdef DEVICE_POLLING
 138 enum poll_cmd { POLL_ONLY, POLL_AND_CHECK_STATUS, POLL_DEREGISTER,
 139                 POLL_REGISTER };
 140 #endif
 141
 142 enum ifnet_serialize {
 143         IFNET_SERIALIZE_ALL,
 144         IFNET_SERIALIZE_MAIN,
 145         IFNET_SERIALIZE_TX_BASE = 0x10000000,
 146         IFNET_SERIALIZE_RX_BASE = 0x20000000
 147 };
 148 #define IFNET_SERIALIZE_TX      IFNET_SERIALIZE_TX_BASE
 149 #define IFNET_SERIALIZE_RX(i)   (IFNET_SERIALIZE_RX_BASE + (i))
 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_qpoll)
 264                 (struct ifnet *, struct ifpoll_info *);
 265 #else
 266         /* Place holders */
 267         void    (*if_qpoll_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         union {
 282                 void *carp_s;           /* carp structure (used by !carp ifs) */
 283                 struct ifnet *carp_d;   /* ptr to carpdev (used by carp ifs) */
 284         } if_carp_ptr;
 285         #define if_carp         if_carp_ptr.carp_s
 286         #define if_carpdev      if_carp_ptr.carp_d
 287 };
 288 typedef void if_init_f_t (void *);
 289
 290 #define if_mtu          if_data.ifi_mtu
 291 #define if_type         if_data.ifi_type
 292 #define if_physical     if_data.ifi_physical
 293 #define if_addrlen      if_data.ifi_addrlen
 294 #define if_hdrlen       if_data.ifi_hdrlen
 295 #define if_metric       if_data.ifi_metric
 296 #define if_link_state   if_data.ifi_link_state
 297 #define if_baudrate     if_data.ifi_baudrate
 298 #define if_hwassist     if_data.ifi_hwassist
 299 #define if_ipackets     if_data.ifi_ipackets
 300 #define if_ierrors      if_data.ifi_ierrors
 301 #define if_opackets     if_data.ifi_opackets
 302 #define if_oerrors      if_data.ifi_oerrors
 303 #define if_collisions   if_data.ifi_collisions
 304 #define if_ibytes       if_data.ifi_ibytes
 305 #define if_obytes       if_data.ifi_obytes
 306 #define if_imcasts      if_data.ifi_imcasts
 307 #define if_omcasts      if_data.ifi_omcasts
 308 #define if_iqdrops      if_data.ifi_iqdrops
 309 #define if_noproto      if_data.ifi_noproto
 310 #define if_lastchange   if_data.ifi_lastchange
 311 #define if_recvquota    if_data.ifi_recvquota
 312 #define if_xmitquota    if_data.ifi_xmitquota
 313 #define if_rawoutput(if, m, sa) if_output(if, m, sa, NULL)
 314
 315 /* for compatibility with other BSDs */
 316 #define if_list         if_link
 317
 318
 319 /*
 320  * Output queues (ifp->if_snd) and slow device input queues (*ifp->if_slowq)
 321  * are queues of messages stored on ifqueue structures
 322  * (defined above).  Entries are added to and deleted from these structures
 323  * by these macros, which should be called with ipl raised to splimp().
 324  */
 325 #define IF_QFULL(ifq)           ((ifq)->ifq_len >= (ifq)->ifq_maxlen)
 326 #define IF_DROP(ifq)            ((ifq)->ifq_drops++)
 327 #define IF_QLEN(ifq)            ((ifq)->ifq_len)
 328 #define IF_QEMPTY(ifq)          (IF_QLEN(ifq) == 0)
 329 #define IF_ENQUEUE(ifq, m) do {                                         \
 330         (m)->m_nextpkt = 0;                                             \
 331         if ((ifq)->ifq_tail == 0)                                       \
 332                 (ifq)->ifq_head = m;                                    \
 333         else                                                            \
 334                 (ifq)->ifq_tail->m_nextpkt = m;                         \
 335         (ifq)->ifq_tail = m;                                            \
 336         (ifq)->ifq_len++;                                               \
 337 } while (0)
 338 #define IF_PREPEND(ifq, m) do {                                         \
 339         (m)->m_nextpkt = (ifq)->ifq_head;                               \
 340         if ((ifq)->ifq_tail == 0)                                       \
 341                 (ifq)->ifq_tail = (m);                                  \
 342         (ifq)->ifq_head = (m);                                          \
 343         (ifq)->ifq_len++;                                               \
 344 } while (0)
 345 #define IF_DEQUEUE(ifq, m) do {                                         \
 346         (m) = (ifq)->ifq_head;                                          \
 347         if (m) {                                                        \
 348                 if (((ifq)->ifq_head = (m)->m_nextpkt) == 0)            \
 349                         (ifq)->ifq_tail = 0;                            \
 350                 (m)->m_nextpkt = 0;                                     \
 351                 (ifq)->ifq_len--;                                       \
 352         }                                                               \
 353 } while (0)
 354
 355 #define IF_POLL(ifq, m)         ((m) = (ifq)->ifq_head)
 356
 357 #define IF_DRAIN(ifq) do {                                              \
 358         struct mbuf *m;                                                 \
 359         while (1) {                                                     \
 360                 IF_DEQUEUE(ifq, m);                                     \
 361                 if (m == NULL)                                          \
 362                         break;                                          \
 363                 m_freem(m);                                             \
 364         }                                                               \
 365 } while (0)
 366
 367 #ifdef _KERNEL
 368
 369 /* interface link layer address change event */
 370 typedef void (*iflladdr_event_handler_t)(void *, struct ifnet *);
 371 EVENTHANDLER_DECLARE(iflladdr_event, iflladdr_event_handler_t);
 372
 373 #ifdef INVARIANTS
 374 #define ASSERT_IFNET_SERIALIZED_ALL(ifp) \
 375         (ifp)->if_serialize_assert((ifp), IFNET_SERIALIZE_ALL, TRUE)
 376 #define ASSERT_IFNET_NOT_SERIALIZED_ALL(ifp) \
 377         (ifp)->if_serialize_assert((ifp), IFNET_SERIALIZE_ALL, FALSE)
 378
 379 #define ASSERT_IFNET_SERIALIZED_TX(ifp) \
 380         (ifp)->if_serialize_assert((ifp), IFNET_SERIALIZE_TX, TRUE)
 381 #define ASSERT_IFNET_NOT_SERIALIZED_TX(ifp) \
 382         (ifp)->if_serialize_assert((ifp), IFNET_SERIALIZE_TX, FALSE)
 383
 384 #define ASSERT_IFNET_SERIALIZED_MAIN(ifp) \
 385         (ifp)->if_serialize_assert((ifp), IFNET_SERIALIZE_MAIN, TRUE)
 386 #define ASSERT_IFNET_NOT_SERIALIZED_MAIN(ifp) \
 387         (ifp)->if_serialize_assert((ifp), IFNET_SERIALIZE_MAIN, FALSE)
 388 #else
 389 #define ASSERT_IFNET_SERIALIZED_ALL(ifp)        ((void)0)
 390 #define ASSERT_IFNET_NOT_SERIALIZED_ALL(ifp)    ((void)0)
 391 #define ASSERT_IFNET_SERIALIZED_TX(ifp)         ((void)0)
 392 #define ASSERT_IFNET_NOT_SERIALIZED_TX(ifp)     ((void)0)
 393 #define ASSERT_IFNET_SERIALIZED_MAIN(ifp)       ((void)0)
 394 #define ASSERT_IFNET_NOT_SERIALIZED_MAIN(ifp)   ((void)0)
 395 #endif
 396
 397 static __inline void
 398 ifnet_serialize_all(struct ifnet *_ifp)
 399 {
 400         _ifp->if_serialize(_ifp, IFNET_SERIALIZE_ALL);
 401 }
 402
 403 static __inline void
 404 ifnet_deserialize_all(struct ifnet *_ifp)
 405 {
 406         _ifp->if_deserialize(_ifp, IFNET_SERIALIZE_ALL);
 407 }
 408
 409 static __inline int
 410 ifnet_tryserialize_all(struct ifnet *_ifp)
 411 {
 412         return _ifp->if_tryserialize(_ifp, IFNET_SERIALIZE_ALL);
 413 }
 414
 415 static __inline void
 416 ifnet_serialize_tx(struct ifnet *_ifp)
 417 {
 418         _ifp->if_serialize(_ifp, IFNET_SERIALIZE_TX);
 419 }
 420
 421 static __inline void
 422 ifnet_deserialize_tx(struct ifnet *_ifp)
 423 {
 424         _ifp->if_deserialize(_ifp, IFNET_SERIALIZE_TX);
 425 }
 426
 427 static __inline int
 428 ifnet_tryserialize_tx(struct ifnet *_ifp)
 429 {
 430         return _ifp->if_tryserialize(_ifp, IFNET_SERIALIZE_TX);
 431 }
 432
 433 static __inline void
 434 ifnet_serialize_main(struct ifnet *_ifp)
 435 {
 436         _ifp->if_serialize(_ifp, IFNET_SERIALIZE_MAIN);
 437 }
 438
 439 static __inline void
 440 ifnet_deserialize_main(struct ifnet *_ifp)
 441 {
 442         _ifp->if_deserialize(_ifp, IFNET_SERIALIZE_MAIN);
 443 }
 444
 445 static __inline int
 446 ifnet_tryserialize_main(struct ifnet *_ifp)
 447 {
 448         return _ifp->if_tryserialize(_ifp, IFNET_SERIALIZE_MAIN);
 449 }
 450
 451 /*
 452  * DEPRECATED - should not be used by any new driver.  This code uses the
 453  * old queueing interface and if_start ABI and does not use the ifp's
 454  * serializer.
 455  */
 456 #define IF_HANDOFF(ifq, m, ifp)                 if_handoff(ifq, m, ifp, 0)
 457 #define IF_HANDOFF_ADJ(ifq, m, ifp, adj)        if_handoff(ifq, m, ifp, adj)
 458
 459 static __inline int
 460 if_handoff(struct ifqueue *_ifq, struct mbuf *_m, struct ifnet *_ifp,
 461            int _adjust)
 462 {
 463         int _need_if_start = 0;
 464
 465         crit_enter();
 466
 467         if (IF_QFULL(_ifq)) {
 468                 IF_DROP(_ifq);
 469                 crit_exit();
 470                 m_freem(_m);
 471                 return (0);
 472         }
 473         if (_ifp != NULL) {
 474                 _ifp->if_obytes += _m->m_pkthdr.len + _adjust;
 475                 if (_m->m_flags & M_MCAST)
 476                         _ifp->if_omcasts++;
 477                 _need_if_start = !(_ifp->if_flags & IFF_OACTIVE);
 478         }
 479         IF_ENQUEUE(_ifq, _m);
 480         if (_need_if_start) {
 481                 (*_ifp->if_start)(_ifp);
 482         }
 483         crit_exit();
 484         return (1);
 485 }
 486
 487 /*
 488  * 72 was chosen below because it is the size of a TCP/IP
 489  * header (40) + the minimum mss (32).
 490  */
 491 #define IF_MINMTU       72
 492 #define IF_MAXMTU       65535
 493
 494 #endif /* _KERNEL */
 495
 496 struct in_ifaddr;
 497
 498 struct in_ifaddr_container {
 499         struct in_ifaddr        *ia;
 500         LIST_ENTRY(in_ifaddr_container) ia_hash;
 501                                 /* entry in bucket of inet addresses */
 502         TAILQ_ENTRY(in_ifaddr_container) ia_link;
 503                                 /* list of internet addresses */
 504         struct ifaddr_container *ia_ifac; /* parent ifaddr_container */
 505 };
 506
 507 struct ifaddr_container {
 508 #define IFA_CONTAINER_MAGIC     0x19810219
 509 #define IFA_CONTAINER_DEAD      0xc0dedead
 510         uint32_t                ifa_magic;  /* IFA_CONTAINER_MAGIC */
 511         struct ifaddr           *ifa;
 512         TAILQ_ENTRY(ifaddr_container)   ifa_link;   /* queue macro glue */
 513         u_int                   ifa_refcnt; /* references to this structure */
 514         uint16_t                ifa_listmask;   /* IFA_LIST_ */
 515         uint16_t                ifa_prflags;    /* protocol specific flags */
 516
 517         /*
 518          * Protocol specific states
 519          */
 520         union {
 521                 struct in_ifaddr_container u_in_ifac;
 522         } ifa_proto_u;
 523 };
 524
 525 #define IFA_LIST_IFADDRHEAD     0x01    /* on ifnet.if_addrheads[cpuid] */
 526 #define IFA_LIST_IN_IFADDRHEAD  0x02    /* on in_ifaddrheads[cpuid] */
 527 #define IFA_LIST_IN_IFADDRHASH  0x04    /* on in_ifaddrhashtbls[cpuid] */
 528
 529 #define IFA_PRF_FLAG0           0x01
 530 #define IFA_PRF_FLAG1           0x02
 531 #define IFA_PRF_FLAG2           0x04
 532 #define IFA_PRF_FLAG3           0x08
 533
 534 /*
 535  * The ifaddr structure contains information about one address
 536  * of an interface.  They are maintained by the different address families,
 537  * are allocated and attached when an address is set, and are linked
 538  * together so all addresses for an interface can be located.
 539  */
 540 struct ifaddr {
 541         struct  sockaddr *ifa_addr;     /* address of interface */
 542         struct  sockaddr *ifa_dstaddr;  /* other end of p-to-p link */
 543 #define ifa_broadaddr   ifa_dstaddr     /* broadcast address interface */
 544         struct  sockaddr *ifa_netmask;  /* used to determine subnet */
 545         struct  if_data if_data;        /* not all members are meaningful */
 546         struct  ifnet *ifa_ifp;         /* back-pointer to interface */
 547         void    *ifa_link_pad;
 548         struct ifaddr_container *ifa_containers;
 549         void    (*ifa_rtrequest)        /* check or clean routes (+ or -)'d */
 550                 (int, struct rtentry *, struct rt_addrinfo *);
 551         u_short ifa_flags;              /* mostly rt_flags for cloning */
 552         int     ifa_ncnt;               /* # of valid ifaddr_container */
 553         int     ifa_metric;             /* cost of going out this interface */
 554 #ifdef notdef
 555         struct  rtentry *ifa_rt;        /* XXXX for ROUTETOIF ????? */
 556 #endif
 557         int (*ifa_claim_addr)           /* check if an addr goes to this if */
 558                 (struct ifaddr *, struct sockaddr *);
 559
 560 };
 561 #define IFA_ROUTE       RTF_UP          /* route installed */
 562
 563 /* for compatibility with other BSDs */
 564 #define ifa_list        ifa_link
 565
 566 /*
 567  * The prefix structure contains information about one prefix
 568  * of an interface.  They are maintained by the different address families,
 569  * are allocated and attached when an prefix or an address is set,
 570  * and are linked together so all prefixes for an interface can be located.
 571  */
 572 struct ifprefix {
 573         struct  sockaddr *ifpr_prefix;  /* prefix of interface */
 574         struct  ifnet *ifpr_ifp;        /* back-pointer to interface */
 575         TAILQ_ENTRY(ifprefix) ifpr_list; /* queue macro glue */
 576         u_char  ifpr_plen;              /* prefix length in bits */
 577         u_char  ifpr_type;              /* protocol dependent prefix type */
 578 };
 579
 580 /*
 581  * Multicast address structure.  This is analogous to the ifaddr
 582  * structure except that it keeps track of multicast addresses.
 583  * Also, the reference count here is a count of requests for this
 584  * address, not a count of pointers to this structure.
 585  */
 586 struct ifmultiaddr {
 587         TAILQ_ENTRY(ifmultiaddr) ifma_link; /* queue macro glue */
 588         struct  sockaddr *ifma_addr;    /* address this membership is for */
 589         struct  sockaddr *ifma_lladdr;  /* link-layer translation, if any */
 590         struct  ifnet *ifma_ifp;        /* back-pointer to interface */
 591         u_int   ifma_refcount;          /* reference count */
 592         void    *ifma_protospec;        /* protocol-specific state, if any */
 593 };
 594
 595 #ifdef _KERNEL
 596
 597 enum ifaddr_event {
 598         IFADDR_EVENT_ADD,
 599         IFADDR_EVENT_DELETE,
 600         IFADDR_EVENT_CHANGE
 601 };
 602
 603 /* interface address change event */
 604 typedef void (*ifaddr_event_handler_t)(void *, struct ifnet *,
 605         enum ifaddr_event, struct ifaddr *);
 606 EVENTHANDLER_DECLARE(ifaddr_event, ifaddr_event_handler_t);
 607 /* new interface attach event */
 608 typedef void (*ifnet_attach_event_handler_t)(void *, struct ifnet *);
 609 EVENTHANDLER_DECLARE(ifnet_attach_event, ifnet_attach_event_handler_t);
 610 /* interface detach event */
 611 typedef void (*ifnet_detach_event_handler_t)(void *, struct ifnet *);
 612 EVENTHANDLER_DECLARE(ifnet_detach_event, ifnet_detach_event_handler_t);
 613
 614 /*
 615  * interface groups
 616  */
 617 struct ifg_group {
 618         char                             ifg_group[IFNAMSIZ];
 619         u_int                            ifg_refcnt;
 620         void                            *ifg_pf_kif;
 621         int                              ifg_carp_demoted;
 622         TAILQ_HEAD(, ifg_member)         ifg_members;
 623         TAILQ_ENTRY(ifg_group)           ifg_next;
 624 };
 625
 626 struct ifg_member {
 627         TAILQ_ENTRY(ifg_member)  ifgm_next;
 628         struct ifnet            *ifgm_ifp;
 629 };
 630
 631 struct ifg_list {
 632         struct ifg_group        *ifgl_group;
 633         TAILQ_ENTRY(ifg_list)    ifgl_next;
 634 };
 635
 636 /* group attach event */
 637 typedef void (*group_attach_event_handler_t)(void *, struct ifg_group *);
 638 EVENTHANDLER_DECLARE(group_attach_event, group_attach_event_handler_t);
 639 /* group detach event */
 640 typedef void (*group_detach_event_handler_t)(void *, struct ifg_group *);
 641 EVENTHANDLER_DECLARE(group_detach_event, group_detach_event_handler_t);
 642 /* group change event */
 643 typedef void (*group_change_event_handler_t)(void *, const char *);
 644 EVENTHANDLER_DECLARE(group_change_event, group_change_event_handler_t);
 645
 646
 647 #ifdef INVARIANTS
 648 #define ASSERT_IFAC_VALID(ifac) do { \
 649         KKASSERT((ifac)->ifa_magic == IFA_CONTAINER_MAGIC); \
 650         KKASSERT((ifac)->ifa_refcnt > 0); \
 651 } while (0)
 652 #else
 653 #define ASSERT_IFAC_VALID(ifac) ((void)0)
 654 #endif
 655
 656 static __inline void
 657 _IFAREF(struct ifaddr *_ifa, int _cpu_id)
 658 {
 659         struct ifaddr_container *_ifac = &_ifa->ifa_containers[_cpu_id];
 660
 661         crit_enter();
 662         ASSERT_IFAC_VALID(_ifac);
 663         ++_ifac->ifa_refcnt;
 664         crit_exit();
 665 }
 666
 667 static __inline void
 668 IFAREF(struct ifaddr *_ifa)
 669 {
 670         _IFAREF(_ifa, mycpuid);
 671 }
 672
 673 #include <sys/malloc.h>
 674
 675 MALLOC_DECLARE(M_IFADDR);
 676 MALLOC_DECLARE(M_IFMADDR);
 677 MALLOC_DECLARE(M_IFNET);
 678
 679 void    ifac_free(struct ifaddr_container *, int);
 680
 681 static __inline void
 682 _IFAFREE(struct ifaddr *_ifa, int _cpu_id)
 683 {
 684         struct ifaddr_container *_ifac = &_ifa->ifa_containers[_cpu_id];
 685
 686         crit_enter();
 687         ASSERT_IFAC_VALID(_ifac);
 688         if (--_ifac->ifa_refcnt == 0)
 689                 ifac_free(_ifac, _cpu_id);
 690         crit_exit();
 691 }
 692
 693 static __inline void
 694 IFAFREE(struct ifaddr *_ifa)
 695 {
 696         _IFAFREE(_ifa, mycpuid);
 697 }
 698
 699 struct lwkt_port *ifnet_portfn(int);
 700 int     ifnet_domsg(struct lwkt_msg *, int);
 701 void    ifnet_sendmsg(struct lwkt_msg *, int);
 702 void    ifnet_forwardmsg(struct lwkt_msg *, int);
 703 struct ifnet *ifnet_byindex(unsigned short);
 704
 705 static __inline int
 706 ifa_domsg(struct lwkt_msg *_lmsg, int _cpu)
 707 {
 708         return ifnet_domsg(_lmsg, _cpu);
 709 }
 710
 711 static __inline void
 712 ifa_sendmsg(struct lwkt_msg *_lmsg, int _cpu)
 713 {
 714         ifnet_sendmsg(_lmsg, _cpu);
 715 }
 716
 717 static __inline void
 718 ifa_forwardmsg(struct lwkt_msg *_lmsg, int _nextcpu)
 719 {
 720         ifnet_forwardmsg(_lmsg, _nextcpu);
 721 }
 722
 723 #define REINPUT_KEEPRCVIF       0x0001  /* ether_reinput_oncpu() */
 724 #define REINPUT_RUNBPF          0x0002  /* ether_reinput_oncpu() */
 725
 726
 727 extern  struct ifnethead ifnet;
 728 extern struct   ifnet   **ifindex2ifnet;
 729 extern  int ifqmaxlen;
 730 extern  struct ifnet loif[];
 731 extern  int if_index;
 732
 733 void    ether_ifattach(struct ifnet *, uint8_t *, struct lwkt_serialize *);
 734 void    ether_ifattach_bpf(struct ifnet *, uint8_t *, u_int, u_int,
 735                         struct lwkt_serialize *);
 736 void    ether_ifdetach(struct ifnet *);
 737 void    ether_demux_oncpu(struct ifnet *, struct mbuf *);
 738 void    ether_reinput_oncpu(struct ifnet *, struct mbuf *, int);
 739 void    ether_input_chain(struct ifnet *, struct mbuf *,
 740                           const struct pktinfo *, struct mbuf_chain *);
 741 void    ether_input_chain_init(struct mbuf_chain *);
 742 void    ether_input_dispatch(struct mbuf_chain *);
 743 int     ether_output_frame(struct ifnet *, struct mbuf *);
 744 int     ether_ioctl(struct ifnet *, int, caddr_t);
 745 struct ifnet *ether_bridge_interface(struct ifnet *ifp);
 746 uint32_t        ether_crc32_le(const uint8_t *, size_t);
 747 uint32_t        ether_crc32_be(const uint8_t *, size_t);
 748
 749 int     if_addmulti(struct ifnet *, struct sockaddr *, struct ifmultiaddr **);
 750 int     if_allmulti(struct ifnet *, int);
 751 void    if_attach(struct ifnet *, struct lwkt_serialize *);
 752 int     if_delmulti(struct ifnet *, struct sockaddr *);
 753 void    if_delallmulti(struct ifnet *ifp);
 754 void    if_purgeaddrs_nolink(struct ifnet *);
 755 void    if_detach(struct ifnet *);
 756 void    if_down(struct ifnet *);
 757 void    if_link_state_change(struct ifnet *);
 758 void    if_initname(struct ifnet *, const char *, int);
 759 int     if_getanyethermac(uint16_t *, int);
 760 int     if_printf(struct ifnet *, const char *, ...) __printflike(2, 3);
 761 struct ifnet *if_alloc(uint8_t);
 762 void    if_free(struct ifnet *);
 763 void    if_route(struct ifnet *, int flag, int fam);
 764 int     if_setlladdr(struct ifnet *, const u_char *, int);
 765 void    if_unroute(struct ifnet *, int flag, int fam);
 766 void    if_up(struct ifnet *);
 767 /*void  ifinit(void);*/ /* declared in systm.h for main() */
 768 int     ifioctl(struct socket *, u_long, caddr_t, struct ucred *);
 769 int     ifpromisc(struct ifnet *, int);
 770 struct  ifnet *ifunit(const char *);
 771 struct  ifnet *if_withname(struct sockaddr *);
 772
 773 struct  ifg_group *if_creategroup(const char *);
 774 int     if_addgroup(struct ifnet *, const char *);
 775 int     if_delgroup(struct ifnet *, const char *);
 776 int     if_getgroup(caddr_t, struct ifnet *);
 777 int     if_getgroupmembers(caddr_t);
 778
 779 struct  ifaddr *ifa_ifwithaddr(struct sockaddr *);
 780 struct  ifaddr *ifa_ifwithdstaddr(struct sockaddr *);
 781 struct  ifaddr *ifa_ifwithnet(struct sockaddr *);
 782 struct  ifaddr *ifa_ifwithroute(int, struct sockaddr *, struct sockaddr *);
 783 struct  ifaddr *ifaof_ifpforaddr(struct sockaddr *, struct ifnet *);
 784
 785 typedef void *if_com_alloc_t(u_char type, struct ifnet *ifp);
 786 typedef void if_com_free_t(void *com, u_char type);
 787 void    if_register_com_alloc(u_char, if_com_alloc_t *a, if_com_free_t *);
 788 void    if_deregister_com_alloc(u_char);
 789
 790 void    *ifa_create(int, int);
 791 void    ifa_destroy(struct ifaddr *);
 792 void    ifa_iflink(struct ifaddr *, struct ifnet *, int);
 793 void    ifa_ifunlink(struct ifaddr *, struct ifnet *);
 794
 795 struct ifaddr *ifaddr_byindex(unsigned short);
 796
 797 struct  ifmultiaddr *ifmaof_ifpforaddr(struct sockaddr *, struct ifnet *);
 798 int     if_simloop(struct ifnet *ifp, struct mbuf *m, int af, int hlen);
 799 void    if_devstart(struct ifnet *ifp);
 800
 801 #define IF_LLSOCKADDR(ifp)                                              \
 802     ((struct sockaddr_dl *)(ifp)->if_lladdr->ifa_addr)
 803 #define IF_LLADDR(ifp)  LLADDR(IF_LLSOCKADDR(ifp))
 804
 805 #ifdef DEVICE_POLLING
 806 typedef void poll_handler_t (struct ifnet *ifp, enum poll_cmd cmd, int count);
 807 int     ether_poll_register(struct ifnet *);
 808 int     ether_poll_deregister(struct ifnet *);
 809 int     ether_pollcpu_register(struct ifnet *, int);
 810 #endif /* DEVICE_POLLING */
 811
 812 #ifdef IFPOLL_ENABLE
 813 int     ifpoll_register(struct ifnet *);
 814 int     ifpoll_deregister(struct ifnet *);
 815 #endif  /* IFPOLL_ENABLE */
 816
 817 #endif /* _KERNEL */
 818
 819 #endif /* !_NET_IF_VAR_H_ */