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, ro)
  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  socket;
  65 struct  carp_if;
  66 struct  carp_softc;
  67 struct  ifvlantrunk;
  68 struct  route;                  /* if_output */
  69 struct  vnet;
  70 struct  ifmedia;
  71 struct  netmap_adapter;
  72 struct  debugnet_methods;
  73
  74 #ifdef _KERNEL
  75 #include <sys/_eventhandler.h>
  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 #endif /* _KERNEL */
 110
 111 typedef enum {
 112         IFCOUNTER_IPACKETS = 0,
 113         IFCOUNTER_IERRORS,
 114         IFCOUNTER_OPACKETS,
 115         IFCOUNTER_OERRORS,
 116         IFCOUNTER_COLLISIONS,
 117         IFCOUNTER_IBYTES,
 118         IFCOUNTER_OBYTES,
 119         IFCOUNTER_IMCASTS,
 120         IFCOUNTER_OMCASTS,
 121         IFCOUNTER_IQDROPS,
 122         IFCOUNTER_OQDROPS,
 123         IFCOUNTER_NOPROTO,
 124         IFCOUNTERS /* Array size. */
 125 } ift_counter;
 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_input_fn_t)(struct ifnet *, struct mbuf *);
 131 typedef int (*if_output_fn_t)
 132     (struct ifnet *, struct mbuf *, const struct sockaddr *, struct route *);
 133 typedef void (*if_qflush_fn_t)(if_t);
 134 typedef int (*if_transmit_fn_t)(if_t, struct mbuf *);
 135 typedef uint64_t (*if_get_counter_t)(if_t, ift_counter);
 136
 137 struct ifnet_hw_tsomax {
 138         u_int   tsomaxbytes;    /* TSO total burst length limit in bytes */
 139         u_int   tsomaxsegcount; /* TSO maximum segment count */
 140         u_int   tsomaxsegsize;  /* TSO maximum segment size in bytes */
 141 };
 142
 143 /* Interface encap request types */
 144 typedef enum {
 145         IFENCAP_LL = 1                  /* pre-calculate link-layer header */
 146 } ife_type;
 147
 148 /*
 149  * The structure below allows to request various pre-calculated L2/L3 headers
 150  * for different media. Requests varies by type (rtype field).
 151  *
 152  * IFENCAP_LL type: pre-calculates link header based on address family
 153  *   and destination lladdr.
 154  *
 155  *   Input data fields:
 156  *     buf: pointer to destination buffer
 157  *     bufsize: buffer size
 158  *     flags: IFENCAP_FLAG_BROADCAST if destination is broadcast
 159  *     family: address family defined by AF_ constant.
 160  *     lladdr: pointer to link-layer address
 161  *     lladdr_len: length of link-layer address
 162  *     hdata: pointer to L3 header (optional, used for ARP requests).
 163  *   Output data fields:
 164  *     buf: encap data is stored here
 165  *     bufsize: resulting encap length is stored here
 166  *     lladdr_off: offset of link-layer address from encap hdr start
 167  *     hdata: L3 header may be altered if necessary
 168  */
 169
 170 struct if_encap_req {
 171         u_char          *buf;           /* Destination buffer (w) */
 172         size_t          bufsize;        /* size of provided buffer (r) */
 173         ife_type        rtype;          /* request type (r) */
 174         uint32_t        flags;          /* Request flags (r) */
 175         int             family;         /* Address family AF_* (r) */
 176         int             lladdr_off;     /* offset from header start (w) */
 177         int             lladdr_len;     /* lladdr length (r) */
 178         char            *lladdr;        /* link-level address pointer (r) */
 179         char            *hdata;         /* Upper layer header data (rw) */
 180 };
 181
 182 #define IFENCAP_FLAG_BROADCAST  0x02    /* Destination is broadcast */
 183
 184 /*
 185  * Network interface send tag support. The storage of "struct
 186  * m_snd_tag" comes from the network driver and it is free to allocate
 187  * as much additional space as it wants for its own use.
 188  */
 189 struct ktls_session;
 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_TLS 2
 195 #define IF_SND_TAG_TYPE_TLS_RATE_LIMIT 3
 196 #define IF_SND_TAG_TYPE_TLS_RX 4
 197 #define IF_SND_TAG_TYPE_MAX 5
 198
 199 struct if_snd_tag_alloc_header {
 200         uint32_t type;          /* send tag type, see IF_SND_TAG_XXX */
 201         uint32_t flowid;        /* mbuf hash value */
 202         uint32_t flowtype;      /* mbuf hash type */
 203         uint8_t numa_domain;    /* numa domain of associated inp */
 204 };
 205
 206 struct if_snd_tag_alloc_rate_limit {
 207         struct if_snd_tag_alloc_header hdr;
 208         uint64_t max_rate;      /* in bytes/s */
 209         uint32_t flags;         /* M_NOWAIT or M_WAITOK */
 210         uint32_t reserved;      /* alignment */
 211 };
 212
 213 struct if_snd_tag_alloc_tls {
 214         struct if_snd_tag_alloc_header hdr;
 215         struct inpcb *inp;
 216         const struct ktls_session *tls;
 217 };
 218
 219 struct if_snd_tag_alloc_tls_rx {
 220         struct if_snd_tag_alloc_header hdr;
 221         struct inpcb *inp;
 222         const struct ktls_session *tls;
 223         uint16_t vlan_id;       /* valid if non-zero */
 224 };
 225
 226 struct if_snd_tag_alloc_tls_rate_limit {
 227         struct if_snd_tag_alloc_header hdr;
 228         struct inpcb *inp;
 229         const struct ktls_session *tls;
 230         uint64_t max_rate;      /* in bytes/s */
 231 };
 232
 233 struct if_snd_tag_rate_limit_params {
 234         uint64_t max_rate;      /* in bytes/s */
 235         uint32_t queue_level;   /* 0 (empty) .. 65535 (full) */
 236 #define IF_SND_QUEUE_LEVEL_MIN 0
 237 #define IF_SND_QUEUE_LEVEL_MAX 65535
 238         uint32_t flags;         /* M_NOWAIT or M_WAITOK */
 239 };
 240
 241 struct if_snd_tag_modify_tls_rx {
 242         /* TCP sequence number of TLS header in host endian format */
 243         uint32_t tls_hdr_tcp_sn;
 244
 245         /*
 246          * TLS record length, including all headers, data and trailers.
 247          * If the tls_rec_length is zero, it means HW encryption resumed.
 248          */
 249         uint32_t tls_rec_length;
 250
 251         /* TLS sequence number in host endian format */
 252         uint64_t tls_seq_number;
 253 };
 254
 255 union if_snd_tag_alloc_params {
 256         struct if_snd_tag_alloc_header hdr;
 257         struct if_snd_tag_alloc_rate_limit rate_limit;
 258         struct if_snd_tag_alloc_rate_limit unlimited;
 259         struct if_snd_tag_alloc_tls tls;
 260         struct if_snd_tag_alloc_tls_rx tls_rx;
 261         struct if_snd_tag_alloc_tls_rate_limit tls_rate_limit;
 262 };
 263
 264 union if_snd_tag_modify_params {
 265         struct if_snd_tag_rate_limit_params rate_limit;
 266         struct if_snd_tag_rate_limit_params unlimited;
 267         struct if_snd_tag_rate_limit_params tls_rate_limit;
 268         struct if_snd_tag_modify_tls_rx tls_rx;
 269 };
 270
 271 union if_snd_tag_query_params {
 272         struct if_snd_tag_rate_limit_params rate_limit;
 273         struct if_snd_tag_rate_limit_params unlimited;
 274         struct if_snd_tag_rate_limit_params tls_rate_limit;
 275 };
 276
 277 typedef int (if_snd_tag_alloc_t)(struct ifnet *, union if_snd_tag_alloc_params *,
 278     struct m_snd_tag **);
 279 typedef int (if_snd_tag_modify_t)(struct m_snd_tag *, union if_snd_tag_modify_params *);
 280 typedef int (if_snd_tag_query_t)(struct m_snd_tag *, union if_snd_tag_query_params *);
 281 typedef void (if_snd_tag_free_t)(struct m_snd_tag *);
 282 typedef struct m_snd_tag *(if_next_send_tag_t)(struct m_snd_tag *);
 283
 284 struct if_snd_tag_sw {
 285         if_snd_tag_modify_t *snd_tag_modify;
 286         if_snd_tag_query_t *snd_tag_query;
 287         if_snd_tag_free_t *snd_tag_free;
 288         if_next_send_tag_t *next_snd_tag;
 289         u_int   type;                   /* One of IF_SND_TAG_TYPE_*. */
 290 };
 291
 292 /* Query return flags */
 293 #define RT_NOSUPPORT      0x00000000    /* Not supported */
 294 #define RT_IS_INDIRECT    0x00000001    /*
 295                                          * Interface like a lagg, select
 296                                          * the actual interface for
 297                                          * capabilities.
 298                                          */
 299 #define RT_IS_SELECTABLE  0x00000002    /*
 300                                          * No rate table, you select
 301                                          * rates and the first
 302                                          * number_of_rates are created.
 303                                          */
 304 #define RT_IS_FIXED_TABLE 0x00000004    /* A fixed table is attached */
 305 #define RT_IS_UNUSABLE    0x00000008    /* It is not usable for this */
 306 #define RT_IS_SETUP_REQ   0x00000010    /* The interface setup must be called before use */
 307
 308 struct if_ratelimit_query_results {
 309         const uint64_t *rate_table;     /* Pointer to table if present */
 310         uint32_t flags;                 /* Flags indicating results */
 311         uint32_t max_flows;             /* Max flows using, 0=unlimited */
 312         uint32_t number_of_rates;       /* How many unique rates can be created */
 313         uint32_t min_segment_burst;     /* The amount the adapter bursts at each send */
 314 };
 315
 316 typedef void (if_ratelimit_query_t)(struct ifnet *,
 317     struct if_ratelimit_query_results *);
 318 typedef int (if_ratelimit_setup_t)(struct ifnet *, uint64_t, uint32_t);
 319 #define IF_NODOM        255
 320 /*
 321  * Locks for address lists on the network interface.
 322  */
 323 #define IF_ADDR_LOCK_INIT(if)   mtx_init(&(if)->if_addr_lock, "if_addr_lock", NULL, MTX_DEF)
 324 #define IF_ADDR_LOCK_DESTROY(if)        mtx_destroy(&(if)->if_addr_lock)
 325
 326 #define IF_ADDR_WLOCK(if)       mtx_lock(&(if)->if_addr_lock)
 327 #define IF_ADDR_WUNLOCK(if)     mtx_unlock(&(if)->if_addr_lock)
 328 #define IF_ADDR_LOCK_ASSERT(if) MPASS(in_epoch(net_epoch_preempt) || mtx_owned(&(if)->if_addr_lock))
 329 #define IF_ADDR_WLOCK_ASSERT(if) mtx_assert(&(if)->if_addr_lock, MA_OWNED)
 330
 331 #ifdef _KERNEL
 332 /* interface link layer address change event */
 333 typedef void (*iflladdr_event_handler_t)(void *, struct ifnet *);
 334 EVENTHANDLER_DECLARE(iflladdr_event, iflladdr_event_handler_t);
 335 /* interface address change event */
 336 typedef void (*ifaddr_event_handler_t)(void *, struct ifnet *);
 337 EVENTHANDLER_DECLARE(ifaddr_event, ifaddr_event_handler_t);
 338 typedef void (*ifaddr_event_ext_handler_t)(void *, struct ifnet *,
 339     struct ifaddr *, int);
 340 EVENTHANDLER_DECLARE(ifaddr_event_ext, ifaddr_event_ext_handler_t);
 341 #define IFADDR_EVENT_ADD        0
 342 #define IFADDR_EVENT_DEL        1
 343 /* new interface arrival event */
 344 typedef void (*ifnet_arrival_event_handler_t)(void *, struct ifnet *);
 345 EVENTHANDLER_DECLARE(ifnet_arrival_event, ifnet_arrival_event_handler_t);
 346 /* interface departure event */
 347 typedef void (*ifnet_departure_event_handler_t)(void *, struct ifnet *);
 348 EVENTHANDLER_DECLARE(ifnet_departure_event, ifnet_departure_event_handler_t);
 349 /* Interface link state change event */
 350 typedef void (*ifnet_link_event_handler_t)(void *, struct ifnet *, int);
 351 EVENTHANDLER_DECLARE(ifnet_link_event, ifnet_link_event_handler_t);
 352 /* Interface up/down event */
 353 #define IFNET_EVENT_UP          0
 354 #define IFNET_EVENT_DOWN        1
 355 #define IFNET_EVENT_PCP         2       /* priority code point, PCP */
 356 #define IFNET_EVENT_UPDATE_BAUDRATE     3
 357
 358 typedef void (*ifnet_event_fn)(void *, struct ifnet *ifp, int event);
 359 EVENTHANDLER_DECLARE(ifnet_event, ifnet_event_fn);
 360
 361 /*
 362  * interface groups
 363  */
 364 struct ifg_group {
 365         char                             ifg_group[IFNAMSIZ];
 366         u_int                            ifg_refcnt;
 367         void                            *ifg_pf_kif;
 368         CK_STAILQ_HEAD(, ifg_member)     ifg_members; /* (CK_) */
 369         CK_STAILQ_ENTRY(ifg_group)               ifg_next; /* (CK_) */
 370 };
 371
 372 struct ifg_member {
 373         CK_STAILQ_ENTRY(ifg_member)      ifgm_next; /* (CK_) */
 374         struct ifnet            *ifgm_ifp;
 375 };
 376
 377 struct ifg_list {
 378         struct ifg_group        *ifgl_group;
 379         CK_STAILQ_ENTRY(ifg_list)        ifgl_next; /* (CK_) */
 380 };
 381
 382 #ifdef _SYS_EVENTHANDLER_H_
 383 /* group attach event */
 384 typedef void (*group_attach_event_handler_t)(void *, struct ifg_group *);
 385 EVENTHANDLER_DECLARE(group_attach_event, group_attach_event_handler_t);
 386 /* group detach event */
 387 typedef void (*group_detach_event_handler_t)(void *, struct ifg_group *);
 388 EVENTHANDLER_DECLARE(group_detach_event, group_detach_event_handler_t);
 389 /* group change event */
 390 typedef void (*group_change_event_handler_t)(void *, const char *);
 391 EVENTHANDLER_DECLARE(group_change_event, group_change_event_handler_t);
 392 #endif /* _SYS_EVENTHANDLER_H_ */
 393
 394 #define IF_AFDATA_LOCK_INIT(ifp)        \
 395         mtx_init(&(ifp)->if_afdata_lock, "if_afdata", NULL, MTX_DEF)
 396
 397 #define IF_AFDATA_WLOCK(ifp)    mtx_lock(&(ifp)->if_afdata_lock)
 398 #define IF_AFDATA_WUNLOCK(ifp)  mtx_unlock(&(ifp)->if_afdata_lock)
 399 #define IF_AFDATA_LOCK(ifp)     IF_AFDATA_WLOCK(ifp)
 400 #define IF_AFDATA_UNLOCK(ifp)   IF_AFDATA_WUNLOCK(ifp)
 401 #define IF_AFDATA_TRYLOCK(ifp)  mtx_trylock(&(ifp)->if_afdata_lock)
 402 #define IF_AFDATA_DESTROY(ifp)  mtx_destroy(&(ifp)->if_afdata_lock)
 403
 404 #define IF_AFDATA_LOCK_ASSERT(ifp)      MPASS(in_epoch(net_epoch_preempt) || mtx_owned(&(ifp)->if_afdata_lock))
 405 #define IF_AFDATA_WLOCK_ASSERT(ifp)     mtx_assert(&(ifp)->if_afdata_lock, MA_OWNED)
 406 #define IF_AFDATA_UNLOCK_ASSERT(ifp)    mtx_assert(&(ifp)->if_afdata_lock, MA_NOTOWNED)
 407
 408 /*
 409  * 72 was chosen below because it is the size of a TCP/IP
 410  * header (40) + the minimum mss (32).
 411  */
 412 #define IF_MINMTU       72
 413 #define IF_MAXMTU       65535
 414
 415 #define TOEDEV(ifp)     ((ifp)->if_llsoftc)
 416
 417 /*
 418  * The ifaddr structure contains information about one address
 419  * of an interface.  They are maintained by the different address families,
 420  * are allocated and attached when an address is set, and are linked
 421  * together so all addresses for an interface can be located.
 422  *
 423  * NOTE: a 'struct ifaddr' is always at the beginning of a larger
 424  * chunk of malloc'ed memory, where we store the three addresses
 425  * (ifa_addr, ifa_dstaddr and ifa_netmask) referenced here.
 426  */
 427 struct ifaddr {
 428         struct  sockaddr *ifa_addr;     /* address of interface */
 429         struct  sockaddr *ifa_dstaddr;  /* other end of p-to-p link */
 430 #define ifa_broadaddr   ifa_dstaddr     /* broadcast address interface */
 431         struct  sockaddr *ifa_netmask;  /* used to determine subnet */
 432         struct  ifnet *ifa_ifp;         /* back-pointer to interface */
 433         struct  carp_softc *ifa_carp;   /* pointer to CARP data */
 434         CK_STAILQ_ENTRY(ifaddr) ifa_link;       /* queue macro glue */
 435         u_short ifa_flags;              /* mostly rt_flags for cloning */
 436 #define IFA_ROUTE       RTF_UP          /* route installed */
 437 #define IFA_RTSELF      RTF_HOST        /* loopback route to self installed */
 438         u_int   ifa_refcnt;             /* references to this structure */
 439
 440         counter_u64_t   ifa_ipackets;
 441         counter_u64_t   ifa_opackets;
 442         counter_u64_t   ifa_ibytes;
 443         counter_u64_t   ifa_obytes;
 444         struct  epoch_context   ifa_epoch_ctx;
 445 };
 446
 447 struct ifaddr * ifa_alloc(size_t size, int flags);
 448 void    ifa_free(struct ifaddr *ifa);
 449 void    ifa_ref(struct ifaddr *ifa);
 450 int __result_use_check ifa_try_ref(struct ifaddr *ifa);
 451
 452 /*
 453  * Multicast address structure.  This is analogous to the ifaddr
 454  * structure except that it keeps track of multicast addresses.
 455  */
 456 #define IFMA_F_ENQUEUED         0x1
 457 struct ifmultiaddr {
 458         CK_STAILQ_ENTRY(ifmultiaddr) ifma_link; /* queue macro glue */
 459         struct  sockaddr *ifma_addr;    /* address this membership is for */
 460         struct  sockaddr *ifma_lladdr;  /* link-layer translation, if any */
 461         struct  ifnet *ifma_ifp;        /* back-pointer to interface */
 462         u_int   ifma_refcount;          /* reference count */
 463         int     ifma_flags;
 464         void    *ifma_protospec;        /* protocol-specific state, if any */
 465         struct  ifmultiaddr *ifma_llifma; /* pointer to ifma for ifma_lladdr */
 466         struct  epoch_context   ifma_epoch_ctx;
 467 };
 468
 469 extern  struct sx ifnet_sxlock;
 470
 471 #define IFNET_WLOCK()           sx_xlock(&ifnet_sxlock)
 472 #define IFNET_WUNLOCK()         sx_xunlock(&ifnet_sxlock)
 473 #define IFNET_RLOCK_ASSERT()    sx_assert(&ifnet_sxlock, SA_SLOCKED)
 474 #define IFNET_WLOCK_ASSERT()    sx_assert(&ifnet_sxlock, SA_XLOCKED)
 475 #define IFNET_RLOCK()           sx_slock(&ifnet_sxlock)
 476 #define IFNET_RUNLOCK()         sx_sunlock(&ifnet_sxlock)
 477
 478 /*
 479  * Look up an ifnet given its index.  The returned value protected from
 480  * being freed by the network epoch.  The _ref variant also acquires a
 481  * reference that must be freed using if_rele().
 482  */
 483 struct ifnet    *ifnet_byindex(u_int);
 484 struct ifnet    *ifnet_byindex_ref(u_int);
 485
 486 /*
 487  * ifnet_byindexgen() looks up ifnet by index and generation count,
 488  * attempting to restore a weak pointer that had been stored across
 489  * the epoch.
 490  */
 491 struct ifnet   *ifnet_byindexgen(uint16_t idx, uint16_t gen);
 492
 493 VNET_DECLARE(struct ifnethead, ifnet);
 494 VNET_DECLARE(struct ifgrouphead, ifg_head);
 495 VNET_DECLARE(struct ifnet *, loif);     /* first loopback interface */
 496
 497 #define V_ifnet         VNET(ifnet)
 498 #define V_ifg_head      VNET(ifg_head)
 499 #define V_loif          VNET(loif)
 500
 501 #ifdef MCAST_VERBOSE
 502 #define MCDPRINTF printf
 503 #else
 504 #define MCDPRINTF(...)
 505 #endif
 506
 507 int     if_addgroup(struct ifnet *, const char *);
 508 int     if_delgroup(struct ifnet *, const char *);
 509 int     if_addmulti(struct ifnet *, struct sockaddr *, struct ifmultiaddr **);
 510 int     if_allmulti(struct ifnet *, int);
 511 struct  ifnet* if_alloc(u_char);
 512 struct  ifnet* if_alloc_dev(u_char, device_t dev);
 513 void    if_attach(struct ifnet *);
 514 void    if_dead(struct ifnet *);
 515 int     if_delmulti(struct ifnet *, struct sockaddr *);
 516 void    if_delmulti_ifma(struct ifmultiaddr *);
 517 void    if_delmulti_ifma_flags(struct ifmultiaddr *, int flags);
 518 void    if_detach(struct ifnet *);
 519 void    if_purgeaddrs(struct ifnet *);
 520 void    if_delallmulti(struct ifnet *);
 521 void    if_down(struct ifnet *);
 522 struct ifmultiaddr *
 523         if_findmulti(struct ifnet *, const struct sockaddr *);
 524 void    if_freemulti(struct ifmultiaddr *ifma);
 525 void    if_free(struct ifnet *);
 526 void    if_initname(struct ifnet *, const char *, int);
 527 void    if_link_state_change(struct ifnet *, int);
 528 int     if_printf(struct ifnet *, const char *, ...) __printflike(2, 3);
 529 int     if_log(struct ifnet *, int, const char *, ...) __printflike(3, 4);
 530 void    if_ref(struct ifnet *);
 531 void    if_rele(struct ifnet *);
 532 bool    __result_use_check if_try_ref(struct ifnet *);
 533 int     if_setlladdr(struct ifnet *, const u_char *, int);
 534 int     if_tunnel_check_nesting(struct ifnet *, struct mbuf *, uint32_t, int);
 535 void    if_up(struct ifnet *);
 536 int     ifioctl(struct socket *, u_long, caddr_t, struct thread *);
 537 int     ifpromisc(struct ifnet *, int);
 538 struct  ifnet *ifunit(const char *);
 539 struct  ifnet *ifunit_ref(const char *);
 540
 541 int     ifa_add_loopback_route(struct ifaddr *, struct sockaddr *);
 542 int     ifa_del_loopback_route(struct ifaddr *, struct sockaddr *);
 543 int     ifa_switch_loopback_route(struct ifaddr *, struct sockaddr *);
 544
 545 struct  ifaddr *ifa_ifwithaddr(const struct sockaddr *);
 546 int             ifa_ifwithaddr_check(const struct sockaddr *);
 547 struct  ifaddr *ifa_ifwithbroadaddr(const struct sockaddr *, int);
 548 struct  ifaddr *ifa_ifwithdstaddr(const struct sockaddr *, int);
 549 struct  ifaddr *ifa_ifwithnet(const struct sockaddr *, int, int);
 550 struct  ifaddr *ifa_ifwithroute(int, const struct sockaddr *,
 551     const struct sockaddr *, u_int);
 552 struct  ifaddr *ifaof_ifpforaddr(const struct sockaddr *, struct ifnet *);
 553 int     ifa_preferred(struct ifaddr *, struct ifaddr *);
 554
 555 int     if_simloop(struct ifnet *ifp, struct mbuf *m, int af, int hlen);
 556
 557 typedef void *if_com_alloc_t(u_char type, struct ifnet *ifp);
 558 typedef void if_com_free_t(void *com, u_char type);
 559 void    if_register_com_alloc(u_char type, if_com_alloc_t *a, if_com_free_t *f);
 560 void    if_deregister_com_alloc(u_char type);
 561 void    if_data_copy(struct ifnet *, struct if_data *);
 562 uint64_t if_get_counter_default(struct ifnet *, ift_counter);
 563 void    if_inc_counter(struct ifnet *, ift_counter, int64_t);
 564
 565 #define IF_LLADDR(ifp)                                                  \
 566     LLADDR((struct sockaddr_dl *)((ifp)->if_addr->ifa_addr))
 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_getdunit(const if_t ifp);
 578 int if_getindex(const if_t ifp);
 579 const char *if_getdname(const if_t ifp);
 580 void if_setdname(if_t ifp, const char *name);
 581 const char *if_name(if_t ifp);
 582 int if_setname(if_t ifp, const char *name);
 583 void if_setdescr(if_t ifp, char *descrbuf);
 584 char *if_allocdescr(size_t sz, int malloc_flag);
 585 void if_freedescr(char *descrbuf);
 586 int if_getalloctype(const if_t ifp);
 587 int if_setdev(if_t ifp, void *dev);
 588 int if_setdrvflagbits(if_t ifp, int if_setflags, int clear_flags);
 589 int if_getdrvflags(const if_t ifp);
 590 int if_setdrvflags(if_t ifp, int flags);
 591 int if_clearhwassist(if_t ifp);
 592 int if_sethwassistbits(if_t ifp, int toset, int toclear);
 593 int if_sethwassist(if_t ifp, int hwassist_bit);
 594 int if_gethwassist(const if_t ifp);
 595 int if_togglehwassist(if_t ifp, int toggle_bits);
 596 int if_setsoftc(if_t ifp, void *softc);
 597 void *if_getsoftc(if_t ifp);
 598 int if_setflags(if_t ifp, int flags);
 599 int if_gethwaddr(const if_t ifp, struct ifreq *);
 600 int if_setmtu(if_t ifp, int mtu);
 601 int if_getmtu(const if_t ifp);
 602 int if_getmtu_family(const if_t ifp, int family);
 603 int if_setflagbits(if_t ifp, int set, int clear);
 604 int if_getflags(const if_t ifp);
 605 int if_sendq_empty(if_t ifp);
 606 int if_setsendqready(if_t ifp);
 607 int if_setsendqlen(if_t ifp, int tx_desc_count);
 608 int if_sethwtsomax(if_t ifp, u_int if_hw_tsomax);
 609 int if_sethwtsomaxsegcount(if_t ifp, u_int if_hw_tsomaxsegcount);
 610 int if_sethwtsomaxsegsize(if_t ifp, u_int if_hw_tsomaxsegsize);
 611 u_int if_gethwtsomax(const if_t ifp);
 612 u_int if_gethwtsomaxsegcount(const if_t ifp);
 613 u_int if_gethwtsomaxsegsize(const if_t ifp);
 614 int if_input(if_t ifp, struct mbuf* sendmp);
 615 int if_sendq_prepend(if_t ifp, struct mbuf *m);
 616 struct mbuf *if_dequeue(if_t ifp);
 617 int if_setifheaderlen(if_t ifp, int len);
 618 void if_setrcvif(struct mbuf *m, if_t ifp);
 619 void if_setvtag(struct mbuf *m, u_int16_t tag);
 620 u_int16_t if_getvtag(struct mbuf *m);
 621 int if_vlantrunkinuse(if_t ifp);
 622 caddr_t if_getlladdr(const if_t ifp);
 623 void *if_gethandle(u_char);
 624 void if_bpfmtap(if_t ifp, struct mbuf *m);
 625 void if_etherbpfmtap(if_t ifp, struct mbuf *m);
 626 void if_vlancap(if_t ifp);
 627 int if_transmit(if_t ifp, struct mbuf *m);
 628 int if_init(if_t ifp, void *ctx);
 629
 630 /*
 631  * Traversing through interface address lists.
 632  */
 633 struct sockaddr_dl;
 634 typedef u_int iflladdr_cb_t(void *, struct sockaddr_dl *, u_int);
 635 u_int if_foreach_lladdr(if_t, iflladdr_cb_t, void *);
 636 u_int if_foreach_llmaddr(if_t, iflladdr_cb_t, void *);
 637 u_int if_lladdr_count(if_t);
 638 u_int if_llmaddr_count(if_t);
 639
 640 int if_getamcount(const if_t ifp);
 641 struct ifaddr * if_getifaddr(const if_t ifp);
 642 typedef u_int if_addr_cb_t(void *, struct ifaddr *, u_int);
 643 u_int if_foreach_addr_type(if_t ifp, int type, if_addr_cb_t cb, void *cb_arg);
 644
 645 /* Functions */
 646 void if_setinitfn(if_t ifp, if_init_fn_t);
 647 void if_setinputfn(if_t ifp, if_input_fn_t);
 648 void if_setioctlfn(if_t ifp, if_ioctl_fn_t);
 649 void if_setoutputfn(if_t ifp, int(*)
 650     (if_t, struct mbuf *, const struct sockaddr *, struct route *));
 651 void if_setstartfn(if_t ifp, void (*)(if_t));
 652 void if_settransmitfn(if_t ifp, if_transmit_fn_t);
 653 void if_setqflushfn(if_t ifp, if_qflush_fn_t);
 654 void if_setgetcounterfn(if_t ifp, if_get_counter_t);
 655 void if_setsndtagallocfn(if_t ifp, if_snd_tag_alloc_t);
 656 void if_setdebugnet_methods(struct ifnet *, struct debugnet_methods *);
 657
 658 /* TSO */
 659 void if_hw_tsomax_common(if_t ifp, struct ifnet_hw_tsomax *);
 660 int if_hw_tsomax_update(if_t ifp, struct ifnet_hw_tsomax *);
 661
 662 /* accessors for struct ifreq */
 663 void *ifr_data_get_ptr(void *ifrp);
 664 void *ifr_buffer_get_buffer(void *data);
 665 size_t ifr_buffer_get_length(void *data);
 666
 667 int ifhwioctl(u_long, struct ifnet *, caddr_t, struct thread *);
 668
 669 #ifdef DEVICE_POLLING
 670 enum poll_cmd { POLL_ONLY, POLL_AND_CHECK_STATUS };
 671
 672 typedef int poll_handler_t(if_t ifp, enum poll_cmd cmd, int count);
 673 int    ether_poll_register(poll_handler_t *h, if_t ifp);
 674 int    ether_poll_deregister(if_t ifp);
 675 #endif /* DEVICE_POLLING */
 676
 677 #endif /* _KERNEL */
 678
 679 #include <net/if_private.h>     /* XXX: temporary until drivers converted. */
 680 #include <net/ifq.h>    /* XXXAO: temporary unconditional include */
 681
 682 #endif /* !_NET_IF_VAR_H_ */