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