source: rtems/cpukit/libnetworking/netinet/in_var.h @ 8fc471a5

/* $Id */
/*
 * Copyright (c) 1985, 1986, 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.
 * 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.
 *
 *      @(#)in_var.h    8.2 (Berkeley) 1/9/95
 * $FreeBSD: src/sys/netinet/in_var.h,v 1.52 2004/10/19 21:06:14 andre Exp $
 */

#ifndef _NETINET_IN_VAR_H_
#define _NETINET_IN_VAR_H_

#include <rtems/bsd/sys/queue.h>
#if !defined(__rtems__)
#include <sys/fnv_hash.h>
#endif

/*
 * Interface address, Internet version.  One of these structures
 * is allocated for each Internet address on an interface.
 * The ifaddr structure contains the protocol-independent part
 * of the structure and is assumed to be first.
 */
struct in_ifaddr {
        struct  ifaddr ia_ifa;          /* protocol-independent info */
#define ia_ifp          ia_ifa.ifa_ifp
#define ia_flags        ia_ifa.ifa_flags
                                        /* ia_{,sub}net{,mask} in host order */
        u_long  ia_net;                 /* network number of interface */
        u_long  ia_netmask;             /* mask of net part */
        u_long  ia_subnet;              /* subnet number, including net */
        u_long  ia_subnetmask;          /* mask of subnet part */
        struct  in_addr ia_netbroadcast; /* to recognize net broadcasts */
        struct  in_ifaddr *ia_next;     /* next in list of internet addresses */
        struct  sockaddr_in ia_addr;    /* reserve space for interface name */
        struct  sockaddr_in ia_dstaddr; /* reserve space for broadcast addr */
#define ia_broadaddr    ia_dstaddr
        struct  sockaddr_in ia_sockmask; /* reserve space for general netmask */
        LIST_HEAD(in_multihead, in_multi) ia_multiaddrs;
                                        /* list of multicast addresses */
};

struct  in_aliasreq {
        char    ifra_name[IFNAMSIZ];            /* if name, e.g. "en0" */
        struct  sockaddr_in ifra_addr;
        struct  sockaddr_in ifra_broadaddr;
#define ifra_dstaddr ifra_broadaddr
        struct  sockaddr_in ifra_mask;
};
/*
 * Given a pointer to an in_ifaddr (ifaddr),
 * return a pointer to the addr as a sockaddr_in.
 */
#define IA_SIN(ia)    (&(((struct in_ifaddr *)(ia))->ia_addr))
#define IA_DSTSIN(ia) (&(((struct in_ifaddr *)(ia))->ia_dstaddr))

#define IN_LNAOF(in, ifa) \
        ((ntohl((in).s_addr) & ~((struct in_ifaddr *)(ifa)->ia_subnetmask))


#ifdef  _KERNEL
extern  struct  in_ifaddr *in_ifaddr;
extern  struct  ifqueue ipintrq;                /* ip packet input queue */
extern  struct  in_addr zeroin_addr;
extern  u_char  inetctlerrmap[];

/*
 * Macro for finding the interface (ifnet structure) corresponding to one
 * of our IP addresses.
 */
#define INADDR_TO_IFP(addr, ifp) \
        /* struct in_addr addr; */ \
        /* struct ifnet *ifp; */ \
{ \
        register struct in_ifaddr *ia; \
\
        for (ia = in_ifaddr; \
            ia != NULL && ((ia->ia_ifp->if_flags & IFF_POINTOPOINT)? \
                IA_DSTSIN(ia):IA_SIN(ia))->sin_addr.s_addr != (addr).s_addr; \
            ia = ia->ia_next) \
                 continue; \
        if (ia == NULL) \
            for (ia = in_ifaddr; \
                ia != NULL; \
                ia = ia->ia_next) \
                    if (ia->ia_ifp->if_flags & IFF_POINTOPOINT && \
                        IA_SIN(ia)->sin_addr.s_addr == (addr).s_addr) \
                            break; \
        (ifp) = (ia == NULL) ? NULL : ia->ia_ifp; \
}

/*
 * Macro for finding the internet address structure (in_ifaddr) corresponding
 * to a given interface (ifnet structure).
 */
#define IFP_TO_IA(ifp, ia) \
        /* struct ifnet *ifp; */ \
        /* struct in_ifaddr *ia; */ \
{ \
        for ((ia) = in_ifaddr; \
            (ia) != NULL && (ia)->ia_ifp != (ifp); \
            (ia) = (ia)->ia_next) \
                continue; \
}
#endif

/*
 * This information should be part of the ifnet structure but we don't wish
 * to change that - as it might break a number of things
 */

struct router_info {
        struct ifnet *rti_ifp;
        int    rti_type; /* type of router which is querier on this interface */
        int    rti_time; /* # of slow timeouts since last old query */
        struct router_info *rti_next;
};

/*
 * Internet multicast address structure.  There is one of these for each IP
 * multicast group to which this host belongs on a given network interface.
 * They are kept in a linked list, rooted in the interface's in_ifaddr
 * structure.
 */
struct in_multi {
        LIST_ENTRY(in_multi) inm_entry; /* list glue */
        struct  in_addr inm_addr;       /* IP multicast address */
        struct  ifnet *inm_ifp;         /* back pointer to ifnet */
        struct  in_ifaddr *inm_ia;      /* back pointer to in_ifaddr */
        u_int   inm_refcount;           /* no. membership claims by sockets */
        u_int   inm_timer;              /* IGMP membership report timer */
        u_int   inm_state;              /*  state of the membership */
        struct  router_info *inm_rti;   /* router info*/
};

#ifdef _KERNEL

#ifdef SYSCTL_DECL
SYSCTL_DECL(_net_inet_ip);
SYSCTL_DECL(_net_inet_raw);
#endif

/*
 * Structure used by macros below to remember position when stepping through
 * all of the in_multi records.
 */
struct in_multistep {
        struct in_ifaddr *i_ia;
        struct in_multi *i_inm;
};

/*
 * Macro for looking up the in_multi record for a given IP multicast address
 * on a given interface.  If no matching record is found, "inm" returns NULL.
 */
#define IN_LOOKUP_MULTI(addr, ifp, inm) \
        /* struct in_addr addr; */ \
        /* struct ifnet *ifp; */ \
        /* struct in_multi *inm; */ \
{ \
        register struct in_ifaddr *ia; \
\
        IFP_TO_IA((ifp), ia); \
        if (ia == NULL) \
                (inm) = NULL; \
        else \
                for ((inm) = ia->ia_multiaddrs.lh_first; \
                    (inm) != NULL && (inm)->inm_addr.s_addr != (addr).s_addr; \
                     (inm) = inm->inm_entry.le_next) \
                         continue; \
}

/*
 * Macro to step through all of the in_multi records, one at a time.
 * The current position is remembered in "step", which the caller must
 * provide.  IN_FIRST_MULTI(), below, must be called to initialize "step"
 * and get the first record.  Both macros return a NULL "inm" when there
 * are no remaining records.
 */
#define IN_NEXT_MULTI(step, inm) \
        /* struct in_multistep  step; */ \
        /* struct in_multi *inm; */ \
{ \
        if (((inm) = (step).i_inm) != NULL) \
                (step).i_inm = (inm)->inm_entry.le_next; \
        else \
                while ((step).i_ia != NULL) { \
                        (inm) = (step).i_ia->ia_multiaddrs.lh_first; \
                        (step).i_ia = (step).i_ia->ia_next; \
                        if ((inm) != NULL) { \
                                (step).i_inm = (inm)->inm_entry.le_next; \
                                break; \
                        } \
                } \
}

#define IN_FIRST_MULTI(step, inm) \
        /* struct in_multistep step; */ \
        /* struct in_multi *inm; */ \
{ \
        (step).i_ia = in_ifaddr; \
        (step).i_inm = NULL; \
        IN_NEXT_MULTI((step), (inm)); \
}

struct  in_multi *in_addmulti(struct in_addr *, struct ifnet *);
void    in_delmulti(struct in_multi *);
int     in_control(struct socket *, u_long, caddr_t, struct ifnet *);
void    in_rtqdrain(void);
void    ip_input(struct mbuf *);

#endif /* _KERNEL */

#endif /* _NETINET_IN_VAR_H_ */