kernel: IFCAP_TSO is really IPv4-specific
[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 $
35 */
36
37#ifndef _NET_IF_H_
38#define _NET_IF_H_
39
1bd40720
MD
40#ifndef _SYS_TYPES_H_
41#include <sys/types.h>
42#endif
43#ifndef _SYS_TIME_H_
44#include <sys/time.h>
45#endif
46#ifndef _SYS_SOCKET_H_
47#include <sys/socket.h>
48#endif
49
984263bc 50#ifdef _KERNEL
1bd40720
MD
51
52#ifndef _SYS_QUEUE_H_
984263bc
MD
53#include <sys/queue.h>
54#endif
55
984263bc
MD
56#endif
57
6de83abe
SZ
58/*
59 * Values for if_link_state.
60 */
61#define LINK_STATE_UNKNOWN 0 /* link invalid/unknown */
62#define LINK_STATE_DOWN 1 /* link is down */
63#define LINK_STATE_UP 2 /* link is up */
846204b6 64#define LINK_STATE_IS_UP(_s) ((_s) >= LINK_STATE_UP)
6de83abe 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 */
b1cbfcfa 101 uint64_t ifi_baudrate; /* linespeed */
984263bc
MD
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 */
07813904 139#define IFF_STATICARP 0x80000 /* static ARP */
b3a7093f 140#define IFF_NPOLLING 0x100000 /* ifpoll is used */
984263bc
MD
141
142/* flags set internally only: */
143#define IFF_CANTCHANGE \
144 (IFF_BROADCAST|IFF_POINTOPOINT|IFF_RUNNING|IFF_OACTIVE|\
b3a7093f
SZ
145 IFF_SIMPLEX|IFF_MULTICAST|IFF_ALLMULTI|IFF_SMART|IFF_POLLING|\
146 IFF_NPOLLING)
984263bc 147
56ba60b1
JS
148/*
149 * Some convenience macros used for setting ifi_baudrate.
150 * XXX 1000 vs. 1024? --thorpej@netbsd.org
151 */
152#define IF_Kbps(x) ((x) * 1000) /* kilobits/sec. */
153#define IF_Mbps(x) (IF_Kbps((x) * 1000)) /* megabits/sec. */
154#define IF_Gbps(x) (IF_Mbps((x) * 1000)) /* gigabits/sec. */
155
984263bc 156/* Capabilities that interfaces can advertise. */
0a702a62
MN
157#define IFCAP_RXCSUM 0x00001 /* can offload checksum on RX */
158#define IFCAP_TXCSUM 0x00002 /* can offload checksum on TX */
159#define IFCAP_NETCONS 0x00004 /* can be a network console */
160#define IFCAP_VLAN_MTU 0x00008 /* VLAN-compatible MTU */
161#define IFCAP_VLAN_HWTAGGING 0x00010 /* hardware VLAN tag support */
162#define IFCAP_JUMBO_MTU 0x00020 /* 9000 byte MTU support */
163#define IFCAP_RSS 0x00040 /* Receive Side Scaling for IPv4 */
164#define IFCAP_VLAN_HWCSUM 0x00080 /* can do IFCAP_HWCSUM on VLANs */
46117e3e
FT
165#define IFCAP_TSO4 0x00100 /* can offload TCP segmentation */
166#define IFCAP_TSO IFCAP_TSO4
167#define IFCAP_TSO6 0x00200 /* can offload TCP6 segmentation */
0a702a62
MN
168
169#define IFCAP_HWCSUM (IFCAP_RXCSUM | IFCAP_TXCSUM)
0a702a62 170
984263bc
MD
171
172#define IFQ_MAXLEN 50
173#define IFNET_SLOWHZ 1 /* granularity is 1 second */
174
175/*
176 * Message format for use in obtaining information about interfaces
177 * from getkerninfo and the routing socket
178 */
179struct if_msghdr {
180 u_short ifm_msglen; /* to skip over non-understood messages */
9a7c6212 181 u_char ifm_version; /* future binary compatibility */
984263bc
MD
182 u_char ifm_type; /* message type */
183 int ifm_addrs; /* like rtm_addrs */
184 int ifm_flags; /* value of if_flags */
185 u_short ifm_index; /* index for associated ifp */
186 struct if_data ifm_data;/* statistics and other data about if */
187};
188
189/*
190 * Message format for use in obtaining information about interface addresses
191 * from getkerninfo and the routing socket
192 */
193struct ifa_msghdr {
194 u_short ifam_msglen; /* to skip over non-understood messages */
9a7c6212 195 u_char ifam_version; /* future binary compatibility */
984263bc
MD
196 u_char ifam_type; /* message type */
197 int ifam_addrs; /* like rtm_addrs */
198 int ifam_flags; /* value of ifa_flags */
199 u_short ifam_index; /* index for associated ifp */
200 int ifam_metric; /* value of ifa_metric */
201};
202
203/*
204 * Message format for use in obtaining information about multicast addresses
205 * from the routing socket
206 */
207struct ifma_msghdr {
208 u_short ifmam_msglen; /* to skip over non-understood messages */
9a7c6212 209 u_char ifmam_version; /* future binary compatibility */
984263bc
MD
210 u_char ifmam_type; /* message type */
211 int ifmam_addrs; /* like rtm_addrs */
212 int ifmam_flags; /* value of ifa_flags */
213 u_short ifmam_index; /* index for associated ifp */
214};
215
216/*
217 * Message format announcing the arrival or departure of a network interface.
218 */
219struct if_announcemsghdr {
220 u_short ifan_msglen; /* to skip over non-understood messages */
221 u_char ifan_version; /* future binary compatibility */
222 u_char ifan_type; /* message type */
223 u_short ifan_index; /* index for associated ifp */
224 char ifan_name[IFNAMSIZ]; /* if name, e.g. "en0" */
225 u_short ifan_what; /* what type of announcement */
226};
227
228#define IFAN_ARRIVAL 0 /* interface arrival */
229#define IFAN_DEPARTURE 1 /* interface departure */
230
231/*
232 * Interface request structure used for socket
233 * ioctl's. All interface ioctl's must have parameter
234 * definitions which begin with ifr_name. The
235 * remainder may be interface specific.
236 */
237struct ifreq {
238 char ifr_name[IFNAMSIZ]; /* if name, e.g. "en0" */
239 union {
240 struct sockaddr ifru_addr;
241 struct sockaddr ifru_dstaddr;
242 struct sockaddr ifru_broadaddr;
243 short ifru_flags[2];
12b71966 244 short ifru_index;
984263bc
MD
245 int ifru_metric;
246 int ifru_mtu;
247 int ifru_phys;
248 int ifru_media;
f23061d4 249 void *ifru_data;
984263bc 250 int ifru_cap[2];
1630efc5 251 int ifru_pollcpu;
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 */
260#define ifr_phys ifr_ifru.ifru_phys /* physical wire */
261#define ifr_media ifr_ifru.ifru_media /* physical media */
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 */
1630efc5 266#define ifr_pollcpu ifr_ifru.ifru_pollcpu /* polling(4) cpu */
984263bc
MD
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
70224baa
JL
327/*
328 * interface groups
329 */
330
331#define IFG_ALL "all" /* group contains all interfaces */
332/* XXX: will we implement this? */
333#define IFG_EGRESS "egress" /* if(s) default route(s) point to */
334
335struct ifg_req {
336 union {
337 char ifgrqu_group[IFNAMSIZ];
338 char ifgrqu_member[IFNAMSIZ];
339 } ifgrq_ifgrqu;
340#define ifgrq_group ifgrq_ifgrqu.ifgrqu_group
341#define ifgrq_member ifgrq_ifgrqu.ifgrqu_member
342};
343
344/*
345 * Used to lookup groups for an interface
346 */
347struct ifgroupreq {
348 char ifgr_name[IFNAMSIZ];
349 u_int ifgr_len;
350 union {
351 char ifgru_group[IFNAMSIZ];
352 struct ifg_req *ifgru_groups;
353 } ifgr_ifgru;
354#define ifgr_group ifgr_ifgru.ifgru_group
355#define ifgr_groups ifgr_ifgru.ifgru_groups
356};
984263bc
MD
357
358/*
359 * Structure for SIOC[AGD]LIFADDR
360 */
361struct if_laddrreq {
362 char iflr_name[IFNAMSIZ];
363 u_int flags;
364#define IFLR_PREFIX 0x8000 /* in: prefix given out: kernel fills id */
365 u_int prefixlen; /* in/out */
366 struct sockaddr_storage addr; /* in/out */
367 struct sockaddr_storage dstaddr; /* out */
368};
369
984263bc
MD
370#ifndef _KERNEL
371struct if_nameindex {
d84c5c7b 372 u_int if_index; /* 1, 2, ... */
ad9f8794 373 char *if_name; /* null terminated name: "lnc0", ... */
984263bc
MD
374};
375
376__BEGIN_DECLS
158abb01 377u_int if_nametoindex (const char *);
9913eb5a 378char *if_indextoname(u_int, char *);
158abb01
RG
379struct if_nameindex *if_nameindex (void);
380void if_freenameindex (struct if_nameindex *);
984263bc
MD
381__END_DECLS
382#endif
383
384#ifdef _KERNEL
dadab5e9 385struct thread;
87de5057 386struct ucred;
984263bc 387
87de5057 388int prison_if (struct ucred *cred, struct sockaddr *sa);
984263bc
MD
389
390/* XXX - this should go away soon. */
391#include <net/if_var.h>
392#endif
393
394#endif /* !_NET_IF_H_ */