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
  32 #ifndef _NET_IF_VAR_H_
  33 #define _NET_IF_VAR_H_
  34
  35 /*
  36  * Structures defining a network interface, providing a packet
  37  * transport mechanism (ala level 0 of the PUP protocols).
  38  *
  39  * Each interface accepts output datagrams of a specified maximum
  40  * length, and provides higher level routines with input datagrams
  41  * received from its medium.
  42  *
  43  * Output occurs when the routine if_output is called, with three parameters:
  44  *      (*ifp->if_output)(ifp, m, dst, ro)
  45  * Here m is the mbuf chain to be sent and dst is the destination address.
  46  * The output routine encapsulates the supplied datagram if necessary,
  47  * and then transmits it on its medium.
  48  *
  49  * On input, each interface unwraps the data received by it, and either
  50  * places it on the input queue of an internetwork datagram routine
  51  * and posts the associated software interrupt, or passes the datagram to a raw
  52  * packet input routine.
  53  *
  54  * Routines exist for locating interfaces by their addresses
  55  * or for locating an interface on a certain network, as well as more general
  56  * routing and gateway routines maintaining information used to locate
  57  * interfaces.  These routines live in the files if.c and route.c
  58  */
  59
  60 struct  rtentry;                /* ifa_rtrequest */
  61 struct  socket;
  62 struct  carp_if;
  63 struct  carp_softc;
  64 struct  ifvlantrunk;
  65 struct  route;                  /* if_output */
  66 struct  vnet;
  67 struct  ifmedia;
  68 struct  netmap_adapter;
  69 struct  debugnet_methods;
  70
  71 #ifdef _KERNEL
  72 #include <sys/_eventhandler.h>
  73 #include <sys/mbuf.h>           /* ifqueue only? */
  74 #include <sys/buf_ring.h>
  75 #include <net/vnet.h>
  76 #endif /* _KERNEL */
  77 #include <sys/ck.h>
  78 #include <sys/counter.h>
  79 #include <sys/epoch.h>
  80 #include <sys/lock.h>           /* XXX */
  81 #include <sys/mutex.h>          /* struct ifqueue */
  82 #include <sys/rwlock.h>         /* XXX */
  83 #include <sys/sx.h>             /* XXX */
  84 #include <sys/_task.h>          /* if_link_task */
  85 #define IF_DUNIT_NONE   -1
  86
  87 #include <net/altq/if_altq.h>
  88
  89 CK_STAILQ_HEAD(ifnethead, ifnet);       /* we use TAILQs so that the order of */
  90 CK_STAILQ_HEAD(ifaddrhead, ifaddr);     /* instantiation is preserved in the list */
  91 CK_STAILQ_HEAD(ifmultihead, ifmultiaddr);
  92 CK_STAILQ_HEAD(ifgrouphead, ifg_group);
  93
  94 #ifdef _KERNEL
  95 VNET_DECLARE(struct pfil_head *, link_pfil_head);
  96 #define V_link_pfil_head        VNET(link_pfil_head)
  97 #define PFIL_ETHER_NAME         "ethernet"
  98
  99 #define HHOOK_IPSEC_INET        0
 100 #define HHOOK_IPSEC_INET6       1
 101 #define HHOOK_IPSEC_COUNT       2
 102 VNET_DECLARE(struct hhook_head *, ipsec_hhh_in[HHOOK_IPSEC_COUNT]);
 103 VNET_DECLARE(struct hhook_head *, ipsec_hhh_out[HHOOK_IPSEC_COUNT]);
 104 #define V_ipsec_hhh_in  VNET(ipsec_hhh_in)
 105 #define V_ipsec_hhh_out VNET(ipsec_hhh_out)
 106 #endif /* _KERNEL */
 107
 108 typedef enum {
 109         IFCOUNTER_IPACKETS = 0,
 110         IFCOUNTER_IERRORS,
 111         IFCOUNTER_OPACKETS,
 112         IFCOUNTER_OERRORS,
 113         IFCOUNTER_COLLISIONS,
 114         IFCOUNTER_IBYTES,
 115         IFCOUNTER_OBYTES,
 116         IFCOUNTER_IMCASTS,
 117         IFCOUNTER_OMCASTS,
 118         IFCOUNTER_IQDROPS,
 119         IFCOUNTER_OQDROPS,
 120         IFCOUNTER_NOPROTO,
 121         IFCOUNTERS /* Array size. */
 122 } ift_counter;
 123
 124 typedef void (*if_start_fn_t)(if_t);
 125 typedef int (*if_ioctl_fn_t)(if_t, u_long, caddr_t);
 126 typedef void (*if_init_fn_t)(void *);
 127 typedef void (*if_input_fn_t)(if_t, struct mbuf *);
 128 typedef int (*if_output_fn_t)(if_t, struct mbuf *, const struct sockaddr *,
 129     struct route *);
 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 typedef void (*if_reassign_fn_t)(if_t, struct vnet *, char *);
 134 typedef int (*if_spdadd_fn_t)(if_t ifp, void *sp, void *inp, void **priv);
 135 typedef int (*if_spddel_fn_t)(if_t ifp, void *sp, void *priv);
 136 typedef int (*if_sa_newkey_fn_t)(if_t ifp, void *sav, u_int drv_spi,
 137     void **privp);
 138 typedef int (*if_sa_deinstall_fn_t)(if_t ifp, u_int drv_spi, void *priv);
 139 struct seclifetime;
 140 #define IF_SA_CNT_UPD   0x80000000
 141 enum IF_SA_CNT_WHICH {
 142         IF_SA_CNT_IFP_HW_VAL = 1,
 143         IF_SA_CNT_TOTAL_SW_VAL,
 144         IF_SA_CNT_TOTAL_HW_VAL,
 145         IF_SA_CNT_IFP_HW_UPD = IF_SA_CNT_IFP_HW_VAL | IF_SA_CNT_UPD,
 146         IF_SA_CNT_TOTAL_SW_UPD = IF_SA_CNT_TOTAL_SW_VAL | IF_SA_CNT_UPD,
 147         IF_SA_CNT_TOTAL_HW_UPD = IF_SA_CNT_TOTAL_HW_VAL | IF_SA_CNT_UPD,
 148 };
 149 typedef int (*if_sa_cnt_fn_t)(if_t ifp, void *sa,
 150     uint32_t drv_spi, void *priv, struct seclifetime *lt);
 151 typedef int (*if_ipsec_hwassist_fn_t)(if_t ifp, void *sav,
 152     u_int drv_spi,void *priv);
 153
 154 struct ifnet_hw_tsomax {
 155         u_int   tsomaxbytes;    /* TSO total burst length limit in bytes */
 156         u_int   tsomaxsegcount; /* TSO maximum segment count */
 157         u_int   tsomaxsegsize;  /* TSO maximum segment size in bytes */
 158 };
 159
 160 /* Interface encap request types */
 161 typedef enum {
 162         IFENCAP_LL = 1                  /* pre-calculate link-layer header */
 163 } ife_type;
 164
 165 /*
 166  * The structure below allows to request various pre-calculated L2/L3 headers
 167  * for different media. Requests varies by type (rtype field).
 168  *
 169  * IFENCAP_LL type: pre-calculates link header based on address family
 170  *   and destination lladdr.
 171  *
 172  *   Input data fields:
 173  *     buf: pointer to destination buffer
 174  *     bufsize: buffer size
 175  *     flags: IFENCAP_FLAG_BROADCAST if destination is broadcast
 176  *     family: address family defined by AF_ constant.
 177  *     lladdr: pointer to link-layer address
 178  *     lladdr_len: length of link-layer address
 179  *     hdata: pointer to L3 header (optional, used for ARP requests).
 180  *   Output data fields:
 181  *     buf: encap data is stored here
 182  *     bufsize: resulting encap length is stored here
 183  *     lladdr_off: offset of link-layer address from encap hdr start
 184  *     hdata: L3 header may be altered if necessary
 185  */
 186
 187 struct if_encap_req {
 188         u_char          *buf;           /* Destination buffer (w) */
 189         size_t          bufsize;        /* size of provided buffer (r) */
 190         ife_type        rtype;          /* request type (r) */
 191         uint32_t        flags;          /* Request flags (r) */
 192         int             family;         /* Address family AF_* (r) */
 193         int             lladdr_off;     /* offset from header start (w) */
 194         int             lladdr_len;     /* lladdr length (r) */
 195         char            *lladdr;        /* link-level address pointer (r) */
 196         char            *hdata;         /* Upper layer header data (rw) */
 197 };
 198
 199 #define IFENCAP_FLAG_BROADCAST  0x02    /* Destination is broadcast */
 200
 201 /*
 202  * Network interface send tag support. The storage of "struct
 203  * m_snd_tag" comes from the network driver and it is free to allocate
 204  * as much additional space as it wants for its own use.
 205  */
 206 struct ktls_session;
 207 struct m_snd_tag;
 208
 209 #define IF_SND_TAG_TYPE_RATE_LIMIT 0
 210 #define IF_SND_TAG_TYPE_UNLIMITED 1
 211 #define IF_SND_TAG_TYPE_TLS 2
 212 #define IF_SND_TAG_TYPE_TLS_RATE_LIMIT 3
 213 #define IF_SND_TAG_TYPE_TLS_RX 4
 214 #define IF_SND_TAG_TYPE_MAX 5
 215
 216 struct if_snd_tag_alloc_header {
 217         uint32_t type;          /* send tag type, see IF_SND_TAG_XXX */
 218         uint32_t flowid;        /* mbuf hash value */
 219         uint32_t flowtype;      /* mbuf hash type */
 220         uint8_t numa_domain;    /* numa domain of associated inp */
 221 };
 222
 223 struct if_snd_tag_alloc_rate_limit {
 224         struct if_snd_tag_alloc_header hdr;
 225         uint64_t max_rate;      /* in bytes/s */
 226         uint32_t flags;         /* M_NOWAIT or M_WAITOK */
 227         uint32_t reserved;      /* alignment */
 228 };
 229
 230 struct if_snd_tag_alloc_tls {
 231         struct if_snd_tag_alloc_header hdr;
 232         struct inpcb *inp;
 233         const struct ktls_session *tls;
 234 };
 235
 236 struct if_snd_tag_alloc_tls_rx {
 237         struct if_snd_tag_alloc_header hdr;
 238         struct inpcb *inp;
 239         const struct ktls_session *tls;
 240         uint16_t vlan_id;       /* valid if non-zero */
 241 };
 242
 243 struct if_snd_tag_alloc_tls_rate_limit {
 244         struct if_snd_tag_alloc_header hdr;
 245         struct inpcb *inp;
 246         const struct ktls_session *tls;
 247         uint64_t max_rate;      /* in bytes/s */
 248 };
 249
 250 struct if_snd_tag_rate_limit_params {
 251         uint64_t max_rate;      /* in bytes/s */
 252         uint32_t queue_level;   /* 0 (empty) .. 65535 (full) */
 253 #define IF_SND_QUEUE_LEVEL_MIN 0
 254 #define IF_SND_QUEUE_LEVEL_MAX 65535
 255         uint32_t flags;         /* M_NOWAIT or M_WAITOK */
 256 };
 257
 258 struct if_snd_tag_modify_tls_rx {
 259         /* TCP sequence number of TLS header in host endian format */
 260         uint32_t tls_hdr_tcp_sn;
 261
 262         /*
 263          * TLS record length, including all headers, data and trailers.
 264          * If the tls_rec_length is zero, it means HW encryption resumed.
 265          */
 266         uint32_t tls_rec_length;
 267
 268         /* TLS sequence number in host endian format */
 269         uint64_t tls_seq_number;
 270 };
 271
 272 union if_snd_tag_alloc_params {
 273         struct if_snd_tag_alloc_header hdr;
 274         struct if_snd_tag_alloc_rate_limit rate_limit;
 275         struct if_snd_tag_alloc_rate_limit unlimited;
 276         struct if_snd_tag_alloc_tls tls;
 277         struct if_snd_tag_alloc_tls_rx tls_rx;
 278         struct if_snd_tag_alloc_tls_rate_limit tls_rate_limit;
 279 };
 280
 281 union if_snd_tag_modify_params {
 282         struct if_snd_tag_rate_limit_params rate_limit;
 283         struct if_snd_tag_rate_limit_params unlimited;
 284         struct if_snd_tag_rate_limit_params tls_rate_limit;
 285         struct if_snd_tag_modify_tls_rx tls_rx;
 286 };
 287
 288 union if_snd_tag_query_params {
 289         struct if_snd_tag_rate_limit_params rate_limit;
 290         struct if_snd_tag_rate_limit_params unlimited;
 291         struct if_snd_tag_rate_limit_params tls_rate_limit;
 292 };
 293
 294 typedef int (if_snd_tag_alloc_t)(if_t, union if_snd_tag_alloc_params *,
 295     struct m_snd_tag **);
 296 typedef int (if_snd_tag_modify_t)(struct m_snd_tag *, union if_snd_tag_modify_params *);
 297 typedef int (if_snd_tag_query_t)(struct m_snd_tag *, union if_snd_tag_query_params *);
 298 typedef void (if_snd_tag_free_t)(struct m_snd_tag *);
 299 typedef struct m_snd_tag *(if_next_send_tag_t)(struct m_snd_tag *);
 300
 301 struct if_snd_tag_sw {
 302         if_snd_tag_modify_t *snd_tag_modify;
 303         if_snd_tag_query_t *snd_tag_query;
 304         if_snd_tag_free_t *snd_tag_free;
 305         if_next_send_tag_t *next_snd_tag;
 306         u_int   type;                   /* One of IF_SND_TAG_TYPE_*. */
 307 };
 308
 309 /* Query return flags */
 310 #define RT_NOSUPPORT      0x00000000    /* Not supported */
 311 #define RT_IS_INDIRECT    0x00000001    /*
 312                                          * Interface like a lagg, select
 313                                          * the actual interface for
 314                                          * capabilities.
 315                                          */
 316 #define RT_IS_SELECTABLE  0x00000002    /*
 317                                          * No rate table, you select
 318                                          * rates and the first
 319                                          * number_of_rates are created.
 320                                          */
 321 #define RT_IS_FIXED_TABLE 0x00000004    /* A fixed table is attached */
 322 #define RT_IS_UNUSABLE    0x00000008    /* It is not usable for this */
 323 #define RT_IS_SETUP_REQ   0x00000010    /* The interface setup must be called before use */
 324
 325 struct if_ratelimit_query_results {
 326         const uint64_t *rate_table;     /* Pointer to table if present */
 327         uint32_t flags;                 /* Flags indicating results */
 328         uint32_t max_flows;             /* Max flows using, 0=unlimited */
 329         uint32_t number_of_rates;       /* How many unique rates can be created */
 330         uint32_t min_segment_burst;     /* The amount the adapter bursts at each send */
 331 };
 332
 333 typedef void (if_ratelimit_query_t)(if_t,
 334     struct if_ratelimit_query_results *);
 335 typedef int (if_ratelimit_setup_t)(if_t, uint64_t, uint32_t);
 336 #define IF_NODOM        255
 337 /*
 338  * Locks for address lists on the network interface.
 339  */
 340 #define IF_ADDR_LOCK_INIT(if)   mtx_init(&(if)->if_addr_lock, "if_addr_lock", NULL, MTX_DEF)
 341 #define IF_ADDR_LOCK_DESTROY(if)        mtx_destroy(&(if)->if_addr_lock)
 342
 343 #define IF_ADDR_WLOCK(if)       mtx_lock(&(if)->if_addr_lock)
 344 #define IF_ADDR_WUNLOCK(if)     mtx_unlock(&(if)->if_addr_lock)
 345 #define IF_ADDR_LOCK_ASSERT(if) MPASS(in_epoch(net_epoch_preempt) || mtx_owned(&(if)->if_addr_lock))
 346 #define IF_ADDR_WLOCK_ASSERT(if) mtx_assert(&(if)->if_addr_lock, MA_OWNED)
 347
 348 #ifdef _KERNEL
 349 /* interface link layer address change event */
 350 typedef void (*iflladdr_event_handler_t)(void *, if_t);
 351 EVENTHANDLER_DECLARE(iflladdr_event, iflladdr_event_handler_t);
 352 /* interface address change event */
 353 typedef void (*ifaddr_event_handler_t)(void *, if_t);
 354 EVENTHANDLER_DECLARE(ifaddr_event, ifaddr_event_handler_t);
 355 typedef void (*ifaddr_event_ext_handler_t)(void *, if_t, struct ifaddr *, int);
 356 EVENTHANDLER_DECLARE(ifaddr_event_ext, ifaddr_event_ext_handler_t);
 357 #define IFADDR_EVENT_ADD        0
 358 #define IFADDR_EVENT_DEL        1
 359 /* new interface arrival event */
 360 typedef void (*ifnet_arrival_event_handler_t)(void *, if_t);
 361 EVENTHANDLER_DECLARE(ifnet_arrival_event, ifnet_arrival_event_handler_t);
 362 /* interface departure event */
 363 typedef void (*ifnet_departure_event_handler_t)(void *, if_t);
 364 EVENTHANDLER_DECLARE(ifnet_departure_event, ifnet_departure_event_handler_t);
 365 /* Interface link state change event */
 366 typedef void (*ifnet_link_event_handler_t)(void *, if_t, int);
 367 EVENTHANDLER_DECLARE(ifnet_link_event, ifnet_link_event_handler_t);
 368 /* Interface up/down event */
 369 #define IFNET_EVENT_UP          0
 370 #define IFNET_EVENT_DOWN        1
 371 #define IFNET_EVENT_PCP         2       /* priority code point, PCP */
 372 #define IFNET_EVENT_UPDATE_BAUDRATE     3
 373
 374 typedef void (*ifnet_event_fn)(void *, if_t ifp, int event);
 375 EVENTHANDLER_DECLARE(ifnet_event, ifnet_event_fn);
 376
 377 /*
 378  * interface groups
 379  */
 380 struct ifg_group {
 381         char                             ifg_group[IFNAMSIZ];
 382         u_int                            ifg_refcnt;
 383         void                            *ifg_pf_kif;
 384         CK_STAILQ_HEAD(, ifg_member)     ifg_members; /* (CK_) */
 385         CK_STAILQ_ENTRY(ifg_group)               ifg_next; /* (CK_) */
 386 };
 387
 388 struct ifg_member {
 389         CK_STAILQ_ENTRY(ifg_member)      ifgm_next; /* (CK_) */
 390         if_t                             ifgm_ifp;
 391 };
 392
 393 struct ifg_list {
 394         struct ifg_group        *ifgl_group;
 395         CK_STAILQ_ENTRY(ifg_list)        ifgl_next; /* (CK_) */
 396 };
 397
 398 #ifdef _SYS_EVENTHANDLER_H_
 399 /* group attach event */
 400 typedef void (*group_attach_event_handler_t)(void *, struct ifg_group *);
 401 EVENTHANDLER_DECLARE(group_attach_event, group_attach_event_handler_t);
 402 /* group detach event */
 403 typedef void (*group_detach_event_handler_t)(void *, struct ifg_group *);
 404 EVENTHANDLER_DECLARE(group_detach_event, group_detach_event_handler_t);
 405 /* group change event */
 406 typedef void (*group_change_event_handler_t)(void *, const char *);
 407 EVENTHANDLER_DECLARE(group_change_event, group_change_event_handler_t);
 408 #endif /* _SYS_EVENTHANDLER_H_ */
 409
 410 /*
 411  * 72 was chosen below because it is the size of a TCP/IP
 412  * header (40) + the minimum mss (32).
 413  */
 414 #define IF_MINMTU       72
 415 #define IF_MAXMTU       65535
 416
 417 #define TOEDEV(ifp)             if_getllsoftc(ifp)
 418 #define SETTOEDEV(ifp, sc)      if_setllsoftc((ifp), (sc))
 419
 420 /*
 421  * The ifaddr structure contains information about one address
 422  * of an interface.  They are maintained by the different address families,
 423  * are allocated and attached when an address is set, and are linked
 424  * together so all addresses for an interface can be located.
 425  *
 426  * NOTE: a 'struct ifaddr' is always at the beginning of a larger
 427  * chunk of malloc'ed memory, where we store the three addresses
 428  * (ifa_addr, ifa_dstaddr and ifa_netmask) referenced here.
 429  */
 430 struct ifaddr {
 431         struct  sockaddr *ifa_addr;     /* address of interface */
 432         struct  sockaddr *ifa_dstaddr;  /* other end of p-to-p link */
 433 #define ifa_broadaddr   ifa_dstaddr     /* broadcast address interface */
 434         struct  sockaddr *ifa_netmask;  /* used to determine subnet */
 435         if_t             ifa_ifp;               /* back-pointer to interface */
 436         struct  carp_softc *ifa_carp;   /* pointer to CARP data */
 437         CK_STAILQ_ENTRY(ifaddr) ifa_link;       /* queue macro glue */
 438         u_short ifa_flags;              /* mostly rt_flags for cloning */
 439 #define IFA_ROUTE       RTF_UP          /* route installed */
 440 #define IFA_RTSELF      RTF_HOST        /* loopback route to self installed */
 441         u_int   ifa_refcnt;             /* references to this structure */
 442
 443         counter_u64_t   ifa_ipackets;
 444         counter_u64_t   ifa_opackets;
 445         counter_u64_t   ifa_ibytes;
 446         counter_u64_t   ifa_obytes;
 447         struct  epoch_context   ifa_epoch_ctx;
 448 };
 449
 450 struct ifaddr * ifa_alloc(size_t size, int flags);
 451 void    ifa_free(struct ifaddr *ifa);
 452 void    ifa_ref(struct ifaddr *ifa);
 453 int __result_use_check ifa_try_ref(struct ifaddr *ifa);
 454
 455 /*
 456  * Multicast address structure.  This is analogous to the ifaddr
 457  * structure except that it keeps track of multicast addresses.
 458  */
 459 #define IFMA_F_ENQUEUED         0x1
 460 struct ifmultiaddr {
 461         CK_STAILQ_ENTRY(ifmultiaddr) ifma_link; /* queue macro glue */
 462         struct  sockaddr *ifma_addr;    /* address this membership is for */
 463         struct  sockaddr *ifma_lladdr;  /* link-layer translation, if any */
 464         if_t    ifma_ifp;               /* back-pointer to interface */
 465         u_int   ifma_refcount;          /* reference count */
 466         int     ifma_flags;
 467         void    *ifma_protospec;        /* protocol-specific state, if any */
 468         struct  ifmultiaddr *ifma_llifma; /* pointer to ifma for ifma_lladdr */
 469         struct  epoch_context   ifma_epoch_ctx;
 470 };
 471
 472 extern  struct sx ifnet_sxlock;
 473
 474 #define IFNET_WLOCK()           sx_xlock(&ifnet_sxlock)
 475 #define IFNET_WUNLOCK()         sx_xunlock(&ifnet_sxlock)
 476 #define IFNET_RLOCK_ASSERT()    sx_assert(&ifnet_sxlock, SA_SLOCKED)
 477 #define IFNET_WLOCK_ASSERT()    sx_assert(&ifnet_sxlock, SA_XLOCKED)
 478 #define IFNET_RLOCK()           sx_slock(&ifnet_sxlock)
 479 #define IFNET_RUNLOCK()         sx_sunlock(&ifnet_sxlock)
 480
 481 /*
 482  * Look up an ifnet given its index.  The returned value protected from
 483  * being freed by the network epoch.  The _ref variant also acquires a
 484  * reference that must be freed using if_rele().
 485  */
 486 if_t ifnet_byindex(u_int);
 487 if_t ifnet_byindex_ref(u_int);
 488
 489 /*
 490  * ifnet_byindexgen() looks up ifnet by index and generation count,
 491  * attempting to restore a weak pointer that had been stored across
 492  * the epoch.
 493  */
 494 if_t ifnet_byindexgen(uint16_t idx, uint16_t gen);
 495
 496 VNET_DECLARE(struct ifnethead, ifnet);
 497 VNET_DECLARE(struct ifgrouphead, ifg_head);
 498 VNET_DECLARE(if_t, loif);       /* first loopback interface */
 499
 500 #define V_ifnet         VNET(ifnet)
 501 #define V_ifg_head      VNET(ifg_head)
 502 #define V_loif          VNET(loif)
 503
 504 #ifdef MCAST_VERBOSE
 505 #define MCDPRINTF printf
 506 #else
 507 #define MCDPRINTF(...)
 508 #endif
 509
 510 int     if_addgroup(if_t, const char *);
 511 int     if_delgroup(if_t, const char *);
 512 int     if_addmulti(if_t, struct sockaddr *, struct ifmultiaddr **);
 513 int     if_allmulti(if_t, int);
 514 if_t    if_alloc(u_char);
 515 if_t    if_alloc_dev(u_char, device_t dev);
 516 void    if_attach(if_t);
 517 void    if_dead(if_t);
 518 int     if_delmulti(if_t, struct sockaddr *);
 519 void    if_delmulti_ifma(struct ifmultiaddr *);
 520 void    if_delmulti_ifma_flags(struct ifmultiaddr *, int flags);
 521 void    if_detach(if_t);
 522 void    if_purgeaddrs(if_t);
 523 void    if_delallmulti(if_t);
 524 void    if_down(if_t);
 525 struct ifmultiaddr *
 526         if_findmulti(if_t, const struct sockaddr *);
 527 void    if_freemulti(struct ifmultiaddr *ifma);
 528 void    if_free(if_t);
 529 void    if_initname(if_t, const char *, int);
 530 void    if_link_state_change(if_t, int);
 531 int     if_printf(if_t, const char *, ...) __printflike(2, 3);
 532 int     if_log(if_t, int, const char *, ...) __printflike(3, 4);
 533 void    if_ref(if_t);
 534 void    if_rele(if_t);
 535 bool    __result_use_check if_try_ref(if_t);
 536 int     if_setlladdr(if_t, const u_char *, int);
 537 int     if_tunnel_check_nesting(if_t, struct mbuf *, uint32_t, int);
 538 void    if_up(if_t);
 539 int     ifioctl(struct socket *, u_long, caddr_t, struct thread *);
 540 int     ifpromisc(if_t, int);
 541 if_t    ifunit(const char *);
 542 if_t    ifunit_ref(const char *);
 543
 544 int     ifa_add_loopback_route(struct ifaddr *, struct sockaddr *);
 545 int     ifa_del_loopback_route(struct ifaddr *, struct sockaddr *);
 546 int     ifa_switch_loopback_route(struct ifaddr *, struct sockaddr *);
 547
 548 struct  ifaddr *ifa_ifwithaddr(const struct sockaddr *);
 549 int             ifa_ifwithaddr_check(const struct sockaddr *);
 550 struct  ifaddr *ifa_ifwithbroadaddr(const struct sockaddr *, int);
 551 struct  ifaddr *ifa_ifwithdstaddr(const struct sockaddr *, int);
 552 struct  ifaddr *ifa_ifwithnet(const struct sockaddr *, int, int);
 553 struct  ifaddr *ifa_ifwithroute(int, const struct sockaddr *,
 554     const struct sockaddr *, u_int);
 555 struct  ifaddr *ifaof_ifpforaddr(const struct sockaddr *, if_t);
 556 int     ifa_preferred(struct ifaddr *, struct ifaddr *);
 557
 558 int     if_simloop(if_t ifp, struct mbuf *m, int af, int hlen);
 559
 560 typedef void *if_com_alloc_t(u_char type, if_t ifp);
 561 typedef void if_com_free_t(void *com, u_char type);
 562 void    if_register_com_alloc(u_char type, if_com_alloc_t *a, if_com_free_t *f);
 563 void    if_deregister_com_alloc(u_char type);
 564 void    if_data_copy(if_t, struct if_data *);
 565 uint64_t if_get_counter_default(if_t, ift_counter);
 566 void    if_inc_counter(if_t, ift_counter, int64_t);
 567
 568 uint64_t if_setbaudrate(if_t ifp, uint64_t baudrate);
 569 uint64_t if_getbaudrate(const if_t ifp);
 570 int if_setcapabilities(if_t ifp, int capabilities);
 571 int if_setcapabilitiesbit(if_t ifp, int setbit, int clearbit);
 572 int if_getcapabilities(const if_t ifp);
 573 int if_togglecapenable(if_t ifp, int togglecap);
 574 int if_setcapenable(if_t ifp, int capenable);
 575 int if_setcapenablebit(if_t ifp, int setcap, int clearcap);
 576 int if_getcapenable(const if_t ifp);
 577 int if_setcapabilities2(if_t ifp, int capabilities);
 578 int if_setcapabilities2bit(if_t ifp, int setbit, int clearbit);
 579 int if_getcapabilities2(const if_t ifp);
 580 int if_togglecapenable2(if_t ifp, int togglecap);
 581 int if_setcapenable2(if_t ifp, int capenable);
 582 int if_setcapenable2bit(if_t ifp, int setcap, int clearcap);
 583 int if_getcapenable2(const if_t ifp);
 584 int if_getdunit(const if_t ifp);
 585 int if_getindex(const if_t ifp);
 586 int if_getidxgen(const if_t ifp);
 587 const char *if_getdname(const if_t ifp);
 588 void if_setdname(if_t ifp, const char *name);
 589 const char *if_name(if_t ifp);
 590 int if_setname(if_t ifp, const char *name);
 591 int if_rename(if_t ifp, char *new_name);
 592 const char *if_getdescr(if_t ifp);
 593 void if_setdescr(if_t ifp, char *descrbuf);
 594 char *if_allocdescr(size_t sz, int malloc_flag);
 595 void if_freedescr(char *descrbuf);
 596 void if_setlastchange(if_t ifp);
 597 int if_getalloctype(const if_t ifp);
 598 int if_gettype(const if_t ifp);
 599 int if_setdev(if_t ifp, void *dev);
 600 int if_setdrvflagbits(if_t ifp, int if_setflags, int clear_flags);
 601 int if_getdrvflags(const if_t ifp);
 602 int if_setdrvflags(if_t ifp, int flags);
 603 int if_getlinkstate(if_t ifp);
 604 int if_clearhwassist(if_t ifp);
 605 int if_sethwassistbits(if_t ifp, int toset, int toclear);
 606 int if_sethwassist(if_t ifp, int hwassist_bit);
 607 int if_gethwassist(const if_t ifp);
 608 int if_togglehwassist(if_t ifp, int toggle_bits);
 609 int if_setsoftc(if_t ifp, void *softc);
 610 void *if_getsoftc(if_t ifp);
 611 int if_setflags(if_t ifp, int flags);
 612 void if_setllsoftc(if_t ifp, void *softc);
 613 void *if_getllsoftc(if_t ifp);
 614 u_int if_getfib(if_t ifp);
 615 uint8_t if_getaddrlen(if_t ifp);
 616 int if_gethwaddr(const if_t ifp, struct ifreq *);
 617 const uint8_t *if_getbroadcastaddr(const if_t ifp);
 618 void if_setbroadcastaddr(if_t ifp, const uint8_t *);
 619 int if_setmtu(if_t ifp, int mtu);
 620 int if_getmtu(const if_t ifp);
 621 int if_getmtu_family(const if_t ifp, int family);
 622 void if_notifymtu(if_t ifp);
 623 int if_setflagbits(if_t ifp, int set, int clear);
 624 int if_setflags(if_t ifp, int flags);
 625 int if_getflags(const if_t ifp);
 626 int if_getnumadomain(if_t ifp);
 627 int if_sendq_empty(if_t ifp);
 628 int if_setsendqready(if_t ifp);
 629 int if_setsendqlen(if_t ifp, int tx_desc_count);
 630 int if_sethwtsomax(if_t ifp, u_int if_hw_tsomax);
 631 int if_sethwtsomaxsegcount(if_t ifp, u_int if_hw_tsomaxsegcount);
 632 int if_sethwtsomaxsegsize(if_t ifp, u_int if_hw_tsomaxsegsize);
 633 u_int if_gethwtsomax(const if_t ifp);
 634 u_int if_gethwtsomaxsegcount(const if_t ifp);
 635 u_int if_gethwtsomaxsegsize(const if_t ifp);
 636 void if_setnetmapadapter(if_t ifp, struct netmap_adapter *na);
 637 struct netmap_adapter *if_getnetmapadapter(if_t ifp);
 638 void if_input(if_t ifp, struct mbuf* sendmp);
 639 int if_sendq_prepend(if_t ifp, struct mbuf *m);
 640 struct mbuf *if_dequeue(if_t ifp);
 641 int if_setifheaderlen(if_t ifp, int len);
 642 void if_setrcvif(struct mbuf *m, if_t ifp);
 643 void if_setvtag(struct mbuf *m, u_int16_t tag);
 644 u_int16_t if_getvtag(struct mbuf *m);
 645 int if_vlantrunkinuse(if_t ifp);
 646 char *if_getlladdr(const if_t ifp);
 647 struct vnet *if_getvnet(const if_t ifp);
 648 void *if_gethandle(u_char);
 649 void if_vlancap(if_t ifp);
 650 int if_transmit(if_t ifp, struct mbuf *m);
 651 void if_init(if_t ifp, void *ctx);
 652 int if_ioctl(if_t ifp, u_long cmd, void *data);
 653 int if_resolvemulti(if_t ifp, struct sockaddr **, struct sockaddr *);
 654 uint64_t if_getcounter(if_t ifp, ift_counter counter);
 655 struct label *if_getmaclabel(if_t ifp);
 656 void if_setmaclabel(if_t ifp, struct label *label);
 657 struct bpf_if *if_getbpf(if_t ifp);
 658 uint8_t if_getpcp(if_t ifp);
 659 void *if_getl2com(if_t ifp);
 660 struct ifvlantrunk *if_getvlantrunk(if_t ifp);
 661 bool if_altq_is_enabled(if_t ifp);
 662
 663 void *if_getafdata(if_t ifp, int);
 664
 665 int if_snd_tag_alloc(if_t ifp, union if_snd_tag_alloc_params *params,
 666     struct m_snd_tag **mstp);
 667 /*
 668  * Traversing through interface address lists.
 669  */
 670 struct sockaddr_dl;
 671 typedef u_int iflladdr_cb_t(void *, struct sockaddr_dl *, u_int);
 672 u_int if_foreach_lladdr(if_t, iflladdr_cb_t, void *);
 673 u_int if_foreach_llmaddr(if_t, iflladdr_cb_t, void *);
 674 u_int if_lladdr_count(if_t);
 675 u_int if_llmaddr_count(if_t);
 676 bool if_maddr_empty(if_t);
 677
 678 struct ifaddr * if_getifaddr(const if_t ifp);
 679 typedef u_int if_addr_cb_t(void *, struct ifaddr *, u_int);
 680 u_int if_foreach_addr_type(if_t ifp, int type, if_addr_cb_t cb, void *cb_arg);
 681
 682 typedef int (*if_foreach_cb_t)(if_t, void *);
 683 typedef bool (*if_foreach_match_t)(if_t, void *);
 684 int     if_foreach(if_foreach_cb_t, void *);
 685 int     if_foreach_sleep(if_foreach_match_t, void *, if_foreach_cb_t, void *);
 686
 687 /* Opaque iterator structure for iterating over interfaces. */
 688 struct if_iter {
 689         void *context[4];
 690 };
 691
 692 if_t    if_iter_start(struct if_iter *);
 693 if_t    if_iter_next(struct if_iter *);
 694 void    if_iter_finish(struct if_iter *);
 695
 696 struct ifa_iter {
 697         void *context[4];
 698 };
 699
 700 struct ifaddr *ifa_iter_start(if_t ifp, struct ifa_iter *iter);
 701 struct ifaddr *ifa_iter_next(struct ifa_iter *iter);
 702 void ifa_iter_finish(struct ifa_iter *iter);
 703
 704 /* Functions */
 705 void if_setinitfn(if_t ifp, if_init_fn_t);
 706 void if_setinputfn(if_t ifp, if_input_fn_t);
 707 if_input_fn_t if_getinputfn(if_t ifp);
 708 void if_setioctlfn(if_t ifp, if_ioctl_fn_t);
 709 void if_setoutputfn(if_t ifp, if_output_fn_t);
 710 void if_setstartfn(if_t ifp, if_start_fn_t);
 711 if_start_fn_t if_getstartfn(if_t ifp);
 712 void if_settransmitfn(if_t ifp, if_transmit_fn_t);
 713 if_transmit_fn_t if_gettransmitfn(if_t ifp);
 714 void if_setqflushfn(if_t ifp, if_qflush_fn_t);
 715 void if_setgetcounterfn(if_t ifp, if_get_counter_t);
 716 void if_setsndtagallocfn(if_t ifp, if_snd_tag_alloc_t);
 717 void if_setdebugnet_methods(if_t, struct debugnet_methods *);
 718 void if_setreassignfn(if_t ifp, if_reassign_fn_t);
 719 void if_setratelimitqueryfn(if_t ifp, if_ratelimit_query_t);
 720
 721 /*
 722  * NB: The interface is not yet stable, drivers implementing IPSEC
 723  * offload need to be prepared to adapt to changes.
 724  */
 725 struct if_ipsec_accel_methods {
 726         if_spdadd_fn_t          if_spdadd;
 727         if_spddel_fn_t          if_spddel;
 728         if_sa_newkey_fn_t       if_sa_newkey;
 729         if_sa_deinstall_fn_t    if_sa_deinstall;
 730         if_sa_cnt_fn_t          if_sa_cnt;
 731         if_ipsec_hwassist_fn_t  if_hwassist;
 732 };
 733 void if_setipsec_accel_methods(if_t ifp, const struct if_ipsec_accel_methods *);
 734
 735 /* TSO */
 736 void if_hw_tsomax_common(if_t ifp, struct ifnet_hw_tsomax *);
 737 int if_hw_tsomax_update(if_t ifp, struct ifnet_hw_tsomax *);
 738
 739 /* accessors for struct ifreq */
 740 void *ifr_data_get_ptr(void *ifrp);
 741 void *ifr_buffer_get_buffer(void *data);
 742 size_t ifr_buffer_get_length(void *data);
 743
 744 int ifhwioctl(u_long, if_t, caddr_t, struct thread *);
 745
 746 #ifdef DEVICE_POLLING
 747 enum poll_cmd { POLL_ONLY, POLL_AND_CHECK_STATUS };
 748
 749 typedef int poll_handler_t(if_t ifp, enum poll_cmd cmd, int count);
 750 int    ether_poll_register(poll_handler_t *h, if_t ifp);
 751 int    ether_poll_deregister(if_t ifp);
 752 #endif /* DEVICE_POLLING */
 753
 754 #endif /* _KERNEL */
 755
 756 #include <net/ifq.h>    /* XXXAO: temporary unconditional include */
 757
 758 #endif /* !_NET_IF_VAR_H_ */