dst.h 6.66 KB
Newer Older
Linus Torvalds's avatar
Linus Torvalds committed
1 2 3 4 5 6 7 8 9 10
/*
 * net/dst.h	Protocol independent destination cache definitions.
 *
 * Authors:	Alexey Kuznetsov, <kuznet@ms2.inr.ac.ru>
 *
 */

#ifndef _NET_DST_H
#define _NET_DST_H

11
#include <net/dst_ops.h>
12
#include <linux/netdevice.h>
Linus Torvalds's avatar
Linus Torvalds committed
13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40
#include <linux/rtnetlink.h>
#include <linux/rcupdate.h>
#include <linux/jiffies.h>
#include <net/neighbour.h>
#include <asm/processor.h>

/*
 * 0 - no debugging messages
 * 1 - rare events and bugs (default)
 * 2 - trace mode.
 */
#define RT_CACHE_DEBUG		0

#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
{
41
	struct rcu_head		rcu_head;
Linus Torvalds's avatar
Linus Torvalds committed
42 43
	struct dst_entry	*child;
	struct net_device       *dev;
44 45
	short			error;
	short			obsolete;
Linus Torvalds's avatar
Linus Torvalds committed
46 47 48 49 50 51 52 53 54 55
	int			flags;
#define DST_HOST		1
#define DST_NOXFRM		2
#define DST_NOPOLICY		4
#define DST_NOHASH		8
	unsigned long		expires;

	unsigned short		header_len;	/* more space at head required */
	unsigned short		trailer_len;	/* space to reserve at tail */

56
	unsigned int		rate_tokens;
57
	unsigned long		rate_last;	/* rate limiting for ICMP */
58

59
	struct dst_entry	*path;
Linus Torvalds's avatar
Linus Torvalds committed
60 61 62

	struct neighbour	*neighbour;
	struct hh_cache		*hh;
63
#ifdef CONFIG_XFRM
Linus Torvalds's avatar
Linus Torvalds committed
64
	struct xfrm_state	*xfrm;
65 66
#else
	void			*__pad1;
67
#endif
Linus Torvalds's avatar
Linus Torvalds committed
68 69 70 71
	int			(*input)(struct sk_buff*);
	int			(*output)(struct sk_buff*);

	struct  dst_ops	        *ops;
72 73 74 75 76

	u32			metrics[RTAX_MAX];

#ifdef CONFIG_NET_CLS_ROUTE
	__u32			tclassid;
77 78
#else
	__u32			__pad2;
79 80
#endif

81 82 83 84 85 86 87 88 89 90

	/*
	 * Align __refcnt to a 64 bytes alignment
	 * (L1_CACHE_SIZE would be too much)
	 */
#ifdef CONFIG_64BIT
	long			__pad_to_align_refcnt[2];
#else
	long			__pad_to_align_refcnt[1];
#endif
91 92 93 94
	/*
	 * __refcnt wants to be on a different cache line from
	 * input/output/ops or performance tanks badly
	 */
95 96
	atomic_t		__refcnt;	/* client references	*/
	int			__use;
97
	unsigned long		lastuse;
98 99 100 101 102 103
	union {
		struct dst_entry *next;
		struct rtable    *rt_next;
		struct rt6_info   *rt6_next;
		struct dn_route  *dn_next;
	};
Linus Torvalds's avatar
Linus Torvalds committed
104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123
};

#ifdef __KERNEL__

static inline u32
dst_metric(const struct dst_entry *dst, int metric)
{
	return dst->metrics[metric-1];
}

static inline u32 dst_mtu(const struct dst_entry *dst)
{
	u32 mtu = dst_metric(dst, RTAX_MTU);
	/*
	 * Alexey put it here, so ask him about it :)
	 */
	barrier();
	return mtu;
}

Stephen Hemminger's avatar
Stephen Hemminger committed
124 125 126 127 128 129 130 131 132 133 134 135
/* 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 void set_dst_metric_rtt(struct dst_entry *dst, int metric,
				      unsigned long rtt)
{
	dst->metrics[metric-1] = jiffies_to_msecs(rtt);
}

Linus Torvalds's avatar
Linus Torvalds committed
136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152
static inline u32
dst_allfrag(const struct dst_entry *dst)
{
	int ret = dst_metric(dst, RTAX_FEATURES) & RTAX_FEATURE_ALLFRAG;
	/* Yes, _exactly_. This is paranoia. */
	barrier();
	return ret;
}

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

static inline void dst_hold(struct dst_entry * dst)
{
153 154 155 156 157
	/*
	 * 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);
Linus Torvalds's avatar
Linus Torvalds committed
158 159 160
	atomic_inc(&dst->__refcnt);
}

161 162 163 164 165 166 167
static inline void dst_use(struct dst_entry *dst, unsigned long time)
{
	dst_hold(dst);
	dst->__use++;
	dst->lastuse = time;
}

Linus Torvalds's avatar
Linus Torvalds committed
168 169 170 171 172 173 174 175
static inline
struct dst_entry * dst_clone(struct dst_entry * dst)
{
	if (dst)
		atomic_inc(&dst->__refcnt);
	return dst;
}

Ilpo Järvinen's avatar
Ilpo Järvinen committed
176
extern void dst_release(struct dst_entry *dst);
Eric Dumazet's avatar
Eric Dumazet committed
177 178 179 180 181 182
static inline void skb_dst_drop(struct sk_buff *skb)
{
	if (skb->_skb_dst)
		dst_release(skb_dst(skb));
	skb->_skb_dst = 0UL;
}
Linus Torvalds's avatar
Linus Torvalds committed
183 184 185 186 187 188 189 190 191 192 193 194 195

/* Children define the path of the packet through the
 * Linux networking.  Thus, destinations are stackable.
 */

static inline struct dst_entry *dst_pop(struct dst_entry *dst)
{
	struct dst_entry *child = dst_clone(dst->child);

	dst_release(dst);
	return child;
}

196
extern int dst_discard(struct sk_buff *skb);
Linus Torvalds's avatar
Linus Torvalds committed
197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224
extern void * dst_alloc(struct dst_ops * ops);
extern void __dst_free(struct dst_entry * dst);
extern struct dst_entry *dst_destroy(struct dst_entry * dst);

static inline void dst_free(struct dst_entry * dst)
{
	if (dst->obsolete > 1)
		return;
	if (!atomic_read(&dst->__refcnt)) {
		dst = dst_destroy(dst);
		if (!dst)
			return;
	}
	__dst_free(dst);
}

static inline void dst_rcu_free(struct rcu_head *head)
{
	struct dst_entry *dst = container_of(head, struct dst_entry, rcu_head);
	dst_free(dst);
}

static inline void dst_confirm(struct dst_entry *dst)
{
	if (dst)
		neigh_confirm(dst->neighbour);
}

225 226
static inline void dst_negative_advice(struct dst_entry **dst_p,
				       struct sock *sk)
Linus Torvalds's avatar
Linus Torvalds committed
227 228
{
	struct dst_entry * dst = *dst_p;
229
	if (dst && dst->ops->negative_advice) {
Linus Torvalds's avatar
Linus Torvalds committed
230
		*dst_p = dst->ops->negative_advice(dst);
231 232 233 234 235 236 237

		if (dst != *dst_p) {
			extern void sk_reset_txq(struct sock *sk);

			sk_reset_txq(sk);
		}
	}
Linus Torvalds's avatar
Linus Torvalds committed
238 239 240 241
}

static inline void dst_link_failure(struct sk_buff *skb)
{
Eric Dumazet's avatar
Eric Dumazet committed
242
	struct dst_entry *dst = skb_dst(skb);
Linus Torvalds's avatar
Linus Torvalds committed
243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260
	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 sk_buff *skb)
{
Eric Dumazet's avatar
Eric Dumazet committed
261
	return skb_dst(skb)->output(skb);
Linus Torvalds's avatar
Linus Torvalds committed
262 263 264 265 266
}

/* Input packet from network to transport.  */
static inline int dst_input(struct sk_buff *skb)
{
Eric Dumazet's avatar
Eric Dumazet committed
267
	return skb_dst(skb)->input(skb);
Linus Torvalds's avatar
Linus Torvalds committed
268 269 270 271 272 273 274 275 276 277 278
}

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

extern void		dst_init(void);

279 280 281
/* Flags for xfrm_lookup flags argument. */
enum {
	XFRM_LOOKUP_WAIT = 1 << 0,
282
	XFRM_LOOKUP_ICMP = 1 << 1,
283 284
};

Linus Torvalds's avatar
Linus Torvalds committed
285 286
struct flowi;
#ifndef CONFIG_XFRM
Alexey Dobriyan's avatar
Alexey Dobriyan committed
287 288
static inline int xfrm_lookup(struct net *net, struct dst_entry **dst_p,
			      struct flowi *fl, struct sock *sk, int flags)
Linus Torvalds's avatar
Linus Torvalds committed
289 290 291
{
	return 0;
} 
Alexey Dobriyan's avatar
Alexey Dobriyan committed
292 293
static inline int __xfrm_lookup(struct net *net, struct dst_entry **dst_p,
				struct flowi *fl, struct sock *sk, int flags)
294 295 296
{
	return 0;
}
Linus Torvalds's avatar
Linus Torvalds committed
297
#else
Alexey Dobriyan's avatar
Alexey Dobriyan committed
298 299 300 301
extern int xfrm_lookup(struct net *net, struct dst_entry **dst_p,
		       struct flowi *fl, struct sock *sk, int flags);
extern int __xfrm_lookup(struct net *net, struct dst_entry **dst_p,
			 struct flowi *fl, struct sock *sk, int flags);
Linus Torvalds's avatar
Linus Torvalds committed
302 303 304 305
#endif
#endif

#endif /* _NET_DST_H */