Home | History | Annotate | Line # | Download | only in net
if.h revision 1.37
      1 /*	$NetBSD: if.h,v 1.37 1999/07/01 08:12:48 itojun Exp $	*/
      2 
      3 /*
      4  * Copyright (c) 1982, 1986, 1989, 1993
      5  *	The Regents of the University of California.  All rights reserved.
      6  *
      7  * Redistribution and use in source and binary forms, with or without
      8  * modification, are permitted provided that the following conditions
      9  * are met:
     10  * 1. Redistributions of source code must retain the above copyright
     11  *    notice, this list of conditions and the following disclaimer.
     12  * 2. Redistributions in binary form must reproduce the above copyright
     13  *    notice, this list of conditions and the following disclaimer in the
     14  *    documentation and/or other materials provided with the distribution.
     15  * 3. All advertising materials mentioning features or use of this software
     16  *    must display the following acknowledgement:
     17  *	This product includes software developed by the University of
     18  *	California, Berkeley and its contributors.
     19  * 4. Neither the name of the University nor the names of its contributors
     20  *    may be used to endorse or promote products derived from this software
     21  *    without specific prior written permission.
     22  *
     23  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
     24  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
     25  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
     26  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
     27  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
     28  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
     29  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
     30  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
     31  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
     32  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
     33  * SUCH DAMAGE.
     34  *
     35  *	@(#)if.h	8.3 (Berkeley) 2/9/95
     36  */
     37 
     38 #ifndef _NET_IF_H_
     39 #define _NET_IF_H_
     40 
     41 #include <sys/queue.h>
     42 
     43 /*
     44  * Structures defining a network interface, providing a packet
     45  * transport mechanism (ala level 0 of the PUP protocols).
     46  *
     47  * Each interface accepts output datagrams of a specified maximum
     48  * length, and provides higher level routines with input datagrams
     49  * received from its medium.
     50  *
     51  * Output occurs when the routine if_output is called, with four parameters:
     52  *	(*ifp->if_output)(ifp, m, dst, rt)
     53  * Here m is the mbuf chain to be sent and dst is the destination address.
     54  * The output routine encapsulates the supplied datagram if necessary,
     55  * and then transmits it on its medium.
     56  *
     57  * On input, each interface unwraps the data received by it, and either
     58  * places it on the input queue of a internetwork datagram routine
     59  * and posts the associated software interrupt, or passes the datagram to a raw
     60  * packet input routine.
     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 /*  XXX fast fix for SNMP, going away soon */
     68 #include <sys/time.h>
     69 
     70 struct mbuf;
     71 struct proc;
     72 struct rtentry;
     73 struct socket;
     74 struct ether_header;
     75 
     76 /*
     77  * Structure defining statistics and other data kept regarding a network
     78  * interface.
     79  */
     80 struct	if_data {
     81 	/* generic interface information */
     82 	u_char	ifi_type;		/* ethernet, tokenring, etc. */
     83 	u_char	ifi_addrlen;		/* media address length */
     84 	u_char	ifi_hdrlen;		/* media header length */
     85 	u_long	ifi_mtu;		/* maximum transmission unit */
     86 	u_long	ifi_metric;		/* routing metric (external only) */
     87 	u_long	ifi_baudrate;		/* linespeed */
     88 	/* volatile statistics */
     89 	u_long	ifi_ipackets;		/* packets received on interface */
     90 	u_long	ifi_ierrors;		/* input errors on interface */
     91 	u_long	ifi_opackets;		/* packets sent on interface */
     92 	u_long	ifi_oerrors;		/* output errors on interface */
     93 	u_long	ifi_collisions;		/* collisions on csma interfaces */
     94 	u_long	ifi_ibytes;		/* total number of octets received */
     95 	u_long	ifi_obytes;		/* total number of octets sent */
     96 	u_long	ifi_imcasts;		/* packets received via multicast */
     97 	u_long	ifi_omcasts;		/* packets sent via multicast */
     98 	u_long	ifi_iqdrops;		/* dropped on input, this interface */
     99 	u_long	ifi_noproto;		/* destined for unsupported protocol */
    100 	struct	timeval ifi_lastchange;	/* last updated */
    101 };
    102 
    103 /*
    104  * Structure defining a queue for a network interface.
    105  *
    106  * (Would like to call this struct ``if'', but C isn't PL/1.)
    107  */
    108 TAILQ_HEAD(ifnet_head, ifnet);		/* the actual queue head */
    109 
    110 /*
    111  * Length of interface external name, including terminating '\0'.
    112  * Note: this is the same size as a generic device's external name.
    113  */
    114 #define	IFNAMSIZ	16
    115 #define	IF_NAMESIZE	IFNAMSIZ
    116 
    117 struct ifnet {				/* and the entries */
    118 	void	*if_softc;		/* lower-level data for this if */
    119 	TAILQ_ENTRY(ifnet) if_list;	/* all struct ifnets are chained */
    120 	TAILQ_HEAD(, ifaddr) if_addrlist; /* linked list of addresses per if */
    121 	char	if_xname[IFNAMSIZ];	/* external name (name + unit) */
    122 	int	if_pcount;		/* number of promiscuous listeners */
    123 	caddr_t	if_bpf;			/* packet filter structure */
    124 	u_short	if_index;		/* numeric abbreviation for this if */
    125 	short	if_timer;		/* time 'til if_watchdog called */
    126 	short	if_flags;		/* up/down, broadcast, etc. */
    127 	short	if__pad1;		/* be nice to m68k ports */
    128 	struct	if_data if_data;	/* statistics and other data about if */
    129 /* procedure handles */
    130 	int	(*if_output)		/* output routine (enqueue) */
    131 		__P((struct ifnet *, struct mbuf *, struct sockaddr *,
    132 		     struct rtentry *));
    133 	void	(*if_input)		/* input routine (from h/w driver) */
    134 		__P((struct ifnet *, struct mbuf *));
    135 	void	(*if_start)		/* initiate output routine */
    136 		__P((struct ifnet *));
    137 	int	(*if_ioctl)		/* ioctl routine */
    138 		__P((struct ifnet *, u_long, caddr_t));
    139 	int	(*if_reset)		/* XXX bus reset routine */
    140 		__P((struct ifnet *));
    141 	void	(*if_watchdog)		/* timer routine */
    142 		__P((struct ifnet *));
    143 	void	(*if_drain)		/* routine to release resources */
    144 		__P((struct ifnet *));
    145 	struct	ifqueue {
    146 		struct	mbuf *ifq_head;
    147 		struct	mbuf *ifq_tail;
    148 		int	ifq_len;
    149 		int	ifq_maxlen;
    150 		int	ifq_drops;
    151 	} if_snd;			/* output queue */
    152 	struct	sockaddr_dl *if_sadl;	/* pointer to our sockaddr_dl */
    153 	u_int8_t *if_broadcastaddr;	/* linklevel broadcast bytestring */
    154 	struct ifprefix *if_prefixlist; /* linked list of prefixes per if */
    155 };
    156 #define	if_mtu		if_data.ifi_mtu
    157 #define	if_type		if_data.ifi_type
    158 #define	if_addrlen	if_data.ifi_addrlen
    159 #define	if_hdrlen	if_data.ifi_hdrlen
    160 #define	if_metric	if_data.ifi_metric
    161 #define	if_baudrate	if_data.ifi_baudrate
    162 #define	if_ipackets	if_data.ifi_ipackets
    163 #define	if_ierrors	if_data.ifi_ierrors
    164 #define	if_opackets	if_data.ifi_opackets
    165 #define	if_oerrors	if_data.ifi_oerrors
    166 #define	if_collisions	if_data.ifi_collisions
    167 #define	if_ibytes	if_data.ifi_ibytes
    168 #define	if_obytes	if_data.ifi_obytes
    169 #define	if_imcasts	if_data.ifi_imcasts
    170 #define	if_omcasts	if_data.ifi_omcasts
    171 #define	if_iqdrops	if_data.ifi_iqdrops
    172 #define	if_noproto	if_data.ifi_noproto
    173 #define	if_lastchange	if_data.ifi_lastchange
    174 
    175 #define	IFF_UP		0x1		/* interface is up */
    176 #define	IFF_BROADCAST	0x2		/* broadcast address valid */
    177 #define	IFF_DEBUG	0x4		/* turn on debugging */
    178 #define	IFF_LOOPBACK	0x8		/* is a loopback net */
    179 #define	IFF_POINTOPOINT	0x10		/* interface is point-to-point link */
    180 #define	IFF_NOTRAILERS	0x20		/* avoid use of trailers */
    181 #define	IFF_RUNNING	0x40		/* resources allocated */
    182 #define	IFF_NOARP	0x80		/* no address resolution protocol */
    183 #define	IFF_PROMISC	0x100		/* receive all packets */
    184 #define	IFF_ALLMULTI	0x200		/* receive all multicast packets */
    185 #define	IFF_OACTIVE	0x400		/* transmission in progress */
    186 #define	IFF_SIMPLEX	0x800		/* can't hear own transmissions */
    187 #define	IFF_LINK0	0x1000		/* per link layer defined bit */
    188 #define	IFF_LINK1	0x2000		/* per link layer defined bit */
    189 #define	IFF_LINK2	0x4000		/* per link layer defined bit */
    190 #define	IFF_MULTICAST	0x8000		/* supports multicast */
    191 
    192 /* flags set internally only: */
    193 #define	IFF_CANTCHANGE \
    194 	(IFF_BROADCAST|IFF_POINTOPOINT|IFF_RUNNING|IFF_OACTIVE|\
    195 	    IFF_SIMPLEX|IFF_MULTICAST|IFF_ALLMULTI)
    196 
    197 /*
    198  * Output queues (ifp->if_snd) and internetwork datagram level (pup level 1)
    199  * input routines have queues of messages stored on ifqueue structures
    200  * (defined above).  Entries are added to and deleted from these structures
    201  * by these macros, which should be called with ipl raised to splimp().
    202  */
    203 #define	IF_QFULL(ifq)		((ifq)->ifq_len >= (ifq)->ifq_maxlen)
    204 #define	IF_DROP(ifq)		((ifq)->ifq_drops++)
    205 #define	IF_ENQUEUE(ifq, m) { \
    206 	(m)->m_nextpkt = 0; \
    207 	if ((ifq)->ifq_tail == 0) \
    208 		(ifq)->ifq_head = m; \
    209 	else \
    210 		(ifq)->ifq_tail->m_nextpkt = m; \
    211 	(ifq)->ifq_tail = m; \
    212 	(ifq)->ifq_len++; \
    213 }
    214 #define	IF_PREPEND(ifq, m) { \
    215 	(m)->m_nextpkt = (ifq)->ifq_head; \
    216 	if ((ifq)->ifq_tail == 0) \
    217 		(ifq)->ifq_tail = (m); \
    218 	(ifq)->ifq_head = (m); \
    219 	(ifq)->ifq_len++; \
    220 }
    221 #define	IF_DEQUEUE(ifq, m) { \
    222 	(m) = (ifq)->ifq_head; \
    223 	if (m) { \
    224 		if (((ifq)->ifq_head = (m)->m_nextpkt) == 0) \
    225 			(ifq)->ifq_tail = 0; \
    226 		(m)->m_nextpkt = 0; \
    227 		(ifq)->ifq_len--; \
    228 	} \
    229 }
    230 
    231 #define	IFQ_MAXLEN	50
    232 #define	IFNET_SLOWHZ	1		/* granularity is 1 second */
    233 
    234 /*
    235  * Structure defining statistics and other data kept regarding an address
    236  * on a network interface.
    237  */
    238 struct ifaddr_data {
    239 	int64_t	ifad_inbytes;
    240 	int64_t	ifad_outbytes;
    241 };
    242 
    243 /*
    244  * The ifaddr structure contains information about one address
    245  * of an interface.  They are maintained by the different address families,
    246  * are allocated and attached when an address is set, and are linked
    247  * together so all addresses for an interface can be located.
    248  */
    249 struct ifaddr {
    250 	struct	sockaddr *ifa_addr;	/* address of interface */
    251 	struct	sockaddr *ifa_dstaddr;	/* other end of p-to-p link */
    252 #define	ifa_broadaddr	ifa_dstaddr	/* broadcast address interface */
    253 	struct	sockaddr *ifa_netmask;	/* used to determine subnet */
    254 	struct	ifnet *ifa_ifp;		/* back-pointer to interface */
    255 	TAILQ_ENTRY(ifaddr) ifa_list;	/* list of addresses for interface */
    256 	struct	ifaddr_data	ifa_data;	/* statistics on the address */
    257 	void	(*ifa_rtrequest)	/* check or clean routes (+ or -)'d */
    258 		    __P((int, struct rtentry *, struct sockaddr *));
    259 	u_short	ifa_flags;		/* mostly rt_flags for cloning */
    260 	short	ifa_refcnt;		/* count of references */
    261 	int	ifa_metric;		/* cost of going out this interface */
    262 };
    263 #define	IFA_ROUTE	RTF_UP		/* route installed */
    264 
    265 /*
    266  * The prefix structure contains information about one prefix
    267  * of an interface.  They are maintained by the different address families,
    268  * are allocated and attached when an prefix or an address is set,
    269  * and are linked together so all prfefixes for an interface can be located.
    270  */
    271 struct ifprefix {
    272 	struct	sockaddr *ifpr_prefix;	/* prefix of interface */
    273 	struct	ifnet *ifpr_ifp;	/* back-pointer to interface */
    274 	struct ifprefix *ifpr_next;
    275 	u_char	ifpr_plen;		/* prefix length in bits */
    276 };
    277 
    278 /*
    279  * Message format for use in obtaining information about interfaces
    280  * from sysctl and the routing socket.
    281  */
    282 struct if_msghdr {
    283 	u_short	ifm_msglen;	/* to skip over non-understood messages */
    284 	u_char	ifm_version;	/* future binary compatability */
    285 	u_char	ifm_type;	/* message type */
    286 	int	ifm_addrs;	/* like rtm_addrs */
    287 	int	ifm_flags;	/* value of if_flags */
    288 	u_short	ifm_index;	/* index for associated ifp */
    289 	struct	if_data ifm_data;/* statistics and other data about if */
    290 };
    291 
    292 /*
    293  * Message format for use in obtaining information about interface addresses
    294  * from sysctl and the routing socket.
    295  */
    296 struct ifa_msghdr {
    297 	u_short	ifam_msglen;	/* to skip over non-understood messages */
    298 	u_char	ifam_version;	/* future binary compatability */
    299 	u_char	ifam_type;	/* message type */
    300 	int	ifam_addrs;	/* like rtm_addrs */
    301 	int	ifam_flags;	/* value of ifa_flags */
    302 	u_short	ifam_index;	/* index for associated ifp */
    303 	int	ifam_metric;	/* value of ifa_metric */
    304 };
    305 
    306 /*
    307  * Interface request structure used for socket
    308  * ioctl's.  All interface ioctl's must have parameter
    309  * definitions which begin with ifr_name.  The
    310  * remainder may be interface specific.
    311  */
    312 struct	ifreq {
    313 	char	ifr_name[IFNAMSIZ];		/* if name, e.g. "en0" */
    314 	union {
    315 		struct	sockaddr ifru_addr;
    316 		struct	sockaddr ifru_dstaddr;
    317 		struct	sockaddr ifru_broadaddr;
    318 		short	ifru_flags;
    319 		int	ifru_metric;
    320 		int	ifru_mtu;
    321 		caddr_t	ifru_data;
    322 	} ifr_ifru;
    323 #define	ifr_addr	ifr_ifru.ifru_addr	/* address */
    324 #define	ifr_dstaddr	ifr_ifru.ifru_dstaddr	/* other end of p-to-p link */
    325 #define	ifr_broadaddr	ifr_ifru.ifru_broadaddr	/* broadcast address */
    326 #define	ifr_flags	ifr_ifru.ifru_flags	/* flags */
    327 #define	ifr_metric	ifr_ifru.ifru_metric	/* metric */
    328 #define	ifr_mtu		ifr_ifru.ifru_mtu	/* mtu */
    329 #define	ifr_media	ifr_ifru.ifru_metric	/* media options (overload) */
    330 #define	ifr_data	ifr_ifru.ifru_data	/* for use by interface */
    331 };
    332 
    333 struct ifaliasreq {
    334 	char	ifra_name[IFNAMSIZ];		/* if name, e.g. "en0" */
    335 	struct	sockaddr ifra_addr;
    336 	struct	sockaddr ifra_dstaddr;
    337 #define	ifra_broadaddr	ifra_dstaddr
    338 	struct	sockaddr ifra_mask;
    339 };
    340 
    341 struct ifmediareq {
    342 	char	ifm_name[IFNAMSIZ];		/* if name, e.g. "en0" */
    343 	int	ifm_current;			/* current media options */
    344 	int	ifm_mask;			/* don't care mask */
    345 	int	ifm_status;			/* media status */
    346 	int	ifm_active;			/* active options */
    347 	int	ifm_count;			/* # entries in ifm_ulist
    348 						   array */
    349 	int	*ifm_ulist;			/* media words */
    350 };
    351 
    352 
    353 struct  ifdrv {
    354 	char		ifd_name[IFNAMSIZ];	/* if name, e.g. "en0" */
    355 	unsigned long	ifd_cmd;
    356 	size_t		ifd_len;
    357 	void		*ifd_data;
    358 };
    359 
    360 /*
    361  * Structure used in SIOCGIFCONF request.
    362  * Used to retrieve interface configuration
    363  * for machine (useful for programs which
    364  * must know all networks accessible).
    365  */
    366 struct	ifconf {
    367 	int	ifc_len;		/* size of associated buffer */
    368 	union {
    369 		caddr_t	ifcu_buf;
    370 		struct	ifreq *ifcu_req;
    371 	} ifc_ifcu;
    372 #define	ifc_buf	ifc_ifcu.ifcu_buf	/* buffer address */
    373 #define	ifc_req	ifc_ifcu.ifcu_req	/* array of structures returned */
    374 };
    375 
    376 /*
    377  * Structure for SIOC[AGD]LIFADDR
    378  */
    379 struct if_laddrreq {
    380 	char iflr_name[IFNAMSIZ];
    381 	unsigned int flags;
    382 #define IFLR_PREFIX	0x8000	/* in: prefix given  out: kernel fills id */
    383 	unsigned int prefixlen;		/* in/out */
    384 	struct sockaddr_storage addr;	/* in/out */
    385 	struct sockaddr_storage dstaddr; /* out */
    386 };
    387 
    388 #include <net/if_arp.h>
    389 
    390 #ifdef _KERNEL
    391 #define	IFAFREE(ifa) \
    392 	if ((ifa)->ifa_refcnt <= 0) \
    393 		ifafree(ifa); \
    394 	else \
    395 		(ifa)->ifa_refcnt--;
    396 
    397 struct ifnet_head ifnet;
    398 struct ifnet **ifindex2ifnet;
    399 #if 0
    400 struct ifnet loif[];
    401 #endif
    402 int if_index;
    403 
    404 void	ether_ifattach __P((struct ifnet *, const u_int8_t *));
    405 char	*ether_sprintf __P((const u_char *));
    406 
    407 void	if_attach __P((struct ifnet *));
    408 void	if_down __P((struct ifnet *));
    409 void	if_qflush __P((struct ifqueue *));
    410 void	if_slowtimo __P((void *));
    411 void	if_up __P((struct ifnet *));
    412 int	ifconf __P((u_long, caddr_t));
    413 void	ifinit __P((void));
    414 int	ifioctl __P((struct socket *, u_long, caddr_t, struct proc *));
    415 int	ifpromisc __P((struct ifnet *, int));
    416 struct	ifnet *ifunit __P((char *));
    417 struct  ifnet *if_withname __P((struct sockaddr *));
    418 
    419 struct	ifaddr *ifa_ifwithaddr __P((struct sockaddr *));
    420 struct	ifaddr *ifa_ifwithaf __P((int));
    421 struct	ifaddr *ifa_ifwithdstaddr __P((struct sockaddr *));
    422 struct	ifaddr *ifa_ifwithnet __P((struct sockaddr *));
    423 struct	ifaddr *ifa_ifwithladdr __P((struct sockaddr *));
    424 struct	ifaddr *ifa_ifwithroute __P((int, struct sockaddr *,
    425 					struct sockaddr *));
    426 struct	ifaddr *ifaof_ifpforaddr __P((struct sockaddr *, struct ifnet *));
    427 void	ifafree __P((struct ifaddr *));
    428 void	link_rtrequest __P((int, struct rtentry *, struct sockaddr *));
    429 
    430 int	loioctl __P((struct ifnet *, u_long, caddr_t));
    431 void	loopattach __P((int));
    432 int	looutput __P((struct ifnet *,
    433 	   struct mbuf *, struct sockaddr *, struct rtentry *));
    434 void	lortrequest __P((int, struct rtentry *, struct sockaddr *));
    435 #else
    436 struct if_nameindex {
    437 	unsigned int	if_index;	/* 1, 2, ... */
    438 	char		*if_name;	/* null terminated name: "le0", ... */
    439 };
    440 
    441 __BEGIN_DECLS
    442 unsigned int if_nametoindex __P((const char *));
    443 char *if_indextoname __P((unsigned int, char *));
    444 struct if_nameindex *if_nameindex __P((void));
    445 void if_freenameindex __P((struct if_nameindex *));
    446 __END_DECLS
    447 #endif /* _KERNEL */
    448 #endif /* !_NET_IF_H_ */
    449