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 * @table: table this set belongs to
374 * @net: netnamespace this set belongs to
375 * @name: name of the set
376 * @handle: unique handle of the set
377 * @ktype: key type (numeric type defined by userspace, not used in the kernel)
378 * @dtype: data type (verdict or numeric type defined by userspace)
379 * @objtype: object type (see NFT_OBJECT_* definitions)
380 * @size: maximum set size
381 * @nelems: number of elements
382 * @ndeact: number of deactivated elements queued for removal
383 * @timeout: default timeout value in jiffies
384 * @gc_int: garbage collection interval in msecs
385 * @policy: set parameterization (see enum nft_set_policies)
386 * @udlen: user data length
390 * @genmask: generation mask
393 * @data: private set data
396 struct list_head list;
397 struct list_head bindings;
398 struct nft_table *table;
412 unsigned char *udata;
413 /* runtime data below here */
414 const struct nft_set_ops *ops ____cacheline_aligned;
420 __attribute__((aligned(__alignof__(u64))));
423 static inline bool nft_set_is_anonymous(const struct nft_set *set)
425 return set->flags & NFT_SET_ANONYMOUS;
428 static inline void *nft_set_priv(const struct nft_set *set)
430 return (void *)set->data;
433 static inline struct nft_set *nft_set_container_of(const void *priv)
435 return (void *)priv - offsetof(struct nft_set, data);
438 struct nft_set *nft_set_lookup_global(const struct net *net,
439 const struct nft_table *table,
440 const struct nlattr *nla_set_name,
441 const struct nlattr *nla_set_id,
444 static inline unsigned long nft_set_gc_interval(const struct nft_set *set)
446 return set->gc_int ? msecs_to_jiffies(set->gc_int) : HZ;
450 * struct nft_set_binding - nf_tables set binding
452 * @list: set bindings list node
453 * @chain: chain containing the rule bound to the set
454 * @flags: set action flags
456 * A set binding contains all information necessary for validation
457 * of new elements added to a bound set.
459 struct nft_set_binding {
460 struct list_head list;
461 const struct nft_chain *chain;
465 int nf_tables_bind_set(const struct nft_ctx *ctx, struct nft_set *set,
466 struct nft_set_binding *binding);
467 void nf_tables_unbind_set(const struct nft_ctx *ctx, struct nft_set *set,
468 struct nft_set_binding *binding);
471 * enum nft_set_extensions - set extension type IDs
473 * @NFT_SET_EXT_KEY: element key
474 * @NFT_SET_EXT_DATA: mapping data
475 * @NFT_SET_EXT_FLAGS: element flags
476 * @NFT_SET_EXT_TIMEOUT: element timeout
477 * @NFT_SET_EXT_EXPIRATION: element expiration time
478 * @NFT_SET_EXT_USERDATA: user data associated with the element
479 * @NFT_SET_EXT_EXPR: expression assiociated with the element
480 * @NFT_SET_EXT_OBJREF: stateful object reference associated with element
481 * @NFT_SET_EXT_NUM: number of extension types
483 enum nft_set_extensions {
488 NFT_SET_EXT_EXPIRATION,
489 NFT_SET_EXT_USERDATA,
496 * struct nft_set_ext_type - set extension type
498 * @len: fixed part length of the extension
499 * @align: alignment requirements of the extension
501 struct nft_set_ext_type {
506 extern const struct nft_set_ext_type nft_set_ext_types[];
509 * struct nft_set_ext_tmpl - set extension template
511 * @len: length of extension area
512 * @offset: offsets of individual extension types
514 struct nft_set_ext_tmpl {
516 u8 offset[NFT_SET_EXT_NUM];
520 * struct nft_set_ext - set extensions
522 * @genmask: generation mask
523 * @offset: offsets of individual extension types
524 * @data: beginning of extension data
528 u8 offset[NFT_SET_EXT_NUM];
532 static inline void nft_set_ext_prepare(struct nft_set_ext_tmpl *tmpl)
534 memset(tmpl, 0, sizeof(*tmpl));
535 tmpl->len = sizeof(struct nft_set_ext);
538 static inline void nft_set_ext_add_length(struct nft_set_ext_tmpl *tmpl, u8 id,
541 tmpl->len = ALIGN(tmpl->len, nft_set_ext_types[id].align);
542 BUG_ON(tmpl->len > U8_MAX);
543 tmpl->offset[id] = tmpl->len;
544 tmpl->len += nft_set_ext_types[id].len + len;
547 static inline void nft_set_ext_add(struct nft_set_ext_tmpl *tmpl, u8 id)
549 nft_set_ext_add_length(tmpl, id, 0);
552 static inline void nft_set_ext_init(struct nft_set_ext *ext,
553 const struct nft_set_ext_tmpl *tmpl)
555 memcpy(ext->offset, tmpl->offset, sizeof(ext->offset));
558 static inline bool __nft_set_ext_exists(const struct nft_set_ext *ext, u8 id)
560 return !!ext->offset[id];
563 static inline bool nft_set_ext_exists(const struct nft_set_ext *ext, u8 id)
565 return ext && __nft_set_ext_exists(ext, id);
568 static inline void *nft_set_ext(const struct nft_set_ext *ext, u8 id)
570 return (void *)ext + ext->offset[id];
573 static inline struct nft_data *nft_set_ext_key(const struct nft_set_ext *ext)
575 return nft_set_ext(ext, NFT_SET_EXT_KEY);
578 static inline struct nft_data *nft_set_ext_data(const struct nft_set_ext *ext)
580 return nft_set_ext(ext, NFT_SET_EXT_DATA);
583 static inline u8 *nft_set_ext_flags(const struct nft_set_ext *ext)
585 return nft_set_ext(ext, NFT_SET_EXT_FLAGS);
588 static inline u64 *nft_set_ext_timeout(const struct nft_set_ext *ext)
590 return nft_set_ext(ext, NFT_SET_EXT_TIMEOUT);
593 static inline u64 *nft_set_ext_expiration(const struct nft_set_ext *ext)
595 return nft_set_ext(ext, NFT_SET_EXT_EXPIRATION);
598 static inline struct nft_userdata *nft_set_ext_userdata(const struct nft_set_ext *ext)
600 return nft_set_ext(ext, NFT_SET_EXT_USERDATA);
603 static inline struct nft_expr *nft_set_ext_expr(const struct nft_set_ext *ext)
605 return nft_set_ext(ext, NFT_SET_EXT_EXPR);
608 static inline bool nft_set_elem_expired(const struct nft_set_ext *ext)
610 return nft_set_ext_exists(ext, NFT_SET_EXT_EXPIRATION) &&
611 time_is_before_eq_jiffies64(*nft_set_ext_expiration(ext));
614 static inline struct nft_set_ext *nft_set_elem_ext(const struct nft_set *set,
617 return elem + set->ops->elemsize;
620 static inline struct nft_object **nft_set_ext_obj(const struct nft_set_ext *ext)
622 return nft_set_ext(ext, NFT_SET_EXT_OBJREF);
625 void *nft_set_elem_init(const struct nft_set *set,
626 const struct nft_set_ext_tmpl *tmpl,
627 const u32 *key, const u32 *data,
628 u64 timeout, gfp_t gfp);
629 void nft_set_elem_destroy(const struct nft_set *set, void *elem,
633 * struct nft_set_gc_batch_head - nf_tables set garbage collection batch
636 * @set: set the elements belong to
637 * @cnt: count of elements
639 struct nft_set_gc_batch_head {
641 const struct nft_set *set;
645 #define NFT_SET_GC_BATCH_SIZE ((PAGE_SIZE - \
646 sizeof(struct nft_set_gc_batch_head)) / \
650 * struct nft_set_gc_batch - nf_tables set garbage collection batch
652 * @head: GC batch head
653 * @elems: garbage collection elements
655 struct nft_set_gc_batch {
656 struct nft_set_gc_batch_head head;
657 void *elems[NFT_SET_GC_BATCH_SIZE];
660 struct nft_set_gc_batch *nft_set_gc_batch_alloc(const struct nft_set *set,
662 void nft_set_gc_batch_release(struct rcu_head *rcu);
664 static inline void nft_set_gc_batch_complete(struct nft_set_gc_batch *gcb)
667 call_rcu(&gcb->head.rcu, nft_set_gc_batch_release);
670 static inline struct nft_set_gc_batch *
671 nft_set_gc_batch_check(const struct nft_set *set, struct nft_set_gc_batch *gcb,
675 if (gcb->head.cnt + 1 < ARRAY_SIZE(gcb->elems))
677 nft_set_gc_batch_complete(gcb);
679 return nft_set_gc_batch_alloc(set, gfp);
682 static inline void nft_set_gc_batch_add(struct nft_set_gc_batch *gcb,
685 gcb->elems[gcb->head.cnt++] = elem;
689 * struct nft_expr_type - nf_tables expression type
691 * @select_ops: function to select nft_expr_ops
692 * @ops: default ops, used when no select_ops functions is present
693 * @list: used internally
695 * @owner: module reference
696 * @policy: netlink attribute policy
697 * @maxattr: highest netlink attribute number
698 * @family: address family for AF-specific types
699 * @flags: expression type flags
701 struct nft_expr_type {
702 const struct nft_expr_ops *(*select_ops)(const struct nft_ctx *,
703 const struct nlattr * const tb[]);
704 const struct nft_expr_ops *ops;
705 struct list_head list;
707 struct module *owner;
708 const struct nla_policy *policy;
709 unsigned int maxattr;
714 #define NFT_EXPR_STATEFUL 0x1
717 * struct nft_expr_ops - nf_tables expression operations
719 * @eval: Expression evaluation function
720 * @size: full expression size, including private data size
721 * @init: initialization function
722 * @destroy: destruction function
723 * @dump: function to dump parameters
724 * @type: expression type
725 * @validate: validate expression, called during loop detection
726 * @data: extra data to attach to this expression operation
729 struct nft_expr_ops {
730 void (*eval)(const struct nft_expr *expr,
731 struct nft_regs *regs,
732 const struct nft_pktinfo *pkt);
733 int (*clone)(struct nft_expr *dst,
734 const struct nft_expr *src);
737 int (*init)(const struct nft_ctx *ctx,
738 const struct nft_expr *expr,
739 const struct nlattr * const tb[]);
740 void (*activate)(const struct nft_ctx *ctx,
741 const struct nft_expr *expr);
742 void (*deactivate)(const struct nft_ctx *ctx,
743 const struct nft_expr *expr);
744 void (*destroy)(const struct nft_ctx *ctx,
745 const struct nft_expr *expr);
746 int (*dump)(struct sk_buff *skb,
747 const struct nft_expr *expr);
748 int (*validate)(const struct nft_ctx *ctx,
749 const struct nft_expr *expr,
750 const struct nft_data **data);
751 const struct nft_expr_type *type;
755 #define NFT_EXPR_MAXATTR 16
756 #define NFT_EXPR_SIZE(size) (sizeof(struct nft_expr) + \
757 ALIGN(size, __alignof__(struct nft_expr)))
760 * struct nft_expr - nf_tables expression
762 * @ops: expression ops
763 * @data: expression private data
766 const struct nft_expr_ops *ops;
767 unsigned char data[];
770 static inline void *nft_expr_priv(const struct nft_expr *expr)
772 return (void *)expr->data;
775 struct nft_expr *nft_expr_init(const struct nft_ctx *ctx,
776 const struct nlattr *nla);
777 void nft_expr_destroy(const struct nft_ctx *ctx, struct nft_expr *expr);
778 int nft_expr_dump(struct sk_buff *skb, unsigned int attr,
779 const struct nft_expr *expr);
781 static inline int nft_expr_clone(struct nft_expr *dst, struct nft_expr *src)
785 if (src->ops->clone) {
787 err = src->ops->clone(dst, src);
791 memcpy(dst, src, src->ops->size);
794 __module_get(src->ops->type->owner);
799 * struct nft_rule - nf_tables rule
801 * @list: used internally
802 * @handle: rule handle
803 * @genmask: generation mask
804 * @dlen: length of expression data
805 * @udata: user data is appended to the rule
806 * @data: expression data
809 struct list_head list;
815 __attribute__((aligned(__alignof__(struct nft_expr))));
818 static inline struct nft_expr *nft_expr_first(const struct nft_rule *rule)
820 return (struct nft_expr *)&rule->data[0];
823 static inline struct nft_expr *nft_expr_next(const struct nft_expr *expr)
825 return ((void *)expr) + expr->ops->size;
828 static inline struct nft_expr *nft_expr_last(const struct nft_rule *rule)
830 return (struct nft_expr *)&rule->data[rule->dlen];
833 static inline struct nft_userdata *nft_userdata(const struct nft_rule *rule)
835 return (void *)&rule->data[rule->dlen];
839 * The last pointer isn't really necessary, but the compiler isn't able to
840 * determine that the result of nft_expr_last() is always the same since it
841 * can't assume that the dlen value wasn't changed within calls in the loop.
843 #define nft_rule_for_each_expr(expr, last, rule) \
844 for ((expr) = nft_expr_first(rule), (last) = nft_expr_last(rule); \
846 (expr) = nft_expr_next(expr))
848 enum nft_chain_flags {
849 NFT_BASE_CHAIN = 0x1,
853 * struct nft_chain - nf_tables chain
855 * @rules: list of rules in the chain
856 * @list: used internally
857 * @table: table that this chain belongs to
858 * @handle: chain handle
859 * @use: number of jump references to this chain
860 * @level: length of longest path to this chain
861 * @flags: bitmask of enum nft_chain_flags
862 * @name: name of the chain
865 struct nft_rule *__rcu *rules_gen_0;
866 struct nft_rule *__rcu *rules_gen_1;
867 struct list_head rules;
868 struct list_head list;
869 struct nft_table *table;
877 /* Only used during control plane commit phase: */
878 struct nft_rule **rules_next;
881 int nft_chain_validate(const struct nft_ctx *ctx, const struct nft_chain *chain);
883 enum nft_chain_types {
884 NFT_CHAIN_T_DEFAULT = 0,
891 * struct nft_chain_type - nf_tables chain type info
893 * @name: name of the type
894 * @type: numeric identifier
895 * @family: address family
896 * @owner: module owner
897 * @hook_mask: mask of valid hooks
898 * @hooks: array of hook functions
899 * @ops_register: base chain register function
900 * @ops_unregister: base chain unregister function
902 struct nft_chain_type {
904 enum nft_chain_types type;
906 struct module *owner;
907 unsigned int hook_mask;
908 nf_hookfn *hooks[NF_MAX_HOOKS];
909 int (*ops_register)(struct net *net, const struct nf_hook_ops *ops);
910 void (*ops_unregister)(struct net *net, const struct nf_hook_ops *ops);
913 int nft_chain_validate_dependency(const struct nft_chain *chain,
914 enum nft_chain_types type);
915 int nft_chain_validate_hooks(const struct nft_chain *chain,
916 unsigned int hook_flags);
921 struct u64_stats_sync syncp;
925 * struct nft_base_chain - nf_tables base chain
927 * @ops: netfilter hook ops
929 * @policy: default policy
930 * @stats: per-cpu chain stats
932 * @dev_name: device name that this base chain is attached to (if any)
934 struct nft_base_chain {
935 struct nf_hook_ops ops;
936 const struct nft_chain_type *type;
939 struct nft_stats __percpu *stats;
940 struct nft_chain chain;
941 char dev_name[IFNAMSIZ];
944 static inline struct nft_base_chain *nft_base_chain(const struct nft_chain *chain)
946 return container_of(chain, struct nft_base_chain, chain);
949 static inline bool nft_is_base_chain(const struct nft_chain *chain)
951 return chain->flags & NFT_BASE_CHAIN;
954 int __nft_release_basechain(struct nft_ctx *ctx);
956 unsigned int nft_do_chain(struct nft_pktinfo *pkt, void *priv);
959 * struct nft_table - nf_tables table
961 * @list: used internally
962 * @chains: chains in the table
963 * @sets: sets in the table
964 * @objects: stateful objects in the table
965 * @flowtables: flow tables in the table
966 * @hgenerator: handle generator state
967 * @handle: table handle
968 * @use: number of chain references to this table
969 * @flags: table flag (see enum nft_table_flags)
970 * @genmask: generation mask
971 * @afinfo: address family info
972 * @name: name of the table
975 struct list_head list;
976 struct list_head chains;
977 struct list_head sets;
978 struct list_head objects;
979 struct list_head flowtables;
989 void nft_register_chain_type(const struct nft_chain_type *);
990 void nft_unregister_chain_type(const struct nft_chain_type *);
992 int nft_register_expr(struct nft_expr_type *);
993 void nft_unregister_expr(struct nft_expr_type *);
995 int nft_verdict_dump(struct sk_buff *skb, int type,
996 const struct nft_verdict *v);
999 * struct nft_object - nf_tables stateful object
1001 * @list: table stateful object list node
1002 * @table: table this object belongs to
1003 * @name: name of this stateful object
1004 * @genmask: generation mask
1005 * @use: number of references to this stateful object
1006 * @handle: unique object handle
1007 * @ops: object operations
1008 * @data: object data, layout depends on type
1011 struct list_head list;
1013 struct nft_table *table;
1017 /* runtime data below here */
1018 const struct nft_object_ops *ops ____cacheline_aligned;
1019 unsigned char data[]
1020 __attribute__((aligned(__alignof__(u64))));
1023 static inline void *nft_obj_data(const struct nft_object *obj)
1025 return (void *)obj->data;
1028 #define nft_expr_obj(expr) *((struct nft_object **)nft_expr_priv(expr))
1030 struct nft_object *nft_obj_lookup(const struct nft_table *table,
1031 const struct nlattr *nla, u32 objtype,
1034 void nft_obj_notify(struct net *net, struct nft_table *table,
1035 struct nft_object *obj, u32 portid, u32 seq,
1036 int event, int family, int report, gfp_t gfp);
1039 * struct nft_object_type - stateful object type
1041 * @select_ops: function to select nft_object_ops
1042 * @ops: default ops, used when no select_ops functions is present
1043 * @list: list node in list of object types
1044 * @type: stateful object numeric type
1045 * @owner: module owner
1046 * @maxattr: maximum netlink attribute
1047 * @policy: netlink attribute policy
1049 struct nft_object_type {
1050 const struct nft_object_ops *(*select_ops)(const struct nft_ctx *,
1051 const struct nlattr * const tb[]);
1052 const struct nft_object_ops *ops;
1053 struct list_head list;
1055 unsigned int maxattr;
1056 struct module *owner;
1057 const struct nla_policy *policy;
1061 * struct nft_object_ops - stateful object operations
1063 * @eval: stateful object evaluation function
1064 * @size: stateful object size
1065 * @init: initialize object from netlink attributes
1066 * @destroy: release existing stateful object
1067 * @dump: netlink dump stateful object
1069 struct nft_object_ops {
1070 void (*eval)(struct nft_object *obj,
1071 struct nft_regs *regs,
1072 const struct nft_pktinfo *pkt);
1074 int (*init)(const struct nft_ctx *ctx,
1075 const struct nlattr *const tb[],
1076 struct nft_object *obj);
1077 void (*destroy)(const struct nft_ctx *ctx,
1078 struct nft_object *obj);
1079 int (*dump)(struct sk_buff *skb,
1080 struct nft_object *obj,
1082 const struct nft_object_type *type;
1085 int nft_register_obj(struct nft_object_type *obj_type);
1086 void nft_unregister_obj(struct nft_object_type *obj_type);
1088 #define NFT_FLOWTABLE_DEVICE_MAX 8
1091 * struct nft_flowtable - nf_tables flow table
1093 * @list: flow table list node in table list
1094 * @table: the table the flow table is contained in
1095 * @name: name of this flow table
1096 * @hooknum: hook number
1097 * @priority: hook priority
1098 * @ops_len: number of hooks in array
1099 * @genmask: generation mask
1100 * @use: number of references to this flow table
1101 * @handle: unique object handle
1102 * @dev_name: array of device names
1103 * @data: rhashtable and garbage collector
1104 * @ops: array of hooks
1106 struct nft_flowtable {
1107 struct list_head list;
1108 struct nft_table *table;
1116 char *dev_name[NFT_FLOWTABLE_DEVICE_MAX];
1117 /* runtime data below here */
1118 struct nf_hook_ops *ops ____cacheline_aligned;
1119 struct nf_flowtable data;
1122 struct nft_flowtable *nft_flowtable_lookup(const struct nft_table *table,
1123 const struct nlattr *nla,
1126 void nft_register_flowtable_type(struct nf_flowtable_type *type);
1127 void nft_unregister_flowtable_type(struct nf_flowtable_type *type);
1130 * struct nft_traceinfo - nft tracing information and state
1132 * @pkt: pktinfo currently processed
1133 * @basechain: base chain currently processed
1134 * @chain: chain currently processed
1135 * @rule: rule that was evaluated
1136 * @verdict: verdict given by rule
1137 * @type: event type (enum nft_trace_types)
1138 * @packet_dumped: packet headers sent in a previous traceinfo message
1139 * @trace: other struct members are initialised
1141 struct nft_traceinfo {
1142 const struct nft_pktinfo *pkt;
1143 const struct nft_base_chain *basechain;
1144 const struct nft_chain *chain;
1145 const struct nft_rule *rule;
1146 const struct nft_verdict *verdict;
1147 enum nft_trace_types type;
1152 void nft_trace_init(struct nft_traceinfo *info, const struct nft_pktinfo *pkt,
1153 const struct nft_verdict *verdict,
1154 const struct nft_chain *basechain);
1156 void nft_trace_notify(struct nft_traceinfo *info);
1158 #define MODULE_ALIAS_NFT_CHAIN(family, name) \
1159 MODULE_ALIAS("nft-chain-" __stringify(family) "-" name)
1161 #define MODULE_ALIAS_NFT_AF_EXPR(family, name) \
1162 MODULE_ALIAS("nft-expr-" __stringify(family) "-" name)
1164 #define MODULE_ALIAS_NFT_EXPR(name) \
1165 MODULE_ALIAS("nft-expr-" name)
1167 #define MODULE_ALIAS_NFT_SET() \
1168 MODULE_ALIAS("nft-set")
1170 #define MODULE_ALIAS_NFT_OBJ(type) \
1171 MODULE_ALIAS("nft-obj-" __stringify(type))
1174 * The gencursor defines two generations, the currently active and the
1175 * next one. Objects contain a bitmask of 2 bits specifying the generations
1176 * they're active in. A set bit means they're inactive in the generation
1177 * represented by that bit.
1179 * New objects start out as inactive in the current and active in the
1180 * next generation. When committing the ruleset the bitmask is cleared,
1181 * meaning they're active in all generations. When removing an object,
1182 * it is set inactive in the next generation. After committing the ruleset,
1183 * the objects are removed.
1185 static inline unsigned int nft_gencursor_next(const struct net *net)
1187 return net->nft.gencursor + 1 == 1 ? 1 : 0;
1190 static inline u8 nft_genmask_next(const struct net *net)
1192 return 1 << nft_gencursor_next(net);
1195 static inline u8 nft_genmask_cur(const struct net *net)
1197 /* Use READ_ONCE() to prevent refetching the value for atomicity */
1198 return 1 << READ_ONCE(net->nft.gencursor);
1201 #define NFT_GENMASK_ANY ((1 << 0) | (1 << 1))
1204 * Generic transaction helpers
1207 /* Check if this object is currently active. */
1208 #define nft_is_active(__net, __obj) \
1209 (((__obj)->genmask & nft_genmask_cur(__net)) == 0)
1211 /* Check if this object is active in the next generation. */
1212 #define nft_is_active_next(__net, __obj) \
1213 (((__obj)->genmask & nft_genmask_next(__net)) == 0)
1215 /* This object becomes active in the next generation. */
1216 #define nft_activate_next(__net, __obj) \
1217 (__obj)->genmask = nft_genmask_cur(__net)
1219 /* This object becomes inactive in the next generation. */
1220 #define nft_deactivate_next(__net, __obj) \
1221 (__obj)->genmask = nft_genmask_next(__net)
1223 /* After committing the ruleset, clear the stale generation bit. */
1224 #define nft_clear(__net, __obj) \
1225 (__obj)->genmask &= ~nft_genmask_next(__net)
1226 #define nft_active_genmask(__obj, __genmask) \
1227 !((__obj)->genmask & __genmask)
1230 * Set element transaction helpers
1233 static inline bool nft_set_elem_active(const struct nft_set_ext *ext,
1236 return !(ext->genmask & genmask);
1239 static inline void nft_set_elem_change_active(const struct net *net,
1240 const struct nft_set *set,
1241 struct nft_set_ext *ext)
1243 ext->genmask ^= nft_genmask_next(net);
1247 * We use a free bit in the genmask field to indicate the element
1248 * is busy, meaning it is currently being processed either by
1249 * the netlink API or GC.
1251 * Even though the genmask is only a single byte wide, this works
1252 * because the extension structure if fully constant once initialized,
1253 * so there are no non-atomic write accesses unless it is already
1256 #define NFT_SET_ELEM_BUSY_MASK (1 << 2)
1258 #if defined(__LITTLE_ENDIAN_BITFIELD)
1259 #define NFT_SET_ELEM_BUSY_BIT 2
1260 #elif defined(__BIG_ENDIAN_BITFIELD)
1261 #define NFT_SET_ELEM_BUSY_BIT (BITS_PER_LONG - BITS_PER_BYTE + 2)
1266 static inline int nft_set_elem_mark_busy(struct nft_set_ext *ext)
1268 unsigned long *word = (unsigned long *)ext;
1270 BUILD_BUG_ON(offsetof(struct nft_set_ext, genmask) != 0);
1271 return test_and_set_bit(NFT_SET_ELEM_BUSY_BIT, word);
1274 static inline void nft_set_elem_clear_busy(struct nft_set_ext *ext)
1276 unsigned long *word = (unsigned long *)ext;
1278 clear_bit(NFT_SET_ELEM_BUSY_BIT, word);
1282 * struct nft_trans - nf_tables object update in transaction
1284 * @list: used internally
1285 * @msg_type: message type
1286 * @ctx: transaction context
1287 * @data: internal information related to the transaction
1290 struct list_head list;
1296 struct nft_trans_rule {
1297 struct nft_rule *rule;
1301 #define nft_trans_rule(trans) \
1302 (((struct nft_trans_rule *)trans->data)->rule)
1303 #define nft_trans_rule_id(trans) \
1304 (((struct nft_trans_rule *)trans->data)->rule_id)
1306 struct nft_trans_set {
1307 struct nft_set *set;
1311 #define nft_trans_set(trans) \
1312 (((struct nft_trans_set *)trans->data)->set)
1313 #define nft_trans_set_id(trans) \
1314 (((struct nft_trans_set *)trans->data)->set_id)
1316 struct nft_trans_chain {
1319 struct nft_stats __percpu *stats;
1323 #define nft_trans_chain_update(trans) \
1324 (((struct nft_trans_chain *)trans->data)->update)
1325 #define nft_trans_chain_name(trans) \
1326 (((struct nft_trans_chain *)trans->data)->name)
1327 #define nft_trans_chain_stats(trans) \
1328 (((struct nft_trans_chain *)trans->data)->stats)
1329 #define nft_trans_chain_policy(trans) \
1330 (((struct nft_trans_chain *)trans->data)->policy)
1332 struct nft_trans_table {
1337 #define nft_trans_table_update(trans) \
1338 (((struct nft_trans_table *)trans->data)->update)
1339 #define nft_trans_table_enable(trans) \
1340 (((struct nft_trans_table *)trans->data)->enable)
1342 struct nft_trans_elem {
1343 struct nft_set *set;
1344 struct nft_set_elem elem;
1347 #define nft_trans_elem_set(trans) \
1348 (((struct nft_trans_elem *)trans->data)->set)
1349 #define nft_trans_elem(trans) \
1350 (((struct nft_trans_elem *)trans->data)->elem)
1352 struct nft_trans_obj {
1353 struct nft_object *obj;
1356 #define nft_trans_obj(trans) \
1357 (((struct nft_trans_obj *)trans->data)->obj)
1359 struct nft_trans_flowtable {
1360 struct nft_flowtable *flowtable;
1363 #define nft_trans_flowtable(trans) \
1364 (((struct nft_trans_flowtable *)trans->data)->flowtable)
1366 int __init nft_chain_filter_init(void);
1367 void __exit nft_chain_filter_fini(void);
1369 #endif /* _NET_NF_TABLES_H */