if.h revision 1.198
1/* $OpenBSD: if.h,v 1.198 2018/11/12 23:34:48 dlg 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#include <sys/types.h> 63#include <sys/time.h> 64#include <sys/socket.h> 65 66/* 67 * Structure used to query names of interface cloners. 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#define MCLPOOLS 8 /* number of cluster pools */ 76 77struct if_rxring { 78 int rxr_adjusted; 79 u_int rxr_alive; 80 u_int rxr_cwm; 81 u_int rxr_lwm; 82 u_int rxr_hwm; 83}; 84 85struct if_rxring_info { 86 char ifr_name[16]; /* name of the ring */ 87 u_int ifr_size; /* size of the packets on the ring */ 88 struct if_rxring ifr_info; 89}; 90 91/* Structure used in SIOCGIFRXR request. */ 92struct if_rxrinfo { 93 u_int ifri_total; 94 struct if_rxring_info *ifri_entries; 95}; 96 97/* 98 * Structure defining statistics and other data kept regarding a network 99 * interface. 100 */ 101struct if_data { 102 /* generic interface information */ 103 u_char ifi_type; /* ethernet, tokenring, etc. */ 104 u_char ifi_addrlen; /* media address length */ 105 u_char ifi_hdrlen; /* media header length */ 106 u_char ifi_link_state; /* current link state */ 107 u_int32_t ifi_mtu; /* maximum transmission unit */ 108 u_int32_t ifi_metric; /* routing metric (external only) */ 109 u_int32_t ifi_rdomain; /* routing instance */ 110 u_int64_t ifi_baudrate; /* linespeed */ 111 /* volatile statistics */ 112 u_int64_t ifi_ipackets; /* packets received on interface */ 113 u_int64_t ifi_ierrors; /* input errors on interface */ 114 u_int64_t ifi_opackets; /* packets sent on interface */ 115 u_int64_t ifi_oerrors; /* output errors on interface */ 116 u_int64_t ifi_collisions; /* collisions on csma interfaces */ 117 u_int64_t ifi_ibytes; /* total number of octets received */ 118 u_int64_t ifi_obytes; /* total number of octets sent */ 119 u_int64_t ifi_imcasts; /* packets received via multicast */ 120 u_int64_t ifi_omcasts; /* packets sent via multicast */ 121 u_int64_t ifi_iqdrops; /* dropped on input, this interface */ 122 u_int64_t ifi_oqdrops; /* dropped on output, this interface */ 123 u_int64_t ifi_noproto; /* destined for unsupported protocol */ 124 u_int32_t ifi_capabilities; /* interface capabilities */ 125 struct timeval ifi_lastchange; /* last operational state change */ 126}; 127 128#define IFQ_NQUEUES 8 129#define IFQ_MINPRIO 0 130#define IFQ_MAXPRIO IFQ_NQUEUES - 1 131#define IFQ_DEFPRIO 3 132#define IFQ_PRIO2TOS(_p) ((_p) << 5) 133#define IFQ_TOS2PRIO(_t) ((_t) >> 5) 134 135/* 136 * Values for if_link_state. 137 */ 138#define LINK_STATE_UNKNOWN 0 /* link unknown */ 139#define LINK_STATE_INVALID 1 /* link invalid */ 140#define LINK_STATE_DOWN 2 /* link is down */ 141#define LINK_STATE_KALIVE_DOWN 3 /* keepalive reports down */ 142#define LINK_STATE_UP 4 /* link is up */ 143#define LINK_STATE_HALF_DUPLEX 5 /* link is up and half duplex */ 144#define LINK_STATE_FULL_DUPLEX 6 /* link is up and full duplex */ 145 146#define LINK_STATE_IS_UP(_s) \ 147 ((_s) >= LINK_STATE_UP || (_s) == LINK_STATE_UNKNOWN) 148 149/* 150 * Status bit descriptions for the various interface types. 151 */ 152struct if_status_description { 153 u_char ifs_type; 154 u_char ifs_state; 155 const char *ifs_string; 156}; 157 158#define LINK_STATE_DESC_MATCH(_ifs, _t, _s) \ 159 (((_ifs)->ifs_type == (_t) || (_ifs)->ifs_type == 0) && \ 160 (_ifs)->ifs_state == (_s)) 161 162 163#define LINK_STATE_DESCRIPTIONS { \ 164 { IFT_ETHER, LINK_STATE_DOWN, "no carrier" }, \ 165 \ 166 { IFT_IEEE80211, LINK_STATE_DOWN, "no network" }, \ 167 \ 168 { IFT_PPP, LINK_STATE_DOWN, "no carrier" }, \ 169 \ 170 { IFT_CARP, LINK_STATE_DOWN, "backup" }, \ 171 { IFT_CARP, LINK_STATE_UP, "master" }, \ 172 { IFT_CARP, LINK_STATE_HALF_DUPLEX, "master" }, \ 173 { IFT_CARP, LINK_STATE_FULL_DUPLEX, "master" }, \ 174 \ 175 { 0, LINK_STATE_UP, "active" }, \ 176 { 0, LINK_STATE_HALF_DUPLEX, "active" }, \ 177 { 0, LINK_STATE_FULL_DUPLEX, "active" }, \ 178 \ 179 { 0, LINK_STATE_UNKNOWN, "unknown" }, \ 180 { 0, LINK_STATE_INVALID, "invalid" }, \ 181 { 0, LINK_STATE_DOWN, "down" }, \ 182 { 0, LINK_STATE_KALIVE_DOWN, "keepalive down" }, \ 183 { 0, 0, NULL } \ 184} 185 186/* Traditional BSD name for length of interface external name. */ 187#define IFNAMSIZ IF_NAMESIZE 188 189/* 190 * Length of interface description, including terminating '\0'. 191 */ 192#define IFDESCRSIZE 64 193 194/* 195 * Interface flags can be either owned by the stack or the driver. The 196 * symbols below document who is toggling which flag. 197 * 198 * I immutable after creation 199 * N written by the stack (upon user request) 200 * d written by the driver 201 * c for userland compatibility only 202 */ 203#define IFF_UP 0x1 /* [N] interface is up */ 204#define IFF_BROADCAST 0x2 /* [I] broadcast address valid */ 205#define IFF_DEBUG 0x4 /* [N] turn on debugging */ 206#define IFF_LOOPBACK 0x8 /* [I] is a loopback net */ 207#define IFF_POINTOPOINT 0x10 /* [I] is point-to-point link */ 208#define IFF_STATICARP 0x20 /* [N] only static ARP */ 209#define IFF_RUNNING 0x40 /* [d] resources allocated */ 210#define IFF_NOARP 0x80 /* [N] no address resolution protocol */ 211#define IFF_PROMISC 0x100 /* [N] receive all packets */ 212#define IFF_ALLMULTI 0x200 /* [d] receive all multicast packets */ 213#define IFF_OACTIVE 0x400 /* [c] transmission in progress */ 214#define IFF_SIMPLEX 0x800 /* [I] can't hear own transmissions */ 215#define IFF_LINK0 0x1000 /* [N] per link layer defined bit */ 216#define IFF_LINK1 0x2000 /* [N] per link layer defined bit */ 217#define IFF_LINK2 0x4000 /* [N] per link layer defined bit */ 218#define IFF_MULTICAST 0x8000 /* [I] supports multicast */ 219 220/* flags set internally only: */ 221#define IFF_CANTCHANGE \ 222 (IFF_BROADCAST|IFF_POINTOPOINT|IFF_RUNNING|IFF_OACTIVE|\ 223 IFF_SIMPLEX|IFF_MULTICAST|IFF_ALLMULTI) 224 225#define IFXF_MPSAFE 0x1 /* [I] if_start is mpsafe */ 226#define IFXF_CLONED 0x2 /* [I] pseudo interface */ 227#define IFXF_INET6_NOPRIVACY 0x4 /* [N] don't autoconf privacy */ 228#define IFXF_MPLS 0x8 /* [N] supports MPLS */ 229#define IFXF_WOL 0x10 /* [N] wake on lan enabled */ 230#define IFXF_AUTOCONF6 0x20 /* [N] v6 autoconf enabled */ 231#define IFXF_INET6_NOSOII 0x40 /* [N] don't do RFC 7217 */ 232 233#define IFXF_CANTCHANGE \ 234 (IFXF_MPSAFE|IFXF_CLONED) 235 236/* 237 * Some convenience macros used for setting ifi_baudrate. 238 */ 239#define IF_Kbps(x) ((x) * 1000ULL) /* kilobits/sec. */ 240#define IF_Mbps(x) (IF_Kbps((x) * 1000ULL)) /* megabits/sec. */ 241#define IF_Gbps(x) (IF_Mbps((x) * 1000ULL)) /* gigabits/sec. */ 242 243/* Capabilities that interfaces can advertise. */ 244#define IFCAP_CSUM_IPv4 0x00000001 /* can do IPv4 header csum */ 245#define IFCAP_CSUM_TCPv4 0x00000002 /* can do IPv4/TCP csum */ 246#define IFCAP_CSUM_UDPv4 0x00000004 /* can do IPv4/UDP csum */ 247#define IFCAP_VLAN_MTU 0x00000010 /* VLAN-compatible MTU */ 248#define IFCAP_VLAN_HWTAGGING 0x00000020 /* hardware VLAN tag support */ 249#define IFCAP_CSUM_TCPv6 0x00000080 /* can do IPv6/TCP checksums */ 250#define IFCAP_CSUM_UDPv6 0x00000100 /* can do IPv6/UDP checksums */ 251#define IFCAP_WOL 0x00008000 /* can do wake on lan */ 252 253#define IFCAP_CSUM_MASK (IFCAP_CSUM_IPv4 | IFCAP_CSUM_TCPv4 | \ 254 IFCAP_CSUM_UDPv4 | IFCAP_CSUM_TCPv6 | IFCAP_CSUM_UDPv6) 255 256/* symbolic names for terminal (per-protocol) CTL_IFQ_ nodes */ 257#define IFQCTL_LEN 1 258#define IFQCTL_MAXLEN 2 259#define IFQCTL_DROPS 3 260#define IFQCTL_CONGESTION 4 261#define IFQCTL_MAXID 5 262 263/* sysctl for ifq (per-protocol packet input queue variant of ifqueue) */ 264#define CTL_IFQ_NAMES { \ 265 { 0, 0 }, \ 266 { "len", CTLTYPE_INT }, \ 267 { "maxlen", CTLTYPE_INT }, \ 268 { "drops", CTLTYPE_INT }, \ 269 { "congestion", CTLTYPE_INT }, \ 270} 271 272/* 273 * Message format for use in obtaining information about interfaces 274 * from sysctl and the routing socket. 275 */ 276struct if_msghdr { 277 u_short ifm_msglen; /* to skip over non-understood messages */ 278 u_char ifm_version; /* future binary compatibility */ 279 u_char ifm_type; /* message type */ 280 u_short ifm_hdrlen; /* sizeof(if_msghdr) to skip over the header */ 281 u_short ifm_index; /* index for associated ifp */ 282 u_short ifm_tableid; /* routing table id */ 283 u_char ifm_pad1; 284 u_char ifm_pad2; 285 int ifm_addrs; /* like rtm_addrs */ 286 int ifm_flags; /* value of if_flags */ 287 int ifm_xflags; 288 struct if_data ifm_data;/* statistics and other data about if */ 289}; 290 291/* 292 * Message format for use in obtaining information about interface addresses 293 * from sysctl and the routing socket. 294 */ 295struct ifa_msghdr { 296 u_short ifam_msglen; /* to skip over non-understood messages */ 297 u_char ifam_version; /* future binary compatibility */ 298 u_char ifam_type; /* message type */ 299 u_short ifam_hdrlen; /* sizeof(ifa_msghdr) to skip over the header */ 300 u_short ifam_index; /* index for associated ifp */ 301 u_short ifam_tableid; /* routing table id */ 302 u_char ifam_pad1; 303 u_char ifam_pad2; 304 int ifam_addrs; /* like rtm_addrs */ 305 int ifam_flags; /* value of ifa_flags */ 306 int ifam_metric; /* value of ifa_metric */ 307}; 308 309/* 310 * Message format announcing the arrival or departure of a network interface. 311 */ 312struct if_announcemsghdr { 313 u_short ifan_msglen; /* to skip over non-understood messages */ 314 u_char ifan_version; /* future binary compatibility */ 315 u_char ifan_type; /* message type */ 316 u_short ifan_hdrlen; /* sizeof(if_announcemsghdr) to skip header */ 317 u_short ifan_index; /* index for associated ifp */ 318 u_short ifan_what; /* what type of announcement */ 319 char ifan_name[IFNAMSIZ]; /* if name, e.g. "en0" */ 320}; 321 322#define IFAN_ARRIVAL 0 /* interface arrival */ 323#define IFAN_DEPARTURE 1 /* interface departure */ 324 325/* message format used to pass 80211 interface info */ 326struct if_ieee80211_data { 327 uint8_t ifie_channel; /* IEEE80211_CHAN_MAX == 255 */ 328 uint8_t ifie_nwid_len; 329 uint32_t ifie_flags; /* ieee80211com.ic_flags */ 330 uint32_t ifie_xflags; /* ieee80211com.ic xflags */ 331 uint8_t ifie_nwid[32]; /* IEEE80211_NWID_LEN */ 332 uint8_t ifie_addr[6]; /* IEEE80211_ADDR_LEN */ 333}; 334 335struct if_ieee80211_msghdr { 336 uint16_t ifim_msglen; 337 uint8_t ifim_version; 338 uint8_t ifim_type; 339 uint16_t ifim_hdrlen; 340 uint16_t ifim_index; 341 uint16_t ifim_tableid; 342 343 struct if_ieee80211_data ifim_ifie; 344}; 345 346/* message format used to pass interface name to index mappings */ 347struct if_nameindex_msg { 348 unsigned int if_index; 349 char if_name[IFNAMSIZ]; 350}; 351 352/* 353 * interface groups 354 */ 355 356#define IFG_ALL "all" /* group contains all interfaces */ 357#define IFG_EGRESS "egress" /* if(s) default route(s) point to */ 358 359struct ifg_req { 360 union { 361 char ifgrqu_group[IFNAMSIZ]; 362 char ifgrqu_member[IFNAMSIZ]; 363 } ifgrq_ifgrqu; 364#define ifgrq_group ifgrq_ifgrqu.ifgrqu_group 365#define ifgrq_member ifgrq_ifgrqu.ifgrqu_member 366}; 367 368struct ifg_attrib { 369 int ifg_carp_demoted; 370}; 371 372/* 373 * Used to lookup groups for an interface 374 */ 375struct ifgroupreq { 376 char ifgr_name[IFNAMSIZ]; 377 u_int ifgr_len; 378 union { 379 char ifgru_group[IFNAMSIZ]; 380 struct ifg_req *ifgru_groups; 381 struct ifg_attrib ifgru_attrib; 382 } ifgr_ifgru; 383#define ifgr_group ifgr_ifgru.ifgru_group 384#define ifgr_groups ifgr_ifgru.ifgru_groups 385#define ifgr_attrib ifgr_ifgru.ifgru_attrib 386}; 387 388/* 389 * Interface request structure used for socket 390 * ioctl's. All interface ioctl's must have parameter 391 * definitions which begin with ifr_name. The 392 * remainder may be interface specific. 393 */ 394struct ifreq { 395 char ifr_name[IFNAMSIZ]; /* if name, e.g. "en0" */ 396 union { 397 struct sockaddr ifru_addr; 398 struct sockaddr ifru_dstaddr; 399 struct sockaddr ifru_broadaddr; 400 short ifru_flags; 401 int ifru_metric; 402 int64_t ifru_vnetid; 403 uint64_t ifru_media; 404 caddr_t ifru_data; 405 unsigned int ifru_index; 406 } ifr_ifru; 407#define ifr_addr ifr_ifru.ifru_addr /* address */ 408#define ifr_dstaddr ifr_ifru.ifru_dstaddr /* other end of p-to-p link */ 409#define ifr_broadaddr ifr_ifru.ifru_broadaddr /* broadcast address */ 410#define ifr_flags ifr_ifru.ifru_flags /* flags */ 411#define ifr_metric ifr_ifru.ifru_metric /* metric */ 412#define ifr_mtu ifr_ifru.ifru_metric /* mtu (overload) */ 413#define ifr_hardmtu ifr_ifru.ifru_metric /* hardmtu (overload) */ 414#define ifr_media ifr_ifru.ifru_media /* media options */ 415#define ifr_rdomainid ifr_ifru.ifru_metric /* VRF instance (overload) */ 416#define ifr_vnetid ifr_ifru.ifru_vnetid /* Virtual Net Id */ 417#define ifr_ttl ifr_ifru.ifru_metric /* tunnel TTL (overload) */ 418#define ifr_df ifr_ifru.ifru_metric /* tunnel DF (overload) */ 419#define ifr_data ifr_ifru.ifru_data /* for use by interface */ 420#define ifr_index ifr_ifru.ifru_index /* interface index */ 421#define ifr_llprio ifr_ifru.ifru_metric /* link layer priority */ 422#define ifr_hdrprio ifr_ifru.ifru_metric /* header prio field config */ 423}; 424 425#define IF_HDRPRIO_MIN IFQ_MINPRIO 426#define IF_HDRPRIO_MAX IFQ_MAXPRIO 427#define IF_HDRPRIO_PACKET -1 /* use mbuf prio */ 428#define IF_HDRPRIO_PAYLOAD -2 /* copy payload prio */ 429 430struct ifaliasreq { 431 char ifra_name[IFNAMSIZ]; /* if name, e.g. "en0" */ 432 union { 433 struct sockaddr ifrau_addr; 434 int ifrau_align; 435 } ifra_ifrau; 436#ifndef ifra_addr 437#define ifra_addr ifra_ifrau.ifrau_addr 438#endif 439 struct sockaddr ifra_dstaddr; 440#define ifra_broadaddr ifra_dstaddr 441 struct sockaddr ifra_mask; 442}; 443 444struct ifmediareq { 445 char ifm_name[IFNAMSIZ]; /* if name, e.g. "en0" */ 446 uint64_t ifm_current; /* get/set current media options */ 447 uint64_t ifm_mask; /* don't care mask */ 448 uint64_t ifm_status; /* media status */ 449 uint64_t ifm_active; /* active options */ 450 int ifm_count; /* # entries in ifm_ulist array */ 451 uint64_t *ifm_ulist; /* media words */ 452}; 453 454struct ifkalivereq { 455 char ikar_name[IFNAMSIZ]; /* if name, e.g. "en0" */ 456 int ikar_timeo; 457 int ikar_cnt; 458}; 459 460/* 461 * Structure used in SIOCGIFCONF request. 462 * Used to retrieve interface configuration 463 * for machine (useful for programs which 464 * must know all networks accessible). 465 */ 466struct ifconf { 467 int ifc_len; /* size of associated buffer */ 468 union { 469 caddr_t ifcu_buf; 470 struct ifreq *ifcu_req; 471 } ifc_ifcu; 472#define ifc_buf ifc_ifcu.ifcu_buf /* buffer address */ 473#define ifc_req ifc_ifcu.ifcu_req /* array of structures returned */ 474}; 475 476/* 477 * Structure for SIOC[AGD]LIFADDR 478 */ 479struct if_laddrreq { 480 char iflr_name[IFNAMSIZ]; 481 unsigned int flags; 482#define IFLR_PREFIX 0x8000 /* in: prefix given out: kernel fills id */ 483 unsigned int prefixlen; /* in/out */ 484 struct sockaddr_storage addr; /* in/out */ 485 struct sockaddr_storage dstaddr; /* out */ 486}; 487 488/* SIOCIFAFDETACH */ 489struct if_afreq { 490 char ifar_name[IFNAMSIZ]; 491 sa_family_t ifar_af; 492}; 493 494/* SIOC[SG]IFPARENT */ 495struct if_parent { 496 char ifp_name[IFNAMSIZ]; 497 char ifp_parent[IFNAMSIZ]; 498}; 499 500#include <net/if_arp.h> 501 502#ifdef _KERNEL 503struct socket; 504struct ifnet; 505struct ifq_ops; 506 507void if_alloc_sadl(struct ifnet *); 508void if_free_sadl(struct ifnet *); 509void if_attach(struct ifnet *); 510void if_attach_queues(struct ifnet *, unsigned int); 511void if_attach_iqueues(struct ifnet *, unsigned int); 512void if_attach_ifq(struct ifnet *, const struct ifq_ops *, void *); 513void if_attachtail(struct ifnet *); 514void if_attachhead(struct ifnet *); 515void if_deactivate(struct ifnet *); 516void if_detach(struct ifnet *); 517void if_down(struct ifnet *); 518void if_downall(void); 519void if_link_state_change(struct ifnet *); 520void if_up(struct ifnet *); 521void if_getdata(struct ifnet *, struct if_data *); 522void ifinit(void); 523int ifioctl(struct socket *, u_long, caddr_t, struct proc *); 524int ifpromisc(struct ifnet *, int); 525struct ifg_group *if_creategroup(const char *); 526int if_addgroup(struct ifnet *, const char *); 527int if_delgroup(struct ifnet *, const char *); 528void if_group_routechange(struct sockaddr *, struct sockaddr *); 529struct ifnet *ifunit(const char *); 530struct ifnet *if_get(unsigned int); 531void if_put(struct ifnet *); 532void ifnewlladdr(struct ifnet *); 533void if_congestion(void); 534int if_congested(void); 535__dead void unhandled_af(int); 536int if_setlladdr(struct ifnet *, const uint8_t *); 537struct taskq * net_tq(unsigned int); 538 539#endif /* _KERNEL */ 540 541#endif /* __BSD_VISIBLE */ 542 543#endif /* _NET_IF_H_ */ 544