1 #ifndef _NET_NEIGHBOUR_H
2 #define _NET_NEIGHBOUR_H
4 #include <linux/neighbour.h>
7 * Generic neighbour manipulation
10 * Pedro Roque <roque@di.fc.ul.pt>
11 * Alexey Kuznetsov <kuznet@ms2.inr.ac.ru>
15 * Harald Welte: <laforge@gnumonks.org>
16 * - Add neighbour cache statistics like rtstat
19 #include <linux/atomic.h>
20 #include <linux/netdevice.h>
21 #include <linux/skbuff.h>
22 #include <linux/rcupdate.h>
23 #include <linux/seq_file.h>
25 #include <linux/err.h>
26 #include <linux/sysctl.h>
27 #include <linux/workqueue.h>
28 #include <net/rtnetlink.h>
31 * NUD stands for "neighbor unreachability detection"
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)
44 struct net_device
*dev
;
45 struct neigh_parms
*next
;
46 int (*neigh_setup
)(struct neighbour
*);
47 void (*neigh_cleanup
)(struct neighbour
*);
48 struct neigh_table
*tbl
;
54 struct rcu_head rcu_head
;
56 int base_reachable_time
;
72 struct neigh_statistics
{
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 */
77 unsigned long res_failed
; /* number of failed resolutions */
79 unsigned long lookups
; /* number of lookups */
80 unsigned long hits
; /* number of hits (among lookups) */
82 unsigned long rcv_probes_mcast
; /* number of received mcast ipv6 */
83 unsigned long rcv_probes_ucast
; /* number of received ucast ipv6 */
85 unsigned long periodic_gc_runs
; /* number of periodic GC runs */
86 unsigned long forced_gc_runs
; /* number of forced GC runs */
88 unsigned long unres_discards
; /* number of unresolved drops */
91 #define NEIGH_CACHE_STAT_INC(tbl, field) this_cpu_inc((tbl)->stats->field)
94 struct neighbour __rcu
*next
;
95 struct neigh_table
*tbl
;
96 struct neigh_parms
*parms
;
97 unsigned long confirmed
;
98 unsigned long updated
;
101 struct sk_buff_head arp_queue
;
102 unsigned int arp_queue_len_bytes
;
103 struct timer_list timer
;
111 unsigned char ha
[ALIGN(MAX_ADDR_LEN
, sizeof(unsigned long))];
113 int (*output
)(struct neighbour
*, struct sk_buff
*);
114 const struct neigh_ops
*ops
;
116 struct net_device
*dev
;
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
*);
128 struct pneigh_entry
{
129 struct pneigh_entry
*next
;
133 struct net_device
*dev
;
139 * neighbour table manipulation
142 struct neigh_hash_table
{
143 struct neighbour __rcu
**hash_buckets
;
144 unsigned int hash_shift
;
151 struct neigh_table
*next
;
155 __u32 (*hash
)(const void *pkey
,
156 const struct net_device
*dev
,
158 int (*constructor
)(struct neighbour
*);
159 int (*pconstructor
)(struct pneigh_entry
*);
160 void (*pdestructor
)(struct pneigh_entry
*);
161 void (*proxy_redo
)(struct sk_buff
*skb
);
163 struct neigh_parms parms
;
164 /* HACK. gc_* should follow parms without a gap! */
169 unsigned long last_flush
;
170 struct delayed_work gc_work
;
171 struct timer_list proxy_timer
;
172 struct sk_buff_head proxy_queue
;
175 unsigned long last_rand
;
176 struct neigh_statistics __percpu
*stats
;
177 struct neigh_hash_table __rcu
*nht
;
178 struct pneigh_entry
**phash_buckets
;
181 #define NEIGH_PRIV_ALIGN sizeof(long long)
183 static inline void *neighbour_priv(const struct neighbour
*n
)
185 return (char *)n
+ ALIGN(sizeof(*n
) + n
->tbl
->key_len
, NEIGH_PRIV_ALIGN
);
188 /* flags for neigh_update() */
189 #define NEIGH_UPDATE_F_OVERRIDE 0x00000001
190 #define NEIGH_UPDATE_F_WEAK_OVERRIDE 0x00000002
191 #define NEIGH_UPDATE_F_OVERRIDE_ISROUTER 0x00000004
192 #define NEIGH_UPDATE_F_ISROUTER 0x40000000
193 #define NEIGH_UPDATE_F_ADMIN 0x80000000
195 extern void neigh_table_init(struct neigh_table
*tbl
);
196 extern void neigh_table_init_no_netlink(struct neigh_table
*tbl
);
197 extern int neigh_table_clear(struct neigh_table
*tbl
);
198 extern struct neighbour
* neigh_lookup(struct neigh_table
*tbl
,
200 struct net_device
*dev
);
201 extern struct neighbour
* neigh_lookup_nodev(struct neigh_table
*tbl
,
204 extern struct neighbour
* neigh_create(struct neigh_table
*tbl
,
206 struct net_device
*dev
);
207 extern void neigh_destroy(struct neighbour
*neigh
);
208 extern int __neigh_event_send(struct neighbour
*neigh
, struct sk_buff
*skb
);
209 extern int neigh_update(struct neighbour
*neigh
, const u8
*lladdr
, u8
new,
211 extern void neigh_changeaddr(struct neigh_table
*tbl
, struct net_device
*dev
);
212 extern int neigh_ifdown(struct neigh_table
*tbl
, struct net_device
*dev
);
213 extern int neigh_resolve_output(struct neighbour
*neigh
, struct sk_buff
*skb
);
214 extern int neigh_connected_output(struct neighbour
*neigh
, struct sk_buff
*skb
);
215 extern int neigh_compat_output(struct neighbour
*neigh
, struct sk_buff
*skb
);
216 extern int neigh_direct_output(struct neighbour
*neigh
, struct sk_buff
*skb
);
217 extern struct neighbour
*neigh_event_ns(struct neigh_table
*tbl
,
218 u8
*lladdr
, void *saddr
,
219 struct net_device
*dev
);
221 extern struct neigh_parms
*neigh_parms_alloc(struct net_device
*dev
, struct neigh_table
*tbl
);
222 extern void neigh_parms_release(struct neigh_table
*tbl
, struct neigh_parms
*parms
);
225 struct net
*neigh_parms_net(const struct neigh_parms
*parms
)
227 return read_pnet(&parms
->net
);
230 extern unsigned long neigh_rand_reach_time(unsigned long base
);
232 extern void pneigh_enqueue(struct neigh_table
*tbl
, struct neigh_parms
*p
,
233 struct sk_buff
*skb
);
234 extern struct pneigh_entry
*pneigh_lookup(struct neigh_table
*tbl
, struct net
*net
, const void *key
, struct net_device
*dev
, int creat
);
235 extern struct pneigh_entry
*__pneigh_lookup(struct neigh_table
*tbl
,
238 struct net_device
*dev
);
239 extern int pneigh_delete(struct neigh_table
*tbl
, struct net
*net
, const void *key
, struct net_device
*dev
);
242 struct net
*pneigh_net(const struct pneigh_entry
*pneigh
)
244 return read_pnet(&pneigh
->net
);
247 extern void neigh_app_ns(struct neighbour
*n
);
248 extern void neigh_for_each(struct neigh_table
*tbl
, void (*cb
)(struct neighbour
*, void *), void *cookie
);
249 extern void __neigh_for_each_release(struct neigh_table
*tbl
, int (*cb
)(struct neighbour
*));
250 extern void pneigh_for_each(struct neigh_table
*tbl
, void (*cb
)(struct pneigh_entry
*));
252 struct neigh_seq_state
{
253 struct seq_net_private p
;
254 struct neigh_table
*tbl
;
255 struct neigh_hash_table
*nht
;
256 void *(*neigh_sub_iter
)(struct neigh_seq_state
*state
,
257 struct neighbour
*n
, loff_t
*pos
);
260 #define NEIGH_SEQ_NEIGH_ONLY 0x00000001
261 #define NEIGH_SEQ_IS_PNEIGH 0x00000002
262 #define NEIGH_SEQ_SKIP_NOARP 0x00000004
264 extern void *neigh_seq_start(struct seq_file
*, loff_t
*, struct neigh_table
*, unsigned int);
265 extern void *neigh_seq_next(struct seq_file
*, void *, loff_t
*);
266 extern void neigh_seq_stop(struct seq_file
*, void *);
268 extern int neigh_sysctl_register(struct net_device
*dev
,
269 struct neigh_parms
*p
,
271 proc_handler
*proc_handler
);
272 extern void neigh_sysctl_unregister(struct neigh_parms
*p
);
274 static inline void __neigh_parms_put(struct neigh_parms
*parms
)
276 atomic_dec(&parms
->refcnt
);
279 static inline struct neigh_parms
*neigh_parms_clone(struct neigh_parms
*parms
)
281 atomic_inc(&parms
->refcnt
);
286 * Neighbour references
289 static inline void neigh_release(struct neighbour
*neigh
)
291 if (atomic_dec_and_test(&neigh
->refcnt
))
292 neigh_destroy(neigh
);
295 static inline struct neighbour
* neigh_clone(struct neighbour
*neigh
)
298 atomic_inc(&neigh
->refcnt
);
302 #define neigh_hold(n) atomic_inc(&(n)->refcnt)
304 static inline void neigh_confirm(struct neighbour
*neigh
)
307 neigh
->confirmed
= jiffies
;
310 static inline int neigh_event_send(struct neighbour
*neigh
, struct sk_buff
*skb
)
312 unsigned long now
= jiffies
;
314 if (neigh
->used
!= now
)
316 if (!(neigh
->nud_state
&(NUD_CONNECTED
|NUD_DELAY
|NUD_PROBE
)))
317 return __neigh_event_send(neigh
, skb
);
321 #ifdef CONFIG_BRIDGE_NETFILTER
322 static inline int neigh_hh_bridge(struct hh_cache
*hh
, struct sk_buff
*skb
)
324 unsigned seq
, hh_alen
;
327 seq
= read_seqbegin(&hh
->hh_lock
);
328 hh_alen
= HH_DATA_ALIGN(ETH_HLEN
);
329 memcpy(skb
->data
- hh_alen
, hh
->hh_data
, ETH_ALEN
+ hh_alen
- ETH_HLEN
);
330 } while (read_seqretry(&hh
->hh_lock
, seq
));
335 static inline int neigh_hh_output(struct hh_cache
*hh
, struct sk_buff
*skb
)
343 seq
= read_seqbegin(&hh
->hh_lock
);
345 hh_alen
= HH_DATA_ALIGN(hh_len
);
346 memcpy(skb
->data
- hh_alen
, hh
->hh_data
, hh_alen
);
347 } while (read_seqretry(&hh
->hh_lock
, seq
));
349 skb_push(skb
, hh_len
);
350 return dev_queue_xmit(skb
);
353 static inline int neigh_output(struct neighbour
*n
, struct sk_buff
*skb
)
355 struct hh_cache
*hh
= &n
->hh
;
356 if ((n
->nud_state
& NUD_CONNECTED
) && hh
->hh_len
)
357 return neigh_hh_output(hh
, skb
);
359 return n
->output(n
, skb
);
362 static inline struct neighbour
*
363 __neigh_lookup(struct neigh_table
*tbl
, const void *pkey
, struct net_device
*dev
, int creat
)
365 struct neighbour
*n
= neigh_lookup(tbl
, pkey
, dev
);
370 n
= neigh_create(tbl
, pkey
, dev
);
371 return IS_ERR(n
) ? NULL
: n
;
374 static inline struct neighbour
*
375 __neigh_lookup_errno(struct neigh_table
*tbl
, const void *pkey
,
376 struct net_device
*dev
)
378 struct neighbour
*n
= neigh_lookup(tbl
, pkey
, dev
);
383 return neigh_create(tbl
, pkey
, dev
);
386 struct neighbour_cb
{
387 unsigned long sched_next
;
391 #define LOCALLY_ENQUEUED 0x1
393 #define NEIGH_CB(skb) ((struct neighbour_cb *)(skb)->cb)
395 static inline void neigh_ha_snapshot(char *dst
, const struct neighbour
*n
,
396 const struct net_device
*dev
)
401 seq
= read_seqbegin(&n
->ha_lock
);
402 memcpy(dst
, n
->ha
, dev
->addr_len
);
403 } while (read_seqretry(&n
->ha_lock
, seq
));