include/net/dst.h

   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
  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>
  19
  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
  31 struct sk_buff;
  32
  33 struct dst_entry {
  34         struct rcu_head         rcu_head;
  35         struct dst_entry        *child;
  36         struct net_device       *dev;
  37         struct  dst_ops         *ops;
  38         unsigned long           _metrics;
  39         unsigned long           expires;
  40         struct dst_entry        *path;
  41         struct dst_entry        *from;
  42 #ifdef CONFIG_XFRM
  43         struct xfrm_state       *xfrm;
  44 #else
  45         void                    *__pad1;
  46 #endif
  47         int                     (*input)(struct sk_buff *);
  48         int                     (*output)(struct net *net, struct sock *sk, struct sk_buff *skb);
  49
  50         unsigned short          flags;
  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
  60 #define DST_METADATA            0x0200
  61
  62         unsigned short          pending_confirm;
  63
  64         short                   error;
  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          */
  74         short                   obsolete;
  75 #define DST_OBSOLETE_NONE       0
  76 #define DST_OBSOLETE_DEAD       2
  77 #define DST_OBSOLETE_FORCE_CHK  -1
  78 #define DST_OBSOLETE_KILL       -2
  79         unsigned short          header_len;     /* more space at head required */
  80         unsigned short          trailer_len;    /* space to reserve at tail */
  81 #ifdef CONFIG_IP_ROUTE_CLASSID
  82         __u32                   tclassid;
  83 #else
  84         __u32                   __pad2;
  85 #endif
  86
  87 #ifdef CONFIG_64BIT
  88         struct lwtunnel_state   *lwtstate;
  89         /*
  90          * Align __refcnt to a 64 bytes alignment
  91          * (L1_CACHE_SIZE would be too much)
  92          */
  93         long                    __pad_to_align_refcnt[1];
  94 #endif
  95         /*
  96          * __refcnt wants to be on a different cache line from
  97          * input/output/ops or performance tanks badly
  98          */
  99         atomic_t                __refcnt;       /* client references    */
 100         int                     __use;
 101         unsigned long           lastuse;
 102 #ifndef CONFIG_64BIT
 103         struct lwtunnel_state   *lwtstate;
 104 #endif
 105         union {
 106                 struct dst_entry        *next;
 107                 struct rtable __rcu     *rt_next;
 108                 struct rt6_info         *rt6_next;
 109                 struct dn_route __rcu   *dn_next;
 110         };
 111 };
 112
 113 struct dst_metrics {
 114         u32             metrics[RTAX_MAX];
 115         atomic_t        refcnt;
 116 } __aligned(4);         /* Low pointer bits contain DST_METRICS_FLAGS */
 117 extern const struct dst_metrics dst_default_metrics;
 118
 119 u32 *dst_cow_metrics_generic(struct dst_entry *dst, unsigned long old);
 120
 121 #define DST_METRICS_READ_ONLY           0x1UL
 122 #define DST_METRICS_REFCOUNTED          0x2UL
 123 #define DST_METRICS_FLAGS               0x3UL
 124 #define __DST_METRICS_PTR(Y)    \
 125         ((u32 *)((Y) & ~DST_METRICS_FLAGS))
 126 #define DST_METRICS_PTR(X)      __DST_METRICS_PTR((X)->_metrics)
 127
 128 static inline bool dst_metrics_read_only(const struct dst_entry *dst)
 129 {
 130         return dst->_metrics & DST_METRICS_READ_ONLY;
 131 }
 132
 133 void __dst_destroy_metrics_generic(struct dst_entry *dst, unsigned long old);
 134
 135 static inline void dst_destroy_metrics_generic(struct dst_entry *dst)
 136 {
 137         unsigned long val = dst->_metrics;
 138         if (!(val & DST_METRICS_READ_ONLY))
 139                 __dst_destroy_metrics_generic(dst, val);
 140 }
 141
 142 static inline u32 *dst_metrics_write_ptr(struct dst_entry *dst)
 143 {
 144         unsigned long p = dst->_metrics;
 145
 146         BUG_ON(!p);
 147
 148         if (p & DST_METRICS_READ_ONLY)
 149                 return dst->ops->cow_metrics(dst, p);
 150         return __DST_METRICS_PTR(p);
 151 }
 152
 153 /* This may only be invoked before the entry has reached global
 154  * visibility.
 155  */
 156 static inline void dst_init_metrics(struct dst_entry *dst,
 157                                     const u32 *src_metrics,
 158                                     bool read_only)
 159 {
 160         dst->_metrics = ((unsigned long) src_metrics) |
 161                 (read_only ? DST_METRICS_READ_ONLY : 0);
 162 }
 163
 164 static inline void dst_copy_metrics(struct dst_entry *dest, const struct dst_entry *src)
 165 {
 166         u32 *dst_metrics = dst_metrics_write_ptr(dest);
 167
 168         if (dst_metrics) {
 169                 u32 *src_metrics = DST_METRICS_PTR(src);
 170
 171                 memcpy(dst_metrics, src_metrics, RTAX_MAX * sizeof(u32));
 172         }
 173 }
 174
 175 static inline u32 *dst_metrics_ptr(struct dst_entry *dst)
 176 {
 177         return DST_METRICS_PTR(dst);
 178 }
 179
 180 static inline u32
 181 dst_metric_raw(const struct dst_entry *dst, const int metric)
 182 {
 183         u32 *p = DST_METRICS_PTR(dst);
 184
 185         return p[metric-1];
 186 }
 187
 188 static inline u32
 189 dst_metric(const struct dst_entry *dst, const int metric)
 190 {
 191         WARN_ON_ONCE(metric == RTAX_HOPLIMIT ||
 192                      metric == RTAX_ADVMSS ||
 193                      metric == RTAX_MTU);
 194         return dst_metric_raw(dst, metric);
 195 }
 196
 197 static inline u32
 198 dst_metric_advmss(const struct dst_entry *dst)
 199 {
 200         u32 advmss = dst_metric_raw(dst, RTAX_ADVMSS);
 201
 202         if (!advmss)
 203                 advmss = dst->ops->default_advmss(dst);
 204
 205         return advmss;
 206 }
 207
 208 static inline void dst_metric_set(struct dst_entry *dst, int metric, u32 val)
 209 {
 210         u32 *p = dst_metrics_write_ptr(dst);
 211
 212         if (p)
 213                 p[metric-1] = val;
 214 }
 215
 216 /* Kernel-internal feature bits that are unallocated in user space. */
 217 #define DST_FEATURE_ECN_CA      (1 << 31)
 218
 219 #define DST_FEATURE_MASK        (DST_FEATURE_ECN_CA)
 220 #define DST_FEATURE_ECN_MASK    (DST_FEATURE_ECN_CA | RTAX_FEATURE_ECN)
 221
 222 static inline u32
 223 dst_feature(const struct dst_entry *dst, u32 feature)
 224 {
 225         return dst_metric(dst, RTAX_FEATURES) & feature;
 226 }
 227
 228 static inline u32 dst_mtu(const struct dst_entry *dst)
 229 {
 230         return dst->ops->mtu(dst);
 231 }
 232
 233 /* RTT metrics are stored in milliseconds for user ABI, but used as jiffies */
 234 static inline unsigned long dst_metric_rtt(const struct dst_entry *dst, int metric)
 235 {
 236         return msecs_to_jiffies(dst_metric(dst, metric));
 237 }
 238
 239 static inline u32
 240 dst_allfrag(const struct dst_entry *dst)
 241 {
 242         int ret = dst_feature(dst,  RTAX_FEATURE_ALLFRAG);
 243         return ret;
 244 }
 245
 246 static inline int
 247 dst_metric_locked(const struct dst_entry *dst, int metric)
 248 {
 249         return dst_metric(dst, RTAX_LOCK) & (1<<metric);
 250 }
 251
 252 static inline void dst_hold(struct dst_entry *dst)
 253 {
 254         /*
 255          * If your kernel compilation stops here, please check
 256          * __pad_to_align_refcnt declaration in struct dst_entry
 257          */
 258         BUILD_BUG_ON(offsetof(struct dst_entry, __refcnt) & 63);
 259         atomic_inc(&dst->__refcnt);
 260 }
 261
 262 static inline void dst_use(struct dst_entry *dst, unsigned long time)
 263 {
 264         dst_hold(dst);
 265         dst->__use++;
 266         dst->lastuse = time;
 267 }
 268
 269 static inline void dst_use_noref(struct dst_entry *dst, unsigned long time)
 270 {
 271         dst->__use++;
 272         dst->lastuse = time;
 273 }
 274
 275 static inline struct dst_entry *dst_clone(struct dst_entry *dst)
 276 {
 277         if (dst)
 278                 atomic_inc(&dst->__refcnt);
 279         return dst;
 280 }
 281
 282 void dst_release(struct dst_entry *dst);
 283
 284 static inline void refdst_drop(unsigned long refdst)
 285 {
 286         if (!(refdst & SKB_DST_NOREF))
 287                 dst_release((struct dst_entry *)(refdst & SKB_DST_PTRMASK));
 288 }
 289
 290 /**
 291  * skb_dst_drop - drops skb dst
 292  * @skb: buffer
 293  *
 294  * Drops dst reference count if a reference was taken.
 295  */
 296 static inline void skb_dst_drop(struct sk_buff *skb)
 297 {
 298         if (skb->_skb_refdst) {
 299                 refdst_drop(skb->_skb_refdst);
 300                 skb->_skb_refdst = 0UL;
 301         }
 302 }
 303
 304 static inline void __skb_dst_copy(struct sk_buff *nskb, unsigned long refdst)
 305 {
 306         nskb->_skb_refdst = refdst;
 307         if (!(nskb->_skb_refdst & SKB_DST_NOREF))
 308                 dst_clone(skb_dst(nskb));
 309 }
 310
 311 static inline void skb_dst_copy(struct sk_buff *nskb, const struct sk_buff *oskb)
 312 {
 313         __skb_dst_copy(nskb, oskb->_skb_refdst);
 314 }
 315
 316 /**
 317  * skb_dst_force - makes sure skb dst is refcounted
 318  * @skb: buffer
 319  *
 320  * If dst is not yet refcounted, let's do it
 321  */
 322 static inline void skb_dst_force(struct sk_buff *skb)
 323 {
 324         if (skb_dst_is_noref(skb)) {
 325                 WARN_ON(!rcu_read_lock_held());
 326                 skb->_skb_refdst &= ~SKB_DST_NOREF;
 327                 dst_clone(skb_dst(skb));
 328         }
 329 }
 330
 331 /**
 332  * dst_hold_safe - Take a reference on a dst if possible
 333  * @dst: pointer to dst entry
 334  *
 335  * This helper returns false if it could not safely
 336  * take a reference on a dst.
 337  */
 338 static inline bool dst_hold_safe(struct dst_entry *dst)
 339 {
 340         if (dst->flags & DST_NOCACHE)
 341                 return atomic_inc_not_zero(&dst->__refcnt);
 342         dst_hold(dst);
 343         return true;
 344 }
 345
 346 /**
 347  * skb_dst_force_safe - makes sure skb dst is refcounted
 348  * @skb: buffer
 349  *
 350  * If dst is not yet refcounted and not destroyed, grab a ref on it.
 351  */
 352 static inline void skb_dst_force_safe(struct sk_buff *skb)
 353 {
 354         if (skb_dst_is_noref(skb)) {
 355                 struct dst_entry *dst = skb_dst(skb);
 356
 357                 if (!dst_hold_safe(dst))
 358                         dst = NULL;
 359
 360                 skb->_skb_refdst = (unsigned long)dst;
 361         }
 362 }
 363
 364
 365 /**
 366  *      __skb_tunnel_rx - prepare skb for rx reinsert
 367  *      @skb: buffer
 368  *      @dev: tunnel device
 369  *      @net: netns for packet i/o
 370  *
 371  *      After decapsulation, packet is going to re-enter (netif_rx()) our stack,
 372  *      so make some cleanups. (no accounting done)
 373  */
 374 static inline void __skb_tunnel_rx(struct sk_buff *skb, struct net_device *dev,
 375                                    struct net *net)
 376 {
 377         skb->dev = dev;
 378
 379         /*
 380          * Clear hash so that we can recalulate the hash for the
 381          * encapsulated packet, unless we have already determine the hash
 382          * over the L4 4-tuple.
 383          */
 384         skb_clear_hash_if_not_l4(skb);
 385         skb_set_queue_mapping(skb, 0);
 386         skb_scrub_packet(skb, !net_eq(net, dev_net(dev)));
 387 }
 388
 389 /**
 390  *      skb_tunnel_rx - prepare skb for rx reinsert
 391  *      @skb: buffer
 392  *      @dev: tunnel device
 393  *
 394  *      After decapsulation, packet is going to re-enter (netif_rx()) our stack,
 395  *      so make some cleanups, and perform accounting.
 396  *      Note: this accounting is not SMP safe.
 397  */
 398 static inline void skb_tunnel_rx(struct sk_buff *skb, struct net_device *dev,
 399                                  struct net *net)
 400 {
 401         /* TODO : stats should be SMP safe */
 402         dev->stats.rx_packets++;
 403         dev->stats.rx_bytes += skb->len;
 404         __skb_tunnel_rx(skb, dev, net);
 405 }
 406
 407 int dst_discard_out(struct net *net, struct sock *sk, struct sk_buff *skb);
 408 static inline int dst_discard(struct sk_buff *skb)
 409 {
 410         return dst_discard_out(&init_net, skb->sk, skb);
 411 }
 412 void *dst_alloc(struct dst_ops *ops, struct net_device *dev, int initial_ref,
 413                 int initial_obsolete, unsigned short flags);
 414 void dst_init(struct dst_entry *dst, struct dst_ops *ops,
 415               struct net_device *dev, int initial_ref, int initial_obsolete,
 416               unsigned short flags);
 417 void __dst_free(struct dst_entry *dst);
 418 struct dst_entry *dst_destroy(struct dst_entry *dst);
 419
 420 static inline void dst_free(struct dst_entry *dst)
 421 {
 422         if (dst->obsolete > 0)
 423                 return;
 424         if (!atomic_read(&dst->__refcnt)) {
 425                 dst = dst_destroy(dst);
 426                 if (!dst)
 427                         return;
 428         }
 429         __dst_free(dst);
 430 }
 431
 432 static inline void dst_rcu_free(struct rcu_head *head)
 433 {
 434         struct dst_entry *dst = container_of(head, struct dst_entry, rcu_head);
 435         dst_free(dst);
 436 }
 437
 438 static inline void dst_confirm(struct dst_entry *dst)
 439 {
 440         dst->pending_confirm = 1;
 441 }
 442
 443 static inline int dst_neigh_output(struct dst_entry *dst, struct neighbour *n,
 444                                    struct sk_buff *skb)
 445 {
 446         const struct hh_cache *hh;
 447
 448         if (dst->pending_confirm) {
 449                 unsigned long now = jiffies;
 450
 451                 dst->pending_confirm = 0;
 452                 /* avoid dirtying neighbour */
 453                 if (n->confirmed != now)
 454                         n->confirmed = now;
 455         }
 456
 457         hh = &n->hh;
 458         if ((n->nud_state & NUD_CONNECTED) && hh->hh_len)
 459                 return neigh_hh_output(hh, skb);
 460         else
 461                 return n->output(n, skb);
 462 }
 463
 464 static inline struct neighbour *dst_neigh_lookup(const struct dst_entry *dst, const void *daddr)
 465 {
 466         struct neighbour *n = dst->ops->neigh_lookup(dst, NULL, daddr);
 467         return IS_ERR(n) ? NULL : n;
 468 }
 469
 470 static inline struct neighbour *dst_neigh_lookup_skb(const struct dst_entry *dst,
 471                                                      struct sk_buff *skb)
 472 {
 473         struct neighbour *n = NULL;
 474
 475         /* The packets from tunnel devices (eg bareudp) may have only
 476          * metadata in the dst pointer of skb. Hence a pointer check of
 477          * neigh_lookup is needed.
 478          */
 479         if (dst->ops->neigh_lookup)
 480                 n = dst->ops->neigh_lookup(dst, skb, NULL);
 481
 482         return IS_ERR(n) ? NULL : n;
 483 }
 484
 485 static inline void dst_link_failure(struct sk_buff *skb)
 486 {
 487         struct dst_entry *dst = skb_dst(skb);
 488         if (dst && dst->ops && dst->ops->link_failure)
 489                 dst->ops->link_failure(skb);
 490 }
 491
 492 static inline void dst_set_expires(struct dst_entry *dst, int timeout)
 493 {
 494         unsigned long expires = jiffies + timeout;
 495
 496         if (expires == 0)
 497                 expires = 1;
 498
 499         if (dst->expires == 0 || time_before(expires, dst->expires))
 500                 dst->expires = expires;
 501 }
 502
 503 /* Output packet to network from transport.  */
 504 static inline int dst_output(struct net *net, struct sock *sk, struct sk_buff *skb)
 505 {
 506         return skb_dst(skb)->output(net, sk, skb);
 507 }
 508
 509 /* Input packet from network to transport.  */
 510 static inline int dst_input(struct sk_buff *skb)
 511 {
 512         return skb_dst(skb)->input(skb);
 513 }
 514
 515 static inline struct dst_entry *dst_check(struct dst_entry *dst, u32 cookie)
 516 {
 517         if (dst->obsolete)
 518                 dst = dst->ops->check(dst, cookie);
 519         return dst;
 520 }
 521
 522 void dst_subsys_init(void);
 523
 524 /* Flags for xfrm_lookup flags argument. */
 525 enum {
 526         XFRM_LOOKUP_ICMP = 1 << 0,
 527         XFRM_LOOKUP_QUEUE = 1 << 1,
 528         XFRM_LOOKUP_KEEP_DST_REF = 1 << 2,
 529 };
 530
 531 struct flowi;
 532 #ifndef CONFIG_XFRM
 533 static inline struct dst_entry *xfrm_lookup(struct net *net,
 534                                             struct dst_entry *dst_orig,
 535                                             const struct flowi *fl,
 536                                             const struct sock *sk,
 537                                             int flags)
 538 {
 539         return dst_orig;
 540 }
 541
 542 static inline struct dst_entry *xfrm_lookup_route(struct net *net,
 543                                                   struct dst_entry *dst_orig,
 544                                                   const struct flowi *fl,
 545                                                   const struct sock *sk,
 546                                                   int flags)
 547 {
 548         return dst_orig;
 549 }
 550
 551 static inline struct xfrm_state *dst_xfrm(const struct dst_entry *dst)
 552 {
 553         return NULL;
 554 }
 555
 556 #else
 557 struct dst_entry *xfrm_lookup(struct net *net, struct dst_entry *dst_orig,
 558                               const struct flowi *fl, const struct sock *sk,
 559                               int flags);
 560
 561 struct dst_entry *xfrm_lookup_route(struct net *net, struct dst_entry *dst_orig,
 562                                     const struct flowi *fl, const struct sock *sk,
 563                                     int flags);
 564
 565 /* skb attached with this dst needs transformation if dst->xfrm is valid */
 566 static inline struct xfrm_state *dst_xfrm(const struct dst_entry *dst)
 567 {
 568         return dst->xfrm;
 569 }
 570 #endif
 571
 572 #endif /* _NET_DST_H */