root/sys/netinet6/in6_var.h
/*      $OpenBSD: in6_var.h,v 1.85 2026/03/22 23:14:00 bluhm Exp $      */
/*      $KAME: in6_var.h,v 1.55 2001/02/16 12:49:45 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_

/*
 *  Locks used to protect struct members in this file:
 *      I       immutable after creation
 *      m       multicast if_maddrlock rwlock of parent interface
 */

/*
 * 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 */
};

#ifdef _KERNEL
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_gwaddr; /* router we learned address from */
        struct  sockaddr_in6 ia_dstaddr; /* space for destination addr */
        struct  sockaddr_in6 ia_prefixmask; /* prefix mask */
        TAILQ_ENTRY(in6_ifaddr) ia_list;        /* list of IP6 addresses */
        int     ia6_flags;

        struct in6_addrlifetime ia6_lifetime;
        time_t  ia6_updatetime;

        /* multicast addresses joined from the kernel */
        LIST_HEAD(, in6_multi_mship) ia6_memberships;
};
#endif /* _KERNEL */

/*
 * IPv6 interface statistics, as defined in RFC2465 Ipv6IfStatsEntry (p12).
 */
struct in6_ifstat {
        u_int64_t ifs6_in_receive;      /* # of total input datagram */
        u_int64_t ifs6_in_hdrerr;       /* # of datagrams with invalid hdr */
        u_int64_t ifs6_in_toobig;       /* # of datagrams exceeded MTU */
        u_int64_t ifs6_in_noroute;      /* # of datagrams with no route */
        u_int64_t ifs6_in_addrerr;      /* # of datagrams with invalid dst */
        u_int64_t ifs6_in_protounknown; /* # of datagrams with unknown proto */
                                        /* NOTE: increment on final dst if */
        u_int64_t ifs6_in_truncated;    /* # of truncated datagrams */
        u_int64_t ifs6_in_discard;      /* # of discarded datagrams */
                                        /* NOTE: fragment timeout is not here */
        u_int64_t ifs6_in_deliver;      /* # of datagrams delivered to ULP */
                                        /* NOTE: increment on final dst if */
        u_int64_t ifs6_out_forward;     /* # of datagrams forwarded */
                                        /* NOTE: increment on outgoing if */
        u_int64_t ifs6_out_request;     /* # of outgoing datagrams from ULP */
                                        /* NOTE: does not include forwards */
        u_int64_t ifs6_out_discard;     /* # of discarded datagrams */
        u_int64_t ifs6_out_fragok;      /* # of datagrams fragmented */
        u_int64_t ifs6_out_fragfail;    /* # of datagrams failed on fragment */
        u_int64_t ifs6_out_fragcreat;   /* # of fragment datagrams */
                                        /* NOTE: this is # after fragment */
        u_int64_t ifs6_reass_reqd;      /* # of incoming fragmented packets */
                                        /* NOTE: increment on final dst if */
        u_int64_t ifs6_reass_ok;        /* # of reassembled packets */
                                        /* NOTE: this is # after reass */
                                        /* NOTE: increment on final dst if */
        u_int64_t ifs6_reass_fail;      /* # of reass failures */
                                        /* NOTE: may not be packet count */
                                        /* NOTE: increment on final dst if */
        u_int64_t ifs6_in_mcast;        /* # of inbound multicast datagrams */
        u_int64_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_int64_t ifs6_in_msg;
        /* ipv6IfIcmpInErrors, # of input error messages */
        u_int64_t ifs6_in_error;
        /* ipv6IfIcmpInDestUnreachs, # of input dest unreach errors */
        u_int64_t ifs6_in_dstunreach;
        /* ipv6IfIcmpInAdminProhibs, # of input administratively prohibited errs */
        u_int64_t ifs6_in_adminprohib;
        /* ipv6IfIcmpInTimeExcds, # of input time exceeded errors */
        u_int64_t ifs6_in_timeexceed;
        /* ipv6IfIcmpInParmProblems, # of input parameter problem errors */
        u_int64_t ifs6_in_paramprob;
        /* ipv6IfIcmpInPktTooBigs, # of input packet too big errors */
        u_int64_t ifs6_in_pkttoobig;
        /* ipv6IfIcmpInEchos, # of input echo requests */
        u_int64_t ifs6_in_echo;
        /* ipv6IfIcmpInEchoReplies, # of input echo replies */
        u_int64_t ifs6_in_echoreply;
        /* ipv6IfIcmpInRouterSolicits, # of input router solicitations */
        u_int64_t ifs6_in_routersolicit;
        /* ipv6IfIcmpInRouterAdvertisements, # of input router advertisements */
        u_int64_t ifs6_in_routeradvert;
        /* ipv6IfIcmpInNeighborSolicits, # of input neighbor solicitations */
        u_int64_t ifs6_in_neighborsolicit;
        /* ipv6IfIcmpInNeighborAdvertisements, # of input neighbor advertisements */
        u_int64_t ifs6_in_neighboradvert;
        /* ipv6IfIcmpInRedirects, # of input redirects */
        u_int64_t ifs6_in_redirect;
        /* ipv6IfIcmpInGroupMembQueries, # of input MLD queries */
        u_int64_t ifs6_in_mldquery;
        /* ipv6IfIcmpInGroupMembResponses, # of input MLD reports */
        u_int64_t ifs6_in_mldreport;
        /* ipv6IfIcmpInGroupMembReductions, # of input MLD done */
        u_int64_t ifs6_in_mlddone;

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

struct  in6_aliasreq {
        char    ifra_name[IFNAMSIZ];
        union {
                struct  sockaddr_in6 ifrau_addr;
                int     ifrau_align;
         } ifra_ifrau;
#ifndef ifra_addr
#define ifra_addr       ifra_ifrau.ifrau_addr
#endif
        struct  sockaddr_in6 ifra_dstaddr;
        struct  sockaddr_in6 ifra_prefixmask;
        int     ifra_flags;
        struct in6_addrlifetime ifra_lifetime;
};

/*
 * 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 SIOCDIFADDR_IN6          _IOW('i', 25, struct in6_ifreq)
#define SIOCAIFADDR_IN6          _IOW('i', 26, struct in6_aliasreq)

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

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

#define SIOCGIFINFO_IN6         _IOWR('i', 108, struct in6_ndireq)
#define SIOCGNBRINFO_IN6        _IOWR('i', 78, struct in6_nbrinfo)

#define SIOCGIFALIFETIME_IN6    _IOWR('i', 81, struct in6_ifreq)

#define SIOCGETSGCNT_IN6        _IOWR('u', 106, struct sioc_sg_req6)
#define SIOCGETMIFCNT_IN6       _IOWR('u', 107, struct sioc_mif_req6)

#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_AUTOCONF        0x40    /* autoconfigurable address. */
#define IN6_IFF_TEMPORARY       0x80    /* RFC 4941 temporary address */

#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 )

#define IN6_ARE_SCOPE_CMP(a,b) ((a)-(b))
#define IN6_ARE_SCOPE_EQUAL(a,b) ((a)==(b))

/*
 * 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 {
        struct ifmaddr          in6m_ifma;   /* Protocol-independent info */
#define in6m_refcnt             in6m_ifma.ifma_refcnt
#define in6m_ifidx              in6m_ifma.ifma_ifidx

        struct sockaddr_in6     in6m_sin;   /* [I] IPv6 multicast address */
#define in6m_addr               in6m_sin.sin6_addr

        u_int                   in6m_state; /* [m] state of membership */
        u_int                   in6m_timer; /* [m] MLD6 membership report */
};

static __inline struct in6_multi *
ifmatoin6m(struct ifmaddr *ifma)
{
       return ((struct in6_multi *)(ifma));
}

struct  in6_multi *in6_lookupmulti(const struct in6_addr *, struct ifnet *);
struct  in6_multi *in6_addmulti(const struct in6_addr *, struct ifnet *, int *);
void    in6_delmulti(struct in6_multi *);
int     in6_hasmulti(const struct in6_addr *, struct ifnet *);
struct in6_multi_mship *in6_joingroup(struct ifnet *, const struct in6_addr *,
            int *);
void    in6_leavegroup(struct in6_multi_mship *);
int     in6_control(struct socket *, u_long, caddr_t, struct ifnet *);
int     in6_ioctl(u_long, caddr_t, struct ifnet *, int);
int     in6_update_ifa(struct ifnet *, struct in6_aliasreq *,
        struct in6_ifaddr *);
void    in6_purgeaddr(struct ifaddr *);
int     in6if_do_dad(struct ifnet *);
struct in6_ifaddr *in6ifa_ifpforlinklocal(struct ifnet *, int);
struct in6_ifaddr *in6ifa_ifpwithaddr(struct ifnet *, struct in6_addr *);
int     in6_addr2scopeid(unsigned int, const struct in6_addr *);
int     in6_matchlen(const struct in6_addr *, const struct in6_addr *);
void    in6_prefixlen2mask(struct in6_addr *, int);
#endif /* _KERNEL */

#endif /* _NETINET6_IN6_VAR_H_ */