1 #ifndef _NET_NEIGHBOUR_H
2 #define _NET_NEIGHBOUR_H
5 * Generic neighbour manipulation
8 * Pedro Roque <roque@di.fc.ul.pt>
9 * Alexey Kuznetsov <kuznet@ms2.inr.ac.ru>
13 * Harald Welte: <laforge@gnumonks.org>
14 * - Add neighbour cache statistics like rtstat
17 /* The following flags & states are exported to user space,
18 so that they should be moved to include/linux/ directory.
22 * Neighbor Cache Entry Flags
25 #define NTF_PROXY 0x08 /* == ATF_PUBL */
26 #define NTF_ROUTER 0x80
29 * Neighbor Cache Entry States.
32 #define NUD_INCOMPLETE 0x01
33 #define NUD_REACHABLE 0x02
34 #define NUD_STALE 0x04
35 #define NUD_DELAY 0x08
36 #define NUD_PROBE 0x10
37 #define NUD_FAILED 0x20
40 #define NUD_NOARP 0x40
41 #define NUD_PERMANENT 0x80
44 /* NUD_NOARP & NUD_PERMANENT are pseudostates, they never change
45 and make no address resolution or NUD.
46 NUD_PERMANENT is also cannot be deleted by garbage collectors.
51 #include <asm/atomic.h>
52 #include <linux/skbuff.h>
53 #include <linux/netdevice.h>
54 #include <linux/rcupdate.h>
55 #include <linux/seq_file.h>
57 #include <linux/err.h>
58 #include <linux/sysctl.h>
60 #define NUD_IN_TIMER (NUD_INCOMPLETE|NUD_REACHABLE|NUD_DELAY|NUD_PROBE)
61 #define NUD_VALID (NUD_PERMANENT|NUD_NOARP|NUD_REACHABLE|NUD_PROBE|NUD_STALE|NUD_DELAY)
62 #define NUD_CONNECTED (NUD_PERMANENT|NUD_NOARP|NUD_REACHABLE)
68 struct neigh_parms *next;
69 int (*neigh_setup)(struct neighbour *);
70 struct neigh_table *tbl;
78 struct rcu_head rcu_head;
80 int base_reachable_time;
96 struct neigh_statistics
98 unsigned long allocs; /* number of allocated neighs */
99 unsigned long destroys; /* number of destroyed neighs */
100 unsigned long hash_grows; /* number of hash resizes */
102 unsigned long res_failed; /* nomber of failed resolutions */
104 unsigned long lookups; /* number of lookups */
105 unsigned long hits; /* number of hits (among lookups) */
107 unsigned long rcv_probes_mcast; /* number of received mcast ipv6 */
108 unsigned long rcv_probes_ucast; /* number of received ucast ipv6 */
110 unsigned long periodic_gc_runs; /* number of periodic GC runs */
111 unsigned long forced_gc_runs; /* number of forced GC runs */
114 #define NEIGH_CACHE_STAT_INC(tbl, field) \
117 (per_cpu_ptr((tbl)->stats, smp_processor_id())->field)++; \
123 struct neighbour *next;
124 struct neigh_table *tbl;
125 struct neigh_parms *parms;
126 struct net_device *dev;
128 unsigned long confirmed;
129 unsigned long updated;
136 unsigned char ha[(MAX_ADDR_LEN+sizeof(unsigned long)-1)&~(sizeof(unsigned long)-1)];
139 int (*output)(struct sk_buff *skb);
140 struct sk_buff_head arp_queue;
141 struct timer_list timer;
142 struct neigh_ops *ops;
149 void (*destructor)(struct neighbour *);
150 void (*solicit)(struct neighbour *, struct sk_buff*);
151 void (*error_report)(struct neighbour *, struct sk_buff*);
152 int (*output)(struct sk_buff*);
153 int (*connected_output)(struct sk_buff*);
154 int (*hh_output)(struct sk_buff*);
155 int (*queue_xmit)(struct sk_buff*);
160 struct pneigh_entry *next;
161 struct net_device *dev;
166 * neighbour table manipulation
172 struct neigh_table *next;
176 __u32 (*hash)(const void *pkey, const struct net_device *);
177 int (*constructor)(struct neighbour *);
178 int (*pconstructor)(struct pneigh_entry *);
179 void (*pdestructor)(struct pneigh_entry *);
180 void (*proxy_redo)(struct sk_buff *skb);
182 struct neigh_parms parms;
183 /* HACK. gc_* shoul follow parms without a gap! */
188 unsigned long last_flush;
189 struct timer_list gc_timer;
190 struct timer_list proxy_timer;
191 struct sk_buff_head proxy_queue;
194 unsigned long last_rand;
195 struct neigh_parms *parms_list;
196 kmem_cache_t *kmem_cachep;
197 struct neigh_statistics *stats;
198 struct neighbour **hash_buckets;
199 unsigned int hash_mask;
201 unsigned int hash_chain_gc;
202 struct pneigh_entry **phash_buckets;
203 #ifdef CONFIG_PROC_FS
204 struct proc_dir_entry *pde;
208 /* flags for neigh_update() */
209 #define NEIGH_UPDATE_F_OVERRIDE 0x00000001
210 #define NEIGH_UPDATE_F_WEAK_OVERRIDE 0x00000002
211 #define NEIGH_UPDATE_F_OVERRIDE_ISROUTER 0x00000004
212 #define NEIGH_UPDATE_F_ISROUTER 0x40000000
213 #define NEIGH_UPDATE_F_ADMIN 0x80000000
215 extern void neigh_table_init(struct neigh_table *tbl);
216 extern int neigh_table_clear(struct neigh_table *tbl);
217 extern struct neighbour * neigh_lookup(struct neigh_table *tbl,
219 struct net_device *dev);
220 extern struct neighbour * neigh_lookup_nodev(struct neigh_table *tbl,
222 extern struct neighbour * neigh_create(struct neigh_table *tbl,
224 struct net_device *dev);
225 extern void neigh_destroy(struct neighbour *neigh);
226 extern int __neigh_event_send(struct neighbour *neigh, struct sk_buff *skb);
227 extern int neigh_update(struct neighbour *neigh, const u8 *lladdr, u8 new,
229 extern void neigh_changeaddr(struct neigh_table *tbl, struct net_device *dev);
230 extern int neigh_ifdown(struct neigh_table *tbl, struct net_device *dev);
231 extern int neigh_resolve_output(struct sk_buff *skb);
232 extern int neigh_connected_output(struct sk_buff *skb);
233 extern int neigh_compat_output(struct sk_buff *skb);
234 extern struct neighbour *neigh_event_ns(struct neigh_table *tbl,
235 u8 *lladdr, void *saddr,
236 struct net_device *dev);
238 extern struct neigh_parms *neigh_parms_alloc(struct net_device *dev, struct neigh_table *tbl);
239 extern void neigh_parms_release(struct neigh_table *tbl, struct neigh_parms *parms);
240 extern void neigh_parms_destroy(struct neigh_parms *parms);
241 extern unsigned long neigh_rand_reach_time(unsigned long base);
243 extern void pneigh_enqueue(struct neigh_table *tbl, struct neigh_parms *p,
244 struct sk_buff *skb);
245 extern struct pneigh_entry *pneigh_lookup(struct neigh_table *tbl, const void *key, struct net_device *dev, int creat);
246 extern int pneigh_delete(struct neigh_table *tbl, const void *key, struct net_device *dev);
248 struct netlink_callback;
250 extern int neigh_dump_info(struct sk_buff *skb, struct netlink_callback *cb);
251 extern int neigh_add(struct sk_buff *skb, struct nlmsghdr *nlh, void *arg);
252 extern int neigh_delete(struct sk_buff *skb, struct nlmsghdr *nlh, void *arg);
253 extern void neigh_app_ns(struct neighbour *n);
255 extern void neigh_for_each(struct neigh_table *tbl, void (*cb)(struct neighbour *, void *), void *cookie);
256 extern void __neigh_for_each_release(struct neigh_table *tbl, int (*cb)(struct neighbour *));
257 extern void pneigh_for_each(struct neigh_table *tbl, void (*cb)(struct pneigh_entry *));
259 struct neigh_seq_state {
260 struct neigh_table *tbl;
261 void *(*neigh_sub_iter)(struct neigh_seq_state *state,
262 struct neighbour *n, loff_t *pos);
265 #define NEIGH_SEQ_NEIGH_ONLY 0x00000001
266 #define NEIGH_SEQ_IS_PNEIGH 0x00000002
267 #define NEIGH_SEQ_SKIP_NOARP 0x00000004
269 extern void *neigh_seq_start(struct seq_file *, loff_t *, struct neigh_table *, unsigned int);
270 extern void *neigh_seq_next(struct seq_file *, void *, loff_t *);
271 extern void neigh_seq_stop(struct seq_file *, void *);
273 extern int neigh_sysctl_register(struct net_device *dev,
274 struct neigh_parms *p,
275 int p_id, int pdev_id,
277 proc_handler *proc_handler,
278 ctl_handler *strategy);
279 extern void neigh_sysctl_unregister(struct neigh_parms *p);
281 static inline void __neigh_parms_put(struct neigh_parms *parms)
283 atomic_dec(&parms->refcnt);
286 static inline void neigh_parms_put(struct neigh_parms *parms)
288 if (atomic_dec_and_test(&parms->refcnt))
289 neigh_parms_destroy(parms);
292 static inline struct neigh_parms *neigh_parms_clone(struct neigh_parms *parms)
294 atomic_inc(&parms->refcnt);
299 * Neighbour references
302 static inline void neigh_release(struct neighbour *neigh)
304 if (atomic_dec_and_test(&neigh->refcnt))
305 neigh_destroy(neigh);
308 static inline struct neighbour * neigh_clone(struct neighbour *neigh)
311 atomic_inc(&neigh->refcnt);
315 #define neigh_hold(n) atomic_inc(&(n)->refcnt)
317 static inline void neigh_confirm(struct neighbour *neigh)
320 neigh->confirmed = jiffies;
323 static inline int neigh_is_connected(struct neighbour *neigh)
325 return neigh->nud_state&NUD_CONNECTED;
328 static inline int neigh_is_valid(struct neighbour *neigh)
330 return neigh->nud_state&NUD_VALID;
333 static inline int neigh_event_send(struct neighbour *neigh, struct sk_buff *skb)
335 neigh->used = jiffies;
336 if (!(neigh->nud_state&(NUD_CONNECTED|NUD_DELAY|NUD_PROBE)))
337 return __neigh_event_send(neigh, skb);
341 static inline struct neighbour *
342 __neigh_lookup(struct neigh_table *tbl, const void *pkey, struct net_device *dev, int creat)
344 struct neighbour *n = neigh_lookup(tbl, pkey, dev);
349 n = neigh_create(tbl, pkey, dev);
350 return IS_ERR(n) ? NULL : n;
353 static inline struct neighbour *
354 __neigh_lookup_errno(struct neigh_table *tbl, const void *pkey,
355 struct net_device *dev)
357 struct neighbour *n = neigh_lookup(tbl, pkey, dev);
362 return neigh_create(tbl, pkey, dev);
365 #define LOCALLY_ENQUEUED -2