c9ecb0b8d2ef1ddc6075f75ab868d8251c1d8938
[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.71 2008/11/22 04:00:53 sephe 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  mbuf_chain;
80 struct  proc;
81 struct  rtentry;
82 struct  rt_addrinfo;
83 struct  socket;
84 struct  ether_header;
85 struct  ucred;
86 struct  lwkt_serialize;
87 struct  ifaddr_container;
88 struct  ifaddr;
89 struct  lwkt_port;
90 struct  lwkt_msg;
91 struct  netmsg;
92 struct  pktinfo;
93
94 #include <sys/queue.h>          /* get TAILQ macros */
95
96 #include <net/altq/if_altq.h>
97
98 #ifdef _KERNEL
99 #include <sys/eventhandler.h>
100 #include <sys/mbuf.h>
101 #include <sys/systm.h>          /* XXX */
102 #include <sys/thread2.h>
103 #endif /* _KERNEL */
104
105 #define IF_DUNIT_NONE   -1
106
107 TAILQ_HEAD(ifnethead, ifnet);   /* we use TAILQs so that the order of */
108 TAILQ_HEAD(ifaddrhead, ifaddr_container); /* instantiation is preserved in the list */
109 TAILQ_HEAD(ifprefixhead, ifprefix);
110 LIST_HEAD(ifmultihead, ifmultiaddr);
111
112 /*
113  * Structure defining a queue for a network interface.
114  */
115 struct  ifqueue {
116         struct  mbuf *ifq_head;
117         struct  mbuf *ifq_tail;
118         int     ifq_len;
119         int     ifq_maxlen;
120         int     ifq_drops;
121 };
122
123 /*
124  * Note of DEVICE_POLLING
125  * 1) Any file(*.c) that depends on DEVICE_POLLING supports in this
126  *    file should include opt_polling.h at its beginning.
127  * 2) When struct changes, which are conditioned by DEVICE_POLLING,
128  *    are to be introduced, please keep the struct's size and layout
129  *    same, no matter whether DEVICE_POLLING is defined or not.
130  *    See ifnet.if_poll and ifnet.if_poll_unused for example.
131  */
132
133 #ifdef DEVICE_POLLING
134 enum poll_cmd { POLL_ONLY, POLL_AND_CHECK_STATUS, POLL_DEREGISTER,
135                 POLL_REGISTER };
136 #endif
137
138 enum ifnet_serialize {
139         IFNET_SERIALIZE_ALL,
140         IFNET_SERIALIZE_MAIN,
141         IFNET_SERIALIZE_TX_BASE = 0x10000000,
142         IFNET_SERIALIZE_RX_BASE = 0x20000000
143 };
144 #define IFNET_SERIALIZE_TX      IFNET_SERIALIZE_TX_BASE
145 #define IFNET_SERIALIZE_RX(i)   (IFNET_SERIALIZE_RX_BASE + (i))
146
147 /*
148  * Structure defining a network interface.
149  *
150  * (Would like to call this struct ``if'', but C isn't PL/1.)
151  */
152
153 /*
154  * NB: For FreeBSD, it is assumed that each NIC driver's softc starts with  
155  * one of these structures, typically held within an arpcom structure.   
156  * 
157  *      struct <foo>_softc {
158  *              struct arpcom {
159  *                      struct  ifnet ac_if;
160  *                      ...
161  *              } <arpcom> ;
162  *              ...   
163  *      };
164  *
165  * The assumption is used in a number of places, including many
166  * files in sys/net, device drivers, and sys/dev/mii.c:miibus_attach().
167  * 
168  * Unfortunately devices' softc are opaque, so we depend on this layout
169  * to locate the struct ifnet from the softc in the generic code.
170  *
171  * MPSAFE NOTES: 
172  *
173  * ifnet is protected by calling if_serialize, if_tryserialize and
174  * if_deserialize serialize functions with the ifnet_serialize parameter.
175  * ifnet.if_snd is protected by its own spinlock.  Callers of if_ioctl,
176  * if_watchdog, if_init, if_resolvemulti, and if_poll should call the
177  * ifnet serialize functions with IFNET_SERIALIZE_ALL.  Callers of if_start
178  * sould call the ifnet serialize functions with IFNET_SERIALIZE_TX.
179  *
180  * FIXME: Device drivers usually use the same serializer for their interrupt
181  * FIXME: but this is not required.
182  *
183  * Caller of if_output must not serialize ifnet by calling ifnet serialize
184  * functions; if_output will call the ifnet serialize functions based on
185  * its own needs.  Caller of if_input does not necessarily hold the related
186  * serializer.
187  *
188  * If a device driver installs the same serializer for its interrupt
189  * as for ifnet, then the driver only really needs to worry about further
190  * serialization in timeout based entry points.  All other entry points
191  * will already be serialized.  Older ISA drivers still using the old
192  * interrupt infrastructure will have to obtain and release the serializer
193  * in their interrupt routine themselves.
194  */
195 struct ifnet {
196         void    *if_softc;              /* pointer to driver state */
197         TAILQ_ENTRY(ifnet) if_link;     /* all struct ifnets are chained */
198         char    if_xname[IFNAMSIZ];     /* external name (name + unit) */
199         const char *if_dname;           /* driver name */
200         int     if_dunit;               /* unit or IF_DUNIT_NONE */
201         void    *if_vlantrunks;         /* vlan trunks */
202         struct  ifaddrhead *if_addrheads; /* array[NCPU] of TAILQs of addresses per if */
203         int     if_pcount;              /* number of promiscuous listeners */
204         void    *if_carp;               /* carp interfaces */
205         struct  bpf_if *if_bpf;         /* packet filter structure */
206         u_short if_index;               /* numeric abbreviation for this if  */
207         short   if_timer;               /* time 'til if_watchdog called */
208         int     if_flags;               /* up/down, broadcast, etc. */
209         int     if_capabilities;        /* interface capabilities */
210         int     if_capenable;           /* enabled features */
211         void    *if_linkmib;            /* link-type-specific MIB data */
212         size_t  if_linkmiblen;          /* length of above data */
213         struct  if_data if_data;
214         struct  ifmultihead if_multiaddrs; /* multicast addresses configured */
215         int     if_amcount;             /* number of all-multicast requests */
216 /* procedure handles */
217         int     (*if_output)            /* output routine (enqueue) */
218                 (struct ifnet *, struct mbuf *, struct sockaddr *,
219                      struct rtentry *);
220         void    (*if_input)             /* input routine from hardware driver */
221                 (struct ifnet *, struct mbuf *);
222         void    (*if_start)             /* initiate output routine */
223                 (struct ifnet *);
224         int     (*if_ioctl)             /* ioctl routine */
225                 (struct ifnet *, u_long, caddr_t, struct ucred *);
226         void    (*if_watchdog)          /* timer routine */
227                 (struct ifnet *);
228         void    (*if_init)              /* Init routine */
229                 (void *);
230         int     (*if_resolvemulti)      /* validate/resolve multicast */
231                 (struct ifnet *, struct sockaddr **, struct sockaddr *);
232         int     (*if_start_cpuid)       /* cpuid to run if_start */
233                 (struct ifnet *);
234 #ifdef DEVICE_POLLING
235         void    (*if_poll)              /* IFF_POLLING support */
236                 (struct ifnet *, enum poll_cmd, int);
237         int     if_poll_cpuid;
238 #else
239         /* Place holders */
240         void    (*if_poll_unused)(void);
241         int     if_poll_cpuid_used;
242 #endif
243         void    (*if_serialize)
244                 (struct ifnet *, enum ifnet_serialize);
245         void    (*if_deserialize)
246                 (struct ifnet *, enum ifnet_serialize);
247         int     (*if_tryserialize)
248                 (struct ifnet *, enum ifnet_serialize);
249 #ifdef INVARIANTS
250         void    (*if_serialize_assert)
251                 (struct ifnet *, enum ifnet_serialize, boolean_t);
252 #else
253         void    (*if_serialize_unused)(void);
254 #endif
255         struct  ifaltq if_snd;          /* output queue (includes altq) */
256         struct  ifprefixhead if_prefixhead; /* list of prefixes per if */
257         const uint8_t   *if_broadcastaddr;
258         void    *if_bridge;             /* bridge glue */
259         void    *if_afdata[AF_MAX];
260         struct ifaddr   *if_lladdr;
261         struct lwkt_serialize *if_serializer;   /* serializer or MP lock */
262         struct lwkt_serialize if_default_serializer; /* if not supplied */
263         int     if_cpuid;
264         struct netmsg *if_start_nmsg; /* percpu messages to schedule if_start */
265 };
266 typedef void if_init_f_t (void *);
267
268 #define if_mtu          if_data.ifi_mtu
269 #define if_type         if_data.ifi_type
270 #define if_physical     if_data.ifi_physical
271 #define if_addrlen      if_data.ifi_addrlen
272 #define if_hdrlen       if_data.ifi_hdrlen
273 #define if_metric       if_data.ifi_metric
274 #define if_link_state   if_data.ifi_link_state
275 #define if_baudrate     if_data.ifi_baudrate
276 #define if_hwassist     if_data.ifi_hwassist
277 #define if_ipackets     if_data.ifi_ipackets
278 #define if_ierrors      if_data.ifi_ierrors
279 #define if_opackets     if_data.ifi_opackets
280 #define if_oerrors      if_data.ifi_oerrors
281 #define if_collisions   if_data.ifi_collisions
282 #define if_ibytes       if_data.ifi_ibytes
283 #define if_obytes       if_data.ifi_obytes
284 #define if_imcasts      if_data.ifi_imcasts
285 #define if_omcasts      if_data.ifi_omcasts
286 #define if_iqdrops      if_data.ifi_iqdrops
287 #define if_noproto      if_data.ifi_noproto
288 #define if_lastchange   if_data.ifi_lastchange
289 #define if_recvquota    if_data.ifi_recvquota
290 #define if_xmitquota    if_data.ifi_xmitquota
291 #define if_rawoutput(if, m, sa) if_output(if, m, sa, NULL)
292
293 /* for compatibility with other BSDs */
294 #define if_list         if_link
295
296
297 /*
298  * Output queues (ifp->if_snd) and slow device input queues (*ifp->if_slowq)
299  * are queues of messages stored on ifqueue structures
300  * (defined above).  Entries are added to and deleted from these structures
301  * by these macros, which should be called with ipl raised to splimp().
302  */
303 #define IF_QFULL(ifq)           ((ifq)->ifq_len >= (ifq)->ifq_maxlen)
304 #define IF_DROP(ifq)            ((ifq)->ifq_drops++)
305 #define IF_QLEN(ifq)            ((ifq)->ifq_len)
306 #define IF_QEMPTY(ifq)          (IF_QLEN(ifq) == 0)
307 #define IF_ENQUEUE(ifq, m) do {                                         \
308         (m)->m_nextpkt = 0;                                             \
309         if ((ifq)->ifq_tail == 0)                                       \
310                 (ifq)->ifq_head = m;                                    \
311         else                                                            \
312                 (ifq)->ifq_tail->m_nextpkt = m;                         \
313         (ifq)->ifq_tail = m;                                            \
314         (ifq)->ifq_len++;                                               \
315 } while (0)
316 #define IF_PREPEND(ifq, m) do {                                         \
317         (m)->m_nextpkt = (ifq)->ifq_head;                               \
318         if ((ifq)->ifq_tail == 0)                                       \
319                 (ifq)->ifq_tail = (m);                                  \
320         (ifq)->ifq_head = (m);                                          \
321         (ifq)->ifq_len++;                                               \
322 } while (0)
323 #define IF_DEQUEUE(ifq, m) do {                                         \
324         (m) = (ifq)->ifq_head;                                          \
325         if (m) {                                                        \
326                 if (((ifq)->ifq_head = (m)->m_nextpkt) == 0)            \
327                         (ifq)->ifq_tail = 0;                            \
328                 (m)->m_nextpkt = 0;                                     \
329                 (ifq)->ifq_len--;                                       \
330         }                                                               \
331 } while (0)
332
333 #define IF_POLL(ifq, m)         ((m) = (ifq)->ifq_head)
334
335 #define IF_DRAIN(ifq) do {                                              \
336         struct mbuf *m;                                                 \
337         while (1) {                                                     \
338                 IF_DEQUEUE(ifq, m);                                     \
339                 if (m == NULL)                                          \
340                         break;                                          \
341                 m_freem(m);                                             \
342         }                                                               \
343 } while (0)
344
345 #ifdef _KERNEL
346
347 #ifdef INVARIANTS
348 #define ASSERT_IFNET_SERIALIZED_ALL(ifp) \
349         (ifp)->if_serialize_assert((ifp), IFNET_SERIALIZE_ALL, TRUE)
350 #define ASSERT_IFNET_NOT_SERIALIZED_ALL(ifp) \
351         (ifp)->if_serialize_assert((ifp), IFNET_SERIALIZE_ALL, FALSE)
352
353 #define ASSERT_IFNET_SERIALIZED_TX(ifp) \
354         (ifp)->if_serialize_assert((ifp), IFNET_SERIALIZE_TX, TRUE)
355 #define ASSERT_IFNET_NOT_SERIALIZED_TX(ifp) \
356         (ifp)->if_serialize_assert((ifp), IFNET_SERIALIZE_TX, FALSE)
357
358 #define ASSERT_IFNET_SERIALIZED_MAIN(ifp) \
359         (ifp)->if_serialize_assert((ifp), IFNET_SERIALIZE_MAIN, TRUE)
360 #define ASSERT_IFNET_NOT_SERIALIZED_MAIN(ifp) \
361         (ifp)->if_serialize_assert((ifp), IFNET_SERIALIZE_MAIN, FALSE)
362 #else
363 #define ASSERT_IFNET_SERIALIZED_ALL(ifp)        ((void)0)
364 #define ASSERT_IFNET_NOT_SERIALIZED_ALL(ifp)    ((void)0)
365 #define ASSERT_IFNET_SERIALIZED_TX(ifp)         ((void)0)
366 #define ASSERT_IFNET_NOT_SERIALIZED_TX(ifp)     ((void)0)
367 #define ASSERT_IFNET_SERIALIZED_MAIN(ifp)       ((void)0)
368 #define ASSERT_IFNET_NOT_SERIALIZED_MAIN(ifp)   ((void)0)
369 #endif
370
371 static __inline void
372 ifnet_serialize_all(struct ifnet *_ifp)
373 {
374         _ifp->if_serialize(_ifp, IFNET_SERIALIZE_ALL);
375 }
376
377 static __inline void
378 ifnet_deserialize_all(struct ifnet *_ifp)
379 {
380         _ifp->if_deserialize(_ifp, IFNET_SERIALIZE_ALL);
381 }
382
383 static __inline int
384 ifnet_tryserialize_all(struct ifnet *_ifp)
385 {
386         return _ifp->if_tryserialize(_ifp, IFNET_SERIALIZE_ALL);
387 }
388
389 static __inline void
390 ifnet_serialize_tx(struct ifnet *_ifp)
391 {
392         _ifp->if_serialize(_ifp, IFNET_SERIALIZE_TX);
393 }
394
395 static __inline void
396 ifnet_deserialize_tx(struct ifnet *_ifp)
397 {
398         _ifp->if_deserialize(_ifp, IFNET_SERIALIZE_TX);
399 }
400
401 static __inline int
402 ifnet_tryserialize_tx(struct ifnet *_ifp)
403 {
404         return _ifp->if_tryserialize(_ifp, IFNET_SERIALIZE_TX);
405 }
406
407 static __inline void
408 ifnet_serialize_main(struct ifnet *_ifp)
409 {
410         _ifp->if_serialize(_ifp, IFNET_SERIALIZE_MAIN);
411 }
412
413 static __inline void
414 ifnet_deserialize_main(struct ifnet *_ifp)
415 {
416         _ifp->if_deserialize(_ifp, IFNET_SERIALIZE_MAIN);
417 }
418
419 static __inline int
420 ifnet_tryserialize_main(struct ifnet *_ifp)
421 {
422         return _ifp->if_tryserialize(_ifp, IFNET_SERIALIZE_MAIN);
423 }
424
425 /*
426  * DEPRECATED - should not be used by any new driver.  This code uses the
427  * old queueing interface and if_start ABI and does not use the ifp's
428  * serializer.
429  */
430 #define IF_HANDOFF(ifq, m, ifp)                 if_handoff(ifq, m, ifp, 0)
431 #define IF_HANDOFF_ADJ(ifq, m, ifp, adj)        if_handoff(ifq, m, ifp, adj)
432
433 static __inline int
434 if_handoff(struct ifqueue *_ifq, struct mbuf *_m, struct ifnet *_ifp,
435            int _adjust)
436 {
437         int _need_if_start = 0;
438
439         crit_enter(); 
440
441         if (IF_QFULL(_ifq)) {
442                 IF_DROP(_ifq);
443                 crit_exit();
444                 m_freem(_m);
445                 return (0);
446         }
447         if (_ifp != NULL) {
448                 _ifp->if_obytes += _m->m_pkthdr.len + _adjust;
449                 if (_m->m_flags & M_MCAST)
450                         _ifp->if_omcasts++;
451                 _need_if_start = !(_ifp->if_flags & IFF_OACTIVE);
452         }
453         IF_ENQUEUE(_ifq, _m);
454         if (_need_if_start) {
455                 (*_ifp->if_start)(_ifp);
456         }
457         crit_exit();
458         return (1);
459 }
460
461 /*
462  * 72 was chosen below because it is the size of a TCP/IP
463  * header (40) + the minimum mss (32).
464  */
465 #define IF_MINMTU       72
466 #define IF_MAXMTU       65535
467
468 #endif /* _KERNEL */
469
470 struct in_ifaddr;
471
472 struct in_ifaddr_container {
473         struct in_ifaddr        *ia;
474         LIST_ENTRY(in_ifaddr_container) ia_hash;
475                                 /* entry in bucket of inet addresses */
476         TAILQ_ENTRY(in_ifaddr_container) ia_link;
477                                 /* list of internet addresses */
478         struct ifaddr_container *ia_ifac; /* parent ifaddr_container */
479 };
480
481 struct ifaddr_container {
482 #define IFA_CONTAINER_MAGIC     0x19810219
483 #define IFA_CONTAINER_DEAD      0xc0dedead
484         uint32_t                ifa_magic;  /* IFA_CONTAINER_MAGIC */
485         struct ifaddr           *ifa;
486         TAILQ_ENTRY(ifaddr_container)   ifa_link;   /* queue macro glue */
487         u_int                   ifa_refcnt; /* references to this structure */
488         uint16_t                ifa_listmask;   /* IFA_LIST_ */
489         uint16_t                ifa_prflags;    /* protocol specific flags */
490
491         /*
492          * Protocol specific states
493          */
494         union {
495                 struct in_ifaddr_container u_in_ifac;
496         } ifa_proto_u;
497 };
498
499 #define IFA_LIST_IFADDRHEAD     0x01    /* on ifnet.if_addrheads[cpuid] */
500 #define IFA_LIST_IN_IFADDRHEAD  0x02    /* on in_ifaddrheads[cpuid] */
501 #define IFA_LIST_IN_IFADDRHASH  0x04    /* on in_ifaddrhashtbls[cpuid] */
502
503 #define IFA_PRF_FLAG0           0x01
504 #define IFA_PRF_FLAG1           0x02
505 #define IFA_PRF_FLAG2           0x04
506 #define IFA_PRF_FLAG3           0x08
507
508 /*
509  * The ifaddr structure contains information about one address
510  * of an interface.  They are maintained by the different address families,
511  * are allocated and attached when an address is set, and are linked
512  * together so all addresses for an interface can be located.
513  */
514 struct ifaddr {
515         struct  sockaddr *ifa_addr;     /* address of interface */
516         struct  sockaddr *ifa_dstaddr;  /* other end of p-to-p link */
517 #define ifa_broadaddr   ifa_dstaddr     /* broadcast address interface */
518         struct  sockaddr *ifa_netmask;  /* used to determine subnet */
519         struct  if_data if_data;        /* not all members are meaningful */
520         struct  ifnet *ifa_ifp;         /* back-pointer to interface */
521         void    *ifa_link_pad;
522         struct ifaddr_container *ifa_containers;
523         void    (*ifa_rtrequest)        /* check or clean routes (+ or -)'d */
524                 (int, struct rtentry *, struct rt_addrinfo *);
525         u_short ifa_flags;              /* mostly rt_flags for cloning */
526         int     ifa_ncnt;               /* # of valid ifaddr_container */
527         int     ifa_metric;             /* cost of going out this interface */
528 #ifdef notdef
529         struct  rtentry *ifa_rt;        /* XXXX for ROUTETOIF ????? */
530 #endif
531         int (*ifa_claim_addr)           /* check if an addr goes to this if */
532                 (struct ifaddr *, struct sockaddr *);
533
534 };
535 #define IFA_ROUTE       RTF_UP          /* route installed */
536
537 /* for compatibility with other BSDs */
538 #define ifa_list        ifa_link
539
540 /*
541  * The prefix structure contains information about one prefix
542  * of an interface.  They are maintained by the different address families,
543  * are allocated and attached when an prefix or an address is set,
544  * and are linked together so all prefixes for an interface can be located.
545  */
546 struct ifprefix {
547         struct  sockaddr *ifpr_prefix;  /* prefix of interface */
548         struct  ifnet *ifpr_ifp;        /* back-pointer to interface */
549         TAILQ_ENTRY(ifprefix) ifpr_list; /* queue macro glue */
550         u_char  ifpr_plen;              /* prefix length in bits */
551         u_char  ifpr_type;              /* protocol dependent prefix type */
552 };
553
554 /*
555  * Multicast address structure.  This is analogous to the ifaddr
556  * structure except that it keeps track of multicast addresses.
557  * Also, the reference count here is a count of requests for this
558  * address, not a count of pointers to this structure.
559  */
560 struct ifmultiaddr {
561         LIST_ENTRY(ifmultiaddr) ifma_link; /* queue macro glue */
562         struct  sockaddr *ifma_addr;    /* address this membership is for */
563         struct  sockaddr *ifma_lladdr;  /* link-layer translation, if any */
564         struct  ifnet *ifma_ifp;        /* back-pointer to interface */
565         u_int   ifma_refcount;          /* reference count */
566         void    *ifma_protospec;        /* protocol-specific state, if any */
567 };
568
569 #ifdef _KERNEL
570
571 enum ifaddr_event {
572         IFADDR_EVENT_ADD,
573         IFADDR_EVENT_DELETE,
574         IFADDR_EVENT_CHANGE
575 };
576
577 /* interface address change event */
578 typedef void (*ifaddr_event_handler_t)(void *, struct ifnet *,
579         enum ifaddr_event, struct ifaddr *);
580 EVENTHANDLER_DECLARE(ifaddr_event, ifaddr_event_handler_t);
581 /* new interface attach event */
582 typedef void (*ifnet_attach_event_handler_t)(void *, struct ifnet *);
583 EVENTHANDLER_DECLARE(ifnet_attach_event, ifnet_attach_event_handler_t);
584 /* interface detach event */
585 typedef void (*ifnet_detach_event_handler_t)(void *, struct ifnet *);
586 EVENTHANDLER_DECLARE(ifnet_detach_event, ifnet_detach_event_handler_t);
587
588 #ifdef INVARIANTS
589 #define ASSERT_IFAC_VALID(ifac) do { \
590         KKASSERT((ifac)->ifa_magic == IFA_CONTAINER_MAGIC); \
591         KKASSERT((ifac)->ifa_refcnt > 0); \
592 } while (0)
593 #else
594 #define ASSERT_IFAC_VALID(ifac) ((void)0)
595 #endif
596
597 static __inline void
598 _IFAREF(struct ifaddr *_ifa, int _cpu_id)
599 {
600         struct ifaddr_container *_ifac = &_ifa->ifa_containers[_cpu_id];
601
602         crit_enter();
603         ASSERT_IFAC_VALID(_ifac);
604         ++_ifac->ifa_refcnt;
605         crit_exit();
606 }
607
608 static __inline void
609 IFAREF(struct ifaddr *_ifa)
610 {
611         _IFAREF(_ifa, mycpuid);
612 }
613
614 #include <sys/malloc.h>
615
616 MALLOC_DECLARE(M_IFADDR);
617 MALLOC_DECLARE(M_IFMADDR);
618
619 void    ifac_free(struct ifaddr_container *, int);
620
621 static __inline void
622 _IFAFREE(struct ifaddr *_ifa, int _cpu_id)
623 {
624         struct ifaddr_container *_ifac = &_ifa->ifa_containers[_cpu_id];
625
626         crit_enter();
627         ASSERT_IFAC_VALID(_ifac);
628         if (--_ifac->ifa_refcnt == 0)
629                 ifac_free(_ifac, _cpu_id);
630         crit_exit();
631 }
632
633 static __inline void
634 IFAFREE(struct ifaddr *_ifa)
635 {
636         _IFAFREE(_ifa, mycpuid);
637 }
638
639 struct lwkt_port *ifnet_portfn(int);
640 int     ifnet_domsg(struct lwkt_msg *, int);
641 void    ifnet_sendmsg(struct lwkt_msg *, int);
642 void    ifnet_forwardmsg(struct lwkt_msg *, int);
643
644 static __inline int
645 ifa_domsg(struct lwkt_msg *_lmsg, int _cpu)
646 {
647         return ifnet_domsg(_lmsg, _cpu);
648 }
649
650 static __inline void
651 ifa_sendmsg(struct lwkt_msg *_lmsg, int _cpu)
652 {
653         ifnet_sendmsg(_lmsg, _cpu);
654 }
655
656 static __inline void
657 ifa_forwardmsg(struct lwkt_msg *_lmsg, int _nextcpu)
658 {
659         ifnet_forwardmsg(_lmsg, _nextcpu);
660 }
661
662 extern  struct ifnethead ifnet;
663 extern struct   ifnet   **ifindex2ifnet;
664 extern  int ifqmaxlen;
665 extern  struct ifnet loif[];
666 extern  int if_index;
667
668 void    ether_ifattach(struct ifnet *, uint8_t *, struct lwkt_serialize *);
669 void    ether_ifattach_bpf(struct ifnet *, uint8_t *, u_int, u_int,
670                         struct lwkt_serialize *);
671 void    ether_ifdetach(struct ifnet *);
672 void    ether_demux_oncpu(struct ifnet *, struct mbuf *);
673 void    ether_input_oncpu(struct ifnet *, struct mbuf *);
674 void    ether_reinput_oncpu(struct ifnet *, struct mbuf *, int);
675 void    ether_input_chain(struct ifnet *, struct mbuf *,
676                           const struct pktinfo *, struct mbuf_chain *);
677 void    ether_input_chain_init(struct mbuf_chain *);
678 void    ether_input_dispatch(struct mbuf_chain *);
679 int     ether_output_frame(struct ifnet *, struct mbuf *);
680 int     ether_ioctl(struct ifnet *, int, caddr_t);
681 uint32_t        ether_crc32_le(const uint8_t *, size_t);
682 uint32_t        ether_crc32_be(const uint8_t *, size_t);
683
684 int     if_addmulti(struct ifnet *, struct sockaddr *, struct ifmultiaddr **);
685 int     if_allmulti(struct ifnet *, int);
686 void    if_attach(struct ifnet *, struct lwkt_serialize *);
687 int     if_delmulti(struct ifnet *, struct sockaddr *);
688 void    if_purgeaddrs_nolink(struct ifnet *);
689 void    if_detach(struct ifnet *);
690 void    if_down(struct ifnet *);
691 void    if_link_state_change(struct ifnet *);
692 void    if_initname(struct ifnet *, const char *, int);
693 int     if_getanyethermac(uint16_t *, int);
694 int     if_printf(struct ifnet *, const char *, ...) __printflike(2, 3);
695 void    if_route(struct ifnet *, int flag, int fam);
696 int     if_setlladdr(struct ifnet *, const u_char *, int);
697 void    if_unroute(struct ifnet *, int flag, int fam);
698 void    if_up(struct ifnet *);
699 /*void  ifinit(void);*/ /* declared in systm.h for main() */
700 int     ifioctl(struct socket *, u_long, caddr_t, struct ucred *);
701 int     ifpromisc(struct ifnet *, int);
702 struct  ifnet *ifunit(const char *);
703 struct  ifnet *if_withname(struct sockaddr *);
704
705 struct  ifaddr *ifa_ifwithaddr(struct sockaddr *);
706 struct  ifaddr *ifa_ifwithdstaddr(struct sockaddr *);
707 struct  ifaddr *ifa_ifwithnet(struct sockaddr *);
708 struct  ifaddr *ifa_ifwithroute(int, struct sockaddr *, struct sockaddr *);
709 struct  ifaddr *ifaof_ifpforaddr(struct sockaddr *, struct ifnet *);
710
711 void    *ifa_create(int, int);
712 void    ifa_destroy(struct ifaddr *);
713 void    ifa_iflink(struct ifaddr *, struct ifnet *, int);
714 void    ifa_ifunlink(struct ifaddr *, struct ifnet *);
715
716 struct  ifmultiaddr *ifmaof_ifpforaddr(struct sockaddr *, struct ifnet *);
717 int     if_simloop(struct ifnet *ifp, struct mbuf *m, int af, int hlen);
718 void    if_devstart(struct ifnet *ifp);
719
720 #define IF_LLSOCKADDR(ifp)                                              \
721     ((struct sockaddr_dl *)(ifp)->if_lladdr->ifa_addr)
722 #define IF_LLADDR(ifp)  LLADDR(IF_LLSOCKADDR(ifp))
723
724 #ifdef DEVICE_POLLING
725 typedef void poll_handler_t (struct ifnet *ifp, enum poll_cmd cmd, int count);
726 int     ether_poll_register(struct ifnet *);
727 int     ether_poll_deregister(struct ifnet *);
728 int     ether_pollcpu_register(struct ifnet *, int);
729 #endif /* DEVICE_POLLING */
730 #endif /* _KERNEL */
731
732 #endif /* !_NET_IF_VAR_H_ */