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