[mirror_ubuntu-artful-kernel.git] / include / net / netfilter / nf_conntrack.h

/*
 * Connection state tracking for netfilter.  This is separated from,
 * but required by, the (future) NAT layer; it can also be used by an iptables
 * extension.
 *
 * 16 Dec 2003: Yasuyuki Kozakai @USAGI <yasuyuki.kozakai@toshiba.co.jp>
 *	- generalize L3 protocol dependent part.
 *
 * Derived from include/linux/netfiter_ipv4/ip_conntrack.h
 */

#ifndef _NF_CONNTRACK_H
#define _NF_CONNTRACK_H

#include <linux/netfilter/nf_conntrack_common.h>

#ifdef __KERNEL__
#include <linux/bitops.h>
#include <linux/compiler.h>
#include <asm/atomic.h>

#include <linux/netfilter/nf_conntrack_tcp.h>
#include <linux/netfilter/nf_conntrack_dccp.h>
#include <linux/netfilter/nf_conntrack_sctp.h>
#include <linux/netfilter/nf_conntrack_proto_gre.h>
#include <net/netfilter/ipv4/nf_conntrack_icmp.h>
#include <net/netfilter/ipv6/nf_conntrack_icmpv6.h>

#include <net/netfilter/nf_conntrack_tuple.h>

/* per conntrack: protocol private data */
union nf_conntrack_proto {
	/* insert conntrack proto private data here */
	struct nf_ct_dccp dccp;
	struct ip_ct_sctp sctp;
	struct ip_ct_tcp tcp;
	struct ip_ct_icmp icmp;
	struct nf_ct_icmpv6 icmpv6;
	struct nf_ct_gre gre;
};

union nf_conntrack_expect_proto {
	/* insert expect proto private data here */
};

/* Add protocol helper include file here */
#include <linux/netfilter/nf_conntrack_ftp.h>
#include <linux/netfilter/nf_conntrack_pptp.h>
#include <linux/netfilter/nf_conntrack_h323.h>
#include <linux/netfilter/nf_conntrack_sane.h>
#include <linux/netfilter/nf_conntrack_sip.h>

/* per conntrack: application helper private data */
union nf_conntrack_help {
	/* insert conntrack helper private data (master) here */
	struct nf_ct_ftp_master ct_ftp_info;
	struct nf_ct_pptp_master ct_pptp_info;
	struct nf_ct_h323_master ct_h323_info;
	struct nf_ct_sane_master ct_sane_info;
	struct nf_ct_sip_master ct_sip_info;
};

#include <linux/types.h>
#include <linux/skbuff.h>
#include <linux/timer.h>

#ifdef CONFIG_NETFILTER_DEBUG
#define NF_CT_ASSERT(x)		WARN_ON(!(x))
#else
#define NF_CT_ASSERT(x)
#endif

struct nf_conntrack_helper;

/* Must be kept in sync with the classes defined by helpers */
#define NF_CT_MAX_EXPECT_CLASSES	3

/* nf_conn feature for connections that have a helper */
struct nf_conn_help {
	/* Helper. if any */
	struct nf_conntrack_helper *helper;

	union nf_conntrack_help help;

	struct hlist_head expectations;

	/* Current number of expected connections */
	u8 expecting[NF_CT_MAX_EXPECT_CLASSES];
};


#include <net/netfilter/ipv4/nf_conntrack_ipv4.h>
#include <net/netfilter/ipv6/nf_conntrack_ipv6.h>

struct nf_conn
{
	/* Usage count in here is 1 for hash table/destruct timer, 1 per skb,
           plus 1 for any connection(s) we are `master' for */
	struct nf_conntrack ct_general;

	/* XXX should I move this to the tail ? - Y.K */
	/* These are my tuples; original and reply */
	struct nf_conntrack_tuple_hash tuplehash[IP_CT_DIR_MAX];

	/* Have we seen traffic both ways yet? (bitset) */
	unsigned long status;

	/* If we were expected by an expectation, this will be it */
	struct nf_conn *master;

	/* Timer function; drops refcnt when it goes off. */
	struct timer_list timeout;

#ifdef CONFIG_NF_CT_ACCT
	/* Accounting Information (same cache line as other written members) */
	struct ip_conntrack_counter counters[IP_CT_DIR_MAX];
#endif

#if defined(CONFIG_NF_CONNTRACK_MARK)
	u_int32_t mark;
#endif

#ifdef CONFIG_NF_CONNTRACK_SECMARK
	u_int32_t secmark;
#endif

	/* Storage reserved for other modules: */
	union nf_conntrack_proto proto;

	/* Extensions */
	struct nf_ct_ext *ext;

	struct rcu_head rcu;
};

static inline struct nf_conn *
nf_ct_tuplehash_to_ctrack(const struct nf_conntrack_tuple_hash *hash)
{
	return container_of(hash, struct nf_conn,
			    tuplehash[hash->tuple.dst.dir]);
}

static inline u_int16_t nf_ct_l3num(const struct nf_conn *ct)
{
	return ct->tuplehash[IP_CT_DIR_ORIGINAL].tuple.src.l3num;
}

static inline u_int8_t nf_ct_protonum(const struct nf_conn *ct)
{
	return ct->tuplehash[IP_CT_DIR_ORIGINAL].tuple.dst.protonum;
}

/* get master conntrack via master expectation */
#define master_ct(conntr) (conntr->master)

/* Alter reply tuple (maybe alter helper). */
extern void
nf_conntrack_alter_reply(struct nf_conn *ct,
			 const struct nf_conntrack_tuple *newreply);

/* Is this tuple taken? (ignoring any belonging to the given
   conntrack). */
extern int
nf_conntrack_tuple_taken(const struct nf_conntrack_tuple *tuple,
			 const struct nf_conn *ignored_conntrack);

/* Return conntrack_info and tuple hash for given skb. */
static inline struct nf_conn *
nf_ct_get(const struct sk_buff *skb, enum ip_conntrack_info *ctinfo)
{
	*ctinfo = skb->nfctinfo;
	return (struct nf_conn *)skb->nfct;
}

/* decrement reference count on a conntrack */
static inline void nf_ct_put(struct nf_conn *ct)
{
	NF_CT_ASSERT(ct);
	nf_conntrack_put(&ct->ct_general);
}

/* Protocol module loading */
extern int nf_ct_l3proto_try_module_get(unsigned short l3proto);
extern void nf_ct_l3proto_module_put(unsigned short l3proto);

extern struct hlist_head *nf_ct_alloc_hashtable(unsigned int *sizep, int *vmalloced);
extern void nf_ct_free_hashtable(struct hlist_head *hash, int vmalloced,
				 unsigned int size);

extern struct nf_conntrack_tuple_hash *
__nf_conntrack_find(const struct nf_conntrack_tuple *tuple);

extern void nf_conntrack_hash_insert(struct nf_conn *ct);

extern void nf_conntrack_flush(void);

extern bool nf_ct_get_tuplepr(const struct sk_buff *skb,
			      unsigned int nhoff, u_int16_t l3num,
			      struct nf_conntrack_tuple *tuple);
extern bool nf_ct_invert_tuplepr(struct nf_conntrack_tuple *inverse,
				 const struct nf_conntrack_tuple *orig);

extern void __nf_ct_refresh_acct(struct nf_conn *ct,
				 enum ip_conntrack_info ctinfo,
				 const struct sk_buff *skb,
				 unsigned long extra_jiffies,
				 int do_acct);

/* Refresh conntrack for this many jiffies and do accounting */
static inline void nf_ct_refresh_acct(struct nf_conn *ct,
				      enum ip_conntrack_info ctinfo,
				      const struct sk_buff *skb,
				      unsigned long extra_jiffies)
{
	__nf_ct_refresh_acct(ct, ctinfo, skb, extra_jiffies, 1);
}

/* Refresh conntrack for this many jiffies */
static inline void nf_ct_refresh(struct nf_conn *ct,
				 const struct sk_buff *skb,
				 unsigned long extra_jiffies)
{
	__nf_ct_refresh_acct(ct, 0, skb, extra_jiffies, 0);
}

extern void __nf_ct_kill_acct(struct nf_conn *ct,
				enum ip_conntrack_info ctinfo,
				const struct sk_buff *skb,
				int do_acct);

/* kill conntrack and do accounting */
static inline void nf_ct_kill_acct(struct nf_conn *ct,
				enum ip_conntrack_info ctinfo,
				const struct sk_buff *skb)
{
	__nf_ct_kill_acct(ct, ctinfo, skb, 1);
}

/* kill conntrack without accounting */
static inline void nf_ct_kill(struct nf_conn *ct)
{
	__nf_ct_kill_acct(ct, 0, NULL, 0);
}

/* These are for NAT.  Icky. */
/* Update TCP window tracking data when NAT mangles the packet */
extern void nf_conntrack_tcp_update(const struct sk_buff *skb,
				    unsigned int dataoff,
				    struct nf_conn *ct,
				    int dir);

/* Fake conntrack entry for untracked connections */
extern struct nf_conn nf_conntrack_untracked;

/* Iterate over all conntracks: if iter returns true, it's deleted. */
extern void
nf_ct_iterate_cleanup(int (*iter)(struct nf_conn *i, void *data), void *data);
extern void nf_conntrack_free(struct nf_conn *ct);
extern struct nf_conn *
nf_conntrack_alloc(const struct nf_conntrack_tuple *orig,
		   const struct nf_conntrack_tuple *repl,
		   gfp_t gfp);

/* It's confirmed if it is, or has been in the hash table. */
static inline int nf_ct_is_confirmed(struct nf_conn *ct)
{
	return test_bit(IPS_CONFIRMED_BIT, &ct->status);
}

static inline int nf_ct_is_dying(struct nf_conn *ct)
{
	return test_bit(IPS_DYING_BIT, &ct->status);
}

static inline int nf_ct_is_untracked(const struct sk_buff *skb)
{
	return (skb->nfct == &nf_conntrack_untracked.ct_general);
}

extern int nf_conntrack_set_hashsize(const char *val, struct kernel_param *kp);
extern unsigned int nf_conntrack_htable_size;
extern int nf_conntrack_checksum;
extern atomic_t nf_conntrack_count;
extern int nf_conntrack_max;

DECLARE_PER_CPU(struct ip_conntrack_stat, nf_conntrack_stat);
#define NF_CT_STAT_INC(count) (__get_cpu_var(nf_conntrack_stat).count++)
#define NF_CT_STAT_INC_ATOMIC(count)			\
do {							\
	local_bh_disable();				\
	__get_cpu_var(nf_conntrack_stat).count++;	\
	local_bh_enable();				\
} while (0)

#endif /* __KERNEL__ */
#endif /* _NF_CONNTRACK_H */
Commit	Line	Data
9fb9cbb1 YK	1	/*
	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
	4	* extension.
	5	*
	6	* 16 Dec 2003: Yasuyuki Kozakai @USAGI <yasuyuki.kozakai@toshiba.co.jp>
	7	* - generalize L3 protocol dependent part.
	8	*
	9	* Derived from include/linux/netfiter_ipv4/ip_conntrack.h
	10	*/
	11
	12	#ifndef _NF_CONNTRACK_H
	13	#define _NF_CONNTRACK_H
	14
	15	#include <linux/netfilter/nf_conntrack_common.h>
	16
	17	#ifdef __KERNEL__
9fb9cbb1 YK	18	#include <linux/bitops.h>
	19	#include <linux/compiler.h>
	20	#include <asm/atomic.h>
	21
	22	#include <linux/netfilter/nf_conntrack_tcp.h>
2bc78049	23	#include <linux/netfilter/nf_conntrack_dccp.h>
9fb9cbb1	24	#include <linux/netfilter/nf_conntrack_sctp.h>
f09943fe	25	#include <linux/netfilter/nf_conntrack_proto_gre.h>
9fb9cbb1 YK	26	#include <net/netfilter/ipv4/nf_conntrack_icmp.h>
	27	#include <net/netfilter/ipv6/nf_conntrack_icmpv6.h>
	28
	29	#include <net/netfilter/nf_conntrack_tuple.h>
	30
	31	/* per conntrack: protocol private data */
	32	union nf_conntrack_proto {
	33	/* insert conntrack proto private data here */
2bc78049	34	struct nf_ct_dccp dccp;
9fb9cbb1 YK	35	struct ip_ct_sctp sctp;
	36	struct ip_ct_tcp tcp;
	37	struct ip_ct_icmp icmp;
	38	struct nf_ct_icmpv6 icmpv6;
f09943fe	39	struct nf_ct_gre gre;
9fb9cbb1 YK	40	};
	41
	42	union nf_conntrack_expect_proto {
	43	/* insert expect proto private data here */
	44	};
	45
	46	/* Add protocol helper include file here */
	47	#include <linux/netfilter/nf_conntrack_ftp.h>
f09943fe	48	#include <linux/netfilter/nf_conntrack_pptp.h>
f587de0e	49	#include <linux/netfilter/nf_conntrack_h323.h>
6fecd198	50	#include <linux/netfilter/nf_conntrack_sane.h>
0f32a40f	51	#include <linux/netfilter/nf_conntrack_sip.h>
9fb9cbb1 YK	52
	53	/* per conntrack: application helper private data */
	54	union nf_conntrack_help {
	55	/* insert conntrack helper private data (master) here */
55a73324	56	struct nf_ct_ftp_master ct_ftp_info;
f09943fe	57	struct nf_ct_pptp_master ct_pptp_info;
f587de0e	58	struct nf_ct_h323_master ct_h323_info;
6fecd198	59	struct nf_ct_sane_master ct_sane_info;
0f32a40f	60	struct nf_ct_sip_master ct_sip_info;
9fb9cbb1 YK	61	};
	62
	63	#include <linux/types.h>
	64	#include <linux/skbuff.h>
d7fe0f24	65	#include <linux/timer.h>
9fb9cbb1 YK	66
9fb9cbb1 YK	67	#ifdef CONFIG_NETFILTER_DEBUG
55871d04	68	#define NF_CT_ASSERT(x) WARN_ON(!(x))
9fb9cbb1 YK	69	#else
	70	#define NF_CT_ASSERT(x)
	71	#endif
	72
	73	struct nf_conntrack_helper;
	74
6002f266	75	/* Must be kept in sync with the classes defined by helpers */
0d0ab037	76	#define NF_CT_MAX_EXPECT_CLASSES 3
6002f266	77
dc808fe2 HW	78	/* nf_conn feature for connections that have a helper */
	79	struct nf_conn_help {
	80	/* Helper. if any */
	81	struct nf_conntrack_helper *helper;
	82
	83	union nf_conntrack_help help;
	84
b560580a PM	85	struct hlist_head expectations;
b560580a PM	86
dc808fe2	87	/* Current number of expected connections */
6002f266	88	u8 expecting[NF_CT_MAX_EXPECT_CLASSES];
dc808fe2 HW	89	};
	90
	91
9fb9cbb1	92	#include <net/netfilter/ipv4/nf_conntrack_ipv4.h>
f8eb24a8 PM	93	#include <net/netfilter/ipv6/nf_conntrack_ipv6.h>
f8eb24a8 PM	94
9fb9cbb1 YK	95	struct nf_conn
	96	{
	97	/* Usage count in here is 1 for hash table/destruct timer, 1 per skb,
	98	plus 1 for any connection(s) we are `master' for */
	99	struct nf_conntrack ct_general;
	100
	101	/* XXX should I move this to the tail ? - Y.K */
	102	/* These are my tuples; original and reply */
	103	struct nf_conntrack_tuple_hash tuplehash[IP_CT_DIR_MAX];
	104
	105	/* Have we seen traffic both ways yet? (bitset) */
	106	unsigned long status;
	107
dc808fe2 HW	108	/* If we were expected by an expectation, this will be it */
	109	struct nf_conn *master;
	110
9fb9cbb1 YK	111	/* Timer function; drops refcnt when it goes off. */
	112	struct timer_list timeout;
	113
	114	#ifdef CONFIG_NF_CT_ACCT
	115	/* Accounting Information (same cache line as other written members) */
	116	struct ip_conntrack_counter counters[IP_CT_DIR_MAX];
	117	#endif
9fb9cbb1	118
9fb9cbb1 YK	119	#if defined(CONFIG_NF_CONNTRACK_MARK)
	120	u_int32_t mark;
	121	#endif
	122
7c9728c3 JM	123	#ifdef CONFIG_NF_CONNTRACK_SECMARK
	124	u_int32_t secmark;
	125	#endif
	126
dc808fe2 HW	127	/* Storage reserved for other modules: */
dc808fe2 HW	128	union nf_conntrack_proto proto;
9fb9cbb1	129
ecfab2c9 YK	130	/* Extensions */
ecfab2c9 YK	131	struct nf_ct_ext *ext;
76507f69 PM	132
76507f69 PM	133	struct rcu_head rcu;
9fb9cbb1 YK	134	};
9fb9cbb1 YK	135
9fb9cbb1 YK	136	static inline struct nf_conn *
	137	nf_ct_tuplehash_to_ctrack(const struct nf_conntrack_tuple_hash *hash)
	138	{
	139	return container_of(hash, struct nf_conn,
	140	tuplehash[hash->tuple.dst.dir]);
	141	}
	142
5e8fbe2a PM	143	static inline u_int16_t nf_ct_l3num(const struct nf_conn *ct)
	144	{
	145	return ct->tuplehash[IP_CT_DIR_ORIGINAL].tuple.src.l3num;
	146	}
	147
	148	static inline u_int8_t nf_ct_protonum(const struct nf_conn *ct)
	149	{
	150	return ct->tuplehash[IP_CT_DIR_ORIGINAL].tuple.dst.protonum;
	151	}
	152
9fb9cbb1 YK	153	/* get master conntrack via master expectation */
	154	#define master_ct(conntr) (conntr->master)
	155
	156	/* Alter reply tuple (maybe alter helper). */
	157	extern void
c88130bc	158	nf_conntrack_alter_reply(struct nf_conn *ct,
9fb9cbb1 YK	159	const struct nf_conntrack_tuple *newreply);
	160
	161	/* Is this tuple taken? (ignoring any belonging to the given
	162	conntrack). */
	163	extern int
	164	nf_conntrack_tuple_taken(const struct nf_conntrack_tuple *tuple,
	165	const struct nf_conn *ignored_conntrack);
	166
	167	/* Return conntrack_info and tuple hash for given skb. */
	168	static inline struct nf_conn *
	169	nf_ct_get(const struct sk_buff skb, enum ip_conntrack_info ctinfo)
	170	{
	171	*ctinfo = skb->nfctinfo;
	172	return (struct nf_conn *)skb->nfct;
	173	}
	174
	175	/* decrement reference count on a conntrack */
	176	static inline void nf_ct_put(struct nf_conn *ct)
	177	{
	178	NF_CT_ASSERT(ct);
	179	nf_conntrack_put(&ct->ct_general);
	180	}
	181
b9f78f9f PNA	182	/* Protocol module loading */
	183	extern int nf_ct_l3proto_try_module_get(unsigned short l3proto);
	184	extern void nf_ct_l3proto_module_put(unsigned short l3proto);
	185
96eb24d7	186	extern struct hlist_head nf_ct_alloc_hashtable(unsigned int sizep, int *vmalloced);
ac565e5f	187	extern void nf_ct_free_hashtable(struct hlist_head *hash, int vmalloced,
96eb24d7	188	unsigned int size);
ac565e5f	189
c1d10adb	190	extern struct nf_conntrack_tuple_hash *
ba419aff	191	__nf_conntrack_find(const struct nf_conntrack_tuple *tuple);
c1d10adb PNA	192
	193	extern void nf_conntrack_hash_insert(struct nf_conn *ct);
	194
c1d10adb PNA	195	extern void nf_conntrack_flush(void);
c1d10adb PNA	196
5f2b4c90 JE	197	extern bool nf_ct_get_tuplepr(const struct sk_buff *skb,
	198	unsigned int nhoff, u_int16_t l3num,
	199	struct nf_conntrack_tuple *tuple);
	200	extern bool nf_ct_invert_tuplepr(struct nf_conntrack_tuple *inverse,
	201	const struct nf_conntrack_tuple *orig);
9fb9cbb1 YK	202
	203	extern void __nf_ct_refresh_acct(struct nf_conn *ct,
	204	enum ip_conntrack_info ctinfo,
	205	const struct sk_buff *skb,
	206	unsigned long extra_jiffies,
	207	int do_acct);
	208
	209	/* Refresh conntrack for this many jiffies and do accounting */
	210	static inline void nf_ct_refresh_acct(struct nf_conn *ct,
	211	enum ip_conntrack_info ctinfo,
	212	const struct sk_buff *skb,
	213	unsigned long extra_jiffies)
	214	{
	215	__nf_ct_refresh_acct(ct, ctinfo, skb, extra_jiffies, 1);
	216	}
	217
	218	/* Refresh conntrack for this many jiffies */
	219	static inline void nf_ct_refresh(struct nf_conn *ct,
	220	const struct sk_buff *skb,
	221	unsigned long extra_jiffies)
	222	{
	223	__nf_ct_refresh_acct(ct, 0, skb, extra_jiffies, 0);
	224	}
	225
718d4ad9 FH	226	extern void __nf_ct_kill_acct(struct nf_conn *ct,
	227	enum ip_conntrack_info ctinfo,
	228	const struct sk_buff *skb,
	229	int do_acct);
	230
	231	/* kill conntrack and do accounting */
	232	static inline void nf_ct_kill_acct(struct nf_conn *ct,
	233	enum ip_conntrack_info ctinfo,
	234	const struct sk_buff *skb)
	235	{
	236	__nf_ct_kill_acct(ct, ctinfo, skb, 1);
	237	}
	238
	239	/* kill conntrack without accounting */
	240	static inline void nf_ct_kill(struct nf_conn *ct)
	241	{
	242	__nf_ct_kill_acct(ct, 0, NULL, 0);
	243	}
51091764	244
9fb9cbb1 YK	245	/* These are for NAT. Icky. */
9fb9cbb1 YK	246	/* Update TCP window tracking data when NAT mangles the packet */
82f568fc	247	extern void nf_conntrack_tcp_update(const struct sk_buff *skb,
9fb9cbb1	248	unsigned int dataoff,
c88130bc	249	struct nf_conn *ct,
9fb9cbb1 YK	250	int dir);
9fb9cbb1 YK	251
9fb9cbb1 YK	252	/* Fake conntrack entry for untracked connections */
	253	extern struct nf_conn nf_conntrack_untracked;
	254
9fb9cbb1 YK	255	/* Iterate over all conntracks: if iter returns true, it's deleted. */
	256	extern void
	257	nf_ct_iterate_cleanup(int (iter)(struct nf_conn i, void data), void data);
	258	extern void nf_conntrack_free(struct nf_conn *ct);
	259	extern struct nf_conn *
	260	nf_conntrack_alloc(const struct nf_conntrack_tuple *orig,
b891c5a8 PNA	261	const struct nf_conntrack_tuple *repl,
b891c5a8 PNA	262	gfp_t gfp);
9fb9cbb1 YK	263
	264	/* It's confirmed if it is, or has been in the hash table. */
	265	static inline int nf_ct_is_confirmed(struct nf_conn *ct)
	266	{
	267	return test_bit(IPS_CONFIRMED_BIT, &ct->status);
	268	}
	269
	270	static inline int nf_ct_is_dying(struct nf_conn *ct)
	271	{
	272	return test_bit(IPS_DYING_BIT, &ct->status);
	273	}
	274
587aa641 PM	275	static inline int nf_ct_is_untracked(const struct sk_buff *skb)
	276	{
	277	return (skb->nfct == &nf_conntrack_untracked.ct_general);
	278	}
	279
fae718dd	280	extern int nf_conntrack_set_hashsize(const char val, struct kernel_param kp);
9fb9cbb1	281	extern unsigned int nf_conntrack_htable_size;
39a27a35	282	extern int nf_conntrack_checksum;
f8eb24a8 PM	283	extern atomic_t nf_conntrack_count;
f8eb24a8 PM	284	extern int nf_conntrack_max;
9fb9cbb1	285
f8eb24a8	286	DECLARE_PER_CPU(struct ip_conntrack_stat, nf_conntrack_stat);
9fb9cbb1	287	#define NF_CT_STAT_INC(count) (__get_cpu_var(nf_conntrack_stat).count++)
c0e912d7 PM	288	#define NF_CT_STAT_INC_ATOMIC(count) \
	289	do { \
	290	local_bh_disable(); \
	291	__get_cpu_var(nf_conntrack_stat).count++; \
	292	local_bh_enable(); \
	293	} while (0)
9fb9cbb1	294
9fb9cbb1 YK	295	#endif /* __KERNEL__ */
9fb9cbb1 YK	296	#endif /* _NF_CONNTRACK_H */