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