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 <net/netfilter/nf_flow_table.h>
13 #include <net/netlink.h>
15 #define NFT_JUMP_STACK_SIZE 16
21 /* for x_tables compatibility */
22 struct xt_action_param xt;
25 static inline struct net *nft_net(const struct nft_pktinfo *pkt)
27 return pkt->xt.state->net;
30 static inline unsigned int nft_hook(const struct nft_pktinfo *pkt)
32 return pkt->xt.state->hook;
35 static inline u8 nft_pf(const struct nft_pktinfo *pkt)
37 return pkt->xt.state->pf;
40 static inline const struct net_device *nft_in(const struct nft_pktinfo *pkt)
42 return pkt->xt.state->in;
45 static inline const struct net_device *nft_out(const struct nft_pktinfo *pkt)
47 return pkt->xt.state->out;
50 static inline void nft_set_pktinfo(struct nft_pktinfo *pkt,
52 const struct nf_hook_state *state)
55 pkt->xt.state = state;
58 static inline void nft_set_pktinfo_unspec(struct nft_pktinfo *pkt,
61 pkt->tprot_set = false;
68 * struct nft_verdict - nf_tables verdict
70 * @code: nf_tables/netfilter verdict code
71 * @chain: destination chain for NFT_JUMP/NFT_GOTO
75 struct nft_chain *chain;
81 struct nft_verdict verdict;
83 } __attribute__((aligned(__alignof__(u64))));
86 * struct nft_regs - nf_tables register set
88 * @data: data registers
89 * @verdict: verdict register
91 * The first four data registers alias to the verdict register.
96 struct nft_verdict verdict;
100 /* Store/load an u16 or u8 integer to/from the u32 data register.
102 * Note, when using concatenations, register allocation happens at 32-bit
103 * level. So for store instruction, pad the rest part with zero to avoid
107 static inline void nft_reg_store16(u32 *dreg, u16 val)
113 static inline void nft_reg_store8(u32 *dreg, u8 val)
119 static inline u16 nft_reg_load16(u32 *sreg)
124 static inline u8 nft_reg_load8(u32 *sreg)
129 static inline void nft_data_copy(u32 *dst, const struct nft_data *src,
132 memcpy(dst, src, len);
135 static inline void nft_data_debug(const struct nft_data *data)
137 pr_debug("data[0]=%x data[1]=%x data[2]=%x data[3]=%x\n",
138 data->data[0], data->data[1],
139 data->data[2], data->data[3]);
143 * struct nft_ctx - nf_tables rule/set context
145 * @net: net namespace
146 * @table: the table the chain is contained in
147 * @chain: the chain the rule is contained in
148 * @nla: netlink attributes
149 * @portid: netlink portID of the original message
150 * @seq: netlink sequence number
151 * @family: protocol family
152 * @report: notify via unicast netlink message
156 struct nft_table *table;
157 struct nft_chain *chain;
158 const struct nlattr * const *nla;
165 struct nft_data_desc {
166 enum nft_data_types type;
170 int nft_data_init(const struct nft_ctx *ctx,
171 struct nft_data *data, unsigned int size,
172 struct nft_data_desc *desc, const struct nlattr *nla);
173 void nft_data_hold(const struct nft_data *data, enum nft_data_types type);
174 void nft_data_release(const struct nft_data *data, enum nft_data_types type);
175 int nft_data_dump(struct sk_buff *skb, int attr, const struct nft_data *data,
176 enum nft_data_types type, unsigned int len);
178 static inline enum nft_data_types nft_dreg_to_type(enum nft_registers reg)
180 return reg == NFT_REG_VERDICT ? NFT_DATA_VERDICT : NFT_DATA_VALUE;
183 static inline enum nft_registers nft_type_to_reg(enum nft_data_types type)
185 return type == NFT_DATA_VERDICT ? NFT_REG_VERDICT : NFT_REG_1 * NFT_REG_SIZE / NFT_REG32_SIZE;
188 int nft_parse_u32_check(const struct nlattr *attr, int max, u32 *dest);
189 unsigned int nft_parse_register(const struct nlattr *attr);
190 int nft_dump_register(struct sk_buff *skb, unsigned int attr, unsigned int reg);
192 int nft_validate_register_load(enum nft_registers reg, unsigned int len);
193 int nft_validate_register_store(const struct nft_ctx *ctx,
194 enum nft_registers reg,
195 const struct nft_data *data,
196 enum nft_data_types type, unsigned int len);
199 * struct nft_userdata - user defined data associated with an object
201 * @len: length of the data
204 * The presence of user data is indicated in an object specific fashion,
205 * so a length of zero can't occur and the value "len" indicates data
208 struct nft_userdata {
210 unsigned char data[0];
214 * struct nft_set_elem - generic representation of set elements
217 * @priv: element private data and extensions
219 struct nft_set_elem {
221 u32 buf[NFT_DATA_VALUE_MAXLEN / sizeof(u32)];
228 struct nft_set_iter {
233 int (*fn)(const struct nft_ctx *ctx,
235 const struct nft_set_iter *iter,
236 struct nft_set_elem *elem);
240 * struct nft_set_desc - description of set elements
244 * @size: number of set elements
246 struct nft_set_desc {
253 * enum nft_set_class - performance class
255 * @NFT_LOOKUP_O_1: constant, O(1)
256 * @NFT_LOOKUP_O_LOG_N: logarithmic, O(log N)
257 * @NFT_LOOKUP_O_N: linear, O(N)
261 NFT_SET_CLASS_O_LOG_N,
266 * struct nft_set_estimate - estimation of memory and performance
269 * @size: required memory
270 * @lookup: lookup performance class
271 * @space: memory class
273 struct nft_set_estimate {
275 enum nft_set_class lookup;
276 enum nft_set_class space;
283 * struct nft_set_ops - nf_tables set operations
285 * @lookup: look up an element within the set
286 * @insert: insert new element into set
287 * @activate: activate new element in the next generation
288 * @deactivate: lookup for element and deactivate it in the next generation
289 * @flush: deactivate element in the next generation
290 * @remove: remove element from set
291 * @walk: iterate over all set elemeennts
292 * @get: get set elements
293 * @privsize: function to return size of set private data
294 * @init: initialize private data of new set instance
295 * @destroy: destroy private data of set instance
296 * @elemsize: element private size
299 bool (*lookup)(const struct net *net,
300 const struct nft_set *set,
302 const struct nft_set_ext **ext);
303 bool (*update)(struct nft_set *set,
305 void *(*new)(struct nft_set *,
306 const struct nft_expr *,
308 const struct nft_expr *expr,
309 struct nft_regs *regs,
310 const struct nft_set_ext **ext);
312 int (*insert)(const struct net *net,
313 const struct nft_set *set,
314 const struct nft_set_elem *elem,
315 struct nft_set_ext **ext);
316 void (*activate)(const struct net *net,
317 const struct nft_set *set,
318 const struct nft_set_elem *elem);
319 void * (*deactivate)(const struct net *net,
320 const struct nft_set *set,
321 const struct nft_set_elem *elem);
322 bool (*flush)(const struct net *net,
323 const struct nft_set *set,
325 void (*remove)(const struct net *net,
326 const struct nft_set *set,
327 const struct nft_set_elem *elem);
328 void (*walk)(const struct nft_ctx *ctx,
330 struct nft_set_iter *iter);
331 void * (*get)(const struct net *net,
332 const struct nft_set *set,
333 const struct nft_set_elem *elem,
336 unsigned int (*privsize)(const struct nlattr * const nla[],
337 const struct nft_set_desc *desc);
338 bool (*estimate)(const struct nft_set_desc *desc,
340 struct nft_set_estimate *est);
341 int (*init)(const struct nft_set *set,
342 const struct nft_set_desc *desc,
343 const struct nlattr * const nla[]);
344 void (*destroy)(const struct nft_set *set);
346 unsigned int elemsize;
350 * struct nft_set_type - nf_tables set type
352 * @ops: set ops for this type
353 * @list: used internally
354 * @owner: module reference
355 * @features: features supported by the implementation
357 struct nft_set_type {
358 const struct nft_set_ops ops;
359 struct list_head list;
360 struct module *owner;
363 #define to_set_type(o) container_of(o, struct nft_set_type, ops)
365 int nft_register_set(struct nft_set_type *type);
366 void nft_unregister_set(struct nft_set_type *type);
369 * struct nft_set - nf_tables set instance
371 * @list: table set list node
372 * @bindings: list of set bindings
373 * @name: name of the set
374 * @handle: unique handle of the set
375 * @ktype: key type (numeric type defined by userspace, not used in the kernel)
376 * @dtype: data type (verdict or numeric type defined by userspace)
377 * @objtype: object type (see NFT_OBJECT_* definitions)
378 * @size: maximum set size
379 * @nelems: number of elements
380 * @ndeact: number of deactivated elements queued for removal
381 * @timeout: default timeout value in jiffies
382 * @gc_int: garbage collection interval in msecs
383 * @policy: set parameterization (see enum nft_set_policies)
384 * @udlen: user data length
388 * @genmask: generation mask
391 * @data: private set data
394 struct list_head list;
395 struct list_head bindings;
408 unsigned char *udata;
409 /* runtime data below here */
410 const struct nft_set_ops *ops ____cacheline_aligned;
416 __attribute__((aligned(__alignof__(u64))));
419 static inline bool nft_set_is_anonymous(const struct nft_set *set)
421 return set->flags & NFT_SET_ANONYMOUS;
424 static inline void *nft_set_priv(const struct nft_set *set)
426 return (void *)set->data;
429 static inline struct nft_set *nft_set_container_of(const void *priv)
431 return (void *)priv - offsetof(struct nft_set, data);
434 struct nft_set *nft_set_lookup_global(const struct net *net,
435 const struct nft_table *table,
436 const struct nlattr *nla_set_name,
437 const struct nlattr *nla_set_id,
440 static inline unsigned long nft_set_gc_interval(const struct nft_set *set)
442 return set->gc_int ? msecs_to_jiffies(set->gc_int) : HZ;
446 * struct nft_set_binding - nf_tables set binding
448 * @list: set bindings list node
449 * @chain: chain containing the rule bound to the set
450 * @flags: set action flags
452 * A set binding contains all information necessary for validation
453 * of new elements added to a bound set.
455 struct nft_set_binding {
456 struct list_head list;
457 const struct nft_chain *chain;
461 int nf_tables_bind_set(const struct nft_ctx *ctx, struct nft_set *set,
462 struct nft_set_binding *binding);
463 void nf_tables_unbind_set(const struct nft_ctx *ctx, struct nft_set *set,
464 struct nft_set_binding *binding);
467 * enum nft_set_extensions - set extension type IDs
469 * @NFT_SET_EXT_KEY: element key
470 * @NFT_SET_EXT_DATA: mapping data
471 * @NFT_SET_EXT_FLAGS: element flags
472 * @NFT_SET_EXT_TIMEOUT: element timeout
473 * @NFT_SET_EXT_EXPIRATION: element expiration time
474 * @NFT_SET_EXT_USERDATA: user data associated with the element
475 * @NFT_SET_EXT_EXPR: expression assiociated with the element
476 * @NFT_SET_EXT_OBJREF: stateful object reference associated with element
477 * @NFT_SET_EXT_NUM: number of extension types
479 enum nft_set_extensions {
484 NFT_SET_EXT_EXPIRATION,
485 NFT_SET_EXT_USERDATA,
492 * struct nft_set_ext_type - set extension type
494 * @len: fixed part length of the extension
495 * @align: alignment requirements of the extension
497 struct nft_set_ext_type {
502 extern const struct nft_set_ext_type nft_set_ext_types[];
505 * struct nft_set_ext_tmpl - set extension template
507 * @len: length of extension area
508 * @offset: offsets of individual extension types
510 struct nft_set_ext_tmpl {
512 u8 offset[NFT_SET_EXT_NUM];
516 * struct nft_set_ext - set extensions
518 * @genmask: generation mask
519 * @offset: offsets of individual extension types
520 * @data: beginning of extension data
524 u8 offset[NFT_SET_EXT_NUM];
528 static inline void nft_set_ext_prepare(struct nft_set_ext_tmpl *tmpl)
530 memset(tmpl, 0, sizeof(*tmpl));
531 tmpl->len = sizeof(struct nft_set_ext);
534 static inline void nft_set_ext_add_length(struct nft_set_ext_tmpl *tmpl, u8 id,
537 tmpl->len = ALIGN(tmpl->len, nft_set_ext_types[id].align);
538 BUG_ON(tmpl->len > U8_MAX);
539 tmpl->offset[id] = tmpl->len;
540 tmpl->len += nft_set_ext_types[id].len + len;
543 static inline void nft_set_ext_add(struct nft_set_ext_tmpl *tmpl, u8 id)
545 nft_set_ext_add_length(tmpl, id, 0);
548 static inline void nft_set_ext_init(struct nft_set_ext *ext,
549 const struct nft_set_ext_tmpl *tmpl)
551 memcpy(ext->offset, tmpl->offset, sizeof(ext->offset));
554 static inline bool __nft_set_ext_exists(const struct nft_set_ext *ext, u8 id)
556 return !!ext->offset[id];
559 static inline bool nft_set_ext_exists(const struct nft_set_ext *ext, u8 id)
561 return ext && __nft_set_ext_exists(ext, id);
564 static inline void *nft_set_ext(const struct nft_set_ext *ext, u8 id)
566 return (void *)ext + ext->offset[id];
569 static inline struct nft_data *nft_set_ext_key(const struct nft_set_ext *ext)
571 return nft_set_ext(ext, NFT_SET_EXT_KEY);
574 static inline struct nft_data *nft_set_ext_data(const struct nft_set_ext *ext)
576 return nft_set_ext(ext, NFT_SET_EXT_DATA);
579 static inline u8 *nft_set_ext_flags(const struct nft_set_ext *ext)
581 return nft_set_ext(ext, NFT_SET_EXT_FLAGS);
584 static inline u64 *nft_set_ext_timeout(const struct nft_set_ext *ext)
586 return nft_set_ext(ext, NFT_SET_EXT_TIMEOUT);
589 static inline u64 *nft_set_ext_expiration(const struct nft_set_ext *ext)
591 return nft_set_ext(ext, NFT_SET_EXT_EXPIRATION);
594 static inline struct nft_userdata *nft_set_ext_userdata(const struct nft_set_ext *ext)
596 return nft_set_ext(ext, NFT_SET_EXT_USERDATA);
599 static inline struct nft_expr *nft_set_ext_expr(const struct nft_set_ext *ext)
601 return nft_set_ext(ext, NFT_SET_EXT_EXPR);
604 static inline bool nft_set_elem_expired(const struct nft_set_ext *ext)
606 return nft_set_ext_exists(ext, NFT_SET_EXT_EXPIRATION) &&
607 time_is_before_eq_jiffies64(*nft_set_ext_expiration(ext));
610 static inline struct nft_set_ext *nft_set_elem_ext(const struct nft_set *set,
613 return elem + set->ops->elemsize;
616 static inline struct nft_object **nft_set_ext_obj(const struct nft_set_ext *ext)
618 return nft_set_ext(ext, NFT_SET_EXT_OBJREF);
621 void *nft_set_elem_init(const struct nft_set *set,
622 const struct nft_set_ext_tmpl *tmpl,
623 const u32 *key, const u32 *data,
624 u64 timeout, gfp_t gfp);
625 void nft_set_elem_destroy(const struct nft_set *set, void *elem,
629 * struct nft_set_gc_batch_head - nf_tables set garbage collection batch
632 * @set: set the elements belong to
633 * @cnt: count of elements
635 struct nft_set_gc_batch_head {
637 const struct nft_set *set;
641 #define NFT_SET_GC_BATCH_SIZE ((PAGE_SIZE - \
642 sizeof(struct nft_set_gc_batch_head)) / \
646 * struct nft_set_gc_batch - nf_tables set garbage collection batch
648 * @head: GC batch head
649 * @elems: garbage collection elements
651 struct nft_set_gc_batch {
652 struct nft_set_gc_batch_head head;
653 void *elems[NFT_SET_GC_BATCH_SIZE];
656 struct nft_set_gc_batch *nft_set_gc_batch_alloc(const struct nft_set *set,
658 void nft_set_gc_batch_release(struct rcu_head *rcu);
660 static inline void nft_set_gc_batch_complete(struct nft_set_gc_batch *gcb)
663 call_rcu(&gcb->head.rcu, nft_set_gc_batch_release);
666 static inline struct nft_set_gc_batch *
667 nft_set_gc_batch_check(const struct nft_set *set, struct nft_set_gc_batch *gcb,
671 if (gcb->head.cnt + 1 < ARRAY_SIZE(gcb->elems))
673 nft_set_gc_batch_complete(gcb);
675 return nft_set_gc_batch_alloc(set, gfp);
678 static inline void nft_set_gc_batch_add(struct nft_set_gc_batch *gcb,
681 gcb->elems[gcb->head.cnt++] = elem;
685 * struct nft_expr_type - nf_tables expression type
687 * @select_ops: function to select nft_expr_ops
688 * @ops: default ops, used when no select_ops functions is present
689 * @list: used internally
691 * @owner: module reference
692 * @policy: netlink attribute policy
693 * @maxattr: highest netlink attribute number
694 * @family: address family for AF-specific types
695 * @flags: expression type flags
697 struct nft_expr_type {
698 const struct nft_expr_ops *(*select_ops)(const struct nft_ctx *,
699 const struct nlattr * const tb[]);
700 const struct nft_expr_ops *ops;
701 struct list_head list;
703 struct module *owner;
704 const struct nla_policy *policy;
705 unsigned int maxattr;
710 #define NFT_EXPR_STATEFUL 0x1
713 * struct nft_expr_ops - nf_tables expression operations
715 * @eval: Expression evaluation function
716 * @size: full expression size, including private data size
717 * @init: initialization function
718 * @destroy: destruction function
719 * @dump: function to dump parameters
720 * @type: expression type
721 * @validate: validate expression, called during loop detection
722 * @data: extra data to attach to this expression operation
725 struct nft_expr_ops {
726 void (*eval)(const struct nft_expr *expr,
727 struct nft_regs *regs,
728 const struct nft_pktinfo *pkt);
729 int (*clone)(struct nft_expr *dst,
730 const struct nft_expr *src);
733 int (*init)(const struct nft_ctx *ctx,
734 const struct nft_expr *expr,
735 const struct nlattr * const tb[]);
736 void (*activate)(const struct nft_ctx *ctx,
737 const struct nft_expr *expr);
738 void (*deactivate)(const struct nft_ctx *ctx,
739 const struct nft_expr *expr);
740 void (*destroy)(const struct nft_ctx *ctx,
741 const struct nft_expr *expr);
742 int (*dump)(struct sk_buff *skb,
743 const struct nft_expr *expr);
744 int (*validate)(const struct nft_ctx *ctx,
745 const struct nft_expr *expr,
746 const struct nft_data **data);
747 const struct nft_expr_type *type;
751 #define NFT_EXPR_MAXATTR 16
752 #define NFT_EXPR_SIZE(size) (sizeof(struct nft_expr) + \
753 ALIGN(size, __alignof__(struct nft_expr)))
756 * struct nft_expr - nf_tables expression
758 * @ops: expression ops
759 * @data: expression private data
762 const struct nft_expr_ops *ops;
763 unsigned char data[];
766 static inline void *nft_expr_priv(const struct nft_expr *expr)
768 return (void *)expr->data;
771 struct nft_expr *nft_expr_init(const struct nft_ctx *ctx,
772 const struct nlattr *nla);
773 void nft_expr_destroy(const struct nft_ctx *ctx, struct nft_expr *expr);
774 int nft_expr_dump(struct sk_buff *skb, unsigned int attr,
775 const struct nft_expr *expr);
777 static inline int nft_expr_clone(struct nft_expr *dst, struct nft_expr *src)
781 if (src->ops->clone) {
783 err = src->ops->clone(dst, src);
787 memcpy(dst, src, src->ops->size);
790 __module_get(src->ops->type->owner);
795 * struct nft_rule - nf_tables rule
797 * @list: used internally
798 * @handle: rule handle
799 * @genmask: generation mask
800 * @dlen: length of expression data
801 * @udata: user data is appended to the rule
802 * @data: expression data
805 struct list_head list;
811 __attribute__((aligned(__alignof__(struct nft_expr))));
814 static inline struct nft_expr *nft_expr_first(const struct nft_rule *rule)
816 return (struct nft_expr *)&rule->data[0];
819 static inline struct nft_expr *nft_expr_next(const struct nft_expr *expr)
821 return ((void *)expr) + expr->ops->size;
824 static inline struct nft_expr *nft_expr_last(const struct nft_rule *rule)
826 return (struct nft_expr *)&rule->data[rule->dlen];
829 static inline struct nft_userdata *nft_userdata(const struct nft_rule *rule)
831 return (void *)&rule->data[rule->dlen];
835 * The last pointer isn't really necessary, but the compiler isn't able to
836 * determine that the result of nft_expr_last() is always the same since it
837 * can't assume that the dlen value wasn't changed within calls in the loop.
839 #define nft_rule_for_each_expr(expr, last, rule) \
840 for ((expr) = nft_expr_first(rule), (last) = nft_expr_last(rule); \
842 (expr) = nft_expr_next(expr))
844 enum nft_chain_flags {
845 NFT_BASE_CHAIN = 0x1,
849 * struct nft_chain - nf_tables chain
851 * @rules: list of rules in the chain
852 * @list: used internally
853 * @table: table that this chain belongs to
854 * @handle: chain handle
855 * @use: number of jump references to this chain
856 * @level: length of longest path to this chain
857 * @flags: bitmask of enum nft_chain_flags
858 * @name: name of the chain
861 struct nft_rule *__rcu *rules_gen_0;
862 struct nft_rule *__rcu *rules_gen_1;
863 struct list_head rules;
864 struct list_head list;
865 struct nft_table *table;
873 /* Only used during control plane commit phase: */
874 struct nft_rule **rules_next;
877 int nft_chain_validate(const struct nft_ctx *ctx, const struct nft_chain *chain);
879 enum nft_chain_types {
880 NFT_CHAIN_T_DEFAULT = 0,
887 * struct nft_chain_type - nf_tables chain type info
889 * @name: name of the type
890 * @type: numeric identifier
891 * @family: address family
892 * @owner: module owner
893 * @hook_mask: mask of valid hooks
894 * @hooks: array of hook functions
895 * @ops_register: base chain register function
896 * @ops_unregister: base chain unregister function
898 struct nft_chain_type {
900 enum nft_chain_types type;
902 struct module *owner;
903 unsigned int hook_mask;
904 nf_hookfn *hooks[NF_MAX_HOOKS];
905 int (*ops_register)(struct net *net, const struct nf_hook_ops *ops);
906 void (*ops_unregister)(struct net *net, const struct nf_hook_ops *ops);
909 int nft_chain_validate_dependency(const struct nft_chain *chain,
910 enum nft_chain_types type);
911 int nft_chain_validate_hooks(const struct nft_chain *chain,
912 unsigned int hook_flags);
917 struct u64_stats_sync syncp;
921 * struct nft_base_chain - nf_tables base chain
923 * @ops: netfilter hook ops
925 * @policy: default policy
926 * @stats: per-cpu chain stats
928 * @dev_name: device name that this base chain is attached to (if any)
930 struct nft_base_chain {
931 struct nf_hook_ops ops;
932 const struct nft_chain_type *type;
935 struct nft_stats __percpu *stats;
936 struct nft_chain chain;
937 char dev_name[IFNAMSIZ];
940 static inline struct nft_base_chain *nft_base_chain(const struct nft_chain *chain)
942 return container_of(chain, struct nft_base_chain, chain);
945 static inline bool nft_is_base_chain(const struct nft_chain *chain)
947 return chain->flags & NFT_BASE_CHAIN;
950 int __nft_release_basechain(struct nft_ctx *ctx);
952 unsigned int nft_do_chain(struct nft_pktinfo *pkt, void *priv);
955 * struct nft_table - nf_tables table
957 * @list: used internally
958 * @chains: chains in the table
959 * @sets: sets in the table
960 * @objects: stateful objects in the table
961 * @flowtables: flow tables in the table
962 * @hgenerator: handle generator state
963 * @handle: table handle
964 * @use: number of chain references to this table
965 * @flags: table flag (see enum nft_table_flags)
966 * @genmask: generation mask
967 * @afinfo: address family info
968 * @name: name of the table
971 struct list_head list;
972 struct list_head chains;
973 struct list_head sets;
974 struct list_head objects;
975 struct list_head flowtables;
985 void nft_register_chain_type(const struct nft_chain_type *);
986 void nft_unregister_chain_type(const struct nft_chain_type *);
988 int nft_register_expr(struct nft_expr_type *);
989 void nft_unregister_expr(struct nft_expr_type *);
991 int nft_verdict_dump(struct sk_buff *skb, int type,
992 const struct nft_verdict *v);
995 * struct nft_object - nf_tables stateful object
997 * @list: table stateful object list node
998 * @table: table this object belongs to
999 * @name: name of this stateful object
1000 * @genmask: generation mask
1001 * @use: number of references to this stateful object
1002 * @handle: unique object handle
1003 * @ops: object operations
1004 * @data: object data, layout depends on type
1007 struct list_head list;
1009 struct nft_table *table;
1013 /* runtime data below here */
1014 const struct nft_object_ops *ops ____cacheline_aligned;
1015 unsigned char data[]
1016 __attribute__((aligned(__alignof__(u64))));
1019 static inline void *nft_obj_data(const struct nft_object *obj)
1021 return (void *)obj->data;
1024 #define nft_expr_obj(expr) *((struct nft_object **)nft_expr_priv(expr))
1026 struct nft_object *nft_obj_lookup(const struct nft_table *table,
1027 const struct nlattr *nla, u32 objtype,
1030 void nft_obj_notify(struct net *net, struct nft_table *table,
1031 struct nft_object *obj, u32 portid, u32 seq,
1032 int event, int family, int report, gfp_t gfp);
1035 * struct nft_object_type - stateful object type
1037 * @select_ops: function to select nft_object_ops
1038 * @ops: default ops, used when no select_ops functions is present
1039 * @list: list node in list of object types
1040 * @type: stateful object numeric type
1041 * @owner: module owner
1042 * @maxattr: maximum netlink attribute
1043 * @policy: netlink attribute policy
1045 struct nft_object_type {
1046 const struct nft_object_ops *(*select_ops)(const struct nft_ctx *,
1047 const struct nlattr * const tb[]);
1048 const struct nft_object_ops *ops;
1049 struct list_head list;
1051 unsigned int maxattr;
1052 struct module *owner;
1053 const struct nla_policy *policy;
1057 * struct nft_object_ops - stateful object operations
1059 * @eval: stateful object evaluation function
1060 * @size: stateful object size
1061 * @init: initialize object from netlink attributes
1062 * @destroy: release existing stateful object
1063 * @dump: netlink dump stateful object
1065 struct nft_object_ops {
1066 void (*eval)(struct nft_object *obj,
1067 struct nft_regs *regs,
1068 const struct nft_pktinfo *pkt);
1070 int (*init)(const struct nft_ctx *ctx,
1071 const struct nlattr *const tb[],
1072 struct nft_object *obj);
1073 void (*destroy)(struct nft_object *obj);
1074 int (*dump)(struct sk_buff *skb,
1075 struct nft_object *obj,
1077 const struct nft_object_type *type;
1080 int nft_register_obj(struct nft_object_type *obj_type);
1081 void nft_unregister_obj(struct nft_object_type *obj_type);
1083 #define NFT_FLOWTABLE_DEVICE_MAX 8
1086 * struct nft_flowtable - nf_tables flow table
1088 * @list: flow table list node in table list
1089 * @table: the table the flow table is contained in
1090 * @name: name of this flow table
1091 * @hooknum: hook number
1092 * @priority: hook priority
1093 * @ops_len: number of hooks in array
1094 * @genmask: generation mask
1095 * @use: number of references to this flow table
1096 * @handle: unique object handle
1097 * @dev_name: array of device names
1098 * @data: rhashtable and garbage collector
1099 * @ops: array of hooks
1101 struct nft_flowtable {
1102 struct list_head list;
1103 struct nft_table *table;
1111 char *dev_name[NFT_FLOWTABLE_DEVICE_MAX];
1112 /* runtime data below here */
1113 struct nf_hook_ops *ops ____cacheline_aligned;
1114 struct nf_flowtable data;
1117 struct nft_flowtable *nft_flowtable_lookup(const struct nft_table *table,
1118 const struct nlattr *nla,
1121 void nft_register_flowtable_type(struct nf_flowtable_type *type);
1122 void nft_unregister_flowtable_type(struct nf_flowtable_type *type);
1125 * struct nft_traceinfo - nft tracing information and state
1127 * @pkt: pktinfo currently processed
1128 * @basechain: base chain currently processed
1129 * @chain: chain currently processed
1130 * @rule: rule that was evaluated
1131 * @verdict: verdict given by rule
1132 * @type: event type (enum nft_trace_types)
1133 * @packet_dumped: packet headers sent in a previous traceinfo message
1134 * @trace: other struct members are initialised
1136 struct nft_traceinfo {
1137 const struct nft_pktinfo *pkt;
1138 const struct nft_base_chain *basechain;
1139 const struct nft_chain *chain;
1140 const struct nft_rule *rule;
1141 const struct nft_verdict *verdict;
1142 enum nft_trace_types type;
1147 void nft_trace_init(struct nft_traceinfo *info, const struct nft_pktinfo *pkt,
1148 const struct nft_verdict *verdict,
1149 const struct nft_chain *basechain);
1151 void nft_trace_notify(struct nft_traceinfo *info);
1153 #define MODULE_ALIAS_NFT_CHAIN(family, name) \
1154 MODULE_ALIAS("nft-chain-" __stringify(family) "-" name)
1156 #define MODULE_ALIAS_NFT_AF_EXPR(family, name) \
1157 MODULE_ALIAS("nft-expr-" __stringify(family) "-" name)
1159 #define MODULE_ALIAS_NFT_EXPR(name) \
1160 MODULE_ALIAS("nft-expr-" name)
1162 #define MODULE_ALIAS_NFT_SET() \
1163 MODULE_ALIAS("nft-set")
1165 #define MODULE_ALIAS_NFT_OBJ(type) \
1166 MODULE_ALIAS("nft-obj-" __stringify(type))
1169 * The gencursor defines two generations, the currently active and the
1170 * next one. Objects contain a bitmask of 2 bits specifying the generations
1171 * they're active in. A set bit means they're inactive in the generation
1172 * represented by that bit.
1174 * New objects start out as inactive in the current and active in the
1175 * next generation. When committing the ruleset the bitmask is cleared,
1176 * meaning they're active in all generations. When removing an object,
1177 * it is set inactive in the next generation. After committing the ruleset,
1178 * the objects are removed.
1180 static inline unsigned int nft_gencursor_next(const struct net *net)
1182 return net->nft.gencursor + 1 == 1 ? 1 : 0;
1185 static inline u8 nft_genmask_next(const struct net *net)
1187 return 1 << nft_gencursor_next(net);
1190 static inline u8 nft_genmask_cur(const struct net *net)
1192 /* Use READ_ONCE() to prevent refetching the value for atomicity */
1193 return 1 << READ_ONCE(net->nft.gencursor);
1196 #define NFT_GENMASK_ANY ((1 << 0) | (1 << 1))
1199 * Generic transaction helpers
1202 /* Check if this object is currently active. */
1203 #define nft_is_active(__net, __obj) \
1204 (((__obj)->genmask & nft_genmask_cur(__net)) == 0)
1206 /* Check if this object is active in the next generation. */
1207 #define nft_is_active_next(__net, __obj) \
1208 (((__obj)->genmask & nft_genmask_next(__net)) == 0)
1210 /* This object becomes active in the next generation. */
1211 #define nft_activate_next(__net, __obj) \
1212 (__obj)->genmask = nft_genmask_cur(__net)
1214 /* This object becomes inactive in the next generation. */
1215 #define nft_deactivate_next(__net, __obj) \
1216 (__obj)->genmask = nft_genmask_next(__net)
1218 /* After committing the ruleset, clear the stale generation bit. */
1219 #define nft_clear(__net, __obj) \
1220 (__obj)->genmask &= ~nft_genmask_next(__net)
1221 #define nft_active_genmask(__obj, __genmask) \
1222 !((__obj)->genmask & __genmask)
1225 * Set element transaction helpers
1228 static inline bool nft_set_elem_active(const struct nft_set_ext *ext,
1231 return !(ext->genmask & genmask);
1234 static inline void nft_set_elem_change_active(const struct net *net,
1235 const struct nft_set *set,
1236 struct nft_set_ext *ext)
1238 ext->genmask ^= nft_genmask_next(net);
1242 * We use a free bit in the genmask field to indicate the element
1243 * is busy, meaning it is currently being processed either by
1244 * the netlink API or GC.
1246 * Even though the genmask is only a single byte wide, this works
1247 * because the extension structure if fully constant once initialized,
1248 * so there are no non-atomic write accesses unless it is already
1251 #define NFT_SET_ELEM_BUSY_MASK (1 << 2)
1253 #if defined(__LITTLE_ENDIAN_BITFIELD)
1254 #define NFT_SET_ELEM_BUSY_BIT 2
1255 #elif defined(__BIG_ENDIAN_BITFIELD)
1256 #define NFT_SET_ELEM_BUSY_BIT (BITS_PER_LONG - BITS_PER_BYTE + 2)
1261 static inline int nft_set_elem_mark_busy(struct nft_set_ext *ext)
1263 unsigned long *word = (unsigned long *)ext;
1265 BUILD_BUG_ON(offsetof(struct nft_set_ext, genmask) != 0);
1266 return test_and_set_bit(NFT_SET_ELEM_BUSY_BIT, word);
1269 static inline void nft_set_elem_clear_busy(struct nft_set_ext *ext)
1271 unsigned long *word = (unsigned long *)ext;
1273 clear_bit(NFT_SET_ELEM_BUSY_BIT, word);
1277 * struct nft_trans - nf_tables object update in transaction
1279 * @list: used internally
1280 * @msg_type: message type
1281 * @ctx: transaction context
1282 * @data: internal information related to the transaction
1285 struct list_head list;
1291 struct nft_trans_rule {
1292 struct nft_rule *rule;
1296 #define nft_trans_rule(trans) \
1297 (((struct nft_trans_rule *)trans->data)->rule)
1298 #define nft_trans_rule_id(trans) \
1299 (((struct nft_trans_rule *)trans->data)->rule_id)
1301 struct nft_trans_set {
1302 struct nft_set *set;
1306 #define nft_trans_set(trans) \
1307 (((struct nft_trans_set *)trans->data)->set)
1308 #define nft_trans_set_id(trans) \
1309 (((struct nft_trans_set *)trans->data)->set_id)
1311 struct nft_trans_chain {
1314 struct nft_stats __percpu *stats;
1318 #define nft_trans_chain_update(trans) \
1319 (((struct nft_trans_chain *)trans->data)->update)
1320 #define nft_trans_chain_name(trans) \
1321 (((struct nft_trans_chain *)trans->data)->name)
1322 #define nft_trans_chain_stats(trans) \
1323 (((struct nft_trans_chain *)trans->data)->stats)
1324 #define nft_trans_chain_policy(trans) \
1325 (((struct nft_trans_chain *)trans->data)->policy)
1327 struct nft_trans_table {
1332 #define nft_trans_table_update(trans) \
1333 (((struct nft_trans_table *)trans->data)->update)
1334 #define nft_trans_table_enable(trans) \
1335 (((struct nft_trans_table *)trans->data)->enable)
1337 struct nft_trans_elem {
1338 struct nft_set *set;
1339 struct nft_set_elem elem;
1342 #define nft_trans_elem_set(trans) \
1343 (((struct nft_trans_elem *)trans->data)->set)
1344 #define nft_trans_elem(trans) \
1345 (((struct nft_trans_elem *)trans->data)->elem)
1347 struct nft_trans_obj {
1348 struct nft_object *obj;
1351 #define nft_trans_obj(trans) \
1352 (((struct nft_trans_obj *)trans->data)->obj)
1354 struct nft_trans_flowtable {
1355 struct nft_flowtable *flowtable;
1358 #define nft_trans_flowtable(trans) \
1359 (((struct nft_trans_flowtable *)trans->data)->flowtable)
1361 int __init nft_chain_filter_init(void);
1362 void __exit nft_chain_filter_fini(void);
1364 #endif /* _NET_NF_TABLES_H */