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