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>
24 #include <linux/bitmap.h>
26 #include <linux/err.h>
27 #include <linux/sysctl.h>
28 #include <linux/workqueue.h>
29 #include <net/rtnetlink.h>
32 * NUD stands for "neighbor unreachability detection"
35 #define NUD_IN_TIMER (NUD_INCOMPLETE|NUD_REACHABLE|NUD_DELAY|NUD_PROBE)
36 #define NUD_VALID (NUD_PERMANENT|NUD_NOARP|NUD_REACHABLE|NUD_PROBE|NUD_STALE|NUD_DELAY)
37 #define NUD_CONNECTED (NUD_PERMANENT|NUD_NOARP|NUD_REACHABLE)
42 NEIGH_VAR_MCAST_PROBES
,
43 NEIGH_VAR_UCAST_PROBES
,
45 NEIGH_VAR_RETRANS_TIME
,
46 NEIGH_VAR_BASE_REACHABLE_TIME
,
47 NEIGH_VAR_DELAY_PROBE_TIME
,
48 NEIGH_VAR_GC_STALETIME
,
49 NEIGH_VAR_QUEUE_LEN_BYTES
,
51 NEIGH_VAR_ANYCAST_DELAY
,
52 NEIGH_VAR_PROXY_DELAY
,
54 #define NEIGH_VAR_DATA_MAX (NEIGH_VAR_LOCKTIME + 1)
55 /* Following are used as a second way to access one of the above */
56 NEIGH_VAR_QUEUE_LEN
, /* same data as NEIGH_VAR_QUEUE_LEN_BYTES */
57 NEIGH_VAR_RETRANS_TIME_MS
, /* same data as NEIGH_VAR_RETRANS_TIME */
58 NEIGH_VAR_BASE_REACHABLE_TIME_MS
, /* same data as NEIGH_VAR_BASE_REACHABLE_TIME */
59 /* Following are used by "default" only */
60 NEIGH_VAR_GC_INTERVAL
,
71 struct net_device
*dev
;
72 struct neigh_parms
*next
;
73 int (*neigh_setup
)(struct neighbour
*);
74 void (*neigh_cleanup
)(struct neighbour
*);
75 struct neigh_table
*tbl
;
81 struct rcu_head rcu_head
;
84 int data
[NEIGH_VAR_DATA_MAX
];
85 DECLARE_BITMAP(data_state
, NEIGH_VAR_DATA_MAX
);
88 static inline void neigh_var_set(struct neigh_parms
*p
, int index
, int val
)
90 set_bit(index
, p
->data_state
);
94 #define NEIGH_VAR(p, attr) ((p)->data[NEIGH_VAR_ ## attr])
95 #define NEIGH_VAR_SET(p, attr, val) neigh_var_set(p, NEIGH_VAR_ ## attr, val)
97 static inline void neigh_parms_data_state_setall(struct neigh_parms
*p
)
99 bitmap_fill(p
->data_state
, NEIGH_VAR_DATA_MAX
);
102 static inline void neigh_parms_data_state_cleanall(struct neigh_parms
*p
)
104 bitmap_zero(p
->data_state
, NEIGH_VAR_DATA_MAX
);
107 struct neigh_statistics
{
108 unsigned long allocs
; /* number of allocated neighs */
109 unsigned long destroys
; /* number of destroyed neighs */
110 unsigned long hash_grows
; /* number of hash resizes */
112 unsigned long res_failed
; /* number of failed resolutions */
114 unsigned long lookups
; /* number of lookups */
115 unsigned long hits
; /* number of hits (among lookups) */
117 unsigned long rcv_probes_mcast
; /* number of received mcast ipv6 */
118 unsigned long rcv_probes_ucast
; /* number of received ucast ipv6 */
120 unsigned long periodic_gc_runs
; /* number of periodic GC runs */
121 unsigned long forced_gc_runs
; /* number of forced GC runs */
123 unsigned long unres_discards
; /* number of unresolved drops */
126 #define NEIGH_CACHE_STAT_INC(tbl, field) this_cpu_inc((tbl)->stats->field)
129 struct neighbour __rcu
*next
;
130 struct neigh_table
*tbl
;
131 struct neigh_parms
*parms
;
132 unsigned long confirmed
;
133 unsigned long updated
;
136 struct sk_buff_head arp_queue
;
137 unsigned int arp_queue_len_bytes
;
138 struct timer_list timer
;
146 unsigned char ha
[ALIGN(MAX_ADDR_LEN
, sizeof(unsigned long))];
148 int (*output
)(struct neighbour
*, struct sk_buff
*);
149 const struct neigh_ops
*ops
;
151 struct net_device
*dev
;
157 void (*solicit
)(struct neighbour
*, struct sk_buff
*);
158 void (*error_report
)(struct neighbour
*, struct sk_buff
*);
159 int (*output
)(struct neighbour
*, struct sk_buff
*);
160 int (*connected_output
)(struct neighbour
*, struct sk_buff
*);
163 struct pneigh_entry
{
164 struct pneigh_entry
*next
;
168 struct net_device
*dev
;
174 * neighbour table manipulation
177 #define NEIGH_NUM_HASH_RND 4
179 struct neigh_hash_table
{
180 struct neighbour __rcu
**hash_buckets
;
181 unsigned int hash_shift
;
182 __u32 hash_rnd
[NEIGH_NUM_HASH_RND
];
188 struct neigh_table
*next
;
192 __u32 (*hash
)(const void *pkey
,
193 const struct net_device
*dev
,
195 int (*constructor
)(struct neighbour
*);
196 int (*pconstructor
)(struct pneigh_entry
*);
197 void (*pdestructor
)(struct pneigh_entry
*);
198 void (*proxy_redo
)(struct sk_buff
*skb
);
200 struct neigh_parms parms
;
201 /* HACK. gc_* should follow parms without a gap! */
206 unsigned long last_flush
;
207 struct delayed_work gc_work
;
208 struct timer_list proxy_timer
;
209 struct sk_buff_head proxy_queue
;
212 unsigned long last_rand
;
213 struct neigh_statistics __percpu
*stats
;
214 struct neigh_hash_table __rcu
*nht
;
215 struct pneigh_entry
**phash_buckets
;
218 static inline int neigh_parms_family(struct neigh_parms
*p
)
220 return p
->tbl
->family
;
223 #define NEIGH_PRIV_ALIGN sizeof(long long)
224 #define NEIGH_ENTRY_SIZE(size) ALIGN((size), NEIGH_PRIV_ALIGN)
226 static inline void *neighbour_priv(const struct neighbour
*n
)
228 return (char *)n
+ n
->tbl
->entry_size
;
231 /* flags for neigh_update() */
232 #define NEIGH_UPDATE_F_OVERRIDE 0x00000001
233 #define NEIGH_UPDATE_F_WEAK_OVERRIDE 0x00000002
234 #define NEIGH_UPDATE_F_OVERRIDE_ISROUTER 0x00000004
235 #define NEIGH_UPDATE_F_ISROUTER 0x40000000
236 #define NEIGH_UPDATE_F_ADMIN 0x80000000
238 void neigh_table_init(struct neigh_table
*tbl
);
239 int neigh_table_clear(struct neigh_table
*tbl
);
240 struct neighbour
*neigh_lookup(struct neigh_table
*tbl
, const void *pkey
,
241 struct net_device
*dev
);
242 struct neighbour
*neigh_lookup_nodev(struct neigh_table
*tbl
, struct net
*net
,
244 struct neighbour
*__neigh_create(struct neigh_table
*tbl
, const void *pkey
,
245 struct net_device
*dev
, bool want_ref
);
246 static inline struct neighbour
*neigh_create(struct neigh_table
*tbl
,
248 struct net_device
*dev
)
250 return __neigh_create(tbl
, pkey
, dev
, true);
252 void neigh_destroy(struct neighbour
*neigh
);
253 int __neigh_event_send(struct neighbour
*neigh
, struct sk_buff
*skb
);
254 int neigh_update(struct neighbour
*neigh
, const u8
*lladdr
, u8
new, u32 flags
);
255 void neigh_changeaddr(struct neigh_table
*tbl
, struct net_device
*dev
);
256 int neigh_ifdown(struct neigh_table
*tbl
, struct net_device
*dev
);
257 int neigh_resolve_output(struct neighbour
*neigh
, struct sk_buff
*skb
);
258 int neigh_connected_output(struct neighbour
*neigh
, struct sk_buff
*skb
);
259 int neigh_compat_output(struct neighbour
*neigh
, struct sk_buff
*skb
);
260 int neigh_direct_output(struct neighbour
*neigh
, struct sk_buff
*skb
);
261 struct neighbour
*neigh_event_ns(struct neigh_table
*tbl
,
262 u8
*lladdr
, void *saddr
,
263 struct net_device
*dev
);
265 struct neigh_parms
*neigh_parms_alloc(struct net_device
*dev
,
266 struct neigh_table
*tbl
);
267 void neigh_parms_release(struct neigh_table
*tbl
, struct neigh_parms
*parms
);
270 struct net
*neigh_parms_net(const struct neigh_parms
*parms
)
272 return read_pnet(&parms
->net
);
275 unsigned long neigh_rand_reach_time(unsigned long base
);
277 void pneigh_enqueue(struct neigh_table
*tbl
, struct neigh_parms
*p
,
278 struct sk_buff
*skb
);
279 struct pneigh_entry
*pneigh_lookup(struct neigh_table
*tbl
, struct net
*net
,
280 const void *key
, struct net_device
*dev
,
282 struct pneigh_entry
*__pneigh_lookup(struct neigh_table
*tbl
, struct net
*net
,
283 const void *key
, struct net_device
*dev
);
284 int pneigh_delete(struct neigh_table
*tbl
, struct net
*net
, const void *key
,
285 struct net_device
*dev
);
287 static inline struct net
*pneigh_net(const struct pneigh_entry
*pneigh
)
289 return read_pnet(&pneigh
->net
);
292 void neigh_app_ns(struct neighbour
*n
);
293 void neigh_for_each(struct neigh_table
*tbl
,
294 void (*cb
)(struct neighbour
*, void *), void *cookie
);
295 void __neigh_for_each_release(struct neigh_table
*tbl
,
296 int (*cb
)(struct neighbour
*));
297 void pneigh_for_each(struct neigh_table
*tbl
,
298 void (*cb
)(struct pneigh_entry
*));
300 struct neigh_seq_state
{
301 struct seq_net_private p
;
302 struct neigh_table
*tbl
;
303 struct neigh_hash_table
*nht
;
304 void *(*neigh_sub_iter
)(struct neigh_seq_state
*state
,
305 struct neighbour
*n
, loff_t
*pos
);
308 #define NEIGH_SEQ_NEIGH_ONLY 0x00000001
309 #define NEIGH_SEQ_IS_PNEIGH 0x00000002
310 #define NEIGH_SEQ_SKIP_NOARP 0x00000004
312 void *neigh_seq_start(struct seq_file
*, loff_t
*, struct neigh_table
*,
314 void *neigh_seq_next(struct seq_file
*, void *, loff_t
*);
315 void neigh_seq_stop(struct seq_file
*, void *);
317 int neigh_proc_dointvec(struct ctl_table
*ctl
, int write
,
318 void __user
*buffer
, size_t *lenp
, loff_t
*ppos
);
319 int neigh_proc_dointvec_jiffies(struct ctl_table
*ctl
, int write
,
321 size_t *lenp
, loff_t
*ppos
);
322 int neigh_proc_dointvec_ms_jiffies(struct ctl_table
*ctl
, int write
,
324 size_t *lenp
, loff_t
*ppos
);
326 int neigh_sysctl_register(struct net_device
*dev
, struct neigh_parms
*p
,
327 proc_handler
*proc_handler
);
328 void neigh_sysctl_unregister(struct neigh_parms
*p
);
330 static inline void __neigh_parms_put(struct neigh_parms
*parms
)
332 atomic_dec(&parms
->refcnt
);
335 static inline struct neigh_parms
*neigh_parms_clone(struct neigh_parms
*parms
)
337 atomic_inc(&parms
->refcnt
);
342 * Neighbour references
345 static inline void neigh_release(struct neighbour
*neigh
)
347 if (atomic_dec_and_test(&neigh
->refcnt
))
348 neigh_destroy(neigh
);
351 static inline struct neighbour
* neigh_clone(struct neighbour
*neigh
)
354 atomic_inc(&neigh
->refcnt
);
358 #define neigh_hold(n) atomic_inc(&(n)->refcnt)
360 static inline int neigh_event_send(struct neighbour
*neigh
, struct sk_buff
*skb
)
362 unsigned long now
= jiffies
;
364 if (neigh
->used
!= now
)
366 if (!(neigh
->nud_state
&(NUD_CONNECTED
|NUD_DELAY
|NUD_PROBE
)))
367 return __neigh_event_send(neigh
, skb
);
371 #ifdef CONFIG_BRIDGE_NETFILTER
372 static inline int neigh_hh_bridge(struct hh_cache
*hh
, struct sk_buff
*skb
)
374 unsigned int seq
, hh_alen
;
377 seq
= read_seqbegin(&hh
->hh_lock
);
378 hh_alen
= HH_DATA_ALIGN(ETH_HLEN
);
379 memcpy(skb
->data
- hh_alen
, hh
->hh_data
, ETH_ALEN
+ hh_alen
- ETH_HLEN
);
380 } while (read_seqretry(&hh
->hh_lock
, seq
));
385 static inline int neigh_hh_output(const struct hh_cache
*hh
, struct sk_buff
*skb
)
391 seq
= read_seqbegin(&hh
->hh_lock
);
393 if (likely(hh_len
<= HH_DATA_MOD
)) {
394 /* this is inlined by gcc */
395 memcpy(skb
->data
- HH_DATA_MOD
, hh
->hh_data
, HH_DATA_MOD
);
397 int hh_alen
= HH_DATA_ALIGN(hh_len
);
399 memcpy(skb
->data
- hh_alen
, hh
->hh_data
, hh_alen
);
401 } while (read_seqretry(&hh
->hh_lock
, seq
));
403 skb_push(skb
, hh_len
);
404 return dev_queue_xmit(skb
);
407 static inline struct neighbour
*
408 __neigh_lookup(struct neigh_table
*tbl
, const void *pkey
, struct net_device
*dev
, int creat
)
410 struct neighbour
*n
= neigh_lookup(tbl
, pkey
, dev
);
415 n
= neigh_create(tbl
, pkey
, dev
);
416 return IS_ERR(n
) ? NULL
: n
;
419 static inline struct neighbour
*
420 __neigh_lookup_errno(struct neigh_table
*tbl
, const void *pkey
,
421 struct net_device
*dev
)
423 struct neighbour
*n
= neigh_lookup(tbl
, pkey
, dev
);
428 return neigh_create(tbl
, pkey
, dev
);
431 struct neighbour_cb
{
432 unsigned long sched_next
;
436 #define LOCALLY_ENQUEUED 0x1
438 #define NEIGH_CB(skb) ((struct neighbour_cb *)(skb)->cb)
440 static inline void neigh_ha_snapshot(char *dst
, const struct neighbour
*n
,
441 const struct net_device
*dev
)
446 seq
= read_seqbegin(&n
->ha_lock
);
447 memcpy(dst
, n
->ha
, dev
->addr_len
);
448 } while (read_seqretry(&n
->ha_lock
, seq
));