[NETFILTER]: connection tracking event notifiers
[safe/jmp/linux-2.6] / include / linux / netfilter_ipv4 / ip_conntrack.h
1 #ifndef _IP_CONNTRACK_H
2 #define _IP_CONNTRACK_H
3 /* Connection state tracking for netfilter.  This is separated from,
4    but required by, the NAT layer; it can also be used by an iptables
5    extension. */
6 enum ip_conntrack_info
7 {
8         /* Part of an established connection (either direction). */
9         IP_CT_ESTABLISHED,
10
11         /* Like NEW, but related to an existing connection, or ICMP error
12            (in either direction). */
13         IP_CT_RELATED,
14
15         /* Started a new connection to track (only
16            IP_CT_DIR_ORIGINAL); may be a retransmission. */
17         IP_CT_NEW,
18
19         /* >= this indicates reply direction */
20         IP_CT_IS_REPLY,
21
22         /* Number of distinct IP_CT types (no NEW in reply dirn). */
23         IP_CT_NUMBER = IP_CT_IS_REPLY * 2 - 1
24 };
25
26 /* Bitset representing status of connection. */
27 enum ip_conntrack_status {
28         /* It's an expected connection: bit 0 set.  This bit never changed */
29         IPS_EXPECTED_BIT = 0,
30         IPS_EXPECTED = (1 << IPS_EXPECTED_BIT),
31
32         /* We've seen packets both ways: bit 1 set.  Can be set, not unset. */
33         IPS_SEEN_REPLY_BIT = 1,
34         IPS_SEEN_REPLY = (1 << IPS_SEEN_REPLY_BIT),
35
36         /* Conntrack should never be early-expired. */
37         IPS_ASSURED_BIT = 2,
38         IPS_ASSURED = (1 << IPS_ASSURED_BIT),
39
40         /* Connection is confirmed: originating packet has left box */
41         IPS_CONFIRMED_BIT = 3,
42         IPS_CONFIRMED = (1 << IPS_CONFIRMED_BIT),
43
44         /* Connection needs src nat in orig dir.  This bit never changed. */
45         IPS_SRC_NAT_BIT = 4,
46         IPS_SRC_NAT = (1 << IPS_SRC_NAT_BIT),
47
48         /* Connection needs dst nat in orig dir.  This bit never changed. */
49         IPS_DST_NAT_BIT = 5,
50         IPS_DST_NAT = (1 << IPS_DST_NAT_BIT),
51
52         /* Both together. */
53         IPS_NAT_MASK = (IPS_DST_NAT | IPS_SRC_NAT),
54
55         /* Connection needs TCP sequence adjusted. */
56         IPS_SEQ_ADJUST_BIT = 6,
57         IPS_SEQ_ADJUST = (1 << IPS_SEQ_ADJUST_BIT),
58
59         /* NAT initialization bits. */
60         IPS_SRC_NAT_DONE_BIT = 7,
61         IPS_SRC_NAT_DONE = (1 << IPS_SRC_NAT_DONE_BIT),
62
63         IPS_DST_NAT_DONE_BIT = 8,
64         IPS_DST_NAT_DONE = (1 << IPS_DST_NAT_DONE_BIT),
65
66         /* Both together */
67         IPS_NAT_DONE_MASK = (IPS_DST_NAT_DONE | IPS_SRC_NAT_DONE),
68
69         /* Connection is dying (removed from lists), can not be unset. */
70         IPS_DYING_BIT = 9,
71         IPS_DYING = (1 << IPS_DYING_BIT),
72 };
73
74 /* Connection tracking event bits */
75 enum ip_conntrack_events
76 {
77         /* New conntrack */
78         IPCT_NEW_BIT = 0,
79         IPCT_NEW = (1 << IPCT_NEW_BIT),
80
81         /* Expected connection */
82         IPCT_RELATED_BIT = 1,
83         IPCT_RELATED = (1 << IPCT_RELATED_BIT),
84
85         /* Destroyed conntrack */
86         IPCT_DESTROY_BIT = 2,
87         IPCT_DESTROY = (1 << IPCT_DESTROY_BIT),
88
89         /* Timer has been refreshed */
90         IPCT_REFRESH_BIT = 3,
91         IPCT_REFRESH = (1 << IPCT_REFRESH_BIT),
92
93         /* Status has changed */
94         IPCT_STATUS_BIT = 4,
95         IPCT_STATUS = (1 << IPCT_STATUS_BIT),
96
97         /* Update of protocol info */
98         IPCT_PROTOINFO_BIT = 5,
99         IPCT_PROTOINFO = (1 << IPCT_PROTOINFO_BIT),
100
101         /* Volatile protocol info */
102         IPCT_PROTOINFO_VOLATILE_BIT = 6,
103         IPCT_PROTOINFO_VOLATILE = (1 << IPCT_PROTOINFO_VOLATILE_BIT),
104
105         /* New helper for conntrack */
106         IPCT_HELPER_BIT = 7,
107         IPCT_HELPER = (1 << IPCT_HELPER_BIT),
108
109         /* Update of helper info */
110         IPCT_HELPINFO_BIT = 8,
111         IPCT_HELPINFO = (1 << IPCT_HELPINFO_BIT),
112
113         /* Volatile helper info */
114         IPCT_HELPINFO_VOLATILE_BIT = 9,
115         IPCT_HELPINFO_VOLATILE = (1 << IPCT_HELPINFO_VOLATILE_BIT),
116
117         /* NAT info */
118         IPCT_NATINFO_BIT = 10,
119         IPCT_NATINFO = (1 << IPCT_NATINFO_BIT),
120 };
121
122 enum ip_conntrack_expect_events {
123         IPEXP_NEW_BIT = 0,
124         IPEXP_NEW = (1 << IPEXP_NEW_BIT),
125 };
126
127 #ifdef __KERNEL__
128 #include <linux/config.h>
129 #include <linux/netfilter_ipv4/ip_conntrack_tuple.h>
130 #include <linux/bitops.h>
131 #include <linux/compiler.h>
132 #include <asm/atomic.h>
133
134 #include <linux/netfilter_ipv4/ip_conntrack_tcp.h>
135 #include <linux/netfilter_ipv4/ip_conntrack_icmp.h>
136 #include <linux/netfilter_ipv4/ip_conntrack_sctp.h>
137
138 /* per conntrack: protocol private data */
139 union ip_conntrack_proto {
140         /* insert conntrack proto private data here */
141         struct ip_ct_sctp sctp;
142         struct ip_ct_tcp tcp;
143         struct ip_ct_icmp icmp;
144 };
145
146 union ip_conntrack_expect_proto {
147         /* insert expect proto private data here */
148 };
149
150 /* Add protocol helper include file here */
151 #include <linux/netfilter_ipv4/ip_conntrack_amanda.h>
152 #include <linux/netfilter_ipv4/ip_conntrack_ftp.h>
153 #include <linux/netfilter_ipv4/ip_conntrack_irc.h>
154
155 /* per conntrack: application helper private data */
156 union ip_conntrack_help {
157         /* insert conntrack helper private data (master) here */
158         struct ip_ct_ftp_master ct_ftp_info;
159         struct ip_ct_irc_master ct_irc_info;
160 };
161
162 #ifdef CONFIG_IP_NF_NAT_NEEDED
163 #include <linux/netfilter_ipv4/ip_nat.h>
164 #endif
165
166 #include <linux/types.h>
167 #include <linux/skbuff.h>
168
169 #ifdef CONFIG_NETFILTER_DEBUG
170 #define IP_NF_ASSERT(x)                                                 \
171 do {                                                                    \
172         if (!(x))                                                       \
173                 /* Wooah!  I'm tripping my conntrack in a frenzy of     \
174                    netplay... */                                        \
175                 printk("NF_IP_ASSERT: %s:%i(%s)\n",                     \
176                        __FILE__, __LINE__, __FUNCTION__);               \
177 } while(0)
178 #else
179 #define IP_NF_ASSERT(x)
180 #endif
181
182 struct ip_conntrack_counter
183 {
184         u_int64_t packets;
185         u_int64_t bytes;
186 };
187
188 struct ip_conntrack_helper;
189
190 struct ip_conntrack
191 {
192         /* Usage count in here is 1 for hash table/destruct timer, 1 per skb,
193            plus 1 for any connection(s) we are `master' for */
194         struct nf_conntrack ct_general;
195
196         /* Have we seen traffic both ways yet? (bitset) */
197         unsigned long status;
198
199         /* Timer function; drops refcnt when it goes off. */
200         struct timer_list timeout;
201
202 #ifdef CONFIG_IP_NF_CT_ACCT
203         /* Accounting Information (same cache line as other written members) */
204         struct ip_conntrack_counter counters[IP_CT_DIR_MAX];
205 #endif
206         /* If we were expected by an expectation, this will be it */
207         struct ip_conntrack *master;
208
209         /* Current number of expected connections */
210         unsigned int expecting;
211
212         /* Helper, if any. */
213         struct ip_conntrack_helper *helper;
214
215         /* Storage reserved for other modules: */
216         union ip_conntrack_proto proto;
217
218         union ip_conntrack_help help;
219
220 #ifdef CONFIG_IP_NF_NAT_NEEDED
221         struct {
222                 struct ip_nat_info info;
223 #if defined(CONFIG_IP_NF_TARGET_MASQUERADE) || \
224         defined(CONFIG_IP_NF_TARGET_MASQUERADE_MODULE)
225                 int masq_index;
226 #endif
227         } nat;
228 #endif /* CONFIG_IP_NF_NAT_NEEDED */
229
230 #if defined(CONFIG_IP_NF_CONNTRACK_MARK)
231         u_int32_t mark;
232 #endif
233
234         /* Traversed often, so hopefully in different cacheline to top */
235         /* These are my tuples; original and reply */
236         struct ip_conntrack_tuple_hash tuplehash[IP_CT_DIR_MAX];
237 };
238
239 struct ip_conntrack_expect
240 {
241         /* Internal linked list (global expectation list) */
242         struct list_head list;
243
244         /* We expect this tuple, with the following mask */
245         struct ip_conntrack_tuple tuple, mask;
246  
247         /* Function to call after setup and insertion */
248         void (*expectfn)(struct ip_conntrack *new,
249                          struct ip_conntrack_expect *this);
250
251         /* The conntrack of the master connection */
252         struct ip_conntrack *master;
253
254         /* Timer function; deletes the expectation. */
255         struct timer_list timeout;
256
257         /* Usage count. */
258         atomic_t use;
259
260 #ifdef CONFIG_IP_NF_NAT_NEEDED
261         /* This is the original per-proto part, used to map the
262          * expected connection the way the recipient expects. */
263         union ip_conntrack_manip_proto saved_proto;
264         /* Direction relative to the master connection. */
265         enum ip_conntrack_dir dir;
266 #endif
267 };
268
269 static inline struct ip_conntrack *
270 tuplehash_to_ctrack(const struct ip_conntrack_tuple_hash *hash)
271 {
272         return container_of(hash, struct ip_conntrack,
273                             tuplehash[hash->tuple.dst.dir]);
274 }
275
276 /* get master conntrack via master expectation */
277 #define master_ct(conntr) (conntr->master)
278
279 /* Alter reply tuple (maybe alter helper). */
280 extern void
281 ip_conntrack_alter_reply(struct ip_conntrack *conntrack,
282                          const struct ip_conntrack_tuple *newreply);
283
284 /* Is this tuple taken? (ignoring any belonging to the given
285    conntrack). */
286 extern int
287 ip_conntrack_tuple_taken(const struct ip_conntrack_tuple *tuple,
288                          const struct ip_conntrack *ignored_conntrack);
289
290 /* Return conntrack_info and tuple hash for given skb. */
291 static inline struct ip_conntrack *
292 ip_conntrack_get(const struct sk_buff *skb, enum ip_conntrack_info *ctinfo)
293 {
294         *ctinfo = skb->nfctinfo;
295         return (struct ip_conntrack *)skb->nfct;
296 }
297
298 /* decrement reference count on a conntrack */
299 extern void ip_conntrack_put(struct ip_conntrack *ct);
300
301 /* call to create an explicit dependency on ip_conntrack. */
302 extern void need_ip_conntrack(void);
303
304 extern int invert_tuplepr(struct ip_conntrack_tuple *inverse,
305                           const struct ip_conntrack_tuple *orig);
306
307 /* Refresh conntrack for this many jiffies */
308 extern void ip_ct_refresh_acct(struct ip_conntrack *ct,
309                                enum ip_conntrack_info ctinfo,
310                                const struct sk_buff *skb,
311                                unsigned long extra_jiffies);
312
313 /* These are for NAT.  Icky. */
314 /* Update TCP window tracking data when NAT mangles the packet */
315 extern void ip_conntrack_tcp_update(struct sk_buff *skb,
316                                     struct ip_conntrack *conntrack,
317                                     enum ip_conntrack_dir dir);
318
319 /* Call me when a conntrack is destroyed. */
320 extern void (*ip_conntrack_destroyed)(struct ip_conntrack *conntrack);
321
322 /* Fake conntrack entry for untracked connections */
323 extern struct ip_conntrack ip_conntrack_untracked;
324
325 /* Returns new sk_buff, or NULL */
326 struct sk_buff *
327 ip_ct_gather_frags(struct sk_buff *skb, u_int32_t user);
328
329 /* Iterate over all conntracks: if iter returns true, it's deleted. */
330 extern void
331 ip_ct_iterate_cleanup(int (*iter)(struct ip_conntrack *i, void *data),
332                       void *data);
333
334 /* It's confirmed if it is, or has been in the hash table. */
335 static inline int is_confirmed(struct ip_conntrack *ct)
336 {
337         return test_bit(IPS_CONFIRMED_BIT, &ct->status);
338 }
339
340 static inline int is_dying(struct ip_conntrack *ct)
341 {
342         return test_bit(IPS_DYING_BIT, &ct->status);
343 }
344
345 extern unsigned int ip_conntrack_htable_size;
346  
347 struct ip_conntrack_stat
348 {
349         unsigned int searched;
350         unsigned int found;
351         unsigned int new;
352         unsigned int invalid;
353         unsigned int ignore;
354         unsigned int delete;
355         unsigned int delete_list;
356         unsigned int insert;
357         unsigned int insert_failed;
358         unsigned int drop;
359         unsigned int early_drop;
360         unsigned int error;
361         unsigned int expect_new;
362         unsigned int expect_create;
363         unsigned int expect_delete;
364 };
365
366 #define CONNTRACK_STAT_INC(count) (__get_cpu_var(ip_conntrack_stat).count++)
367
368 #ifdef CONFIG_IP_NF_CONNTRACK_EVENTS
369 #include <linux/notifier.h>
370
371 struct ip_conntrack_ecache {
372         struct ip_conntrack *ct;
373         unsigned int events;
374 };
375 DECLARE_PER_CPU(struct ip_conntrack_ecache, ip_conntrack_ecache);
376
377 #define CONNTRACK_ECACHE(x)     (__get_cpu_var(ip_conntrack_ecache).x)
378  
379 extern struct notifier_block *ip_conntrack_chain;
380 extern struct notifier_block *ip_conntrack_expect_chain;
381
382 static inline int ip_conntrack_register_notifier(struct notifier_block *nb)
383 {
384         return notifier_chain_register(&ip_conntrack_chain, nb);
385 }
386
387 static inline int ip_conntrack_unregister_notifier(struct notifier_block *nb)
388 {
389         return notifier_chain_unregister(&ip_conntrack_chain, nb);
390 }
391
392 static inline int 
393 ip_conntrack_expect_register_notifier(struct notifier_block *nb)
394 {
395         return notifier_chain_register(&ip_conntrack_expect_chain, nb);
396 }
397
398 static inline int
399 ip_conntrack_expect_unregister_notifier(struct notifier_block *nb)
400 {
401         return notifier_chain_unregister(&ip_conntrack_expect_chain, nb);
402 }
403
404 static inline void 
405 ip_conntrack_event_cache(enum ip_conntrack_events event,
406                          const struct sk_buff *skb)
407 {
408         struct ip_conntrack_ecache *ecache = 
409                                         &__get_cpu_var(ip_conntrack_ecache);
410
411         if (unlikely((struct ip_conntrack *) skb->nfct != ecache->ct)) {
412                 if (net_ratelimit()) {
413                         printk(KERN_ERR "ctevent: skb->ct != ecache->ct !!!\n");
414                         dump_stack();
415                 }
416         }
417         ecache->events |= event;
418 }
419
420 extern void 
421 ip_conntrack_deliver_cached_events_for(const struct ip_conntrack *ct);
422 extern void ip_conntrack_event_cache_init(const struct sk_buff *skb);
423
424 static inline void ip_conntrack_event(enum ip_conntrack_events event,
425                                       struct ip_conntrack *ct)
426 {
427         if (is_confirmed(ct) && !is_dying(ct))
428                 notifier_call_chain(&ip_conntrack_chain, event, ct);
429 }
430
431 static inline void 
432 ip_conntrack_expect_event(enum ip_conntrack_expect_events event,
433                           struct ip_conntrack_expect *exp)
434 {
435         notifier_call_chain(&ip_conntrack_expect_chain, event, exp);
436 }
437 #else /* CONFIG_IP_NF_CONNTRACK_EVENTS */
438 static inline void ip_conntrack_event_cache(enum ip_conntrack_events event, 
439                                             const struct sk_buff *skb) {}
440 static inline void ip_conntrack_event(enum ip_conntrack_events event, 
441                                       struct ip_conntrack *ct) {}
442 static inline void ip_conntrack_deliver_cached_events_for(
443                                                 struct ip_conntrack *ct) {}
444 static inline void ip_conntrack_event_cache_init(const struct sk_buff *skb) {}
445 static inline void 
446 ip_conntrack_expect_event(enum ip_conntrack_expect_events event, 
447                           struct ip_conntrack_expect *exp) {}
448 #endif /* CONFIG_IP_NF_CONNTRACK_EVENTS */
449
450 #ifdef CONFIG_IP_NF_NAT_NEEDED
451 static inline int ip_nat_initialized(struct ip_conntrack *conntrack,
452                                      enum ip_nat_manip_type manip)
453 {
454         if (manip == IP_NAT_MANIP_SRC)
455                 return test_bit(IPS_SRC_NAT_DONE_BIT, &conntrack->status);
456         return test_bit(IPS_DST_NAT_DONE_BIT, &conntrack->status);
457 }
458 #endif /* CONFIG_IP_NF_NAT_NEEDED */
459
460 #endif /* __KERNEL__ */
461 #endif /* _IP_CONNTRACK_H */