kernel - Zero out syncache_percpu properly
[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.
2c64e990 13 * 3. Neither the name of the University nor the names of its contributors
984263bc
MD
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: src/sys/net/if.h,v 1.58.2.9 2002/08/30 14:23:38 sobomax Exp $
31 */
32
33#ifndef _NET_IF_H_
34#define _NET_IF_H_
35
c0993117 36#include <sys/cdefs.h>
984263bc 37
c0993117 38#if __BSD_VISIBLE
6de83abe 39/*
c0993117
SW
40 * <net/if.h> does not depend on <sys/time.h> on most other systems. This
41 * helps userland compatibility. (struct timeval ifi_lastchange)
6de83abe 42 */
c0993117
SW
43#include <sys/socket.h>
44#ifndef _KERNEL
45#include <sys/time.h>
46#endif
47#endif
984263bc
MD
48
49/*
50 * Length of interface external name, including terminating '\0'.
51 * Note: this is the same size as a generic device's external name.
52 */
c0993117
SW
53#define IF_NAMESIZE 16
54#if __BSD_VISIBLE
55#define IFNAMSIZ IF_NAMESIZE
b7b982e2 56#define IF_MAXUNIT 0x7fff /* if_unit is 15bits */
984263bc 57
984263bc
MD
58/*
59 * Structure used to query names of interface cloners.
65a24520 60 * XXX should be moved to net/if_clone.h
984263bc 61 */
984263bc
MD
62struct if_clonereq {
63 int ifcr_total; /* total cloners (out) */
64 int ifcr_count; /* room for this many in user buffer */
65 char *ifcr_buffer; /* buffer for cloner names */
66};
67
68/*
69 * Structure describing information about an interface
70 * which may be of interest to management entities.
71 */
72struct if_data {
73 /* generic interface information */
74 u_char ifi_type; /* ethernet, tokenring, etc */
75 u_char ifi_physical; /* e.g., AUI, Thinnet, 10base-T, etc */
76 u_char ifi_addrlen; /* media address length */
77 u_char ifi_hdrlen; /* media header length */
78 u_char ifi_recvquota; /* polling quota for receive intrs */
79 u_char ifi_xmitquota; /* polling quota for xmit intrs */
80 u_long ifi_mtu; /* maximum transmission unit */
81 u_long ifi_metric; /* routing metric (external only) */
6de83abe 82 u_long ifi_link_state; /* current link state */
b1cbfcfa 83 uint64_t ifi_baudrate; /* linespeed */
984263bc
MD
84 /* volatile statistics */
85 u_long ifi_ipackets; /* packets received on interface */
86 u_long ifi_ierrors; /* input errors on interface */
87 u_long ifi_opackets; /* packets sent on interface */
88 u_long ifi_oerrors; /* output errors on interface */
89 u_long ifi_collisions; /* collisions on csma interfaces */
90 u_long ifi_ibytes; /* total number of octets received */
91 u_long ifi_obytes; /* total number of octets sent */
92 u_long ifi_imcasts; /* packets received via multicast */
93 u_long ifi_omcasts; /* packets sent via multicast */
94 u_long ifi_iqdrops; /* dropped on input, this interface */
95 u_long ifi_noproto; /* destined for unsupported protocol */
96 u_long ifi_hwassist; /* HW offload capabilities */
6de344ba 97 u_long ifi_oqdrops; /* dropped on input, this interface */
984263bc
MD
98 struct timeval ifi_lastchange; /* time of last administrative change */
99};
100
101#define IFF_UP 0x1 /* interface is up */
102#define IFF_BROADCAST 0x2 /* broadcast address valid */
103#define IFF_DEBUG 0x4 /* turn on debugging */
104#define IFF_LOOPBACK 0x8 /* is a loopback net */
105#define IFF_POINTOPOINT 0x10 /* interface is point-to-point link */
106#define IFF_SMART 0x20 /* interface manages own routes */
107#define IFF_RUNNING 0x40 /* resources allocated */
108#define IFF_NOARP 0x80 /* no address resolution protocol */
109#define IFF_PROMISC 0x100 /* receive all packets */
110#define IFF_ALLMULTI 0x200 /* receive all multicast packets */
9ed293e0 111#define IFF_OACTIVE_COMPAT 0x400 /* was transmission in progress */
984263bc
MD
112#define IFF_SIMPLEX 0x800 /* can't hear own transmissions */
113#define IFF_LINK0 0x1000 /* per link layer defined bit */
114#define IFF_LINK1 0x2000 /* per link layer defined bit */
115#define IFF_LINK2 0x4000 /* per link layer defined bit */
116#define IFF_ALTPHYS IFF_LINK2 /* use alternate physical connection */
117#define IFF_MULTICAST 0x8000 /* supports multicast */
7d255ab8 118#define IFF_POLLING_COMPAT 0x10000 /* was interface is in polling mode */
984263bc 119#define IFF_PPROMISC 0x20000 /* user-requested promisc mode */
3a593c54 120#define IFF_MONITOR 0x40000 /* user-requested monitor mode */
0f07c642
SW
121#define IFF_STATICARP 0x80000 /* static ARP */
122#define IFF_NPOLLING 0x100000 /* interface is in polling mode */
8d0afa86 123#define IFF_IDIRECT 0x200000 /* direct input */
984263bc
MD
124
125/* flags set internally only: */
126#define IFF_CANTCHANGE \
9ed293e0 127 (IFF_BROADCAST|IFF_POINTOPOINT|IFF_RUNNING|IFF_OACTIVE_COMPAT|\
7d255ab8 128 IFF_SIMPLEX|IFF_MULTICAST|IFF_ALLMULTI|IFF_SMART|IFF_POLLING_COMPAT|\
8d0afa86 129 IFF_NPOLLING|IFF_IDIRECT)
984263bc 130
9ed293e0 131#ifndef _KERNEL
7d255ab8
SZ
132/*
133 * User space compat
134 */
0f07c642
SW
135#define IFF_OACTIVE IFF_OACTIVE_COMPAT
136#define IFF_POLLING IFF_POLLING_COMPAT
9ed293e0
SZ
137#endif
138
c0993117
SW
139/*
140 * Values for if_link_state.
141 */
142#define LINK_STATE_UNKNOWN 0 /* link invalid/unknown */
143#define LINK_STATE_DOWN 1 /* link is down */
144#define LINK_STATE_UP 2 /* link is up */
145#define LINK_STATE_IS_UP(_s) ((_s) >= LINK_STATE_UP)
146
56ba60b1
JS
147/*
148 * Some convenience macros used for setting ifi_baudrate.
149 * XXX 1000 vs. 1024? --thorpej@netbsd.org
150 */
151#define IF_Kbps(x) ((x) * 1000) /* kilobits/sec. */
152#define IF_Mbps(x) (IF_Kbps((x) * 1000)) /* megabits/sec. */
153#define IF_Gbps(x) (IF_Mbps((x) * 1000)) /* gigabits/sec. */
154
984263bc 155/* Capabilities that interfaces can advertise. */
0f07c642
SW
156#define IFCAP_RXCSUM 0x00001 /* can offload checksum on RX */
157#define IFCAP_TXCSUM 0x00002 /* can offload checksum on TX */
158#define IFCAP_NETCONS 0x00004 /* can be a network console */
159#define IFCAP_VLAN_MTU 0x00008 /* VLAN-compatible MTU */
160#define IFCAP_VLAN_HWTAGGING 0x00010 /* hardware VLAN tag support */
161#define IFCAP_JUMBO_MTU 0x00020 /* 9000 byte MTU support */
162#define IFCAP_RSS 0x00040 /* Receive Side Scaling for IPv4 */
163#define IFCAP_VLAN_HWCSUM 0x00080 /* can do IFCAP_HWCSUM on VLANs */
164#define IFCAP_TSO4 0x00100 /* can offload TCP segmentation */
165#define IFCAP_TSO IFCAP_TSO4
166#define IFCAP_TSO6 0x00200 /* can offload TCP6 segmentation */
0a702a62 167
0f07c642 168#define IFCAP_HWCSUM (IFCAP_RXCSUM | IFCAP_TXCSUM)
0a702a62 169
984263bc 170
bc8ce7f2 171#define IFQ_MAXLEN 250
984263bc
MD
172#define IFNET_SLOWHZ 1 /* granularity is 1 second */
173
174/*
175 * Message format for use in obtaining information about interfaces
176 * from getkerninfo and the routing socket
177 */
178struct if_msghdr {
179 u_short ifm_msglen; /* to skip over non-understood messages */
9a7c6212 180 u_char ifm_version; /* future binary compatibility */
984263bc
MD
181 u_char ifm_type; /* message type */
182 int ifm_addrs; /* like rtm_addrs */
183 int ifm_flags; /* value of if_flags */
184 u_short ifm_index; /* index for associated ifp */
185 struct if_data ifm_data;/* statistics and other data about if */
186};
187
188/*
189 * Message format for use in obtaining information about interface addresses
190 * from getkerninfo and the routing socket
191 */
192struct ifa_msghdr {
193 u_short ifam_msglen; /* to skip over non-understood messages */
9a7c6212 194 u_char ifam_version; /* future binary compatibility */
984263bc
MD
195 u_char ifam_type; /* message type */
196 int ifam_addrs; /* like rtm_addrs */
197 int ifam_flags; /* value of ifa_flags */
198 u_short ifam_index; /* index for associated ifp */
199 int ifam_metric; /* value of ifa_metric */
200};
201
202/*
203 * Message format for use in obtaining information about multicast addresses
204 * from the routing socket
205 */
206struct ifma_msghdr {
207 u_short ifmam_msglen; /* to skip over non-understood messages */
9a7c6212 208 u_char ifmam_version; /* future binary compatibility */
984263bc
MD
209 u_char ifmam_type; /* message type */
210 int ifmam_addrs; /* like rtm_addrs */
211 int ifmam_flags; /* value of ifa_flags */
212 u_short ifmam_index; /* index for associated ifp */
213};
214
215/*
216 * Message format announcing the arrival or departure of a network interface.
217 */
218struct if_announcemsghdr {
219 u_short ifan_msglen; /* to skip over non-understood messages */
220 u_char ifan_version; /* future binary compatibility */
221 u_char ifan_type; /* message type */
222 u_short ifan_index; /* index for associated ifp */
223 char ifan_name[IFNAMSIZ]; /* if name, e.g. "en0" */
224 u_short ifan_what; /* what type of announcement */
225};
226
227#define IFAN_ARRIVAL 0 /* interface arrival */
228#define IFAN_DEPARTURE 1 /* interface departure */
229
230/*
231 * Interface request structure used for socket
232 * ioctl's. All interface ioctl's must have parameter
233 * definitions which begin with ifr_name. The
234 * remainder may be interface specific.
235 */
236struct ifreq {
237 char ifr_name[IFNAMSIZ]; /* if name, e.g. "en0" */
238 union {
239 struct sockaddr ifru_addr;
240 struct sockaddr ifru_dstaddr;
241 struct sockaddr ifru_broadaddr;
242 short ifru_flags[2];
12b71966 243 short ifru_index;
984263bc
MD
244 int ifru_metric;
245 int ifru_mtu;
246 int ifru_phys;
247 int ifru_media;
f23061d4 248 void *ifru_data;
984263bc 249 int ifru_cap[2];
1630efc5 250 int ifru_pollcpu;
e41e61d5 251 int ifru_tsolen;
984263bc
MD
252 } ifr_ifru;
253#define ifr_addr ifr_ifru.ifru_addr /* address */
254#define ifr_dstaddr ifr_ifru.ifru_dstaddr /* other end of p-to-p link */
255#define ifr_broadaddr ifr_ifru.ifru_broadaddr /* broadcast address */
256#define ifr_flags ifr_ifru.ifru_flags[0] /* flags (low 16 bits) */
257#define ifr_flagshigh ifr_ifru.ifru_flags[1] /* flags (high 16 bits) */
258#define ifr_metric ifr_ifru.ifru_metric /* metric */
259#define ifr_mtu ifr_ifru.ifru_mtu /* mtu */
0f07c642
SW
260#define ifr_phys ifr_ifru.ifru_phys /* physical wire */
261#define ifr_media ifr_ifru.ifru_media /* physical media */
984263bc
MD
262#define ifr_data ifr_ifru.ifru_data /* for use by interface */
263#define ifr_reqcap ifr_ifru.ifru_cap[0] /* requested capabilities */
264#define ifr_curcap ifr_ifru.ifru_cap[1] /* current capabilities */
12b71966 265#define ifr_index ifr_ifru.ifru_index /* interface index */
0f07c642
SW
266#define ifr_pollcpu ifr_ifru.ifru_pollcpu /* deprecated */
267#define ifr_tsolen ifr_ifru.ifru_tsolen /* max TSO length */
984263bc
MD
268};
269
270#define _SIZEOF_ADDR_IFREQ(ifr) \
271 ((ifr).ifr_addr.sa_len > sizeof(struct sockaddr) ? \
272 (sizeof(struct ifreq) - sizeof(struct sockaddr) + \
273 (ifr).ifr_addr.sa_len) : sizeof(struct ifreq))
274
275struct ifaliasreq {
276 char ifra_name[IFNAMSIZ]; /* if name, e.g. "en0" */
277 struct sockaddr ifra_addr;
278 struct sockaddr ifra_broadaddr;
279 struct sockaddr ifra_mask;
280};
281
282struct ifmediareq {
283 char ifm_name[IFNAMSIZ]; /* if name, e.g. "en0" */
284 int ifm_current; /* current media options */
285 int ifm_mask; /* don't care mask */
286 int ifm_status; /* media status */
287 int ifm_active; /* active options */
288 int ifm_count; /* # entries in ifm_ulist array */
289 int *ifm_ulist; /* media words */
290};
291
db37145f
SS
292struct ifdrv {
293 char ifd_name[IFNAMSIZ]; /* if name, e.g. "en0" */
294 unsigned long ifd_cmd;
295 size_t ifd_len;
296 void *ifd_data;
297};
298
984263bc
MD
299/*
300 * Structure used to retrieve aux status data from interfaces.
301 * Kernel suppliers to this interface should respect the formatting
302 * needed by ifconfig(8): each line starts with a TAB and ends with
303 * a newline. The canonical example to copy and paste is in if_tun.c.
304 */
305
306#define IFSTATMAX 800 /* 10 lines of text */
307struct ifstat {
308 char ifs_name[IFNAMSIZ]; /* if name, e.g. "en0" */
309 char ascii[IFSTATMAX + 1];
310};
311
312/*
313 * Structure used in SIOCGIFCONF request.
314 * Used to retrieve interface configuration
315 * for machine (useful for programs which
316 * must know all networks accessible).
317 */
318struct ifconf {
319 int ifc_len; /* size of associated buffer */
320 union {
321 caddr_t ifcu_buf;
322 struct ifreq *ifcu_req;
323 } ifc_ifcu;
324#define ifc_buf ifc_ifcu.ifcu_buf /* buffer address */
325#define ifc_req ifc_ifcu.ifcu_req /* array of structures returned */
326};
327
70224baa
JL
328/*
329 * interface groups
330 */
331
332#define IFG_ALL "all" /* group contains all interfaces */
333/* XXX: will we implement this? */
334#define IFG_EGRESS "egress" /* if(s) default route(s) point to */
335
336struct ifg_req {
337 union {
338 char ifgrqu_group[IFNAMSIZ];
339 char ifgrqu_member[IFNAMSIZ];
340 } ifgrq_ifgrqu;
341#define ifgrq_group ifgrq_ifgrqu.ifgrqu_group
342#define ifgrq_member ifgrq_ifgrqu.ifgrqu_member
343};
344
345/*
346 * Used to lookup groups for an interface
347 */
348struct ifgroupreq {
349 char ifgr_name[IFNAMSIZ];
350 u_int ifgr_len;
351 union {
352 char ifgru_group[IFNAMSIZ];
353 struct ifg_req *ifgru_groups;
354 } ifgr_ifgru;
0f07c642
SW
355#define ifgr_group ifgr_ifgru.ifgru_group
356#define ifgr_groups ifgr_ifgru.ifgru_groups
70224baa 357};
984263bc
MD
358
359/*
360 * Structure for SIOC[AGD]LIFADDR
361 */
362struct if_laddrreq {
363 char iflr_name[IFNAMSIZ];
364 u_int flags;
365#define IFLR_PREFIX 0x8000 /* in: prefix given out: kernel fills id */
366 u_int prefixlen; /* in/out */
367 struct sockaddr_storage addr; /* in/out */
368 struct sockaddr_storage dstaddr; /* out */
369};
c0993117 370#endif /* __BSD_VISIBLE */
984263bc 371
984263bc
MD
372#ifndef _KERNEL
373struct if_nameindex {
c0993117
SW
374 unsigned int if_index; /* 1, 2, ... */
375 char *if_name; /* null terminated name: "lnc0", ... */
984263bc
MD
376};
377
378__BEGIN_DECLS
c0993117
SW
379unsigned int if_nametoindex(const char *);
380char *if_indextoname(unsigned int, char *);
381struct if_nameindex *if_nameindex(void);
382void if_freenameindex(struct if_nameindex *);
984263bc
MD
383__END_DECLS
384#endif
385
386#ifdef _KERNEL
dadab5e9 387struct thread;
87de5057 388struct ucred;
984263bc 389
0f07c642 390int prison_if(struct ucred *cred, struct sockaddr *sa);
984263bc
MD
391
392/* XXX - this should go away soon. */
393#include <net/if_var.h>
394#endif
395
396#endif /* !_NET_IF_H_ */