[linux-block.git] / include / linux / netfilter / ipset / ip_set.h

/* SPDX-License-Identifier: GPL-2.0-only */
/* 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@netfilter.org>
 */
#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,
};

struct ip_set;

/* Extension type */
struct ip_set_ext_type {
	/* Destroy extension private data (can be NULL) */
	void (*destroy)(struct ip_set *set, 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_counter {
	atomic64_t bytes;
	atomic64_t packets;
};

struct ip_set_comment_rcu {
	struct rcu_head rcu;
	char str[];
};

struct ip_set_comment {
	struct ip_set_comment_rcu __rcu *c;
};

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

struct ip_set_ext {
	struct ip_set_skbinfo skbinfo;
	u64 packets;
	u64 bytes;
	char *comment;
	u32 timeout;
	u8 packets_op;
	u8 bytes_op;
	bool target;
};

#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);
	/* Keep listing private when resizing runs parallel */
	void (*uref)(struct ip_set *set, struct netlink_callback *cb,
		     bool start);

	/* 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);
	/* Cancel ongoing garbage collectors before destroying the set*/
	void (*cancel_gc)(struct ip_set *set);
	/* Region-locking is used */
	bool region_lock;
};

struct ip_set_region {
	spinlock_t lock;	/* Region lock */
	size_t ext_size;	/* Size of the dynamic extensions */
	u32 elements;		/* Number of elements vs timeout */
};

/* Max range where every element is added/deleted in one step */
#define IPSET_MAX_RANGE		(1<<14)

/* The max revision number supported by any set type + 1 */
#define IPSET_REVISION_MAX	9

/* 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;
	/* Revision-specific supported (create) flags */
	u8 create_flags[IPSET_REVISION_MAX+1];
	/* 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 {
	/* For call_cru in destroy */
	struct rcu_head rcu;
	/* The name of the set */
	char name[IPSET_MAXNAMELEN];
	/* Lock protecting the set data */
	spinlock_t lock;
	/* References to the set */
	u32 ref;
	/* References to the set for netlink events like dump,
	 * ref can be swapped out by ip_set_swap
	 */
	u32 ref_netlink;
	/* 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;
	/* Number of elements (vs timeout) */
	u32 elements;
	/* Size of the dynamic extensions (vs timeout) */
	size_t ext_size;
	/* 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)) {
		struct ip_set_comment *c = ext_comment(data, set);

		ip_set_extensions[IPSET_EXT_ID_COMMENT].destroy(set, c);
	}
}

int ip_set_put_flags(struct sk_buff *skb, struct ip_set *set);

/* Netlink CB args */
enum {
	IPSET_CB_NET = 0,	/* net namespace */
	IPSET_CB_PROTO,		/* ipset protocol */
	IPSET_CB_DUMP,		/* dump single set/all sets */
	IPSET_CB_INDEX,		/* set index */
	IPSET_CB_PRIVATE,	/* set private data */
	IPSET_CB_ARG0,		/* type specific */
};

/* 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 void ip_set_name_byindex(struct net *net, ip_set_id_t index, char *name);
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, size_t align);
extern int ip_set_get_extensions(struct ip_set *set, struct nlattr *tb[],
				 struct ip_set_ext *ext);
extern int ip_set_put_extensions(struct sk_buff *skb, const struct ip_set *set,
				 const void *e, bool active);
extern bool ip_set_match_extensions(struct ip_set *set,
				    const struct ip_set_ext *ext,
				    struct ip_set_ext *mext,
				    u32 flags, void *data);

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));
}

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

	if (!__nested)
		return -EMSGSIZE;
	ret = nla_put_in_addr(skb, IPSET_ATTR_IPADDR_IPV4, ipaddr);
	if (!ret)
		nla_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 = nla_nest_start(skb, type);
	int ret;

	if (!__nested)
		return -EMSGSIZE;
	ret = nla_put_in6_addr(skb, IPSET_ATTR_IPADDR_IPV6, ipaddrptr);
	if (!ret)
		nla_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));
}

/* How often should the gc be run by default */
#define IPSET_GC_TIME			(3 * 60)

/* Timeout period depending on the timeout value of the given set */
#define IPSET_GC_PERIOD(timeout) \
	((timeout/3) ? min_t(u32, (timeout)/3, IPSET_GC_TIME) : 1)

/* Entry is set with no timeout value */
#define IPSET_ELEM_PERMANENT	0

/* Set is defined with timeout support: timeout value may be 0 */
#define IPSET_NO_TIMEOUT	UINT_MAX

/* Max timeout value, see msecs_to_jiffies() in jiffies.h */
#define IPSET_MAX_TIMEOUT	(UINT_MAX >> 1)/MSEC_PER_SEC

#define ip_set_adt_opt_timeout(opt, set)	\
((opt)->ext.timeout != IPSET_NO_TIMEOUT ? (opt)->ext.timeout : (set)->timeout)

static inline unsigned int
ip_set_timeout_uget(struct nlattr *tb)
{
	unsigned int timeout = ip_set_get_h32(tb);

	/* Normalize to fit into jiffies */
	if (timeout > IPSET_MAX_TIMEOUT)
		timeout = IPSET_MAX_TIMEOUT;

	return timeout;
}

static inline bool
ip_set_timeout_expired(const unsigned long *t)
{
	return *t != IPSET_ELEM_PERMANENT && time_is_before_jiffies(*t);
}

static inline void
ip_set_timeout_set(unsigned long *timeout, u32 value)
{
	unsigned long t;

	if (!value) {
		*timeout = IPSET_ELEM_PERMANENT;
		return;
	}

	t = msecs_to_jiffies(value * MSEC_PER_SEC) + jiffies;
	if (t == IPSET_ELEM_PERMANENT)
		/* Bingo! :-) */
		t--;
	*timeout = t;
}

void ip_set_init_comment(struct ip_set *set, struct ip_set_comment *comment,
			 const struct ip_set_ext *ext);

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));
}

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

static inline void
nf_inet_addr_mask_inplace(union nf_inet_addr *a1,
			  const union nf_inet_addr *mask)
{
	a1->all[0] &= mask->all[0];
	a1->all[1] &= mask->all[1];
	a1->all[2] &= mask->all[2];
	a1->all[3] &= mask->all[3];
}

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

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

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

#endif /*_IP_SET_H */
Commit	Line	Data
d2912cb1	1	/* SPDX-License-Identifier: GPL-2.0-only */
a7b4f989 JK	2	/* Copyright (C) 2000-2002 Joakim Axelsson <gozem@linux.nu>
	3	* Patrick Schaaf <bof@bof.de>
	4	* Martin Josefsson <gandalf@wlug.westbo.se>
fe03d474	5	* Copyright (C) 2003-2013 Jozsef Kadlecsik <kadlec@netfilter.org>
a7b4f989	6	*/
a8201414 DH	7	#ifndef _IP_SET_H
a8201414 DH	8	#define _IP_SET_H
a7b4f989	9
ae8ded1c JE	10	#include <linux/ip.h>
	11	#include <linux/ipv6.h>
	12	#include <linux/netlink.h>
	13	#include <linux/netfilter.h>
	14	#include <linux/netfilter/x_tables.h>
10111a6e	15	#include <linux/stringify.h>
ae8ded1c JE	16	#include <linux/vmalloc.h>
ae8ded1c JE	17	#include <net/netlink.h>
a8201414	18	#include <uapi/linux/netfilter/ipset/ip_set.h>
ae8ded1c	19
10111a6e JK	20	#define _IP_SET_MODULE_DESC(a, b, c) \
	21	MODULE_DESCRIPTION(a " type of IP sets, revisions " b "-" c)
	22	#define IP_SET_MODULE_DESC(a, b, c) \
	23	_IP_SET_MODULE_DESC(a, __stringify(b), __stringify(c))
	24
a7b4f989 JK	25	/* Set features */
	26	enum ip_set_feature {
	27	IPSET_TYPE_IP_FLAG = 0,
	28	IPSET_TYPE_IP = (1 << IPSET_TYPE_IP_FLAG),
	29	IPSET_TYPE_PORT_FLAG = 1,
	30	IPSET_TYPE_PORT = (1 << IPSET_TYPE_PORT_FLAG),
	31	IPSET_TYPE_MAC_FLAG = 2,
	32	IPSET_TYPE_MAC = (1 << IPSET_TYPE_MAC_FLAG),
	33	IPSET_TYPE_IP2_FLAG = 3,
	34	IPSET_TYPE_IP2 = (1 << IPSET_TYPE_IP2_FLAG),
	35	IPSET_TYPE_NAME_FLAG = 4,
	36	IPSET_TYPE_NAME = (1 << IPSET_TYPE_NAME_FLAG),
e385357a JK	37	IPSET_TYPE_IFACE_FLAG = 5,
e385357a JK	38	IPSET_TYPE_IFACE = (1 << IPSET_TYPE_IFACE_FLAG),
3b02b56c VD	39	IPSET_TYPE_MARK_FLAG = 6,
	40	IPSET_TYPE_MARK = (1 << IPSET_TYPE_MARK_FLAG),
	41	IPSET_TYPE_NOMATCH_FLAG = 7,
3e0304a5	42	IPSET_TYPE_NOMATCH = (1 << IPSET_TYPE_NOMATCH_FLAG),
a7b4f989 JK	43	/* Strictly speaking not a feature, but a flag for dumping:
a7b4f989 JK	44	* this settype must be dumped last */
3b02b56c	45	IPSET_DUMP_LAST_FLAG = 8,
a7b4f989 JK	46	IPSET_DUMP_LAST = (1 << IPSET_DUMP_LAST_FLAG),
	47	};
	48
075e64c0 JK	49	/* Set extensions */
075e64c0 JK	50	enum ip_set_extension {
40cd63bf	51	IPSET_EXT_BIT_TIMEOUT = 0,
075e64c0	52	IPSET_EXT_TIMEOUT = (1 << IPSET_EXT_BIT_TIMEOUT),
40cd63bf	53	IPSET_EXT_BIT_COUNTER = 1,
34d666d4	54	IPSET_EXT_COUNTER = (1 << IPSET_EXT_BIT_COUNTER),
68b63f08 OS	55	IPSET_EXT_BIT_COMMENT = 2,
68b63f08 OS	56	IPSET_EXT_COMMENT = (1 << IPSET_EXT_BIT_COMMENT),
0e9871e3 AD	57	IPSET_EXT_BIT_SKBINFO = 3,
0e9871e3 AD	58	IPSET_EXT_SKBINFO = (1 << IPSET_EXT_BIT_SKBINFO),
40cd63bf JK	59	/* Mark set with an extension which needs to call destroy */
	60	IPSET_EXT_BIT_DESTROY = 7,
	61	IPSET_EXT_DESTROY = (1 << IPSET_EXT_BIT_DESTROY),
075e64c0 JK	62	};
075e64c0 JK	63
075e64c0	64	#define SET_WITH_TIMEOUT(s) ((s)->extensions & IPSET_EXT_TIMEOUT)
34d666d4	65	#define SET_WITH_COUNTER(s) ((s)->extensions & IPSET_EXT_COUNTER)
68b63f08	66	#define SET_WITH_COMMENT(s) ((s)->extensions & IPSET_EXT_COMMENT)
0e9871e3	67	#define SET_WITH_SKBINFO(s) ((s)->extensions & IPSET_EXT_SKBINFO)
07cf8f5a	68	#define SET_WITH_FORCEADD(s) ((s)->flags & IPSET_CREATE_FLAG_FORCEADD)
075e64c0	69
f925f705 JK	70	/* Extension id, in size order */
	71	enum ip_set_ext_id {
	72	IPSET_EXT_ID_COUNTER = 0,
	73	IPSET_EXT_ID_TIMEOUT,
0e9871e3	74	IPSET_EXT_ID_SKBINFO,
68b63f08	75	IPSET_EXT_ID_COMMENT,
f925f705 JK	76	IPSET_EXT_ID_MAX,
	77	};
	78
9e41f26a JK	79	struct ip_set;
9e41f26a JK	80
03c8b234 JK	81	/* Extension type */
03c8b234 JK	82	struct ip_set_ext_type {
40cd63bf	83	/* Destroy extension private data (can be NULL) */
9e41f26a	84	void (destroy)(struct ip_set set, void *ext);
03c8b234 JK	85	enum ip_set_extension type;
	86	enum ipset_cadt_flags flag;
	87	/* Size and minimal alignment */
	88	u8 len;
	89	u8 align;
	90	};
	91
	92	extern const struct ip_set_ext_type ip_set_extensions[];
	93
ca134ce8 JK	94	struct ip_set_counter {
	95	atomic64_t bytes;
	96	atomic64_t packets;
	97	};
	98
b57b2d1f JK	99	struct ip_set_comment_rcu {
b57b2d1f JK	100	struct rcu_head rcu;
6daf1414	101	char str[];
b57b2d1f JK	102	};
b57b2d1f JK	103
68b63f08	104	struct ip_set_comment {
b57b2d1f	105	struct ip_set_comment_rcu __rcu *c;
68b63f08	106	};
40cd63bf	107
0e9871e3 AD	108	struct ip_set_skbinfo {
	109	u32 skbmark;
	110	u32 skbmarkmask;
	111	u32 skbprio;
	112	u16 skbqueue;
bec810d9 JK	113	u16 __pad;
	114	};
	115
	116	struct ip_set_ext {
	117	struct ip_set_skbinfo skbinfo;
	118	u64 packets;
	119	u64 bytes;
	120	char *comment;
	121	u32 timeout;
4750005a JK	122	u8 packets_op;
4750005a JK	123	u8 bytes_op;
f66ee041	124	bool target;
0e9871e3 AD	125	};
0e9871e3 AD	126
ca134ce8	127	#define ext_timeout(e, s) \
275e2bc0	128	((unsigned long )(((void )(e)) + (s)->offset[IPSET_EXT_ID_TIMEOUT]))
ca134ce8	129	#define ext_counter(e, s) \
275e2bc0	130	((struct ip_set_counter )(((void )(e)) + (s)->offset[IPSET_EXT_ID_COUNTER]))
68b63f08	131	#define ext_comment(e, s) \
275e2bc0	132	((struct ip_set_comment )(((void )(e)) + (s)->offset[IPSET_EXT_ID_COMMENT]))
0e9871e3	133	#define ext_skbinfo(e, s) \
275e2bc0	134	((struct ip_set_skbinfo )(((void )(e)) + (s)->offset[IPSET_EXT_ID_SKBINFO]))
ca134ce8	135
5416219e	136	typedef int (ipset_adtfn)(struct ip_set set, void *value,
075e64c0	137	const struct ip_set_ext *ext,
6e01781d	138	struct ip_set_ext *mext, u32 cmdflags);
a7b4f989	139
ac8cc925 JK	140	/* Kernel API function options */
	141	struct ip_set_adt_opt {
	142	u8 family; /* Actual protocol family */
	143	u8 dim; /* Dimension of match/target */
	144	u8 flags; /* Direction and negation flags */
	145	u32 cmdflags; /* Command-like flags */
075e64c0	146	struct ip_set_ext ext; /* Extensions */
ac8cc925 JK	147	};
ac8cc925 JK	148
a7b4f989 JK	149	/* Set type, variant-specific part */
	150	struct ip_set_type_variant {
	151	/* Kernelspace: test/add/del entries
	152	* returns negative error code,
	153	* zero for no match/success to add/delete
	154	* positive for matching element */
3ace95c0	155	int (kadt)(struct ip_set set, const struct sk_buff *skb,
b66554cf	156	const struct xt_action_param *par,
075e64c0	157	enum ipset_adt adt, struct ip_set_adt_opt *opt);
a7b4f989 JK	158
	159	/* Userspace: test/add/del entries
	160	* returns negative error code,
	161	* zero for no match/success to add/delete
	162	* positive for matching element */
	163	int (uadt)(struct ip_set set, struct nlattr *tb[],
3d14b171	164	enum ipset_adt adt, u32 *lineno, u32 flags, bool retried);
a7b4f989 JK	165
	166	/* Low level add/del/test functions */
	167	ipset_adtfn adt[IPSET_ADT_MAX];
	168
	169	/* When adding entries and set is full, try to resize the set */
	170	int (resize)(struct ip_set set, bool retried);
	171	/* Destroy the set */
	172	void (destroy)(struct ip_set set);
	173	/* Flush the elements */
	174	void (flush)(struct ip_set set);
	175	/* Expire entries before listing */
	176	void (expire)(struct ip_set set);
	177	/* List set header data */
	178	int (head)(struct ip_set set, struct sk_buff *skb);
	179	/* List elements */
	180	int (list)(const struct ip_set set, struct sk_buff *skb,
	181	struct netlink_callback *cb);
c4c99783 JK	182	/* Keep listing private when resizing runs parallel */
	183	void (uref)(struct ip_set set, struct netlink_callback *cb,
	184	bool start);
a7b4f989 JK	185
	186	/* Return true if "b" set is the same as "a"
	187	* according to the create set parameters */
	188	bool (same_set)(const struct ip_set a, const struct ip_set *b);
97f7cf1c JK	189	/* Cancel ongoing garbage collectors before destroying the set*/
97f7cf1c JK	190	void (cancel_gc)(struct ip_set set);
f66ee041 JK	191	/* Region-locking is used */
	192	bool region_lock;
	193	};
	194
	195	struct ip_set_region {
	196	spinlock_t lock; /* Region lock */
	197	size_t ext_size; /* Size of the dynamic extensions */
	198	u32 elements; /* Number of elements vs timeout */
a7b4f989 JK	199	};
a7b4f989 JK	200
5f7b51bf	201	/* Max range where every element is added/deleted in one step */
5e29dc36	202	#define IPSET_MAX_RANGE (1<<14)
5f7b51bf	203
ccf0a4b7 JK	204	/* The max revision number supported by any set type + 1 */
	205	#define IPSET_REVISION_MAX 9
	206
a7b4f989 JK	207	/* The core set type structure */
	208	struct ip_set_type {
	209	struct list_head list;
	210
	211	/* Typename */
	212	char name[IPSET_MAXNAMELEN];
	213	/* Protocol version */
	214	u8 protocol;
a7b4f989 JK	215	/* Set type dimension */
a7b4f989 JK	216	u8 dimension;
c15f1c83 JE	217	/*
	218	* Supported family: may be NFPROTO_UNSPEC for both
	219	* NFPROTO_IPV4/NFPROTO_IPV6.
	220	*/
a7b4f989	221	u8 family;
f1e00b39 JK	222	/* Type revisions */
f1e00b39 JK	223	u8 revision_min, revision_max;
ccf0a4b7 JK	224	/* Revision-specific supported (create) flags */
ccf0a4b7 JK	225	u8 create_flags[IPSET_REVISION_MAX+1];
3b02b56c VD	226	/* Set features to control swapping */
3b02b56c VD	227	u16 features;
a7b4f989 JK	228
a7b4f989 JK	229	/* Create set */
1785e8f4 VL	230	int (create)(struct net net, struct ip_set *set,
1785e8f4 VL	231	struct nlattr *tb[], u32 flags);
a7b4f989 JK	232
	233	/* Attribute policies */
	234	const struct nla_policy create_policy[IPSET_ATTR_CREATE_MAX + 1];
	235	const struct nla_policy adt_policy[IPSET_ATTR_ADT_MAX + 1];
	236
	237	/* Set this to THIS_MODULE if you are a module, otherwise NULL */
	238	struct module *me;
	239	};
	240
	241	/* register and unregister set type */
	242	extern int ip_set_type_register(struct ip_set_type *set_type);
	243	extern void ip_set_type_unregister(struct ip_set_type *set_type);
	244
	245	/* A generic IP set */
	246	struct ip_set {
97f7cf1c JK	247	/* For call_cru in destroy */
97f7cf1c JK	248	struct rcu_head rcu;
a7b4f989 JK	249	/* The name of the set */
	250	char name[IPSET_MAXNAMELEN];
	251	/* Lock protecting the set data */
b57b2d1f	252	spinlock_t lock;
a7b4f989	253	/* References to the set */
2f9f28b2	254	u32 ref;
596cf3fe VP	255	/* References to the set for netlink events like dump,
	256	* ref can be swapped out by ip_set_swap
	257	*/
	258	u32 ref_netlink;
a7b4f989 JK	259	/* The core set type */
	260	struct ip_set_type *type;
	261	/* The type variant doing the real job */
	262	const struct ip_set_type_variant *variant;
	263	/* The actual INET family of the set */
	264	u8 family;
f1e00b39 JK	265	/* The type revision */
f1e00b39 JK	266	u8 revision;
075e64c0 JK	267	/* Extensions */
075e64c0 JK	268	u8 extensions;
af284ece JK	269	/* Create flags */
af284ece JK	270	u8 flags;
ca134ce8 JK	271	/* Default timeout value, if enabled */
ca134ce8 JK	272	u32 timeout;
702b71e7 JK	273	/* Number of elements (vs timeout) */
702b71e7 JK	274	u32 elements;
9e41f26a JK	275	/* Size of the dynamic extensions (vs timeout) */
9e41f26a JK	276	size_t ext_size;
ca134ce8 JK	277	/* Element data size */
	278	size_t dsize;
	279	/* Offsets to extensions in elements */
	280	size_t offset[IPSET_EXT_ID_MAX];
a7b4f989 JK	281	/* The type specific data */
	282	void *data;
	283	};
	284
68b63f08 OS	285	static inline void
	286	ip_set_ext_destroy(struct ip_set set, void data)
	287	{
	288	/* Check that the extension is enabled for the set and
	289	* call it's destroy function for its extension part in data.
	290	*/
017f77c0 JS	291	if (SET_WITH_COMMENT(set)) {
	292	struct ip_set_comment *c = ext_comment(data, set);
	293
	294	ip_set_extensions[IPSET_EXT_ID_COMMENT].destroy(set, c);
	295	}
68b63f08 OS	296	}
68b63f08 OS	297
85639185	298	int ip_set_put_flags(struct sk_buff skb, struct ip_set set);
68b63f08	299
93302880 JK	300	/* Netlink CB args */
93302880 JK	301	enum {
c4c99783	302	IPSET_CB_NET = 0, /* net namespace */
23c42a40	303	IPSET_CB_PROTO, /* ipset protocol */
c4c99783 JK	304	IPSET_CB_DUMP, /* dump single set/all sets */
	305	IPSET_CB_INDEX, /* set index */
	306	IPSET_CB_PRIVATE, /* set private data */
	307	IPSET_CB_ARG0, /* type specific */
93302880 JK	308	};
93302880 JK	309
a7b4f989	310	/* register and unregister set references */
1785e8f4 VL	311	extern ip_set_id_t ip_set_get_byname(struct net *net,
	312	const char name, struct ip_set *set);
	313	extern void ip_set_put_byindex(struct net *net, ip_set_id_t index);
439cd39e	314	extern void ip_set_name_byindex(struct net net, ip_set_id_t index, char name);
1785e8f4 VL	315	extern ip_set_id_t ip_set_nfnl_get_byindex(struct net *net, ip_set_id_t index);
1785e8f4 VL	316	extern void ip_set_nfnl_put(struct net *net, ip_set_id_t index);
a7b4f989 JK	317
a7b4f989 JK	318	/* API for iptables set match, and SET target */
ac8cc925	319
a7b4f989	320	extern int ip_set_add(ip_set_id_t id, const struct sk_buff *skb,
b66554cf	321	const struct xt_action_param *par,
075e64c0	322	struct ip_set_adt_opt *opt);
a7b4f989	323	extern int ip_set_del(ip_set_id_t id, const struct sk_buff *skb,
b66554cf	324	const struct xt_action_param *par,
075e64c0	325	struct ip_set_adt_opt *opt);
a7b4f989	326	extern int ip_set_test(ip_set_id_t id, const struct sk_buff *skb,
b66554cf	327	const struct xt_action_param *par,
075e64c0	328	struct ip_set_adt_opt *opt);
a7b4f989 JK	329
a7b4f989 JK	330	/* Utility functions */
15b4d93f	331	extern void *ip_set_alloc(size_t size);
a7b4f989 JK	332	extern void ip_set_free(void *members);
	333	extern int ip_set_get_ipaddr4(struct nlattr nla, __be32 ipaddr);
	334	extern int ip_set_get_ipaddr6(struct nlattr nla, union nf_inet_addr ipaddr);
03c8b234	335	extern size_t ip_set_elem_len(struct ip_set set, struct nlattr tb[],
95ad1f4a	336	size_t len, size_t align);
075e64c0 JK	337	extern int ip_set_get_extensions(struct ip_set set, struct nlattr tb[],
075e64c0 JK	338	struct ip_set_ext *ext);
837a90ea JK	339	extern int ip_set_put_extensions(struct sk_buff skb, const struct ip_set set,
837a90ea JK	340	const void *e, bool active);
4750005a JK	341	extern bool ip_set_match_extensions(struct ip_set *set,
	342	const struct ip_set_ext *ext,
	343	struct ip_set_ext *mext,
	344	u32 flags, void *data);
a7b4f989 JK	345
	346	static inline int
	347	ip_set_get_hostipaddr4(struct nlattr nla, u32 ipaddr)
	348	{
	349	__be32 ip;
	350	int ret = ip_set_get_ipaddr4(nla, &ip);
15b4d93f	351
a7b4f989 JK	352	if (ret)
	353	return ret;
	354	*ipaddr = ntohl(ip);
	355	return 0;
	356	}
	357
	358	/* Ignore IPSET_ERR_EXIST errors if asked to do so? */
	359	static inline bool
	360	ip_set_eexist(int ret, u32 flags)
	361	{
	362	return ret == -IPSET_ERR_EXIST && (flags & IPSET_FLAG_EXIST);
	363	}
	364
43c56e59 JK	365	/* Match elements marked with nomatch */
43c56e59 JK	366	static inline bool
0f1799ba	367	ip_set_enomatch(int ret, u32 flags, enum ipset_adt adt, struct ip_set *set)
43c56e59 JK	368	{
43c56e59 JK	369	return adt == IPSET_TEST &&
0f1799ba JK	370	(set->type->features & IPSET_TYPE_NOMATCH) &&
	371	((flags >> 16) & IPSET_FLAG_NOMATCH) &&
	372	(ret > 0 \|\| ret == -ENOTEMPTY);
43c56e59 JK	373	}
43c56e59 JK	374
a7b4f989 JK	375	/* Check the NLA_F_NET_BYTEORDER flag */
	376	static inline bool
	377	ip_set_attr_netorder(struct nlattr *tb[], int type)
	378	{
	379	return tb[type] && (tb[type]->nla_type & NLA_F_NET_BYTEORDER);
	380	}
	381
	382	static inline bool
	383	ip_set_optattr_netorder(struct nlattr *tb[], int type)
	384	{
	385	return !tb[type] \|\| (tb[type]->nla_type & NLA_F_NET_BYTEORDER);
	386	}
	387
	388	/* Useful converters */
	389	static inline u32
	390	ip_set_get_h32(const struct nlattr *attr)
	391	{
	392	return ntohl(nla_get_be32(attr));
	393	}
	394
	395	static inline u16
	396	ip_set_get_h16(const struct nlattr *attr)
	397	{
	398	return ntohs(nla_get_be16(attr));
	399	}
	400
7cf7899d DM	401	static inline int nla_put_ipaddr4(struct sk_buff *skb, int type, __be32 ipaddr)
7cf7899d DM	402	{
12ad5f65	403	struct nlattr *__nested = nla_nest_start(skb, type);
7cf7899d DM	404	int ret;
	405
	406	if (!__nested)
	407	return -EMSGSIZE;
930345ea	408	ret = nla_put_in_addr(skb, IPSET_ATTR_IPADDR_IPV4, ipaddr);
7cf7899d	409	if (!ret)
12ad5f65	410	nla_nest_end(skb, __nested);
7cf7899d DM	411	return ret;
	412	}
	413
3ace95c0 JK	414	static inline int nla_put_ipaddr6(struct sk_buff *skb, int type,
3ace95c0 JK	415	const struct in6_addr *ipaddrptr)
7cf7899d	416	{
12ad5f65	417	struct nlattr *__nested = nla_nest_start(skb, type);
7cf7899d DM	418	int ret;
	419
	420	if (!__nested)
	421	return -EMSGSIZE;
930345ea	422	ret = nla_put_in6_addr(skb, IPSET_ATTR_IPADDR_IPV6, ipaddrptr);
7cf7899d	423	if (!ret)
12ad5f65	424	nla_nest_end(skb, __nested);
7cf7899d DM	425	return ret;
7cf7899d DM	426	}
a7b4f989 JK	427
	428	/* Get address from skbuff */
	429	static inline __be32
	430	ip4addr(const struct sk_buff *skb, bool src)
	431	{
	432	return src ? ip_hdr(skb)->saddr : ip_hdr(skb)->daddr;
	433	}
	434
	435	static inline void
	436	ip4addrptr(const struct sk_buff skb, bool src, __be32 addr)
	437	{
	438	*addr = src ? ip_hdr(skb)->saddr : ip_hdr(skb)->daddr;
	439	}
	440
	441	static inline void
	442	ip6addrptr(const struct sk_buff skb, bool src, struct in6_addr addr)
	443	{
	444	memcpy(addr, src ? &ipv6_hdr(skb)->saddr : &ipv6_hdr(skb)->daddr,
	445	sizeof(*addr));
	446	}
	447
bd96b4c7 JS	448	/* How often should the gc be run by default */
	449	#define IPSET_GC_TIME (3 * 60)
	450
	451	/* Timeout period depending on the timeout value of the given set */
	452	#define IPSET_GC_PERIOD(timeout) \
	453	((timeout/3) ? min_t(u32, (timeout)/3, IPSET_GC_TIME) : 1)
	454
	455	/* Entry is set with no timeout value */
	456	#define IPSET_ELEM_PERMANENT 0
	457
	458	/* Set is defined with timeout support: timeout value may be 0 */
	459	#define IPSET_NO_TIMEOUT UINT_MAX
	460
	461	/* Max timeout value, see msecs_to_jiffies() in jiffies.h */
	462	#define IPSET_MAX_TIMEOUT (UINT_MAX >> 1)/MSEC_PER_SEC
	463
	464	#define ip_set_adt_opt_timeout(opt, set) \
	465	((opt)->ext.timeout != IPSET_NO_TIMEOUT ? (opt)->ext.timeout : (set)->timeout)
	466
	467	static inline unsigned int
	468	ip_set_timeout_uget(struct nlattr *tb)
	469	{
	470	unsigned int timeout = ip_set_get_h32(tb);
	471
	472	/* Normalize to fit into jiffies */
	473	if (timeout > IPSET_MAX_TIMEOUT)
	474	timeout = IPSET_MAX_TIMEOUT;
	475
	476	return timeout;
	477	}
	478
	479	static inline bool
	480	ip_set_timeout_expired(const unsigned long *t)
	481	{
	482	return t != IPSET_ELEM_PERMANENT && time_is_before_jiffies(t);
	483	}
	484
	485	static inline void
	486	ip_set_timeout_set(unsigned long *timeout, u32 value)
	487	{
	488	unsigned long t;
	489
	490	if (!value) {
	491	*timeout = IPSET_ELEM_PERMANENT;
	492	return;
	493	}
	494
	495	t = msecs_to_jiffies(value * MSEC_PER_SEC) + jiffies;
	496	if (t == IPSET_ELEM_PERMANENT)
	497	/* Bingo! :-) */
	498	t--;
	499	*timeout = t;
	500	}
	501
94177f6e JS	502	void ip_set_init_comment(struct ip_set set, struct ip_set_comment comment,
94177f6e JS	503	const struct ip_set_ext *ext);
bd96b4c7	504
bd96b4c7 JS	505	static inline void
	506	ip_set_init_counter(struct ip_set_counter *counter,
	507	const struct ip_set_ext *ext)
	508	{
	509	if (ext->bytes != ULLONG_MAX)
	510	atomic64_set(&(counter)->bytes, (long long)(ext->bytes));
	511	if (ext->packets != ULLONG_MAX)
	512	atomic64_set(&(counter)->packets, (long long)(ext->packets));
	513	}
	514
bd96b4c7 JS	515	static inline void
	516	ip_set_init_skbinfo(struct ip_set_skbinfo *skbinfo,
	517	const struct ip_set_ext *ext)
	518	{
	519	*skbinfo = ext->skbinfo;
	520	}
075e64c0	521
e9374524 VP	522	static inline void
	523	nf_inet_addr_mask_inplace(union nf_inet_addr *a1,
	524	const union nf_inet_addr *mask)
	525	{
	526	a1->all[0] &= mask->all[0];
	527	a1->all[1] &= mask->all[1];
	528	a1->all[2] &= mask->all[2];
	529	a1->all[3] &= mask->all[3];
	530	}
	531
ca134ce8	532	#define IP_SET_INIT_KEXT(skb, opt, set) \
f66ee041	533	{ .bytes = (skb)->len, .packets = 1, .target = true,\
ca134ce8	534	.timeout = ip_set_adt_opt_timeout(opt, set) }
075e64c0	535
ca134ce8	536	#define IP_SET_INIT_UEXT(set) \
34d666d4	537	{ .bytes = ULLONG_MAX, .packets = ULLONG_MAX, \
ca134ce8	538	.timeout = (set)->timeout }
075e64c0	539
35b8dcf8 JK	540	#define IPSET_CONCAT(a, b) a##b
	541	#define IPSET_TOKEN(a, b) IPSET_CONCAT(a, b)
	542
a7b4f989	543	#endif /_IP_SET_H /