1 #ifndef _NET_NF_TABLES_H
2 #define _NET_NF_TABLES_H
4 #include <linux/list.h>
5 #include <linux/netfilter.h>
6 #include <linux/netfilter/nfnetlink.h>
7 #include <linux/netfilter/x_tables.h>
8 #include <linux/netfilter/nf_tables.h>
9 #include <linux/u64_stats_sync.h>
10 #include <net/netlink.h>
12 #define NFT_JUMP_STACK_SIZE 16
16 const struct net_device *in;
17 const struct net_device *out;
18 const struct nf_hook_ops *ops;
22 /* for x_tables compatibility */
23 struct xt_action_param xt;
26 static inline void nft_set_pktinfo(struct nft_pktinfo *pkt,
27 const struct nf_hook_ops *ops,
29 const struct net_device *in,
30 const struct net_device *out)
33 pkt->in = pkt->xt.in = in;
34 pkt->out = pkt->xt.out = out;
36 pkt->xt.hooknum = ops->hooknum;
37 pkt->xt.family = ops->pf;
45 struct nft_chain *chain;
48 } __attribute__((aligned(__alignof__(u64))));
50 static inline int nft_data_cmp(const struct nft_data *d1,
51 const struct nft_data *d2,
54 return memcmp(d1->data, d2->data, len);
57 static inline void nft_data_copy(struct nft_data *dst,
58 const struct nft_data *src)
60 BUILD_BUG_ON(__alignof__(*dst) != __alignof__(u64));
61 *(u64 *)&dst->data[0] = *(u64 *)&src->data[0];
62 *(u64 *)&dst->data[2] = *(u64 *)&src->data[2];
65 static inline void nft_data_debug(const struct nft_data *data)
67 pr_debug("data[0]=%x data[1]=%x data[2]=%x data[3]=%x\n",
68 data->data[0], data->data[1],
69 data->data[2], data->data[3]);
73 * struct nft_ctx - nf_tables rule/set context
76 * @afi: address family info
77 * @table: the table the chain is contained in
78 * @chain: the chain the rule is contained in
79 * @nla: netlink attributes
80 * @portid: netlink portID of the original message
81 * @seq: netlink sequence number
82 * @report: notify via unicast netlink message
86 struct nft_af_info *afi;
87 struct nft_table *table;
88 struct nft_chain *chain;
89 const struct nlattr * const *nla;
95 struct nft_data_desc {
96 enum nft_data_types type;
100 int nft_data_init(const struct nft_ctx *ctx, struct nft_data *data,
101 struct nft_data_desc *desc, const struct nlattr *nla);
102 void nft_data_uninit(const struct nft_data *data, enum nft_data_types type);
103 int nft_data_dump(struct sk_buff *skb, int attr, const struct nft_data *data,
104 enum nft_data_types type, unsigned int len);
106 static inline enum nft_data_types nft_dreg_to_type(enum nft_registers reg)
108 return reg == NFT_REG_VERDICT ? NFT_DATA_VERDICT : NFT_DATA_VALUE;
111 static inline enum nft_registers nft_type_to_reg(enum nft_data_types type)
113 return type == NFT_DATA_VERDICT ? NFT_REG_VERDICT : NFT_REG_1;
116 int nft_validate_input_register(enum nft_registers reg);
117 int nft_validate_output_register(enum nft_registers reg);
118 int nft_validate_data_load(const struct nft_ctx *ctx, enum nft_registers reg,
119 const struct nft_data *data,
120 enum nft_data_types type);
123 * struct nft_set_elem - generic representation of set elements
125 * @cookie: implementation specific element cookie
127 * @data: element data (maps only)
128 * @flags: element flags (end of interval)
130 * The cookie can be used to store a handle to the element for subsequent
133 struct nft_set_elem {
136 struct nft_data data;
141 struct nft_set_iter {
145 int (*fn)(const struct nft_ctx *ctx,
146 const struct nft_set *set,
147 const struct nft_set_iter *iter,
148 const struct nft_set_elem *elem);
152 * struct nft_set_desc - description of set elements
156 * @size: number of set elements
158 struct nft_set_desc {
165 * enum nft_set_class - performance class
167 * @NFT_LOOKUP_O_1: constant, O(1)
168 * @NFT_LOOKUP_O_LOG_N: logarithmic, O(log N)
169 * @NFT_LOOKUP_O_N: linear, O(N)
173 NFT_SET_CLASS_O_LOG_N,
178 * struct nft_set_estimate - estimation of memory and performance
181 * @size: required memory
182 * @class: lookup performance class
184 struct nft_set_estimate {
186 enum nft_set_class class;
190 * struct nft_set_ops - nf_tables set operations
192 * @lookup: look up an element within the set
193 * @insert: insert new element into set
194 * @remove: remove element from set
195 * @walk: iterate over all set elemeennts
196 * @privsize: function to return size of set private data
197 * @init: initialize private data of new set instance
198 * @destroy: destroy private data of set instance
199 * @list: nf_tables_set_ops list node
200 * @owner: module reference
201 * @features: features supported by the implementation
204 bool (*lookup)(const struct nft_set *set,
205 const struct nft_data *key,
206 struct nft_data *data);
207 int (*get)(const struct nft_set *set,
208 struct nft_set_elem *elem);
209 int (*insert)(const struct nft_set *set,
210 const struct nft_set_elem *elem);
211 void (*remove)(const struct nft_set *set,
212 const struct nft_set_elem *elem);
213 void (*walk)(const struct nft_ctx *ctx,
214 const struct nft_set *set,
215 struct nft_set_iter *iter);
217 unsigned int (*privsize)(const struct nlattr * const nla[]);
218 bool (*estimate)(const struct nft_set_desc *desc,
220 struct nft_set_estimate *est);
221 int (*init)(const struct nft_set *set,
222 const struct nft_set_desc *desc,
223 const struct nlattr * const nla[]);
224 void (*destroy)(const struct nft_set *set);
226 struct list_head list;
227 struct module *owner;
231 int nft_register_set(struct nft_set_ops *ops);
232 void nft_unregister_set(struct nft_set_ops *ops);
235 * struct nft_set - nf_tables set instance
237 * @list: table set list node
238 * @bindings: list of set bindings
239 * @name: name of the set
240 * @ktype: key type (numeric type defined by userspace, not used in the kernel)
241 * @dtype: data type (verdict or numeric type defined by userspace)
242 * @size: maximum set size
243 * @nelems: number of elements
244 * @policy: set parameterization (see enum nft_set_policies)
249 * @data: private set data
252 struct list_head list;
253 struct list_head bindings;
260 /* runtime data below here */
261 const struct nft_set_ops *ops ____cacheline_aligned;
266 __attribute__((aligned(__alignof__(u64))));
269 static inline void *nft_set_priv(const struct nft_set *set)
271 return (void *)set->data;
274 struct nft_set *nf_tables_set_lookup(const struct nft_table *table,
275 const struct nlattr *nla);
276 struct nft_set *nf_tables_set_lookup_byid(const struct net *net,
277 const struct nlattr *nla);
280 * struct nft_set_binding - nf_tables set binding
282 * @list: set bindings list node
283 * @chain: chain containing the rule bound to the set
285 * A set binding contains all information necessary for validation
286 * of new elements added to a bound set.
288 struct nft_set_binding {
289 struct list_head list;
290 const struct nft_chain *chain;
293 int nf_tables_bind_set(const struct nft_ctx *ctx, struct nft_set *set,
294 struct nft_set_binding *binding);
295 void nf_tables_unbind_set(const struct nft_ctx *ctx, struct nft_set *set,
296 struct nft_set_binding *binding);
300 * struct nft_expr_type - nf_tables expression type
302 * @select_ops: function to select nft_expr_ops
303 * @ops: default ops, used when no select_ops functions is present
304 * @list: used internally
306 * @owner: module reference
307 * @policy: netlink attribute policy
308 * @maxattr: highest netlink attribute number
309 * @family: address family for AF-specific types
311 struct nft_expr_type {
312 const struct nft_expr_ops *(*select_ops)(const struct nft_ctx *,
313 const struct nlattr * const tb[]);
314 const struct nft_expr_ops *ops;
315 struct list_head list;
317 struct module *owner;
318 const struct nla_policy *policy;
319 unsigned int maxattr;
324 * struct nft_expr_ops - nf_tables expression operations
326 * @eval: Expression evaluation function
327 * @size: full expression size, including private data size
328 * @init: initialization function
329 * @destroy: destruction function
330 * @dump: function to dump parameters
331 * @type: expression type
332 * @validate: validate expression, called during loop detection
333 * @data: extra data to attach to this expression operation
336 struct nft_expr_ops {
337 void (*eval)(const struct nft_expr *expr,
338 struct nft_data data[NFT_REG_MAX + 1],
339 const struct nft_pktinfo *pkt);
342 int (*init)(const struct nft_ctx *ctx,
343 const struct nft_expr *expr,
344 const struct nlattr * const tb[]);
345 void (*destroy)(const struct nft_ctx *ctx,
346 const struct nft_expr *expr);
347 int (*dump)(struct sk_buff *skb,
348 const struct nft_expr *expr);
349 int (*validate)(const struct nft_ctx *ctx,
350 const struct nft_expr *expr,
351 const struct nft_data **data);
352 const struct nft_expr_type *type;
356 #define NFT_EXPR_MAXATTR 16
357 #define NFT_EXPR_SIZE(size) (sizeof(struct nft_expr) + \
358 ALIGN(size, __alignof__(struct nft_expr)))
361 * struct nft_expr - nf_tables expression
363 * @ops: expression ops
364 * @data: expression private data
367 const struct nft_expr_ops *ops;
368 unsigned char data[];
371 static inline void *nft_expr_priv(const struct nft_expr *expr)
373 return (void *)expr->data;
377 * struct nft_rule - nf_tables rule
379 * @list: used internally
380 * @handle: rule handle
381 * @genmask: generation mask
382 * @dlen: length of expression data
383 * @ulen: length of user data (used for comments)
384 * @data: expression data
387 struct list_head list;
393 __attribute__((aligned(__alignof__(struct nft_expr))));
397 * struct nft_trans - nf_tables object update in transaction
399 * @rcu_head: rcu head to defer release of transaction data
400 * @list: used internally
401 * @msg_type: message type
402 * @ctx: transaction context
403 * @data: internal information related to the transaction
406 struct rcu_head rcu_head;
407 struct list_head list;
413 struct nft_trans_rule {
414 struct nft_rule *rule;
417 #define nft_trans_rule(trans) \
418 (((struct nft_trans_rule *)trans->data)->rule)
420 struct nft_trans_set {
425 #define nft_trans_set(trans) \
426 (((struct nft_trans_set *)trans->data)->set)
427 #define nft_trans_set_id(trans) \
428 (((struct nft_trans_set *)trans->data)->set_id)
430 struct nft_trans_chain {
432 char name[NFT_CHAIN_MAXNAMELEN];
433 struct nft_stats __percpu *stats;
437 #define nft_trans_chain_update(trans) \
438 (((struct nft_trans_chain *)trans->data)->update)
439 #define nft_trans_chain_name(trans) \
440 (((struct nft_trans_chain *)trans->data)->name)
441 #define nft_trans_chain_stats(trans) \
442 (((struct nft_trans_chain *)trans->data)->stats)
443 #define nft_trans_chain_policy(trans) \
444 (((struct nft_trans_chain *)trans->data)->policy)
446 struct nft_trans_table {
451 #define nft_trans_table_update(trans) \
452 (((struct nft_trans_table *)trans->data)->update)
453 #define nft_trans_table_enable(trans) \
454 (((struct nft_trans_table *)trans->data)->enable)
456 struct nft_trans_elem {
458 struct nft_set_elem elem;
461 #define nft_trans_elem_set(trans) \
462 (((struct nft_trans_elem *)trans->data)->set)
463 #define nft_trans_elem(trans) \
464 (((struct nft_trans_elem *)trans->data)->elem)
466 static inline struct nft_expr *nft_expr_first(const struct nft_rule *rule)
468 return (struct nft_expr *)&rule->data[0];
471 static inline struct nft_expr *nft_expr_next(const struct nft_expr *expr)
473 return ((void *)expr) + expr->ops->size;
476 static inline struct nft_expr *nft_expr_last(const struct nft_rule *rule)
478 return (struct nft_expr *)&rule->data[rule->dlen];
481 static inline void *nft_userdata(const struct nft_rule *rule)
483 return (void *)&rule->data[rule->dlen];
487 * The last pointer isn't really necessary, but the compiler isn't able to
488 * determine that the result of nft_expr_last() is always the same since it
489 * can't assume that the dlen value wasn't changed within calls in the loop.
491 #define nft_rule_for_each_expr(expr, last, rule) \
492 for ((expr) = nft_expr_first(rule), (last) = nft_expr_last(rule); \
494 (expr) = nft_expr_next(expr))
496 enum nft_chain_flags {
497 NFT_BASE_CHAIN = 0x1,
498 NFT_CHAIN_INACTIVE = 0x2,
502 * struct nft_chain - nf_tables chain
504 * @rules: list of rules in the chain
505 * @list: used internally
506 * @net: net namespace that this chain belongs to
507 * @table: table that this chain belongs to
508 * @handle: chain handle
509 * @use: number of jump references to this chain
510 * @level: length of longest path to this chain
511 * @flags: bitmask of enum nft_chain_flags
512 * @name: name of the chain
515 struct list_head rules;
516 struct list_head list;
518 struct nft_table *table;
523 char name[NFT_CHAIN_MAXNAMELEN];
526 enum nft_chain_type {
527 NFT_CHAIN_T_DEFAULT = 0,
533 int nft_chain_validate_dependency(const struct nft_chain *chain,
534 enum nft_chain_type type);
539 struct u64_stats_sync syncp;
542 #define NFT_HOOK_OPS_MAX 2
545 * struct nft_base_chain - nf_tables base chain
547 * @ops: netfilter hook ops
549 * @policy: default policy
550 * @stats: per-cpu chain stats
553 struct nft_base_chain {
554 struct nf_hook_ops ops[NFT_HOOK_OPS_MAX];
555 const struct nf_chain_type *type;
557 struct nft_stats __percpu *stats;
558 struct nft_chain chain;
561 static inline struct nft_base_chain *nft_base_chain(const struct nft_chain *chain)
563 return container_of(chain, struct nft_base_chain, chain);
566 unsigned int nft_do_chain(struct nft_pktinfo *pkt,
567 const struct nf_hook_ops *ops);
570 * struct nft_table - nf_tables table
572 * @list: used internally
573 * @chains: chains in the table
574 * @sets: sets in the table
575 * @hgenerator: handle generator state
576 * @use: number of chain references to this table
577 * @flags: table flag (see enum nft_table_flags)
578 * @name: name of the table
581 struct list_head list;
582 struct list_head chains;
583 struct list_head sets;
591 * struct nft_af_info - nf_tables address family info
593 * @list: used internally
594 * @family: address family
595 * @nhooks: number of hooks in this family
596 * @owner: module owner
597 * @tables: used internally
598 * @nops: number of hook ops in this family
599 * @hook_ops_init: initialization function for chain hook ops
600 * @hooks: hookfn overrides for packet validation
603 struct list_head list;
606 struct module *owner;
607 struct list_head tables;
609 void (*hook_ops_init)(struct nf_hook_ops *,
611 nf_hookfn *hooks[NF_MAX_HOOKS];
614 int nft_register_afinfo(struct net *, struct nft_af_info *);
615 void nft_unregister_afinfo(struct nft_af_info *);
618 * struct nf_chain_type - nf_tables chain type info
620 * @name: name of the type
621 * @type: numeric identifier
622 * @family: address family
623 * @owner: module owner
624 * @hook_mask: mask of valid hooks
625 * @hooks: hookfn overrides
627 struct nf_chain_type {
629 enum nft_chain_type type;
631 struct module *owner;
632 unsigned int hook_mask;
633 nf_hookfn *hooks[NF_MAX_HOOKS];
636 int nft_register_chain_type(const struct nf_chain_type *);
637 void nft_unregister_chain_type(const struct nf_chain_type *);
639 int nft_register_expr(struct nft_expr_type *);
640 void nft_unregister_expr(struct nft_expr_type *);
642 #define nft_dereference(p) \
643 nfnl_dereference(p, NFNL_SUBSYS_NFTABLES)
645 #define MODULE_ALIAS_NFT_FAMILY(family) \
646 MODULE_ALIAS("nft-afinfo-" __stringify(family))
648 #define MODULE_ALIAS_NFT_CHAIN(family, name) \
649 MODULE_ALIAS("nft-chain-" __stringify(family) "-" name)
651 #define MODULE_ALIAS_NFT_AF_EXPR(family, name) \
652 MODULE_ALIAS("nft-expr-" __stringify(family) "-" name)
654 #define MODULE_ALIAS_NFT_EXPR(name) \
655 MODULE_ALIAS("nft-expr-" name)
657 #define MODULE_ALIAS_NFT_SET() \
658 MODULE_ALIAS("nft-set")
660 #endif /* _NET_NF_TABLES_H */