if.h revision 97289
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 97289 2002-05-25 20:17:04Z brooks $ 351541Srgrimes */ 361541Srgrimes 372168Spaul#ifndef _NET_IF_H_ 384507Sbde#define _NET_IF_H_ 392168Spaul 4097024Siedowse#ifdef _KERNEL 4179103Sbrooks#include <sys/queue.h> 4297024Siedowse#endif 4379103Sbrooks 441541Srgrimes/* 4534750Speter * <net/if.h> does not depend on <sys/time.h> on most other systems. This 4672093Sasmodai * helps userland compatibility. (struct timeval ifi_lastchange) 4734750Speter */ 4855205Speter#ifndef _KERNEL 4934750Speter#include <sys/time.h> 5034750Speter#endif 5134750Speter 5279103Sbrooksstruct ifnet; 5379103Sbrooks 5434750Speter/* 5579103Sbrooks * Length of interface external name, including terminating '\0'. 5679103Sbrooks * Note: this is the same size as a generic device's external name. 5779103Sbrooks */ 5879103Sbrooks#define IFNAMSIZ 16 5979103Sbrooks#define IF_NAMESIZE IFNAMSIZ 6092081Smux#define IF_MAXUNIT 0x7fff /* ifp->if_unit is only 15 bits */ 6179103Sbrooks 6297024Siedowse#ifdef _KERNEL 6379103Sbrooks/* 6479103Sbrooks * Structure describing a `cloning' interface. 6579103Sbrooks */ 6679103Sbrooksstruct if_clone { 6779103Sbrooks LIST_ENTRY(if_clone) ifc_list; /* on list of cloners */ 6879103Sbrooks const char *ifc_name; /* name of device, e.g. `gif' */ 6979103Sbrooks size_t ifc_namelen; /* length of name */ 7097289Sbrooks int ifc_minifs; /* minimum number of interfaces */ 7192081Smux int ifc_maxunit; /* maximum unit number */ 7292081Smux unsigned char *ifc_units; /* bitmap to handle units */ 7392081Smux int ifc_bmlen; /* bitmap length */ 7479103Sbrooks 7592081Smux int (*ifc_create)(struct if_clone *, int); 7697289Sbrooks void (*ifc_destroy)(struct ifnet *); 7779103Sbrooks}; 7879103Sbrooks 7997289Sbrooks#define IF_CLONE_INITIALIZER(name, create, destroy, minifs, maxunit) \ 8097289Sbrooks { { 0 }, name, sizeof(name) - 1, minifs, maxunit, NULL, 0, create, destroy } 8197024Siedowse#endif 8279103Sbrooks 8379103Sbrooks/* 8479103Sbrooks * Structure used to query names of interface cloners. 8579103Sbrooks */ 8679103Sbrooks 8779103Sbrooksstruct if_clonereq { 8879103Sbrooks int ifcr_total; /* total cloners (out) */ 8979103Sbrooks int ifcr_count; /* room for this many in user buffer */ 9079103Sbrooks char *ifcr_buffer; /* buffer for cloner names */ 9179103Sbrooks}; 9279103Sbrooks 9379103Sbrooks/* 9419079Sfenner * Structure describing information about an interface 9519079Sfenner * which may be of interest to management entities. 9619079Sfenner */ 979457Sjoergstruct if_data { 989457Sjoerg /* generic interface information */ 999457Sjoerg u_char ifi_type; /* ethernet, tokenring, etc */ 1009457Sjoerg u_char ifi_physical; /* e.g., AUI, Thinnet, 10base-T, etc */ 1019457Sjoerg u_char ifi_addrlen; /* media address length */ 1029457Sjoerg u_char ifi_hdrlen; /* media header length */ 10317352Swollman u_char ifi_recvquota; /* polling quota for receive intrs */ 10417352Swollman u_char ifi_xmitquota; /* polling quota for xmit intrs */ 1059457Sjoerg u_long ifi_mtu; /* maximum transmission unit */ 1069457Sjoerg u_long ifi_metric; /* routing metric (external only) */ 1079457Sjoerg u_long ifi_baudrate; /* linespeed */ 1089457Sjoerg /* volatile statistics */ 1099457Sjoerg u_long ifi_ipackets; /* packets received on interface */ 1109457Sjoerg u_long ifi_ierrors; /* input errors on interface */ 1119457Sjoerg u_long ifi_opackets; /* packets sent on interface */ 1129457Sjoerg u_long ifi_oerrors; /* output errors on interface */ 1139457Sjoerg u_long ifi_collisions; /* collisions on csma interfaces */ 1149457Sjoerg u_long ifi_ibytes; /* total number of octets received */ 1159457Sjoerg u_long ifi_obytes; /* total number of octets sent */ 1169457Sjoerg u_long ifi_imcasts; /* packets received via multicast */ 1179457Sjoerg u_long ifi_omcasts; /* packets sent via multicast */ 1189457Sjoerg u_long ifi_iqdrops; /* dropped on input, this interface */ 1199457Sjoerg u_long ifi_noproto; /* destined for unsupported protocol */ 12058698Sjlemon u_long ifi_hwassist; /* HW offload capabilities */ 12158698Sjlemon u_long ifi_unused; /* XXX was ifi_xmittiming */ 12216287Sgpalmer struct timeval ifi_lastchange; /* time of last administrative change */ 1239457Sjoerg}; 1249457Sjoerg 1251541Srgrimes#define IFF_UP 0x1 /* interface is up */ 1261541Srgrimes#define IFF_BROADCAST 0x2 /* broadcast address valid */ 1271541Srgrimes#define IFF_DEBUG 0x4 /* turn on debugging */ 1281541Srgrimes#define IFF_LOOPBACK 0x8 /* is a loopback net */ 1291541Srgrimes#define IFF_POINTOPOINT 0x10 /* interface is point-to-point link */ 13047777Sphk#define IFF_SMART 0x20 /* interface manages own routes */ 1311541Srgrimes#define IFF_RUNNING 0x40 /* resources allocated */ 1321541Srgrimes#define IFF_NOARP 0x80 /* no address resolution protocol */ 1331541Srgrimes#define IFF_PROMISC 0x100 /* receive all packets */ 1341541Srgrimes#define IFF_ALLMULTI 0x200 /* receive all multicast packets */ 1351541Srgrimes#define IFF_OACTIVE 0x400 /* transmission in progress */ 1361541Srgrimes#define IFF_SIMPLEX 0x800 /* can't hear own transmissions */ 1371541Srgrimes#define IFF_LINK0 0x1000 /* per link layer defined bit */ 1381541Srgrimes#define IFF_LINK1 0x2000 /* per link layer defined bit */ 1391541Srgrimes#define IFF_LINK2 0x4000 /* per link layer defined bit */ 1403274Swollman#define IFF_ALTPHYS IFF_LINK2 /* use alternate physical connection */ 1411541Srgrimes#define IFF_MULTICAST 0x8000 /* supports multicast */ 1421541Srgrimes 14387902Sluigi/* 14487902Sluigi * The following flag(s) ought to go in if_flags, but we cannot change 14587902Sluigi * struct ifnet because of binary compatibility, so we store them in 14687902Sluigi * if_ipending, which is not used so far. 14787902Sluigi * If possible, make sure the value is not conflicting with other 14887902Sluigi * IFF flags, so we have an easier time when we want to merge them. 14987902Sluigi */ 15087902Sluigi#define IFF_POLLING 0x10000 /* Interface is in polling mode. */ 15187902Sluigi 1521541Srgrimes/* flags set internally only: */ 1531541Srgrimes#define IFF_CANTCHANGE \ 1541541Srgrimes (IFF_BROADCAST|IFF_POINTOPOINT|IFF_RUNNING|IFF_OACTIVE|\ 15547777Sphk IFF_SIMPLEX|IFF_MULTICAST|IFF_ALLMULTI|IFF_SMART) 1561541Srgrimes 15783624Sjlemon/* Capabilities that interfaces can advertise. */ 15883636Sjlemon#define IFCAP_RXCSUM 0x0001 /* can offload checksum on RX */ 15983636Sjlemon#define IFCAP_TXCSUM 0x0002 /* can offload checksum on TX */ 16083636Sjlemon#define IFCAP_NETCONS 0x0004 /* can be a network console */ 16183624Sjlemon 16283636Sjlemon#define IFCAP_HWCSUM (IFCAP_RXCSUM | IFCAP_TXCSUM) 16383636Sjlemon 1641541Srgrimes#define IFQ_MAXLEN 50 1651541Srgrimes#define IFNET_SLOWHZ 1 /* granularity is 1 second */ 1661541Srgrimes 1671541Srgrimes/* 1681541Srgrimes * Message format for use in obtaining information about interfaces 1691541Srgrimes * from getkerninfo and the routing socket 1701541Srgrimes */ 1711541Srgrimesstruct if_msghdr { 1721541Srgrimes u_short ifm_msglen; /* to skip over non-understood messages */ 17372093Sasmodai u_char ifm_version; /* future binary compatibility */ 1741541Srgrimes u_char ifm_type; /* message type */ 1751541Srgrimes int ifm_addrs; /* like rtm_addrs */ 1761541Srgrimes int ifm_flags; /* value of if_flags */ 1771541Srgrimes u_short ifm_index; /* index for associated ifp */ 1781541Srgrimes struct if_data ifm_data;/* statistics and other data about if */ 1791541Srgrimes}; 1801541Srgrimes 1811541Srgrimes/* 1821541Srgrimes * Message format for use in obtaining information about interface addresses 1831541Srgrimes * from getkerninfo and the routing socket 1841541Srgrimes */ 1851541Srgrimesstruct ifa_msghdr { 1861541Srgrimes u_short ifam_msglen; /* to skip over non-understood messages */ 18772093Sasmodai u_char ifam_version; /* future binary compatibility */ 1881541Srgrimes u_char ifam_type; /* message type */ 1891541Srgrimes int ifam_addrs; /* like rtm_addrs */ 1901541Srgrimes int ifam_flags; /* value of ifa_flags */ 1911541Srgrimes u_short ifam_index; /* index for associated ifp */ 1921541Srgrimes int ifam_metric; /* value of ifa_metric */ 1931541Srgrimes}; 1941541Srgrimes 1951541Srgrimes/* 19621666Swollman * Message format for use in obtaining information about multicast addresses 19721666Swollman * from the routing socket 19821666Swollman */ 19921666Swollmanstruct ifma_msghdr { 20021666Swollman u_short ifmam_msglen; /* to skip over non-understood messages */ 20172093Sasmodai u_char ifmam_version; /* future binary compatibility */ 20221666Swollman u_char ifmam_type; /* message type */ 20321666Swollman int ifmam_addrs; /* like rtm_addrs */ 20421666Swollman int ifmam_flags; /* value of ifa_flags */ 20521666Swollman u_short ifmam_index; /* index for associated ifp */ 20621666Swollman}; 20721666Swollman 20821666Swollman/* 20989498Sru * Message format announcing the arrival or departure of a network interface. 21089498Sru */ 21189498Srustruct if_announcemsghdr { 21289498Sru u_short ifan_msglen; /* to skip over non-understood messages */ 21389498Sru u_char ifan_version; /* future binary compatibility */ 21489498Sru u_char ifan_type; /* message type */ 21589498Sru u_short ifan_index; /* index for associated ifp */ 21689498Sru char ifan_name[IFNAMSIZ]; /* if name, e.g. "en0" */ 21789498Sru u_short ifan_what; /* what type of announcement */ 21889498Sru}; 21989498Sru 22089498Sru#define IFAN_ARRIVAL 0 /* interface arrival */ 22189498Sru#define IFAN_DEPARTURE 1 /* interface departure */ 22289498Sru 22389498Sru/* 2241541Srgrimes * Interface request structure used for socket 2251541Srgrimes * ioctl's. All interface ioctl's must have parameter 2261541Srgrimes * definitions which begin with ifr_name. The 2271541Srgrimes * remainder may be interface specific. 2281541Srgrimes */ 2291541Srgrimesstruct ifreq { 2301541Srgrimes char ifr_name[IFNAMSIZ]; /* if name, e.g. "en0" */ 2311541Srgrimes union { 2321541Srgrimes struct sockaddr ifru_addr; 2331541Srgrimes struct sockaddr ifru_dstaddr; 2341541Srgrimes struct sockaddr ifru_broadaddr; 23544144Sphk short ifru_flags[2]; 23685079Sjlemon short ifru_index; 2371541Srgrimes int ifru_metric; 2381941Sdg int ifru_mtu; 2395184Swollman int ifru_phys; 24025434Speter int ifru_media; 2411541Srgrimes caddr_t ifru_data; 24283624Sjlemon int ifru_cap[2]; 2431541Srgrimes } ifr_ifru; 2441541Srgrimes#define ifr_addr ifr_ifru.ifru_addr /* address */ 2451541Srgrimes#define ifr_dstaddr ifr_ifru.ifru_dstaddr /* other end of p-to-p link */ 2461541Srgrimes#define ifr_broadaddr ifr_ifru.ifru_broadaddr /* broadcast address */ 24744144Sphk#define ifr_flags ifr_ifru.ifru_flags[0] /* flags */ 24844144Sphk#define ifr_prevflags ifr_ifru.ifru_flags[1] /* flags */ 2491541Srgrimes#define ifr_metric ifr_ifru.ifru_metric /* metric */ 2501941Sdg#define ifr_mtu ifr_ifru.ifru_mtu /* mtu */ 2515187Sdg#define ifr_phys ifr_ifru.ifru_phys /* physical wire */ 25225434Speter#define ifr_media ifr_ifru.ifru_media /* physical media */ 2531541Srgrimes#define ifr_data ifr_ifru.ifru_data /* for use by interface */ 25483624Sjlemon#define ifr_reqcap ifr_ifru.ifru_cap[0] /* requested capabilities */ 25583624Sjlemon#define ifr_curcap ifr_ifru.ifru_cap[1] /* current capabilities */ 25685079Sjlemon#define ifr_index ifr_ifru.ifru_index /* interface index */ 2571541Srgrimes}; 2581541Srgrimes 25932491Swollman#define _SIZEOF_ADDR_IFREQ(ifr) \ 26032491Swollman ((ifr).ifr_addr.sa_len > sizeof(struct sockaddr) ? \ 26132491Swollman (sizeof(struct ifreq) - sizeof(struct sockaddr) + \ 26232491Swollman (ifr).ifr_addr.sa_len) : sizeof(struct ifreq)) 26332491Swollman 2641541Srgrimesstruct ifaliasreq { 2651541Srgrimes char ifra_name[IFNAMSIZ]; /* if name, e.g. "en0" */ 2661541Srgrimes struct sockaddr ifra_addr; 2671541Srgrimes struct sockaddr ifra_broadaddr; 2681541Srgrimes struct sockaddr ifra_mask; 2691541Srgrimes}; 2701541Srgrimes 27125434Speterstruct ifmediareq { 27225434Speter char ifm_name[IFNAMSIZ]; /* if name, e.g. "en0" */ 27325434Speter int ifm_current; /* current media options */ 27425434Speter int ifm_mask; /* don't care mask */ 27525434Speter int ifm_status; /* media status */ 27625434Speter int ifm_active; /* active options */ 27725434Speter int ifm_count; /* # entries in ifm_ulist array */ 27825434Speter int *ifm_ulist; /* media words */ 27925434Speter}; 28048021Sphk 28148021Sphk/* 28248021Sphk * Structure used to retrieve aux status data from interfaces. 28348589Sbde * Kernel suppliers to this interface should respect the formatting 28448021Sphk * needed by ifconfig(8): each line starts with a TAB and ends with 28548589Sbde * a newline. The canonical example to copy and paste is in if_tun.c. 28648021Sphk */ 28748021Sphk 28848589Sbde#define IFSTATMAX 800 /* 10 lines of text */ 28948021Sphkstruct ifstat { 29048589Sbde char ifs_name[IFNAMSIZ]; /* if name, e.g. "en0" */ 29148589Sbde char ascii[IFSTATMAX + 1]; 29248021Sphk}; 29348021Sphk 2941541Srgrimes/* 2951541Srgrimes * Structure used in SIOCGIFCONF request. 2961541Srgrimes * Used to retrieve interface configuration 2971541Srgrimes * for machine (useful for programs which 2981541Srgrimes * must know all networks accessible). 2991541Srgrimes */ 3001541Srgrimesstruct ifconf { 3011541Srgrimes int ifc_len; /* size of associated buffer */ 3021541Srgrimes union { 3031541Srgrimes caddr_t ifcu_buf; 3041541Srgrimes struct ifreq *ifcu_req; 3051541Srgrimes } ifc_ifcu; 3061541Srgrimes#define ifc_buf ifc_ifcu.ifcu_buf /* buffer address */ 3071541Srgrimes#define ifc_req ifc_ifcu.ifcu_req /* array of structures returned */ 3081541Srgrimes}; 3091541Srgrimes 31052904Sshin 31152904Sshin/* 31252904Sshin * Structure for SIOC[AGD]LIFADDR 31352904Sshin */ 31452904Sshinstruct if_laddrreq { 31552904Sshin char iflr_name[IFNAMSIZ]; 31652904Sshin u_int flags; 31752904Sshin#define IFLR_PREFIX 0x8000 /* in: prefix given out: kernel fills id */ 31852904Sshin u_int prefixlen; /* in/out */ 31952904Sshin struct sockaddr_storage addr; /* in/out */ 32052904Sshin struct sockaddr_storage dstaddr; /* out */ 32152904Sshin}; 32252904Sshin 32355205Speter#ifdef _KERNEL 32430354Sphk#ifdef MALLOC_DECLARE 32530354SphkMALLOC_DECLARE(M_IFADDR); 32630354SphkMALLOC_DECLARE(M_IFMADDR); 32730354Sphk#endif 32830354Sphk#endif 32930354Sphk 33055205Speter#ifndef _KERNEL 33152904Sshinstruct if_nameindex { 33252904Sshin u_int if_index; /* 1, 2, ... */ 33352904Sshin char *if_name; /* null terminated name: "le0", ... */ 33452904Sshin}; 33552904Sshin 33652904Sshin__BEGIN_DECLS 33792725Salfredu_int if_nametoindex(const char *); 33892725Salfredchar *if_indextoname(u_int, char *); 33992725Salfredstruct if_nameindex *if_nameindex(void); 34092725Salfredvoid if_freenameindex(struct if_nameindex *); 34152904Sshin__END_DECLS 34252904Sshin#endif 34352904Sshin 34455205Speter#ifdef _KERNEL 34583366Sjulianstruct thread; 34648589Sbde 34748589Sbde/* XXX - this should go away soon. */ 34821259Swollman#include <net/if_var.h> 3491541Srgrimes#endif 3501541Srgrimes 3514507Sbde#endif /* !_NET_IF_H_ */ 352