if.h revision 17352
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 * @(#)if.h 8.1 (Berkeley) 6/10/93 34 * $Id: if.h,v 1.31 1996/07/23 14:44:46 wollman Exp $ 35 */ 36 37#ifndef _NET_IF_H_ 38#define _NET_IF_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#include <sys/socket.h> /* for struct sockaddr */ 66 67#ifndef _TIME_ /* XXX fast fix for SNMP, going away soon */ 68#include <sys/time.h> 69#endif 70 71#ifdef __STDC__ 72/* 73 * Forward structure declarations for function prototypes [sic]. 74 */ 75struct mbuf; 76struct proc; 77struct rtentry; 78struct socket; 79struct ether_header; 80#endif 81 82struct if_data { 83 /* generic interface information */ 84 u_char ifi_type; /* ethernet, tokenring, etc */ 85 u_char ifi_physical; /* e.g., AUI, Thinnet, 10base-T, etc */ 86 u_char ifi_addrlen; /* media address length */ 87 u_char ifi_hdrlen; /* media header length */ 88 u_char ifi_recvquota; /* polling quota for receive intrs */ 89 u_char ifi_xmitquota; /* polling quota for xmit intrs */ 90 u_long ifi_mtu; /* maximum transmission unit */ 91 u_long ifi_metric; /* routing metric (external only) */ 92 u_long ifi_baudrate; /* linespeed */ 93 /* volatile statistics */ 94 u_long ifi_ipackets; /* packets received on interface */ 95 u_long ifi_ierrors; /* input errors on interface */ 96 u_long ifi_opackets; /* packets sent on interface */ 97 u_long ifi_oerrors; /* output errors on interface */ 98 u_long ifi_collisions; /* collisions on csma interfaces */ 99 u_long ifi_ibytes; /* total number of octets received */ 100 u_long ifi_obytes; /* total number of octets sent */ 101 u_long ifi_imcasts; /* packets received via multicast */ 102 u_long ifi_omcasts; /* packets sent via multicast */ 103 u_long ifi_iqdrops; /* dropped on input, this interface */ 104 u_long ifi_noproto; /* destined for unsupported protocol */ 105 u_long ifi_recvtiming; /* usec spent receiving when timing */ 106 u_long ifi_xmittiming; /* usec spent xmitting when timing */ 107 struct timeval ifi_lastchange; /* time of last administrative change */ 108}; 109 110/* 111 * Structure defining a queue for a network interface. 112 * 113 * (Would like to call this struct ``if'', but C isn't PL/1.) 114 */ 115 116struct ifqueue { 117 struct mbuf *ifq_head; 118 struct mbuf *ifq_tail; 119 int ifq_len; 120 int ifq_maxlen; 121 int ifq_drops; 122}; 123 124/* 125 * Structure describing information about an interface 126 * which may be of interest to management entities. 127 */ 128struct ifnet { 129 void *if_softc; /* pointer to driver state */ 130 char *if_name; /* name, e.g. ``en'' or ``lo'' */ 131 struct ifnet *if_next; /* all struct ifnets are chained */ 132 struct ifaddr *if_addrlist; /* linked list of addresses per if */ 133 int if_pcount; /* number of promiscuous listeners */ 134 struct bpf_if *if_bpf; /* packet filter structure */ 135 u_short if_index; /* numeric abbreviation for this if */ 136 short if_unit; /* sub-unit for lower level driver */ 137 short if_timer; /* time 'til if_watchdog called */ 138 short if_flags; /* up/down, broadcast, etc. */ 139 int if_ipending; /* interrupts pending */ 140 void *if_linkmib; /* link-type-specific MIB data */ 141 size_t if_linkmiblen; /* length of above data */ 142 struct if_data if_data; 143/* procedure handles */ 144 int (*if_output) /* output routine (enqueue) */ 145 __P((struct ifnet *, struct mbuf *, struct sockaddr *, 146 struct rtentry *)); 147 void (*if_start) /* initiate output routine */ 148 __P((struct ifnet *)); 149 int (*if_done) /* output complete routine */ 150 __P((struct ifnet *)); /* (XXX not used; fake prototype) */ 151 int (*if_ioctl) /* ioctl routine */ 152 __P((struct ifnet *, int, caddr_t)); 153 void (*if_watchdog) /* timer routine */ 154 __P((struct ifnet *)); 155 int (*if_poll_recv) /* polled receive routine */ 156 __P((struct ifnet *, int *)); 157 int (*if_poll_xmit) /* polled transmit routine */ 158 __P((struct ifnet *, int *)); 159 void (*if_poll_intren) /* polled interrupt reenable routine */ 160 __P((struct ifnet *)); 161 void (*if_poll_slowinput) /* input routine for slow devices */ 162 __P((struct ifnet *, struct mbuf *)); 163 struct ifqueue if_snd; /* output queue */ 164 struct ifqueue *if_poll_slowq; /* input queue for slow devices */ 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_ipackets if_data.ifi_ipackets 174#define if_ierrors if_data.ifi_ierrors 175#define if_opackets if_data.ifi_opackets 176#define if_oerrors if_data.ifi_oerrors 177#define if_collisions if_data.ifi_collisions 178#define if_ibytes if_data.ifi_ibytes 179#define if_obytes if_data.ifi_obytes 180#define if_imcasts if_data.ifi_imcasts 181#define if_omcasts if_data.ifi_omcasts 182#define if_iqdrops if_data.ifi_iqdrops 183#define if_noproto if_data.ifi_noproto 184#define if_lastchange if_data.ifi_lastchange 185#define if_recvquota if_data.ifi_recvquota 186#define if_xmitquota if_data.ifi_xmitquota 187#define if_rawoutput(if, m, sa) if_output(if, m, sa, (struct rtentry *)0) 188 189#define IFF_UP 0x1 /* interface is up */ 190#define IFF_BROADCAST 0x2 /* broadcast address valid */ 191#define IFF_DEBUG 0x4 /* turn on debugging */ 192#define IFF_LOOPBACK 0x8 /* is a loopback net */ 193#define IFF_POINTOPOINT 0x10 /* interface is point-to-point link */ 194/*#define IFF_NOTRAILERS 0x20 * obsolete: avoid use of trailers */ 195#define IFF_RUNNING 0x40 /* resources allocated */ 196#define IFF_NOARP 0x80 /* no address resolution protocol */ 197#define IFF_PROMISC 0x100 /* receive all packets */ 198#define IFF_ALLMULTI 0x200 /* receive all multicast packets */ 199#define IFF_OACTIVE 0x400 /* transmission in progress */ 200#define IFF_SIMPLEX 0x800 /* can't hear own transmissions */ 201#define IFF_LINK0 0x1000 /* per link layer defined bit */ 202#define IFF_LINK1 0x2000 /* per link layer defined bit */ 203#define IFF_LINK2 0x4000 /* per link layer defined bit */ 204#define IFF_ALTPHYS IFF_LINK2 /* use alternate physical connection */ 205#define IFF_MULTICAST 0x8000 /* supports multicast */ 206 207/* flags set internally only: */ 208#define IFF_CANTCHANGE \ 209 (IFF_BROADCAST|IFF_POINTOPOINT|IFF_RUNNING|IFF_OACTIVE|\ 210 IFF_SIMPLEX|IFF_MULTICAST|IFF_ALLMULTI) 211 212 213/* 214 * These really don't belong here, but there's no other obviously appropriate 215 * location. 216 */ 217#define IFP_AUI 0 218#define IFP_10BASE2 1 219#define IFP_10BASET 2 220/* etc. */ 221 222/* 223 * Bit values in if_ipending 224 */ 225#define IFI_RECV 1 /* I want to receive */ 226#define IFI_XMIT 2 /* I want to transmit */ 227 228/* 229 * Output queues (ifp->if_snd) and slow device input queues (*ifp->if_slowq) 230 * are queues of messages stored on ifqueue structures 231 * (defined above). Entries are added to and deleted from these structures 232 * by these macros, which should be called with ipl raised to splimp(). 233 */ 234#define IF_QFULL(ifq) ((ifq)->ifq_len >= (ifq)->ifq_maxlen) 235#define IF_DROP(ifq) ((ifq)->ifq_drops++) 236#define IF_ENQUEUE(ifq, m) { \ 237 (m)->m_nextpkt = 0; \ 238 if ((ifq)->ifq_tail == 0) \ 239 (ifq)->ifq_head = m; \ 240 else \ 241 (ifq)->ifq_tail->m_nextpkt = m; \ 242 (ifq)->ifq_tail = m; \ 243 (ifq)->ifq_len++; \ 244} 245#define IF_PREPEND(ifq, m) { \ 246 (m)->m_nextpkt = (ifq)->ifq_head; \ 247 if ((ifq)->ifq_tail == 0) \ 248 (ifq)->ifq_tail = (m); \ 249 (ifq)->ifq_head = (m); \ 250 (ifq)->ifq_len++; \ 251} 252#define IF_DEQUEUE(ifq, m) { \ 253 (m) = (ifq)->ifq_head; \ 254 if (m) { \ 255 if (((ifq)->ifq_head = (m)->m_nextpkt) == 0) \ 256 (ifq)->ifq_tail = 0; \ 257 (m)->m_nextpkt = 0; \ 258 (ifq)->ifq_len--; \ 259 } \ 260} 261 262#ifdef KERNEL 263#define IF_ENQ_DROP(ifq, m) if_enq_drop(ifq, m) 264 265#if defined(__GNUC__) && defined(MT_HEADER) 266static inline int 267if_queue_drop(struct ifqueue *ifq, struct mbuf *m) 268{ 269 IF_DROP(ifq); 270 return 0; 271} 272 273static inline int 274if_enq_drop(struct ifqueue *ifq, struct mbuf *m) 275{ 276 if (IF_QFULL(ifq) && 277 !if_queue_drop(ifq, m)) 278 return 0; 279 IF_ENQUEUE(ifq, m); 280 return 1; 281} 282#else 283 284#ifdef MT_HEADER 285int if_enq_drop __P((struct ifqueue *, struct mbuf *)); 286#endif 287 288#endif 289#endif /* KERNEL */ 290 291#define IFQ_MAXLEN 50 292#define IFNET_SLOWHZ 1 /* granularity is 1 second */ 293 294/* 295 * The ifaddr structure contains information about one address 296 * of an interface. They are maintained by the different address families, 297 * are allocated and attached when an address is set, and are linked 298 * together so all addresses for an interface can be located. 299 */ 300struct ifaddr { 301 struct sockaddr *ifa_addr; /* address of interface */ 302 struct sockaddr *ifa_dstaddr; /* other end of p-to-p link */ 303#define ifa_broadaddr ifa_dstaddr /* broadcast address interface */ 304 struct sockaddr *ifa_netmask; /* used to determine subnet */ 305 struct ifnet *ifa_ifp; /* back-pointer to interface */ 306 struct ifaddr *ifa_next; /* next address for interface */ 307 void (*ifa_rtrequest) /* check or clean routes (+ or -)'d */ 308 __P((int, struct rtentry *, struct sockaddr *)); 309 u_short ifa_flags; /* mostly rt_flags for cloning */ 310 short ifa_refcnt; /* extra to malloc for link info */ 311 int ifa_metric; /* cost of going out this interface */ 312#ifdef notdef 313 struct rtentry *ifa_rt; /* XXXX for ROUTETOIF ????? */ 314#endif 315}; 316#define IFA_ROUTE RTF_UP /* route installed */ 317 318/* 319 * Message format for use in obtaining information about interfaces 320 * from getkerninfo and the routing socket 321 */ 322struct if_msghdr { 323 u_short ifm_msglen; /* to skip over non-understood messages */ 324 u_char ifm_version; /* future binary compatability */ 325 u_char ifm_type; /* message type */ 326 int ifm_addrs; /* like rtm_addrs */ 327 int ifm_flags; /* value of if_flags */ 328 u_short ifm_index; /* index for associated ifp */ 329 struct if_data ifm_data;/* statistics and other data about if */ 330}; 331 332/* 333 * Message format for use in obtaining information about interface addresses 334 * from getkerninfo and the routing socket 335 */ 336struct ifa_msghdr { 337 u_short ifam_msglen; /* to skip over non-understood messages */ 338 u_char ifam_version; /* future binary compatability */ 339 u_char ifam_type; /* message type */ 340 int ifam_addrs; /* like rtm_addrs */ 341 int ifam_flags; /* value of ifa_flags */ 342 u_short ifam_index; /* index for associated ifp */ 343 int ifam_metric; /* value of ifa_metric */ 344}; 345 346/* 347 * Interface request structure used for socket 348 * ioctl's. All interface ioctl's must have parameter 349 * definitions which begin with ifr_name. The 350 * remainder may be interface specific. 351 */ 352struct ifreq { 353#define IFNAMSIZ 16 354 char ifr_name[IFNAMSIZ]; /* if name, e.g. "en0" */ 355 union { 356 struct sockaddr ifru_addr; 357 struct sockaddr ifru_dstaddr; 358 struct sockaddr ifru_broadaddr; 359 short ifru_flags; 360 int ifru_metric; 361 int ifru_mtu; 362 int ifru_phys; 363 caddr_t ifru_data; 364 } ifr_ifru; 365#define ifr_addr ifr_ifru.ifru_addr /* address */ 366#define ifr_dstaddr ifr_ifru.ifru_dstaddr /* other end of p-to-p link */ 367#define ifr_broadaddr ifr_ifru.ifru_broadaddr /* broadcast address */ 368#define ifr_flags ifr_ifru.ifru_flags /* flags */ 369#define ifr_metric ifr_ifru.ifru_metric /* metric */ 370#define ifr_mtu ifr_ifru.ifru_mtu /* mtu */ 371#define ifr_phys ifr_ifru.ifru_phys /* physical wire */ 372#define ifr_data ifr_ifru.ifru_data /* for use by interface */ 373}; 374 375struct ifaliasreq { 376 char ifra_name[IFNAMSIZ]; /* if name, e.g. "en0" */ 377 struct sockaddr ifra_addr; 378 struct sockaddr ifra_broadaddr; 379 struct sockaddr ifra_mask; 380}; 381 382/* 383 * Structure used in SIOCGIFCONF request. 384 * Used to retrieve interface configuration 385 * for machine (useful for programs which 386 * must know all networks accessible). 387 */ 388struct ifconf { 389 int ifc_len; /* size of associated buffer */ 390 union { 391 caddr_t ifcu_buf; 392 struct ifreq *ifcu_req; 393 } ifc_ifcu; 394#define ifc_buf ifc_ifcu.ifcu_buf /* buffer address */ 395#define ifc_req ifc_ifcu.ifcu_req /* array of structures returned */ 396}; 397 398#include <net/if_arp.h> 399 400#ifdef KERNEL 401#define IFAFREE(ifa) \ 402 if ((ifa)->ifa_refcnt <= 0) \ 403 ifafree(ifa); \ 404 else \ 405 (ifa)->ifa_refcnt--; 406 407extern struct ifnet *ifnet; 408extern int ifqmaxlen; 409extern struct ifnet loif[]; 410extern int if_index; 411extern struct ifaddr **ifnet_addrs; 412 413void ether_ifattach __P((struct ifnet *)); 414void ether_input __P((struct ifnet *, struct ether_header *, struct mbuf *)); 415int ether_output __P((struct ifnet *, 416 struct mbuf *, struct sockaddr *, struct rtentry *)); 417 418void if_attach __P((struct ifnet *)); 419void if_down __P((struct ifnet *)); 420void if_up __P((struct ifnet *)); 421#ifdef vax 422void ifubareset __P((int)); 423#endif 424/*void ifinit __P((void));*/ /* declared in systm.h for main() */ 425int ifioctl __P((struct socket *, int, caddr_t, struct proc *)); 426int ifpromisc __P((struct ifnet *, int)); 427struct ifnet *ifunit __P((char *)); 428 429int if_poll_recv_slow __P((struct ifnet *ifp, int *quotap)); 430void if_poll_xmit_slow __P((struct ifnet *ifp, int *quotap)); 431void if_poll_throttle __P((void)); 432void if_poll_unthrottle __P((void *)); 433void if_poll_init __P((void)); 434void if_poll __P((void)); 435 436struct ifaddr *ifa_ifwithaddr __P((struct sockaddr *)); 437struct ifaddr *ifa_ifwithdstaddr __P((struct sockaddr *)); 438struct ifaddr *ifa_ifwithnet __P((struct sockaddr *)); 439struct ifaddr *ifa_ifwithroute __P((int, struct sockaddr *, 440 struct sockaddr *)); 441struct ifaddr *ifaof_ifpforaddr __P((struct sockaddr *, struct ifnet *)); 442void ifafree __P((struct ifaddr *)); 443 444int looutput __P((struct ifnet *, 445 struct mbuf *, struct sockaddr *, struct rtentry *)); 446#endif /* KERNEL */ 447 448#endif /* !_NET_IF_H_ */ 449