[linux-2.6-block.git] / include / net / fib_rules.h

/* SPDX-License-Identifier: GPL-2.0 */
#ifndef __NET_FIB_RULES_H
#define __NET_FIB_RULES_H

#include <linux/types.h>
#include <linux/slab.h>
#include <linux/netdevice.h>
#include <linux/fib_rules.h>
#include <linux/refcount.h>
#include <net/flow.h>
#include <net/rtnetlink.h>
#include <net/fib_notifier.h>

struct fib_kuid_range {
	kuid_t start;
	kuid_t end;
};

struct fib_rule {
	struct list_head	list;
	int			iifindex;
	int			oifindex;
	u32			mark;
	u32			mark_mask;
	u32			flags;
	u32			table;
	u8			action;
	u8			l3mdev;
	u8                      proto;
	u8			ip_proto;
	u32			target;
	__be64			tun_id;
	struct fib_rule __rcu	*ctarget;
	struct net		*fr_net;

	refcount_t		refcnt;
	u32			pref;
	int			suppress_ifgroup;
	int			suppress_prefixlen;
	char			iifname[IFNAMSIZ];
	char			oifname[IFNAMSIZ];
	struct fib_kuid_range	uid_range;
	struct fib_rule_port_range	sport_range;
	struct fib_rule_port_range	dport_range;
	struct rcu_head		rcu;
};

struct fib_lookup_arg {
	void			*lookup_ptr;
	const void		*lookup_data;
	void			*result;
	struct fib_rule		*rule;
	u32			table;
	int			flags;
#define FIB_LOOKUP_NOREF		1
#define FIB_LOOKUP_IGNORE_LINKSTATE	2
};

struct fib_rules_ops {
	int			family;
	struct list_head	list;
	int			rule_size;
	int			addr_size;
	int			unresolved_rules;
	int			nr_goto_rules;
	unsigned int		fib_rules_seq;

	int			(*action)(struct fib_rule *,
					  struct flowi *, int,
					  struct fib_lookup_arg *);
	bool			(*suppress)(struct fib_rule *,
					    struct fib_lookup_arg *);
	int			(*match)(struct fib_rule *,
					 struct flowi *, int);
	int			(*configure)(struct fib_rule *,
					     struct sk_buff *,
					     struct fib_rule_hdr *,
					     struct nlattr **,
					     struct netlink_ext_ack *);
	int			(*delete)(struct fib_rule *);
	int			(*compare)(struct fib_rule *,
					   struct fib_rule_hdr *,
					   struct nlattr **);
	int			(*fill)(struct fib_rule *, struct sk_buff *,
					struct fib_rule_hdr *);
	size_t			(*nlmsg_payload)(struct fib_rule *);

	/* Called after modifications to the rules set, must flush
	 * the route cache if one exists. */
	void			(*flush_cache)(struct fib_rules_ops *ops);

	int			nlgroup;
	const struct nla_policy	*policy;
	struct list_head	rules_list;
	struct module		*owner;
	struct net		*fro_net;
	struct rcu_head		rcu;
};

struct fib_rule_notifier_info {
	struct fib_notifier_info info; /* must be first */
	struct fib_rule *rule;
};

#define FRA_GENERIC_POLICY \
	[FRA_IIFNAME]	= { .type = NLA_STRING, .len = IFNAMSIZ - 1 }, \
	[FRA_OIFNAME]	= { .type = NLA_STRING, .len = IFNAMSIZ - 1 }, \
	[FRA_PRIORITY]	= { .type = NLA_U32 }, \
	[FRA_FWMARK]	= { .type = NLA_U32 }, \
	[FRA_FWMASK]	= { .type = NLA_U32 }, \
	[FRA_TABLE]     = { .type = NLA_U32 }, \
	[FRA_SUPPRESS_PREFIXLEN] = { .type = NLA_U32 }, \
	[FRA_SUPPRESS_IFGROUP] = { .type = NLA_U32 }, \
	[FRA_GOTO]	= { .type = NLA_U32 }, \
	[FRA_L3MDEV]	= { .type = NLA_U8 }, \
	[FRA_UID_RANGE]	= { .len = sizeof(struct fib_rule_uid_range) }, \
	[FRA_PROTOCOL]  = { .type = NLA_U8 }, \
	[FRA_IP_PROTO]  = { .type = NLA_U8 }, \
	[FRA_SPORT_RANGE] = { .len = sizeof(struct fib_rule_port_range) }, \
	[FRA_DPORT_RANGE] = { .len = sizeof(struct fib_rule_port_range) }


static inline void fib_rule_get(struct fib_rule *rule)
{
	refcount_inc(&rule->refcnt);
}

static inline void fib_rule_put(struct fib_rule *rule)
{
	if (refcount_dec_and_test(&rule->refcnt))
		kfree_rcu(rule, rcu);
}

#ifdef CONFIG_NET_L3_MASTER_DEV
static inline u32 fib_rule_get_table(struct fib_rule *rule,
				     struct fib_lookup_arg *arg)
{
	return rule->l3mdev ? arg->table : rule->table;
}
#else
static inline u32 fib_rule_get_table(struct fib_rule *rule,
				     struct fib_lookup_arg *arg)
{
	return rule->table;
}
#endif

static inline u32 frh_get_table(struct fib_rule_hdr *frh, struct nlattr **nla)
{
	if (nla[FRA_TABLE])
		return nla_get_u32(nla[FRA_TABLE]);
	return frh->table;
}

static inline bool fib_rule_port_range_set(const struct fib_rule_port_range *range)
{
	return range->start != 0 && range->end != 0;
}

static inline bool fib_rule_port_inrange(const struct fib_rule_port_range *a,
					 __be16 port)
{
	return ntohs(port) >= a->start &&
		ntohs(port) <= a->end;
}

static inline bool fib_rule_port_range_valid(const struct fib_rule_port_range *a)
{
	return a->start != 0 && a->end != 0 && a->end < 0xffff &&
		a->start <= a->end;
}

static inline bool fib_rule_port_range_compare(struct fib_rule_port_range *a,
					       struct fib_rule_port_range *b)
{
	return a->start == b->start &&
		a->end == b->end;
}

static inline bool fib_rule_requires_fldissect(struct fib_rule *rule)
{
	return rule->ip_proto ||
		fib_rule_port_range_set(&rule->sport_range) ||
		fib_rule_port_range_set(&rule->dport_range);
}

struct fib_rules_ops *fib_rules_register(const struct fib_rules_ops *,
					 struct net *);
void fib_rules_unregister(struct fib_rules_ops *);

int fib_rules_lookup(struct fib_rules_ops *, struct flowi *, int flags,
		     struct fib_lookup_arg *);
int fib_default_rule_add(struct fib_rules_ops *, u32 pref, u32 table,
			 u32 flags);
bool fib_rule_matchall(const struct fib_rule *rule);
int fib_rules_dump(struct net *net, struct notifier_block *nb, int family);
unsigned int fib_rules_seq_read(struct net *net, int family);

int fib_nl_newrule(struct sk_buff *skb, struct nlmsghdr *nlh,
		   struct netlink_ext_ack *extack);
int fib_nl_delrule(struct sk_buff *skb, struct nlmsghdr *nlh,
		   struct netlink_ext_ack *extack);
#endif
Commit	Line	Data
b2441318	1	/* SPDX-License-Identifier: GPL-2.0 */
14c0b97d TG	2	#ifndef __NET_FIB_RULES_H
	3	#define __NET_FIB_RULES_H
	4
	5	#include <linux/types.h>
5a0e3ad6	6	#include <linux/slab.h>
14c0b97d TG	7	#include <linux/netdevice.h>
14c0b97d TG	8	#include <linux/fib_rules.h>
717d1e99	9	#include <linux/refcount.h>
14c0b97d	10	#include <net/flow.h>
9d9e6a58	11	#include <net/rtnetlink.h>
1b2a4440	12	#include <net/fib_notifier.h>
14c0b97d	13
622ec2c9 LC	14	struct fib_kuid_range {
	15	kuid_t start;
	16	kuid_t end;
	17	};
	18
fd2c3ef7	19	struct fib_rule {
14c0b97d	20	struct list_head list;
491deb24	21	int iifindex;
1b038a5e	22	int oifindex;
b8964ed9 TG	23	u32 mark;
b8964ed9 TG	24	u32 mark_mask;
14c0b97d TG	25	u32 flags;
	26	u32 table;
	27	u8 action;
96c63fa7	28	u8 l3mdev;
cac56209	29	u8 proto;
bfff4862	30	u8 ip_proto;
0947c9fe	31	u32 target;
e7030878	32	__be64 tun_id;
7a2b03c5	33	struct fib_rule __rcu *ctarget;
fba3679d ED	34	struct net *fr_net;
fba3679d ED	35
717d1e99	36	refcount_t refcnt;
fba3679d ED	37	u32 pref;
	38	int suppress_ifgroup;
	39	int suppress_prefixlen;
491deb24	40	char iifname[IFNAMSIZ];
1b038a5e	41	char oifname[IFNAMSIZ];
622ec2c9	42	struct fib_kuid_range uid_range;
bfff4862 RP	43	struct fib_rule_port_range sport_range;
bfff4862 RP	44	struct fib_rule_port_range dport_range;
14c0b97d TG	45	struct rcu_head rcu;
	46	};
	47
fd2c3ef7	48	struct fib_lookup_arg {
14c0b97d	49	void *lookup_ptr;
b75cc8f9	50	const void *lookup_data;
14c0b97d TG	51	void *result;
14c0b97d TG	52	struct fib_rule *rule;
96c63fa7	53	u32 table;
ebc0ffae	54	int flags;
0eeb075f AG	55	#define FIB_LOOKUP_NOREF 1
0eeb075f AG	56	#define FIB_LOOKUP_IGNORE_LINKSTATE 2
14c0b97d TG	57	};
14c0b97d TG	58
fd2c3ef7	59	struct fib_rules_ops {
14c0b97d TG	60	int family;
	61	struct list_head list;
	62	int rule_size;
e1701c68	63	int addr_size;
0947c9fe TG	64	int unresolved_rules;
0947c9fe TG	65	int nr_goto_rules;
1b2a4440	66	unsigned int fib_rules_seq;
14c0b97d TG	67
	68	int (action)(struct fib_rule ,
	69	struct flowi *, int,
	70	struct fib_lookup_arg *);
7764a45a ST	71	bool (suppress)(struct fib_rule ,
7764a45a ST	72	struct fib_lookup_arg *);
14c0b97d TG	73	int (match)(struct fib_rule ,
	74	struct flowi *, int);
	75	int (configure)(struct fib_rule ,
	76	struct sk_buff *,
14c0b97d	77	struct fib_rule_hdr *,
b16fb418 RP	78	struct nlattr **,
b16fb418 RP	79	struct netlink_ext_ack *);
0ddcf43d	80	int (delete)(struct fib_rule );
14c0b97d TG	81	int (compare)(struct fib_rule ,
	82	struct fib_rule_hdr *,
	83	struct nlattr **);
	84	int (fill)(struct fib_rule , struct sk_buff *,
14c0b97d	85	struct fib_rule_hdr *);
339bf98f	86	size_t (nlmsg_payload)(struct fib_rule );
14c0b97d	87
73417f61 TG	88	/* Called after modifications to the rules set, must flush
73417f61 TG	89	* the route cache if one exists. */
ae299fc0	90	void (flush_cache)(struct fib_rules_ops ops);
73417f61	91
14c0b97d	92	int nlgroup;
ef7c79ed	93	const struct nla_policy *policy;
76c72d4f	94	struct list_head rules_list;
14c0b97d	95	struct module *owner;
03592383	96	struct net *fro_net;
e9c5158a	97	struct rcu_head rcu;
14c0b97d TG	98	};
14c0b97d TG	99
1b2a4440 IS	100	struct fib_rule_notifier_info {
	101	struct fib_notifier_info info; /* must be first */
	102	struct fib_rule *rule;
	103	};
	104
1f6c9557	105	#define FRA_GENERIC_POLICY \
491deb24	106	[FRA_IIFNAME] = { .type = NLA_STRING, .len = IFNAMSIZ - 1 }, \
1b038a5e	107	[FRA_OIFNAME] = { .type = NLA_STRING, .len = IFNAMSIZ - 1 }, \
1f6c9557 TG	108	[FRA_PRIORITY] = { .type = NLA_U32 }, \
	109	[FRA_FWMARK] = { .type = NLA_U32 }, \
	110	[FRA_FWMASK] = { .type = NLA_U32 }, \
0947c9fe	111	[FRA_TABLE] = { .type = NLA_U32 }, \
73f5698e	112	[FRA_SUPPRESS_PREFIXLEN] = { .type = NLA_U32 }, \
6ef94cfa	113	[FRA_SUPPRESS_IFGROUP] = { .type = NLA_U32 }, \
96c63fa7	114	[FRA_GOTO] = { .type = NLA_U32 }, \
622ec2c9	115	[FRA_L3MDEV] = { .type = NLA_U8 }, \
1b71af60	116	[FRA_UID_RANGE] = { .len = sizeof(struct fib_rule_uid_range) }, \
5f6f845b RP	117	[FRA_PROTOCOL] = { .type = NLA_U8 }, \
	118	[FRA_IP_PROTO] = { .type = NLA_U8 }, \
	119	[FRA_SPORT_RANGE] = { .len = sizeof(struct fib_rule_port_range) }, \
	120	[FRA_DPORT_RANGE] = { .len = sizeof(struct fib_rule_port_range) }
	121
1f6c9557	122
14c0b97d TG	123	static inline void fib_rule_get(struct fib_rule *rule)
14c0b97d TG	124	{
717d1e99	125	refcount_inc(&rule->refcnt);
14c0b97d TG	126	}
14c0b97d TG	127
14c0b97d TG	128	static inline void fib_rule_put(struct fib_rule *rule)
14c0b97d TG	129	{
717d1e99	130	if (refcount_dec_and_test(&rule->refcnt))
efd7ef1c	131	kfree_rcu(rule, rcu);
14c0b97d TG	132	}
14c0b97d TG	133
96c63fa7 DA	134	#ifdef CONFIG_NET_L3_MASTER_DEV
	135	static inline u32 fib_rule_get_table(struct fib_rule *rule,
	136	struct fib_lookup_arg *arg)
	137	{
	138	return rule->l3mdev ? arg->table : rule->table;
	139	}
	140	#else
	141	static inline u32 fib_rule_get_table(struct fib_rule *rule,
	142	struct fib_lookup_arg *arg)
	143	{
	144	return rule->table;
	145	}
	146	#endif
	147
9e762a4a PM	148	static inline u32 frh_get_table(struct fib_rule_hdr frh, struct nlattr *nla)
	149	{
	150	if (nla[FRA_TABLE])
	151	return nla_get_u32(nla[FRA_TABLE]);
	152	return frh->table;
	153	}
	154
bfff4862 RP	155	static inline bool fib_rule_port_range_set(const struct fib_rule_port_range *range)
	156	{
	157	return range->start != 0 && range->end != 0;
	158	}
	159
	160	static inline bool fib_rule_port_inrange(const struct fib_rule_port_range *a,
	161	__be16 port)
	162	{
	163	return ntohs(port) >= a->start &&
	164	ntohs(port) <= a->end;
	165	}
	166
	167	static inline bool fib_rule_port_range_valid(const struct fib_rule_port_range *a)
	168	{
	169	return a->start != 0 && a->end != 0 && a->end < 0xffff &&
	170	a->start <= a->end;
	171	}
	172
	173	static inline bool fib_rule_port_range_compare(struct fib_rule_port_range *a,
	174	struct fib_rule_port_range *b)
	175	{
	176	return a->start == b->start &&
	177	a->end == b->end;
	178	}
	179
	180	static inline bool fib_rule_requires_fldissect(struct fib_rule *rule)
	181	{
	182	return rule->ip_proto \|\|
	183	fib_rule_port_range_set(&rule->sport_range) \|\|
	184	fib_rule_port_range_set(&rule->dport_range);
	185	}
	186
8de6879f JP	187	struct fib_rules_ops fib_rules_register(const struct fib_rules_ops ,
	188	struct net *);
	189	void fib_rules_unregister(struct fib_rules_ops *);
14c0b97d	190
8de6879f JP	191	int fib_rules_lookup(struct fib_rules_ops , struct flowi , int flags,
	192	struct fib_lookup_arg *);
	193	int fib_default_rule_add(struct fib_rules_ops *, u32 pref, u32 table,
	194	u32 flags);
3c71006d	195	bool fib_rule_matchall(const struct fib_rule *rule);
1b2a4440 IS	196	int fib_rules_dump(struct net net, struct notifier_block nb, int family);
1b2a4440 IS	197	unsigned int fib_rules_seq_read(struct net *net, int family);
96c63fa7	198
c21ef3e3 DA	199	int fib_nl_newrule(struct sk_buff skb, struct nlmsghdr nlh,
	200	struct netlink_ext_ack *extack);
	201	int fib_nl_delrule(struct sk_buff skb, struct nlmsghdr nlh,
	202	struct netlink_ext_ack *extack);
14c0b97d	203	#endif