ipv4: fix checkpatch errors
[linux-2.6-block.git] / include / net / neighbour.h
CommitLineData
1da177e4
LT
1#ifndef _NET_NEIGHBOUR_H
2#define _NET_NEIGHBOUR_H
3
9067c722
TG
4#include <linux/neighbour.h>
5
1da177e4
LT
6/*
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
60063497 19#include <linux/atomic.h>
1da177e4 20#include <linux/netdevice.h>
14c85021 21#include <linux/skbuff.h>
1da177e4
LT
22#include <linux/rcupdate.h>
23#include <linux/seq_file.h>
24
25#include <linux/err.h>
26#include <linux/sysctl.h>
e4c4e448 27#include <linux/workqueue.h>
c8822a4e 28#include <net/rtnetlink.h>
1da177e4 29
39971554
PE
30/*
31 * NUD stands for "neighbor unreachability detection"
32 */
33
1da177e4
LT
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)
37
38struct neighbour;
39
fd2c3ef7 40struct neigh_parms {
57da52c1 41#ifdef CONFIG_NET_NS
426b5303 42 struct net *net;
57da52c1 43#endif
c7fb64db 44 struct net_device *dev;
1da177e4 45 struct neigh_parms *next;
447f2191 46 int (*neigh_setup)(struct neighbour *);
ecbb4169 47 void (*neigh_cleanup)(struct neighbour *);
1da177e4 48 struct neigh_table *tbl;
1da177e4
LT
49
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
8b5c171b 62 int queue_len_bytes;
1da177e4
LT
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
fd2c3ef7 72struct neigh_statistics {
1da177e4
LT
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 */
76
9a6d276e 77 unsigned long res_failed; /* number of failed resolutions */
1da177e4
LT
78
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 */
9a6d276e
NH
87
88 unsigned long unres_discards; /* number of unresolved drops */
1da177e4
LT
89};
90
4ea7334b 91#define NEIGH_CACHE_STAT_INC(tbl, field) this_cpu_inc((tbl)->stats->field)
1da177e4 92
fd2c3ef7 93struct neighbour {
767e97e1 94 struct neighbour __rcu *next;
1da177e4
LT
95 struct neigh_table *tbl;
96 struct neigh_parms *parms;
1da177e4
LT
97 unsigned long confirmed;
98 unsigned long updated;
46b13fc5 99 rwlock_t lock;
367e5e37 100 atomic_t refcnt;
e37ef961 101 struct sk_buff_head arp_queue;
8b5c171b 102 unsigned int arp_queue_len_bytes;
e37ef961
ED
103 struct timer_list timer;
104 unsigned long used;
1da177e4 105 atomic_t probes;
46b13fc5
ED
106 __u8 flags;
107 __u8 nud_state;
108 __u8 type;
109 __u8 dead;
0ed8ddf4 110 seqlock_t ha_lock;
d924424a 111 unsigned char ha[ALIGN(MAX_ADDR_LEN, sizeof(unsigned long))];
f6b72b62 112 struct hh_cache hh;
8f40b161 113 int (*output)(struct neighbour *, struct sk_buff *);
89d69d2b 114 const struct neigh_ops *ops;
767e97e1 115 struct rcu_head rcu;
e37ef961 116 struct net_device *dev;
1da177e4
LT
117 u8 primary_key[0];
118};
119
fd2c3ef7 120struct neigh_ops {
1da177e4 121 int family;
8f40b161
DM
122 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 *);
1da177e4
LT
126};
127
fd2c3ef7 128struct pneigh_entry {
1da177e4 129 struct pneigh_entry *next;
57da52c1 130#ifdef CONFIG_NET_NS
426b5303 131 struct net *net;
57da52c1 132#endif
426b5303 133 struct net_device *dev;
62dd9318 134 u8 flags;
1da177e4
LT
135 u8 key[0];
136};
137
138/*
139 * neighbour table manipulation
140 */
141
2c2aba6c
DM
142#define NEIGH_NUM_HASH_RND 4
143
d6bf7817 144struct neigh_hash_table {
767e97e1 145 struct neighbour __rcu **hash_buckets;
cd089336 146 unsigned int hash_shift;
2c2aba6c 147 __u32 hash_rnd[NEIGH_NUM_HASH_RND];
d6bf7817
ED
148 struct rcu_head rcu;
149};
150
1da177e4 151
fd2c3ef7 152struct neigh_table {
1da177e4
LT
153 struct neigh_table *next;
154 int family;
155 int entry_size;
156 int key_len;
d6bf7817
ED
157 __u32 (*hash)(const void *pkey,
158 const struct net_device *dev,
2c2aba6c 159 __u32 *hash_rnd);
1da177e4
LT
160 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;
787a3445 166 /* HACK. gc_* should follow parms without a gap! */
1da177e4
LT
167 int gc_interval;
168 int gc_thresh1;
169 int gc_thresh2;
170 int gc_thresh3;
171 unsigned long last_flush;
e4c4e448 172 struct delayed_work gc_work;
1da177e4
LT
173 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;
7d720c3e 178 struct neigh_statistics __percpu *stats;
d6bf7817 179 struct neigh_hash_table __rcu *nht;
1da177e4 180 struct pneigh_entry **phash_buckets;
1da177e4
LT
181};
182
1026fec8
DM
183#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
1da177e4
LT
190/* 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,
426b5303 203 struct net *net,
1da177e4
LT
204 const void *pkey);
205extern struct neighbour * neigh_create(struct neigh_table *tbl,
206 const void *pkey,
207 struct net_device *dev);
208extern void neigh_destroy(struct neighbour *neigh);
209extern int __neigh_event_send(struct neighbour *neigh, struct sk_buff *skb);
210extern int neigh_update(struct neighbour *neigh, const u8 *lladdr, u8 new,
211 u32 flags);
212extern void neigh_changeaddr(struct neigh_table *tbl, struct net_device *dev);
213extern int neigh_ifdown(struct neigh_table *tbl, struct net_device *dev);
8f40b161
DM
214extern int neigh_resolve_output(struct neighbour *neigh, struct sk_buff *skb);
215extern int neigh_connected_output(struct neighbour *neigh, struct sk_buff *skb);
216extern int neigh_compat_output(struct neighbour *neigh, struct sk_buff *skb);
217extern int neigh_direct_output(struct neighbour *neigh, struct sk_buff *skb);
1da177e4
LT
218extern struct neighbour *neigh_event_ns(struct neigh_table *tbl,
219 u8 *lladdr, void *saddr,
220 struct net_device *dev);
221
222extern struct neigh_parms *neigh_parms_alloc(struct net_device *dev, struct neigh_table *tbl);
223extern void neigh_parms_release(struct neigh_table *tbl, struct neigh_parms *parms);
57da52c1
YH
224
225static inline
226struct net *neigh_parms_net(const struct neigh_parms *parms)
227{
e42ea986 228 return read_pnet(&parms->net);
57da52c1
YH
229}
230
1da177e4
LT
231extern unsigned long neigh_rand_reach_time(unsigned long base);
232
233extern void pneigh_enqueue(struct neigh_table *tbl, struct neigh_parms *p,
234 struct sk_buff *skb);
426b5303 235extern struct pneigh_entry *pneigh_lookup(struct neigh_table *tbl, struct net *net, const void *key, struct net_device *dev, int creat);
fa86d322
PE
236extern struct pneigh_entry *__pneigh_lookup(struct neigh_table *tbl,
237 struct net *net,
238 const void *key,
239 struct net_device *dev);
426b5303 240extern int pneigh_delete(struct neigh_table *tbl, struct net *net, const void *key, struct net_device *dev);
1da177e4 241
57da52c1
YH
242static inline
243struct net *pneigh_net(const struct pneigh_entry *pneigh)
244{
e42ea986 245 return read_pnet(&pneigh->net);
57da52c1
YH
246}
247
1da177e4 248extern void neigh_app_ns(struct neighbour *n);
1da177e4
LT
249extern void neigh_for_each(struct neigh_table *tbl, void (*cb)(struct neighbour *, void *), void *cookie);
250extern void __neigh_for_each_release(struct neigh_table *tbl, int (*cb)(struct neighbour *));
251extern void pneigh_for_each(struct neigh_table *tbl, void (*cb)(struct pneigh_entry *));
252
253struct neigh_seq_state {
42508461 254 struct seq_net_private p;
1da177e4 255 struct neigh_table *tbl;
d6bf7817 256 struct neigh_hash_table *nht;
1da177e4
LT
257 void *(*neigh_sub_iter)(struct neigh_seq_state *state,
258 struct neighbour *n, loff_t *pos);
259 unsigned int bucket;
260 unsigned int flags;
261#define NEIGH_SEQ_NEIGH_ONLY 0x00000001
262#define NEIGH_SEQ_IS_PNEIGH 0x00000002
263#define NEIGH_SEQ_SKIP_NOARP 0x00000004
264};
265extern void *neigh_seq_start(struct seq_file *, loff_t *, struct neigh_table *, unsigned int);
266extern void *neigh_seq_next(struct seq_file *, void *, loff_t *);
267extern void neigh_seq_stop(struct seq_file *, void *);
268
269extern int neigh_sysctl_register(struct net_device *dev,
270 struct neigh_parms *p,
1da177e4 271 char *p_name,
f8572d8f 272 proc_handler *proc_handler);
1da177e4
LT
273extern void neigh_sysctl_unregister(struct neigh_parms *p);
274
275static inline void __neigh_parms_put(struct neigh_parms *parms)
276{
277 atomic_dec(&parms->refcnt);
278}
279
1da177e4
LT
280static inline struct neigh_parms *neigh_parms_clone(struct neigh_parms *parms)
281{
282 atomic_inc(&parms->refcnt);
283 return parms;
284}
285
286/*
287 * Neighbour references
288 */
289
290static inline void neigh_release(struct neighbour *neigh)
291{
292 if (atomic_dec_and_test(&neigh->refcnt))
293 neigh_destroy(neigh);
294}
295
296static inline struct neighbour * neigh_clone(struct neighbour *neigh)
297{
298 if (neigh)
299 atomic_inc(&neigh->refcnt);
300 return neigh;
301}
302
303#define neigh_hold(n) atomic_inc(&(n)->refcnt)
304
305static inline void neigh_confirm(struct neighbour *neigh)
306{
307 if (neigh)
308 neigh->confirmed = jiffies;
309}
310
1da177e4
LT
311static inline int neigh_event_send(struct neighbour *neigh, struct sk_buff *skb)
312{
ef22b7b6 313 unsigned long now = jiffies;
0ed8ddf4
ED
314
315 if (neigh->used != now)
316 neigh->used = now;
1da177e4
LT
317 if (!(neigh->nud_state&(NUD_CONNECTED|NUD_DELAY|NUD_PROBE)))
318 return __neigh_event_send(neigh, skb);
319 return 0;
320}
321
e179e632
BDS
322#ifdef CONFIG_BRIDGE_NETFILTER
323static inline int neigh_hh_bridge(struct hh_cache *hh, struct sk_buff *skb)
324{
325 unsigned seq, hh_alen;
326
327 do {
328 seq = read_seqbegin(&hh->hh_lock);
329 hh_alen = HH_DATA_ALIGN(ETH_HLEN);
330 memcpy(skb->data - hh_alen, hh->hh_data, ETH_ALEN + hh_alen - ETH_HLEN);
331 } while (read_seqretry(&hh->hh_lock, seq));
332 return 0;
333}
334#endif
335
3644f0ce
SH
336static inline int neigh_hh_output(struct hh_cache *hh, struct sk_buff *skb)
337{
338 unsigned seq;
339 int hh_len;
340
341 do {
342 int hh_alen;
343
344 seq = read_seqbegin(&hh->hh_lock);
345 hh_len = hh->hh_len;
346 hh_alen = HH_DATA_ALIGN(hh_len);
347 memcpy(skb->data - hh_alen, hh->hh_data, hh_alen);
348 } while (read_seqretry(&hh->hh_lock, seq));
349
350 skb_push(skb, hh_len);
b23b5455 351 return dev_queue_xmit(skb);
3644f0ce
SH
352}
353
05e3aa09
DM
354static inline int neigh_output(struct neighbour *n, struct sk_buff *skb)
355{
356 struct hh_cache *hh = &n->hh;
b23b5455 357 if ((n->nud_state & NUD_CONNECTED) && hh->hh_len)
05e3aa09
DM
358 return neigh_hh_output(hh, skb);
359 else
8f40b161 360 return n->output(n, skb);
05e3aa09
DM
361}
362
1da177e4
LT
363static inline struct neighbour *
364__neigh_lookup(struct neigh_table *tbl, const void *pkey, struct net_device *dev, int creat)
365{
366 struct neighbour *n = neigh_lookup(tbl, pkey, dev);
367
368 if (n || !creat)
369 return n;
370
371 n = neigh_create(tbl, pkey, dev);
372 return IS_ERR(n) ? NULL : n;
373}
374
375static inline struct neighbour *
376__neigh_lookup_errno(struct neigh_table *tbl, const void *pkey,
377 struct net_device *dev)
378{
379 struct neighbour *n = neigh_lookup(tbl, pkey, dev);
380
381 if (n)
382 return n;
383
384 return neigh_create(tbl, pkey, dev);
385}
386
a61bbcf2
PM
387struct neighbour_cb {
388 unsigned long sched_next;
389 unsigned int flags;
390};
391
392#define LOCALLY_ENQUEUED 0x1
393
394#define NEIGH_CB(skb) ((struct neighbour_cb *)(skb)->cb)
1da177e4 395
0ed8ddf4
ED
396static inline void neigh_ha_snapshot(char *dst, const struct neighbour *n,
397 const struct net_device *dev)
398{
399 unsigned int seq;
400
401 do {
402 seq = read_seqbegin(&n->ha_lock);
403 memcpy(dst, n->ha, dev->addr_len);
404 } while (read_seqretry(&n->ha_lock, seq));
405}
1da177e4 406#endif