netfilter: xtables: move extension arguments into compound structure (3/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 struct xt_match
222 {
223         struct list_head list;
224
225         const char name[XT_FUNCTION_MAXNAMELEN-1];
226
227         /* Return true or false: return FALSE and set *hotdrop = 1 to
228            force immediate packet drop. */
229         /* Arguments changed since 2.6.9, as this must now handle
230            non-linear skb, using skb_header_pointer and
231            skb_ip_make_writable. */
232         bool (*match)(const struct sk_buff *skb,
233                       const struct xt_match_param *);
234
235         /* Called when user tries to insert an entry of this type. */
236         bool (*checkentry)(const struct xt_mtchk_param *);
237
238         /* Called when entry of this type deleted. */
239         void (*destroy)(const struct xt_mtdtor_param *);
240
241         /* Called when userspace align differs from kernel space one */
242         void (*compat_from_user)(void *dst, void *src);
243         int (*compat_to_user)(void __user *dst, void *src);
244
245         /* Set this to THIS_MODULE if you are a module, otherwise NULL */
246         struct module *me;
247
248         /* Free to use by each match */
249         unsigned long data;
250
251         const char *table;
252         unsigned int matchsize;
253         unsigned int compatsize;
254         unsigned int hooks;
255         unsigned short proto;
256
257         unsigned short family;
258         u_int8_t revision;
259 };
260
261 /* Registration hooks for targets. */
262 struct xt_target
263 {
264         struct list_head list;
265
266         const char name[XT_FUNCTION_MAXNAMELEN-1];
267
268         /* Returns verdict. Argument order changed since 2.6.9, as this
269            must now handle non-linear skbs, using skb_copy_bits and
270            skb_ip_make_writable. */
271         unsigned int (*target)(struct sk_buff *skb,
272                                const struct net_device *in,
273                                const struct net_device *out,
274                                unsigned int hooknum,
275                                const struct xt_target *target,
276                                const void *targinfo);
277
278         /* Called when user tries to insert an entry of this type:
279            hook_mask is a bitmask of hooks from which it can be
280            called. */
281         /* Should return true or false. */
282         bool (*checkentry)(const char *tablename,
283                            const void *entry,
284                            const struct xt_target *target,
285                            void *targinfo,
286                            unsigned int hook_mask);
287
288         /* Called when entry of this type deleted. */
289         void (*destroy)(const struct xt_target *target, void *targinfo);
290
291         /* Called when userspace align differs from kernel space one */
292         void (*compat_from_user)(void *dst, void *src);
293         int (*compat_to_user)(void __user *dst, void *src);
294
295         /* Set this to THIS_MODULE if you are a module, otherwise NULL */
296         struct module *me;
297
298         const char *table;
299         unsigned int targetsize;
300         unsigned int compatsize;
301         unsigned int hooks;
302         unsigned short proto;
303
304         unsigned short family;
305         u_int8_t revision;
306 };
307
308 /* Furniture shopping... */
309 struct xt_table
310 {
311         struct list_head list;
312
313         /* A unique name... */
314         const char name[XT_TABLE_MAXNAMELEN];
315
316         /* What hooks you will enter on */
317         unsigned int valid_hooks;
318
319         /* Lock for the curtain */
320         rwlock_t lock;
321
322         /* Man behind the curtain... */
323         //struct ip6t_table_info *private;
324         void *private;
325
326         /* Set this to THIS_MODULE if you are a module, otherwise NULL */
327         struct module *me;
328
329         u_int8_t af;            /* address/protocol family */
330 };
331
332 #include <linux/netfilter_ipv4.h>
333
334 /* The table itself */
335 struct xt_table_info
336 {
337         /* Size per table */
338         unsigned int size;
339         /* Number of entries: FIXME. --RR */
340         unsigned int number;
341         /* Initial number of entries. Needed for module usage count */
342         unsigned int initial_entries;
343
344         /* Entry points and underflows */
345         unsigned int hook_entry[NF_INET_NUMHOOKS];
346         unsigned int underflow[NF_INET_NUMHOOKS];
347
348         /* ipt_entry tables: one per CPU */
349         /* Note : this field MUST be the last one, see XT_TABLE_INFO_SZ */
350         char *entries[1];
351 };
352
353 #define XT_TABLE_INFO_SZ (offsetof(struct xt_table_info, entries) \
354                           + nr_cpu_ids * sizeof(char *))
355 extern int xt_register_target(struct xt_target *target);
356 extern void xt_unregister_target(struct xt_target *target);
357 extern int xt_register_targets(struct xt_target *target, unsigned int n);
358 extern void xt_unregister_targets(struct xt_target *target, unsigned int n);
359
360 extern int xt_register_match(struct xt_match *target);
361 extern void xt_unregister_match(struct xt_match *target);
362 extern int xt_register_matches(struct xt_match *match, unsigned int n);
363 extern void xt_unregister_matches(struct xt_match *match, unsigned int n);
364
365 extern int xt_check_match(struct xt_mtchk_param *, u_int8_t family,
366                           unsigned int size, u_int8_t proto, bool inv_proto);
367 extern int xt_check_target(const struct xt_target *target, unsigned short family,
368                            unsigned int size, const char *table, unsigned int hook,
369                            unsigned short proto, int inv_proto,
370                            const void *entry, void *targinfo);
371
372 extern struct xt_table *xt_register_table(struct net *net,
373                                           struct xt_table *table,
374                                           struct xt_table_info *bootstrap,
375                                           struct xt_table_info *newinfo);
376 extern void *xt_unregister_table(struct xt_table *table);
377
378 extern struct xt_table_info *xt_replace_table(struct xt_table *table,
379                                               unsigned int num_counters,
380                                               struct xt_table_info *newinfo,
381                                               int *error);
382
383 extern struct xt_match *xt_find_match(u8 af, const char *name, u8 revision);
384 extern struct xt_target *xt_find_target(u8 af, const char *name, u8 revision);
385 extern struct xt_target *xt_request_find_target(u8 af, const char *name,
386                                                 u8 revision);
387 extern int xt_find_revision(u8 af, const char *name, u8 revision,
388                             int target, int *err);
389
390 extern struct xt_table *xt_find_table_lock(struct net *net, u_int8_t af,
391                                            const char *name);
392 extern void xt_table_unlock(struct xt_table *t);
393
394 extern int xt_proto_init(struct net *net, u_int8_t af);
395 extern void xt_proto_fini(struct net *net, u_int8_t af);
396
397 extern struct xt_table_info *xt_alloc_table_info(unsigned int size);
398 extern void xt_free_table_info(struct xt_table_info *info);
399
400 #ifdef CONFIG_COMPAT
401 #include <net/compat.h>
402
403 struct compat_xt_entry_match
404 {
405         union {
406                 struct {
407                         u_int16_t match_size;
408                         char name[XT_FUNCTION_MAXNAMELEN - 1];
409                         u_int8_t revision;
410                 } user;
411                 struct {
412                         u_int16_t match_size;
413                         compat_uptr_t match;
414                 } kernel;
415                 u_int16_t match_size;
416         } u;
417         unsigned char data[0];
418 };
419
420 struct compat_xt_entry_target
421 {
422         union {
423                 struct {
424                         u_int16_t target_size;
425                         char name[XT_FUNCTION_MAXNAMELEN - 1];
426                         u_int8_t revision;
427                 } user;
428                 struct {
429                         u_int16_t target_size;
430                         compat_uptr_t target;
431                 } kernel;
432                 u_int16_t target_size;
433         } u;
434         unsigned char data[0];
435 };
436
437 /* FIXME: this works only on 32 bit tasks
438  * need to change whole approach in order to calculate align as function of
439  * current task alignment */
440
441 struct compat_xt_counters
442 {
443 #if defined(CONFIG_X86_64) || defined(CONFIG_IA64)
444         u_int32_t cnt[4];
445 #else
446         u_int64_t cnt[2];
447 #endif
448 };
449
450 struct compat_xt_counters_info
451 {
452         char name[XT_TABLE_MAXNAMELEN];
453         compat_uint_t num_counters;
454         struct compat_xt_counters counters[0];
455 };
456
457 #define COMPAT_XT_ALIGN(s) (((s) + (__alignof__(struct compat_xt_counters)-1)) \
458                 & ~(__alignof__(struct compat_xt_counters)-1))
459
460 extern void xt_compat_lock(u_int8_t af);
461 extern void xt_compat_unlock(u_int8_t af);
462
463 extern int xt_compat_add_offset(u_int8_t af, unsigned int offset, short delta);
464 extern void xt_compat_flush_offsets(u_int8_t af);
465 extern short xt_compat_calc_jump(u_int8_t af, unsigned int offset);
466
467 extern int xt_compat_match_offset(const struct xt_match *match);
468 extern int xt_compat_match_from_user(struct xt_entry_match *m,
469                                      void **dstptr, unsigned int *size);
470 extern int xt_compat_match_to_user(struct xt_entry_match *m,
471                                    void __user **dstptr, unsigned int *size);
472
473 extern int xt_compat_target_offset(const struct xt_target *target);
474 extern void xt_compat_target_from_user(struct xt_entry_target *t,
475                                        void **dstptr, unsigned int *size);
476 extern int xt_compat_target_to_user(struct xt_entry_target *t,
477                                     void __user **dstptr, unsigned int *size);
478
479 #endif /* CONFIG_COMPAT */
480 #endif /* __KERNEL__ */
481
482 #endif /* _X_TABLES_H */