1 /* $NetBSD: if.h,v 1.28 1997/04/08 21:29:26 chuck Exp $ */ 2 3 /* 4 * Copyright (c) 1982, 1986, 1989, 1993 5 * The Regents of the University of California. All rights reserved. 6 * 7 * Redistribution and use in source and binary forms, with or without 8 * modification, are permitted provided that the following conditions 9 * are met: 10 * 1. Redistributions of source code must retain the above copyright 11 * notice, this list of conditions and the following disclaimer. 12 * 2. Redistributions in binary form must reproduce the above copyright 13 * notice, this list of conditions and the following disclaimer in the 14 * documentation and/or other materials provided with the distribution. 15 * 3. All advertising materials mentioning features or use of this software 16 * must display the following acknowledgement: 17 * This product includes software developed by the University of 18 * California, Berkeley and its contributors. 19 * 4. Neither the name of the University nor the names of its contributors 20 * may be used to endorse or promote products derived from this software 21 * without specific prior written permission. 22 * 23 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 24 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 25 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 26 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 27 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 28 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 29 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 30 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 31 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 32 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 33 * SUCH DAMAGE. 34 * 35 * @(#)if.h 8.1 (Berkeley) 6/10/93 36 */ 37 38 #ifndef _NET_IF_H_ 39 #define _NET_IF_H_ 40 41 #include <sys/queue.h> 42 43 /* 44 * Structures defining a network interface, providing a packet 45 * transport mechanism (ala level 0 of the PUP protocols). 46 * 47 * Each interface accepts output datagrams of a specified maximum 48 * length, and provides higher level routines with input datagrams 49 * received from its medium. 50 * 51 * Output occurs when the routine if_output is called, with four parameters: 52 * (*ifp->if_output)(ifp, m, dst, rt) 53 * Here m is the mbuf chain to be sent and dst is the destination address. 54 * The output routine encapsulates the supplied datagram if necessary, 55 * and then transmits it on its medium. 56 * 57 * On input, each interface unwraps the data received by it, and either 58 * places it on the input queue of a internetwork datagram routine 59 * and posts the associated software interrupt, or passes the datagram to a raw 60 * packet input routine. 61 * 62 * Routines exist for locating interfaces by their addresses 63 * or for locating a interface on a certain network, as well as more general 64 * routing and gateway routines maintaining information used to locate 65 * interfaces. These routines live in the files if.c and route.c 66 */ 67 /* XXX fast fix for SNMP, going away soon */ 68 #include <sys/time.h> 69 70 struct mbuf; 71 struct proc; 72 struct rtentry; 73 struct socket; 74 struct ether_header; 75 76 /* 77 * Structure defining statistics and other data kept regarding a network 78 * interface. 79 */ 80 struct if_data { 81 /* generic interface information */ 82 u_char ifi_type; /* ethernet, tokenring, etc. */ 83 u_char ifi_addrlen; /* media address length */ 84 u_char ifi_hdrlen; /* media header length */ 85 u_long ifi_mtu; /* maximum transmission unit */ 86 u_long ifi_metric; /* routing metric (external only) */ 87 u_long ifi_baudrate; /* linespeed */ 88 /* volatile statistics */ 89 u_long ifi_ipackets; /* packets received on interface */ 90 u_long ifi_ierrors; /* input errors on interface */ 91 u_long ifi_opackets; /* packets sent on interface */ 92 u_long ifi_oerrors; /* output errors on interface */ 93 u_long ifi_collisions; /* collisions on csma interfaces */ 94 u_long ifi_ibytes; /* total number of octets received */ 95 u_long ifi_obytes; /* total number of octets sent */ 96 u_long ifi_imcasts; /* packets received via multicast */ 97 u_long ifi_omcasts; /* packets sent via multicast */ 98 u_long ifi_iqdrops; /* dropped on input, this interface */ 99 u_long ifi_noproto; /* destined for unsupported protocol */ 100 struct timeval ifi_lastchange; /* last updated */ 101 }; 102 103 /* 104 * Structure defining a queue for a network interface. 105 * 106 * (Would like to call this struct ``if'', but C isn't PL/1.) 107 */ 108 TAILQ_HEAD(ifnet_head, ifnet); /* the actual queue head */ 109 110 /* 111 * Length of interface external name, including terminating '\0'. 112 * Note: this is the same size as a generic device's external name. 113 */ 114 #define IFNAMSIZ 16 115 116 struct 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 u_short if_index; /* numeric abbreviation for this if */ 124 short if_timer; /* time 'til if_watchdog called */ 125 short if_flags; /* up/down, broadcast, etc. */ 126 short if__pad1; /* be nice to m68k ports */ 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 sockaddr_dl *if_sadl; /* pointer to our sockaddr_dl */ 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 */ 233 struct 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 short 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 * Message format for use in obtaining information about interfaces 250 * from sysctl and the routing socket. 251 */ 252 struct if_msghdr { 253 u_short ifm_msglen; /* to skip over non-understood messages */ 254 u_char ifm_version; /* future binary compatability */ 255 u_char ifm_type; /* message type */ 256 int ifm_addrs; /* like rtm_addrs */ 257 int ifm_flags; /* value of if_flags */ 258 u_short ifm_index; /* index for associated ifp */ 259 struct if_data ifm_data;/* statistics and other data about if */ 260 }; 261 262 /* 263 * Message format for use in obtaining information about interface addresses 264 * from sysctl and the routing socket. 265 */ 266 struct ifa_msghdr { 267 u_short ifam_msglen; /* to skip over non-understood messages */ 268 u_char ifam_version; /* future binary compatability */ 269 u_char ifam_type; /* message type */ 270 int ifam_addrs; /* like rtm_addrs */ 271 int ifam_flags; /* value of ifa_flags */ 272 u_short ifam_index; /* index for associated ifp */ 273 int ifam_metric; /* value of ifa_metric */ 274 }; 275 276 /* 277 * Interface request structure used for socket 278 * ioctl's. All interface ioctl's must have parameter 279 * definitions which begin with ifr_name. The 280 * remainder may be interface specific. 281 */ 282 struct ifreq { 283 char ifr_name[IFNAMSIZ]; /* if name, e.g. "en0" */ 284 union { 285 struct sockaddr ifru_addr; 286 struct sockaddr ifru_dstaddr; 287 struct sockaddr ifru_broadaddr; 288 short ifru_flags; 289 int ifru_metric; 290 int ifru_mtu; 291 caddr_t ifru_data; 292 } ifr_ifru; 293 #define ifr_addr ifr_ifru.ifru_addr /* address */ 294 #define ifr_dstaddr ifr_ifru.ifru_dstaddr /* other end of p-to-p link */ 295 #define ifr_broadaddr ifr_ifru.ifru_broadaddr /* broadcast address */ 296 #define ifr_flags ifr_ifru.ifru_flags /* flags */ 297 #define ifr_metric ifr_ifru.ifru_metric /* metric */ 298 #define ifr_mtu ifr_ifru.ifru_mtu /* mtu */ 299 #define ifr_media ifr_ifru.ifru_metric /* media options (overload) */ 300 #define ifr_data ifr_ifru.ifru_data /* for use by interface */ 301 }; 302 303 struct ifaliasreq { 304 char ifra_name[IFNAMSIZ]; /* if name, e.g. "en0" */ 305 struct sockaddr ifra_addr; 306 struct sockaddr ifra_dstaddr; 307 #define ifra_broadaddr ifra_dstaddr 308 struct sockaddr ifra_mask; 309 }; 310 311 struct ifmediareq { 312 char ifm_name[IFNAMSIZ]; /* if name, e.g. "en0" */ 313 int ifm_current; /* current media options */ 314 int ifm_mask; /* don't care mask */ 315 int ifm_status; /* media status */ 316 int ifm_active; /* active options */ 317 int ifm_count; /* # entries in ifm_ulist 318 array */ 319 int *ifm_ulist; /* media words */ 320 }; 321 322 /* 323 * Structure used in SIOCGIFCONF request. 324 * Used to retrieve interface configuration 325 * for machine (useful for programs which 326 * must know all networks accessible). 327 */ 328 struct ifconf { 329 int ifc_len; /* size of associated buffer */ 330 union { 331 caddr_t ifcu_buf; 332 struct ifreq *ifcu_req; 333 } ifc_ifcu; 334 #define ifc_buf ifc_ifcu.ifcu_buf /* buffer address */ 335 #define ifc_req ifc_ifcu.ifcu_req /* array of structures returned */ 336 }; 337 338 #include <net/if_arp.h> 339 340 #ifdef _KERNEL 341 #define IFAFREE(ifa) \ 342 if ((ifa)->ifa_refcnt <= 0) \ 343 ifafree(ifa); \ 344 else \ 345 (ifa)->ifa_refcnt--; 346 347 struct ifnet_head ifnet; 348 349 void ether_ifattach __P((struct ifnet *, u_int8_t *)); 350 void ether_input __P((struct ifnet *, struct ether_header *, struct mbuf *)); 351 int ether_output __P((struct ifnet *, 352 struct mbuf *, struct sockaddr *, struct rtentry *)); 353 char *ether_sprintf __P((u_char *)); 354 355 void if_attach __P((struct ifnet *)); 356 void if_down __P((struct ifnet *)); 357 void if_qflush __P((struct ifqueue *)); 358 void if_slowtimo __P((void *)); 359 void if_up __P((struct ifnet *)); 360 int ifconf __P((u_long, caddr_t)); 361 void ifinit __P((void)); 362 int ifioctl __P((struct socket *, u_long, caddr_t, struct proc *)); 363 int ifpromisc __P((struct ifnet *, int)); 364 struct ifnet *ifunit __P((char *)); 365 366 struct ifaddr *ifa_ifwithaddr __P((struct sockaddr *)); 367 struct ifaddr *ifa_ifwithaf __P((int)); 368 struct ifaddr *ifa_ifwithdstaddr __P((struct sockaddr *)); 369 struct ifaddr *ifa_ifwithnet __P((struct sockaddr *)); 370 struct ifaddr *ifa_ifwithladdr __P((struct sockaddr *)); 371 struct ifaddr *ifa_ifwithroute __P((int, struct sockaddr *, 372 struct sockaddr *)); 373 struct ifaddr *ifaof_ifpforaddr __P((struct sockaddr *, struct ifnet *)); 374 void ifafree __P((struct ifaddr *)); 375 void link_rtrequest __P((int, struct rtentry *, struct sockaddr *)); 376 377 int loioctl __P((struct ifnet *, u_long, caddr_t)); 378 void loopattach __P((int)); 379 int looutput __P((struct ifnet *, 380 struct mbuf *, struct sockaddr *, struct rtentry *)); 381 void lortrequest __P((int, struct rtentry *, struct sockaddr *)); 382 #endif /* _KERNEL */ 383 #endif /* !_NET_IF_H_ */ 384