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
  71 #ifdef _KERNEL
  72 #include <sys/mbuf.h>           /* ifqueue only? */
  73 #include <sys/buf_ring.h>
  74 #include <net/vnet.h>
  75 #endif /* _KERNEL */
  76 #include <sys/counter.h>
  77 #include <sys/lock.h>           /* XXX */
  78 #include <sys/mutex.h>          /* struct ifqueue */
  79 #include <sys/rwlock.h>         /* XXX */
  80 #include <sys/sx.h>             /* XXX */
  81 #include <sys/_task.h>          /* if_link_task */
  82
  83 #define IF_DUNIT_NONE   -1
  84
  85 #include <altq/if_altq.h>
  86
  87 TAILQ_HEAD(ifnethead, ifnet);   /* we use TAILQs so that the order of */
  88 TAILQ_HEAD(ifaddrhead, ifaddr); /* instantiation is preserved in the list */
  89 TAILQ_HEAD(ifmultihead, ifmultiaddr);
  90 TAILQ_HEAD(ifgrouphead, ifg_group);
  91
  92 #ifdef _KERNEL
  93 VNET_DECLARE(struct pfil_head, link_pfil_hook); /* packet filter hooks */
  94 #define V_link_pfil_hook        VNET(link_pfil_hook)
  95 #endif /* _KERNEL */
  96
  97 typedef void (*if_start_fn_t)(struct ifnet *);
  98 typedef int (*if_ioctl_fn_t)(struct ifnet *, u_long, caddr_t);
  99 typedef void (*if_init_fn_t)(void *);
 100 typedef void (*if_qflush_fn_t)(struct ifnet *);
 101 typedef int (*if_transmit_fn_t)(struct ifnet *, struct mbuf *);
 102
 103 /* Opaque object pointing to interface structure (ifnet) */
 104 typedef void *if_t;
 105
 106 /*
 107  * Structure defining a network interface.
 108  *
 109  * Size ILP32:  592 (approx)
 110  *       LP64: 1048 (approx)
 111  */
 112 struct ifnet {
 113         /* General book keeping of interface lists. */
 114         TAILQ_ENTRY(ifnet) if_link;     /* all struct ifnets are chained */
 115         LIST_ENTRY(ifnet) if_clones;    /* interfaces of a cloner */
 116         TAILQ_HEAD(, ifg_list) if_groups; /* linked list of groups per if */
 117                                         /* protected by if_addr_lock */
 118         u_char  if_alloctype;           /* if_type at time of allocation */
 119
 120         /* Driver and protocol specific information that remains stable. */
 121         void    *if_softc;              /* pointer to driver state */
 122         void    *if_llsoftc;            /* link layer softc */
 123         void    *if_l2com;              /* pointer to protocol bits */
 124         const char *if_dname;           /* driver name */
 125         int     if_dunit;               /* unit or IF_DUNIT_NONE */
 126         u_short if_index;               /* numeric abbreviation for this if  */
 127         short   if_index_reserved;      /* spare space to grow if_index */
 128         char    if_xname[IFNAMSIZ];     /* external name (name + unit) */
 129         char    *if_description;        /* interface description */
 130
 131         /* Variable fields that are touched by the stack and drivers. */
 132         int     if_flags;               /* up/down, broadcast, etc. */
 133         int     if_capabilities;        /* interface features & capabilities */
 134         int     if_capenable;           /* enabled features & capabilities */
 135         void    *if_linkmib;            /* link-type-specific MIB data */
 136         size_t  if_linkmiblen;          /* length of above data */
 137         int     if_drv_flags;           /* driver-managed status flags */
 138         u_int   if_refcount;            /* reference count */
 139         struct  ifaltq if_snd;          /* output queue (includes altq) */
 140         struct  if_data if_data;        /* type information and statistics */
 141         struct  task if_linktask;       /* task for link change events */
 142
 143         /* Addresses of different protocol families assigned to this if. */
 144         struct  rwlock if_addr_lock;    /* lock to protect address lists */
 145                 /*
 146                  * if_addrhead is the list of all addresses associated to
 147                  * an interface.
 148                  * Some code in the kernel assumes that first element
 149                  * of the list has type AF_LINK, and contains sockaddr_dl
 150                  * addresses which store the link-level address and the name
 151                  * of the interface.
 152                  * However, access to the AF_LINK address through this
 153                  * field is deprecated. Use if_addr or ifaddr_byindex() instead.
 154                  */
 155         struct  ifaddrhead if_addrhead; /* linked list of addresses per if */
 156         struct  ifmultihead if_multiaddrs; /* multicast addresses configured */
 157         int     if_amcount;             /* number of all-multicast requests */
 158         struct  ifaddr  *if_addr;       /* pointer to link-level address */
 159         const u_int8_t *if_broadcastaddr; /* linklevel broadcast bytestring */
 160         struct  rwlock if_afdata_lock;
 161         void    *if_afdata[AF_MAX];
 162         int     if_afdata_initialized;
 163
 164         /* Additional features hung off the interface. */
 165         u_int   if_fib;                 /* interface FIB */
 166         struct  vnet *if_vnet;          /* pointer to network stack instance */
 167         struct  vnet *if_home_vnet;     /* where this ifnet originates from */
 168         struct  ifvlantrunk *if_vlantrunk; /* pointer to 802.1q data */
 169         struct  bpf_if *if_bpf;         /* packet filter structure */
 170         int     if_pcount;              /* number of promiscuous listeners */
 171         void    *if_bridge;             /* bridge glue */
 172         void    *if_lagg;               /* lagg glue */
 173         void    *if_pf_kif;             /* pf glue */
 174         struct  carp_if *if_carp;       /* carp interface structure */
 175         struct  label *if_label;        /* interface MAC label */
 176
 177         /* Various procedures of the layer2 encapsulation and drivers. */
 178         int     (*if_output)            /* output routine (enqueue) */
 179                 (struct ifnet *, struct mbuf *, const struct sockaddr *,
 180                      struct route *);
 181         void    (*if_input)             /* input routine (from h/w driver) */
 182                 (struct ifnet *, struct mbuf *);
 183         if_start_fn_t   if_start;       /* initiate output routine */
 184         if_ioctl_fn_t   if_ioctl;       /* ioctl routine */
 185         if_init_fn_t    if_init;        /* Init routine */
 186         int     (*if_resolvemulti)      /* validate/resolve multicast */
 187                 (struct ifnet *, struct sockaddr **, struct sockaddr *);
 188         if_qflush_fn_t  if_qflush;      /* flush any queue */
 189         if_transmit_fn_t if_transmit;   /* initiate output routine */
 190
 191         void    (*if_reassign)          /* reassign to vnet routine */
 192                 (struct ifnet *, struct vnet *, char *);
 193
 194         /* Stuff that's only temporary and doesn't belong here. */
 195         u_int   if_hw_tsomax;           /* tso burst length limit, the minimum
 196                                          * is (IP_MAXPACKET / 8).
 197                                          * XXXAO: Have to find a better place
 198                                          * for it eventually. */
 199         /*
 200          * Spare fields are added so that we can modify sensitive data
 201          * structures without changing the kernel binary interface, and must
 202          * be used with care where binary compatibility is required.
 203          */
 204         char    if_cspare[3];
 205         int     if_ispare[4];
 206         void    *if_unused[2];
 207         void    *if_pspare[8];          /* 1 netmap, 7 TDB */
 208 };
 209
 210 #include <net/ifq.h>    /* XXXAO: temporary unconditional include */
 211
 212 /*
 213  * XXX These aliases are terribly dangerous because they could apply
 214  * to anything.
 215  */
 216 #define if_mtu          if_data.ifi_mtu
 217 #define if_type         if_data.ifi_type
 218 #define if_physical     if_data.ifi_physical
 219 #define if_addrlen      if_data.ifi_addrlen
 220 #define if_hdrlen       if_data.ifi_hdrlen
 221 #define if_metric       if_data.ifi_metric
 222 #define if_link_state   if_data.ifi_link_state
 223 #define if_baudrate     if_data.ifi_baudrate
 224 #define if_hwassist     if_data.ifi_hwassist
 225 #define if_ipackets     if_data.ifi_ipackets
 226 #define if_ierrors      if_data.ifi_ierrors
 227 #define if_opackets     if_data.ifi_opackets
 228 #define if_oerrors      if_data.ifi_oerrors
 229 #define if_collisions   if_data.ifi_collisions
 230 #define if_ibytes       if_data.ifi_ibytes
 231 #define if_obytes       if_data.ifi_obytes
 232 #define if_imcasts      if_data.ifi_imcasts
 233 #define if_omcasts      if_data.ifi_omcasts
 234 #define if_iqdrops      if_data.ifi_iqdrops
 235 #define if_oqdrops      if_data.ifi_oqdrops
 236 #define if_noproto      if_data.ifi_noproto
 237 #define if_lastchange   if_data.ifi_lastchange
 238
 239 /* for compatibility with other BSDs */
 240 #define if_addrlist     if_addrhead
 241 #define if_list         if_link
 242 #define if_name(ifp)    ((ifp)->if_xname)
 243
 244 /*
 245  * Locks for address lists on the network interface.
 246  */
 247 #define IF_ADDR_LOCK_INIT(if)   rw_init(&(if)->if_addr_lock, "if_addr_lock")
 248 #define IF_ADDR_LOCK_DESTROY(if)        rw_destroy(&(if)->if_addr_lock)
 249 #define IF_ADDR_WLOCK(if)       rw_wlock(&(if)->if_addr_lock)
 250 #define IF_ADDR_WUNLOCK(if)     rw_wunlock(&(if)->if_addr_lock)
 251 #define IF_ADDR_RLOCK(if)       rw_rlock(&(if)->if_addr_lock)
 252 #define IF_ADDR_RUNLOCK(if)     rw_runlock(&(if)->if_addr_lock)
 253 #define IF_ADDR_LOCK_ASSERT(if) rw_assert(&(if)->if_addr_lock, RA_LOCKED)
 254 #define IF_ADDR_WLOCK_ASSERT(if) rw_assert(&(if)->if_addr_lock, RA_WLOCKED)
 255
 256 /*
 257  * Function variations on locking macros intended to be used by loadable
 258  * kernel modules in order to divorce them from the internals of address list
 259  * locking.
 260  */
 261 void    if_addr_rlock(struct ifnet *ifp);       /* if_addrhead */
 262 void    if_addr_runlock(struct ifnet *ifp);     /* if_addrhead */
 263 void    if_maddr_rlock(if_t ifp);       /* if_multiaddrs */
 264 void    if_maddr_runlock(if_t ifp);     /* if_multiaddrs */
 265
 266 #ifdef _KERNEL
 267 #ifdef _SYS_EVENTHANDLER_H_
 268 /* interface link layer address change event */
 269 typedef void (*iflladdr_event_handler_t)(void *, struct ifnet *);
 270 EVENTHANDLER_DECLARE(iflladdr_event, iflladdr_event_handler_t);
 271 /* interface address change event */
 272 typedef void (*ifaddr_event_handler_t)(void *, struct ifnet *);
 273 EVENTHANDLER_DECLARE(ifaddr_event, ifaddr_event_handler_t);
 274 /* new interface arrival event */
 275 typedef void (*ifnet_arrival_event_handler_t)(void *, struct ifnet *);
 276 EVENTHANDLER_DECLARE(ifnet_arrival_event, ifnet_arrival_event_handler_t);
 277 /* interface departure event */
 278 typedef void (*ifnet_departure_event_handler_t)(void *, struct ifnet *);
 279 EVENTHANDLER_DECLARE(ifnet_departure_event, ifnet_departure_event_handler_t);
 280 /* Interface link state change event */
 281 typedef void (*ifnet_link_event_handler_t)(void *, struct ifnet *, int);
 282 EVENTHANDLER_DECLARE(ifnet_link_event, ifnet_link_event_handler_t);
 283 #endif /* _SYS_EVENTHANDLER_H_ */
 284
 285 /*
 286  * interface groups
 287  */
 288 struct ifg_group {
 289         char                             ifg_group[IFNAMSIZ];
 290         u_int                            ifg_refcnt;
 291         void                            *ifg_pf_kif;
 292         TAILQ_HEAD(, ifg_member)         ifg_members;
 293         TAILQ_ENTRY(ifg_group)           ifg_next;
 294 };
 295
 296 struct ifg_member {
 297         TAILQ_ENTRY(ifg_member)  ifgm_next;
 298         struct ifnet            *ifgm_ifp;
 299 };
 300
 301 struct ifg_list {
 302         struct ifg_group        *ifgl_group;
 303         TAILQ_ENTRY(ifg_list)    ifgl_next;
 304 };
 305
 306 #ifdef _SYS_EVENTHANDLER_H_
 307 /* group attach event */
 308 typedef void (*group_attach_event_handler_t)(void *, struct ifg_group *);
 309 EVENTHANDLER_DECLARE(group_attach_event, group_attach_event_handler_t);
 310 /* group detach event */
 311 typedef void (*group_detach_event_handler_t)(void *, struct ifg_group *);
 312 EVENTHANDLER_DECLARE(group_detach_event, group_detach_event_handler_t);
 313 /* group change event */
 314 typedef void (*group_change_event_handler_t)(void *, const char *);
 315 EVENTHANDLER_DECLARE(group_change_event, group_change_event_handler_t);
 316 #endif /* _SYS_EVENTHANDLER_H_ */
 317
 318 #define IF_AFDATA_LOCK_INIT(ifp)        \
 319         rw_init(&(ifp)->if_afdata_lock, "if_afdata")
 320
 321 #define IF_AFDATA_WLOCK(ifp)    rw_wlock(&(ifp)->if_afdata_lock)
 322 #define IF_AFDATA_RLOCK(ifp)    rw_rlock(&(ifp)->if_afdata_lock)
 323 #define IF_AFDATA_WUNLOCK(ifp)  rw_wunlock(&(ifp)->if_afdata_lock)
 324 #define IF_AFDATA_RUNLOCK(ifp)  rw_runlock(&(ifp)->if_afdata_lock)
 325 #define IF_AFDATA_LOCK(ifp)     IF_AFDATA_WLOCK(ifp)
 326 #define IF_AFDATA_UNLOCK(ifp)   IF_AFDATA_WUNLOCK(ifp)
 327 #define IF_AFDATA_TRYLOCK(ifp)  rw_try_wlock(&(ifp)->if_afdata_lock)
 328 #define IF_AFDATA_DESTROY(ifp)  rw_destroy(&(ifp)->if_afdata_lock)
 329
 330 #define IF_AFDATA_LOCK_ASSERT(ifp)      rw_assert(&(ifp)->if_afdata_lock, RA_LOCKED)
 331 #define IF_AFDATA_RLOCK_ASSERT(ifp)     rw_assert(&(ifp)->if_afdata_lock, RA_RLOCKED)
 332 #define IF_AFDATA_WLOCK_ASSERT(ifp)     rw_assert(&(ifp)->if_afdata_lock, RA_WLOCKED)
 333 #define IF_AFDATA_UNLOCK_ASSERT(ifp)    rw_assert(&(ifp)->if_afdata_lock, RA_UNLOCKED)
 334
 335 /*
 336  * 72 was chosen below because it is the size of a TCP/IP
 337  * header (40) + the minimum mss (32).
 338  */
 339 #define IF_MINMTU       72
 340 #define IF_MAXMTU       65535
 341
 342 #define TOEDEV(ifp)     ((ifp)->if_llsoftc)
 343
 344 #endif /* _KERNEL */
 345
 346 /*
 347  * The ifaddr structure contains information about one address
 348  * of an interface.  They are maintained by the different address families,
 349  * are allocated and attached when an address is set, and are linked
 350  * together so all addresses for an interface can be located.
 351  *
 352  * NOTE: a 'struct ifaddr' is always at the beginning of a larger
 353  * chunk of malloc'ed memory, where we store the three addresses
 354  * (ifa_addr, ifa_dstaddr and ifa_netmask) referenced here.
 355  */
 356 #if defined(_KERNEL) || defined(_WANT_IFADDR)
 357 struct ifaddr {
 358         struct  sockaddr *ifa_addr;     /* address of interface */
 359         struct  sockaddr *ifa_dstaddr;  /* other end of p-to-p link */
 360 #define ifa_broadaddr   ifa_dstaddr     /* broadcast address interface */
 361         struct  sockaddr *ifa_netmask;  /* used to determine subnet */
 362         struct  ifnet *ifa_ifp;         /* back-pointer to interface */
 363         struct  carp_softc *ifa_carp;   /* pointer to CARP data */
 364         TAILQ_ENTRY(ifaddr) ifa_link;   /* queue macro glue */
 365         void    (*ifa_rtrequest)        /* check or clean routes (+ or -)'d */
 366                 (int, struct rtentry *, struct rt_addrinfo *);
 367         u_short ifa_flags;              /* mostly rt_flags for cloning */
 368         u_int   ifa_refcnt;             /* references to this structure */
 369         int     ifa_metric;             /* cost of going out this interface */
 370         int (*ifa_claim_addr)           /* check if an addr goes to this if */
 371                 (struct ifaddr *, struct sockaddr *);
 372
 373         counter_u64_t   ifa_ipackets;
 374         counter_u64_t   ifa_opackets;
 375         counter_u64_t   ifa_ibytes;
 376         counter_u64_t   ifa_obytes;
 377 };
 378 #endif
 379
 380 #ifdef _KERNEL
 381 #define IFA_ROUTE       RTF_UP          /* route installed */
 382 #define IFA_RTSELF      RTF_HOST        /* loopback route to self installed */
 383
 384 /* For compatibility with other BSDs. SCTP uses it. */
 385 #define ifa_list        ifa_link
 386
 387 struct ifaddr * ifa_alloc(size_t size, int flags);
 388 void    ifa_free(struct ifaddr *ifa);
 389 void    ifa_ref(struct ifaddr *ifa);
 390 #endif /* _KERNEL */
 391
 392 /*
 393  * Multicast address structure.  This is analogous to the ifaddr
 394  * structure except that it keeps track of multicast addresses.
 395  */
 396 struct ifmultiaddr {
 397         TAILQ_ENTRY(ifmultiaddr) ifma_link; /* queue macro glue */
 398         struct  sockaddr *ifma_addr;    /* address this membership is for */
 399         struct  sockaddr *ifma_lladdr;  /* link-layer translation, if any */
 400         struct  ifnet *ifma_ifp;        /* back-pointer to interface */
 401         u_int   ifma_refcount;          /* reference count */
 402         void    *ifma_protospec;        /* protocol-specific state, if any */
 403         struct  ifmultiaddr *ifma_llifma; /* pointer to ifma for ifma_lladdr */
 404 };
 405
 406 #ifdef _KERNEL
 407
 408 extern  struct rwlock ifnet_rwlock;
 409 extern  struct sx ifnet_sxlock;
 410
 411 #define IFNET_LOCK_INIT() do {                                          \
 412         rw_init_flags(&ifnet_rwlock, "ifnet_rw",  RW_RECURSE);          \
 413         sx_init_flags(&ifnet_sxlock, "ifnet_sx",  SX_RECURSE);          \
 414 } while(0)
 415
 416 #define IFNET_WLOCK() do {                                              \
 417         sx_xlock(&ifnet_sxlock);                                        \
 418         rw_wlock(&ifnet_rwlock);                                        \
 419 } while (0)
 420
 421 #define IFNET_WUNLOCK() do {                                            \
 422         rw_wunlock(&ifnet_rwlock);                                      \
 423         sx_xunlock(&ifnet_sxlock);                                      \
 424 } while (0)
 425
 426 /*
 427  * To assert the ifnet lock, you must know not only whether it's for read or
 428  * write, but also whether it was acquired with sleep support or not.
 429  */
 430 #define IFNET_RLOCK_ASSERT()            sx_assert(&ifnet_sxlock, SA_SLOCKED)
 431 #define IFNET_RLOCK_NOSLEEP_ASSERT()    rw_assert(&ifnet_rwlock, RA_RLOCKED)
 432 #define IFNET_WLOCK_ASSERT() do {                                       \
 433         sx_assert(&ifnet_sxlock, SA_XLOCKED);                           \
 434         rw_assert(&ifnet_rwlock, RA_WLOCKED);                           \
 435 } while (0)
 436
 437 #define IFNET_RLOCK()           sx_slock(&ifnet_sxlock)
 438 #define IFNET_RLOCK_NOSLEEP()   rw_rlock(&ifnet_rwlock)
 439 #define IFNET_RUNLOCK()         sx_sunlock(&ifnet_sxlock)
 440 #define IFNET_RUNLOCK_NOSLEEP() rw_runlock(&ifnet_rwlock)
 441
 442 /*
 443  * Look up an ifnet given its index; the _ref variant also acquires a
 444  * reference that must be freed using if_rele().  It is almost always a bug
 445  * to call ifnet_byindex() instead if ifnet_byindex_ref().
 446  */
 447 struct ifnet    *ifnet_byindex(u_short idx);
 448 struct ifnet    *ifnet_byindex_locked(u_short idx);
 449 struct ifnet    *ifnet_byindex_ref(u_short idx);
 450
 451 /*
 452  * Given the index, ifaddr_byindex() returns the one and only
 453  * link-level ifaddr for the interface. You are not supposed to use
 454  * it to traverse the list of addresses associated to the interface.
 455  */
 456 struct ifaddr   *ifaddr_byindex(u_short idx);
 457
 458 VNET_DECLARE(struct ifnethead, ifnet);
 459 VNET_DECLARE(struct ifgrouphead, ifg_head);
 460 VNET_DECLARE(int, if_index);
 461 VNET_DECLARE(struct ifnet *, loif);     /* first loopback interface */
 462
 463 #define V_ifnet         VNET(ifnet)
 464 #define V_ifg_head      VNET(ifg_head)
 465 #define V_if_index      VNET(if_index)
 466 #define V_loif          VNET(loif)
 467
 468 int     if_addgroup(struct ifnet *, const char *);
 469 int     if_delgroup(struct ifnet *, const char *);
 470 int     if_addmulti(struct ifnet *, struct sockaddr *, struct ifmultiaddr **);
 471 int     if_allmulti(struct ifnet *, int);
 472 struct  ifnet* if_alloc(u_char);
 473 void    if_attach(struct ifnet *);
 474 void    if_dead(struct ifnet *);
 475 int     if_delmulti(struct ifnet *, struct sockaddr *);
 476 void    if_delmulti_ifma(struct ifmultiaddr *);
 477 void    if_detach(struct ifnet *);
 478 void    if_vmove(struct ifnet *, struct vnet *);
 479 void    if_purgeaddrs(struct ifnet *);
 480 void    if_delallmulti(struct ifnet *);
 481 void    if_down(struct ifnet *);
 482 struct ifmultiaddr *
 483         if_findmulti(struct ifnet *, struct sockaddr *);
 484 void    if_free(struct ifnet *);
 485 void    if_initname(struct ifnet *, const char *, int);
 486 void    if_link_state_change(struct ifnet *, int);
 487 int     if_printf(struct ifnet *, const char *, ...) __printflike(2, 3);
 488 void    if_ref(struct ifnet *);
 489 void    if_rele(struct ifnet *);
 490 int     if_setlladdr(struct ifnet *, const u_char *, int);
 491 void    if_up(struct ifnet *);
 492 int     ifioctl(struct socket *, u_long, caddr_t, struct thread *);
 493 int     ifpromisc(struct ifnet *, int);
 494 struct  ifnet *ifunit(const char *);
 495 struct  ifnet *ifunit_ref(const char *);
 496
 497 int     ifa_add_loopback_route(struct ifaddr *, struct sockaddr *);
 498 int     ifa_del_loopback_route(struct ifaddr *, struct sockaddr *);
 499 int     ifa_switch_loopback_route(struct ifaddr *, struct sockaddr *, int fib);
 500
 501 struct  ifaddr *ifa_ifwithaddr(struct sockaddr *);
 502 int             ifa_ifwithaddr_check(struct sockaddr *);
 503 struct  ifaddr *ifa_ifwithbroadaddr(struct sockaddr *);
 504 struct  ifaddr *ifa_ifwithdstaddr(struct sockaddr *);
 505 struct  ifaddr *ifa_ifwithdstaddr_fib(struct sockaddr *, int);
 506 struct  ifaddr *ifa_ifwithnet(struct sockaddr *, int);
 507 struct  ifaddr *ifa_ifwithnet_fib(struct sockaddr *, int, int);
 508 struct  ifaddr *ifa_ifwithroute(int, struct sockaddr *, struct sockaddr *);
 509 struct  ifaddr *ifa_ifwithroute_fib(int, struct sockaddr *, struct sockaddr *, u_int);
 510 struct  ifaddr *ifaof_ifpforaddr(struct sockaddr *, struct ifnet *);
 511 int     ifa_preferred(struct ifaddr *, struct ifaddr *);
 512
 513 int     if_simloop(struct ifnet *ifp, struct mbuf *m, int af, int hlen);
 514
 515 typedef void *if_com_alloc_t(u_char type, struct ifnet *ifp);
 516 typedef void if_com_free_t(void *com, u_char type);
 517 void    if_register_com_alloc(u_char type, if_com_alloc_t *a, if_com_free_t *f);
 518 void    if_deregister_com_alloc(u_char type);
 519
 520 #define IF_LLADDR(ifp)                                                  \
 521     LLADDR((struct sockaddr_dl *)((ifp)->if_addr->ifa_addr))
 522
 523 uint64_t if_setbaudrate(if_t ifp, uint64_t baudrate);
 524 uint64_t if_getbaudrate(if_t ifp);
 525 int if_setcapabilities(if_t ifp, int capabilities);
 526 int if_setcapabilitiesbit(if_t ifp, int setbit, int clearbit);
 527 int if_getcapabilities(if_t ifp);
 528 int if_togglecapenable(if_t ifp, int togglecap);
 529 int if_setcapenable(if_t ifp, int capenable);
 530 int if_setcapenablebit(if_t ifp, int setcap, int clearcap);
 531 int if_getcapenable(if_t ifp);
 532 const char *if_getdname(if_t ifp);
 533 int if_setdev(if_t ifp, void *dev);
 534 int if_setdrvflagbits(if_t ifp, int if_setflags, int clear_flags);
 535 int if_getdrvflags(if_t ifp);
 536 int if_setdrvflags(if_t ifp, int flags);
 537 int if_clearhwassist(if_t ifp);
 538 int if_sethwassistbits(if_t ifp, int toset, int toclear);
 539 int if_sethwassist(if_t ifp, int hwassist_bit);
 540 int if_gethwassist(if_t ifp);
 541 int if_setsoftc(if_t ifp, void *softc);
 542 void *if_getsoftc(if_t ifp);
 543 int if_setflags(if_t ifp, int flags);
 544 int if_setmtu(if_t ifp, int mtu);
 545 int if_getmtu(if_t ifp);
 546 int if_setflagbits(if_t ifp, int set, int clear);
 547 int if_getflags(if_t ifp);
 548 int if_sendq_empty(if_t ifp);
 549 int if_setsendqready(if_t ifp);
 550 int if_setsendqlen(if_t ifp, int tx_desc_count);
 551 int if_input(if_t ifp, struct mbuf* sendmp);
 552 int if_sendq_prepend(if_t ifp, struct mbuf *m);
 553 struct mbuf *if_dequeue(if_t ifp);
 554 int if_setifheaderlen(if_t ifp, int len);
 555 void if_setrcvif(struct mbuf *m, if_t ifp);
 556 void if_setvtag(struct mbuf *m, u_int16_t tag);
 557 u_int16_t if_getvtag(struct mbuf *m);
 558 int if_vlantrunkinuse(if_t ifp);
 559 caddr_t if_getlladdr(if_t ifp);
 560 void *if_gethandle(u_char);
 561 void if_bpfmtap(if_t ifp, struct mbuf *m);
 562 void if_etherbpfmtap(if_t ifp, struct mbuf *m);
 563 void if_vlancap(if_t ifp);
 564
 565 int if_setupmultiaddr(if_t ifp, void *mta, int *cnt, int max);
 566 int if_multiaddr_array(if_t ifp, void *mta, int *cnt, int max);
 567 int if_multiaddr_count(if_t ifp, int max);
 568
 569 int if_getamcount(if_t ifp);
 570 struct ifaddr * if_getifaddr(if_t ifp);
 571 /* Shim for drivers using drvapi */
 572 int ifmedia_ioctl_drv(if_t ifp, struct ifreq *ifr, struct ifmedia *ifm,
 573     u_long cmd);
 574
 575 /* Statistics */
 576
 577 int if_incipackets(if_t ifp, int pkt);
 578 int if_incopackets(if_t ifp, int pkts);
 579 int if_incierrors(if_t ifp, int ierrors);
 580 int if_incoerrors(if_t ifp, int oerrors);
 581 int if_inciqdrops(if_t ifp, int val);
 582 int if_setierrors(if_t ifp, int ierrors);
 583 int if_setoerrors(if_t ifp, int oerrors);
 584 int if_setcollisions(if_t ifp, int collisions);
 585 int if_inccollisions(if_t ifp, int collisions);
 586 int if_incobytes(if_t ifp, int bytes);
 587 int if_getiqdrops(if_t ifp);
 588 int if_incimcasts(if_t ifp, int imcasts);
 589 int if_incomcasts(if_t ifp, int imcasts);
 590 int if_setipackets(if_t ifp, int pkts);
 591 int if_setopackets(if_t ifp, int pkts);
 592 int if_setibytes(if_t ifp, int bytes);
 593 int if_setobytes(if_t ifp, int bytes);
 594 int if_setimcasts(if_t ifp, int pkts);
 595
 596 /* Functions */
 597 void if_setinitfn(if_t ifp, void (*)(void *));
 598 void if_setioctlfn(if_t ifp, int (*)(void *, u_long, caddr_t));
 599 void if_setstartfn(if_t ifp, void (*)(void *));
 600 void if_settransmitfn(if_t ifp, if_transmit_fn_t);
 601 void if_setqflushfn(if_t ifp, if_qflush_fn_t);
 602
 603
 604 /* Shim functions till all drivers use drvapi */
 605 void arp_ifinit_drv(if_t ifp, struct ifaddr *ifa);
 606 void ether_ifattach_drv(if_t ifp, const u_int8_t *lla);
 607 void ether_ifdetach_drv(if_t ifp);
 608 int ether_ioctl_drv(if_t ifp, u_long cmd, caddr_t data);
 609 void if_free_drv(if_t ifp);
 610 void if_initname_drv(if_t ifp, const char *name, int unit);
 611 void if_linkstate_change_drv(if_t ifp, int link_state);
 612
 613 struct ifmedia;
 614 void ifmedia_init_drv(struct ifmedia *, int, int (*)(void *),
 615         void (*)(void *, struct ifmediareq *));
 616
 617 void if_addr_rlock_drv(if_t ifp);
 618 void if_addr_runlock_drv(if_t ifp);
 619 void if_qflush_drv(if_t ifp);
 620
 621 /* Revisit the below. These are inline functions originally */
 622 int drbr_inuse_drv(if_t ifp, struct buf_ring *br);
 623 struct mbuf* drbr_dequeue_drv(if_t ifp, struct buf_ring *br);
 624 int drbr_needs_enqueue_drv(if_t ifp, struct buf_ring *br);
 625 int drbr_enqueue_drv(if_t ifp, struct buf_ring *br, struct mbuf *m);
 626
 627 #endif /* _KERNEL */
 628 #endif /* !_NET_IF_VAR_H_ */