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