[mirror_ubuntu-bionic-kernel.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.
	 */
	bool (*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.
	 */
	bool (*invert_tuple)(struct nf_conntrack_tuple *inverse,
			     const struct nf_conntrack_tuple *orig);

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

	/*
	 * 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);

	/*
	 * Calculate size of tuple nlattr
	 */
	int (*nlattr_tuple_size)(void);

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

	size_t nla_size;

#ifdef CONFIG_SYSCTL
	const char		*ctl_table_path;
#endif /* CONFIG_SYSCTL */

	/* Init l3proto pernet data */
	int (*init_net)(struct net *net);

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

extern struct nf_conntrack_l3proto __rcu *nf_ct_l3protos[AF_MAX];

/* Protocol pernet registration. */
int nf_ct_l3proto_pernet_register(struct net *net,
				  struct nf_conntrack_l3proto *proto);
void nf_ct_l3proto_pernet_unregister(struct net *net,
				     struct nf_conntrack_l3proto *proto);

/* Protocol global registration. */
int nf_ct_l3proto_register(struct nf_conntrack_l3proto *proto);
void nf_ct_l3proto_unregister(struct nf_conntrack_l3proto *proto);

struct nf_conntrack_l3proto *nf_ct_l3proto_find_get(u_int16_t l3proto);

/* 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
	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
	14	#include <linux/netlink.h>
	15	#include <net/netlink.h>
	16	#include <linux/seq_file.h>
	17	#include <net/netfilter/nf_conntrack.h>
	18
	19	struct nf_conntrack_l3proto {
	20	/* L3 Protocol Family number. ex) PF_INET */
	21	u_int16_t l3proto;
	22
	23	/* Protocol name */
	24	const char *name;
	25
	26	/*
	27	* Try to fill in the third arg: nhoff is offset of l3 proto
	28	* hdr. Return true if possible.
	29	*/
	30	bool (pkt_to_tuple)(const struct sk_buff skb, unsigned int nhoff,
	31	struct nf_conntrack_tuple *tuple);
	32
	33	/*
	34	* Invert the per-proto part of the tuple: ie. turn xmit into reply.
	35	* Some packets can't be inverted: return 0 in that case.
	36	*/
	37	bool (invert_tuple)(struct nf_conntrack_tuple inverse,
	38	const struct nf_conntrack_tuple *orig);
	39
	40	/* Print out the per-protocol part of the tuple. */
	41	void (print_tuple)(struct seq_file s,
	42	const struct nf_conntrack_tuple *);
	43
	44	/*
	45	* Called before tracking.
	46	* *dataoff: offset of protocol header (TCP, UDP,...) in skb
	47	* *protonum: protocol number
	48	*/
	49	int (get_l4proto)(const struct sk_buff skb, unsigned int nhoff,
	50	unsigned int dataoff, u_int8_t protonum);
	51
	52	int (tuple_to_nlattr)(struct sk_buff skb,
	53	const struct nf_conntrack_tuple *t);
	54
	55	/*
	56	* Calculate size of tuple nlattr
	57	*/
	58	int (*nlattr_tuple_size)(void);
	59
	60	int (nlattr_to_tuple)(struct nlattr tb[],
	61	struct nf_conntrack_tuple *t);
	62	const struct nla_policy *nla_policy;
	63
	64	size_t nla_size;
	65
	66	#ifdef CONFIG_SYSCTL
	67	const char *ctl_table_path;
	68	#endif /* CONFIG_SYSCTL */
	69
	70	/* Init l3proto pernet data */
	71	int (init_net)(struct net net);
	72
	73	/* Module (if any) which this is connected to. */
	74	struct module *me;
	75	};
	76
	77	extern struct nf_conntrack_l3proto __rcu *nf_ct_l3protos[AF_MAX];
	78
	79	/* Protocol pernet registration. */
	80	int nf_ct_l3proto_pernet_register(struct net *net,
	81	struct nf_conntrack_l3proto *proto);
	82	void nf_ct_l3proto_pernet_unregister(struct net *net,
	83	struct nf_conntrack_l3proto *proto);
	84
	85	/* Protocol global registration. */
	86	int nf_ct_l3proto_register(struct nf_conntrack_l3proto *proto);
	87	void nf_ct_l3proto_unregister(struct nf_conntrack_l3proto *proto);
	88
	89	struct nf_conntrack_l3proto *nf_ct_l3proto_find_get(u_int16_t l3proto);
	90
	91	/* Existing built-in protocols */
	92	extern struct nf_conntrack_l3proto nf_conntrack_l3proto_generic;
	93
	94	static inline struct nf_conntrack_l3proto *
	95	__nf_ct_l3proto_find(u_int16_t l3proto)
	96	{
	97	if (unlikely(l3proto >= AF_MAX))
	98	return &nf_conntrack_l3proto_generic;
	99	return rcu_dereference(nf_ct_l3protos[l3proto]);
	100	}
	101
	102	#endif /_NF_CONNTRACK_L3PROTO_H/