1 /* SPDX-License-Identifier: GPL-2.0 */
2 #ifndef _NET_NF_TABLES_H
3 #define _NET_NF_TABLES_H
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>
18 #define NFT_MAX_HOOKS (NF_INET_INGRESS + 1)
22 #define NFT_JUMP_STACK_SIZE 16
28 /* for x_tables compatibility */
29 struct xt_action_param xt;
32 static inline struct net *nft_net(const struct nft_pktinfo *pkt)
34 return pkt->xt.state->net;
37 static inline unsigned int nft_hook(const struct nft_pktinfo *pkt)
39 return pkt->xt.state->hook;
42 static inline u8 nft_pf(const struct nft_pktinfo *pkt)
44 return pkt->xt.state->pf;
47 static inline const struct net_device *nft_in(const struct nft_pktinfo *pkt)
49 return pkt->xt.state->in;
52 static inline const struct net_device *nft_out(const struct nft_pktinfo *pkt)
54 return pkt->xt.state->out;
57 static inline void nft_set_pktinfo(struct nft_pktinfo *pkt,
59 const struct nf_hook_state *state)
62 pkt->xt.state = state;
65 static inline void nft_set_pktinfo_unspec(struct nft_pktinfo *pkt,
68 pkt->tprot_set = false;
75 * struct nft_verdict - nf_tables verdict
77 * @code: nf_tables/netfilter verdict code
78 * @chain: destination chain for NFT_JUMP/NFT_GOTO
82 struct nft_chain *chain;
88 struct nft_verdict verdict;
90 } __attribute__((aligned(__alignof__(u64))));
93 * struct nft_regs - nf_tables register set
95 * @data: data registers
96 * @verdict: verdict register
98 * The first four data registers alias to the verdict register.
103 struct nft_verdict verdict;
107 /* Store/load an u8, u16 or u64 integer to/from the u32 data register.
109 * Note, when using concatenations, register allocation happens at 32-bit
110 * level. So for store instruction, pad the rest part with zero to avoid
114 static inline void nft_reg_store8(u32 *dreg, u8 val)
120 static inline u8 nft_reg_load8(const u32 *sreg)
125 static inline void nft_reg_store16(u32 *dreg, u16 val)
131 static inline u16 nft_reg_load16(const u32 *sreg)
136 static inline void nft_reg_store64(u32 *dreg, u64 val)
138 put_unaligned(val, (u64 *)dreg);
141 static inline u64 nft_reg_load64(const u32 *sreg)
143 return get_unaligned((u64 *)sreg);
146 static inline void nft_data_copy(u32 *dst, const struct nft_data *src,
149 if (len % NFT_REG32_SIZE)
150 dst[len / NFT_REG32_SIZE] = 0;
151 memcpy(dst, src, len);
155 * struct nft_ctx - nf_tables rule/set context
157 * @net: net namespace
158 * @table: the table the chain is contained in
159 * @chain: the chain the rule is contained in
160 * @nla: netlink attributes
161 * @portid: netlink portID of the original message
162 * @seq: netlink sequence number
163 * @family: protocol family
164 * @level: depth of the chains
165 * @report: notify via unicast netlink message
169 struct nft_table *table;
170 struct nft_chain *chain;
171 const struct nlattr * const *nla;
180 struct nft_data_desc {
181 enum nft_data_types type;
185 int nft_data_init(const struct nft_ctx *ctx,
186 struct nft_data *data, unsigned int size,
187 struct nft_data_desc *desc, const struct nlattr *nla);
188 void nft_data_hold(const struct nft_data *data, enum nft_data_types type);
189 void nft_data_release(const struct nft_data *data, enum nft_data_types type);
190 int nft_data_dump(struct sk_buff *skb, int attr, const struct nft_data *data,
191 enum nft_data_types type, unsigned int len);
193 static inline enum nft_data_types nft_dreg_to_type(enum nft_registers reg)
195 return reg == NFT_REG_VERDICT ? NFT_DATA_VERDICT : NFT_DATA_VALUE;
198 static inline enum nft_registers nft_type_to_reg(enum nft_data_types type)
200 return type == NFT_DATA_VERDICT ? NFT_REG_VERDICT : NFT_REG_1 * NFT_REG_SIZE / NFT_REG32_SIZE;
203 int nft_parse_u32_check(const struct nlattr *attr, int max, u32 *dest);
204 int nft_dump_register(struct sk_buff *skb, unsigned int attr, unsigned int reg);
206 int nft_parse_register_load(const struct nlattr *attr, u8 *sreg, u32 len);
207 int nft_parse_register_store(const struct nft_ctx *ctx,
208 const struct nlattr *attr, u8 *dreg,
209 const struct nft_data *data,
210 enum nft_data_types type, unsigned int len);
213 * struct nft_userdata - user defined data associated with an object
215 * @len: length of the data
218 * The presence of user data is indicated in an object specific fashion,
219 * so a length of zero can't occur and the value "len" indicates data
222 struct nft_userdata {
224 unsigned char data[];
228 * struct nft_set_elem - generic representation of set elements
231 * @key_end: closing element key
232 * @priv: element private data and extensions
234 struct nft_set_elem {
236 u32 buf[NFT_DATA_VALUE_MAXLEN / sizeof(u32)];
240 u32 buf[NFT_DATA_VALUE_MAXLEN / sizeof(u32)];
244 u32 buf[NFT_DATA_VALUE_MAXLEN / sizeof(u32)];
251 struct nft_set_iter {
256 int (*fn)(const struct nft_ctx *ctx,
258 const struct nft_set_iter *iter,
259 struct nft_set_elem *elem);
263 * struct nft_set_desc - description of set elements
267 * @size: number of set elements
268 * @field_len: length of each field in concatenation, bytes
269 * @field_count: number of concatenated fields in element
270 * @expr: set must support for expressions
272 struct nft_set_desc {
276 u8 field_len[NFT_REG32_COUNT];
282 * enum nft_set_class - performance class
284 * @NFT_LOOKUP_O_1: constant, O(1)
285 * @NFT_LOOKUP_O_LOG_N: logarithmic, O(log N)
286 * @NFT_LOOKUP_O_N: linear, O(N)
290 NFT_SET_CLASS_O_LOG_N,
295 * struct nft_set_estimate - estimation of memory and performance
298 * @size: required memory
299 * @lookup: lookup performance class
300 * @space: memory class
302 struct nft_set_estimate {
304 enum nft_set_class lookup;
305 enum nft_set_class space;
308 #define NFT_EXPR_MAXATTR 16
309 #define NFT_EXPR_SIZE(size) (sizeof(struct nft_expr) + \
310 ALIGN(size, __alignof__(struct nft_expr)))
313 * struct nft_expr - nf_tables expression
315 * @ops: expression ops
316 * @data: expression private data
319 const struct nft_expr_ops *ops;
321 __attribute__((aligned(__alignof__(u64))));
324 static inline void *nft_expr_priv(const struct nft_expr *expr)
326 return (void *)expr->data;
329 int nft_expr_clone(struct nft_expr *dst, struct nft_expr *src);
330 void nft_expr_destroy(const struct nft_ctx *ctx, struct nft_expr *expr);
331 int nft_expr_dump(struct sk_buff *skb, unsigned int attr,
332 const struct nft_expr *expr);
337 * struct nft_set_ops - nf_tables set operations
339 * @lookup: look up an element within the set
340 * @update: update an element if exists, add it if doesn't exist
341 * @delete: delete an element
342 * @insert: insert new element into set
343 * @activate: activate new element in the next generation
344 * @deactivate: lookup for element and deactivate it in the next generation
345 * @flush: deactivate element in the next generation
346 * @remove: remove element from set
347 * @walk: iterate over all set elements
348 * @get: get set elements
349 * @privsize: function to return size of set private data
350 * @init: initialize private data of new set instance
351 * @destroy: destroy private data of set instance
352 * @elemsize: element private size
354 * Operations lookup, update and delete have simpler interfaces, are faster
355 * and currently only used in the packet path. All the rest are slower,
356 * control plane functions.
359 bool (*lookup)(const struct net *net,
360 const struct nft_set *set,
362 const struct nft_set_ext **ext);
363 bool (*update)(struct nft_set *set,
365 void *(*new)(struct nft_set *,
366 const struct nft_expr *,
368 const struct nft_expr *expr,
369 struct nft_regs *regs,
370 const struct nft_set_ext **ext);
371 bool (*delete)(const struct nft_set *set,
374 int (*insert)(const struct net *net,
375 const struct nft_set *set,
376 const struct nft_set_elem *elem,
377 struct nft_set_ext **ext);
378 void (*activate)(const struct net *net,
379 const struct nft_set *set,
380 const struct nft_set_elem *elem);
381 void * (*deactivate)(const struct net *net,
382 const struct nft_set *set,
383 const struct nft_set_elem *elem);
384 bool (*flush)(const struct net *net,
385 const struct nft_set *set,
387 void (*remove)(const struct net *net,
388 const struct nft_set *set,
389 const struct nft_set_elem *elem);
390 void (*walk)(const struct nft_ctx *ctx,
392 struct nft_set_iter *iter);
393 void * (*get)(const struct net *net,
394 const struct nft_set *set,
395 const struct nft_set_elem *elem,
398 u64 (*privsize)(const struct nlattr * const nla[],
399 const struct nft_set_desc *desc);
400 bool (*estimate)(const struct nft_set_desc *desc,
402 struct nft_set_estimate *est);
403 int (*init)(const struct nft_set *set,
404 const struct nft_set_desc *desc,
405 const struct nlattr * const nla[]);
406 void (*destroy)(const struct nft_set *set);
407 void (*gc_init)(const struct nft_set *set);
409 unsigned int elemsize;
413 * struct nft_set_type - nf_tables set type
415 * @ops: set ops for this type
416 * @features: features supported by the implementation
418 struct nft_set_type {
419 const struct nft_set_ops ops;
422 #define to_set_type(o) container_of(o, struct nft_set_type, ops)
424 struct nft_set_elem_expr {
427 __attribute__((aligned(__alignof__(struct nft_expr))));
430 #define nft_setelem_expr_at(__elem_expr, __offset) \
431 ((struct nft_expr *)&__elem_expr->data[__offset])
433 #define nft_setelem_expr_foreach(__expr, __elem_expr, __size) \
434 for (__expr = nft_setelem_expr_at(__elem_expr, 0), __size = 0; \
435 __size < (__elem_expr)->size; \
436 __size += (__expr)->ops->size, __expr = ((void *)(__expr)) + (__expr)->ops->size)
438 #define NFT_SET_EXPR_MAX 2
441 * struct nft_set - nf_tables set instance
443 * @list: table set list node
444 * @bindings: list of set bindings
445 * @table: table this set belongs to
446 * @net: netnamespace this set belongs to
447 * @name: name of the set
448 * @handle: unique handle of the set
449 * @ktype: key type (numeric type defined by userspace, not used in the kernel)
450 * @dtype: data type (verdict or numeric type defined by userspace)
451 * @objtype: object type (see NFT_OBJECT_* definitions)
452 * @size: maximum set size
453 * @field_len: length of each field in concatenation, bytes
454 * @field_count: number of concatenated fields in element
455 * @use: number of rules references to this set
456 * @nelems: number of elements
457 * @ndeact: number of deactivated elements queued for removal
458 * @timeout: default timeout value in jiffies
459 * @gc_int: garbage collection interval in msecs
460 * @policy: set parameterization (see enum nft_set_policies)
461 * @udlen: user data length
463 * @expr: stateful expression
466 * @genmask: generation mask
469 * @data: private set data
472 struct list_head list;
473 struct list_head bindings;
474 struct nft_table *table;
482 u8 field_len[NFT_REG32_COUNT];
491 unsigned char *udata;
492 /* runtime data below here */
493 const struct nft_set_ops *ops ____cacheline_aligned;
499 struct nft_expr *exprs[NFT_SET_EXPR_MAX];
500 struct list_head catchall_list;
502 __attribute__((aligned(__alignof__(u64))));
505 static inline bool nft_set_is_anonymous(const struct nft_set *set)
507 return set->flags & NFT_SET_ANONYMOUS;
510 static inline void *nft_set_priv(const struct nft_set *set)
512 return (void *)set->data;
515 static inline struct nft_set *nft_set_container_of(const void *priv)
517 return (void *)priv - offsetof(struct nft_set, data);
520 struct nft_set *nft_set_lookup_global(const struct net *net,
521 const struct nft_table *table,
522 const struct nlattr *nla_set_name,
523 const struct nlattr *nla_set_id,
526 struct nft_set_ext *nft_set_catchall_lookup(const struct net *net,
527 const struct nft_set *set);
528 void *nft_set_catchall_gc(const struct nft_set *set);
530 static inline unsigned long nft_set_gc_interval(const struct nft_set *set)
532 return set->gc_int ? msecs_to_jiffies(set->gc_int) : HZ;
536 * struct nft_set_binding - nf_tables set binding
538 * @list: set bindings list node
539 * @chain: chain containing the rule bound to the set
540 * @flags: set action flags
542 * A set binding contains all information necessary for validation
543 * of new elements added to a bound set.
545 struct nft_set_binding {
546 struct list_head list;
547 const struct nft_chain *chain;
551 enum nft_trans_phase;
552 void nf_tables_deactivate_set(const struct nft_ctx *ctx, struct nft_set *set,
553 struct nft_set_binding *binding,
554 enum nft_trans_phase phase);
555 int nf_tables_bind_set(const struct nft_ctx *ctx, struct nft_set *set,
556 struct nft_set_binding *binding);
557 void nf_tables_destroy_set(const struct nft_ctx *ctx, struct nft_set *set);
560 * enum nft_set_extensions - set extension type IDs
562 * @NFT_SET_EXT_KEY: element key
563 * @NFT_SET_EXT_KEY_END: upper bound element key, for ranges
564 * @NFT_SET_EXT_DATA: mapping data
565 * @NFT_SET_EXT_FLAGS: element flags
566 * @NFT_SET_EXT_TIMEOUT: element timeout
567 * @NFT_SET_EXT_EXPIRATION: element expiration time
568 * @NFT_SET_EXT_USERDATA: user data associated with the element
569 * @NFT_SET_EXT_EXPRESSIONS: expressions assiciated with the element
570 * @NFT_SET_EXT_OBJREF: stateful object reference associated with element
571 * @NFT_SET_EXT_NUM: number of extension types
573 enum nft_set_extensions {
579 NFT_SET_EXT_EXPIRATION,
580 NFT_SET_EXT_USERDATA,
581 NFT_SET_EXT_EXPRESSIONS,
587 * struct nft_set_ext_type - set extension type
589 * @len: fixed part length of the extension
590 * @align: alignment requirements of the extension
592 struct nft_set_ext_type {
597 extern const struct nft_set_ext_type nft_set_ext_types[];
600 * struct nft_set_ext_tmpl - set extension template
602 * @len: length of extension area
603 * @offset: offsets of individual extension types
605 struct nft_set_ext_tmpl {
607 u8 offset[NFT_SET_EXT_NUM];
611 * struct nft_set_ext - set extensions
613 * @genmask: generation mask
614 * @offset: offsets of individual extension types
615 * @data: beginning of extension data
619 u8 offset[NFT_SET_EXT_NUM];
623 static inline void nft_set_ext_prepare(struct nft_set_ext_tmpl *tmpl)
625 memset(tmpl, 0, sizeof(*tmpl));
626 tmpl->len = sizeof(struct nft_set_ext);
629 static inline void nft_set_ext_add_length(struct nft_set_ext_tmpl *tmpl, u8 id,
632 tmpl->len = ALIGN(tmpl->len, nft_set_ext_types[id].align);
633 BUG_ON(tmpl->len > U8_MAX);
634 tmpl->offset[id] = tmpl->len;
635 tmpl->len += nft_set_ext_types[id].len + len;
638 static inline void nft_set_ext_add(struct nft_set_ext_tmpl *tmpl, u8 id)
640 nft_set_ext_add_length(tmpl, id, 0);
643 static inline void nft_set_ext_init(struct nft_set_ext *ext,
644 const struct nft_set_ext_tmpl *tmpl)
646 memcpy(ext->offset, tmpl->offset, sizeof(ext->offset));
649 static inline bool __nft_set_ext_exists(const struct nft_set_ext *ext, u8 id)
651 return !!ext->offset[id];
654 static inline bool nft_set_ext_exists(const struct nft_set_ext *ext, u8 id)
656 return ext && __nft_set_ext_exists(ext, id);
659 static inline void *nft_set_ext(const struct nft_set_ext *ext, u8 id)
661 return (void *)ext + ext->offset[id];
664 static inline struct nft_data *nft_set_ext_key(const struct nft_set_ext *ext)
666 return nft_set_ext(ext, NFT_SET_EXT_KEY);
669 static inline struct nft_data *nft_set_ext_key_end(const struct nft_set_ext *ext)
671 return nft_set_ext(ext, NFT_SET_EXT_KEY_END);
674 static inline struct nft_data *nft_set_ext_data(const struct nft_set_ext *ext)
676 return nft_set_ext(ext, NFT_SET_EXT_DATA);
679 static inline u8 *nft_set_ext_flags(const struct nft_set_ext *ext)
681 return nft_set_ext(ext, NFT_SET_EXT_FLAGS);
684 static inline u64 *nft_set_ext_timeout(const struct nft_set_ext *ext)
686 return nft_set_ext(ext, NFT_SET_EXT_TIMEOUT);
689 static inline u64 *nft_set_ext_expiration(const struct nft_set_ext *ext)
691 return nft_set_ext(ext, NFT_SET_EXT_EXPIRATION);
694 static inline struct nft_userdata *nft_set_ext_userdata(const struct nft_set_ext *ext)
696 return nft_set_ext(ext, NFT_SET_EXT_USERDATA);
699 static inline struct nft_set_elem_expr *nft_set_ext_expr(const struct nft_set_ext *ext)
701 return nft_set_ext(ext, NFT_SET_EXT_EXPRESSIONS);
704 static inline bool nft_set_elem_expired(const struct nft_set_ext *ext)
706 return nft_set_ext_exists(ext, NFT_SET_EXT_EXPIRATION) &&
707 time_is_before_eq_jiffies64(*nft_set_ext_expiration(ext));
710 static inline struct nft_set_ext *nft_set_elem_ext(const struct nft_set *set,
713 return elem + set->ops->elemsize;
716 static inline struct nft_object **nft_set_ext_obj(const struct nft_set_ext *ext)
718 return nft_set_ext(ext, NFT_SET_EXT_OBJREF);
721 struct nft_expr *nft_set_elem_expr_alloc(const struct nft_ctx *ctx,
722 const struct nft_set *set,
723 const struct nlattr *attr);
725 void *nft_set_elem_init(const struct nft_set *set,
726 const struct nft_set_ext_tmpl *tmpl,
727 const u32 *key, const u32 *key_end, const u32 *data,
728 u64 timeout, u64 expiration, gfp_t gfp);
729 int nft_set_elem_expr_clone(const struct nft_ctx *ctx, struct nft_set *set,
730 struct nft_expr *expr_array[]);
731 void nft_set_elem_destroy(const struct nft_set *set, void *elem,
735 * struct nft_set_gc_batch_head - nf_tables set garbage collection batch
738 * @set: set the elements belong to
739 * @cnt: count of elements
741 struct nft_set_gc_batch_head {
743 const struct nft_set *set;
747 #define NFT_SET_GC_BATCH_SIZE ((PAGE_SIZE - \
748 sizeof(struct nft_set_gc_batch_head)) / \
752 * struct nft_set_gc_batch - nf_tables set garbage collection batch
754 * @head: GC batch head
755 * @elems: garbage collection elements
757 struct nft_set_gc_batch {
758 struct nft_set_gc_batch_head head;
759 void *elems[NFT_SET_GC_BATCH_SIZE];
762 struct nft_set_gc_batch *nft_set_gc_batch_alloc(const struct nft_set *set,
764 void nft_set_gc_batch_release(struct rcu_head *rcu);
766 static inline void nft_set_gc_batch_complete(struct nft_set_gc_batch *gcb)
769 call_rcu(&gcb->head.rcu, nft_set_gc_batch_release);
772 static inline struct nft_set_gc_batch *
773 nft_set_gc_batch_check(const struct nft_set *set, struct nft_set_gc_batch *gcb,
777 if (gcb->head.cnt + 1 < ARRAY_SIZE(gcb->elems))
779 nft_set_gc_batch_complete(gcb);
781 return nft_set_gc_batch_alloc(set, gfp);
784 static inline void nft_set_gc_batch_add(struct nft_set_gc_batch *gcb,
787 gcb->elems[gcb->head.cnt++] = elem;
792 * struct nft_expr_type - nf_tables expression type
794 * @select_ops: function to select nft_expr_ops
795 * @release_ops: release nft_expr_ops
796 * @ops: default ops, used when no select_ops functions is present
797 * @list: used internally
799 * @owner: module reference
800 * @policy: netlink attribute policy
801 * @maxattr: highest netlink attribute number
802 * @family: address family for AF-specific types
803 * @flags: expression type flags
805 struct nft_expr_type {
806 const struct nft_expr_ops *(*select_ops)(const struct nft_ctx *,
807 const struct nlattr * const tb[]);
808 void (*release_ops)(const struct nft_expr_ops *ops);
809 const struct nft_expr_ops *ops;
810 struct list_head list;
812 struct module *owner;
813 const struct nla_policy *policy;
814 unsigned int maxattr;
819 #define NFT_EXPR_STATEFUL 0x1
820 #define NFT_EXPR_GC 0x2
822 enum nft_trans_phase {
829 struct nft_flow_rule;
830 struct nft_offload_ctx;
833 * struct nft_expr_ops - nf_tables expression operations
835 * @eval: Expression evaluation function
836 * @size: full expression size, including private data size
837 * @init: initialization function
838 * @activate: activate expression in the next generation
839 * @deactivate: deactivate expression in next generation
840 * @destroy: destruction function, called after synchronize_rcu
841 * @dump: function to dump parameters
842 * @type: expression type
843 * @validate: validate expression, called during loop detection
844 * @data: extra data to attach to this expression operation
846 struct nft_expr_ops {
847 void (*eval)(const struct nft_expr *expr,
848 struct nft_regs *regs,
849 const struct nft_pktinfo *pkt);
850 int (*clone)(struct nft_expr *dst,
851 const struct nft_expr *src);
854 int (*init)(const struct nft_ctx *ctx,
855 const struct nft_expr *expr,
856 const struct nlattr * const tb[]);
857 void (*activate)(const struct nft_ctx *ctx,
858 const struct nft_expr *expr);
859 void (*deactivate)(const struct nft_ctx *ctx,
860 const struct nft_expr *expr,
861 enum nft_trans_phase phase);
862 void (*destroy)(const struct nft_ctx *ctx,
863 const struct nft_expr *expr);
864 void (*destroy_clone)(const struct nft_ctx *ctx,
865 const struct nft_expr *expr);
866 int (*dump)(struct sk_buff *skb,
867 const struct nft_expr *expr);
868 int (*validate)(const struct nft_ctx *ctx,
869 const struct nft_expr *expr,
870 const struct nft_data **data);
871 bool (*gc)(struct net *net,
872 const struct nft_expr *expr);
873 int (*offload)(struct nft_offload_ctx *ctx,
874 struct nft_flow_rule *flow,
875 const struct nft_expr *expr);
876 void (*offload_stats)(struct nft_expr *expr,
877 const struct flow_stats *stats);
879 const struct nft_expr_type *type;
884 * struct nft_rule - nf_tables rule
886 * @list: used internally
887 * @handle: rule handle
888 * @genmask: generation mask
889 * @dlen: length of expression data
890 * @udata: user data is appended to the rule
891 * @data: expression data
894 struct list_head list;
900 __attribute__((aligned(__alignof__(struct nft_expr))));
903 static inline struct nft_expr *nft_expr_first(const struct nft_rule *rule)
905 return (struct nft_expr *)&rule->data[0];
908 static inline struct nft_expr *nft_expr_next(const struct nft_expr *expr)
910 return ((void *)expr) + expr->ops->size;
913 static inline struct nft_expr *nft_expr_last(const struct nft_rule *rule)
915 return (struct nft_expr *)&rule->data[rule->dlen];
918 static inline bool nft_expr_more(const struct nft_rule *rule,
919 const struct nft_expr *expr)
921 return expr != nft_expr_last(rule) && expr->ops;
924 static inline struct nft_userdata *nft_userdata(const struct nft_rule *rule)
926 return (void *)&rule->data[rule->dlen];
929 void nf_tables_rule_release(const struct nft_ctx *ctx, struct nft_rule *rule);
931 static inline void nft_set_elem_update_expr(const struct nft_set_ext *ext,
932 struct nft_regs *regs,
933 const struct nft_pktinfo *pkt)
935 struct nft_set_elem_expr *elem_expr;
936 struct nft_expr *expr;
939 if (__nft_set_ext_exists(ext, NFT_SET_EXT_EXPRESSIONS)) {
940 elem_expr = nft_set_ext_expr(ext);
941 nft_setelem_expr_foreach(expr, elem_expr, size) {
942 expr->ops->eval(expr, regs, pkt);
943 if (regs->verdict.code == NFT_BREAK)
950 * The last pointer isn't really necessary, but the compiler isn't able to
951 * determine that the result of nft_expr_last() is always the same since it
952 * can't assume that the dlen value wasn't changed within calls in the loop.
954 #define nft_rule_for_each_expr(expr, last, rule) \
955 for ((expr) = nft_expr_first(rule), (last) = nft_expr_last(rule); \
957 (expr) = nft_expr_next(expr))
959 #define NFT_CHAIN_POLICY_UNSET U8_MAX
962 * struct nft_chain - nf_tables chain
964 * @rules: list of rules in the chain
965 * @list: used internally
966 * @rhlhead: used internally
967 * @table: table that this chain belongs to
968 * @handle: chain handle
969 * @use: number of jump references to this chain
970 * @flags: bitmask of enum nft_chain_flags
971 * @name: name of the chain
974 struct nft_rule *__rcu *rules_gen_0;
975 struct nft_rule *__rcu *rules_gen_1;
976 struct list_head rules;
977 struct list_head list;
978 struct rhlist_head rhlhead;
979 struct nft_table *table;
989 /* Only used during control plane commit phase: */
990 struct nft_rule **rules_next;
993 int nft_chain_validate(const struct nft_ctx *ctx, const struct nft_chain *chain);
995 enum nft_chain_types {
996 NFT_CHAIN_T_DEFAULT = 0,
1003 * struct nft_chain_type - nf_tables chain type info
1005 * @name: name of the type
1006 * @type: numeric identifier
1007 * @family: address family
1008 * @owner: module owner
1009 * @hook_mask: mask of valid hooks
1010 * @hooks: array of hook functions
1011 * @ops_register: base chain register function
1012 * @ops_unregister: base chain unregister function
1014 struct nft_chain_type {
1016 enum nft_chain_types type;
1018 struct module *owner;
1019 unsigned int hook_mask;
1020 nf_hookfn *hooks[NFT_MAX_HOOKS];
1021 int (*ops_register)(struct net *net, const struct nf_hook_ops *ops);
1022 void (*ops_unregister)(struct net *net, const struct nf_hook_ops *ops);
1025 int nft_chain_validate_dependency(const struct nft_chain *chain,
1026 enum nft_chain_types type);
1027 int nft_chain_validate_hooks(const struct nft_chain *chain,
1028 unsigned int hook_flags);
1030 static inline bool nft_chain_is_bound(struct nft_chain *chain)
1032 return (chain->flags & NFT_CHAIN_BINDING) && chain->bound;
1035 void nft_chain_del(struct nft_chain *chain);
1036 void nf_tables_chain_destroy(struct nft_ctx *ctx);
1041 struct u64_stats_sync syncp;
1045 struct list_head list;
1047 struct nf_hook_ops ops;
1048 struct rcu_head rcu;
1052 * struct nft_base_chain - nf_tables base chain
1054 * @ops: netfilter hook ops
1055 * @hook_list: list of netfilter hooks (for NFPROTO_NETDEV family)
1057 * @policy: default policy
1058 * @stats: per-cpu chain stats
1060 * @flow_block: flow block (for hardware offload)
1062 struct nft_base_chain {
1063 struct nf_hook_ops ops;
1064 struct list_head hook_list;
1065 const struct nft_chain_type *type;
1068 struct nft_stats __percpu *stats;
1069 struct nft_chain chain;
1070 struct flow_block flow_block;
1073 static inline struct nft_base_chain *nft_base_chain(const struct nft_chain *chain)
1075 return container_of(chain, struct nft_base_chain, chain);
1078 static inline bool nft_is_base_chain(const struct nft_chain *chain)
1080 return chain->flags & NFT_CHAIN_BASE;
1083 int __nft_release_basechain(struct nft_ctx *ctx);
1085 unsigned int nft_do_chain(struct nft_pktinfo *pkt, void *priv);
1088 * struct nft_table - nf_tables table
1090 * @list: used internally
1091 * @chains_ht: chains in the table
1092 * @chains: same, for stable walks
1093 * @sets: sets in the table
1094 * @objects: stateful objects in the table
1095 * @flowtables: flow tables in the table
1096 * @hgenerator: handle generator state
1097 * @handle: table handle
1098 * @use: number of chain references to this table
1099 * @flags: table flag (see enum nft_table_flags)
1100 * @genmask: generation mask
1101 * @afinfo: address family info
1102 * @name: name of the table
1105 struct list_head list;
1106 struct rhltable chains_ht;
1107 struct list_head chains;
1108 struct list_head sets;
1109 struct list_head objects;
1110 struct list_head flowtables;
1123 static inline bool nft_table_has_owner(const struct nft_table *table)
1125 return table->flags & NFT_TABLE_F_OWNER;
1128 static inline bool nft_base_chain_netdev(int family, u32 hooknum)
1130 return family == NFPROTO_NETDEV ||
1131 (family == NFPROTO_INET && hooknum == NF_INET_INGRESS);
1134 void nft_register_chain_type(const struct nft_chain_type *);
1135 void nft_unregister_chain_type(const struct nft_chain_type *);
1137 int nft_register_expr(struct nft_expr_type *);
1138 void nft_unregister_expr(struct nft_expr_type *);
1140 int nft_verdict_dump(struct sk_buff *skb, int type,
1141 const struct nft_verdict *v);
1144 * struct nft_object_hash_key - key to lookup nft_object
1146 * @name: name of the stateful object to look up
1147 * @table: table the object belongs to
1149 struct nft_object_hash_key {
1151 const struct nft_table *table;
1155 * struct nft_object - nf_tables stateful object
1157 * @list: table stateful object list node
1158 * @key: keys that identify this object
1159 * @rhlhead: nft_objname_ht node
1160 * @genmask: generation mask
1161 * @use: number of references to this stateful object
1162 * @handle: unique object handle
1163 * @ops: object operations
1164 * @data: object data, layout depends on type
1167 struct list_head list;
1168 struct rhlist_head rhlhead;
1169 struct nft_object_hash_key key;
1175 /* runtime data below here */
1176 const struct nft_object_ops *ops ____cacheline_aligned;
1177 unsigned char data[]
1178 __attribute__((aligned(__alignof__(u64))));
1181 static inline void *nft_obj_data(const struct nft_object *obj)
1183 return (void *)obj->data;
1186 #define nft_expr_obj(expr) *((struct nft_object **)nft_expr_priv(expr))
1188 struct nft_object *nft_obj_lookup(const struct net *net,
1189 const struct nft_table *table,
1190 const struct nlattr *nla, u32 objtype,
1193 void nft_obj_notify(struct net *net, const struct nft_table *table,
1194 struct nft_object *obj, u32 portid, u32 seq,
1195 int event, int family, int report, gfp_t gfp);
1198 * struct nft_object_type - stateful object type
1200 * @select_ops: function to select nft_object_ops
1201 * @ops: default ops, used when no select_ops functions is present
1202 * @list: list node in list of object types
1203 * @type: stateful object numeric type
1204 * @owner: module owner
1205 * @maxattr: maximum netlink attribute
1206 * @policy: netlink attribute policy
1208 struct nft_object_type {
1209 const struct nft_object_ops *(*select_ops)(const struct nft_ctx *,
1210 const struct nlattr * const tb[]);
1211 const struct nft_object_ops *ops;
1212 struct list_head list;
1214 unsigned int maxattr;
1215 struct module *owner;
1216 const struct nla_policy *policy;
1220 * struct nft_object_ops - stateful object operations
1222 * @eval: stateful object evaluation function
1223 * @size: stateful object size
1224 * @init: initialize object from netlink attributes
1225 * @destroy: release existing stateful object
1226 * @dump: netlink dump stateful object
1227 * @update: update stateful object
1229 struct nft_object_ops {
1230 void (*eval)(struct nft_object *obj,
1231 struct nft_regs *regs,
1232 const struct nft_pktinfo *pkt);
1234 int (*init)(const struct nft_ctx *ctx,
1235 const struct nlattr *const tb[],
1236 struct nft_object *obj);
1237 void (*destroy)(const struct nft_ctx *ctx,
1238 struct nft_object *obj);
1239 int (*dump)(struct sk_buff *skb,
1240 struct nft_object *obj,
1242 void (*update)(struct nft_object *obj,
1243 struct nft_object *newobj);
1244 const struct nft_object_type *type;
1247 int nft_register_obj(struct nft_object_type *obj_type);
1248 void nft_unregister_obj(struct nft_object_type *obj_type);
1250 #define NFT_NETDEVICE_MAX 256
1253 * struct nft_flowtable - nf_tables flow table
1255 * @list: flow table list node in table list
1256 * @table: the table the flow table is contained in
1257 * @name: name of this flow table
1258 * @hooknum: hook number
1259 * @ops_len: number of hooks in array
1260 * @genmask: generation mask
1261 * @use: number of references to this flow table
1262 * @handle: unique object handle
1263 * @dev_name: array of device names
1264 * @data: rhashtable and garbage collector
1265 * @ops: array of hooks
1267 struct nft_flowtable {
1268 struct list_head list;
1269 struct nft_table *table;
1276 /* runtime data below here */
1277 struct list_head hook_list ____cacheline_aligned;
1278 struct nf_flowtable data;
1281 struct nft_flowtable *nft_flowtable_lookup(const struct nft_table *table,
1282 const struct nlattr *nla,
1285 void nf_tables_deactivate_flowtable(const struct nft_ctx *ctx,
1286 struct nft_flowtable *flowtable,
1287 enum nft_trans_phase phase);
1289 void nft_register_flowtable_type(struct nf_flowtable_type *type);
1290 void nft_unregister_flowtable_type(struct nf_flowtable_type *type);
1293 * struct nft_traceinfo - nft tracing information and state
1295 * @pkt: pktinfo currently processed
1296 * @basechain: base chain currently processed
1297 * @chain: chain currently processed
1298 * @rule: rule that was evaluated
1299 * @verdict: verdict given by rule
1300 * @type: event type (enum nft_trace_types)
1301 * @packet_dumped: packet headers sent in a previous traceinfo message
1302 * @trace: other struct members are initialised
1304 struct nft_traceinfo {
1305 const struct nft_pktinfo *pkt;
1306 const struct nft_base_chain *basechain;
1307 const struct nft_chain *chain;
1308 const struct nft_rule *rule;
1309 const struct nft_verdict *verdict;
1310 enum nft_trace_types type;
1315 void nft_trace_init(struct nft_traceinfo *info, const struct nft_pktinfo *pkt,
1316 const struct nft_verdict *verdict,
1317 const struct nft_chain *basechain);
1319 void nft_trace_notify(struct nft_traceinfo *info);
1321 #define MODULE_ALIAS_NFT_CHAIN(family, name) \
1322 MODULE_ALIAS("nft-chain-" __stringify(family) "-" name)
1324 #define MODULE_ALIAS_NFT_AF_EXPR(family, name) \
1325 MODULE_ALIAS("nft-expr-" __stringify(family) "-" name)
1327 #define MODULE_ALIAS_NFT_EXPR(name) \
1328 MODULE_ALIAS("nft-expr-" name)
1330 #define MODULE_ALIAS_NFT_OBJ(type) \
1331 MODULE_ALIAS("nft-obj-" __stringify(type))
1333 #if IS_ENABLED(CONFIG_NF_TABLES)
1336 * The gencursor defines two generations, the currently active and the
1337 * next one. Objects contain a bitmask of 2 bits specifying the generations
1338 * they're active in. A set bit means they're inactive in the generation
1339 * represented by that bit.
1341 * New objects start out as inactive in the current and active in the
1342 * next generation. When committing the ruleset the bitmask is cleared,
1343 * meaning they're active in all generations. When removing an object,
1344 * it is set inactive in the next generation. After committing the ruleset,
1345 * the objects are removed.
1347 static inline unsigned int nft_gencursor_next(const struct net *net)
1349 return net->nft.gencursor + 1 == 1 ? 1 : 0;
1352 static inline u8 nft_genmask_next(const struct net *net)
1354 return 1 << nft_gencursor_next(net);
1357 static inline u8 nft_genmask_cur(const struct net *net)
1359 /* Use READ_ONCE() to prevent refetching the value for atomicity */
1360 return 1 << READ_ONCE(net->nft.gencursor);
1363 #define NFT_GENMASK_ANY ((1 << 0) | (1 << 1))
1366 * Generic transaction helpers
1369 /* Check if this object is currently active. */
1370 #define nft_is_active(__net, __obj) \
1371 (((__obj)->genmask & nft_genmask_cur(__net)) == 0)
1373 /* Check if this object is active in the next generation. */
1374 #define nft_is_active_next(__net, __obj) \
1375 (((__obj)->genmask & nft_genmask_next(__net)) == 0)
1377 /* This object becomes active in the next generation. */
1378 #define nft_activate_next(__net, __obj) \
1379 (__obj)->genmask = nft_genmask_cur(__net)
1381 /* This object becomes inactive in the next generation. */
1382 #define nft_deactivate_next(__net, __obj) \
1383 (__obj)->genmask = nft_genmask_next(__net)
1385 /* After committing the ruleset, clear the stale generation bit. */
1386 #define nft_clear(__net, __obj) \
1387 (__obj)->genmask &= ~nft_genmask_next(__net)
1388 #define nft_active_genmask(__obj, __genmask) \
1389 !((__obj)->genmask & __genmask)
1392 * Set element transaction helpers
1395 static inline bool nft_set_elem_active(const struct nft_set_ext *ext,
1398 return !(ext->genmask & genmask);
1401 static inline void nft_set_elem_change_active(const struct net *net,
1402 const struct nft_set *set,
1403 struct nft_set_ext *ext)
1405 ext->genmask ^= nft_genmask_next(net);
1408 #endif /* IS_ENABLED(CONFIG_NF_TABLES) */
1411 * We use a free bit in the genmask field to indicate the element
1412 * is busy, meaning it is currently being processed either by
1413 * the netlink API or GC.
1415 * Even though the genmask is only a single byte wide, this works
1416 * because the extension structure if fully constant once initialized,
1417 * so there are no non-atomic write accesses unless it is already
1420 #define NFT_SET_ELEM_BUSY_MASK (1 << 2)
1422 #if defined(__LITTLE_ENDIAN_BITFIELD)
1423 #define NFT_SET_ELEM_BUSY_BIT 2
1424 #elif defined(__BIG_ENDIAN_BITFIELD)
1425 #define NFT_SET_ELEM_BUSY_BIT (BITS_PER_LONG - BITS_PER_BYTE + 2)
1430 static inline int nft_set_elem_mark_busy(struct nft_set_ext *ext)
1432 unsigned long *word = (unsigned long *)ext;
1434 BUILD_BUG_ON(offsetof(struct nft_set_ext, genmask) != 0);
1435 return test_and_set_bit(NFT_SET_ELEM_BUSY_BIT, word);
1438 static inline void nft_set_elem_clear_busy(struct nft_set_ext *ext)
1440 unsigned long *word = (unsigned long *)ext;
1442 clear_bit(NFT_SET_ELEM_BUSY_BIT, word);
1446 * struct nft_trans - nf_tables object update in transaction
1448 * @list: used internally
1449 * @msg_type: message type
1450 * @put_net: ctx->net needs to be put
1451 * @ctx: transaction context
1452 * @data: internal information related to the transaction
1455 struct list_head list;
1462 struct nft_trans_rule {
1463 struct nft_rule *rule;
1464 struct nft_flow_rule *flow;
1468 #define nft_trans_rule(trans) \
1469 (((struct nft_trans_rule *)trans->data)->rule)
1470 #define nft_trans_flow_rule(trans) \
1471 (((struct nft_trans_rule *)trans->data)->flow)
1472 #define nft_trans_rule_id(trans) \
1473 (((struct nft_trans_rule *)trans->data)->rule_id)
1475 struct nft_trans_set {
1476 struct nft_set *set;
1481 #define nft_trans_set(trans) \
1482 (((struct nft_trans_set *)trans->data)->set)
1483 #define nft_trans_set_id(trans) \
1484 (((struct nft_trans_set *)trans->data)->set_id)
1485 #define nft_trans_set_bound(trans) \
1486 (((struct nft_trans_set *)trans->data)->bound)
1488 struct nft_trans_chain {
1491 struct nft_stats __percpu *stats;
1496 #define nft_trans_chain_update(trans) \
1497 (((struct nft_trans_chain *)trans->data)->update)
1498 #define nft_trans_chain_name(trans) \
1499 (((struct nft_trans_chain *)trans->data)->name)
1500 #define nft_trans_chain_stats(trans) \
1501 (((struct nft_trans_chain *)trans->data)->stats)
1502 #define nft_trans_chain_policy(trans) \
1503 (((struct nft_trans_chain *)trans->data)->policy)
1504 #define nft_trans_chain_id(trans) \
1505 (((struct nft_trans_chain *)trans->data)->chain_id)
1507 struct nft_trans_table {
1511 #define nft_trans_table_update(trans) \
1512 (((struct nft_trans_table *)trans->data)->update)
1514 struct nft_trans_elem {
1515 struct nft_set *set;
1516 struct nft_set_elem elem;
1520 #define nft_trans_elem_set(trans) \
1521 (((struct nft_trans_elem *)trans->data)->set)
1522 #define nft_trans_elem(trans) \
1523 (((struct nft_trans_elem *)trans->data)->elem)
1524 #define nft_trans_elem_set_bound(trans) \
1525 (((struct nft_trans_elem *)trans->data)->bound)
1527 struct nft_trans_obj {
1528 struct nft_object *obj;
1529 struct nft_object *newobj;
1533 #define nft_trans_obj(trans) \
1534 (((struct nft_trans_obj *)trans->data)->obj)
1535 #define nft_trans_obj_newobj(trans) \
1536 (((struct nft_trans_obj *)trans->data)->newobj)
1537 #define nft_trans_obj_update(trans) \
1538 (((struct nft_trans_obj *)trans->data)->update)
1540 struct nft_trans_flowtable {
1541 struct nft_flowtable *flowtable;
1543 struct list_head hook_list;
1547 #define nft_trans_flowtable(trans) \
1548 (((struct nft_trans_flowtable *)trans->data)->flowtable)
1549 #define nft_trans_flowtable_update(trans) \
1550 (((struct nft_trans_flowtable *)trans->data)->update)
1551 #define nft_trans_flowtable_hooks(trans) \
1552 (((struct nft_trans_flowtable *)trans->data)->hook_list)
1553 #define nft_trans_flowtable_flags(trans) \
1554 (((struct nft_trans_flowtable *)trans->data)->flags)
1556 int __init nft_chain_filter_init(void);
1557 void nft_chain_filter_fini(void);
1559 void __init nft_chain_route_init(void);
1560 void nft_chain_route_fini(void);
1562 void nf_tables_trans_destroy_flush_work(void);
1564 int nf_msecs_to_jiffies64(const struct nlattr *nla, u64 *result);
1565 __be64 nf_jiffies64_to_msecs(u64 input);
1567 #ifdef CONFIG_MODULES
1568 __printf(2, 3) int nft_request_module(struct net *net, const char *fmt, ...);
1570 static inline int nft_request_module(struct net *net, const char *fmt, ...) { return -ENOENT; }
1573 struct nftables_pernet {
1574 struct list_head tables;
1575 struct list_head commit_list;
1576 struct list_head module_list;
1577 struct list_head notify_list;
1578 struct mutex commit_mutex;
1579 unsigned int base_seq;
1583 extern unsigned int nf_tables_net_id;
1585 static inline struct nftables_pernet *nft_pernet(const struct net *net)
1587 return net_generic(net, nf_tables_net_id);
1590 #endif /* _NET_NF_TABLES_H */