2 * Copyright (c) 1982, 1986, 1989, 1993
3 * The Regents of the University of California. All rights reserved.
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
13 * 4. Neither the name of the University nor the names of its contributors
14 * may be used to endorse or promote products derived from this software
15 * without specific prior written permission.
17 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29 * @(#)if.h 8.1 (Berkeley) 6/10/93
36 #include <sys/cdefs.h>
39 #include <sys/queue.h>
44 * <net/if.h> does not depend on <sys/time.h> on most other systems. This
45 * helps userland compatibility. (struct timeval ifi_lastchange)
55 * Length of interface external name, including terminating '\0'.
56 * Note: this is the same size as a generic device's external name.
58 #define IF_NAMESIZE 16
60 #define IFNAMSIZ IF_NAMESIZE
61 #define IF_MAXUNIT 0x7fff /* historical value */
66 * Structure used to query names of interface cloners.
70 int ifcr_total; /* total cloners (out) */
71 int ifcr_count; /* room for this many in user buffer */
72 char *ifcr_buffer; /* buffer for cloner names */
76 * Structure describing information about an interface
77 * which may be of interest to management entities.
80 /* generic interface information */
81 u_char ifi_type; /* ethernet, tokenring, etc */
82 u_char ifi_physical; /* e.g., AUI, Thinnet, 10base-T, etc */
83 u_char ifi_addrlen; /* media address length */
84 u_char ifi_hdrlen; /* media header length */
85 u_char ifi_link_state; /* current link state */
86 u_char ifi_spare_char1; /* spare byte */
87 u_char ifi_spare_char2; /* spare byte */
88 u_char ifi_datalen; /* length of this data struct */
89 u_long ifi_mtu; /* maximum transmission unit */
90 u_long ifi_metric; /* routing metric (external only) */
91 u_long ifi_baudrate; /* linespeed */
92 /* volatile statistics */
93 u_long ifi_ipackets; /* packets received on interface */
94 u_long ifi_ierrors; /* input errors on interface */
95 u_long ifi_opackets; /* packets sent on interface */
96 u_long ifi_oerrors; /* output errors on interface */
97 u_long ifi_collisions; /* collisions on csma interfaces */
98 u_long ifi_ibytes; /* total number of octets received */
99 u_long ifi_obytes; /* total number of octets sent */
100 u_long ifi_imcasts; /* packets received via multicast */
101 u_long ifi_omcasts; /* packets sent via multicast */
102 u_long ifi_iqdrops; /* dropped on input, this interface */
103 u_long ifi_noproto; /* destined for unsupported protocol */
104 u_long ifi_hwassist; /* HW offload capabilities, see IFCAP */
105 time_t ifi_epoch; /* uptime at attach or stat reset */
106 struct timeval ifi_lastchange; /* time of last administrative change */
110 * Interface flags are of two types: network stack owned flags, and driver
111 * owned flags. Historically, these values were stored in the same ifnet
112 * flags field, but with the advent of fine-grained locking, they have been
113 * broken out such that the network stack is responsible for synchronizing
114 * the stack-owned fields, and the device driver the device-owned fields.
115 * Both halves can perform lockless reads of the other half's field, subject
116 * to accepting the involved races.
118 * Both sets of flags come from the same number space, and should not be
119 * permitted to conflict, as they are exposed to user space via a single
122 * The following symbols identify read and write requirements for fields:
124 * (i) if_flags field set by device driver before attach, read-only there
126 * (n) if_flags field written only by the network stack, read by either the
128 * (d) if_drv_flags field written only by the device driver, read by either
129 * the stack or driver.
131 #define IFF_UP 0x1 /* (n) interface is up */
132 #define IFF_BROADCAST 0x2 /* (i) broadcast address valid */
133 #define IFF_DEBUG 0x4 /* (n) turn on debugging */
134 #define IFF_LOOPBACK 0x8 /* (i) is a loopback net */
135 #define IFF_POINTOPOINT 0x10 /* (i) is a point-to-point link */
136 #define IFF_SMART 0x20 /* (i) interface manages own routes */
137 #define IFF_DRV_RUNNING 0x40 /* (d) resources allocated */
138 #define IFF_NOARP 0x80 /* (n) no address resolution protocol */
139 #define IFF_PROMISC 0x100 /* (n) receive all packets */
140 #define IFF_ALLMULTI 0x200 /* (n) receive all multicast packets */
141 #define IFF_DRV_OACTIVE 0x400 /* (d) tx hardware queue is full */
142 #define IFF_SIMPLEX 0x800 /* (i) can't hear own transmissions */
143 #define IFF_LINK0 0x1000 /* per link layer defined bit */
144 #define IFF_LINK1 0x2000 /* per link layer defined bit */
145 #define IFF_LINK2 0x4000 /* per link layer defined bit */
146 #define IFF_ALTPHYS IFF_LINK2 /* use alternate physical connection */
147 #define IFF_MULTICAST 0x8000 /* (i) supports multicast */
149 #define IFF_PPROMISC 0x20000 /* (n) user-requested promisc mode */
150 #define IFF_MONITOR 0x40000 /* (n) user-requested monitor mode */
151 #define IFF_STATICARP 0x80000 /* (n) static ARP */
152 #define IFF_NEEDSGIANT 0x100000 /* (i) hold Giant over if_start calls */
155 * Old names for driver flags so that user space tools can continue to use
156 * the old (portable) names.
159 #define IFF_RUNNING IFF_DRV_RUNNING
160 #define IFF_OACTIVE IFF_DRV_OACTIVE
163 /* flags set internally only: */
164 #define IFF_CANTCHANGE \
165 (IFF_BROADCAST|IFF_POINTOPOINT|IFF_DRV_RUNNING|IFF_DRV_OACTIVE|\
166 IFF_SIMPLEX|IFF_MULTICAST|IFF_ALLMULTI|IFF_SMART|IFF_PROMISC|\
170 * Values for if_link_state.
172 #define LINK_STATE_UNKNOWN 0 /* link invalid/unknown */
173 #define LINK_STATE_DOWN 1 /* link is down */
174 #define LINK_STATE_UP 2 /* link is up */
177 * Some convenience macros used for setting ifi_baudrate.
178 * XXX 1000 vs. 1024? --thorpej@netbsd.org
180 #define IF_Kbps(x) ((x) * 1000) /* kilobits/sec. */
181 #define IF_Mbps(x) (IF_Kbps((x) * 1000)) /* megabits/sec. */
182 #define IF_Gbps(x) (IF_Mbps((x) * 1000)) /* gigabits/sec. */
185 * Capabilities that interfaces can advertise.
187 * struct ifnet.if_capabilities
188 * contains the optional features & capabilities a particular interface
189 * supports (not only the driver but also the detected hw revision).
190 * Capabilities are defined by IFCAP_* below.
191 * struct ifnet.if_capenable
192 * contains the enabled (either by default or through ifconfig) optional
193 * features & capabilities on this interface.
194 * Capabilities are defined by IFCAP_* below.
195 * struct if_data.ifi_hwassist in mbuf CSUM_ flag form, controlled by above
196 * contains the enabled optional feature & capabilites that can be used
197 * individually per packet and are specified in the mbuf pkthdr.csum_flags
198 * field. IFCAP_* and CSUM_* do not match one to one and CSUM_* may be
199 * more detailed or differenciated than IFCAP_*.
200 * Hwassist features are defined CSUM_* in sys/mbuf.h
202 #define IFCAP_RXCSUM 0x00001 /* can offload checksum on RX */
203 #define IFCAP_TXCSUM 0x00002 /* can offload checksum on TX */
204 #define IFCAP_NETCONS 0x00004 /* can be a network console */
205 #define IFCAP_VLAN_MTU 0x00008 /* VLAN-compatible MTU */
206 #define IFCAP_VLAN_HWTAGGING 0x00010 /* hardware VLAN tag support */
207 #define IFCAP_JUMBO_MTU 0x00020 /* 9000 byte MTU supported */
208 #define IFCAP_POLLING 0x00040 /* driver supports polling */
209 #define IFCAP_VLAN_HWCSUM 0x00080 /* can do IFCAP_HWCSUM on VLANs */
210 #define IFCAP_TSO4 0x00100 /* can do TCP Segmentation Offload */
211 #define IFCAP_TSO6 0x00200 /* can do TCP6 Segmentation Offload */
212 #define IFCAP_LRO 0x00400 /* can do Large Receive Offload */
213 #define IFCAP_WOL_UCAST 0x00800 /* wake on any unicast frame */
214 #define IFCAP_WOL_MCAST 0x01000 /* wake on any multicast frame */
215 #define IFCAP_WOL_MAGIC 0x02000 /* wake on any Magic Packet */
216 #define IFCAP_TOE4 0x04000 /* interface can offload TCP */
217 #define IFCAP_TOE6 0x08000 /* interface can offload TCP6 */
218 #define IFCAP_VLAN_HWFILTER 0x10000 /* interface hw can filter vlan tag */
220 #define IFCAP_HWCSUM (IFCAP_RXCSUM | IFCAP_TXCSUM)
221 #define IFCAP_TSO (IFCAP_TSO4 | IFCAP_TSO6)
222 #define IFCAP_WOL (IFCAP_WOL_UCAST | IFCAP_WOL_MCAST | IFCAP_WOL_MAGIC)
223 #define IFCAP_TOE (IFCAP_TOE4 | IFCAP_TOE6)
225 #define IFQ_MAXLEN 50
226 #define IFNET_SLOWHZ 1 /* granularity is 1 second */
229 * Message format for use in obtaining information about interfaces
230 * from getkerninfo and the routing socket
233 u_short ifm_msglen; /* to skip over non-understood messages */
234 u_char ifm_version; /* future binary compatibility */
235 u_char ifm_type; /* message type */
236 int ifm_addrs; /* like rtm_addrs */
237 int ifm_flags; /* value of if_flags */
238 u_short ifm_index; /* index for associated ifp */
239 struct if_data ifm_data;/* statistics and other data about if */
243 * Message format for use in obtaining information about interface addresses
244 * from getkerninfo and the routing socket
247 u_short ifam_msglen; /* to skip over non-understood messages */
248 u_char ifam_version; /* future binary compatibility */
249 u_char ifam_type; /* message type */
250 int ifam_addrs; /* like rtm_addrs */
251 int ifam_flags; /* value of ifa_flags */
252 u_short ifam_index; /* index for associated ifp */
253 int ifam_metric; /* value of ifa_metric */
257 * Message format for use in obtaining information about multicast addresses
258 * from the routing socket
261 u_short ifmam_msglen; /* to skip over non-understood messages */
262 u_char ifmam_version; /* future binary compatibility */
263 u_char ifmam_type; /* message type */
264 int ifmam_addrs; /* like rtm_addrs */
265 int ifmam_flags; /* value of ifa_flags */
266 u_short ifmam_index; /* index for associated ifp */
270 * Message format announcing the arrival or departure of a network interface.
272 struct if_announcemsghdr {
273 u_short ifan_msglen; /* to skip over non-understood messages */
274 u_char ifan_version; /* future binary compatibility */
275 u_char ifan_type; /* message type */
276 u_short ifan_index; /* index for associated ifp */
277 char ifan_name[IFNAMSIZ]; /* if name, e.g. "en0" */
278 u_short ifan_what; /* what type of announcement */
281 #define IFAN_ARRIVAL 0 /* interface arrival */
282 #define IFAN_DEPARTURE 1 /* interface departure */
285 * Interface request structure used for socket
286 * ioctl's. All interface ioctl's must have parameter
287 * definitions which begin with ifr_name. The
288 * remainder may be interface specific.
291 char ifr_name[IFNAMSIZ]; /* if name, e.g. "en0" */
293 struct sockaddr ifru_addr;
294 struct sockaddr ifru_dstaddr;
295 struct sockaddr ifru_broadaddr;
305 #define ifr_addr ifr_ifru.ifru_addr /* address */
306 #define ifr_dstaddr ifr_ifru.ifru_dstaddr /* other end of p-to-p link */
307 #define ifr_broadaddr ifr_ifru.ifru_broadaddr /* broadcast address */
308 #define ifr_flags ifr_ifru.ifru_flags[0] /* flags (low 16 bits) */
309 #define ifr_flagshigh ifr_ifru.ifru_flags[1] /* flags (high 16 bits) */
310 #define ifr_metric ifr_ifru.ifru_metric /* metric */
311 #define ifr_mtu ifr_ifru.ifru_mtu /* mtu */
312 #define ifr_phys ifr_ifru.ifru_phys /* physical wire */
313 #define ifr_media ifr_ifru.ifru_media /* physical media */
314 #define ifr_data ifr_ifru.ifru_data /* for use by interface */
315 #define ifr_reqcap ifr_ifru.ifru_cap[0] /* requested capabilities */
316 #define ifr_curcap ifr_ifru.ifru_cap[1] /* current capabilities */
317 #define ifr_index ifr_ifru.ifru_index /* interface index */
320 #define _SIZEOF_ADDR_IFREQ(ifr) \
321 ((ifr).ifr_addr.sa_len > sizeof(struct sockaddr) ? \
322 (sizeof(struct ifreq) - sizeof(struct sockaddr) + \
323 (ifr).ifr_addr.sa_len) : sizeof(struct ifreq))
326 char ifra_name[IFNAMSIZ]; /* if name, e.g. "en0" */
327 struct sockaddr ifra_addr;
328 struct sockaddr ifra_broadaddr;
329 struct sockaddr ifra_mask;
333 char ifm_name[IFNAMSIZ]; /* if name, e.g. "en0" */
334 int ifm_current; /* current media options */
335 int ifm_mask; /* don't care mask */
336 int ifm_status; /* media status */
337 int ifm_active; /* active options */
338 int ifm_count; /* # entries in ifm_ulist array */
339 int *ifm_ulist; /* media words */
343 char ifd_name[IFNAMSIZ]; /* if name, e.g. "en0" */
344 unsigned long ifd_cmd;
350 * Structure used to retrieve aux status data from interfaces.
351 * Kernel suppliers to this interface should respect the formatting
352 * needed by ifconfig(8): each line starts with a TAB and ends with
353 * a newline. The canonical example to copy and paste is in if_tun.c.
356 #define IFSTATMAX 800 /* 10 lines of text */
358 char ifs_name[IFNAMSIZ]; /* if name, e.g. "en0" */
359 char ascii[IFSTATMAX + 1];
363 * Structure used in SIOCGIFCONF request.
364 * Used to retrieve interface configuration
365 * for machine (useful for programs which
366 * must know all networks accessible).
369 int ifc_len; /* size of associated buffer */
372 struct ifreq *ifcu_req;
374 #define ifc_buf ifc_ifcu.ifcu_buf /* buffer address */
375 #define ifc_req ifc_ifcu.ifcu_req /* array of structures returned */
378 #if defined (__amd64__)
380 int ifc_len; /* size of associated buffer */
392 #define IFG_ALL "all" /* group contains all interfaces */
393 /* XXX: will we implement this? */
394 #define IFG_EGRESS "egress" /* if(s) default route(s) point to */
398 char ifgrqu_group[IFNAMSIZ];
399 char ifgrqu_member[IFNAMSIZ];
401 #define ifgrq_group ifgrq_ifgrqu.ifgrqu_group
402 #define ifgrq_member ifgrq_ifgrqu.ifgrqu_member
406 * Used to lookup groups for an interface
409 char ifgr_name[IFNAMSIZ];
412 char ifgru_group[IFNAMSIZ];
413 struct ifg_req *ifgru_groups;
415 #define ifgr_group ifgr_ifgru.ifgru_group
416 #define ifgr_groups ifgr_ifgru.ifgru_groups
420 * Structure for SIOC[AGD]LIFADDR
423 char iflr_name[IFNAMSIZ];
425 #define IFLR_PREFIX 0x8000 /* in: prefix given out: kernel fills id */
426 u_int prefixlen; /* in/out */
427 struct sockaddr_storage addr; /* in/out */
428 struct sockaddr_storage dstaddr; /* out */
431 #endif /* __BSD_VISIBLE */
434 #ifdef MALLOC_DECLARE
435 MALLOC_DECLARE(M_IFADDR);
436 MALLOC_DECLARE(M_IFMADDR);
441 struct if_nameindex {
442 unsigned int if_index; /* 1, 2, ... */
443 char *if_name; /* null terminated name: "le0", ... */
447 void if_freenameindex(struct if_nameindex *);
448 char *if_indextoname(unsigned int, char *);
449 struct if_nameindex *if_nameindex(void);
450 unsigned int if_nametoindex(const char *);
457 /* XXX - this should go away soon. */
458 #include <net/if_var.h>
461 #endif /* !_NET_IF_H_ */