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