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