xref: /titanic_52/usr/src/uts/common/net/if.h (revision 96a62ada8aa6cb19b04270da282e7e21ba74b808)
1 /*
2  * Copyright 2009 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 /* flags that cannot be changed by userland on any interface */
174 #define	IFF_CANTCHANGE \
175 	(IFF_BROADCAST | IFF_POINTOPOINT | IFF_RUNNING | IFF_PROMISC | \
176 	IFF_MULTICAST | IFF_MULTI_BCAST | IFF_UNNUMBERED | IFF_IPV4 | \
177 	IFF_IPV6 | IFF_IPMP | IFF_FIXEDMTU | IFF_VIRTUAL | \
178 	IFF_LOOPBACK | IFF_ALLMULTI | IFF_DUPLICATE | IFF_COS_ENABLED | \
179 	IFF_VRRP)
180 
181 /* flags that cannot be changed by userland on an IPMP interface */
182 #define	IFF_IPMP_CANTCHANGE 	IFF_FAILED
183 
184 /* flags that can never be set on an IPMP interface */
185 #define	IFF_IPMP_INVALID	(IFF_STANDBY | IFF_INACTIVE | IFF_OFFLINE | \
186 	IFF_NOFAILOVER | IFF_NOARP | IFF_NONUD | IFF_XRESOLV | IFF_NOACCEPT)
187 
188 /*
189  * Output queues (ifp->if_snd) and internetwork datagram level (pup level 1)
190  * input routines have queues of messages stored on ifqueue structures
191  * (defined above).  Entries are added to and deleted from these structures
192  * by these macros, which should be called with ipl raised to splimp().
193  */
194 #define	IF_QFULL(ifq)		((ifq)->ifq_len >= (ifq)->ifq_maxlen)
195 #define	IF_DROP(ifq)		((ifq)->ifq_drops++)
196 #define	IF_ENQUEUE(ifq, m) { \
197 	(m)->m_act = 0; \
198 	if ((ifq)->ifq_tail == 0) \
199 		(ifq)->ifq_head = m; \
200 	else \
201 		(ifq)->ifq_tail->m_act = m; \
202 	(ifq)->ifq_tail = m; \
203 	(ifq)->ifq_len++; \
204 }
205 #define	IF_PREPEND(ifq, m) { \
206 	(m)->m_act = (ifq)->ifq_head; \
207 	if ((ifq)->ifq_tail == 0) \
208 		(ifq)->ifq_tail = (m); \
209 	(ifq)->ifq_head = (m); \
210 	(ifq)->ifq_len++; \
211 }
212 
213 /*
214  * Packets destined for level-1 protocol input routines
215  * have a pointer to the receiving interface prepended to the data.
216  * IF_DEQUEUEIF extracts and returns this pointer when dequeuing the packet.
217  * IF_ADJ should be used otherwise to adjust for its presence.
218  */
219 #define	IF_ADJ(m) { \
220 	(m)->m_off += sizeof (struct ifnet *); \
221 	(m)->m_len -= sizeof (struct ifnet *); \
222 	if ((m)->m_len == 0) { \
223 		struct mbuf *n; \
224 		MFREE((m), n); \
225 		(m) = n; \
226 	} \
227 }
228 #define	IF_DEQUEUEIF(ifq, m, ifp) { \
229 	(m) = (ifq)->ifq_head; \
230 	if (m) { \
231 		if (((ifq)->ifq_head = (m)->m_act) == 0) \
232 			(ifq)->ifq_tail = 0; \
233 		(m)->m_act = 0; \
234 		(ifq)->ifq_len--; \
235 		(ifp) = *(mtod((m), struct ifnet **)); \
236 		IF_ADJ(m); \
237 	} \
238 }
239 #define	IF_DEQUEUE(ifq, m) { \
240 	(m) = (ifq)->ifq_head; \
241 	if (m) { \
242 		if (((ifq)->ifq_head = (m)->m_act) == 0) \
243 			(ifq)->ifq_tail = 0; \
244 		(m)->m_act = 0; \
245 		(ifq)->ifq_len--; \
246 	} \
247 }
248 
249 #define	IFQ_MAXLEN	50
250 #define	IFNET_SLOWHZ	1		/* granularity is 1 second */
251 
252 /*
253  * The ifaddr structure contains information about one address
254  * of an interface.  They are maintained by the different address families,
255  * are allocated and attached when an address is set, and are linked
256  * together so all addresses for an interface can be located.
257  */
258 struct ifaddr {
259 	struct	sockaddr ifa_addr;	/* address of interface */
260 	union {
261 		struct	sockaddr ifu_broadaddr;
262 		struct	sockaddr ifu_dstaddr;
263 	} ifa_ifu;
264 #define	ifa_broadaddr	ifa_ifu.ifu_broadaddr	/* broadcast address */
265 #define	ifa_dstaddr	ifa_ifu.ifu_dstaddr	/* other end of p-to-p link */
266 	struct	ifnet *ifa_ifp;		/* back-pointer to interface */
267 	struct	ifaddr *ifa_next;	/* next address for interface */
268 };
269 
270 /*
271  * For SIOCLIF*ND ioctls.
272  *
273  * The lnr_state_* fields use the ND_* neighbor reachability states.
274  * The 3 different fields are for use with SIOCLIFSETND to cover the cases
275  * when
276  *	A new entry is created
277  *	The entry already exists and the link-layer address is the same
278  *	The entry already exists and the link-layer address differs
279  *
280  * Use ND_UNCHANGED and ND_ISROUTER_UNCHANGED to not change any state.
281  */
282 #define	ND_MAX_HDW_LEN	64
283 typedef struct lif_nd_req {
284 	struct sockaddr_storage	lnr_addr;
285 	uint8_t			lnr_state_create;	/* When creating */
286 	uint8_t			lnr_state_same_lla;	/* Update same addr */
287 	uint8_t			lnr_state_diff_lla;	/* Update w/ diff. */
288 	int			lnr_hdw_len;
289 	int			lnr_flags;		/* See below */
290 	/* padding because ia32 "long long"s are only 4-byte aligned. */
291 	int			lnr_pad0;
292 	char			lnr_hdw_addr[ND_MAX_HDW_LEN];
293 } lif_nd_req_t;
294 
295 /*
296  * Neighbor reachability states
297  * Used with SIOCLIF*ND ioctls.
298  */
299 #define	ND_UNCHANGED	0	/* For ioctls that don't modify state */
300 #define	ND_INCOMPLETE	1	/* addr resolution in progress */
301 #define	ND_REACHABLE	2	/* have recently been reachable */
302 #define	ND_STALE	3	/* may be unreachable, don't do anything */
303 #define	ND_DELAY	4	/* wait for upper layer hint */
304 #define	ND_PROBE	5	/* send probes */
305 #define	ND_UNREACHABLE	6	/* delete this route */
306 #define	ND_INITIAL	7	/* ipv4: arp resolution has not been sent yet */
307 
308 #define	ND_STATE_VALID_MIN	0
309 #define	ND_STATE_VALID_MAX	7
310 
311 /*
312  * lnr_flags value of lif_nd_req.
313  * Used with SIOCLIF*ND ioctls.
314  */
315 #define	NDF_ISROUTER_ON		0x1
316 #define	NDF_ISROUTER_OFF	0x2
317 #define	NDF_ANYCAST_ON		0x4
318 #define	NDF_ANYCAST_OFF		0x8
319 #define	NDF_PROXY_ON		0x10
320 #define	NDF_PROXY_OFF		0x20
321 
322 /* For SIOC[GS]LIFLNKINFO */
323 typedef struct lif_ifinfo_req {
324 	uint8_t		lir_maxhops;
325 	uint32_t	lir_reachtime;		/* Reachable time in msec */
326 	uint32_t	lir_reachretrans;	/* Retransmission timer msec */
327 	uint32_t	lir_maxmtu;
328 } lif_ifinfo_req_t;
329 
330 #endif /* !defined(_XOPEN_SOURCE) || defined(__EXTENSIONS__) */
331 
332 /*
333  * Maximum lengths of interface name and IPMP group name; these are the same
334  * for historical reasons.  Note that the actual maximum length of a name is
335  * one byte less than these constants since the kernel always sets the final
336  * byte of lifr_name and lifr_groupname to NUL.
337  */
338 #define	_LIFNAMSIZ	32
339 
340 #if !defined(_XOPEN_SOURCE) || defined(__EXTENSIONS__)
341 
342 #define	LIFNAMSIZ	_LIFNAMSIZ
343 #define	LIFGRNAMSIZ	LIFNAMSIZ
344 
345 /*
346  * Interface request structure used for socket
347  * ioctl's.  All interface ioctl's must have parameter
348  * definitions which begin with ifr_name.  The
349  * remainder may be interface specific.
350  * Note: This data structure uses 64bit type uint64_t which is not
351  *	 a valid type for strict ANSI/ISO C compilation for ILP32.
352  *	 Applications with ioctls using this structure that insist on
353  *	 building with strict ANSI/ISO C (-Xc) will need to be LP64.
354  */
355 #if defined(_INT64_TYPE)
356 struct	lifreq {
357 	char	lifr_name[LIFNAMSIZ];		/* if name, e.g. "en0" */
358 	union {
359 		int	lifru_addrlen;		/* for subnet/token etc */
360 		uint_t	lifru_ppa;		/* SIOCSLIFNAME */
361 	} lifr_lifru1;
362 #define	lifr_addrlen	lifr_lifru1.lifru_addrlen
363 #define	lifr_ppa	lifr_lifru1.lifru_ppa	/* Driver's ppa */
364 	uint_t		lifr_type;		/* IFT_ETHER, ... */
365 	union {
366 		struct	sockaddr_storage lifru_addr;
367 		struct	sockaddr_storage lifru_dstaddr;
368 		struct	sockaddr_storage lifru_broadaddr;
369 		struct	sockaddr_storage lifru_token;	/* With lifr_addrlen */
370 		struct	sockaddr_storage lifru_subnet;	/* With lifr_addrlen */
371 		int	lifru_index;		/* interface index */
372 		uint64_t lifru_flags;		/* Flags for SIOC?LIFFLAGS */
373 		int	lifru_metric;
374 		uint_t	lifru_mtu;
375 		int	lif_muxid[2];		/* mux id's for arp and ip */
376 		struct lif_nd_req	lifru_nd_req;
377 		struct lif_ifinfo_req	lifru_ifinfo_req;
378 		char	lifru_groupname[LIFGRNAMSIZ]; /* SIOC[GS]LIFGROUPNAME */
379 		char	lifru_binding[LIFNAMSIZ]; /* SIOCGLIFBINDING */
380 		zoneid_t lifru_zoneid;		/* SIOC[GS]LIFZONE */
381 	} lifr_lifru;
382 
383 #define	lifr_addr	lifr_lifru.lifru_addr	/* address */
384 #define	lifr_dstaddr	lifr_lifru.lifru_dstaddr /* other end of p-to-p link */
385 #define	lifr_broadaddr	lifr_lifru.lifru_broadaddr /* broadcast address */
386 #define	lifr_token	lifr_lifru.lifru_token	/* address token */
387 #define	lifr_subnet	lifr_lifru.lifru_subnet	/* subnet prefix */
388 #define	lifr_index	lifr_lifru.lifru_index	/* interface index */
389 #define	lifr_flags	lifr_lifru.lifru_flags	/* flags */
390 #define	lifr_metric	lifr_lifru.lifru_metric	/* metric */
391 #define	lifr_mtu	lifr_lifru.lifru_mtu	/* mtu */
392 #define	lifr_ip_muxid	lifr_lifru.lif_muxid[0]
393 #define	lifr_arp_muxid	lifr_lifru.lif_muxid[1]
394 #define	lifr_nd		lifr_lifru.lifru_nd_req	/* SIOCLIF*ND */
395 #define	lifr_ifinfo	lifr_lifru.lifru_ifinfo_req /* SIOC[GS]LIFLNKINFO */
396 #define	lifr_groupname	lifr_lifru.lifru_groupname
397 #define	lifr_binding	lifr_lifru.lifru_binding
398 #define	lifr_zoneid	lifr_lifru.lifru_zoneid
399 };
400 #endif /* defined(_INT64_TYPE) */
401 
402 /*
403  * Argument structure for SIOCT* address testing ioctls.
404  */
405 struct sioc_addrreq {
406 	struct sockaddr_storage	sa_addr;	/* Address to test */
407 	int			sa_res;		/* Result - 0/1 */
408 	int			sa_pad;
409 };
410 
411 /*
412  * Argument structure used by mrouted to get src-grp pkt counts using
413  * SIOCGETLSGCNT. See <netinet/ip_mroute.h>.
414  */
415 struct sioc_lsg_req {
416 	struct sockaddr_storage	slr_src;
417 	struct sockaddr_storage	slr_grp;
418 	uint_t			slr_pktcnt;
419 	uint_t			slr_bytecnt;
420 	uint_t			slr_wrong_if;
421 	uint_t			slr_pad;
422 };
423 
424 /*
425  * OBSOLETE: Replaced by struct lifreq. Supported for compatibility.
426  *
427  * Interface request structure used for socket
428  * ioctl's.  All interface ioctl's must have parameter
429  * definitions which begin with ifr_name.  The
430  * remainder may be interface specific.
431  */
432 struct	ifreq {
433 #define	IFNAMSIZ	16
434 	char	ifr_name[IFNAMSIZ];		/* if name, e.g. "en0" */
435 	union {
436 		struct	sockaddr ifru_addr;
437 		struct	sockaddr ifru_dstaddr;
438 		char	ifru_oname[IFNAMSIZ];	/* other if name */
439 		struct	sockaddr ifru_broadaddr;
440 		int	ifru_index;		/* interface index */
441 		uint_t	ifru_mtu;
442 		short	ifru_flags;
443 		int	ifru_metric;
444 		char	ifru_data[1];		/* interface dependent data */
445 		char	ifru_enaddr[6];
446 		int	if_muxid[2];		/* mux id's for arp and ip */
447 
448 		/* Struct for flags/ppa */
449 		struct ifr_ppaflags {
450 			short ifrup_flags;	/* Space of ifru_flags. */
451 			short ifrup_filler;
452 			uint_t ifrup_ppa;
453 		} ifru_ppaflags;
454 
455 		/* Struct for FDDI ioctl's */
456 		struct ifr_dnld_reqs {
457 			uint32_t	v_addr;
458 			uint32_t	m_addr;
459 			uint32_t	ex_addr;
460 			uint32_t	size;
461 		} ifru_dnld_req;
462 
463 		/* Struct for FDDI stats */
464 		struct ifr_fddi_stats {
465 			uint32_t stat_size;
466 			uint32_t fddi_stats;
467 		} ifru_fddi_stat;
468 
469 		struct ifr_netmapents {
470 			uint32_t map_ent_size,	/* size of netmap structure */
471 				entry_number;	/* index into netmap list */
472 			uint32_t fddi_map_ent;	/* pointer to user structure */
473 		} ifru_netmapent;
474 
475 		/* Field for generic ioctl for fddi */
476 
477 		struct ifr_fddi_gen_struct {
478 			uint32_t ifru_fddi_gioctl; /* field for gen ioctl */
479 			uint32_t ifru_fddi_gaddr;  /* Generic ptr to a field */
480 		} ifru_fddi_gstruct;
481 
482 	} ifr_ifru;
483 
484 #define	ifr_addr	ifr_ifru.ifru_addr	/* address */
485 #define	ifr_dstaddr	ifr_ifru.ifru_dstaddr	/* other end of p-to-p link */
486 #define	ifr_oname	ifr_ifru.ifru_oname	/* other if name */
487 #define	ifr_broadaddr	ifr_ifru.ifru_broadaddr	/* broadcast address */
488 #define	ifr_flags	ifr_ifru.ifru_flags	/* flags */
489 #define	ifr_metric	ifr_ifru.ifru_metric	/* metric */
490 #define	ifr_data	ifr_ifru.ifru_data	/* for use by interface */
491 #define	ifr_enaddr	ifr_ifru.ifru_enaddr	/* ethernet address */
492 #define	ifr_index	ifr_ifru.ifru_index	/* interface index */
493 #define	ifr_mtu		ifr_ifru.ifru_mtu	/* mtu */
494 /* For setting ppa */
495 #define	ifr_ppa		ifr_ifru.ifru_ppaflags.ifrup_ppa
496 
497 /* FDDI specific */
498 #define	ifr_dnld_req	ifr_ifru.ifru_dnld_req
499 #define	ifr_fddi_stat	ifr_ifru.ifru_fddi_stat
500 #define	ifr_fddi_netmap	ifr_ifru.ifru_netmapent	/* FDDI network map entries */
501 #define	ifr_fddi_gstruct ifr_ifru.ifru_fddi_gstruct
502 
503 #define	ifr_ip_muxid	ifr_ifru.if_muxid[0]
504 #define	ifr_arp_muxid	ifr_ifru.if_muxid[1]
505 };
506 
507 /* Used by SIOCGLIFNUM. Uses same flags as in struct lifconf */
508 struct lifnum {
509 	sa_family_t	lifn_family;
510 	int		lifn_flags;	/* request specific interfaces */
511 	int		lifn_count;	/* Result */
512 };
513 
514 /*
515  * Structure used in SIOCGLIFCONF request.
516  * Used to retrieve interface configuration
517  * for machine (useful for programs which
518  * must know all networks accessible) for a given address family.
519  * Using AF_UNSPEC will retrieve all address families.
520  */
521 struct	lifconf {
522 	sa_family_t	lifc_family;
523 	int		lifc_flags;	/* request specific interfaces */
524 	int		lifc_len;	/* size of associated buffer */
525 	union {
526 		caddr_t	lifcu_buf;
527 		struct	lifreq *lifcu_req;
528 	} lifc_lifcu;
529 #define	lifc_buf lifc_lifcu.lifcu_buf	/* buffer address */
530 #define	lifc_req lifc_lifcu.lifcu_req	/* array of structures returned */
531 };
532 
533 /*
534  * Structure used in SIOCGLIFSRCOF to get the interface
535  * configuration list for those interfaces that use an address
536  * hosted on the interface (set in lifs_ifindex), as the source
537  * address.
538  */
539 struct lifsrcof {
540 	uint_t	lifs_ifindex;	/* interface of interest */
541 	size_t  lifs_maxlen;	/* size of buffer: input */
542 	size_t  lifs_len;	/* size of buffer: output */
543 	union {
544 		caddr_t	lifsu_buf;
545 		struct	lifreq *lifsu_req;
546 	} lifs_lifsu;
547 #define	lifs_buf lifs_lifsu.lifsu_buf /* buffer address */
548 #define	lifs_req lifs_lifsu.lifsu_req /* array returned */
549 };
550 
551 /* Flags */
552 #define	LIFC_NOXMIT	0x01		/* Include IFF_NOXMIT interfaces */
553 #define	LIFC_EXTERNAL_SOURCE	0x02	/* Exclude the interfaces which can't */
554 					/* be used to communicate outside the */
555 					/* node (exclude interfaces which are */
556 					/* IFF_NOXMIT, IFF_NOLOCAL, */
557 					/* IFF_LOOPBACK, IFF_DEPRECATED, or */
558 					/* not IFF_UP). Has priority over */
559 					/* LIFC_NOXMIT. */
560 #define	LIFC_TEMPORARY	0x04		/* Include IFF_TEMPORARY interfaces */
561 #define	LIFC_ALLZONES	0x08		/* Include all zones */
562 					/* (must be issued from global zone) */
563 #define	LIFC_UNDER_IPMP	0x10		/* Include underlying IPMP interfaces */
564 
565 #if defined(_SYSCALL32)
566 
567 struct	lifconf32 {
568 	sa_family_t	lifc_family;
569 	int		lifc_flags;	/* request specific interfaces */
570 	int32_t	lifc_len;		/* size of associated buffer */
571 	union {
572 		caddr32_t lifcu_buf;
573 		caddr32_t lifcu_req;
574 	} lifc_lifcu;
575 };
576 
577 struct lifsrcof32 {
578 	uint_t	lifs_ifindex;	/* interface of interest */
579 	size32_t  lifs_maxlen;	/* size of buffer: input */
580 	size32_t  lifs_len;	/* size of buffer: output */
581 	union {
582 		caddr32_t lifsu_buf;
583 		caddr32_t lifsu_req;
584 	} lifs_lifsu;
585 };
586 
587 #endif	/* _SYSCALL32 */
588 
589 /*
590  * IPMP group information, for use with SIOCGLIFGROUPINFO.
591  */
592 typedef struct lifgroupinfo {
593 	char		gi_grname[LIFGRNAMSIZ];	/* group name (set by caller) */
594 	char		gi_grifname[LIFNAMSIZ];	/* IPMP meta-interface name */
595 	char		gi_m4ifname[LIFNAMSIZ];	/* v4 mcast interface name */
596 	char		gi_m6ifname[LIFNAMSIZ];	/* v6 mcast interface name */
597 	char		gi_bcifname[LIFNAMSIZ];	/* v4 bcast interface name */
598 	boolean_t	gi_v4;			/* group is plumbed for v4 */
599 	boolean_t	gi_v6; 			/* group is plumbed for v6 */
600 	uint_t		gi_nv4;			/* # of underlying v4 if's */
601 	uint_t		gi_nv6;			/* # of underlying v6 if's */
602 	uint_t		gi_mactype; 		/* DLPI mac type of group */
603 } lifgroupinfo_t;
604 
605 /*
606  * OBSOLETE: Structure used in SIOCGIFCONF request.
607  * Used to retrieve interface configuration
608  * for machine (useful for programs which
609  * must know all networks accessible).
610  */
611 struct	ifconf {
612 	int	ifc_len;		/* size of associated buffer */
613 	union {
614 		caddr_t	ifcu_buf;
615 		struct	ifreq *ifcu_req;
616 	} ifc_ifcu;
617 #define	ifc_buf	ifc_ifcu.ifcu_buf	/* buffer address */
618 #define	ifc_req	ifc_ifcu.ifcu_req	/* array of structures returned */
619 };
620 
621 #if defined(_SYSCALL32)
622 
623 struct	ifconf32 {
624 	int32_t	ifc_len;		/* size of associated buffer */
625 	union {
626 		caddr32_t ifcu_buf;
627 		caddr32_t ifcu_req;
628 	} ifc_ifcu;
629 };
630 
631 #endif	/* _SYSCALL32 */
632 
633 typedef struct if_data {
634 				/* generic interface information */
635 	uchar_t	ifi_type;	/* ethernet, tokenring, etc */
636 	uchar_t	ifi_addrlen;	/* media address length */
637 	uchar_t	ifi_hdrlen;	/* media header length */
638 	uint_t	ifi_mtu;	/* maximum transmission unit */
639 	uint_t	ifi_metric;	/* routing metric (external only) */
640 	uint_t	ifi_baudrate;	/* linespeed */
641 				/* volatile statistics */
642 	uint_t	ifi_ipackets;	/* packets received on interface */
643 	uint_t	ifi_ierrors;	/* input errors on interface */
644 	uint_t	ifi_opackets;	/* packets sent on interface */
645 	uint_t	ifi_oerrors;	/* output errors on interface */
646 	uint_t	ifi_collisions;	/* collisions on csma interfaces */
647 	uint_t	ifi_ibytes;	/* total number of octets received */
648 	uint_t	ifi_obytes;	/* total number of octets sent */
649 	uint_t	ifi_imcasts;	/* packets received via multicast */
650 	uint_t	ifi_omcasts;	/* packets sent via multicast */
651 	uint_t	ifi_iqdrops;	/* dropped on input, this interface */
652 	uint_t	ifi_noproto;	/* destined for unsupported protocol */
653 #if defined(_LP64)
654 	struct	timeval32 ifi_lastchange; /* last updated */
655 #else
656 	struct	timeval ifi_lastchange; /* last updated */
657 #endif
658 } if_data_t;
659 
660 /*
661  * Message format for use in obtaining information about interfaces
662  * from the routing socket
663  */
664 typedef struct if_msghdr {
665 	ushort_t ifm_msglen;	/* to skip over non-understood messages */
666 	uchar_t	ifm_version;	/* future binary compatibility */
667 	uchar_t	ifm_type;	/* message type */
668 	int	ifm_addrs;	/* like rtm_addrs */
669 	int	ifm_flags;	/* value of if_flags */
670 	ushort_t ifm_index;	/* index for associated ifp */
671 	struct	if_data ifm_data; /* statistics and other data about if */
672 } if_msghdr_t;
673 
674 /*
675  * Message format for use in obtaining information about interface addresses
676  * from the routing socket
677  */
678 typedef struct ifa_msghdr {
679 	ushort_t ifam_msglen;	/* to skip over non-understood messages */
680 	uchar_t	ifam_version;	/* future binary compatibility */
681 	uchar_t	ifam_type;	/* message type */
682 	int	ifam_addrs;	/* like rtm_addrs */
683 	int	ifam_flags;	/* route flags */
684 	ushort_t ifam_index;	/* index for associated ifp */
685 	int	ifam_metric;	/* value of ipif_metric */
686 } ifa_msghdr_t;
687 
688 #endif /* !defined(_XOPEN_SOURCE) || defined(__EXTENSIONS__) */
689 
690 /*
691  * The if_nameindex structure holds the interface index value about
692  * a single interface. An array of this structure is used to return
693  * all interfaces and indexes.
694  */
695 struct if_nameindex {
696 	unsigned 	if_index;	/* positive interface index */
697 	char		*if_name;	/* if name, e.g. "en0" */
698 };
699 
700 /* Interface index identification API definitions */
701 extern	unsigned 		if_nametoindex(const char *);
702 extern	char			*if_indextoname(unsigned, char *);
703 extern	struct if_nameindex	*if_nameindex(void);
704 extern	void			if_freenameindex(struct if_nameindex *);
705 
706 #define	IF_NAMESIZE	_LIFNAMSIZ
707 
708 #ifdef	__cplusplus
709 }
710 #endif
711 
712 #endif	/* _NET_IF_H */
713