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