2 * net/dst.h Protocol independent destination cache definitions.
4 * Authors: Alexey Kuznetsov, <kuznet@ms2.inr.ac.ru>
11 #include <net/dst_ops.h>
12 #include <linux/netdevice.h>
13 #include <linux/rtnetlink.h>
14 #include <linux/rcupdate.h>
15 #include <linux/bug.h>
16 #include <linux/jiffies.h>
17 #include <net/neighbour.h>
18 #include <asm/processor.h>
20 #define DST_GC_MIN (HZ/10)
21 #define DST_GC_INC (HZ/2)
22 #define DST_GC_MAX (120*HZ)
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.
34 struct rcu_head rcu_head
;
35 struct dst_entry
*child
;
36 struct net_device
*dev
;
38 unsigned long _metrics
;
39 unsigned long expires
;
40 struct dst_entry
*path
;
41 struct dst_entry
*from
;
43 struct xfrm_state
*xfrm
;
47 int (*input
)(struct sk_buff
*);
48 int (*output
)(struct sock
*sk
, struct sk_buff
*skb
);
51 #define DST_HOST 0x0001
52 #define DST_NOXFRM 0x0002
53 #define DST_NOPOLICY 0x0004
54 #define DST_NOHASH 0x0008
55 #define DST_NOCACHE 0x0010
56 #define DST_NOCOUNT 0x0020
57 #define DST_FAKE_RTABLE 0x0040
58 #define DST_XFRM_TUNNEL 0x0080
59 #define DST_XFRM_QUEUE 0x0100
61 unsigned short pending_confirm
;
65 /* A non-zero value of dst->obsolete forces by-hand validation
66 * of the route entry. Positive values are set by the generic
67 * dst layer to indicate that the entry has been forcefully
70 * Negative values are used by the implementation layer code to
71 * force invocation of the dst_ops->check() method.
74 #define DST_OBSOLETE_NONE 0
75 #define DST_OBSOLETE_DEAD 2
76 #define DST_OBSOLETE_FORCE_CHK -1
77 #define DST_OBSOLETE_KILL -2
78 unsigned short header_len
; /* more space at head required */
79 unsigned short trailer_len
; /* space to reserve at tail */
80 #ifdef CONFIG_IP_ROUTE_CLASSID
87 * Align __refcnt to a 64 bytes alignment
88 * (L1_CACHE_SIZE would be too much)
91 long __pad_to_align_refcnt
[2];
94 * __refcnt wants to be on a different cache line from
95 * input/output/ops or performance tanks badly
97 atomic_t __refcnt
; /* client references */
99 unsigned long lastuse
;
101 struct dst_entry
*next
;
102 struct rtable __rcu
*rt_next
;
103 struct rt6_info
*rt6_next
;
104 struct dn_route __rcu
*dn_next
;
108 u32
*dst_cow_metrics_generic(struct dst_entry
*dst
, unsigned long old
);
109 extern const u32 dst_default_metrics
[];
111 #define DST_METRICS_READ_ONLY 0x1UL
112 #define DST_METRICS_FORCE_OVERWRITE 0x2UL
113 #define DST_METRICS_FLAGS 0x3UL
114 #define __DST_METRICS_PTR(Y) \
115 ((u32 *)((Y) & ~DST_METRICS_FLAGS))
116 #define DST_METRICS_PTR(X) __DST_METRICS_PTR((X)->_metrics)
118 static inline bool dst_metrics_read_only(const struct dst_entry
*dst
)
120 return dst
->_metrics
& DST_METRICS_READ_ONLY
;
123 static inline void dst_metrics_set_force_overwrite(struct dst_entry
*dst
)
125 dst
->_metrics
|= DST_METRICS_FORCE_OVERWRITE
;
128 void __dst_destroy_metrics_generic(struct dst_entry
*dst
, unsigned long old
);
130 static inline void dst_destroy_metrics_generic(struct dst_entry
*dst
)
132 unsigned long val
= dst
->_metrics
;
133 if (!(val
& DST_METRICS_READ_ONLY
))
134 __dst_destroy_metrics_generic(dst
, val
);
137 static inline u32
*dst_metrics_write_ptr(struct dst_entry
*dst
)
139 unsigned long p
= dst
->_metrics
;
143 if (p
& DST_METRICS_READ_ONLY
)
144 return dst
->ops
->cow_metrics(dst
, p
);
145 return __DST_METRICS_PTR(p
);
148 /* This may only be invoked before the entry has reached global
151 static inline void dst_init_metrics(struct dst_entry
*dst
,
152 const u32
*src_metrics
,
155 dst
->_metrics
= ((unsigned long) src_metrics
) |
156 (read_only
? DST_METRICS_READ_ONLY
: 0);
159 static inline void dst_copy_metrics(struct dst_entry
*dest
, const struct dst_entry
*src
)
161 u32
*dst_metrics
= dst_metrics_write_ptr(dest
);
164 u32
*src_metrics
= DST_METRICS_PTR(src
);
166 memcpy(dst_metrics
, src_metrics
, RTAX_MAX
* sizeof(u32
));
170 static inline u32
*dst_metrics_ptr(struct dst_entry
*dst
)
172 return DST_METRICS_PTR(dst
);
176 dst_metric_raw(const struct dst_entry
*dst
, const int metric
)
178 u32
*p
= DST_METRICS_PTR(dst
);
184 dst_metric(const struct dst_entry
*dst
, const int metric
)
186 WARN_ON_ONCE(metric
== RTAX_HOPLIMIT
||
187 metric
== RTAX_ADVMSS
||
189 return dst_metric_raw(dst
, metric
);
193 dst_metric_advmss(const struct dst_entry
*dst
)
195 u32 advmss
= dst_metric_raw(dst
, RTAX_ADVMSS
);
198 advmss
= dst
->ops
->default_advmss(dst
);
203 static inline void dst_metric_set(struct dst_entry
*dst
, int metric
, u32 val
)
205 u32
*p
= dst_metrics_write_ptr(dst
);
212 dst_feature(const struct dst_entry
*dst
, u32 feature
)
214 return dst_metric(dst
, RTAX_FEATURES
) & feature
;
217 static inline u32
dst_mtu(const struct dst_entry
*dst
)
219 return dst
->ops
->mtu(dst
);
222 /* RTT metrics are stored in milliseconds for user ABI, but used as jiffies */
223 static inline unsigned long dst_metric_rtt(const struct dst_entry
*dst
, int metric
)
225 return msecs_to_jiffies(dst_metric(dst
, metric
));
229 dst_allfrag(const struct dst_entry
*dst
)
231 int ret
= dst_feature(dst
, RTAX_FEATURE_ALLFRAG
);
236 dst_metric_locked(const struct dst_entry
*dst
, int metric
)
238 return dst_metric(dst
, RTAX_LOCK
) & (1<<metric
);
241 static inline void dst_hold(struct dst_entry
*dst
)
244 * If your kernel compilation stops here, please check
245 * __pad_to_align_refcnt declaration in struct dst_entry
247 BUILD_BUG_ON(offsetof(struct dst_entry
, __refcnt
) & 63);
248 atomic_inc(&dst
->__refcnt
);
251 static inline void dst_use(struct dst_entry
*dst
, unsigned long time
)
258 static inline void dst_use_noref(struct dst_entry
*dst
, unsigned long time
)
264 static inline struct dst_entry
*dst_clone(struct dst_entry
*dst
)
267 atomic_inc(&dst
->__refcnt
);
271 void dst_release(struct dst_entry
*dst
);
273 static inline void refdst_drop(unsigned long refdst
)
275 if (!(refdst
& SKB_DST_NOREF
))
276 dst_release((struct dst_entry
*)(refdst
& SKB_DST_PTRMASK
));
280 * skb_dst_drop - drops skb dst
283 * Drops dst reference count if a reference was taken.
285 static inline void skb_dst_drop(struct sk_buff
*skb
)
287 if (skb
->_skb_refdst
) {
288 refdst_drop(skb
->_skb_refdst
);
289 skb
->_skb_refdst
= 0UL;
293 static inline void skb_dst_copy(struct sk_buff
*nskb
, const struct sk_buff
*oskb
)
295 nskb
->_skb_refdst
= oskb
->_skb_refdst
;
296 if (!(nskb
->_skb_refdst
& SKB_DST_NOREF
))
297 dst_clone(skb_dst(nskb
));
301 * skb_dst_force - makes sure skb dst is refcounted
304 * If dst is not yet refcounted, let's do it
306 static inline void skb_dst_force(struct sk_buff
*skb
)
308 if (skb_dst_is_noref(skb
)) {
309 WARN_ON(!rcu_read_lock_held());
310 skb
->_skb_refdst
&= ~SKB_DST_NOREF
;
311 dst_clone(skb_dst(skb
));
316 * dst_hold_safe - Take a reference on a dst if possible
317 * @dst: pointer to dst entry
319 * This helper returns false if it could not safely
320 * take a reference on a dst.
322 static inline bool dst_hold_safe(struct dst_entry
*dst
)
324 if (dst
->flags
& DST_NOCACHE
)
325 return atomic_inc_not_zero(&dst
->__refcnt
);
331 * skb_dst_force_safe - makes sure skb dst is refcounted
334 * If dst is not yet refcounted and not destroyed, grab a ref on it.
336 static inline void skb_dst_force_safe(struct sk_buff
*skb
)
338 if (skb_dst_is_noref(skb
)) {
339 struct dst_entry
*dst
= skb_dst(skb
);
341 if (!dst_hold_safe(dst
))
344 skb
->_skb_refdst
= (unsigned long)dst
;
350 * __skb_tunnel_rx - prepare skb for rx reinsert
352 * @dev: tunnel device
353 * @net: netns for packet i/o
355 * After decapsulation, packet is going to re-enter (netif_rx()) our stack,
356 * so make some cleanups. (no accounting done)
358 static inline void __skb_tunnel_rx(struct sk_buff
*skb
, struct net_device
*dev
,
364 * Clear hash so that we can recalulate the hash for the
365 * encapsulated packet, unless we have already determine the hash
366 * over the L4 4-tuple.
368 skb_clear_hash_if_not_l4(skb
);
369 skb_set_queue_mapping(skb
, 0);
370 skb_scrub_packet(skb
, !net_eq(net
, dev_net(dev
)));
374 * skb_tunnel_rx - prepare skb for rx reinsert
376 * @dev: tunnel device
378 * After decapsulation, packet is going to re-enter (netif_rx()) our stack,
379 * so make some cleanups, and perform accounting.
380 * Note: this accounting is not SMP safe.
382 static inline void skb_tunnel_rx(struct sk_buff
*skb
, struct net_device
*dev
,
385 /* TODO : stats should be SMP safe */
386 dev
->stats
.rx_packets
++;
387 dev
->stats
.rx_bytes
+= skb
->len
;
388 __skb_tunnel_rx(skb
, dev
, net
);
391 /* Children define the path of the packet through the
392 * Linux networking. Thus, destinations are stackable.
395 static inline struct dst_entry
*skb_dst_pop(struct sk_buff
*skb
)
397 struct dst_entry
*child
= dst_clone(skb_dst(skb
)->child
);
403 int dst_discard_sk(struct sock
*sk
, struct sk_buff
*skb
);
404 static inline int dst_discard(struct sk_buff
*skb
)
406 return dst_discard_sk(skb
->sk
, skb
);
408 void *dst_alloc(struct dst_ops
*ops
, struct net_device
*dev
, int initial_ref
,
409 int initial_obsolete
, unsigned short flags
);
410 void __dst_free(struct dst_entry
*dst
);
411 struct dst_entry
*dst_destroy(struct dst_entry
*dst
);
413 static inline void dst_free(struct dst_entry
*dst
)
415 if (dst
->obsolete
> 0)
417 if (!atomic_read(&dst
->__refcnt
)) {
418 dst
= dst_destroy(dst
);
425 static inline void dst_rcu_free(struct rcu_head
*head
)
427 struct dst_entry
*dst
= container_of(head
, struct dst_entry
, rcu_head
);
431 static inline void dst_confirm(struct dst_entry
*dst
)
433 dst
->pending_confirm
= 1;
436 static inline int dst_neigh_output(struct dst_entry
*dst
, struct neighbour
*n
,
439 const struct hh_cache
*hh
;
441 if (dst
->pending_confirm
) {
442 unsigned long now
= jiffies
;
444 dst
->pending_confirm
= 0;
445 /* avoid dirtying neighbour */
446 if (n
->confirmed
!= now
)
451 if ((n
->nud_state
& NUD_CONNECTED
) && hh
->hh_len
)
452 return neigh_hh_output(hh
, skb
);
454 return n
->output(n
, skb
);
457 static inline struct neighbour
*dst_neigh_lookup(const struct dst_entry
*dst
, const void *daddr
)
459 struct neighbour
*n
= dst
->ops
->neigh_lookup(dst
, NULL
, daddr
);
460 return IS_ERR(n
) ? NULL
: n
;
463 static inline struct neighbour
*dst_neigh_lookup_skb(const struct dst_entry
*dst
,
466 struct neighbour
*n
= dst
->ops
->neigh_lookup(dst
, skb
, NULL
);
467 return IS_ERR(n
) ? NULL
: n
;
470 static inline void dst_link_failure(struct sk_buff
*skb
)
472 struct dst_entry
*dst
= skb_dst(skb
);
473 if (dst
&& dst
->ops
&& dst
->ops
->link_failure
)
474 dst
->ops
->link_failure(skb
);
477 static inline void dst_set_expires(struct dst_entry
*dst
, int timeout
)
479 unsigned long expires
= jiffies
+ timeout
;
484 if (dst
->expires
== 0 || time_before(expires
, dst
->expires
))
485 dst
->expires
= expires
;
488 /* Output packet to network from transport. */
489 static inline int dst_output_sk(struct sock
*sk
, struct sk_buff
*skb
)
491 return skb_dst(skb
)->output(sk
, skb
);
493 static inline int dst_output(struct sk_buff
*skb
)
495 return dst_output_sk(skb
->sk
, skb
);
498 /* Input packet from network to transport. */
499 static inline int dst_input(struct sk_buff
*skb
)
501 return skb_dst(skb
)->input(skb
);
504 static inline struct dst_entry
*dst_check(struct dst_entry
*dst
, u32 cookie
)
507 dst
= dst
->ops
->check(dst
, cookie
);
513 /* Flags for xfrm_lookup flags argument. */
515 XFRM_LOOKUP_ICMP
= 1 << 0,
516 XFRM_LOOKUP_QUEUE
= 1 << 1,
517 XFRM_LOOKUP_KEEP_DST_REF
= 1 << 2,
522 static inline struct dst_entry
*xfrm_lookup(struct net
*net
,
523 struct dst_entry
*dst_orig
,
524 const struct flowi
*fl
, struct sock
*sk
,
530 static inline struct dst_entry
*xfrm_lookup_route(struct net
*net
,
531 struct dst_entry
*dst_orig
,
532 const struct flowi
*fl
,
539 static inline struct xfrm_state
*dst_xfrm(const struct dst_entry
*dst
)
545 struct dst_entry
*xfrm_lookup(struct net
*net
, struct dst_entry
*dst_orig
,
546 const struct flowi
*fl
, struct sock
*sk
,
549 struct dst_entry
*xfrm_lookup_route(struct net
*net
, struct dst_entry
*dst_orig
,
550 const struct flowi
*fl
, struct sock
*sk
,
553 /* skb attached with this dst needs transformation if dst->xfrm is valid */
554 static inline struct xfrm_state
*dst_xfrm(const struct dst_entry
*dst
)
560 #endif /* _NET_DST_H */