include/net/netfilter/nf_tables.h

   1 /* SPDX-License-Identifier: GPL-2.0 */
   2 #ifndef _NET_NF_TABLES_H
   3 #define _NET_NF_TABLES_H
   4
   5 #include <asm/unaligned.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 <linux/rhashtable.h>
  13 #include <net/netfilter/nf_flow_table.h>
  14 #include <net/netlink.h>
  15 #include <net/flow_offload.h>
  16
  17 struct module;
  18
  19 #define NFT_JUMP_STACK_SIZE     16
  20
  21 struct nft_pktinfo {
  22         struct sk_buff                  *skb;
  23         bool                            tprot_set;
  24         u8                              tprot;
  25         /* for x_tables compatibility */
  26         struct xt_action_param          xt;
  27 };
  28
  29 static inline struct net *nft_net(const struct nft_pktinfo *pkt)
  30 {
  31         return pkt->xt.state->net;
  32 }
  33
  34 static inline unsigned int nft_hook(const struct nft_pktinfo *pkt)
  35 {
  36         return pkt->xt.state->hook;
  37 }
  38
  39 static inline u8 nft_pf(const struct nft_pktinfo *pkt)
  40 {
  41         return pkt->xt.state->pf;
  42 }
  43
  44 static inline const struct net_device *nft_in(const struct nft_pktinfo *pkt)
  45 {
  46         return pkt->xt.state->in;
  47 }
  48
  49 static inline const struct net_device *nft_out(const struct nft_pktinfo *pkt)
  50 {
  51         return pkt->xt.state->out;
  52 }
  53
  54 static inline void nft_set_pktinfo(struct nft_pktinfo *pkt,
  55                                    struct sk_buff *skb,
  56                                    const struct nf_hook_state *state)
  57 {
  58         pkt->skb = skb;
  59         pkt->xt.state = state;
  60 }
  61
  62 static inline void nft_set_pktinfo_unspec(struct nft_pktinfo *pkt,
  63                                           struct sk_buff *skb)
  64 {
  65         pkt->tprot_set = false;
  66         pkt->tprot = 0;
  67         pkt->xt.thoff = 0;
  68         pkt->xt.fragoff = 0;
  69 }
  70
  71 /**
  72  *      struct nft_verdict - nf_tables verdict
  73  *
  74  *      @code: nf_tables/netfilter verdict code
  75  *      @chain: destination chain for NFT_JUMP/NFT_GOTO
  76  */
  77 struct nft_verdict {
  78         u32                             code;
  79         struct nft_chain                *chain;
  80 };
  81
  82 struct nft_data {
  83         union {
  84                 u32                     data[4];
  85                 struct nft_verdict      verdict;
  86         };
  87 } __attribute__((aligned(__alignof__(u64))));
  88
  89 /**
  90  *      struct nft_regs - nf_tables register set
  91  *
  92  *      @data: data registers
  93  *      @verdict: verdict register
  94  *
  95  *      The first four data registers alias to the verdict register.
  96  */
  97 struct nft_regs {
  98         union {
  99                 u32                     data[20];
 100                 struct nft_verdict      verdict;
 101         };
 102 };
 103
 104 /* Store/load an u8, u16 or u64 integer to/from the u32 data register.
 105  *
 106  * Note, when using concatenations, register allocation happens at 32-bit
 107  * level. So for store instruction, pad the rest part with zero to avoid
 108  * garbage values.
 109  */
 110
 111 static inline void nft_reg_store8(u32 *dreg, u8 val)
 112 {
 113         *dreg = 0;
 114         *(u8 *)dreg = val;
 115 }
 116
 117 static inline u8 nft_reg_load8(const u32 *sreg)
 118 {
 119         return *(u8 *)sreg;
 120 }
 121
 122 static inline void nft_reg_store16(u32 *dreg, u16 val)
 123 {
 124         *dreg = 0;
 125         *(u16 *)dreg = val;
 126 }
 127
 128 static inline u16 nft_reg_load16(const u32 *sreg)
 129 {
 130         return *(u16 *)sreg;
 131 }
 132
 133 static inline void nft_reg_store64(u32 *dreg, u64 val)
 134 {
 135         put_unaligned(val, (u64 *)dreg);
 136 }
 137
 138 static inline u64 nft_reg_load64(const u32 *sreg)
 139 {
 140         return get_unaligned((u64 *)sreg);
 141 }
 142
 143 static inline void nft_data_copy(u32 *dst, const struct nft_data *src,
 144                                  unsigned int len)
 145 {
 146         memcpy(dst, src, len);
 147 }
 148
 149 static inline void nft_data_debug(const struct nft_data *data)
 150 {
 151         pr_debug("data[0]=%x data[1]=%x data[2]=%x data[3]=%x\n",
 152                  data->data[0], data->data[1],
 153                  data->data[2], data->data[3]);
 154 }
 155
 156 /**
 157  *      struct nft_ctx - nf_tables rule/set context
 158  *
 159  *      @net: net namespace
 160  *      @table: the table the chain is contained in
 161  *      @chain: the chain the rule is contained in
 162  *      @nla: netlink attributes
 163  *      @portid: netlink portID of the original message
 164  *      @seq: netlink sequence number
 165  *      @family: protocol family
 166  *      @level: depth of the chains
 167  *      @report: notify via unicast netlink message
 168  */
 169 struct nft_ctx {
 170         struct net                      *net;
 171         struct nft_table                *table;
 172         struct nft_chain                *chain;
 173         const struct nlattr * const     *nla;
 174         u32                             portid;
 175         u32                             seq;
 176         u16                             flags;
 177         u8                              family;
 178         u8                              level;
 179         bool                            report;
 180 };
 181
 182 struct nft_data_desc {
 183         enum nft_data_types             type;
 184         unsigned int                    len;
 185 };
 186
 187 int nft_data_init(const struct nft_ctx *ctx,
 188                   struct nft_data *data, unsigned int size,
 189                   struct nft_data_desc *desc, const struct nlattr *nla);
 190 void nft_data_hold(const struct nft_data *data, enum nft_data_types type);
 191 void nft_data_release(const struct nft_data *data, enum nft_data_types type);
 192 int nft_data_dump(struct sk_buff *skb, int attr, const struct nft_data *data,
 193                   enum nft_data_types type, unsigned int len);
 194
 195 static inline enum nft_data_types nft_dreg_to_type(enum nft_registers reg)
 196 {
 197         return reg == NFT_REG_VERDICT ? NFT_DATA_VERDICT : NFT_DATA_VALUE;
 198 }
 199
 200 static inline enum nft_registers nft_type_to_reg(enum nft_data_types type)
 201 {
 202         return type == NFT_DATA_VERDICT ? NFT_REG_VERDICT : NFT_REG_1 * NFT_REG_SIZE / NFT_REG32_SIZE;
 203 }
 204
 205 int nft_parse_u32_check(const struct nlattr *attr, int max, u32 *dest);
 206 unsigned int nft_parse_register(const struct nlattr *attr);
 207 int nft_dump_register(struct sk_buff *skb, unsigned int attr, unsigned int reg);
 208
 209 int nft_validate_register_load(enum nft_registers reg, unsigned int len);
 210 int nft_validate_register_store(const struct nft_ctx *ctx,
 211                                 enum nft_registers reg,
 212                                 const struct nft_data *data,
 213                                 enum nft_data_types type, unsigned int len);
 214
 215 /**
 216  *      struct nft_userdata - user defined data associated with an object
 217  *
 218  *      @len: length of the data
 219  *      @data: content
 220  *
 221  *      The presence of user data is indicated in an object specific fashion,
 222  *      so a length of zero can't occur and the value "len" indicates data
 223  *      of length len + 1.
 224  */
 225 struct nft_userdata {
 226         u8                      len;
 227         unsigned char           data[0];
 228 };
 229
 230 /**
 231  *      struct nft_set_elem - generic representation of set elements
 232  *
 233  *      @key: element key
 234  *      @key_end: closing element key
 235  *      @priv: element private data and extensions
 236  */
 237 struct nft_set_elem {
 238         union {
 239                 u32             buf[NFT_DATA_VALUE_MAXLEN / sizeof(u32)];
 240                 struct nft_data val;
 241         } key;
 242         union {
 243                 u32             buf[NFT_DATA_VALUE_MAXLEN / sizeof(u32)];
 244                 struct nft_data val;
 245         } key_end;
 246         void                    *priv;
 247 };
 248
 249 struct nft_set;
 250 struct nft_set_iter {
 251         u8              genmask;
 252         unsigned int    count;
 253         unsigned int    skip;
 254         int             err;
 255         int             (*fn)(const struct nft_ctx *ctx,
 256                               struct nft_set *set,
 257                               const struct nft_set_iter *iter,
 258                               struct nft_set_elem *elem);
 259 };
 260
 261 /**
 262  *      struct nft_set_desc - description of set elements
 263  *
 264  *      @klen: key length
 265  *      @dlen: data length
 266  *      @size: number of set elements
 267  *      @field_len: length of each field in concatenation, bytes
 268  *      @field_count: number of concatenated fields in element
 269  */
 270 struct nft_set_desc {
 271         unsigned int            klen;
 272         unsigned int            dlen;
 273         unsigned int            size;
 274         u8                      field_len[NFT_REG32_COUNT];
 275         u8                      field_count;
 276 };
 277
 278 /**
 279  *      enum nft_set_class - performance class
 280  *
 281  *      @NFT_LOOKUP_O_1: constant, O(1)
 282  *      @NFT_LOOKUP_O_LOG_N: logarithmic, O(log N)
 283  *      @NFT_LOOKUP_O_N: linear, O(N)
 284  */
 285 enum nft_set_class {
 286         NFT_SET_CLASS_O_1,
 287         NFT_SET_CLASS_O_LOG_N,
 288         NFT_SET_CLASS_O_N,
 289 };
 290
 291 /**
 292  *      struct nft_set_estimate - estimation of memory and performance
 293  *                                characteristics
 294  *
 295  *      @size: required memory
 296  *      @lookup: lookup performance class
 297  *      @space: memory class
 298  */
 299 struct nft_set_estimate {
 300         u64                     size;
 301         enum nft_set_class      lookup;
 302         enum nft_set_class      space;
 303 };
 304
 305 struct nft_set_ext;
 306 struct nft_expr;
 307
 308 /**
 309  *      struct nft_set_ops - nf_tables set operations
 310  *
 311  *      @lookup: look up an element within the set
 312  *      @update: update an element if exists, add it if doesn't exist
 313  *      @delete: delete an element
 314  *      @insert: insert new element into set
 315  *      @activate: activate new element in the next generation
 316  *      @deactivate: lookup for element and deactivate it in the next generation
 317  *      @flush: deactivate element in the next generation
 318  *      @remove: remove element from set
 319  *      @walk: iterate over all set elements
 320  *      @get: get set elements
 321  *      @privsize: function to return size of set private data
 322  *      @init: initialize private data of new set instance
 323  *      @destroy: destroy private data of set instance
 324  *      @elemsize: element private size
 325  *
 326  *      Operations lookup, update and delete have simpler interfaces, are faster
 327  *      and currently only used in the packet path. All the rest are slower,
 328  *      control plane functions.
 329  */
 330 struct nft_set_ops {
 331         bool                            (*lookup)(const struct net *net,
 332                                                   const struct nft_set *set,
 333                                                   const u32 *key,
 334                                                   const struct nft_set_ext **ext);
 335         bool                            (*update)(struct nft_set *set,
 336                                                   const u32 *key,
 337                                                   void *(*new)(struct nft_set *,
 338                                                                const struct nft_expr *,
 339                                                                struct nft_regs *),
 340                                                   const struct nft_expr *expr,
 341                                                   struct nft_regs *regs,
 342                                                   const struct nft_set_ext **ext);
 343         bool                            (*delete)(const struct nft_set *set,
 344                                                   const u32 *key);
 345
 346         int                             (*insert)(const struct net *net,
 347                                                   const struct nft_set *set,
 348                                                   const struct nft_set_elem *elem,
 349                                                   struct nft_set_ext **ext);
 350         void                            (*activate)(const struct net *net,
 351                                                     const struct nft_set *set,
 352                                                     const struct nft_set_elem *elem);
 353         void *                          (*deactivate)(const struct net *net,
 354                                                       const struct nft_set *set,
 355                                                       const struct nft_set_elem *elem);
 356         bool                            (*flush)(const struct net *net,
 357                                                  const struct nft_set *set,
 358                                                  void *priv);
 359         void                            (*remove)(const struct net *net,
 360                                                   const struct nft_set *set,
 361                                                   const struct nft_set_elem *elem);
 362         void                            (*walk)(const struct nft_ctx *ctx,
 363                                                 struct nft_set *set,
 364                                                 struct nft_set_iter *iter);
 365         void *                          (*get)(const struct net *net,
 366                                                const struct nft_set *set,
 367                                                const struct nft_set_elem *elem,
 368                                                unsigned int flags);
 369
 370         u64                             (*privsize)(const struct nlattr * const nla[],
 371                                                     const struct nft_set_desc *desc);
 372         bool                            (*estimate)(const struct nft_set_desc *desc,
 373                                                     u32 features,
 374                                                     struct nft_set_estimate *est);
 375         int                             (*init)(const struct nft_set *set,
 376                                                 const struct nft_set_desc *desc,
 377                                                 const struct nlattr * const nla[]);
 378         void                            (*destroy)(const struct nft_set *set);
 379         void                            (*gc_init)(const struct nft_set *set);
 380
 381         unsigned int                    elemsize;
 382 };
 383
 384 /**
 385  *      struct nft_set_type - nf_tables set type
 386  *
 387  *      @ops: set ops for this type
 388  *      @list: used internally
 389  *      @owner: module reference
 390  *      @features: features supported by the implementation
 391  */
 392 struct nft_set_type {
 393         const struct nft_set_ops        ops;
 394         struct list_head                list;
 395         struct module                   *owner;
 396         u32                             features;
 397 };
 398 #define to_set_type(o) container_of(o, struct nft_set_type, ops)
 399
 400 int nft_register_set(struct nft_set_type *type);
 401 void nft_unregister_set(struct nft_set_type *type);
 402
 403 /**
 404  *      struct nft_set - nf_tables set instance
 405  *
 406  *      @list: table set list node
 407  *      @bindings: list of set bindings
 408  *      @table: table this set belongs to
 409  *      @net: netnamespace this set belongs to
 410  *      @name: name of the set
 411  *      @handle: unique handle of the set
 412  *      @ktype: key type (numeric type defined by userspace, not used in the kernel)
 413  *      @dtype: data type (verdict or numeric type defined by userspace)
 414  *      @objtype: object type (see NFT_OBJECT_* definitions)
 415  *      @size: maximum set size
 416  *      @field_len: length of each field in concatenation, bytes
 417  *      @field_count: number of concatenated fields in element
 418  *      @use: number of rules references to this set
 419  *      @nelems: number of elements
 420  *      @ndeact: number of deactivated elements queued for removal
 421  *      @timeout: default timeout value in jiffies
 422  *      @gc_int: garbage collection interval in msecs
 423  *      @policy: set parameterization (see enum nft_set_policies)
 424  *      @udlen: user data length
 425  *      @udata: user data
 426  *      @ops: set ops
 427  *      @flags: set flags
 428  *      @genmask: generation mask
 429  *      @klen: key length
 430  *      @dlen: data length
 431  *      @data: private set data
 432  */
 433 struct nft_set {
 434         struct list_head                list;
 435         struct list_head                bindings;
 436         struct nft_table                *table;
 437         possible_net_t                  net;
 438         char                            *name;
 439         u64                             handle;
 440         u32                             ktype;
 441         u32                             dtype;
 442         u32                             objtype;
 443         u32                             size;
 444         u8                              field_len[NFT_REG32_COUNT];
 445         u8                              field_count;
 446         u32                             use;
 447         atomic_t                        nelems;
 448         u32                             ndeact;
 449         u64                             timeout;
 450         u32                             gc_int;
 451         u16                             policy;
 452         u16                             udlen;
 453         unsigned char                   *udata;
 454         /* runtime data below here */
 455         const struct nft_set_ops        *ops ____cacheline_aligned;
 456         u16                             flags:14,
 457                                         genmask:2;
 458         u8                              klen;
 459         u8                              dlen;
 460         unsigned char                   data[]
 461                 __attribute__((aligned(__alignof__(u64))));
 462 };
 463
 464 static inline bool nft_set_is_anonymous(const struct nft_set *set)
 465 {
 466         return set->flags & NFT_SET_ANONYMOUS;
 467 }
 468
 469 static inline void *nft_set_priv(const struct nft_set *set)
 470 {
 471         return (void *)set->data;
 472 }
 473
 474 static inline struct nft_set *nft_set_container_of(const void *priv)
 475 {
 476         return (void *)priv - offsetof(struct nft_set, data);
 477 }
 478
 479 struct nft_set *nft_set_lookup_global(const struct net *net,
 480                                       const struct nft_table *table,
 481                                       const struct nlattr *nla_set_name,
 482                                       const struct nlattr *nla_set_id,
 483                                       u8 genmask);
 484
 485 static inline unsigned long nft_set_gc_interval(const struct nft_set *set)
 486 {
 487         return set->gc_int ? msecs_to_jiffies(set->gc_int) : HZ;
 488 }
 489
 490 /**
 491  *      struct nft_set_binding - nf_tables set binding
 492  *
 493  *      @list: set bindings list node
 494  *      @chain: chain containing the rule bound to the set
 495  *      @flags: set action flags
 496  *
 497  *      A set binding contains all information necessary for validation
 498  *      of new elements added to a bound set.
 499  */
 500 struct nft_set_binding {
 501         struct list_head                list;
 502         const struct nft_chain          *chain;
 503         u32                             flags;
 504 };
 505
 506 enum nft_trans_phase;
 507 void nf_tables_deactivate_set(const struct nft_ctx *ctx, struct nft_set *set,
 508                               struct nft_set_binding *binding,
 509                               enum nft_trans_phase phase);
 510 int nf_tables_bind_set(const struct nft_ctx *ctx, struct nft_set *set,
 511                        struct nft_set_binding *binding);
 512 void nf_tables_destroy_set(const struct nft_ctx *ctx, struct nft_set *set);
 513
 514 /**
 515  *      enum nft_set_extensions - set extension type IDs
 516  *
 517  *      @NFT_SET_EXT_KEY: element key
 518  *      @NFT_SET_EXT_KEY_END: upper bound element key, for ranges
 519  *      @NFT_SET_EXT_DATA: mapping data
 520  *      @NFT_SET_EXT_FLAGS: element flags
 521  *      @NFT_SET_EXT_TIMEOUT: element timeout
 522  *      @NFT_SET_EXT_EXPIRATION: element expiration time
 523  *      @NFT_SET_EXT_USERDATA: user data associated with the element
 524  *      @NFT_SET_EXT_EXPR: expression assiociated with the element
 525  *      @NFT_SET_EXT_OBJREF: stateful object reference associated with element
 526  *      @NFT_SET_EXT_NUM: number of extension types
 527  */
 528 enum nft_set_extensions {
 529         NFT_SET_EXT_KEY,
 530         NFT_SET_EXT_KEY_END,
 531         NFT_SET_EXT_DATA,
 532         NFT_SET_EXT_FLAGS,
 533         NFT_SET_EXT_TIMEOUT,
 534         NFT_SET_EXT_EXPIRATION,
 535         NFT_SET_EXT_USERDATA,
 536         NFT_SET_EXT_EXPR,
 537         NFT_SET_EXT_OBJREF,
 538         NFT_SET_EXT_NUM
 539 };
 540
 541 /**
 542  *      struct nft_set_ext_type - set extension type
 543  *
 544  *      @len: fixed part length of the extension
 545  *      @align: alignment requirements of the extension
 546  */
 547 struct nft_set_ext_type {
 548         u8      len;
 549         u8      align;
 550 };
 551
 552 extern const struct nft_set_ext_type nft_set_ext_types[];
 553
 554 /**
 555  *      struct nft_set_ext_tmpl - set extension template
 556  *
 557  *      @len: length of extension area
 558  *      @offset: offsets of individual extension types
 559  */
 560 struct nft_set_ext_tmpl {
 561         u16     len;
 562         u8      offset[NFT_SET_EXT_NUM];
 563 };
 564
 565 /**
 566  *      struct nft_set_ext - set extensions
 567  *
 568  *      @genmask: generation mask
 569  *      @offset: offsets of individual extension types
 570  *      @data: beginning of extension data
 571  */
 572 struct nft_set_ext {
 573         u8      genmask;
 574         u8      offset[NFT_SET_EXT_NUM];
 575         char    data[0];
 576 };
 577
 578 static inline void nft_set_ext_prepare(struct nft_set_ext_tmpl *tmpl)
 579 {
 580         memset(tmpl, 0, sizeof(*tmpl));
 581         tmpl->len = sizeof(struct nft_set_ext);
 582 }
 583
 584 static inline void nft_set_ext_add_length(struct nft_set_ext_tmpl *tmpl, u8 id,
 585                                           unsigned int len)
 586 {
 587         tmpl->len        = ALIGN(tmpl->len, nft_set_ext_types[id].align);
 588         BUG_ON(tmpl->len > U8_MAX);
 589         tmpl->offset[id] = tmpl->len;
 590         tmpl->len       += nft_set_ext_types[id].len + len;
 591 }
 592
 593 static inline void nft_set_ext_add(struct nft_set_ext_tmpl *tmpl, u8 id)
 594 {
 595         nft_set_ext_add_length(tmpl, id, 0);
 596 }
 597
 598 static inline void nft_set_ext_init(struct nft_set_ext *ext,
 599                                     const struct nft_set_ext_tmpl *tmpl)
 600 {
 601         memcpy(ext->offset, tmpl->offset, sizeof(ext->offset));
 602 }
 603
 604 static inline bool __nft_set_ext_exists(const struct nft_set_ext *ext, u8 id)
 605 {
 606         return !!ext->offset[id];
 607 }
 608
 609 static inline bool nft_set_ext_exists(const struct nft_set_ext *ext, u8 id)
 610 {
 611         return ext && __nft_set_ext_exists(ext, id);
 612 }
 613
 614 static inline void *nft_set_ext(const struct nft_set_ext *ext, u8 id)
 615 {
 616         return (void *)ext + ext->offset[id];
 617 }
 618
 619 static inline struct nft_data *nft_set_ext_key(const struct nft_set_ext *ext)
 620 {
 621         return nft_set_ext(ext, NFT_SET_EXT_KEY);
 622 }
 623
 624 static inline struct nft_data *nft_set_ext_key_end(const struct nft_set_ext *ext)
 625 {
 626         return nft_set_ext(ext, NFT_SET_EXT_KEY_END);
 627 }
 628
 629 static inline struct nft_data *nft_set_ext_data(const struct nft_set_ext *ext)
 630 {
 631         return nft_set_ext(ext, NFT_SET_EXT_DATA);
 632 }
 633
 634 static inline u8 *nft_set_ext_flags(const struct nft_set_ext *ext)
 635 {
 636         return nft_set_ext(ext, NFT_SET_EXT_FLAGS);
 637 }
 638
 639 static inline u64 *nft_set_ext_timeout(const struct nft_set_ext *ext)
 640 {
 641         return nft_set_ext(ext, NFT_SET_EXT_TIMEOUT);
 642 }
 643
 644 static inline u64 *nft_set_ext_expiration(const struct nft_set_ext *ext)
 645 {
 646         return nft_set_ext(ext, NFT_SET_EXT_EXPIRATION);
 647 }
 648
 649 static inline struct nft_userdata *nft_set_ext_userdata(const struct nft_set_ext *ext)
 650 {
 651         return nft_set_ext(ext, NFT_SET_EXT_USERDATA);
 652 }
 653
 654 static inline struct nft_expr *nft_set_ext_expr(const struct nft_set_ext *ext)
 655 {
 656         return nft_set_ext(ext, NFT_SET_EXT_EXPR);
 657 }
 658
 659 static inline bool nft_set_elem_expired(const struct nft_set_ext *ext)
 660 {
 661         return nft_set_ext_exists(ext, NFT_SET_EXT_EXPIRATION) &&
 662                time_is_before_eq_jiffies64(*nft_set_ext_expiration(ext));
 663 }
 664
 665 static inline struct nft_set_ext *nft_set_elem_ext(const struct nft_set *set,
 666                                                    void *elem)
 667 {
 668         return elem + set->ops->elemsize;
 669 }
 670
 671 static inline struct nft_object **nft_set_ext_obj(const struct nft_set_ext *ext)
 672 {
 673         return nft_set_ext(ext, NFT_SET_EXT_OBJREF);
 674 }
 675
 676 void *nft_set_elem_init(const struct nft_set *set,
 677                         const struct nft_set_ext_tmpl *tmpl,
 678                         const u32 *key, const u32 *key_end, const u32 *data,
 679                         u64 timeout, u64 expiration, gfp_t gfp);
 680 void nft_set_elem_destroy(const struct nft_set *set, void *elem,
 681                           bool destroy_expr);
 682
 683 /**
 684  *      struct nft_set_gc_batch_head - nf_tables set garbage collection batch
 685  *
 686  *      @rcu: rcu head
 687  *      @set: set the elements belong to
 688  *      @cnt: count of elements
 689  */
 690 struct nft_set_gc_batch_head {
 691         struct rcu_head                 rcu;
 692         const struct nft_set            *set;
 693         unsigned int                    cnt;
 694 };
 695
 696 #define NFT_SET_GC_BATCH_SIZE   ((PAGE_SIZE -                             \
 697                                   sizeof(struct nft_set_gc_batch_head)) / \
 698                                  sizeof(void *))
 699
 700 /**
 701  *      struct nft_set_gc_batch - nf_tables set garbage collection batch
 702  *
 703  *      @head: GC batch head
 704  *      @elems: garbage collection elements
 705  */
 706 struct nft_set_gc_batch {
 707         struct nft_set_gc_batch_head    head;
 708         void                            *elems[NFT_SET_GC_BATCH_SIZE];
 709 };
 710
 711 struct nft_set_gc_batch *nft_set_gc_batch_alloc(const struct nft_set *set,
 712                                                 gfp_t gfp);
 713 void nft_set_gc_batch_release(struct rcu_head *rcu);
 714
 715 static inline void nft_set_gc_batch_complete(struct nft_set_gc_batch *gcb)
 716 {
 717         if (gcb != NULL)
 718                 call_rcu(&gcb->head.rcu, nft_set_gc_batch_release);
 719 }
 720
 721 static inline struct nft_set_gc_batch *
 722 nft_set_gc_batch_check(const struct nft_set *set, struct nft_set_gc_batch *gcb,
 723                        gfp_t gfp)
 724 {
 725         if (gcb != NULL) {
 726                 if (gcb->head.cnt + 1 < ARRAY_SIZE(gcb->elems))
 727                         return gcb;
 728                 nft_set_gc_batch_complete(gcb);
 729         }
 730         return nft_set_gc_batch_alloc(set, gfp);
 731 }
 732
 733 static inline void nft_set_gc_batch_add(struct nft_set_gc_batch *gcb,
 734                                         void *elem)
 735 {
 736         gcb->elems[gcb->head.cnt++] = elem;
 737 }
 738
 739 struct nft_expr_ops;
 740 /**
 741  *      struct nft_expr_type - nf_tables expression type
 742  *
 743  *      @select_ops: function to select nft_expr_ops
 744  *      @release_ops: release nft_expr_ops
 745  *      @ops: default ops, used when no select_ops functions is present
 746  *      @list: used internally
 747  *      @name: Identifier
 748  *      @owner: module reference
 749  *      @policy: netlink attribute policy
 750  *      @maxattr: highest netlink attribute number
 751  *      @family: address family for AF-specific types
 752  *      @flags: expression type flags
 753  */
 754 struct nft_expr_type {
 755         const struct nft_expr_ops       *(*select_ops)(const struct nft_ctx *,
 756                                                        const struct nlattr * const tb[]);
 757         void                            (*release_ops)(const struct nft_expr_ops *ops);
 758         const struct nft_expr_ops       *ops;
 759         struct list_head                list;
 760         const char                      *name;
 761         struct module                   *owner;
 762         const struct nla_policy         *policy;
 763         unsigned int                    maxattr;
 764         u8                              family;
 765         u8                              flags;
 766 };
 767
 768 #define NFT_EXPR_STATEFUL               0x1
 769 #define NFT_EXPR_GC                     0x2
 770
 771 enum nft_trans_phase {
 772         NFT_TRANS_PREPARE,
 773         NFT_TRANS_ABORT,
 774         NFT_TRANS_COMMIT,
 775         NFT_TRANS_RELEASE
 776 };
 777
 778 struct nft_flow_rule;
 779 struct nft_offload_ctx;
 780
 781 /**
 782  *      struct nft_expr_ops - nf_tables expression operations
 783  *
 784  *      @eval: Expression evaluation function
 785  *      @size: full expression size, including private data size
 786  *      @init: initialization function
 787  *      @activate: activate expression in the next generation
 788  *      @deactivate: deactivate expression in next generation
 789  *      @destroy: destruction function, called after synchronize_rcu
 790  *      @dump: function to dump parameters
 791  *      @type: expression type
 792  *      @validate: validate expression, called during loop detection
 793  *      @data: extra data to attach to this expression operation
 794  */
 795 struct nft_expr;
 796 struct nft_expr_ops {
 797         void                            (*eval)(const struct nft_expr *expr,
 798                                                 struct nft_regs *regs,
 799                                                 const struct nft_pktinfo *pkt);
 800         int                             (*clone)(struct nft_expr *dst,
 801                                                  const struct nft_expr *src);
 802         unsigned int                    size;
 803
 804         int                             (*init)(const struct nft_ctx *ctx,
 805                                                 const struct nft_expr *expr,
 806                                                 const struct nlattr * const tb[]);
 807         void                            (*activate)(const struct nft_ctx *ctx,
 808                                                     const struct nft_expr *expr);
 809         void                            (*deactivate)(const struct nft_ctx *ctx,
 810                                                       const struct nft_expr *expr,
 811                                                       enum nft_trans_phase phase);
 812         void                            (*destroy)(const struct nft_ctx *ctx,
 813                                                    const struct nft_expr *expr);
 814         void                            (*destroy_clone)(const struct nft_ctx *ctx,
 815                                                          const struct nft_expr *expr);
 816         int                             (*dump)(struct sk_buff *skb,
 817                                                 const struct nft_expr *expr);
 818         int                             (*validate)(const struct nft_ctx *ctx,
 819                                                     const struct nft_expr *expr,
 820                                                     const struct nft_data **data);
 821         bool                            (*gc)(struct net *net,
 822                                               const struct nft_expr *expr);
 823         int                             (*offload)(struct nft_offload_ctx *ctx,
 824                                                    struct nft_flow_rule *flow,
 825                                                    const struct nft_expr *expr);
 826         u32                             offload_flags;
 827         const struct nft_expr_type      *type;
 828         void                            *data;
 829 };
 830
 831 #define NFT_EXPR_MAXATTR                16
 832 #define NFT_EXPR_SIZE(size)             (sizeof(struct nft_expr) + \
 833                                          ALIGN(size, __alignof__(struct nft_expr)))
 834
 835 /**
 836  *      struct nft_expr - nf_tables expression
 837  *
 838  *      @ops: expression ops
 839  *      @data: expression private data
 840  */
 841 struct nft_expr {
 842         const struct nft_expr_ops       *ops;
 843         unsigned char                   data[]
 844                 __attribute__((aligned(__alignof__(u64))));
 845 };
 846
 847 static inline void *nft_expr_priv(const struct nft_expr *expr)
 848 {
 849         return (void *)expr->data;
 850 }
 851
 852 struct nft_expr *nft_expr_init(const struct nft_ctx *ctx,
 853                                const struct nlattr *nla);
 854 void nft_expr_destroy(const struct nft_ctx *ctx, struct nft_expr *expr);
 855 int nft_expr_dump(struct sk_buff *skb, unsigned int attr,
 856                   const struct nft_expr *expr);
 857
 858 /**
 859  *      struct nft_rule - nf_tables rule
 860  *
 861  *      @list: used internally
 862  *      @handle: rule handle
 863  *      @genmask: generation mask
 864  *      @dlen: length of expression data
 865  *      @udata: user data is appended to the rule
 866  *      @data: expression data
 867  */
 868 struct nft_rule {
 869         struct list_head                list;
 870         u64                             handle:42,
 871                                         genmask:2,
 872                                         dlen:12,
 873                                         udata:1;
 874         unsigned char                   data[]
 875                 __attribute__((aligned(__alignof__(struct nft_expr))));
 876 };
 877
 878 static inline struct nft_expr *nft_expr_first(const struct nft_rule *rule)
 879 {
 880         return (struct nft_expr *)&rule->data[0];
 881 }
 882
 883 static inline struct nft_expr *nft_expr_next(const struct nft_expr *expr)
 884 {
 885         return ((void *)expr) + expr->ops->size;
 886 }
 887
 888 static inline struct nft_expr *nft_expr_last(const struct nft_rule *rule)
 889 {
 890         return (struct nft_expr *)&rule->data[rule->dlen];
 891 }
 892
 893 static inline struct nft_userdata *nft_userdata(const struct nft_rule *rule)
 894 {
 895         return (void *)&rule->data[rule->dlen];
 896 }
 897
 898 /*
 899  * The last pointer isn't really necessary, but the compiler isn't able to
 900  * determine that the result of nft_expr_last() is always the same since it
 901  * can't assume that the dlen value wasn't changed within calls in the loop.
 902  */
 903 #define nft_rule_for_each_expr(expr, last, rule) \
 904         for ((expr) = nft_expr_first(rule), (last) = nft_expr_last(rule); \
 905              (expr) != (last); \
 906              (expr) = nft_expr_next(expr))
 907
 908 enum nft_chain_flags {
 909         NFT_BASE_CHAIN                  = 0x1,
 910         NFT_CHAIN_HW_OFFLOAD            = 0x2,
 911 };
 912
 913 #define NFT_CHAIN_POLICY_UNSET          U8_MAX
 914
 915 /**
 916  *      struct nft_chain - nf_tables chain
 917  *
 918  *      @rules: list of rules in the chain
 919  *      @list: used internally
 920  *      @rhlhead: used internally
 921  *      @table: table that this chain belongs to
 922  *      @handle: chain handle
 923  *      @use: number of jump references to this chain
 924  *      @flags: bitmask of enum nft_chain_flags
 925  *      @name: name of the chain
 926  */
 927 struct nft_chain {
 928         struct nft_rule                 *__rcu *rules_gen_0;
 929         struct nft_rule                 *__rcu *rules_gen_1;
 930         struct list_head                rules;
 931         struct list_head                list;
 932         struct rhlist_head              rhlhead;
 933         struct nft_table                *table;
 934         u64                             handle;
 935         u32                             use;
 936         u8                              flags:6,
 937                                         genmask:2;
 938         char                            *name;
 939
 940         /* Only used during control plane commit phase: */
 941         struct nft_rule                 **rules_next;
 942 };
 943
 944 int nft_chain_validate(const struct nft_ctx *ctx, const struct nft_chain *chain);
 945
 946 enum nft_chain_types {
 947         NFT_CHAIN_T_DEFAULT = 0,
 948         NFT_CHAIN_T_ROUTE,
 949         NFT_CHAIN_T_NAT,
 950         NFT_CHAIN_T_MAX
 951 };
 952
 953 /**
 954  *      struct nft_chain_type - nf_tables chain type info
 955  *
 956  *      @name: name of the type
 957  *      @type: numeric identifier
 958  *      @family: address family
 959  *      @owner: module owner
 960  *      @hook_mask: mask of valid hooks
 961  *      @hooks: array of hook functions
 962  *      @ops_register: base chain register function
 963  *      @ops_unregister: base chain unregister function
 964  */
 965 struct nft_chain_type {
 966         const char                      *name;
 967         enum nft_chain_types            type;
 968         int                             family;
 969         struct module                   *owner;
 970         unsigned int                    hook_mask;
 971         nf_hookfn                       *hooks[NF_MAX_HOOKS];
 972         int                             (*ops_register)(struct net *net, const struct nf_hook_ops *ops);
 973         void                            (*ops_unregister)(struct net *net, const struct nf_hook_ops *ops);
 974 };
 975
 976 int nft_chain_validate_dependency(const struct nft_chain *chain,
 977                                   enum nft_chain_types type);
 978 int nft_chain_validate_hooks(const struct nft_chain *chain,
 979                              unsigned int hook_flags);
 980
 981 struct nft_stats {
 982         u64                     bytes;
 983         u64                     pkts;
 984         struct u64_stats_sync   syncp;
 985 };
 986
 987 struct nft_hook {
 988         struct list_head        list;
 989         struct nf_hook_ops      ops;
 990         struct rcu_head         rcu;
 991 };
 992
 993 /**
 994  *      struct nft_base_chain - nf_tables base chain
 995  *
 996  *      @ops: netfilter hook ops
 997  *      @hook_list: list of netfilter hooks (for NFPROTO_NETDEV family)
 998  *      @type: chain type
 999  *      @policy: default policy
1000  *      @stats: per-cpu chain stats
1001  *      @chain: the chain
1002  *      @flow_block: flow block (for hardware offload)
1003  */
1004 struct nft_base_chain {
1005         struct nf_hook_ops              ops;
1006         struct list_head                hook_list;
1007         const struct nft_chain_type     *type;
1008         u8                              policy;
1009         u8                              flags;
1010         struct nft_stats __percpu       *stats;
1011         struct nft_chain                chain;
1012         struct flow_block               flow_block;
1013 };
1014
1015 static inline struct nft_base_chain *nft_base_chain(const struct nft_chain *chain)
1016 {
1017         return container_of(chain, struct nft_base_chain, chain);
1018 }
1019
1020 static inline bool nft_is_base_chain(const struct nft_chain *chain)
1021 {
1022         return chain->flags & NFT_BASE_CHAIN;
1023 }
1024
1025 int __nft_release_basechain(struct nft_ctx *ctx);
1026
1027 unsigned int nft_do_chain(struct nft_pktinfo *pkt, void *priv);
1028
1029 /**
1030  *      struct nft_table - nf_tables table
1031  *
1032  *      @list: used internally
1033  *      @chains_ht: chains in the table
1034  *      @chains: same, for stable walks
1035  *      @sets: sets in the table
1036  *      @objects: stateful objects in the table
1037  *      @flowtables: flow tables in the table
1038  *      @hgenerator: handle generator state
1039  *      @handle: table handle
1040  *      @use: number of chain references to this table
1041  *      @flags: table flag (see enum nft_table_flags)
1042  *      @genmask: generation mask
1043  *      @afinfo: address family info
1044  *      @name: name of the table
1045  */
1046 struct nft_table {
1047         struct list_head                list;
1048         struct rhltable                 chains_ht;
1049         struct list_head                chains;
1050         struct list_head                sets;
1051         struct list_head                objects;
1052         struct list_head                flowtables;
1053         u64                             hgenerator;
1054         u64                             handle;
1055         u32                             use;
1056         u16                             family:6,
1057                                         flags:8,
1058                                         genmask:2;
1059         char                            *name;
1060 };
1061
1062 void nft_register_chain_type(const struct nft_chain_type *);
1063 void nft_unregister_chain_type(const struct nft_chain_type *);
1064
1065 int nft_register_expr(struct nft_expr_type *);
1066 void nft_unregister_expr(struct nft_expr_type *);
1067
1068 int nft_verdict_dump(struct sk_buff *skb, int type,
1069                      const struct nft_verdict *v);
1070
1071 /**
1072  *      struct nft_object_hash_key - key to lookup nft_object
1073  *
1074  *      @name: name of the stateful object to look up
1075  *      @table: table the object belongs to
1076  */
1077 struct nft_object_hash_key {
1078         const char                      *name;
1079         const struct nft_table          *table;
1080 };
1081
1082 /**
1083  *      struct nft_object - nf_tables stateful object
1084  *
1085  *      @list: table stateful object list node
1086  *      @key:  keys that identify this object
1087  *      @rhlhead: nft_objname_ht node
1088  *      @genmask: generation mask
1089  *      @use: number of references to this stateful object
1090  *      @handle: unique object handle
1091  *      @ops: object operations
1092  *      @data: object data, layout depends on type
1093  */
1094 struct nft_object {
1095         struct list_head                list;
1096         struct rhlist_head              rhlhead;
1097         struct nft_object_hash_key      key;
1098         u32                             genmask:2,
1099                                         use:30;
1100         u64                             handle;
1101         /* runtime data below here */
1102         const struct nft_object_ops     *ops ____cacheline_aligned;
1103         unsigned char                   data[]
1104                 __attribute__((aligned(__alignof__(u64))));
1105 };
1106
1107 static inline void *nft_obj_data(const struct nft_object *obj)
1108 {
1109         return (void *)obj->data;
1110 }
1111
1112 #define nft_expr_obj(expr)      *((struct nft_object **)nft_expr_priv(expr))
1113
1114 struct nft_object *nft_obj_lookup(const struct net *net,
1115                                   const struct nft_table *table,
1116                                   const struct nlattr *nla, u32 objtype,
1117                                   u8 genmask);
1118
1119 void nft_obj_notify(struct net *net, const struct nft_table *table,
1120                     struct nft_object *obj, u32 portid, u32 seq,
1121                     int event, int family, int report, gfp_t gfp);
1122
1123 /**
1124  *      struct nft_object_type - stateful object type
1125  *
1126  *      @select_ops: function to select nft_object_ops
1127  *      @ops: default ops, used when no select_ops functions is present
1128  *      @list: list node in list of object types
1129  *      @type: stateful object numeric type
1130  *      @owner: module owner
1131  *      @maxattr: maximum netlink attribute
1132  *      @policy: netlink attribute policy
1133  */
1134 struct nft_object_type {
1135         const struct nft_object_ops     *(*select_ops)(const struct nft_ctx *,
1136                                                        const struct nlattr * const tb[]);
1137         const struct nft_object_ops     *ops;
1138         struct list_head                list;
1139         u32                             type;
1140         unsigned int                    maxattr;
1141         struct module                   *owner;
1142         const struct nla_policy         *policy;
1143 };
1144
1145 /**
1146  *      struct nft_object_ops - stateful object operations
1147  *
1148  *      @eval: stateful object evaluation function
1149  *      @size: stateful object size
1150  *      @init: initialize object from netlink attributes
1151  *      @destroy: release existing stateful object
1152  *      @dump: netlink dump stateful object
1153  *      @update: update stateful object
1154  */
1155 struct nft_object_ops {
1156         void                            (*eval)(struct nft_object *obj,
1157                                                 struct nft_regs *regs,
1158                                                 const struct nft_pktinfo *pkt);
1159         unsigned int                    size;
1160         int                             (*init)(const struct nft_ctx *ctx,
1161                                                 const struct nlattr *const tb[],
1162                                                 struct nft_object *obj);
1163         void                            (*destroy)(const struct nft_ctx *ctx,
1164                                                    struct nft_object *obj);
1165         int                             (*dump)(struct sk_buff *skb,
1166                                                 struct nft_object *obj,
1167                                                 bool reset);
1168         void                            (*update)(struct nft_object *obj,
1169                                                   struct nft_object *newobj);
1170         const struct nft_object_type    *type;
1171 };
1172
1173 int nft_register_obj(struct nft_object_type *obj_type);
1174 void nft_unregister_obj(struct nft_object_type *obj_type);
1175
1176 #define NFT_NETDEVICE_MAX       256
1177
1178 /**
1179  *      struct nft_flowtable - nf_tables flow table
1180  *
1181  *      @list: flow table list node in table list
1182  *      @table: the table the flow table is contained in
1183  *      @name: name of this flow table
1184  *      @hooknum: hook number
1185  *      @ops_len: number of hooks in array
1186  *      @genmask: generation mask
1187  *      @use: number of references to this flow table
1188  *      @handle: unique object handle
1189  *      @dev_name: array of device names
1190  *      @data: rhashtable and garbage collector
1191  *      @ops: array of hooks
1192  */
1193 struct nft_flowtable {
1194         struct list_head                list;
1195         struct nft_table                *table;
1196         char                            *name;
1197         int                             hooknum;
1198         int                             ops_len;
1199         u32                             genmask:2,
1200                                         use:30;
1201         u64                             handle;
1202         /* runtime data below here */
1203         struct list_head                hook_list ____cacheline_aligned;
1204         struct nf_flowtable             data;
1205 };
1206
1207 struct nft_flowtable *nft_flowtable_lookup(const struct nft_table *table,
1208                                            const struct nlattr *nla,
1209                                            u8 genmask);
1210
1211 void nf_tables_deactivate_flowtable(const struct nft_ctx *ctx,
1212                                     struct nft_flowtable *flowtable,
1213                                     enum nft_trans_phase phase);
1214
1215 void nft_register_flowtable_type(struct nf_flowtable_type *type);
1216 void nft_unregister_flowtable_type(struct nf_flowtable_type *type);
1217
1218 /**
1219  *      struct nft_traceinfo - nft tracing information and state
1220  *
1221  *      @pkt: pktinfo currently processed
1222  *      @basechain: base chain currently processed
1223  *      @chain: chain currently processed
1224  *      @rule:  rule that was evaluated
1225  *      @verdict: verdict given by rule
1226  *      @type: event type (enum nft_trace_types)
1227  *      @packet_dumped: packet headers sent in a previous traceinfo message
1228  *      @trace: other struct members are initialised
1229  */
1230 struct nft_traceinfo {
1231         const struct nft_pktinfo        *pkt;
1232         const struct nft_base_chain     *basechain;
1233         const struct nft_chain          *chain;
1234         const struct nft_rule           *rule;
1235         const struct nft_verdict        *verdict;
1236         enum nft_trace_types            type;
1237         bool                            packet_dumped;
1238         bool                            trace;
1239 };
1240
1241 void nft_trace_init(struct nft_traceinfo *info, const struct nft_pktinfo *pkt,
1242                     const struct nft_verdict *verdict,
1243                     const struct nft_chain *basechain);
1244
1245 void nft_trace_notify(struct nft_traceinfo *info);
1246
1247 #define MODULE_ALIAS_NFT_CHAIN(family, name) \
1248         MODULE_ALIAS("nft-chain-" __stringify(family) "-" name)
1249
1250 #define MODULE_ALIAS_NFT_AF_EXPR(family, name) \
1251         MODULE_ALIAS("nft-expr-" __stringify(family) "-" name)
1252
1253 #define MODULE_ALIAS_NFT_EXPR(name) \
1254         MODULE_ALIAS("nft-expr-" name)
1255
1256 #define MODULE_ALIAS_NFT_SET() \
1257         MODULE_ALIAS("nft-set")
1258
1259 #define MODULE_ALIAS_NFT_OBJ(type) \
1260         MODULE_ALIAS("nft-obj-" __stringify(type))
1261
1262 #if IS_ENABLED(CONFIG_NF_TABLES)
1263
1264 /*
1265  * The gencursor defines two generations, the currently active and the
1266  * next one. Objects contain a bitmask of 2 bits specifying the generations
1267  * they're active in. A set bit means they're inactive in the generation
1268  * represented by that bit.
1269  *
1270  * New objects start out as inactive in the current and active in the
1271  * next generation. When committing the ruleset the bitmask is cleared,
1272  * meaning they're active in all generations. When removing an object,
1273  * it is set inactive in the next generation. After committing the ruleset,
1274  * the objects are removed.
1275  */
1276 static inline unsigned int nft_gencursor_next(const struct net *net)
1277 {
1278         return net->nft.gencursor + 1 == 1 ? 1 : 0;
1279 }
1280
1281 static inline u8 nft_genmask_next(const struct net *net)
1282 {
1283         return 1 << nft_gencursor_next(net);
1284 }
1285
1286 static inline u8 nft_genmask_cur(const struct net *net)
1287 {
1288         /* Use READ_ONCE() to prevent refetching the value for atomicity */
1289         return 1 << READ_ONCE(net->nft.gencursor);
1290 }
1291
1292 #define NFT_GENMASK_ANY         ((1 << 0) | (1 << 1))
1293
1294 /*
1295  * Generic transaction helpers
1296  */
1297
1298 /* Check if this object is currently active. */
1299 #define nft_is_active(__net, __obj)                             \
1300         (((__obj)->genmask & nft_genmask_cur(__net)) == 0)
1301
1302 /* Check if this object is active in the next generation. */
1303 #define nft_is_active_next(__net, __obj)                        \
1304         (((__obj)->genmask & nft_genmask_next(__net)) == 0)
1305
1306 /* This object becomes active in the next generation. */
1307 #define nft_activate_next(__net, __obj)                         \
1308         (__obj)->genmask = nft_genmask_cur(__net)
1309
1310 /* This object becomes inactive in the next generation. */
1311 #define nft_deactivate_next(__net, __obj)                       \
1312         (__obj)->genmask = nft_genmask_next(__net)
1313
1314 /* After committing the ruleset, clear the stale generation bit. */
1315 #define nft_clear(__net, __obj)                                 \
1316         (__obj)->genmask &= ~nft_genmask_next(__net)
1317 #define nft_active_genmask(__obj, __genmask)                    \
1318         !((__obj)->genmask & __genmask)
1319
1320 /*
1321  * Set element transaction helpers
1322  */
1323
1324 static inline bool nft_set_elem_active(const struct nft_set_ext *ext,
1325                                        u8 genmask)
1326 {
1327         return !(ext->genmask & genmask);
1328 }
1329
1330 static inline void nft_set_elem_change_active(const struct net *net,
1331                                               const struct nft_set *set,
1332                                               struct nft_set_ext *ext)
1333 {
1334         ext->genmask ^= nft_genmask_next(net);
1335 }
1336
1337 #endif /* IS_ENABLED(CONFIG_NF_TABLES) */
1338
1339 /*
1340  * We use a free bit in the genmask field to indicate the element
1341  * is busy, meaning it is currently being processed either by
1342  * the netlink API or GC.
1343  *
1344  * Even though the genmask is only a single byte wide, this works
1345  * because the extension structure if fully constant once initialized,
1346  * so there are no non-atomic write accesses unless it is already
1347  * marked busy.
1348  */
1349 #define NFT_SET_ELEM_BUSY_MASK  (1 << 2)
1350
1351 #if defined(__LITTLE_ENDIAN_BITFIELD)
1352 #define NFT_SET_ELEM_BUSY_BIT   2
1353 #elif defined(__BIG_ENDIAN_BITFIELD)
1354 #define NFT_SET_ELEM_BUSY_BIT   (BITS_PER_LONG - BITS_PER_BYTE + 2)
1355 #else
1356 #error
1357 #endif
1358
1359 static inline int nft_set_elem_mark_busy(struct nft_set_ext *ext)
1360 {
1361         unsigned long *word = (unsigned long *)ext;
1362
1363         BUILD_BUG_ON(offsetof(struct nft_set_ext, genmask) != 0);
1364         return test_and_set_bit(NFT_SET_ELEM_BUSY_BIT, word);
1365 }
1366
1367 static inline void nft_set_elem_clear_busy(struct nft_set_ext *ext)
1368 {
1369         unsigned long *word = (unsigned long *)ext;
1370
1371         clear_bit(NFT_SET_ELEM_BUSY_BIT, word);
1372 }
1373
1374 /**
1375  *      struct nft_trans - nf_tables object update in transaction
1376  *
1377  *      @list: used internally
1378  *      @msg_type: message type
1379  *      @put_net: ctx->net needs to be put
1380  *      @ctx: transaction context
1381  *      @data: internal information related to the transaction
1382  */
1383 struct nft_trans {
1384         struct list_head                list;
1385         int                             msg_type;
1386         bool                            put_net;
1387         struct nft_ctx                  ctx;
1388         char                            data[0];
1389 };
1390
1391 struct nft_trans_rule {
1392         struct nft_rule                 *rule;
1393         struct nft_flow_rule            *flow;
1394         u32                             rule_id;
1395 };
1396
1397 #define nft_trans_rule(trans)   \
1398         (((struct nft_trans_rule *)trans->data)->rule)
1399 #define nft_trans_flow_rule(trans)      \
1400         (((struct nft_trans_rule *)trans->data)->flow)
1401 #define nft_trans_rule_id(trans)        \
1402         (((struct nft_trans_rule *)trans->data)->rule_id)
1403
1404 struct nft_trans_set {
1405         struct nft_set                  *set;
1406         u32                             set_id;
1407         bool                            bound;
1408 };
1409
1410 #define nft_trans_set(trans)    \
1411         (((struct nft_trans_set *)trans->data)->set)
1412 #define nft_trans_set_id(trans) \
1413         (((struct nft_trans_set *)trans->data)->set_id)
1414 #define nft_trans_set_bound(trans)      \
1415         (((struct nft_trans_set *)trans->data)->bound)
1416
1417 struct nft_trans_chain {
1418         bool                            update;
1419         char                            *name;
1420         struct nft_stats __percpu       *stats;
1421         u8                              policy;
1422 };
1423
1424 #define nft_trans_chain_update(trans)   \
1425         (((struct nft_trans_chain *)trans->data)->update)
1426 #define nft_trans_chain_name(trans)     \
1427         (((struct nft_trans_chain *)trans->data)->name)
1428 #define nft_trans_chain_stats(trans)    \
1429         (((struct nft_trans_chain *)trans->data)->stats)
1430 #define nft_trans_chain_policy(trans)   \
1431         (((struct nft_trans_chain *)trans->data)->policy)
1432
1433 struct nft_trans_table {
1434         bool                            update;
1435         bool                            enable;
1436 };
1437
1438 #define nft_trans_table_update(trans)   \
1439         (((struct nft_trans_table *)trans->data)->update)
1440 #define nft_trans_table_enable(trans)   \
1441         (((struct nft_trans_table *)trans->data)->enable)
1442
1443 struct nft_trans_elem {
1444         struct nft_set                  *set;
1445         struct nft_set_elem             elem;
1446         bool                            bound;
1447 };
1448
1449 #define nft_trans_elem_set(trans)       \
1450         (((struct nft_trans_elem *)trans->data)->set)
1451 #define nft_trans_elem(trans)   \
1452         (((struct nft_trans_elem *)trans->data)->elem)
1453 #define nft_trans_elem_set_bound(trans) \
1454         (((struct nft_trans_elem *)trans->data)->bound)
1455
1456 struct nft_trans_obj {
1457         struct nft_object               *obj;
1458         struct nft_object               *newobj;
1459         bool                            update;
1460 };
1461
1462 #define nft_trans_obj(trans)    \
1463         (((struct nft_trans_obj *)trans->data)->obj)
1464 #define nft_trans_obj_newobj(trans) \
1465         (((struct nft_trans_obj *)trans->data)->newobj)
1466 #define nft_trans_obj_update(trans)     \
1467         (((struct nft_trans_obj *)trans->data)->update)
1468
1469 struct nft_trans_flowtable {
1470         struct nft_flowtable            *flowtable;
1471 };
1472
1473 #define nft_trans_flowtable(trans)      \
1474         (((struct nft_trans_flowtable *)trans->data)->flowtable)
1475
1476 int __init nft_chain_filter_init(void);
1477 void nft_chain_filter_fini(void);
1478
1479 void __init nft_chain_route_init(void);
1480 void nft_chain_route_fini(void);
1481 #endif /* _NET_NF_TABLES_H */