netfilter: xtables: move extension arguments into compound structure (5/6)
[linux-2.6.git] / include / linux / netfilter / x_tables.h
1 #ifndef _X_TABLES_H
2 #define _X_TABLES_H
3
4 #define XT_FUNCTION_MAXNAMELEN 30
5 #define XT_TABLE_MAXNAMELEN 32
6
7 struct xt_entry_match
8 {
9         union {
10                 struct {
11                         u_int16_t match_size;
12
13                         /* Used by userspace */
14                         char name[XT_FUNCTION_MAXNAMELEN-1];
15
16                         u_int8_t revision;
17                 } user;
18                 struct {
19                         u_int16_t match_size;
20
21                         /* Used inside the kernel */
22                         struct xt_match *match;
23                 } kernel;
24
25                 /* Total length */
26                 u_int16_t match_size;
27         } u;
28
29         unsigned char data[0];
30 };
31
32 struct xt_entry_target
33 {
34         union {
35                 struct {
36                         u_int16_t target_size;
37
38                         /* Used by userspace */
39                         char name[XT_FUNCTION_MAXNAMELEN-1];
40
41                         u_int8_t revision;
42                 } user;
43                 struct {
44                         u_int16_t target_size;
45
46                         /* Used inside the kernel */
47                         struct xt_target *target;
48                 } kernel;
49
50                 /* Total length */
51                 u_int16_t 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 {
67         struct xt_entry_target target;
68         int verdict;
69 };
70
71 /* The argument to IPT_SO_GET_REVISION_*.  Returns highest revision
72  * kernel supports, if >= revision. */
73 struct xt_get_revision
74 {
75         char name[XT_FUNCTION_MAXNAMELEN-1];
76
77         u_int8_t revision;
78 };
79
80 /* CONTINUE verdict for targets */
81 #define XT_CONTINUE 0xFFFFFFFF
82
83 /* For standard target */
84 #define XT_RETURN (-NF_REPEAT - 1)
85
86 /* this is a dummy structure to find out the alignment requirement for a struct
87  * containing all the fundamental data types that are used in ipt_entry,
88  * ip6t_entry and arpt_entry.  This sucks, and it is a hack.  It will be my
89  * personal pleasure to remove it -HW
90  */
91 struct _xt_align
92 {
93         u_int8_t u8;
94         u_int16_t u16;
95         u_int32_t u32;
96         u_int64_t u64;
97 };
98
99 #define XT_ALIGN(s) (((s) + (__alignof__(struct _xt_align)-1))  \
100                         & ~(__alignof__(struct _xt_align)-1))
101
102 /* Standard return verdict, or do jump. */
103 #define XT_STANDARD_TARGET ""
104 /* Error verdict. */
105 #define XT_ERROR_TARGET "ERROR"
106
107 #define SET_COUNTER(c,b,p) do { (c).bcnt = (b); (c).pcnt = (p); } while(0)
108 #define ADD_COUNTER(c,b,p) do { (c).bcnt += (b); (c).pcnt += (p); } while(0)
109
110 struct xt_counters
111 {
112         u_int64_t pcnt, bcnt;                   /* Packet and byte counters */
113 };
114
115 /* The argument to IPT_SO_ADD_COUNTERS. */
116 struct xt_counters_info
117 {
118         /* Which table. */
119         char name[XT_TABLE_MAXNAMELEN];
120
121         unsigned int num_counters;
122
123         /* The counters (actually `number' of these). */
124         struct xt_counters counters[0];
125 };
126
127 #define XT_INV_PROTO            0x40    /* Invert the sense of PROTO. */
128
129 /* fn returns 0 to continue iteration */
130 #define XT_MATCH_ITERATE(type, e, fn, args...)                  \
131 ({                                                              \
132         unsigned int __i;                                       \
133         int __ret = 0;                                          \
134         struct xt_entry_match *__m;                             \
135                                                                 \
136         for (__i = sizeof(type);                                \
137              __i < (e)->target_offset;                          \
138              __i += __m->u.match_size) {                        \
139                 __m = (void *)e + __i;                          \
140                                                                 \
141                 __ret = fn(__m , ## args);                      \
142                 if (__ret != 0)                                 \
143                         break;                                  \
144         }                                                       \
145         __ret;                                                  \
146 })
147
148 /* fn returns 0 to continue iteration */
149 #define XT_ENTRY_ITERATE_CONTINUE(type, entries, size, n, fn, args...) \
150 ({                                                              \
151         unsigned int __i, __n;                                  \
152         int __ret = 0;                                          \
153         type *__entry;                                          \
154                                                                 \
155         for (__i = 0, __n = 0; __i < (size);                    \
156              __i += __entry->next_offset, __n++) {              \
157                 __entry = (void *)(entries) + __i;              \
158                 if (__n < n)                                    \
159                         continue;                               \
160                                                                 \
161                 __ret = fn(__entry , ## args);                  \
162                 if (__ret != 0)                                 \
163                         break;                                  \
164         }                                                       \
165         __ret;                                                  \
166 })
167
168 /* fn returns 0 to continue iteration */
169 #define XT_ENTRY_ITERATE(type, entries, size, fn, args...) \
170         XT_ENTRY_ITERATE_CONTINUE(type, entries, size, 0, fn, args)
171
172 #ifdef __KERNEL__
173
174 #include <linux/netdevice.h>
175
176 /**
177  * struct xt_match_param - parameters for match extensions' match functions
178  *
179  * @in:         input netdevice
180  * @out:        output netdevice
181  * @match:      struct xt_match through which this function was invoked
182  * @matchinfo:  per-match data
183  * @fragoff:    packet is a fragment, this is the data offset
184  * @thoff:      position of transport header relative to skb->data
185  * @hotdrop:    drop packet if we had inspection problems
186  */
187 struct xt_match_param {
188         const struct net_device *in, *out;
189         const struct xt_match *match;
190         const void *matchinfo;
191         int fragoff;
192         unsigned int thoff;
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         const char *table;
209         const void *entryinfo;
210         const struct xt_match *match;
211         void *matchinfo;
212         unsigned int hook_mask;
213 };
214
215 /* Match destructor parameters */
216 struct xt_mtdtor_param {
217         const struct xt_match *match;
218         void *matchinfo;
219 };
220
221 /**
222  * struct xt_target_param - parameters for target extensions' target functions
223  *
224  * @hooknum:    hook through which this target was invoked
225  * @target:     struct xt_target through which this function was invoked
226  * @targinfo:   per-target data
227  *
228  * Other fields see above.
229  */
230 struct xt_target_param {
231         const struct net_device *in, *out;
232         unsigned int hooknum;
233         const struct xt_target *target;
234         const void *targinfo;
235 };
236
237 /**
238  * struct xt_tgchk_param - parameters for target extensions'
239  * checkentry functions
240  *
241  * @entryinfo:  the family-specific rule data
242  *              (struct ipt_entry, ip6t_entry, arpt_entry, ebt_entry)
243  *
244  * Other fields see above.
245  */
246 struct xt_tgchk_param {
247         const char *table;
248         void *entryinfo;
249         const struct xt_target *target;
250         void *targinfo;
251         unsigned int hook_mask;
252 };
253
254 struct xt_match
255 {
256         struct list_head list;
257
258         const char name[XT_FUNCTION_MAXNAMELEN-1];
259
260         /* Return true or false: return FALSE and set *hotdrop = 1 to
261            force immediate packet drop. */
262         /* Arguments changed since 2.6.9, as this must now handle
263            non-linear skb, using skb_header_pointer and
264            skb_ip_make_writable. */
265         bool (*match)(const struct sk_buff *skb,
266                       const struct xt_match_param *);
267
268         /* Called when user tries to insert an entry of this type. */
269         bool (*checkentry)(const struct xt_mtchk_param *);
270
271         /* Called when entry of this type deleted. */
272         void (*destroy)(const struct xt_mtdtor_param *);
273
274         /* Called when userspace align differs from kernel space one */
275         void (*compat_from_user)(void *dst, void *src);
276         int (*compat_to_user)(void __user *dst, void *src);
277
278         /* Set this to THIS_MODULE if you are a module, otherwise NULL */
279         struct module *me;
280
281         /* Free to use by each match */
282         unsigned long data;
283
284         const char *table;
285         unsigned int matchsize;
286         unsigned int compatsize;
287         unsigned int hooks;
288         unsigned short proto;
289
290         unsigned short family;
291         u_int8_t revision;
292 };
293
294 /* Registration hooks for targets. */
295 struct xt_target
296 {
297         struct list_head list;
298
299         const char name[XT_FUNCTION_MAXNAMELEN-1];
300
301         /* Returns verdict. Argument order changed since 2.6.9, as this
302            must now handle non-linear skbs, using skb_copy_bits and
303            skb_ip_make_writable. */
304         unsigned int (*target)(struct sk_buff *skb,
305                                const struct xt_target_param *);
306
307         /* Called when user tries to insert an entry of this type:
308            hook_mask is a bitmask of hooks from which it can be
309            called. */
310         /* Should return true or false. */
311         bool (*checkentry)(const struct xt_tgchk_param *);
312
313         /* Called when entry of this type deleted. */
314         void (*destroy)(const struct xt_target *target, void *targinfo);
315
316         /* Called when userspace align differs from kernel space one */
317         void (*compat_from_user)(void *dst, void *src);
318         int (*compat_to_user)(void __user *dst, void *src);
319
320         /* Set this to THIS_MODULE if you are a module, otherwise NULL */
321         struct module *me;
322
323         const char *table;
324         unsigned int targetsize;
325         unsigned int compatsize;
326         unsigned int hooks;
327         unsigned short proto;
328
329         unsigned short family;
330         u_int8_t revision;
331 };
332
333 /* Furniture shopping... */
334 struct xt_table
335 {
336         struct list_head list;
337
338         /* A unique name... */
339         const char name[XT_TABLE_MAXNAMELEN];
340
341         /* What hooks you will enter on */
342         unsigned int valid_hooks;
343
344         /* Lock for the curtain */
345         rwlock_t lock;
346
347         /* Man behind the curtain... */
348         //struct ip6t_table_info *private;
349         void *private;
350
351         /* Set this to THIS_MODULE if you are a module, otherwise NULL */
352         struct module *me;
353
354         u_int8_t af;            /* address/protocol family */
355 };
356
357 #include <linux/netfilter_ipv4.h>
358
359 /* The table itself */
360 struct xt_table_info
361 {
362         /* Size per table */
363         unsigned int size;
364         /* Number of entries: FIXME. --RR */
365         unsigned int number;
366         /* Initial number of entries. Needed for module usage count */
367         unsigned int initial_entries;
368
369         /* Entry points and underflows */
370         unsigned int hook_entry[NF_INET_NUMHOOKS];
371         unsigned int underflow[NF_INET_NUMHOOKS];
372
373         /* ipt_entry tables: one per CPU */
374         /* Note : this field MUST be the last one, see XT_TABLE_INFO_SZ */
375         char *entries[1];
376 };
377
378 #define XT_TABLE_INFO_SZ (offsetof(struct xt_table_info, entries) \
379                           + nr_cpu_ids * sizeof(char *))
380 extern int xt_register_target(struct xt_target *target);
381 extern void xt_unregister_target(struct xt_target *target);
382 extern int xt_register_targets(struct xt_target *target, unsigned int n);
383 extern void xt_unregister_targets(struct xt_target *target, unsigned int n);
384
385 extern int xt_register_match(struct xt_match *target);
386 extern void xt_unregister_match(struct xt_match *target);
387 extern int xt_register_matches(struct xt_match *match, unsigned int n);
388 extern void xt_unregister_matches(struct xt_match *match, unsigned int n);
389
390 extern int xt_check_match(struct xt_mtchk_param *, u_int8_t family,
391                           unsigned int size, u_int8_t proto, bool inv_proto);
392 extern int xt_check_target(struct xt_tgchk_param *, u_int8_t family,
393                            unsigned int size, u_int8_t proto, bool inv_proto);
394
395 extern struct xt_table *xt_register_table(struct net *net,
396                                           struct xt_table *table,
397                                           struct xt_table_info *bootstrap,
398                                           struct xt_table_info *newinfo);
399 extern void *xt_unregister_table(struct xt_table *table);
400
401 extern struct xt_table_info *xt_replace_table(struct xt_table *table,
402                                               unsigned int num_counters,
403                                               struct xt_table_info *newinfo,
404                                               int *error);
405
406 extern struct xt_match *xt_find_match(u8 af, const char *name, u8 revision);
407 extern struct xt_target *xt_find_target(u8 af, const char *name, u8 revision);
408 extern struct xt_target *xt_request_find_target(u8 af, const char *name,
409                                                 u8 revision);
410 extern int xt_find_revision(u8 af, const char *name, u8 revision,
411                             int target, int *err);
412
413 extern struct xt_table *xt_find_table_lock(struct net *net, u_int8_t af,
414                                            const char *name);
415 extern void xt_table_unlock(struct xt_table *t);
416
417 extern int xt_proto_init(struct net *net, u_int8_t af);
418 extern void xt_proto_fini(struct net *net, u_int8_t af);
419
420 extern struct xt_table_info *xt_alloc_table_info(unsigned int size);
421 extern void xt_free_table_info(struct xt_table_info *info);
422
423 #ifdef CONFIG_COMPAT
424 #include <net/compat.h>
425
426 struct compat_xt_entry_match
427 {
428         union {
429                 struct {
430                         u_int16_t match_size;
431                         char name[XT_FUNCTION_MAXNAMELEN - 1];
432                         u_int8_t revision;
433                 } user;
434                 struct {
435                         u_int16_t match_size;
436                         compat_uptr_t match;
437                 } kernel;
438                 u_int16_t match_size;
439         } u;
440         unsigned char data[0];
441 };
442
443 struct compat_xt_entry_target
444 {
445         union {
446                 struct {
447                         u_int16_t target_size;
448                         char name[XT_FUNCTION_MAXNAMELEN - 1];
449                         u_int8_t revision;
450                 } user;
451                 struct {
452                         u_int16_t target_size;
453                         compat_uptr_t target;
454                 } kernel;
455                 u_int16_t target_size;
456         } u;
457         unsigned char data[0];
458 };
459
460 /* FIXME: this works only on 32 bit tasks
461  * need to change whole approach in order to calculate align as function of
462  * current task alignment */
463
464 struct compat_xt_counters
465 {
466 #if defined(CONFIG_X86_64) || defined(CONFIG_IA64)
467         u_int32_t cnt[4];
468 #else
469         u_int64_t cnt[2];
470 #endif
471 };
472
473 struct compat_xt_counters_info
474 {
475         char name[XT_TABLE_MAXNAMELEN];
476         compat_uint_t num_counters;
477         struct compat_xt_counters counters[0];
478 };
479
480 #define COMPAT_XT_ALIGN(s) (((s) + (__alignof__(struct compat_xt_counters)-1)) \
481                 & ~(__alignof__(struct compat_xt_counters)-1))
482
483 extern void xt_compat_lock(u_int8_t af);
484 extern void xt_compat_unlock(u_int8_t af);
485
486 extern int xt_compat_add_offset(u_int8_t af, unsigned int offset, short delta);
487 extern void xt_compat_flush_offsets(u_int8_t af);
488 extern short xt_compat_calc_jump(u_int8_t af, unsigned int offset);
489
490 extern int xt_compat_match_offset(const struct xt_match *match);
491 extern int xt_compat_match_from_user(struct xt_entry_match *m,
492                                      void **dstptr, unsigned int *size);
493 extern int xt_compat_match_to_user(struct xt_entry_match *m,
494                                    void __user **dstptr, unsigned int *size);
495
496 extern int xt_compat_target_offset(const struct xt_target *target);
497 extern void xt_compat_target_from_user(struct xt_entry_target *t,
498                                        void **dstptr, unsigned int *size);
499 extern int xt_compat_target_to_user(struct xt_entry_target *t,
500                                     void __user **dstptr, unsigned int *size);
501
502 #endif /* CONFIG_COMPAT */
503 #endif /* __KERNEL__ */
504
505 #endif /* _X_TABLES_H */