blob: da1d58be31b7a4a3e9d8c43e2d11ef62f7b0be84 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001#ifndef _NET_NEIGHBOUR_H
2#define _NET_NEIGHBOUR_H
3
Thomas Graf9067c722006-08-07 17:57:44 -07004#include <linux/neighbour.h>
5
Linus Torvalds1da177e2005-04-16 15:20:36 -07006/*
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
Linus Torvalds1da177e2005-04-16 15:20:36 -070019#include <asm/atomic.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070020#include <linux/netdevice.h>
Arnaldo Carvalho de Melo14c85022005-12-27 02:43:12 -020021#include <linux/skbuff.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070022#include <linux/rcupdate.h>
23#include <linux/seq_file.h>
24
25#include <linux/err.h>
26#include <linux/sysctl.h>
Eric Dumazete4c4e442009-07-30 03:15:07 +000027#include <linux/workqueue.h>
Thomas Grafc8822a42007-03-22 11:50:06 -070028#include <net/rtnetlink.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070029
Pavel Emelyanov39971552008-01-10 22:37:16 -080030/*
31 * NUD stands for "neighbor unreachability detection"
32 */
33
Linus Torvalds1da177e2005-04-16 15:20:36 -070034#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)
37
38struct neighbour;
39
Eric Dumazetfd2c3ef2009-11-03 03:26:03 +000040struct neigh_parms {
YOSHIFUJI Hideaki57da52c2008-03-26 03:49:59 +090041#ifdef CONFIG_NET_NS
Eric W. Biederman426b5302008-01-24 00:13:18 -080042 struct net *net;
YOSHIFUJI Hideaki57da52c2008-03-26 03:49:59 +090043#endif
Thomas Grafc7fb64d2005-06-18 22:50:55 -070044 struct net_device *dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -070045 struct neigh_parms *next;
46 int (*neigh_setup)(struct neighbour *);
Alexey Kuznetsovecbb4162007-03-24 12:52:16 -070047 void (*neigh_cleanup)(struct neighbour *);
Linus Torvalds1da177e2005-04-16 15:20:36 -070048 struct neigh_table *tbl;
Linus Torvalds1da177e2005-04-16 15:20:36 -070049
50 void *sysctl_table;
51
52 int dead;
53 atomic_t refcnt;
54 struct rcu_head rcu_head;
55
56 int base_reachable_time;
57 int retrans_time;
58 int gc_staletime;
59 int reachable_time;
60 int delay_probe_time;
61
62 int queue_len;
63 int ucast_probes;
64 int app_probes;
65 int mcast_probes;
66 int anycast_delay;
67 int proxy_delay;
68 int proxy_qlen;
69 int locktime;
70};
71
Eric Dumazetfd2c3ef2009-11-03 03:26:03 +000072struct neigh_statistics {
Linus Torvalds1da177e2005-04-16 15:20:36 -070073 unsigned long allocs; /* number of allocated neighs */
74 unsigned long destroys; /* number of destroyed neighs */
75 unsigned long hash_grows; /* number of hash resizes */
76
Neil Horman9a6d2762008-07-16 20:50:49 -070077 unsigned long res_failed; /* number of failed resolutions */
Linus Torvalds1da177e2005-04-16 15:20:36 -070078
79 unsigned long lookups; /* number of lookups */
80 unsigned long hits; /* number of hits (among lookups) */
81
82 unsigned long rcv_probes_mcast; /* number of received mcast ipv6 */
83 unsigned long rcv_probes_ucast; /* number of received ucast ipv6 */
84
85 unsigned long periodic_gc_runs; /* number of periodic GC runs */
86 unsigned long forced_gc_runs; /* number of forced GC runs */
Neil Horman9a6d2762008-07-16 20:50:49 -070087
88 unsigned long unres_discards; /* number of unresolved drops */
Linus Torvalds1da177e2005-04-16 15:20:36 -070089};
90
Christoph Lameter4ea73342009-10-03 19:48:22 +090091#define NEIGH_CACHE_STAT_INC(tbl, field) this_cpu_inc((tbl)->stats->field)
Linus Torvalds1da177e2005-04-16 15:20:36 -070092
Eric Dumazetfd2c3ef2009-11-03 03:26:03 +000093struct neighbour {
Linus Torvalds1da177e2005-04-16 15:20:36 -070094 struct neighbour *next;
95 struct neigh_table *tbl;
96 struct neigh_parms *parms;
97 struct net_device *dev;
98 unsigned long used;
99 unsigned long confirmed;
100 unsigned long updated;
101 __u8 flags;
102 __u8 nud_state;
103 __u8 type;
104 __u8 dead;
105 atomic_t probes;
106 rwlock_t lock;
Stephen Hemmingerd9244242006-08-10 23:03:23 -0700107 unsigned char ha[ALIGN(MAX_ADDR_LEN, sizeof(unsigned long))];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700108 struct hh_cache *hh;
109 atomic_t refcnt;
110 int (*output)(struct sk_buff *skb);
111 struct sk_buff_head arp_queue;
112 struct timer_list timer;
Stephen Hemminger89d69d22009-09-01 11:13:19 +0000113 const struct neigh_ops *ops;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700114 u8 primary_key[0];
115};
116
Eric Dumazetfd2c3ef2009-11-03 03:26:03 +0000117struct neigh_ops {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700118 int family;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700119 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*);
125};
126
Eric Dumazetfd2c3ef2009-11-03 03:26:03 +0000127struct pneigh_entry {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700128 struct pneigh_entry *next;
YOSHIFUJI Hideaki57da52c2008-03-26 03:49:59 +0900129#ifdef CONFIG_NET_NS
Eric W. Biederman426b5302008-01-24 00:13:18 -0800130 struct net *net;
YOSHIFUJI Hideaki57da52c2008-03-26 03:49:59 +0900131#endif
Eric W. Biederman426b5302008-01-24 00:13:18 -0800132 struct net_device *dev;
Ville Nuorvala62dd9312006-09-22 14:43:19 -0700133 u8 flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700134 u8 key[0];
135};
136
137/*
138 * neighbour table manipulation
139 */
140
141
Eric Dumazetfd2c3ef2009-11-03 03:26:03 +0000142struct neigh_table {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700143 struct neigh_table *next;
144 int family;
145 int entry_size;
146 int key_len;
147 __u32 (*hash)(const void *pkey, const struct net_device *);
148 int (*constructor)(struct neighbour *);
149 int (*pconstructor)(struct pneigh_entry *);
150 void (*pdestructor)(struct pneigh_entry *);
151 void (*proxy_redo)(struct sk_buff *skb);
152 char *id;
153 struct neigh_parms parms;
154 /* HACK. gc_* shoul follow parms without a gap! */
155 int gc_interval;
156 int gc_thresh1;
157 int gc_thresh2;
158 int gc_thresh3;
159 unsigned long last_flush;
Eric Dumazete4c4e442009-07-30 03:15:07 +0000160 struct delayed_work gc_work;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700161 struct timer_list proxy_timer;
162 struct sk_buff_head proxy_queue;
163 atomic_t entries;
164 rwlock_t lock;
165 unsigned long last_rand;
Christoph Lametere18b8902006-12-06 20:33:20 -0800166 struct kmem_cache *kmem_cachep;
Tejun Heo7d720c32010-02-16 15:20:26 +0000167 struct neigh_statistics __percpu *stats;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700168 struct neighbour **hash_buckets;
169 unsigned int hash_mask;
170 __u32 hash_rnd;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700171 struct pneigh_entry **phash_buckets;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700172};
173
174/* flags for neigh_update() */
175#define NEIGH_UPDATE_F_OVERRIDE 0x00000001
176#define NEIGH_UPDATE_F_WEAK_OVERRIDE 0x00000002
177#define NEIGH_UPDATE_F_OVERRIDE_ISROUTER 0x00000004
178#define NEIGH_UPDATE_F_ISROUTER 0x40000000
179#define NEIGH_UPDATE_F_ADMIN 0x80000000
180
181extern void neigh_table_init(struct neigh_table *tbl);
Simon Kelleybd89efc2006-05-12 14:56:08 -0700182extern void neigh_table_init_no_netlink(struct neigh_table *tbl);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700183extern int neigh_table_clear(struct neigh_table *tbl);
184extern struct neighbour * neigh_lookup(struct neigh_table *tbl,
185 const void *pkey,
186 struct net_device *dev);
187extern struct neighbour * neigh_lookup_nodev(struct neigh_table *tbl,
Eric W. Biederman426b5302008-01-24 00:13:18 -0800188 struct net *net,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700189 const void *pkey);
190extern struct neighbour * neigh_create(struct neigh_table *tbl,
191 const void *pkey,
192 struct net_device *dev);
193extern void neigh_destroy(struct neighbour *neigh);
194extern int __neigh_event_send(struct neighbour *neigh, struct sk_buff *skb);
195extern int neigh_update(struct neighbour *neigh, const u8 *lladdr, u8 new,
196 u32 flags);
197extern void neigh_changeaddr(struct neigh_table *tbl, struct net_device *dev);
198extern int neigh_ifdown(struct neigh_table *tbl, struct net_device *dev);
199extern int neigh_resolve_output(struct sk_buff *skb);
200extern int neigh_connected_output(struct sk_buff *skb);
201extern int neigh_compat_output(struct sk_buff *skb);
202extern struct neighbour *neigh_event_ns(struct neigh_table *tbl,
203 u8 *lladdr, void *saddr,
204 struct net_device *dev);
205
206extern struct neigh_parms *neigh_parms_alloc(struct net_device *dev, struct neigh_table *tbl);
207extern void neigh_parms_release(struct neigh_table *tbl, struct neigh_parms *parms);
YOSHIFUJI Hideaki57da52c2008-03-26 03:49:59 +0900208
209static inline
210struct net *neigh_parms_net(const struct neigh_parms *parms)
211{
Eric Dumazete42ea982008-11-12 00:54:54 -0800212 return read_pnet(&parms->net);
YOSHIFUJI Hideaki57da52c2008-03-26 03:49:59 +0900213}
214
Linus Torvalds1da177e2005-04-16 15:20:36 -0700215extern unsigned long neigh_rand_reach_time(unsigned long base);
216
217extern void pneigh_enqueue(struct neigh_table *tbl, struct neigh_parms *p,
218 struct sk_buff *skb);
Eric W. Biederman426b5302008-01-24 00:13:18 -0800219extern struct pneigh_entry *pneigh_lookup(struct neigh_table *tbl, struct net *net, const void *key, struct net_device *dev, int creat);
Pavel Emelyanovfa86d322008-03-24 14:48:59 -0700220extern struct pneigh_entry *__pneigh_lookup(struct neigh_table *tbl,
221 struct net *net,
222 const void *key,
223 struct net_device *dev);
Eric W. Biederman426b5302008-01-24 00:13:18 -0800224extern int pneigh_delete(struct neigh_table *tbl, struct net *net, const void *key, struct net_device *dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700225
YOSHIFUJI Hideaki57da52c2008-03-26 03:49:59 +0900226static inline
227struct net *pneigh_net(const struct pneigh_entry *pneigh)
228{
Eric Dumazete42ea982008-11-12 00:54:54 -0800229 return read_pnet(&pneigh->net);
YOSHIFUJI Hideaki57da52c2008-03-26 03:49:59 +0900230}
231
Linus Torvalds1da177e2005-04-16 15:20:36 -0700232extern void neigh_app_ns(struct neighbour *n);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700233extern void neigh_for_each(struct neigh_table *tbl, void (*cb)(struct neighbour *, void *), void *cookie);
234extern void __neigh_for_each_release(struct neigh_table *tbl, int (*cb)(struct neighbour *));
235extern void pneigh_for_each(struct neigh_table *tbl, void (*cb)(struct pneigh_entry *));
236
237struct neigh_seq_state {
Denis V. Lunev42508462008-01-10 03:53:12 -0800238 struct seq_net_private p;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700239 struct neigh_table *tbl;
240 void *(*neigh_sub_iter)(struct neigh_seq_state *state,
241 struct neighbour *n, loff_t *pos);
242 unsigned int bucket;
243 unsigned int flags;
244#define NEIGH_SEQ_NEIGH_ONLY 0x00000001
245#define NEIGH_SEQ_IS_PNEIGH 0x00000002
246#define NEIGH_SEQ_SKIP_NOARP 0x00000004
247};
248extern void *neigh_seq_start(struct seq_file *, loff_t *, struct neigh_table *, unsigned int);
249extern void *neigh_seq_next(struct seq_file *, void *, loff_t *);
250extern void neigh_seq_stop(struct seq_file *, void *);
251
252extern int neigh_sysctl_register(struct net_device *dev,
253 struct neigh_parms *p,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700254 char *p_name,
Eric W. Biedermanf8572d82009-11-05 13:32:03 -0800255 proc_handler *proc_handler);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700256extern void neigh_sysctl_unregister(struct neigh_parms *p);
257
258static inline void __neigh_parms_put(struct neigh_parms *parms)
259{
260 atomic_dec(&parms->refcnt);
261}
262
Linus Torvalds1da177e2005-04-16 15:20:36 -0700263static 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
273static inline void neigh_release(struct neighbour *neigh)
274{
275 if (atomic_dec_and_test(&neigh->refcnt))
276 neigh_destroy(neigh);
277}
278
279static 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
288static inline void neigh_confirm(struct neighbour *neigh)
289{
290 if (neigh)
291 neigh->confirmed = jiffies;
292}
293
Linus Torvalds1da177e2005-04-16 15:20:36 -0700294static inline int neigh_event_send(struct neighbour *neigh, struct sk_buff *skb)
295{
296 neigh->used = jiffies;
297 if (!(neigh->nud_state&(NUD_CONNECTED|NUD_DELAY|NUD_PROBE)))
298 return __neigh_event_send(neigh, skb);
299 return 0;
300}
301
Stephen Hemminger3644f0c2006-12-07 15:08:17 -0800302static inline int neigh_hh_output(struct hh_cache *hh, struct sk_buff *skb)
303{
304 unsigned seq;
305 int hh_len;
306
307 do {
308 int hh_alen;
309
310 seq = read_seqbegin(&hh->hh_lock);
311 hh_len = hh->hh_len;
312 hh_alen = HH_DATA_ALIGN(hh_len);
313 memcpy(skb->data - hh_alen, hh->hh_data, hh_alen);
314 } while (read_seqretry(&hh->hh_lock, seq));
315
316 skb_push(skb, hh_len);
317 return hh->hh_output(skb);
318}
319
Linus Torvalds1da177e2005-04-16 15:20:36 -0700320static inline struct neighbour *
321__neigh_lookup(struct neigh_table *tbl, const void *pkey, struct net_device *dev, int creat)
322{
323 struct neighbour *n = neigh_lookup(tbl, pkey, dev);
324
325 if (n || !creat)
326 return n;
327
328 n = neigh_create(tbl, pkey, dev);
329 return IS_ERR(n) ? NULL : n;
330}
331
332static inline struct neighbour *
333__neigh_lookup_errno(struct neigh_table *tbl, const void *pkey,
334 struct net_device *dev)
335{
336 struct neighbour *n = neigh_lookup(tbl, pkey, dev);
337
338 if (n)
339 return n;
340
341 return neigh_create(tbl, pkey, dev);
342}
343
Patrick McHardya61bbcf2005-08-14 17:24:31 -0700344struct neighbour_cb {
345 unsigned long sched_next;
346 unsigned int flags;
347};
348
349#define LOCALLY_ENQUEUED 0x1
350
351#define NEIGH_CB(skb) ((struct neighbour_cb *)(skb)->cb)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700352
353#endif