1 /* SPDX-License-Identifier: GPL-2.0 */
2 #ifndef _NET_NF_TABLES_H
3 #define _NET_NF_TABLES_H
5 #include <linux/module.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>
16 #define NFT_JUMP_STACK_SIZE 16
22 /* for x_tables compatibility */
23 struct xt_action_param xt;
26 static inline struct net *nft_net(const struct nft_pktinfo *pkt)
28 return pkt->xt.state->net;
31 static inline unsigned int nft_hook(const struct nft_pktinfo *pkt)
33 return pkt->xt.state->hook;
36 static inline u8 nft_pf(const struct nft_pktinfo *pkt)
38 return pkt->xt.state->pf;
41 static inline const struct net_device *nft_in(const struct nft_pktinfo *pkt)
43 return pkt->xt.state->in;
46 static inline const struct net_device *nft_out(const struct nft_pktinfo *pkt)
48 return pkt->xt.state->out;
51 static inline void nft_set_pktinfo(struct nft_pktinfo *pkt,
53 const struct nf_hook_state *state)
56 pkt->xt.state = state;
59 static inline void nft_set_pktinfo_unspec(struct nft_pktinfo *pkt,
62 pkt->tprot_set = false;
69 * struct nft_verdict - nf_tables verdict
71 * @code: nf_tables/netfilter verdict code
72 * @chain: destination chain for NFT_JUMP/NFT_GOTO
76 struct nft_chain *chain;
82 struct nft_verdict verdict;
84 } __attribute__((aligned(__alignof__(u64))));
87 * struct nft_regs - nf_tables register set
89 * @data: data registers
90 * @verdict: verdict register
92 * The first four data registers alias to the verdict register.
97 struct nft_verdict verdict;
101 /* Store/load an u16 or u8 integer to/from the u32 data register.
103 * Note, when using concatenations, register allocation happens at 32-bit
104 * level. So for store instruction, pad the rest part with zero to avoid
108 static inline void nft_reg_store16(u32 *dreg, u16 val)
114 static inline void nft_reg_store8(u32 *dreg, u8 val)
120 static inline u16 nft_reg_load16(u32 *sreg)
125 static inline u8 nft_reg_load8(u32 *sreg)
130 static inline void nft_data_copy(u32 *dst, const struct nft_data *src,
133 memcpy(dst, src, len);
136 static inline void nft_data_debug(const struct nft_data *data)
138 pr_debug("data[0]=%x data[1]=%x data[2]=%x data[3]=%x\n",
139 data->data[0], data->data[1],
140 data->data[2], data->data[3]);
144 * struct nft_ctx - nf_tables rule/set context
146 * @net: net namespace
147 * @table: the table the chain is contained in
148 * @chain: the chain the rule is contained in
149 * @nla: netlink attributes
150 * @portid: netlink portID of the original message
151 * @seq: netlink sequence number
152 * @family: protocol family
153 * @level: depth of the chains
154 * @report: notify via unicast netlink message
158 struct nft_table *table;
159 struct nft_chain *chain;
160 const struct nlattr * const *nla;
168 struct nft_data_desc {
169 enum nft_data_types type;
173 int nft_data_init(const struct nft_ctx *ctx,
174 struct nft_data *data, unsigned int size,
175 struct nft_data_desc *desc, const struct nlattr *nla);
176 void nft_data_hold(const struct nft_data *data, enum nft_data_types type);
177 void nft_data_release(const struct nft_data *data, enum nft_data_types type);
178 int nft_data_dump(struct sk_buff *skb, int attr, const struct nft_data *data,
179 enum nft_data_types type, unsigned int len);
181 static inline enum nft_data_types nft_dreg_to_type(enum nft_registers reg)
183 return reg == NFT_REG_VERDICT ? NFT_DATA_VERDICT : NFT_DATA_VALUE;
186 static inline enum nft_registers nft_type_to_reg(enum nft_data_types type)
188 return type == NFT_DATA_VERDICT ? NFT_REG_VERDICT : NFT_REG_1 * NFT_REG_SIZE / NFT_REG32_SIZE;
191 int nft_parse_u32_check(const struct nlattr *attr, int max, u32 *dest);
192 unsigned int nft_parse_register(const struct nlattr *attr);
193 int nft_dump_register(struct sk_buff *skb, unsigned int attr, unsigned int reg);
195 int nft_validate_register_load(enum nft_registers reg, unsigned int len);
196 int nft_validate_register_store(const struct nft_ctx *ctx,
197 enum nft_registers reg,
198 const struct nft_data *data,
199 enum nft_data_types type, unsigned int len);
202 * struct nft_userdata - user defined data associated with an object
204 * @len: length of the data
207 * The presence of user data is indicated in an object specific fashion,
208 * so a length of zero can't occur and the value "len" indicates data
211 struct nft_userdata {
213 unsigned char data[0];
217 * struct nft_set_elem - generic representation of set elements
220 * @priv: element private data and extensions
222 struct nft_set_elem {
224 u32 buf[NFT_DATA_VALUE_MAXLEN / sizeof(u32)];
231 struct nft_set_iter {
236 int (*fn)(const struct nft_ctx *ctx,
238 const struct nft_set_iter *iter,
239 struct nft_set_elem *elem);
243 * struct nft_set_desc - description of set elements
247 * @size: number of set elements
249 struct nft_set_desc {
256 * enum nft_set_class - performance class
258 * @NFT_LOOKUP_O_1: constant, O(1)
259 * @NFT_LOOKUP_O_LOG_N: logarithmic, O(log N)
260 * @NFT_LOOKUP_O_N: linear, O(N)
264 NFT_SET_CLASS_O_LOG_N,
269 * struct nft_set_estimate - estimation of memory and performance
272 * @size: required memory
273 * @lookup: lookup performance class
274 * @space: memory class
276 struct nft_set_estimate {
278 enum nft_set_class lookup;
279 enum nft_set_class space;
286 * struct nft_set_ops - nf_tables set operations
288 * @lookup: look up an element within the set
289 * @insert: insert new element into set
290 * @activate: activate new element in the next generation
291 * @deactivate: lookup for element and deactivate it in the next generation
292 * @flush: deactivate element in the next generation
293 * @remove: remove element from set
294 * @walk: iterate over all set elemeennts
295 * @get: get set elements
296 * @privsize: function to return size of set private data
297 * @init: initialize private data of new set instance
298 * @destroy: destroy private data of set instance
299 * @elemsize: element private size
302 bool (*lookup)(const struct net *net,
303 const struct nft_set *set,
305 const struct nft_set_ext **ext);
306 bool (*update)(struct nft_set *set,
308 void *(*new)(struct nft_set *,
309 const struct nft_expr *,
311 const struct nft_expr *expr,
312 struct nft_regs *regs,
313 const struct nft_set_ext **ext);
315 int (*insert)(const struct net *net,
316 const struct nft_set *set,
317 const struct nft_set_elem *elem,
318 struct nft_set_ext **ext);
319 void (*activate)(const struct net *net,
320 const struct nft_set *set,
321 const struct nft_set_elem *elem);
322 void * (*deactivate)(const struct net *net,
323 const struct nft_set *set,
324 const struct nft_set_elem *elem);
325 bool (*flush)(const struct net *net,
326 const struct nft_set *set,
328 void (*remove)(const struct net *net,
329 const struct nft_set *set,
330 const struct nft_set_elem *elem);
331 void (*walk)(const struct nft_ctx *ctx,
333 struct nft_set_iter *iter);
334 void * (*get)(const struct net *net,
335 const struct nft_set *set,
336 const struct nft_set_elem *elem,
339 unsigned int (*privsize)(const struct nlattr * const nla[],
340 const struct nft_set_desc *desc);
341 bool (*estimate)(const struct nft_set_desc *desc,
343 struct nft_set_estimate *est);
344 int (*init)(const struct nft_set *set,
345 const struct nft_set_desc *desc,
346 const struct nlattr * const nla[]);
347 void (*destroy)(const struct nft_set *set);
348 void (*gc_init)(const struct nft_set *set);
350 unsigned int elemsize;
354 * struct nft_set_type - nf_tables set type
356 * @ops: set ops for this type
357 * @list: used internally
358 * @owner: module reference
359 * @features: features supported by the implementation
361 struct nft_set_type {
362 const struct nft_set_ops ops;
363 struct list_head list;
364 struct module *owner;
367 #define to_set_type(o) container_of(o, struct nft_set_type, ops)
369 int nft_register_set(struct nft_set_type *type);
370 void nft_unregister_set(struct nft_set_type *type);
373 * struct nft_set - nf_tables set instance
375 * @list: table set list node
376 * @bindings: list of set bindings
377 * @table: table this set belongs to
378 * @net: netnamespace this set belongs to
379 * @name: name of the set
380 * @handle: unique handle of the set
381 * @ktype: key type (numeric type defined by userspace, not used in the kernel)
382 * @dtype: data type (verdict or numeric type defined by userspace)
383 * @objtype: object type (see NFT_OBJECT_* definitions)
384 * @size: maximum set size
385 * @nelems: number of elements
386 * @ndeact: number of deactivated elements queued for removal
387 * @timeout: default timeout value in jiffies
388 * @gc_int: garbage collection interval in msecs
389 * @policy: set parameterization (see enum nft_set_policies)
390 * @udlen: user data length
394 * @genmask: generation mask
397 * @data: private set data
400 struct list_head list;
401 struct list_head bindings;
402 struct nft_table *table;
416 unsigned char *udata;
417 /* runtime data below here */
418 const struct nft_set_ops *ops ____cacheline_aligned;
424 __attribute__((aligned(__alignof__(u64))));
427 static inline bool nft_set_is_anonymous(const struct nft_set *set)
429 return set->flags & NFT_SET_ANONYMOUS;
432 static inline void *nft_set_priv(const struct nft_set *set)
434 return (void *)set->data;
437 static inline struct nft_set *nft_set_container_of(const void *priv)
439 return (void *)priv - offsetof(struct nft_set, data);
442 struct nft_set *nft_set_lookup_global(const struct net *net,
443 const struct nft_table *table,
444 const struct nlattr *nla_set_name,
445 const struct nlattr *nla_set_id,
448 static inline unsigned long nft_set_gc_interval(const struct nft_set *set)
450 return set->gc_int ? msecs_to_jiffies(set->gc_int) : HZ;
454 * struct nft_set_binding - nf_tables set binding
456 * @list: set bindings list node
457 * @chain: chain containing the rule bound to the set
458 * @flags: set action flags
460 * A set binding contains all information necessary for validation
461 * of new elements added to a bound set.
463 struct nft_set_binding {
464 struct list_head list;
465 const struct nft_chain *chain;
469 int nf_tables_bind_set(const struct nft_ctx *ctx, struct nft_set *set,
470 struct nft_set_binding *binding);
471 void nf_tables_unbind_set(const struct nft_ctx *ctx, struct nft_set *set,
472 struct nft_set_binding *binding);
475 * enum nft_set_extensions - set extension type IDs
477 * @NFT_SET_EXT_KEY: element key
478 * @NFT_SET_EXT_DATA: mapping data
479 * @NFT_SET_EXT_FLAGS: element flags
480 * @NFT_SET_EXT_TIMEOUT: element timeout
481 * @NFT_SET_EXT_EXPIRATION: element expiration time
482 * @NFT_SET_EXT_USERDATA: user data associated with the element
483 * @NFT_SET_EXT_EXPR: expression assiociated with the element
484 * @NFT_SET_EXT_OBJREF: stateful object reference associated with element
485 * @NFT_SET_EXT_NUM: number of extension types
487 enum nft_set_extensions {
492 NFT_SET_EXT_EXPIRATION,
493 NFT_SET_EXT_USERDATA,
500 * struct nft_set_ext_type - set extension type
502 * @len: fixed part length of the extension
503 * @align: alignment requirements of the extension
505 struct nft_set_ext_type {
510 extern const struct nft_set_ext_type nft_set_ext_types[];
513 * struct nft_set_ext_tmpl - set extension template
515 * @len: length of extension area
516 * @offset: offsets of individual extension types
518 struct nft_set_ext_tmpl {
520 u8 offset[NFT_SET_EXT_NUM];
524 * struct nft_set_ext - set extensions
526 * @genmask: generation mask
527 * @offset: offsets of individual extension types
528 * @data: beginning of extension data
532 u8 offset[NFT_SET_EXT_NUM];
536 static inline void nft_set_ext_prepare(struct nft_set_ext_tmpl *tmpl)
538 memset(tmpl, 0, sizeof(*tmpl));
539 tmpl->len = sizeof(struct nft_set_ext);
542 static inline void nft_set_ext_add_length(struct nft_set_ext_tmpl *tmpl, u8 id,
545 tmpl->len = ALIGN(tmpl->len, nft_set_ext_types[id].align);
546 BUG_ON(tmpl->len > U8_MAX);
547 tmpl->offset[id] = tmpl->len;
548 tmpl->len += nft_set_ext_types[id].len + len;
551 static inline void nft_set_ext_add(struct nft_set_ext_tmpl *tmpl, u8 id)
553 nft_set_ext_add_length(tmpl, id, 0);
556 static inline void nft_set_ext_init(struct nft_set_ext *ext,
557 const struct nft_set_ext_tmpl *tmpl)
559 memcpy(ext->offset, tmpl->offset, sizeof(ext->offset));
562 static inline bool __nft_set_ext_exists(const struct nft_set_ext *ext, u8 id)
564 return !!ext->offset[id];
567 static inline bool nft_set_ext_exists(const struct nft_set_ext *ext, u8 id)
569 return ext && __nft_set_ext_exists(ext, id);
572 static inline void *nft_set_ext(const struct nft_set_ext *ext, u8 id)
574 return (void *)ext + ext->offset[id];
577 static inline struct nft_data *nft_set_ext_key(const struct nft_set_ext *ext)
579 return nft_set_ext(ext, NFT_SET_EXT_KEY);
582 static inline struct nft_data *nft_set_ext_data(const struct nft_set_ext *ext)
584 return nft_set_ext(ext, NFT_SET_EXT_DATA);
587 static inline u8 *nft_set_ext_flags(const struct nft_set_ext *ext)
589 return nft_set_ext(ext, NFT_SET_EXT_FLAGS);
592 static inline u64 *nft_set_ext_timeout(const struct nft_set_ext *ext)
594 return nft_set_ext(ext, NFT_SET_EXT_TIMEOUT);
597 static inline u64 *nft_set_ext_expiration(const struct nft_set_ext *ext)
599 return nft_set_ext(ext, NFT_SET_EXT_EXPIRATION);
602 static inline struct nft_userdata *nft_set_ext_userdata(const struct nft_set_ext *ext)
604 return nft_set_ext(ext, NFT_SET_EXT_USERDATA);
607 static inline struct nft_expr *nft_set_ext_expr(const struct nft_set_ext *ext)
609 return nft_set_ext(ext, NFT_SET_EXT_EXPR);
612 static inline bool nft_set_elem_expired(const struct nft_set_ext *ext)
614 return nft_set_ext_exists(ext, NFT_SET_EXT_EXPIRATION) &&
615 time_is_before_eq_jiffies64(*nft_set_ext_expiration(ext));
618 static inline struct nft_set_ext *nft_set_elem_ext(const struct nft_set *set,
621 return elem + set->ops->elemsize;
624 static inline struct nft_object **nft_set_ext_obj(const struct nft_set_ext *ext)
626 return nft_set_ext(ext, NFT_SET_EXT_OBJREF);
629 void *nft_set_elem_init(const struct nft_set *set,
630 const struct nft_set_ext_tmpl *tmpl,
631 const u32 *key, const u32 *data,
632 u64 timeout, gfp_t gfp);
633 void nft_set_elem_destroy(const struct nft_set *set, void *elem,
637 * struct nft_set_gc_batch_head - nf_tables set garbage collection batch
640 * @set: set the elements belong to
641 * @cnt: count of elements
643 struct nft_set_gc_batch_head {
645 const struct nft_set *set;
649 #define NFT_SET_GC_BATCH_SIZE ((PAGE_SIZE - \
650 sizeof(struct nft_set_gc_batch_head)) / \
654 * struct nft_set_gc_batch - nf_tables set garbage collection batch
656 * @head: GC batch head
657 * @elems: garbage collection elements
659 struct nft_set_gc_batch {
660 struct nft_set_gc_batch_head head;
661 void *elems[NFT_SET_GC_BATCH_SIZE];
664 struct nft_set_gc_batch *nft_set_gc_batch_alloc(const struct nft_set *set,
666 void nft_set_gc_batch_release(struct rcu_head *rcu);
668 static inline void nft_set_gc_batch_complete(struct nft_set_gc_batch *gcb)
671 call_rcu(&gcb->head.rcu, nft_set_gc_batch_release);
674 static inline struct nft_set_gc_batch *
675 nft_set_gc_batch_check(const struct nft_set *set, struct nft_set_gc_batch *gcb,
679 if (gcb->head.cnt + 1 < ARRAY_SIZE(gcb->elems))
681 nft_set_gc_batch_complete(gcb);
683 return nft_set_gc_batch_alloc(set, gfp);
686 static inline void nft_set_gc_batch_add(struct nft_set_gc_batch *gcb,
689 gcb->elems[gcb->head.cnt++] = elem;
693 * struct nft_expr_type - nf_tables expression type
695 * @select_ops: function to select nft_expr_ops
696 * @ops: default ops, used when no select_ops functions is present
697 * @list: used internally
699 * @owner: module reference
700 * @policy: netlink attribute policy
701 * @maxattr: highest netlink attribute number
702 * @family: address family for AF-specific types
703 * @flags: expression type flags
705 struct nft_expr_type {
706 const struct nft_expr_ops *(*select_ops)(const struct nft_ctx *,
707 const struct nlattr * const tb[]);
708 const struct nft_expr_ops *ops;
709 struct list_head list;
711 struct module *owner;
712 const struct nla_policy *policy;
713 unsigned int maxattr;
718 #define NFT_EXPR_STATEFUL 0x1
719 #define NFT_EXPR_GC 0x2
722 * struct nft_expr_ops - nf_tables expression operations
724 * @eval: Expression evaluation function
725 * @size: full expression size, including private data size
726 * @init: initialization function
727 * @destroy: destruction function
728 * @dump: function to dump parameters
729 * @type: expression type
730 * @validate: validate expression, called during loop detection
731 * @data: extra data to attach to this expression operation
734 struct nft_expr_ops {
735 void (*eval)(const struct nft_expr *expr,
736 struct nft_regs *regs,
737 const struct nft_pktinfo *pkt);
738 int (*clone)(struct nft_expr *dst,
739 const struct nft_expr *src);
742 int (*init)(const struct nft_ctx *ctx,
743 const struct nft_expr *expr,
744 const struct nlattr * const tb[]);
745 void (*activate)(const struct nft_ctx *ctx,
746 const struct nft_expr *expr);
747 void (*deactivate)(const struct nft_ctx *ctx,
748 const struct nft_expr *expr);
749 void (*destroy)(const struct nft_ctx *ctx,
750 const struct nft_expr *expr);
751 void (*destroy_clone)(const struct nft_ctx *ctx,
752 const struct nft_expr *expr);
753 int (*dump)(struct sk_buff *skb,
754 const struct nft_expr *expr);
755 int (*validate)(const struct nft_ctx *ctx,
756 const struct nft_expr *expr,
757 const struct nft_data **data);
758 bool (*gc)(struct net *net,
759 const struct nft_expr *expr);
760 const struct nft_expr_type *type;
764 #define NFT_EXPR_MAXATTR 16
765 #define NFT_EXPR_SIZE(size) (sizeof(struct nft_expr) + \
766 ALIGN(size, __alignof__(struct nft_expr)))
769 * struct nft_expr - nf_tables expression
771 * @ops: expression ops
772 * @data: expression private data
775 const struct nft_expr_ops *ops;
776 unsigned char data[];
779 static inline void *nft_expr_priv(const struct nft_expr *expr)
781 return (void *)expr->data;
784 struct nft_expr *nft_expr_init(const struct nft_ctx *ctx,
785 const struct nlattr *nla);
786 void nft_expr_destroy(const struct nft_ctx *ctx, struct nft_expr *expr);
787 int nft_expr_dump(struct sk_buff *skb, unsigned int attr,
788 const struct nft_expr *expr);
790 static inline int nft_expr_clone(struct nft_expr *dst, struct nft_expr *src)
794 if (src->ops->clone) {
796 err = src->ops->clone(dst, src);
800 memcpy(dst, src, src->ops->size);
803 __module_get(src->ops->type->owner);
808 * struct nft_rule - nf_tables rule
810 * @list: used internally
811 * @handle: rule handle
812 * @genmask: generation mask
813 * @dlen: length of expression data
814 * @udata: user data is appended to the rule
815 * @data: expression data
818 struct list_head list;
824 __attribute__((aligned(__alignof__(struct nft_expr))));
827 static inline struct nft_expr *nft_expr_first(const struct nft_rule *rule)
829 return (struct nft_expr *)&rule->data[0];
832 static inline struct nft_expr *nft_expr_next(const struct nft_expr *expr)
834 return ((void *)expr) + expr->ops->size;
837 static inline struct nft_expr *nft_expr_last(const struct nft_rule *rule)
839 return (struct nft_expr *)&rule->data[rule->dlen];
842 static inline struct nft_userdata *nft_userdata(const struct nft_rule *rule)
844 return (void *)&rule->data[rule->dlen];
848 * The last pointer isn't really necessary, but the compiler isn't able to
849 * determine that the result of nft_expr_last() is always the same since it
850 * can't assume that the dlen value wasn't changed within calls in the loop.
852 #define nft_rule_for_each_expr(expr, last, rule) \
853 for ((expr) = nft_expr_first(rule), (last) = nft_expr_last(rule); \
855 (expr) = nft_expr_next(expr))
857 enum nft_chain_flags {
858 NFT_BASE_CHAIN = 0x1,
862 * struct nft_chain - nf_tables chain
864 * @rules: list of rules in the chain
865 * @list: used internally
866 * @rhlhead: used internally
867 * @table: table that this chain belongs to
868 * @handle: chain handle
869 * @use: number of jump references to this chain
870 * @flags: bitmask of enum nft_chain_flags
871 * @name: name of the chain
874 struct nft_rule *__rcu *rules_gen_0;
875 struct nft_rule *__rcu *rules_gen_1;
876 struct list_head rules;
877 struct list_head list;
878 struct rhlist_head rhlhead;
879 struct nft_table *table;
886 /* Only used during control plane commit phase: */
887 struct nft_rule **rules_next;
890 int nft_chain_validate(const struct nft_ctx *ctx, const struct nft_chain *chain);
892 enum nft_chain_types {
893 NFT_CHAIN_T_DEFAULT = 0,
900 * struct nft_chain_type - nf_tables chain type info
902 * @name: name of the type
903 * @type: numeric identifier
904 * @family: address family
905 * @owner: module owner
906 * @hook_mask: mask of valid hooks
907 * @hooks: array of hook functions
908 * @ops_register: base chain register function
909 * @ops_unregister: base chain unregister function
911 struct nft_chain_type {
913 enum nft_chain_types type;
915 struct module *owner;
916 unsigned int hook_mask;
917 nf_hookfn *hooks[NF_MAX_HOOKS];
918 int (*ops_register)(struct net *net, const struct nf_hook_ops *ops);
919 void (*ops_unregister)(struct net *net, const struct nf_hook_ops *ops);
922 int nft_chain_validate_dependency(const struct nft_chain *chain,
923 enum nft_chain_types type);
924 int nft_chain_validate_hooks(const struct nft_chain *chain,
925 unsigned int hook_flags);
930 struct u64_stats_sync syncp;
934 * struct nft_base_chain - nf_tables base chain
936 * @ops: netfilter hook ops
938 * @policy: default policy
939 * @stats: per-cpu chain stats
941 * @dev_name: device name that this base chain is attached to (if any)
943 struct nft_base_chain {
944 struct nf_hook_ops ops;
945 const struct nft_chain_type *type;
948 struct nft_stats __percpu *stats;
949 struct nft_chain chain;
950 char dev_name[IFNAMSIZ];
953 static inline struct nft_base_chain *nft_base_chain(const struct nft_chain *chain)
955 return container_of(chain, struct nft_base_chain, chain);
958 static inline bool nft_is_base_chain(const struct nft_chain *chain)
960 return chain->flags & NFT_BASE_CHAIN;
963 int __nft_release_basechain(struct nft_ctx *ctx);
965 unsigned int nft_do_chain(struct nft_pktinfo *pkt, void *priv);
968 * struct nft_table - nf_tables table
970 * @list: used internally
971 * @chains_ht: chains in the table
972 * @chains: same, for stable walks
973 * @sets: sets in the table
974 * @objects: stateful objects in the table
975 * @flowtables: flow tables in the table
976 * @hgenerator: handle generator state
977 * @handle: table handle
978 * @use: number of chain references to this table
979 * @flags: table flag (see enum nft_table_flags)
980 * @genmask: generation mask
981 * @afinfo: address family info
982 * @name: name of the table
985 struct list_head list;
986 struct rhltable chains_ht;
987 struct list_head chains;
988 struct list_head sets;
989 struct list_head objects;
990 struct list_head flowtables;
1000 void nft_register_chain_type(const struct nft_chain_type *);
1001 void nft_unregister_chain_type(const struct nft_chain_type *);
1003 int nft_register_expr(struct nft_expr_type *);
1004 void nft_unregister_expr(struct nft_expr_type *);
1006 int nft_verdict_dump(struct sk_buff *skb, int type,
1007 const struct nft_verdict *v);
1010 * struct nft_object - nf_tables stateful object
1012 * @list: table stateful object list node
1013 * @table: table this object belongs to
1014 * @name: name of this stateful object
1015 * @genmask: generation mask
1016 * @use: number of references to this stateful object
1017 * @handle: unique object handle
1018 * @ops: object operations
1019 * @data: object data, layout depends on type
1022 struct list_head list;
1024 struct nft_table *table;
1028 /* runtime data below here */
1029 const struct nft_object_ops *ops ____cacheline_aligned;
1030 unsigned char data[]
1031 __attribute__((aligned(__alignof__(u64))));
1034 static inline void *nft_obj_data(const struct nft_object *obj)
1036 return (void *)obj->data;
1039 #define nft_expr_obj(expr) *((struct nft_object **)nft_expr_priv(expr))
1041 struct nft_object *nft_obj_lookup(const struct nft_table *table,
1042 const struct nlattr *nla, u32 objtype,
1045 void nft_obj_notify(struct net *net, struct nft_table *table,
1046 struct nft_object *obj, u32 portid, u32 seq,
1047 int event, int family, int report, gfp_t gfp);
1050 * struct nft_object_type - stateful object type
1052 * @select_ops: function to select nft_object_ops
1053 * @ops: default ops, used when no select_ops functions is present
1054 * @list: list node in list of object types
1055 * @type: stateful object numeric type
1056 * @owner: module owner
1057 * @maxattr: maximum netlink attribute
1058 * @policy: netlink attribute policy
1060 struct nft_object_type {
1061 const struct nft_object_ops *(*select_ops)(const struct nft_ctx *,
1062 const struct nlattr * const tb[]);
1063 const struct nft_object_ops *ops;
1064 struct list_head list;
1066 unsigned int maxattr;
1067 struct module *owner;
1068 const struct nla_policy *policy;
1072 * struct nft_object_ops - stateful object operations
1074 * @eval: stateful object evaluation function
1075 * @size: stateful object size
1076 * @init: initialize object from netlink attributes
1077 * @destroy: release existing stateful object
1078 * @dump: netlink dump stateful object
1080 struct nft_object_ops {
1081 void (*eval)(struct nft_object *obj,
1082 struct nft_regs *regs,
1083 const struct nft_pktinfo *pkt);
1085 int (*init)(const struct nft_ctx *ctx,
1086 const struct nlattr *const tb[],
1087 struct nft_object *obj);
1088 void (*destroy)(const struct nft_ctx *ctx,
1089 struct nft_object *obj);
1090 int (*dump)(struct sk_buff *skb,
1091 struct nft_object *obj,
1093 const struct nft_object_type *type;
1096 int nft_register_obj(struct nft_object_type *obj_type);
1097 void nft_unregister_obj(struct nft_object_type *obj_type);
1099 #define NFT_FLOWTABLE_DEVICE_MAX 8
1102 * struct nft_flowtable - nf_tables flow table
1104 * @list: flow table list node in table list
1105 * @table: the table the flow table is contained in
1106 * @name: name of this flow table
1107 * @hooknum: hook number
1108 * @priority: hook priority
1109 * @ops_len: number of hooks in array
1110 * @genmask: generation mask
1111 * @use: number of references to this flow table
1112 * @handle: unique object handle
1113 * @dev_name: array of device names
1114 * @data: rhashtable and garbage collector
1115 * @ops: array of hooks
1117 struct nft_flowtable {
1118 struct list_head list;
1119 struct nft_table *table;
1127 /* runtime data below here */
1128 struct nf_hook_ops *ops ____cacheline_aligned;
1129 struct nf_flowtable data;
1132 struct nft_flowtable *nft_flowtable_lookup(const struct nft_table *table,
1133 const struct nlattr *nla,
1136 void nft_register_flowtable_type(struct nf_flowtable_type *type);
1137 void nft_unregister_flowtable_type(struct nf_flowtable_type *type);
1140 * struct nft_traceinfo - nft tracing information and state
1142 * @pkt: pktinfo currently processed
1143 * @basechain: base chain currently processed
1144 * @chain: chain currently processed
1145 * @rule: rule that was evaluated
1146 * @verdict: verdict given by rule
1147 * @type: event type (enum nft_trace_types)
1148 * @packet_dumped: packet headers sent in a previous traceinfo message
1149 * @trace: other struct members are initialised
1151 struct nft_traceinfo {
1152 const struct nft_pktinfo *pkt;
1153 const struct nft_base_chain *basechain;
1154 const struct nft_chain *chain;
1155 const struct nft_rule *rule;
1156 const struct nft_verdict *verdict;
1157 enum nft_trace_types type;
1162 void nft_trace_init(struct nft_traceinfo *info, const struct nft_pktinfo *pkt,
1163 const struct nft_verdict *verdict,
1164 const struct nft_chain *basechain);
1166 void nft_trace_notify(struct nft_traceinfo *info);
1168 #define MODULE_ALIAS_NFT_CHAIN(family, name) \
1169 MODULE_ALIAS("nft-chain-" __stringify(family) "-" name)
1171 #define MODULE_ALIAS_NFT_AF_EXPR(family, name) \
1172 MODULE_ALIAS("nft-expr-" __stringify(family) "-" name)
1174 #define MODULE_ALIAS_NFT_EXPR(name) \
1175 MODULE_ALIAS("nft-expr-" name)
1177 #define MODULE_ALIAS_NFT_SET() \
1178 MODULE_ALIAS("nft-set")
1180 #define MODULE_ALIAS_NFT_OBJ(type) \
1181 MODULE_ALIAS("nft-obj-" __stringify(type))
1184 * The gencursor defines two generations, the currently active and the
1185 * next one. Objects contain a bitmask of 2 bits specifying the generations
1186 * they're active in. A set bit means they're inactive in the generation
1187 * represented by that bit.
1189 * New objects start out as inactive in the current and active in the
1190 * next generation. When committing the ruleset the bitmask is cleared,
1191 * meaning they're active in all generations. When removing an object,
1192 * it is set inactive in the next generation. After committing the ruleset,
1193 * the objects are removed.
1195 static inline unsigned int nft_gencursor_next(const struct net *net)
1197 return net->nft.gencursor + 1 == 1 ? 1 : 0;
1200 static inline u8 nft_genmask_next(const struct net *net)
1202 return 1 << nft_gencursor_next(net);
1205 static inline u8 nft_genmask_cur(const struct net *net)
1207 /* Use READ_ONCE() to prevent refetching the value for atomicity */
1208 return 1 << READ_ONCE(net->nft.gencursor);
1211 #define NFT_GENMASK_ANY ((1 << 0) | (1 << 1))
1214 * Generic transaction helpers
1217 /* Check if this object is currently active. */
1218 #define nft_is_active(__net, __obj) \
1219 (((__obj)->genmask & nft_genmask_cur(__net)) == 0)
1221 /* Check if this object is active in the next generation. */
1222 #define nft_is_active_next(__net, __obj) \
1223 (((__obj)->genmask & nft_genmask_next(__net)) == 0)
1225 /* This object becomes active in the next generation. */
1226 #define nft_activate_next(__net, __obj) \
1227 (__obj)->genmask = nft_genmask_cur(__net)
1229 /* This object becomes inactive in the next generation. */
1230 #define nft_deactivate_next(__net, __obj) \
1231 (__obj)->genmask = nft_genmask_next(__net)
1233 /* After committing the ruleset, clear the stale generation bit. */
1234 #define nft_clear(__net, __obj) \
1235 (__obj)->genmask &= ~nft_genmask_next(__net)
1236 #define nft_active_genmask(__obj, __genmask) \
1237 !((__obj)->genmask & __genmask)
1240 * Set element transaction helpers
1243 static inline bool nft_set_elem_active(const struct nft_set_ext *ext,
1246 return !(ext->genmask & genmask);
1249 static inline void nft_set_elem_change_active(const struct net *net,
1250 const struct nft_set *set,
1251 struct nft_set_ext *ext)
1253 ext->genmask ^= nft_genmask_next(net);
1257 * We use a free bit in the genmask field to indicate the element
1258 * is busy, meaning it is currently being processed either by
1259 * the netlink API or GC.
1261 * Even though the genmask is only a single byte wide, this works
1262 * because the extension structure if fully constant once initialized,
1263 * so there are no non-atomic write accesses unless it is already
1266 #define NFT_SET_ELEM_BUSY_MASK (1 << 2)
1268 #if defined(__LITTLE_ENDIAN_BITFIELD)
1269 #define NFT_SET_ELEM_BUSY_BIT 2
1270 #elif defined(__BIG_ENDIAN_BITFIELD)
1271 #define NFT_SET_ELEM_BUSY_BIT (BITS_PER_LONG - BITS_PER_BYTE + 2)
1276 static inline int nft_set_elem_mark_busy(struct nft_set_ext *ext)
1278 unsigned long *word = (unsigned long *)ext;
1280 BUILD_BUG_ON(offsetof(struct nft_set_ext, genmask) != 0);
1281 return test_and_set_bit(NFT_SET_ELEM_BUSY_BIT, word);
1284 static inline void nft_set_elem_clear_busy(struct nft_set_ext *ext)
1286 unsigned long *word = (unsigned long *)ext;
1288 clear_bit(NFT_SET_ELEM_BUSY_BIT, word);
1292 * struct nft_trans - nf_tables object update in transaction
1294 * @list: used internally
1295 * @msg_type: message type
1296 * @ctx: transaction context
1297 * @data: internal information related to the transaction
1300 struct list_head list;
1306 struct nft_trans_rule {
1307 struct nft_rule *rule;
1311 #define nft_trans_rule(trans) \
1312 (((struct nft_trans_rule *)trans->data)->rule)
1313 #define nft_trans_rule_id(trans) \
1314 (((struct nft_trans_rule *)trans->data)->rule_id)
1316 struct nft_trans_set {
1317 struct nft_set *set;
1321 #define nft_trans_set(trans) \
1322 (((struct nft_trans_set *)trans->data)->set)
1323 #define nft_trans_set_id(trans) \
1324 (((struct nft_trans_set *)trans->data)->set_id)
1326 struct nft_trans_chain {
1329 struct nft_stats __percpu *stats;
1333 #define nft_trans_chain_update(trans) \
1334 (((struct nft_trans_chain *)trans->data)->update)
1335 #define nft_trans_chain_name(trans) \
1336 (((struct nft_trans_chain *)trans->data)->name)
1337 #define nft_trans_chain_stats(trans) \
1338 (((struct nft_trans_chain *)trans->data)->stats)
1339 #define nft_trans_chain_policy(trans) \
1340 (((struct nft_trans_chain *)trans->data)->policy)
1342 struct nft_trans_table {
1347 #define nft_trans_table_update(trans) \
1348 (((struct nft_trans_table *)trans->data)->update)
1349 #define nft_trans_table_enable(trans) \
1350 (((struct nft_trans_table *)trans->data)->enable)
1352 struct nft_trans_elem {
1353 struct nft_set *set;
1354 struct nft_set_elem elem;
1357 #define nft_trans_elem_set(trans) \
1358 (((struct nft_trans_elem *)trans->data)->set)
1359 #define nft_trans_elem(trans) \
1360 (((struct nft_trans_elem *)trans->data)->elem)
1362 struct nft_trans_obj {
1363 struct nft_object *obj;
1366 #define nft_trans_obj(trans) \
1367 (((struct nft_trans_obj *)trans->data)->obj)
1369 struct nft_trans_flowtable {
1370 struct nft_flowtable *flowtable;
1373 #define nft_trans_flowtable(trans) \
1374 (((struct nft_trans_flowtable *)trans->data)->flowtable)
1376 int __init nft_chain_filter_init(void);
1377 void __exit nft_chain_filter_fini(void);
1379 #endif /* _NET_NF_TABLES_H */