sys/net/if_var.h

   1 /*-
   2  * SPDX-License-Identifier: BSD-3-Clause
   3  *
   4  * Copyright (c) 1982, 1986, 1989, 1993
   5  *      The Regents of the University of California.  All rights reserved.
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  * 1. Redistributions of source code must retain the above copyright
  11  *    notice, this list of conditions and the following disclaimer.
  12  * 2. Redistributions in binary form must reproduce the above copyright
  13  *    notice, this list of conditions and the following disclaimer in the
  14  *    documentation and/or other materials provided with the distribution.
  15  * 3. Neither the name of the University nor the names of its contributors
  16  *    may be used to endorse or promote products derived from this software
  17  *    without specific prior written permission.
  18  *
  19  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  20  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  21  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  22  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  23  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  24  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  25  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  26  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  27  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  28  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  29  * SUCH DAMAGE.
  30  *
  31  *      From: @(#)if.h  8.1 (Berkeley) 6/10/93
  32  * $FreeBSD$
  33  */
  34
  35 #ifndef _NET_IF_VAR_H_
  36 #define _NET_IF_VAR_H_
  37
  38 /*
  39  * Structures defining a network interface, providing a packet
  40  * transport mechanism (ala level 0 of the PUP protocols).
  41  *
  42  * Each interface accepts output datagrams of a specified maximum
  43  * length, and provides higher level routines with input datagrams
  44  * received from its medium.
  45  *
  46  * Output occurs when the routine if_output is called, with three parameters:
  47  *      (*ifp->if_output)(ifp, m, dst, rt)
  48  * Here m is the mbuf chain to be sent and dst is the destination address.
  49  * The output routine encapsulates the supplied datagram if necessary,
  50  * and then transmits it on its medium.
  51  *
  52  * On input, each interface unwraps the data received by it, and either
  53  * places it on the input queue of an internetwork datagram routine
  54  * and posts the associated software interrupt, or passes the datagram to a raw
  55  * packet input routine.
  56  *
  57  * Routines exist for locating interfaces by their addresses
  58  * or for locating an interface on a certain network, as well as more general
  59  * routing and gateway routines maintaining information used to locate
  60  * interfaces.  These routines live in the files if.c and route.c
  61  */
  62
  63 struct  rtentry;                /* ifa_rtrequest */
  64 struct  rt_addrinfo;            /* ifa_rtrequest */
  65 struct  socket;
  66 struct  carp_if;
  67 struct  carp_softc;
  68 struct  ifvlantrunk;
  69 struct  route;                  /* if_output */
  70 struct  vnet;
  71 struct  ifmedia;
  72 struct  netmap_adapter;
  73 struct  netdump_methods;
  74
  75 #ifdef _KERNEL
  76 #include <sys/mbuf.h>           /* ifqueue only? */
  77 #include <sys/buf_ring.h>
  78 #include <net/vnet.h>
  79 #endif /* _KERNEL */
  80 #include <sys/ck.h>
  81 #include <sys/counter.h>
  82 #include <sys/epoch.h>
  83 #include <sys/lock.h>           /* XXX */
  84 #include <sys/mutex.h>          /* struct ifqueue */
  85 #include <sys/rwlock.h>         /* XXX */
  86 #include <sys/sx.h>             /* XXX */
  87 #include <sys/_task.h>          /* if_link_task */
  88 #define IF_DUNIT_NONE   -1
  89
  90 #include <net/altq/if_altq.h>
  91
  92 CK_STAILQ_HEAD(ifnethead, ifnet);       /* we use TAILQs so that the order of */
  93 CK_STAILQ_HEAD(ifaddrhead, ifaddr);     /* instantiation is preserved in the list */
  94 CK_STAILQ_HEAD(ifmultihead, ifmultiaddr);
  95 CK_STAILQ_HEAD(ifgrouphead, ifg_group);
  96
  97 #ifdef _KERNEL
  98 VNET_DECLARE(struct pfil_head *, link_pfil_head);
  99 #define V_link_pfil_head        VNET(link_pfil_head)
 100 #define PFIL_ETHER_NAME         "ethernet"
 101
 102 #define HHOOK_IPSEC_INET        0
 103 #define HHOOK_IPSEC_INET6       1
 104 #define HHOOK_IPSEC_COUNT       2
 105 VNET_DECLARE(struct hhook_head *, ipsec_hhh_in[HHOOK_IPSEC_COUNT]);
 106 VNET_DECLARE(struct hhook_head *, ipsec_hhh_out[HHOOK_IPSEC_COUNT]);
 107 #define V_ipsec_hhh_in  VNET(ipsec_hhh_in)
 108 #define V_ipsec_hhh_out VNET(ipsec_hhh_out)
 109 extern epoch_t net_epoch_preempt;
 110 extern epoch_t net_epoch;
 111 #endif /* _KERNEL */
 112
 113 typedef enum {
 114         IFCOUNTER_IPACKETS = 0,
 115         IFCOUNTER_IERRORS,
 116         IFCOUNTER_OPACKETS,
 117         IFCOUNTER_OERRORS,
 118         IFCOUNTER_COLLISIONS,
 119         IFCOUNTER_IBYTES,
 120         IFCOUNTER_OBYTES,
 121         IFCOUNTER_IMCASTS,
 122         IFCOUNTER_OMCASTS,
 123         IFCOUNTER_IQDROPS,
 124         IFCOUNTER_OQDROPS,
 125         IFCOUNTER_NOPROTO,
 126         IFCOUNTERS /* Array size. */
 127 } ift_counter;
 128
 129 typedef struct ifnet * if_t;
 130
 131 typedef void (*if_start_fn_t)(if_t);
 132 typedef int (*if_ioctl_fn_t)(if_t, u_long, caddr_t);
 133 typedef void (*if_init_fn_t)(void *);
 134 typedef void (*if_qflush_fn_t)(if_t);
 135 typedef int (*if_transmit_fn_t)(if_t, struct mbuf *);
 136 typedef uint64_t (*if_get_counter_t)(if_t, ift_counter);
 137
 138 struct ifnet_hw_tsomax {
 139         u_int   tsomaxbytes;    /* TSO total burst length limit in bytes */
 140         u_int   tsomaxsegcount; /* TSO maximum segment count */
 141         u_int   tsomaxsegsize;  /* TSO maximum segment size in bytes */
 142 };
 143
 144 /* Interface encap request types */
 145 typedef enum {
 146         IFENCAP_LL = 1                  /* pre-calculate link-layer header */
 147 } ife_type;
 148
 149 /*
 150  * The structure below allows to request various pre-calculated L2/L3 headers
 151  * for different media. Requests varies by type (rtype field).
 152  *
 153  * IFENCAP_LL type: pre-calculates link header based on address family
 154  *   and destination lladdr.
 155  *
 156  *   Input data fields:
 157  *     buf: pointer to destination buffer
 158  *     bufsize: buffer size
 159  *     flags: IFENCAP_FLAG_BROADCAST if destination is broadcast
 160  *     family: address family defined by AF_ constant.
 161  *     lladdr: pointer to link-layer address
 162  *     lladdr_len: length of link-layer address
 163  *     hdata: pointer to L3 header (optional, used for ARP requests).
 164  *   Output data fields:
 165  *     buf: encap data is stored here
 166  *     bufsize: resulting encap length is stored here
 167  *     lladdr_off: offset of link-layer address from encap hdr start
 168  *     hdata: L3 header may be altered if necessary
 169  */
 170
 171 struct if_encap_req {
 172         u_char          *buf;           /* Destination buffer (w) */
 173         size_t          bufsize;        /* size of provided buffer (r) */
 174         ife_type        rtype;          /* request type (r) */
 175         uint32_t        flags;          /* Request flags (r) */
 176         int             family;         /* Address family AF_* (r) */
 177         int             lladdr_off;     /* offset from header start (w) */
 178         int             lladdr_len;     /* lladdr length (r) */
 179         char            *lladdr;        /* link-level address pointer (r) */
 180         char            *hdata;         /* Upper layer header data (rw) */
 181 };
 182
 183 #define IFENCAP_FLAG_BROADCAST  0x02    /* Destination is broadcast */
 184
 185 /*
 186  * Network interface send tag support. The storage of "struct
 187  * m_snd_tag" comes from the network driver and it is free to allocate
 188  * as much additional space as it wants for its own use.
 189  */
 190 struct m_snd_tag;
 191
 192 #define IF_SND_TAG_TYPE_RATE_LIMIT 0
 193 #define IF_SND_TAG_TYPE_UNLIMITED 1
 194 #define IF_SND_TAG_TYPE_MAX 2
 195
 196 struct if_snd_tag_alloc_header {
 197         uint32_t type;          /* send tag type, see IF_SND_TAG_XXX */
 198         uint32_t flowid;        /* mbuf hash value */
 199         uint32_t flowtype;      /* mbuf hash type */
 200 };
 201
 202 struct if_snd_tag_alloc_rate_limit {
 203         struct if_snd_tag_alloc_header hdr;
 204         uint64_t max_rate;      /* in bytes/s */
 205 };
 206
 207 struct if_snd_tag_rate_limit_params {
 208         uint64_t max_rate;      /* in bytes/s */
 209         uint32_t queue_level;   /* 0 (empty) .. 65535 (full) */
 210 #define IF_SND_QUEUE_LEVEL_MIN 0
 211 #define IF_SND_QUEUE_LEVEL_MAX 65535
 212         uint32_t reserved;      /* padding */
 213 };
 214
 215 union if_snd_tag_alloc_params {
 216         struct if_snd_tag_alloc_header hdr;
 217         struct if_snd_tag_alloc_rate_limit rate_limit;
 218         struct if_snd_tag_alloc_rate_limit unlimited;
 219 };
 220
 221 union if_snd_tag_modify_params {
 222         struct if_snd_tag_rate_limit_params rate_limit;
 223         struct if_snd_tag_rate_limit_params unlimited;
 224 };
 225
 226 union if_snd_tag_query_params {
 227         struct if_snd_tag_rate_limit_params rate_limit;
 228         struct if_snd_tag_rate_limit_params unlimited;
 229 };
 230
 231 typedef int (if_snd_tag_alloc_t)(struct ifnet *, union if_snd_tag_alloc_params *,
 232     struct m_snd_tag **);
 233 typedef int (if_snd_tag_modify_t)(struct m_snd_tag *, union if_snd_tag_modify_params *);
 234 typedef int (if_snd_tag_query_t)(struct m_snd_tag *, union if_snd_tag_query_params *);
 235 typedef void (if_snd_tag_free_t)(struct m_snd_tag *);
 236
 237 /*
 238  * Structure defining a network interface.
 239  */
 240 struct ifnet {
 241         /* General book keeping of interface lists. */
 242         CK_STAILQ_ENTRY(ifnet) if_link;         /* all struct ifnets are chained (CK_) */
 243         LIST_ENTRY(ifnet) if_clones;    /* interfaces of a cloner */
 244         CK_STAILQ_HEAD(, ifg_list) if_groups; /* linked list of groups per if (CK_) */
 245                                         /* protected by if_addr_lock */
 246         u_char  if_alloctype;           /* if_type at time of allocation */
 247
 248         /* Driver and protocol specific information that remains stable. */
 249         void    *if_softc;              /* pointer to driver state */
 250         void    *if_llsoftc;            /* link layer softc */
 251         void    *if_l2com;              /* pointer to protocol bits */
 252         const char *if_dname;           /* driver name */
 253         int     if_dunit;               /* unit or IF_DUNIT_NONE */
 254         u_short if_index;               /* numeric abbreviation for this if  */
 255         short   if_index_reserved;      /* spare space to grow if_index */
 256         char    if_xname[IFNAMSIZ];     /* external name (name + unit) */
 257         char    *if_description;        /* interface description */
 258
 259         /* Variable fields that are touched by the stack and drivers. */
 260         int     if_flags;               /* up/down, broadcast, etc. */
 261         int     if_drv_flags;           /* driver-managed status flags */
 262         int     if_capabilities;        /* interface features & capabilities */
 263         int     if_capenable;           /* enabled features & capabilities */
 264         void    *if_linkmib;            /* link-type-specific MIB data */
 265         size_t  if_linkmiblen;          /* length of above data */
 266         u_int   if_refcount;            /* reference count */
 267
 268         /* These fields are shared with struct if_data. */
 269         uint8_t         if_type;        /* ethernet, tokenring, etc */
 270         uint8_t         if_addrlen;     /* media address length */
 271         uint8_t         if_hdrlen;      /* media header length */
 272         uint8_t         if_link_state;  /* current link state */
 273         uint32_t        if_mtu;         /* maximum transmission unit */
 274         uint32_t        if_metric;      /* routing metric (external only) */
 275         uint64_t        if_baudrate;    /* linespeed */
 276         uint64_t        if_hwassist;    /* HW offload capabilities, see IFCAP */
 277         time_t          if_epoch;       /* uptime at attach or stat reset */
 278         struct timeval  if_lastchange;  /* time of last administrative change */
 279
 280         struct  ifaltq if_snd;          /* output queue (includes altq) */
 281         struct  task if_linktask;       /* task for link change events */
 282
 283         /* Addresses of different protocol families assigned to this if. */
 284         struct mtx if_addr_lock;        /* lock to protect address lists */
 285                 /*
 286                  * if_addrhead is the list of all addresses associated to
 287                  * an interface.
 288                  * Some code in the kernel assumes that first element
 289                  * of the list has type AF_LINK, and contains sockaddr_dl
 290                  * addresses which store the link-level address and the name
 291                  * of the interface.
 292                  * However, access to the AF_LINK address through this
 293                  * field is deprecated. Use if_addr or ifaddr_byindex() instead.
 294                  */
 295         struct  ifaddrhead if_addrhead; /* linked list of addresses per if */
 296         struct  ifmultihead if_multiaddrs; /* multicast addresses configured */
 297         int     if_amcount;             /* number of all-multicast requests */
 298         struct  ifaddr  *if_addr;       /* pointer to link-level address */
 299         void    *if_hw_addr;            /* hardware link-level address */
 300         const u_int8_t *if_broadcastaddr; /* linklevel broadcast bytestring */
 301         struct  mtx if_afdata_lock;
 302         void    *if_afdata[AF_MAX];
 303         int     if_afdata_initialized;
 304
 305         /* Additional features hung off the interface. */
 306         u_int   if_fib;                 /* interface FIB */
 307         struct  vnet *if_vnet;          /* pointer to network stack instance */
 308         struct  vnet *if_home_vnet;     /* where this ifnet originates from */
 309         struct  ifvlantrunk *if_vlantrunk; /* pointer to 802.1q data */
 310         struct  bpf_if *if_bpf;         /* packet filter structure */
 311         int     if_pcount;              /* number of promiscuous listeners */
 312         void    *if_bridge;             /* bridge glue */
 313         void    *if_lagg;               /* lagg glue */
 314         void    *if_pf_kif;             /* pf glue */
 315         struct  carp_if *if_carp;       /* carp interface structure */
 316         struct  label *if_label;        /* interface MAC label */
 317         struct  netmap_adapter *if_netmap; /* netmap(4) softc */
 318
 319         /* Various procedures of the layer2 encapsulation and drivers. */
 320         int     (*if_output)            /* output routine (enqueue) */
 321                 (struct ifnet *, struct mbuf *, const struct sockaddr *,
 322                      struct route *);
 323         void    (*if_input)             /* input routine (from h/w driver) */
 324                 (struct ifnet *, struct mbuf *);
 325         struct mbuf *(*if_bridge_input)(struct ifnet *, struct mbuf *);
 326         int     (*if_bridge_output)(struct ifnet *, struct mbuf *, struct sockaddr *,
 327                     struct rtentry *);
 328         void (*if_bridge_linkstate)(struct ifnet *ifp);
 329         if_start_fn_t   if_start;       /* initiate output routine */
 330         if_ioctl_fn_t   if_ioctl;       /* ioctl routine */
 331         if_init_fn_t    if_init;        /* Init routine */
 332         int     (*if_resolvemulti)      /* validate/resolve multicast */
 333                 (struct ifnet *, struct sockaddr **, struct sockaddr *);
 334         if_qflush_fn_t  if_qflush;      /* flush any queue */
 335         if_transmit_fn_t if_transmit;   /* initiate output routine */
 336
 337         void    (*if_reassign)          /* reassign to vnet routine */
 338                 (struct ifnet *, struct vnet *, char *);
 339         if_get_counter_t if_get_counter; /* get counter values */
 340         int     (*if_requestencap)      /* make link header from request */
 341                 (struct ifnet *, struct if_encap_req *);
 342
 343         /* Statistics. */
 344         counter_u64_t   if_counters[IFCOUNTERS];
 345
 346         /* Stuff that's only temporary and doesn't belong here. */
 347
 348         /*
 349          * Network adapter TSO limits:
 350          * ===========================
 351          *
 352          * If the "if_hw_tsomax" field is zero the maximum segment
 353          * length limit does not apply. If the "if_hw_tsomaxsegcount"
 354          * or the "if_hw_tsomaxsegsize" field is zero the TSO segment
 355          * count limit does not apply. If all three fields are zero,
 356          * there is no TSO limit.
 357          *
 358          * NOTE: The TSO limits should reflect the values used in the
 359          * BUSDMA tag a network adapter is using to load a mbuf chain
 360          * for transmission. The TCP/IP network stack will subtract
 361          * space for all linklevel and protocol level headers and
 362          * ensure that the full mbuf chain passed to the network
 363          * adapter fits within the given limits.
 364          */
 365         u_int   if_hw_tsomax;           /* TSO maximum size in bytes */
 366         u_int   if_hw_tsomaxsegcount;   /* TSO maximum segment count */
 367         u_int   if_hw_tsomaxsegsize;    /* TSO maximum segment size in bytes */
 368
 369         /*
 370          * Network adapter send tag support:
 371          */
 372         if_snd_tag_alloc_t *if_snd_tag_alloc;
 373         if_snd_tag_modify_t *if_snd_tag_modify;
 374         if_snd_tag_query_t *if_snd_tag_query;
 375         if_snd_tag_free_t *if_snd_tag_free;
 376
 377         /* Ethernet PCP */
 378         uint8_t if_pcp;
 379
 380         /*
 381          * Netdump hooks to be called while dumping.
 382          */
 383         struct netdump_methods *if_netdump_methods;
 384         struct epoch_context    if_epoch_ctx;
 385
 386         /*
 387          * Spare fields to be added before branching a stable branch, so
 388          * that structure can be enhanced without changing the kernel
 389          * binary interface.
 390          */
 391         int     if_ispare[4];           /* general use */
 392 };
 393
 394 /* for compatibility with other BSDs */
 395 #define if_name(ifp)    ((ifp)->if_xname)
 396
 397 /*
 398  * Locks for address lists on the network interface.
 399  */
 400 #define IF_ADDR_LOCK_INIT(if)   mtx_init(&(if)->if_addr_lock, "if_addr_lock", NULL, MTX_DEF)
 401 #define IF_ADDR_LOCK_DESTROY(if)        mtx_destroy(&(if)->if_addr_lock)
 402
 403 #define IF_ADDR_WLOCK(if)       mtx_lock(&(if)->if_addr_lock)
 404 #define IF_ADDR_WUNLOCK(if)     mtx_unlock(&(if)->if_addr_lock)
 405 #define IF_ADDR_LOCK_ASSERT(if) MPASS(in_epoch(net_epoch_preempt) || mtx_owned(&(if)->if_addr_lock))
 406 #define IF_ADDR_WLOCK_ASSERT(if) mtx_assert(&(if)->if_addr_lock, MA_OWNED)
 407 #define NET_EPOCH_ENTER(et)     epoch_enter_preempt(net_epoch_preempt, &(et))
 408 #define NET_EPOCH_EXIT(et)      epoch_exit_preempt(net_epoch_preempt, &(et))
 409 #define NET_EPOCH_WAIT()        epoch_wait_preempt(net_epoch_preempt)
 410 #define NET_EPOCH_ASSERT()      MPASS(in_epoch(net_epoch_preempt))
 411
 412 /*
 413  * Function variations on locking macros intended to be used by loadable
 414  * kernel modules in order to divorce them from the internals of address list
 415  * locking.
 416  */
 417 void    if_addr_rlock(struct ifnet *ifp);       /* if_addrhead */
 418 void    if_addr_runlock(struct ifnet *ifp);     /* if_addrhead */
 419 void    if_maddr_rlock(if_t ifp);       /* if_multiaddrs */
 420 void    if_maddr_runlock(if_t ifp);     /* if_multiaddrs */
 421
 422 #ifdef _KERNEL
 423 #ifdef _SYS_EVENTHANDLER_H_
 424 /* interface link layer address change event */
 425 typedef void (*iflladdr_event_handler_t)(void *, struct ifnet *);
 426 EVENTHANDLER_DECLARE(iflladdr_event, iflladdr_event_handler_t);
 427 /* interface address change event */
 428 typedef void (*ifaddr_event_handler_t)(void *, struct ifnet *);
 429 EVENTHANDLER_DECLARE(ifaddr_event, ifaddr_event_handler_t);
 430 typedef void (*ifaddr_event_ext_handler_t)(void *, struct ifnet *,
 431     struct ifaddr *, int);
 432 EVENTHANDLER_DECLARE(ifaddr_event_ext, ifaddr_event_ext_handler_t);
 433 #define IFADDR_EVENT_ADD        0
 434 #define IFADDR_EVENT_DEL        1
 435 /* new interface arrival event */
 436 typedef void (*ifnet_arrival_event_handler_t)(void *, struct ifnet *);
 437 EVENTHANDLER_DECLARE(ifnet_arrival_event, ifnet_arrival_event_handler_t);
 438 /* interface departure event */
 439 typedef void (*ifnet_departure_event_handler_t)(void *, struct ifnet *);
 440 EVENTHANDLER_DECLARE(ifnet_departure_event, ifnet_departure_event_handler_t);
 441 /* Interface link state change event */
 442 typedef void (*ifnet_link_event_handler_t)(void *, struct ifnet *, int);
 443 EVENTHANDLER_DECLARE(ifnet_link_event, ifnet_link_event_handler_t);
 444 /* Interface up/down event */
 445 #define IFNET_EVENT_UP          0
 446 #define IFNET_EVENT_DOWN        1
 447 #define IFNET_EVENT_PCP         2       /* priority code point, PCP */
 448
 449 typedef void (*ifnet_event_fn)(void *, struct ifnet *ifp, int event);
 450 EVENTHANDLER_DECLARE(ifnet_event, ifnet_event_fn);
 451 #endif /* _SYS_EVENTHANDLER_H_ */
 452
 453 /*
 454  * interface groups
 455  */
 456 struct ifg_group {
 457         char                             ifg_group[IFNAMSIZ];
 458         u_int                            ifg_refcnt;
 459         void                            *ifg_pf_kif;
 460         CK_STAILQ_HEAD(, ifg_member)     ifg_members; /* (CK_) */
 461         CK_STAILQ_ENTRY(ifg_group)               ifg_next; /* (CK_) */
 462 };
 463
 464 struct ifg_member {
 465         CK_STAILQ_ENTRY(ifg_member)      ifgm_next; /* (CK_) */
 466         struct ifnet            *ifgm_ifp;
 467 };
 468
 469 struct ifg_list {
 470         struct ifg_group        *ifgl_group;
 471         CK_STAILQ_ENTRY(ifg_list)        ifgl_next; /* (CK_) */
 472 };
 473
 474 #ifdef _SYS_EVENTHANDLER_H_
 475 /* group attach event */
 476 typedef void (*group_attach_event_handler_t)(void *, struct ifg_group *);
 477 EVENTHANDLER_DECLARE(group_attach_event, group_attach_event_handler_t);
 478 /* group detach event */
 479 typedef void (*group_detach_event_handler_t)(void *, struct ifg_group *);
 480 EVENTHANDLER_DECLARE(group_detach_event, group_detach_event_handler_t);
 481 /* group change event */
 482 typedef void (*group_change_event_handler_t)(void *, const char *);
 483 EVENTHANDLER_DECLARE(group_change_event, group_change_event_handler_t);
 484 #endif /* _SYS_EVENTHANDLER_H_ */
 485
 486 #define IF_AFDATA_LOCK_INIT(ifp)        \
 487         mtx_init(&(ifp)->if_afdata_lock, "if_afdata", NULL, MTX_DEF)
 488
 489 #define IF_AFDATA_WLOCK(ifp)    mtx_lock(&(ifp)->if_afdata_lock)
 490 #define IF_AFDATA_WUNLOCK(ifp)  mtx_unlock(&(ifp)->if_afdata_lock)
 491 #define IF_AFDATA_LOCK(ifp)     IF_AFDATA_WLOCK(ifp)
 492 #define IF_AFDATA_UNLOCK(ifp)   IF_AFDATA_WUNLOCK(ifp)
 493 #define IF_AFDATA_TRYLOCK(ifp)  mtx_trylock(&(ifp)->if_afdata_lock)
 494 #define IF_AFDATA_DESTROY(ifp)  mtx_destroy(&(ifp)->if_afdata_lock)
 495
 496 #define IF_AFDATA_LOCK_ASSERT(ifp)      MPASS(in_epoch(net_epoch_preempt) || mtx_owned(&(ifp)->if_afdata_lock))
 497 #define IF_AFDATA_WLOCK_ASSERT(ifp)     mtx_assert(&(ifp)->if_afdata_lock, MA_OWNED)
 498 #define IF_AFDATA_UNLOCK_ASSERT(ifp)    mtx_assert(&(ifp)->if_afdata_lock, MA_NOTOWNED)
 499
 500 /*
 501  * 72 was chosen below because it is the size of a TCP/IP
 502  * header (40) + the minimum mss (32).
 503  */
 504 #define IF_MINMTU       72
 505 #define IF_MAXMTU       65535
 506
 507 #define TOEDEV(ifp)     ((ifp)->if_llsoftc)
 508
 509 /*
 510  * The ifaddr structure contains information about one address
 511  * of an interface.  They are maintained by the different address families,
 512  * are allocated and attached when an address is set, and are linked
 513  * together so all addresses for an interface can be located.
 514  *
 515  * NOTE: a 'struct ifaddr' is always at the beginning of a larger
 516  * chunk of malloc'ed memory, where we store the three addresses
 517  * (ifa_addr, ifa_dstaddr and ifa_netmask) referenced here.
 518  */
 519 struct ifaddr {
 520         struct  sockaddr *ifa_addr;     /* address of interface */
 521         struct  sockaddr *ifa_dstaddr;  /* other end of p-to-p link */
 522 #define ifa_broadaddr   ifa_dstaddr     /* broadcast address interface */
 523         struct  sockaddr *ifa_netmask;  /* used to determine subnet */
 524         struct  ifnet *ifa_ifp;         /* back-pointer to interface */
 525         struct  carp_softc *ifa_carp;   /* pointer to CARP data */
 526         CK_STAILQ_ENTRY(ifaddr) ifa_link;       /* queue macro glue */
 527         void    (*ifa_rtrequest)        /* check or clean routes (+ or -)'d */
 528                 (int, struct rtentry *, struct rt_addrinfo *);
 529         u_short ifa_flags;              /* mostly rt_flags for cloning */
 530 #define IFA_ROUTE       RTF_UP          /* route installed */
 531 #define IFA_RTSELF      RTF_HOST        /* loopback route to self installed */
 532         u_int   ifa_refcnt;             /* references to this structure */
 533
 534         counter_u64_t   ifa_ipackets;
 535         counter_u64_t   ifa_opackets;
 536         counter_u64_t   ifa_ibytes;
 537         counter_u64_t   ifa_obytes;
 538         struct  epoch_context   ifa_epoch_ctx;
 539 };
 540
 541 struct ifaddr * ifa_alloc(size_t size, int flags);
 542 void    ifa_free(struct ifaddr *ifa);
 543 void    ifa_ref(struct ifaddr *ifa);
 544
 545 /*
 546  * Multicast address structure.  This is analogous to the ifaddr
 547  * structure except that it keeps track of multicast addresses.
 548  */
 549 #define IFMA_F_ENQUEUED         0x1
 550 struct ifmultiaddr {
 551         CK_STAILQ_ENTRY(ifmultiaddr) ifma_link; /* queue macro glue */
 552         struct  sockaddr *ifma_addr;    /* address this membership is for */
 553         struct  sockaddr *ifma_lladdr;  /* link-layer translation, if any */
 554         struct  ifnet *ifma_ifp;        /* back-pointer to interface */
 555         u_int   ifma_refcount;          /* reference count */
 556         int     ifma_flags;
 557         void    *ifma_protospec;        /* protocol-specific state, if any */
 558         struct  ifmultiaddr *ifma_llifma; /* pointer to ifma for ifma_lladdr */
 559         struct  epoch_context   ifma_epoch_ctx;
 560 };
 561
 562 extern  struct rwlock ifnet_rwlock;
 563 extern  struct sx ifnet_sxlock;
 564
 565 #define IFNET_WLOCK() do {                                              \
 566         sx_xlock(&ifnet_sxlock);                                        \
 567         rw_wlock(&ifnet_rwlock);                                        \
 568 } while (0)
 569
 570 #define IFNET_WUNLOCK() do {                                            \
 571         rw_wunlock(&ifnet_rwlock);                                      \
 572         sx_xunlock(&ifnet_sxlock);                                      \
 573 } while (0)
 574
 575 /*
 576  * To assert the ifnet lock, you must know not only whether it's for read or
 577  * write, but also whether it was acquired with sleep support or not.
 578  */
 579 #define IFNET_RLOCK_ASSERT()            sx_assert(&ifnet_sxlock, SA_SLOCKED)
 580 #define IFNET_WLOCK_ASSERT() do {                                       \
 581         sx_assert(&ifnet_sxlock, SA_XLOCKED);                           \
 582         rw_assert(&ifnet_rwlock, RA_WLOCKED);                           \
 583 } while (0)
 584
 585 #define IFNET_RLOCK()           sx_slock(&ifnet_sxlock)
 586 #define IFNET_RUNLOCK()         sx_sunlock(&ifnet_sxlock)
 587
 588 /*
 589  * Look up an ifnet given its index; the _ref variant also acquires a
 590  * reference that must be freed using if_rele().  It is almost always a bug
 591  * to call ifnet_byindex() instead of ifnet_byindex_ref().
 592  */
 593 struct ifnet    *ifnet_byindex(u_short idx);
 594 struct ifnet    *ifnet_byindex_locked(u_short idx);
 595 struct ifnet    *ifnet_byindex_ref(u_short idx);
 596
 597 /*
 598  * Given the index, ifaddr_byindex() returns the one and only
 599  * link-level ifaddr for the interface. You are not supposed to use
 600  * it to traverse the list of addresses associated to the interface.
 601  */
 602 struct ifaddr   *ifaddr_byindex(u_short idx);
 603
 604 VNET_DECLARE(struct ifnethead, ifnet);
 605 VNET_DECLARE(struct ifgrouphead, ifg_head);
 606 VNET_DECLARE(int, if_index);
 607 VNET_DECLARE(struct ifnet *, loif);     /* first loopback interface */
 608
 609 #define V_ifnet         VNET(ifnet)
 610 #define V_ifg_head      VNET(ifg_head)
 611 #define V_if_index      VNET(if_index)
 612 #define V_loif          VNET(loif)
 613
 614 #ifdef MCAST_VERBOSE
 615 #define MCDPRINTF printf
 616 #else
 617 #define MCDPRINTF(...)
 618 #endif
 619
 620 int     if_addgroup(struct ifnet *, const char *);
 621 int     if_delgroup(struct ifnet *, const char *);
 622 int     if_addmulti(struct ifnet *, struct sockaddr *, struct ifmultiaddr **);
 623 int     if_allmulti(struct ifnet *, int);
 624 struct  ifnet* if_alloc(u_char);
 625 void    if_attach(struct ifnet *);
 626 void    if_dead(struct ifnet *);
 627 int     if_delmulti(struct ifnet *, struct sockaddr *);
 628 void    if_delmulti_ifma(struct ifmultiaddr *);
 629 void    if_delmulti_ifma_flags(struct ifmultiaddr *, int flags);
 630 void    if_detach(struct ifnet *);
 631 void    if_purgeaddrs(struct ifnet *);
 632 void    if_delallmulti(struct ifnet *);
 633 void    if_down(struct ifnet *);
 634 struct ifmultiaddr *
 635         if_findmulti(struct ifnet *, const struct sockaddr *);
 636 void    if_freemulti(struct ifmultiaddr *ifma);
 637 void    if_free(struct ifnet *);
 638 void    if_initname(struct ifnet *, const char *, int);
 639 void    if_link_state_change(struct ifnet *, int);
 640 int     if_printf(struct ifnet *, const char *, ...) __printflike(2, 3);
 641 void    if_ref(struct ifnet *);
 642 void    if_rele(struct ifnet *);
 643 int     if_setlladdr(struct ifnet *, const u_char *, int);
 644 int     if_tunnel_check_nesting(struct ifnet *, struct mbuf *, uint32_t, int);
 645 void    if_up(struct ifnet *);
 646 int     ifioctl(struct socket *, u_long, caddr_t, struct thread *);
 647 int     ifpromisc(struct ifnet *, int);
 648 struct  ifnet *ifunit(const char *);
 649 struct  ifnet *ifunit_ref(const char *);
 650
 651 int     ifa_add_loopback_route(struct ifaddr *, struct sockaddr *);
 652 int     ifa_del_loopback_route(struct ifaddr *, struct sockaddr *);
 653 int     ifa_switch_loopback_route(struct ifaddr *, struct sockaddr *);
 654
 655 struct  ifaddr *ifa_ifwithaddr(const struct sockaddr *);
 656 int             ifa_ifwithaddr_check(const struct sockaddr *);
 657 struct  ifaddr *ifa_ifwithbroadaddr(const struct sockaddr *, int);
 658 struct  ifaddr *ifa_ifwithdstaddr(const struct sockaddr *, int);
 659 struct  ifaddr *ifa_ifwithnet(const struct sockaddr *, int, int);
 660 struct  ifaddr *ifa_ifwithroute(int, const struct sockaddr *, struct sockaddr *,
 661     u_int);
 662 struct  ifaddr *ifaof_ifpforaddr(const struct sockaddr *, struct ifnet *);
 663 int     ifa_preferred(struct ifaddr *, struct ifaddr *);
 664
 665 int     if_simloop(struct ifnet *ifp, struct mbuf *m, int af, int hlen);
 666
 667 typedef void *if_com_alloc_t(u_char type, struct ifnet *ifp);
 668 typedef void if_com_free_t(void *com, u_char type);
 669 void    if_register_com_alloc(u_char type, if_com_alloc_t *a, if_com_free_t *f);
 670 void    if_deregister_com_alloc(u_char type);
 671 void    if_data_copy(struct ifnet *, struct if_data *);
 672 uint64_t if_get_counter_default(struct ifnet *, ift_counter);
 673 void    if_inc_counter(struct ifnet *, ift_counter, int64_t);
 674
 675 #define IF_LLADDR(ifp)                                                  \
 676     LLADDR((struct sockaddr_dl *)((ifp)->if_addr->ifa_addr))
 677
 678 uint64_t if_setbaudrate(if_t ifp, uint64_t baudrate);
 679 uint64_t if_getbaudrate(if_t ifp);
 680 int if_setcapabilities(if_t ifp, int capabilities);
 681 int if_setcapabilitiesbit(if_t ifp, int setbit, int clearbit);
 682 int if_getcapabilities(if_t ifp);
 683 int if_togglecapenable(if_t ifp, int togglecap);
 684 int if_setcapenable(if_t ifp, int capenable);
 685 int if_setcapenablebit(if_t ifp, int setcap, int clearcap);
 686 int if_getcapenable(if_t ifp);
 687 const char *if_getdname(if_t ifp);
 688 int if_setdev(if_t ifp, void *dev);
 689 int if_setdrvflagbits(if_t ifp, int if_setflags, int clear_flags);
 690 int if_getdrvflags(if_t ifp);
 691 int if_setdrvflags(if_t ifp, int flags);
 692 int if_clearhwassist(if_t ifp);
 693 int if_sethwassistbits(if_t ifp, int toset, int toclear);
 694 int if_sethwassist(if_t ifp, int hwassist_bit);
 695 int if_gethwassist(if_t ifp);
 696 int if_setsoftc(if_t ifp, void *softc);
 697 void *if_getsoftc(if_t ifp);
 698 int if_setflags(if_t ifp, int flags);
 699 int if_gethwaddr(if_t ifp, struct ifreq *);
 700 int if_setmtu(if_t ifp, int mtu);
 701 int if_getmtu(if_t ifp);
 702 int if_getmtu_family(if_t ifp, int family);
 703 int if_setflagbits(if_t ifp, int set, int clear);
 704 int if_getflags(if_t ifp);
 705 int if_sendq_empty(if_t ifp);
 706 int if_setsendqready(if_t ifp);
 707 int if_setsendqlen(if_t ifp, int tx_desc_count);
 708 int if_sethwtsomax(if_t ifp, u_int if_hw_tsomax);
 709 int if_sethwtsomaxsegcount(if_t ifp, u_int if_hw_tsomaxsegcount);
 710 int if_sethwtsomaxsegsize(if_t ifp, u_int if_hw_tsomaxsegsize);
 711 u_int if_gethwtsomax(if_t ifp);
 712 u_int if_gethwtsomaxsegcount(if_t ifp);
 713 u_int if_gethwtsomaxsegsize(if_t ifp);
 714 int if_input(if_t ifp, struct mbuf* sendmp);
 715 int if_sendq_prepend(if_t ifp, struct mbuf *m);
 716 struct mbuf *if_dequeue(if_t ifp);
 717 int if_setifheaderlen(if_t ifp, int len);
 718 void if_setrcvif(struct mbuf *m, if_t ifp);
 719 void if_setvtag(struct mbuf *m, u_int16_t tag);
 720 u_int16_t if_getvtag(struct mbuf *m);
 721 int if_vlantrunkinuse(if_t ifp);
 722 caddr_t if_getlladdr(if_t ifp);
 723 void *if_gethandle(u_char);
 724 void if_bpfmtap(if_t ifp, struct mbuf *m);
 725 void if_etherbpfmtap(if_t ifp, struct mbuf *m);
 726 void if_vlancap(if_t ifp);
 727
 728 int if_setupmultiaddr(if_t ifp, void *mta, int *cnt, int max);
 729 int if_multiaddr_array(if_t ifp, void *mta, int *cnt, int max);
 730 int if_multiaddr_count(if_t ifp, int max);
 731
 732 int if_multi_apply(struct ifnet *ifp, int (*filter)(void *, struct ifmultiaddr *, int), void *arg);
 733 int if_getamcount(if_t ifp);
 734 struct ifaddr * if_getifaddr(if_t ifp);
 735
 736 /* Functions */
 737 void if_setinitfn(if_t ifp, void (*)(void *));
 738 void if_setioctlfn(if_t ifp, int (*)(if_t, u_long, caddr_t));
 739 void if_setstartfn(if_t ifp, void (*)(if_t));
 740 void if_settransmitfn(if_t ifp, if_transmit_fn_t);
 741 void if_setqflushfn(if_t ifp, if_qflush_fn_t);
 742 void if_setgetcounterfn(if_t ifp, if_get_counter_t);
 743
 744 /* Revisit the below. These are inline functions originally */
 745 int drbr_inuse_drv(if_t ifp, struct buf_ring *br);
 746 struct mbuf* drbr_dequeue_drv(if_t ifp, struct buf_ring *br);
 747 int drbr_needs_enqueue_drv(if_t ifp, struct buf_ring *br);
 748 int drbr_enqueue_drv(if_t ifp, struct buf_ring *br, struct mbuf *m);
 749
 750 /* TSO */
 751 void if_hw_tsomax_common(if_t ifp, struct ifnet_hw_tsomax *);
 752 int if_hw_tsomax_update(if_t ifp, struct ifnet_hw_tsomax *);
 753
 754 /* accessors for struct ifreq */
 755 void *ifr_data_get_ptr(void *ifrp);
 756
 757 int ifhwioctl(u_long, struct ifnet *, caddr_t, struct thread *);
 758
 759 #ifdef DEVICE_POLLING
 760 enum poll_cmd { POLL_ONLY, POLL_AND_CHECK_STATUS };
 761
 762 typedef int poll_handler_t(if_t ifp, enum poll_cmd cmd, int count);
 763 int    ether_poll_register(poll_handler_t *h, if_t ifp);
 764 int    ether_poll_deregister(if_t ifp);
 765 #endif /* DEVICE_POLLING */
 766
 767 #endif /* _KERNEL */
 768
 769 #include <net/ifq.h>    /* XXXAO: temporary unconditional include */
 770
 771 #endif /* !_NET_IF_VAR_H_ */