2 * Connection state tracking for netfilter. This is separated from,
3 * but required by, the (future) NAT layer; it can also be used by an iptables
6 * 16 Dec 2003: Yasuyuki Kozakai @USAGI <yasuyuki.kozakai@toshiba.co.jp>
7 * - generalize L3 protocol dependent part.
9 * Derived from include/linux/netfiter_ipv4/ip_conntrack.h
12 #ifndef _NF_CONNTRACK_H
13 #define _NF_CONNTRACK_H
15 #include <linux/netfilter/nf_conntrack_common.h>
19 #if defined(CONFIG_BCM_NAT) || defined(CONFIG_BCM_NAT_MODULE)
20 #define BCM_FASTNAT_DENY 1
23 #include <linux/bitops.h>
24 #include <linux/compiler.h>
25 #include <asm/atomic.h>
27 #include <linux/netfilter/nf_conntrack_tcp.h>
28 #include <linux/netfilter/nf_conntrack_sctp.h>
29 #include <linux/netfilter/nf_conntrack_proto_gre.h>
30 #include <net/netfilter/ipv4/nf_conntrack_icmp.h>
31 #include <net/netfilter/ipv6/nf_conntrack_icmpv6.h>
33 #include <net/netfilter/nf_conntrack_tuple.h>
35 #if defined(CONFIG_NETFILTER_XT_MATCH_LAYER7) || \
36 defined(CONFIG_NETFILTER_XT_MATCH_LAYER7_MODULE)
40 * e.g. "http". NULL before decision. "unknown" after decision
45 * application layer data so far. NULL after match decision.
48 unsigned int app_data_len
;
52 /* per conntrack: protocol private data */
53 union nf_conntrack_proto
{
54 /* insert conntrack proto private data here */
55 struct ip_ct_sctp sctp
;
57 struct ip_ct_icmp icmp
;
58 struct nf_ct_icmpv6 icmpv6
;
62 union nf_conntrack_expect_proto
{
63 /* insert expect proto private data here */
66 /* Add protocol helper include file here */
67 #include <linux/netfilter/nf_conntrack_ftp.h>
68 #include <linux/netfilter/nf_conntrack_pptp.h>
69 #include <linux/netfilter/nf_conntrack_h323.h>
70 #include <linux/netfilter/nf_conntrack_sane.h>
71 #include <linux/netfilter/nf_conntrack_sip.h>
72 #include <linux/netfilter/nf_conntrack_autofw.h>
74 /* per conntrack: application helper private data */
75 union nf_conntrack_help
{
76 /* insert conntrack helper private data (master) here */
77 struct nf_ct_ftp_master ct_ftp_info
;
78 struct nf_ct_pptp_master ct_pptp_info
;
79 struct nf_ct_h323_master ct_h323_info
;
80 struct nf_ct_sane_master ct_sane_info
;
81 struct nf_ct_sip_master ct_sip_info
;
82 struct nf_ct_autofw_master ct_autofw_info
;
85 #include <linux/types.h>
86 #include <linux/skbuff.h>
87 #include <linux/timer.h>
89 #ifdef CONFIG_NETFILTER_DEBUG
90 #define NF_CT_ASSERT(x) \
93 /* Wooah! I'm tripping my conntrack in a frenzy of \
95 printk("NF_CT_ASSERT: %s:%i(%s)\n", \
96 __FILE__, __LINE__, __FUNCTION__); \
99 #define NF_CT_ASSERT(x)
102 struct nf_conntrack_helper
;
104 /* Must be kept in sync with the classes defined by helpers */
105 #define NF_CT_MAX_EXPECT_CLASSES 4
107 /* nf_conn feature for connections that have a helper */
108 struct nf_conn_help
{
110 struct nf_conntrack_helper
*helper
;
112 union nf_conntrack_help help
;
114 /* Current number of expected connections */
115 u8 expecting
[NF_CT_MAX_EXPECT_CLASSES
];
119 #define CTF_FLAGS_CACHED (1 << 31) /* Indicates cached connection */
120 #define CTF_FLAGS_EXCLUDED (1 << 30)
121 #define CTF_FLAGS_REPLY_CACHED (1 << 1)
122 #define CTF_FLAGS_ORG_CACHED (1 << 0)
125 #include <net/netfilter/ipv4/nf_conntrack_ipv4.h>
126 #include <net/netfilter/ipv6/nf_conntrack_ipv6.h>
130 /* Usage count in here is 1 for hash table/destruct timer, 1 per skb,
131 plus 1 for any connection(s) we are `master' for */
132 struct nf_conntrack ct_general
;
134 /* XXX should I move this to the tail ? - Y.K */
135 /* These are my tuples; original and reply */
136 struct nf_conntrack_tuple_hash tuplehash
[IP_CT_DIR_MAX
];
138 /* Have we seen traffic both ways yet? (bitset) */
139 unsigned long status
;
141 /* If we were expected by an expectation, this will be it */
142 struct nf_conn
*master
;
144 /* Timer function; drops refcnt when it goes off. */
145 struct timer_list timeout
;
147 #ifdef CONFIG_NF_CT_ACCT
148 /* Accounting Information (same cache line as other written members) */
149 struct ip_conntrack_counter counters
[IP_CT_DIR_MAX
];
152 /* Unique ID that identifies this conntrack*/
155 /* features - nat, helper, ... used by allocating system */
158 #if defined(CONFIG_NF_CONNTRACK_MARK)
162 #ifdef CONFIG_NF_CONNTRACK_SECMARK
167 /* Timeout for the connection */
168 u_int32_t expire_jiffies
;
170 /* Flags for connection attributes */
175 /* Storage reserved for other modules: */
176 union nf_conntrack_proto proto
;
178 #if defined(CONFIG_IP_NF_TARGET_BCOUNT) || defined(CONFIG_IP_NF_TARGET_BCOUNT_MODULE)
181 #if defined(CONFIG_IP_NF_TARGET_MACSAVE) || defined(CONFIG_IP_NF_TARGET_MACSAVE_MODULE)
182 unsigned char macsave
[6];
185 #if defined(CONFIG_NETFILTER_XT_MATCH_LAYER7) || \
186 defined(CONFIG_NETFILTER_XT_MATCH_LAYER7_MODULE)
187 struct ip_ct_layer7 layer7
;
190 /* features dynamically at the end: helper, nat (both optional) */
194 static inline struct nf_conn
*
195 nf_ct_tuplehash_to_ctrack(const struct nf_conntrack_tuple_hash
*hash
)
197 return container_of(hash
, struct nf_conn
,
198 tuplehash
[hash
->tuple
.dst
.dir
]);
201 static inline u_int16_t
nf_ct_l3num(const struct nf_conn
*ct
)
203 return ct
->tuplehash
[IP_CT_DIR_ORIGINAL
].tuple
.src
.l3num
;
206 static inline u_int8_t
nf_ct_protonum(const struct nf_conn
*ct
)
208 return ct
->tuplehash
[IP_CT_DIR_ORIGINAL
].tuple
.dst
.protonum
;
211 /* get master conntrack via master expectation */
212 #define master_ct(conntr) (conntr->master)
214 /* Alter reply tuple (maybe alter helper). */
216 nf_conntrack_alter_reply(struct nf_conn
*conntrack
,
217 const struct nf_conntrack_tuple
*newreply
);
219 /* Is this tuple taken? (ignoring any belonging to the given
222 nf_conntrack_tuple_taken(const struct nf_conntrack_tuple
*tuple
,
223 const struct nf_conn
*ignored_conntrack
);
225 /* Return conntrack_info and tuple hash for given skb. */
226 static inline struct nf_conn
*
227 nf_ct_get(const struct sk_buff
*skb
, enum ip_conntrack_info
*ctinfo
)
229 *ctinfo
= skb
->nfctinfo
;
230 return (struct nf_conn
*)skb
->nfct
;
233 /* decrement reference count on a conntrack */
234 static inline void nf_ct_put(struct nf_conn
*ct
)
237 nf_conntrack_put(&ct
->ct_general
);
240 /* Protocol module loading */
241 extern int nf_ct_l3proto_try_module_get(unsigned short l3proto
);
242 extern void nf_ct_l3proto_module_put(unsigned short l3proto
);
244 extern struct nf_conntrack_tuple_hash
*
245 __nf_conntrack_find(const struct nf_conntrack_tuple
*tuple
);
247 extern void nf_conntrack_hash_insert(struct nf_conn
*ct
);
249 extern void nf_conntrack_flush(void);
251 extern int nf_ct_invert_tuplepr(struct nf_conntrack_tuple
*inverse
,
252 const struct nf_conntrack_tuple
*orig
);
254 extern void __nf_ct_refresh_acct(struct nf_conn
*ct
,
255 enum ip_conntrack_info ctinfo
,
256 const struct sk_buff
*skb
,
257 unsigned long extra_jiffies
,
260 /* Refresh conntrack for this many jiffies and do accounting */
261 static inline void nf_ct_refresh_acct(struct nf_conn
*ct
,
262 enum ip_conntrack_info ctinfo
,
263 const struct sk_buff
*skb
,
264 unsigned long extra_jiffies
)
266 __nf_ct_refresh_acct(ct
, ctinfo
, skb
, extra_jiffies
, 1);
269 /* Refresh conntrack for this many jiffies */
270 static inline void nf_ct_refresh(struct nf_conn
*ct
,
271 const struct sk_buff
*skb
,
272 unsigned long extra_jiffies
)
274 __nf_ct_refresh_acct(ct
, 0, skb
, extra_jiffies
, 0);
277 /* These are for NAT. Icky. */
278 extern s16 (*nf_ct_nat_offset
)(const struct nf_conn
*ct
,
279 enum ip_conntrack_dir dir
,
282 /* Call me when a conntrack is destroyed. */
283 extern void (*nf_conntrack_destroyed
)(struct nf_conn
*conntrack
);
285 /* Fake conntrack entry for untracked connections */
286 extern struct nf_conn nf_conntrack_untracked
;
288 extern int nf_ct_no_defrag
;
290 /* Iterate over all conntracks: if iter returns true, it's deleted. */
292 nf_ct_iterate_cleanup(int (*iter
)(struct nf_conn
*i
, void *data
), void *data
);
293 extern void nf_conntrack_free(struct nf_conn
*ct
);
294 extern struct nf_conn
*
295 nf_conntrack_alloc(const struct nf_conntrack_tuple
*orig
,
296 const struct nf_conntrack_tuple
*repl
);
298 /* It's confirmed if it is, or has been in the hash table. */
299 static inline int nf_ct_is_confirmed(struct nf_conn
*ct
)
301 return test_bit(IPS_CONFIRMED_BIT
, &ct
->status
);
304 static inline int nf_ct_is_dying(struct nf_conn
*ct
)
306 return test_bit(IPS_DYING_BIT
, &ct
->status
);
309 static inline int nf_ct_is_untracked(const struct sk_buff
*skb
)
311 return (skb
->nfct
== &nf_conntrack_untracked
.ct_general
);
314 extern unsigned int nf_conntrack_htable_size
;
315 extern int nf_conntrack_checksum
;
316 extern atomic_t nf_conntrack_count
;
317 extern int nf_conntrack_max
;
319 DECLARE_PER_CPU(struct ip_conntrack_stat
, nf_conntrack_stat
);
320 #define NF_CT_STAT_INC(count) (__get_cpu_var(nf_conntrack_stat).count++)
321 #define NF_CT_STAT_INC_ATOMIC(count) \
323 local_bh_disable(); \
324 __get_cpu_var(nf_conntrack_stat).count++; \
328 /* no helper, no nat */
329 #define NF_CT_F_BASIC 0
331 #define NF_CT_F_HELP 1
333 #define NF_CT_F_NAT 2
334 #define NF_CT_F_NUM 4
337 nf_conntrack_register_cache(u_int32_t features
, const char *name
, size_t size
);
339 nf_conntrack_unregister_cache(u_int32_t features
);
341 /* valid combinations:
342 * basic: nf_conn, nf_conn .. nf_conn_help
343 * nat: nf_conn .. nf_conn_nat, nf_conn .. nf_conn_nat .. nf_conn help
345 #ifdef CONFIG_NF_NAT_NEEDED
346 static inline struct nf_conn_nat
*nfct_nat(const struct nf_conn
*ct
)
348 unsigned int offset
= sizeof(struct nf_conn
);
350 if (!(ct
->features
& NF_CT_F_NAT
))
353 offset
= ALIGN(offset
, __alignof__(struct nf_conn_nat
));
354 return (struct nf_conn_nat
*) ((void *)ct
+ offset
);
357 static inline struct nf_conn_help
*nfct_help(const struct nf_conn
*ct
)
359 unsigned int offset
= sizeof(struct nf_conn
);
361 if (!(ct
->features
& NF_CT_F_HELP
))
363 if (ct
->features
& NF_CT_F_NAT
) {
364 offset
= ALIGN(offset
, __alignof__(struct nf_conn_nat
));
365 offset
+= sizeof(struct nf_conn_nat
);
368 offset
= ALIGN(offset
, __alignof__(struct nf_conn_help
));
369 return (struct nf_conn_help
*) ((void *)ct
+ offset
);
372 static inline struct nf_conn_help
*nfct_help(const struct nf_conn
*ct
)
374 unsigned int offset
= sizeof(struct nf_conn
);
376 if (!(ct
->features
& NF_CT_F_HELP
))
379 offset
= ALIGN(offset
, __alignof__(struct nf_conn_help
));
380 return (struct nf_conn_help
*) ((void *)ct
+ offset
);
382 #endif /* CONFIG_NF_NAT_NEEDED */
383 #endif /* __KERNEL__ */
384 #endif /* _NF_CONNTRACK_H */