if.h revision 1941
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.3 1994/08/02 07:46:07 davidg Exp $ 35 */ 36 37/* 38 * Structures defining a network interface, providing a packet 39 * transport mechanism (ala level 0 of the PUP protocols). 40 * 41 * Each interface accepts output datagrams of a specified maximum 42 * length, and provides higher level routines with input datagrams 43 * received from its medium. 44 * 45 * Output occurs when the routine if_output is called, with three parameters: 46 * (*ifp->if_output)(ifp, m, dst, rt) 47 * Here m is the mbuf chain to be sent and dst is the destination address. 48 * The output routine encapsulates the supplied datagram if necessary, 49 * and then transmits it on its medium. 50 * 51 * On input, each interface unwraps the data received by it, and either 52 * places it on the input queue of a internetwork datagram routine 53 * and posts the associated software interrupt, or passes the datagram to a raw 54 * packet input routine. 55 * 56 * Routines exist for locating interfaces by their addresses 57 * or for locating a interface on a certain network, as well as more general 58 * routing and gateway routines maintaining information used to locate 59 * interfaces. These routines live in the files if.c and route.c 60 */ 61#ifndef _TIME_ /* XXX fast fix for SNMP, going away soon */ 62#include <sys/time.h> 63#endif 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 * Structure describing information about an interface 77 * which may be of interest to management entities. 78 */ 79/* 80 * Structure defining a queue for a network interface. 81 * 82 * (Would like to call this struct ``if'', but C isn't PL/1.) 83 */ 84 85struct ifnet { 86 char *if_name; /* name, e.g. ``en'' or ``lo'' */ 87 struct ifnet *if_next; /* all struct ifnets are chained */ 88 struct ifaddr *if_addrlist; /* linked list of addresses per if */ 89 int if_pcount; /* number of promiscuous listeners */ 90 caddr_t if_bpf; /* packet filter structure */ 91 u_short if_index; /* numeric abbreviation for this if */ 92 short if_unit; /* sub-unit for lower level driver */ 93 short if_timer; /* time 'til if_watchdog called */ 94 short if_flags; /* up/down, broadcast, etc. */ 95 struct if_data { 96/* generic interface information */ 97 u_char ifi_type; /* ethernet, tokenring, etc */ 98 u_char ifi_addrlen; /* media address length */ 99 u_char ifi_hdrlen; /* media header length */ 100 u_long ifi_mtu; /* maximum transmission unit */ 101 u_long ifi_metric; /* routing metric (external only) */ 102 u_long ifi_baudrate; /* linespeed */ 103/* volatile statistics */ 104 u_long ifi_ipackets; /* packets received on interface */ 105 u_long ifi_ierrors; /* input errors on interface */ 106 u_long ifi_opackets; /* packets sent on interface */ 107 u_long ifi_oerrors; /* output errors on interface */ 108 u_long ifi_collisions; /* collisions on csma interfaces */ 109 u_long ifi_ibytes; /* total number of octets received */ 110 u_long ifi_obytes; /* total number of octets sent */ 111 u_long ifi_imcasts; /* packets received via multicast */ 112 u_long ifi_omcasts; /* packets sent via multicast */ 113 u_long ifi_iqdrops; /* dropped on input, this interface */ 114 u_long ifi_noproto; /* destined for unsupported protocol */ 115 struct timeval ifi_lastchange;/* last updated */ 116 } if_data; 117/* procedure handles */ 118 void (*if_init) /* init routine */ 119 __P((int)); 120 int (*if_output) /* output routine (enqueue) */ 121 __P((struct ifnet *, struct mbuf *, struct sockaddr *, 122 struct rtentry *)); 123 void (*if_start) /* initiate output routine */ 124 __P((struct ifnet *)); 125 int (*if_done) /* output complete routine */ 126 __P((struct ifnet *)); /* (XXX not used; fake prototype) */ 127 int (*if_ioctl) /* ioctl routine */ 128 __P((struct ifnet *, int, caddr_t)); 129 void (*if_reset) 130 __P((int)); /* new autoconfig will permit removal */ 131 void (*if_watchdog) /* timer routine */ 132 __P((int)); 133 struct ifqueue { 134 struct mbuf *ifq_head; 135 struct mbuf *ifq_tail; 136 int ifq_len; 137 int ifq_maxlen; 138 int ifq_drops; 139 } if_snd; /* output queue */ 140}; 141#define if_mtu if_data.ifi_mtu 142#define if_type if_data.ifi_type 143#define if_addrlen if_data.ifi_addrlen 144#define if_hdrlen if_data.ifi_hdrlen 145#define if_metric if_data.ifi_metric 146#define if_baudrate if_data.ifi_baudrate 147#define if_ipackets if_data.ifi_ipackets 148#define if_ierrors if_data.ifi_ierrors 149#define if_opackets if_data.ifi_opackets 150#define if_oerrors if_data.ifi_oerrors 151#define if_collisions if_data.ifi_collisions 152#define if_ibytes if_data.ifi_ibytes 153#define if_obytes if_data.ifi_obytes 154#define if_imcasts if_data.ifi_imcasts 155#define if_omcasts if_data.ifi_omcasts 156#define if_iqdrops if_data.ifi_iqdrops 157#define if_noproto if_data.ifi_noproto 158#define if_lastchange if_data.ifi_lastchange 159 160#define IFF_UP 0x1 /* interface is up */ 161#define IFF_BROADCAST 0x2 /* broadcast address valid */ 162#define IFF_DEBUG 0x4 /* turn on debugging */ 163#define IFF_LOOPBACK 0x8 /* is a loopback net */ 164#define IFF_POINTOPOINT 0x10 /* interface is point-to-point link */ 165#define IFF_NOTRAILERS 0x20 /* avoid use of trailers */ 166#define IFF_RUNNING 0x40 /* resources allocated */ 167#define IFF_NOARP 0x80 /* no address resolution protocol */ 168#define IFF_PROMISC 0x100 /* receive all packets */ 169#define IFF_ALLMULTI 0x200 /* receive all multicast packets */ 170#define IFF_OACTIVE 0x400 /* transmission in progress */ 171#define IFF_SIMPLEX 0x800 /* can't hear own transmissions */ 172#define IFF_LINK0 0x1000 /* per link layer defined bit */ 173#define IFF_LINK1 0x2000 /* per link layer defined bit */ 174#define IFF_LINK2 0x4000 /* per link layer defined bit */ 175#define IFF_MULTICAST 0x8000 /* supports multicast */ 176 177/* flags set internally only: */ 178#define IFF_CANTCHANGE \ 179 (IFF_BROADCAST|IFF_POINTOPOINT|IFF_RUNNING|IFF_OACTIVE|\ 180 IFF_SIMPLEX|IFF_MULTICAST|IFF_ALLMULTI) 181 182/* 183 * Output queues (ifp->if_snd) and internetwork datagram level (pup level 1) 184 * input routines have queues of messages stored on ifqueue structures 185 * (defined above). Entries are added to and deleted from these structures 186 * by these macros, which should be called with ipl raised to splimp(). 187 */ 188#define IF_QFULL(ifq) ((ifq)->ifq_len >= (ifq)->ifq_maxlen) 189#define IF_DROP(ifq) ((ifq)->ifq_drops++) 190#define IF_ENQUEUE(ifq, m) { \ 191 (m)->m_nextpkt = 0; \ 192 if ((ifq)->ifq_tail == 0) \ 193 (ifq)->ifq_head = m; \ 194 else \ 195 (ifq)->ifq_tail->m_nextpkt = m; \ 196 (ifq)->ifq_tail = m; \ 197 (ifq)->ifq_len++; \ 198} 199#define IF_PREPEND(ifq, m) { \ 200 (m)->m_nextpkt = (ifq)->ifq_head; \ 201 if ((ifq)->ifq_tail == 0) \ 202 (ifq)->ifq_tail = (m); \ 203 (ifq)->ifq_head = (m); \ 204 (ifq)->ifq_len++; \ 205} 206#define IF_DEQUEUE(ifq, m) { \ 207 (m) = (ifq)->ifq_head; \ 208 if (m) { \ 209 if (((ifq)->ifq_head = (m)->m_nextpkt) == 0) \ 210 (ifq)->ifq_tail = 0; \ 211 (m)->m_nextpkt = 0; \ 212 (ifq)->ifq_len--; \ 213 } \ 214} 215 216#define IFQ_MAXLEN 50 217#define IFNET_SLOWHZ 1 /* granularity is 1 second */ 218 219/* 220 * The ifaddr structure contains information about one address 221 * of an interface. They are maintained by the different address families, 222 * are allocated and attached when an address is set, and are linked 223 * together so all addresses for an interface can be located. 224 */ 225struct ifaddr { 226 struct sockaddr *ifa_addr; /* address of interface */ 227 struct sockaddr *ifa_dstaddr; /* other end of p-to-p link */ 228#define ifa_broadaddr ifa_dstaddr /* broadcast address interface */ 229 struct sockaddr *ifa_netmask; /* used to determine subnet */ 230 struct ifnet *ifa_ifp; /* back-pointer to interface */ 231 struct ifaddr *ifa_next; /* next address for interface */ 232 void (*ifa_rtrequest)(); /* check or clean routes (+ or -)'d */ 233 u_short ifa_flags; /* mostly rt_flags for cloning */ 234 short ifa_refcnt; /* extra to malloc for link info */ 235 int ifa_metric; /* cost of going out this interface */ 236#ifdef notdef 237 struct rtentry *ifa_rt; /* XXXX for ROUTETOIF ????? */ 238#endif 239}; 240#define IFA_ROUTE RTF_UP /* route installed */ 241 242/* 243 * Message format for use in obtaining information about interfaces 244 * from getkerninfo and the routing socket 245 */ 246struct if_msghdr { 247 u_short ifm_msglen; /* to skip over non-understood messages */ 248 u_char ifm_version; /* future binary compatability */ 249 u_char ifm_type; /* message type */ 250 int ifm_addrs; /* like rtm_addrs */ 251 int ifm_flags; /* value of if_flags */ 252 u_short ifm_index; /* index for associated ifp */ 253 struct if_data ifm_data;/* statistics and other data about if */ 254}; 255 256/* 257 * Message format for use in obtaining information about interface addresses 258 * from getkerninfo and the routing socket 259 */ 260struct ifa_msghdr { 261 u_short ifam_msglen; /* to skip over non-understood messages */ 262 u_char ifam_version; /* future binary compatability */ 263 u_char ifam_type; /* message type */ 264 int ifam_addrs; /* like rtm_addrs */ 265 int ifam_flags; /* value of ifa_flags */ 266 u_short ifam_index; /* index for associated ifp */ 267 int ifam_metric; /* value of ifa_metric */ 268}; 269 270/* 271 * Interface request structure used for socket 272 * ioctl's. All interface ioctl's must have parameter 273 * definitions which begin with ifr_name. The 274 * remainder may be interface specific. 275 */ 276struct ifreq { 277#define IFNAMSIZ 16 278 char ifr_name[IFNAMSIZ]; /* if name, e.g. "en0" */ 279 union { 280 struct sockaddr ifru_addr; 281 struct sockaddr ifru_dstaddr; 282 struct sockaddr ifru_broadaddr; 283 short ifru_flags; 284 int ifru_metric; 285 int ifru_mtu; 286 caddr_t ifru_data; 287 } ifr_ifru; 288#define ifr_addr ifr_ifru.ifru_addr /* address */ 289#define ifr_dstaddr ifr_ifru.ifru_dstaddr /* other end of p-to-p link */ 290#define ifr_broadaddr ifr_ifru.ifru_broadaddr /* broadcast address */ 291#define ifr_flags ifr_ifru.ifru_flags /* flags */ 292#define ifr_metric ifr_ifru.ifru_metric /* metric */ 293#define ifr_mtu ifr_ifru.ifru_mtu /* mtu */ 294#define ifr_data ifr_ifru.ifru_data /* for use by interface */ 295}; 296 297struct ifaliasreq { 298 char ifra_name[IFNAMSIZ]; /* if name, e.g. "en0" */ 299 struct sockaddr ifra_addr; 300 struct sockaddr ifra_broadaddr; 301 struct sockaddr ifra_mask; 302}; 303 304/* 305 * Structure used in SIOCGIFCONF request. 306 * Used to retrieve interface configuration 307 * for machine (useful for programs which 308 * must know all networks accessible). 309 */ 310struct ifconf { 311 int ifc_len; /* size of associated buffer */ 312 union { 313 caddr_t ifcu_buf; 314 struct ifreq *ifcu_req; 315 } ifc_ifcu; 316#define ifc_buf ifc_ifcu.ifcu_buf /* buffer address */ 317#define ifc_req ifc_ifcu.ifcu_req /* array of structures returned */ 318}; 319 320#include <net/if_arp.h> 321 322#ifdef KERNEL 323#define IFAFREE(ifa) \ 324 if ((ifa)->ifa_refcnt <= 0) \ 325 ifafree(ifa); \ 326 else \ 327 (ifa)->ifa_refcnt--; 328 329struct ifnet *ifnet; 330 331void ether_ifattach __P((struct ifnet *)); 332void ether_input __P((struct ifnet *, struct ether_header *, struct mbuf *)); 333int ether_output __P((struct ifnet *, 334 struct mbuf *, struct sockaddr *, struct rtentry *)); 335char *ether_sprintf __P((u_char *)); 336 337void if_attach __P((struct ifnet *)); 338void if_down __P((struct ifnet *)); 339void if_qflush __P((struct ifqueue *)); 340void if_slowtimo __P((void *)); 341void if_up __P((struct ifnet *)); 342#ifdef vax 343void ifubareset __P((int)); 344#endif 345int ifconf __P((int, caddr_t)); 346void ifinit __P((void)); 347int ifioctl __P((struct socket *, int, caddr_t, struct proc *)); 348int ifpromisc __P((struct ifnet *, int)); 349struct ifnet *ifunit __P((char *)); 350 351struct ifaddr *ifa_ifwithaddr __P((struct sockaddr *)); 352struct ifaddr *ifa_ifwithaf __P((int)); 353struct ifaddr *ifa_ifwithdstaddr __P((struct sockaddr *)); 354struct ifaddr *ifa_ifwithnet __P((struct sockaddr *)); 355struct ifaddr *ifa_ifwithroute __P((int, struct sockaddr *, 356 struct sockaddr *)); 357struct ifaddr *ifaof_ifpforaddr __P((struct sockaddr *, struct ifnet *)); 358void ifafree __P((struct ifaddr *)); 359void link_rtrequest __P((int, struct rtentry *, struct sockaddr *)); 360 361int loioctl __P((struct ifnet *, int, caddr_t)); 362void loopattach __P((void)); 363int looutput __P((struct ifnet *, 364 struct mbuf *, struct sockaddr *, struct rtentry *)); 365void lortrequest __P((int, struct rtentry *, struct sockaddr *)); 366#endif 367