]> git.proxmox.com Git - mirror_ubuntu-bionic-kernel.git/blame - include/net/dst.h
decnet (dn*.h): Remove extern from function prototypes
[mirror_ubuntu-bionic-kernel.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;
ecd98837 39 unsigned long expires;
f1dd9c37 40 struct dst_entry *path;
ecd98837 41 struct dst_entry *from;
def8b4fa 42#ifdef CONFIG_XFRM
1da177e4 43 struct xfrm_state *xfrm;
5635c10d
ED
44#else
45 void *__pad1;
def8b4fa 46#endif
7f95e188
EZ
47 int (*input)(struct sk_buff *);
48 int (*output)(struct sk_buff *);
1da177e4 49
5110effe 50 unsigned short flags;
f6b72b62
DM
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
e688a604 57#define DST_NOPEER 0x0040
a881e963 58#define DST_FAKE_RTABLE 0x0080
0c183379 59#define DST_XFRM_TUNNEL 0x0100
a0073fe1 60#define DST_XFRM_QUEUE 0x0200
f6b72b62 61
5110effe
DM
62 unsigned short pending_confirm;
63
62fa8a84 64 short error;
f5b0a874
DM
65
66 /* A non-zero value of dst->obsolete forces by-hand validation
67 * of the route entry. Positive values are set by the generic
68 * dst layer to indicate that the entry has been forcefully
69 * destroyed.
70 *
71 * Negative values are used by the implementation layer code to
72 * force invocation of the dst_ops->check() method.
73 */
62fa8a84 74 short obsolete;
f5b0a874
DM
75#define DST_OBSOLETE_NONE 0
76#define DST_OBSOLETE_DEAD 2
77#define DST_OBSOLETE_FORCE_CHK -1
ceb33206 78#define DST_OBSOLETE_KILL -2
62fa8a84
DM
79 unsigned short header_len; /* more space at head required */
80 unsigned short trailer_len; /* space to reserve at tail */
c7066f70 81#ifdef CONFIG_IP_ROUTE_CLASSID
f1dd9c37 82 __u32 tclassid;
5635c10d
ED
83#else
84 __u32 __pad2;
f1dd9c37
ZY
85#endif
86
5635c10d
ED
87 /*
88 * Align __refcnt to a 64 bytes alignment
89 * (L1_CACHE_SIZE would be too much)
90 */
91#ifdef CONFIG_64BIT
f6b72b62 92 long __pad_to_align_refcnt[2];
5635c10d 93#endif
f1dd9c37
ZY
94 /*
95 * __refcnt wants to be on a different cache line from
96 * input/output/ops or performance tanks badly
97 */
1e19e02c
ED
98 atomic_t __refcnt; /* client references */
99 int __use;
f1dd9c37 100 unsigned long lastuse;
1e19e02c 101 union {
fc766e4c
ED
102 struct dst_entry *next;
103 struct rtable __rcu *rt_next;
104 struct rt6_info *rt6_next;
105 struct dn_route __rcu *dn_next;
1e19e02c 106 };
1da177e4
LT
107};
108
62fa8a84 109extern u32 *dst_cow_metrics_generic(struct dst_entry *dst, unsigned long old);
a37e6e34 110extern const u32 dst_default_metrics[];
62fa8a84
DM
111
112#define DST_METRICS_READ_ONLY 0x1UL
113#define __DST_METRICS_PTR(Y) \
114 ((u32 *)((Y) & ~DST_METRICS_READ_ONLY))
115#define DST_METRICS_PTR(X) __DST_METRICS_PTR((X)->_metrics)
116
117static inline bool dst_metrics_read_only(const struct dst_entry *dst)
118{
119 return dst->_metrics & DST_METRICS_READ_ONLY;
120}
121
122extern void __dst_destroy_metrics_generic(struct dst_entry *dst, unsigned long old);
123
124static inline void dst_destroy_metrics_generic(struct dst_entry *dst)
125{
126 unsigned long val = dst->_metrics;
127 if (!(val & DST_METRICS_READ_ONLY))
128 __dst_destroy_metrics_generic(dst, val);
129}
130
131static inline u32 *dst_metrics_write_ptr(struct dst_entry *dst)
132{
133 unsigned long p = dst->_metrics;
134
1f37070d
SH
135 BUG_ON(!p);
136
62fa8a84
DM
137 if (p & DST_METRICS_READ_ONLY)
138 return dst->ops->cow_metrics(dst, p);
139 return __DST_METRICS_PTR(p);
140}
141
142/* This may only be invoked before the entry has reached global
143 * visibility.
144 */
145static inline void dst_init_metrics(struct dst_entry *dst,
146 const u32 *src_metrics,
147 bool read_only)
148{
149 dst->_metrics = ((unsigned long) src_metrics) |
150 (read_only ? DST_METRICS_READ_ONLY : 0);
151}
152
153static inline void dst_copy_metrics(struct dst_entry *dest, const struct dst_entry *src)
154{
155 u32 *dst_metrics = dst_metrics_write_ptr(dest);
156
157 if (dst_metrics) {
158 u32 *src_metrics = DST_METRICS_PTR(src);
159
160 memcpy(dst_metrics, src_metrics, RTAX_MAX * sizeof(u32));
161 }
162}
163
164static inline u32 *dst_metrics_ptr(struct dst_entry *dst)
165{
166 return DST_METRICS_PTR(dst);
167}
168
1da177e4 169static inline u32
5170ae82 170dst_metric_raw(const struct dst_entry *dst, const int metric)
1da177e4 171{
62fa8a84
DM
172 u32 *p = DST_METRICS_PTR(dst);
173
174 return p[metric-1];
defb3519
DM
175}
176
5170ae82
DM
177static inline u32
178dst_metric(const struct dst_entry *dst, const int metric)
179{
0dbaee3b 180 WARN_ON_ONCE(metric == RTAX_HOPLIMIT ||
d33e4553
DM
181 metric == RTAX_ADVMSS ||
182 metric == RTAX_MTU);
5170ae82
DM
183 return dst_metric_raw(dst, metric);
184}
185
0dbaee3b
DM
186static inline u32
187dst_metric_advmss(const struct dst_entry *dst)
188{
189 u32 advmss = dst_metric_raw(dst, RTAX_ADVMSS);
190
191 if (!advmss)
192 advmss = dst->ops->default_advmss(dst);
193
194 return advmss;
195}
196
defb3519
DM
197static inline void dst_metric_set(struct dst_entry *dst, int metric, u32 val)
198{
62fa8a84 199 u32 *p = dst_metrics_write_ptr(dst);
defb3519 200
62fa8a84
DM
201 if (p)
202 p[metric-1] = val;
1da177e4
LT
203}
204
0c3adfb8
GBY
205static inline u32
206dst_feature(const struct dst_entry *dst, u32 feature)
207{
bb5b7c11 208 return dst_metric(dst, RTAX_FEATURES) & feature;
0c3adfb8
GBY
209}
210
1da177e4
LT
211static inline u32 dst_mtu(const struct dst_entry *dst)
212{
618f9bc7 213 return dst->ops->mtu(dst);
1da177e4
LT
214}
215
c1e20f7c
SH
216/* RTT metrics are stored in milliseconds for user ABI, but used as jiffies */
217static inline unsigned long dst_metric_rtt(const struct dst_entry *dst, int metric)
218{
219 return msecs_to_jiffies(dst_metric(dst, metric));
220}
221
1da177e4
LT
222static inline u32
223dst_allfrag(const struct dst_entry *dst)
224{
0c3adfb8 225 int ret = dst_feature(dst, RTAX_FEATURE_ALLFRAG);
1da177e4
LT
226 return ret;
227}
228
229static inline int
d33e4553 230dst_metric_locked(const struct dst_entry *dst, int metric)
1da177e4
LT
231{
232 return dst_metric(dst, RTAX_LOCK) & (1<<metric);
233}
234
7f95e188 235static inline void dst_hold(struct dst_entry *dst)
1da177e4 236{
5635c10d
ED
237 /*
238 * If your kernel compilation stops here, please check
239 * __pad_to_align_refcnt declaration in struct dst_entry
240 */
241 BUILD_BUG_ON(offsetof(struct dst_entry, __refcnt) & 63);
1da177e4
LT
242 atomic_inc(&dst->__refcnt);
243}
244
03f49f34
PE
245static inline void dst_use(struct dst_entry *dst, unsigned long time)
246{
247 dst_hold(dst);
248 dst->__use++;
249 dst->lastuse = time;
250}
251
7fee226a
ED
252static inline void dst_use_noref(struct dst_entry *dst, unsigned long time)
253{
254 dst->__use++;
255 dst->lastuse = time;
256}
257
7f95e188 258static inline struct dst_entry *dst_clone(struct dst_entry *dst)
1da177e4
LT
259{
260 if (dst)
261 atomic_inc(&dst->__refcnt);
262 return dst;
263}
264
8d330868 265extern void dst_release(struct dst_entry *dst);
7fee226a
ED
266
267static inline void refdst_drop(unsigned long refdst)
268{
269 if (!(refdst & SKB_DST_NOREF))
270 dst_release((struct dst_entry *)(refdst & SKB_DST_PTRMASK));
271}
272
273/**
274 * skb_dst_drop - drops skb dst
275 * @skb: buffer
276 *
277 * Drops dst reference count if a reference was taken.
278 */
adf30907
ED
279static inline void skb_dst_drop(struct sk_buff *skb)
280{
7fee226a
ED
281 if (skb->_skb_refdst) {
282 refdst_drop(skb->_skb_refdst);
283 skb->_skb_refdst = 0UL;
284 }
285}
286
287static inline void skb_dst_copy(struct sk_buff *nskb, const struct sk_buff *oskb)
288{
289 nskb->_skb_refdst = oskb->_skb_refdst;
290 if (!(nskb->_skb_refdst & SKB_DST_NOREF))
291 dst_clone(skb_dst(nskb));
292}
293
294/**
295 * skb_dst_force - makes sure skb dst is refcounted
296 * @skb: buffer
297 *
298 * If dst is not yet refcounted, let's do it
299 */
300static inline void skb_dst_force(struct sk_buff *skb)
301{
302 if (skb_dst_is_noref(skb)) {
303 WARN_ON(!rcu_read_lock_held());
304 skb->_skb_refdst &= ~SKB_DST_NOREF;
305 dst_clone(skb_dst(skb));
306 }
adf30907 307}
1da177e4 308
d19d56dd 309
290b895e
ED
310/**
311 * __skb_tunnel_rx - prepare skb for rx reinsert
312 * @skb: buffer
313 * @dev: tunnel device
ea23192e 314 * @net: netns for packet i/o
290b895e
ED
315 *
316 * After decapsulation, packet is going to re-enter (netif_rx()) our stack,
317 * so make some cleanups. (no accounting done)
318 */
ea23192e
ND
319static inline void __skb_tunnel_rx(struct sk_buff *skb, struct net_device *dev,
320 struct net *net)
290b895e
ED
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 331 skb_set_queue_mapping(skb, 0);
ea23192e 332 skb_scrub_packet(skb, !net_eq(net, dev_net(dev)));
290b895e
ED
333}
334
d19d56dd
ED
335/**
336 * skb_tunnel_rx - prepare skb for rx reinsert
337 * @skb: buffer
338 * @dev: tunnel device
339 *
340 * After decapsulation, packet is going to re-enter (netif_rx()) our stack,
341 * so make some cleanups, and perform accounting.
290b895e 342 * Note: this accounting is not SMP safe.
d19d56dd 343 */
ea23192e
ND
344static inline void skb_tunnel_rx(struct sk_buff *skb, struct net_device *dev,
345 struct net *net)
d19d56dd 346{
d19d56dd
ED
347 /* TODO : stats should be SMP safe */
348 dev->stats.rx_packets++;
349 dev->stats.rx_bytes += skb->len;
ea23192e 350 __skb_tunnel_rx(skb, dev, net);
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{
425f09ab
ED
398 const struct hh_cache *hh;
399
400 if (dst->pending_confirm) {
401 unsigned long now = jiffies;
5110effe 402
5110effe 403 dst->pending_confirm = 0;
425f09ab
ED
404 /* avoid dirtying neighbour */
405 if (n->confirmed != now)
406 n->confirmed = now;
69cce1d1 407 }
5110effe
DM
408
409 hh = &n->hh;
410 if ((n->nud_state & NUD_CONNECTED) && hh->hh_len)
411 return neigh_hh_output(hh, skb);
412 else
413 return n->output(n, skb);
1da177e4
LT
414}
415
d3aaeb38
DM
416static inline struct neighbour *dst_neigh_lookup(const struct dst_entry *dst, const void *daddr)
417{
aaa0c23c
ZZ
418 struct neighbour *n = dst->ops->neigh_lookup(dst, NULL, daddr);
419 return IS_ERR(n) ? NULL : n;
f894cbf8
DM
420}
421
422static inline struct neighbour *dst_neigh_lookup_skb(const struct dst_entry *dst,
423 struct sk_buff *skb)
424{
aaa0c23c
ZZ
425 struct neighbour *n = dst->ops->neigh_lookup(dst, skb, NULL);
426 return IS_ERR(n) ? NULL : n;
d3aaeb38
DM
427}
428
1da177e4
LT
429static inline void dst_link_failure(struct sk_buff *skb)
430{
adf30907 431 struct dst_entry *dst = skb_dst(skb);
1da177e4
LT
432 if (dst && dst->ops && dst->ops->link_failure)
433 dst->ops->link_failure(skb);
434}
435
436static inline void dst_set_expires(struct dst_entry *dst, int timeout)
437{
438 unsigned long expires = jiffies + timeout;
439
440 if (expires == 0)
441 expires = 1;
442
443 if (dst->expires == 0 || time_before(expires, dst->expires))
444 dst->expires = expires;
445}
446
447/* Output packet to network from transport. */
448static inline int dst_output(struct sk_buff *skb)
449{
adf30907 450 return skb_dst(skb)->output(skb);
1da177e4
LT
451}
452
453/* Input packet from network to transport. */
454static inline int dst_input(struct sk_buff *skb)
455{
adf30907 456 return skb_dst(skb)->input(skb);
1da177e4
LT
457}
458
459static inline struct dst_entry *dst_check(struct dst_entry *dst, u32 cookie)
460{
461 if (dst->obsolete)
462 dst = dst->ops->check(dst, cookie);
463 return dst;
464}
465
466extern void dst_init(void);
467
815f4e57
HX
468/* Flags for xfrm_lookup flags argument. */
469enum {
80c0bc9e 470 XFRM_LOOKUP_ICMP = 1 << 0,
815f4e57
HX
471};
472
1da177e4
LT
473struct flowi;
474#ifndef CONFIG_XFRM
452edd59
DM
475static inline struct dst_entry *xfrm_lookup(struct net *net,
476 struct dst_entry *dst_orig,
477 const struct flowi *fl, struct sock *sk,
478 int flags)
1da177e4 479{
452edd59 480 return dst_orig;
1da177e4
LT
481}
482#else
452edd59
DM
483extern struct dst_entry *xfrm_lookup(struct net *net, struct dst_entry *dst_orig,
484 const struct flowi *fl, struct sock *sk,
485 int flags);
1da177e4 486#endif
1da177e4
LT
487
488#endif /* _NET_DST_H */