[mirror_ubuntu-bionic-kernel.git] / include / net / ip6_route.h

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

struct route_info {
	__u8			type;
	__u8			length;
	__u8			prefix_len;
#if defined(__BIG_ENDIAN_BITFIELD)
	__u8			reserved_h:3,
				route_pref:2,
				reserved_l:3;
#elif defined(__LITTLE_ENDIAN_BITFIELD)
	__u8			reserved_l:3,
				route_pref:2,
				reserved_h:3;
#endif
	__be32			lifetime;
	__u8			prefix[0];	/* 0,8 or 16 */
};

#include <net/addrconf.h>
#include <net/flow.h>
#include <net/ip6_fib.h>
#include <net/sock.h>
#include <net/lwtunnel.h>
#include <linux/ip.h>
#include <linux/ipv6.h>
#include <linux/route.h>

#define RT6_LOOKUP_F_IFACE		0x00000001
#define RT6_LOOKUP_F_REACHABLE		0x00000002
#define RT6_LOOKUP_F_HAS_SADDR		0x00000004
#define RT6_LOOKUP_F_SRCPREF_TMP	0x00000008
#define RT6_LOOKUP_F_SRCPREF_PUBLIC	0x00000010
#define RT6_LOOKUP_F_SRCPREF_COA	0x00000020
#define RT6_LOOKUP_F_IGNORE_LINKSTATE	0x00000040

/* We do not (yet ?) support IPv6 jumbograms (RFC 2675)
 * Unlike IPv4, hdr->seg_len doesn't include the IPv6 header
 */
#define IP6_MAX_MTU (0xFFFF + sizeof(struct ipv6hdr))

/*
 * rt6_srcprefs2flags() and rt6_flags2srcprefs() translate
 * between IPV6_ADDR_PREFERENCES socket option values
 *	IPV6_PREFER_SRC_TMP    = 0x1
 *	IPV6_PREFER_SRC_PUBLIC = 0x2
 *	IPV6_PREFER_SRC_COA    = 0x4
 * and above RT6_LOOKUP_F_SRCPREF_xxx flags.
 */
static inline int rt6_srcprefs2flags(unsigned int srcprefs)
{
	/* No need to bitmask because srcprefs have only 3 bits. */
	return srcprefs << 3;
}

static inline unsigned int rt6_flags2srcprefs(int flags)
{
	return (flags >> 3) & 7;
}

static inline bool rt6_need_strict(const struct in6_addr *daddr)
{
	return ipv6_addr_type(daddr) &
		(IPV6_ADDR_MULTICAST | IPV6_ADDR_LINKLOCAL | IPV6_ADDR_LOOPBACK);
}

void ip6_route_input(struct sk_buff *skb);
struct dst_entry *ip6_route_input_lookup(struct net *net,
					 struct net_device *dev,
					 struct flowi6 *fl6, int flags);

struct dst_entry *ip6_route_output_flags(struct net *net, const struct sock *sk,
					 struct flowi6 *fl6, int flags);

static inline struct dst_entry *ip6_route_output(struct net *net,
						 const struct sock *sk,
						 struct flowi6 *fl6)
{
	return ip6_route_output_flags(net, sk, fl6, 0);
}

struct dst_entry *ip6_route_lookup(struct net *net, struct flowi6 *fl6,
				   int flags);
struct rt6_info *ip6_pol_route(struct net *net, struct fib6_table *table,
			       int ifindex, struct flowi6 *fl6, int flags);

void ip6_route_init_special_entries(void);
int ip6_route_init(void);
void ip6_route_cleanup(void);

int ipv6_route_ioctl(struct net *net, unsigned int cmd, void __user *arg);

int ip6_route_add(struct fib6_config *cfg, struct netlink_ext_ack *extack);
int ip6_ins_rt(struct rt6_info *);
int ip6_del_rt(struct rt6_info *);

void rt6_flush_exceptions(struct rt6_info *rt);
int rt6_remove_exception_rt(struct rt6_info *rt);
void rt6_age_exceptions(struct rt6_info *rt, struct fib6_gc_args *gc_args,
			unsigned long now);

static inline int ip6_route_get_saddr(struct net *net, struct rt6_info *rt,
				      const struct in6_addr *daddr,
				      unsigned int prefs,
				      struct in6_addr *saddr)
{
	struct inet6_dev *idev =
			rt ? ip6_dst_idev((struct dst_entry *)rt) : NULL;
	int err = 0;

	if (rt && rt->rt6i_prefsrc.plen)
		*saddr = rt->rt6i_prefsrc.addr;
	else
		err = ipv6_dev_get_saddr(net, idev ? idev->dev : NULL,
					 daddr, prefs, saddr);

	return err;
}

struct rt6_info *rt6_lookup(struct net *net, const struct in6_addr *daddr,
			    const struct in6_addr *saddr, int oif, int flags);
u32 rt6_multipath_hash(const struct flowi6 *fl6, const struct sk_buff *skb);

struct dst_entry *icmp6_dst_alloc(struct net_device *dev, struct flowi6 *fl6);

void fib6_force_start_gc(struct net *net);

struct rt6_info *addrconf_dst_alloc(struct inet6_dev *idev,
				    const struct in6_addr *addr, bool anycast);

struct rt6_info *ip6_dst_alloc(struct net *net, struct net_device *dev,
			       int flags);

/*
 *	support functions for ND
 *
 */
struct rt6_info *rt6_get_dflt_router(const struct in6_addr *addr,
				     struct net_device *dev);
struct rt6_info *rt6_add_dflt_router(const struct in6_addr *gwaddr,
				     struct net_device *dev, unsigned int pref);

void rt6_purge_dflt_routers(struct net *net);

int rt6_route_rcv(struct net_device *dev, u8 *opt, int len,
		  const struct in6_addr *gwaddr);

void ip6_update_pmtu(struct sk_buff *skb, struct net *net, __be32 mtu, int oif,
		     u32 mark, kuid_t uid);
void ip6_sk_update_pmtu(struct sk_buff *skb, struct sock *sk, __be32 mtu);
void ip6_redirect(struct sk_buff *skb, struct net *net, int oif, u32 mark,
		  kuid_t uid);
void ip6_redirect_no_header(struct sk_buff *skb, struct net *net, int oif,
			    u32 mark);
void ip6_sk_redirect(struct sk_buff *skb, struct sock *sk);

struct netlink_callback;

struct rt6_rtnl_dump_arg {
	struct sk_buff *skb;
	struct netlink_callback *cb;
	struct net *net;
};

int rt6_dump_route(struct rt6_info *rt, void *p_arg);
void rt6_ifdown(struct net *net, struct net_device *dev);
void rt6_mtu_change(struct net_device *dev, unsigned int mtu);
void rt6_remove_prefsrc(struct inet6_ifaddr *ifp);
void rt6_clean_tohost(struct net *net, struct in6_addr *gateway);

void rt6_uncached_list_add(struct rt6_info *rt);
void rt6_uncached_list_del(struct rt6_info *rt);

static inline const struct rt6_info *skb_rt6_info(const struct sk_buff *skb)
{
	const struct dst_entry *dst = skb_dst(skb);
	const struct rt6_info *rt6 = NULL;

	if (dst)
		rt6 = container_of(dst, struct rt6_info, dst);

	return rt6;
}

/*
 *	Store a destination cache entry in a socket
 */
static inline void ip6_dst_store(struct sock *sk, struct dst_entry *dst,
				 const struct in6_addr *daddr,
				 const struct in6_addr *saddr)
{
	struct ipv6_pinfo *np = inet6_sk(sk);

	np->dst_cookie = rt6_get_cookie((struct rt6_info *)dst);
	sk_setup_caps(sk, dst);
	np->daddr_cache = daddr;
#ifdef CONFIG_IPV6_SUBTREES
	np->saddr_cache = saddr;
#endif
}

static inline bool ipv6_unicast_destination(const struct sk_buff *skb)
{
	struct rt6_info *rt = (struct rt6_info *) skb_dst(skb);

	return rt->rt6i_flags & RTF_LOCAL;
}

static inline bool ipv6_anycast_destination(const struct dst_entry *dst,
					    const struct in6_addr *daddr)
{
	struct rt6_info *rt = (struct rt6_info *)dst;

	return rt->rt6i_flags & RTF_ANYCAST ||
		(rt->rt6i_dst.plen < 127 &&
		 ipv6_addr_equal(&rt->rt6i_dst.addr, daddr));
}

int ip6_fragment(struct net *net, struct sock *sk, struct sk_buff *skb,
		 int (*output)(struct net *, struct sock *, struct sk_buff *));

static inline int ip6_skb_dst_mtu(struct sk_buff *skb)
{
	struct ipv6_pinfo *np = skb->sk && !dev_recursion_level() ?
				inet6_sk(skb->sk) : NULL;

	return (np && np->pmtudisc >= IPV6_PMTUDISC_PROBE) ?
	       skb_dst(skb)->dev->mtu : dst_mtu(skb_dst(skb));
}

static inline bool ip6_sk_accept_pmtu(const struct sock *sk)
{
	return inet6_sk(sk)->pmtudisc != IPV6_PMTUDISC_INTERFACE &&
	       inet6_sk(sk)->pmtudisc != IPV6_PMTUDISC_OMIT;
}

static inline bool ip6_sk_ignore_df(const struct sock *sk)
{
	return inet6_sk(sk)->pmtudisc < IPV6_PMTUDISC_DO ||
	       inet6_sk(sk)->pmtudisc == IPV6_PMTUDISC_OMIT;
}

static inline const struct in6_addr *rt6_nexthop(const struct rt6_info *rt,
						 const struct in6_addr *daddr)
{
	if (rt->rt6i_flags & RTF_GATEWAY)
		return &rt->rt6i_gateway;
	else if (unlikely(rt->rt6i_flags & RTF_CACHE))
		return &rt->rt6i_dst.addr;
	else
		return daddr;
}

static inline bool rt6_duplicate_nexthop(struct rt6_info *a, struct rt6_info *b)
{
	return a->dst.dev == b->dst.dev &&
	       a->rt6i_idev == b->rt6i_idev &&
	       ipv6_addr_equal(&a->rt6i_gateway, &b->rt6i_gateway) &&
	       !lwtunnel_cmp_encap(a->dst.lwtstate, b->dst.lwtstate);
}
#endif
Commit	Line	Data
b2441318	1	/* SPDX-License-Identifier: GPL-2.0 */
1da177e4 LT	2	#ifndef _NET_IP6_ROUTE_H
	3	#define _NET_IP6_ROUTE_H
	4
70ceb4f5 YH	5	struct route_info {
	6	__u8 type;
	7	__u8 length;
	8	__u8 prefix_len;
	9	#if defined(__BIG_ENDIAN_BITFIELD)
	10	__u8 reserved_h:3,
	11	route_pref:2,
	12	reserved_l:3;
	13	#elif defined(__LITTLE_ENDIAN_BITFIELD)
	14	__u8 reserved_l:3,
	15	route_pref:2,
	16	reserved_h:3;
	17	#endif
e69a4adc	18	__be32 lifetime;
70ceb4f5 YH	19	__u8 prefix[0]; /* 0,8 or 16 */
	20	};
	21
a2e2ff56	22	#include <net/addrconf.h>
1da177e4 LT	23	#include <net/flow.h>
	24	#include <net/ip6_fib.h>
	25	#include <net/sock.h>
f06b7549	26	#include <net/lwtunnel.h>
1da177e4 LT	27	#include <linux/ip.h>
1da177e4 LT	28	#include <linux/ipv6.h>
9bb5a148	29	#include <linux/route.h>
1da177e4	30
7cbca67c YH	31	#define RT6_LOOKUP_F_IFACE 0x00000001
	32	#define RT6_LOOKUP_F_REACHABLE 0x00000002
	33	#define RT6_LOOKUP_F_HAS_SADDR 0x00000004
	34	#define RT6_LOOKUP_F_SRCPREF_TMP 0x00000008
	35	#define RT6_LOOKUP_F_SRCPREF_PUBLIC 0x00000010
	36	#define RT6_LOOKUP_F_SRCPREF_COA 0x00000020
d5d32e4b	37	#define RT6_LOOKUP_F_IGNORE_LINKSTATE 0x00000040
77d16f45	38
30f78d8e ED	39	/* We do not (yet ?) support IPv6 jumbograms (RFC 2675)
	40	* Unlike IPv4, hdr->seg_len doesn't include the IPv6 header
	41	*/
	42	#define IP6_MAX_MTU (0xFFFF + sizeof(struct ipv6hdr))
	43
0c9a2ac1 YH	44	/*
	45	* rt6_srcprefs2flags() and rt6_flags2srcprefs() translate
	46	* between IPV6_ADDR_PREFERENCES socket option values
	47	* IPV6_PREFER_SRC_TMP = 0x1
	48	* IPV6_PREFER_SRC_PUBLIC = 0x2
	49	* IPV6_PREFER_SRC_COA = 0x4
	50	* and above RT6_LOOKUP_F_SRCPREF_xxx flags.
	51	*/
	52	static inline int rt6_srcprefs2flags(unsigned int srcprefs)
	53	{
	54	/* No need to bitmask because srcprefs have only 3 bits. */
	55	return srcprefs << 3;
	56	}
	57
	58	static inline unsigned int rt6_flags2srcprefs(int flags)
	59	{
	60	return (flags >> 3) & 7;
	61	}
1da177e4	62
60ea37f7 WY	63	static inline bool rt6_need_strict(const struct in6_addr *daddr)
	64	{
	65	return ipv6_addr_type(daddr) &
	66	(IPV6_ADDR_MULTICAST \| IPV6_ADDR_LINKLOCAL \| IPV6_ADDR_LOOPBACK);
	67	}
fbfe95a4	68
5c3a0fd7	69	void ip6_route_input(struct sk_buff *skb);
d409b847 MB	70	struct dst_entry ip6_route_input_lookup(struct net net,
	71	struct net_device *dev,
	72	struct flowi6 *fl6, int flags);
1da177e4	73
6f21c96a PA	74	struct dst_entry ip6_route_output_flags(struct net net, const struct sock *sk,
	75	struct flowi6 *fl6, int flags);
	76
	77	static inline struct dst_entry ip6_route_output(struct net net,
	78	const struct sock *sk,
	79	struct flowi6 *fl6)
	80	{
	81	return ip6_route_output_flags(net, sk, fl6, 0);
	82	}
	83
5c3a0fd7 JP	84	struct dst_entry ip6_route_lookup(struct net net, struct flowi6 *fl6,
5c3a0fd7 JP	85	int flags);
9ff74384 DA	86	struct rt6_info ip6_pol_route(struct net net, struct fib6_table *table,
9ff74384 DA	87	int ifindex, struct flowi6 *fl6, int flags);
1da177e4	88
2f460933	89	void ip6_route_init_special_entries(void);
5c3a0fd7 JP	90	int ip6_route_init(void);
5c3a0fd7 JP	91	void ip6_route_cleanup(void);
1da177e4	92
5c3a0fd7	93	int ipv6_route_ioctl(struct net net, unsigned int cmd, void __user arg);
1da177e4	94
333c4301	95	int ip6_route_add(struct fib6_config cfg, struct netlink_ext_ack extack);
5c3a0fd7 JP	96	int ip6_ins_rt(struct rt6_info *);
5c3a0fd7 JP	97	int ip6_del_rt(struct rt6_info *);
1da177e4	98
35732d01 WW	99	void rt6_flush_exceptions(struct rt6_info *rt);
35732d01 WW	100	int rt6_remove_exception_rt(struct rt6_info *rt);
c757faa8 WW	101	void rt6_age_exceptions(struct rt6_info rt, struct fib6_gc_args gc_args,
c757faa8 WW	102	unsigned long now);
35732d01	103
a2e2ff56 DA	104	static inline int ip6_route_get_saddr(struct net net, struct rt6_info rt,
	105	const struct in6_addr *daddr,
	106	unsigned int prefs,
	107	struct in6_addr *saddr)
	108	{
	109	struct inet6_dev *idev =
	110	rt ? ip6_dst_idev((struct dst_entry *)rt) : NULL;
	111	int err = 0;
	112
	113	if (rt && rt->rt6i_prefsrc.plen)
	114	*saddr = rt->rt6i_prefsrc.addr;
	115	else
	116	err = ipv6_dev_get_saddr(net, idev ? idev->dev : NULL,
	117	daddr, prefs, saddr);
	118
	119	return err;
	120	}
c3968a85	121
5c3a0fd7 JP	122	struct rt6_info rt6_lookup(struct net net, const struct in6_addr *daddr,
5c3a0fd7 JP	123	const struct in6_addr *saddr, int oif, int flags);
23aebdac	124	u32 rt6_multipath_hash(const struct flowi6 fl6, const struct sk_buff skb);
1da177e4	125
5c3a0fd7	126	struct dst_entry icmp6_dst_alloc(struct net_device dev, struct flowi6 *fl6);
3b00944c	127
5c3a0fd7	128	void fib6_force_start_gc(struct net *net);
1da177e4	129
5c3a0fd7 JP	130	struct rt6_info addrconf_dst_alloc(struct inet6_dev idev,
5c3a0fd7 JP	131	const struct in6_addr *addr, bool anycast);
1da177e4	132
9ab179d8 DA	133	struct rt6_info ip6_dst_alloc(struct net net, struct net_device *dev,
	134	int flags);
	135
1da177e4 LT	136	/*
	137	* support functions for ND
	138	*
	139	*/
5c3a0fd7 JP	140	struct rt6_info rt6_get_dflt_router(const struct in6_addr addr,
	141	struct net_device *dev);
	142	struct rt6_info rt6_add_dflt_router(const struct in6_addr gwaddr,
	143	struct net_device *dev, unsigned int pref);
	144
	145	void rt6_purge_dflt_routers(struct net *net);
	146
	147	int rt6_route_rcv(struct net_device dev, u8 opt, int len,
	148	const struct in6_addr *gwaddr);
	149
	150	void ip6_update_pmtu(struct sk_buff skb, struct net net, __be32 mtu, int oif,
e2d118a1	151	u32 mark, kuid_t uid);
5c3a0fd7	152	void ip6_sk_update_pmtu(struct sk_buff skb, struct sock sk, __be32 mtu);
e2d118a1 LC	153	void ip6_redirect(struct sk_buff skb, struct net net, int oif, u32 mark,
e2d118a1 LC	154	kuid_t uid);
5c3a0fd7 JP	155	void ip6_redirect_no_header(struct sk_buff skb, struct net net, int oif,
	156	u32 mark);
	157	void ip6_sk_redirect(struct sk_buff skb, struct sock sk);
1da177e4	158
1da177e4	159	struct netlink_callback;
1da177e4	160
fd2c3ef7	161	struct rt6_rtnl_dump_arg {
1b43af54 PM	162	struct sk_buff *skb;
1b43af54 PM	163	struct netlink_callback *cb;
191cd582	164	struct net *net;
1b43af54 PM	165	};
1b43af54 PM	166
5c3a0fd7 JP	167	int rt6_dump_route(struct rt6_info rt, void p_arg);
	168	void rt6_ifdown(struct net net, struct net_device dev);
	169	void rt6_mtu_change(struct net_device *dev, unsigned int mtu);
	170	void rt6_remove_prefsrc(struct inet6_ifaddr *ifp);
be7a010d	171	void rt6_clean_tohost(struct net net, struct in6_addr gateway);
1da177e4	172
31a5b09d XL	173	void rt6_uncached_list_add(struct rt6_info *rt);
	174	void rt6_uncached_list_del(struct rt6_info *rt);
	175
1b70d792 DA	176	static inline const struct rt6_info skb_rt6_info(const struct sk_buff skb)
	177	{
	178	const struct dst_entry *dst = skb_dst(skb);
	179	const struct rt6_info *rt6 = NULL;
	180
	181	if (dst)
	182	rt6 = container_of(dst, struct rt6_info, dst);
	183
	184	return rt6;
	185	}
1da177e4 LT	186
	187	/*
	188	* Store a destination cache entry in a socket
	189	*/
6bd4f355 ED	190	static inline void ip6_dst_store(struct sock sk, struct dst_entry dst,
	191	const struct in6_addr *daddr,
	192	const struct in6_addr *saddr)
1da177e4 LT	193	{
1da177e4 LT	194	struct ipv6_pinfo *np = inet6_sk(sk);
1da177e4	195
6bd4f355	196	np->dst_cookie = rt6_get_cookie((struct rt6_info *)dst);
f83ef8c0	197	sk_setup_caps(sk, dst);
1da177e4	198	np->daddr_cache = daddr;
8e1ef0a9 YH	199	#ifdef CONFIG_IPV6_SUBTREES
	200	np->saddr_cache = saddr;
	201	#endif
1da177e4 LT	202	}
1da177e4 LT	203
a50feda5	204	static inline bool ipv6_unicast_destination(const struct sk_buff *skb)
1da177e4	205	{
adf30907	206	struct rt6_info rt = (struct rt6_info ) skb_dst(skb);
1da177e4 LT	207
	208	return rt->rt6i_flags & RTF_LOCAL;
	209	}
	210
2647a9b0 MKL	211	static inline bool ipv6_anycast_destination(const struct dst_entry *dst,
2647a9b0 MKL	212	const struct in6_addr *daddr)
509aba3b	213	{
2647a9b0	214	struct rt6_info rt = (struct rt6_info )dst;
509aba3b	215
2647a9b0	216	return rt->rt6i_flags & RTF_ANYCAST \|\|
ccdb2d17	217	(rt->rt6i_dst.plen < 127 &&
2647a9b0	218	ipv6_addr_equal(&rt->rt6i_dst.addr, daddr));
509aba3b FLB	219	}
509aba3b FLB	220
7d8c6e39 EB	221	int ip6_fragment(struct net net, struct sock sk, struct sk_buff *skb,
7d8c6e39 EB	222	int (output)(struct net , struct sock , struct sk_buff ));
ad0081e4 DS	223
	224	static inline int ip6_skb_dst_mtu(struct sk_buff *skb)
	225	{
f60e5990	226	struct ipv6_pinfo *np = skb->sk && !dev_recursion_level() ?
f60e5990	227	inet6_sk(skb->sk) : NULL;
ad0081e4	228
93b36cf3	229	return (np && np->pmtudisc >= IPV6_PMTUDISC_PROBE) ?
ad0081e4 DS	230	skb_dst(skb)->dev->mtu : dst_mtu(skb_dst(skb));
	231	}
	232
93b36cf3 HFS	233	static inline bool ip6_sk_accept_pmtu(const struct sock *sk)
93b36cf3 HFS	234	{
0b95227a HFS	235	return inet6_sk(sk)->pmtudisc != IPV6_PMTUDISC_INTERFACE &&
	236	inet6_sk(sk)->pmtudisc != IPV6_PMTUDISC_OMIT;
	237	}
	238
60ff7467	239	static inline bool ip6_sk_ignore_df(const struct sock *sk)
0b95227a HFS	240	{
	241	return inet6_sk(sk)->pmtudisc < IPV6_PMTUDISC_DO \|\|
	242	inet6_sk(sk)->pmtudisc == IPV6_PMTUDISC_OMIT;
93b36cf3 HFS	243	}
93b36cf3 HFS	244
fdfc428e ND	245	static inline const struct in6_addr rt6_nexthop(const struct rt6_info rt,
fdfc428e ND	246	const struct in6_addr *daddr)
9bb5a148	247	{
2647a9b0 MKL	248	if (rt->rt6i_flags & RTF_GATEWAY)
2647a9b0 MKL	249	return &rt->rt6i_gateway;
45e4fd26	250	else if (unlikely(rt->rt6i_flags & RTF_CACHE))
2647a9b0 MKL	251	return &rt->rt6i_dst.addr;
	252	else
	253	return daddr;
9bb5a148 YH	254	}
9bb5a148 YH	255
f06b7549 DA	256	static inline bool rt6_duplicate_nexthop(struct rt6_info a, struct rt6_info b)
	257	{
	258	return a->dst.dev == b->dst.dev &&
	259	a->rt6i_idev == b->rt6i_idev &&
	260	ipv6_addr_equal(&a->rt6i_gateway, &b->rt6i_gateway) &&
	261	!lwtunnel_cmp_encap(a->dst.lwtstate, b->dst.lwtstate);
	262	}
1da177e4	263	#endif