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

/*
 *	Linux INET6 implementation 
 *
 *	Authors:
 *	Pedro Roque		<roque@di.fc.ul.pt>	
 *
 *	This program is free software; you can redistribute it and/or
 *      modify it under the terms of the GNU General Public License
 *      as published by the Free Software Foundation; either version
 *      2 of the License, or (at your option) any later version.
 */

#ifndef _IP6_FIB_H
#define _IP6_FIB_H

#include <linux/ipv6_route.h>
#include <linux/rtnetlink.h>
#include <linux/spinlock.h>
#include <linux/notifier.h>
#include <net/dst.h>
#include <net/flow.h>
#include <net/netlink.h>
#include <net/inetpeer.h>
#include <net/fib_notifier.h>

#ifdef CONFIG_IPV6_MULTIPLE_TABLES
#define FIB6_TABLE_HASHSZ 256
#else
#define FIB6_TABLE_HASHSZ 1
#endif

#define RT6_DEBUG 2

#if RT6_DEBUG >= 3
#define RT6_TRACE(x...) pr_debug(x)
#else
#define RT6_TRACE(x...) do { ; } while (0)
#endif

struct rt6_info;
struct fib6_info;

struct fib6_config {
	u32		fc_table;
	u32		fc_metric;
	int		fc_dst_len;
	int		fc_src_len;
	int		fc_ifindex;
	u32		fc_flags;
	u32		fc_protocol;
	u16		fc_type;        /* only 8 bits are used */
	u16		fc_delete_all_nh : 1,
			__unused : 15;

	struct in6_addr	fc_dst;
	struct in6_addr	fc_src;
	struct in6_addr	fc_prefsrc;
	struct in6_addr	fc_gateway;

	unsigned long	fc_expires;
	struct nlattr	*fc_mx;
	int		fc_mx_len;
	int		fc_mp_len;
	struct nlattr	*fc_mp;

	struct nl_info	fc_nlinfo;
	struct nlattr	*fc_encap;
	u16		fc_encap_type;
};

struct fib6_node {
	struct fib6_node __rcu	*parent;
	struct fib6_node __rcu	*left;
	struct fib6_node __rcu	*right;
#ifdef CONFIG_IPV6_SUBTREES
	struct fib6_node __rcu	*subtree;
#endif
	struct fib6_info __rcu	*leaf;

	__u16			fn_bit;		/* bit key */
	__u16			fn_flags;
	int			fn_sernum;
	struct fib6_info __rcu	*rr_ptr;
	struct rcu_head		rcu;
};

struct fib6_gc_args {
	int			timeout;
	int			more;
};

#ifndef CONFIG_IPV6_SUBTREES
#define FIB6_SUBTREE(fn)	NULL
#else
#define FIB6_SUBTREE(fn)	(rcu_dereference_protected((fn)->subtree, 1))
#endif

/*
 *	routing information
 *
 */

struct rt6key {
	struct in6_addr	addr;
	int		plen;
};

struct fib6_table;

struct rt6_exception_bucket {
	struct hlist_head	chain;
	int			depth;
};

struct rt6_exception {
	struct hlist_node	hlist;
	struct rt6_info		*rt6i;
	unsigned long		stamp;
	struct rcu_head		rcu;
};

#define FIB6_EXCEPTION_BUCKET_SIZE_SHIFT 10
#define FIB6_EXCEPTION_BUCKET_SIZE (1 << FIB6_EXCEPTION_BUCKET_SIZE_SHIFT)
#define FIB6_MAX_DEPTH 5

struct fib6_nh {
	struct in6_addr		nh_gw;
	struct net_device	*nh_dev;
	struct lwtunnel_state	*nh_lwtstate;

	unsigned int		nh_flags;
	atomic_t		nh_upper_bound;
	int			nh_weight;
};

struct fib6_info {
	struct fib6_table		*fib6_table;
	struct fib6_info __rcu		*fib6_next;
	struct fib6_node __rcu		*fib6_node;

	/* Multipath routes:
	 * siblings is a list of fib6_info that have the the same metric/weight,
	 * destination, but not the same gateway. nsiblings is just a cache
	 * to speed up lookup.
	 */
	struct list_head		fib6_siblings;
	unsigned int			fib6_nsiblings;

	atomic_t			fib6_ref;
	unsigned long			expires;
	struct dst_metrics		*fib6_metrics;
#define fib6_pmtu		fib6_metrics->metrics[RTAX_MTU-1]

	struct rt6key			fib6_dst;
	u32				fib6_flags;
	struct rt6key			fib6_src;
	struct rt6key			fib6_prefsrc;

	struct rt6_info * __percpu	*rt6i_pcpu;
	struct rt6_exception_bucket __rcu *rt6i_exception_bucket;

#ifdef CONFIG_IPV6_ROUTER_PREF
	unsigned long			last_probe;
#endif

	u32				fib6_metric;
	u8				fib6_protocol;
	u8				fib6_type;
	u8				exception_bucket_flushed:1,
					should_flush:1,
					dst_nocount:1,
					dst_nopolicy:1,
					dst_host:1,
					unused:3;

	struct fib6_nh			fib6_nh;
	struct rcu_head			rcu;
};

struct rt6_info {
	struct dst_entry		dst;
	struct fib6_info __rcu		*from;

	struct rt6key			rt6i_dst;
	struct rt6key			rt6i_src;
	struct in6_addr			rt6i_gateway;
	struct inet6_dev		*rt6i_idev;
	u32				rt6i_flags;

	struct list_head		rt6i_uncached;
	struct uncached_list		*rt6i_uncached_list;

	/* more non-fragment space at head required */
	unsigned short			rt6i_nfheader_len;
};

#define for_each_fib6_node_rt_rcu(fn)					\
	for (rt = rcu_dereference((fn)->leaf); rt;			\
	     rt = rcu_dereference(rt->fib6_next))

#define for_each_fib6_walker_rt(w)					\
	for (rt = (w)->leaf; rt;					\
	     rt = rcu_dereference_protected(rt->fib6_next, 1))

static inline struct inet6_dev *ip6_dst_idev(struct dst_entry *dst)
{
	return ((struct rt6_info *)dst)->rt6i_idev;
}

static inline void fib6_clean_expires(struct fib6_info *f6i)
{
	f6i->fib6_flags &= ~RTF_EXPIRES;
	f6i->expires = 0;
}

static inline void fib6_set_expires(struct fib6_info *f6i,
				    unsigned long expires)
{
	f6i->expires = expires;
	f6i->fib6_flags |= RTF_EXPIRES;
}

static inline bool fib6_check_expired(const struct fib6_info *f6i)
{
	if (f6i->fib6_flags & RTF_EXPIRES)
		return time_after(jiffies, f6i->expires);
	return false;
}

/* Function to safely get fn->sernum for passed in rt
 * and store result in passed in cookie.
 * Return true if we can get cookie safely
 * Return false if not
 */
static inline bool fib6_get_cookie_safe(const struct fib6_info *f6i,
					u32 *cookie)
{
	struct fib6_node *fn;
	bool status = false;

	fn = rcu_dereference(f6i->fib6_node);

	if (fn) {
		*cookie = fn->fn_sernum;
		/* pairs with smp_wmb() in fib6_update_sernum_upto_root() */
		smp_rmb();
		status = true;
	}

	return status;
}

static inline u32 rt6_get_cookie(const struct rt6_info *rt)
{
	struct fib6_info *from;
	u32 cookie = 0;

	rcu_read_lock();

	from = rcu_dereference(rt->from);
	if (from && (rt->rt6i_flags & RTF_PCPU ||
	    unlikely(!list_empty(&rt->rt6i_uncached))))
		fib6_get_cookie_safe(from, &cookie);

	rcu_read_unlock();

	return cookie;
}

static inline void ip6_rt_put(struct rt6_info *rt)
{
	/* dst_release() accepts a NULL parameter.
	 * We rely on dst being first structure in struct rt6_info
	 */
	BUILD_BUG_ON(offsetof(struct rt6_info, dst) != 0);
	dst_release(&rt->dst);
}

struct fib6_info *fib6_info_alloc(gfp_t gfp_flags);
void fib6_info_destroy_rcu(struct rcu_head *head);

static inline void fib6_info_hold(struct fib6_info *f6i)
{
	atomic_inc(&f6i->fib6_ref);
}

static inline bool fib6_info_hold_safe(struct fib6_info *f6i)
{
	return atomic_inc_not_zero(&f6i->fib6_ref);
}

static inline void fib6_info_release(struct fib6_info *f6i)
{
	if (f6i && atomic_dec_and_test(&f6i->fib6_ref))
		call_rcu(&f6i->rcu, fib6_info_destroy_rcu);
}

enum fib6_walk_state {
#ifdef CONFIG_IPV6_SUBTREES
	FWS_S,
#endif
	FWS_L,
	FWS_R,
	FWS_C,
	FWS_U
};

struct fib6_walker {
	struct list_head lh;
	struct fib6_node *root, *node;
	struct fib6_info *leaf;
	enum fib6_walk_state state;
	unsigned int skip;
	unsigned int count;
	int (*func)(struct fib6_walker *);
	void *args;
};

struct rt6_statistics {
	__u32		fib_nodes;		/* all fib6 nodes */
	__u32		fib_route_nodes;	/* intermediate nodes */
	__u32		fib_rt_entries;		/* rt entries in fib table */
	__u32		fib_rt_cache;		/* cached rt entries in exception table */
	__u32		fib_discarded_routes;	/* total number of routes delete */

	/* The following stats are not protected by any lock */
	atomic_t	fib_rt_alloc;		/* total number of routes alloced */
	atomic_t	fib_rt_uncache;		/* rt entries in uncached list */
};

#define RTN_TL_ROOT	0x0001
#define RTN_ROOT	0x0002		/* tree root node		*/
#define RTN_RTINFO	0x0004		/* node with valid routing info	*/

/*
 *	priority levels (or metrics)
 *
 */


struct fib6_table {
	struct hlist_node	tb6_hlist;
	u32			tb6_id;
	spinlock_t		tb6_lock;
	struct fib6_node	tb6_root;
	struct inet_peer_base	tb6_peers;
	unsigned int		flags;
	unsigned int		fib_seq;
#define RT6_TABLE_HAS_DFLT_ROUTER	BIT(0)
};

#define RT6_TABLE_UNSPEC	RT_TABLE_UNSPEC
#define RT6_TABLE_MAIN		RT_TABLE_MAIN
#define RT6_TABLE_DFLT		RT6_TABLE_MAIN
#define RT6_TABLE_INFO		RT6_TABLE_MAIN
#define RT6_TABLE_PREFIX	RT6_TABLE_MAIN

#ifdef CONFIG_IPV6_MULTIPLE_TABLES
#define FIB6_TABLE_MIN		1
#define FIB6_TABLE_MAX		RT_TABLE_MAX
#define RT6_TABLE_LOCAL		RT_TABLE_LOCAL
#else
#define FIB6_TABLE_MIN		RT_TABLE_MAIN
#define FIB6_TABLE_MAX		FIB6_TABLE_MIN
#define RT6_TABLE_LOCAL		RT6_TABLE_MAIN
#endif

typedef struct rt6_info *(*pol_lookup_t)(struct net *,
					 struct fib6_table *,
					 struct flowi6 *,
					 const struct sk_buff *, int);

struct fib6_entry_notifier_info {
	struct fib_notifier_info info; /* must be first */
	struct fib6_info *rt;
};

/*
 *	exported functions
 */

struct fib6_table *fib6_get_table(struct net *net, u32 id);
struct fib6_table *fib6_new_table(struct net *net, u32 id);
struct dst_entry *fib6_rule_lookup(struct net *net, struct flowi6 *fl6,
				   const struct sk_buff *skb,
				   int flags, pol_lookup_t lookup);

/* called with rcu lock held; can return error pointer
 * caller needs to select path
 */
struct fib6_info *fib6_lookup(struct net *net, int oif, struct flowi6 *fl6,
			      int flags);

/* called with rcu lock held; caller needs to select path */
struct fib6_info *fib6_table_lookup(struct net *net, struct fib6_table *table,
				    int oif, struct flowi6 *fl6, int strict);

struct fib6_info *fib6_multipath_select(const struct net *net,
					struct fib6_info *match,
					struct flowi6 *fl6, int oif,
					const struct sk_buff *skb, int strict);

struct fib6_node *fib6_node_lookup(struct fib6_node *root,
				   const struct in6_addr *daddr,
				   const struct in6_addr *saddr);

struct fib6_node *fib6_locate(struct fib6_node *root,
			      const struct in6_addr *daddr, int dst_len,
			      const struct in6_addr *saddr, int src_len,
			      bool exact_match);

void fib6_clean_all(struct net *net, int (*func)(struct fib6_info *, void *arg),
		    void *arg);
void fib6_clean_all_skip_notify(struct net *net,
				int (*func)(struct fib6_info *, void *arg),
				void *arg);

int fib6_add(struct fib6_node *root, struct fib6_info *rt,
	     struct nl_info *info, struct netlink_ext_ack *extack);
int fib6_del(struct fib6_info *rt, struct nl_info *info);

static inline
void rt6_get_prefsrc(const struct rt6_info *rt, struct in6_addr *addr)
{
	const struct fib6_info *from;

	rcu_read_lock();

	from = rcu_dereference(rt->from);
	if (from) {
		*addr = from->fib6_prefsrc.addr;
	} else {
		struct in6_addr in6_zero = {};

		*addr = in6_zero;
	}

	rcu_read_unlock();
}

static inline struct net_device *fib6_info_nh_dev(const struct fib6_info *f6i)
{
	return f6i->fib6_nh.nh_dev;
}

static inline
struct lwtunnel_state *fib6_info_nh_lwt(const struct fib6_info *f6i)
{
	return f6i->fib6_nh.nh_lwtstate;
}

void inet6_rt_notify(int event, struct fib6_info *rt, struct nl_info *info,
		     unsigned int flags);

void fib6_run_gc(unsigned long expires, struct net *net, bool force);

void fib6_gc_cleanup(void);

int fib6_init(void);

struct ipv6_route_iter {
	struct seq_net_private p;
	struct fib6_walker w;
	loff_t skip;
	struct fib6_table *tbl;
	int sernum;
};

extern const struct seq_operations ipv6_route_seq_ops;

int call_fib6_notifier(struct notifier_block *nb, struct net *net,
		       enum fib_event_type event_type,
		       struct fib_notifier_info *info);
int call_fib6_notifiers(struct net *net, enum fib_event_type event_type,
			struct fib_notifier_info *info);

int __net_init fib6_notifier_init(struct net *net);
void __net_exit fib6_notifier_exit(struct net *net);

unsigned int fib6_tables_seq_read(struct net *net);
int fib6_tables_dump(struct net *net, struct notifier_block *nb);

void fib6_update_sernum(struct net *net, struct fib6_info *rt);
void fib6_update_sernum_upto_root(struct net *net, struct fib6_info *rt);

void fib6_metric_set(struct fib6_info *f6i, int metric, u32 val);
static inline bool fib6_metric_locked(struct fib6_info *f6i, int metric)
{
	return !!(f6i->fib6_metrics->metrics[RTAX_LOCK - 1] & (1 << metric));
}

#ifdef CONFIG_IPV6_MULTIPLE_TABLES
int fib6_rules_init(void);
void fib6_rules_cleanup(void);
bool fib6_rule_default(const struct fib_rule *rule);
int fib6_rules_dump(struct net *net, struct notifier_block *nb);
unsigned int fib6_rules_seq_read(struct net *net);

static inline bool fib6_rules_early_flow_dissect(struct net *net,
						 struct sk_buff *skb,
						 struct flowi6 *fl6,
						 struct flow_keys *flkeys)
{
	unsigned int flag = FLOW_DISSECTOR_F_STOP_AT_ENCAP;

	if (!net->ipv6.fib6_rules_require_fldissect)
		return false;

	skb_flow_dissect_flow_keys(skb, flkeys, flag);
	fl6->fl6_sport = flkeys->ports.src;
	fl6->fl6_dport = flkeys->ports.dst;
	fl6->flowi6_proto = flkeys->basic.ip_proto;

	return true;
}
#else
static inline int               fib6_rules_init(void)
{
	return 0;
}
static inline void              fib6_rules_cleanup(void)
{
	return ;
}
static inline bool fib6_rule_default(const struct fib_rule *rule)
{
	return true;
}
static inline int fib6_rules_dump(struct net *net, struct notifier_block *nb)
{
	return 0;
}
static inline unsigned int fib6_rules_seq_read(struct net *net)
{
	return 0;
}
static inline bool fib6_rules_early_flow_dissect(struct net *net,
						 struct sk_buff *skb,
						 struct flowi6 *fl6,
						 struct flow_keys *flkeys)
{
	return false;
}
#endif
#endif
Commit	Line	Data
1da177e4 LT	1	/*
	2	* Linux INET6 implementation
	3	*
	4	* Authors:
	5	* Pedro Roque <roque@di.fc.ul.pt>
	6	*
	7	* This program is free software; you can redistribute it and/or
	8	* modify it under the terms of the GNU General Public License
	9	* as published by the Free Software Foundation; either version
	10	* 2 of the License, or (at your option) any later version.
	11	*/
	12
	13	#ifndef _IP6_FIB_H
	14	#define _IP6_FIB_H
	15
1da177e4	16	#include <linux/ipv6_route.h>
1da177e4 LT	17	#include <linux/rtnetlink.h>
1da177e4 LT	18	#include <linux/spinlock.h>
16ab6d7d	19	#include <linux/notifier.h>
86872cb5 TG	20	#include <net/dst.h>
	21	#include <net/flow.h>
	22	#include <net/netlink.h>
b3419363	23	#include <net/inetpeer.h>
16ab6d7d	24	#include <net/fib_notifier.h>
1da177e4	25
a33bc5c1 NH	26	#ifdef CONFIG_IPV6_MULTIPLE_TABLES
	27	#define FIB6_TABLE_HASHSZ 256
	28	#else
	29	#define FIB6_TABLE_HASHSZ 1
	30	#endif
	31
c757faa8 WW	32	#define RT6_DEBUG 2
	33
	34	#if RT6_DEBUG >= 3
	35	#define RT6_TRACE(x...) pr_debug(x)
	36	#else
	37	#define RT6_TRACE(x...) do { ; } while (0)
	38	#endif
	39
1da177e4	40	struct rt6_info;
a64efe14	41	struct fib6_info;
1da177e4	42
fd2c3ef7	43	struct fib6_config {
86872cb5 TG	44	u32 fc_table;
	45	u32 fc_metric;
	46	int fc_dst_len;
	47	int fc_src_len;
	48	int fc_ifindex;
	49	u32 fc_flags;
	50	u32 fc_protocol;
0ae81335 DA	51	u16 fc_type; /* only 8 bits are used */
	52	u16 fc_delete_all_nh : 1,
	53	__unused : 15;
86872cb5 TG	54
	55	struct in6_addr fc_dst;
	56	struct in6_addr fc_src;
c3968a85	57	struct in6_addr fc_prefsrc;
86872cb5 TG	58	struct in6_addr fc_gateway;
	59
	60	unsigned long fc_expires;
	61	struct nlattr *fc_mx;
	62	int fc_mx_len;
51ebd318 ND	63	int fc_mp_len;
51ebd318 ND	64	struct nlattr *fc_mp;
86872cb5 TG	65
86872cb5 TG	66	struct nl_info fc_nlinfo;
19e42e45 RP	67	struct nlattr *fc_encap;
19e42e45 RP	68	u16 fc_encap_type;
86872cb5 TG	69	};
86872cb5 TG	70
fd2c3ef7	71	struct fib6_node {
66f5d6ce WW	72	struct fib6_node __rcu *parent;
	73	struct fib6_node __rcu *left;
	74	struct fib6_node __rcu *right;
8bce65b9	75	#ifdef CONFIG_IPV6_SUBTREES
66f5d6ce	76	struct fib6_node __rcu *subtree;
8bce65b9	77	#endif
8d1c802b	78	struct fib6_info __rcu *leaf;
1da177e4 LT	79
	80	__u16 fn_bit; /* bit key */
	81	__u16 fn_flags;
42b18706	82	int fn_sernum;
8d1c802b	83	struct fib6_info __rcu *rr_ptr;
c5cff856	84	struct rcu_head rcu;
1da177e4 LT	85	};
1da177e4 LT	86
c757faa8 WW	87	struct fib6_gc_args {
	88	int timeout;
	89	int more;
	90	};
	91
7fc33165 YH	92	#ifndef CONFIG_IPV6_SUBTREES
	93	#define FIB6_SUBTREE(fn) NULL
	94	#else
66f5d6ce	95	#define FIB6_SUBTREE(fn) (rcu_dereference_protected((fn)->subtree, 1))
7fc33165	96	#endif
1da177e4 LT	97
	98	/*
	99	* routing information
	100	*
	101	*/
	102
fd2c3ef7	103	struct rt6key {
1da177e4 LT	104	struct in6_addr addr;
	105	int plen;
	106	};
	107
c71099ac TG	108	struct fib6_table;
c71099ac TG	109
35732d01 WW	110	struct rt6_exception_bucket {
	111	struct hlist_head chain;
	112	int depth;
	113	};
	114
	115	struct rt6_exception {
	116	struct hlist_node hlist;
	117	struct rt6_info *rt6i;
	118	unsigned long stamp;
	119	struct rcu_head rcu;
	120	};
	121
	122	#define FIB6_EXCEPTION_BUCKET_SIZE_SHIFT 10
	123	#define FIB6_EXCEPTION_BUCKET_SIZE (1 << FIB6_EXCEPTION_BUCKET_SIZE_SHIFT)
	124	#define FIB6_MAX_DEPTH 5
	125
5e670d84 DA	126	struct fib6_nh {
	127	struct in6_addr nh_gw;
	128	struct net_device *nh_dev;
	129	struct lwtunnel_state *nh_lwtstate;
1da177e4	130
5e670d84 DA	131	unsigned int nh_flags;
	132	atomic_t nh_upper_bound;
	133	int nh_weight;
	134	};
1da177e4	135
a64efe14	136	struct fib6_info {
93c2fb25	137	struct fib6_table *fib6_table;
8fb11a9a	138	struct fib6_info __rcu *fib6_next;
93c2fb25	139	struct fib6_node __rcu *fib6_node;
1da177e4	140
51ebd318	141	/* Multipath routes:
a64efe14	142	* siblings is a list of fib6_info that have the the same metric/weight,
51ebd318 ND	143	* destination, but not the same gateway. nsiblings is just a cache
	144	* to speed up lookup.
	145	*/
93c2fb25 DA	146	struct list_head fib6_siblings;
93c2fb25 DA	147	unsigned int fib6_nsiblings;
51ebd318	148
93c2fb25	149	atomic_t fib6_ref;
a64efe14 DA	150	unsigned long expires;
	151	struct dst_metrics *fib6_metrics;
	152	#define fib6_pmtu fib6_metrics->metrics[RTAX_MTU-1]
a47ed4cd	153
93c2fb25 DA	154	struct rt6key fib6_dst;
	155	u32 fib6_flags;
	156	struct rt6key fib6_src;
	157	struct rt6key fib6_prefsrc;
fe400799	158
a64efe14 DA	159	struct rt6_info * __percpu *rt6i_pcpu;
	160	struct rt6_exception_bucket __rcu *rt6i_exception_bucket;
	161
f547fac6 SD	162	#ifdef CONFIG_IPV6_ROUTER_PREF
	163	unsigned long last_probe;
	164	#endif
	165
93c2fb25 DA	166	u32 fib6_metric;
93c2fb25 DA	167	u8 fib6_protocol;
a64efe14 DA	168	u8 fib6_type;
	169	u8 exception_bucket_flushed:1,
	170	should_flush:1,
	171	dst_nocount:1,
	172	dst_nopolicy:1,
	173	dst_host:1,
	174	unused:3;
	175
	176	struct fib6_nh fib6_nh;
9b0a8da8	177	struct rcu_head rcu;
a64efe14 DA	178	};
a64efe14 DA	179
fd2c3ef7	180	struct rt6_info {
d8d1f30b	181	struct dst_entry dst;
a68886a6	182	struct fib6_info __rcu *from;
1da177e4	183
77634cc6	184	struct rt6key rt6i_dst;
bd2c77a0	185	struct rt6key rt6i_src;
1da177e4	186	struct in6_addr rt6i_gateway;
77634cc6	187	struct inet6_dev *rt6i_idev;
bd2c77a0	188	u32 rt6i_flags;
b4ce9277	189
8d0b94af MKL	190	struct list_head rt6i_uncached;
	191	struct uncached_list *rt6i_uncached_list;
	192
bd2c77a0 YH	193	/* more non-fragment space at head required */
bd2c77a0 YH	194	unsigned short rt6i_nfheader_len;
1da177e4 LT	195	};
1da177e4 LT	196
66f5d6ce WW	197	#define for_each_fib6_node_rt_rcu(fn) \
66f5d6ce WW	198	for (rt = rcu_dereference((fn)->leaf); rt; \
8fb11a9a	199	rt = rcu_dereference(rt->fib6_next))
66f5d6ce WW	200
	201	#define for_each_fib6_walker_rt(w) \
	202	for (rt = (w)->leaf; rt; \
8fb11a9a	203	rt = rcu_dereference_protected(rt->fib6_next, 1))
66f5d6ce	204
7a3025b1 YH	205	static inline struct inet6_dev ip6_dst_idev(struct dst_entry dst)
	206	{
	207	return ((struct rt6_info *)dst)->rt6i_idev;
	208	}
	209
8d1c802b	210	static inline void fib6_clean_expires(struct fib6_info *f6i)
1716a961	211	{
93c2fb25	212	f6i->fib6_flags &= ~RTF_EXPIRES;
14895687	213	f6i->expires = 0;
1716a961 G	214	}
1716a961 G	215
8d1c802b	216	static inline void fib6_set_expires(struct fib6_info *f6i,
14895687	217	unsigned long expires)
1716a961	218	{
14895687	219	f6i->expires = expires;
93c2fb25	220	f6i->fib6_flags \|= RTF_EXPIRES;
1716a961 G	221	}
1716a961 G	222
8d1c802b	223	static inline bool fib6_check_expired(const struct fib6_info *f6i)
1716a961	224	{
93c2fb25	225	if (f6i->fib6_flags & RTF_EXPIRES)
14895687 DA	226	return time_after(jiffies, f6i->expires);
14895687 DA	227	return false;
1716a961	228	}
b197df4f	229
c5cff856 WW	230	/* Function to safely get fn->sernum for passed in rt
	231	* and store result in passed in cookie.
	232	* Return true if we can get cookie safely
	233	* Return false if not
	234	*/
a269f1a7 DA	235	static inline bool fib6_get_cookie_safe(const struct fib6_info *f6i,
a269f1a7 DA	236	u32 *cookie)
c5cff856 WW	237	{
	238	struct fib6_node *fn;
	239	bool status = false;
	240
93c2fb25	241	fn = rcu_dereference(f6i->fib6_node);
c5cff856 WW	242
	243	if (fn) {
	244	*cookie = fn->fn_sernum;
bbd63f06 WW	245	/* pairs with smp_wmb() in fib6_update_sernum_upto_root() */
bbd63f06 WW	246	smp_rmb();
c5cff856 WW	247	status = true;
	248	}
	249
c5cff856 WW	250	return status;
	251	}
	252
b197df4f MKL	253	static inline u32 rt6_get_cookie(const struct rt6_info *rt)
b197df4f MKL	254	{
a68886a6	255	struct fib6_info *from;
c5cff856 WW	256	u32 cookie = 0;
c5cff856 WW	257
a87b7dc9 DA	258	rcu_read_lock();
a87b7dc9 DA	259
a68886a6 DA	260	from = rcu_dereference(rt->from);
	261	if (from && (rt->rt6i_flags & RTF_PCPU \|\|
	262	unlikely(!list_empty(&rt->rt6i_uncached))))
	263	fib6_get_cookie_safe(from, &cookie);
3da59bd9	264
a87b7dc9	265	rcu_read_unlock();
c5cff856 WW	266
c5cff856 WW	267	return cookie;
b197df4f	268	}
1716a961	269
94e187c0 AW	270	static inline void ip6_rt_put(struct rt6_info *rt)
	271	{
	272	/* dst_release() accepts a NULL parameter.
	273	* We rely on dst being first structure in struct rt6_info
	274	*/
	275	BUILD_BUG_ON(offsetof(struct rt6_info, dst) != 0);
	276	dst_release(&rt->dst);
	277	}
	278
8d1c802b	279	struct fib6_info *fib6_info_alloc(gfp_t gfp_flags);
9b0a8da8	280	void fib6_info_destroy_rcu(struct rcu_head *head);
a460aa83	281
8d1c802b	282	static inline void fib6_info_hold(struct fib6_info *f6i)
a460aa83	283	{
93c2fb25	284	atomic_inc(&f6i->fib6_ref);
a460aa83 IS	285	}
a460aa83 IS	286
e873e4b9 WW	287	static inline bool fib6_info_hold_safe(struct fib6_info *f6i)
	288	{
	289	return atomic_inc_not_zero(&f6i->fib6_ref);
	290	}
	291
8d1c802b	292	static inline void fib6_info_release(struct fib6_info *f6i)
a460aa83	293	{
93c2fb25	294	if (f6i && atomic_dec_and_test(&f6i->fib6_ref))
9b0a8da8	295	call_rcu(&f6i->rcu, fib6_info_destroy_rcu);
a460aa83 IS	296	}
a460aa83 IS	297
94b2cfe0 HFS	298	enum fib6_walk_state {
	299	#ifdef CONFIG_IPV6_SUBTREES
	300	FWS_S,
	301	#endif
	302	FWS_L,
	303	FWS_R,
	304	FWS_C,
	305	FWS_U
	306	};
	307
	308	struct fib6_walker {
bbef49da	309	struct list_head lh;
1da177e4	310	struct fib6_node root, node;
8d1c802b	311	struct fib6_info *leaf;
94b2cfe0	312	enum fib6_walk_state state;
2bec5a36 PM	313	unsigned int skip;
2bec5a36 PM	314	unsigned int count;
94b2cfe0	315	int (func)(struct fib6_walker );
1da177e4 LT	316	void *args;
	317	};
	318
1da177e4	319	struct rt6_statistics {
81eb8447 WW	320	__u32 fib_nodes; /* all fib6 nodes */
	321	__u32 fib_route_nodes; /* intermediate nodes */
	322	__u32 fib_rt_entries; /* rt entries in fib table */
	323	__u32 fib_rt_cache; /* cached rt entries in exception table */
	324	__u32 fib_discarded_routes; /* total number of routes delete */
	325
	326	/* The following stats are not protected by any lock */
	327	atomic_t fib_rt_alloc; /* total number of routes alloced */
	328	atomic_t fib_rt_uncache; /* rt entries in uncached list */
1da177e4 LT	329	};
	330
	331	#define RTN_TL_ROOT 0x0001
	332	#define RTN_ROOT 0x0002 /* tree root node */
	333	#define RTN_RTINFO 0x0004 /* node with valid routing info */
	334
	335	/*
	336	* priority levels (or metrics)
	337	*
	338	*/
	339
1da177e4	340
c71099ac TG	341	struct fib6_table {
	342	struct hlist_node tb6_hlist;
	343	u32 tb6_id;
66f5d6ce	344	spinlock_t tb6_lock;
c71099ac	345	struct fib6_node tb6_root;
8e773277	346	struct inet_peer_base tb6_peers;
830218c1	347	unsigned int flags;
e1ee0a5b	348	unsigned int fib_seq;
830218c1	349	#define RT6_TABLE_HAS_DFLT_ROUTER BIT(0)
c71099ac TG	350	};
	351
	352	#define RT6_TABLE_UNSPEC RT_TABLE_UNSPEC
	353	#define RT6_TABLE_MAIN RT_TABLE_MAIN
c71099ac TG	354	#define RT6_TABLE_DFLT RT6_TABLE_MAIN
	355	#define RT6_TABLE_INFO RT6_TABLE_MAIN
	356	#define RT6_TABLE_PREFIX RT6_TABLE_MAIN
	357
	358	#ifdef CONFIG_IPV6_MULTIPLE_TABLES
	359	#define FIB6_TABLE_MIN 1
	360	#define FIB6_TABLE_MAX RT_TABLE_MAX
101367c2	361	#define RT6_TABLE_LOCAL RT_TABLE_LOCAL
c71099ac TG	362	#else
	363	#define FIB6_TABLE_MIN RT_TABLE_MAIN
	364	#define FIB6_TABLE_MAX FIB6_TABLE_MIN
101367c2	365	#define RT6_TABLE_LOCAL RT6_TABLE_MAIN
c71099ac TG	366	#endif
c71099ac TG	367
8ed67789 DL	368	typedef struct rt6_info (pol_lookup_t)(struct net *,
8ed67789 DL	369	struct fib6_table *,
b75cc8f9 DA	370	struct flowi6 *,
b75cc8f9 DA	371	const struct sk_buff *, int);
1da177e4	372
df77fe4d IS	373	struct fib6_entry_notifier_info {
df77fe4d IS	374	struct fib_notifier_info info; /* must be first */
8d1c802b	375	struct fib6_info *rt;
df77fe4d IS	376	};
df77fe4d IS	377
1da177e4 LT	378	/*
	379	* exported functions
	380	*/
	381
5c3a0fd7 JP	382	struct fib6_table fib6_get_table(struct net net, u32 id);
	383	struct fib6_table fib6_new_table(struct net net, u32 id);
	384	struct dst_entry fib6_rule_lookup(struct net net, struct flowi6 *fl6,
b75cc8f9	385	const struct sk_buff *skb,
5c3a0fd7	386	int flags, pol_lookup_t lookup);
c71099ac	387
138118ec DA	388	/* called with rcu lock held; can return error pointer
	389	* caller needs to select path
	390	*/
	391	struct fib6_info fib6_lookup(struct net net, int oif, struct flowi6 *fl6,
	392	int flags);
	393
1d053da9 DA	394	/* called with rcu lock held; caller needs to select path */
	395	struct fib6_info fib6_table_lookup(struct net net, struct fib6_table *table,
	396	int oif, struct flowi6 *fl6, int strict);
	397
3b290a31 DA	398	struct fib6_info fib6_multipath_select(const struct net net,
	399	struct fib6_info *match,
	400	struct flowi6 *fl6, int oif,
	401	const struct sk_buff *skb, int strict);
	402
6454743b DA	403	struct fib6_node fib6_node_lookup(struct fib6_node root,
	404	const struct in6_addr *daddr,
	405	const struct in6_addr *saddr);
1da177e4	406
5c3a0fd7 JP	407	struct fib6_node fib6_locate(struct fib6_node root,
5c3a0fd7 JP	408	const struct in6_addr *daddr, int dst_len,
38fbeeee WW	409	const struct in6_addr *saddr, int src_len,
38fbeeee WW	410	bool exact_match);
1da177e4	411
8d1c802b	412	void fib6_clean_all(struct net net, int (func)(struct fib6_info , void arg),
0c3584d5	413	void *arg);
7c6bb7d2 DA	414	void fib6_clean_all_skip_notify(struct net *net,
	415	int (func)(struct fib6_info , void *arg),
	416	void *arg);
c71099ac	417
8d1c802b	418	int fib6_add(struct fib6_node root, struct fib6_info rt,
d4ead6b3	419	struct nl_info info, struct netlink_ext_ack extack);
8d1c802b	420	int fib6_del(struct fib6_info rt, struct nl_info info);
1da177e4	421
67edf21e DA	422	static inline
	423	void rt6_get_prefsrc(const struct rt6_info rt, struct in6_addr addr)
	424	{
	425	const struct fib6_info *from;
	426
	427	rcu_read_lock();
	428
	429	from = rcu_dereference(rt->from);
	430	if (from) {
	431	*addr = from->fib6_prefsrc.addr;
	432	} else {
	433	struct in6_addr in6_zero = {};
	434
	435	*addr = in6_zero;
	436	}
	437
	438	rcu_read_unlock();
	439	}
	440
9ee8cbb2 DA	441	static inline struct net_device fib6_info_nh_dev(const struct fib6_info f6i)
	442	{
	443	return f6i->fib6_nh.nh_dev;
	444	}
	445
901731b8 DA	446	static inline
	447	struct lwtunnel_state fib6_info_nh_lwt(const struct fib6_info f6i)
	448	{
	449	return f6i->fib6_nh.nh_lwtstate;
	450	}
1da177e4	451
8d1c802b	452	void inet6_rt_notify(int event, struct fib6_info rt, struct nl_info info,
37a1d361	453	unsigned int flags);
1da177e4	454
5c3a0fd7	455	void fib6_run_gc(unsigned long expires, struct net *net, bool force);
1da177e4	456
5c3a0fd7	457	void fib6_gc_cleanup(void);
1da177e4	458
5c3a0fd7	459	int fib6_init(void);
101367c2	460
c3506372 CH	461	struct ipv6_route_iter {
	462	struct seq_net_private p;
	463	struct fib6_walker w;
	464	loff_t skip;
	465	struct fib6_table *tbl;
	466	int sernum;
	467	};
	468
	469	extern const struct seq_operations ipv6_route_seq_ops;
8d2ca1d7	470
16ab6d7d IS	471	int call_fib6_notifier(struct notifier_block nb, struct net net,
	472	enum fib_event_type event_type,
	473	struct fib_notifier_info *info);
	474	int call_fib6_notifiers(struct net *net, enum fib_event_type event_type,
	475	struct fib_notifier_info *info);
	476
	477	int __net_init fib6_notifier_init(struct net *net);
	478	void __net_exit fib6_notifier_exit(struct net *net);
	479
e1ee0a5b IS	480	unsigned int fib6_tables_seq_read(struct net *net);
	481	int fib6_tables_dump(struct net net, struct notifier_block nb);
	482
8d1c802b DA	483	void fib6_update_sernum(struct net net, struct fib6_info rt);
8d1c802b DA	484	void fib6_update_sernum_upto_root(struct net net, struct fib6_info rt);
180ca444	485
8d1c802b DA	486	void fib6_metric_set(struct fib6_info *f6i, int metric, u32 val);
8d1c802b DA	487	static inline bool fib6_metric_locked(struct fib6_info *f6i, int metric)
d4ead6b3 DA	488	{
	489	return !!(f6i->fib6_metrics->metrics[RTAX_LOCK - 1] & (1 << metric));
	490	}
180ca444	491
7e5449c2	492	#ifdef CONFIG_IPV6_MULTIPLE_TABLES
5c3a0fd7 JP	493	int fib6_rules_init(void);
5c3a0fd7 JP	494	void fib6_rules_cleanup(void);
e3ea9731	495	bool fib6_rule_default(const struct fib_rule *rule);
dcb18f76 IS	496	int fib6_rules_dump(struct net net, struct notifier_block nb);
dcb18f76 IS	497	unsigned int fib6_rules_seq_read(struct net *net);
5e5d6fed RP	498
	499	static inline bool fib6_rules_early_flow_dissect(struct net *net,
	500	struct sk_buff *skb,
	501	struct flowi6 *fl6,
	502	struct flow_keys *flkeys)
	503	{
	504	unsigned int flag = FLOW_DISSECTOR_F_STOP_AT_ENCAP;
	505
	506	if (!net->ipv6.fib6_rules_require_fldissect)
	507	return false;
	508
	509	skb_flow_dissect_flow_keys(skb, flkeys, flag);
	510	fl6->fl6_sport = flkeys->ports.src;
	511	fl6->fl6_dport = flkeys->ports.dst;
	512	fl6->flowi6_proto = flkeys->basic.ip_proto;
	513
	514	return true;
	515	}
7e5449c2 DL	516	#else
	517	static inline int fib6_rules_init(void)
	518	{
	519	return 0;
	520	}
	521	static inline void fib6_rules_cleanup(void)
	522	{
	523	return ;
	524	}
e3ea9731 IS	525	static inline bool fib6_rule_default(const struct fib_rule *rule)
	526	{
	527	return true;
	528	}
dcb18f76 IS	529	static inline int fib6_rules_dump(struct net net, struct notifier_block nb)
	530	{
	531	return 0;
	532	}
	533	static inline unsigned int fib6_rules_seq_read(struct net *net)
	534	{
	535	return 0;
	536	}
5e5d6fed RP	537	static inline bool fib6_rules_early_flow_dissect(struct net *net,
	538	struct sk_buff *skb,
	539	struct flowi6 *fl6,
	540	struct flow_keys *flkeys)
	541	{
	542	return false;
	543	}
7e5449c2	544	#endif
1da177e4	545	#endif