xref: /illumos-gate/usr/src/uts/common/net/if.h (revision c9fd6b31f4fa1345ad799549dc0f1101b9cef127)
1 /*
2  * Copyright 2010 Sun Microsystems, Inc.  All rights reserved.
3  * Use is subject to license terms.
4  */
5 
6 /*
7  * Copyright (c) 1982, 1986 Regents of the University of California.
8  * All rights reserved.  The Berkeley software License Agreement
9  * specifies the terms and conditions for redistribution.
10  */
11 
12 #ifndef	_NET_IF_H
13 #define	_NET_IF_H
14 
15 /* if.h 1.26 90/05/29 SMI; from UCB 7.1 6/4/86		*/
16 
17 #include <sys/feature_tests.h>
18 
19 #if !defined(_XOPEN_SOURCE) || defined(__EXTENSIONS__)
20 #include <sys/socket.h>
21 #include <netinet/in.h>
22 #if defined(_LP64)
23 #include <sys/types32.h>
24 #endif
25 #endif
26 
27 #ifdef	__cplusplus
28 extern "C" {
29 #endif
30 
31 /*
32  * Structures defining a network interface, providing a packet
33  * transport mechanism (ala level 0 of the PUP protocols).
34  *
35  * Each interface accepts output datagrams of a specified maximum
36  * length, and provides higher level routines with input datagrams
37  * received from its medium.
38  *
39  * Output occurs when the routine if_output is called, with three parameters:
40  *	(*ifp->if_output)(ifp, m, dst)
41  * Here m is the mbuf chain to be sent and dst is the destination address.
42  * The output routine encapsulates the supplied datagram if necessary,
43  * and then transmits it on its medium.
44  *
45  * On input, each interface unwraps the data received by it, and either
46  * places it on the input queue of a internetwork datagram routine
47  * and posts the associated software interrupt, or passes the datagram to a raw
48  * packet input routine.
49  *
50  * Routines exist for locating interfaces by their addresses
51  * or for locating a interface on a certain network, as well as more general
52  * routing and gateway routines maintaining information used to locate
53  * interfaces.  These routines live in the files if.c and route.c
54  */
55 
56 #if !defined(_XOPEN_SOURCE) || defined(__EXTENSIONS__)
57 
58 /*
59  * Structure defining a queue for a network interface.
60  *
61  * (Would like to call this struct ``if'', but C isn't PL/1.)
62  */
63 struct ifnet {
64 	char	*if_name;		/* name, e.g. ``en'' or ``lo'' */
65 	short	if_unit;		/* sub-unit for lower level driver */
66 	short	if_mtu;			/* maximum transmission unit */
67 	short	if_flags;		/* up/down, broadcast, etc. */
68 	short	if_timer;		/* time 'til if_watchdog called */
69 	ushort_t if_promisc;		/* net # of requests for promisc mode */
70 	int	if_metric;		/* routing metric (external only) */
71 	struct	ifaddr *if_addrlist;	/* linked list of addresses per if */
72 	struct	ifqueue {
73 		struct	mbuf *ifq_head;
74 		struct	mbuf *ifq_tail;
75 		int	ifq_len;
76 		int	ifq_maxlen;
77 		int	ifq_drops;
78 	} if_snd;			/* output queue */
79 /* procedure handles */
80 	int	(*if_init)();		/* init routine */
81 	int	(*if_output)();		/* output routine */
82 	int	(*if_ioctl)();		/* ioctl routine */
83 	int	(*if_reset)();		/* bus reset routine */
84 	int	(*if_watchdog)();	/* timer routine */
85 /* generic interface statistics */
86 	int	if_ipackets;		/* packets received on interface */
87 	int	if_ierrors;		/* input errors on interface */
88 	int	if_opackets;		/* packets sent on interface */
89 	int	if_oerrors;		/* output errors on interface */
90 	int	if_collisions;		/* collisions on csma interfaces */
91 /* end statistics */
92 	struct	ifnet *if_next;
93 	struct	ifnet *if_upper;	/* next layer up */
94 	struct	ifnet *if_lower;	/* next layer down */
95 	int	(*if_input)();		/* input routine */
96 	int	(*if_ctlin)();		/* control input routine */
97 	int	(*if_ctlout)();		/* control output routine */
98 	struct map *if_memmap;		/* rmap for interface specific memory */
99 };
100 
101 /*
102  * NOTE : These flags are not directly used within IP.
103  * ip_if.h has definitions derived from this which is used within IP.
104  * If you define a flag here, you need to define one in ip_if.h before
105  * using the new flag in IP. Don't use these flags directly in IP.
106  */
107 #define	IFF_UP		0x0000000001	/* address is up */
108 #define	IFF_BROADCAST	0x0000000002	/* broadcast address valid */
109 #define	IFF_DEBUG	0x0000000004	/* turn on debugging */
110 #define	IFF_LOOPBACK	0x0000000008	/* is a loopback net */
111 
112 #define	IFF_POINTOPOINT	0x0000000010	/* interface is point-to-point link */
113 #define	IFF_NOTRAILERS	0x0000000020	/* avoid use of trailers */
114 #define	IFF_RUNNING	0x0000000040	/* resources allocated */
115 #define	IFF_NOARP	0x0000000080	/* no address resolution protocol */
116 
117 #define	IFF_PROMISC	0x0000000100	/* receive all packets */
118 #define	IFF_ALLMULTI	0x0000000200	/* receive all multicast packets */
119 #define	IFF_INTELLIGENT	0x0000000400	/* protocol code on board */
120 /*
121  * The IFF_MULTICAST flag indicates that the network can support the
122  * transmission and reception of higher-level (e.g., IP) multicast packets.
123  * It is independent of hardware support for multicasting; for example,
124  * point-to-point links or pure broadcast networks may well support
125  * higher-level multicasts.
126  */
127 #define	IFF_MULTICAST	0x0000000800	/* supports multicast */
128 
129 #define	IFF_MULTI_BCAST	0x0000001000	/* multicast using broadcast address */
130 #define	IFF_UNNUMBERED	0x0000002000	/* non-unique address */
131 #define	IFF_DHCPRUNNING	0x0000004000	/* DHCP controls this interface */
132 #define	IFF_PRIVATE	0x0000008000	/* do not advertise */
133 
134 /*
135  * The following flags can't be grabbed or altered by SIOC[GS]IFFLAGS.
136  * Should use SIOC[GS]LIFFLAGS which has a larger flags field.
137  */
138 #define	IFF_NOXMIT	0x0000010000	/* Do not transmit packets */
139 #define	IFF_NOLOCAL	0x0000020000	/* No address - just on-link subnet */
140 #define	IFF_DEPRECATED	0x0000040000	/* Address is deprecated */
141 #define	IFF_ADDRCONF	0x0000080000	/* address from stateless addrconf */
142 
143 #define	IFF_ROUTER	0x0000100000	/* router on this interface */
144 #define	IFF_NONUD	0x0000200000	/* No NUD on this interface */
145 #define	IFF_ANYCAST	0x0000400000	/* Anycast address */
146 #define	IFF_NORTEXCH	0x0000800000	/* Do not exchange routing info */
147 
148 #define	IFF_IPV4	0x0001000000	/* IPv4 interface */
149 #define	IFF_IPV6	0x0002000000	/* IPv6 interface */
150 #define	IFF_NOACCEPT	0x0004000000	/* no-accept mode VRRP ill */
151 #define	IFF_NOFAILOVER	0x0008000000	/* in.mpathd(1M) test address */
152 
153 #define	IFF_FAILED	0x0010000000	/* Interface has failed */
154 #define	IFF_STANDBY	0x0020000000	/* Interface is a hot-spare */
155 #define	IFF_INACTIVE	0x0040000000	/* Functioning but not used for data */
156 #define	IFF_OFFLINE	0x0080000000	/* Interface is offline */
157 
158 /*
159  * The IFF_XRESOLV flag is an evolving interface and is subject
160  * to change without notice.
161  */
162 #define	IFF_XRESOLV	0x0100000000ll	/* IPv6 external resolver */
163 #define	IFF_COS_ENABLED	0x0200000000ll	/* If interface supports CoS marking */
164 #define	IFF_PREFERRED	0x0400000000ll	/* Prefer as source address */
165 #define	IFF_TEMPORARY	0x0800000000ll	/* RFC3041 */
166 
167 #define	IFF_FIXEDMTU	0x1000000000ll	/* MTU manually set with SIOCSLIFMTU */
168 #define	IFF_VIRTUAL	0x2000000000ll	/* Does not send or receive packets */
169 #define	IFF_DUPLICATE	0x4000000000ll	/* Local address already in use */
170 #define	IFF_IPMP	0x8000000000ll	/* IPMP IP interface */
171 #define	IFF_VRRP	0x10000000000ll	/* Managed by VRRP */
172 
173 #define	IFF_NOLINKLOCAL	0x20000000000ll	/* No default linklocal */
174 
175 /* flags that cannot be changed by userland on any interface */
176 #define	IFF_CANTCHANGE \
177 	(IFF_BROADCAST | IFF_POINTOPOINT | IFF_RUNNING | IFF_PROMISC | \
178 	IFF_MULTICAST | IFF_MULTI_BCAST | IFF_UNNUMBERED | IFF_IPV4 | \
179 	IFF_IPV6 | IFF_IPMP | IFF_FIXEDMTU | IFF_VIRTUAL | \
180 	IFF_LOOPBACK | IFF_ALLMULTI | IFF_DUPLICATE | IFF_COS_ENABLED | \
181 	IFF_VRRP | IFF_NOLINKLOCAL)
182 
183 /* flags that cannot be changed by userland on an IPMP interface */
184 #define	IFF_IPMP_CANTCHANGE 	IFF_FAILED
185 
186 /* flags that can never be set on an IPMP interface */
187 #define	IFF_IPMP_INVALID	(IFF_STANDBY | IFF_INACTIVE | IFF_OFFLINE | \
188 	IFF_NOFAILOVER | IFF_NOARP | IFF_NONUD | IFF_XRESOLV | IFF_NOACCEPT)
189 
190 /*
191  * Output queues (ifp->if_snd) and internetwork datagram level (pup level 1)
192  * input routines have queues of messages stored on ifqueue structures
193  * (defined above).  Entries are added to and deleted from these structures
194  * by these macros, which should be called with ipl raised to splimp().
195  */
196 #define	IF_QFULL(ifq)		((ifq)->ifq_len >= (ifq)->ifq_maxlen)
197 #define	IF_DROP(ifq)		((ifq)->ifq_drops++)
198 #define	IF_ENQUEUE(ifq, m) { \
199 	(m)->m_act = 0; \
200 	if ((ifq)->ifq_tail == 0) \
201 		(ifq)->ifq_head = m; \
202 	else \
203 		(ifq)->ifq_tail->m_act = m; \
204 	(ifq)->ifq_tail = m; \
205 	(ifq)->ifq_len++; \
206 }
207 #define	IF_PREPEND(ifq, m) { \
208 	(m)->m_act = (ifq)->ifq_head; \
209 	if ((ifq)->ifq_tail == 0) \
210 		(ifq)->ifq_tail = (m); \
211 	(ifq)->ifq_head = (m); \
212 	(ifq)->ifq_len++; \
213 }
214 
215 /*
216  * Packets destined for level-1 protocol input routines
217  * have a pointer to the receiving interface prepended to the data.
218  * IF_DEQUEUEIF extracts and returns this pointer when dequeuing the packet.
219  * IF_ADJ should be used otherwise to adjust for its presence.
220  */
221 #define	IF_ADJ(m) { \
222 	(m)->m_off += sizeof (struct ifnet *); \
223 	(m)->m_len -= sizeof (struct ifnet *); \
224 	if ((m)->m_len == 0) { \
225 		struct mbuf *n; \
226 		MFREE((m), n); \
227 		(m) = n; \
228 	} \
229 }
230 #define	IF_DEQUEUEIF(ifq, m, ifp) { \
231 	(m) = (ifq)->ifq_head; \
232 	if (m) { \
233 		if (((ifq)->ifq_head = (m)->m_act) == 0) \
234 			(ifq)->ifq_tail = 0; \
235 		(m)->m_act = 0; \
236 		(ifq)->ifq_len--; \
237 		(ifp) = *(mtod((m), struct ifnet **)); \
238 		IF_ADJ(m); \
239 	} \
240 }
241 #define	IF_DEQUEUE(ifq, m) { \
242 	(m) = (ifq)->ifq_head; \
243 	if (m) { \
244 		if (((ifq)->ifq_head = (m)->m_act) == 0) \
245 			(ifq)->ifq_tail = 0; \
246 		(m)->m_act = 0; \
247 		(ifq)->ifq_len--; \
248 	} \
249 }
250 
251 #define	IFQ_MAXLEN	50
252 #define	IFNET_SLOWHZ	1		/* granularity is 1 second */
253 
254 /*
255  * The ifaddr structure contains information about one address
256  * of an interface.  They are maintained by the different address families,
257  * are allocated and attached when an address is set, and are linked
258  * together so all addresses for an interface can be located.
259  */
260 struct ifaddr {
261 	struct	sockaddr ifa_addr;	/* address of interface */
262 	union {
263 		struct	sockaddr ifu_broadaddr;
264 		struct	sockaddr ifu_dstaddr;
265 	} ifa_ifu;
266 #define	ifa_broadaddr	ifa_ifu.ifu_broadaddr	/* broadcast address */
267 #define	ifa_dstaddr	ifa_ifu.ifu_dstaddr	/* other end of p-to-p link */
268 	struct	ifnet *ifa_ifp;		/* back-pointer to interface */
269 	struct	ifaddr *ifa_next;	/* next address for interface */
270 };
271 
272 /*
273  * For SIOCLIF*ND ioctls.
274  *
275  * The lnr_state_* fields use the ND_* neighbor reachability states.
276  * The 3 different fields are for use with SIOCLIFSETND to cover the cases
277  * when
278  *	A new entry is created
279  *	The entry already exists and the link-layer address is the same
280  *	The entry already exists and the link-layer address differs
281  *
282  * Use ND_UNCHANGED and ND_ISROUTER_UNCHANGED to not change any state.
283  */
284 #define	ND_MAX_HDW_LEN	64
285 typedef struct lif_nd_req {
286 	struct sockaddr_storage	lnr_addr;
287 	uint8_t			lnr_state_create;	/* When creating */
288 	uint8_t			lnr_state_same_lla;	/* Update same addr */
289 	uint8_t			lnr_state_diff_lla;	/* Update w/ diff. */
290 	int			lnr_hdw_len;
291 	int			lnr_flags;		/* See below */
292 	/* padding because ia32 "long long"s are only 4-byte aligned. */
293 	int			lnr_pad0;
294 	char			lnr_hdw_addr[ND_MAX_HDW_LEN];
295 } lif_nd_req_t;
296 
297 /*
298  * Neighbor reachability states
299  * Used with SIOCLIF*ND ioctls.
300  */
301 #define	ND_UNCHANGED	0	/* For ioctls that don't modify state */
302 #define	ND_INCOMPLETE	1	/* addr resolution in progress */
303 #define	ND_REACHABLE	2	/* have recently been reachable */
304 #define	ND_STALE	3	/* may be unreachable, don't do anything */
305 #define	ND_DELAY	4	/* wait for upper layer hint */
306 #define	ND_PROBE	5	/* send probes */
307 #define	ND_UNREACHABLE	6	/* delete this route */
308 #define	ND_INITIAL	7	/* ipv4: arp resolution has not been sent yet */
309 
310 #define	ND_STATE_VALID_MIN	0
311 #define	ND_STATE_VALID_MAX	7
312 
313 /*
314  * lnr_flags value of lif_nd_req.
315  * Used with SIOCLIF*ND ioctls.
316  */
317 #define	NDF_ISROUTER_ON		0x1
318 #define	NDF_ISROUTER_OFF	0x2
319 #define	NDF_ANYCAST_ON		0x4
320 #define	NDF_ANYCAST_OFF		0x8
321 #define	NDF_PROXY_ON		0x10
322 #define	NDF_PROXY_OFF		0x20
323 
324 /* For SIOC[GS]LIFLNKINFO */
325 typedef struct lif_ifinfo_req {
326 	uint8_t		lir_maxhops;
327 	uint32_t	lir_reachtime;		/* Reachable time in msec */
328 	uint32_t	lir_reachretrans;	/* Retransmission timer msec */
329 	uint32_t	lir_maxmtu;
330 } lif_ifinfo_req_t;
331 
332 #endif /* !defined(_XOPEN_SOURCE) || defined(__EXTENSIONS__) */
333 
334 /*
335  * Maximum lengths of interface name and IPMP group name; these are the same
336  * for historical reasons.  Note that the actual maximum length of a name is
337  * one byte less than these constants since the kernel always sets the final
338  * byte of lifr_name and lifr_groupname to NUL.
339  */
340 #define	_LIFNAMSIZ	32
341 
342 #if !defined(_XOPEN_SOURCE) || defined(__EXTENSIONS__)
343 
344 #define	LIFNAMSIZ	_LIFNAMSIZ
345 #define	LIFGRNAMSIZ	LIFNAMSIZ
346 
347 /*
348  * Interface request structure used for socket
349  * ioctl's.  All interface ioctl's must have parameter
350  * definitions which begin with ifr_name.  The
351  * remainder may be interface specific.
352  * Note: This data structure uses 64bit type uint64_t which is not
353  *	 a valid type for strict ANSI/ISO C compilation for ILP32.
354  *	 Applications with ioctls using this structure that insist on
355  *	 building with strict ANSI/ISO C (-Xc) will need to be LP64.
356  */
357 #if defined(_INT64_TYPE)
358 struct	lifreq {
359 	char	lifr_name[LIFNAMSIZ];		/* if name, e.g. "en0" */
360 	union {
361 		int	lifru_addrlen;		/* for subnet/token etc */
362 		uint_t	lifru_ppa;		/* SIOCSLIFNAME */
363 	} lifr_lifru1;
364 #define	lifr_addrlen	lifr_lifru1.lifru_addrlen
365 #define	lifr_ppa	lifr_lifru1.lifru_ppa	/* Driver's ppa */
366 	uint_t		lifr_type;		/* IFT_ETHER, ... */
367 	union {
368 		struct	sockaddr_storage lifru_addr;
369 		struct	sockaddr_storage lifru_dstaddr;
370 		struct	sockaddr_storage lifru_broadaddr;
371 		struct	sockaddr_storage lifru_token;	/* With lifr_addrlen */
372 		struct	sockaddr_storage lifru_subnet;	/* With lifr_addrlen */
373 		int	lifru_index;		/* interface index */
374 		uint64_t lifru_flags;		/* Flags for SIOC?LIFFLAGS */
375 		int	lifru_metric;
376 		uint_t	lifru_mtu;
377 		int	lif_muxid[2];		/* mux id's for arp and ip */
378 		struct lif_nd_req	lifru_nd_req;
379 		struct lif_ifinfo_req	lifru_ifinfo_req;
380 		char	lifru_groupname[LIFGRNAMSIZ]; /* SIOC[GS]LIFGROUPNAME */
381 		char	lifru_binding[LIFNAMSIZ]; /* SIOCGLIFBINDING */
382 		zoneid_t lifru_zoneid;		/* SIOC[GS]LIFZONE */
383 		uint_t	lifru_dadstate;		/* SIOCGLIFDADSTATE */
384 	} lifr_lifru;
385 
386 #define	lifr_addr	lifr_lifru.lifru_addr	/* address */
387 #define	lifr_dstaddr	lifr_lifru.lifru_dstaddr /* other end of p-to-p link */
388 #define	lifr_broadaddr	lifr_lifru.lifru_broadaddr /* broadcast address */
389 #define	lifr_token	lifr_lifru.lifru_token	/* address token */
390 #define	lifr_subnet	lifr_lifru.lifru_subnet	/* subnet prefix */
391 #define	lifr_index	lifr_lifru.lifru_index	/* interface index */
392 #define	lifr_flags	lifr_lifru.lifru_flags	/* flags */
393 #define	lifr_metric	lifr_lifru.lifru_metric	/* metric */
394 #define	lifr_mtu	lifr_lifru.lifru_mtu	/* mtu */
395 #define	lifr_ip_muxid	lifr_lifru.lif_muxid[0]
396 #define	lifr_arp_muxid	lifr_lifru.lif_muxid[1]
397 #define	lifr_nd		lifr_lifru.lifru_nd_req	/* SIOCLIF*ND */
398 #define	lifr_ifinfo	lifr_lifru.lifru_ifinfo_req /* SIOC[GS]LIFLNKINFO */
399 #define	lifr_groupname	lifr_lifru.lifru_groupname
400 #define	lifr_binding	lifr_lifru.lifru_binding
401 #define	lifr_zoneid	lifr_lifru.lifru_zoneid
402 #define	lifr_dadstate	lifr_lifru.lifru_dadstate
403 };
404 #endif /* defined(_INT64_TYPE) */
405 
406 /*
407  * Argument structure for SIOCT* address testing ioctls.
408  */
409 struct sioc_addrreq {
410 	struct sockaddr_storage	sa_addr;	/* Address to test */
411 	int			sa_res;		/* Result - 0/1 */
412 	int			sa_pad;
413 };
414 
415 /*
416  * Argument structure used by mrouted to get src-grp pkt counts using
417  * SIOCGETLSGCNT. See <netinet/ip_mroute.h>.
418  */
419 struct sioc_lsg_req {
420 	struct sockaddr_storage	slr_src;
421 	struct sockaddr_storage	slr_grp;
422 	uint_t			slr_pktcnt;
423 	uint_t			slr_bytecnt;
424 	uint_t			slr_wrong_if;
425 	uint_t			slr_pad;
426 };
427 
428 /* Argument structure for SIOCGLIFDADSTATE ioctl */
429 typedef enum {
430 	DAD_IN_PROGRESS	= 0x1,
431 	DAD_DONE	= 0x2
432 } glif_dad_state_t;
433 
434 /*
435  * OBSOLETE: Replaced by struct lifreq. Supported for compatibility.
436  *
437  * Interface request structure used for socket
438  * ioctl's.  All interface ioctl's must have parameter
439  * definitions which begin with ifr_name.  The
440  * remainder may be interface specific.
441  */
442 struct	ifreq {
443 #define	IFNAMSIZ	16
444 	char	ifr_name[IFNAMSIZ];		/* if name, e.g. "en0" */
445 	union {
446 		struct	sockaddr ifru_addr;
447 		struct	sockaddr ifru_dstaddr;
448 		char	ifru_oname[IFNAMSIZ];	/* other if name */
449 		struct	sockaddr ifru_broadaddr;
450 		int	ifru_index;		/* interface index */
451 		uint_t	ifru_mtu;
452 		short	ifru_flags;
453 		int	ifru_metric;
454 		char	ifru_data[1];		/* interface dependent data */
455 		char	ifru_enaddr[6];
456 		int	if_muxid[2];		/* mux id's for arp and ip */
457 
458 		/* Struct for flags/ppa */
459 		struct ifr_ppaflags {
460 			short ifrup_flags;	/* Space of ifru_flags. */
461 			short ifrup_filler;
462 			uint_t ifrup_ppa;
463 		} ifru_ppaflags;
464 
465 		/* Struct for FDDI ioctl's */
466 		struct ifr_dnld_reqs {
467 			uint32_t	v_addr;
468 			uint32_t	m_addr;
469 			uint32_t	ex_addr;
470 			uint32_t	size;
471 		} ifru_dnld_req;
472 
473 		/* Struct for FDDI stats */
474 		struct ifr_fddi_stats {
475 			uint32_t stat_size;
476 			uint32_t fddi_stats;
477 		} ifru_fddi_stat;
478 
479 		struct ifr_netmapents {
480 			uint32_t map_ent_size,	/* size of netmap structure */
481 				entry_number;	/* index into netmap list */
482 			uint32_t fddi_map_ent;	/* pointer to user structure */
483 		} ifru_netmapent;
484 
485 		/* Field for generic ioctl for fddi */
486 
487 		struct ifr_fddi_gen_struct {
488 			uint32_t ifru_fddi_gioctl; /* field for gen ioctl */
489 			uint32_t ifru_fddi_gaddr;  /* Generic ptr to a field */
490 		} ifru_fddi_gstruct;
491 
492 	} ifr_ifru;
493 
494 #define	ifr_addr	ifr_ifru.ifru_addr	/* address */
495 #define	ifr_dstaddr	ifr_ifru.ifru_dstaddr	/* other end of p-to-p link */
496 #define	ifr_oname	ifr_ifru.ifru_oname	/* other if name */
497 #define	ifr_broadaddr	ifr_ifru.ifru_broadaddr	/* broadcast address */
498 #define	ifr_flags	ifr_ifru.ifru_flags	/* flags */
499 #define	ifr_metric	ifr_ifru.ifru_metric	/* metric */
500 #define	ifr_data	ifr_ifru.ifru_data	/* for use by interface */
501 #define	ifr_enaddr	ifr_ifru.ifru_enaddr	/* ethernet address */
502 #define	ifr_index	ifr_ifru.ifru_index	/* interface index */
503 #define	ifr_mtu		ifr_ifru.ifru_mtu	/* mtu */
504 /* For setting ppa */
505 #define	ifr_ppa		ifr_ifru.ifru_ppaflags.ifrup_ppa
506 
507 /* FDDI specific */
508 #define	ifr_dnld_req	ifr_ifru.ifru_dnld_req
509 #define	ifr_fddi_stat	ifr_ifru.ifru_fddi_stat
510 #define	ifr_fddi_netmap	ifr_ifru.ifru_netmapent	/* FDDI network map entries */
511 #define	ifr_fddi_gstruct ifr_ifru.ifru_fddi_gstruct
512 
513 #define	ifr_ip_muxid	ifr_ifru.if_muxid[0]
514 #define	ifr_arp_muxid	ifr_ifru.if_muxid[1]
515 };
516 
517 /* Used by SIOCGLIFNUM. Uses same flags as in struct lifconf */
518 struct lifnum {
519 	sa_family_t	lifn_family;
520 	int		lifn_flags;	/* request specific interfaces */
521 	int		lifn_count;	/* Result */
522 };
523 
524 /*
525  * Structure used in SIOCGLIFCONF request.
526  * Used to retrieve interface configuration
527  * for machine (useful for programs which
528  * must know all networks accessible) for a given address family.
529  * Using AF_UNSPEC will retrieve all address families.
530  */
531 struct	lifconf {
532 	sa_family_t	lifc_family;
533 	int		lifc_flags;	/* request specific interfaces */
534 	int		lifc_len;	/* size of associated buffer */
535 	union {
536 		caddr_t	lifcu_buf;
537 		struct	lifreq *lifcu_req;
538 	} lifc_lifcu;
539 #define	lifc_buf lifc_lifcu.lifcu_buf	/* buffer address */
540 #define	lifc_req lifc_lifcu.lifcu_req	/* array of structures returned */
541 };
542 
543 /*
544  * Structure used in SIOCGLIFSRCOF to get the interface
545  * configuration list for those interfaces that use an address
546  * hosted on the interface (set in lifs_ifindex), as the source
547  * address.
548  */
549 struct lifsrcof {
550 	uint_t	lifs_ifindex;	/* interface of interest */
551 	size_t  lifs_maxlen;	/* size of buffer: input */
552 	size_t  lifs_len;	/* size of buffer: output */
553 	union {
554 		caddr_t	lifsu_buf;
555 		struct	lifreq *lifsu_req;
556 	} lifs_lifsu;
557 #define	lifs_buf lifs_lifsu.lifsu_buf /* buffer address */
558 #define	lifs_req lifs_lifsu.lifsu_req /* array returned */
559 };
560 
561 /* Flags */
562 #define	LIFC_NOXMIT	0x01		/* Include IFF_NOXMIT interfaces */
563 #define	LIFC_EXTERNAL_SOURCE	0x02	/* Exclude the interfaces which can't */
564 					/* be used to communicate outside the */
565 					/* node (exclude interfaces which are */
566 					/* IFF_NOXMIT, IFF_NOLOCAL, */
567 					/* IFF_LOOPBACK, IFF_DEPRECATED, or */
568 					/* not IFF_UP). Has priority over */
569 					/* LIFC_NOXMIT. */
570 #define	LIFC_TEMPORARY	0x04		/* Include IFF_TEMPORARY interfaces */
571 #define	LIFC_ALLZONES	0x08		/* Include all zones */
572 					/* (must be issued from global zone) */
573 #define	LIFC_UNDER_IPMP	0x10		/* Include underlying IPMP interfaces */
574 #define	LIFC_ENABLED	0x20		/* Include only IFF_UP interfaces */
575 
576 #if defined(_SYSCALL32)
577 
578 struct	lifconf32 {
579 	sa_family_t	lifc_family;
580 	int		lifc_flags;	/* request specific interfaces */
581 	int32_t	lifc_len;		/* size of associated buffer */
582 	union {
583 		caddr32_t lifcu_buf;
584 		caddr32_t lifcu_req;
585 	} lifc_lifcu;
586 };
587 
588 struct lifsrcof32 {
589 	uint_t	lifs_ifindex;	/* interface of interest */
590 	size32_t  lifs_maxlen;	/* size of buffer: input */
591 	size32_t  lifs_len;	/* size of buffer: output */
592 	union {
593 		caddr32_t lifsu_buf;
594 		caddr32_t lifsu_req;
595 	} lifs_lifsu;
596 };
597 
598 #endif	/* _SYSCALL32 */
599 
600 /*
601  * IPMP group information, for use with SIOCGLIFGROUPINFO.
602  */
603 typedef struct lifgroupinfo {
604 	char		gi_grname[LIFGRNAMSIZ];	/* group name (set by caller) */
605 	char		gi_grifname[LIFNAMSIZ];	/* IPMP meta-interface name */
606 	char		gi_m4ifname[LIFNAMSIZ];	/* v4 mcast interface name */
607 	char		gi_m6ifname[LIFNAMSIZ];	/* v6 mcast interface name */
608 	char		gi_bcifname[LIFNAMSIZ];	/* v4 bcast interface name */
609 	boolean_t	gi_v4;			/* group is plumbed for v4 */
610 	boolean_t	gi_v6; 			/* group is plumbed for v6 */
611 	uint_t		gi_nv4;			/* # of underlying v4 if's */
612 	uint_t		gi_nv6;			/* # of underlying v6 if's */
613 	uint_t		gi_mactype; 		/* DLPI mac type of group */
614 } lifgroupinfo_t;
615 
616 /*
617  * OBSOLETE: Structure used in SIOCGIFCONF request.
618  * Used to retrieve interface configuration
619  * for machine (useful for programs which
620  * must know all networks accessible).
621  */
622 struct	ifconf {
623 	int	ifc_len;		/* size of associated buffer */
624 	union {
625 		caddr_t	ifcu_buf;
626 		struct	ifreq *ifcu_req;
627 	} ifc_ifcu;
628 #define	ifc_buf	ifc_ifcu.ifcu_buf	/* buffer address */
629 #define	ifc_req	ifc_ifcu.ifcu_req	/* array of structures returned */
630 };
631 
632 #if defined(_SYSCALL32)
633 
634 struct	ifconf32 {
635 	int32_t	ifc_len;		/* size of associated buffer */
636 	union {
637 		caddr32_t ifcu_buf;
638 		caddr32_t ifcu_req;
639 	} ifc_ifcu;
640 };
641 
642 #endif	/* _SYSCALL32 */
643 
644 typedef struct if_data {
645 				/* generic interface information */
646 	uchar_t	ifi_type;	/* ethernet, tokenring, etc */
647 	uchar_t	ifi_addrlen;	/* media address length */
648 	uchar_t	ifi_hdrlen;	/* media header length */
649 	uint_t	ifi_mtu;	/* maximum transmission unit */
650 	uint_t	ifi_metric;	/* routing metric (external only) */
651 	uint_t	ifi_baudrate;	/* linespeed */
652 				/* volatile statistics */
653 	uint_t	ifi_ipackets;	/* packets received on interface */
654 	uint_t	ifi_ierrors;	/* input errors on interface */
655 	uint_t	ifi_opackets;	/* packets sent on interface */
656 	uint_t	ifi_oerrors;	/* output errors on interface */
657 	uint_t	ifi_collisions;	/* collisions on csma interfaces */
658 	uint_t	ifi_ibytes;	/* total number of octets received */
659 	uint_t	ifi_obytes;	/* total number of octets sent */
660 	uint_t	ifi_imcasts;	/* packets received via multicast */
661 	uint_t	ifi_omcasts;	/* packets sent via multicast */
662 	uint_t	ifi_iqdrops;	/* dropped on input, this interface */
663 	uint_t	ifi_noproto;	/* destined for unsupported protocol */
664 #if defined(_LP64)
665 	struct	timeval32 ifi_lastchange; /* last updated */
666 #else
667 	struct	timeval ifi_lastchange; /* last updated */
668 #endif
669 } if_data_t;
670 
671 /*
672  * Message format for use in obtaining information about interfaces
673  * from the routing socket
674  */
675 typedef struct if_msghdr {
676 	ushort_t ifm_msglen;	/* to skip over non-understood messages */
677 	uchar_t	ifm_version;	/* future binary compatibility */
678 	uchar_t	ifm_type;	/* message type */
679 	int	ifm_addrs;	/* like rtm_addrs */
680 	int	ifm_flags;	/* value of if_flags */
681 	ushort_t ifm_index;	/* index for associated ifp */
682 	struct	if_data ifm_data; /* statistics and other data about if */
683 } if_msghdr_t;
684 
685 /*
686  * Message format for use in obtaining information about interface addresses
687  * from the routing socket
688  */
689 typedef struct ifa_msghdr {
690 	ushort_t ifam_msglen;	/* to skip over non-understood messages */
691 	uchar_t	ifam_version;	/* future binary compatibility */
692 	uchar_t	ifam_type;	/* message type */
693 	int	ifam_addrs;	/* like rtm_addrs */
694 	int	ifam_flags;	/* route flags */
695 	ushort_t ifam_index;	/* index for associated ifp */
696 	int	ifam_metric;	/* value of ipif_metric */
697 } ifa_msghdr_t;
698 
699 #endif /* !defined(_XOPEN_SOURCE) || defined(__EXTENSIONS__) */
700 
701 /*
702  * The if_nameindex structure holds the interface index value about
703  * a single interface. An array of this structure is used to return
704  * all interfaces and indexes.
705  */
706 struct if_nameindex {
707 	unsigned 	if_index;	/* positive interface index */
708 	char		*if_name;	/* if name, e.g. "en0" */
709 };
710 
711 /* Interface index identification API definitions */
712 extern	unsigned 		if_nametoindex(const char *);
713 extern	char			*if_indextoname(unsigned, char *);
714 extern	struct if_nameindex	*if_nameindex(void);
715 extern	void			if_freenameindex(struct if_nameindex *);
716 
717 #define	IF_NAMESIZE	_LIFNAMSIZ
718 
719 #ifdef	__cplusplus
720 }
721 #endif
722 
723 #endif	/* _NET_IF_H */
724