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