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

/* SPDX-License-Identifier: GPL-2.0 */
/*
 * net/dst.h	Protocol independent destination cache definitions.
 *
 * Authors:	Alexey Kuznetsov, <kuznet@ms2.inr.ac.ru>
 *
 */

#ifndef _NET_DST_H
#define _NET_DST_H

#include <net/dst_ops.h>
#include <linux/netdevice.h>
#include <linux/rtnetlink.h>
#include <linux/rcupdate.h>
#include <linux/bug.h>
#include <linux/jiffies.h>
#include <linux/refcount.h>
#include <net/neighbour.h>
#include <asm/processor.h>

#define DST_GC_MIN	(HZ/10)
#define DST_GC_INC	(HZ/2)
#define DST_GC_MAX	(120*HZ)

/* Each dst_entry has reference count and sits in some parent list(s).
 * When it is removed from parent list, it is "freed" (dst_free).
 * After this it enters dead state (dst->obsolete > 0) and if its refcnt
 * is zero, it can be destroyed immediately, otherwise it is added
 * to gc list and garbage collector periodically checks the refcnt.
 */

struct sk_buff;

struct dst_entry {
	struct net_device       *dev;
	struct rcu_head		rcu_head;
	struct dst_entry	*child;
	struct  dst_ops	        *ops;
	unsigned long		_metrics;
	unsigned long           expires;
	struct dst_entry	*path;
	struct dst_entry	*from;
#ifdef CONFIG_XFRM
	struct xfrm_state	*xfrm;
#else
	void			*__pad1;
#endif
	int			(*input)(struct sk_buff *);
	int			(*output)(struct net *net, struct sock *sk, struct sk_buff *skb);

	unsigned short		flags;
#define DST_HOST		0x0001
#define DST_NOXFRM		0x0002
#define DST_NOPOLICY		0x0004
#define DST_NOCOUNT		0x0008
#define DST_FAKE_RTABLE		0x0010
#define DST_XFRM_TUNNEL		0x0020
#define DST_XFRM_QUEUE		0x0040
#define DST_METADATA		0x0080

	short			error;

	/* A non-zero value of dst->obsolete forces by-hand validation
	 * of the route entry.  Positive values are set by the generic
	 * dst layer to indicate that the entry has been forcefully
	 * destroyed.
	 *
	 * Negative values are used by the implementation layer code to
	 * force invocation of the dst_ops->check() method.
	 */
	short			obsolete;
#define DST_OBSOLETE_NONE	0
#define DST_OBSOLETE_DEAD	2
#define DST_OBSOLETE_FORCE_CHK	-1
#define DST_OBSOLETE_KILL	-2
	unsigned short		header_len;	/* more space at head required */
	unsigned short		trailer_len;	/* space to reserve at tail */
	unsigned short		__pad3;

#ifdef CONFIG_IP_ROUTE_CLASSID
	__u32			tclassid;
#else
	__u32			__pad2;
#endif

#ifdef CONFIG_64BIT
	/*
	 * Align __refcnt to a 64 bytes alignment
	 * (L1_CACHE_SIZE would be too much)
	 */
	long			__pad_to_align_refcnt[2];
#endif
	/*
	 * __refcnt wants to be on a different cache line from
	 * input/output/ops or performance tanks badly
	 */
	atomic_t		__refcnt;	/* client references	*/
	int			__use;
	unsigned long		lastuse;
	struct lwtunnel_state   *lwtstate;
	union {
		struct dst_entry	*next;
		struct rtable __rcu	*rt_next;
		struct rt6_info __rcu	*rt6_next;
		struct dn_route __rcu	*dn_next;
	};
};

struct dst_metrics {
	u32		metrics[RTAX_MAX];
	refcount_t	refcnt;
} __aligned(4);		/* Low pointer bits contain DST_METRICS_FLAGS */
extern const struct dst_metrics dst_default_metrics;

u32 *dst_cow_metrics_generic(struct dst_entry *dst, unsigned long old);

#define DST_METRICS_READ_ONLY		0x1UL
#define DST_METRICS_REFCOUNTED		0x2UL
#define DST_METRICS_FLAGS		0x3UL
#define __DST_METRICS_PTR(Y)	\
	((u32 *)((Y) & ~DST_METRICS_FLAGS))
#define DST_METRICS_PTR(X)	__DST_METRICS_PTR((X)->_metrics)

static inline bool dst_metrics_read_only(const struct dst_entry *dst)
{
	return dst->_metrics & DST_METRICS_READ_ONLY;
}

void __dst_destroy_metrics_generic(struct dst_entry *dst, unsigned long old);

static inline void dst_destroy_metrics_generic(struct dst_entry *dst)
{
	unsigned long val = dst->_metrics;
	if (!(val & DST_METRICS_READ_ONLY))
		__dst_destroy_metrics_generic(dst, val);
}

static inline u32 *dst_metrics_write_ptr(struct dst_entry *dst)
{
	unsigned long p = dst->_metrics;

	BUG_ON(!p);

	if (p & DST_METRICS_READ_ONLY)
		return dst->ops->cow_metrics(dst, p);
	return __DST_METRICS_PTR(p);
}

/* This may only be invoked before the entry has reached global
 * visibility.
 */
static inline void dst_init_metrics(struct dst_entry *dst,
				    const u32 *src_metrics,
				    bool read_only)
{
	dst->_metrics = ((unsigned long) src_metrics) |
		(read_only ? DST_METRICS_READ_ONLY : 0);
}

static inline void dst_copy_metrics(struct dst_entry *dest, const struct dst_entry *src)
{
	u32 *dst_metrics = dst_metrics_write_ptr(dest);

	if (dst_metrics) {
		u32 *src_metrics = DST_METRICS_PTR(src);

		memcpy(dst_metrics, src_metrics, RTAX_MAX * sizeof(u32));
	}
}

static inline u32 *dst_metrics_ptr(struct dst_entry *dst)
{
	return DST_METRICS_PTR(dst);
}

static inline u32
dst_metric_raw(const struct dst_entry *dst, const int metric)
{
	u32 *p = DST_METRICS_PTR(dst);

	return p[metric-1];
}

static inline u32
dst_metric(const struct dst_entry *dst, const int metric)
{
	WARN_ON_ONCE(metric == RTAX_HOPLIMIT ||
		     metric == RTAX_ADVMSS ||
		     metric == RTAX_MTU);
	return dst_metric_raw(dst, metric);
}

static inline u32
dst_metric_advmss(const struct dst_entry *dst)
{
	u32 advmss = dst_metric_raw(dst, RTAX_ADVMSS);

	if (!advmss)
		advmss = dst->ops->default_advmss(dst);

	return advmss;
}

static inline void dst_metric_set(struct dst_entry *dst, int metric, u32 val)
{
	u32 *p = dst_metrics_write_ptr(dst);

	if (p)
		p[metric-1] = val;
}

/* Kernel-internal feature bits that are unallocated in user space. */
#define DST_FEATURE_ECN_CA	(1 << 31)

#define DST_FEATURE_MASK	(DST_FEATURE_ECN_CA)
#define DST_FEATURE_ECN_MASK	(DST_FEATURE_ECN_CA | RTAX_FEATURE_ECN)

static inline u32
dst_feature(const struct dst_entry *dst, u32 feature)
{
	return dst_metric(dst, RTAX_FEATURES) & feature;
}

static inline u32 dst_mtu(const struct dst_entry *dst)
{
	return dst->ops->mtu(dst);
}

/* RTT metrics are stored in milliseconds for user ABI, but used as jiffies */
static inline unsigned long dst_metric_rtt(const struct dst_entry *dst, int metric)
{
	return msecs_to_jiffies(dst_metric(dst, metric));
}

static inline u32
dst_allfrag(const struct dst_entry *dst)
{
	int ret = dst_feature(dst,  RTAX_FEATURE_ALLFRAG);
	return ret;
}

static inline int
dst_metric_locked(const struct dst_entry *dst, int metric)
{
	return dst_metric(dst, RTAX_LOCK) & (1<<metric);
}

static inline void dst_hold(struct dst_entry *dst)
{
	/*
	 * If your kernel compilation stops here, please check
	 * __pad_to_align_refcnt declaration in struct dst_entry
	 */
	BUILD_BUG_ON(offsetof(struct dst_entry, __refcnt) & 63);
	WARN_ON(atomic_inc_not_zero(&dst->__refcnt) == 0);
}

static inline void dst_use_noref(struct dst_entry *dst, unsigned long time)
{
	if (unlikely(time != dst->lastuse)) {
		dst->__use++;
		dst->lastuse = time;
	}
}

static inline void dst_hold_and_use(struct dst_entry *dst, unsigned long time)
{
	dst_hold(dst);
	dst_use_noref(dst, time);
}

static inline struct dst_entry *dst_clone(struct dst_entry *dst)
{
	if (dst)
		dst_hold(dst);
	return dst;
}

void dst_release(struct dst_entry *dst);

void dst_release_immediate(struct dst_entry *dst);

static inline void refdst_drop(unsigned long refdst)
{
	if (!(refdst & SKB_DST_NOREF))
		dst_release((struct dst_entry *)(refdst & SKB_DST_PTRMASK));
}

/**
 * skb_dst_drop - drops skb dst
 * @skb: buffer
 *
 * Drops dst reference count if a reference was taken.
 */
static inline void skb_dst_drop(struct sk_buff *skb)
{
	if (skb->_skb_refdst) {
		refdst_drop(skb->_skb_refdst);
		skb->_skb_refdst = 0UL;
	}
}

static inline void __skb_dst_copy(struct sk_buff *nskb, unsigned long refdst)
{
	nskb->_skb_refdst = refdst;
	if (!(nskb->_skb_refdst & SKB_DST_NOREF))
		dst_clone(skb_dst(nskb));
}

static inline void skb_dst_copy(struct sk_buff *nskb, const struct sk_buff *oskb)
{
	__skb_dst_copy(nskb, oskb->_skb_refdst);
}

/**
 * dst_hold_safe - Take a reference on a dst if possible
 * @dst: pointer to dst entry
 *
 * This helper returns false if it could not safely
 * take a reference on a dst.
 */
static inline bool dst_hold_safe(struct dst_entry *dst)
{
	return atomic_inc_not_zero(&dst->__refcnt);
}

/**
 * skb_dst_force - makes sure skb dst is refcounted
 * @skb: buffer
 *
 * If dst is not yet refcounted and not destroyed, grab a ref on it.
 * Returns true if dst is refcounted.
 */
static inline bool skb_dst_force(struct sk_buff *skb)
{
	if (skb_dst_is_noref(skb)) {
		struct dst_entry *dst = skb_dst(skb);

		WARN_ON(!rcu_read_lock_held());
		if (!dst_hold_safe(dst))
			dst = NULL;

		skb->_skb_refdst = (unsigned long)dst;
	}

	return skb->_skb_refdst != 0UL;
}


/**
 *	__skb_tunnel_rx - prepare skb for rx reinsert
 *	@skb: buffer
 *	@dev: tunnel device
 *	@net: netns for packet i/o
 *
 *	After decapsulation, packet is going to re-enter (netif_rx()) our stack,
 *	so make some cleanups. (no accounting done)
 */
static inline void __skb_tunnel_rx(struct sk_buff *skb, struct net_device *dev,
				   struct net *net)
{
	skb->dev = dev;

	/*
	 * Clear hash so that we can recalulate the hash for the
	 * encapsulated packet, unless we have already determine the hash
	 * over the L4 4-tuple.
	 */
	skb_clear_hash_if_not_l4(skb);
	skb_set_queue_mapping(skb, 0);
	skb_scrub_packet(skb, !net_eq(net, dev_net(dev)));
}

/**
 *	skb_tunnel_rx - prepare skb for rx reinsert
 *	@skb: buffer
 *	@dev: tunnel device
 *
 *	After decapsulation, packet is going to re-enter (netif_rx()) our stack,
 *	so make some cleanups, and perform accounting.
 *	Note: this accounting is not SMP safe.
 */
static inline void skb_tunnel_rx(struct sk_buff *skb, struct net_device *dev,
				 struct net *net)
{
	/* TODO : stats should be SMP safe */
	dev->stats.rx_packets++;
	dev->stats.rx_bytes += skb->len;
	__skb_tunnel_rx(skb, dev, net);
}

static inline u32 dst_tclassid(const struct sk_buff *skb)
{
#ifdef CONFIG_IP_ROUTE_CLASSID
	const struct dst_entry *dst;

	dst = skb_dst(skb);
	if (dst)
		return dst->tclassid;
#endif
	return 0;
}

int dst_discard_out(struct net *net, struct sock *sk, struct sk_buff *skb);
static inline int dst_discard(struct sk_buff *skb)
{
	return dst_discard_out(&init_net, skb->sk, skb);
}
void *dst_alloc(struct dst_ops *ops, struct net_device *dev, int initial_ref,
		int initial_obsolete, unsigned short flags);
void dst_init(struct dst_entry *dst, struct dst_ops *ops,
	      struct net_device *dev, int initial_ref, int initial_obsolete,
	      unsigned short flags);
struct dst_entry *dst_destroy(struct dst_entry *dst);
void dst_dev_put(struct dst_entry *dst);

static inline void dst_confirm(struct dst_entry *dst)
{
}

static inline struct neighbour *dst_neigh_lookup(const struct dst_entry *dst, const void *daddr)
{
	struct neighbour *n = dst->ops->neigh_lookup(dst, NULL, daddr);
	return IS_ERR(n) ? NULL : n;
}

static inline struct neighbour *dst_neigh_lookup_skb(const struct dst_entry *dst,
						     struct sk_buff *skb)
{
	struct neighbour *n =  dst->ops->neigh_lookup(dst, skb, NULL);
	return IS_ERR(n) ? NULL : n;
}

static inline void dst_confirm_neigh(const struct dst_entry *dst,
				     const void *daddr)
{
	if (dst->ops->confirm_neigh)
		dst->ops->confirm_neigh(dst, daddr);
}

static inline void dst_link_failure(struct sk_buff *skb)
{
	struct dst_entry *dst = skb_dst(skb);
	if (dst && dst->ops && dst->ops->link_failure)
		dst->ops->link_failure(skb);
}

static inline void dst_set_expires(struct dst_entry *dst, int timeout)
{
	unsigned long expires = jiffies + timeout;

	if (expires == 0)
		expires = 1;

	if (dst->expires == 0 || time_before(expires, dst->expires))
		dst->expires = expires;
}

/* Output packet to network from transport.  */
static inline int dst_output(struct net *net, struct sock *sk, struct sk_buff *skb)
{
	return skb_dst(skb)->output(net, sk, skb);
}

/* Input packet from network to transport.  */
static inline int dst_input(struct sk_buff *skb)
{
	return skb_dst(skb)->input(skb);
}

static inline struct dst_entry *dst_check(struct dst_entry *dst, u32 cookie)
{
	if (dst->obsolete)
		dst = dst->ops->check(dst, cookie);
	return dst;
}

/* Flags for xfrm_lookup flags argument. */
enum {
	XFRM_LOOKUP_ICMP = 1 << 0,
	XFRM_LOOKUP_QUEUE = 1 << 1,
	XFRM_LOOKUP_KEEP_DST_REF = 1 << 2,
};

struct flowi;
#ifndef CONFIG_XFRM
static inline struct dst_entry *xfrm_lookup(struct net *net,
					    struct dst_entry *dst_orig,
					    const struct flowi *fl,
					    const struct sock *sk,
					    int flags)
{
	return dst_orig;
}

static inline struct dst_entry *xfrm_lookup_route(struct net *net,
						  struct dst_entry *dst_orig,
						  const struct flowi *fl,
						  const struct sock *sk,
						  int flags)
{
	return dst_orig;
}

static inline struct xfrm_state *dst_xfrm(const struct dst_entry *dst)
{
	return NULL;
}

#else
struct dst_entry *xfrm_lookup(struct net *net, struct dst_entry *dst_orig,
			      const struct flowi *fl, const struct sock *sk,
			      int flags);

struct dst_entry *xfrm_lookup_route(struct net *net, struct dst_entry *dst_orig,
				    const struct flowi *fl, const struct sock *sk,
				    int flags);

/* skb attached with this dst needs transformation if dst->xfrm is valid */
static inline struct xfrm_state *dst_xfrm(const struct dst_entry *dst)
{
	return dst->xfrm;
}
#endif

static inline void skb_dst_update_pmtu(struct sk_buff *skb, u32 mtu)
{
	struct dst_entry *dst = skb_dst(skb);

	if (dst && dst->ops->update_pmtu)
		dst->ops->update_pmtu(dst, NULL, skb, mtu);
}

#endif /* _NET_DST_H */
Commit	Line	Data
b2441318	1	/* SPDX-License-Identifier: GPL-2.0 */
1da177e4 LT	2	/*
	3	* net/dst.h Protocol independent destination cache definitions.
	4	*
	5	* Authors: Alexey Kuznetsov, <kuznet@ms2.inr.ac.ru>
	6	*
	7	*/
	8
	9	#ifndef _NET_DST_H
	10	#define _NET_DST_H
	11
86393e52	12	#include <net/dst_ops.h>
14c85021	13	#include <linux/netdevice.h>
1da177e4 LT	14	#include <linux/rtnetlink.h>
1da177e4 LT	15	#include <linux/rcupdate.h>
187f1882	16	#include <linux/bug.h>
1da177e4	17	#include <linux/jiffies.h>
9620fef2	18	#include <linux/refcount.h>
1da177e4 LT	19	#include <net/neighbour.h>
	20	#include <asm/processor.h>
	21
1da177e4 LT	22	#define DST_GC_MIN (HZ/10)
	23	#define DST_GC_INC (HZ/2)
	24	#define DST_GC_MAX (120*HZ)
	25
	26	/* Each dst_entry has reference count and sits in some parent list(s).
	27	* When it is removed from parent list, it is "freed" (dst_free).
	28	* After this it enters dead state (dst->obsolete > 0) and if its refcnt
	29	* is zero, it can be destroyed immediately, otherwise it is added
	30	* to gc list and garbage collector periodically checks the refcnt.
	31	*/
	32
	33	struct sk_buff;
	34
fd2c3ef7	35	struct dst_entry {
66727145	36	struct net_device *dev;
1e19e02c	37	struct rcu_head rcu_head;
1da177e4	38	struct dst_entry *child;
62fa8a84 DM	39	struct dst_ops *ops;
62fa8a84 DM	40	unsigned long _metrics;
ecd98837	41	unsigned long expires;
f1dd9c37	42	struct dst_entry *path;
ecd98837	43	struct dst_entry *from;
def8b4fa	44	#ifdef CONFIG_XFRM
1da177e4	45	struct xfrm_state *xfrm;
5635c10d ED	46	#else
5635c10d ED	47	void *__pad1;
def8b4fa	48	#endif
7f95e188	49	int (input)(struct sk_buff );
ede2059d	50	int (output)(struct net net, struct sock sk, struct sk_buff skb);
1da177e4	51
5110effe	52	unsigned short flags;
f6b72b62 DM	53	#define DST_HOST 0x0001
	54	#define DST_NOXFRM 0x0002
	55	#define DST_NOPOLICY 0x0004
1eb04e7c WW	56	#define DST_NOCOUNT 0x0008
	57	#define DST_FAKE_RTABLE 0x0010
	58	#define DST_XFRM_TUNNEL 0x0020
	59	#define DST_XFRM_QUEUE 0x0040
	60	#define DST_METADATA 0x0080
f6b72b62	61
62fa8a84	62	short error;
f5b0a874 DM	63
	64	/* A non-zero value of dst->obsolete forces by-hand validation
	65	* of the route entry. Positive values are set by the generic
	66	* dst layer to indicate that the entry has been forcefully
	67	* destroyed.
	68	*
	69	* Negative values are used by the implementation layer code to
	70	* force invocation of the dst_ops->check() method.
	71	*/
62fa8a84	72	short obsolete;
f5b0a874 DM	73	#define DST_OBSOLETE_NONE 0
	74	#define DST_OBSOLETE_DEAD 2
	75	#define DST_OBSOLETE_FORCE_CHK -1
ceb33206	76	#define DST_OBSOLETE_KILL -2
62fa8a84 DM	77	unsigned short header_len; /* more space at head required */
62fa8a84 DM	78	unsigned short trailer_len; /* space to reserve at tail */
51ce8bd4 JA	79	unsigned short __pad3;
51ce8bd4 JA	80
c7066f70	81	#ifdef CONFIG_IP_ROUTE_CLASSID
f1dd9c37	82	__u32 tclassid;
5635c10d ED	83	#else
5635c10d ED	84	__u32 __pad2;
f1dd9c37 ZY	85	#endif
f1dd9c37 ZY	86
751a587a	87	#ifdef CONFIG_64BIT
5635c10d ED	88	/*
	89	* Align __refcnt to a 64 bytes alignment
	90	* (L1_CACHE_SIZE would be too much)
	91	*/
0868e253	92	long __pad_to_align_refcnt[2];
5635c10d	93	#endif
f1dd9c37 ZY	94	/*
	95	* __refcnt wants to be on a different cache line from
	96	* input/output/ops or performance tanks badly
	97	*/
1e19e02c ED	98	atomic_t __refcnt; /* client references */
1e19e02c ED	99	int __use;
f1dd9c37	100	unsigned long lastuse;
751a587a	101	struct lwtunnel_state *lwtstate;
1e19e02c	102	union {
fc766e4c ED	103	struct dst_entry *next;
fc766e4c ED	104	struct rtable __rcu *rt_next;
66f5d6ce	105	struct rt6_info __rcu *rt6_next;
fc766e4c	106	struct dn_route __rcu *dn_next;
1e19e02c	107	};
1da177e4 LT	108	};
1da177e4 LT	109
3fb07daf ED	110	struct dst_metrics {
3fb07daf ED	111	u32 metrics[RTAX_MAX];
9620fef2	112	refcount_t refcnt;
60c26a50	113	} __aligned(4); /* Low pointer bits contain DST_METRICS_FLAGS */
3fb07daf ED	114	extern const struct dst_metrics dst_default_metrics;
3fb07daf ED	115
a4023dd0	116	u32 dst_cow_metrics_generic(struct dst_entry dst, unsigned long old);
62fa8a84	117
e5fd387a	118	#define DST_METRICS_READ_ONLY 0x1UL
3fb07daf	119	#define DST_METRICS_REFCOUNTED 0x2UL
e5fd387a	120	#define DST_METRICS_FLAGS 0x3UL
62fa8a84	121	#define __DST_METRICS_PTR(Y) \
e5fd387a	122	((u32 *)((Y) & ~DST_METRICS_FLAGS))
62fa8a84 DM	123	#define DST_METRICS_PTR(X) __DST_METRICS_PTR((X)->_metrics)
	124
	125	static inline bool dst_metrics_read_only(const struct dst_entry *dst)
	126	{
	127	return dst->_metrics & DST_METRICS_READ_ONLY;
	128	}
	129
a4023dd0	130	void __dst_destroy_metrics_generic(struct dst_entry *dst, unsigned long old);
62fa8a84 DM	131
	132	static inline void dst_destroy_metrics_generic(struct dst_entry *dst)
	133	{
	134	unsigned long val = dst->_metrics;
	135	if (!(val & DST_METRICS_READ_ONLY))
	136	__dst_destroy_metrics_generic(dst, val);
	137	}
	138
	139	static inline u32 dst_metrics_write_ptr(struct dst_entry dst)
	140	{
	141	unsigned long p = dst->_metrics;
	142
1f37070d SH	143	BUG_ON(!p);
1f37070d SH	144
62fa8a84 DM	145	if (p & DST_METRICS_READ_ONLY)
	146	return dst->ops->cow_metrics(dst, p);
	147	return __DST_METRICS_PTR(p);
	148	}
	149
	150	/* This may only be invoked before the entry has reached global
	151	* visibility.
	152	*/
	153	static inline void dst_init_metrics(struct dst_entry *dst,
	154	const u32 *src_metrics,
	155	bool read_only)
	156	{
	157	dst->_metrics = ((unsigned long) src_metrics) \|
	158	(read_only ? DST_METRICS_READ_ONLY : 0);
	159	}
	160
	161	static inline void dst_copy_metrics(struct dst_entry dest, const struct dst_entry src)
	162	{
	163	u32 *dst_metrics = dst_metrics_write_ptr(dest);
	164
	165	if (dst_metrics) {
	166	u32 *src_metrics = DST_METRICS_PTR(src);
	167
	168	memcpy(dst_metrics, src_metrics, RTAX_MAX * sizeof(u32));
	169	}
	170	}
	171
	172	static inline u32 dst_metrics_ptr(struct dst_entry dst)
	173	{
	174	return DST_METRICS_PTR(dst);
	175	}
	176
1da177e4	177	static inline u32
5170ae82	178	dst_metric_raw(const struct dst_entry *dst, const int metric)
1da177e4	179	{
62fa8a84 DM	180	u32 *p = DST_METRICS_PTR(dst);
	181
	182	return p[metric-1];
defb3519 DM	183	}
defb3519 DM	184
5170ae82 DM	185	static inline u32
	186	dst_metric(const struct dst_entry *dst, const int metric)
	187	{
0dbaee3b	188	WARN_ON_ONCE(metric == RTAX_HOPLIMIT \|\|
d33e4553 DM	189	metric == RTAX_ADVMSS \|\|
d33e4553 DM	190	metric == RTAX_MTU);
5170ae82 DM	191	return dst_metric_raw(dst, metric);
	192	}
	193
0dbaee3b DM	194	static inline u32
	195	dst_metric_advmss(const struct dst_entry *dst)
	196	{
	197	u32 advmss = dst_metric_raw(dst, RTAX_ADVMSS);
	198
	199	if (!advmss)
	200	advmss = dst->ops->default_advmss(dst);
	201
	202	return advmss;
	203	}
	204
defb3519 DM	205	static inline void dst_metric_set(struct dst_entry *dst, int metric, u32 val)
defb3519 DM	206	{
62fa8a84	207	u32 *p = dst_metrics_write_ptr(dst);
defb3519	208
62fa8a84 DM	209	if (p)
62fa8a84 DM	210	p[metric-1] = val;
1da177e4 LT	211	}
1da177e4 LT	212
c3a8d947 DB	213	/* Kernel-internal feature bits that are unallocated in user space. */
	214	#define DST_FEATURE_ECN_CA (1 << 31)
	215
	216	#define DST_FEATURE_MASK (DST_FEATURE_ECN_CA)
	217	#define DST_FEATURE_ECN_MASK (DST_FEATURE_ECN_CA \| RTAX_FEATURE_ECN)
	218
0c3adfb8 GBY	219	static inline u32
	220	dst_feature(const struct dst_entry *dst, u32 feature)
	221	{
bb5b7c11	222	return dst_metric(dst, RTAX_FEATURES) & feature;
0c3adfb8 GBY	223	}
0c3adfb8 GBY	224
1da177e4 LT	225	static inline u32 dst_mtu(const struct dst_entry *dst)
1da177e4 LT	226	{
618f9bc7	227	return dst->ops->mtu(dst);
1da177e4 LT	228	}
1da177e4 LT	229
c1e20f7c SH	230	/* RTT metrics are stored in milliseconds for user ABI, but used as jiffies */
	231	static inline unsigned long dst_metric_rtt(const struct dst_entry *dst, int metric)
	232	{
	233	return msecs_to_jiffies(dst_metric(dst, metric));
	234	}
	235
1da177e4 LT	236	static inline u32
	237	dst_allfrag(const struct dst_entry *dst)
	238	{
0c3adfb8	239	int ret = dst_feature(dst, RTAX_FEATURE_ALLFRAG);
1da177e4 LT	240	return ret;
	241	}
	242
	243	static inline int
d33e4553	244	dst_metric_locked(const struct dst_entry *dst, int metric)
1da177e4 LT	245	{
	246	return dst_metric(dst, RTAX_LOCK) & (1<<metric);
	247	}
	248
7f95e188	249	static inline void dst_hold(struct dst_entry *dst)
1da177e4	250	{
5635c10d ED	251	/*
	252	* If your kernel compilation stops here, please check
	253	* __pad_to_align_refcnt declaration in struct dst_entry
	254	*/
	255	BUILD_BUG_ON(offsetof(struct dst_entry, __refcnt) & 63);
44ebe791	256	WARN_ON(atomic_inc_not_zero(&dst->__refcnt) == 0);
1da177e4 LT	257	}
1da177e4 LT	258
0da4af00	259	static inline void dst_use_noref(struct dst_entry *dst, unsigned long time)
03f49f34	260	{
32d18ab1	261	if (unlikely(time != dst->lastuse)) {
0da4af00 WW	262	dst->__use++;
	263	dst->lastuse = time;
	264	}
03f49f34 PE	265	}
03f49f34 PE	266
0da4af00	267	static inline void dst_hold_and_use(struct dst_entry *dst, unsigned long time)
7fee226a	268	{
0da4af00 WW	269	dst_hold(dst);
0da4af00 WW	270	dst_use_noref(dst, time);
7fee226a ED	271	}
7fee226a ED	272
7f95e188	273	static inline struct dst_entry dst_clone(struct dst_entry dst)
1da177e4 LT	274	{
1da177e4 LT	275	if (dst)
222d7dbd	276	dst_hold(dst);
1da177e4 LT	277	return dst;
	278	}
	279
a4023dd0	280	void dst_release(struct dst_entry *dst);
7fee226a	281
5f56f409 WW	282	void dst_release_immediate(struct dst_entry *dst);
5f56f409 WW	283
7fee226a ED	284	static inline void refdst_drop(unsigned long refdst)
	285	{
	286	if (!(refdst & SKB_DST_NOREF))
	287	dst_release((struct dst_entry *)(refdst & SKB_DST_PTRMASK));
	288	}
	289
	290	/**
	291	* skb_dst_drop - drops skb dst
	292	* @skb: buffer
	293	*
	294	* Drops dst reference count if a reference was taken.
	295	*/
adf30907 ED	296	static inline void skb_dst_drop(struct sk_buff *skb)
adf30907 ED	297	{
7fee226a ED	298	if (skb->_skb_refdst) {
	299	refdst_drop(skb->_skb_refdst);
	300	skb->_skb_refdst = 0UL;
	301	}
	302	}
	303
e79e2595	304	static inline void __skb_dst_copy(struct sk_buff *nskb, unsigned long refdst)
7fee226a	305	{
e79e2595	306	nskb->_skb_refdst = refdst;
7fee226a ED	307	if (!(nskb->_skb_refdst & SKB_DST_NOREF))
	308	dst_clone(skb_dst(nskb));
	309	}
	310
e79e2595 JS	311	static inline void skb_dst_copy(struct sk_buff nskb, const struct sk_buff oskb)
	312	{
	313	__skb_dst_copy(nskb, oskb->_skb_refdst);
	314	}
	315
5037e9ef ED	316	/**
	317	* dst_hold_safe - Take a reference on a dst if possible
	318	* @dst: pointer to dst entry
	319	*
	320	* This helper returns false if it could not safely
	321	* take a reference on a dst.
	322	*/
	323	static inline bool dst_hold_safe(struct dst_entry *dst)
	324	{
b2a9c0ed	325	return atomic_inc_not_zero(&dst->__refcnt);
5037e9ef ED	326	}
	327
	328	/**
222d7dbd	329	* skb_dst_force - makes sure skb dst is refcounted
5037e9ef ED	330	* @skb: buffer
	331	*
	332	* If dst is not yet refcounted and not destroyed, grab a ref on it.
0face484	333	* Returns true if dst is refcounted.
5037e9ef	334	*/
0face484	335	static inline bool skb_dst_force(struct sk_buff *skb)
5037e9ef ED	336	{
	337	if (skb_dst_is_noref(skb)) {
	338	struct dst_entry *dst = skb_dst(skb);
	339
222d7dbd	340	WARN_ON(!rcu_read_lock_held());
5037e9ef ED	341	if (!dst_hold_safe(dst))
	342	dst = NULL;
	343
	344	skb->_skb_refdst = (unsigned long)dst;
	345	}
0face484 FW	346
0face484 FW	347	return skb->_skb_refdst != 0UL;
5037e9ef ED	348	}
5037e9ef ED	349
d19d56dd	350
290b895e ED	351	/**
	352	* __skb_tunnel_rx - prepare skb for rx reinsert
	353	* @skb: buffer
	354	* @dev: tunnel device
ea23192e	355	* @net: netns for packet i/o
290b895e ED	356	*
	357	* After decapsulation, packet is going to re-enter (netif_rx()) our stack,
	358	* so make some cleanups. (no accounting done)
	359	*/
ea23192e ND	360	static inline void __skb_tunnel_rx(struct sk_buff skb, struct net_device dev,
ea23192e ND	361	struct net *net)
290b895e ED	362	{
290b895e ED	363	skb->dev = dev;
bdeab991 TH	364
bdeab991 TH	365	/*
7539fadc	366	* Clear hash so that we can recalulate the hash for the
bdeab991 TH	367	* encapsulated packet, unless we have already determine the hash
	368	* over the L4 4-tuple.
	369	*/
7539fadc	370	skb_clear_hash_if_not_l4(skb);
290b895e	371	skb_set_queue_mapping(skb, 0);
ea23192e	372	skb_scrub_packet(skb, !net_eq(net, dev_net(dev)));
290b895e ED	373	}
290b895e ED	374
d19d56dd ED	375	/**
	376	* skb_tunnel_rx - prepare skb for rx reinsert
	377	* @skb: buffer
	378	* @dev: tunnel device
	379	*
	380	* After decapsulation, packet is going to re-enter (netif_rx()) our stack,
	381	* so make some cleanups, and perform accounting.
290b895e	382	* Note: this accounting is not SMP safe.
d19d56dd	383	*/
ea23192e ND	384	static inline void skb_tunnel_rx(struct sk_buff skb, struct net_device dev,
ea23192e ND	385	struct net *net)
d19d56dd	386	{
d19d56dd ED	387	/* TODO : stats should be SMP safe */
	388	dev->stats.rx_packets++;
	389	dev->stats.rx_bytes += skb->len;
ea23192e	390	__skb_tunnel_rx(skb, dev, net);
d19d56dd ED	391	}
d19d56dd ED	392
808c1b69 DB	393	static inline u32 dst_tclassid(const struct sk_buff *skb)
	394	{
	395	#ifdef CONFIG_IP_ROUTE_CLASSID
	396	const struct dst_entry *dst;
	397
	398	dst = skb_dst(skb);
	399	if (dst)
	400	return dst->tclassid;
	401	#endif
	402	return 0;
	403	}
	404
ede2059d	405	int dst_discard_out(struct net net, struct sock sk, struct sk_buff *skb);
aad88724 ED	406	static inline int dst_discard(struct sk_buff *skb)
aad88724 ED	407	{
ede2059d	408	return dst_discard_out(&init_net, skb->sk, skb);
aad88724	409	}
a4023dd0 JP	410	void dst_alloc(struct dst_ops ops, struct net_device *dev, int initial_ref,
a4023dd0 JP	411	int initial_obsolete, unsigned short flags);
f38a9eb1 TG	412	void dst_init(struct dst_entry dst, struct dst_ops ops,
	413	struct net_device *dev, int initial_ref, int initial_obsolete,
	414	unsigned short flags);
a4023dd0	415	struct dst_entry dst_destroy(struct dst_entry dst);
4a6ce2b6	416	void dst_dev_put(struct dst_entry *dst);
1da177e4	417
1da177e4 LT	418	static inline void dst_confirm(struct dst_entry *dst)
1da177e4 LT	419	{
5110effe	420	}
f2c31e32	421
d3aaeb38 DM	422	static inline struct neighbour dst_neigh_lookup(const struct dst_entry dst, const void *daddr)
d3aaeb38 DM	423	{
aaa0c23c ZZ	424	struct neighbour *n = dst->ops->neigh_lookup(dst, NULL, daddr);
aaa0c23c ZZ	425	return IS_ERR(n) ? NULL : n;
f894cbf8 DM	426	}
	427
	428	static inline struct neighbour dst_neigh_lookup_skb(const struct dst_entry dst,
	429	struct sk_buff *skb)
	430	{
aaa0c23c ZZ	431	struct neighbour *n = dst->ops->neigh_lookup(dst, skb, NULL);
aaa0c23c ZZ	432	return IS_ERR(n) ? NULL : n;
d3aaeb38 DM	433	}
d3aaeb38 DM	434
63fca65d JA	435	static inline void dst_confirm_neigh(const struct dst_entry *dst,
	436	const void *daddr)
	437	{
	438	if (dst->ops->confirm_neigh)
	439	dst->ops->confirm_neigh(dst, daddr);
	440	}
	441
1da177e4 LT	442	static inline void dst_link_failure(struct sk_buff *skb)
1da177e4 LT	443	{
adf30907	444	struct dst_entry *dst = skb_dst(skb);
1da177e4 LT	445	if (dst && dst->ops && dst->ops->link_failure)
	446	dst->ops->link_failure(skb);
	447	}
	448
	449	static inline void dst_set_expires(struct dst_entry *dst, int timeout)
	450	{
	451	unsigned long expires = jiffies + timeout;
	452
	453	if (expires == 0)
	454	expires = 1;
	455
	456	if (dst->expires == 0 \|\| time_before(expires, dst->expires))
	457	dst->expires = expires;
	458	}
	459
	460	/* Output packet to network from transport. */
13206b6b	461	static inline int dst_output(struct net net, struct sock sk, struct sk_buff *skb)
aad88724	462	{
ede2059d	463	return skb_dst(skb)->output(net, sk, skb);
aad88724	464	}
1da177e4 LT	465
	466	/* Input packet from network to transport. */
	467	static inline int dst_input(struct sk_buff *skb)
	468	{
adf30907	469	return skb_dst(skb)->input(skb);
1da177e4 LT	470	}
	471
	472	static inline struct dst_entry dst_check(struct dst_entry dst, u32 cookie)
	473	{
	474	if (dst->obsolete)
	475	dst = dst->ops->check(dst, cookie);
	476	return dst;
	477	}
	478
815f4e57 HX	479	/* Flags for xfrm_lookup flags argument. */
815f4e57 HX	480	enum {
80c0bc9e	481	XFRM_LOOKUP_ICMP = 1 << 0,
b8c203b2	482	XFRM_LOOKUP_QUEUE = 1 << 1,
ac37e251	483	XFRM_LOOKUP_KEEP_DST_REF = 1 << 2,
815f4e57 HX	484	};
815f4e57 HX	485
1da177e4 LT	486	struct flowi;
1da177e4 LT	487	#ifndef CONFIG_XFRM
452edd59 DM	488	static inline struct dst_entry xfrm_lookup(struct net net,
452edd59 DM	489	struct dst_entry *dst_orig,
6f9c9615 ED	490	const struct flowi *fl,
6f9c9615 ED	491	const struct sock *sk,
452edd59	492	int flags)
1da177e4	493	{
452edd59	494	return dst_orig;
f92ee619 SK	495	}
	496
	497	static inline struct dst_entry xfrm_lookup_route(struct net net,
	498	struct dst_entry *dst_orig,
	499	const struct flowi *fl,
6f9c9615	500	const struct sock *sk,
f92ee619 SK	501	int flags)
	502	{
	503	return dst_orig;
	504	}
e87b3998 VY	505
	506	static inline struct xfrm_state dst_xfrm(const struct dst_entry dst)
	507	{
	508	return NULL;
	509	}
	510
1da177e4	511	#else
a4023dd0	512	struct dst_entry xfrm_lookup(struct net net, struct dst_entry *dst_orig,
6f9c9615	513	const struct flowi fl, const struct sock sk,
a4023dd0	514	int flags);
e87b3998	515
f92ee619	516	struct dst_entry xfrm_lookup_route(struct net net, struct dst_entry *dst_orig,
6f9c9615	517	const struct flowi fl, const struct sock sk,
f92ee619 SK	518	int flags);
f92ee619 SK	519
e87b3998 VY	520	/* skb attached with this dst needs transformation if dst->xfrm is valid */
	521	static inline struct xfrm_state dst_xfrm(const struct dst_entry dst)
	522	{
	523	return dst->xfrm;
	524	}
1da177e4	525	#endif
1da177e4	526
f15ca723 ND	527	static inline void skb_dst_update_pmtu(struct sk_buff *skb, u32 mtu)
	528	{
	529	struct dst_entry *dst = skb_dst(skb);
	530
	531	if (dst && dst->ops->update_pmtu)
	532	dst->ops->update_pmtu(dst, NULL, skb, mtu);
	533	}
	534
1da177e4	535	#endif /* _NET_DST_H */