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