include/linux/netfilter/x_tables.h

   1 #ifndef _X_TABLES_H
   2 #define _X_TABLES_H
   3
   4 #include <linux/types.h>
   5
   6 #define XT_FUNCTION_MAXNAMELEN 30
   7 #define XT_TABLE_MAXNAMELEN 32
   8
   9 struct xt_entry_match {
  10         union {
  11                 struct {
  12                         __u16 match_size;
  13
  14                         /* Used by userspace */
  15                         char name[XT_FUNCTION_MAXNAMELEN-1];
  16
  17                         __u8 revision;
  18                 } user;
  19                 struct {
  20                         __u16 match_size;
  21
  22                         /* Used inside the kernel */
  23                         struct xt_match *match;
  24                 } kernel;
  25
  26                 /* Total length */
  27                 __u16 match_size;
  28         } u;
  29
  30         unsigned char data[0];
  31 };
  32
  33 struct xt_entry_target {
  34         union {
  35                 struct {
  36                         __u16 target_size;
  37
  38                         /* Used by userspace */
  39                         char name[XT_FUNCTION_MAXNAMELEN-1];
  40
  41                         __u8 revision;
  42                 } user;
  43                 struct {
  44                         __u16 target_size;
  45
  46                         /* Used inside the kernel */
  47                         struct xt_target *target;
  48                 } kernel;
  49
  50                 /* Total length */
  51                 __u16 target_size;
  52         } u;
  53
  54         unsigned char data[0];
  55 };
  56
  57 #define XT_TARGET_INIT(__name, __size)                                         \
  58 {                                                                              \
  59         .target.u.user = {                                                     \
  60                 .target_size    = XT_ALIGN(__size),                            \
  61                 .name           = __name,                                      \
  62         },                                                                     \
  63 }
  64
  65 struct xt_standard_target {
  66         struct xt_entry_target target;
  67         int verdict;
  68 };
  69
  70 /* The argument to IPT_SO_GET_REVISION_*.  Returns highest revision
  71  * kernel supports, if >= revision. */
  72 struct xt_get_revision {
  73         char name[XT_FUNCTION_MAXNAMELEN-1];
  74
  75         __u8 revision;
  76 };
  77
  78 /* CONTINUE verdict for targets */
  79 #define XT_CONTINUE 0xFFFFFFFF
  80
  81 /* For standard target */
  82 #define XT_RETURN (-NF_REPEAT - 1)
  83
  84 /* this is a dummy structure to find out the alignment requirement for a struct
  85  * containing all the fundamental data types that are used in ipt_entry,
  86  * ip6t_entry and arpt_entry.  This sucks, and it is a hack.  It will be my
  87  * personal pleasure to remove it -HW
  88  */
  89 struct _xt_align {
  90         __u8 u8;
  91         __u16 u16;
  92         __u32 u32;
  93         __u64 u64;
  94 };
  95
  96 #define XT_ALIGN(s) ALIGN((s), __alignof__(struct _xt_align))
  97
  98 /* Standard return verdict, or do jump. */
  99 #define XT_STANDARD_TARGET ""
 100 /* Error verdict. */
 101 #define XT_ERROR_TARGET "ERROR"
 102
 103 #define SET_COUNTER(c,b,p) do { (c).bcnt = (b); (c).pcnt = (p); } while(0)
 104 #define ADD_COUNTER(c,b,p) do { (c).bcnt += (b); (c).pcnt += (p); } while(0)
 105
 106 struct xt_counters {
 107         __u64 pcnt, bcnt;                       /* Packet and byte counters */
 108 };
 109
 110 /* The argument to IPT_SO_ADD_COUNTERS. */
 111 struct xt_counters_info {
 112         /* Which table. */
 113         char name[XT_TABLE_MAXNAMELEN];
 114
 115         unsigned int num_counters;
 116
 117         /* The counters (actually `number' of these). */
 118         struct xt_counters counters[0];
 119 };
 120
 121 #define XT_INV_PROTO            0x40    /* Invert the sense of PROTO. */
 122
 123 #ifndef __KERNEL__
 124 /* fn returns 0 to continue iteration */
 125 #define XT_MATCH_ITERATE(type, e, fn, args...)                  \
 126 ({                                                              \
 127         unsigned int __i;                                       \
 128         int __ret = 0;                                          \
 129         struct xt_entry_match *__m;                             \
 130                                                                 \
 131         for (__i = sizeof(type);                                \
 132              __i < (e)->target_offset;                          \
 133              __i += __m->u.match_size) {                        \
 134                 __m = (void *)e + __i;                          \
 135                                                                 \
 136                 __ret = fn(__m , ## args);                      \
 137                 if (__ret != 0)                                 \
 138                         break;                                  \
 139         }                                                       \
 140         __ret;                                                  \
 141 })
 142
 143 /* fn returns 0 to continue iteration */
 144 #define XT_ENTRY_ITERATE_CONTINUE(type, entries, size, n, fn, args...) \
 145 ({                                                              \
 146         unsigned int __i, __n;                                  \
 147         int __ret = 0;                                          \
 148         type *__entry;                                          \
 149                                                                 \
 150         for (__i = 0, __n = 0; __i < (size);                    \
 151              __i += __entry->next_offset, __n++) {              \
 152                 __entry = (void *)(entries) + __i;              \
 153                 if (__n < n)                                    \
 154                         continue;                               \
 155                                                                 \
 156                 __ret = fn(__entry , ## args);                  \
 157                 if (__ret != 0)                                 \
 158                         break;                                  \
 159         }                                                       \
 160         __ret;                                                  \
 161 })
 162
 163 /* fn returns 0 to continue iteration */
 164 #define XT_ENTRY_ITERATE(type, entries, size, fn, args...) \
 165         XT_ENTRY_ITERATE_CONTINUE(type, entries, size, 0, fn, args)
 166
 167 #endif /* !__KERNEL__ */
 168
 169 /* pos is normally a struct ipt_entry/ip6t_entry/etc. */
 170 #define xt_entry_foreach(pos, ehead, esize) \
 171         for ((pos) = (typeof(pos))(ehead); \
 172              (pos) < (typeof(pos))((char *)(ehead) + (esize)); \
 173              (pos) = (typeof(pos))((char *)(pos) + (pos)->next_offset))
 174
 175 /* can only be xt_entry_match, so no use of typeof here */
 176 #define xt_ematch_foreach(pos, entry) \
 177         for ((pos) = (struct xt_entry_match *)entry->elems; \
 178              (pos) < (struct xt_entry_match *)((char *)(entry) + \
 179                      (entry)->target_offset); \
 180              (pos) = (struct xt_entry_match *)((char *)(pos) + \
 181                      (pos)->u.match_size))
 182
 183 #ifdef __KERNEL__
 184
 185 #include <linux/netdevice.h>
 186
 187 /**
 188  * struct xt_match_param - parameters for match extensions' match functions
 189  *
 190  * @in:         input netdevice
 191  * @out:        output netdevice
 192  * @match:      struct xt_match through which this function was invoked
 193  * @matchinfo:  per-match data
 194  * @fragoff:    packet is a fragment, this is the data offset
 195  * @thoff:      position of transport header relative to skb->data
 196  * @hook:       hook number given packet came from
 197  * @family:     Actual NFPROTO_* through which the function is invoked
 198  *              (helpful when match->family == NFPROTO_UNSPEC)
 199  * @hotdrop:    drop packet if we had inspection problems
 200  * Network namespace obtainable using dev_net(in/out)
 201  */
 202 struct xt_match_param {
 203         const struct net_device *in, *out;
 204         const struct xt_match *match;
 205         const void *matchinfo;
 206         int fragoff;
 207         unsigned int thoff;
 208         unsigned int hooknum;
 209         u_int8_t family;
 210         bool *hotdrop;
 211 };
 212
 213 /**
 214  * struct xt_mtchk_param - parameters for match extensions'
 215  * checkentry functions
 216  *
 217  * @net:        network namespace through which the check was invoked
 218  * @table:      table the rule is tried to be inserted into
 219  * @entryinfo:  the family-specific rule data
 220  *              (struct ipt_ip, ip6t_ip, arpt_arp or (note) ebt_entry)
 221  * @match:      struct xt_match through which this function was invoked
 222  * @matchinfo:  per-match data
 223  * @hook_mask:  via which hooks the new rule is reachable
 224  * Other fields as above.
 225  */
 226 struct xt_mtchk_param {
 227         struct net *net;
 228         const char *table;
 229         const void *entryinfo;
 230         const struct xt_match *match;
 231         void *matchinfo;
 232         unsigned int hook_mask;
 233         u_int8_t family;
 234 };
 235
 236 /**
 237  * struct xt_mdtor_param - match destructor parameters
 238  * Fields as above.
 239  */
 240 struct xt_mtdtor_param {
 241         struct net *net;
 242         const struct xt_match *match;
 243         void *matchinfo;
 244         u_int8_t family;
 245 };
 246
 247 /**
 248  * struct xt_target_param - parameters for target extensions' target functions
 249  *
 250  * @hooknum:    hook through which this target was invoked
 251  * @target:     struct xt_target through which this function was invoked
 252  * @targinfo:   per-target data
 253  *
 254  * Other fields see above.
 255  */
 256 struct xt_target_param {
 257         const struct net_device *in, *out;
 258         const struct xt_target *target;
 259         const void *targinfo;
 260         unsigned int hooknum;
 261         u_int8_t family;
 262 };
 263
 264 /**
 265  * struct xt_tgchk_param - parameters for target extensions'
 266  * checkentry functions
 267  *
 268  * @entryinfo:  the family-specific rule data
 269  *              (struct ipt_entry, ip6t_entry, arpt_entry, ebt_entry)
 270  *
 271  * Other fields see above.
 272  */
 273 struct xt_tgchk_param {
 274         struct net *net;
 275         const char *table;
 276         const void *entryinfo;
 277         const struct xt_target *target;
 278         void *targinfo;
 279         unsigned int hook_mask;
 280         u_int8_t family;
 281 };
 282
 283 /* Target destructor parameters */
 284 struct xt_tgdtor_param {
 285         struct net *net;
 286         const struct xt_target *target;
 287         void *targinfo;
 288         u_int8_t family;
 289 };
 290
 291 struct xt_match {
 292         struct list_head list;
 293
 294         const char name[XT_FUNCTION_MAXNAMELEN-1];
 295         u_int8_t revision;
 296
 297         /* Return true or false: return FALSE and set *hotdrop = 1 to
 298            force immediate packet drop. */
 299         /* Arguments changed since 2.6.9, as this must now handle
 300            non-linear skb, using skb_header_pointer and
 301            skb_ip_make_writable. */
 302         bool (*match)(const struct sk_buff *skb,
 303                       const struct xt_match_param *);
 304
 305         /* Called when user tries to insert an entry of this type. */
 306         bool (*checkentry)(const struct xt_mtchk_param *);
 307
 308         /* Called when entry of this type deleted. */
 309         void (*destroy)(const struct xt_mtdtor_param *);
 310 #ifdef CONFIG_COMPAT
 311         /* Called when userspace align differs from kernel space one */
 312         void (*compat_from_user)(void *dst, const void *src);
 313         int (*compat_to_user)(void __user *dst, const void *src);
 314 #endif
 315         /* Set this to THIS_MODULE if you are a module, otherwise NULL */
 316         struct module *me;
 317
 318         /* Free to use by each match */
 319         unsigned long data;
 320
 321         const char *table;
 322         unsigned int matchsize;
 323 #ifdef CONFIG_COMPAT
 324         unsigned int compatsize;
 325 #endif
 326         unsigned int hooks;
 327         unsigned short proto;
 328
 329         unsigned short family;
 330 };
 331
 332 /* Registration hooks for targets. */
 333 struct xt_target {
 334         struct list_head list;
 335
 336         const char name[XT_FUNCTION_MAXNAMELEN-1];
 337
 338         /* Returns verdict. Argument order changed since 2.6.9, as this
 339            must now handle non-linear skbs, using skb_copy_bits and
 340            skb_ip_make_writable. */
 341         unsigned int (*target)(struct sk_buff *skb,
 342                                const struct xt_target_param *);
 343
 344         /* Called when user tries to insert an entry of this type:
 345            hook_mask is a bitmask of hooks from which it can be
 346            called. */
 347         /* Should return true or false. */
 348         bool (*checkentry)(const struct xt_tgchk_param *);
 349
 350         /* Called when entry of this type deleted. */
 351         void (*destroy)(const struct xt_tgdtor_param *);
 352 #ifdef CONFIG_COMPAT
 353         /* Called when userspace align differs from kernel space one */
 354         void (*compat_from_user)(void *dst, const void *src);
 355         int (*compat_to_user)(void __user *dst, const void *src);
 356 #endif
 357         /* Set this to THIS_MODULE if you are a module, otherwise NULL */
 358         struct module *me;
 359
 360         const char *table;
 361         unsigned int targetsize;
 362 #ifdef CONFIG_COMPAT
 363         unsigned int compatsize;
 364 #endif
 365         unsigned int hooks;
 366         unsigned short proto;
 367
 368         unsigned short family;
 369         u_int8_t revision;
 370 };
 371
 372 /* Furniture shopping... */
 373 struct xt_table {
 374         struct list_head list;
 375
 376         /* What hooks you will enter on */
 377         unsigned int valid_hooks;
 378
 379         /* Man behind the curtain... */
 380         struct xt_table_info *private;
 381
 382         /* Set this to THIS_MODULE if you are a module, otherwise NULL */
 383         struct module *me;
 384
 385         u_int8_t af;            /* address/protocol family */
 386         int priority;           /* hook order */
 387
 388         /* A unique name... */
 389         const char name[XT_TABLE_MAXNAMELEN];
 390 };
 391
 392 #include <linux/netfilter_ipv4.h>
 393
 394 /* The table itself */
 395 struct xt_table_info {
 396         /* Size per table */
 397         unsigned int size;
 398         /* Number of entries: FIXME. --RR */
 399         unsigned int number;
 400         /* Initial number of entries. Needed for module usage count */
 401         unsigned int initial_entries;
 402
 403         /* Entry points and underflows */
 404         unsigned int hook_entry[NF_INET_NUMHOOKS];
 405         unsigned int underflow[NF_INET_NUMHOOKS];
 406
 407         /* ipt_entry tables: one per CPU */
 408         /* Note : this field MUST be the last one, see XT_TABLE_INFO_SZ */
 409         void *entries[1];
 410 };
 411
 412 #define XT_TABLE_INFO_SZ (offsetof(struct xt_table_info, entries) \
 413                           + nr_cpu_ids * sizeof(char *))
 414 extern int xt_register_target(struct xt_target *target);
 415 extern void xt_unregister_target(struct xt_target *target);
 416 extern int xt_register_targets(struct xt_target *target, unsigned int n);
 417 extern void xt_unregister_targets(struct xt_target *target, unsigned int n);
 418
 419 extern int xt_register_match(struct xt_match *target);
 420 extern void xt_unregister_match(struct xt_match *target);
 421 extern int xt_register_matches(struct xt_match *match, unsigned int n);
 422 extern void xt_unregister_matches(struct xt_match *match, unsigned int n);
 423
 424 extern int xt_check_match(struct xt_mtchk_param *,
 425                           unsigned int size, u_int8_t proto, bool inv_proto);
 426 extern int xt_check_target(struct xt_tgchk_param *,
 427                            unsigned int size, u_int8_t proto, bool inv_proto);
 428
 429 extern struct xt_table *xt_register_table(struct net *net,
 430                                           const struct xt_table *table,
 431                                           struct xt_table_info *bootstrap,
 432                                           struct xt_table_info *newinfo);
 433 extern void *xt_unregister_table(struct xt_table *table);
 434
 435 extern struct xt_table_info *xt_replace_table(struct xt_table *table,
 436                                               unsigned int num_counters,
 437                                               struct xt_table_info *newinfo,
 438                                               int *error);
 439
 440 extern struct xt_match *xt_find_match(u8 af, const char *name, u8 revision);
 441 extern struct xt_target *xt_find_target(u8 af, const char *name, u8 revision);
 442 extern struct xt_target *xt_request_find_target(u8 af, const char *name,
 443                                                 u8 revision);
 444 extern int xt_find_revision(u8 af, const char *name, u8 revision,
 445                             int target, int *err);
 446
 447 extern struct xt_table *xt_find_table_lock(struct net *net, u_int8_t af,
 448                                            const char *name);
 449 extern void xt_table_unlock(struct xt_table *t);
 450
 451 extern int xt_proto_init(struct net *net, u_int8_t af);
 452 extern void xt_proto_fini(struct net *net, u_int8_t af);
 453
 454 extern struct xt_table_info *xt_alloc_table_info(unsigned int size);
 455 extern void xt_free_table_info(struct xt_table_info *info);
 456
 457 /*
 458  * Per-CPU spinlock associated with per-cpu table entries, and
 459  * with a counter for the "reading" side that allows a recursive
 460  * reader to avoid taking the lock and deadlocking.
 461  *
 462  * "reading" is used by ip/arp/ip6 tables rule processing which runs per-cpu.
 463  * It needs to ensure that the rules are not being changed while the packet
 464  * is being processed. In some cases, the read lock will be acquired
 465  * twice on the same CPU; this is okay because of the count.
 466  *
 467  * "writing" is used when reading counters.
 468  *  During replace any readers that are using the old tables have to complete
 469  *  before freeing the old table. This is handled by the write locking
 470  *  necessary for reading the counters.
 471  */
 472 struct xt_info_lock {
 473         spinlock_t lock;
 474         unsigned char readers;
 475 };
 476 DECLARE_PER_CPU(struct xt_info_lock, xt_info_locks);
 477
 478 /*
 479  * Note: we need to ensure that preemption is disabled before acquiring
 480  * the per-cpu-variable, so we do it as a two step process rather than
 481  * using "spin_lock_bh()".
 482  *
 483  * We _also_ need to disable bottom half processing before updating our
 484  * nesting count, to make sure that the only kind of re-entrancy is this
 485  * code being called by itself: since the count+lock is not an atomic
 486  * operation, we can allow no races.
 487  *
 488  * _Only_ that special combination of being per-cpu and never getting
 489  * re-entered asynchronously means that the count is safe.
 490  */
 491 static inline void xt_info_rdlock_bh(void)
 492 {
 493         struct xt_info_lock *lock;
 494
 495         local_bh_disable();
 496         lock = &__get_cpu_var(xt_info_locks);
 497         if (likely(!lock->readers++))
 498                 spin_lock(&lock->lock);
 499 }
 500
 501 static inline void xt_info_rdunlock_bh(void)
 502 {
 503         struct xt_info_lock *lock = &__get_cpu_var(xt_info_locks);
 504
 505         if (likely(!--lock->readers))
 506                 spin_unlock(&lock->lock);
 507         local_bh_enable();
 508 }
 509
 510 /*
 511  * The "writer" side needs to get exclusive access to the lock,
 512  * regardless of readers.  This must be called with bottom half
 513  * processing (and thus also preemption) disabled.
 514  */
 515 static inline void xt_info_wrlock(unsigned int cpu)
 516 {
 517         spin_lock(&per_cpu(xt_info_locks, cpu).lock);
 518 }
 519
 520 static inline void xt_info_wrunlock(unsigned int cpu)
 521 {
 522         spin_unlock(&per_cpu(xt_info_locks, cpu).lock);
 523 }
 524
 525 /*
 526  * This helper is performance critical and must be inlined
 527  */
 528 static inline unsigned long ifname_compare_aligned(const char *_a,
 529                                                    const char *_b,
 530                                                    const char *_mask)
 531 {
 532         const unsigned long *a = (const unsigned long *)_a;
 533         const unsigned long *b = (const unsigned long *)_b;
 534         const unsigned long *mask = (const unsigned long *)_mask;
 535         unsigned long ret;
 536
 537         ret = (a[0] ^ b[0]) & mask[0];
 538         if (IFNAMSIZ > sizeof(unsigned long))
 539                 ret |= (a[1] ^ b[1]) & mask[1];
 540         if (IFNAMSIZ > 2 * sizeof(unsigned long))
 541                 ret |= (a[2] ^ b[2]) & mask[2];
 542         if (IFNAMSIZ > 3 * sizeof(unsigned long))
 543                 ret |= (a[3] ^ b[3]) & mask[3];
 544         BUILD_BUG_ON(IFNAMSIZ > 4 * sizeof(unsigned long));
 545         return ret;
 546 }
 547
 548 extern struct nf_hook_ops *xt_hook_link(const struct xt_table *, nf_hookfn *);
 549 extern void xt_hook_unlink(const struct xt_table *, struct nf_hook_ops *);
 550
 551 #ifdef CONFIG_COMPAT
 552 #include <net/compat.h>
 553
 554 struct compat_xt_entry_match {
 555         union {
 556                 struct {
 557                         u_int16_t match_size;
 558                         char name[XT_FUNCTION_MAXNAMELEN - 1];
 559                         u_int8_t revision;
 560                 } user;
 561                 struct {
 562                         u_int16_t match_size;
 563                         compat_uptr_t match;
 564                 } kernel;
 565                 u_int16_t match_size;
 566         } u;
 567         unsigned char data[0];
 568 };
 569
 570 struct compat_xt_entry_target {
 571         union {
 572                 struct {
 573                         u_int16_t target_size;
 574                         char name[XT_FUNCTION_MAXNAMELEN - 1];
 575                         u_int8_t revision;
 576                 } user;
 577                 struct {
 578                         u_int16_t target_size;
 579                         compat_uptr_t target;
 580                 } kernel;
 581                 u_int16_t target_size;
 582         } u;
 583         unsigned char data[0];
 584 };
 585
 586 /* FIXME: this works only on 32 bit tasks
 587  * need to change whole approach in order to calculate align as function of
 588  * current task alignment */
 589
 590 struct compat_xt_counters {
 591         compat_u64 pcnt, bcnt;                  /* Packet and byte counters */
 592 };
 593
 594 struct compat_xt_counters_info {
 595         char name[XT_TABLE_MAXNAMELEN];
 596         compat_uint_t num_counters;
 597         struct compat_xt_counters counters[0];
 598 };
 599
 600 struct _compat_xt_align {
 601         __u8 u8;
 602         __u16 u16;
 603         __u32 u32;
 604         compat_u64 u64;
 605 };
 606
 607 #define COMPAT_XT_ALIGN(s) ALIGN((s), __alignof__(struct _compat_xt_align))
 608
 609 extern void xt_compat_lock(u_int8_t af);
 610 extern void xt_compat_unlock(u_int8_t af);
 611
 612 extern int xt_compat_add_offset(u_int8_t af, unsigned int offset, short delta);
 613 extern void xt_compat_flush_offsets(u_int8_t af);
 614 extern int xt_compat_calc_jump(u_int8_t af, unsigned int offset);
 615
 616 extern int xt_compat_match_offset(const struct xt_match *match);
 617 extern int xt_compat_match_from_user(struct xt_entry_match *m,
 618                                      void **dstptr, unsigned int *size);
 619 extern int xt_compat_match_to_user(const struct xt_entry_match *m,
 620                                    void __user **dstptr, unsigned int *size);
 621
 622 extern int xt_compat_target_offset(const struct xt_target *target);
 623 extern void xt_compat_target_from_user(struct xt_entry_target *t,
 624                                        void **dstptr, unsigned int *size);
 625 extern int xt_compat_target_to_user(const struct xt_entry_target *t,
 626                                     void __user **dstptr, unsigned int *size);
 627
 628 #endif /* CONFIG_COMPAT */
 629 #endif /* __KERNEL__ */
 630
 631 #endif /* _X_TABLES_H */