if.h revision 1.15
1/* $OpenBSD: if.h,v 1.15 2000/02/02 17:14:36 itojun Exp $ */ 2/* $NetBSD: if.h,v 1.23 1996/05/07 02:40:27 thorpej Exp $ */ 3 4/* 5 * Copyright (c) 1982, 1986, 1989, 1993 6 * The Regents of the University of California. All rights reserved. 7 * 8 * Redistribution and use in source and binary forms, with or without 9 * modification, are permitted provided that the following conditions 10 * are met: 11 * 1. Redistributions of source code must retain the above copyright 12 * notice, this list of conditions and the following disclaimer. 13 * 2. Redistributions in binary form must reproduce the above copyright 14 * notice, this list of conditions and the following disclaimer in the 15 * documentation and/or other materials provided with the distribution. 16 * 3. All advertising materials mentioning features or use of this software 17 * must display the following acknowledgement: 18 * This product includes software developed by the University of 19 * California, Berkeley and its contributors. 20 * 4. Neither the name of the University nor the names of its contributors 21 * may be used to endorse or promote products derived from this software 22 * without specific prior written permission. 23 * 24 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 25 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 27 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 28 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 29 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 30 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 31 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 32 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 33 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 34 * SUCH DAMAGE. 35 * 36 * @(#)if.h 8.1 (Berkeley) 6/10/93 37 */ 38 39#include <sys/queue.h> 40 41/* 42 * Structures defining a network interface, providing a packet 43 * transport mechanism (ala level 0 of the PUP protocols). 44 * 45 * Each interface accepts output datagrams of a specified maximum 46 * length, and provides higher level routines with input datagrams 47 * received from its medium. 48 * 49 * Output occurs when the routine if_output is called, with four parameters: 50 * (*ifp->if_output)(ifp, m, dst, rt) 51 * Here m is the mbuf chain to be sent and dst is the destination address. 52 * The output routine encapsulates the supplied datagram if necessary, 53 * and then transmits it on its medium. 54 * 55 * On input, each interface unwraps the data received by it, and either 56 * places it on the input queue of a internetwork datagram routine 57 * and posts the associated software interrupt, or passes the datagram to a raw 58 * packet input routine. 59 * 60 * Routines exist for locating interfaces by their addresses 61 * or for locating a interface on a certain network, as well as more general 62 * routing and gateway routines maintaining information used to locate 63 * interfaces. These routines live in the files if.c and route.c 64 */ 65/* XXX fast fix for SNMP, going away soon */ 66#include <sys/time.h> 67 68struct mbuf; 69struct proc; 70struct rtentry; 71struct socket; 72struct ether_header; 73struct arpcom; 74 75/* 76 * Structure defining statistics and other data kept regarding a network 77 * interface. 78 */ 79struct if_data { 80 /* generic interface information */ 81 u_char ifi_type; /* ethernet, tokenring, etc. */ 82 u_char ifi_addrlen; /* media address length */ 83 u_char ifi_hdrlen; /* media header length */ 84 u_long ifi_mtu; /* maximum transmission unit */ 85 u_long ifi_metric; /* routing metric (external only) */ 86 u_long ifi_baudrate; /* linespeed */ 87 /* volatile statistics */ 88 u_long ifi_ipackets; /* packets received on interface */ 89 u_long ifi_ierrors; /* input errors on interface */ 90 u_long ifi_opackets; /* packets sent on interface */ 91 u_long ifi_oerrors; /* output errors on interface */ 92 u_long ifi_collisions; /* collisions on csma interfaces */ 93 u_long ifi_ibytes; /* total number of octets received */ 94 u_long ifi_obytes; /* total number of octets sent */ 95 u_long ifi_imcasts; /* packets received via multicast */ 96 u_long ifi_omcasts; /* packets sent via multicast */ 97 u_long ifi_iqdrops; /* dropped on input, this interface */ 98 u_long ifi_noproto; /* destined for unsupported protocol */ 99 struct timeval ifi_lastchange; /* last updated */ 100}; 101 102/* 103 * Structure defining a queue for a network interface. 104 * 105 * (Would like to call this struct ``if'', but C isn't PL/1.) 106 */ 107TAILQ_HEAD(ifnet_head, ifnet); /* the actual queue head */ 108 109/* 110 * Length of interface external name, including terminating '\0'. 111 * Note: this is the same size as a generic device's external name. 112 */ 113#define IFNAMSIZ 16 114#define IF_NAMESIZE IFNAMSIZ 115 116struct ifnet { /* and the entries */ 117 void *if_softc; /* lower-level data for this if */ 118 TAILQ_ENTRY(ifnet) if_list; /* all struct ifnets are chained */ 119 TAILQ_HEAD(, ifaddr) if_addrlist; /* linked list of addresses per if */ 120 char if_xname[IFNAMSIZ]; /* external name (name + unit) */ 121 int if_pcount; /* number of promiscuous listeners */ 122 caddr_t if_bpf; /* packet filter structure */ 123 caddr_t if_bridge; /* bridge structure */ 124 u_short if_index; /* numeric abbreviation for this if */ 125 short if_timer; /* time 'til if_watchdog called */ 126 short if_flags; /* up/down, broadcast, etc. */ 127 struct if_data if_data; /* statistics and other data about if */ 128/* procedure handles */ 129 int (*if_output) /* output routine (enqueue) */ 130 __P((struct ifnet *, struct mbuf *, struct sockaddr *, 131 struct rtentry *)); 132 void (*if_start) /* initiate output routine */ 133 __P((struct ifnet *)); 134 int (*if_ioctl) /* ioctl routine */ 135 __P((struct ifnet *, u_long, caddr_t)); 136 int (*if_reset) /* XXX bus reset routine */ 137 __P((struct ifnet *)); 138 void (*if_watchdog) /* timer routine */ 139 __P((struct ifnet *)); 140 struct ifqueue { 141 struct mbuf *ifq_head; 142 struct mbuf *ifq_tail; 143 int ifq_len; 144 int ifq_maxlen; 145 int ifq_drops; 146 } if_snd; /* output queue */ 147 struct ifprefix *if_prefixlist; /* linked list of prefixes per if */ 148}; 149#define if_mtu if_data.ifi_mtu 150#define if_type if_data.ifi_type 151#define if_addrlen if_data.ifi_addrlen 152#define if_hdrlen if_data.ifi_hdrlen 153#define if_metric if_data.ifi_metric 154#define if_baudrate if_data.ifi_baudrate 155#define if_ipackets if_data.ifi_ipackets 156#define if_ierrors if_data.ifi_ierrors 157#define if_opackets if_data.ifi_opackets 158#define if_oerrors if_data.ifi_oerrors 159#define if_collisions if_data.ifi_collisions 160#define if_ibytes if_data.ifi_ibytes 161#define if_obytes if_data.ifi_obytes 162#define if_imcasts if_data.ifi_imcasts 163#define if_omcasts if_data.ifi_omcasts 164#define if_iqdrops if_data.ifi_iqdrops 165#define if_noproto if_data.ifi_noproto 166#define if_lastchange if_data.ifi_lastchange 167 168#define IFF_UP 0x1 /* interface is up */ 169#define IFF_BROADCAST 0x2 /* broadcast address valid */ 170#define IFF_DEBUG 0x4 /* turn on debugging */ 171#define IFF_LOOPBACK 0x8 /* is a loopback net */ 172#define IFF_POINTOPOINT 0x10 /* interface is point-to-point link */ 173#define IFF_NOTRAILERS 0x20 /* avoid use of trailers */ 174#define IFF_RUNNING 0x40 /* resources allocated */ 175#define IFF_NOARP 0x80 /* no address resolution protocol */ 176#define IFF_PROMISC 0x100 /* receive all packets */ 177#define IFF_ALLMULTI 0x200 /* receive all multicast packets */ 178#define IFF_OACTIVE 0x400 /* transmission in progress */ 179#define IFF_SIMPLEX 0x800 /* can't hear own transmissions */ 180#define IFF_LINK0 0x1000 /* per link layer defined bit */ 181#define IFF_LINK1 0x2000 /* per link layer defined bit */ 182#define IFF_LINK2 0x4000 /* per link layer defined bit */ 183#define IFF_MULTICAST 0x8000 /* supports multicast */ 184 185/* flags set internally only: */ 186#define IFF_CANTCHANGE \ 187 (IFF_BROADCAST|IFF_POINTOPOINT|IFF_RUNNING|IFF_OACTIVE|\ 188 IFF_SIMPLEX|IFF_MULTICAST|IFF_ALLMULTI) 189 190/* 191 * Output queues (ifp->if_snd) and internetwork datagram level (pup level 1) 192 * input routines have queues of messages stored on ifqueue structures 193 * (defined above). Entries are added to and deleted from these structures 194 * by these macros, which should be called with ipl raised to splimp(). 195 */ 196#define IF_QFULL(ifq) ((ifq)->ifq_len >= (ifq)->ifq_maxlen) 197#define IF_DROP(ifq) ((ifq)->ifq_drops++) 198#define IF_ENQUEUE(ifq, m) { \ 199 (m)->m_nextpkt = 0; \ 200 if ((ifq)->ifq_tail == 0) \ 201 (ifq)->ifq_head = m; \ 202 else \ 203 (ifq)->ifq_tail->m_nextpkt = m; \ 204 (ifq)->ifq_tail = m; \ 205 (ifq)->ifq_len++; \ 206} 207#define IF_PREPEND(ifq, m) { \ 208 (m)->m_nextpkt = (ifq)->ifq_head; \ 209 if ((ifq)->ifq_tail == 0) \ 210 (ifq)->ifq_tail = (m); \ 211 (ifq)->ifq_head = (m); \ 212 (ifq)->ifq_len++; \ 213} 214#define IF_DEQUEUE(ifq, m) { \ 215 (m) = (ifq)->ifq_head; \ 216 if (m) { \ 217 if (((ifq)->ifq_head = (m)->m_nextpkt) == 0) \ 218 (ifq)->ifq_tail = 0; \ 219 (m)->m_nextpkt = 0; \ 220 (ifq)->ifq_len--; \ 221 } \ 222} 223 224#define IFQ_MAXLEN 50 225#define IFNET_SLOWHZ 1 /* granularity is 1 second */ 226 227/* 228 * The ifaddr structure contains information about one address 229 * of an interface. They are maintained by the different address families, 230 * are allocated and attached when an address is set, and are linked 231 * together so all addresses for an interface can be located. 232 */ 233struct ifaddr { 234 struct sockaddr *ifa_addr; /* address of interface */ 235 struct sockaddr *ifa_dstaddr; /* other end of p-to-p link */ 236#define ifa_broadaddr ifa_dstaddr /* broadcast address interface */ 237 struct sockaddr *ifa_netmask; /* used to determine subnet */ 238 struct ifnet *ifa_ifp; /* back-pointer to interface */ 239 TAILQ_ENTRY(ifaddr) ifa_list; /* list of addresses for interface */ 240 void (*ifa_rtrequest) /* check or clean routes (+ or -)'d */ 241 __P((int, struct rtentry *, struct sockaddr *)); 242 u_short ifa_flags; /* mostly rt_flags for cloning */ 243 u_int ifa_refcnt; /* count of references */ 244 int ifa_metric; /* cost of going out this interface */ 245}; 246#define IFA_ROUTE RTF_UP /* route installed */ 247 248/* 249 * The prefix structure contains information about one prefix 250 * of an interface. They are maintained by the different address families, 251 * are allocated and attached when an prefix or an address is set, 252 * and are linked together so all prfefixes for an interface can be located. 253 */ 254struct ifprefix { 255 struct sockaddr *ifpr_prefix; /* prefix of interface */ 256 struct ifnet *ifpr_ifp; /* back-pointer to interface */ 257 struct ifprefix *ifpr_next; 258 u_char ifpr_plen; /* prefix length in bits */ 259 u_char ifpr_type; /* protocol dependent prefix type */ 260}; 261 262/* 263 * Message format for use in obtaining information about interfaces 264 * from sysctl and the routing socket. 265 */ 266struct if_msghdr { 267 u_short ifm_msglen; /* to skip over non-understood messages */ 268 u_char ifm_version; /* future binary compatability */ 269 u_char ifm_type; /* message type */ 270 int ifm_addrs; /* like rtm_addrs */ 271 int ifm_flags; /* value of if_flags */ 272 u_short ifm_index; /* index for associated ifp */ 273 struct if_data ifm_data;/* statistics and other data about if */ 274}; 275 276/* 277 * Message format for use in obtaining information about interface addresses 278 * from sysctl and the routing socket. 279 */ 280struct ifa_msghdr { 281 u_short ifam_msglen; /* to skip over non-understood messages */ 282 u_char ifam_version; /* future binary compatability */ 283 u_char ifam_type; /* message type */ 284 int ifam_addrs; /* like rtm_addrs */ 285 int ifam_flags; /* value of ifa_flags */ 286 u_short ifam_index; /* index for associated ifp */ 287 int ifam_metric; /* value of ifa_metric */ 288}; 289 290/* 291 * Interface request structure used for socket 292 * ioctl's. All interface ioctl's must have parameter 293 * definitions which begin with ifr_name. The 294 * remainder may be interface specific. 295 */ 296struct ifreq { 297 char ifr_name[IFNAMSIZ]; /* if name, e.g. "en0" */ 298 union { 299 struct sockaddr ifru_addr; 300 struct sockaddr ifru_dstaddr; 301 struct sockaddr ifru_broadaddr; 302 short ifru_flags; 303 int ifru_metric; 304 caddr_t ifru_data; 305 } ifr_ifru; 306#define ifr_addr ifr_ifru.ifru_addr /* address */ 307#define ifr_dstaddr ifr_ifru.ifru_dstaddr /* other end of p-to-p link */ 308#define ifr_broadaddr ifr_ifru.ifru_broadaddr /* broadcast address */ 309#define ifr_flags ifr_ifru.ifru_flags /* flags */ 310#define ifr_metric ifr_ifru.ifru_metric /* metric */ 311#define ifr_media ifr_ifru.ifru_metric /* media options (overload) */ 312#define ifr_data ifr_ifru.ifru_data /* for use by interface */ 313}; 314 315struct ifaliasreq { 316 char ifra_name[IFNAMSIZ]; /* if name, e.g. "en0" */ 317 struct sockaddr ifra_addr; 318 struct sockaddr ifra_dstaddr; 319#define ifra_broadaddr ifra_dstaddr 320 struct sockaddr ifra_mask; 321}; 322 323struct ifmediareq { 324 char ifm_name[IFNAMSIZ]; /* if name, e.g. "en0" */ 325 int ifm_current; /* current media options */ 326 int ifm_mask; /* don't care mask */ 327 int ifm_status; /* media status */ 328 int ifm_active; /* active options */ 329 int ifm_count; /* # entries in ifm_ulist 330 array */ 331 int *ifm_ulist; /* media words */ 332}; 333 334/* 335 * Structure used in SIOCGIFCONF request. 336 * Used to retrieve interface configuration 337 * for machine (useful for programs which 338 * must know all networks accessible). 339 */ 340struct ifconf { 341 int ifc_len; /* size of associated buffer */ 342 union { 343 caddr_t ifcu_buf; 344 struct ifreq *ifcu_req; 345 } ifc_ifcu; 346#define ifc_buf ifc_ifcu.ifcu_buf /* buffer address */ 347#define ifc_req ifc_ifcu.ifcu_req /* array of structures returned */ 348}; 349 350/* 351 * Structure for SIOC[AGD]LIFADDR 352 */ 353struct if_laddrreq { 354 char iflr_name[IFNAMSIZ]; 355 unsigned int flags; 356#define IFLR_PREFIX 0x8000 /* in: prefix given out: kernel fills id */ 357 unsigned int prefixlen; /* in/out */ 358 struct sockaddr_storage addr; /* in/out */ 359 struct sockaddr_storage dstaddr; /* out */ 360}; 361 362struct if_nameindex { 363 unsigned int if_index; 364 char *if_name; 365}; 366 367#ifndef _KERNEL 368__BEGIN_DECLS 369unsigned int if_nametoindex __P((const char *)); 370char *if_indextoname __P((unsigned int, char *)); 371struct if_nameindex *if_nameindex __P((void)); 372__END_DECLS 373#define if_freenameindex(x) free(x) 374#endif 375 376#include <net/if_arp.h> 377 378#ifdef _KERNEL 379#define IFAFREE(ifa) \ 380do { \ 381 if ((ifa)->ifa_refcnt <= 0) \ 382 ifafree(ifa); \ 383 else \ 384 (ifa)->ifa_refcnt--; \ 385} while (0) 386 387struct ifnet_head ifnet; 388struct ifnet **ifindex2ifnet; 389#if 0 390struct ifnet loif[]; 391#endif 392int if_index; 393 394void ether_ifattach __P((struct ifnet *)); 395void ether_ifdetach __P((struct ifnet *)); 396int ether_ioctl __P((struct ifnet *, struct arpcom *, u_long, caddr_t)); 397void ether_input __P((struct ifnet *, struct ether_header *, struct mbuf *)); 398int ether_output __P((struct ifnet *, 399 struct mbuf *, struct sockaddr *, struct rtentry *)); 400char *ether_sprintf __P((u_char *)); 401 402void if_attach __P((struct ifnet *)); 403void if_attachtail __P((struct ifnet *)); 404void if_attachhead __P((struct ifnet *)); 405void if_detach __P((struct ifnet *)); 406void if_down __P((struct ifnet *)); 407void if_qflush __P((struct ifqueue *)); 408void if_slowtimo __P((void *)); 409void if_up __P((struct ifnet *)); 410int ifconf __P((u_long, caddr_t)); 411void ifinit __P((void)); 412int ifioctl __P((struct socket *, u_long, caddr_t, struct proc *)); 413int ifpromisc __P((struct ifnet *, int)); 414struct ifnet *ifunit __P((char *)); 415struct ifnet *if_withname __P((struct sockaddr *)); 416 417struct ifaddr *ifa_ifwithaddr __P((struct sockaddr *)); 418struct ifaddr *ifa_ifwithaf __P((int)); 419struct ifaddr *ifa_ifwithdstaddr __P((struct sockaddr *)); 420struct ifaddr *ifa_ifwithnet __P((struct sockaddr *)); 421struct ifaddr *ifa_ifwithroute __P((int, struct sockaddr *, 422 struct sockaddr *)); 423struct ifaddr *ifaof_ifpforaddr __P((struct sockaddr *, struct ifnet *)); 424void ifafree __P((struct ifaddr *)); 425void link_rtrequest __P((int, struct rtentry *, struct sockaddr *)); 426 427int loioctl __P((struct ifnet *, u_long, caddr_t)); 428void loopattach __P((int)); 429int looutput __P((struct ifnet *, 430 struct mbuf *, struct sockaddr *, struct rtentry *)); 431void lortrequest __P((int, struct rtentry *, struct sockaddr *)); 432#endif /* _KERNEL */ 433