if.h revision 148886
11722Sjkh/*- 21722Sjkh * Copyright (c) 1982, 1986, 1989, 1993 31722Sjkh * The Regents of the University of California. All rights reserved. 41722Sjkh * 51722Sjkh * Redistribution and use in source and binary forms, with or without 61722Sjkh * modification, are permitted provided that the following conditions 71722Sjkh * are met: 81722Sjkh * 1. Redistributions of source code must retain the above copyright 91722Sjkh * notice, this list of conditions and the following disclaimer. 101722Sjkh * 2. Redistributions in binary form must reproduce the above copyright 111722Sjkh * notice, this list of conditions and the following disclaimer in the 121722Sjkh * documentation and/or other materials provided with the distribution. 131722Sjkh * 4. Neither the name of the University nor the names of its contributors 141722Sjkh * may be used to endorse or promote products derived from this software 151722Sjkh * without specific prior written permission. 161722Sjkh * 171722Sjkh * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 181722Sjkh * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 191722Sjkh * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 201722Sjkh * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 211722Sjkh * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 221722Sjkh * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 231722Sjkh * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 241722Sjkh * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 251722Sjkh * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 27 * SUCH DAMAGE. 28 * 29 * @(#)if.h 8.1 (Berkeley) 6/10/93 30 * $FreeBSD: head/sys/net/if.h 148886 2005-08-09 10:16:17Z rwatson $ 31 */ 32 33#ifndef _NET_IF_H_ 34#define _NET_IF_H_ 35 36#include <sys/cdefs.h> 37 38#ifdef _KERNEL 39#include <sys/queue.h> 40#endif 41 42#if __BSD_VISIBLE 43/* 44 * <net/if.h> does not depend on <sys/time.h> on most other systems. This 45 * helps userland compatibility. (struct timeval ifi_lastchange) 46 */ 47#ifndef _KERNEL 48#include <sys/time.h> 49#endif 50 51struct ifnet; 52#endif 53 54/* 55 * Length of interface external name, including terminating '\0'. 56 * Note: this is the same size as a generic device's external name. 57 */ 58#define IF_NAMESIZE 16 59#if __BSD_VISIBLE 60#define IFNAMSIZ IF_NAMESIZE 61#define IF_MAXUNIT 0x7fff /* historical value */ 62#endif 63#if __BSD_VISIBLE 64 65/* 66 * Structure used to query names of interface cloners. 67 */ 68 69struct if_clonereq { 70 int ifcr_total; /* total cloners (out) */ 71 int ifcr_count; /* room for this many in user buffer */ 72 char *ifcr_buffer; /* buffer for cloner names */ 73}; 74 75/* 76 * Structure describing information about an interface 77 * which may be of interest to management entities. 78 */ 79struct if_data { 80 /* generic interface information */ 81 u_char ifi_type; /* ethernet, tokenring, etc */ 82 u_char ifi_physical; /* e.g., AUI, Thinnet, 10base-T, etc */ 83 u_char ifi_addrlen; /* media address length */ 84 u_char ifi_hdrlen; /* media header length */ 85 u_char ifi_link_state; /* current link state */ 86 u_char ifi_recvquota; /* polling quota for receive intrs */ 87 u_char ifi_xmitquota; /* polling quota for xmit intrs */ 88 u_char ifi_datalen; /* length of this data struct */ 89 u_long ifi_mtu; /* maximum transmission unit */ 90 u_long ifi_metric; /* routing metric (external only) */ 91 u_long ifi_baudrate; /* linespeed */ 92 /* volatile statistics */ 93 u_long ifi_ipackets; /* packets received on interface */ 94 u_long ifi_ierrors; /* input errors on interface */ 95 u_long ifi_opackets; /* packets sent on interface */ 96 u_long ifi_oerrors; /* output errors on interface */ 97 u_long ifi_collisions; /* collisions on csma interfaces */ 98 u_long ifi_ibytes; /* total number of octets received */ 99 u_long ifi_obytes; /* total number of octets sent */ 100 u_long ifi_imcasts; /* packets received via multicast */ 101 u_long ifi_omcasts; /* packets sent via multicast */ 102 u_long ifi_iqdrops; /* dropped on input, this interface */ 103 u_long ifi_noproto; /* destined for unsupported protocol */ 104 u_long ifi_hwassist; /* HW offload capabilities */ 105 time_t ifi_epoch; /* uptime at attach or stat reset */ 106#ifdef __alpha__ 107 u_int ifi_timepad; /* time_t is int, not long on alpha */ 108#endif 109 struct timeval ifi_lastchange; /* time of last administrative change */ 110}; 111 112/* 113 * Interface flags are of two types: network stack owned flags, and driver 114 * owned flags. Historically, these values were stored in the same ifnet 115 * flags field, but with the advent of fine-grained locking, they have been 116 * broken out such that the network stack is responsible for synchronizing 117 * the stack-owned fields, and the device driver the device-owned fields. 118 * Both halves can perform lockless reads of the other half's field, subject 119 * to accepting the involved races. 120 * 121 * Both sets of flags come from the same number space, and should not be 122 * permitted to conflict, as they are exposed to user space via a single 123 * field. 124 * 125 * For historical reasons, the old flag names for driver flags are exposed to 126 * user space. 127 */ 128#define IFF_UP 0x1 /* interface is up */ 129#define IFF_BROADCAST 0x2 /* broadcast address valid */ 130#define IFF_DEBUG 0x4 /* turn on debugging */ 131#define IFF_LOOPBACK 0x8 /* is a loopback net */ 132#define IFF_POINTOPOINT 0x10 /* interface is point-to-point link */ 133#define IFF_SMART 0x20 /* interface manages own routes */ 134#define IFF_DRV_RUNNING 0x40 /* resources allocated */ 135#define IFF_NOARP 0x80 /* no address resolution protocol */ 136#define IFF_PROMISC 0x100 /* receive all packets */ 137#define IFF_ALLMULTI 0x200 /* receive all multicast packets */ 138#define IFF_DRV_OACTIVE 0x400 /* tx hardware queue is full */ 139#define IFF_SIMPLEX 0x800 /* can't hear own transmissions */ 140#define IFF_LINK0 0x1000 /* per link layer defined bit */ 141#define IFF_LINK1 0x2000 /* per link layer defined bit */ 142#define IFF_LINK2 0x4000 /* per link layer defined bit */ 143#define IFF_ALTPHYS IFF_LINK2 /* use alternate physical connection */ 144#define IFF_MULTICAST 0x8000 /* supports multicast */ 145#define IFF_POLLING 0x10000 /* Interface is in polling mode. */ 146#define IFF_PPROMISC 0x20000 /* user-requested promisc mode */ 147#define IFF_MONITOR 0x40000 /* user-requested monitor mode */ 148#define IFF_STATICARP 0x80000 /* static ARP */ 149#define IFF_NEEDSGIANT 0x100000 /* hold Giant over if_start calls */ 150 151/* 152 * Old names for driver flags so that user space tools can continue to use 153 * the old names. 154 */ 155#ifndef _KERNEL 156#define IFF_RUNNING IFF_DRV_RUNNING 157#define IFF_OACTIVE IFF_DRV_OACTIVE 158#endif 159 160/* flags set internally only: */ 161#define IFF_CANTCHANGE \ 162 (IFF_BROADCAST|IFF_POINTOPOINT|IFF_DRV_RUNNING|IFF_DRV_OACTIVE|\ 163 IFF_SIMPLEX|IFF_MULTICAST|IFF_ALLMULTI|IFF_SMART|IFF_PROMISC|\ 164 IFF_POLLING) 165 166/* 167 * Values for if_link_state. 168 */ 169#define LINK_STATE_UNKNOWN 0 /* link invalid/unknown */ 170#define LINK_STATE_DOWN 1 /* link is down */ 171#define LINK_STATE_UP 2 /* link is up */ 172 173/* 174 * Some convenience macros used for setting ifi_baudrate. 175 * XXX 1000 vs. 1024? --thorpej@netbsd.org 176 */ 177#define IF_Kbps(x) ((x) * 1000) /* kilobits/sec. */ 178#define IF_Mbps(x) (IF_Kbps((x) * 1000)) /* megabits/sec. */ 179#define IF_Gbps(x) (IF_Mbps((x) * 1000)) /* gigabits/sec. */ 180 181/* Capabilities that interfaces can advertise. */ 182#define IFCAP_RXCSUM 0x0001 /* can offload checksum on RX */ 183#define IFCAP_TXCSUM 0x0002 /* can offload checksum on TX */ 184#define IFCAP_NETCONS 0x0004 /* can be a network console */ 185#define IFCAP_VLAN_MTU 0x0008 /* VLAN-compatible MTU */ 186#define IFCAP_VLAN_HWTAGGING 0x0010 /* hardware VLAN tag support */ 187#define IFCAP_JUMBO_MTU 0x0020 /* 9000 byte MTU supported */ 188#define IFCAP_POLLING 0x0040 /* driver supports polling */ 189 190#define IFCAP_HWCSUM (IFCAP_RXCSUM | IFCAP_TXCSUM) 191 192#define IFQ_MAXLEN 50 193#define IFNET_SLOWHZ 1 /* granularity is 1 second */ 194 195/* 196 * Message format for use in obtaining information about interfaces 197 * from getkerninfo and the routing socket 198 */ 199struct if_msghdr { 200 u_short ifm_msglen; /* to skip over non-understood messages */ 201 u_char ifm_version; /* future binary compatibility */ 202 u_char ifm_type; /* message type */ 203 int ifm_addrs; /* like rtm_addrs */ 204 int ifm_flags; /* value of if_flags */ 205 u_short ifm_index; /* index for associated ifp */ 206 struct if_data ifm_data;/* statistics and other data about if */ 207}; 208 209/* 210 * Message format for use in obtaining information about interface addresses 211 * from getkerninfo and the routing socket 212 */ 213struct ifa_msghdr { 214 u_short ifam_msglen; /* to skip over non-understood messages */ 215 u_char ifam_version; /* future binary compatibility */ 216 u_char ifam_type; /* message type */ 217 int ifam_addrs; /* like rtm_addrs */ 218 int ifam_flags; /* value of ifa_flags */ 219 u_short ifam_index; /* index for associated ifp */ 220 int ifam_metric; /* value of ifa_metric */ 221}; 222 223/* 224 * Message format for use in obtaining information about multicast addresses 225 * from the routing socket 226 */ 227struct ifma_msghdr { 228 u_short ifmam_msglen; /* to skip over non-understood messages */ 229 u_char ifmam_version; /* future binary compatibility */ 230 u_char ifmam_type; /* message type */ 231 int ifmam_addrs; /* like rtm_addrs */ 232 int ifmam_flags; /* value of ifa_flags */ 233 u_short ifmam_index; /* index for associated ifp */ 234}; 235 236/* 237 * Message format announcing the arrival or departure of a network interface. 238 */ 239struct if_announcemsghdr { 240 u_short ifan_msglen; /* to skip over non-understood messages */ 241 u_char ifan_version; /* future binary compatibility */ 242 u_char ifan_type; /* message type */ 243 u_short ifan_index; /* index for associated ifp */ 244 char ifan_name[IFNAMSIZ]; /* if name, e.g. "en0" */ 245 u_short ifan_what; /* what type of announcement */ 246}; 247 248#define IFAN_ARRIVAL 0 /* interface arrival */ 249#define IFAN_DEPARTURE 1 /* interface departure */ 250 251/* 252 * Interface request structure used for socket 253 * ioctl's. All interface ioctl's must have parameter 254 * definitions which begin with ifr_name. The 255 * remainder may be interface specific. 256 */ 257struct ifreq { 258 char ifr_name[IFNAMSIZ]; /* if name, e.g. "en0" */ 259 union { 260 struct sockaddr ifru_addr; 261 struct sockaddr ifru_dstaddr; 262 struct sockaddr ifru_broadaddr; 263 short ifru_flags[2]; 264 short ifru_index; 265 int ifru_metric; 266 int ifru_mtu; 267 int ifru_phys; 268 int ifru_media; 269 caddr_t ifru_data; 270 int ifru_cap[2]; 271 } ifr_ifru; 272#define ifr_addr ifr_ifru.ifru_addr /* address */ 273#define ifr_dstaddr ifr_ifru.ifru_dstaddr /* other end of p-to-p link */ 274#define ifr_broadaddr ifr_ifru.ifru_broadaddr /* broadcast address */ 275#define ifr_flags ifr_ifru.ifru_flags[0] /* flags (low 16 bits) */ 276#define ifr_flagshigh ifr_ifru.ifru_flags[1] /* flags (high 16 bits) */ 277#define ifr_metric ifr_ifru.ifru_metric /* metric */ 278#define ifr_mtu ifr_ifru.ifru_mtu /* mtu */ 279#define ifr_phys ifr_ifru.ifru_phys /* physical wire */ 280#define ifr_media ifr_ifru.ifru_media /* physical media */ 281#define ifr_data ifr_ifru.ifru_data /* for use by interface */ 282#define ifr_reqcap ifr_ifru.ifru_cap[0] /* requested capabilities */ 283#define ifr_curcap ifr_ifru.ifru_cap[1] /* current capabilities */ 284#define ifr_index ifr_ifru.ifru_index /* interface index */ 285}; 286 287#define _SIZEOF_ADDR_IFREQ(ifr) \ 288 ((ifr).ifr_addr.sa_len > sizeof(struct sockaddr) ? \ 289 (sizeof(struct ifreq) - sizeof(struct sockaddr) + \ 290 (ifr).ifr_addr.sa_len) : sizeof(struct ifreq)) 291 292struct ifaliasreq { 293 char ifra_name[IFNAMSIZ]; /* if name, e.g. "en0" */ 294 struct sockaddr ifra_addr; 295 struct sockaddr ifra_broadaddr; 296 struct sockaddr ifra_mask; 297}; 298 299struct ifmediareq { 300 char ifm_name[IFNAMSIZ]; /* if name, e.g. "en0" */ 301 int ifm_current; /* current media options */ 302 int ifm_mask; /* don't care mask */ 303 int ifm_status; /* media status */ 304 int ifm_active; /* active options */ 305 int ifm_count; /* # entries in ifm_ulist array */ 306 int *ifm_ulist; /* media words */ 307}; 308 309struct ifdrv { 310 char ifd_name[IFNAMSIZ]; /* if name, e.g. "en0" */ 311 unsigned long ifd_cmd; 312 size_t ifd_len; 313 void *ifd_data; 314}; 315 316/* 317 * Structure used to retrieve aux status data from interfaces. 318 * Kernel suppliers to this interface should respect the formatting 319 * needed by ifconfig(8): each line starts with a TAB and ends with 320 * a newline. The canonical example to copy and paste is in if_tun.c. 321 */ 322 323#define IFSTATMAX 800 /* 10 lines of text */ 324struct ifstat { 325 char ifs_name[IFNAMSIZ]; /* if name, e.g. "en0" */ 326 char ascii[IFSTATMAX + 1]; 327}; 328 329/* 330 * Structure used in SIOCGIFCONF request. 331 * Used to retrieve interface configuration 332 * for machine (useful for programs which 333 * must know all networks accessible). 334 */ 335struct ifconf { 336 int ifc_len; /* size of associated buffer */ 337 union { 338 caddr_t ifcu_buf; 339 struct ifreq *ifcu_req; 340 } ifc_ifcu; 341#define ifc_buf ifc_ifcu.ifcu_buf /* buffer address */ 342#define ifc_req ifc_ifcu.ifcu_req /* array of structures returned */ 343}; 344 345 346/* 347 * Structure for SIOC[AGD]LIFADDR 348 */ 349struct if_laddrreq { 350 char iflr_name[IFNAMSIZ]; 351 u_int flags; 352#define IFLR_PREFIX 0x8000 /* in: prefix given out: kernel fills id */ 353 u_int prefixlen; /* in/out */ 354 struct sockaddr_storage addr; /* in/out */ 355 struct sockaddr_storage dstaddr; /* out */ 356}; 357 358#endif /* __BSD_VISIBLE */ 359 360#ifdef _KERNEL 361#ifdef MALLOC_DECLARE 362MALLOC_DECLARE(M_IFADDR); 363MALLOC_DECLARE(M_IFMADDR); 364#endif 365#endif 366 367#ifndef _KERNEL 368struct if_nameindex { 369 unsigned int if_index; /* 1, 2, ... */ 370 char *if_name; /* null terminated name: "le0", ... */ 371}; 372 373__BEGIN_DECLS 374void if_freenameindex(struct if_nameindex *); 375char *if_indextoname(unsigned int, char *); 376struct if_nameindex *if_nameindex(void); 377unsigned int if_nametoindex(const char *); 378__END_DECLS 379#endif 380 381#ifdef _KERNEL 382struct thread; 383 384/* XXX - this should go away soon. */ 385#include <net/if_var.h> 386#endif 387 388#endif /* !_NET_IF_H_ */ 389