1 /* $NetBSD: if.h,v 1.24 1996/06/13 21:48:34 cgd 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 #include <sys/queue.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 four 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 /* XXX fast fix for SNMP, going away soon */ 65 #include <sys/time.h> 66 67 struct mbuf; 68 struct proc; 69 struct rtentry; 70 struct socket; 71 struct ether_header; 72 73 /* 74 * Structure defining statistics and other data kept regarding a network 75 * interface. 76 */ 77 struct if_data { 78 /* generic interface information */ 79 u_char ifi_type; /* ethernet, tokenring, etc. */ 80 u_char ifi_addrlen; /* media address length */ 81 u_char ifi_hdrlen; /* media header length */ 82 u_long ifi_mtu; /* maximum transmission unit */ 83 u_long ifi_metric; /* routing metric (external only) */ 84 u_long ifi_baudrate; /* linespeed */ 85 /* volatile statistics */ 86 u_long ifi_ipackets; /* packets received on interface */ 87 u_long ifi_ierrors; /* input errors on interface */ 88 u_long ifi_opackets; /* packets sent on interface */ 89 u_long ifi_oerrors; /* output errors on interface */ 90 u_long ifi_collisions; /* collisions on csma interfaces */ 91 u_long ifi_ibytes; /* total number of octets received */ 92 u_long ifi_obytes; /* total number of octets sent */ 93 u_long ifi_imcasts; /* packets received via multicast */ 94 u_long ifi_omcasts; /* packets sent via multicast */ 95 u_long ifi_iqdrops; /* dropped on input, this interface */ 96 u_long ifi_noproto; /* destined for unsupported protocol */ 97 struct timeval ifi_lastchange; /* last updated */ 98 }; 99 100 /* 101 * Structure defining a queue for a network interface. 102 * 103 * (Would like to call this struct ``if'', but C isn't PL/1.) 104 */ 105 TAILQ_HEAD(ifnet_head, ifnet); /* the actual queue head */ 106 107 /* 108 * Length of interface external name, including terminating '\0'. 109 * Note: this is the same size as a generic device's external name. 110 */ 111 #define IFNAMSIZ 16 112 113 struct ifnet { /* and the entries */ 114 void *if_softc; /* lower-level data for this if */ 115 TAILQ_ENTRY(ifnet) if_list; /* all struct ifnets are chained */ 116 TAILQ_HEAD(, ifaddr) if_addrlist; /* linked list of addresses per if */ 117 char if_xname[IFNAMSIZ]; /* external name (name + unit) */ 118 int if_pcount; /* number of promiscuous listeners */ 119 caddr_t if_bpf; /* packet filter structure */ 120 u_short if_index; /* numeric abbreviation for this if */ 121 short if_timer; /* time 'til if_watchdog called */ 122 short if_flags; /* up/down, broadcast, etc. */ 123 struct if_data if_data; /* statistics and other data about if */ 124 /* procedure handles */ 125 int (*if_output) /* output routine (enqueue) */ 126 __P((struct ifnet *, struct mbuf *, struct sockaddr *, 127 struct rtentry *)); 128 void (*if_start) /* initiate output routine */ 129 __P((struct ifnet *)); 130 int (*if_ioctl) /* ioctl routine */ 131 __P((struct ifnet *, u_long, caddr_t)); 132 int (*if_reset) /* XXX bus reset routine */ 133 __P((struct ifnet *)); 134 void (*if_watchdog) /* timer routine */ 135 __P((struct ifnet *)); 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_MULTICAST 0x8000 /* supports multicast */ 179 180 /* flags set internally only: */ 181 #define IFF_CANTCHANGE \ 182 (IFF_BROADCAST|IFF_POINTOPOINT|IFF_RUNNING|IFF_OACTIVE|\ 183 IFF_SIMPLEX|IFF_MULTICAST|IFF_ALLMULTI) 184 185 /* 186 * Output queues (ifp->if_snd) and internetwork datagram level (pup level 1) 187 * input routines have queues of messages stored on ifqueue structures 188 * (defined above). Entries are added to and deleted from these structures 189 * by these macros, which should be called with ipl raised to splimp(). 190 */ 191 #define IF_QFULL(ifq) ((ifq)->ifq_len >= (ifq)->ifq_maxlen) 192 #define IF_DROP(ifq) ((ifq)->ifq_drops++) 193 #define IF_ENQUEUE(ifq, m) { \ 194 (m)->m_nextpkt = 0; \ 195 if ((ifq)->ifq_tail == 0) \ 196 (ifq)->ifq_head = m; \ 197 else \ 198 (ifq)->ifq_tail->m_nextpkt = m; \ 199 (ifq)->ifq_tail = m; \ 200 (ifq)->ifq_len++; \ 201 } 202 #define IF_PREPEND(ifq, m) { \ 203 (m)->m_nextpkt = (ifq)->ifq_head; \ 204 if ((ifq)->ifq_tail == 0) \ 205 (ifq)->ifq_tail = (m); \ 206 (ifq)->ifq_head = (m); \ 207 (ifq)->ifq_len++; \ 208 } 209 #define IF_DEQUEUE(ifq, m) { \ 210 (m) = (ifq)->ifq_head; \ 211 if (m) { \ 212 if (((ifq)->ifq_head = (m)->m_nextpkt) == 0) \ 213 (ifq)->ifq_tail = 0; \ 214 (m)->m_nextpkt = 0; \ 215 (ifq)->ifq_len--; \ 216 } \ 217 } 218 219 #define IFQ_MAXLEN 50 220 #define IFNET_SLOWHZ 1 /* granularity is 1 second */ 221 222 /* 223 * The ifaddr structure contains information about one address 224 * of an interface. They are maintained by the different address families, 225 * are allocated and attached when an address is set, and are linked 226 * together so all addresses for an interface can be located. 227 */ 228 struct ifaddr { 229 struct sockaddr *ifa_addr; /* address of interface */ 230 struct sockaddr *ifa_dstaddr; /* other end of p-to-p link */ 231 #define ifa_broadaddr ifa_dstaddr /* broadcast address interface */ 232 struct sockaddr *ifa_netmask; /* used to determine subnet */ 233 struct ifnet *ifa_ifp; /* back-pointer to interface */ 234 TAILQ_ENTRY(ifaddr) ifa_list; /* list of addresses for interface */ 235 void (*ifa_rtrequest) /* check or clean routes (+ or -)'d */ 236 __P((int, struct rtentry *, struct sockaddr *)); 237 u_short ifa_flags; /* mostly rt_flags for cloning */ 238 short ifa_refcnt; /* count of references */ 239 int ifa_metric; /* cost of going out this interface */ 240 }; 241 #define IFA_ROUTE RTF_UP /* route installed */ 242 243 /* 244 * Message format for use in obtaining information about interfaces 245 * from sysctl and the routing socket. 246 */ 247 struct if_msghdr { 248 u_short ifm_msglen; /* to skip over non-understood messages */ 249 u_char ifm_version; /* future binary compatability */ 250 u_char ifm_type; /* message type */ 251 int ifm_addrs; /* like rtm_addrs */ 252 int ifm_flags; /* value of if_flags */ 253 u_short ifm_index; /* index for associated ifp */ 254 struct if_data ifm_data;/* statistics and other data about if */ 255 }; 256 257 /* 258 * Message format for use in obtaining information about interface addresses 259 * from sysctl and the routing socket. 260 */ 261 struct ifa_msghdr { 262 u_short ifam_msglen; /* to skip over non-understood messages */ 263 u_char ifam_version; /* future binary compatability */ 264 u_char ifam_type; /* message type */ 265 int ifam_addrs; /* like rtm_addrs */ 266 int ifam_flags; /* value of ifa_flags */ 267 u_short ifam_index; /* index for associated ifp */ 268 int ifam_metric; /* value of ifa_metric */ 269 }; 270 271 /* 272 * Interface request structure used for socket 273 * ioctl's. All interface ioctl's must have parameter 274 * definitions which begin with ifr_name. The 275 * remainder may be interface specific. 276 */ 277 struct ifreq { 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 297 struct ifaliasreq { 298 char ifra_name[IFNAMSIZ]; /* if name, e.g. "en0" */ 299 struct sockaddr ifra_addr; 300 struct sockaddr ifra_dstaddr; 301 #define ifra_broadaddr ifra_dstaddr 302 struct sockaddr ifra_mask; 303 }; 304 305 /* 306 * Structure used in SIOCGIFCONF request. 307 * Used to retrieve interface configuration 308 * for machine (useful for programs which 309 * must know all networks accessible). 310 */ 311 struct ifconf { 312 int ifc_len; /* size of associated buffer */ 313 union { 314 caddr_t ifcu_buf; 315 struct ifreq *ifcu_req; 316 } ifc_ifcu; 317 #define ifc_buf ifc_ifcu.ifcu_buf /* buffer address */ 318 #define ifc_req ifc_ifcu.ifcu_req /* array of structures returned */ 319 }; 320 321 #include <net/if_arp.h> 322 323 #ifdef _KERNEL 324 #define IFAFREE(ifa) \ 325 if ((ifa)->ifa_refcnt <= 0) \ 326 ifafree(ifa); \ 327 else \ 328 (ifa)->ifa_refcnt--; 329 330 struct ifnet_head ifnet; 331 332 void ether_ifattach __P((struct ifnet *)); 333 void ether_input __P((struct ifnet *, struct ether_header *, struct mbuf *)); 334 int ether_output __P((struct ifnet *, 335 struct mbuf *, struct sockaddr *, struct rtentry *)); 336 char *ether_sprintf __P((u_char *)); 337 338 void if_attach __P((struct ifnet *)); 339 void if_down __P((struct ifnet *)); 340 void if_qflush __P((struct ifqueue *)); 341 void if_slowtimo __P((void *)); 342 void if_up __P((struct ifnet *)); 343 int ifconf __P((u_long, caddr_t)); 344 void ifinit __P((void)); 345 int ifioctl __P((struct socket *, u_long, caddr_t, struct proc *)); 346 int ifpromisc __P((struct ifnet *, int)); 347 struct ifnet *ifunit __P((char *)); 348 349 struct ifaddr *ifa_ifwithaddr __P((struct sockaddr *)); 350 struct ifaddr *ifa_ifwithaf __P((int)); 351 struct ifaddr *ifa_ifwithdstaddr __P((struct sockaddr *)); 352 struct ifaddr *ifa_ifwithnet __P((struct sockaddr *)); 353 struct ifaddr *ifa_ifwithladdr __P((struct sockaddr *)); 354 struct ifaddr *ifa_ifwithroute __P((int, struct sockaddr *, 355 struct sockaddr *)); 356 struct ifaddr *ifaof_ifpforaddr __P((struct sockaddr *, struct ifnet *)); 357 void ifafree __P((struct ifaddr *)); 358 void link_rtrequest __P((int, struct rtentry *, struct sockaddr *)); 359 360 int loioctl __P((struct ifnet *, u_long, caddr_t)); 361 void loopattach __P((int)); 362 int looutput __P((struct ifnet *, 363 struct mbuf *, struct sockaddr *, struct rtentry *)); 364 void lortrequest __P((int, struct rtentry *, struct sockaddr *)); 365 #endif /* _KERNEL */ 366