if.h revision 162070
1/*- 2 * Copyright (c) 1982, 1986, 1989, 1993 3 * The Regents of the University of California. All rights reserved. 4 * 5 * Redistribution and use in source and binary forms, with or without 6 * modification, are permitted provided that the following conditions 7 * are met: 8 * 1. Redistributions of source code must retain the above copyright 9 * notice, this list of conditions and the following disclaimer. 10 * 2. Redistributions in binary form must reproduce the above copyright 11 * notice, this list of conditions and the following disclaimer in the 12 * documentation and/or other materials provided with the distribution. 13 * 4. Neither the name of the University nor the names of its contributors 14 * may be used to endorse or promote products derived from this software 15 * without specific prior written permission. 16 * 17 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 20 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 25 * 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 162070 2006-09-06 18:06:04Z andre $ 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, see IFCAP */ 105 time_t ifi_epoch; /* uptime at attach or stat reset */ 106 struct timeval ifi_lastchange; /* time of last administrative change */ 107}; 108 109/*- 110 * Interface flags are of two types: network stack owned flags, and driver 111 * owned flags. Historically, these values were stored in the same ifnet 112 * flags field, but with the advent of fine-grained locking, they have been 113 * broken out such that the network stack is responsible for synchronizing 114 * the stack-owned fields, and the device driver the device-owned fields. 115 * Both halves can perform lockless reads of the other half's field, subject 116 * to accepting the involved races. 117 * 118 * Both sets of flags come from the same number space, and should not be 119 * permitted to conflict, as they are exposed to user space via a single 120 * field. 121 * 122 * The following symbols identify read and write requirements for fields: 123 * 124 * (i) if_flags field set by device driver before attach, read-only there 125 * after. 126 * (n) if_flags field written only by the network stack, read by either the 127 * stack or driver. 128 * (d) if_drv_flags field written only by the device driver, read by either 129 * the stack or driver. 130 */ 131#define IFF_UP 0x1 /* (n) interface is up */ 132#define IFF_BROADCAST 0x2 /* (i) broadcast address valid */ 133#define IFF_DEBUG 0x4 /* (n) turn on debugging */ 134#define IFF_LOOPBACK 0x8 /* (i) is a loopback net */ 135#define IFF_POINTOPOINT 0x10 /* (i) is a point-to-point link */ 136#define IFF_SMART 0x20 /* (i) interface manages own routes */ 137#define IFF_DRV_RUNNING 0x40 /* (d) resources allocated */ 138#define IFF_NOARP 0x80 /* (n) no address resolution protocol */ 139#define IFF_PROMISC 0x100 /* (n) receive all packets */ 140#define IFF_ALLMULTI 0x200 /* (n) receive all multicast packets */ 141#define IFF_DRV_OACTIVE 0x400 /* (d) tx hardware queue is full */ 142#define IFF_SIMPLEX 0x800 /* (i) can't hear own transmissions */ 143#define IFF_LINK0 0x1000 /* per link layer defined bit */ 144#define IFF_LINK1 0x2000 /* per link layer defined bit */ 145#define IFF_LINK2 0x4000 /* per link layer defined bit */ 146#define IFF_ALTPHYS IFF_LINK2 /* use alternate physical connection */ 147#define IFF_MULTICAST 0x8000 /* (i) supports multicast */ 148/* 0x10000 */ 149#define IFF_PPROMISC 0x20000 /* (n) user-requested promisc mode */ 150#define IFF_MONITOR 0x40000 /* (n) user-requested monitor mode */ 151#define IFF_STATICARP 0x80000 /* (n) static ARP */ 152#define IFF_NEEDSGIANT 0x100000 /* (i) hold Giant over if_start calls */ 153 154/* 155 * Old names for driver flags so that user space tools can continue to use 156 * the old (portable) names. 157 */ 158#ifndef _KERNEL 159#define IFF_RUNNING IFF_DRV_RUNNING 160#define IFF_OACTIVE IFF_DRV_OACTIVE 161#endif 162 163/* flags set internally only: */ 164#define IFF_CANTCHANGE \ 165 (IFF_BROADCAST|IFF_POINTOPOINT|IFF_DRV_RUNNING|IFF_DRV_OACTIVE|\ 166 IFF_SIMPLEX|IFF_MULTICAST|IFF_ALLMULTI|IFF_SMART|IFF_PROMISC) 167 168/* 169 * Values for if_link_state. 170 */ 171#define LINK_STATE_UNKNOWN 0 /* link invalid/unknown */ 172#define LINK_STATE_DOWN 1 /* link is down */ 173#define LINK_STATE_UP 2 /* link is up */ 174 175/* 176 * Some convenience macros used for setting ifi_baudrate. 177 * XXX 1000 vs. 1024? --thorpej@netbsd.org 178 */ 179#define IF_Kbps(x) ((x) * 1000) /* kilobits/sec. */ 180#define IF_Mbps(x) (IF_Kbps((x) * 1000)) /* megabits/sec. */ 181#define IF_Gbps(x) (IF_Mbps((x) * 1000)) /* gigabits/sec. */ 182 183/* 184 * Capabilities that interfaces can advertise. 185 * 186 * struct ifnet.if_capabilities 187 * contains the optional features & capabilities a particular interface 188 * supports (not only the driver but also the detected hw revision). 189 * Capabilities are defined by IFCAP_* below. 190 * struct ifnet.if_capenabled 191 * contains the enabled (either by default or through ifconfig) optional 192 * features & capabilities on this interface. 193 * Capabilities are defined by IFCAP_* below. 194 * struct if_data.ifi_hwassist in mbuf CSUM_ flag form, controlled by above 195 * contains the enabled optional feature & capabilites that can be used 196 * individually per packet and are specified in the mbuf pkthdr.csum_flags 197 * field. IFCAP_* and CSUM_* do not match one to one and CSUM_* may be 198 * more detailed or differenciated that IFCAP_*. 199 * Hwassist features are defined CSUM_* in sys/mbuf.h 200 */ 201#define IFCAP_RXCSUM 0x0001 /* can offload checksum on RX */ 202#define IFCAP_TXCSUM 0x0002 /* can offload checksum on TX */ 203#define IFCAP_NETCONS 0x0004 /* can be a network console */ 204#define IFCAP_VLAN_MTU 0x0008 /* VLAN-compatible MTU */ 205#define IFCAP_VLAN_HWTAGGING 0x0010 /* hardware VLAN tag support */ 206#define IFCAP_JUMBO_MTU 0x0020 /* 9000 byte MTU supported */ 207#define IFCAP_POLLING 0x0040 /* driver supports polling */ 208#define IFCAP_VLAN_HWCSUM 0x0080 /* can do IFCAP_HWCSUM on VLANs */ 209 210#define IFCAP_HWCSUM (IFCAP_RXCSUM | IFCAP_TXCSUM) 211 212#define IFQ_MAXLEN 50 213#define IFNET_SLOWHZ 1 /* granularity is 1 second */ 214 215/* 216 * Message format for use in obtaining information about interfaces 217 * from getkerninfo and the routing socket 218 */ 219struct if_msghdr { 220 u_short ifm_msglen; /* to skip over non-understood messages */ 221 u_char ifm_version; /* future binary compatibility */ 222 u_char ifm_type; /* message type */ 223 int ifm_addrs; /* like rtm_addrs */ 224 int ifm_flags; /* value of if_flags */ 225 u_short ifm_index; /* index for associated ifp */ 226 struct if_data ifm_data;/* statistics and other data about if */ 227}; 228 229/* 230 * Message format for use in obtaining information about interface addresses 231 * from getkerninfo and the routing socket 232 */ 233struct ifa_msghdr { 234 u_short ifam_msglen; /* to skip over non-understood messages */ 235 u_char ifam_version; /* future binary compatibility */ 236 u_char ifam_type; /* message type */ 237 int ifam_addrs; /* like rtm_addrs */ 238 int ifam_flags; /* value of ifa_flags */ 239 u_short ifam_index; /* index for associated ifp */ 240 int ifam_metric; /* value of ifa_metric */ 241}; 242 243/* 244 * Message format for use in obtaining information about multicast addresses 245 * from the routing socket 246 */ 247struct ifma_msghdr { 248 u_short ifmam_msglen; /* to skip over non-understood messages */ 249 u_char ifmam_version; /* future binary compatibility */ 250 u_char ifmam_type; /* message type */ 251 int ifmam_addrs; /* like rtm_addrs */ 252 int ifmam_flags; /* value of ifa_flags */ 253 u_short ifmam_index; /* index for associated ifp */ 254}; 255 256/* 257 * Message format announcing the arrival or departure of a network interface. 258 */ 259struct if_announcemsghdr { 260 u_short ifan_msglen; /* to skip over non-understood messages */ 261 u_char ifan_version; /* future binary compatibility */ 262 u_char ifan_type; /* message type */ 263 u_short ifan_index; /* index for associated ifp */ 264 char ifan_name[IFNAMSIZ]; /* if name, e.g. "en0" */ 265 u_short ifan_what; /* what type of announcement */ 266}; 267 268#define IFAN_ARRIVAL 0 /* interface arrival */ 269#define IFAN_DEPARTURE 1 /* interface departure */ 270 271/* 272 * Interface request structure used for socket 273 * ioctl's. All interface ioctl's must have parameter 274 * definitions which begin with ifr_name. The 275 * remainder may be interface specific. 276 */ 277struct ifreq { 278 char ifr_name[IFNAMSIZ]; /* if name, e.g. "en0" */ 279 union { 280 struct sockaddr ifru_addr; 281 struct sockaddr ifru_dstaddr; 282 struct sockaddr ifru_broadaddr; 283 short ifru_flags[2]; 284 short ifru_index; 285 int ifru_metric; 286 int ifru_mtu; 287 int ifru_phys; 288 int ifru_media; 289 caddr_t ifru_data; 290 int ifru_cap[2]; 291 } ifr_ifru; 292#define ifr_addr ifr_ifru.ifru_addr /* address */ 293#define ifr_dstaddr ifr_ifru.ifru_dstaddr /* other end of p-to-p link */ 294#define ifr_broadaddr ifr_ifru.ifru_broadaddr /* broadcast address */ 295#define ifr_flags ifr_ifru.ifru_flags[0] /* flags (low 16 bits) */ 296#define ifr_flagshigh ifr_ifru.ifru_flags[1] /* flags (high 16 bits) */ 297#define ifr_metric ifr_ifru.ifru_metric /* metric */ 298#define ifr_mtu ifr_ifru.ifru_mtu /* mtu */ 299#define ifr_phys ifr_ifru.ifru_phys /* physical wire */ 300#define ifr_media ifr_ifru.ifru_media /* physical media */ 301#define ifr_data ifr_ifru.ifru_data /* for use by interface */ 302#define ifr_reqcap ifr_ifru.ifru_cap[0] /* requested capabilities */ 303#define ifr_curcap ifr_ifru.ifru_cap[1] /* current capabilities */ 304#define ifr_index ifr_ifru.ifru_index /* interface index */ 305}; 306 307#define _SIZEOF_ADDR_IFREQ(ifr) \ 308 ((ifr).ifr_addr.sa_len > sizeof(struct sockaddr) ? \ 309 (sizeof(struct ifreq) - sizeof(struct sockaddr) + \ 310 (ifr).ifr_addr.sa_len) : sizeof(struct ifreq)) 311 312struct ifaliasreq { 313 char ifra_name[IFNAMSIZ]; /* if name, e.g. "en0" */ 314 struct sockaddr ifra_addr; 315 struct sockaddr ifra_broadaddr; 316 struct sockaddr ifra_mask; 317}; 318 319struct ifmediareq { 320 char ifm_name[IFNAMSIZ]; /* if name, e.g. "en0" */ 321 int ifm_current; /* current media options */ 322 int ifm_mask; /* don't care mask */ 323 int ifm_status; /* media status */ 324 int ifm_active; /* active options */ 325 int ifm_count; /* # entries in ifm_ulist array */ 326 int *ifm_ulist; /* media words */ 327}; 328 329struct ifdrv { 330 char ifd_name[IFNAMSIZ]; /* if name, e.g. "en0" */ 331 unsigned long ifd_cmd; 332 size_t ifd_len; 333 void *ifd_data; 334}; 335 336/* 337 * Structure used to retrieve aux status data from interfaces. 338 * Kernel suppliers to this interface should respect the formatting 339 * needed by ifconfig(8): each line starts with a TAB and ends with 340 * a newline. The canonical example to copy and paste is in if_tun.c. 341 */ 342 343#define IFSTATMAX 800 /* 10 lines of text */ 344struct ifstat { 345 char ifs_name[IFNAMSIZ]; /* if name, e.g. "en0" */ 346 char ascii[IFSTATMAX + 1]; 347}; 348 349/* 350 * Structure used in SIOCGIFCONF request. 351 * Used to retrieve interface configuration 352 * for machine (useful for programs which 353 * must know all networks accessible). 354 */ 355struct ifconf { 356 int ifc_len; /* size of associated buffer */ 357 union { 358 caddr_t ifcu_buf; 359 struct ifreq *ifcu_req; 360 } ifc_ifcu; 361#define ifc_buf ifc_ifcu.ifcu_buf /* buffer address */ 362#define ifc_req ifc_ifcu.ifcu_req /* array of structures returned */ 363}; 364 365#if defined (__amd64__) || defined (COMPAT_32BIT) 366struct ifconf32 { 367 int ifc_len; /* size of associated buffer */ 368 union { 369 u_int ifcu_buf; 370 u_int ifcu_req; 371 } ifc_ifcu; 372}; 373#endif 374 375/* 376 * interface groups 377 */ 378 379#define IFG_ALL "all" /* group contains all interfaces */ 380/* XXX: will we implement this? */ 381#define IFG_EGRESS "egress" /* if(s) default route(s) point to */ 382 383struct ifg_req { 384 union { 385 char ifgrqu_group[IFNAMSIZ]; 386 char ifgrqu_member[IFNAMSIZ]; 387 } ifgrq_ifgrqu; 388#define ifgrq_group ifgrq_ifgrqu.ifgrqu_group 389#define ifgrq_member ifgrq_ifgrqu.ifgrqu_member 390}; 391 392/* 393 * Used to lookup groups for an interface 394 */ 395struct ifgroupreq { 396 char ifgr_name[IFNAMSIZ]; 397 u_int ifgr_len; 398 union { 399 char ifgru_group[IFNAMSIZ]; 400 struct ifg_req *ifgru_groups; 401 } ifgr_ifgru; 402#define ifgr_group ifgr_ifgru.ifgru_group 403#define ifgr_groups ifgr_ifgru.ifgru_groups 404}; 405 406/* 407 * Structure for SIOC[AGD]LIFADDR 408 */ 409struct if_laddrreq { 410 char iflr_name[IFNAMSIZ]; 411 u_int flags; 412#define IFLR_PREFIX 0x8000 /* in: prefix given out: kernel fills id */ 413 u_int prefixlen; /* in/out */ 414 struct sockaddr_storage addr; /* in/out */ 415 struct sockaddr_storage dstaddr; /* out */ 416}; 417 418#endif /* __BSD_VISIBLE */ 419 420#ifdef _KERNEL 421#ifdef MALLOC_DECLARE 422MALLOC_DECLARE(M_IFADDR); 423MALLOC_DECLARE(M_IFMADDR); 424#endif 425#endif 426 427#ifndef _KERNEL 428struct if_nameindex { 429 unsigned int if_index; /* 1, 2, ... */ 430 char *if_name; /* null terminated name: "le0", ... */ 431}; 432 433__BEGIN_DECLS 434void if_freenameindex(struct if_nameindex *); 435char *if_indextoname(unsigned int, char *); 436struct if_nameindex *if_nameindex(void); 437unsigned int if_nametoindex(const char *); 438__END_DECLS 439#endif 440 441#ifdef _KERNEL 442struct thread; 443 444/* XXX - this should go away soon. */ 445#include <net/if_var.h> 446#endif 447 448#endif /* !_NET_IF_H_ */ 449