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 #include <net/netns/generic.h>
  17
  18 #define NFT_MAX_HOOKS   (NF_INET_INGRESS + 1)
  19
  20 struct module;
  21
  22 #define NFT_JUMP_STACK_SIZE     16
  23
  24 enum {
  25         NFT_PKTINFO_L4PROTO     = (1 << 0),
  26         NFT_PKTINFO_INNER       = (1 << 1),
  27         NFT_PKTINFO_INNER_FULL  = (1 << 2),
  28 };
  29
  30 struct nft_pktinfo {
  31         struct sk_buff                  *skb;
  32         const struct nf_hook_state      *state;
  33         u8                              flags;
  34         u8                              tprot;
  35         u16                             fragoff;
  36         u16                             thoff;
  37         u16                             inneroff;
  38 };
  39
  40 static inline struct sock *nft_sk(const struct nft_pktinfo *pkt)
  41 {
  42         return pkt->state->sk;
  43 }
  44
  45 static inline unsigned int nft_thoff(const struct nft_pktinfo *pkt)
  46 {
  47         return pkt->thoff;
  48 }
  49
  50 static inline struct net *nft_net(const struct nft_pktinfo *pkt)
  51 {
  52         return pkt->state->net;
  53 }
  54
  55 static inline unsigned int nft_hook(const struct nft_pktinfo *pkt)
  56 {
  57         return pkt->state->hook;
  58 }
  59
  60 static inline u8 nft_pf(const struct nft_pktinfo *pkt)
  61 {
  62         return pkt->state->pf;
  63 }
  64
  65 static inline const struct net_device *nft_in(const struct nft_pktinfo *pkt)
  66 {
  67         return pkt->state->in;
  68 }
  69
  70 static inline const struct net_device *nft_out(const struct nft_pktinfo *pkt)
  71 {
  72         return pkt->state->out;
  73 }
  74
  75 static inline void nft_set_pktinfo(struct nft_pktinfo *pkt,
  76                                    struct sk_buff *skb,
  77                                    const struct nf_hook_state *state)
  78 {
  79         pkt->skb = skb;
  80         pkt->state = state;
  81 }
  82
  83 static inline void nft_set_pktinfo_unspec(struct nft_pktinfo *pkt)
  84 {
  85         pkt->flags = 0;
  86         pkt->tprot = 0;
  87         pkt->thoff = 0;
  88         pkt->fragoff = 0;
  89 }
  90
  91 /**
  92  *      struct nft_verdict - nf_tables verdict
  93  *
  94  *      @code: nf_tables/netfilter verdict code
  95  *      @chain: destination chain for NFT_JUMP/NFT_GOTO
  96  */
  97 struct nft_verdict {
  98         u32                             code;
  99         struct nft_chain                *chain;
 100 };
 101
 102 struct nft_data {
 103         union {
 104                 u32                     data[4];
 105                 struct nft_verdict      verdict;
 106         };
 107 } __attribute__((aligned(__alignof__(u64))));
 108
 109 #define NFT_REG32_NUM           20
 110
 111 /**
 112  *      struct nft_regs - nf_tables register set
 113  *
 114  *      @data: data registers
 115  *      @verdict: verdict register
 116  *
 117  *      The first four data registers alias to the verdict register.
 118  */
 119 struct nft_regs {
 120         union {
 121                 u32                     data[NFT_REG32_NUM];
 122                 struct nft_verdict      verdict;
 123         };
 124 };
 125
 126 struct nft_regs_track {
 127         struct {
 128                 const struct nft_expr           *selector;
 129                 const struct nft_expr           *bitwise;
 130                 u8                              num_reg;
 131         } regs[NFT_REG32_NUM];
 132
 133         const struct nft_expr                   *cur;
 134         const struct nft_expr                   *last;
 135 };
 136
 137 /* Store/load an u8, u16 or u64 integer to/from the u32 data register.
 138  *
 139  * Note, when using concatenations, register allocation happens at 32-bit
 140  * level. So for store instruction, pad the rest part with zero to avoid
 141  * garbage values.
 142  */
 143
 144 static inline void nft_reg_store8(u32 *dreg, u8 val)
 145 {
 146         *dreg = 0;
 147         *(u8 *)dreg = val;
 148 }
 149
 150 static inline u8 nft_reg_load8(const u32 *sreg)
 151 {
 152         return *(u8 *)sreg;
 153 }
 154
 155 static inline void nft_reg_store16(u32 *dreg, u16 val)
 156 {
 157         *dreg = 0;
 158         *(u16 *)dreg = val;
 159 }
 160
 161 static inline void nft_reg_store_be16(u32 *dreg, __be16 val)
 162 {
 163         nft_reg_store16(dreg, (__force __u16)val);
 164 }
 165
 166 static inline u16 nft_reg_load16(const u32 *sreg)
 167 {
 168         return *(u16 *)sreg;
 169 }
 170
 171 static inline __be16 nft_reg_load_be16(const u32 *sreg)
 172 {
 173         return (__force __be16)nft_reg_load16(sreg);
 174 }
 175
 176 static inline __be32 nft_reg_load_be32(const u32 *sreg)
 177 {
 178         return *(__force __be32 *)sreg;
 179 }
 180
 181 static inline void nft_reg_store64(u32 *dreg, u64 val)
 182 {
 183         put_unaligned(val, (u64 *)dreg);
 184 }
 185
 186 static inline u64 nft_reg_load64(const u32 *sreg)
 187 {
 188         return get_unaligned((u64 *)sreg);
 189 }
 190
 191 static inline void nft_data_copy(u32 *dst, const struct nft_data *src,
 192                                  unsigned int len)
 193 {
 194         if (len % NFT_REG32_SIZE)
 195                 dst[len / NFT_REG32_SIZE] = 0;
 196         memcpy(dst, src, len);
 197 }
 198
 199 /**
 200  *      struct nft_ctx - nf_tables rule/set context
 201  *
 202  *      @net: net namespace
 203  *      @table: the table the chain is contained in
 204  *      @chain: the chain the rule is contained in
 205  *      @nla: netlink attributes
 206  *      @portid: netlink portID of the original message
 207  *      @seq: netlink sequence number
 208  *      @family: protocol family
 209  *      @level: depth of the chains
 210  *      @report: notify via unicast netlink message
 211  */
 212 struct nft_ctx {
 213         struct net                      *net;
 214         struct nft_table                *table;
 215         struct nft_chain                *chain;
 216         const struct nlattr * const     *nla;
 217         u32                             portid;
 218         u32                             seq;
 219         u16                             flags;
 220         u8                              family;
 221         u8                              level;
 222         bool                            report;
 223 };
 224
 225 enum nft_data_desc_flags {
 226         NFT_DATA_DESC_SETELEM   = (1 << 0),
 227 };
 228
 229 struct nft_data_desc {
 230         enum nft_data_types             type;
 231         unsigned int                    size;
 232         unsigned int                    len;
 233         unsigned int                    flags;
 234 };
 235
 236 int nft_data_init(const struct nft_ctx *ctx, struct nft_data *data,
 237                   struct nft_data_desc *desc, const struct nlattr *nla);
 238 void nft_data_hold(const struct nft_data *data, enum nft_data_types type);
 239 void nft_data_release(const struct nft_data *data, enum nft_data_types type);
 240 int nft_data_dump(struct sk_buff *skb, int attr, const struct nft_data *data,
 241                   enum nft_data_types type, unsigned int len);
 242
 243 static inline enum nft_data_types nft_dreg_to_type(enum nft_registers reg)
 244 {
 245         return reg == NFT_REG_VERDICT ? NFT_DATA_VERDICT : NFT_DATA_VALUE;
 246 }
 247
 248 static inline enum nft_registers nft_type_to_reg(enum nft_data_types type)
 249 {
 250         return type == NFT_DATA_VERDICT ? NFT_REG_VERDICT : NFT_REG_1 * NFT_REG_SIZE / NFT_REG32_SIZE;
 251 }
 252
 253 int nft_parse_u32_check(const struct nlattr *attr, int max, u32 *dest);
 254 int nft_dump_register(struct sk_buff *skb, unsigned int attr, unsigned int reg);
 255
 256 int nft_parse_register_load(const struct nlattr *attr, u8 *sreg, u32 len);
 257 int nft_parse_register_store(const struct nft_ctx *ctx,
 258                              const struct nlattr *attr, u8 *dreg,
 259                              const struct nft_data *data,
 260                              enum nft_data_types type, unsigned int len);
 261
 262 /**
 263  *      struct nft_userdata - user defined data associated with an object
 264  *
 265  *      @len: length of the data
 266  *      @data: content
 267  *
 268  *      The presence of user data is indicated in an object specific fashion,
 269  *      so a length of zero can't occur and the value "len" indicates data
 270  *      of length len + 1.
 271  */
 272 struct nft_userdata {
 273         u8                      len;
 274         unsigned char           data[];
 275 };
 276
 277 /**
 278  *      struct nft_set_elem - generic representation of set elements
 279  *
 280  *      @key: element key
 281  *      @key_end: closing element key
 282  *      @priv: element private data and extensions
 283  */
 284 struct nft_set_elem {
 285         union {
 286                 u32             buf[NFT_DATA_VALUE_MAXLEN / sizeof(u32)];
 287                 struct nft_data val;
 288         } key;
 289         union {
 290                 u32             buf[NFT_DATA_VALUE_MAXLEN / sizeof(u32)];
 291                 struct nft_data val;
 292         } key_end;
 293         union {
 294                 u32             buf[NFT_DATA_VALUE_MAXLEN / sizeof(u32)];
 295                 struct nft_data val;
 296         } data;
 297         void                    *priv;
 298 };
 299
 300 struct nft_set;
 301 struct nft_set_iter {
 302         u8              genmask;
 303         unsigned int    count;
 304         unsigned int    skip;
 305         int             err;
 306         int             (*fn)(const struct nft_ctx *ctx,
 307                               struct nft_set *set,
 308                               const struct nft_set_iter *iter,
 309                               struct nft_set_elem *elem);
 310 };
 311
 312 /**
 313  *      struct nft_set_desc - description of set elements
 314  *
 315  *      @ktype: key type
 316  *      @klen: key length
 317  *      @dtype: data type
 318  *      @dlen: data length
 319  *      @objtype: object type
 320  *      @flags: flags
 321  *      @size: number of set elements
 322  *      @policy: set policy
 323  *      @gc_int: garbage collector interval
 324  *      @field_len: length of each field in concatenation, bytes
 325  *      @field_count: number of concatenated fields in element
 326  *      @expr: set must support for expressions
 327  */
 328 struct nft_set_desc {
 329         u32                     ktype;
 330         unsigned int            klen;
 331         u32                     dtype;
 332         unsigned int            dlen;
 333         u32                     objtype;
 334         unsigned int            size;
 335         u32                     policy;
 336         u32                     gc_int;
 337         u64                     timeout;
 338         u8                      field_len[NFT_REG32_COUNT];
 339         u8                      field_count;
 340         bool                    expr;
 341 };
 342
 343 /**
 344  *      enum nft_set_class - performance class
 345  *
 346  *      @NFT_LOOKUP_O_1: constant, O(1)
 347  *      @NFT_LOOKUP_O_LOG_N: logarithmic, O(log N)
 348  *      @NFT_LOOKUP_O_N: linear, O(N)
 349  */
 350 enum nft_set_class {
 351         NFT_SET_CLASS_O_1,
 352         NFT_SET_CLASS_O_LOG_N,
 353         NFT_SET_CLASS_O_N,
 354 };
 355
 356 /**
 357  *      struct nft_set_estimate - estimation of memory and performance
 358  *                                characteristics
 359  *
 360  *      @size: required memory
 361  *      @lookup: lookup performance class
 362  *      @space: memory class
 363  */
 364 struct nft_set_estimate {
 365         u64                     size;
 366         enum nft_set_class      lookup;
 367         enum nft_set_class      space;
 368 };
 369
 370 #define NFT_EXPR_MAXATTR                16
 371 #define NFT_EXPR_SIZE(size)             (sizeof(struct nft_expr) + \
 372                                          ALIGN(size, __alignof__(struct nft_expr)))
 373
 374 /**
 375  *      struct nft_expr - nf_tables expression
 376  *
 377  *      @ops: expression ops
 378  *      @data: expression private data
 379  */
 380 struct nft_expr {
 381         const struct nft_expr_ops       *ops;
 382         unsigned char                   data[]
 383                 __attribute__((aligned(__alignof__(u64))));
 384 };
 385
 386 static inline void *nft_expr_priv(const struct nft_expr *expr)
 387 {
 388         return (void *)expr->data;
 389 }
 390
 391 struct nft_expr_info;
 392
 393 int nft_expr_inner_parse(const struct nft_ctx *ctx, const struct nlattr *nla,
 394                          struct nft_expr_info *info);
 395 int nft_expr_clone(struct nft_expr *dst, struct nft_expr *src);
 396 void nft_expr_destroy(const struct nft_ctx *ctx, struct nft_expr *expr);
 397 int nft_expr_dump(struct sk_buff *skb, unsigned int attr,
 398                   const struct nft_expr *expr, bool reset);
 399 bool nft_expr_reduce_bitwise(struct nft_regs_track *track,
 400                              const struct nft_expr *expr);
 401
 402 struct nft_set_ext;
 403
 404 /**
 405  *      struct nft_set_ops - nf_tables set operations
 406  *
 407  *      @lookup: look up an element within the set
 408  *      @update: update an element if exists, add it if doesn't exist
 409  *      @delete: delete an element
 410  *      @insert: insert new element into set
 411  *      @activate: activate new element in the next generation
 412  *      @deactivate: lookup for element and deactivate it in the next generation
 413  *      @flush: deactivate element in the next generation
 414  *      @remove: remove element from set
 415  *      @walk: iterate over all set elements
 416  *      @get: get set elements
 417  *      @privsize: function to return size of set private data
 418  *      @init: initialize private data of new set instance
 419  *      @destroy: destroy private data of set instance
 420  *      @elemsize: element private size
 421  *
 422  *      Operations lookup, update and delete have simpler interfaces, are faster
 423  *      and currently only used in the packet path. All the rest are slower,
 424  *      control plane functions.
 425  */
 426 struct nft_set_ops {
 427         bool                            (*lookup)(const struct net *net,
 428                                                   const struct nft_set *set,
 429                                                   const u32 *key,
 430                                                   const struct nft_set_ext **ext);
 431         bool                            (*update)(struct nft_set *set,
 432                                                   const u32 *key,
 433                                                   void *(*new)(struct nft_set *,
 434                                                                const struct nft_expr *,
 435                                                                struct nft_regs *),
 436                                                   const struct nft_expr *expr,
 437                                                   struct nft_regs *regs,
 438                                                   const struct nft_set_ext **ext);
 439         bool                            (*delete)(const struct nft_set *set,
 440                                                   const u32 *key);
 441
 442         int                             (*insert)(const struct net *net,
 443                                                   const struct nft_set *set,
 444                                                   const struct nft_set_elem *elem,
 445                                                   struct nft_set_ext **ext);
 446         void                            (*activate)(const struct net *net,
 447                                                     const struct nft_set *set,
 448                                                     const struct nft_set_elem *elem);
 449         void *                          (*deactivate)(const struct net *net,
 450                                                       const struct nft_set *set,
 451                                                       const struct nft_set_elem *elem);
 452         bool                            (*flush)(const struct net *net,
 453                                                  const struct nft_set *set,
 454                                                  void *priv);
 455         void                            (*remove)(const struct net *net,
 456                                                   const struct nft_set *set,
 457                                                   const struct nft_set_elem *elem);
 458         void                            (*walk)(const struct nft_ctx *ctx,
 459                                                 struct nft_set *set,
 460                                                 struct nft_set_iter *iter);
 461         void *                          (*get)(const struct net *net,
 462                                                const struct nft_set *set,
 463                                                const struct nft_set_elem *elem,
 464                                                unsigned int flags);
 465         void                            (*commit)(const struct nft_set *set);
 466         void                            (*abort)(const struct nft_set *set);
 467         u64                             (*privsize)(const struct nlattr * const nla[],
 468                                                     const struct nft_set_desc *desc);
 469         bool                            (*estimate)(const struct nft_set_desc *desc,
 470                                                     u32 features,
 471                                                     struct nft_set_estimate *est);
 472         int                             (*init)(const struct nft_set *set,
 473                                                 const struct nft_set_desc *desc,
 474                                                 const struct nlattr * const nla[]);
 475         void                            (*destroy)(const struct nft_ctx *ctx,
 476                                                    const struct nft_set *set);
 477         void                            (*gc_init)(const struct nft_set *set);
 478
 479         unsigned int                    elemsize;
 480 };
 481
 482 /**
 483  *      struct nft_set_type - nf_tables set type
 484  *
 485  *      @ops: set ops for this type
 486  *      @features: features supported by the implementation
 487  */
 488 struct nft_set_type {
 489         const struct nft_set_ops        ops;
 490         u32                             features;
 491 };
 492 #define to_set_type(o) container_of(o, struct nft_set_type, ops)
 493
 494 struct nft_set_elem_expr {
 495         u8                              size;
 496         unsigned char                   data[]
 497                 __attribute__((aligned(__alignof__(struct nft_expr))));
 498 };
 499
 500 #define nft_setelem_expr_at(__elem_expr, __offset)                      \
 501         ((struct nft_expr *)&__elem_expr->data[__offset])
 502
 503 #define nft_setelem_expr_foreach(__expr, __elem_expr, __size)           \
 504         for (__expr = nft_setelem_expr_at(__elem_expr, 0), __size = 0;  \
 505              __size < (__elem_expr)->size;                              \
 506              __size += (__expr)->ops->size, __expr = ((void *)(__expr)) + (__expr)->ops->size)
 507
 508 #define NFT_SET_EXPR_MAX        2
 509
 510 /**
 511  *      struct nft_set - nf_tables set instance
 512  *
 513  *      @list: table set list node
 514  *      @bindings: list of set bindings
 515  *      @refs: internal refcounting for async set destruction
 516  *      @table: table this set belongs to
 517  *      @net: netnamespace this set belongs to
 518  *      @name: name of the set
 519  *      @handle: unique handle of the set
 520  *      @ktype: key type (numeric type defined by userspace, not used in the kernel)
 521  *      @dtype: data type (verdict or numeric type defined by userspace)
 522  *      @objtype: object type (see NFT_OBJECT_* definitions)
 523  *      @size: maximum set size
 524  *      @field_len: length of each field in concatenation, bytes
 525  *      @field_count: number of concatenated fields in element
 526  *      @use: number of rules references to this set
 527  *      @nelems: number of elements
 528  *      @ndeact: number of deactivated elements queued for removal
 529  *      @timeout: default timeout value in jiffies
 530  *      @gc_int: garbage collection interval in msecs
 531  *      @policy: set parameterization (see enum nft_set_policies)
 532  *      @udlen: user data length
 533  *      @udata: user data
 534  *      @expr: stateful expression
 535  *      @ops: set ops
 536  *      @flags: set flags
 537  *      @dead: set will be freed, never cleared
 538  *      @genmask: generation mask
 539  *      @klen: key length
 540  *      @dlen: data length
 541  *      @data: private set data
 542  */
 543 struct nft_set {
 544         struct list_head                list;
 545         struct list_head                bindings;
 546         refcount_t                      refs;
 547         struct nft_table                *table;
 548         possible_net_t                  net;
 549         char                            *name;
 550         u64                             handle;
 551         u32                             ktype;
 552         u32                             dtype;
 553         u32                             objtype;
 554         u32                             size;
 555         u8                              field_len[NFT_REG32_COUNT];
 556         u8                              field_count;
 557         u32                             use;
 558         atomic_t                        nelems;
 559         u32                             ndeact;
 560         u64                             timeout;
 561         u32                             gc_int;
 562         u16                             policy;
 563         u16                             udlen;
 564         unsigned char                   *udata;
 565         struct list_head                pending_update;
 566         /* runtime data below here */
 567         const struct nft_set_ops        *ops ____cacheline_aligned;
 568         u16                             flags:13,
 569                                         dead:1,
 570                                         genmask:2;
 571         u8                              klen;
 572         u8                              dlen;
 573         u8                              num_exprs;
 574         struct nft_expr                 *exprs[NFT_SET_EXPR_MAX];
 575         struct list_head                catchall_list;
 576         unsigned char                   data[]
 577                 __attribute__((aligned(__alignof__(u64))));
 578 };
 579
 580 static inline bool nft_set_is_anonymous(const struct nft_set *set)
 581 {
 582         return set->flags & NFT_SET_ANONYMOUS;
 583 }
 584
 585 static inline void *nft_set_priv(const struct nft_set *set)
 586 {
 587         return (void *)set->data;
 588 }
 589
 590 static inline bool nft_set_gc_is_pending(const struct nft_set *s)
 591 {
 592         return refcount_read(&s->refs) != 1;
 593 }
 594
 595 static inline struct nft_set *nft_set_container_of(const void *priv)
 596 {
 597         return (void *)priv - offsetof(struct nft_set, data);
 598 }
 599
 600 struct nft_set *nft_set_lookup_global(const struct net *net,
 601                                       const struct nft_table *table,
 602                                       const struct nlattr *nla_set_name,
 603                                       const struct nlattr *nla_set_id,
 604                                       u8 genmask);
 605
 606 struct nft_set_ext *nft_set_catchall_lookup(const struct net *net,
 607                                             const struct nft_set *set);
 608
 609 static inline unsigned long nft_set_gc_interval(const struct nft_set *set)
 610 {
 611         u32 gc_int = READ_ONCE(set->gc_int);
 612
 613         return gc_int ? msecs_to_jiffies(gc_int) : HZ;
 614 }
 615
 616 /**
 617  *      struct nft_set_binding - nf_tables set binding
 618  *
 619  *      @list: set bindings list node
 620  *      @chain: chain containing the rule bound to the set
 621  *      @flags: set action flags
 622  *
 623  *      A set binding contains all information necessary for validation
 624  *      of new elements added to a bound set.
 625  */
 626 struct nft_set_binding {
 627         struct list_head                list;
 628         const struct nft_chain          *chain;
 629         u32                             flags;
 630 };
 631
 632 enum nft_trans_phase;
 633 void nf_tables_activate_set(const struct nft_ctx *ctx, struct nft_set *set);
 634 void nf_tables_deactivate_set(const struct nft_ctx *ctx, struct nft_set *set,
 635                               struct nft_set_binding *binding,
 636                               enum nft_trans_phase phase);
 637 int nf_tables_bind_set(const struct nft_ctx *ctx, struct nft_set *set,
 638                        struct nft_set_binding *binding);
 639 void nf_tables_destroy_set(const struct nft_ctx *ctx, struct nft_set *set);
 640
 641 /**
 642  *      enum nft_set_extensions - set extension type IDs
 643  *
 644  *      @NFT_SET_EXT_KEY: element key
 645  *      @NFT_SET_EXT_KEY_END: upper bound element key, for ranges
 646  *      @NFT_SET_EXT_DATA: mapping data
 647  *      @NFT_SET_EXT_FLAGS: element flags
 648  *      @NFT_SET_EXT_TIMEOUT: element timeout
 649  *      @NFT_SET_EXT_EXPIRATION: element expiration time
 650  *      @NFT_SET_EXT_USERDATA: user data associated with the element
 651  *      @NFT_SET_EXT_EXPRESSIONS: expressions assiciated with the element
 652  *      @NFT_SET_EXT_OBJREF: stateful object reference associated with element
 653  *      @NFT_SET_EXT_NUM: number of extension types
 654  */
 655 enum nft_set_extensions {
 656         NFT_SET_EXT_KEY,
 657         NFT_SET_EXT_KEY_END,
 658         NFT_SET_EXT_DATA,
 659         NFT_SET_EXT_FLAGS,
 660         NFT_SET_EXT_TIMEOUT,
 661         NFT_SET_EXT_EXPIRATION,
 662         NFT_SET_EXT_USERDATA,
 663         NFT_SET_EXT_EXPRESSIONS,
 664         NFT_SET_EXT_OBJREF,
 665         NFT_SET_EXT_NUM
 666 };
 667
 668 /**
 669  *      struct nft_set_ext_type - set extension type
 670  *
 671  *      @len: fixed part length of the extension
 672  *      @align: alignment requirements of the extension
 673  */
 674 struct nft_set_ext_type {
 675         u8      len;
 676         u8      align;
 677 };
 678
 679 extern const struct nft_set_ext_type nft_set_ext_types[];
 680
 681 /**
 682  *      struct nft_set_ext_tmpl - set extension template
 683  *
 684  *      @len: length of extension area
 685  *      @offset: offsets of individual extension types
 686  */
 687 struct nft_set_ext_tmpl {
 688         u16     len;
 689         u8      offset[NFT_SET_EXT_NUM];
 690         u8      ext_len[NFT_SET_EXT_NUM];
 691 };
 692
 693 /**
 694  *      struct nft_set_ext - set extensions
 695  *
 696  *      @genmask: generation mask
 697  *      @offset: offsets of individual extension types
 698  *      @data: beginning of extension data
 699  */
 700 struct nft_set_ext {
 701         u8      genmask;
 702         u8      offset[NFT_SET_EXT_NUM];
 703         char    data[];
 704 };
 705
 706 static inline void nft_set_ext_prepare(struct nft_set_ext_tmpl *tmpl)
 707 {
 708         memset(tmpl, 0, sizeof(*tmpl));
 709         tmpl->len = sizeof(struct nft_set_ext);
 710 }
 711
 712 static inline int nft_set_ext_add_length(struct nft_set_ext_tmpl *tmpl, u8 id,
 713                                          unsigned int len)
 714 {
 715         tmpl->len        = ALIGN(tmpl->len, nft_set_ext_types[id].align);
 716         if (tmpl->len > U8_MAX)
 717                 return -EINVAL;
 718
 719         tmpl->offset[id] = tmpl->len;
 720         tmpl->ext_len[id] = nft_set_ext_types[id].len + len;
 721         tmpl->len       += tmpl->ext_len[id];
 722
 723         return 0;
 724 }
 725
 726 static inline int nft_set_ext_add(struct nft_set_ext_tmpl *tmpl, u8 id)
 727 {
 728         return nft_set_ext_add_length(tmpl, id, 0);
 729 }
 730
 731 static inline void nft_set_ext_init(struct nft_set_ext *ext,
 732                                     const struct nft_set_ext_tmpl *tmpl)
 733 {
 734         memcpy(ext->offset, tmpl->offset, sizeof(ext->offset));
 735 }
 736
 737 static inline bool __nft_set_ext_exists(const struct nft_set_ext *ext, u8 id)
 738 {
 739         return !!ext->offset[id];
 740 }
 741
 742 static inline bool nft_set_ext_exists(const struct nft_set_ext *ext, u8 id)
 743 {
 744         return ext && __nft_set_ext_exists(ext, id);
 745 }
 746
 747 static inline void *nft_set_ext(const struct nft_set_ext *ext, u8 id)
 748 {
 749         return (void *)ext + ext->offset[id];
 750 }
 751
 752 static inline struct nft_data *nft_set_ext_key(const struct nft_set_ext *ext)
 753 {
 754         return nft_set_ext(ext, NFT_SET_EXT_KEY);
 755 }
 756
 757 static inline struct nft_data *nft_set_ext_key_end(const struct nft_set_ext *ext)
 758 {
 759         return nft_set_ext(ext, NFT_SET_EXT_KEY_END);
 760 }
 761
 762 static inline struct nft_data *nft_set_ext_data(const struct nft_set_ext *ext)
 763 {
 764         return nft_set_ext(ext, NFT_SET_EXT_DATA);
 765 }
 766
 767 static inline u8 *nft_set_ext_flags(const struct nft_set_ext *ext)
 768 {
 769         return nft_set_ext(ext, NFT_SET_EXT_FLAGS);
 770 }
 771
 772 static inline u64 *nft_set_ext_timeout(const struct nft_set_ext *ext)
 773 {
 774         return nft_set_ext(ext, NFT_SET_EXT_TIMEOUT);
 775 }
 776
 777 static inline u64 *nft_set_ext_expiration(const struct nft_set_ext *ext)
 778 {
 779         return nft_set_ext(ext, NFT_SET_EXT_EXPIRATION);
 780 }
 781
 782 static inline struct nft_userdata *nft_set_ext_userdata(const struct nft_set_ext *ext)
 783 {
 784         return nft_set_ext(ext, NFT_SET_EXT_USERDATA);
 785 }
 786
 787 static inline struct nft_set_elem_expr *nft_set_ext_expr(const struct nft_set_ext *ext)
 788 {
 789         return nft_set_ext(ext, NFT_SET_EXT_EXPRESSIONS);
 790 }
 791
 792 static inline bool nft_set_elem_expired(const struct nft_set_ext *ext)
 793 {
 794         return nft_set_ext_exists(ext, NFT_SET_EXT_EXPIRATION) &&
 795                time_is_before_eq_jiffies64(*nft_set_ext_expiration(ext));
 796 }
 797
 798 static inline struct nft_set_ext *nft_set_elem_ext(const struct nft_set *set,
 799                                                    void *elem)
 800 {
 801         return elem + set->ops->elemsize;
 802 }
 803
 804 static inline struct nft_object **nft_set_ext_obj(const struct nft_set_ext *ext)
 805 {
 806         return nft_set_ext(ext, NFT_SET_EXT_OBJREF);
 807 }
 808
 809 struct nft_expr *nft_set_elem_expr_alloc(const struct nft_ctx *ctx,
 810                                          const struct nft_set *set,
 811                                          const struct nlattr *attr);
 812
 813 void *nft_set_elem_init(const struct nft_set *set,
 814                         const struct nft_set_ext_tmpl *tmpl,
 815                         const u32 *key, const u32 *key_end, const u32 *data,
 816                         u64 timeout, u64 expiration, gfp_t gfp);
 817 int nft_set_elem_expr_clone(const struct nft_ctx *ctx, struct nft_set *set,
 818                             struct nft_expr *expr_array[]);
 819 void nft_set_elem_destroy(const struct nft_set *set, void *elem,
 820                           bool destroy_expr);
 821 void nf_tables_set_elem_destroy(const struct nft_ctx *ctx,
 822                                 const struct nft_set *set, void *elem);
 823
 824 struct nft_expr_ops;
 825 /**
 826  *      struct nft_expr_type - nf_tables expression type
 827  *
 828  *      @select_ops: function to select nft_expr_ops
 829  *      @release_ops: release nft_expr_ops
 830  *      @ops: default ops, used when no select_ops functions is present
 831  *      @list: used internally
 832  *      @name: Identifier
 833  *      @owner: module reference
 834  *      @policy: netlink attribute policy
 835  *      @maxattr: highest netlink attribute number
 836  *      @family: address family for AF-specific types
 837  *      @flags: expression type flags
 838  */
 839 struct nft_expr_type {
 840         const struct nft_expr_ops       *(*select_ops)(const struct nft_ctx *,
 841                                                        const struct nlattr * const tb[]);
 842         void                            (*release_ops)(const struct nft_expr_ops *ops);
 843         const struct nft_expr_ops       *ops;
 844         const struct nft_expr_ops       *inner_ops;
 845         struct list_head                list;
 846         const char                      *name;
 847         struct module                   *owner;
 848         const struct nla_policy         *policy;
 849         unsigned int                    maxattr;
 850         u8                              family;
 851         u8                              flags;
 852 };
 853
 854 #define NFT_EXPR_STATEFUL               0x1
 855 #define NFT_EXPR_GC                     0x2
 856
 857 enum nft_trans_phase {
 858         NFT_TRANS_PREPARE,
 859         NFT_TRANS_PREPARE_ERROR,
 860         NFT_TRANS_ABORT,
 861         NFT_TRANS_COMMIT,
 862         NFT_TRANS_RELEASE
 863 };
 864
 865 struct nft_flow_rule;
 866 struct nft_offload_ctx;
 867
 868 /**
 869  *      struct nft_expr_ops - nf_tables expression operations
 870  *
 871  *      @eval: Expression evaluation function
 872  *      @size: full expression size, including private data size
 873  *      @init: initialization function
 874  *      @activate: activate expression in the next generation
 875  *      @deactivate: deactivate expression in next generation
 876  *      @destroy: destruction function, called after synchronize_rcu
 877  *      @dump: function to dump parameters
 878  *      @type: expression type
 879  *      @validate: validate expression, called during loop detection
 880  *      @data: extra data to attach to this expression operation
 881  */
 882 struct nft_expr_ops {
 883         void                            (*eval)(const struct nft_expr *expr,
 884                                                 struct nft_regs *regs,
 885                                                 const struct nft_pktinfo *pkt);
 886         int                             (*clone)(struct nft_expr *dst,
 887                                                  const struct nft_expr *src);
 888         unsigned int                    size;
 889
 890         int                             (*init)(const struct nft_ctx *ctx,
 891                                                 const struct nft_expr *expr,
 892                                                 const struct nlattr * const tb[]);
 893         void                            (*activate)(const struct nft_ctx *ctx,
 894                                                     const struct nft_expr *expr);
 895         void                            (*deactivate)(const struct nft_ctx *ctx,
 896                                                       const struct nft_expr *expr,
 897                                                       enum nft_trans_phase phase);
 898         void                            (*destroy)(const struct nft_ctx *ctx,
 899                                                    const struct nft_expr *expr);
 900         void                            (*destroy_clone)(const struct nft_ctx *ctx,
 901                                                          const struct nft_expr *expr);
 902         int                             (*dump)(struct sk_buff *skb,
 903                                                 const struct nft_expr *expr,
 904                                                 bool reset);
 905         int                             (*validate)(const struct nft_ctx *ctx,
 906                                                     const struct nft_expr *expr,
 907                                                     const struct nft_data **data);
 908         bool                            (*reduce)(struct nft_regs_track *track,
 909                                                   const struct nft_expr *expr);
 910         bool                            (*gc)(struct net *net,
 911                                               const struct nft_expr *expr);
 912         int                             (*offload)(struct nft_offload_ctx *ctx,
 913                                                    struct nft_flow_rule *flow,
 914                                                    const struct nft_expr *expr);
 915         bool                            (*offload_action)(const struct nft_expr *expr);
 916         void                            (*offload_stats)(struct nft_expr *expr,
 917                                                          const struct flow_stats *stats);
 918         const struct nft_expr_type      *type;
 919         void                            *data;
 920 };
 921
 922 /**
 923  *      struct nft_rule - nf_tables rule
 924  *
 925  *      @list: used internally
 926  *      @handle: rule handle
 927  *      @genmask: generation mask
 928  *      @dlen: length of expression data
 929  *      @udata: user data is appended to the rule
 930  *      @data: expression data
 931  */
 932 struct nft_rule {
 933         struct list_head                list;
 934         u64                             handle:42,
 935                                         genmask:2,
 936                                         dlen:12,
 937                                         udata:1;
 938         unsigned char                   data[]
 939                 __attribute__((aligned(__alignof__(struct nft_expr))));
 940 };
 941
 942 static inline struct nft_expr *nft_expr_first(const struct nft_rule *rule)
 943 {
 944         return (struct nft_expr *)&rule->data[0];
 945 }
 946
 947 static inline struct nft_expr *nft_expr_next(const struct nft_expr *expr)
 948 {
 949         return ((void *)expr) + expr->ops->size;
 950 }
 951
 952 static inline struct nft_expr *nft_expr_last(const struct nft_rule *rule)
 953 {
 954         return (struct nft_expr *)&rule->data[rule->dlen];
 955 }
 956
 957 static inline bool nft_expr_more(const struct nft_rule *rule,
 958                                  const struct nft_expr *expr)
 959 {
 960         return expr != nft_expr_last(rule) && expr->ops;
 961 }
 962
 963 static inline struct nft_userdata *nft_userdata(const struct nft_rule *rule)
 964 {
 965         return (void *)&rule->data[rule->dlen];
 966 }
 967
 968 void nft_rule_expr_activate(const struct nft_ctx *ctx, struct nft_rule *rule);
 969 void nft_rule_expr_deactivate(const struct nft_ctx *ctx, struct nft_rule *rule,
 970                               enum nft_trans_phase phase);
 971 void nf_tables_rule_destroy(const struct nft_ctx *ctx, struct nft_rule *rule);
 972
 973 static inline void nft_set_elem_update_expr(const struct nft_set_ext *ext,
 974                                             struct nft_regs *regs,
 975                                             const struct nft_pktinfo *pkt)
 976 {
 977         struct nft_set_elem_expr *elem_expr;
 978         struct nft_expr *expr;
 979         u32 size;
 980
 981         if (__nft_set_ext_exists(ext, NFT_SET_EXT_EXPRESSIONS)) {
 982                 elem_expr = nft_set_ext_expr(ext);
 983                 nft_setelem_expr_foreach(expr, elem_expr, size) {
 984                         expr->ops->eval(expr, regs, pkt);
 985                         if (regs->verdict.code == NFT_BREAK)
 986                                 return;
 987                 }
 988         }
 989 }
 990
 991 /*
 992  * The last pointer isn't really necessary, but the compiler isn't able to
 993  * determine that the result of nft_expr_last() is always the same since it
 994  * can't assume that the dlen value wasn't changed within calls in the loop.
 995  */
 996 #define nft_rule_for_each_expr(expr, last, rule) \
 997         for ((expr) = nft_expr_first(rule), (last) = nft_expr_last(rule); \
 998              (expr) != (last); \
 999              (expr) = nft_expr_next(expr))
1000
1001 #define NFT_CHAIN_POLICY_UNSET          U8_MAX
1002
1003 struct nft_rule_dp {
1004         u64                             is_last:1,
1005                                         dlen:12,
1006                                         handle:42;      /* for tracing */
1007         unsigned char                   data[]
1008                 __attribute__((aligned(__alignof__(struct nft_expr))));
1009 };
1010
1011 struct nft_rule_dp_last {
1012         struct nft_rule_dp end;         /* end of nft_rule_blob marker */
1013         struct rcu_head h;              /* call_rcu head */
1014         struct nft_rule_blob *blob;     /* ptr to free via call_rcu */
1015         const struct nft_chain *chain;  /* for nftables tracing */
1016 };
1017
1018 static inline const struct nft_rule_dp *nft_rule_next(const struct nft_rule_dp *rule)
1019 {
1020         return (void *)rule + sizeof(*rule) + rule->dlen;
1021 }
1022
1023 struct nft_rule_blob {
1024         unsigned long                   size;
1025         unsigned char                   data[]
1026                 __attribute__((aligned(__alignof__(struct nft_rule_dp))));
1027 };
1028
1029 /**
1030  *      struct nft_chain - nf_tables chain
1031  *
1032  *      @rules: list of rules in the chain
1033  *      @list: used internally
1034  *      @rhlhead: used internally
1035  *      @table: table that this chain belongs to
1036  *      @handle: chain handle
1037  *      @use: number of jump references to this chain
1038  *      @flags: bitmask of enum nft_chain_flags
1039  *      @name: name of the chain
1040  */
1041 struct nft_chain {
1042         struct nft_rule_blob            __rcu *blob_gen_0;
1043         struct nft_rule_blob            __rcu *blob_gen_1;
1044         struct list_head                rules;
1045         struct list_head                list;
1046         struct rhlist_head              rhlhead;
1047         struct nft_table                *table;
1048         u64                             handle;
1049         u32                             use;
1050         u8                              flags:5,
1051                                         bound:1,
1052                                         genmask:2;
1053         char                            *name;
1054         u16                             udlen;
1055         u8                              *udata;
1056
1057         /* Only used during control plane commit phase: */
1058         struct nft_rule_blob            *blob_next;
1059 };
1060
1061 int nft_chain_validate(const struct nft_ctx *ctx, const struct nft_chain *chain);
1062 int nft_setelem_validate(const struct nft_ctx *ctx, struct nft_set *set,
1063                          const struct nft_set_iter *iter,
1064                          struct nft_set_elem *elem);
1065 int nft_set_catchall_validate(const struct nft_ctx *ctx, struct nft_set *set);
1066 int nf_tables_bind_chain(const struct nft_ctx *ctx, struct nft_chain *chain);
1067 void nf_tables_unbind_chain(const struct nft_ctx *ctx, struct nft_chain *chain);
1068
1069 enum nft_chain_types {
1070         NFT_CHAIN_T_DEFAULT = 0,
1071         NFT_CHAIN_T_ROUTE,
1072         NFT_CHAIN_T_NAT,
1073         NFT_CHAIN_T_MAX
1074 };
1075
1076 /**
1077  *      struct nft_chain_type - nf_tables chain type info
1078  *
1079  *      @name: name of the type
1080  *      @type: numeric identifier
1081  *      @family: address family
1082  *      @owner: module owner
1083  *      @hook_mask: mask of valid hooks
1084  *      @hooks: array of hook functions
1085  *      @ops_register: base chain register function
1086  *      @ops_unregister: base chain unregister function
1087  */
1088 struct nft_chain_type {
1089         const char                      *name;
1090         enum nft_chain_types            type;
1091         int                             family;
1092         struct module                   *owner;
1093         unsigned int                    hook_mask;
1094         nf_hookfn                       *hooks[NFT_MAX_HOOKS];
1095         int                             (*ops_register)(struct net *net, const struct nf_hook_ops *ops);
1096         void                            (*ops_unregister)(struct net *net, const struct nf_hook_ops *ops);
1097 };
1098
1099 int nft_chain_validate_dependency(const struct nft_chain *chain,
1100                                   enum nft_chain_types type);
1101 int nft_chain_validate_hooks(const struct nft_chain *chain,
1102                              unsigned int hook_flags);
1103
1104 static inline bool nft_chain_binding(const struct nft_chain *chain)
1105 {
1106         return chain->flags & NFT_CHAIN_BINDING;
1107 }
1108
1109 static inline bool nft_chain_is_bound(struct nft_chain *chain)
1110 {
1111         return (chain->flags & NFT_CHAIN_BINDING) && chain->bound;
1112 }
1113
1114 int nft_chain_add(struct nft_table *table, struct nft_chain *chain);
1115 void nft_chain_del(struct nft_chain *chain);
1116 void nf_tables_chain_destroy(struct nft_ctx *ctx);
1117
1118 struct nft_stats {
1119         u64                     bytes;
1120         u64                     pkts;
1121         struct u64_stats_sync   syncp;
1122 };
1123
1124 struct nft_hook {
1125         struct list_head        list;
1126         struct nf_hook_ops      ops;
1127         struct rcu_head         rcu;
1128 };
1129
1130 /**
1131  *      struct nft_base_chain - nf_tables base chain
1132  *
1133  *      @ops: netfilter hook ops
1134  *      @hook_list: list of netfilter hooks (for NFPROTO_NETDEV family)
1135  *      @type: chain type
1136  *      @policy: default policy
1137  *      @stats: per-cpu chain stats
1138  *      @chain: the chain
1139  *      @flow_block: flow block (for hardware offload)
1140  */
1141 struct nft_base_chain {
1142         struct nf_hook_ops              ops;
1143         struct list_head                hook_list;
1144         const struct nft_chain_type     *type;
1145         u8                              policy;
1146         u8                              flags;
1147         struct nft_stats __percpu       *stats;
1148         struct nft_chain                chain;
1149         struct flow_block               flow_block;
1150 };
1151
1152 static inline struct nft_base_chain *nft_base_chain(const struct nft_chain *chain)
1153 {
1154         return container_of(chain, struct nft_base_chain, chain);
1155 }
1156
1157 static inline bool nft_is_base_chain(const struct nft_chain *chain)
1158 {
1159         return chain->flags & NFT_CHAIN_BASE;
1160 }
1161
1162 int __nft_release_basechain(struct nft_ctx *ctx);
1163
1164 unsigned int nft_do_chain(struct nft_pktinfo *pkt, void *priv);
1165
1166 static inline bool nft_use_inc(u32 *use)
1167 {
1168         if (*use == UINT_MAX)
1169                 return false;
1170
1171         (*use)++;
1172
1173         return true;
1174 }
1175
1176 static inline void nft_use_dec(u32 *use)
1177 {
1178         WARN_ON_ONCE((*use)-- == 0);
1179 }
1180
1181 /* For error and abort path: restore use counter to previous state. */
1182 static inline void nft_use_inc_restore(u32 *use)
1183 {
1184         WARN_ON_ONCE(!nft_use_inc(use));
1185 }
1186
1187 #define nft_use_dec_restore     nft_use_dec
1188
1189 /**
1190  *      struct nft_table - nf_tables table
1191  *
1192  *      @list: used internally
1193  *      @chains_ht: chains in the table
1194  *      @chains: same, for stable walks
1195  *      @sets: sets in the table
1196  *      @objects: stateful objects in the table
1197  *      @flowtables: flow tables in the table
1198  *      @hgenerator: handle generator state
1199  *      @handle: table handle
1200  *      @use: number of chain references to this table
1201  *      @flags: table flag (see enum nft_table_flags)
1202  *      @genmask: generation mask
1203  *      @afinfo: address family info
1204  *      @name: name of the table
1205  *      @validate_state: internal, set when transaction adds jumps
1206  */
1207 struct nft_table {
1208         struct list_head                list;
1209         struct rhltable                 chains_ht;
1210         struct list_head                chains;
1211         struct list_head                sets;
1212         struct list_head                objects;
1213         struct list_head                flowtables;
1214         u64                             hgenerator;
1215         u64                             handle;
1216         u32                             use;
1217         u16                             family:6,
1218                                         flags:8,
1219                                         genmask:2;
1220         u32                             nlpid;
1221         char                            *name;
1222         u16                             udlen;
1223         u8                              *udata;
1224         u8                              validate_state;
1225 };
1226
1227 static inline bool nft_table_has_owner(const struct nft_table *table)
1228 {
1229         return table->flags & NFT_TABLE_F_OWNER;
1230 }
1231
1232 static inline bool nft_base_chain_netdev(int family, u32 hooknum)
1233 {
1234         return family == NFPROTO_NETDEV ||
1235                (family == NFPROTO_INET && hooknum == NF_INET_INGRESS);
1236 }
1237
1238 void nft_register_chain_type(const struct nft_chain_type *);
1239 void nft_unregister_chain_type(const struct nft_chain_type *);
1240
1241 int nft_register_expr(struct nft_expr_type *);
1242 void nft_unregister_expr(struct nft_expr_type *);
1243
1244 int nft_verdict_dump(struct sk_buff *skb, int type,
1245                      const struct nft_verdict *v);
1246
1247 /**
1248  *      struct nft_object_hash_key - key to lookup nft_object
1249  *
1250  *      @name: name of the stateful object to look up
1251  *      @table: table the object belongs to
1252  */
1253 struct nft_object_hash_key {
1254         const char                      *name;
1255         const struct nft_table          *table;
1256 };
1257
1258 /**
1259  *      struct nft_object - nf_tables stateful object
1260  *
1261  *      @list: table stateful object list node
1262  *      @key:  keys that identify this object
1263  *      @rhlhead: nft_objname_ht node
1264  *      @genmask: generation mask
1265  *      @use: number of references to this stateful object
1266  *      @handle: unique object handle
1267  *      @ops: object operations
1268  *      @data: object data, layout depends on type
1269  */
1270 struct nft_object {
1271         struct list_head                list;
1272         struct rhlist_head              rhlhead;
1273         struct nft_object_hash_key      key;
1274         u32                             genmask:2;
1275         u32                             use;
1276         u64                             handle;
1277         u16                             udlen;
1278         u8                              *udata;
1279         /* runtime data below here */
1280         const struct nft_object_ops     *ops ____cacheline_aligned;
1281         unsigned char                   data[]
1282                 __attribute__((aligned(__alignof__(u64))));
1283 };
1284
1285 static inline void *nft_obj_data(const struct nft_object *obj)
1286 {
1287         return (void *)obj->data;
1288 }
1289
1290 #define nft_expr_obj(expr)      *((struct nft_object **)nft_expr_priv(expr))
1291
1292 struct nft_object *nft_obj_lookup(const struct net *net,
1293                                   const struct nft_table *table,
1294                                   const struct nlattr *nla, u32 objtype,
1295                                   u8 genmask);
1296
1297 void nft_obj_notify(struct net *net, const struct nft_table *table,
1298                     struct nft_object *obj, u32 portid, u32 seq,
1299                     int event, u16 flags, int family, int report, gfp_t gfp);
1300
1301 /**
1302  *      struct nft_object_type - stateful object type
1303  *
1304  *      @select_ops: function to select nft_object_ops
1305  *      @ops: default ops, used when no select_ops functions is present
1306  *      @list: list node in list of object types
1307  *      @type: stateful object numeric type
1308  *      @owner: module owner
1309  *      @maxattr: maximum netlink attribute
1310  *      @policy: netlink attribute policy
1311  */
1312 struct nft_object_type {
1313         const struct nft_object_ops     *(*select_ops)(const struct nft_ctx *,
1314                                                        const struct nlattr * const tb[]);
1315         const struct nft_object_ops     *ops;
1316         struct list_head                list;
1317         u32                             type;
1318         unsigned int                    maxattr;
1319         struct module                   *owner;
1320         const struct nla_policy         *policy;
1321 };
1322
1323 /**
1324  *      struct nft_object_ops - stateful object operations
1325  *
1326  *      @eval: stateful object evaluation function
1327  *      @size: stateful object size
1328  *      @init: initialize object from netlink attributes
1329  *      @destroy: release existing stateful object
1330  *      @dump: netlink dump stateful object
1331  *      @update: update stateful object
1332  */
1333 struct nft_object_ops {
1334         void                            (*eval)(struct nft_object *obj,
1335                                                 struct nft_regs *regs,
1336                                                 const struct nft_pktinfo *pkt);
1337         unsigned int                    size;
1338         int                             (*init)(const struct nft_ctx *ctx,
1339                                                 const struct nlattr *const tb[],
1340                                                 struct nft_object *obj);
1341         void                            (*destroy)(const struct nft_ctx *ctx,
1342                                                    struct nft_object *obj);
1343         int                             (*dump)(struct sk_buff *skb,
1344                                                 struct nft_object *obj,
1345                                                 bool reset);
1346         void                            (*update)(struct nft_object *obj,
1347                                                   struct nft_object *newobj);
1348         const struct nft_object_type    *type;
1349 };
1350
1351 int nft_register_obj(struct nft_object_type *obj_type);
1352 void nft_unregister_obj(struct nft_object_type *obj_type);
1353
1354 #define NFT_NETDEVICE_MAX       256
1355
1356 /**
1357  *      struct nft_flowtable - nf_tables flow table
1358  *
1359  *      @list: flow table list node in table list
1360  *      @table: the table the flow table is contained in
1361  *      @name: name of this flow table
1362  *      @hooknum: hook number
1363  *      @ops_len: number of hooks in array
1364  *      @genmask: generation mask
1365  *      @use: number of references to this flow table
1366  *      @handle: unique object handle
1367  *      @dev_name: array of device names
1368  *      @data: rhashtable and garbage collector
1369  *      @ops: array of hooks
1370  */
1371 struct nft_flowtable {
1372         struct list_head                list;
1373         struct nft_table                *table;
1374         char                            *name;
1375         int                             hooknum;
1376         int                             ops_len;
1377         u32                             genmask:2;
1378         u32                             use;
1379         u64                             handle;
1380         /* runtime data below here */
1381         struct list_head                hook_list ____cacheline_aligned;
1382         struct nf_flowtable             data;
1383 };
1384
1385 struct nft_flowtable *nft_flowtable_lookup(const struct nft_table *table,
1386                                            const struct nlattr *nla,
1387                                            u8 genmask);
1388
1389 void nf_tables_deactivate_flowtable(const struct nft_ctx *ctx,
1390                                     struct nft_flowtable *flowtable,
1391                                     enum nft_trans_phase phase);
1392
1393 void nft_register_flowtable_type(struct nf_flowtable_type *type);
1394 void nft_unregister_flowtable_type(struct nf_flowtable_type *type);
1395
1396 /**
1397  *      struct nft_traceinfo - nft tracing information and state
1398  *
1399  *      @trace: other struct members are initialised
1400  *      @nf_trace: copy of skb->nf_trace before rule evaluation
1401  *      @type: event type (enum nft_trace_types)
1402  *      @skbid: hash of skb to be used as trace id
1403  *      @packet_dumped: packet headers sent in a previous traceinfo message
1404  *      @basechain: base chain currently processed
1405  */
1406 struct nft_traceinfo {
1407         bool                            trace;
1408         bool                            nf_trace;
1409         bool                            packet_dumped;
1410         enum nft_trace_types            type:8;
1411         u32                             skbid;
1412         const struct nft_base_chain     *basechain;
1413 };
1414
1415 void nft_trace_init(struct nft_traceinfo *info, const struct nft_pktinfo *pkt,
1416                     const struct nft_chain *basechain);
1417
1418 void nft_trace_notify(const struct nft_pktinfo *pkt,
1419                       const struct nft_verdict *verdict,
1420                       const struct nft_rule_dp *rule,
1421                       struct nft_traceinfo *info);
1422
1423 #define MODULE_ALIAS_NFT_CHAIN(family, name) \
1424         MODULE_ALIAS("nft-chain-" __stringify(family) "-" name)
1425
1426 #define MODULE_ALIAS_NFT_AF_EXPR(family, name) \
1427         MODULE_ALIAS("nft-expr-" __stringify(family) "-" name)
1428
1429 #define MODULE_ALIAS_NFT_EXPR(name) \
1430         MODULE_ALIAS("nft-expr-" name)
1431
1432 #define MODULE_ALIAS_NFT_OBJ(type) \
1433         MODULE_ALIAS("nft-obj-" __stringify(type))
1434
1435 #if IS_ENABLED(CONFIG_NF_TABLES)
1436
1437 /*
1438  * The gencursor defines two generations, the currently active and the
1439  * next one. Objects contain a bitmask of 2 bits specifying the generations
1440  * they're active in. A set bit means they're inactive in the generation
1441  * represented by that bit.
1442  *
1443  * New objects start out as inactive in the current and active in the
1444  * next generation. When committing the ruleset the bitmask is cleared,
1445  * meaning they're active in all generations. When removing an object,
1446  * it is set inactive in the next generation. After committing the ruleset,
1447  * the objects are removed.
1448  */
1449 static inline unsigned int nft_gencursor_next(const struct net *net)
1450 {
1451         return net->nft.gencursor + 1 == 1 ? 1 : 0;
1452 }
1453
1454 static inline u8 nft_genmask_next(const struct net *net)
1455 {
1456         return 1 << nft_gencursor_next(net);
1457 }
1458
1459 static inline u8 nft_genmask_cur(const struct net *net)
1460 {
1461         /* Use READ_ONCE() to prevent refetching the value for atomicity */
1462         return 1 << READ_ONCE(net->nft.gencursor);
1463 }
1464
1465 #define NFT_GENMASK_ANY         ((1 << 0) | (1 << 1))
1466
1467 /*
1468  * Generic transaction helpers
1469  */
1470
1471 /* Check if this object is currently active. */
1472 #define nft_is_active(__net, __obj)                             \
1473         (((__obj)->genmask & nft_genmask_cur(__net)) == 0)
1474
1475 /* Check if this object is active in the next generation. */
1476 #define nft_is_active_next(__net, __obj)                        \
1477         (((__obj)->genmask & nft_genmask_next(__net)) == 0)
1478
1479 /* This object becomes active in the next generation. */
1480 #define nft_activate_next(__net, __obj)                         \
1481         (__obj)->genmask = nft_genmask_cur(__net)
1482
1483 /* This object becomes inactive in the next generation. */
1484 #define nft_deactivate_next(__net, __obj)                       \
1485         (__obj)->genmask = nft_genmask_next(__net)
1486
1487 /* After committing the ruleset, clear the stale generation bit. */
1488 #define nft_clear(__net, __obj)                                 \
1489         (__obj)->genmask &= ~nft_genmask_next(__net)
1490 #define nft_active_genmask(__obj, __genmask)                    \
1491         !((__obj)->genmask & __genmask)
1492
1493 /*
1494  * Set element transaction helpers
1495  */
1496
1497 static inline bool nft_set_elem_active(const struct nft_set_ext *ext,
1498                                        u8 genmask)
1499 {
1500         return !(ext->genmask & genmask);
1501 }
1502
1503 static inline void nft_set_elem_change_active(const struct net *net,
1504                                               const struct nft_set *set,
1505                                               struct nft_set_ext *ext)
1506 {
1507         ext->genmask ^= nft_genmask_next(net);
1508 }
1509
1510 #endif /* IS_ENABLED(CONFIG_NF_TABLES) */
1511
1512 #define NFT_SET_ELEM_DEAD_MASK  (1 << 2)
1513
1514 #if defined(__LITTLE_ENDIAN_BITFIELD)
1515 #define NFT_SET_ELEM_DEAD_BIT   2
1516 #elif defined(__BIG_ENDIAN_BITFIELD)
1517 #define NFT_SET_ELEM_DEAD_BIT   (BITS_PER_LONG - BITS_PER_BYTE + 2)
1518 #else
1519 #error
1520 #endif
1521
1522 static inline void nft_set_elem_dead(struct nft_set_ext *ext)
1523 {
1524         unsigned long *word = (unsigned long *)ext;
1525
1526         BUILD_BUG_ON(offsetof(struct nft_set_ext, genmask) != 0);
1527         set_bit(NFT_SET_ELEM_DEAD_BIT, word);
1528 }
1529
1530 static inline int nft_set_elem_is_dead(const struct nft_set_ext *ext)
1531 {
1532         unsigned long *word = (unsigned long *)ext;
1533
1534         BUILD_BUG_ON(offsetof(struct nft_set_ext, genmask) != 0);
1535         return test_bit(NFT_SET_ELEM_DEAD_BIT, word);
1536 }
1537
1538 /**
1539  *      struct nft_trans - nf_tables object update in transaction
1540  *
1541  *      @list: used internally
1542  *      @binding_list: list of objects with possible bindings
1543  *      @msg_type: message type
1544  *      @put_net: ctx->net needs to be put
1545  *      @ctx: transaction context
1546  *      @data: internal information related to the transaction
1547  */
1548 struct nft_trans {
1549         struct list_head                list;
1550         struct list_head                binding_list;
1551         int                             msg_type;
1552         bool                            put_net;
1553         struct nft_ctx                  ctx;
1554         char                            data[];
1555 };
1556
1557 struct nft_trans_rule {
1558         struct nft_rule                 *rule;
1559         struct nft_flow_rule            *flow;
1560         u32                             rule_id;
1561         bool                            bound;
1562 };
1563
1564 #define nft_trans_rule(trans)   \
1565         (((struct nft_trans_rule *)trans->data)->rule)
1566 #define nft_trans_flow_rule(trans)      \
1567         (((struct nft_trans_rule *)trans->data)->flow)
1568 #define nft_trans_rule_id(trans)        \
1569         (((struct nft_trans_rule *)trans->data)->rule_id)
1570 #define nft_trans_rule_bound(trans)     \
1571         (((struct nft_trans_rule *)trans->data)->bound)
1572
1573 struct nft_trans_set {
1574         struct nft_set                  *set;
1575         u32                             set_id;
1576         u32                             gc_int;
1577         u64                             timeout;
1578         bool                            update;
1579         bool                            bound;
1580         u32                             size;
1581 };
1582
1583 #define nft_trans_set(trans)    \
1584         (((struct nft_trans_set *)trans->data)->set)
1585 #define nft_trans_set_id(trans) \
1586         (((struct nft_trans_set *)trans->data)->set_id)
1587 #define nft_trans_set_bound(trans)      \
1588         (((struct nft_trans_set *)trans->data)->bound)
1589 #define nft_trans_set_update(trans)     \
1590         (((struct nft_trans_set *)trans->data)->update)
1591 #define nft_trans_set_timeout(trans)    \
1592         (((struct nft_trans_set *)trans->data)->timeout)
1593 #define nft_trans_set_gc_int(trans)     \
1594         (((struct nft_trans_set *)trans->data)->gc_int)
1595 #define nft_trans_set_size(trans)       \
1596         (((struct nft_trans_set *)trans->data)->size)
1597
1598 struct nft_trans_chain {
1599         struct nft_chain                *chain;
1600         bool                            update;
1601         char                            *name;
1602         struct nft_stats __percpu       *stats;
1603         u8                              policy;
1604         bool                            bound;
1605         u32                             chain_id;
1606         struct nft_base_chain           *basechain;
1607         struct list_head                hook_list;
1608 };
1609
1610 #define nft_trans_chain(trans)  \
1611         (((struct nft_trans_chain *)trans->data)->chain)
1612 #define nft_trans_chain_update(trans)   \
1613         (((struct nft_trans_chain *)trans->data)->update)
1614 #define nft_trans_chain_name(trans)     \
1615         (((struct nft_trans_chain *)trans->data)->name)
1616 #define nft_trans_chain_stats(trans)    \
1617         (((struct nft_trans_chain *)trans->data)->stats)
1618 #define nft_trans_chain_policy(trans)   \
1619         (((struct nft_trans_chain *)trans->data)->policy)
1620 #define nft_trans_chain_bound(trans)    \
1621         (((struct nft_trans_chain *)trans->data)->bound)
1622 #define nft_trans_chain_id(trans)       \
1623         (((struct nft_trans_chain *)trans->data)->chain_id)
1624 #define nft_trans_basechain(trans)      \
1625         (((struct nft_trans_chain *)trans->data)->basechain)
1626 #define nft_trans_chain_hooks(trans)    \
1627         (((struct nft_trans_chain *)trans->data)->hook_list)
1628
1629 struct nft_trans_table {
1630         bool                            update;
1631 };
1632
1633 #define nft_trans_table_update(trans)   \
1634         (((struct nft_trans_table *)trans->data)->update)
1635
1636 struct nft_trans_elem {
1637         struct nft_set                  *set;
1638         struct nft_set_elem             elem;
1639         bool                            bound;
1640 };
1641
1642 #define nft_trans_elem_set(trans)       \
1643         (((struct nft_trans_elem *)trans->data)->set)
1644 #define nft_trans_elem(trans)   \
1645         (((struct nft_trans_elem *)trans->data)->elem)
1646 #define nft_trans_elem_set_bound(trans) \
1647         (((struct nft_trans_elem *)trans->data)->bound)
1648
1649 struct nft_trans_obj {
1650         struct nft_object               *obj;
1651         struct nft_object               *newobj;
1652         bool                            update;
1653 };
1654
1655 #define nft_trans_obj(trans)    \
1656         (((struct nft_trans_obj *)trans->data)->obj)
1657 #define nft_trans_obj_newobj(trans) \
1658         (((struct nft_trans_obj *)trans->data)->newobj)
1659 #define nft_trans_obj_update(trans)     \
1660         (((struct nft_trans_obj *)trans->data)->update)
1661
1662 struct nft_trans_flowtable {
1663         struct nft_flowtable            *flowtable;
1664         bool                            update;
1665         struct list_head                hook_list;
1666         u32                             flags;
1667 };
1668
1669 #define nft_trans_flowtable(trans)      \
1670         (((struct nft_trans_flowtable *)trans->data)->flowtable)
1671 #define nft_trans_flowtable_update(trans)       \
1672         (((struct nft_trans_flowtable *)trans->data)->update)
1673 #define nft_trans_flowtable_hooks(trans)        \
1674         (((struct nft_trans_flowtable *)trans->data)->hook_list)
1675 #define nft_trans_flowtable_flags(trans)        \
1676         (((struct nft_trans_flowtable *)trans->data)->flags)
1677
1678 #define NFT_TRANS_GC_BATCHCOUNT 256
1679
1680 struct nft_trans_gc {
1681         struct list_head        list;
1682         struct net              *net;
1683         struct nft_set          *set;
1684         u32                     seq;
1685         u16                     count;
1686         void                    *priv[NFT_TRANS_GC_BATCHCOUNT];
1687         struct rcu_head         rcu;
1688 };
1689
1690 struct nft_trans_gc *nft_trans_gc_alloc(struct nft_set *set,
1691                                         unsigned int gc_seq, gfp_t gfp);
1692 void nft_trans_gc_destroy(struct nft_trans_gc *trans);
1693
1694 struct nft_trans_gc *nft_trans_gc_queue_async(struct nft_trans_gc *gc,
1695                                               unsigned int gc_seq, gfp_t gfp);
1696 void nft_trans_gc_queue_async_done(struct nft_trans_gc *gc);
1697
1698 struct nft_trans_gc *nft_trans_gc_queue_sync(struct nft_trans_gc *gc, gfp_t gfp);
1699 void nft_trans_gc_queue_sync_done(struct nft_trans_gc *trans);
1700
1701 void nft_trans_gc_elem_add(struct nft_trans_gc *gc, void *priv);
1702
1703 struct nft_trans_gc *nft_trans_gc_catchall_async(struct nft_trans_gc *gc,
1704                                                  unsigned int gc_seq);
1705 struct nft_trans_gc *nft_trans_gc_catchall_sync(struct nft_trans_gc *gc);
1706
1707 void nft_setelem_data_deactivate(const struct net *net,
1708                                  const struct nft_set *set,
1709                                  struct nft_set_elem *elem);
1710
1711 int __init nft_chain_filter_init(void);
1712 void nft_chain_filter_fini(void);
1713
1714 void __init nft_chain_route_init(void);
1715 void nft_chain_route_fini(void);
1716
1717 void nf_tables_trans_destroy_flush_work(void);
1718
1719 int nf_msecs_to_jiffies64(const struct nlattr *nla, u64 *result);
1720 __be64 nf_jiffies64_to_msecs(u64 input);
1721
1722 #ifdef CONFIG_MODULES
1723 __printf(2, 3) int nft_request_module(struct net *net, const char *fmt, ...);
1724 #else
1725 static inline int nft_request_module(struct net *net, const char *fmt, ...) { return -ENOENT; }
1726 #endif
1727
1728 struct nftables_pernet {
1729         struct list_head        tables;
1730         struct list_head        commit_list;
1731         struct list_head        binding_list;
1732         struct list_head        module_list;
1733         struct list_head        notify_list;
1734         struct mutex            commit_mutex;
1735         u64                     table_handle;
1736         unsigned int            base_seq;
1737         unsigned int            gc_seq;
1738         u8                      validate_state;
1739 };
1740
1741 extern unsigned int nf_tables_net_id;
1742
1743 static inline struct nftables_pernet *nft_pernet(const struct net *net)
1744 {
1745         return net_generic(net, nf_tables_net_id);
1746 }
1747
1748 #define __NFT_REDUCE_READONLY   1UL
1749 #define NFT_REDUCE_READONLY     (void *)__NFT_REDUCE_READONLY
1750
1751 static inline bool nft_reduce_is_readonly(const struct nft_expr *expr)
1752 {
1753         return expr->ops->reduce == NFT_REDUCE_READONLY;
1754 }
1755
1756 void nft_reg_track_update(struct nft_regs_track *track,
1757                           const struct nft_expr *expr, u8 dreg, u8 len);
1758 void nft_reg_track_cancel(struct nft_regs_track *track, u8 dreg, u8 len);
1759 void __nft_reg_track_cancel(struct nft_regs_track *track, u8 dreg);
1760
1761 static inline bool nft_reg_track_cmp(struct nft_regs_track *track,
1762                                      const struct nft_expr *expr, u8 dreg)
1763 {
1764         return track->regs[dreg].selector &&
1765                track->regs[dreg].selector->ops == expr->ops &&
1766                track->regs[dreg].num_reg == 0;
1767 }
1768
1769 #endif /* _NET_NF_TABLES_H */