net: Document dst->obsolete better.
[GitHub/mt8127/android_kernel_alcatel_ttab.git] / include / net / dst.h
CommitLineData
1da177e4
LT
1/*
2 * net/dst.h Protocol independent destination cache definitions.
3 *
4 * Authors: Alexey Kuznetsov, <kuznet@ms2.inr.ac.ru>
5 *
6 */
7
8#ifndef _NET_DST_H
9#define _NET_DST_H
10
86393e52 11#include <net/dst_ops.h>
14c85021 12#include <linux/netdevice.h>
1da177e4
LT
13#include <linux/rtnetlink.h>
14#include <linux/rcupdate.h>
187f1882 15#include <linux/bug.h>
1da177e4
LT
16#include <linux/jiffies.h>
17#include <net/neighbour.h>
18#include <asm/processor.h>
19
1da177e4
LT
20#define DST_GC_MIN (HZ/10)
21#define DST_GC_INC (HZ/2)
22#define DST_GC_MAX (120*HZ)
23
24/* Each dst_entry has reference count and sits in some parent list(s).
25 * When it is removed from parent list, it is "freed" (dst_free).
26 * After this it enters dead state (dst->obsolete > 0) and if its refcnt
27 * is zero, it can be destroyed immediately, otherwise it is added
28 * to gc list and garbage collector periodically checks the refcnt.
29 */
30
31struct sk_buff;
32
fd2c3ef7 33struct dst_entry {
1e19e02c 34 struct rcu_head rcu_head;
1da177e4
LT
35 struct dst_entry *child;
36 struct net_device *dev;
62fa8a84
DM
37 struct dst_ops *ops;
38 unsigned long _metrics;
1716a961
G
39 union {
40 unsigned long expires;
41 /* point to where the dst_entry copied from */
42 struct dst_entry *from;
43 };
f1dd9c37 44 struct dst_entry *path;
36bdbcae 45 void *__pad0;
def8b4fa 46#ifdef CONFIG_XFRM
1da177e4 47 struct xfrm_state *xfrm;
5635c10d
ED
48#else
49 void *__pad1;
def8b4fa 50#endif
7f95e188
EZ
51 int (*input)(struct sk_buff *);
52 int (*output)(struct sk_buff *);
1da177e4 53
5110effe 54 unsigned short flags;
f6b72b62
DM
55#define DST_HOST 0x0001
56#define DST_NOXFRM 0x0002
57#define DST_NOPOLICY 0x0004
58#define DST_NOHASH 0x0008
59#define DST_NOCACHE 0x0010
60#define DST_NOCOUNT 0x0020
e688a604 61#define DST_NOPEER 0x0040
a881e963 62#define DST_FAKE_RTABLE 0x0080
0c183379 63#define DST_XFRM_TUNNEL 0x0100
f6b72b62 64
5110effe
DM
65 unsigned short pending_confirm;
66
62fa8a84 67 short error;
f5b0a874
DM
68
69 /* A non-zero value of dst->obsolete forces by-hand validation
70 * of the route entry. Positive values are set by the generic
71 * dst layer to indicate that the entry has been forcefully
72 * destroyed.
73 *
74 * Negative values are used by the implementation layer code to
75 * force invocation of the dst_ops->check() method.
76 */
62fa8a84 77 short obsolete;
f5b0a874
DM
78#define DST_OBSOLETE_NONE 0
79#define DST_OBSOLETE_DEAD 2
80#define DST_OBSOLETE_FORCE_CHK -1
62fa8a84
DM
81 unsigned short header_len; /* more space at head required */
82 unsigned short trailer_len; /* space to reserve at tail */
c7066f70 83#ifdef CONFIG_IP_ROUTE_CLASSID
f1dd9c37 84 __u32 tclassid;
5635c10d
ED
85#else
86 __u32 __pad2;
f1dd9c37
ZY
87#endif
88
5635c10d
ED
89 /*
90 * Align __refcnt to a 64 bytes alignment
91 * (L1_CACHE_SIZE would be too much)
92 */
93#ifdef CONFIG_64BIT
f6b72b62 94 long __pad_to_align_refcnt[2];
5635c10d 95#endif
f1dd9c37
ZY
96 /*
97 * __refcnt wants to be on a different cache line from
98 * input/output/ops or performance tanks badly
99 */
1e19e02c
ED
100 atomic_t __refcnt; /* client references */
101 int __use;
f1dd9c37 102 unsigned long lastuse;
1e19e02c 103 union {
fc766e4c
ED
104 struct dst_entry *next;
105 struct rtable __rcu *rt_next;
106 struct rt6_info *rt6_next;
107 struct dn_route __rcu *dn_next;
1e19e02c 108 };
1da177e4
LT
109};
110
62fa8a84 111extern u32 *dst_cow_metrics_generic(struct dst_entry *dst, unsigned long old);
725d1e1b 112extern const u32 dst_default_metrics[RTAX_MAX];
62fa8a84
DM
113
114#define DST_METRICS_READ_ONLY 0x1UL
115#define __DST_METRICS_PTR(Y) \
116 ((u32 *)((Y) & ~DST_METRICS_READ_ONLY))
117#define DST_METRICS_PTR(X) __DST_METRICS_PTR((X)->_metrics)
118
119static inline bool dst_metrics_read_only(const struct dst_entry *dst)
120{
121 return dst->_metrics & DST_METRICS_READ_ONLY;
122}
123
124extern void __dst_destroy_metrics_generic(struct dst_entry *dst, unsigned long old);
125
126static inline void dst_destroy_metrics_generic(struct dst_entry *dst)
127{
128 unsigned long val = dst->_metrics;
129 if (!(val & DST_METRICS_READ_ONLY))
130 __dst_destroy_metrics_generic(dst, val);
131}
132
133static inline u32 *dst_metrics_write_ptr(struct dst_entry *dst)
134{
135 unsigned long p = dst->_metrics;
136
1f37070d
SH
137 BUG_ON(!p);
138
62fa8a84
DM
139 if (p & DST_METRICS_READ_ONLY)
140 return dst->ops->cow_metrics(dst, p);
141 return __DST_METRICS_PTR(p);
142}
143
144/* This may only be invoked before the entry has reached global
145 * visibility.
146 */
147static inline void dst_init_metrics(struct dst_entry *dst,
148 const u32 *src_metrics,
149 bool read_only)
150{
151 dst->_metrics = ((unsigned long) src_metrics) |
152 (read_only ? DST_METRICS_READ_ONLY : 0);
153}
154
155static inline void dst_copy_metrics(struct dst_entry *dest, const struct dst_entry *src)
156{
157 u32 *dst_metrics = dst_metrics_write_ptr(dest);
158
159 if (dst_metrics) {
160 u32 *src_metrics = DST_METRICS_PTR(src);
161
162 memcpy(dst_metrics, src_metrics, RTAX_MAX * sizeof(u32));
163 }
164}
165
166static inline u32 *dst_metrics_ptr(struct dst_entry *dst)
167{
168 return DST_METRICS_PTR(dst);
169}
170
1da177e4 171static inline u32
5170ae82 172dst_metric_raw(const struct dst_entry *dst, const int metric)
1da177e4 173{
62fa8a84
DM
174 u32 *p = DST_METRICS_PTR(dst);
175
176 return p[metric-1];
defb3519
DM
177}
178
5170ae82
DM
179static inline u32
180dst_metric(const struct dst_entry *dst, const int metric)
181{
0dbaee3b 182 WARN_ON_ONCE(metric == RTAX_HOPLIMIT ||
d33e4553
DM
183 metric == RTAX_ADVMSS ||
184 metric == RTAX_MTU);
5170ae82
DM
185 return dst_metric_raw(dst, metric);
186}
187
0dbaee3b
DM
188static inline u32
189dst_metric_advmss(const struct dst_entry *dst)
190{
191 u32 advmss = dst_metric_raw(dst, RTAX_ADVMSS);
192
193 if (!advmss)
194 advmss = dst->ops->default_advmss(dst);
195
196 return advmss;
197}
198
defb3519
DM
199static inline void dst_metric_set(struct dst_entry *dst, int metric, u32 val)
200{
62fa8a84 201 u32 *p = dst_metrics_write_ptr(dst);
defb3519 202
62fa8a84
DM
203 if (p)
204 p[metric-1] = val;
1da177e4
LT
205}
206
0c3adfb8
GBY
207static inline u32
208dst_feature(const struct dst_entry *dst, u32 feature)
209{
bb5b7c11 210 return dst_metric(dst, RTAX_FEATURES) & feature;
0c3adfb8
GBY
211}
212
1da177e4
LT
213static inline u32 dst_mtu(const struct dst_entry *dst)
214{
618f9bc7 215 return dst->ops->mtu(dst);
1da177e4
LT
216}
217
c1e20f7c
SH
218/* RTT metrics are stored in milliseconds for user ABI, but used as jiffies */
219static inline unsigned long dst_metric_rtt(const struct dst_entry *dst, int metric)
220{
221 return msecs_to_jiffies(dst_metric(dst, metric));
222}
223
1da177e4
LT
224static inline u32
225dst_allfrag(const struct dst_entry *dst)
226{
0c3adfb8 227 int ret = dst_feature(dst, RTAX_FEATURE_ALLFRAG);
1da177e4
LT
228 return ret;
229}
230
231static inline int
d33e4553 232dst_metric_locked(const struct dst_entry *dst, int metric)
1da177e4
LT
233{
234 return dst_metric(dst, RTAX_LOCK) & (1<<metric);
235}
236
7f95e188 237static inline void dst_hold(struct dst_entry *dst)
1da177e4 238{
5635c10d
ED
239 /*
240 * If your kernel compilation stops here, please check
241 * __pad_to_align_refcnt declaration in struct dst_entry
242 */
243 BUILD_BUG_ON(offsetof(struct dst_entry, __refcnt) & 63);
1da177e4
LT
244 atomic_inc(&dst->__refcnt);
245}
246
03f49f34
PE
247static inline void dst_use(struct dst_entry *dst, unsigned long time)
248{
249 dst_hold(dst);
250 dst->__use++;
251 dst->lastuse = time;
252}
253
7fee226a
ED
254static inline void dst_use_noref(struct dst_entry *dst, unsigned long time)
255{
256 dst->__use++;
257 dst->lastuse = time;
258}
259
7f95e188 260static inline struct dst_entry *dst_clone(struct dst_entry *dst)
1da177e4
LT
261{
262 if (dst)
263 atomic_inc(&dst->__refcnt);
264 return dst;
265}
266
8d330868 267extern void dst_release(struct dst_entry *dst);
7fee226a
ED
268
269static inline void refdst_drop(unsigned long refdst)
270{
271 if (!(refdst & SKB_DST_NOREF))
272 dst_release((struct dst_entry *)(refdst & SKB_DST_PTRMASK));
273}
274
275/**
276 * skb_dst_drop - drops skb dst
277 * @skb: buffer
278 *
279 * Drops dst reference count if a reference was taken.
280 */
adf30907
ED
281static inline void skb_dst_drop(struct sk_buff *skb)
282{
7fee226a
ED
283 if (skb->_skb_refdst) {
284 refdst_drop(skb->_skb_refdst);
285 skb->_skb_refdst = 0UL;
286 }
287}
288
289static inline void skb_dst_copy(struct sk_buff *nskb, const struct sk_buff *oskb)
290{
291 nskb->_skb_refdst = oskb->_skb_refdst;
292 if (!(nskb->_skb_refdst & SKB_DST_NOREF))
293 dst_clone(skb_dst(nskb));
294}
295
296/**
297 * skb_dst_force - makes sure skb dst is refcounted
298 * @skb: buffer
299 *
300 * If dst is not yet refcounted, let's do it
301 */
302static inline void skb_dst_force(struct sk_buff *skb)
303{
304 if (skb_dst_is_noref(skb)) {
305 WARN_ON(!rcu_read_lock_held());
306 skb->_skb_refdst &= ~SKB_DST_NOREF;
307 dst_clone(skb_dst(skb));
308 }
adf30907 309}
1da177e4 310
d19d56dd 311
290b895e
ED
312/**
313 * __skb_tunnel_rx - prepare skb for rx reinsert
314 * @skb: buffer
315 * @dev: tunnel device
316 *
317 * After decapsulation, packet is going to re-enter (netif_rx()) our stack,
318 * so make some cleanups. (no accounting done)
319 */
320static inline void __skb_tunnel_rx(struct sk_buff *skb, struct net_device *dev)
321{
322 skb->dev = dev;
bdeab991
TH
323
324 /*
325 * Clear rxhash so that we can recalulate the hash for the
326 * encapsulated packet, unless we have already determine the hash
327 * over the L4 4-tuple.
328 */
329 if (!skb->l4_rxhash)
330 skb->rxhash = 0;
290b895e
ED
331 skb_set_queue_mapping(skb, 0);
332 skb_dst_drop(skb);
333 nf_reset(skb);
334}
335
d19d56dd
ED
336/**
337 * skb_tunnel_rx - prepare skb for rx reinsert
338 * @skb: buffer
339 * @dev: tunnel device
340 *
341 * After decapsulation, packet is going to re-enter (netif_rx()) our stack,
342 * so make some cleanups, and perform accounting.
290b895e 343 * Note: this accounting is not SMP safe.
d19d56dd
ED
344 */
345static inline void skb_tunnel_rx(struct sk_buff *skb, struct net_device *dev)
346{
d19d56dd
ED
347 /* TODO : stats should be SMP safe */
348 dev->stats.rx_packets++;
349 dev->stats.rx_bytes += skb->len;
290b895e 350 __skb_tunnel_rx(skb, dev);
d19d56dd
ED
351}
352
1da177e4
LT
353/* Children define the path of the packet through the
354 * Linux networking. Thus, destinations are stackable.
355 */
356
8764ab2c 357static inline struct dst_entry *skb_dst_pop(struct sk_buff *skb)
1da177e4 358{
e433430a 359 struct dst_entry *child = dst_clone(skb_dst(skb)->child);
1da177e4 360
8764ab2c 361 skb_dst_drop(skb);
1da177e4
LT
362 return child;
363}
364
352e512c 365extern int dst_discard(struct sk_buff *skb);
7f95e188 366extern void *dst_alloc(struct dst_ops *ops, struct net_device *dev,
5110effe
DM
367 int initial_ref, int initial_obsolete,
368 unsigned short flags);
7f95e188
EZ
369extern void __dst_free(struct dst_entry *dst);
370extern struct dst_entry *dst_destroy(struct dst_entry *dst);
1da177e4 371
7f95e188 372static inline void dst_free(struct dst_entry *dst)
1da177e4 373{
f5b0a874 374 if (dst->obsolete > 0)
1da177e4
LT
375 return;
376 if (!atomic_read(&dst->__refcnt)) {
377 dst = dst_destroy(dst);
378 if (!dst)
379 return;
380 }
381 __dst_free(dst);
382}
383
384static inline void dst_rcu_free(struct rcu_head *head)
385{
386 struct dst_entry *dst = container_of(head, struct dst_entry, rcu_head);
387 dst_free(dst);
388}
389
390static inline void dst_confirm(struct dst_entry *dst)
391{
5110effe
DM
392 dst->pending_confirm = 1;
393}
f2c31e32 394
5110effe
DM
395static inline int dst_neigh_output(struct dst_entry *dst, struct neighbour *n,
396 struct sk_buff *skb)
397{
398 struct hh_cache *hh;
399
400 if (unlikely(dst->pending_confirm)) {
401 n->confirmed = jiffies;
402 dst->pending_confirm = 0;
69cce1d1 403 }
5110effe
DM
404
405 hh = &n->hh;
406 if ((n->nud_state & NUD_CONNECTED) && hh->hh_len)
407 return neigh_hh_output(hh, skb);
408 else
409 return n->output(n, skb);
1da177e4
LT
410}
411
d3aaeb38
DM
412static inline struct neighbour *dst_neigh_lookup(const struct dst_entry *dst, const void *daddr)
413{
f894cbf8
DM
414 return dst->ops->neigh_lookup(dst, NULL, daddr);
415}
416
417static inline struct neighbour *dst_neigh_lookup_skb(const struct dst_entry *dst,
418 struct sk_buff *skb)
419{
420 return dst->ops->neigh_lookup(dst, skb, NULL);
d3aaeb38
DM
421}
422
1da177e4
LT
423static inline void dst_link_failure(struct sk_buff *skb)
424{
adf30907 425 struct dst_entry *dst = skb_dst(skb);
1da177e4
LT
426 if (dst && dst->ops && dst->ops->link_failure)
427 dst->ops->link_failure(skb);
428}
429
430static inline void dst_set_expires(struct dst_entry *dst, int timeout)
431{
432 unsigned long expires = jiffies + timeout;
433
434 if (expires == 0)
435 expires = 1;
436
437 if (dst->expires == 0 || time_before(expires, dst->expires))
438 dst->expires = expires;
439}
440
441/* Output packet to network from transport. */
442static inline int dst_output(struct sk_buff *skb)
443{
adf30907 444 return skb_dst(skb)->output(skb);
1da177e4
LT
445}
446
447/* Input packet from network to transport. */
448static inline int dst_input(struct sk_buff *skb)
449{
adf30907 450 return skb_dst(skb)->input(skb);
1da177e4
LT
451}
452
453static inline struct dst_entry *dst_check(struct dst_entry *dst, u32 cookie)
454{
455 if (dst->obsolete)
456 dst = dst->ops->check(dst, cookie);
457 return dst;
458}
459
460extern void dst_init(void);
461
815f4e57
HX
462/* Flags for xfrm_lookup flags argument. */
463enum {
80c0bc9e 464 XFRM_LOOKUP_ICMP = 1 << 0,
815f4e57
HX
465};
466
1da177e4
LT
467struct flowi;
468#ifndef CONFIG_XFRM
452edd59
DM
469static inline struct dst_entry *xfrm_lookup(struct net *net,
470 struct dst_entry *dst_orig,
471 const struct flowi *fl, struct sock *sk,
472 int flags)
1da177e4 473{
452edd59 474 return dst_orig;
1da177e4
LT
475}
476#else
452edd59
DM
477extern struct dst_entry *xfrm_lookup(struct net *net, struct dst_entry *dst_orig,
478 const struct flowi *fl, struct sock *sk,
479 int flags);
1da177e4 480#endif
1da177e4
LT
481
482#endif /* _NET_DST_H */