[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		*rt6_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;
	struct inet6_dev		*fib6_idev;
	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;

	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 rt6_info {
	struct dst_entry		dst;
	struct fib6_info		*from;

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

	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->rt6_next))

#define for_each_fib6_walker_rt(w)					\
	for (rt = (w)->leaf; rt;					\
	     rt = rcu_dereference_protected(rt->rt6_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;
}

static inline void rt6_clean_expires(struct rt6_info *rt)
{
	rt->rt6i_flags &= ~RTF_EXPIRES;
	rt->dst.expires = 0;
}

static inline void rt6_set_expires(struct rt6_info *rt, unsigned long expires)
{
	rt->dst.expires = expires;
	rt->rt6i_flags |= RTF_EXPIRES;
}

static inline void rt6_update_expires(struct rt6_info *rt0, int timeout)
{
	if (!(rt0->rt6i_flags & RTF_EXPIRES) && rt0->from)
		rt0->dst.expires = rt0->from->expires;

	dst_set_expires(&rt0->dst, timeout);
	rt0->rt6i_flags |= RTF_EXPIRES;
}

/* 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 rt6_get_cookie_safe(const struct fib6_info *f6i,
				       u32 *cookie)
{
	struct fib6_node *fn;
	bool status = false;

	rcu_read_lock();
	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;
	}

	rcu_read_unlock();
	return status;
}

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

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

	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(struct fib6_info *f6i);

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

static inline void fib6_info_release(struct fib6_info *f6i)
{
	if (f6i && atomic_dec_and_test(&f6i->fib6_ref))
		fib6_info_destroy(f6i);
}

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);

struct fib6_node *fib6_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);

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);

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);

int ipv6_route_open(struct inode *inode, struct file *file);

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;
	130
	131	unsigned int nh_flags;
	132	atomic_t nh_upper_bound;
	133	int nh_weight;
	134	};
	135
a64efe14	136	struct fib6_info {
93c2fb25	137	struct fib6_table *fib6_table;
a64efe14	138	struct fib6_info __rcu *rt6_next;
93c2fb25	139	struct fib6_node __rcu *fib6_node;
a64efe14 DA	140
	141	/* Multipath routes:
	142	* siblings is a list of fib6_info that have the the same metric/weight,
	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;
a64efe14	148
93c2fb25 DA	149	atomic_t fib6_ref;
93c2fb25 DA	150	struct inet6_dev *fib6_idev;
a64efe14 DA	151	unsigned long expires;
	152	struct dst_metrics *fib6_metrics;
	153	#define fib6_pmtu fib6_metrics->metrics[RTAX_MTU-1]
	154
93c2fb25 DA	155	struct rt6key fib6_dst;
	156	u32 fib6_flags;
	157	struct rt6key fib6_src;
	158	struct rt6key fib6_prefsrc;
a64efe14 DA	159
	160	struct rt6_info * __percpu *rt6i_pcpu;
	161	struct rt6_exception_bucket __rcu *rt6i_exception_bucket;
	162
93c2fb25 DA	163	u32 fib6_metric;
93c2fb25 DA	164	u8 fib6_protocol;
a64efe14 DA	165	u8 fib6_type;
	166	u8 exception_bucket_flushed:1,
	167	should_flush:1,
	168	dst_nocount:1,
	169	dst_nopolicy:1,
	170	dst_host:1,
	171	unused:3;
	172
	173	struct fib6_nh fib6_nh;
	174	};
	175
fd2c3ef7	176	struct rt6_info {
d8d1f30b	177	struct dst_entry dst;
8d1c802b	178	struct fib6_info *from;
1da177e4	179
77634cc6 DA	180	struct rt6key rt6i_dst;
77634cc6 DA	181	struct rt6key rt6i_src;
1da177e4	182	struct in6_addr rt6i_gateway;
77634cc6	183	struct inet6_dev *rt6i_idev;
bd2c77a0	184	u32 rt6i_flags;
c3968a85	185	struct rt6key rt6i_prefsrc;
b4ce9277	186
8d0b94af MKL	187	struct list_head rt6i_uncached;
	188	struct uncached_list *rt6i_uncached_list;
	189
bd2c77a0 YH	190	/* more non-fragment space at head required */
bd2c77a0 YH	191	unsigned short rt6i_nfheader_len;
1da177e4 LT	192	};
1da177e4 LT	193
66f5d6ce WW	194	#define for_each_fib6_node_rt_rcu(fn) \
66f5d6ce WW	195	for (rt = rcu_dereference((fn)->leaf); rt; \
071fb37e	196	rt = rcu_dereference(rt->rt6_next))
66f5d6ce WW	197
	198	#define for_each_fib6_walker_rt(w) \
	199	for (rt = (w)->leaf; rt; \
071fb37e	200	rt = rcu_dereference_protected(rt->rt6_next, 1))
66f5d6ce	201
7a3025b1 YH	202	static inline struct inet6_dev ip6_dst_idev(struct dst_entry dst)
	203	{
	204	return ((struct rt6_info *)dst)->rt6i_idev;
	205	}
	206
8d1c802b	207	static inline void fib6_clean_expires(struct fib6_info *f6i)
14895687	208	{
93c2fb25	209	f6i->fib6_flags &= ~RTF_EXPIRES;
14895687 DA	210	f6i->expires = 0;
	211	}
	212
8d1c802b	213	static inline void fib6_set_expires(struct fib6_info *f6i,
14895687 DA	214	unsigned long expires)
	215	{
	216	f6i->expires = expires;
93c2fb25	217	f6i->fib6_flags \|= RTF_EXPIRES;
14895687 DA	218	}
14895687 DA	219
8d1c802b	220	static inline bool fib6_check_expired(const struct fib6_info *f6i)
14895687	221	{
93c2fb25	222	if (f6i->fib6_flags & RTF_EXPIRES)
14895687 DA	223	return time_after(jiffies, f6i->expires);
	224	return false;
	225	}
	226
1716a961 G	227	static inline void rt6_clean_expires(struct rt6_info *rt)
1716a961 G	228	{
1716a961	229	rt->rt6i_flags &= ~RTF_EXPIRES;
01ba16d6	230	rt->dst.expires = 0;
1716a961 G	231	}
	232
	233	static inline void rt6_set_expires(struct rt6_info *rt, unsigned long expires)
	234	{
1716a961	235	rt->dst.expires = expires;
ecd98837	236	rt->rt6i_flags \|= RTF_EXPIRES;
1716a961 G	237	}
1716a961 G	238
ecd98837	239	static inline void rt6_update_expires(struct rt6_info *rt0, int timeout)
1716a961	240	{
14895687 DA	241	if (!(rt0->rt6i_flags & RTF_EXPIRES) && rt0->from)
14895687 DA	242	rt0->dst.expires = rt0->from->expires;
ecd98837	243
ecd98837 YH	244	dst_set_expires(&rt0->dst, timeout);
ecd98837 YH	245	rt0->rt6i_flags \|= RTF_EXPIRES;
1716a961	246	}
b197df4f	247
c5cff856 WW	248	/* Function to safely get fn->sernum for passed in rt
	249	* and store result in passed in cookie.
	250	* Return true if we can get cookie safely
	251	* Return false if not
	252	*/
93c2fb25	253	static inline bool rt6_get_cookie_safe(const struct fib6_info *f6i,
c5cff856 WW	254	u32 *cookie)
	255	{
	256	struct fib6_node *fn;
	257	bool status = false;
	258
	259	rcu_read_lock();
93c2fb25	260	fn = rcu_dereference(f6i->fib6_node);
c5cff856 WW	261
	262	if (fn) {
	263	*cookie = fn->fn_sernum;
bbd63f06 WW	264	/* pairs with smp_wmb() in fib6_update_sernum_upto_root() */
bbd63f06 WW	265	smp_rmb();
c5cff856 WW	266	status = true;
	267	}
	268
	269	rcu_read_unlock();
	270	return status;
	271	}
	272
b197df4f MKL	273	static inline u32 rt6_get_cookie(const struct rt6_info *rt)
b197df4f MKL	274	{
c5cff856 WW	275	u32 cookie = 0;
c5cff856 WW	276
02bcf4e0	277	if (rt->rt6i_flags & RTF_PCPU \|\|
3a2232e9	278	(unlikely(!list_empty(&rt->rt6i_uncached)) && rt->from))
93531c67	279	rt6_get_cookie_safe(rt->from, &cookie);
c5cff856 WW	280
c5cff856 WW	281	return cookie;
b197df4f	282	}
1716a961	283
94e187c0 AW	284	static inline void ip6_rt_put(struct rt6_info *rt)
	285	{
	286	/* dst_release() accepts a NULL parameter.
	287	* We rely on dst being first structure in struct rt6_info
	288	*/
	289	BUILD_BUG_ON(offsetof(struct rt6_info, dst) != 0);
	290	dst_release(&rt->dst);
	291	}
	292
8d1c802b DA	293	struct fib6_info *fib6_info_alloc(gfp_t gfp_flags);
8d1c802b DA	294	void fib6_info_destroy(struct fib6_info *f6i);
a64efe14	295
8d1c802b	296	static inline void fib6_info_hold(struct fib6_info *f6i)
a64efe14	297	{
93c2fb25	298	atomic_inc(&f6i->fib6_ref);
a64efe14 DA	299	}
a64efe14 DA	300
8d1c802b	301	static inline void fib6_info_release(struct fib6_info *f6i)
a64efe14	302	{
93c2fb25	303	if (f6i && atomic_dec_and_test(&f6i->fib6_ref))
a64efe14 DA	304	fib6_info_destroy(f6i);
	305	}
	306
94b2cfe0 HFS	307	enum fib6_walk_state {
	308	#ifdef CONFIG_IPV6_SUBTREES
	309	FWS_S,
	310	#endif
	311	FWS_L,
	312	FWS_R,
	313	FWS_C,
	314	FWS_U
	315	};
	316
	317	struct fib6_walker {
bbef49da	318	struct list_head lh;
1da177e4	319	struct fib6_node root, node;
8d1c802b	320	struct fib6_info *leaf;
94b2cfe0	321	enum fib6_walk_state state;
2bec5a36 PM	322	unsigned int skip;
2bec5a36 PM	323	unsigned int count;
94b2cfe0	324	int (func)(struct fib6_walker );
1da177e4 LT	325	void *args;
	326	};
	327
1da177e4	328	struct rt6_statistics {
81eb8447 WW	329	__u32 fib_nodes; /* all fib6 nodes */
	330	__u32 fib_route_nodes; /* intermediate nodes */
	331	__u32 fib_rt_entries; /* rt entries in fib table */
	332	__u32 fib_rt_cache; /* cached rt entries in exception table */
	333	__u32 fib_discarded_routes; /* total number of routes delete */
	334
	335	/* The following stats are not protected by any lock */
	336	atomic_t fib_rt_alloc; /* total number of routes alloced */
	337	atomic_t fib_rt_uncache; /* rt entries in uncached list */
1da177e4 LT	338	};
	339
	340	#define RTN_TL_ROOT 0x0001
	341	#define RTN_ROOT 0x0002 /* tree root node */
	342	#define RTN_RTINFO 0x0004 /* node with valid routing info */
	343
	344	/*
	345	* priority levels (or metrics)
	346	*
	347	*/
	348
1da177e4	349
c71099ac TG	350	struct fib6_table {
	351	struct hlist_node tb6_hlist;
	352	u32 tb6_id;
66f5d6ce	353	spinlock_t tb6_lock;
c71099ac	354	struct fib6_node tb6_root;
8e773277	355	struct inet_peer_base tb6_peers;
830218c1	356	unsigned int flags;
e1ee0a5b	357	unsigned int fib_seq;
830218c1	358	#define RT6_TABLE_HAS_DFLT_ROUTER BIT(0)
c71099ac TG	359	};
	360
	361	#define RT6_TABLE_UNSPEC RT_TABLE_UNSPEC
	362	#define RT6_TABLE_MAIN RT_TABLE_MAIN
c71099ac TG	363	#define RT6_TABLE_DFLT RT6_TABLE_MAIN
	364	#define RT6_TABLE_INFO RT6_TABLE_MAIN
	365	#define RT6_TABLE_PREFIX RT6_TABLE_MAIN
	366
	367	#ifdef CONFIG_IPV6_MULTIPLE_TABLES
	368	#define FIB6_TABLE_MIN 1
	369	#define FIB6_TABLE_MAX RT_TABLE_MAX
101367c2	370	#define RT6_TABLE_LOCAL RT_TABLE_LOCAL
c71099ac TG	371	#else
	372	#define FIB6_TABLE_MIN RT_TABLE_MAIN
	373	#define FIB6_TABLE_MAX FIB6_TABLE_MIN
101367c2	374	#define RT6_TABLE_LOCAL RT6_TABLE_MAIN
c71099ac TG	375	#endif
c71099ac TG	376
8ed67789 DL	377	typedef struct rt6_info (pol_lookup_t)(struct net *,
8ed67789 DL	378	struct fib6_table *,
b75cc8f9 DA	379	struct flowi6 *,
b75cc8f9 DA	380	const struct sk_buff *, int);
1da177e4	381
df77fe4d IS	382	struct fib6_entry_notifier_info {
df77fe4d IS	383	struct fib_notifier_info info; /* must be first */
8d1c802b	384	struct fib6_info *rt;
df77fe4d IS	385	};
df77fe4d IS	386
1da177e4 LT	387	/*
	388	* exported functions
	389	*/
	390
5c3a0fd7 JP	391	struct fib6_table fib6_get_table(struct net net, u32 id);
	392	struct fib6_table fib6_new_table(struct net net, u32 id);
	393	struct dst_entry fib6_rule_lookup(struct net net, struct flowi6 *fl6,
b75cc8f9	394	const struct sk_buff *skb,
5c3a0fd7	395	int flags, pol_lookup_t lookup);
c71099ac	396
5c3a0fd7 JP	397	struct fib6_node fib6_lookup(struct fib6_node root,
	398	const struct in6_addr *daddr,
	399	const struct in6_addr *saddr);
1da177e4	400
5c3a0fd7 JP	401	struct fib6_node fib6_locate(struct fib6_node root,
5c3a0fd7 JP	402	const struct in6_addr *daddr, int dst_len,
38fbeeee WW	403	const struct in6_addr *saddr, int src_len,
38fbeeee WW	404	bool exact_match);
1da177e4	405
8d1c802b	406	void fib6_clean_all(struct net net, int (func)(struct fib6_info , void arg),
0c3584d5	407	void *arg);
c71099ac	408
8d1c802b	409	int fib6_add(struct fib6_node root, struct fib6_info rt,
d4ead6b3	410	struct nl_info info, struct netlink_ext_ack extack);
8d1c802b	411	int fib6_del(struct fib6_info rt, struct nl_info info);
1da177e4	412
8d1c802b	413	void inet6_rt_notify(int event, struct fib6_info rt, struct nl_info info,
37a1d361	414	unsigned int flags);
1da177e4	415
5c3a0fd7	416	void fib6_run_gc(unsigned long expires, struct net *net, bool force);
1da177e4	417
5c3a0fd7	418	void fib6_gc_cleanup(void);
1da177e4	419
5c3a0fd7	420	int fib6_init(void);
101367c2	421
8d2ca1d7 HFS	422	int ipv6_route_open(struct inode inode, struct file file);
8d2ca1d7 HFS	423
16ab6d7d IS	424	int call_fib6_notifier(struct notifier_block nb, struct net net,
	425	enum fib_event_type event_type,
	426	struct fib_notifier_info *info);
	427	int call_fib6_notifiers(struct net *net, enum fib_event_type event_type,
	428	struct fib_notifier_info *info);
	429
	430	int __net_init fib6_notifier_init(struct net *net);
	431	void __net_exit fib6_notifier_exit(struct net *net);
	432
e1ee0a5b IS	433	unsigned int fib6_tables_seq_read(struct net *net);
	434	int fib6_tables_dump(struct net net, struct notifier_block nb);
	435
8d1c802b DA	436	void fib6_update_sernum(struct net net, struct fib6_info rt);
8d1c802b DA	437	void fib6_update_sernum_upto_root(struct net net, struct fib6_info rt);
180ca444	438
8d1c802b DA	439	void fib6_metric_set(struct fib6_info *f6i, int metric, u32 val);
8d1c802b DA	440	static inline bool fib6_metric_locked(struct fib6_info *f6i, int metric)
d4ead6b3 DA	441	{
	442	return !!(f6i->fib6_metrics->metrics[RTAX_LOCK - 1] & (1 << metric));
	443	}
	444
7e5449c2	445	#ifdef CONFIG_IPV6_MULTIPLE_TABLES
5c3a0fd7 JP	446	int fib6_rules_init(void);
5c3a0fd7 JP	447	void fib6_rules_cleanup(void);
e3ea9731	448	bool fib6_rule_default(const struct fib_rule *rule);
dcb18f76 IS	449	int fib6_rules_dump(struct net net, struct notifier_block nb);
dcb18f76 IS	450	unsigned int fib6_rules_seq_read(struct net *net);
5e5d6fed RP	451
	452	static inline bool fib6_rules_early_flow_dissect(struct net *net,
	453	struct sk_buff *skb,
	454	struct flowi6 *fl6,
	455	struct flow_keys *flkeys)
	456	{
	457	unsigned int flag = FLOW_DISSECTOR_F_STOP_AT_ENCAP;
	458
	459	if (!net->ipv6.fib6_rules_require_fldissect)
	460	return false;
	461
	462	skb_flow_dissect_flow_keys(skb, flkeys, flag);
	463	fl6->fl6_sport = flkeys->ports.src;
	464	fl6->fl6_dport = flkeys->ports.dst;
	465	fl6->flowi6_proto = flkeys->basic.ip_proto;
	466
	467	return true;
	468	}
7e5449c2 DL	469	#else
	470	static inline int fib6_rules_init(void)
	471	{
	472	return 0;
	473	}
	474	static inline void fib6_rules_cleanup(void)
	475	{
	476	return ;
	477	}
e3ea9731 IS	478	static inline bool fib6_rule_default(const struct fib_rule *rule)
	479	{
	480	return true;
	481	}
dcb18f76 IS	482	static inline int fib6_rules_dump(struct net net, struct notifier_block nb)
	483	{
	484	return 0;
	485	}
	486	static inline unsigned int fib6_rules_seq_read(struct net *net)
	487	{
	488	return 0;
	489	}
5e5d6fed RP	490	static inline bool fib6_rules_early_flow_dissect(struct net *net,
	491	struct sk_buff *skb,
	492	struct flowi6 *fl6,
	493	struct flow_keys *flkeys)
	494	{
	495	return false;
	496	}
7e5449c2	497	#endif
1da177e4	498	#endif