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 * $DragonFly: src/sys/net/if_var.h,v 1.24 2005/02/11 22:25:57 joerg Exp $ 36 */ 37 38 #ifndef _NET_IF_VAR_H_ 39 #define _NET_IF_VAR_H_ 40 41 /* 42 * Structures defining a network interface, providing a packet 43 * transport mechanism (ala level 0 of the PUP protocols). 44 * 45 * Each interface accepts output datagrams of a specified maximum 46 * length, and provides higher level routines with input datagrams 47 * received from its medium. 48 * 49 * Output occurs when the routine if_output is called, with three parameters: 50 * (*ifp->if_output)(ifp, m, dst, rt) 51 * Here m is the mbuf chain to be sent and dst is the destination address. 52 * The output routine encapsulates the supplied datagram if necessary, 53 * and then transmits it on its medium. 54 * 55 * On input, each interface unwraps the data received by it, and either 56 * places it on the input queue of a internetwork datagram routine 57 * and posts the associated software interrupt, or passes the datagram to 58 * the routine if_input. It is called with the mbuf chain as parameter: 59 * (*ifp->if_input)(ifp, m) 60 * The input routine removes the protocol dependent header if necessary. 61 * 62 * Routines exist for locating interfaces by their addresses 63 * or for locating a interface on a certain network, as well as more general 64 * routing and gateway routines maintaining information used to locate 65 * interfaces. These routines live in the files if.c and route.c 66 */ 67 68 #ifdef __STDC__ 69 /* 70 * Forward structure declarations for function prototypes [sic]. 71 */ 72 struct mbuf; 73 struct proc; 74 struct rtentry; 75 struct rt_addrinfo; 76 struct socket; 77 struct ether_header; 78 struct ucred; 79 #endif 80 81 #include <sys/queue.h> /* get TAILQ macros */ 82 83 #include <net/altq/if_altq.h> 84 85 #ifdef _KERNEL 86 #include <sys/eventhandler.h> 87 #include <sys/mbuf.h> 88 #include <sys/systm.h> /* XXX */ 89 #endif /* _KERNEL */ 90 91 #define IF_DUNIT_NONE -1 92 93 TAILQ_HEAD(ifnethead, ifnet); /* we use TAILQs so that the order of */ 94 TAILQ_HEAD(ifaddrhead, ifaddr); /* instantiation is preserved in the list */ 95 TAILQ_HEAD(ifprefixhead, ifprefix); 96 LIST_HEAD(ifmultihead, ifmultiaddr); 97 98 /* 99 * Structure defining a queue for a network interface. 100 */ 101 struct ifqueue { 102 struct mbuf *ifq_head; 103 struct mbuf *ifq_tail; 104 int ifq_len; 105 int ifq_maxlen; 106 int ifq_drops; 107 }; 108 109 /* 110 * Structure defining a network interface. 111 * 112 * (Would like to call this struct ``if'', but C isn't PL/1.) 113 */ 114 115 /* 116 * NB: For FreeBSD, it is assumed that each NIC driver's softc starts with 117 * one of these structures, typically held within an arpcom structure. 118 * 119 * struct <foo>_softc { 120 * struct arpcom { 121 * struct ifnet ac_if; 122 * ... 123 * } <arpcom> ; 124 * ... 125 * }; 126 * 127 * The assumption is used in a number of places, including many 128 * files in sys/net, device drivers, and sys/dev/mii.c:miibus_attach(). 129 * 130 * Unfortunately devices' softc are opaque, so we depend on this layout 131 * to locate the struct ifnet from the softc in the generic code. 132 * 133 * Note that not all fields are used by drivers in the FreeBSD source 134 * tree. However, who knows what third party software does with fields 135 * marked as "unused", such as if_ipending, if_done, and if_poll*, 136 * so any attemt to redefine their meaning might end up in binary 137 * compatibility problems, even if the size of struct ifnet, and 138 * the size and position of its fields do not change. 139 * We just have to live with that. 140 */ 141 struct ifnet { 142 void *if_softc; /* pointer to driver state */ 143 TAILQ_ENTRY(ifnet) if_link; /* all struct ifnets are chained */ 144 char if_xname[IFNAMSIZ]; /* external name (name + unit) */ 145 const char *if_dname; /* driver name */ 146 int if_dunit; /* unit or IF_DUNIT_NONE */ 147 struct ifaddrhead if_addrhead; /* linked list of addresses per if */ 148 int if_pcount; /* number of promiscuous listeners */ 149 struct bpf_if *if_bpf; /* packet filter structure */ 150 u_short if_index; /* numeric abbreviation for this if */ 151 short if_timer; /* time 'til if_watchdog called */ 152 int if_flags; /* up/down, broadcast, etc. */ 153 int if_capabilities; /* interface capabilities */ 154 int if_capenable; /* enabled features */ 155 void *if_linkmib; /* link-type-specific MIB data */ 156 size_t if_linkmiblen; /* length of above data */ 157 struct if_data if_data; 158 struct ifmultihead if_multiaddrs; /* multicast addresses configured */ 159 int if_amcount; /* number of all-multicast requests */ 160 /* procedure handles */ 161 int (*if_output) /* output routine (enqueue) */ 162 (struct ifnet *, struct mbuf *, struct sockaddr *, 163 struct rtentry *); 164 void (*if_input) /* input routine from hardware driver */ 165 (struct ifnet *, struct mbuf *); 166 void (*if_start) /* initiate output routine */ 167 (struct ifnet *); 168 int (*if_ioctl) /* ioctl routine */ 169 (struct ifnet *, u_long, caddr_t, struct ucred *); 170 void (*if_watchdog) /* timer routine */ 171 (struct ifnet *); 172 void (*if_init) /* Init routine */ 173 (void *); 174 int (*if_resolvemulti) /* validate/resolve multicast */ 175 (struct ifnet *, struct sockaddr **, struct sockaddr *); 176 struct ifaltq if_snd; /* output queue (includes altq) */ 177 struct ifprefixhead if_prefixhead; /* list of prefixes per if */ 178 const uint8_t *if_broadcastaddr; 179 void *if_afdata[AF_MAX]; 180 }; 181 typedef void if_init_f_t (void *); 182 183 #define if_mtu if_data.ifi_mtu 184 #define if_type if_data.ifi_type 185 #define if_physical if_data.ifi_physical 186 #define if_addrlen if_data.ifi_addrlen 187 #define if_hdrlen if_data.ifi_hdrlen 188 #define if_metric if_data.ifi_metric 189 #define if_baudrate if_data.ifi_baudrate 190 #define if_hwassist if_data.ifi_hwassist 191 #define if_ipackets if_data.ifi_ipackets 192 #define if_ierrors if_data.ifi_ierrors 193 #define if_opackets if_data.ifi_opackets 194 #define if_oerrors if_data.ifi_oerrors 195 #define if_collisions if_data.ifi_collisions 196 #define if_ibytes if_data.ifi_ibytes 197 #define if_obytes if_data.ifi_obytes 198 #define if_imcasts if_data.ifi_imcasts 199 #define if_omcasts if_data.ifi_omcasts 200 #define if_iqdrops if_data.ifi_iqdrops 201 #define if_noproto if_data.ifi_noproto 202 #define if_lastchange if_data.ifi_lastchange 203 #define if_recvquota if_data.ifi_recvquota 204 #define if_xmitquota if_data.ifi_xmitquota 205 #define if_rawoutput(if, m, sa) if_output(if, m, sa, (struct rtentry *)0) 206 207 /* for compatibility with other BSDs */ 208 #define if_addrlist if_addrhead 209 #define if_list if_link 210 211 /* 212 * Output queues (ifp->if_snd) and slow device input queues (*ifp->if_slowq) 213 * are queues of messages stored on ifqueue structures 214 * (defined above). Entries are added to and deleted from these structures 215 * by these macros, which should be called with ipl raised to splimp(). 216 */ 217 #define IF_QFULL(ifq) ((ifq)->ifq_len >= (ifq)->ifq_maxlen) 218 #define IF_DROP(ifq) ((ifq)->ifq_drops++) 219 #define IF_QLEN(ifq) ((ifq)->ifq_len) 220 #define IF_QEMPTY(ifq) (IF_QLEN(ifq) == 0) 221 #define IF_ENQUEUE(ifq, m) { \ 222 (m)->m_nextpkt = 0; \ 223 if ((ifq)->ifq_tail == 0) \ 224 (ifq)->ifq_head = m; \ 225 else \ 226 (ifq)->ifq_tail->m_nextpkt = m; \ 227 (ifq)->ifq_tail = m; \ 228 (ifq)->ifq_len++; \ 229 } 230 #define IF_PREPEND(ifq, m) { \ 231 (m)->m_nextpkt = (ifq)->ifq_head; \ 232 if ((ifq)->ifq_tail == 0) \ 233 (ifq)->ifq_tail = (m); \ 234 (ifq)->ifq_head = (m); \ 235 (ifq)->ifq_len++; \ 236 } 237 #define IF_DEQUEUE(ifq, m) { \ 238 (m) = (ifq)->ifq_head; \ 239 if (m) { \ 240 if (((ifq)->ifq_head = (m)->m_nextpkt) == 0) \ 241 (ifq)->ifq_tail = 0; \ 242 (m)->m_nextpkt = 0; \ 243 (ifq)->ifq_len--; \ 244 } \ 245 } 246 247 #define IF_POLL(ifq, m) ((m) = (ifq)->ifq_head) 248 249 #define IF_DRAIN(ifq) do { \ 250 struct mbuf *m; \ 251 while (1) { \ 252 IF_DEQUEUE(ifq, m); \ 253 if (m == NULL) \ 254 break; \ 255 m_freem(m); \ 256 } \ 257 } while (0) 258 259 #ifdef _KERNEL 260 261 #define IF_HANDOFF(ifq, m, ifp) if_handoff(ifq, m, ifp, 0) 262 #define IF_HANDOFF_ADJ(ifq, m, ifp, adj) if_handoff(ifq, m, ifp, adj) 263 264 static __inline int 265 if_handoff(struct ifqueue *ifq, struct mbuf *m, struct ifnet *ifp, int adjust) 266 { 267 int need_if_start = 0; 268 int s = splimp(); 269 270 if (IF_QFULL(ifq)) { 271 IF_DROP(ifq); 272 splx(s); 273 m_freem(m); 274 return (0); 275 } 276 if (ifp != NULL) { 277 ifp->if_obytes += m->m_pkthdr.len + adjust; 278 if (m->m_flags & M_MCAST) 279 ifp->if_omcasts++; 280 need_if_start = !(ifp->if_flags & IFF_OACTIVE); 281 } 282 IF_ENQUEUE(ifq, m); 283 if (need_if_start) 284 (*ifp->if_start)(ifp); 285 splx(s); 286 return (1); 287 } 288 289 /* 290 * 72 was chosen below because it is the size of a TCP/IP 291 * header (40) + the minimum mss (32). 292 */ 293 #define IF_MINMTU 72 294 #define IF_MAXMTU 65535 295 296 #endif /* _KERNEL */ 297 298 /* 299 * The ifaddr structure contains information about one address 300 * of an interface. They are maintained by the different address families, 301 * are allocated and attached when an address is set, and are linked 302 * together so all addresses for an interface can be located. 303 */ 304 struct ifaddr { 305 struct sockaddr *ifa_addr; /* address of interface */ 306 struct sockaddr *ifa_dstaddr; /* other end of p-to-p link */ 307 #define ifa_broadaddr ifa_dstaddr /* broadcast address interface */ 308 struct sockaddr *ifa_netmask; /* used to determine subnet */ 309 struct if_data if_data; /* not all members are meaningful */ 310 struct ifnet *ifa_ifp; /* back-pointer to interface */ 311 TAILQ_ENTRY(ifaddr) ifa_link; /* queue macro glue */ 312 void (*ifa_rtrequest) /* check or clean routes (+ or -)'d */ 313 (int, struct rtentry *, struct rt_addrinfo *); 314 u_short ifa_flags; /* mostly rt_flags for cloning */ 315 u_int ifa_refcnt; /* references to this structure */ 316 int ifa_metric; /* cost of going out this interface */ 317 #ifdef notdef 318 struct rtentry *ifa_rt; /* XXXX for ROUTETOIF ????? */ 319 #endif 320 int (*ifa_claim_addr) /* check if an addr goes to this if */ 321 (struct ifaddr *, struct sockaddr *); 322 323 }; 324 #define IFA_ROUTE RTF_UP /* route installed */ 325 326 /* for compatibility with other BSDs */ 327 #define ifa_list ifa_link 328 329 /* 330 * The prefix structure contains information about one prefix 331 * of an interface. They are maintained by the different address families, 332 * are allocated and attached when an prefix or an address is set, 333 * and are linked together so all prefixes for an interface can be located. 334 */ 335 struct ifprefix { 336 struct sockaddr *ifpr_prefix; /* prefix of interface */ 337 struct ifnet *ifpr_ifp; /* back-pointer to interface */ 338 TAILQ_ENTRY(ifprefix) ifpr_list; /* queue macro glue */ 339 u_char ifpr_plen; /* prefix length in bits */ 340 u_char ifpr_type; /* protocol dependent prefix type */ 341 }; 342 343 /* 344 * Multicast address structure. This is analogous to the ifaddr 345 * structure except that it keeps track of multicast addresses. 346 * Also, the reference count here is a count of requests for this 347 * address, not a count of pointers to this structure. 348 */ 349 struct ifmultiaddr { 350 LIST_ENTRY(ifmultiaddr) ifma_link; /* queue macro glue */ 351 struct sockaddr *ifma_addr; /* address this membership is for */ 352 struct sockaddr *ifma_lladdr; /* link-layer translation, if any */ 353 struct ifnet *ifma_ifp; /* back-pointer to interface */ 354 u_int ifma_refcount; /* reference count */ 355 void *ifma_protospec; /* protocol-specific state, if any */ 356 }; 357 358 #ifdef _KERNEL 359 /* interface address change event */ 360 typedef void (*ifaddr_event_handler_t)(void *, struct ifnet *); 361 EVENTHANDLER_DECLARE(ifaddr_event, ifaddr_event_handler_t); 362 /* new interface attach event */ 363 typedef void (*ifnet_attach_event_handler_t)(void *, struct ifnet *); 364 EVENTHANDLER_DECLARE(ifnet_attach_event, ifnet_attach_event_handler_t); 365 /* interface detach event */ 366 typedef void (*ifnet_detach_event_handler_t)(void *, struct ifnet *); 367 EVENTHANDLER_DECLARE(ifnet_detach_event, ifnet_detach_event_handler_t); 368 /* interface clone event */ 369 typedef void (*if_clone_event_handler_t)(void *, struct if_clone *); 370 EVENTHANDLER_DECLARE(if_clone_event, if_clone_event_handler_t); 371 372 static __inline void 373 IFAREF(struct ifaddr *ifa) 374 { 375 ++ifa->ifa_refcnt; 376 } 377 378 #include <sys/malloc.h> 379 380 MALLOC_DECLARE(M_IFADDR); 381 MALLOC_DECLARE(M_IFMADDR); 382 383 static __inline void 384 IFAFREE(struct ifaddr *ifa) 385 { 386 if (ifa->ifa_refcnt <= 0) 387 free(ifa, M_IFADDR); 388 else 389 ifa->ifa_refcnt--; 390 } 391 392 extern struct ifnethead ifnet; 393 extern struct ifnet **ifindex2ifnet; 394 extern int ifqmaxlen; 395 extern struct ifnet loif[]; 396 extern int if_index; 397 extern struct ifaddr **ifnet_addrs; 398 399 void ether_ifattach(struct ifnet *, uint8_t *); 400 void ether_ifattach_bpf(struct ifnet *, uint8_t *, u_int, u_int); 401 void ether_ifdetach(struct ifnet *); 402 void ether_input(struct ifnet *, struct ether_header *, struct mbuf *); 403 void ether_demux(struct ifnet *, struct ether_header *, struct mbuf *); 404 int ether_output_frame(struct ifnet *, struct mbuf *); 405 int ether_ioctl(struct ifnet *, int, caddr_t); 406 uint32_t ether_crc32_le(const uint8_t *, size_t); 407 uint32_t ether_crc32_be(const uint8_t *, size_t); 408 409 int if_addmulti(struct ifnet *, struct sockaddr *, struct ifmultiaddr **); 410 int if_allmulti(struct ifnet *, int); 411 void if_attach(struct ifnet *); 412 int if_delmulti(struct ifnet *, struct sockaddr *); 413 void if_detach(struct ifnet *); 414 void if_down(struct ifnet *); 415 void if_initname(struct ifnet *, const char *, int); 416 int if_printf(struct ifnet *, const char *, ...) __printflike(2, 3); 417 void if_route(struct ifnet *, int flag, int fam); 418 int if_setlladdr(struct ifnet *, const u_char *, int); 419 void if_unroute(struct ifnet *, int flag, int fam); 420 void if_up(struct ifnet *); 421 /*void ifinit(void);*/ /* declared in systm.h for main() */ 422 int ifioctl(struct socket *, u_long, caddr_t, struct thread *); 423 int ifpromisc(struct ifnet *, int); 424 struct ifnet *ifunit(const char *); 425 struct ifnet *if_withname(struct sockaddr *); 426 427 struct ifaddr *ifa_ifwithaddr(struct sockaddr *); 428 struct ifaddr *ifa_ifwithdstaddr(struct sockaddr *); 429 struct ifaddr *ifa_ifwithnet(struct sockaddr *); 430 struct ifaddr *ifa_ifwithroute(int, struct sockaddr *, struct sockaddr *); 431 struct ifaddr *ifaof_ifpforaddr(struct sockaddr *, struct ifnet *); 432 433 struct ifmultiaddr *ifmaof_ifpforaddr(struct sockaddr *, struct ifnet *); 434 int if_simloop(struct ifnet *ifp, struct mbuf *m, int af, int hlen); 435 436 void if_clone_attach(struct if_clone *); 437 void if_clone_detach(struct if_clone *); 438 439 int if_clone_create(char *, int); 440 int if_clone_destroy(const char *); 441 442 #define IF_LLADDR(ifp) \ 443 LLADDR((struct sockaddr_dl *) ifnet_addrs[ifp->if_index - 1]->ifa_addr) 444 445 #ifdef DEVICE_POLLING 446 enum poll_cmd { POLL_ONLY, POLL_AND_CHECK_STATUS, POLL_DEREGISTER }; 447 448 typedef void poll_handler_t (struct ifnet *ifp, 449 enum poll_cmd cmd, int count); 450 int ether_poll_register(poll_handler_t *h, struct ifnet *ifp); 451 int ether_poll_deregister(struct ifnet *ifp); 452 void emergency_poll_enable(const char *name); 453 #endif /* DEVICE_POLLING */ 454 #endif /* _KERNEL */ 455 456 #endif /* !_NET_IF_VAR_H_ */ 457