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