1 #ifndef _NET_NEIGHBOUR_H
2 #define _NET_NEIGHBOUR_H
4 #include <linux/neighbour.h>
7 * Generic neighbour manipulation
10 * Pedro Roque <roque@di.fc.ul.pt>
11 * Alexey Kuznetsov <kuznet@ms2.inr.ac.ru>
15 * Harald Welte: <laforge@gnumonks.org>
16 * - Add neighbour cache statistics like rtstat
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>
25 #include <linux/err.h>
26 #include <linux/sysctl.h>
27 #include <linux/workqueue.h>
28 #include <net/rtnetlink.h>
31 * NUD stands for "neighbor unreachability detection"
34 #define NUD_IN_TIMER (NUD_INCOMPLETE|NUD_REACHABLE|NUD_DELAY|NUD_PROBE)
35 #define NUD_VALID (NUD_PERMANENT|NUD_NOARP|NUD_REACHABLE|NUD_PROBE|NUD_STALE|NUD_DELAY)
36 #define NUD_CONNECTED (NUD_PERMANENT|NUD_NOARP|NUD_REACHABLE)
44 struct net_device *dev;
45 struct neigh_parms *next;
46 int (*neigh_setup)(struct neighbour *);
47 void (*neigh_cleanup)(struct neighbour *);
48 struct neigh_table *tbl;
54 struct rcu_head rcu_head;
56 int base_reachable_time;
72 struct neigh_statistics {
73 unsigned long allocs; /* number of allocated neighs */
74 unsigned long destroys; /* number of destroyed neighs */
75 unsigned long hash_grows; /* number of hash resizes */
77 unsigned long res_failed; /* number of failed resolutions */
79 unsigned long lookups; /* number of lookups */
80 unsigned long hits; /* number of hits (among lookups) */
82 unsigned long rcv_probes_mcast; /* number of received mcast ipv6 */
83 unsigned long rcv_probes_ucast; /* number of received ucast ipv6 */
85 unsigned long periodic_gc_runs; /* number of periodic GC runs */
86 unsigned long forced_gc_runs; /* number of forced GC runs */
88 unsigned long unres_discards; /* number of unresolved drops */
91 #define NEIGH_CACHE_STAT_INC(tbl, field) this_cpu_inc((tbl)->stats->field)
94 struct neighbour *next;
95 struct neigh_table *tbl;
96 struct neigh_parms *parms;
97 struct net_device *dev;
99 unsigned long confirmed;
100 unsigned long updated;
108 unsigned char ha[ALIGN(MAX_ADDR_LEN, sizeof(unsigned long))];
110 int (*output)(struct sk_buff *skb);
111 struct sk_buff_head arp_queue;
112 struct timer_list timer;
113 const struct neigh_ops *ops;
119 void (*solicit)(struct neighbour *, struct sk_buff*);
120 void (*error_report)(struct neighbour *, struct sk_buff*);
121 int (*output)(struct sk_buff*);
122 int (*connected_output)(struct sk_buff*);
123 int (*hh_output)(struct sk_buff*);
124 int (*queue_xmit)(struct sk_buff*);
127 struct pneigh_entry {
128 struct pneigh_entry *next;
132 struct net_device *dev;
138 * neighbour table manipulation
141 struct neigh_hash_table {
142 struct neighbour **hash_buckets;
143 unsigned int hash_mask;
150 struct neigh_table *next;
154 __u32 (*hash)(const void *pkey,
155 const struct net_device *dev,
157 int (*constructor)(struct neighbour *);
158 int (*pconstructor)(struct pneigh_entry *);
159 void (*pdestructor)(struct pneigh_entry *);
160 void (*proxy_redo)(struct sk_buff *skb);
162 struct neigh_parms parms;
163 /* HACK. gc_* should follow parms without a gap! */
168 unsigned long last_flush;
169 struct delayed_work gc_work;
170 struct timer_list proxy_timer;
171 struct sk_buff_head proxy_queue;
174 unsigned long last_rand;
175 struct kmem_cache *kmem_cachep;
176 struct neigh_statistics __percpu *stats;
177 struct neigh_hash_table __rcu *nht;
178 struct pneigh_entry **phash_buckets;
181 /* flags for neigh_update() */
182 #define NEIGH_UPDATE_F_OVERRIDE 0x00000001
183 #define NEIGH_UPDATE_F_WEAK_OVERRIDE 0x00000002
184 #define NEIGH_UPDATE_F_OVERRIDE_ISROUTER 0x00000004
185 #define NEIGH_UPDATE_F_ISROUTER 0x40000000
186 #define NEIGH_UPDATE_F_ADMIN 0x80000000
188 extern void neigh_table_init(struct neigh_table *tbl);
189 extern void neigh_table_init_no_netlink(struct neigh_table *tbl);
190 extern int neigh_table_clear(struct neigh_table *tbl);
191 extern struct neighbour * neigh_lookup(struct neigh_table *tbl,
193 struct net_device *dev);
194 extern struct neighbour * neigh_lookup_nodev(struct neigh_table *tbl,
197 extern struct neighbour * neigh_create(struct neigh_table *tbl,
199 struct net_device *dev);
200 extern void neigh_destroy(struct neighbour *neigh);
201 extern int __neigh_event_send(struct neighbour *neigh, struct sk_buff *skb);
202 extern int neigh_update(struct neighbour *neigh, const u8 *lladdr, u8 new,
204 extern void neigh_changeaddr(struct neigh_table *tbl, struct net_device *dev);
205 extern int neigh_ifdown(struct neigh_table *tbl, struct net_device *dev);
206 extern int neigh_resolve_output(struct sk_buff *skb);
207 extern int neigh_connected_output(struct sk_buff *skb);
208 extern int neigh_compat_output(struct sk_buff *skb);
209 extern struct neighbour *neigh_event_ns(struct neigh_table *tbl,
210 u8 *lladdr, void *saddr,
211 struct net_device *dev);
213 extern struct neigh_parms *neigh_parms_alloc(struct net_device *dev, struct neigh_table *tbl);
214 extern void neigh_parms_release(struct neigh_table *tbl, struct neigh_parms *parms);
217 struct net *neigh_parms_net(const struct neigh_parms *parms)
219 return read_pnet(&parms->net);
222 extern unsigned long neigh_rand_reach_time(unsigned long base);
224 extern void pneigh_enqueue(struct neigh_table *tbl, struct neigh_parms *p,
225 struct sk_buff *skb);
226 extern struct pneigh_entry *pneigh_lookup(struct neigh_table *tbl, struct net *net, const void *key, struct net_device *dev, int creat);
227 extern struct pneigh_entry *__pneigh_lookup(struct neigh_table *tbl,
230 struct net_device *dev);
231 extern int pneigh_delete(struct neigh_table *tbl, struct net *net, const void *key, struct net_device *dev);
234 struct net *pneigh_net(const struct pneigh_entry *pneigh)
236 return read_pnet(&pneigh->net);
239 extern void neigh_app_ns(struct neighbour *n);
240 extern void neigh_for_each(struct neigh_table *tbl, void (*cb)(struct neighbour *, void *), void *cookie);
241 extern void __neigh_for_each_release(struct neigh_table *tbl, int (*cb)(struct neighbour *));
242 extern void pneigh_for_each(struct neigh_table *tbl, void (*cb)(struct pneigh_entry *));
244 struct neigh_seq_state {
245 struct seq_net_private p;
246 struct neigh_table *tbl;
247 struct neigh_hash_table *nht;
248 void *(*neigh_sub_iter)(struct neigh_seq_state *state,
249 struct neighbour *n, loff_t *pos);
252 #define NEIGH_SEQ_NEIGH_ONLY 0x00000001
253 #define NEIGH_SEQ_IS_PNEIGH 0x00000002
254 #define NEIGH_SEQ_SKIP_NOARP 0x00000004
256 extern void *neigh_seq_start(struct seq_file *, loff_t *, struct neigh_table *, unsigned int);
257 extern void *neigh_seq_next(struct seq_file *, void *, loff_t *);
258 extern void neigh_seq_stop(struct seq_file *, void *);
260 extern int neigh_sysctl_register(struct net_device *dev,
261 struct neigh_parms *p,
263 proc_handler *proc_handler);
264 extern void neigh_sysctl_unregister(struct neigh_parms *p);
266 static inline void __neigh_parms_put(struct neigh_parms *parms)
268 atomic_dec(&parms->refcnt);
271 static inline struct neigh_parms *neigh_parms_clone(struct neigh_parms *parms)
273 atomic_inc(&parms->refcnt);
278 * Neighbour references
281 static inline void neigh_release(struct neighbour *neigh)
283 if (atomic_dec_and_test(&neigh->refcnt))
284 neigh_destroy(neigh);
287 static inline struct neighbour * neigh_clone(struct neighbour *neigh)
290 atomic_inc(&neigh->refcnt);
294 #define neigh_hold(n) atomic_inc(&(n)->refcnt)
296 static inline void neigh_confirm(struct neighbour *neigh)
299 neigh->confirmed = jiffies;
302 static inline int neigh_event_send(struct neighbour *neigh, struct sk_buff *skb)
304 neigh->used = jiffies;
305 if (!(neigh->nud_state&(NUD_CONNECTED|NUD_DELAY|NUD_PROBE)))
306 return __neigh_event_send(neigh, skb);
310 #ifdef CONFIG_BRIDGE_NETFILTER
311 static inline int neigh_hh_bridge(struct hh_cache *hh, struct sk_buff *skb)
313 unsigned seq, hh_alen;
316 seq = read_seqbegin(&hh->hh_lock);
317 hh_alen = HH_DATA_ALIGN(ETH_HLEN);
318 memcpy(skb->data - hh_alen, hh->hh_data, ETH_ALEN + hh_alen - ETH_HLEN);
319 } while (read_seqretry(&hh->hh_lock, seq));
324 static inline int neigh_hh_output(struct hh_cache *hh, struct sk_buff *skb)
332 seq = read_seqbegin(&hh->hh_lock);
334 hh_alen = HH_DATA_ALIGN(hh_len);
335 memcpy(skb->data - hh_alen, hh->hh_data, hh_alen);
336 } while (read_seqretry(&hh->hh_lock, seq));
338 skb_push(skb, hh_len);
339 return hh->hh_output(skb);
342 static inline struct neighbour *
343 __neigh_lookup(struct neigh_table *tbl, const void *pkey, struct net_device *dev, int creat)
345 struct neighbour *n = neigh_lookup(tbl, pkey, dev);
350 n = neigh_create(tbl, pkey, dev);
351 return IS_ERR(n) ? NULL : n;
354 static inline struct neighbour *
355 __neigh_lookup_errno(struct neigh_table *tbl, const void *pkey,
356 struct net_device *dev)
358 struct neighbour *n = neigh_lookup(tbl, pkey, dev);
363 return neigh_create(tbl, pkey, dev);
366 struct neighbour_cb {
367 unsigned long sched_next;
371 #define LOCALLY_ENQUEUED 0x1
373 #define NEIGH_CB(skb) ((struct neighbour_cb *)(skb)->cb)