Home | History | Annotate | Line # | Download | only in net
if.h revision 1.46
      1  1.46   thorpej /*	$NetBSD: if.h,v 1.46 2000/03/06 20:49:00 thorpej Exp $	*/
      2  1.44   thorpej 
      3  1.44   thorpej /*-
      4  1.44   thorpej  * Copyright (c) 1999, 2000 The NetBSD Foundation, Inc.
      5  1.44   thorpej  * All rights reserved.
      6  1.44   thorpej  *
      7  1.44   thorpej  * This code is derived from software contributed to The NetBSD Foundation
      8  1.44   thorpej  * by William Studnemund and Jason R. Thorpe.
      9  1.44   thorpej  *
     10  1.44   thorpej  * Redistribution and use in source and binary forms, with or without
     11  1.44   thorpej  * modification, are permitted provided that the following conditions
     12  1.44   thorpej  * are met:
     13  1.44   thorpej  * 1. Redistributions of source code must retain the above copyright
     14  1.44   thorpej  *    notice, this list of conditions and the following disclaimer.
     15  1.44   thorpej  * 2. Redistributions in binary form must reproduce the above copyright
     16  1.44   thorpej  *    notice, this list of conditions and the following disclaimer in the
     17  1.44   thorpej  *    documentation and/or other materials provided with the distribution.
     18  1.44   thorpej  * 3. All advertising materials mentioning features or use of this software
     19  1.44   thorpej  *    must display the following acknowledgement:
     20  1.44   thorpej  *	This product includes software developed by the NetBSD
     21  1.44   thorpej  *	Foundation, Inc. and its contributors.
     22  1.44   thorpej  * 4. Neither the name of The NetBSD Foundation nor the names of its
     23  1.44   thorpej  *    contributors may be used to endorse or promote products derived
     24  1.44   thorpej  *    from this software without specific prior written permission.
     25  1.44   thorpej  *
     26  1.44   thorpej  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
     27  1.44   thorpej  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
     28  1.44   thorpej  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
     29  1.44   thorpej  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
     30  1.44   thorpej  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
     31  1.44   thorpej  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
     32  1.44   thorpej  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
     33  1.44   thorpej  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
     34  1.44   thorpej  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
     35  1.44   thorpej  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
     36  1.44   thorpej  * POSSIBILITY OF SUCH DAMAGE.
     37  1.44   thorpej  */
     38  1.10       cgd 
     39   1.1       cgd /*
     40   1.9   mycroft  * Copyright (c) 1982, 1986, 1989, 1993
     41   1.9   mycroft  *	The Regents of the University of California.  All rights reserved.
     42   1.1       cgd  *
     43   1.1       cgd  * Redistribution and use in source and binary forms, with or without
     44   1.1       cgd  * modification, are permitted provided that the following conditions
     45   1.1       cgd  * are met:
     46   1.1       cgd  * 1. Redistributions of source code must retain the above copyright
     47   1.1       cgd  *    notice, this list of conditions and the following disclaimer.
     48   1.1       cgd  * 2. Redistributions in binary form must reproduce the above copyright
     49   1.1       cgd  *    notice, this list of conditions and the following disclaimer in the
     50   1.1       cgd  *    documentation and/or other materials provided with the distribution.
     51   1.1       cgd  * 3. All advertising materials mentioning features or use of this software
     52   1.1       cgd  *    must display the following acknowledgement:
     53   1.1       cgd  *	This product includes software developed by the University of
     54   1.1       cgd  *	California, Berkeley and its contributors.
     55   1.1       cgd  * 4. Neither the name of the University nor the names of its contributors
     56   1.1       cgd  *    may be used to endorse or promote products derived from this software
     57   1.1       cgd  *    without specific prior written permission.
     58   1.1       cgd  *
     59   1.1       cgd  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
     60   1.1       cgd  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
     61   1.1       cgd  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
     62   1.1       cgd  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
     63   1.1       cgd  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
     64   1.1       cgd  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
     65   1.1       cgd  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
     66   1.1       cgd  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
     67   1.1       cgd  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
     68   1.1       cgd  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
     69   1.1       cgd  * SUCH DAMAGE.
     70   1.1       cgd  *
     71  1.30      fvdl  *	@(#)if.h	8.3 (Berkeley) 2/9/95
     72   1.1       cgd  */
     73   1.1       cgd 
     74  1.28     chuck #ifndef _NET_IF_H_
     75  1.28     chuck #define _NET_IF_H_
     76  1.28     chuck 
     77  1.38    kleink #if !defined(_XOPEN_SOURCE)
     78  1.38    kleink 
     79  1.17   mycroft #include <sys/queue.h>
     80  1.17   mycroft 
     81   1.1       cgd /*
     82   1.1       cgd  * Structures defining a network interface, providing a packet
     83   1.1       cgd  * transport mechanism (ala level 0 of the PUP protocols).
     84   1.1       cgd  *
     85   1.1       cgd  * Each interface accepts output datagrams of a specified maximum
     86   1.1       cgd  * length, and provides higher level routines with input datagrams
     87   1.1       cgd  * received from its medium.
     88   1.1       cgd  *
     89   1.9   mycroft  * Output occurs when the routine if_output is called, with four parameters:
     90   1.9   mycroft  *	(*ifp->if_output)(ifp, m, dst, rt)
     91   1.1       cgd  * Here m is the mbuf chain to be sent and dst is the destination address.
     92   1.1       cgd  * The output routine encapsulates the supplied datagram if necessary,
     93   1.1       cgd  * and then transmits it on its medium.
     94   1.1       cgd  *
     95   1.1       cgd  * On input, each interface unwraps the data received by it, and either
     96   1.1       cgd  * places it on the input queue of a internetwork datagram routine
     97   1.1       cgd  * and posts the associated software interrupt, or passes the datagram to a raw
     98   1.1       cgd  * packet input routine.
     99   1.1       cgd  *
    100   1.1       cgd  * Routines exist for locating interfaces by their addresses
    101   1.1       cgd  * or for locating a interface on a certain network, as well as more general
    102   1.1       cgd  * routing and gateway routines maintaining information used to locate
    103   1.1       cgd  * interfaces.  These routines live in the files if.c and route.c
    104   1.1       cgd  */
    105   1.7   mycroft /*  XXX fast fix for SNMP, going away soon */
    106   1.1       cgd #include <sys/time.h>
    107   1.1       cgd 
    108  1.42    bouyer #if defined(_KERNEL) && !defined(_LKM)
    109  1.42    bouyer #include "opt_compat_netbsd.h"
    110  1.42    bouyer #endif
    111  1.42    bouyer 
    112   1.9   mycroft struct mbuf;
    113   1.9   mycroft struct proc;
    114   1.9   mycroft struct rtentry;
    115   1.9   mycroft struct socket;
    116   1.9   mycroft struct ether_header;
    117   1.9   mycroft 
    118   1.1       cgd /*
    119  1.12       cgd  * Structure defining statistics and other data kept regarding a network
    120  1.12       cgd  * interface.
    121  1.12       cgd  */
    122  1.46   thorpej struct if_data {
    123  1.12       cgd 	/* generic interface information */
    124  1.12       cgd 	u_char	ifi_type;		/* ethernet, tokenring, etc. */
    125  1.12       cgd 	u_char	ifi_addrlen;		/* media address length */
    126  1.12       cgd 	u_char	ifi_hdrlen;		/* media header length */
    127  1.46   thorpej 	int	ifi_link_state;		/* current link state */
    128  1.42    bouyer 	u_quad_t ifi_mtu;		/* maximum transmission unit */
    129  1.42    bouyer 	u_quad_t ifi_metric;		/* routing metric (external only) */
    130  1.42    bouyer 	u_quad_t ifi_baudrate;		/* linespeed */
    131  1.42    bouyer 	/* volatile statistics */
    132  1.42    bouyer 	u_quad_t ifi_ipackets;		/* packets received on interface */
    133  1.42    bouyer 	u_quad_t ifi_ierrors;		/* input errors on interface */
    134  1.42    bouyer 	u_quad_t ifi_opackets;		/* packets sent on interface */
    135  1.42    bouyer 	u_quad_t ifi_oerrors;		/* output errors on interface */
    136  1.42    bouyer 	u_quad_t ifi_collisions;	/* collisions on csma interfaces */
    137  1.42    bouyer 	u_quad_t ifi_ibytes;		/* total number of octets received */
    138  1.42    bouyer 	u_quad_t ifi_obytes;		/* total number of octets sent */
    139  1.42    bouyer 	u_quad_t ifi_imcasts;		/* packets received via multicast */
    140  1.42    bouyer 	u_quad_t ifi_omcasts;		/* packets sent via multicast */
    141  1.42    bouyer 	u_quad_t ifi_iqdrops;		/* dropped on input, this interface */
    142  1.42    bouyer 	u_quad_t ifi_noproto;		/* destined for unsupported protocol */
    143  1.42    bouyer 	struct	timeval ifi_lastchange;	/* last updated */
    144  1.42    bouyer };
    145  1.42    bouyer 
    146  1.46   thorpej /*
    147  1.46   thorpej  * Values for if_link_state.
    148  1.46   thorpej  */
    149  1.46   thorpej #define	LINK_STATE_UNKNOWN	0	/* link invalid/unknown */
    150  1.46   thorpej #define	LINK_STATE_DOWN		1	/* link is down */
    151  1.46   thorpej #define	LINK_STATE_UP		2	/* link is up */
    152  1.46   thorpej 
    153  1.45    kleink #if defined(_KERNEL) && defined(COMPAT_14)
    154  1.42    bouyer /* Pre-1.5 if_data struct */
    155  1.46   thorpej struct if_data14 {
    156  1.42    bouyer 	/* generic interface information */
    157  1.42    bouyer 	u_char	ifi_type;		/* ethernet, tokenring, etc. */
    158  1.42    bouyer 	u_char	ifi_addrlen;		/* media address length */
    159  1.42    bouyer 	u_char	ifi_hdrlen;		/* media header length */
    160  1.12       cgd 	u_long	ifi_mtu;		/* maximum transmission unit */
    161  1.12       cgd 	u_long	ifi_metric;		/* routing metric (external only) */
    162  1.12       cgd 	u_long	ifi_baudrate;		/* linespeed */
    163  1.12       cgd 	/* volatile statistics */
    164  1.12       cgd 	u_long	ifi_ipackets;		/* packets received on interface */
    165  1.12       cgd 	u_long	ifi_ierrors;		/* input errors on interface */
    166  1.12       cgd 	u_long	ifi_opackets;		/* packets sent on interface */
    167  1.12       cgd 	u_long	ifi_oerrors;		/* output errors on interface */
    168  1.12       cgd 	u_long	ifi_collisions;		/* collisions on csma interfaces */
    169  1.12       cgd 	u_long	ifi_ibytes;		/* total number of octets received */
    170  1.12       cgd 	u_long	ifi_obytes;		/* total number of octets sent */
    171  1.12       cgd 	u_long	ifi_imcasts;		/* packets received via multicast */
    172  1.12       cgd 	u_long	ifi_omcasts;		/* packets sent via multicast */
    173  1.12       cgd 	u_long	ifi_iqdrops;		/* dropped on input, this interface */
    174  1.12       cgd 	u_long	ifi_noproto;		/* destined for unsupported protocol */
    175  1.12       cgd 	struct	timeval ifi_lastchange;	/* last updated */
    176  1.12       cgd };
    177  1.45    kleink #endif /* _KERNEL && COMPAT_14 */
    178  1.12       cgd 
    179  1.12       cgd /*
    180   1.1       cgd  * Structure defining a queue for a network interface.
    181   1.1       cgd  *
    182   1.1       cgd  * (Would like to call this struct ``if'', but C isn't PL/1.)
    183   1.1       cgd  */
    184  1.19       cgd TAILQ_HEAD(ifnet_head, ifnet);		/* the actual queue head */
    185  1.19       cgd 
    186  1.23   thorpej /*
    187  1.23   thorpej  * Length of interface external name, including terminating '\0'.
    188  1.23   thorpej  * Note: this is the same size as a generic device's external name.
    189  1.23   thorpej  */
    190  1.23   thorpej #define	IFNAMSIZ	16
    191  1.37    itojun #define	IF_NAMESIZE	IFNAMSIZ
    192  1.23   thorpej 
    193  1.19       cgd struct ifnet {				/* and the entries */
    194  1.23   thorpej 	void	*if_softc;		/* lower-level data for this if */
    195  1.17   mycroft 	TAILQ_ENTRY(ifnet) if_list;	/* all struct ifnets are chained */
    196  1.17   mycroft 	TAILQ_HEAD(, ifaddr) if_addrlist; /* linked list of addresses per if */
    197  1.23   thorpej 	char	if_xname[IFNAMSIZ];	/* external name (name + unit) */
    198   1.9   mycroft 	int	if_pcount;		/* number of promiscuous listeners */
    199   1.9   mycroft 	caddr_t	if_bpf;			/* packet filter structure */
    200   1.9   mycroft 	u_short	if_index;		/* numeric abbreviation for this if */
    201   1.9   mycroft 	short	if_timer;		/* time 'til if_watchdog called */
    202   1.1       cgd 	short	if_flags;		/* up/down, broadcast, etc. */
    203  1.25       gwr 	short	if__pad1;		/* be nice to m68k ports */
    204  1.12       cgd 	struct	if_data if_data;	/* statistics and other data about if */
    205  1.44   thorpej 	/*
    206  1.44   thorpej 	 * Procedure handles.  If you add more of these, don't forget the
    207  1.44   thorpej 	 * corresponding NULL stub in if.c.
    208  1.44   thorpej 	 */
    209   1.9   mycroft 	int	(*if_output)		/* output routine (enqueue) */
    210   1.9   mycroft 		__P((struct ifnet *, struct mbuf *, struct sockaddr *,
    211   1.9   mycroft 		     struct rtentry *));
    212  1.36   thorpej 	void	(*if_input)		/* input routine (from h/w driver) */
    213  1.36   thorpej 		__P((struct ifnet *, struct mbuf *));
    214  1.16   mycroft 	void	(*if_start)		/* initiate output routine */
    215   1.9   mycroft 		__P((struct ifnet *));
    216   1.9   mycroft 	int	(*if_ioctl)		/* ioctl routine */
    217  1.13       cgd 		__P((struct ifnet *, u_long, caddr_t));
    218   1.9   mycroft 	int	(*if_reset)		/* XXX bus reset routine */
    219  1.23   thorpej 		__P((struct ifnet *));
    220  1.16   mycroft 	void	(*if_watchdog)		/* timer routine */
    221  1.32      matt 		__P((struct ifnet *));
    222  1.32      matt 	void	(*if_drain)		/* routine to release resources */
    223  1.23   thorpej 		__P((struct ifnet *));
    224   1.1       cgd 	struct	ifqueue {
    225   1.1       cgd 		struct	mbuf *ifq_head;
    226   1.1       cgd 		struct	mbuf *ifq_tail;
    227   1.1       cgd 		int	ifq_len;
    228   1.1       cgd 		int	ifq_maxlen;
    229   1.1       cgd 		int	ifq_drops;
    230   1.1       cgd 	} if_snd;			/* output queue */
    231  1.26        is 	struct	sockaddr_dl *if_sadl;	/* pointer to our sockaddr_dl */
    232  1.29        is 	u_int8_t *if_broadcastaddr;	/* linklevel broadcast bytestring */
    233  1.37    itojun 	struct ifprefix *if_prefixlist; /* linked list of prefixes per if */
    234   1.1       cgd };
    235   1.9   mycroft #define	if_mtu		if_data.ifi_mtu
    236   1.9   mycroft #define	if_type		if_data.ifi_type
    237   1.9   mycroft #define	if_addrlen	if_data.ifi_addrlen
    238   1.9   mycroft #define	if_hdrlen	if_data.ifi_hdrlen
    239   1.9   mycroft #define	if_metric	if_data.ifi_metric
    240  1.46   thorpej #define	if_link_state	if_data.ifi_link_state
    241   1.9   mycroft #define	if_baudrate	if_data.ifi_baudrate
    242   1.9   mycroft #define	if_ipackets	if_data.ifi_ipackets
    243   1.9   mycroft #define	if_ierrors	if_data.ifi_ierrors
    244   1.9   mycroft #define	if_opackets	if_data.ifi_opackets
    245   1.9   mycroft #define	if_oerrors	if_data.ifi_oerrors
    246   1.9   mycroft #define	if_collisions	if_data.ifi_collisions
    247   1.9   mycroft #define	if_ibytes	if_data.ifi_ibytes
    248   1.9   mycroft #define	if_obytes	if_data.ifi_obytes
    249   1.9   mycroft #define	if_imcasts	if_data.ifi_imcasts
    250   1.9   mycroft #define	if_omcasts	if_data.ifi_omcasts
    251   1.9   mycroft #define	if_iqdrops	if_data.ifi_iqdrops
    252   1.9   mycroft #define	if_noproto	if_data.ifi_noproto
    253   1.9   mycroft #define	if_lastchange	if_data.ifi_lastchange
    254   1.1       cgd 
    255   1.1       cgd #define	IFF_UP		0x1		/* interface is up */
    256   1.1       cgd #define	IFF_BROADCAST	0x2		/* broadcast address valid */
    257   1.1       cgd #define	IFF_DEBUG	0x4		/* turn on debugging */
    258   1.1       cgd #define	IFF_LOOPBACK	0x8		/* is a loopback net */
    259   1.1       cgd #define	IFF_POINTOPOINT	0x10		/* interface is point-to-point link */
    260   1.1       cgd #define	IFF_NOTRAILERS	0x20		/* avoid use of trailers */
    261   1.1       cgd #define	IFF_RUNNING	0x40		/* resources allocated */
    262   1.1       cgd #define	IFF_NOARP	0x80		/* no address resolution protocol */
    263   1.1       cgd #define	IFF_PROMISC	0x100		/* receive all packets */
    264   1.1       cgd #define	IFF_ALLMULTI	0x200		/* receive all multicast packets */
    265   1.1       cgd #define	IFF_OACTIVE	0x400		/* transmission in progress */
    266   1.1       cgd #define	IFF_SIMPLEX	0x800		/* can't hear own transmissions */
    267   1.5       cgd #define	IFF_LINK0	0x1000		/* per link layer defined bit */
    268   1.6       cgd #define	IFF_LINK1	0x2000		/* per link layer defined bit */
    269   1.6       cgd #define	IFF_LINK2	0x4000		/* per link layer defined bit */
    270   1.9   mycroft #define	IFF_MULTICAST	0x8000		/* supports multicast */
    271   1.4   hpeyerl 
    272   1.1       cgd /* flags set internally only: */
    273   1.9   mycroft #define	IFF_CANTCHANGE \
    274   1.9   mycroft 	(IFF_BROADCAST|IFF_POINTOPOINT|IFF_RUNNING|IFF_OACTIVE|\
    275   1.9   mycroft 	    IFF_SIMPLEX|IFF_MULTICAST|IFF_ALLMULTI)
    276   1.1       cgd 
    277   1.1       cgd /*
    278  1.46   thorpej  * Some convenience macros used for setting ifi_baudrate.
    279  1.46   thorpej  * XXX 1000 vs. 1024? --thorpej (at) netbsd.org
    280  1.46   thorpej  */
    281  1.46   thorpej #define	IF_Kbps(x)	((x) * 1000)		/* kilobits/sec. */
    282  1.46   thorpej #define	IF_Mbps(x)	(IF_Kbps((x) * 1000))	/* megabits/sec. */
    283  1.46   thorpej #define	IF_Gbps(x)	(IF_Mbps((x) * 1000))	/* gigabits/sec. */
    284  1.46   thorpej 
    285  1.46   thorpej /*
    286   1.1       cgd  * Output queues (ifp->if_snd) and internetwork datagram level (pup level 1)
    287   1.1       cgd  * input routines have queues of messages stored on ifqueue structures
    288   1.1       cgd  * (defined above).  Entries are added to and deleted from these structures
    289   1.1       cgd  * by these macros, which should be called with ipl raised to splimp().
    290   1.1       cgd  */
    291   1.1       cgd #define	IF_QFULL(ifq)		((ifq)->ifq_len >= (ifq)->ifq_maxlen)
    292   1.1       cgd #define	IF_DROP(ifq)		((ifq)->ifq_drops++)
    293   1.1       cgd #define	IF_ENQUEUE(ifq, m) { \
    294   1.1       cgd 	(m)->m_nextpkt = 0; \
    295   1.1       cgd 	if ((ifq)->ifq_tail == 0) \
    296   1.1       cgd 		(ifq)->ifq_head = m; \
    297   1.1       cgd 	else \
    298   1.1       cgd 		(ifq)->ifq_tail->m_nextpkt = m; \
    299   1.1       cgd 	(ifq)->ifq_tail = m; \
    300   1.1       cgd 	(ifq)->ifq_len++; \
    301   1.1       cgd }
    302   1.1       cgd #define	IF_PREPEND(ifq, m) { \
    303   1.1       cgd 	(m)->m_nextpkt = (ifq)->ifq_head; \
    304   1.1       cgd 	if ((ifq)->ifq_tail == 0) \
    305   1.1       cgd 		(ifq)->ifq_tail = (m); \
    306   1.1       cgd 	(ifq)->ifq_head = (m); \
    307   1.1       cgd 	(ifq)->ifq_len++; \
    308   1.1       cgd }
    309   1.1       cgd #define	IF_DEQUEUE(ifq, m) { \
    310   1.1       cgd 	(m) = (ifq)->ifq_head; \
    311   1.1       cgd 	if (m) { \
    312   1.1       cgd 		if (((ifq)->ifq_head = (m)->m_nextpkt) == 0) \
    313   1.1       cgd 			(ifq)->ifq_tail = 0; \
    314   1.1       cgd 		(m)->m_nextpkt = 0; \
    315   1.1       cgd 		(ifq)->ifq_len--; \
    316   1.1       cgd 	} \
    317   1.1       cgd }
    318   1.1       cgd 
    319   1.1       cgd #define	IFQ_MAXLEN	50
    320   1.1       cgd #define	IFNET_SLOWHZ	1		/* granularity is 1 second */
    321   1.1       cgd 
    322   1.1       cgd /*
    323  1.35     aidan  * Structure defining statistics and other data kept regarding an address
    324  1.35     aidan  * on a network interface.
    325  1.35     aidan  */
    326  1.35     aidan struct ifaddr_data {
    327  1.35     aidan 	int64_t	ifad_inbytes;
    328  1.35     aidan 	int64_t	ifad_outbytes;
    329  1.35     aidan };
    330  1.35     aidan 
    331  1.35     aidan /*
    332   1.1       cgd  * The ifaddr structure contains information about one address
    333   1.1       cgd  * of an interface.  They are maintained by the different address families,
    334   1.1       cgd  * are allocated and attached when an address is set, and are linked
    335   1.1       cgd  * together so all addresses for an interface can be located.
    336   1.1       cgd  */
    337   1.1       cgd struct ifaddr {
    338   1.1       cgd 	struct	sockaddr *ifa_addr;	/* address of interface */
    339   1.1       cgd 	struct	sockaddr *ifa_dstaddr;	/* other end of p-to-p link */
    340   1.1       cgd #define	ifa_broadaddr	ifa_dstaddr	/* broadcast address interface */
    341   1.1       cgd 	struct	sockaddr *ifa_netmask;	/* used to determine subnet */
    342   1.1       cgd 	struct	ifnet *ifa_ifp;		/* back-pointer to interface */
    343  1.17   mycroft 	TAILQ_ENTRY(ifaddr) ifa_list;	/* list of addresses for interface */
    344  1.35     aidan 	struct	ifaddr_data	ifa_data;	/* statistics on the address */
    345  1.20  christos 	void	(*ifa_rtrequest)	/* check or clean routes (+ or -)'d */
    346  1.20  christos 		    __P((int, struct rtentry *, struct sockaddr *));
    347  1.41  wrstuden 	u_int	ifa_flags;		/* mostly rt_flags for cloning */
    348  1.41  wrstuden 	int	ifa_refcnt;		/* count of references */
    349   1.9   mycroft 	int	ifa_metric;		/* cost of going out this interface */
    350   1.1       cgd };
    351   1.9   mycroft #define	IFA_ROUTE	RTF_UP		/* route installed */
    352   1.9   mycroft 
    353   1.9   mycroft /*
    354  1.37    itojun  * The prefix structure contains information about one prefix
    355  1.37    itojun  * of an interface.  They are maintained by the different address families,
    356  1.43    itojun  * are allocated and attached when an prefix or an address is set,
    357  1.37    itojun  * and are linked together so all prfefixes for an interface can be located.
    358  1.37    itojun  */
    359  1.37    itojun struct ifprefix {
    360  1.37    itojun 	struct	sockaddr *ifpr_prefix;	/* prefix of interface */
    361  1.37    itojun 	struct	ifnet *ifpr_ifp;	/* back-pointer to interface */
    362  1.37    itojun 	struct ifprefix *ifpr_next;
    363  1.37    itojun 	u_char	ifpr_plen;		/* prefix length in bits */
    364  1.43    itojun 	u_char	ifpr_type;		/* protocol dependent prefix type */
    365  1.37    itojun };
    366  1.37    itojun 
    367  1.37    itojun /*
    368   1.9   mycroft  * Message format for use in obtaining information about interfaces
    369   1.9   mycroft  * from sysctl and the routing socket.
    370   1.9   mycroft  */
    371   1.9   mycroft struct if_msghdr {
    372   1.9   mycroft 	u_short	ifm_msglen;	/* to skip over non-understood messages */
    373   1.9   mycroft 	u_char	ifm_version;	/* future binary compatability */
    374   1.9   mycroft 	u_char	ifm_type;	/* message type */
    375   1.9   mycroft 	int	ifm_addrs;	/* like rtm_addrs */
    376   1.9   mycroft 	int	ifm_flags;	/* value of if_flags */
    377   1.9   mycroft 	u_short	ifm_index;	/* index for associated ifp */
    378   1.9   mycroft 	struct	if_data ifm_data;/* statistics and other data about if */
    379   1.9   mycroft };
    380  1.42    bouyer 
    381  1.45    kleink #if defined(_KERNEL) && defined(COMPAT_14)
    382  1.42    bouyer /* pre-1.5 if_msghdr (ifm_data changed) */
    383  1.42    bouyer struct if_msghdr14 {
    384  1.42    bouyer 	u_short	ifm_msglen;	/* to skip over non-understood messages */
    385  1.42    bouyer 	u_char	ifm_version;	/* future binary compatability */
    386  1.42    bouyer 	u_char	ifm_type;	/* message type */
    387  1.42    bouyer 	int	ifm_addrs;	/* like rtm_addrs */
    388  1.42    bouyer 	int	ifm_flags;	/* value of if_flags */
    389  1.42    bouyer 	u_short	ifm_index;	/* index for associated ifp */
    390  1.42    bouyer 	struct	if_data14 ifm_data; /* statistics and other data about if */
    391  1.42    bouyer };
    392  1.45    kleink #endif /* _KERNEL && COMPAT_14 */
    393   1.9   mycroft 
    394   1.9   mycroft /*
    395   1.9   mycroft  * Message format for use in obtaining information about interface addresses
    396   1.9   mycroft  * from sysctl and the routing socket.
    397   1.9   mycroft  */
    398   1.9   mycroft struct ifa_msghdr {
    399   1.9   mycroft 	u_short	ifam_msglen;	/* to skip over non-understood messages */
    400   1.9   mycroft 	u_char	ifam_version;	/* future binary compatability */
    401   1.9   mycroft 	u_char	ifam_type;	/* message type */
    402   1.9   mycroft 	int	ifam_addrs;	/* like rtm_addrs */
    403   1.9   mycroft 	int	ifam_flags;	/* value of ifa_flags */
    404   1.9   mycroft 	u_short	ifam_index;	/* index for associated ifp */
    405   1.9   mycroft 	int	ifam_metric;	/* value of ifa_metric */
    406   1.9   mycroft };
    407  1.46   thorpej 
    408  1.46   thorpej /*
    409  1.46   thorpej  * Message format announcing the arrival or departure of a network interface.
    410  1.46   thorpej  */
    411  1.46   thorpej struct if_announcemsghdr {
    412  1.46   thorpej 	u_short	ifan_msglen;	/* to skip over non-understood messages */
    413  1.46   thorpej 	u_char	ifan_version;	/* future binary compatibility */
    414  1.46   thorpej 	u_char	ifan_type;	/* message type */
    415  1.46   thorpej 	u_short	ifan_index;	/* index for associated ifp */
    416  1.46   thorpej 	char	ifan_name[IFNAMSIZ]; /* if name, e.g. "en0" */
    417  1.46   thorpej 	u_short	ifan_what;	/* what type of announcement */
    418  1.46   thorpej };
    419  1.46   thorpej 
    420  1.46   thorpej #define	IFAN_ARRIVAL	0	/* interface arrival */
    421  1.46   thorpej #define	IFAN_DEPARTURE	1	/* interface departure */
    422   1.9   mycroft 
    423   1.1       cgd /*
    424   1.1       cgd  * Interface request structure used for socket
    425   1.1       cgd  * ioctl's.  All interface ioctl's must have parameter
    426   1.1       cgd  * definitions which begin with ifr_name.  The
    427   1.1       cgd  * remainder may be interface specific.
    428   1.1       cgd  */
    429   1.1       cgd struct	ifreq {
    430   1.1       cgd 	char	ifr_name[IFNAMSIZ];		/* if name, e.g. "en0" */
    431   1.1       cgd 	union {
    432   1.1       cgd 		struct	sockaddr ifru_addr;
    433   1.1       cgd 		struct	sockaddr ifru_dstaddr;
    434   1.1       cgd 		struct	sockaddr ifru_broadaddr;
    435   1.1       cgd 		short	ifru_flags;
    436   1.1       cgd 		int	ifru_metric;
    437  1.24       cgd 		int	ifru_mtu;
    438  1.39      matt 		u_int	ifru_value;
    439   1.1       cgd 		caddr_t	ifru_data;
    440   1.1       cgd 	} ifr_ifru;
    441   1.1       cgd #define	ifr_addr	ifr_ifru.ifru_addr	/* address */
    442   1.1       cgd #define	ifr_dstaddr	ifr_ifru.ifru_dstaddr	/* other end of p-to-p link */
    443   1.1       cgd #define	ifr_broadaddr	ifr_ifru.ifru_broadaddr	/* broadcast address */
    444   1.1       cgd #define	ifr_flags	ifr_ifru.ifru_flags	/* flags */
    445   1.1       cgd #define	ifr_metric	ifr_ifru.ifru_metric	/* metric */
    446  1.24       cgd #define	ifr_mtu		ifr_ifru.ifru_mtu	/* mtu */
    447  1.39      matt #define	ifr_value	ifr_ifru.ifru_value	/* generic value */
    448  1.27   thorpej #define	ifr_media	ifr_ifru.ifru_metric	/* media options (overload) */
    449   1.1       cgd #define	ifr_data	ifr_ifru.ifru_data	/* for use by interface */
    450   1.1       cgd };
    451   1.1       cgd 
    452   1.1       cgd struct ifaliasreq {
    453   1.1       cgd 	char	ifra_name[IFNAMSIZ];		/* if name, e.g. "en0" */
    454   1.1       cgd 	struct	sockaddr ifra_addr;
    455  1.21        pk 	struct	sockaddr ifra_dstaddr;
    456  1.21        pk #define	ifra_broadaddr	ifra_dstaddr
    457   1.1       cgd 	struct	sockaddr ifra_mask;
    458  1.27   thorpej };
    459  1.27   thorpej 
    460  1.27   thorpej struct ifmediareq {
    461  1.27   thorpej 	char	ifm_name[IFNAMSIZ];		/* if name, e.g. "en0" */
    462  1.27   thorpej 	int	ifm_current;			/* current media options */
    463  1.27   thorpej 	int	ifm_mask;			/* don't care mask */
    464  1.27   thorpej 	int	ifm_status;			/* media status */
    465  1.27   thorpej 	int	ifm_active;			/* active options */
    466  1.27   thorpej 	int	ifm_count;			/* # entries in ifm_ulist
    467  1.27   thorpej 						   array */
    468  1.27   thorpej 	int	*ifm_ulist;			/* media words */
    469   1.1       cgd };
    470  1.31       kml 
    471  1.31       kml 
    472  1.31       kml struct  ifdrv {
    473  1.31       kml 	char		ifd_name[IFNAMSIZ];	/* if name, e.g. "en0" */
    474  1.31       kml 	unsigned long	ifd_cmd;
    475  1.31       kml 	size_t		ifd_len;
    476  1.31       kml 	void		*ifd_data;
    477  1.31       kml };
    478   1.1       cgd 
    479   1.1       cgd /*
    480   1.1       cgd  * Structure used in SIOCGIFCONF request.
    481   1.1       cgd  * Used to retrieve interface configuration
    482   1.1       cgd  * for machine (useful for programs which
    483   1.1       cgd  * must know all networks accessible).
    484   1.1       cgd  */
    485   1.1       cgd struct	ifconf {
    486   1.1       cgd 	int	ifc_len;		/* size of associated buffer */
    487   1.1       cgd 	union {
    488   1.1       cgd 		caddr_t	ifcu_buf;
    489   1.1       cgd 		struct	ifreq *ifcu_req;
    490   1.1       cgd 	} ifc_ifcu;
    491   1.1       cgd #define	ifc_buf	ifc_ifcu.ifcu_buf	/* buffer address */
    492   1.1       cgd #define	ifc_req	ifc_ifcu.ifcu_req	/* array of structures returned */
    493   1.1       cgd };
    494   1.1       cgd 
    495  1.37    itojun /*
    496  1.37    itojun  * Structure for SIOC[AGD]LIFADDR
    497  1.37    itojun  */
    498  1.37    itojun struct if_laddrreq {
    499  1.37    itojun 	char iflr_name[IFNAMSIZ];
    500  1.37    itojun 	unsigned int flags;
    501  1.37    itojun #define IFLR_PREFIX	0x8000	/* in: prefix given  out: kernel fills id */
    502  1.37    itojun 	unsigned int prefixlen;		/* in/out */
    503  1.37    itojun 	struct sockaddr_storage addr;	/* in/out */
    504  1.37    itojun 	struct sockaddr_storage dstaddr; /* out */
    505  1.37    itojun };
    506  1.37    itojun 
    507   1.9   mycroft #include <net/if_arp.h>
    508   1.9   mycroft 
    509  1.38    kleink #endif /* !_XOPEN_SOURCE */
    510  1.38    kleink 
    511  1.15       jtc #ifdef _KERNEL
    512  1.44   thorpej #ifdef IFAREF_DEBUG
    513  1.44   thorpej #define	IFAREF(ifa)							\
    514  1.44   thorpej do {									\
    515  1.44   thorpej 	printf("IFAREF: %s:%d %p -> %d\n", __FILE__, __LINE__,		\
    516  1.44   thorpej 	    (ifa), ++(ifa)->ifa_refcnt);				\
    517  1.44   thorpej } while (0)
    518  1.44   thorpej 
    519  1.44   thorpej #define	IFAFREE(ifa)							\
    520  1.44   thorpej do {									\
    521  1.44   thorpej 	if ((ifa)->ifa_refcnt <= 0)					\
    522  1.44   thorpej 		panic("%s:%d: %p ifa_refcnt <= 0", __FILE__,		\
    523  1.44   thorpej 		    __LINE__, (ifa));					\
    524  1.44   thorpej 	printf("IFAFREE: %s:%d %p -> %d\n", __FILE__, __LINE__,		\
    525  1.44   thorpej 	    (ifa), --(ifa)->ifa_refcnt);				\
    526  1.44   thorpej 	if ((ifa)->ifa_refcnt == 0)					\
    527  1.44   thorpej 		ifafree(ifa);						\
    528  1.44   thorpej } while (0)
    529  1.44   thorpej #else
    530  1.44   thorpej #define	IFAREF(ifa)	(ifa)->ifa_refcnt++
    531  1.44   thorpej 
    532  1.44   thorpej #ifdef DIAGNOSTIC
    533  1.44   thorpej #define	IFAFREE(ifa)							\
    534  1.44   thorpej do {									\
    535  1.44   thorpej 	if ((ifa)->ifa_refcnt <= 0)					\
    536  1.44   thorpej 		panic("%s:%d: %p ifa_refcnt <= 0", __FILE__,		\
    537  1.44   thorpej 		    __LINE__, (ifa));					\
    538  1.44   thorpej 	if (--(ifa)->ifa_refcnt == 0)					\
    539  1.44   thorpej 		ifafree(ifa);						\
    540  1.44   thorpej } while (0)
    541  1.44   thorpej #else
    542  1.44   thorpej #define	IFAFREE(ifa)							\
    543  1.44   thorpej do {									\
    544  1.44   thorpej 	if (--(ifa)->ifa_refcnt == 0)					\
    545  1.44   thorpej 		ifafree(ifa);						\
    546  1.44   thorpej } while (0)
    547  1.44   thorpej #endif /* DIAGNOSTIC */
    548  1.44   thorpej #endif /* IFAREF_DEBUG */
    549   1.9   mycroft 
    550  1.19       cgd struct ifnet_head ifnet;
    551  1.37    itojun struct ifnet **ifindex2ifnet;
    552  1.37    itojun #if 0
    553  1.37    itojun struct ifnet loif[];
    554  1.37    itojun #endif
    555  1.37    itojun int if_index;
    556   1.2   mycroft 
    557  1.34   thorpej void	ether_ifattach __P((struct ifnet *, const u_int8_t *));
    558  1.44   thorpej void	ether_ifdetach __P((struct ifnet *));
    559  1.33   thorpej char	*ether_sprintf __P((const u_char *));
    560   1.9   mycroft 
    561   1.9   mycroft void	if_attach __P((struct ifnet *));
    562  1.44   thorpej void	if_deactivate __P((struct ifnet *));
    563  1.44   thorpej void	if_detach __P((struct ifnet *));
    564   1.9   mycroft void	if_down __P((struct ifnet *));
    565   1.9   mycroft void	if_qflush __P((struct ifqueue *));
    566   1.9   mycroft void	if_slowtimo __P((void *));
    567   1.9   mycroft void	if_up __P((struct ifnet *));
    568  1.14       cgd int	ifconf __P((u_long, caddr_t));
    569   1.9   mycroft void	ifinit __P((void));
    570  1.13       cgd int	ifioctl __P((struct socket *, u_long, caddr_t, struct proc *));
    571   1.9   mycroft int	ifpromisc __P((struct ifnet *, int));
    572  1.40   thorpej struct	ifnet *ifunit __P((const char *));
    573  1.37    itojun struct  ifnet *if_withname __P((struct sockaddr *));
    574   1.9   mycroft 
    575   1.9   mycroft struct	ifaddr *ifa_ifwithaddr __P((struct sockaddr *));
    576   1.9   mycroft struct	ifaddr *ifa_ifwithaf __P((int));
    577   1.9   mycroft struct	ifaddr *ifa_ifwithdstaddr __P((struct sockaddr *));
    578   1.9   mycroft struct	ifaddr *ifa_ifwithnet __P((struct sockaddr *));
    579  1.22       mrg struct	ifaddr *ifa_ifwithladdr __P((struct sockaddr *));
    580   1.9   mycroft struct	ifaddr *ifa_ifwithroute __P((int, struct sockaddr *,
    581   1.9   mycroft 					struct sockaddr *));
    582   1.9   mycroft struct	ifaddr *ifaof_ifpforaddr __P((struct sockaddr *, struct ifnet *));
    583   1.9   mycroft void	ifafree __P((struct ifaddr *));
    584   1.9   mycroft void	link_rtrequest __P((int, struct rtentry *, struct sockaddr *));
    585   1.9   mycroft 
    586  1.13       cgd int	loioctl __P((struct ifnet *, u_long, caddr_t));
    587   1.9   mycroft void	loopattach __P((int));
    588   1.9   mycroft int	looutput __P((struct ifnet *,
    589   1.9   mycroft 	   struct mbuf *, struct sockaddr *, struct rtentry *));
    590   1.9   mycroft void	lortrequest __P((int, struct rtentry *, struct sockaddr *));
    591  1.44   thorpej 
    592  1.44   thorpej /*
    593  1.44   thorpej  * These are exported because they're an easy way to tell if
    594  1.44   thorpej  * an interface is going away without having to burn a flag.
    595  1.44   thorpej  */
    596  1.44   thorpej int	if_nulloutput __P((struct ifnet *, struct mbuf *,
    597  1.44   thorpej 	    struct sockaddr *, struct rtentry *));
    598  1.44   thorpej void	if_nullinput __P((struct ifnet *, struct mbuf *));
    599  1.44   thorpej void	if_nullstart __P((struct ifnet *));
    600  1.44   thorpej int	if_nullioctl __P((struct ifnet *, u_long, caddr_t));
    601  1.44   thorpej int	if_nullreset __P((struct ifnet *));
    602  1.44   thorpej void	if_nullwatchdog __P((struct ifnet *));
    603  1.44   thorpej void	if_nulldrain __P((struct ifnet *));
    604  1.37    itojun #else
    605  1.37    itojun struct if_nameindex {
    606  1.37    itojun 	unsigned int	if_index;	/* 1, 2, ... */
    607  1.37    itojun 	char		*if_name;	/* null terminated name: "le0", ... */
    608  1.37    itojun };
    609  1.37    itojun 
    610  1.38    kleink #include <sys/cdefs.h>
    611  1.37    itojun __BEGIN_DECLS
    612  1.37    itojun unsigned int if_nametoindex __P((const char *));
    613  1.38    kleink char *	if_indextoname __P((unsigned int, char *));
    614  1.38    kleink struct	if_nameindex * if_nameindex __P((void));
    615  1.38    kleink void	if_freenameindex __P((struct if_nameindex *));
    616  1.37    itojun __END_DECLS
    617  1.15       jtc #endif /* _KERNEL */
    618  1.28     chuck #endif /* !_NET_IF_H_ */
    619