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