xref: /openbmc/linux/include/net/neighbour.h (revision 767e97e1)
1 #ifndef _NET_NEIGHBOUR_H
2 #define _NET_NEIGHBOUR_H
3 
4 #include <linux/neighbour.h>
5 
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 
19 #include <asm/atomic.h>
20 #include <linux/netdevice.h>
21 #include <linux/skbuff.h>
22 #include <linux/rcupdate.h>
23 #include <linux/seq_file.h>
24 
25 #include <linux/err.h>
26 #include <linux/sysctl.h>
27 #include <linux/workqueue.h>
28 #include <net/rtnetlink.h>
29 
30 /*
31  * NUD stands for "neighbor unreachability detection"
32  */
33 
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 
40 struct neigh_parms {
41 #ifdef CONFIG_NET_NS
42 	struct net *net;
43 #endif
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;
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 
62 	int	queue_len;
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 
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 */
76 
77 	unsigned long res_failed;	/* number of failed resolutions */
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 */
87 
88 	unsigned long unres_discards;	/* number of unresolved drops */
89 };
90 
91 #define NEIGH_CACHE_STAT_INC(tbl, field) this_cpu_inc((tbl)->stats->field)
92 
93 struct neighbour {
94 	struct neighbour __rcu	*next;
95 	struct neigh_table	*tbl;
96 	struct neigh_parms	*parms;
97 	struct net_device	*dev;
98 	unsigned long		used;
99 	unsigned long		confirmed;
100 	unsigned long		updated;
101 	__u8			flags;
102 	__u8			nud_state;
103 	__u8			type;
104 	__u8			dead;
105 	atomic_t		refcnt;
106 	atomic_t		probes;
107 	rwlock_t		lock;
108 	unsigned char		ha[ALIGN(MAX_ADDR_LEN, sizeof(unsigned long))];
109 	struct hh_cache		*hh;
110 	int			(*output)(struct sk_buff *skb);
111 	struct sk_buff_head	arp_queue;
112 	struct timer_list	timer;
113 	const struct neigh_ops	*ops;
114 	struct rcu_head		rcu;
115 	u8			primary_key[0];
116 };
117 
118 struct neigh_ops {
119 	int			family;
120 	void			(*solicit)(struct neighbour *, struct sk_buff*);
121 	void			(*error_report)(struct neighbour *, struct sk_buff*);
122 	int			(*output)(struct sk_buff*);
123 	int			(*connected_output)(struct sk_buff*);
124 	int			(*hh_output)(struct sk_buff*);
125 	int			(*queue_xmit)(struct sk_buff*);
126 };
127 
128 struct pneigh_entry {
129 	struct pneigh_entry	*next;
130 #ifdef CONFIG_NET_NS
131 	struct net		*net;
132 #endif
133 	struct net_device	*dev;
134 	u8			flags;
135 	u8			key[0];
136 };
137 
138 /*
139  *	neighbour table manipulation
140  */
141 
142 struct neigh_hash_table {
143 	struct neighbour __rcu	**hash_buckets;
144 	unsigned int		hash_mask;
145 	__u32			hash_rnd;
146 	struct rcu_head		rcu;
147 };
148 
149 
150 struct neigh_table {
151 	struct neigh_table	*next;
152 	int			family;
153 	int			entry_size;
154 	int			key_len;
155 	__u32			(*hash)(const void *pkey,
156 					const struct net_device *dev,
157 					__u32 hash_rnd);
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);
162 	char			*id;
163 	struct neigh_parms	parms;
164 	/* HACK. gc_* should follow parms without a gap! */
165 	int			gc_interval;
166 	int			gc_thresh1;
167 	int			gc_thresh2;
168 	int			gc_thresh3;
169 	unsigned long		last_flush;
170 	struct delayed_work	gc_work;
171 	struct timer_list 	proxy_timer;
172 	struct sk_buff_head	proxy_queue;
173 	atomic_t		entries;
174 	rwlock_t		lock;
175 	unsigned long		last_rand;
176 	struct kmem_cache	*kmem_cachep;
177 	struct neigh_statistics	__percpu *stats;
178 	struct neigh_hash_table __rcu *nht;
179 	struct pneigh_entry	**phash_buckets;
180 };
181 
182 /* flags for neigh_update() */
183 #define NEIGH_UPDATE_F_OVERRIDE			0x00000001
184 #define NEIGH_UPDATE_F_WEAK_OVERRIDE		0x00000002
185 #define NEIGH_UPDATE_F_OVERRIDE_ISROUTER	0x00000004
186 #define NEIGH_UPDATE_F_ISROUTER			0x40000000
187 #define NEIGH_UPDATE_F_ADMIN			0x80000000
188 
189 extern void			neigh_table_init(struct neigh_table *tbl);
190 extern void			neigh_table_init_no_netlink(struct neigh_table *tbl);
191 extern int			neigh_table_clear(struct neigh_table *tbl);
192 extern struct neighbour *	neigh_lookup(struct neigh_table *tbl,
193 					     const void *pkey,
194 					     struct net_device *dev);
195 extern struct neighbour *	neigh_lookup_nodev(struct neigh_table *tbl,
196 						   struct net *net,
197 						   const void *pkey);
198 extern struct neighbour *	neigh_create(struct neigh_table *tbl,
199 					     const void *pkey,
200 					     struct net_device *dev);
201 extern void			neigh_destroy(struct neighbour *neigh);
202 extern int			__neigh_event_send(struct neighbour *neigh, struct sk_buff *skb);
203 extern int			neigh_update(struct neighbour *neigh, const u8 *lladdr, u8 new,
204 					     u32 flags);
205 extern void			neigh_changeaddr(struct neigh_table *tbl, struct net_device *dev);
206 extern int			neigh_ifdown(struct neigh_table *tbl, struct net_device *dev);
207 extern int			neigh_resolve_output(struct sk_buff *skb);
208 extern int			neigh_connected_output(struct sk_buff *skb);
209 extern int			neigh_compat_output(struct sk_buff *skb);
210 extern struct neighbour 	*neigh_event_ns(struct neigh_table *tbl,
211 						u8 *lladdr, void *saddr,
212 						struct net_device *dev);
213 
214 extern struct neigh_parms	*neigh_parms_alloc(struct net_device *dev, struct neigh_table *tbl);
215 extern void			neigh_parms_release(struct neigh_table *tbl, struct neigh_parms *parms);
216 
217 static inline
218 struct net			*neigh_parms_net(const struct neigh_parms *parms)
219 {
220 	return read_pnet(&parms->net);
221 }
222 
223 extern unsigned long		neigh_rand_reach_time(unsigned long base);
224 
225 extern void			pneigh_enqueue(struct neigh_table *tbl, struct neigh_parms *p,
226 					       struct sk_buff *skb);
227 extern struct pneigh_entry	*pneigh_lookup(struct neigh_table *tbl, struct net *net, const void *key, struct net_device *dev, int creat);
228 extern struct pneigh_entry	*__pneigh_lookup(struct neigh_table *tbl,
229 						 struct net *net,
230 						 const void *key,
231 						 struct net_device *dev);
232 extern int			pneigh_delete(struct neigh_table *tbl, struct net *net, const void *key, struct net_device *dev);
233 
234 static inline
235 struct net			*pneigh_net(const struct pneigh_entry *pneigh)
236 {
237 	return read_pnet(&pneigh->net);
238 }
239 
240 extern void neigh_app_ns(struct neighbour *n);
241 extern void neigh_for_each(struct neigh_table *tbl, void (*cb)(struct neighbour *, void *), void *cookie);
242 extern void __neigh_for_each_release(struct neigh_table *tbl, int (*cb)(struct neighbour *));
243 extern void pneigh_for_each(struct neigh_table *tbl, void (*cb)(struct pneigh_entry *));
244 
245 struct neigh_seq_state {
246 	struct seq_net_private p;
247 	struct neigh_table *tbl;
248 	struct neigh_hash_table *nht;
249 	void *(*neigh_sub_iter)(struct neigh_seq_state *state,
250 				struct neighbour *n, loff_t *pos);
251 	unsigned int bucket;
252 	unsigned int flags;
253 #define NEIGH_SEQ_NEIGH_ONLY	0x00000001
254 #define NEIGH_SEQ_IS_PNEIGH	0x00000002
255 #define NEIGH_SEQ_SKIP_NOARP	0x00000004
256 };
257 extern void *neigh_seq_start(struct seq_file *, loff_t *, struct neigh_table *, unsigned int);
258 extern void *neigh_seq_next(struct seq_file *, void *, loff_t *);
259 extern void neigh_seq_stop(struct seq_file *, void *);
260 
261 extern int			neigh_sysctl_register(struct net_device *dev,
262 						      struct neigh_parms *p,
263 						      char *p_name,
264 						      proc_handler *proc_handler);
265 extern void			neigh_sysctl_unregister(struct neigh_parms *p);
266 
267 static inline void __neigh_parms_put(struct neigh_parms *parms)
268 {
269 	atomic_dec(&parms->refcnt);
270 }
271 
272 static inline struct neigh_parms *neigh_parms_clone(struct neigh_parms *parms)
273 {
274 	atomic_inc(&parms->refcnt);
275 	return parms;
276 }
277 
278 /*
279  *	Neighbour references
280  */
281 
282 static inline void neigh_release(struct neighbour *neigh)
283 {
284 	if (atomic_dec_and_test(&neigh->refcnt))
285 		neigh_destroy(neigh);
286 }
287 
288 static inline struct neighbour * neigh_clone(struct neighbour *neigh)
289 {
290 	if (neigh)
291 		atomic_inc(&neigh->refcnt);
292 	return neigh;
293 }
294 
295 #define neigh_hold(n)	atomic_inc(&(n)->refcnt)
296 
297 static inline void neigh_confirm(struct neighbour *neigh)
298 {
299 	if (neigh)
300 		neigh->confirmed = jiffies;
301 }
302 
303 static 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 
311 #ifdef CONFIG_BRIDGE_NETFILTER
312 static inline int neigh_hh_bridge(struct hh_cache *hh, struct sk_buff *skb)
313 {
314 	unsigned seq, hh_alen;
315 
316 	do {
317 		seq = read_seqbegin(&hh->hh_lock);
318 		hh_alen = HH_DATA_ALIGN(ETH_HLEN);
319 		memcpy(skb->data - hh_alen, hh->hh_data, ETH_ALEN + hh_alen - ETH_HLEN);
320 	} while (read_seqretry(&hh->hh_lock, seq));
321 	return 0;
322 }
323 #endif
324 
325 static inline int neigh_hh_output(struct hh_cache *hh, struct sk_buff *skb)
326 {
327 	unsigned seq;
328 	int hh_len;
329 
330 	do {
331 		int hh_alen;
332 
333 		seq = read_seqbegin(&hh->hh_lock);
334 		hh_len = hh->hh_len;
335 		hh_alen = HH_DATA_ALIGN(hh_len);
336 		memcpy(skb->data - hh_alen, hh->hh_data, hh_alen);
337 	} while (read_seqretry(&hh->hh_lock, seq));
338 
339 	skb_push(skb, hh_len);
340 	return hh->hh_output(skb);
341 }
342 
343 static inline struct neighbour *
344 __neigh_lookup(struct neigh_table *tbl, const void *pkey, struct net_device *dev, int creat)
345 {
346 	struct neighbour *n = neigh_lookup(tbl, pkey, dev);
347 
348 	if (n || !creat)
349 		return n;
350 
351 	n = neigh_create(tbl, pkey, dev);
352 	return IS_ERR(n) ? NULL : n;
353 }
354 
355 static inline struct neighbour *
356 __neigh_lookup_errno(struct neigh_table *tbl, const void *pkey,
357   struct net_device *dev)
358 {
359 	struct neighbour *n = neigh_lookup(tbl, pkey, dev);
360 
361 	if (n)
362 		return n;
363 
364 	return neigh_create(tbl, pkey, dev);
365 }
366 
367 struct neighbour_cb {
368 	unsigned long sched_next;
369 	unsigned int flags;
370 };
371 
372 #define LOCALLY_ENQUEUED 0x1
373 
374 #define NEIGH_CB(skb)	((struct neighbour_cb *)(skb)->cb)
375 
376 #endif
377