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