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