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