bug.h: add include of it to various implicit C users
[deliverable/linux.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>
15#include <linux/jiffies.h>
16#include <net/neighbour.h>
17#include <asm/processor.h>
18
1da177e4
LT
19#define DST_GC_MIN (HZ/10)
20#define DST_GC_INC (HZ/2)
21#define DST_GC_MAX (120*HZ)
22
23/* Each dst_entry has reference count and sits in some parent list(s).
24 * When it is removed from parent list, it is "freed" (dst_free).
25 * After this it enters dead state (dst->obsolete > 0) and if its refcnt
26 * is zero, it can be destroyed immediately, otherwise it is added
27 * to gc list and garbage collector periodically checks the refcnt.
28 */
29
30struct sk_buff;
31
fd2c3ef7 32struct dst_entry {
1e19e02c 33 struct rcu_head rcu_head;
1da177e4
LT
34 struct dst_entry *child;
35 struct net_device *dev;
62fa8a84
DM
36 struct dst_ops *ops;
37 unsigned long _metrics;
1da177e4 38 unsigned long expires;
f1dd9c37 39 struct dst_entry *path;
f2c31e32 40 struct neighbour __rcu *_neighbour;
def8b4fa 41#ifdef CONFIG_XFRM
1da177e4 42 struct xfrm_state *xfrm;
5635c10d
ED
43#else
44 void *__pad1;
def8b4fa 45#endif
1da177e4
LT
46 int (*input)(struct sk_buff*);
47 int (*output)(struct sk_buff*);
48
f6b72b62
DM
49 int flags;
50#define DST_HOST 0x0001
51#define DST_NOXFRM 0x0002
52#define DST_NOPOLICY 0x0004
53#define DST_NOHASH 0x0008
54#define DST_NOCACHE 0x0010
55#define DST_NOCOUNT 0x0020
e688a604 56#define DST_NOPEER 0x0040
f6b72b62 57
62fa8a84
DM
58 short error;
59 short obsolete;
60 unsigned short header_len; /* more space at head required */
61 unsigned short trailer_len; /* space to reserve at tail */
c7066f70 62#ifdef CONFIG_IP_ROUTE_CLASSID
f1dd9c37 63 __u32 tclassid;
5635c10d
ED
64#else
65 __u32 __pad2;
f1dd9c37
ZY
66#endif
67
5635c10d
ED
68 /*
69 * Align __refcnt to a 64 bytes alignment
70 * (L1_CACHE_SIZE would be too much)
71 */
72#ifdef CONFIG_64BIT
f6b72b62 73 long __pad_to_align_refcnt[2];
5635c10d 74#endif
f1dd9c37
ZY
75 /*
76 * __refcnt wants to be on a different cache line from
77 * input/output/ops or performance tanks badly
78 */
1e19e02c
ED
79 atomic_t __refcnt; /* client references */
80 int __use;
f1dd9c37 81 unsigned long lastuse;
1e19e02c 82 union {
fc766e4c
ED
83 struct dst_entry *next;
84 struct rtable __rcu *rt_next;
85 struct rt6_info *rt6_next;
86 struct dn_route __rcu *dn_next;
1e19e02c 87 };
1da177e4
LT
88};
89
27217455 90static inline struct neighbour *dst_get_neighbour_noref(struct dst_entry *dst)
69cce1d1 91{
f2c31e32
ED
92 return rcu_dereference(dst->_neighbour);
93}
94
27217455 95static inline struct neighbour *dst_get_neighbour_noref_raw(struct dst_entry *dst)
f2c31e32
ED
96{
97 return rcu_dereference_raw(dst->_neighbour);
69cce1d1
DM
98}
99
100static inline void dst_set_neighbour(struct dst_entry *dst, struct neighbour *neigh)
101{
f2c31e32 102 rcu_assign_pointer(dst->_neighbour, neigh);
69cce1d1
DM
103}
104
62fa8a84 105extern u32 *dst_cow_metrics_generic(struct dst_entry *dst, unsigned long old);
725d1e1b 106extern const u32 dst_default_metrics[RTAX_MAX];
62fa8a84
DM
107
108#define DST_METRICS_READ_ONLY 0x1UL
109#define __DST_METRICS_PTR(Y) \
110 ((u32 *)((Y) & ~DST_METRICS_READ_ONLY))
111#define DST_METRICS_PTR(X) __DST_METRICS_PTR((X)->_metrics)
112
113static inline bool dst_metrics_read_only(const struct dst_entry *dst)
114{
115 return dst->_metrics & DST_METRICS_READ_ONLY;
116}
117
118extern void __dst_destroy_metrics_generic(struct dst_entry *dst, unsigned long old);
119
120static inline void dst_destroy_metrics_generic(struct dst_entry *dst)
121{
122 unsigned long val = dst->_metrics;
123 if (!(val & DST_METRICS_READ_ONLY))
124 __dst_destroy_metrics_generic(dst, val);
125}
126
127static inline u32 *dst_metrics_write_ptr(struct dst_entry *dst)
128{
129 unsigned long p = dst->_metrics;
130
1f37070d
SH
131 BUG_ON(!p);
132
62fa8a84
DM
133 if (p & DST_METRICS_READ_ONLY)
134 return dst->ops->cow_metrics(dst, p);
135 return __DST_METRICS_PTR(p);
136}
137
138/* This may only be invoked before the entry has reached global
139 * visibility.
140 */
141static inline void dst_init_metrics(struct dst_entry *dst,
142 const u32 *src_metrics,
143 bool read_only)
144{
145 dst->_metrics = ((unsigned long) src_metrics) |
146 (read_only ? DST_METRICS_READ_ONLY : 0);
147}
148
149static inline void dst_copy_metrics(struct dst_entry *dest, const struct dst_entry *src)
150{
151 u32 *dst_metrics = dst_metrics_write_ptr(dest);
152
153 if (dst_metrics) {
154 u32 *src_metrics = DST_METRICS_PTR(src);
155
156 memcpy(dst_metrics, src_metrics, RTAX_MAX * sizeof(u32));
157 }
158}
159
160static inline u32 *dst_metrics_ptr(struct dst_entry *dst)
161{
162 return DST_METRICS_PTR(dst);
163}
164
1da177e4 165static inline u32
5170ae82 166dst_metric_raw(const struct dst_entry *dst, const int metric)
1da177e4 167{
62fa8a84
DM
168 u32 *p = DST_METRICS_PTR(dst);
169
170 return p[metric-1];
defb3519
DM
171}
172
5170ae82
DM
173static inline u32
174dst_metric(const struct dst_entry *dst, const int metric)
175{
0dbaee3b 176 WARN_ON_ONCE(metric == RTAX_HOPLIMIT ||
d33e4553
DM
177 metric == RTAX_ADVMSS ||
178 metric == RTAX_MTU);
5170ae82
DM
179 return dst_metric_raw(dst, metric);
180}
181
0dbaee3b
DM
182static inline u32
183dst_metric_advmss(const struct dst_entry *dst)
184{
185 u32 advmss = dst_metric_raw(dst, RTAX_ADVMSS);
186
187 if (!advmss)
188 advmss = dst->ops->default_advmss(dst);
189
190 return advmss;
191}
192
defb3519
DM
193static inline void dst_metric_set(struct dst_entry *dst, int metric, u32 val)
194{
62fa8a84 195 u32 *p = dst_metrics_write_ptr(dst);
defb3519 196
62fa8a84
DM
197 if (p)
198 p[metric-1] = val;
1da177e4
LT
199}
200
0c3adfb8
GBY
201static inline u32
202dst_feature(const struct dst_entry *dst, u32 feature)
203{
bb5b7c11 204 return dst_metric(dst, RTAX_FEATURES) & feature;
0c3adfb8
GBY
205}
206
1da177e4
LT
207static inline u32 dst_mtu(const struct dst_entry *dst)
208{
618f9bc7 209 return dst->ops->mtu(dst);
1da177e4
LT
210}
211
c1e20f7c
SH
212/* RTT metrics are stored in milliseconds for user ABI, but used as jiffies */
213static inline unsigned long dst_metric_rtt(const struct dst_entry *dst, int metric)
214{
215 return msecs_to_jiffies(dst_metric(dst, metric));
216}
217
218static inline void set_dst_metric_rtt(struct dst_entry *dst, int metric,
219 unsigned long rtt)
220{
defb3519 221 dst_metric_set(dst, metric, jiffies_to_msecs(rtt));
c1e20f7c
SH
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
237static inline void dst_hold(struct dst_entry * dst)
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
1da177e4
LT
260static inline
261struct dst_entry * dst_clone(struct dst_entry * dst)
262{
263 if (dst)
264 atomic_inc(&dst->__refcnt);
265 return dst;
266}
267
8d330868 268extern void dst_release(struct dst_entry *dst);
7fee226a
ED
269
270static inline void refdst_drop(unsigned long refdst)
271{
272 if (!(refdst & SKB_DST_NOREF))
273 dst_release((struct dst_entry *)(refdst & SKB_DST_PTRMASK));
274}
275
276/**
277 * skb_dst_drop - drops skb dst
278 * @skb: buffer
279 *
280 * Drops dst reference count if a reference was taken.
281 */
adf30907
ED
282static inline void skb_dst_drop(struct sk_buff *skb)
283{
7fee226a
ED
284 if (skb->_skb_refdst) {
285 refdst_drop(skb->_skb_refdst);
286 skb->_skb_refdst = 0UL;
287 }
288}
289
290static inline void skb_dst_copy(struct sk_buff *nskb, const struct sk_buff *oskb)
291{
292 nskb->_skb_refdst = oskb->_skb_refdst;
293 if (!(nskb->_skb_refdst & SKB_DST_NOREF))
294 dst_clone(skb_dst(nskb));
295}
296
297/**
298 * skb_dst_force - makes sure skb dst is refcounted
299 * @skb: buffer
300 *
301 * If dst is not yet refcounted, let's do it
302 */
303static inline void skb_dst_force(struct sk_buff *skb)
304{
305 if (skb_dst_is_noref(skb)) {
306 WARN_ON(!rcu_read_lock_held());
307 skb->_skb_refdst &= ~SKB_DST_NOREF;
308 dst_clone(skb_dst(skb));
309 }
adf30907 310}
1da177e4 311
d19d56dd 312
290b895e
ED
313/**
314 * __skb_tunnel_rx - prepare skb for rx reinsert
315 * @skb: buffer
316 * @dev: tunnel device
317 *
318 * After decapsulation, packet is going to re-enter (netif_rx()) our stack,
319 * so make some cleanups. (no accounting done)
320 */
321static inline void __skb_tunnel_rx(struct sk_buff *skb, struct net_device *dev)
322{
323 skb->dev = dev;
bdeab991
TH
324
325 /*
326 * Clear rxhash so that we can recalulate the hash for the
327 * encapsulated packet, unless we have already determine the hash
328 * over the L4 4-tuple.
329 */
330 if (!skb->l4_rxhash)
331 skb->rxhash = 0;
290b895e
ED
332 skb_set_queue_mapping(skb, 0);
333 skb_dst_drop(skb);
334 nf_reset(skb);
335}
336
d19d56dd
ED
337/**
338 * skb_tunnel_rx - prepare skb for rx reinsert
339 * @skb: buffer
340 * @dev: tunnel device
341 *
342 * After decapsulation, packet is going to re-enter (netif_rx()) our stack,
343 * so make some cleanups, and perform accounting.
290b895e 344 * Note: this accounting is not SMP safe.
d19d56dd
ED
345 */
346static inline void skb_tunnel_rx(struct sk_buff *skb, struct net_device *dev)
347{
d19d56dd
ED
348 /* TODO : stats should be SMP safe */
349 dev->stats.rx_packets++;
350 dev->stats.rx_bytes += skb->len;
290b895e 351 __skb_tunnel_rx(skb, dev);
d19d56dd
ED
352}
353
1da177e4
LT
354/* Children define the path of the packet through the
355 * Linux networking. Thus, destinations are stackable.
356 */
357
8764ab2c 358static inline struct dst_entry *skb_dst_pop(struct sk_buff *skb)
1da177e4 359{
e433430a 360 struct dst_entry *child = dst_clone(skb_dst(skb)->child);
1da177e4 361
8764ab2c 362 skb_dst_drop(skb);
1da177e4
LT
363 return child;
364}
365
352e512c 366extern int dst_discard(struct sk_buff *skb);
5c1e6aa3
DM
367extern void *dst_alloc(struct dst_ops * ops, struct net_device *dev,
368 int initial_ref, int initial_obsolete, int flags);
1da177e4
LT
369extern void __dst_free(struct dst_entry * dst);
370extern struct dst_entry *dst_destroy(struct dst_entry * dst);
371
372static inline void dst_free(struct dst_entry * dst)
373{
374 if (dst->obsolete > 1)
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{
69cce1d1 392 if (dst) {
f2c31e32
ED
393 struct neighbour *n;
394
395 rcu_read_lock();
27217455 396 n = dst_get_neighbour_noref(dst);
69cce1d1 397 neigh_confirm(n);
f2c31e32 398 rcu_read_unlock();
69cce1d1 399 }
1da177e4
LT
400}
401
d3aaeb38
DM
402static inline struct neighbour *dst_neigh_lookup(const struct dst_entry *dst, const void *daddr)
403{
404 return dst->ops->neigh_lookup(dst, daddr);
405}
406
1da177e4
LT
407static inline void dst_link_failure(struct sk_buff *skb)
408{
adf30907 409 struct dst_entry *dst = skb_dst(skb);
1da177e4
LT
410 if (dst && dst->ops && dst->ops->link_failure)
411 dst->ops->link_failure(skb);
412}
413
414static inline void dst_set_expires(struct dst_entry *dst, int timeout)
415{
416 unsigned long expires = jiffies + timeout;
417
418 if (expires == 0)
419 expires = 1;
420
421 if (dst->expires == 0 || time_before(expires, dst->expires))
422 dst->expires = expires;
423}
424
425/* Output packet to network from transport. */
426static inline int dst_output(struct sk_buff *skb)
427{
adf30907 428 return skb_dst(skb)->output(skb);
1da177e4
LT
429}
430
431/* Input packet from network to transport. */
432static inline int dst_input(struct sk_buff *skb)
433{
adf30907 434 return skb_dst(skb)->input(skb);
1da177e4
LT
435}
436
437static inline struct dst_entry *dst_check(struct dst_entry *dst, u32 cookie)
438{
439 if (dst->obsolete)
440 dst = dst->ops->check(dst, cookie);
441 return dst;
442}
443
444extern void dst_init(void);
445
815f4e57
HX
446/* Flags for xfrm_lookup flags argument. */
447enum {
80c0bc9e 448 XFRM_LOOKUP_ICMP = 1 << 0,
815f4e57
HX
449};
450
1da177e4
LT
451struct flowi;
452#ifndef CONFIG_XFRM
452edd59
DM
453static inline struct dst_entry *xfrm_lookup(struct net *net,
454 struct dst_entry *dst_orig,
455 const struct flowi *fl, struct sock *sk,
456 int flags)
1da177e4 457{
452edd59 458 return dst_orig;
1da177e4
LT
459}
460#else
452edd59
DM
461extern struct dst_entry *xfrm_lookup(struct net *net, struct dst_entry *dst_orig,
462 const struct flowi *fl, struct sock *sk,
463 int flags);
1da177e4 464#endif
1da177e4
LT
465
466#endif /* _NET_DST_H */
This page took 0.81081 seconds and 5 git commands to generate.