blob: 74c4b6ff8a5c52b8c3cd8af39d40c07ef2b97de4 [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>
27
28#define NUD_IN_TIMER (NUD_INCOMPLETE|NUD_REACHABLE|NUD_DELAY|NUD_PROBE)
29#define NUD_VALID (NUD_PERMANENT|NUD_NOARP|NUD_REACHABLE|NUD_PROBE|NUD_STALE|NUD_DELAY)
30#define NUD_CONNECTED (NUD_PERMANENT|NUD_NOARP|NUD_REACHABLE)
31
32struct neighbour;
33
34struct neigh_parms
35{
Thomas Grafc7fb64d2005-06-18 22:50:55 -070036 struct net_device *dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -070037 struct neigh_parms *next;
38 int (*neigh_setup)(struct neighbour *);
Michael S. Tsirkinc5ecd622006-03-20 22:25:41 -080039 void (*neigh_destructor)(struct neighbour *);
Linus Torvalds1da177e2005-04-16 15:20:36 -070040 struct neigh_table *tbl;
Linus Torvalds1da177e2005-04-16 15:20:36 -070041
42 void *sysctl_table;
43
44 int dead;
45 atomic_t refcnt;
46 struct rcu_head rcu_head;
47
48 int base_reachable_time;
49 int retrans_time;
50 int gc_staletime;
51 int reachable_time;
52 int delay_probe_time;
53
54 int queue_len;
55 int ucast_probes;
56 int app_probes;
57 int mcast_probes;
58 int anycast_delay;
59 int proxy_delay;
60 int proxy_qlen;
61 int locktime;
62};
63
64struct neigh_statistics
65{
66 unsigned long allocs; /* number of allocated neighs */
67 unsigned long destroys; /* number of destroyed neighs */
68 unsigned long hash_grows; /* number of hash resizes */
69
70 unsigned long res_failed; /* nomber of failed resolutions */
71
72 unsigned long lookups; /* number of lookups */
73 unsigned long hits; /* number of hits (among lookups) */
74
75 unsigned long rcv_probes_mcast; /* number of received mcast ipv6 */
76 unsigned long rcv_probes_ucast; /* number of received ucast ipv6 */
77
78 unsigned long periodic_gc_runs; /* number of periodic GC runs */
79 unsigned long forced_gc_runs; /* number of forced GC runs */
80};
81
82#define NEIGH_CACHE_STAT_INC(tbl, field) \
83 do { \
84 preempt_disable(); \
85 (per_cpu_ptr((tbl)->stats, smp_processor_id())->field)++; \
86 preempt_enable(); \
87 } while (0)
88
89struct neighbour
90{
91 struct neighbour *next;
92 struct neigh_table *tbl;
93 struct neigh_parms *parms;
94 struct net_device *dev;
95 unsigned long used;
96 unsigned long confirmed;
97 unsigned long updated;
98 __u8 flags;
99 __u8 nud_state;
100 __u8 type;
101 __u8 dead;
102 atomic_t probes;
103 rwlock_t lock;
104 unsigned char ha[(MAX_ADDR_LEN+sizeof(unsigned long)-1)&~(sizeof(unsigned long)-1)];
105 struct hh_cache *hh;
106 atomic_t refcnt;
107 int (*output)(struct sk_buff *skb);
108 struct sk_buff_head arp_queue;
109 struct timer_list timer;
110 struct neigh_ops *ops;
111 u8 primary_key[0];
112};
113
114struct neigh_ops
115{
116 int family;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700117 void (*solicit)(struct neighbour *, struct sk_buff*);
118 void (*error_report)(struct neighbour *, struct sk_buff*);
119 int (*output)(struct sk_buff*);
120 int (*connected_output)(struct sk_buff*);
121 int (*hh_output)(struct sk_buff*);
122 int (*queue_xmit)(struct sk_buff*);
123};
124
125struct pneigh_entry
126{
127 struct pneigh_entry *next;
128 struct net_device *dev;
129 u8 key[0];
130};
131
132/*
133 * neighbour table manipulation
134 */
135
136
137struct neigh_table
138{
139 struct neigh_table *next;
140 int family;
141 int entry_size;
142 int key_len;
143 __u32 (*hash)(const void *pkey, const struct net_device *);
144 int (*constructor)(struct neighbour *);
145 int (*pconstructor)(struct pneigh_entry *);
146 void (*pdestructor)(struct pneigh_entry *);
147 void (*proxy_redo)(struct sk_buff *skb);
148 char *id;
149 struct neigh_parms parms;
150 /* HACK. gc_* shoul follow parms without a gap! */
151 int gc_interval;
152 int gc_thresh1;
153 int gc_thresh2;
154 int gc_thresh3;
155 unsigned long last_flush;
156 struct timer_list gc_timer;
157 struct timer_list proxy_timer;
158 struct sk_buff_head proxy_queue;
159 atomic_t entries;
160 rwlock_t lock;
161 unsigned long last_rand;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700162 kmem_cache_t *kmem_cachep;
163 struct neigh_statistics *stats;
164 struct neighbour **hash_buckets;
165 unsigned int hash_mask;
166 __u32 hash_rnd;
167 unsigned int hash_chain_gc;
168 struct pneigh_entry **phash_buckets;
169#ifdef CONFIG_PROC_FS
170 struct proc_dir_entry *pde;
171#endif
172};
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,
188 const void *pkey);
189extern struct neighbour * neigh_create(struct neigh_table *tbl,
190 const void *pkey,
191 struct net_device *dev);
192extern void neigh_destroy(struct neighbour *neigh);
193extern int __neigh_event_send(struct neighbour *neigh, struct sk_buff *skb);
194extern int neigh_update(struct neighbour *neigh, const u8 *lladdr, u8 new,
195 u32 flags);
196extern void neigh_changeaddr(struct neigh_table *tbl, struct net_device *dev);
197extern int neigh_ifdown(struct neigh_table *tbl, struct net_device *dev);
198extern int neigh_resolve_output(struct sk_buff *skb);
199extern int neigh_connected_output(struct sk_buff *skb);
200extern int neigh_compat_output(struct sk_buff *skb);
201extern struct neighbour *neigh_event_ns(struct neigh_table *tbl,
202 u8 *lladdr, void *saddr,
203 struct net_device *dev);
204
205extern struct neigh_parms *neigh_parms_alloc(struct net_device *dev, struct neigh_table *tbl);
206extern void neigh_parms_release(struct neigh_table *tbl, struct neigh_parms *parms);
207extern void neigh_parms_destroy(struct neigh_parms *parms);
208extern unsigned long neigh_rand_reach_time(unsigned long base);
209
210extern void pneigh_enqueue(struct neigh_table *tbl, struct neigh_parms *p,
211 struct sk_buff *skb);
212extern struct pneigh_entry *pneigh_lookup(struct neigh_table *tbl, const void *key, struct net_device *dev, int creat);
213extern int pneigh_delete(struct neigh_table *tbl, const void *key, struct net_device *dev);
214
215struct netlink_callback;
216struct nlmsghdr;
217extern int neigh_dump_info(struct sk_buff *skb, struct netlink_callback *cb);
218extern int neigh_add(struct sk_buff *skb, struct nlmsghdr *nlh, void *arg);
219extern int neigh_delete(struct sk_buff *skb, struct nlmsghdr *nlh, void *arg);
220extern void neigh_app_ns(struct neighbour *n);
221
Thomas Grafc7fb64d2005-06-18 22:50:55 -0700222extern int neightbl_dump_info(struct sk_buff *skb, struct netlink_callback *cb);
223extern int neightbl_set(struct sk_buff *skb, struct nlmsghdr *nlh, void *arg);
224
Linus Torvalds1da177e2005-04-16 15:20:36 -0700225extern void neigh_for_each(struct neigh_table *tbl, void (*cb)(struct neighbour *, void *), void *cookie);
226extern void __neigh_for_each_release(struct neigh_table *tbl, int (*cb)(struct neighbour *));
227extern void pneigh_for_each(struct neigh_table *tbl, void (*cb)(struct pneigh_entry *));
228
229struct neigh_seq_state {
230 struct neigh_table *tbl;
231 void *(*neigh_sub_iter)(struct neigh_seq_state *state,
232 struct neighbour *n, loff_t *pos);
233 unsigned int bucket;
234 unsigned int flags;
235#define NEIGH_SEQ_NEIGH_ONLY 0x00000001
236#define NEIGH_SEQ_IS_PNEIGH 0x00000002
237#define NEIGH_SEQ_SKIP_NOARP 0x00000004
238};
239extern void *neigh_seq_start(struct seq_file *, loff_t *, struct neigh_table *, unsigned int);
240extern void *neigh_seq_next(struct seq_file *, void *, loff_t *);
241extern void neigh_seq_stop(struct seq_file *, void *);
242
243extern int neigh_sysctl_register(struct net_device *dev,
244 struct neigh_parms *p,
245 int p_id, int pdev_id,
246 char *p_name,
247 proc_handler *proc_handler,
248 ctl_handler *strategy);
249extern void neigh_sysctl_unregister(struct neigh_parms *p);
250
251static inline void __neigh_parms_put(struct neigh_parms *parms)
252{
253 atomic_dec(&parms->refcnt);
254}
255
256static inline void neigh_parms_put(struct neigh_parms *parms)
257{
258 if (atomic_dec_and_test(&parms->refcnt))
259 neigh_parms_destroy(parms);
260}
261
262static inline struct neigh_parms *neigh_parms_clone(struct neigh_parms *parms)
263{
264 atomic_inc(&parms->refcnt);
265 return parms;
266}
267
268/*
269 * Neighbour references
270 */
271
272static inline void neigh_release(struct neighbour *neigh)
273{
274 if (atomic_dec_and_test(&neigh->refcnt))
275 neigh_destroy(neigh);
276}
277
278static inline struct neighbour * neigh_clone(struct neighbour *neigh)
279{
280 if (neigh)
281 atomic_inc(&neigh->refcnt);
282 return neigh;
283}
284
285#define neigh_hold(n) atomic_inc(&(n)->refcnt)
286
287static inline void neigh_confirm(struct neighbour *neigh)
288{
289 if (neigh)
290 neigh->confirmed = jiffies;
291}
292
293static inline int neigh_is_connected(struct neighbour *neigh)
294{
295 return neigh->nud_state&NUD_CONNECTED;
296}
297
298static inline int neigh_is_valid(struct neighbour *neigh)
299{
300 return neigh->nud_state&NUD_VALID;
301}
302
303static inline int neigh_event_send(struct neighbour *neigh, struct sk_buff *skb)
304{
305 neigh->used = jiffies;
306 if (!(neigh->nud_state&(NUD_CONNECTED|NUD_DELAY|NUD_PROBE)))
307 return __neigh_event_send(neigh, skb);
308 return 0;
309}
310
311static inline struct neighbour *
312__neigh_lookup(struct neigh_table *tbl, const void *pkey, struct net_device *dev, int creat)
313{
314 struct neighbour *n = neigh_lookup(tbl, pkey, dev);
315
316 if (n || !creat)
317 return n;
318
319 n = neigh_create(tbl, pkey, dev);
320 return IS_ERR(n) ? NULL : n;
321}
322
323static inline struct neighbour *
324__neigh_lookup_errno(struct neigh_table *tbl, const void *pkey,
325 struct net_device *dev)
326{
327 struct neighbour *n = neigh_lookup(tbl, pkey, dev);
328
329 if (n)
330 return n;
331
332 return neigh_create(tbl, pkey, dev);
333}
334
Patrick McHardya61bbcf2005-08-14 17:24:31 -0700335struct neighbour_cb {
336 unsigned long sched_next;
337 unsigned int flags;
338};
339
340#define LOCALLY_ENQUEUED 0x1
341
342#define NEIGH_CB(skb) ((struct neighbour_cb *)(skb)->cb)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700343
344#endif