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 <linux/config.h>
  12 #include <linux/rtnetlink.h>
  13 #include <linux/rcupdate.h>
  14 #include <linux/jiffies.h>
  15 #include <net/neighbour.h>
  16 #include <asm/processor.h>
  17
  18 /*
  19  * 0 - no debugging messages
  20  * 1 - rare events and bugs (default)
  21  * 2 - trace mode.
  22  */
  23 #define RT_CACHE_DEBUG          0
  24
  25 #define DST_GC_MIN      (HZ/10)
  26 #define DST_GC_INC      (HZ/2)
  27 #define DST_GC_MAX      (120*HZ)
  28
  29 /* Each dst_entry has reference count and sits in some parent list(s).
  30  * When it is removed from parent list, it is "freed" (dst_free).
  31  * After this it enters dead state (dst->obsolete > 0) and if its refcnt
  32  * is zero, it can be destroyed immediately, otherwise it is added
  33  * to gc list and garbage collector periodically checks the refcnt.
  34  */
  35
  36 struct sk_buff;
  37
  38 struct dst_entry
  39 {
  40         struct dst_entry        *next;
  41         atomic_t                __refcnt;       /* client references    */
  42         int                     __use;
  43         struct dst_entry        *child;
  44         struct net_device       *dev;
  45         int                     obsolete;
  46         int                     flags;
  47 #define DST_HOST                1
  48 #define DST_NOXFRM              2
  49 #define DST_NOPOLICY            4
  50 #define DST_NOHASH              8
  51         unsigned long           lastuse;
  52         unsigned long           expires;
  53
  54         unsigned short          header_len;     /* more space at head required */
  55         unsigned short          trailer_len;    /* space to reserve at tail */
  56
  57         u32                     metrics[RTAX_MAX];
  58         struct dst_entry        *path;
  59
  60         unsigned long           rate_last;      /* rate limiting for ICMP */
  61         unsigned long           rate_tokens;
  62
  63         int                     error;
  64
  65         struct neighbour        *neighbour;
  66         struct hh_cache         *hh;
  67         struct xfrm_state       *xfrm;
  68
  69         int                     (*input)(struct sk_buff*);
  70         int                     (*output)(struct sk_buff*);
  71
  72 #ifdef CONFIG_NET_CLS_ROUTE
  73         __u32                   tclassid;
  74 #endif
  75
  76         struct  dst_ops         *ops;
  77         struct rcu_head         rcu_head;
  78
  79         char                    info[0];
  80 };
  81
  82
  83 struct dst_ops
  84 {
  85         unsigned short          family;
  86         unsigned short          protocol;
  87         unsigned                gc_thresh;
  88
  89         int                     (*gc)(void);
  90         struct dst_entry *      (*check)(struct dst_entry *, __u32 cookie);
  91         void                    (*destroy)(struct dst_entry *);
  92         void                    (*ifdown)(struct dst_entry *,
  93                                           struct net_device *dev, int how);
  94         struct dst_entry *      (*negative_advice)(struct dst_entry *);
  95         void                    (*link_failure)(struct sk_buff *);
  96         void                    (*update_pmtu)(struct dst_entry *dst, u32 mtu);
  97         int                     (*get_mss)(struct dst_entry *dst, u32 mtu);
  98         int                     entry_size;
  99
 100         atomic_t                entries;
 101         kmem_cache_t            *kmem_cachep;
 102 };
 103
 104 #ifdef __KERNEL__
 105
 106 static inline u32
 107 dst_metric(const struct dst_entry *dst, int metric)
 108 {
 109         return dst->metrics[metric-1];
 110 }
 111
 112 static inline u32
 113 dst_path_metric(const struct dst_entry *dst, int metric)
 114 {
 115         return dst->path->metrics[metric-1];
 116 }
 117
 118 static inline u32
 119 dst_pmtu(const struct dst_entry *dst)
 120 {
 121         u32 mtu = dst_path_metric(dst, RTAX_MTU);
 122         /* Yes, _exactly_. This is paranoia. */
 123         barrier();
 124         return mtu;
 125 }
 126
 127 static inline int
 128 dst_metric_locked(struct dst_entry *dst, int metric)
 129 {
 130         return dst_metric(dst, RTAX_LOCK) & (1<<metric);
 131 }
 132
 133 static inline void dst_hold(struct dst_entry * dst)
 134 {
 135         atomic_inc(&dst->__refcnt);
 136 }
 137
 138 static inline
 139 struct dst_entry * dst_clone(struct dst_entry * dst)
 140 {
 141         if (dst)
 142                 atomic_inc(&dst->__refcnt);
 143         return dst;
 144 }
 145
 146 static inline
 147 void dst_release(struct dst_entry * dst)
 148 {
 149         if (dst) {
 150                 WARN_ON(atomic_read(&dst->__refcnt) < 1);
 151                 smp_mb__before_atomic_dec();
 152                 atomic_dec(&dst->__refcnt);
 153         }
 154 }
 155
 156 /* Children define the path of the packet through the
 157  * Linux networking.  Thus, destinations are stackable.
 158  */
 159
 160 static inline struct dst_entry *dst_pop(struct dst_entry *dst)
 161 {
 162         struct dst_entry *child = dst_clone(dst->child);
 163
 164         dst_release(dst);
 165         return child;
 166 }
 167
 168 extern void * dst_alloc(struct dst_ops * ops);
 169 extern void __dst_free(struct dst_entry * dst);
 170 extern struct dst_entry *dst_destroy(struct dst_entry * dst);
 171
 172 static inline void dst_free(struct dst_entry * dst)
 173 {
 174         if (dst->obsolete > 1)
 175                 return;
 176         if (!atomic_read(&dst->__refcnt)) {
 177                 dst = dst_destroy(dst);
 178                 if (!dst)
 179                         return;
 180         }
 181         __dst_free(dst);
 182 }
 183
 184 static inline void dst_rcu_free(struct rcu_head *head)
 185 {
 186         struct dst_entry *dst = container_of(head, struct dst_entry, rcu_head);
 187         dst_free(dst);
 188 }
 189
 190 static inline void dst_confirm(struct dst_entry *dst)
 191 {
 192         if (dst)
 193                 neigh_confirm(dst->neighbour);
 194 }
 195
 196 static inline void dst_negative_advice(struct dst_entry **dst_p)
 197 {
 198         struct dst_entry * dst = *dst_p;
 199         if (dst && dst->ops->negative_advice)
 200                 *dst_p = dst->ops->negative_advice(dst);
 201 }
 202
 203 static inline void dst_link_failure(struct sk_buff *skb)
 204 {
 205         struct dst_entry * dst = skb->dst;
 206         if (dst && dst->ops && dst->ops->link_failure)
 207                 dst->ops->link_failure(skb);
 208 }
 209
 210 static inline void dst_set_expires(struct dst_entry *dst, int timeout)
 211 {
 212         unsigned long expires = jiffies + timeout;
 213
 214         if (expires == 0)
 215                 expires = 1;
 216
 217         if (dst->expires == 0 || time_before(expires, dst->expires))
 218                 dst->expires = expires;
 219 }
 220
 221 /* Output packet to network from transport.  */
 222 static inline int dst_output(struct sk_buff *skb)
 223 {
 224         int err;
 225
 226         for (;;) {
 227                 err = skb->dst->output(skb);
 228
 229                 if (likely(err == 0))
 230                         return err;
 231                 if (unlikely(err != NET_XMIT_BYPASS))
 232                         return err;
 233         }
 234 }
 235
 236 /* Input packet from network to transport.  */
 237 static inline int dst_input(struct sk_buff *skb)
 238 {
 239         int err;
 240
 241         for (;;) {
 242                 err = skb->dst->input(skb);
 243
 244                 if (likely(err == 0))
 245                         return err;
 246                 /* Oh, Jamal... Seems, I will not forgive you this mess. :-) */
 247                 if (unlikely(err != NET_XMIT_BYPASS))
 248                         return err;
 249         }
 250 }
 251
 252 extern void             dst_init(void);
 253
 254 struct flowi;
 255 #ifndef CONFIG_XFRM
 256 static inline int xfrm_lookup(struct dst_entry **dst_p, struct flowi *fl,
 257                        struct sock *sk, int flags)
 258 {
 259         return 0;
 260 }
 261 #else
 262 extern int xfrm_lookup(struct dst_entry **dst_p, struct flowi *fl,
 263                        struct sock *sk, int flags);
 264 #endif
 265 #endif
 266
 267 #endif /* _NET_DST_H */