__P() removal
[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  * $DragonFly: src/sys/net/if.h,v 1.5 2003/08/26 20:49:47 rob Exp $
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
47  * helps userland compatability.  (struct timeval ifi_lastchange)
48  */
49 #ifndef _KERNEL
50 #include <sys/time.h>
51 #endif
52
53 struct 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
61
62 #ifdef _KERNEL
63 /*
64  * Structure describing a `cloning' interface.
65  */
66 struct if_clone {
67         LIST_ENTRY(if_clone) ifc_list;  /* on list of cloners */
68         const char *ifc_name;           /* name of device, e.g. `gif' */
69         size_t ifc_namelen;             /* length of name */
70
71         int     (*ifc_create)(struct if_clone *, int *);
72         void    (*ifc_destroy)(struct ifnet *);
73 };
74
75 #define IF_CLONE_INITIALIZER(name, create, destroy)                     \
76         { { 0 }, name, sizeof(name) - 1, create, destroy }
77 #endif
78
79 /*
80  * Structure used to query names of interface cloners.
81  */
82
83 struct if_clonereq {
84         int     ifcr_total;             /* total cloners (out) */
85         int     ifcr_count;             /* room for this many in user buffer */
86         char    *ifcr_buffer;           /* buffer for cloner names */
87 };
88
89 /*
90  * Structure describing information about an interface
91  * which may be of interest to management entities.
92  */
93 struct if_data {
94         /* generic interface information */
95         u_char  ifi_type;               /* ethernet, tokenring, etc */
96         u_char  ifi_physical;           /* e.g., AUI, Thinnet, 10base-T, etc */
97         u_char  ifi_addrlen;            /* media address length */
98         u_char  ifi_hdrlen;             /* media header length */
99         u_char  ifi_recvquota;          /* polling quota for receive intrs */
100         u_char  ifi_xmitquota;          /* polling quota for xmit intrs */
101         u_long  ifi_mtu;                /* maximum transmission unit */
102         u_long  ifi_metric;             /* routing metric (external only) */
103         u_long  ifi_baudrate;           /* linespeed */
104         /* volatile statistics */
105         u_long  ifi_ipackets;           /* packets received on interface */
106         u_long  ifi_ierrors;            /* input errors on interface */
107         u_long  ifi_opackets;           /* packets sent on interface */
108         u_long  ifi_oerrors;            /* output errors on interface */
109         u_long  ifi_collisions;         /* collisions on csma interfaces */
110         u_long  ifi_ibytes;             /* total number of octets received */
111         u_long  ifi_obytes;             /* total number of octets sent */
112         u_long  ifi_imcasts;            /* packets received via multicast */
113         u_long  ifi_omcasts;            /* packets sent via multicast */
114         u_long  ifi_iqdrops;            /* dropped on input, this interface */
115         u_long  ifi_noproto;            /* destined for unsupported protocol */
116         u_long  ifi_hwassist;           /* HW offload capabilities */
117         u_long  ifi_unused;             /* XXX was ifi_xmittiming */
118         struct  timeval ifi_lastchange; /* time of last administrative change */
119 };
120
121 #define IFF_UP          0x1             /* interface is up */
122 #define IFF_BROADCAST   0x2             /* broadcast address valid */
123 #define IFF_DEBUG       0x4             /* turn on debugging */
124 #define IFF_LOOPBACK    0x8             /* is a loopback net */
125 #define IFF_POINTOPOINT 0x10            /* interface is point-to-point link */
126 #define IFF_SMART       0x20            /* interface manages own routes */
127 #define IFF_RUNNING     0x40            /* resources allocated */
128 #define IFF_NOARP       0x80            /* no address resolution protocol */
129 #define IFF_PROMISC     0x100           /* receive all packets */
130 #define IFF_ALLMULTI    0x200           /* receive all multicast packets */
131 #define IFF_OACTIVE     0x400           /* transmission in progress */
132 #define IFF_SIMPLEX     0x800           /* can't hear own transmissions */
133 #define IFF_LINK0       0x1000          /* per link layer defined bit */
134 #define IFF_LINK1       0x2000          /* per link layer defined bit */
135 #define IFF_LINK2       0x4000          /* per link layer defined bit */
136 #define IFF_ALTPHYS     IFF_LINK2       /* use alternate physical connection */
137 #define IFF_MULTICAST   0x8000          /* supports multicast */
138
139 /*
140  * The following flag(s) ought to go in if_flags, but we cannot change
141  * struct ifnet because of binary compatibility, so we store them in
142  * if_ipending, which is not used so far.
143  * If possible, make sure the value is not conflicting with other
144  * IFF flags, so we have an easier time when we want to merge them.
145  */
146 #define IFF_POLLING     0x10000         /* Interface is in polling mode. */
147 #define IFF_PPROMISC    0x20000         /* user-requested promisc mode */
148
149 /* flags set internally only: */
150 #define IFF_CANTCHANGE \
151         (IFF_BROADCAST|IFF_POINTOPOINT|IFF_RUNNING|IFF_OACTIVE|\
152             IFF_SIMPLEX|IFF_MULTICAST|IFF_ALLMULTI|IFF_SMART|IFF_POLLING)
153
154 /* Capabilities that interfaces can advertise. */
155 #define IFCAP_RXCSUM            0x0001  /* can offload checksum on RX */
156 #define IFCAP_TXCSUM            0x0002  /* can offload checksum on TX */
157 #define IFCAP_NETCONS           0x0004  /* can be a network console */
158
159 #define IFCAP_HWCSUM            (IFCAP_RXCSUM | IFCAP_TXCSUM)
160
161 #define IFQ_MAXLEN      50
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 compatability */
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 compatability */
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 compatability */
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                 int     ifru_metric;
234                 int     ifru_mtu;
235                 int     ifru_phys;
236                 int     ifru_media;
237                 caddr_t ifru_data;
238                 int     ifru_cap[2];
239         } ifr_ifru;
240 #define ifr_addr        ifr_ifru.ifru_addr      /* address */
241 #define ifr_dstaddr     ifr_ifru.ifru_dstaddr   /* other end of p-to-p link */
242 #define ifr_broadaddr   ifr_ifru.ifru_broadaddr /* broadcast address */
243 #define ifr_flags       ifr_ifru.ifru_flags[0]  /* flags (low 16 bits) */
244 #define ifr_flagshigh   ifr_ifru.ifru_flags[1]  /* flags (high 16 bits) */
245 #define ifr_metric      ifr_ifru.ifru_metric    /* metric */
246 #define ifr_mtu         ifr_ifru.ifru_mtu       /* mtu */
247 #define ifr_phys        ifr_ifru.ifru_phys      /* physical wire */
248 #define ifr_media       ifr_ifru.ifru_media     /* physical media */
249 #define ifr_data        ifr_ifru.ifru_data      /* for use by interface */
250 #define ifr_reqcap      ifr_ifru.ifru_cap[0]    /* requested capabilities */
251 #define ifr_curcap      ifr_ifru.ifru_cap[1]    /* current capabilities */
252 };
253
254 #define _SIZEOF_ADDR_IFREQ(ifr) \
255         ((ifr).ifr_addr.sa_len > sizeof(struct sockaddr) ? \
256          (sizeof(struct ifreq) - sizeof(struct sockaddr) + \
257           (ifr).ifr_addr.sa_len) : sizeof(struct ifreq))
258
259 struct ifaliasreq {
260         char    ifra_name[IFNAMSIZ];            /* if name, e.g. "en0" */
261         struct  sockaddr ifra_addr;
262         struct  sockaddr ifra_broadaddr;
263         struct  sockaddr ifra_mask;
264 };
265
266 struct ifmediareq {
267         char    ifm_name[IFNAMSIZ];     /* if name, e.g. "en0" */
268         int     ifm_current;            /* current media options */
269         int     ifm_mask;               /* don't care mask */
270         int     ifm_status;             /* media status */
271         int     ifm_active;             /* active options */
272         int     ifm_count;              /* # entries in ifm_ulist array */
273         int     *ifm_ulist;             /* media words */
274 };
275
276 /* 
277  * Structure used to retrieve aux status data from interfaces.
278  * Kernel suppliers to this interface should respect the formatting
279  * needed by ifconfig(8): each line starts with a TAB and ends with
280  * a newline.  The canonical example to copy and paste is in if_tun.c.
281  */
282
283 #define IFSTATMAX       800             /* 10 lines of text */
284 struct ifstat {
285         char    ifs_name[IFNAMSIZ];     /* if name, e.g. "en0" */
286         char    ascii[IFSTATMAX + 1];
287 };
288
289 /*
290  * Structure used in SIOCGIFCONF request.
291  * Used to retrieve interface configuration
292  * for machine (useful for programs which
293  * must know all networks accessible).
294  */
295 struct  ifconf {
296         int     ifc_len;                /* size of associated buffer */
297         union {
298                 caddr_t ifcu_buf;
299                 struct  ifreq *ifcu_req;
300         } ifc_ifcu;
301 #define ifc_buf ifc_ifcu.ifcu_buf       /* buffer address */
302 #define ifc_req ifc_ifcu.ifcu_req       /* array of structures returned */
303 };
304
305
306 /*
307  * Structure for SIOC[AGD]LIFADDR
308  */
309 struct if_laddrreq {
310         char    iflr_name[IFNAMSIZ];
311         u_int   flags;
312 #define IFLR_PREFIX     0x8000  /* in: prefix given  out: kernel fills id */
313         u_int   prefixlen;         /* in/out */
314         struct  sockaddr_storage addr;   /* in/out */
315         struct  sockaddr_storage dstaddr; /* out */
316 };
317
318 #ifdef _KERNEL
319 #ifdef MALLOC_DECLARE
320 MALLOC_DECLARE(M_IFADDR);
321 MALLOC_DECLARE(M_IFMADDR);
322 #endif
323 #endif
324
325 #ifndef _KERNEL
326 struct if_nameindex {
327         u_int   if_index;       /* 1, 2, ... */
328         const char *if_name;    /* null terminated name: "le0", ... */
329 };
330
331 __BEGIN_DECLS
332 u_int    if_nametoindex (const char *);
333 struct   if_nameindex *if_nameindex (void);
334 void     if_freenameindex (struct if_nameindex *);
335 __END_DECLS
336 #endif
337
338 #ifdef _KERNEL
339 struct thread;
340
341 int     prison_if (struct thread *td, struct sockaddr *sa);
342
343 /* XXX - this should go away soon. */
344 #include <net/if_var.h>
345 #endif
346
347 #endif /* !_NET_IF_H_ */