if_var.h revision 49459
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 * $Id: if_var.h,v 1.13 1999/05/16 17:09:20 pb Exp $ 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 78TAILQ_HEAD(ifnethead, ifnet); /* we use TAILQs so that the order of */ 79TAILQ_HEAD(ifaddrhead, ifaddr); /* instantiation is preserved in the list */ 80LIST_HEAD(ifmultihead, ifmultiaddr); 81 82/* 83 * Structure defining a queue for a network interface. 84 */ 85struct ifqueue { 86 struct mbuf *ifq_head; 87 struct mbuf *ifq_tail; 88 int ifq_len; 89 int ifq_maxlen; 90 int ifq_drops; 91}; 92 93/* 94 * Structure defining a network interface. 95 * 96 * (Would like to call this struct ``if'', but C isn't PL/1.) 97 */ 98struct ifnet { 99 void *if_softc; /* pointer to driver state */ 100 char *if_name; /* name, e.g. ``en'' or ``lo'' */ 101 TAILQ_ENTRY(ifnet) if_link; /* all struct ifnets are chained */ 102 struct ifaddrhead if_addrhead; /* linked list of addresses per if */ 103 int if_pcount; /* number of promiscuous listeners */ 104 struct bpf_if *if_bpf; /* packet filter structure */ 105 u_short if_index; /* numeric abbreviation for this if */ 106 short if_unit; /* sub-unit for lower level driver */ 107 short if_timer; /* time 'til if_watchdog called */ 108 short if_flags; /* up/down, broadcast, etc. */ 109 int if_ipending; /* interrupts pending */ 110 void *if_linkmib; /* link-type-specific MIB data */ 111 size_t if_linkmiblen; /* length of above data */ 112 struct if_data if_data; 113 struct ifmultihead if_multiaddrs; /* multicast addresses configured */ 114 int if_amcount; /* number of all-multicast requests */ 115/* procedure handles */ 116 int (*if_output) /* output routine (enqueue) */ 117 __P((struct ifnet *, struct mbuf *, struct sockaddr *, 118 struct rtentry *)); 119 void (*if_start) /* initiate output routine */ 120 __P((struct ifnet *)); 121 int (*if_done) /* output complete routine */ 122 __P((struct ifnet *)); /* (XXX not used; fake prototype) */ 123 int (*if_ioctl) /* ioctl routine */ 124 __P((struct ifnet *, u_long, caddr_t)); 125 void (*if_watchdog) /* timer routine */ 126 __P((struct ifnet *)); 127 int (*if_poll_recv) /* polled receive routine */ 128 __P((struct ifnet *, int *)); 129 int (*if_poll_xmit) /* polled transmit routine */ 130 __P((struct ifnet *, int *)); 131 void (*if_poll_intren) /* polled interrupt reenable routine */ 132 __P((struct ifnet *)); 133 void (*if_poll_slowinput) /* input routine for slow devices */ 134 __P((struct ifnet *, struct mbuf *)); 135 void (*if_init) /* Init routine */ 136 __P((void *)); 137 int (*if_resolvemulti) /* validate/resolve multicast */ 138 __P((struct ifnet *, struct sockaddr **, struct sockaddr *)); 139 struct ifqueue if_snd; /* output queue */ 140 struct ifqueue *if_poll_slowq; /* input queue for slow devices */ 141}; 142typedef void if_init_f_t __P((void *)); 143 144#define if_mtu if_data.ifi_mtu 145#define if_type if_data.ifi_type 146#define if_physical if_data.ifi_physical 147#define if_addrlen if_data.ifi_addrlen 148#define if_hdrlen if_data.ifi_hdrlen 149#define if_metric if_data.ifi_metric 150#define if_baudrate if_data.ifi_baudrate 151#define if_ipackets if_data.ifi_ipackets 152#define if_ierrors if_data.ifi_ierrors 153#define if_opackets if_data.ifi_opackets 154#define if_oerrors if_data.ifi_oerrors 155#define if_collisions if_data.ifi_collisions 156#define if_ibytes if_data.ifi_ibytes 157#define if_obytes if_data.ifi_obytes 158#define if_imcasts if_data.ifi_imcasts 159#define if_omcasts if_data.ifi_omcasts 160#define if_iqdrops if_data.ifi_iqdrops 161#define if_noproto if_data.ifi_noproto 162#define if_lastchange if_data.ifi_lastchange 163#define if_recvquota if_data.ifi_recvquota 164#define if_xmitquota if_data.ifi_xmitquota 165#define if_rawoutput(if, m, sa) if_output(if, m, sa, (struct rtentry *)0) 166 167/* 168 * Bit values in if_ipending 169 */ 170#define IFI_RECV 1 /* I want to receive */ 171#define IFI_XMIT 2 /* I want to transmit */ 172 173/* 174 * Output queues (ifp->if_snd) and slow device input queues (*ifp->if_slowq) 175 * are queues of messages stored on ifqueue structures 176 * (defined above). Entries are added to and deleted from these structures 177 * by these macros, which should be called with ipl raised to splimp(). 178 */ 179#define IF_QFULL(ifq) ((ifq)->ifq_len >= (ifq)->ifq_maxlen) 180#define IF_DROP(ifq) ((ifq)->ifq_drops++) 181#define IF_ENQUEUE(ifq, m) { \ 182 (m)->m_nextpkt = 0; \ 183 if ((ifq)->ifq_tail == 0) \ 184 (ifq)->ifq_head = m; \ 185 else \ 186 (ifq)->ifq_tail->m_nextpkt = m; \ 187 (ifq)->ifq_tail = m; \ 188 (ifq)->ifq_len++; \ 189} 190#define IF_PREPEND(ifq, m) { \ 191 (m)->m_nextpkt = (ifq)->ifq_head; \ 192 if ((ifq)->ifq_tail == 0) \ 193 (ifq)->ifq_tail = (m); \ 194 (ifq)->ifq_head = (m); \ 195 (ifq)->ifq_len++; \ 196} 197#define IF_DEQUEUE(ifq, m) { \ 198 (m) = (ifq)->ifq_head; \ 199 if (m) { \ 200 if (((ifq)->ifq_head = (m)->m_nextpkt) == 0) \ 201 (ifq)->ifq_tail = 0; \ 202 (m)->m_nextpkt = 0; \ 203 (ifq)->ifq_len--; \ 204 } \ 205} 206 207#ifdef KERNEL 208#define IF_ENQ_DROP(ifq, m) if_enq_drop(ifq, m) 209 210#if defined(__GNUC__) && defined(MT_HEADER) 211static __inline int 212if_queue_drop(struct ifqueue *ifq, struct mbuf *m) 213{ 214 IF_DROP(ifq); 215 return 0; 216} 217 218static __inline int 219if_enq_drop(struct ifqueue *ifq, struct mbuf *m) 220{ 221 if (IF_QFULL(ifq) && 222 !if_queue_drop(ifq, m)) 223 return 0; 224 IF_ENQUEUE(ifq, m); 225 return 1; 226} 227#else 228 229#ifdef MT_HEADER 230int if_enq_drop __P((struct ifqueue *, struct mbuf *)); 231#endif 232 233#endif 234 235/* 236 * 72 was chosen below because it is the size of a TCP/IP 237 * header (40) + the minimum mss (32). 238 */ 239#define IF_MINMTU 72 240#define IF_MAXMTU 65535 241 242#endif /* KERNEL */ 243 244/* 245 * The ifaddr structure contains information about one address 246 * of an interface. They are maintained by the different address families, 247 * are allocated and attached when an address is set, and are linked 248 * together so all addresses for an interface can be located. 249 */ 250struct ifaddr { 251 struct sockaddr *ifa_addr; /* address of interface */ 252 struct sockaddr *ifa_dstaddr; /* other end of p-to-p link */ 253#define ifa_broadaddr ifa_dstaddr /* broadcast address interface */ 254 struct sockaddr *ifa_netmask; /* used to determine subnet */ 255 struct ifnet *ifa_ifp; /* back-pointer to interface */ 256 TAILQ_ENTRY(ifaddr) ifa_link; /* queue macro glue */ 257 void (*ifa_rtrequest) /* check or clean routes (+ or -)'d */ 258 __P((int, struct rtentry *, struct sockaddr *)); 259 u_short ifa_flags; /* mostly rt_flags for cloning */ 260 u_int ifa_refcnt; /* references to this structure */ 261 int ifa_metric; /* cost of going out this interface */ 262#ifdef notdef 263 struct rtentry *ifa_rt; /* XXXX for ROUTETOIF ????? */ 264#endif 265 int (*ifa_claim_addr) /* check if an addr goes to this if */ 266 __P((struct ifaddr *, struct sockaddr *)); 267 268}; 269#define IFA_ROUTE RTF_UP /* route installed */ 270 271/* 272 * Multicast address structure. This is analogous to the ifaddr 273 * structure except that it keeps track of multicast addresses. 274 * Also, the reference count here is a count of requests for this 275 * address, not a count of pointers to this structure. 276 */ 277struct ifmultiaddr { 278 LIST_ENTRY(ifmultiaddr) ifma_link; /* queue macro glue */ 279 struct sockaddr *ifma_addr; /* address this membership is for */ 280 struct sockaddr *ifma_lladdr; /* link-layer translation, if any */ 281 struct ifnet *ifma_ifp; /* back-pointer to interface */ 282 u_int ifma_refcount; /* reference count */ 283 void *ifma_protospec; /* protocol-specific state, if any */ 284}; 285 286#ifdef KERNEL 287#define IFAFREE(ifa) \ 288 do { \ 289 if ((ifa)->ifa_refcnt <= 0) \ 290 ifafree(ifa); \ 291 else \ 292 (ifa)->ifa_refcnt--; \ 293 } while (0) 294 295extern struct ifnethead ifnet; 296extern int ifqmaxlen; 297extern struct ifnet loif[]; 298extern int if_index; 299extern struct ifaddr **ifnet_addrs; 300 301void ether_ifattach __P((struct ifnet *)); 302void ether_input __P((struct ifnet *, struct ether_header *, struct mbuf *)); 303int ether_output __P((struct ifnet *, 304 struct mbuf *, struct sockaddr *, struct rtentry *)); 305int ether_ioctl __P((struct ifnet *, int, caddr_t)); 306 307int if_addmulti __P((struct ifnet *, struct sockaddr *, 308 struct ifmultiaddr **)); 309int if_allmulti __P((struct ifnet *, int)); 310void if_attach __P((struct ifnet *)); 311int if_delmulti __P((struct ifnet *, struct sockaddr *)); 312void if_detach __P((struct ifnet *)); 313void if_down __P((struct ifnet *)); 314void if_route __P((struct ifnet *, int flag, int fam)); 315void if_unroute __P((struct ifnet *, int flag, int fam)); 316void if_up __P((struct ifnet *)); 317/*void ifinit __P((void));*/ /* declared in systm.h for main() */ 318int ifioctl __P((struct socket *, u_long, caddr_t, struct proc *)); 319int ifpromisc __P((struct ifnet *, int)); 320struct ifnet *ifunit __P((char *)); 321 322int if_poll_recv_slow __P((struct ifnet *ifp, int *quotap)); 323void if_poll_xmit_slow __P((struct ifnet *ifp, int *quotap)); 324void if_poll_throttle __P((void)); 325void if_poll_unthrottle __P((void *)); 326void if_poll_init __P((void)); 327void if_poll __P((void)); 328 329struct ifaddr *ifa_ifwithaddr __P((struct sockaddr *)); 330struct ifaddr *ifa_ifwithdstaddr __P((struct sockaddr *)); 331struct ifaddr *ifa_ifwithnet __P((struct sockaddr *)); 332struct ifaddr *ifa_ifwithroute __P((int, struct sockaddr *, 333 struct sockaddr *)); 334struct ifaddr *ifaof_ifpforaddr __P((struct sockaddr *, struct ifnet *)); 335void ifafree __P((struct ifaddr *)); 336 337struct ifmultiaddr *ifmaof_ifpforaddr __P((struct sockaddr *, 338 struct ifnet *)); 339int if_simloop __P((struct ifnet *ifp, struct mbuf *m, 340 struct sockaddr *dst, int hlen)); 341 342#endif /* KERNEL */ 343 344 345#endif /* !_NET_IF_VAR_H_ */ 346