kernel/include/linux/netfilter/x_tables.h

   1 #ifndef _X_TABLES_H
   2 #define _X_TABLES_H
   3
   4
   5 #include <linux/netdevice.h>
   6 #include <linux/static_key.h>
   7 #include <linux/locallock.h>
   8 #include <uapi/linux/netfilter/x_tables.h>
   9
  10 /**
  11  * struct xt_action_param - parameters for matches/targets
  12  *
  13  * @match:      the match extension
  14  * @target:     the target extension
  15  * @matchinfo:  per-match data
  16  * @targetinfo: per-target data
  17  * @net         network namespace through which the action was invoked
  18  * @in:         input netdevice
  19  * @out:        output netdevice
  20  * @fragoff:    packet is a fragment, this is the data offset
  21  * @thoff:      position of transport header relative to skb->data
  22  * @hook:       hook number given packet came from
  23  * @family:     Actual NFPROTO_* through which the function is invoked
  24  *              (helpful when match->family == NFPROTO_UNSPEC)
  25  *
  26  * Fields written to by extensions:
  27  *
  28  * @hotdrop:    drop packet if we had inspection problems
  29  */
  30 struct xt_action_param {
  31         union {
  32                 const struct xt_match *match;
  33                 const struct xt_target *target;
  34         };
  35         union {
  36                 const void *matchinfo, *targinfo;
  37         };
  38         struct net *net;
  39         const struct net_device *in, *out;
  40         int fragoff;
  41         unsigned int thoff;
  42         unsigned int hooknum;
  43         u_int8_t family;
  44         bool hotdrop;
  45 };
  46
  47 /**
  48  * struct xt_mtchk_param - parameters for match extensions'
  49  * checkentry functions
  50  *
  51  * @net:        network namespace through which the check was invoked
  52  * @table:      table the rule is tried to be inserted into
  53  * @entryinfo:  the family-specific rule data
  54  *              (struct ipt_ip, ip6t_ip, arpt_arp or (note) ebt_entry)
  55  * @match:      struct xt_match through which this function was invoked
  56  * @matchinfo:  per-match data
  57  * @hook_mask:  via which hooks the new rule is reachable
  58  * Other fields as above.
  59  */
  60 struct xt_mtchk_param {
  61         struct net *net;
  62         const char *table;
  63         const void *entryinfo;
  64         const struct xt_match *match;
  65         void *matchinfo;
  66         unsigned int hook_mask;
  67         u_int8_t family;
  68         bool nft_compat;
  69 };
  70
  71 /**
  72  * struct xt_mdtor_param - match destructor parameters
  73  * Fields as above.
  74  */
  75 struct xt_mtdtor_param {
  76         struct net *net;
  77         const struct xt_match *match;
  78         void *matchinfo;
  79         u_int8_t family;
  80 };
  81
  82 /**
  83  * struct xt_tgchk_param - parameters for target extensions'
  84  * checkentry functions
  85  *
  86  * @entryinfo:  the family-specific rule data
  87  *              (struct ipt_entry, ip6t_entry, arpt_entry, ebt_entry)
  88  *
  89  * Other fields see above.
  90  */
  91 struct xt_tgchk_param {
  92         struct net *net;
  93         const char *table;
  94         const void *entryinfo;
  95         const struct xt_target *target;
  96         void *targinfo;
  97         unsigned int hook_mask;
  98         u_int8_t family;
  99         bool nft_compat;
 100 };
 101
 102 /* Target destructor parameters */
 103 struct xt_tgdtor_param {
 104         struct net *net;
 105         const struct xt_target *target;
 106         void *targinfo;
 107         u_int8_t family;
 108 };
 109
 110 struct xt_match {
 111         struct list_head list;
 112
 113         const char name[XT_EXTENSION_MAXNAMELEN];
 114         u_int8_t revision;
 115
 116         /* Return true or false: return FALSE and set *hotdrop = 1 to
 117            force immediate packet drop. */
 118         /* Arguments changed since 2.6.9, as this must now handle
 119            non-linear skb, using skb_header_pointer and
 120            skb_ip_make_writable. */
 121         bool (*match)(const struct sk_buff *skb,
 122                       struct xt_action_param *);
 123
 124         /* Called when user tries to insert an entry of this type. */
 125         int (*checkentry)(const struct xt_mtchk_param *);
 126
 127         /* Called when entry of this type deleted. */
 128         void (*destroy)(const struct xt_mtdtor_param *);
 129 #ifdef CONFIG_COMPAT
 130         /* Called when userspace align differs from kernel space one */
 131         void (*compat_from_user)(void *dst, const void *src);
 132         int (*compat_to_user)(void __user *dst, const void *src);
 133 #endif
 134         /* Set this to THIS_MODULE if you are a module, otherwise NULL */
 135         struct module *me;
 136
 137         const char *table;
 138         unsigned int matchsize;
 139 #ifdef CONFIG_COMPAT
 140         unsigned int compatsize;
 141 #endif
 142         unsigned int hooks;
 143         unsigned short proto;
 144
 145         unsigned short family;
 146 };
 147
 148 /* Registration hooks for targets. */
 149 struct xt_target {
 150         struct list_head list;
 151
 152         const char name[XT_EXTENSION_MAXNAMELEN];
 153         u_int8_t revision;
 154
 155         /* Returns verdict. Argument order changed since 2.6.9, as this
 156            must now handle non-linear skbs, using skb_copy_bits and
 157            skb_ip_make_writable. */
 158         unsigned int (*target)(struct sk_buff *skb,
 159                                const struct xt_action_param *);
 160
 161         /* Called when user tries to insert an entry of this type:
 162            hook_mask is a bitmask of hooks from which it can be
 163            called. */
 164         /* Should return 0 on success or an error code otherwise (-Exxxx). */
 165         int (*checkentry)(const struct xt_tgchk_param *);
 166
 167         /* Called when entry of this type deleted. */
 168         void (*destroy)(const struct xt_tgdtor_param *);
 169 #ifdef CONFIG_COMPAT
 170         /* Called when userspace align differs from kernel space one */
 171         void (*compat_from_user)(void *dst, const void *src);
 172         int (*compat_to_user)(void __user *dst, const void *src);
 173 #endif
 174         /* Set this to THIS_MODULE if you are a module, otherwise NULL */
 175         struct module *me;
 176
 177         const char *table;
 178         unsigned int targetsize;
 179 #ifdef CONFIG_COMPAT
 180         unsigned int compatsize;
 181 #endif
 182         unsigned int hooks;
 183         unsigned short proto;
 184
 185         unsigned short family;
 186 };
 187
 188 /* Furniture shopping... */
 189 struct xt_table {
 190         struct list_head list;
 191
 192         /* What hooks you will enter on */
 193         unsigned int valid_hooks;
 194
 195         /* Man behind the curtain... */
 196         struct xt_table_info *private;
 197
 198         /* Set this to THIS_MODULE if you are a module, otherwise NULL */
 199         struct module *me;
 200
 201         u_int8_t af;            /* address/protocol family */
 202         int priority;           /* hook order */
 203
 204         /* A unique name... */
 205         const char name[XT_TABLE_MAXNAMELEN];
 206 };
 207
 208 #include <linux/netfilter_ipv4.h>
 209
 210 /* The table itself */
 211 struct xt_table_info {
 212         /* Size per table */
 213         unsigned int size;
 214         /* Number of entries: FIXME. --RR */
 215         unsigned int number;
 216         /* Initial number of entries. Needed for module usage count */
 217         unsigned int initial_entries;
 218
 219         /* Entry points and underflows */
 220         unsigned int hook_entry[NF_INET_NUMHOOKS];
 221         unsigned int underflow[NF_INET_NUMHOOKS];
 222
 223         /*
 224          * Number of user chains. Since tables cannot have loops, at most
 225          * @stacksize jumps (number of user chains) can possibly be made.
 226          */
 227         unsigned int stacksize;
 228         void ***jumpstack;
 229
 230         unsigned char entries[0] __aligned(8);
 231 };
 232
 233 int xt_register_target(struct xt_target *target);
 234 void xt_unregister_target(struct xt_target *target);
 235 int xt_register_targets(struct xt_target *target, unsigned int n);
 236 void xt_unregister_targets(struct xt_target *target, unsigned int n);
 237
 238 int xt_register_match(struct xt_match *target);
 239 void xt_unregister_match(struct xt_match *target);
 240 int xt_register_matches(struct xt_match *match, unsigned int n);
 241 void xt_unregister_matches(struct xt_match *match, unsigned int n);
 242
 243 int xt_check_entry_offsets(const void *base, const char *elems,
 244                            unsigned int target_offset,
 245                            unsigned int next_offset);
 246
 247 int xt_check_match(struct xt_mtchk_param *, unsigned int size, u_int8_t proto,
 248                    bool inv_proto);
 249 int xt_check_target(struct xt_tgchk_param *, unsigned int size, u_int8_t proto,
 250                     bool inv_proto);
 251
 252 void *xt_copy_counters_from_user(const void __user *user, unsigned int len,
 253                                  struct xt_counters_info *info, bool compat);
 254
 255 struct xt_table *xt_register_table(struct net *net,
 256                                    const struct xt_table *table,
 257                                    struct xt_table_info *bootstrap,
 258                                    struct xt_table_info *newinfo);
 259 void *xt_unregister_table(struct xt_table *table);
 260
 261 struct xt_table_info *xt_replace_table(struct xt_table *table,
 262                                        unsigned int num_counters,
 263                                        struct xt_table_info *newinfo,
 264                                        int *error);
 265
 266 struct xt_match *xt_find_match(u8 af, const char *name, u8 revision);
 267 struct xt_target *xt_find_target(u8 af, const char *name, u8 revision);
 268 struct xt_match *xt_request_find_match(u8 af, const char *name, u8 revision);
 269 struct xt_target *xt_request_find_target(u8 af, const char *name, u8 revision);
 270 int xt_find_revision(u8 af, const char *name, u8 revision, int target,
 271                      int *err);
 272
 273 struct xt_table *xt_find_table_lock(struct net *net, u_int8_t af,
 274                                     const char *name);
 275 void xt_table_unlock(struct xt_table *t);
 276
 277 int xt_proto_init(struct net *net, u_int8_t af);
 278 void xt_proto_fini(struct net *net, u_int8_t af);
 279
 280 struct xt_table_info *xt_alloc_table_info(unsigned int size);
 281 void xt_free_table_info(struct xt_table_info *info);
 282
 283 /**
 284  * xt_recseq - recursive seqcount for netfilter use
 285  *
 286  * Packet processing changes the seqcount only if no recursion happened
 287  * get_counters() can use read_seqcount_begin()/read_seqcount_retry(),
 288  * because we use the normal seqcount convention :
 289  * Low order bit set to 1 if a writer is active.
 290  */
 291 DECLARE_PER_CPU(seqcount_t, xt_recseq);
 292
 293 DECLARE_LOCAL_IRQ_LOCK(xt_write_lock);
 294
 295 /* xt_tee_enabled - true if x_tables needs to handle reentrancy
 296  *
 297  * Enabled if current ip(6)tables ruleset has at least one -j TEE rule.
 298  */
 299 extern struct static_key xt_tee_enabled;
 300
 301 /**
 302  * xt_write_recseq_begin - start of a write section
 303  *
 304  * Begin packet processing : all readers must wait the end
 305  * 1) Must be called with preemption disabled
 306  * 2) softirqs must be disabled too (or we should use this_cpu_add())
 307  * Returns :
 308  *  1 if no recursion on this cpu
 309  *  0 if recursion detected
 310  */
 311 static inline unsigned int xt_write_recseq_begin(void)
 312 {
 313         unsigned int addend;
 314
 315         /* RT protection */
 316         local_lock(xt_write_lock);
 317
 318         /*
 319          * Low order bit of sequence is set if we already
 320          * called xt_write_recseq_begin().
 321          */
 322         addend = (__this_cpu_read(xt_recseq.sequence) + 1) & 1;
 323
 324         /*
 325          * This is kind of a write_seqcount_begin(), but addend is 0 or 1
 326          * We dont check addend value to avoid a test and conditional jump,
 327          * since addend is most likely 1
 328          */
 329         __this_cpu_add(xt_recseq.sequence, addend);
 330         smp_wmb();
 331
 332         return addend;
 333 }
 334
 335 /**
 336  * xt_write_recseq_end - end of a write section
 337  * @addend: return value from previous xt_write_recseq_begin()
 338  *
 339  * End packet processing : all readers can proceed
 340  * 1) Must be called with preemption disabled
 341  * 2) softirqs must be disabled too (or we should use this_cpu_add())
 342  */
 343 static inline void xt_write_recseq_end(unsigned int addend)
 344 {
 345         /* this is kind of a write_seqcount_end(), but addend is 0 or 1 */
 346         smp_wmb();
 347         __this_cpu_add(xt_recseq.sequence, addend);
 348         local_unlock(xt_write_lock);
 349 }
 350
 351 /*
 352  * This helper is performance critical and must be inlined
 353  */
 354 static inline unsigned long ifname_compare_aligned(const char *_a,
 355                                                    const char *_b,
 356                                                    const char *_mask)
 357 {
 358         const unsigned long *a = (const unsigned long *)_a;
 359         const unsigned long *b = (const unsigned long *)_b;
 360         const unsigned long *mask = (const unsigned long *)_mask;
 361         unsigned long ret;
 362
 363         ret = (a[0] ^ b[0]) & mask[0];
 364         if (IFNAMSIZ > sizeof(unsigned long))
 365                 ret |= (a[1] ^ b[1]) & mask[1];
 366         if (IFNAMSIZ > 2 * sizeof(unsigned long))
 367                 ret |= (a[2] ^ b[2]) & mask[2];
 368         if (IFNAMSIZ > 3 * sizeof(unsigned long))
 369                 ret |= (a[3] ^ b[3]) & mask[3];
 370         BUILD_BUG_ON(IFNAMSIZ > 4 * sizeof(unsigned long));
 371         return ret;
 372 }
 373
 374
 375 /* On SMP, ip(6)t_entry->counters.pcnt holds address of the
 376  * real (percpu) counter.  On !SMP, its just the packet count,
 377  * so nothing needs to be done there.
 378  *
 379  * xt_percpu_counter_alloc returns the address of the percpu
 380  * counter, or 0 on !SMP. We force an alignment of 16 bytes
 381  * so that bytes/packets share a common cache line.
 382  *
 383  * Hence caller must use IS_ERR_VALUE to check for error, this
 384  * allows us to return 0 for single core systems without forcing
 385  * callers to deal with SMP vs. NONSMP issues.
 386  */
 387 static inline u64 xt_percpu_counter_alloc(void)
 388 {
 389         if (nr_cpu_ids > 1) {
 390                 void __percpu *res = __alloc_percpu(sizeof(struct xt_counters),
 391                                                     sizeof(struct xt_counters));
 392
 393                 if (res == NULL)
 394                         return (u64) -ENOMEM;
 395
 396                 return (u64) (__force unsigned long) res;
 397         }
 398
 399         return 0;
 400 }
 401 static inline void xt_percpu_counter_free(u64 pcnt)
 402 {
 403         if (nr_cpu_ids > 1)
 404                 free_percpu((void __percpu *) (unsigned long) pcnt);
 405 }
 406
 407 static inline struct xt_counters *
 408 xt_get_this_cpu_counter(struct xt_counters *cnt)
 409 {
 410         if (nr_cpu_ids > 1)
 411                 return this_cpu_ptr((void __percpu *) (unsigned long) cnt->pcnt);
 412
 413         return cnt;
 414 }
 415
 416 static inline struct xt_counters *
 417 xt_get_per_cpu_counter(struct xt_counters *cnt, unsigned int cpu)
 418 {
 419         if (nr_cpu_ids > 1)
 420                 return per_cpu_ptr((void __percpu *) (unsigned long) cnt->pcnt, cpu);
 421
 422         return cnt;
 423 }
 424
 425 struct nf_hook_ops *xt_hook_link(const struct xt_table *, nf_hookfn *);
 426 void xt_hook_unlink(const struct xt_table *, struct nf_hook_ops *);
 427
 428 #ifdef CONFIG_COMPAT
 429 #include <net/compat.h>
 430
 431 struct compat_xt_entry_match {
 432         union {
 433                 struct {
 434                         u_int16_t match_size;
 435                         char name[XT_FUNCTION_MAXNAMELEN - 1];
 436                         u_int8_t revision;
 437                 } user;
 438                 struct {
 439                         u_int16_t match_size;
 440                         compat_uptr_t match;
 441                 } kernel;
 442                 u_int16_t match_size;
 443         } u;
 444         unsigned char data[0];
 445 };
 446
 447 struct compat_xt_entry_target {
 448         union {
 449                 struct {
 450                         u_int16_t target_size;
 451                         char name[XT_FUNCTION_MAXNAMELEN - 1];
 452                         u_int8_t revision;
 453                 } user;
 454                 struct {
 455                         u_int16_t target_size;
 456                         compat_uptr_t target;
 457                 } kernel;
 458                 u_int16_t target_size;
 459         } u;
 460         unsigned char data[0];
 461 };
 462
 463 /* FIXME: this works only on 32 bit tasks
 464  * need to change whole approach in order to calculate align as function of
 465  * current task alignment */
 466
 467 struct compat_xt_counters {
 468         compat_u64 pcnt, bcnt;                  /* Packet and byte counters */
 469 };
 470
 471 struct compat_xt_counters_info {
 472         char name[XT_TABLE_MAXNAMELEN];
 473         compat_uint_t num_counters;
 474         struct compat_xt_counters counters[0];
 475 };
 476
 477 struct _compat_xt_align {
 478         __u8 u8;
 479         __u16 u16;
 480         __u32 u32;
 481         compat_u64 u64;
 482 };
 483
 484 #define COMPAT_XT_ALIGN(s) __ALIGN_KERNEL((s), __alignof__(struct _compat_xt_align))
 485
 486 void xt_compat_lock(u_int8_t af);
 487 void xt_compat_unlock(u_int8_t af);
 488
 489 int xt_compat_add_offset(u_int8_t af, unsigned int offset, int delta);
 490 void xt_compat_flush_offsets(u_int8_t af);
 491 void xt_compat_init_offsets(u_int8_t af, unsigned int number);
 492 int xt_compat_calc_jump(u_int8_t af, unsigned int offset);
 493
 494 int xt_compat_match_offset(const struct xt_match *match);
 495 void xt_compat_match_from_user(struct xt_entry_match *m, void **dstptr,
 496                               unsigned int *size);
 497 int xt_compat_match_to_user(const struct xt_entry_match *m,
 498                             void __user **dstptr, unsigned int *size);
 499
 500 int xt_compat_target_offset(const struct xt_target *target);
 501 void xt_compat_target_from_user(struct xt_entry_target *t, void **dstptr,
 502                                 unsigned int *size);
 503 int xt_compat_target_to_user(const struct xt_entry_target *t,
 504                              void __user **dstptr, unsigned int *size);
 505 int xt_compat_check_entry_offsets(const void *base, const char *elems,
 506                                   unsigned int target_offset,
 507                                   unsigned int next_offset);
 508
 509 #endif /* CONFIG_COMPAT */
 510 #endif /* _X_TABLES_H */