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