if.h revision 1.40
1 /* $NetBSD: if.h,v 1.40 1999/09/29 22:42:02 thorpej 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.3 (Berkeley) 2/9/95 36 */ 37 38 #ifndef _NET_IF_H_ 39 #define _NET_IF_H_ 40 41 #if !defined(_XOPEN_SOURCE) 42 43 #include <sys/queue.h> 44 45 /* 46 * Structures defining a network interface, providing a packet 47 * transport mechanism (ala level 0 of the PUP protocols). 48 * 49 * Each interface accepts output datagrams of a specified maximum 50 * length, and provides higher level routines with input datagrams 51 * received from its medium. 52 * 53 * Output occurs when the routine if_output is called, with four parameters: 54 * (*ifp->if_output)(ifp, m, dst, rt) 55 * Here m is the mbuf chain to be sent and dst is the destination address. 56 * The output routine encapsulates the supplied datagram if necessary, 57 * and then transmits it on its medium. 58 * 59 * On input, each interface unwraps the data received by it, and either 60 * places it on the input queue of a internetwork datagram routine 61 * and posts the associated software interrupt, or passes the datagram to a raw 62 * packet input routine. 63 * 64 * Routines exist for locating interfaces by their addresses 65 * or for locating a interface on a certain network, as well as more general 66 * routing and gateway routines maintaining information used to locate 67 * interfaces. These routines live in the files if.c and route.c 68 */ 69 /* XXX fast fix for SNMP, going away soon */ 70 #include <sys/time.h> 71 72 struct mbuf; 73 struct proc; 74 struct rtentry; 75 struct socket; 76 struct ether_header; 77 78 /* 79 * Structure defining statistics and other data kept regarding a network 80 * interface. 81 */ 82 struct if_data { 83 /* generic interface information */ 84 u_char ifi_type; /* ethernet, tokenring, etc. */ 85 u_char ifi_addrlen; /* media address length */ 86 u_char ifi_hdrlen; /* media header length */ 87 u_long ifi_mtu; /* maximum transmission unit */ 88 u_long ifi_metric; /* routing metric (external only) */ 89 u_long ifi_baudrate; /* linespeed */ 90 /* volatile statistics */ 91 u_long ifi_ipackets; /* packets received on interface */ 92 u_long ifi_ierrors; /* input errors on interface */ 93 u_long ifi_opackets; /* packets sent on interface */ 94 u_long ifi_oerrors; /* output errors on interface */ 95 u_long ifi_collisions; /* collisions on csma interfaces */ 96 u_long ifi_ibytes; /* total number of octets received */ 97 u_long ifi_obytes; /* total number of octets sent */ 98 u_long ifi_imcasts; /* packets received via multicast */ 99 u_long ifi_omcasts; /* packets sent via multicast */ 100 u_long ifi_iqdrops; /* dropped on input, this interface */ 101 u_long ifi_noproto; /* destined for unsupported protocol */ 102 struct timeval ifi_lastchange; /* last updated */ 103 }; 104 105 /* 106 * Structure defining a queue for a network interface. 107 * 108 * (Would like to call this struct ``if'', but C isn't PL/1.) 109 */ 110 TAILQ_HEAD(ifnet_head, ifnet); /* the actual queue head */ 111 112 /* 113 * Length of interface external name, including terminating '\0'. 114 * Note: this is the same size as a generic device's external name. 115 */ 116 #define IFNAMSIZ 16 117 #define IF_NAMESIZE IFNAMSIZ 118 119 struct ifnet { /* and the entries */ 120 void *if_softc; /* lower-level data for this if */ 121 TAILQ_ENTRY(ifnet) if_list; /* all struct ifnets are chained */ 122 TAILQ_HEAD(, ifaddr) if_addrlist; /* linked list of addresses per if */ 123 char if_xname[IFNAMSIZ]; /* external name (name + unit) */ 124 int if_pcount; /* number of promiscuous listeners */ 125 caddr_t if_bpf; /* packet filter structure */ 126 u_short if_index; /* numeric abbreviation for this if */ 127 short if_timer; /* time 'til if_watchdog called */ 128 short if_flags; /* up/down, broadcast, etc. */ 129 short if__pad1; /* be nice to m68k ports */ 130 struct if_data if_data; /* statistics and other data about if */ 131 /* procedure handles */ 132 int (*if_output) /* output routine (enqueue) */ 133 __P((struct ifnet *, struct mbuf *, struct sockaddr *, 134 struct rtentry *)); 135 void (*if_input) /* input routine (from h/w driver) */ 136 __P((struct ifnet *, struct mbuf *)); 137 void (*if_start) /* initiate output routine */ 138 __P((struct ifnet *)); 139 int (*if_ioctl) /* ioctl routine */ 140 __P((struct ifnet *, u_long, caddr_t)); 141 int (*if_reset) /* XXX bus reset routine */ 142 __P((struct ifnet *)); 143 void (*if_watchdog) /* timer routine */ 144 __P((struct ifnet *)); 145 void (*if_drain) /* routine to release resources */ 146 __P((struct ifnet *)); 147 struct ifqueue { 148 struct mbuf *ifq_head; 149 struct mbuf *ifq_tail; 150 int ifq_len; 151 int ifq_maxlen; 152 int ifq_drops; 153 } if_snd; /* output queue */ 154 struct sockaddr_dl *if_sadl; /* pointer to our sockaddr_dl */ 155 u_int8_t *if_broadcastaddr; /* linklevel broadcast bytestring */ 156 struct ifprefix *if_prefixlist; /* linked list of prefixes per if */ 157 }; 158 #define if_mtu if_data.ifi_mtu 159 #define if_type if_data.ifi_type 160 #define if_addrlen if_data.ifi_addrlen 161 #define if_hdrlen if_data.ifi_hdrlen 162 #define if_metric if_data.ifi_metric 163 #define if_baudrate if_data.ifi_baudrate 164 #define if_ipackets if_data.ifi_ipackets 165 #define if_ierrors if_data.ifi_ierrors 166 #define if_opackets if_data.ifi_opackets 167 #define if_oerrors if_data.ifi_oerrors 168 #define if_collisions if_data.ifi_collisions 169 #define if_ibytes if_data.ifi_ibytes 170 #define if_obytes if_data.ifi_obytes 171 #define if_imcasts if_data.ifi_imcasts 172 #define if_omcasts if_data.ifi_omcasts 173 #define if_iqdrops if_data.ifi_iqdrops 174 #define if_noproto if_data.ifi_noproto 175 #define if_lastchange if_data.ifi_lastchange 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 /* 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_MULTICAST 0x8000 /* supports multicast */ 193 194 /* flags set internally only: */ 195 #define IFF_CANTCHANGE \ 196 (IFF_BROADCAST|IFF_POINTOPOINT|IFF_RUNNING|IFF_OACTIVE|\ 197 IFF_SIMPLEX|IFF_MULTICAST|IFF_ALLMULTI) 198 199 /* 200 * Output queues (ifp->if_snd) and internetwork datagram level (pup level 1) 201 * input routines have queues of messages stored on ifqueue structures 202 * (defined above). Entries are added to and deleted from these structures 203 * by these macros, which should be called with ipl raised to splimp(). 204 */ 205 #define IF_QFULL(ifq) ((ifq)->ifq_len >= (ifq)->ifq_maxlen) 206 #define IF_DROP(ifq) ((ifq)->ifq_drops++) 207 #define IF_ENQUEUE(ifq, m) { \ 208 (m)->m_nextpkt = 0; \ 209 if ((ifq)->ifq_tail == 0) \ 210 (ifq)->ifq_head = m; \ 211 else \ 212 (ifq)->ifq_tail->m_nextpkt = m; \ 213 (ifq)->ifq_tail = m; \ 214 (ifq)->ifq_len++; \ 215 } 216 #define IF_PREPEND(ifq, m) { \ 217 (m)->m_nextpkt = (ifq)->ifq_head; \ 218 if ((ifq)->ifq_tail == 0) \ 219 (ifq)->ifq_tail = (m); \ 220 (ifq)->ifq_head = (m); \ 221 (ifq)->ifq_len++; \ 222 } 223 #define IF_DEQUEUE(ifq, m) { \ 224 (m) = (ifq)->ifq_head; \ 225 if (m) { \ 226 if (((ifq)->ifq_head = (m)->m_nextpkt) == 0) \ 227 (ifq)->ifq_tail = 0; \ 228 (m)->m_nextpkt = 0; \ 229 (ifq)->ifq_len--; \ 230 } \ 231 } 232 233 #define IFQ_MAXLEN 50 234 #define IFNET_SLOWHZ 1 /* granularity is 1 second */ 235 236 /* 237 * Structure defining statistics and other data kept regarding an address 238 * on a network interface. 239 */ 240 struct ifaddr_data { 241 int64_t ifad_inbytes; 242 int64_t ifad_outbytes; 243 }; 244 245 /* 246 * The ifaddr structure contains information about one address 247 * of an interface. They are maintained by the different address families, 248 * are allocated and attached when an address is set, and are linked 249 * together so all addresses for an interface can be located. 250 */ 251 struct ifaddr { 252 struct sockaddr *ifa_addr; /* address of interface */ 253 struct sockaddr *ifa_dstaddr; /* other end of p-to-p link */ 254 #define ifa_broadaddr ifa_dstaddr /* broadcast address interface */ 255 struct sockaddr *ifa_netmask; /* used to determine subnet */ 256 struct ifnet *ifa_ifp; /* back-pointer to interface */ 257 TAILQ_ENTRY(ifaddr) ifa_list; /* list of addresses for interface */ 258 struct ifaddr_data ifa_data; /* statistics on the address */ 259 void (*ifa_rtrequest) /* check or clean routes (+ or -)'d */ 260 __P((int, struct rtentry *, struct sockaddr *)); 261 u_short ifa_flags; /* mostly rt_flags for cloning */ 262 short ifa_refcnt; /* count of references */ 263 int ifa_metric; /* cost of going out this interface */ 264 }; 265 #define IFA_ROUTE RTF_UP /* route installed */ 266 267 /* 268 * The prefix structure contains information about one prefix 269 * of an interface. They are maintained by the different address families, 270 * are allocated and attached when an prefix or an address is set, 271 * and are linked together so all prfefixes for an interface can be located. 272 */ 273 struct ifprefix { 274 struct sockaddr *ifpr_prefix; /* prefix of interface */ 275 struct ifnet *ifpr_ifp; /* back-pointer to interface */ 276 struct ifprefix *ifpr_next; 277 u_char ifpr_plen; /* prefix length in bits */ 278 }; 279 280 /* 281 * Message format for use in obtaining information about interfaces 282 * from sysctl and the routing socket. 283 */ 284 struct if_msghdr { 285 u_short ifm_msglen; /* to skip over non-understood messages */ 286 u_char ifm_version; /* future binary compatability */ 287 u_char ifm_type; /* message type */ 288 int ifm_addrs; /* like rtm_addrs */ 289 int ifm_flags; /* value of if_flags */ 290 u_short ifm_index; /* index for associated ifp */ 291 struct if_data ifm_data;/* statistics and other data about if */ 292 }; 293 294 /* 295 * Message format for use in obtaining information about interface addresses 296 * from sysctl and the routing socket. 297 */ 298 struct ifa_msghdr { 299 u_short ifam_msglen; /* to skip over non-understood messages */ 300 u_char ifam_version; /* future binary compatability */ 301 u_char ifam_type; /* message type */ 302 int ifam_addrs; /* like rtm_addrs */ 303 int ifam_flags; /* value of ifa_flags */ 304 u_short ifam_index; /* index for associated ifp */ 305 int ifam_metric; /* value of ifa_metric */ 306 }; 307 308 /* 309 * Interface request structure used for socket 310 * ioctl's. All interface ioctl's must have parameter 311 * definitions which begin with ifr_name. The 312 * remainder may be interface specific. 313 */ 314 struct ifreq { 315 char ifr_name[IFNAMSIZ]; /* if name, e.g. "en0" */ 316 union { 317 struct sockaddr ifru_addr; 318 struct sockaddr ifru_dstaddr; 319 struct sockaddr ifru_broadaddr; 320 short ifru_flags; 321 int ifru_metric; 322 int ifru_mtu; 323 u_int ifru_value; 324 caddr_t ifru_data; 325 } ifr_ifru; 326 #define ifr_addr ifr_ifru.ifru_addr /* address */ 327 #define ifr_dstaddr ifr_ifru.ifru_dstaddr /* other end of p-to-p link */ 328 #define ifr_broadaddr ifr_ifru.ifru_broadaddr /* broadcast address */ 329 #define ifr_flags ifr_ifru.ifru_flags /* flags */ 330 #define ifr_metric ifr_ifru.ifru_metric /* metric */ 331 #define ifr_mtu ifr_ifru.ifru_mtu /* mtu */ 332 #define ifr_value ifr_ifru.ifru_value /* generic value */ 333 #define ifr_media ifr_ifru.ifru_metric /* media options (overload) */ 334 #define ifr_data ifr_ifru.ifru_data /* for use by interface */ 335 }; 336 337 struct ifaliasreq { 338 char ifra_name[IFNAMSIZ]; /* if name, e.g. "en0" */ 339 struct sockaddr ifra_addr; 340 struct sockaddr ifra_dstaddr; 341 #define ifra_broadaddr ifra_dstaddr 342 struct sockaddr ifra_mask; 343 }; 344 345 struct ifmediareq { 346 char ifm_name[IFNAMSIZ]; /* if name, e.g. "en0" */ 347 int ifm_current; /* current media options */ 348 int ifm_mask; /* don't care mask */ 349 int ifm_status; /* media status */ 350 int ifm_active; /* active options */ 351 int ifm_count; /* # entries in ifm_ulist 352 array */ 353 int *ifm_ulist; /* media words */ 354 }; 355 356 357 struct ifdrv { 358 char ifd_name[IFNAMSIZ]; /* if name, e.g. "en0" */ 359 unsigned long ifd_cmd; 360 size_t ifd_len; 361 void *ifd_data; 362 }; 363 364 /* 365 * Structure used in SIOCGIFCONF request. 366 * Used to retrieve interface configuration 367 * for machine (useful for programs which 368 * must know all networks accessible). 369 */ 370 struct ifconf { 371 int ifc_len; /* size of associated buffer */ 372 union { 373 caddr_t ifcu_buf; 374 struct ifreq *ifcu_req; 375 } ifc_ifcu; 376 #define ifc_buf ifc_ifcu.ifcu_buf /* buffer address */ 377 #define ifc_req ifc_ifcu.ifcu_req /* array of structures returned */ 378 }; 379 380 /* 381 * Structure for SIOC[AGD]LIFADDR 382 */ 383 struct if_laddrreq { 384 char iflr_name[IFNAMSIZ]; 385 unsigned int flags; 386 #define IFLR_PREFIX 0x8000 /* in: prefix given out: kernel fills id */ 387 unsigned int prefixlen; /* in/out */ 388 struct sockaddr_storage addr; /* in/out */ 389 struct sockaddr_storage dstaddr; /* out */ 390 }; 391 392 #include <net/if_arp.h> 393 394 #endif /* !_XOPEN_SOURCE */ 395 396 #ifdef _KERNEL 397 #define IFAFREE(ifa) \ 398 if ((ifa)->ifa_refcnt <= 0) \ 399 ifafree(ifa); \ 400 else \ 401 (ifa)->ifa_refcnt--; 402 403 struct ifnet_head ifnet; 404 struct ifnet **ifindex2ifnet; 405 #if 0 406 struct ifnet loif[]; 407 #endif 408 int if_index; 409 410 void ether_ifattach __P((struct ifnet *, const u_int8_t *)); 411 char *ether_sprintf __P((const u_char *)); 412 413 void if_attach __P((struct ifnet *)); 414 void if_down __P((struct ifnet *)); 415 void if_qflush __P((struct ifqueue *)); 416 void if_slowtimo __P((void *)); 417 void if_up __P((struct ifnet *)); 418 int ifconf __P((u_long, caddr_t)); 419 void ifinit __P((void)); 420 int ifioctl __P((struct socket *, u_long, caddr_t, struct proc *)); 421 int ifpromisc __P((struct ifnet *, int)); 422 struct ifnet *ifunit __P((const char *)); 423 struct ifnet *if_withname __P((struct sockaddr *)); 424 425 struct ifaddr *ifa_ifwithaddr __P((struct sockaddr *)); 426 struct ifaddr *ifa_ifwithaf __P((int)); 427 struct ifaddr *ifa_ifwithdstaddr __P((struct sockaddr *)); 428 struct ifaddr *ifa_ifwithnet __P((struct sockaddr *)); 429 struct ifaddr *ifa_ifwithladdr __P((struct sockaddr *)); 430 struct ifaddr *ifa_ifwithroute __P((int, struct sockaddr *, 431 struct sockaddr *)); 432 struct ifaddr *ifaof_ifpforaddr __P((struct sockaddr *, struct ifnet *)); 433 void ifafree __P((struct ifaddr *)); 434 void link_rtrequest __P((int, struct rtentry *, struct sockaddr *)); 435 436 int loioctl __P((struct ifnet *, u_long, caddr_t)); 437 void loopattach __P((int)); 438 int looutput __P((struct ifnet *, 439 struct mbuf *, struct sockaddr *, struct rtentry *)); 440 void lortrequest __P((int, struct rtentry *, struct sockaddr *)); 441 #else 442 struct if_nameindex { 443 unsigned int if_index; /* 1, 2, ... */ 444 char *if_name; /* null terminated name: "le0", ... */ 445 }; 446 447 #include <sys/cdefs.h> 448 __BEGIN_DECLS 449 unsigned int if_nametoindex __P((const char *)); 450 char * if_indextoname __P((unsigned int, char *)); 451 struct if_nameindex * if_nameindex __P((void)); 452 void if_freenameindex __P((struct if_nameindex *)); 453 __END_DECLS 454 #endif /* _KERNEL */ 455 #endif /* !_NET_IF_H_ */ 456
Indexes created Wed Sep 24 05:09:52 GMT 2025