Sync with OpenBSD:
[dragonfly.git] / sys / net / if.h
CommitLineData
984263bc
MD
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 * 3. All advertising materials mentioning features or use of this software
14 * must display the following acknowledgement:
15 * This product includes software developed by the University of
16 * California, Berkeley and its contributors.
17 * 4. Neither the name of the University nor the names of its contributors
18 * may be used to endorse or promote products derived from this software
19 * without specific prior written permission.
20 *
21 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
22 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
25 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31 * SUCH DAMAGE.
32 *
33 * @(#)if.h 8.1 (Berkeley) 6/10/93
34 * $FreeBSD: src/sys/net/if.h,v 1.58.2.9 2002/08/30 14:23:38 sobomax Exp $
6de83abe 35 * $DragonFly: src/sys/net/if.h,v 1.18 2007/03/24 05:57:49 sephe Exp $
984263bc
MD
36 */
37
38#ifndef _NET_IF_H_
39#define _NET_IF_H_
40
1bd40720
MD
41#ifndef _SYS_TYPES_H_
42#include <sys/types.h>
43#endif
44#ifndef _SYS_TIME_H_
45#include <sys/time.h>
46#endif
47#ifndef _SYS_SOCKET_H_
48#include <sys/socket.h>
49#endif
50
984263bc 51#ifdef _KERNEL
1bd40720
MD
52
53#ifndef _SYS_QUEUE_H_
984263bc
MD
54#include <sys/queue.h>
55#endif
56
984263bc
MD
57#endif
58
6de83abe
SZ
59/*
60 * Values for if_link_state.
61 */
62#define LINK_STATE_UNKNOWN 0 /* link invalid/unknown */
63#define LINK_STATE_DOWN 1 /* link is down */
64#define LINK_STATE_UP 2 /* link is up */
65
984263bc
MD
66struct ifnet;
67
68/*
69 * Length of interface external name, including terminating '\0'.
70 * Note: this is the same size as a generic device's external name.
71 */
72#define IFNAMSIZ 16
73#define IF_NAMESIZE IFNAMSIZ
b7b982e2 74#define IF_MAXUNIT 0x7fff /* if_unit is 15bits */
984263bc
MD
75
76#ifdef _KERNEL
77/*
78 * Structure describing a `cloning' interface.
79 */
80struct if_clone {
81 LIST_ENTRY(if_clone) ifc_list; /* on list of cloners */
82 const char *ifc_name; /* name of device, e.g. `gif' */
83 size_t ifc_namelen; /* length of name */
b7b982e2
MD
84 int ifc_minifs; /* minimum number of interfaces */
85 int ifc_maxunit; /* maximum unit number */
86 unsigned char *ifc_units; /* bitmap to handle units */
87 int ifc_bmlen; /* bitmap length */
984263bc 88
b7b982e2 89 int (*ifc_create)(struct if_clone *, int);
984263bc
MD
90 void (*ifc_destroy)(struct ifnet *);
91};
92
b7b982e2
MD
93#define IF_CLONE_INITIALIZER(name, create, destroy, minifs, maxunit) \
94 { { 0 }, name, sizeof(name) - 1, minifs, maxunit, NULL, 0, create, destroy }
984263bc
MD
95#endif
96
97/*
98 * Structure used to query names of interface cloners.
99 */
100
101struct if_clonereq {
102 int ifcr_total; /* total cloners (out) */
103 int ifcr_count; /* room for this many in user buffer */
104 char *ifcr_buffer; /* buffer for cloner names */
105};
106
107/*
108 * Structure describing information about an interface
109 * which may be of interest to management entities.
110 */
111struct if_data {
112 /* generic interface information */
113 u_char ifi_type; /* ethernet, tokenring, etc */
114 u_char ifi_physical; /* e.g., AUI, Thinnet, 10base-T, etc */
115 u_char ifi_addrlen; /* media address length */
116 u_char ifi_hdrlen; /* media header length */
117 u_char ifi_recvquota; /* polling quota for receive intrs */
118 u_char ifi_xmitquota; /* polling quota for xmit intrs */
119 u_long ifi_mtu; /* maximum transmission unit */
120 u_long ifi_metric; /* routing metric (external only) */
6de83abe 121 u_long ifi_link_state; /* current link state */
984263bc
MD
122 u_long ifi_baudrate; /* linespeed */
123 /* volatile statistics */
124 u_long ifi_ipackets; /* packets received on interface */
125 u_long ifi_ierrors; /* input errors on interface */
126 u_long ifi_opackets; /* packets sent on interface */
127 u_long ifi_oerrors; /* output errors on interface */
128 u_long ifi_collisions; /* collisions on csma interfaces */
129 u_long ifi_ibytes; /* total number of octets received */
130 u_long ifi_obytes; /* total number of octets sent */
131 u_long ifi_imcasts; /* packets received via multicast */
132 u_long ifi_omcasts; /* packets sent via multicast */
133 u_long ifi_iqdrops; /* dropped on input, this interface */
134 u_long ifi_noproto; /* destined for unsupported protocol */
135 u_long ifi_hwassist; /* HW offload capabilities */
136 u_long ifi_unused; /* XXX was ifi_xmittiming */
137 struct timeval ifi_lastchange; /* time of last administrative change */
138};
139
140#define IFF_UP 0x1 /* interface is up */
141#define IFF_BROADCAST 0x2 /* broadcast address valid */
142#define IFF_DEBUG 0x4 /* turn on debugging */
143#define IFF_LOOPBACK 0x8 /* is a loopback net */
144#define IFF_POINTOPOINT 0x10 /* interface is point-to-point link */
145#define IFF_SMART 0x20 /* interface manages own routes */
146#define IFF_RUNNING 0x40 /* resources allocated */
147#define IFF_NOARP 0x80 /* no address resolution protocol */
148#define IFF_PROMISC 0x100 /* receive all packets */
149#define IFF_ALLMULTI 0x200 /* receive all multicast packets */
150#define IFF_OACTIVE 0x400 /* transmission in progress */
151#define IFF_SIMPLEX 0x800 /* can't hear own transmissions */
152#define IFF_LINK0 0x1000 /* per link layer defined bit */
153#define IFF_LINK1 0x2000 /* per link layer defined bit */
154#define IFF_LINK2 0x4000 /* per link layer defined bit */
155#define IFF_ALTPHYS IFF_LINK2 /* use alternate physical connection */
156#define IFF_MULTICAST 0x8000 /* supports multicast */
984263bc
MD
157#define IFF_POLLING 0x10000 /* Interface is in polling mode. */
158#define IFF_PPROMISC 0x20000 /* user-requested promisc mode */
3a593c54 159#define IFF_MONITOR 0x40000 /* user-requested monitor mode */
984263bc
MD
160
161/* flags set internally only: */
162#define IFF_CANTCHANGE \
163 (IFF_BROADCAST|IFF_POINTOPOINT|IFF_RUNNING|IFF_OACTIVE|\
164 IFF_SIMPLEX|IFF_MULTICAST|IFF_ALLMULTI|IFF_SMART|IFF_POLLING)
165
56ba60b1
JS
166/*
167 * Some convenience macros used for setting ifi_baudrate.
168 * XXX 1000 vs. 1024? --thorpej@netbsd.org
169 */
170#define IF_Kbps(x) ((x) * 1000) /* kilobits/sec. */
171#define IF_Mbps(x) (IF_Kbps((x) * 1000)) /* megabits/sec. */
172#define IF_Gbps(x) (IF_Mbps((x) * 1000)) /* gigabits/sec. */
173
984263bc
MD
174/* Capabilities that interfaces can advertise. */
175#define IFCAP_RXCSUM 0x0001 /* can offload checksum on RX */
176#define IFCAP_TXCSUM 0x0002 /* can offload checksum on TX */
177#define IFCAP_NETCONS 0x0004 /* can be a network console */
56ba60b1
JS
178#define IFCAP_VLAN_MTU 0x0008 /* VLAN-compatible MTU */
179#define IFCAP_VLAN_HWTAGGING 0x0010 /* hardware VLAN tag support */
180#define IFCAP_JUMBO_MTU 0x0020 /* 9000 byte MTU support */
984263bc
MD
181
182#define IFCAP_HWCSUM (IFCAP_RXCSUM | IFCAP_TXCSUM)
183
184#define IFQ_MAXLEN 50
185#define IFNET_SLOWHZ 1 /* granularity is 1 second */
186
187/*
188 * Message format for use in obtaining information about interfaces
189 * from getkerninfo and the routing socket
190 */
191struct if_msghdr {
192 u_short ifm_msglen; /* to skip over non-understood messages */
9a7c6212 193 u_char ifm_version; /* future binary compatibility */
984263bc
MD
194 u_char ifm_type; /* message type */
195 int ifm_addrs; /* like rtm_addrs */
196 int ifm_flags; /* value of if_flags */
197 u_short ifm_index; /* index for associated ifp */
198 struct if_data ifm_data;/* statistics and other data about if */
199};
200
201/*
202 * Message format for use in obtaining information about interface addresses
203 * from getkerninfo and the routing socket
204 */
205struct ifa_msghdr {
206 u_short ifam_msglen; /* to skip over non-understood messages */
9a7c6212 207 u_char ifam_version; /* future binary compatibility */
984263bc
MD
208 u_char ifam_type; /* message type */
209 int ifam_addrs; /* like rtm_addrs */
210 int ifam_flags; /* value of ifa_flags */
211 u_short ifam_index; /* index for associated ifp */
212 int ifam_metric; /* value of ifa_metric */
213};
214
215/*
216 * Message format for use in obtaining information about multicast addresses
217 * from the routing socket
218 */
219struct ifma_msghdr {
220 u_short ifmam_msglen; /* to skip over non-understood messages */
9a7c6212 221 u_char ifmam_version; /* future binary compatibility */
984263bc
MD
222 u_char ifmam_type; /* message type */
223 int ifmam_addrs; /* like rtm_addrs */
224 int ifmam_flags; /* value of ifa_flags */
225 u_short ifmam_index; /* index for associated ifp */
226};
227
228/*
229 * Message format announcing the arrival or departure of a network interface.
230 */
231struct if_announcemsghdr {
232 u_short ifan_msglen; /* to skip over non-understood messages */
233 u_char ifan_version; /* future binary compatibility */
234 u_char ifan_type; /* message type */
235 u_short ifan_index; /* index for associated ifp */
236 char ifan_name[IFNAMSIZ]; /* if name, e.g. "en0" */
237 u_short ifan_what; /* what type of announcement */
238};
239
240#define IFAN_ARRIVAL 0 /* interface arrival */
241#define IFAN_DEPARTURE 1 /* interface departure */
242
243/*
244 * Interface request structure used for socket
245 * ioctl's. All interface ioctl's must have parameter
246 * definitions which begin with ifr_name. The
247 * remainder may be interface specific.
248 */
249struct ifreq {
250 char ifr_name[IFNAMSIZ]; /* if name, e.g. "en0" */
251 union {
252 struct sockaddr ifru_addr;
253 struct sockaddr ifru_dstaddr;
254 struct sockaddr ifru_broadaddr;
255 short ifru_flags[2];
256 int ifru_metric;
257 int ifru_mtu;
258 int ifru_phys;
259 int ifru_media;
f23061d4 260 void *ifru_data;
984263bc
MD
261 int ifru_cap[2];
262 } ifr_ifru;
263#define ifr_addr ifr_ifru.ifru_addr /* address */
264#define ifr_dstaddr ifr_ifru.ifru_dstaddr /* other end of p-to-p link */
265#define ifr_broadaddr ifr_ifru.ifru_broadaddr /* broadcast address */
266#define ifr_flags ifr_ifru.ifru_flags[0] /* flags (low 16 bits) */
267#define ifr_flagshigh ifr_ifru.ifru_flags[1] /* flags (high 16 bits) */
268#define ifr_metric ifr_ifru.ifru_metric /* metric */
269#define ifr_mtu ifr_ifru.ifru_mtu /* mtu */
270#define ifr_phys ifr_ifru.ifru_phys /* physical wire */
271#define ifr_media ifr_ifru.ifru_media /* physical media */
272#define ifr_data ifr_ifru.ifru_data /* for use by interface */
273#define ifr_reqcap ifr_ifru.ifru_cap[0] /* requested capabilities */
274#define ifr_curcap ifr_ifru.ifru_cap[1] /* current capabilities */
275};
276
277#define _SIZEOF_ADDR_IFREQ(ifr) \
278 ((ifr).ifr_addr.sa_len > sizeof(struct sockaddr) ? \
279 (sizeof(struct ifreq) - sizeof(struct sockaddr) + \
280 (ifr).ifr_addr.sa_len) : sizeof(struct ifreq))
281
282struct ifaliasreq {
283 char ifra_name[IFNAMSIZ]; /* if name, e.g. "en0" */
284 struct sockaddr ifra_addr;
285 struct sockaddr ifra_broadaddr;
286 struct sockaddr ifra_mask;
287};
288
289struct ifmediareq {
290 char ifm_name[IFNAMSIZ]; /* if name, e.g. "en0" */
291 int ifm_current; /* current media options */
292 int ifm_mask; /* don't care mask */
293 int ifm_status; /* media status */
294 int ifm_active; /* active options */
295 int ifm_count; /* # entries in ifm_ulist array */
296 int *ifm_ulist; /* media words */
297};
298
db37145f
SS
299struct ifdrv {
300 char ifd_name[IFNAMSIZ]; /* if name, e.g. "en0" */
301 unsigned long ifd_cmd;
302 size_t ifd_len;
303 void *ifd_data;
304};
305
984263bc
MD
306/*
307 * Structure used to retrieve aux status data from interfaces.
308 * Kernel suppliers to this interface should respect the formatting
309 * needed by ifconfig(8): each line starts with a TAB and ends with
310 * a newline. The canonical example to copy and paste is in if_tun.c.
311 */
312
313#define IFSTATMAX 800 /* 10 lines of text */
314struct ifstat {
315 char ifs_name[IFNAMSIZ]; /* if name, e.g. "en0" */
316 char ascii[IFSTATMAX + 1];
317};
318
319/*
320 * Structure used in SIOCGIFCONF request.
321 * Used to retrieve interface configuration
322 * for machine (useful for programs which
323 * must know all networks accessible).
324 */
325struct ifconf {
326 int ifc_len; /* size of associated buffer */
327 union {
328 caddr_t ifcu_buf;
329 struct ifreq *ifcu_req;
330 } ifc_ifcu;
331#define ifc_buf ifc_ifcu.ifcu_buf /* buffer address */
332#define ifc_req ifc_ifcu.ifcu_req /* array of structures returned */
333};
334
335
336/*
337 * Structure for SIOC[AGD]LIFADDR
338 */
339struct if_laddrreq {
340 char iflr_name[IFNAMSIZ];
341 u_int flags;
342#define IFLR_PREFIX 0x8000 /* in: prefix given out: kernel fills id */
343 u_int prefixlen; /* in/out */
344 struct sockaddr_storage addr; /* in/out */
345 struct sockaddr_storage dstaddr; /* out */
346};
347
984263bc
MD
348#ifndef _KERNEL
349struct if_nameindex {
350 u_int if_index; /* 1, 2, ... */
f15db79e 351 const char *if_name; /* null terminated name: "le0", ... */
984263bc
MD
352};
353
354__BEGIN_DECLS
158abb01 355u_int if_nametoindex (const char *);
9913eb5a 356char *if_indextoname(u_int, char *);
158abb01
RG
357struct if_nameindex *if_nameindex (void);
358void if_freenameindex (struct if_nameindex *);
984263bc
MD
359__END_DECLS
360#endif
361
362#ifdef _KERNEL
dadab5e9 363struct thread;
87de5057 364struct ucred;
984263bc 365
87de5057 366int prison_if (struct ucred *cred, struct sockaddr *sa);
984263bc
MD
367
368/* XXX - this should go away soon. */
369#include <net/if_var.h>
370#endif
371
372#endif /* !_NET_IF_H_ */