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