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_release(const struct nft_data *data, enum nft_data_types type);
174 int nft_data_dump(struct sk_buff *skb, int attr, const struct nft_data *data,
175 enum nft_data_types type, unsigned int len);
177 static inline enum nft_data_types nft_dreg_to_type(enum nft_registers reg)
179 return reg == NFT_REG_VERDICT ? NFT_DATA_VERDICT : NFT_DATA_VALUE;
182 static inline enum nft_registers nft_type_to_reg(enum nft_data_types type)
184 return type == NFT_DATA_VERDICT ? NFT_REG_VERDICT : NFT_REG_1 * NFT_REG_SIZE / NFT_REG32_SIZE;
187 int nft_parse_u32_check(const struct nlattr *attr, int max, u32 *dest);
188 unsigned int nft_parse_register(const struct nlattr *attr);
189 int nft_dump_register(struct sk_buff *skb, unsigned int attr, unsigned int reg);
191 int nft_validate_register_load(enum nft_registers reg, unsigned int len);
192 int nft_validate_register_store(const struct nft_ctx *ctx,
193 enum nft_registers reg,
194 const struct nft_data *data,
195 enum nft_data_types type, unsigned int len);
198 * struct nft_userdata - user defined data associated with an object
200 * @len: length of the data
203 * The presence of user data is indicated in an object specific fashion,
204 * so a length of zero can't occur and the value "len" indicates data
207 struct nft_userdata {
209 unsigned char data[0];
213 * struct nft_set_elem - generic representation of set elements
216 * @priv: element private data and extensions
218 struct nft_set_elem {
220 u32 buf[NFT_DATA_VALUE_MAXLEN / sizeof(u32)];
227 struct nft_set_iter {
232 int (*fn)(const struct nft_ctx *ctx,
234 const struct nft_set_iter *iter,
235 struct nft_set_elem *elem);
239 * struct nft_set_desc - description of set elements
243 * @size: number of set elements
245 struct nft_set_desc {
252 * enum nft_set_class - performance class
254 * @NFT_LOOKUP_O_1: constant, O(1)
255 * @NFT_LOOKUP_O_LOG_N: logarithmic, O(log N)
256 * @NFT_LOOKUP_O_N: linear, O(N)
260 NFT_SET_CLASS_O_LOG_N,
265 * struct nft_set_estimate - estimation of memory and performance
268 * @size: required memory
269 * @lookup: lookup performance class
270 * @space: memory class
272 struct nft_set_estimate {
274 enum nft_set_class lookup;
275 enum nft_set_class space;
279 * struct nft_set_type - nf_tables set type
281 * @select_ops: function to select nft_set_ops
282 * @ops: default ops, used when no select_ops functions is present
283 * @list: used internally
284 * @owner: module reference
286 struct nft_set_type {
287 const struct nft_set_ops *(*select_ops)(const struct nft_ctx *,
288 const struct nft_set_desc *desc,
290 const struct nft_set_ops *ops;
291 struct list_head list;
292 struct module *owner;
299 * struct nft_set_ops - nf_tables set operations
301 * @lookup: look up an element within the set
302 * @insert: insert new element into set
303 * @activate: activate new element in the next generation
304 * @deactivate: lookup for element and deactivate it in the next generation
305 * @flush: deactivate element in the next generation
306 * @remove: remove element from set
307 * @walk: iterate over all set elemeennts
308 * @get: get set elements
309 * @privsize: function to return size of set private data
310 * @init: initialize private data of new set instance
311 * @destroy: destroy private data of set instance
312 * @elemsize: element private size
313 * @features: features supported by the implementation
316 bool (*lookup)(const struct net *net,
317 const struct nft_set *set,
319 const struct nft_set_ext **ext);
320 bool (*update)(struct nft_set *set,
322 void *(*new)(struct nft_set *,
323 const struct nft_expr *,
325 const struct nft_expr *expr,
326 struct nft_regs *regs,
327 const struct nft_set_ext **ext);
329 int (*insert)(const struct net *net,
330 const struct nft_set *set,
331 const struct nft_set_elem *elem,
332 struct nft_set_ext **ext);
333 void (*activate)(const struct net *net,
334 const struct nft_set *set,
335 const struct nft_set_elem *elem);
336 void * (*deactivate)(const struct net *net,
337 const struct nft_set *set,
338 const struct nft_set_elem *elem);
339 bool (*flush)(const struct net *net,
340 const struct nft_set *set,
342 void (*remove)(const struct net *net,
343 const struct nft_set *set,
344 const struct nft_set_elem *elem);
345 void (*walk)(const struct nft_ctx *ctx,
347 struct nft_set_iter *iter);
348 void * (*get)(const struct net *net,
349 const struct nft_set *set,
350 const struct nft_set_elem *elem,
353 unsigned int (*privsize)(const struct nlattr * const nla[],
354 const struct nft_set_desc *desc);
355 bool (*estimate)(const struct nft_set_desc *desc,
357 struct nft_set_estimate *est);
358 int (*init)(const struct nft_set *set,
359 const struct nft_set_desc *desc,
360 const struct nlattr * const nla[]);
361 void (*destroy)(const struct nft_set *set);
363 unsigned int elemsize;
365 const struct nft_set_type *type;
368 int nft_register_set(struct nft_set_type *type);
369 void nft_unregister_set(struct nft_set_type *type);
372 * struct nft_set - nf_tables set instance
374 * @list: table set list node
375 * @bindings: list of set bindings
376 * @name: name of the set
377 * @handle: unique handle of the set
378 * @ktype: key type (numeric type defined by userspace, not used in the kernel)
379 * @dtype: data type (verdict or numeric type defined by userspace)
380 * @objtype: object type (see NFT_OBJECT_* definitions)
381 * @size: maximum set size
382 * @nelems: number of elements
383 * @ndeact: number of deactivated elements queued for removal
384 * @timeout: default timeout value in jiffies
385 * @gc_int: garbage collection interval in msecs
386 * @policy: set parameterization (see enum nft_set_policies)
387 * @udlen: user data length
391 * @genmask: generation mask
394 * @data: private set data
397 struct list_head list;
398 struct list_head bindings;
411 unsigned char *udata;
412 /* runtime data below here */
413 const struct nft_set_ops *ops ____cacheline_aligned;
419 __attribute__((aligned(__alignof__(u64))));
422 static inline bool nft_set_is_anonymous(const struct nft_set *set)
424 return set->flags & NFT_SET_ANONYMOUS;
427 static inline void *nft_set_priv(const struct nft_set *set)
429 return (void *)set->data;
432 static inline struct nft_set *nft_set_container_of(const void *priv)
434 return (void *)priv - offsetof(struct nft_set, data);
437 struct nft_set *nft_set_lookup_global(const struct net *net,
438 const struct nft_table *table,
439 const struct nlattr *nla_set_name,
440 const struct nlattr *nla_set_id,
443 static inline unsigned long nft_set_gc_interval(const struct nft_set *set)
445 return set->gc_int ? msecs_to_jiffies(set->gc_int) : HZ;
449 * struct nft_set_binding - nf_tables set binding
451 * @list: set bindings list node
452 * @chain: chain containing the rule bound to the set
453 * @flags: set action flags
455 * A set binding contains all information necessary for validation
456 * of new elements added to a bound set.
458 struct nft_set_binding {
459 struct list_head list;
460 const struct nft_chain *chain;
464 int nf_tables_bind_set(const struct nft_ctx *ctx, struct nft_set *set,
465 struct nft_set_binding *binding);
466 void nf_tables_unbind_set(const struct nft_ctx *ctx, struct nft_set *set,
467 struct nft_set_binding *binding);
470 * enum nft_set_extensions - set extension type IDs
472 * @NFT_SET_EXT_KEY: element key
473 * @NFT_SET_EXT_DATA: mapping data
474 * @NFT_SET_EXT_FLAGS: element flags
475 * @NFT_SET_EXT_TIMEOUT: element timeout
476 * @NFT_SET_EXT_EXPIRATION: element expiration time
477 * @NFT_SET_EXT_USERDATA: user data associated with the element
478 * @NFT_SET_EXT_EXPR: expression assiociated with the element
479 * @NFT_SET_EXT_OBJREF: stateful object reference associated with element
480 * @NFT_SET_EXT_NUM: number of extension types
482 enum nft_set_extensions {
487 NFT_SET_EXT_EXPIRATION,
488 NFT_SET_EXT_USERDATA,
495 * struct nft_set_ext_type - set extension type
497 * @len: fixed part length of the extension
498 * @align: alignment requirements of the extension
500 struct nft_set_ext_type {
505 extern const struct nft_set_ext_type nft_set_ext_types[];
508 * struct nft_set_ext_tmpl - set extension template
510 * @len: length of extension area
511 * @offset: offsets of individual extension types
513 struct nft_set_ext_tmpl {
515 u8 offset[NFT_SET_EXT_NUM];
519 * struct nft_set_ext - set extensions
521 * @genmask: generation mask
522 * @offset: offsets of individual extension types
523 * @data: beginning of extension data
527 u8 offset[NFT_SET_EXT_NUM];
531 static inline void nft_set_ext_prepare(struct nft_set_ext_tmpl *tmpl)
533 memset(tmpl, 0, sizeof(*tmpl));
534 tmpl->len = sizeof(struct nft_set_ext);
537 static inline void nft_set_ext_add_length(struct nft_set_ext_tmpl *tmpl, u8 id,
540 tmpl->len = ALIGN(tmpl->len, nft_set_ext_types[id].align);
541 BUG_ON(tmpl->len > U8_MAX);
542 tmpl->offset[id] = tmpl->len;
543 tmpl->len += nft_set_ext_types[id].len + len;
546 static inline void nft_set_ext_add(struct nft_set_ext_tmpl *tmpl, u8 id)
548 nft_set_ext_add_length(tmpl, id, 0);
551 static inline void nft_set_ext_init(struct nft_set_ext *ext,
552 const struct nft_set_ext_tmpl *tmpl)
554 memcpy(ext->offset, tmpl->offset, sizeof(ext->offset));
557 static inline bool __nft_set_ext_exists(const struct nft_set_ext *ext, u8 id)
559 return !!ext->offset[id];
562 static inline bool nft_set_ext_exists(const struct nft_set_ext *ext, u8 id)
564 return ext && __nft_set_ext_exists(ext, id);
567 static inline void *nft_set_ext(const struct nft_set_ext *ext, u8 id)
569 return (void *)ext + ext->offset[id];
572 static inline struct nft_data *nft_set_ext_key(const struct nft_set_ext *ext)
574 return nft_set_ext(ext, NFT_SET_EXT_KEY);
577 static inline struct nft_data *nft_set_ext_data(const struct nft_set_ext *ext)
579 return nft_set_ext(ext, NFT_SET_EXT_DATA);
582 static inline u8 *nft_set_ext_flags(const struct nft_set_ext *ext)
584 return nft_set_ext(ext, NFT_SET_EXT_FLAGS);
587 static inline u64 *nft_set_ext_timeout(const struct nft_set_ext *ext)
589 return nft_set_ext(ext, NFT_SET_EXT_TIMEOUT);
592 static inline unsigned long *nft_set_ext_expiration(const struct nft_set_ext *ext)
594 return nft_set_ext(ext, NFT_SET_EXT_EXPIRATION);
597 static inline struct nft_userdata *nft_set_ext_userdata(const struct nft_set_ext *ext)
599 return nft_set_ext(ext, NFT_SET_EXT_USERDATA);
602 static inline struct nft_expr *nft_set_ext_expr(const struct nft_set_ext *ext)
604 return nft_set_ext(ext, NFT_SET_EXT_EXPR);
607 static inline bool nft_set_elem_expired(const struct nft_set_ext *ext)
609 return nft_set_ext_exists(ext, NFT_SET_EXT_EXPIRATION) &&
610 time_is_before_eq_jiffies(*nft_set_ext_expiration(ext));
613 static inline struct nft_set_ext *nft_set_elem_ext(const struct nft_set *set,
616 return elem + set->ops->elemsize;
619 static inline struct nft_object **nft_set_ext_obj(const struct nft_set_ext *ext)
621 return nft_set_ext(ext, NFT_SET_EXT_OBJREF);
624 void *nft_set_elem_init(const struct nft_set *set,
625 const struct nft_set_ext_tmpl *tmpl,
626 const u32 *key, const u32 *data,
627 u64 timeout, gfp_t gfp);
628 void nft_set_elem_destroy(const struct nft_set *set, void *elem,
632 * struct nft_set_gc_batch_head - nf_tables set garbage collection batch
635 * @set: set the elements belong to
636 * @cnt: count of elements
638 struct nft_set_gc_batch_head {
640 const struct nft_set *set;
644 #define NFT_SET_GC_BATCH_SIZE ((PAGE_SIZE - \
645 sizeof(struct nft_set_gc_batch_head)) / \
649 * struct nft_set_gc_batch - nf_tables set garbage collection batch
651 * @head: GC batch head
652 * @elems: garbage collection elements
654 struct nft_set_gc_batch {
655 struct nft_set_gc_batch_head head;
656 void *elems[NFT_SET_GC_BATCH_SIZE];
659 struct nft_set_gc_batch *nft_set_gc_batch_alloc(const struct nft_set *set,
661 void nft_set_gc_batch_release(struct rcu_head *rcu);
663 static inline void nft_set_gc_batch_complete(struct nft_set_gc_batch *gcb)
666 call_rcu(&gcb->head.rcu, nft_set_gc_batch_release);
669 static inline struct nft_set_gc_batch *
670 nft_set_gc_batch_check(const struct nft_set *set, struct nft_set_gc_batch *gcb,
674 if (gcb->head.cnt + 1 < ARRAY_SIZE(gcb->elems))
676 nft_set_gc_batch_complete(gcb);
678 return nft_set_gc_batch_alloc(set, gfp);
681 static inline void nft_set_gc_batch_add(struct nft_set_gc_batch *gcb,
684 gcb->elems[gcb->head.cnt++] = elem;
688 * struct nft_expr_type - nf_tables expression type
690 * @select_ops: function to select nft_expr_ops
691 * @ops: default ops, used when no select_ops functions is present
692 * @list: used internally
694 * @owner: module reference
695 * @policy: netlink attribute policy
696 * @maxattr: highest netlink attribute number
697 * @family: address family for AF-specific types
698 * @flags: expression type flags
700 struct nft_expr_type {
701 const struct nft_expr_ops *(*select_ops)(const struct nft_ctx *,
702 const struct nlattr * const tb[]);
703 const struct nft_expr_ops *ops;
704 struct list_head list;
706 struct module *owner;
707 const struct nla_policy *policy;
708 unsigned int maxattr;
713 #define NFT_EXPR_STATEFUL 0x1
716 * struct nft_expr_ops - nf_tables expression operations
718 * @eval: Expression evaluation function
719 * @size: full expression size, including private data size
720 * @init: initialization function
721 * @destroy: destruction function
722 * @dump: function to dump parameters
723 * @type: expression type
724 * @validate: validate expression, called during loop detection
725 * @data: extra data to attach to this expression operation
728 struct nft_expr_ops {
729 void (*eval)(const struct nft_expr *expr,
730 struct nft_regs *regs,
731 const struct nft_pktinfo *pkt);
732 int (*clone)(struct nft_expr *dst,
733 const struct nft_expr *src);
736 int (*init)(const struct nft_ctx *ctx,
737 const struct nft_expr *expr,
738 const struct nlattr * const tb[]);
739 void (*destroy)(const struct nft_ctx *ctx,
740 const struct nft_expr *expr);
741 int (*dump)(struct sk_buff *skb,
742 const struct nft_expr *expr);
743 int (*validate)(const struct nft_ctx *ctx,
744 const struct nft_expr *expr,
745 const struct nft_data **data);
746 const struct nft_expr_type *type;
750 #define NFT_EXPR_MAXATTR 16
751 #define NFT_EXPR_SIZE(size) (sizeof(struct nft_expr) + \
752 ALIGN(size, __alignof__(struct nft_expr)))
755 * struct nft_expr - nf_tables expression
757 * @ops: expression ops
758 * @data: expression private data
761 const struct nft_expr_ops *ops;
762 unsigned char data[];
765 static inline void *nft_expr_priv(const struct nft_expr *expr)
767 return (void *)expr->data;
770 struct nft_expr *nft_expr_init(const struct nft_ctx *ctx,
771 const struct nlattr *nla);
772 void nft_expr_destroy(const struct nft_ctx *ctx, struct nft_expr *expr);
773 int nft_expr_dump(struct sk_buff *skb, unsigned int attr,
774 const struct nft_expr *expr);
776 static inline int nft_expr_clone(struct nft_expr *dst, struct nft_expr *src)
780 if (src->ops->clone) {
782 err = src->ops->clone(dst, src);
786 memcpy(dst, src, src->ops->size);
789 __module_get(src->ops->type->owner);
794 * struct nft_rule - nf_tables rule
796 * @list: used internally
797 * @handle: rule handle
798 * @genmask: generation mask
799 * @dlen: length of expression data
800 * @udata: user data is appended to the rule
801 * @data: expression data
804 struct list_head list;
810 __attribute__((aligned(__alignof__(struct nft_expr))));
813 static inline struct nft_expr *nft_expr_first(const struct nft_rule *rule)
815 return (struct nft_expr *)&rule->data[0];
818 static inline struct nft_expr *nft_expr_next(const struct nft_expr *expr)
820 return ((void *)expr) + expr->ops->size;
823 static inline struct nft_expr *nft_expr_last(const struct nft_rule *rule)
825 return (struct nft_expr *)&rule->data[rule->dlen];
828 static inline struct nft_userdata *nft_userdata(const struct nft_rule *rule)
830 return (void *)&rule->data[rule->dlen];
834 * The last pointer isn't really necessary, but the compiler isn't able to
835 * determine that the result of nft_expr_last() is always the same since it
836 * can't assume that the dlen value wasn't changed within calls in the loop.
838 #define nft_rule_for_each_expr(expr, last, rule) \
839 for ((expr) = nft_expr_first(rule), (last) = nft_expr_last(rule); \
841 (expr) = nft_expr_next(expr))
843 enum nft_chain_flags {
844 NFT_BASE_CHAIN = 0x1,
848 * struct nft_chain - nf_tables chain
850 * @rules: list of rules in the chain
851 * @list: used internally
852 * @table: table that this chain belongs to
853 * @handle: chain handle
854 * @use: number of jump references to this chain
855 * @level: length of longest path to this chain
856 * @flags: bitmask of enum nft_chain_flags
857 * @name: name of the chain
860 struct list_head rules;
861 struct list_head list;
862 struct nft_table *table;
871 enum nft_chain_types {
872 NFT_CHAIN_T_DEFAULT = 0,
879 * struct nft_chain_type - nf_tables chain type info
881 * @name: name of the type
882 * @type: numeric identifier
883 * @family: address family
884 * @owner: module owner
885 * @hook_mask: mask of valid hooks
886 * @hooks: array of hook functions
887 * @init: chain initialization function
888 * @free: chain release function
890 struct nft_chain_type {
892 enum nft_chain_types type;
894 struct module *owner;
895 unsigned int hook_mask;
896 nf_hookfn *hooks[NF_MAX_HOOKS];
897 int (*init)(struct nft_ctx *ctx);
898 void (*free)(struct nft_ctx *ctx);
901 int nft_chain_validate_dependency(const struct nft_chain *chain,
902 enum nft_chain_types type);
903 int nft_chain_validate_hooks(const struct nft_chain *chain,
904 unsigned int hook_flags);
909 struct u64_stats_sync syncp;
913 * struct nft_base_chain - nf_tables base chain
915 * @ops: netfilter hook ops
917 * @policy: default policy
918 * @stats: per-cpu chain stats
920 * @dev_name: device name that this base chain is attached to (if any)
922 struct nft_base_chain {
923 struct nf_hook_ops ops;
924 const struct nft_chain_type *type;
927 struct nft_stats __percpu *stats;
928 struct nft_chain chain;
929 char dev_name[IFNAMSIZ];
932 static inline struct nft_base_chain *nft_base_chain(const struct nft_chain *chain)
934 return container_of(chain, struct nft_base_chain, chain);
937 static inline bool nft_is_base_chain(const struct nft_chain *chain)
939 return chain->flags & NFT_BASE_CHAIN;
942 int __nft_release_basechain(struct nft_ctx *ctx);
944 unsigned int nft_do_chain(struct nft_pktinfo *pkt, void *priv);
947 * struct nft_table - nf_tables table
949 * @list: used internally
950 * @chains: chains in the table
951 * @sets: sets in the table
952 * @objects: stateful objects in the table
953 * @flowtables: flow tables in the table
954 * @hgenerator: handle generator state
955 * @handle: table handle
956 * @use: number of chain references to this table
957 * @flags: table flag (see enum nft_table_flags)
958 * @genmask: generation mask
959 * @afinfo: address family info
960 * @name: name of the table
963 struct list_head list;
964 struct list_head chains;
965 struct list_head sets;
966 struct list_head objects;
967 struct list_head flowtables;
977 void nft_register_chain_type(const struct nft_chain_type *);
978 void nft_unregister_chain_type(const struct nft_chain_type *);
980 int nft_register_expr(struct nft_expr_type *);
981 void nft_unregister_expr(struct nft_expr_type *);
983 int nft_verdict_dump(struct sk_buff *skb, int type,
984 const struct nft_verdict *v);
987 * struct nft_object - nf_tables stateful object
989 * @list: table stateful object list node
990 * @table: table this object belongs to
991 * @name: name of this stateful object
992 * @genmask: generation mask
993 * @use: number of references to this stateful object
994 * @handle: unique object handle
995 * @ops: object operations
996 * @data: object data, layout depends on type
999 struct list_head list;
1001 struct nft_table *table;
1005 /* runtime data below here */
1006 const struct nft_object_ops *ops ____cacheline_aligned;
1007 unsigned char data[]
1008 __attribute__((aligned(__alignof__(u64))));
1011 static inline void *nft_obj_data(const struct nft_object *obj)
1013 return (void *)obj->data;
1016 #define nft_expr_obj(expr) *((struct nft_object **)nft_expr_priv(expr))
1018 struct nft_object *nf_tables_obj_lookup(const struct nft_table *table,
1019 const struct nlattr *nla, u32 objtype,
1022 void nft_obj_notify(struct net *net, struct nft_table *table,
1023 struct nft_object *obj, u32 portid, u32 seq,
1024 int event, int family, int report, gfp_t gfp);
1027 * struct nft_object_type - stateful object type
1029 * @select_ops: function to select nft_object_ops
1030 * @ops: default ops, used when no select_ops functions is present
1031 * @list: list node in list of object types
1032 * @type: stateful object numeric type
1033 * @owner: module owner
1034 * @maxattr: maximum netlink attribute
1035 * @policy: netlink attribute policy
1037 struct nft_object_type {
1038 const struct nft_object_ops *(*select_ops)(const struct nft_ctx *,
1039 const struct nlattr * const tb[]);
1040 const struct nft_object_ops *ops;
1041 struct list_head list;
1043 unsigned int maxattr;
1044 struct module *owner;
1045 const struct nla_policy *policy;
1049 * struct nft_object_ops - stateful object operations
1051 * @eval: stateful object evaluation function
1052 * @size: stateful object size
1053 * @init: initialize object from netlink attributes
1054 * @destroy: release existing stateful object
1055 * @dump: netlink dump stateful object
1057 struct nft_object_ops {
1058 void (*eval)(struct nft_object *obj,
1059 struct nft_regs *regs,
1060 const struct nft_pktinfo *pkt);
1062 int (*init)(const struct nft_ctx *ctx,
1063 const struct nlattr *const tb[],
1064 struct nft_object *obj);
1065 void (*destroy)(struct nft_object *obj);
1066 int (*dump)(struct sk_buff *skb,
1067 struct nft_object *obj,
1069 const struct nft_object_type *type;
1072 int nft_register_obj(struct nft_object_type *obj_type);
1073 void nft_unregister_obj(struct nft_object_type *obj_type);
1075 #define NFT_FLOWTABLE_DEVICE_MAX 8
1078 * struct nft_flowtable - nf_tables flow table
1080 * @list: flow table list node in table list
1081 * @table: the table the flow table is contained in
1082 * @name: name of this flow table
1083 * @hooknum: hook number
1084 * @priority: hook priority
1085 * @ops_len: number of hooks in array
1086 * @genmask: generation mask
1087 * @use: number of references to this flow table
1088 * @handle: unique object handle
1089 * @dev_name: array of device names
1090 * @data: rhashtable and garbage collector
1091 * @ops: array of hooks
1093 struct nft_flowtable {
1094 struct list_head list;
1095 struct nft_table *table;
1103 char *dev_name[NFT_FLOWTABLE_DEVICE_MAX];
1104 /* runtime data below here */
1105 struct nf_hook_ops *ops ____cacheline_aligned;
1106 struct nf_flowtable data;
1109 struct nft_flowtable *nf_tables_flowtable_lookup(const struct nft_table *table,
1110 const struct nlattr *nla,
1113 void nft_register_flowtable_type(struct nf_flowtable_type *type);
1114 void nft_unregister_flowtable_type(struct nf_flowtable_type *type);
1117 * struct nft_traceinfo - nft tracing information and state
1119 * @pkt: pktinfo currently processed
1120 * @basechain: base chain currently processed
1121 * @chain: chain currently processed
1122 * @rule: rule that was evaluated
1123 * @verdict: verdict given by rule
1124 * @type: event type (enum nft_trace_types)
1125 * @packet_dumped: packet headers sent in a previous traceinfo message
1126 * @trace: other struct members are initialised
1128 struct nft_traceinfo {
1129 const struct nft_pktinfo *pkt;
1130 const struct nft_base_chain *basechain;
1131 const struct nft_chain *chain;
1132 const struct nft_rule *rule;
1133 const struct nft_verdict *verdict;
1134 enum nft_trace_types type;
1139 void nft_trace_init(struct nft_traceinfo *info, const struct nft_pktinfo *pkt,
1140 const struct nft_verdict *verdict,
1141 const struct nft_chain *basechain);
1143 void nft_trace_notify(struct nft_traceinfo *info);
1145 #define MODULE_ALIAS_NFT_CHAIN(family, name) \
1146 MODULE_ALIAS("nft-chain-" __stringify(family) "-" name)
1148 #define MODULE_ALIAS_NFT_AF_EXPR(family, name) \
1149 MODULE_ALIAS("nft-expr-" __stringify(family) "-" name)
1151 #define MODULE_ALIAS_NFT_EXPR(name) \
1152 MODULE_ALIAS("nft-expr-" name)
1154 #define MODULE_ALIAS_NFT_SET() \
1155 MODULE_ALIAS("nft-set")
1157 #define MODULE_ALIAS_NFT_OBJ(type) \
1158 MODULE_ALIAS("nft-obj-" __stringify(type))
1161 * The gencursor defines two generations, the currently active and the
1162 * next one. Objects contain a bitmask of 2 bits specifying the generations
1163 * they're active in. A set bit means they're inactive in the generation
1164 * represented by that bit.
1166 * New objects start out as inactive in the current and active in the
1167 * next generation. When committing the ruleset the bitmask is cleared,
1168 * meaning they're active in all generations. When removing an object,
1169 * it is set inactive in the next generation. After committing the ruleset,
1170 * the objects are removed.
1172 static inline unsigned int nft_gencursor_next(const struct net *net)
1174 return net->nft.gencursor + 1 == 1 ? 1 : 0;
1177 static inline u8 nft_genmask_next(const struct net *net)
1179 return 1 << nft_gencursor_next(net);
1182 static inline u8 nft_genmask_cur(const struct net *net)
1184 /* Use READ_ONCE() to prevent refetching the value for atomicity */
1185 return 1 << READ_ONCE(net->nft.gencursor);
1188 #define NFT_GENMASK_ANY ((1 << 0) | (1 << 1))
1191 * Generic transaction helpers
1194 /* Check if this object is currently active. */
1195 #define nft_is_active(__net, __obj) \
1196 (((__obj)->genmask & nft_genmask_cur(__net)) == 0)
1198 /* Check if this object is active in the next generation. */
1199 #define nft_is_active_next(__net, __obj) \
1200 (((__obj)->genmask & nft_genmask_next(__net)) == 0)
1202 /* This object becomes active in the next generation. */
1203 #define nft_activate_next(__net, __obj) \
1204 (__obj)->genmask = nft_genmask_cur(__net)
1206 /* This object becomes inactive in the next generation. */
1207 #define nft_deactivate_next(__net, __obj) \
1208 (__obj)->genmask = nft_genmask_next(__net)
1210 /* After committing the ruleset, clear the stale generation bit. */
1211 #define nft_clear(__net, __obj) \
1212 (__obj)->genmask &= ~nft_genmask_next(__net)
1213 #define nft_active_genmask(__obj, __genmask) \
1214 !((__obj)->genmask & __genmask)
1217 * Set element transaction helpers
1220 static inline bool nft_set_elem_active(const struct nft_set_ext *ext,
1223 return !(ext->genmask & genmask);
1226 static inline void nft_set_elem_change_active(const struct net *net,
1227 const struct nft_set *set,
1228 struct nft_set_ext *ext)
1230 ext->genmask ^= nft_genmask_next(net);
1234 * We use a free bit in the genmask field to indicate the element
1235 * is busy, meaning it is currently being processed either by
1236 * the netlink API or GC.
1238 * Even though the genmask is only a single byte wide, this works
1239 * because the extension structure if fully constant once initialized,
1240 * so there are no non-atomic write accesses unless it is already
1243 #define NFT_SET_ELEM_BUSY_MASK (1 << 2)
1245 #if defined(__LITTLE_ENDIAN_BITFIELD)
1246 #define NFT_SET_ELEM_BUSY_BIT 2
1247 #elif defined(__BIG_ENDIAN_BITFIELD)
1248 #define NFT_SET_ELEM_BUSY_BIT (BITS_PER_LONG - BITS_PER_BYTE + 2)
1253 static inline int nft_set_elem_mark_busy(struct nft_set_ext *ext)
1255 unsigned long *word = (unsigned long *)ext;
1257 BUILD_BUG_ON(offsetof(struct nft_set_ext, genmask) != 0);
1258 return test_and_set_bit(NFT_SET_ELEM_BUSY_BIT, word);
1261 static inline void nft_set_elem_clear_busy(struct nft_set_ext *ext)
1263 unsigned long *word = (unsigned long *)ext;
1265 clear_bit(NFT_SET_ELEM_BUSY_BIT, word);
1269 * struct nft_trans - nf_tables object update in transaction
1271 * @list: used internally
1272 * @msg_type: message type
1273 * @ctx: transaction context
1274 * @data: internal information related to the transaction
1277 struct list_head list;
1283 struct nft_trans_rule {
1284 struct nft_rule *rule;
1288 #define nft_trans_rule(trans) \
1289 (((struct nft_trans_rule *)trans->data)->rule)
1290 #define nft_trans_rule_id(trans) \
1291 (((struct nft_trans_rule *)trans->data)->rule_id)
1293 struct nft_trans_set {
1294 struct nft_set *set;
1298 #define nft_trans_set(trans) \
1299 (((struct nft_trans_set *)trans->data)->set)
1300 #define nft_trans_set_id(trans) \
1301 (((struct nft_trans_set *)trans->data)->set_id)
1303 struct nft_trans_chain {
1306 struct nft_stats __percpu *stats;
1310 #define nft_trans_chain_update(trans) \
1311 (((struct nft_trans_chain *)trans->data)->update)
1312 #define nft_trans_chain_name(trans) \
1313 (((struct nft_trans_chain *)trans->data)->name)
1314 #define nft_trans_chain_stats(trans) \
1315 (((struct nft_trans_chain *)trans->data)->stats)
1316 #define nft_trans_chain_policy(trans) \
1317 (((struct nft_trans_chain *)trans->data)->policy)
1319 struct nft_trans_table {
1324 #define nft_trans_table_update(trans) \
1325 (((struct nft_trans_table *)trans->data)->update)
1326 #define nft_trans_table_enable(trans) \
1327 (((struct nft_trans_table *)trans->data)->enable)
1329 struct nft_trans_elem {
1330 struct nft_set *set;
1331 struct nft_set_elem elem;
1334 #define nft_trans_elem_set(trans) \
1335 (((struct nft_trans_elem *)trans->data)->set)
1336 #define nft_trans_elem(trans) \
1337 (((struct nft_trans_elem *)trans->data)->elem)
1339 struct nft_trans_obj {
1340 struct nft_object *obj;
1343 #define nft_trans_obj(trans) \
1344 (((struct nft_trans_obj *)trans->data)->obj)
1346 struct nft_trans_flowtable {
1347 struct nft_flowtable *flowtable;
1350 #define nft_trans_flowtable(trans) \
1351 (((struct nft_trans_flowtable *)trans->data)->flowtable)
1353 int __init nft_chain_filter_init(void);
1354 void __exit nft_chain_filter_fini(void);
1356 #endif /* _NET_NF_TABLES_H */