blob: 344d8988842a527fbec3bffc674cda865f67b15c [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
Arun Sharma600634972011-07-26 16:09:06 -070019#include <linux/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;
David S. Miller447f2192011-12-19 15:04:41 -050046 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
Eric Dumazet8b5c1712011-11-09 12:07:14 +000062 int queue_len_bytes;
Linus Torvalds1da177e2005-04-16 15:20:36 -070063 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 {
Eric Dumazet767e97e2010-10-06 17:49:21 -070094 struct neighbour __rcu *next;
Linus Torvalds1da177e2005-04-16 15:20:36 -070095 struct neigh_table *tbl;
96 struct neigh_parms *parms;
Linus Torvalds1da177e2005-04-16 15:20:36 -070097 unsigned long confirmed;
98 unsigned long updated;
Eric Dumazet46b13fc2010-11-11 06:57:19 +000099 rwlock_t lock;
Eric Dumazet367e5e32010-09-30 05:36:29 +0000100 atomic_t refcnt;
Eric Dumazete37ef962010-10-11 12:20:54 +0000101 struct sk_buff_head arp_queue;
Eric Dumazet8b5c1712011-11-09 12:07:14 +0000102 unsigned int arp_queue_len_bytes;
Eric Dumazete37ef962010-10-11 12:20:54 +0000103 struct timer_list timer;
104 unsigned long used;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700105 atomic_t probes;
Eric Dumazet46b13fc2010-11-11 06:57:19 +0000106 __u8 flags;
107 __u8 nud_state;
108 __u8 type;
109 __u8 dead;
Eric Dumazet0ed8ddf2010-10-07 10:44:07 +0000110 seqlock_t ha_lock;
Stephen Hemmingerd9244242006-08-10 23:03:23 -0700111 unsigned char ha[ALIGN(MAX_ADDR_LEN, sizeof(unsigned long))];
David S. Millerf6b72b62011-07-14 07:53:20 -0700112 struct hh_cache hh;
David S. Miller8f40b162011-07-17 13:34:11 -0700113 int (*output)(struct neighbour *, struct sk_buff *);
Stephen Hemminger89d69d22009-09-01 11:13:19 +0000114 const struct neigh_ops *ops;
Eric Dumazet767e97e2010-10-06 17:49:21 -0700115 struct rcu_head rcu;
Eric Dumazete37ef962010-10-11 12:20:54 +0000116 struct net_device *dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700117 u8 primary_key[0];
118};
119
Eric Dumazetfd2c3ef2009-11-03 03:26:03 +0000120struct neigh_ops {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700121 int family;
David S. Miller8f40b162011-07-17 13:34:11 -0700122 void (*solicit)(struct neighbour *, struct sk_buff *);
123 void (*error_report)(struct neighbour *, struct sk_buff *);
124 int (*output)(struct neighbour *, struct sk_buff *);
125 int (*connected_output)(struct neighbour *, struct sk_buff *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700126};
127
Eric Dumazetfd2c3ef2009-11-03 03:26:03 +0000128struct pneigh_entry {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700129 struct pneigh_entry *next;
YOSHIFUJI Hideaki57da52c2008-03-26 03:49:59 +0900130#ifdef CONFIG_NET_NS
Eric W. Biederman426b5302008-01-24 00:13:18 -0800131 struct net *net;
YOSHIFUJI Hideaki57da52c2008-03-26 03:49:59 +0900132#endif
Eric W. Biederman426b5302008-01-24 00:13:18 -0800133 struct net_device *dev;
Ville Nuorvala62dd9312006-09-22 14:43:19 -0700134 u8 flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700135 u8 key[0];
136};
137
138/*
139 * neighbour table manipulation
140 */
141
David S. Miller2c2aba62011-12-28 15:06:58 -0500142#define NEIGH_NUM_HASH_RND 4
143
Eric Dumazetd6bf7812010-10-04 06:15:44 +0000144struct neigh_hash_table {
Eric Dumazet767e97e2010-10-06 17:49:21 -0700145 struct neighbour __rcu **hash_buckets;
David S. Millercd089332011-07-11 01:28:12 -0700146 unsigned int hash_shift;
David S. Miller2c2aba62011-12-28 15:06:58 -0500147 __u32 hash_rnd[NEIGH_NUM_HASH_RND];
Eric Dumazetd6bf7812010-10-04 06:15:44 +0000148 struct rcu_head rcu;
149};
150
Linus Torvalds1da177e2005-04-16 15:20:36 -0700151
Eric Dumazetfd2c3ef2009-11-03 03:26:03 +0000152struct neigh_table {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700153 struct neigh_table *next;
154 int family;
155 int entry_size;
156 int key_len;
Eric Dumazetd6bf7812010-10-04 06:15:44 +0000157 __u32 (*hash)(const void *pkey,
158 const struct net_device *dev,
David S. Miller2c2aba62011-12-28 15:06:58 -0500159 __u32 *hash_rnd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700160 int (*constructor)(struct neighbour *);
161 int (*pconstructor)(struct pneigh_entry *);
162 void (*pdestructor)(struct pneigh_entry *);
163 void (*proxy_redo)(struct sk_buff *skb);
164 char *id;
165 struct neigh_parms parms;
Kulikov Vasiliy787a3442010-06-30 06:08:15 +0000166 /* HACK. gc_* should follow parms without a gap! */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700167 int gc_interval;
168 int gc_thresh1;
169 int gc_thresh2;
170 int gc_thresh3;
171 unsigned long last_flush;
Eric Dumazete4c4e442009-07-30 03:15:07 +0000172 struct delayed_work gc_work;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700173 struct timer_list proxy_timer;
174 struct sk_buff_head proxy_queue;
175 atomic_t entries;
176 rwlock_t lock;
177 unsigned long last_rand;
Tejun Heo7d720c32010-02-16 15:20:26 +0000178 struct neigh_statistics __percpu *stats;
Eric Dumazetd6bf7812010-10-04 06:15:44 +0000179 struct neigh_hash_table __rcu *nht;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700180 struct pneigh_entry **phash_buckets;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700181};
182
David Miller1026fec2011-07-25 00:01:17 +0000183#define NEIGH_PRIV_ALIGN sizeof(long long)
184
185static inline void *neighbour_priv(const struct neighbour *n)
186{
187 return (char *)n + ALIGN(sizeof(*n) + n->tbl->key_len, NEIGH_PRIV_ALIGN);
188}
189
Linus Torvalds1da177e2005-04-16 15:20:36 -0700190/* flags for neigh_update() */
191#define NEIGH_UPDATE_F_OVERRIDE 0x00000001
192#define NEIGH_UPDATE_F_WEAK_OVERRIDE 0x00000002
193#define NEIGH_UPDATE_F_OVERRIDE_ISROUTER 0x00000004
194#define NEIGH_UPDATE_F_ISROUTER 0x40000000
195#define NEIGH_UPDATE_F_ADMIN 0x80000000
196
197extern void neigh_table_init(struct neigh_table *tbl);
198extern int neigh_table_clear(struct neigh_table *tbl);
199extern struct neighbour * neigh_lookup(struct neigh_table *tbl,
200 const void *pkey,
201 struct net_device *dev);
202extern struct neighbour * neigh_lookup_nodev(struct neigh_table *tbl,
Eric W. Biederman426b5302008-01-24 00:13:18 -0800203 struct net *net,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700204 const void *pkey);
David S. Millera263b302012-07-02 02:02:15 -0700205extern struct neighbour * __neigh_create(struct neigh_table *tbl,
206 const void *pkey,
207 struct net_device *dev,
208 bool want_ref);
209static inline struct neighbour *neigh_create(struct neigh_table *tbl,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700210 const void *pkey,
David S. Millera263b302012-07-02 02:02:15 -0700211 struct net_device *dev)
212{
213 return __neigh_create(tbl, pkey, dev, true);
214}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700215extern void neigh_destroy(struct neighbour *neigh);
216extern int __neigh_event_send(struct neighbour *neigh, struct sk_buff *skb);
217extern int neigh_update(struct neighbour *neigh, const u8 *lladdr, u8 new,
218 u32 flags);
219extern void neigh_changeaddr(struct neigh_table *tbl, struct net_device *dev);
220extern int neigh_ifdown(struct neigh_table *tbl, struct net_device *dev);
David S. Miller8f40b162011-07-17 13:34:11 -0700221extern int neigh_resolve_output(struct neighbour *neigh, struct sk_buff *skb);
222extern int neigh_connected_output(struct neighbour *neigh, struct sk_buff *skb);
223extern int neigh_compat_output(struct neighbour *neigh, struct sk_buff *skb);
224extern int neigh_direct_output(struct neighbour *neigh, struct sk_buff *skb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700225extern struct neighbour *neigh_event_ns(struct neigh_table *tbl,
226 u8 *lladdr, void *saddr,
227 struct net_device *dev);
228
229extern struct neigh_parms *neigh_parms_alloc(struct net_device *dev, struct neigh_table *tbl);
230extern void neigh_parms_release(struct neigh_table *tbl, struct neigh_parms *parms);
YOSHIFUJI Hideaki57da52c2008-03-26 03:49:59 +0900231
232static inline
233struct net *neigh_parms_net(const struct neigh_parms *parms)
234{
Eric Dumazete42ea982008-11-12 00:54:54 -0800235 return read_pnet(&parms->net);
YOSHIFUJI Hideaki57da52c2008-03-26 03:49:59 +0900236}
237
Linus Torvalds1da177e2005-04-16 15:20:36 -0700238extern unsigned long neigh_rand_reach_time(unsigned long base);
239
240extern void pneigh_enqueue(struct neigh_table *tbl, struct neigh_parms *p,
241 struct sk_buff *skb);
Eric W. Biederman426b5302008-01-24 00:13:18 -0800242extern 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 -0700243extern struct pneigh_entry *__pneigh_lookup(struct neigh_table *tbl,
244 struct net *net,
245 const void *key,
246 struct net_device *dev);
Eric W. Biederman426b5302008-01-24 00:13:18 -0800247extern int pneigh_delete(struct neigh_table *tbl, struct net *net, const void *key, struct net_device *dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700248
YOSHIFUJI Hideaki57da52c2008-03-26 03:49:59 +0900249static inline
250struct net *pneigh_net(const struct pneigh_entry *pneigh)
251{
Eric Dumazete42ea982008-11-12 00:54:54 -0800252 return read_pnet(&pneigh->net);
YOSHIFUJI Hideaki57da52c2008-03-26 03:49:59 +0900253}
254
Linus Torvalds1da177e2005-04-16 15:20:36 -0700255extern void neigh_app_ns(struct neighbour *n);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700256extern void neigh_for_each(struct neigh_table *tbl, void (*cb)(struct neighbour *, void *), void *cookie);
257extern void __neigh_for_each_release(struct neigh_table *tbl, int (*cb)(struct neighbour *));
258extern void pneigh_for_each(struct neigh_table *tbl, void (*cb)(struct pneigh_entry *));
259
260struct neigh_seq_state {
Denis V. Lunev42508462008-01-10 03:53:12 -0800261 struct seq_net_private p;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700262 struct neigh_table *tbl;
Eric Dumazetd6bf7812010-10-04 06:15:44 +0000263 struct neigh_hash_table *nht;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700264 void *(*neigh_sub_iter)(struct neigh_seq_state *state,
265 struct neighbour *n, loff_t *pos);
266 unsigned int bucket;
267 unsigned int flags;
268#define NEIGH_SEQ_NEIGH_ONLY 0x00000001
269#define NEIGH_SEQ_IS_PNEIGH 0x00000002
270#define NEIGH_SEQ_SKIP_NOARP 0x00000004
271};
272extern void *neigh_seq_start(struct seq_file *, loff_t *, struct neigh_table *, unsigned int);
273extern void *neigh_seq_next(struct seq_file *, void *, loff_t *);
274extern void neigh_seq_stop(struct seq_file *, void *);
275
276extern int neigh_sysctl_register(struct net_device *dev,
277 struct neigh_parms *p,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700278 char *p_name,
Eric W. Biedermanf8572d82009-11-05 13:32:03 -0800279 proc_handler *proc_handler);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700280extern void neigh_sysctl_unregister(struct neigh_parms *p);
281
282static inline void __neigh_parms_put(struct neigh_parms *parms)
283{
284 atomic_dec(&parms->refcnt);
285}
286
Linus Torvalds1da177e2005-04-16 15:20:36 -0700287static inline struct neigh_parms *neigh_parms_clone(struct neigh_parms *parms)
288{
289 atomic_inc(&parms->refcnt);
290 return parms;
291}
292
293/*
294 * Neighbour references
295 */
296
297static inline void neigh_release(struct neighbour *neigh)
298{
299 if (atomic_dec_and_test(&neigh->refcnt))
300 neigh_destroy(neigh);
301}
302
303static inline struct neighbour * neigh_clone(struct neighbour *neigh)
304{
305 if (neigh)
306 atomic_inc(&neigh->refcnt);
307 return neigh;
308}
309
310#define neigh_hold(n) atomic_inc(&(n)->refcnt)
311
Linus Torvalds1da177e2005-04-16 15:20:36 -0700312static inline int neigh_event_send(struct neighbour *neigh, struct sk_buff *skb)
313{
Tetsuo Handaef22b7b2010-11-18 09:40:04 -0800314 unsigned long now = jiffies;
Eric Dumazet0ed8ddf2010-10-07 10:44:07 +0000315
316 if (neigh->used != now)
317 neigh->used = now;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700318 if (!(neigh->nud_state&(NUD_CONNECTED|NUD_DELAY|NUD_PROBE)))
319 return __neigh_event_send(neigh, skb);
320 return 0;
321}
322
Bart De Schuymere179e632010-04-15 12:26:39 +0200323#ifdef CONFIG_BRIDGE_NETFILTER
324static inline int neigh_hh_bridge(struct hh_cache *hh, struct sk_buff *skb)
325{
Eric Dumazet95c96172012-04-15 05:58:06 +0000326 unsigned int seq, hh_alen;
Bart De Schuymere179e632010-04-15 12:26:39 +0200327
328 do {
329 seq = read_seqbegin(&hh->hh_lock);
330 hh_alen = HH_DATA_ALIGN(ETH_HLEN);
331 memcpy(skb->data - hh_alen, hh->hh_data, ETH_ALEN + hh_alen - ETH_HLEN);
332 } while (read_seqretry(&hh->hh_lock, seq));
333 return 0;
334}
335#endif
336
Stephen Hemminger3644f0c2006-12-07 15:08:17 -0800337static inline int neigh_hh_output(struct hh_cache *hh, struct sk_buff *skb)
338{
Eric Dumazet95c96172012-04-15 05:58:06 +0000339 unsigned int seq;
Stephen Hemminger3644f0c2006-12-07 15:08:17 -0800340 int hh_len;
341
342 do {
343 int hh_alen;
344
345 seq = read_seqbegin(&hh->hh_lock);
346 hh_len = hh->hh_len;
347 hh_alen = HH_DATA_ALIGN(hh_len);
348 memcpy(skb->data - hh_alen, hh->hh_data, hh_alen);
349 } while (read_seqretry(&hh->hh_lock, seq));
350
351 skb_push(skb, hh_len);
David S. Millerb23b5452011-07-16 17:45:02 -0700352 return dev_queue_xmit(skb);
Stephen Hemminger3644f0c2006-12-07 15:08:17 -0800353}
354
Linus Torvalds1da177e2005-04-16 15:20:36 -0700355static inline struct neighbour *
356__neigh_lookup(struct neigh_table *tbl, const void *pkey, struct net_device *dev, int creat)
357{
358 struct neighbour *n = neigh_lookup(tbl, pkey, dev);
359
360 if (n || !creat)
361 return n;
362
363 n = neigh_create(tbl, pkey, dev);
364 return IS_ERR(n) ? NULL : n;
365}
366
367static inline struct neighbour *
368__neigh_lookup_errno(struct neigh_table *tbl, const void *pkey,
369 struct net_device *dev)
370{
371 struct neighbour *n = neigh_lookup(tbl, pkey, dev);
372
373 if (n)
374 return n;
375
376 return neigh_create(tbl, pkey, dev);
377}
378
Patrick McHardya61bbcf2005-08-14 17:24:31 -0700379struct neighbour_cb {
380 unsigned long sched_next;
381 unsigned int flags;
382};
383
384#define LOCALLY_ENQUEUED 0x1
385
386#define NEIGH_CB(skb) ((struct neighbour_cb *)(skb)->cb)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700387
Eric Dumazet0ed8ddf2010-10-07 10:44:07 +0000388static inline void neigh_ha_snapshot(char *dst, const struct neighbour *n,
389 const struct net_device *dev)
390{
391 unsigned int seq;
392
393 do {
394 seq = read_seqbegin(&n->ha_lock);
395 memcpy(dst, n->ha, dev->addr_len);
396 } while (read_seqretry(&n->ha_lock, seq));
397}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700398#endif