sys/net/if_var.h

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