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