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