if.h revision 91647
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 91647 2002-03-04 21:43:49Z brooks $ 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 5879103Sbrooks 5979103Sbrooks/* 6079103Sbrooks * Structure describing a `cloning' interface. 6179103Sbrooks */ 6279103Sbrooksstruct if_clone { 6379103Sbrooks LIST_ENTRY(if_clone) ifc_list; /* on list of cloners */ 6479103Sbrooks const char *ifc_name; /* name of device, e.g. `gif' */ 6579103Sbrooks size_t ifc_namelen; /* length of name */ 6679103Sbrooks 6779103Sbrooks int (*ifc_create)(struct if_clone *, int *); 6891647Sbrooks int (*ifc_destroy)(struct ifnet *); 6979103Sbrooks}; 7079103Sbrooks 7179103Sbrooks#define IF_CLONE_INITIALIZER(name, create, destroy) \ 7279103Sbrooks { { 0 }, name, sizeof(name) - 1, create, destroy } 7379103Sbrooks 7479103Sbrooks/* 7579103Sbrooks * Structure used to query names of interface cloners. 7679103Sbrooks */ 7779103Sbrooks 7879103Sbrooksstruct if_clonereq { 7979103Sbrooks int ifcr_total; /* total cloners (out) */ 8079103Sbrooks int ifcr_count; /* room for this many in user buffer */ 8179103Sbrooks char *ifcr_buffer; /* buffer for cloner names */ 8279103Sbrooks}; 8379103Sbrooks 8479103Sbrooks/* 8519079Sfenner * Structure describing information about an interface 8619079Sfenner * which may be of interest to management entities. 8719079Sfenner */ 889457Sjoergstruct if_data { 899457Sjoerg /* generic interface information */ 909457Sjoerg u_char ifi_type; /* ethernet, tokenring, etc */ 919457Sjoerg u_char ifi_physical; /* e.g., AUI, Thinnet, 10base-T, etc */ 929457Sjoerg u_char ifi_addrlen; /* media address length */ 939457Sjoerg u_char ifi_hdrlen; /* media header length */ 9417352Swollman u_char ifi_recvquota; /* polling quota for receive intrs */ 9517352Swollman u_char ifi_xmitquota; /* polling quota for xmit intrs */ 969457Sjoerg u_long ifi_mtu; /* maximum transmission unit */ 979457Sjoerg u_long ifi_metric; /* routing metric (external only) */ 989457Sjoerg u_long ifi_baudrate; /* linespeed */ 999457Sjoerg /* volatile statistics */ 1009457Sjoerg u_long ifi_ipackets; /* packets received on interface */ 1019457Sjoerg u_long ifi_ierrors; /* input errors on interface */ 1029457Sjoerg u_long ifi_opackets; /* packets sent on interface */ 1039457Sjoerg u_long ifi_oerrors; /* output errors on interface */ 1049457Sjoerg u_long ifi_collisions; /* collisions on csma interfaces */ 1059457Sjoerg u_long ifi_ibytes; /* total number of octets received */ 1069457Sjoerg u_long ifi_obytes; /* total number of octets sent */ 1079457Sjoerg u_long ifi_imcasts; /* packets received via multicast */ 1089457Sjoerg u_long ifi_omcasts; /* packets sent via multicast */ 1099457Sjoerg u_long ifi_iqdrops; /* dropped on input, this interface */ 1109457Sjoerg u_long ifi_noproto; /* destined for unsupported protocol */ 11158698Sjlemon u_long ifi_hwassist; /* HW offload capabilities */ 11258698Sjlemon u_long ifi_unused; /* XXX was ifi_xmittiming */ 11316287Sgpalmer struct timeval ifi_lastchange; /* time of last administrative change */ 1149457Sjoerg}; 1159457Sjoerg 1161541Srgrimes#define IFF_UP 0x1 /* interface is up */ 1171541Srgrimes#define IFF_BROADCAST 0x2 /* broadcast address valid */ 1181541Srgrimes#define IFF_DEBUG 0x4 /* turn on debugging */ 1191541Srgrimes#define IFF_LOOPBACK 0x8 /* is a loopback net */ 1201541Srgrimes#define IFF_POINTOPOINT 0x10 /* interface is point-to-point link */ 12147777Sphk#define IFF_SMART 0x20 /* interface manages own routes */ 1221541Srgrimes#define IFF_RUNNING 0x40 /* resources allocated */ 1231541Srgrimes#define IFF_NOARP 0x80 /* no address resolution protocol */ 1241541Srgrimes#define IFF_PROMISC 0x100 /* receive all packets */ 1251541Srgrimes#define IFF_ALLMULTI 0x200 /* receive all multicast packets */ 1261541Srgrimes#define IFF_OACTIVE 0x400 /* transmission in progress */ 1271541Srgrimes#define IFF_SIMPLEX 0x800 /* can't hear own transmissions */ 1281541Srgrimes#define IFF_LINK0 0x1000 /* per link layer defined bit */ 1291541Srgrimes#define IFF_LINK1 0x2000 /* per link layer defined bit */ 1301541Srgrimes#define IFF_LINK2 0x4000 /* per link layer defined bit */ 1313274Swollman#define IFF_ALTPHYS IFF_LINK2 /* use alternate physical connection */ 1321541Srgrimes#define IFF_MULTICAST 0x8000 /* supports multicast */ 1331541Srgrimes 13487902Sluigi/* 13587902Sluigi * The following flag(s) ought to go in if_flags, but we cannot change 13687902Sluigi * struct ifnet because of binary compatibility, so we store them in 13787902Sluigi * if_ipending, which is not used so far. 13887902Sluigi * If possible, make sure the value is not conflicting with other 13987902Sluigi * IFF flags, so we have an easier time when we want to merge them. 14087902Sluigi */ 14187902Sluigi#define IFF_POLLING 0x10000 /* Interface is in polling mode. */ 14287902Sluigi 1431541Srgrimes/* flags set internally only: */ 1441541Srgrimes#define IFF_CANTCHANGE \ 1451541Srgrimes (IFF_BROADCAST|IFF_POINTOPOINT|IFF_RUNNING|IFF_OACTIVE|\ 14647777Sphk IFF_SIMPLEX|IFF_MULTICAST|IFF_ALLMULTI|IFF_SMART) 1471541Srgrimes 14883624Sjlemon/* Capabilities that interfaces can advertise. */ 14983636Sjlemon#define IFCAP_RXCSUM 0x0001 /* can offload checksum on RX */ 15083636Sjlemon#define IFCAP_TXCSUM 0x0002 /* can offload checksum on TX */ 15183636Sjlemon#define IFCAP_NETCONS 0x0004 /* can be a network console */ 15283624Sjlemon 15383636Sjlemon#define IFCAP_HWCSUM (IFCAP_RXCSUM | IFCAP_TXCSUM) 15483636Sjlemon 1551541Srgrimes#define IFQ_MAXLEN 50 1561541Srgrimes#define IFNET_SLOWHZ 1 /* granularity is 1 second */ 1571541Srgrimes 1581541Srgrimes/* 1591541Srgrimes * Message format for use in obtaining information about interfaces 1601541Srgrimes * from getkerninfo and the routing socket 1611541Srgrimes */ 1621541Srgrimesstruct if_msghdr { 1631541Srgrimes u_short ifm_msglen; /* to skip over non-understood messages */ 16472093Sasmodai u_char ifm_version; /* future binary compatibility */ 1651541Srgrimes u_char ifm_type; /* message type */ 1661541Srgrimes int ifm_addrs; /* like rtm_addrs */ 1671541Srgrimes int ifm_flags; /* value of if_flags */ 1681541Srgrimes u_short ifm_index; /* index for associated ifp */ 1691541Srgrimes struct if_data ifm_data;/* statistics and other data about if */ 1701541Srgrimes}; 1711541Srgrimes 1721541Srgrimes/* 1731541Srgrimes * Message format for use in obtaining information about interface addresses 1741541Srgrimes * from getkerninfo and the routing socket 1751541Srgrimes */ 1761541Srgrimesstruct ifa_msghdr { 1771541Srgrimes u_short ifam_msglen; /* to skip over non-understood messages */ 17872093Sasmodai u_char ifam_version; /* future binary compatibility */ 1791541Srgrimes u_char ifam_type; /* message type */ 1801541Srgrimes int ifam_addrs; /* like rtm_addrs */ 1811541Srgrimes int ifam_flags; /* value of ifa_flags */ 1821541Srgrimes u_short ifam_index; /* index for associated ifp */ 1831541Srgrimes int ifam_metric; /* value of ifa_metric */ 1841541Srgrimes}; 1851541Srgrimes 1861541Srgrimes/* 18721666Swollman * Message format for use in obtaining information about multicast addresses 18821666Swollman * from the routing socket 18921666Swollman */ 19021666Swollmanstruct ifma_msghdr { 19121666Swollman u_short ifmam_msglen; /* to skip over non-understood messages */ 19272093Sasmodai u_char ifmam_version; /* future binary compatibility */ 19321666Swollman u_char ifmam_type; /* message type */ 19421666Swollman int ifmam_addrs; /* like rtm_addrs */ 19521666Swollman int ifmam_flags; /* value of ifa_flags */ 19621666Swollman u_short ifmam_index; /* index for associated ifp */ 19721666Swollman}; 19821666Swollman 19921666Swollman/* 20089498Sru * Message format announcing the arrival or departure of a network interface. 20189498Sru */ 20289498Srustruct if_announcemsghdr { 20389498Sru u_short ifan_msglen; /* to skip over non-understood messages */ 20489498Sru u_char ifan_version; /* future binary compatibility */ 20589498Sru u_char ifan_type; /* message type */ 20689498Sru u_short ifan_index; /* index for associated ifp */ 20789498Sru char ifan_name[IFNAMSIZ]; /* if name, e.g. "en0" */ 20889498Sru u_short ifan_what; /* what type of announcement */ 20989498Sru}; 21089498Sru 21189498Sru#define IFAN_ARRIVAL 0 /* interface arrival */ 21289498Sru#define IFAN_DEPARTURE 1 /* interface departure */ 21389498Sru 21489498Sru/* 2151541Srgrimes * Interface request structure used for socket 2161541Srgrimes * ioctl's. All interface ioctl's must have parameter 2171541Srgrimes * definitions which begin with ifr_name. The 2181541Srgrimes * remainder may be interface specific. 2191541Srgrimes */ 2201541Srgrimesstruct ifreq { 2211541Srgrimes char ifr_name[IFNAMSIZ]; /* if name, e.g. "en0" */ 2221541Srgrimes union { 2231541Srgrimes struct sockaddr ifru_addr; 2241541Srgrimes struct sockaddr ifru_dstaddr; 2251541Srgrimes struct sockaddr ifru_broadaddr; 22644144Sphk short ifru_flags[2]; 22785079Sjlemon short ifru_index; 2281541Srgrimes int ifru_metric; 2291941Sdg int ifru_mtu; 2305184Swollman int ifru_phys; 23125434Speter int ifru_media; 2321541Srgrimes caddr_t ifru_data; 23383624Sjlemon int ifru_cap[2]; 2341541Srgrimes } ifr_ifru; 2351541Srgrimes#define ifr_addr ifr_ifru.ifru_addr /* address */ 2361541Srgrimes#define ifr_dstaddr ifr_ifru.ifru_dstaddr /* other end of p-to-p link */ 2371541Srgrimes#define ifr_broadaddr ifr_ifru.ifru_broadaddr /* broadcast address */ 23844144Sphk#define ifr_flags ifr_ifru.ifru_flags[0] /* flags */ 23944144Sphk#define ifr_prevflags ifr_ifru.ifru_flags[1] /* flags */ 2401541Srgrimes#define ifr_metric ifr_ifru.ifru_metric /* metric */ 2411941Sdg#define ifr_mtu ifr_ifru.ifru_mtu /* mtu */ 2425187Sdg#define ifr_phys ifr_ifru.ifru_phys /* physical wire */ 24325434Speter#define ifr_media ifr_ifru.ifru_media /* physical media */ 2441541Srgrimes#define ifr_data ifr_ifru.ifru_data /* for use by interface */ 24583624Sjlemon#define ifr_reqcap ifr_ifru.ifru_cap[0] /* requested capabilities */ 24683624Sjlemon#define ifr_curcap ifr_ifru.ifru_cap[1] /* current capabilities */ 24785079Sjlemon#define ifr_index ifr_ifru.ifru_index /* interface index */ 2481541Srgrimes}; 2491541Srgrimes 25032491Swollman#define _SIZEOF_ADDR_IFREQ(ifr) \ 25132491Swollman ((ifr).ifr_addr.sa_len > sizeof(struct sockaddr) ? \ 25232491Swollman (sizeof(struct ifreq) - sizeof(struct sockaddr) + \ 25332491Swollman (ifr).ifr_addr.sa_len) : sizeof(struct ifreq)) 25432491Swollman 2551541Srgrimesstruct ifaliasreq { 2561541Srgrimes char ifra_name[IFNAMSIZ]; /* if name, e.g. "en0" */ 2571541Srgrimes struct sockaddr ifra_addr; 2581541Srgrimes struct sockaddr ifra_broadaddr; 2591541Srgrimes struct sockaddr ifra_mask; 2601541Srgrimes}; 2611541Srgrimes 26225434Speterstruct ifmediareq { 26325434Speter char ifm_name[IFNAMSIZ]; /* if name, e.g. "en0" */ 26425434Speter int ifm_current; /* current media options */ 26525434Speter int ifm_mask; /* don't care mask */ 26625434Speter int ifm_status; /* media status */ 26725434Speter int ifm_active; /* active options */ 26825434Speter int ifm_count; /* # entries in ifm_ulist array */ 26925434Speter int *ifm_ulist; /* media words */ 27025434Speter}; 27148021Sphk 27248021Sphk/* 27348021Sphk * Structure used to retrieve aux status data from interfaces. 27448589Sbde * Kernel suppliers to this interface should respect the formatting 27548021Sphk * needed by ifconfig(8): each line starts with a TAB and ends with 27648589Sbde * a newline. The canonical example to copy and paste is in if_tun.c. 27748021Sphk */ 27848021Sphk 27948589Sbde#define IFSTATMAX 800 /* 10 lines of text */ 28048021Sphkstruct ifstat { 28148589Sbde char ifs_name[IFNAMSIZ]; /* if name, e.g. "en0" */ 28248589Sbde char ascii[IFSTATMAX + 1]; 28348021Sphk}; 28448021Sphk 2851541Srgrimes/* 2861541Srgrimes * Structure used in SIOCGIFCONF request. 2871541Srgrimes * Used to retrieve interface configuration 2881541Srgrimes * for machine (useful for programs which 2891541Srgrimes * must know all networks accessible). 2901541Srgrimes */ 2911541Srgrimesstruct ifconf { 2921541Srgrimes int ifc_len; /* size of associated buffer */ 2931541Srgrimes union { 2941541Srgrimes caddr_t ifcu_buf; 2951541Srgrimes struct ifreq *ifcu_req; 2961541Srgrimes } ifc_ifcu; 2971541Srgrimes#define ifc_buf ifc_ifcu.ifcu_buf /* buffer address */ 2981541Srgrimes#define ifc_req ifc_ifcu.ifcu_req /* array of structures returned */ 2991541Srgrimes}; 3001541Srgrimes 30152904Sshin 30252904Sshin/* 30352904Sshin * Structure for SIOC[AGD]LIFADDR 30452904Sshin */ 30552904Sshinstruct if_laddrreq { 30652904Sshin char iflr_name[IFNAMSIZ]; 30752904Sshin u_int flags; 30852904Sshin#define IFLR_PREFIX 0x8000 /* in: prefix given out: kernel fills id */ 30952904Sshin u_int prefixlen; /* in/out */ 31052904Sshin struct sockaddr_storage addr; /* in/out */ 31152904Sshin struct sockaddr_storage dstaddr; /* out */ 31252904Sshin}; 31352904Sshin 31455205Speter#ifdef _KERNEL 31530354Sphk#ifdef MALLOC_DECLARE 31630354SphkMALLOC_DECLARE(M_IFADDR); 31730354SphkMALLOC_DECLARE(M_IFMADDR); 31830354Sphk#endif 31930354Sphk#endif 32030354Sphk 32155205Speter#ifndef _KERNEL 32252904Sshinstruct if_nameindex { 32352904Sshin u_int if_index; /* 1, 2, ... */ 32452904Sshin char *if_name; /* null terminated name: "le0", ... */ 32552904Sshin}; 32652904Sshin 32752904Sshin__BEGIN_DECLS 32852904Sshinu_int if_nametoindex __P((const char *)); 32952904Sshinchar *if_indextoname __P((u_int, char *)); 33052904Sshinstruct if_nameindex *if_nameindex __P((void)); 33152904Sshinvoid if_freenameindex __P((struct if_nameindex *)); 33252904Sshin__END_DECLS 33352904Sshin#endif 33452904Sshin 33555205Speter#ifdef _KERNEL 33683366Sjulianstruct thread; 33748589Sbde 33848589Sbde/* XXX - this should go away soon. */ 33921259Swollman#include <net/if_var.h> 3401541Srgrimes#endif 3411541Srgrimes 3424507Sbde#endif /* !_NET_IF_H_ */ 343