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