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 * Portions Copyright (c) 2005-2009 Nokia Corporation and/or its subsidiary(-ies). All rights reserved.
30 * @(#)if.h 8.1 (Berkeley) 6/10/93
31 * $FreeBSD: src/sys/net/if.h,v 1.96.2.3 2005/10/07 14:00:05 glebius Exp $
43 #include <sys/cdefs.h>
46 #include <sys/queue.h>
51 * <net/if.h> does not depend on <sys/time.h> on most other systems. This
52 * helps userland compatibility. (struct timeval ifi_lastchange)
62 * Length of interface external name, including terminating '\0'.
63 * Note: this is the same size as a generic device's external name.
66 // KCommsDbSvrMaxColumnNameLength = 50
67 #define IF_NAMESIZE 50
69 #define IF_NAMESIZE 16
72 #define IFNAMSIZ IF_NAMESIZE
73 #define IF_MAXUNIT 0x7fff /* historical value */
78 * Structure used to query names of interface cloners.
82 int ifcr_total; /* total cloners (out) */
83 int ifcr_count; /* room for this many in user buffer */
84 char *ifcr_buffer; /* buffer for cloner names */
88 * Structure describing information about an interface
89 * which may be of interest to management entities.
92 /* generic interface information */
93 u_char ifi_type; /* ethernet, tokenring, etc */
94 u_char ifi_physical; /* e.g., AUI, Thinnet, 10base-T, etc */
95 u_char ifi_addrlen; /* media address length */
96 u_char ifi_hdrlen; /* media header length */
97 u_char ifi_link_state; /* current link state */
98 u_char ifi_recvquota; /* polling quota for receive intrs */
99 u_char ifi_xmitquota; /* polling quota for xmit intrs */
100 u_char ifi_datalen; /* length of this data struct */
101 u_long ifi_mtu; /* maximum transmission unit */
102 u_long ifi_metric; /* routing metric (external only) */
103 u_long ifi_baudrate; /* linespeed */
104 /* volatile statistics */
105 u_long ifi_ipackets; /* packets received on interface */
106 u_long ifi_ierrors; /* input errors on interface */
107 u_long ifi_opackets; /* packets sent on interface */
108 u_long ifi_oerrors; /* output errors on interface */
109 u_long ifi_collisions; /* collisions on csma interfaces */
110 u_long ifi_ibytes; /* total number of octets received */
111 u_long ifi_obytes; /* total number of octets sent */
112 u_long ifi_imcasts; /* packets received via multicast */
113 u_long ifi_omcasts; /* packets sent via multicast */
114 u_long ifi_iqdrops; /* dropped on input, this interface */
115 u_long ifi_noproto; /* destined for unsupported protocol */
116 u_long ifi_hwassist; /* HW offload capabilities */
117 time_t ifi_epoch; /* uptime at attach or stat reset */
119 u_int ifi_timepad; /* time_t is int, not long on alpha */
121 struct timeval ifi_lastchange; /* time of last administrative change */
125 * Interface flags are of two types: network stack owned flags, and driver
126 * owned flags. Historically, these values were stored in the same ifnet
127 * flags field, but with the advent of fine-grained locking, they have been
128 * broken out such that the network stack is responsible for synchronizing
129 * the stack-owned fields, and the device driver the device-owned fields.
130 * Both halves can perform lockless reads of the other half's field, subject
131 * to accepting the involved races.
133 * Both sets of flags come from the same number space, and should not be
134 * permitted to conflict, as they are exposed to user space via a single
137 * The following symbols identify read and write requirements for fields:
139 * (i) if_flags field set by device driver before attach, read-only there
141 * (n) if_flags field written only by the network stack, read by either the
143 * (d) if_drv_flags field written only by the device driver, read by either
144 * the stack or driver.
146 #define IFF_UP 0x1 /* (n) interface is up */
147 #define IFF_BROADCAST 0x2 /* (i) broadcast address valid */
148 #define IFF_DEBUG 0x4 /* (n) turn on debugging */
149 #define IFF_LOOPBACK 0x8 /* (i) is a loopback net */
150 #define IFF_POINTOPOINT 0x10 /* (i) is a point-to-point link */
151 #define IFF_SMART 0x20 /* (i) interface manages own routes */
152 #define IFF_DRV_RUNNING 0x40 /* (d) resources allocated */
153 #define IFF_NOARP 0x80 /* (n) no address resolution protocol */
154 #define IFF_PROMISC 0x100 /* (n) receive all packets */
155 #define IFF_ALLMULTI 0x200 /* (n) receive all multicast packets */
156 #define IFF_DRV_OACTIVE 0x400 /* (d) tx hardware queue is full */
157 #define IFF_SIMPLEX 0x800 /* (i) can't hear own transmissions */
158 #define IFF_LINK0 0x1000 /* per link layer defined bit */
159 #define IFF_LINK1 0x2000 /* per link layer defined bit */
160 #define IFF_LINK2 0x4000 /* per link layer defined bit */
161 #define IFF_ALTPHYS IFF_LINK2 /* use alternate physical connection */
162 #define IFF_MULTICAST 0x8000 /* (i) supports multicast */
164 #define IFF_PPROMISC 0x20000 /* (n) user-requested promisc mode */
165 #define IFF_MONITOR 0x40000 /* (n) user-requested monitor mode */
166 #define IFF_STATICARP 0x80000 /* (n) static ARP */
167 #define IFF_NEEDSGIANT 0x100000 /* (i) hold Giant over if_start calls */
170 * Old names for driver flags so that user space tools can continue to use
171 * the old (portable) names.
174 #define IFF_RUNNING IFF_DRV_RUNNING
175 #define IFF_OACTIVE IFF_DRV_OACTIVE
178 /* flags set internally only: */
179 #define IFF_CANTCHANGE \
180 (IFF_BROADCAST|IFF_POINTOPOINT|IFF_DRV_RUNNING|IFF_DRV_OACTIVE|\
181 IFF_SIMPLEX|IFF_MULTICAST|IFF_ALLMULTI|IFF_SMART|IFF_PROMISC)
184 * Values for if_link_state.
186 #define LINK_STATE_UNKNOWN 0 /* link invalid/unknown */
187 #define LINK_STATE_DOWN 1 /* link is down */
188 #define LINK_STATE_UP 2 /* link is up */
191 * Some convenience macros used for setting ifi_baudrate.
192 * XXX 1000 vs. 1024? --thorpej@netbsd.org
194 #define IF_Kbps(x) ((x) * 1000) /* kilobits/sec. */
195 #define IF_Mbps(x) (IF_Kbps((x) * 1000)) /* megabits/sec. */
196 #define IF_Gbps(x) (IF_Mbps((x) * 1000)) /* gigabits/sec. */
198 /* Capabilities that interfaces can advertise. */
199 #define IFCAP_RXCSUM 0x0001 /* can offload checksum on RX */
200 #define IFCAP_TXCSUM 0x0002 /* can offload checksum on TX */
201 #define IFCAP_NETCONS 0x0004 /* can be a network console */
202 #define IFCAP_VLAN_MTU 0x0008 /* VLAN-compatible MTU */
203 #define IFCAP_VLAN_HWTAGGING 0x0010 /* hardware VLAN tag support */
204 #define IFCAP_JUMBO_MTU 0x0020 /* 9000 byte MTU supported */
205 #define IFCAP_POLLING 0x0040 /* driver supports polling */
207 #define IFCAP_HWCSUM (IFCAP_RXCSUM | IFCAP_TXCSUM)
209 #define IFQ_MAXLEN 50
210 #define IFNET_SLOWHZ 1 /* granularity is 1 second */
213 * Message format for use in obtaining information about interfaces
214 * from getkerninfo and the routing socket
217 u_short ifm_msglen; /* to skip over non-understood messages */
218 u_char ifm_version; /* future binary compatibility */
219 u_char ifm_type; /* message type */
220 int ifm_addrs; /* like rtm_addrs */
221 int ifm_flags; /* value of if_flags */
222 u_short ifm_index; /* index for associated ifp */
223 struct if_data ifm_data;/* statistics and other data about if */
227 * Message format for use in obtaining information about interface addresses
228 * from getkerninfo and the routing socket
231 u_short ifam_msglen; /* to skip over non-understood messages */
232 u_char ifam_version; /* future binary compatibility */
233 u_char ifam_type; /* message type */
234 int ifam_addrs; /* like rtm_addrs */
235 int ifam_flags; /* value of ifa_flags */
236 u_short ifam_index; /* index for associated ifp */
237 int ifam_metric; /* value of ifa_metric */
241 * Message format for use in obtaining information about multicast addresses
242 * from the routing socket
245 u_short ifmam_msglen; /* to skip over non-understood messages */
246 u_char ifmam_version; /* future binary compatibility */
247 u_char ifmam_type; /* message type */
248 int ifmam_addrs; /* like rtm_addrs */
249 int ifmam_flags; /* value of ifa_flags */
250 u_short ifmam_index; /* index for associated ifp */
254 * Message format announcing the arrival or departure of a network interface.
256 struct if_announcemsghdr {
257 u_short ifan_msglen; /* to skip over non-understood messages */
258 u_char ifan_version; /* future binary compatibility */
259 u_char ifan_type; /* message type */
260 u_short ifan_index; /* index for associated ifp */
261 char ifan_name[IFNAMSIZ]; /* if name, e.g. "en0" */
262 u_short ifan_what; /* what type of announcement */
265 #define IFAN_ARRIVAL 0 /* interface arrival */
266 #define IFAN_DEPARTURE 1 /* interface departure */
269 * Interface request structure used for socket
270 * ioctl's. All interface ioctl's must have parameter
271 * definitions which begin with ifr_name. The
272 * remainder may be interface specific.
275 char ifr_name[IFNAMSIZ]; /* if name, e.g. "en0" */
277 struct sockaddr ifru_addr;
278 struct sockaddr ifru_dstaddr;
279 struct sockaddr ifru_broadaddr;
280 struct sockaddr ifru_hwaddr;
289 unsigned int snap_id;
292 #define ifr_hwaddr ifr_ifru.ifru_hwaddr /* MAC address */
294 #define ifr_addr ifr_ifru.ifru_addr /* address */
295 #define ifr_dstaddr ifr_ifru.ifru_dstaddr /* other end of p-to-p link */
296 #define ifr_broadaddr ifr_ifru.ifru_broadaddr /* broadcast address */
297 #define ifr_flags ifr_ifru.ifru_flags[0] /* flags (low 16 bits) */
298 #define ifr_flagshigh ifr_ifru.ifru_flags[1] /* flags (high 16 bits) */
299 #define ifr_metric ifr_ifru.ifru_metric /* metric */
300 #define ifr_mtu ifr_ifru.ifru_mtu /* mtu */
301 #define ifr_phys ifr_ifru.ifru_phys /* physical wire */
302 #define ifr_media ifr_ifru.ifru_media /* physical media */
303 #define ifr_data ifr_ifru.ifru_data /* for use by interface */
304 #define ifr_reqcap ifr_ifru.ifru_cap[0] /* requested capabilities */
305 #define ifr_curcap ifr_ifru.ifru_cap[1] /* current capabilities */
306 #define ifr_index ifr_ifru.ifru_index /* interface index */
309 #define _SIZEOF_ADDR_IFREQ(ifr) \
310 ((ifr).ifr_addr.sa_len > sizeof(struct sockaddr) ? \
311 (sizeof(struct ifreq) - sizeof(struct sockaddr) + \
312 (ifr).ifr_addr.sa_len) : sizeof(struct ifreq))
315 char ifra_name[IFNAMSIZ]; /* if name, e.g. "en0" */
316 struct sockaddr ifra_addr;
317 struct sockaddr ifra_broadaddr;
318 struct sockaddr ifra_mask;
322 char ifm_name[IFNAMSIZ]; /* if name, e.g. "en0" */
323 int ifm_current; /* current media options */
324 int ifm_mask; /* don't care mask */
325 int ifm_status; /* media status */
326 int ifm_active; /* active options */
327 int ifm_count; /* # entries in ifm_ulist array */
328 int *ifm_ulist; /* media words */
332 char ifd_name[IFNAMSIZ]; /* if name, e.g. "en0" */
333 unsigned long ifd_cmd;
339 * Structure used to retrieve aux status data from interfaces.
340 * Kernel suppliers to this interface should respect the formatting
341 * needed by ifconfig(8): each line starts with a TAB and ends with
342 * a newline. The canonical example to copy and paste is in if_tun.c.
345 #define IFSTATMAX 800 /* 10 lines of text */
347 char ifs_name[IFNAMSIZ]; /* if name, e.g. "en0" */
348 char ascii[IFSTATMAX + 1];
352 * Structure used in SIOCGIFCONF request.
353 * Used to retrieve interface configuration
354 * for machine (useful for programs which
355 * must know all networks accessible).
358 int ifc_len; /* size of associated buffer */
361 struct ifreq *ifcu_req;
363 #define ifc_buf ifc_ifcu.ifcu_buf /* buffer address */
364 #define ifc_req ifc_ifcu.ifcu_req /* array of structures returned */
369 * Structure for SIOC[AGD]LIFADDR
372 char iflr_name[IFNAMSIZ];
374 #define IFLR_PREFIX 0x8000 /* in: prefix given out: kernel fills id */
375 u_int prefixlen; /* in/out */
376 struct sockaddr_storage addr; /* in/out */
377 struct sockaddr_storage dstaddr; /* out */
380 #endif /* __BSD_VISIBLE */
383 struct if_nameindex {
384 unsigned int if_index; /* 1, 2, ... */
385 char *if_name; /* null terminated name: "le0", ... */
389 IMPORT_C void if_freenameindex(struct if_nameindex *);
390 IMPORT_C char *if_indextoname(unsigned int, char *);
391 IMPORT_C struct if_nameindex *if_nameindex(void);
392 IMPORT_C unsigned int if_nametoindex(const char *);
399 /* XXX - this should go away soon. */
400 #include <stdapis/net/if_var.h>
404 * Symbian specific APIs
407 IMPORT_C int setdefaultif( const struct ifreq* );
416 #endif /* !_NET_IF_H_ */