ifq.h revision 53541
121259Swollman/* 221259Swollman * Copyright (c) 1982, 1986, 1989, 1993 321259Swollman * The Regents of the University of California. All rights reserved. 421259Swollman * 521259Swollman * Redistribution and use in source and binary forms, with or without 621259Swollman * modification, are permitted provided that the following conditions 721259Swollman * are met: 821259Swollman * 1. Redistributions of source code must retain the above copyright 921259Swollman * notice, this list of conditions and the following disclaimer. 1021259Swollman * 2. Redistributions in binary form must reproduce the above copyright 1121259Swollman * notice, this list of conditions and the following disclaimer in the 1221259Swollman * documentation and/or other materials provided with the distribution. 1321259Swollman * 3. All advertising materials mentioning features or use of this software 1421259Swollman * must display the following acknowledgement: 1521259Swollman * This product includes software developed by the University of 1621259Swollman * California, Berkeley and its contributors. 1721259Swollman * 4. Neither the name of the University nor the names of its contributors 1821259Swollman * may be used to endorse or promote products derived from this software 1921259Swollman * without specific prior written permission. 2021259Swollman * 2121259Swollman * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 2221259Swollman * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 2321259Swollman * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 2421259Swollman * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 2521259Swollman * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 2621259Swollman * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 2721259Swollman * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 2821259Swollman * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 2921259Swollman * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 3021259Swollman * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 3121259Swollman * SUCH DAMAGE. 3221259Swollman * 3321259Swollman * From: @(#)if.h 8.1 (Berkeley) 6/10/93 3450477Speter * $FreeBSD: head/sys/net/if_var.h 53541 1999-11-22 02:45:11Z shin $ 3521259Swollman */ 3621259Swollman 3721259Swollman#ifndef _NET_IF_VAR_H_ 3821259Swollman#define _NET_IF_VAR_H_ 3921259Swollman 4021259Swollman/* 4121259Swollman * Structures defining a network interface, providing a packet 4221259Swollman * transport mechanism (ala level 0 of the PUP protocols). 4321259Swollman * 4421259Swollman * Each interface accepts output datagrams of a specified maximum 4521259Swollman * length, and provides higher level routines with input datagrams 4621259Swollman * received from its medium. 4721259Swollman * 4821259Swollman * Output occurs when the routine if_output is called, with three parameters: 4921259Swollman * (*ifp->if_output)(ifp, m, dst, rt) 5021259Swollman * Here m is the mbuf chain to be sent and dst is the destination address. 5121259Swollman * The output routine encapsulates the supplied datagram if necessary, 5221259Swollman * and then transmits it on its medium. 5321259Swollman * 5421259Swollman * On input, each interface unwraps the data received by it, and either 5521259Swollman * places it on the input queue of a internetwork datagram routine 5621259Swollman * and posts the associated software interrupt, or passes the datagram to a raw 5721259Swollman * packet input routine. 5821259Swollman * 5921259Swollman * Routines exist for locating interfaces by their addresses 6021259Swollman * or for locating a interface on a certain network, as well as more general 6121259Swollman * routing and gateway routines maintaining information used to locate 6221259Swollman * interfaces. These routines live in the files if.c and route.c 6321259Swollman */ 6421259Swollman 6521259Swollman#ifdef __STDC__ 6621259Swollman/* 6721259Swollman * Forward structure declarations for function prototypes [sic]. 6821259Swollman */ 6921259Swollmanstruct mbuf; 7021259Swollmanstruct proc; 7121259Swollmanstruct rtentry; 7221259Swollmanstruct socket; 7321259Swollmanstruct ether_header; 7421259Swollman#endif 7521259Swollman 7621259Swollman#include <sys/queue.h> /* get TAILQ macros */ 7721259Swollman 7821259SwollmanTAILQ_HEAD(ifnethead, ifnet); /* we use TAILQs so that the order of */ 7921259SwollmanTAILQ_HEAD(ifaddrhead, ifaddr); /* instantiation is preserved in the list */ 8052904SshinTAILQ_HEAD(ifprefixhead, ifprefix); 8121404SwollmanLIST_HEAD(ifmultihead, ifmultiaddr); 8221259Swollman 8321259Swollman/* 8421259Swollman * Structure defining a queue for a network interface. 8521259Swollman */ 8621259Swollmanstruct ifqueue { 8721259Swollman struct mbuf *ifq_head; 8821259Swollman struct mbuf *ifq_tail; 8921259Swollman int ifq_len; 9021259Swollman int ifq_maxlen; 9121259Swollman int ifq_drops; 9221259Swollman}; 9321259Swollman 9421259Swollman/* 9521259Swollman * Structure defining a network interface. 9621259Swollman * 9721259Swollman * (Would like to call this struct ``if'', but C isn't PL/1.) 9821259Swollman */ 9921259Swollmanstruct ifnet { 10021259Swollman void *if_softc; /* pointer to driver state */ 10121259Swollman char *if_name; /* name, e.g. ``en'' or ``lo'' */ 10221259Swollman TAILQ_ENTRY(ifnet) if_link; /* all struct ifnets are chained */ 10321259Swollman struct ifaddrhead if_addrhead; /* linked list of addresses per if */ 10421259Swollman int if_pcount; /* number of promiscuous listeners */ 10521259Swollman struct bpf_if *if_bpf; /* packet filter structure */ 10621259Swollman u_short if_index; /* numeric abbreviation for this if */ 10721259Swollman short if_unit; /* sub-unit for lower level driver */ 10821259Swollman short if_timer; /* time 'til if_watchdog called */ 10921259Swollman short if_flags; /* up/down, broadcast, etc. */ 11021259Swollman int if_ipending; /* interrupts pending */ 11121259Swollman void *if_linkmib; /* link-type-specific MIB data */ 11221259Swollman size_t if_linkmiblen; /* length of above data */ 11321259Swollman struct if_data if_data; 11421404Swollman struct ifmultihead if_multiaddrs; /* multicast addresses configured */ 11521404Swollman int if_amcount; /* number of all-multicast requests */ 11621259Swollman/* procedure handles */ 11721259Swollman int (*if_output) /* output routine (enqueue) */ 11821259Swollman __P((struct ifnet *, struct mbuf *, struct sockaddr *, 11921259Swollman struct rtentry *)); 12021259Swollman void (*if_start) /* initiate output routine */ 12121259Swollman __P((struct ifnet *)); 12221259Swollman int (*if_done) /* output complete routine */ 12321259Swollman __P((struct ifnet *)); /* (XXX not used; fake prototype) */ 12421259Swollman int (*if_ioctl) /* ioctl routine */ 12536735Sdfr __P((struct ifnet *, u_long, caddr_t)); 12621259Swollman void (*if_watchdog) /* timer routine */ 12721259Swollman __P((struct ifnet *)); 12821259Swollman int (*if_poll_recv) /* polled receive routine */ 12921259Swollman __P((struct ifnet *, int *)); 13021259Swollman int (*if_poll_xmit) /* polled transmit routine */ 13121259Swollman __P((struct ifnet *, int *)); 13221259Swollman void (*if_poll_intren) /* polled interrupt reenable routine */ 13321259Swollman __P((struct ifnet *)); 13421259Swollman void (*if_poll_slowinput) /* input routine for slow devices */ 13521259Swollman __P((struct ifnet *, struct mbuf *)); 13621259Swollman void (*if_init) /* Init routine */ 13721259Swollman __P((void *)); 13821404Swollman int (*if_resolvemulti) /* validate/resolve multicast */ 13921404Swollman __P((struct ifnet *, struct sockaddr **, struct sockaddr *)); 14021259Swollman struct ifqueue if_snd; /* output queue */ 14121259Swollman struct ifqueue *if_poll_slowq; /* input queue for slow devices */ 14252904Sshin struct ifprefixhead if_prefixhead; /* list of prefixes per if */ 14321259Swollman}; 14421259Swollmantypedef void if_init_f_t __P((void *)); 14521259Swollman 14621259Swollman#define if_mtu if_data.ifi_mtu 14721259Swollman#define if_type if_data.ifi_type 14821259Swollman#define if_physical if_data.ifi_physical 14921259Swollman#define if_addrlen if_data.ifi_addrlen 15021259Swollman#define if_hdrlen if_data.ifi_hdrlen 15121259Swollman#define if_metric if_data.ifi_metric 15221259Swollman#define if_baudrate if_data.ifi_baudrate 15321259Swollman#define if_ipackets if_data.ifi_ipackets 15421259Swollman#define if_ierrors if_data.ifi_ierrors 15521259Swollman#define if_opackets if_data.ifi_opackets 15621259Swollman#define if_oerrors if_data.ifi_oerrors 15721259Swollman#define if_collisions if_data.ifi_collisions 15821259Swollman#define if_ibytes if_data.ifi_ibytes 15921259Swollman#define if_obytes if_data.ifi_obytes 16021259Swollman#define if_imcasts if_data.ifi_imcasts 16121259Swollman#define if_omcasts if_data.ifi_omcasts 16221259Swollman#define if_iqdrops if_data.ifi_iqdrops 16321259Swollman#define if_noproto if_data.ifi_noproto 16421259Swollman#define if_lastchange if_data.ifi_lastchange 16521259Swollman#define if_recvquota if_data.ifi_recvquota 16621259Swollman#define if_xmitquota if_data.ifi_xmitquota 16721259Swollman#define if_rawoutput(if, m, sa) if_output(if, m, sa, (struct rtentry *)0) 16821259Swollman 16953541Sshin/* for compatibility with other BSDs */ 17053541Sshin#define if_addrlist if_addrhead 17153541Sshin#define if_list if_link 17253541Sshin 17321259Swollman/* 17421259Swollman * Bit values in if_ipending 17521259Swollman */ 17621259Swollman#define IFI_RECV 1 /* I want to receive */ 17721259Swollman#define IFI_XMIT 2 /* I want to transmit */ 17821259Swollman 17921259Swollman/* 18021259Swollman * Output queues (ifp->if_snd) and slow device input queues (*ifp->if_slowq) 18121259Swollman * are queues of messages stored on ifqueue structures 18221259Swollman * (defined above). Entries are added to and deleted from these structures 18321259Swollman * by these macros, which should be called with ipl raised to splimp(). 18421259Swollman */ 18521259Swollman#define IF_QFULL(ifq) ((ifq)->ifq_len >= (ifq)->ifq_maxlen) 18621259Swollman#define IF_DROP(ifq) ((ifq)->ifq_drops++) 18721259Swollman#define IF_ENQUEUE(ifq, m) { \ 18821259Swollman (m)->m_nextpkt = 0; \ 18921259Swollman if ((ifq)->ifq_tail == 0) \ 19021259Swollman (ifq)->ifq_head = m; \ 19121259Swollman else \ 19221259Swollman (ifq)->ifq_tail->m_nextpkt = m; \ 19321259Swollman (ifq)->ifq_tail = m; \ 19421259Swollman (ifq)->ifq_len++; \ 19521259Swollman} 19621259Swollman#define IF_PREPEND(ifq, m) { \ 19721259Swollman (m)->m_nextpkt = (ifq)->ifq_head; \ 19821259Swollman if ((ifq)->ifq_tail == 0) \ 19921259Swollman (ifq)->ifq_tail = (m); \ 20021259Swollman (ifq)->ifq_head = (m); \ 20121259Swollman (ifq)->ifq_len++; \ 20221259Swollman} 20321259Swollman#define IF_DEQUEUE(ifq, m) { \ 20421259Swollman (m) = (ifq)->ifq_head; \ 20521259Swollman if (m) { \ 20621259Swollman if (((ifq)->ifq_head = (m)->m_nextpkt) == 0) \ 20721259Swollman (ifq)->ifq_tail = 0; \ 20821259Swollman (m)->m_nextpkt = 0; \ 20921259Swollman (ifq)->ifq_len--; \ 21021259Swollman } \ 21121259Swollman} 21221259Swollman 21321259Swollman#ifdef KERNEL 21421259Swollman#define IF_ENQ_DROP(ifq, m) if_enq_drop(ifq, m) 21521259Swollman 21621259Swollman#if defined(__GNUC__) && defined(MT_HEADER) 21735210Sbdestatic __inline int 21821259Swollmanif_queue_drop(struct ifqueue *ifq, struct mbuf *m) 21921259Swollman{ 22021259Swollman IF_DROP(ifq); 22121259Swollman return 0; 22221259Swollman} 22321259Swollman 22435210Sbdestatic __inline int 22521259Swollmanif_enq_drop(struct ifqueue *ifq, struct mbuf *m) 22621259Swollman{ 22721259Swollman if (IF_QFULL(ifq) && 22821259Swollman !if_queue_drop(ifq, m)) 22921259Swollman return 0; 23021259Swollman IF_ENQUEUE(ifq, m); 23121259Swollman return 1; 23221259Swollman} 23321259Swollman#else 23421259Swollman 23521259Swollman#ifdef MT_HEADER 23621259Swollmanint if_enq_drop __P((struct ifqueue *, struct mbuf *)); 23721259Swollman#endif 23821259Swollman 23921259Swollman#endif 24049459Sbrian 24149459Sbrian/* 24249459Sbrian * 72 was chosen below because it is the size of a TCP/IP 24349459Sbrian * header (40) + the minimum mss (32). 24449459Sbrian */ 24549459Sbrian#define IF_MINMTU 72 24649459Sbrian#define IF_MAXMTU 65535 24749459Sbrian 24821259Swollman#endif /* KERNEL */ 24921259Swollman 25021259Swollman/* 25121259Swollman * The ifaddr structure contains information about one address 25221259Swollman * of an interface. They are maintained by the different address families, 25321259Swollman * are allocated and attached when an address is set, and are linked 25421259Swollman * together so all addresses for an interface can be located. 25521259Swollman */ 25621259Swollmanstruct ifaddr { 25721259Swollman struct sockaddr *ifa_addr; /* address of interface */ 25821259Swollman struct sockaddr *ifa_dstaddr; /* other end of p-to-p link */ 25921259Swollman#define ifa_broadaddr ifa_dstaddr /* broadcast address interface */ 26021259Swollman struct sockaddr *ifa_netmask; /* used to determine subnet */ 26121259Swollman struct ifnet *ifa_ifp; /* back-pointer to interface */ 26221259Swollman TAILQ_ENTRY(ifaddr) ifa_link; /* queue macro glue */ 26321259Swollman void (*ifa_rtrequest) /* check or clean routes (+ or -)'d */ 26421259Swollman __P((int, struct rtentry *, struct sockaddr *)); 26521259Swollman u_short ifa_flags; /* mostly rt_flags for cloning */ 26647254Spb u_int ifa_refcnt; /* references to this structure */ 26721259Swollman int ifa_metric; /* cost of going out this interface */ 26821259Swollman#ifdef notdef 26921259Swollman struct rtentry *ifa_rt; /* XXXX for ROUTETOIF ????? */ 27021259Swollman#endif 27128845Sjulian int (*ifa_claim_addr) /* check if an addr goes to this if */ 27228845Sjulian __P((struct ifaddr *, struct sockaddr *)); 27328845Sjulian 27421259Swollman}; 27521259Swollman#define IFA_ROUTE RTF_UP /* route installed */ 27621259Swollman 27753541Sshin/* for compatibility with other BSDs */ 27853541Sshin#define ifa_list ifa_link 27953541Sshin 28021404Swollman/* 28152904Sshin * The prefix structure contains information about one prefix 28252904Sshin * of an interface. They are maintained by the different address families, 28352904Sshin * are allocated and attached when an prefix or an address is set, 28453541Sshin * and are linked together so all prefixes for an interface can be located. 28552904Sshin */ 28652904Sshinstruct ifprefix { 28752904Sshin struct sockaddr *ifpr_prefix; /* prefix of interface */ 28852904Sshin struct ifnet *ifpr_ifp; /* back-pointer to interface */ 28953541Sshin TAILQ_ENTRY(ifprefix) ifpr_list; /* queue macro glue */ 29052904Sshin u_char ifpr_plen; /* prefix length in bits */ 29152904Sshin u_char ifpr_type; /* protocol dependent prefix type */ 29252904Sshin}; 29352904Sshin 29452904Sshin/* 29521404Swollman * Multicast address structure. This is analogous to the ifaddr 29621404Swollman * structure except that it keeps track of multicast addresses. 29721404Swollman * Also, the reference count here is a count of requests for this 29821404Swollman * address, not a count of pointers to this structure. 29921404Swollman */ 30021404Swollmanstruct ifmultiaddr { 30121434Swollman LIST_ENTRY(ifmultiaddr) ifma_link; /* queue macro glue */ 30221434Swollman struct sockaddr *ifma_addr; /* address this membership is for */ 30321434Swollman struct sockaddr *ifma_lladdr; /* link-layer translation, if any */ 30421434Swollman struct ifnet *ifma_ifp; /* back-pointer to interface */ 30521434Swollman u_int ifma_refcount; /* reference count */ 30621434Swollman void *ifma_protospec; /* protocol-specific state, if any */ 30721404Swollman}; 30821404Swollman 30921259Swollman#ifdef KERNEL 31021259Swollman#define IFAFREE(ifa) \ 31146568Speter do { \ 31246568Speter if ((ifa)->ifa_refcnt <= 0) \ 31346568Speter ifafree(ifa); \ 31446568Speter else \ 31546568Speter (ifa)->ifa_refcnt--; \ 31646568Speter } while (0) 31721259Swollman 31821259Swollmanextern struct ifnethead ifnet; 31952904Sshinextern struct ifnet **ifindex2ifnet; 32021259Swollmanextern int ifqmaxlen; 32121259Swollmanextern struct ifnet loif[]; 32221259Swollmanextern int if_index; 32321259Swollmanextern struct ifaddr **ifnet_addrs; 32421259Swollman 32521259Swollmanvoid ether_ifattach __P((struct ifnet *)); 32621259Swollmanvoid ether_input __P((struct ifnet *, struct ether_header *, struct mbuf *)); 32721259Swollmanint ether_output __P((struct ifnet *, 32821259Swollman struct mbuf *, struct sockaddr *, struct rtentry *)); 32921259Swollmanint ether_ioctl __P((struct ifnet *, int, caddr_t)); 33021259Swollman 33153541Sshinint if_addmulti __P((struct ifnet *, struct sockaddr *, 33221434Swollman struct ifmultiaddr **)); 33321404Swollmanint if_allmulti __P((struct ifnet *, int)); 33421259Swollmanvoid if_attach __P((struct ifnet *)); 33521404Swollmanint if_delmulti __P((struct ifnet *, struct sockaddr *)); 33645720Spetervoid if_detach __P((struct ifnet *)); 33721259Swollmanvoid if_down __P((struct ifnet *)); 33841879Sphkvoid if_route __P((struct ifnet *, int flag, int fam)); 33941879Sphkvoid if_unroute __P((struct ifnet *, int flag, int fam)); 34021259Swollmanvoid if_up __P((struct ifnet *)); 34121259Swollman/*void ifinit __P((void));*/ /* declared in systm.h for main() */ 34236735Sdfrint ifioctl __P((struct socket *, u_long, caddr_t, struct proc *)); 34321259Swollmanint ifpromisc __P((struct ifnet *, int)); 34421259Swollmanstruct ifnet *ifunit __P((char *)); 34552904Sshinstruct ifnet *if_withname __P((struct sockaddr *)); 34621259Swollman 34721259Swollmanint if_poll_recv_slow __P((struct ifnet *ifp, int *quotap)); 34821259Swollmanvoid if_poll_xmit_slow __P((struct ifnet *ifp, int *quotap)); 34921259Swollmanvoid if_poll_throttle __P((void)); 35021259Swollmanvoid if_poll_unthrottle __P((void *)); 35121259Swollmanvoid if_poll_init __P((void)); 35221259Swollmanvoid if_poll __P((void)); 35321259Swollman 35421259Swollmanstruct ifaddr *ifa_ifwithaddr __P((struct sockaddr *)); 35521259Swollmanstruct ifaddr *ifa_ifwithdstaddr __P((struct sockaddr *)); 35621259Swollmanstruct ifaddr *ifa_ifwithnet __P((struct sockaddr *)); 35721259Swollmanstruct ifaddr *ifa_ifwithroute __P((int, struct sockaddr *, 35821259Swollman struct sockaddr *)); 35921259Swollmanstruct ifaddr *ifaof_ifpforaddr __P((struct sockaddr *, struct ifnet *)); 36021259Swollmanvoid ifafree __P((struct ifaddr *)); 36121259Swollman 36253541Sshinstruct ifmultiaddr *ifmaof_ifpforaddr __P((struct sockaddr *, 36321434Swollman struct ifnet *)); 36436908Sjulianint if_simloop __P((struct ifnet *ifp, struct mbuf *m, 36536908Sjulian struct sockaddr *dst, int hlen)); 36621434Swollman 36721259Swollman#endif /* KERNEL */ 36821259Swollman 36921259Swollman 37021259Swollman#endif /* !_NET_IF_VAR_H_ */ 371