include/net/neighbour.h

   1 #ifndef _NET_NEIGHBOUR_H
   2 #define _NET_NEIGHBOUR_H
   3
   4 #include <linux/neighbour.h>
   5
   6 /*
   7  *      Generic neighbour manipulation
   8  *
   9  *      Authors:
  10  *      Pedro Roque             <roque@di.fc.ul.pt>
  11  *      Alexey Kuznetsov        <kuznet@ms2.inr.ac.ru>
  12  *
  13  *      Changes:
  14  *
  15  *      Harald Welte:           <laforge@gnumonks.org>
  16  *              - Add neighbour cache statistics like rtstat
  17  */
  18
  19 #include <asm/atomic.h>
  20 #include <linux/netdevice.h>
  21 #include <linux/skbuff.h>
  22 #include <linux/rcupdate.h>
  23 #include <linux/seq_file.h>
  24
  25 #include <linux/err.h>
  26 #include <linux/sysctl.h>
  27 #include <net/rtnetlink.h>
  28
  29 /*
  30  * NUD stands for "neighbor unreachability detection"
  31  */
  32
  33 #define NUD_IN_TIMER    (NUD_INCOMPLETE|NUD_REACHABLE|NUD_DELAY|NUD_PROBE)
  34 #define NUD_VALID       (NUD_PERMANENT|NUD_NOARP|NUD_REACHABLE|NUD_PROBE|NUD_STALE|NUD_DELAY)
  35 #define NUD_CONNECTED   (NUD_PERMANENT|NUD_NOARP|NUD_REACHABLE)
  36
  37 struct neighbour;
  38
  39 struct neigh_parms
  40 {
  41         struct net *net;
  42         struct net_device *dev;
  43         struct neigh_parms *next;
  44         int     (*neigh_setup)(struct neighbour *);
  45         void    (*neigh_cleanup)(struct neighbour *);
  46         struct neigh_table *tbl;
  47
  48         void    *sysctl_table;
  49
  50         int dead;
  51         atomic_t refcnt;
  52         struct rcu_head rcu_head;
  53
  54         int     base_reachable_time;
  55         int     retrans_time;
  56         int     gc_staletime;
  57         int     reachable_time;
  58         int     delay_probe_time;
  59
  60         int     queue_len;
  61         int     ucast_probes;
  62         int     app_probes;
  63         int     mcast_probes;
  64         int     anycast_delay;
  65         int     proxy_delay;
  66         int     proxy_qlen;
  67         int     locktime;
  68 };
  69
  70 struct neigh_statistics
  71 {
  72         unsigned long allocs;           /* number of allocated neighs */
  73         unsigned long destroys;         /* number of destroyed neighs */
  74         unsigned long hash_grows;       /* number of hash resizes */
  75
  76         unsigned long res_failed;       /* nomber of failed resolutions */
  77
  78         unsigned long lookups;          /* number of lookups */
  79         unsigned long hits;             /* number of hits (among lookups) */
  80
  81         unsigned long rcv_probes_mcast; /* number of received mcast ipv6 */
  82         unsigned long rcv_probes_ucast; /* number of received ucast ipv6 */
  83
  84         unsigned long periodic_gc_runs; /* number of periodic GC runs */
  85         unsigned long forced_gc_runs;   /* number of forced GC runs */
  86 };
  87
  88 #define NEIGH_CACHE_STAT_INC(tbl, field)                                \
  89         do {                                                            \
  90                 preempt_disable();                                      \
  91                 (per_cpu_ptr((tbl)->stats, smp_processor_id())->field)++; \
  92                 preempt_enable();                                       \
  93         } while (0)
  94
  95 struct neighbour
  96 {
  97         struct neighbour        *next;
  98         struct neigh_table      *tbl;
  99         struct neigh_parms      *parms;
 100         struct net_device               *dev;
 101         unsigned long           used;
 102         unsigned long           confirmed;
 103         unsigned long           updated;
 104         __u8                    flags;
 105         __u8                    nud_state;
 106         __u8                    type;
 107         __u8                    dead;
 108         atomic_t                probes;
 109         rwlock_t                lock;
 110         unsigned char           ha[ALIGN(MAX_ADDR_LEN, sizeof(unsigned long))];
 111         struct hh_cache         *hh;
 112         atomic_t                refcnt;
 113         int                     (*output)(struct sk_buff *skb);
 114         struct sk_buff_head     arp_queue;
 115         struct timer_list       timer;
 116         struct neigh_ops        *ops;
 117         u8                      primary_key[0];
 118 };
 119
 120 struct neigh_ops
 121 {
 122         int                     family;
 123         void                    (*solicit)(struct neighbour *, struct sk_buff*);
 124         void                    (*error_report)(struct neighbour *, struct sk_buff*);
 125         int                     (*output)(struct sk_buff*);
 126         int                     (*connected_output)(struct sk_buff*);
 127         int                     (*hh_output)(struct sk_buff*);
 128         int                     (*queue_xmit)(struct sk_buff*);
 129 };
 130
 131 struct pneigh_entry
 132 {
 133         struct pneigh_entry     *next;
 134         struct net              *net;
 135         struct net_device       *dev;
 136         u8                      flags;
 137         u8                      key[0];
 138 };
 139
 140 /*
 141  *      neighbour table manipulation
 142  */
 143
 144
 145 struct neigh_table
 146 {
 147         struct neigh_table      *next;
 148         int                     family;
 149         int                     entry_size;
 150         int                     key_len;
 151         __u32                   (*hash)(const void *pkey, const struct net_device *);
 152         int                     (*constructor)(struct neighbour *);
 153         int                     (*pconstructor)(struct pneigh_entry *);
 154         void                    (*pdestructor)(struct pneigh_entry *);
 155         void                    (*proxy_redo)(struct sk_buff *skb);
 156         char                    *id;
 157         struct neigh_parms      parms;
 158         /* HACK. gc_* shoul follow parms without a gap! */
 159         int                     gc_interval;
 160         int                     gc_thresh1;
 161         int                     gc_thresh2;
 162         int                     gc_thresh3;
 163         unsigned long           last_flush;
 164         struct timer_list       gc_timer;
 165         struct timer_list       proxy_timer;
 166         struct sk_buff_head     proxy_queue;
 167         atomic_t                entries;
 168         rwlock_t                lock;
 169         unsigned long           last_rand;
 170         struct kmem_cache               *kmem_cachep;
 171         struct neigh_statistics *stats;
 172         struct neighbour        **hash_buckets;
 173         unsigned int            hash_mask;
 174         __u32                   hash_rnd;
 175         unsigned int            hash_chain_gc;
 176         struct pneigh_entry     **phash_buckets;
 177 #ifdef CONFIG_PROC_FS
 178         struct proc_dir_entry   *pde;
 179 #endif
 180 };
 181
 182 /* flags for neigh_update() */
 183 #define NEIGH_UPDATE_F_OVERRIDE                 0x00000001
 184 #define NEIGH_UPDATE_F_WEAK_OVERRIDE            0x00000002
 185 #define NEIGH_UPDATE_F_OVERRIDE_ISROUTER        0x00000004
 186 #define NEIGH_UPDATE_F_ISROUTER                 0x40000000
 187 #define NEIGH_UPDATE_F_ADMIN                    0x80000000
 188
 189 extern void                     neigh_table_init(struct neigh_table *tbl);
 190 extern void                     neigh_table_init_no_netlink(struct neigh_table *tbl);
 191 extern int                      neigh_table_clear(struct neigh_table *tbl);
 192 extern struct neighbour *       neigh_lookup(struct neigh_table *tbl,
 193                                              const void *pkey,
 194                                              struct net_device *dev);
 195 extern struct neighbour *       neigh_lookup_nodev(struct neigh_table *tbl,
 196                                                    struct net *net,
 197                                                    const void *pkey);
 198 extern struct neighbour *       neigh_create(struct neigh_table *tbl,
 199                                              const void *pkey,
 200                                              struct net_device *dev);
 201 extern void                     neigh_destroy(struct neighbour *neigh);
 202 extern int                      __neigh_event_send(struct neighbour *neigh, struct sk_buff *skb);
 203 extern int                      neigh_update(struct neighbour *neigh, const u8 *lladdr, u8 new,
 204                                              u32 flags);
 205 extern void                     neigh_changeaddr(struct neigh_table *tbl, struct net_device *dev);
 206 extern int                      neigh_ifdown(struct neigh_table *tbl, struct net_device *dev);
 207 extern int                      neigh_resolve_output(struct sk_buff *skb);
 208 extern int                      neigh_connected_output(struct sk_buff *skb);
 209 extern int                      neigh_compat_output(struct sk_buff *skb);
 210 extern struct neighbour         *neigh_event_ns(struct neigh_table *tbl,
 211                                                 u8 *lladdr, void *saddr,
 212                                                 struct net_device *dev);
 213
 214 extern struct neigh_parms       *neigh_parms_alloc(struct net_device *dev, struct neigh_table *tbl);
 215 extern void                     neigh_parms_release(struct neigh_table *tbl, struct neigh_parms *parms);
 216 extern void                     neigh_parms_destroy(struct neigh_parms *parms);
 217 extern unsigned long            neigh_rand_reach_time(unsigned long base);
 218
 219 extern void                     pneigh_enqueue(struct neigh_table *tbl, struct neigh_parms *p,
 220                                                struct sk_buff *skb);
 221 extern struct pneigh_entry      *pneigh_lookup(struct neigh_table *tbl, struct net *net, const void *key, struct net_device *dev, int creat);
 222 extern int                      pneigh_delete(struct neigh_table *tbl, struct net *net, const void *key, struct net_device *dev);
 223
 224 extern void neigh_app_ns(struct neighbour *n);
 225 extern void neigh_for_each(struct neigh_table *tbl, void (*cb)(struct neighbour *, void *), void *cookie);
 226 extern void __neigh_for_each_release(struct neigh_table *tbl, int (*cb)(struct neighbour *));
 227 extern void pneigh_for_each(struct neigh_table *tbl, void (*cb)(struct pneigh_entry *));
 228
 229 struct neigh_seq_state {
 230         struct seq_net_private p;
 231         struct neigh_table *tbl;
 232         void *(*neigh_sub_iter)(struct neigh_seq_state *state,
 233                                 struct neighbour *n, loff_t *pos);
 234         unsigned int bucket;
 235         unsigned int flags;
 236 #define NEIGH_SEQ_NEIGH_ONLY    0x00000001
 237 #define NEIGH_SEQ_IS_PNEIGH     0x00000002
 238 #define NEIGH_SEQ_SKIP_NOARP    0x00000004
 239 };
 240 extern void *neigh_seq_start(struct seq_file *, loff_t *, struct neigh_table *, unsigned int);
 241 extern void *neigh_seq_next(struct seq_file *, void *, loff_t *);
 242 extern void neigh_seq_stop(struct seq_file *, void *);
 243
 244 extern int                      neigh_sysctl_register(struct net_device *dev,
 245                                                       struct neigh_parms *p,
 246                                                       int p_id, int pdev_id,
 247                                                       char *p_name,
 248                                                       proc_handler *proc_handler,
 249                                                       ctl_handler *strategy);
 250 extern void                     neigh_sysctl_unregister(struct neigh_parms *p);
 251
 252 static inline void __neigh_parms_put(struct neigh_parms *parms)
 253 {
 254         atomic_dec(&parms->refcnt);
 255 }
 256
 257 static inline void neigh_parms_put(struct neigh_parms *parms)
 258 {
 259         if (atomic_dec_and_test(&parms->refcnt))
 260                 neigh_parms_destroy(parms);
 261 }
 262
 263 static inline struct neigh_parms *neigh_parms_clone(struct neigh_parms *parms)
 264 {
 265         atomic_inc(&parms->refcnt);
 266         return parms;
 267 }
 268
 269 /*
 270  *      Neighbour references
 271  */
 272
 273 static inline void neigh_release(struct neighbour *neigh)
 274 {
 275         if (atomic_dec_and_test(&neigh->refcnt))
 276                 neigh_destroy(neigh);
 277 }
 278
 279 static inline struct neighbour * neigh_clone(struct neighbour *neigh)
 280 {
 281         if (neigh)
 282                 atomic_inc(&neigh->refcnt);
 283         return neigh;
 284 }
 285
 286 #define neigh_hold(n)   atomic_inc(&(n)->refcnt)
 287
 288 static inline void neigh_confirm(struct neighbour *neigh)
 289 {
 290         if (neigh)
 291                 neigh->confirmed = jiffies;
 292 }
 293
 294 static inline int neigh_is_connected(struct neighbour *neigh)
 295 {
 296         return neigh->nud_state&NUD_CONNECTED;
 297 }
 298
 299
 300 static inline int neigh_event_send(struct neighbour *neigh, struct sk_buff *skb)
 301 {
 302         neigh->used = jiffies;
 303         if (!(neigh->nud_state&(NUD_CONNECTED|NUD_DELAY|NUD_PROBE)))
 304                 return __neigh_event_send(neigh, skb);
 305         return 0;
 306 }
 307
 308 static inline int neigh_hh_output(struct hh_cache *hh, struct sk_buff *skb)
 309 {
 310         unsigned seq;
 311         int hh_len;
 312
 313         do {
 314                 int hh_alen;
 315
 316                 seq = read_seqbegin(&hh->hh_lock);
 317                 hh_len = hh->hh_len;
 318                 hh_alen = HH_DATA_ALIGN(hh_len);
 319                 memcpy(skb->data - hh_alen, hh->hh_data, hh_alen);
 320         } while (read_seqretry(&hh->hh_lock, seq));
 321
 322         skb_push(skb, hh_len);
 323         return hh->hh_output(skb);
 324 }
 325
 326 static inline struct neighbour *
 327 __neigh_lookup(struct neigh_table *tbl, const void *pkey, struct net_device *dev, int creat)
 328 {
 329         struct neighbour *n = neigh_lookup(tbl, pkey, dev);
 330
 331         if (n || !creat)
 332                 return n;
 333
 334         n = neigh_create(tbl, pkey, dev);
 335         return IS_ERR(n) ? NULL : n;
 336 }
 337
 338 static inline struct neighbour *
 339 __neigh_lookup_errno(struct neigh_table *tbl, const void *pkey,
 340   struct net_device *dev)
 341 {
 342         struct neighbour *n = neigh_lookup(tbl, pkey, dev);
 343
 344         if (n)
 345                 return n;
 346
 347         return neigh_create(tbl, pkey, dev);
 348 }
 349
 350 struct neighbour_cb {
 351         unsigned long sched_next;
 352         unsigned int flags;
 353 };
 354
 355 #define LOCALLY_ENQUEUED 0x1
 356
 357 #define NEIGH_CB(skb)   ((struct neighbour_cb *)(skb)->cb)
 358
 359 #endif