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 net_device       *dev;
  35         struct rcu_head         rcu_head;
  36         struct dst_entry        *child;
  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 #define DST_NOGC                0x0400
  62
  63         short                   error;
  64
  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
  68          * destroyed.
  69          *
  70          * Negative values are used by the implementation layer code to
  71          * force invocation of the dst_ops->check() method.
  72          */
  73         short                   obsolete;
  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         unsigned short          __pad3;
  81
  82 #ifdef CONFIG_IP_ROUTE_CLASSID
  83         __u32                   tclassid;
  84 #else
  85         __u32                   __pad2;
  86 #endif
  87
  88 #ifdef CONFIG_64BIT
  89         /*
  90          * Align __refcnt to a 64 bytes alignment
  91          * (L1_CACHE_SIZE would be too much)
  92          */
  93         long                    __pad_to_align_refcnt[2];
  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         struct lwtunnel_state   *lwtstate;
 103         union {
 104                 struct dst_entry        *next;
 105                 struct rtable __rcu     *rt_next;
 106                 struct rt6_info         *rt6_next;
 107                 struct dn_route __rcu   *dn_next;
 108         };
 109 };
 110
 111 struct dst_metrics {
 112         u32             metrics[RTAX_MAX];
 113         atomic_t        refcnt;
 114 };
 115 extern const struct dst_metrics dst_default_metrics;
 116
 117 u32 *dst_cow_metrics_generic(struct dst_entry *dst, unsigned long old);
 118
 119 #define DST_METRICS_READ_ONLY           0x1UL
 120 #define DST_METRICS_REFCOUNTED          0x2UL
 121 #define DST_METRICS_FLAGS               0x3UL
 122 #define __DST_METRICS_PTR(Y)    \
 123         ((u32 *)((Y) & ~DST_METRICS_FLAGS))
 124 #define DST_METRICS_PTR(X)      __DST_METRICS_PTR((X)->_metrics)
 125
 126 static inline bool dst_metrics_read_only(const struct dst_entry *dst)
 127 {
 128         return dst->_metrics & DST_METRICS_READ_ONLY;
 129 }
 130
 131 void __dst_destroy_metrics_generic(struct dst_entry *dst, unsigned long old);
 132
 133 static inline void dst_destroy_metrics_generic(struct dst_entry *dst)
 134 {
 135         unsigned long val = dst->_metrics;
 136         if (!(val & DST_METRICS_READ_ONLY))
 137                 __dst_destroy_metrics_generic(dst, val);
 138 }
 139
 140 static inline u32 *dst_metrics_write_ptr(struct dst_entry *dst)
 141 {
 142         unsigned long p = dst->_metrics;
 143
 144         BUG_ON(!p);
 145
 146         if (p & DST_METRICS_READ_ONLY)
 147                 return dst->ops->cow_metrics(dst, p);
 148         return __DST_METRICS_PTR(p);
 149 }
 150
 151 /* This may only be invoked before the entry has reached global
 152  * visibility.
 153  */
 154 static inline void dst_init_metrics(struct dst_entry *dst,
 155                                     const u32 *src_metrics,
 156                                     bool read_only)
 157 {
 158         dst->_metrics = ((unsigned long) src_metrics) |
 159                 (read_only ? DST_METRICS_READ_ONLY : 0);
 160 }
 161
 162 static inline void dst_copy_metrics(struct dst_entry *dest, const struct dst_entry *src)
 163 {
 164         u32 *dst_metrics = dst_metrics_write_ptr(dest);
 165
 166         if (dst_metrics) {
 167                 u32 *src_metrics = DST_METRICS_PTR(src);
 168
 169                 memcpy(dst_metrics, src_metrics, RTAX_MAX * sizeof(u32));
 170         }
 171 }
 172
 173 static inline u32 *dst_metrics_ptr(struct dst_entry *dst)
 174 {
 175         return DST_METRICS_PTR(dst);
 176 }
 177
 178 static inline u32
 179 dst_metric_raw(const struct dst_entry *dst, const int metric)
 180 {
 181         u32 *p = DST_METRICS_PTR(dst);
 182
 183         return p[metric-1];
 184 }
 185
 186 static inline u32
 187 dst_metric(const struct dst_entry *dst, const int metric)
 188 {
 189         WARN_ON_ONCE(metric == RTAX_HOPLIMIT ||
 190                      metric == RTAX_ADVMSS ||
 191                      metric == RTAX_MTU);
 192         return dst_metric_raw(dst, metric);
 193 }
 194
 195 static inline u32
 196 dst_metric_advmss(const struct dst_entry *dst)
 197 {
 198         u32 advmss = dst_metric_raw(dst, RTAX_ADVMSS);
 199
 200         if (!advmss)
 201                 advmss = dst->ops->default_advmss(dst);
 202
 203         return advmss;
 204 }
 205
 206 static inline void dst_metric_set(struct dst_entry *dst, int metric, u32 val)
 207 {
 208         u32 *p = dst_metrics_write_ptr(dst);
 209
 210         if (p)
 211                 p[metric-1] = val;
 212 }
 213
 214 /* Kernel-internal feature bits that are unallocated in user space. */
 215 #define DST_FEATURE_ECN_CA      (1 << 31)
 216
 217 #define DST_FEATURE_MASK        (DST_FEATURE_ECN_CA)
 218 #define DST_FEATURE_ECN_MASK    (DST_FEATURE_ECN_CA | RTAX_FEATURE_ECN)
 219
 220 static inline u32
 221 dst_feature(const struct dst_entry *dst, u32 feature)
 222 {
 223         return dst_metric(dst, RTAX_FEATURES) & feature;
 224 }
 225
 226 static inline u32 dst_mtu(const struct dst_entry *dst)
 227 {
 228         return dst->ops->mtu(dst);
 229 }
 230
 231 /* RTT metrics are stored in milliseconds for user ABI, but used as jiffies */
 232 static inline unsigned long dst_metric_rtt(const struct dst_entry *dst, int metric)
 233 {
 234         return msecs_to_jiffies(dst_metric(dst, metric));
 235 }
 236
 237 static inline u32
 238 dst_allfrag(const struct dst_entry *dst)
 239 {
 240         int ret = dst_feature(dst,  RTAX_FEATURE_ALLFRAG);
 241         return ret;
 242 }
 243
 244 static inline int
 245 dst_metric_locked(const struct dst_entry *dst, int metric)
 246 {
 247         return dst_metric(dst, RTAX_LOCK) & (1<<metric);
 248 }
 249
 250 static inline void dst_hold(struct dst_entry *dst)
 251 {
 252         /*
 253          * If your kernel compilation stops here, please check
 254          * __pad_to_align_refcnt declaration in struct dst_entry
 255          */
 256         BUILD_BUG_ON(offsetof(struct dst_entry, __refcnt) & 63);
 257         atomic_inc(&dst->__refcnt);
 258 }
 259
 260 static inline void dst_use(struct dst_entry *dst, unsigned long time)
 261 {
 262         dst_hold(dst);
 263         dst->__use++;
 264         dst->lastuse = time;
 265 }
 266
 267 static inline void dst_use_noref(struct dst_entry *dst, unsigned long time)
 268 {
 269         dst->__use++;
 270         dst->lastuse = time;
 271 }
 272
 273 static inline struct dst_entry *dst_clone(struct dst_entry *dst)
 274 {
 275         if (dst)
 276                 atomic_inc(&dst->__refcnt);
 277         return dst;
 278 }
 279
 280 void dst_release(struct dst_entry *dst);
 281
 282 void dst_release_immediate(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 | DST_NOGC))
 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 static inline u32 dst_tclassid(const struct sk_buff *skb)
 408 {
 409 #ifdef CONFIG_IP_ROUTE_CLASSID
 410         const struct dst_entry *dst;
 411
 412         dst = skb_dst(skb);
 413         if (dst)
 414                 return dst->tclassid;
 415 #endif
 416         return 0;
 417 }
 418
 419 int dst_discard_out(struct net *net, struct sock *sk, struct sk_buff *skb);
 420 static inline int dst_discard(struct sk_buff *skb)
 421 {
 422         return dst_discard_out(&init_net, skb->sk, skb);
 423 }
 424 void *dst_alloc(struct dst_ops *ops, struct net_device *dev, int initial_ref,
 425                 int initial_obsolete, unsigned short flags);
 426 void dst_init(struct dst_entry *dst, struct dst_ops *ops,
 427               struct net_device *dev, int initial_ref, int initial_obsolete,
 428               unsigned short flags);
 429 void __dst_free(struct dst_entry *dst);
 430 struct dst_entry *dst_destroy(struct dst_entry *dst);
 431 void dst_dev_put(struct dst_entry *dst);
 432
 433 static inline void dst_free(struct dst_entry *dst)
 434 {
 435         if (dst->obsolete > 0)
 436                 return;
 437         if (!atomic_read(&dst->__refcnt)) {
 438                 dst = dst_destroy(dst);
 439                 if (!dst)
 440                         return;
 441         }
 442         __dst_free(dst);
 443 }
 444
 445 static inline void dst_rcu_free(struct rcu_head *head)
 446 {
 447         struct dst_entry *dst = container_of(head, struct dst_entry, rcu_head);
 448         dst_free(dst);
 449 }
 450
 451 static inline void dst_confirm(struct dst_entry *dst)
 452 {
 453 }
 454
 455 static inline struct neighbour *dst_neigh_lookup(const struct dst_entry *dst, const void *daddr)
 456 {
 457         struct neighbour *n = dst->ops->neigh_lookup(dst, NULL, daddr);
 458         return IS_ERR(n) ? NULL : n;
 459 }
 460
 461 static inline struct neighbour *dst_neigh_lookup_skb(const struct dst_entry *dst,
 462                                                      struct sk_buff *skb)
 463 {
 464         struct neighbour *n =  dst->ops->neigh_lookup(dst, skb, NULL);
 465         return IS_ERR(n) ? NULL : n;
 466 }
 467
 468 static inline void dst_confirm_neigh(const struct dst_entry *dst,
 469                                      const void *daddr)
 470 {
 471         if (dst->ops->confirm_neigh)
 472                 dst->ops->confirm_neigh(dst, daddr);
 473 }
 474
 475 static inline void dst_link_failure(struct sk_buff *skb)
 476 {
 477         struct dst_entry *dst = skb_dst(skb);
 478         if (dst && dst->ops && dst->ops->link_failure)
 479                 dst->ops->link_failure(skb);
 480 }
 481
 482 static inline void dst_set_expires(struct dst_entry *dst, int timeout)
 483 {
 484         unsigned long expires = jiffies + timeout;
 485
 486         if (expires == 0)
 487                 expires = 1;
 488
 489         if (dst->expires == 0 || time_before(expires, dst->expires))
 490                 dst->expires = expires;
 491 }
 492
 493 /* Output packet to network from transport.  */
 494 static inline int dst_output(struct net *net, struct sock *sk, struct sk_buff *skb)
 495 {
 496         return skb_dst(skb)->output(net, sk, skb);
 497 }
 498
 499 /* Input packet from network to transport.  */
 500 static inline int dst_input(struct sk_buff *skb)
 501 {
 502         return skb_dst(skb)->input(skb);
 503 }
 504
 505 static inline struct dst_entry *dst_check(struct dst_entry *dst, u32 cookie)
 506 {
 507         if (dst->obsolete)
 508                 dst = dst->ops->check(dst, cookie);
 509         return dst;
 510 }
 511
 512 void dst_subsys_init(void);
 513
 514 /* Flags for xfrm_lookup flags argument. */
 515 enum {
 516         XFRM_LOOKUP_ICMP = 1 << 0,
 517         XFRM_LOOKUP_QUEUE = 1 << 1,
 518         XFRM_LOOKUP_KEEP_DST_REF = 1 << 2,
 519 };
 520
 521 struct flowi;
 522 #ifndef CONFIG_XFRM
 523 static inline struct dst_entry *xfrm_lookup(struct net *net,
 524                                             struct dst_entry *dst_orig,
 525                                             const struct flowi *fl,
 526                                             const struct sock *sk,
 527                                             int flags)
 528 {
 529         return dst_orig;
 530 }
 531
 532 static inline struct dst_entry *xfrm_lookup_route(struct net *net,
 533                                                   struct dst_entry *dst_orig,
 534                                                   const struct flowi *fl,
 535                                                   const struct sock *sk,
 536                                                   int flags)
 537 {
 538         return dst_orig;
 539 }
 540
 541 static inline struct xfrm_state *dst_xfrm(const struct dst_entry *dst)
 542 {
 543         return NULL;
 544 }
 545
 546 #else
 547 struct dst_entry *xfrm_lookup(struct net *net, struct dst_entry *dst_orig,
 548                               const struct flowi *fl, const struct sock *sk,
 549                               int flags);
 550
 551 struct dst_entry *xfrm_lookup_route(struct net *net, struct dst_entry *dst_orig,
 552                                     const struct flowi *fl, const struct sock *sk,
 553                                     int flags);
 554
 555 /* skb attached with this dst needs transformation if dst->xfrm is valid */
 556 static inline struct xfrm_state *dst_xfrm(const struct dst_entry *dst)
 557 {
 558         return dst->xfrm;
 559 }
 560 #endif
 561
 562 #endif /* _NET_DST_H */