if.h revision 1.187
1 /* $NetBSD: if.h,v 1.187 2015/04/07 23:30:36 roy Exp $ */ 2 3 /*- 4 * Copyright (c) 1999, 2000, 2001 The NetBSD Foundation, Inc. 5 * All rights reserved. 6 * 7 * This code is derived from software contributed to The NetBSD Foundation 8 * by William Studenmund and Jason R. Thorpe. 9 * 10 * Redistribution and use in source and binary forms, with or without 11 * modification, are permitted provided that the following conditions 12 * are met: 13 * 1. Redistributions of source code must retain the above copyright 14 * notice, this list of conditions and the following disclaimer. 15 * 2. Redistributions in binary form must reproduce the above copyright 16 * notice, this list of conditions and the following disclaimer in the 17 * documentation and/or other materials provided with the distribution. 18 * 19 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 20 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 21 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 22 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 23 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 24 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 25 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 26 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 27 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 28 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 29 * POSSIBILITY OF SUCH DAMAGE. 30 */ 31 32 /* 33 * Copyright (c) 1982, 1986, 1989, 1993 34 * The Regents of the University of California. All rights reserved. 35 * 36 * Redistribution and use in source and binary forms, with or without 37 * modification, are permitted provided that the following conditions 38 * are met: 39 * 1. Redistributions of source code must retain the above copyright 40 * notice, this list of conditions and the following disclaimer. 41 * 2. Redistributions in binary form must reproduce the above copyright 42 * notice, this list of conditions and the following disclaimer in the 43 * documentation and/or other materials provided with the distribution. 44 * 3. Neither the name of the University nor the names of its contributors 45 * may be used to endorse or promote products derived from this software 46 * without specific prior written permission. 47 * 48 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 49 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 50 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 51 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 52 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 53 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 54 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 55 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 56 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 57 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 58 * SUCH DAMAGE. 59 * 60 * @(#)if.h 8.3 (Berkeley) 2/9/95 61 */ 62 63 #ifndef _NET_IF_H_ 64 #define _NET_IF_H_ 65 66 #if !defined(_KERNEL) && !defined(_STANDALONE) 67 #include <stdbool.h> 68 #endif 69 70 #include <sys/featuretest.h> 71 72 /* 73 * Length of interface external name, including terminating '\0'. 74 * Note: this is the same size as a generic device's external name. 75 */ 76 #define IF_NAMESIZE 16 77 78 #if defined(_NETBSD_SOURCE) 79 80 #include <sys/socket.h> 81 #include <sys/queue.h> 82 #include <sys/mutex.h> 83 84 #include <net/dlt.h> 85 #include <net/pfil.h> 86 #ifdef _KERNEL 87 #include <net/pktqueue.h> 88 #endif 89 90 /* 91 * Always include ALTQ glue here -- we use the ALTQ interface queue 92 * structure even when ALTQ is not configured into the kernel so that 93 * the size of struct ifnet does not changed based on the option. The 94 * ALTQ queue structure is API-compatible with the legacy ifqueue. 95 */ 96 #include <altq/if_altq.h> 97 98 /* 99 * Structures defining a network interface, providing a packet 100 * transport mechanism (ala level 0 of the PUP protocols). 101 * 102 * Each interface accepts output datagrams of a specified maximum 103 * length, and provides higher level routines with input datagrams 104 * received from its medium. 105 * 106 * Output occurs when the routine if_output is called, with four parameters: 107 * (*ifp->if_output)(ifp, m, dst, rt) 108 * Here m is the mbuf chain to be sent and dst is the destination address. 109 * The output routine encapsulates the supplied datagram if necessary, 110 * and then transmits it on its medium. 111 * 112 * On input, each interface unwraps the data received by it, and either 113 * places it on the input queue of a internetwork datagram routine 114 * and posts the associated software interrupt, or passes the datagram to a raw 115 * packet input routine. 116 * 117 * Routines exist for locating interfaces by their addresses 118 * or for locating a interface on a certain network, as well as more general 119 * routing and gateway routines maintaining information used to locate 120 * interfaces. These routines live in the files if.c and route.c 121 */ 122 #include <sys/time.h> 123 124 #if defined(_KERNEL_OPT) 125 #include "opt_compat_netbsd.h" 126 #endif 127 128 struct mbuf; 129 struct proc; 130 struct rtentry; 131 struct socket; 132 struct ether_header; 133 struct ifaddr; 134 struct ifnet; 135 struct rt_addrinfo; 136 137 #define IFNAMSIZ IF_NAMESIZE 138 139 /* 140 * Structure describing a `cloning' interface. 141 */ 142 struct if_clone { 143 LIST_ENTRY(if_clone) ifc_list; /* on list of cloners */ 144 const char *ifc_name; /* name of device, e.g. `gif' */ 145 size_t ifc_namelen; /* length of name */ 146 147 int (*ifc_create)(struct if_clone *, int); 148 int (*ifc_destroy)(struct ifnet *); 149 }; 150 151 #define IF_CLONE_INITIALIZER(name, create, destroy) \ 152 { { NULL, NULL }, name, sizeof(name) - 1, create, destroy } 153 154 /* 155 * Structure used to query names of interface cloners. 156 */ 157 struct if_clonereq { 158 int ifcr_total; /* total cloners (out) */ 159 int ifcr_count; /* room for this many in user buffer */ 160 char *ifcr_buffer; /* buffer for cloner names */ 161 }; 162 163 /* 164 * Structure defining statistics and other data kept regarding a network 165 * interface. 166 */ 167 struct if_data { 168 /* generic interface information */ 169 u_char ifi_type; /* ethernet, tokenring, etc. */ 170 u_char ifi_addrlen; /* media address length */ 171 u_char ifi_hdrlen; /* media header length */ 172 int ifi_link_state; /* current link state */ 173 uint64_t ifi_mtu; /* maximum transmission unit */ 174 uint64_t ifi_metric; /* routing metric (external only) */ 175 uint64_t ifi_baudrate; /* linespeed */ 176 /* volatile statistics */ 177 uint64_t ifi_ipackets; /* packets received on interface */ 178 uint64_t ifi_ierrors; /* input errors on interface */ 179 uint64_t ifi_opackets; /* packets sent on interface */ 180 uint64_t ifi_oerrors; /* output errors on interface */ 181 uint64_t ifi_collisions; /* collisions on csma interfaces */ 182 uint64_t ifi_ibytes; /* total number of octets received */ 183 uint64_t ifi_obytes; /* total number of octets sent */ 184 uint64_t ifi_imcasts; /* packets received via multicast */ 185 uint64_t ifi_omcasts; /* packets sent via multicast */ 186 uint64_t ifi_iqdrops; /* dropped on input, this interface */ 187 uint64_t ifi_noproto; /* destined for unsupported protocol */ 188 struct timespec ifi_lastchange;/* last operational state change */ 189 }; 190 191 /* 192 * Values for if_link_state. 193 */ 194 #define LINK_STATE_UNKNOWN 0 /* link invalid/unknown */ 195 #define LINK_STATE_DOWN 1 /* link is down */ 196 #define LINK_STATE_UP 2 /* link is up */ 197 198 /* 199 * Structure defining a queue for a network interface. 200 */ 201 struct ifqueue { 202 struct mbuf *ifq_head; 203 struct mbuf *ifq_tail; 204 int ifq_len; 205 int ifq_maxlen; 206 int ifq_drops; 207 kmutex_t *ifq_lock; 208 }; 209 210 struct ifnet_lock; 211 212 #ifdef _KERNEL 213 #include <sys/condvar.h> 214 #include <sys/percpu.h> 215 #include <sys/callout.h> 216 217 struct ifnet_lock { 218 kmutex_t il_lock; /* Protects the critical section. */ 219 uint64_t il_nexit; /* Counts threads across all CPUs who 220 * have exited the critical section. 221 * Access to il_nexit is synchronized 222 * by il_lock. 223 */ 224 percpu_t *il_nenter; /* Counts threads on each CPU who have 225 * entered or who wait to enter the 226 * critical section protected by il_lock. 227 * Synchronization is not required. 228 */ 229 kcondvar_t il_emptied; /* The ifnet_lock user must arrange for 230 * the last threads in the critical 231 * section to signal this condition variable 232 * before they leave. 233 */ 234 }; 235 #endif /* _KERNEL */ 236 237 /* 238 * Structure defining a queue for a network interface. 239 * 240 * (Would like to call this struct ``if'', but C isn't PL/1.) 241 */ 242 TAILQ_HEAD(ifnet_head, ifnet); /* the actual queue head */ 243 244 struct bridge_softc; 245 struct bridge_iflist; 246 struct callout; 247 248 typedef struct ifnet { 249 void *if_softc; /* lower-level data for this if */ 250 TAILQ_ENTRY(ifnet) if_list; /* all struct ifnets are chained */ 251 TAILQ_HEAD(, ifaddr) if_addrlist; /* linked list of addresses per if */ 252 char if_xname[IFNAMSIZ]; /* external name (name + unit) */ 253 int if_pcount; /* number of promiscuous listeners */ 254 struct bpf_if *if_bpf; /* packet filter structure */ 255 u_short if_index; /* numeric abbreviation for this if */ 256 short if_timer; /* time 'til if_slowtimo called */ 257 short if_flags; /* up/down, broadcast, etc. */ 258 short if__pad1; /* be nice to m68k ports */ 259 struct if_data if_data; /* statistics and other data about if */ 260 /* 261 * Procedure handles. If you add more of these, don't forget the 262 * corresponding NULL stub in if.c. 263 */ 264 int (*if_output) /* output routine (enqueue) */ 265 (struct ifnet *, struct mbuf *, const struct sockaddr *, 266 struct rtentry *); 267 void (*if_input) /* input routine (from h/w driver) */ 268 (struct ifnet *, struct mbuf *); 269 void (*if_start) /* initiate output routine */ 270 (struct ifnet *); 271 int (*if_ioctl) /* ioctl routine */ 272 (struct ifnet *, u_long, void *); 273 int (*if_init) /* init routine */ 274 (struct ifnet *); 275 void (*if_stop) /* stop routine */ 276 (struct ifnet *, int); 277 void (*if_slowtimo) /* timer routine */ 278 (struct ifnet *); 279 #define if_watchdog if_slowtimo 280 void (*if_drain) /* routine to release resources */ 281 (struct ifnet *); 282 struct ifaltq if_snd; /* output queue (includes altq) */ 283 struct ifaddr *if_dl; /* identity of this interface. */ 284 const struct sockaddr_dl *if_sadl; /* pointer to sockaddr_dl 285 * of if_dl 286 */ 287 /* if_hwdl: h/w identity 288 * 289 * May be NULL. If not NULL, it is the address assigned 290 * to the interface by the manufacturer, so it very likely 291 * to be unique. It MUST NOT be deleted. It is highly 292 * suitable for deriving the EUI64 for the interface. 293 */ 294 struct ifaddr *if_hwdl; 295 const uint8_t *if_broadcastaddr;/* linklevel broadcast bytestring */ 296 struct bridge_softc *if_bridge; /* bridge glue */ 297 struct bridge_iflist *if_bridgeif; /* shortcut to interface list entry */ 298 int if_dlt; /* data link type (<net/dlt.h>) */ 299 pfil_head_t * if_pfil; /* filtering point */ 300 uint64_t if_capabilities; /* interface capabilities */ 301 uint64_t if_capenable; /* capabilities enabled */ 302 union { 303 void * carp_s; /* carp structure (used by !carp ifs) */ 304 struct ifnet *carp_d;/* ptr to carpdev (used by carp ifs) */ 305 } if_carp_ptr; 306 #define if_carp if_carp_ptr.carp_s 307 #define if_carpdev if_carp_ptr.carp_d 308 /* 309 * These are pre-computed based on an interfaces enabled 310 * capabilities, for speed elsewhere. 311 */ 312 int if_csum_flags_tx; /* M_CSUM_* flags for Tx */ 313 int if_csum_flags_rx; /* M_CSUM_* flags for Rx */ 314 315 void *if_afdata[AF_MAX]; 316 struct mowner *if_mowner; /* who owns mbufs for this interface */ 317 318 void *if_agrprivate; /* used only when #if NAGR > 0 */ 319 320 /* 321 * pf specific data, used only when #if NPF > 0. 322 */ 323 void *if_pf_kif; /* pf interface abstraction */ 324 void *if_pf_groups; /* pf interface groups */ 325 /* 326 * During an ifnet's lifetime, it has only one if_index, but 327 * and if_index is not sufficient to identify an ifnet 328 * because during the lifetime of the system, many ifnets may occupy a 329 * given if_index. Let us tell different ifnets at the same 330 * if_index apart by their if_index_gen, a unique number that each ifnet 331 * is assigned when it if_attach()s. Now, the kernel can use the 332 * pair (if_index, if_index_gen) as a weak reference to an ifnet. 333 */ 334 uint64_t if_index_gen; /* generation number for the ifnet 335 * at if_index: if two ifnets' index 336 * and generation number are both the 337 * same, they are the same ifnet. 338 */ 339 struct sysctllog *if_sysctl_log; 340 int (*if_initaddr)(struct ifnet *, struct ifaddr *, bool); 341 int (*if_mcastop)(struct ifnet *, const unsigned long, 342 const struct sockaddr *); 343 int (*if_setflags)(struct ifnet *, const short); 344 struct ifnet_lock *if_ioctl_lock; 345 #ifdef _KERNEL /* XXX kvm(3) */ 346 struct callout *if_slowtimo_ch; 347 #endif 348 } ifnet_t; 349 350 #define if_mtu if_data.ifi_mtu 351 #define if_type if_data.ifi_type 352 #define if_addrlen if_data.ifi_addrlen 353 #define if_hdrlen if_data.ifi_hdrlen 354 #define if_metric if_data.ifi_metric 355 #define if_link_state if_data.ifi_link_state 356 #define if_baudrate if_data.ifi_baudrate 357 #define if_ipackets if_data.ifi_ipackets 358 #define if_ierrors if_data.ifi_ierrors 359 #define if_opackets if_data.ifi_opackets 360 #define if_oerrors if_data.ifi_oerrors 361 #define if_collisions if_data.ifi_collisions 362 #define if_ibytes if_data.ifi_ibytes 363 #define if_obytes if_data.ifi_obytes 364 #define if_imcasts if_data.ifi_imcasts 365 #define if_omcasts if_data.ifi_omcasts 366 #define if_iqdrops if_data.ifi_iqdrops 367 #define if_noproto if_data.ifi_noproto 368 #define if_lastchange if_data.ifi_lastchange 369 370 #define IFF_UP 0x0001 /* interface is up */ 371 #define IFF_BROADCAST 0x0002 /* broadcast address valid */ 372 #define IFF_DEBUG 0x0004 /* turn on debugging */ 373 #define IFF_LOOPBACK 0x0008 /* is a loopback net */ 374 #define IFF_POINTOPOINT 0x0010 /* interface is point-to-point link */ 375 #define IFF_NOTRAILERS 0x0020 /* avoid use of trailers */ 376 #define IFF_RUNNING 0x0040 /* resources allocated */ 377 #define IFF_NOARP 0x0080 /* no address resolution protocol */ 378 #define IFF_PROMISC 0x0100 /* receive all packets */ 379 #define IFF_ALLMULTI 0x0200 /* receive all multicast packets */ 380 #define IFF_OACTIVE 0x0400 /* transmission in progress */ 381 #define IFF_SIMPLEX 0x0800 /* can't hear own transmissions */ 382 #define IFF_LINK0 0x1000 /* per link layer defined bit */ 383 #define IFF_LINK1 0x2000 /* per link layer defined bit */ 384 #define IFF_LINK2 0x4000 /* per link layer defined bit */ 385 #define IFF_MULTICAST 0x8000 /* supports multicast */ 386 387 #define IFFBITS \ 388 "\020\1UP\2BROADCAST\3DEBUG\4LOOPBACK\5POINTOPOINT\6NOTRAILERS" \ 389 "\7RUNNING\10NOARP\11PROMISC\12ALLMULTI\13OACTIVE\14SIMPLEX" \ 390 "\15LINK0\16LINK1\17LINK2\20MULTICAST" 391 392 /* flags set internally only: */ 393 #define IFF_CANTCHANGE \ 394 (IFF_BROADCAST|IFF_POINTOPOINT|IFF_RUNNING|IFF_OACTIVE|\ 395 IFF_SIMPLEX|IFF_MULTICAST|IFF_ALLMULTI|IFF_PROMISC) 396 397 /* 398 * Some convenience macros used for setting ifi_baudrate. 399 */ 400 #define IF_Kbps(x) ((x) * 1000ULL) /* kilobits/sec. */ 401 #define IF_Mbps(x) (IF_Kbps((x) * 1000ULL)) /* megabits/sec. */ 402 #define IF_Gbps(x) (IF_Mbps((x) * 1000ULL)) /* gigabits/sec. */ 403 404 /* Capabilities that interfaces can advertise. */ 405 /* 0x01 .. 0x40 were previously used */ 406 #define IFCAP_TSOv4 0x00080 /* can do TCPv4 segmentation offload */ 407 #define IFCAP_CSUM_IPv4_Rx 0x00100 /* can do IPv4 header checksums (Rx) */ 408 #define IFCAP_CSUM_IPv4_Tx 0x00200 /* can do IPv4 header checksums (Tx) */ 409 #define IFCAP_CSUM_TCPv4_Rx 0x00400 /* can do IPv4/TCP checksums (Rx) */ 410 #define IFCAP_CSUM_TCPv4_Tx 0x00800 /* can do IPv4/TCP checksums (Tx) */ 411 #define IFCAP_CSUM_UDPv4_Rx 0x01000 /* can do IPv4/UDP checksums (Rx) */ 412 #define IFCAP_CSUM_UDPv4_Tx 0x02000 /* can do IPv4/UDP checksums (Tx) */ 413 #define IFCAP_CSUM_TCPv6_Rx 0x04000 /* can do IPv6/TCP checksums (Rx) */ 414 #define IFCAP_CSUM_TCPv6_Tx 0x08000 /* can do IPv6/TCP checksums (Tx) */ 415 #define IFCAP_CSUM_UDPv6_Rx 0x10000 /* can do IPv6/UDP checksums (Rx) */ 416 #define IFCAP_CSUM_UDPv6_Tx 0x20000 /* can do IPv6/UDP checksums (Tx) */ 417 #define IFCAP_TSOv6 0x40000 /* can do TCPv6 segmentation offload */ 418 #define IFCAP_LRO 0x80000 /* can do Large Receive Offload */ 419 #define IFCAP_MASK 0xfff80 /* currently valid capabilities */ 420 421 #define IFCAPBITS \ 422 "\020" \ 423 "\10TSO4" \ 424 "\11IP4CSUM_Rx" \ 425 "\12IP4CSUM_Tx" \ 426 "\13TCP4CSUM_Rx" \ 427 "\14TCP4CSUM_Tx" \ 428 "\15UDP4CSUM_Rx" \ 429 "\16UDP4CSUM_Tx" \ 430 "\17TCP6CSUM_Rx" \ 431 "\20TCP6CSUM_Tx" \ 432 "\21UDP6CSUM_Rx" \ 433 "\22UDP6CSUM_Tx" \ 434 "\23TSO6" \ 435 "\24LRO" \ 436 437 #define IFQ_LOCK(_ifq) if ((_ifq)->ifq_lock) mutex_enter((_ifq)->ifq_lock) 438 #define IFQ_UNLOCK(_ifq) if ((_ifq)->ifq_lock) mutex_exit((_ifq)->ifq_lock) 439 440 /* 441 * Output queues (ifp->if_snd) and internetwork datagram level (pup level 1) 442 * input routines have queues of messages stored on ifqueue structures 443 * (defined above). Entries are added to and deleted from these structures 444 * by these macros, which should be called with ipl raised to splnet(). 445 */ 446 #define IF_QFULL(ifq) ((ifq)->ifq_len >= (ifq)->ifq_maxlen) 447 #define IF_DROP(ifq) ((ifq)->ifq_drops++) 448 #define IF_ENQUEUE(ifq, m) do { \ 449 (m)->m_nextpkt = 0; \ 450 if ((ifq)->ifq_tail == 0) \ 451 (ifq)->ifq_head = m; \ 452 else \ 453 (ifq)->ifq_tail->m_nextpkt = m; \ 454 (ifq)->ifq_tail = m; \ 455 (ifq)->ifq_len++; \ 456 } while (/*CONSTCOND*/0) 457 #define IF_PREPEND(ifq, m) do { \ 458 (m)->m_nextpkt = (ifq)->ifq_head; \ 459 if ((ifq)->ifq_tail == 0) \ 460 (ifq)->ifq_tail = (m); \ 461 (ifq)->ifq_head = (m); \ 462 (ifq)->ifq_len++; \ 463 } while (/*CONSTCOND*/0) 464 #define IF_DEQUEUE(ifq, m) do { \ 465 (m) = (ifq)->ifq_head; \ 466 if (m) { \ 467 if (((ifq)->ifq_head = (m)->m_nextpkt) == 0) \ 468 (ifq)->ifq_tail = 0; \ 469 (m)->m_nextpkt = 0; \ 470 (ifq)->ifq_len--; \ 471 } \ 472 } while (/*CONSTCOND*/0) 473 #define IF_POLL(ifq, m) ((m) = (ifq)->ifq_head) 474 #define IF_PURGE(ifq) \ 475 do { \ 476 struct mbuf *__m0; \ 477 \ 478 for (;;) { \ 479 IF_DEQUEUE((ifq), __m0); \ 480 if (__m0 == NULL) \ 481 break; \ 482 else \ 483 m_freem(__m0); \ 484 } \ 485 } while (/*CONSTCOND*/ 0) 486 #define IF_IS_EMPTY(ifq) ((ifq)->ifq_len == 0) 487 488 #ifndef IFQ_MAXLEN 489 #define IFQ_MAXLEN 256 490 #endif 491 #define IFNET_SLOWHZ 1 /* granularity is 1 second */ 492 493 /* 494 * Structure defining statistics and other data kept regarding an address 495 * on a network interface. 496 */ 497 struct ifaddr_data { 498 int64_t ifad_inbytes; 499 int64_t ifad_outbytes; 500 }; 501 502 /* 503 * The ifaddr structure contains information about one address 504 * of an interface. They are maintained by the different address families, 505 * are allocated and attached when an address is set, and are linked 506 * together so all addresses for an interface can be located. 507 */ 508 struct ifaddr { 509 struct sockaddr *ifa_addr; /* address of interface */ 510 struct sockaddr *ifa_dstaddr; /* other end of p-to-p link */ 511 #define ifa_broadaddr ifa_dstaddr /* broadcast address interface */ 512 struct sockaddr *ifa_netmask; /* used to determine subnet */ 513 struct ifnet *ifa_ifp; /* back-pointer to interface */ 514 TAILQ_ENTRY(ifaddr) ifa_list; /* list of addresses for interface */ 515 struct ifaddr_data ifa_data; /* statistics on the address */ 516 void (*ifa_rtrequest) /* check or clean routes (+ or -)'d */ 517 (int, struct rtentry *, const struct rt_addrinfo *); 518 u_int ifa_flags; /* mostly rt_flags for cloning */ 519 int ifa_refcnt; /* count of references */ 520 int ifa_metric; /* cost of going out this interface */ 521 struct ifaddr *(*ifa_getifa)(struct ifaddr *, 522 const struct sockaddr *); 523 uint32_t *ifa_seqno; 524 int16_t ifa_preference; /* preference level for this address */ 525 }; 526 #define IFA_ROUTE RTF_UP /* (0x01) route installed */ 527 528 /* 529 * Message format for use in obtaining information about interfaces from 530 * sysctl and the routing socket. We need to force 64-bit alignment if we 531 * aren't using compatiblity definitons. 532 */ 533 #if !defined(_KERNEL) || !defined(COMPAT_RTSOCK) 534 #define __align64 __aligned(sizeof(uint64_t)) 535 #else 536 #define __align64 537 #endif 538 struct if_msghdr { 539 u_short ifm_msglen __align64; 540 /* to skip over non-understood messages */ 541 u_char ifm_version; /* future binary compatibility */ 542 u_char ifm_type; /* message type */ 543 int ifm_addrs; /* like rtm_addrs */ 544 int ifm_flags; /* value of if_flags */ 545 u_short ifm_index; /* index for associated ifp */ 546 struct if_data ifm_data __align64; 547 /* statistics and other data about if */ 548 }; 549 550 /* 551 * Message format for use in obtaining information about interface addresses 552 * from sysctl and the routing socket. 553 */ 554 struct ifa_msghdr { 555 u_short ifam_msglen __align64; 556 /* to skip over non-understood messages */ 557 u_char ifam_version; /* future binary compatibility */ 558 u_char ifam_type; /* message type */ 559 int ifam_addrs; /* like rtm_addrs */ 560 int ifam_flags; /* value of ifa_flags */ 561 int ifam_metric; /* value of ifa_metric */ 562 u_short ifam_index; /* index for associated ifp */ 563 }; 564 565 /* 566 * Message format announcing the arrival or departure of a network interface. 567 */ 568 struct if_announcemsghdr { 569 u_short ifan_msglen __align64; 570 /* to skip over non-understood messages */ 571 u_char ifan_version; /* future binary compatibility */ 572 u_char ifan_type; /* message type */ 573 u_short ifan_index; /* index for associated ifp */ 574 char ifan_name[IFNAMSIZ]; /* if name, e.g. "en0" */ 575 u_short ifan_what; /* what type of announcement */ 576 }; 577 578 #define IFAN_ARRIVAL 0 /* interface arrival */ 579 #define IFAN_DEPARTURE 1 /* interface departure */ 580 581 #undef __align64 582 583 /* 584 * Interface request structure used for socket 585 * ioctl's. All interface ioctl's must have parameter 586 * definitions which begin with ifr_name. The 587 * remainder may be interface specific. 588 */ 589 struct ifreq { 590 char ifr_name[IFNAMSIZ]; /* if name, e.g. "en0" */ 591 union { 592 struct sockaddr ifru_addr; 593 struct sockaddr ifru_dstaddr; 594 struct sockaddr ifru_broadaddr; 595 struct sockaddr_storage ifru_space; 596 short ifru_flags; 597 int ifru_metric; 598 int ifru_mtu; 599 int ifru_dlt; 600 u_int ifru_value; 601 void * ifru_data; 602 struct { 603 uint32_t b_buflen; 604 void *b_buf; 605 } ifru_b; 606 } ifr_ifru; 607 #define ifr_addr ifr_ifru.ifru_addr /* address */ 608 #define ifr_dstaddr ifr_ifru.ifru_dstaddr /* other end of p-to-p link */ 609 #define ifr_broadaddr ifr_ifru.ifru_broadaddr /* broadcast address */ 610 #define ifr_space ifr_ifru.ifru_space /* sockaddr_storage */ 611 #define ifr_flags ifr_ifru.ifru_flags /* flags */ 612 #define ifr_metric ifr_ifru.ifru_metric /* metric */ 613 #define ifr_mtu ifr_ifru.ifru_mtu /* mtu */ 614 #define ifr_dlt ifr_ifru.ifru_dlt /* data link type (DLT_*) */ 615 #define ifr_value ifr_ifru.ifru_value /* generic value */ 616 #define ifr_media ifr_ifru.ifru_metric /* media options (overload) */ 617 #define ifr_data ifr_ifru.ifru_data /* for use by interface 618 * XXX deprecated 619 */ 620 #define ifr_buf ifr_ifru.ifru_b.b_buf /* new interface ioctls */ 621 #define ifr_buflen ifr_ifru.ifru_b.b_buflen 622 #define ifr_index ifr_ifru.ifru_value /* interface index, BSD */ 623 #define ifr_ifindex ifr_index /* interface index, linux */ 624 }; 625 626 #ifdef _KERNEL 627 #define ifreq_setdstaddr ifreq_setaddr 628 #define ifreq_setbroadaddr ifreq_setaddr 629 #define ifreq_getdstaddr ifreq_getaddr 630 #define ifreq_getbroadaddr ifreq_getaddr 631 632 static inline const struct sockaddr * 633 /*ARGSUSED*/ 634 ifreq_getaddr(u_long cmd, const struct ifreq *ifr) 635 { 636 return &ifr->ifr_addr; 637 } 638 #endif /* _KERNEL */ 639 640 struct ifcapreq { 641 char ifcr_name[IFNAMSIZ]; /* if name, e.g. "en0" */ 642 uint64_t ifcr_capabilities; /* supported capabiliites */ 643 uint64_t ifcr_capenable; /* capabilities enabled */ 644 }; 645 646 struct ifaliasreq { 647 char ifra_name[IFNAMSIZ]; /* if name, e.g. "en0" */ 648 struct sockaddr ifra_addr; 649 struct sockaddr ifra_dstaddr; 650 #define ifra_broadaddr ifra_dstaddr 651 struct sockaddr ifra_mask; 652 }; 653 654 struct ifdatareq { 655 char ifdr_name[IFNAMSIZ]; /* if name, e.g. "en0" */ 656 struct if_data ifdr_data; 657 }; 658 659 struct ifmediareq { 660 char ifm_name[IFNAMSIZ]; /* if name, e.g. "en0" */ 661 int ifm_current; /* current media options */ 662 int ifm_mask; /* don't care mask */ 663 int ifm_status; /* media status */ 664 int ifm_active; /* active options */ 665 int ifm_count; /* # entries in ifm_ulist 666 array */ 667 int *ifm_ulist; /* media words */ 668 }; 669 670 671 struct ifdrv { 672 char ifd_name[IFNAMSIZ]; /* if name, e.g. "en0" */ 673 unsigned long ifd_cmd; 674 size_t ifd_len; 675 void *ifd_data; 676 }; 677 #define IFLINKSTR_QUERYLEN 0x01 678 #define IFLINKSTR_UNSET 0x02 679 680 /* 681 * Structure used in SIOCGIFCONF request. 682 * Used to retrieve interface configuration 683 * for machine (useful for programs which 684 * must know all networks accessible). 685 */ 686 struct ifconf { 687 int ifc_len; /* size of associated buffer */ 688 union { 689 void * ifcu_buf; 690 struct ifreq *ifcu_req; 691 } ifc_ifcu; 692 #define ifc_buf ifc_ifcu.ifcu_buf /* buffer address */ 693 #define ifc_req ifc_ifcu.ifcu_req /* array of structures returned */ 694 }; 695 696 /* 697 * Structure for SIOC[AGD]LIFADDR 698 */ 699 struct if_laddrreq { 700 char iflr_name[IFNAMSIZ]; 701 unsigned int flags; 702 #define IFLR_PREFIX 0x8000 /* in: prefix given out: kernel fills id */ 703 #define IFLR_ACTIVE 0x4000 /* in/out: link-layer address activation */ 704 #define IFLR_FACTORY 0x2000 /* in/out: factory link-layer address */ 705 unsigned int prefixlen; /* in/out */ 706 struct sockaddr_storage addr; /* in/out */ 707 struct sockaddr_storage dstaddr; /* out */ 708 }; 709 710 /* 711 * Structure for SIOC[SG]IFADDRPREF 712 */ 713 struct if_addrprefreq { 714 char ifap_name[IFNAMSIZ]; 715 int16_t ifap_preference; /* in/out */ 716 struct sockaddr_storage ifap_addr; /* in/out */ 717 }; 718 719 #include <net/if_arp.h> 720 721 #endif /* _NETBSD_SOURCE */ 722 723 #ifdef _KERNEL 724 #ifdef ALTQ 725 #define ALTQ_DECL(x) x 726 #define ALTQ_COMMA , 727 728 #define IFQ_ENQUEUE(ifq, m, pattr, err) \ 729 do { \ 730 IFQ_LOCK((ifq)); \ 731 if (ALTQ_IS_ENABLED((ifq))) \ 732 ALTQ_ENQUEUE((ifq), (m), (pattr), (err)); \ 733 else { \ 734 if (IF_QFULL((ifq))) { \ 735 m_freem((m)); \ 736 (err) = ENOBUFS; \ 737 } else { \ 738 IF_ENQUEUE((ifq), (m)); \ 739 (err) = 0; \ 740 } \ 741 } \ 742 if ((err)) \ 743 (ifq)->ifq_drops++; \ 744 IFQ_UNLOCK((ifq)); \ 745 } while (/*CONSTCOND*/ 0) 746 747 #define IFQ_DEQUEUE(ifq, m) \ 748 do { \ 749 IFQ_LOCK((ifq)); \ 750 if (TBR_IS_ENABLED((ifq))) \ 751 (m) = tbr_dequeue((ifq), ALTDQ_REMOVE); \ 752 else if (ALTQ_IS_ENABLED((ifq))) \ 753 ALTQ_DEQUEUE((ifq), (m)); \ 754 else \ 755 IF_DEQUEUE((ifq), (m)); \ 756 IFQ_UNLOCK((ifq)); \ 757 } while (/*CONSTCOND*/ 0) 758 759 #define IFQ_POLL(ifq, m) \ 760 do { \ 761 IFQ_LOCK((ifq)); \ 762 if (TBR_IS_ENABLED((ifq))) \ 763 (m) = tbr_dequeue((ifq), ALTDQ_POLL); \ 764 else if (ALTQ_IS_ENABLED((ifq))) \ 765 ALTQ_POLL((ifq), (m)); \ 766 else \ 767 IF_POLL((ifq), (m)); \ 768 IFQ_UNLOCK((ifq)); \ 769 } while (/*CONSTCOND*/ 0) 770 771 #define IFQ_PURGE(ifq) \ 772 do { \ 773 IFQ_LOCK((ifq)); \ 774 if (ALTQ_IS_ENABLED((ifq))) \ 775 ALTQ_PURGE((ifq)); \ 776 else \ 777 IF_PURGE((ifq)); \ 778 IFQ_UNLOCK((ifq)); \ 779 } while (/*CONSTCOND*/ 0) 780 781 #define IFQ_SET_READY(ifq) \ 782 do { \ 783 (ifq)->altq_flags |= ALTQF_READY; \ 784 } while (/*CONSTCOND*/ 0) 785 786 #define IFQ_CLASSIFY(ifq, m, af, pattr) \ 787 do { \ 788 IFQ_LOCK((ifq)); \ 789 if (ALTQ_IS_ENABLED((ifq))) { \ 790 if (ALTQ_NEEDS_CLASSIFY((ifq))) \ 791 (pattr)->pattr_class = (*(ifq)->altq_classify) \ 792 ((ifq)->altq_clfier, (m), (af)); \ 793 (pattr)->pattr_af = (af); \ 794 (pattr)->pattr_hdr = mtod((m), void *); \ 795 } \ 796 IFQ_UNLOCK((ifq)); \ 797 } while (/*CONSTCOND*/ 0) 798 #else /* ! ALTQ */ 799 #define ALTQ_DECL(x) /* nothing */ 800 #define ALTQ_COMMA 801 802 #define IFQ_ENQUEUE(ifq, m, pattr, err) \ 803 do { \ 804 IFQ_LOCK((ifq)); \ 805 if (IF_QFULL((ifq))) { \ 806 m_freem((m)); \ 807 (err) = ENOBUFS; \ 808 } else { \ 809 IF_ENQUEUE((ifq), (m)); \ 810 (err) = 0; \ 811 } \ 812 if ((err)) \ 813 (ifq)->ifq_drops++; \ 814 IFQ_UNLOCK((ifq)); \ 815 } while (/*CONSTCOND*/ 0) 816 817 #define IFQ_DEQUEUE(ifq, m) \ 818 do { \ 819 IFQ_LOCK((ifq)); \ 820 IF_DEQUEUE((ifq), (m)); \ 821 IFQ_UNLOCK((ifq)); \ 822 } while (/*CONSTCOND*/ 0) 823 824 #define IFQ_POLL(ifq, m) \ 825 do { \ 826 IFQ_LOCK((ifq)); \ 827 IF_POLL((ifq), (m)); \ 828 IFQ_UNLOCK((ifq)); \ 829 } while (/*CONSTCOND*/ 0) 830 831 #define IFQ_PURGE(ifq) \ 832 do { \ 833 IFQ_LOCK((ifq)); \ 834 IF_PURGE((ifq)); \ 835 IFQ_UNLOCK((ifq)); \ 836 } while (/*CONSTCOND*/ 0) 837 838 #define IFQ_SET_READY(ifq) /* nothing */ 839 840 #define IFQ_CLASSIFY(ifq, m, af, pattr) /* nothing */ 841 842 #endif /* ALTQ */ 843 844 #define IFQ_IS_EMPTY(ifq) IF_IS_EMPTY((ifq)) 845 #define IFQ_INC_LEN(ifq) ((ifq)->ifq_len++) 846 #define IFQ_DEC_LEN(ifq) (--(ifq)->ifq_len) 847 #define IFQ_INC_DROPS(ifq) ((ifq)->ifq_drops++) 848 #define IFQ_SET_MAXLEN(ifq, len) ((ifq)->ifq_maxlen = (len)) 849 850 #include <sys/mallocvar.h> 851 MALLOC_DECLARE(M_IFADDR); 852 MALLOC_DECLARE(M_IFMADDR); 853 854 int ifreq_setaddr(u_long, struct ifreq *, const struct sockaddr *); 855 856 struct ifnet *if_alloc(u_char); 857 void if_free(struct ifnet *); 858 void if_initname(struct ifnet *, const char *, int); 859 struct ifaddr *if_dl_create(const struct ifnet *, const struct sockaddr_dl **); 860 void if_activate_sadl(struct ifnet *, struct ifaddr *, 861 const struct sockaddr_dl *); 862 void if_set_sadl(struct ifnet *, const void *, u_char, bool); 863 void if_alloc_sadl(struct ifnet *); 864 void if_initialize(struct ifnet *); 865 void if_register(struct ifnet *); 866 void if_attach(struct ifnet *); /* Deprecated. Use if_initialize and if_register */ 867 void if_attachdomain(void); 868 void if_deactivate(struct ifnet *); 869 void if_purgeaddrs(struct ifnet *, int, void (*)(struct ifaddr *)); 870 void if_detach(struct ifnet *); 871 void if_down(struct ifnet *); 872 void if_link_state_change(struct ifnet *, int); 873 void if_up(struct ifnet *); 874 void ifinit(void); 875 void ifinit1(void); 876 int ifaddrpref_ioctl(struct socket *, u_long, void *, struct ifnet *); 877 extern int (*ifioctl)(struct socket *, u_long, void *, struct lwp *); 878 int ifioctl_common(struct ifnet *, u_long, void *); 879 int ifpromisc(struct ifnet *, int); 880 struct ifnet *ifunit(const char *); 881 int if_addr_init(ifnet_t *, struct ifaddr *, bool); 882 int if_do_dad(struct ifnet *); 883 int if_mcast_op(ifnet_t *, const unsigned long, const struct sockaddr *); 884 int if_flags_set(struct ifnet *, const short); 885 886 void ifa_insert(struct ifnet *, struct ifaddr *); 887 void ifa_remove(struct ifnet *, struct ifaddr *); 888 889 void ifaref(struct ifaddr *); 890 void ifafree(struct ifaddr *); 891 892 struct ifaddr *ifa_ifwithaddr(const struct sockaddr *); 893 struct ifaddr *ifa_ifwithaf(int); 894 struct ifaddr *ifa_ifwithdstaddr(const struct sockaddr *); 895 struct ifaddr *ifa_ifwithnet(const struct sockaddr *); 896 struct ifaddr *ifa_ifwithladdr(const struct sockaddr *); 897 struct ifaddr *ifa_ifwithroute(int, const struct sockaddr *, 898 const struct sockaddr *); 899 struct ifaddr *ifaof_ifpforaddr(const struct sockaddr *, struct ifnet *); 900 void ifafree(struct ifaddr *); 901 void link_rtrequest(int, struct rtentry *, const struct rt_addrinfo *); 902 903 void if_clone_attach(struct if_clone *); 904 void if_clone_detach(struct if_clone *); 905 906 int ifq_enqueue(struct ifnet *, struct mbuf * ALTQ_COMMA 907 ALTQ_DECL(struct altq_pktattr *)); 908 int ifq_enqueue2(struct ifnet *, struct ifqueue *, struct mbuf * ALTQ_COMMA 909 ALTQ_DECL(struct altq_pktattr *)); 910 911 int loioctl(struct ifnet *, u_long, void *); 912 void loopattach(int); 913 int looutput(struct ifnet *, 914 struct mbuf *, const struct sockaddr *, struct rtentry *); 915 void lortrequest(int, struct rtentry *, const struct rt_addrinfo *); 916 917 /* 918 * These are exported because they're an easy way to tell if 919 * an interface is going away without having to burn a flag. 920 */ 921 int if_nulloutput(struct ifnet *, struct mbuf *, 922 const struct sockaddr *, struct rtentry *); 923 void if_nullinput(struct ifnet *, struct mbuf *); 924 void if_nullstart(struct ifnet *); 925 int if_nullioctl(struct ifnet *, u_long, void *); 926 int if_nullinit(struct ifnet *); 927 void if_nullstop(struct ifnet *, int); 928 void if_nullslowtimo(struct ifnet *); 929 #define if_nullwatchdog if_nullslowtimo 930 void if_nulldrain(struct ifnet *); 931 #else 932 struct if_nameindex { 933 unsigned int if_index; /* 1, 2, ... */ 934 char *if_name; /* null terminated name: "le0", ... */ 935 }; 936 937 #include <sys/cdefs.h> 938 __BEGIN_DECLS 939 unsigned int if_nametoindex(const char *); 940 char * if_indextoname(unsigned int, char *); 941 struct if_nameindex * if_nameindex(void); 942 void if_freenameindex(struct if_nameindex *); 943 __END_DECLS 944 #endif /* _KERNEL */ /* XXX really ALTQ? */ 945 946 #ifdef _KERNEL 947 948 #define IFNET_FIRST() TAILQ_FIRST(&ifnet_list) 949 #define IFNET_EMPTY() TAILQ_EMPTY(&ifnet_list) 950 #define IFNET_NEXT(__ifp) TAILQ_NEXT((__ifp), if_list) 951 #define IFNET_FOREACH(__ifp) TAILQ_FOREACH(__ifp, &ifnet_list, if_list) 952 #define IFADDR_FIRST(__ifp) TAILQ_FIRST(&(__ifp)->if_addrlist) 953 #define IFADDR_NEXT(__ifa) TAILQ_NEXT((__ifa), ifa_list) 954 #define IFADDR_FOREACH(__ifa, __ifp) TAILQ_FOREACH(__ifa, \ 955 &(__ifp)->if_addrlist, ifa_list) 956 #define IFADDR_FOREACH_SAFE(__ifa, __ifp, __nifa) \ 957 TAILQ_FOREACH_SAFE(__ifa, \ 958 &(__ifp)->if_addrlist, ifa_list, __nifa) 959 #define IFADDR_EMPTY(__ifp) TAILQ_EMPTY(&(__ifp)->if_addrlist) 960 961 extern struct ifnet_head ifnet_list; 962 extern struct ifnet *lo0ifp; 963 964 ifnet_t * if_byindex(u_int); 965 966 /* 967 * ifq sysctl support 968 */ 969 int sysctl_ifq(int *name, u_int namelen, void *oldp, 970 size_t *oldlenp, void *newp, size_t newlen, 971 struct ifqueue *ifq); 972 /* symbolic names for terminal (per-protocol) CTL_IFQ_ nodes */ 973 #define IFQCTL_LEN 1 974 #define IFQCTL_MAXLEN 2 975 #define IFQCTL_PEAK 3 976 #define IFQCTL_DROPS 4 977 #define IFQCTL_MAXID 5 978 979 #endif /* _KERNEL */ 980 981 #ifdef _NETBSD_SOURCE 982 /* 983 * sysctl for ifq (per-protocol packet input queue variant of ifqueue) 984 */ 985 #define CTL_IFQ_NAMES { \ 986 { 0, 0 }, \ 987 { "len", CTLTYPE_INT }, \ 988 { "maxlen", CTLTYPE_INT }, \ 989 { "peak", CTLTYPE_INT }, \ 990 { "drops", CTLTYPE_INT }, \ 991 } 992 #endif /* _NETBSD_SOURCE */ 993 #endif /* !_NET_IF_H_ */ 994
Indexes created Thu Sep 25 08:09:54 GMT 2025