if_var.h revision 186199
1139823Simp/*- 221259Swollman * Copyright (c) 1982, 1986, 1989, 1993 321259Swollman * The Regents of the University of California. All rights reserved. 421259Swollman * 521259Swollman * Redistribution and use in source and binary forms, with or without 621259Swollman * modification, are permitted provided that the following conditions 721259Swollman * are met: 821259Swollman * 1. Redistributions of source code must retain the above copyright 921259Swollman * notice, this list of conditions and the following disclaimer. 1021259Swollman * 2. Redistributions in binary form must reproduce the above copyright 1121259Swollman * notice, this list of conditions and the following disclaimer in the 1221259Swollman * documentation and/or other materials provided with the distribution. 1321259Swollman * 4. Neither the name of the University nor the names of its contributors 1421259Swollman * may be used to endorse or promote products derived from this software 1521259Swollman * without specific prior written permission. 1621259Swollman * 1721259Swollman * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 1821259Swollman * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 1921259Swollman * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 2021259Swollman * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 2121259Swollman * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 2221259Swollman * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 2321259Swollman * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 2421259Swollman * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 2521259Swollman * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 2621259Swollman * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 2721259Swollman * SUCH DAMAGE. 2821259Swollman * 2921259Swollman * From: @(#)if.h 8.1 (Berkeley) 6/10/93 3050477Speter * $FreeBSD: head/sys/net/if_var.h 186199 2008-12-17 00:11:56Z kmacy $ 3121259Swollman */ 3221259Swollman 3321259Swollman#ifndef _NET_IF_VAR_H_ 3421259Swollman#define _NET_IF_VAR_H_ 3521259Swollman 3621259Swollman/* 3721259Swollman * Structures defining a network interface, providing a packet 3821259Swollman * transport mechanism (ala level 0 of the PUP protocols). 3921259Swollman * 4021259Swollman * Each interface accepts output datagrams of a specified maximum 4121259Swollman * length, and provides higher level routines with input datagrams 4221259Swollman * received from its medium. 4321259Swollman * 4421259Swollman * Output occurs when the routine if_output is called, with three parameters: 4521259Swollman * (*ifp->if_output)(ifp, m, dst, rt) 4621259Swollman * Here m is the mbuf chain to be sent and dst is the destination address. 4721259Swollman * The output routine encapsulates the supplied datagram if necessary, 4821259Swollman * and then transmits it on its medium. 4921259Swollman * 5021259Swollman * On input, each interface unwraps the data received by it, and either 51108533Sschweikh * places it on the input queue of an internetwork datagram routine 5221259Swollman * and posts the associated software interrupt, or passes the datagram to a raw 5321259Swollman * packet input routine. 5421259Swollman * 5521259Swollman * Routines exist for locating interfaces by their addresses 56108533Sschweikh * or for locating an interface on a certain network, as well as more general 5721259Swollman * routing and gateway routines maintaining information used to locate 5821259Swollman * interfaces. These routines live in the files if.c and route.c 5921259Swollman */ 6021259Swollman 6121259Swollman#ifdef __STDC__ 6221259Swollman/* 6321259Swollman * Forward structure declarations for function prototypes [sic]. 6421259Swollman */ 6521259Swollmanstruct mbuf; 6683366Sjulianstruct thread; 6721259Swollmanstruct rtentry; 6885074Srustruct rt_addrinfo; 6921259Swollmanstruct socket; 7021259Swollmanstruct ether_header; 71142215Sglebiusstruct carp_if; 72155051Sglebiusstruct ifvlantrunk; 7321259Swollman#endif 7421259Swollman 7521259Swollman#include <sys/queue.h> /* get TAILQ macros */ 7621259Swollman 7769224Sjlemon#ifdef _KERNEL 7869152Sjlemon#include <sys/mbuf.h> 79126264Smlaier#include <sys/eventhandler.h> 8069224Sjlemon#endif /* _KERNEL */ 8174914Sjhb#include <sys/lock.h> /* XXX */ 8274914Sjhb#include <sys/mutex.h> /* XXX */ 83186199Skmacy#include <sys/rwlock.h> /* XXX */ 8483130Sjlemon#include <sys/event.h> /* XXX */ 85132712Srwatson#include <sys/_task.h> 8669152Sjlemon 87121816Sbrooks#define IF_DUNIT_NONE -1 88121816Sbrooks 89130416Smlaier#include <altq/if_altq.h> 90130416Smlaier 9160938SjakeTAILQ_HEAD(ifnethead, ifnet); /* we use TAILQs so that the order of */ 9260938SjakeTAILQ_HEAD(ifaddrhead, ifaddr); /* instantiation is preserved in the list */ 9360938SjakeTAILQ_HEAD(ifprefixhead, ifprefix); 9472084SphkTAILQ_HEAD(ifmultihead, ifmultiaddr); 95159781SmlaierTAILQ_HEAD(ifgrouphead, ifg_group); 9621259Swollman 9721259Swollman/* 9821259Swollman * Structure defining a queue for a network interface. 9921259Swollman */ 10021259Swollmanstruct ifqueue { 10121259Swollman struct mbuf *ifq_head; 10221259Swollman struct mbuf *ifq_tail; 10321259Swollman int ifq_len; 10421259Swollman int ifq_maxlen; 10521259Swollman int ifq_drops; 10669152Sjlemon struct mtx ifq_mtx; 10721259Swollman}; 10821259Swollman 10921259Swollman/* 11021259Swollman * Structure defining a network interface. 11121259Swollman * 11221259Swollman * (Would like to call this struct ``if'', but C isn't PL/1.) 11321259Swollman */ 11484380Smjacob 11521259Swollmanstruct ifnet { 11621259Swollman void *if_softc; /* pointer to driver state */ 117147256Sbrooks void *if_l2com; /* pointer to protocol bits */ 11860938Sjake TAILQ_ENTRY(ifnet) if_link; /* all struct ifnets are chained */ 119121816Sbrooks char if_xname[IFNAMSIZ]; /* external name (name + unit) */ 120121816Sbrooks const char *if_dname; /* driver name */ 121121816Sbrooks int if_dunit; /* unit or IF_DUNIT_NONE */ 12221259Swollman struct ifaddrhead if_addrhead; /* linked list of addresses per if */ 123128291Sluigi /* 124128291Sluigi * if_addrhead is the list of all addresses associated to 125128315Sluigi * an interface. 126128315Sluigi * Some code in the kernel assumes that first element 127128315Sluigi * of the list has type AF_LINK, and contains sockaddr_dl 128128315Sluigi * addresses which store the link-level address and the name 129128291Sluigi * of the interface. 130128315Sluigi * However, access to the AF_LINK address through this 131152315Sru * field is deprecated. Use if_addr or ifaddr_byindex() instead. 132128291Sluigi */ 133133741Sjmg struct knlist if_klist; /* events attached to this if */ 13483130Sjlemon int if_pcount; /* number of promiscuous listeners */ 135142901Sglebius struct carp_if *if_carp; /* carp interface structure */ 13621259Swollman struct bpf_if *if_bpf; /* packet filter structure */ 13721259Swollman u_short if_index; /* numeric abbreviation for this if */ 13821259Swollman short if_timer; /* time 'til if_watchdog called */ 139155051Sglebius struct ifvlantrunk *if_vlantrunk; /* pointer to 802.1q data */ 140102052Ssobomax int if_flags; /* up/down, broadcast, etc. */ 141162070Sandre int if_capabilities; /* interface features & capabilities */ 142162070Sandre int if_capenable; /* enabled features & capabilities */ 14321259Swollman void *if_linkmib; /* link-type-specific MIB data */ 14421259Swollman size_t if_linkmiblen; /* length of above data */ 14521259Swollman struct if_data if_data; 14621404Swollman struct ifmultihead if_multiaddrs; /* multicast addresses configured */ 14721404Swollman int if_amcount; /* number of all-multicast requests */ 14821259Swollman/* procedure handles */ 14921259Swollman int (*if_output) /* output routine (enqueue) */ 15092725Salfred (struct ifnet *, struct mbuf *, struct sockaddr *, 15192725Salfred struct rtentry *); 152106931Ssam void (*if_input) /* input routine (from h/w driver) */ 153106931Ssam (struct ifnet *, struct mbuf *); 15421259Swollman void (*if_start) /* initiate output routine */ 15592725Salfred (struct ifnet *); 15621259Swollman int (*if_ioctl) /* ioctl routine */ 15792725Salfred (struct ifnet *, u_long, caddr_t); 15821259Swollman void (*if_watchdog) /* timer routine */ 15992725Salfred (struct ifnet *); 16021259Swollman void (*if_init) /* Init routine */ 16192725Salfred (void *); 16221404Swollman int (*if_resolvemulti) /* validate/resolve multicast */ 16392725Salfred (struct ifnet *, struct sockaddr **, struct sockaddr *); 164152315Sru struct ifaddr *if_addr; /* pointer to link-level address */ 165174388Skmacy void *if_llsoftc; /* link layer softc */ 166148265Srwatson int if_drv_flags; /* driver-managed status flags */ 167137062Srwatson u_int if_spare_flags2; /* spare flags 2 */ 168130416Smlaier struct ifaltq if_snd; /* output queue (includes altq) */ 169123220Simp const u_int8_t *if_broadcastaddr; /* linklevel broadcast bytestring */ 170127828Sluigi 171146986Sthompsa void *if_bridge; /* bridge glue */ 172146986Sthompsa 173122524Srwatson struct label *if_label; /* interface MAC label */ 174121161Sume 175127828Sluigi /* these are only used by IPv6 */ 176127828Sluigi struct ifprefixhead if_prefixhead; /* list of prefixes per if */ 177121161Sume void *if_afdata[AF_MAX]; 178121470Sume int if_afdata_initialized; 179186199Skmacy struct rwlock if_afdata_lock; 180132712Srwatson struct task if_starttask; /* task for IFF_NEEDSGIANT */ 181145320Sglebius struct task if_linktask; /* task for link change events */ 182148640Srwatson struct mtx if_addr_mtx; /* mutex to protect address lists */ 183186119Sqingli 184152209Sthompsa LIST_ENTRY(ifnet) if_clones; /* interfaces of a cloner */ 185159781Smlaier TAILQ_HEAD(, ifg_list) if_groups; /* linked list of groups per if */ 186159781Smlaier /* protected by if_addr_mtx */ 187159781Smlaier void *if_pf_kif; 188168793Sthompsa void *if_lagg; /* lagg glue */ 189186199Skmacy void *if_pspare[8]; /* TOE 3; vimage 3; general use 4 */ 190186199Skmacy void (*if_qflush) /* flush any queues */ 191185162Skmacy (struct ifnet *); 192185162Skmacy int (*if_transmit) /* initiate output routine */ 193185162Skmacy (struct ifnet *, struct mbuf *); 194174388Skmacy int if_ispare[2]; /* general use 2 */ 19521259Swollman}; 19669152Sjlemon 19792725Salfredtypedef void if_init_f_t(void *); 19821259Swollman 199128376Sluigi/* 200128376Sluigi * XXX These aliases are terribly dangerous because they could apply 201128376Sluigi * to anything. 202128376Sluigi */ 20321259Swollman#define if_mtu if_data.ifi_mtu 20421259Swollman#define if_type if_data.ifi_type 20521259Swollman#define if_physical if_data.ifi_physical 20621259Swollman#define if_addrlen if_data.ifi_addrlen 20721259Swollman#define if_hdrlen if_data.ifi_hdrlen 20821259Swollman#define if_metric if_data.ifi_metric 209128871Sandre#define if_link_state if_data.ifi_link_state 21021259Swollman#define if_baudrate if_data.ifi_baudrate 21158698Sjlemon#define if_hwassist if_data.ifi_hwassist 21221259Swollman#define if_ipackets if_data.ifi_ipackets 21321259Swollman#define if_ierrors if_data.ifi_ierrors 21421259Swollman#define if_opackets if_data.ifi_opackets 21521259Swollman#define if_oerrors if_data.ifi_oerrors 21621259Swollman#define if_collisions if_data.ifi_collisions 21721259Swollman#define if_ibytes if_data.ifi_ibytes 21821259Swollman#define if_obytes if_data.ifi_obytes 21921259Swollman#define if_imcasts if_data.ifi_imcasts 22021259Swollman#define if_omcasts if_data.ifi_omcasts 22121259Swollman#define if_iqdrops if_data.ifi_iqdrops 22221259Swollman#define if_noproto if_data.ifi_noproto 22321259Swollman#define if_lastchange if_data.ifi_lastchange 224136950Sjmg#define if_rawoutput(if, m, sa) if_output(if, m, sa, (struct rtentry *)NULL) 22521259Swollman 22653541Sshin/* for compatibility with other BSDs */ 22753541Sshin#define if_addrlist if_addrhead 22853541Sshin#define if_list if_link 229160981Sbrooks#define if_name(ifp) ((ifp)->if_xname) 23053541Sshin 23121259Swollman/* 232148640Srwatson * Locks for address lists on the network interface. 233148640Srwatson */ 234148640Srwatson#define IF_ADDR_LOCK_INIT(if) mtx_init(&(if)->if_addr_mtx, \ 235148640Srwatson "if_addr_mtx", NULL, MTX_DEF) 236148640Srwatson#define IF_ADDR_LOCK_DESTROY(if) mtx_destroy(&(if)->if_addr_mtx) 237148640Srwatson#define IF_ADDR_LOCK(if) mtx_lock(&(if)->if_addr_mtx) 238148640Srwatson#define IF_ADDR_UNLOCK(if) mtx_unlock(&(if)->if_addr_mtx) 239148640Srwatson#define IF_ADDR_LOCK_ASSERT(if) mtx_assert(&(if)->if_addr_mtx, MA_OWNED) 240148640Srwatson 241148640Srwatson/* 24221259Swollman * Output queues (ifp->if_snd) and slow device input queues (*ifp->if_slowq) 24321259Swollman * are queues of messages stored on ifqueue structures 24421259Swollman * (defined above). Entries are added to and deleted from these structures 24521259Swollman * by these macros, which should be called with ipl raised to splimp(). 24621259Swollman */ 24772200Sbmilekic#define IF_LOCK(ifq) mtx_lock(&(ifq)->ifq_mtx) 24872200Sbmilekic#define IF_UNLOCK(ifq) mtx_unlock(&(ifq)->ifq_mtx) 249130416Smlaier#define IF_LOCK_ASSERT(ifq) mtx_assert(&(ifq)->ifq_mtx, MA_OWNED) 25069152Sjlemon#define _IF_QFULL(ifq) ((ifq)->ifq_len >= (ifq)->ifq_maxlen) 25169152Sjlemon#define _IF_DROP(ifq) ((ifq)->ifq_drops++) 25269152Sjlemon#define _IF_QLEN(ifq) ((ifq)->ifq_len) 25321259Swollman 25469152Sjlemon#define _IF_ENQUEUE(ifq, m) do { \ 25569152Sjlemon (m)->m_nextpkt = NULL; \ 25669152Sjlemon if ((ifq)->ifq_tail == NULL) \ 25769152Sjlemon (ifq)->ifq_head = m; \ 25869152Sjlemon else \ 25969152Sjlemon (ifq)->ifq_tail->m_nextpkt = m; \ 26069152Sjlemon (ifq)->ifq_tail = m; \ 26169152Sjlemon (ifq)->ifq_len++; \ 26269152Sjlemon} while (0) 26369152Sjlemon 26469152Sjlemon#define IF_ENQUEUE(ifq, m) do { \ 26569152Sjlemon IF_LOCK(ifq); \ 26669152Sjlemon _IF_ENQUEUE(ifq, m); \ 26769152Sjlemon IF_UNLOCK(ifq); \ 26869152Sjlemon} while (0) 26969152Sjlemon 27069152Sjlemon#define _IF_PREPEND(ifq, m) do { \ 27169152Sjlemon (m)->m_nextpkt = (ifq)->ifq_head; \ 27269152Sjlemon if ((ifq)->ifq_tail == NULL) \ 27369152Sjlemon (ifq)->ifq_tail = (m); \ 27469152Sjlemon (ifq)->ifq_head = (m); \ 27569152Sjlemon (ifq)->ifq_len++; \ 27669152Sjlemon} while (0) 27769152Sjlemon 27869152Sjlemon#define IF_PREPEND(ifq, m) do { \ 27969152Sjlemon IF_LOCK(ifq); \ 28069152Sjlemon _IF_PREPEND(ifq, m); \ 28169152Sjlemon IF_UNLOCK(ifq); \ 28269152Sjlemon} while (0) 28369152Sjlemon 28469152Sjlemon#define _IF_DEQUEUE(ifq, m) do { \ 28569152Sjlemon (m) = (ifq)->ifq_head; \ 28669152Sjlemon if (m) { \ 287136950Sjmg if (((ifq)->ifq_head = (m)->m_nextpkt) == NULL) \ 28869152Sjlemon (ifq)->ifq_tail = NULL; \ 28969152Sjlemon (m)->m_nextpkt = NULL; \ 29069152Sjlemon (ifq)->ifq_len--; \ 29169152Sjlemon } \ 29269152Sjlemon} while (0) 29369152Sjlemon 29469152Sjlemon#define IF_DEQUEUE(ifq, m) do { \ 29569152Sjlemon IF_LOCK(ifq); \ 29669152Sjlemon _IF_DEQUEUE(ifq, m); \ 29769152Sjlemon IF_UNLOCK(ifq); \ 29869152Sjlemon} while (0) 29969152Sjlemon 300130416Smlaier#define _IF_POLL(ifq, m) ((m) = (ifq)->ifq_head) 301130416Smlaier#define IF_POLL(ifq, m) _IF_POLL(ifq, m) 302130416Smlaier 303130416Smlaier#define _IF_DRAIN(ifq) do { \ 30469152Sjlemon struct mbuf *m; \ 30569152Sjlemon for (;;) { \ 30669152Sjlemon _IF_DEQUEUE(ifq, m); \ 30769152Sjlemon if (m == NULL) \ 30869152Sjlemon break; \ 30969152Sjlemon m_freem(m); \ 31069152Sjlemon } \ 31169152Sjlemon} while (0) 31269152Sjlemon 313130416Smlaier#define IF_DRAIN(ifq) do { \ 314130416Smlaier IF_LOCK(ifq); \ 315130416Smlaier _IF_DRAIN(ifq); \ 316130416Smlaier IF_UNLOCK(ifq); \ 317130416Smlaier} while(0) 318130416Smlaier 31955205Speter#ifdef _KERNEL 320126264Smlaier/* interface address change event */ 321126264Smlaiertypedef void (*ifaddr_event_handler_t)(void *, struct ifnet *); 322126264SmlaierEVENTHANDLER_DECLARE(ifaddr_event, ifaddr_event_handler_t); 323126264Smlaier/* new interface arrival event */ 324126264Smlaiertypedef void (*ifnet_arrival_event_handler_t)(void *, struct ifnet *); 325126264SmlaierEVENTHANDLER_DECLARE(ifnet_arrival_event, ifnet_arrival_event_handler_t); 326126264Smlaier/* interface departure event */ 327126264Smlaiertypedef void (*ifnet_departure_event_handler_t)(void *, struct ifnet *); 328126264SmlaierEVENTHANDLER_DECLARE(ifnet_departure_event, ifnet_departure_event_handler_t); 329126264Smlaier 330159781Smlaier/* 331159781Smlaier * interface groups 332159781Smlaier */ 333159781Smlaierstruct ifg_group { 334159781Smlaier char ifg_group[IFNAMSIZ]; 335159781Smlaier u_int ifg_refcnt; 336159781Smlaier void *ifg_pf_kif; 337159781Smlaier TAILQ_HEAD(, ifg_member) ifg_members; 338159781Smlaier TAILQ_ENTRY(ifg_group) ifg_next; 339159781Smlaier}; 340159781Smlaier 341159781Smlaierstruct ifg_member { 342159781Smlaier TAILQ_ENTRY(ifg_member) ifgm_next; 343159781Smlaier struct ifnet *ifgm_ifp; 344159781Smlaier}; 345159781Smlaier 346159781Smlaierstruct ifg_list { 347159781Smlaier struct ifg_group *ifgl_group; 348159781Smlaier TAILQ_ENTRY(ifg_list) ifgl_next; 349159781Smlaier}; 350159781Smlaier 351159781Smlaier/* group attach event */ 352159781Smlaiertypedef void (*group_attach_event_handler_t)(void *, struct ifg_group *); 353159781SmlaierEVENTHANDLER_DECLARE(group_attach_event, group_attach_event_handler_t); 354159781Smlaier/* group detach event */ 355159781Smlaiertypedef void (*group_detach_event_handler_t)(void *, struct ifg_group *); 356159781SmlaierEVENTHANDLER_DECLARE(group_detach_event, group_detach_event_handler_t); 357159781Smlaier/* group change event */ 358159781Smlaiertypedef void (*group_change_event_handler_t)(void *, const char *); 359159781SmlaierEVENTHANDLER_DECLARE(group_change_event, group_change_event_handler_t); 360159781Smlaier 361121470Sume#define IF_AFDATA_LOCK_INIT(ifp) \ 362186199Skmacy rw_init(&(ifp)->if_afdata_lock, "if_afdata") 363121470Sume 364186199Skmacy#define IF_AFDATA_WLOCK(ifp) rw_wlock(&(ifp)->if_afdata_lock) 365186199Skmacy#define IF_AFDATA_RLOCK(ifp) rw_rlock(&(ifp)->if_afdata_lock) 366186199Skmacy#define IF_AFDATA_WUNLOCK(ifp) rw_wunlock(&(ifp)->if_afdata_lock) 367186199Skmacy#define IF_AFDATA_RUNLOCK(ifp) rw_runlock(&(ifp)->if_afdata_lock) 368186199Skmacy#define IF_AFDATA_LOCK(ifp) IF_AFDATA_WLOCK(ifp) 369186199Skmacy#define IF_AFDATA_UNLOCK(ifp) IF_AFDATA_WUNLOCK(ifp) 370186199Skmacy#define IF_AFDATA_TRYLOCK(ifp) rw_try_wlock(&(ifp)->if_afdata_lock) 371186199Skmacy#define IF_AFDATA_DESTROY(ifp) rw_destroy(&(ifp)->if_afdata_lock) 372186119Sqingli 373186199Skmacy#define IF_AFDATA_LOCK_ASSERT(ifp) rw_assert(&(ifp)->if_afdata_lock, RA_LOCKED) 374186199Skmacy#define IF_AFDATA_UNLOCK_ASSERT(ifp) rw_assert(&(ifp)->if_afdata_lock, RA_UNLOCKED) 375186199Skmacy 376136704Srwatson#define IFF_LOCKGIANT(ifp) do { \ 377136704Srwatson if ((ifp)->if_flags & IFF_NEEDSGIANT) \ 378136704Srwatson mtx_lock(&Giant); \ 379136704Srwatson} while (0) 380136704Srwatson 381136704Srwatson#define IFF_UNLOCKGIANT(ifp) do { \ 382136704Srwatson if ((ifp)->if_flags & IFF_NEEDSGIANT) \ 383136704Srwatson mtx_unlock(&Giant); \ 384136704Srwatson} while (0) 385136704Srwatson 386137065Srwatsonint if_handoff(struct ifqueue *ifq, struct mbuf *m, struct ifnet *ifp, 387137065Srwatson int adjust); 388130416Smlaier#define IF_HANDOFF(ifq, m, ifp) \ 389130416Smlaier if_handoff((struct ifqueue *)ifq, m, ifp, 0) 390130416Smlaier#define IF_HANDOFF_ADJ(ifq, m, ifp, adj) \ 391130416Smlaier if_handoff((struct ifqueue *)ifq, m, ifp, adj) 39221259Swollman 393132712Srwatsonvoid if_start(struct ifnet *); 394132712Srwatson 395130416Smlaier#define IFQ_ENQUEUE(ifq, m, err) \ 396130416Smlaierdo { \ 397130416Smlaier IF_LOCK(ifq); \ 398130416Smlaier if (ALTQ_IS_ENABLED(ifq)) \ 399130416Smlaier ALTQ_ENQUEUE(ifq, m, NULL, err); \ 400130416Smlaier else { \ 401130416Smlaier if (_IF_QFULL(ifq)) { \ 402130416Smlaier m_freem(m); \ 403130416Smlaier (err) = ENOBUFS; \ 404130416Smlaier } else { \ 405130416Smlaier _IF_ENQUEUE(ifq, m); \ 406130416Smlaier (err) = 0; \ 407130416Smlaier } \ 408130416Smlaier } \ 409130416Smlaier if (err) \ 410130416Smlaier (ifq)->ifq_drops++; \ 411130416Smlaier IF_UNLOCK(ifq); \ 412130416Smlaier} while (0) 41321259Swollman 414130416Smlaier#define IFQ_DEQUEUE_NOLOCK(ifq, m) \ 415130416Smlaierdo { \ 416130416Smlaier if (TBR_IS_ENABLED(ifq)) \ 417130508Smlaier (m) = tbr_dequeue_ptr(ifq, ALTDQ_REMOVE); \ 418130416Smlaier else if (ALTQ_IS_ENABLED(ifq)) \ 419130416Smlaier ALTQ_DEQUEUE(ifq, m); \ 420130416Smlaier else \ 421130416Smlaier _IF_DEQUEUE(ifq, m); \ 422130416Smlaier} while (0) 423130416Smlaier 424130416Smlaier#define IFQ_DEQUEUE(ifq, m) \ 425130416Smlaierdo { \ 426130416Smlaier IF_LOCK(ifq); \ 427130416Smlaier IFQ_DEQUEUE_NOLOCK(ifq, m); \ 428130416Smlaier IF_UNLOCK(ifq); \ 429130416Smlaier} while (0) 430130416Smlaier 431130416Smlaier#define IFQ_POLL_NOLOCK(ifq, m) \ 432130416Smlaierdo { \ 433130416Smlaier if (TBR_IS_ENABLED(ifq)) \ 434130508Smlaier (m) = tbr_dequeue_ptr(ifq, ALTDQ_POLL); \ 435130416Smlaier else if (ALTQ_IS_ENABLED(ifq)) \ 436130416Smlaier ALTQ_POLL(ifq, m); \ 437130416Smlaier else \ 438130416Smlaier _IF_POLL(ifq, m); \ 439130416Smlaier} while (0) 440130416Smlaier 441130416Smlaier#define IFQ_POLL(ifq, m) \ 442130416Smlaierdo { \ 443130416Smlaier IF_LOCK(ifq); \ 444130416Smlaier IFQ_POLL_NOLOCK(ifq, m); \ 445130416Smlaier IF_UNLOCK(ifq); \ 446130416Smlaier} while (0) 447130416Smlaier 448130416Smlaier#define IFQ_PURGE_NOLOCK(ifq) \ 449130416Smlaierdo { \ 450130416Smlaier if (ALTQ_IS_ENABLED(ifq)) { \ 451130416Smlaier ALTQ_PURGE(ifq); \ 452130416Smlaier } else \ 453130416Smlaier _IF_DRAIN(ifq); \ 454130416Smlaier} while (0) 455130416Smlaier 456130416Smlaier#define IFQ_PURGE(ifq) \ 457130416Smlaierdo { \ 458130416Smlaier IF_LOCK(ifq); \ 459130416Smlaier IFQ_PURGE_NOLOCK(ifq); \ 460130416Smlaier IF_UNLOCK(ifq); \ 461130416Smlaier} while (0) 462130416Smlaier 463130416Smlaier#define IFQ_SET_READY(ifq) \ 464130416Smlaier do { ((ifq)->altq_flags |= ALTQF_READY); } while (0) 465130416Smlaier 466130416Smlaier#define IFQ_LOCK(ifq) IF_LOCK(ifq) 467130416Smlaier#define IFQ_UNLOCK(ifq) IF_UNLOCK(ifq) 468130416Smlaier#define IFQ_LOCK_ASSERT(ifq) IF_LOCK_ASSERT(ifq) 469130416Smlaier#define IFQ_IS_EMPTY(ifq) ((ifq)->ifq_len == 0) 470130416Smlaier#define IFQ_INC_LEN(ifq) ((ifq)->ifq_len++) 471130416Smlaier#define IFQ_DEC_LEN(ifq) (--(ifq)->ifq_len) 472130416Smlaier#define IFQ_INC_DROPS(ifq) ((ifq)->ifq_drops++) 473130416Smlaier#define IFQ_SET_MAXLEN(ifq, len) ((ifq)->ifq_maxlen = (len)) 474130416Smlaier 475148886Srwatson/* 476148886Srwatson * The IFF_DRV_OACTIVE test should really occur in the device driver, not in 477148886Srwatson * the handoff logic, as that flag is locked by the device driver. 478148886Srwatson */ 479130416Smlaier#define IFQ_HANDOFF_ADJ(ifp, m, adj, err) \ 480130416Smlaierdo { \ 481130416Smlaier int len; \ 482130416Smlaier short mflags; \ 483130416Smlaier \ 484130416Smlaier len = (m)->m_pkthdr.len; \ 485130416Smlaier mflags = (m)->m_flags; \ 486130416Smlaier IFQ_ENQUEUE(&(ifp)->if_snd, m, err); \ 487130416Smlaier if ((err) == 0) { \ 488130416Smlaier (ifp)->if_obytes += len + (adj); \ 489130416Smlaier if (mflags & M_MCAST) \ 490130416Smlaier (ifp)->if_omcasts++; \ 491148886Srwatson if (((ifp)->if_drv_flags & IFF_DRV_OACTIVE) == 0) \ 492132712Srwatson if_start(ifp); \ 493130416Smlaier } \ 494130416Smlaier} while (0) 495130416Smlaier 496130416Smlaier#define IFQ_HANDOFF(ifp, m, err) \ 497130512Smlaier IFQ_HANDOFF_ADJ(ifp, m, 0, err) 498130416Smlaier 499130416Smlaier#define IFQ_DRV_DEQUEUE(ifq, m) \ 500130416Smlaierdo { \ 501130416Smlaier (m) = (ifq)->ifq_drv_head; \ 502130416Smlaier if (m) { \ 503130416Smlaier if (((ifq)->ifq_drv_head = (m)->m_nextpkt) == NULL) \ 504130416Smlaier (ifq)->ifq_drv_tail = NULL; \ 505130416Smlaier (m)->m_nextpkt = NULL; \ 506130416Smlaier (ifq)->ifq_drv_len--; \ 507130416Smlaier } else { \ 508130416Smlaier IFQ_LOCK(ifq); \ 509130416Smlaier IFQ_DEQUEUE_NOLOCK(ifq, m); \ 510130416Smlaier while ((ifq)->ifq_drv_len < (ifq)->ifq_drv_maxlen) { \ 511130416Smlaier struct mbuf *m0; \ 512130416Smlaier IFQ_DEQUEUE_NOLOCK(ifq, m0); \ 513130416Smlaier if (m0 == NULL) \ 514130416Smlaier break; \ 515130416Smlaier m0->m_nextpkt = NULL; \ 516130416Smlaier if ((ifq)->ifq_drv_tail == NULL) \ 517130416Smlaier (ifq)->ifq_drv_head = m0; \ 518130416Smlaier else \ 519130416Smlaier (ifq)->ifq_drv_tail->m_nextpkt = m0; \ 520130416Smlaier (ifq)->ifq_drv_tail = m0; \ 521130416Smlaier (ifq)->ifq_drv_len++; \ 522130416Smlaier } \ 523130416Smlaier IFQ_UNLOCK(ifq); \ 524130416Smlaier } \ 525130416Smlaier} while (0) 526130416Smlaier 527130416Smlaier#define IFQ_DRV_PREPEND(ifq, m) \ 528130416Smlaierdo { \ 529130416Smlaier (m)->m_nextpkt = (ifq)->ifq_drv_head; \ 530132152Smlaier if ((ifq)->ifq_drv_tail == NULL) \ 531132152Smlaier (ifq)->ifq_drv_tail = (m); \ 532130416Smlaier (ifq)->ifq_drv_head = (m); \ 533130416Smlaier (ifq)->ifq_drv_len++; \ 534130416Smlaier} while (0) 535130416Smlaier 536130416Smlaier#define IFQ_DRV_IS_EMPTY(ifq) \ 537130416Smlaier (((ifq)->ifq_drv_len == 0) && ((ifq)->ifq_len == 0)) 538130416Smlaier 539130416Smlaier#define IFQ_DRV_PURGE(ifq) \ 540130416Smlaierdo { \ 541132152Smlaier struct mbuf *m, *n = (ifq)->ifq_drv_head; \ 542132152Smlaier while((m = n) != NULL) { \ 543132152Smlaier n = m->m_nextpkt; \ 544130416Smlaier m_freem(m); \ 545130416Smlaier } \ 546130416Smlaier (ifq)->ifq_drv_head = (ifq)->ifq_drv_tail = NULL; \ 547130416Smlaier (ifq)->ifq_drv_len = 0; \ 548130416Smlaier IFQ_PURGE(ifq); \ 549130416Smlaier} while (0) 550130416Smlaier 55149459Sbrian/* 55249459Sbrian * 72 was chosen below because it is the size of a TCP/IP 55349459Sbrian * header (40) + the minimum mss (32). 55449459Sbrian */ 55549459Sbrian#define IF_MINMTU 72 55649459Sbrian#define IF_MAXMTU 65535 55749459Sbrian 55855205Speter#endif /* _KERNEL */ 55921259Swollman 56021259Swollman/* 56121259Swollman * The ifaddr structure contains information about one address 56221259Swollman * of an interface. They are maintained by the different address families, 56321259Swollman * are allocated and attached when an address is set, and are linked 56421259Swollman * together so all addresses for an interface can be located. 565128291Sluigi * 566128291Sluigi * NOTE: a 'struct ifaddr' is always at the beginning of a larger 567128291Sluigi * chunk of malloc'ed memory, where we store the three addresses 568128291Sluigi * (ifa_addr, ifa_dstaddr and ifa_netmask) referenced here. 56921259Swollman */ 57021259Swollmanstruct ifaddr { 57121259Swollman struct sockaddr *ifa_addr; /* address of interface */ 57221259Swollman struct sockaddr *ifa_dstaddr; /* other end of p-to-p link */ 57321259Swollman#define ifa_broadaddr ifa_dstaddr /* broadcast address interface */ 57421259Swollman struct sockaddr *ifa_netmask; /* used to determine subnet */ 57567334Sjoe struct if_data if_data; /* not all members are meaningful */ 57621259Swollman struct ifnet *ifa_ifp; /* back-pointer to interface */ 57760938Sjake TAILQ_ENTRY(ifaddr) ifa_link; /* queue macro glue */ 57821259Swollman void (*ifa_rtrequest) /* check or clean routes (+ or -)'d */ 57992725Salfred (int, struct rtentry *, struct rt_addrinfo *); 58021259Swollman u_short ifa_flags; /* mostly rt_flags for cloning */ 58147254Spb u_int ifa_refcnt; /* references to this structure */ 58221259Swollman int ifa_metric; /* cost of going out this interface */ 58328845Sjulian int (*ifa_claim_addr) /* check if an addr goes to this if */ 58492725Salfred (struct ifaddr *, struct sockaddr *); 585108033Shsu struct mtx ifa_mtx; 58621259Swollman}; 58721259Swollman#define IFA_ROUTE RTF_UP /* route installed */ 58821259Swollman 58953541Sshin/* for compatibility with other BSDs */ 59053541Sshin#define ifa_list ifa_link 59153541Sshin 592108033Shsu#define IFA_LOCK_INIT(ifa) \ 593108033Shsu mtx_init(&(ifa)->ifa_mtx, "ifaddr", NULL, MTX_DEF) 594108033Shsu#define IFA_LOCK(ifa) mtx_lock(&(ifa)->ifa_mtx) 595108033Shsu#define IFA_UNLOCK(ifa) mtx_unlock(&(ifa)->ifa_mtx) 596108033Shsu#define IFA_DESTROY(ifa) mtx_destroy(&(ifa)->ifa_mtx) 597108033Shsu 59821404Swollman/* 59952904Sshin * The prefix structure contains information about one prefix 60052904Sshin * of an interface. They are maintained by the different address families, 601108470Sschweikh * are allocated and attached when a prefix or an address is set, 60253541Sshin * and are linked together so all prefixes for an interface can be located. 60352904Sshin */ 60452904Sshinstruct ifprefix { 60552904Sshin struct sockaddr *ifpr_prefix; /* prefix of interface */ 60652904Sshin struct ifnet *ifpr_ifp; /* back-pointer to interface */ 60760938Sjake TAILQ_ENTRY(ifprefix) ifpr_list; /* queue macro glue */ 60852904Sshin u_char ifpr_plen; /* prefix length in bits */ 60952904Sshin u_char ifpr_type; /* protocol dependent prefix type */ 61052904Sshin}; 61152904Sshin 61252904Sshin/* 61321404Swollman * Multicast address structure. This is analogous to the ifaddr 61421404Swollman * structure except that it keeps track of multicast addresses. 61521404Swollman */ 61621404Swollmanstruct ifmultiaddr { 61772084Sphk TAILQ_ENTRY(ifmultiaddr) ifma_link; /* queue macro glue */ 61821434Swollman struct sockaddr *ifma_addr; /* address this membership is for */ 61921434Swollman struct sockaddr *ifma_lladdr; /* link-layer translation, if any */ 62021434Swollman struct ifnet *ifma_ifp; /* back-pointer to interface */ 62121434Swollman u_int ifma_refcount; /* reference count */ 62221434Swollman void *ifma_protospec; /* protocol-specific state, if any */ 623167729Sbms struct ifmultiaddr *ifma_llifma; /* pointer to ifma for ifma_lladdr */ 62421404Swollman}; 62521404Swollman 62655205Speter#ifdef _KERNEL 627108036Shsu#define IFAFREE(ifa) \ 628108036Shsu do { \ 629108036Shsu IFA_LOCK(ifa); \ 630108036Shsu KASSERT((ifa)->ifa_refcnt > 0, \ 631108036Shsu ("ifa %p !(ifa_refcnt > 0)", ifa)); \ 632108036Shsu if (--(ifa)->ifa_refcnt == 0) { \ 633108036Shsu IFA_DESTROY(ifa); \ 634108036Shsu free(ifa, M_IFADDR); \ 635108036Shsu } else \ 636108036Shsu IFA_UNLOCK(ifa); \ 63746568Speter } while (0) 63821259Swollman 639108036Shsu#define IFAREF(ifa) \ 640108036Shsu do { \ 641108036Shsu IFA_LOCK(ifa); \ 642108036Shsu ++(ifa)->ifa_refcnt; \ 643108036Shsu IFA_UNLOCK(ifa); \ 644108033Shsu } while (0) 645108033Shsu 646186199Skmacyextern struct rwlock ifnet_lock; 647108298Shsu#define IFNET_LOCK_INIT() \ 648186199Skmacy rw_init_flags(&ifnet_lock, "ifnet", RW_RECURSE) 649186199Skmacy#define IFNET_WLOCK() rw_wlock(&ifnet_lock) 650186199Skmacy#define IFNET_WUNLOCK() rw_wunlock(&ifnet_lock) 651186199Skmacy#define IFNET_WLOCK_ASSERT() rw_assert(&ifnet_lock, RA_LOCKED) 652186199Skmacy#define IFNET_RLOCK() rw_rlock(&ifnet_lock) 653186199Skmacy#define IFNET_RUNLOCK() rw_runlock(&ifnet_lock) 654108172Shsu 65583130Sjlemonstruct ifindex_entry { 65687914Sjlemon struct ifnet *ife_ifnet; 657130585Sphk struct cdev *ife_dev; 65883130Sjlemon}; 65983130Sjlemon 660180042Srwatsonstruct ifnet *ifnet_byindex(u_short idx); 661181892Skmacy 662128315Sluigi/* 663128315Sluigi * Given the index, ifaddr_byindex() returns the one and only 664128315Sluigi * link-level ifaddr for the interface. You are not supposed to use 665128315Sluigi * it to traverse the list of addresses associated to the interface. 666128315Sluigi */ 667180042Srwatsonstruct ifaddr *ifaddr_byindex(u_short idx); 668180042Srwatsonstruct cdev *ifdev_byindex(u_short idx); 66983130Sjlemon 670186048Sbz#ifdef VIMAGE_GLOBALS 67121259Swollmanextern struct ifnethead ifnet; 67271791Speterextern struct ifnet *loif; /* first loopback interface */ 67321259Swollmanextern int if_index; 674186048Sbz#endif 675186048Sbzextern int ifqmaxlen; 67621259Swollman 677159781Smlaierint if_addgroup(struct ifnet *, const char *); 678159781Smlaierint if_delgroup(struct ifnet *, const char *); 67992725Salfredint if_addmulti(struct ifnet *, struct sockaddr *, struct ifmultiaddr **); 68092725Salfredint if_allmulti(struct ifnet *, int); 681147256Sbrooksstruct ifnet* if_alloc(u_char); 68292725Salfredvoid if_attach(struct ifnet *); 68392725Salfredint if_delmulti(struct ifnet *, struct sockaddr *); 684167729Sbmsvoid if_delmulti_ifma(struct ifmultiaddr *); 68592725Salfredvoid if_detach(struct ifnet *); 686146620Speadarvoid if_purgeaddrs(struct ifnet *); 687177617Ssamvoid if_purgemaddrs(struct ifnet *); 68892725Salfredvoid if_down(struct ifnet *); 689167732Sbmsstruct ifmultiaddr * 690167732Sbms if_findmulti(struct ifnet *, struct sockaddr *); 691147256Sbrooksvoid if_free(struct ifnet *); 692147256Sbrooksvoid if_free_type(struct ifnet *, u_char); 693121816Sbrooksvoid if_initname(struct ifnet *, const char *, int); 694138542Ssamvoid if_link_state_change(struct ifnet *, int); 695103900Sbrooksint if_printf(struct ifnet *, const char *, ...) __printflike(2, 3); 69692725Salfredint if_setlladdr(struct ifnet *, const u_char *, int); 69792725Salfredvoid if_up(struct ifnet *); 69892725Salfred/*void ifinit(void);*/ /* declared in systm.h for main() */ 69992725Salfredint ifioctl(struct socket *, u_long, caddr_t, struct thread *); 70092725Salfredint ifpromisc(struct ifnet *, int); 70192725Salfredstruct ifnet *ifunit(const char *); 70221259Swollman 703185162Skmacyvoid ifq_attach(struct ifaltq *, struct ifnet *ifp); 704185162Skmacyvoid ifq_detach(struct ifaltq *); 705185162Skmacy 70692725Salfredstruct ifaddr *ifa_ifwithaddr(struct sockaddr *); 707162068Sandrestruct ifaddr *ifa_ifwithbroadaddr(struct sockaddr *); 70892725Salfredstruct ifaddr *ifa_ifwithdstaddr(struct sockaddr *); 70992725Salfredstruct ifaddr *ifa_ifwithnet(struct sockaddr *); 71092725Salfredstruct ifaddr *ifa_ifwithroute(int, struct sockaddr *, struct sockaddr *); 711178888Sjulianstruct ifaddr *ifa_ifwithroute_fib(int, struct sockaddr *, struct sockaddr *, u_int); 712178888Sjulian 71392725Salfredstruct ifaddr *ifaof_ifpforaddr(struct sockaddr *, struct ifnet *); 71421259Swollman 71592725Salfredint if_simloop(struct ifnet *ifp, struct mbuf *m, int af, int hlen); 71621434Swollman 717147256Sbrookstypedef void *if_com_alloc_t(u_char type, struct ifnet *ifp); 718147256Sbrookstypedef void if_com_free_t(void *com, u_char type); 719147256Sbrooksvoid if_register_com_alloc(u_char type, if_com_alloc_t *a, if_com_free_t *f); 720147256Sbrooksvoid if_deregister_com_alloc(u_char type); 721147256Sbrooks 72284931Sfjoe#define IF_LLADDR(ifp) \ 723152315Sru LLADDR((struct sockaddr_dl *)((ifp)->if_addr->ifa_addr)) 72484931Sfjoe 72587902Sluigi#ifdef DEVICE_POLLING 726150789Sglebiusenum poll_cmd { POLL_ONLY, POLL_AND_CHECK_STATUS }; 72787902Sluigi 72892725Salfredtypedef void poll_handler_t(struct ifnet *ifp, enum poll_cmd cmd, int count); 72992725Salfredint ether_poll_register(poll_handler_t *h, struct ifnet *ifp); 73092725Salfredint ether_poll_deregister(struct ifnet *ifp); 73187902Sluigi#endif /* DEVICE_POLLING */ 73287902Sluigi 73355205Speter#endif /* _KERNEL */ 73421259Swollman 73521259Swollman#endif /* !_NET_IF_VAR_H_ */ 736