if.h revision 241646
1139823Simp/*-
21541Srgrimes * Copyright (c) 1982, 1986, 1989, 1993
31541Srgrimes *	The Regents of the University of California.  All rights reserved.
41541Srgrimes *
51541Srgrimes * Redistribution and use in source and binary forms, with or without
61541Srgrimes * modification, are permitted provided that the following conditions
71541Srgrimes * are met:
81541Srgrimes * 1. Redistributions of source code must retain the above copyright
91541Srgrimes *    notice, this list of conditions and the following disclaimer.
101541Srgrimes * 2. Redistributions in binary form must reproduce the above copyright
111541Srgrimes *    notice, this list of conditions and the following disclaimer in the
121541Srgrimes *    documentation and/or other materials provided with the distribution.
131541Srgrimes * 4. Neither the name of the University nor the names of its contributors
141541Srgrimes *    may be used to endorse or promote products derived from this software
151541Srgrimes *    without specific prior written permission.
161541Srgrimes *
171541Srgrimes * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
181541Srgrimes * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
191541Srgrimes * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
201541Srgrimes * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
211541Srgrimes * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
221541Srgrimes * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
231541Srgrimes * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
241541Srgrimes * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
251541Srgrimes * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
261541Srgrimes * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
271541Srgrimes * SUCH DAMAGE.
281541Srgrimes *
291541Srgrimes *	@(#)if.h	8.1 (Berkeley) 6/10/93
3050477Speter * $FreeBSD: head/sys/net/if.h 241646 2012-10-17 19:24:13Z emax $
311541Srgrimes */
321541Srgrimes
332168Spaul#ifndef _NET_IF_H_
344507Sbde#define	_NET_IF_H_
352168Spaul
36104355Smike#include <sys/cdefs.h>
37104355Smike
3897024Siedowse#ifdef _KERNEL
3979103Sbrooks#include <sys/queue.h>
4097024Siedowse#endif
4179103Sbrooks
42104355Smike#if __BSD_VISIBLE
431541Srgrimes/*
4434750Speter * <net/if.h> does not depend on <sys/time.h> on most other systems.  This
4572093Sasmodai * helps userland compatibility.  (struct timeval ifi_lastchange)
46226610Sed * The same holds for <sys/socket.h>.  (struct sockaddr ifru_addr)
4734750Speter */
4855205Speter#ifndef _KERNEL
4934750Speter#include <sys/time.h>
50226610Sed#include <sys/socket.h>
5134750Speter#endif
5234750Speter
5379103Sbrooksstruct ifnet;
54104355Smike#endif
5579103Sbrooks
5634750Speter/*
5779103Sbrooks * Length of interface external name, including terminating '\0'.
5879103Sbrooks * Note: this is the same size as a generic device's external name.
5979103Sbrooks */
60104355Smike#define		IF_NAMESIZE	16
61104355Smike#if __BSD_VISIBLE
62104355Smike#define		IFNAMSIZ	IF_NAMESIZE
63121816Sbrooks#define		IF_MAXUNIT	0x7fff	/* historical value */
64104355Smike#endif
65104355Smike#if __BSD_VISIBLE
66104355Smike
6779103Sbrooks/*
6879103Sbrooks * Structure used to query names of interface cloners.
6979103Sbrooks */
7079103Sbrooks
7179103Sbrooksstruct if_clonereq {
7279103Sbrooks	int	ifcr_total;		/* total cloners (out) */
7379103Sbrooks	int	ifcr_count;		/* room for this many in user buffer */
7479103Sbrooks	char	*ifcr_buffer;		/* buffer for cloner names */
7579103Sbrooks};
7679103Sbrooks
7779103Sbrooks/*
7819079Sfenner * Structure describing information about an interface
7919079Sfenner * which may be of interest to management entities.
8019079Sfenner */
819457Sjoergstruct if_data {
829457Sjoerg	/* generic interface information */
839457Sjoerg	u_char	ifi_type;		/* ethernet, tokenring, etc */
849457Sjoerg	u_char	ifi_physical;		/* e.g., AUI, Thinnet, 10base-T, etc */
859457Sjoerg	u_char	ifi_addrlen;		/* media address length */
869457Sjoerg	u_char	ifi_hdrlen;		/* media header length */
87128871Sandre	u_char	ifi_link_state;		/* current link state */
88228571Sglebius	u_char	ifi_vhid;		/* carp vhid */
89241616Semax	u_char	ifi_baudrate_pf;	/* baudrate power factor */
90134609Sbrooks	u_char	ifi_datalen;		/* length of this data struct */
919457Sjoerg	u_long	ifi_mtu;		/* maximum transmission unit */
929457Sjoerg	u_long	ifi_metric;		/* routing metric (external only) */
939457Sjoerg	u_long	ifi_baudrate;		/* linespeed */
949457Sjoerg	/* volatile statistics */
959457Sjoerg	u_long	ifi_ipackets;		/* packets received on interface */
969457Sjoerg	u_long	ifi_ierrors;		/* input errors on interface */
979457Sjoerg	u_long	ifi_opackets;		/* packets sent on interface */
989457Sjoerg	u_long	ifi_oerrors;		/* output errors on interface */
999457Sjoerg	u_long	ifi_collisions;		/* collisions on csma interfaces */
1009457Sjoerg	u_long	ifi_ibytes;		/* total number of octets received */
1019457Sjoerg	u_long	ifi_obytes;		/* total number of octets sent */
1029457Sjoerg	u_long	ifi_imcasts;		/* packets received via multicast */
1039457Sjoerg	u_long	ifi_omcasts;		/* packets sent via multicast */
1049457Sjoerg	u_long	ifi_iqdrops;		/* dropped on input, this interface */
1059457Sjoerg	u_long	ifi_noproto;		/* destined for unsupported protocol */
106162070Sandre	u_long	ifi_hwassist;		/* HW offload capabilities, see IFCAP */
107142501Sbrooks	time_t	ifi_epoch;		/* uptime at attach or stat reset */
10816287Sgpalmer	struct	timeval ifi_lastchange;	/* time of last administrative change */
1099457Sjoerg};
1109457Sjoerg
111148894Srwatson/*-
112148886Srwatson * Interface flags are of two types: network stack owned flags, and driver
113148886Srwatson * owned flags.  Historically, these values were stored in the same ifnet
114148886Srwatson * flags field, but with the advent of fine-grained locking, they have been
115148886Srwatson * broken out such that the network stack is responsible for synchronizing
116148886Srwatson * the stack-owned fields, and the device driver the device-owned fields.
117148886Srwatson * Both halves can perform lockless reads of the other half's field, subject
118148886Srwatson * to accepting the involved races.
119148886Srwatson *
120148886Srwatson * Both sets of flags come from the same number space, and should not be
121148886Srwatson * permitted to conflict, as they are exposed to user space via a single
122148886Srwatson * field.
123148886Srwatson *
124148894Srwatson * The following symbols identify read and write requirements for fields:
125148894Srwatson *
126148894Srwatson * (i) if_flags field set by device driver before attach, read-only there
127148894Srwatson *     after.
128148894Srwatson * (n) if_flags field written only by the network stack, read by either the
129148894Srwatson *     stack or driver.
130148894Srwatson * (d) if_drv_flags field written only by the device driver, read by either
131148894Srwatson *     the stack or driver.
132148886Srwatson */
133148894Srwatson#define	IFF_UP		0x1		/* (n) interface is up */
134148894Srwatson#define	IFF_BROADCAST	0x2		/* (i) broadcast address valid */
135148894Srwatson#define	IFF_DEBUG	0x4		/* (n) turn on debugging */
136148894Srwatson#define	IFF_LOOPBACK	0x8		/* (i) is a loopback net */
137148894Srwatson#define	IFF_POINTOPOINT	0x10		/* (i) is a point-to-point link */
138148894Srwatson#define	IFF_SMART	0x20		/* (i) interface manages own routes */
139148894Srwatson#define	IFF_DRV_RUNNING	0x40		/* (d) resources allocated */
140148894Srwatson#define	IFF_NOARP	0x80		/* (n) no address resolution protocol */
141148894Srwatson#define	IFF_PROMISC	0x100		/* (n) receive all packets */
142148894Srwatson#define	IFF_ALLMULTI	0x200		/* (n) receive all multicast packets */
143148894Srwatson#define	IFF_DRV_OACTIVE	0x400		/* (d) tx hardware queue is full */
144148894Srwatson#define	IFF_SIMPLEX	0x800		/* (i) can't hear own transmissions */
1451541Srgrimes#define	IFF_LINK0	0x1000		/* per link layer defined bit */
1461541Srgrimes#define	IFF_LINK1	0x2000		/* per link layer defined bit */
1471541Srgrimes#define	IFF_LINK2	0x4000		/* per link layer defined bit */
1483274Swollman#define	IFF_ALTPHYS	IFF_LINK2	/* use alternate physical connection */
149148894Srwatson#define	IFF_MULTICAST	0x8000		/* (i) supports multicast */
150216267Sweongyo#define	IFF_CANTCONFIG	0x10000		/* (i) unconfigurable using ioctl(2) */
151148894Srwatson#define	IFF_PPROMISC	0x20000		/* (n) user-requested promisc mode */
152148894Srwatson#define	IFF_MONITOR	0x40000		/* (n) user-requested monitor mode */
153148894Srwatson#define	IFF_STATICARP	0x80000		/* (n) static ARP */
154191416Srwatson#define	IFF_DYING	0x200000	/* (n) interface is winding down */
155201196Sjhb#define	IFF_RENAMING	0x400000	/* (n) interface is being renamed */
156148886Srwatson/*
157148886Srwatson * Old names for driver flags so that user space tools can continue to use
158148894Srwatson * the old (portable) names.
159148886Srwatson */
160148886Srwatson#ifndef _KERNEL
161148886Srwatson#define	IFF_RUNNING	IFF_DRV_RUNNING
162148886Srwatson#define	IFF_OACTIVE	IFF_DRV_OACTIVE
163148886Srwatson#endif
164148886Srwatson
1651541Srgrimes/* flags set internally only: */
1661541Srgrimes#define	IFF_CANTCHANGE \
167148886Srwatson	(IFF_BROADCAST|IFF_POINTOPOINT|IFF_DRV_RUNNING|IFF_DRV_OACTIVE|\
168191416Srwatson	    IFF_SIMPLEX|IFF_MULTICAST|IFF_ALLMULTI|IFF_SMART|IFF_PROMISC|\
169216268Sweongyo	    IFF_DYING|IFF_CANTCONFIG)
1701541Srgrimes
171106925Ssam/*
172128871Sandre * Values for if_link_state.
173128871Sandre */
174128871Sandre#define	LINK_STATE_UNKNOWN	0	/* link invalid/unknown */
175128871Sandre#define	LINK_STATE_DOWN		1	/* link is down */
176128871Sandre#define	LINK_STATE_UP		2	/* link is up */
177128871Sandre
178128871Sandre/*
179106925Ssam * Some convenience macros used for setting ifi_baudrate.
180106925Ssam * XXX 1000 vs. 1024? --thorpej@netbsd.org
181106925Ssam */
182241646Semax#define	IF_Kbps(x)	((uintmax_t)(x) * 1000)	/* kilobits/sec. */
183106925Ssam#define	IF_Mbps(x)	(IF_Kbps((x) * 1000))	/* megabits/sec. */
184106925Ssam#define	IF_Gbps(x)	(IF_Mbps((x) * 1000))	/* gigabits/sec. */
185106925Ssam
186162070Sandre/*
187162070Sandre * Capabilities that interfaces can advertise.
188162070Sandre *
189162070Sandre * struct ifnet.if_capabilities
190162070Sandre *   contains the optional features & capabilities a particular interface
191162070Sandre *   supports (not only the driver but also the detected hw revision).
192162070Sandre *   Capabilities are defined by IFCAP_* below.
193169207Syar * struct ifnet.if_capenable
194162070Sandre *   contains the enabled (either by default or through ifconfig) optional
195162070Sandre *   features & capabilities on this interface.
196162070Sandre *   Capabilities are defined by IFCAP_* below.
197162070Sandre * struct if_data.ifi_hwassist in mbuf CSUM_ flag form, controlled by above
198162070Sandre *   contains the enabled optional feature & capabilites that can be used
199162070Sandre *   individually per packet and are specified in the mbuf pkthdr.csum_flags
200162070Sandre *   field.  IFCAP_* and CSUM_* do not match one to one and CSUM_* may be
201169207Syar *   more detailed or differenciated than IFCAP_*.
202162070Sandre *   Hwassist features are defined CSUM_* in sys/mbuf.h
203223078Sluigi *
204223078Sluigi * Capabilities that cannot be arbitrarily changed with ifconfig/ioctl
205223078Sluigi * are listed in IFCAP_CANTCHANGE, similar to IFF_CANTCHANGE.
206223078Sluigi * This is not strictly necessary because the common code never
207223078Sluigi * changes capabilities, and it is left to the individual driver
208223078Sluigi * to do the right thing. However, having the filter here
209223078Sluigi * avoids replication of the same code in all individual drivers.
210162070Sandre */
211182413Sjfv#define	IFCAP_RXCSUM		0x00001  /* can offload checksum on RX */
212182413Sjfv#define	IFCAP_TXCSUM		0x00002  /* can offload checksum on TX */
213182413Sjfv#define	IFCAP_NETCONS		0x00004  /* can be a network console */
214182413Sjfv#define	IFCAP_VLAN_MTU		0x00008	/* VLAN-compatible MTU */
215182413Sjfv#define	IFCAP_VLAN_HWTAGGING	0x00010	/* hardware VLAN tag support */
216182413Sjfv#define	IFCAP_JUMBO_MTU		0x00020	/* 9000 byte MTU supported */
217182413Sjfv#define	IFCAP_POLLING		0x00040	/* driver supports polling */
218182413Sjfv#define	IFCAP_VLAN_HWCSUM	0x00080	/* can do IFCAP_HWCSUM on VLANs */
219182413Sjfv#define	IFCAP_TSO4		0x00100	/* can do TCP Segmentation Offload */
220182413Sjfv#define	IFCAP_TSO6		0x00200	/* can do TCP6 Segmentation Offload */
221182413Sjfv#define	IFCAP_LRO		0x00400	/* can do Large Receive Offload */
222182413Sjfv#define	IFCAP_WOL_UCAST		0x00800	/* wake on any unicast frame */
223182413Sjfv#define	IFCAP_WOL_MCAST		0x01000	/* wake on any multicast frame */
224182413Sjfv#define	IFCAP_WOL_MAGIC		0x02000	/* wake on any Magic Packet */
225182413Sjfv#define	IFCAP_TOE4		0x04000	/* interface can offload TCP */
226182413Sjfv#define	IFCAP_TOE6		0x08000	/* interface can offload TCP6 */
227182413Sjfv#define	IFCAP_VLAN_HWFILTER	0x10000 /* interface hw can filter vlan tag */
228193096Sattilio#define	IFCAP_POLLING_NOCOUNT	0x20000 /* polling ticks cannot be fragmented */
229204149Syongari#define	IFCAP_VLAN_HWTSO	0x40000 /* can do IFCAP_TSO on VLANs */
230205222Sqingli#define	IFCAP_LINKSTATE		0x80000 /* the runtime link state is dynamic */
231223078Sluigi#define	IFCAP_NETMAP		0x100000 /* netmap mode supported/enabled */
232236170Sbz#define	IFCAP_RXCSUM_IPV6	0x200000  /* can offload checksum on IPv6 RX */
233236170Sbz#define	IFCAP_TXCSUM_IPV6	0x400000  /* can offload checksum on IPv6 TX */
23483624Sjlemon
235236170Sbz#define IFCAP_HWCSUM_IPV6	(IFCAP_RXCSUM_IPV6 | IFCAP_TXCSUM_IPV6)
236236170Sbz
237174505Ssam#define IFCAP_HWCSUM	(IFCAP_RXCSUM | IFCAP_TXCSUM)
238174505Ssam#define	IFCAP_TSO	(IFCAP_TSO4 | IFCAP_TSO6)
239174505Ssam#define	IFCAP_WOL	(IFCAP_WOL_UCAST | IFCAP_WOL_MCAST | IFCAP_WOL_MAGIC)
240174628Skmacy#define	IFCAP_TOE	(IFCAP_TOE4 | IFCAP_TOE6)
24183636Sjlemon
242223078Sluigi#define	IFCAP_CANTCHANGE	(IFCAP_NETMAP)
243223078Sluigi
2441541Srgrimes#define	IFQ_MAXLEN	50
2451541Srgrimes#define	IFNET_SLOWHZ	1		/* granularity is 1 second */
2461541Srgrimes
2471541Srgrimes/*
2481541Srgrimes * Message format for use in obtaining information about interfaces
2491541Srgrimes * from getkerninfo and the routing socket
250231505Sbz * For the new, extensible interface see struct if_msghdrl below.
2511541Srgrimes */
2521541Srgrimesstruct if_msghdr {
2531541Srgrimes	u_short	ifm_msglen;	/* to skip over non-understood messages */
25472093Sasmodai	u_char	ifm_version;	/* future binary compatibility */
2551541Srgrimes	u_char	ifm_type;	/* message type */
2561541Srgrimes	int	ifm_addrs;	/* like rtm_addrs */
2571541Srgrimes	int	ifm_flags;	/* value of if_flags */
2581541Srgrimes	u_short	ifm_index;	/* index for associated ifp */
2591541Srgrimes	struct	if_data ifm_data;/* statistics and other data about if */
2601541Srgrimes};
2611541Srgrimes
2621541Srgrimes/*
263231505Sbz * The 'l' version shall be used by new interfaces, like NET_RT_IFLISTL.  It is
264231505Sbz * extensible after ifm_data_off or within ifm_data.  Both the if_msghdr and
265231505Sbz * if_data now have a member field detailing the struct length in addition to
266231505Sbz * the routing message length.  Macros are provided to find the start of
267231505Sbz * ifm_data and the start of the socket address strucutres immediately following
268231505Sbz * struct if_msghdrl given a pointer to struct if_msghdrl.
269231505Sbz */
270231505Sbz#define	IF_MSGHDRL_IFM_DATA(_l) \
271231505Sbz    (struct if_data *)((char *)(_l) + (_l)->ifm_data_off)
272231505Sbz#define	IF_MSGHDRL_RTA(_l) \
273231505Sbz    (void *)((uintptr_t)(_l) + (_l)->ifm_len)
274231505Sbzstruct if_msghdrl {
275231505Sbz	u_short	ifm_msglen;	/* to skip over non-understood messages */
276231505Sbz	u_char	ifm_version;	/* future binary compatibility */
277231505Sbz	u_char	ifm_type;	/* message type */
278231505Sbz	int	ifm_addrs;	/* like rtm_addrs */
279231505Sbz	int	ifm_flags;	/* value of if_flags */
280231505Sbz	u_short	ifm_index;	/* index for associated ifp */
281231505Sbz	u_short _ifm_spare1;	/* spare space to grow if_index, see if_var.h */
282231505Sbz	u_short	ifm_len;	/* length of if_msghdrl incl. if_data */
283231505Sbz	u_short	ifm_data_off;	/* offset of if_data from beginning */
284231505Sbz	struct	if_data ifm_data;/* statistics and other data about if */
285231505Sbz};
286231505Sbz
287231505Sbz/*
2881541Srgrimes * Message format for use in obtaining information about interface addresses
2891541Srgrimes * from getkerninfo and the routing socket
290231505Sbz * For the new, extensible interface see struct ifa_msghdrl below.
2911541Srgrimes */
2921541Srgrimesstruct ifa_msghdr {
2931541Srgrimes	u_short	ifam_msglen;	/* to skip over non-understood messages */
29472093Sasmodai	u_char	ifam_version;	/* future binary compatibility */
2951541Srgrimes	u_char	ifam_type;	/* message type */
2961541Srgrimes	int	ifam_addrs;	/* like rtm_addrs */
2971541Srgrimes	int	ifam_flags;	/* value of ifa_flags */
2981541Srgrimes	u_short	ifam_index;	/* index for associated ifp */
2991541Srgrimes	int	ifam_metric;	/* value of ifa_metric */
3001541Srgrimes};
3011541Srgrimes
3021541Srgrimes/*
303231505Sbz * The 'l' version shall be used by new interfaces, like NET_RT_IFLISTL.  It is
304231505Sbz * extensible after ifam_metric or within ifam_data.  Both the ifa_msghdrl and
305231505Sbz * if_data now have a member field detailing the struct length in addition to
306231505Sbz * the routing message length.  Macros are provided to find the start of
307231505Sbz * ifm_data and the start of the socket address strucutres immediately following
308231505Sbz * struct ifa_msghdrl given a pointer to struct ifa_msghdrl.
309231505Sbz */
310231505Sbz#define	IFA_MSGHDRL_IFAM_DATA(_l) \
311231505Sbz    (struct if_data *)((char *)(_l) + (_l)->ifam_data_off)
312231505Sbz#define	IFA_MSGHDRL_RTA(_l) \
313231505Sbz    (void *)((uintptr_t)(_l) + (_l)->ifam_len)
314231505Sbzstruct ifa_msghdrl {
315231505Sbz	u_short	ifam_msglen;	/* to skip over non-understood messages */
316231505Sbz	u_char	ifam_version;	/* future binary compatibility */
317231505Sbz	u_char	ifam_type;	/* message type */
318231505Sbz	int	ifam_addrs;	/* like rtm_addrs */
319231505Sbz	int	ifam_flags;	/* value of ifa_flags */
320231505Sbz	u_short	ifam_index;	/* index for associated ifp */
321231505Sbz	u_short _ifam_spare1;	/* spare space to grow if_index, see if_var.h */
322231505Sbz	u_short	ifam_len;	/* length of ifa_msghdrl incl. if_data */
323231505Sbz	u_short	ifam_data_off;	/* offset of if_data from beginning */
324231505Sbz	int	ifam_metric;	/* value of ifa_metric */
325231505Sbz	struct	if_data ifam_data;/* statistics and other data about if or
326231505Sbz				 * address */
327231505Sbz};
328231505Sbz
329231505Sbz/*
33021666Swollman * Message format for use in obtaining information about multicast addresses
33121666Swollman * from the routing socket
33221666Swollman */
33321666Swollmanstruct ifma_msghdr {
33421666Swollman	u_short	ifmam_msglen;	/* to skip over non-understood messages */
33572093Sasmodai	u_char	ifmam_version;	/* future binary compatibility */
33621666Swollman	u_char	ifmam_type;	/* message type */
33721666Swollman	int	ifmam_addrs;	/* like rtm_addrs */
33821666Swollman	int	ifmam_flags;	/* value of ifa_flags */
33921666Swollman	u_short	ifmam_index;	/* index for associated ifp */
34021666Swollman};
34121666Swollman
34221666Swollman/*
34389498Sru * Message format announcing the arrival or departure of a network interface.
34489498Sru */
34589498Srustruct if_announcemsghdr {
34689498Sru	u_short	ifan_msglen;	/* to skip over non-understood messages */
34789498Sru	u_char	ifan_version;	/* future binary compatibility */
34889498Sru	u_char	ifan_type;	/* message type */
34989498Sru	u_short	ifan_index;	/* index for associated ifp */
35089498Sru	char	ifan_name[IFNAMSIZ]; /* if name, e.g. "en0" */
35189498Sru	u_short	ifan_what;	/* what type of announcement */
35289498Sru};
35389498Sru
35489498Sru#define	IFAN_ARRIVAL	0	/* interface arrival */
35589498Sru#define	IFAN_DEPARTURE	1	/* interface departure */
35689498Sru
35789498Sru/*
358203052Sdelphij * Buffer with length to be used in SIOCGIFDESCR/SIOCSIFDESCR requests
359203052Sdelphij */
360203052Sdelphijstruct ifreq_buffer {
361203052Sdelphij	size_t	length;
362203052Sdelphij	void	*buffer;
363203052Sdelphij};
364203052Sdelphij
365203052Sdelphij/*
3661541Srgrimes * Interface request structure used for socket
3671541Srgrimes * ioctl's.  All interface ioctl's must have parameter
3681541Srgrimes * definitions which begin with ifr_name.  The
3691541Srgrimes * remainder may be interface specific.
3701541Srgrimes */
3711541Srgrimesstruct	ifreq {
3721541Srgrimes	char	ifr_name[IFNAMSIZ];		/* if name, e.g. "en0" */
3731541Srgrimes	union {
3741541Srgrimes		struct	sockaddr ifru_addr;
3751541Srgrimes		struct	sockaddr ifru_dstaddr;
3761541Srgrimes		struct	sockaddr ifru_broadaddr;
377203052Sdelphij		struct	ifreq_buffer ifru_buffer;
37844144Sphk		short	ifru_flags[2];
37985079Sjlemon		short	ifru_index;
380194251Sjamie		int	ifru_jid;
3811541Srgrimes		int	ifru_metric;
3821941Sdg		int	ifru_mtu;
3835184Swollman		int	ifru_phys;
38425434Speter		int	ifru_media;
3851541Srgrimes		caddr_t	ifru_data;
38683624Sjlemon		int	ifru_cap[2];
387223735Sbz		u_int	ifru_fib;
3881541Srgrimes	} ifr_ifru;
3891541Srgrimes#define	ifr_addr	ifr_ifru.ifru_addr	/* address */
3901541Srgrimes#define	ifr_dstaddr	ifr_ifru.ifru_dstaddr	/* other end of p-to-p link */
3911541Srgrimes#define	ifr_broadaddr	ifr_ifru.ifru_broadaddr	/* broadcast address */
392203052Sdelphij#define	ifr_buffer	ifr_ifru.ifru_buffer	/* user supplied buffer with its length */
393102052Ssobomax#define	ifr_flags	ifr_ifru.ifru_flags[0]	/* flags (low 16 bits) */
394102052Ssobomax#define	ifr_flagshigh	ifr_ifru.ifru_flags[1]	/* flags (high 16 bits) */
395194251Sjamie#define	ifr_jid		ifr_ifru.ifru_jid	/* jail/vnet */
3961541Srgrimes#define	ifr_metric	ifr_ifru.ifru_metric	/* metric */
3971941Sdg#define	ifr_mtu		ifr_ifru.ifru_mtu	/* mtu */
3985187Sdg#define ifr_phys	ifr_ifru.ifru_phys	/* physical wire */
39925434Speter#define ifr_media	ifr_ifru.ifru_media	/* physical media */
4001541Srgrimes#define	ifr_data	ifr_ifru.ifru_data	/* for use by interface */
40183624Sjlemon#define	ifr_reqcap	ifr_ifru.ifru_cap[0]	/* requested capabilities */
40283624Sjlemon#define	ifr_curcap	ifr_ifru.ifru_cap[1]	/* current capabilities */
40385079Sjlemon#define	ifr_index	ifr_ifru.ifru_index	/* interface index */
404223735Sbz#define	ifr_fib		ifr_ifru.ifru_fib	/* interface fib */
4051541Srgrimes};
4061541Srgrimes
40732491Swollman#define	_SIZEOF_ADDR_IFREQ(ifr) \
40832491Swollman	((ifr).ifr_addr.sa_len > sizeof(struct sockaddr) ? \
40932491Swollman	 (sizeof(struct ifreq) - sizeof(struct sockaddr) + \
41032491Swollman	  (ifr).ifr_addr.sa_len) : sizeof(struct ifreq))
41132491Swollman
4121541Srgrimesstruct ifaliasreq {
4131541Srgrimes	char	ifra_name[IFNAMSIZ];		/* if name, e.g. "en0" */
4141541Srgrimes	struct	sockaddr ifra_addr;
4151541Srgrimes	struct	sockaddr ifra_broadaddr;
4161541Srgrimes	struct	sockaddr ifra_mask;
417228571Sglebius	int	ifra_vhid;
4181541Srgrimes};
4191541Srgrimes
420228768Sglebius/* Compat with pre-10.x */
421228768Sglebiusstruct oifaliasreq {
422228768Sglebius	char	ifra_name[IFNAMSIZ];
423228768Sglebius	struct	sockaddr ifra_addr;
424228768Sglebius	struct	sockaddr ifra_broadaddr;
425228768Sglebius	struct	sockaddr ifra_mask;
426228768Sglebius};
427228768Sglebius
42825434Speterstruct ifmediareq {
42925434Speter	char	ifm_name[IFNAMSIZ];	/* if name, e.g. "en0" */
43025434Speter	int	ifm_current;		/* current media options */
43125434Speter	int	ifm_mask;		/* don't care mask */
43225434Speter	int	ifm_status;		/* media status */
43325434Speter	int	ifm_active;		/* active options */
43425434Speter	int	ifm_count;		/* # entries in ifm_ulist array */
43525434Speter	int	*ifm_ulist;		/* media words */
43625434Speter};
43748021Sphk
438146986Sthompsastruct  ifdrv {
439146986Sthompsa	char            ifd_name[IFNAMSIZ];     /* if name, e.g. "en0" */
440146986Sthompsa	unsigned long   ifd_cmd;
441146986Sthompsa	size_t          ifd_len;
442146986Sthompsa	void            *ifd_data;
443146986Sthompsa};
444146986Sthompsa
44548021Sphk/*
44648021Sphk * Structure used to retrieve aux status data from interfaces.
44748589Sbde * Kernel suppliers to this interface should respect the formatting
44848021Sphk * needed by ifconfig(8): each line starts with a TAB and ends with
44948589Sbde * a newline.  The canonical example to copy and paste is in if_tun.c.
45048021Sphk */
45148021Sphk
45248589Sbde#define	IFSTATMAX	800		/* 10 lines of text */
45348021Sphkstruct ifstat {
45448589Sbde	char	ifs_name[IFNAMSIZ];	/* if name, e.g. "en0" */
45548589Sbde	char	ascii[IFSTATMAX + 1];
45648021Sphk};
45748021Sphk
4581541Srgrimes/*
4591541Srgrimes * Structure used in SIOCGIFCONF request.
4601541Srgrimes * Used to retrieve interface configuration
4611541Srgrimes * for machine (useful for programs which
4621541Srgrimes * must know all networks accessible).
4631541Srgrimes */
4641541Srgrimesstruct	ifconf {
4651541Srgrimes	int	ifc_len;		/* size of associated buffer */
4661541Srgrimes	union {
4671541Srgrimes		caddr_t	ifcu_buf;
4681541Srgrimes		struct	ifreq *ifcu_req;
4691541Srgrimes	} ifc_ifcu;
4701541Srgrimes#define	ifc_buf	ifc_ifcu.ifcu_buf	/* buffer address */
4711541Srgrimes#define	ifc_req	ifc_ifcu.ifcu_req	/* array of structures returned */
4721541Srgrimes};
4731541Srgrimes
47452904Sshin/*
475159781Smlaier * interface groups
476159781Smlaier */
477159781Smlaier
478159781Smlaier#define	IFG_ALL		"all"		/* group contains all interfaces */
479159781Smlaier/* XXX: will we implement this? */
480159781Smlaier#define	IFG_EGRESS	"egress"	/* if(s) default route(s) point to */
481159781Smlaier
482159781Smlaierstruct ifg_req {
483159781Smlaier	union {
484159781Smlaier		char			 ifgrqu_group[IFNAMSIZ];
485159781Smlaier		char			 ifgrqu_member[IFNAMSIZ];
486159781Smlaier	} ifgrq_ifgrqu;
487159781Smlaier#define	ifgrq_group	ifgrq_ifgrqu.ifgrqu_group
488159781Smlaier#define	ifgrq_member	ifgrq_ifgrqu.ifgrqu_member
489159781Smlaier};
490159781Smlaier
491159781Smlaier/*
492159781Smlaier * Used to lookup groups for an interface
493159781Smlaier */
494159781Smlaierstruct ifgroupreq {
495159781Smlaier	char	ifgr_name[IFNAMSIZ];
496159781Smlaier	u_int	ifgr_len;
497159781Smlaier	union {
498159781Smlaier		char	ifgru_group[IFNAMSIZ];
499159781Smlaier		struct	ifg_req *ifgru_groups;
500159781Smlaier	} ifgr_ifgru;
501159781Smlaier#define ifgr_group	ifgr_ifgru.ifgru_group
502159781Smlaier#define ifgr_groups	ifgr_ifgru.ifgru_groups
503159781Smlaier};
504159781Smlaier
505159781Smlaier/*
50652904Sshin * Structure for SIOC[AGD]LIFADDR
50752904Sshin */
50852904Sshinstruct if_laddrreq {
50952904Sshin	char	iflr_name[IFNAMSIZ];
51052904Sshin	u_int	flags;
51152904Sshin#define	IFLR_PREFIX	0x8000  /* in: prefix given  out: kernel fills id */
51252904Sshin	u_int	prefixlen;         /* in/out */
51352904Sshin	struct	sockaddr_storage addr;   /* in/out */
51452904Sshin	struct	sockaddr_storage dstaddr; /* out */
51552904Sshin};
51652904Sshin
517104355Smike#endif /* __BSD_VISIBLE */
518104355Smike
51955205Speter#ifdef _KERNEL
52030354Sphk#ifdef MALLOC_DECLARE
52130354SphkMALLOC_DECLARE(M_IFADDR);
52230354SphkMALLOC_DECLARE(M_IFMADDR);
52330354Sphk#endif
52430354Sphk#endif
52530354Sphk
52655205Speter#ifndef _KERNEL
52752904Sshinstruct if_nameindex {
528104355Smike	unsigned int	if_index;	/* 1, 2, ... */
529104360Smike	char		*if_name;	/* null terminated name: "le0", ... */
53052904Sshin};
53152904Sshin
53252904Sshin__BEGIN_DECLS
533104360Smikevoid			 if_freenameindex(struct if_nameindex *);
534104360Smikechar			*if_indextoname(unsigned int, char *);
535104360Smikestruct if_nameindex	*if_nameindex(void);
536104360Smikeunsigned int		 if_nametoindex(const char *);
53752904Sshin__END_DECLS
53852904Sshin#endif
53952904Sshin
54055205Speter#ifdef _KERNEL
54148589Sbde/* XXX - this should go away soon. */
54221259Swollman#include <net/if_var.h>
5431541Srgrimes#endif
5441541Srgrimes
5454507Sbde#endif /* !_NET_IF_H_ */
546