/*      $FreeBSD: src/sys/netinet6/in6_var.h,v 1.3.2.3 2002/04/28 05:40:27 suz Exp $    */
/*      $DragonFly: src/sys/netinet6/in6_var.h,v 1.10 2008/10/03 07:59:20 hasso Exp $   */
/*      $KAME: in6_var.h,v 1.56 2001/03/29 05:34:31 itojun Exp $        */

/*
 * Copyright (C) 1995, 1996, 1997, and 1998 WIDE Project.
 * 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. Neither the name of the project 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 PROJECT 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 PROJECT 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.
 */

/*
 * 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.
 * 3. 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.1 (Berkeley) 6/10/93
 */

#ifndef _NETINET6_IN6_VAR_H_
#define _NETINET6_IN6_VAR_H_

#ifndef _SYS_TYPES_H_
#include <sys/types.h>
#endif
#ifndef _SYS_IOCCOM_H_
#include <sys/ioccom.h>
#endif
#ifndef _SYS_TIME_H_
#include <sys/time.h>
#endif
#ifndef _NET_IF_VAR_H_
#include <net/if_var.h>
#endif
#ifndef _NETINET_IN_H_
#include <netinet/in.h>
#endif

/*
 * Interface address, Internet version.  One of these structures
 * is allocated for each interface with an Internet address.
 * The ifaddr structure contains the protocol-independent part
 * of the structure and is assumed to be first.
 */

/*
 * pltime/vltime are just for future reference (required to implements 2
 * hour rule for hosts).  they should never be modified by nd6_timeout or
 * anywhere else.
 *      userland -> kernel: accept pltime/vltime
 *      kernel -> userland: throw up everything
 *      in kernel: modify preferred/expire only
 */
struct in6_addrlifetime {
        time_t ia6t_expire;     /* valid lifetime expiration time */
        time_t ia6t_preferred;  /* preferred lifetime expiration time */
        u_int32_t ia6t_vltime;  /* valid lifetime */
        u_int32_t ia6t_pltime;  /* prefix lifetime */
};

struct nd_ifinfo;
struct scope6_id;

struct in6_ifextra {
        struct in6_ifstat *in6_ifstat;
        struct icmp6_ifstat *icmp6_ifstat;
        struct nd_ifinfo *nd_ifinfo;
        struct scope6_id *scope6_id;
};

struct  in6_ifaddr {
        struct  ifaddr ia_ifa;          /* protocol-independent info */
#define ia_ifp          ia_ifa.ifa_ifp
#define ia_flags        ia_ifa.ifa_flags
        struct  sockaddr_in6 ia_addr;   /* interface address */
        struct  sockaddr_in6 ia_net;    /* network number of interface */
        struct  sockaddr_in6 ia_dstaddr; /* space for destination addr */
        struct  sockaddr_in6 ia_prefixmask; /* prefix mask */
        u_int32_t ia_plen;              /* prefix length */
        struct  in6_ifaddr *ia_next;    /* next in6 list of IP6 addresses */
        int     ia6_flags;

        struct in6_addrlifetime ia6_lifetime;
        /* back pointer to the ND prefix (for autoconfigured addresses only) */
        struct nd_prefix *ia6_ndpr;
};

/* control structure to manage address selection policy */
struct in6_addrpolicy {
        struct sockaddr_in6 addr; /* prefix address */
        struct sockaddr_in6 addrmask; /* prefix mask */
        int preced;             /* precedence */
        int label;              /* matching label */
        u_quad_t use;           /* statistics */
};

/*
 * IPv6 interface statistics, as defined in RFC2465 Ipv6IfStatsEntry (p12).
 */
struct in6_ifstat {
        u_quad_t ifs6_in_receive;       /* # of total input datagram */
        u_quad_t ifs6_in_hdrerr;        /* # of datagrams with invalid hdr */
        u_quad_t ifs6_in_toobig;        /* # of datagrams exceeded MTU */
        u_quad_t ifs6_in_noroute;       /* # of datagrams with no route */
        u_quad_t ifs6_in_addrerr;       /* # of datagrams with invalid dst */
        u_quad_t ifs6_in_protounknown;  /* # of datagrams with unknown proto */
                                        /* NOTE: increment on final dst if */
        u_quad_t ifs6_in_truncated;     /* # of truncated datagrams */
        u_quad_t ifs6_in_discard;       /* # of discarded datagrams */
                                        /* NOTE: fragment timeout is not here */
        u_quad_t ifs6_in_deliver;       /* # of datagrams delivered to ULP */
                                        /* NOTE: increment on final dst if */
        u_quad_t ifs6_out_forward;      /* # of datagrams forwarded */
                                        /* NOTE: increment on outgoing if */
        u_quad_t ifs6_out_request;      /* # of outgoing datagrams from ULP */
                                        /* NOTE: does not include forwrads */
        u_quad_t ifs6_out_discard;      /* # of discarded datagrams */
        u_quad_t ifs6_out_fragok;       /* # of datagrams fragmented */
        u_quad_t ifs6_out_fragfail;     /* # of datagrams failed on fragment */
        u_quad_t ifs6_out_fragcreat;    /* # of fragment datagrams */
                                        /* NOTE: this is # after fragment */
        u_quad_t ifs6_reass_reqd;       /* # of incoming fragmented packets */
                                        /* NOTE: increment on final dst if */
        u_quad_t ifs6_reass_ok;         /* # of reassembled packets */
                                        /* NOTE: this is # after reass */
                                        /* NOTE: increment on final dst if */
        u_quad_t ifs6_reass_fail;       /* # of reass failures */
                                        /* NOTE: may not be packet count */
                                        /* NOTE: increment on final dst if */
        u_quad_t ifs6_in_mcast;         /* # of inbound multicast datagrams */
        u_quad_t ifs6_out_mcast;        /* # of outbound multicast datagrams */
};

/*
 * ICMPv6 interface statistics, as defined in RFC2466 Ipv6IfIcmpEntry.
 * XXX: I'm not sure if this file is the right place for this structure...
 */
struct icmp6_ifstat {
        /*
         * Input statistics
         */
        /* ipv6IfIcmpInMsgs, total # of input messages */
        u_quad_t ifs6_in_msg;
        /* ipv6IfIcmpInErrors, # of input error messages */
        u_quad_t ifs6_in_error;
        /* ipv6IfIcmpInDestUnreachs, # of input dest unreach errors */
        u_quad_t ifs6_in_dstunreach;
        /* ipv6IfIcmpInAdminProhibs, # of input administratively prohibited errs */
        u_quad_t ifs6_in_adminprohib;
        /* ipv6IfIcmpInTimeExcds, # of input time exceeded errors */
        u_quad_t ifs6_in_timeexceed;
        /* ipv6IfIcmpInParmProblems, # of input parameter problem errors */
        u_quad_t ifs6_in_paramprob;
        /* ipv6IfIcmpInPktTooBigs, # of input packet too big errors */
        u_quad_t ifs6_in_pkttoobig;
        /* ipv6IfIcmpInEchos, # of input echo requests */
        u_quad_t ifs6_in_echo;
        /* ipv6IfIcmpInEchoReplies, # of input echo replies */
        u_quad_t ifs6_in_echoreply;
        /* ipv6IfIcmpInRouterSolicits, # of input router solicitations */
        u_quad_t ifs6_in_routersolicit;
        /* ipv6IfIcmpInRouterAdvertisements, # of input router advertisements */
        u_quad_t ifs6_in_routeradvert;
        /* ipv6IfIcmpInNeighborSolicits, # of input neighbor solicitations */
        u_quad_t ifs6_in_neighborsolicit;
        /* ipv6IfIcmpInNeighborAdvertisements, # of input neighbor advertisements */
        u_quad_t ifs6_in_neighboradvert;
        /* ipv6IfIcmpInRedirects, # of input redirects */
        u_quad_t ifs6_in_redirect;
        /* ipv6IfIcmpInGroupMembQueries, # of input MLD queries */
        u_quad_t ifs6_in_mldquery;
        /* ipv6IfIcmpInGroupMembResponses, # of input MLD reports */
        u_quad_t ifs6_in_mldreport;
        /* ipv6IfIcmpInGroupMembReductions, # of input MLD done */
        u_quad_t ifs6_in_mlddone;

        /*
         * Output statistics. We should solve unresolved routing problem...
         */
        /* ipv6IfIcmpOutMsgs, total # of output messages */
        u_quad_t ifs6_out_msg;
        /* ipv6IfIcmpOutErrors, # of output error messages */
        u_quad_t ifs6_out_error;
        /* ipv6IfIcmpOutDestUnreachs, # of output dest unreach errors */
        u_quad_t ifs6_out_dstunreach;
        /* ipv6IfIcmpOutAdminProhibs, # of output administratively prohibited errs */
        u_quad_t ifs6_out_adminprohib;
        /* ipv6IfIcmpOutTimeExcds, # of output time exceeded errors */
        u_quad_t ifs6_out_timeexceed;
        /* ipv6IfIcmpOutParmProblems, # of output parameter problem errors */
        u_quad_t ifs6_out_paramprob;
        /* ipv6IfIcmpOutPktTooBigs, # of output packet too big errors */
        u_quad_t ifs6_out_pkttoobig;
        /* ipv6IfIcmpOutEchos, # of output echo requests */
        u_quad_t ifs6_out_echo;
        /* ipv6IfIcmpOutEchoReplies, # of output echo replies */
        u_quad_t ifs6_out_echoreply;
        /* ipv6IfIcmpOutRouterSolicits, # of output router solicitations */
        u_quad_t ifs6_out_routersolicit;
        /* ipv6IfIcmpOutRouterAdvertisements, # of output router advertisements */
        u_quad_t ifs6_out_routeradvert;
        /* ipv6IfIcmpOutNeighborSolicits, # of output neighbor solicitations */
        u_quad_t ifs6_out_neighborsolicit;
        /* ipv6IfIcmpOutNeighborAdvertisements, # of output neighbor advertisements */
        u_quad_t ifs6_out_neighboradvert;
        /* ipv6IfIcmpOutRedirects, # of output redirects */
        u_quad_t ifs6_out_redirect;
        /* ipv6IfIcmpOutGroupMembQueries, # of output MLD queries */
        u_quad_t ifs6_out_mldquery;
        /* ipv6IfIcmpOutGroupMembResponses, # of output MLD reports */
        u_quad_t ifs6_out_mldreport;
        /* ipv6IfIcmpOutGroupMembReductions, # of output MLD done */
        u_quad_t ifs6_out_mlddone;
};

struct  in6_ifreq {
        char    ifr_name[IFNAMSIZ];
        union {
                struct  sockaddr_in6 ifru_addr;
                struct  sockaddr_in6 ifru_dstaddr;
                short   ifru_flags;
                int     ifru_flags6;
                int     ifru_metric;
                caddr_t ifru_data;
                struct in6_addrlifetime ifru_lifetime;
                struct in6_ifstat ifru_stat;
                struct icmp6_ifstat ifru_icmp6stat;
                u_int32_t ifru_scope_id[16];
        } ifr_ifru;
};

struct  in6_aliasreq {
        char    ifra_name[IFNAMSIZ];
        struct  sockaddr_in6 ifra_addr;
        struct  sockaddr_in6 ifra_dstaddr;
        struct  sockaddr_in6 ifra_prefixmask;
        int     ifra_flags;
        struct in6_addrlifetime ifra_lifetime;
};

/* prefix type macro */
#define IN6_PREFIX_ND   1
#define IN6_PREFIX_RR   2

/*
 * prefix related flags passed between kernel(NDP related part) and
 * user land command(ifconfig) and daemon(rtadvd).
 */
struct in6_prflags {
        struct prf_ra {
                u_char onlink : 1;
                u_char autonomous : 1;
                u_char reserved : 6;
        } prf_ra;
        u_char prf_reserved1;
        u_short prf_reserved2;
        /* want to put this on 4byte offset */
        struct prf_rr {
                u_char decrvalid : 1;
                u_char decrprefd : 1;
                u_char reserved : 6;
        } prf_rr;
        u_char prf_reserved3;
        u_short prf_reserved4;
};

struct  in6_prefixreq {
        char    ipr_name[IFNAMSIZ];
        u_char  ipr_origin;
        u_char  ipr_plen;
        u_int32_t ipr_vltime;
        u_int32_t ipr_pltime;
        struct in6_prflags ipr_flags;
        struct  sockaddr_in6 ipr_prefix;
};

#define PR_ORIG_RA      0
#define PR_ORIG_RR      1
#define PR_ORIG_STATIC  2
#define PR_ORIG_KERNEL  3

#define ipr_raf_onlink          ipr_flags.prf_ra.onlink
#define ipr_raf_auto            ipr_flags.prf_ra.autonomous

#define ipr_statef_onlink       ipr_flags.prf_state.onlink

#define ipr_rrf_decrvalid       ipr_flags.prf_rr.decrvalid
#define ipr_rrf_decrprefd       ipr_flags.prf_rr.decrprefd

struct  in6_rrenumreq {
        char    irr_name[IFNAMSIZ];
        u_char  irr_origin;
        u_char  irr_m_len;      /* match len for matchprefix */
        u_char  irr_m_minlen;   /* minlen for matching prefix */
        u_char  irr_m_maxlen;   /* maxlen for matching prefix */
        u_char  irr_u_uselen;   /* uselen for adding prefix */
        u_char  irr_u_keeplen;  /* keeplen from matching prefix */
        struct irr_raflagmask {
                u_char onlink : 1;
                u_char autonomous : 1;
                u_char reserved : 6;
        } irr_raflagmask;
        u_int32_t irr_vltime;
        u_int32_t irr_pltime;
        struct in6_prflags irr_flags;
        struct  sockaddr_in6 irr_matchprefix;
        struct  sockaddr_in6 irr_useprefix;
};

#define irr_raf_mask_onlink     irr_raflagmask.onlink
#define irr_raf_mask_auto       irr_raflagmask.autonomous
#define irr_raf_mask_reserved   irr_raflagmask.reserved

#define irr_raf_onlink          irr_flags.prf_ra.onlink
#define irr_raf_auto            irr_flags.prf_ra.autonomous

#define irr_statef_onlink       irr_flags.prf_state.onlink

#define irr_rrf                 irr_flags.prf_rr
#define irr_rrf_decrvalid       irr_flags.prf_rr.decrvalid
#define irr_rrf_decrprefd       irr_flags.prf_rr.decrprefd

/*
 * Given a pointer to an in6_ifaddr (ifaddr),
 * return a pointer to the addr as a sockaddr_in6
 */
#define IA6_IN6(ia)     (&((ia)->ia_addr.sin6_addr))
#define IA6_DSTIN6(ia)  (&((ia)->ia_dstaddr.sin6_addr))
#define IA6_MASKIN6(ia) (&((ia)->ia_prefixmask.sin6_addr))
#define IA6_SIN6(ia)    (&((ia)->ia_addr))
#define IA6_DSTSIN6(ia) (&((ia)->ia_dstaddr))
#define IFA_IN6(x)      (&((struct sockaddr_in6 *)((x)->ifa_addr))->sin6_addr)
#define IFA_DSTIN6(x)   (&((struct sockaddr_in6 *)((x)->ifa_dstaddr))->sin6_addr)

#define IFPR_IN6(x)     (&((struct sockaddr_in6 *)((x)->ifpr_prefix))->sin6_addr)

#ifdef _KERNEL
#define IN6_ARE_MASKED_ADDR_EQUAL(d, a, m)      (       \
        (((d)->s6_addr32[0] ^ (a)->s6_addr32[0]) & (m)->s6_addr32[0]) == 0 && \
        (((d)->s6_addr32[1] ^ (a)->s6_addr32[1]) & (m)->s6_addr32[1]) == 0 && \
        (((d)->s6_addr32[2] ^ (a)->s6_addr32[2]) & (m)->s6_addr32[2]) == 0 && \
        (((d)->s6_addr32[3] ^ (a)->s6_addr32[3]) & (m)->s6_addr32[3]) == 0 )
#endif

#define SIOCSIFADDR_IN6          _IOW('i', 12, struct in6_ifreq)
#define SIOCGIFADDR_IN6         _IOWR('i', 33, struct in6_ifreq)

#ifdef _KERNEL
/*
 * SIOCSxxx ioctls should be unused (see comments in in6.c), but
 * we do not shift numbers for binary compatibility.
 */
#define SIOCSIFDSTADDR_IN6       _IOW('i', 14, struct in6_ifreq)
#define SIOCSIFNETMASK_IN6       _IOW('i', 22, struct in6_ifreq)
#endif

#define SIOCGIFDSTADDR_IN6      _IOWR('i', 34, struct in6_ifreq)
#define SIOCGIFNETMASK_IN6      _IOWR('i', 37, struct in6_ifreq)

#define SIOCDIFADDR_IN6          _IOW('i', 25, struct in6_ifreq)
#define SIOCAIFADDR_IN6          _IOW('i', 26, struct in6_aliasreq)

#define SIOCSIFPHYADDR_IN6       _IOW('i', 70, struct in6_aliasreq)
#define SIOCGIFPSRCADDR_IN6     _IOWR('i', 71, struct in6_ifreq)
#define SIOCGIFPDSTADDR_IN6     _IOWR('i', 72, struct in6_ifreq)

#define SIOCGIFAFLAG_IN6        _IOWR('i', 73, struct in6_ifreq)

#define SIOCGDRLST_IN6          _IOWR('i', 74, struct in6_drlist)
#define SIOCGPRLST_IN6          _IOWR('i', 75, struct in6_prlist)
#ifdef _KERNEL
#define OSIOCGIFINFO_IN6        _IOWR('i', 76, struct in6_ondireq)
#endif
#define SIOCGIFINFO_IN6         _IOWR('i', 108, struct in6_ndireq)
#define SIOCSIFINFO_IN6         _IOWR('i', 109, struct in6_ndireq)
#define SIOCSNDFLUSH_IN6        _IOWR('i', 77, struct in6_ifreq)
#define SIOCGNBRINFO_IN6        _IOWR('i', 78, struct in6_nbrinfo)
#define SIOCSPFXFLUSH_IN6       _IOWR('i', 79, struct in6_ifreq)
#define SIOCSRTRFLUSH_IN6       _IOWR('i', 80, struct in6_ifreq)

#define SIOCGIFALIFETIME_IN6    _IOWR('i', 81, struct in6_ifreq)
#define SIOCSIFALIFETIME_IN6    _IOWR('i', 82, struct in6_ifreq)
#define SIOCGIFSTAT_IN6         _IOWR('i', 83, struct in6_ifreq)
#define SIOCGIFSTAT_ICMP6       _IOWR('i', 84, struct in6_ifreq)

#define SIOCSDEFIFACE_IN6       _IOWR('i', 85, struct in6_ndifreq)
#define SIOCGDEFIFACE_IN6       _IOWR('i', 86, struct in6_ndifreq)

#define SIOCSIFINFO_FLAGS       _IOWR('i', 87, struct in6_ndireq) /* XXX */

#define SIOCSSCOPE6             _IOW('i', 88, struct in6_ifreq)
#define SIOCGSCOPE6             _IOWR('i', 89, struct in6_ifreq)
#define SIOCGSCOPE6DEF          _IOWR('i', 90, struct in6_ifreq)

#define SIOCSIFPREFIX_IN6       _IOW('i', 100, struct in6_prefixreq) /* set */
#define SIOCGIFPREFIX_IN6       _IOWR('i', 101, struct in6_prefixreq) /* get */
#define SIOCDIFPREFIX_IN6       _IOW('i', 102, struct in6_prefixreq) /* del */
#define SIOCAIFPREFIX_IN6       _IOW('i', 103, struct in6_rrenumreq) /* add */
#define SIOCCIFPREFIX_IN6       _IOW('i', 104, \
                                     struct in6_rrenumreq) /* change */
#define SIOCSGIFPREFIX_IN6      _IOW('i', 105, \
                                     struct in6_rrenumreq) /* set global */

#define SIOCGETSGCNT_IN6        _IOWR('u', 106, \
                                      struct sioc_sg_req6) /* get s,g pkt cnt */
#define SIOCGETMIFCNT_IN6       _IOWR('u', 107, \
                                      struct sioc_mif_req6) /* get pkt cnt per if */

#define SIOCAADDRCTL_POLICY     _IOW('u', 108, struct in6_addrpolicy)
#define SIOCDADDRCTL_POLICY     _IOW('u', 109, struct in6_addrpolicy)

#define IN6_IFF_ANYCAST         0x01    /* anycast address */
#define IN6_IFF_TENTATIVE       0x02    /* tentative address */
#define IN6_IFF_DUPLICATED      0x04    /* DAD detected duplicate */
#define IN6_IFF_DETACHED        0x08    /* may be detached from the link */
#define IN6_IFF_DEPRECATED      0x10    /* deprecated address */
#define IN6_IFF_NODAD           0x20    /* don't perform DAD on this address
                                         * (used only at first SIOC* call)
                                         */
#define IN6_IFF_AUTOCONF        0x40    /* autoconfigurable address. */
#define IN6_IFF_TEMPORARY       0x80    /* temporary (anonymous) address. */
#define IN6_IFF_NOPFX           0x8000  /* skip kernel prefix management.
                                         * XXX: this should be temporary.
                                         */

/* do not input/output */
#define IN6_IFF_NOTREADY (IN6_IFF_TENTATIVE|IN6_IFF_DUPLICATED)

#ifdef _KERNEL
#define IN6_ARE_SCOPE_CMP(a,b) ((a)-(b))
#define IN6_ARE_SCOPE_EQUAL(a,b) ((a)==(b))
#endif

#ifdef _KERNEL
extern struct in6_ifaddr *in6_ifaddr;

extern struct icmp6stat icmp6stat;
#define in6_ifstat_inc(ifp, tag) \
do {                                                                    \
        struct in6_ifextra *xtra;                                       \
        if ((ifp) && (xtra = (ifp)->if_afdata[AF_INET6]) != NULL)       \
                xtra->in6_ifstat->tag++;                                \
} while (0)

extern struct ifqueue ip6intrq;         /* IP6 packet input queue */
extern struct in6_addr zeroin6_addr;
extern u_char inet6ctlerrmap[];
extern unsigned long in6_maxmtu;
#ifdef MALLOC_DECLARE
MALLOC_DECLARE(M_IPMADDR);
#endif

/*
 * Macro for finding the internet address structure (in6_ifaddr) corresponding
 * to a given interface (ifnet structure).
 */

#define IFP_TO_IA6(ifp, ia)                             \
/* struct ifnet *ifp; */                                \
/* struct in6_ifaddr *ia; */                            \
do {                                                                    \
        struct ifaddr_container *ifac;                                  \
        TAILQ_FOREACH(ifac, &(ifp)->if_addrheads[mycpuid], ifa_list) {  \
                if (!ifac->ifa->ifa_addr)                               \
                        continue;                                       \
                if (ifac->ifa->ifa_addr->sa_family == AF_INET6)         \
                        break;                                          \
        }                                                               \
        (ia) = ifac == NULL ? NULL : (struct in6_ifaddr *)(ifac->ifa);  \
} while (0)

#endif /* _KERNEL */

/*
 * Multi-cast membership entry.  One for each group/ifp that a PCB
 * belongs to.
 */
struct in6_multi_mship {
        struct  in6_multi *i6mm_maddr;  /* Multicast address pointer */
        LIST_ENTRY(in6_multi_mship) i6mm_chain;  /* multicast options chain */
};

struct  in6_multi {
        LIST_ENTRY(in6_multi) in6m_entry; /* list glue */
        struct  in6_addr in6m_addr;     /* IP6 multicast address */
        struct  ifnet *in6m_ifp;        /* back pointer to ifnet */
        struct  ifmultiaddr *in6m_ifma; /* back pointer to ifmultiaddr */
        u_int   in6m_refcount;          /* # membership claims by sockets */
        u_int   in6m_state;             /* state of the membership */
        u_int   in6m_timer;             /* MLD6 listener report timer */
};

#ifdef _KERNEL
extern LIST_HEAD(in6_multihead, in6_multi) in6_multihead;

/*
 * Structure used by macros below to remember position when stepping through
 * all of the in6_multi records.
 */
struct  in6_multistep {
        struct  in6_ifaddr *i_ia;
        struct  in6_multi *i_in6m;
};

/*
 * Look up the in6_multi record for a given IP6 multicast address on a given
 * interface.  If no matching record is found, NULL is returned.
 */
static __inline struct in6_multi *
IN6_LOOKUP_MULTI(const struct in6_addr *_addr, struct ifnet *_ifp)
{
        const struct ifmultiaddr *_ifma;
        struct in6_multi *_in6m = NULL;

        /* TODO: need ifnet_serialize_main */
        ifnet_serialize_all(_ifp);
        TAILQ_FOREACH(_ifma, &_ifp->if_multiaddrs, ifma_link) {
                if (_ifma->ifma_addr->sa_family == AF_INET6 &&
                    IN6_ARE_ADDR_EQUAL(
                    &((struct sockaddr_in6 *)_ifma->ifma_addr)->sin6_addr,
                    _addr)) {
                        _in6m = _ifma->ifma_protospec;
                        break;
                }
        }
        ifnet_deserialize_all(_ifp);

        return _in6m;
}

/*
 * Macro to step through all of the in6_multi records, one at a time.
 * The current position is remembered in "step", which the caller must
 * provide.  IN6_FIRST_MULTI(), below, must be called to initialize "step"
 * and get the first record.  Both macros return a NULL "in6m" when there
 * are no remaining records.
 */
#define IN6_NEXT_MULTI(step, in6m)                                      \
/* struct in6_multistep step; */                                        \
/* struct in6_multi *in6m; */                                           \
do { \
        if (((in6m) = (step).i_in6m) != NULL) \
                (step).i_in6m = (step).i_in6m->in6m_entry.le_next; \
} while(0)

#define IN6_FIRST_MULTI(step, in6m)             \
/* struct in6_multistep step; */                \
/* struct in6_multi *in6m */                    \
do { \
        (step).i_in6m = in6_multihead.lh_first; \
                IN6_NEXT_MULTI((step), (in6m)); \
} while(0)

struct  in6_multi *in6_addmulti (struct in6_addr *, struct ifnet *, int *);
void    in6_delmulti (struct in6_multi *);
struct  in6_multi_mship *in6_joingroup(struct ifnet *, struct in6_addr *, int *);
int     in6_leavegroup(struct in6_multi_mship *);

int     in6_mask2len(const struct in6_addr *, const u_char *);
void    in6_control_dispatch(netmsg_t msg);
int     in6_control(u_long, caddr_t, struct ifnet *, struct thread *);
int     in6_update_ifa (struct ifnet *, struct in6_aliasreq *,
                        struct in6_ifaddr *);
void    in6_purgeaddr (struct ifaddr *);
int     in6if_do_dad (struct ifnet *);
void    in6_purgeif (struct ifnet *);
void    in6_savemkludge (struct in6_ifaddr *);
void    in6_if_up(struct ifnet *);
void    in6_if_down(struct ifnet *);
void    *in6_domifattach (struct ifnet *);
void    in6_domifdetach (struct ifnet *, void *);
void    in6_setmaxmtu   (void);
void    in6_restoremkludge (struct in6_ifaddr *, struct ifnet *);
void    in6_purgemkludge (struct ifnet *);
struct in6_ifaddr *in6ifa_ifpforlinklocal (struct ifnet *, int);
struct in6_ifaddr *in6ifa_ifpwithaddr (struct ifnet *, struct in6_addr *);
struct in6_ifaddr *in6ifa_llaonifp(struct ifnet *);
char    *ip6_sprintf (const struct in6_addr *);
int     in6_addr2zoneid(struct ifnet *, struct in6_addr *, u_int32_t *);
int     in6_matchlen (struct in6_addr *, struct in6_addr *);
int     in6_are_prefix_equal(struct in6_addr *p1, struct in6_addr *p2, int len);
void    in6_prefixlen2mask(struct in6_addr *maskp, int len);
void    in6_newaddrmsg(struct ifaddr *);
void    in6_ifremloop(struct ifaddr *);
void    in6_ifaddloop(struct ifaddr *);

int     in6_is_addr_deprecated (struct sockaddr_in6 *);
struct inpcb;
int in6_embedscope (struct in6_addr *, const struct sockaddr_in6 *,
        struct inpcb *, struct ifnet **);
int in6_recoverscope (struct sockaddr_in6 *, const struct in6_addr *,
        struct ifnet *);
void in6_clearscope (struct in6_addr *);
int in6_src_ioctl (u_long, caddr_t);
#endif /* _KERNEL */

#endif /* _NETINET6_IN6_VAR_H_ */