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