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