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