1 #ifndef _NET_NF_TABLES_H
2 #define _NET_NF_TABLES_H
4 #include <linux/module.h>
5 #include <linux/list.h>
6 #include <linux/netfilter.h>
7 #include <linux/netfilter/nfnetlink.h>
8 #include <linux/netfilter/x_tables.h>
9 #include <linux/netfilter/nf_tables.h>
10 #include <linux/u64_stats_sync.h>
11 #include <net/netlink.h>
13 #define NFT_JUMP_STACK_SIZE 16
18 const struct net_device *in;
19 const struct net_device *out;
23 /* for x_tables compatibility */
24 struct xt_action_param xt;
27 static inline void nft_set_pktinfo(struct nft_pktinfo *pkt,
29 const struct nf_hook_state *state)
32 pkt->net = pkt->xt.net = state->net;
33 pkt->in = pkt->xt.in = state->in;
34 pkt->out = pkt->xt.out = state->out;
35 pkt->hook = pkt->xt.hooknum = state->hook;
36 pkt->pf = pkt->xt.family = state->pf;
40 * struct nft_verdict - nf_tables verdict
42 * @code: nf_tables/netfilter verdict code
43 * @chain: destination chain for NFT_JUMP/NFT_GOTO
47 struct nft_chain *chain;
53 struct nft_verdict verdict;
55 } __attribute__((aligned(__alignof__(u64))));
58 * struct nft_regs - nf_tables register set
60 * @data: data registers
61 * @verdict: verdict register
63 * The first four data registers alias to the verdict register.
68 struct nft_verdict verdict;
72 static inline void nft_data_copy(u32 *dst, const struct nft_data *src,
75 memcpy(dst, src, len);
78 static inline void nft_data_debug(const struct nft_data *data)
80 pr_debug("data[0]=%x data[1]=%x data[2]=%x data[3]=%x\n",
81 data->data[0], data->data[1],
82 data->data[2], data->data[3]);
86 * struct nft_ctx - nf_tables rule/set context
89 * @afi: address family info
90 * @table: the table the chain is contained in
91 * @chain: the chain the rule is contained in
92 * @nla: netlink attributes
93 * @portid: netlink portID of the original message
94 * @seq: netlink sequence number
95 * @report: notify via unicast netlink message
99 struct nft_af_info *afi;
100 struct nft_table *table;
101 struct nft_chain *chain;
102 const struct nlattr * const *nla;
108 struct nft_data_desc {
109 enum nft_data_types type;
113 int nft_data_init(const struct nft_ctx *ctx,
114 struct nft_data *data, unsigned int size,
115 struct nft_data_desc *desc, const struct nlattr *nla);
116 void nft_data_uninit(const struct nft_data *data, enum nft_data_types type);
117 int nft_data_dump(struct sk_buff *skb, int attr, const struct nft_data *data,
118 enum nft_data_types type, unsigned int len);
120 static inline enum nft_data_types nft_dreg_to_type(enum nft_registers reg)
122 return reg == NFT_REG_VERDICT ? NFT_DATA_VERDICT : NFT_DATA_VALUE;
125 static inline enum nft_registers nft_type_to_reg(enum nft_data_types type)
127 return type == NFT_DATA_VERDICT ? NFT_REG_VERDICT : NFT_REG_1 * NFT_REG_SIZE / NFT_REG32_SIZE;
130 unsigned int nft_parse_register(const struct nlattr *attr);
131 int nft_dump_register(struct sk_buff *skb, unsigned int attr, unsigned int reg);
133 int nft_validate_register_load(enum nft_registers reg, unsigned int len);
134 int nft_validate_register_store(const struct nft_ctx *ctx,
135 enum nft_registers reg,
136 const struct nft_data *data,
137 enum nft_data_types type, unsigned int len);
140 * struct nft_userdata - user defined data associated with an object
142 * @len: length of the data
145 * The presence of user data is indicated in an object specific fashion,
146 * so a length of zero can't occur and the value "len" indicates data
149 struct nft_userdata {
151 unsigned char data[0];
155 * struct nft_set_elem - generic representation of set elements
158 * @priv: element private data and extensions
160 struct nft_set_elem {
162 u32 buf[NFT_DATA_VALUE_MAXLEN / sizeof(u32)];
169 struct nft_set_iter {
173 int (*fn)(const struct nft_ctx *ctx,
174 const struct nft_set *set,
175 const struct nft_set_iter *iter,
176 const struct nft_set_elem *elem);
180 * struct nft_set_desc - description of set elements
184 * @size: number of set elements
186 struct nft_set_desc {
193 * enum nft_set_class - performance class
195 * @NFT_LOOKUP_O_1: constant, O(1)
196 * @NFT_LOOKUP_O_LOG_N: logarithmic, O(log N)
197 * @NFT_LOOKUP_O_N: linear, O(N)
201 NFT_SET_CLASS_O_LOG_N,
206 * struct nft_set_estimate - estimation of memory and performance
209 * @size: required memory
210 * @class: lookup performance class
212 struct nft_set_estimate {
214 enum nft_set_class class;
221 * struct nft_set_ops - nf_tables set operations
223 * @lookup: look up an element within the set
224 * @insert: insert new element into set
225 * @activate: activate new element in the next generation
226 * @deactivate: deactivate element in the next generation
227 * @remove: remove element from set
228 * @walk: iterate over all set elemeennts
229 * @privsize: function to return size of set private data
230 * @init: initialize private data of new set instance
231 * @destroy: destroy private data of set instance
232 * @list: nf_tables_set_ops list node
233 * @owner: module reference
234 * @elemsize: element private size
235 * @features: features supported by the implementation
238 bool (*lookup)(const struct nft_set *set,
240 const struct nft_set_ext **ext);
241 bool (*update)(struct nft_set *set,
243 void *(*new)(struct nft_set *,
244 const struct nft_expr *,
246 const struct nft_expr *expr,
247 struct nft_regs *regs,
248 const struct nft_set_ext **ext);
250 int (*insert)(const struct nft_set *set,
251 const struct nft_set_elem *elem);
252 void (*activate)(const struct nft_set *set,
253 const struct nft_set_elem *elem);
254 void * (*deactivate)(const struct nft_set *set,
255 const struct nft_set_elem *elem);
256 void (*remove)(const struct nft_set *set,
257 const struct nft_set_elem *elem);
258 void (*walk)(const struct nft_ctx *ctx,
259 const struct nft_set *set,
260 struct nft_set_iter *iter);
262 unsigned int (*privsize)(const struct nlattr * const nla[]);
263 bool (*estimate)(const struct nft_set_desc *desc,
265 struct nft_set_estimate *est);
266 int (*init)(const struct nft_set *set,
267 const struct nft_set_desc *desc,
268 const struct nlattr * const nla[]);
269 void (*destroy)(const struct nft_set *set);
271 struct list_head list;
272 struct module *owner;
273 unsigned int elemsize;
277 int nft_register_set(struct nft_set_ops *ops);
278 void nft_unregister_set(struct nft_set_ops *ops);
281 * struct nft_set - nf_tables set instance
283 * @list: table set list node
284 * @bindings: list of set bindings
285 * @name: name of the set
286 * @ktype: key type (numeric type defined by userspace, not used in the kernel)
287 * @dtype: data type (verdict or numeric type defined by userspace)
288 * @size: maximum set size
289 * @nelems: number of elements
290 * @ndeact: number of deactivated elements queued for removal
291 * @timeout: default timeout value in msecs
292 * @gc_int: garbage collection interval in msecs
293 * @policy: set parameterization (see enum nft_set_policies)
294 * @udlen: user data length
297 * @pnet: network namespace
301 * @data: private set data
304 struct list_head list;
305 struct list_head bindings;
306 char name[NFT_SET_MAXNAMELEN];
316 unsigned char *udata;
317 /* runtime data below here */
318 const struct nft_set_ops *ops ____cacheline_aligned;
324 __attribute__((aligned(__alignof__(u64))));
327 static inline void *nft_set_priv(const struct nft_set *set)
329 return (void *)set->data;
332 static inline struct nft_set *nft_set_container_of(const void *priv)
334 return (void *)priv - offsetof(struct nft_set, data);
337 struct nft_set *nf_tables_set_lookup(const struct nft_table *table,
338 const struct nlattr *nla);
339 struct nft_set *nf_tables_set_lookup_byid(const struct net *net,
340 const struct nlattr *nla);
342 static inline unsigned long nft_set_gc_interval(const struct nft_set *set)
344 return set->gc_int ? msecs_to_jiffies(set->gc_int) : HZ;
348 * struct nft_set_binding - nf_tables set binding
350 * @list: set bindings list node
351 * @chain: chain containing the rule bound to the set
352 * @flags: set action flags
354 * A set binding contains all information necessary for validation
355 * of new elements added to a bound set.
357 struct nft_set_binding {
358 struct list_head list;
359 const struct nft_chain *chain;
363 int nf_tables_bind_set(const struct nft_ctx *ctx, struct nft_set *set,
364 struct nft_set_binding *binding);
365 void nf_tables_unbind_set(const struct nft_ctx *ctx, struct nft_set *set,
366 struct nft_set_binding *binding);
369 * enum nft_set_extensions - set extension type IDs
371 * @NFT_SET_EXT_KEY: element key
372 * @NFT_SET_EXT_DATA: mapping data
373 * @NFT_SET_EXT_FLAGS: element flags
374 * @NFT_SET_EXT_TIMEOUT: element timeout
375 * @NFT_SET_EXT_EXPIRATION: element expiration time
376 * @NFT_SET_EXT_USERDATA: user data associated with the element
377 * @NFT_SET_EXT_EXPR: expression assiociated with the element
378 * @NFT_SET_EXT_NUM: number of extension types
380 enum nft_set_extensions {
385 NFT_SET_EXT_EXPIRATION,
386 NFT_SET_EXT_USERDATA,
392 * struct nft_set_ext_type - set extension type
394 * @len: fixed part length of the extension
395 * @align: alignment requirements of the extension
397 struct nft_set_ext_type {
402 extern const struct nft_set_ext_type nft_set_ext_types[];
405 * struct nft_set_ext_tmpl - set extension template
407 * @len: length of extension area
408 * @offset: offsets of individual extension types
410 struct nft_set_ext_tmpl {
412 u8 offset[NFT_SET_EXT_NUM];
416 * struct nft_set_ext - set extensions
418 * @genmask: generation mask
419 * @offset: offsets of individual extension types
420 * @data: beginning of extension data
424 u8 offset[NFT_SET_EXT_NUM];
428 static inline void nft_set_ext_prepare(struct nft_set_ext_tmpl *tmpl)
430 memset(tmpl, 0, sizeof(*tmpl));
431 tmpl->len = sizeof(struct nft_set_ext);
434 static inline void nft_set_ext_add_length(struct nft_set_ext_tmpl *tmpl, u8 id,
437 tmpl->len = ALIGN(tmpl->len, nft_set_ext_types[id].align);
438 BUG_ON(tmpl->len > U8_MAX);
439 tmpl->offset[id] = tmpl->len;
440 tmpl->len += nft_set_ext_types[id].len + len;
443 static inline void nft_set_ext_add(struct nft_set_ext_tmpl *tmpl, u8 id)
445 nft_set_ext_add_length(tmpl, id, 0);
448 static inline void nft_set_ext_init(struct nft_set_ext *ext,
449 const struct nft_set_ext_tmpl *tmpl)
451 memcpy(ext->offset, tmpl->offset, sizeof(ext->offset));
454 static inline bool __nft_set_ext_exists(const struct nft_set_ext *ext, u8 id)
456 return !!ext->offset[id];
459 static inline bool nft_set_ext_exists(const struct nft_set_ext *ext, u8 id)
461 return ext && __nft_set_ext_exists(ext, id);
464 static inline void *nft_set_ext(const struct nft_set_ext *ext, u8 id)
466 return (void *)ext + ext->offset[id];
469 static inline struct nft_data *nft_set_ext_key(const struct nft_set_ext *ext)
471 return nft_set_ext(ext, NFT_SET_EXT_KEY);
474 static inline struct nft_data *nft_set_ext_data(const struct nft_set_ext *ext)
476 return nft_set_ext(ext, NFT_SET_EXT_DATA);
479 static inline u8 *nft_set_ext_flags(const struct nft_set_ext *ext)
481 return nft_set_ext(ext, NFT_SET_EXT_FLAGS);
484 static inline u64 *nft_set_ext_timeout(const struct nft_set_ext *ext)
486 return nft_set_ext(ext, NFT_SET_EXT_TIMEOUT);
489 static inline unsigned long *nft_set_ext_expiration(const struct nft_set_ext *ext)
491 return nft_set_ext(ext, NFT_SET_EXT_EXPIRATION);
494 static inline struct nft_userdata *nft_set_ext_userdata(const struct nft_set_ext *ext)
496 return nft_set_ext(ext, NFT_SET_EXT_USERDATA);
499 static inline struct nft_expr *nft_set_ext_expr(const struct nft_set_ext *ext)
501 return nft_set_ext(ext, NFT_SET_EXT_EXPR);
504 static inline bool nft_set_elem_expired(const struct nft_set_ext *ext)
506 return nft_set_ext_exists(ext, NFT_SET_EXT_EXPIRATION) &&
507 time_is_before_eq_jiffies(*nft_set_ext_expiration(ext));
510 static inline struct nft_set_ext *nft_set_elem_ext(const struct nft_set *set,
513 return elem + set->ops->elemsize;
516 void *nft_set_elem_init(const struct nft_set *set,
517 const struct nft_set_ext_tmpl *tmpl,
518 const u32 *key, const u32 *data,
519 u64 timeout, gfp_t gfp);
520 void nft_set_elem_destroy(const struct nft_set *set, void *elem);
523 * struct nft_set_gc_batch_head - nf_tables set garbage collection batch
526 * @set: set the elements belong to
527 * @cnt: count of elements
529 struct nft_set_gc_batch_head {
531 const struct nft_set *set;
535 #define NFT_SET_GC_BATCH_SIZE ((PAGE_SIZE - \
536 sizeof(struct nft_set_gc_batch_head)) / \
540 * struct nft_set_gc_batch - nf_tables set garbage collection batch
542 * @head: GC batch head
543 * @elems: garbage collection elements
545 struct nft_set_gc_batch {
546 struct nft_set_gc_batch_head head;
547 void *elems[NFT_SET_GC_BATCH_SIZE];
550 struct nft_set_gc_batch *nft_set_gc_batch_alloc(const struct nft_set *set,
552 void nft_set_gc_batch_release(struct rcu_head *rcu);
554 static inline void nft_set_gc_batch_complete(struct nft_set_gc_batch *gcb)
557 call_rcu(&gcb->head.rcu, nft_set_gc_batch_release);
560 static inline struct nft_set_gc_batch *
561 nft_set_gc_batch_check(const struct nft_set *set, struct nft_set_gc_batch *gcb,
565 if (gcb->head.cnt + 1 < ARRAY_SIZE(gcb->elems))
567 nft_set_gc_batch_complete(gcb);
569 return nft_set_gc_batch_alloc(set, gfp);
572 static inline void nft_set_gc_batch_add(struct nft_set_gc_batch *gcb,
575 gcb->elems[gcb->head.cnt++] = elem;
579 * struct nft_expr_type - nf_tables expression type
581 * @select_ops: function to select nft_expr_ops
582 * @ops: default ops, used when no select_ops functions is present
583 * @list: used internally
585 * @owner: module reference
586 * @policy: netlink attribute policy
587 * @maxattr: highest netlink attribute number
588 * @family: address family for AF-specific types
589 * @flags: expression type flags
591 struct nft_expr_type {
592 const struct nft_expr_ops *(*select_ops)(const struct nft_ctx *,
593 const struct nlattr * const tb[]);
594 const struct nft_expr_ops *ops;
595 struct list_head list;
597 struct module *owner;
598 const struct nla_policy *policy;
599 unsigned int maxattr;
604 #define NFT_EXPR_STATEFUL 0x1
607 * struct nft_expr_ops - nf_tables expression operations
609 * @eval: Expression evaluation function
610 * @size: full expression size, including private data size
611 * @init: initialization function
612 * @destroy: destruction function
613 * @dump: function to dump parameters
614 * @type: expression type
615 * @validate: validate expression, called during loop detection
616 * @data: extra data to attach to this expression operation
619 struct nft_expr_ops {
620 void (*eval)(const struct nft_expr *expr,
621 struct nft_regs *regs,
622 const struct nft_pktinfo *pkt);
623 int (*clone)(struct nft_expr *dst,
624 const struct nft_expr *src);
627 int (*init)(const struct nft_ctx *ctx,
628 const struct nft_expr *expr,
629 const struct nlattr * const tb[]);
630 void (*destroy)(const struct nft_ctx *ctx,
631 const struct nft_expr *expr);
632 int (*dump)(struct sk_buff *skb,
633 const struct nft_expr *expr);
634 int (*validate)(const struct nft_ctx *ctx,
635 const struct nft_expr *expr,
636 const struct nft_data **data);
637 const struct nft_expr_type *type;
641 #define NFT_EXPR_MAXATTR 16
642 #define NFT_EXPR_SIZE(size) (sizeof(struct nft_expr) + \
643 ALIGN(size, __alignof__(struct nft_expr)))
646 * struct nft_expr - nf_tables expression
648 * @ops: expression ops
649 * @data: expression private data
652 const struct nft_expr_ops *ops;
653 unsigned char data[];
656 static inline void *nft_expr_priv(const struct nft_expr *expr)
658 return (void *)expr->data;
661 struct nft_expr *nft_expr_init(const struct nft_ctx *ctx,
662 const struct nlattr *nla);
663 void nft_expr_destroy(const struct nft_ctx *ctx, struct nft_expr *expr);
664 int nft_expr_dump(struct sk_buff *skb, unsigned int attr,
665 const struct nft_expr *expr);
667 static inline int nft_expr_clone(struct nft_expr *dst, struct nft_expr *src)
671 __module_get(src->ops->type->owner);
672 if (src->ops->clone) {
674 err = src->ops->clone(dst, src);
678 memcpy(dst, src, src->ops->size);
684 * struct nft_rule - nf_tables rule
686 * @list: used internally
687 * @handle: rule handle
688 * @genmask: generation mask
689 * @dlen: length of expression data
690 * @udata: user data is appended to the rule
691 * @data: expression data
694 struct list_head list;
700 __attribute__((aligned(__alignof__(struct nft_expr))));
703 static inline struct nft_expr *nft_expr_first(const struct nft_rule *rule)
705 return (struct nft_expr *)&rule->data[0];
708 static inline struct nft_expr *nft_expr_next(const struct nft_expr *expr)
710 return ((void *)expr) + expr->ops->size;
713 static inline struct nft_expr *nft_expr_last(const struct nft_rule *rule)
715 return (struct nft_expr *)&rule->data[rule->dlen];
718 static inline struct nft_userdata *nft_userdata(const struct nft_rule *rule)
720 return (void *)&rule->data[rule->dlen];
724 * The last pointer isn't really necessary, but the compiler isn't able to
725 * determine that the result of nft_expr_last() is always the same since it
726 * can't assume that the dlen value wasn't changed within calls in the loop.
728 #define nft_rule_for_each_expr(expr, last, rule) \
729 for ((expr) = nft_expr_first(rule), (last) = nft_expr_last(rule); \
731 (expr) = nft_expr_next(expr))
733 enum nft_chain_flags {
734 NFT_BASE_CHAIN = 0x1,
735 NFT_CHAIN_INACTIVE = 0x2,
739 * struct nft_chain - nf_tables chain
741 * @rules: list of rules in the chain
742 * @list: used internally
743 * @table: table that this chain belongs to
744 * @handle: chain handle
745 * @use: number of jump references to this chain
746 * @level: length of longest path to this chain
747 * @flags: bitmask of enum nft_chain_flags
748 * @name: name of the chain
751 struct list_head rules;
752 struct list_head list;
753 struct nft_table *table;
758 char name[NFT_CHAIN_MAXNAMELEN];
761 enum nft_chain_type {
762 NFT_CHAIN_T_DEFAULT = 0,
769 * struct nf_chain_type - nf_tables chain type info
771 * @name: name of the type
772 * @type: numeric identifier
773 * @family: address family
774 * @owner: module owner
775 * @hook_mask: mask of valid hooks
776 * @hooks: hookfn overrides
778 struct nf_chain_type {
780 enum nft_chain_type type;
782 struct module *owner;
783 unsigned int hook_mask;
784 nf_hookfn *hooks[NF_MAX_HOOKS];
787 int nft_chain_validate_dependency(const struct nft_chain *chain,
788 enum nft_chain_type type);
789 int nft_chain_validate_hooks(const struct nft_chain *chain,
790 unsigned int hook_flags);
795 struct u64_stats_sync syncp;
798 #define NFT_HOOK_OPS_MAX 2
799 #define NFT_BASECHAIN_DISABLED (1 << 0)
802 * struct nft_base_chain - nf_tables base chain
804 * @ops: netfilter hook ops
805 * @pnet: net namespace that this chain belongs to
807 * @policy: default policy
808 * @stats: per-cpu chain stats
810 * @dev_name: device name that this base chain is attached to (if any)
812 struct nft_base_chain {
813 struct nf_hook_ops ops[NFT_HOOK_OPS_MAX];
815 const struct nf_chain_type *type;
818 struct nft_stats __percpu *stats;
819 struct nft_chain chain;
820 char dev_name[IFNAMSIZ];
823 static inline struct nft_base_chain *nft_base_chain(const struct nft_chain *chain)
825 return container_of(chain, struct nft_base_chain, chain);
828 int __nft_release_basechain(struct nft_ctx *ctx);
830 unsigned int nft_do_chain(struct nft_pktinfo *pkt, void *priv);
833 * struct nft_table - nf_tables table
835 * @list: used internally
836 * @chains: chains in the table
837 * @sets: sets in the table
838 * @hgenerator: handle generator state
839 * @use: number of chain references to this table
840 * @flags: table flag (see enum nft_table_flags)
841 * @name: name of the table
844 struct list_head list;
845 struct list_head chains;
846 struct list_head sets;
850 char name[NFT_TABLE_MAXNAMELEN];
854 NFT_AF_NEEDS_DEV = (1 << 0),
858 * struct nft_af_info - nf_tables address family info
860 * @list: used internally
861 * @family: address family
862 * @nhooks: number of hooks in this family
863 * @owner: module owner
864 * @tables: used internally
865 * @flags: family flags
866 * @nops: number of hook ops in this family
867 * @hook_ops_init: initialization function for chain hook ops
868 * @hooks: hookfn overrides for packet validation
871 struct list_head list;
874 struct module *owner;
875 struct list_head tables;
878 void (*hook_ops_init)(struct nf_hook_ops *,
880 nf_hookfn *hooks[NF_MAX_HOOKS];
883 int nft_register_afinfo(struct net *, struct nft_af_info *);
884 void nft_unregister_afinfo(struct net *, struct nft_af_info *);
886 int nft_register_chain_type(const struct nf_chain_type *);
887 void nft_unregister_chain_type(const struct nf_chain_type *);
889 int nft_register_expr(struct nft_expr_type *);
890 void nft_unregister_expr(struct nft_expr_type *);
892 int nft_verdict_dump(struct sk_buff *skb, int type,
893 const struct nft_verdict *v);
896 * struct nft_traceinfo - nft tracing information and state
898 * @pkt: pktinfo currently processed
899 * @basechain: base chain currently processed
900 * @chain: chain currently processed
901 * @rule: rule that was evaluated
902 * @verdict: verdict given by rule
903 * @type: event type (enum nft_trace_types)
904 * @packet_dumped: packet headers sent in a previous traceinfo message
905 * @trace: other struct members are initialised
907 struct nft_traceinfo {
908 const struct nft_pktinfo *pkt;
909 const struct nft_base_chain *basechain;
910 const struct nft_chain *chain;
911 const struct nft_rule *rule;
912 const struct nft_verdict *verdict;
913 enum nft_trace_types type;
918 void nft_trace_init(struct nft_traceinfo *info, const struct nft_pktinfo *pkt,
919 const struct nft_verdict *verdict,
920 const struct nft_chain *basechain);
922 void nft_trace_notify(struct nft_traceinfo *info);
924 #define nft_dereference(p) \
925 nfnl_dereference(p, NFNL_SUBSYS_NFTABLES)
927 #define MODULE_ALIAS_NFT_FAMILY(family) \
928 MODULE_ALIAS("nft-afinfo-" __stringify(family))
930 #define MODULE_ALIAS_NFT_CHAIN(family, name) \
931 MODULE_ALIAS("nft-chain-" __stringify(family) "-" name)
933 #define MODULE_ALIAS_NFT_AF_EXPR(family, name) \
934 MODULE_ALIAS("nft-expr-" __stringify(family) "-" name)
936 #define MODULE_ALIAS_NFT_EXPR(name) \
937 MODULE_ALIAS("nft-expr-" name)
939 #define MODULE_ALIAS_NFT_SET() \
940 MODULE_ALIAS("nft-set")
943 * The gencursor defines two generations, the currently active and the
944 * next one. Objects contain a bitmask of 2 bits specifying the generations
945 * they're active in. A set bit means they're inactive in the generation
946 * represented by that bit.
948 * New objects start out as inactive in the current and active in the
949 * next generation. When committing the ruleset the bitmask is cleared,
950 * meaning they're active in all generations. When removing an object,
951 * it is set inactive in the next generation. After committing the ruleset,
952 * the objects are removed.
954 static inline unsigned int nft_gencursor_next(const struct net *net)
956 return net->nft.gencursor + 1 == 1 ? 1 : 0;
959 static inline u8 nft_genmask_next(const struct net *net)
961 return 1 << nft_gencursor_next(net);
964 static inline u8 nft_genmask_cur(const struct net *net)
966 /* Use ACCESS_ONCE() to prevent refetching the value for atomicity */
967 return 1 << ACCESS_ONCE(net->nft.gencursor);
970 #define NFT_GENMASK_ANY ((1 << 0) | (1 << 1))
973 * Set element transaction helpers
976 static inline bool nft_set_elem_active(const struct nft_set_ext *ext,
979 return !(ext->genmask & genmask);
982 static inline void nft_set_elem_change_active(const struct nft_set *set,
983 struct nft_set_ext *ext)
985 ext->genmask ^= nft_genmask_next(read_pnet(&set->pnet));
989 * We use a free bit in the genmask field to indicate the element
990 * is busy, meaning it is currently being processed either by
991 * the netlink API or GC.
993 * Even though the genmask is only a single byte wide, this works
994 * because the extension structure if fully constant once initialized,
995 * so there are no non-atomic write accesses unless it is already
998 #define NFT_SET_ELEM_BUSY_MASK (1 << 2)
1000 #if defined(__LITTLE_ENDIAN_BITFIELD)
1001 #define NFT_SET_ELEM_BUSY_BIT 2
1002 #elif defined(__BIG_ENDIAN_BITFIELD)
1003 #define NFT_SET_ELEM_BUSY_BIT (BITS_PER_LONG - BITS_PER_BYTE + 2)
1008 static inline int nft_set_elem_mark_busy(struct nft_set_ext *ext)
1010 unsigned long *word = (unsigned long *)ext;
1012 BUILD_BUG_ON(offsetof(struct nft_set_ext, genmask) != 0);
1013 return test_and_set_bit(NFT_SET_ELEM_BUSY_BIT, word);
1016 static inline void nft_set_elem_clear_busy(struct nft_set_ext *ext)
1018 unsigned long *word = (unsigned long *)ext;
1020 clear_bit(NFT_SET_ELEM_BUSY_BIT, word);
1024 * struct nft_trans - nf_tables object update in transaction
1026 * @list: used internally
1027 * @msg_type: message type
1028 * @ctx: transaction context
1029 * @data: internal information related to the transaction
1032 struct list_head list;
1038 struct nft_trans_rule {
1039 struct nft_rule *rule;
1042 #define nft_trans_rule(trans) \
1043 (((struct nft_trans_rule *)trans->data)->rule)
1045 struct nft_trans_set {
1046 struct nft_set *set;
1050 #define nft_trans_set(trans) \
1051 (((struct nft_trans_set *)trans->data)->set)
1052 #define nft_trans_set_id(trans) \
1053 (((struct nft_trans_set *)trans->data)->set_id)
1055 struct nft_trans_chain {
1057 char name[NFT_CHAIN_MAXNAMELEN];
1058 struct nft_stats __percpu *stats;
1062 #define nft_trans_chain_update(trans) \
1063 (((struct nft_trans_chain *)trans->data)->update)
1064 #define nft_trans_chain_name(trans) \
1065 (((struct nft_trans_chain *)trans->data)->name)
1066 #define nft_trans_chain_stats(trans) \
1067 (((struct nft_trans_chain *)trans->data)->stats)
1068 #define nft_trans_chain_policy(trans) \
1069 (((struct nft_trans_chain *)trans->data)->policy)
1071 struct nft_trans_table {
1076 #define nft_trans_table_update(trans) \
1077 (((struct nft_trans_table *)trans->data)->update)
1078 #define nft_trans_table_enable(trans) \
1079 (((struct nft_trans_table *)trans->data)->enable)
1081 struct nft_trans_elem {
1082 struct nft_set *set;
1083 struct nft_set_elem elem;
1086 #define nft_trans_elem_set(trans) \
1087 (((struct nft_trans_elem *)trans->data)->set)
1088 #define nft_trans_elem(trans) \
1089 (((struct nft_trans_elem *)trans->data)->elem)
1091 #endif /* _NET_NF_TABLES_H */