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.15 2004/07/23 07:16:30 joerg Exp $
  36  */
  37
  38 #ifndef _NET_IF_VAR_H_
  39 #define _NET_IF_VAR_H_
  40
  41 /*
  42  * Structures defining a network interface, providing a packet
  43  * transport mechanism (ala level 0 of the PUP protocols).
  44  *
  45  * Each interface accepts output datagrams of a specified maximum
  46  * length, and provides higher level routines with input datagrams
  47  * received from its medium.
  48  *
  49  * Output occurs when the routine if_output is called, with three parameters:
  50  *      (*ifp->if_output)(ifp, m, dst, rt)
  51  * Here m is the mbuf chain to be sent and dst is the destination address.
  52  * The output routine encapsulates the supplied datagram if necessary,
  53  * and then transmits it on its medium.
  54  *
  55  * On input, each interface unwraps the data received by it, and either
  56  * places it on the input queue of a internetwork datagram routine
  57  * and posts the associated software interrupt, or passes the datagram to
  58  * the routine if_input. It is called with the mbuf chain as parameter:
  59  *      (*ifp->if_input)(ifp, m)
  60  * The input routine removes the protocol dependent header if necessary.
  61  *
  62  * Routines exist for locating interfaces by their addresses
  63  * or for locating a interface on a certain network, as well as more general
  64  * routing and gateway routines maintaining information used to locate
  65  * interfaces.  These routines live in the files if.c and route.c
  66  */
  67
  68 #ifdef __STDC__
  69 /*
  70  * Forward structure declarations for function prototypes [sic].
  71  */
  72 struct  mbuf;
  73 struct  proc;
  74 struct  rtentry;
  75 struct  rt_addrinfo;
  76 struct  socket;
  77 struct  ether_header;
  78 struct  ucred;
  79 #endif
  80
  81 #include <sys/queue.h>          /* get TAILQ macros */
  82
  83 #ifdef _KERNEL
  84 #include <sys/mbuf.h>
  85 #include <sys/systm.h>          /* XXX */
  86 #endif /* _KERNEL */
  87
  88 #define IF_DUNIT_NONE   -1
  89
  90 TAILQ_HEAD(ifnethead, ifnet);   /* we use TAILQs so that the order of */
  91 TAILQ_HEAD(ifaddrhead, ifaddr); /* instantiation is preserved in the list */
  92 TAILQ_HEAD(ifprefixhead, ifprefix);
  93 LIST_HEAD(ifmultihead, ifmultiaddr);
  94
  95 /*
  96  * Structure defining a queue for a network interface.
  97  */
  98 struct  ifqueue {
  99         struct  mbuf *ifq_head;
 100         struct  mbuf *ifq_tail;
 101         int     ifq_len;
 102         int     ifq_maxlen;
 103         int     ifq_drops;
 104 };
 105
 106 /*
 107  * Structure defining a network interface.
 108  *
 109  * (Would like to call this struct ``if'', but C isn't PL/1.)
 110  */
 111
 112 /*
 113  * NB: For FreeBSD, it is assumed that each NIC driver's softc starts with
 114  * one of these structures, typically held within an arpcom structure.
 115  *
 116  *      struct <foo>_softc {
 117  *              struct arpcom {
 118  *                      struct  ifnet ac_if;
 119  *                      ...
 120  *              } <arpcom> ;
 121  *              ...
 122  *      };
 123  *
 124  * The assumption is used in a number of places, including many
 125  * files in sys/net, device drivers, and sys/dev/mii.c:miibus_attach().
 126  *
 127  * Unfortunately devices' softc are opaque, so we depend on this layout
 128  * to locate the struct ifnet from the softc in the generic code.
 129  *
 130  * Note that not all fields are used by drivers in the FreeBSD source
 131  * tree. However, who knows what third party software does with fields
 132  * marked as "unused", such as if_ipending, if_done, and if_poll*,
 133  * so any attemt to redefine their meaning might end up in binary
 134  * compatibility problems, even if the size of struct ifnet, and
 135  * the size and position of its fields do not change.
 136  * We just have to live with that.
 137  */
 138 struct ifnet {
 139         void    *if_softc;              /* pointer to driver state */
 140         TAILQ_ENTRY(ifnet) if_link;     /* all struct ifnets are chained */
 141         char    if_xname[IFNAMSIZ];     /* external name (name + unit) */
 142         const char *if_dname;           /* driver name */
 143         int     if_dunit;               /* unit or IF_DUNIT_NONE */
 144         struct  ifaddrhead if_addrhead; /* linked list of addresses per if */
 145         int     if_pcount;              /* number of promiscuous listeners */
 146         struct  bpf_if *if_bpf;         /* packet filter structure */
 147         u_short if_index;               /* numeric abbreviation for this if  */
 148         short   if_timer;               /* time 'til if_watchdog called */
 149         int     if_flags;               /* up/down, broadcast, etc. */
 150         int     if_capabilities;        /* interface capabilities */
 151         int     if_capenable;           /* enabled features */
 152         void    *if_linkmib;            /* link-type-specific MIB data */
 153         size_t  if_linkmiblen;          /* length of above data */
 154         struct  if_data if_data;
 155         struct  ifmultihead if_multiaddrs; /* multicast addresses configured */
 156         int     if_amcount;             /* number of all-multicast requests */
 157 /* procedure handles */
 158         int     (*if_output)            /* output routine (enqueue) */
 159                 (struct ifnet *, struct mbuf *, struct sockaddr *,
 160                      struct rtentry *);
 161         void    (*if_input)             /* input routine from hardware driver */
 162                 (struct ifnet *, struct mbuf *);
 163         void    (*if_start)             /* initiate output routine */
 164                 (struct ifnet *);
 165         int     (*if_ioctl)             /* ioctl routine */
 166                 (struct ifnet *, u_long, caddr_t, struct ucred *);
 167         void    (*if_watchdog)          /* timer routine */
 168                 (struct ifnet *);
 169         void    (*if_init)              /* Init routine */
 170                 (void *);
 171         int     (*if_resolvemulti)      /* validate/resolve multicast */
 172                 (struct ifnet *, struct sockaddr **, struct sockaddr *);
 173         struct  ifqueue if_snd;         /* output queue */
 174         struct  ifprefixhead if_prefixhead; /* list of prefixes per if */
 175         const uint8_t   *if_broadcastaddr;
 176 };
 177 typedef void if_init_f_t (void *);
 178
 179 #define if_mtu          if_data.ifi_mtu
 180 #define if_type         if_data.ifi_type
 181 #define if_physical     if_data.ifi_physical
 182 #define if_addrlen      if_data.ifi_addrlen
 183 #define if_hdrlen       if_data.ifi_hdrlen
 184 #define if_metric       if_data.ifi_metric
 185 #define if_baudrate     if_data.ifi_baudrate
 186 #define if_hwassist     if_data.ifi_hwassist
 187 #define if_ipackets     if_data.ifi_ipackets
 188 #define if_ierrors      if_data.ifi_ierrors
 189 #define if_opackets     if_data.ifi_opackets
 190 #define if_oerrors      if_data.ifi_oerrors
 191 #define if_collisions   if_data.ifi_collisions
 192 #define if_ibytes       if_data.ifi_ibytes
 193 #define if_obytes       if_data.ifi_obytes
 194 #define if_imcasts      if_data.ifi_imcasts
 195 #define if_omcasts      if_data.ifi_omcasts
 196 #define if_iqdrops      if_data.ifi_iqdrops
 197 #define if_noproto      if_data.ifi_noproto
 198 #define if_lastchange   if_data.ifi_lastchange
 199 #define if_recvquota    if_data.ifi_recvquota
 200 #define if_xmitquota    if_data.ifi_xmitquota
 201 #define if_rawoutput(if, m, sa) if_output(if, m, sa, (struct rtentry *)0)
 202
 203 /* for compatibility with other BSDs */
 204 #define if_addrlist     if_addrhead
 205 #define if_list         if_link
 206
 207 /*
 208  * Output queues (ifp->if_snd) and slow device input queues (*ifp->if_slowq)
 209  * are queues of messages stored on ifqueue structures
 210  * (defined above).  Entries are added to and deleted from these structures
 211  * by these macros, which should be called with ipl raised to splimp().
 212  */
 213 #define IF_QFULL(ifq)           ((ifq)->ifq_len >= (ifq)->ifq_maxlen)
 214 #define IF_DROP(ifq)            ((ifq)->ifq_drops++)
 215 #define IF_ENQUEUE(ifq, m) { \
 216         (m)->m_nextpkt = 0; \
 217         if ((ifq)->ifq_tail == 0) \
 218                 (ifq)->ifq_head = m; \
 219         else \
 220                 (ifq)->ifq_tail->m_nextpkt = m; \
 221         (ifq)->ifq_tail = m; \
 222         (ifq)->ifq_len++; \
 223 }
 224 #define IF_PREPEND(ifq, m) { \
 225         (m)->m_nextpkt = (ifq)->ifq_head; \
 226         if ((ifq)->ifq_tail == 0) \
 227                 (ifq)->ifq_tail = (m); \
 228         (ifq)->ifq_head = (m); \
 229         (ifq)->ifq_len++; \
 230 }
 231 #define IF_DEQUEUE(ifq, m) { \
 232         (m) = (ifq)->ifq_head; \
 233         if (m) { \
 234                 if (((ifq)->ifq_head = (m)->m_nextpkt) == 0) \
 235                         (ifq)->ifq_tail = 0; \
 236                 (m)->m_nextpkt = 0; \
 237                 (ifq)->ifq_len--; \
 238         } \
 239 }
 240 #define IF_DRAIN(ifq) do {                                              \
 241         struct mbuf *m;                                                 \
 242         while (1) {                                                     \
 243                 IF_DEQUEUE(ifq, m);                                     \
 244                 if (m == NULL)                                          \
 245                         break;                                          \
 246                 m_freem(m);                                             \
 247         }                                                               \
 248 } while (0)
 249
 250 #ifdef _KERNEL
 251
 252 /*
 253  * #define _IF_QFULL for compatibility with -current
 254  */
 255 #define _IF_QFULL(ifq)                          IF_QFULL(ifq)
 256
 257 #define IF_HANDOFF(ifq, m, ifp)                 if_handoff(ifq, m, ifp, 0)
 258 #define IF_HANDOFF_ADJ(ifq, m, ifp, adj)        if_handoff(ifq, m, ifp, adj)
 259
 260 static __inline int
 261 if_handoff(struct ifqueue *ifq, struct mbuf *m, struct ifnet *ifp, int adjust)
 262 {
 263         int need_if_start = 0;
 264         int s = splimp();
 265
 266         if (IF_QFULL(ifq)) {
 267                 IF_DROP(ifq);
 268                 splx(s);
 269                 m_freem(m);
 270                 return (0);
 271         }
 272         if (ifp != NULL) {
 273                 ifp->if_obytes += m->m_pkthdr.len + adjust;
 274                 if (m->m_flags & M_MCAST)
 275                         ifp->if_omcasts++;
 276                 need_if_start = !(ifp->if_flags & IFF_OACTIVE);
 277         }
 278         IF_ENQUEUE(ifq, m);
 279         if (need_if_start)
 280                 (*ifp->if_start)(ifp);
 281         splx(s);
 282         return (1);
 283 }
 284
 285 /*
 286  * 72 was chosen below because it is the size of a TCP/IP
 287  * header (40) + the minimum mss (32).
 288  */
 289 #define IF_MINMTU       72
 290 #define IF_MAXMTU       65535
 291
 292 #endif /* _KERNEL */
 293
 294 /*
 295  * The ifaddr structure contains information about one address
 296  * of an interface.  They are maintained by the different address families,
 297  * are allocated and attached when an address is set, and are linked
 298  * together so all addresses for an interface can be located.
 299  */
 300 struct ifaddr {
 301         struct  sockaddr *ifa_addr;     /* address of interface */
 302         struct  sockaddr *ifa_dstaddr;  /* other end of p-to-p link */
 303 #define ifa_broadaddr   ifa_dstaddr     /* broadcast address interface */
 304         struct  sockaddr *ifa_netmask;  /* used to determine subnet */
 305         struct  if_data if_data;        /* not all members are meaningful */
 306         struct  ifnet *ifa_ifp;         /* back-pointer to interface */
 307         TAILQ_ENTRY(ifaddr) ifa_link;   /* queue macro glue */
 308         void    (*ifa_rtrequest)        /* check or clean routes (+ or -)'d */
 309                 (int, struct rtentry *, struct rt_addrinfo *);
 310         u_short ifa_flags;              /* mostly rt_flags for cloning */
 311         u_int   ifa_refcnt;             /* references to this structure */
 312         int     ifa_metric;             /* cost of going out this interface */
 313 #ifdef notdef
 314         struct  rtentry *ifa_rt;        /* XXXX for ROUTETOIF ????? */
 315 #endif
 316         int (*ifa_claim_addr)           /* check if an addr goes to this if */
 317                 (struct ifaddr *, struct sockaddr *);
 318
 319 };
 320 #define IFA_ROUTE       RTF_UP          /* route installed */
 321
 322 /* for compatibility with other BSDs */
 323 #define ifa_list        ifa_link
 324
 325 /*
 326  * The prefix structure contains information about one prefix
 327  * of an interface.  They are maintained by the different address families,
 328  * are allocated and attached when an prefix or an address is set,
 329  * and are linked together so all prefixes for an interface can be located.
 330  */
 331 struct ifprefix {
 332         struct  sockaddr *ifpr_prefix;  /* prefix of interface */
 333         struct  ifnet *ifpr_ifp;        /* back-pointer to interface */
 334         TAILQ_ENTRY(ifprefix) ifpr_list; /* queue macro glue */
 335         u_char  ifpr_plen;              /* prefix length in bits */
 336         u_char  ifpr_type;              /* protocol dependent prefix type */
 337 };
 338
 339 /*
 340  * Multicast address structure.  This is analogous to the ifaddr
 341  * structure except that it keeps track of multicast addresses.
 342  * Also, the reference count here is a count of requests for this
 343  * address, not a count of pointers to this structure.
 344  */
 345 struct ifmultiaddr {
 346         LIST_ENTRY(ifmultiaddr) ifma_link; /* queue macro glue */
 347         struct  sockaddr *ifma_addr;    /* address this membership is for */
 348         struct  sockaddr *ifma_lladdr;  /* link-layer translation, if any */
 349         struct  ifnet *ifma_ifp;        /* back-pointer to interface */
 350         u_int   ifma_refcount;          /* reference count */
 351         void    *ifma_protospec;        /* protocol-specific state, if any */
 352 };
 353
 354 #ifdef _KERNEL
 355 #define IFAFREE(ifa)                                    \
 356         do {                                            \
 357                 if ((ifa)->ifa_refcnt <= 0)             \
 358                         ifafree(ifa);                   \
 359                 else                                    \
 360                         (ifa)->ifa_refcnt--;            \
 361         } while (0)
 362
 363 extern  struct ifnethead ifnet;
 364 extern struct   ifnet   **ifindex2ifnet;
 365 extern  int ifqmaxlen;
 366 extern  struct ifnet loif[];
 367 extern  int if_index;
 368 extern  struct ifaddr **ifnet_addrs;
 369
 370 void    ether_ifattach(struct ifnet *, uint8_t *);
 371 void    ether_ifattach_bpf(struct ifnet *, uint8_t *, u_int, u_int);
 372 void    ether_ifdetach(struct ifnet *);
 373 void    ether_input(struct ifnet *, struct ether_header *, struct mbuf *);
 374 void    ether_demux(struct ifnet *, struct ether_header *, struct mbuf *);
 375 int     ether_output_frame(struct ifnet *, struct mbuf *);
 376 int     ether_ioctl(struct ifnet *, int, caddr_t);
 377 uint32_t        ether_crc32_le(const uint8_t *, size_t);
 378 uint32_t        ether_crc32_be(const uint8_t *, size_t);
 379
 380 int     if_addmulti(struct ifnet *, struct sockaddr *, struct ifmultiaddr **);
 381 int     if_allmulti(struct ifnet *, int);
 382 void    if_attach(struct ifnet *);
 383 int     if_delmulti(struct ifnet *, struct sockaddr *);
 384 void    if_detach(struct ifnet *);
 385 void    if_down(struct ifnet *);
 386 void    if_initname(struct ifnet *, const char *, int);
 387 int     if_printf(struct ifnet *, const char *, ...) __printflike(2, 3);
 388 void    if_route(struct ifnet *, int flag, int fam);
 389 int     if_setlladdr(struct ifnet *, const u_char *, int);
 390 void    if_unroute(struct ifnet *, int flag, int fam);
 391 void    if_up(struct ifnet *);
 392 /*void  ifinit(void);*/ /* declared in systm.h for main() */
 393 int     ifioctl(struct socket *, u_long, caddr_t, struct thread *);
 394 int     ifpromisc(struct ifnet *, int);
 395 struct  ifnet *ifunit(const char *);
 396 struct  ifnet *if_withname(struct sockaddr *);
 397
 398 struct  ifaddr *ifa_ifwithaddr(struct sockaddr *);
 399 struct  ifaddr *ifa_ifwithdstaddr(struct sockaddr *);
 400 struct  ifaddr *ifa_ifwithnet(struct sockaddr *);
 401 struct  ifaddr *ifa_ifwithroute(int, struct sockaddr *, struct sockaddr *);
 402 struct  ifaddr *ifaof_ifpforaddr(struct sockaddr *, struct ifnet *);
 403 void    ifafree(struct ifaddr *);
 404
 405 struct  ifmultiaddr *ifmaof_ifpforaddr(struct sockaddr *, struct ifnet *);
 406 int     if_simloop(struct ifnet *ifp, struct mbuf *m, int af, int hlen);
 407
 408 void    if_clone_attach(struct if_clone *);
 409 void    if_clone_detach(struct if_clone *);
 410
 411 int     if_clone_create(char *, int);
 412 int     if_clone_destroy(const char *);
 413
 414 #define IF_LLADDR(ifp)                                                  \
 415     LLADDR((struct sockaddr_dl *) ifnet_addrs[ifp->if_index - 1]->ifa_addr)
 416
 417 #ifdef DEVICE_POLLING
 418 enum poll_cmd { POLL_ONLY, POLL_AND_CHECK_STATUS, POLL_DEREGISTER };
 419
 420 typedef void poll_handler_t (struct ifnet *ifp,
 421                 enum poll_cmd cmd, int count);
 422 int     ether_poll_register(poll_handler_t *h, struct ifnet *ifp);
 423 int     ether_poll_deregister(struct ifnet *ifp);
 424 void    emergency_poll_enable(const char *name);
 425 #endif /* DEVICE_POLLING */
 426 #endif /* _KERNEL */
 427
 428 #endif /* !_NET_IF_VAR_H_ */