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