source: rtems/c/src/exec/libnetworking/net/if.h @ a3d0b8a

/*
 * Copyright (c) 1982, 1986, 1989, 1993
 *      The Regents of the University of California.  All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. All advertising materials mentioning features or use of this software
 *    must display the following acknowledgement:
 *      This product includes software developed by the University of
 *      California, Berkeley and its contributors.
 * 4. Neither the name of the University nor the names of its contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 *
 *      @(#)if.h        8.1 (Berkeley) 6/10/93
 * $Id$
 */

#ifndef _NET_IF_H_
#define _NET_IF_H_

/*
 * Structures defining a network interface, providing a packet
 * transport mechanism (ala level 0 of the PUP protocols).
 *
 * Each interface accepts output datagrams of a specified maximum
 * length, and provides higher level routines with input datagrams
 * received from its medium.
 *
 * Output occurs when the routine if_output is called, with three parameters:
 *      (*ifp->if_output)(ifp, m, dst, rt)
 * Here m is the mbuf chain to be sent and dst is the destination address.
 * The output routine encapsulates the supplied datagram if necessary,
 * and then transmits it on its medium.
 *
 * On input, each interface unwraps the data received by it, and either
 * places it on the input queue of a internetwork datagram routine
 * and posts the associated software interrupt, or passes the datagram to a raw
 * packet input routine.
 *
 * Routines exist for locating interfaces by their addresses
 * or for locating a interface on a certain network, as well as more general
 * routing and gateway routines maintaining information used to locate
 * interfaces.  These routines live in the files if.c and route.c
 */

#ifndef _TIME_ /*  XXX fast fix for SNMP, going away soon */
#include <sys/time.h>
#endif

#ifdef __STDC__
/*
 * Forward structure declarations for function prototypes [sic].
 */
struct  mbuf;
struct  proc;
struct  rtentry;
struct  socket;
struct  ether_header;
#endif

/*
 * Structure describing information about an interface
 * which may be of interest to management entities.
 */
struct if_data {
        /* generic interface information */
        u_char  ifi_type;               /* ethernet, tokenring, etc */
        u_char  ifi_physical;           /* e.g., AUI, Thinnet, 10base-T, etc */
        u_char  ifi_addrlen;            /* media address length */
        u_char  ifi_hdrlen;             /* media header length */
        u_char  ifi_recvquota;          /* polling quota for receive intrs */
        u_char  ifi_xmitquota;          /* polling quota for xmit intrs */
        u_long  ifi_mtu;                /* maximum transmission unit */
        u_long  ifi_metric;             /* routing metric (external only) */
        u_long  ifi_baudrate;           /* linespeed */
        /* volatile statistics */
        u_long  ifi_ipackets;           /* packets received on interface */
        u_long  ifi_ierrors;            /* input errors on interface */
        u_long  ifi_opackets;           /* packets sent on interface */
        u_long  ifi_oerrors;            /* output errors on interface */
        u_long  ifi_collisions;         /* collisions on csma interfaces */
        u_long  ifi_ibytes;             /* total number of octets received */
        u_long  ifi_obytes;             /* total number of octets sent */
        u_long  ifi_imcasts;            /* packets received via multicast */
        u_long  ifi_omcasts;            /* packets sent via multicast */
        u_long  ifi_iqdrops;            /* dropped on input, this interface */
        u_long  ifi_noproto;            /* destined for unsupported protocol */
        u_long  ifi_recvtiming;         /* usec spent receiving when timing */
        u_long  ifi_xmittiming;         /* usec spent xmitting when timing */
        struct  timeval ifi_lastchange; /* time of last administrative change */
};

/*
 * Structure defining a queue for a network interface.
 */
struct  ifqueue {
        struct  mbuf *ifq_head;
        struct  mbuf *ifq_tail;
        int     ifq_len;
        int     ifq_maxlen;
        int     ifq_drops;
};

/*
 * Structure defining a network interface.
 *
 * (Would like to call this struct ``if'', but C isn't PL/1.)
 */
struct ifnet {
        void    *if_softc;              /* pointer to driver state */
        char    *if_name;               /* name, e.g. ``en'' or ``lo'' */
        struct  ifnet *if_next;         /* all struct ifnets are chained */
        struct  ifaddr *if_addrlist;    /* linked list of addresses per if */
        int     if_pcount;              /* number of promiscuous listeners */
        struct  bpf_if *if_bpf;         /* packet filter structure */
        u_short if_index;               /* numeric abbreviation for this if  */
        short   if_unit;                /* sub-unit for lower level driver */
        short   if_timer;               /* time 'til if_watchdog called */
        short   if_flags;               /* up/down, broadcast, etc. */
        int     if_ipending;            /* interrupts pending */
        void    *if_linkmib;            /* link-type-specific MIB data */
        size_t  if_linkmiblen;          /* length of above data */
        struct  if_data if_data;
/* procedure handles */
        int     (*if_output)            /* output routine (enqueue) */
                __P((struct ifnet *, struct mbuf *, struct sockaddr *,
                     struct rtentry *));
        void    (*if_start)             /* initiate output routine */
                __P((struct ifnet *));
        int     (*if_done)              /* output complete routine */
                __P((struct ifnet *));  /* (XXX not used; fake prototype) */
        int     (*if_ioctl)             /* ioctl routine */
                __P((struct ifnet *, int, caddr_t));
        void    (*if_watchdog)          /* timer routine */
                __P((struct ifnet *));
        int     (*if_poll_recv)         /* polled receive routine */
                __P((struct ifnet *, int *));
        int     (*if_poll_xmit)         /* polled transmit routine */
                __P((struct ifnet *, int *));
        void    (*if_poll_intren)       /* polled interrupt reenable routine */
                __P((struct ifnet *));
        void    (*if_poll_slowinput)    /* input routine for slow devices */
                __P((struct ifnet *, struct mbuf *));
        void    (*if_init)              /* Init routine */
                __P((void *));
        int     (*if_tap)               /* Packet filter routine */
                (struct ifnet *, struct ether_header *, struct mbuf *);
        struct  ifqueue if_snd;         /* output queue */
        struct  ifqueue *if_poll_slowq; /* input queue for slow devices */
};
typedef void if_init_f_t __P((void *));       

#define if_mtu          if_data.ifi_mtu
#define if_type         if_data.ifi_type
#define if_physical     if_data.ifi_physical
#define if_addrlen      if_data.ifi_addrlen
#define if_hdrlen       if_data.ifi_hdrlen
#define if_metric       if_data.ifi_metric
#define if_baudrate     if_data.ifi_baudrate
#define if_ipackets     if_data.ifi_ipackets
#define if_ierrors      if_data.ifi_ierrors
#define if_opackets     if_data.ifi_opackets
#define if_oerrors      if_data.ifi_oerrors
#define if_collisions   if_data.ifi_collisions
#define if_ibytes       if_data.ifi_ibytes
#define if_obytes       if_data.ifi_obytes
#define if_imcasts      if_data.ifi_imcasts
#define if_omcasts      if_data.ifi_omcasts
#define if_iqdrops      if_data.ifi_iqdrops
#define if_noproto      if_data.ifi_noproto
#define if_lastchange   if_data.ifi_lastchange
#define if_recvquota    if_data.ifi_recvquota
#define if_xmitquota    if_data.ifi_xmitquota
#define if_rawoutput(if, m, sa) if_output(if, m, sa, (struct rtentry *)0)

#define IFF_UP          0x1             /* interface is up */
#define IFF_BROADCAST   0x2             /* broadcast address valid */
#define IFF_DEBUG       0x4             /* turn on debugging */
#define IFF_LOOPBACK    0x8             /* is a loopback net */
#define IFF_POINTOPOINT 0x10            /* interface is point-to-point link */
/*#define IFF_NOTRAILERS 0x20            * obsolete: avoid use of trailers */
#define IFF_RUNNING     0x40            /* resources allocated */
#define IFF_NOARP       0x80            /* no address resolution protocol */
#define IFF_PROMISC     0x100           /* receive all packets */
#define IFF_ALLMULTI    0x200           /* receive all multicast packets */
#define IFF_OACTIVE     0x400           /* transmission in progress */
#define IFF_SIMPLEX     0x800           /* can't hear own transmissions */
#define IFF_LINK0       0x1000          /* per link layer defined bit */
#define IFF_LINK1       0x2000          /* per link layer defined bit */
#define IFF_LINK2       0x4000          /* per link layer defined bit */
#define IFF_ALTPHYS     IFF_LINK2       /* use alternate physical connection */
#define IFF_MULTICAST   0x8000          /* supports multicast */

/* flags set internally only: */
#define IFF_CANTCHANGE \
        (IFF_BROADCAST|IFF_POINTOPOINT|IFF_RUNNING|IFF_OACTIVE|\
            IFF_SIMPLEX|IFF_MULTICAST|IFF_ALLMULTI)


/*
 * These really don't belong here, but there's no other obviously appropriate
 * location.
 */
#define IFP_AUI         0
#define IFP_10BASE2     1
#define IFP_10BASET     2
/* etc. */

/*
 * Bit values in if_ipending
 */
#define IFI_RECV        1       /* I want to receive */
#define IFI_XMIT        2       /* I want to transmit */

/*
 * Output queues (ifp->if_snd) and slow device input queues (*ifp->if_slowq)
 * are queues of messages stored on ifqueue structures
 * (defined above).  Entries are added to and deleted from these structures
 * by these macros, which should be called with ipl raised to splimp().
 */
#define IF_QFULL(ifq)           ((ifq)->ifq_len >= (ifq)->ifq_maxlen)
#define IF_DROP(ifq)            ((ifq)->ifq_drops++)
#define IF_ENQUEUE(ifq, m) { \
        (m)->m_nextpkt = 0; \
        if ((ifq)->ifq_tail == 0) \
                (ifq)->ifq_head = m; \
        else \
                (ifq)->ifq_tail->m_nextpkt = m; \
        (ifq)->ifq_tail = m; \
        (ifq)->ifq_len++; \
}
#define IF_PREPEND(ifq, m) { \
        (m)->m_nextpkt = (ifq)->ifq_head; \
        if ((ifq)->ifq_tail == 0) \
                (ifq)->ifq_tail = (m); \
        (ifq)->ifq_head = (m); \
        (ifq)->ifq_len++; \
}
#define IF_DEQUEUE(ifq, m) { \
        (m) = (ifq)->ifq_head; \
        if (m) { \
                if (((ifq)->ifq_head = (m)->m_nextpkt) == 0) \
                        (ifq)->ifq_tail = 0; \
                (m)->m_nextpkt = 0; \
                (ifq)->ifq_len--; \
        } \
}

#ifdef KERNEL
#define IF_ENQ_DROP(ifq, m)     if_enq_drop(ifq, m)

#if defined(__GNUC__) && defined(MT_HEADER)
static inline int
if_queue_drop(struct ifqueue *ifq, struct mbuf *m)
{
        IF_DROP(ifq);
        return 0;
}

static inline int
if_enq_drop(struct ifqueue *ifq, struct mbuf *m)
{
        if (IF_QFULL(ifq) &&
            !if_queue_drop(ifq, m))
                return 0;
        IF_ENQUEUE(ifq, m);
        return 1;
}
#else

#ifdef MT_HEADER
int     if_enq_drop __P((struct ifqueue *, struct mbuf *));
#endif

#endif
#endif /* KERNEL */

#define IFQ_MAXLEN      50
#define IFNET_SLOWHZ    1               /* granularity is 1 second */

/*
 * The ifaddr structure contains information about one address
 * of an interface.  They are maintained by the different address families,
 * are allocated and attached when an address is set, and are linked
 * together so all addresses for an interface can be located.
 */
struct ifaddr {
        struct  sockaddr *ifa_addr;     /* address of interface */
        struct  sockaddr *ifa_dstaddr;  /* other end of p-to-p link */
#define ifa_broadaddr   ifa_dstaddr     /* broadcast address interface */
        struct  sockaddr *ifa_netmask;  /* used to determine subnet */
        struct  ifnet *ifa_ifp;         /* back-pointer to interface */
        struct  ifaddr *ifa_next;       /* next address for interface */
        void    (*ifa_rtrequest)        /* check or clean routes (+ or -)'d */
                __P((int, struct rtentry *, struct sockaddr *));
        u_short ifa_flags;              /* mostly rt_flags for cloning */
        short   ifa_refcnt;             /* references to this structure */
        int     ifa_metric;             /* cost of going out this interface */
#ifdef notdef
        struct  rtentry *ifa_rt;        /* XXXX for ROUTETOIF ????? */
#endif
        int (*ifa_claim_addr)           /* check if an addr goes to this if */
                __P((struct ifaddr *, struct sockaddr *));

};
#define IFA_ROUTE       RTF_UP          /* route installed */

/*
 * Message format for use in obtaining information about interfaces
 * from getkerninfo and the routing socket
 */
struct if_msghdr {
        u_short ifm_msglen;     /* to skip over non-understood messages */
        u_char  ifm_version;    /* future binary compatability */
        u_char  ifm_type;       /* message type */
        int     ifm_addrs;      /* like rtm_addrs */
        int     ifm_flags;      /* value of if_flags */
        u_short ifm_index;      /* index for associated ifp */
        struct  if_data ifm_data;/* statistics and other data about if */
};

/*
 * Message format for use in obtaining information about interface addresses
 * from getkerninfo and the routing socket
 */
struct ifa_msghdr {
        u_short ifam_msglen;    /* to skip over non-understood messages */
        u_char  ifam_version;   /* future binary compatability */
        u_char  ifam_type;      /* message type */
        int     ifam_addrs;     /* like rtm_addrs */
        int     ifam_flags;     /* value of ifa_flags */
        u_short ifam_index;     /* index for associated ifp */
        int     ifam_metric;    /* value of ifa_metric */
};

/*
 * Interface request structure used for socket
 * ioctl's.  All interface ioctl's must have parameter
 * definitions which begin with ifr_name.  The
 * remainder may be interface specific.
 */
struct  ifreq {
#define IFNAMSIZ        16
        char    ifr_name[IFNAMSIZ];             /* if name, e.g. "en0" */
        union {
                struct  sockaddr ifru_addr;
                struct  sockaddr ifru_dstaddr;
                struct  sockaddr ifru_broadaddr;
                short   ifru_flags;
                int     ifru_metric;
                int     ifru_mtu;
                int     ifru_phys;
                int     ifru_media;
                caddr_t ifru_data;
                int     (*ifru_tap)(struct ifnet *, struct ether_header *, struct mbuf *);
        } ifr_ifru;
#define ifr_addr        ifr_ifru.ifru_addr      /* address */
#define ifr_dstaddr     ifr_ifru.ifru_dstaddr   /* other end of p-to-p link */
#define ifr_broadaddr   ifr_ifru.ifru_broadaddr /* broadcast address */
#define ifr_flags       ifr_ifru.ifru_flags     /* flags */
#define ifr_metric      ifr_ifru.ifru_metric    /* metric */
#define ifr_mtu         ifr_ifru.ifru_mtu       /* mtu */
#define ifr_phys        ifr_ifru.ifru_phys      /* physical wire */
#define ifr_media       ifr_ifru.ifru_media     /* physical media */
#define ifr_data        ifr_ifru.ifru_data      /* for use by interface */
#define ifr_tap         ifr_ifru.ifru_tap       /* tap function */
};

struct ifaliasreq {
        char    ifra_name[IFNAMSIZ];            /* if name, e.g. "en0" */
        struct  sockaddr ifra_addr;
        struct  sockaddr ifra_broadaddr;
        struct  sockaddr ifra_mask;
};

struct ifmediareq {
        char    ifm_name[IFNAMSIZ];     /* if name, e.g. "en0" */
        int     ifm_current;            /* current media options */
        int     ifm_mask;               /* don't care mask */
        int     ifm_status;             /* media status */
        int     ifm_active;             /* active options */
        int     ifm_count;              /* # entries in ifm_ulist array */
        int     *ifm_ulist;             /* media words */
};
/*
 * Structure used in SIOCGIFCONF request.
 * Used to retrieve interface configuration
 * for machine (useful for programs which
 * must know all networks accessible).
 */
struct  ifconf {
        int     ifc_len;                /* size of associated buffer */
        union {
                caddr_t ifcu_buf;
                struct  ifreq *ifcu_req;
        } ifc_ifcu;
#define ifc_buf ifc_ifcu.ifcu_buf       /* buffer address */
#define ifc_req ifc_ifcu.ifcu_req       /* array of structures returned */
};

#include <net/if_arp.h>

#ifdef KERNEL
#define IFAFREE(ifa) \
        if ((ifa)->ifa_refcnt <= 0) \
                ifafree(ifa); \
        else \
                (ifa)->ifa_refcnt--;

extern struct   ifnet   *ifnet;
extern int      ifqmaxlen;
extern struct   ifnet   loif[];
extern int      if_index;
extern struct   ifaddr  **ifnet_addrs;

void    ether_ifattach __P((struct ifnet *));
void    ether_input __P((struct ifnet *, struct ether_header *, struct mbuf *));
int     ether_output __P((struct ifnet *,
           struct mbuf *, struct sockaddr *, struct rtentry *));
int     ether_ioctl __P((struct ifnet *, int , caddr_t ));

void    if_attach __P((struct ifnet *));
void    if_down __P((struct ifnet *));
void    if_up __P((struct ifnet *));
#ifdef vax
void    ifubareset __P((int));
#endif
/*void  ifinit __P((void));*/ /* declared in systm.h for main() */
int     ifioctl __P((struct socket *, int, caddr_t, struct proc *));
int     ifpromisc __P((struct ifnet *, int));
struct  ifnet *ifunit __P((char *));

int     if_poll_recv_slow __P((struct ifnet *ifp, int *quotap));
void    if_poll_xmit_slow __P((struct ifnet *ifp, int *quotap));
void    if_poll_throttle __P((void));
void    if_poll_unthrottle __P((void *));
void    if_poll_init __P((void));
void    if_poll __P((void));

struct  ifaddr *ifa_ifwithaddr __P((struct sockaddr *));
struct  ifaddr *ifa_ifwithdstaddr __P((struct sockaddr *));
struct  ifaddr *ifa_ifwithnet __P((struct sockaddr *));
struct  ifaddr *ifa_ifwithroute __P((int, struct sockaddr *,
                                        struct sockaddr *));
struct  ifaddr *ifaof_ifpforaddr __P((struct sockaddr *, struct ifnet *));
void    ifafree __P((struct ifaddr *));

int     looutput __P((struct ifnet *,
           struct mbuf *, struct sockaddr *, struct rtentry *));
#endif /* KERNEL */

#endif /* !_NET_IF_H_ */