ifq.h revision 121470
1/* 2 * Copyright (c) 1982, 1986, 1989, 1993 3 * The Regents of the University of California. All rights reserved. 4 * 5 * Redistribution and use in source and binary forms, with or without 6 * modification, are permitted provided that the following conditions 7 * are met: 8 * 1. Redistributions of source code must retain the above copyright 9 * notice, this list of conditions and the following disclaimer. 10 * 2. Redistributions in binary form must reproduce the above copyright 11 * notice, this list of conditions and the following disclaimer in the 12 * documentation and/or other materials provided with the distribution. 13 * 3. All advertising materials mentioning features or use of this software 14 * must display the following acknowledgement: 15 * This product includes software developed by the University of 16 * California, Berkeley and its contributors. 17 * 4. Neither the name of the University nor the names of its contributors 18 * may be used to endorse or promote products derived from this software 19 * without specific prior written permission. 20 * 21 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 22 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 23 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 24 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 25 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 26 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 27 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 28 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 29 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 30 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 31 * SUCH DAMAGE. 32 * 33 * From: @(#)if.h 8.1 (Berkeley) 6/10/93 34 * $FreeBSD: head/sys/net/if_var.h 121470 2003-10-24 16:57:59Z ume $ 35 */ 36 37#ifndef _NET_IF_VAR_H_ 38#define _NET_IF_VAR_H_ 39 40/* 41 * Structures defining a network interface, providing a packet 42 * transport mechanism (ala level 0 of the PUP protocols). 43 * 44 * Each interface accepts output datagrams of a specified maximum 45 * length, and provides higher level routines with input datagrams 46 * received from its medium. 47 * 48 * Output occurs when the routine if_output is called, with three parameters: 49 * (*ifp->if_output)(ifp, m, dst, rt) 50 * Here m is the mbuf chain to be sent and dst is the destination address. 51 * The output routine encapsulates the supplied datagram if necessary, 52 * and then transmits it on its medium. 53 * 54 * On input, each interface unwraps the data received by it, and either 55 * places it on the input queue of an internetwork datagram routine 56 * and posts the associated software interrupt, or passes the datagram to a raw 57 * packet input routine. 58 * 59 * Routines exist for locating interfaces by their addresses 60 * or for locating an interface on a certain network, as well as more general 61 * routing and gateway routines maintaining information used to locate 62 * interfaces. These routines live in the files if.c and route.c 63 */ 64 65#ifdef __STDC__ 66/* 67 * Forward structure declarations for function prototypes [sic]. 68 */ 69struct mbuf; 70struct thread; 71struct rtentry; 72struct rt_addrinfo; 73struct socket; 74struct ether_header; 75#endif 76 77#include <sys/_label.h> /* struct label */ 78#include <sys/queue.h> /* get TAILQ macros */ 79 80#ifdef _KERNEL 81#include <sys/mbuf.h> 82#endif /* _KERNEL */ 83#include <sys/lock.h> /* XXX */ 84#include <sys/mutex.h> /* XXX */ 85#include <sys/event.h> /* XXX */ 86 87TAILQ_HEAD(ifnethead, ifnet); /* we use TAILQs so that the order of */ 88TAILQ_HEAD(ifaddrhead, ifaddr); /* instantiation is preserved in the list */ 89TAILQ_HEAD(ifprefixhead, ifprefix); 90TAILQ_HEAD(ifmultihead, ifmultiaddr); 91 92/* 93 * Structure defining a queue for a network interface. 94 */ 95struct ifqueue { 96 struct mbuf *ifq_head; 97 struct mbuf *ifq_tail; 98 int ifq_len; 99 int ifq_maxlen; 100 int ifq_drops; 101 struct mtx ifq_mtx; 102}; 103 104/* 105 * Structure defining a network interface. 106 * 107 * (Would like to call this struct ``if'', but C isn't PL/1.) 108 */ 109 110/* 111 * NB: For FreeBSD, it is assumed that each NIC driver's softc starts with 112 * one of these structures, typically held within an arpcom structure. 113 * 114 * struct <foo>_softc { 115 * struct arpcom { 116 * struct ifnet ac_if; 117 * ... 118 * } <arpcom> ; 119 * ... 120 * }; 121 * 122 * The assumption is used in a number of places, including many 123 * files in sys/net, device drivers, and sys/dev/mii.c:miibus_attach(). 124 * 125 * Unfortunately devices' softc are opaque, so we depend on this layout 126 * to locate the struct ifnet from the softc in the generic code. 127 * 128 */ 129struct ifnet { 130 void *if_softc; /* pointer to driver state */ 131 char *if_name; /* name, e.g. ``en'' or ``lo'' */ 132 TAILQ_ENTRY(ifnet) if_link; /* all struct ifnets are chained */ 133 struct ifaddrhead if_addrhead; /* linked list of addresses per if */ 134 struct klist if_klist; /* events attached to this if */ 135 int if_pcount; /* number of promiscuous listeners */ 136 struct bpf_if *if_bpf; /* packet filter structure */ 137 u_short if_index; /* numeric abbreviation for this if */ 138 short if_unit; /* sub-unit for lower level driver */ 139 short if_timer; /* time 'til if_watchdog called */ 140 u_short if_nvlans; /* number of active vlans */ 141 int if_flags; /* up/down, broadcast, etc. */ 142 int if_capabilities; /* interface capabilities */ 143 int if_capenable; /* enabled features */ 144 int if_ipending; /* interrupts pending */ 145 void *if_linkmib; /* link-type-specific MIB data */ 146 size_t if_linkmiblen; /* length of above data */ 147 struct if_data if_data; 148 struct ifmultihead if_multiaddrs; /* multicast addresses configured */ 149 int if_amcount; /* number of all-multicast requests */ 150/* procedure handles */ 151 int (*if_output) /* output routine (enqueue) */ 152 (struct ifnet *, struct mbuf *, struct sockaddr *, 153 struct rtentry *); 154 void (*if_input) /* input routine (from h/w driver) */ 155 (struct ifnet *, struct mbuf *); 156 void (*if_start) /* initiate output routine */ 157 (struct ifnet *); 158 int (*if_done) /* output complete routine */ 159 (struct ifnet *); /* (XXX not used; fake prototype) */ 160 int (*if_ioctl) /* ioctl routine */ 161 (struct ifnet *, u_long, caddr_t); 162 void (*if_watchdog) /* timer routine */ 163 (struct ifnet *); 164 int (*if_poll_recv) /* polled receive routine */ 165 (struct ifnet *, int *); 166 int (*if_poll_xmit) /* polled transmit routine */ 167 (struct ifnet *, int *); 168 void (*if_poll_intren) /* polled interrupt reenable routine */ 169 (struct ifnet *); 170 void (*if_poll_slowinput) /* input routine for slow devices */ 171 (struct ifnet *, struct mbuf *); 172 void (*if_init) /* Init routine */ 173 (void *); 174 int (*if_resolvemulti) /* validate/resolve multicast */ 175 (struct ifnet *, struct sockaddr **, struct sockaddr *); 176 struct ifqueue if_snd; /* output queue */ 177 struct ifqueue *if_poll_slowq; /* input queue for slow devices */ 178 struct ifprefixhead if_prefixhead; /* list of prefixes per if */ 179 u_int8_t *if_broadcastaddr; /* linklevel broadcast bytestring */ 180 struct label if_label; /* interface MAC label */ 181 182 void *if_afdata[AF_MAX]; 183 int if_afdata_initialized; 184 struct mtx if_afdata_mtx; 185}; 186 187typedef void if_init_f_t(void *); 188 189#define if_mtu if_data.ifi_mtu 190#define if_type if_data.ifi_type 191#define if_physical if_data.ifi_physical 192#define if_addrlen if_data.ifi_addrlen 193#define if_hdrlen if_data.ifi_hdrlen 194#define if_metric if_data.ifi_metric 195#define if_baudrate if_data.ifi_baudrate 196#define if_hwassist if_data.ifi_hwassist 197#define if_ipackets if_data.ifi_ipackets 198#define if_ierrors if_data.ifi_ierrors 199#define if_opackets if_data.ifi_opackets 200#define if_oerrors if_data.ifi_oerrors 201#define if_collisions if_data.ifi_collisions 202#define if_ibytes if_data.ifi_ibytes 203#define if_obytes if_data.ifi_obytes 204#define if_imcasts if_data.ifi_imcasts 205#define if_omcasts if_data.ifi_omcasts 206#define if_iqdrops if_data.ifi_iqdrops 207#define if_noproto if_data.ifi_noproto 208#define if_lastchange if_data.ifi_lastchange 209#define if_recvquota if_data.ifi_recvquota 210#define if_xmitquota if_data.ifi_xmitquota 211#define if_rawoutput(if, m, sa) if_output(if, m, sa, (struct rtentry *)0) 212 213/* for compatibility with other BSDs */ 214#define if_addrlist if_addrhead 215#define if_list if_link 216 217/* 218 * Bit values in if_ipending 219 */ 220#define IFI_RECV 1 /* I want to receive */ 221#define IFI_XMIT 2 /* I want to transmit */ 222 223/* 224 * Output queues (ifp->if_snd) and slow device input queues (*ifp->if_slowq) 225 * are queues of messages stored on ifqueue structures 226 * (defined above). Entries are added to and deleted from these structures 227 * by these macros, which should be called with ipl raised to splimp(). 228 */ 229#define IF_LOCK(ifq) mtx_lock(&(ifq)->ifq_mtx) 230#define IF_UNLOCK(ifq) mtx_unlock(&(ifq)->ifq_mtx) 231#define _IF_QFULL(ifq) ((ifq)->ifq_len >= (ifq)->ifq_maxlen) 232#define _IF_DROP(ifq) ((ifq)->ifq_drops++) 233#define _IF_QLEN(ifq) ((ifq)->ifq_len) 234 235#define _IF_ENQUEUE(ifq, m) do { \ 236 (m)->m_nextpkt = NULL; \ 237 if ((ifq)->ifq_tail == NULL) \ 238 (ifq)->ifq_head = m; \ 239 else \ 240 (ifq)->ifq_tail->m_nextpkt = m; \ 241 (ifq)->ifq_tail = m; \ 242 (ifq)->ifq_len++; \ 243} while (0) 244 245#define IF_ENQUEUE(ifq, m) do { \ 246 IF_LOCK(ifq); \ 247 _IF_ENQUEUE(ifq, m); \ 248 IF_UNLOCK(ifq); \ 249} while (0) 250 251#define _IF_PREPEND(ifq, m) do { \ 252 (m)->m_nextpkt = (ifq)->ifq_head; \ 253 if ((ifq)->ifq_tail == NULL) \ 254 (ifq)->ifq_tail = (m); \ 255 (ifq)->ifq_head = (m); \ 256 (ifq)->ifq_len++; \ 257} while (0) 258 259#define IF_PREPEND(ifq, m) do { \ 260 IF_LOCK(ifq); \ 261 _IF_PREPEND(ifq, m); \ 262 IF_UNLOCK(ifq); \ 263} while (0) 264 265#define _IF_DEQUEUE(ifq, m) do { \ 266 (m) = (ifq)->ifq_head; \ 267 if (m) { \ 268 if (((ifq)->ifq_head = (m)->m_nextpkt) == 0) \ 269 (ifq)->ifq_tail = NULL; \ 270 (m)->m_nextpkt = NULL; \ 271 (ifq)->ifq_len--; \ 272 } \ 273} while (0) 274 275#define IF_DEQUEUE(ifq, m) do { \ 276 IF_LOCK(ifq); \ 277 _IF_DEQUEUE(ifq, m); \ 278 IF_UNLOCK(ifq); \ 279} while (0) 280 281#define IF_DRAIN(ifq) do { \ 282 struct mbuf *m; \ 283 IF_LOCK(ifq); \ 284 for (;;) { \ 285 _IF_DEQUEUE(ifq, m); \ 286 if (m == NULL) \ 287 break; \ 288 m_freem(m); \ 289 } \ 290 IF_UNLOCK(ifq); \ 291} while (0) 292 293#ifdef _KERNEL 294#define IF_AFDATA_LOCK_INIT(ifp) \ 295 mtx_init(&(ifp)->if_afdata_mtx, "if_afdata", NULL, MTX_DEF) 296#define IF_AFDATA_LOCK(ifp) mtx_lock(&(ifp)->if_afdata_mtx) 297#define IF_AFDATA_TRYLOCK(ifp) mtx_trylock(&(ifp)->if_afdata_mtx) 298#define IF_AFDATA_UNLOCK(ifp) mtx_unlock(&(ifp)->if_afdata_mtx) 299#define IF_AFDATA_DESTROY(ifp) mtx_destroy(&(ifp)->if_afdata_mtx) 300 301#define IF_HANDOFF(ifq, m, ifp) if_handoff(ifq, m, ifp, 0) 302#define IF_HANDOFF_ADJ(ifq, m, ifp, adj) if_handoff(ifq, m, ifp, adj) 303 304static __inline int 305if_handoff(struct ifqueue *ifq, struct mbuf *m, struct ifnet *ifp, int adjust) 306{ 307 int active = 0; 308 309 IF_LOCK(ifq); 310 if (_IF_QFULL(ifq)) { 311 _IF_DROP(ifq); 312 IF_UNLOCK(ifq); 313 m_freem(m); 314 return (0); 315 } 316 if (ifp != NULL) { 317 ifp->if_obytes += m->m_pkthdr.len + adjust; 318 if (m->m_flags & M_MCAST) 319 ifp->if_omcasts++; 320 active = ifp->if_flags & IFF_OACTIVE; 321 } 322 _IF_ENQUEUE(ifq, m); 323 IF_UNLOCK(ifq); 324 if (ifp != NULL && !active) 325 (*ifp->if_start)(ifp); 326 return (1); 327} 328 329/* 330 * 72 was chosen below because it is the size of a TCP/IP 331 * header (40) + the minimum mss (32). 332 */ 333#define IF_MINMTU 72 334#define IF_MAXMTU 65535 335 336#endif /* _KERNEL */ 337 338/* 339 * The ifaddr structure contains information about one address 340 * of an interface. They are maintained by the different address families, 341 * are allocated and attached when an address is set, and are linked 342 * together so all addresses for an interface can be located. 343 */ 344struct ifaddr { 345 struct sockaddr *ifa_addr; /* address of interface */ 346 struct sockaddr *ifa_dstaddr; /* other end of p-to-p link */ 347#define ifa_broadaddr ifa_dstaddr /* broadcast address interface */ 348 struct sockaddr *ifa_netmask; /* used to determine subnet */ 349 struct if_data if_data; /* not all members are meaningful */ 350 struct ifnet *ifa_ifp; /* back-pointer to interface */ 351 TAILQ_ENTRY(ifaddr) ifa_link; /* queue macro glue */ 352 void (*ifa_rtrequest) /* check or clean routes (+ or -)'d */ 353 (int, struct rtentry *, struct rt_addrinfo *); 354 u_short ifa_flags; /* mostly rt_flags for cloning */ 355 u_int ifa_refcnt; /* references to this structure */ 356 int ifa_metric; /* cost of going out this interface */ 357#ifdef notdef 358 struct rtentry *ifa_rt; /* XXXX for ROUTETOIF ????? */ 359#endif 360 int (*ifa_claim_addr) /* check if an addr goes to this if */ 361 (struct ifaddr *, struct sockaddr *); 362 struct mtx ifa_mtx; 363}; 364#define IFA_ROUTE RTF_UP /* route installed */ 365 366/* for compatibility with other BSDs */ 367#define ifa_list ifa_link 368 369#define IFA_LOCK_INIT(ifa) \ 370 mtx_init(&(ifa)->ifa_mtx, "ifaddr", NULL, MTX_DEF) 371#define IFA_LOCK(ifa) mtx_lock(&(ifa)->ifa_mtx) 372#define IFA_UNLOCK(ifa) mtx_unlock(&(ifa)->ifa_mtx) 373#define IFA_DESTROY(ifa) mtx_destroy(&(ifa)->ifa_mtx) 374 375/* 376 * The prefix structure contains information about one prefix 377 * of an interface. They are maintained by the different address families, 378 * are allocated and attached when a prefix or an address is set, 379 * and are linked together so all prefixes for an interface can be located. 380 */ 381struct ifprefix { 382 struct sockaddr *ifpr_prefix; /* prefix of interface */ 383 struct ifnet *ifpr_ifp; /* back-pointer to interface */ 384 TAILQ_ENTRY(ifprefix) ifpr_list; /* queue macro glue */ 385 u_char ifpr_plen; /* prefix length in bits */ 386 u_char ifpr_type; /* protocol dependent prefix type */ 387}; 388 389/* 390 * Multicast address structure. This is analogous to the ifaddr 391 * structure except that it keeps track of multicast addresses. 392 * Also, the reference count here is a count of requests for this 393 * address, not a count of pointers to this structure. 394 */ 395struct ifmultiaddr { 396 TAILQ_ENTRY(ifmultiaddr) ifma_link; /* queue macro glue */ 397 struct sockaddr *ifma_addr; /* address this membership is for */ 398 struct sockaddr *ifma_lladdr; /* link-layer translation, if any */ 399 struct ifnet *ifma_ifp; /* back-pointer to interface */ 400 u_int ifma_refcount; /* reference count */ 401 void *ifma_protospec; /* protocol-specific state, if any */ 402}; 403 404#ifdef _KERNEL 405#define IFAFREE(ifa) \ 406 do { \ 407 IFA_LOCK(ifa); \ 408 KASSERT((ifa)->ifa_refcnt > 0, \ 409 ("ifa %p !(ifa_refcnt > 0)", ifa)); \ 410 if (--(ifa)->ifa_refcnt == 0) { \ 411 IFA_DESTROY(ifa); \ 412 free(ifa, M_IFADDR); \ 413 } else \ 414 IFA_UNLOCK(ifa); \ 415 } while (0) 416 417#define IFAREF(ifa) \ 418 do { \ 419 IFA_LOCK(ifa); \ 420 ++(ifa)->ifa_refcnt; \ 421 IFA_UNLOCK(ifa); \ 422 } while (0) 423 424extern struct mtx ifnet_lock; 425#define IFNET_LOCK_INIT() \ 426 mtx_init(&ifnet_lock, "ifnet", NULL, MTX_DEF | MTX_RECURSE) 427#define IFNET_WLOCK() mtx_lock(&ifnet_lock) 428#define IFNET_WUNLOCK() mtx_unlock(&ifnet_lock) 429#define IFNET_RLOCK() IFNET_WLOCK() 430#define IFNET_RUNLOCK() IFNET_WUNLOCK() 431 432struct ifindex_entry { 433 struct ifnet *ife_ifnet; 434 struct ifaddr *ife_ifnet_addr; 435 dev_t ife_dev; 436}; 437 438#define ifnet_byindex(idx) ifindex_table[(idx)].ife_ifnet 439#define ifaddr_byindex(idx) ifindex_table[(idx)].ife_ifnet_addr 440#define ifdev_byindex(idx) ifindex_table[(idx)].ife_dev 441 442extern struct ifnethead ifnet; 443extern struct ifindex_entry *ifindex_table; 444extern int ifqmaxlen; 445extern struct ifnet *loif; /* first loopback interface */ 446extern int if_index; 447 448int if_addmulti(struct ifnet *, struct sockaddr *, struct ifmultiaddr **); 449int if_allmulti(struct ifnet *, int); 450void if_attach(struct ifnet *); 451int if_delmulti(struct ifnet *, struct sockaddr *); 452void if_detach(struct ifnet *); 453void if_down(struct ifnet *); 454int if_printf(struct ifnet *, const char *, ...) __printflike(2, 3); 455void if_route(struct ifnet *, int flag, int fam); 456int if_setlladdr(struct ifnet *, const u_char *, int); 457void if_unroute(struct ifnet *, int flag, int fam); 458void if_up(struct ifnet *); 459/*void ifinit(void);*/ /* declared in systm.h for main() */ 460int ifioctl(struct socket *, u_long, caddr_t, struct thread *); 461int ifpromisc(struct ifnet *, int); 462struct ifnet *ifunit(const char *); 463struct ifnet *if_withname(struct sockaddr *); 464 465int if_poll_recv_slow(struct ifnet *ifp, int *quotap); 466void if_poll_xmit_slow(struct ifnet *ifp, int *quotap); 467void if_poll_throttle(void); 468void if_poll_unthrottle(void *); 469void if_poll_init(void); 470void if_poll(void); 471 472struct ifaddr *ifa_ifwithaddr(struct sockaddr *); 473struct ifaddr *ifa_ifwithdstaddr(struct sockaddr *); 474struct ifaddr *ifa_ifwithnet(struct sockaddr *); 475struct ifaddr *ifa_ifwithroute(int, struct sockaddr *, struct sockaddr *); 476struct ifaddr *ifaof_ifpforaddr(struct sockaddr *, struct ifnet *); 477 478struct ifmultiaddr *ifmaof_ifpforaddr(struct sockaddr *, struct ifnet *); 479int if_simloop(struct ifnet *ifp, struct mbuf *m, int af, int hlen); 480 481void if_clone_attach(struct if_clone *); 482void if_clone_detach(struct if_clone *); 483 484int if_clone_create(char *, int); 485int if_clone_destroy(const char *); 486 487#define IF_LLADDR(ifp) \ 488 LLADDR((struct sockaddr_dl *) ifaddr_byindex((ifp)->if_index)->ifa_addr) 489 490#ifdef DEVICE_POLLING 491enum poll_cmd { POLL_ONLY, POLL_AND_CHECK_STATUS, POLL_DEREGISTER }; 492 493typedef void poll_handler_t(struct ifnet *ifp, enum poll_cmd cmd, int count); 494int ether_poll_register(poll_handler_t *h, struct ifnet *ifp); 495int ether_poll_deregister(struct ifnet *ifp); 496#endif /* DEVICE_POLLING */ 497 498#endif /* _KERNEL */ 499 500#endif /* !_NET_IF_VAR_H_ */ 501