include/linux/netfilter/ipset/ip

/* [<][>][^][v][top][bottom][index][help] */
This source file includes following definitions.
ip_set_ext_destroy
ip_set_put_flags
ip_set_add_bytes
ip_set_add_packets
ip_set_get_bytes
ip_set_get_packets
ip_set_update_counter
ip_set_get_skbinfo
ip_set_put_skbinfo
ip_set_init_skbinfo
ip_set_put_counter
ip_set_init_counter
ip_set_get_hostipaddr4
ip_set_eexist
ip_set_enomatch
ip_set_attr_netorder
ip_set_optattr_netorder
ip_set_get_h32
ip_set_get_h16
nla_put_ipaddr4
nla_put_ipaddr6
ip4addr
ip4addrptr
ip6addrptr
bitmap_bytes
ip_set_put_extensions
/* Copyright (C) 2000-2002 Joakim Axelsson <gozem@linux.nu>
 *                         Patrick Schaaf <bof@bof.de>
 *                         Martin Josefsson <gandalf@wlug.westbo.se>
 * Copyright (C) 2003-2013 Jozsef Kadlecsik <kadlec@blackhole.kfki.hu>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation.
 */
#ifndef _IP_SET_H
#define _IP_SET_H

#include <linux/ip.h>
#include <linux/ipv6.h>
#include <linux/netlink.h>
#include <linux/netfilter.h>
#include <linux/netfilter/x_tables.h>
#include <linux/stringify.h>
#include <linux/vmalloc.h>
#include <net/netlink.h>
#include <uapi/linux/netfilter/ipset/ip_set.h>

#define _IP_SET_MODULE_DESC(a, b, c)            \
        MODULE_DESCRIPTION(a " type of IP sets, revisions " b "-" c)
#define IP_SET_MODULE_DESC(a, b, c)             \
        _IP_SET_MODULE_DESC(a, __stringify(b), __stringify(c))

/* Set features */
enum ip_set_feature {
        IPSET_TYPE_IP_FLAG = 0,
        IPSET_TYPE_IP = (1 << IPSET_TYPE_IP_FLAG),
        IPSET_TYPE_PORT_FLAG = 1,
        IPSET_TYPE_PORT = (1 << IPSET_TYPE_PORT_FLAG),
        IPSET_TYPE_MAC_FLAG = 2,
        IPSET_TYPE_MAC = (1 << IPSET_TYPE_MAC_FLAG),
        IPSET_TYPE_IP2_FLAG = 3,
        IPSET_TYPE_IP2 = (1 << IPSET_TYPE_IP2_FLAG),
        IPSET_TYPE_NAME_FLAG = 4,
        IPSET_TYPE_NAME = (1 << IPSET_TYPE_NAME_FLAG),
        IPSET_TYPE_IFACE_FLAG = 5,
        IPSET_TYPE_IFACE = (1 << IPSET_TYPE_IFACE_FLAG),
        IPSET_TYPE_MARK_FLAG = 6,
        IPSET_TYPE_MARK = (1 << IPSET_TYPE_MARK_FLAG),
        IPSET_TYPE_NOMATCH_FLAG = 7,
        IPSET_TYPE_NOMATCH = (1 << IPSET_TYPE_NOMATCH_FLAG),
        /* Strictly speaking not a feature, but a flag for dumping:
         * this settype must be dumped last */
        IPSET_DUMP_LAST_FLAG = 8,
        IPSET_DUMP_LAST = (1 << IPSET_DUMP_LAST_FLAG),
};

/* Set extensions */
enum ip_set_extension {
        IPSET_EXT_BIT_TIMEOUT = 0,
        IPSET_EXT_TIMEOUT = (1 << IPSET_EXT_BIT_TIMEOUT),
        IPSET_EXT_BIT_COUNTER = 1,
        IPSET_EXT_COUNTER = (1 << IPSET_EXT_BIT_COUNTER),
        IPSET_EXT_BIT_COMMENT = 2,
        IPSET_EXT_COMMENT = (1 << IPSET_EXT_BIT_COMMENT),
        IPSET_EXT_BIT_SKBINFO = 3,
        IPSET_EXT_SKBINFO = (1 << IPSET_EXT_BIT_SKBINFO),
        /* Mark set with an extension which needs to call destroy */
        IPSET_EXT_BIT_DESTROY = 7,
        IPSET_EXT_DESTROY = (1 << IPSET_EXT_BIT_DESTROY),
};

#define SET_WITH_TIMEOUT(s)     ((s)->extensions & IPSET_EXT_TIMEOUT)
#define SET_WITH_COUNTER(s)     ((s)->extensions & IPSET_EXT_COUNTER)
#define SET_WITH_COMMENT(s)     ((s)->extensions & IPSET_EXT_COMMENT)
#define SET_WITH_SKBINFO(s)     ((s)->extensions & IPSET_EXT_SKBINFO)
#define SET_WITH_FORCEADD(s)    ((s)->flags & IPSET_CREATE_FLAG_FORCEADD)

/* Extension id, in size order */
enum ip_set_ext_id {
        IPSET_EXT_ID_COUNTER = 0,
        IPSET_EXT_ID_TIMEOUT,
        IPSET_EXT_ID_SKBINFO,
        IPSET_EXT_ID_COMMENT,
        IPSET_EXT_ID_MAX,
};

/* Extension type */
struct ip_set_ext_type {
        /* Destroy extension private data (can be NULL) */
        void (*destroy)(void *ext);
        enum ip_set_extension type;
        enum ipset_cadt_flags flag;
        /* Size and minimal alignment */
        u8 len;
        u8 align;
};

extern const struct ip_set_ext_type ip_set_extensions[];

struct ip_set_ext {
        u64 packets;
        u64 bytes;
        u32 timeout;
        u32 skbmark;
        u32 skbmarkmask;
        u32 skbprio;
        u16 skbqueue;
        char *comment;
};

struct ip_set_counter {
        atomic64_t bytes;
        atomic64_t packets;
};

struct ip_set_comment {
        char *str;
};

struct ip_set_skbinfo {
        u32 skbmark;
        u32 skbmarkmask;
        u32 skbprio;
        u16 skbqueue;
};

struct ip_set;

#define ext_timeout(e, s)       \
(unsigned long *)(((void *)(e)) + (s)->offset[IPSET_EXT_ID_TIMEOUT])
#define ext_counter(e, s)       \
(struct ip_set_counter *)(((void *)(e)) + (s)->offset[IPSET_EXT_ID_COUNTER])
#define ext_comment(e, s)       \
(struct ip_set_comment *)(((void *)(e)) + (s)->offset[IPSET_EXT_ID_COMMENT])
#define ext_skbinfo(e, s)       \
(struct ip_set_skbinfo *)(((void *)(e)) + (s)->offset[IPSET_EXT_ID_SKBINFO])

typedef int (*ipset_adtfn)(struct ip_set *set, void *value,
                           const struct ip_set_ext *ext,
                           struct ip_set_ext *mext, u32 cmdflags);

/* Kernel API function options */
struct ip_set_adt_opt {
        u8 family;              /* Actual protocol family */
        u8 dim;                 /* Dimension of match/target */
        u8 flags;               /* Direction and negation flags */
        u32 cmdflags;           /* Command-like flags */
        struct ip_set_ext ext;  /* Extensions */
};

/* Set type, variant-specific part */
struct ip_set_type_variant {
        /* Kernelspace: test/add/del entries
         *              returns negative error code,
         *                      zero for no match/success to add/delete
         *                      positive for matching element */
        int (*kadt)(struct ip_set *set, const struct sk_buff *skb,
                    const struct xt_action_param *par,
                    enum ipset_adt adt, struct ip_set_adt_opt *opt);

        /* Userspace: test/add/del entries
         *              returns negative error code,
         *                      zero for no match/success to add/delete
         *                      positive for matching element */
        int (*uadt)(struct ip_set *set, struct nlattr *tb[],
                    enum ipset_adt adt, u32 *lineno, u32 flags, bool retried);

        /* Low level add/del/test functions */
        ipset_adtfn adt[IPSET_ADT_MAX];

        /* When adding entries and set is full, try to resize the set */
        int (*resize)(struct ip_set *set, bool retried);
        /* Destroy the set */
        void (*destroy)(struct ip_set *set);
        /* Flush the elements */
        void (*flush)(struct ip_set *set);
        /* Expire entries before listing */
        void (*expire)(struct ip_set *set);
        /* List set header data */
        int (*head)(struct ip_set *set, struct sk_buff *skb);
        /* List elements */
        int (*list)(const struct ip_set *set, struct sk_buff *skb,
                    struct netlink_callback *cb);

        /* Return true if "b" set is the same as "a"
         * according to the create set parameters */
        bool (*same_set)(const struct ip_set *a, const struct ip_set *b);
};

/* The core set type structure */
struct ip_set_type {
        struct list_head list;

        /* Typename */
        char name[IPSET_MAXNAMELEN];
        /* Protocol version */
        u8 protocol;
        /* Set type dimension */
        u8 dimension;
        /*
         * Supported family: may be NFPROTO_UNSPEC for both
         * NFPROTO_IPV4/NFPROTO_IPV6.
         */
        u8 family;
        /* Type revisions */
        u8 revision_min, revision_max;
        /* Set features to control swapping */
        u16 features;

        /* Create set */
        int (*create)(struct net *net, struct ip_set *set,
                      struct nlattr *tb[], u32 flags);

        /* Attribute policies */
        const struct nla_policy create_policy[IPSET_ATTR_CREATE_MAX + 1];
        const struct nla_policy adt_policy[IPSET_ATTR_ADT_MAX + 1];

        /* Set this to THIS_MODULE if you are a module, otherwise NULL */
        struct module *me;
};

/* register and unregister set type */
extern int ip_set_type_register(struct ip_set_type *set_type);
extern void ip_set_type_unregister(struct ip_set_type *set_type);

/* A generic IP set */
struct ip_set {
        /* The name of the set */
        char name[IPSET_MAXNAMELEN];
        /* Lock protecting the set data */
        rwlock_t lock;
        /* References to the set */
        u32 ref;
        /* The core set type */
        struct ip_set_type *type;
        /* The type variant doing the real job */
        const struct ip_set_type_variant *variant;
        /* The actual INET family of the set */
        u8 family;
        /* The type revision */
        u8 revision;
        /* Extensions */
        u8 extensions;
        /* Create flags */
        u8 flags;
        /* Default timeout value, if enabled */
        u32 timeout;
        /* Element data size */
        size_t dsize;
        /* Offsets to extensions in elements */
        size_t offset[IPSET_EXT_ID_MAX];
        /* The type specific data */
        void *data;
};

static inline void
ip_set_ext_destroy(struct ip_set *set, void *data)
{
        /* Check that the extension is enabled for the set and
         * call it's destroy function for its extension part in data.
         */
        if (SET_WITH_COMMENT(set))
                ip_set_extensions[IPSET_EXT_ID_COMMENT].destroy(
                        ext_comment(data, set));
}

static inline int
ip_set_put_flags(struct sk_buff *skb, struct ip_set *set)
{
        u32 cadt_flags = 0;

        if (SET_WITH_TIMEOUT(set))
                if (unlikely(nla_put_net32(skb, IPSET_ATTR_TIMEOUT,
                                           htonl(set->timeout))))
                        return -EMSGSIZE;
        if (SET_WITH_COUNTER(set))
                cadt_flags |= IPSET_FLAG_WITH_COUNTERS;
        if (SET_WITH_COMMENT(set))
                cadt_flags |= IPSET_FLAG_WITH_COMMENT;
        if (SET_WITH_SKBINFO(set))
                cadt_flags |= IPSET_FLAG_WITH_SKBINFO;
        if (SET_WITH_FORCEADD(set))
                cadt_flags |= IPSET_FLAG_WITH_FORCEADD;

        if (!cadt_flags)
                return 0;
        return nla_put_net32(skb, IPSET_ATTR_CADT_FLAGS, htonl(cadt_flags));
}

static inline void
ip_set_add_bytes(u64 bytes, struct ip_set_counter *counter)
{
        atomic64_add((long long)bytes, &(counter)->bytes);
}

static inline void
ip_set_add_packets(u64 packets, struct ip_set_counter *counter)
{
        atomic64_add((long long)packets, &(counter)->packets);
}

static inline u64
ip_set_get_bytes(const struct ip_set_counter *counter)
{
        return (u64)atomic64_read(&(counter)->bytes);
}

static inline u64
ip_set_get_packets(const struct ip_set_counter *counter)
{
        return (u64)atomic64_read(&(counter)->packets);
}

static inline void
ip_set_update_counter(struct ip_set_counter *counter,
                      const struct ip_set_ext *ext,
                      struct ip_set_ext *mext, u32 flags)
{
        if (ext->packets != ULLONG_MAX &&
            !(flags & IPSET_FLAG_SKIP_COUNTER_UPDATE)) {
                ip_set_add_bytes(ext->bytes, counter);
                ip_set_add_packets(ext->packets, counter);
        }
        if (flags & IPSET_FLAG_MATCH_COUNTERS) {
                mext->packets = ip_set_get_packets(counter);
                mext->bytes = ip_set_get_bytes(counter);
        }
}

static inline void
ip_set_get_skbinfo(struct ip_set_skbinfo *skbinfo,
                      const struct ip_set_ext *ext,
                      struct ip_set_ext *mext, u32 flags)
{
                mext->skbmark = skbinfo->skbmark;
                mext->skbmarkmask = skbinfo->skbmarkmask;
                mext->skbprio = skbinfo->skbprio;
                mext->skbqueue = skbinfo->skbqueue;
}
static inline bool
ip_set_put_skbinfo(struct sk_buff *skb, struct ip_set_skbinfo *skbinfo)
{
        /* Send nonzero parameters only */
        return ((skbinfo->skbmark || skbinfo->skbmarkmask) &&
                nla_put_net64(skb, IPSET_ATTR_SKBMARK,
                              cpu_to_be64((u64)skbinfo->skbmark << 32 |
                                          skbinfo->skbmarkmask))) ||
               (skbinfo->skbprio &&
                nla_put_net32(skb, IPSET_ATTR_SKBPRIO,
                              cpu_to_be32(skbinfo->skbprio))) ||
               (skbinfo->skbqueue &&
                nla_put_net16(skb, IPSET_ATTR_SKBQUEUE,
                             cpu_to_be16(skbinfo->skbqueue)));

}

static inline void
ip_set_init_skbinfo(struct ip_set_skbinfo *skbinfo,
                    const struct ip_set_ext *ext)
{
        skbinfo->skbmark = ext->skbmark;
        skbinfo->skbmarkmask = ext->skbmarkmask;
        skbinfo->skbprio = ext->skbprio;
        skbinfo->skbqueue = ext->skbqueue;
}

static inline bool
ip_set_put_counter(struct sk_buff *skb, struct ip_set_counter *counter)
{
        return nla_put_net64(skb, IPSET_ATTR_BYTES,
                             cpu_to_be64(ip_set_get_bytes(counter))) ||
               nla_put_net64(skb, IPSET_ATTR_PACKETS,
                             cpu_to_be64(ip_set_get_packets(counter)));
}

static inline void
ip_set_init_counter(struct ip_set_counter *counter,
                    const struct ip_set_ext *ext)
{
        if (ext->bytes != ULLONG_MAX)
                atomic64_set(&(counter)->bytes, (long long)(ext->bytes));
        if (ext->packets != ULLONG_MAX)
                atomic64_set(&(counter)->packets, (long long)(ext->packets));
}

/* Netlink CB args */
enum {
        IPSET_CB_NET = 0,
        IPSET_CB_DUMP,
        IPSET_CB_INDEX,
        IPSET_CB_ARG0,
        IPSET_CB_ARG1,
        IPSET_CB_ARG2,
};

/* register and unregister set references */
extern ip_set_id_t ip_set_get_byname(struct net *net,
                                     const char *name, struct ip_set **set);
extern void ip_set_put_byindex(struct net *net, ip_set_id_t index);
extern const char *ip_set_name_byindex(struct net *net, ip_set_id_t index);
extern ip_set_id_t ip_set_nfnl_get_byindex(struct net *net, ip_set_id_t index);
extern void ip_set_nfnl_put(struct net *net, ip_set_id_t index);

/* API for iptables set match, and SET target */

extern int ip_set_add(ip_set_id_t id, const struct sk_buff *skb,
                      const struct xt_action_param *par,
                      struct ip_set_adt_opt *opt);
extern int ip_set_del(ip_set_id_t id, const struct sk_buff *skb,
                      const struct xt_action_param *par,
                      struct ip_set_adt_opt *opt);
extern int ip_set_test(ip_set_id_t id, const struct sk_buff *skb,
                       const struct xt_action_param *par,
                       struct ip_set_adt_opt *opt);

/* Utility functions */
extern void *ip_set_alloc(size_t size);
extern void ip_set_free(void *members);
extern int ip_set_get_ipaddr4(struct nlattr *nla,  __be32 *ipaddr);
extern int ip_set_get_ipaddr6(struct nlattr *nla, union nf_inet_addr *ipaddr);
extern size_t ip_set_elem_len(struct ip_set *set, struct nlattr *tb[],
                              size_t len);
extern int ip_set_get_extensions(struct ip_set *set, struct nlattr *tb[],
                                 struct ip_set_ext *ext);

static inline int
ip_set_get_hostipaddr4(struct nlattr *nla, u32 *ipaddr)
{
        __be32 ip;
        int ret = ip_set_get_ipaddr4(nla, &ip);

        if (ret)
                return ret;
        *ipaddr = ntohl(ip);
        return 0;
}

/* Ignore IPSET_ERR_EXIST errors if asked to do so? */
static inline bool
ip_set_eexist(int ret, u32 flags)
{
        return ret == -IPSET_ERR_EXIST && (flags & IPSET_FLAG_EXIST);
}

/* Match elements marked with nomatch */
static inline bool
ip_set_enomatch(int ret, u32 flags, enum ipset_adt adt, struct ip_set *set)
{
        return adt == IPSET_TEST &&
               (set->type->features & IPSET_TYPE_NOMATCH) &&
               ((flags >> 16) & IPSET_FLAG_NOMATCH) &&
               (ret > 0 || ret == -ENOTEMPTY);
}

/* Check the NLA_F_NET_BYTEORDER flag */
static inline bool
ip_set_attr_netorder(struct nlattr *tb[], int type)
{
        return tb[type] && (tb[type]->nla_type & NLA_F_NET_BYTEORDER);
}

static inline bool
ip_set_optattr_netorder(struct nlattr *tb[], int type)
{
        return !tb[type] || (tb[type]->nla_type & NLA_F_NET_BYTEORDER);
}

/* Useful converters */
static inline u32
ip_set_get_h32(const struct nlattr *attr)
{
        return ntohl(nla_get_be32(attr));
}

static inline u16
ip_set_get_h16(const struct nlattr *attr)
{
        return ntohs(nla_get_be16(attr));
}

#define ipset_nest_start(skb, attr) nla_nest_start(skb, attr | NLA_F_NESTED)
#define ipset_nest_end(skb, start)  nla_nest_end(skb, start)

static inline int nla_put_ipaddr4(struct sk_buff *skb, int type, __be32 ipaddr)
{
        struct nlattr *__nested = ipset_nest_start(skb, type);
        int ret;

        if (!__nested)
                return -EMSGSIZE;
        ret = nla_put_net32(skb, IPSET_ATTR_IPADDR_IPV4, ipaddr);
        if (!ret)
                ipset_nest_end(skb, __nested);
        return ret;
}

static inline int nla_put_ipaddr6(struct sk_buff *skb, int type,
                                  const struct in6_addr *ipaddrptr)
{
        struct nlattr *__nested = ipset_nest_start(skb, type);
        int ret;

        if (!__nested)
                return -EMSGSIZE;
        ret = nla_put(skb, IPSET_ATTR_IPADDR_IPV6,
                      sizeof(struct in6_addr), ipaddrptr);
        if (!ret)
                ipset_nest_end(skb, __nested);
        return ret;
}

/* Get address from skbuff */
static inline __be32
ip4addr(const struct sk_buff *skb, bool src)
{
        return src ? ip_hdr(skb)->saddr : ip_hdr(skb)->daddr;
}

static inline void
ip4addrptr(const struct sk_buff *skb, bool src, __be32 *addr)
{
        *addr = src ? ip_hdr(skb)->saddr : ip_hdr(skb)->daddr;
}

static inline void
ip6addrptr(const struct sk_buff *skb, bool src, struct in6_addr *addr)
{
        memcpy(addr, src ? &ipv6_hdr(skb)->saddr : &ipv6_hdr(skb)->daddr,
               sizeof(*addr));
}

/* Calculate the bytes required to store the inclusive range of a-b */
static inline int
bitmap_bytes(u32 a, u32 b)
{
        return 4 * ((((b - a + 8) / 8) + 3) / 4);
}

#include <linux/netfilter/ipset/ip_set_timeout.h>
#include <linux/netfilter/ipset/ip_set_comment.h>

static inline int
ip_set_put_extensions(struct sk_buff *skb, const struct ip_set *set,
                      const void *e, bool active)
{
        if (SET_WITH_TIMEOUT(set)) {
                unsigned long *timeout = ext_timeout(e, set);

                if (nla_put_net32(skb, IPSET_ATTR_TIMEOUT,
                        htonl(active ? ip_set_timeout_get(timeout)
                                : *timeout)))
                        return -EMSGSIZE;
        }
        if (SET_WITH_COUNTER(set) &&
            ip_set_put_counter(skb, ext_counter(e, set)))
                return -EMSGSIZE;
        if (SET_WITH_COMMENT(set) &&
            ip_set_put_comment(skb, ext_comment(e, set)))
                return -EMSGSIZE;
        if (SET_WITH_SKBINFO(set) &&
            ip_set_put_skbinfo(skb, ext_skbinfo(e, set)))
                return -EMSGSIZE;
        return 0;
}

#define IP_SET_INIT_KEXT(skb, opt, set)                 \
        { .bytes = (skb)->len, .packets = 1,            \
          .timeout = ip_set_adt_opt_timeout(opt, set) }

#define IP_SET_INIT_UEXT(set)                           \
        { .bytes = ULLONG_MAX, .packets = ULLONG_MAX,   \
          .timeout = (set)->timeout }

#define IP_SET_INIT_CIDR(a, b) ((a) ? (a) : (b))

#define IPSET_CONCAT(a, b)              a##b
#define IPSET_TOKEN(a, b)               IPSET_CONCAT(a, b)

#endif /*_IP_SET_H */
/* [<][>][^][v][top][bottom][index][help] */
root/include/linux/netfilter/ipset/ip_set.h

INCLUDED FROM

DEFINITIONS
