/*-
 * SPDX-License-Identifier: BSD-2-Clause
 *
 * Copyright (c) 2001 Daniel Hartmeier
 * Copyright (c) 2003 Cedric Berger
 * Copyright (c) 2005 Henning Brauer <henning@openbsd.org>
 * Copyright (c) 2005 Ryan McBride <mcbride@openbsd.org>
 * Copyright (c) 2012 Gleb Smirnoff <glebius@FreeBSD.org>
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 *    - Redistributions of source code must retain the above copyright
 *      notice, this list of conditions and the following disclaimer.
 *    - 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.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS 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
 * COPYRIGHT HOLDERS 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.
 *
 *      $OpenBSD: pf_if.c,v 1.54 2008/06/14 16:55:28 mk Exp $
 */

#include <sys/cdefs.h>
#include "opt_inet.h"
#include "opt_inet6.h"

#include <sys/param.h>
#include <sys/kernel.h>
#include <sys/eventhandler.h>
#include <sys/lock.h>
#include <sys/mbuf.h>
#include <sys/socket.h>

#include <net/if.h>
#include <net/if_var.h>
#include <net/if_private.h>
#include <net/vnet.h>
#include <net/pfvar.h>
#include <net/route.h>

VNET_DEFINE(struct pfi_kkif *,   pfi_all);
VNET_DEFINE_STATIC(long, pfi_update);
#define V_pfi_update    VNET(pfi_update)
#define PFI_BUFFER_MAX  0x10000

VNET_DECLARE(int, pf_vnet_active);
#define V_pf_vnet_active        VNET(pf_vnet_active)

VNET_DEFINE_STATIC(struct pfr_addr *, pfi_buffer);
VNET_DEFINE_STATIC(int, pfi_buffer_cnt);
VNET_DEFINE_STATIC(int, pfi_buffer_max);
#define V_pfi_buffer             VNET(pfi_buffer)
#define V_pfi_buffer_cnt         VNET(pfi_buffer_cnt)
#define V_pfi_buffer_max         VNET(pfi_buffer_max)

#ifdef PF_WANT_32_TO_64_COUNTER
VNET_DEFINE(struct allkiflist_head, pf_allkiflist);
VNET_DEFINE(size_t, pf_allkifcount);
VNET_DEFINE(struct pfi_kkif *, pf_kifmarker);
#endif

static eventhandler_tag  pfi_attach_cookie;
static eventhandler_tag  pfi_detach_cookie;
static eventhandler_tag  pfi_rename_cookie;
static eventhandler_tag  pfi_attach_group_cookie;
static eventhandler_tag  pfi_change_group_cookie;
static eventhandler_tag  pfi_detach_group_cookie;
static eventhandler_tag  pfi_ifaddr_event_cookie;

static void      pfi_attach_ifnet(struct ifnet *, struct pfi_kkif *);
static void      pfi_attach_ifgroup(struct ifg_group *, struct pfi_kkif *);

static void      pfi_kkif_update(struct pfi_kkif *);
static void      pfi_dynaddr_update(struct pfi_dynaddr *dyn);
static void      pfi_table_update(struct pfr_ktable *, struct pfi_kkif *, uint8_t,
                    int);
static void      pfi_instance_add(struct ifnet *, uint8_t, int);
static void      pfi_address_add(struct sockaddr *, sa_family_t, uint8_t);
static int       pfi_kkif_compare(struct pfi_kkif *, struct pfi_kkif *);
static int       pfi_skip_if(const char *, struct pfi_kkif *);
static int       pfi_unmask(void *);
static void      pfi_attach_ifnet_event(void * __unused, struct ifnet *);
static void      pfi_detach_ifnet_event(void * __unused, struct ifnet *);
static void      pfi_rename_ifnet_event(void * __unused, struct ifnet *);
static void      pfi_attach_group_event(void * __unused, struct ifg_group *);
static void      pfi_change_group_event(void * __unused, char *);
static void      pfi_detach_group_event(void * __unused, struct ifg_group *);
static void      pfi_ifaddr_event(void * __unused, struct ifnet *);

RB_HEAD(pfi_ifhead, pfi_kkif);
static RB_PROTOTYPE(pfi_ifhead, pfi_kkif, pfik_tree, pfi_kkif_compare);
static RB_GENERATE(pfi_ifhead, pfi_kkif, pfik_tree, pfi_kkif_compare);
VNET_DEFINE_STATIC(struct pfi_ifhead, pfi_ifs);
#define V_pfi_ifs       VNET(pfi_ifs)

#define PFI_BUFFER_MAX          0x10000
MALLOC_DEFINE(PFI_MTYPE, "pf_ifnet", "pf(4) interface database");

LIST_HEAD(pfi_list, pfi_kkif);
VNET_DEFINE_STATIC(struct pfi_list, pfi_unlinked_kifs);
#define V_pfi_unlinked_kifs     VNET(pfi_unlinked_kifs)
static struct mtx pfi_unlnkdkifs_mtx;
MTX_SYSINIT(pfi_unlnkdkifs_mtx, &pfi_unlnkdkifs_mtx, "pf unlinked interfaces",
    MTX_DEF);

void
pfi_initialize_vnet(void)
{
        struct pfi_list kifs = LIST_HEAD_INITIALIZER();
        struct epoch_tracker et;
        struct pfi_kkif *kif;
        struct ifg_group *ifg;
        struct ifnet *ifp;
        int nkifs;

        V_pfi_buffer_max = 64;
        V_pfi_buffer = malloc(V_pfi_buffer_max * sizeof(*V_pfi_buffer),
            PFI_MTYPE, M_WAITOK);

        nkifs = 1;      /* one for V_pfi_all */
        IFNET_RLOCK();
        CK_STAILQ_FOREACH(ifg, &V_ifg_head, ifg_next)
                nkifs++;
        CK_STAILQ_FOREACH(ifp, &V_ifnet, if_link)
                nkifs++;

        for (int n = 0; n < nkifs; n++) {
                kif = pf_kkif_create(M_WAITOK);
                LIST_INSERT_HEAD(&kifs, kif, pfik_list);
        }

        NET_EPOCH_ENTER(et);
        PF_RULES_WLOCK();
        kif = LIST_FIRST(&kifs);
        LIST_REMOVE(kif, pfik_list);
        V_pfi_all = pfi_kkif_attach(kif, IFG_ALL);
        CK_STAILQ_FOREACH(ifg, &V_ifg_head, ifg_next) {
                kif = LIST_FIRST(&kifs);
                LIST_REMOVE(kif, pfik_list);
                pfi_attach_ifgroup(ifg, kif);
        }
        CK_STAILQ_FOREACH(ifp, &V_ifnet, if_link) {
                kif = LIST_FIRST(&kifs);
                LIST_REMOVE(kif, pfik_list);
                pfi_attach_ifnet(ifp, kif);
        }
        PF_RULES_WUNLOCK();
        NET_EPOCH_EXIT(et);
        IFNET_RUNLOCK();

        MPASS(LIST_EMPTY(&kifs));
}

void
pfi_initialize(void)
{

        pfi_attach_cookie = EVENTHANDLER_REGISTER(ifnet_arrival_event,
            pfi_attach_ifnet_event, NULL, EVENTHANDLER_PRI_ANY);
        pfi_detach_cookie = EVENTHANDLER_REGISTER(ifnet_departure_event,
            pfi_detach_ifnet_event, NULL, EVENTHANDLER_PRI_ANY);
        pfi_rename_cookie = EVENTHANDLER_REGISTER(ifnet_rename_event,
            pfi_rename_ifnet_event, NULL, EVENTHANDLER_PRI_ANY);
        pfi_attach_group_cookie = EVENTHANDLER_REGISTER(group_attach_event,
            pfi_attach_group_event, NULL, EVENTHANDLER_PRI_ANY);
        pfi_change_group_cookie = EVENTHANDLER_REGISTER(group_change_event,
            pfi_change_group_event, NULL, EVENTHANDLER_PRI_ANY);
        pfi_detach_group_cookie = EVENTHANDLER_REGISTER(group_detach_event,
            pfi_detach_group_event, NULL, EVENTHANDLER_PRI_ANY);
        pfi_ifaddr_event_cookie = EVENTHANDLER_REGISTER(ifaddr_event,
            pfi_ifaddr_event, NULL, EVENTHANDLER_PRI_ANY);
}

void
pfi_cleanup_vnet(void)
{
        struct pfi_kkif *kif;

        PF_RULES_WASSERT();

        V_pfi_all = NULL;
        while ((kif = RB_MIN(pfi_ifhead, &V_pfi_ifs))) {
                RB_REMOVE(pfi_ifhead, &V_pfi_ifs, kif);
                if (kif->pfik_group)
                        kif->pfik_group->ifg_pf_kif = NULL;
                if (kif->pfik_ifp) {
                        if_rele(kif->pfik_ifp);
                        kif->pfik_ifp->if_pf_kif = NULL;
                }
                pf_kkif_free(kif);
        }

        mtx_lock(&pfi_unlnkdkifs_mtx);
        while ((kif = LIST_FIRST(&V_pfi_unlinked_kifs))) {
                LIST_REMOVE(kif, pfik_list);
                pf_kkif_free(kif);
        }
        mtx_unlock(&pfi_unlnkdkifs_mtx);

        free(V_pfi_buffer, PFI_MTYPE);
}

void
pfi_cleanup(void)
{

        EVENTHANDLER_DEREGISTER(ifnet_arrival_event, pfi_attach_cookie);
        EVENTHANDLER_DEREGISTER(ifnet_departure_event, pfi_detach_cookie);
        EVENTHANDLER_DEREGISTER(group_attach_event, pfi_attach_group_cookie);
        EVENTHANDLER_DEREGISTER(group_change_event, pfi_change_group_cookie);
        EVENTHANDLER_DEREGISTER(group_detach_event, pfi_detach_group_cookie);
        EVENTHANDLER_DEREGISTER(ifaddr_event, pfi_ifaddr_event_cookie);
}

struct pfi_kkif*
pf_kkif_create(int flags)
{
        struct pfi_kkif *kif;
#ifdef PF_WANT_32_TO_64_COUNTER
        bool wowned;
#endif

        kif = malloc(sizeof(*kif), PFI_MTYPE, flags | M_ZERO);
        if (! kif)
                return (kif);

        for (int i = 0; i < 2; i++) {
                for (int j = 0; j < 2; j++) {
                        for (int k = 0; k < 2; k++) {
                                if (pf_counter_u64_init(&kif->pfik_packets[i][j][k], flags) != 0) {
                                        pf_kkif_free(kif);
                                        return (NULL);
                                }

                                if (pf_counter_u64_init(&kif->pfik_bytes[i][j][k], flags) != 0) {
                                        pf_kkif_free(kif);
                                        return (NULL);
                                }
                        }
                }
        }

#ifdef PF_WANT_32_TO_64_COUNTER
        wowned = PF_RULES_WOWNED();
        if (!wowned)
                PF_RULES_WLOCK();
        LIST_INSERT_HEAD(&V_pf_allkiflist, kif, pfik_allkiflist);
        V_pf_allkifcount++;
        if (!wowned)
                PF_RULES_WUNLOCK();
#endif

        return (kif);
}

void
pf_kkif_free(struct pfi_kkif *kif)
{
#ifdef PF_WANT_32_TO_64_COUNTER
        bool wowned;
#endif

        if (! kif)
                return;

#ifdef INVARIANTS
        if (kif->pfik_ifp) {
                struct ifnet *ifp = kif->pfik_ifp;
                MPASS(ifp->if_pf_kif == NULL || ifp->if_pf_kif == kif);
        }
#endif

#ifdef PF_WANT_32_TO_64_COUNTER
        wowned = PF_RULES_WOWNED();
        if (!wowned)
                PF_RULES_WLOCK();
        LIST_REMOVE(kif, pfik_allkiflist);
        V_pf_allkifcount--;
        if (!wowned)
                PF_RULES_WUNLOCK();
#endif

        for (int i = 0; i < 2; i++) {
                for (int j = 0; j < 2; j++) {
                        for (int k = 0; k < 2; k++) {
                                pf_counter_u64_deinit(&kif->pfik_packets[i][j][k]);
                                pf_counter_u64_deinit(&kif->pfik_bytes[i][j][k]);
                        }
                }
        }

        free(kif, PFI_MTYPE);
}

void
pf_kkif_zero(struct pfi_kkif *kif)
{

        for (int i = 0; i < 2; i++) {
                for (int j = 0; j < 2; j++) {
                        for (int k = 0; k < 2; k++) {
                                pf_counter_u64_zero(&kif->pfik_packets[i][j][k]);
                                pf_counter_u64_zero(&kif->pfik_bytes[i][j][k]);
                        }
                }
        }
        kif->pfik_tzero = time_second;
}

struct pfi_kkif *
pfi_kkif_find(const char *kif_name)
{
        struct pfi_kif_cmp s;

        PF_RULES_ASSERT();

        memset(&s, 0, sizeof(s));
        strlcpy(s.pfik_name, kif_name, sizeof(s.pfik_name));

        return (RB_FIND(pfi_ifhead, &V_pfi_ifs, (struct pfi_kkif *)&s));
}

struct pfi_kkif *
pfi_kkif_attach(struct pfi_kkif *kif, const char *kif_name)
{
        struct pfi_kkif *kif1;

        PF_RULES_WASSERT();
        KASSERT(kif != NULL, ("%s: null kif", __func__));

        kif1 = pfi_kkif_find(kif_name);
        if (kif1 != NULL) {
                pf_kkif_free(kif);
                return (kif1);
        }

        pf_kkif_zero(kif);
        strlcpy(kif->pfik_name, kif_name, sizeof(kif->pfik_name));
        /*
         * It seems that the value of time_second is in unintialzied state
         * when pf sets interface statistics clear time in boot phase if pf
         * was statically linked to kernel. Instead of setting the bogus
         * time value have pfi_get_ifaces handle this case. In
         * pfi_get_ifaces it uses time_second if it sees the time is 0.
         */
        kif->pfik_tzero = time_second > 1 ? time_second : 0;
        TAILQ_INIT(&kif->pfik_dynaddrs);

        if (!strcmp(kif->pfik_name, "any")) {
                /* both so it works in the ioctl and the regular case */
                kif->pfik_flags |= PFI_IFLAG_ANY;
        }

        RB_INSERT(pfi_ifhead, &V_pfi_ifs, kif);

        return (kif);
}

void
pfi_kkif_ref(struct pfi_kkif *kif)
{

        PF_RULES_WASSERT();
        kif->pfik_rulerefs++;
}

static void
pfi_kkif_remove_if_unref(struct pfi_kkif *kif)
{

        PF_RULES_WASSERT();

        if (kif->pfik_rulerefs > 0)
                return;

        /* kif referencing an existing ifnet or group or holding flags should
         * exist. */
        if (kif->pfik_ifp != NULL || kif->pfik_group != NULL ||
            kif == V_pfi_all || kif->pfik_flags != 0)
                return;

        /*
         * We can get here in at least two distinct paths:
         * - when the struct ifnet is removed, via pfi_detach_ifnet_event()
         * - when a rule referencing us is removed, via pfi_kkif_unref().
         * These two events can race against each other, leading us to free this kif
         * twice. That leads to a loop in V_pfi_unlinked_kifs, and an eventual
         * deadlock.
         *
         * Avoid this by making sure we only ever insert the kif into
         * V_pfi_unlinked_kifs once.
         * If we don't find it in V_pfi_ifs it's already been removed. Check that it
         * exists in V_pfi_unlinked_kifs.
         */
        if (! RB_FIND(pfi_ifhead, &V_pfi_ifs, kif)) {
#ifdef INVARIANTS
                struct pfi_kkif *tmp;
                bool found = false;
                mtx_lock(&pfi_unlnkdkifs_mtx);
                LIST_FOREACH(tmp, &V_pfi_unlinked_kifs, pfik_list) {
                        if (tmp == kif) {
                                found = true;
                                break;
                        }
                }
                mtx_unlock(&pfi_unlnkdkifs_mtx);
                MPASS(found);
#endif
                return;
        }
        RB_REMOVE(pfi_ifhead, &V_pfi_ifs, kif);

        kif->pfik_flags |= PFI_IFLAG_REFS;

        mtx_lock(&pfi_unlnkdkifs_mtx);
        LIST_INSERT_HEAD(&V_pfi_unlinked_kifs, kif, pfik_list);
        mtx_unlock(&pfi_unlnkdkifs_mtx);
}

void
pfi_kkif_unref(struct pfi_kkif *kif)
{

        PF_RULES_WASSERT();
        KASSERT(kif->pfik_rulerefs > 0, ("%s: %p has zero refs", __func__, kif));

        kif->pfik_rulerefs--;

        pfi_kkif_remove_if_unref(kif);
}

void
pfi_kkif_purge(void)
{
        struct pfi_kkif *kif, *kif1;

        /*
         * Do naive mark-and-sweep garbage collecting of old kifs.
         * Reference flag is raised by pf_purge_expired_states().
         */
        mtx_lock(&pfi_unlnkdkifs_mtx);
        LIST_FOREACH_SAFE(kif, &V_pfi_unlinked_kifs, pfik_list, kif1) {
                if (!(kif->pfik_flags & PFI_IFLAG_REFS)) {
                        LIST_REMOVE(kif, pfik_list);
                        pf_kkif_free(kif);
                } else
                        kif->pfik_flags &= ~PFI_IFLAG_REFS;
        }
        mtx_unlock(&pfi_unlnkdkifs_mtx);
}

int
pfi_kkif_match(struct pfi_kkif *rule_kif, struct pfi_kkif *packet_kif)
{
        struct ifg_list *p;

        NET_EPOCH_ASSERT();

        MPASS(packet_kif != NULL);
        MPASS(packet_kif->pfik_ifp != NULL);

        if (rule_kif == NULL || rule_kif == packet_kif)
                return (1);

        if (rule_kif->pfik_group != NULL) {
                CK_STAILQ_FOREACH(p, &packet_kif->pfik_ifp->if_groups, ifgl_next)
                        if (p->ifgl_group == rule_kif->pfik_group)
                                return (1);
        }

        if (rule_kif->pfik_flags & PFI_IFLAG_ANY && packet_kif->pfik_ifp &&
            !(packet_kif->pfik_ifp->if_flags & IFF_LOOPBACK))
                        return (1);

        return (0);
}

static void
pfi_attach_ifnet(struct ifnet *ifp, struct pfi_kkif *kif)
{

        PF_RULES_WASSERT();

        V_pfi_update++;
        kif = pfi_kkif_attach(kif, ifp->if_xname);
        if_ref(ifp);
        kif->pfik_ifp = ifp;
        ifp->if_pf_kif = kif;
        pfi_kkif_update(kif);
}

static void
pfi_attach_ifgroup(struct ifg_group *ifg, struct pfi_kkif *kif)
{

        PF_RULES_WASSERT();

        V_pfi_update++;
        kif = pfi_kkif_attach(kif, ifg->ifg_group);
        kif->pfik_group = ifg;
        ifg->ifg_pf_kif = kif;
}

int
pfi_match_addr(struct pfi_dynaddr *dyn, struct pf_addr *a, sa_family_t af)
{
        switch (af) {
#ifdef INET
        case AF_INET:
                switch (dyn->pfid_acnt4) {
                case 0:
                        return (0);
                case 1:
                        return (pf_match_addr(0, &dyn->pfid_addr4,
                            &dyn->pfid_mask4, a, AF_INET));
                default:
                        return (pfr_match_addr(dyn->pfid_kt, a, AF_INET));
                }
                break;
#endif /* INET */
#ifdef INET6
        case AF_INET6:
                switch (dyn->pfid_acnt6) {
                case 0:
                        return (0);
                case 1:
                        return (pf_match_addr(0, &dyn->pfid_addr6,
                            &dyn->pfid_mask6, a, AF_INET6));
                default:
                        return (pfr_match_addr(dyn->pfid_kt, a, AF_INET6));
                }
                break;
#endif /* INET6 */
        default:
                return (0);
        }
}

int
pfi_dynaddr_setup(struct pf_addr_wrap *aw, sa_family_t af)
{
        struct epoch_tracker     et;
        struct pfi_dynaddr      *dyn;
        char                     tblname[PF_TABLE_NAME_SIZE];
        struct pf_kruleset      *ruleset = NULL;
        struct pfi_kkif         *kif;
        int                      rv = 0;

        PF_RULES_WASSERT();
        KASSERT(aw->type == PF_ADDR_DYNIFTL, ("%s: type %u",
            __func__, aw->type));
        KASSERT(aw->p.dyn == NULL, ("%s: dyn is %p", __func__, aw->p.dyn));

        if ((dyn = malloc(sizeof(*dyn), PFI_MTYPE, M_NOWAIT | M_ZERO)) == NULL)
                return (ENOMEM);

        if ((kif = pf_kkif_create(M_NOWAIT)) == NULL) {
                free(dyn, PFI_MTYPE);
                return (ENOMEM);
        }

        if (!strcmp(aw->v.ifname, "self"))
                dyn->pfid_kif = pfi_kkif_attach(kif, IFG_ALL);
        else
                dyn->pfid_kif = pfi_kkif_attach(kif, aw->v.ifname);
        kif = NULL;
        pfi_kkif_ref(dyn->pfid_kif);

        dyn->pfid_net = pfi_unmask(&aw->v.a.mask);
        if (af == AF_INET && dyn->pfid_net == 32)
                dyn->pfid_net = 128;
        strlcpy(tblname, aw->v.ifname, sizeof(tblname));
        if (aw->iflags & PFI_AFLAG_NETWORK)
                strlcat(tblname, ":network", sizeof(tblname));
        if (aw->iflags & PFI_AFLAG_BROADCAST)
                strlcat(tblname, ":broadcast", sizeof(tblname));
        if (aw->iflags & PFI_AFLAG_PEER)
                strlcat(tblname, ":peer", sizeof(tblname));
        if (aw->iflags & PFI_AFLAG_NOALIAS)
                strlcat(tblname, ":0", sizeof(tblname));
        if (dyn->pfid_net != 128)
                snprintf(tblname + strlen(tblname),
                    sizeof(tblname) - strlen(tblname), "/%d", dyn->pfid_net);
        if ((ruleset = pf_find_or_create_kruleset(PF_RESERVED_ANCHOR)) == NULL) {
                rv = ENOMEM;
                goto _bad;
        }

        if ((dyn->pfid_kt = pfr_attach_table(ruleset, tblname)) == NULL) {
                rv = ENOMEM;
                goto _bad;
        }

        dyn->pfid_kt->pfrkt_flags |= PFR_TFLAG_ACTIVE;
        dyn->pfid_iflags = aw->iflags;
        dyn->pfid_af = af;

        TAILQ_INSERT_TAIL(&dyn->pfid_kif->pfik_dynaddrs, dyn, entry);
        aw->p.dyn = dyn;
        NET_EPOCH_ENTER(et);
        pfi_kkif_update(dyn->pfid_kif);
        NET_EPOCH_EXIT(et);

        return (0);

_bad:
        if (dyn->pfid_kt != NULL)
                pfr_detach_table(dyn->pfid_kt);
        if (ruleset != NULL)
                pf_remove_if_empty_kruleset(ruleset);
        pfi_kkif_unref(dyn->pfid_kif);
        free(dyn, PFI_MTYPE);

        return (rv);
}

static void
pfi_kkif_update(struct pfi_kkif *kif)
{
        struct ifg_list         *ifgl;
        struct ifg_member       *ifgm;
        struct pfi_dynaddr      *p;
        struct pfi_kkif         *tmpkif;

        NET_EPOCH_ASSERT();
        PF_RULES_WASSERT();

        /* update all dynaddr */
        TAILQ_FOREACH(p, &kif->pfik_dynaddrs, entry)
                pfi_dynaddr_update(p);

        /* Apply group flags to new members. */
        if (kif->pfik_group != NULL) {
                CK_STAILQ_FOREACH(ifgm, &kif->pfik_group->ifg_members,
                    ifgm_next) {
                        tmpkif = (struct pfi_kkif *)ifgm->ifgm_ifp->if_pf_kif;
                        if (tmpkif == NULL)
                                continue;

                        tmpkif->pfik_flags |= kif->pfik_flags;
                }
        }

        /* again for all groups kif is member of */
        if (kif->pfik_ifp != NULL) {
                CK_STAILQ_FOREACH(ifgl, &kif->pfik_ifp->if_groups, ifgl_next)
                        if (ifgl->ifgl_group->ifg_pf_kif) {
                                pfi_kkif_update((struct pfi_kkif *)
                                    ifgl->ifgl_group->ifg_pf_kif);
                        }
        }
}

static void
pfi_dynaddr_update(struct pfi_dynaddr *dyn)
{
        struct pfi_kkif         *kif;
        struct pfr_ktable       *kt;

        PF_RULES_WASSERT();
        KASSERT(dyn && dyn->pfid_kif && dyn->pfid_kt,
            ("%s: bad argument", __func__));

        kif = dyn->pfid_kif;
        kt = dyn->pfid_kt;

        if (kt->pfrkt_larg != V_pfi_update) {
                /* this table needs to be brought up-to-date */
                pfi_table_update(kt, kif, dyn->pfid_net, dyn->pfid_iflags);
                kt->pfrkt_larg = V_pfi_update;
        }
        pfr_dynaddr_update(kt, dyn);
}

static void
pfi_table_update(struct pfr_ktable *kt, struct pfi_kkif *kif, uint8_t net,
    int flags)
{
        int                      e, size2 = 0;
        struct ifg_member       *ifgm;

        NET_EPOCH_ASSERT();

        V_pfi_buffer_cnt = 0;

        if (kif->pfik_ifp != NULL)
                pfi_instance_add(kif->pfik_ifp, net, flags);
        else if (kif->pfik_group != NULL) {
                CK_STAILQ_FOREACH(ifgm, &kif->pfik_group->ifg_members, ifgm_next)
                        pfi_instance_add(ifgm->ifgm_ifp, net, flags);
        }

        if ((e = pfr_set_addrs(&kt->pfrkt_t, V_pfi_buffer, V_pfi_buffer_cnt, &size2,
            NULL, NULL, NULL, PFR_FLAG_START | PFR_FLAG_DONE, PFR_TFLAG_ALLMASK)))
                printf("%s: cannot set %d new addresses into table %s: %d\n",
                    __func__, V_pfi_buffer_cnt, kt->pfrkt_name, e);
}

static void
pfi_instance_add(struct ifnet *ifp, uint8_t net, int flags)
{
        struct ifaddr   *ia;
        int              got4 = 0, got6 = 0;
        sa_family_t      af;
        uint8_t          net2;

        NET_EPOCH_ASSERT();

        CK_STAILQ_FOREACH(ia, &ifp->if_addrhead, ifa_link) {
                if (ia->ifa_addr == NULL)
                        continue;
                af = ia->ifa_addr->sa_family;
                if (af != AF_INET && af != AF_INET6)
                        continue;
                /*
                 * XXX: For point-to-point interfaces, (ifname:0) and IPv4,
                 *      jump over addresses without a proper route to work
                 *      around a problem with ppp not fully removing the
                 *      address used during IPCP.
                 */
                if ((ifp->if_flags & IFF_POINTOPOINT) &&
                    !(ia->ifa_flags & IFA_ROUTE) &&
                    (flags & PFI_AFLAG_NOALIAS) && (af == AF_INET))
                        continue;
                if ((flags & PFI_AFLAG_BROADCAST) && af == AF_INET6)
                        continue;
                if ((flags & PFI_AFLAG_BROADCAST) &&
                    !(ifp->if_flags & IFF_BROADCAST))
                        continue;
                if ((flags & PFI_AFLAG_PEER) &&
                    !(ifp->if_flags & IFF_POINTOPOINT))
                        continue;
                if ((flags & (PFI_AFLAG_NETWORK | PFI_AFLAG_NOALIAS)) &&
                    af == AF_INET6 &&
                    IN6_IS_ADDR_LINKLOCAL(
                    &((struct sockaddr_in6 *)ia->ifa_addr)->sin6_addr))
                        continue;
                if (flags & PFI_AFLAG_NOALIAS) {
                        if (af == AF_INET && got4)
                                continue;
                        if (af == AF_INET6 && got6)
                                continue;
                }
                if (af == AF_INET)
                        got4 = 1;
                else if (af == AF_INET6)
                        got6 = 1;
                net2 = net;
                if (net2 == 128 && (flags & PFI_AFLAG_NETWORK)) {
                        if (af == AF_INET)
                                net2 = pfi_unmask(&((struct sockaddr_in *)
                                    ia->ifa_netmask)->sin_addr);
                        else if (af == AF_INET6)
                                net2 = pfi_unmask(&((struct sockaddr_in6 *)
                                    ia->ifa_netmask)->sin6_addr);
                }
                if (af == AF_INET && net2 > 32)
                        net2 = 32;
                if (flags & PFI_AFLAG_BROADCAST)
                        pfi_address_add(ia->ifa_broadaddr, af, net2);
                else if (flags & PFI_AFLAG_PEER)
                        pfi_address_add(ia->ifa_dstaddr, af, net2);
                else
                        pfi_address_add(ia->ifa_addr, af, net2);
        }
}

static void
pfi_address_add(struct sockaddr *sa, sa_family_t af, uint8_t net)
{
        struct pfr_addr *p;
        int              i;

        if (V_pfi_buffer_cnt >= V_pfi_buffer_max) {
                int              new_max = V_pfi_buffer_max * 2;

                if (new_max > PFI_BUFFER_MAX) {
                        printf("%s: address buffer full (%d/%d)\n", __func__,
                            V_pfi_buffer_cnt, PFI_BUFFER_MAX);
                        return;
                }
                p = malloc(new_max * sizeof(*V_pfi_buffer), PFI_MTYPE,
                    M_NOWAIT);
                if (p == NULL) {
                        printf("%s: no memory to grow buffer (%d/%d)\n",
                            __func__, V_pfi_buffer_cnt, PFI_BUFFER_MAX);
                        return;
                }
                memcpy(p, V_pfi_buffer, V_pfi_buffer_max * sizeof(*V_pfi_buffer));
                /* no need to zero buffer */
                free(V_pfi_buffer, PFI_MTYPE);
                V_pfi_buffer = p;
                V_pfi_buffer_max = new_max;
        }
        if (af == AF_INET && net > 32)
                net = 128;
        p = V_pfi_buffer + V_pfi_buffer_cnt++;
        memset(p, 0, sizeof(*p));
        p->pfra_af = af;
        p->pfra_net = net;
        if (af == AF_INET)
                p->pfra_ip4addr = ((struct sockaddr_in *)sa)->sin_addr;
        else if (af == AF_INET6) {
                p->pfra_ip6addr = ((struct sockaddr_in6 *)sa)->sin6_addr;
                if (IN6_IS_SCOPE_EMBED(&p->pfra_ip6addr))
                        p->pfra_ip6addr.s6_addr16[1] = 0;
        }
        /* mask network address bits */
        if (net < 128)
                ((caddr_t)p)[p->pfra_net/8] &= ~(0xFF >> (p->pfra_net%8));
        for (i = (p->pfra_net+7)/8; i < sizeof(p->pfra_u); i++)
                ((caddr_t)p)[i] = 0;
}

void
pfi_dynaddr_remove(struct pfi_dynaddr *dyn)
{

        KASSERT(dyn->pfid_kif != NULL, ("%s: null pfid_kif", __func__));
        KASSERT(dyn->pfid_kt != NULL, ("%s: null pfid_kt", __func__));

        TAILQ_REMOVE(&dyn->pfid_kif->pfik_dynaddrs, dyn, entry);
        pfi_kkif_unref(dyn->pfid_kif);
        pfr_detach_table(dyn->pfid_kt);
        free(dyn, PFI_MTYPE);
}

void
pfi_dynaddr_copyout(struct pf_addr_wrap *aw)
{

        KASSERT(aw->type == PF_ADDR_DYNIFTL,
            ("%s: type %u", __func__, aw->type));

        if (aw->p.dyn == NULL || aw->p.dyn->pfid_kif == NULL)
                return;
        aw->p.dyncnt = aw->p.dyn->pfid_acnt4 + aw->p.dyn->pfid_acnt6;
}

static int
pfi_kkif_compare(struct pfi_kkif *p, struct pfi_kkif *q)
{
        return (strncmp(p->pfik_name, q->pfik_name, IFNAMSIZ));
}

void
pfi_update_status(const char *name, struct pf_status *pfs)
{
        struct pfi_kkif         *p;
        struct pfi_kif_cmp       key;
        struct ifg_member        p_member, *ifgm;
        CK_STAILQ_HEAD(, ifg_member) ifg_members;
        int                      i, j, k;

        if (pfs) {
                memset(pfs->pcounters, 0, sizeof(pfs->pcounters));
                memset(pfs->bcounters, 0, sizeof(pfs->bcounters));
        }

        strlcpy(key.pfik_name, name, sizeof(key.pfik_name));
        p = RB_FIND(pfi_ifhead, &V_pfi_ifs, (struct pfi_kkif *)&key);
        if (p == NULL) {
                return;
        }

        if (p->pfik_group != NULL) {
                memcpy(&ifg_members, &p->pfik_group->ifg_members,
                    sizeof(ifg_members));
        } else {
                /* build a temporary list for p only */
                memset(&p_member, 0, sizeof(p_member));
                p_member.ifgm_ifp = p->pfik_ifp;
                CK_STAILQ_INIT(&ifg_members);
                CK_STAILQ_INSERT_TAIL(&ifg_members, &p_member, ifgm_next);
        }
        CK_STAILQ_FOREACH(ifgm, &ifg_members, ifgm_next) {
                if (ifgm->ifgm_ifp == NULL || ifgm->ifgm_ifp->if_pf_kif == NULL)
                        continue;
                p = (struct pfi_kkif *)ifgm->ifgm_ifp->if_pf_kif;

                /* just clear statistics */
                if (pfs == NULL) {
                        pf_kkif_zero(p);
                        continue;
                }
                for (i = 0; i < 2; i++)
                        for (j = 0; j < 2; j++)
                                for (k = 0; k < 2; k++) {
                                        pfs->pcounters[i][j][k] +=
                                            pf_counter_u64_fetch(&p->pfik_packets[i][j][k]);
                                        pfs->bcounters[i][j] +=
                                            pf_counter_u64_fetch(&p->pfik_bytes[i][j][k]);
                                }
        }
}

static void
pf_kkif_to_kif(struct pfi_kkif *kkif, struct pfi_kif *kif)
{

        memset(kif, 0, sizeof(*kif));
        strlcpy(kif->pfik_name, kkif->pfik_name, sizeof(kif->pfik_name));
        for (int i = 0; i < 2; i++) {
                for (int j = 0; j < 2; j++) {
                        for (int k = 0; k < 2; k++) {
                                kif->pfik_packets[i][j][k] =
                                    pf_counter_u64_fetch(&kkif->pfik_packets[i][j][k]);
                                kif->pfik_bytes[i][j][k] =
                                    pf_counter_u64_fetch(&kkif->pfik_bytes[i][j][k]);
                        }
                }
        }
        kif->pfik_flags = kkif->pfik_flags;
        kif->pfik_tzero = kkif->pfik_tzero;
        kif->pfik_rulerefs = kkif->pfik_rulerefs;
        /*
         * Userspace relies on this pointer to decide if this is a group or
         * not. We don't want to share the actual pointer, because it's
         * useless to userspace and leaks kernel memory layout information.
         * So instead we provide 0xfeedcode as 'true' and NULL as 'false'.
         */
        kif->pfik_group =
            kkif->pfik_group ? (struct ifg_group *)0xfeedc0de : NULL;
}

void
pfi_get_ifaces(const char *name, struct pfi_kif *buf, int *size)
{
        struct epoch_tracker et;
        struct pfi_kkif *p, *nextp;
        int              n = 0;

        NET_EPOCH_ENTER(et);
        for (p = RB_MIN(pfi_ifhead, &V_pfi_ifs); p; p = nextp) {
                nextp = RB_NEXT(pfi_ifhead, &V_pfi_ifs, p);
                if (pfi_skip_if(name, p))
                        continue;
                if (*size <= n++)
                        break;
                if (!p->pfik_tzero)
                        p->pfik_tzero = time_second;
                pf_kkif_to_kif(p, buf++);
                nextp = RB_NEXT(pfi_ifhead, &V_pfi_ifs, p);
        }
        *size = n;
        NET_EPOCH_EXIT(et);
}

static int
pfi_skip_if(const char *filter, struct pfi_kkif *p)
{
        struct ifg_list *i;
        int     n;

        NET_EPOCH_ASSERT();

        if (filter == NULL || !*filter)
                return (0);
        if (!strcmp(p->pfik_name, filter))
                return (0);     /* exact match */
        n = strlen(filter);
        if (n < 1 || n >= IFNAMSIZ)
                return (1);     /* sanity check */
        if (filter[n-1] >= '0' && filter[n-1] <= '9')
                return (1);     /* group names may not end in a digit */
        if (p->pfik_ifp == NULL)
                return (1);
        CK_STAILQ_FOREACH(i, &p->pfik_ifp->if_groups, ifgl_next)
                if (!strncmp(i->ifgl_group->ifg_group, filter, IFNAMSIZ))
                        return (0); /* iface is in group "filter" */
        return (1);
}

int
pfi_set_flags(const char *name, int flags)
{
        struct epoch_tracker et;
        struct pfi_kkif *p, *kif;

        kif = pf_kkif_create(M_NOWAIT);
        if (kif == NULL)
                return (ENOMEM);

        NET_EPOCH_ENTER(et);

        kif = pfi_kkif_attach(kif, name);

        RB_FOREACH(p, pfi_ifhead, &V_pfi_ifs) {
                if (pfi_skip_if(name, p))
                        continue;
                p->pfik_flags |= flags;
        }
        NET_EPOCH_EXIT(et);
        return (0);
}

int
pfi_clear_flags(const char *name, int flags)
{
        struct epoch_tracker et;
        struct pfi_kkif *p, *tmp;

        NET_EPOCH_ENTER(et);
        RB_FOREACH_SAFE(p, pfi_ifhead, &V_pfi_ifs, tmp) {
                if (pfi_skip_if(name, p))
                        continue;
                p->pfik_flags &= ~flags;

                if (p->pfik_ifp == NULL && p->pfik_group == NULL &&
                    p->pfik_flags == 0 && p->pfik_rulerefs == 0) {
                        /* Delete this kif. */
                        RB_REMOVE(pfi_ifhead, &V_pfi_ifs, p);
                        pf_kkif_free(p);
                }
        }
        NET_EPOCH_EXIT(et);
        return (0);
}

/* from pf_print_state.c */
static int
pfi_unmask(void *addr)
{
        struct pf_addr *m = addr;
        int i = 31, j = 0, b = 0;
        u_int32_t tmp;

        while (j < 4 && m->addr32[j] == 0xffffffff) {
                b += 32;
                j++;
        }
        if (j < 4) {
                tmp = ntohl(m->addr32[j]);
                for (i = 31; tmp & (1 << i); --i)
                        b++;
        }
        return (b);
}

static void
pfi_attach_ifnet_event(void *arg __unused, struct ifnet *ifp)
{
        struct epoch_tracker et;
        struct pfi_kkif *kif;

        if (V_pf_vnet_active == 0) {
                /* Avoid teardown race in the least expensive way. */
                return;
        }
        kif = pf_kkif_create(M_NOWAIT);
        NET_EPOCH_ENTER(et);
        PF_RULES_WLOCK();
        pfi_attach_ifnet(ifp, kif);
#ifdef ALTQ
        pf_altq_ifnet_event(ifp, 0);
#endif
        PF_RULES_WUNLOCK();
        NET_EPOCH_EXIT(et);
}

static void
pfi_rename_ifnet_event(void *arg, struct ifnet *ifp)
{
        /* XXXGL: should be handled better */
        pfi_detach_ifnet_event(arg, ifp);
        pfi_attach_ifnet_event(arg, ifp);
}

static void
pfi_detach_ifnet_event(void *arg __unused, struct ifnet *ifp)
{
        struct epoch_tracker et;
        struct pfi_kkif *kif = (struct pfi_kkif *)ifp->if_pf_kif;

        if (pfsync_detach_ifnet_ptr)
                pfsync_detach_ifnet_ptr(ifp);

        if (kif == NULL)
                return;

        if (V_pf_vnet_active == 0) {
                /* Avoid teardown race in the least expensive way. */
                return;
        }

        NET_EPOCH_ENTER(et);
        PF_RULES_WLOCK();
        V_pfi_update++;
        pfi_kkif_update(kif);

        if (kif->pfik_ifp)
                if_rele(kif->pfik_ifp);

        kif->pfik_ifp = NULL;
        ifp->if_pf_kif = NULL;
#ifdef ALTQ
        pf_altq_ifnet_event(ifp, 1);
#endif
        pfi_kkif_remove_if_unref(kif);

        PF_RULES_WUNLOCK();
        NET_EPOCH_EXIT(et);
}

static void
pfi_attach_group_event(void *arg __unused, struct ifg_group *ifg)
{
        struct epoch_tracker et;
        struct pfi_kkif *kif;

        if (V_pf_vnet_active == 0) {
                /* Avoid teardown race in the least expensive way. */
                return;
        }
        kif = pf_kkif_create(M_WAITOK);
        NET_EPOCH_ENTER(et);
        PF_RULES_WLOCK();
        pfi_attach_ifgroup(ifg, kif);
        PF_RULES_WUNLOCK();
        NET_EPOCH_EXIT(et);
}

static void
pfi_change_group_event(void *arg __unused, char *gname)
{
        struct epoch_tracker et;
        struct pfi_kkif *kif;

        if (V_pf_vnet_active == 0) {
                /* Avoid teardown race in the least expensive way. */
                return;
        }

        kif = pf_kkif_create(M_WAITOK);
        NET_EPOCH_ENTER(et);
        PF_RULES_WLOCK();
        V_pfi_update++;
        kif = pfi_kkif_attach(kif, gname);
        pfi_kkif_update(kif);
        PF_RULES_WUNLOCK();
        NET_EPOCH_EXIT(et);
}

static void
pfi_detach_group_event(void *arg __unused, struct ifg_group *ifg)
{
        struct pfi_kkif *kif = (struct pfi_kkif *)ifg->ifg_pf_kif;

        if (kif == NULL)
                return;

        if (V_pf_vnet_active == 0) {
                /* Avoid teardown race in the least expensive way. */
                return;
        }
        PF_RULES_WLOCK();
        V_pfi_update++;

        kif->pfik_group = NULL;
        ifg->ifg_pf_kif = NULL;

        pfi_kkif_remove_if_unref(kif);
        PF_RULES_WUNLOCK();
}

static void
pfi_ifaddr_event(void *arg __unused, struct ifnet *ifp)
{

        KASSERT(ifp, ("ifp == NULL"));

        if (ifp->if_pf_kif == NULL)
                return;

        if (V_pf_vnet_active == 0) {
                /* Avoid teardown race in the least expensive way. */
                return;
        }
        PF_RULES_WLOCK();
        if (ifp->if_pf_kif) {
                struct epoch_tracker et;

                V_pfi_update++;
                NET_EPOCH_ENTER(et);
                pfi_kkif_update(ifp->if_pf_kif);
                NET_EPOCH_EXIT(et);
        }
        PF_RULES_WUNLOCK();
}