if.h revision 1.178
1/* $OpenBSD: if.h,v 1.178 2016/09/03 13:46:57 reyk 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_rdomain; /* routing instance */ 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_oqdrops; /* dropped on output, this interface */ 119 u_int64_t ifi_noproto; /* destined for unsupported protocol */ 120 u_int32_t ifi_capabilities; /* interface capabilities */ 121 struct timeval ifi_lastchange; /* last operational state change */ 122}; 123 124#define IFQ_NQUEUES 8 125#define IFQ_MAXPRIO IFQ_NQUEUES - 1 126#define IFQ_DEFPRIO 3 127 128/* 129 * Values for if_link_state. 130 */ 131#define LINK_STATE_UNKNOWN 0 /* link unknown */ 132#define LINK_STATE_INVALID 1 /* link invalid */ 133#define LINK_STATE_DOWN 2 /* link is down */ 134#define LINK_STATE_KALIVE_DOWN 3 /* keepalive reports down */ 135#define LINK_STATE_UP 4 /* link is up */ 136#define LINK_STATE_HALF_DUPLEX 5 /* link is up and half duplex */ 137#define LINK_STATE_FULL_DUPLEX 6 /* link is up and full duplex */ 138 139#define LINK_STATE_IS_UP(_s) \ 140 ((_s) >= LINK_STATE_UP || (_s) == LINK_STATE_UNKNOWN) 141 142/* 143 * Status bit descriptions for the various interface types. 144 */ 145struct if_status_description { 146 u_char ifs_type; 147 u_char ifs_state; 148 const char *ifs_string; 149}; 150 151#define LINK_STATE_DESC_MATCH(_ifs, _t, _s) \ 152 (((_ifs)->ifs_type == (_t) || (_ifs)->ifs_type == 0) && \ 153 (_ifs)->ifs_state == (_s)) 154 155 156#define LINK_STATE_DESCRIPTIONS { \ 157 { IFT_ETHER, LINK_STATE_DOWN, "no carrier" }, \ 158 \ 159 { IFT_IEEE80211, LINK_STATE_DOWN, "no network" }, \ 160 \ 161 { IFT_PPP, LINK_STATE_DOWN, "no carrier" }, \ 162 \ 163 { IFT_CARP, LINK_STATE_DOWN, "backup" }, \ 164 { IFT_CARP, LINK_STATE_UP, "master" }, \ 165 { IFT_CARP, LINK_STATE_HALF_DUPLEX, "master" }, \ 166 { IFT_CARP, LINK_STATE_FULL_DUPLEX, "master" }, \ 167 \ 168 { 0, LINK_STATE_UP, "active" }, \ 169 { 0, LINK_STATE_HALF_DUPLEX, "active" }, \ 170 { 0, LINK_STATE_FULL_DUPLEX, "active" }, \ 171 \ 172 { 0, LINK_STATE_UNKNOWN, "unknown" }, \ 173 { 0, LINK_STATE_INVALID, "invalid" }, \ 174 { 0, LINK_STATE_DOWN, "down" }, \ 175 { 0, LINK_STATE_KALIVE_DOWN, "keepalive down" }, \ 176 { 0, 0, NULL } \ 177} 178 179/* Traditional BSD name for length of interface external name. */ 180#define IFNAMSIZ IF_NAMESIZE 181 182/* 183 * Length of interface description, including terminating '\0'. 184 */ 185#define IFDESCRSIZE 64 186 187#define IFF_UP 0x1 /* interface is up */ 188#define IFF_BROADCAST 0x2 /* broadcast address valid */ 189#define IFF_DEBUG 0x4 /* turn on debugging */ 190#define IFF_LOOPBACK 0x8 /* is a loopback net */ 191#define IFF_POINTOPOINT 0x10 /* interface is point-to-point link */ 192#define IFF_NOTRAILERS 0x20 /* avoid use of trailers */ 193#define IFF_RUNNING 0x40 /* resources allocated */ 194#define IFF_NOARP 0x80 /* no address resolution protocol */ 195#define IFF_PROMISC 0x100 /* receive all packets */ 196#define IFF_ALLMULTI 0x200 /* receive all multicast packets */ 197#define IFF_OACTIVE 0x400 /* transmission in progress */ 198#define IFF_SIMPLEX 0x800 /* can't hear own transmissions */ 199#define IFF_LINK0 0x1000 /* per link layer defined bit */ 200#define IFF_LINK1 0x2000 /* per link layer defined bit */ 201#define IFF_LINK2 0x4000 /* per link layer defined bit */ 202#define IFF_MULTICAST 0x8000 /* supports multicast */ 203 204/* flags set internally only: */ 205#define IFF_CANTCHANGE \ 206 (IFF_BROADCAST|IFF_POINTOPOINT|IFF_RUNNING|IFF_OACTIVE|\ 207 IFF_SIMPLEX|IFF_MULTICAST|IFF_ALLMULTI) 208 209#define IFXF_MPSAFE 0x1 /* if_start is mpsafe */ 210#define IFXF_INET6_NOPRIVACY 0x4 /* don't autoconf privacy */ 211#define IFXF_MPLS 0x8 /* supports MPLS */ 212#define IFXF_WOL 0x10 /* wake on lan enabled */ 213#define IFXF_AUTOCONF6 0x20 /* v6 autoconf enabled */ 214 215#define IFXF_CANTCHANGE \ 216 (IFXF_MPSAFE) 217 218/* 219 * Some convenience macros used for setting ifi_baudrate. 220 */ 221#define IF_Kbps(x) ((x) * 1000ULL) /* kilobits/sec. */ 222#define IF_Mbps(x) (IF_Kbps((x) * 1000ULL)) /* megabits/sec. */ 223#define IF_Gbps(x) (IF_Mbps((x) * 1000ULL)) /* gigabits/sec. */ 224 225/* Capabilities that interfaces can advertise. */ 226#define IFCAP_CSUM_IPv4 0x00000001 /* can do IPv4 header csum */ 227#define IFCAP_CSUM_TCPv4 0x00000002 /* can do IPv4/TCP csum */ 228#define IFCAP_CSUM_UDPv4 0x00000004 /* can do IPv4/UDP csum */ 229#define IFCAP_VLAN_MTU 0x00000010 /* VLAN-compatible MTU */ 230#define IFCAP_VLAN_HWTAGGING 0x00000020 /* hardware VLAN tag support */ 231#define IFCAP_CSUM_TCPv6 0x00000080 /* can do IPv6/TCP checksums */ 232#define IFCAP_CSUM_UDPv6 0x00000100 /* can do IPv6/UDP checksums */ 233#define IFCAP_WOL 0x00008000 /* can do wake on lan */ 234 235#define IFCAP_CSUM_MASK (IFCAP_CSUM_IPv4 | IFCAP_CSUM_TCPv4 | \ 236 IFCAP_CSUM_UDPv4 | IFCAP_CSUM_TCPv6 | IFCAP_CSUM_UDPv6) 237 238/* symbolic names for terminal (per-protocol) CTL_IFQ_ nodes */ 239#define IFQCTL_LEN 1 240#define IFQCTL_MAXLEN 2 241#define IFQCTL_DROPS 3 242#define IFQCTL_CONGESTION 4 243#define IFQCTL_MAXID 5 244 245/* sysctl for ifq (per-protocol packet input queue variant of ifqueue) */ 246#define CTL_IFQ_NAMES { \ 247 { 0, 0 }, \ 248 { "len", CTLTYPE_INT }, \ 249 { "maxlen", CTLTYPE_INT }, \ 250 { "drops", CTLTYPE_INT }, \ 251 { "congestion", CTLTYPE_INT }, \ 252} 253 254/* 255 * Message format for use in obtaining information about interfaces 256 * from sysctl and the routing socket. 257 */ 258struct if_msghdr { 259 u_short ifm_msglen; /* to skip over non-understood messages */ 260 u_char ifm_version; /* future binary compatibility */ 261 u_char ifm_type; /* message type */ 262 u_short ifm_hdrlen; /* sizeof(if_msghdr) to skip over the header */ 263 u_short ifm_index; /* index for associated ifp */ 264 u_short ifm_tableid; /* routing table id */ 265 u_char ifm_pad1; 266 u_char ifm_pad2; 267 int ifm_addrs; /* like rtm_addrs */ 268 int ifm_flags; /* value of if_flags */ 269 int ifm_xflags; 270 struct if_data ifm_data;/* statistics and other data about if */ 271}; 272 273/* 274 * Message format for use in obtaining information about interface addresses 275 * from sysctl and the routing socket. 276 */ 277struct ifa_msghdr { 278 u_short ifam_msglen; /* to skip over non-understood messages */ 279 u_char ifam_version; /* future binary compatibility */ 280 u_char ifam_type; /* message type */ 281 u_short ifam_hdrlen; /* sizeof(ifa_msghdr) to skip over the header */ 282 u_short ifam_index; /* index for associated ifp */ 283 u_short ifam_tableid; /* routing table id */ 284 u_char ifam_pad1; 285 u_char ifam_pad2; 286 int ifam_addrs; /* like rtm_addrs */ 287 int ifam_flags; /* value of ifa_flags */ 288 int ifam_metric; /* value of ifa_metric */ 289}; 290 291/* 292 * Message format announcing the arrival or departure of a network interface. 293 */ 294struct if_announcemsghdr { 295 u_short ifan_msglen; /* to skip over non-understood messages */ 296 u_char ifan_version; /* future binary compatibility */ 297 u_char ifan_type; /* message type */ 298 u_short ifan_hdrlen; /* sizeof(ifa_msghdr) to skip over the header */ 299 u_short ifan_index; /* index for associated ifp */ 300 u_short ifan_what; /* what type of announcement */ 301 char ifan_name[IFNAMSIZ]; /* if name, e.g. "en0" */ 302}; 303 304#define IFAN_ARRIVAL 0 /* interface arrival */ 305#define IFAN_DEPARTURE 1 /* interface departure */ 306 307/* message format used to pass interface name to index mappings */ 308struct if_nameindex_msg { 309 unsigned int if_index; 310 char if_name[IFNAMSIZ]; 311}; 312 313/* 314 * interface groups 315 */ 316 317#define IFG_ALL "all" /* group contains all interfaces */ 318#define IFG_EGRESS "egress" /* if(s) default route(s) point to */ 319 320struct ifg_req { 321 union { 322 char ifgrqu_group[IFNAMSIZ]; 323 char ifgrqu_member[IFNAMSIZ]; 324 } ifgrq_ifgrqu; 325#define ifgrq_group ifgrq_ifgrqu.ifgrqu_group 326#define ifgrq_member ifgrq_ifgrqu.ifgrqu_member 327}; 328 329struct ifg_attrib { 330 int ifg_carp_demoted; 331}; 332 333/* 334 * Used to lookup groups for an interface 335 */ 336struct ifgroupreq { 337 char ifgr_name[IFNAMSIZ]; 338 u_int ifgr_len; 339 union { 340 char ifgru_group[IFNAMSIZ]; 341 struct ifg_req *ifgru_groups; 342 struct ifg_attrib ifgru_attrib; 343 } ifgr_ifgru; 344#define ifgr_group ifgr_ifgru.ifgru_group 345#define ifgr_groups ifgr_ifgru.ifgru_groups 346#define ifgr_attrib ifgr_ifgru.ifgru_attrib 347}; 348 349/* 350 * Interface request structure used for socket 351 * ioctl's. All interface ioctl's must have parameter 352 * definitions which begin with ifr_name. The 353 * remainder may be interface specific. 354 */ 355struct ifreq { 356 char ifr_name[IFNAMSIZ]; /* if name, e.g. "en0" */ 357 union { 358 struct sockaddr ifru_addr; 359 struct sockaddr ifru_dstaddr; 360 struct sockaddr ifru_broadaddr; 361 short ifru_flags; 362 int ifru_metric; 363 int64_t ifru_vnetid; 364 uint64_t ifru_media; 365 caddr_t ifru_data; 366 unsigned int ifru_index; 367 } ifr_ifru; 368#define ifr_addr ifr_ifru.ifru_addr /* address */ 369#define ifr_dstaddr ifr_ifru.ifru_dstaddr /* other end of p-to-p link */ 370#define ifr_broadaddr ifr_ifru.ifru_broadaddr /* broadcast address */ 371#define ifr_flags ifr_ifru.ifru_flags /* flags */ 372#define ifr_metric ifr_ifru.ifru_metric /* metric */ 373#define ifr_mtu ifr_ifru.ifru_metric /* mtu (overload) */ 374#define ifr_hardmtu ifr_ifru.ifru_metric /* hardmtu (overload) */ 375#define ifr_media ifr_ifru.ifru_media /* media options */ 376#define ifr_rdomainid ifr_ifru.ifru_metric /* VRF instance (overload) */ 377#define ifr_vnetid ifr_ifru.ifru_vnetid /* Virtual Net Id */ 378#define ifr_ttl ifr_ifru.ifru_metric /* tunnel TTL (overload) */ 379#define ifr_data ifr_ifru.ifru_data /* for use by interface */ 380#define ifr_index ifr_ifru.ifru_index /* interface index */ 381#define ifr_llprio ifr_ifru.ifru_metric /* link layer priority */ 382}; 383 384struct ifaliasreq { 385 char ifra_name[IFNAMSIZ]; /* if name, e.g. "en0" */ 386 union { 387 struct sockaddr ifrau_addr; 388 int ifrau_align; 389 } ifra_ifrau; 390#ifndef ifra_addr 391#define ifra_addr ifra_ifrau.ifrau_addr 392#endif 393 struct sockaddr ifra_dstaddr; 394#define ifra_broadaddr ifra_dstaddr 395 struct sockaddr ifra_mask; 396}; 397 398struct ifmediareq { 399 char ifm_name[IFNAMSIZ]; /* if name, e.g. "en0" */ 400 uint64_t ifm_current; /* get/set current media options */ 401 uint64_t ifm_mask; /* don't care mask */ 402 uint64_t ifm_status; /* media status */ 403 uint64_t ifm_active; /* active options */ 404 int ifm_count; /* # entries in ifm_ulist array */ 405 uint64_t *ifm_ulist; /* media words */ 406}; 407 408struct ifkalivereq { 409 char ikar_name[IFNAMSIZ]; /* if name, e.g. "en0" */ 410 int ikar_timeo; 411 int ikar_cnt; 412}; 413 414/* 415 * Structure used in SIOCGIFCONF request. 416 * Used to retrieve interface configuration 417 * for machine (useful for programs which 418 * must know all networks accessible). 419 */ 420struct ifconf { 421 int ifc_len; /* size of associated buffer */ 422 union { 423 caddr_t ifcu_buf; 424 struct ifreq *ifcu_req; 425 } ifc_ifcu; 426#define ifc_buf ifc_ifcu.ifcu_buf /* buffer address */ 427#define ifc_req ifc_ifcu.ifcu_req /* array of structures returned */ 428}; 429 430/* 431 * Structure for SIOC[AGD]LIFADDR 432 */ 433struct if_laddrreq { 434 char iflr_name[IFNAMSIZ]; 435 unsigned int flags; 436#define IFLR_PREFIX 0x8000 /* in: prefix given out: kernel fills id */ 437 unsigned int prefixlen; /* in/out */ 438 struct sockaddr_storage addr; /* in/out */ 439 struct sockaddr_storage dstaddr; /* out */ 440}; 441 442/* SIOCIFAFDETACH */ 443struct if_afreq { 444 char ifar_name[IFNAMSIZ]; 445 sa_family_t ifar_af; 446}; 447 448/* SIOC[SG]IFPARENT */ 449struct if_parent { 450 char ifp_name[IFNAMSIZ]; 451 char ifp_parent[IFNAMSIZ]; 452}; 453 454#include <net/if_arp.h> 455 456#ifdef _KERNEL 457struct socket; 458struct ifnet; 459 460void if_alloc_sadl(struct ifnet *); 461void if_free_sadl(struct ifnet *); 462void if_attach(struct ifnet *); 463void if_attachtail(struct ifnet *); 464void if_attachhead(struct ifnet *); 465void if_deactivate(struct ifnet *); 466void if_detach(struct ifnet *); 467void if_down(struct ifnet *); 468void if_downall(void); 469void if_link_state_change(struct ifnet *); 470void if_slowtimo(void *); 471void if_up(struct ifnet *); 472int ifconf(u_long, caddr_t); 473void ifinit(void); 474int ifioctl(struct socket *, u_long, caddr_t, struct proc *); 475int ifpromisc(struct ifnet *, int); 476struct ifg_group *if_creategroup(const char *); 477int if_addgroup(struct ifnet *, const char *); 478int if_delgroup(struct ifnet *, const char *); 479void if_group_routechange(struct sockaddr *, struct sockaddr *); 480struct ifnet *ifunit(const char *); 481struct ifnet *if_get(unsigned int); 482void if_put(struct ifnet *); 483void ifnewlladdr(struct ifnet *); 484void if_congestion(void); 485int if_congested(void); 486__dead void unhandled_af(int); 487int if_setlladdr(struct ifnet *, const uint8_t *); 488 489#endif /* _KERNEL */ 490 491#endif /* __BSD_VISIBLE */ 492 493#endif /* _NET_IF_H_ */ 494