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