if.h revision 148894
1139823Simp/*- 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 148894 2005-08-09 12:56:20Z rwatson $ 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 63104355Smike#if __BSD_VISIBLE 64104355Smike 6579103Sbrooks/* 6679103Sbrooks * Structure used to query names of interface cloners. 6779103Sbrooks */ 6879103Sbrooks 6979103Sbrooksstruct if_clonereq { 7079103Sbrooks int ifcr_total; /* total cloners (out) */ 7179103Sbrooks int ifcr_count; /* room for this many in user buffer */ 7279103Sbrooks char *ifcr_buffer; /* buffer for cloner names */ 7379103Sbrooks}; 7479103Sbrooks 7579103Sbrooks/* 7619079Sfenner * Structure describing information about an interface 7719079Sfenner * which may be of interest to management entities. 7819079Sfenner */ 799457Sjoergstruct if_data { 809457Sjoerg /* generic interface information */ 819457Sjoerg u_char ifi_type; /* ethernet, tokenring, etc */ 829457Sjoerg u_char ifi_physical; /* e.g., AUI, Thinnet, 10base-T, etc */ 839457Sjoerg u_char ifi_addrlen; /* media address length */ 849457Sjoerg u_char ifi_hdrlen; /* media header length */ 85128871Sandre u_char ifi_link_state; /* current link state */ 8617352Swollman u_char ifi_recvquota; /* polling quota for receive intrs */ 8717352Swollman u_char ifi_xmitquota; /* polling quota for xmit intrs */ 88134609Sbrooks u_char ifi_datalen; /* length of this data struct */ 899457Sjoerg u_long ifi_mtu; /* maximum transmission unit */ 909457Sjoerg u_long ifi_metric; /* routing metric (external only) */ 919457Sjoerg u_long ifi_baudrate; /* linespeed */ 929457Sjoerg /* volatile statistics */ 939457Sjoerg u_long ifi_ipackets; /* packets received on interface */ 949457Sjoerg u_long ifi_ierrors; /* input errors on interface */ 959457Sjoerg u_long ifi_opackets; /* packets sent on interface */ 969457Sjoerg u_long ifi_oerrors; /* output errors on interface */ 979457Sjoerg u_long ifi_collisions; /* collisions on csma interfaces */ 989457Sjoerg u_long ifi_ibytes; /* total number of octets received */ 999457Sjoerg u_long ifi_obytes; /* total number of octets sent */ 1009457Sjoerg u_long ifi_imcasts; /* packets received via multicast */ 1019457Sjoerg u_long ifi_omcasts; /* packets sent via multicast */ 1029457Sjoerg u_long ifi_iqdrops; /* dropped on input, this interface */ 1039457Sjoerg u_long ifi_noproto; /* destined for unsupported protocol */ 10458698Sjlemon u_long ifi_hwassist; /* HW offload capabilities */ 105142501Sbrooks time_t ifi_epoch; /* uptime at attach or stat reset */ 106134933Sbrooks#ifdef __alpha__ 107134933Sbrooks u_int ifi_timepad; /* time_t is int, not long on alpha */ 108134933Sbrooks#endif 10916287Sgpalmer struct timeval ifi_lastchange; /* time of last administrative change */ 1109457Sjoerg}; 1119457Sjoerg 112148894Srwatson/*- 113148886Srwatson * Interface flags are of two types: network stack owned flags, and driver 114148886Srwatson * owned flags. Historically, these values were stored in the same ifnet 115148886Srwatson * flags field, but with the advent of fine-grained locking, they have been 116148886Srwatson * broken out such that the network stack is responsible for synchronizing 117148886Srwatson * the stack-owned fields, and the device driver the device-owned fields. 118148886Srwatson * Both halves can perform lockless reads of the other half's field, subject 119148886Srwatson * to accepting the involved races. 120148886Srwatson * 121148886Srwatson * Both sets of flags come from the same number space, and should not be 122148886Srwatson * permitted to conflict, as they are exposed to user space via a single 123148886Srwatson * field. 124148886Srwatson * 125148894Srwatson * The following symbols identify read and write requirements for fields: 126148894Srwatson * 127148894Srwatson * (i) if_flags field set by device driver before attach, read-only there 128148894Srwatson * after. 129148894Srwatson * (n) if_flags field written only by the network stack, read by either the 130148894Srwatson * stack or driver. 131148894Srwatson * (d) if_drv_flags field written only by the device driver, read by either 132148894Srwatson * the stack or driver. 133148886Srwatson */ 134148894Srwatson#define IFF_UP 0x1 /* (n) interface is up */ 135148894Srwatson#define IFF_BROADCAST 0x2 /* (i) broadcast address valid */ 136148894Srwatson#define IFF_DEBUG 0x4 /* (n) turn on debugging */ 137148894Srwatson#define IFF_LOOPBACK 0x8 /* (i) is a loopback net */ 138148894Srwatson#define IFF_POINTOPOINT 0x10 /* (i) is a point-to-point link */ 139148894Srwatson#define IFF_SMART 0x20 /* (i) interface manages own routes */ 140148894Srwatson#define IFF_DRV_RUNNING 0x40 /* (d) resources allocated */ 141148894Srwatson#define IFF_NOARP 0x80 /* (n) no address resolution protocol */ 142148894Srwatson#define IFF_PROMISC 0x100 /* (n) receive all packets */ 143148894Srwatson#define IFF_ALLMULTI 0x200 /* (n) receive all multicast packets */ 144148894Srwatson#define IFF_DRV_OACTIVE 0x400 /* (d) tx hardware queue is full */ 145148894Srwatson#define IFF_SIMPLEX 0x800 /* (i) can't hear own transmissions */ 1461541Srgrimes#define IFF_LINK0 0x1000 /* per link layer defined bit */ 1471541Srgrimes#define IFF_LINK1 0x2000 /* per link layer defined bit */ 1481541Srgrimes#define IFF_LINK2 0x4000 /* per link layer defined bit */ 1493274Swollman#define IFF_ALTPHYS IFF_LINK2 /* use alternate physical connection */ 150148894Srwatson#define IFF_MULTICAST 0x8000 /* (i) supports multicast */ 151148894Srwatson#define IFF_POLLING 0x10000 /* (n) Interface is in polling mode. */ 152148894Srwatson#define IFF_PPROMISC 0x20000 /* (n) user-requested promisc mode */ 153148894Srwatson#define IFF_MONITOR 0x40000 /* (n) user-requested monitor mode */ 154148894Srwatson#define IFF_STATICARP 0x80000 /* (n) static ARP */ 155148894Srwatson#define IFF_NEEDSGIANT 0x100000 /* (i) hold Giant over if_start calls */ 15687902Sluigi 157148886Srwatson/* 158148886Srwatson * Old names for driver flags so that user space tools can continue to use 159148894Srwatson * the old (portable) names. 160148886Srwatson */ 161148886Srwatson#ifndef _KERNEL 162148886Srwatson#define IFF_RUNNING IFF_DRV_RUNNING 163148886Srwatson#define IFF_OACTIVE IFF_DRV_OACTIVE 164148886Srwatson#endif 165148886Srwatson 1661541Srgrimes/* flags set internally only: */ 1671541Srgrimes#define IFF_CANTCHANGE \ 168148886Srwatson (IFF_BROADCAST|IFF_POINTOPOINT|IFF_DRV_RUNNING|IFF_DRV_OACTIVE|\ 169102526Ssobomax IFF_SIMPLEX|IFF_MULTICAST|IFF_ALLMULTI|IFF_SMART|IFF_PROMISC|\ 170102526Ssobomax IFF_POLLING) 1711541Srgrimes 172106925Ssam/* 173128871Sandre * Values for if_link_state. 174128871Sandre */ 175128871Sandre#define LINK_STATE_UNKNOWN 0 /* link invalid/unknown */ 176128871Sandre#define LINK_STATE_DOWN 1 /* link is down */ 177128871Sandre#define LINK_STATE_UP 2 /* link is up */ 178128871Sandre 179128871Sandre/* 180106925Ssam * Some convenience macros used for setting ifi_baudrate. 181106925Ssam * XXX 1000 vs. 1024? --thorpej@netbsd.org 182106925Ssam */ 183106925Ssam#define IF_Kbps(x) ((x) * 1000) /* kilobits/sec. */ 184106925Ssam#define IF_Mbps(x) (IF_Kbps((x) * 1000)) /* megabits/sec. */ 185106925Ssam#define IF_Gbps(x) (IF_Mbps((x) * 1000)) /* gigabits/sec. */ 186106925Ssam 18783624Sjlemon/* Capabilities that interfaces can advertise. */ 18883636Sjlemon#define IFCAP_RXCSUM 0x0001 /* can offload checksum on RX */ 18983636Sjlemon#define IFCAP_TXCSUM 0x0002 /* can offload checksum on TX */ 19083636Sjlemon#define IFCAP_NETCONS 0x0004 /* can be a network console */ 191106925Ssam#define IFCAP_VLAN_MTU 0x0008 /* VLAN-compatible MTU */ 192106925Ssam#define IFCAP_VLAN_HWTAGGING 0x0010 /* hardware VLAN tag support */ 193106925Ssam#define IFCAP_JUMBO_MTU 0x0020 /* 9000 byte MTU supported */ 194128113Sru#define IFCAP_POLLING 0x0040 /* driver supports polling */ 19583624Sjlemon 19683636Sjlemon#define IFCAP_HWCSUM (IFCAP_RXCSUM | IFCAP_TXCSUM) 19783636Sjlemon 1981541Srgrimes#define IFQ_MAXLEN 50 1991541Srgrimes#define IFNET_SLOWHZ 1 /* granularity is 1 second */ 2001541Srgrimes 2011541Srgrimes/* 2021541Srgrimes * Message format for use in obtaining information about interfaces 2031541Srgrimes * from getkerninfo and the routing socket 2041541Srgrimes */ 2051541Srgrimesstruct if_msghdr { 2061541Srgrimes u_short ifm_msglen; /* to skip over non-understood messages */ 20772093Sasmodai u_char ifm_version; /* future binary compatibility */ 2081541Srgrimes u_char ifm_type; /* message type */ 2091541Srgrimes int ifm_addrs; /* like rtm_addrs */ 2101541Srgrimes int ifm_flags; /* value of if_flags */ 2111541Srgrimes u_short ifm_index; /* index for associated ifp */ 2121541Srgrimes struct if_data ifm_data;/* statistics and other data about if */ 2131541Srgrimes}; 2141541Srgrimes 2151541Srgrimes/* 2161541Srgrimes * Message format for use in obtaining information about interface addresses 2171541Srgrimes * from getkerninfo and the routing socket 2181541Srgrimes */ 2191541Srgrimesstruct ifa_msghdr { 2201541Srgrimes u_short ifam_msglen; /* to skip over non-understood messages */ 22172093Sasmodai u_char ifam_version; /* future binary compatibility */ 2221541Srgrimes u_char ifam_type; /* message type */ 2231541Srgrimes int ifam_addrs; /* like rtm_addrs */ 2241541Srgrimes int ifam_flags; /* value of ifa_flags */ 2251541Srgrimes u_short ifam_index; /* index for associated ifp */ 2261541Srgrimes int ifam_metric; /* value of ifa_metric */ 2271541Srgrimes}; 2281541Srgrimes 2291541Srgrimes/* 23021666Swollman * Message format for use in obtaining information about multicast addresses 23121666Swollman * from the routing socket 23221666Swollman */ 23321666Swollmanstruct ifma_msghdr { 23421666Swollman u_short ifmam_msglen; /* to skip over non-understood messages */ 23572093Sasmodai u_char ifmam_version; /* future binary compatibility */ 23621666Swollman u_char ifmam_type; /* message type */ 23721666Swollman int ifmam_addrs; /* like rtm_addrs */ 23821666Swollman int ifmam_flags; /* value of ifa_flags */ 23921666Swollman u_short ifmam_index; /* index for associated ifp */ 24021666Swollman}; 24121666Swollman 24221666Swollman/* 24389498Sru * Message format announcing the arrival or departure of a network interface. 24489498Sru */ 24589498Srustruct if_announcemsghdr { 24689498Sru u_short ifan_msglen; /* to skip over non-understood messages */ 24789498Sru u_char ifan_version; /* future binary compatibility */ 24889498Sru u_char ifan_type; /* message type */ 24989498Sru u_short ifan_index; /* index for associated ifp */ 25089498Sru char ifan_name[IFNAMSIZ]; /* if name, e.g. "en0" */ 25189498Sru u_short ifan_what; /* what type of announcement */ 25289498Sru}; 25389498Sru 25489498Sru#define IFAN_ARRIVAL 0 /* interface arrival */ 25589498Sru#define IFAN_DEPARTURE 1 /* interface departure */ 25689498Sru 25789498Sru/* 2581541Srgrimes * Interface request structure used for socket 2591541Srgrimes * ioctl's. All interface ioctl's must have parameter 2601541Srgrimes * definitions which begin with ifr_name. The 2611541Srgrimes * remainder may be interface specific. 2621541Srgrimes */ 2631541Srgrimesstruct ifreq { 2641541Srgrimes char ifr_name[IFNAMSIZ]; /* if name, e.g. "en0" */ 2651541Srgrimes union { 2661541Srgrimes struct sockaddr ifru_addr; 2671541Srgrimes struct sockaddr ifru_dstaddr; 2681541Srgrimes struct sockaddr ifru_broadaddr; 26944144Sphk short ifru_flags[2]; 27085079Sjlemon short ifru_index; 2711541Srgrimes int ifru_metric; 2721941Sdg int ifru_mtu; 2735184Swollman int ifru_phys; 27425434Speter int ifru_media; 2751541Srgrimes caddr_t ifru_data; 27683624Sjlemon int ifru_cap[2]; 2771541Srgrimes } ifr_ifru; 2781541Srgrimes#define ifr_addr ifr_ifru.ifru_addr /* address */ 2791541Srgrimes#define ifr_dstaddr ifr_ifru.ifru_dstaddr /* other end of p-to-p link */ 2801541Srgrimes#define ifr_broadaddr ifr_ifru.ifru_broadaddr /* broadcast address */ 281102052Ssobomax#define ifr_flags ifr_ifru.ifru_flags[0] /* flags (low 16 bits) */ 282102052Ssobomax#define ifr_flagshigh ifr_ifru.ifru_flags[1] /* flags (high 16 bits) */ 2831541Srgrimes#define ifr_metric ifr_ifru.ifru_metric /* metric */ 2841941Sdg#define ifr_mtu ifr_ifru.ifru_mtu /* mtu */ 2855187Sdg#define ifr_phys ifr_ifru.ifru_phys /* physical wire */ 28625434Speter#define ifr_media ifr_ifru.ifru_media /* physical media */ 2871541Srgrimes#define ifr_data ifr_ifru.ifru_data /* for use by interface */ 28883624Sjlemon#define ifr_reqcap ifr_ifru.ifru_cap[0] /* requested capabilities */ 28983624Sjlemon#define ifr_curcap ifr_ifru.ifru_cap[1] /* current capabilities */ 29085079Sjlemon#define ifr_index ifr_ifru.ifru_index /* interface index */ 2911541Srgrimes}; 2921541Srgrimes 29332491Swollman#define _SIZEOF_ADDR_IFREQ(ifr) \ 29432491Swollman ((ifr).ifr_addr.sa_len > sizeof(struct sockaddr) ? \ 29532491Swollman (sizeof(struct ifreq) - sizeof(struct sockaddr) + \ 29632491Swollman (ifr).ifr_addr.sa_len) : sizeof(struct ifreq)) 29732491Swollman 2981541Srgrimesstruct ifaliasreq { 2991541Srgrimes char ifra_name[IFNAMSIZ]; /* if name, e.g. "en0" */ 3001541Srgrimes struct sockaddr ifra_addr; 3011541Srgrimes struct sockaddr ifra_broadaddr; 3021541Srgrimes struct sockaddr ifra_mask; 3031541Srgrimes}; 3041541Srgrimes 30525434Speterstruct ifmediareq { 30625434Speter char ifm_name[IFNAMSIZ]; /* if name, e.g. "en0" */ 30725434Speter int ifm_current; /* current media options */ 30825434Speter int ifm_mask; /* don't care mask */ 30925434Speter int ifm_status; /* media status */ 31025434Speter int ifm_active; /* active options */ 31125434Speter int ifm_count; /* # entries in ifm_ulist array */ 31225434Speter int *ifm_ulist; /* media words */ 31325434Speter}; 31448021Sphk 315146986Sthompsastruct ifdrv { 316146986Sthompsa char ifd_name[IFNAMSIZ]; /* if name, e.g. "en0" */ 317146986Sthompsa unsigned long ifd_cmd; 318146986Sthompsa size_t ifd_len; 319146986Sthompsa void *ifd_data; 320146986Sthompsa}; 321146986Sthompsa 32248021Sphk/* 32348021Sphk * Structure used to retrieve aux status data from interfaces. 32448589Sbde * Kernel suppliers to this interface should respect the formatting 32548021Sphk * needed by ifconfig(8): each line starts with a TAB and ends with 32648589Sbde * a newline. The canonical example to copy and paste is in if_tun.c. 32748021Sphk */ 32848021Sphk 32948589Sbde#define IFSTATMAX 800 /* 10 lines of text */ 33048021Sphkstruct ifstat { 33148589Sbde char ifs_name[IFNAMSIZ]; /* if name, e.g. "en0" */ 33248589Sbde char ascii[IFSTATMAX + 1]; 33348021Sphk}; 33448021Sphk 3351541Srgrimes/* 3361541Srgrimes * Structure used in SIOCGIFCONF request. 3371541Srgrimes * Used to retrieve interface configuration 3381541Srgrimes * for machine (useful for programs which 3391541Srgrimes * must know all networks accessible). 3401541Srgrimes */ 3411541Srgrimesstruct ifconf { 3421541Srgrimes int ifc_len; /* size of associated buffer */ 3431541Srgrimes union { 3441541Srgrimes caddr_t ifcu_buf; 3451541Srgrimes struct ifreq *ifcu_req; 3461541Srgrimes } ifc_ifcu; 3471541Srgrimes#define ifc_buf ifc_ifcu.ifcu_buf /* buffer address */ 3481541Srgrimes#define ifc_req ifc_ifcu.ifcu_req /* array of structures returned */ 3491541Srgrimes}; 3501541Srgrimes 35152904Sshin 35252904Sshin/* 35352904Sshin * Structure for SIOC[AGD]LIFADDR 35452904Sshin */ 35552904Sshinstruct if_laddrreq { 35652904Sshin char iflr_name[IFNAMSIZ]; 35752904Sshin u_int flags; 35852904Sshin#define IFLR_PREFIX 0x8000 /* in: prefix given out: kernel fills id */ 35952904Sshin u_int prefixlen; /* in/out */ 36052904Sshin struct sockaddr_storage addr; /* in/out */ 36152904Sshin struct sockaddr_storage dstaddr; /* out */ 36252904Sshin}; 36352904Sshin 364104355Smike#endif /* __BSD_VISIBLE */ 365104355Smike 36655205Speter#ifdef _KERNEL 36730354Sphk#ifdef MALLOC_DECLARE 36830354SphkMALLOC_DECLARE(M_IFADDR); 36930354SphkMALLOC_DECLARE(M_IFMADDR); 37030354Sphk#endif 37130354Sphk#endif 37230354Sphk 37355205Speter#ifndef _KERNEL 37452904Sshinstruct if_nameindex { 375104355Smike unsigned int if_index; /* 1, 2, ... */ 376104360Smike char *if_name; /* null terminated name: "le0", ... */ 37752904Sshin}; 37852904Sshin 37952904Sshin__BEGIN_DECLS 380104360Smikevoid if_freenameindex(struct if_nameindex *); 381104360Smikechar *if_indextoname(unsigned int, char *); 382104360Smikestruct if_nameindex *if_nameindex(void); 383104360Smikeunsigned int if_nametoindex(const char *); 38452904Sshin__END_DECLS 38552904Sshin#endif 38652904Sshin 38755205Speter#ifdef _KERNEL 38883366Sjulianstruct thread; 38948589Sbde 39048589Sbde/* XXX - this should go away soon. */ 39121259Swollman#include <net/if_var.h> 3921541Srgrimes#endif 3931541Srgrimes 3944507Sbde#endif /* !_NET_IF_H_ */ 395