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