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/netdevice.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 rcu_head         rcu_head;
  41         struct dst_entry        *child;
  42         struct net_device       *dev;
  43         short                   error;
  44         short                   obsolete;
  45         int                     flags;
  46 #define DST_HOST                1
  47 #define DST_NOXFRM              2
  48 #define DST_NOPOLICY            4
  49 #define DST_NOHASH              8
  50         unsigned long           expires;
  51
  52         unsigned short          header_len;     /* more space at head required */
  53         unsigned short          trailer_len;    /* space to reserve at tail */
  54
  55         u32                     metrics[RTAX_MAX];
  56         struct dst_entry        *path;
  57
  58         unsigned long           rate_last;      /* rate limiting for ICMP */
  59         unsigned long           rate_tokens;
  60
  61         struct neighbour        *neighbour;
  62         struct hh_cache         *hh;
  63         struct xfrm_state       *xfrm;
  64
  65         int                     (*input)(struct sk_buff*);
  66         int                     (*output)(struct sk_buff*);
  67
  68 #ifdef CONFIG_NET_CLS_ROUTE
  69         __u32                   tclassid;
  70 #endif
  71
  72         struct  dst_ops         *ops;
  73
  74         unsigned long           lastuse;
  75         atomic_t                __refcnt;       /* client references    */
  76         int                     __use;
  77         union {
  78                 struct dst_entry *next;
  79                 struct rtable    *rt_next;
  80                 struct rt6_info   *rt6_next;
  81                 struct dn_route  *dn_next;
  82         };
  83         char                    info[0];
  84 };
  85
  86
  87 struct dst_ops
  88 {
  89         unsigned short          family;
  90         __be16                  protocol;
  91         unsigned                gc_thresh;
  92
  93         int                     (*gc)(void);
  94         struct dst_entry *      (*check)(struct dst_entry *, __u32 cookie);
  95         void                    (*destroy)(struct dst_entry *);
  96         void                    (*ifdown)(struct dst_entry *,
  97                                           struct net_device *dev, int how);
  98         struct dst_entry *      (*negative_advice)(struct dst_entry *);
  99         void                    (*link_failure)(struct sk_buff *);
 100         void                    (*update_pmtu)(struct dst_entry *dst, u32 mtu);
 101         int                     entry_size;
 102
 103         atomic_t                entries;
 104         struct kmem_cache               *kmem_cachep;
 105 };
 106
 107 #ifdef __KERNEL__
 108
 109 static inline u32
 110 dst_metric(const struct dst_entry *dst, int metric)
 111 {
 112         return dst->metrics[metric-1];
 113 }
 114
 115 static inline u32 dst_mtu(const struct dst_entry *dst)
 116 {
 117         u32 mtu = dst_metric(dst, RTAX_MTU);
 118         /*
 119          * Alexey put it here, so ask him about it :)
 120          */
 121         barrier();
 122         return mtu;
 123 }
 124
 125 static inline u32
 126 dst_allfrag(const struct dst_entry *dst)
 127 {
 128         int ret = dst_metric(dst, RTAX_FEATURES) & RTAX_FEATURE_ALLFRAG;
 129         /* Yes, _exactly_. This is paranoia. */
 130         barrier();
 131         return ret;
 132 }
 133
 134 static inline int
 135 dst_metric_locked(struct dst_entry *dst, int metric)
 136 {
 137         return dst_metric(dst, RTAX_LOCK) & (1<<metric);
 138 }
 139
 140 static inline void dst_hold(struct dst_entry * dst)
 141 {
 142         atomic_inc(&dst->__refcnt);
 143 }
 144
 145 static inline void dst_use(struct dst_entry *dst, unsigned long time)
 146 {
 147         dst_hold(dst);
 148         dst->__use++;
 149         dst->lastuse = time;
 150 }
 151
 152 static inline
 153 struct dst_entry * dst_clone(struct dst_entry * dst)
 154 {
 155         if (dst)
 156                 atomic_inc(&dst->__refcnt);
 157         return dst;
 158 }
 159
 160 static inline
 161 void dst_release(struct dst_entry * dst)
 162 {
 163         if (dst) {
 164                 WARN_ON(atomic_read(&dst->__refcnt) < 1);
 165                 smp_mb__before_atomic_dec();
 166                 atomic_dec(&dst->__refcnt);
 167         }
 168 }
 169
 170 /* Children define the path of the packet through the
 171  * Linux networking.  Thus, destinations are stackable.
 172  */
 173
 174 static inline struct dst_entry *dst_pop(struct dst_entry *dst)
 175 {
 176         struct dst_entry *child = dst_clone(dst->child);
 177
 178         dst_release(dst);
 179         return child;
 180 }
 181
 182 extern void * dst_alloc(struct dst_ops * ops);
 183 extern void __dst_free(struct dst_entry * dst);
 184 extern struct dst_entry *dst_destroy(struct dst_entry * dst);
 185
 186 static inline void dst_free(struct dst_entry * dst)
 187 {
 188         if (dst->obsolete > 1)
 189                 return;
 190         if (!atomic_read(&dst->__refcnt)) {
 191                 dst = dst_destroy(dst);
 192                 if (!dst)
 193                         return;
 194         }
 195         __dst_free(dst);
 196 }
 197
 198 static inline void dst_rcu_free(struct rcu_head *head)
 199 {
 200         struct dst_entry *dst = container_of(head, struct dst_entry, rcu_head);
 201         dst_free(dst);
 202 }
 203
 204 static inline void dst_confirm(struct dst_entry *dst)
 205 {
 206         if (dst)
 207                 neigh_confirm(dst->neighbour);
 208 }
 209
 210 static inline void dst_negative_advice(struct dst_entry **dst_p)
 211 {
 212         struct dst_entry * dst = *dst_p;
 213         if (dst && dst->ops->negative_advice)
 214                 *dst_p = dst->ops->negative_advice(dst);
 215 }
 216
 217 static inline void dst_link_failure(struct sk_buff *skb)
 218 {
 219         struct dst_entry * dst = skb->dst;
 220         if (dst && dst->ops && dst->ops->link_failure)
 221                 dst->ops->link_failure(skb);
 222 }
 223
 224 static inline void dst_set_expires(struct dst_entry *dst, int timeout)
 225 {
 226         unsigned long expires = jiffies + timeout;
 227
 228         if (expires == 0)
 229                 expires = 1;
 230
 231         if (dst->expires == 0 || time_before(expires, dst->expires))
 232                 dst->expires = expires;
 233 }
 234
 235 /* Output packet to network from transport.  */
 236 static inline int dst_output(struct sk_buff *skb)
 237 {
 238         return skb->dst->output(skb);
 239 }
 240
 241 /* Input packet from network to transport.  */
 242 static inline int dst_input(struct sk_buff *skb)
 243 {
 244         int err;
 245
 246         for (;;) {
 247                 err = skb->dst->input(skb);
 248
 249                 if (likely(err == 0))
 250                         return err;
 251                 /* Oh, Jamal... Seems, I will not forgive you this mess. :-) */
 252                 if (unlikely(err != NET_XMIT_BYPASS))
 253                         return err;
 254         }
 255 }
 256
 257 static inline struct dst_entry *dst_check(struct dst_entry *dst, u32 cookie)
 258 {
 259         if (dst->obsolete)
 260                 dst = dst->ops->check(dst, cookie);
 261         return dst;
 262 }
 263
 264 extern void             dst_init(void);
 265
 266 struct flowi;
 267 #ifndef CONFIG_XFRM
 268 static inline int xfrm_lookup(struct dst_entry **dst_p, struct flowi *fl,
 269                        struct sock *sk, int flags)
 270 {
 271         return 0;
 272 }
 273 static inline int __xfrm_lookup(struct dst_entry **dst_p, struct flowi *fl,
 274                                 struct sock *sk, int flags)
 275 {
 276         return 0;
 277 }
 278 #else
 279 extern int xfrm_lookup(struct dst_entry **dst_p, struct flowi *fl,
 280                        struct sock *sk, int flags);
 281 extern int __xfrm_lookup(struct dst_entry **dst_p, struct flowi *fl,
 282                          struct sock *sk, int flags);
 283 #endif
 284 #endif
 285
 286 #endif /* _NET_DST_H */