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