Deleted Added
sdiff udiff text old ( 128871 ) new ( 130933 )
full compact
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: head/sys/net/if.h 130933 2004-06-22 20:13:25Z brooks $
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
51struct 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
69struct 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 */
79struct 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_long ifi_mtu; /* maximum transmission unit */
89 u_long ifi_metric; /* routing metric (external only) */
90 u_long ifi_baudrate; /* linespeed */
91 /* volatile statistics */
92 u_long ifi_ipackets; /* packets received on interface */
93 u_long ifi_ierrors; /* input errors on interface */
94 u_long ifi_opackets; /* packets sent on interface */
95 u_long ifi_oerrors; /* output errors on interface */
96 u_long ifi_collisions; /* collisions on csma interfaces */
97 u_long ifi_ibytes; /* total number of octets received */
98 u_long ifi_obytes; /* total number of octets sent */
99 u_long ifi_imcasts; /* packets received via multicast */
100 u_long ifi_omcasts; /* packets sent via multicast */
101 u_long ifi_iqdrops; /* dropped on input, this interface */
102 u_long ifi_noproto; /* destined for unsupported protocol */
103 u_long ifi_hwassist; /* HW offload capabilities */
104 u_long ifi_unused; /* XXX was ifi_xmittiming */
105 struct timeval ifi_lastchange; /* time of last administrative change */
106};
107
108#define IFF_UP 0x1 /* interface is up */
109#define IFF_BROADCAST 0x2 /* broadcast address valid */
110#define IFF_DEBUG 0x4 /* turn on debugging */
111#define IFF_LOOPBACK 0x8 /* is a loopback net */
112#define IFF_POINTOPOINT 0x10 /* interface is point-to-point link */
113#define IFF_SMART 0x20 /* interface manages own routes */
114#define IFF_RUNNING 0x40 /* resources allocated */
115#define IFF_NOARP 0x80 /* no address resolution protocol */
116#define IFF_PROMISC 0x100 /* receive all packets */
117#define IFF_ALLMULTI 0x200 /* receive all multicast packets */
118#define IFF_OACTIVE 0x400 /* transmission in progress */
119#define IFF_SIMPLEX 0x800 /* can't hear own transmissions */
120#define IFF_LINK0 0x1000 /* per link layer defined bit */
121#define IFF_LINK1 0x2000 /* per link layer defined bit */
122#define IFF_LINK2 0x4000 /* per link layer defined bit */
123#define IFF_ALTPHYS IFF_LINK2 /* use alternate physical connection */
124#define IFF_MULTICAST 0x8000 /* supports multicast */
125#define IFF_POLLING 0x10000 /* Interface is in polling mode. */
126#define IFF_PPROMISC 0x20000 /* user-requested promisc mode */
127#define IFF_MONITOR 0x40000 /* user-requested monitor mode */
128#define IFF_STATICARP 0x80000 /* static ARP */
129
130/* flags set internally only: */
131#define IFF_CANTCHANGE \
132 (IFF_BROADCAST|IFF_POINTOPOINT|IFF_RUNNING|IFF_OACTIVE|\
133 IFF_SIMPLEX|IFF_MULTICAST|IFF_ALLMULTI|IFF_SMART|IFF_PROMISC|\
134 IFF_POLLING)
135
136/*
137 * Values for if_link_state.
138 */
139#define LINK_STATE_UNKNOWN 0 /* link invalid/unknown */
140#define LINK_STATE_DOWN 1 /* link is down */
141#define LINK_STATE_UP 2 /* link is up */
142
143/*
144 * Some convenience macros used for setting ifi_baudrate.
145 * XXX 1000 vs. 1024? --thorpej@netbsd.org
146 */
147#define IF_Kbps(x) ((x) * 1000) /* kilobits/sec. */
148#define IF_Mbps(x) (IF_Kbps((x) * 1000)) /* megabits/sec. */
149#define IF_Gbps(x) (IF_Mbps((x) * 1000)) /* gigabits/sec. */
150
151/* Capabilities that interfaces can advertise. */
152#define IFCAP_RXCSUM 0x0001 /* can offload checksum on RX */
153#define IFCAP_TXCSUM 0x0002 /* can offload checksum on TX */
154#define IFCAP_NETCONS 0x0004 /* can be a network console */
155#define IFCAP_VLAN_MTU 0x0008 /* VLAN-compatible MTU */
156#define IFCAP_VLAN_HWTAGGING 0x0010 /* hardware VLAN tag support */
157#define IFCAP_JUMBO_MTU 0x0020 /* 9000 byte MTU supported */
158#define IFCAP_POLLING 0x0040 /* driver supports polling */
159
160#define IFCAP_HWCSUM (IFCAP_RXCSUM | IFCAP_TXCSUM)
161
162#define IFQ_MAXLEN 50
163#define IFNET_SLOWHZ 1 /* granularity is 1 second */
164
165/*
166 * Message format for use in obtaining information about interfaces
167 * from getkerninfo and the routing socket
168 */
169struct if_msghdr {
170 u_short ifm_msglen; /* to skip over non-understood messages */
171 u_char ifm_version; /* future binary compatibility */
172 u_char ifm_type; /* message type */
173 int ifm_addrs; /* like rtm_addrs */
174 int ifm_flags; /* value of if_flags */
175 u_short ifm_index; /* index for associated ifp */
176 struct if_data ifm_data;/* statistics and other data about if */
177};
178
179/*
180 * Message format for use in obtaining information about interface addresses
181 * from getkerninfo and the routing socket
182 */
183struct ifa_msghdr {
184 u_short ifam_msglen; /* to skip over non-understood messages */
185 u_char ifam_version; /* future binary compatibility */
186 u_char ifam_type; /* message type */
187 int ifam_addrs; /* like rtm_addrs */
188 int ifam_flags; /* value of ifa_flags */
189 u_short ifam_index; /* index for associated ifp */
190 int ifam_metric; /* value of ifa_metric */
191};
192
193/*
194 * Message format for use in obtaining information about multicast addresses
195 * from the routing socket
196 */
197struct ifma_msghdr {
198 u_short ifmam_msglen; /* to skip over non-understood messages */
199 u_char ifmam_version; /* future binary compatibility */
200 u_char ifmam_type; /* message type */
201 int ifmam_addrs; /* like rtm_addrs */
202 int ifmam_flags; /* value of ifa_flags */
203 u_short ifmam_index; /* index for associated ifp */
204};
205
206/*
207 * Message format announcing the arrival or departure of a network interface.
208 */
209struct if_announcemsghdr {
210 u_short ifan_msglen; /* to skip over non-understood messages */
211 u_char ifan_version; /* future binary compatibility */
212 u_char ifan_type; /* message type */
213 u_short ifan_index; /* index for associated ifp */
214 char ifan_name[IFNAMSIZ]; /* if name, e.g. "en0" */
215 u_short ifan_what; /* what type of announcement */
216};
217
218#define IFAN_ARRIVAL 0 /* interface arrival */
219#define IFAN_DEPARTURE 1 /* interface departure */
220
221/*
222 * Interface request structure used for socket
223 * ioctl's. All interface ioctl's must have parameter
224 * definitions which begin with ifr_name. The
225 * remainder may be interface specific.
226 */
227struct ifreq {
228 char ifr_name[IFNAMSIZ]; /* if name, e.g. "en0" */
229 union {
230 struct sockaddr ifru_addr;
231 struct sockaddr ifru_dstaddr;
232 struct sockaddr ifru_broadaddr;
233 short ifru_flags[2];
234 short ifru_index;
235 int ifru_metric;
236 int ifru_mtu;
237 int ifru_phys;
238 int ifru_media;
239 caddr_t ifru_data;
240 int ifru_cap[2];
241 } ifr_ifru;
242#define ifr_addr ifr_ifru.ifru_addr /* address */
243#define ifr_dstaddr ifr_ifru.ifru_dstaddr /* other end of p-to-p link */
244#define ifr_broadaddr ifr_ifru.ifru_broadaddr /* broadcast address */
245#define ifr_flags ifr_ifru.ifru_flags[0] /* flags (low 16 bits) */
246#define ifr_flagshigh ifr_ifru.ifru_flags[1] /* flags (high 16 bits) */
247#define ifr_metric ifr_ifru.ifru_metric /* metric */
248#define ifr_mtu ifr_ifru.ifru_mtu /* mtu */
249#define ifr_phys ifr_ifru.ifru_phys /* physical wire */
250#define ifr_media ifr_ifru.ifru_media /* physical media */
251#define ifr_data ifr_ifru.ifru_data /* for use by interface */
252#define ifr_reqcap ifr_ifru.ifru_cap[0] /* requested capabilities */
253#define ifr_curcap ifr_ifru.ifru_cap[1] /* current capabilities */
254#define ifr_index ifr_ifru.ifru_index /* interface index */
255};
256
257#define _SIZEOF_ADDR_IFREQ(ifr) \
258 ((ifr).ifr_addr.sa_len > sizeof(struct sockaddr) ? \
259 (sizeof(struct ifreq) - sizeof(struct sockaddr) + \
260 (ifr).ifr_addr.sa_len) : sizeof(struct ifreq))
261
262struct ifaliasreq {
263 char ifra_name[IFNAMSIZ]; /* if name, e.g. "en0" */
264 struct sockaddr ifra_addr;
265 struct sockaddr ifra_broadaddr;
266 struct sockaddr ifra_mask;
267};
268
269struct ifmediareq {
270 char ifm_name[IFNAMSIZ]; /* if name, e.g. "en0" */
271 int ifm_current; /* current media options */
272 int ifm_mask; /* don't care mask */
273 int ifm_status; /* media status */
274 int ifm_active; /* active options */
275 int ifm_count; /* # entries in ifm_ulist array */
276 int *ifm_ulist; /* media words */
277};
278
279/*
280 * Structure used to retrieve aux status data from interfaces.
281 * Kernel suppliers to this interface should respect the formatting
282 * needed by ifconfig(8): each line starts with a TAB and ends with
283 * a newline. The canonical example to copy and paste is in if_tun.c.
284 */
285
286#define IFSTATMAX 800 /* 10 lines of text */
287struct ifstat {
288 char ifs_name[IFNAMSIZ]; /* if name, e.g. "en0" */
289 char ascii[IFSTATMAX + 1];
290};
291
292/*
293 * Structure used in SIOCGIFCONF request.
294 * Used to retrieve interface configuration
295 * for machine (useful for programs which
296 * must know all networks accessible).
297 */
298struct ifconf {
299 int ifc_len; /* size of associated buffer */
300 union {
301 caddr_t ifcu_buf;
302 struct ifreq *ifcu_req;
303 } ifc_ifcu;
304#define ifc_buf ifc_ifcu.ifcu_buf /* buffer address */
305#define ifc_req ifc_ifcu.ifcu_req /* array of structures returned */
306};
307
308
309/*
310 * Structure for SIOC[AGD]LIFADDR
311 */
312struct if_laddrreq {
313 char iflr_name[IFNAMSIZ];
314 u_int flags;
315#define IFLR_PREFIX 0x8000 /* in: prefix given out: kernel fills id */
316 u_int prefixlen; /* in/out */
317 struct sockaddr_storage addr; /* in/out */
318 struct sockaddr_storage dstaddr; /* out */
319};
320
321#endif /* __BSD_VISIBLE */
322
323#ifdef _KERNEL
324#ifdef MALLOC_DECLARE
325MALLOC_DECLARE(M_IFADDR);
326MALLOC_DECLARE(M_IFMADDR);
327#endif
328#endif
329
330#ifndef _KERNEL
331struct if_nameindex {
332 unsigned int if_index; /* 1, 2, ... */
333 char *if_name; /* null terminated name: "le0", ... */
334};
335
336__BEGIN_DECLS
337void if_freenameindex(struct if_nameindex *);
338char *if_indextoname(unsigned int, char *);
339struct if_nameindex *if_nameindex(void);
340unsigned int if_nametoindex(const char *);
341__END_DECLS
342#endif
343
344#ifdef _KERNEL
345struct thread;
346
347/* XXX - this should go away soon. */
348#include <net/if_var.h>
349#endif
350
351#endif /* !_NET_IF_H_ */