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  * 4. Neither the name of the University nor the names of its contributors
  14  *    may be used to endorse or promote products derived from this software
  15  *    without specific prior written permission.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  20  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  27  * SUCH DAMAGE.
  28  *
  29  *      From: @(#)if.h  8.1 (Berkeley) 6/10/93
  30  * $FreeBSD$
  31  */
  32
  33 #ifndef _NET_IF_VAR_H_
  34 #define _NET_IF_VAR_H_
  35
  36 /*
  37  * Structures defining a network interface, providing a packet
  38  * transport mechanism (ala level 0 of the PUP protocols).
  39  *
  40  * Each interface accepts output datagrams of a specified maximum
  41  * length, and provides higher level routines with input datagrams
  42  * received from its medium.
  43  *
  44  * Output occurs when the routine if_output is called, with three parameters:
  45  *      (*ifp->if_output)(ifp, m, dst, rt)
  46  * Here m is the mbuf chain to be sent and dst is the destination address.
  47  * The output routine encapsulates the supplied datagram if necessary,
  48  * and then transmits it on its medium.
  49  *
  50  * On input, each interface unwraps the data received by it, and either
  51  * places it on the input queue of an internetwork datagram routine
  52  * and posts the associated software interrupt, or passes the datagram to a raw
  53  * packet input routine.
  54  *
  55  * Routines exist for locating interfaces by their addresses
  56  * or for locating an interface on a certain network, as well as more general
  57  * routing and gateway routines maintaining information used to locate
  58  * interfaces.  These routines live in the files if.c and route.c
  59  */
  60
  61 struct  rtentry;                /* ifa_rtrequest */
  62 struct  rt_addrinfo;            /* ifa_rtrequest */
  63 struct  socket;
  64 struct  carp_if;
  65 struct  carp_softc;
  66 struct  ifvlantrunk;
  67 struct  route;                  /* if_output */
  68 struct  vnet;
  69 struct  ifmedia;
  70 struct  netmap_adapter;
  71
  72 #ifdef _KERNEL
  73 #include <sys/mbuf.h>           /* ifqueue only? */
  74 #include <sys/buf_ring.h>
  75 #include <net/vnet.h>
  76 #endif /* _KERNEL */
  77 #include <sys/counter.h>
  78 #include <sys/lock.h>           /* XXX */
  79 #include <sys/mutex.h>          /* struct ifqueue */
  80 #include <sys/rwlock.h>         /* XXX */
  81 #include <sys/sx.h>             /* XXX */
  82 #include <sys/_task.h>          /* if_link_task */
  83
  84 #define IF_DUNIT_NONE   -1
  85
  86 #include <altq/if_altq.h>
  87
  88 TAILQ_HEAD(ifnethead, ifnet);   /* we use TAILQs so that the order of */
  89 TAILQ_HEAD(ifaddrhead, ifaddr); /* instantiation is preserved in the list */
  90 TAILQ_HEAD(ifmultihead, ifmultiaddr);
  91 TAILQ_HEAD(ifgrouphead, ifg_group);
  92
  93 #ifdef _KERNEL
  94 VNET_DECLARE(struct pfil_head, link_pfil_hook); /* packet filter hooks */
  95 #define V_link_pfil_hook        VNET(link_pfil_hook)
  96 #endif /* _KERNEL */
  97
  98 typedef enum {
  99         IFCOUNTER_IPACKETS = 1,
 100         IFCOUNTER_IERRORS,
 101         IFCOUNTER_OPACKETS,
 102         IFCOUNTER_OERRORS,
 103         IFCOUNTER_COLLISIONS,
 104         IFCOUNTER_IBYTES,
 105         IFCOUNTER_OBYTES,
 106         IFCOUNTER_IMCASTS,
 107         IFCOUNTER_OMCASTS,
 108         IFCOUNTER_IQDROPS,
 109         IFCOUNTER_OQDROPS,
 110         IFCOUNTER_NOPROTO,
 111 } ifnet_counter;
 112
 113 typedef struct ifnet * if_t;
 114
 115 typedef void (*if_start_fn_t)(if_t);
 116 typedef int (*if_ioctl_fn_t)(if_t, u_long, caddr_t);
 117 typedef void (*if_init_fn_t)(void *);
 118 typedef void (*if_qflush_fn_t)(if_t);
 119 typedef int (*if_transmit_fn_t)(if_t, struct mbuf *);
 120 typedef uint64_t (*if_get_counter_t)(if_t, ifnet_counter);
 121
 122 /*
 123  * Structure defining a network interface.
 124  *
 125  * Size ILP32:  592 (approx)
 126  *       LP64: 1048 (approx)
 127  */
 128 struct ifnet {
 129         /* General book keeping of interface lists. */
 130         TAILQ_ENTRY(ifnet) if_link;     /* all struct ifnets are chained */
 131         LIST_ENTRY(ifnet) if_clones;    /* interfaces of a cloner */
 132         TAILQ_HEAD(, ifg_list) if_groups; /* linked list of groups per if */
 133                                         /* protected by if_addr_lock */
 134         u_char  if_alloctype;           /* if_type at time of allocation */
 135
 136         /* Driver and protocol specific information that remains stable. */
 137         void    *if_softc;              /* pointer to driver state */
 138         void    *if_llsoftc;            /* link layer softc */
 139         void    *if_l2com;              /* pointer to protocol bits */
 140         const char *if_dname;           /* driver name */
 141         int     if_dunit;               /* unit or IF_DUNIT_NONE */
 142         u_short if_index;               /* numeric abbreviation for this if  */
 143         short   if_index_reserved;      /* spare space to grow if_index */
 144         char    if_xname[IFNAMSIZ];     /* external name (name + unit) */
 145         char    *if_description;        /* interface description */
 146
 147         /* Variable fields that are touched by the stack and drivers. */
 148         int     if_flags;               /* up/down, broadcast, etc. */
 149         int     if_drv_flags;           /* driver-managed status flags */
 150         int     if_capabilities;        /* interface features & capabilities */
 151         int     if_capenable;           /* enabled features & capabilities */
 152         void    *if_linkmib;            /* link-type-specific MIB data */
 153         size_t  if_linkmiblen;          /* length of above data */
 154         u_int   if_refcount;            /* reference count */
 155
 156         /* These fields are shared with struct if_data. */
 157         uint8_t         if_type;        /* ethernet, tokenring, etc */
 158         uint8_t         if_addrlen;     /* media address length */
 159         uint8_t         if_hdrlen;      /* media header length */
 160         uint8_t         if_link_state;  /* current link state */
 161         uint32_t        if_mtu;         /* maximum transmission unit */
 162         uint32_t        if_metric;      /* routing metric (external only) */
 163         uint64_t        if_baudrate;    /* linespeed */
 164         uint64_t        if_hwassist;    /* HW offload capabilities, see IFCAP */
 165         time_t          if_epoch;       /* uptime at attach or stat reset */
 166         struct timeval  if_lastchange;  /* time of last administrative change */
 167
 168         struct  ifaltq if_snd;          /* output queue (includes altq) */
 169         struct  task if_linktask;       /* task for link change events */
 170
 171         /* Addresses of different protocol families assigned to this if. */
 172         struct  rwlock if_addr_lock;    /* lock to protect address lists */
 173                 /*
 174                  * if_addrhead is the list of all addresses associated to
 175                  * an interface.
 176                  * Some code in the kernel assumes that first element
 177                  * of the list has type AF_LINK, and contains sockaddr_dl
 178                  * addresses which store the link-level address and the name
 179                  * of the interface.
 180                  * However, access to the AF_LINK address through this
 181                  * field is deprecated. Use if_addr or ifaddr_byindex() instead.
 182                  */
 183         struct  ifaddrhead if_addrhead; /* linked list of addresses per if */
 184         struct  ifmultihead if_multiaddrs; /* multicast addresses configured */
 185         int     if_amcount;             /* number of all-multicast requests */
 186         struct  ifaddr  *if_addr;       /* pointer to link-level address */
 187         const u_int8_t *if_broadcastaddr; /* linklevel broadcast bytestring */
 188         struct  rwlock if_afdata_lock;
 189         void    *if_afdata[AF_MAX];
 190         int     if_afdata_initialized;
 191
 192         /* Additional features hung off the interface. */
 193         u_int   if_fib;                 /* interface FIB */
 194         struct  vnet *if_vnet;          /* pointer to network stack instance */
 195         struct  vnet *if_home_vnet;     /* where this ifnet originates from */
 196         struct  ifvlantrunk *if_vlantrunk; /* pointer to 802.1q data */
 197         struct  bpf_if *if_bpf;         /* packet filter structure */
 198         int     if_pcount;              /* number of promiscuous listeners */
 199         void    *if_bridge;             /* bridge glue */
 200         void    *if_lagg;               /* lagg glue */
 201         void    *if_pf_kif;             /* pf glue */
 202         struct  carp_if *if_carp;       /* carp interface structure */
 203         struct  label *if_label;        /* interface MAC label */
 204         struct  netmap_adapter *if_netmap; /* netmap(4) softc */
 205
 206         /* Various procedures of the layer2 encapsulation and drivers. */
 207         int     (*if_output)            /* output routine (enqueue) */
 208                 (struct ifnet *, struct mbuf *, const struct sockaddr *,
 209                      struct route *);
 210         void    (*if_input)             /* input routine (from h/w driver) */
 211                 (struct ifnet *, struct mbuf *);
 212         if_start_fn_t   if_start;       /* initiate output routine */
 213         if_ioctl_fn_t   if_ioctl;       /* ioctl routine */
 214         if_init_fn_t    if_init;        /* Init routine */
 215         int     (*if_resolvemulti)      /* validate/resolve multicast */
 216                 (struct ifnet *, struct sockaddr **, struct sockaddr *);
 217         if_qflush_fn_t  if_qflush;      /* flush any queue */
 218         if_transmit_fn_t if_transmit;   /* initiate output routine */
 219
 220         void    (*if_reassign)          /* reassign to vnet routine */
 221                 (struct ifnet *, struct vnet *, char *);
 222         if_get_counter_t if_get_counter; /* get counter values */
 223
 224         /* Stuff that's only temporary and doesn't belong here. */
 225         u_int   if_hw_tsomax;           /* tso burst length limit, the minimum
 226                                          * is (IP_MAXPACKET / 8).
 227                                          * XXXAO: Have to find a better place
 228                                          * for it eventually. */
 229         /*
 230          * Old, racy and expensive statistics, should not be used in
 231          * new drivers.
 232          */
 233         uint64_t        if_ipackets;    /* packets received on interface */
 234         uint64_t        if_ierrors;     /* input errors on interface */
 235         uint64_t        if_opackets;    /* packets sent on interface */
 236         uint64_t        if_oerrors;     /* output errors on interface */
 237         uint64_t        if_collisions;  /* collisions on csma interfaces */
 238         uint64_t        if_ibytes;      /* total number of octets received */
 239         uint64_t        if_obytes;      /* total number of octets sent */
 240         uint64_t        if_imcasts;     /* packets received via multicast */
 241         uint64_t        if_omcasts;     /* packets sent via multicast */
 242         uint64_t        if_iqdrops;     /* dropped on input */
 243         uint64_t        if_oqdrops;     /* dropped on output */
 244         uint64_t        if_noproto;     /* destined for unsupported protocol */
 245
 246         /*
 247          * Spare fields to be added before branching a stable branch, so
 248          * that structure can be enhanced without changing the kernel
 249          * binary interface.
 250          */
 251 };
 252
 253 #include <net/ifq.h>    /* XXXAO: temporary unconditional include */
 254
 255 /* for compatibility with other BSDs */
 256 #define if_addrlist     if_addrhead
 257 #define if_list         if_link
 258 #define if_name(ifp)    ((ifp)->if_xname)
 259
 260 /*
 261  * Locks for address lists on the network interface.
 262  */
 263 #define IF_ADDR_LOCK_INIT(if)   rw_init(&(if)->if_addr_lock, "if_addr_lock")
 264 #define IF_ADDR_LOCK_DESTROY(if)        rw_destroy(&(if)->if_addr_lock)
 265 #define IF_ADDR_WLOCK(if)       rw_wlock(&(if)->if_addr_lock)
 266 #define IF_ADDR_WUNLOCK(if)     rw_wunlock(&(if)->if_addr_lock)
 267 #define IF_ADDR_RLOCK(if)       rw_rlock(&(if)->if_addr_lock)
 268 #define IF_ADDR_RUNLOCK(if)     rw_runlock(&(if)->if_addr_lock)
 269 #define IF_ADDR_LOCK_ASSERT(if) rw_assert(&(if)->if_addr_lock, RA_LOCKED)
 270 #define IF_ADDR_WLOCK_ASSERT(if) rw_assert(&(if)->if_addr_lock, RA_WLOCKED)
 271
 272 /*
 273  * Function variations on locking macros intended to be used by loadable
 274  * kernel modules in order to divorce them from the internals of address list
 275  * locking.
 276  */
 277 void    if_addr_rlock(struct ifnet *ifp);       /* if_addrhead */
 278 void    if_addr_runlock(struct ifnet *ifp);     /* if_addrhead */
 279 void    if_maddr_rlock(if_t ifp);       /* if_multiaddrs */
 280 void    if_maddr_runlock(if_t ifp);     /* if_multiaddrs */
 281
 282 #ifdef _KERNEL
 283 #ifdef _SYS_EVENTHANDLER_H_
 284 /* interface link layer address change event */
 285 typedef void (*iflladdr_event_handler_t)(void *, struct ifnet *);
 286 EVENTHANDLER_DECLARE(iflladdr_event, iflladdr_event_handler_t);
 287 /* interface address change event */
 288 typedef void (*ifaddr_event_handler_t)(void *, struct ifnet *);
 289 EVENTHANDLER_DECLARE(ifaddr_event, ifaddr_event_handler_t);
 290 /* new interface arrival event */
 291 typedef void (*ifnet_arrival_event_handler_t)(void *, struct ifnet *);
 292 EVENTHANDLER_DECLARE(ifnet_arrival_event, ifnet_arrival_event_handler_t);
 293 /* interface departure event */
 294 typedef void (*ifnet_departure_event_handler_t)(void *, struct ifnet *);
 295 EVENTHANDLER_DECLARE(ifnet_departure_event, ifnet_departure_event_handler_t);
 296 /* Interface link state change event */
 297 typedef void (*ifnet_link_event_handler_t)(void *, struct ifnet *, int);
 298 EVENTHANDLER_DECLARE(ifnet_link_event, ifnet_link_event_handler_t);
 299 #endif /* _SYS_EVENTHANDLER_H_ */
 300
 301 /*
 302  * interface groups
 303  */
 304 struct ifg_group {
 305         char                             ifg_group[IFNAMSIZ];
 306         u_int                            ifg_refcnt;
 307         void                            *ifg_pf_kif;
 308         TAILQ_HEAD(, ifg_member)         ifg_members;
 309         TAILQ_ENTRY(ifg_group)           ifg_next;
 310 };
 311
 312 struct ifg_member {
 313         TAILQ_ENTRY(ifg_member)  ifgm_next;
 314         struct ifnet            *ifgm_ifp;
 315 };
 316
 317 struct ifg_list {
 318         struct ifg_group        *ifgl_group;
 319         TAILQ_ENTRY(ifg_list)    ifgl_next;
 320 };
 321
 322 #ifdef _SYS_EVENTHANDLER_H_
 323 /* group attach event */
 324 typedef void (*group_attach_event_handler_t)(void *, struct ifg_group *);
 325 EVENTHANDLER_DECLARE(group_attach_event, group_attach_event_handler_t);
 326 /* group detach event */
 327 typedef void (*group_detach_event_handler_t)(void *, struct ifg_group *);
 328 EVENTHANDLER_DECLARE(group_detach_event, group_detach_event_handler_t);
 329 /* group change event */
 330 typedef void (*group_change_event_handler_t)(void *, const char *);
 331 EVENTHANDLER_DECLARE(group_change_event, group_change_event_handler_t);
 332 #endif /* _SYS_EVENTHANDLER_H_ */
 333
 334 #define IF_AFDATA_LOCK_INIT(ifp)        \
 335         rw_init(&(ifp)->if_afdata_lock, "if_afdata")
 336
 337 #define IF_AFDATA_WLOCK(ifp)    rw_wlock(&(ifp)->if_afdata_lock)
 338 #define IF_AFDATA_RLOCK(ifp)    rw_rlock(&(ifp)->if_afdata_lock)
 339 #define IF_AFDATA_WUNLOCK(ifp)  rw_wunlock(&(ifp)->if_afdata_lock)
 340 #define IF_AFDATA_RUNLOCK(ifp)  rw_runlock(&(ifp)->if_afdata_lock)
 341 #define IF_AFDATA_LOCK(ifp)     IF_AFDATA_WLOCK(ifp)
 342 #define IF_AFDATA_UNLOCK(ifp)   IF_AFDATA_WUNLOCK(ifp)
 343 #define IF_AFDATA_TRYLOCK(ifp)  rw_try_wlock(&(ifp)->if_afdata_lock)
 344 #define IF_AFDATA_DESTROY(ifp)  rw_destroy(&(ifp)->if_afdata_lock)
 345
 346 #define IF_AFDATA_LOCK_ASSERT(ifp)      rw_assert(&(ifp)->if_afdata_lock, RA_LOCKED)
 347 #define IF_AFDATA_RLOCK_ASSERT(ifp)     rw_assert(&(ifp)->if_afdata_lock, RA_RLOCKED)
 348 #define IF_AFDATA_WLOCK_ASSERT(ifp)     rw_assert(&(ifp)->if_afdata_lock, RA_WLOCKED)
 349 #define IF_AFDATA_UNLOCK_ASSERT(ifp)    rw_assert(&(ifp)->if_afdata_lock, RA_UNLOCKED)
 350
 351 /*
 352  * 72 was chosen below because it is the size of a TCP/IP
 353  * header (40) + the minimum mss (32).
 354  */
 355 #define IF_MINMTU       72
 356 #define IF_MAXMTU       65535
 357
 358 #define TOEDEV(ifp)     ((ifp)->if_llsoftc)
 359
 360 #endif /* _KERNEL */
 361
 362 /*
 363  * The ifaddr structure contains information about one address
 364  * of an interface.  They are maintained by the different address families,
 365  * are allocated and attached when an address is set, and are linked
 366  * together so all addresses for an interface can be located.
 367  *
 368  * NOTE: a 'struct ifaddr' is always at the beginning of a larger
 369  * chunk of malloc'ed memory, where we store the three addresses
 370  * (ifa_addr, ifa_dstaddr and ifa_netmask) referenced here.
 371  */
 372 #if defined(_KERNEL) || defined(_WANT_IFADDR)
 373 struct ifaddr {
 374         struct  sockaddr *ifa_addr;     /* address of interface */
 375         struct  sockaddr *ifa_dstaddr;  /* other end of p-to-p link */
 376 #define ifa_broadaddr   ifa_dstaddr     /* broadcast address interface */
 377         struct  sockaddr *ifa_netmask;  /* used to determine subnet */
 378         struct  ifnet *ifa_ifp;         /* back-pointer to interface */
 379         struct  carp_softc *ifa_carp;   /* pointer to CARP data */
 380         TAILQ_ENTRY(ifaddr) ifa_link;   /* queue macro glue */
 381         void    (*ifa_rtrequest)        /* check or clean routes (+ or -)'d */
 382                 (int, struct rtentry *, struct rt_addrinfo *);
 383         u_short ifa_flags;              /* mostly rt_flags for cloning */
 384         u_int   ifa_refcnt;             /* references to this structure */
 385
 386         counter_u64_t   ifa_ipackets;
 387         counter_u64_t   ifa_opackets;
 388         counter_u64_t   ifa_ibytes;
 389         counter_u64_t   ifa_obytes;
 390 };
 391 #endif
 392
 393 #ifdef _KERNEL
 394 #define IFA_ROUTE       RTF_UP          /* route installed */
 395 #define IFA_RTSELF      RTF_HOST        /* loopback route to self installed */
 396
 397 /* For compatibility with other BSDs. SCTP uses it. */
 398 #define ifa_list        ifa_link
 399
 400 struct ifaddr * ifa_alloc(size_t size, int flags);
 401 void    ifa_free(struct ifaddr *ifa);
 402 void    ifa_ref(struct ifaddr *ifa);
 403 #endif /* _KERNEL */
 404
 405 /*
 406  * Multicast address structure.  This is analogous to the ifaddr
 407  * structure except that it keeps track of multicast addresses.
 408  */
 409 struct ifmultiaddr {
 410         TAILQ_ENTRY(ifmultiaddr) ifma_link; /* queue macro glue */
 411         struct  sockaddr *ifma_addr;    /* address this membership is for */
 412         struct  sockaddr *ifma_lladdr;  /* link-layer translation, if any */
 413         struct  ifnet *ifma_ifp;        /* back-pointer to interface */
 414         u_int   ifma_refcount;          /* reference count */
 415         void    *ifma_protospec;        /* protocol-specific state, if any */
 416         struct  ifmultiaddr *ifma_llifma; /* pointer to ifma for ifma_lladdr */
 417 };
 418
 419 #ifdef _KERNEL
 420
 421 extern  struct rwlock ifnet_rwlock;
 422 extern  struct sx ifnet_sxlock;
 423
 424 #define IFNET_LOCK_INIT() do {                                          \
 425         rw_init_flags(&ifnet_rwlock, "ifnet_rw",  RW_RECURSE);          \
 426         sx_init_flags(&ifnet_sxlock, "ifnet_sx",  SX_RECURSE);          \
 427 } while(0)
 428
 429 #define IFNET_WLOCK() do {                                              \
 430         sx_xlock(&ifnet_sxlock);                                        \
 431         rw_wlock(&ifnet_rwlock);                                        \
 432 } while (0)
 433
 434 #define IFNET_WUNLOCK() do {                                            \
 435         rw_wunlock(&ifnet_rwlock);                                      \
 436         sx_xunlock(&ifnet_sxlock);                                      \
 437 } while (0)
 438
 439 /*
 440  * To assert the ifnet lock, you must know not only whether it's for read or
 441  * write, but also whether it was acquired with sleep support or not.
 442  */
 443 #define IFNET_RLOCK_ASSERT()            sx_assert(&ifnet_sxlock, SA_SLOCKED)
 444 #define IFNET_RLOCK_NOSLEEP_ASSERT()    rw_assert(&ifnet_rwlock, RA_RLOCKED)
 445 #define IFNET_WLOCK_ASSERT() do {                                       \
 446         sx_assert(&ifnet_sxlock, SA_XLOCKED);                           \
 447         rw_assert(&ifnet_rwlock, RA_WLOCKED);                           \
 448 } while (0)
 449
 450 #define IFNET_RLOCK()           sx_slock(&ifnet_sxlock)
 451 #define IFNET_RLOCK_NOSLEEP()   rw_rlock(&ifnet_rwlock)
 452 #define IFNET_RUNLOCK()         sx_sunlock(&ifnet_sxlock)
 453 #define IFNET_RUNLOCK_NOSLEEP() rw_runlock(&ifnet_rwlock)
 454
 455 /*
 456  * Look up an ifnet given its index; the _ref variant also acquires a
 457  * reference that must be freed using if_rele().  It is almost always a bug
 458  * to call ifnet_byindex() instead if ifnet_byindex_ref().
 459  */
 460 struct ifnet    *ifnet_byindex(u_short idx);
 461 struct ifnet    *ifnet_byindex_locked(u_short idx);
 462 struct ifnet    *ifnet_byindex_ref(u_short idx);
 463
 464 /*
 465  * Given the index, ifaddr_byindex() returns the one and only
 466  * link-level ifaddr for the interface. You are not supposed to use
 467  * it to traverse the list of addresses associated to the interface.
 468  */
 469 struct ifaddr   *ifaddr_byindex(u_short idx);
 470
 471 VNET_DECLARE(struct ifnethead, ifnet);
 472 VNET_DECLARE(struct ifgrouphead, ifg_head);
 473 VNET_DECLARE(int, if_index);
 474 VNET_DECLARE(struct ifnet *, loif);     /* first loopback interface */
 475
 476 #define V_ifnet         VNET(ifnet)
 477 #define V_ifg_head      VNET(ifg_head)
 478 #define V_if_index      VNET(if_index)
 479 #define V_loif          VNET(loif)
 480
 481 int     if_addgroup(struct ifnet *, const char *);
 482 int     if_delgroup(struct ifnet *, const char *);
 483 int     if_addmulti(struct ifnet *, struct sockaddr *, struct ifmultiaddr **);
 484 int     if_allmulti(struct ifnet *, int);
 485 struct  ifnet* if_alloc(u_char);
 486 void    if_attach(struct ifnet *);
 487 void    if_dead(struct ifnet *);
 488 int     if_delmulti(struct ifnet *, struct sockaddr *);
 489 void    if_delmulti_ifma(struct ifmultiaddr *);
 490 void    if_detach(struct ifnet *);
 491 void    if_vmove(struct ifnet *, struct vnet *);
 492 void    if_purgeaddrs(struct ifnet *);
 493 void    if_delallmulti(struct ifnet *);
 494 void    if_down(struct ifnet *);
 495 struct ifmultiaddr *
 496         if_findmulti(struct ifnet *, struct sockaddr *);
 497 void    if_free(struct ifnet *);
 498 void    if_initname(struct ifnet *, const char *, int);
 499 void    if_link_state_change(struct ifnet *, int);
 500 int     if_printf(struct ifnet *, const char *, ...) __printflike(2, 3);
 501 void    if_ref(struct ifnet *);
 502 void    if_rele(struct ifnet *);
 503 int     if_setlladdr(struct ifnet *, const u_char *, int);
 504 void    if_up(struct ifnet *);
 505 int     ifioctl(struct socket *, u_long, caddr_t, struct thread *);
 506 int     ifpromisc(struct ifnet *, int);
 507 struct  ifnet *ifunit(const char *);
 508 struct  ifnet *ifunit_ref(const char *);
 509
 510 int     ifa_add_loopback_route(struct ifaddr *, struct sockaddr *);
 511 int     ifa_del_loopback_route(struct ifaddr *, struct sockaddr *);
 512 int     ifa_switch_loopback_route(struct ifaddr *, struct sockaddr *, int fib);
 513
 514 struct  ifaddr *ifa_ifwithaddr(struct sockaddr *);
 515 int             ifa_ifwithaddr_check(struct sockaddr *);
 516 struct  ifaddr *ifa_ifwithbroadaddr(struct sockaddr *, int);
 517 struct  ifaddr *ifa_ifwithdstaddr(struct sockaddr *, int);
 518 struct  ifaddr *ifa_ifwithnet(struct sockaddr *, int, int);
 519 struct  ifaddr *ifa_ifwithroute(int, struct sockaddr *, struct sockaddr *, u_int);
 520 struct  ifaddr *ifaof_ifpforaddr(struct sockaddr *, struct ifnet *);
 521 int     ifa_preferred(struct ifaddr *, struct ifaddr *);
 522
 523 int     if_simloop(struct ifnet *ifp, struct mbuf *m, int af, int hlen);
 524
 525 typedef void *if_com_alloc_t(u_char type, struct ifnet *ifp);
 526 typedef void if_com_free_t(void *com, u_char type);
 527 void    if_register_com_alloc(u_char type, if_com_alloc_t *a, if_com_free_t *f);
 528 void    if_deregister_com_alloc(u_char type);
 529 void    if_data_copy(struct ifnet *, struct if_data *);
 530 uint64_t if_get_counter_default(struct ifnet *, ifnet_counter);
 531 void    if_inc_counter(struct ifnet *, ifnet_counter, int64_t);
 532
 533 #define IF_LLADDR(ifp)                                                  \
 534     LLADDR((struct sockaddr_dl *)((ifp)->if_addr->ifa_addr))
 535
 536 uint64_t if_setbaudrate(if_t ifp, uint64_t baudrate);
 537 uint64_t if_getbaudrate(if_t ifp);
 538 int if_setcapabilities(if_t ifp, int capabilities);
 539 int if_setcapabilitiesbit(if_t ifp, int setbit, int clearbit);
 540 int if_getcapabilities(if_t ifp);
 541 int if_togglecapenable(if_t ifp, int togglecap);
 542 int if_setcapenable(if_t ifp, int capenable);
 543 int if_setcapenablebit(if_t ifp, int setcap, int clearcap);
 544 int if_getcapenable(if_t ifp);
 545 const char *if_getdname(if_t ifp);
 546 int if_setdev(if_t ifp, void *dev);
 547 int if_setdrvflagbits(if_t ifp, int if_setflags, int clear_flags);
 548 int if_getdrvflags(if_t ifp);
 549 int if_setdrvflags(if_t ifp, int flags);
 550 int if_clearhwassist(if_t ifp);
 551 int if_sethwassistbits(if_t ifp, int toset, int toclear);
 552 int if_sethwassist(if_t ifp, int hwassist_bit);
 553 int if_gethwassist(if_t ifp);
 554 int if_setsoftc(if_t ifp, void *softc);
 555 void *if_getsoftc(if_t ifp);
 556 int if_setflags(if_t ifp, int flags);
 557 int if_setmtu(if_t ifp, int mtu);
 558 int if_getmtu(if_t ifp);
 559 int if_setflagbits(if_t ifp, int set, int clear);
 560 int if_getflags(if_t ifp);
 561 int if_sendq_empty(if_t ifp);
 562 int if_setsendqready(if_t ifp);
 563 int if_setsendqlen(if_t ifp, int tx_desc_count);
 564 int if_input(if_t ifp, struct mbuf* sendmp);
 565 int if_sendq_prepend(if_t ifp, struct mbuf *m);
 566 struct mbuf *if_dequeue(if_t ifp);
 567 int if_setifheaderlen(if_t ifp, int len);
 568 void if_setrcvif(struct mbuf *m, if_t ifp);
 569 void if_setvtag(struct mbuf *m, u_int16_t tag);
 570 u_int16_t if_getvtag(struct mbuf *m);
 571 int if_vlantrunkinuse(if_t ifp);
 572 caddr_t if_getlladdr(if_t ifp);
 573 void *if_gethandle(u_char);
 574 void if_bpfmtap(if_t ifp, struct mbuf *m);
 575 void if_etherbpfmtap(if_t ifp, struct mbuf *m);
 576 void if_vlancap(if_t ifp);
 577
 578 int if_setupmultiaddr(if_t ifp, void *mta, int *cnt, int max);
 579 int if_multiaddr_array(if_t ifp, void *mta, int *cnt, int max);
 580 int if_multiaddr_count(if_t ifp, int max);
 581
 582 int if_getamcount(if_t ifp);
 583 struct ifaddr * if_getifaddr(if_t ifp);
 584
 585 /* Statistics */
 586
 587 int if_incipackets(if_t ifp, int pkt);
 588 int if_incopackets(if_t ifp, int pkts);
 589 int if_incierrors(if_t ifp, int ierrors);
 590 int if_incoerrors(if_t ifp, int oerrors);
 591 int if_inciqdrops(if_t ifp, int val);
 592 int if_setierrors(if_t ifp, int ierrors);
 593 int if_setoerrors(if_t ifp, int oerrors);
 594 int if_setcollisions(if_t ifp, int collisions);
 595 int if_inccollisions(if_t ifp, int collisions);
 596 int if_incobytes(if_t ifp, int bytes);
 597 int if_getiqdrops(if_t ifp);
 598 int if_incimcasts(if_t ifp, int imcasts);
 599 int if_incomcasts(if_t ifp, int imcasts);
 600 int if_setipackets(if_t ifp, int pkts);
 601 int if_setopackets(if_t ifp, int pkts);
 602 int if_setibytes(if_t ifp, int bytes);
 603 int if_setobytes(if_t ifp, int bytes);
 604 int if_setimcasts(if_t ifp, int pkts);
 605
 606 /* Functions */
 607 void if_setinitfn(if_t ifp, void (*)(void *));
 608 void if_setioctlfn(if_t ifp, int (*)(if_t, u_long, caddr_t));
 609 void if_setstartfn(if_t ifp, void (*)(if_t));
 610 void if_settransmitfn(if_t ifp, if_transmit_fn_t);
 611 void if_setqflushfn(if_t ifp, if_qflush_fn_t);
 612 void if_setgetcounterfn(if_t ifp, if_get_counter_t);
 613
 614 /* Revisit the below. These are inline functions originally */
 615 int drbr_inuse_drv(if_t ifp, struct buf_ring *br);
 616 struct mbuf* drbr_dequeue_drv(if_t ifp, struct buf_ring *br);
 617 int drbr_needs_enqueue_drv(if_t ifp, struct buf_ring *br);
 618 int drbr_enqueue_drv(if_t ifp, struct buf_ring *br, struct mbuf *m);
 619
 620 #endif /* _KERNEL */
 621 #endif /* !_NET_IF_VAR_H_ */