[mirror_ubuntu-eoan-kernel.git] / include / net / l3mdev.h

/* SPDX-License-Identifier: GPL-2.0-or-later */
/*
 * include/net/l3mdev.h - L3 master device API
 * Copyright (c) 2015 Cumulus Networks
 * Copyright (c) 2015 David Ahern <dsa@cumulusnetworks.com>
 */
#ifndef _NET_L3MDEV_H_
#define _NET_L3MDEV_H_

#include <net/dst.h>
#include <net/fib_rules.h>

/**
 * struct l3mdev_ops - l3mdev operations
 *
 * @l3mdev_fib_table: Get FIB table id to use for lookups
 *
 * @l3mdev_l3_rcv:    Hook in L3 receive path
 *
 * @l3mdev_l3_out:    Hook in L3 output path
 *
 * @l3mdev_link_scope_lookup: IPv6 lookup for linklocal and mcast destinations
 */

struct l3mdev_ops {
	u32		(*l3mdev_fib_table)(const struct net_device *dev);
	struct sk_buff * (*l3mdev_l3_rcv)(struct net_device *dev,
					  struct sk_buff *skb, u16 proto);
	struct sk_buff * (*l3mdev_l3_out)(struct net_device *dev,
					  struct sock *sk, struct sk_buff *skb,
					  u16 proto);

	/* IPv6 ops */
	struct dst_entry * (*l3mdev_link_scope_lookup)(const struct net_device *dev,
						 struct flowi6 *fl6);
};

#ifdef CONFIG_NET_L3_MASTER_DEV

int l3mdev_fib_rule_match(struct net *net, struct flowi *fl,
			  struct fib_lookup_arg *arg);

void l3mdev_update_flow(struct net *net, struct flowi *fl);

int l3mdev_master_ifindex_rcu(const struct net_device *dev);
static inline int l3mdev_master_ifindex(struct net_device *dev)
{
	int ifindex;

	rcu_read_lock();
	ifindex = l3mdev_master_ifindex_rcu(dev);
	rcu_read_unlock();

	return ifindex;
}

static inline int l3mdev_master_ifindex_by_index(struct net *net, int ifindex)
{
	struct net_device *dev;
	int rc = 0;

	if (likely(ifindex)) {
		rcu_read_lock();

		dev = dev_get_by_index_rcu(net, ifindex);
		if (dev)
			rc = l3mdev_master_ifindex_rcu(dev);

		rcu_read_unlock();
	}

	return rc;
}

static inline
struct net_device *l3mdev_master_dev_rcu(const struct net_device *_dev)
{
	/* netdev_master_upper_dev_get_rcu calls
	 * list_first_or_null_rcu to walk the upper dev list.
	 * list_first_or_null_rcu does not handle a const arg. We aren't
	 * making changes, just want the master device from that list so
	 * typecast to remove the const
	 */
	struct net_device *dev = (struct net_device *)_dev;
	struct net_device *master;

	if (!dev)
		return NULL;

	if (netif_is_l3_master(dev))
		master = dev;
	else if (netif_is_l3_slave(dev))
		master = netdev_master_upper_dev_get_rcu(dev);
	else
		master = NULL;

	return master;
}

int l3mdev_master_upper_ifindex_by_index_rcu(struct net *net, int ifindex);
static inline
int l3mdev_master_upper_ifindex_by_index(struct net *net, int ifindex)
{
	rcu_read_lock();
	ifindex = l3mdev_master_upper_ifindex_by_index_rcu(net, ifindex);
	rcu_read_unlock();

	return ifindex;
}

u32 l3mdev_fib_table_rcu(const struct net_device *dev);
u32 l3mdev_fib_table_by_index(struct net *net, int ifindex);
static inline u32 l3mdev_fib_table(const struct net_device *dev)
{
	u32 tb_id;

	rcu_read_lock();
	tb_id = l3mdev_fib_table_rcu(dev);
	rcu_read_unlock();

	return tb_id;
}

static inline bool netif_index_is_l3_master(struct net *net, int ifindex)
{
	struct net_device *dev;
	bool rc = false;

	if (ifindex == 0)
		return false;

	rcu_read_lock();

	dev = dev_get_by_index_rcu(net, ifindex);
	if (dev)
		rc = netif_is_l3_master(dev);

	rcu_read_unlock();

	return rc;
}

struct dst_entry *l3mdev_link_scope_lookup(struct net *net, struct flowi6 *fl6);

static inline
struct sk_buff *l3mdev_l3_rcv(struct sk_buff *skb, u16 proto)
{
	struct net_device *master = NULL;

	if (netif_is_l3_slave(skb->dev))
		master = netdev_master_upper_dev_get_rcu(skb->dev);
	else if (netif_is_l3_master(skb->dev) ||
		 netif_has_l3_rx_handler(skb->dev))
		master = skb->dev;

	if (master && master->l3mdev_ops->l3mdev_l3_rcv)
		skb = master->l3mdev_ops->l3mdev_l3_rcv(master, skb, proto);

	return skb;
}

static inline
struct sk_buff *l3mdev_ip_rcv(struct sk_buff *skb)
{
	return l3mdev_l3_rcv(skb, AF_INET);
}

static inline
struct sk_buff *l3mdev_ip6_rcv(struct sk_buff *skb)
{
	return l3mdev_l3_rcv(skb, AF_INET6);
}

static inline
struct sk_buff *l3mdev_l3_out(struct sock *sk, struct sk_buff *skb, u16 proto)
{
	struct net_device *dev = skb_dst(skb)->dev;

	if (netif_is_l3_slave(dev)) {
		struct net_device *master;

		master = netdev_master_upper_dev_get_rcu(dev);
		if (master && master->l3mdev_ops->l3mdev_l3_out)
			skb = master->l3mdev_ops->l3mdev_l3_out(master, sk,
								skb, proto);
	}

	return skb;
}

static inline
struct sk_buff *l3mdev_ip_out(struct sock *sk, struct sk_buff *skb)
{
	return l3mdev_l3_out(sk, skb, AF_INET);
}

static inline
struct sk_buff *l3mdev_ip6_out(struct sock *sk, struct sk_buff *skb)
{
	return l3mdev_l3_out(sk, skb, AF_INET6);
}
#else

static inline int l3mdev_master_ifindex_rcu(const struct net_device *dev)
{
	return 0;
}
static inline int l3mdev_master_ifindex(struct net_device *dev)
{
	return 0;
}

static inline int l3mdev_master_ifindex_by_index(struct net *net, int ifindex)
{
	return 0;
}

static inline
int l3mdev_master_upper_ifindex_by_index_rcu(struct net *net, int ifindex)
{
	return 0;
}
static inline
int l3mdev_master_upper_ifindex_by_index(struct net *net, int ifindex)
{
	return 0;
}

static inline
struct net_device *l3mdev_master_dev_rcu(const struct net_device *dev)
{
	return NULL;
}

static inline u32 l3mdev_fib_table_rcu(const struct net_device *dev)
{
	return 0;
}
static inline u32 l3mdev_fib_table(const struct net_device *dev)
{
	return 0;
}
static inline u32 l3mdev_fib_table_by_index(struct net *net, int ifindex)
{
	return 0;
}

static inline bool netif_index_is_l3_master(struct net *net, int ifindex)
{
	return false;
}

static inline
struct dst_entry *l3mdev_link_scope_lookup(struct net *net, struct flowi6 *fl6)
{
	return NULL;
}

static inline
struct sk_buff *l3mdev_ip_rcv(struct sk_buff *skb)
{
	return skb;
}

static inline
struct sk_buff *l3mdev_ip6_rcv(struct sk_buff *skb)
{
	return skb;
}

static inline
struct sk_buff *l3mdev_ip_out(struct sock *sk, struct sk_buff *skb)
{
	return skb;
}

static inline
struct sk_buff *l3mdev_ip6_out(struct sock *sk, struct sk_buff *skb)
{
	return skb;
}

static inline
int l3mdev_fib_rule_match(struct net *net, struct flowi *fl,
			  struct fib_lookup_arg *arg)
{
	return 1;
}
static inline
void l3mdev_update_flow(struct net *net, struct flowi *fl)
{
}
#endif

#endif /* _NET_L3MDEV_H_ */
Commit	Line	Data
2874c5fd	1	/* SPDX-License-Identifier: GPL-2.0-or-later */
1b69c6d0 DA	2	/*
	3	* include/net/l3mdev.h - L3 master device API
	4	* Copyright (c) 2015 Cumulus Networks
	5	* Copyright (c) 2015 David Ahern <dsa@cumulusnetworks.com>
1b69c6d0 DA	6	*/
	7	#ifndef _NET_L3MDEV_H_
	8	#define _NET_L3MDEV_H_
	9
a8e3e1a9	10	#include <net/dst.h>
96c63fa7 DA	11	#include <net/fib_rules.h>
96c63fa7 DA	12
1b69c6d0 DA	13	/**
	14	* struct l3mdev_ops - l3mdev operations
	15	*
	16	* @l3mdev_fib_table: Get FIB table id to use for lookups
	17	*
a8e3e1a9 DA	18	* @l3mdev_l3_rcv: Hook in L3 receive path
	19	*
	20	* @l3mdev_l3_out: Hook in L3 output path
	21	*
4c1feac5	22	* @l3mdev_link_scope_lookup: IPv6 lookup for linklocal and mcast destinations
1b69c6d0 DA	23	*/
	24
	25	struct l3mdev_ops {
	26	u32 (l3mdev_fib_table)(const struct net_device dev);
74b20582 DA	27	struct sk_buff * (l3mdev_l3_rcv)(struct net_device dev,
74b20582 DA	28	struct sk_buff *skb, u16 proto);
a8e3e1a9 DA	29	struct sk_buff * (l3mdev_l3_out)(struct net_device dev,
	30	struct sock sk, struct sk_buff skb,
	31	u16 proto);
ccf3c8c3	32
ccf3c8c3	33	/* IPv6 ops */
4c1feac5	34	struct dst_entry * (l3mdev_link_scope_lookup)(const struct net_device dev,
cd2a9e62	35	struct flowi6 *fl6);
1b69c6d0 DA	36	};
	37
	38	#ifdef CONFIG_NET_L3_MASTER_DEV
	39
96c63fa7 DA	40	int l3mdev_fib_rule_match(struct net net, struct flowi fl,
	41	struct fib_lookup_arg *arg);
	42
9ee0034b DA	43	void l3mdev_update_flow(struct net net, struct flowi fl);
9ee0034b DA	44
3f2fb9a8	45	int l3mdev_master_ifindex_rcu(const struct net_device *dev);
1b69c6d0 DA	46	static inline int l3mdev_master_ifindex(struct net_device *dev)
	47	{
	48	int ifindex;
	49
	50	rcu_read_lock();
	51	ifindex = l3mdev_master_ifindex_rcu(dev);
	52	rcu_read_unlock();
	53
	54	return ifindex;
	55	}
	56
1a852479 DA	57	static inline int l3mdev_master_ifindex_by_index(struct net *net, int ifindex)
	58	{
	59	struct net_device *dev;
	60	int rc = 0;
	61
	62	if (likely(ifindex)) {
	63	rcu_read_lock();
	64
	65	dev = dev_get_by_index_rcu(net, ifindex);
	66	if (dev)
	67	rc = l3mdev_master_ifindex_rcu(dev);
	68
	69	rcu_read_unlock();
	70	}
	71
	72	return rc;
	73	}
	74
afbac601	75	static inline
5f02ce24	76	struct net_device l3mdev_master_dev_rcu(const struct net_device _dev)
afbac601 DA	77	{
	78	/* netdev_master_upper_dev_get_rcu calls
	79	* list_first_or_null_rcu to walk the upper dev list.
	80	* list_first_or_null_rcu does not handle a const arg. We aren't
	81	* making changes, just want the master device from that list so
	82	* typecast to remove the const
	83	*/
	84	struct net_device dev = (struct net_device )_dev;
5f02ce24	85	struct net_device *master;
afbac601 DA	86
	87	if (!dev)
	88	return NULL;
	89
	90	if (netif_is_l3_master(dev))
	91	master = dev;
	92	else if (netif_is_l3_slave(dev))
	93	master = netdev_master_upper_dev_get_rcu(dev);
	94	else
	95	master = NULL;
	96
	97	return master;
	98	}
	99
6a6d6681 AB	100	int l3mdev_master_upper_ifindex_by_index_rcu(struct net *net, int ifindex);
	101	static inline
	102	int l3mdev_master_upper_ifindex_by_index(struct net *net, int ifindex)
	103	{
	104	rcu_read_lock();
	105	ifindex = l3mdev_master_upper_ifindex_by_index_rcu(net, ifindex);
	106	rcu_read_unlock();
	107
	108	return ifindex;
	109	}
	110
1b69c6d0 DA	111	u32 l3mdev_fib_table_rcu(const struct net_device *dev);
	112	u32 l3mdev_fib_table_by_index(struct net *net, int ifindex);
	113	static inline u32 l3mdev_fib_table(const struct net_device *dev)
	114	{
	115	u32 tb_id;
	116
	117	rcu_read_lock();
	118	tb_id = l3mdev_fib_table_rcu(dev);
	119	rcu_read_unlock();
	120
	121	return tb_id;
	122	}
	123
6104e112 DA	124	static inline bool netif_index_is_l3_master(struct net *net, int ifindex)
	125	{
	126	struct net_device *dev;
	127	bool rc = false;
	128
	129	if (ifindex == 0)
	130	return false;
	131
	132	rcu_read_lock();
	133
	134	dev = dev_get_by_index_rcu(net, ifindex);
	135	if (dev)
	136	rc = netif_is_l3_master(dev);
	137
	138	rcu_read_unlock();
	139
	140	return rc;
	141	}
	142
4c1feac5	143	struct dst_entry l3mdev_link_scope_lookup(struct net net, struct flowi6 *fl6);
ccf3c8c3	144
74b20582 DA	145	static inline
	146	struct sk_buff l3mdev_l3_rcv(struct sk_buff skb, u16 proto)
	147	{
	148	struct net_device *master = NULL;
	149
	150	if (netif_is_l3_slave(skb->dev))
	151	master = netdev_master_upper_dev_get_rcu(skb->dev);
d5256083 DB	152	else if (netif_is_l3_master(skb->dev) \|\|
d5256083 DB	153	netif_has_l3_rx_handler(skb->dev))
74b20582 DA	154	master = skb->dev;
	155
	156	if (master && master->l3mdev_ops->l3mdev_l3_rcv)
	157	skb = master->l3mdev_ops->l3mdev_l3_rcv(master, skb, proto);
	158
	159	return skb;
	160	}
	161
	162	static inline
	163	struct sk_buff l3mdev_ip_rcv(struct sk_buff skb)
	164	{
	165	return l3mdev_l3_rcv(skb, AF_INET);
	166	}
	167
	168	static inline
	169	struct sk_buff l3mdev_ip6_rcv(struct sk_buff skb)
	170	{
	171	return l3mdev_l3_rcv(skb, AF_INET6);
	172	}
	173
a8e3e1a9 DA	174	static inline
	175	struct sk_buff l3mdev_l3_out(struct sock sk, struct sk_buff *skb, u16 proto)
	176	{
	177	struct net_device *dev = skb_dst(skb)->dev;
	178
	179	if (netif_is_l3_slave(dev)) {
	180	struct net_device *master;
	181
	182	master = netdev_master_upper_dev_get_rcu(dev);
	183	if (master && master->l3mdev_ops->l3mdev_l3_out)
	184	skb = master->l3mdev_ops->l3mdev_l3_out(master, sk,
	185	skb, proto);
	186	}
	187
	188	return skb;
	189	}
	190
	191	static inline
	192	struct sk_buff l3mdev_ip_out(struct sock sk, struct sk_buff *skb)
	193	{
	194	return l3mdev_l3_out(sk, skb, AF_INET);
	195	}
	196
	197	static inline
	198	struct sk_buff l3mdev_ip6_out(struct sock sk, struct sk_buff *skb)
	199	{
	200	return l3mdev_l3_out(sk, skb, AF_INET6);
	201	}
1b69c6d0 DA	202	#else
1b69c6d0 DA	203
3f2fb9a8	204	static inline int l3mdev_master_ifindex_rcu(const struct net_device *dev)
1b69c6d0 DA	205	{
	206	return 0;
	207	}
	208	static inline int l3mdev_master_ifindex(struct net_device *dev)
	209	{
	210	return 0;
	211	}
	212
1a852479 DA	213	static inline int l3mdev_master_ifindex_by_index(struct net *net, int ifindex)
	214	{
	215	return 0;
	216	}
	217
6a6d6681 AB	218	static inline
	219	int l3mdev_master_upper_ifindex_by_index_rcu(struct net *net, int ifindex)
	220	{
	221	return 0;
	222	}
	223	static inline
	224	int l3mdev_master_upper_ifindex_by_index(struct net *net, int ifindex)
	225	{
	226	return 0;
	227	}
	228
afbac601	229	static inline
5f02ce24	230	struct net_device l3mdev_master_dev_rcu(const struct net_device dev)
afbac601 DA	231	{
	232	return NULL;
	233	}
	234
1b69c6d0 DA	235	static inline u32 l3mdev_fib_table_rcu(const struct net_device *dev)
	236	{
	237	return 0;
	238	}
	239	static inline u32 l3mdev_fib_table(const struct net_device *dev)
	240	{
	241	return 0;
	242	}
	243	static inline u32 l3mdev_fib_table_by_index(struct net *net, int ifindex)
	244	{
	245	return 0;
	246	}
	247
6104e112 DA	248	static inline bool netif_index_is_l3_master(struct net *net, int ifindex)
	249	{
	250	return false;
	251	}
	252
ccf3c8c3	253	static inline
4c1feac5	254	struct dst_entry l3mdev_link_scope_lookup(struct net net, struct flowi6 *fl6)
ccf3c8c3 DA	255	{
	256	return NULL;
	257	}
74b20582 DA	258
	259	static inline
	260	struct sk_buff l3mdev_ip_rcv(struct sk_buff skb)
	261	{
	262	return skb;
	263	}
	264
	265	static inline
	266	struct sk_buff l3mdev_ip6_rcv(struct sk_buff skb)
	267	{
	268	return skb;
	269	}
96c63fa7	270
a8e3e1a9 DA	271	static inline
	272	struct sk_buff l3mdev_ip_out(struct sock sk, struct sk_buff *skb)
	273	{
	274	return skb;
	275	}
	276
	277	static inline
	278	struct sk_buff l3mdev_ip6_out(struct sock sk, struct sk_buff *skb)
	279	{
	280	return skb;
	281	}
	282
96c63fa7 DA	283	static inline
	284	int l3mdev_fib_rule_match(struct net net, struct flowi fl,
	285	struct fib_lookup_arg *arg)
	286	{
	287	return 1;
	288	}
9ee0034b DA	289	static inline
	290	void l3mdev_update_flow(struct net net, struct flowi fl)
	291	{
	292	}
1b69c6d0 DA	293	#endif
	294
	295	#endif /* _NET_L3MDEV_H_ */