Merge tag 'vfio-v6.8-rc1' of https://github.com/awilliam/linux-vfio
[linux-2.6-microblaze.git] / include / net / dst.h
1 /* SPDX-License-Identifier: GPL-2.0 */
2 /*
3  * net/dst.h    Protocol independent destination cache definitions.
4  *
5  * Authors:     Alexey Kuznetsov, <kuznet@ms2.inr.ac.ru>
6  *
7  */
8
9 #ifndef _NET_DST_H
10 #define _NET_DST_H
11
12 #include <net/dst_ops.h>
13 #include <linux/netdevice.h>
14 #include <linux/rtnetlink.h>
15 #include <linux/rcupdate.h>
16 #include <linux/bug.h>
17 #include <linux/jiffies.h>
18 #include <linux/refcount.h>
19 #include <linux/rcuref.h>
20 #include <net/neighbour.h>
21 #include <asm/processor.h>
22 #include <linux/indirect_call_wrapper.h>
23
24 struct sk_buff;
25
26 struct dst_entry {
27         struct net_device       *dev;
28         struct  dst_ops         *ops;
29         unsigned long           _metrics;
30         unsigned long           expires;
31 #ifdef CONFIG_XFRM
32         struct xfrm_state       *xfrm;
33 #else
34         void                    *__pad1;
35 #endif
36         int                     (*input)(struct sk_buff *);
37         int                     (*output)(struct net *net, struct sock *sk, struct sk_buff *skb);
38
39         unsigned short          flags;
40 #define DST_NOXFRM              0x0002
41 #define DST_NOPOLICY            0x0004
42 #define DST_NOCOUNT             0x0008
43 #define DST_FAKE_RTABLE         0x0010
44 #define DST_XFRM_TUNNEL         0x0020
45 #define DST_XFRM_QUEUE          0x0040
46 #define DST_METADATA            0x0080
47
48         /* A non-zero value of dst->obsolete forces by-hand validation
49          * of the route entry.  Positive values are set by the generic
50          * dst layer to indicate that the entry has been forcefully
51          * destroyed.
52          *
53          * Negative values are used by the implementation layer code to
54          * force invocation of the dst_ops->check() method.
55          */
56         short                   obsolete;
57 #define DST_OBSOLETE_NONE       0
58 #define DST_OBSOLETE_DEAD       2
59 #define DST_OBSOLETE_FORCE_CHK  -1
60 #define DST_OBSOLETE_KILL       -2
61         unsigned short          header_len;     /* more space at head required */
62         unsigned short          trailer_len;    /* space to reserve at tail */
63
64         /*
65          * __rcuref wants to be on a different cache line from
66          * input/output/ops or performance tanks badly
67          */
68 #ifdef CONFIG_64BIT
69         rcuref_t                __rcuref;       /* 64-bit offset 64 */
70 #endif
71         int                     __use;
72         unsigned long           lastuse;
73         struct rcu_head         rcu_head;
74         short                   error;
75         short                   __pad;
76         __u32                   tclassid;
77 #ifndef CONFIG_64BIT
78         struct lwtunnel_state   *lwtstate;
79         rcuref_t                __rcuref;       /* 32-bit offset 64 */
80 #endif
81         netdevice_tracker       dev_tracker;
82
83         /*
84          * Used by rtable and rt6_info. Moves lwtstate into the next cache
85          * line on 64bit so that lwtstate does not cause false sharing with
86          * __rcuref under contention of __rcuref. This also puts the
87          * frequently accessed members of rtable and rt6_info out of the
88          * __rcuref cache line.
89          */
90         struct list_head        rt_uncached;
91         struct uncached_list    *rt_uncached_list;
92 #ifdef CONFIG_64BIT
93         struct lwtunnel_state   *lwtstate;
94 #endif
95 };
96
97 struct dst_metrics {
98         u32             metrics[RTAX_MAX];
99         refcount_t      refcnt;
100 } __aligned(4);         /* Low pointer bits contain DST_METRICS_FLAGS */
101 extern const struct dst_metrics dst_default_metrics;
102
103 u32 *dst_cow_metrics_generic(struct dst_entry *dst, unsigned long old);
104
105 #define DST_METRICS_READ_ONLY           0x1UL
106 #define DST_METRICS_REFCOUNTED          0x2UL
107 #define DST_METRICS_FLAGS               0x3UL
108 #define __DST_METRICS_PTR(Y)    \
109         ((u32 *)((Y) & ~DST_METRICS_FLAGS))
110 #define DST_METRICS_PTR(X)      __DST_METRICS_PTR((X)->_metrics)
111
112 static inline bool dst_metrics_read_only(const struct dst_entry *dst)
113 {
114         return dst->_metrics & DST_METRICS_READ_ONLY;
115 }
116
117 void __dst_destroy_metrics_generic(struct dst_entry *dst, unsigned long old);
118
119 static inline void dst_destroy_metrics_generic(struct dst_entry *dst)
120 {
121         unsigned long val = dst->_metrics;
122         if (!(val & DST_METRICS_READ_ONLY))
123                 __dst_destroy_metrics_generic(dst, val);
124 }
125
126 static inline u32 *dst_metrics_write_ptr(struct dst_entry *dst)
127 {
128         unsigned long p = dst->_metrics;
129
130         BUG_ON(!p);
131
132         if (p & DST_METRICS_READ_ONLY)
133                 return dst->ops->cow_metrics(dst, p);
134         return __DST_METRICS_PTR(p);
135 }
136
137 /* This may only be invoked before the entry has reached global
138  * visibility.
139  */
140 static inline void dst_init_metrics(struct dst_entry *dst,
141                                     const u32 *src_metrics,
142                                     bool read_only)
143 {
144         dst->_metrics = ((unsigned long) src_metrics) |
145                 (read_only ? DST_METRICS_READ_ONLY : 0);
146 }
147
148 static inline void dst_copy_metrics(struct dst_entry *dest, const struct dst_entry *src)
149 {
150         u32 *dst_metrics = dst_metrics_write_ptr(dest);
151
152         if (dst_metrics) {
153                 u32 *src_metrics = DST_METRICS_PTR(src);
154
155                 memcpy(dst_metrics, src_metrics, RTAX_MAX * sizeof(u32));
156         }
157 }
158
159 static inline u32 *dst_metrics_ptr(struct dst_entry *dst)
160 {
161         return DST_METRICS_PTR(dst);
162 }
163
164 static inline u32
165 dst_metric_raw(const struct dst_entry *dst, const int metric)
166 {
167         u32 *p = DST_METRICS_PTR(dst);
168
169         return p[metric-1];
170 }
171
172 static inline u32
173 dst_metric(const struct dst_entry *dst, const int metric)
174 {
175         WARN_ON_ONCE(metric == RTAX_HOPLIMIT ||
176                      metric == RTAX_ADVMSS ||
177                      metric == RTAX_MTU);
178         return dst_metric_raw(dst, metric);
179 }
180
181 static inline u32
182 dst_metric_advmss(const struct dst_entry *dst)
183 {
184         u32 advmss = dst_metric_raw(dst, RTAX_ADVMSS);
185
186         if (!advmss)
187                 advmss = dst->ops->default_advmss(dst);
188
189         return advmss;
190 }
191
192 static inline void dst_metric_set(struct dst_entry *dst, int metric, u32 val)
193 {
194         u32 *p = dst_metrics_write_ptr(dst);
195
196         if (p)
197                 p[metric-1] = val;
198 }
199
200 /* Kernel-internal feature bits that are unallocated in user space. */
201 #define DST_FEATURE_ECN_CA      (1U << 31)
202
203 #define DST_FEATURE_MASK        (DST_FEATURE_ECN_CA)
204 #define DST_FEATURE_ECN_MASK    (DST_FEATURE_ECN_CA | RTAX_FEATURE_ECN)
205
206 static inline u32
207 dst_feature(const struct dst_entry *dst, u32 feature)
208 {
209         return dst_metric(dst, RTAX_FEATURES) & feature;
210 }
211
212 INDIRECT_CALLABLE_DECLARE(unsigned int ip6_mtu(const struct dst_entry *));
213 INDIRECT_CALLABLE_DECLARE(unsigned int ipv4_mtu(const struct dst_entry *));
214 static inline u32 dst_mtu(const struct dst_entry *dst)
215 {
216         return INDIRECT_CALL_INET(dst->ops->mtu, ip6_mtu, ipv4_mtu, dst);
217 }
218
219 /* RTT metrics are stored in milliseconds for user ABI, but used as jiffies */
220 static inline unsigned long dst_metric_rtt(const struct dst_entry *dst, int metric)
221 {
222         return msecs_to_jiffies(dst_metric(dst, metric));
223 }
224
225 static inline int
226 dst_metric_locked(const struct dst_entry *dst, int metric)
227 {
228         return dst_metric(dst, RTAX_LOCK) & (1 << metric);
229 }
230
231 static inline void dst_hold(struct dst_entry *dst)
232 {
233         /*
234          * If your kernel compilation stops here, please check
235          * the placement of __rcuref in struct dst_entry
236          */
237         BUILD_BUG_ON(offsetof(struct dst_entry, __rcuref) & 63);
238         WARN_ON(!rcuref_get(&dst->__rcuref));
239 }
240
241 static inline void dst_use_noref(struct dst_entry *dst, unsigned long time)
242 {
243         if (unlikely(time != dst->lastuse)) {
244                 dst->__use++;
245                 dst->lastuse = time;
246         }
247 }
248
249 static inline struct dst_entry *dst_clone(struct dst_entry *dst)
250 {
251         if (dst)
252                 dst_hold(dst);
253         return dst;
254 }
255
256 void dst_release(struct dst_entry *dst);
257
258 void dst_release_immediate(struct dst_entry *dst);
259
260 static inline void refdst_drop(unsigned long refdst)
261 {
262         if (!(refdst & SKB_DST_NOREF))
263                 dst_release((struct dst_entry *)(refdst & SKB_DST_PTRMASK));
264 }
265
266 /**
267  * skb_dst_drop - drops skb dst
268  * @skb: buffer
269  *
270  * Drops dst reference count if a reference was taken.
271  */
272 static inline void skb_dst_drop(struct sk_buff *skb)
273 {
274         if (skb->_skb_refdst) {
275                 refdst_drop(skb->_skb_refdst);
276                 skb->_skb_refdst = 0UL;
277         }
278 }
279
280 static inline void __skb_dst_copy(struct sk_buff *nskb, unsigned long refdst)
281 {
282         nskb->slow_gro |= !!refdst;
283         nskb->_skb_refdst = refdst;
284         if (!(nskb->_skb_refdst & SKB_DST_NOREF))
285                 dst_clone(skb_dst(nskb));
286 }
287
288 static inline void skb_dst_copy(struct sk_buff *nskb, const struct sk_buff *oskb)
289 {
290         __skb_dst_copy(nskb, oskb->_skb_refdst);
291 }
292
293 /**
294  * dst_hold_safe - Take a reference on a dst if possible
295  * @dst: pointer to dst entry
296  *
297  * This helper returns false if it could not safely
298  * take a reference on a dst.
299  */
300 static inline bool dst_hold_safe(struct dst_entry *dst)
301 {
302         return rcuref_get(&dst->__rcuref);
303 }
304
305 /**
306  * skb_dst_force - makes sure skb dst is refcounted
307  * @skb: buffer
308  *
309  * If dst is not yet refcounted and not destroyed, grab a ref on it.
310  * Returns true if dst is refcounted.
311  */
312 static inline bool skb_dst_force(struct sk_buff *skb)
313 {
314         if (skb_dst_is_noref(skb)) {
315                 struct dst_entry *dst = skb_dst(skb);
316
317                 WARN_ON(!rcu_read_lock_held());
318                 if (!dst_hold_safe(dst))
319                         dst = NULL;
320
321                 skb->_skb_refdst = (unsigned long)dst;
322                 skb->slow_gro |= !!dst;
323         }
324
325         return skb->_skb_refdst != 0UL;
326 }
327
328
329 /**
330  *      __skb_tunnel_rx - prepare skb for rx reinsert
331  *      @skb: buffer
332  *      @dev: tunnel device
333  *      @net: netns for packet i/o
334  *
335  *      After decapsulation, packet is going to re-enter (netif_rx()) our stack,
336  *      so make some cleanups. (no accounting done)
337  */
338 static inline void __skb_tunnel_rx(struct sk_buff *skb, struct net_device *dev,
339                                    struct net *net)
340 {
341         skb->dev = dev;
342
343         /*
344          * Clear hash so that we can recalulate the hash for the
345          * encapsulated packet, unless we have already determine the hash
346          * over the L4 4-tuple.
347          */
348         skb_clear_hash_if_not_l4(skb);
349         skb_set_queue_mapping(skb, 0);
350         skb_scrub_packet(skb, !net_eq(net, dev_net(dev)));
351 }
352
353 /**
354  *      skb_tunnel_rx - prepare skb for rx reinsert
355  *      @skb: buffer
356  *      @dev: tunnel device
357  *      @net: netns for packet i/o
358  *
359  *      After decapsulation, packet is going to re-enter (netif_rx()) our stack,
360  *      so make some cleanups, and perform accounting.
361  *      Note: this accounting is not SMP safe.
362  */
363 static inline void skb_tunnel_rx(struct sk_buff *skb, struct net_device *dev,
364                                  struct net *net)
365 {
366         DEV_STATS_INC(dev, rx_packets);
367         DEV_STATS_ADD(dev, rx_bytes, skb->len);
368         __skb_tunnel_rx(skb, dev, net);
369 }
370
371 static inline u32 dst_tclassid(const struct sk_buff *skb)
372 {
373 #ifdef CONFIG_IP_ROUTE_CLASSID
374         const struct dst_entry *dst;
375
376         dst = skb_dst(skb);
377         if (dst)
378                 return dst->tclassid;
379 #endif
380         return 0;
381 }
382
383 int dst_discard_out(struct net *net, struct sock *sk, struct sk_buff *skb);
384 static inline int dst_discard(struct sk_buff *skb)
385 {
386         return dst_discard_out(&init_net, skb->sk, skb);
387 }
388 void *dst_alloc(struct dst_ops *ops, struct net_device *dev,
389                 int initial_obsolete, unsigned short flags);
390 void dst_init(struct dst_entry *dst, struct dst_ops *ops,
391               struct net_device *dev, int initial_obsolete,
392               unsigned short flags);
393 struct dst_entry *dst_destroy(struct dst_entry *dst);
394 void dst_dev_put(struct dst_entry *dst);
395
396 static inline void dst_confirm(struct dst_entry *dst)
397 {
398 }
399
400 static inline struct neighbour *dst_neigh_lookup(const struct dst_entry *dst, const void *daddr)
401 {
402         struct neighbour *n = dst->ops->neigh_lookup(dst, NULL, daddr);
403         return IS_ERR(n) ? NULL : n;
404 }
405
406 static inline struct neighbour *dst_neigh_lookup_skb(const struct dst_entry *dst,
407                                                      struct sk_buff *skb)
408 {
409         struct neighbour *n;
410
411         if (WARN_ON_ONCE(!dst->ops->neigh_lookup))
412                 return NULL;
413
414         n = dst->ops->neigh_lookup(dst, skb, NULL);
415
416         return IS_ERR(n) ? NULL : n;
417 }
418
419 static inline void dst_confirm_neigh(const struct dst_entry *dst,
420                                      const void *daddr)
421 {
422         if (dst->ops->confirm_neigh)
423                 dst->ops->confirm_neigh(dst, daddr);
424 }
425
426 static inline void dst_link_failure(struct sk_buff *skb)
427 {
428         struct dst_entry *dst = skb_dst(skb);
429         if (dst && dst->ops && dst->ops->link_failure)
430                 dst->ops->link_failure(skb);
431 }
432
433 static inline void dst_set_expires(struct dst_entry *dst, int timeout)
434 {
435         unsigned long expires = jiffies + timeout;
436
437         if (expires == 0)
438                 expires = 1;
439
440         if (dst->expires == 0 || time_before(expires, dst->expires))
441                 dst->expires = expires;
442 }
443
444 INDIRECT_CALLABLE_DECLARE(int ip6_output(struct net *, struct sock *,
445                                          struct sk_buff *));
446 INDIRECT_CALLABLE_DECLARE(int ip_output(struct net *, struct sock *,
447                                          struct sk_buff *));
448 /* Output packet to network from transport.  */
449 static inline int dst_output(struct net *net, struct sock *sk, struct sk_buff *skb)
450 {
451         return INDIRECT_CALL_INET(skb_dst(skb)->output,
452                                   ip6_output, ip_output,
453                                   net, sk, skb);
454 }
455
456 INDIRECT_CALLABLE_DECLARE(int ip6_input(struct sk_buff *));
457 INDIRECT_CALLABLE_DECLARE(int ip_local_deliver(struct sk_buff *));
458 /* Input packet from network to transport.  */
459 static inline int dst_input(struct sk_buff *skb)
460 {
461         return INDIRECT_CALL_INET(skb_dst(skb)->input,
462                                   ip6_input, ip_local_deliver, skb);
463 }
464
465 INDIRECT_CALLABLE_DECLARE(struct dst_entry *ip6_dst_check(struct dst_entry *,
466                                                           u32));
467 INDIRECT_CALLABLE_DECLARE(struct dst_entry *ipv4_dst_check(struct dst_entry *,
468                                                            u32));
469 static inline struct dst_entry *dst_check(struct dst_entry *dst, u32 cookie)
470 {
471         if (dst->obsolete)
472                 dst = INDIRECT_CALL_INET(dst->ops->check, ip6_dst_check,
473                                          ipv4_dst_check, dst, cookie);
474         return dst;
475 }
476
477 /* Flags for xfrm_lookup flags argument. */
478 enum {
479         XFRM_LOOKUP_ICMP = 1 << 0,
480         XFRM_LOOKUP_QUEUE = 1 << 1,
481         XFRM_LOOKUP_KEEP_DST_REF = 1 << 2,
482 };
483
484 struct flowi;
485 #ifndef CONFIG_XFRM
486 static inline struct dst_entry *xfrm_lookup(struct net *net,
487                                             struct dst_entry *dst_orig,
488                                             const struct flowi *fl,
489                                             const struct sock *sk,
490                                             int flags)
491 {
492         return dst_orig;
493 }
494
495 static inline struct dst_entry *
496 xfrm_lookup_with_ifid(struct net *net, struct dst_entry *dst_orig,
497                       const struct flowi *fl, const struct sock *sk,
498                       int flags, u32 if_id)
499 {
500         return dst_orig;
501 }
502
503 static inline struct dst_entry *xfrm_lookup_route(struct net *net,
504                                                   struct dst_entry *dst_orig,
505                                                   const struct flowi *fl,
506                                                   const struct sock *sk,
507                                                   int flags)
508 {
509         return dst_orig;
510 }
511
512 static inline struct xfrm_state *dst_xfrm(const struct dst_entry *dst)
513 {
514         return NULL;
515 }
516
517 #else
518 struct dst_entry *xfrm_lookup(struct net *net, struct dst_entry *dst_orig,
519                               const struct flowi *fl, const struct sock *sk,
520                               int flags);
521
522 struct dst_entry *xfrm_lookup_with_ifid(struct net *net,
523                                         struct dst_entry *dst_orig,
524                                         const struct flowi *fl,
525                                         const struct sock *sk, int flags,
526                                         u32 if_id);
527
528 struct dst_entry *xfrm_lookup_route(struct net *net, struct dst_entry *dst_orig,
529                                     const struct flowi *fl, const struct sock *sk,
530                                     int flags);
531
532 /* skb attached with this dst needs transformation if dst->xfrm is valid */
533 static inline struct xfrm_state *dst_xfrm(const struct dst_entry *dst)
534 {
535         return dst->xfrm;
536 }
537 #endif
538
539 static inline void skb_dst_update_pmtu(struct sk_buff *skb, u32 mtu)
540 {
541         struct dst_entry *dst = skb_dst(skb);
542
543         if (dst && dst->ops->update_pmtu)
544                 dst->ops->update_pmtu(dst, NULL, skb, mtu, true);
545 }
546
547 /* update dst pmtu but not do neighbor confirm */
548 static inline void skb_dst_update_pmtu_no_confirm(struct sk_buff *skb, u32 mtu)
549 {
550         struct dst_entry *dst = skb_dst(skb);
551
552         if (dst && dst->ops->update_pmtu)
553                 dst->ops->update_pmtu(dst, NULL, skb, mtu, false);
554 }
555
556 struct dst_entry *dst_blackhole_check(struct dst_entry *dst, u32 cookie);
557 void dst_blackhole_update_pmtu(struct dst_entry *dst, struct sock *sk,
558                                struct sk_buff *skb, u32 mtu, bool confirm_neigh);
559 void dst_blackhole_redirect(struct dst_entry *dst, struct sock *sk,
560                             struct sk_buff *skb);
561 u32 *dst_blackhole_cow_metrics(struct dst_entry *dst, unsigned long old);
562 struct neighbour *dst_blackhole_neigh_lookup(const struct dst_entry *dst,
563                                              struct sk_buff *skb,
564                                              const void *daddr);
565 unsigned int dst_blackhole_mtu(const struct dst_entry *dst);
566
567 #endif /* _NET_DST_H */