1b2441318SGreg Kroah-Hartman /* SPDX-License-Identifier: GPL-2.0 */
296518518SPatrick McHardy #ifndef _NET_NF_TABLES_H
396518518SPatrick McHardy #define _NET_NF_TABLES_H
496518518SPatrick McHardy 
5a1b840adSAnder Juaristi #include <asm/unaligned.h>
696518518SPatrick McHardy #include <linux/list.h>
796518518SPatrick McHardy #include <linux/netfilter.h>
867a8fc27SPatrick McHardy #include <linux/netfilter/nfnetlink.h>
90ca743a5SPablo Neira Ayuso #include <linux/netfilter/x_tables.h>
1096518518SPatrick McHardy #include <linux/netfilter/nf_tables.h>
11ce355e20SEric Dumazet #include <linux/u64_stats_sync.h>
121b2470e5SFlorian Westphal #include <linux/rhashtable.h>
133b49e2e9SPablo Neira Ayuso #include <net/netfilter/nf_flow_table.h>
1496518518SPatrick McHardy #include <net/netlink.h>
1514bfb13fSPablo Neira Ayuso #include <net/flow_offload.h>
16d59d2f82SPablo Neira Ayuso #include <net/netns/generic.h>
1796518518SPatrick McHardy 
18d25e2e93SPablo Neira Ayuso #define NFT_MAX_HOOKS	(NF_INET_INGRESS + 1)
19d25e2e93SPablo Neira Ayuso 
20a4cb98f3SPaul Gortmaker struct module;
21a4cb98f3SPaul Gortmaker 
2220a69341SPatrick McHardy #define NFT_JUMP_STACK_SIZE	16
2320a69341SPatrick McHardy 
24b5bdc6f9SPablo Neira Ayuso enum {
25b5bdc6f9SPablo Neira Ayuso 	NFT_PKTINFO_L4PROTO	= (1 << 0),
26c46b38dcSPablo Neira Ayuso 	NFT_PKTINFO_INNER	= (1 << 1),
27b5bdc6f9SPablo Neira Ayuso };
28b5bdc6f9SPablo Neira Ayuso 
2996518518SPatrick McHardy struct nft_pktinfo {
3096518518SPatrick McHardy 	struct sk_buff			*skb;
31897389deSFlorian Westphal 	const struct nf_hook_state	*state;
32b5bdc6f9SPablo Neira Ayuso 	u8				flags;
334566bf27SPatrick McHardy 	u8				tprot;
34897389deSFlorian Westphal 	u16				fragoff;
35897389deSFlorian Westphal 	unsigned int			thoff;
36c46b38dcSPablo Neira Ayuso 	unsigned int			inneroff;
3796518518SPatrick McHardy };
3896518518SPatrick McHardy 
3985554eb9SFlorian Westphal static inline struct sock *nft_sk(const struct nft_pktinfo *pkt)
4085554eb9SFlorian Westphal {
41897389deSFlorian Westphal 	return pkt->state->sk;
4285554eb9SFlorian Westphal }
4385554eb9SFlorian Westphal 
442d7b4aceSFlorian Westphal static inline unsigned int nft_thoff(const struct nft_pktinfo *pkt)
452d7b4aceSFlorian Westphal {
46897389deSFlorian Westphal 	return pkt->thoff;
472d7b4aceSFlorian Westphal }
482d7b4aceSFlorian Westphal 
490e5a1c7eSPablo Neira Ayuso static inline struct net *nft_net(const struct nft_pktinfo *pkt)
500e5a1c7eSPablo Neira Ayuso {
51897389deSFlorian Westphal 	return pkt->state->net;
520e5a1c7eSPablo Neira Ayuso }
530e5a1c7eSPablo Neira Ayuso 
540e5a1c7eSPablo Neira Ayuso static inline unsigned int nft_hook(const struct nft_pktinfo *pkt)
550e5a1c7eSPablo Neira Ayuso {
56897389deSFlorian Westphal 	return pkt->state->hook;
570e5a1c7eSPablo Neira Ayuso }
580e5a1c7eSPablo Neira Ayuso 
590e5a1c7eSPablo Neira Ayuso static inline u8 nft_pf(const struct nft_pktinfo *pkt)
600e5a1c7eSPablo Neira Ayuso {
61897389deSFlorian Westphal 	return pkt->state->pf;
620e5a1c7eSPablo Neira Ayuso }
630e5a1c7eSPablo Neira Ayuso 
640e5a1c7eSPablo Neira Ayuso static inline const struct net_device *nft_in(const struct nft_pktinfo *pkt)
650e5a1c7eSPablo Neira Ayuso {
66897389deSFlorian Westphal 	return pkt->state->in;
670e5a1c7eSPablo Neira Ayuso }
680e5a1c7eSPablo Neira Ayuso 
690e5a1c7eSPablo Neira Ayuso static inline const struct net_device *nft_out(const struct nft_pktinfo *pkt)
700e5a1c7eSPablo Neira Ayuso {
71897389deSFlorian Westphal 	return pkt->state->out;
720e5a1c7eSPablo Neira Ayuso }
730e5a1c7eSPablo Neira Ayuso 
740ca743a5SPablo Neira Ayuso static inline void nft_set_pktinfo(struct nft_pktinfo *pkt,
750ca743a5SPablo Neira Ayuso 				   struct sk_buff *skb,
76073bfd56SDavid S. Miller 				   const struct nf_hook_state *state)
770ca743a5SPablo Neira Ayuso {
780ca743a5SPablo Neira Ayuso 	pkt->skb = skb;
79897389deSFlorian Westphal 	pkt->state = state;
800ca743a5SPablo Neira Ayuso }
810ca743a5SPablo Neira Ayuso 
82f06ad944SFlorian Westphal static inline void nft_set_pktinfo_unspec(struct nft_pktinfo *pkt)
83beac5afaSPablo Neira Ayuso {
84b5bdc6f9SPablo Neira Ayuso 	pkt->flags = 0;
85beac5afaSPablo Neira Ayuso 	pkt->tprot = 0;
86897389deSFlorian Westphal 	pkt->thoff = 0;
87897389deSFlorian Westphal 	pkt->fragoff = 0;
88beac5afaSPablo Neira Ayuso }
89beac5afaSPablo Neira Ayuso 
90a55e22e9SPatrick McHardy /**
91a55e22e9SPatrick McHardy  * 	struct nft_verdict - nf_tables verdict
92a55e22e9SPatrick McHardy  *
93a55e22e9SPatrick McHardy  * 	@code: nf_tables/netfilter verdict code
94a55e22e9SPatrick McHardy  * 	@chain: destination chain for NFT_JUMP/NFT_GOTO
95a55e22e9SPatrick McHardy  */
96a55e22e9SPatrick McHardy struct nft_verdict {
97a55e22e9SPatrick McHardy 	u32				code;
98a55e22e9SPatrick McHardy 	struct nft_chain		*chain;
99a55e22e9SPatrick McHardy };
100a55e22e9SPatrick McHardy 
10196518518SPatrick McHardy struct nft_data {
10296518518SPatrick McHardy 	union {
10396518518SPatrick McHardy 		u32			data[4];
1041ca2e170SPatrick McHardy 		struct nft_verdict	verdict;
10596518518SPatrick McHardy 	};
10696518518SPatrick McHardy } __attribute__((aligned(__alignof__(u64))));
10796518518SPatrick McHardy 
108642c8effSPablo Neira Ayuso #define NFT_REG32_NUM		20
109642c8effSPablo Neira Ayuso 
110a55e22e9SPatrick McHardy /**
111a55e22e9SPatrick McHardy  *	struct nft_regs - nf_tables register set
112a55e22e9SPatrick McHardy  *
113a55e22e9SPatrick McHardy  *	@data: data registers
114a55e22e9SPatrick McHardy  *	@verdict: verdict register
115a55e22e9SPatrick McHardy  *
116a55e22e9SPatrick McHardy  *	The first four data registers alias to the verdict register.
117a55e22e9SPatrick McHardy  */
118a55e22e9SPatrick McHardy struct nft_regs {
119a55e22e9SPatrick McHardy 	union {
120642c8effSPablo Neira Ayuso 		u32			data[NFT_REG32_NUM];
121a55e22e9SPatrick McHardy 		struct nft_verdict	verdict;
122a55e22e9SPatrick McHardy 	};
123a55e22e9SPatrick McHardy };
124a55e22e9SPatrick McHardy 
12512e4ecfaSPablo Neira Ayuso struct nft_regs_track {
12612e4ecfaSPablo Neira Ayuso 	struct {
12712e4ecfaSPablo Neira Ayuso 		const struct nft_expr		*selector;
12812e4ecfaSPablo Neira Ayuso 		const struct nft_expr		*bitwise;
12912e4ecfaSPablo Neira Ayuso 	} regs[NFT_REG32_NUM];
13012e4ecfaSPablo Neira Ayuso 
13112e4ecfaSPablo Neira Ayuso 	const struct nft_expr			*cur;
13212e4ecfaSPablo Neira Ayuso 	const struct nft_expr			*last;
13312e4ecfaSPablo Neira Ayuso };
13412e4ecfaSPablo Neira Ayuso 
135a1b840adSAnder Juaristi /* Store/load an u8, u16 or u64 integer to/from the u32 data register.
13610596608SLiping Zhang  *
13710596608SLiping Zhang  * Note, when using concatenations, register allocation happens at 32-bit
13810596608SLiping Zhang  * level. So for store instruction, pad the rest part with zero to avoid
13910596608SLiping Zhang  * garbage values.
14010596608SLiping Zhang  */
14110596608SLiping Zhang 
14210596608SLiping Zhang static inline void nft_reg_store8(u32 *dreg, u8 val)
14310596608SLiping Zhang {
14410596608SLiping Zhang 	*dreg = 0;
14510596608SLiping Zhang 	*(u8 *)dreg = val;
14610596608SLiping Zhang }
14710596608SLiping Zhang 
1487cd9a58dSPablo Neira Ayuso static inline u8 nft_reg_load8(const u32 *sreg)
149a1b840adSAnder Juaristi {
150a1b840adSAnder Juaristi 	return *(u8 *)sreg;
151a1b840adSAnder Juaristi }
152a1b840adSAnder Juaristi 
153a1b840adSAnder Juaristi static inline void nft_reg_store16(u32 *dreg, u16 val)
154a1b840adSAnder Juaristi {
155a1b840adSAnder Juaristi 	*dreg = 0;
156a1b840adSAnder Juaristi 	*(u16 *)dreg = val;
157a1b840adSAnder Juaristi }
158a1b840adSAnder Juaristi 
1597cd9a58dSPablo Neira Ayuso static inline u16 nft_reg_load16(const u32 *sreg)
16010596608SLiping Zhang {
16110596608SLiping Zhang 	return *(u16 *)sreg;
16210596608SLiping Zhang }
16310596608SLiping Zhang 
164a1b840adSAnder Juaristi static inline void nft_reg_store64(u32 *dreg, u64 val)
16510596608SLiping Zhang {
166a1b840adSAnder Juaristi 	put_unaligned(val, (u64 *)dreg);
167a1b840adSAnder Juaristi }
168a1b840adSAnder Juaristi 
1697cd9a58dSPablo Neira Ayuso static inline u64 nft_reg_load64(const u32 *sreg)
170a1b840adSAnder Juaristi {
171a1b840adSAnder Juaristi 	return get_unaligned((u64 *)sreg);
17210596608SLiping Zhang }
17310596608SLiping Zhang 
17449499c3eSPatrick McHardy static inline void nft_data_copy(u32 *dst, const struct nft_data *src,
17549499c3eSPatrick McHardy 				 unsigned int len)
17696518518SPatrick McHardy {
1771e105e6aSFlorian Westphal 	if (len % NFT_REG32_SIZE)
1781e105e6aSFlorian Westphal 		dst[len / NFT_REG32_SIZE] = 0;
17949499c3eSPatrick McHardy 	memcpy(dst, src, len);
18096518518SPatrick McHardy }
18196518518SPatrick McHardy 
18296518518SPatrick McHardy /**
18320a69341SPatrick McHardy  *	struct nft_ctx - nf_tables rule/set context
18496518518SPatrick McHardy  *
18599633ab2SPablo Neira Ayuso  *	@net: net namespace
18696518518SPatrick McHardy  * 	@table: the table the chain is contained in
18796518518SPatrick McHardy  * 	@chain: the chain the rule is contained in
1880ca743a5SPablo Neira Ayuso  *	@nla: netlink attributes
189128ad332SPablo Neira Ayuso  *	@portid: netlink portID of the original message
190128ad332SPablo Neira Ayuso  *	@seq: netlink sequence number
19136596dadSPablo Neira Ayuso  *	@family: protocol family
19226b2f552STaehee Yoo  *	@level: depth of the chains
193128ad332SPablo Neira Ayuso  *	@report: notify via unicast netlink message
19496518518SPatrick McHardy  */
19596518518SPatrick McHardy struct nft_ctx {
19699633ab2SPablo Neira Ayuso 	struct net			*net;
1977c95f6d8SPablo Neira Ayuso 	struct nft_table		*table;
1987c95f6d8SPablo Neira Ayuso 	struct nft_chain		*chain;
1990ca743a5SPablo Neira Ayuso 	const struct nlattr * const 	*nla;
200128ad332SPablo Neira Ayuso 	u32				portid;
201128ad332SPablo Neira Ayuso 	u32				seq;
202c9626a2cSPablo Neira Ayuso 	u16				flags;
20336596dadSPablo Neira Ayuso 	u8				family;
20426b2f552STaehee Yoo 	u8				level;
205128ad332SPablo Neira Ayuso 	bool				report;
20696518518SPatrick McHardy };
20796518518SPatrick McHardy 
20896518518SPatrick McHardy struct nft_data_desc {
20996518518SPatrick McHardy 	enum nft_data_types		type;
21096518518SPatrick McHardy 	unsigned int			len;
21196518518SPatrick McHardy };
21296518518SPatrick McHardy 
213d0a11fc3SPatrick McHardy int nft_data_init(const struct nft_ctx *ctx,
214d0a11fc3SPatrick McHardy 		  struct nft_data *data, unsigned int size,
21596518518SPatrick McHardy 		  struct nft_data_desc *desc, const struct nlattr *nla);
216bb7b40aeSPablo Neira Ayuso void nft_data_hold(const struct nft_data *data, enum nft_data_types type);
21759105446SPablo Neira Ayuso void nft_data_release(const struct nft_data *data, enum nft_data_types type);
2185eccdfaaSJoe Perches int nft_data_dump(struct sk_buff *skb, int attr, const struct nft_data *data,
21996518518SPatrick McHardy 		  enum nft_data_types type, unsigned int len);
22096518518SPatrick McHardy 
22196518518SPatrick McHardy static inline enum nft_data_types nft_dreg_to_type(enum nft_registers reg)
22296518518SPatrick McHardy {
22396518518SPatrick McHardy 	return reg == NFT_REG_VERDICT ? NFT_DATA_VERDICT : NFT_DATA_VALUE;
22496518518SPatrick McHardy }
22596518518SPatrick McHardy 
22620a69341SPatrick McHardy static inline enum nft_registers nft_type_to_reg(enum nft_data_types type)
22720a69341SPatrick McHardy {
228bf798657SPablo Neira Ayuso 	return type == NFT_DATA_VERDICT ? NFT_REG_VERDICT : NFT_REG_1 * NFT_REG_SIZE / NFT_REG32_SIZE;
22920a69341SPatrick McHardy }
23020a69341SPatrick McHardy 
231f1d505bbSJohn W. Linville int nft_parse_u32_check(const struct nlattr *attr, int max, u32 *dest);
232b1c96ed3SPatrick McHardy int nft_dump_register(struct sk_buff *skb, unsigned int attr, unsigned int reg);
233b1c96ed3SPatrick McHardy 
2344f16d25cSPablo Neira Ayuso int nft_parse_register_load(const struct nlattr *attr, u8 *sreg, u32 len);
235345023b0SPablo Neira Ayuso int nft_parse_register_store(const struct nft_ctx *ctx,
236345023b0SPablo Neira Ayuso 			     const struct nlattr *attr, u8 *dreg,
23796518518SPatrick McHardy 			     const struct nft_data *data,
23845d9bcdaSPatrick McHardy 			     enum nft_data_types type, unsigned int len);
23996518518SPatrick McHardy 
24086f1ec32SPatrick McHardy /**
24186f1ec32SPatrick McHardy  *	struct nft_userdata - user defined data associated with an object
24286f1ec32SPatrick McHardy  *
24386f1ec32SPatrick McHardy  *	@len: length of the data
24486f1ec32SPatrick McHardy  *	@data: content
24586f1ec32SPatrick McHardy  *
24686f1ec32SPatrick McHardy  *	The presence of user data is indicated in an object specific fashion,
24786f1ec32SPatrick McHardy  *	so a length of zero can't occur and the value "len" indicates data
24886f1ec32SPatrick McHardy  *	of length len + 1.
24986f1ec32SPatrick McHardy  */
25086f1ec32SPatrick McHardy struct nft_userdata {
25186f1ec32SPatrick McHardy 	u8			len;
2526daf1414SGustavo A. R. Silva 	unsigned char		data[];
25386f1ec32SPatrick McHardy };
25486f1ec32SPatrick McHardy 
25596518518SPatrick McHardy /**
25620a69341SPatrick McHardy  *	struct nft_set_elem - generic representation of set elements
25720a69341SPatrick McHardy  *
25820a69341SPatrick McHardy  *	@key: element key
2597b225d0bSPablo Neira Ayuso  *	@key_end: closing element key
260fe2811ebSPatrick McHardy  *	@priv: element private data and extensions
26120a69341SPatrick McHardy  */
26220a69341SPatrick McHardy struct nft_set_elem {
2637d740264SPatrick McHardy 	union {
2647d740264SPatrick McHardy 		u32		buf[NFT_DATA_VALUE_MAXLEN / sizeof(u32)];
2657d740264SPatrick McHardy 		struct nft_data	val;
2667d740264SPatrick McHardy 	} key;
2677b225d0bSPablo Neira Ayuso 	union {
2687b225d0bSPablo Neira Ayuso 		u32		buf[NFT_DATA_VALUE_MAXLEN / sizeof(u32)];
2697b225d0bSPablo Neira Ayuso 		struct nft_data	val;
2707b225d0bSPablo Neira Ayuso 	} key_end;
271fdb9c405SPablo Neira Ayuso 	union {
272fdb9c405SPablo Neira Ayuso 		u32		buf[NFT_DATA_VALUE_MAXLEN / sizeof(u32)];
273fdb9c405SPablo Neira Ayuso 		struct nft_data val;
274fdb9c405SPablo Neira Ayuso 	} data;
275fe2811ebSPatrick McHardy 	void			*priv;
27620a69341SPatrick McHardy };
27720a69341SPatrick McHardy 
27820a69341SPatrick McHardy struct nft_set;
27920a69341SPatrick McHardy struct nft_set_iter {
2808588ac09SPablo Neira Ayuso 	u8		genmask;
28120a69341SPatrick McHardy 	unsigned int	count;
28220a69341SPatrick McHardy 	unsigned int	skip;
28320a69341SPatrick McHardy 	int		err;
28420a69341SPatrick McHardy 	int		(*fn)(const struct nft_ctx *ctx,
285de70185dSPablo Neira Ayuso 			      struct nft_set *set,
28620a69341SPatrick McHardy 			      const struct nft_set_iter *iter,
287de70185dSPablo Neira Ayuso 			      struct nft_set_elem *elem);
28820a69341SPatrick McHardy };
28920a69341SPatrick McHardy 
29020a69341SPatrick McHardy /**
291c50b960cSPatrick McHardy  *	struct nft_set_desc - description of set elements
292c50b960cSPatrick McHardy  *
293c50b960cSPatrick McHardy  *	@klen: key length
294c50b960cSPatrick McHardy  *	@dlen: data length
295c50b960cSPatrick McHardy  *	@size: number of set elements
296f3a2181eSStefano Brivio  *	@field_len: length of each field in concatenation, bytes
297f3a2181eSStefano Brivio  *	@field_count: number of concatenated fields in element
298d56aab26SPablo Neira Ayuso  *	@expr: set must support for expressions
299c50b960cSPatrick McHardy  */
300c50b960cSPatrick McHardy struct nft_set_desc {
301c50b960cSPatrick McHardy 	unsigned int		klen;
302c50b960cSPatrick McHardy 	unsigned int		dlen;
303c50b960cSPatrick McHardy 	unsigned int		size;
304f3a2181eSStefano Brivio 	u8			field_len[NFT_REG32_COUNT];
305f3a2181eSStefano Brivio 	u8			field_count;
306d56aab26SPablo Neira Ayuso 	bool			expr;
307c50b960cSPatrick McHardy };
308c50b960cSPatrick McHardy 
309c50b960cSPatrick McHardy /**
310c50b960cSPatrick McHardy  *	enum nft_set_class - performance class
311c50b960cSPatrick McHardy  *
312c50b960cSPatrick McHardy  *	@NFT_LOOKUP_O_1: constant, O(1)
313c50b960cSPatrick McHardy  *	@NFT_LOOKUP_O_LOG_N: logarithmic, O(log N)
314c50b960cSPatrick McHardy  *	@NFT_LOOKUP_O_N: linear, O(N)
315c50b960cSPatrick McHardy  */
316c50b960cSPatrick McHardy enum nft_set_class {
317c50b960cSPatrick McHardy 	NFT_SET_CLASS_O_1,
318c50b960cSPatrick McHardy 	NFT_SET_CLASS_O_LOG_N,
319c50b960cSPatrick McHardy 	NFT_SET_CLASS_O_N,
320c50b960cSPatrick McHardy };
321c50b960cSPatrick McHardy 
322c50b960cSPatrick McHardy /**
323c50b960cSPatrick McHardy  *	struct nft_set_estimate - estimation of memory and performance
324c50b960cSPatrick McHardy  *				  characteristics
325c50b960cSPatrick McHardy  *
326c50b960cSPatrick McHardy  *	@size: required memory
32755af753cSPablo Neira Ayuso  *	@lookup: lookup performance class
3280b5a7874SPablo Neira Ayuso  *	@space: memory class
329c50b960cSPatrick McHardy  */
330c50b960cSPatrick McHardy struct nft_set_estimate {
3314ef360ddSTaehee Yoo 	u64			size;
33255af753cSPablo Neira Ayuso 	enum nft_set_class	lookup;
3330b5a7874SPablo Neira Ayuso 	enum nft_set_class	space;
334c50b960cSPatrick McHardy };
335c50b960cSPatrick McHardy 
33692b211a2SPablo Neira Ayuso #define NFT_EXPR_MAXATTR		16
33792b211a2SPablo Neira Ayuso #define NFT_EXPR_SIZE(size)		(sizeof(struct nft_expr) + \
33892b211a2SPablo Neira Ayuso 					 ALIGN(size, __alignof__(struct nft_expr)))
33992b211a2SPablo Neira Ayuso 
34092b211a2SPablo Neira Ayuso /**
34192b211a2SPablo Neira Ayuso  *	struct nft_expr - nf_tables expression
34292b211a2SPablo Neira Ayuso  *
34392b211a2SPablo Neira Ayuso  *	@ops: expression ops
34492b211a2SPablo Neira Ayuso  *	@data: expression private data
34592b211a2SPablo Neira Ayuso  */
34692b211a2SPablo Neira Ayuso struct nft_expr {
34792b211a2SPablo Neira Ayuso 	const struct nft_expr_ops	*ops;
34892b211a2SPablo Neira Ayuso 	unsigned char			data[]
34992b211a2SPablo Neira Ayuso 		__attribute__((aligned(__alignof__(u64))));
35092b211a2SPablo Neira Ayuso };
35192b211a2SPablo Neira Ayuso 
35292b211a2SPablo Neira Ayuso static inline void *nft_expr_priv(const struct nft_expr *expr)
35392b211a2SPablo Neira Ayuso {
35492b211a2SPablo Neira Ayuso 	return (void *)expr->data;
35592b211a2SPablo Neira Ayuso }
35692b211a2SPablo Neira Ayuso 
35792b211a2SPablo Neira Ayuso int nft_expr_clone(struct nft_expr *dst, struct nft_expr *src);
35892b211a2SPablo Neira Ayuso void nft_expr_destroy(const struct nft_ctx *ctx, struct nft_expr *expr);
35992b211a2SPablo Neira Ayuso int nft_expr_dump(struct sk_buff *skb, unsigned int attr,
36092b211a2SPablo Neira Ayuso 		  const struct nft_expr *expr);
361be5650f8SPablo Neira Ayuso bool nft_expr_reduce_bitwise(struct nft_regs_track *track,
362be5650f8SPablo Neira Ayuso 			     const struct nft_expr *expr);
36392b211a2SPablo Neira Ayuso 
364b2832dd6SPatrick McHardy struct nft_set_ext;
365b2832dd6SPatrick McHardy 
366c50b960cSPatrick McHardy /**
36720a69341SPatrick McHardy  *	struct nft_set_ops - nf_tables set operations
36820a69341SPatrick McHardy  *
36920a69341SPatrick McHardy  *	@lookup: look up an element within the set
370d0a8d877SAnder Juaristi  *	@update: update an element if exists, add it if doesn't exist
371d0a8d877SAnder Juaristi  *	@delete: delete an element
37220a69341SPatrick McHardy  *	@insert: insert new element into set
373cc02e457SPatrick McHardy  *	@activate: activate new element in the next generation
3748411b644SPablo Neira Ayuso  *	@deactivate: lookup for element and deactivate it in the next generation
3751ba1c414SPablo Neira Ayuso  *	@flush: deactivate element in the next generation
37620a69341SPatrick McHardy  *	@remove: remove element from set
377d0a8d877SAnder Juaristi  *	@walk: iterate over all set elements
378ba0e4d99SPablo Neira Ayuso  *	@get: get set elements
37920a69341SPatrick McHardy  *	@privsize: function to return size of set private data
38020a69341SPatrick McHardy  *	@init: initialize private data of new set instance
38120a69341SPatrick McHardy  *	@destroy: destroy private data of set instance
382fe2811ebSPatrick McHardy  *	@elemsize: element private size
383d0a8d877SAnder Juaristi  *
384d0a8d877SAnder Juaristi  *	Operations lookup, update and delete have simpler interfaces, are faster
385d0a8d877SAnder Juaristi  *	and currently only used in the packet path. All the rest are slower,
386d0a8d877SAnder Juaristi  *	control plane functions.
38720a69341SPatrick McHardy  */
38820a69341SPatrick McHardy struct nft_set_ops {
38942a55769SPablo Neira Ayuso 	bool				(*lookup)(const struct net *net,
39042a55769SPablo Neira Ayuso 						  const struct nft_set *set,
3918cd8937aSPatrick McHardy 						  const u32 *key,
392b2832dd6SPatrick McHardy 						  const struct nft_set_ext **ext);
39322fe54d5SPatrick McHardy 	bool				(*update)(struct nft_set *set,
3948cd8937aSPatrick McHardy 						  const u32 *key,
39522fe54d5SPatrick McHardy 						  void *(*new)(struct nft_set *,
39622fe54d5SPatrick McHardy 							       const struct nft_expr *,
397a55e22e9SPatrick McHardy 							       struct nft_regs *),
39822fe54d5SPatrick McHardy 						  const struct nft_expr *expr,
399a55e22e9SPatrick McHardy 						  struct nft_regs *regs,
40022fe54d5SPatrick McHardy 						  const struct nft_set_ext **ext);
401d0a8d877SAnder Juaristi 	bool				(*delete)(const struct nft_set *set,
402d0a8d877SAnder Juaristi 						  const u32 *key);
40322fe54d5SPatrick McHardy 
40442a55769SPablo Neira Ayuso 	int				(*insert)(const struct net *net,
40542a55769SPablo Neira Ayuso 						  const struct nft_set *set,
406c016c7e4SPablo Neira Ayuso 						  const struct nft_set_elem *elem,
407c016c7e4SPablo Neira Ayuso 						  struct nft_set_ext **ext);
40842a55769SPablo Neira Ayuso 	void				(*activate)(const struct net *net,
40942a55769SPablo Neira Ayuso 						    const struct nft_set *set,
410cc02e457SPatrick McHardy 						    const struct nft_set_elem *elem);
41142a55769SPablo Neira Ayuso 	void *				(*deactivate)(const struct net *net,
41242a55769SPablo Neira Ayuso 						      const struct nft_set *set,
413cc02e457SPatrick McHardy 						      const struct nft_set_elem *elem);
4141ba1c414SPablo Neira Ayuso 	bool				(*flush)(const struct net *net,
4158411b644SPablo Neira Ayuso 						 const struct nft_set *set,
4168411b644SPablo Neira Ayuso 						 void *priv);
4175cb82a38SPablo Neira Ayuso 	void				(*remove)(const struct net *net,
4185cb82a38SPablo Neira Ayuso 						  const struct nft_set *set,
41920a69341SPatrick McHardy 						  const struct nft_set_elem *elem);
42020a69341SPatrick McHardy 	void				(*walk)(const struct nft_ctx *ctx,
421de70185dSPablo Neira Ayuso 						struct nft_set *set,
42220a69341SPatrick McHardy 						struct nft_set_iter *iter);
423ba0e4d99SPablo Neira Ayuso 	void *				(*get)(const struct net *net,
424ba0e4d99SPablo Neira Ayuso 					       const struct nft_set *set,
425ba0e4d99SPablo Neira Ayuso 					       const struct nft_set_elem *elem,
426ba0e4d99SPablo Neira Ayuso 					       unsigned int flags);
42720a69341SPatrick McHardy 
4284ef360ddSTaehee Yoo 	u64				(*privsize)(const struct nlattr * const nla[],
429347b408dSPablo Neira Ayuso 						    const struct nft_set_desc *desc);
430c50b960cSPatrick McHardy 	bool				(*estimate)(const struct nft_set_desc *desc,
431c50b960cSPatrick McHardy 						    u32 features,
432c50b960cSPatrick McHardy 						    struct nft_set_estimate *est);
43320a69341SPatrick McHardy 	int				(*init)(const struct nft_set *set,
434c50b960cSPatrick McHardy 						const struct nft_set_desc *desc,
43520a69341SPatrick McHardy 						const struct nlattr * const nla[]);
43620a69341SPatrick McHardy 	void				(*destroy)(const struct nft_set *set);
43779b174adSPablo Neira Ayuso 	void				(*gc_init)(const struct nft_set *set);
43820a69341SPatrick McHardy 
439fe2811ebSPatrick McHardy 	unsigned int			elemsize;
44020a69341SPatrick McHardy };
44120a69341SPatrick McHardy 
44271cc0873SPhil Sutter /**
44371cc0873SPhil Sutter  *      struct nft_set_type - nf_tables set type
44471cc0873SPhil Sutter  *
44571cc0873SPhil Sutter  *      @ops: set ops for this type
44671cc0873SPhil Sutter  *      @features: features supported by the implementation
44771cc0873SPhil Sutter  */
44871cc0873SPhil Sutter struct nft_set_type {
44971cc0873SPhil Sutter 	const struct nft_set_ops	ops;
45071cc0873SPhil Sutter 	u32				features;
45171cc0873SPhil Sutter };
45271cc0873SPhil Sutter #define to_set_type(o) container_of(o, struct nft_set_type, ops)
45371cc0873SPhil Sutter 
454563125a7SPablo Neira Ayuso struct nft_set_elem_expr {
455563125a7SPablo Neira Ayuso 	u8				size;
456563125a7SPablo Neira Ayuso 	unsigned char			data[]
457563125a7SPablo Neira Ayuso 		__attribute__((aligned(__alignof__(struct nft_expr))));
458563125a7SPablo Neira Ayuso };
459563125a7SPablo Neira Ayuso 
460563125a7SPablo Neira Ayuso #define nft_setelem_expr_at(__elem_expr, __offset)			\
461563125a7SPablo Neira Ayuso 	((struct nft_expr *)&__elem_expr->data[__offset])
462563125a7SPablo Neira Ayuso 
463563125a7SPablo Neira Ayuso #define nft_setelem_expr_foreach(__expr, __elem_expr, __size)		\
464563125a7SPablo Neira Ayuso 	for (__expr = nft_setelem_expr_at(__elem_expr, 0), __size = 0;	\
465563125a7SPablo Neira Ayuso 	     __size < (__elem_expr)->size;				\
466563125a7SPablo Neira Ayuso 	     __size += (__expr)->ops->size, __expr = ((void *)(__expr)) + (__expr)->ops->size)
467563125a7SPablo Neira Ayuso 
4688cfd9b0fSPablo Neira Ayuso #define NFT_SET_EXPR_MAX	2
4698cfd9b0fSPablo Neira Ayuso 
47020a69341SPatrick McHardy /**
47120a69341SPatrick McHardy  * 	struct nft_set - nf_tables set instance
47220a69341SPatrick McHardy  *
47320a69341SPatrick McHardy  *	@list: table set list node
47420a69341SPatrick McHardy  *	@bindings: list of set bindings
4753453c927SPablo Neira Ayuso  *	@table: table this set belongs to
4763453c927SPablo Neira Ayuso  *	@net: netnamespace this set belongs to
47720a69341SPatrick McHardy  * 	@name: name of the set
4783ecbfd65SHarsha Sharma  *	@handle: unique handle of the set
47920a69341SPatrick McHardy  * 	@ktype: key type (numeric type defined by userspace, not used in the kernel)
48020a69341SPatrick McHardy  * 	@dtype: data type (verdict or numeric type defined by userspace)
4818aeff920SPablo Neira Ayuso  * 	@objtype: object type (see NFT_OBJECT_* definitions)
482c50b960cSPatrick McHardy  * 	@size: maximum set size
483f3a2181eSStefano Brivio  *	@field_len: length of each field in concatenation, bytes
484f3a2181eSStefano Brivio  *	@field_count: number of concatenated fields in element
485273fe3f1SPablo Neira Ayuso  *	@use: number of rules references to this set
486c50b960cSPatrick McHardy  * 	@nelems: number of elements
4873dd0673aSPatrick McHardy  * 	@ndeact: number of deactivated elements queued for removal
488d3e2a111SAnders K. Pedersen  *	@timeout: default timeout value in jiffies
489761da293SPatrick McHardy  * 	@gc_int: garbage collection interval in msecs
4909363dc4bSArturo Borrero  *	@policy: set parameterization (see enum nft_set_policies)
491e6d8ecacSCarlos Falgueras García  *	@udlen: user data length
492e6d8ecacSCarlos Falgueras García  *	@udata: user data
49365038428SPablo Neira Ayuso  *	@expr: stateful expression
49420a69341SPatrick McHardy  * 	@ops: set ops
49520a69341SPatrick McHardy  * 	@flags: set flags
49637a9cc52SPablo Neira Ayuso  *	@genmask: generation mask
49720a69341SPatrick McHardy  * 	@klen: key length
49820a69341SPatrick McHardy  * 	@dlen: data length
49920a69341SPatrick McHardy  * 	@data: private set data
50020a69341SPatrick McHardy  */
50120a69341SPatrick McHardy struct nft_set {
50220a69341SPatrick McHardy 	struct list_head		list;
50320a69341SPatrick McHardy 	struct list_head		bindings;
5043453c927SPablo Neira Ayuso 	struct nft_table		*table;
5053453c927SPablo Neira Ayuso 	possible_net_t			net;
50638745490SPhil Sutter 	char				*name;
5073ecbfd65SHarsha Sharma 	u64				handle;
50820a69341SPatrick McHardy 	u32				ktype;
50920a69341SPatrick McHardy 	u32				dtype;
5108aeff920SPablo Neira Ayuso 	u32				objtype;
511c50b960cSPatrick McHardy 	u32				size;
512f3a2181eSStefano Brivio 	u8				field_len[NFT_REG32_COUNT];
513f3a2181eSStefano Brivio 	u8				field_count;
514273fe3f1SPablo Neira Ayuso 	u32				use;
5153dd0673aSPatrick McHardy 	atomic_t			nelems;
5163dd0673aSPatrick McHardy 	u32				ndeact;
517761da293SPatrick McHardy 	u64				timeout;
518761da293SPatrick McHardy 	u32				gc_int;
5199363dc4bSArturo Borrero 	u16				policy;
520e6d8ecacSCarlos Falgueras García 	u16				udlen;
521e6d8ecacSCarlos Falgueras García 	unsigned char			*udata;
52220a69341SPatrick McHardy 	/* runtime data below here */
52320a69341SPatrick McHardy 	const struct nft_set_ops	*ops ____cacheline_aligned;
5246a0a8d10SPablo Neira Ayuso 	u16				flags:14,
52537a9cc52SPablo Neira Ayuso 					genmask:2;
52620a69341SPatrick McHardy 	u8				klen;
52720a69341SPatrick McHardy 	u8				dlen;
5288cfd9b0fSPablo Neira Ayuso 	u8				num_exprs;
5298cfd9b0fSPablo Neira Ayuso 	struct nft_expr			*exprs[NFT_SET_EXPR_MAX];
530aaa31047SPablo Neira Ayuso 	struct list_head		catchall_list;
53120a69341SPatrick McHardy 	unsigned char			data[]
53220a69341SPatrick McHardy 		__attribute__((aligned(__alignof__(u64))));
53320a69341SPatrick McHardy };
53420a69341SPatrick McHardy 
535408070d6SPablo Neira Ayuso static inline bool nft_set_is_anonymous(const struct nft_set *set)
536408070d6SPablo Neira Ayuso {
537408070d6SPablo Neira Ayuso 	return set->flags & NFT_SET_ANONYMOUS;
538408070d6SPablo Neira Ayuso }
539408070d6SPablo Neira Ayuso 
54020a69341SPatrick McHardy static inline void *nft_set_priv(const struct nft_set *set)
54120a69341SPatrick McHardy {
54220a69341SPatrick McHardy 	return (void *)set->data;
54320a69341SPatrick McHardy }
54420a69341SPatrick McHardy 
5459d098292SPatrick McHardy static inline struct nft_set *nft_set_container_of(const void *priv)
5469d098292SPatrick McHardy {
5479d098292SPatrick McHardy 	return (void *)priv - offsetof(struct nft_set, data);
5489d098292SPatrick McHardy }
5499d098292SPatrick McHardy 
55010659cbaSPablo Neira Ayuso struct nft_set *nft_set_lookup_global(const struct net *net,
551c7a72e3fSPablo Neira Ayuso 				      const struct nft_table *table,
552c7a72e3fSPablo Neira Ayuso 				      const struct nlattr *nla_set_name,
553c7a72e3fSPablo Neira Ayuso 				      const struct nlattr *nla_set_id,
554c7a72e3fSPablo Neira Ayuso 				      u8 genmask);
55520a69341SPatrick McHardy 
556aaa31047SPablo Neira Ayuso struct nft_set_ext *nft_set_catchall_lookup(const struct net *net,
557aaa31047SPablo Neira Ayuso 					    const struct nft_set *set);
558aaa31047SPablo Neira Ayuso void *nft_set_catchall_gc(const struct nft_set *set);
559aaa31047SPablo Neira Ayuso 
560761da293SPatrick McHardy static inline unsigned long nft_set_gc_interval(const struct nft_set *set)
561761da293SPatrick McHardy {
562761da293SPatrick McHardy 	return set->gc_int ? msecs_to_jiffies(set->gc_int) : HZ;
563761da293SPatrick McHardy }
564761da293SPatrick McHardy 
56520a69341SPatrick McHardy /**
56620a69341SPatrick McHardy  *	struct nft_set_binding - nf_tables set binding
56720a69341SPatrick McHardy  *
56820a69341SPatrick McHardy  *	@list: set bindings list node
56920a69341SPatrick McHardy  *	@chain: chain containing the rule bound to the set
57011113e19SPatrick McHardy  *	@flags: set action flags
57120a69341SPatrick McHardy  *
57220a69341SPatrick McHardy  *	A set binding contains all information necessary for validation
57320a69341SPatrick McHardy  *	of new elements added to a bound set.
57420a69341SPatrick McHardy  */
57520a69341SPatrick McHardy struct nft_set_binding {
57620a69341SPatrick McHardy 	struct list_head		list;
57720a69341SPatrick McHardy 	const struct nft_chain		*chain;
57811113e19SPatrick McHardy 	u32				flags;
57920a69341SPatrick McHardy };
58020a69341SPatrick McHardy 
581273fe3f1SPablo Neira Ayuso enum nft_trans_phase;
582273fe3f1SPablo Neira Ayuso void nf_tables_deactivate_set(const struct nft_ctx *ctx, struct nft_set *set,
583273fe3f1SPablo Neira Ayuso 			      struct nft_set_binding *binding,
584273fe3f1SPablo Neira Ayuso 			      enum nft_trans_phase phase);
5855eccdfaaSJoe Perches int nf_tables_bind_set(const struct nft_ctx *ctx, struct nft_set *set,
58620a69341SPatrick McHardy 		       struct nft_set_binding *binding);
587cd5125d8SFlorian Westphal void nf_tables_destroy_set(const struct nft_ctx *ctx, struct nft_set *set);
58820a69341SPatrick McHardy 
5893ac4c07aSPatrick McHardy /**
5903ac4c07aSPatrick McHardy  *	enum nft_set_extensions - set extension type IDs
5913ac4c07aSPatrick McHardy  *
5923ac4c07aSPatrick McHardy  *	@NFT_SET_EXT_KEY: element key
5937b225d0bSPablo Neira Ayuso  *	@NFT_SET_EXT_KEY_END: upper bound element key, for ranges
5943ac4c07aSPatrick McHardy  *	@NFT_SET_EXT_DATA: mapping data
5953ac4c07aSPatrick McHardy  *	@NFT_SET_EXT_FLAGS: element flags
596c3e1b005SPatrick McHardy  *	@NFT_SET_EXT_TIMEOUT: element timeout
597c3e1b005SPatrick McHardy  *	@NFT_SET_EXT_EXPIRATION: element expiration time
59868e942e8SPatrick McHardy  *	@NFT_SET_EXT_USERDATA: user data associated with the element
599563125a7SPablo Neira Ayuso  *	@NFT_SET_EXT_EXPRESSIONS: expressions assiciated with the element
6008aeff920SPablo Neira Ayuso  *	@NFT_SET_EXT_OBJREF: stateful object reference associated with element
6013ac4c07aSPatrick McHardy  *	@NFT_SET_EXT_NUM: number of extension types
6023ac4c07aSPatrick McHardy  */
6033ac4c07aSPatrick McHardy enum nft_set_extensions {
6043ac4c07aSPatrick McHardy 	NFT_SET_EXT_KEY,
6057b225d0bSPablo Neira Ayuso 	NFT_SET_EXT_KEY_END,
6063ac4c07aSPatrick McHardy 	NFT_SET_EXT_DATA,
6073ac4c07aSPatrick McHardy 	NFT_SET_EXT_FLAGS,
608c3e1b005SPatrick McHardy 	NFT_SET_EXT_TIMEOUT,
609c3e1b005SPatrick McHardy 	NFT_SET_EXT_EXPIRATION,
61068e942e8SPatrick McHardy 	NFT_SET_EXT_USERDATA,
611563125a7SPablo Neira Ayuso 	NFT_SET_EXT_EXPRESSIONS,
6128aeff920SPablo Neira Ayuso 	NFT_SET_EXT_OBJREF,
6133ac4c07aSPatrick McHardy 	NFT_SET_EXT_NUM
6143ac4c07aSPatrick McHardy };
6153ac4c07aSPatrick McHardy 
6163ac4c07aSPatrick McHardy /**
6173ac4c07aSPatrick McHardy  *	struct nft_set_ext_type - set extension type
6183ac4c07aSPatrick McHardy  *
6193ac4c07aSPatrick McHardy  * 	@len: fixed part length of the extension
6203ac4c07aSPatrick McHardy  * 	@align: alignment requirements of the extension
6213ac4c07aSPatrick McHardy  */
6223ac4c07aSPatrick McHardy struct nft_set_ext_type {
6233ac4c07aSPatrick McHardy 	u8	len;
6243ac4c07aSPatrick McHardy 	u8	align;
6253ac4c07aSPatrick McHardy };
6263ac4c07aSPatrick McHardy 
6273ac4c07aSPatrick McHardy extern const struct nft_set_ext_type nft_set_ext_types[];
6283ac4c07aSPatrick McHardy 
6293ac4c07aSPatrick McHardy /**
6303ac4c07aSPatrick McHardy  *	struct nft_set_ext_tmpl - set extension template
6313ac4c07aSPatrick McHardy  *
6323ac4c07aSPatrick McHardy  *	@len: length of extension area
6333ac4c07aSPatrick McHardy  *	@offset: offsets of individual extension types
6343ac4c07aSPatrick McHardy  */
6353ac4c07aSPatrick McHardy struct nft_set_ext_tmpl {
6363ac4c07aSPatrick McHardy 	u16	len;
6373ac4c07aSPatrick McHardy 	u8	offset[NFT_SET_EXT_NUM];
6383ac4c07aSPatrick McHardy };
6393ac4c07aSPatrick McHardy 
6403ac4c07aSPatrick McHardy /**
6413ac4c07aSPatrick McHardy  *	struct nft_set_ext - set extensions
6423ac4c07aSPatrick McHardy  *
643cc02e457SPatrick McHardy  *	@genmask: generation mask
6443ac4c07aSPatrick McHardy  *	@offset: offsets of individual extension types
6453ac4c07aSPatrick McHardy  *	@data: beginning of extension data
6463ac4c07aSPatrick McHardy  */
6473ac4c07aSPatrick McHardy struct nft_set_ext {
648cc02e457SPatrick McHardy 	u8	genmask;
6493ac4c07aSPatrick McHardy 	u8	offset[NFT_SET_EXT_NUM];
6506daf1414SGustavo A. R. Silva 	char	data[];
6513ac4c07aSPatrick McHardy };
6523ac4c07aSPatrick McHardy 
6533ac4c07aSPatrick McHardy static inline void nft_set_ext_prepare(struct nft_set_ext_tmpl *tmpl)
6543ac4c07aSPatrick McHardy {
6553ac4c07aSPatrick McHardy 	memset(tmpl, 0, sizeof(*tmpl));
6563ac4c07aSPatrick McHardy 	tmpl->len = sizeof(struct nft_set_ext);
6573ac4c07aSPatrick McHardy }
6583ac4c07aSPatrick McHardy 
6593ac4c07aSPatrick McHardy static inline void nft_set_ext_add_length(struct nft_set_ext_tmpl *tmpl, u8 id,
6603ac4c07aSPatrick McHardy 					  unsigned int len)
6613ac4c07aSPatrick McHardy {
6623ac4c07aSPatrick McHardy 	tmpl->len	 = ALIGN(tmpl->len, nft_set_ext_types[id].align);
6633ac4c07aSPatrick McHardy 	BUG_ON(tmpl->len > U8_MAX);
6643ac4c07aSPatrick McHardy 	tmpl->offset[id] = tmpl->len;
6653ac4c07aSPatrick McHardy 	tmpl->len	+= nft_set_ext_types[id].len + len;
6663ac4c07aSPatrick McHardy }
6673ac4c07aSPatrick McHardy 
6683ac4c07aSPatrick McHardy static inline void nft_set_ext_add(struct nft_set_ext_tmpl *tmpl, u8 id)
6693ac4c07aSPatrick McHardy {
6703ac4c07aSPatrick McHardy 	nft_set_ext_add_length(tmpl, id, 0);
6713ac4c07aSPatrick McHardy }
6723ac4c07aSPatrick McHardy 
6733ac4c07aSPatrick McHardy static inline void nft_set_ext_init(struct nft_set_ext *ext,
6743ac4c07aSPatrick McHardy 				    const struct nft_set_ext_tmpl *tmpl)
6753ac4c07aSPatrick McHardy {
6763ac4c07aSPatrick McHardy 	memcpy(ext->offset, tmpl->offset, sizeof(ext->offset));
6773ac4c07aSPatrick McHardy }
6783ac4c07aSPatrick McHardy 
6793ac4c07aSPatrick McHardy static inline bool __nft_set_ext_exists(const struct nft_set_ext *ext, u8 id)
6803ac4c07aSPatrick McHardy {
6813ac4c07aSPatrick McHardy 	return !!ext->offset[id];
6823ac4c07aSPatrick McHardy }
6833ac4c07aSPatrick McHardy 
6843ac4c07aSPatrick McHardy static inline bool nft_set_ext_exists(const struct nft_set_ext *ext, u8 id)
6853ac4c07aSPatrick McHardy {
6863ac4c07aSPatrick McHardy 	return ext && __nft_set_ext_exists(ext, id);
6873ac4c07aSPatrick McHardy }
6883ac4c07aSPatrick McHardy 
6893ac4c07aSPatrick McHardy static inline void *nft_set_ext(const struct nft_set_ext *ext, u8 id)
6903ac4c07aSPatrick McHardy {
6913ac4c07aSPatrick McHardy 	return (void *)ext + ext->offset[id];
6923ac4c07aSPatrick McHardy }
6933ac4c07aSPatrick McHardy 
6943ac4c07aSPatrick McHardy static inline struct nft_data *nft_set_ext_key(const struct nft_set_ext *ext)
6953ac4c07aSPatrick McHardy {
6963ac4c07aSPatrick McHardy 	return nft_set_ext(ext, NFT_SET_EXT_KEY);
6973ac4c07aSPatrick McHardy }
6983ac4c07aSPatrick McHardy 
6997b225d0bSPablo Neira Ayuso static inline struct nft_data *nft_set_ext_key_end(const struct nft_set_ext *ext)
7007b225d0bSPablo Neira Ayuso {
7017b225d0bSPablo Neira Ayuso 	return nft_set_ext(ext, NFT_SET_EXT_KEY_END);
7027b225d0bSPablo Neira Ayuso }
7037b225d0bSPablo Neira Ayuso 
7043ac4c07aSPatrick McHardy static inline struct nft_data *nft_set_ext_data(const struct nft_set_ext *ext)
7053ac4c07aSPatrick McHardy {
7063ac4c07aSPatrick McHardy 	return nft_set_ext(ext, NFT_SET_EXT_DATA);
7073ac4c07aSPatrick McHardy }
7083ac4c07aSPatrick McHardy 
7093ac4c07aSPatrick McHardy static inline u8 *nft_set_ext_flags(const struct nft_set_ext *ext)
7103ac4c07aSPatrick McHardy {
7113ac4c07aSPatrick McHardy 	return nft_set_ext(ext, NFT_SET_EXT_FLAGS);
7123ac4c07aSPatrick McHardy }
713ef1f7df9SPatrick McHardy 
714c3e1b005SPatrick McHardy static inline u64 *nft_set_ext_timeout(const struct nft_set_ext *ext)
715c3e1b005SPatrick McHardy {
716c3e1b005SPatrick McHardy 	return nft_set_ext(ext, NFT_SET_EXT_TIMEOUT);
717c3e1b005SPatrick McHardy }
718c3e1b005SPatrick McHardy 
7198e1102d5SFlorian Westphal static inline u64 *nft_set_ext_expiration(const struct nft_set_ext *ext)
720c3e1b005SPatrick McHardy {
721c3e1b005SPatrick McHardy 	return nft_set_ext(ext, NFT_SET_EXT_EXPIRATION);
722c3e1b005SPatrick McHardy }
723c3e1b005SPatrick McHardy 
72468e942e8SPatrick McHardy static inline struct nft_userdata *nft_set_ext_userdata(const struct nft_set_ext *ext)
72568e942e8SPatrick McHardy {
72668e942e8SPatrick McHardy 	return nft_set_ext(ext, NFT_SET_EXT_USERDATA);
72768e942e8SPatrick McHardy }
72868e942e8SPatrick McHardy 
729563125a7SPablo Neira Ayuso static inline struct nft_set_elem_expr *nft_set_ext_expr(const struct nft_set_ext *ext)
730f25ad2e9SPatrick McHardy {
731563125a7SPablo Neira Ayuso 	return nft_set_ext(ext, NFT_SET_EXT_EXPRESSIONS);
732f25ad2e9SPatrick McHardy }
733f25ad2e9SPatrick McHardy 
734c3e1b005SPatrick McHardy static inline bool nft_set_elem_expired(const struct nft_set_ext *ext)
735c3e1b005SPatrick McHardy {
736c3e1b005SPatrick McHardy 	return nft_set_ext_exists(ext, NFT_SET_EXT_EXPIRATION) &&
7378e1102d5SFlorian Westphal 	       time_is_before_eq_jiffies64(*nft_set_ext_expiration(ext));
738c3e1b005SPatrick McHardy }
739c3e1b005SPatrick McHardy 
740fe2811ebSPatrick McHardy static inline struct nft_set_ext *nft_set_elem_ext(const struct nft_set *set,
741fe2811ebSPatrick McHardy 						   void *elem)
742fe2811ebSPatrick McHardy {
743fe2811ebSPatrick McHardy 	return elem + set->ops->elemsize;
744fe2811ebSPatrick McHardy }
745fe2811ebSPatrick McHardy 
7468aeff920SPablo Neira Ayuso static inline struct nft_object **nft_set_ext_obj(const struct nft_set_ext *ext)
7478aeff920SPablo Neira Ayuso {
7488aeff920SPablo Neira Ayuso 	return nft_set_ext(ext, NFT_SET_EXT_OBJREF);
7498aeff920SPablo Neira Ayuso }
7508aeff920SPablo Neira Ayuso 
751a7fc9368SPablo Neira Ayuso struct nft_expr *nft_set_elem_expr_alloc(const struct nft_ctx *ctx,
752a7fc9368SPablo Neira Ayuso 					 const struct nft_set *set,
753a7fc9368SPablo Neira Ayuso 					 const struct nlattr *attr);
754a7fc9368SPablo Neira Ayuso 
75522fe54d5SPatrick McHardy void *nft_set_elem_init(const struct nft_set *set,
75622fe54d5SPatrick McHardy 			const struct nft_set_ext_tmpl *tmpl,
7577b225d0bSPablo Neira Ayuso 			const u32 *key, const u32 *key_end, const u32 *data,
75879ebb5bbSLaura Garcia Liebana 			u64 timeout, u64 expiration, gfp_t gfp);
759fca05d4dSPablo Neira Ayuso int nft_set_elem_expr_clone(const struct nft_ctx *ctx, struct nft_set *set,
760fca05d4dSPablo Neira Ayuso 			    struct nft_expr *expr_array[]);
76161f9e292SLiping Zhang void nft_set_elem_destroy(const struct nft_set *set, void *elem,
76261f9e292SLiping Zhang 			  bool destroy_expr);
76361edafbbSPatrick McHardy 
76420a69341SPatrick McHardy /**
765cfed7e1bSPatrick McHardy  *	struct nft_set_gc_batch_head - nf_tables set garbage collection batch
766cfed7e1bSPatrick McHardy  *
767cfed7e1bSPatrick McHardy  *	@rcu: rcu head
768cfed7e1bSPatrick McHardy  *	@set: set the elements belong to
769cfed7e1bSPatrick McHardy  *	@cnt: count of elements
770cfed7e1bSPatrick McHardy  */
771cfed7e1bSPatrick McHardy struct nft_set_gc_batch_head {
772cfed7e1bSPatrick McHardy 	struct rcu_head			rcu;
773cfed7e1bSPatrick McHardy 	const struct nft_set		*set;
774cfed7e1bSPatrick McHardy 	unsigned int			cnt;
775cfed7e1bSPatrick McHardy };
776cfed7e1bSPatrick McHardy 
777cfed7e1bSPatrick McHardy #define NFT_SET_GC_BATCH_SIZE	((PAGE_SIZE -				  \
778cfed7e1bSPatrick McHardy 				  sizeof(struct nft_set_gc_batch_head)) / \
779cfed7e1bSPatrick McHardy 				 sizeof(void *))
780cfed7e1bSPatrick McHardy 
781cfed7e1bSPatrick McHardy /**
782cfed7e1bSPatrick McHardy  *	struct nft_set_gc_batch - nf_tables set garbage collection batch
783cfed7e1bSPatrick McHardy  *
784cfed7e1bSPatrick McHardy  * 	@head: GC batch head
785cfed7e1bSPatrick McHardy  * 	@elems: garbage collection elements
786cfed7e1bSPatrick McHardy  */
787cfed7e1bSPatrick McHardy struct nft_set_gc_batch {
788cfed7e1bSPatrick McHardy 	struct nft_set_gc_batch_head	head;
789cfed7e1bSPatrick McHardy 	void				*elems[NFT_SET_GC_BATCH_SIZE];
790cfed7e1bSPatrick McHardy };
791cfed7e1bSPatrick McHardy 
792cfed7e1bSPatrick McHardy struct nft_set_gc_batch *nft_set_gc_batch_alloc(const struct nft_set *set,
793cfed7e1bSPatrick McHardy 						gfp_t gfp);
794cfed7e1bSPatrick McHardy void nft_set_gc_batch_release(struct rcu_head *rcu);
795cfed7e1bSPatrick McHardy 
796cfed7e1bSPatrick McHardy static inline void nft_set_gc_batch_complete(struct nft_set_gc_batch *gcb)
797cfed7e1bSPatrick McHardy {
798cfed7e1bSPatrick McHardy 	if (gcb != NULL)
799cfed7e1bSPatrick McHardy 		call_rcu(&gcb->head.rcu, nft_set_gc_batch_release);
800cfed7e1bSPatrick McHardy }
801cfed7e1bSPatrick McHardy 
802cfed7e1bSPatrick McHardy static inline struct nft_set_gc_batch *
803cfed7e1bSPatrick McHardy nft_set_gc_batch_check(const struct nft_set *set, struct nft_set_gc_batch *gcb,
804cfed7e1bSPatrick McHardy 		       gfp_t gfp)
805cfed7e1bSPatrick McHardy {
806cfed7e1bSPatrick McHardy 	if (gcb != NULL) {
807cfed7e1bSPatrick McHardy 		if (gcb->head.cnt + 1 < ARRAY_SIZE(gcb->elems))
808cfed7e1bSPatrick McHardy 			return gcb;
809cfed7e1bSPatrick McHardy 		nft_set_gc_batch_complete(gcb);
810cfed7e1bSPatrick McHardy 	}
811cfed7e1bSPatrick McHardy 	return nft_set_gc_batch_alloc(set, gfp);
812cfed7e1bSPatrick McHardy }
813cfed7e1bSPatrick McHardy 
814cfed7e1bSPatrick McHardy static inline void nft_set_gc_batch_add(struct nft_set_gc_batch *gcb,
815cfed7e1bSPatrick McHardy 					void *elem)
816cfed7e1bSPatrick McHardy {
817cfed7e1bSPatrick McHardy 	gcb->elems[gcb->head.cnt++] = elem;
818cfed7e1bSPatrick McHardy }
819cfed7e1bSPatrick McHardy 
820b8e20400SPablo Neira Ayuso struct nft_expr_ops;
821cfed7e1bSPatrick McHardy /**
822ef1f7df9SPatrick McHardy  *	struct nft_expr_type - nf_tables expression type
82396518518SPatrick McHardy  *
824ef1f7df9SPatrick McHardy  *	@select_ops: function to select nft_expr_ops
825b8e20400SPablo Neira Ayuso  *	@release_ops: release nft_expr_ops
826ef1f7df9SPatrick McHardy  *	@ops: default ops, used when no select_ops functions is present
82796518518SPatrick McHardy  *	@list: used internally
82896518518SPatrick McHardy  *	@name: Identifier
82996518518SPatrick McHardy  *	@owner: module reference
83096518518SPatrick McHardy  *	@policy: netlink attribute policy
83196518518SPatrick McHardy  *	@maxattr: highest netlink attribute number
83264d46806SPatrick McHardy  *	@family: address family for AF-specific types
833151d799aSPatrick McHardy  *	@flags: expression type flags
834ef1f7df9SPatrick McHardy  */
835ef1f7df9SPatrick McHardy struct nft_expr_type {
8360ca743a5SPablo Neira Ayuso 	const struct nft_expr_ops	*(*select_ops)(const struct nft_ctx *,
8370ca743a5SPablo Neira Ayuso 						       const struct nlattr * const tb[]);
838b8e20400SPablo Neira Ayuso 	void				(*release_ops)(const struct nft_expr_ops *ops);
839ef1f7df9SPatrick McHardy 	const struct nft_expr_ops	*ops;
840ef1f7df9SPatrick McHardy 	struct list_head		list;
841ef1f7df9SPatrick McHardy 	const char			*name;
842ef1f7df9SPatrick McHardy 	struct module			*owner;
843ef1f7df9SPatrick McHardy 	const struct nla_policy		*policy;
844ef1f7df9SPatrick McHardy 	unsigned int			maxattr;
84564d46806SPatrick McHardy 	u8				family;
846151d799aSPatrick McHardy 	u8				flags;
847ef1f7df9SPatrick McHardy };
848ef1f7df9SPatrick McHardy 
849151d799aSPatrick McHardy #define NFT_EXPR_STATEFUL		0x1
85079b174adSPablo Neira Ayuso #define NFT_EXPR_GC			0x2
851151d799aSPatrick McHardy 
852f6ac8585SPablo Neira Ayuso enum nft_trans_phase {
853f6ac8585SPablo Neira Ayuso 	NFT_TRANS_PREPARE,
854f6ac8585SPablo Neira Ayuso 	NFT_TRANS_ABORT,
855f6ac8585SPablo Neira Ayuso 	NFT_TRANS_COMMIT,
856f6ac8585SPablo Neira Ayuso 	NFT_TRANS_RELEASE
857f6ac8585SPablo Neira Ayuso };
858f6ac8585SPablo Neira Ayuso 
859c9626a2cSPablo Neira Ayuso struct nft_flow_rule;
860c9626a2cSPablo Neira Ayuso struct nft_offload_ctx;
861c9626a2cSPablo Neira Ayuso 
862ef1f7df9SPatrick McHardy /**
863ef1f7df9SPatrick McHardy  *	struct nft_expr_ops - nf_tables expression operations
864ef1f7df9SPatrick McHardy  *
865ef1f7df9SPatrick McHardy  *	@eval: Expression evaluation function
86696518518SPatrick McHardy  *	@size: full expression size, including private data size
867ef1f7df9SPatrick McHardy  *	@init: initialization function
868cd5125d8SFlorian Westphal  *	@activate: activate expression in the next generation
869cd5125d8SFlorian Westphal  *	@deactivate: deactivate expression in next generation
870cd5125d8SFlorian Westphal  *	@destroy: destruction function, called after synchronize_rcu
871ef1f7df9SPatrick McHardy  *	@dump: function to dump parameters
872ef1f7df9SPatrick McHardy  *	@type: expression type
8730ca743a5SPablo Neira Ayuso  *	@validate: validate expression, called during loop detection
8740ca743a5SPablo Neira Ayuso  *	@data: extra data to attach to this expression operation
87596518518SPatrick McHardy  */
87696518518SPatrick McHardy struct nft_expr_ops {
87796518518SPatrick McHardy 	void				(*eval)(const struct nft_expr *expr,
878a55e22e9SPatrick McHardy 						struct nft_regs *regs,
87996518518SPatrick McHardy 						const struct nft_pktinfo *pkt);
880086f3321SPablo Neira Ayuso 	int				(*clone)(struct nft_expr *dst,
881086f3321SPablo Neira Ayuso 						 const struct nft_expr *src);
882ef1f7df9SPatrick McHardy 	unsigned int			size;
883ef1f7df9SPatrick McHardy 
88496518518SPatrick McHardy 	int				(*init)(const struct nft_ctx *ctx,
88596518518SPatrick McHardy 						const struct nft_expr *expr,
88696518518SPatrick McHardy 						const struct nlattr * const tb[]);
887bb7b40aeSPablo Neira Ayuso 	void				(*activate)(const struct nft_ctx *ctx,
888bb7b40aeSPablo Neira Ayuso 						    const struct nft_expr *expr);
889bb7b40aeSPablo Neira Ayuso 	void				(*deactivate)(const struct nft_ctx *ctx,
890f6ac8585SPablo Neira Ayuso 						      const struct nft_expr *expr,
891f6ac8585SPablo Neira Ayuso 						      enum nft_trans_phase phase);
89262472bceSPatrick McHardy 	void				(*destroy)(const struct nft_ctx *ctx,
89362472bceSPatrick McHardy 						   const struct nft_expr *expr);
894371ebcbbSPablo Neira Ayuso 	void				(*destroy_clone)(const struct nft_ctx *ctx,
895371ebcbbSPablo Neira Ayuso 							 const struct nft_expr *expr);
89696518518SPatrick McHardy 	int				(*dump)(struct sk_buff *skb,
89796518518SPatrick McHardy 						const struct nft_expr *expr);
8980ca743a5SPablo Neira Ayuso 	int				(*validate)(const struct nft_ctx *ctx,
8990ca743a5SPablo Neira Ayuso 						    const struct nft_expr *expr,
9000ca743a5SPablo Neira Ayuso 						    const struct nft_data **data);
90112e4ecfaSPablo Neira Ayuso 	bool				(*reduce)(struct nft_regs_track *track,
90212e4ecfaSPablo Neira Ayuso 						  const struct nft_expr *expr);
90379b174adSPablo Neira Ayuso 	bool				(*gc)(struct net *net,
90479b174adSPablo Neira Ayuso 					      const struct nft_expr *expr);
905c9626a2cSPablo Neira Ayuso 	int				(*offload)(struct nft_offload_ctx *ctx,
906c9626a2cSPablo Neira Ayuso 						   struct nft_flow_rule *flow,
907c9626a2cSPablo Neira Ayuso 						   const struct nft_expr *expr);
908*b1a5983fSPablo Neira Ayuso 	bool				(*offload_action)(const struct nft_expr *expr);
909b72920f6SPablo Neira Ayuso 	void				(*offload_stats)(struct nft_expr *expr,
910b72920f6SPablo Neira Ayuso 							 const struct flow_stats *stats);
911ef1f7df9SPatrick McHardy 	const struct nft_expr_type	*type;
9120ca743a5SPablo Neira Ayuso 	void				*data;
91396518518SPatrick McHardy };
91496518518SPatrick McHardy 
91596518518SPatrick McHardy /**
91696518518SPatrick McHardy  *	struct nft_rule - nf_tables rule
91796518518SPatrick McHardy  *
91896518518SPatrick McHardy  *	@list: used internally
91996518518SPatrick McHardy  *	@handle: rule handle
9200628b123SPablo Neira Ayuso  *	@genmask: generation mask
92196518518SPatrick McHardy  *	@dlen: length of expression data
92286f1ec32SPatrick McHardy  *	@udata: user data is appended to the rule
92396518518SPatrick McHardy  *	@data: expression data
92496518518SPatrick McHardy  */
92596518518SPatrick McHardy struct nft_rule {
92696518518SPatrick McHardy 	struct list_head		list;
9270768b3b3SPablo Neira Ayuso 	u64				handle:42,
9280628b123SPablo Neira Ayuso 					genmask:2,
9290768b3b3SPablo Neira Ayuso 					dlen:12,
93086f1ec32SPatrick McHardy 					udata:1;
93196518518SPatrick McHardy 	unsigned char			data[]
93296518518SPatrick McHardy 		__attribute__((aligned(__alignof__(struct nft_expr))));
93396518518SPatrick McHardy };
93496518518SPatrick McHardy 
93596518518SPatrick McHardy static inline struct nft_expr *nft_expr_first(const struct nft_rule *rule)
93696518518SPatrick McHardy {
93796518518SPatrick McHardy 	return (struct nft_expr *)&rule->data[0];
93896518518SPatrick McHardy }
93996518518SPatrick McHardy 
94096518518SPatrick McHardy static inline struct nft_expr *nft_expr_next(const struct nft_expr *expr)
94196518518SPatrick McHardy {
94296518518SPatrick McHardy 	return ((void *)expr) + expr->ops->size;
94396518518SPatrick McHardy }
94496518518SPatrick McHardy 
94596518518SPatrick McHardy static inline struct nft_expr *nft_expr_last(const struct nft_rule *rule)
94696518518SPatrick McHardy {
94796518518SPatrick McHardy 	return (struct nft_expr *)&rule->data[rule->dlen];
94896518518SPatrick McHardy }
94996518518SPatrick McHardy 
95031cc578aSSaeed Mirzamohammadi static inline bool nft_expr_more(const struct nft_rule *rule,
95131cc578aSSaeed Mirzamohammadi 				 const struct nft_expr *expr)
95231cc578aSSaeed Mirzamohammadi {
95331cc578aSSaeed Mirzamohammadi 	return expr != nft_expr_last(rule) && expr->ops;
95431cc578aSSaeed Mirzamohammadi }
95531cc578aSSaeed Mirzamohammadi 
95686f1ec32SPatrick McHardy static inline struct nft_userdata *nft_userdata(const struct nft_rule *rule)
9570768b3b3SPablo Neira Ayuso {
9580768b3b3SPablo Neira Ayuso 	return (void *)&rule->data[rule->dlen];
9590768b3b3SPablo Neira Ayuso }
9600768b3b3SPablo Neira Ayuso 
961d0e2c7deSPablo Neira Ayuso void nf_tables_rule_release(const struct nft_ctx *ctx, struct nft_rule *rule);
962d0e2c7deSPablo Neira Ayuso 
96376adfafeSPablo Neira Ayuso static inline void nft_set_elem_update_expr(const struct nft_set_ext *ext,
96476adfafeSPablo Neira Ayuso 					    struct nft_regs *regs,
96576adfafeSPablo Neira Ayuso 					    const struct nft_pktinfo *pkt)
96676adfafeSPablo Neira Ayuso {
967563125a7SPablo Neira Ayuso 	struct nft_set_elem_expr *elem_expr;
96876adfafeSPablo Neira Ayuso 	struct nft_expr *expr;
969563125a7SPablo Neira Ayuso 	u32 size;
97076adfafeSPablo Neira Ayuso 
971563125a7SPablo Neira Ayuso 	if (__nft_set_ext_exists(ext, NFT_SET_EXT_EXPRESSIONS)) {
972563125a7SPablo Neira Ayuso 		elem_expr = nft_set_ext_expr(ext);
973563125a7SPablo Neira Ayuso 		nft_setelem_expr_foreach(expr, elem_expr, size) {
97476adfafeSPablo Neira Ayuso 			expr->ops->eval(expr, regs, pkt);
975563125a7SPablo Neira Ayuso 			if (regs->verdict.code == NFT_BREAK)
976563125a7SPablo Neira Ayuso 				return;
977563125a7SPablo Neira Ayuso 		}
97876adfafeSPablo Neira Ayuso 	}
97976adfafeSPablo Neira Ayuso }
98076adfafeSPablo Neira Ayuso 
98196518518SPatrick McHardy /*
98296518518SPatrick McHardy  * The last pointer isn't really necessary, but the compiler isn't able to
98396518518SPatrick McHardy  * determine that the result of nft_expr_last() is always the same since it
98496518518SPatrick McHardy  * can't assume that the dlen value wasn't changed within calls in the loop.
98596518518SPatrick McHardy  */
98696518518SPatrick McHardy #define nft_rule_for_each_expr(expr, last, rule) \
98796518518SPatrick McHardy 	for ((expr) = nft_expr_first(rule), (last) = nft_expr_last(rule); \
98896518518SPatrick McHardy 	     (expr) != (last); \
98996518518SPatrick McHardy 	     (expr) = nft_expr_next(expr))
99096518518SPatrick McHardy 
991ad652f38SPablo Neira Ayuso #define NFT_CHAIN_POLICY_UNSET		U8_MAX
992ad652f38SPablo Neira Ayuso 
9932c865a8aSPablo Neira Ayuso struct nft_rule_dp {
9942c865a8aSPablo Neira Ayuso 	u64				is_last:1,
9952c865a8aSPablo Neira Ayuso 					dlen:12,
9962c865a8aSPablo Neira Ayuso 					handle:42;	/* for tracing */
9972c865a8aSPablo Neira Ayuso 	unsigned char			data[]
9982c865a8aSPablo Neira Ayuso 		__attribute__((aligned(__alignof__(struct nft_expr))));
9992c865a8aSPablo Neira Ayuso };
10002c865a8aSPablo Neira Ayuso 
10012c865a8aSPablo Neira Ayuso struct nft_rule_blob {
10022c865a8aSPablo Neira Ayuso 	unsigned long			size;
10032c865a8aSPablo Neira Ayuso 	unsigned char			data[]
10042c865a8aSPablo Neira Ayuso 		__attribute__((aligned(__alignof__(struct nft_rule_dp))));
10052c865a8aSPablo Neira Ayuso };
10062c865a8aSPablo Neira Ayuso 
100796518518SPatrick McHardy /**
100896518518SPatrick McHardy  *	struct nft_chain - nf_tables chain
100996518518SPatrick McHardy  *
101096518518SPatrick McHardy  *	@rules: list of rules in the chain
101196518518SPatrick McHardy  *	@list: used internally
10121b2470e5SFlorian Westphal  *	@rhlhead: used internally
1013b5bc89bfSPablo Neira Ayuso  *	@table: table that this chain belongs to
101496518518SPatrick McHardy  *	@handle: chain handle
101596518518SPatrick McHardy  *	@use: number of jump references to this chain
1016a0a7379eSPablo Neira Ayuso  *	@flags: bitmask of enum nft_chain_flags
101796518518SPatrick McHardy  *	@name: name of the chain
101896518518SPatrick McHardy  */
101996518518SPatrick McHardy struct nft_chain {
10202c865a8aSPablo Neira Ayuso 	struct nft_rule_blob		__rcu *blob_gen_0;
10212c865a8aSPablo Neira Ayuso 	struct nft_rule_blob		__rcu *blob_gen_1;
102296518518SPatrick McHardy 	struct list_head		rules;
102396518518SPatrick McHardy 	struct list_head		list;
10241b2470e5SFlorian Westphal 	struct rhlist_head		rhlhead;
1025b5bc89bfSPablo Neira Ayuso 	struct nft_table		*table;
102696518518SPatrick McHardy 	u64				handle;
1027a0a7379eSPablo Neira Ayuso 	u32				use;
1028d0e2c7deSPablo Neira Ayuso 	u8				flags:5,
1029d0e2c7deSPablo Neira Ayuso 					bound:1,
1030664b0f8cSPablo Neira Ayuso 					genmask:2;
1031b7263e07SPhil Sutter 	char				*name;
1032002f2176SJose M. Guisado Gomez 	u16				udlen;
1033002f2176SJose M. Guisado Gomez 	u8				*udata;
10340cbc06b3SFlorian Westphal 
10350cbc06b3SFlorian Westphal 	/* Only used during control plane commit phase: */
10362c865a8aSPablo Neira Ayuso 	struct nft_rule_blob		*blob_next;
103796518518SPatrick McHardy };
103896518518SPatrick McHardy 
1039a654de8fSPablo Neira Ayuso int nft_chain_validate(const struct nft_ctx *ctx, const struct nft_chain *chain);
1040a654de8fSPablo Neira Ayuso 
104132537e91SPablo Neira Ayuso enum nft_chain_types {
10429370761cSPablo Neira Ayuso 	NFT_CHAIN_T_DEFAULT = 0,
10439370761cSPablo Neira Ayuso 	NFT_CHAIN_T_ROUTE,
10449370761cSPablo Neira Ayuso 	NFT_CHAIN_T_NAT,
10459370761cSPablo Neira Ayuso 	NFT_CHAIN_T_MAX
10469370761cSPablo Neira Ayuso };
10479370761cSPablo Neira Ayuso 
10481a1e1a12SPatrick McHardy /**
104932537e91SPablo Neira Ayuso  * 	struct nft_chain_type - nf_tables chain type info
10501a1e1a12SPatrick McHardy  *
10511a1e1a12SPatrick McHardy  * 	@name: name of the type
10521a1e1a12SPatrick McHardy  * 	@type: numeric identifier
10531a1e1a12SPatrick McHardy  * 	@family: address family
10541a1e1a12SPatrick McHardy  * 	@owner: module owner
10551a1e1a12SPatrick McHardy  * 	@hook_mask: mask of valid hooks
1056c2f9eafeSPablo Neira Ayuso  * 	@hooks: array of hook functions
10574e25ceb8SFlorian Westphal  *	@ops_register: base chain register function
10584e25ceb8SFlorian Westphal  *	@ops_unregister: base chain unregister function
10591a1e1a12SPatrick McHardy  */
106032537e91SPablo Neira Ayuso struct nft_chain_type {
10611a1e1a12SPatrick McHardy 	const char			*name;
106232537e91SPablo Neira Ayuso 	enum nft_chain_types		type;
10631a1e1a12SPatrick McHardy 	int				family;
10641a1e1a12SPatrick McHardy 	struct module			*owner;
10651a1e1a12SPatrick McHardy 	unsigned int			hook_mask;
1066d25e2e93SPablo Neira Ayuso 	nf_hookfn			*hooks[NFT_MAX_HOOKS];
10674e25ceb8SFlorian Westphal 	int				(*ops_register)(struct net *net, const struct nf_hook_ops *ops);
10684e25ceb8SFlorian Westphal 	void				(*ops_unregister)(struct net *net, const struct nf_hook_ops *ops);
10691a1e1a12SPatrick McHardy };
10701a1e1a12SPatrick McHardy 
10717210e4e3SPablo Neira Ayuso int nft_chain_validate_dependency(const struct nft_chain *chain,
107232537e91SPablo Neira Ayuso 				  enum nft_chain_types type);
107375e8d06dSPablo Neira Ayuso int nft_chain_validate_hooks(const struct nft_chain *chain,
107475e8d06dSPablo Neira Ayuso                              unsigned int hook_flags);
10757210e4e3SPablo Neira Ayuso 
1076d0e2c7deSPablo Neira Ayuso static inline bool nft_chain_is_bound(struct nft_chain *chain)
1077d0e2c7deSPablo Neira Ayuso {
1078d0e2c7deSPablo Neira Ayuso 	return (chain->flags & NFT_CHAIN_BINDING) && chain->bound;
1079d0e2c7deSPablo Neira Ayuso }
1080d0e2c7deSPablo Neira Ayuso 
1081d0e2c7deSPablo Neira Ayuso void nft_chain_del(struct nft_chain *chain);
1082d0e2c7deSPablo Neira Ayuso void nf_tables_chain_destroy(struct nft_ctx *ctx);
1083d0e2c7deSPablo Neira Ayuso 
10840ca743a5SPablo Neira Ayuso struct nft_stats {
10850ca743a5SPablo Neira Ayuso 	u64			bytes;
10860ca743a5SPablo Neira Ayuso 	u64			pkts;
1087ce355e20SEric Dumazet 	struct u64_stats_sync	syncp;
10880ca743a5SPablo Neira Ayuso };
10890ca743a5SPablo Neira Ayuso 
10903f0465a9SPablo Neira Ayuso struct nft_hook {
10913f0465a9SPablo Neira Ayuso 	struct list_head	list;
1092abadb2f8SPablo Neira Ayuso 	bool			inactive;
10933f0465a9SPablo Neira Ayuso 	struct nf_hook_ops	ops;
10943f0465a9SPablo Neira Ayuso 	struct rcu_head		rcu;
10953f0465a9SPablo Neira Ayuso };
10963f0465a9SPablo Neira Ayuso 
109796518518SPatrick McHardy /**
109896518518SPatrick McHardy  *	struct nft_base_chain - nf_tables base chain
109996518518SPatrick McHardy  *
110096518518SPatrick McHardy  *	@ops: netfilter hook ops
1101d54725cdSPablo Neira Ayuso  *	@hook_list: list of netfilter hooks (for NFPROTO_NETDEV family)
11029370761cSPablo Neira Ayuso  *	@type: chain type
11030ca743a5SPablo Neira Ayuso  *	@policy: default policy
11040ca743a5SPablo Neira Ayuso  *	@stats: per-cpu chain stats
110596518518SPatrick McHardy  *	@chain: the chain
110614bfb13fSPablo Neira Ayuso  *	@flow_block: flow block (for hardware offload)
110796518518SPatrick McHardy  */
110896518518SPatrick McHardy struct nft_base_chain {
1109c974a3a3SPablo Neira Ayuso 	struct nf_hook_ops		ops;
1110d54725cdSPablo Neira Ayuso 	struct list_head		hook_list;
111132537e91SPablo Neira Ayuso 	const struct nft_chain_type	*type;
11120ca743a5SPablo Neira Ayuso 	u8				policy;
1113835b8033SPablo Neira Ayuso 	u8				flags;
11140ca743a5SPablo Neira Ayuso 	struct nft_stats __percpu	*stats;
111596518518SPatrick McHardy 	struct nft_chain		chain;
111614bfb13fSPablo Neira Ayuso 	struct flow_block		flow_block;
111796518518SPatrick McHardy };
111896518518SPatrick McHardy 
111996518518SPatrick McHardy static inline struct nft_base_chain *nft_base_chain(const struct nft_chain *chain)
112096518518SPatrick McHardy {
112196518518SPatrick McHardy 	return container_of(chain, struct nft_base_chain, chain);
112296518518SPatrick McHardy }
112396518518SPatrick McHardy 
1124f323d954SPablo Neira Ayuso static inline bool nft_is_base_chain(const struct nft_chain *chain)
1125f323d954SPablo Neira Ayuso {
112667c49de4SPablo Neira Ayuso 	return chain->flags & NFT_CHAIN_BASE;
1127f323d954SPablo Neira Ayuso }
1128f323d954SPablo Neira Ayuso 
11295ebe0b0eSPablo Neira Ayuso int __nft_release_basechain(struct nft_ctx *ctx);
1130835b8033SPablo Neira Ayuso 
113106198b34SEric W. Biederman unsigned int nft_do_chain(struct nft_pktinfo *pkt, void *priv);
113296518518SPatrick McHardy 
113396518518SPatrick McHardy /**
113496518518SPatrick McHardy  *	struct nft_table - nf_tables table
113596518518SPatrick McHardy  *
113696518518SPatrick McHardy  *	@list: used internally
11371b2470e5SFlorian Westphal  *	@chains_ht: chains in the table
11381b2470e5SFlorian Westphal  *	@chains: same, for stable walks
113996518518SPatrick McHardy  *	@sets: sets in the table
1140e5009240SPablo Neira Ayuso  *	@objects: stateful objects in the table
11413b49e2e9SPablo Neira Ayuso  *	@flowtables: flow tables in the table
114296518518SPatrick McHardy  *	@hgenerator: handle generator state
11433ecbfd65SHarsha Sharma  *	@handle: table handle
114496518518SPatrick McHardy  *	@use: number of chain references to this table
114596518518SPatrick McHardy  *	@flags: table flag (see enum nft_table_flags)
1146f2a6d766SPablo Neira Ayuso  *	@genmask: generation mask
114736596dadSPablo Neira Ayuso  *	@afinfo: address family info
114896518518SPatrick McHardy  *	@name: name of the table
114996518518SPatrick McHardy  */
115096518518SPatrick McHardy struct nft_table {
115196518518SPatrick McHardy 	struct list_head		list;
11521b2470e5SFlorian Westphal 	struct rhltable			chains_ht;
115396518518SPatrick McHardy 	struct list_head		chains;
115496518518SPatrick McHardy 	struct list_head		sets;
1155e5009240SPablo Neira Ayuso 	struct list_head		objects;
11563b49e2e9SPablo Neira Ayuso 	struct list_head		flowtables;
115796518518SPatrick McHardy 	u64				hgenerator;
11583ecbfd65SHarsha Sharma 	u64				handle;
115996518518SPatrick McHardy 	u32				use;
116098319cb9SPablo Neira Ayuso 	u16				family:6,
116198319cb9SPablo Neira Ayuso 					flags:8,
1162f2a6d766SPablo Neira Ayuso 					genmask:2;
11636001a930SPablo Neira Ayuso 	u32				nlpid;
1164e46abbccSPhil Sutter 	char				*name;
11657a81575bSJose M. Guisado Gomez 	u16				udlen;
11667a81575bSJose M. Guisado Gomez 	u8				*udata;
1167ebddf1a8SPablo Neira Ayuso };
1168ebddf1a8SPablo Neira Ayuso 
11696001a930SPablo Neira Ayuso static inline bool nft_table_has_owner(const struct nft_table *table)
11706001a930SPablo Neira Ayuso {
11716001a930SPablo Neira Ayuso 	return table->flags & NFT_TABLE_F_OWNER;
11726001a930SPablo Neira Ayuso }
11736001a930SPablo Neira Ayuso 
1174d3519cb8SPablo Neira Ayuso static inline bool nft_base_chain_netdev(int family, u32 hooknum)
1175d3519cb8SPablo Neira Ayuso {
1176d3519cb8SPablo Neira Ayuso 	return family == NFPROTO_NETDEV ||
1177d3519cb8SPablo Neira Ayuso 	       (family == NFPROTO_INET && hooknum == NF_INET_INGRESS);
1178d3519cb8SPablo Neira Ayuso }
1179d3519cb8SPablo Neira Ayuso 
1180cc07eeb0SPablo Neira Ayuso void nft_register_chain_type(const struct nft_chain_type *);
118132537e91SPablo Neira Ayuso void nft_unregister_chain_type(const struct nft_chain_type *);
118296518518SPatrick McHardy 
11835eccdfaaSJoe Perches int nft_register_expr(struct nft_expr_type *);
11845eccdfaaSJoe Perches void nft_unregister_expr(struct nft_expr_type *);
118596518518SPatrick McHardy 
118633d5a7b1SFlorian Westphal int nft_verdict_dump(struct sk_buff *skb, int type,
118733d5a7b1SFlorian Westphal 		     const struct nft_verdict *v);
118833d5a7b1SFlorian Westphal 
118933d5a7b1SFlorian Westphal /**
1190d152159bSFlorian Westphal  *	struct nft_object_hash_key - key to lookup nft_object
1191d152159bSFlorian Westphal  *
1192d152159bSFlorian Westphal  *	@name: name of the stateful object to look up
1193d152159bSFlorian Westphal  *	@table: table the object belongs to
1194d152159bSFlorian Westphal  */
1195d152159bSFlorian Westphal struct nft_object_hash_key {
1196d152159bSFlorian Westphal 	const char                      *name;
1197d152159bSFlorian Westphal 	const struct nft_table          *table;
1198d152159bSFlorian Westphal };
1199d152159bSFlorian Westphal 
1200d152159bSFlorian Westphal /**
1201e5009240SPablo Neira Ayuso  *	struct nft_object - nf_tables stateful object
1202e5009240SPablo Neira Ayuso  *
1203e5009240SPablo Neira Ayuso  *	@list: table stateful object list node
1204d152159bSFlorian Westphal  *	@key:  keys that identify this object
12054d44175aSFlorian Westphal  *	@rhlhead: nft_objname_ht node
1206e5009240SPablo Neira Ayuso  *	@genmask: generation mask
1207e5009240SPablo Neira Ayuso  *	@use: number of references to this stateful object
12083ecbfd65SHarsha Sharma  *	@handle: unique object handle
1209dfc46034SPablo M. Bermudo Garay  *	@ops: object operations
12103ecbfd65SHarsha Sharma  *	@data: object data, layout depends on type
1211e5009240SPablo Neira Ayuso  */
1212e5009240SPablo Neira Ayuso struct nft_object {
1213e5009240SPablo Neira Ayuso 	struct list_head		list;
12144d44175aSFlorian Westphal 	struct rhlist_head		rhlhead;
1215d152159bSFlorian Westphal 	struct nft_object_hash_key	key;
1216e5009240SPablo Neira Ayuso 	u32				genmask:2,
1217e5009240SPablo Neira Ayuso 					use:30;
12183ecbfd65SHarsha Sharma 	u64				handle;
1219b131c964SJose M. Guisado Gomez 	u16				udlen;
1220b131c964SJose M. Guisado Gomez 	u8				*udata;
1221e5009240SPablo Neira Ayuso 	/* runtime data below here */
1222dfc46034SPablo M. Bermudo Garay 	const struct nft_object_ops	*ops ____cacheline_aligned;
1223e5009240SPablo Neira Ayuso 	unsigned char			data[]
1224e5009240SPablo Neira Ayuso 		__attribute__((aligned(__alignof__(u64))));
1225e5009240SPablo Neira Ayuso };
1226e5009240SPablo Neira Ayuso 
1227e5009240SPablo Neira Ayuso static inline void *nft_obj_data(const struct nft_object *obj)
1228e5009240SPablo Neira Ayuso {
1229e5009240SPablo Neira Ayuso 	return (void *)obj->data;
1230e5009240SPablo Neira Ayuso }
1231e5009240SPablo Neira Ayuso 
1232e5009240SPablo Neira Ayuso #define nft_expr_obj(expr)	*((struct nft_object **)nft_expr_priv(expr))
1233e5009240SPablo Neira Ayuso 
12344d44175aSFlorian Westphal struct nft_object *nft_obj_lookup(const struct net *net,
12354d44175aSFlorian Westphal 				  const struct nft_table *table,
1236e5009240SPablo Neira Ayuso 				  const struct nlattr *nla, u32 objtype,
1237e5009240SPablo Neira Ayuso 				  u8 genmask);
1238e5009240SPablo Neira Ayuso 
1239d152159bSFlorian Westphal void nft_obj_notify(struct net *net, const struct nft_table *table,
12402599e989SPablo Neira Ayuso 		    struct nft_object *obj, u32 portid, u32 seq,
12416fb721cfSPablo Neira Ayuso 		    int event, u16 flags, int family, int report, gfp_t gfp);
12422599e989SPablo Neira Ayuso 
1243e5009240SPablo Neira Ayuso /**
1244e5009240SPablo Neira Ayuso  *	struct nft_object_type - stateful object type
1245e5009240SPablo Neira Ayuso  *
1246dfc46034SPablo M. Bermudo Garay  *	@select_ops: function to select nft_object_ops
1247dfc46034SPablo M. Bermudo Garay  *	@ops: default ops, used when no select_ops functions is present
1248e5009240SPablo Neira Ayuso  *	@list: list node in list of object types
1249e5009240SPablo Neira Ayuso  *	@type: stateful object numeric type
1250e5009240SPablo Neira Ayuso  *	@owner: module owner
1251e5009240SPablo Neira Ayuso  *	@maxattr: maximum netlink attribute
1252e5009240SPablo Neira Ayuso  *	@policy: netlink attribute policy
1253dfc46034SPablo M. Bermudo Garay  */
1254dfc46034SPablo M. Bermudo Garay struct nft_object_type {
1255dfc46034SPablo M. Bermudo Garay 	const struct nft_object_ops	*(*select_ops)(const struct nft_ctx *,
1256dfc46034SPablo M. Bermudo Garay 						       const struct nlattr * const tb[]);
1257dfc46034SPablo M. Bermudo Garay 	const struct nft_object_ops	*ops;
1258dfc46034SPablo M. Bermudo Garay 	struct list_head		list;
1259dfc46034SPablo M. Bermudo Garay 	u32				type;
1260dfc46034SPablo M. Bermudo Garay 	unsigned int                    maxattr;
1261dfc46034SPablo M. Bermudo Garay 	struct module			*owner;
1262dfc46034SPablo M. Bermudo Garay 	const struct nla_policy		*policy;
1263dfc46034SPablo M. Bermudo Garay };
1264dfc46034SPablo M. Bermudo Garay 
1265dfc46034SPablo M. Bermudo Garay /**
1266dfc46034SPablo M. Bermudo Garay  *	struct nft_object_ops - stateful object operations
1267dfc46034SPablo M. Bermudo Garay  *
1268dfc46034SPablo M. Bermudo Garay  *	@eval: stateful object evaluation function
1269dfc46034SPablo M. Bermudo Garay  *	@size: stateful object size
1270e5009240SPablo Neira Ayuso  *	@init: initialize object from netlink attributes
1271e5009240SPablo Neira Ayuso  *	@destroy: release existing stateful object
1272e5009240SPablo Neira Ayuso  *	@dump: netlink dump stateful object
1273d62d0ba9SFernando Fernandez Mancera  *	@update: update stateful object
1274e5009240SPablo Neira Ayuso  */
1275dfc46034SPablo M. Bermudo Garay struct nft_object_ops {
1276e5009240SPablo Neira Ayuso 	void				(*eval)(struct nft_object *obj,
1277e5009240SPablo Neira Ayuso 						struct nft_regs *regs,
1278e5009240SPablo Neira Ayuso 						const struct nft_pktinfo *pkt);
1279e5009240SPablo Neira Ayuso 	unsigned int			size;
128084fba055SFlorian Westphal 	int				(*init)(const struct nft_ctx *ctx,
128184fba055SFlorian Westphal 						const struct nlattr *const tb[],
1282e5009240SPablo Neira Ayuso 						struct nft_object *obj);
128300bfb320SPablo Neira Ayuso 	void				(*destroy)(const struct nft_ctx *ctx,
128400bfb320SPablo Neira Ayuso 						   struct nft_object *obj);
1285e5009240SPablo Neira Ayuso 	int				(*dump)(struct sk_buff *skb,
128643da04a5SPablo Neira Ayuso 						struct nft_object *obj,
128743da04a5SPablo Neira Ayuso 						bool reset);
1288d62d0ba9SFernando Fernandez Mancera 	void				(*update)(struct nft_object *obj,
1289d62d0ba9SFernando Fernandez Mancera 						  struct nft_object *newobj);
1290dfc46034SPablo M. Bermudo Garay 	const struct nft_object_type	*type;
1291e5009240SPablo Neira Ayuso };
1292e5009240SPablo Neira Ayuso 
1293e5009240SPablo Neira Ayuso int nft_register_obj(struct nft_object_type *obj_type);
1294e5009240SPablo Neira Ayuso void nft_unregister_obj(struct nft_object_type *obj_type);
1295e5009240SPablo Neira Ayuso 
1296cb662ac6SPablo Neira Ayuso #define NFT_NETDEVICE_MAX	256
1297d92191aaSPablo Neira Ayuso 
1298e5009240SPablo Neira Ayuso /**
12993b49e2e9SPablo Neira Ayuso  *	struct nft_flowtable - nf_tables flow table
13003b49e2e9SPablo Neira Ayuso  *
13013b49e2e9SPablo Neira Ayuso  *	@list: flow table list node in table list
13023b49e2e9SPablo Neira Ayuso  * 	@table: the table the flow table is contained in
13033b49e2e9SPablo Neira Ayuso  *	@name: name of this flow table
13043b49e2e9SPablo Neira Ayuso  *	@hooknum: hook number
13053b49e2e9SPablo Neira Ayuso  *	@ops_len: number of hooks in array
13063b49e2e9SPablo Neira Ayuso  *	@genmask: generation mask
13073b49e2e9SPablo Neira Ayuso  *	@use: number of references to this flow table
13083ecbfd65SHarsha Sharma  * 	@handle: unique object handle
1309d92191aaSPablo Neira Ayuso  *	@dev_name: array of device names
13103b49e2e9SPablo Neira Ayuso  *	@data: rhashtable and garbage collector
13113b49e2e9SPablo Neira Ayuso  * 	@ops: array of hooks
13123b49e2e9SPablo Neira Ayuso  */
13133b49e2e9SPablo Neira Ayuso struct nft_flowtable {
13143b49e2e9SPablo Neira Ayuso 	struct list_head		list;
13153b49e2e9SPablo Neira Ayuso 	struct nft_table		*table;
13163b49e2e9SPablo Neira Ayuso 	char				*name;
13173b49e2e9SPablo Neira Ayuso 	int				hooknum;
13183b49e2e9SPablo Neira Ayuso 	int				ops_len;
13193b49e2e9SPablo Neira Ayuso 	u32				genmask:2,
13203b49e2e9SPablo Neira Ayuso 					use:30;
13213ecbfd65SHarsha Sharma 	u64				handle;
13223b49e2e9SPablo Neira Ayuso 	/* runtime data below here */
13233f0465a9SPablo Neira Ayuso 	struct list_head		hook_list ____cacheline_aligned;
13243b49e2e9SPablo Neira Ayuso 	struct nf_flowtable		data;
13253b49e2e9SPablo Neira Ayuso };
13263b49e2e9SPablo Neira Ayuso 
1327cac20fcdSPablo Neira Ayuso struct nft_flowtable *nft_flowtable_lookup(const struct nft_table *table,
13283b49e2e9SPablo Neira Ayuso 					   const struct nlattr *nla,
13293b49e2e9SPablo Neira Ayuso 					   u8 genmask);
13303b49e2e9SPablo Neira Ayuso 
13319b05b6e1SLaura Garcia Liebana void nf_tables_deactivate_flowtable(const struct nft_ctx *ctx,
13329b05b6e1SLaura Garcia Liebana 				    struct nft_flowtable *flowtable,
13339b05b6e1SLaura Garcia Liebana 				    enum nft_trans_phase phase);
13349b05b6e1SLaura Garcia Liebana 
13353b49e2e9SPablo Neira Ayuso void nft_register_flowtable_type(struct nf_flowtable_type *type);
13363b49e2e9SPablo Neira Ayuso void nft_unregister_flowtable_type(struct nf_flowtable_type *type);
13373b49e2e9SPablo Neira Ayuso 
13383b49e2e9SPablo Neira Ayuso /**
133933d5a7b1SFlorian Westphal  *	struct nft_traceinfo - nft tracing information and state
134033d5a7b1SFlorian Westphal  *
134133d5a7b1SFlorian Westphal  *	@pkt: pktinfo currently processed
134233d5a7b1SFlorian Westphal  *	@basechain: base chain currently processed
134333d5a7b1SFlorian Westphal  *	@chain: chain currently processed
134433d5a7b1SFlorian Westphal  *	@rule:  rule that was evaluated
134533d5a7b1SFlorian Westphal  *	@verdict: verdict given by rule
134633d5a7b1SFlorian Westphal  *	@type: event type (enum nft_trace_types)
134733d5a7b1SFlorian Westphal  *	@packet_dumped: packet headers sent in a previous traceinfo message
134833d5a7b1SFlorian Westphal  *	@trace: other struct members are initialised
134933d5a7b1SFlorian Westphal  */
135033d5a7b1SFlorian Westphal struct nft_traceinfo {
135133d5a7b1SFlorian Westphal 	const struct nft_pktinfo	*pkt;
135233d5a7b1SFlorian Westphal 	const struct nft_base_chain	*basechain;
135333d5a7b1SFlorian Westphal 	const struct nft_chain		*chain;
13542c865a8aSPablo Neira Ayuso 	const struct nft_rule_dp	*rule;
135533d5a7b1SFlorian Westphal 	const struct nft_verdict	*verdict;
135633d5a7b1SFlorian Westphal 	enum nft_trace_types		type;
135733d5a7b1SFlorian Westphal 	bool				packet_dumped;
135833d5a7b1SFlorian Westphal 	bool				trace;
135933d5a7b1SFlorian Westphal };
136033d5a7b1SFlorian Westphal 
136133d5a7b1SFlorian Westphal void nft_trace_init(struct nft_traceinfo *info, const struct nft_pktinfo *pkt,
136233d5a7b1SFlorian Westphal 		    const struct nft_verdict *verdict,
136333d5a7b1SFlorian Westphal 		    const struct nft_chain *basechain);
136433d5a7b1SFlorian Westphal 
136533d5a7b1SFlorian Westphal void nft_trace_notify(struct nft_traceinfo *info);
136633d5a7b1SFlorian Westphal 
13679370761cSPablo Neira Ayuso #define MODULE_ALIAS_NFT_CHAIN(family, name) \
13689370761cSPablo Neira Ayuso 	MODULE_ALIAS("nft-chain-" __stringify(family) "-" name)
136996518518SPatrick McHardy 
137064d46806SPatrick McHardy #define MODULE_ALIAS_NFT_AF_EXPR(family, name) \
137164d46806SPatrick McHardy 	MODULE_ALIAS("nft-expr-" __stringify(family) "-" name)
137264d46806SPatrick McHardy 
137396518518SPatrick McHardy #define MODULE_ALIAS_NFT_EXPR(name) \
137496518518SPatrick McHardy 	MODULE_ALIAS("nft-expr-" name)
137596518518SPatrick McHardy 
1376e5009240SPablo Neira Ayuso #define MODULE_ALIAS_NFT_OBJ(type) \
1377e5009240SPablo Neira Ayuso 	MODULE_ALIAS("nft-obj-" __stringify(type))
1378e5009240SPablo Neira Ayuso 
137947e640afSJeremy Sowden #if IS_ENABLED(CONFIG_NF_TABLES)
138047e640afSJeremy Sowden 
1381ea4bd995SPatrick McHardy /*
1382ea4bd995SPatrick McHardy  * The gencursor defines two generations, the currently active and the
1383ea4bd995SPatrick McHardy  * next one. Objects contain a bitmask of 2 bits specifying the generations
1384ea4bd995SPatrick McHardy  * they're active in. A set bit means they're inactive in the generation
1385ea4bd995SPatrick McHardy  * represented by that bit.
1386ea4bd995SPatrick McHardy  *
1387ea4bd995SPatrick McHardy  * New objects start out as inactive in the current and active in the
1388ea4bd995SPatrick McHardy  * next generation. When committing the ruleset the bitmask is cleared,
1389ea4bd995SPatrick McHardy  * meaning they're active in all generations. When removing an object,
1390ea4bd995SPatrick McHardy  * it is set inactive in the next generation. After committing the ruleset,
1391ea4bd995SPatrick McHardy  * the objects are removed.
1392ea4bd995SPatrick McHardy  */
1393ea4bd995SPatrick McHardy static inline unsigned int nft_gencursor_next(const struct net *net)
1394ea4bd995SPatrick McHardy {
1395ea4bd995SPatrick McHardy 	return net->nft.gencursor + 1 == 1 ? 1 : 0;
1396ea4bd995SPatrick McHardy }
1397ea4bd995SPatrick McHardy 
1398ea4bd995SPatrick McHardy static inline u8 nft_genmask_next(const struct net *net)
1399ea4bd995SPatrick McHardy {
1400ea4bd995SPatrick McHardy 	return 1 << nft_gencursor_next(net);
1401ea4bd995SPatrick McHardy }
1402ea4bd995SPatrick McHardy 
1403ea4bd995SPatrick McHardy static inline u8 nft_genmask_cur(const struct net *net)
1404ea4bd995SPatrick McHardy {
140514cd5d4aSMark Rutland 	/* Use READ_ONCE() to prevent refetching the value for atomicity */
140614cd5d4aSMark Rutland 	return 1 << READ_ONCE(net->nft.gencursor);
1407ea4bd995SPatrick McHardy }
1408ea4bd995SPatrick McHardy 
140922fe54d5SPatrick McHardy #define NFT_GENMASK_ANY		((1 << 0) | (1 << 1))
141022fe54d5SPatrick McHardy 
1411cc02e457SPatrick McHardy /*
1412889f7ee7SPablo Neira Ayuso  * Generic transaction helpers
1413889f7ee7SPablo Neira Ayuso  */
1414889f7ee7SPablo Neira Ayuso 
1415889f7ee7SPablo Neira Ayuso /* Check if this object is currently active. */
1416889f7ee7SPablo Neira Ayuso #define nft_is_active(__net, __obj)				\
1417889f7ee7SPablo Neira Ayuso 	(((__obj)->genmask & nft_genmask_cur(__net)) == 0)
1418889f7ee7SPablo Neira Ayuso 
1419889f7ee7SPablo Neira Ayuso /* Check if this object is active in the next generation. */
1420889f7ee7SPablo Neira Ayuso #define nft_is_active_next(__net, __obj)			\
1421889f7ee7SPablo Neira Ayuso 	(((__obj)->genmask & nft_genmask_next(__net)) == 0)
1422889f7ee7SPablo Neira Ayuso 
1423889f7ee7SPablo Neira Ayuso /* This object becomes active in the next generation. */
1424889f7ee7SPablo Neira Ayuso #define nft_activate_next(__net, __obj)				\
1425889f7ee7SPablo Neira Ayuso 	(__obj)->genmask = nft_genmask_cur(__net)
1426889f7ee7SPablo Neira Ayuso 
1427889f7ee7SPablo Neira Ayuso /* This object becomes inactive in the next generation. */
1428889f7ee7SPablo Neira Ayuso #define nft_deactivate_next(__net, __obj)			\
1429889f7ee7SPablo Neira Ayuso         (__obj)->genmask = nft_genmask_next(__net)
1430889f7ee7SPablo Neira Ayuso 
1431889f7ee7SPablo Neira Ayuso /* After committing the ruleset, clear the stale generation bit. */
1432889f7ee7SPablo Neira Ayuso #define nft_clear(__net, __obj)					\
1433889f7ee7SPablo Neira Ayuso 	(__obj)->genmask &= ~nft_genmask_next(__net)
1434f2a6d766SPablo Neira Ayuso #define nft_active_genmask(__obj, __genmask)			\
1435f2a6d766SPablo Neira Ayuso 	!((__obj)->genmask & __genmask)
1436889f7ee7SPablo Neira Ayuso 
1437889f7ee7SPablo Neira Ayuso /*
1438cc02e457SPatrick McHardy  * Set element transaction helpers
1439cc02e457SPatrick McHardy  */
1440cc02e457SPatrick McHardy 
1441cc02e457SPatrick McHardy static inline bool nft_set_elem_active(const struct nft_set_ext *ext,
1442cc02e457SPatrick McHardy 				       u8 genmask)
1443cc02e457SPatrick McHardy {
1444cc02e457SPatrick McHardy 	return !(ext->genmask & genmask);
1445cc02e457SPatrick McHardy }
1446cc02e457SPatrick McHardy 
144742a55769SPablo Neira Ayuso static inline void nft_set_elem_change_active(const struct net *net,
144842a55769SPablo Neira Ayuso 					      const struct nft_set *set,
1449cc02e457SPatrick McHardy 					      struct nft_set_ext *ext)
1450cc02e457SPatrick McHardy {
145142a55769SPablo Neira Ayuso 	ext->genmask ^= nft_genmask_next(net);
1452cc02e457SPatrick McHardy }
1453cc02e457SPatrick McHardy 
145447e640afSJeremy Sowden #endif /* IS_ENABLED(CONFIG_NF_TABLES) */
145547e640afSJeremy Sowden 
145669086658SPatrick McHardy /*
145769086658SPatrick McHardy  * We use a free bit in the genmask field to indicate the element
145869086658SPatrick McHardy  * is busy, meaning it is currently being processed either by
145969086658SPatrick McHardy  * the netlink API or GC.
146069086658SPatrick McHardy  *
146169086658SPatrick McHardy  * Even though the genmask is only a single byte wide, this works
146269086658SPatrick McHardy  * because the extension structure if fully constant once initialized,
146369086658SPatrick McHardy  * so there are no non-atomic write accesses unless it is already
146469086658SPatrick McHardy  * marked busy.
146569086658SPatrick McHardy  */
146669086658SPatrick McHardy #define NFT_SET_ELEM_BUSY_MASK	(1 << 2)
146769086658SPatrick McHardy 
146869086658SPatrick McHardy #if defined(__LITTLE_ENDIAN_BITFIELD)
146969086658SPatrick McHardy #define NFT_SET_ELEM_BUSY_BIT	2
147069086658SPatrick McHardy #elif defined(__BIG_ENDIAN_BITFIELD)
147169086658SPatrick McHardy #define NFT_SET_ELEM_BUSY_BIT	(BITS_PER_LONG - BITS_PER_BYTE + 2)
147269086658SPatrick McHardy #else
147369086658SPatrick McHardy #error
147469086658SPatrick McHardy #endif
147569086658SPatrick McHardy 
147669086658SPatrick McHardy static inline int nft_set_elem_mark_busy(struct nft_set_ext *ext)
147769086658SPatrick McHardy {
147869086658SPatrick McHardy 	unsigned long *word = (unsigned long *)ext;
147969086658SPatrick McHardy 
148069086658SPatrick McHardy 	BUILD_BUG_ON(offsetof(struct nft_set_ext, genmask) != 0);
148169086658SPatrick McHardy 	return test_and_set_bit(NFT_SET_ELEM_BUSY_BIT, word);
148269086658SPatrick McHardy }
148369086658SPatrick McHardy 
148469086658SPatrick McHardy static inline void nft_set_elem_clear_busy(struct nft_set_ext *ext)
148569086658SPatrick McHardy {
148669086658SPatrick McHardy 	unsigned long *word = (unsigned long *)ext;
148769086658SPatrick McHardy 
148869086658SPatrick McHardy 	clear_bit(NFT_SET_ELEM_BUSY_BIT, word);
148969086658SPatrick McHardy }
149069086658SPatrick McHardy 
14911a1e1a12SPatrick McHardy /**
14921a1e1a12SPatrick McHardy  *	struct nft_trans - nf_tables object update in transaction
14931a1e1a12SPatrick McHardy  *
14941a1e1a12SPatrick McHardy  *	@list: used internally
14951a1e1a12SPatrick McHardy  *	@msg_type: message type
14960935d558SFlorian Westphal  *	@put_net: ctx->net needs to be put
14971a1e1a12SPatrick McHardy  *	@ctx: transaction context
14981a1e1a12SPatrick McHardy  *	@data: internal information related to the transaction
14991a1e1a12SPatrick McHardy  */
15001a1e1a12SPatrick McHardy struct nft_trans {
15011a1e1a12SPatrick McHardy 	struct list_head		list;
15021a1e1a12SPatrick McHardy 	int				msg_type;
15030935d558SFlorian Westphal 	bool				put_net;
15041a1e1a12SPatrick McHardy 	struct nft_ctx			ctx;
15056daf1414SGustavo A. R. Silva 	char				data[];
15061a1e1a12SPatrick McHardy };
15071a1e1a12SPatrick McHardy 
15081a1e1a12SPatrick McHardy struct nft_trans_rule {
15091a1e1a12SPatrick McHardy 	struct nft_rule			*rule;
1510c9626a2cSPablo Neira Ayuso 	struct nft_flow_rule		*flow;
15111a94e38dSPablo Neira Ayuso 	u32				rule_id;
15121a1e1a12SPatrick McHardy };
15131a1e1a12SPatrick McHardy 
15141a1e1a12SPatrick McHardy #define nft_trans_rule(trans)	\
15151a1e1a12SPatrick McHardy 	(((struct nft_trans_rule *)trans->data)->rule)
1516c9626a2cSPablo Neira Ayuso #define nft_trans_flow_rule(trans)	\
1517c9626a2cSPablo Neira Ayuso 	(((struct nft_trans_rule *)trans->data)->flow)
15181a94e38dSPablo Neira Ayuso #define nft_trans_rule_id(trans)	\
15191a94e38dSPablo Neira Ayuso 	(((struct nft_trans_rule *)trans->data)->rule_id)
15201a1e1a12SPatrick McHardy 
15211a1e1a12SPatrick McHardy struct nft_trans_set {
15221a1e1a12SPatrick McHardy 	struct nft_set			*set;
15231a1e1a12SPatrick McHardy 	u32				set_id;
15246a0a8d10SPablo Neira Ayuso 	bool				bound;
15251a1e1a12SPatrick McHardy };
15261a1e1a12SPatrick McHardy 
15271a1e1a12SPatrick McHardy #define nft_trans_set(trans)	\
15281a1e1a12SPatrick McHardy 	(((struct nft_trans_set *)trans->data)->set)
15291a1e1a12SPatrick McHardy #define nft_trans_set_id(trans)	\
15301a1e1a12SPatrick McHardy 	(((struct nft_trans_set *)trans->data)->set_id)
15316a0a8d10SPablo Neira Ayuso #define nft_trans_set_bound(trans)	\
15326a0a8d10SPablo Neira Ayuso 	(((struct nft_trans_set *)trans->data)->bound)
15331a1e1a12SPatrick McHardy 
15341a1e1a12SPatrick McHardy struct nft_trans_chain {
15351a1e1a12SPatrick McHardy 	bool				update;
1536b7263e07SPhil Sutter 	char				*name;
15371a1e1a12SPatrick McHardy 	struct nft_stats __percpu	*stats;
15381a1e1a12SPatrick McHardy 	u8				policy;
153974cccc3dSPablo Neira Ayuso 	u32				chain_id;
15401a1e1a12SPatrick McHardy };
15411a1e1a12SPatrick McHardy 
15421a1e1a12SPatrick McHardy #define nft_trans_chain_update(trans)	\
15431a1e1a12SPatrick McHardy 	(((struct nft_trans_chain *)trans->data)->update)
15441a1e1a12SPatrick McHardy #define nft_trans_chain_name(trans)	\
15451a1e1a12SPatrick McHardy 	(((struct nft_trans_chain *)trans->data)->name)
15461a1e1a12SPatrick McHardy #define nft_trans_chain_stats(trans)	\
15471a1e1a12SPatrick McHardy 	(((struct nft_trans_chain *)trans->data)->stats)
15481a1e1a12SPatrick McHardy #define nft_trans_chain_policy(trans)	\
15491a1e1a12SPatrick McHardy 	(((struct nft_trans_chain *)trans->data)->policy)
155074cccc3dSPablo Neira Ayuso #define nft_trans_chain_id(trans)	\
155174cccc3dSPablo Neira Ayuso 	(((struct nft_trans_chain *)trans->data)->chain_id)
15521a1e1a12SPatrick McHardy 
15531a1e1a12SPatrick McHardy struct nft_trans_table {
15541a1e1a12SPatrick McHardy 	bool				update;
15551a1e1a12SPatrick McHardy };
15561a1e1a12SPatrick McHardy 
15571a1e1a12SPatrick McHardy #define nft_trans_table_update(trans)	\
15581a1e1a12SPatrick McHardy 	(((struct nft_trans_table *)trans->data)->update)
15591a1e1a12SPatrick McHardy 
15601a1e1a12SPatrick McHardy struct nft_trans_elem {
15611a1e1a12SPatrick McHardy 	struct nft_set			*set;
15621a1e1a12SPatrick McHardy 	struct nft_set_elem		elem;
15636a0a8d10SPablo Neira Ayuso 	bool				bound;
15641a1e1a12SPatrick McHardy };
15651a1e1a12SPatrick McHardy 
15661a1e1a12SPatrick McHardy #define nft_trans_elem_set(trans)	\
15671a1e1a12SPatrick McHardy 	(((struct nft_trans_elem *)trans->data)->set)
15681a1e1a12SPatrick McHardy #define nft_trans_elem(trans)	\
15691a1e1a12SPatrick McHardy 	(((struct nft_trans_elem *)trans->data)->elem)
15706a0a8d10SPablo Neira Ayuso #define nft_trans_elem_set_bound(trans)	\
15716a0a8d10SPablo Neira Ayuso 	(((struct nft_trans_elem *)trans->data)->bound)
15721a1e1a12SPatrick McHardy 
1573e5009240SPablo Neira Ayuso struct nft_trans_obj {
1574e5009240SPablo Neira Ayuso 	struct nft_object		*obj;
1575d62d0ba9SFernando Fernandez Mancera 	struct nft_object		*newobj;
1576d62d0ba9SFernando Fernandez Mancera 	bool				update;
1577e5009240SPablo Neira Ayuso };
1578e5009240SPablo Neira Ayuso 
1579e5009240SPablo Neira Ayuso #define nft_trans_obj(trans)	\
1580e5009240SPablo Neira Ayuso 	(((struct nft_trans_obj *)trans->data)->obj)
1581d62d0ba9SFernando Fernandez Mancera #define nft_trans_obj_newobj(trans) \
1582d62d0ba9SFernando Fernandez Mancera 	(((struct nft_trans_obj *)trans->data)->newobj)
1583d62d0ba9SFernando Fernandez Mancera #define nft_trans_obj_update(trans)	\
1584d62d0ba9SFernando Fernandez Mancera 	(((struct nft_trans_obj *)trans->data)->update)
1585e5009240SPablo Neira Ayuso 
15863b49e2e9SPablo Neira Ayuso struct nft_trans_flowtable {
15873b49e2e9SPablo Neira Ayuso 	struct nft_flowtable		*flowtable;
158878d9f48fSPablo Neira Ayuso 	bool				update;
158978d9f48fSPablo Neira Ayuso 	struct list_head		hook_list;
15907b35582cSPablo Neira Ayuso 	u32				flags;
15913b49e2e9SPablo Neira Ayuso };
15923b49e2e9SPablo Neira Ayuso 
15933b49e2e9SPablo Neira Ayuso #define nft_trans_flowtable(trans)	\
15943b49e2e9SPablo Neira Ayuso 	(((struct nft_trans_flowtable *)trans->data)->flowtable)
159578d9f48fSPablo Neira Ayuso #define nft_trans_flowtable_update(trans)	\
159678d9f48fSPablo Neira Ayuso 	(((struct nft_trans_flowtable *)trans->data)->update)
159778d9f48fSPablo Neira Ayuso #define nft_trans_flowtable_hooks(trans)	\
159878d9f48fSPablo Neira Ayuso 	(((struct nft_trans_flowtable *)trans->data)->hook_list)
15997b35582cSPablo Neira Ayuso #define nft_trans_flowtable_flags(trans)	\
16007b35582cSPablo Neira Ayuso 	(((struct nft_trans_flowtable *)trans->data)->flags)
16013b49e2e9SPablo Neira Ayuso 
160202c7b25eSPablo Neira Ayuso int __init nft_chain_filter_init(void);
1603d209df3eSFlorian Westphal void nft_chain_filter_fini(void);
160402c7b25eSPablo Neira Ayuso 
1605c1deb065SFlorian Westphal void __init nft_chain_route_init(void);
1606c1deb065SFlorian Westphal void nft_chain_route_fini(void);
1607ffe8923fSFlorian Westphal 
1608ffe8923fSFlorian Westphal void nf_tables_trans_destroy_flush_work(void);
1609917d80d3SPablo Neira Ayuso 
1610917d80d3SPablo Neira Ayuso int nf_msecs_to_jiffies64(const struct nlattr *nla, u64 *result);
1611917d80d3SPablo Neira Ayuso __be64 nf_jiffies64_to_msecs(u64 input);
1612917d80d3SPablo Neira Ayuso 
1613cefa31a9SFlorian Westphal #ifdef CONFIG_MODULES
1614cefa31a9SFlorian Westphal __printf(2, 3) int nft_request_module(struct net *net, const char *fmt, ...);
1615cefa31a9SFlorian Westphal #else
1616cefa31a9SFlorian Westphal static inline int nft_request_module(struct net *net, const char *fmt, ...) { return -ENOENT; }
1617cefa31a9SFlorian Westphal #endif
16180854db2aSFlorian Westphal 
16190854db2aSFlorian Westphal struct nftables_pernet {
16200854db2aSFlorian Westphal 	struct list_head	tables;
16210854db2aSFlorian Westphal 	struct list_head	commit_list;
16220854db2aSFlorian Westphal 	struct list_head	module_list;
16230854db2aSFlorian Westphal 	struct list_head	notify_list;
16240854db2aSFlorian Westphal 	struct mutex		commit_mutex;
16250854db2aSFlorian Westphal 	unsigned int		base_seq;
16260854db2aSFlorian Westphal 	u8			validate_state;
16270854db2aSFlorian Westphal };
16280854db2aSFlorian Westphal 
1629d59d2f82SPablo Neira Ayuso extern unsigned int nf_tables_net_id;
1630d59d2f82SPablo Neira Ayuso 
1631d59d2f82SPablo Neira Ayuso static inline struct nftables_pernet *nft_pernet(const struct net *net)
1632d59d2f82SPablo Neira Ayuso {
1633d59d2f82SPablo Neira Ayuso 	return net_generic(net, nf_tables_net_id);
1634d59d2f82SPablo Neira Ayuso }
1635d59d2f82SPablo Neira Ayuso 
163696518518SPatrick McHardy #endif /* _NET_NF_TABLES_H */
1637