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