Commit | Line | Data |
---|---|---|
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 | ||
38 | struct neighbour; | |
39 | ||
fd2c3ef7 | 40 | struct 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 | 72 | struct 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 | 93 | struct 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 | 120 | struct 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 | 128 | struct 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 | 144 | struct 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 | 152 | struct 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 | ||
185 | static 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 | ||
197 | extern void neigh_table_init(struct neigh_table *tbl); | |
bd89efc5 | 198 | extern void neigh_table_init_no_netlink(struct neigh_table *tbl); |
1da177e4 LT |
199 | extern int neigh_table_clear(struct neigh_table *tbl); |
200 | extern struct neighbour * neigh_lookup(struct neigh_table *tbl, | |
201 | const void *pkey, | |
202 | struct net_device *dev); | |
203 | extern struct neighbour * neigh_lookup_nodev(struct neigh_table *tbl, | |
426b5303 | 204 | struct net *net, |
1da177e4 LT |
205 | const void *pkey); |
206 | extern struct neighbour * neigh_create(struct neigh_table *tbl, | |
207 | const void *pkey, | |
208 | struct net_device *dev); | |
209 | extern void neigh_destroy(struct neighbour *neigh); | |
210 | extern int __neigh_event_send(struct neighbour *neigh, struct sk_buff *skb); | |
211 | extern int neigh_update(struct neighbour *neigh, const u8 *lladdr, u8 new, | |
212 | u32 flags); | |
213 | extern void neigh_changeaddr(struct neigh_table *tbl, struct net_device *dev); | |
214 | extern int neigh_ifdown(struct neigh_table *tbl, struct net_device *dev); | |
8f40b161 DM |
215 | extern int neigh_resolve_output(struct neighbour *neigh, struct sk_buff *skb); |
216 | extern int neigh_connected_output(struct neighbour *neigh, struct sk_buff *skb); | |
217 | extern int neigh_compat_output(struct neighbour *neigh, struct sk_buff *skb); | |
218 | extern int neigh_direct_output(struct neighbour *neigh, struct sk_buff *skb); | |
1da177e4 LT |
219 | extern struct neighbour *neigh_event_ns(struct neigh_table *tbl, |
220 | u8 *lladdr, void *saddr, | |
221 | struct net_device *dev); | |
222 | ||
223 | extern struct neigh_parms *neigh_parms_alloc(struct net_device *dev, struct neigh_table *tbl); | |
224 | extern void neigh_parms_release(struct neigh_table *tbl, struct neigh_parms *parms); | |
57da52c1 YH |
225 | |
226 | static inline | |
227 | struct net *neigh_parms_net(const struct neigh_parms *parms) | |
228 | { | |
e42ea986 | 229 | return read_pnet(&parms->net); |
57da52c1 YH |
230 | } |
231 | ||
1da177e4 LT |
232 | extern unsigned long neigh_rand_reach_time(unsigned long base); |
233 | ||
234 | extern void pneigh_enqueue(struct neigh_table *tbl, struct neigh_parms *p, | |
235 | struct sk_buff *skb); | |
426b5303 | 236 | extern struct pneigh_entry *pneigh_lookup(struct neigh_table *tbl, struct net *net, const void *key, struct net_device *dev, int creat); |
fa86d322 PE |
237 | extern struct pneigh_entry *__pneigh_lookup(struct neigh_table *tbl, |
238 | struct net *net, | |
239 | const void *key, | |
240 | struct net_device *dev); | |
426b5303 | 241 | extern int pneigh_delete(struct neigh_table *tbl, struct net *net, const void *key, struct net_device *dev); |
1da177e4 | 242 | |
57da52c1 YH |
243 | static inline |
244 | struct net *pneigh_net(const struct pneigh_entry *pneigh) | |
245 | { | |
e42ea986 | 246 | return read_pnet(&pneigh->net); |
57da52c1 YH |
247 | } |
248 | ||
1da177e4 | 249 | extern void neigh_app_ns(struct neighbour *n); |
1da177e4 LT |
250 | extern void neigh_for_each(struct neigh_table *tbl, void (*cb)(struct neighbour *, void *), void *cookie); |
251 | extern void __neigh_for_each_release(struct neigh_table *tbl, int (*cb)(struct neighbour *)); | |
252 | extern void pneigh_for_each(struct neigh_table *tbl, void (*cb)(struct pneigh_entry *)); | |
253 | ||
254 | struct neigh_seq_state { | |
42508461 | 255 | struct seq_net_private p; |
1da177e4 | 256 | struct neigh_table *tbl; |
d6bf7817 | 257 | struct neigh_hash_table *nht; |
1da177e4 LT |
258 | void *(*neigh_sub_iter)(struct neigh_seq_state *state, |
259 | struct neighbour *n, loff_t *pos); | |
260 | unsigned int bucket; | |
261 | unsigned int flags; | |
262 | #define NEIGH_SEQ_NEIGH_ONLY 0x00000001 | |
263 | #define NEIGH_SEQ_IS_PNEIGH 0x00000002 | |
264 | #define NEIGH_SEQ_SKIP_NOARP 0x00000004 | |
265 | }; | |
266 | extern void *neigh_seq_start(struct seq_file *, loff_t *, struct neigh_table *, unsigned int); | |
267 | extern void *neigh_seq_next(struct seq_file *, void *, loff_t *); | |
268 | extern void neigh_seq_stop(struct seq_file *, void *); | |
269 | ||
270 | extern int neigh_sysctl_register(struct net_device *dev, | |
271 | struct neigh_parms *p, | |
1da177e4 | 272 | char *p_name, |
f8572d8f | 273 | proc_handler *proc_handler); |
1da177e4 LT |
274 | extern void neigh_sysctl_unregister(struct neigh_parms *p); |
275 | ||
276 | static inline void __neigh_parms_put(struct neigh_parms *parms) | |
277 | { | |
278 | atomic_dec(&parms->refcnt); | |
279 | } | |
280 | ||
1da177e4 LT |
281 | static inline struct neigh_parms *neigh_parms_clone(struct neigh_parms *parms) |
282 | { | |
283 | atomic_inc(&parms->refcnt); | |
284 | return parms; | |
285 | } | |
286 | ||
287 | /* | |
288 | * Neighbour references | |
289 | */ | |
290 | ||
291 | static inline void neigh_release(struct neighbour *neigh) | |
292 | { | |
293 | if (atomic_dec_and_test(&neigh->refcnt)) | |
294 | neigh_destroy(neigh); | |
295 | } | |
296 | ||
297 | static inline struct neighbour * neigh_clone(struct neighbour *neigh) | |
298 | { | |
299 | if (neigh) | |
300 | atomic_inc(&neigh->refcnt); | |
301 | return neigh; | |
302 | } | |
303 | ||
304 | #define neigh_hold(n) atomic_inc(&(n)->refcnt) | |
305 | ||
306 | static inline void neigh_confirm(struct neighbour *neigh) | |
307 | { | |
308 | if (neigh) | |
309 | neigh->confirmed = jiffies; | |
310 | } | |
311 | ||
1da177e4 LT |
312 | static inline int neigh_event_send(struct neighbour *neigh, struct sk_buff *skb) |
313 | { | |
ef22b7b6 | 314 | unsigned long now = jiffies; |
0ed8ddf4 ED |
315 | |
316 | if (neigh->used != now) | |
317 | neigh->used = now; | |
1da177e4 LT |
318 | if (!(neigh->nud_state&(NUD_CONNECTED|NUD_DELAY|NUD_PROBE))) |
319 | return __neigh_event_send(neigh, skb); | |
320 | return 0; | |
321 | } | |
322 | ||
e179e632 BDS |
323 | #ifdef CONFIG_BRIDGE_NETFILTER |
324 | static inline int neigh_hh_bridge(struct hh_cache *hh, struct sk_buff *skb) | |
325 | { | |
326 | unsigned seq, hh_alen; | |
327 | ||
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 | ||
3644f0ce SH |
337 | static inline int neigh_hh_output(struct hh_cache *hh, struct sk_buff *skb) |
338 | { | |
339 | unsigned seq; | |
340 | 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); | |
b23b5455 | 352 | return dev_queue_xmit(skb); |
3644f0ce SH |
353 | } |
354 | ||
05e3aa09 DM |
355 | static inline int neigh_output(struct neighbour *n, struct sk_buff *skb) |
356 | { | |
357 | struct hh_cache *hh = &n->hh; | |
b23b5455 | 358 | if ((n->nud_state & NUD_CONNECTED) && hh->hh_len) |
05e3aa09 DM |
359 | return neigh_hh_output(hh, skb); |
360 | else | |
8f40b161 | 361 | return n->output(n, skb); |
05e3aa09 DM |
362 | } |
363 | ||
1da177e4 LT |
364 | static inline struct neighbour * |
365 | __neigh_lookup(struct neigh_table *tbl, const void *pkey, struct net_device *dev, int creat) | |
366 | { | |
367 | struct neighbour *n = neigh_lookup(tbl, pkey, dev); | |
368 | ||
369 | if (n || !creat) | |
370 | return n; | |
371 | ||
372 | n = neigh_create(tbl, pkey, dev); | |
373 | return IS_ERR(n) ? NULL : n; | |
374 | } | |
375 | ||
376 | static inline struct neighbour * | |
377 | __neigh_lookup_errno(struct neigh_table *tbl, const void *pkey, | |
378 | struct net_device *dev) | |
379 | { | |
380 | struct neighbour *n = neigh_lookup(tbl, pkey, dev); | |
381 | ||
382 | if (n) | |
383 | return n; | |
384 | ||
385 | return neigh_create(tbl, pkey, dev); | |
386 | } | |
387 | ||
a61bbcf2 PM |
388 | struct neighbour_cb { |
389 | unsigned long sched_next; | |
390 | unsigned int flags; | |
391 | }; | |
392 | ||
393 | #define LOCALLY_ENQUEUED 0x1 | |
394 | ||
395 | #define NEIGH_CB(skb) ((struct neighbour_cb *)(skb)->cb) | |
1da177e4 | 396 | |
0ed8ddf4 ED |
397 | static inline void neigh_ha_snapshot(char *dst, const struct neighbour *n, |
398 | const struct net_device *dev) | |
399 | { | |
400 | unsigned int seq; | |
401 | ||
402 | do { | |
403 | seq = read_seqbegin(&n->ha_lock); | |
404 | memcpy(dst, n->ha, dev->addr_len); | |
405 | } while (read_seqretry(&n->ha_lock, seq)); | |
406 | } | |
1da177e4 | 407 | #endif |