if.h revision 128113
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 * 4. Neither the name of the University nor the names of its contributors 141541Srgrimes * may be used to endorse or promote products derived from this software 151541Srgrimes * without specific prior written permission. 161541Srgrimes * 171541Srgrimes * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 181541Srgrimes * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 191541Srgrimes * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 201541Srgrimes * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 211541Srgrimes * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 221541Srgrimes * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 231541Srgrimes * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 241541Srgrimes * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 251541Srgrimes * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 261541Srgrimes * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 271541Srgrimes * SUCH DAMAGE. 281541Srgrimes * 291541Srgrimes * @(#)if.h 8.1 (Berkeley) 6/10/93 3050477Speter * $FreeBSD: head/sys/net/if.h 128113 2004-04-11 13:36:52Z ru $ 311541Srgrimes */ 321541Srgrimes 332168Spaul#ifndef _NET_IF_H_ 344507Sbde#define _NET_IF_H_ 352168Spaul 36104355Smike#include <sys/cdefs.h> 37104355Smike 3897024Siedowse#ifdef _KERNEL 3979103Sbrooks#include <sys/queue.h> 4097024Siedowse#endif 4179103Sbrooks 42104355Smike#if __BSD_VISIBLE 431541Srgrimes/* 4434750Speter * <net/if.h> does not depend on <sys/time.h> on most other systems. This 4572093Sasmodai * helps userland compatibility. (struct timeval ifi_lastchange) 4634750Speter */ 4755205Speter#ifndef _KERNEL 4834750Speter#include <sys/time.h> 4934750Speter#endif 5034750Speter 5179103Sbrooksstruct ifnet; 52104355Smike#endif 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 */ 58104355Smike#define IF_NAMESIZE 16 59104355Smike#if __BSD_VISIBLE 60104355Smike#define IFNAMSIZ IF_NAMESIZE 61121816Sbrooks#define IF_MAXUNIT 0x7fff /* historical value */ 62104355Smike#endif 6379103Sbrooks 6497024Siedowse#ifdef _KERNEL 6579103Sbrooks/* 6679103Sbrooks * Structure describing a `cloning' interface. 6779103Sbrooks */ 6879103Sbrooksstruct if_clone { 6979103Sbrooks LIST_ENTRY(if_clone) ifc_list; /* on list of cloners */ 7079103Sbrooks const char *ifc_name; /* name of device, e.g. `gif' */ 7179103Sbrooks size_t ifc_namelen; /* length of name */ 7297289Sbrooks int ifc_minifs; /* minimum number of interfaces */ 7392081Smux int ifc_maxunit; /* maximum unit number */ 7492081Smux unsigned char *ifc_units; /* bitmap to handle units */ 7592081Smux int ifc_bmlen; /* bitmap length */ 7679103Sbrooks 7792081Smux int (*ifc_create)(struct if_clone *, int); 7897289Sbrooks void (*ifc_destroy)(struct ifnet *); 7979103Sbrooks}; 8079103Sbrooks 8197289Sbrooks#define IF_CLONE_INITIALIZER(name, create, destroy, minifs, maxunit) \ 8297289Sbrooks { { 0 }, name, sizeof(name) - 1, minifs, maxunit, NULL, 0, create, destroy } 8397024Siedowse#endif 8479103Sbrooks 85104355Smike#if __BSD_VISIBLE 86104355Smike 8779103Sbrooks/* 8879103Sbrooks * Structure used to query names of interface cloners. 8979103Sbrooks */ 9079103Sbrooks 9179103Sbrooksstruct if_clonereq { 9279103Sbrooks int ifcr_total; /* total cloners (out) */ 9379103Sbrooks int ifcr_count; /* room for this many in user buffer */ 9479103Sbrooks char *ifcr_buffer; /* buffer for cloner names */ 9579103Sbrooks}; 9679103Sbrooks 9779103Sbrooks/* 9819079Sfenner * Structure describing information about an interface 9919079Sfenner * which may be of interest to management entities. 10019079Sfenner */ 1019457Sjoergstruct if_data { 1029457Sjoerg /* generic interface information */ 1039457Sjoerg u_char ifi_type; /* ethernet, tokenring, etc */ 1049457Sjoerg u_char ifi_physical; /* e.g., AUI, Thinnet, 10base-T, etc */ 1059457Sjoerg u_char ifi_addrlen; /* media address length */ 1069457Sjoerg u_char ifi_hdrlen; /* media header length */ 10717352Swollman u_char ifi_recvquota; /* polling quota for receive intrs */ 10817352Swollman u_char ifi_xmitquota; /* polling quota for xmit intrs */ 1099457Sjoerg u_long ifi_mtu; /* maximum transmission unit */ 1109457Sjoerg u_long ifi_metric; /* routing metric (external only) */ 1119457Sjoerg u_long ifi_baudrate; /* linespeed */ 1129457Sjoerg /* volatile statistics */ 1139457Sjoerg u_long ifi_ipackets; /* packets received on interface */ 1149457Sjoerg u_long ifi_ierrors; /* input errors on interface */ 1159457Sjoerg u_long ifi_opackets; /* packets sent on interface */ 1169457Sjoerg u_long ifi_oerrors; /* output errors on interface */ 1179457Sjoerg u_long ifi_collisions; /* collisions on csma interfaces */ 1189457Sjoerg u_long ifi_ibytes; /* total number of octets received */ 1199457Sjoerg u_long ifi_obytes; /* total number of octets sent */ 1209457Sjoerg u_long ifi_imcasts; /* packets received via multicast */ 1219457Sjoerg u_long ifi_omcasts; /* packets sent via multicast */ 1229457Sjoerg u_long ifi_iqdrops; /* dropped on input, this interface */ 1239457Sjoerg u_long ifi_noproto; /* destined for unsupported protocol */ 12458698Sjlemon u_long ifi_hwassist; /* HW offload capabilities */ 12558698Sjlemon u_long ifi_unused; /* XXX was ifi_xmittiming */ 12616287Sgpalmer struct timeval ifi_lastchange; /* time of last administrative change */ 1279457Sjoerg}; 1289457Sjoerg 1291541Srgrimes#define IFF_UP 0x1 /* interface is up */ 1301541Srgrimes#define IFF_BROADCAST 0x2 /* broadcast address valid */ 1311541Srgrimes#define IFF_DEBUG 0x4 /* turn on debugging */ 1321541Srgrimes#define IFF_LOOPBACK 0x8 /* is a loopback net */ 1331541Srgrimes#define IFF_POINTOPOINT 0x10 /* interface is point-to-point link */ 13447777Sphk#define IFF_SMART 0x20 /* interface manages own routes */ 1351541Srgrimes#define IFF_RUNNING 0x40 /* resources allocated */ 1361541Srgrimes#define IFF_NOARP 0x80 /* no address resolution protocol */ 1371541Srgrimes#define IFF_PROMISC 0x100 /* receive all packets */ 1381541Srgrimes#define IFF_ALLMULTI 0x200 /* receive all multicast packets */ 1391541Srgrimes#define IFF_OACTIVE 0x400 /* transmission in progress */ 1401541Srgrimes#define IFF_SIMPLEX 0x800 /* can't hear own transmissions */ 1411541Srgrimes#define IFF_LINK0 0x1000 /* per link layer defined bit */ 1421541Srgrimes#define IFF_LINK1 0x2000 /* per link layer defined bit */ 1431541Srgrimes#define IFF_LINK2 0x4000 /* per link layer defined bit */ 1443274Swollman#define IFF_ALTPHYS IFF_LINK2 /* use alternate physical connection */ 1451541Srgrimes#define IFF_MULTICAST 0x8000 /* supports multicast */ 14687902Sluigi#define IFF_POLLING 0x10000 /* Interface is in polling mode. */ 147102099Ssobomax#define IFF_PPROMISC 0x20000 /* user-requested promisc mode */ 148104044Sphk#define IFF_MONITOR 0x40000 /* user-requested monitor mode */ 149120626Sru#define IFF_STATICARP 0x80000 /* static ARP */ 15087902Sluigi 1511541Srgrimes/* flags set internally only: */ 1521541Srgrimes#define IFF_CANTCHANGE \ 1531541Srgrimes (IFF_BROADCAST|IFF_POINTOPOINT|IFF_RUNNING|IFF_OACTIVE|\ 154102526Ssobomax IFF_SIMPLEX|IFF_MULTICAST|IFF_ALLMULTI|IFF_SMART|IFF_PROMISC|\ 155102526Ssobomax IFF_POLLING) 1561541Srgrimes 157106925Ssam/* 158106925Ssam * Some convenience macros used for setting ifi_baudrate. 159106925Ssam * XXX 1000 vs. 1024? --thorpej@netbsd.org 160106925Ssam */ 161106925Ssam#define IF_Kbps(x) ((x) * 1000) /* kilobits/sec. */ 162106925Ssam#define IF_Mbps(x) (IF_Kbps((x) * 1000)) /* megabits/sec. */ 163106925Ssam#define IF_Gbps(x) (IF_Mbps((x) * 1000)) /* gigabits/sec. */ 164106925Ssam 16583624Sjlemon/* Capabilities that interfaces can advertise. */ 16683636Sjlemon#define IFCAP_RXCSUM 0x0001 /* can offload checksum on RX */ 16783636Sjlemon#define IFCAP_TXCSUM 0x0002 /* can offload checksum on TX */ 16883636Sjlemon#define IFCAP_NETCONS 0x0004 /* can be a network console */ 169106925Ssam#define IFCAP_VLAN_MTU 0x0008 /* VLAN-compatible MTU */ 170106925Ssam#define IFCAP_VLAN_HWTAGGING 0x0010 /* hardware VLAN tag support */ 171106925Ssam#define IFCAP_JUMBO_MTU 0x0020 /* 9000 byte MTU supported */ 172128113Sru#define IFCAP_POLLING 0x0040 /* driver supports polling */ 17383624Sjlemon 17483636Sjlemon#define IFCAP_HWCSUM (IFCAP_RXCSUM | IFCAP_TXCSUM) 17583636Sjlemon 1761541Srgrimes#define IFQ_MAXLEN 50 1771541Srgrimes#define IFNET_SLOWHZ 1 /* granularity is 1 second */ 1781541Srgrimes 1791541Srgrimes/* 1801541Srgrimes * Message format for use in obtaining information about interfaces 1811541Srgrimes * from getkerninfo and the routing socket 1821541Srgrimes */ 1831541Srgrimesstruct if_msghdr { 1841541Srgrimes u_short ifm_msglen; /* to skip over non-understood messages */ 18572093Sasmodai u_char ifm_version; /* future binary compatibility */ 1861541Srgrimes u_char ifm_type; /* message type */ 1871541Srgrimes int ifm_addrs; /* like rtm_addrs */ 1881541Srgrimes int ifm_flags; /* value of if_flags */ 1891541Srgrimes u_short ifm_index; /* index for associated ifp */ 1901541Srgrimes struct if_data ifm_data;/* statistics and other data about if */ 1911541Srgrimes}; 1921541Srgrimes 1931541Srgrimes/* 1941541Srgrimes * Message format for use in obtaining information about interface addresses 1951541Srgrimes * from getkerninfo and the routing socket 1961541Srgrimes */ 1971541Srgrimesstruct ifa_msghdr { 1981541Srgrimes u_short ifam_msglen; /* to skip over non-understood messages */ 19972093Sasmodai u_char ifam_version; /* future binary compatibility */ 2001541Srgrimes u_char ifam_type; /* message type */ 2011541Srgrimes int ifam_addrs; /* like rtm_addrs */ 2021541Srgrimes int ifam_flags; /* value of ifa_flags */ 2031541Srgrimes u_short ifam_index; /* index for associated ifp */ 2041541Srgrimes int ifam_metric; /* value of ifa_metric */ 2051541Srgrimes}; 2061541Srgrimes 2071541Srgrimes/* 20821666Swollman * Message format for use in obtaining information about multicast addresses 20921666Swollman * from the routing socket 21021666Swollman */ 21121666Swollmanstruct ifma_msghdr { 21221666Swollman u_short ifmam_msglen; /* to skip over non-understood messages */ 21372093Sasmodai u_char ifmam_version; /* future binary compatibility */ 21421666Swollman u_char ifmam_type; /* message type */ 21521666Swollman int ifmam_addrs; /* like rtm_addrs */ 21621666Swollman int ifmam_flags; /* value of ifa_flags */ 21721666Swollman u_short ifmam_index; /* index for associated ifp */ 21821666Swollman}; 21921666Swollman 22021666Swollman/* 22189498Sru * Message format announcing the arrival or departure of a network interface. 22289498Sru */ 22389498Srustruct if_announcemsghdr { 22489498Sru u_short ifan_msglen; /* to skip over non-understood messages */ 22589498Sru u_char ifan_version; /* future binary compatibility */ 22689498Sru u_char ifan_type; /* message type */ 22789498Sru u_short ifan_index; /* index for associated ifp */ 22889498Sru char ifan_name[IFNAMSIZ]; /* if name, e.g. "en0" */ 22989498Sru u_short ifan_what; /* what type of announcement */ 23089498Sru}; 23189498Sru 23289498Sru#define IFAN_ARRIVAL 0 /* interface arrival */ 23389498Sru#define IFAN_DEPARTURE 1 /* interface departure */ 23489498Sru 23589498Sru/* 2361541Srgrimes * Interface request structure used for socket 2371541Srgrimes * ioctl's. All interface ioctl's must have parameter 2381541Srgrimes * definitions which begin with ifr_name. The 2391541Srgrimes * remainder may be interface specific. 2401541Srgrimes */ 2411541Srgrimesstruct ifreq { 2421541Srgrimes char ifr_name[IFNAMSIZ]; /* if name, e.g. "en0" */ 2431541Srgrimes union { 2441541Srgrimes struct sockaddr ifru_addr; 2451541Srgrimes struct sockaddr ifru_dstaddr; 2461541Srgrimes struct sockaddr ifru_broadaddr; 24744144Sphk short ifru_flags[2]; 24885079Sjlemon short ifru_index; 2491541Srgrimes int ifru_metric; 2501941Sdg int ifru_mtu; 2515184Swollman int ifru_phys; 25225434Speter int ifru_media; 2531541Srgrimes caddr_t ifru_data; 25483624Sjlemon int ifru_cap[2]; 2551541Srgrimes } ifr_ifru; 2561541Srgrimes#define ifr_addr ifr_ifru.ifru_addr /* address */ 2571541Srgrimes#define ifr_dstaddr ifr_ifru.ifru_dstaddr /* other end of p-to-p link */ 2581541Srgrimes#define ifr_broadaddr ifr_ifru.ifru_broadaddr /* broadcast address */ 259102052Ssobomax#define ifr_flags ifr_ifru.ifru_flags[0] /* flags (low 16 bits) */ 260102052Ssobomax#define ifr_flagshigh ifr_ifru.ifru_flags[1] /* flags (high 16 bits) */ 2611541Srgrimes#define ifr_metric ifr_ifru.ifru_metric /* metric */ 2621941Sdg#define ifr_mtu ifr_ifru.ifru_mtu /* mtu */ 2635187Sdg#define ifr_phys ifr_ifru.ifru_phys /* physical wire */ 26425434Speter#define ifr_media ifr_ifru.ifru_media /* physical media */ 2651541Srgrimes#define ifr_data ifr_ifru.ifru_data /* for use by interface */ 26683624Sjlemon#define ifr_reqcap ifr_ifru.ifru_cap[0] /* requested capabilities */ 26783624Sjlemon#define ifr_curcap ifr_ifru.ifru_cap[1] /* current capabilities */ 26885079Sjlemon#define ifr_index ifr_ifru.ifru_index /* interface index */ 2691541Srgrimes}; 2701541Srgrimes 27132491Swollman#define _SIZEOF_ADDR_IFREQ(ifr) \ 27232491Swollman ((ifr).ifr_addr.sa_len > sizeof(struct sockaddr) ? \ 27332491Swollman (sizeof(struct ifreq) - sizeof(struct sockaddr) + \ 27432491Swollman (ifr).ifr_addr.sa_len) : sizeof(struct ifreq)) 27532491Swollman 2761541Srgrimesstruct ifaliasreq { 2771541Srgrimes char ifra_name[IFNAMSIZ]; /* if name, e.g. "en0" */ 2781541Srgrimes struct sockaddr ifra_addr; 2791541Srgrimes struct sockaddr ifra_broadaddr; 2801541Srgrimes struct sockaddr ifra_mask; 2811541Srgrimes}; 2821541Srgrimes 28325434Speterstruct ifmediareq { 28425434Speter char ifm_name[IFNAMSIZ]; /* if name, e.g. "en0" */ 28525434Speter int ifm_current; /* current media options */ 28625434Speter int ifm_mask; /* don't care mask */ 28725434Speter int ifm_status; /* media status */ 28825434Speter int ifm_active; /* active options */ 28925434Speter int ifm_count; /* # entries in ifm_ulist array */ 29025434Speter int *ifm_ulist; /* media words */ 29125434Speter}; 29248021Sphk 29348021Sphk/* 29448021Sphk * Structure used to retrieve aux status data from interfaces. 29548589Sbde * Kernel suppliers to this interface should respect the formatting 29648021Sphk * needed by ifconfig(8): each line starts with a TAB and ends with 29748589Sbde * a newline. The canonical example to copy and paste is in if_tun.c. 29848021Sphk */ 29948021Sphk 30048589Sbde#define IFSTATMAX 800 /* 10 lines of text */ 30148021Sphkstruct ifstat { 30248589Sbde char ifs_name[IFNAMSIZ]; /* if name, e.g. "en0" */ 30348589Sbde char ascii[IFSTATMAX + 1]; 30448021Sphk}; 30548021Sphk 3061541Srgrimes/* 3071541Srgrimes * Structure used in SIOCGIFCONF request. 3081541Srgrimes * Used to retrieve interface configuration 3091541Srgrimes * for machine (useful for programs which 3101541Srgrimes * must know all networks accessible). 3111541Srgrimes */ 3121541Srgrimesstruct ifconf { 3131541Srgrimes int ifc_len; /* size of associated buffer */ 3141541Srgrimes union { 3151541Srgrimes caddr_t ifcu_buf; 3161541Srgrimes struct ifreq *ifcu_req; 3171541Srgrimes } ifc_ifcu; 3181541Srgrimes#define ifc_buf ifc_ifcu.ifcu_buf /* buffer address */ 3191541Srgrimes#define ifc_req ifc_ifcu.ifcu_req /* array of structures returned */ 3201541Srgrimes}; 3211541Srgrimes 32252904Sshin 32352904Sshin/* 32452904Sshin * Structure for SIOC[AGD]LIFADDR 32552904Sshin */ 32652904Sshinstruct if_laddrreq { 32752904Sshin char iflr_name[IFNAMSIZ]; 32852904Sshin u_int flags; 32952904Sshin#define IFLR_PREFIX 0x8000 /* in: prefix given out: kernel fills id */ 33052904Sshin u_int prefixlen; /* in/out */ 33152904Sshin struct sockaddr_storage addr; /* in/out */ 33252904Sshin struct sockaddr_storage dstaddr; /* out */ 33352904Sshin}; 33452904Sshin 335104355Smike#endif /* __BSD_VISIBLE */ 336104355Smike 33755205Speter#ifdef _KERNEL 33830354Sphk#ifdef MALLOC_DECLARE 33930354SphkMALLOC_DECLARE(M_IFADDR); 34030354SphkMALLOC_DECLARE(M_IFMADDR); 34130354Sphk#endif 34230354Sphk#endif 34330354Sphk 34455205Speter#ifndef _KERNEL 34552904Sshinstruct if_nameindex { 346104355Smike unsigned int if_index; /* 1, 2, ... */ 347104360Smike char *if_name; /* null terminated name: "le0", ... */ 34852904Sshin}; 34952904Sshin 35052904Sshin__BEGIN_DECLS 351104360Smikevoid if_freenameindex(struct if_nameindex *); 352104360Smikechar *if_indextoname(unsigned int, char *); 353104360Smikestruct if_nameindex *if_nameindex(void); 354104360Smikeunsigned int if_nametoindex(const char *); 35552904Sshin__END_DECLS 35652904Sshin#endif 35752904Sshin 35855205Speter#ifdef _KERNEL 35983366Sjulianstruct thread; 36048589Sbde 36148589Sbde/* XXX - this should go away soon. */ 36221259Swollman#include <net/if_var.h> 3631541Srgrimes#endif 3641541Srgrimes 3654507Sbde#endif /* !_NET_IF_H_ */ 366