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