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

/*
 * Copyright (C)2003,2004 USAGI/WIDE Project
 *
 * Header for use in defining a given L3 protocol for connection tracking.
 *
 * Author:
 *	Yasuyuki Kozakai @USAGI	<yasuyuki.kozakai@toshiba.co.jp>
 *
 * Derived from include/netfilter_ipv4/ip_conntrack_protocol.h
 */

#ifndef _NF_CONNTRACK_L3PROTO_H
#define _NF_CONNTRACK_L3PROTO_H
#include <linux/netlink.h>
#include <net/netlink.h>
#include <linux/seq_file.h>
#include <net/netfilter/nf_conntrack.h>

struct nf_conntrack_l3proto
{
	/* L3 Protocol Family number. ex) PF_INET */
	u_int16_t l3proto;

	/* Protocol name */
	const char *name;

	/*
	 * Try to fill in the third arg: nhoff is offset of l3 proto
         * hdr.  Return true if possible.
	 */
	int (*pkt_to_tuple)(const struct sk_buff *skb, unsigned int nhoff,
			    struct nf_conntrack_tuple *tuple);

	/*
	 * Invert the per-proto part of the tuple: ie. turn xmit into reply.
	 * Some packets can't be inverted: return 0 in that case.
	 */
	int (*invert_tuple)(struct nf_conntrack_tuple *inverse,
			    const struct nf_conntrack_tuple *orig);

	/* Print out the per-protocol part of the tuple. */
	int (*print_tuple)(struct seq_file *s,
			   const struct nf_conntrack_tuple *);

	/* Print out the private part of the conntrack. */
	int (*print_conntrack)(struct seq_file *s, const struct nf_conn *);

	/* Returns verdict for packet, or -1 for invalid. */
	int (*packet)(struct nf_conn *conntrack,
		      const struct sk_buff *skb,
		      enum ip_conntrack_info ctinfo);

	/*
	 * Called when a new connection for this protocol found;
	 * returns TRUE if it's OK.  If so, packet() called next.
	 */
	int (*new)(struct nf_conn *conntrack, const struct sk_buff *skb);

	/*
	 * Called before tracking. 
	 *	*dataoff: offset of protocol header (TCP, UDP,...) in skb
	 *	*protonum: protocol number
	 */
	int (*get_l4proto)(const struct sk_buff *skb, unsigned int nhoff,
			   unsigned int *dataoff, u_int8_t *protonum);

	int (*tuple_to_nlattr)(struct sk_buff *skb,
			       const struct nf_conntrack_tuple *t);

	int (*nlattr_to_tuple)(struct nlattr *tb[],
			       struct nf_conntrack_tuple *t);
	const struct nla_policy *nla_policy;

#ifdef CONFIG_SYSCTL
	struct ctl_table_header	*ctl_table_header;
	struct ctl_table	*ctl_table_path;
	struct ctl_table	*ctl_table;
#endif /* CONFIG_SYSCTL */

	/* Module (if any) which this is connected to. */
	struct module *me;
};

extern struct nf_conntrack_l3proto *nf_ct_l3protos[AF_MAX];

/* Protocol registration. */
extern int nf_conntrack_l3proto_register(struct nf_conntrack_l3proto *proto);
extern void nf_conntrack_l3proto_unregister(struct nf_conntrack_l3proto *proto);
extern struct nf_conntrack_l3proto *nf_ct_l3proto_find_get(u_int16_t l3proto);
extern void nf_ct_l3proto_put(struct nf_conntrack_l3proto *p);

/* Existing built-in protocols */
extern struct nf_conntrack_l3proto nf_conntrack_l3proto_generic;

static inline struct nf_conntrack_l3proto *
__nf_ct_l3proto_find(u_int16_t l3proto)
{
	if (unlikely(l3proto >= AF_MAX))
		return &nf_conntrack_l3proto_generic;
	return rcu_dereference(nf_ct_l3protos[l3proto]);
}

#endif /*_NF_CONNTRACK_L3PROTO_H*/
Commit	Line	Data
9fb9cbb1 YK	1	/*
	2	* Copyright (C)2003,2004 USAGI/WIDE Project
	3	*
	4	* Header for use in defining a given L3 protocol for connection tracking.
	5	*
	6	* Author:
	7	* Yasuyuki Kozakai @USAGI <yasuyuki.kozakai@toshiba.co.jp>
	8	*
	9	* Derived from include/netfilter_ipv4/ip_conntrack_protocol.h
	10	*/
	11
	12	#ifndef _NF_CONNTRACK_L3PROTO_H
	13	#define _NF_CONNTRACK_L3PROTO_H
df6fb868	14	#include <linux/netlink.h>
f73e924c	15	#include <net/netlink.h>
9fb9cbb1 YK	16	#include <linux/seq_file.h>
	17	#include <net/netfilter/nf_conntrack.h>
	18
	19	struct nf_conntrack_l3proto
	20	{
9fb9cbb1 YK	21	/* L3 Protocol Family number. ex) PF_INET */
	22	u_int16_t l3proto;
	23
	24	/* Protocol name */
	25	const char *name;
	26
	27	/*
	28	* Try to fill in the third arg: nhoff is offset of l3 proto
	29	* hdr. Return true if possible.
	30	*/
	31	int (pkt_to_tuple)(const struct sk_buff skb, unsigned int nhoff,
	32	struct nf_conntrack_tuple *tuple);
	33
	34	/*
	35	* Invert the per-proto part of the tuple: ie. turn xmit into reply.
	36	* Some packets can't be inverted: return 0 in that case.
	37	*/
	38	int (invert_tuple)(struct nf_conntrack_tuple inverse,
	39	const struct nf_conntrack_tuple *orig);
	40
	41	/* Print out the per-protocol part of the tuple. */
	42	int (print_tuple)(struct seq_file s,
	43	const struct nf_conntrack_tuple *);
	44
	45	/* Print out the private part of the conntrack. */
	46	int (print_conntrack)(struct seq_file s, const struct nf_conn *);
	47
	48	/* Returns verdict for packet, or -1 for invalid. */
	49	int (packet)(struct nf_conn conntrack,
	50	const struct sk_buff *skb,
	51	enum ip_conntrack_info ctinfo);
	52
	53	/*
	54	* Called when a new connection for this protocol found;
	55	* returns TRUE if it's OK. If so, packet() called next.
	56	*/
	57	int (new)(struct nf_conn conntrack, const struct sk_buff *skb);
	58
9fb9cbb1 YK	59	/*
9fb9cbb1 YK	60	* Called before tracking.
ffc30690	61	* *dataoff: offset of protocol header (TCP, UDP,...) in skb
9fb9cbb1 YK	62	* *protonum: protocol number
9fb9cbb1 YK	63	*/
ffc30690 YK	64	int (get_l4proto)(const struct sk_buff skb, unsigned int nhoff,
ffc30690 YK	65	unsigned int dataoff, u_int8_t protonum);
9fb9cbb1	66
fdf70832	67	int (tuple_to_nlattr)(struct sk_buff skb,
c1d10adb PNA	68	const struct nf_conntrack_tuple *t);
c1d10adb PNA	69
fdf70832	70	int (nlattr_to_tuple)(struct nlattr tb[],
c1d10adb	71	struct nf_conntrack_tuple *t);
f73e924c	72	const struct nla_policy *nla_policy;
c1d10adb	73
d62f9ed4 PM	74	#ifdef CONFIG_SYSCTL
	75	struct ctl_table_header *ctl_table_header;
	76	struct ctl_table *ctl_table_path;
	77	struct ctl_table *ctl_table;
	78	#endif /* CONFIG_SYSCTL */
	79
9fb9cbb1 YK	80	/* Module (if any) which this is connected to. */
	81	struct module *me;
	82	};
	83
	84	extern struct nf_conntrack_l3proto *nf_ct_l3protos[AF_MAX];
	85
	86	/* Protocol registration. */
	87	extern int nf_conntrack_l3proto_register(struct nf_conntrack_l3proto *proto);
fe3eb20c	88	extern void nf_conntrack_l3proto_unregister(struct nf_conntrack_l3proto *proto);
a3c5029c	89	extern struct nf_conntrack_l3proto *nf_ct_l3proto_find_get(u_int16_t l3proto);
c1d10adb PNA	90	extern void nf_ct_l3proto_put(struct nf_conntrack_l3proto *p);
c1d10adb PNA	91
9fb9cbb1	92	/* Existing built-in protocols */
605dcad6	93	extern struct nf_conntrack_l3proto nf_conntrack_l3proto_generic;
ddc8d029 YK	94
	95	static inline struct nf_conntrack_l3proto *
	96	__nf_ct_l3proto_find(u_int16_t l3proto)
	97	{
	98	if (unlikely(l3proto >= AF_MAX))
605dcad6	99	return &nf_conntrack_l3proto_generic;
923f4902	100	return rcu_dereference(nf_ct_l3protos[l3proto]);
ddc8d029 YK	101	}
ddc8d029 YK	102
9fb9cbb1	103	#endif /_NF_CONNTRACK_L3PROTO_H/