if.h revision 1.159
1/* $OpenBSD: if.h,v 1.159 2015/01/06 21:26:46 stsp Exp $ */ 2/* $NetBSD: if.h,v 1.23 1996/05/07 02:40:27 thorpej Exp $ */ 3 4/* 5 * Copyright (c) 1982, 1986, 1989, 1993 6 * The Regents of the University of California. All rights reserved. 7 * 8 * Redistribution and use in source and binary forms, with or without 9 * modification, are permitted provided that the following conditions 10 * are met: 11 * 1. Redistributions of source code must retain the above copyright 12 * notice, this list of conditions and the following disclaimer. 13 * 2. Redistributions in binary form must reproduce the above copyright 14 * notice, this list of conditions and the following disclaimer in the 15 * documentation and/or other materials provided with the distribution. 16 * 3. Neither the name of the University nor the names of its contributors 17 * may be used to endorse or promote products derived from this software 18 * without specific prior written permission. 19 * 20 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 21 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 23 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 24 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 25 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 26 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 27 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 28 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 29 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 30 * SUCH DAMAGE. 31 * 32 * @(#)if.h 8.1 (Berkeley) 6/10/93 33 */ 34 35#ifndef _NET_IF_H_ 36#define _NET_IF_H_ 37 38#include <sys/cdefs.h> 39 40/* 41 * Length of interface external name, including terminating '\0'. 42 * Note: this is the same size as a generic device's external name. 43 */ 44#define IF_NAMESIZE 16 45 46struct if_nameindex { 47 unsigned int if_index; 48 char *if_name; 49}; 50 51#ifndef _KERNEL 52__BEGIN_DECLS 53unsigned int if_nametoindex(const char *); 54char *if_indextoname(unsigned int, char *); 55struct if_nameindex *if_nameindex(void); 56void if_freenameindex(struct if_nameindex *); 57__END_DECLS 58#endif 59 60#if __BSD_VISIBLE 61 62/* 63 * Structure used to query names of interface cloners. 64 */ 65struct if_clonereq { 66 int ifcr_total; /* total cloners (out) */ 67 int ifcr_count; /* room for this many in user buffer */ 68 char *ifcr_buffer; /* buffer for cloner names */ 69}; 70 71#define MCLPOOLS 7 /* number of cluster pools */ 72 73struct if_rxring { 74 int rxr_adjusted; 75 u_int rxr_alive; 76 u_int rxr_cwm; 77 u_int rxr_lwm; 78 u_int rxr_hwm; 79}; 80 81struct if_rxring_info { 82 char ifr_name[16]; /* name of the ring */ 83 u_int ifr_size; /* size of the packets on the ring */ 84 struct if_rxring ifr_info; 85}; 86 87/* Structure used in SIOCGIFRXR request. */ 88struct if_rxrinfo { 89 u_int ifri_total; 90 struct if_rxring_info *ifri_entries; 91}; 92 93/* 94 * Structure defining statistics and other data kept regarding a network 95 * interface. 96 */ 97struct if_data { 98 /* generic interface information */ 99 u_char ifi_type; /* ethernet, tokenring, etc. */ 100 u_char ifi_addrlen; /* media address length */ 101 u_char ifi_hdrlen; /* media header length */ 102 u_char ifi_link_state; /* current link state */ 103 u_int32_t ifi_mtu; /* maximum transmission unit */ 104 u_int32_t ifi_metric; /* routing metric (external only) */ 105 u_int32_t ifi_pad; 106 u_int64_t ifi_baudrate; /* linespeed */ 107 /* volatile statistics */ 108 u_int64_t ifi_ipackets; /* packets received on interface */ 109 u_int64_t ifi_ierrors; /* input errors on interface */ 110 u_int64_t ifi_opackets; /* packets sent on interface */ 111 u_int64_t ifi_oerrors; /* output errors on interface */ 112 u_int64_t ifi_collisions; /* collisions on csma interfaces */ 113 u_int64_t ifi_ibytes; /* total number of octets received */ 114 u_int64_t ifi_obytes; /* total number of octets sent */ 115 u_int64_t ifi_imcasts; /* packets received via multicast */ 116 u_int64_t ifi_omcasts; /* packets sent via multicast */ 117 u_int64_t ifi_iqdrops; /* dropped on input, this interface */ 118 u_int64_t ifi_noproto; /* destined for unsupported protocol */ 119 u_int32_t ifi_capabilities; /* interface capabilities */ 120 struct timeval ifi_lastchange; /* last operational state change */ 121}; 122 123#define IFQ_NQUEUES 8 124#define IFQ_MAXPRIO IFQ_NQUEUES - 1 125#define IFQ_DEFPRIO 3 126 127/* 128 * Values for if_link_state. 129 */ 130#define LINK_STATE_UNKNOWN 0 /* link unknown */ 131#define LINK_STATE_INVALID 1 /* link invalid */ 132#define LINK_STATE_DOWN 2 /* link is down */ 133#define LINK_STATE_KALIVE_DOWN 3 /* keepalive reports down */ 134#define LINK_STATE_UP 4 /* link is up */ 135#define LINK_STATE_HALF_DUPLEX 5 /* link is up and half duplex */ 136#define LINK_STATE_FULL_DUPLEX 6 /* link is up and full duplex */ 137 138#define LINK_STATE_IS_UP(_s) \ 139 ((_s) >= LINK_STATE_UP || (_s) == LINK_STATE_UNKNOWN) 140 141/* 142 * Status bit descriptions for the various interface types. 143 */ 144struct if_status_description { 145 u_char ifs_type; 146 u_char ifs_state; 147 const char *ifs_string; 148}; 149 150#define LINK_STATE_DESC_MATCH(_ifs, _t, _s) \ 151 (((_ifs)->ifs_type == (_t) || (_ifs)->ifs_type == 0) && \ 152 (_ifs)->ifs_state == (_s)) 153 154 155#define LINK_STATE_DESCRIPTIONS { \ 156 { IFT_ETHER, LINK_STATE_DOWN, "no carrier" }, \ 157 \ 158 { IFT_IEEE80211, LINK_STATE_DOWN, "no network" }, \ 159 \ 160 { IFT_PPP, LINK_STATE_DOWN, "no carrier" }, \ 161 \ 162 { IFT_CARP, LINK_STATE_DOWN, "backup" }, \ 163 { IFT_CARP, LINK_STATE_UP, "master" }, \ 164 { IFT_CARP, LINK_STATE_HALF_DUPLEX, "master" }, \ 165 { IFT_CARP, LINK_STATE_FULL_DUPLEX, "master" }, \ 166 \ 167 { 0, LINK_STATE_UP, "active" }, \ 168 { 0, LINK_STATE_HALF_DUPLEX, "active" }, \ 169 { 0, LINK_STATE_FULL_DUPLEX, "active" }, \ 170 \ 171 { 0, LINK_STATE_UNKNOWN, "unknown" }, \ 172 { 0, LINK_STATE_INVALID, "invalid" }, \ 173 { 0, LINK_STATE_DOWN, "down" }, \ 174 { 0, LINK_STATE_KALIVE_DOWN, "keepalive down" }, \ 175 { 0, 0, NULL } \ 176} 177 178/* Traditional BSD name for length of interface external name. */ 179#define IFNAMSIZ IF_NAMESIZE 180 181/* 182 * Length of interface description, including terminating '\0'. 183 */ 184#define IFDESCRSIZE 64 185 186#define IFF_UP 0x1 /* interface is up */ 187#define IFF_BROADCAST 0x2 /* broadcast address valid */ 188#define IFF_DEBUG 0x4 /* turn on debugging */ 189#define IFF_LOOPBACK 0x8 /* is a loopback net */ 190#define IFF_POINTOPOINT 0x10 /* interface is point-to-point link */ 191#define IFF_NOTRAILERS 0x20 /* avoid use of trailers */ 192#define IFF_RUNNING 0x40 /* resources allocated */ 193#define IFF_NOARP 0x80 /* no address resolution protocol */ 194#define IFF_PROMISC 0x100 /* receive all packets */ 195#define IFF_ALLMULTI 0x200 /* receive all multicast packets */ 196#define IFF_OACTIVE 0x400 /* transmission in progress */ 197#define IFF_SIMPLEX 0x800 /* can't hear own transmissions */ 198#define IFF_LINK0 0x1000 /* per link layer defined bit */ 199#define IFF_LINK1 0x2000 /* per link layer defined bit */ 200#define IFF_LINK2 0x4000 /* per link layer defined bit */ 201#define IFF_MULTICAST 0x8000 /* supports multicast */ 202 203/* flags set internally only: */ 204#define IFF_CANTCHANGE \ 205 (IFF_BROADCAST|IFF_POINTOPOINT|IFF_RUNNING|IFF_OACTIVE|\ 206 IFF_SIMPLEX|IFF_MULTICAST|IFF_ALLMULTI) 207 208#define IFXF_TXREADY 0x1 /* interface is ready to tx */ 209#define IFXF_INET6_NOPRIVACY 0x4 /* don't autoconf privacy */ 210#define IFXF_MPLS 0x8 /* supports MPLS */ 211#define IFXF_WOL 0x10 /* wake on lan enabled */ 212#define IFXF_AUTOCONF6 0x20 /* v6 autoconf enabled */ 213 214#define IFXF_CANTCHANGE \ 215 (IFXF_TXREADY) 216 217/* 218 * Some convenience macros used for setting ifi_baudrate. 219 */ 220#define IF_Kbps(x) ((x) * 1000ULL) /* kilobits/sec. */ 221#define IF_Mbps(x) (IF_Kbps((x) * 1000ULL)) /* megabits/sec. */ 222#define IF_Gbps(x) (IF_Mbps((x) * 1000ULL)) /* gigabits/sec. */ 223 224/* Capabilities that interfaces can advertise. */ 225#define IFCAP_CSUM_IPv4 0x00000001 /* can do IPv4 header csum */ 226#define IFCAP_CSUM_TCPv4 0x00000002 /* can do IPv4/TCP csum */ 227#define IFCAP_CSUM_UDPv4 0x00000004 /* can do IPv4/UDP csum */ 228#define IFCAP_VLAN_MTU 0x00000010 /* VLAN-compatible MTU */ 229#define IFCAP_VLAN_HWTAGGING 0x00000020 /* hardware VLAN tag support */ 230#define IFCAP_CSUM_TCPv6 0x00000080 /* can do IPv6/TCP checksums */ 231#define IFCAP_CSUM_UDPv6 0x00000100 /* can do IPv6/UDP checksums */ 232#define IFCAP_WOL 0x00008000 /* can do wake on lan */ 233 234#define IFCAP_CSUM_MASK (IFCAP_CSUM_IPv4 | IFCAP_CSUM_TCPv4 | \ 235 IFCAP_CSUM_UDPv4 | IFCAP_CSUM_TCPv6 | IFCAP_CSUM_UDPv6) 236 237/* symbolic names for terminal (per-protocol) CTL_IFQ_ nodes */ 238#define IFQCTL_LEN 1 239#define IFQCTL_MAXLEN 2 240#define IFQCTL_DROPS 3 241#define IFQCTL_CONGESTION 4 242#define IFQCTL_MAXID 5 243 244/* sysctl for ifq (per-protocol packet input queue variant of ifqueue) */ 245#define CTL_IFQ_NAMES { \ 246 { 0, 0 }, \ 247 { "len", CTLTYPE_INT }, \ 248 { "maxlen", CTLTYPE_INT }, \ 249 { "drops", CTLTYPE_INT }, \ 250 { "congestion", CTLTYPE_INT }, \ 251} 252 253/* 254 * Message format for use in obtaining information about interfaces 255 * from sysctl and the routing socket. 256 */ 257struct if_msghdr { 258 u_short ifm_msglen; /* to skip over non-understood messages */ 259 u_char ifm_version; /* future binary compatibility */ 260 u_char ifm_type; /* message type */ 261 u_short ifm_hdrlen; /* sizeof(if_msghdr) to skip over the header */ 262 u_short ifm_index; /* index for associated ifp */ 263 u_short ifm_tableid; /* routing table id */ 264 u_char ifm_pad1; 265 u_char ifm_pad2; 266 int ifm_addrs; /* like rtm_addrs */ 267 int ifm_flags; /* value of if_flags */ 268 int ifm_xflags; 269 struct if_data ifm_data;/* statistics and other data about if */ 270}; 271 272/* 273 * Message format for use in obtaining information about interface addresses 274 * from sysctl and the routing socket. 275 */ 276struct ifa_msghdr { 277 u_short ifam_msglen; /* to skip over non-understood messages */ 278 u_char ifam_version; /* future binary compatibility */ 279 u_char ifam_type; /* message type */ 280 u_short ifam_hdrlen; /* sizeof(ifa_msghdr) to skip over the header */ 281 u_short ifam_index; /* index for associated ifp */ 282 u_short ifam_tableid; /* routing table id */ 283 u_char ifam_pad1; 284 u_char ifam_pad2; 285 int ifam_addrs; /* like rtm_addrs */ 286 int ifam_flags; /* value of ifa_flags */ 287 int ifam_metric; /* value of ifa_metric */ 288}; 289 290/* 291 * Message format announcing the arrival or departure of a network interface. 292 */ 293struct if_announcemsghdr { 294 u_short ifan_msglen; /* to skip over non-understood messages */ 295 u_char ifan_version; /* future binary compatibility */ 296 u_char ifan_type; /* message type */ 297 u_short ifan_hdrlen; /* sizeof(ifa_msghdr) to skip over the header */ 298 u_short ifan_index; /* index for associated ifp */ 299 u_short ifan_what; /* what type of announcement */ 300 char ifan_name[IFNAMSIZ]; /* if name, e.g. "en0" */ 301}; 302 303#define IFAN_ARRIVAL 0 /* interface arrival */ 304#define IFAN_DEPARTURE 1 /* interface departure */ 305 306/* 307 * interface groups 308 */ 309 310#define IFG_ALL "all" /* group contains all interfaces */ 311#define IFG_EGRESS "egress" /* if(s) default route(s) point to */ 312 313struct ifg_req { 314 union { 315 char ifgrqu_group[IFNAMSIZ]; 316 char ifgrqu_member[IFNAMSIZ]; 317 } ifgrq_ifgrqu; 318#define ifgrq_group ifgrq_ifgrqu.ifgrqu_group 319#define ifgrq_member ifgrq_ifgrqu.ifgrqu_member 320}; 321 322struct ifg_attrib { 323 int ifg_carp_demoted; 324}; 325 326/* 327 * Used to lookup groups for an interface 328 */ 329struct ifgroupreq { 330 char ifgr_name[IFNAMSIZ]; 331 u_int ifgr_len; 332 union { 333 char ifgru_group[IFNAMSIZ]; 334 struct ifg_req *ifgru_groups; 335 struct ifg_attrib ifgru_attrib; 336 } ifgr_ifgru; 337#define ifgr_group ifgr_ifgru.ifgru_group 338#define ifgr_groups ifgr_ifgru.ifgru_groups 339#define ifgr_attrib ifgr_ifgru.ifgru_attrib 340}; 341 342/* 343 * Interface request structure used for socket 344 * ioctl's. All interface ioctl's must have parameter 345 * definitions which begin with ifr_name. The 346 * remainder may be interface specific. 347 */ 348struct ifreq { 349 char ifr_name[IFNAMSIZ]; /* if name, e.g. "en0" */ 350 union { 351 struct sockaddr ifru_addr; 352 struct sockaddr ifru_dstaddr; 353 struct sockaddr ifru_broadaddr; 354 short ifru_flags; 355 int ifru_metric; 356 caddr_t ifru_data; 357 } ifr_ifru; 358#define ifr_addr ifr_ifru.ifru_addr /* address */ 359#define ifr_dstaddr ifr_ifru.ifru_dstaddr /* other end of p-to-p link */ 360#define ifr_broadaddr ifr_ifru.ifru_broadaddr /* broadcast address */ 361#define ifr_flags ifr_ifru.ifru_flags /* flags */ 362#define ifr_metric ifr_ifru.ifru_metric /* metric */ 363#define ifr_mtu ifr_ifru.ifru_metric /* mtu (overload) */ 364#define ifr_hardmtu ifr_ifru.ifru_metric /* hardmtu (overload) */ 365#define ifr_media ifr_ifru.ifru_metric /* media options (overload) */ 366#define ifr_rdomainid ifr_ifru.ifru_metric /* VRF instance (overload) */ 367#define ifr_vnetid ifr_ifru.ifru_metric /* Virtual Net Id (overload) */ 368#define ifr_ttl ifr_ifru.ifru_metric /* tunnel TTL (overload) */ 369#define ifr_data ifr_ifru.ifru_data /* for use by interface */ 370}; 371 372struct ifaliasreq { 373 char ifra_name[IFNAMSIZ]; /* if name, e.g. "en0" */ 374 union { 375 struct sockaddr ifrau_addr; 376 int ifrau_align; 377 } ifra_ifrau; 378#ifndef ifra_addr 379#define ifra_addr ifra_ifrau.ifrau_addr 380#endif 381 struct sockaddr ifra_dstaddr; 382#define ifra_broadaddr ifra_dstaddr 383 struct sockaddr ifra_mask; 384}; 385 386struct ifmediareq { 387 char ifm_name[IFNAMSIZ]; /* if name, e.g. "en0" */ 388 int ifm_current; /* current media options */ 389 int ifm_mask; /* don't care mask */ 390 int ifm_status; /* media status */ 391 int ifm_active; /* active options */ 392 int ifm_count; /* # entries in ifm_ulist 393 array */ 394 int *ifm_ulist; /* media words */ 395}; 396 397struct ifkalivereq { 398 char ikar_name[IFNAMSIZ]; /* if name, e.g. "en0" */ 399 int ikar_timeo; 400 int ikar_cnt; 401}; 402 403/* 404 * Structure used in SIOCGIFCONF request. 405 * Used to retrieve interface configuration 406 * for machine (useful for programs which 407 * must know all networks accessible). 408 */ 409struct ifconf { 410 int ifc_len; /* size of associated buffer */ 411 union { 412 caddr_t ifcu_buf; 413 struct ifreq *ifcu_req; 414 } ifc_ifcu; 415#define ifc_buf ifc_ifcu.ifcu_buf /* buffer address */ 416#define ifc_req ifc_ifcu.ifcu_req /* array of structures returned */ 417}; 418 419/* 420 * Structure for SIOC[AGD]LIFADDR 421 */ 422struct if_laddrreq { 423 char iflr_name[IFNAMSIZ]; 424 unsigned int flags; 425#define IFLR_PREFIX 0x8000 /* in: prefix given out: kernel fills id */ 426 unsigned int prefixlen; /* in/out */ 427 struct sockaddr_storage addr; /* in/out */ 428 struct sockaddr_storage dstaddr; /* out */ 429}; 430 431/* SIOCIFAFDETACH */ 432struct if_afreq { 433 char ifar_name[IFNAMSIZ]; 434 sa_family_t ifar_af; 435}; 436 437#include <net/if_arp.h> 438 439#ifdef _KERNEL 440struct socket; 441struct ifnet; 442 443void if_alloc_sadl(struct ifnet *); 444void if_free_sadl(struct ifnet *); 445void if_attach(struct ifnet *); 446void if_attachdomain(void); 447void if_attachtail(struct ifnet *); 448void if_attachhead(struct ifnet *); 449void if_detach(struct ifnet *); 450void if_down(struct ifnet *); 451void if_downall(void); 452void if_link_state_change(struct ifnet *); 453void if_slowtimo(void *); 454void if_up(struct ifnet *); 455int ifconf(u_long, caddr_t); 456void ifinit(void); 457int ifioctl(struct socket *, u_long, caddr_t, struct proc *); 458int ifpromisc(struct ifnet *, int); 459struct ifg_group *if_creategroup(const char *); 460int if_addgroup(struct ifnet *, const char *); 461int if_delgroup(struct ifnet *, const char *); 462void if_group_routechange(struct sockaddr *, struct sockaddr *); 463struct ifnet *ifunit(const char *); 464struct ifnet *if_get(unsigned int); 465void if_start(struct ifnet *); 466void ifnewlladdr(struct ifnet *); 467 468#endif /* _KERNEL */ 469 470#endif /* __BSD_VISIBLE */ 471 472#endif /* _NET_IF_H_ */ 473