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