if.h revision 92081
11541Srgrimes/* 21541Srgrimes * Copyright (c) 1982, 1986, 1989, 1993 31541Srgrimes * The Regents of the University of California. All rights reserved. 41541Srgrimes * 51541Srgrimes * Redistribution and use in source and binary forms, with or without 61541Srgrimes * modification, are permitted provided that the following conditions 71541Srgrimes * are met: 81541Srgrimes * 1. Redistributions of source code must retain the above copyright 91541Srgrimes * notice, this list of conditions and the following disclaimer. 101541Srgrimes * 2. Redistributions in binary form must reproduce the above copyright 111541Srgrimes * notice, this list of conditions and the following disclaimer in the 121541Srgrimes * documentation and/or other materials provided with the distribution. 131541Srgrimes * 3. All advertising materials mentioning features or use of this software 141541Srgrimes * must display the following acknowledgement: 151541Srgrimes * This product includes software developed by the University of 161541Srgrimes * California, Berkeley and its contributors. 171541Srgrimes * 4. Neither the name of the University nor the names of its contributors 181541Srgrimes * may be used to endorse or promote products derived from this software 191541Srgrimes * without specific prior written permission. 201541Srgrimes * 211541Srgrimes * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 221541Srgrimes * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 231541Srgrimes * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 241541Srgrimes * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 251541Srgrimes * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 261541Srgrimes * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 271541Srgrimes * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 281541Srgrimes * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 291541Srgrimes * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 301541Srgrimes * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 311541Srgrimes * SUCH DAMAGE. 321541Srgrimes * 331541Srgrimes * @(#)if.h 8.1 (Berkeley) 6/10/93 3450477Speter * $FreeBSD: head/sys/net/if.h 92081 2002-03-11 09:26:07Z mux $ 351541Srgrimes */ 361541Srgrimes 372168Spaul#ifndef _NET_IF_H_ 384507Sbde#define _NET_IF_H_ 392168Spaul 4079103Sbrooks#include <sys/queue.h> 4179103Sbrooks 421541Srgrimes/* 4334750Speter * <net/if.h> does not depend on <sys/time.h> on most other systems. This 4472093Sasmodai * helps userland compatibility. (struct timeval ifi_lastchange) 4534750Speter */ 4655205Speter#ifndef _KERNEL 4734750Speter#include <sys/time.h> 4834750Speter#endif 4934750Speter 5079103Sbrooksstruct ifnet; 5179103Sbrooks 5234750Speter/* 5379103Sbrooks * Length of interface external name, including terminating '\0'. 5479103Sbrooks * Note: this is the same size as a generic device's external name. 5579103Sbrooks */ 5679103Sbrooks#define IFNAMSIZ 16 5779103Sbrooks#define IF_NAMESIZE IFNAMSIZ 5892081Smux#define IF_MAXUNIT 0x7fff /* ifp->if_unit is only 15 bits */ 5979103Sbrooks 6079103Sbrooks/* 6179103Sbrooks * Structure describing a `cloning' interface. 6279103Sbrooks */ 6379103Sbrooksstruct if_clone { 6479103Sbrooks LIST_ENTRY(if_clone) ifc_list; /* on list of cloners */ 6579103Sbrooks const char *ifc_name; /* name of device, e.g. `gif' */ 6679103Sbrooks size_t ifc_namelen; /* length of name */ 6792081Smux int ifc_maxunit; /* maximum unit number */ 6892081Smux unsigned char *ifc_units; /* bitmap to handle units */ 6992081Smux int ifc_bmlen; /* bitmap length */ 7079103Sbrooks 7192081Smux int (*ifc_create)(struct if_clone *, int); 7291647Sbrooks int (*ifc_destroy)(struct ifnet *); 7379103Sbrooks}; 7479103Sbrooks 7592081Smux#define IF_CLONE_INITIALIZER(name, create, destroy, maxunit) \ 7692081Smux { { 0 }, name, sizeof(name) - 1, maxunit, NULL, 0, create, destroy } 7779103Sbrooks 7879103Sbrooks/* 7979103Sbrooks * Structure used to query names of interface cloners. 8079103Sbrooks */ 8179103Sbrooks 8279103Sbrooksstruct if_clonereq { 8379103Sbrooks int ifcr_total; /* total cloners (out) */ 8479103Sbrooks int ifcr_count; /* room for this many in user buffer */ 8579103Sbrooks char *ifcr_buffer; /* buffer for cloner names */ 8679103Sbrooks}; 8779103Sbrooks 8879103Sbrooks/* 8919079Sfenner * Structure describing information about an interface 9019079Sfenner * which may be of interest to management entities. 9119079Sfenner */ 929457Sjoergstruct if_data { 939457Sjoerg /* generic interface information */ 949457Sjoerg u_char ifi_type; /* ethernet, tokenring, etc */ 959457Sjoerg u_char ifi_physical; /* e.g., AUI, Thinnet, 10base-T, etc */ 969457Sjoerg u_char ifi_addrlen; /* media address length */ 979457Sjoerg u_char ifi_hdrlen; /* media header length */ 9817352Swollman u_char ifi_recvquota; /* polling quota for receive intrs */ 9917352Swollman u_char ifi_xmitquota; /* polling quota for xmit intrs */ 1009457Sjoerg u_long ifi_mtu; /* maximum transmission unit */ 1019457Sjoerg u_long ifi_metric; /* routing metric (external only) */ 1029457Sjoerg u_long ifi_baudrate; /* linespeed */ 1039457Sjoerg /* volatile statistics */ 1049457Sjoerg u_long ifi_ipackets; /* packets received on interface */ 1059457Sjoerg u_long ifi_ierrors; /* input errors on interface */ 1069457Sjoerg u_long ifi_opackets; /* packets sent on interface */ 1079457Sjoerg u_long ifi_oerrors; /* output errors on interface */ 1089457Sjoerg u_long ifi_collisions; /* collisions on csma interfaces */ 1099457Sjoerg u_long ifi_ibytes; /* total number of octets received */ 1109457Sjoerg u_long ifi_obytes; /* total number of octets sent */ 1119457Sjoerg u_long ifi_imcasts; /* packets received via multicast */ 1129457Sjoerg u_long ifi_omcasts; /* packets sent via multicast */ 1139457Sjoerg u_long ifi_iqdrops; /* dropped on input, this interface */ 1149457Sjoerg u_long ifi_noproto; /* destined for unsupported protocol */ 11558698Sjlemon u_long ifi_hwassist; /* HW offload capabilities */ 11658698Sjlemon u_long ifi_unused; /* XXX was ifi_xmittiming */ 11716287Sgpalmer struct timeval ifi_lastchange; /* time of last administrative change */ 1189457Sjoerg}; 1199457Sjoerg 1201541Srgrimes#define IFF_UP 0x1 /* interface is up */ 1211541Srgrimes#define IFF_BROADCAST 0x2 /* broadcast address valid */ 1221541Srgrimes#define IFF_DEBUG 0x4 /* turn on debugging */ 1231541Srgrimes#define IFF_LOOPBACK 0x8 /* is a loopback net */ 1241541Srgrimes#define IFF_POINTOPOINT 0x10 /* interface is point-to-point link */ 12547777Sphk#define IFF_SMART 0x20 /* interface manages own routes */ 1261541Srgrimes#define IFF_RUNNING 0x40 /* resources allocated */ 1271541Srgrimes#define IFF_NOARP 0x80 /* no address resolution protocol */ 1281541Srgrimes#define IFF_PROMISC 0x100 /* receive all packets */ 1291541Srgrimes#define IFF_ALLMULTI 0x200 /* receive all multicast packets */ 1301541Srgrimes#define IFF_OACTIVE 0x400 /* transmission in progress */ 1311541Srgrimes#define IFF_SIMPLEX 0x800 /* can't hear own transmissions */ 1321541Srgrimes#define IFF_LINK0 0x1000 /* per link layer defined bit */ 1331541Srgrimes#define IFF_LINK1 0x2000 /* per link layer defined bit */ 1341541Srgrimes#define IFF_LINK2 0x4000 /* per link layer defined bit */ 1353274Swollman#define IFF_ALTPHYS IFF_LINK2 /* use alternate physical connection */ 1361541Srgrimes#define IFF_MULTICAST 0x8000 /* supports multicast */ 1371541Srgrimes 13887902Sluigi/* 13987902Sluigi * The following flag(s) ought to go in if_flags, but we cannot change 14087902Sluigi * struct ifnet because of binary compatibility, so we store them in 14187902Sluigi * if_ipending, which is not used so far. 14287902Sluigi * If possible, make sure the value is not conflicting with other 14387902Sluigi * IFF flags, so we have an easier time when we want to merge them. 14487902Sluigi */ 14587902Sluigi#define IFF_POLLING 0x10000 /* Interface is in polling mode. */ 14687902Sluigi 1471541Srgrimes/* flags set internally only: */ 1481541Srgrimes#define IFF_CANTCHANGE \ 1491541Srgrimes (IFF_BROADCAST|IFF_POINTOPOINT|IFF_RUNNING|IFF_OACTIVE|\ 15047777Sphk IFF_SIMPLEX|IFF_MULTICAST|IFF_ALLMULTI|IFF_SMART) 1511541Srgrimes 15283624Sjlemon/* Capabilities that interfaces can advertise. */ 15383636Sjlemon#define IFCAP_RXCSUM 0x0001 /* can offload checksum on RX */ 15483636Sjlemon#define IFCAP_TXCSUM 0x0002 /* can offload checksum on TX */ 15583636Sjlemon#define IFCAP_NETCONS 0x0004 /* can be a network console */ 15683624Sjlemon 15783636Sjlemon#define IFCAP_HWCSUM (IFCAP_RXCSUM | IFCAP_TXCSUM) 15883636Sjlemon 1591541Srgrimes#define IFQ_MAXLEN 50 1601541Srgrimes#define IFNET_SLOWHZ 1 /* granularity is 1 second */ 1611541Srgrimes 1621541Srgrimes/* 1631541Srgrimes * Message format for use in obtaining information about interfaces 1641541Srgrimes * from getkerninfo and the routing socket 1651541Srgrimes */ 1661541Srgrimesstruct if_msghdr { 1671541Srgrimes u_short ifm_msglen; /* to skip over non-understood messages */ 16872093Sasmodai u_char ifm_version; /* future binary compatibility */ 1691541Srgrimes u_char ifm_type; /* message type */ 1701541Srgrimes int ifm_addrs; /* like rtm_addrs */ 1711541Srgrimes int ifm_flags; /* value of if_flags */ 1721541Srgrimes u_short ifm_index; /* index for associated ifp */ 1731541Srgrimes struct if_data ifm_data;/* statistics and other data about if */ 1741541Srgrimes}; 1751541Srgrimes 1761541Srgrimes/* 1771541Srgrimes * Message format for use in obtaining information about interface addresses 1781541Srgrimes * from getkerninfo and the routing socket 1791541Srgrimes */ 1801541Srgrimesstruct ifa_msghdr { 1811541Srgrimes u_short ifam_msglen; /* to skip over non-understood messages */ 18272093Sasmodai u_char ifam_version; /* future binary compatibility */ 1831541Srgrimes u_char ifam_type; /* message type */ 1841541Srgrimes int ifam_addrs; /* like rtm_addrs */ 1851541Srgrimes int ifam_flags; /* value of ifa_flags */ 1861541Srgrimes u_short ifam_index; /* index for associated ifp */ 1871541Srgrimes int ifam_metric; /* value of ifa_metric */ 1881541Srgrimes}; 1891541Srgrimes 1901541Srgrimes/* 19121666Swollman * Message format for use in obtaining information about multicast addresses 19221666Swollman * from the routing socket 19321666Swollman */ 19421666Swollmanstruct ifma_msghdr { 19521666Swollman u_short ifmam_msglen; /* to skip over non-understood messages */ 19672093Sasmodai u_char ifmam_version; /* future binary compatibility */ 19721666Swollman u_char ifmam_type; /* message type */ 19821666Swollman int ifmam_addrs; /* like rtm_addrs */ 19921666Swollman int ifmam_flags; /* value of ifa_flags */ 20021666Swollman u_short ifmam_index; /* index for associated ifp */ 20121666Swollman}; 20221666Swollman 20321666Swollman/* 20489498Sru * Message format announcing the arrival or departure of a network interface. 20589498Sru */ 20689498Srustruct if_announcemsghdr { 20789498Sru u_short ifan_msglen; /* to skip over non-understood messages */ 20889498Sru u_char ifan_version; /* future binary compatibility */ 20989498Sru u_char ifan_type; /* message type */ 21089498Sru u_short ifan_index; /* index for associated ifp */ 21189498Sru char ifan_name[IFNAMSIZ]; /* if name, e.g. "en0" */ 21289498Sru u_short ifan_what; /* what type of announcement */ 21389498Sru}; 21489498Sru 21589498Sru#define IFAN_ARRIVAL 0 /* interface arrival */ 21689498Sru#define IFAN_DEPARTURE 1 /* interface departure */ 21789498Sru 21889498Sru/* 2191541Srgrimes * Interface request structure used for socket 2201541Srgrimes * ioctl's. All interface ioctl's must have parameter 2211541Srgrimes * definitions which begin with ifr_name. The 2221541Srgrimes * remainder may be interface specific. 2231541Srgrimes */ 2241541Srgrimesstruct ifreq { 2251541Srgrimes char ifr_name[IFNAMSIZ]; /* if name, e.g. "en0" */ 2261541Srgrimes union { 2271541Srgrimes struct sockaddr ifru_addr; 2281541Srgrimes struct sockaddr ifru_dstaddr; 2291541Srgrimes struct sockaddr ifru_broadaddr; 23044144Sphk short ifru_flags[2]; 23185079Sjlemon short ifru_index; 2321541Srgrimes int ifru_metric; 2331941Sdg int ifru_mtu; 2345184Swollman int ifru_phys; 23525434Speter int ifru_media; 2361541Srgrimes caddr_t ifru_data; 23783624Sjlemon int ifru_cap[2]; 2381541Srgrimes } ifr_ifru; 2391541Srgrimes#define ifr_addr ifr_ifru.ifru_addr /* address */ 2401541Srgrimes#define ifr_dstaddr ifr_ifru.ifru_dstaddr /* other end of p-to-p link */ 2411541Srgrimes#define ifr_broadaddr ifr_ifru.ifru_broadaddr /* broadcast address */ 24244144Sphk#define ifr_flags ifr_ifru.ifru_flags[0] /* flags */ 24344144Sphk#define ifr_prevflags ifr_ifru.ifru_flags[1] /* flags */ 2441541Srgrimes#define ifr_metric ifr_ifru.ifru_metric /* metric */ 2451941Sdg#define ifr_mtu ifr_ifru.ifru_mtu /* mtu */ 2465187Sdg#define ifr_phys ifr_ifru.ifru_phys /* physical wire */ 24725434Speter#define ifr_media ifr_ifru.ifru_media /* physical media */ 2481541Srgrimes#define ifr_data ifr_ifru.ifru_data /* for use by interface */ 24983624Sjlemon#define ifr_reqcap ifr_ifru.ifru_cap[0] /* requested capabilities */ 25083624Sjlemon#define ifr_curcap ifr_ifru.ifru_cap[1] /* current capabilities */ 25185079Sjlemon#define ifr_index ifr_ifru.ifru_index /* interface index */ 2521541Srgrimes}; 2531541Srgrimes 25432491Swollman#define _SIZEOF_ADDR_IFREQ(ifr) \ 25532491Swollman ((ifr).ifr_addr.sa_len > sizeof(struct sockaddr) ? \ 25632491Swollman (sizeof(struct ifreq) - sizeof(struct sockaddr) + \ 25732491Swollman (ifr).ifr_addr.sa_len) : sizeof(struct ifreq)) 25832491Swollman 2591541Srgrimesstruct ifaliasreq { 2601541Srgrimes char ifra_name[IFNAMSIZ]; /* if name, e.g. "en0" */ 2611541Srgrimes struct sockaddr ifra_addr; 2621541Srgrimes struct sockaddr ifra_broadaddr; 2631541Srgrimes struct sockaddr ifra_mask; 2641541Srgrimes}; 2651541Srgrimes 26625434Speterstruct ifmediareq { 26725434Speter char ifm_name[IFNAMSIZ]; /* if name, e.g. "en0" */ 26825434Speter int ifm_current; /* current media options */ 26925434Speter int ifm_mask; /* don't care mask */ 27025434Speter int ifm_status; /* media status */ 27125434Speter int ifm_active; /* active options */ 27225434Speter int ifm_count; /* # entries in ifm_ulist array */ 27325434Speter int *ifm_ulist; /* media words */ 27425434Speter}; 27548021Sphk 27648021Sphk/* 27748021Sphk * Structure used to retrieve aux status data from interfaces. 27848589Sbde * Kernel suppliers to this interface should respect the formatting 27948021Sphk * needed by ifconfig(8): each line starts with a TAB and ends with 28048589Sbde * a newline. The canonical example to copy and paste is in if_tun.c. 28148021Sphk */ 28248021Sphk 28348589Sbde#define IFSTATMAX 800 /* 10 lines of text */ 28448021Sphkstruct ifstat { 28548589Sbde char ifs_name[IFNAMSIZ]; /* if name, e.g. "en0" */ 28648589Sbde char ascii[IFSTATMAX + 1]; 28748021Sphk}; 28848021Sphk 2891541Srgrimes/* 2901541Srgrimes * Structure used in SIOCGIFCONF request. 2911541Srgrimes * Used to retrieve interface configuration 2921541Srgrimes * for machine (useful for programs which 2931541Srgrimes * must know all networks accessible). 2941541Srgrimes */ 2951541Srgrimesstruct ifconf { 2961541Srgrimes int ifc_len; /* size of associated buffer */ 2971541Srgrimes union { 2981541Srgrimes caddr_t ifcu_buf; 2991541Srgrimes struct ifreq *ifcu_req; 3001541Srgrimes } ifc_ifcu; 3011541Srgrimes#define ifc_buf ifc_ifcu.ifcu_buf /* buffer address */ 3021541Srgrimes#define ifc_req ifc_ifcu.ifcu_req /* array of structures returned */ 3031541Srgrimes}; 3041541Srgrimes 30552904Sshin 30652904Sshin/* 30752904Sshin * Structure for SIOC[AGD]LIFADDR 30852904Sshin */ 30952904Sshinstruct if_laddrreq { 31052904Sshin char iflr_name[IFNAMSIZ]; 31152904Sshin u_int flags; 31252904Sshin#define IFLR_PREFIX 0x8000 /* in: prefix given out: kernel fills id */ 31352904Sshin u_int prefixlen; /* in/out */ 31452904Sshin struct sockaddr_storage addr; /* in/out */ 31552904Sshin struct sockaddr_storage dstaddr; /* out */ 31652904Sshin}; 31752904Sshin 31855205Speter#ifdef _KERNEL 31930354Sphk#ifdef MALLOC_DECLARE 32030354SphkMALLOC_DECLARE(M_IFADDR); 32130354SphkMALLOC_DECLARE(M_IFMADDR); 32230354Sphk#endif 32330354Sphk#endif 32430354Sphk 32555205Speter#ifndef _KERNEL 32652904Sshinstruct if_nameindex { 32752904Sshin u_int if_index; /* 1, 2, ... */ 32852904Sshin char *if_name; /* null terminated name: "le0", ... */ 32952904Sshin}; 33052904Sshin 33152904Sshin__BEGIN_DECLS 33252904Sshinu_int if_nametoindex __P((const char *)); 33352904Sshinchar *if_indextoname __P((u_int, char *)); 33452904Sshinstruct if_nameindex *if_nameindex __P((void)); 33552904Sshinvoid if_freenameindex __P((struct if_nameindex *)); 33652904Sshin__END_DECLS 33752904Sshin#endif 33852904Sshin 33955205Speter#ifdef _KERNEL 34083366Sjulianstruct thread; 34148589Sbde 34248589Sbde/* XXX - this should go away soon. */ 34321259Swollman#include <net/if_var.h> 3441541Srgrimes#endif 3451541Srgrimes 3464507Sbde#endif /* !_NET_IF_H_ */ 347