[mirror_ubuntu-jammy-kernel.git] / include / net / netfilter / nf_flow_table.h

#ifndef _NF_FLOW_TABLE_H
#define _NF_FLOW_TABLE_H

#include <linux/in.h>
#include <linux/in6.h>
#include <linux/netdevice.h>
#include <linux/rhashtable-types.h>
#include <linux/rcupdate.h>
#include <linux/netfilter.h>
#include <linux/netfilter/nf_conntrack_tuple_common.h>
#include <net/flow_offload.h>
#include <net/dst.h>

struct nf_flowtable;
struct nf_flow_rule;
struct flow_offload;
enum flow_offload_tuple_dir;

struct nf_flow_key {
	struct flow_dissector_key_meta			meta;
	struct flow_dissector_key_control		control;
	struct flow_dissector_key_control		enc_control;
	struct flow_dissector_key_basic			basic;
	union {
		struct flow_dissector_key_ipv4_addrs	ipv4;
		struct flow_dissector_key_ipv6_addrs	ipv6;
	};
	struct flow_dissector_key_keyid			enc_key_id;
	union {
		struct flow_dissector_key_ipv4_addrs	enc_ipv4;
		struct flow_dissector_key_ipv6_addrs	enc_ipv6;
	};
	struct flow_dissector_key_tcp			tcp;
	struct flow_dissector_key_ports			tp;
} __aligned(BITS_PER_LONG / 8); /* Ensure that we can do comparisons as longs. */

struct nf_flow_match {
	struct flow_dissector	dissector;
	struct nf_flow_key	key;
	struct nf_flow_key	mask;
};

struct nf_flow_rule {
	struct nf_flow_match	match;
	struct flow_rule	*rule;
};

struct nf_flowtable_type {
	struct list_head		list;
	int				family;
	int				(*init)(struct nf_flowtable *ft);
	int				(*setup)(struct nf_flowtable *ft,
						 struct net_device *dev,
						 enum flow_block_command cmd);
	int				(*action)(struct net *net,
						  const struct flow_offload *flow,
						  enum flow_offload_tuple_dir dir,
						  struct nf_flow_rule *flow_rule);
	void				(*free)(struct nf_flowtable *ft);
	nf_hookfn			*hook;
	struct module			*owner;
};

enum nf_flowtable_flags {
	NF_FLOWTABLE_HW_OFFLOAD		= 0x1,	/* NFT_FLOWTABLE_HW_OFFLOAD */
	NF_FLOWTABLE_COUNTER		= 0x2,	/* NFT_FLOWTABLE_COUNTER */
};

struct nf_flowtable {
	struct list_head		list;
	struct rhashtable		rhashtable;
	int				priority;
	const struct nf_flowtable_type	*type;
	struct delayed_work		gc_work;
	unsigned int			flags;
	struct flow_block		flow_block;
	struct rw_semaphore		flow_block_lock; /* Guards flow_block */
	possible_net_t			net;
};

static inline bool nf_flowtable_hw_offload(struct nf_flowtable *flowtable)
{
	return flowtable->flags & NF_FLOWTABLE_HW_OFFLOAD;
}

enum flow_offload_tuple_dir {
	FLOW_OFFLOAD_DIR_ORIGINAL = IP_CT_DIR_ORIGINAL,
	FLOW_OFFLOAD_DIR_REPLY = IP_CT_DIR_REPLY,
};
#define FLOW_OFFLOAD_DIR_MAX	IP_CT_DIR_MAX

struct flow_offload_tuple {
	union {
		struct in_addr		src_v4;
		struct in6_addr		src_v6;
	};
	union {
		struct in_addr		dst_v4;
		struct in6_addr		dst_v6;
	};
	struct {
		__be16			src_port;
		__be16			dst_port;
	};

	int				iifidx;

	u8				l3proto;
	u8				l4proto;

	/* All members above are keys for lookups, see flow_offload_hash(). */
	struct { }			__hash;

	u8				dir;

	u16				mtu;

	struct dst_entry		*dst_cache;
};

struct flow_offload_tuple_rhash {
	struct rhash_head		node;
	struct flow_offload_tuple	tuple;
};

enum nf_flow_flags {
	NF_FLOW_SNAT,
	NF_FLOW_DNAT,
	NF_FLOW_TEARDOWN,
	NF_FLOW_HW,
	NF_FLOW_HW_DYING,
	NF_FLOW_HW_DEAD,
	NF_FLOW_HW_REFRESH,
	NF_FLOW_HW_PENDING,
};

enum flow_offload_type {
	NF_FLOW_OFFLOAD_UNSPEC	= 0,
	NF_FLOW_OFFLOAD_ROUTE,
};

struct flow_offload {
	struct flow_offload_tuple_rhash		tuplehash[FLOW_OFFLOAD_DIR_MAX];
	struct nf_conn				*ct;
	unsigned long				flags;
	u16					type;
	u32					timeout;
	struct rcu_head				rcu_head;
};

#define NF_FLOW_TIMEOUT (30 * HZ)
#define nf_flowtable_time_stamp	(u32)jiffies

static inline __s32 nf_flow_timeout_delta(unsigned int timeout)
{
	return (__s32)(timeout - nf_flowtable_time_stamp);
}

struct nf_flow_route {
	struct {
		struct dst_entry	*dst;
	} tuple[FLOW_OFFLOAD_DIR_MAX];
};

struct flow_offload *flow_offload_alloc(struct nf_conn *ct);
void flow_offload_free(struct flow_offload *flow);

static inline int
nf_flow_table_offload_add_cb(struct nf_flowtable *flow_table,
			     flow_setup_cb_t *cb, void *cb_priv)
{
	struct flow_block *block = &flow_table->flow_block;
	struct flow_block_cb *block_cb;
	int err = 0;

	down_write(&flow_table->flow_block_lock);
	block_cb = flow_block_cb_lookup(block, cb, cb_priv);
	if (block_cb) {
		err = -EEXIST;
		goto unlock;
	}

	block_cb = flow_block_cb_alloc(cb, cb_priv, cb_priv, NULL);
	if (IS_ERR(block_cb)) {
		err = PTR_ERR(block_cb);
		goto unlock;
	}

	list_add_tail(&block_cb->list, &block->cb_list);

unlock:
	up_write(&flow_table->flow_block_lock);
	return err;
}

static inline void
nf_flow_table_offload_del_cb(struct nf_flowtable *flow_table,
			     flow_setup_cb_t *cb, void *cb_priv)
{
	struct flow_block *block = &flow_table->flow_block;
	struct flow_block_cb *block_cb;

	down_write(&flow_table->flow_block_lock);
	block_cb = flow_block_cb_lookup(block, cb, cb_priv);
	if (block_cb) {
		list_del(&block_cb->list);
		flow_block_cb_free(block_cb);
	} else {
		WARN_ON(true);
	}
	up_write(&flow_table->flow_block_lock);
}

int flow_offload_route_init(struct flow_offload *flow,
			    const struct nf_flow_route *route);

int flow_offload_add(struct nf_flowtable *flow_table, struct flow_offload *flow);
void flow_offload_refresh(struct nf_flowtable *flow_table,
			  struct flow_offload *flow);

struct flow_offload_tuple_rhash *flow_offload_lookup(struct nf_flowtable *flow_table,
						     struct flow_offload_tuple *tuple);
void nf_flow_table_gc_cleanup(struct nf_flowtable *flowtable,
			      struct net_device *dev);
void nf_flow_table_cleanup(struct net_device *dev);

int nf_flow_table_init(struct nf_flowtable *flow_table);
void nf_flow_table_free(struct nf_flowtable *flow_table);

void flow_offload_teardown(struct flow_offload *flow);

void nf_flow_snat_port(const struct flow_offload *flow,
		       struct sk_buff *skb, unsigned int thoff,
		       u8 protocol, enum flow_offload_tuple_dir dir);
void nf_flow_dnat_port(const struct flow_offload *flow,
		       struct sk_buff *skb, unsigned int thoff,
		       u8 protocol, enum flow_offload_tuple_dir dir);

struct flow_ports {
	__be16 source, dest;
};

unsigned int nf_flow_offload_ip_hook(void *priv, struct sk_buff *skb,
				     const struct nf_hook_state *state);
unsigned int nf_flow_offload_ipv6_hook(void *priv, struct sk_buff *skb,
				       const struct nf_hook_state *state);

#define MODULE_ALIAS_NF_FLOWTABLE(family)	\
	MODULE_ALIAS("nf-flowtable-" __stringify(family))

void nf_flow_offload_add(struct nf_flowtable *flowtable,
			 struct flow_offload *flow);
void nf_flow_offload_del(struct nf_flowtable *flowtable,
			 struct flow_offload *flow);
void nf_flow_offload_stats(struct nf_flowtable *flowtable,
			   struct flow_offload *flow);

void nf_flow_table_offload_flush(struct nf_flowtable *flowtable);
int nf_flow_table_offload_setup(struct nf_flowtable *flowtable,
				struct net_device *dev,
				enum flow_block_command cmd);
int nf_flow_rule_route_ipv4(struct net *net, const struct flow_offload *flow,
			    enum flow_offload_tuple_dir dir,
			    struct nf_flow_rule *flow_rule);
int nf_flow_rule_route_ipv6(struct net *net, const struct flow_offload *flow,
			    enum flow_offload_tuple_dir dir,
			    struct nf_flow_rule *flow_rule);

int nf_flow_table_offload_init(void);
void nf_flow_table_offload_exit(void);

#endif /* _NF_FLOW_TABLE_H */
Commit	Line	Data
3b49e2e9 PNA	1	#ifndef _NF_FLOW_TABLE_H
	2	#define _NF_FLOW_TABLE_H
	3
ac2a6666 PNA	4	#include <linux/in.h>
	5	#include <linux/in6.h>
	6	#include <linux/netdevice.h>
0eb71a9d	7	#include <linux/rhashtable-types.h>
ac2a6666	8	#include <linux/rcupdate.h>
a1b2f04e	9	#include <linux/netfilter.h>
af81f9e7	10	#include <linux/netfilter/nf_conntrack_tuple_common.h>
8bb69f3b	11	#include <net/flow_offload.h>
ac2a6666	12	#include <net/dst.h>
3b49e2e9 PNA	13
3b49e2e9 PNA	14	struct nf_flowtable;
c29f74e0 PNA	15	struct nf_flow_rule;
	16	struct flow_offload;
	17	enum flow_offload_tuple_dir;
3b49e2e9	18
9c26ba9b PB	19	struct nf_flow_key {
	20	struct flow_dissector_key_meta meta;
	21	struct flow_dissector_key_control control;
cfab6dbd	22	struct flow_dissector_key_control enc_control;
9c26ba9b PB	23	struct flow_dissector_key_basic basic;
	24	union {
	25	struct flow_dissector_key_ipv4_addrs ipv4;
	26	struct flow_dissector_key_ipv6_addrs ipv6;
	27	};
cfab6dbd	28	struct flow_dissector_key_keyid enc_key_id;
	29	union {
	30	struct flow_dissector_key_ipv4_addrs enc_ipv4;
	31	struct flow_dissector_key_ipv6_addrs enc_ipv6;
	32	};
9c26ba9b PB	33	struct flow_dissector_key_tcp tcp;
	34	struct flow_dissector_key_ports tp;
	35	} __aligned(BITS_PER_LONG / 8); /* Ensure that we can do comparisons as longs. */
	36
	37	struct nf_flow_match {
	38	struct flow_dissector dissector;
	39	struct nf_flow_key key;
	40	struct nf_flow_key mask;
	41	};
	42
	43	struct nf_flow_rule {
	44	struct nf_flow_match match;
	45	struct flow_rule *rule;
	46	};
	47
3b49e2e9 PNA	48	struct nf_flowtable_type {
	49	struct list_head list;
	50	int family;
a268de77	51	int (init)(struct nf_flowtable ft);
8bb69f3b PNA	52	int (setup)(struct nf_flowtable ft,
	53	struct net_device *dev,
	54	enum flow_block_command cmd);
c29f74e0 PNA	55	int (action)(struct net net,
	56	const struct flow_offload *flow,
	57	enum flow_offload_tuple_dir dir,
	58	struct nf_flow_rule *flow_rule);
b408c5b0	59	void (free)(struct nf_flowtable ft);
3b49e2e9 PNA	60	nf_hookfn *hook;
	61	struct module *owner;
	62	};
	63
8bb69f3b	64	enum nf_flowtable_flags {
cfbd1125	65	NF_FLOWTABLE_HW_OFFLOAD = 0x1, /* NFT_FLOWTABLE_HW_OFFLOAD */
53c2b289	66	NF_FLOWTABLE_COUNTER = 0x2, /* NFT_FLOWTABLE_COUNTER */
8bb69f3b PNA	67	};
8bb69f3b PNA	68
3b49e2e9	69	struct nf_flowtable {
84453a90	70	struct list_head list;
3b49e2e9	71	struct rhashtable rhashtable;
71a8a63b	72	int priority;
3b49e2e9 PNA	73	const struct nf_flowtable_type *type;
3b49e2e9 PNA	74	struct delayed_work gc_work;
8bb69f3b PNA	75	unsigned int flags;
8bb69f3b PNA	76	struct flow_block flow_block;
422c032a	77	struct rw_semaphore flow_block_lock; /* Guards flow_block */
8bb69f3b	78	possible_net_t net;
3b49e2e9 PNA	79	};
3b49e2e9 PNA	80
a5449cdc PNA	81	static inline bool nf_flowtable_hw_offload(struct nf_flowtable *flowtable)
	82	{
	83	return flowtable->flags & NF_FLOWTABLE_HW_OFFLOAD;
	84	}
	85
ac2a6666	86	enum flow_offload_tuple_dir {
af81f9e7 FF	87	FLOW_OFFLOAD_DIR_ORIGINAL = IP_CT_DIR_ORIGINAL,
af81f9e7 FF	88	FLOW_OFFLOAD_DIR_REPLY = IP_CT_DIR_REPLY,
ac2a6666	89	};
4f08f173	90	#define FLOW_OFFLOAD_DIR_MAX IP_CT_DIR_MAX
ac2a6666 PNA	91
	92	struct flow_offload_tuple {
	93	union {
	94	struct in_addr src_v4;
	95	struct in6_addr src_v6;
	96	};
	97	union {
	98	struct in_addr dst_v4;
	99	struct in6_addr dst_v6;
	100	};
	101	struct {
	102	__be16 src_port;
	103	__be16 dst_port;
	104	};
	105
	106	int iifidx;
	107
	108	u8 l3proto;
	109	u8 l4proto;
dbc859d9 PNA	110
	111	/* All members above are keys for lookups, see flow_offload_hash(). */
	112	struct { } __hash;
	113
ac2a6666 PNA	114	u8 dir;
ac2a6666 PNA	115
4f3780c0 FF	116	u16 mtu;
4f3780c0 FF	117
ac2a6666 PNA	118	struct dst_entry *dst_cache;
	119	};
	120
	121	struct flow_offload_tuple_rhash {
	122	struct rhash_head node;
	123	struct flow_offload_tuple tuple;
	124	};
	125
355a8b13 PNA	126	enum nf_flow_flags {
	127	NF_FLOW_SNAT,
	128	NF_FLOW_DNAT,
	129	NF_FLOW_TEARDOWN,
	130	NF_FLOW_HW,
	131	NF_FLOW_HW_DYING,
	132	NF_FLOW_HW_DEAD,
f698fe40	133	NF_FLOW_HW_REFRESH,
2c889795	134	NF_FLOW_HW_PENDING,
355a8b13	135	};
ac2a6666	136
f1363e05 PNA	137	enum flow_offload_type {
	138	NF_FLOW_OFFLOAD_UNSPEC = 0,
	139	NF_FLOW_OFFLOAD_ROUTE,
	140	};
	141
ac2a6666 PNA	142	struct flow_offload {
ac2a6666 PNA	143	struct flow_offload_tuple_rhash tuplehash[FLOW_OFFLOAD_DIR_MAX];
b32d2f34	144	struct nf_conn *ct;
355a8b13	145	unsigned long flags;
f1363e05	146	u16 type;
9f48e9bf	147	u32 timeout;
62248df8	148	struct rcu_head rcu_head;
ac2a6666 PNA	149	};
	150
	151	#define NF_FLOW_TIMEOUT (30 * HZ)
fb46f1b7 PNA	152	#define nf_flowtable_time_stamp (u32)jiffies
	153
	154	static inline __s32 nf_flow_timeout_delta(unsigned int timeout)
	155	{
	156	return (__s32)(timeout - nf_flowtable_time_stamp);
	157	}
ac2a6666 PNA	158
	159	struct nf_flow_route {
	160	struct {
	161	struct dst_entry *dst;
ac2a6666 PNA	162	} tuple[FLOW_OFFLOAD_DIR_MAX];
	163	};
	164
f1363e05	165	struct flow_offload flow_offload_alloc(struct nf_conn ct);
ac2a6666 PNA	166	void flow_offload_free(struct flow_offload *flow);
ac2a6666 PNA	167
505ee3a1 AH	168	static inline int
	169	nf_flow_table_offload_add_cb(struct nf_flowtable *flow_table,
	170	flow_setup_cb_t cb, void cb_priv)
	171	{
	172	struct flow_block *block = &flow_table->flow_block;
	173	struct flow_block_cb *block_cb;
	174	int err = 0;
	175
	176	down_write(&flow_table->flow_block_lock);
	177	block_cb = flow_block_cb_lookup(block, cb, cb_priv);
	178	if (block_cb) {
	179	err = -EEXIST;
	180	goto unlock;
	181	}
	182
	183	block_cb = flow_block_cb_alloc(cb, cb_priv, cb_priv, NULL);
	184	if (IS_ERR(block_cb)) {
	185	err = PTR_ERR(block_cb);
	186	goto unlock;
	187	}
	188
	189	list_add_tail(&block_cb->list, &block->cb_list);
	190
	191	unlock:
	192	up_write(&flow_table->flow_block_lock);
	193	return err;
	194	}
	195
	196	static inline void
	197	nf_flow_table_offload_del_cb(struct nf_flowtable *flow_table,
	198	flow_setup_cb_t cb, void cb_priv)
	199	{
	200	struct flow_block *block = &flow_table->flow_block;
	201	struct flow_block_cb *block_cb;
	202
	203	down_write(&flow_table->flow_block_lock);
	204	block_cb = flow_block_cb_lookup(block, cb, cb_priv);
	205	if (block_cb) {
	206	list_del(&block_cb->list);
	207	flow_block_cb_free(block_cb);
	208	} else {
	209	WARN_ON(true);
	210	}
	211	up_write(&flow_table->flow_block_lock);
	212	}
978703f4	213
f1363e05 PNA	214	int flow_offload_route_init(struct flow_offload *flow,
	215	const struct nf_flow_route *route);
	216
ac2a6666	217	int flow_offload_add(struct nf_flowtable flow_table, struct flow_offload flow);
8b3646d6 PB	218	void flow_offload_refresh(struct nf_flowtable *flow_table,
	219	struct flow_offload *flow);
	220
ac2a6666 PNA	221	struct flow_offload_tuple_rhash flow_offload_lookup(struct nf_flowtable flow_table,
ac2a6666 PNA	222	struct flow_offload_tuple *tuple);
a8284c68 PNA	223	void nf_flow_table_gc_cleanup(struct nf_flowtable *flowtable,
a8284c68 PNA	224	struct net_device *dev);
5f1be84a	225	void nf_flow_table_cleanup(struct net_device *dev);
c0ea1bcb	226
a268de77	227	int nf_flow_table_init(struct nf_flowtable *flow_table);
b408c5b0	228	void nf_flow_table_free(struct nf_flowtable *flow_table);
ac2a6666	229
59c466dd	230	void flow_offload_teardown(struct flow_offload *flow);
ac2a6666	231
f4401262 PNA	232	void nf_flow_snat_port(const struct flow_offload *flow,
	233	struct sk_buff *skb, unsigned int thoff,
	234	u8 protocol, enum flow_offload_tuple_dir dir);
	235	void nf_flow_dnat_port(const struct flow_offload *flow,
	236	struct sk_buff *skb, unsigned int thoff,
	237	u8 protocol, enum flow_offload_tuple_dir dir);
ac2a6666 PNA	238
	239	struct flow_ports {
	240	__be16 source, dest;
	241	};
	242
7c23b629 PNA	243	unsigned int nf_flow_offload_ip_hook(void priv, struct sk_buff skb,
	244	const struct nf_hook_state *state);
	245	unsigned int nf_flow_offload_ipv6_hook(void priv, struct sk_buff skb,
	246	const struct nf_hook_state *state);
	247
ac2a6666 PNA	248	#define MODULE_ALIAS_NF_FLOWTABLE(family) \
	249	MODULE_ALIAS("nf-flowtable-" __stringify(family))
	250
c29f74e0 PNA	251	void nf_flow_offload_add(struct nf_flowtable *flowtable,
	252	struct flow_offload *flow);
	253	void nf_flow_offload_del(struct nf_flowtable *flowtable,
	254	struct flow_offload *flow);
	255	void nf_flow_offload_stats(struct nf_flowtable *flowtable,
	256	struct flow_offload *flow);
	257
	258	void nf_flow_table_offload_flush(struct nf_flowtable *flowtable);
	259	int nf_flow_table_offload_setup(struct nf_flowtable *flowtable,
	260	struct net_device *dev,
	261	enum flow_block_command cmd);
5c27d8d7 PNA	262	int nf_flow_rule_route_ipv4(struct net net, const struct flow_offload flow,
	263	enum flow_offload_tuple_dir dir,
	264	struct nf_flow_rule *flow_rule);
	265	int nf_flow_rule_route_ipv6(struct net net, const struct flow_offload flow,
	266	enum flow_offload_tuple_dir dir,
	267	struct nf_flow_rule *flow_rule);
c29f74e0 PNA	268
	269	int nf_flow_table_offload_init(void);
	270	void nf_flow_table_offload_exit(void);
8bb69f3b	271
0286fbc6	272	#endif /* _NF_FLOW_TABLE_H */