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 *, int how);
  93         struct dst_entry *      (*negative_advice)(struct dst_entry *);
  94         void                    (*link_failure)(struct sk_buff *);
  95         void                    (*update_pmtu)(struct dst_entry *dst, u32 mtu);
  96         int                     (*get_mss)(struct dst_entry *dst, u32 mtu);
  97         int                     entry_size;
  98
  99         atomic_t                entries;
 100         kmem_cache_t            *kmem_cachep;
 101 };
 102
 103 #ifdef __KERNEL__
 104
 105 static inline u32
 106 dst_metric(struct dst_entry *dst, int metric)
 107 {
 108         return dst->metrics[metric-1];
 109 }
 110
 111 static inline u32
 112 dst_path_metric(struct dst_entry *dst, int metric)
 113 {
 114         return dst->path->metrics[metric-1];
 115 }
 116
 117 static inline u32
 118 dst_pmtu(struct dst_entry *dst)
 119 {
 120         u32 mtu = dst_path_metric(dst, RTAX_MTU);
 121         /* Yes, _exactly_. This is paranoia. */
 122         barrier();
 123         return mtu;
 124 }
 125
 126 static inline int
 127 dst_metric_locked(struct dst_entry *dst, int metric)
 128 {
 129         return dst_metric(dst, RTAX_LOCK) & (1<<metric);
 130 }
 131
 132 static inline void dst_hold(struct dst_entry * dst)
 133 {
 134         atomic_inc(&dst->__refcnt);
 135 }
 136
 137 static inline
 138 struct dst_entry * dst_clone(struct dst_entry * dst)
 139 {
 140         if (dst)
 141                 atomic_inc(&dst->__refcnt);
 142         return dst;
 143 }
 144
 145 static inline
 146 void dst_release(struct dst_entry * dst)
 147 {
 148         if (dst) {
 149                 if (atomic_read(&dst->__refcnt) < 1) {
 150                         printk("BUG: dst underflow %d: %p\n",
 151                                atomic_read(&dst->__refcnt),
 152                                current_text_addr());
 153                 }
 154                 atomic_dec(&dst->__refcnt);
 155         }
 156 }
 157
 158 /* Children define the path of the packet through the
 159  * Linux networking.  Thus, destinations are stackable.
 160  */
 161
 162 static inline struct dst_entry *dst_pop(struct dst_entry *dst)
 163 {
 164         struct dst_entry *child = dst_clone(dst->child);
 165
 166         dst_release(dst);
 167         return child;
 168 }
 169
 170 extern void * dst_alloc(struct dst_ops * ops);
 171 extern void __dst_free(struct dst_entry * dst);
 172 extern struct dst_entry *dst_destroy(struct dst_entry * dst);
 173
 174 static inline void dst_free(struct dst_entry * dst)
 175 {
 176         if (dst->obsolete > 1)
 177                 return;
 178         if (!atomic_read(&dst->__refcnt)) {
 179                 dst = dst_destroy(dst);
 180                 if (!dst)
 181                         return;
 182         }
 183         __dst_free(dst);
 184 }
 185
 186 static inline void dst_confirm(struct dst_entry *dst)
 187 {
 188         if (dst)
 189                 neigh_confirm(dst->neighbour);
 190 }
 191
 192 static inline void dst_negative_advice(struct dst_entry **dst_p)
 193 {
 194         struct dst_entry * dst = *dst_p;
 195         if (dst && dst->ops->negative_advice)
 196                 *dst_p = dst->ops->negative_advice(dst);
 197 }
 198
 199 static inline void dst_link_failure(struct sk_buff *skb)
 200 {
 201         struct dst_entry * dst = skb->dst;
 202         if (dst && dst->ops && dst->ops->link_failure)
 203                 dst->ops->link_failure(skb);
 204 }
 205
 206 static inline void dst_set_expires(struct dst_entry *dst, int timeout)
 207 {
 208         unsigned long expires = jiffies + timeout;
 209
 210         if (expires == 0)
 211                 expires = 1;
 212
 213         if (dst->expires == 0 || time_before(expires, dst->expires))
 214                 dst->expires = expires;
 215 }
 216
 217 /* Output packet to network from transport.  */
 218 static inline int dst_output(struct sk_buff *skb)
 219 {
 220         int err;
 221
 222         for (;;) {
 223                 err = skb->dst->output(&skb);
 224
 225                 if (likely(err == 0))
 226                         return err;
 227                 if (unlikely(err != NET_XMIT_BYPASS))
 228                         return err;
 229         }
 230 }
 231
 232 /* Input packet from network to transport.  */
 233 static inline int dst_input(struct sk_buff *skb)
 234 {
 235         int err;
 236
 237         for (;;) {
 238                 err = skb->dst->input(skb);
 239
 240                 if (likely(err == 0))
 241                         return err;
 242                 /* Oh, Jamal... Seems, I will not forgive you this mess. :-) */
 243                 if (unlikely(err != NET_XMIT_BYPASS))
 244                         return err;
 245         }
 246 }
 247
 248 extern void             dst_init(void);
 249
 250 struct flowi;
 251 #ifndef CONFIG_XFRM
 252 static inline int xfrm_lookup(struct dst_entry **dst_p, struct flowi *fl,
 253                        struct sock *sk, int flags)
 254 {
 255         return 0;
 256 }
 257 #else
 258 extern int xfrm_lookup(struct dst_entry **dst_p, struct flowi *fl,
 259                        struct sock *sk, int flags);
 260 #endif
 261 #endif
 262
 263 #endif /* _NET_DST_H */