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