6f500f71b7a97e21acfe89c72e9b53e6035e29f1
[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. 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
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
50 #ifdef _KERNEL
51
52 #ifndef _SYS_QUEUE_H_
53 #include <sys/queue.h>
54 #endif
55
56 #endif
57
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 */
64 #define LINK_STATE_IS_UP(_s)    ((_s) >= LINK_STATE_UP)
65
66 struct 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
74 #define         IF_MAXUNIT      0x7fff          /* if_unit is 15bits */
75
76 /*
77  * Structure used to query names of interface cloners.
78  * XXX should be moved to net/if_clone.h
79  */
80 struct 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  */
90 struct 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) */
100         u_long  ifi_link_state;         /* current link state */
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 */
136 #define IFF_POLLING     0x10000         /* Interface is in polling mode. */
137 #define IFF_PPROMISC    0x20000         /* user-requested promisc mode */
138 #define IFF_MONITOR     0x40000         /* user-requested monitor mode */
139 #define IFF_STATICARP   0x80000         /* static ARP */
140 #define IFF_NPOLLING    0x100000        /* ifpoll is used */
141
142 /* flags set internally only: */
143 #define IFF_CANTCHANGE \
144         (IFF_BROADCAST|IFF_POINTOPOINT|IFF_RUNNING|IFF_OACTIVE|\
145          IFF_SIMPLEX|IFF_MULTICAST|IFF_ALLMULTI|IFF_SMART|IFF_POLLING|\
146          IFF_NPOLLING)
147
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
156 /* Capabilities that interfaces can advertise. */
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 */
165
166 #define IFCAP_HWCSUM    (IFCAP_RXCSUM | IFCAP_TXCSUM)
167
168
169 #define IFQ_MAXLEN      50
170 #define IFNET_SLOWHZ    1               /* granularity is 1 second */
171
172 /*
173  * Message format for use in obtaining information about interfaces
174  * from getkerninfo and the routing socket
175  */
176 struct if_msghdr {
177         u_short ifm_msglen;     /* to skip over non-understood messages */
178         u_char  ifm_version;    /* future binary compatibility */
179         u_char  ifm_type;       /* message type */
180         int     ifm_addrs;      /* like rtm_addrs */
181         int     ifm_flags;      /* value of if_flags */
182         u_short ifm_index;      /* index for associated ifp */
183         struct  if_data ifm_data;/* statistics and other data about if */
184 };
185
186 /*
187  * Message format for use in obtaining information about interface addresses
188  * from getkerninfo and the routing socket
189  */
190 struct ifa_msghdr {
191         u_short ifam_msglen;    /* to skip over non-understood messages */
192         u_char  ifam_version;   /* future binary compatibility */
193         u_char  ifam_type;      /* message type */
194         int     ifam_addrs;     /* like rtm_addrs */
195         int     ifam_flags;     /* value of ifa_flags */
196         u_short ifam_index;     /* index for associated ifp */
197         int     ifam_metric;    /* value of ifa_metric */
198 };
199
200 /*
201  * Message format for use in obtaining information about multicast addresses
202  * from the routing socket
203  */
204 struct ifma_msghdr {
205         u_short ifmam_msglen;   /* to skip over non-understood messages */
206         u_char  ifmam_version;  /* future binary compatibility */
207         u_char  ifmam_type;     /* message type */
208         int     ifmam_addrs;    /* like rtm_addrs */
209         int     ifmam_flags;    /* value of ifa_flags */
210         u_short ifmam_index;    /* index for associated ifp */
211 };
212
213 /*
214  * Message format announcing the arrival or departure of a network interface.
215  */
216 struct if_announcemsghdr {
217         u_short ifan_msglen;    /* to skip over non-understood messages */
218         u_char  ifan_version;   /* future binary compatibility */
219         u_char  ifan_type;      /* message type */
220         u_short ifan_index;     /* index for associated ifp */
221         char    ifan_name[IFNAMSIZ]; /* if name, e.g. "en0" */
222         u_short ifan_what;      /* what type of announcement */
223 };
224
225 #define IFAN_ARRIVAL    0       /* interface arrival */
226 #define IFAN_DEPARTURE  1       /* interface departure */
227
228 /*
229  * Interface request structure used for socket
230  * ioctl's.  All interface ioctl's must have parameter
231  * definitions which begin with ifr_name.  The
232  * remainder may be interface specific.
233  */
234 struct  ifreq {
235         char    ifr_name[IFNAMSIZ];             /* if name, e.g. "en0" */
236         union {
237                 struct  sockaddr ifru_addr;
238                 struct  sockaddr ifru_dstaddr;
239                 struct  sockaddr ifru_broadaddr;
240                 short   ifru_flags[2];
241                 short   ifru_index;
242                 int     ifru_metric;
243                 int     ifru_mtu;
244                 int     ifru_phys;
245                 int     ifru_media;
246                 void   *ifru_data;
247                 int     ifru_cap[2];
248                 int     ifru_pollcpu;
249         } ifr_ifru;
250 #define ifr_addr        ifr_ifru.ifru_addr      /* address */
251 #define ifr_dstaddr     ifr_ifru.ifru_dstaddr   /* other end of p-to-p link */
252 #define ifr_broadaddr   ifr_ifru.ifru_broadaddr /* broadcast address */
253 #define ifr_flags       ifr_ifru.ifru_flags[0]  /* flags (low 16 bits) */
254 #define ifr_flagshigh   ifr_ifru.ifru_flags[1]  /* flags (high 16 bits) */
255 #define ifr_metric      ifr_ifru.ifru_metric    /* metric */
256 #define ifr_mtu         ifr_ifru.ifru_mtu       /* mtu */
257 #define ifr_phys        ifr_ifru.ifru_phys      /* physical wire */
258 #define ifr_media       ifr_ifru.ifru_media     /* physical media */
259 #define ifr_data        ifr_ifru.ifru_data      /* for use by interface */
260 #define ifr_reqcap      ifr_ifru.ifru_cap[0]    /* requested capabilities */
261 #define ifr_curcap      ifr_ifru.ifru_cap[1]    /* current capabilities */
262 #define ifr_index       ifr_ifru.ifru_index     /* interface index */
263 #define ifr_pollcpu     ifr_ifru.ifru_pollcpu   /* polling(4) cpu */
264 };
265
266 #define _SIZEOF_ADDR_IFREQ(ifr) \
267         ((ifr).ifr_addr.sa_len > sizeof(struct sockaddr) ? \
268          (sizeof(struct ifreq) - sizeof(struct sockaddr) + \
269           (ifr).ifr_addr.sa_len) : sizeof(struct ifreq))
270
271 struct ifaliasreq {
272         char    ifra_name[IFNAMSIZ];            /* if name, e.g. "en0" */
273         struct  sockaddr ifra_addr;
274         struct  sockaddr ifra_broadaddr;
275         struct  sockaddr ifra_mask;
276 };
277
278 struct ifmediareq {
279         char    ifm_name[IFNAMSIZ];     /* if name, e.g. "en0" */
280         int     ifm_current;            /* current media options */
281         int     ifm_mask;               /* don't care mask */
282         int     ifm_status;             /* media status */
283         int     ifm_active;             /* active options */
284         int     ifm_count;              /* # entries in ifm_ulist array */
285         int     *ifm_ulist;             /* media words */
286 };
287
288 struct  ifdrv {
289         char            ifd_name[IFNAMSIZ];     /* if name, e.g. "en0" */
290         unsigned long   ifd_cmd;
291         size_t          ifd_len;
292         void            *ifd_data;
293 };
294
295 /* 
296  * Structure used to retrieve aux status data from interfaces.
297  * Kernel suppliers to this interface should respect the formatting
298  * needed by ifconfig(8): each line starts with a TAB and ends with
299  * a newline.  The canonical example to copy and paste is in if_tun.c.
300  */
301
302 #define IFSTATMAX       800             /* 10 lines of text */
303 struct ifstat {
304         char    ifs_name[IFNAMSIZ];     /* if name, e.g. "en0" */
305         char    ascii[IFSTATMAX + 1];
306 };
307
308 /*
309  * Structure used in SIOCGIFCONF request.
310  * Used to retrieve interface configuration
311  * for machine (useful for programs which
312  * must know all networks accessible).
313  */
314 struct  ifconf {
315         int     ifc_len;                /* size of associated buffer */
316         union {
317                 caddr_t ifcu_buf;
318                 struct  ifreq *ifcu_req;
319         } ifc_ifcu;
320 #define ifc_buf ifc_ifcu.ifcu_buf       /* buffer address */
321 #define ifc_req ifc_ifcu.ifcu_req       /* array of structures returned */
322 };
323
324 /*
325  * interface groups
326  */
327
328 #define IFG_ALL         "all"           /* group contains all interfaces */
329 /* XXX: will we implement this? */
330 #define IFG_EGRESS      "egress"        /* if(s) default route(s) point to */
331
332 struct ifg_req {
333         union {
334                 char                     ifgrqu_group[IFNAMSIZ];
335                 char                     ifgrqu_member[IFNAMSIZ];
336         } ifgrq_ifgrqu;
337 #define ifgrq_group     ifgrq_ifgrqu.ifgrqu_group
338 #define ifgrq_member    ifgrq_ifgrqu.ifgrqu_member
339 };
340
341 /*
342  * Used to lookup groups for an interface
343  */
344 struct ifgroupreq {
345         char    ifgr_name[IFNAMSIZ];
346         u_int   ifgr_len;
347         union {
348                 char    ifgru_group[IFNAMSIZ];
349                 struct  ifg_req *ifgru_groups;
350         } ifgr_ifgru;
351 #define ifgr_group      ifgr_ifgru.ifgru_group
352 #define ifgr_groups     ifgr_ifgru.ifgru_groups
353 };
354
355 /*
356  * Structure for SIOC[AGD]LIFADDR
357  */
358 struct if_laddrreq {
359         char    iflr_name[IFNAMSIZ];
360         u_int   flags;
361 #define IFLR_PREFIX     0x8000  /* in: prefix given  out: kernel fills id */
362         u_int   prefixlen;         /* in/out */
363         struct  sockaddr_storage addr;   /* in/out */
364         struct  sockaddr_storage dstaddr; /* out */
365 };
366
367 #ifndef _KERNEL
368 struct if_nameindex {
369         u_int    if_index;      /* 1, 2, ... */
370         char    *if_name;       /* null terminated name: "lnc0", ... */
371 };
372
373 __BEGIN_DECLS
374 u_int    if_nametoindex (const char *);
375 char    *if_indextoname(u_int, char *);
376 struct   if_nameindex *if_nameindex (void);
377 void     if_freenameindex (struct if_nameindex *);
378 __END_DECLS
379 #endif
380
381 #ifdef _KERNEL
382 struct thread;
383 struct ucred;
384
385 int     prison_if (struct ucred *cred, struct sockaddr *sa);
386
387 /* XXX - this should go away soon. */
388 #include <net/if_var.h>
389 #endif
390
391 #endif /* !_NET_IF_H_ */