1 /* 2 * Copyright (c) 1982, 1986, 1989, 1993 3 * The Regents of the University of California. All rights reserved. 4 * 5 * Redistribution and use in source and binary forms, with or without 6 * modification, are permitted provided that the following conditions 7 * are met: 8 * 1. Redistributions of source code must retain the above copyright 9 * notice, this list of conditions and the following disclaimer. 10 * 2. Redistributions in binary form must reproduce the above copyright 11 * notice, this list of conditions and the following disclaimer in the 12 * documentation and/or other materials provided with the distribution. 13 * 3. All advertising materials mentioning features or use of this software 14 * must display the following acknowledgement: 15 * This product includes software developed by the University of 16 * California, Berkeley and its contributors. 17 * 4. Neither the name of the University nor the names of its contributors 18 * may be used to endorse or promote products derived from this software 19 * without specific prior written permission. 20 * 21 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 22 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 23 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 24 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 25 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 26 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 27 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 28 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 29 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 30 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 31 * SUCH DAMAGE. 32 * 33 * From: @(#)if.h 8.1 (Berkeley) 6/10/93 34 * $FreeBSD: src/sys/net/if_var.h,v 1.18.2.16 2003/04/15 18:11:19 fjoe Exp $ 35 */ 36 37 #ifndef _NET_IF_VAR_H_ 38 #define _NET_IF_VAR_H_ 39 40 #ifndef _SYS_SERIALIZE_H_ 41 #include <sys/serialize.h> 42 #endif 43 #ifndef _NET_IF_H_ 44 #include <net/if.h> 45 #endif 46 #ifndef _SYS_MUTEX_H_ 47 #include <sys/mutex.h> 48 #endif 49 50 /* 51 * Structures defining a network interface, providing a packet 52 * transport mechanism (ala level 0 of the PUP protocols). 53 * 54 * Each interface accepts output datagrams of a specified maximum 55 * length, and provides higher level routines with input datagrams 56 * received from its medium. 57 * 58 * Output occurs when the routine if_output is called, with four parameters: 59 * 60 * ifp->if_output(ifp, m, dst, rt) 61 * 62 * Here m is the mbuf chain to be sent and dst is the destination address. 63 * The output routine encapsulates the supplied datagram if necessary, 64 * and then transmits it on its medium. 65 * 66 * On input, each interface unwraps the data received by it, and either 67 * places it on the input queue of a internetwork datagram routine 68 * and posts the associated software interrupt, or passes the datagram to 69 * the routine if_input. It is called with four parameters: 70 * 71 * ifp->if_input(ifp, m, pi, cpuid) 72 * 73 * Here m is the mbuf chain to be received. The input routine removes the 74 * protocol dependent header if necessary. A driver may also call using 75 * custom struct pktinfo reference pi and a cpuid to take advantage of 76 * hardware supplied information. Otherwise, the defaults for pi and cpuid 77 * are as follows: 78 * 79 * ifp->if_input(ifp, m, NULL, -1); 80 * 81 * Routines exist for locating interfaces by their addresses 82 * or for locating a interface on a certain network, as well as more general 83 * routing and gateway routines maintaining information used to locate 84 * interfaces. These routines live in the files if.c and route.c 85 */ 86 87 /* 88 * Forward structure declarations for function prototypes [sic]. 89 */ 90 struct mbuf; 91 struct proc; 92 struct rtentry; 93 struct rt_addrinfo; 94 struct socket; 95 struct ether_header; 96 struct ucred; 97 struct lwkt_serialize; 98 struct ifaddr_container; 99 struct ifaddr; 100 struct lwkt_port; 101 struct lwkt_msg; 102 union netmsg; 103 struct pktinfo; 104 struct ifpoll_info; 105 struct ifdata_pcpu; 106 107 #include <sys/queue.h> /* get TAILQ macros */ 108 109 #include <net/altq/if_altq.h> 110 111 #ifdef _KERNEL 112 #include <sys/eventhandler.h> 113 #include <sys/mbuf.h> 114 #include <sys/systm.h> /* XXX */ 115 #include <sys/thread2.h> 116 #endif /* _KERNEL */ 117 118 #define IF_DUNIT_NONE -1 119 120 TAILQ_HEAD(ifnethead, ifnet); /* we use TAILQs so that the order of */ 121 TAILQ_HEAD(ifaddrhead, ifaddr_container); /* instantiation is preserved in the list */ 122 TAILQ_HEAD(ifprefixhead, ifprefix); 123 TAILQ_HEAD(ifmultihead, ifmultiaddr); 124 125 /* 126 * Structure defining a mbuf queue. 127 */ 128 struct ifqueue { 129 struct mbuf *ifq_head; 130 struct mbuf *ifq_tail; 131 int ifq_len; 132 int ifq_maxlen; 133 int ifq_drops; 134 }; 135 136 /* 137 * Note of IFPOLL_ENABLE 138 * 1) Any file(*.c) that depends on IFPOLL_ENABLE supports in this 139 * file should include opt_ifpoll.h at its beginning. 140 * 2) When struct changes, which are conditioned by IFPOLL_ENABLE, 141 * are to be introduced, please keep the struct's size and layout 142 * same, no matter whether IFPOLL_ENABLE is defined or not. 143 * See ifnet.if_npoll and ifnet.if_npoll_unused for example. 144 */ 145 146 /* 147 * Network serialize/deserialize types 148 */ 149 enum ifnet_serialize { 150 IFNET_SERIALIZE_ALL /* all serializers */ 151 }; 152 153 #if defined(_KERNEL) || defined(_KERNEL_STRUCTURES) 154 155 /* 156 * Structure defining a network interface. 157 * 158 * (Would like to call this struct ``if'', but C isn't PL/1.) 159 */ 160 161 /* 162 * NB: For DragonFlyBSD, it is assumed that each NIC driver's softc starts 163 * with one of these structures, typically held within an arpcom structure. 164 * 165 * struct <foo>_softc { 166 * struct arpcom { 167 * struct ifnet ac_if; 168 * ... 169 * } <arpcom> ; 170 * ... 171 * }; 172 * 173 * The assumption is used in a number of places, including many 174 * files in sys/net, device drivers, and sys/dev/mii.c:miibus_attach(). 175 * 176 * Unfortunately devices' softc are opaque, so we depend on this layout 177 * to locate the struct ifnet from the softc in the generic code. 178 * 179 * 180 * 181 * MPSAFE NOTES: 182 * 183 * ifnet is protected by calling if_serialize, if_tryserialize and 184 * if_deserialize serialize functions with the ifnet_serialize parameter. 185 * Callers of if_ioctl, if_watchdog, if_init, if_resolvemulti, and if_npoll 186 * should call the ifnet serialize functions with IFNET_SERIALIZE_ALL. 187 * 188 * if_snd subqueues are protected by its own serializers. Callers of 189 * if_start should call ifsq_serialiize_hw(), ifsq_deserialize_hw() and 190 * ifsq_tryserialize_hw() to properly serialize hardware for transmission. 191 * 192 * Caller of if_output MUST NOT serialize ifnet or if_snd by calling 193 * the related serialize functions. 194 * 195 * For better tranmission performance, driver should setup if_snd subqueue 196 * owner cpuid properly using ifsq_set_cpuid() (or ifq_set_cpuid(), if not 197 * multiple transmit queue capable). Normally, the if_snd subqueue owner 198 * cpu is the one that processing the transmission interrupt. And in driver, 199 * direct call of if_start should be avoided, use ifsq_devstart() or 200 * ifsq_devstart_sched() instead (or if_devstart()/if_devstart_sched(), if 201 * not multiple transmit queue capable). 202 * 203 * 204 * 205 * STATISTICS: 206 * 207 * if_data is no longer used to hold per interface statistics, so DO NOT use 208 * the old style ifp->if_ipackets++ to update statistics; instead IFNET_STAT_ 209 * macros should be used. 210 * 211 * 212 * 213 * SINGLE SERIALIZER MODE: 214 * 215 * In this mode, driver MUST NOT setup if_serialize, if_deserialize, 216 * if_tryserialize or if_serialize_assert. Driver could supply its own 217 * serializer to be used (through the type specific attach function, e.g. 218 * ether_ifattach()) or it could depend on the default serializer. In this 219 * mode if_serializer will be setup properly. 220 * 221 * If a device driver installs the same serializer for its interrupt 222 * as for ifnet, then the driver only really needs to worry about further 223 * serialization in timeout based entry points and device_method_t entry 224 * points. All other entry points will already be serialized. 225 * 226 * 227 * 228 * MULTI SERIALIZERS MODE: 229 * 230 * In this mode, driver MUST setup if_serialize, if_deserialize, 231 * if_tryserialize and if_serialize_assert. Driver MUST NOT supply its own 232 * serializer to be used. In this mode, if_serializer will be left as NULL. 233 * And driver MUST setup if_snd subqueues' hardware serailizer properly by 234 * calling ifsq_set_hw_serialize(). 235 * 236 * 237 * 238 * MULTIPLE TRANSMIT QUEUES: 239 * 240 * This should be implemented in "MULTI SERIALIZERS MODE". Legacy if_watchdog 241 * method SHOULD NOT be used. 242 * 243 * 1) Attach 244 * 245 * Before the type specific attach, e.g. ether_ifattach(), driver should 246 * setup the transmit queue count and cpuid to subqueue mapping method 247 * properly (assume QCOUNT is power of 2): 248 * 249 * ifq_set_subq_cnt(&ifp->if_snd, QCOUNT); 250 * ifp->if_mapsubq = ifq_mapsubq_mask; 251 * ifq_set_subq_mask(&ifp->if_snd, QCOUNT - 1); 252 * 253 * After the type specific attach, driver should setup the subqueues owner 254 * cpu, serializer and watchdog properly: 255 * 256 * for (i = 0; i < QCOUNT, ++i) { 257 * struct ifaltq_subque *ifsq = ifq_get_subq(&ifp->if_snd, i); 258 * 259 * ifsq_set_cpuid(ifsq, Q_CPUID); 260 * ifsq_set_hw_serialize(ifsq, Q_SLIZE); 261 * ifsq_watchdog_init(Q_WDOG, ifsq, Q_WDOG_FUNC); 262 * } 263 * 264 * Q_CPUID, the cpu which handles the hardware transmit queue interrupt 265 * Q_SLIZE, the serializer protects the hardware transmit queue 266 * Q_WDOG, per hardware transmit queue watchdog handler, struct ifsubq_watchdog 267 * Q_WDOG_FUNC, watchdog function, probably should reset hardware 268 * 269 * 2) Stop 270 * 271 * Make sure per hardware transmit queue watchdog is stopped and oactive is 272 * cleared: 273 * 274 * for (i = 0; i < QCOUNT, ++i) { 275 * ifsq_clr_oactive(ifsq); 276 * ifsq_watchdog_stop(Q_WDOG); 277 * } 278 * 279 * 3) Initialize 280 * 281 * Make sure per hardware transmit queue watchdog is started and oactive is 282 * cleared: 283 * 284 * for (i = 0; i < QCOUNT, ++i) { 285 * ifsq_clr_oactive(ifsq); 286 * ifsq_watchdog_start(Q_WDOG); 287 * } 288 * 289 * 4) if_start 290 * 291 * if_start takes subqueue as parameter, so instead of using ifq_ functions 292 * ifsq_ functions should be used. If device could not be programmed to 293 * transmit when no media link is not up, MAKE SURE to purge the subqueue: 294 * 295 * if ((ifp->if_flags & IFF_RUNNING) == 0 || ifsq_is_oactive(ifsq)) 296 * return; 297 * if (NO_LINK) { 298 * ifsq_purge(ifsq); 299 * return; 300 * } 301 * for (;;) { 302 * if (NO_FREE_DESC) { 303 * ifsq_set_oactive(ifsq); 304 * break; 305 * } 306 * m = ifsq_dequeue(ifsq); 307 * if (m != NULL) 308 * DRIVER_ENCAP(m); 309 * Q_WDOG.wd_timer = WDOG_TIMEOUT; 310 * } 311 * 312 * 5) Transmission done, e.g. transmit queue interrupt processing 313 * 314 * Same as if_start, ifsq_ functions should be used: 315 * 316 * DRIVER_COLLECT_DESC(); 317 * if (HAS_FREE_DESC) 318 * ifsq_clr_oactive(ifsq); 319 * if (NO_PENDING_DESC) 320 * Q_WDOG.wd_timer = 0; 321 * if (!ifsq_is_empty(ifsq)) 322 * ifsq_devstart(ifsq); 323 */ 324 struct ifnet { 325 void *if_softc; /* pointer to driver state */ 326 void *if_l2com; /* pointer to protocol bits */ 327 TAILQ_ENTRY(ifnet) if_link; /* all struct ifnets are chained */ 328 char if_xname[IFNAMSIZ]; /* external name (name + unit) */ 329 const char *if_dname; /* driver name */ 330 int if_dunit; /* unit or IF_DUNIT_NONE */ 331 void *if_vlantrunks; /* vlan trunks */ 332 struct ifaddrhead *if_addrheads; /* per-cpu per-if addresses */ 333 int if_pcount; /* number of promiscuous listeners */ 334 void *if_carp; /* carp interfaces */ 335 struct bpf_if *if_bpf; /* packet filter structure */ 336 u_short if_index; /* numeric abbreviation for this if */ 337 short if_timer; /* time 'til if_watchdog called */ 338 int if_flags; /* up/down, broadcast, etc. */ 339 int if_capabilities; /* interface capabilities */ 340 int if_capenable; /* enabled features */ 341 void *if_linkmib; /* link-type-specific MIB data */ 342 size_t if_linkmiblen; /* length of above data */ 343 struct if_data if_data; /* NOTE: stats are in if_data_pcpu */ 344 struct ifmultihead if_multiaddrs; /* multicast addresses configured */ 345 int if_amcount; /* number of all-multicast requests */ 346 /* procedure handles */ 347 int (*if_output) /* output routine (enqueue) */ 348 (struct ifnet *, struct mbuf *, struct sockaddr *, 349 struct rtentry *); 350 void (*if_input) /* input routine from hardware driver */ 351 (struct ifnet *, struct mbuf *, 352 const struct pktinfo *pi, int cpuid); 353 void (*if_start) /* initiate output routine */ 354 (struct ifnet *, struct ifaltq_subque *); 355 int (*if_ioctl) /* ioctl routine */ 356 (struct ifnet *, u_long, caddr_t, struct ucred *); 357 void (*if_watchdog) /* timer routine */ 358 (struct ifnet *); 359 void (*if_init) /* init routine */ 360 (void *); 361 int (*if_resolvemulti) /* validate/resolve multicast */ 362 (struct ifnet *, struct sockaddr **, struct sockaddr *); 363 void *if_unused5; 364 TAILQ_HEAD(, ifg_list) if_groups; /* linked list of groups per if */ 365 int (*if_mapsubq) /* cpuid to if_snd subqueue map */ 366 (struct ifaltq *, int); 367 int if_unused2; 368 369 /* 370 * ifnet serialize functions 371 */ 372 void (*if_serialize) 373 (struct ifnet *, enum ifnet_serialize); 374 void (*if_deserialize) 375 (struct ifnet *, enum ifnet_serialize); 376 int (*if_tryserialize) 377 (struct ifnet *, enum ifnet_serialize); 378 #ifdef INVARIANTS 379 void (*if_serialize_assert) 380 (struct ifnet *, enum ifnet_serialize, boolean_t); 381 #else 382 /* Place holder */ 383 void (*if_serialize_unused)(void); 384 #endif 385 386 #ifdef IFPOLL_ENABLE 387 void (*if_npoll) /* polling config */ 388 (struct ifnet *, struct ifpoll_info *); 389 #else 390 /* Place holder */ 391 void (*if_npoll_unused)(void); 392 #endif 393 int if_tsolen; /* max TSO length */ 394 struct ifaltq if_snd; /* output subqueues */ 395 struct ifprefixhead if_prefixhead; /* list of prefixes per if */ 396 const uint8_t *if_broadcastaddr; 397 void *if_bridge; /* bridge glue */ 398 void *if_afdata[AF_MAX]; 399 struct ifaddr *if_lladdr; 400 401 /* serializer, in single serializer mode */ 402 struct lwkt_serialize *if_serializer; 403 /* 404 * default serializer, in single serializer mode, 405 * if driver does not supply one 406 */ 407 struct lwkt_serialize if_default_serializer; 408 409 struct mtx if_ioctl_mtx; /* high-level ioctl mutex */ 410 int if_unused4; 411 struct ifdata_pcpu *if_data_pcpu; /* per-cpu stats */ 412 void *if_pf_kif; /* pf interface */ 413 void *if_unused7; 414 }; 415 typedef void if_init_f_t (void *); 416 417 #define if_mtu if_data.ifi_mtu 418 #define if_type if_data.ifi_type 419 #define if_physical if_data.ifi_physical 420 #define if_addrlen if_data.ifi_addrlen 421 #define if_hdrlen if_data.ifi_hdrlen 422 #define if_metric if_data.ifi_metric 423 #define if_link_state if_data.ifi_link_state 424 #define if_baudrate if_data.ifi_baudrate 425 #define if_hwassist if_data.ifi_hwassist 426 #define if_ipackets if_data.ifi_ipackets 427 #define if_ierrors if_data.ifi_ierrors 428 #define if_opackets if_data.ifi_opackets 429 #define if_oerrors if_data.ifi_oerrors 430 #define if_collisions if_data.ifi_collisions 431 #define if_ibytes if_data.ifi_ibytes 432 #define if_obytes if_data.ifi_obytes 433 #define if_imcasts if_data.ifi_imcasts 434 #define if_omcasts if_data.ifi_omcasts 435 #define if_iqdrops if_data.ifi_iqdrops 436 #define if_noproto if_data.ifi_noproto 437 #define if_lastchange if_data.ifi_lastchange 438 #define if_recvquota if_data.ifi_recvquota 439 #define if_xmitquota if_data.ifi_xmitquota 440 #define if_rawoutput(if, m, sa) if_output(if, m, sa, NULL) 441 442 /* for compatibility with other BSDs */ 443 #define if_list if_link 444 445 /* 446 * Per-cpu interface statistics 447 */ 448 struct ifdata_pcpu { 449 u_long ifd_ipackets; /* packets received on interface */ 450 u_long ifd_ierrors; /* input errors on interface */ 451 u_long ifd_opackets; /* packets sent on interface */ 452 u_long ifd_oerrors; /* output errors on interface */ 453 u_long ifd_collisions; /* collisions on csma interfaces */ 454 u_long ifd_ibytes; /* total number of octets received */ 455 u_long ifd_obytes; /* total number of octets sent */ 456 u_long ifd_imcasts; /* packets received via multicast */ 457 u_long ifd_omcasts; /* packets sent via multicast */ 458 u_long ifd_iqdrops; /* dropped on input, this interface */ 459 u_long ifd_noproto; /* destined for unsupported protocol */ 460 } __cachealign; 461 462 #endif /* _KERNEL || _KERNEL_STRUCTURES */ 463 464 /* 465 * ifqueue operation macros 466 */ 467 #define IF_QFULL(ifq) ((ifq)->ifq_len >= (ifq)->ifq_maxlen) 468 #define IF_DROP(ifq) ((ifq)->ifq_drops++) 469 #define IF_QLEN(ifq) ((ifq)->ifq_len) 470 #define IF_QEMPTY(ifq) (IF_QLEN(ifq) == 0) 471 472 #define IF_ENQUEUE(ifq, m) do { \ 473 (m)->m_nextpkt = NULL; \ 474 if ((ifq)->ifq_tail == NULL) \ 475 (ifq)->ifq_head = m; \ 476 else \ 477 (ifq)->ifq_tail->m_nextpkt = m; \ 478 (ifq)->ifq_tail = m; \ 479 (ifq)->ifq_len++; \ 480 } while (0) 481 482 #define IF_PREPEND(ifq, m) do { \ 483 (m)->m_nextpkt = (ifq)->ifq_head; \ 484 if ((ifq)->ifq_tail == NULL) \ 485 (ifq)->ifq_tail = (m); \ 486 (ifq)->ifq_head = (m); \ 487 (ifq)->ifq_len++; \ 488 } while (0) 489 490 #define IF_DEQUEUE(ifq, m) do { \ 491 (m) = (ifq)->ifq_head; \ 492 if (m) { \ 493 if (((ifq)->ifq_head = (m)->m_nextpkt) == NULL) \ 494 (ifq)->ifq_tail = NULL; \ 495 (m)->m_nextpkt = NULL; \ 496 (ifq)->ifq_len--; \ 497 } \ 498 } while (0) 499 500 #define IF_POLL(ifq, m) ((m) = (ifq)->ifq_head) 501 502 #define IF_DRAIN(ifq) do { \ 503 struct mbuf *m; \ 504 while (1) { \ 505 IF_DEQUEUE(ifq, m); \ 506 if (m == NULL) \ 507 break; \ 508 m_freem(m); \ 509 } \ 510 } while (0) 511 512 #ifdef _KERNEL 513 514 /* interface link layer address change event */ 515 typedef void (*iflladdr_event_handler_t)(void *, struct ifnet *); 516 EVENTHANDLER_DECLARE(iflladdr_event, iflladdr_event_handler_t); 517 518 #ifdef INVARIANTS 519 #define ASSERT_IFNET_SERIALIZED_ALL(ifp) \ 520 (ifp)->if_serialize_assert((ifp), IFNET_SERIALIZE_ALL, TRUE) 521 #define ASSERT_IFNET_NOT_SERIALIZED_ALL(ifp) \ 522 (ifp)->if_serialize_assert((ifp), IFNET_SERIALIZE_ALL, FALSE) 523 #else 524 #define ASSERT_IFNET_SERIALIZED_ALL(ifp) ((void)0) 525 #define ASSERT_IFNET_NOT_SERIALIZED_ALL(ifp) ((void)0) 526 #endif 527 528 static __inline void 529 ifnet_serialize_all(struct ifnet *_ifp) 530 { 531 _ifp->if_serialize(_ifp, IFNET_SERIALIZE_ALL); 532 } 533 534 static __inline void 535 ifnet_deserialize_all(struct ifnet *_ifp) 536 { 537 _ifp->if_deserialize(_ifp, IFNET_SERIALIZE_ALL); 538 } 539 540 static __inline int 541 ifnet_tryserialize_all(struct ifnet *_ifp) 542 { 543 return _ifp->if_tryserialize(_ifp, IFNET_SERIALIZE_ALL); 544 } 545 546 /* 547 * 72 was chosen below because it is the size of a TCP/IP 548 * header (40) + the minimum mss (32). 549 */ 550 #define IF_MINMTU 72 551 #define IF_MAXMTU 65535 552 553 #endif /* _KERNEL */ 554 555 struct in_ifaddr; 556 557 struct in_ifaddr_container { 558 struct in_ifaddr *ia; 559 LIST_ENTRY(in_ifaddr_container) ia_hash; 560 /* entry in bucket of inet addresses */ 561 TAILQ_ENTRY(in_ifaddr_container) ia_link; 562 /* list of internet addresses */ 563 struct ifaddr_container *ia_ifac; /* parent ifaddr_container */ 564 }; 565 566 /* 567 * Per-cpu ifaddr container: 568 * - per-cpu ifaddr reference count 569 * - linkage to per-cpu addresses lists 570 * - per-cpu ifaddr statistics 571 */ 572 struct ifaddr_container { 573 #define IFA_CONTAINER_MAGIC 0x19810219 574 #define IFA_CONTAINER_DEAD 0xc0dedead 575 uint32_t ifa_magic; /* IFA_CONTAINER_MAGIC */ 576 struct ifaddr *ifa; 577 TAILQ_ENTRY(ifaddr_container) ifa_link; /* queue macro glue */ 578 u_int ifa_refcnt; /* references to this structure */ 579 uint16_t ifa_listmask; /* IFA_LIST_ */ 580 uint16_t ifa_prflags; /* protocol specific flags */ 581 582 u_long ifa_ipackets; /* packets received on addr */ 583 u_long ifa_ibytes; /* bytes received on addr */ 584 u_long ifa_opackets; /* packets sent on addr */ 585 u_long ifa_obytes; /* bytes sent on addr */ 586 587 /* 588 * Protocol specific states 589 */ 590 union { 591 struct in_ifaddr_container u_in_ifac; 592 } ifa_proto_u; 593 } __cachealign; 594 595 #define IFA_LIST_IFADDRHEAD 0x01 /* on ifnet.if_addrheads[cpuid] */ 596 #define IFA_LIST_IN_IFADDRHEAD 0x02 /* on in_ifaddrheads[cpuid] */ 597 #define IFA_LIST_IN_IFADDRHASH 0x04 /* on in_ifaddrhashtbls[cpuid] */ 598 599 #define IFA_PRF_FLAG0 0x01 600 #define IFA_PRF_FLAG1 0x02 601 #define IFA_PRF_FLAG2 0x04 602 #define IFA_PRF_FLAG3 0x08 603 604 /* 605 * The ifaddr structure contains information about one address 606 * of an interface. They are maintained by the different address families, 607 * are allocated and attached when an address is set, and are linked 608 * together so all addresses for an interface can be located. 609 * 610 * NOTE: 611 * Statistics are no longer stored in if_data, instead, they are stored 612 * in the per-cpu ifaddr_container. So don't use the old style 613 * ifa->if_ipackets++ to update statistics, use IFA_STAT_ macros. 614 */ 615 struct ifaddr { 616 struct sockaddr *ifa_addr; /* address of interface */ 617 struct sockaddr *ifa_dstaddr; /* other end of p-to-p link */ 618 #define ifa_broadaddr ifa_dstaddr /* broadcast address interface */ 619 struct sockaddr *ifa_netmask; /* used to determine subnet */ 620 struct if_data if_data; /* not all members are meaningful */ 621 struct ifnet *ifa_ifp; /* back-pointer to interface */ 622 void *ifa_link_pad; 623 struct ifaddr_container *ifa_containers; /* per-cpu data */ 624 void (*ifa_rtrequest) /* check or clean routes (+ or -)'d */ 625 (int, struct rtentry *); 626 u_short ifa_flags; /* mostly rt_flags for cloning */ 627 int ifa_ncnt; /* # of valid ifaddr_container */ 628 int ifa_metric; /* cost of going out this interface */ 629 #ifdef notdef 630 struct rtentry *ifa_rt; /* XXXX for ROUTETOIF ????? */ 631 #endif 632 int (*ifa_claim_addr) /* check if an addr goes to this if */ 633 (struct ifaddr *, struct sockaddr *); 634 635 }; 636 #define IFA_ROUTE RTF_UP /* route installed */ 637 638 /* for compatibility with other BSDs */ 639 #define ifa_list ifa_link 640 641 /* 642 * The prefix structure contains information about one prefix 643 * of an interface. They are maintained by the different address families, 644 * are allocated and attached when an prefix or an address is set, 645 * and are linked together so all prefixes for an interface can be located. 646 */ 647 struct ifprefix { 648 struct sockaddr *ifpr_prefix; /* prefix of interface */ 649 struct ifnet *ifpr_ifp; /* back-pointer to interface */ 650 TAILQ_ENTRY(ifprefix) ifpr_list; /* queue macro glue */ 651 u_char ifpr_plen; /* prefix length in bits */ 652 u_char ifpr_type; /* protocol dependent prefix type */ 653 }; 654 655 /* 656 * Multicast address structure. This is analogous to the ifaddr 657 * structure except that it keeps track of multicast addresses. 658 * Also, the reference count here is a count of requests for this 659 * address, not a count of pointers to this structure. 660 */ 661 struct ifmultiaddr { 662 TAILQ_ENTRY(ifmultiaddr) ifma_link; /* queue macro glue */ 663 struct sockaddr *ifma_addr; /* address this membership is for */ 664 struct sockaddr *ifma_lladdr; /* link-layer translation, if any */ 665 struct ifnet *ifma_ifp; /* back-pointer to interface */ 666 u_int ifma_refcount; /* reference count */ 667 void *ifma_protospec; /* protocol-specific state, if any */ 668 }; 669 670 #ifdef _KERNEL 671 672 /* 673 * ifaddr statistics update macro 674 */ 675 #define IFA_STAT_INC(ifa, name, v) \ 676 do { \ 677 (ifa)->ifa_containers[mycpuid].ifa_##name += (v); \ 678 } while (0) 679 680 /* 681 * Interface (ifnet) statistics update macros 682 */ 683 #define IFNET_STAT_INC(ifp, name, v) \ 684 do { \ 685 (ifp)->if_data_pcpu[mycpuid].ifd_##name += (v); \ 686 } while (0) 687 688 #define IFNET_STAT_SET(ifp, name, v) \ 689 do { \ 690 int _cpu; \ 691 (ifp)->if_data_pcpu[0].ifd_##name = (v); \ 692 for (_cpu = 1; _cpu < ncpus; ++_cpu) \ 693 (ifp)->if_data_pcpu[_cpu].ifd_##name = 0; \ 694 } while (0) 695 696 #define IFNET_STAT_GET(ifp, name, v) \ 697 do { \ 698 int _cpu; \ 699 (v) = (ifp)->if_data_pcpu[0].ifd_##name; \ 700 for (_cpu = 1; _cpu < ncpus; ++_cpu) \ 701 (v) += (ifp)->if_data_pcpu[_cpu].ifd_##name; \ 702 } while (0) 703 704 #ifndef _SYS_SERIALIZE2_H_ 705 #include <sys/serialize2.h> 706 #endif 707 708 enum ifaddr_event { 709 IFADDR_EVENT_ADD, 710 IFADDR_EVENT_DELETE, 711 IFADDR_EVENT_CHANGE 712 }; 713 714 /* interface address change event */ 715 typedef void (*ifaddr_event_handler_t)(void *, struct ifnet *, 716 enum ifaddr_event, struct ifaddr *); 717 EVENTHANDLER_DECLARE(ifaddr_event, ifaddr_event_handler_t); 718 /* new interface attach event */ 719 typedef void (*ifnet_attach_event_handler_t)(void *, struct ifnet *); 720 EVENTHANDLER_DECLARE(ifnet_attach_event, ifnet_attach_event_handler_t); 721 /* interface detach event */ 722 typedef void (*ifnet_detach_event_handler_t)(void *, struct ifnet *); 723 EVENTHANDLER_DECLARE(ifnet_detach_event, ifnet_detach_event_handler_t); 724 725 /* 726 * interface groups 727 */ 728 struct ifg_group { 729 char ifg_group[IFNAMSIZ]; 730 u_int ifg_refcnt; 731 void *ifg_pf_kif; 732 int ifg_carp_demoted; 733 TAILQ_HEAD(, ifg_member) ifg_members; 734 TAILQ_ENTRY(ifg_group) ifg_next; 735 }; 736 737 struct ifg_member { 738 TAILQ_ENTRY(ifg_member) ifgm_next; 739 struct ifnet *ifgm_ifp; 740 }; 741 742 struct ifg_list { 743 struct ifg_group *ifgl_group; 744 TAILQ_ENTRY(ifg_list) ifgl_next; 745 }; 746 747 /* group attach event */ 748 typedef void (*group_attach_event_handler_t)(void *, struct ifg_group *); 749 EVENTHANDLER_DECLARE(group_attach_event, group_attach_event_handler_t); 750 /* group detach event */ 751 typedef void (*group_detach_event_handler_t)(void *, struct ifg_group *); 752 EVENTHANDLER_DECLARE(group_detach_event, group_detach_event_handler_t); 753 /* group change event */ 754 typedef void (*group_change_event_handler_t)(void *, const char *); 755 EVENTHANDLER_DECLARE(group_change_event, group_change_event_handler_t); 756 757 758 #ifdef INVARIANTS 759 #define ASSERT_IFAC_VALID(ifac) do { \ 760 KKASSERT((ifac)->ifa_magic == IFA_CONTAINER_MAGIC); \ 761 KKASSERT((ifac)->ifa_refcnt > 0); \ 762 } while (0) 763 #else 764 #define ASSERT_IFAC_VALID(ifac) ((void)0) 765 #endif 766 767 static __inline void 768 _IFAREF(struct ifaddr *_ifa, int _cpu_id) 769 { 770 struct ifaddr_container *_ifac = &_ifa->ifa_containers[_cpu_id]; 771 772 crit_enter(); 773 ASSERT_IFAC_VALID(_ifac); 774 ++_ifac->ifa_refcnt; 775 crit_exit(); 776 } 777 778 static __inline void 779 IFAREF(struct ifaddr *_ifa) 780 { 781 _IFAREF(_ifa, mycpuid); 782 } 783 784 #include <sys/malloc.h> 785 786 MALLOC_DECLARE(M_IFADDR); 787 MALLOC_DECLARE(M_IFMADDR); 788 MALLOC_DECLARE(M_IFNET); 789 790 void ifac_free(struct ifaddr_container *, int); 791 792 static __inline void 793 _IFAFREE(struct ifaddr *_ifa, int _cpu_id) 794 { 795 struct ifaddr_container *_ifac = &_ifa->ifa_containers[_cpu_id]; 796 797 crit_enter(); 798 ASSERT_IFAC_VALID(_ifac); 799 if (--_ifac->ifa_refcnt == 0) 800 ifac_free(_ifac, _cpu_id); 801 crit_exit(); 802 } 803 804 static __inline void 805 IFAFREE(struct ifaddr *_ifa) 806 { 807 _IFAFREE(_ifa, mycpuid); 808 } 809 810 struct lwkt_port *ifnet_portfn(int); 811 int ifnet_domsg(struct lwkt_msg *, int); 812 void ifnet_sendmsg(struct lwkt_msg *, int); 813 void ifnet_forwardmsg(struct lwkt_msg *, int); 814 struct ifnet *ifnet_byindex(unsigned short); 815 816 static __inline int 817 ifa_domsg(struct lwkt_msg *_lmsg, int _cpu) 818 { 819 return ifnet_domsg(_lmsg, _cpu); 820 } 821 822 static __inline void 823 ifa_sendmsg(struct lwkt_msg *_lmsg, int _cpu) 824 { 825 ifnet_sendmsg(_lmsg, _cpu); 826 } 827 828 static __inline void 829 ifa_forwardmsg(struct lwkt_msg *_lmsg, int _nextcpu) 830 { 831 ifnet_forwardmsg(_lmsg, _nextcpu); 832 } 833 834 static __inline void 835 ifnet_serialize_array_enter(lwkt_serialize_t *_arr, int _arrcnt, 836 enum ifnet_serialize _slz) 837 { 838 KKASSERT(_slz == IFNET_SERIALIZE_ALL); 839 lwkt_serialize_array_enter(_arr, _arrcnt, 0); 840 } 841 842 static __inline void 843 ifnet_serialize_array_exit(lwkt_serialize_t *_arr, int _arrcnt, 844 enum ifnet_serialize _slz) 845 { 846 KKASSERT(_slz == IFNET_SERIALIZE_ALL); 847 lwkt_serialize_array_exit(_arr, _arrcnt, 0); 848 } 849 850 static __inline int 851 ifnet_serialize_array_try(lwkt_serialize_t *_arr, int _arrcnt, 852 enum ifnet_serialize _slz) 853 { 854 KKASSERT(_slz == IFNET_SERIALIZE_ALL); 855 return lwkt_serialize_array_try(_arr, _arrcnt, 0); 856 } 857 858 #ifdef INVARIANTS 859 860 static __inline void 861 ifnet_serialize_array_assert(lwkt_serialize_t *_arr, int _arrcnt, 862 enum ifnet_serialize _slz, boolean_t _serialized) 863 { 864 int _i; 865 866 KKASSERT(_slz == IFNET_SERIALIZE_ALL); 867 if (_serialized) { 868 for (_i = 0; _i < _arrcnt; ++_i) 869 ASSERT_SERIALIZED(_arr[_i]); 870 } else { 871 for (_i = 0; _i < _arrcnt; ++_i) 872 ASSERT_NOT_SERIALIZED(_arr[_i]); 873 } 874 } 875 876 #endif /* INVARIANTS */ 877 878 #define REINPUT_KEEPRCVIF 0x0001 /* ether_reinput_oncpu() */ 879 #define REINPUT_RUNBPF 0x0002 /* ether_reinput_oncpu() */ 880 881 extern struct ifnethead ifnet; 882 extern struct ifnet **ifindex2ifnet; 883 extern int ifqmaxlen; 884 extern struct ifnet loif[]; 885 extern int if_index; 886 887 struct ip; 888 struct tcphdr; 889 890 void ether_ifattach(struct ifnet *, const uint8_t *, 891 struct lwkt_serialize *); 892 void ether_ifattach_bpf(struct ifnet *, const uint8_t *, u_int, u_int, 893 struct lwkt_serialize *); 894 void ether_ifdetach(struct ifnet *); 895 void ether_demux(struct mbuf *); 896 void ether_demux_oncpu(struct ifnet *, struct mbuf *); 897 void ether_reinput_oncpu(struct ifnet *, struct mbuf *, int); 898 void ether_input(struct ifnet *, struct mbuf *, 899 const struct pktinfo *, int); 900 int ether_output_frame(struct ifnet *, struct mbuf *); 901 int ether_ioctl(struct ifnet *, u_long, caddr_t); 902 u_char *kether_aton(const char *, u_char *); 903 char *kether_ntoa(const u_char *, char *); 904 struct ifnet *ether_bridge_interface(struct ifnet *ifp); 905 uint32_t ether_crc32_le(const uint8_t *, size_t); 906 uint32_t ether_crc32_be(const uint8_t *, size_t); 907 908 int if_addmulti(struct ifnet *, struct sockaddr *, struct ifmultiaddr **); 909 int if_addmulti_serialized(struct ifnet *, struct sockaddr *, 910 struct ifmultiaddr **); 911 int if_allmulti(struct ifnet *, int); 912 void if_attach(struct ifnet *, struct lwkt_serialize *); 913 int if_delmulti(struct ifnet *, struct sockaddr *); 914 void if_delallmulti_serialized(struct ifnet *ifp); 915 void if_purgeaddrs_nolink(struct ifnet *); 916 void if_detach(struct ifnet *); 917 void if_down(struct ifnet *); 918 void if_link_state_change(struct ifnet *); 919 void if_initname(struct ifnet *, const char *, int); 920 int if_getanyethermac(uint16_t *, int); 921 int if_printf(struct ifnet *, const char *, ...) __printflike(2, 3); 922 struct ifnet *if_alloc(uint8_t); 923 void if_free(struct ifnet *); 924 void if_route(struct ifnet *, int flag, int fam); 925 int if_setlladdr(struct ifnet *, const u_char *, int); 926 void if_unroute(struct ifnet *, int flag, int fam); 927 void if_up(struct ifnet *); 928 /*void ifinit(void);*/ /* declared in systm.h for main() */ 929 int ifioctl(struct socket *, u_long, caddr_t, struct ucred *); 930 int ifpromisc(struct ifnet *, int); 931 struct ifnet *ifunit(const char *); 932 struct ifnet *if_withname(struct sockaddr *); 933 934 struct ifg_group *if_creategroup(const char *); 935 int if_addgroup(struct ifnet *, const char *); 936 int if_delgroup(struct ifnet *, const char *); 937 int if_getgroup(caddr_t, struct ifnet *); 938 int if_getgroupmembers(caddr_t); 939 940 struct ifaddr *ifa_ifwithaddr(struct sockaddr *); 941 struct ifaddr *ifa_ifwithdstaddr(struct sockaddr *); 942 struct ifaddr *ifa_ifwithnet(struct sockaddr *); 943 struct ifaddr *ifa_ifwithroute(int, struct sockaddr *, struct sockaddr *); 944 struct ifaddr *ifaof_ifpforaddr(struct sockaddr *, struct ifnet *); 945 946 typedef void *if_com_alloc_t(u_char type, struct ifnet *ifp); 947 typedef void if_com_free_t(void *com, u_char type); 948 void if_register_com_alloc(u_char, if_com_alloc_t *a, if_com_free_t *); 949 void if_deregister_com_alloc(u_char); 950 951 void *ifa_create(int, int); 952 void ifa_destroy(struct ifaddr *); 953 void ifa_iflink(struct ifaddr *, struct ifnet *, int); 954 void ifa_ifunlink(struct ifaddr *, struct ifnet *); 955 956 struct ifaddr *ifaddr_byindex(unsigned short); 957 958 struct ifmultiaddr *ifmaof_ifpforaddr(struct sockaddr *, struct ifnet *); 959 int if_simloop(struct ifnet *ifp, struct mbuf *m, int af, int hlen); 960 void if_devstart(struct ifnet *ifp); /* COMPAT */ 961 void if_devstart_sched(struct ifnet *ifp); /* COMPAT */ 962 int if_ring_count2(int cnt, int cnt_max); 963 964 #define IF_LLSOCKADDR(ifp) \ 965 ((struct sockaddr_dl *)(ifp)->if_lladdr->ifa_addr) 966 #define IF_LLADDR(ifp) LLADDR(IF_LLSOCKADDR(ifp)) 967 968 #ifdef IFPOLL_ENABLE 969 int ifpoll_register(struct ifnet *); 970 int ifpoll_deregister(struct ifnet *); 971 #endif /* IFPOLL_ENABLE */ 972 973 #endif /* _KERNEL */ 974 975 #endif /* !_NET_IF_VAR_H_ */ 976