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