Merge from vendor branch BIND:
[dragonfly.git] / sys / net / if_var.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  *      From: @(#)if.h  8.1 (Berkeley) 6/10/93
34  * $FreeBSD: src/sys/net/if_var.h,v 1.18.2.16 2003/04/15 18:11:19 fjoe Exp $
35  * $DragonFly: src/sys/net/if_var.h,v 1.36 2006/09/05 00:55:46 dillon Exp $
36  */
37
38 #ifndef _NET_IF_VAR_H_
39 #define _NET_IF_VAR_H_
40
41 #ifndef _SYS_SERIALIZE_H_
42 #include <sys/serialize.h>
43 #endif
44 #ifndef _NET_IF_H_
45 #include <net/if.h>
46 #endif
47
48 /*
49  * Structures defining a network interface, providing a packet
50  * transport mechanism (ala level 0 of the PUP protocols).
51  *
52  * Each interface accepts output datagrams of a specified maximum
53  * length, and provides higher level routines with input datagrams
54  * received from its medium.
55  *
56  * Output occurs when the routine if_output is called, with four parameters:
57  *      ifp->if_output(ifp, m, dst, rt)
58  * Here m is the mbuf chain to be sent and dst is the destination address.
59  * The output routine encapsulates the supplied datagram if necessary,
60  * and then transmits it on its medium.
61  *
62  * On input, each interface unwraps the data received by it, and either
63  * places it on the input queue of a internetwork datagram routine
64  * and posts the associated software interrupt, or passes the datagram to
65  * the routine if_input. It is called with the mbuf chain as parameter:
66  *      ifp->if_input(ifp, m)
67  * The input routine removes the protocol dependent header if necessary.
68  *
69  * Routines exist for locating interfaces by their addresses
70  * or for locating a interface on a certain network, as well as more general
71  * routing and gateway routines maintaining information used to locate
72  * interfaces.  These routines live in the files if.c and route.c
73  */
74
75 /*
76  * Forward structure declarations for function prototypes [sic].
77  */
78 struct  mbuf;
79 struct  proc;
80 struct  rtentry;
81 struct  rt_addrinfo;
82 struct  socket;
83 struct  ether_header;
84 struct  ucred;
85 struct  lwkt_serialize;
86
87 #include <sys/queue.h>          /* get TAILQ macros */
88
89 #include <net/altq/if_altq.h>
90
91 #ifdef _KERNEL
92 #include <sys/eventhandler.h>
93 #include <sys/mbuf.h>
94 #include <sys/systm.h>          /* XXX */
95 #include <sys/thread2.h>
96 #endif /* _KERNEL */
97
98 #define IF_DUNIT_NONE   -1
99
100 TAILQ_HEAD(ifnethead, ifnet);   /* we use TAILQs so that the order of */
101 TAILQ_HEAD(ifaddrhead, ifaddr); /* instantiation is preserved in the list */
102 TAILQ_HEAD(ifprefixhead, ifprefix);
103 LIST_HEAD(ifmultihead, ifmultiaddr);
104
105 /*
106  * Structure defining a queue for a network interface.
107  */
108 struct  ifqueue {
109         struct  mbuf *ifq_head;
110         struct  mbuf *ifq_tail;
111         int     ifq_len;
112         int     ifq_maxlen;
113         int     ifq_drops;
114 };
115
116 /*
117  * Note of DEVICE_POLLING
118  * 1) Any file(*.c) that depends on DEVICE_POLLING supports in this
119  *    file should include opt_polling.h at its beginning.
120  * 2) When struct changes, which are conditioned by DEVICE_POLLING,
121  *    are to be introduced, please keep the struct's size and layout
122  *    same, no matter whether DEVICE_POLLING is defined or not.
123  *    See ifnet.if_poll and ifnet.if_poll_unused for example.
124  */
125
126 #ifdef DEVICE_POLLING
127 enum poll_cmd { POLL_ONLY, POLL_AND_CHECK_STATUS, POLL_DEREGISTER,
128                 POLL_REGISTER };
129 #endif
130
131 /*
132  * Structure defining a network interface.
133  *
134  * (Would like to call this struct ``if'', but C isn't PL/1.)
135  */
136
137 /*
138  * NB: For FreeBSD, it is assumed that each NIC driver's softc starts with  
139  * one of these structures, typically held within an arpcom structure.   
140  * 
141  *      struct <foo>_softc {
142  *              struct arpcom {
143  *                      struct  ifnet ac_if;
144  *                      ...
145  *              } <arpcom> ;
146  *              ...   
147  *      };
148  *
149  * The assumption is used in a number of places, including many
150  * files in sys/net, device drivers, and sys/dev/mii.c:miibus_attach().
151  * 
152  * Unfortunately devices' softc are opaque, so we depend on this layout
153  * to locate the struct ifnet from the softc in the generic code.
154  *
155  * MPSAFE NOTES: 
156  *
157  * ifnet and its related packet queues are protected by if_serializer.
158  * Callers of if_output, if_ioctl, if_start, if_watchdog, if_init, 
159  * if_resolvemulti, and if_poll hold if_serializer.  Device drivers usually
160  * use the same serializer for their interrupt but this is not required.
161  * However, the device driver must be holding if_serializer when it 
162  * calls if_input.  Note that the serializer may be temporarily released
163  * within if_input to avoid a deadlock (e.g. when fast-forwarding or
164  * bridging packets between interfaces).
165  *
166  * If a device driver installs the same serializer for its interrupt
167  * as for ifnet, then the driver only really needs to worry about further
168  * serialization in timeout based entry points.  All other entry points
169  * will already be serialized.  Older ISA drivers still using the old
170  * interrupt infrastructure will have to obtain and release the serializer
171  * in their interrupt routine themselves.
172  */
173 struct ifnet {
174         void    *if_softc;              /* pointer to driver state */
175         TAILQ_ENTRY(ifnet) if_link;     /* all struct ifnets are chained */
176         char    if_xname[IFNAMSIZ];     /* external name (name + unit) */
177         const char *if_dname;           /* driver name */
178         int     if_dunit;               /* unit or IF_DUNIT_NONE */
179         struct  ifaddrhead if_addrhead; /* linked list of addresses per if */
180         int     if_pcount;              /* number of promiscuous listeners */
181         struct  bpf_if *if_bpf;         /* packet filter structure */
182         u_short if_index;               /* numeric abbreviation for this if  */
183         short   if_timer;               /* time 'til if_watchdog called */
184         int     if_flags;               /* up/down, broadcast, etc. */
185         int     if_capabilities;        /* interface capabilities */
186         int     if_capenable;           /* enabled features */
187         void    *if_linkmib;            /* link-type-specific MIB data */
188         size_t  if_linkmiblen;          /* length of above data */
189         struct  if_data if_data;
190         struct  ifmultihead if_multiaddrs; /* multicast addresses configured */
191         int     if_amcount;             /* number of all-multicast requests */
192 /* procedure handles */
193         int     (*if_output)            /* output routine (enqueue) */
194                 (struct ifnet *, struct mbuf *, struct sockaddr *,
195                      struct rtentry *);
196         void    (*if_input)             /* input routine from hardware driver */
197                 (struct ifnet *, struct mbuf *);
198         void    (*if_start)             /* initiate output routine */
199                 (struct ifnet *);
200         int     (*if_ioctl)             /* ioctl routine */
201                 (struct ifnet *, u_long, caddr_t, struct ucred *);
202         void    (*if_watchdog)          /* timer routine */
203                 (struct ifnet *);
204         void    (*if_init)              /* Init routine */
205                 (void *);
206         int     (*if_resolvemulti)      /* validate/resolve multicast */
207                 (struct ifnet *, struct sockaddr **, struct sockaddr *);
208 #ifdef DEVICE_POLLING
209         void    (*if_poll)              /* IFF_POLLING support */
210                 (struct ifnet *, enum poll_cmd, int);
211 #else
212         void    (*if_poll_unused)(void); /* placeholder */
213 #endif
214         struct  ifaltq if_snd;          /* output queue (includes altq) */
215         struct  ifprefixhead if_prefixhead; /* list of prefixes per if */
216         const uint8_t   *if_broadcastaddr;
217         void    *if_bridge;             /* bridge glue */
218         void    *if_afdata[AF_MAX];
219         struct ifaddr   *if_lladdr;
220         struct lwkt_serialize *if_serializer;   /* serializer or MP lock */
221         struct lwkt_serialize if_default_serializer; /* if not supplied */
222 };
223 typedef void if_init_f_t (void *);
224
225 #define if_mtu          if_data.ifi_mtu
226 #define if_type         if_data.ifi_type
227 #define if_physical     if_data.ifi_physical
228 #define if_addrlen      if_data.ifi_addrlen
229 #define if_hdrlen       if_data.ifi_hdrlen
230 #define if_metric       if_data.ifi_metric
231 #define if_baudrate     if_data.ifi_baudrate
232 #define if_hwassist     if_data.ifi_hwassist
233 #define if_ipackets     if_data.ifi_ipackets
234 #define if_ierrors      if_data.ifi_ierrors
235 #define if_opackets     if_data.ifi_opackets
236 #define if_oerrors      if_data.ifi_oerrors
237 #define if_collisions   if_data.ifi_collisions
238 #define if_ibytes       if_data.ifi_ibytes
239 #define if_obytes       if_data.ifi_obytes
240 #define if_imcasts      if_data.ifi_imcasts
241 #define if_omcasts      if_data.ifi_omcasts
242 #define if_iqdrops      if_data.ifi_iqdrops
243 #define if_noproto      if_data.ifi_noproto
244 #define if_lastchange   if_data.ifi_lastchange
245 #define if_recvquota    if_data.ifi_recvquota
246 #define if_xmitquota    if_data.ifi_xmitquota
247 #define if_rawoutput(if, m, sa) if_output(if, m, sa, (struct rtentry *)0)
248
249 /* for compatibility with other BSDs */
250 #define if_addrlist     if_addrhead
251 #define if_list         if_link
252
253 /*
254  * Output queues (ifp->if_snd) and slow device input queues (*ifp->if_slowq)
255  * are queues of messages stored on ifqueue structures
256  * (defined above).  Entries are added to and deleted from these structures
257  * by these macros, which should be called with ipl raised to splimp().
258  */
259 #define IF_QFULL(ifq)           ((ifq)->ifq_len >= (ifq)->ifq_maxlen)
260 #define IF_DROP(ifq)            ((ifq)->ifq_drops++)
261 #define IF_QLEN(ifq)            ((ifq)->ifq_len)
262 #define IF_QEMPTY(ifq)          (IF_QLEN(ifq) == 0)
263 #define IF_ENQUEUE(ifq, m) { \
264         (m)->m_nextpkt = 0; \
265         if ((ifq)->ifq_tail == 0) \
266                 (ifq)->ifq_head = m; \
267         else \
268                 (ifq)->ifq_tail->m_nextpkt = m; \
269         (ifq)->ifq_tail = m; \
270         (ifq)->ifq_len++; \
271 }
272 #define IF_PREPEND(ifq, m) { \
273         (m)->m_nextpkt = (ifq)->ifq_head; \
274         if ((ifq)->ifq_tail == 0) \
275                 (ifq)->ifq_tail = (m); \
276         (ifq)->ifq_head = (m); \
277         (ifq)->ifq_len++; \
278 }
279 #define IF_DEQUEUE(ifq, m) { \
280         (m) = (ifq)->ifq_head; \
281         if (m) { \
282                 if (((ifq)->ifq_head = (m)->m_nextpkt) == 0) \
283                         (ifq)->ifq_tail = 0; \
284                 (m)->m_nextpkt = 0; \
285                 (ifq)->ifq_len--; \
286         } \
287 }
288
289 #define IF_POLL(ifq, m)         ((m) = (ifq)->ifq_head)
290
291 #define IF_DRAIN(ifq) do {                                              \
292         struct mbuf *m;                                                 \
293         while (1) {                                                     \
294                 IF_DEQUEUE(ifq, m);                                     \
295                 if (m == NULL)                                          \
296                         break;                                          \
297                 m_freem(m);                                             \
298         }                                                               \
299 } while (0)
300
301 #ifdef _KERNEL
302
303 /*
304  * DEPRECATED - should not be used by any new driver.  This code uses the
305  * old queueing interface and if_start ABI and does not use the ifp's
306  * serializer.
307  */
308 #define IF_HANDOFF(ifq, m, ifp)                 if_handoff(ifq, m, ifp, 0)
309 #define IF_HANDOFF_ADJ(ifq, m, ifp, adj)        if_handoff(ifq, m, ifp, adj)
310
311 static __inline int
312 if_handoff(struct ifqueue *_ifq, struct mbuf *_m, struct ifnet *_ifp,
313            int _adjust)
314 {
315         int _need_if_start = 0;
316
317         crit_enter(); 
318
319         if (IF_QFULL(_ifq)) {
320                 IF_DROP(_ifq);
321                 crit_exit();
322                 m_freem(_m);
323                 return (0);
324         }
325         if (_ifp != NULL) {
326                 _ifp->if_obytes += _m->m_pkthdr.len + _adjust;
327                 if (_m->m_flags & M_MCAST)
328                         _ifp->if_omcasts++;
329                 _need_if_start = !(_ifp->if_flags & IFF_OACTIVE);
330         }
331         IF_ENQUEUE(_ifq, _m);
332         if (_need_if_start) {
333                 (*_ifp->if_start)(_ifp);
334         }
335         crit_exit();
336         return (1);
337 }
338
339 /*
340  * 72 was chosen below because it is the size of a TCP/IP
341  * header (40) + the minimum mss (32).
342  */
343 #define IF_MINMTU       72
344 #define IF_MAXMTU       65535
345
346 #endif /* _KERNEL */
347
348 /*
349  * The ifaddr structure contains information about one address
350  * of an interface.  They are maintained by the different address families,
351  * are allocated and attached when an address is set, and are linked
352  * together so all addresses for an interface can be located.
353  */
354 struct ifaddr {
355         struct  sockaddr *ifa_addr;     /* address of interface */
356         struct  sockaddr *ifa_dstaddr;  /* other end of p-to-p link */
357 #define ifa_broadaddr   ifa_dstaddr     /* broadcast address interface */
358         struct  sockaddr *ifa_netmask;  /* used to determine subnet */
359         struct  if_data if_data;        /* not all members are meaningful */
360         struct  ifnet *ifa_ifp;         /* back-pointer to interface */
361         TAILQ_ENTRY(ifaddr) ifa_link;   /* queue macro glue */
362         void    (*ifa_rtrequest)        /* check or clean routes (+ or -)'d */
363                 (int, struct rtentry *, struct rt_addrinfo *);
364         u_short ifa_flags;              /* mostly rt_flags for cloning */
365         u_int   ifa_refcnt;             /* references to this structure */
366         int     ifa_metric;             /* cost of going out this interface */
367 #ifdef notdef
368         struct  rtentry *ifa_rt;        /* XXXX for ROUTETOIF ????? */
369 #endif
370         int (*ifa_claim_addr)           /* check if an addr goes to this if */
371                 (struct ifaddr *, struct sockaddr *);
372
373 };
374 #define IFA_ROUTE       RTF_UP          /* route installed */
375
376 /* for compatibility with other BSDs */
377 #define ifa_list        ifa_link
378
379 /*
380  * The prefix structure contains information about one prefix
381  * of an interface.  They are maintained by the different address families,
382  * are allocated and attached when an prefix or an address is set,
383  * and are linked together so all prefixes for an interface can be located.
384  */
385 struct ifprefix {
386         struct  sockaddr *ifpr_prefix;  /* prefix of interface */
387         struct  ifnet *ifpr_ifp;        /* back-pointer to interface */
388         TAILQ_ENTRY(ifprefix) ifpr_list; /* queue macro glue */
389         u_char  ifpr_plen;              /* prefix length in bits */
390         u_char  ifpr_type;              /* protocol dependent prefix type */
391 };
392
393 /*
394  * Multicast address structure.  This is analogous to the ifaddr
395  * structure except that it keeps track of multicast addresses.
396  * Also, the reference count here is a count of requests for this
397  * address, not a count of pointers to this structure.
398  */
399 struct ifmultiaddr {
400         LIST_ENTRY(ifmultiaddr) ifma_link; /* queue macro glue */
401         struct  sockaddr *ifma_addr;    /* address this membership is for */
402         struct  sockaddr *ifma_lladdr;  /* link-layer translation, if any */
403         struct  ifnet *ifma_ifp;        /* back-pointer to interface */
404         u_int   ifma_refcount;          /* reference count */
405         void    *ifma_protospec;        /* protocol-specific state, if any */
406 };
407
408 #ifdef _KERNEL
409 /* interface address change event */
410 typedef void (*ifaddr_event_handler_t)(void *, struct ifnet *);
411 EVENTHANDLER_DECLARE(ifaddr_event, ifaddr_event_handler_t);
412 /* new interface attach event */
413 typedef void (*ifnet_attach_event_handler_t)(void *, struct ifnet *);
414 EVENTHANDLER_DECLARE(ifnet_attach_event, ifnet_attach_event_handler_t);
415 /* interface detach event */
416 typedef void (*ifnet_detach_event_handler_t)(void *, struct ifnet *);
417 EVENTHANDLER_DECLARE(ifnet_detach_event, ifnet_detach_event_handler_t);
418 /* interface clone event */
419 typedef void (*if_clone_event_handler_t)(void *, struct if_clone *);
420 EVENTHANDLER_DECLARE(if_clone_event, if_clone_event_handler_t);
421
422 static __inline void
423 IFAREF(struct ifaddr *_ifa)
424 {
425         ++_ifa->ifa_refcnt;
426 }
427
428 #include <sys/malloc.h>
429
430 MALLOC_DECLARE(M_IFADDR);
431 MALLOC_DECLARE(M_IFMADDR);
432
433 static __inline void
434 IFAFREE(struct ifaddr *_ifa)
435 {
436         if (_ifa->ifa_refcnt <= 0)
437                 kfree(_ifa, M_IFADDR);
438         else
439                 _ifa->ifa_refcnt--;
440 }
441
442 extern  struct ifnethead ifnet;
443 extern struct   ifnet   **ifindex2ifnet;
444 extern  int ifqmaxlen;
445 extern  struct ifnet loif[];
446 extern  int if_index;
447
448 void    ether_ifattach(struct ifnet *, uint8_t *, struct lwkt_serialize *);
449 void    ether_ifattach_bpf(struct ifnet *, uint8_t *, u_int, u_int,
450                         struct lwkt_serialize *);
451 void    ether_ifdetach(struct ifnet *);
452 void    ether_input(struct ifnet *, struct ether_header *, struct mbuf *);
453 void    ether_demux(struct ifnet *, struct ether_header *, struct mbuf *);
454 int     ether_output_frame(struct ifnet *, struct mbuf *);
455 int     ether_ioctl(struct ifnet *, int, caddr_t);
456 uint32_t        ether_crc32_le(const uint8_t *, size_t);
457 uint32_t        ether_crc32_be(const uint8_t *, size_t);
458
459 int     if_addmulti(struct ifnet *, struct sockaddr *, struct ifmultiaddr **);
460 int     if_allmulti(struct ifnet *, int);
461 void    if_attach(struct ifnet *, struct lwkt_serialize *);
462 int     if_delmulti(struct ifnet *, struct sockaddr *);
463 void    if_detach(struct ifnet *);
464 void    if_down(struct ifnet *);
465 void    if_initname(struct ifnet *, const char *, int);
466 int     if_printf(struct ifnet *, const char *, ...) __printflike(2, 3);
467 void    if_route(struct ifnet *, int flag, int fam);
468 int     if_setlladdr(struct ifnet *, const u_char *, int);
469 void    if_unroute(struct ifnet *, int flag, int fam);
470 void    if_up(struct ifnet *);
471 /*void  ifinit(void);*/ /* declared in systm.h for main() */
472 int     ifioctl(struct socket *, u_long, caddr_t, struct ucred *);
473 int     ifpromisc(struct ifnet *, int);
474 struct  ifnet *ifunit(const char *);
475 struct  ifnet *if_withname(struct sockaddr *);
476
477 struct  ifaddr *ifa_ifwithaddr(struct sockaddr *);
478 struct  ifaddr *ifa_ifwithdstaddr(struct sockaddr *);
479 struct  ifaddr *ifa_ifwithnet(struct sockaddr *);
480 struct  ifaddr *ifa_ifwithroute(int, struct sockaddr *, struct sockaddr *);
481 struct  ifaddr *ifaof_ifpforaddr(struct sockaddr *, struct ifnet *);
482
483 struct  ifmultiaddr *ifmaof_ifpforaddr(struct sockaddr *, struct ifnet *);
484 int     if_simloop(struct ifnet *ifp, struct mbuf *m, int af, int hlen);
485
486 void    if_clone_attach(struct if_clone *);
487 void    if_clone_detach(struct if_clone *);
488
489 int     if_clone_create(char *, int);
490 int     if_clone_destroy(const char *);
491
492 #define IF_LLSOCKADDR(ifp)                                              \
493     ((struct sockaddr_dl *)(ifp)->if_lladdr->ifa_addr)
494 #define IF_LLADDR(ifp)  LLADDR(IF_LLSOCKADDR(ifp))
495
496 #ifdef DEVICE_POLLING
497 typedef void poll_handler_t (struct ifnet *ifp, enum poll_cmd cmd, int count);
498 int     ether_poll_register(struct ifnet *);
499 int     ether_poll_deregister(struct ifnet *);
500 void    emergency_poll_enable(const char *);
501 #endif /* DEVICE_POLLING */
502 #endif /* _KERNEL */
503
504 #endif /* !_NET_IF_VAR_H_ */