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