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/netlink.h>
14 #define NFT_JUMP_STACK_SIZE 16
20 /* for x_tables compatibility */
21 struct xt_action_param xt
;
24 static inline struct net
*nft_net(const struct nft_pktinfo
*pkt
)
26 return pkt
->xt
.state
->net
;
29 static inline unsigned int nft_hook(const struct nft_pktinfo
*pkt
)
31 return pkt
->xt
.state
->hook
;
34 static inline u8
nft_pf(const struct nft_pktinfo
*pkt
)
36 return pkt
->xt
.state
->pf
;
39 static inline const struct net_device
*nft_in(const struct nft_pktinfo
*pkt
)
41 return pkt
->xt
.state
->in
;
44 static inline const struct net_device
*nft_out(const struct nft_pktinfo
*pkt
)
46 return pkt
->xt
.state
->out
;
49 static inline void nft_set_pktinfo(struct nft_pktinfo
*pkt
,
51 const struct nf_hook_state
*state
)
54 pkt
->xt
.state
= state
;
57 static inline void nft_set_pktinfo_proto_unspec(struct nft_pktinfo
*pkt
,
60 pkt
->tprot_set
= false;
66 static inline void nft_set_pktinfo_unspec(struct nft_pktinfo
*pkt
,
68 const struct nf_hook_state
*state
)
70 nft_set_pktinfo(pkt
, skb
, state
);
71 nft_set_pktinfo_proto_unspec(pkt
, skb
);
75 * struct nft_verdict - nf_tables verdict
77 * @code: nf_tables/netfilter verdict code
78 * @chain: destination chain for NFT_JUMP/NFT_GOTO
82 struct nft_chain
*chain
;
88 struct nft_verdict verdict
;
90 } __attribute__((aligned(__alignof__(u64
))));
93 * struct nft_regs - nf_tables register set
95 * @data: data registers
96 * @verdict: verdict register
98 * The first four data registers alias to the verdict register.
103 struct nft_verdict verdict
;
107 /* Store/load an u16 or u8 integer to/from the u32 data register.
109 * Note, when using concatenations, register allocation happens at 32-bit
110 * level. So for store instruction, pad the rest part with zero to avoid
114 static inline void nft_reg_store16(u32
*dreg
, u16 val
)
120 static inline void nft_reg_store8(u32
*dreg
, u8 val
)
126 static inline u16
nft_reg_load16(u32
*sreg
)
131 static inline u8
nft_reg_load8(u32
*sreg
)
136 static inline void nft_data_copy(u32
*dst
, const struct nft_data
*src
,
139 memcpy(dst
, src
, len
);
142 static inline void nft_data_debug(const struct nft_data
*data
)
144 pr_debug("data[0]=%x data[1]=%x data[2]=%x data[3]=%x\n",
145 data
->data
[0], data
->data
[1],
146 data
->data
[2], data
->data
[3]);
150 * struct nft_ctx - nf_tables rule/set context
152 * @net: net namespace
153 * @afi: address family info
154 * @table: the table the chain is contained in
155 * @chain: the chain the rule is contained in
156 * @nla: netlink attributes
157 * @portid: netlink portID of the original message
158 * @seq: netlink sequence number
159 * @report: notify via unicast netlink message
163 struct nft_af_info
*afi
;
164 struct nft_table
*table
;
165 struct nft_chain
*chain
;
166 const struct nlattr
* const *nla
;
172 struct nft_data_desc
{
173 enum nft_data_types type
;
177 int nft_data_init(const struct nft_ctx
*ctx
,
178 struct nft_data
*data
, unsigned int size
,
179 struct nft_data_desc
*desc
, const struct nlattr
*nla
);
180 void nft_data_release(const struct nft_data
*data
, enum nft_data_types type
);
181 int nft_data_dump(struct sk_buff
*skb
, int attr
, const struct nft_data
*data
,
182 enum nft_data_types type
, unsigned int len
);
184 static inline enum nft_data_types
nft_dreg_to_type(enum nft_registers reg
)
186 return reg
== NFT_REG_VERDICT
? NFT_DATA_VERDICT
: NFT_DATA_VALUE
;
189 static inline enum nft_registers
nft_type_to_reg(enum nft_data_types type
)
191 return type
== NFT_DATA_VERDICT
? NFT_REG_VERDICT
: NFT_REG_1
* NFT_REG_SIZE
/ NFT_REG32_SIZE
;
194 int nft_parse_u32_check(const struct nlattr
*attr
, int max
, u32
*dest
);
195 unsigned int nft_parse_register(const struct nlattr
*attr
);
196 int nft_dump_register(struct sk_buff
*skb
, unsigned int attr
, unsigned int reg
);
198 int nft_validate_register_load(enum nft_registers reg
, unsigned int len
);
199 int nft_validate_register_store(const struct nft_ctx
*ctx
,
200 enum nft_registers reg
,
201 const struct nft_data
*data
,
202 enum nft_data_types type
, unsigned int len
);
205 * struct nft_userdata - user defined data associated with an object
207 * @len: length of the data
210 * The presence of user data is indicated in an object specific fashion,
211 * so a length of zero can't occur and the value "len" indicates data
214 struct nft_userdata
{
216 unsigned char data
[0];
220 * struct nft_set_elem - generic representation of set elements
223 * @priv: element private data and extensions
225 struct nft_set_elem
{
227 u32 buf
[NFT_DATA_VALUE_MAXLEN
/ sizeof(u32
)];
234 struct nft_set_iter
{
239 int (*fn
)(const struct nft_ctx
*ctx
,
241 const struct nft_set_iter
*iter
,
242 struct nft_set_elem
*elem
);
246 * struct nft_set_desc - description of set elements
250 * @size: number of set elements
252 struct nft_set_desc
{
259 * enum nft_set_class - performance class
261 * @NFT_LOOKUP_O_1: constant, O(1)
262 * @NFT_LOOKUP_O_LOG_N: logarithmic, O(log N)
263 * @NFT_LOOKUP_O_N: linear, O(N)
267 NFT_SET_CLASS_O_LOG_N
,
272 * struct nft_set_estimate - estimation of memory and performance
275 * @size: required memory
276 * @lookup: lookup performance class
277 * @space: memory class
279 struct nft_set_estimate
{
281 enum nft_set_class lookup
;
282 enum nft_set_class space
;
286 * struct nft_set_type - nf_tables set type
288 * @select_ops: function to select nft_set_ops
289 * @ops: default ops, used when no select_ops functions is present
290 * @list: used internally
291 * @owner: module reference
293 struct nft_set_type
{
294 const struct nft_set_ops
*(*select_ops
)(const struct nft_ctx
*,
295 const struct nft_set_desc
*desc
,
297 const struct nft_set_ops
*ops
;
298 struct list_head list
;
299 struct module
*owner
;
306 * struct nft_set_ops - nf_tables set operations
308 * @lookup: look up an element within the set
309 * @insert: insert new element into set
310 * @activate: activate new element in the next generation
311 * @deactivate: lookup for element and deactivate it in the next generation
312 * @flush: deactivate element in the next generation
313 * @remove: remove element from set
314 * @walk: iterate over all set elemeennts
315 * @get: get set elements
316 * @privsize: function to return size of set private data
317 * @init: initialize private data of new set instance
318 * @destroy: destroy private data of set instance
319 * @elemsize: element private size
320 * @features: features supported by the implementation
323 bool (*lookup
)(const struct net
*net
,
324 const struct nft_set
*set
,
326 const struct nft_set_ext
**ext
);
327 bool (*update
)(struct nft_set
*set
,
329 void *(*new)(struct nft_set
*,
330 const struct nft_expr
*,
332 const struct nft_expr
*expr
,
333 struct nft_regs
*regs
,
334 const struct nft_set_ext
**ext
);
336 int (*insert
)(const struct net
*net
,
337 const struct nft_set
*set
,
338 const struct nft_set_elem
*elem
,
339 struct nft_set_ext
**ext
);
340 void (*activate
)(const struct net
*net
,
341 const struct nft_set
*set
,
342 const struct nft_set_elem
*elem
);
343 void * (*deactivate
)(const struct net
*net
,
344 const struct nft_set
*set
,
345 const struct nft_set_elem
*elem
);
346 bool (*flush
)(const struct net
*net
,
347 const struct nft_set
*set
,
349 void (*remove
)(const struct net
*net
,
350 const struct nft_set
*set
,
351 const struct nft_set_elem
*elem
);
352 void (*walk
)(const struct nft_ctx
*ctx
,
354 struct nft_set_iter
*iter
);
355 void * (*get
)(const struct net
*net
,
356 const struct nft_set
*set
,
357 const struct nft_set_elem
*elem
,
360 unsigned int (*privsize
)(const struct nlattr
* const nla
[],
361 const struct nft_set_desc
*desc
);
362 bool (*estimate
)(const struct nft_set_desc
*desc
,
364 struct nft_set_estimate
*est
);
365 int (*init
)(const struct nft_set
*set
,
366 const struct nft_set_desc
*desc
,
367 const struct nlattr
* const nla
[]);
368 void (*destroy
)(const struct nft_set
*set
);
370 unsigned int elemsize
;
372 const struct nft_set_type
*type
;
375 int nft_register_set(struct nft_set_type
*type
);
376 void nft_unregister_set(struct nft_set_type
*type
);
379 * struct nft_set - nf_tables set instance
381 * @list: table set list node
382 * @bindings: list of set bindings
383 * @name: name of the set
384 * @ktype: key type (numeric type defined by userspace, not used in the kernel)
385 * @dtype: data type (verdict or numeric type defined by userspace)
386 * @objtype: object type (see NFT_OBJECT_* definitions)
387 * @size: maximum set size
388 * @nelems: number of elements
389 * @ndeact: number of deactivated elements queued for removal
390 * @timeout: default timeout value in jiffies
391 * @gc_int: garbage collection interval in msecs
392 * @policy: set parameterization (see enum nft_set_policies)
393 * @udlen: user data length
397 * @genmask: generation mask
400 * @data: private set data
403 struct list_head list
;
404 struct list_head bindings
;
416 unsigned char *udata
;
417 /* runtime data below here */
418 const struct nft_set_ops
*ops ____cacheline_aligned
;
424 __attribute__((aligned(__alignof__(u64
))));
427 static inline 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(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_type
{
872 NFT_CHAIN_T_DEFAULT
= 0,
879 * struct nf_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: hookfn overrides
888 struct nf_chain_type
{
890 enum nft_chain_type type
;
892 struct module
*owner
;
893 unsigned int hook_mask
;
894 nf_hookfn
*hooks
[NF_MAX_HOOKS
];
897 int nft_chain_validate_dependency(const struct nft_chain
*chain
,
898 enum nft_chain_type type
);
899 int nft_chain_validate_hooks(const struct nft_chain
*chain
,
900 unsigned int hook_flags
);
905 struct u64_stats_sync syncp
;
908 #define NFT_HOOK_OPS_MAX 2
911 * struct nft_base_chain - nf_tables base chain
913 * @ops: netfilter hook ops
915 * @policy: default policy
916 * @stats: per-cpu chain stats
918 * @dev_name: device name that this base chain is attached to (if any)
920 struct nft_base_chain
{
921 struct nf_hook_ops ops
[NFT_HOOK_OPS_MAX
];
922 const struct nf_chain_type
*type
;
925 struct nft_stats __percpu
*stats
;
926 struct nft_chain chain
;
927 char dev_name
[IFNAMSIZ
];
930 static inline struct nft_base_chain
*nft_base_chain(const struct nft_chain
*chain
)
932 return container_of(chain
, struct nft_base_chain
, chain
);
935 static inline bool nft_is_base_chain(const struct nft_chain
*chain
)
937 return chain
->flags
& NFT_BASE_CHAIN
;
940 int __nft_release_basechain(struct nft_ctx
*ctx
);
942 unsigned int nft_do_chain(struct nft_pktinfo
*pkt
, void *priv
);
945 * struct nft_table - nf_tables table
947 * @list: used internally
948 * @chains: chains in the table
949 * @sets: sets in the table
950 * @objects: stateful objects in the table
951 * @hgenerator: handle generator state
952 * @use: number of chain references to this table
953 * @flags: table flag (see enum nft_table_flags)
954 * @genmask: generation mask
955 * @name: name of the table
958 struct list_head list
;
959 struct list_head chains
;
960 struct list_head sets
;
961 struct list_head objects
;
970 NFT_AF_NEEDS_DEV
= (1 << 0),
974 * struct nft_af_info - nf_tables address family info
976 * @list: used internally
977 * @family: address family
978 * @nhooks: number of hooks in this family
979 * @owner: module owner
980 * @tables: used internally
981 * @flags: family flags
982 * @nops: number of hook ops in this family
983 * @hook_ops_init: initialization function for chain hook ops
984 * @hooks: hookfn overrides for packet validation
987 struct list_head list
;
990 struct module
*owner
;
991 struct list_head tables
;
994 void (*hook_ops_init
)(struct nf_hook_ops
*,
996 nf_hookfn
*hooks
[NF_MAX_HOOKS
];
999 int nft_register_afinfo(struct net
*, struct nft_af_info
*);
1000 void nft_unregister_afinfo(struct net
*, struct nft_af_info
*);
1002 int nft_register_chain_type(const struct nf_chain_type
*);
1003 void nft_unregister_chain_type(const struct nf_chain_type
*);
1005 int nft_register_expr(struct nft_expr_type
*);
1006 void nft_unregister_expr(struct nft_expr_type
*);
1008 int nft_verdict_dump(struct sk_buff
*skb
, int type
,
1009 const struct nft_verdict
*v
);
1012 * struct nft_object - nf_tables stateful object
1014 * @list: table stateful object list node
1015 * @table: table this object belongs to
1016 * @name: name of this stateful object
1017 * @genmask: generation mask
1018 * @use: number of references to this stateful object
1019 * @data: object data, layout depends on type
1020 * @ops: object operations
1021 * @data: pointer to object data
1024 struct list_head list
;
1026 struct nft_table
*table
;
1029 /* runtime data below here */
1030 const struct nft_object_ops
*ops ____cacheline_aligned
;
1031 unsigned char data
[]
1032 __attribute__((aligned(__alignof__(u64
))));
1035 static inline void *nft_obj_data(const struct nft_object
*obj
)
1037 return (void *)obj
->data
;
1040 #define nft_expr_obj(expr) *((struct nft_object **)nft_expr_priv(expr))
1042 struct nft_object
*nf_tables_obj_lookup(const struct nft_table
*table
,
1043 const struct nlattr
*nla
, u32 objtype
,
1046 void nft_obj_notify(struct net
*net
, struct nft_table
*table
,
1047 struct nft_object
*obj
, u32 portid
, u32 seq
,
1048 int event
, int family
, int report
, gfp_t gfp
);
1051 * struct nft_object_type - stateful object type
1053 * @select_ops: function to select nft_object_ops
1054 * @ops: default ops, used when no select_ops functions is present
1055 * @list: list node in list of object types
1056 * @type: stateful object numeric type
1057 * @owner: module owner
1058 * @maxattr: maximum netlink attribute
1059 * @policy: netlink attribute policy
1061 struct nft_object_type
{
1062 const struct nft_object_ops
*(*select_ops
)(const struct nft_ctx
*,
1063 const struct nlattr
* const tb
[]);
1064 const struct nft_object_ops
*ops
;
1065 struct list_head list
;
1067 unsigned int maxattr
;
1068 struct module
*owner
;
1069 const struct nla_policy
*policy
;
1073 * struct nft_object_ops - stateful object operations
1075 * @eval: stateful object evaluation function
1076 * @size: stateful object size
1077 * @init: initialize object from netlink attributes
1078 * @destroy: release existing stateful object
1079 * @dump: netlink dump stateful object
1081 struct nft_object_ops
{
1082 void (*eval
)(struct nft_object
*obj
,
1083 struct nft_regs
*regs
,
1084 const struct nft_pktinfo
*pkt
);
1086 int (*init
)(const struct nft_ctx
*ctx
,
1087 const struct nlattr
*const tb
[],
1088 struct nft_object
*obj
);
1089 void (*destroy
)(struct nft_object
*obj
);
1090 int (*dump
)(struct sk_buff
*skb
,
1091 struct nft_object
*obj
,
1093 const struct nft_object_type
*type
;
1096 int nft_register_obj(struct nft_object_type
*obj_type
);
1097 void nft_unregister_obj(struct nft_object_type
*obj_type
);
1100 * struct nft_traceinfo - nft tracing information and state
1102 * @pkt: pktinfo currently processed
1103 * @basechain: base chain currently processed
1104 * @chain: chain currently processed
1105 * @rule: rule that was evaluated
1106 * @verdict: verdict given by rule
1107 * @type: event type (enum nft_trace_types)
1108 * @packet_dumped: packet headers sent in a previous traceinfo message
1109 * @trace: other struct members are initialised
1111 struct nft_traceinfo
{
1112 const struct nft_pktinfo
*pkt
;
1113 const struct nft_base_chain
*basechain
;
1114 const struct nft_chain
*chain
;
1115 const struct nft_rule
*rule
;
1116 const struct nft_verdict
*verdict
;
1117 enum nft_trace_types type
;
1122 void nft_trace_init(struct nft_traceinfo
*info
, const struct nft_pktinfo
*pkt
,
1123 const struct nft_verdict
*verdict
,
1124 const struct nft_chain
*basechain
);
1126 void nft_trace_notify(struct nft_traceinfo
*info
);
1128 #define nft_dereference(p) \
1129 nfnl_dereference(p, NFNL_SUBSYS_NFTABLES)
1131 #define MODULE_ALIAS_NFT_FAMILY(family) \
1132 MODULE_ALIAS("nft-afinfo-" __stringify(family))
1134 #define MODULE_ALIAS_NFT_CHAIN(family, name) \
1135 MODULE_ALIAS("nft-chain-" __stringify(family) "-" name)
1137 #define MODULE_ALIAS_NFT_AF_EXPR(family, name) \
1138 MODULE_ALIAS("nft-expr-" __stringify(family) "-" name)
1140 #define MODULE_ALIAS_NFT_EXPR(name) \
1141 MODULE_ALIAS("nft-expr-" name)
1143 #define MODULE_ALIAS_NFT_SET() \
1144 MODULE_ALIAS("nft-set")
1146 #define MODULE_ALIAS_NFT_OBJ(type) \
1147 MODULE_ALIAS("nft-obj-" __stringify(type))
1150 * The gencursor defines two generations, the currently active and the
1151 * next one. Objects contain a bitmask of 2 bits specifying the generations
1152 * they're active in. A set bit means they're inactive in the generation
1153 * represented by that bit.
1155 * New objects start out as inactive in the current and active in the
1156 * next generation. When committing the ruleset the bitmask is cleared,
1157 * meaning they're active in all generations. When removing an object,
1158 * it is set inactive in the next generation. After committing the ruleset,
1159 * the objects are removed.
1161 static inline unsigned int nft_gencursor_next(const struct net
*net
)
1163 return net
->nft
.gencursor
+ 1 == 1 ? 1 : 0;
1166 static inline u8
nft_genmask_next(const struct net
*net
)
1168 return 1 << nft_gencursor_next(net
);
1171 static inline u8
nft_genmask_cur(const struct net
*net
)
1173 /* Use READ_ONCE() to prevent refetching the value for atomicity */
1174 return 1 << READ_ONCE(net
->nft
.gencursor
);
1177 #define NFT_GENMASK_ANY ((1 << 0) | (1 << 1))
1180 * Generic transaction helpers
1183 /* Check if this object is currently active. */
1184 #define nft_is_active(__net, __obj) \
1185 (((__obj)->genmask & nft_genmask_cur(__net)) == 0)
1187 /* Check if this object is active in the next generation. */
1188 #define nft_is_active_next(__net, __obj) \
1189 (((__obj)->genmask & nft_genmask_next(__net)) == 0)
1191 /* This object becomes active in the next generation. */
1192 #define nft_activate_next(__net, __obj) \
1193 (__obj)->genmask = nft_genmask_cur(__net)
1195 /* This object becomes inactive in the next generation. */
1196 #define nft_deactivate_next(__net, __obj) \
1197 (__obj)->genmask = nft_genmask_next(__net)
1199 /* After committing the ruleset, clear the stale generation bit. */
1200 #define nft_clear(__net, __obj) \
1201 (__obj)->genmask &= ~nft_genmask_next(__net)
1202 #define nft_active_genmask(__obj, __genmask) \
1203 !((__obj)->genmask & __genmask)
1206 * Set element transaction helpers
1209 static inline bool nft_set_elem_active(const struct nft_set_ext
*ext
,
1212 return !(ext
->genmask
& genmask
);
1215 static inline void nft_set_elem_change_active(const struct net
*net
,
1216 const struct nft_set
*set
,
1217 struct nft_set_ext
*ext
)
1219 ext
->genmask
^= nft_genmask_next(net
);
1223 * We use a free bit in the genmask field to indicate the element
1224 * is busy, meaning it is currently being processed either by
1225 * the netlink API or GC.
1227 * Even though the genmask is only a single byte wide, this works
1228 * because the extension structure if fully constant once initialized,
1229 * so there are no non-atomic write accesses unless it is already
1232 #define NFT_SET_ELEM_BUSY_MASK (1 << 2)
1234 #if defined(__LITTLE_ENDIAN_BITFIELD)
1235 #define NFT_SET_ELEM_BUSY_BIT 2
1236 #elif defined(__BIG_ENDIAN_BITFIELD)
1237 #define NFT_SET_ELEM_BUSY_BIT (BITS_PER_LONG - BITS_PER_BYTE + 2)
1242 static inline int nft_set_elem_mark_busy(struct nft_set_ext
*ext
)
1244 unsigned long *word
= (unsigned long *)ext
;
1246 BUILD_BUG_ON(offsetof(struct nft_set_ext
, genmask
) != 0);
1247 return test_and_set_bit(NFT_SET_ELEM_BUSY_BIT
, word
);
1250 static inline void nft_set_elem_clear_busy(struct nft_set_ext
*ext
)
1252 unsigned long *word
= (unsigned long *)ext
;
1254 clear_bit(NFT_SET_ELEM_BUSY_BIT
, word
);
1258 * struct nft_trans - nf_tables object update in transaction
1260 * @list: used internally
1261 * @msg_type: message type
1262 * @ctx: transaction context
1263 * @data: internal information related to the transaction
1266 struct list_head list
;
1272 struct nft_trans_rule
{
1273 struct nft_rule
*rule
;
1277 #define nft_trans_rule(trans) \
1278 (((struct nft_trans_rule *)trans->data)->rule)
1279 #define nft_trans_rule_id(trans) \
1280 (((struct nft_trans_rule *)trans->data)->rule_id)
1282 struct nft_trans_set
{
1283 struct nft_set
*set
;
1287 #define nft_trans_set(trans) \
1288 (((struct nft_trans_set *)trans->data)->set)
1289 #define nft_trans_set_id(trans) \
1290 (((struct nft_trans_set *)trans->data)->set_id)
1292 struct nft_trans_chain
{
1295 struct nft_stats __percpu
*stats
;
1299 #define nft_trans_chain_update(trans) \
1300 (((struct nft_trans_chain *)trans->data)->update)
1301 #define nft_trans_chain_name(trans) \
1302 (((struct nft_trans_chain *)trans->data)->name)
1303 #define nft_trans_chain_stats(trans) \
1304 (((struct nft_trans_chain *)trans->data)->stats)
1305 #define nft_trans_chain_policy(trans) \
1306 (((struct nft_trans_chain *)trans->data)->policy)
1308 struct nft_trans_table
{
1313 #define nft_trans_table_update(trans) \
1314 (((struct nft_trans_table *)trans->data)->update)
1315 #define nft_trans_table_enable(trans) \
1316 (((struct nft_trans_table *)trans->data)->enable)
1318 struct nft_trans_elem
{
1319 struct nft_set
*set
;
1320 struct nft_set_elem elem
;
1323 #define nft_trans_elem_set(trans) \
1324 (((struct nft_trans_elem *)trans->data)->set)
1325 #define nft_trans_elem(trans) \
1326 (((struct nft_trans_elem *)trans->data)->elem)
1328 struct nft_trans_obj
{
1329 struct nft_object
*obj
;
1332 #define nft_trans_obj(trans) \
1333 (((struct nft_trans_obj *)trans->data)->obj)
1335 #endif /* _NET_NF_TABLES_H */