[deliverable/linux.git] / include / net / netfilter / nf_conntrack_helper.h

/*
 * connection tracking helpers.
 *
 * 16 Dec 2003: Yasuyuki Kozakai @USAGI <yasuyuki.kozakai@toshiba.co.jp>
 *	- generalize L3 protocol dependent part.
 *
 * Derived from include/linux/netfiter_ipv4/ip_conntrack_helper.h
 */

#ifndef _NF_CONNTRACK_HELPER_H
#define _NF_CONNTRACK_HELPER_H
#include <net/netfilter/nf_conntrack.h>
#include <net/netfilter/nf_conntrack_extend.h>
#include <net/netfilter/nf_conntrack_expect.h>

struct module;

enum nf_ct_helper_flags {
	NF_CT_HELPER_F_USERSPACE	= (1 << 0),
	NF_CT_HELPER_F_CONFIGURED	= (1 << 1),
};

#define NF_CT_HELPER_NAME_LEN	16

struct nf_conntrack_helper {
	struct hlist_node hnode;	/* Internal use. */

	char name[NF_CT_HELPER_NAME_LEN]; /* name of the module */
	struct module *me;		/* pointer to self */
	const struct nf_conntrack_expect_policy *expect_policy;

	/* length of internal data, ie. sizeof(struct nf_ct_*_master) */
	size_t data_len;

	/* Tuple of things we will help (compared against server response) */
	struct nf_conntrack_tuple tuple;

	/* Function to call when data passes; return verdict, or -1 to
           invalidate. */
	int (*help)(struct sk_buff *skb,
		    unsigned int protoff,
		    struct nf_conn *ct,
		    enum ip_conntrack_info conntrackinfo);

	void (*destroy)(struct nf_conn *ct);

	int (*from_nlattr)(struct nlattr *attr, struct nf_conn *ct);
	int (*to_nlattr)(struct sk_buff *skb, const struct nf_conn *ct);
	unsigned int expect_class_max;

	unsigned int flags;
	unsigned int queue_num;		/* For user-space helpers. */
};

struct nf_conntrack_helper *__nf_conntrack_helper_find(const char *name,
						       u16 l3num, u8 protonum);

struct nf_conntrack_helper *nf_conntrack_helper_try_module_get(const char *name,
							       u16 l3num,
							       u8 protonum);
void nf_ct_helper_init(struct nf_conntrack_helper *helper,
		       u16 l3num, u16 protonum, const char *name,
		       u16 default_port, u16 spec_port, u32 id,
		       const struct nf_conntrack_expect_policy *exp_pol,
		       u32 expect_class_max, u32 data_len,
		       int (*help)(struct sk_buff *skb, unsigned int protoff,
				   struct nf_conn *ct,
				   enum ip_conntrack_info ctinfo),
		       int (*from_nlattr)(struct nlattr *attr,
					  struct nf_conn *ct),
		       struct module *module);

int nf_conntrack_helper_register(struct nf_conntrack_helper *);
void nf_conntrack_helper_unregister(struct nf_conntrack_helper *);

int nf_conntrack_helpers_register(struct nf_conntrack_helper *, unsigned int);
void nf_conntrack_helpers_unregister(struct nf_conntrack_helper *,
				     unsigned int);

struct nf_conn_help *nf_ct_helper_ext_add(struct nf_conn *ct,
					  struct nf_conntrack_helper *helper,
					  gfp_t gfp);

int __nf_ct_try_assign_helper(struct nf_conn *ct, struct nf_conn *tmpl,
			      gfp_t flags);

void nf_ct_helper_destroy(struct nf_conn *ct);

static inline struct nf_conn_help *nfct_help(const struct nf_conn *ct)
{
	return nf_ct_ext_find(ct, NF_CT_EXT_HELPER);
}

static inline void *nfct_help_data(const struct nf_conn *ct)
{
	struct nf_conn_help *help;

	help = nf_ct_ext_find(ct, NF_CT_EXT_HELPER);

	return (void *)help->data;
}

int nf_conntrack_helper_pernet_init(struct net *net);
void nf_conntrack_helper_pernet_fini(struct net *net);

int nf_conntrack_helper_init(void);
void nf_conntrack_helper_fini(void);

int nf_conntrack_broadcast_help(struct sk_buff *skb, unsigned int protoff,
				struct nf_conn *ct,
				enum ip_conntrack_info ctinfo,
				unsigned int timeout);

struct nf_ct_helper_expectfn {
	struct list_head head;
	const char *name;
	void (*expectfn)(struct nf_conn *ct, struct nf_conntrack_expect *exp);
};

__printf(3,4)
void nf_ct_helper_log(struct sk_buff *skb, const struct nf_conn *ct,
		      const char *fmt, ...);

void nf_ct_helper_expectfn_register(struct nf_ct_helper_expectfn *n);
void nf_ct_helper_expectfn_unregister(struct nf_ct_helper_expectfn *n);
struct nf_ct_helper_expectfn *
nf_ct_helper_expectfn_find_by_name(const char *name);
struct nf_ct_helper_expectfn *
nf_ct_helper_expectfn_find_by_symbol(const void *symbol);

extern struct hlist_head *nf_ct_helper_hash;
extern unsigned int nf_ct_helper_hsize;

#endif /*_NF_CONNTRACK_HELPER_H*/
Commit	Line	Data
9fb9cbb1 YK	1	/*
	2	* connection tracking helpers.
	3	*
	4	* 16 Dec 2003: Yasuyuki Kozakai @USAGI <yasuyuki.kozakai@toshiba.co.jp>
	5	* - generalize L3 protocol dependent part.
	6	*
	7	* Derived from include/linux/netfiter_ipv4/ip_conntrack_helper.h
	8	*/
	9
	10	#ifndef _NF_CONNTRACK_HELPER_H
	11	#define _NF_CONNTRACK_HELPER_H
	12	#include <net/netfilter/nf_conntrack.h>
ceceae1b	13	#include <net/netfilter/nf_conntrack_extend.h>
1afc5679	14	#include <net/netfilter/nf_conntrack_expect.h>
9fb9cbb1 YK	15
	16	struct module;
	17
12f7a505 PNA	18	enum nf_ct_helper_flags {
	19	NF_CT_HELPER_F_USERSPACE = (1 << 0),
	20	NF_CT_HELPER_F_CONFIGURED = (1 << 1),
	21	};
	22
af9d32ad HE	23	#define NF_CT_HELPER_NAME_LEN 16
af9d32ad HE	24
fd2c3ef7	25	struct nf_conntrack_helper {
b8a7fe6c	26	struct hlist_node hnode; /* Internal use. */
9fb9cbb1	27
3a8fc53a	28	char name[NF_CT_HELPER_NAME_LEN]; /* name of the module */
9fb9cbb1	29	struct module me; / pointer to self */
6002f266	30	const struct nf_conntrack_expect_policy *expect_policy;
9fb9cbb1	31
1afc5679 PNA	32	/* length of internal data, ie. sizeof(struct nf_ct__master) /
	33	size_t data_len;
	34
d4156e8c	35	/* Tuple of things we will help (compared against server response) */
9fb9cbb1	36	struct nf_conntrack_tuple tuple;
d4156e8c	37
9fb9cbb1 YK	38	/* Function to call when data passes; return verdict, or -1 to
9fb9cbb1 YK	39	invalidate. */
3db05fea	40	int (help)(struct sk_buff skb,
9fb9cbb1 YK	41	unsigned int protoff,
	42	struct nf_conn *ct,
	43	enum ip_conntrack_info conntrackinfo);
c1d10adb	44
f09943fe PM	45	void (destroy)(struct nf_conn ct);
f09943fe PM	46
ae243bee	47	int (from_nlattr)(struct nlattr attr, struct nf_conn *ct);
fdf70832	48	int (to_nlattr)(struct sk_buff skb, const struct nf_conn *ct);
6002f266	49	unsigned int expect_class_max;
12f7a505 PNA	50
	51	unsigned int flags;
	52	unsigned int queue_num; /* For user-space helpers. */
9fb9cbb1 YK	53	};
9fb9cbb1 YK	54
4e77be46 JP	55	struct nf_conntrack_helper __nf_conntrack_helper_find(const char name,
4e77be46 JP	56	u16 l3num, u8 protonum);
7e5d03bb	57
4e77be46 JP	58	struct nf_conntrack_helper nf_conntrack_helper_try_module_get(const char name,
	59	u16 l3num,
	60	u8 protonum);
82de0be6 GF	61	void nf_ct_helper_init(struct nf_conntrack_helper *helper,
	62	u16 l3num, u16 protonum, const char *name,
	63	u16 default_port, u16 spec_port, u32 id,
	64	const struct nf_conntrack_expect_policy *exp_pol,
	65	u32 expect_class_max, u32 data_len,
	66	int (help)(struct sk_buff skb, unsigned int protoff,
	67	struct nf_conn *ct,
	68	enum ip_conntrack_info ctinfo),
	69	int (from_nlattr)(struct nlattr attr,
	70	struct nf_conn *ct),
	71	struct module *module);
84f3bb9a	72
4e77be46 JP	73	int nf_conntrack_helper_register(struct nf_conntrack_helper *);
4e77be46 JP	74	void nf_conntrack_helper_unregister(struct nf_conntrack_helper *);
9fb9cbb1	75
82de0be6 GF	76	int nf_conntrack_helpers_register(struct nf_conntrack_helper *, unsigned int);
	77	void nf_conntrack_helpers_unregister(struct nf_conntrack_helper *,
	78	unsigned int);
	79
4e77be46 JP	80	struct nf_conn_help nf_ct_helper_ext_add(struct nf_conn ct,
	81	struct nf_conntrack_helper *helper,
	82	gfp_t gfp);
b560580a	83
4e77be46 JP	84	int __nf_ct_try_assign_helper(struct nf_conn ct, struct nf_conn tmpl,
4e77be46 JP	85	gfp_t flags);
226c0c0e	86
4e77be46	87	void nf_ct_helper_destroy(struct nf_conn *ct);
9858a3ae	88
ceceae1b YK	89	static inline struct nf_conn_help nfct_help(const struct nf_conn ct)
	90	{
	91	return nf_ct_ext_find(ct, NF_CT_EXT_HELPER);
	92	}
b334aadc	93
1afc5679 PNA	94	static inline void nfct_help_data(const struct nf_conn ct)
	95	{
	96	struct nf_conn_help *help;
	97
	98	help = nf_ct_ext_find(ct, NF_CT_EXT_HELPER);
	99
	100	return (void *)help->data;
	101	}
	102
4e77be46 JP	103	int nf_conntrack_helper_pernet_init(struct net *net);
4e77be46 JP	104	void nf_conntrack_helper_pernet_fini(struct net *net);
5e615b22	105
4e77be46 JP	106	int nf_conntrack_helper_init(void);
4e77be46 JP	107	void nf_conntrack_helper_fini(void);
b334aadc	108
4e77be46 JP	109	int nf_conntrack_broadcast_help(struct sk_buff *skb, unsigned int protoff,
	110	struct nf_conn *ct,
	111	enum ip_conntrack_info ctinfo,
	112	unsigned int timeout);
93557f53	113
544d5c7d PNA	114	struct nf_ct_helper_expectfn {
	115	struct list_head head;
	116	const char *name;
	117	void (expectfn)(struct nf_conn ct, struct nf_conntrack_expect *exp);
	118	};
	119
b20ab9cc PNA	120	__printf(3,4)
	121	void nf_ct_helper_log(struct sk_buff skb, const struct nf_conn ct,
	122	const char *fmt, ...);
	123
544d5c7d PNA	124	void nf_ct_helper_expectfn_register(struct nf_ct_helper_expectfn *n);
	125	void nf_ct_helper_expectfn_unregister(struct nf_ct_helper_expectfn *n);
	126	struct nf_ct_helper_expectfn *
	127	nf_ct_helper_expectfn_find_by_name(const char *name);
	128	struct nf_ct_helper_expectfn *
	129	nf_ct_helper_expectfn_find_by_symbol(const void *symbol);
	130
12f7a505 PNA	131	extern struct hlist_head *nf_ct_helper_hash;
	132	extern unsigned int nf_ct_helper_hsize;
	133
9fb9cbb1	134	#endif /_NF_CONNTRACK_HELPER_H/