[deliverable/linux.git] / include / linux / netfilter / ipset / ip_set.h

#ifndef _IP_SET_H
#define _IP_SET_H

/* Copyright (C) 2000-2002 Joakim Axelsson <gozem@linux.nu>
 *                         Patrick Schaaf <bof@bof.de>
 *                         Martin Josefsson <gandalf@wlug.westbo.se>
 * Copyright (C) 2003-2011 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.
 */

#include <linux/types.h>

/* The protocol version */
#define IPSET_PROTOCOL		6

/* The max length of strings including NUL: set and type identifiers */
#define IPSET_MAXNAMELEN	32

/* Message types and commands */
enum ipset_cmd {
	IPSET_CMD_NONE,
	IPSET_CMD_PROTOCOL,	/* 1: Return protocol version */
	IPSET_CMD_CREATE,	/* 2: Create a new (empty) set */
	IPSET_CMD_DESTROY,	/* 3: Destroy a (empty) set */
	IPSET_CMD_FLUSH,	/* 4: Remove all elements from a set */
	IPSET_CMD_RENAME,	/* 5: Rename a set */
	IPSET_CMD_SWAP,		/* 6: Swap two sets */
	IPSET_CMD_LIST,		/* 7: List sets */
	IPSET_CMD_SAVE,		/* 8: Save sets */
	IPSET_CMD_ADD,		/* 9: Add an element to a set */
	IPSET_CMD_DEL,		/* 10: Delete an element from a set */
	IPSET_CMD_TEST,		/* 11: Test an element in a set */
	IPSET_CMD_HEADER,	/* 12: Get set header data only */
	IPSET_CMD_TYPE,		/* 13: Get set type */
	IPSET_MSG_MAX,		/* Netlink message commands */

	/* Commands in userspace: */
	IPSET_CMD_RESTORE = IPSET_MSG_MAX, /* 14: Enter restore mode */
	IPSET_CMD_HELP,		/* 15: Get help */
	IPSET_CMD_VERSION,	/* 16: Get program version */
	IPSET_CMD_QUIT,		/* 17: Quit from interactive mode */

	IPSET_CMD_MAX,

	IPSET_CMD_COMMIT = IPSET_CMD_MAX, /* 18: Commit buffered commands */
};

/* Attributes at command level */
enum {
	IPSET_ATTR_UNSPEC,
	IPSET_ATTR_PROTOCOL,	/* 1: Protocol version */
	IPSET_ATTR_SETNAME,	/* 2: Name of the set */
	IPSET_ATTR_TYPENAME,	/* 3: Typename */
	IPSET_ATTR_SETNAME2 = IPSET_ATTR_TYPENAME, /* Setname at rename/swap */
	IPSET_ATTR_REVISION,	/* 4: Settype revision */
	IPSET_ATTR_FAMILY,	/* 5: Settype family */
	IPSET_ATTR_FLAGS,	/* 6: Flags at command level */
	IPSET_ATTR_DATA,	/* 7: Nested attributes */
	IPSET_ATTR_ADT,		/* 8: Multiple data containers */
	IPSET_ATTR_LINENO,	/* 9: Restore lineno */
	IPSET_ATTR_PROTOCOL_MIN, /* 10: Minimal supported version number */
	IPSET_ATTR_REVISION_MIN	= IPSET_ATTR_PROTOCOL_MIN, /* type rev min */
	__IPSET_ATTR_CMD_MAX,
};
#define IPSET_ATTR_CMD_MAX	(__IPSET_ATTR_CMD_MAX - 1)

/* CADT specific attributes */
enum {
	IPSET_ATTR_IP = IPSET_ATTR_UNSPEC + 1,
	IPSET_ATTR_IP_FROM = IPSET_ATTR_IP,
	IPSET_ATTR_IP_TO,	/* 2 */
	IPSET_ATTR_CIDR,	/* 3 */
	IPSET_ATTR_PORT,	/* 4 */
	IPSET_ATTR_PORT_FROM = IPSET_ATTR_PORT,
	IPSET_ATTR_PORT_TO,	/* 5 */
	IPSET_ATTR_TIMEOUT,	/* 6 */
	IPSET_ATTR_PROTO,	/* 7 */
	IPSET_ATTR_CADT_FLAGS,	/* 8 */
	IPSET_ATTR_CADT_LINENO = IPSET_ATTR_LINENO,	/* 9 */
	/* Reserve empty slots */
	IPSET_ATTR_CADT_MAX = 16,
	/* Create-only specific attributes */
	IPSET_ATTR_GC,
	IPSET_ATTR_HASHSIZE,
	IPSET_ATTR_MAXELEM,
	IPSET_ATTR_NETMASK,
	IPSET_ATTR_PROBES,
	IPSET_ATTR_RESIZE,
	IPSET_ATTR_SIZE,
	/* Kernel-only */
	IPSET_ATTR_ELEMENTS,
	IPSET_ATTR_REFERENCES,
	IPSET_ATTR_MEMSIZE,

	__IPSET_ATTR_CREATE_MAX,
};
#define IPSET_ATTR_CREATE_MAX	(__IPSET_ATTR_CREATE_MAX - 1)

/* ADT specific attributes */
enum {
	IPSET_ATTR_ETHER = IPSET_ATTR_CADT_MAX + 1,
	IPSET_ATTR_NAME,
	IPSET_ATTR_NAMEREF,
	IPSET_ATTR_IP2,
	IPSET_ATTR_CIDR2,
	IPSET_ATTR_IP2_TO,
	IPSET_ATTR_IFACE,
	__IPSET_ATTR_ADT_MAX,
};
#define IPSET_ATTR_ADT_MAX	(__IPSET_ATTR_ADT_MAX - 1)

/* IP specific attributes */
enum {
	IPSET_ATTR_IPADDR_IPV4 = IPSET_ATTR_UNSPEC + 1,
	IPSET_ATTR_IPADDR_IPV6,
	__IPSET_ATTR_IPADDR_MAX,
};
#define IPSET_ATTR_IPADDR_MAX	(__IPSET_ATTR_IPADDR_MAX - 1)

/* Error codes */
enum ipset_errno {
	IPSET_ERR_PRIVATE = 4096,
	IPSET_ERR_PROTOCOL,
	IPSET_ERR_FIND_TYPE,
	IPSET_ERR_MAX_SETS,
	IPSET_ERR_BUSY,
	IPSET_ERR_EXIST_SETNAME2,
	IPSET_ERR_TYPE_MISMATCH,
	IPSET_ERR_EXIST,
	IPSET_ERR_INVALID_CIDR,
	IPSET_ERR_INVALID_NETMASK,
	IPSET_ERR_INVALID_FAMILY,
	IPSET_ERR_TIMEOUT,
	IPSET_ERR_REFERENCED,
	IPSET_ERR_IPADDR_IPV4,
	IPSET_ERR_IPADDR_IPV6,

	/* Type specific error codes */
	IPSET_ERR_TYPE_SPECIFIC = 4352,
};

/* Flags at command level */
enum ipset_cmd_flags {
	IPSET_FLAG_BIT_EXIST	= 0,
	IPSET_FLAG_EXIST	= (1 << IPSET_FLAG_BIT_EXIST),
	IPSET_FLAG_BIT_LIST_SETNAME = 1,
	IPSET_FLAG_LIST_SETNAME	= (1 << IPSET_FLAG_BIT_LIST_SETNAME),
	IPSET_FLAG_BIT_LIST_HEADER = 2,
	IPSET_FLAG_LIST_HEADER	= (1 << IPSET_FLAG_BIT_LIST_HEADER),
	IPSET_FLAG_CMD_MAX = 15,	/* Lower half */
};

/* Flags at CADT attribute level */
enum ipset_cadt_flags {
	IPSET_FLAG_BIT_BEFORE	= 0,
	IPSET_FLAG_BEFORE	= (1 << IPSET_FLAG_BIT_BEFORE),
	IPSET_FLAG_BIT_PHYSDEV	= 1,
	IPSET_FLAG_PHYSDEV	= (1 << IPSET_FLAG_BIT_PHYSDEV),
	IPSET_FLAG_BIT_NOMATCH	= 2,
	IPSET_FLAG_NOMATCH	= (1 << IPSET_FLAG_BIT_NOMATCH),
	IPSET_FLAG_CADT_MAX	= 15,	/* Upper half */
};

/* Commands with settype-specific attributes */
enum ipset_adt {
	IPSET_ADD,
	IPSET_DEL,
	IPSET_TEST,
	IPSET_ADT_MAX,
	IPSET_CREATE = IPSET_ADT_MAX,
	IPSET_CADT_MAX,
};

/* Sets are identified by an index in kernel space. Tweak with ip_set_id_t
 * and IPSET_INVALID_ID if you want to increase the max number of sets.
 */
typedef __u16 ip_set_id_t;

#define IPSET_INVALID_ID		65535

enum ip_set_dim {
	IPSET_DIM_ZERO = 0,
	IPSET_DIM_ONE,
	IPSET_DIM_TWO,
	IPSET_DIM_THREE,
	/* Max dimension in elements.
	 * If changed, new revision of iptables match/target is required.
	 */
	IPSET_DIM_MAX = 6,
};

/* Option flags for kernel operations */
enum ip_set_kopt {
	IPSET_INV_MATCH = (1 << IPSET_DIM_ZERO),
	IPSET_DIM_ONE_SRC = (1 << IPSET_DIM_ONE),
	IPSET_DIM_TWO_SRC = (1 << IPSET_DIM_TWO),
	IPSET_DIM_THREE_SRC = (1 << IPSET_DIM_THREE),
};

#ifdef __KERNEL__
#include <linux/ip.h>
#include <linux/ipv6.h>
#include <linux/netlink.h>
#include <linux/netfilter.h>
#include <linux/netfilter/x_tables.h>
#include <linux/vmalloc.h>
#include <net/netlink.h>

/* 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),
	/* Strictly speaking not a feature, but a flag for dumping:
	 * this settype must be dumped last */
	IPSET_DUMP_LAST_FLAG = 7,
	IPSET_DUMP_LAST = (1 << IPSET_DUMP_LAST_FLAG),
};

struct ip_set;

typedef int (*ipset_adtfn)(struct ip_set *set, void *value,
			   u32 timeout, u32 flags);

/* 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 */
	u32 timeout;		/* Timeout value */
};

/* 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, const 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 features to control swapping */
	u8 features;
	/* 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;

	/* Create set */
	int (*create)(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;
	/* The type specific data */
	void *data;
};

/* register and unregister set references */
extern ip_set_id_t ip_set_get_byname(const char *name, struct ip_set **set);
extern void ip_set_put_byindex(ip_set_id_t index);
extern const char *ip_set_name_byindex(ip_set_id_t index);
extern ip_set_id_t ip_set_nfnl_get(const char *name);
extern ip_set_id_t ip_set_nfnl_get_byindex(ip_set_id_t index);
extern void ip_set_nfnl_put(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,
		      const 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,
		      const 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,
		       const 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);

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

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

#endif /* __KERNEL__ */

/* Interface to iptables/ip6tables */

#define SO_IP_SET		83

union ip_set_name_index {
	char name[IPSET_MAXNAMELEN];
	ip_set_id_t index;
};

#define IP_SET_OP_GET_BYNAME	0x00000006	/* Get set index by name */
struct ip_set_req_get_set {
	unsigned op;
	unsigned version;
	union ip_set_name_index set;
};

#define IP_SET_OP_GET_BYINDEX	0x00000007	/* Get set name by index */
/* Uses ip_set_req_get_set */

#define IP_SET_OP_VERSION	0x00000100	/* Ask kernel version */
struct ip_set_req_version {
	unsigned op;
	unsigned version;
};

#endif /*_IP_SET_H */
Commit	Line	Data
a7b4f989 JK	1	#ifndef _IP_SET_H
	2	#define _IP_SET_H
	3
	4	/* Copyright (C) 2000-2002 Joakim Axelsson <gozem@linux.nu>
	5	* Patrick Schaaf <bof@bof.de>
	6	* Martin Josefsson <gandalf@wlug.westbo.se>
	7	* Copyright (C) 2003-2011 Jozsef Kadlecsik <kadlec@blackhole.kfki.hu>
	8	*
	9	* This program is free software; you can redistribute it and/or modify
	10	* it under the terms of the GNU General Public License version 2 as
	11	* published by the Free Software Foundation.
	12	*/
	13
ae8ded1c JE	14	#include <linux/types.h>
ae8ded1c JE	15
a7b4f989 JK	16	/* The protocol version */
	17	#define IPSET_PROTOCOL 6
	18
	19	/* The max length of strings including NUL: set and type identifiers */
	20	#define IPSET_MAXNAMELEN 32
	21
	22	/* Message types and commands */
	23	enum ipset_cmd {
	24	IPSET_CMD_NONE,
	25	IPSET_CMD_PROTOCOL, /* 1: Return protocol version */
	26	IPSET_CMD_CREATE, /* 2: Create a new (empty) set */
	27	IPSET_CMD_DESTROY, /* 3: Destroy a (empty) set */
	28	IPSET_CMD_FLUSH, /* 4: Remove all elements from a set */
	29	IPSET_CMD_RENAME, /* 5: Rename a set */
	30	IPSET_CMD_SWAP, /* 6: Swap two sets */
	31	IPSET_CMD_LIST, /* 7: List sets */
	32	IPSET_CMD_SAVE, /* 8: Save sets */
	33	IPSET_CMD_ADD, /* 9: Add an element to a set */
	34	IPSET_CMD_DEL, /* 10: Delete an element from a set */
	35	IPSET_CMD_TEST, /* 11: Test an element in a set */
	36	IPSET_CMD_HEADER, /* 12: Get set header data only */
	37	IPSET_CMD_TYPE, /* 13: Get set type */
	38	IPSET_MSG_MAX, /* Netlink message commands */
	39
	40	/* Commands in userspace: */
	41	IPSET_CMD_RESTORE = IPSET_MSG_MAX, /* 14: Enter restore mode */
	42	IPSET_CMD_HELP, /* 15: Get help */
	43	IPSET_CMD_VERSION, /* 16: Get program version */
	44	IPSET_CMD_QUIT, /* 17: Quit from interactive mode */
	45
	46	IPSET_CMD_MAX,
	47
	48	IPSET_CMD_COMMIT = IPSET_CMD_MAX, /* 18: Commit buffered commands */
	49	};
	50
	51	/* Attributes at command level */
	52	enum {
	53	IPSET_ATTR_UNSPEC,
	54	IPSET_ATTR_PROTOCOL, /* 1: Protocol version */
	55	IPSET_ATTR_SETNAME, /* 2: Name of the set */
	56	IPSET_ATTR_TYPENAME, /* 3: Typename */
	57	IPSET_ATTR_SETNAME2 = IPSET_ATTR_TYPENAME, /* Setname at rename/swap */
	58	IPSET_ATTR_REVISION, /* 4: Settype revision */
	59	IPSET_ATTR_FAMILY, /* 5: Settype family */
	60	IPSET_ATTR_FLAGS, /* 6: Flags at command level */
	61	IPSET_ATTR_DATA, /* 7: Nested attributes */
	62	IPSET_ATTR_ADT, /* 8: Multiple data containers */
	63	IPSET_ATTR_LINENO, /* 9: Restore lineno */
	64	IPSET_ATTR_PROTOCOL_MIN, /* 10: Minimal supported version number */
	65	IPSET_ATTR_REVISION_MIN = IPSET_ATTR_PROTOCOL_MIN, /* type rev min */
	66	__IPSET_ATTR_CMD_MAX,
	67	};
	68	#define IPSET_ATTR_CMD_MAX (__IPSET_ATTR_CMD_MAX - 1)
	69
	70	/* CADT specific attributes */
	71	enum {
	72	IPSET_ATTR_IP = IPSET_ATTR_UNSPEC + 1,
	73	IPSET_ATTR_IP_FROM = IPSET_ATTR_IP,
	74	IPSET_ATTR_IP_TO, /* 2 */
	75	IPSET_ATTR_CIDR, /* 3 */
	76	IPSET_ATTR_PORT, /* 4 */
	77	IPSET_ATTR_PORT_FROM = IPSET_ATTR_PORT,
	78	IPSET_ATTR_PORT_TO, /* 5 */
	79	IPSET_ATTR_TIMEOUT, /* 6 */
80	IPSET_ATTR_PROTO, /* 7 */
81	IPSET_ATTR_CADT_FLAGS, /* 8 */
82	IPSET_ATTR_CADT_LINENO = IPSET_ATTR_LINENO, /* 9 */
83	/* Reserve empty slots */
84	IPSET_ATTR_CADT_MAX = 16,
85	/* Create-only specific attributes */
86	IPSET_ATTR_GC,
87	IPSET_ATTR_HASHSIZE,
88	IPSET_ATTR_MAXELEM,
89	IPSET_ATTR_NETMASK,
90	IPSET_ATTR_PROBES,
91	IPSET_ATTR_RESIZE,
92	IPSET_ATTR_SIZE,
93	/* Kernel-only */
94	IPSET_ATTR_ELEMENTS,
95	IPSET_ATTR_REFERENCES,
96	IPSET_ATTR_MEMSIZE,
97
98	__IPSET_ATTR_CREATE_MAX,
99	};
100	#define IPSET_ATTR_CREATE_MAX (__IPSET_ATTR_CREATE_MAX - 1)
101
102	/* ADT specific attributes */
103	enum {
104	IPSET_ATTR_ETHER = IPSET_ATTR_CADT_MAX + 1,
105	IPSET_ATTR_NAME,
106	IPSET_ATTR_NAMEREF,
107	IPSET_ATTR_IP2,
108	IPSET_ATTR_CIDR2,
d0d9e0a5	109	IPSET_ATTR_IP2_TO,
e385357a	110	IPSET_ATTR_IFACE,
a7b4f989 JK	111	__IPSET_ATTR_ADT_MAX,
	112	};
	113	#define IPSET_ATTR_ADT_MAX (__IPSET_ATTR_ADT_MAX - 1)
	114
	115	/* IP specific attributes */
	116	enum {
	117	IPSET_ATTR_IPADDR_IPV4 = IPSET_ATTR_UNSPEC + 1,
	118	IPSET_ATTR_IPADDR_IPV6,
	119	__IPSET_ATTR_IPADDR_MAX,
	120	};
	121	#define IPSET_ATTR_IPADDR_MAX (__IPSET_ATTR_IPADDR_MAX - 1)
	122
	123	/* Error codes */
	124	enum ipset_errno {
	125	IPSET_ERR_PRIVATE = 4096,
	126	IPSET_ERR_PROTOCOL,
	127	IPSET_ERR_FIND_TYPE,
	128	IPSET_ERR_MAX_SETS,
	129	IPSET_ERR_BUSY,
	130	IPSET_ERR_EXIST_SETNAME2,
	131	IPSET_ERR_TYPE_MISMATCH,
	132	IPSET_ERR_EXIST,
	133	IPSET_ERR_INVALID_CIDR,
	134	IPSET_ERR_INVALID_NETMASK,
	135	IPSET_ERR_INVALID_FAMILY,
	136	IPSET_ERR_TIMEOUT,
	137	IPSET_ERR_REFERENCED,
	138	IPSET_ERR_IPADDR_IPV4,
	139	IPSET_ERR_IPADDR_IPV6,
	140
	141	/* Type specific error codes */
	142	IPSET_ERR_TYPE_SPECIFIC = 4352,
	143	};
	144
	145	/* Flags at command level */
	146	enum ipset_cmd_flags {
	147	IPSET_FLAG_BIT_EXIST = 0,
	148	IPSET_FLAG_EXIST = (1 << IPSET_FLAG_BIT_EXIST),
c1e2e043 JK	149	IPSET_FLAG_BIT_LIST_SETNAME = 1,
	150	IPSET_FLAG_LIST_SETNAME = (1 << IPSET_FLAG_BIT_LIST_SETNAME),
	151	IPSET_FLAG_BIT_LIST_HEADER = 2,
	152	IPSET_FLAG_LIST_HEADER = (1 << IPSET_FLAG_BIT_LIST_HEADER),
2a7cef2a	153	IPSET_FLAG_CMD_MAX = 15, /* Lower half */
a7b4f989 JK	154	};
	155
	156	/* Flags at CADT attribute level */
	157	enum ipset_cadt_flags {
	158	IPSET_FLAG_BIT_BEFORE = 0,
	159	IPSET_FLAG_BEFORE = (1 << IPSET_FLAG_BIT_BEFORE),
e385357a JK	160	IPSET_FLAG_BIT_PHYSDEV = 1,
e385357a JK	161	IPSET_FLAG_PHYSDEV = (1 << IPSET_FLAG_BIT_PHYSDEV),
2a7cef2a JK	162	IPSET_FLAG_BIT_NOMATCH = 2,
	163	IPSET_FLAG_NOMATCH = (1 << IPSET_FLAG_BIT_NOMATCH),
	164	IPSET_FLAG_CADT_MAX = 15, /* Upper half */
a7b4f989 JK	165	};
	166
	167	/* Commands with settype-specific attributes */
	168	enum ipset_adt {
	169	IPSET_ADD,
	170	IPSET_DEL,
	171	IPSET_TEST,
	172	IPSET_ADT_MAX,
	173	IPSET_CREATE = IPSET_ADT_MAX,
	174	IPSET_CADT_MAX,
	175	};
	176
a7b4f989 JK	177	/* Sets are identified by an index in kernel space. Tweak with ip_set_id_t
	178	* and IPSET_INVALID_ID if you want to increase the max number of sets.
	179	*/
ae8ded1c	180	typedef __u16 ip_set_id_t;
a7b4f989 JK	181
	182	#define IPSET_INVALID_ID 65535
	183
	184	enum ip_set_dim {
	185	IPSET_DIM_ZERO = 0,
	186	IPSET_DIM_ONE,
	187	IPSET_DIM_TWO,
	188	IPSET_DIM_THREE,
	189	/* Max dimension in elements.
	190	* If changed, new revision of iptables match/target is required.
	191	*/
	192	IPSET_DIM_MAX = 6,
	193	};
	194
	195	/* Option flags for kernel operations */
	196	enum ip_set_kopt {
	197	IPSET_INV_MATCH = (1 << IPSET_DIM_ZERO),
	198	IPSET_DIM_ONE_SRC = (1 << IPSET_DIM_ONE),
	199	IPSET_DIM_TWO_SRC = (1 << IPSET_DIM_TWO),
	200	IPSET_DIM_THREE_SRC = (1 << IPSET_DIM_THREE),
	201	};
	202
ae8ded1c JE	203	#ifdef __KERNEL__
	204	#include <linux/ip.h>
	205	#include <linux/ipv6.h>
	206	#include <linux/netlink.h>
	207	#include <linux/netfilter.h>
	208	#include <linux/netfilter/x_tables.h>
	209	#include <linux/vmalloc.h>
	210	#include <net/netlink.h>
	211
a7b4f989 JK	212	/* Set features */
	213	enum ip_set_feature {
	214	IPSET_TYPE_IP_FLAG = 0,
	215	IPSET_TYPE_IP = (1 << IPSET_TYPE_IP_FLAG),
	216	IPSET_TYPE_PORT_FLAG = 1,
	217	IPSET_TYPE_PORT = (1 << IPSET_TYPE_PORT_FLAG),
	218	IPSET_TYPE_MAC_FLAG = 2,
	219	IPSET_TYPE_MAC = (1 << IPSET_TYPE_MAC_FLAG),
	220	IPSET_TYPE_IP2_FLAG = 3,
	221	IPSET_TYPE_IP2 = (1 << IPSET_TYPE_IP2_FLAG),
	222	IPSET_TYPE_NAME_FLAG = 4,
	223	IPSET_TYPE_NAME = (1 << IPSET_TYPE_NAME_FLAG),
e385357a JK	224	IPSET_TYPE_IFACE_FLAG = 5,
e385357a JK	225	IPSET_TYPE_IFACE = (1 << IPSET_TYPE_IFACE_FLAG),
a7b4f989 JK	226	/* Strictly speaking not a feature, but a flag for dumping:
	227	* this settype must be dumped last */
	228	IPSET_DUMP_LAST_FLAG = 7,
	229	IPSET_DUMP_LAST = (1 << IPSET_DUMP_LAST_FLAG),
	230	};
	231
	232	struct ip_set;
	233
5416219e JK	234	typedef int (ipset_adtfn)(struct ip_set set, void *value,
5416219e JK	235	u32 timeout, u32 flags);
a7b4f989	236
ac8cc925 JK	237	/* Kernel API function options */
	238	struct ip_set_adt_opt {
	239	u8 family; /* Actual protocol family */
	240	u8 dim; /* Dimension of match/target */
	241	u8 flags; /* Direction and negation flags */
	242	u32 cmdflags; /* Command-like flags */
	243	u32 timeout; /* Timeout value */
	244	};
	245
a7b4f989 JK	246	/* Set type, variant-specific part */
	247	struct ip_set_type_variant {
	248	/* Kernelspace: test/add/del entries
	249	* returns negative error code,
	250	* zero for no match/success to add/delete
	251	* positive for matching element */
	252	int (kadt)(struct ip_set set, const struct sk_buff * skb,
b66554cf	253	const struct xt_action_param *par,
ac8cc925	254	enum ipset_adt adt, const struct ip_set_adt_opt *opt);
a7b4f989 JK	255
	256	/* Userspace: test/add/del entries
	257	* returns negative error code,
	258	* zero for no match/success to add/delete
	259	* positive for matching element */
	260	int (uadt)(struct ip_set set, struct nlattr *tb[],
3d14b171	261	enum ipset_adt adt, u32 *lineno, u32 flags, bool retried);
a7b4f989 JK	262
	263	/* Low level add/del/test functions */
	264	ipset_adtfn adt[IPSET_ADT_MAX];
	265
	266	/* When adding entries and set is full, try to resize the set */
	267	int (resize)(struct ip_set set, bool retried);
	268	/* Destroy the set */
	269	void (destroy)(struct ip_set set);
	270	/* Flush the elements */
	271	void (flush)(struct ip_set set);
	272	/* Expire entries before listing */
	273	void (expire)(struct ip_set set);
	274	/* List set header data */
	275	int (head)(struct ip_set set, struct sk_buff *skb);
	276	/* List elements */
	277	int (list)(const struct ip_set set, struct sk_buff *skb,
	278	struct netlink_callback *cb);
	279
	280	/* Return true if "b" set is the same as "a"
	281	* according to the create set parameters */
	282	bool (same_set)(const struct ip_set a, const struct ip_set *b);
	283	};
	284
	285	/* The core set type structure */
	286	struct ip_set_type {
	287	struct list_head list;
	288
	289	/* Typename */
	290	char name[IPSET_MAXNAMELEN];
	291	/* Protocol version */
	292	u8 protocol;
	293	/* Set features to control swapping */
	294	u8 features;
	295	/* Set type dimension */
	296	u8 dimension;
c15f1c83 JE	297	/*
	298	* Supported family: may be NFPROTO_UNSPEC for both
	299	* NFPROTO_IPV4/NFPROTO_IPV6.
	300	*/
a7b4f989	301	u8 family;
f1e00b39 JK	302	/* Type revisions */
f1e00b39 JK	303	u8 revision_min, revision_max;
a7b4f989 JK	304
	305	/* Create set */
	306	int (create)(struct ip_set set, struct nlattr *tb[], u32 flags);
	307
	308	/* Attribute policies */
	309	const struct nla_policy create_policy[IPSET_ATTR_CREATE_MAX + 1];
	310	const struct nla_policy adt_policy[IPSET_ATTR_ADT_MAX + 1];
	311
	312	/* Set this to THIS_MODULE if you are a module, otherwise NULL */
	313	struct module *me;
	314	};
	315
	316	/* register and unregister set type */
	317	extern int ip_set_type_register(struct ip_set_type *set_type);
	318	extern void ip_set_type_unregister(struct ip_set_type *set_type);
	319
	320	/* A generic IP set */
	321	struct ip_set {
	322	/* The name of the set */
	323	char name[IPSET_MAXNAMELEN];
	324	/* Lock protecting the set data */
	325	rwlock_t lock;
	326	/* References to the set */
2f9f28b2	327	u32 ref;
a7b4f989 JK	328	/* The core set type */
	329	struct ip_set_type *type;
	330	/* The type variant doing the real job */
	331	const struct ip_set_type_variant *variant;
	332	/* The actual INET family of the set */
	333	u8 family;
f1e00b39 JK	334	/* The type revision */
f1e00b39 JK	335	u8 revision;
a7b4f989 JK	336	/* The type specific data */
	337	void *data;
	338	};
	339
	340	/* register and unregister set references */
	341	extern ip_set_id_t ip_set_get_byname(const char name, struct ip_set *set);
	342	extern void ip_set_put_byindex(ip_set_id_t index);
15b4d93f	343	extern const char *ip_set_name_byindex(ip_set_id_t index);
a7b4f989 JK	344	extern ip_set_id_t ip_set_nfnl_get(const char *name);
	345	extern ip_set_id_t ip_set_nfnl_get_byindex(ip_set_id_t index);
	346	extern void ip_set_nfnl_put(ip_set_id_t index);
	347
	348	/* API for iptables set match, and SET target */
ac8cc925	349
a7b4f989	350	extern int ip_set_add(ip_set_id_t id, const struct sk_buff *skb,
b66554cf	351	const struct xt_action_param *par,
ac8cc925	352	const struct ip_set_adt_opt *opt);
a7b4f989	353	extern int ip_set_del(ip_set_id_t id, const struct sk_buff *skb,
b66554cf	354	const struct xt_action_param *par,
ac8cc925	355	const struct ip_set_adt_opt *opt);
a7b4f989	356	extern int ip_set_test(ip_set_id_t id, const struct sk_buff *skb,
b66554cf	357	const struct xt_action_param *par,
ac8cc925	358	const struct ip_set_adt_opt *opt);
a7b4f989 JK	359
a7b4f989 JK	360	/* Utility functions */
15b4d93f	361	extern void *ip_set_alloc(size_t size);
a7b4f989 JK	362	extern void ip_set_free(void *members);
	363	extern int ip_set_get_ipaddr4(struct nlattr nla, __be32 ipaddr);
	364	extern int ip_set_get_ipaddr6(struct nlattr nla, union nf_inet_addr ipaddr);
	365
	366	static inline int
	367	ip_set_get_hostipaddr4(struct nlattr nla, u32 ipaddr)
	368	{
	369	__be32 ip;
	370	int ret = ip_set_get_ipaddr4(nla, &ip);
15b4d93f	371
a7b4f989 JK	372	if (ret)
	373	return ret;
	374	*ipaddr = ntohl(ip);
	375	return 0;
	376	}
	377
	378	/* Ignore IPSET_ERR_EXIST errors if asked to do so? */
	379	static inline bool
	380	ip_set_eexist(int ret, u32 flags)
	381	{
	382	return ret == -IPSET_ERR_EXIST && (flags & IPSET_FLAG_EXIST);
	383	}
	384
	385	/* Check the NLA_F_NET_BYTEORDER flag */
	386	static inline bool
	387	ip_set_attr_netorder(struct nlattr *tb[], int type)
	388	{
	389	return tb[type] && (tb[type]->nla_type & NLA_F_NET_BYTEORDER);
	390	}
	391
	392	static inline bool
	393	ip_set_optattr_netorder(struct nlattr *tb[], int type)
	394	{
	395	return !tb[type] \|\| (tb[type]->nla_type & NLA_F_NET_BYTEORDER);
	396	}
	397
	398	/* Useful converters */
	399	static inline u32
	400	ip_set_get_h32(const struct nlattr *attr)
	401	{
	402	return ntohl(nla_get_be32(attr));
	403	}
	404
	405	static inline u16
	406	ip_set_get_h16(const struct nlattr *attr)
	407	{
	408	return ntohs(nla_get_be16(attr));
	409	}
	410
	411	#define ipset_nest_start(skb, attr) nla_nest_start(skb, attr \| NLA_F_NESTED)
	412	#define ipset_nest_end(skb, start) nla_nest_end(skb, start)
	413
7cf7899d DM	414	static inline int nla_put_ipaddr4(struct sk_buff *skb, int type, __be32 ipaddr)
	415	{
	416	struct nlattr *__nested = ipset_nest_start(skb, type);
	417	int ret;
	418
	419	if (!__nested)
	420	return -EMSGSIZE;
	421	ret = nla_put_net32(skb, IPSET_ATTR_IPADDR_IPV4, ipaddr);
	422	if (!ret)
	423	ipset_nest_end(skb, __nested);
	424	return ret;
	425	}
	426
	427	static inline int nla_put_ipaddr6(struct sk_buff skb, int type, const struct in6_addr ipaddrptr)
	428	{
	429	struct nlattr *__nested = ipset_nest_start(skb, type);
	430	int ret;
	431
	432	if (!__nested)
	433	return -EMSGSIZE;
	434	ret = nla_put(skb, IPSET_ATTR_IPADDR_IPV6,
	435	sizeof(struct in6_addr), ipaddrptr);
	436	if (!ret)
	437	ipset_nest_end(skb, __nested);
	438	return ret;
	439	}
a7b4f989 JK	440
	441	/* Get address from skbuff */
	442	static inline __be32
	443	ip4addr(const struct sk_buff *skb, bool src)
	444	{
	445	return src ? ip_hdr(skb)->saddr : ip_hdr(skb)->daddr;
	446	}
	447
	448	static inline void
	449	ip4addrptr(const struct sk_buff skb, bool src, __be32 addr)
	450	{
	451	*addr = src ? ip_hdr(skb)->saddr : ip_hdr(skb)->daddr;
	452	}
	453
	454	static inline void
	455	ip6addrptr(const struct sk_buff skb, bool src, struct in6_addr addr)
	456	{
	457	memcpy(addr, src ? &ipv6_hdr(skb)->saddr : &ipv6_hdr(skb)->daddr,
	458	sizeof(*addr));
	459	}
	460
	461	/* Calculate the bytes required to store the inclusive range of a-b */
	462	static inline int
	463	bitmap_bytes(u32 a, u32 b)
	464	{
	465	return 4 * ((((b - a + 8) / 8) + 3) / 4);
	466	}
	467
ae8ded1c JE	468	#endif /* __KERNEL__ */
ae8ded1c JE	469
a7b4f989 JK	470	/* Interface to iptables/ip6tables */
	471
	472	#define SO_IP_SET 83
	473
	474	union ip_set_name_index {
	475	char name[IPSET_MAXNAMELEN];
	476	ip_set_id_t index;
	477	};
	478
	479	#define IP_SET_OP_GET_BYNAME 0x00000006 /* Get set index by name */
	480	struct ip_set_req_get_set {
	481	unsigned op;
	482	unsigned version;
	483	union ip_set_name_index set;
	484	};
	485
	486	#define IP_SET_OP_GET_BYINDEX 0x00000007 /* Get set name by index */
	487	/* Uses ip_set_req_get_set */
	488
	489	#define IP_SET_OP_VERSION 0x00000100 /* Ask kernel version */
	490	struct ip_set_req_version {
	491	unsigned op;
	492	unsigned version;
	493	};
	494
a7b4f989	495	#endif /_IP_SET_H /