if.h revision 17415
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.32 1996/07/30 19:17:00 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 void (*if_init) /* Init routine */ 164 __P((void *)); 165 struct ifqueue if_snd; /* output queue */ 166 struct ifqueue *if_poll_slowq; /* input queue for slow devices */ 167}; 168typedef void if_init_f_t __P((void *)); 169 170#define if_mtu if_data.ifi_mtu 171#define if_type if_data.ifi_type 172#define if_physical if_data.ifi_physical 173#define if_addrlen if_data.ifi_addrlen 174#define if_hdrlen if_data.ifi_hdrlen 175#define if_metric if_data.ifi_metric 176#define if_baudrate if_data.ifi_baudrate 177#define if_ipackets if_data.ifi_ipackets 178#define if_ierrors if_data.ifi_ierrors 179#define if_opackets if_data.ifi_opackets 180#define if_oerrors if_data.ifi_oerrors 181#define if_collisions if_data.ifi_collisions 182#define if_ibytes if_data.ifi_ibytes 183#define if_obytes if_data.ifi_obytes 184#define if_imcasts if_data.ifi_imcasts 185#define if_omcasts if_data.ifi_omcasts 186#define if_iqdrops if_data.ifi_iqdrops 187#define if_noproto if_data.ifi_noproto 188#define if_lastchange if_data.ifi_lastchange 189#define if_recvquota if_data.ifi_recvquota 190#define if_xmitquota if_data.ifi_xmitquota 191#define if_rawoutput(if, m, sa) if_output(if, m, sa, (struct rtentry *)0) 192 193#define IFF_UP 0x1 /* interface is up */ 194#define IFF_BROADCAST 0x2 /* broadcast address valid */ 195#define IFF_DEBUG 0x4 /* turn on debugging */ 196#define IFF_LOOPBACK 0x8 /* is a loopback net */ 197#define IFF_POINTOPOINT 0x10 /* interface is point-to-point link */ 198/*#define IFF_NOTRAILERS 0x20 * obsolete: avoid use of trailers */ 199#define IFF_RUNNING 0x40 /* resources allocated */ 200#define IFF_NOARP 0x80 /* no address resolution protocol */ 201#define IFF_PROMISC 0x100 /* receive all packets */ 202#define IFF_ALLMULTI 0x200 /* receive all multicast packets */ 203#define IFF_OACTIVE 0x400 /* transmission in progress */ 204#define IFF_SIMPLEX 0x800 /* can't hear own transmissions */ 205#define IFF_LINK0 0x1000 /* per link layer defined bit */ 206#define IFF_LINK1 0x2000 /* per link layer defined bit */ 207#define IFF_LINK2 0x4000 /* per link layer defined bit */ 208#define IFF_ALTPHYS IFF_LINK2 /* use alternate physical connection */ 209#define IFF_MULTICAST 0x8000 /* supports multicast */ 210 211/* flags set internally only: */ 212#define IFF_CANTCHANGE \ 213 (IFF_BROADCAST|IFF_POINTOPOINT|IFF_RUNNING|IFF_OACTIVE|\ 214 IFF_SIMPLEX|IFF_MULTICAST|IFF_ALLMULTI) 215 216 217/* 218 * These really don't belong here, but there's no other obviously appropriate 219 * location. 220 */ 221#define IFP_AUI 0 222#define IFP_10BASE2 1 223#define IFP_10BASET 2 224/* etc. */ 225 226/* 227 * Bit values in if_ipending 228 */ 229#define IFI_RECV 1 /* I want to receive */ 230#define IFI_XMIT 2 /* I want to transmit */ 231 232/* 233 * Output queues (ifp->if_snd) and slow device input queues (*ifp->if_slowq) 234 * are queues of messages stored on ifqueue structures 235 * (defined above). Entries are added to and deleted from these structures 236 * by these macros, which should be called with ipl raised to splimp(). 237 */ 238#define IF_QFULL(ifq) ((ifq)->ifq_len >= (ifq)->ifq_maxlen) 239#define IF_DROP(ifq) ((ifq)->ifq_drops++) 240#define IF_ENQUEUE(ifq, m) { \ 241 (m)->m_nextpkt = 0; \ 242 if ((ifq)->ifq_tail == 0) \ 243 (ifq)->ifq_head = m; \ 244 else \ 245 (ifq)->ifq_tail->m_nextpkt = m; \ 246 (ifq)->ifq_tail = m; \ 247 (ifq)->ifq_len++; \ 248} 249#define IF_PREPEND(ifq, m) { \ 250 (m)->m_nextpkt = (ifq)->ifq_head; \ 251 if ((ifq)->ifq_tail == 0) \ 252 (ifq)->ifq_tail = (m); \ 253 (ifq)->ifq_head = (m); \ 254 (ifq)->ifq_len++; \ 255} 256#define IF_DEQUEUE(ifq, m) { \ 257 (m) = (ifq)->ifq_head; \ 258 if (m) { \ 259 if (((ifq)->ifq_head = (m)->m_nextpkt) == 0) \ 260 (ifq)->ifq_tail = 0; \ 261 (m)->m_nextpkt = 0; \ 262 (ifq)->ifq_len--; \ 263 } \ 264} 265 266#ifdef KERNEL 267#define IF_ENQ_DROP(ifq, m) if_enq_drop(ifq, m) 268 269#if defined(__GNUC__) && defined(MT_HEADER) 270static inline int 271if_queue_drop(struct ifqueue *ifq, struct mbuf *m) 272{ 273 IF_DROP(ifq); 274 return 0; 275} 276 277static inline int 278if_enq_drop(struct ifqueue *ifq, struct mbuf *m) 279{ 280 if (IF_QFULL(ifq) && 281 !if_queue_drop(ifq, m)) 282 return 0; 283 IF_ENQUEUE(ifq, m); 284 return 1; 285} 286#else 287 288#ifdef MT_HEADER 289int if_enq_drop __P((struct ifqueue *, struct mbuf *)); 290#endif 291 292#endif 293#endif /* KERNEL */ 294 295#define IFQ_MAXLEN 50 296#define IFNET_SLOWHZ 1 /* granularity is 1 second */ 297 298/* 299 * The ifaddr structure contains information about one address 300 * of an interface. They are maintained by the different address families, 301 * are allocated and attached when an address is set, and are linked 302 * together so all addresses for an interface can be located. 303 */ 304struct ifaddr { 305 struct sockaddr *ifa_addr; /* address of interface */ 306 struct sockaddr *ifa_dstaddr; /* other end of p-to-p link */ 307#define ifa_broadaddr ifa_dstaddr /* broadcast address interface */ 308 struct sockaddr *ifa_netmask; /* used to determine subnet */ 309 struct ifnet *ifa_ifp; /* back-pointer to interface */ 310 struct ifaddr *ifa_next; /* next address for interface */ 311 void (*ifa_rtrequest) /* check or clean routes (+ or -)'d */ 312 __P((int, struct rtentry *, struct sockaddr *)); 313 u_short ifa_flags; /* mostly rt_flags for cloning */ 314 short ifa_refcnt; /* extra to malloc for link info */ 315 int ifa_metric; /* cost of going out this interface */ 316#ifdef notdef 317 struct rtentry *ifa_rt; /* XXXX for ROUTETOIF ????? */ 318#endif 319}; 320#define IFA_ROUTE RTF_UP /* route installed */ 321 322/* 323 * Message format for use in obtaining information about interfaces 324 * from getkerninfo and the routing socket 325 */ 326struct if_msghdr { 327 u_short ifm_msglen; /* to skip over non-understood messages */ 328 u_char ifm_version; /* future binary compatability */ 329 u_char ifm_type; /* message type */ 330 int ifm_addrs; /* like rtm_addrs */ 331 int ifm_flags; /* value of if_flags */ 332 u_short ifm_index; /* index for associated ifp */ 333 struct if_data ifm_data;/* statistics and other data about if */ 334}; 335 336/* 337 * Message format for use in obtaining information about interface addresses 338 * from getkerninfo and the routing socket 339 */ 340struct ifa_msghdr { 341 u_short ifam_msglen; /* to skip over non-understood messages */ 342 u_char ifam_version; /* future binary compatability */ 343 u_char ifam_type; /* message type */ 344 int ifam_addrs; /* like rtm_addrs */ 345 int ifam_flags; /* value of ifa_flags */ 346 u_short ifam_index; /* index for associated ifp */ 347 int ifam_metric; /* value of ifa_metric */ 348}; 349 350/* 351 * Interface request structure used for socket 352 * ioctl's. All interface ioctl's must have parameter 353 * definitions which begin with ifr_name. The 354 * remainder may be interface specific. 355 */ 356struct ifreq { 357#define IFNAMSIZ 16 358 char ifr_name[IFNAMSIZ]; /* if name, e.g. "en0" */ 359 union { 360 struct sockaddr ifru_addr; 361 struct sockaddr ifru_dstaddr; 362 struct sockaddr ifru_broadaddr; 363 short ifru_flags; 364 int ifru_metric; 365 int ifru_mtu; 366 int ifru_phys; 367 caddr_t ifru_data; 368 } ifr_ifru; 369#define ifr_addr ifr_ifru.ifru_addr /* address */ 370#define ifr_dstaddr ifr_ifru.ifru_dstaddr /* other end of p-to-p link */ 371#define ifr_broadaddr ifr_ifru.ifru_broadaddr /* broadcast address */ 372#define ifr_flags ifr_ifru.ifru_flags /* flags */ 373#define ifr_metric ifr_ifru.ifru_metric /* metric */ 374#define ifr_mtu ifr_ifru.ifru_mtu /* mtu */ 375#define ifr_phys ifr_ifru.ifru_phys /* physical wire */ 376#define ifr_data ifr_ifru.ifru_data /* for use by interface */ 377}; 378 379struct ifaliasreq { 380 char ifra_name[IFNAMSIZ]; /* if name, e.g. "en0" */ 381 struct sockaddr ifra_addr; 382 struct sockaddr ifra_broadaddr; 383 struct sockaddr ifra_mask; 384}; 385 386/* 387 * Structure used in SIOCGIFCONF request. 388 * Used to retrieve interface configuration 389 * for machine (useful for programs which 390 * must know all networks accessible). 391 */ 392struct ifconf { 393 int ifc_len; /* size of associated buffer */ 394 union { 395 caddr_t ifcu_buf; 396 struct ifreq *ifcu_req; 397 } ifc_ifcu; 398#define ifc_buf ifc_ifcu.ifcu_buf /* buffer address */ 399#define ifc_req ifc_ifcu.ifcu_req /* array of structures returned */ 400}; 401 402#include <net/if_arp.h> 403 404#ifdef KERNEL 405#define IFAFREE(ifa) \ 406 if ((ifa)->ifa_refcnt <= 0) \ 407 ifafree(ifa); \ 408 else \ 409 (ifa)->ifa_refcnt--; 410 411extern struct ifnet *ifnet; 412extern int ifqmaxlen; 413extern struct ifnet loif[]; 414extern int if_index; 415extern struct ifaddr **ifnet_addrs; 416 417void ether_ifattach __P((struct ifnet *)); 418void ether_input __P((struct ifnet *, struct ether_header *, struct mbuf *)); 419int ether_output __P((struct ifnet *, 420 struct mbuf *, struct sockaddr *, struct rtentry *)); 421void ether_ioctl __P((struct ifnet *, int , caddr_t )); 422 423void if_attach __P((struct ifnet *)); 424void if_down __P((struct ifnet *)); 425void if_up __P((struct ifnet *)); 426#ifdef vax 427void ifubareset __P((int)); 428#endif 429/*void ifinit __P((void));*/ /* declared in systm.h for main() */ 430int ifioctl __P((struct socket *, int, caddr_t, struct proc *)); 431int ifpromisc __P((struct ifnet *, int)); 432struct ifnet *ifunit __P((char *)); 433 434int if_poll_recv_slow __P((struct ifnet *ifp, int *quotap)); 435void if_poll_xmit_slow __P((struct ifnet *ifp, int *quotap)); 436void if_poll_throttle __P((void)); 437void if_poll_unthrottle __P((void *)); 438void if_poll_init __P((void)); 439void if_poll __P((void)); 440 441struct ifaddr *ifa_ifwithaddr __P((struct sockaddr *)); 442struct ifaddr *ifa_ifwithdstaddr __P((struct sockaddr *)); 443struct ifaddr *ifa_ifwithnet __P((struct sockaddr *)); 444struct ifaddr *ifa_ifwithroute __P((int, struct sockaddr *, 445 struct sockaddr *)); 446struct ifaddr *ifaof_ifpforaddr __P((struct sockaddr *, struct ifnet *)); 447void ifafree __P((struct ifaddr *)); 448 449int looutput __P((struct ifnet *, 450 struct mbuf *, struct sockaddr *, struct rtentry *)); 451#endif /* KERNEL */ 452 453#endif /* !_NET_IF_H_ */ 454