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  *	@(#)if.h	8.1 (Berkeley) 6/10/93
34  * $FreeBSD: src/sys/net/if.h,v 1.49.2.1 1999/08/29 16:28:15 peter Exp $
35  */
36 
37 #ifndef _NET_IF_H_
38 #define	_NET_IF_H_
39 
40 /*
41  * <net/if.h> does not depend on <sys/time.h> on most other systems.  This
42  * helps userland compatability.  (struct timeval ifi_lastchange)
43  */
44 #ifndef KERNEL
45 #include <pcap-stdinc.h>
46 #endif
47 
48 /*
49  * Structure describing information about an interface
50  * which may be of interest to management entities.
51  */
52 struct if_data {
53 	/* generic interface information */
54 	u_char	ifi_type;		/* ethernet, tokenring, etc */
55 	u_char	ifi_physical;		/* e.g., AUI, Thinnet, 10base-T, etc */
56 	u_char	ifi_addrlen;		/* media address length */
57 	u_char	ifi_hdrlen;		/* media header length */
58 	u_char	ifi_recvquota;		/* polling quota for receive intrs */
59 	u_char	ifi_xmitquota;		/* polling quota for xmit intrs */
60 	u_long	ifi_mtu;		/* maximum transmission unit */
61 	u_long	ifi_metric;		/* routing metric (external only) */
62 	u_long	ifi_baudrate;		/* linespeed */
63 	/* volatile statistics */
64 	u_long	ifi_ipackets;		/* packets received on interface */
65 	u_long	ifi_ierrors;		/* input errors on interface */
66 	u_long	ifi_opackets;		/* packets sent on interface */
67 	u_long	ifi_oerrors;		/* output errors on interface */
68 	u_long	ifi_collisions;		/* collisions on csma interfaces */
69 	u_long	ifi_ibytes;		/* total number of octets received */
70 	u_long	ifi_obytes;		/* total number of octets sent */
71 	u_long	ifi_imcasts;		/* packets received via multicast */
72 	u_long	ifi_omcasts;		/* packets sent via multicast */
73 	u_long	ifi_iqdrops;		/* dropped on input, this interface */
74 	u_long	ifi_noproto;		/* destined for unsupported protocol */
75 	u_long	ifi_recvtiming;		/* usec spent receiving when timing */
76 	u_long	ifi_xmittiming;		/* usec spent xmitting when timing */
77 	struct	timeval ifi_lastchange;	/* time of last administrative change */
78 };
79 
80 /* ws2tcpip.h has interface flags: IFF_* */
81 #if 0
82 #define	IFF_UP		0x1		/* interface is up */
83 #define	IFF_BROADCAST	0x2		/* broadcast address valid */
84 #define	IFF_DEBUG	0x4		/* turn on debugging */
85 #define	IFF_LOOPBACK	0x8		/* is a loopback net */
86 #define	IFF_POINTOPOINT	0x10		/* interface is point-to-point link */
87 /*#define IFF_NOTRAILERS 0x20		 * obsolete: avoid use of trailers */
88 #define	IFF_RUNNING	0x40		/* resources allocated */
89 #define	IFF_NOARP	0x80		/* no address resolution protocol */
90 #define	IFF_PROMISC	0x100		/* receive all packets */
91 #define	IFF_ALLMULTI	0x200		/* receive all multicast packets */
92 #define	IFF_OACTIVE	0x400		/* transmission in progress */
93 #define	IFF_SIMPLEX	0x800		/* can't hear own transmissions */
94 #define	IFF_LINK0	0x1000		/* per link layer defined bit */
95 #define	IFF_LINK1	0x2000		/* per link layer defined bit */
96 #define	IFF_LINK2	0x4000		/* per link layer defined bit */
97 #define	IFF_ALTPHYS	IFF_LINK2	/* use alternate physical connection */
98 #define	IFF_MULTICAST	0x8000		/* supports multicast */
99 #endif /* 0 */
100 
101 /* flags set internally only: */
102 #define	IFF_CANTCHANGE \
103 	(IFF_BROADCAST|IFF_POINTOPOINT|IFF_RUNNING|IFF_OACTIVE|\
104 	    IFF_SIMPLEX|IFF_MULTICAST|IFF_ALLMULTI)
105 
106 #define	IFQ_MAXLEN	50
107 #define	IFNET_SLOWHZ	1		/* granularity is 1 second */
108 
109 /*
110  * Message format for use in obtaining information about interfaces
111  * from getkerninfo and the routing socket
112  */
113 struct if_msghdr {
114 	u_short	ifm_msglen;	/* to skip over non-understood messages */
115 	u_char	ifm_version;	/* future binary compatability */
116 	u_char	ifm_type;	/* message type */
117 	int	ifm_addrs;	/* like rtm_addrs */
118 	int	ifm_flags;	/* value of if_flags */
119 	u_short	ifm_index;	/* index for associated ifp */
120 	struct	if_data ifm_data;/* statistics and other data about if */
121 };
122 
123 /*
124  * Message format for use in obtaining information about interface addresses
125  * from getkerninfo and the routing socket
126  */
127 struct ifa_msghdr {
128 	u_short	ifam_msglen;	/* to skip over non-understood messages */
129 	u_char	ifam_version;	/* future binary compatability */
130 	u_char	ifam_type;	/* message type */
131 	int	ifam_addrs;	/* like rtm_addrs */
132 	int	ifam_flags;	/* value of ifa_flags */
133 	u_short	ifam_index;	/* index for associated ifp */
134 	int	ifam_metric;	/* value of ifa_metric */
135 };
136 
137 /*
138  * Message format for use in obtaining information about multicast addresses
139  * from the routing socket
140  */
141 struct ifma_msghdr {
142 	u_short	ifmam_msglen;	/* to skip over non-understood messages */
143 	u_char	ifmam_version;	/* future binary compatability */
144 	u_char	ifmam_type;	/* message type */
145 	int	ifmam_addrs;	/* like rtm_addrs */
146 	int	ifmam_flags;	/* value of ifa_flags */
147 	u_short	ifmam_index;	/* index for associated ifp */
148 };
149 
150 /*
151  * Interface request structure used for socket
152  * ioctl's.  All interface ioctl's must have parameter
153  * definitions which begin with ifr_name.  The
154  * remainder may be interface specific.
155  */
156 struct	ifreq {
157 #define	IFNAMSIZ	16
158 	char	ifr_name[IFNAMSIZ];		/* if name, e.g. "en0" */
159 	union {
160 		struct	sockaddr ifru_addr;
161 		struct	sockaddr ifru_dstaddr;
162 		struct	sockaddr ifru_broadaddr;
163 		short	ifru_flags;
164 		int	ifru_metric;
165 		int	ifru_mtu;
166 		int	ifru_phys;
167 		int	ifru_media;
168 		caddr_t	ifru_data;
169 	} ifr_ifru;
170 #define	ifr_addr	ifr_ifru.ifru_addr	/* address */
171 #define	ifr_dstaddr	ifr_ifru.ifru_dstaddr	/* other end of p-to-p link */
172 #define	ifr_broadaddr	ifr_ifru.ifru_broadaddr	/* broadcast address */
173 #define	ifr_flags	ifr_ifru.ifru_flags	/* flags */
174 #define	ifr_metric	ifr_ifru.ifru_metric	/* metric */
175 #define	ifr_mtu		ifr_ifru.ifru_mtu	/* mtu */
176 #define ifr_phys	ifr_ifru.ifru_phys	/* physical wire */
177 #define ifr_media	ifr_ifru.ifru_media	/* physical media */
178 #define	ifr_data	ifr_ifru.ifru_data	/* for use by interface */
179 };
180 
181 #define	_SIZEOF_ADDR_IFREQ(ifr) \
182 	((ifr).ifr_addr.sa_len > sizeof(struct sockaddr) ? \
183 	 (sizeof(struct ifreq) - sizeof(struct sockaddr) + \
184 	  (ifr).ifr_addr.sa_len) : sizeof(struct ifreq))
185 
186 struct ifaliasreq {
187 	char	ifra_name[IFNAMSIZ];		/* if name, e.g. "en0" */
188 	struct	sockaddr ifra_addr;
189 	struct	sockaddr ifra_broadaddr;
190 	struct	sockaddr ifra_mask;
191 };
192 
193 struct ifmediareq {
194 	char	ifm_name[IFNAMSIZ];	/* if name, e.g. "en0" */
195 	int	ifm_current;		/* current media options */
196 	int	ifm_mask;		/* don't care mask */
197 	int	ifm_status;		/* media status */
198 	int	ifm_active;		/* active options */
199 	int	ifm_count;		/* # entries in ifm_ulist array */
200 	int	*ifm_ulist;		/* media words */
201 };
202 /*
203  * Structure used in SIOCGIFCONF request.
204  * Used to retrieve interface configuration
205  * for machine (useful for programs which
206  * must know all networks accessible).
207  */
208 struct	ifconf {
209 	int	ifc_len;		/* size of associated buffer */
210 	union {
211 		caddr_t	ifcu_buf;
212 		struct	ifreq *ifcu_req;
213 	} ifc_ifcu;
214 #define	ifc_buf	ifc_ifcu.ifcu_buf	/* buffer address */
215 #define	ifc_req	ifc_ifcu.ifcu_req	/* array of structures returned */
216 };
217 
218 #ifdef KERNEL
219 #ifdef MALLOC_DECLARE
220 MALLOC_DECLARE(M_IFADDR);
221 MALLOC_DECLARE(M_IFMADDR);
222 #endif
223 #endif
224 
225 /* XXX - this should go away soon */
226 #ifdef KERNEL
227 #include <net/if_var.h>
228 #endif
229 
230 #endif /* !_NET_IF_H_ */
231