[linux-block.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>
#include <linux/indirect_call_wrapper.h>

struct sk_buff;

struct dst_entry {
	struct net_device       *dev;
	struct  dst_ops	        *ops;
	unsigned long		_metrics;
	unsigned long           expires;
#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_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

	/* 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 */

	/*
	 * __refcnt wants to be on a different cache line from
	 * input/output/ops or performance tanks badly
	 */
#ifdef CONFIG_64BIT
	atomic_t		__refcnt;	/* 64-bit offset 64 */
#endif
	int			__use;
	unsigned long		lastuse;
	struct lwtunnel_state   *lwtstate;
	struct rcu_head		rcu_head;
	short			error;
	short			__pad;
	__u32			tclassid;
#ifndef CONFIG_64BIT
	atomic_t		__refcnt;	/* 32-bit offset 64 */
#endif
	netdevice_tracker	dev_tracker;
};

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	(1U << 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;
}

INDIRECT_CALLABLE_DECLARE(unsigned int ip6_mtu(const struct dst_entry *));
INDIRECT_CALLABLE_DECLARE(unsigned int ipv4_mtu(const struct dst_entry *));
static inline u32 dst_mtu(const struct dst_entry *dst)
{
	return INDIRECT_CALL_INET(dst->ops->mtu, ip6_mtu, ipv4_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
	 * the placement of __refcnt 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->slow_gro |= !!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;
		skb->slow_gro |= !!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
 *	@net: netns for packet i/o
 *
 *	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;

	if (WARN_ON_ONCE(!dst->ops->neigh_lookup))
		return NULL;

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

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

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

INDIRECT_CALLABLE_DECLARE(struct dst_entry *ip6_dst_check(struct dst_entry *,
							  u32));
INDIRECT_CALLABLE_DECLARE(struct dst_entry *ipv4_dst_check(struct dst_entry *,
							   u32));
static inline struct dst_entry *dst_check(struct dst_entry *dst, u32 cookie)
{
	if (dst->obsolete)
		dst = INDIRECT_CALL_INET(dst->ops->check, ip6_dst_check,
					 ipv4_dst_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_with_ifid(struct net *net, struct dst_entry *dst_orig,
		      const struct flowi *fl, const struct sock *sk,
		      int flags, u32 if_id)
{
	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_with_ifid(struct net *net,
					struct dst_entry *dst_orig,
					const struct flowi *fl,
					const struct sock *sk, int flags,
					u32 if_id);

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, true);
}

/* update dst pmtu but not do neighbor confirm */
static inline void skb_dst_update_pmtu_no_confirm(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, false);
}

struct dst_entry *dst_blackhole_check(struct dst_entry *dst, u32 cookie);
void dst_blackhole_update_pmtu(struct dst_entry *dst, struct sock *sk,
			       struct sk_buff *skb, u32 mtu, bool confirm_neigh);
void dst_blackhole_redirect(struct dst_entry *dst, struct sock *sk,
			    struct sk_buff *skb);
u32 *dst_blackhole_cow_metrics(struct dst_entry *dst, unsigned long old);
struct neighbour *dst_blackhole_neigh_lookup(const struct dst_entry *dst,
					     struct sk_buff *skb,
					     const void *daddr);
unsigned int dst_blackhole_mtu(const struct dst_entry *dst);

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