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 * 4. Neither the name of the University nor the names of its contributors 14 * may be used to endorse or promote products derived from this software 15 * without specific prior written permission. 16 * 17 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 20 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 27 * SUCH DAMAGE. 28 * 29 * From: @(#)if.h 8.1 (Berkeley) 6/10/93 30 * $FreeBSD$ 31 */ 32 33 #ifndef _NET_IF_VAR_H_ 34 #define _NET_IF_VAR_H_ 35 36 /* 37 * Structures defining a network interface, providing a packet 38 * transport mechanism (ala level 0 of the PUP protocols). 39 * 40 * Each interface accepts output datagrams of a specified maximum 41 * length, and provides higher level routines with input datagrams 42 * received from its medium. 43 * 44 * Output occurs when the routine if_output is called, with three parameters: 45 * (*ifp->if_output)(ifp, m, dst, rt) 46 * Here m is the mbuf chain to be sent and dst is the destination address. 47 * The output routine encapsulates the supplied datagram if necessary, 48 * and then transmits it on its medium. 49 * 50 * On input, each interface unwraps the data received by it, and either 51 * places it on the input queue of an internetwork datagram routine 52 * and posts the associated software interrupt, or passes the datagram to a raw 53 * packet input routine. 54 * 55 * Routines exist for locating interfaces by their addresses 56 * or for locating an interface on a certain network, as well as more general 57 * routing and gateway routines maintaining information used to locate 58 * interfaces. These routines live in the files if.c and route.c 59 */ 60 61 #ifdef __STDC__ 62 /* 63 * Forward structure declarations for function prototypes [sic]. 64 */ 65 struct mbuf; 66 struct thread; 67 struct rtentry; 68 struct rt_addrinfo; 69 struct socket; 70 struct ether_header; 71 #endif 72 73 #include <sys/queue.h> /* get TAILQ macros */ 74 75 #ifdef _KERNEL 76 #include <sys/mbuf.h> 77 #include <sys/eventhandler.h> 78 #endif /* _KERNEL */ 79 #include <sys/lock.h> /* XXX */ 80 #include <sys/mutex.h> /* XXX */ 81 #include <sys/event.h> /* XXX */ 82 83 #define IF_DUNIT_NONE -1 84 85 TAILQ_HEAD(ifnethead, ifnet); /* we use TAILQs so that the order of */ 86 TAILQ_HEAD(ifaddrhead, ifaddr); /* instantiation is preserved in the list */ 87 TAILQ_HEAD(ifprefixhead, ifprefix); 88 TAILQ_HEAD(ifmultihead, ifmultiaddr); 89 90 /* 91 * Structure defining a queue for a network interface. 92 */ 93 struct ifqueue { 94 struct mbuf *ifq_head; 95 struct mbuf *ifq_tail; 96 int ifq_len; 97 int ifq_maxlen; 98 int ifq_drops; 99 struct mtx ifq_mtx; 100 }; 101 102 /* 103 * Structure defining a network interface. 104 * 105 * (Would like to call this struct ``if'', but C isn't PL/1.) 106 */ 107 108 /* 109 * NB: For FreeBSD, it is assumed that each NIC driver's softc starts with 110 * one of these structures, typically held within an arpcom structure. 111 * 112 * struct <foo>_softc { 113 * struct arpcom { 114 * struct ifnet ac_if; 115 * ... 116 * } <arpcom> ; 117 * ... 118 * }; 119 * 120 * The assumption is used in a number of places, including many 121 * files in sys/net, device drivers, and sys/dev/mii.c:miibus_attach(). 122 * 123 * Unfortunately devices' softc are opaque, so we depend on this layout 124 * to locate the struct ifnet from the softc in the generic code. 125 * 126 */ 127 struct ifnet { 128 void *if_softc; /* pointer to driver state */ 129 TAILQ_ENTRY(ifnet) if_link; /* all struct ifnets are chained */ 130 char if_xname[IFNAMSIZ]; /* external name (name + unit) */ 131 const char *if_dname; /* driver name */ 132 int if_dunit; /* unit or IF_DUNIT_NONE */ 133 struct ifaddrhead if_addrhead; /* linked list of addresses per if */ 134 /* 135 * if_addrhead is the list of all addresses associated to 136 * an interface. 137 * Some code in the kernel assumes that first element 138 * of the list has type AF_LINK, and contains sockaddr_dl 139 * addresses which store the link-level address and the name 140 * of the interface. 141 * However, access to the AF_LINK address through this 142 * field is deprecated. Use ifaddr_byindex() instead. 143 */ 144 struct klist if_klist; /* events attached to this if */ 145 int if_pcount; /* number of promiscuous listeners */ 146 struct bpf_if *if_bpf; /* packet filter structure */ 147 u_short if_index; /* numeric abbreviation for this if */ 148 short if_timer; /* time 'til if_watchdog called */ 149 u_short if_nvlans; /* number of active vlans */ 150 int if_flags; /* up/down, broadcast, etc. */ 151 int if_capabilities; /* interface capabilities */ 152 int if_capenable; /* enabled features */ 153 void *if_linkmib; /* link-type-specific MIB data */ 154 size_t if_linkmiblen; /* length of above data */ 155 struct if_data if_data; 156 struct ifmultihead if_multiaddrs; /* multicast addresses configured */ 157 int if_amcount; /* number of all-multicast requests */ 158 /* procedure handles */ 159 int (*if_output) /* output routine (enqueue) */ 160 (struct ifnet *, struct mbuf *, struct sockaddr *, 161 struct rtentry *); 162 void (*if_input) /* input routine (from h/w driver) */ 163 (struct ifnet *, struct mbuf *); 164 void (*if_start) /* initiate output routine */ 165 (struct ifnet *); 166 int (*if_ioctl) /* ioctl routine */ 167 (struct ifnet *, u_long, caddr_t); 168 void (*if_watchdog) /* timer routine */ 169 (struct ifnet *); 170 void (*if_init) /* Init routine */ 171 (void *); 172 int (*if_resolvemulti) /* validate/resolve multicast */ 173 (struct ifnet *, struct sockaddr **, struct sockaddr *); 174 struct ifqueue if_snd; /* output queue */ 175 const u_int8_t *if_broadcastaddr; /* linklevel broadcast bytestring */ 176 177 struct lltable *lltables; /* list of L3-L2 resolution tables */ 178 179 struct label *if_label; /* interface MAC label */ 180 181 /* these are only used by IPv6 */ 182 struct ifprefixhead if_prefixhead; /* list of prefixes per if */ 183 void *if_afdata[AF_MAX]; 184 int if_afdata_initialized; 185 struct mtx if_afdata_mtx; 186 }; 187 188 typedef void if_init_f_t(void *); 189 190 /* 191 * XXX These aliases are terribly dangerous because they could apply 192 * to anything. 193 */ 194 #define if_mtu if_data.ifi_mtu 195 #define if_type if_data.ifi_type 196 #define if_physical if_data.ifi_physical 197 #define if_addrlen if_data.ifi_addrlen 198 #define if_hdrlen if_data.ifi_hdrlen 199 #define if_metric if_data.ifi_metric 200 #define if_link_state if_data.ifi_link_state 201 #define if_baudrate if_data.ifi_baudrate 202 #define if_hwassist if_data.ifi_hwassist 203 #define if_ipackets if_data.ifi_ipackets 204 #define if_ierrors if_data.ifi_ierrors 205 #define if_opackets if_data.ifi_opackets 206 #define if_oerrors if_data.ifi_oerrors 207 #define if_collisions if_data.ifi_collisions 208 #define if_ibytes if_data.ifi_ibytes 209 #define if_obytes if_data.ifi_obytes 210 #define if_imcasts if_data.ifi_imcasts 211 #define if_omcasts if_data.ifi_omcasts 212 #define if_iqdrops if_data.ifi_iqdrops 213 #define if_noproto if_data.ifi_noproto 214 #define if_lastchange if_data.ifi_lastchange 215 #define if_recvquota if_data.ifi_recvquota 216 #define if_xmitquota if_data.ifi_xmitquota 217 #define if_rawoutput(if, m, sa) if_output(if, m, sa, (struct rtentry *)0) 218 219 /* for compatibility with other BSDs */ 220 #define if_addrlist if_addrhead 221 #define if_list if_link 222 223 /* 224 * Output queues (ifp->if_snd) and slow device input queues (*ifp->if_slowq) 225 * are queues of messages stored on ifqueue structures 226 * (defined above). Entries are added to and deleted from these structures 227 * by these macros, which should be called with ipl raised to splimp(). 228 */ 229 #define IF_LOCK(ifq) mtx_lock(&(ifq)->ifq_mtx) 230 #define IF_UNLOCK(ifq) mtx_unlock(&(ifq)->ifq_mtx) 231 #define _IF_QFULL(ifq) ((ifq)->ifq_len >= (ifq)->ifq_maxlen) 232 #define _IF_DROP(ifq) ((ifq)->ifq_drops++) 233 #define _IF_QLEN(ifq) ((ifq)->ifq_len) 234 235 #define _IF_ENQUEUE(ifq, m) do { \ 236 (m)->m_nextpkt = NULL; \ 237 if ((ifq)->ifq_tail == NULL) \ 238 (ifq)->ifq_head = m; \ 239 else \ 240 (ifq)->ifq_tail->m_nextpkt = m; \ 241 (ifq)->ifq_tail = m; \ 242 (ifq)->ifq_len++; \ 243 } while (0) 244 245 #define IF_ENQUEUE(ifq, m) do { \ 246 IF_LOCK(ifq); \ 247 _IF_ENQUEUE(ifq, m); \ 248 IF_UNLOCK(ifq); \ 249 } while (0) 250 251 #define _IF_PREPEND(ifq, m) do { \ 252 (m)->m_nextpkt = (ifq)->ifq_head; \ 253 if ((ifq)->ifq_tail == NULL) \ 254 (ifq)->ifq_tail = (m); \ 255 (ifq)->ifq_head = (m); \ 256 (ifq)->ifq_len++; \ 257 } while (0) 258 259 #define IF_PREPEND(ifq, m) do { \ 260 IF_LOCK(ifq); \ 261 _IF_PREPEND(ifq, m); \ 262 IF_UNLOCK(ifq); \ 263 } while (0) 264 265 #define _IF_DEQUEUE(ifq, m) do { \ 266 (m) = (ifq)->ifq_head; \ 267 if (m) { \ 268 if (((ifq)->ifq_head = (m)->m_nextpkt) == 0) \ 269 (ifq)->ifq_tail = NULL; \ 270 (m)->m_nextpkt = NULL; \ 271 (ifq)->ifq_len--; \ 272 } \ 273 } while (0) 274 275 #define IF_DEQUEUE(ifq, m) do { \ 276 IF_LOCK(ifq); \ 277 _IF_DEQUEUE(ifq, m); \ 278 IF_UNLOCK(ifq); \ 279 } while (0) 280 281 #define IF_DRAIN(ifq) do { \ 282 struct mbuf *m; \ 283 IF_LOCK(ifq); \ 284 for (;;) { \ 285 _IF_DEQUEUE(ifq, m); \ 286 if (m == NULL) \ 287 break; \ 288 m_freem(m); \ 289 } \ 290 IF_UNLOCK(ifq); \ 291 } while (0) 292 293 #ifdef _KERNEL 294 /* interface address change event */ 295 typedef void (*ifaddr_event_handler_t)(void *, struct ifnet *); 296 EVENTHANDLER_DECLARE(ifaddr_event, ifaddr_event_handler_t); 297 /* new interface arrival event */ 298 typedef void (*ifnet_arrival_event_handler_t)(void *, struct ifnet *); 299 EVENTHANDLER_DECLARE(ifnet_arrival_event, ifnet_arrival_event_handler_t); 300 /* interface departure event */ 301 typedef void (*ifnet_departure_event_handler_t)(void *, struct ifnet *); 302 EVENTHANDLER_DECLARE(ifnet_departure_event, ifnet_departure_event_handler_t); 303 /* interface clone event */ 304 typedef void (*if_clone_event_handler_t)(void *, struct if_clone *); 305 EVENTHANDLER_DECLARE(if_clone_event, if_clone_event_handler_t); 306 307 #define IF_AFDATA_LOCK_INIT(ifp) \ 308 mtx_init(&(ifp)->if_afdata_mtx, "if_afdata", NULL, MTX_DEF) 309 #define IF_AFDATA_LOCK(ifp) mtx_lock(&(ifp)->if_afdata_mtx) 310 #define IF_AFDATA_TRYLOCK(ifp) mtx_trylock(&(ifp)->if_afdata_mtx) 311 #define IF_AFDATA_UNLOCK(ifp) mtx_unlock(&(ifp)->if_afdata_mtx) 312 #define IF_AFDATA_DESTROY(ifp) mtx_destroy(&(ifp)->if_afdata_mtx) 313 314 #define IF_HANDOFF(ifq, m, ifp) if_handoff(ifq, m, ifp, 0) 315 #define IF_HANDOFF_ADJ(ifq, m, ifp, adj) if_handoff(ifq, m, ifp, adj) 316 317 static __inline int 318 if_handoff(struct ifqueue *ifq, struct mbuf *m, struct ifnet *ifp, int adjust) 319 { 320 int active = 0; 321 322 IF_LOCK(ifq); 323 if (_IF_QFULL(ifq)) { 324 _IF_DROP(ifq); 325 IF_UNLOCK(ifq); 326 m_freem(m); 327 return (0); 328 } 329 if (ifp != NULL) { 330 ifp->if_obytes += m->m_pkthdr.len + adjust; 331 if (m->m_flags & (M_BCAST|M_MCAST)) 332 ifp->if_omcasts++; 333 active = ifp->if_flags & IFF_OACTIVE; 334 } 335 _IF_ENQUEUE(ifq, m); 336 IF_UNLOCK(ifq); 337 if (ifp != NULL && !active) 338 (*ifp->if_start)(ifp); 339 return (1); 340 } 341 342 /* 343 * 72 was chosen below because it is the size of a TCP/IP 344 * header (40) + the minimum mss (32). 345 */ 346 #define IF_MINMTU 72 347 #define IF_MAXMTU 65535 348 349 #endif /* _KERNEL */ 350 351 /* 352 * The ifaddr structure contains information about one address 353 * of an interface. They are maintained by the different address families, 354 * are allocated and attached when an address is set, and are linked 355 * together so all addresses for an interface can be located. 356 * 357 * NOTE: a 'struct ifaddr' is always at the beginning of a larger 358 * chunk of malloc'ed memory, where we store the three addresses 359 * (ifa_addr, ifa_dstaddr and ifa_netmask) referenced here. 360 */ 361 struct ifaddr { 362 struct sockaddr *ifa_addr; /* address of interface */ 363 struct sockaddr *ifa_dstaddr; /* other end of p-to-p link */ 364 #define ifa_broadaddr ifa_dstaddr /* broadcast address interface */ 365 struct sockaddr *ifa_netmask; /* used to determine subnet */ 366 struct if_data if_data; /* not all members are meaningful */ 367 struct ifnet *ifa_ifp; /* back-pointer to interface */ 368 TAILQ_ENTRY(ifaddr) ifa_link; /* queue macro glue */ 369 void (*ifa_rtrequest) /* check or clean routes (+ or -)'d */ 370 (int, struct rtentry *, struct rt_addrinfo *); 371 u_short ifa_flags; /* mostly rt_flags for cloning */ 372 u_int ifa_refcnt; /* references to this structure */ 373 int ifa_metric; /* cost of going out this interface */ 374 int (*ifa_claim_addr) /* check if an addr goes to this if */ 375 (struct ifaddr *, struct sockaddr *); 376 struct mtx ifa_mtx; 377 }; 378 #define IFA_ROUTE RTF_UP /* route installed */ 379 380 /* for compatibility with other BSDs */ 381 #define ifa_list ifa_link 382 383 #define IFA_LOCK_INIT(ifa) \ 384 mtx_init(&(ifa)->ifa_mtx, "ifaddr", NULL, MTX_DEF) 385 #define IFA_LOCK(ifa) mtx_lock(&(ifa)->ifa_mtx) 386 #define IFA_UNLOCK(ifa) mtx_unlock(&(ifa)->ifa_mtx) 387 #define IFA_DESTROY(ifa) mtx_destroy(&(ifa)->ifa_mtx) 388 389 /* 390 * The prefix structure contains information about one prefix 391 * of an interface. They are maintained by the different address families, 392 * are allocated and attached when a prefix or an address is set, 393 * and are linked together so all prefixes for an interface can be located. 394 */ 395 struct ifprefix { 396 struct sockaddr *ifpr_prefix; /* prefix of interface */ 397 struct ifnet *ifpr_ifp; /* back-pointer to interface */ 398 TAILQ_ENTRY(ifprefix) ifpr_list; /* queue macro glue */ 399 u_char ifpr_plen; /* prefix length in bits */ 400 u_char ifpr_type; /* protocol dependent prefix type */ 401 }; 402 403 /* 404 * Multicast address structure. This is analogous to the ifaddr 405 * structure except that it keeps track of multicast addresses. 406 * Also, the reference count here is a count of requests for this 407 * address, not a count of pointers to this structure. 408 */ 409 struct ifmultiaddr { 410 TAILQ_ENTRY(ifmultiaddr) ifma_link; /* queue macro glue */ 411 struct sockaddr *ifma_addr; /* address this membership is for */ 412 struct sockaddr *ifma_lladdr; /* link-layer translation, if any */ 413 struct ifnet *ifma_ifp; /* back-pointer to interface */ 414 u_int ifma_refcount; /* reference count */ 415 void *ifma_protospec; /* protocol-specific state, if any */ 416 }; 417 418 #ifdef _KERNEL 419 #define IFAFREE(ifa) \ 420 do { \ 421 IFA_LOCK(ifa); \ 422 KASSERT((ifa)->ifa_refcnt > 0, \ 423 ("ifa %p !(ifa_refcnt > 0)", ifa)); \ 424 if (--(ifa)->ifa_refcnt == 0) { \ 425 IFA_DESTROY(ifa); \ 426 free(ifa, M_IFADDR); \ 427 } else \ 428 IFA_UNLOCK(ifa); \ 429 } while (0) 430 431 #define IFAREF(ifa) \ 432 do { \ 433 IFA_LOCK(ifa); \ 434 ++(ifa)->ifa_refcnt; \ 435 IFA_UNLOCK(ifa); \ 436 } while (0) 437 438 extern struct mtx ifnet_lock; 439 #define IFNET_LOCK_INIT() \ 440 mtx_init(&ifnet_lock, "ifnet", NULL, MTX_DEF | MTX_RECURSE) 441 #define IFNET_WLOCK() mtx_lock(&ifnet_lock) 442 #define IFNET_WUNLOCK() mtx_unlock(&ifnet_lock) 443 #define IFNET_RLOCK() IFNET_WLOCK() 444 #define IFNET_RUNLOCK() IFNET_WUNLOCK() 445 446 struct ifindex_entry { 447 struct ifnet *ife_ifnet; 448 struct ifaddr *ife_ifnet_addr; 449 dev_t ife_dev; 450 }; 451 452 #define ifnet_byindex(idx) ifindex_table[(idx)].ife_ifnet 453 /* 454 * Given the index, ifaddr_byindex() returns the one and only 455 * link-level ifaddr for the interface. You are not supposed to use 456 * it to traverse the list of addresses associated to the interface. 457 */ 458 #define ifaddr_byindex(idx) ifindex_table[(idx)].ife_ifnet_addr 459 #define ifdev_byindex(idx) ifindex_table[(idx)].ife_dev 460 461 extern struct ifnethead ifnet; 462 extern struct ifindex_entry *ifindex_table; 463 extern int ifqmaxlen; 464 extern struct ifnet *loif; /* first loopback interface */ 465 extern int if_index; 466 467 int if_addmulti(struct ifnet *, struct sockaddr *, struct ifmultiaddr **); 468 int if_allmulti(struct ifnet *, int); 469 void if_attach(struct ifnet *); 470 int if_delmulti(struct ifnet *, struct sockaddr *); 471 void if_detach(struct ifnet *); 472 void if_down(struct ifnet *); 473 void if_initname(struct ifnet *, const char *, int); 474 int if_printf(struct ifnet *, const char *, ...) __printflike(2, 3); 475 int if_setlladdr(struct ifnet *, const u_char *, int); 476 void if_up(struct ifnet *); 477 /*void ifinit(void);*/ /* declared in systm.h for main() */ 478 int ifioctl(struct socket *, u_long, caddr_t, struct thread *); 479 int ifpromisc(struct ifnet *, int); 480 struct ifnet *ifunit(const char *); 481 482 struct ifaddr *ifa_ifwithaddr(struct sockaddr *); 483 struct ifaddr *ifa_ifwithdstaddr(struct sockaddr *); 484 struct ifaddr *ifa_ifwithnet(struct sockaddr *); 485 struct ifaddr *ifa_ifwithroute(int, struct sockaddr *, struct sockaddr *); 486 struct ifaddr *ifaof_ifpforaddr(struct sockaddr *, struct ifnet *); 487 488 struct ifmultiaddr *ifmaof_ifpforaddr(struct sockaddr *, struct ifnet *); 489 int if_simloop(struct ifnet *ifp, struct mbuf *m, int af, int hlen); 490 491 void if_clone_attach(struct if_clone *); 492 void if_clone_detach(struct if_clone *); 493 494 int if_clone_create(char *, int); 495 int if_clone_destroy(const char *); 496 497 #define IF_LLADDR(ifp) \ 498 LLADDR((struct sockaddr_dl *) ifaddr_byindex((ifp)->if_index)->ifa_addr) 499 500 #ifdef DEVICE_POLLING 501 enum poll_cmd { POLL_ONLY, POLL_AND_CHECK_STATUS, POLL_DEREGISTER }; 502 503 typedef void poll_handler_t(struct ifnet *ifp, enum poll_cmd cmd, int count); 504 int ether_poll_register(poll_handler_t *h, struct ifnet *ifp); 505 int ether_poll_deregister(struct ifnet *ifp); 506 #endif /* DEVICE_POLLING */ 507 508 #endif /* _KERNEL */ 509 510 #endif /* !_NET_IF_VAR_H_ */ 511