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  proc;
  83 struct  rtentry;
  84 struct  rt_addrinfo;
  85 struct  socket;
  86 struct  ether_header;
  87 struct  ucred;
  88 struct  lwkt_serialize;
  89 struct  ifaddr_container;
  90 struct  ifaddr;
  91 struct  lwkt_port;
  92 struct  lwkt_msg;
  93 union   netmsg;
  94 struct  pktinfo;
  95 struct  ifpoll_info;
  96
  97 #include <sys/queue.h>          /* get TAILQ macros */
  98
  99 #include <net/altq/if_altq.h>
 100
 101 #ifdef _KERNEL
 102 #include <sys/eventhandler.h>
 103 #include <sys/mbuf.h>
 104 #include <sys/systm.h>          /* XXX */
 105 #include <sys/thread2.h>
 106 #endif /* _KERNEL */
 107
 108 #define IF_DUNIT_NONE   -1
 109
 110 TAILQ_HEAD(ifnethead, ifnet);   /* we use TAILQs so that the order of */
 111 TAILQ_HEAD(ifaddrhead, ifaddr_container); /* instantiation is preserved in the list */
 112 TAILQ_HEAD(ifprefixhead, ifprefix);
 113 TAILQ_HEAD(ifmultihead, ifmultiaddr);
 114
 115 /*
 116  * Structure defining a queue for a network interface.
 117  */
 118 struct  ifqueue {
 119         struct  mbuf *ifq_head;
 120         struct  mbuf *ifq_tail;
 121         int     ifq_len;
 122         int     ifq_maxlen;
 123         int     ifq_drops;
 124 };
 125
 126 /*
 127  * Note of DEVICE_POLLING
 128  * 1) Any file(*.c) that depends on DEVICE_POLLING supports in this
 129  *    file should include opt_polling.h at its beginning.
 130  * 2) When struct changes, which are conditioned by DEVICE_POLLING,
 131  *    are to be introduced, please keep the struct's size and layout
 132  *    same, no matter whether DEVICE_POLLING is defined or not.
 133  *    See ifnet.if_poll and ifnet.if_poll_unused for example.
 134  */
 135
 136 #ifdef DEVICE_POLLING
 137 enum poll_cmd { POLL_ONLY, POLL_AND_CHECK_STATUS, POLL_DEREGISTER,
 138                 POLL_REGISTER };
 139 #endif
 140
 141 enum ifnet_serialize {
 142         IFNET_SERIALIZE_ALL,
 143         IFNET_SERIALIZE_MAIN,
 144         IFNET_SERIALIZE_TX_BASE = 0x10000000,
 145         IFNET_SERIALIZE_RX_BASE = 0x20000000
 146 };
 147 #define IFNET_SERIALIZE_TX      IFNET_SERIALIZE_TX_BASE
 148 #define IFNET_SERIALIZE_RX(i)   (IFNET_SERIALIZE_RX_BASE + (i))
 149
 150 #if defined(_KERNEL) || defined(_KERNEL_STRUCTURES)
 151
 152 /*
 153  * Structure defining a network interface.
 154  *
 155  * (Would like to call this struct ``if'', but C isn't PL/1.)
 156  */
 157
 158 /*
 159  * NB: For FreeBSD, it is assumed that each NIC driver's softc starts with
 160  * one of these structures, typically held within an arpcom structure.
 161  *
 162  *      struct <foo>_softc {
 163  *              struct arpcom {
 164  *                      struct  ifnet ac_if;
 165  *                      ...
 166  *              } <arpcom> ;
 167  *              ...
 168  *      };
 169  *
 170  * The assumption is used in a number of places, including many
 171  * files in sys/net, device drivers, and sys/dev/mii.c:miibus_attach().
 172  *
 173  * Unfortunately devices' softc are opaque, so we depend on this layout
 174  * to locate the struct ifnet from the softc in the generic code.
 175  *
 176  * MPSAFE NOTES:
 177  *
 178  * ifnet is protected by calling if_serialize, if_tryserialize and
 179  * if_deserialize serialize functions with the ifnet_serialize parameter.
 180  * ifnet.if_snd is protected by its own spinlock.  Callers of if_ioctl,
 181  * if_watchdog, if_init, if_resolvemulti, and if_poll should call the
 182  * ifnet serialize functions with IFNET_SERIALIZE_ALL.  Callers of if_start
 183  * sould call the ifnet serialize functions with IFNET_SERIALIZE_TX.
 184  *
 185  * FIXME: Device drivers usually use the same serializer for their interrupt
 186  * FIXME: but this is not required.
 187  *
 188  * Caller of if_output must not serialize ifnet by calling ifnet serialize
 189  * functions; if_output will call the ifnet serialize functions based on
 190  * its own needs.  Caller of if_input does not necessarily hold the related
 191  * serializer.
 192  *
 193  * If a device driver installs the same serializer for its interrupt
 194  * as for ifnet, then the driver only really needs to worry about further
 195  * serialization in timeout based entry points.  All other entry points
 196  * will already be serialized.  Older ISA drivers still using the old
 197  * interrupt infrastructure will have to obtain and release the serializer
 198  * in their interrupt routine themselves.
 199  */
 200 struct ifnet {
 201         void    *if_softc;              /* pointer to driver state */
 202         void    *if_l2com;              /* pointer to protocol bits */
 203         TAILQ_ENTRY(ifnet) if_link;     /* all struct ifnets are chained */
 204         char    if_xname[IFNAMSIZ];     /* external name (name + unit) */
 205         const char *if_dname;           /* driver name */
 206         int     if_dunit;               /* unit or IF_DUNIT_NONE */
 207         void    *if_vlantrunks;         /* vlan trunks */
 208         struct  ifaddrhead *if_addrheads; /* array[NCPU] of TAILQs of addresses per if */
 209         int     if_pcount;              /* number of promiscuous listeners */
 210         void    *if_carp;               /* carp interfaces */
 211         struct  bpf_if *if_bpf;         /* packet filter structure */
 212         u_short if_index;               /* numeric abbreviation for this if  */
 213         short   if_timer;               /* time 'til if_watchdog called */
 214         int     if_flags;               /* up/down, broadcast, etc. */
 215         int     if_capabilities;        /* interface capabilities */
 216         int     if_capenable;           /* enabled features */
 217         void    *if_linkmib;            /* link-type-specific MIB data */
 218         size_t  if_linkmiblen;          /* length of above data */
 219         struct  if_data if_data;
 220         struct  ifmultihead if_multiaddrs; /* multicast addresses configured */
 221         int     if_amcount;             /* number of all-multicast requests */
 222 /* procedure handles */
 223         int     (*if_output)            /* output routine (enqueue) */
 224                 (struct ifnet *, struct mbuf *, struct sockaddr *,
 225                      struct rtentry *);
 226         void    (*if_input)             /* input routine from hardware driver */
 227                 (struct ifnet *, struct mbuf *);
 228         void    (*if_start)             /* initiate output routine */
 229                 (struct ifnet *);
 230         int     (*if_ioctl)             /* ioctl routine */
 231                 (struct ifnet *, u_long, caddr_t, struct ucred *);
 232         void    (*if_watchdog)          /* timer routine */
 233                 (struct ifnet *);
 234         void    (*if_init)              /* Init routine */
 235                 (void *);
 236         int     (*if_resolvemulti)      /* validate/resolve multicast */
 237                 (struct ifnet *, struct sockaddr **, struct sockaddr *);
 238         int     (*if_start_cpuid)       /* cpuid to run if_start */
 239                 (struct ifnet *);
 240         TAILQ_HEAD(, ifg_list) if_groups; /* linked list of groups per if */
 241 #ifdef DEVICE_POLLING
 242         void    (*if_poll)              /* IFF_POLLING support */
 243                 (struct ifnet *, enum poll_cmd, int);
 244         int     if_poll_cpuid;
 245 #else
 246         /* Place holders */
 247         void    (*if_poll_unused)(void);
 248         int     if_poll_cpuid_used;
 249 #endif
 250         void    (*if_serialize)
 251                 (struct ifnet *, enum ifnet_serialize);
 252         void    (*if_deserialize)
 253                 (struct ifnet *, enum ifnet_serialize);
 254         int     (*if_tryserialize)
 255                 (struct ifnet *, enum ifnet_serialize);
 256 #ifdef INVARIANTS
 257         void    (*if_serialize_assert)
 258                 (struct ifnet *, enum ifnet_serialize, boolean_t);
 259 #else
 260         /* Place holders */
 261         void    (*if_serialize_unused)(void);
 262 #endif
 263 #ifdef IFPOLL_ENABLE
 264         void    (*if_qpoll)
 265                 (struct ifnet *, struct ifpoll_info *);
 266 #else
 267         /* Place holders */
 268         void    (*if_qpoll_unused)(void);
 269 #endif
 270         struct  ifaltq if_snd;          /* output queue (includes altq) */
 271         struct  ifprefixhead if_prefixhead; /* list of prefixes per if */
 272         const uint8_t   *if_broadcastaddr;
 273         void    *if_bridge;             /* bridge glue */
 274         void    *if_afdata[AF_MAX];
 275         struct ifaddr   *if_lladdr;
 276         struct lwkt_serialize *if_serializer;   /* serializer or MP lock */
 277         struct lwkt_serialize if_default_serializer; /* if not supplied */
 278         struct mtx      if_ioctl_mtx;   /* high-level ioctl serializing mutex */
 279         int     if_cpuid;
 280         struct netmsg_base *if_start_nmsg; /* percpu msgs to sched if_start */
 281         void    *if_pf_kif; /* pf interface abstraction */
 282         void    *if_unused;
 283 };
 284 typedef void if_init_f_t (void *);
 285
 286 #define if_mtu          if_data.ifi_mtu
 287 #define if_type         if_data.ifi_type
 288 #define if_physical     if_data.ifi_physical
 289 #define if_addrlen      if_data.ifi_addrlen
 290 #define if_hdrlen       if_data.ifi_hdrlen
 291 #define if_metric       if_data.ifi_metric
 292 #define if_link_state   if_data.ifi_link_state
 293 #define if_baudrate     if_data.ifi_baudrate
 294 #define if_hwassist     if_data.ifi_hwassist
 295 #define if_ipackets     if_data.ifi_ipackets
 296 #define if_ierrors      if_data.ifi_ierrors
 297 #define if_opackets     if_data.ifi_opackets
 298 #define if_oerrors      if_data.ifi_oerrors
 299 #define if_collisions   if_data.ifi_collisions
 300 #define if_ibytes       if_data.ifi_ibytes
 301 #define if_obytes       if_data.ifi_obytes
 302 #define if_imcasts      if_data.ifi_imcasts
 303 #define if_omcasts      if_data.ifi_omcasts
 304 #define if_iqdrops      if_data.ifi_iqdrops
 305 #define if_noproto      if_data.ifi_noproto
 306 #define if_lastchange   if_data.ifi_lastchange
 307 #define if_recvquota    if_data.ifi_recvquota
 308 #define if_xmitquota    if_data.ifi_xmitquota
 309 #define if_rawoutput(if, m, sa) if_output(if, m, sa, NULL)
 310
 311 /* for compatibility with other BSDs */
 312 #define if_list         if_link
 313
 314 #endif
 315
 316 /*
 317  * Output queues (ifp->if_snd) and slow device input queues (*ifp->if_slowq)
 318  * are queues of messages stored on ifqueue structures
 319  * (defined above).  Entries are added to and deleted from these structures
 320  * by these macros, which should be called with ipl raised to splimp().
 321  */
 322 #define IF_QFULL(ifq)           ((ifq)->ifq_len >= (ifq)->ifq_maxlen)
 323 #define IF_DROP(ifq)            ((ifq)->ifq_drops++)
 324 #define IF_QLEN(ifq)            ((ifq)->ifq_len)
 325 #define IF_QEMPTY(ifq)          (IF_QLEN(ifq) == 0)
 326
 327 #define IF_ENQUEUE(ifq, m) do {                                         \
 328         (m)->m_nextpkt = 0;                                             \
 329         if ((ifq)->ifq_tail == 0)                                       \
 330                 (ifq)->ifq_head = m;                                    \
 331         else                                                            \
 332                 (ifq)->ifq_tail->m_nextpkt = m;                         \
 333         (ifq)->ifq_tail = m;                                            \
 334         (ifq)->ifq_len++;                                               \
 335 } while (0)
 336
 337 #define IF_PREPEND(ifq, m) do {                                         \
 338         (m)->m_nextpkt = (ifq)->ifq_head;                               \
 339         if ((ifq)->ifq_tail == 0)                                       \
 340                 (ifq)->ifq_tail = (m);                                  \
 341         (ifq)->ifq_head = (m);                                          \
 342         (ifq)->ifq_len++;                                               \
 343 } while (0)
 344
 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 #ifndef _SYS_SERIALIZE2_H_
 598 #include <sys/serialize2.h>
 599 #endif
 600
 601 enum ifaddr_event {
 602         IFADDR_EVENT_ADD,
 603         IFADDR_EVENT_DELETE,
 604         IFADDR_EVENT_CHANGE
 605 };
 606
 607 /* interface address change event */
 608 typedef void (*ifaddr_event_handler_t)(void *, struct ifnet *,
 609         enum ifaddr_event, struct ifaddr *);
 610 EVENTHANDLER_DECLARE(ifaddr_event, ifaddr_event_handler_t);
 611 /* new interface attach event */
 612 typedef void (*ifnet_attach_event_handler_t)(void *, struct ifnet *);
 613 EVENTHANDLER_DECLARE(ifnet_attach_event, ifnet_attach_event_handler_t);
 614 /* interface detach event */
 615 typedef void (*ifnet_detach_event_handler_t)(void *, struct ifnet *);
 616 EVENTHANDLER_DECLARE(ifnet_detach_event, ifnet_detach_event_handler_t);
 617
 618 /*
 619  * interface groups
 620  */
 621 struct ifg_group {
 622         char                             ifg_group[IFNAMSIZ];
 623         u_int                            ifg_refcnt;
 624         void                            *ifg_pf_kif;
 625         int                              ifg_carp_demoted;
 626         TAILQ_HEAD(, ifg_member)         ifg_members;
 627         TAILQ_ENTRY(ifg_group)           ifg_next;
 628 };
 629
 630 struct ifg_member {
 631         TAILQ_ENTRY(ifg_member)  ifgm_next;
 632         struct ifnet            *ifgm_ifp;
 633 };
 634
 635 struct ifg_list {
 636         struct ifg_group        *ifgl_group;
 637         TAILQ_ENTRY(ifg_list)    ifgl_next;
 638 };
 639
 640 /* group attach event */
 641 typedef void (*group_attach_event_handler_t)(void *, struct ifg_group *);
 642 EVENTHANDLER_DECLARE(group_attach_event, group_attach_event_handler_t);
 643 /* group detach event */
 644 typedef void (*group_detach_event_handler_t)(void *, struct ifg_group *);
 645 EVENTHANDLER_DECLARE(group_detach_event, group_detach_event_handler_t);
 646 /* group change event */
 647 typedef void (*group_change_event_handler_t)(void *, const char *);
 648 EVENTHANDLER_DECLARE(group_change_event, group_change_event_handler_t);
 649
 650
 651 #ifdef INVARIANTS
 652 #define ASSERT_IFAC_VALID(ifac) do { \
 653         KKASSERT((ifac)->ifa_magic == IFA_CONTAINER_MAGIC); \
 654         KKASSERT((ifac)->ifa_refcnt > 0); \
 655 } while (0)
 656 #else
 657 #define ASSERT_IFAC_VALID(ifac) ((void)0)
 658 #endif
 659
 660 static __inline void
 661 _IFAREF(struct ifaddr *_ifa, int _cpu_id)
 662 {
 663         struct ifaddr_container *_ifac = &_ifa->ifa_containers[_cpu_id];
 664
 665         crit_enter();
 666         ASSERT_IFAC_VALID(_ifac);
 667         ++_ifac->ifa_refcnt;
 668         crit_exit();
 669 }
 670
 671 static __inline void
 672 IFAREF(struct ifaddr *_ifa)
 673 {
 674         _IFAREF(_ifa, mycpuid);
 675 }
 676
 677 #include <sys/malloc.h>
 678
 679 MALLOC_DECLARE(M_IFADDR);
 680 MALLOC_DECLARE(M_IFMADDR);
 681 MALLOC_DECLARE(M_IFNET);
 682
 683 void    ifac_free(struct ifaddr_container *, int);
 684
 685 static __inline void
 686 _IFAFREE(struct ifaddr *_ifa, int _cpu_id)
 687 {
 688         struct ifaddr_container *_ifac = &_ifa->ifa_containers[_cpu_id];
 689
 690         crit_enter();
 691         ASSERT_IFAC_VALID(_ifac);
 692         if (--_ifac->ifa_refcnt == 0)
 693                 ifac_free(_ifac, _cpu_id);
 694         crit_exit();
 695 }
 696
 697 static __inline void
 698 IFAFREE(struct ifaddr *_ifa)
 699 {
 700         _IFAFREE(_ifa, mycpuid);
 701 }
 702
 703 struct lwkt_port *ifnet_portfn(int);
 704 int     ifnet_domsg(struct lwkt_msg *, int);
 705 void    ifnet_sendmsg(struct lwkt_msg *, int);
 706 void    ifnet_forwardmsg(struct lwkt_msg *, int);
 707 struct ifnet *ifnet_byindex(unsigned short);
 708
 709 static __inline int
 710 ifa_domsg(struct lwkt_msg *_lmsg, int _cpu)
 711 {
 712         return ifnet_domsg(_lmsg, _cpu);
 713 }
 714
 715 static __inline void
 716 ifa_sendmsg(struct lwkt_msg *_lmsg, int _cpu)
 717 {
 718         ifnet_sendmsg(_lmsg, _cpu);
 719 }
 720
 721 static __inline void
 722 ifa_forwardmsg(struct lwkt_msg *_lmsg, int _nextcpu)
 723 {
 724         ifnet_forwardmsg(_lmsg, _nextcpu);
 725 }
 726
 727 static __inline int
 728 ifnet_serialize_array_index(int _arrcnt, int _txoff, int _rxoff,
 729     enum ifnet_serialize _slz)
 730 {
 731         int _off;
 732
 733         if (_slz == IFNET_SERIALIZE_MAIN) {
 734                 _off = 0;
 735         } else if (_slz & IFNET_SERIALIZE_TX_BASE) {
 736                 _off = (_slz & ~IFNET_SERIALIZE_TX_BASE) + _txoff;
 737                 KASSERT(_off < _arrcnt,
 738                     ("invalid TX serializer %#x", _slz));
 739         } else if (_slz & IFNET_SERIALIZE_RX_BASE) {
 740                 _off = (_slz & ~IFNET_SERIALIZE_RX_BASE) + _rxoff;
 741                 KASSERT(_off < _arrcnt,
 742                     ("invalid RX serializer %#x", _slz));
 743         } else {
 744                 panic("unknown serializer %#x", _slz);
 745         }
 746         return _off;
 747 }
 748
 749 static __inline void
 750 ifnet_serialize_array_enter(lwkt_serialize_t *_arr, int _arrcnt,
 751     int _txoff, int _rxoff, enum ifnet_serialize _slz)
 752 {
 753         int _off;
 754
 755         if (_slz == IFNET_SERIALIZE_ALL) {
 756                 lwkt_serialize_array_enter(_arr, _arrcnt, 0);
 757                 return;
 758         }
 759
 760         _off = ifnet_serialize_array_index(_arrcnt, _txoff, _rxoff, _slz);
 761         lwkt_serialize_enter(_arr[_off]);
 762 }
 763
 764 static __inline void
 765 ifnet_serialize_array_exit(lwkt_serialize_t *_arr, int _arrcnt,
 766     int _txoff, int _rxoff, enum ifnet_serialize _slz)
 767 {
 768         int _off;
 769
 770         if (_slz == IFNET_SERIALIZE_ALL) {
 771                 lwkt_serialize_array_exit(_arr, _arrcnt, 0);
 772                 return;
 773         }
 774
 775         _off = ifnet_serialize_array_index(_arrcnt, _txoff, _rxoff, _slz);
 776         lwkt_serialize_exit(_arr[_off]);
 777 }
 778
 779 static __inline int
 780 ifnet_serialize_array_try(lwkt_serialize_t *_arr, int _arrcnt,
 781     int _txoff, int _rxoff, enum ifnet_serialize _slz)
 782 {
 783         int _off;
 784
 785         if (_slz == IFNET_SERIALIZE_ALL)
 786                 return lwkt_serialize_array_try(_arr, _arrcnt, 0);
 787
 788         _off = ifnet_serialize_array_index(_arrcnt, _txoff, _rxoff, _slz);
 789         return lwkt_serialize_try(_arr[_off]);
 790 }
 791
 792 #ifdef INVARIANTS
 793
 794 static __inline void
 795 ifnet_serialize_array_assert(lwkt_serialize_t *_arr, int _arrcnt,
 796     int _txoff, int _rxoff, enum ifnet_serialize _slz, boolean_t _serialized)
 797 {
 798         int _off;
 799
 800         if (_slz == IFNET_SERIALIZE_ALL) {
 801                 int _i;
 802
 803                 if (_serialized) {
 804                         for (_i = 0; _i < _arrcnt; ++_i)
 805                                 ASSERT_SERIALIZED(_arr[_i]);
 806                 } else {
 807                         for (_i = 0; _i < _arrcnt; ++_i)
 808                                 ASSERT_NOT_SERIALIZED(_arr[_i]);
 809                 }
 810                 return;
 811         }
 812
 813         _off = ifnet_serialize_array_index(_arrcnt, _txoff, _rxoff, _slz);
 814         if (_serialized)
 815                 ASSERT_SERIALIZED(_arr[_off]);
 816         else
 817                 ASSERT_NOT_SERIALIZED(_arr[_off]);
 818 }
 819
 820 #endif  /* INVARIANTS */
 821
 822 #define REINPUT_KEEPRCVIF       0x0001  /* ether_reinput_oncpu() */
 823 #define REINPUT_RUNBPF          0x0002  /* ether_reinput_oncpu() */
 824
 825 extern  struct ifnethead ifnet;
 826 extern struct   ifnet   **ifindex2ifnet;
 827 extern  int ifqmaxlen;
 828 extern  struct ifnet loif[];
 829 extern  int if_index;
 830
 831 void    ether_ifattach(struct ifnet *, uint8_t *, struct lwkt_serialize *);
 832 void    ether_ifattach_bpf(struct ifnet *, uint8_t *, u_int, u_int,
 833                         struct lwkt_serialize *);
 834 void    ether_ifdetach(struct ifnet *);
 835 void    ether_demux(struct mbuf *);
 836 void    ether_demux_oncpu(struct ifnet *, struct mbuf *);
 837 void    ether_reinput_oncpu(struct ifnet *, struct mbuf *, int);
 838 void    ether_input_pkt(struct ifnet *, struct mbuf *, const struct pktinfo *);
 839 int     ether_output_frame(struct ifnet *, struct mbuf *);
 840 int     ether_ioctl(struct ifnet *, u_long, caddr_t);
 841 struct ifnet *ether_bridge_interface(struct ifnet *ifp);
 842 uint32_t        ether_crc32_le(const uint8_t *, size_t);
 843 uint32_t        ether_crc32_be(const uint8_t *, size_t);
 844
 845 int     if_addmulti(struct ifnet *, struct sockaddr *, struct ifmultiaddr **);
 846 int     if_allmulti(struct ifnet *, int);
 847 void    if_attach(struct ifnet *, struct lwkt_serialize *);
 848 int     if_delmulti(struct ifnet *, struct sockaddr *);
 849 void    if_delallmulti(struct ifnet *ifp);
 850 void    if_purgeaddrs_nolink(struct ifnet *);
 851 void    if_detach(struct ifnet *);
 852 void    if_down(struct ifnet *);
 853 void    if_link_state_change(struct ifnet *);
 854 void    if_initname(struct ifnet *, const char *, int);
 855 int     if_getanyethermac(uint16_t *, int);
 856 int     if_printf(struct ifnet *, const char *, ...) __printflike(2, 3);
 857 struct ifnet *if_alloc(uint8_t);
 858 void    if_free(struct ifnet *);
 859 void    if_route(struct ifnet *, int flag, int fam);
 860 int     if_setlladdr(struct ifnet *, const u_char *, int);
 861 void    if_unroute(struct ifnet *, int flag, int fam);
 862 void    if_up(struct ifnet *);
 863 /*void  ifinit(void);*/ /* declared in systm.h for main() */
 864 int     ifioctl(struct socket *, u_long, caddr_t, struct ucred *);
 865 int     ifpromisc(struct ifnet *, int);
 866 struct  ifnet *ifunit(const char *);
 867 struct  ifnet *if_withname(struct sockaddr *);
 868
 869 struct  ifg_group *if_creategroup(const char *);
 870 int     if_addgroup(struct ifnet *, const char *);
 871 int     if_delgroup(struct ifnet *, const char *);
 872 int     if_getgroup(caddr_t, struct ifnet *);
 873 int     if_getgroupmembers(caddr_t);
 874
 875 struct  ifaddr *ifa_ifwithaddr(struct sockaddr *);
 876 struct  ifaddr *ifa_ifwithdstaddr(struct sockaddr *);
 877 struct  ifaddr *ifa_ifwithnet(struct sockaddr *);
 878 struct  ifaddr *ifa_ifwithroute(int, struct sockaddr *, struct sockaddr *);
 879 struct  ifaddr *ifaof_ifpforaddr(struct sockaddr *, struct ifnet *);
 880
 881 typedef void *if_com_alloc_t(u_char type, struct ifnet *ifp);
 882 typedef void if_com_free_t(void *com, u_char type);
 883 void    if_register_com_alloc(u_char, if_com_alloc_t *a, if_com_free_t *);
 884 void    if_deregister_com_alloc(u_char);
 885
 886 void    *ifa_create(int, int);
 887 void    ifa_destroy(struct ifaddr *);
 888 void    ifa_iflink(struct ifaddr *, struct ifnet *, int);
 889 void    ifa_ifunlink(struct ifaddr *, struct ifnet *);
 890
 891 struct ifaddr *ifaddr_byindex(unsigned short);
 892
 893 struct  ifmultiaddr *ifmaof_ifpforaddr(struct sockaddr *, struct ifnet *);
 894 int     if_simloop(struct ifnet *ifp, struct mbuf *m, int af, int hlen);
 895 void    if_devstart(struct ifnet *ifp);
 896 int     if_ring_count2(int cnt, int cnt_max);
 897
 898 #define IF_LLSOCKADDR(ifp)                                              \
 899     ((struct sockaddr_dl *)(ifp)->if_lladdr->ifa_addr)
 900 #define IF_LLADDR(ifp)  LLADDR(IF_LLSOCKADDR(ifp))
 901
 902 #ifdef DEVICE_POLLING
 903 typedef void poll_handler_t (struct ifnet *ifp, enum poll_cmd cmd, int count);
 904 int     ether_poll_register(struct ifnet *);
 905 int     ether_poll_deregister(struct ifnet *);
 906 int     ether_pollcpu_register(struct ifnet *, int);
 907 #endif /* DEVICE_POLLING */
 908
 909 #ifdef IFPOLL_ENABLE
 910 int     ifpoll_register(struct ifnet *);
 911 int     ifpoll_deregister(struct ifnet *);
 912 #endif  /* IFPOLL_ENABLE */
 913
 914 #endif /* _KERNEL */
 915
 916 #endif /* !_NET_IF_VAR_H_ */