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) (((s) + (__alignof__(struct _xt_align)-1))  \
  97                         & ~(__alignof__(struct _xt_align)-1))
  98
  99 /* Standard return verdict, or do jump. */
 100 #define XT_STANDARD_TARGET ""
 101 /* Error verdict. */
 102 #define XT_ERROR_TARGET "ERROR"
 103
 104 #define SET_COUNTER(c,b,p) do { (c).bcnt = (b); (c).pcnt = (p); } while(0)
 105 #define ADD_COUNTER(c,b,p) do { (c).bcnt += (b); (c).pcnt += (p); } while(0)
 106
 107 struct xt_counters {
 108         __u64 pcnt, bcnt;                       /* Packet and byte counters */
 109 };
 110
 111 /* The argument to IPT_SO_ADD_COUNTERS. */
 112 struct xt_counters_info {
 113         /* Which table. */
 114         char name[XT_TABLE_MAXNAMELEN];
 115
 116         unsigned int num_counters;
 117
 118         /* The counters (actually `number' of these). */
 119         struct xt_counters counters[0];
 120 };
 121
 122 #define XT_INV_PROTO            0x40    /* Invert the sense of PROTO. */
 123
 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 #ifdef __KERNEL__
 168
 169 #include <linux/netdevice.h>
 170
 171 /**
 172  * struct xt_match_param - parameters for match extensions' match functions
 173  *
 174  * @in:         input netdevice
 175  * @out:        output netdevice
 176  * @match:      struct xt_match through which this function was invoked
 177  * @matchinfo:  per-match data
 178  * @fragoff:    packet is a fragment, this is the data offset
 179  * @thoff:      position of transport header relative to skb->data
 180  * @hook:       hook number given packet came from
 181  * @family:     Actual NFPROTO_* through which the function is invoked
 182  *              (helpful when match->family == NFPROTO_UNSPEC)
 183  * @hotdrop:    drop packet if we had inspection problems
 184  */
 185 struct xt_match_param {
 186         const struct net_device *in, *out;
 187         const struct xt_match *match;
 188         const void *matchinfo;
 189         int fragoff;
 190         unsigned int thoff;
 191         unsigned int hooknum;
 192         u_int8_t family;
 193         bool *hotdrop;
 194 };
 195
 196 /**
 197  * struct xt_mtchk_param - parameters for match extensions'
 198  * checkentry functions
 199  *
 200  * @table:      table the rule is tried to be inserted into
 201  * @entryinfo:  the family-specific rule data
 202  *              (struct ipt_ip, ip6t_ip, ebt_entry)
 203  * @match:      struct xt_match through which this function was invoked
 204  * @matchinfo:  per-match data
 205  * @hook_mask:  via which hooks the new rule is reachable
 206  */
 207 struct xt_mtchk_param {
 208         struct net *net;
 209         const char *table;
 210         const void *entryinfo;
 211         const struct xt_match *match;
 212         void *matchinfo;
 213         unsigned int hook_mask;
 214         u_int8_t family;
 215 };
 216
 217 /* Match destructor parameters */
 218 struct xt_mtdtor_param {
 219         struct net *net;
 220         const struct xt_match *match;
 221         void *matchinfo;
 222         u_int8_t family;
 223 };
 224
 225 /**
 226  * struct xt_target_param - parameters for target extensions' target functions
 227  *
 228  * @hooknum:    hook through which this target was invoked
 229  * @target:     struct xt_target through which this function was invoked
 230  * @targinfo:   per-target data
 231  *
 232  * Other fields see above.
 233  */
 234 struct xt_target_param {
 235         const struct net_device *in, *out;
 236         const struct xt_target *target;
 237         const void *targinfo;
 238         unsigned int hooknum;
 239         u_int8_t family;
 240 };
 241
 242 /**
 243  * struct xt_tgchk_param - parameters for target extensions'
 244  * checkentry functions
 245  *
 246  * @entryinfo:  the family-specific rule data
 247  *              (struct ipt_entry, ip6t_entry, arpt_entry, ebt_entry)
 248  *
 249  * Other fields see above.
 250  */
 251 struct xt_tgchk_param {
 252         struct net *net;
 253         const char *table;
 254         const void *entryinfo;
 255         const struct xt_target *target;
 256         void *targinfo;
 257         unsigned int hook_mask;
 258         u_int8_t family;
 259 };
 260
 261 /* Target destructor parameters */
 262 struct xt_tgdtor_param {
 263         struct net *net;
 264         const struct xt_target *target;
 265         void *targinfo;
 266         u_int8_t family;
 267 };
 268
 269 struct xt_match {
 270         struct list_head list;
 271
 272         const char name[XT_FUNCTION_MAXNAMELEN-1];
 273         u_int8_t revision;
 274
 275         /* Return true or false: return FALSE and set *hotdrop = 1 to
 276            force immediate packet drop. */
 277         /* Arguments changed since 2.6.9, as this must now handle
 278            non-linear skb, using skb_header_pointer and
 279            skb_ip_make_writable. */
 280         bool (*match)(const struct sk_buff *skb,
 281                       const struct xt_match_param *);
 282
 283         /* Called when user tries to insert an entry of this type. */
 284         bool (*checkentry)(const struct xt_mtchk_param *);
 285
 286         /* Called when entry of this type deleted. */
 287         void (*destroy)(const struct xt_mtdtor_param *);
 288 #ifdef CONFIG_COMPAT
 289         /* Called when userspace align differs from kernel space one */
 290         void (*compat_from_user)(void *dst, void *src);
 291         int (*compat_to_user)(void __user *dst, void *src);
 292 #endif
 293         /* Set this to THIS_MODULE if you are a module, otherwise NULL */
 294         struct module *me;
 295
 296         /* Free to use by each match */
 297         unsigned long data;
 298
 299         const char *table;
 300         unsigned int matchsize;
 301 #ifdef CONFIG_COMPAT
 302         unsigned int compatsize;
 303 #endif
 304         unsigned int hooks;
 305         unsigned short proto;
 306
 307         unsigned short family;
 308 };
 309
 310 /* Registration hooks for targets. */
 311 struct xt_target {
 312         struct list_head list;
 313
 314         const char name[XT_FUNCTION_MAXNAMELEN-1];
 315
 316         /* Returns verdict. Argument order changed since 2.6.9, as this
 317            must now handle non-linear skbs, using skb_copy_bits and
 318            skb_ip_make_writable. */
 319         unsigned int (*target)(struct sk_buff *skb,
 320                                const struct xt_target_param *);
 321
 322         /* Called when user tries to insert an entry of this type:
 323            hook_mask is a bitmask of hooks from which it can be
 324            called. */
 325         /* Should return true or false. */
 326         bool (*checkentry)(const struct xt_tgchk_param *);
 327
 328         /* Called when entry of this type deleted. */
 329         void (*destroy)(const struct xt_tgdtor_param *);
 330 #ifdef CONFIG_COMPAT
 331         /* Called when userspace align differs from kernel space one */
 332         void (*compat_from_user)(void *dst, void *src);
 333         int (*compat_to_user)(void __user *dst, void *src);
 334 #endif
 335         /* Set this to THIS_MODULE if you are a module, otherwise NULL */
 336         struct module *me;
 337
 338         const char *table;
 339         unsigned int targetsize;
 340 #ifdef CONFIG_COMPAT
 341         unsigned int compatsize;
 342 #endif
 343         unsigned int hooks;
 344         unsigned short proto;
 345
 346         unsigned short family;
 347         u_int8_t revision;
 348 };
 349
 350 /* Furniture shopping... */
 351 struct xt_table {
 352         struct list_head list;
 353
 354         /* What hooks you will enter on */
 355         unsigned int valid_hooks;
 356
 357         /* Man behind the curtain... */
 358         struct xt_table_info *private;
 359
 360         /* Set this to THIS_MODULE if you are a module, otherwise NULL */
 361         struct module *me;
 362
 363         u_int8_t af;            /* address/protocol family */
 364
 365         /* A unique name... */
 366         const char name[XT_TABLE_MAXNAMELEN];
 367 };
 368
 369 #include <linux/netfilter_ipv4.h>
 370
 371 /* The table itself */
 372 struct xt_table_info {
 373         /* Size per table */
 374         unsigned int size;
 375         /* Number of entries: FIXME. --RR */
 376         unsigned int number;
 377         /* Initial number of entries. Needed for module usage count */
 378         unsigned int initial_entries;
 379
 380         /* Entry points and underflows */
 381         unsigned int hook_entry[NF_INET_NUMHOOKS];
 382         unsigned int underflow[NF_INET_NUMHOOKS];
 383
 384         /* ipt_entry tables: one per CPU */
 385         /* Note : this field MUST be the last one, see XT_TABLE_INFO_SZ */
 386         void *entries[1];
 387 };
 388
 389 #define XT_TABLE_INFO_SZ (offsetof(struct xt_table_info, entries) \
 390                           + nr_cpu_ids * sizeof(char *))
 391 extern int xt_register_target(struct xt_target *target);
 392 extern void xt_unregister_target(struct xt_target *target);
 393 extern int xt_register_targets(struct xt_target *target, unsigned int n);
 394 extern void xt_unregister_targets(struct xt_target *target, unsigned int n);
 395
 396 extern int xt_register_match(struct xt_match *target);
 397 extern void xt_unregister_match(struct xt_match *target);
 398 extern int xt_register_matches(struct xt_match *match, unsigned int n);
 399 extern void xt_unregister_matches(struct xt_match *match, unsigned int n);
 400
 401 extern int xt_check_match(struct xt_mtchk_param *,
 402                           unsigned int size, u_int8_t proto, bool inv_proto);
 403 extern int xt_check_target(struct xt_tgchk_param *,
 404                            unsigned int size, u_int8_t proto, bool inv_proto);
 405
 406 extern struct xt_table *xt_register_table(struct net *net,
 407                                           const struct xt_table *table,
 408                                           struct xt_table_info *bootstrap,
 409                                           struct xt_table_info *newinfo);
 410 extern void *xt_unregister_table(struct xt_table *table);
 411
 412 extern struct xt_table_info *xt_replace_table(struct xt_table *table,
 413                                               unsigned int num_counters,
 414                                               struct xt_table_info *newinfo,
 415                                               int *error);
 416
 417 extern struct xt_match *xt_find_match(u8 af, const char *name, u8 revision);
 418 extern struct xt_target *xt_find_target(u8 af, const char *name, u8 revision);
 419 extern struct xt_target *xt_request_find_target(u8 af, const char *name,
 420                                                 u8 revision);
 421 extern int xt_find_revision(u8 af, const char *name, u8 revision,
 422                             int target, int *err);
 423
 424 extern struct xt_table *xt_find_table_lock(struct net *net, u_int8_t af,
 425                                            const char *name);
 426 extern void xt_table_unlock(struct xt_table *t);
 427
 428 extern int xt_proto_init(struct net *net, u_int8_t af);
 429 extern void xt_proto_fini(struct net *net, u_int8_t af);
 430
 431 extern struct xt_table_info *xt_alloc_table_info(unsigned int size);
 432 extern void xt_free_table_info(struct xt_table_info *info);
 433
 434 /*
 435  * Per-CPU spinlock associated with per-cpu table entries, and
 436  * with a counter for the "reading" side that allows a recursive
 437  * reader to avoid taking the lock and deadlocking.
 438  *
 439  * "reading" is used by ip/arp/ip6 tables rule processing which runs per-cpu.
 440  * It needs to ensure that the rules are not being changed while the packet
 441  * is being processed. In some cases, the read lock will be acquired
 442  * twice on the same CPU; this is okay because of the count.
 443  *
 444  * "writing" is used when reading counters.
 445  *  During replace any readers that are using the old tables have to complete
 446  *  before freeing the old table. This is handled by the write locking
 447  *  necessary for reading the counters.
 448  */
 449 struct xt_info_lock {
 450         spinlock_t lock;
 451         unsigned char readers;
 452 };
 453 DECLARE_PER_CPU(struct xt_info_lock, xt_info_locks);
 454
 455 /*
 456  * Note: we need to ensure that preemption is disabled before acquiring
 457  * the per-cpu-variable, so we do it as a two step process rather than
 458  * using "spin_lock_bh()".
 459  *
 460  * We _also_ need to disable bottom half processing before updating our
 461  * nesting count, to make sure that the only kind of re-entrancy is this
 462  * code being called by itself: since the count+lock is not an atomic
 463  * operation, we can allow no races.
 464  *
 465  * _Only_ that special combination of being per-cpu and never getting
 466  * re-entered asynchronously means that the count is safe.
 467  */
 468 static inline void xt_info_rdlock_bh(void)
 469 {
 470         struct xt_info_lock *lock;
 471
 472         local_bh_disable();
 473         lock = &__get_cpu_var(xt_info_locks);
 474         if (likely(!lock->readers++))
 475                 spin_lock(&lock->lock);
 476 }
 477
 478 static inline void xt_info_rdunlock_bh(void)
 479 {
 480         struct xt_info_lock *lock = &__get_cpu_var(xt_info_locks);
 481
 482         if (likely(!--lock->readers))
 483                 spin_unlock(&lock->lock);
 484         local_bh_enable();
 485 }
 486
 487 /*
 488  * The "writer" side needs to get exclusive access to the lock,
 489  * regardless of readers.  This must be called with bottom half
 490  * processing (and thus also preemption) disabled.
 491  */
 492 static inline void xt_info_wrlock(unsigned int cpu)
 493 {
 494         spin_lock(&per_cpu(xt_info_locks, cpu).lock);
 495 }
 496
 497 static inline void xt_info_wrunlock(unsigned int cpu)
 498 {
 499         spin_unlock(&per_cpu(xt_info_locks, cpu).lock);
 500 }
 501
 502 /*
 503  * This helper is performance critical and must be inlined
 504  */
 505 static inline unsigned long ifname_compare_aligned(const char *_a,
 506                                                    const char *_b,
 507                                                    const char *_mask)
 508 {
 509         const unsigned long *a = (const unsigned long *)_a;
 510         const unsigned long *b = (const unsigned long *)_b;
 511         const unsigned long *mask = (const unsigned long *)_mask;
 512         unsigned long ret;
 513
 514         ret = (a[0] ^ b[0]) & mask[0];
 515         if (IFNAMSIZ > sizeof(unsigned long))
 516                 ret |= (a[1] ^ b[1]) & mask[1];
 517         if (IFNAMSIZ > 2 * sizeof(unsigned long))
 518                 ret |= (a[2] ^ b[2]) & mask[2];
 519         if (IFNAMSIZ > 3 * sizeof(unsigned long))
 520                 ret |= (a[3] ^ b[3]) & mask[3];
 521         BUILD_BUG_ON(IFNAMSIZ > 4 * sizeof(unsigned long));
 522         return ret;
 523 }
 524
 525 #ifdef CONFIG_COMPAT
 526 #include <net/compat.h>
 527
 528 struct compat_xt_entry_match {
 529         union {
 530                 struct {
 531                         u_int16_t match_size;
 532                         char name[XT_FUNCTION_MAXNAMELEN - 1];
 533                         u_int8_t revision;
 534                 } user;
 535                 struct {
 536                         u_int16_t match_size;
 537                         compat_uptr_t match;
 538                 } kernel;
 539                 u_int16_t match_size;
 540         } u;
 541         unsigned char data[0];
 542 };
 543
 544 struct compat_xt_entry_target {
 545         union {
 546                 struct {
 547                         u_int16_t target_size;
 548                         char name[XT_FUNCTION_MAXNAMELEN - 1];
 549                         u_int8_t revision;
 550                 } user;
 551                 struct {
 552                         u_int16_t target_size;
 553                         compat_uptr_t target;
 554                 } kernel;
 555                 u_int16_t target_size;
 556         } u;
 557         unsigned char data[0];
 558 };
 559
 560 /* FIXME: this works only on 32 bit tasks
 561  * need to change whole approach in order to calculate align as function of
 562  * current task alignment */
 563
 564 struct compat_xt_counters {
 565 #if defined(CONFIG_X86_64) || defined(CONFIG_IA64)
 566         u_int32_t cnt[4];
 567 #else
 568         u_int64_t cnt[2];
 569 #endif
 570 };
 571
 572 struct compat_xt_counters_info {
 573         char name[XT_TABLE_MAXNAMELEN];
 574         compat_uint_t num_counters;
 575         struct compat_xt_counters counters[0];
 576 };
 577
 578 #define COMPAT_XT_ALIGN(s) (((s) + (__alignof__(struct compat_xt_counters)-1)) \
 579                 & ~(__alignof__(struct compat_xt_counters)-1))
 580
 581 extern void xt_compat_lock(u_int8_t af);
 582 extern void xt_compat_unlock(u_int8_t af);
 583
 584 extern int xt_compat_add_offset(u_int8_t af, unsigned int offset, short delta);
 585 extern void xt_compat_flush_offsets(u_int8_t af);
 586 extern short xt_compat_calc_jump(u_int8_t af, unsigned int offset);
 587
 588 extern int xt_compat_match_offset(const struct xt_match *match);
 589 extern int xt_compat_match_from_user(struct xt_entry_match *m,
 590                                      void **dstptr, unsigned int *size);
 591 extern int xt_compat_match_to_user(struct xt_entry_match *m,
 592                                    void __user **dstptr, unsigned int *size);
 593
 594 extern int xt_compat_target_offset(const struct xt_target *target);
 595 extern void xt_compat_target_from_user(struct xt_entry_target *t,
 596                                        void **dstptr, unsigned int *size);
 597 extern int xt_compat_target_to_user(struct xt_entry_target *t,
 598                                     void __user **dstptr, unsigned int *size);
 599
 600 #endif /* CONFIG_COMPAT */
 601 #endif /* __KERNEL__ */
 602
 603 #endif /* _X_TABLES_H */