1 /* SPDX-License-Identifier: GPL-2.0 */
2 #ifndef _NET_NF_TABLES_H
3 #define _NET_NF_TABLES_H
4
5 #include <asm/unaligned.h>
6 #include <linux/list.h>
7 #include <linux/netfilter.h>
8 #include <linux/netfilter/nfnetlink.h>
9 #include <linux/netfilter/x_tables.h>
10 #include <linux/netfilter/nf_tables.h>
11 #include <linux/u64_stats_sync.h>
12 #include <linux/rhashtable.h>
13 #include <net/netfilter/nf_flow_table.h>
14 #include <net/netlink.h>
15 #include <net/flow_offload.h>
16 #include <net/netns/generic.h>
17
18 #define NFT_MAX_HOOKS (NF_INET_INGRESS + 1)
19
20 struct module;
21
22 #define NFT_JUMP_STACK_SIZE 16
23
24 enum {
25 NFT_PKTINFO_L4PROTO = (1 << 0),
26 NFT_PKTINFO_INNER = (1 << 1),
27 NFT_PKTINFO_INNER_FULL = (1 << 2),
28 };
29
30 struct nft_pktinfo {
31 struct sk_buff *skb;
32 const struct nf_hook_state *state;
33 u8 flags;
34 u8 tprot;
35 u16 fragoff;
36 u16 thoff;
37 u16 inneroff;
38 };
39
nft_sk(const struct nft_pktinfo * pkt)40 static inline struct sock *nft_sk(const struct nft_pktinfo *pkt)
41 {
42 return pkt->state->sk;
43 }
44
nft_thoff(const struct nft_pktinfo * pkt)45 static inline unsigned int nft_thoff(const struct nft_pktinfo *pkt)
46 {
47 return pkt->thoff;
48 }
49
nft_net(const struct nft_pktinfo * pkt)50 static inline struct net *nft_net(const struct nft_pktinfo *pkt)
51 {
52 return pkt->state->net;
53 }
54
nft_hook(const struct nft_pktinfo * pkt)55 static inline unsigned int nft_hook(const struct nft_pktinfo *pkt)
56 {
57 return pkt->state->hook;
58 }
59
nft_pf(const struct nft_pktinfo * pkt)60 static inline u8 nft_pf(const struct nft_pktinfo *pkt)
61 {
62 return pkt->state->pf;
63 }
64
nft_in(const struct nft_pktinfo * pkt)65 static inline const struct net_device *nft_in(const struct nft_pktinfo *pkt)
66 {
67 return pkt->state->in;
68 }
69
nft_out(const struct nft_pktinfo * pkt)70 static inline const struct net_device *nft_out(const struct nft_pktinfo *pkt)
71 {
72 return pkt->state->out;
73 }
74
nft_set_pktinfo(struct nft_pktinfo * pkt,struct sk_buff * skb,const struct nf_hook_state * state)75 static inline void nft_set_pktinfo(struct nft_pktinfo *pkt,
76 struct sk_buff *skb,
77 const struct nf_hook_state *state)
78 {
79 pkt->skb = skb;
80 pkt->state = state;
81 }
82
nft_set_pktinfo_unspec(struct nft_pktinfo * pkt)83 static inline void nft_set_pktinfo_unspec(struct nft_pktinfo *pkt)
84 {
85 pkt->flags = 0;
86 pkt->tprot = 0;
87 pkt->thoff = 0;
88 pkt->fragoff = 0;
89 }
90
91 /**
92 * struct nft_verdict - nf_tables verdict
93 *
94 * @code: nf_tables/netfilter verdict code
95 * @chain: destination chain for NFT_JUMP/NFT_GOTO
96 */
97 struct nft_verdict {
98 u32 code;
99 struct nft_chain *chain;
100 };
101
102 struct nft_data {
103 union {
104 u32 data[4];
105 struct nft_verdict verdict;
106 };
107 } __attribute__((aligned(__alignof__(u64))));
108
109 #define NFT_REG32_NUM 20
110
111 /**
112 * struct nft_regs - nf_tables register set
113 *
114 * @data: data registers
115 * @verdict: verdict register
116 *
117 * The first four data registers alias to the verdict register.
118 */
119 struct nft_regs {
120 union {
121 u32 data[NFT_REG32_NUM];
122 struct nft_verdict verdict;
123 };
124 };
125
126 struct nft_regs_track {
127 struct {
128 const struct nft_expr *selector;
129 const struct nft_expr *bitwise;
130 u8 num_reg;
131 } regs[NFT_REG32_NUM];
132
133 const struct nft_expr *cur;
134 const struct nft_expr *last;
135 };
136
137 /* Store/load an u8, u16 or u64 integer to/from the u32 data register.
138 *
139 * Note, when using concatenations, register allocation happens at 32-bit
140 * level. So for store instruction, pad the rest part with zero to avoid
141 * garbage values.
142 */
143
nft_reg_store8(u32 * dreg,u8 val)144 static inline void nft_reg_store8(u32 *dreg, u8 val)
145 {
146 *dreg = 0;
147 *(u8 *)dreg = val;
148 }
149
nft_reg_load8(const u32 * sreg)150 static inline u8 nft_reg_load8(const u32 *sreg)
151 {
152 return *(u8 *)sreg;
153 }
154
nft_reg_store16(u32 * dreg,u16 val)155 static inline void nft_reg_store16(u32 *dreg, u16 val)
156 {
157 *dreg = 0;
158 *(u16 *)dreg = val;
159 }
160
nft_reg_store_be16(u32 * dreg,__be16 val)161 static inline void nft_reg_store_be16(u32 *dreg, __be16 val)
162 {
163 nft_reg_store16(dreg, (__force __u16)val);
164 }
165
nft_reg_load16(const u32 * sreg)166 static inline u16 nft_reg_load16(const u32 *sreg)
167 {
168 return *(u16 *)sreg;
169 }
170
nft_reg_load_be16(const u32 * sreg)171 static inline __be16 nft_reg_load_be16(const u32 *sreg)
172 {
173 return (__force __be16)nft_reg_load16(sreg);
174 }
175
nft_reg_load_be32(const u32 * sreg)176 static inline __be32 nft_reg_load_be32(const u32 *sreg)
177 {
178 return *(__force __be32 *)sreg;
179 }
180
nft_reg_store64(u32 * dreg,u64 val)181 static inline void nft_reg_store64(u32 *dreg, u64 val)
182 {
183 put_unaligned(val, (u64 *)dreg);
184 }
185
nft_reg_load64(const u32 * sreg)186 static inline u64 nft_reg_load64(const u32 *sreg)
187 {
188 return get_unaligned((u64 *)sreg);
189 }
190
nft_data_copy(u32 * dst,const struct nft_data * src,unsigned int len)191 static inline void nft_data_copy(u32 *dst, const struct nft_data *src,
192 unsigned int len)
193 {
194 if (len % NFT_REG32_SIZE)
195 dst[len / NFT_REG32_SIZE] = 0;
196 memcpy(dst, src, len);
197 }
198
199 /**
200 * struct nft_ctx - nf_tables rule/set context
201 *
202 * @net: net namespace
203 * @table: the table the chain is contained in
204 * @chain: the chain the rule is contained in
205 * @nla: netlink attributes
206 * @portid: netlink portID of the original message
207 * @seq: netlink sequence number
208 * @family: protocol family
209 * @level: depth of the chains
210 * @report: notify via unicast netlink message
211 */
212 struct nft_ctx {
213 struct net *net;
214 struct nft_table *table;
215 struct nft_chain *chain;
216 const struct nlattr * const *nla;
217 u32 portid;
218 u32 seq;
219 u16 flags;
220 u8 family;
221 u8 level;
222 bool report;
223 };
224
225 enum nft_data_desc_flags {
226 NFT_DATA_DESC_SETELEM = (1 << 0),
227 };
228
229 struct nft_data_desc {
230 enum nft_data_types type;
231 unsigned int size;
232 unsigned int len;
233 unsigned int flags;
234 };
235
236 int nft_data_init(const struct nft_ctx *ctx, struct nft_data *data,
237 struct nft_data_desc *desc, const struct nlattr *nla);
238 void nft_data_hold(const struct nft_data *data, enum nft_data_types type);
239 void nft_data_release(const struct nft_data *data, enum nft_data_types type);
240 int nft_data_dump(struct sk_buff *skb, int attr, const struct nft_data *data,
241 enum nft_data_types type, unsigned int len);
242
nft_dreg_to_type(enum nft_registers reg)243 static inline enum nft_data_types nft_dreg_to_type(enum nft_registers reg)
244 {
245 return reg == NFT_REG_VERDICT ? NFT_DATA_VERDICT : NFT_DATA_VALUE;
246 }
247
nft_type_to_reg(enum nft_data_types type)248 static inline enum nft_registers nft_type_to_reg(enum nft_data_types type)
249 {
250 return type == NFT_DATA_VERDICT ? NFT_REG_VERDICT : NFT_REG_1 * NFT_REG_SIZE / NFT_REG32_SIZE;
251 }
252
253 int nft_parse_u32_check(const struct nlattr *attr, int max, u32 *dest);
254 int nft_dump_register(struct sk_buff *skb, unsigned int attr, unsigned int reg);
255
256 int nft_parse_register_load(const struct nlattr *attr, u8 *sreg, u32 len);
257 int nft_parse_register_store(const struct nft_ctx *ctx,
258 const struct nlattr *attr, u8 *dreg,
259 const struct nft_data *data,
260 enum nft_data_types type, unsigned int len);
261
262 /**
263 * struct nft_userdata - user defined data associated with an object
264 *
265 * @len: length of the data
266 * @data: content
267 *
268 * The presence of user data is indicated in an object specific fashion,
269 * so a length of zero can't occur and the value "len" indicates data
270 * of length len + 1.
271 */
272 struct nft_userdata {
273 u8 len;
274 unsigned char data[];
275 };
276
277 /**
278 * struct nft_set_elem - generic representation of set elements
279 *
280 * @key: element key
281 * @key_end: closing element key
282 * @priv: element private data and extensions
283 */
284 struct nft_set_elem {
285 union {
286 u32 buf[NFT_DATA_VALUE_MAXLEN / sizeof(u32)];
287 struct nft_data val;
288 } key;
289 union {
290 u32 buf[NFT_DATA_VALUE_MAXLEN / sizeof(u32)];
291 struct nft_data val;
292 } key_end;
293 union {
294 u32 buf[NFT_DATA_VALUE_MAXLEN / sizeof(u32)];
295 struct nft_data val;
296 } data;
297 void *priv;
298 };
299
300 struct nft_set;
301 struct nft_set_iter {
302 u8 genmask;
303 unsigned int count;
304 unsigned int skip;
305 int err;
306 int (*fn)(const struct nft_ctx *ctx,
307 struct nft_set *set,
308 const struct nft_set_iter *iter,
309 struct nft_set_elem *elem);
310 };
311
312 /**
313 * struct nft_set_desc - description of set elements
314 *
315 * @ktype: key type
316 * @klen: key length
317 * @dtype: data type
318 * @dlen: data length
319 * @objtype: object type
320 * @flags: flags
321 * @size: number of set elements
322 * @policy: set policy
323 * @gc_int: garbage collector interval
324 * @field_len: length of each field in concatenation, bytes
325 * @field_count: number of concatenated fields in element
326 * @expr: set must support for expressions
327 */
328 struct nft_set_desc {
329 u32 ktype;
330 unsigned int klen;
331 u32 dtype;
332 unsigned int dlen;
333 u32 objtype;
334 unsigned int size;
335 u32 policy;
336 u32 gc_int;
337 u64 timeout;
338 u8 field_len[NFT_REG32_COUNT];
339 u8 field_count;
340 bool expr;
341 };
342
343 /**
344 * enum nft_set_class - performance class
345 *
346 * @NFT_LOOKUP_O_1: constant, O(1)
347 * @NFT_LOOKUP_O_LOG_N: logarithmic, O(log N)
348 * @NFT_LOOKUP_O_N: linear, O(N)
349 */
350 enum nft_set_class {
351 NFT_SET_CLASS_O_1,
352 NFT_SET_CLASS_O_LOG_N,
353 NFT_SET_CLASS_O_N,
354 };
355
356 /**
357 * struct nft_set_estimate - estimation of memory and performance
358 * characteristics
359 *
360 * @size: required memory
361 * @lookup: lookup performance class
362 * @space: memory class
363 */
364 struct nft_set_estimate {
365 u64 size;
366 enum nft_set_class lookup;
367 enum nft_set_class space;
368 };
369
370 #define NFT_EXPR_MAXATTR 16
371 #define NFT_EXPR_SIZE(size) (sizeof(struct nft_expr) + \
372 ALIGN(size, __alignof__(struct nft_expr)))
373
374 /**
375 * struct nft_expr - nf_tables expression
376 *
377 * @ops: expression ops
378 * @data: expression private data
379 */
380 struct nft_expr {
381 const struct nft_expr_ops *ops;
382 unsigned char data[]
383 __attribute__((aligned(__alignof__(u64))));
384 };
385
nft_expr_priv(const struct nft_expr * expr)386 static inline void *nft_expr_priv(const struct nft_expr *expr)
387 {
388 return (void *)expr->data;
389 }
390
391 struct nft_expr_info;
392
393 int nft_expr_inner_parse(const struct nft_ctx *ctx, const struct nlattr *nla,
394 struct nft_expr_info *info);
395 int nft_expr_clone(struct nft_expr *dst, struct nft_expr *src);
396 void nft_expr_destroy(const struct nft_ctx *ctx, struct nft_expr *expr);
397 int nft_expr_dump(struct sk_buff *skb, unsigned int attr,
398 const struct nft_expr *expr, bool reset);
399 bool nft_expr_reduce_bitwise(struct nft_regs_track *track,
400 const struct nft_expr *expr);
401
402 struct nft_set_ext;
403
404 /**
405 * struct nft_set_ops - nf_tables set operations
406 *
407 * @lookup: look up an element within the set
408 * @update: update an element if exists, add it if doesn't exist
409 * @delete: delete an element
410 * @insert: insert new element into set
411 * @activate: activate new element in the next generation
412 * @deactivate: lookup for element and deactivate it in the next generation
413 * @flush: deactivate element in the next generation
414 * @remove: remove element from set
415 * @walk: iterate over all set elements
416 * @get: get set elements
417 * @privsize: function to return size of set private data
418 * @init: initialize private data of new set instance
419 * @destroy: destroy private data of set instance
420 * @elemsize: element private size
421 *
422 * Operations lookup, update and delete have simpler interfaces, are faster
423 * and currently only used in the packet path. All the rest are slower,
424 * control plane functions.
425 */
426 struct nft_set_ops {
427 bool (*lookup)(const struct net *net,
428 const struct nft_set *set,
429 const u32 *key,
430 const struct nft_set_ext **ext);
431 bool (*update)(struct nft_set *set,
432 const u32 *key,
433 void *(*new)(struct nft_set *,
434 const struct nft_expr *,
435 struct nft_regs *),
436 const struct nft_expr *expr,
437 struct nft_regs *regs,
438 const struct nft_set_ext **ext);
439 bool (*delete)(const struct nft_set *set,
440 const u32 *key);
441
442 int (*insert)(const struct net *net,
443 const struct nft_set *set,
444 const struct nft_set_elem *elem,
445 struct nft_set_ext **ext);
446 void (*activate)(const struct net *net,
447 const struct nft_set *set,
448 const struct nft_set_elem *elem);
449 void * (*deactivate)(const struct net *net,
450 const struct nft_set *set,
451 const struct nft_set_elem *elem);
452 bool (*flush)(const struct net *net,
453 const struct nft_set *set,
454 void *priv);
455 void (*remove)(const struct net *net,
456 const struct nft_set *set,
457 const struct nft_set_elem *elem);
458 void (*walk)(const struct nft_ctx *ctx,
459 struct nft_set *set,
460 struct nft_set_iter *iter);
461 void * (*get)(const struct net *net,
462 const struct nft_set *set,
463 const struct nft_set_elem *elem,
464 unsigned int flags);
465
466 u64 (*privsize)(const struct nlattr * const nla[],
467 const struct nft_set_desc *desc);
468 bool (*estimate)(const struct nft_set_desc *desc,
469 u32 features,
470 struct nft_set_estimate *est);
471 int (*init)(const struct nft_set *set,
472 const struct nft_set_desc *desc,
473 const struct nlattr * const nla[]);
474 void (*destroy)(const struct nft_set *set);
475 void (*gc_init)(const struct nft_set *set);
476
477 unsigned int elemsize;
478 };
479
480 /**
481 * struct nft_set_type - nf_tables set type
482 *
483 * @ops: set ops for this type
484 * @features: features supported by the implementation
485 */
486 struct nft_set_type {
487 const struct nft_set_ops ops;
488 u32 features;
489 };
490 #define to_set_type(o) container_of(o, struct nft_set_type, ops)
491
492 struct nft_set_elem_expr {
493 u8 size;
494 unsigned char data[]
495 __attribute__((aligned(__alignof__(struct nft_expr))));
496 };
497
498 #define nft_setelem_expr_at(__elem_expr, __offset) \
499 ((struct nft_expr *)&__elem_expr->data[__offset])
500
501 #define nft_setelem_expr_foreach(__expr, __elem_expr, __size) \
502 for (__expr = nft_setelem_expr_at(__elem_expr, 0), __size = 0; \
503 __size < (__elem_expr)->size; \
504 __size += (__expr)->ops->size, __expr = ((void *)(__expr)) + (__expr)->ops->size)
505
506 #define NFT_SET_EXPR_MAX 2
507
508 /**
509 * struct nft_set - nf_tables set instance
510 *
511 * @list: table set list node
512 * @bindings: list of set bindings
513 * @table: table this set belongs to
514 * @net: netnamespace this set belongs to
515 * @name: name of the set
516 * @handle: unique handle of the set
517 * @ktype: key type (numeric type defined by userspace, not used in the kernel)
518 * @dtype: data type (verdict or numeric type defined by userspace)
519 * @objtype: object type (see NFT_OBJECT_* definitions)
520 * @size: maximum set size
521 * @field_len: length of each field in concatenation, bytes
522 * @field_count: number of concatenated fields in element
523 * @use: number of rules references to this set
524 * @nelems: number of elements
525 * @ndeact: number of deactivated elements queued for removal
526 * @timeout: default timeout value in jiffies
527 * @gc_int: garbage collection interval in msecs
528 * @policy: set parameterization (see enum nft_set_policies)
529 * @udlen: user data length
530 * @udata: user data
531 * @expr: stateful expression
532 * @ops: set ops
533 * @flags: set flags
534 * @genmask: generation mask
535 * @klen: key length
536 * @dlen: data length
537 * @data: private set data
538 */
539 struct nft_set {
540 struct list_head list;
541 struct list_head bindings;
542 struct nft_table *table;
543 possible_net_t net;
544 char *name;
545 u64 handle;
546 u32 ktype;
547 u32 dtype;
548 u32 objtype;
549 u32 size;
550 u8 field_len[NFT_REG32_COUNT];
551 u8 field_count;
552 u32 use;
553 atomic_t nelems;
554 u32 ndeact;
555 u64 timeout;
556 u32 gc_int;
557 u16 policy;
558 u16 udlen;
559 unsigned char *udata;
560 /* runtime data below here */
561 const struct nft_set_ops *ops ____cacheline_aligned;
562 u16 flags:14,
563 genmask:2;
564 u8 klen;
565 u8 dlen;
566 u8 num_exprs;
567 struct nft_expr *exprs[NFT_SET_EXPR_MAX];
568 struct list_head catchall_list;
569 unsigned char data[]
570 __attribute__((aligned(__alignof__(u64))));
571 };
572
nft_set_is_anonymous(const struct nft_set * set)573 static inline bool nft_set_is_anonymous(const struct nft_set *set)
574 {
575 return set->flags & NFT_SET_ANONYMOUS;
576 }
577
nft_set_priv(const struct nft_set * set)578 static inline void *nft_set_priv(const struct nft_set *set)
579 {
580 return (void *)set->data;
581 }
582
nft_set_container_of(const void * priv)583 static inline struct nft_set *nft_set_container_of(const void *priv)
584 {
585 return (void *)priv - offsetof(struct nft_set, data);
586 }
587
588 struct nft_set *nft_set_lookup_global(const struct net *net,
589 const struct nft_table *table,
590 const struct nlattr *nla_set_name,
591 const struct nlattr *nla_set_id,
592 u8 genmask);
593
594 struct nft_set_ext *nft_set_catchall_lookup(const struct net *net,
595 const struct nft_set *set);
596 void *nft_set_catchall_gc(const struct nft_set *set);
597
nft_set_gc_interval(const struct nft_set * set)598 static inline unsigned long nft_set_gc_interval(const struct nft_set *set)
599 {
600 u32 gc_int = READ_ONCE(set->gc_int);
601
602 return gc_int ? msecs_to_jiffies(gc_int) : HZ;
603 }
604
605 /**
606 * struct nft_set_binding - nf_tables set binding
607 *
608 * @list: set bindings list node
609 * @chain: chain containing the rule bound to the set
610 * @flags: set action flags
611 *
612 * A set binding contains all information necessary for validation
613 * of new elements added to a bound set.
614 */
615 struct nft_set_binding {
616 struct list_head list;
617 const struct nft_chain *chain;
618 u32 flags;
619 };
620
621 enum nft_trans_phase;
622 void nf_tables_deactivate_set(const struct nft_ctx *ctx, struct nft_set *set,
623 struct nft_set_binding *binding,
624 enum nft_trans_phase phase);
625 int nf_tables_bind_set(const struct nft_ctx *ctx, struct nft_set *set,
626 struct nft_set_binding *binding);
627 void nf_tables_destroy_set(const struct nft_ctx *ctx, struct nft_set *set);
628
629 /**
630 * enum nft_set_extensions - set extension type IDs
631 *
632 * @NFT_SET_EXT_KEY: element key
633 * @NFT_SET_EXT_KEY_END: upper bound element key, for ranges
634 * @NFT_SET_EXT_DATA: mapping data
635 * @NFT_SET_EXT_FLAGS: element flags
636 * @NFT_SET_EXT_TIMEOUT: element timeout
637 * @NFT_SET_EXT_EXPIRATION: element expiration time
638 * @NFT_SET_EXT_USERDATA: user data associated with the element
639 * @NFT_SET_EXT_EXPRESSIONS: expressions assiciated with the element
640 * @NFT_SET_EXT_OBJREF: stateful object reference associated with element
641 * @NFT_SET_EXT_NUM: number of extension types
642 */
643 enum nft_set_extensions {
644 NFT_SET_EXT_KEY,
645 NFT_SET_EXT_KEY_END,
646 NFT_SET_EXT_DATA,
647 NFT_SET_EXT_FLAGS,
648 NFT_SET_EXT_TIMEOUT,
649 NFT_SET_EXT_EXPIRATION,
650 NFT_SET_EXT_USERDATA,
651 NFT_SET_EXT_EXPRESSIONS,
652 NFT_SET_EXT_OBJREF,
653 NFT_SET_EXT_NUM
654 };
655
656 /**
657 * struct nft_set_ext_type - set extension type
658 *
659 * @len: fixed part length of the extension
660 * @align: alignment requirements of the extension
661 */
662 struct nft_set_ext_type {
663 u8 len;
664 u8 align;
665 };
666
667 extern const struct nft_set_ext_type nft_set_ext_types[];
668
669 /**
670 * struct nft_set_ext_tmpl - set extension template
671 *
672 * @len: length of extension area
673 * @offset: offsets of individual extension types
674 */
675 struct nft_set_ext_tmpl {
676 u16 len;
677 u8 offset[NFT_SET_EXT_NUM];
678 u8 ext_len[NFT_SET_EXT_NUM];
679 };
680
681 /**
682 * struct nft_set_ext - set extensions
683 *
684 * @genmask: generation mask
685 * @offset: offsets of individual extension types
686 * @data: beginning of extension data
687 */
688 struct nft_set_ext {
689 u8 genmask;
690 u8 offset[NFT_SET_EXT_NUM];
691 char data[];
692 };
693
nft_set_ext_prepare(struct nft_set_ext_tmpl * tmpl)694 static inline void nft_set_ext_prepare(struct nft_set_ext_tmpl *tmpl)
695 {
696 memset(tmpl, 0, sizeof(*tmpl));
697 tmpl->len = sizeof(struct nft_set_ext);
698 }
699
nft_set_ext_add_length(struct nft_set_ext_tmpl * tmpl,u8 id,unsigned int len)700 static inline int nft_set_ext_add_length(struct nft_set_ext_tmpl *tmpl, u8 id,
701 unsigned int len)
702 {
703 tmpl->len = ALIGN(tmpl->len, nft_set_ext_types[id].align);
704 if (tmpl->len > U8_MAX)
705 return -EINVAL;
706
707 tmpl->offset[id] = tmpl->len;
708 tmpl->ext_len[id] = nft_set_ext_types[id].len + len;
709 tmpl->len += tmpl->ext_len[id];
710
711 return 0;
712 }
713
nft_set_ext_add(struct nft_set_ext_tmpl * tmpl,u8 id)714 static inline int nft_set_ext_add(struct nft_set_ext_tmpl *tmpl, u8 id)
715 {
716 return nft_set_ext_add_length(tmpl, id, 0);
717 }
718
nft_set_ext_init(struct nft_set_ext * ext,const struct nft_set_ext_tmpl * tmpl)719 static inline void nft_set_ext_init(struct nft_set_ext *ext,
720 const struct nft_set_ext_tmpl *tmpl)
721 {
722 memcpy(ext->offset, tmpl->offset, sizeof(ext->offset));
723 }
724
__nft_set_ext_exists(const struct nft_set_ext * ext,u8 id)725 static inline bool __nft_set_ext_exists(const struct nft_set_ext *ext, u8 id)
726 {
727 return !!ext->offset[id];
728 }
729
nft_set_ext_exists(const struct nft_set_ext * ext,u8 id)730 static inline bool nft_set_ext_exists(const struct nft_set_ext *ext, u8 id)
731 {
732 return ext && __nft_set_ext_exists(ext, id);
733 }
734
nft_set_ext(const struct nft_set_ext * ext,u8 id)735 static inline void *nft_set_ext(const struct nft_set_ext *ext, u8 id)
736 {
737 return (void *)ext + ext->offset[id];
738 }
739
nft_set_ext_key(const struct nft_set_ext * ext)740 static inline struct nft_data *nft_set_ext_key(const struct nft_set_ext *ext)
741 {
742 return nft_set_ext(ext, NFT_SET_EXT_KEY);
743 }
744
nft_set_ext_key_end(const struct nft_set_ext * ext)745 static inline struct nft_data *nft_set_ext_key_end(const struct nft_set_ext *ext)
746 {
747 return nft_set_ext(ext, NFT_SET_EXT_KEY_END);
748 }
749
nft_set_ext_data(const struct nft_set_ext * ext)750 static inline struct nft_data *nft_set_ext_data(const struct nft_set_ext *ext)
751 {
752 return nft_set_ext(ext, NFT_SET_EXT_DATA);
753 }
754
nft_set_ext_flags(const struct nft_set_ext * ext)755 static inline u8 *nft_set_ext_flags(const struct nft_set_ext *ext)
756 {
757 return nft_set_ext(ext, NFT_SET_EXT_FLAGS);
758 }
759
nft_set_ext_timeout(const struct nft_set_ext * ext)760 static inline u64 *nft_set_ext_timeout(const struct nft_set_ext *ext)
761 {
762 return nft_set_ext(ext, NFT_SET_EXT_TIMEOUT);
763 }
764
nft_set_ext_expiration(const struct nft_set_ext * ext)765 static inline u64 *nft_set_ext_expiration(const struct nft_set_ext *ext)
766 {
767 return nft_set_ext(ext, NFT_SET_EXT_EXPIRATION);
768 }
769
nft_set_ext_userdata(const struct nft_set_ext * ext)770 static inline struct nft_userdata *nft_set_ext_userdata(const struct nft_set_ext *ext)
771 {
772 return nft_set_ext(ext, NFT_SET_EXT_USERDATA);
773 }
774
nft_set_ext_expr(const struct nft_set_ext * ext)775 static inline struct nft_set_elem_expr *nft_set_ext_expr(const struct nft_set_ext *ext)
776 {
777 return nft_set_ext(ext, NFT_SET_EXT_EXPRESSIONS);
778 }
779
nft_set_elem_expired(const struct nft_set_ext * ext)780 static inline bool nft_set_elem_expired(const struct nft_set_ext *ext)
781 {
782 return nft_set_ext_exists(ext, NFT_SET_EXT_EXPIRATION) &&
783 time_is_before_eq_jiffies64(*nft_set_ext_expiration(ext));
784 }
785
nft_set_elem_ext(const struct nft_set * set,void * elem)786 static inline struct nft_set_ext *nft_set_elem_ext(const struct nft_set *set,
787 void *elem)
788 {
789 return elem + set->ops->elemsize;
790 }
791
nft_set_ext_obj(const struct nft_set_ext * ext)792 static inline struct nft_object **nft_set_ext_obj(const struct nft_set_ext *ext)
793 {
794 return nft_set_ext(ext, NFT_SET_EXT_OBJREF);
795 }
796
797 struct nft_expr *nft_set_elem_expr_alloc(const struct nft_ctx *ctx,
798 const struct nft_set *set,
799 const struct nlattr *attr);
800
801 void *nft_set_elem_init(const struct nft_set *set,
802 const struct nft_set_ext_tmpl *tmpl,
803 const u32 *key, const u32 *key_end, const u32 *data,
804 u64 timeout, u64 expiration, gfp_t gfp);
805 int nft_set_elem_expr_clone(const struct nft_ctx *ctx, struct nft_set *set,
806 struct nft_expr *expr_array[]);
807 void nft_set_elem_destroy(const struct nft_set *set, void *elem,
808 bool destroy_expr);
809
810 /**
811 * struct nft_set_gc_batch_head - nf_tables set garbage collection batch
812 *
813 * @rcu: rcu head
814 * @set: set the elements belong to
815 * @cnt: count of elements
816 */
817 struct nft_set_gc_batch_head {
818 struct rcu_head rcu;
819 const struct nft_set *set;
820 unsigned int cnt;
821 };
822
823 #define NFT_SET_GC_BATCH_SIZE ((PAGE_SIZE - \
824 sizeof(struct nft_set_gc_batch_head)) / \
825 sizeof(void *))
826
827 /**
828 * struct nft_set_gc_batch - nf_tables set garbage collection batch
829 *
830 * @head: GC batch head
831 * @elems: garbage collection elements
832 */
833 struct nft_set_gc_batch {
834 struct nft_set_gc_batch_head head;
835 void *elems[NFT_SET_GC_BATCH_SIZE];
836 };
837
838 struct nft_set_gc_batch *nft_set_gc_batch_alloc(const struct nft_set *set,
839 gfp_t gfp);
840 void nft_set_gc_batch_release(struct rcu_head *rcu);
841
nft_set_gc_batch_complete(struct nft_set_gc_batch * gcb)842 static inline void nft_set_gc_batch_complete(struct nft_set_gc_batch *gcb)
843 {
844 if (gcb != NULL)
845 call_rcu(&gcb->head.rcu, nft_set_gc_batch_release);
846 }
847
848 static inline struct nft_set_gc_batch *
nft_set_gc_batch_check(const struct nft_set * set,struct nft_set_gc_batch * gcb,gfp_t gfp)849 nft_set_gc_batch_check(const struct nft_set *set, struct nft_set_gc_batch *gcb,
850 gfp_t gfp)
851 {
852 if (gcb != NULL) {
853 if (gcb->head.cnt + 1 < ARRAY_SIZE(gcb->elems))
854 return gcb;
855 nft_set_gc_batch_complete(gcb);
856 }
857 return nft_set_gc_batch_alloc(set, gfp);
858 }
859
nft_set_gc_batch_add(struct nft_set_gc_batch * gcb,void * elem)860 static inline void nft_set_gc_batch_add(struct nft_set_gc_batch *gcb,
861 void *elem)
862 {
863 gcb->elems[gcb->head.cnt++] = elem;
864 }
865
866 struct nft_expr_ops;
867 /**
868 * struct nft_expr_type - nf_tables expression type
869 *
870 * @select_ops: function to select nft_expr_ops
871 * @release_ops: release nft_expr_ops
872 * @ops: default ops, used when no select_ops functions is present
873 * @list: used internally
874 * @name: Identifier
875 * @owner: module reference
876 * @policy: netlink attribute policy
877 * @maxattr: highest netlink attribute number
878 * @family: address family for AF-specific types
879 * @flags: expression type flags
880 */
881 struct nft_expr_type {
882 const struct nft_expr_ops *(*select_ops)(const struct nft_ctx *,
883 const struct nlattr * const tb[]);
884 void (*release_ops)(const struct nft_expr_ops *ops);
885 const struct nft_expr_ops *ops;
886 const struct nft_expr_ops *inner_ops;
887 struct list_head list;
888 const char *name;
889 struct module *owner;
890 const struct nla_policy *policy;
891 unsigned int maxattr;
892 u8 family;
893 u8 flags;
894 };
895
896 #define NFT_EXPR_STATEFUL 0x1
897 #define NFT_EXPR_GC 0x2
898
899 enum nft_trans_phase {
900 NFT_TRANS_PREPARE,
901 NFT_TRANS_ABORT,
902 NFT_TRANS_COMMIT,
903 NFT_TRANS_RELEASE
904 };
905
906 struct nft_flow_rule;
907 struct nft_offload_ctx;
908
909 /**
910 * struct nft_expr_ops - nf_tables expression operations
911 *
912 * @eval: Expression evaluation function
913 * @size: full expression size, including private data size
914 * @init: initialization function
915 * @activate: activate expression in the next generation
916 * @deactivate: deactivate expression in next generation
917 * @destroy: destruction function, called after synchronize_rcu
918 * @dump: function to dump parameters
919 * @type: expression type
920 * @validate: validate expression, called during loop detection
921 * @data: extra data to attach to this expression operation
922 */
923 struct nft_expr_ops {
924 void (*eval)(const struct nft_expr *expr,
925 struct nft_regs *regs,
926 const struct nft_pktinfo *pkt);
927 int (*clone)(struct nft_expr *dst,
928 const struct nft_expr *src);
929 unsigned int size;
930
931 int (*init)(const struct nft_ctx *ctx,
932 const struct nft_expr *expr,
933 const struct nlattr * const tb[]);
934 void (*activate)(const struct nft_ctx *ctx,
935 const struct nft_expr *expr);
936 void (*deactivate)(const struct nft_ctx *ctx,
937 const struct nft_expr *expr,
938 enum nft_trans_phase phase);
939 void (*destroy)(const struct nft_ctx *ctx,
940 const struct nft_expr *expr);
941 void (*destroy_clone)(const struct nft_ctx *ctx,
942 const struct nft_expr *expr);
943 int (*dump)(struct sk_buff *skb,
944 const struct nft_expr *expr,
945 bool reset);
946 int (*validate)(const struct nft_ctx *ctx,
947 const struct nft_expr *expr,
948 const struct nft_data **data);
949 bool (*reduce)(struct nft_regs_track *track,
950 const struct nft_expr *expr);
951 bool (*gc)(struct net *net,
952 const struct nft_expr *expr);
953 int (*offload)(struct nft_offload_ctx *ctx,
954 struct nft_flow_rule *flow,
955 const struct nft_expr *expr);
956 bool (*offload_action)(const struct nft_expr *expr);
957 void (*offload_stats)(struct nft_expr *expr,
958 const struct flow_stats *stats);
959 const struct nft_expr_type *type;
960 void *data;
961 };
962
963 /**
964 * struct nft_rule - nf_tables rule
965 *
966 * @list: used internally
967 * @handle: rule handle
968 * @genmask: generation mask
969 * @dlen: length of expression data
970 * @udata: user data is appended to the rule
971 * @data: expression data
972 */
973 struct nft_rule {
974 struct list_head list;
975 u64 handle:42,
976 genmask:2,
977 dlen:12,
978 udata:1;
979 unsigned char data[]
980 __attribute__((aligned(__alignof__(struct nft_expr))));
981 };
982
nft_expr_first(const struct nft_rule * rule)983 static inline struct nft_expr *nft_expr_first(const struct nft_rule *rule)
984 {
985 return (struct nft_expr *)&rule->data[0];
986 }
987
nft_expr_next(const struct nft_expr * expr)988 static inline struct nft_expr *nft_expr_next(const struct nft_expr *expr)
989 {
990 return ((void *)expr) + expr->ops->size;
991 }
992
nft_expr_last(const struct nft_rule * rule)993 static inline struct nft_expr *nft_expr_last(const struct nft_rule *rule)
994 {
995 return (struct nft_expr *)&rule->data[rule->dlen];
996 }
997
nft_expr_more(const struct nft_rule * rule,const struct nft_expr * expr)998 static inline bool nft_expr_more(const struct nft_rule *rule,
999 const struct nft_expr *expr)
1000 {
1001 return expr != nft_expr_last(rule) && expr->ops;
1002 }
1003
nft_userdata(const struct nft_rule * rule)1004 static inline struct nft_userdata *nft_userdata(const struct nft_rule *rule)
1005 {
1006 return (void *)&rule->data[rule->dlen];
1007 }
1008
1009 void nf_tables_rule_release(const struct nft_ctx *ctx, struct nft_rule *rule);
1010
nft_set_elem_update_expr(const struct nft_set_ext * ext,struct nft_regs * regs,const struct nft_pktinfo * pkt)1011 static inline void nft_set_elem_update_expr(const struct nft_set_ext *ext,
1012 struct nft_regs *regs,
1013 const struct nft_pktinfo *pkt)
1014 {
1015 struct nft_set_elem_expr *elem_expr;
1016 struct nft_expr *expr;
1017 u32 size;
1018
1019 if (__nft_set_ext_exists(ext, NFT_SET_EXT_EXPRESSIONS)) {
1020 elem_expr = nft_set_ext_expr(ext);
1021 nft_setelem_expr_foreach(expr, elem_expr, size) {
1022 expr->ops->eval(expr, regs, pkt);
1023 if (regs->verdict.code == NFT_BREAK)
1024 return;
1025 }
1026 }
1027 }
1028
1029 /*
1030 * The last pointer isn't really necessary, but the compiler isn't able to
1031 * determine that the result of nft_expr_last() is always the same since it
1032 * can't assume that the dlen value wasn't changed within calls in the loop.
1033 */
1034 #define nft_rule_for_each_expr(expr, last, rule) \
1035 for ((expr) = nft_expr_first(rule), (last) = nft_expr_last(rule); \
1036 (expr) != (last); \
1037 (expr) = nft_expr_next(expr))
1038
1039 #define NFT_CHAIN_POLICY_UNSET U8_MAX
1040
1041 struct nft_rule_dp {
1042 u64 is_last:1,
1043 dlen:12,
1044 handle:42; /* for tracing */
1045 unsigned char data[]
1046 __attribute__((aligned(__alignof__(struct nft_expr))));
1047 };
1048
1049 struct nft_rule_blob {
1050 unsigned long size;
1051 unsigned char data[]
1052 __attribute__((aligned(__alignof__(struct nft_rule_dp))));
1053 };
1054
1055 /**
1056 * struct nft_chain - nf_tables chain
1057 *
1058 * @rules: list of rules in the chain
1059 * @list: used internally
1060 * @rhlhead: used internally
1061 * @table: table that this chain belongs to
1062 * @handle: chain handle
1063 * @use: number of jump references to this chain
1064 * @flags: bitmask of enum nft_chain_flags
1065 * @name: name of the chain
1066 */
1067 struct nft_chain {
1068 struct nft_rule_blob __rcu *blob_gen_0;
1069 struct nft_rule_blob __rcu *blob_gen_1;
1070 struct list_head rules;
1071 struct list_head list;
1072 struct rhlist_head rhlhead;
1073 struct nft_table *table;
1074 u64 handle;
1075 u32 use;
1076 u8 flags:5,
1077 bound:1,
1078 genmask:2;
1079 char *name;
1080 u16 udlen;
1081 u8 *udata;
1082
1083 /* Only used during control plane commit phase: */
1084 struct nft_rule_blob *blob_next;
1085 };
1086
1087 int nft_chain_validate(const struct nft_ctx *ctx, const struct nft_chain *chain);
1088
1089 enum nft_chain_types {
1090 NFT_CHAIN_T_DEFAULT = 0,
1091 NFT_CHAIN_T_ROUTE,
1092 NFT_CHAIN_T_NAT,
1093 NFT_CHAIN_T_MAX
1094 };
1095
1096 /**
1097 * struct nft_chain_type - nf_tables chain type info
1098 *
1099 * @name: name of the type
1100 * @type: numeric identifier
1101 * @family: address family
1102 * @owner: module owner
1103 * @hook_mask: mask of valid hooks
1104 * @hooks: array of hook functions
1105 * @ops_register: base chain register function
1106 * @ops_unregister: base chain unregister function
1107 */
1108 struct nft_chain_type {
1109 const char *name;
1110 enum nft_chain_types type;
1111 int family;
1112 struct module *owner;
1113 unsigned int hook_mask;
1114 nf_hookfn *hooks[NFT_MAX_HOOKS];
1115 int (*ops_register)(struct net *net, const struct nf_hook_ops *ops);
1116 void (*ops_unregister)(struct net *net, const struct nf_hook_ops *ops);
1117 };
1118
1119 int nft_chain_validate_dependency(const struct nft_chain *chain,
1120 enum nft_chain_types type);
1121 int nft_chain_validate_hooks(const struct nft_chain *chain,
1122 unsigned int hook_flags);
1123
nft_chain_is_bound(struct nft_chain * chain)1124 static inline bool nft_chain_is_bound(struct nft_chain *chain)
1125 {
1126 return (chain->flags & NFT_CHAIN_BINDING) && chain->bound;
1127 }
1128
1129 void nft_chain_del(struct nft_chain *chain);
1130 void nf_tables_chain_destroy(struct nft_ctx *ctx);
1131
1132 struct nft_stats {
1133 u64 bytes;
1134 u64 pkts;
1135 struct u64_stats_sync syncp;
1136 };
1137
1138 struct nft_hook {
1139 struct list_head list;
1140 struct nf_hook_ops ops;
1141 struct rcu_head rcu;
1142 };
1143
1144 /**
1145 * struct nft_base_chain - nf_tables base chain
1146 *
1147 * @ops: netfilter hook ops
1148 * @hook_list: list of netfilter hooks (for NFPROTO_NETDEV family)
1149 * @type: chain type
1150 * @policy: default policy
1151 * @stats: per-cpu chain stats
1152 * @chain: the chain
1153 * @flow_block: flow block (for hardware offload)
1154 */
1155 struct nft_base_chain {
1156 struct nf_hook_ops ops;
1157 struct list_head hook_list;
1158 const struct nft_chain_type *type;
1159 u8 policy;
1160 u8 flags;
1161 struct nft_stats __percpu *stats;
1162 struct nft_chain chain;
1163 struct flow_block flow_block;
1164 };
1165
nft_base_chain(const struct nft_chain * chain)1166 static inline struct nft_base_chain *nft_base_chain(const struct nft_chain *chain)
1167 {
1168 return container_of(chain, struct nft_base_chain, chain);
1169 }
1170
nft_is_base_chain(const struct nft_chain * chain)1171 static inline bool nft_is_base_chain(const struct nft_chain *chain)
1172 {
1173 return chain->flags & NFT_CHAIN_BASE;
1174 }
1175
1176 int __nft_release_basechain(struct nft_ctx *ctx);
1177
1178 unsigned int nft_do_chain(struct nft_pktinfo *pkt, void *priv);
1179
1180 /**
1181 * struct nft_table - nf_tables table
1182 *
1183 * @list: used internally
1184 * @chains_ht: chains in the table
1185 * @chains: same, for stable walks
1186 * @sets: sets in the table
1187 * @objects: stateful objects in the table
1188 * @flowtables: flow tables in the table
1189 * @hgenerator: handle generator state
1190 * @handle: table handle
1191 * @use: number of chain references to this table
1192 * @flags: table flag (see enum nft_table_flags)
1193 * @genmask: generation mask
1194 * @afinfo: address family info
1195 * @name: name of the table
1196 */
1197 struct nft_table {
1198 struct list_head list;
1199 struct rhltable chains_ht;
1200 struct list_head chains;
1201 struct list_head sets;
1202 struct list_head objects;
1203 struct list_head flowtables;
1204 u64 hgenerator;
1205 u64 handle;
1206 u32 use;
1207 u16 family:6,
1208 flags:8,
1209 genmask:2;
1210 u32 nlpid;
1211 char *name;
1212 u16 udlen;
1213 u8 *udata;
1214 };
1215
nft_table_has_owner(const struct nft_table * table)1216 static inline bool nft_table_has_owner(const struct nft_table *table)
1217 {
1218 return table->flags & NFT_TABLE_F_OWNER;
1219 }
1220
nft_base_chain_netdev(int family,u32 hooknum)1221 static inline bool nft_base_chain_netdev(int family, u32 hooknum)
1222 {
1223 return family == NFPROTO_NETDEV ||
1224 (family == NFPROTO_INET && hooknum == NF_INET_INGRESS);
1225 }
1226
1227 void nft_register_chain_type(const struct nft_chain_type *);
1228 void nft_unregister_chain_type(const struct nft_chain_type *);
1229
1230 int nft_register_expr(struct nft_expr_type *);
1231 void nft_unregister_expr(struct nft_expr_type *);
1232
1233 int nft_verdict_dump(struct sk_buff *skb, int type,
1234 const struct nft_verdict *v);
1235
1236 /**
1237 * struct nft_object_hash_key - key to lookup nft_object
1238 *
1239 * @name: name of the stateful object to look up
1240 * @table: table the object belongs to
1241 */
1242 struct nft_object_hash_key {
1243 const char *name;
1244 const struct nft_table *table;
1245 };
1246
1247 /**
1248 * struct nft_object - nf_tables stateful object
1249 *
1250 * @list: table stateful object list node
1251 * @key: keys that identify this object
1252 * @rhlhead: nft_objname_ht node
1253 * @genmask: generation mask
1254 * @use: number of references to this stateful object
1255 * @handle: unique object handle
1256 * @ops: object operations
1257 * @data: object data, layout depends on type
1258 */
1259 struct nft_object {
1260 struct list_head list;
1261 struct rhlist_head rhlhead;
1262 struct nft_object_hash_key key;
1263 u32 genmask:2,
1264 use:30;
1265 u64 handle;
1266 u16 udlen;
1267 u8 *udata;
1268 /* runtime data below here */
1269 const struct nft_object_ops *ops ____cacheline_aligned;
1270 unsigned char data[]
1271 __attribute__((aligned(__alignof__(u64))));
1272 };
1273
nft_obj_data(const struct nft_object * obj)1274 static inline void *nft_obj_data(const struct nft_object *obj)
1275 {
1276 return (void *)obj->data;
1277 }
1278
1279 #define nft_expr_obj(expr) *((struct nft_object **)nft_expr_priv(expr))
1280
1281 struct nft_object *nft_obj_lookup(const struct net *net,
1282 const struct nft_table *table,
1283 const struct nlattr *nla, u32 objtype,
1284 u8 genmask);
1285
1286 void nft_obj_notify(struct net *net, const struct nft_table *table,
1287 struct nft_object *obj, u32 portid, u32 seq,
1288 int event, u16 flags, int family, int report, gfp_t gfp);
1289
1290 /**
1291 * struct nft_object_type - stateful object type
1292 *
1293 * @select_ops: function to select nft_object_ops
1294 * @ops: default ops, used when no select_ops functions is present
1295 * @list: list node in list of object types
1296 * @type: stateful object numeric type
1297 * @owner: module owner
1298 * @maxattr: maximum netlink attribute
1299 * @policy: netlink attribute policy
1300 */
1301 struct nft_object_type {
1302 const struct nft_object_ops *(*select_ops)(const struct nft_ctx *,
1303 const struct nlattr * const tb[]);
1304 const struct nft_object_ops *ops;
1305 struct list_head list;
1306 u32 type;
1307 unsigned int maxattr;
1308 struct module *owner;
1309 const struct nla_policy *policy;
1310 };
1311
1312 /**
1313 * struct nft_object_ops - stateful object operations
1314 *
1315 * @eval: stateful object evaluation function
1316 * @size: stateful object size
1317 * @init: initialize object from netlink attributes
1318 * @destroy: release existing stateful object
1319 * @dump: netlink dump stateful object
1320 * @update: update stateful object
1321 */
1322 struct nft_object_ops {
1323 void (*eval)(struct nft_object *obj,
1324 struct nft_regs *regs,
1325 const struct nft_pktinfo *pkt);
1326 unsigned int size;
1327 int (*init)(const struct nft_ctx *ctx,
1328 const struct nlattr *const tb[],
1329 struct nft_object *obj);
1330 void (*destroy)(const struct nft_ctx *ctx,
1331 struct nft_object *obj);
1332 int (*dump)(struct sk_buff *skb,
1333 struct nft_object *obj,
1334 bool reset);
1335 void (*update)(struct nft_object *obj,
1336 struct nft_object *newobj);
1337 const struct nft_object_type *type;
1338 };
1339
1340 int nft_register_obj(struct nft_object_type *obj_type);
1341 void nft_unregister_obj(struct nft_object_type *obj_type);
1342
1343 #define NFT_NETDEVICE_MAX 256
1344
1345 /**
1346 * struct nft_flowtable - nf_tables flow table
1347 *
1348 * @list: flow table list node in table list
1349 * @table: the table the flow table is contained in
1350 * @name: name of this flow table
1351 * @hooknum: hook number
1352 * @ops_len: number of hooks in array
1353 * @genmask: generation mask
1354 * @use: number of references to this flow table
1355 * @handle: unique object handle
1356 * @dev_name: array of device names
1357 * @data: rhashtable and garbage collector
1358 * @ops: array of hooks
1359 */
1360 struct nft_flowtable {
1361 struct list_head list;
1362 struct nft_table *table;
1363 char *name;
1364 int hooknum;
1365 int ops_len;
1366 u32 genmask:2,
1367 use:30;
1368 u64 handle;
1369 /* runtime data below here */
1370 struct list_head hook_list ____cacheline_aligned;
1371 struct nf_flowtable data;
1372 };
1373
1374 struct nft_flowtable *nft_flowtable_lookup(const struct nft_table *table,
1375 const struct nlattr *nla,
1376 u8 genmask);
1377
1378 void nf_tables_deactivate_flowtable(const struct nft_ctx *ctx,
1379 struct nft_flowtable *flowtable,
1380 enum nft_trans_phase phase);
1381
1382 void nft_register_flowtable_type(struct nf_flowtable_type *type);
1383 void nft_unregister_flowtable_type(struct nf_flowtable_type *type);
1384
1385 /**
1386 * struct nft_traceinfo - nft tracing information and state
1387 *
1388 * @trace: other struct members are initialised
1389 * @nf_trace: copy of skb->nf_trace before rule evaluation
1390 * @type: event type (enum nft_trace_types)
1391 * @skbid: hash of skb to be used as trace id
1392 * @packet_dumped: packet headers sent in a previous traceinfo message
1393 * @pkt: pktinfo currently processed
1394 * @basechain: base chain currently processed
1395 * @chain: chain currently processed
1396 * @rule: rule that was evaluated
1397 * @verdict: verdict given by rule
1398 */
1399 struct nft_traceinfo {
1400 bool trace;
1401 bool nf_trace;
1402 bool packet_dumped;
1403 enum nft_trace_types type:8;
1404 u32 skbid;
1405 const struct nft_pktinfo *pkt;
1406 const struct nft_base_chain *basechain;
1407 const struct nft_chain *chain;
1408 const struct nft_rule_dp *rule;
1409 const struct nft_verdict *verdict;
1410 };
1411
1412 void nft_trace_init(struct nft_traceinfo *info, const struct nft_pktinfo *pkt,
1413 const struct nft_verdict *verdict,
1414 const struct nft_chain *basechain);
1415
1416 void nft_trace_notify(struct nft_traceinfo *info);
1417
1418 #define MODULE_ALIAS_NFT_CHAIN(family, name) \
1419 MODULE_ALIAS("nft-chain-" __stringify(family) "-" name)
1420
1421 #define MODULE_ALIAS_NFT_AF_EXPR(family, name) \
1422 MODULE_ALIAS("nft-expr-" __stringify(family) "-" name)
1423
1424 #define MODULE_ALIAS_NFT_EXPR(name) \
1425 MODULE_ALIAS("nft-expr-" name)
1426
1427 #define MODULE_ALIAS_NFT_OBJ(type) \
1428 MODULE_ALIAS("nft-obj-" __stringify(type))
1429
1430 #if IS_ENABLED(CONFIG_NF_TABLES)
1431
1432 /*
1433 * The gencursor defines two generations, the currently active and the
1434 * next one. Objects contain a bitmask of 2 bits specifying the generations
1435 * they're active in. A set bit means they're inactive in the generation
1436 * represented by that bit.
1437 *
1438 * New objects start out as inactive in the current and active in the
1439 * next generation. When committing the ruleset the bitmask is cleared,
1440 * meaning they're active in all generations. When removing an object,
1441 * it is set inactive in the next generation. After committing the ruleset,
1442 * the objects are removed.
1443 */
nft_gencursor_next(const struct net * net)1444 static inline unsigned int nft_gencursor_next(const struct net *net)
1445 {
1446 return net->nft.gencursor + 1 == 1 ? 1 : 0;
1447 }
1448
nft_genmask_next(const struct net * net)1449 static inline u8 nft_genmask_next(const struct net *net)
1450 {
1451 return 1 << nft_gencursor_next(net);
1452 }
1453
nft_genmask_cur(const struct net * net)1454 static inline u8 nft_genmask_cur(const struct net *net)
1455 {
1456 /* Use READ_ONCE() to prevent refetching the value for atomicity */
1457 return 1 << READ_ONCE(net->nft.gencursor);
1458 }
1459
1460 #define NFT_GENMASK_ANY ((1 << 0) | (1 << 1))
1461
1462 /*
1463 * Generic transaction helpers
1464 */
1465
1466 /* Check if this object is currently active. */
1467 #define nft_is_active(__net, __obj) \
1468 (((__obj)->genmask & nft_genmask_cur(__net)) == 0)
1469
1470 /* Check if this object is active in the next generation. */
1471 #define nft_is_active_next(__net, __obj) \
1472 (((__obj)->genmask & nft_genmask_next(__net)) == 0)
1473
1474 /* This object becomes active in the next generation. */
1475 #define nft_activate_next(__net, __obj) \
1476 (__obj)->genmask = nft_genmask_cur(__net)
1477
1478 /* This object becomes inactive in the next generation. */
1479 #define nft_deactivate_next(__net, __obj) \
1480 (__obj)->genmask = nft_genmask_next(__net)
1481
1482 /* After committing the ruleset, clear the stale generation bit. */
1483 #define nft_clear(__net, __obj) \
1484 (__obj)->genmask &= ~nft_genmask_next(__net)
1485 #define nft_active_genmask(__obj, __genmask) \
1486 !((__obj)->genmask & __genmask)
1487
1488 /*
1489 * Set element transaction helpers
1490 */
1491
nft_set_elem_active(const struct nft_set_ext * ext,u8 genmask)1492 static inline bool nft_set_elem_active(const struct nft_set_ext *ext,
1493 u8 genmask)
1494 {
1495 return !(ext->genmask & genmask);
1496 }
1497
nft_set_elem_change_active(const struct net * net,const struct nft_set * set,struct nft_set_ext * ext)1498 static inline void nft_set_elem_change_active(const struct net *net,
1499 const struct nft_set *set,
1500 struct nft_set_ext *ext)
1501 {
1502 ext->genmask ^= nft_genmask_next(net);
1503 }
1504
1505 #endif /* IS_ENABLED(CONFIG_NF_TABLES) */
1506
1507 /*
1508 * We use a free bit in the genmask field to indicate the element
1509 * is busy, meaning it is currently being processed either by
1510 * the netlink API or GC.
1511 *
1512 * Even though the genmask is only a single byte wide, this works
1513 * because the extension structure if fully constant once initialized,
1514 * so there are no non-atomic write accesses unless it is already
1515 * marked busy.
1516 */
1517 #define NFT_SET_ELEM_BUSY_MASK (1 << 2)
1518
1519 #if defined(__LITTLE_ENDIAN_BITFIELD)
1520 #define NFT_SET_ELEM_BUSY_BIT 2
1521 #elif defined(__BIG_ENDIAN_BITFIELD)
1522 #define NFT_SET_ELEM_BUSY_BIT (BITS_PER_LONG - BITS_PER_BYTE + 2)
1523 #else
1524 #error
1525 #endif
1526
nft_set_elem_mark_busy(struct nft_set_ext * ext)1527 static inline int nft_set_elem_mark_busy(struct nft_set_ext *ext)
1528 {
1529 unsigned long *word = (unsigned long *)ext;
1530
1531 BUILD_BUG_ON(offsetof(struct nft_set_ext, genmask) != 0);
1532 return test_and_set_bit(NFT_SET_ELEM_BUSY_BIT, word);
1533 }
1534
nft_set_elem_clear_busy(struct nft_set_ext * ext)1535 static inline void nft_set_elem_clear_busy(struct nft_set_ext *ext)
1536 {
1537 unsigned long *word = (unsigned long *)ext;
1538
1539 clear_bit(NFT_SET_ELEM_BUSY_BIT, word);
1540 }
1541
1542 /**
1543 * struct nft_trans - nf_tables object update in transaction
1544 *
1545 * @list: used internally
1546 * @msg_type: message type
1547 * @put_net: ctx->net needs to be put
1548 * @ctx: transaction context
1549 * @data: internal information related to the transaction
1550 */
1551 struct nft_trans {
1552 struct list_head list;
1553 int msg_type;
1554 bool put_net;
1555 struct nft_ctx ctx;
1556 char data[];
1557 };
1558
1559 struct nft_trans_rule {
1560 struct nft_rule *rule;
1561 struct nft_flow_rule *flow;
1562 u32 rule_id;
1563 };
1564
1565 #define nft_trans_rule(trans) \
1566 (((struct nft_trans_rule *)trans->data)->rule)
1567 #define nft_trans_flow_rule(trans) \
1568 (((struct nft_trans_rule *)trans->data)->flow)
1569 #define nft_trans_rule_id(trans) \
1570 (((struct nft_trans_rule *)trans->data)->rule_id)
1571
1572 struct nft_trans_set {
1573 struct nft_set *set;
1574 u32 set_id;
1575 u32 gc_int;
1576 u64 timeout;
1577 bool update;
1578 bool bound;
1579 };
1580
1581 #define nft_trans_set(trans) \
1582 (((struct nft_trans_set *)trans->data)->set)
1583 #define nft_trans_set_id(trans) \
1584 (((struct nft_trans_set *)trans->data)->set_id)
1585 #define nft_trans_set_bound(trans) \
1586 (((struct nft_trans_set *)trans->data)->bound)
1587 #define nft_trans_set_update(trans) \
1588 (((struct nft_trans_set *)trans->data)->update)
1589 #define nft_trans_set_timeout(trans) \
1590 (((struct nft_trans_set *)trans->data)->timeout)
1591 #define nft_trans_set_gc_int(trans) \
1592 (((struct nft_trans_set *)trans->data)->gc_int)
1593
1594 struct nft_trans_chain {
1595 bool update;
1596 char *name;
1597 struct nft_stats __percpu *stats;
1598 u8 policy;
1599 u32 chain_id;
1600 };
1601
1602 #define nft_trans_chain_update(trans) \
1603 (((struct nft_trans_chain *)trans->data)->update)
1604 #define nft_trans_chain_name(trans) \
1605 (((struct nft_trans_chain *)trans->data)->name)
1606 #define nft_trans_chain_stats(trans) \
1607 (((struct nft_trans_chain *)trans->data)->stats)
1608 #define nft_trans_chain_policy(trans) \
1609 (((struct nft_trans_chain *)trans->data)->policy)
1610 #define nft_trans_chain_id(trans) \
1611 (((struct nft_trans_chain *)trans->data)->chain_id)
1612
1613 struct nft_trans_table {
1614 bool update;
1615 };
1616
1617 #define nft_trans_table_update(trans) \
1618 (((struct nft_trans_table *)trans->data)->update)
1619
1620 struct nft_trans_elem {
1621 struct nft_set *set;
1622 struct nft_set_elem elem;
1623 bool bound;
1624 };
1625
1626 #define nft_trans_elem_set(trans) \
1627 (((struct nft_trans_elem *)trans->data)->set)
1628 #define nft_trans_elem(trans) \
1629 (((struct nft_trans_elem *)trans->data)->elem)
1630 #define nft_trans_elem_set_bound(trans) \
1631 (((struct nft_trans_elem *)trans->data)->bound)
1632
1633 struct nft_trans_obj {
1634 struct nft_object *obj;
1635 struct nft_object *newobj;
1636 bool update;
1637 };
1638
1639 #define nft_trans_obj(trans) \
1640 (((struct nft_trans_obj *)trans->data)->obj)
1641 #define nft_trans_obj_newobj(trans) \
1642 (((struct nft_trans_obj *)trans->data)->newobj)
1643 #define nft_trans_obj_update(trans) \
1644 (((struct nft_trans_obj *)trans->data)->update)
1645
1646 struct nft_trans_flowtable {
1647 struct nft_flowtable *flowtable;
1648 bool update;
1649 struct list_head hook_list;
1650 u32 flags;
1651 };
1652
1653 #define nft_trans_flowtable(trans) \
1654 (((struct nft_trans_flowtable *)trans->data)->flowtable)
1655 #define nft_trans_flowtable_update(trans) \
1656 (((struct nft_trans_flowtable *)trans->data)->update)
1657 #define nft_trans_flowtable_hooks(trans) \
1658 (((struct nft_trans_flowtable *)trans->data)->hook_list)
1659 #define nft_trans_flowtable_flags(trans) \
1660 (((struct nft_trans_flowtable *)trans->data)->flags)
1661
1662 int __init nft_chain_filter_init(void);
1663 void nft_chain_filter_fini(void);
1664
1665 void __init nft_chain_route_init(void);
1666 void nft_chain_route_fini(void);
1667
1668 void nf_tables_trans_destroy_flush_work(void);
1669
1670 int nf_msecs_to_jiffies64(const struct nlattr *nla, u64 *result);
1671 __be64 nf_jiffies64_to_msecs(u64 input);
1672
1673 #ifdef CONFIG_MODULES
1674 __printf(2, 3) int nft_request_module(struct net *net, const char *fmt, ...);
1675 #else
nft_request_module(struct net * net,const char * fmt,...)1676 static inline int nft_request_module(struct net *net, const char *fmt, ...) { return -ENOENT; }
1677 #endif
1678
1679 struct nftables_pernet {
1680 struct list_head tables;
1681 struct list_head commit_list;
1682 struct list_head module_list;
1683 struct list_head notify_list;
1684 struct mutex commit_mutex;
1685 u64 table_handle;
1686 unsigned int base_seq;
1687 u8 validate_state;
1688 };
1689
1690 extern unsigned int nf_tables_net_id;
1691
nft_pernet(const struct net * net)1692 static inline struct nftables_pernet *nft_pernet(const struct net *net)
1693 {
1694 return net_generic(net, nf_tables_net_id);
1695 }
1696
1697 #define __NFT_REDUCE_READONLY 1UL
1698 #define NFT_REDUCE_READONLY (void *)__NFT_REDUCE_READONLY
1699
nft_reduce_is_readonly(const struct nft_expr * expr)1700 static inline bool nft_reduce_is_readonly(const struct nft_expr *expr)
1701 {
1702 return expr->ops->reduce == NFT_REDUCE_READONLY;
1703 }
1704
1705 void nft_reg_track_update(struct nft_regs_track *track,
1706 const struct nft_expr *expr, u8 dreg, u8 len);
1707 void nft_reg_track_cancel(struct nft_regs_track *track, u8 dreg, u8 len);
1708 void __nft_reg_track_cancel(struct nft_regs_track *track, u8 dreg);
1709
nft_reg_track_cmp(struct nft_regs_track * track,const struct nft_expr * expr,u8 dreg)1710 static inline bool nft_reg_track_cmp(struct nft_regs_track *track,
1711 const struct nft_expr *expr, u8 dreg)
1712 {
1713 return track->regs[dreg].selector &&
1714 track->regs[dreg].selector->ops == expr->ops &&
1715 track->regs[dreg].num_reg == 0;
1716 }
1717
1718 #endif /* _NET_NF_TABLES_H */
1719