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 * @(#)if.h 8.1 (Berkeley) 6/10/93 34 * $Id: if.h,v 1.27 1996/01/26 22:09:54 wollman Exp $ 35 */ 36 37 #ifndef _NET_IF_H_ 38 #define _NET_IF_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 three 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 65 #include <sys/socket.h> /* for struct sockaddr */ 66 67 #ifndef _TIME_ /* XXX fast fix for SNMP, going away soon */ 68 #include <sys/time.h> 69 #endif 70 71 #ifdef __STDC__ 72 /* 73 * Forward structure declarations for function prototypes [sic]. 74 */ 75 struct mbuf; 76 struct proc; 77 struct rtentry; 78 struct socket; 79 struct ether_header; 80 #endif 81 82 struct if_data { 83 /* generic interface information */ 84 u_char ifi_type; /* ethernet, tokenring, etc */ 85 u_char ifi_physical; /* e.g., AUI, Thinnet, 10base-T, etc */ 86 u_char ifi_addrlen; /* media address length */ 87 u_char ifi_hdrlen; /* media header length */ 88 u_long ifi_mtu; /* maximum transmission unit */ 89 u_long ifi_metric; /* routing metric (external only) */ 90 u_long ifi_baudrate; /* linespeed */ 91 /* volatile statistics */ 92 u_long ifi_ipackets; /* packets received on interface */ 93 u_long ifi_ierrors; /* input errors on interface */ 94 u_long ifi_opackets; /* packets sent on interface */ 95 u_long ifi_oerrors; /* output errors on interface */ 96 u_long ifi_collisions; /* collisions on csma interfaces */ 97 u_long ifi_ibytes; /* total number of octets received */ 98 u_long ifi_obytes; /* total number of octets sent */ 99 u_long ifi_imcasts; /* packets received via multicast */ 100 u_long ifi_omcasts; /* packets sent via multicast */ 101 u_long ifi_iqdrops; /* dropped on input, this interface */ 102 u_long ifi_noproto; /* destined for unsupported protocol */ 103 struct timeval ifi_lastchange; /* last updated */ 104 }; 105 106 /* 107 * Structure defining a queue for a network interface. 108 * 109 * (Would like to call this struct ``if'', but C isn't PL/1.) 110 */ 111 112 struct ifqueue { 113 struct mbuf *ifq_head; 114 struct mbuf *ifq_tail; 115 int ifq_len; 116 int ifq_maxlen; 117 int ifq_drops; 118 }; 119 120 /* 121 * Structure describing information about an interface 122 * which may be of interest to management entities. 123 */ 124 struct ifnet { 125 void *if_softc; /* pointer to driver state */ 126 char *if_name; /* name, e.g. ``en'' or ``lo'' */ 127 struct ifnet *if_next; /* all struct ifnets are chained */ 128 struct ifaddr *if_addrlist; /* linked list of addresses per if */ 129 int if_pcount; /* number of promiscuous listeners */ 130 struct bpf_if *if_bpf; /* packet filter structure */ 131 u_short if_index; /* numeric abbreviation for this if */ 132 short if_unit; /* sub-unit for lower level driver */ 133 short if_timer; /* time 'til if_watchdog called */ 134 short if_flags; /* up/down, broadcast, etc. */ 135 u_char if_recvquota, if_sendquota; /* quotas for send, receive */ 136 u_char if_ipending; /* interrupts pending */ 137 struct if_data if_data; 138 /* procedure handles */ 139 int (*if_output) /* output routine (enqueue) */ 140 __P((struct ifnet *, struct mbuf *, struct sockaddr *, 141 struct rtentry *)); 142 void (*if_start) /* initiate output routine */ 143 __P((struct ifnet *)); 144 int (*if_done) /* output complete routine */ 145 __P((struct ifnet *)); /* (XXX not used; fake prototype) */ 146 int (*if_ioctl) /* ioctl routine */ 147 __P((struct ifnet *, int, caddr_t)); 148 void (*if_watchdog) /* timer routine */ 149 __P((struct ifnet *)); 150 void (*if_poll_recv) /* polled receive routine */ 151 __P((struct ifnet *, int *)); 152 void (*if_poll_xmit) /* polled transmit routine */ 153 __P((struct ifnet *, int *)); 154 void (*if_poll_intren) /* polled interrupt reenable routine */ 155 __P((struct ifnet *)); 156 void (*if_poll_slowinput) /* input routine for slow devices */ 157 __P((struct ifnet *, struct mbuf *)); 158 struct ifqueue if_snd; /* output queue */ 159 struct ifqueue *if_poll_slowq; /* input queue for slow devices */ 160 }; 161 #define if_mtu if_data.ifi_mtu 162 #define if_type if_data.ifi_type 163 #define if_physical if_data.ifi_physical 164 #define if_addrlen if_data.ifi_addrlen 165 #define if_hdrlen if_data.ifi_hdrlen 166 #define if_metric if_data.ifi_metric 167 #define if_baudrate if_data.ifi_baudrate 168 #define if_ipackets if_data.ifi_ipackets 169 #define if_ierrors if_data.ifi_ierrors 170 #define if_opackets if_data.ifi_opackets 171 #define if_oerrors if_data.ifi_oerrors 172 #define if_collisions if_data.ifi_collisions 173 #define if_ibytes if_data.ifi_ibytes 174 #define if_obytes if_data.ifi_obytes 175 #define if_imcasts if_data.ifi_imcasts 176 #define if_omcasts if_data.ifi_omcasts 177 #define if_iqdrops if_data.ifi_iqdrops 178 #define if_noproto if_data.ifi_noproto 179 #define if_lastchange if_data.ifi_lastchange 180 #define if_rawoutput(if, m, sa) if_output(if, m, sa, (struct rtentry *)0) 181 182 #define IFF_UP 0x1 /* interface is up */ 183 #define IFF_BROADCAST 0x2 /* broadcast address valid */ 184 #define IFF_DEBUG 0x4 /* turn on debugging */ 185 #define IFF_LOOPBACK 0x8 /* is a loopback net */ 186 #define IFF_POINTOPOINT 0x10 /* interface is point-to-point link */ 187 /*#define IFF_NOTRAILERS 0x20 * obsolete: avoid use of trailers */ 188 #define IFF_RUNNING 0x40 /* resources allocated */ 189 #define IFF_NOARP 0x80 /* no address resolution protocol */ 190 #define IFF_PROMISC 0x100 /* receive all packets */ 191 #define IFF_ALLMULTI 0x200 /* receive all multicast packets */ 192 #define IFF_OACTIVE 0x400 /* transmission in progress */ 193 #define IFF_SIMPLEX 0x800 /* can't hear own transmissions */ 194 #define IFF_LINK0 0x1000 /* per link layer defined bit */ 195 #define IFF_LINK1 0x2000 /* per link layer defined bit */ 196 #define IFF_LINK2 0x4000 /* per link layer defined bit */ 197 #define IFF_ALTPHYS IFF_LINK2 /* use alternate physical connection */ 198 #define IFF_MULTICAST 0x8000 /* supports multicast */ 199 200 /* flags set internally only: */ 201 #define IFF_CANTCHANGE \ 202 (IFF_BROADCAST|IFF_POINTOPOINT|IFF_RUNNING|IFF_OACTIVE|\ 203 IFF_SIMPLEX|IFF_MULTICAST|IFF_ALLMULTI) 204 205 206 /* 207 * These really don't belong here, but there's no other obviously appropriate 208 * location. 209 */ 210 #define IFP_AUI 0 211 #define IFP_10BASE2 1 212 #define IFP_10BASET 2 213 /* etc. */ 214 215 /* 216 * Bit values in if_ipending 217 */ 218 #define IFI_RECV 1 /* I want to receive */ 219 #define IFI_XMIT 2 /* I want to transmit */ 220 221 /* 222 * Output queues (ifp->if_snd) and internetwork datagram level (pup level 1) 223 * input routines have queues of messages stored on ifqueue structures 224 * (defined above). Entries are added to and deleted from these structures 225 * by these macros, which should be called with ipl raised to splimp(). 226 */ 227 #define IF_QFULL(ifq) ((ifq)->ifq_len >= (ifq)->ifq_maxlen) 228 #define IF_DROP(ifq) ((ifq)->ifq_drops++) 229 #define IF_ENQUEUE(ifq, m) { \ 230 (m)->m_nextpkt = 0; \ 231 if ((ifq)->ifq_tail == 0) \ 232 (ifq)->ifq_head = m; \ 233 else \ 234 (ifq)->ifq_tail->m_nextpkt = m; \ 235 (ifq)->ifq_tail = m; \ 236 (ifq)->ifq_len++; \ 237 } 238 #define IF_PREPEND(ifq, m) { \ 239 (m)->m_nextpkt = (ifq)->ifq_head; \ 240 if ((ifq)->ifq_tail == 0) \ 241 (ifq)->ifq_tail = (m); \ 242 (ifq)->ifq_head = (m); \ 243 (ifq)->ifq_len++; \ 244 } 245 #define IF_DEQUEUE(ifq, m) { \ 246 (m) = (ifq)->ifq_head; \ 247 if (m) { \ 248 if (((ifq)->ifq_head = (m)->m_nextpkt) == 0) \ 249 (ifq)->ifq_tail = 0; \ 250 (m)->m_nextpkt = 0; \ 251 (ifq)->ifq_len--; \ 252 } \ 253 } 254 255 #define IFQ_MAXLEN 50 256 #define IFNET_SLOWHZ 1 /* granularity is 1 second */ 257 258 /* 259 * The ifaddr structure contains information about one address 260 * of an interface. They are maintained by the different address families, 261 * are allocated and attached when an address is set, and are linked 262 * together so all addresses for an interface can be located. 263 */ 264 struct ifaddr { 265 struct sockaddr *ifa_addr; /* address of interface */ 266 struct sockaddr *ifa_dstaddr; /* other end of p-to-p link */ 267 #define ifa_broadaddr ifa_dstaddr /* broadcast address interface */ 268 struct sockaddr *ifa_netmask; /* used to determine subnet */ 269 struct ifnet *ifa_ifp; /* back-pointer to interface */ 270 struct ifaddr *ifa_next; /* next address for interface */ 271 void (*ifa_rtrequest) /* check or clean routes (+ or -)'d */ 272 __P((int, struct rtentry *, struct sockaddr *)); 273 u_short ifa_flags; /* mostly rt_flags for cloning */ 274 short ifa_refcnt; /* extra to malloc for link info */ 275 int ifa_metric; /* cost of going out this interface */ 276 #ifdef notdef 277 struct rtentry *ifa_rt; /* XXXX for ROUTETOIF ????? */ 278 #endif 279 }; 280 #define IFA_ROUTE RTF_UP /* route installed */ 281 282 /* 283 * Message format for use in obtaining information about interfaces 284 * from getkerninfo and the routing socket 285 */ 286 struct if_msghdr { 287 u_short ifm_msglen; /* to skip over non-understood messages */ 288 u_char ifm_version; /* future binary compatability */ 289 u_char ifm_type; /* message type */ 290 int ifm_addrs; /* like rtm_addrs */ 291 int ifm_flags; /* value of if_flags */ 292 u_short ifm_index; /* index for associated ifp */ 293 struct if_data ifm_data;/* statistics and other data about if */ 294 }; 295 296 /* 297 * Message format for use in obtaining information about interface addresses 298 * from getkerninfo and the routing socket 299 */ 300 struct ifa_msghdr { 301 u_short ifam_msglen; /* to skip over non-understood messages */ 302 u_char ifam_version; /* future binary compatability */ 303 u_char ifam_type; /* message type */ 304 int ifam_addrs; /* like rtm_addrs */ 305 int ifam_flags; /* value of ifa_flags */ 306 u_short ifam_index; /* index for associated ifp */ 307 int ifam_metric; /* value of ifa_metric */ 308 }; 309 310 /* 311 * Interface request structure used for socket 312 * ioctl's. All interface ioctl's must have parameter 313 * definitions which begin with ifr_name. The 314 * remainder may be interface specific. 315 */ 316 struct ifreq { 317 #define IFNAMSIZ 16 318 char ifr_name[IFNAMSIZ]; /* if name, e.g. "en0" */ 319 union { 320 struct sockaddr ifru_addr; 321 struct sockaddr ifru_dstaddr; 322 struct sockaddr ifru_broadaddr; 323 short ifru_flags; 324 int ifru_metric; 325 int ifru_mtu; 326 int ifru_phys; 327 caddr_t ifru_data; 328 } ifr_ifru; 329 #define ifr_addr ifr_ifru.ifru_addr /* address */ 330 #define ifr_dstaddr ifr_ifru.ifru_dstaddr /* other end of p-to-p link */ 331 #define ifr_broadaddr ifr_ifru.ifru_broadaddr /* broadcast address */ 332 #define ifr_flags ifr_ifru.ifru_flags /* flags */ 333 #define ifr_metric ifr_ifru.ifru_metric /* metric */ 334 #define ifr_mtu ifr_ifru.ifru_mtu /* mtu */ 335 #define ifr_phys ifr_ifru.ifru_phys /* physical wire */ 336 #define ifr_data ifr_ifru.ifru_data /* for use by interface */ 337 }; 338 339 struct ifaliasreq { 340 char ifra_name[IFNAMSIZ]; /* if name, e.g. "en0" */ 341 struct sockaddr ifra_addr; 342 struct sockaddr ifra_broadaddr; 343 struct sockaddr ifra_mask; 344 }; 345 346 /* 347 * Structure used in SIOCGIFCONF request. 348 * Used to retrieve interface configuration 349 * for machine (useful for programs which 350 * must know all networks accessible). 351 */ 352 struct ifconf { 353 int ifc_len; /* size of associated buffer */ 354 union { 355 caddr_t ifcu_buf; 356 struct ifreq *ifcu_req; 357 } ifc_ifcu; 358 #define ifc_buf ifc_ifcu.ifcu_buf /* buffer address */ 359 #define ifc_req ifc_ifcu.ifcu_req /* array of structures returned */ 360 }; 361 362 #include <net/if_arp.h> 363 364 #ifdef KERNEL 365 #define IFAFREE(ifa) \ 366 if ((ifa)->ifa_refcnt <= 0) \ 367 ifafree(ifa); \ 368 else \ 369 (ifa)->ifa_refcnt--; 370 371 extern struct ifnet *ifnet; 372 extern int ifqmaxlen; 373 extern struct ifnet loif[]; 374 375 void ether_ifattach __P((struct ifnet *)); 376 void ether_input __P((struct ifnet *, struct ether_header *, struct mbuf *)); 377 int ether_output __P((struct ifnet *, 378 struct mbuf *, struct sockaddr *, struct rtentry *)); 379 380 void if_attach __P((struct ifnet *)); 381 void if_down __P((struct ifnet *)); 382 void if_up __P((struct ifnet *)); 383 #ifdef vax 384 void ifubareset __P((int)); 385 #endif 386 /*void ifinit __P((void));*/ /* declared in systm.h for main() */ 387 int ifioctl __P((struct socket *, int, caddr_t, struct proc *)); 388 int ifpromisc __P((struct ifnet *, int)); 389 struct ifnet *ifunit __P((char *)); 390 391 struct ifaddr *ifa_ifwithaddr __P((struct sockaddr *)); 392 struct ifaddr *ifa_ifwithdstaddr __P((struct sockaddr *)); 393 struct ifaddr *ifa_ifwithnet __P((struct sockaddr *)); 394 struct ifaddr *ifa_ifwithroute __P((int, struct sockaddr *, 395 struct sockaddr *)); 396 struct ifaddr *ifaof_ifpforaddr __P((struct sockaddr *, struct ifnet *)); 397 void ifafree __P((struct ifaddr *)); 398 399 int looutput __P((struct ifnet *, 400 struct mbuf *, struct sockaddr *, struct rtentry *)); 401 #endif /* KERNEL */ 402 403 #endif /* !_NET_IF_H_ */ 404