FreeBSD/Linux Kernel Cross Reference
sys/net/if.h
1 /*-
2 * Copyright (c) 1982, 1986, 1989, 1993
3 * The Regents of the University of California. All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
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.
16 *
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
27 * SUCH DAMAGE.
28 *
29 * @(#)if.h 8.1 (Berkeley) 6/10/93
30 * $FreeBSD: releng/5.4/sys/net/if.h 145335 2005-04-20 19:11:07Z cvs2svn $
31 */
32
33 #ifndef _NET_IF_H_
34 #define _NET_IF_H_
35
36 #include <sys/cdefs.h>
37
38 #ifdef _KERNEL
39 #include <sys/queue.h>
40 #endif
41
42 #if __BSD_VISIBLE
43 /*
44 * <net/if.h> does not depend on <sys/time.h> on most other systems. This
45 * helps userland compatibility. (struct timeval ifi_lastchange)
46 */
47 #ifndef _KERNEL
48 #include <sys/time.h>
49 #endif
50
51 struct ifnet;
52 #endif
53
54 /*
55 * Length of interface external name, including terminating '\0'.
56 * Note: this is the same size as a generic device's external name.
57 */
58 #define IF_NAMESIZE 16
59 #if __BSD_VISIBLE
60 #define IFNAMSIZ IF_NAMESIZE
61 #define IF_MAXUNIT 0x7fff /* historical value */
62 #endif
63 #if __BSD_VISIBLE
64
65 /*
66 * Structure used to query names of interface cloners.
67 */
68
69 struct if_clonereq {
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 */
73 };
74
75 /*
76 * Structure describing information about an interface
77 * which may be of interest to management entities.
78 */
79 struct if_data {
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_recvquota; /* polling quota for receive intrs */
87 u_char ifi_xmitquota; /* polling quota for xmit intrs */
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 */
105 time_t ifi_epoch; /* uptime at attach or stat reset */
106 #ifdef __alpha__
107 u_int ifi_timepad; /* time_t is int, not long on alpha */
108 #endif
109 struct timeval ifi_lastchange; /* time of last administrative change */
110 };
111
112 #define IFF_UP 0x1 /* interface is up */
113 #define IFF_BROADCAST 0x2 /* broadcast address valid */
114 #define IFF_DEBUG 0x4 /* turn on debugging */
115 #define IFF_LOOPBACK 0x8 /* is a loopback net */
116 #define IFF_POINTOPOINT 0x10 /* interface is point-to-point link */
117 #define IFF_SMART 0x20 /* interface manages own routes */
118 #define IFF_RUNNING 0x40 /* resources allocated */
119 #define IFF_NOARP 0x80 /* no address resolution protocol */
120 #define IFF_PROMISC 0x100 /* receive all packets */
121 #define IFF_ALLMULTI 0x200 /* receive all multicast packets */
122 #define IFF_OACTIVE 0x400 /* tx hardware queue is full */
123 #define IFF_SIMPLEX 0x800 /* can't hear own transmissions */
124 #define IFF_LINK0 0x1000 /* per link layer defined bit */
125 #define IFF_LINK1 0x2000 /* per link layer defined bit */
126 #define IFF_LINK2 0x4000 /* per link layer defined bit */
127 #define IFF_ALTPHYS IFF_LINK2 /* use alternate physical connection */
128 #define IFF_MULTICAST 0x8000 /* supports multicast */
129 #define IFF_POLLING 0x10000 /* Interface is in polling mode. */
130 #define IFF_PPROMISC 0x20000 /* user-requested promisc mode */
131 #define IFF_MONITOR 0x40000 /* user-requested monitor mode */
132 #define IFF_STATICARP 0x80000 /* static ARP */
133 #define IFF_NEEDSGIANT 0x100000 /* hold Giant over if_start calls */
134
135 /* flags set internally only: */
136 #define IFF_CANTCHANGE \
137 (IFF_BROADCAST|IFF_POINTOPOINT|IFF_RUNNING|IFF_OACTIVE|\
138 IFF_SIMPLEX|IFF_MULTICAST|IFF_ALLMULTI|IFF_SMART|IFF_PROMISC|\
139 IFF_POLLING)
140
141 /*
142 * Values for if_link_state.
143 */
144 #define LINK_STATE_UNKNOWN 0 /* link invalid/unknown */
145 #define LINK_STATE_DOWN 1 /* link is down */
146 #define LINK_STATE_UP 2 /* link is up */
147
148 /*
149 * Some convenience macros used for setting ifi_baudrate.
150 * XXX 1000 vs. 1024? --thorpej@netbsd.org
151 */
152 #define IF_Kbps(x) ((x) * 1000) /* kilobits/sec. */
153 #define IF_Mbps(x) (IF_Kbps((x) * 1000)) /* megabits/sec. */
154 #define IF_Gbps(x) (IF_Mbps((x) * 1000)) /* gigabits/sec. */
155
156 /* Capabilities that interfaces can advertise. */
157 #define IFCAP_RXCSUM 0x0001 /* can offload checksum on RX */
158 #define IFCAP_TXCSUM 0x0002 /* can offload checksum on TX */
159 #define IFCAP_NETCONS 0x0004 /* can be a network console */
160 #define IFCAP_VLAN_MTU 0x0008 /* VLAN-compatible MTU */
161 #define IFCAP_VLAN_HWTAGGING 0x0010 /* hardware VLAN tag support */
162 #define IFCAP_JUMBO_MTU 0x0020 /* 9000 byte MTU supported */
163 #define IFCAP_POLLING 0x0040 /* driver supports polling */
164
165 #define IFCAP_HWCSUM (IFCAP_RXCSUM | IFCAP_TXCSUM)
166
167 #define IFQ_MAXLEN 50
168 #define IFNET_SLOWHZ 1 /* granularity is 1 second */
169
170 /*
171 * Message format for use in obtaining information about interfaces
172 * from getkerninfo and the routing socket
173 */
174 struct if_msghdr {
175 u_short ifm_msglen; /* to skip over non-understood messages */
176 u_char ifm_version; /* future binary compatibility */
177 u_char ifm_type; /* message type */
178 int ifm_addrs; /* like rtm_addrs */
179 int ifm_flags; /* value of if_flags */
180 u_short ifm_index; /* index for associated ifp */
181 struct if_data ifm_data;/* statistics and other data about if */
182 };
183
184 /*
185 * Message format for use in obtaining information about interface addresses
186 * from getkerninfo and the routing socket
187 */
188 struct ifa_msghdr {
189 u_short ifam_msglen; /* to skip over non-understood messages */
190 u_char ifam_version; /* future binary compatibility */
191 u_char ifam_type; /* message type */
192 int ifam_addrs; /* like rtm_addrs */
193 int ifam_flags; /* value of ifa_flags */
194 u_short ifam_index; /* index for associated ifp */
195 int ifam_metric; /* value of ifa_metric */
196 };
197
198 /*
199 * Message format for use in obtaining information about multicast addresses
200 * from the routing socket
201 */
202 struct ifma_msghdr {
203 u_short ifmam_msglen; /* to skip over non-understood messages */
204 u_char ifmam_version; /* future binary compatibility */
205 u_char ifmam_type; /* message type */
206 int ifmam_addrs; /* like rtm_addrs */
207 int ifmam_flags; /* value of ifa_flags */
208 u_short ifmam_index; /* index for associated ifp */
209 };
210
211 /*
212 * Message format announcing the arrival or departure of a network interface.
213 */
214 struct if_announcemsghdr {
215 u_short ifan_msglen; /* to skip over non-understood messages */
216 u_char ifan_version; /* future binary compatibility */
217 u_char ifan_type; /* message type */
218 u_short ifan_index; /* index for associated ifp */
219 char ifan_name[IFNAMSIZ]; /* if name, e.g. "en0" */
220 u_short ifan_what; /* what type of announcement */
221 };
222
223 #define IFAN_ARRIVAL 0 /* interface arrival */
224 #define IFAN_DEPARTURE 1 /* interface departure */
225
226 /*
227 * Interface request structure used for socket
228 * ioctl's. All interface ioctl's must have parameter
229 * definitions which begin with ifr_name. The
230 * remainder may be interface specific.
231 */
232 struct ifreq {
233 char ifr_name[IFNAMSIZ]; /* if name, e.g. "en0" */
234 union {
235 struct sockaddr ifru_addr;
236 struct sockaddr ifru_dstaddr;
237 struct sockaddr ifru_broadaddr;
238 short ifru_flags[2];
239 short ifru_index;
240 int ifru_metric;
241 int ifru_mtu;
242 int ifru_phys;
243 int ifru_media;
244 caddr_t ifru_data;
245 int ifru_cap[2];
246 } ifr_ifru;
247 #define ifr_addr ifr_ifru.ifru_addr /* address */
248 #define ifr_dstaddr ifr_ifru.ifru_dstaddr /* other end of p-to-p link */
249 #define ifr_broadaddr ifr_ifru.ifru_broadaddr /* broadcast address */
250 #define ifr_flags ifr_ifru.ifru_flags[0] /* flags (low 16 bits) */
251 #define ifr_flagshigh ifr_ifru.ifru_flags[1] /* flags (high 16 bits) */
252 #define ifr_metric ifr_ifru.ifru_metric /* metric */
253 #define ifr_mtu ifr_ifru.ifru_mtu /* mtu */
254 #define ifr_phys ifr_ifru.ifru_phys /* physical wire */
255 #define ifr_media ifr_ifru.ifru_media /* physical media */
256 #define ifr_data ifr_ifru.ifru_data /* for use by interface */
257 #define ifr_reqcap ifr_ifru.ifru_cap[0] /* requested capabilities */
258 #define ifr_curcap ifr_ifru.ifru_cap[1] /* current capabilities */
259 #define ifr_index ifr_ifru.ifru_index /* interface index */
260 };
261
262 #define _SIZEOF_ADDR_IFREQ(ifr) \
263 ((ifr).ifr_addr.sa_len > sizeof(struct sockaddr) ? \
264 (sizeof(struct ifreq) - sizeof(struct sockaddr) + \
265 (ifr).ifr_addr.sa_len) : sizeof(struct ifreq))
266
267 struct ifaliasreq {
268 char ifra_name[IFNAMSIZ]; /* if name, e.g. "en0" */
269 struct sockaddr ifra_addr;
270 struct sockaddr ifra_broadaddr;
271 struct sockaddr ifra_mask;
272 };
273
274 struct ifmediareq {
275 char ifm_name[IFNAMSIZ]; /* if name, e.g. "en0" */
276 int ifm_current; /* current media options */
277 int ifm_mask; /* don't care mask */
278 int ifm_status; /* media status */
279 int ifm_active; /* active options */
280 int ifm_count; /* # entries in ifm_ulist array */
281 int *ifm_ulist; /* media words */
282 };
283
284 /*
285 * Structure used to retrieve aux status data from interfaces.
286 * Kernel suppliers to this interface should respect the formatting
287 * needed by ifconfig(8): each line starts with a TAB and ends with
288 * a newline. The canonical example to copy and paste is in if_tun.c.
289 */
290
291 #define IFSTATMAX 800 /* 10 lines of text */
292 struct ifstat {
293 char ifs_name[IFNAMSIZ]; /* if name, e.g. "en0" */
294 char ascii[IFSTATMAX + 1];
295 };
296
297 /*
298 * Structure used in SIOCGIFCONF request.
299 * Used to retrieve interface configuration
300 * for machine (useful for programs which
301 * must know all networks accessible).
302 */
303 struct ifconf {
304 int ifc_len; /* size of associated buffer */
305 union {
306 caddr_t ifcu_buf;
307 struct ifreq *ifcu_req;
308 } ifc_ifcu;
309 #define ifc_buf ifc_ifcu.ifcu_buf /* buffer address */
310 #define ifc_req ifc_ifcu.ifcu_req /* array of structures returned */
311 };
312
313
314 /*
315 * Structure for SIOC[AGD]LIFADDR
316 */
317 struct if_laddrreq {
318 char iflr_name[IFNAMSIZ];
319 u_int flags;
320 #define IFLR_PREFIX 0x8000 /* in: prefix given out: kernel fills id */
321 u_int prefixlen; /* in/out */
322 struct sockaddr_storage addr; /* in/out */
323 struct sockaddr_storage dstaddr; /* out */
324 };
325
326 #endif /* __BSD_VISIBLE */
327
328 #ifdef _KERNEL
329 #ifdef MALLOC_DECLARE
330 MALLOC_DECLARE(M_IFADDR);
331 MALLOC_DECLARE(M_IFMADDR);
332 #endif
333 #endif
334
335 #ifndef _KERNEL
336 struct if_nameindex {
337 unsigned int if_index; /* 1, 2, ... */
338 char *if_name; /* null terminated name: "le0", ... */
339 };
340
341 __BEGIN_DECLS
342 void if_freenameindex(struct if_nameindex *);
343 char *if_indextoname(unsigned int, char *);
344 struct if_nameindex *if_nameindex(void);
345 unsigned int if_nametoindex(const char *);
346 __END_DECLS
347 #endif
348
349 #ifdef _KERNEL
350 struct thread;
351
352 /* XXX - this should go away soon. */
353 #include <net/if_var.h>
354 #endif
355
356 #endif /* !_NET_IF_H_ */
Cache object: c2441ddb101e94f3751b502be59d97d8
|