if_var.h revision 84931
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 84931 2001-10-14 20:17:53Z fjoe $ 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 a 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 a 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 socket; 73struct ether_header; 74#endif 75 76#include <sys/queue.h> /* get TAILQ macros */ 77 78#ifdef _KERNEL 79#include <sys/mbuf.h> 80#include <sys/systm.h> /* XXX */ 81#endif /* _KERNEL */ 82#include <sys/lock.h> /* XXX */ 83#include <sys/mutex.h> /* XXX */ 84#include <sys/event.h> /* XXX */ 85 86TAILQ_HEAD(ifnethead, ifnet); /* we use TAILQs so that the order of */ 87TAILQ_HEAD(ifaddrhead, ifaddr); /* instantiation is preserved in the list */ 88TAILQ_HEAD(ifprefixhead, ifprefix); 89TAILQ_HEAD(ifmultihead, ifmultiaddr); 90 91/* 92 * Structure defining a queue for a network interface. 93 */ 94struct ifqueue { 95 struct mbuf *ifq_head; 96 struct mbuf *ifq_tail; 97 int ifq_len; 98 int ifq_maxlen; 99 int ifq_drops; 100 struct mtx ifq_mtx; 101}; 102 103/* 104 * Structure defining a network interface. 105 * 106 * (Would like to call this struct ``if'', but C isn't PL/1.) 107 */ 108 109/* 110 * NB: For FreeBSD, it is assumed that each NIC driver's softc starts with 111 * one of these structures, typically held within an arpcom structure. 112 */ 113struct ifnet { 114 void *if_softc; /* pointer to driver state */ 115 char *if_name; /* name, e.g. ``en'' or ``lo'' */ 116 TAILQ_ENTRY(ifnet) if_link; /* all struct ifnets are chained */ 117 struct ifaddrhead if_addrhead; /* linked list of addresses per if */ 118 struct klist if_klist; /* events attached to this if */ 119 int if_pcount; /* number of promiscuous listeners */ 120 struct bpf_if *if_bpf; /* packet filter structure */ 121 u_short if_index; /* numeric abbreviation for this if */ 122 short if_unit; /* sub-unit for lower level driver */ 123 short if_timer; /* time 'til if_watchdog called */ 124 short if_flags; /* up/down, broadcast, etc. */ 125 int if_capabilities; /* interface capabilities */ 126 int if_capenable; /* enabled features */ 127 int if_mpsafe; /* XXX TEMPORARY */ 128 int if_ipending; /* interrupts pending */ 129 void *if_linkmib; /* link-type-specific MIB data */ 130 size_t if_linkmiblen; /* length of above data */ 131 struct if_data if_data; 132 struct ifmultihead if_multiaddrs; /* multicast addresses configured */ 133 int if_amcount; /* number of all-multicast requests */ 134/* procedure handles */ 135 int (*if_output) /* output routine (enqueue) */ 136 __P((struct ifnet *, struct mbuf *, struct sockaddr *, 137 struct rtentry *)); 138 void (*if_start) /* initiate output routine */ 139 __P((struct ifnet *)); 140 int (*if_done) /* output complete routine */ 141 __P((struct ifnet *)); /* (XXX not used; fake prototype) */ 142 int (*if_ioctl) /* ioctl routine */ 143 __P((struct ifnet *, u_long, caddr_t)); 144 void (*if_watchdog) /* timer routine */ 145 __P((struct ifnet *)); 146 int (*if_poll_recv) /* polled receive routine */ 147 __P((struct ifnet *, int *)); 148 int (*if_poll_xmit) /* polled transmit routine */ 149 __P((struct ifnet *, int *)); 150 void (*if_poll_intren) /* polled interrupt reenable routine */ 151 __P((struct ifnet *)); 152 void (*if_poll_slowinput) /* input routine for slow devices */ 153 __P((struct ifnet *, struct mbuf *)); 154 void (*if_init) /* Init routine */ 155 __P((void *)); 156 int (*if_resolvemulti) /* validate/resolve multicast */ 157 __P((struct ifnet *, struct sockaddr **, struct sockaddr *)); 158 struct ifqueue if_snd; /* output queue */ 159 struct ifqueue *if_poll_slowq; /* input queue for slow devices */ 160 struct ifprefixhead if_prefixhead; /* list of prefixes per if */ 161 u_int8_t *if_broadcastaddr; /* linklevel broadcast bytestring */ 162}; 163 164typedef void if_init_f_t __P((void *)); 165 166#define if_mtu if_data.ifi_mtu 167#define if_type if_data.ifi_type 168#define if_physical if_data.ifi_physical 169#define if_addrlen if_data.ifi_addrlen 170#define if_hdrlen if_data.ifi_hdrlen 171#define if_metric if_data.ifi_metric 172#define if_baudrate if_data.ifi_baudrate 173#define if_hwassist if_data.ifi_hwassist 174#define if_ipackets if_data.ifi_ipackets 175#define if_ierrors if_data.ifi_ierrors 176#define if_opackets if_data.ifi_opackets 177#define if_oerrors if_data.ifi_oerrors 178#define if_collisions if_data.ifi_collisions 179#define if_ibytes if_data.ifi_ibytes 180#define if_obytes if_data.ifi_obytes 181#define if_imcasts if_data.ifi_imcasts 182#define if_omcasts if_data.ifi_omcasts 183#define if_iqdrops if_data.ifi_iqdrops 184#define if_noproto if_data.ifi_noproto 185#define if_lastchange if_data.ifi_lastchange 186#define if_recvquota if_data.ifi_recvquota 187#define if_xmitquota if_data.ifi_xmitquota 188#define if_rawoutput(if, m, sa) if_output(if, m, sa, (struct rtentry *)0) 189 190/* for compatibility with other BSDs */ 191#define if_addrlist if_addrhead 192#define if_list if_link 193 194/* 195 * Bit values in if_ipending 196 */ 197#define IFI_RECV 1 /* I want to receive */ 198#define IFI_XMIT 2 /* I want to transmit */ 199 200/* 201 * Output queues (ifp->if_snd) and slow device input queues (*ifp->if_slowq) 202 * are queues of messages stored on ifqueue structures 203 * (defined above). Entries are added to and deleted from these structures 204 * by these macros, which should be called with ipl raised to splimp(). 205 */ 206#define IF_LOCK(ifq) mtx_lock(&(ifq)->ifq_mtx) 207#define IF_UNLOCK(ifq) mtx_unlock(&(ifq)->ifq_mtx) 208#define _IF_QFULL(ifq) ((ifq)->ifq_len >= (ifq)->ifq_maxlen) 209#define _IF_DROP(ifq) ((ifq)->ifq_drops++) 210#define _IF_QLEN(ifq) ((ifq)->ifq_len) 211 212#define _IF_ENQUEUE(ifq, m) do { \ 213 (m)->m_nextpkt = NULL; \ 214 if ((ifq)->ifq_tail == NULL) \ 215 (ifq)->ifq_head = m; \ 216 else \ 217 (ifq)->ifq_tail->m_nextpkt = m; \ 218 (ifq)->ifq_tail = m; \ 219 (ifq)->ifq_len++; \ 220} while (0) 221 222#define IF_ENQUEUE(ifq, m) do { \ 223 IF_LOCK(ifq); \ 224 _IF_ENQUEUE(ifq, m); \ 225 IF_UNLOCK(ifq); \ 226} while (0) 227 228#define _IF_PREPEND(ifq, m) do { \ 229 (m)->m_nextpkt = (ifq)->ifq_head; \ 230 if ((ifq)->ifq_tail == NULL) \ 231 (ifq)->ifq_tail = (m); \ 232 (ifq)->ifq_head = (m); \ 233 (ifq)->ifq_len++; \ 234} while (0) 235 236#define IF_PREPEND(ifq, m) do { \ 237 IF_LOCK(ifq); \ 238 _IF_PREPEND(ifq, m); \ 239 IF_UNLOCK(ifq); \ 240} while (0) 241 242#define _IF_DEQUEUE(ifq, m) do { \ 243 (m) = (ifq)->ifq_head; \ 244 if (m) { \ 245 if (((ifq)->ifq_head = (m)->m_nextpkt) == 0) \ 246 (ifq)->ifq_tail = NULL; \ 247 (m)->m_nextpkt = NULL; \ 248 (ifq)->ifq_len--; \ 249 } \ 250} while (0) 251 252#define IF_DEQUEUE(ifq, m) do { \ 253 IF_LOCK(ifq); \ 254 _IF_DEQUEUE(ifq, m); \ 255 IF_UNLOCK(ifq); \ 256} while (0) 257 258#define IF_DRAIN(ifq) do { \ 259 struct mbuf *m; \ 260 IF_LOCK(ifq); \ 261 for (;;) { \ 262 _IF_DEQUEUE(ifq, m); \ 263 if (m == NULL) \ 264 break; \ 265 m_freem(m); \ 266 } \ 267 IF_UNLOCK(ifq); \ 268} while (0) 269 270#ifdef _KERNEL 271#define IF_HANDOFF(ifq, m, ifp) if_handoff(ifq, m, ifp, 0) 272#define IF_HANDOFF_ADJ(ifq, m, ifp, adj) if_handoff(ifq, m, ifp, adj) 273 274static __inline int 275if_handoff(struct ifqueue *ifq, struct mbuf *m, struct ifnet *ifp, int adjust) 276{ 277 int active = 0; 278 279 IF_LOCK(ifq); 280 if (_IF_QFULL(ifq)) { 281 _IF_DROP(ifq); 282 IF_UNLOCK(ifq); 283 m_freem(m); 284 return (0); 285 } 286 if (ifp != NULL) { 287 ifp->if_obytes += m->m_pkthdr.len + adjust; 288 if (m->m_flags & M_MCAST) 289 ifp->if_omcasts++; 290 active = ifp->if_flags & IFF_OACTIVE; 291 } 292 _IF_ENQUEUE(ifq, m); 293 IF_UNLOCK(ifq); 294 if (ifp != NULL && !active) { 295 if (ifp->if_mpsafe) { 296 DROP_GIANT_NOSWITCH(); 297 (*ifp->if_start)(ifp); 298 PICKUP_GIANT(); 299 } else { 300 (*ifp->if_start)(ifp); 301 } 302 } 303 return (1); 304} 305 306/* 307 * 72 was chosen below because it is the size of a TCP/IP 308 * header (40) + the minimum mss (32). 309 */ 310#define IF_MINMTU 72 311#define IF_MAXMTU 65535 312 313#endif /* _KERNEL */ 314 315/* 316 * The ifaddr structure contains information about one address 317 * of an interface. They are maintained by the different address families, 318 * are allocated and attached when an address is set, and are linked 319 * together so all addresses for an interface can be located. 320 */ 321struct ifaddr { 322 struct sockaddr *ifa_addr; /* address of interface */ 323 struct sockaddr *ifa_dstaddr; /* other end of p-to-p link */ 324#define ifa_broadaddr ifa_dstaddr /* broadcast address interface */ 325 struct sockaddr *ifa_netmask; /* used to determine subnet */ 326 struct if_data if_data; /* not all members are meaningful */ 327 struct ifnet *ifa_ifp; /* back-pointer to interface */ 328 TAILQ_ENTRY(ifaddr) ifa_link; /* queue macro glue */ 329 void (*ifa_rtrequest) /* check or clean routes (+ or -)'d */ 330 __P((int, struct rtentry *, struct sockaddr *)); 331 u_short ifa_flags; /* mostly rt_flags for cloning */ 332 u_int ifa_refcnt; /* references to this structure */ 333 int ifa_metric; /* cost of going out this interface */ 334#ifdef notdef 335 struct rtentry *ifa_rt; /* XXXX for ROUTETOIF ????? */ 336#endif 337 int (*ifa_claim_addr) /* check if an addr goes to this if */ 338 __P((struct ifaddr *, struct sockaddr *)); 339 340}; 341#define IFA_ROUTE RTF_UP /* route installed */ 342 343/* for compatibility with other BSDs */ 344#define ifa_list ifa_link 345 346/* 347 * The prefix structure contains information about one prefix 348 * of an interface. They are maintained by the different address families, 349 * are allocated and attached when an prefix or an address is set, 350 * and are linked together so all prefixes for an interface can be located. 351 */ 352struct ifprefix { 353 struct sockaddr *ifpr_prefix; /* prefix of interface */ 354 struct ifnet *ifpr_ifp; /* back-pointer to interface */ 355 TAILQ_ENTRY(ifprefix) ifpr_list; /* queue macro glue */ 356 u_char ifpr_plen; /* prefix length in bits */ 357 u_char ifpr_type; /* protocol dependent prefix type */ 358}; 359 360/* 361 * Multicast address structure. This is analogous to the ifaddr 362 * structure except that it keeps track of multicast addresses. 363 * Also, the reference count here is a count of requests for this 364 * address, not a count of pointers to this structure. 365 */ 366struct ifmultiaddr { 367 TAILQ_ENTRY(ifmultiaddr) ifma_link; /* queue macro glue */ 368 struct sockaddr *ifma_addr; /* address this membership is for */ 369 struct sockaddr *ifma_lladdr; /* link-layer translation, if any */ 370 struct ifnet *ifma_ifp; /* back-pointer to interface */ 371 u_int ifma_refcount; /* reference count */ 372 void *ifma_protospec; /* protocol-specific state, if any */ 373}; 374 375#ifdef _KERNEL 376#define IFAFREE(ifa) \ 377 do { \ 378 if ((ifa)->ifa_refcnt <= 0) \ 379 ifafree(ifa); \ 380 else \ 381 (ifa)->ifa_refcnt--; \ 382 } while (0) 383 384struct ifindex_entry { 385 struct ifnet *ife_ifnet; 386 struct ifaddr *ife_ifnet_addr; 387 dev_t ife_dev; 388}; 389 390#define ifnet_byindex(idx) ifindex_table[(idx)].ife_ifnet 391#define ifaddr_byindex(idx) ifindex_table[(idx)].ife_ifnet_addr 392#define ifdev_byindex(idx) ifindex_table[(idx)].ife_dev 393 394extern struct ifnethead ifnet; 395extern struct ifindex_entry *ifindex_table; 396extern int ifqmaxlen; 397extern struct ifnet *loif; /* first loopback interface */ 398extern int if_index; 399 400void ether_ifattach __P((struct ifnet *, int)); 401void ether_ifdetach __P((struct ifnet *, int)); 402void ether_input __P((struct ifnet *, struct ether_header *, struct mbuf *)); 403void ether_demux __P((struct ifnet *, struct ether_header *, struct mbuf *)); 404int ether_output __P((struct ifnet *, 405 struct mbuf *, struct sockaddr *, struct rtentry *)); 406int ether_output_frame __P((struct ifnet *, struct mbuf *)); 407int ether_ioctl __P((struct ifnet *, int, caddr_t)); 408 409int if_addmulti __P((struct ifnet *, struct sockaddr *, 410 struct ifmultiaddr **)); 411int if_allmulti __P((struct ifnet *, int)); 412void if_attach __P((struct ifnet *)); 413int if_delmulti __P((struct ifnet *, struct sockaddr *)); 414void if_detach __P((struct ifnet *)); 415void if_down __P((struct ifnet *)); 416void if_route __P((struct ifnet *, int flag, int fam)); 417int if_setlladdr __P((struct ifnet *, const u_char *, int)); 418void if_unroute __P((struct ifnet *, int flag, int fam)); 419void if_up __P((struct ifnet *)); 420/*void ifinit __P((void));*/ /* declared in systm.h for main() */ 421int ifioctl __P((struct socket *, u_long, caddr_t, struct thread *)); 422int ifpromisc __P((struct ifnet *, int)); 423struct ifnet *ifunit __P((const char *)); 424struct ifnet *if_withname __P((struct sockaddr *)); 425 426int if_poll_recv_slow __P((struct ifnet *ifp, int *quotap)); 427void if_poll_xmit_slow __P((struct ifnet *ifp, int *quotap)); 428void if_poll_throttle __P((void)); 429void if_poll_unthrottle __P((void *)); 430void if_poll_init __P((void)); 431void if_poll __P((void)); 432 433struct ifaddr *ifa_ifwithaddr __P((struct sockaddr *)); 434struct ifaddr *ifa_ifwithdstaddr __P((struct sockaddr *)); 435struct ifaddr *ifa_ifwithnet __P((struct sockaddr *)); 436struct ifaddr *ifa_ifwithroute __P((int, struct sockaddr *, 437 struct sockaddr *)); 438struct ifaddr *ifaof_ifpforaddr __P((struct sockaddr *, struct ifnet *)); 439void ifafree __P((struct ifaddr *)); 440 441struct ifmultiaddr *ifmaof_ifpforaddr __P((struct sockaddr *, 442 struct ifnet *)); 443int if_simloop __P((struct ifnet *ifp, struct mbuf *m, int af, int hlen)); 444 445void if_clone_attach __P((struct if_clone *)); 446void if_clone_detach __P((struct if_clone *)); 447 448int if_clone_create __P((char *, int)); 449int if_clone_destroy __P((const char *)); 450 451#define IF_LLADDR(ifp) \ 452 LLADDR((struct sockaddr_dl *) ifaddr_byindex((ifp)->if_index)->ifa_addr) 453 454#endif /* _KERNEL */ 455 456#endif /* !_NET_IF_VAR_H_ */ 457