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